@temboplus/frontend-core 1.0.1-beta.1 → 1.0.1-beta.3

package/dist/domain/amount/amount.schema.d.ts

@@ -10,10 +10,10 @@ export declare const AmountJSONSchema: z.ZodObject<{
     text: z.ZodString;
     /** The ISO currency code */
     currencyCode: z.ZodString;
-    /** Version for future compatibility */
-    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    /** Model JSON schema version for future compatibility. */
+    _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
-    version: string;
+    _version: string;
     value: number;
     text: string;
     currencyCode: string;
@@ -21,7 +21,7 @@ export declare const AmountJSONSchema: z.ZodObject<{
     value: number;
     text: string;
     currencyCode: string;
-    version?: string | undefined;
+    _version?: string | undefined;
 }>;
 /**
  * Compact JSON identity for an Amount, sufficient to reconstruct the value via

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

@@ -14,26 +14,26 @@ export declare const BankJSONSchema: z.ZodEffects<z.ZodObject<{
     swiftCode: z.ZodOptional<z.ZodString>;
     /** The ISO 3166-1 alpha-2 country code */
     countryCode: z.ZodString;
-    /** Version for future compatibility */
-    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    /** Model JSON schema version for future compatibility. */
+    _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
-    version: string;
+    _version: string;
     countryCode: string;
     bic?: string | undefined;
     swiftCode?: string | undefined;
 }, {
     countryCode: string;
-    version?: string | undefined;
+    _version?: string | undefined;
     bic?: string | undefined;
     swiftCode?: string | undefined;
 }>, {
-    version: string;
+    _version: string;
     countryCode: string;
     bic?: string | undefined;
     swiftCode?: string | undefined;
 }, {
     countryCode: string;
-    version?: string | undefined;
+    _version?: string | undefined;
     bic?: string | undefined;
     swiftCode?: string | undefined;
 }>;

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

@@ -6,14 +6,14 @@ import { z } from "zod";
 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>>;
+    /** Model JSON schema version for future compatibility. */
+    _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     code: string;
-    version: string;
+    _version: string;
 }, {
     code: string;
-    version?: string | undefined;
+    _version?: string | undefined;
 }>;
 /**
  * Zod schema for validating ISO 3166-1 alpha-2 country codes.
@@ -62,12 +62,12 @@ export declare const ISO3CountryCodeSchema: z.ZodEffects<z.ZodString, string, st
 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>>;
+    /** Model JSON schema version for future compatibility. */
+    _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     code: string;
-    version: string;
+    _version: string;
 }, {
     code: string;
-    version?: string | undefined;
+    _version?: string | undefined;
 }>]>;

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

@@ -13,12 +13,12 @@ export declare const CurrencyCodeSchema: z.ZodEffects<z.ZodString, string, strin
 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>>;
+    /** Model JSON schema version for future compatibility. */
+    _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     code: string;
-    version: string;
+    _version: string;
 }, {
     code: string;
-    version?: string | undefined;
+    _version?: string | undefined;
 }>;

package/dist/domain/mobile-money-provider/mobile-money-provider.d.ts

@@ -1,7 +1,7 @@
 import { ChannelType, TransactionDirection } from "@domain/channel/channel.enums.js";
 import type { ISO2CountryCode } from "@domain/country/country.types.js";
 import { MobileMoneyProviderJSON } from "./mobile-money-provider.schema.js";
-import type { MobileMoneyProviderData } from "./mobile-money-provider.types.js";
+import type { MobileMoneyProviderData, MobileMoneyProviderId } from "./mobile-money-provider.types.js";
 /**
  * Plain-object representation of a MobileMoneyProvider containing the full state.
  */
@@ -18,7 +18,7 @@ export declare const MobileMoneyProviderConstructorToken: unique symbol;
  * the static methods on this class are thin delegations for ergonomic call sites.
  */
 export declare class MobileMoneyProvider {
-    readonly id: string;
+    readonly id: MobileMoneyProviderId;
     readonly displayName: string;
     readonly mobileMoneyServiceName: string;
     readonly countryCode: MobileMoneyProviderData["countryCode"];
@@ -42,7 +42,7 @@ export declare class MobileMoneyProvider {
      * Resolves a MobileMoneyProvider by ID. When `countryCode` is omitted, the
      * factory searches across every supported country.
      */
-    static fromID(id: string, countryCode?: ISO2CountryCode): MobileMoneyProvider | undefined;
+    static fromID(id: MobileMoneyProviderId | string, countryCode?: ISO2CountryCode): MobileMoneyProvider | undefined;
     /** Re-resolves a MobileMoneyProvider from its compact JSON identity. */
     static fromJSON(json: MobileMoneyProviderJSON | string): MobileMoneyProvider | undefined;
     /** Re-resolves a MobileMoneyProvider from a JSON string. */

package/dist/domain/mobile-money-provider/mobile-money-provider.helpers.d.ts

@@ -1,5 +1,66 @@
-import { isPhonePrefix, isProviderId } from "./mobile-money-provider.types.js";
+import type { TransactionDirection } from "@domain/channel/channel.enums.js";
+import type { ISO2CountryCode } from "@domain/country/country.types.js";
+import { PhoneNumber } from "@domain/phone-number/phone-number.js";
+import { MobileMoneyProvider } from "./mobile-money-provider.js";
+import { isMobileMoneyProviderId, isPhonePrefix, isProviderId, type MobileMoneyProviderId } from "./mobile-money-provider.types.js";
+/**
+ * Flat helper surface around `MobileMoneyProvider`, the registry, and the
+ * provider ID type guards. Mirrors `BankHelpers` / `CountryHelpers` so consumers
+ * have a single entry point and don't need to reach into the registry singleton
+ * directly.
+ */
 export declare const MobileMoneyProviderHelpers: {
     isProviderId: typeof isProviderId;
+    isMobileMoneyProviderId: typeof isMobileMoneyProviderId;
     isPhonePrefix: typeof isPhonePrefix;
+    findById: typeof findById;
+    getProviders: typeof getProviders;
+    requiresExplicitProvider: typeof requiresExplicitProvider;
+    isProviderSupported: typeof isProviderSupported;
+    detectProviderByPhoneNumber: typeof detectProviderByPhoneNumber;
+    validateProviderForPhoneNumber: typeof validateProviderForPhoneNumber;
 };
+/**
+ * Resolves a provider by ID. When `countryCode` is provided the lookup is
+ * scoped to that country; otherwise every supported country is searched.
+ *
+ * @returns the matching `MobileMoneyProvider`, or `undefined` if not found.
+ */
+declare function findById(id: MobileMoneyProviderId | string, countryCode?: ISO2CountryCode): MobileMoneyProvider | undefined;
+/**
+ * Returns every supported provider for a country, optionally filtered by
+ * transaction direction.
+ */
+declare function getProviders(countryCode: ISO2CountryCode, direction?: TransactionDirection): MobileMoneyProvider[];
+/**
+ * Whether the country requires the caller to supply the provider ID
+ * explicitly (e.g. Kenya, where number portability makes prefix-based
+ * detection unreliable).
+ */
+declare function requiresExplicitProvider(countryCode: ISO2CountryCode): boolean;
+/**
+ * Whether a provider ID is supported in the given country, optionally
+ * constrained to a transaction direction.
+ */
+declare function isProviderSupported(countryCode: ISO2CountryCode, providerId: MobileMoneyProviderId | string, direction?: TransactionDirection): boolean;
+/**
+ * Detects a provider from a phone number when prefix mapping is reliable.
+ *
+ * Accepts either a parsed `PhoneNumber` or a raw string (which will be parsed
+ * via `PhoneNumber.from`). Returns `undefined` when the country requires an
+ * explicit provider, or when no prefix matches.
+ */
+declare function detectProviderByPhoneNumber(input: PhoneNumber | string): MobileMoneyProvider | undefined;
+/**
+ * Validates that a provider ID is consistent with a phone number.
+ *
+ * - When the country uses prefix-based detection, the supplied ID must match
+ *   the provider auto-detected from the phone's prefix.
+ * - When the country requires an explicit provider, any supported ID for that
+ *   country is accepted.
+ *
+ * Returns `false` if the phone number cannot be parsed or the ID is not
+ * supported in the inferred country.
+ */
+declare function validateProviderForPhoneNumber(phoneNumber: PhoneNumber | string, providerId: MobileMoneyProviderId | string): boolean;
+export {};

package/dist/domain/mobile-money-provider/mobile-money-provider.schema.d.ts

@@ -5,9 +5,9 @@ export declare const MobileMoneyProviderJSONSchema: z.ZodObject<{
     countryCode: z.ZodString;
     channelType: z.ZodDefault<z.ZodLiteral<ChannelType.MOBILE_MONEY>>;
     direction: z.ZodOptional<z.ZodNativeEnum<typeof TransactionDirection>>;
-    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
-    version: string;
+    _version: string;
     countryCode: string;
     id: string;
     channelType: ChannelType.MOBILE_MONEY;
@@ -15,7 +15,7 @@ export declare const MobileMoneyProviderJSONSchema: z.ZodObject<{
 }, {
     countryCode: string;
     id: string;
-    version?: string | undefined;
+    _version?: string | undefined;
     channelType?: ChannelType.MOBILE_MONEY | undefined;
     direction?: TransactionDirection | undefined;
 }>;

package/dist/domain/mobile-money-provider/mobile-money-provider.types.d.ts

@@ -1,8 +1,25 @@
 import type { ISO2CountryCode } from "@domain/country/country.types.js";
 import type { CurrencyCode } from "@domain/currency/currency.types.js";
 import type { TransactionDirection } from "@domain/channel/channel.enums.js";
+/**
+ * Tanzania mobile-money provider IDs.
+ * Keep this in sync with src/data/mobile-money/tz.json.
+ */
+export type TZMobileMoneyProviderId = "VODACOM" | "AIRTEL" | "TIGO" | "HALOTEL";
+/**
+ * Kenya mobile-money provider IDs.
+ * Keep this in sync with src/data/mobile-money/ke.json.
+ */
+export type KEMobileMoneyProviderId = "SAFARICOM";
+/**
+ * Stable Tembo identifier for any supported mobile-money provider.
+ *
+ * Combines the per-country provider unions so a value of this type is
+ * guaranteed to refer to a real provider in the package's dataset.
+ */
+export type MobileMoneyProviderId = TZMobileMoneyProviderId | KEMobileMoneyProviderId;
 export interface MobileMoneyProviderData {
-    id: string;
+    id: MobileMoneyProviderId;
     displayName: string;
     mobileMoneyServiceName: string;
     countryCode: ISO2CountryCode;
@@ -11,10 +28,24 @@ export interface MobileMoneyProviderData {
     requiresExplicitProvider: boolean;
     phonePrefixes: string[];
 }
+/** Set of TZ provider IDs derived from the dataset for runtime lookups. */
+export declare const TZMobileMoneyProviderIdsSet: Set<string>;
+/** Set of KE provider IDs derived from the dataset for runtime lookups. */
+export declare const KEMobileMoneyProviderIdsSet: Set<string>;
+/** Combined set of every supported provider ID across countries. */
+export declare const MobileMoneyProviderIdsSet: Set<string>;
 /**
  * Provider IDs are stable uppercase Tembo identifiers, not display names.
+ *
+ * This is a shape check (matches the regex of valid IDs); use
+ * `isMobileMoneyProviderId` for membership against the dataset.
  */
 export declare function isProviderId(value: unknown): value is string;
+/**
+ * Membership check: returns true when the value is one of the provider IDs
+ * present in the package's dataset.
+ */
+export declare function isMobileMoneyProviderId(value: unknown): value is MobileMoneyProviderId;
 /**
  * Prefixes are national-number prefixes used only when detection is reliable.
  */

package/dist/domain/phone-number/phone-number.schema.d.ts

@@ -10,12 +10,12 @@ import { z } from "zod";
  */
 export declare const PhoneNumberJSONSchema: z.ZodObject<{
     e164Format: z.ZodString;
-    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
-    version: string;
+    _version: string;
     e164Format: string;
 }, {
     e164Format: string;
-    version?: string | undefined;
+    _version?: string | undefined;
 }>;
 export type PhoneNumberJSON = z.infer<typeof PhoneNumberJSONSchema>;

package/dist/factories/mobile-money-provider.factory.d.ts

@@ -2,6 +2,7 @@ import type { ISO2CountryCode } from "@domain/country/country.types.js";
 import type { CurrencyCode } from "@domain/currency/currency.types.js";
 import { MobileMoneyProvider } from "@domain/mobile-money-provider/mobile-money-provider.js";
 import { type MobileMoneyProviderJSON } from "@domain/mobile-money-provider/mobile-money-provider.schema.js";
+import type { MobileMoneyProviderId } from "@domain/mobile-money-provider/mobile-money-provider.types.js";
 import { type RawMobileMoneyProvider } from "@repositories/mobile-money-provider.repository.js";
 /**
  * Constructs MobileMoneyProvider model instances from raw provider records.
@@ -19,7 +20,7 @@ export declare class MobileMoneyProviderFactory {
      * lookup is scoped to that country; otherwise the repository searches across
      * every supported country.
      */
-    create(id: string, countryCode?: ISO2CountryCode): MobileMoneyProvider | undefined;
+    create(id: MobileMoneyProviderId | string, countryCode?: ISO2CountryCode): MobileMoneyProvider | undefined;
     /**
      * Builds a MobileMoneyProvider directly from a raw provider record plus the
      * country/currency context (typically supplied by the repository or registry).