@temboplus/tembo-dashboard 0.0.4 → 0.0.6

package/dist/lib/api/common-schemas.d.ts

@@ -21,7 +21,7 @@ declare const paginationSchema: z.ZodObject<{
     hasNext: boolean;
     hasPrev: boolean;
 }>;
-declare const accountSummarySchema: z.ZodObject<{
+declare const walletSummarySchema: z.ZodObject<{
     balance: z.ZodNumber;
     availableBalance: z.ZodNumber;
     accountNumber: z.ZodString;
@@ -92,7 +92,7 @@ export declare const CommonSchemas: {
         thisMonth: number;
         lastMonth: number;
     }>;
-    accountSummary: z.ZodObject<{
+    walletSummary: z.ZodObject<{
         balance: z.ZodNumber;
         availableBalance: z.ZodNumber;
         accountNumber: z.ZodString;
@@ -111,5 +111,5 @@ export declare const CommonSchemas: {
 };
 export type PaginationDTO = z.infer<typeof paginationSchema>;
 export type TransactionSummaryDTO = z.infer<typeof transactionSummarySchema>;
-export type WalletSummaryDTO = z.infer<typeof accountSummarySchema>;
+export type WalletSummaryDTO = z.infer<typeof walletSummarySchema>;
 export {};

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

@@ -8,7 +8,7 @@ export declare const collectionContract: {
         path: "/";
         responses: {
             200: z.ZodObject<{
-                data: z.ZodArray<z.ZodObject<{
+                results: z.ZodArray<z.ZodObject<{
                     id: z.ZodString;
                     status: z.ZodNativeEnum<typeof import("./collection.dtos").COLLECTION_STATUS>;
                     statusMessage: z.ZodString;
@@ -81,7 +81,7 @@ export declare const collectionContract: {
                 total: z.ZodNumber;
             }, "strip", z.ZodTypeAny, {
                 total: number;
-                data: {
+                results: {
                     status: import("./collection.dtos").COLLECTION_STATUS;
                     createdAt: string;
                     id: string;
@@ -107,7 +107,7 @@ export declare const collectionContract: {
                 }[];
             }, {
                 total: number;
-                data: {
+                results: {
                     status: import("./collection.dtos").COLLECTION_STATUS;
                     createdAt: string;
                     id: string;

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

@@ -10,22 +10,6 @@ export declare enum COLLECTION_CHANNEL {
     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;
@@ -149,6 +133,58 @@ export declare const CollectionDTOSchemas: {
         minAmount?: number | undefined;
         maxAmount?: number | undefined;
     }>;
+    collectionURLQueryParams: z.ZodObject<{
+        page: z.ZodOptional<z.ZodEffects<z.ZodString, number, string>>;
+        limit: z.ZodOptional<z.ZodEffects<z.ZodString, number, string>>;
+        sortBy: z.ZodDefault<z.ZodString>;
+        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.ZodEffects<z.ZodEffects<z.ZodString, string, string>, COLLECTION_CHANNEL, string>>;
+        status: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, COLLECTION_STATUS, string>>;
+        minAmount: z.ZodOptional<z.ZodEffects<z.ZodString, number, string>>;
+        maxAmount: z.ZodOptional<z.ZodEffects<z.ZodString, number, string>>;
+        search: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        sortBy: string;
+        sortOrder: "asc" | "desc";
+        status?: COLLECTION_STATUS | undefined;
+        startDate?: string | undefined;
+        endDate?: string | 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;
+        minAmount?: number | undefined;
+        maxAmount?: number | undefined;
+    }, {
+        status?: string | undefined;
+        startDate?: string | undefined;
+        endDate?: string | undefined;
+        page?: string | undefined;
+        limit?: string | undefined;
+        search?: string | undefined;
+        id?: string | undefined;
+        accountNo?: string | undefined;
+        msisdn?: string | undefined;
+        channel?: string | undefined;
+        reference?: string | undefined;
+        partnerReference?: string | undefined;
+        sortBy?: string | undefined;
+        sortOrder?: "asc" | "desc" | undefined;
+        minAmount?: string | undefined;
+        maxAmount?: string | undefined;
+    }>;
     pagination: z.ZodObject<{
         page: z.ZodNumber;
         limit: z.ZodNumber;
@@ -173,7 +209,7 @@ export declare const CollectionDTOSchemas: {
     }>;
     paymentStatus: z.ZodNativeEnum<typeof COLLECTION_STATUS>;
     paymentChannel: z.ZodNativeEnum<typeof COLLECTION_CHANNEL>;
-    accountSummary: z.ZodObject<{
+    walletSummary: z.ZodObject<{
         balance: z.ZodNumber;
         availableBalance: z.ZodNumber;
         accountNumber: z.ZodString;
@@ -192,4 +228,4 @@ export declare const CollectionDTOSchemas: {
 };
 export type CollectionDTO = z.infer<typeof CollectionDTOSchemas.collection>;
 export type CollectionQueryParamsDTO = z.infer<typeof CollectionDTOSchemas.collectionQueryParams>;
-export type AccountSummaryDTO = z.infer<typeof CollectionDTOSchemas.accountSummary>;
+export type CollectionURLQueryParamsDTO = z.infer<typeof CollectionDTOSchemas.collectionURLQueryParams>;

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

@@ -1,6 +1,6 @@
-import { BaseRepository, PaginationDTO } from "@/lib/api";
+import { BaseRepository, PaginationDTO, WalletSummaryDTO } from "@/lib/api";
 import { collectionContract } from "./collection.api-contract";
-import { type CollectionQueryParamsDTO, AccountSummaryDTO } from "./collection.dtos";
+import { type CollectionQueryParamsDTO } from "./collection.dtos";
 import { Collection } from "./collection.model";
 /**
  * Repository class for managing collections through API interactions.
@@ -34,5 +34,5 @@ export declare class CollectionRepository extends BaseRepository<typeof collecti
     /**
      * Get account balance and summary information
      */
-    getBalance(): Promise<AccountSummaryDTO>;
+    getBalance(): Promise<WalletSummaryDTO>;
 }

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

@@ -0,0 +1,91 @@
+import { CollectionQueryParamsDTO } from "./collection.dtos";
+/**
+ * Converts URL search parameters (string-based) to properly typed CollectionQueryParamsDTO.
+ *
+ * This function handles the conversion from URL search parameters (which are always strings)
+ * to the typed DTO used internally. It performs validation and type conversion for:
+ * - Numbers (page, limit, amounts)
+ * - Enums (status, channel)
+ * - Dates (startDate, endDate)
+ * - Optional string fields
+ *
+ * @param urlParams - Raw URL search parameters as key-value string pairs
+ * @returns Validated and typed CollectionQueryParamsDTO object
+ *
+ * @throws {ZodError} When URL parameters fail validation (invalid enum values, malformed numbers, etc.)
+ *
+ * @example
+ * ```typescript
+ * const urlParams = {
+ *   page: "1",
+ *   limit: "20",
+ *   status: "PAYMENT_ACCEPTED",
+ *   minAmount: "100.50"
+ * };
+ *
+ * const queryParams = urlParamsToQueryParams(urlParams);
+ * // Result: { page: 1, limit: 20, status: COLLECTION_STATUS.PAYMENT_ACCEPTED, minAmount: 100.5 }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Usage in API route
+ * export async function GET(req: NextRequest) {
+ *   const searchParams = Object.fromEntries(req.nextUrl.searchParams.entries());
+ *   const queryParams = urlParamsToQueryParams(searchParams);
+ *   // Now you have properly typed parameters
+ * }
+ * ```
+ */
+export declare function urlParamsToQueryParams(urlParams: Record<string, string>): CollectionQueryParamsDTO;
+/**
+ * Converts typed CollectionQueryParamsDTO to URL-safe string parameters.
+ *
+ * This function transforms the typed DTO back into string-based key-value pairs
+ * suitable for URL search parameters or form submission. It:
+ * - Filters out undefined and null values
+ * - Converts all values to strings
+ * - Preserves the original parameter names
+ *
+ * @param queryParams - Typed collection query parameters
+ * @returns Object with string values suitable for URLSearchParams or query string construction
+ *
+ * @example
+ * ```typescript
+ * const queryParams: CollectionQueryParamsDTO = {
+ *   page: 1,
+ *   limit: 20,
+ *   status: COLLECTION_STATUS.PAYMENT_ACCEPTED,
+ *   minAmount: 100.50,
+ *   search: "test query"
+ * };
+ *
+ * const urlParams = queryParamsToURLParams(queryParams);
+ * // Result: {
+ * //   page: "1",
+ * //   limit: "20",
+ * //   status: "PAYMENT_ACCEPTED",
+ * //   minAmount: "100.5",
+ * //   search: "test query"
+ * // }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Usage with URLSearchParams
+ * const queryParams = { page: 1, limit: 20, status: COLLECTION_STATUS.PAYMENT_ACCEPTED };
+ * const urlParams = queryParamsToURLParams(queryParams);
+ * const searchParams = new URLSearchParams(urlParams);
+ * const queryString = searchParams.toString();
+ * // Result: "page=1&limit=20&status=PAYMENT_ACCEPTED"
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Usage in client-side API calls
+ * const filters = { status: COLLECTION_STATUS.PENDING_ACK, minAmount: 50 };
+ * const urlParams = queryParamsToURLParams(filters);
+ * const response = await fetch(`/api/collections?${new URLSearchParams(urlParams)}`);
+ * ```
+ */
+export declare function queryParamsToURLParams(queryParams: CollectionQueryParamsDTO): Record<string, string>;

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

@@ -53,7 +53,7 @@ export declare const payoutContract: {
         path: "";
         responses: {
             200: z.ZodObject<{
-                data: z.ZodArray<z.ZodObject<{
+                results: z.ZodArray<z.ZodObject<{
                     id: z.ZodString;
                     statusCode: z.ZodString;
                     statusCodeText: z.ZodNativeEnum<typeof import("./payout.dtos").PAYOUT_STATUS>;
@@ -144,7 +144,7 @@ export declare const payoutContract: {
                 total: z.ZodNumber;
             }, "strip", z.ZodTypeAny, {
                 total: number;
-                data: {
+                results: {
                     statusCode: string;
                     createdAt: string;
                     id: string;
@@ -176,7 +176,7 @@ export declare const payoutContract: {
                 }[];
             }, {
                 total: number;
-                data: {
+                results: {
                     statusCode: string;
                     createdAt: string;
                     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temboplus/tembo-dashboard",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "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",