@diia-inhouse/utils 4.13.0 → 5.3.0

package/dist/types/applicationUtils.d.ts

@@ -19,7 +19,20 @@ export declare class ApplicationUtils {
     static lowerFirstLetter(str: string): string;
     static mapCyrillic(value: string): string;
     static mapLatin(value: string): string;
+    /**
+     * Validates the Ukrainian IBAN number by format and checksum.
+     */
     static isIbanNumberValid(iban: string): boolean;
+    /**
+     * Extracts the bank code (МФО) from Ukrainian IBAN (4-10 digits). Does not validate the IBAN.
+     *
+     * @link https://en.wikipedia.org/wiki/International_Bank_Account_Number#IBAN_formats_by_country
+     * @example
+     * ```typescript
+     * const bankCode = extractBankCodeFromIban('UA833052991234567890123456789') // '305299'
+     * ```
+     */
+    static extractBankCodeFromIban(iban: string): string;
     static getStreetName(street: string, streetType: string): string;
     static toHashedFilesWithSignatures(hashedFiles: HashedFile[], signedItems: SignedItem[]): [HashedFileWithSignature[], string[]];
     static handleError<T = never>(err: unknown, cb: (err: ApiError) => T): T;
@@ -30,13 +43,19 @@ export declare class ApplicationUtils {
      * Get age from birth date. Powered by {@link https://moment.github.io/luxon/#/ luxon}
      *
      * @param birthDay Input birth date.
-     * @param format `birthDay` format (https://moment.github.io/luxon/#/formatting?id=table-of-tokens). Default - 'dd.MM.yyyy'
-     * @param unitOfTime Unit of time to return. Default - 'years'
+     * @param params Additional parameters. Default: `{ format: 'dd.MM.yyyy', unitOfTime: 'years' }`
+     * @param params.format Input date format (https://moment.github.io/luxon/#/formatting?id=table-of-tokens). Default - 'dd.MM.yyyy'
+     * @param params.unitOfTime Unit of time to get the difference in. Default - 'years'
+     * @param params.relativeTo Date to compare the input date to. Default - current date
      *
      * @returns Age in years if other `unitOfTime` is not specified
      * @throws If input date is invalid
      */
-    static getAge(birthDay: string, format?: string, unitOfTime?: ToRelativeUnit): number;
+    static getAge(birthDay: string, params?: {
+        format?: string;
+        unitOfTime?: ToRelativeUnit;
+        relativeTo?: string;
+    }): number;
     static getFullName(lastName: string, firstName: string, middleName?: string, separator?: string): string;
     static getShortName(lastName: string, firstName: string, middleName?: string): string;
     static getUserFullName(user: UserTokenData): string;
@@ -110,6 +129,84 @@ export declare class ApplicationUtils {
      * getPluralForm(0, 'яблуко', 'яблука', 'яблук'); // 'яблук' (uses 'many' as default fallback)
      */
     static pluralizeString(value: number, one: string, few: string, many: string, other?: string, locale?: string): string;
+    /**
+     * Returns the name of a service from a package.json in the current working directory (process.cwd()) converted to PascalCase.
+     * If the name is scoped, it will be returned without the scope.
+     * If the name is not found, an empty string is returned. Also, all whitespace characters are removed.
+     *
+     * @returns The name of the service in PascalCase.
+     *
+     * @example
+     * getServiceName() // 'my-service' -> 'MyService'
+     * getServiceName() // '@scope/my-service' -> 'MyService'
+     */
+    static getServiceName(): string;
+    /**
+     * Returns the version of a service from a package.json in the current working directory (process.cwd()).
+     * If the version is not found, an empty string is returned.
+     *
+     * @returns The version of the service.
+     *
+     * @example
+     * getServiceVersion() // '1.143.0-rc.2'
+     */
+    static getServiceVersion(): string;
+    /**
+     * Format string according to mask pattern
+     *
+     * Basic Examples:
+     * '12345' with '##-###'    -> '12-345'
+     * 'AB345' with '##-###'    -> 'AB-345'
+     * '123456' with '##.####'  -> '12.3456'
+     * '12345' with '### ##'    -> '123 45'
+     * 'ABCDEF' with '##-##-##' -> 'AB-CD-EF'
+     */
+    static formatMask(rawData: string, mask: string): string;
+    /**
+     * Memoize a function.
+     * The function is memoized by the arguments (`JSON.stringify(args)`) and the result is cached for the specified time to live in milliseconds.
+     * If the function is called with the same arguments again, the cached result is returned.
+     * If the function is called with the same arguments again after the time to live has expired, the function is called again and the result is cached again.
+     *
+     * @param fn - The function to memoize.
+     * @param ttl - The time to live for the cached value in milliseconds.
+     * @returns The memoized function.
+     */
+    static memoize<T extends (...args: Parameters<T>) => ReturnType<T>>(fn: T, ttl?: number): T;
+    /**
+     * Recursively encodes all string values in an object or string using encodeURIComponent.
+     * For objects, it creates a deep clone and processes all string values.
+     * For strings, it directly applies the encoding.
+     *
+     * @param data Input data to encode - can be an object or string
+     * @returns Deep cloned object with encoded string values, or encoded string if input was string
+     * @example
+     * ```typescript
+     * const data = { name: 'John Doe', email: 'john@example.com' }
+     * const encoded = ApplicationUtils.encodeValuesWithIterator(data)
+     * // Result: { name: 'John%20Doe', email: 'john%40example.com' }
+     * ```
+     */
+    static encodeValuesWithIterator(data: object | string): object | string;
+    /**
+     * Recursively decodes all string values in an object or string using decodeURIComponent.
+     * For objects, it creates a deep clone and processes all string values.
+     * For strings, it directly applies the decoding.
+     *
+     * @param data Input data to decode - can be an object or string
+     * @returns Deep cloned object with decoded string values, or decoded string if input was string
+     * @example
+     * ```typescript
+     * const data = { name: 'John%20Doe', email: 'john%40example.com' }
+     * const decoded = ApplicationUtils.decodeValuesWithIterator(data)
+     * // Result: { name: 'John Doe', email: 'john@example.com' }
+     * ```
+     */
+    static decodeValuesWithIterator(data: object | string): object | string;
+    static removeUnderscoreFields<T>(value: T): T;
     private static mod97;
     private static toApiError;
+    private static getPackageJson;
+    private static processObject;
+    private static processValues;
 }

package/dist/types/dictionaries/phoneCodes.d.ts

@@ -1,2 +1,2 @@
-import { InputPhoneCodeItem } from '@diia-inhouse/types';
+import { InputPhoneCodeItem } from '@diia-inhouse/design-system';
 export declare const phoneCodes: InputPhoneCodeItem[];

package/dist/types/guards.d.ts

@@ -1,9 +1,12 @@
 import { ApiError } from '@diia-inhouse/errors';
-import { AcquirerSession, ActionSession, OnBeforeApplicationShutdown, OnDestroy, OnHealthCheck, OnInit, OnRegistrationsFinished, ServiceEntranceSession, UserSession } from '@diia-inhouse/types';
+import { AcquirerSession, ActionSession, AppUser, EResidentSession, EResidentTokenData, OnBeforeApplicationShutdown, OnDestroy, OnHealthCheck, OnInit, OnRegistrationsFinished, ServiceEntranceSession, UserSession, UserTokenData } from '@diia-inhouse/types';
 export declare const Guards: {
     isError(value: unknown): value is Error;
     apiError(err: Error): err is ApiError;
     isUserSession(session: ActionSession | undefined): session is UserSession;
+    isUser(user: AppUser | undefined): user is UserTokenData;
+    isEResidentSession(session: ActionSession | undefined): session is EResidentSession;
+    isEResident(user: AppUser | undefined): user is EResidentTokenData;
     isAcquirerSession(session: ActionSession | undefined): session is AcquirerSession;
     isServiceEntranceSession(session: ActionSession | undefined): session is ServiceEntranceSession;
     hasOnInitHook(instance: unknown): instance is OnInit;

package/dist/types/index.d.ts

@@ -1,9 +1,16 @@
+import { AddressUtils } from './address';
 import { ApplicationUtils } from './applicationUtils';
+import { NetworkUtils } from './network';
+import { PaymentUtils } from './payment';
+import { SlackFormattingUtils } from './slackFormatting';
 declare const asserts: import("./interfaces/asserts").AssertsContainer;
 declare const guards: {
     isError(value: unknown): value is Error;
     apiError(err: Error): err is import("@diia-inhouse/errors").ApiError;
     isUserSession(session: import("@diia-inhouse/types").ActionSession | undefined): session is import("@diia-inhouse/types").UserSession;
+    isUser(user: import("@diia-inhouse/types").AppUser | undefined): user is import("@diia-inhouse/types").UserTokenData;
+    isEResidentSession(session: import("@diia-inhouse/types").ActionSession | undefined): session is import("@diia-inhouse/types").EResidentSession;
+    isEResident(user: import("@diia-inhouse/types").AppUser | undefined): user is import("@diia-inhouse/types").EResidentTokenData;
     isAcquirerSession(session: import("@diia-inhouse/types").ActionSession | undefined): session is import("@diia-inhouse/types").AcquirerSession;
     isServiceEntranceSession(session: import("@diia-inhouse/types").ActionSession | undefined): session is import("@diia-inhouse/types").ServiceEntranceSession;
     hasOnInitHook(instance: unknown): instance is import("@diia-inhouse/types").OnInit;
@@ -21,8 +28,59 @@ export { asserts, guards, utils, pdfUtils };
 export { TypeUtils } from './typeUtils';
 export { PaymentUtils } from './payment';
 export { PublicServiceUtils } from './publicService';
-export { phoneticChecker } from './phoneticChecker/index';
+export { phoneticChecker } from './phoneticChecker';
 export { NetworkUtils } from './network';
 export { IntegrationUtils } from './integration';
 export { RandomUtils } from './random';
+export { AddressUtils } from './address';
 export * from './session';
+export * from './slackFormatting';
+export declare class Utils {
+    address: typeof AddressUtils;
+    application: typeof ApplicationUtils;
+    network: typeof NetworkUtils;
+    payment: typeof PaymentUtils;
+    slackFormatting: typeof SlackFormattingUtils;
+    asserts: import("./interfaces/asserts").AssertsContainer;
+    guards: {
+        isError(value: unknown): value is Error;
+        apiError(err: Error): err is import("@diia-inhouse/errors").ApiError;
+        isUserSession(session: import("@diia-inhouse/types").ActionSession | undefined): session is import("@diia-inhouse/types").UserSession;
+        isUser(user: import("@diia-inhouse/types").AppUser | undefined): user is import("@diia-inhouse/types").UserTokenData;
+        isEResidentSession(session: import("@diia-inhouse/types").ActionSession | undefined): session is import("@diia-inhouse/types").EResidentSession;
+        isEResident(user: import("@diia-inhouse/types").AppUser | undefined): user is import("@diia-inhouse/types").EResidentTokenData;
+        isAcquirerSession(session: import("@diia-inhouse/types").ActionSession | undefined): session is import("@diia-inhouse/types").AcquirerSession;
+        isServiceEntranceSession(session: import("@diia-inhouse/types").ActionSession | undefined): session is import("@diia-inhouse/types").ServiceEntranceSession;
+        hasOnInitHook(instance: unknown): instance is import("@diia-inhouse/types").OnInit;
+        hasOnHealthCheckHook(instance: unknown): instance is import("@diia-inhouse/types").OnHealthCheck;
+        hasOnDestroyHook(instance: unknown): instance is import("@diia-inhouse/types").OnDestroy;
+        hasOnRegistrationsFinishedHook(instance: unknown): instance is import("@diia-inhouse/types").OnRegistrationsFinished;
+        hasOnBeforeApplicationShutdownHook(instance: unknown): instance is import("@diia-inhouse/types").OnBeforeApplicationShutdown;
+        isSettledError(value: PromiseSettledResult<unknown>): value is PromiseRejectedResult;
+    };
+    integration: {
+        getRetryDelay(retry: number, timeLeft: number, initDelay: number, maxDelay: number, multiplier: number): number;
+    };
+    pdf: {
+        getPdfFileName(name: string, id: string, requestDateTime?: string): string;
+    };
+    publicService: {
+        getContacts(user: import("@diia-inhouse/types").UserTokenData): import("@diia-inhouse/design-system").ContactsResponse;
+        getContactsText(user: import("@diia-inhouse/types").UserTokenData): string;
+        getContactsComponent(user: import("@diia-inhouse/types").UserTokenData, inputCode?: string): import("@diia-inhouse/design-system").DSBodyItem;
+        getInputPhoneCodeOrg(params: import("./interfaces/publicService").InputPhoneCodeOrgParams): import("@diia-inhouse/design-system").InputPhoneCodeOrg;
+        getInputPhoneCodeItems(filter?: string[]): import("@diia-inhouse/design-system").InputPhoneCodeItem[];
+        getEmailInputTextMlc(emailValue: string, inputCode?: string): import("@diia-inhouse/design-system").InputTextMlc;
+        getContactsComponentTextLabel(user: import("@diia-inhouse/types").UserTokenData, phoneNumber: string): import("@diia-inhouse/design-system").TextLabelMlc | undefined;
+        extractPhoneNumber(phoneNumber: string, phoneCodeValue: string): string | never;
+    };
+    random: {
+        generateUUID: typeof import("node:crypto").randomUUID;
+        getRandomIntsString(length?: number): string;
+    };
+    type: {
+        isObject(value: any): boolean;
+        isArray(value: any): boolean;
+        isBuffer(value: any): boolean;
+    };
+}

package/dist/types/interfaces/applicationUtils.d.ts

@@ -0,0 +1 @@
+export type ProcessObjectCallback = (value: string) => string;

package/dist/types/interfaces/error.d.ts

@@ -0,0 +1,7 @@
+import { ErrorData, ErrorType } from '@diia-inhouse/errors';
+export type OriginError = Error & {
+    code?: number;
+    data?: ErrorData;
+    type?: ErrorType;
+    keyValue?: unknown;
+};

package/dist/types/interfaces/publicService.d.ts

@@ -11,4 +11,5 @@ export interface InputPhoneCodeOrgParams {
     codeValueId?: string;
     codeIds?: string[];
     hint?: string;
+    codeValueIsEditable?: boolean;
 }

package/dist/types/interfaces/slack.d.ts

@@ -0,0 +1,3 @@
+export interface GetListValueOptions {
+    isError?: boolean;
+}

package/dist/types/phoneticChecker/index.d.ts

@@ -1,6 +1,7 @@
 declare class PhoneticChecker {
-    getEqualityCoefficient(etalonValue: string, slaveValue: string): number;
-    private getLevenshteinDistance;
+    private equalityCoefficientThreshold;
+    arePhoneticallySimilar(etalonValue: string, slaveValue: string, threshold?: number): boolean;
+    private getEqualityCoefficient;
 }
 export declare const phoneticChecker: PhoneticChecker;
 export {};

package/dist/types/publicService.d.ts

@@ -1,12 +1,55 @@
-import { ContactsResponse, DSBodyItem, InputPhoneCodeOrg, InputTextMlc, NavigationPanel, PlatformAppVersion, PublicServiceContextMenu, PublicServiceSettings, TextLabelMlc, UserTokenData } from '@diia-inhouse/types';
+import { ContactsResponse, DSBodyItem, InputPhoneCodeItem, InputPhoneCodeOrg, InputTextMlc, TextLabelMlc } from '@diia-inhouse/design-system';
+import { UserTokenData } from '@diia-inhouse/types';
 import { InputPhoneCodeOrgParams } from './interfaces/publicService';
 export declare const PublicServiceUtils: {
     getContacts(user: UserTokenData): ContactsResponse;
     getContactsText(user: UserTokenData): string;
     getContactsComponent(user: UserTokenData, inputCode?: string): DSBodyItem;
+    /**
+     * Creates an InputPhoneCodeOrg with specified parameters
+     * @param params.codeIds - Optional array of allowed country code IDs
+     * @returns InputPhoneCodeOrg
+     * @example
+     * // Create a phone input with Ukrainian code
+     * const phoneInput = getInputPhoneCodeOrg({
+     *   inputCode: 'phone',
+     *   phoneValue: '501234567',
+     *   codeValueId: 'ua',
+     *   codeIds: ['ua', 'pl'],
+     *   hint: 'Enter your phone number'
+     * });
+     */
     getInputPhoneCodeOrg(params: InputPhoneCodeOrgParams): InputPhoneCodeOrg;
+    /**
+     * Returns an array of phone code items, optionally filtered by provided code IDs
+     * @param filter - Optional array of phone code IDs to filter by
+     * @returns Array of phone code items matching the filter criteria, or all phone codes if no filter is provided
+     * @example
+     * // Get all phone codes
+     * const allCodes = getInputPhoneCodeItems();
+     *
+     * @example
+     * // Get only Ukrainian and Polish phone codes
+     * const filteredCodes = getInputPhoneCodeItems(['ua', 'pl']);
+     */
+    getInputPhoneCodeItems(filter?: string[]): InputPhoneCodeItem[];
     getEmailInputTextMlc(emailValue: string, inputCode?: string): InputTextMlc;
     getContactsComponentTextLabel(user: UserTokenData, phoneNumber: string): TextLabelMlc | undefined;
-    extractContextMenu(settings: PublicServiceSettings, appVersion: PlatformAppVersion | undefined): PublicServiceContextMenu[] | undefined;
-    extractNavigationPanel(settings: PublicServiceSettings, appVersion: PlatformAppVersion | undefined, header?: string): NavigationPanel | undefined;
+    /**
+     * Extracts the phone number from the phone number string
+     *
+     * @param phoneNumber - Phone number to extract the number from
+     * @param phoneCodeValue - Phone country code in ISO 3166-1 alpha-2 format
+     * @returns Extracted phone number (without country code)
+     *
+     * @example
+     * extractPhoneNumber('+380123456789', 'ua') // 123456789
+     *
+     * @example
+     * extractPhoneNumber('123456789', 'ua') // throws Error(`Phone number must start with country code 380`)
+     *
+     * @example
+     * extractPhoneNumber('380123456789', 'invalid') // throws Error(`Invalid country code`)
+     */
+    extractPhoneNumber(phoneNumber: string, phoneCodeValue: string): string | never;
 };

package/dist/types/slackFormatting.d.ts

@@ -0,0 +1,7 @@
+import type { RichTextElement, RichTextEmoji } from '@slack/types';
+import { GetListValueOptions } from './interfaces/slack';
+export declare class SlackFormattingUtils {
+    readonly greenCircleEmoji: RichTextEmoji;
+    readonly redCircleEmoji: RichTextEmoji;
+    getValue(name: string, value: string | number | undefined, { isError }?: GetListValueOptions): RichTextElement[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@diia-inhouse/utils",
-    "version": "4.13.0",
+    "version": "5.3.0",
     "description": "Generic utils",
     "main": "dist/index.js",
     "types": "dist/types/index.d.ts",
@@ -11,28 +11,32 @@
         "dist"
     ],
     "engines": {
-        "node": ">=20"
+        "node": ">=22"
     },
     "scripts": {
         "prebuild": "rimraf dist",
         "build": "tsc",
         "semantic-release": "semantic-release",
-        "lint": "eslint --ext .ts . && prettier --check .",
-        "lint-fix": "eslint '*/**/*.{js,ts}' --fix && prettier --write .",
+        "lint": "eslint . && prettier --check .",
+        "lint-fix": "eslint --fix . && prettier --write .",
         "lint:lockfile": "lockfile-lint --path package-lock.json --allowed-hosts registry.npmjs.org --validate-https",
         "prepare": "npm run build",
-        "test": "vitest run",
+        "test": "tsc --project tests/tsconfig.json --noEmit && vitest run",
         "test:watch": "vitest watch",
         "find-circulars": "madge --circular --extensions ts ./"
     },
     "dependencies": {
-        "@types/luxon": "3.4.2",
-        "bson": "6.9.0",
+        "@diia-inhouse/design-system": "3.0.2",
+        "@types/luxon": "3.7.1",
+        "bson": "7.2.0",
         "compare-versions": "6.1.1",
+        "design-system": "2.5.0",
         "fast-levenshtein": "3.0.0",
-        "lodash": "4.17.21",
-        "luxon": "3.5.0",
-        "moment": "2.30.1"
+        "lodash": "4.17.23",
+        "luxon": "3.7.2",
+        "map-age-cleaner": "0.2.0",
+        "moment": "2.30.1",
+        "type-fest": "4.41.0"
     },
     "peerDependencies": {
         "@diia-inhouse/errors": ">=1.4.1",
@@ -40,53 +44,33 @@
         "@diia-inhouse/validators": ">=1.5.0"
     },
     "devDependencies": {
-        "@diia-inhouse/configs": "4.0.0",
-        "@diia-inhouse/errors": "1.10.0",
-        "@diia-inhouse/eslint-config": "5.6.5",
-        "@diia-inhouse/test": "6.6.4",
-        "@diia-inhouse/types": "6.92.0",
-        "@diia-inhouse/validators": "1.17.0",
+        "@diia-inhouse/configs": "6.1.1",
+        "@diia-inhouse/errors": "1.17.0",
+        "@diia-inhouse/eslint-config": "8.2.4",
+        "@diia-inhouse/test": "7.2.0",
+        "@diia-inhouse/types": "11.3.0",
+        "@diia-inhouse/validators": "1.28.0",
+        "@slack/types": "2.20.0",
         "@types/fast-levenshtein": "0.0.4",
-        "@types/lodash": "4.17.13",
-        "@types/node": "22.9.0",
-        "@typescript-eslint/typescript-estree": "8.14.0",
-        "@vitest/coverage-v8": "2.1.5",
-        "@vitest/ui": "2.1.5",
-        "lockfile-lint": "4.14.0",
+        "@types/lodash": "4.17.24",
+        "@types/node": "25.3.3",
+        "@vitest/coverage-v8": "4.0.18",
+        "@vitest/ui": "4.0.18",
+        "eslint": "9.39.3",
+        "lockfile-lint": "4.14.1",
         "madge": "8.0.0",
-        "protobufjs": "7.4.0",
-        "rimraf": "6.0.1",
-        "vite-tsconfig-paths": "5.1.2",
-        "vitest": "2.1.5"
+        "protobufjs": "7.5.4",
+        "rimraf": "6.1.3",
+        "typescript": "5.9.3",
+        "vite-tsconfig-paths": "6.1.1",
+        "vitest": "4.0.18"
     },
     "release": {
-        "extends": "@diia-inhouse/configs/dist/semantic-release/package",
-        "branches": [
-            "main"
-        ]
+        "extends": "@diia-inhouse/configs/dist/semantic-release/package"
     },
     "commitlint": {
         "extends": "@diia-inhouse/configs/dist/commitlint"
     },
-    "eslintConfig": {
-        "extends": "@diia-inhouse/eslint-config",
-        "rules": {
-            "@typescript-eslint/no-explicit-any": "warn"
-        },
-        "overrides": [
-            {
-                "files": [
-                    "*.ts"
-                ],
-                "parserOptions": {
-                    "project": [
-                        "./tsconfig.json",
-                        "./tests/tsconfig.json"
-                    ]
-                }
-            }
-        ]
-    },
     "prettier": "@diia-inhouse/eslint-config/prettier",
     "madge": {
         "tsConfig": "./tsconfig.json"