@hirehq/enterprise-master-data

Master email touchpoints constants and templates for SimplifyHire enterprise platform.

Installation

``bash
npm install @hirehq/enterprise-master-data
`

Usage

`typescript
import {
EMAIL_TEMPLATES,
MASTER_EMAIL_LAYOUT,
COMMUNICATION_PREFERENCES,
EMAIL_EVENT_CODES,
EventCodeConfig
} from '@hirehq/enterprise-master-data';

// Access email templates
const domainVerificationTemplate = EMAIL_TEMPLATES.find(
template => template.eventCode === 'DOMAIN_NAME_VERIFICATION'
);

// Access email layout configuration
const defaultLayout = MASTER_EMAIL_LAYOUT;

// Access communication preferences
const preferences = COMMUNICATION_PREFERENCES;

// Access email event codes and their template variables
const eventCode = EMAIL_EVENT_CODES.DOMAIN_NAME_VERIFICATION;
console.log(eventCode.templateVariables); // Array of template variables
`

Features

$3

Each email template includes:
- category: Template category for organization
- description: Human-readable description
- emailTemplate: HTML template with variable placeholders
- eventCode: Unique identifier for the event
- eventName: Event name
- name: Template name
- subject: Email subject line

Variable Placeholders

Templates use variable placeholders in the format {{VARIABLE_NAME}} for dynamic content:

- {{ENTERPRISE_NAME}} - Enterprise name
- {{CANDIDATE_NAME}} - Candidate name
- {{JOB_TITLE}} - Job title
- {{APP_NAME}} - Application name
- And many more...

Event Code Structure

Each event code includes:
- code: Unique event code identifier
- name: Human-readable event name
- templateVariables: Array of available template variables with labels and values

Development

$3

`bash
npm run build
`

$3

`bash
npm run clean
`

License

MIT

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature`)
5. Open a Pull Request

Support

For support, email support@simplifyhire.com or create an issue in the GitHub repository.