@temboplus/frontend-core 1.0.1-beta.2 → 1.0.1

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

@@ -316,6 +316,21 @@ declare class Amount {
      * ```
      */
     percentage(percentage: number): Amount;
+    /**
+     * Returns this amount as a percentage of another amount or numeric value.
+     *
+     * @param other - Amount object or number to use as the denominator
+     * @returns Percentage value as a number
+     * @throws {Error} If currencies don't match when comparing Amount objects
+     * @throws {Error} If the denominator is zero
+     *
+     * @example
+     * ```typescript
+     * Amount.from(25).asPercentageOf(Amount.from(100)); // 25
+     * Amount.from(50).asPercentageOf(200);              // 25
+     * ```
+     */
+    asPercentageOf(other: Amount | number): number;
     /**
      * Checks if this amount is zero
      *

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

@@ -1,5 +1,6 @@
 import type { Currency } from "../currency/currency.js";
 import type { CurrencyCode } from "../currency/currency.types.js";
+import type { Amount } from "./amount.js";
 /**
  * Formatting options for the enhanced format method.
  */
@@ -52,13 +53,25 @@ declare function formatAmountText(value: number, currency: Currency): string;
 declare function formatAmountWithIntl(value: number, currency: Currency, options: AmountFormatOptions): string;
 declare function formatAmountManually(value: number, currency: Currency, options: AmountFormatOptions): string;
 declare function formatCompactAmount(value: number, currency: Currency, precision?: number, options?: AmountCompactFormatOptions): string;
+/** Sum of every Amount, requiring a non-empty array with matching currencies. */
+declare function sum(amounts: Amount[]): Amount;
+/** Mean of every Amount, requiring a non-empty array with matching currencies. */
+declare function average(amounts: Amount[]): Amount;
+/** Smallest Amount in the array. */
+declare function min(amounts: Amount[]): Amount;
+/** Largest Amount in the array. */
+declare function max(amounts: Amount[]): Amount;
 export declare const AmountHelpers: {
     AMOUNT_REGEX: RegExp;
+    average: typeof average;
     containsForbiddenCurrencySymbol: typeof containsForbiddenCurrencySymbol;
     formatAmountText: typeof formatAmountText;
     formatAmountManually: typeof formatAmountManually;
     formatAmountWithIntl: typeof formatAmountWithIntl;
     formatCompactAmount: typeof formatCompactAmount;
+    max: typeof max;
+    min: typeof min;
     parseCurrencyAmountInput: typeof parseCurrencyAmountInput;
+    sum: typeof sum;
 };
 export {};

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.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/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/amount.factory.d.ts

@@ -2,7 +2,7 @@ import { Amount } from "@domain/amount/amount.js";
 import { type AmountJSON } from "@domain/amount/amount.schema.js";
 import type { CurrencyCode } from "@domain/currency/currency.types.js";
 /**
- * Owns Amount construction, parsing, validation, and aggregate operations.
+ * Owns Amount construction, parsing, and validation.
  * Resolves currencies through CurrencyRegistry; never owns currency data itself.
  */
 export declare class AmountFactory {
@@ -35,14 +35,6 @@ export declare class AmountFactory {
     isAmountJSON(obj: unknown): obj is AmountJSON;
     /** Verifies that an Amount instance can still be reconstructed cleanly. */
     validate(amount: Amount): boolean;
-    /** Sum of every Amount, requiring matching currencies. */
-    sum(amounts: Amount[]): Amount;
-    /** Mean of every Amount, requiring matching currencies and non-empty array. */
-    average(amounts: Amount[]): Amount;
-    /** Smallest Amount in the array (most negative wins). */
-    min(amounts: Amount[]): Amount;
-    /** Largest Amount in the array. */
-    max(amounts: Amount[]): Amount;
     /** Builds an Amount by validating a numeric string and currency code. */
     private createFromString;
     /** Resolves a (possibly mixed-case) currency code to its canonical form. */