@temboplus/frontend-core 0.2.22 → 0.3.0-beta.1

package/dist/models/amount/index.d.ts

@@ -0,0 +1 @@
+export * from "./amount.js";

package/dist/models/bank/bank.d.ts

@@ -0,0 +1,193 @@
+import { ISO2CountryCode } from "../country/country.types.js";
+import type { BankSwiftCode, KEBankSwiftCode, TZBankSwiftCode } from "./bank.types.js";
+import { z } from "zod";
+import { BankJSONSchema } from "./bank.schema.js";
+/**
+ * Infer the BankJSON type from the schema
+ */
+export type BankJSON = z.infer<typeof BankJSONSchema>;
+export declare class Bank {
+    /**
+     * The full registered name of the bank.
+     */
+    readonly fullName: string;
+    /**
+     * The commonly used short name or abbreviation for the bank.
+     */
+    readonly shortName: string;
+    /**
+     * The SWIFT/BIC code for the bank's head office.
+     */
+    readonly swiftCode: TZBankSwiftCode | KEBankSwiftCode;
+    /**
+     * The ISO 3166-1 alpha-2 country code (e.g., 'TZ', 'KE').
+     */
+    readonly countryCode: ISO2CountryCode;
+    /**
+     * Optional list of former names the bank was known by.
+     * Useful for historical reference and search functionality.
+     */
+    readonly formerNames?: string[];
+    /**
+     * Creates a new Bank instance.
+     *
+     * @param fullName The full registered name of the bank
+     * @param shortName The commonly used short name or abbreviation for the bank
+     * @param swiftCode The SWIFT/BIC code for the bank's head office
+     * @param countryCode The ISO 3166-1 alpha-2 country code
+     * @param formerNames Optional list of former names the bank was known by
+     */
+    constructor(fullName: string, shortName: string, swiftCode: TZBankSwiftCode | KEBankSwiftCode, countryCode: ISO2CountryCode, formerNames?: string[]);
+    /**
+     * Checks if this bank has any former names recorded.
+     * @returns True if the bank has at least one former name, false otherwise.
+     */
+    hasFormerNames(): boolean;
+    /**
+     * Gets a display string showing the current name with former names in parentheses.
+     * @returns A formatted string, e.g., "Access Bank Tanzania Limited (formerly BancABC)"
+     */
+    getDisplayNameWithHistory(): string;
+    /**
+     * Returns a string representation of the bank.
+     * @returns A formatted string, e.g., "CRDB BANK PLC (CRDB) - SWIFT: CORUTZTZ [TZ]"
+     */
+    toString(): string;
+    static from(swiftCode: BankSwiftCode, countryCode: ISO2CountryCode): Bank;
+    /**
+     * Converts the Bank instance to a plain JavaScript object.
+     * Suitable for serialization or data transfer.
+     *
+     * @returns {Object} Plain object representation of the bank
+     * @returns {string} returns.fullName - The full registered name of the bank
+     * @returns {string} returns.shortName - The commonly used short name
+     * @returns {string} returns.swiftCode - The SWIFT/BIC code
+     * @returns {ISO2CountryCode} returns.countryCode - The ISO 3166-1 alpha-2 country code
+     * @returns {string[] | undefined} returns.formerNames - Optional list of former names
+     *
+     * @example
+     * ```typescript
+     * const bank = Bank.from("FMBZTZTX", "TZ");
+     * const obj = bank.toObject();
+     * console.log(obj);
+     * // {
+     * //   fullName: "Access Bank Tanzania Limited",
+     * //   shortName: "ABT",
+     * //   swiftCode: "FMBZTZTX",
+     * //   countryCode: "TZ",
+     * //   formerNames: ["BancABC"]
+     * // }
+     * ```
+     */
+    toObject(): {
+        fullName: string;
+        shortName: string;
+        swiftCode: TZBankSwiftCode | KEBankSwiftCode;
+        countryCode: ISO2CountryCode;
+        formerNames?: string[];
+    };
+    /**
+     * Static method to determine if an unknown object is a valid Bank object.
+     *
+     * This method performs a series of checks to validate if the provided object conforms
+     * to the Bank interface and contains valid data.
+     *
+     * @param {unknown} obj - The object to validate.
+     * @returns {obj is Bank} - Returns true if the object is a valid Bank, false otherwise.
+     */
+    static is(obj: unknown): obj is Bank;
+    /**
+     * Serializes the Bank instance to a JSON-compatible object
+     */
+    toJSON(): BankJSON;
+    /**
+     * Serializes the Bank instance to a JSON string
+     */
+    toJSONString(): string;
+    /**
+     * Creates a Bank instance from a JSON-compatible object or string
+     */
+    static fromJSON(json: BankJSON | string): Bank | undefined;
+    /**
+     * Creates a Bank instance from a JSON string
+     */
+    static fromJSONString(jsonString: string): Bank | undefined;
+    /**
+     * Type guard to check if an object is a valid BankJSON using Zod validation
+     */
+    static isBankJSON(obj: unknown): obj is BankJSON;
+}
+/**
+ * Service for managing bank data, validation, and instance creation
+ * across multiple countries. Acts as the central Facade and Factory.
+ * @class BankService
+ */
+export declare class BankService {
+    private static instance;
+    private loadedData;
+    private constructor();
+    /**
+     * Gets the singleton instance of BankService.
+     * Initializes known countries synchronously on first call.
+     * Consider async initialization if data loading becomes async.
+     */
+    static getInstance(): BankService;
+    /**
+     * Initializes bank data for a specific country synchronously.
+     * @param countryCode The ISO country code (e.g., 'TZ', 'KE').
+     * @returns True if successful or already loaded, false on failure.
+     */
+    initializeCountry(countryCode: ISO2CountryCode): boolean;
+    /**
+     * Retrieves the loaded data structure for a given country.
+     * Ensures country is initialized.
+     * @param countryCode The ISO country code.
+     * @returns The CountryBankData structure or undefined.
+     */
+    private getCountryData;
+    /**
+     * Retrieves a Bank instance by its SWIFT code for a specific country.
+     * Performs validation before returning.
+     * @param countryCode The ISO country code.
+     * @param swiftCode The SWIFT code.
+     * @returns The Bank instance or undefined if SWIFT is invalid or not found.
+     */
+    getBankBySwiftCode(countryCode: ISO2CountryCode, swiftCode: BankSwiftCode): Bank | undefined;
+    /**
+     * Retrieves all banks for a specific country.
+     * @param countryCode The ISO country code.
+     * @returns An array of Bank instances, or empty array.
+     */
+    getAllBanks(countryCode: ISO2CountryCode): Bank[];
+    /**
+     * Retrieves all banks for all supported countries.
+     * @returns An array of Bank instances, or empty array.
+     */
+    getAllSupportedBanks(): Bank[];
+    /**
+     * Searches all supported banks for a bank with the provided swift code
+     */
+    detectBank(swiftCode: string): Bank | undefined;
+    /**
+     * Searches for banks within a specific country by name, SWIFT code, or former names.
+     * @param countryCode The ISO country code.
+     * @param searchTerm The term to search for (case-insensitive).
+     * @param limit Max number of results.
+     * @returns An array of matching Bank instances.
+     */
+    searchBanks(countryCode: ISO2CountryCode, searchTerm: string, limit?: number): Bank[];
+    /**
+     * Searches for banks across all supported countries by name, SWIFT code, or former names.
+     * @param searchTerm The term to search for (case-insensitive).
+     * @param limit Max number of results.
+     * @returns An array of matching Bank instances from all supported countries.
+     */
+    searchAllBanks(searchTerm: string, limit?: number): Bank[];
+    /**
+     * Finds banks that were formerly known by a specific name.
+     * @param formerName The former name to search for (case-insensitive).
+     * @param countryCode Optional country code to limit the search.
+     * @returns An array of Bank instances that match the former name.
+     */
+    findByFormerName(formerName: string, countryCode?: ISO2CountryCode): Bank[];
+}

package/dist/models/bank/bank.schema.d.ts

@@ -0,0 +1,23 @@
+import { z } from "zod";
+export declare const TZBankSWIFTCodeSchema: z.ZodEffects<z.ZodString, string, string>;
+export declare const KEBankSWIFTCodeSchema: z.ZodEffects<z.ZodString, string, string>;
+/**
+* Zod schema for Bank JSON serialization
+* This schema validates the JSON representation of a Bank instance
+*/
+export declare const BankJSONSchema: z.ZodObject<{
+    /** The SWIFT/BIC code for the bank's head office */
+    swiftCode: z.ZodString;
+    /** The ISO 3166-1 alpha-2 country code */
+    countryCode: z.ZodString;
+    /** Version for future compatibility */
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    version: string;
+    swiftCode: string;
+    countryCode: string;
+}, {
+    swiftCode: string;
+    countryCode: string;
+    version?: string | undefined;
+}>;

package/{esm/src/models/bank/types.d.ts → dist/models/bank/bank.types.d.ts}

@@ -1,7 +1,5 @@
+export declare const KEBankSwiftCodesSet: Set<string>;
+export declare const TZBankSwiftCodesSet: Set<string>;
+export type KEBankSwiftCode = "KCBLKENX" | "EQBLKENX" | "KCOOKENX" | "SCBLKENX" | "BARCKENX" | "CBAFKENX" | "DTKEKENX" | "FABLKENA" | "CITIKENA" | "HFCOKENX" | "SBICKENX" | "NBKEKENX" | "AFRIKENX" | "GTBOKENX" | "IMBLKENX" | "ECOCKENX" | "BARBKENX" | "BKIDKENX" | "UNAFKENX" | "SGKENX";
 export type TZBankSwiftCode = "CORUTZTZ" | "PBZATZTZ" | "SCBLTZTX" | "SBICTZTX" | "CITITZTZ" | "EUAFTZTZ" | "DTKETZTZ" | "AKCOTZTZ" | "EXTNTZTZ" | "KLMJTZTZ" | "NLCBTZTX" | "NMIBTZTZ" | "KCBLTZTZ" | "HABLTZTZ" | "BKMYTZTZ" | "BARCTZTZ" | "IMBLTZTZ" | "CBAFTZTZ" | "DASUTZTZ" | "BARBTZTZ" | "AZANTZTZ" | "UCCTTZTZ" | "FMBZTZTX" | "ACTZTZTZ" | "BKIDTZTZ" | "UNAFTZTZ" | "MKCBTZTZ" | "ECOCTZTZ" | "MWCBTZTZ" | "FIRNTZTX" | "AMNNTZTZ" | "EQBLTZTZ" | "TAPBTZTZ" | "MBTLTZTZ" | "CNRBTZTZ" | "MWCOTZTZ" | "GTBITZTZ" | "YETMTZTZ" | "CDSHTZTZ";
-/**
- * A Set containing all SWIFT codes from the provided list.
- * Useful for quick lookups (e.g., checking if a string is a valid SWIFT code from this list).
- */
-export declare const TZBankSwiftCodesSet: Set<TZBankSwiftCode>;
-//# sourceMappingURL=types.d.ts.map
+export type BankSwiftCode = KEBankSwiftCode | TZBankSwiftCode;

package/dist/models/bank/bank.validation.d.ts

@@ -0,0 +1,80 @@
+import { ISO2CountryCode } from "@models/country/country.types.js";
+import { BankSwiftCode } from "./bank.types.js";
+export declare const BankValidation: {
+    /**
+     * Validates a bank account number format for a specific country.
+     * @param accountNumber The account number string.
+     * @param countryCode The ISO2 country code.
+     * @returns True if the format is valid, false otherwise.
+     */
+    validateAccountNumber: (accountNumber: string, countryCode: ISO2CountryCode) => boolean;
+    /**
+     * Validates a bank account number format for any supported country.
+     * @param accountNumber The account number string.
+     * @returns True if the format is valid for any supported country, false otherwise.
+     */
+    validateAccountNumberForAnyCountry: (accountNumber: string) => boolean;
+    /**
+     * Validates a SWIFT/BIC code for a specific country.
+     * @param swiftCode The SWIFT code string.
+     * @param countryCode The ISO2 country code.
+     * @returns True if the format is valid, false otherwise.
+     */
+    validateSwiftCode: (swiftCode: string, countryCode: ISO2CountryCode) => swiftCode is BankSwiftCode;
+    /**
+     * Validates a SWIFT/BIC code for any supported country.
+     * @param swiftCode The SWIFT code string.
+     * @returns True if the SWIFT code is valid for any supported country, false otherwise.
+     */
+    validateSwiftCodeForAnyCountry: (swiftCode: string) => swiftCode is BankSwiftCode;
+    /**
+     * Validates an account name based on various criteria.
+     * This validation is country-agnostic as account name rules are generally similar.
+     *
+     * @param {string} accountName - The account name to validate
+     * @returns {boolean} True if the account name meets all validation criteria, false otherwise
+     *
+     * @example
+     * // Returns true
+     * validateAccountName("John Smith");
+     *
+     * @example
+     * // Returns false (too short)
+     * validateAccountName("Jo");
+     *
+     * @example
+     * // Returns false (invalid characters)
+     * validateAccountName("User123");
+     */
+    validateAccountName: (accountName: string) => boolean;
+    /**
+     * Validates an account name for any supported country.
+     * Since account name validation is generally country-agnostic, this is an alias to validateAccountName.
+     * @param accountName The account name to validate.
+     * @returns True if the account name is valid, false otherwise.
+     */
+    validateAccountNameForAnyCountry: (accountName: string) => boolean;
+    /**
+     * Validates all bank details (account number, SWIFT code, and account name) for a specific country.
+     * @param accountNumber The account number string.
+     * @param swiftCode The SWIFT code string.
+     * @param accountName The account name string.
+     * @param countryCode The ISO2 country code.
+     * @returns True if all details are valid for the specified country, false otherwise.
+     */
+    validateAllBankDetails: (accountNumber: string, swiftCode: string, accountName: string, countryCode: ISO2CountryCode) => boolean;
+    /**
+     * Validates all bank details (account number, SWIFT code, and account name) for any supported country.
+     * @param accountNumber The account number string.
+     * @param swiftCode The SWIFT code string.
+     * @param accountName The account name string.
+     * @returns True if all details are valid for any supported country, false otherwise.
+     */
+    validateAllBankDetailsForAnyCountry: (accountNumber: string, swiftCode: string, accountName: string) => boolean;
+    /**
+     * Determines which country a SWIFT code belongs to.
+     * @param swiftCode The SWIFT code string.
+     * @returns The ISO2 country code if found, undefined otherwise.
+     */
+    getCountryFromSwiftCode: (swiftCode: string) => ISO2CountryCode | undefined;
+};

package/dist/models/bank/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./bank.js";
+export * from "./bank.types.js";
+export * from "./bank.validation.js";
+export * from "./bank.schema.js";

package/{script/src → dist}/models/country/country.d.ts

@@ -24,9 +24,15 @@
  * The addition of currency support through the getCurrency() method leverages
  * the Currency model while maintaining a clean separation of concerns.
  */
-import { Currency } from "../currency/currency.js";
-import type { CurrencyCode } from "../currency/index.js";
-import type { CountryCode, ISO2CountryCode, ISO3CountryCode } from "./types.js";
+import { Currency } from "@models/currency/currency.js";
+import { CurrencyCode } from "@models/currency/currency.types.js";
+import { ISO2CountryCode, ISO3CountryCode, CountryCode } from "./country.types.js";
+import { z } from "zod";
+import { CountryJSONSchema } from "./country.schema.js";
+/**
+ * Infer the CountryJSON type from the schema
+ */
+export type CountryJSON = z.infer<typeof CountryJSONSchema>;
 /**
  * Enum for continents
  */
@@ -78,6 +84,7 @@ export declare class Country {
     private readonly _continent;
     private readonly _region;
     private readonly _currencyCode;
+    private readonly _dialCode;
     static readonly AF: Country;
     static readonly AX: Country;
     static readonly AL: Country;
@@ -578,8 +585,9 @@ export declare class Country {
      * @param {CONTINENT} _continent - The continent where the country is located
      * @param {SUB_REGION} _region - The region within the continent where the country is located
      * @param {string | null} _currencyCode - The ISO currency code used in the country
+     * @param {number} _dialCode - The dial code used in the country
      */
-    constructor(_name: string, _iso2: ISO2CountryCode, _nameOfficial: string, _iso3: ISO3CountryCode, _flagEmoji?: string, _continent?: CONTINENT, _region?: SUB_REGION, _currencyCode?: CurrencyCode | null);
+    constructor(token: symbol, _name: string, _iso2: ISO2CountryCode, _nameOfficial: string | undefined, _iso3: ISO3CountryCode, _flagEmoji: string | undefined, _continent: CONTINENT | undefined, _region: SUB_REGION | undefined, _currencyCode: (CurrencyCode | null) | undefined, _dialCode: number);
     /**
      * Gets the common name of the country.
      * @returns {string} The common name of the country
@@ -620,6 +628,11 @@ export declare class Country {
      * @returns {string | null} The ISO currency code of the country, or null if not available
      */
     get currencyCode(): CurrencyCode | null;
+    /**
+     * Gets the dial code used in the country.
+     * @returns {number} The dial code of the country
+     */
+    get dialCode(): number;
     /**
      * Gets the Currency instance for this country.
      * @returns {Currency | undefined} The Currency instance or undefined if no currency is assigned
@@ -709,6 +722,26 @@ export declare class Country {
      * @returns Type predicate indicating if the value is a valid Country
      */
     static is(obj: unknown): obj is Country;
+    /**
+     * Serializes the Country instance to a JSON-compatible object
+     */
+    toJSON(): CountryJSON;
+    /**
+     * Serializes the Country instance to a JSON string
+     */
+    toJSONString(): string;
+    /**
+     * Creates a Country instance from a JSON-compatible object or string
+     */
+    static fromJSON(json: CountryJSON | string): Country | undefined;
+    /**
+     * Creates a Country instance from a JSON string
+     */
+    static fromJSONString(jsonString: string): Country | undefined;
+    /**
+     * Type guard to check if an object is a valid CountryJSON using Zod validation
+     */
+    static isCountryJSON(obj: unknown): obj is CountryJSON;
 }
 /**
  * Service for managing country data.
@@ -819,4 +852,3 @@ export declare class CountryService {
      */
     compare(country1: Country, country2: Country): boolean;
 }
-//# sourceMappingURL=country.d.ts.map

package/dist/models/country/country.schema.d.ts

@@ -0,0 +1,73 @@
+import { z } from "zod";
+/**
+ * Zod schema for Country JSON serialization
+ * This schema validates the JSON representation of a Country instance
+ */
+export declare const CountryJSONSchema: z.ZodObject<{
+    /** The ISO 3166-1 alpha-2 country code */
+    code: z.ZodString;
+    /** Version for future compatibility */
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    code: string;
+    version: string;
+}, {
+    code: string;
+    version?: string | undefined;
+}>;
+/**
+ * Zod schema for validating ISO 3166-1 alpha-2 country codes.
+ *
+ * This schema checks if a given string is a valid ISO 3166-1 alpha-2 country code
+ * by checking against the predefined set of valid codes.
+ *
+ * @example
+ * const result = iso2CountryCodeSchema.safeParse("US");
+ * if (result.success) {
+ *   console.log("Valid ISO2 country code");
+ * } else {
+ *   console.error("Invalid ISO2 country code");
+ * }
+ */
+export declare const ISO2CountryCodeSchema: z.ZodEffects<z.ZodString, string, string>;
+/**
+ * Zod schema for validating ISO 3166-1 alpha-3 country codes.
+ *
+ * This schema checks if a given string is a valid ISO 3166-1 alpha-3 country code
+ * by checking against the predefined set of valid codes.
+ *
+ * @example
+ * const result = iso3CountryCodeSchema.safeParse("USA");
+ * if (result.success) {
+ *  console.log("Valid ISO3 country code");
+ * } else {
+ *  console.error("Invalid ISO3 country code");
+ * }
+ */
+export declare const ISO3CountryCodeSchema: z.ZodEffects<z.ZodString, string, string>;
+/**
+ * Zod schema for validating either ISO 3166-1 alpha-2 or alpha-3 country codes.
+ *
+ * This schema allows for flexibility in accepting both two-letter and three-letter
+ * country codes, making it useful for functions that need to handle both formats.
+ *
+ * @example
+ * const result = countryCodeSchema.safeParse("US");
+ * if (result.success) {
+ *   console.log("Valid country code");
+ * } else {
+ *   console.error("Invalid country code");
+ * }
+ */
+export declare const CountryCodeSchema: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{
+    /** The ISO 3166-1 alpha-2 country code */
+    code: z.ZodString;
+    /** Version for future compatibility */
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    code: string;
+    version: string;
+}, {
+    code: string;
+    version?: string | undefined;
+}>]>;

package/{script/src/models/country/types.d.ts → dist/models/country/country.types.d.ts}

@@ -60,4 +60,3 @@ export declare const ISO3CountryCodesSet: Set<string>;
  * @see ISO3CountryCode - For three-letter country codes only
  */
 export type CountryCode = ISO2CountryCode | ISO3CountryCode;
-//# sourceMappingURL=types.d.ts.map

package/{esm/src/models/country/utils.d.ts → dist/models/country/country.validation.d.ts}

@@ -1,21 +1,25 @@
-import type { ISO2CountryCode, ISO3CountryCode } from "./types.js";
-import type { CountryCode } from "../index.js";
+import { ISO2CountryCode, ISO3CountryCode, CountryCode } from "./country.types.js";
+export declare const CountryValidation: {
+    isISO2CountryCode: typeof isISO2CountryCode;
+    isISO3CountryCode: typeof isISO3CountryCode;
+    isCountryCode: typeof isCountryCode;
+};
 /**
  * Type guard to check if a string is a valid ISO2CountryCode.
  * @param code The string to check.
  * @returns True if the string is a member of the ISO2CountryCode union type, false otherwise.
  */
-export declare function isISO2CountryCode(code: string): code is ISO2CountryCode;
+declare function isISO2CountryCode(code: string): code is ISO2CountryCode;
 /**
  * Type guard to check if a string is a valid isISO3CountryCode.
  * @param code The string to check.
  * @returns True if the string is a member of the isISO3CountryCode union type, false otherwise.
  */
-export declare function isISO3CountryCode(code: string): code is ISO3CountryCode;
+declare function isISO3CountryCode(code: string): code is ISO3CountryCode;
 /**
  * Type guard to check if a string is a valid CountryCode.
  * @param code The string to check
  * @returns True if the string is a valid ISO-2 or ISO-3 country code
  */
-export declare function isCountryCode(code: string): code is CountryCode;
-//# sourceMappingURL=utils.d.ts.map
+declare function isCountryCode(code: string): code is CountryCode;
+export {};

package/dist/models/country/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./country.js";
+export * from "./country.types.js";
+export * from "./country.validation.js";
+export * from "./country.schema.js";

package/{script/src → dist}/models/currency/currency.d.ts

@@ -26,7 +26,13 @@
  * This approach follows the principle that closely related classes with circular
  * dependencies are best managed in a unified module.
  */
-import type { CurrencyCode } from "./types.js";
+import type { CurrencyCode } from "./currency.types.js";
+import { z } from "zod";
+import { CurrencyJSONSchema } from "./currency.schema.js";
+/**
+ * Infer the CurrencyJSON type from the schema
+ */
+export type CurrencyJSON = z.infer<typeof CurrencyJSONSchema>;
 /**
  * Represents a currency with essential details.
  * @class Currency
@@ -284,7 +290,7 @@ export declare class Currency {
      * @param {CurrencyCode} _code - The ISO 4217 currency code
      * @param {string} _namePlural - The plural form of the currency name
      */
-    constructor(_symbol: string, _name: string, _symbolNative: string, _decimalDigits: number, _rounding: number, _code: CurrencyCode, _namePlural: string);
+    constructor(token: symbol, _symbol: string, _name: string, _symbolNative: string, _decimalDigits: number, _rounding: number, _code: CurrencyCode, _namePlural: string);
     /**
      * Gets the international symbol of the currency.
      * @returns {string} The international symbol of the currency
@@ -367,6 +373,26 @@ export declare class Currency {
      * @returns Type predicate indicating if the value is a valid Currency
      */
     static is(obj: unknown): obj is Currency;
+    /**
+     * Serializes the Currency instance to a JSON-compatible object
+     */
+    toJSON(): CurrencyJSON;
+    /**
+     * Serializes the Currency instance to a JSON string
+     */
+    toJSONString(): string;
+    /**
+     * Creates a Currency instance from a JSON-compatible object or string
+     */
+    static fromJSON(json: CurrencyJSON | string): Currency | undefined;
+    /**
+     * Creates a Currency instance from a JSON string
+     */
+    static fromJSONString(jsonString: string): Currency | undefined;
+    /**
+     * Type guard to check if an object is a valid CurrencyJSON using Zod validation
+     */
+    static isCurrencyJSON(obj: unknown): obj is CurrencyJSON;
 }
 /**
  * Service for managing currency data.
@@ -462,4 +488,3 @@ export declare class CurrencyService {
      */
     private escapeRegExp;
 }
-//# sourceMappingURL=currency.d.ts.map

package/dist/models/currency/currency.schema.d.ts

@@ -0,0 +1,24 @@
+import { z } from "zod";
+/**
+ * Zod schema for validating ISO 4217 currency codes
+ *
+ * This schema checks if the provided string is a valid ISO 4217 currency code.
+ * If the validation fails, it returns an error message.
+ */
+export declare const CurrencyCodeSchema: z.ZodEffects<z.ZodString, string, string>;
+/**
+ * Zod schema for Currency JSON serialization
+ * This schema validates the JSON representation of a Currency instance
+ */
+export declare const CurrencyJSONSchema: z.ZodObject<{
+    /** The ISO 4217 currency code */
+    code: z.ZodString;
+    /** Version for future compatibility */
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    code: string;
+    version: string;
+}, {
+    code: string;
+    version?: string | undefined;
+}>;

package/{esm/src/models/currency/types.d.ts → dist/models/currency/currency.types.d.ts}

@@ -17,5 +17,4 @@
  * Example: "USD" for US Dollar, "EUR" for Euro, "JPY" for Japanese Yen
  */
 export type CurrencyCode = "USD" | "CAD" | "EUR" | "AED" | "AFN" | "ALL" | "AMD" | "ARS" | "AUD" | "AZN" | "BAM" | "BDT" | "BGN" | "BHD" | "BIF" | "BND" | "BOB" | "BRL" | "BWP" | "BYN" | "BZD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "GBP" | "GEL" | "GHS" | "GNF" | "GTQ" | "HKD" | "HNL" | "HRK" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KHR" | "KMF" | "KRW" | "KWD" | "KZT" | "LBP" | "LKR" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MOP" | "MUR" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SDG" | "SEK" | "SGD" | "SOS" | "SSP" | "SYP" | "THB" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VES" | "VND" | "XAF" | "XOF" | "YER" | "ZAR" | "ZMW" | "STN" | "MRU" | "ZWG";
-export declare const ValidCurrencyCodesSet: Set<CurrencyCode>;
-//# sourceMappingURL=types.d.ts.map
+export declare const CurrencyCodesSet: Set<CurrencyCode>;

package/dist/models/currency/currency.validation.d.ts

@@ -0,0 +1,11 @@
+import { type CurrencyCode } from "./currency.types.js";
+export declare const CurrencyValidation: {
+    isCurrencyCode: typeof isCurrencyCode;
+};
+/**
+ * Type guard to check if a string is a valid CurrencyCode.
+ * @param code The string to check.
+ * @returns True if the string is a member of the CurrencyCode union type, false otherwise.
+ */
+declare function isCurrencyCode(code: string): code is CurrencyCode;
+export {};

package/dist/models/currency/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./currency.js";
+export * from "./currency.types.js";
+export * from "./currency.validation.js";
+export * from "./currency.schema.js";

package/{esm/src/models/index.js → dist/models/index.d.ts}

@@ -1,5 +1,5 @@
 export * from "./amount/index.js";
 export * from "./bank/index.js";
-export * from "./phone_number/index.js";
+export * from "./phone-number/index.js";
 export * from "./country/index.js";
 export * from "./currency/index.js";

package/dist/models/phone-number/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./phone-number.factory.js";
+export * from "./phone-number.types.js";
+export * from "./mno/mno.utils.js";
+export * from "./mno/mno.types.js";
+export * from "./phone-number.js";
+export * from "./mno/index.js";

package/dist/models/phone-number/mno/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./ke/mobile-number.ke.js";
+export * from "./ke/mobile-number.ke-mnos.js";
+export * from "./tz/mobile-number.tz.js";
+export * from "./tz/mobile-number.tz-mnos.js";
+export * from "./mno.types.js";
+export * from "./mno.utils.js";