@temboplus/tembo-dashboard 0.0.26-beta.0 → 0.0.26-beta.1

package/dist/modules/wallet/wallet.api-contract.d.ts

@@ -0,0 +1,406 @@
+import { z } from "zod";
+export declare const walletContract: {
+    listWallets: {
+        summary: "List wallets";
+        description: "Retrieve all wallets linked to the account across supported currencies.";
+        method: "GET";
+        path: "";
+        responses: {
+            200: z.ZodArray<z.ZodObject<{
+                accountNo: z.ZodString;
+                accountName: z.ZodString;
+                type: z.ZodString;
+                balance: z.ZodNumber;
+                currency: z.ZodString;
+                countryCode: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                type: string;
+                balance: number;
+                accountName: string;
+                accountNo: string;
+                countryCode: string;
+                currency: string;
+            }, {
+                type: string;
+                balance: number;
+                accountName: string;
+                accountNo: string;
+                countryCode: string;
+                currency: string;
+            }>, "many">;
+            401: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+            } & {
+                statusCode: z.ZodLiteral<401>;
+            }, "strip", z.ZodTypeAny, {
+                statusCode: 401;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }, {
+                statusCode: 401;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }>;
+            500: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+            } & {
+                statusCode: z.ZodLiteral<500>;
+            }, "strip", z.ZodTypeAny, {
+                statusCode: 500;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }, {
+                statusCode: 500;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }>;
+        };
+    };
+    getWalletInfo: {
+        pathParams: z.ZodObject<{
+            accountNo: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            accountNo: string;
+        }, {
+            accountNo: string;
+        }>;
+        summary: "Get wallet info";
+        description: "Retrieve wallet metadata including balance, currency, and type for a specific wallet.";
+        method: "GET";
+        path: "/:accountNo";
+        responses: {
+            200: z.ZodObject<{
+                accountNo: z.ZodString;
+                accountName: z.ZodString;
+                type: z.ZodString;
+                balance: z.ZodNumber;
+                currency: z.ZodString;
+                countryCode: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                type: string;
+                balance: number;
+                accountName: string;
+                accountNo: string;
+                countryCode: string;
+                currency: string;
+            }, {
+                type: string;
+                balance: number;
+                accountName: string;
+                accountNo: string;
+                countryCode: string;
+                currency: string;
+            }>;
+            401: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+            } & {
+                statusCode: z.ZodLiteral<401>;
+            }, "strip", z.ZodTypeAny, {
+                statusCode: 401;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }, {
+                statusCode: 401;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }>;
+            500: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+            } & {
+                statusCode: z.ZodLiteral<500>;
+            }, "strip", z.ZodTypeAny, {
+                statusCode: 500;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }, {
+                statusCode: 500;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }>;
+        };
+    };
+    getWalletBalance: {
+        summary: "Get wallet balance";
+        description: "Retrieve the current and available balance for a specific wallet account number.";
+        method: "POST";
+        body: z.ZodObject<{
+            accountNo: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            accountNo: string;
+        }, {
+            accountNo: string;
+        }>;
+        path: "/balance";
+        responses: {
+            200: z.ZodObject<{
+                availableBalance: z.ZodNumber;
+                currentBalance: z.ZodNumber;
+                accountStatus: z.ZodString;
+                accountNo: z.ZodString;
+                accountName: z.ZodString;
+                type: z.ZodString;
+                currencyCode: z.ZodString;
+                countryCode: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                type: string;
+                availableBalance: number;
+                accountName: string;
+                accountNo: string;
+                currencyCode: string;
+                countryCode: string;
+                currentBalance: number;
+                accountStatus: string;
+            }, {
+                type: string;
+                availableBalance: number;
+                accountName: string;
+                accountNo: string;
+                currencyCode: string;
+                countryCode: string;
+                currentBalance: number;
+                accountStatus: string;
+            }>;
+            400: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+            } & {
+                statusCode: z.ZodLiteral<400>;
+            }, "strip", z.ZodTypeAny, {
+                statusCode: 400;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }, {
+                statusCode: 400;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }>;
+            401: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+            } & {
+                statusCode: z.ZodLiteral<401>;
+            }, "strip", z.ZodTypeAny, {
+                statusCode: 401;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }, {
+                statusCode: 401;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }>;
+            404: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+            } & {
+                statusCode: z.ZodLiteral<404>;
+            }, "strip", z.ZodTypeAny, {
+                statusCode: 404;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }, {
+                statusCode: 404;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }>;
+            500: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+            } & {
+                statusCode: z.ZodLiteral<500>;
+            }, "strip", z.ZodTypeAny, {
+                statusCode: 500;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }, {
+                statusCode: 500;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }>;
+        };
+    };
+    getWalletStatement: {
+        summary: "Get wallet statement";
+        description: "Retrieve statement entries for a specific wallet within a date range.";
+        method: "POST";
+        body: z.ZodObject<{
+            accountNo: z.ZodString;
+            startDate: z.ZodString;
+            endDate: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            startDate: string;
+            endDate: string;
+            accountNo: string;
+        }, {
+            startDate: string;
+            endDate: string;
+            accountNo: string;
+        }>;
+        path: "/statement";
+        responses: {
+            200: z.ZodArray<z.ZodObject<{
+                accountNo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                debitOrCredit: z.ZodEnum<["CR", "DR"]>;
+                tranRefNo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                narration: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                txnDate: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null, string | null | undefined>;
+                valueDate: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null, string | null | undefined>;
+                amountCredited: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodEffects<z.ZodString, number, string>]>>>;
+                amountDebited: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodEffects<z.ZodString, number, string>]>>>;
+                balance: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                balance: number;
+                debitOrCredit: "CR" | "DR";
+                txnDate: string | null;
+                valueDate: string | null;
+                accountNo?: string | null | undefined;
+                tranRefNo?: string | null | undefined;
+                narration?: string | null | undefined;
+                amountCredited?: number | null | undefined;
+                amountDebited?: number | null | undefined;
+            }, {
+                balance: number;
+                debitOrCredit: "CR" | "DR";
+                accountNo?: string | null | undefined;
+                tranRefNo?: string | null | undefined;
+                narration?: string | null | undefined;
+                txnDate?: string | null | undefined;
+                valueDate?: string | null | undefined;
+                amountCredited?: string | number | null | undefined;
+                amountDebited?: string | number | null | undefined;
+            }>, "many">;
+            400: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+            } & {
+                statusCode: z.ZodLiteral<400>;
+            }, "strip", z.ZodTypeAny, {
+                statusCode: 400;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }, {
+                statusCode: 400;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }>;
+            401: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+            } & {
+                statusCode: z.ZodLiteral<401>;
+            }, "strip", z.ZodTypeAny, {
+                statusCode: 401;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }, {
+                statusCode: 401;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }>;
+            404: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+            } & {
+                statusCode: z.ZodLiteral<404>;
+            }, "strip", z.ZodTypeAny, {
+                statusCode: 404;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }, {
+                statusCode: 404;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }>;
+            500: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+            } & {
+                statusCode: z.ZodLiteral<500>;
+            }, "strip", z.ZodTypeAny, {
+                statusCode: 500;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }, {
+                statusCode: 500;
+                message?: string | undefined;
+                error?: string | undefined;
+                details?: Record<string, unknown> | undefined;
+                reason?: string | undefined;
+            }>;
+        };
+    };
+};
+export type WalletContract = typeof walletContract;

package/dist/modules/wallet/wallet.model.d.ts

@@ -0,0 +1,35 @@
+import { Amount, AmountJson, CurrencyCode } from "@temboplus/frontend-core";
+export interface WalletData {
+    accountNo: string;
+    accountName: string;
+    type: string;
+    balance: number;
+    currency: string;
+    countryCode: string;
+}
+export interface WalletJson {
+    accountNo: string;
+    accountName: string;
+    type: string;
+    balance: AmountJson;
+    currency: CurrencyCode;
+    countryCode: string;
+}
+export declare class Wallet {
+    readonly accountNo: string;
+    readonly accountName: string;
+    readonly type: string;
+    readonly balance: Amount;
+    readonly currency: CurrencyCode;
+    readonly countryCode: string;
+    private readonly _originalData;
+    constructor(data: WalletData);
+    getOriginalData(): Readonly<WalletData>;
+    isCollectionWallet(): boolean;
+    isDisbursementWallet(): boolean;
+    isDefaultWallet(): boolean;
+    static from(data: WalletData): Wallet;
+    static createMany(dataArray: WalletData[]): Wallet[];
+    toJSON(): WalletJson;
+    static fromJSON(json: WalletJson): Wallet | undefined;
+}

package/dist/modules/wallet/wallet.repository.d.ts

@@ -0,0 +1,20 @@
+import { BaseRepository } from "@/lib/api";
+import { StatementEntry, WalletInfo } from "@/lib/models";
+import { Wallet } from "./wallet.model";
+import { walletContract } from "./wallet.api-contract";
+export interface WalletStatementInput {
+    accountNo: string;
+    startDate: Date | string;
+    endDate: Date | string;
+}
+export declare class WalletRepository extends BaseRepository<typeof walletContract> {
+    constructor(options?: {
+        token?: string;
+        root?: string;
+    });
+    listWallets(): Promise<Wallet[]>;
+    getWalletInfo(accountNo: string): Promise<Wallet>;
+    getWalletBalance(accountNo: string): Promise<WalletInfo>;
+    getWalletStatement(input: WalletStatementInput): Promise<StatementEntry[]>;
+    private formatStatementDate;
+}

package/dist/modules/wallet/wallet.types.d.ts

@@ -0,0 +1,84 @@
+import { z } from "zod";
+export declare enum WALLET_TYPE {
+    DEFAULT_DISBURSEMENT = "DEFAULT DISBURSEMENT",
+    DEFAULT_COLLECTION = "DEFAULT COLLECTION",
+    COLLECTION = "COLLECTION",
+    DISBURSEMENT = "DISBURSEMENT"
+}
+export declare const WalletDTOSchemas: {
+    wallet: z.ZodObject<{
+        accountNo: z.ZodString;
+        accountName: z.ZodString;
+        type: z.ZodString;
+        balance: z.ZodNumber;
+        currency: z.ZodString;
+        countryCode: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        balance: number;
+        accountName: string;
+        accountNo: string;
+        countryCode: string;
+        currency: string;
+    }, {
+        type: string;
+        balance: number;
+        accountName: string;
+        accountNo: string;
+        countryCode: string;
+        currency: string;
+    }>;
+    walletType: z.ZodNativeEnum<typeof WALLET_TYPE>;
+    walletBalanceRequest: z.ZodObject<{
+        accountNo: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        accountNo: string;
+    }, {
+        accountNo: string;
+    }>;
+    walletBalance: z.ZodObject<{
+        availableBalance: z.ZodNumber;
+        currentBalance: z.ZodNumber;
+        accountStatus: z.ZodString;
+        accountNo: z.ZodString;
+        accountName: z.ZodString;
+        type: z.ZodString;
+        currencyCode: z.ZodString;
+        countryCode: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        availableBalance: number;
+        accountName: string;
+        accountNo: string;
+        currencyCode: string;
+        countryCode: string;
+        currentBalance: number;
+        accountStatus: string;
+    }, {
+        type: string;
+        availableBalance: number;
+        accountName: string;
+        accountNo: string;
+        currencyCode: string;
+        countryCode: string;
+        currentBalance: number;
+        accountStatus: string;
+    }>;
+    walletStatementRequest: z.ZodObject<{
+        accountNo: z.ZodString;
+        startDate: z.ZodString;
+        endDate: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        startDate: string;
+        endDate: string;
+        accountNo: string;
+    }, {
+        startDate: string;
+        endDate: string;
+        accountNo: string;
+    }>;
+};
+export type WalletDTO = z.infer<typeof WalletDTOSchemas.wallet>;
+export type WalletBalanceRequestDTO = z.infer<typeof WalletDTOSchemas.walletBalanceRequest>;
+export type WalletBalanceDTO = z.infer<typeof WalletDTOSchemas.walletBalance>;
+export type WalletStatementRequestDTO = z.infer<typeof WalletDTOSchemas.walletStatementRequest>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temboplus/tembo-dashboard",
-  "version": "0.0.26-beta.0",
+  "version": "0.0.26-beta.1",
   "description": "A foundational library for Temboplus-Dashboard projects providing type-safe data layer abstraction with API contracts, domain models, and repositories.",
   "main": "./dist/index.cjs.js",
   "module": "./dist/index.esm.js",
@@ -57,6 +57,6 @@
     "typescript": "^5.8.3"
   },
   "dependencies": {
-    "@temboplus/frontend-core": "^0.2.20-beta.3"
+    "@temboplus/frontend-core": "^0.3.0-beta.2"
   }
 }