@temboplus/afloat 0.1.77-beta.8 → 0.1.77

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

@@ -27,7 +27,11 @@ export declare class QueryBuilder {
     whereLessThan(field: string, value: any): this;
     whereLessThanOrEqual(field: string, value: any): this;
     whereBetween(field: string, min: any, max: any): this;
-    whereDateBetween(startDate?: string | null, endDate?: string | null): this;
+    /**
+     * Filter by date range with support for Date objects, strings, and null
+     * Internally converts to createdAt:gte and createdAt:lte filters
+     */
+    whereDateBetween(startDate?: string | Date | null, endDate?: string | Date | null): this;
     addSort(criteria: SortCriteria): this;
     orderBy(field: string, direction?: SortDirection): this;
     orderByAsc(field: string): this;

package/dist/modules/auth/auth.contract.d.ts

@@ -55,6 +55,7 @@ export declare const authContract: {
             }, "strip", z.ZodTypeAny, {
                 resetPassword: boolean;
                 access: string[];
+                token: string;
                 profile: {
                     id: string;
                     displayName: string;
@@ -65,10 +66,10 @@ export declare const authContract: {
                     email?: string | null | undefined;
                     autoApprove?: boolean | null | undefined;
                 };
-                token: string;
             }, {
                 resetPassword: boolean;
                 access: string[];
+                token: string;
                 profile: {
                     id: string;
                     displayName: string;
@@ -79,7 +80,6 @@ export declare const authContract: {
                     email?: string | null | undefined;
                     autoApprove?: boolean | null | undefined;
                 };
-                token: string;
             }>;
             400: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
         };

package/dist/modules/auth/company-membership.model.d.ts

@@ -1,9 +1,117 @@
+import z from "zod";
 import { Profile } from "../profile/profile.model.js";
 import { Role } from "../team-member/role.model.js";
-export interface CompanyMembershipData {
+/**
+ * Zod schema for CompanyMembership JSON serialization
+ */
+export declare const CompanyMembershipJSONSchema: z.ZodObject<{
+    companyProfile: z.ZodObject<{
+        id: z.ZodString;
+        firstName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        lastName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        displayName: z.ZodString;
+        phone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        accountNo: z.ZodString;
+        email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        autoApprove: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        displayName: string;
+        accountNo: string;
+        version: string;
+        firstName?: string | null | undefined;
+        lastName?: string | null | undefined;
+        phone?: string | null | undefined;
+        email?: string | null | undefined;
+        autoApprove?: boolean | null | undefined;
+    }, {
+        id: string;
+        displayName: string;
+        accountNo: string;
+        firstName?: string | null | undefined;
+        lastName?: string | null | undefined;
+        phone?: string | null | undefined;
+        email?: string | null | undefined;
+        autoApprove?: boolean | null | undefined;
+        version?: string | undefined;
+    }>;
+    role: z.ZodOptional<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        access: z.ZodArray<z.ZodString, "many">;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+        version: string;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+        description?: string | undefined;
+    }, {
+        name: string;
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+        version?: string | undefined;
+        description?: string | undefined;
+    }>>;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    version: string;
+    companyProfile: {
+        id: string;
+        displayName: string;
+        accountNo: string;
+        version: string;
+        firstName?: string | null | undefined;
+        lastName?: string | null | undefined;
+        phone?: string | null | undefined;
+        email?: string | null | undefined;
+        autoApprove?: boolean | null | undefined;
+    };
+    role?: {
+        name: string;
+        id: string;
+        version: string;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+        description?: string | undefined;
+    } | undefined;
+}, {
+    companyProfile: {
+        id: string;
+        displayName: string;
+        accountNo: string;
+        firstName?: string | null | undefined;
+        lastName?: string | null | undefined;
+        phone?: string | null | undefined;
+        email?: string | null | undefined;
+        autoApprove?: boolean | null | undefined;
+        version?: string | undefined;
+    };
+    version?: string | undefined;
+    role?: {
+        name: string;
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+        version?: string | undefined;
+        description?: string | undefined;
+    } | undefined;
+}>;
+export type CompanyMembershipJSON = z.infer<typeof CompanyMembershipJSONSchema>;
+export type CompanyMembershipData = {
     companyProfile: Profile;
     role?: Role;
-}
+};
 /**
  * Represents a user's membership within a company.
  *
@@ -45,14 +153,19 @@ export declare class CompanyMembership {
      */
     get role(): Role | undefined;
     /**
-     * Converts the membership to a plain object.
+    * Serializes the CompanyMembership instance to a JSON-compatible object
+    */
+    toJSON(): CompanyMembershipJSON;
+    /**
+     * Serializes the CompanyMembership instance to a JSON string
      */
-    toObject(): {
-        companyProfile: ReturnType<Profile['toObject']>;
-        role?: ReturnType<Role['toJSON']>;
-    };
+    toJSONString(): string;
+    /**
+     * Creates a CompanyMembership instance from a JSON-compatible object or string
+     */
+    static fromJSON(json: CompanyMembershipJSON | string): CompanyMembership | undefined;
     /**
-     * Converts the membership to a JSON string.
+     * Type guard using Zod schema validation
      */
-    toJson(): string;
+    static isCompanyMembershipJSON(obj: unknown): obj is CompanyMembershipJSON;
 }

package/dist/modules/auth/user.model.d.ts

@@ -3,12 +3,200 @@ import { Profile } from "../profile/profile.model.js";
 import { LogIn } from "../login/login.model.js";
 import { CompanyMembership } from "./company-membership.model.js";
 import { Role } from "../team-member/role.model.js";
-export interface UserData {
+import z from "zod";
+/**
+ * Zod schema for User JSON serialization
+ * Composes the schemas from nested objects
+ */
+export declare const UserJSONSchema: z.ZodObject<{
+    logIn: z.ZodObject<{
+        id: z.ZodString;
+        profileId: z.ZodString;
+        name: z.ZodString;
+        identity: z.ZodString;
+        type: z.ZodString;
+        roleId: z.ZodString;
+        isActive: z.ZodBoolean;
+        isArchived: z.ZodBoolean;
+        resetPassword: z.ZodBoolean;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        access: z.ZodArray<z.ZodString, "many">;
+        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        name: string;
+        id: string;
+        version: string;
+        profileId: string;
+        identity: string;
+        roleId: string;
+        isActive: boolean;
+        isArchived: boolean;
+        resetPassword: boolean;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+    }, {
+        type: string;
+        name: string;
+        id: string;
+        profileId: string;
+        identity: string;
+        roleId: string;
+        isActive: boolean;
+        isArchived: boolean;
+        resetPassword: boolean;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+        version?: string | undefined;
+    }>;
+    companyProfile: z.ZodObject<{
+        id: z.ZodString;
+        firstName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        lastName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        displayName: z.ZodString;
+        phone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        accountNo: z.ZodString;
+        email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        autoApprove: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        displayName: string;
+        accountNo: string;
+        version: string;
+        firstName?: string | null | undefined;
+        lastName?: string | null | undefined;
+        phone?: string | null | undefined;
+        email?: string | null | undefined;
+        autoApprove?: boolean | null | undefined;
+    }, {
+        id: string;
+        displayName: string;
+        accountNo: string;
+        firstName?: string | null | undefined;
+        lastName?: string | null | undefined;
+        phone?: string | null | undefined;
+        email?: string | null | undefined;
+        autoApprove?: boolean | null | undefined;
+        version?: string | undefined;
+    }>;
+    role: z.ZodOptional<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        access: z.ZodArray<z.ZodString, "many">;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+        version: string;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+        description?: string | undefined;
+    }, {
+        name: string;
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+        version?: string | undefined;
+        description?: string | undefined;
+    }>>;
+    token: z.ZodString;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    version: string;
+    companyProfile: {
+        id: string;
+        displayName: string;
+        accountNo: string;
+        version: string;
+        firstName?: string | null | undefined;
+        lastName?: string | null | undefined;
+        phone?: string | null | undefined;
+        email?: string | null | undefined;
+        autoApprove?: boolean | null | undefined;
+    };
+    logIn: {
+        type: string;
+        name: string;
+        id: string;
+        version: string;
+        profileId: string;
+        identity: string;
+        roleId: string;
+        isActive: boolean;
+        isArchived: boolean;
+        resetPassword: boolean;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+    };
+    token: string;
+    role?: {
+        name: string;
+        id: string;
+        version: string;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+        description?: string | undefined;
+    } | undefined;
+}, {
+    companyProfile: {
+        id: string;
+        displayName: string;
+        accountNo: string;
+        firstName?: string | null | undefined;
+        lastName?: string | null | undefined;
+        phone?: string | null | undefined;
+        email?: string | null | undefined;
+        autoApprove?: boolean | null | undefined;
+        version?: string | undefined;
+    };
+    logIn: {
+        type: string;
+        name: string;
+        id: string;
+        profileId: string;
+        identity: string;
+        roleId: string;
+        isActive: boolean;
+        isArchived: boolean;
+        resetPassword: boolean;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+        version?: string | undefined;
+    };
+    token: string;
+    version?: string | undefined;
+    role?: {
+        name: string;
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+        version?: string | undefined;
+        description?: string | undefined;
+    } | undefined;
+}>;
+/**
+ * Infer the UserJSON type from the schema
+ */
+export type UserJSON = z.infer<typeof UserJSONSchema>;
+export type UserData = {
     logIn: LogIn;
     companyProfile: Profile;
     role?: Role;
     token: string;
-}
+};
 /**
  * Represents the currently authenticated user session.
  *
@@ -45,13 +233,6 @@ export declare class User {
      * ```
      */
     static from(data: UserData): User | undefined;
-    /**
-     * Creates a User instance from a JSON string.
-     *
-     * @param jsonString - JSON string containing user data
-     * @returns A new User instance, or undefined if parsing failed
-     */
-    static fromJson(jsonString: string): User | undefined;
     /**
      * Gets the user's login data.
      */
@@ -126,15 +307,57 @@ export declare class User {
      */
     canViewRoles(): boolean;
     /**
-     * Converts the User instance to a plain object.
+   * Serializes the User instance to a JSON-compatible object
+   *
+   * This method creates a complete snapshot of the user session including
+   * all nested objects (LogIn, Profile, Role). All data can be reconstructed
+   * from this JSON representation without needing backend calls.
+   *
+   * @returns {UserJSON} A plain object containing all necessary User data
+   *
+   * @example
+   * ```typescript
+   * const user = User.from({ ... });
+   * const json = user.toJSON();
+   * // Store in localStorage
+   * localStorage.setItem('currentUser', JSON.stringify(json));
+   * ```
+   */
+    toJSON(): UserJSON;
+    /**
+     * Serializes the User instance to a JSON string
      *
-     * @returns A plain object representation suitable for serialization
+     * @returns {string} JSON string representation of the User
      */
-    toObject(): Record<string, any>;
+    toJSONString(): string;
     /**
-     * Converts the User instance to a JSON string.
+     * Creates a User instance from a JSON-compatible object or string
+     *
+     * This static method reconstructs a complete User instance from data that was
+     * previously serialized using toJSON(). It validates the input data and
+     * ensures all nested objects (LogIn, Profile, Role) are properly reconstructed.
+     *
+     * @param {UserJSON | string} json - Either a UserJSON object or a JSON string
+     * @returns {User | undefined} A User instance if valid, undefined otherwise
      *
-     * @returns A JSON string representation
+     * @example
+     * ```typescript
+     * // From localStorage
+     * const stored = localStorage.getItem('currentUser');
+     * const user = User.fromJSON(stored!);
+     *
+     * // From object
+     * const userJson = {
+     *   logIn: { id: "...", ... },
+     *   companyProfile: { id: "...", ... },
+     *   token: "..."
+     * };
+     * const user = User.fromJSON(userJson);
+     * ```
+     */
+    static fromJSON(json: UserJSON | string): User | undefined;
+    /**
+     * Type guard using Zod schema validation
      */
-    toJson(): string;
+    static isUserJSON(obj: unknown): obj is UserJSON;
 }

package/dist/modules/contact/contact-info.model.d.ts

@@ -2,6 +2,91 @@ import { ContactType, ContactDTO } from "@/modules/contact/contact.dtos.js";
 import { PayoutDTO } from "@/modules/payout/payout.dtos.js";
 import { Bank, ISO2CountryCode, PhoneNumber } from "@temboplus/frontend-core";
 import type { BankSwiftCode, MNOId } from "@temboplus/frontend-core";
+import { z } from "zod";
+export declare const MobileContactInfoJSONSchema: z.ZodObject<{
+    type: z.ZodLiteral<"Mobile">;
+    name: z.ZodString;
+    phoneNumber: z.ZodString;
+    mnoId: z.ZodString;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    type: "Mobile";
+    name: string;
+    version: string;
+    phoneNumber: string;
+    mnoId: string;
+}, {
+    type: "Mobile";
+    name: string;
+    phoneNumber: string;
+    mnoId: string;
+    version?: string | undefined;
+}>;
+export declare const BankContactInfoJSONSchema: z.ZodObject<{
+    type: z.ZodLiteral<"Bank">;
+    accName: z.ZodString;
+    swiftCode: z.ZodString;
+    countryCode: z.ZodString;
+    accNo: z.ZodString;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    type: "Bank";
+    version: string;
+    countryCode: string;
+    accName: string;
+    swiftCode: string;
+    accNo: string;
+}, {
+    type: "Bank";
+    countryCode: string;
+    accName: string;
+    swiftCode: string;
+    accNo: string;
+    version?: string | undefined;
+}>;
+export declare const ContactInfoJSONSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"Mobile">;
+    name: z.ZodString;
+    phoneNumber: z.ZodString;
+    mnoId: z.ZodString;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    type: "Mobile";
+    name: string;
+    version: string;
+    phoneNumber: string;
+    mnoId: string;
+}, {
+    type: "Mobile";
+    name: string;
+    phoneNumber: string;
+    mnoId: string;
+    version?: string | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"Bank">;
+    accName: z.ZodString;
+    swiftCode: z.ZodString;
+    countryCode: z.ZodString;
+    accNo: z.ZodString;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    type: "Bank";
+    version: string;
+    countryCode: string;
+    accName: string;
+    swiftCode: string;
+    accNo: string;
+}, {
+    type: "Bank";
+    countryCode: string;
+    accName: string;
+    swiftCode: string;
+    accNo: string;
+    version?: string | undefined;
+}>]>;
+export type MobileContactInfoJSON = z.infer<typeof MobileContactInfoJSONSchema>;
+export type BankContactInfoJSON = z.infer<typeof BankContactInfoJSONSchema>;
+export type ContactInfoJSON = z.infer<typeof ContactInfoJSONSchema>;
 /**
  * Abstract base class that provides a common interface for different types of contact information.
  * This class defines the structure and validation requirements for both mobile and bank contacts.
@@ -116,25 +201,16 @@ declare abstract class BaseContactInfo {
      */
     abstract validate(): boolean;
     /**
-     * Converts the contact info to a plain JavaScript object for serialization.
-     *
-     * @abstract
-     * @returns {Record<string, unknown>} Plain object representation
-     */
-    abstract toObject(): Record<string, unknown>;
+    * Serializes the ContactInfo instance to a JSON-compatible object
+    */
+    abstract toJSON(): ContactInfoJSON;
     /**
-     * Serializes the contact info to a JSON string.
-     *
-     * @returns {string} JSON string representation
-     *
-     * @example
-     * ```typescript
-     * const contact = MobileContactInfo.from({ name: "John", phoneNumber });
-     * const jsonString = contact.toJSON();
-     * // Store or transmit jsonString
-     * ```
-     */
-    toJSON(): string;
+     * Converts the ContactInfo instance to a JSON string.
+    */
+    toJSONString(): string;
+    get isMobile(): boolean;
+    get isBank(): boolean;
+    get displayName(): string;
 }
 /**
  * Implementation of BaseContactInfo for mobile phone contacts.
@@ -264,20 +340,6 @@ export declare class MobileContactInfo extends BaseContactInfo {
      * ```
      */
     static fromPayoutDTO(info: PayoutDTO): MobileContactInfo | undefined;
-    /**
-     * Creates a MobileContactInfo instance from a JSON string.
-     *
-     * @static
-     * @param {string} jsonString - JSON string containing mobile contact data
-     * @returns {MobileContactInfo | undefined} New instance if successful, undefined if parsing fails
-     *
-     * @example
-     * ```typescript
-     * const jsonString = '{"name":"John Doe","phoneNumber":"+255712345678","mnoId":"VODACOM"}';
-     * const contact = MobileContactInfo.fromJSON(jsonString);
-     * ```
-     */
-    static fromJSON(jsonString: string): MobileContactInfo | undefined;
     /**
      * Type guard to validate if an unknown object is a valid MobileContactInfo instance.
      *
@@ -309,13 +371,6 @@ export declare class MobileContactInfo extends BaseContactInfo {
         errors: string[];
         warnings: string[];
     };
-    /**
-     * Converts the mobile contact info to a plain object for serialization.
-     *
-     * @override
-     * @returns {Record<string, unknown>} Plain object representation
-     */
-    toObject(): Record<string, unknown>;
     get accountName(): string;
     get accountNumber(): string;
     get accountNameLabel(): string;
@@ -323,6 +378,10 @@ export declare class MobileContactInfo extends BaseContactInfo {
     get channelLabel(): string;
     get channelId(): MNOId;
     get channelName(): string;
+    toJSON(): MobileContactInfoJSON;
+    static fromJSON(json: MobileContactInfoJSON | string): MobileContactInfo | undefined;
+    static fromJSONString(jsonString: string): MobileContactInfo | undefined;
+    static isMobileContactInfoJSON(obj: unknown): obj is MobileContactInfoJSON;
 }
 /**
  * Implementation of BaseContactInfo for bank account contacts.
@@ -399,20 +458,6 @@ export declare class BankContactInfo extends BaseContactInfo {
      * @returns {BankContactInfo | undefined} New instance if successful, undefined if parsing fails
      */
     static fromPayoutDTO(info: PayoutDTO): BankContactInfo | undefined;
-    /**
-     * Creates a BankContactInfo instance from a JSON string.
-     *
-     * @static
-     * @param {string} jsonString - JSON string containing bank contact data
-     * @returns {BankContactInfo | undefined} New instance if successful, undefined if parsing fails
-     *
-     * @example
-     * ```typescript
-     * const jsonString = '{"accName":"John Doe","swiftCode":"CORUTZTZ","accNo":"0150123456789"}';
-     * const contact = BankContactInfo.fromJSON(jsonString);
-     * ```
-     */
-    static fromJSON(jsonString: string): BankContactInfo | undefined;
     /**
      * Type guard to validate if an unknown object is a valid BankContactInfo instance.
      *
@@ -422,13 +467,6 @@ export declare class BankContactInfo extends BaseContactInfo {
      */
     static is(obj: unknown): obj is BankContactInfo;
     validate(): boolean;
-    /**
-     * Converts the bank contact info to a plain object for serialization.
-     *
-     * @override
-     * @returns {Record<string, unknown>} Plain object representation
-     */
-    toObject(): Record<string, unknown>;
     get accountName(): string;
     get accountNumber(): string;
     get accountNameLabel(): string;
@@ -436,6 +474,10 @@ export declare class BankContactInfo extends BaseContactInfo {
     get channelLabel(): string;
     get channelId(): BankSwiftCode;
     get channelName(): string;
+    toJSON(): BankContactInfoJSON;
+    static fromJSON(json: BankContactInfoJSON | string): BankContactInfo | undefined;
+    static fromJSONString(jsonString: string): BankContactInfo | undefined;
+    static isBankContactInfoJSON(obj: unknown): obj is BankContactInfoJSON;
 }
 /**
  * Union type representing either a mobile or bank contact.