npm package: @hirehq/enterprise-master-data
Description: Master email touchpoints constants and templates for SimplifyHire enterprise platform
Author: Hirehq developer
Latest version: 1.4.1

# @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

### Email Templates
The package provides a comprehensive collection of email templates for various enterprise scenarios:

- **Domain Management**: Domain verification and setup emails
- **General**: Job application notifications
- **Offer Management**: Offer acceptance and decline notifications
- **Contract Management**: Contract termination notifications
- **Communication**: Candidate messaging notifications
- **Talent Pool Management**: Unbind requests and talent pool notifications
- **User Management**: User invitations and registrations
- **Authentication**: Account verification and password reset
- **Interview Management**: Interview scheduling, confirmations, and feedback
- **Analytics**: Data report downloads
- **Workflow Management**: Hiring workflow notifications
- **Platform**: Various platform-specific notifications

### Email Layout Configuration
Standardized email layout configuration with:
- Header configuration (logo, title, background)
- Footer configuration
- Responsive design settings

### Communication Preferences
Predefined communication preferences for different event types with email, SMS, and WhatsApp options.

### Email Event Codes
Comprehensive collection of email event codes with their associated template variables for dynamic content generation.

## Template Structure

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

### Building

```bash
npm run build
```

### Cleaning

```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.