@procxo/shared 1.0.2 → 1.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@procxo/shared",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Shared library for Invoice Management - centralized entities, migrations, and seeders",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -42,7 +42,9 @@
     "typeorm": ">=0.3.21"
   },
   "files": [
-    "dist/**/*"
+    "src/**/*",
+    "README.md",
+    "package.json"
   ],
   "keywords": [
     "typeorm",

package/src/config/index.ts

@@ -0,0 +1,5 @@
+export {
+  createOrmConfig,
+  getAllSharedEntities,
+  OrmConfigOptions,
+} from './ormconfig.factory';

package/src/config/ormconfig.factory.ts

@@ -0,0 +1,102 @@
+import { TypeOrmModuleOptions } from '@nestjs/typeorm';
+import {
+  User, Role, Permission, RolePermission, UserRole, Department, FileData,
+  Chat, Entitlement, LeaveType, LeaveBalance, LeaveRequest, Gst, UploadLog,
+  OwnershipTransfer, UserSessionHistory,
+  ApprovalHierarchy, ApprovalHierarchyRole, ApprovalHierarchyUser,
+  ApprovalLevel, ApprovalLevelUser, ApprovalLevelEscalation,
+  ApprovalLevelEscalationUser, ApprovalCondition, ApprovalJourney,
+  Currency, Country, City, Client, Contact, Address,
+  Matter, MatterTag, MatterTeamMember, MatterTaskViewFilter,
+  Task, TaskType, TaskUser, TaskTag, TaskComment, TaskMilestone, TaskReminder,
+  SubTask, SubTaskUser, SubTaskTag, Tag,
+  Template, TemplateTask,
+  Invoice, InvoiceItem, UserInvoiceTemplateEntity,
+  UserInvoiceTemplateHeaderEntity, UserInvoiceTemplateTableEntity,
+  UserInvoiceTemplateFooterEntity, FixedInvoiceItem,
+  Payment, CreditNoteEntity, Expense, Group, Superset,
+  QuickBooksConnection, QuickBooksSyncLog,
+  ActivityLog, TaskStatus, TimesheetSummary, SequenceGenerator,
+  Timesheet, TimesheetEvent, TimesheetComment,
+  Shift, RoleShift, UserShift, Holiday,
+  Alert, UserNotificationPreference, UserNotificationChannel,
+} from '../database/entities';
+
+export interface OrmConfigOptions {
+  /** Database schema the service operates on */
+  schema: string;
+  /** Additional entity classes specific to the consuming service */
+  additionalEntities?: Function[];
+  /** Override synchronize flag (default: false) */
+  synchronize?: boolean;
+  /** Override logging flag */
+  logging?: boolean;
+}
+
+/**
+ * Returns all entity classes from the shared-lib across all schemas.
+ */
+export function getAllSharedEntities(): Function[] {
+  return [
+    // User schema
+    User, Role, Permission, RolePermission, UserRole, Department, FileData,
+    Chat, Entitlement, LeaveType, LeaveBalance, LeaveRequest, Gst, UploadLog,
+    OwnershipTransfer, UserSessionHistory,
+    ApprovalHierarchy, ApprovalHierarchyRole, ApprovalHierarchyUser,
+    ApprovalLevel, ApprovalLevelUser, ApprovalLevelEscalation,
+    ApprovalLevelEscalationUser, ApprovalCondition, ApprovalJourney,
+    // Core schema
+    Currency, Country, City, Client, Contact, Address,
+    Matter, MatterTag, MatterTeamMember, MatterTaskViewFilter,
+    Task, TaskType, TaskUser, TaskTag, TaskComment, TaskMilestone, TaskReminder,
+    SubTask, SubTaskUser, SubTaskTag, Tag,
+    Template, TemplateTask,
+    Invoice, InvoiceItem, UserInvoiceTemplateEntity,
+    UserInvoiceTemplateHeaderEntity, UserInvoiceTemplateTableEntity,
+    UserInvoiceTemplateFooterEntity, FixedInvoiceItem,
+    Payment, CreditNoteEntity, Expense, Group, Superset,
+    QuickBooksConnection, QuickBooksSyncLog,
+    ActivityLog, TaskStatus, TimesheetSummary, SequenceGenerator,
+    // Timesheet schema
+    Timesheet, TimesheetEvent, TimesheetComment,
+    Shift, RoleShift, UserShift, Holiday,
+    // Notification schema
+    Alert, UserNotificationPreference, UserNotificationChannel,
+  ];
+}
+
+/**
+ * Factory function that produces a TypeOrmModuleOptions config
+ * for a consuming NestJS service.
+ *
+ * @example
+ * import { createOrmConfig } from '@invoice-management/shared';
+ *
+ * TypeOrmModule.forRoot(createOrmConfig({
+ *   schema: 'timesheet',
+ *   synchronize: true,
+ * }));
+ */
+export function createOrmConfig(options: OrmConfigOptions): TypeOrmModuleOptions {
+  const {
+    schema,
+    additionalEntities = [],
+    synchronize = false,
+    logging,
+  } = options;
+
+  return {
+    type: 'postgres',
+    host: process.env.DB_HOST ?? 'localhost',
+    port: parseInt(process.env.DB_PORT ?? '5432', 10),
+    username: process.env.DB_USERNAME ?? 'postgres',
+    password: process.env.DB_PASSWORD ?? 'postgres',
+    database: process.env.DB_NAME ?? 'IVM',
+    entities: [...getAllSharedEntities(), ...additionalEntities],
+    schema,
+    synchronize,
+    logging: logging ?? process.env.NODE_ENV === 'development',
+    retryAttempts: 3,
+    retryDelay: 3000,
+  };
+}

package/src/config/typeorm.config.ts

@@ -0,0 +1,22 @@
+import { DataSource, DataSourceOptions } from 'typeorm';
+import { config } from 'dotenv';
+import { join } from 'path';
+import { getAllSharedEntities } from './ormconfig.factory';
+
+config();
+
+const dataSourceOptions: DataSourceOptions = {
+  type: 'postgres',
+  host: process.env.DB_HOST ?? 'localhost',
+  port: parseInt(process.env.DB_PORT ?? '5432'),
+  username: process.env.DB_USERNAME ?? 'postgres',
+  password: process.env.DB_PASSWORD ?? 'postgres',
+  database: process.env.DB_NAME ?? 'IVM',
+  entities: getAllSharedEntities(),
+  migrations: [join(__dirname, '..', 'database', 'migrations', '*.{ts,js}')],
+  synchronize: false,
+  logging: process.env.NODE_ENV === 'development',
+  migrationsTableName: 'migrations',
+};
+
+export default new DataSource(dataSourceOptions);

package/src/core/constant/index.ts

@@ -0,0 +1 @@
+export * from './notification-preference';

package/src/core/constant/notification-preference.ts

@@ -0,0 +1,113 @@
+/**
+ * @fileoverview
+ * Notification Preference Constants
+ * Contains all constants related to notification preferences, channels, and default configurations
+ * 
+ * @version 1.0
+ * @author KATALYST TEAM
+ */
+
+/**
+ * Enum for notification preference types
+ * Matches the database enum in user_notification_preferences table
+ */
+export enum NotificationPreferenceType {
+  TASK_UPDATES = 'task_updates',
+  APPROVALS_REVIEWS = 'approvals_reviews',
+  SECURITY_ALERTS = 'security_alerts',
+  BILLING_PAYMENT_UPDATES = 'billing_payment_updates',
+  MENTIONS_COMMENTS = 'mentions_comments',
+  DAILY_SUMMARY_DIGEST = 'daily_summary_digest',
+}
+
+/**
+ * Enum for notification channels
+ */
+export enum NotificationChannel {
+  EMAIL = 'email',
+  PUSH = 'push',
+  WHATSAPP = 'whatsapp',
+}
+
+/**
+ * Enum for channel field names in UserNotificationChannel entity
+ */
+export enum ChannelField {
+  EMAIL_ENABLED = 'emailEnabled',
+  PUSH_ENABLED = 'pushEnabled',
+  WHATSAPP_ENABLED = 'whatsappEnabled',
+}
+
+/**
+ * Notification Preference Configuration Interface
+ */
+export interface NotificationPreferenceConfig {
+  type: NotificationPreferenceType;
+  title: string;
+  description: string;
+  defaultEnabled: boolean;
+  supportedChannels: NotificationChannel[];
+  defaultChannels: NotificationChannel[];
+  priority: 'high' | 'medium' | 'low';
+}
+
+/**
+ * Default Notification Preference Configurations
+ * Used when creating default preferences for new users
+ */
+export const NOTIFICATION_PREFERENCE_CONFIGS: Record<NotificationPreferenceType, NotificationPreferenceConfig> = {
+  [NotificationPreferenceType.TASK_UPDATES]: {
+    type: NotificationPreferenceType.TASK_UPDATES,
+    title: 'Task Updates',
+    description: 'Get notified when a task is created, updated, completed, or overdue.',
+    defaultEnabled: true,
+    supportedChannels: [NotificationChannel.EMAIL, NotificationChannel.PUSH, NotificationChannel.WHATSAPP],
+    defaultChannels: [NotificationChannel.EMAIL, NotificationChannel.PUSH],
+    priority: 'high',
+  },
+  [NotificationPreferenceType.APPROVALS_REVIEWS]: {
+    type: NotificationPreferenceType.APPROVALS_REVIEWS,
+    title: 'Approvals & Reviews',
+    description: 'Receive alerts when a pending approval is assigned to you or requires your action.',
+    defaultEnabled: true,
+    supportedChannels: [NotificationChannel.EMAIL, NotificationChannel.PUSH, NotificationChannel.WHATSAPP],
+    defaultChannels: [NotificationChannel.EMAIL, NotificationChannel.PUSH],
+    priority: 'high',
+  },
+  [NotificationPreferenceType.SECURITY_ALERTS]: {
+    type: NotificationPreferenceType.SECURITY_ALERTS,
+    title: 'Security Alerts',
+    description: 'Get notifications for suspicious logins, password changes, and unauthorized access attempts.',
+    defaultEnabled: true,
+    supportedChannels: [NotificationChannel.EMAIL, NotificationChannel.PUSH],
+    defaultChannels: [NotificationChannel.EMAIL, NotificationChannel.PUSH],
+    priority: 'high',
+  },
+  [NotificationPreferenceType.BILLING_PAYMENT_UPDATES]: {
+    type: NotificationPreferenceType.BILLING_PAYMENT_UPDATES,
+    title: 'Billing & Payment Updates',
+    description: 'Notify users when an invoice is generated, payment is due, or a billing task is assigned.',
+    defaultEnabled: true,
+    supportedChannels: [NotificationChannel.EMAIL, NotificationChannel.PUSH],
+    defaultChannels: [NotificationChannel.EMAIL],
+    priority: 'medium',
+  },
+  [NotificationPreferenceType.MENTIONS_COMMENTS]: {
+    type: NotificationPreferenceType.MENTIONS_COMMENTS,
+    title: 'Mentions & Comments',
+    description: 'Alerts when someone mentions you in a discussion or comments on a task.',
+    defaultEnabled: true,
+    supportedChannels: [NotificationChannel.EMAIL, NotificationChannel.PUSH],
+    defaultChannels: [NotificationChannel.EMAIL, NotificationChannel.PUSH],
+    priority: 'medium',
+  },
+  [NotificationPreferenceType.DAILY_SUMMARY_DIGEST]: {
+    type: NotificationPreferenceType.DAILY_SUMMARY_DIGEST,
+    title: 'Daily Summary Digest',
+    description: 'Choose to receive a daily report of pending tasks, overdue approvals, and priority items.',
+    defaultEnabled: true,
+    supportedChannels: [NotificationChannel.EMAIL],
+    defaultChannels: [NotificationChannel.EMAIL],
+    priority: 'low',
+  },
+};

package/src/core/json/core-data/currency.json

@@ -0,0 +1,8 @@
+[
+    {
+      "name": "Indian Rupee",
+      "code": "INR",
+      "symbol": "₹",
+      "isActive": true
+    }
+  ]

package/{dist → src}/core/json/core-data/department.json

@@ -1,38 +1,38 @@
-[
-    {
-        "departmentName": "Engineering",
-        "departmentDescription": "Engineering department responsible for technical infrastructure",
-        "departmentSlug": "engineering",
-        "isActive": true
-    },
-    {
-        "departmentName": "Information Technology",
-        "departmentDescription": "IT department responsible for technical infrastructure",
-        "departmentSlug": "information-technology",
-        "isActive": true
-    },
-    {
-        "departmentName": "Human Resources",
-        "departmentDescription": "HR department responsible for employee management",
-        "departmentSlug": "human-resources",
-        "isActive": true
-    },
-    {
-        "departmentName": "Finance",
-        "departmentDescription": "Finance department responsible for financial operations",
-        "departmentSlug": "finance",
-        "isActive": true
-    },
-    {
-        "departmentName": "Marketing",
-        "departmentDescription": "Marketing department responsible for brand and marketing",
-        "departmentSlug": "marketing",
-        "isActive": true
-    },
-    {
-        "departmentName": "Operations",
-        "departmentDescription": "Operations department responsible for day-to-day operations",
-        "departmentSlug": "operations",
-        "isActive": true
-    }
-]
+[
+    {
+        "departmentName": "Engineering",
+        "departmentDescription": "Engineering department responsible for technical infrastructure",
+        "departmentSlug": "engineering",
+        "isActive": true
+    },
+    {
+        "departmentName": "Information Technology",
+        "departmentDescription": "IT department responsible for technical infrastructure",
+        "departmentSlug": "information-technology",
+        "isActive": true
+    },
+    {
+        "departmentName": "Human Resources",
+        "departmentDescription": "HR department responsible for employee management",
+        "departmentSlug": "human-resources",
+        "isActive": true
+    },
+    {
+        "departmentName": "Finance",
+        "departmentDescription": "Finance department responsible for financial operations",
+        "departmentSlug": "finance",
+        "isActive": true
+    },
+    {
+        "departmentName": "Marketing",
+        "departmentDescription": "Marketing department responsible for brand and marketing",
+        "departmentSlug": "marketing",
+        "isActive": true
+    },
+    {
+        "departmentName": "Operations",
+        "departmentDescription": "Operations department responsible for day-to-day operations",
+        "departmentSlug": "operations",
+        "isActive": true
+    }
+]