@temboplus/tembo-dashboard 0.0.5 → 0.0.6

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

@@ -133,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;
@@ -176,3 +228,4 @@ export declare const CollectionDTOSchemas: {
 };
 export type CollectionDTO = z.infer<typeof CollectionDTOSchemas.collection>;
 export type CollectionQueryParamsDTO = z.infer<typeof CollectionDTOSchemas.collectionQueryParams>;
+export type CollectionURLQueryParamsDTO = z.infer<typeof CollectionDTOSchemas.collectionURLQueryParams>;

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/package.json

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