@temboplus/afloat 0.1.57 → 0.1.58

package/dist/models/index.d.ts

@@ -1,10 +0,0 @@
-export * from "./contact-info.model";
-export * from "./contact.model";
-export * from "./payout.model";
-export * from "./profile.model";
-export * from "./user.model";
-export * from "./wallet.model";
-export * from "./statement-entry.model";
-export * from "./permission";
-export * from "./managed-user.model";
-export * from "./role.model";

package/dist/models/statement-entry.model.d.ts

@@ -1,195 +0,0 @@
-import { WalletStatementEntryDTO } from "@/features/wallet/wallet.dtos";
-import { Amount, AmountJson } from "@temboplus/frontend-core";
-/**
- * Interface for the JSON representation of WalletStatementEntry
- */
-export interface WalletStatementEntryJson {
-    accountNo?: string;
-    debitOrCredit: string;
-    tranRefNo: string;
-    narration: string;
-    txnDate: string;
-    valueDate: string;
-    amountCredited: AmountJson;
-    amountDebited: AmountJson;
-    balance: AmountJson;
-    currencyCode: string;
-    version?: string;
-}
-/**
- * Represents a single entry in a Wallet's statement history.
- *
- * This class provides methods for creating, validating, and accessing statement entry data.
- * It integrates with the Zod schema validation for data integrity.
- */
-export declare class WalletStatementEntry {
-    private _accountNo?;
-    private _debitOrCredit;
-    private _tranRefNo;
-    private _narration;
-    private _txnDate;
-    private _valueDate;
-    private _amountCredited;
-    private _amountDebited;
-    private _balance;
-    private _currencyCode;
-    /**
-     * Gets the statement entry schema used for validation.
-     */
-    static get schema(): import("zod").ZodObject<{
-        accountNo: import("zod").ZodEffects<import("zod").ZodOptional<import("zod").ZodString>, string | undefined, string | undefined>;
-        debitOrCredit: import("zod").ZodString;
-        tranRefNo: import("zod").ZodString;
-        narration: import("zod").ZodString;
-        txnDate: import("zod").ZodDate;
-        valueDate: import("zod").ZodDate;
-        amountCredited: import("zod").ZodNumber;
-        amountDebited: import("zod").ZodNumber;
-        balance: import("zod").ZodNumber;
-        currencyCode: import("zod").ZodDefault<import("zod").ZodEffects<import("zod").ZodOptional<import("zod").ZodString>, string | undefined, string | undefined>>;
-    }, "strip", import("zod").ZodTypeAny, {
-        currencyCode: string;
-        debitOrCredit: string;
-        tranRefNo: string;
-        narration: string;
-        txnDate: Date;
-        valueDate: Date;
-        amountCredited: number;
-        amountDebited: number;
-        balance: number;
-        accountNo?: string | undefined;
-    }, {
-        debitOrCredit: string;
-        tranRefNo: string;
-        narration: string;
-        txnDate: Date;
-        valueDate: Date;
-        amountCredited: number;
-        amountDebited: number;
-        balance: number;
-        accountNo?: string | undefined;
-        currencyCode?: string | undefined;
-    }>;
-    /**
-     * Private constructor to enforce use of static factory methods.
-     * Assumes data is already validated and dates are Date objects.
-     * @param data - Object containing statement entry information conforming to WalletStatementEntryDTO.
-     */
-    private constructor();
-    /**
-     * Creates a new WalletStatementEntry instance after validating the input data.
-     * Handles date coercion via the schema and uses currencyCode from the data.
-     *
-     * @param data - Object containing statement entry information. Dates can be strings or Date objects.
-     * @returns A new WalletStatementEntry instance, or undefined if validation fails.
-     */
-    static create(data: {
-        accountNo?: string | null;
-        debitOrCredit: string;
-        tranRefNo: string;
-        narration: string;
-        txnDate: string | Date;
-        valueDate: string | Date;
-        amountCredited: number;
-        amountDebited: number;
-        balance: number;
-        currencyCode?: string;
-    }): WalletStatementEntry | undefined;
-    get accountNo(): string | undefined;
-    get debitOrCredit(): string;
-    get tranRefNo(): string;
-    get narration(): string;
-    get txnDate(): Date;
-    get valueDate(): Date;
-    get amountCredited(): Amount;
-    get amountDebited(): Amount;
-    get balance(): Amount;
-    get currencyCode(): string;
-    /**
-     * Serializes the WalletStatementEntry instance to a JSON-compatible object.
-     * Dates are converted to ISO strings, amounts are serialized using Amount.toJson().
-     *
-     * @returns {WalletStatementEntryJson} A plain object containing all necessary data
-     */
-    toJson(): WalletStatementEntryJson;
-    /**
-     * Creates a WalletStatementEntry instance from a JSON-compatible object.
-     *
-     * @param {WalletStatementEntryJson | string} json - Either a WalletStatementEntryJson object or a JSON string
-     * @returns {WalletStatementEntry | undefined} A WalletStatementEntry instance if valid, undefined otherwise
-     */
-    static fromJson(json: WalletStatementEntryJson | string): WalletStatementEntry | undefined;
-    /**
-     * Type guard to check if an object is a valid WalletStatementEntryJson
-     *
-     * @param obj - The object to validate
-     * @returns True if the object conforms to WalletStatementEntryJson structure
-     */
-    static isWalletStatementEntryJson(obj: unknown): obj is WalletStatementEntryJson;
-    /**
-     * Validates the current statement entry instance data against the schema.
-     * @returns True if the statement entry instance data is valid, false otherwise.
-     */
-    validate(): boolean;
-    /**
-     * Type guard to check if an unknown object is a valid WalletStatementEntry instance.
-     * Performs structural checks (duck typing).
-     * @param obj - The object to check.
-     * @returns Type predicate indicating if the object is a WalletStatementEntry instance.
-     */
-    static is(obj: unknown): obj is WalletStatementEntry;
-    /**
-     * Checks if two WalletStatementEntry instances are equal based on their transaction reference numbers.
-     * @param other - Another WalletStatementEntry to compare with.
-     * @returns True if both entries have the same transaction reference number.
-     */
-    equals(other: WalletStatementEntry): boolean;
-    /**
-     * Creates a copy of this WalletStatementEntry with the same data.
-     * @returns A new WalletStatementEntry instance with identical data.
-     */
-    clone(): WalletStatementEntry | undefined;
-    /**
-     * Returns a string representation of the statement entry for debugging.
-     * @returns A formatted string with key transaction details.
-     */
-    toString(): string;
-    /**
-     * Serializes an array of WalletStatementEntry instances to JSON-compatible objects
-     *
-     * @param entries - Array of WalletStatementEntry instances to serialize
-     * @returns Array of WalletStatementEntryJson objects
-     */
-    static toJsonArray(entries: WalletStatementEntry[]): WalletStatementEntryJson[];
-    /**
-     * Creates WalletStatementEntry instances from an array of JSON-compatible objects
-     *
-     * @param jsonArray - Array of WalletStatementEntryJson objects or JSON string
-     * @returns Array of WalletStatementEntry instances (invalid items are filtered out)
-     */
-    static fromJsonArray(jsonArray: WalletStatementEntryJson[] | string): WalletStatementEntry[];
-    /**
-     * Legacy method for backwards compatibility - creates object representation
-     * @deprecated Use toJson() instead for proper serialization
-     */
-    toObject(): Omit<WalletStatementEntryDTO, "amountCredited" | "amountDebited" | "balance"> & {
-        amountCredited: AmountJson;
-        amountDebited: AmountJson;
-        balance: AmountJson;
-    };
-    /**
-     * Legacy method for backwards compatibility - converts to JSON string
-     * @deprecated Use JSON.stringify(entry.toJson()) instead
-     */
-    toJSON(): string;
-    /**
-     * Legacy method for backwards compatibility
-     * @deprecated Use fromJson() instead
-     */
-    static fromJSON(jsonString: string): WalletStatementEntry | undefined;
-    /**
-     * Legacy method for backwards compatibility - creates from plain object
-     * @deprecated Use fromJson() for serialized data or create() for raw data
-     */
-    static from(data: any): WalletStatementEntry | undefined;
-}

package/dist/models/user.model.d.ts

@@ -1,65 +0,0 @@
-import { Profile } from "./profile.model";
-/**
- * Represents a user in Afloat.
- *
- * This class centralizes user-related logic, simplifying interaction
- * with user-related data and ensuring consistent access checks across the application.
- */
-export declare class User {
-    /**
-     * Logged-in user name.
-     */
-    name: string;
-    /**
-     * Logged-in identity: phone number or email address.
-     */
-    identity: string;
-    /**
-     * The user's Afloat profile.
-     */
-    profile: Profile;
-    /**
-     * The user's authentication token.
-     */
-    token: string;
-    /**
-     * Indicates whether the user must change their default password.
-     */
-    resetPassword: boolean;
-    /**
-     * A list of granted access keys (permissions).
-     */
-    access: string[];
-    /**
-     * A map of access keys to boolean values for fast permission checks.
-     */
-    private accessMap;
-    /**
-     * Creates a new `User` instance.
-     */
-    private constructor();
-    /**
-     * Checks if the user has a specific access permission.
-     *
-     * @param key - The access key to check.
-     * @returns `true` if the user has the specified access, otherwise `false`.
-     */
-    can(key: string): boolean;
-    /**
-     * Returns a plain object representation of the user.
-     * This can safely be embedded in a JWT payload.
-     */
-    toObject(): Record<string, any>;
-    /**
-     * Serializes the `User` instance to a JSON string.
-     */
-    toJSON(): string;
-    /**
-     * Creates a new `User` instance from a JSON string.
-     */
-    static fromJSON(jsonString: string): User | undefined;
-    /**
-     * Creates a new `User` instance from a plain object.
-     */
-    static from(data: any): User | undefined;
-}