@temboplus/tembo-dashboard 0.0.7 → 0.0.9

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

@@ -1,10 +1,16 @@
 import { BaseRepository, PaginationDTO, WalletSummaryDTO } from "@/lib/api";
 import { collectionContract } from "./collection.api-contract";
-import { type CollectionQueryParamsDTO } from "./collection.dtos";
 import { Collection } from "./collection.model";
+import { CollectionQueryBuilder } from "./collection.query-builder";
+import { CollectionQueryParams } from "./collection.query-params.model";
+/**
+ * Flexible query input type - supports the class, DTO, URL params, etc.
+ */
+export type CollectionQueryInput = CollectionQueryParams | Parameters<typeof CollectionQueryParams.from>[0];
 /**
  * Repository class for managing collections through API interactions.
  * Handles collection operations, filtering, and summary data retrieval.
+ * Supports flexible query input types including URL search parameters and typed DTOs.
  */
 export declare class CollectionRepository extends BaseRepository<typeof collectionContract> {
     constructor(options?: {
@@ -12,9 +18,78 @@ export declare class CollectionRepository extends BaseRepository<typeof collecti
         root?: string;
     });
     /**
-     * Get all collections with filtering and pagination
+     * Normalize query input to CollectionQueryParams class instance
+     * @param query - Any supported query input type
+     * @returns CollectionQueryParams instance
+     * @throws Error if validation fails
+     */
+    private normalizeQueryParams;
+    /**
+     * Get all collections with filtering and pagination.
+     * Supports flexible input types: typed DTO, URL search params, or string records.
+     *
+     * @param query - Query parameters in any supported format
+     * @returns Promise resolving to collections and pagination info
+     *
+     * @example
+     * ```typescript
+     * // From API route with URL search params
+     * const { searchParams } = new URL(req.url);
+     * const stringParams = Object.fromEntries(searchParams.entries());
+     * const result = await repo.getCollections(stringParams);
+     *
+     * // From client with typed params
+     * const typedParams: CollectionQueryParamsDTO = { page: 1, limit: 20, status: 'PAYMENT_ACCEPTED' };
+     * const result2 = await repo.getCollections(typedParams);
+     *
+     * // With URLSearchParams directly
+     * const urlParams = new URLSearchParams(window.location.search);
+     * const result3 = await repo.getCollections(urlParams);
+     * ```
+     */
+    getCollections(query?: CollectionQueryInput): Promise<{
+        collections: Collection[];
+        pagination: PaginationDTO;
+    }>;
+    /**
+     * Convenience method to get collections from URL search params directly.
+     * Useful in API routes where you have direct access to search params.
+     *
+     * @param searchParams - URLSearchParams from request
+     * @returns Promise resolving to collections and pagination info
+     *
+     * @example
+     * ```typescript
+     * // In API route
+     * export async function GET(req: Request) {
+     *   const { searchParams } = new URL(req.url);
+     *   const repo = new CollectionRepository({ token });
+     *   return repo.getCollectionsFromSearchParams(searchParams);
+     * }
+     * ```
+     */
+    getCollectionsFromSearchParams(searchParams: URLSearchParams): Promise<{
+        collections: Collection[];
+        pagination: PaginationDTO;
+    }>;
+    /**
+     * Convenience method to get collections from Next.js Request object.
+     * Extracts and processes search params automatically.
+     *
+     * @param req - Next.js Request object
+     * @returns Promise resolving to collections and pagination info
+     *
+     * @example
+     * ```typescript
+     * // In API route
+     * export async function GET(req: Request) {
+     *   const repo = new CollectionRepository({ token });
+     *   const result = await repo.getCollectionsFromRequest(req);
+     *   return NextResponse.json(result);
+     * }
+     * ```
      */
-    getCollections(query?: CollectionQueryParamsDTO): Promise<{
+    getCollectionsFromRequest(req: Request): Promise<{
         collections: Collection[];
         pagination: PaginationDTO;
     }>;
@@ -35,4 +110,40 @@ export declare class CollectionRepository extends BaseRepository<typeof collecti
      * Get account balance and summary information
      */
     getBalance(): Promise<WalletSummaryDTO>;
+    /**
+     * Build a query using the fluent query builder interface
+     * Returns a query builder instance for complex filtering scenarios.
+     *
+     * @returns CollectionQueryBuilder instance for method chaining
+     *
+     * @example
+     * ```typescript
+     * const collections = await repo.query()
+     *   .whereSuccessful()
+     *   .whereAmountBetween(100, 1000)
+     *   .whereDateBetween('2024-01-01', '2024-01-31')
+     *   .orderByDesc('amount')
+     *   .paginate(1, 50)
+     *   .execute(repo);
+     * ```
+     */
+    query(): CollectionQueryBuilderWithExecute;
+}
+/**
+ * Extended query builder that includes execute method for direct repository integration
+ */
+declare class CollectionQueryBuilderWithExecute extends CollectionQueryBuilder {
+    private builder;
+    private repository;
+    constructor(builder: CollectionQueryBuilder, repository: CollectionRepository);
+    /**
+     * Execute the query and return results
+     *
+     * @returns Promise resolving to collections and pagination info
+     */
+    execute(): Promise<{
+        collections: Collection[];
+        pagination: PaginationDTO;
+    }>;
 }
+export {};

package/package.json

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