@temboplus/afloat 0.2.0-beta.2 → 0.2.0-beta.3

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

@@ -64,7 +64,12 @@ export declare class QueryBuilder {
      */
     countAs(expression: string, alias: string): this;
     /**
-     * @returns an objection-find query
+     * Build the query into an objection-find compatible object.
+     *
+     * Pagination (rangeStart/rangeEnd) is only included if both `page` and `limit`
+     * have been explicitly set via `.paginate()` or in the constructor options.
+     *
+     * @returns An objection-find query object
      */
     build(): Record<string, any>;
     /**

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

@@ -111,6 +111,35 @@ export declare class PayoutQuery extends QueryBuilder {
      * Get human-readable filter descriptions
      */
     getActiveFilters(): string[];
+    /**
+       * Build the query into an objection-find compatible object for payout queries.
+       *
+       * The output object contains:
+       * - Filters: Field conditions like `status:eq`, `createdAt:gte`, `payeeName:likeLower`
+       * - Sorting: `orderBy` and/or `orderByDesc` with comma-separated fields
+       * - Pagination: `rangeStart` and `rangeEnd` (only if `.paginate()` was called)
+       * - Relations: `eager` for included relations via `.with()` or `.includeDefaultRelations()`
+       *
+       * @example
+       * ```ts
+       * // Paginated query
+       * const paged = PayoutQuery.create()
+       *   .whereStatus(PayoutStatus.PAID)
+       *   .paginate(1, 20)
+       *   .build();
+       * // => { "status:eq": "PAID", rangeStart: 0, rangeEnd: 19 }
+       *
+       * // Unpaginated list (no rangeStart/rangeEnd)
+       * const all = PayoutQuery.create()
+       *   .whereApproved()
+       *   .orderByDesc("createdAt")
+       *   .build();
+       * // => { "approvalStatus:eq": "APPROVED", orderByDesc: "createdAt" }
+       * ```
+       *
+       * @returns An objection-find query object
+       */
+    build(): Record<string, any>;
     /**
      * Extract filter values from QueryBuilder options
      */

package/dist/modules/wallet/wallet.query.d.ts

@@ -88,6 +88,37 @@ export declare class WalletQuery extends QueryBuilder {
      * Get human-readable filter descriptions
      */
     getActiveFilters(): string[];
+    /**
+       * Build the query into an objection-find compatible object for wallet queries.
+       *
+       * The output object contains:
+       * - Filters: Field conditions like `id:eq`, `profileId:eq`, `accountName:likeLower`
+       * - Sorting: `orderBy` and/or `orderByDesc` with comma-separated fields
+       * - Pagination: `rangeStart` and `rangeEnd` (only if `.paginate()` was called)
+       *
+       * Since wallets are typically fetched as complete lists (not paginated),
+       * pagination is usually omitted.
+       *
+       * @example
+       * ```ts
+       * // Get all wallets for a profile (no pagination)
+       * const query = WalletQuery.create()
+       *   .whereProfileId("prof_123")
+       *   .whereCurrencyCode("TZS")
+       *   .build();
+       * // => { "profileId:eq": "prof_123", "currencyCode:eq": "TZS" }
+       *
+       * // Paginated wallet list (if needed)
+       * const paged = WalletQuery.create()
+       *   .whereChannel("MOBILE")
+       *   .paginate(1, 10)
+       *   .build();
+       * // => { "channel:eq": "MOBILE", rangeStart: 0, rangeEnd: 9 }
+       * ```
+       *
+       * @returns An objection-find query object
+       */
+    build(): Record<string, any>;
     /**
      * Extract filter values from QueryBuilder options
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temboplus/afloat",
-  "version": "0.2.0-beta.2",
+  "version": "0.2.0-beta.3",
   "description": "A foundational library for Temboplus-Afloat projects.",
   "main": "./dist/index.cjs.js",
   "module": "./dist/index.esm.js",