av6-core 1.0.3 → 1.0.4

package/README.md

@@ -10,6 +10,7 @@ A comprehensive utility library for AV6 Node.js projects, providing common funct
 - **Pagination**: Built-in pagination for search results
 - **DTO Mapping**: Support for Data Transfer Object mapping
 - **Type Safety**: Written in TypeScript with comprehensive type definitions
+- **UIN Config Management**: Unique Identification Number generation with configurable segments and automatic reset policies
 
 ## Installation
 
@@ -123,6 +124,71 @@ const workbook = await service.commonExcelExport({
 });
 ```
 
+### UIN Config Operations
+
+```typescript
+import { uinConfigService, UinDeps, UIN_RESET_POLICY, UinShortCode } from 'av6-core';
+
+// Initialize UIN Config dependencies
+const uinDeps: UinDeps = {
+  config: {
+    REDIS_PREFIX: 'your-prefix:',
+    CACHE_KEY_NAME: 'your-cache-key'
+  },
+  helpers: {
+    generateErrorMessage: (type, ...variables) => {
+      // Your error message generation logic
+    },
+    ErrorHandler: class ErrorHandler extends Error {
+      // Your error handler implementation
+    }
+  },
+  logger: winston.createLogger({
+    // Your logger configuration
+  }),
+  cacheAdapter: {
+    // Your cache adapter implementation
+  },
+  requestStorage: new AsyncLocalStorage(),
+  db: new PrismaClient(),
+  prisma: PrismaNamespace,
+  shortCode: 'UIN_CONFIG',
+  cacheKey: 'uin-config'
+};
+
+// Initialize the UIN Config service
+const uinService = uinConfigService(uinDeps);
+
+// Create a new UIN Config
+const newUinConfig = await uinService.createUINConfig({
+  shortCode: UinShortCode.INVOICE,
+  seqResetPolicy: UIN_RESET_POLICY.monthly,
+  description: 'Invoice number generator',
+  uinSegments: [
+    { order: 1, type: 'text', value: 'INV-' },
+    { order: 2, type: 'dateFormat', value: 'YYYYMM' },
+    { order: 3, type: 'separator', value: '-' },
+    { order: 4, type: 'sequenceNo', minSeqLength: 5 }
+  ]
+});
+
+// Generate a UIN preview
+const uinPreview = await uinService.previewUIN({
+  uinSegments: [
+    { order: 1, type: 'text', value: 'INV-' },
+    { order: 2, type: 'dateFormat', value: 'YYYYMM' },
+    { order: 3, type: 'separator', value: '-' },
+    { order: 4, type: 'sequenceNo', minSeqLength: 5 }
+  ]
+});
+
+// Get a UIN Config by ID
+const uinConfig = await uinService.getUINConfigById(1);
+
+// Generate a new UIN
+const generatedUin = await uinService.generateUIN(UinShortCode.INVOICE);
+```
+
 ## API Reference
 
 ### Common Service
@@ -141,6 +207,18 @@ The library provides a comprehensive service for common operations:
 - `updateStatus`: Update the status of a record
 - `fetchImageStream`: Fetch an image as a stream
 
+### UIN Config Service
+
+The library provides a service for managing Unique Identification Numbers:
+
+- `createUINConfig`: Create a new UIN configuration
+- `updateUINConfig`: Update an existing UIN configuration
+- `getUINConfigById`: Retrieve a UIN configuration by ID
+- `getAllUINConfig`: Retrieve all UIN configurations
+- `deleteUINConfig`: Delete a UIN configuration
+- `generateUIN`: Generate a new UIN based on a shortcode
+- `previewUIN`: Preview a UIN based on segment configuration
+
 ### Utility Functions
 
 The library also provides utility functions:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "av6-core",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -16,10 +16,13 @@
     "typescript": "^5.9.2"
   },
   "peerDependencies": {
-    "prisma": "^6.14.0",
     "@prisma/client": "^6.14.0",
     "axios": "^1.11.0",
     "exceljs": "^4.4.0",
+    "prisma": "^6.14.0",
     "winston": "^3.17.0"
+  },
+  "dependencies": {
+    "node-cron": "^4.2.1"
   }
 }