@temboplus/afloat 0.2.0-beta.1 → 0.2.0-beta.11

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

@@ -1,6 +1,17 @@
 import { QueryBuilder } from "@/lib/query/index.js";
 import { PayoutStatus, PayoutApprovalStatus, PayoutFilters } from "./payout.dtos.js";
 import { Amount } from "@temboplus/frontend-core";
+/**
+ * Represents an active filter with its label and value
+ */
+export interface ActiveFilter {
+    label: string;
+    value: string;
+}
+export interface DescribeFiltersOptions {
+    /** Custom date formatter function */
+    formatDate?: (date: string) => string;
+}
 /**
  * Payout-specific query builder that extends the base QueryBuilder
  * and handles all possible input conversions (DTOs, URL params, etc.)
@@ -108,9 +119,49 @@ export declare class PayoutQuery extends QueryBuilder {
      */
     hasFilters(): boolean;
     /**
-     * Get human-readable filter descriptions
-     */
-    getActiveFilters(): string[];
+     * Get active filters as structured objects for programmatic use
+     * @param options - Formatting options
+     * @returns Array of ActiveFilter objects with label and value
+     */
+    describeFilters(options?: DescribeFiltersOptions): ActiveFilter[];
+    /**
+     * Get active filters as human-readable strings for display
+     * @returns Array of formatted filter strings
+     */
+    describeFiltersAsText(): string[];
+    /**
+     * Format sort field for display
+     */
+    private formatSortField;
+    /**
+     * 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/profile/profile.model.d.ts

@@ -11,12 +11,12 @@ export declare const ProfileJSONSchema: z.ZodObject<{
     accountNo: z.ZodString;
     email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     autoApprove: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     id: string;
     displayName: string;
     accountNo: string;
-    version: string;
+    _version: string;
     firstName?: string | null | undefined;
     lastName?: string | null | undefined;
     phone?: string | null | undefined;
@@ -31,7 +31,7 @@ export declare const ProfileJSONSchema: z.ZodObject<{
     phone?: string | null | undefined;
     email?: string | null | undefined;
     autoApprove?: boolean | null | undefined;
-    version?: string | undefined;
+    _version?: string | undefined;
 }>;
 /**
  * Infer the ProfileJSON type from the schema

package/dist/modules/team-member/role.model.d.ts

@@ -10,12 +10,12 @@ export declare const RoleJSONSchema: z.ZodObject<{
     access: z.ZodArray<z.ZodString, "many">;
     createdAt: z.ZodString;
     updatedAt: z.ZodString;
-    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     name: string;
     createdAt: string;
     id: string;
-    version: string;
+    _version: string;
     updatedAt: string;
     access: string[];
     description?: string | undefined;
@@ -25,7 +25,7 @@ export declare const RoleJSONSchema: z.ZodObject<{
     id: string;
     updatedAt: string;
     access: string[];
-    version?: string | undefined;
+    _version?: string | undefined;
     description?: string | undefined;
 }>;
 /**

package/dist/modules/team-member/team-member.model.d.ts

@@ -35,12 +35,12 @@ export declare const TeamMemberJSONSchema: z.ZodObject<{
         access: z.ZodArray<z.ZodString, "many">;
         createdAt: z.ZodString;
         updatedAt: z.ZodString;
-        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
         name: string;
         createdAt: string;
         id: string;
-        version: string;
+        _version: string;
         updatedAt: string;
         access: string[];
         description?: string | undefined;
@@ -50,18 +50,18 @@ export declare const TeamMemberJSONSchema: z.ZodObject<{
         id: string;
         updatedAt: string;
         access: string[];
-        version?: string | undefined;
+        _version?: string | undefined;
         description?: string | undefined;
     }>>;
     createdAt: z.ZodString;
     updatedAt: z.ZodString;
-    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     type: string;
     name: string;
     createdAt: string;
     id: string;
-    version: string;
+    _version: string;
     profileId: string;
     identity: string;
     roleId: string;
@@ -73,7 +73,7 @@ export declare const TeamMemberJSONSchema: z.ZodObject<{
         name: string;
         createdAt: string;
         id: string;
-        version: string;
+        _version: string;
         updatedAt: string;
         access: string[];
         description?: string | undefined;
@@ -90,14 +90,14 @@ export declare const TeamMemberJSONSchema: z.ZodObject<{
     isArchived: boolean;
     resetPassword: boolean;
     updatedAt: string;
-    version?: string | undefined;
+    _version?: string | undefined;
     role?: {
         name: string;
         createdAt: string;
         id: string;
         updatedAt: string;
         access: string[];
-        version?: string | undefined;
+        _version?: string | undefined;
         description?: string | undefined;
     } | undefined;
 }>;

package/dist/modules/wallet/narration.model.d.ts

@@ -17,13 +17,13 @@ export declare const LEGACY_MOBILE_NARR_PREFIX: string;
  */
 export declare const NarrationJSONSchema: z.ZodObject<{
     text: z.ZodString;
-    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
-    version: string;
+    _version: string;
     text: string;
 }, {
     text: string;
-    version?: string | undefined;
+    _version?: string | undefined;
 }>;
 export type NarrationJSON = z.infer<typeof NarrationJSONSchema>;
 /**
@@ -199,8 +199,8 @@ export declare class Narration {
      */
     static is(obj: unknown): obj is Narration;
     /**
-   * Serializes the Narration instance to a JSON-compatible object
-   */
+     * Serializes the Narration instance to a JSON-compatible object
+     */
     toJSON(): NarrationJSON;
     /**
      * Serializes the Narration instance to a JSON string

package/dist/modules/wallet/statement-entry.model.d.ts

@@ -10,13 +10,13 @@ export declare const WalletStatementEntryJSONSchema: z.ZodObject<{
     tranRefNo: z.ZodString;
     narration: z.ZodObject<{
         text: z.ZodString;
-        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
-        version: string;
+        _version: string;
         text: string;
     }, {
         text: string;
-        version?: string | undefined;
+        _version?: string | undefined;
     }>;
     txnDate: z.ZodString;
     valueDate: z.ZodString;
@@ -24,9 +24,9 @@ export declare const WalletStatementEntryJSONSchema: z.ZodObject<{
         value: z.ZodNumber;
         text: z.ZodString;
         currencyCode: z.ZodString;
-        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
-        version: string;
+        _version: string;
         value: number;
         text: string;
         currencyCode: string;
@@ -34,15 +34,15 @@ export declare const WalletStatementEntryJSONSchema: z.ZodObject<{
         value: number;
         text: string;
         currencyCode: string;
-        version?: string | undefined;
+        _version?: string | undefined;
     }>;
     amountDebited: z.ZodObject<{
         value: z.ZodNumber;
         text: z.ZodString;
         currencyCode: z.ZodString;
-        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
-        version: string;
+        _version: string;
         value: number;
         text: string;
         currencyCode: string;
@@ -50,15 +50,15 @@ export declare const WalletStatementEntryJSONSchema: z.ZodObject<{
         value: number;
         text: string;
         currencyCode: string;
-        version?: string | undefined;
+        _version?: string | undefined;
     }>;
     balance: z.ZodObject<{
         value: z.ZodNumber;
         text: z.ZodString;
         currencyCode: z.ZodString;
-        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
-        version: string;
+        _version: string;
         value: number;
         text: string;
         currencyCode: string;
@@ -66,35 +66,35 @@ export declare const WalletStatementEntryJSONSchema: z.ZodObject<{
         value: number;
         text: string;
         currencyCode: string;
-        version?: string | undefined;
+        _version?: string | undefined;
     }>;
     currencyCode: z.ZodString;
-    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
-    version: string;
+    _version: string;
     currencyCode: string;
     debitOrCredit: string;
     tranRefNo: string;
     narration: {
-        version: string;
+        _version: string;
         text: string;
     };
     txnDate: string;
     valueDate: string;
     amountCredited: {
-        version: string;
+        _version: string;
         value: number;
         text: string;
         currencyCode: string;
     };
     amountDebited: {
-        version: string;
+        _version: string;
         value: number;
         text: string;
         currencyCode: string;
     };
     balance: {
-        version: string;
+        _version: string;
         value: number;
         text: string;
         currencyCode: string;
@@ -106,7 +106,7 @@ export declare const WalletStatementEntryJSONSchema: z.ZodObject<{
     tranRefNo: string;
     narration: {
         text: string;
-        version?: string | undefined;
+        _version?: string | undefined;
     };
     txnDate: string;
     valueDate: string;
@@ -114,22 +114,22 @@ export declare const WalletStatementEntryJSONSchema: z.ZodObject<{
         value: number;
         text: string;
         currencyCode: string;
-        version?: string | undefined;
+        _version?: string | undefined;
     };
     amountDebited: {
         value: number;
         text: string;
         currencyCode: string;
-        version?: string | undefined;
+        _version?: string | undefined;
     };
     balance: {
         value: number;
         text: string;
         currencyCode: string;
-        version?: string | undefined;
+        _version?: string | undefined;
     };
     accountNo?: string | undefined;
-    version?: string | undefined;
+    _version?: string | undefined;
 }>;
 export type WalletStatementEntryJSON = z.infer<typeof WalletStatementEntryJSONSchema>;
 /**

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

@@ -14,12 +14,12 @@ export declare const WalletJSONSchema: z.ZodObject<{
     currencyCode: z.ZodString;
     createdAt: z.ZodString;
     updatedAt: z.ZodString;
-    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     createdAt: string;
     id: string;
     accountNo: string;
-    version: string;
+    _version: string;
     profileId: string;
     updatedAt: string;
     channel: string;
@@ -36,7 +36,7 @@ export declare const WalletJSONSchema: z.ZodObject<{
     countryCode: string;
     currencyCode: string;
     accountName: string;
-    version?: string | undefined;
+    _version?: string | undefined;
 }>;
 export type WalletJSON = z.infer<typeof WalletJSONSchema>;
 /**

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/dist/modules/wallet/wallet.repository.d.ts

@@ -24,8 +24,8 @@ export type WalletQueryInput = WalletQuery | WalletQueryDTO | Record<string, str
  * const repo = new WalletRepository({ token: userToken });
  * const balance = await repo.getBalance({ wallet });
  *
- * // Service locator usage
- * const repo = new WalletRepository();
+ * // Reuse the same construction shape for authenticated calls
+ * const repo = new WalletRepository({ token: userToken });
  * const wallets = await repo.getWallets();
  * ```
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temboplus/afloat",
-  "version": "0.2.0-beta.1",
+  "version": "0.2.0-beta.11",
   "description": "A foundational library for Temboplus-Afloat projects.",
   "main": "./dist/index.cjs.js",
   "module": "./dist/index.esm.js",
@@ -40,8 +40,7 @@
     "@ts-rest/core": "^3.52.1",
     "tslib": "^2.8.1",
     "uuid": "^11.1.0",
-    "zod": "^3.24.2",
-    "zustand": "^5.0.9"
+    "zod": "^3.24.2"
   },
   "devDependencies": {
     "@rollup/plugin-alias": "^6.0.0",
@@ -58,6 +57,6 @@
     "typescript": "^5.9.3"
   },
   "dependencies": {
-    "@temboplus/frontend-core": "^0.3.0-beta.1"
+    "@temboplus/frontend-core": "^1.0.1-beta.3"
   }
 }