@temboplus/tembo-dashboard 0.0.1

package/dist/modules/collection/collection.dtos.d.ts

@@ -0,0 +1,195 @@
+import { z } from "zod";
+export declare enum COLLECTION_STATUS {
+    PAYMENT_ACCEPTED = "PAYMENT_ACCEPTED",
+    GENERIC_FAILURE = "GENERIC_FAILURE",
+    PAYMENT_REJECTED = "PAYMENT_REJECTED",
+    PENDING_ACK = "PENDING_ACK"
+}
+export declare enum COLLECTION_CHANNEL {
+    AIRTEL = "TZ-AIRTEL-C2B",
+    TIGO = "TZ-TIGO-C2B",
+    HALOTEL = "TZ-HALOTEL-C2B"
+}
+export declare const accountSummarySchema: z.ZodObject<{
+    balance: z.ZodNumber;
+    availableBalance: z.ZodNumber;
+    accountNumber: z.ZodString;
+    accountName: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    balance: number;
+    availableBalance: number;
+    accountNumber: string;
+    accountName: string;
+}, {
+    balance: number;
+    availableBalance: number;
+    accountNumber: string;
+    accountName: string;
+}>;
+export declare const CollectionDTOSchemas: {
+    collection: z.ZodObject<{
+        id: z.ZodString;
+        status: z.ZodNativeEnum<typeof COLLECTION_STATUS>;
+        statusMessage: z.ZodString;
+        accountNo: z.ZodString;
+        walletId: z.ZodString;
+        transactionDate: z.ZodString;
+        narration: z.ZodString;
+        msisdn: z.ZodString;
+        channel: z.ZodNativeEnum<typeof COLLECTION_CHANNEL>;
+        amount: z.ZodNumber;
+        serviceFee: z.ZodOptional<z.ZodString>;
+        postedAmount: z.ZodOptional<z.ZodString>;
+        reference: z.ZodString;
+        partnerReference: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        transactionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        serviceFeeTransactionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        requestId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        completedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        notes: z.ZodOptional<z.ZodString>;
+        currencyCode: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        status: COLLECTION_STATUS;
+        id: string;
+        statusMessage: string;
+        accountNo: string;
+        walletId: string;
+        transactionDate: string;
+        narration: string;
+        msisdn: string;
+        channel: COLLECTION_CHANNEL;
+        amount: number;
+        reference: string;
+        createdAt: string;
+        updatedAt: string;
+        currencyCode: string;
+        serviceFee?: string | undefined;
+        postedAmount?: string | undefined;
+        partnerReference?: string | null | undefined;
+        transactionId?: string | null | undefined;
+        serviceFeeTransactionId?: string | null | undefined;
+        requestId?: string | null | undefined;
+        completedAt?: string | null | undefined;
+        notes?: string | undefined;
+    }, {
+        status: COLLECTION_STATUS;
+        id: string;
+        statusMessage: string;
+        accountNo: string;
+        walletId: string;
+        transactionDate: string;
+        narration: string;
+        msisdn: string;
+        channel: COLLECTION_CHANNEL;
+        amount: number;
+        reference: string;
+        createdAt: string;
+        updatedAt: string;
+        serviceFee?: string | undefined;
+        postedAmount?: string | undefined;
+        partnerReference?: string | null | undefined;
+        transactionId?: string | null | undefined;
+        serviceFeeTransactionId?: string | null | undefined;
+        requestId?: string | null | undefined;
+        completedAt?: string | null | undefined;
+        notes?: string | undefined;
+        currencyCode?: string | undefined;
+    }>;
+    collectionQueryParams: z.ZodObject<{
+        page: z.ZodDefault<z.ZodNumber>;
+        limit: z.ZodDefault<z.ZodNumber>;
+        sortBy: z.ZodDefault<z.ZodEnum<["transactionDate", "amount", "status", "createdAt"]>>;
+        sortOrder: z.ZodDefault<z.ZodEnum<["asc", "desc"]>>;
+        startDate: z.ZodOptional<z.ZodString>;
+        endDate: z.ZodOptional<z.ZodString>;
+        msisdn: z.ZodOptional<z.ZodString>;
+        id: z.ZodOptional<z.ZodString>;
+        reference: z.ZodOptional<z.ZodString>;
+        accountNo: z.ZodOptional<z.ZodString>;
+        partnerReference: z.ZodOptional<z.ZodString>;
+        channel: z.ZodOptional<z.ZodNativeEnum<typeof COLLECTION_CHANNEL>>;
+        status: z.ZodOptional<z.ZodNativeEnum<typeof COLLECTION_STATUS>>;
+        minAmount: z.ZodOptional<z.ZodNumber>;
+        maxAmount: z.ZodOptional<z.ZodNumber>;
+        search: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        page: number;
+        limit: number;
+        sortBy: "status" | "transactionDate" | "amount" | "createdAt";
+        sortOrder: "asc" | "desc";
+        status?: COLLECTION_STATUS | undefined;
+        search?: string | undefined;
+        id?: string | undefined;
+        accountNo?: string | undefined;
+        msisdn?: string | undefined;
+        channel?: COLLECTION_CHANNEL | undefined;
+        reference?: string | undefined;
+        partnerReference?: string | undefined;
+        startDate?: string | undefined;
+        endDate?: string | undefined;
+        minAmount?: number | undefined;
+        maxAmount?: number | undefined;
+    }, {
+        status?: COLLECTION_STATUS | undefined;
+        page?: number | undefined;
+        limit?: number | undefined;
+        search?: string | undefined;
+        id?: string | undefined;
+        accountNo?: string | undefined;
+        msisdn?: string | undefined;
+        channel?: COLLECTION_CHANNEL | undefined;
+        reference?: string | undefined;
+        partnerReference?: string | undefined;
+        sortBy?: "status" | "transactionDate" | "amount" | "createdAt" | undefined;
+        sortOrder?: "asc" | "desc" | undefined;
+        startDate?: string | undefined;
+        endDate?: string | undefined;
+        minAmount?: number | undefined;
+        maxAmount?: number | undefined;
+    }>;
+    pagination: z.ZodObject<{
+        page: z.ZodNumber;
+        limit: z.ZodNumber;
+        total: z.ZodNumber;
+        totalPages: z.ZodNumber;
+        hasNext: z.ZodBoolean;
+        hasPrev: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }>;
+    paymentStatus: z.ZodNativeEnum<typeof COLLECTION_STATUS>;
+    paymentChannel: z.ZodNativeEnum<typeof COLLECTION_CHANNEL>;
+    accountSummary: z.ZodObject<{
+        balance: z.ZodNumber;
+        availableBalance: z.ZodNumber;
+        accountNumber: z.ZodString;
+        accountName: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        balance: number;
+        availableBalance: number;
+        accountNumber: string;
+        accountName: string;
+    }, {
+        balance: number;
+        availableBalance: number;
+        accountNumber: string;
+        accountName: string;
+    }>;
+};
+export type CollectionDTO = z.infer<typeof CollectionDTOSchemas.collection>;
+export type CollectionQueryParamsDTO = z.infer<typeof CollectionDTOSchemas.collectionQueryParams>;
+export type AccountSummaryDTO = z.infer<typeof CollectionDTOSchemas.accountSummary>;

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

@@ -0,0 +1,145 @@
+import { Amount, AmountJson } from "@temboplus/frontend-core";
+import { COLLECTION_CHANNEL, COLLECTION_STATUS } from "./collection.dtos";
+export interface CollectionStatusInfo {
+    label: string;
+    description: string;
+    category: "success" | "pending" | "failed";
+    color: "success" | "warning" | "error";
+    userFriendlyMessage: string;
+}
+export declare const COLLECTION_STATUS_INFO: Record<COLLECTION_STATUS, CollectionStatusInfo>;
+export interface ChannelInfo {
+    networkOperator: string;
+    serviceName: string;
+    type: "mobile" | "bank";
+}
+export declare const CHANNEL_INFO: Record<COLLECTION_CHANNEL, ChannelInfo>;
+export interface CollectionData {
+    id: string;
+    status: COLLECTION_STATUS;
+    statusMessage: string;
+    accountNo: string;
+    walletId: string;
+    transactionDate: string;
+    narration: string;
+    msisdn: string;
+    channel: COLLECTION_CHANNEL;
+    amount: number;
+    serviceFee?: string;
+    postedAmount?: string;
+    reference: string;
+    partnerReference?: string | null;
+    transactionId?: string | null;
+    serviceFeeTransactionId?: string | null;
+    requestId?: string | null;
+    completedAt?: string | null;
+    createdAt: string;
+    updatedAt: string;
+    notes?: string;
+    currencyCode: string;
+}
+export interface CollectionJson {
+    id: string;
+    status: COLLECTION_STATUS;
+    statusMessage: string;
+    accountNo: string;
+    walletId: string;
+    transactionDate: string;
+    narration: string;
+    msisdn: string;
+    channel: COLLECTION_CHANNEL;
+    amount: AmountJson;
+    serviceFee?: AmountJson;
+    postedAmount?: AmountJson;
+    reference: string;
+    partnerReference?: string | null;
+    transactionId?: string | null;
+    serviceFeeTransactionId?: string | null;
+    requestId?: string | null;
+    completedAt?: string | null;
+    createdAt: string;
+    updatedAt: string;
+    notes?: string;
+    currencyCode: string;
+}
+/**
+ * Represents a collection transaction
+ */
+export declare class Collection {
+    readonly id: string;
+    readonly status: COLLECTION_STATUS;
+    readonly statusMessage: string;
+    readonly accountNo: string;
+    readonly walletId: string;
+    readonly transactionDate: Date;
+    readonly narration: string;
+    readonly msisdn: string;
+    readonly channel: COLLECTION_CHANNEL;
+    readonly amount: Amount;
+    readonly serviceFee?: Amount;
+    readonly postedAmount?: Amount;
+    readonly reference: string;
+    readonly partnerReference?: string | null;
+    readonly transactionId?: string | null;
+    readonly serviceFeeTransactionId?: string | null;
+    readonly requestId?: string | null;
+    readonly completedAt?: Date | null;
+    readonly createdAt: Date;
+    readonly updatedAt: Date;
+    readonly notes?: string;
+    readonly currencyCode: string;
+    constructor(data: CollectionData);
+    /**
+     * Check if collection is pending
+     */
+    isPending(): boolean;
+    /**
+     * Check if collection was successful
+     */
+    isSuccessful(): boolean;
+    /**
+     * Check if collection failed
+     */
+    isFailed(): boolean;
+    /**
+     * Get status color and label
+     */
+    getStatusInfo(): CollectionStatusInfo;
+    /**
+     * Get channel information
+     */
+    getChannelInfo(): ChannelInfo;
+    /**
+     * Get provider name from channel
+     */
+    getProviderName(): string;
+    /**
+     * Get service name from channel
+     */
+    getServiceName(): string;
+    /**
+     * Check if this is a mobile money collection
+     */
+    isMobileCollection(): boolean;
+    /**
+     * Check if this is a bank collection
+     */
+    isBankCollection(): boolean;
+    /**
+     * Create Collection instance from raw API data
+     */
+    static from(data: any): Collection | undefined;
+    static createMany(dataArray: any[]): Collection[];
+    /**
+     * Create Collection instance from JSON representation
+     */
+    static fromJson(json: CollectionJson): Collection | undefined;
+    /**
+     * Create multiple Collection instances from JSON array
+     */
+    static createManyFromJson(jsonArray: CollectionJson[]): Collection[];
+    /**
+     * Convert to JSON representation with proper typing
+     */
+    toJson(): CollectionJson;
+}

package/dist/modules/collection/collection.query-builder.d.ts

@@ -0,0 +1,18 @@
+import { QueryBuilder } from "@/lib/query";
+import { COLLECTION_STATUS, COLLECTION_CHANNEL, CollectionQueryParamsDTO } from "./collection.dtos";
+/**
+ * Specialized query builder for collection queries
+ */
+export declare class CollectionQueryBuilder extends QueryBuilder {
+    whereStatus(status: COLLECTION_STATUS): this;
+    whereChannel(channel: COLLECTION_CHANNEL): this;
+    wherePending(): this;
+    whereSuccessful(): this;
+    whereFailed(): this;
+    whereAmountBetween(min: number, max: number): this;
+    whereSender(msisdn: string): this;
+    whereAccount(accountNo: string): this;
+    whereReference(reference: string): this;
+    wherePartnerReference(partnerReference: string): this;
+    toCollectionQuery(): CollectionQueryParamsDTO;
+}

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

@@ -0,0 +1,38 @@
+import { BaseRepository, PaginationDTO } from "@/lib/api";
+import { collectionContract } from "./collection.api-contract";
+import { type CollectionQueryParamsDTO, AccountSummaryDTO } from "./collection.dtos";
+import { Collection } from "./collection.model";
+/**
+ * Repository class for managing collections through API interactions.
+ * Handles collection operations, filtering, and summary data retrieval.
+ */
+export declare class CollectionRepository extends BaseRepository<typeof collectionContract> {
+    constructor(options?: {
+        token?: string;
+        root?: string;
+    });
+    /**
+     * Get all collections with filtering and pagination
+     */
+    getCollections(query?: CollectionQueryParamsDTO): Promise<{
+        collections: Collection[];
+        pagination: PaginationDTO;
+    }>;
+    /**
+     * Get a specific collection by ID
+     */
+    getCollection(id: string): Promise<Collection>;
+    /**
+     * Get collections summary statistics
+     */
+    getSummary(): Promise<{
+        yesterday: number;
+        today: number;
+        thisMonth: number;
+        lastMonth: number;
+    }>;
+    /**
+     * Get account balance and summary information
+     */
+    getBalance(): Promise<AccountSummaryDTO>;
+}

package/dist/modules/collection/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./collection.api-contract";
+export * from "./collection.dtos";
+export * from "./collection.model";
+export * from "./collection.query-builder";
+export * from "./collection.repository";

package/dist/modules/payout/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./payout.api-contract";
+export * from "./payout.dtos";
+export * from "./payout.model";
+export * from "./payout.query-builder";
+export * from "./payout.repository";