@temboplus/afloat 0.1.0

package/script/src/models/permission.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permission.d.ts","sourceRoot":"","sources":["../../../src/src/models/permission.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiCd,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,OAAO,WAAW,CAAC,OAAO,CAAC,MAAM,OAAO,WAAW,CAAC,OAAO,CAAC,GAC5D,OAAO,WAAW,CAAC,OAAO,CAAC,MAAM,OAAO,WAAW,CAAC,OAAO,CAAC,GAC5D,OAAO,WAAW,CAAC,OAAO,CAAC,MAAM,OAAO,WAAW,CAAC,OAAO,CAAC,GAC5D,OAAO,WAAW,CAAC,MAAM,CAAC,MAAM,OAAO,WAAW,CAAC,MAAM,CAAC,GAC1D,OAAO,WAAW,CAAC,QAAQ,CAAC,MAAM,OAAO,WAAW,CAAC,QAAQ,CAAC,GAC9D,OAAO,WAAW,CAAC,MAAM,CAAC,MAAM,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC"}

package/script/src/models/permission.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Permissions = void 0;
+/**
+ * All Afloat Permissions
+ */
+exports.Permissions = {
+    Profile: {
+        ViewCurrent: "profile.getCurrent",
+        Update: "profile.update",
+    },
+    Contact: {
+        View: "contact.findById",
+        List: "contact.findAll",
+        Create: "contact.create",
+        Update: "contact.update",
+        Delete: "contact.delete",
+    },
+    Payment: {
+        View: "payment.findById",
+        List: "payment.findAll",
+        Create: "payment.create",
+    },
+    Payout: {
+        View: "payout.findById",
+        List: "payout.findAll",
+        Create: "payout.create",
+        Approve: "payout.approve",
+    },
+    Transfer: {
+        View: "transfer.findById",
+        List: "transfer.findAll",
+        Create: "transfer.create",
+        Approve: "transfer.approve",
+    },
+    Wallet: {
+        ViewBalance: "wallet.getBalance",
+        ViewStatement: "wallet.getStatement",
+    },
+}; // Make it deeply readonly

package/script/src/models/user/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./profile.js";
+export * from "./user.js";
+//# sourceMappingURL=index.d.ts.map

package/script/src/models/user/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/src/models/user/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC"}

package/script/src/models/user/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./profile.js"), exports);
+__exportStar(require("./user.js"), exports);

package/script/src/models/user/profile.d.ts

@@ -0,0 +1,38 @@
+import { z } from "zod";
+/**
+ * Type definition for profile schema using Zod.
+ * This type helper ensures type safety when implementing the actual schema.
+ */
+type ProfileType = z.ZodObject<{
+    id: z.ZodString;
+    firstName: z.ZodString;
+    lastName: z.ZodString;
+    displayName: z.ZodString;
+    phone: z.ZodString;
+    accountNo: z.ZodString;
+    email: z.ZodString;
+}>;
+/**
+ * Zod schema for validating user profile data.
+ * Defines validation rules and constraints for each profile field.
+ *
+ * @const {ProfileType}
+ *
+ * @property {string} id - Unique identifier for the profile
+ * @property {string} firstName - User's first name
+ * @property {string} lastName - User's last name
+ * @property {string} displayName - User's display name
+ * @property {string} phone - User's contact phone number
+ * @property {string} accountNo - User's account number
+ * @property {string} email - User's email address
+ */
+export declare const profileSchema: ProfileType;
+/**
+ * TypeScript type representing a validated user profile.
+ * Use this type for profile instances that have been validated against the schema.
+ *
+ * @see {@link profileSchema} for validation rules
+ */
+export type Profile = z.infer<typeof profileSchema>;
+export {};
+//# sourceMappingURL=profile.d.ts.map

package/script/src/models/user/profile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"profile.d.ts","sourceRoot":"","sources":["../../../../src/src/models/user/profile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,KAAK,WAAW,GAAG,CAAC,CAAC,SAAS,CAAC;IAC7B,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC;IAChB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC;IACvB,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC;IACtB,WAAW,EAAE,CAAC,CAAC,SAAS,CAAC;IACzB,KAAK,EAAE,CAAC,CAAC,SAAS,CAAC;IACnB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC;IACvB,KAAK,EAAE,CAAC,CAAC,SAAS,CAAC;CACpB,CAAC,CAAC;AAEH;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa,EAAE,WAS1B,CAAC;AAEH;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC"}

package/script/src/models/user/profile.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.profileSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Zod schema for validating user profile data.
+ * Defines validation rules and constraints for each profile field.
+ *
+ * @const {ProfileType}
+ *
+ * @property {string} id - Unique identifier for the profile
+ * @property {string} firstName - User's first name
+ * @property {string} lastName - User's last name
+ * @property {string} displayName - User's display name
+ * @property {string} phone - User's contact phone number
+ * @property {string} accountNo - User's account number
+ * @property {string} email - User's email address
+ */
+exports.profileSchema = zod_1.z.object({
+    id: zod_1.z.string().uuid("Invalid profile ID format"),
+    firstName: zod_1.z.string().min(1, "First name is required"),
+    lastName: zod_1.z.string().min(1, "Last name is required"),
+    displayName: zod_1.z.string().min(1, "Display name is required"),
+    phone: zod_1.z.string().min(1, "Phone number is required")
+        .regex(/^\+?[\d\s-]+$/, "Invalid phone number format"),
+    accountNo: zod_1.z.string().min(1, "Account number is required"),
+    email: zod_1.z.string().email("Invalid email format"),
+});

package/script/src/models/user/user.d.ts

@@ -0,0 +1,80 @@
+import type { Profile } from "./profile.js";
+/**
+ * Represents a user in Afloat
+ *
+ * This class centralizes user-related logic, simplifying interaction
+ * with user-related data and ensuring consistent permission 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, containing personal information such as name, contact details, and account information.
+     */
+    profile: Profile;
+    /**
+     * The user's authentication token. This token must be passed in the request headers
+     * for all authenticated API endpoints.
+     */
+    token: string;
+    /**
+     * Indicates whether the user is required to change their default password.
+     *
+     * Afloat users are initially provided with a default username and password. After the first
+     * successful login, `resetPassword` will be set to `true` to prompt the user to set a new password.
+     */
+    resetPassword: boolean;
+    /**
+     * A map of permission keys to boolean values, indicating whether the user has access
+     * to specific actions or features in the system.
+     */
+    private permissionsMap;
+    /**
+     * Creates a new instance of the `User` class.
+     *
+     * @param userData - An object of type `CoreUser` containing the user's profile, token,
+     * permissions (access list), and the `resetPassword` flag.
+     */
+    constructor(data: {
+        profile: Profile;
+        token: string;
+        access: string[];
+        resetPassword: boolean;
+        loginCredentials: {
+            name: string;
+            identity: string;
+        };
+    });
+    /**
+     * Checks if the user has a specific permission.
+     *
+     * @param permission - The permission key to check.
+     * @returns `true` if the user has the specified permission, otherwise `false`.
+     */
+    can(permission: string): boolean;
+    /**
+     * Serializes the `User` instance to a JSON string.
+     *
+     * @returns A JSON string representation of the `User` instance, including:
+     * - `profile`: The user's profile information.
+     * - `token`: The user's authentication token.
+     * - `resetPassword`: Indicates whether the user must reset their password.
+     * - `permissions`: An array of permission keys the user has.
+     */
+    toJSON(): string;
+    /**
+     * Creates a new `User` instance from a JSON string.
+     *
+     * @param jsonString - A JSON string containing user data.
+     * @returns A `User` instance reconstructed from the JSON data.
+     * @throws Will throw an error if the JSON data is invalid or incomplete.
+     */
+    static fromJSON(jsonString: string): User;
+}
+//# sourceMappingURL=user.d.ts.map

package/script/src/models/user/user.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../../../src/src/models/user/user.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C;;;;;GAKG;AACH,qBAAa,IAAI;IACf;;OAEG;IACI,IAAI,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACI,QAAQ,EAAE,MAAM,CAAC;IAExB;;OAEG;IACI,OAAO,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACI,KAAK,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACI,aAAa,EAAE,OAAO,CAAC;IAE9B;;;OAGG;IACH,OAAO,CAAC,cAAc,CAA0B;IAEhD;;;;;OAKG;gBACS,IAAI,EAAE;QAChB,OAAO,EAAE,OAAO,CAAC;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,aAAa,EAAE,OAAO,CAAC;QACvB,gBAAgB,EAAE;YAChB,IAAI,EAAE,MAAM,CAAC;YACb,QAAQ,EAAE,MAAM,CAAC;SAClB,CAAC;KACH;IAqBD;;;;;OAKG;IACI,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAIvC;;;;;;;;OAQG;IACI,MAAM,IAAI,MAAM;IAavB;;;;;;OAMG;WACW,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;CA4BjD"}

package/script/src/models/user/user.js

@@ -0,0 +1,153 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.User = void 0;
+const permission_js_1 = require("../permission.js");
+/**
+ * Represents a user in Afloat
+ *
+ * This class centralizes user-related logic, simplifying interaction
+ * with user-related data and ensuring consistent permission checks across the application.
+ */
+class User {
+    /**
+     * Creates a new instance of the `User` class.
+     *
+     * @param userData - An object of type `CoreUser` containing the user's profile, token,
+     * permissions (access list), and the `resetPassword` flag.
+     */
+    constructor(data) {
+        /**
+         * Logged-in user name
+         */
+        Object.defineProperty(this, "name", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * Logged-in identity: phone-number or email address
+         */
+        Object.defineProperty(this, "identity", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * The user's Afloat profile, containing personal information such as name, contact details, and account information.
+         */
+        Object.defineProperty(this, "profile", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * The user's authentication token. This token must be passed in the request headers
+         * for all authenticated API endpoints.
+         */
+        Object.defineProperty(this, "token", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * Indicates whether the user is required to change their default password.
+         *
+         * Afloat users are initially provided with a default username and password. After the first
+         * successful login, `resetPassword` will be set to `true` to prompt the user to set a new password.
+         */
+        Object.defineProperty(this, "resetPassword", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * A map of permission keys to boolean values, indicating whether the user has access
+         * to specific actions or features in the system.
+         */
+        Object.defineProperty(this, "permissionsMap", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        const { profile, token, access, resetPassword } = data;
+        this.profile = profile;
+        this.token = token;
+        this.resetPassword = resetPassword;
+        this.name = data.loginCredentials.name;
+        this.identity = data.loginCredentials.identity;
+        // Initialize the permissions map
+        this.permissionsMap = {};
+        for (const permission of Object.values(permission_js_1.Permissions)) {
+            if (typeof permission === "object") {
+                Object.values(permission).forEach((perm) => {
+                    this.permissionsMap[perm] = access.includes(perm);
+                });
+            }
+        }
+    }
+    /**
+     * Checks if the user has a specific permission.
+     *
+     * @param permission - The permission key to check.
+     * @returns `true` if the user has the specified permission, otherwise `false`.
+     */
+    can(permission) {
+        return this.permissionsMap[permission] ?? false;
+    }
+    /**
+     * Serializes the `User` instance to a JSON string.
+     *
+     * @returns A JSON string representation of the `User` instance, including:
+     * - `profile`: The user's profile information.
+     * - `token`: The user's authentication token.
+     * - `resetPassword`: Indicates whether the user must reset their password.
+     * - `permissions`: An array of permission keys the user has.
+     */
+    toJSON() {
+        return JSON.stringify({
+            profile: this.profile,
+            token: this.token,
+            resetPassword: this.resetPassword,
+            name: this.name,
+            identity: this.identity,
+            permissions: Object.keys(this.permissionsMap).filter((key) => this.permissionsMap[key]),
+        });
+    }
+    /**
+     * Creates a new `User` instance from a JSON string.
+     *
+     * @param jsonString - A JSON string containing user data.
+     * @returns A `User` instance reconstructed from the JSON data.
+     * @throws Will throw an error if the JSON data is invalid or incomplete.
+     */
+    static fromJSON(jsonString) {
+        const data = JSON.parse(jsonString);
+        if (!data.profile ||
+            !data.token ||
+            !data.name ||
+            !data.identity ||
+            !Array.isArray(data.permissions) ||
+            typeof data.resetPassword !== "boolean") {
+            throw new Error("Invalid JSON data for User");
+        }
+        // Reconstruct the CoreUser structure
+        const args = {
+            profile: data.profile,
+            token: data.token,
+            access: data.permissions,
+            resetPassword: data.resetPassword,
+            loginCredentials: {
+                name: data.name,
+                identity: data.identity,
+            },
+        };
+        return new User(args);
+    }
+}
+exports.User = User;

package/script/src/models/wallet/guards.d.ts

@@ -0,0 +1,11 @@
+import { type WalletStatementItem } from "./schemas.js";
+/**
+ * Type guard function that checks if the provided data is an array of valid wallet statement items.
+ * Uses Zod schema validation to ensure each item in the array matches the WalletStatementItem schema.
+ *
+ * @param {unknown} data - The data to be type checked. Can be any value.
+ * @returns {boolean} Returns true if the data is an array of valid WalletStatementItem objects,
+ *                    false otherwise
+ */
+export declare function isWalletStatementItemArray(data: unknown): data is WalletStatementItem[];
+//# sourceMappingURL=guards.d.ts.map

package/script/src/models/wallet/guards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guards.d.ts","sourceRoot":"","sources":["../../../../src/src/models/wallet/guards.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,mBAAmB,EACzB,MAAM,cAAc,CAAC;AAEtB;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,IAAI,EAAE,OAAO,GACZ,IAAI,IAAI,mBAAmB,EAAE,CAG/B"}

package/script/src/models/wallet/guards.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWalletStatementItemArray = isWalletStatementItemArray;
+const zod_1 = require("zod");
+const schemas_js_1 = require("./schemas.js");
+/**
+ * Type guard function that checks if the provided data is an array of valid wallet statement items.
+ * Uses Zod schema validation to ensure each item in the array matches the WalletStatementItem schema.
+ *
+ * @param {unknown} data - The data to be type checked. Can be any value.
+ * @returns {boolean} Returns true if the data is an array of valid WalletStatementItem objects,
+ *                    false otherwise
+ */
+function isWalletStatementItemArray(data) {
+    const result = zod_1.z.array(schemas_js_1.WalletSchemas.statementEntry).safeParse(data);
+    return result.success;
+}

package/script/src/models/wallet/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./guards.js";
+export * from "./schemas.js";
+export * from "./statement.js";
+//# sourceMappingURL=index.d.ts.map

package/script/src/models/wallet/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/src/models/wallet/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC"}

package/script/src/models/wallet/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./guards.js"), exports);
+__exportStar(require("./schemas.js"), exports);
+__exportStar(require("./statement.js"), exports);

package/script/src/models/wallet/schemas.d.ts

@@ -0,0 +1,50 @@
+import { z } from "zod";
+/**
+ * Type definition for statement entry schema using Zod.
+ * This is used as a TypeScript type helper for the actual schema implementation.
+ */
+type _StatementEntryType = z.ZodObject<{
+    accountNo: z.ZodEffects<z.ZodOptional<z.ZodString>>;
+    cbaRefNo: z.ZodEffects<z.ZodOptional<z.ZodString>>;
+    debitOrCredit: z.ZodString;
+    tranRefNo: z.ZodString;
+    narration: z.ZodString;
+    txnDate: z.ZodDate;
+    valueDate: z.ZodDate;
+    amountCredited: z.ZodNumber;
+    amountDebited: z.ZodNumber;
+    balance: z.ZodNumber;
+}>;
+/**
+ * Type definition for wallet schema using Zod.
+ * This is used as a TypeScript type helper for the actual schema implementation.
+ */
+type _WalletType = z.ZodObject<{
+    id: z.ZodString;
+    profileId: z.ZodString;
+    accountNo: z.ZodString;
+    accountName: z.ZodString;
+    channel: z.ZodString;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+}>;
+/**
+ * Collection of wallet-related schemas for export.
+ * Provides access to both wallet and statement entry validation schemas.
+ */
+export declare const WalletSchemas: {
+    wallet: _WalletType;
+    statementEntry: _StatementEntryType;
+};
+/**
+ * TypeScript type for a validated wallet object.
+ * Use this type for wallet instances that have been validated against the schema.
+ */
+export type Wallet = z.infer<typeof WalletSchemas.wallet>;
+/**
+ * TypeScript type for a validated statement entry object.
+ * Use this type for statement entries that have been validated against the schema.
+ */
+export type WalletStatementItem = z.infer<typeof WalletSchemas.statementEntry>;
+export {};
+//# sourceMappingURL=schemas.d.ts.map

package/script/src/models/wallet/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../../src/src/models/wallet/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAWxB;;;GAGG;AACH,KAAK,mBAAmB,GAAG,CAAC,CAAC,SAAS,CAAC;IACrC,SAAS,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IACpD,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IACnD,aAAa,EAAE,CAAC,CAAC,SAAS,CAAC;IAC3B,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC;IACvB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC;IACvB,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC;IACnB,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC;IACrB,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC;IAC5B,aAAa,EAAE,CAAC,CAAC,SAAS,CAAC;IAC3B,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC;CACtB,CAAC,CAAC;AA8BH;;;GAGG;AACH,KAAK,WAAW,GAAG,CAAC,CAAC,SAAS,CAAC;IAC7B,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC;IAChB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC;IACvB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC;IACvB,WAAW,EAAE,CAAC,CAAC,SAAS,CAAC;IACzB,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC;IACrB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC;IACvB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC;CACxB,CAAC,CAAC;AAwBH;;;GAGG;AACH,eAAO,MAAM,aAAa;;;CAGzB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC;AAE1D;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,cAAc,CAAC,CAAC"}

package/script/src/models/wallet/schemas.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WalletSchemas = void 0;
+const zod_1 = require("zod");
+/**
+ * Helper function to make a field optional with undefined
+ * Transforms null values to undefined for consistency
+ * @param schema - The Zod schema to make optional
+ * @returns A schema that only allows string or undefined (no null)
+ */
+const makeOptional = (schema) => schema.optional().transform((val) => val ?? undefined);
+/**
+ * Schema definition for a statement entry.
+ * Represents a single transaction in a wallet's statement history.
+ *
+ * @property {string} accountNo - The account number associated with the transaction (optional)
+ * @property {string} cbaRefNo - Core banking system reference number (optional)
+ * @property {string} debitOrCredit - Indicator if transaction is debit or credit
+ * @property {string} tranRefNo - Transaction reference number
+ * @property {string} narration - Description of the transaction
+ * @property {Date} txnDate - Date when transaction was initiated
+ * @property {Date} valueDate - Date when transaction value was applied
+ * @property {number} amountCredited - Amount credited in transaction (if credit)
+ * @property {number} amountDebited - Amount debited in transaction (if debit)
+ * @property {number} balance - Running balance after transaction
+ */
+const statementEntrySchema = zod_1.z.object({
+    accountNo: makeOptional(zod_1.z.string()),
+    cbaRefNo: makeOptional(zod_1.z.string()),
+    debitOrCredit: zod_1.z.string().min(1, "Transaction type is required"),
+    tranRefNo: zod_1.z.string().min(1, "Transaction reference is required"),
+    narration: zod_1.z.string().min(1, "Transaction description is required"),
+    txnDate: zod_1.z.coerce.date(),
+    valueDate: zod_1.z.coerce.date(),
+    amountCredited: zod_1.z.number().min(0, "Credited amount must be non-negative"),
+    amountDebited: zod_1.z.number().min(0, "Debited amount must be non-negative"),
+    balance: zod_1.z.number(),
+});
+/**
+ * Schema definition for a wallet.
+ * Represents a digital wallet that can hold funds and process transactions.
+ *
+ * @property {string} id - Unique identifier for the wallet
+ * @property {string} profileId - ID of the profile that owns this wallet
+ * @property {string} accountNo - Account number associated with the wallet
+ * @property {string} accountName - Name of the account holder
+ * @property {string} channel - Payment channel or provider (e.g., "MPESA", "BANK")
+ * @property {string} createdAt - ISO datetime string of wallet creation
+ * @property {string} updatedAt - ISO datetime string of last wallet update
+ */
+const walletSchema = zod_1.z.object({
+    id: zod_1.z.string().uuid("Invalid wallet ID format"),
+    profileId: zod_1.z.string().min(1, "Profile ID is required"),
+    accountNo: zod_1.z.string().min(1, "Account number is required"),
+    accountName: zod_1.z.string().min(1, "Account name is required"),
+    channel: zod_1.z.string().min(1, "Channel is required"),
+    createdAt: zod_1.z.string().datetime("Invalid creation timestamp"),
+    updatedAt: zod_1.z.string().datetime("Invalid update timestamp"),
+});
+/**
+ * Collection of wallet-related schemas for export.
+ * Provides access to both wallet and statement entry validation schemas.
+ */
+exports.WalletSchemas = {
+    wallet: walletSchema,
+    statementEntry: statementEntrySchema,
+};

package/script/src/models/wallet/statement.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Enum representing the supported output formats for statement generation.
+ * Used to specify the desired file format when requesting statement downloads.
+ *
+ * @enum {string}
+ */
+export declare enum STATEMENT_OUTPUT_TYPE {
+    /** Generate statement as a PDF document */
+    PDF = "PDF",
+    /** Generate statement as an Excel spreadsheet */
+    EXCEL = "EXCEL"
+}
+/**
+ * Interface defining the structure of a generated statement file.
+ * Contains metadata about the file and its content type.
+ *
+ * @interface StatementFile
+ * @property {string} file - Base64 encoded string of the file content or file path
+ * @property {string} file_extension - File extension (e.g., "pdf", "xlsx") without the dot
+ * @property {string} mime_type - MIME type of the file (e.g., "application/pdf", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
+ */
+export interface StatementFile {
+    file: string;
+    file_extension: string;
+    mime_type: string;
+}
+//# sourceMappingURL=statement.d.ts.map

package/script/src/models/wallet/statement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"statement.d.ts","sourceRoot":"","sources":["../../../../src/src/models/wallet/statement.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,oBAAY,qBAAqB;IAC/B,2CAA2C;IAC3C,GAAG,QAAQ;IACX,iDAAiD;IACjD,KAAK,UAAU;CAChB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/script/src/models/wallet/statement.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STATEMENT_OUTPUT_TYPE = void 0;
+/**
+ * Enum representing the supported output formats for statement generation.
+ * Used to specify the desired file format when requesting statement downloads.
+ *
+ * @enum {string}
+ */
+var STATEMENT_OUTPUT_TYPE;
+(function (STATEMENT_OUTPUT_TYPE) {
+    /** Generate statement as a PDF document */
+    STATEMENT_OUTPUT_TYPE["PDF"] = "PDF";
+    /** Generate statement as an Excel spreadsheet */
+    STATEMENT_OUTPUT_TYPE["EXCEL"] = "EXCEL";
+})(STATEMENT_OUTPUT_TYPE || (exports.STATEMENT_OUTPUT_TYPE = STATEMENT_OUTPUT_TYPE = {}));