@temboplus/tembo-dashboard 0.0.1

package/dist/lib/query/query.types.d.ts

@@ -0,0 +1,36 @@
+export declare enum FilterOperator {
+    EQUALS = "eq",
+    NOT_EQUALS = "neq",
+    LESS_THAN = "lt",
+    LESS_THAN_OR_EQUAL = "lte",
+    GREATER_THAN = "gt",
+    GREATER_THAN_OR_EQUAL = "gte",
+    LIKE = "like",
+    LIKE_LOWER = "likeLower",
+    IS_NULL = "isNull",
+    IS_NOT_NULL = "isNotNull",
+    IN = "in"
+}
+export declare enum SortDirection {
+    ASC = "asc",
+    DESC = "desc"
+}
+export interface FilterCriteria {
+    field: string;
+    operator: FilterOperator;
+    value?: any;
+}
+export interface SortCriteria {
+    field: string;
+    direction: SortDirection;
+}
+export interface QueryOptions {
+    page?: number;
+    pageSize?: number;
+    filters?: FilterCriteria[];
+    sort?: SortCriteria[];
+    includes?: string[];
+    join?: string[];
+    groupBy?: string[];
+    count?: string;
+}

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

@@ -0,0 +1,52 @@
+import { z } from "zod";
+export declare const authContract: {
+    login: {
+        summary: "User login";
+        description: "Authenticate user with email and password";
+        method: "POST";
+        body: z.ZodObject<{
+            type: z.ZodDefault<z.ZodString>;
+            identity: z.ZodString;
+            password: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: string;
+            identity: string;
+            password: string;
+        }, {
+            identity: string;
+            password: string;
+            type?: string | undefined;
+        }>;
+        path: "/auth/login";
+        responses: {
+            201: z.ZodObject<{
+                token: z.ZodString;
+                identity: z.ZodString;
+                name: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                token: string;
+                identity: string;
+                name: string;
+            }, {
+                token: string;
+                identity: string;
+                name: string;
+            }>;
+            400: z.ZodObject<{
+                message: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                message?: string | undefined;
+            }, {
+                message?: string | undefined;
+            }>;
+            401: z.ZodObject<{
+                message: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                message?: string | undefined;
+            }, {
+                message?: string | undefined;
+            }>;
+        };
+    };
+};
+export type AuthContract = typeof authContract;

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

@@ -0,0 +1,31 @@
+import { z } from "zod";
+export declare const AuthDTOSchemas: {
+    user: z.ZodObject<{
+        token: z.ZodString;
+        identity: z.ZodString;
+        name: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        token: string;
+        identity: string;
+        name: string;
+    }, {
+        token: string;
+        identity: string;
+        name: string;
+    }>;
+    loginRequest: z.ZodObject<{
+        type: z.ZodDefault<z.ZodString>;
+        identity: z.ZodString;
+        password: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        identity: string;
+        password: string;
+    }, {
+        identity: string;
+        password: string;
+        type?: string | undefined;
+    }>;
+};
+export type UserDTO = z.infer<typeof AuthDTOSchemas.user>;
+export type LoginRequestDTO = z.infer<typeof AuthDTOSchemas.loginRequest>;

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

@@ -0,0 +1,17 @@
+import { BaseRepository } from "@/lib/api";
+import { authContract } from "./auth.api-contract";
+import { User, LoginCredentials } from "./user.model";
+/**
+ * Repository class for managing authentication through API interactions.
+ * Handles user login and authentication operations.
+ */
+export declare class AuthRepository extends BaseRepository<typeof authContract> {
+    constructor(options?: {
+        token?: string;
+        root?: string;
+    });
+    /**
+     * Authenticate user with email and password
+     */
+    login(credentials: LoginCredentials): Promise<User>;
+}

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

@@ -0,0 +1,4 @@
+export * from "./auth.repository";
+export * from "./user.model";
+export * from "./auth.dtos";
+export * from "./auth.api-contract";

package/dist/modules/auth/user.model.d.ts

@@ -0,0 +1,48 @@
+export interface UserData {
+    token: string;
+    identity: string;
+    name: string;
+}
+export interface UserJson {
+    token: string;
+    identity: string;
+    name: string;
+}
+export interface LoginCredentials {
+    type?: string;
+    identity: string;
+    password: string;
+}
+/**
+ * Represents an authenticated user
+ */
+export declare class User {
+    readonly token: string;
+    readonly identity: string;
+    readonly name: string;
+    constructor(data: UserData);
+    /**
+     * Check if user has a valid token
+     */
+    hasToken(): boolean;
+    /**
+     * Get user's display name
+     */
+    getDisplayName(): string;
+    /**
+     * Check if user identity is an email
+     */
+    isEmailIdentity(): boolean;
+    /**
+     * Create User instance from raw API data
+     */
+    static from(data: any): User | undefined;
+    /**
+     * Create User instance from JSON representation
+     */
+    static fromJson(json: UserJson): User | undefined;
+    /**
+     * Convert to JSON representation
+     */
+    toJson(): UserJson;
+}

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

@@ -0,0 +1,385 @@
+import { z } from "zod";
+export declare const collectionContract: {
+    getCollections: {
+        query: 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 import("./collection.dtos").COLLECTION_CHANNEL>>;
+            status: z.ZodOptional<z.ZodNativeEnum<typeof import("./collection.dtos").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?: import("./collection.dtos").COLLECTION_STATUS | undefined;
+            search?: string | undefined;
+            id?: string | undefined;
+            accountNo?: string | undefined;
+            msisdn?: string | undefined;
+            channel?: import("./collection.dtos").COLLECTION_CHANNEL | undefined;
+            reference?: string | undefined;
+            partnerReference?: string | undefined;
+            startDate?: string | undefined;
+            endDate?: string | undefined;
+            minAmount?: number | undefined;
+            maxAmount?: number | undefined;
+        }, {
+            status?: import("./collection.dtos").COLLECTION_STATUS | undefined;
+            page?: number | undefined;
+            limit?: number | undefined;
+            search?: string | undefined;
+            id?: string | undefined;
+            accountNo?: string | undefined;
+            msisdn?: string | undefined;
+            channel?: import("./collection.dtos").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;
+        }>;
+        summary: "List collections";
+        description: "Retrieve a paginated list of collections with optional filtering";
+        method: "GET";
+        path: "/";
+        responses: {
+            200: z.ZodObject<{
+                data: z.ZodArray<z.ZodObject<{
+                    id: z.ZodString;
+                    status: z.ZodNativeEnum<typeof import("./collection.dtos").COLLECTION_STATUS>;
+                    statusMessage: z.ZodString;
+                    accountNo: z.ZodString;
+                    walletId: z.ZodString;
+                    transactionDate: z.ZodString;
+                    narration: z.ZodString;
+                    msisdn: z.ZodString;
+                    channel: z.ZodNativeEnum<typeof import("./collection.dtos").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: import("./collection.dtos").COLLECTION_STATUS;
+                    id: string;
+                    statusMessage: string;
+                    accountNo: string;
+                    walletId: string;
+                    transactionDate: string;
+                    narration: string;
+                    msisdn: string;
+                    channel: import("./collection.dtos").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: import("./collection.dtos").COLLECTION_STATUS;
+                    id: string;
+                    statusMessage: string;
+                    accountNo: string;
+                    walletId: string;
+                    transactionDate: string;
+                    narration: string;
+                    msisdn: string;
+                    channel: import("./collection.dtos").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;
+                }>, "many">;
+                total: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                total: number;
+                data: {
+                    status: import("./collection.dtos").COLLECTION_STATUS;
+                    id: string;
+                    statusMessage: string;
+                    accountNo: string;
+                    walletId: string;
+                    transactionDate: string;
+                    narration: string;
+                    msisdn: string;
+                    channel: import("./collection.dtos").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;
+                }[];
+            }, {
+                total: number;
+                data: {
+                    status: import("./collection.dtos").COLLECTION_STATUS;
+                    id: string;
+                    statusMessage: string;
+                    accountNo: string;
+                    walletId: string;
+                    transactionDate: string;
+                    narration: string;
+                    msisdn: string;
+                    channel: import("./collection.dtos").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;
+                }[];
+            }>;
+            401: z.ZodObject<{
+                message: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                message?: string | undefined;
+            }, {
+                message?: string | undefined;
+            }>;
+            403: z.ZodObject<{
+                message: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                message?: string | undefined;
+            }, {
+                message?: string | undefined;
+            }>;
+        };
+    };
+    getCollection: {
+        pathParams: z.ZodObject<{
+            id: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+        }, {
+            id: string;
+        }>;
+        summary: "Get collection details";
+        description: "Retrieve detailed information about a specific collection";
+        method: "GET";
+        path: "/:id";
+        responses: {
+            200: z.ZodObject<{
+                id: z.ZodString;
+                status: z.ZodNativeEnum<typeof import("./collection.dtos").COLLECTION_STATUS>;
+                statusMessage: z.ZodString;
+                accountNo: z.ZodString;
+                walletId: z.ZodString;
+                transactionDate: z.ZodString;
+                narration: z.ZodString;
+                msisdn: z.ZodString;
+                channel: z.ZodNativeEnum<typeof import("./collection.dtos").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: import("./collection.dtos").COLLECTION_STATUS;
+                id: string;
+                statusMessage: string;
+                accountNo: string;
+                walletId: string;
+                transactionDate: string;
+                narration: string;
+                msisdn: string;
+                channel: import("./collection.dtos").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: import("./collection.dtos").COLLECTION_STATUS;
+                id: string;
+                statusMessage: string;
+                accountNo: string;
+                walletId: string;
+                transactionDate: string;
+                narration: string;
+                msisdn: string;
+                channel: import("./collection.dtos").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;
+            }>;
+            401: z.ZodObject<{
+                message: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                message?: string | undefined;
+            }, {
+                message?: string | undefined;
+            }>;
+            403: z.ZodObject<{
+                message: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                message?: string | undefined;
+            }, {
+                message?: string | undefined;
+            }>;
+            404: z.ZodObject<{
+                message: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                message?: string | undefined;
+            }, {
+                message?: string | undefined;
+            }>;
+        };
+    };
+    getSummary: {
+        summary: "Get collections summary";
+        description: "Retrieve collection summary statistics for different time periods";
+        method: "GET";
+        path: "/summary";
+        responses: {
+            200: z.ZodObject<{
+                yesterday: z.ZodNumber;
+                today: z.ZodNumber;
+                thisMonth: z.ZodNumber;
+                lastMonth: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                yesterday: number;
+                today: number;
+                thisMonth: number;
+                lastMonth: number;
+            }, {
+                yesterday: number;
+                today: number;
+                thisMonth: number;
+                lastMonth: number;
+            }>;
+            401: z.ZodObject<{
+                message: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                message?: string | undefined;
+            }, {
+                message?: string | undefined;
+            }>;
+            403: z.ZodObject<{
+                message: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                message?: string | undefined;
+            }, {
+                message?: string | undefined;
+            }>;
+        };
+    };
+    getBalance: {
+        summary: "Get account balance";
+        description: "Retrieve current account balance and summary information";
+        method: "GET";
+        path: "/balance";
+        responses: {
+            200: 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;
+            }>;
+            401: z.ZodObject<{
+                message: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                message?: string | undefined;
+            }, {
+                message?: string | undefined;
+            }>;
+            403: z.ZodObject<{
+                message: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                message?: string | undefined;
+            }, {
+                message?: string | undefined;
+            }>;
+        };
+    };
+};
+export type CollectionContract = typeof collectionContract;