@caucasus/az-utils 0.2.2 → 0.3.0

package/README.md

@@ -2,7 +2,6 @@
 ![npm version](https://img.shields.io/npm/v/@caucasus/az-utils)
 ![license](https://img.shields.io/npm/l/@caucasus/az-utils)
 
-
 # az-utils 🇦🇿
 
 A lightweight, TypeScript-first utility library providing **Azerbaijan-specific helpers** commonly needed in backend development.
@@ -10,6 +9,7 @@ A lightweight, TypeScript-first utility library providing **Azerbaijan-specific
 This package focuses on **validation, normalization, and parsing** of data formats frequently used in Azerbaijan-based systems.
 
 > Initial release focuses on **Azerbaijan mobile phone utilities**
+> Added support for **FIN and local ID utilities**
 
 ---
 
@@ -21,14 +21,25 @@ This package focuses on **validation, normalization, and parsing** of data forma
 - Normalize phone numbers to a standard local format
 - Detect mobile operator (Azercell, Bakcell, Nar)
 
-More utilities (FIN, IBAN, passport, addresses) will be added incrementally.
+### 📱 FIN Utilities
+
+- Validate FIN
+- Normalize FIN
+
+### 📱 Passport Utilities
+
+- Validate local ID series
+- Normalize ID series
+- Supported series (AZE,AA,AB)
+
+More utilities (IBAN, addresses) will be added incrementally.
 
 ---
 
 ## 📦 Installation
 
 ```bash
-npm install @samurai-jack/az-utils
+npm install @caucasus/az-utils
 
 ```
 
@@ -38,7 +49,10 @@ npm install @samurai-jack/az-utils
 import {
   isValidAzPhone,
   normalizeAzPhone,
-  getAzMobileOperator
+  getAzMobileOperator,
+  IsAzPhone,
+  TransformAzPhone
+  ...etc
 } from "az-utils";
 
 ```
@@ -50,7 +64,9 @@ isValidAzPhone("+994 (50) 123-45-67"); // true
 isValidAzPhone("0501234567");         // true
 isValidAzPhone("0401234567");         // false
 ```
+
 Supported input formats:
+
 - 0501234567
 - 050 123 45 67
 - (050) 123-45-67
@@ -82,26 +98,43 @@ getAzMobileOperator("0771234567");
 
 ```
 
+## Decorator support (DTO)
+
+```
+class TestDto {
+  @IsAzPhone()
+  phone!: string;
+
+  @IsFin()
+  fin!: string
+
+  @IsSeries()
+  idSeries!: string
+}
+```
+
 ### Supported Prefixes
 
+## Mobile phones 
+
 | Prefix       | Operator |
-| --------     | -------- |
+| ------------ | -------- |
 | 050, 051,010 | Azercell |
 | 055, 099     | Bakcell  |
 | 070, 077     | Nar      |
 
+## Local ID series
+
+AZE, AA, AB
 
+---
 
-## 🛣 Roadmap   
+## 🛣 Roadmap
 
 Planned additions:
 
-- FIN (Fərdi İdentifikasiya Nömrəsi) validation
-
 - Azerbaijan IBAN validation
 
-- Passport series validation
-
 - Address parsing utilities
 
 - Localization helpers (AZ / EN / RU)
@@ -118,9 +151,8 @@ Please:
 
 - Avoid breaking changes without discussion
 
-##  📄 License
+## 📄 License
 
 MIT License © Contributors
 
---- 
-
+---

package/dist/fin/decorators/index.d.ts

@@ -0,0 +1,2 @@
+export { IsFin } from "./isFin.decorator";
+export { TransformFin } from "./transform-fin.decorators";

package/dist/fin/decorators/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransformFin = exports.IsFin = void 0;
+var isFin_decorator_1 = require("./isFin.decorator");
+Object.defineProperty(exports, "IsFin", { enumerable: true, get: function () { return isFin_decorator_1.IsFin; } });
+var transform_fin_decorators_1 = require("./transform-fin.decorators");
+Object.defineProperty(exports, "TransformFin", { enumerable: true, get: function () { return transform_fin_decorators_1.TransformFin; } });

package/dist/fin/decorators/isFin.decorator.d.ts

@@ -0,0 +1,2 @@
+import { ValidationOptions } from "class-validator";
+export declare function IsFin(validationOptions?: ValidationOptions): PropertyDecorator;

package/dist/fin/decorators/isFin.decorator.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IsFin = IsFin;
+const class_validator_1 = require("class-validator");
+const isValidFin_1 = require("../isValidFin");
+function IsFin(validationOptions) {
+    return function (target, propertyKey) {
+        (0, class_validator_1.registerDecorator)({
+            name: "IsFin",
+            target: target.constructor,
+            propertyName: propertyKey,
+            options: validationOptions,
+            validator: {
+                validate(value) {
+                    return typeof value === "string" && (0, isValidFin_1.isValidFin)(value);
+                },
+                defaultMessage() {
+                    return "$property must be a valid Azerbaijan FIN";
+                },
+            },
+        });
+    };
+}

package/dist/fin/decorators/transform-fin.decorators.d.ts

@@ -0,0 +1 @@
+export declare function TransformFin(): PropertyDecorator;

package/dist/fin/decorators/transform-fin.decorators.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransformFin = TransformFin;
+const class_transformer_1 = require("class-transformer");
+const normalizeFin_1 = require("../normalizeFin");
+function TransformFin() {
+    return (0, class_transformer_1.Transform)(({ value }) => {
+        if (value === undefined || value === null)
+            return value;
+        if (typeof value !== "string")
+            return value;
+        return (0, normalizeFin_1.normalizeFin)(value);
+    });
+}

package/dist/fin/index.d.ts

@@ -1 +1,3 @@
-export {};
+export { isValidFin } from "./isValidFin";
+export { normalizeFin } from "./normalizeFin";
+export * from "./decorators";

package/dist/fin/index.js

@@ -1,2 +1,22 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeFin = exports.isValidFin = void 0;
+var isValidFin_1 = require("./isValidFin");
+Object.defineProperty(exports, "isValidFin", { enumerable: true, get: function () { return isValidFin_1.isValidFin; } });
+var normalizeFin_1 = require("./normalizeFin");
+Object.defineProperty(exports, "normalizeFin", { enumerable: true, get: function () { return normalizeFin_1.normalizeFin; } });
+__exportStar(require("./decorators"), exports);

package/dist/fin/isValidFin.d.ts

@@ -0,0 +1 @@
+export declare function isValidFin(fin: string): boolean;

package/dist/fin/isValidFin.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidFin = isValidFin;
+function isValidFin(fin) {
+    if (typeof fin !== "string")
+        return false;
+    return /^[A-Z0-9]{7}$/.test(fin.toUpperCase());
+}

package/dist/fin/normalizeFin.d.ts

@@ -0,0 +1 @@
+export declare function normalizeFin(fin: string): string;

package/dist/fin/normalizeFin.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeFin = normalizeFin;
+function normalizeFin(fin) {
+    if (typeof fin !== "string")
+        return fin;
+    return fin.toUpperCase();
+}

package/dist/index.d.ts

@@ -1 +1,3 @@
 export * from "./phone";
+export * from "./fin";
+export * from "./passport";

package/dist/index.js

@@ -15,3 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./phone"), exports);
+__exportStar(require("./fin"), exports);
+__exportStar(require("./passport"), exports);

package/dist/passport/constants.d.ts

@@ -0,0 +1 @@
+export declare const SERIES_REGEX: RegExp;

package/dist/passport/constants.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SERIES_REGEX = void 0;
+exports.SERIES_REGEX = /^(AZE\d{8}|AA\d{7}|AB\d{7})$/;

package/dist/passport/decorators/index.d.ts

@@ -0,0 +1,2 @@
+export { IsSeries } from "./isSeries.decorator";
+export { TransformSeries } from "./transformSeries.decorator";

package/dist/passport/decorators/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransformSeries = exports.IsSeries = void 0;
+var isSeries_decorator_1 = require("./isSeries.decorator");
+Object.defineProperty(exports, "IsSeries", { enumerable: true, get: function () { return isSeries_decorator_1.IsSeries; } });
+var transformSeries_decorator_1 = require("./transformSeries.decorator");
+Object.defineProperty(exports, "TransformSeries", { enumerable: true, get: function () { return transformSeries_decorator_1.TransformSeries; } });

package/dist/passport/decorators/isSeries.decorator.d.ts

@@ -0,0 +1,2 @@
+import { ValidationOptions } from "class-validator";
+export declare function IsSeries(validationOptions?: ValidationOptions): PropertyDecorator;

package/dist/passport/decorators/isSeries.decorator.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IsSeries = IsSeries;
+const class_validator_1 = require("class-validator");
+const isValidSeries_1 = require("../isValidSeries");
+function IsSeries(validationOptions) {
+    return function (target, propertyKey) {
+        (0, class_validator_1.registerDecorator)({
+            name: "IsSeries",
+            target: target.constructor,
+            propertyName: propertyKey,
+            options: validationOptions,
+            validator: {
+                validate(value) {
+                    return typeof value === "string" && (0, isValidSeries_1.isValidSeries)(value);
+                },
+                defaultMessage() {
+                    return "$property must be a valid Azerbaijan series";
+                },
+            },
+        });
+    };
+}

package/dist/passport/decorators/transformSeries.decorator.d.ts

@@ -0,0 +1 @@
+export declare function TransformSeries(): PropertyDecorator;

package/dist/passport/decorators/transformSeries.decorator.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransformSeries = TransformSeries;
+const class_transformer_1 = require("class-transformer");
+const normalizeSeries_1 = require("../normalizeSeries");
+function TransformSeries() {
+    return (0, class_transformer_1.Transform)(({ value }) => {
+        if (value === undefined || value === null)
+            return value;
+        if (typeof value !== "string")
+            return value;
+        return (0, normalizeSeries_1.normalizeSeries)(value);
+    });
+}

package/dist/passport/index.d.ts

@@ -1 +1,3 @@
-export {};
+export { isValidSeries } from "./isValidSeries";
+export { normalizeSeries } from "./normalizeSeries";
+export * from "./decorators";

package/dist/passport/index.js

@@ -1,2 +1,22 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeSeries = exports.isValidSeries = void 0;
+var isValidSeries_1 = require("./isValidSeries");
+Object.defineProperty(exports, "isValidSeries", { enumerable: true, get: function () { return isValidSeries_1.isValidSeries; } });
+var normalizeSeries_1 = require("./normalizeSeries");
+Object.defineProperty(exports, "normalizeSeries", { enumerable: true, get: function () { return normalizeSeries_1.normalizeSeries; } });
+__exportStar(require("./decorators"), exports);

package/dist/passport/isValidSeries.d.ts

@@ -0,0 +1 @@
+export declare function isValidSeries(series: string): boolean;

package/dist/passport/isValidSeries.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidSeries = isValidSeries;
+const constants_1 = require("./constants");
+function isValidSeries(series) {
+    if (typeof series !== "string")
+        return false;
+    return constants_1.SERIES_REGEX.test(series.toUpperCase());
+}

package/dist/passport/normalizeSeries.d.ts

@@ -0,0 +1 @@
+export declare function normalizeSeries(series: string): string;

package/dist/passport/normalizeSeries.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeSeries = normalizeSeries;
+function normalizeSeries(series) {
+    if (typeof series !== "string")
+        return series;
+    return series.toUpperCase().trim();
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caucasus/az-utils",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "Azerbaijan-specific utility functions for Node.js backends",
   "type": "commonjs",
   "main": "dist/index.js",