@caucasus/az-utils 0.2.3 → 0.4.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,7 +21,18 @@ 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.
 
 ---
 
@@ -41,6 +52,7 @@ import {
   getAzMobileOperator,
   IsAzPhone,
   TransformAzPhone
+  ...etc
 } from "az-utils";
 
 ```
@@ -52,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
@@ -90,29 +104,37 @@ getAzMobileOperator("0771234567");
 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   
+---
 
-Planned additions:
+## 🛣 Roadmap
 
-- FIN (Fərdi İdentifikasiya Nömrəsi) validation
+Planned additions:
 
 - Azerbaijan IBAN validation
 
-- Passport series validation
-
 - Address parsing utilities
 
 - Localization helpers (AZ / EN / RU)
@@ -129,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/dist/phone/{operators.d.ts → constants/operator.constants.d.ts}

@@ -1,2 +1,3 @@
 export type AzMobileOperator = "Azercell" | "Bakcell" | "Nar" | "Unknown";
 export declare const OPERATOR_PREFIX_MAP: Record<string, AzMobileOperator>;
+export declare const AZ_PHONE_PREFIX: "+994";

package/dist/phone/{operators.js → constants/operator.constants.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OPERATOR_PREFIX_MAP = void 0;
+exports.AZ_PHONE_PREFIX = exports.OPERATOR_PREFIX_MAP = void 0;
 exports.OPERATOR_PREFIX_MAP = {
     "50": "Azercell",
     "51": "Azercell",
@@ -10,3 +10,4 @@ exports.OPERATOR_PREFIX_MAP = {
     "70": "Nar",
     "77": "Nar",
 };
+exports.AZ_PHONE_PREFIX = "+994";

package/dist/phone/constants/regex.constants.d.ts

@@ -0,0 +1,4 @@
+export declare const NUMBER_LENGTH_REX: RegExp;
+export declare const NUMBER_CLEANING_REX: RegExp;
+export declare const NUMBER_PARTITION_WITH_PREFIX_REX: RegExp;
+export declare const NUMBER_PARTITION_LOCAL_REX: RegExp;

package/dist/phone/constants/regex.constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NUMBER_PARTITION_LOCAL_REX = exports.NUMBER_PARTITION_WITH_PREFIX_REX = exports.NUMBER_CLEANING_REX = exports.NUMBER_LENGTH_REX = void 0;
+exports.NUMBER_LENGTH_REX = /^\d{9}$/;
+exports.NUMBER_CLEANING_REX = /[\s\-()]/g;
+exports.NUMBER_PARTITION_WITH_PREFIX_REX = /^\+994(\d{2})(\d{3})(\d{2})(\d{2})$/;
+exports.NUMBER_PARTITION_LOCAL_REX = /^0(\d{2})(\d{3})(\d{2})(\d{2})$/;

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

@@ -1,2 +1,2 @@
-export { IsAzPhone } from "./isAzPhone.decorator";
-export { TransformAzPhone } from "./transformAzPhone.decorator";
+export { IsAzPhone } from "./is-az-phone.decorator";
+export { TransformAzPhone } from "./transform-az-phone.decorator";

package/dist/phone/decorators/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransformAzPhone = exports.IsAzPhone = void 0;
-var isAzPhone_decorator_1 = require("./isAzPhone.decorator");
-Object.defineProperty(exports, "IsAzPhone", { enumerable: true, get: function () { return isAzPhone_decorator_1.IsAzPhone; } });
-var transformAzPhone_decorator_1 = require("./transformAzPhone.decorator");
-Object.defineProperty(exports, "TransformAzPhone", { enumerable: true, get: function () { return transformAzPhone_decorator_1.TransformAzPhone; } });
+var is_az_phone_decorator_1 = require("./is-az-phone.decorator");
+Object.defineProperty(exports, "IsAzPhone", { enumerable: true, get: function () { return is_az_phone_decorator_1.IsAzPhone; } });
+var transform_az_phone_decorator_1 = require("./transform-az-phone.decorator");
+Object.defineProperty(exports, "TransformAzPhone", { enumerable: true, get: function () { return transform_az_phone_decorator_1.TransformAzPhone; } });

package/dist/phone/decorators/{isAzPhone.decorator.js → is-az-phone.decorator.js}

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IsAzPhone = IsAzPhone;
 const class_validator_1 = require("class-validator");
-const isValidAzPhone_1 = __importDefault(require("../isValidAzPhone"));
+const is_valid_az_phone_1 = __importDefault(require("../is-valid-az-phone"));
 function IsAzPhone(validationOptions) {
     return (target, propertyName) => {
         (0, class_validator_1.registerDecorator)({
@@ -15,7 +15,7 @@ function IsAzPhone(validationOptions) {
             options: validationOptions,
             validator: {
                 validate(value) {
-                    return typeof value === "string" && (0, isValidAzPhone_1.default)(value);
+                    return typeof value === "string" && (0, is_valid_az_phone_1.default)(value);
                 },
                 defaultMessage(args) {
                     return `${args.property} must be a valid Azerbaijan phone number`;

package/dist/phone/decorators/{transformAzPhone.decorator.js → transform-az-phone.decorator.js}

@@ -2,13 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransformAzPhone = TransformAzPhone;
 const class_transformer_1 = require("class-transformer");
-const normalizeAzPhone_1 = require("../normalizeAzPhone");
+const normalize_az_phone_1 = require("../normalize-az-phone");
 function TransformAzPhone() {
     return (0, class_transformer_1.Transform)(({ value }) => {
         if (value === undefined || value === null)
             return value;
         if (typeof value !== "string")
             return value;
-        return (0, normalizeAzPhone_1.normalizeAzPhone)(value);
+        return (0, normalize_az_phone_1.normalizeAzPhone)(value);
     });
 }

package/dist/phone/format.d.ts

@@ -0,0 +1,4 @@
+/**
+ * ex. 0501234567 → +994 50 123 45 67
+ */
+export declare function formatAzPhoneInternational(phone: string): string;

package/dist/phone/format.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatAzPhoneInternational = formatAzPhoneInternational;
+const operator_constants_1 = require("./constants/operator.constants");
+const regex_constants_1 = require("./constants/regex.constants");
+const normalize_az_phone_1 = require("./normalize-az-phone");
+/**
+ * ex. 0501234567 → +994 50 123 45 67
+ */
+function formatAzPhoneInternational(phone) {
+    const normalized = (0, normalize_az_phone_1.normalizeAzPhone)(phone);
+    if (!normalized)
+        return phone;
+    const match = normalized.match(regex_constants_1.NUMBER_PARTITION_LOCAL_REX);
+    if (!match)
+        return phone;
+    const [, operator, p1, p2, p3] = match;
+    return `${operator_constants_1.AZ_PHONE_PREFIX}(${operator})${p1}-${p2}-${p3}`;
+}

package/dist/phone/{getAzMobileOperator.d.ts → get-az-mobile-operator.d.ts}

@@ -1,2 +1,2 @@
-import { AzMobileOperator } from "./operators";
+import { AzMobileOperator } from "./constants/operator.constants";
 export declare function getAzMobileOperator(phone: string): AzMobileOperator;

package/dist/phone/get-az-mobile-operator.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAzMobileOperator = getAzMobileOperator;
+const operator_constants_1 = require("./constants/operator.constants");
+const normalize_az_phone_1 = require("./normalize-az-phone");
+function getAzMobileOperator(phone) {
+    const normalized = (0, normalize_az_phone_1.normalizeAzPhone)(phone);
+    if (!normalized) {
+        return "Unknown";
+    }
+    const prefix = normalized.slice(1, 3);
+    return operator_constants_1.OPERATOR_PREFIX_MAP[prefix] ?? "Unknown";
+}

package/dist/phone/index.d.ts

@@ -1,5 +1,8 @@
-export { isValidAzPhone } from "./isValidAzPhone";
-export { normalizeAzPhone } from "./normalizeAzPhone";
-export { getAzMobileOperator } from "./getAzMobileOperator";
-export type { AzMobileOperator } from "./operators";
-export * from './decorators';
+export { isValidAzPhone } from "./is-valid-az-phone";
+export { normalizeAzPhone } from "./normalize-az-phone";
+export { getAzMobileOperator } from "./get-az-mobile-operator";
+export { formatAzPhoneInternational } from "./format";
+export { maskAzPhone } from "./mask";
+export type { AzMobileOperator } from "./constants/operator.constants";
+export * from "./decorators";
+export * from "./phone.types";

package/dist/phone/index.js

@@ -14,11 +14,16 @@ 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.getAzMobileOperator = exports.normalizeAzPhone = exports.isValidAzPhone = void 0;
-var isValidAzPhone_1 = require("./isValidAzPhone");
-Object.defineProperty(exports, "isValidAzPhone", { enumerable: true, get: function () { return isValidAzPhone_1.isValidAzPhone; } });
-var normalizeAzPhone_1 = require("./normalizeAzPhone");
-Object.defineProperty(exports, "normalizeAzPhone", { enumerable: true, get: function () { return normalizeAzPhone_1.normalizeAzPhone; } });
-var getAzMobileOperator_1 = require("./getAzMobileOperator");
-Object.defineProperty(exports, "getAzMobileOperator", { enumerable: true, get: function () { return getAzMobileOperator_1.getAzMobileOperator; } });
+exports.maskAzPhone = exports.formatAzPhoneInternational = exports.getAzMobileOperator = exports.normalizeAzPhone = exports.isValidAzPhone = void 0;
+var is_valid_az_phone_1 = require("./is-valid-az-phone");
+Object.defineProperty(exports, "isValidAzPhone", { enumerable: true, get: function () { return is_valid_az_phone_1.isValidAzPhone; } });
+var normalize_az_phone_1 = require("./normalize-az-phone");
+Object.defineProperty(exports, "normalizeAzPhone", { enumerable: true, get: function () { return normalize_az_phone_1.normalizeAzPhone; } });
+var get_az_mobile_operator_1 = require("./get-az-mobile-operator");
+Object.defineProperty(exports, "getAzMobileOperator", { enumerable: true, get: function () { return get_az_mobile_operator_1.getAzMobileOperator; } });
+var format_1 = require("./format");
+Object.defineProperty(exports, "formatAzPhoneInternational", { enumerable: true, get: function () { return format_1.formatAzPhoneInternational; } });
+var mask_1 = require("./mask");
+Object.defineProperty(exports, "maskAzPhone", { enumerable: true, get: function () { return mask_1.maskAzPhone; } });
 __exportStar(require("./decorators"), exports);
+__exportStar(require("./phone.types"), exports);

package/dist/phone/{isValidAzPhone.js → is-valid-az-phone.js}

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isValidAzPhone = isValidAzPhone;
-const operators_1 = require("./operators");
-const constants_1 = require("./constants");
+const operator_constants_1 = require("./constants/operator.constants");
+const regex_constants_1 = require("./constants/regex.constants");
 function isValidAzPhone(phone) {
     if (!phone)
         return false;
     // Remove spaces, dashes, parentheses
-    const cleaned = phone.replace(constants_1.NUMBER_CLEANING_REX, "");
+    const cleaned = phone.replace(regex_constants_1.NUMBER_CLEANING_REX, "");
     let localNumber;
     if (cleaned.startsWith("+994")) {
         localNumber = cleaned.slice(4);
@@ -18,17 +18,17 @@ function isValidAzPhone(phone) {
     else if (cleaned.startsWith("0")) {
         localNumber = cleaned.slice(1);
     }
-    else if (cleaned.slice(0, 2) in operators_1.OPERATOR_PREFIX_MAP) {
+    else if (cleaned.slice(0, 2) in operator_constants_1.OPERATOR_PREFIX_MAP) {
         localNumber = cleaned;
     }
     else {
         return false;
     }
     // Must be exactly 9 digits after prefix removal
-    if (!constants_1.NUMBER_LENGTH_REX.test(localNumber)) {
+    if (!regex_constants_1.NUMBER_LENGTH_REX.test(localNumber)) {
         return false;
     }
     const operatorPrefix = localNumber.slice(0, 2);
-    return operatorPrefix in operators_1.OPERATOR_PREFIX_MAP;
+    return operatorPrefix in operator_constants_1.OPERATOR_PREFIX_MAP;
 }
 exports.default = isValidAzPhone;

package/dist/phone/mask.d.ts

@@ -0,0 +1,8 @@
+import { MaskAzPhoneOptions } from "./phone.types";
+/**
+ * @example +994501234567 → +994 50 *** ** 67
+ */
+export declare function maskAzPhone(phone: string, options?: MaskAzPhoneOptions): {
+    value: string;
+    isMasked: boolean;
+};

package/dist/phone/mask.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.maskAzPhone = maskAzPhone;
+const operator_constants_1 = require("./constants/operator.constants");
+const normalize_az_phone_1 = require("./normalize-az-phone");
+/**
+ * @example +994501234567 → +994 50 *** ** 67
+ */
+function maskAzPhone(phone, options = {}) {
+    const normalized = (0, normalize_az_phone_1.normalizeAzPhone)(phone);
+    if (!normalized)
+        return { value: phone, isMasked: false };
+    const match = normalized.match(/^0(\d{2})(\d{7})$/);
+    if (!match)
+        return { value: phone, isMasked: false };
+    const visibleEnd = Math.min(Math.max(options.visibleEnd ?? 2, 2), 5);
+    const [, operator, rest] = match;
+    const maskedLength = rest.length - visibleEnd;
+    const masked = maskedLength > 0 ? "*".repeat(maskedLength) : "";
+    const visible = rest.slice(-visibleEnd);
+    const value = `${operator_constants_1.AZ_PHONE_PREFIX}(${operator})${masked}${visible}`;
+    return { value, isMasked: true };
+}

package/dist/phone/{normalizeAzPhone.js → normalize-az-phone.js}

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.normalizeAzPhone = normalizeAzPhone;
-const isValidAzPhone_1 = require("./isValidAzPhone");
-const constants_1 = require("./constants");
+const is_valid_az_phone_1 = require("./is-valid-az-phone");
+const regex_constants_1 = require("./constants/regex.constants");
 function normalizeAzPhone(phone) {
-    if (!(0, isValidAzPhone_1.isValidAzPhone)(phone)) {
+    if (!(0, is_valid_az_phone_1.isValidAzPhone)(phone)) {
         return null;
     }
-    const cleaned = phone.replace(constants_1.NUMBER_CLEANING_REX, "");
+    const cleaned = phone.replace(regex_constants_1.NUMBER_CLEANING_REX, "");
     let localNumber;
     if (cleaned.startsWith("+994")) {
         localNumber = cleaned.slice(4);

package/dist/phone/phone.types.d.ts

@@ -0,0 +1,7 @@
+export interface MaskAzPhoneOptions {
+    /**
+     * Visible digits at the end (2–5)
+     * @default 2
+     */
+    visibleEnd?: number;
+}

package/dist/phone/phone.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

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

package/dist/phone/constants.d.ts

@@ -1,2 +0,0 @@
-export declare const NUMBER_LENGTH_REX: RegExp;
-export declare const NUMBER_CLEANING_REX: RegExp;

package/dist/phone/constants.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NUMBER_CLEANING_REX = exports.NUMBER_LENGTH_REX = void 0;
-exports.NUMBER_LENGTH_REX = /^\d{9}$/;
-exports.NUMBER_CLEANING_REX = /[\s\-()]/g;

package/dist/phone/getAzMobileOperator.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAzMobileOperator = getAzMobileOperator;
-const operators_1 = require("./operators");
-const normalizeAzPhone_1 = require("./normalizeAzPhone");
-function getAzMobileOperator(phone) {
-    const normalized = (0, normalizeAzPhone_1.normalizeAzPhone)(phone);
-    if (!normalized) {
-        return "Unknown";
-    }
-    const prefix = normalized.slice(1, 3);
-    return operators_1.OPERATOR_PREFIX_MAP[prefix] ?? "Unknown";
-}