@procxo/shared 1.0.4 → 1.0.5

package/package.json

@@ -1,70 +1,50 @@
-{
-  "name": "@procxo/shared",
-  "version": "1.0.4",
-  "description": "Shared library for Invoice Management - centralized entities, migrations, and seeders",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "tsc -p tsconfig.build.json",
-    "build:watch": "tsc -p tsconfig.build.json --watch",
-    "clean": "rimraf dist",
-    "prebuild": "npm run clean",
-    "typeorm": "cross-env NODE_ENV=migration ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js -d src/config/typeorm.config.ts",
-    "migration:generate": "npm run typeorm -- migration:generate",
-    "migration:create": "npm run typeorm -- migration:create",
-    "migration:run": "npm run typeorm -- migration:run",
-    "migration:revert": "npm run typeorm -- migration:revert",
-    "migration:show": "npm run typeorm -- migration:show",
-    "schema:create": "ts-node -r tsconfig-paths/register src/scripts/create-schema.ts",
-    "seed:run": "ts-node -r tsconfig-paths/register src/database/seeder/seed-runner.ts"
-  },
-  "dependencies": {
-    "class-transformer": "^0.5.1",
-    "class-validator": "^0.14.1",
-    "dotenv": "^16.4.7",
-    "pg": "^8.14.0",
-    "reflect-metadata": "^0.2.2",
-    "typeorm": "^0.3.21"
-  },
-  "devDependencies": {
-    "@jorgebodega/typeorm-seeding": "^7.1.0",
-    "@nestjs/common": "^11.0.1",
-    "@nestjs/typeorm": "^11.0.0",
-    "cross-env": "^7.0.3",
-    "rimraf": "^5.0.5",
-    "ts-node": "^10.9.2",
-    "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.7.3"
-  },
-  "peerDependencies": {
-    "@nestjs/common": ">=11.0.0",
-    "@nestjs/typeorm": ">=11.0.0",
-    "typeorm": ">=0.3.21"
-  },
-  "files": [
-    "src/**/*",
-    "README.md",
-    "package.json"
-  ],
-  "keywords": [
-    "typeorm",
-    "database",
-    "migrations",
-    "seeders",
-    "nestjs",
-    "postgres",
-    "entities",
-    "invoice-management",
-    "orm"
-  ],
-  "author": "Procxo hello@procxo.ai",
-  "license": "UNLICENSED",
-  "repository": {
-    "type": "git",
-    "url": "https://ntgitlab.novatechset.com/invoice_management/shared-lib.git"
-  },
-  "bugs": {
-    "url": "https://ntgitlab.novatechset.com/invoice_management/shared-lib.git"
-  },
-  "homepage": "https://ntgitlab.novatechset.com/invoice_management/shared-lib.git#readme"
-}
+{
+  "name": "@procxo/shared",
+  "version": "1.0.5",
+  "description": "Shared library for Invoice Management - centralized entities, migrations, and seeders",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "build:watch": "tsc -p tsconfig.build.json --watch",
+    "clean": "rimraf dist",
+    "prebuild": "npm run clean",
+    "typeorm": "cross-env NODE_ENV=migration ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js -d src/config/typeorm.config.ts",
+    "migration:generate": "npm run typeorm -- migration:generate",
+    "migration:create": "npm run typeorm -- migration:create",
+    "migration:run": "npm run typeorm -- migration:run",
+    "migration:revert": "npm run typeorm -- migration:revert",
+    "migration:show": "npm run typeorm -- migration:show",
+    "schema:create": "ts-node -r tsconfig-paths/register src/scripts/create-schema.ts",
+    "seed:run": "ts-node -r tsconfig-paths/register src/database/seeder/seed-runner.ts"
+  },
+  "dependencies": {
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
+    "dotenv": "^16.4.7",
+    "pg": "^8.14.0",
+    "reflect-metadata": "^0.2.2",
+    "typeorm": "^0.3.21"
+  },
+  "devDependencies": {
+    "@jorgebodega/typeorm-seeding": "^7.1.0",
+    "@nestjs/common": "^11.0.1",
+    "@nestjs/typeorm": "^11.0.0",
+    "cross-env": "^7.0.3",
+    "rimraf": "^5.0.5",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.7.3"
+  },
+  "peerDependencies": {
+    "@nestjs/common": ">=11.0.0",
+    "@nestjs/typeorm": ">=11.0.0",
+    "typeorm": ">=0.3.21"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "keywords": [],
+  "author": "",
+  "license": "UNLICENSED"
+}

package/README.md

@@ -1,250 +0,0 @@
-# @procxo/shared
-
-A shared TypeORM library providing centralized database entities, migrations, and seeders for Invoice Management applications.
-
-## Features
-
-- 🗄️ **70+ Pre-built TypeORM Entities** - Ready-to-use database models
-- 🔄 **Automatic Schema Management** - Create schemas across multiple databases
-- 📦 **Database Migrations** - Version-controlled schema changes
-- 🌱 **Smart Seeders** - Pre-configured data seeding with admin user
-- ⚙️ **Dynamic Configuration** - Flexible ORM config factory for NestJS
-- 📊 **Multi-Schema Support** - user, core, timesheet, notification schemas
-
-## Installation
-
-```bash
-npm install @procxo/shared
-```
-
-### Prerequisites
-
-- Node.js >= 16
-- PostgreSQL database
-- NestJS >= 11 (for integration)
-- TypeORM >= 0.3.21
-
-## Quick Start
-
-### 1. Configure Environment Variables
-
-Create a `.env` file in your project root:
-
-```env
-DB_HOST=localhost
-DB_PORT=5432
-DB_USERNAME=postgres
-DB_PASSWORD=postgres
-DB_NAME=your_database
-NODE_ENV=development
-```
-
-### 2. Use in NestJS Application
-
-```typescript
-import { Module } from '@nestjs/common';
-import { TypeOrmModule } from '@nestjs/typeorm';
-import { createOrmConfig } from '@procxo/shared';
-
-@Module({
-  imports: [
-    TypeOrmModule.forRoot(
-      createOrmConfig({
-        schema: 'core', // or 'user', 'timesheet', 'notification'
-        synchronize: false,
-        logging: true,
-      })
-    ),
-  ],
-})
-export class AppModule {}
-```
-
-### 3. Import Entities
-
-```typescript
-import {
-  User,
-  Role,
-  Permission,
-  Invoice,
-  Task,
-  Matter,
-  Timesheet,
-} from '@procxo/shared';
-
-// Use entities in your services/repositories
-```
-
-## Database Setup
-
-Run these commands in order for initial setup:
-
-```bash
-# 1. Create database schemas
-npm run schema:create
-
-# 2. Generate initial migration (first time only)
-npm run migration:generate -- src/database/migrations/initialMigration
-
-# 3. Run migrations
-npm run migration:run
-
-# 4. Seed initial data (admin user, roles, permissions)
-npm run seed:run
-```
-
-## Available Commands
-
-### Schema Management
-
-```bash
-npm run schema:create          # Create all required database schemas
-```
-
-### Migrations
-
-```bash
-npm run migration:generate -- <path>  # Generate new migration from entity changes
-npm run migration:create -- <name>    # Create empty migration file
-npm run migration:run                 # Execute pending migrations
-npm run migration:revert              # Revert last migration
-npm run migration:show                # Show migration status
-```
-
-### Seeding
-
-```bash
-npm run seed:run              # Run all seeders (departments, roles, admin user, etc.)
-```
-
-### Build
-
-```bash
-npm run build                 # Compile TypeScript to dist/
-npm run build:watch           # Watch mode for development
-```
-
-## API Reference
-
-### `createOrmConfig(options: OrmConfigOptions)`
-
-Factory function to generate TypeORM configuration for NestJS.
-
-**Options:**
-- `schema` (required): Target database schema
-- `additionalEntities`: Extra entities specific to your service
-- `synchronize`: Auto-sync entities (default: false)
-- `logging`: Enable query logging
-
-**Example:**
-```typescript
-createOrmConfig({
-  schema: 'timesheet',
-  additionalEntities: [CustomEntity],
-  synchronize: false,
-  logging: true,
-});
-```
-
-### `getAllSharedEntities()`
-
-Returns all entity classes from the shared library.
-
-```typescript
-import { getAllSharedEntities } from '@procxo/shared';
-
-const entities = getAllSharedEntities(); // Returns array of entity classes
-```
-
-## Included Seeders
-
-The package includes pre-configured seeders for:
-
-- ✅ **Departments** - Default organizational departments
-- ✅ **Permissions** - System-wide permissions
-- ✅ **Roles** - Admin, User roles with hierarchies
-- ✅ **Admin User** - Default admin account
-- ✅ **Currency** - Common currencies
-- ✅ **Countries & Cities** - Geographic data
-
-## Entity Categories
-
-| Schema | Entities |
-|--------|----------|
-| **User** | User, Role, Permission, Department, Leave, Approvals, Sessions |
-| **Core** | Client, Matter, Task, Invoice, Payment, Template, QuickBooks |
-| **Timesheet** | Timesheet, Event, Shift, Holiday |
-| **Notification** | Alert, Preferences, Channels |
-
-## Publishing This Package
-
-### Before Publishing
-
-1. Update version in `package.json`:
-   ```bash
-   npm version patch  # or minor/major
-   ```
-
-2. Build the package:
-   ```bash
-   npm run build
-   ```
-
-3. Verify build output in `dist/` folder
-
-### Publish to npm Registry
-
-```bash
-# Login to npm (first time)
-npm login
-
-# Publish package
-npm publish --access public
-```
-
-### Publish to GitHub Packages (Alternative)
-
-Add to `package.json`:
-```json
-{
-  "publishConfig": {
-    "registry": "https://npm.pkg.github.com"
-  }
-}
-```
-
-Then publish:
-```bash
-npm publish
-```
-
-## Development
-
-```bash
-# Install dependencies
-npm install
-
-# Build package
-npm run build
-
-# Watch mode for development
-npm run build:watch
-```
-
-## Environment Support
-
-- **Development**: Full logging, synchronize enabled
-- **Production**: Minimal logging, synchronize disabled
-
-## License
-
-UNLICENSED
-
-## Support
-
-For issues or questions, please contact the development team.
-
----
-
-**Note**: This is an internal package for Invoice Management applications. Ensure database credentials are properly configured before running migrations or seeders.

package/src/config/index.ts

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

package/src/config/ormconfig.factory.ts

@@ -1,102 +0,0 @@
-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

@@ -1,22 +0,0 @@
-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

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

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

@@ -1,113 +0,0 @@
-/**
- * @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

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

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

@@ -1,30 +0,0 @@
-[
-    {
-      "roleName": "Super Admin",
-      "roleSlug": "super_admin",
-      "roleDescription": "Super Admin role with all privileges",
-      "isMainRoleSlug": true,
-      "isActive": true
-    },
-    {
-      "roleName": "Partner",
-      "roleSlug": "partner",
-      "roleDescription": "Partner role with elevated privileges",
-      "isMainRoleSlug": true,
-      "isActive": true
-    },
-    {
-      "roleName": "Manager",
-      "roleSlug": "manager",
-      "roleDescription": "Manager role with supervisory access",
-      "isMainRoleSlug": true,
-      "isActive": true
-    },
-    {
-      "roleName": "Associate",
-      "roleSlug": "associate",
-      "roleDescription": "Associate role with standard access",
-      "isMainRoleSlug": true,
-      "isActive": true
-    }
-  ]

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

@@ -1,12 +0,0 @@
-[
-    {
-      "name": "Super Admin",
-      "email": "hsinghi@katalysttech.com",
-      "password": "123456789",
-      "countryCode": "+91",
-      "phoneNumber": "9636377887",
-      "isActive": true,
-      "roleName": "Super Admin",
-      "departmentName":null
-    }
-  ]