@temboplus/afloat 0.1.81 → 0.2.0-beta.2

package/script/npm/src/src/models/payout/schemas.js

@@ -1,108 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PayoutSchemas = void 0;
-const zod_1 = require("zod");
-const status_js_1 = require("./status.js");
-/**
- * Creates a Zod schema that transforms null values to undefined
- * This is useful when dealing with APIs that return null but you want to use undefined in your codebase
- *
- * @template T - The type of Zod schema being transformed
- * @param {T} schema - The original Zod schema to transform
- * @returns {MakeOptionalResult<T>} A new schema that:
- *   - Accepts the original type or null as input
- *   - Outputs the original type or undefined
- *   - Automatically transforms null to undefined during validation
- *
- * @example
- * const userSchema = z.object({
- *   name: makeOptional(z.string()), // accepts: string | null, outputs: string | undefined
- * });
- *
- * // These are all valid:
- * userSchema.parse({ name: "John" })    // { name: "John" }
- * userSchema.parse({ name: null })      // { name: undefined }
- */
-const makeOptional = (schema) => schema.nullable().transform((val) => val === null ? undefined : val);
-/**
- * Schema for identifying users in the payout process
- * Used to track who created or actioned a payout
- */
-const identifierSchema = zod_1.z.object({
-    name: zod_1.z.string(),
-    identity: zod_1.z.string(),
-});
-/**
- * Schema for payout status
- * Defines all possible states a payout can be in
- */
-const payoutStatusSchema = zod_1.z.enum([
-    status_js_1.PAYOUT_STATUS.CREATED,
-    status_js_1.PAYOUT_STATUS.PAID,
-    status_js_1.PAYOUT_STATUS.FAILED,
-    status_js_1.PAYOUT_STATUS.REJECTED,
-    status_js_1.PAYOUT_STATUS.PENDING,
-    status_js_1.PAYOUT_STATUS.QUEUED,
-    status_js_1.PAYOUT_STATUS.REVERSED,
-]);
-/**
- * Schema for payout approval status
- * Defines all possible approval states
- */
-const approvalPayoutStatusSchema = zod_1.z.enum([
-    status_js_1.PAYOUT_APPROVAL_STATUS.APPROVED,
-    status_js_1.PAYOUT_APPROVAL_STATUS.PENDING,
-    status_js_1.PAYOUT_APPROVAL_STATUS.REJECTED,
-]);
-/**
- * Base schema for payout operations
- * Contains common fields used across all payout operations
- */
-const basePayoutSchema = zod_1.z.object({
-    channel: zod_1.z.string(),
-    msisdn: zod_1.z.string(),
-    amount: zod_1.z.coerce.number(),
-    description: zod_1.z.string(),
-    notes: makeOptional(zod_1.z.string()).optional(),
-});
-/**
- * Schema for creating a new payout
- * Extends base payout schema with payee information
- */
-const payoutInputSchema = basePayoutSchema.extend({
-    payeeName: zod_1.z.string(),
-});
-/**
- * Schema for complete payout record
- * Extends base payout schema with additional fields for:
- * - Identification (id, profileId)
- * - Status tracking
- * - Timestamps
- * - Approval information
- * - User tracking (created by, actioned by)
- */
-const payoutSchema = basePayoutSchema.extend({
-    id: zod_1.z.string(),
-    profileId: zod_1.z.string(),
-    payeeName: zod_1.z.string(),
-    status: payoutStatusSchema,
-    statusMessage: zod_1.z.string(),
-    partnerReference: makeOptional(zod_1.z.string()).optional(),
-    createdAt: zod_1.z.coerce.date(),
-    updatedAt: zod_1.z.coerce.date(),
-    actionedAt: zod_1.z.coerce.date().nullish(),
-    approvalStatus: approvalPayoutStatusSchema,
-    createdBy: makeOptional(identifierSchema).optional(),
-    actionedBy: makeOptional(identifierSchema).optional(),
-});
-/**
- * Export object containing all payout-related schemas
- * Used for validation and type checking throughout the application
- */
-exports.PayoutSchemas = {
-    payoutData: payoutSchema, // Complete payout record schema
-    payoutInput: payoutInputSchema, // New payout input schema
-    payoutTransactionStatus: payoutStatusSchema, // Payout status enum schema
-    payoutApprovalStatus: approvalPayoutStatusSchema, // Approval status enum schema
-    payoutApprover: identifierSchema, // Identifier schema for approvers
-};

package/script/npm/src/src/models/payout/status.d.ts

@@ -1,33 +0,0 @@
-/**
- * Represents the current status of a payout transaction.
- * @enum {string}
- * @readonly
- */
-export declare enum PAYOUT_STATUS {
-    QUEUED = "QUEUED",
-    /** Payout is awaiting processing */
-    PENDING = "PENDING",
-    /** Payout has been successfully processed */
-    PAID = "PAID",
-    /** Payout processing has failed */
-    FAILED = "FAILED",
-    /** Payout has been rejected */
-    REJECTED = "REJECTED",
-    /** Payout has been initially created but not yet processed */
-    CREATED = "CREATED",
-    REVERSED = "REVERSED"
-}
-/**
- * Represents the approval status for payouts that require authorization.
- * @enum {string}
- * @readonly
- */
-export declare enum PAYOUT_APPROVAL_STATUS {
-    /** Payout is awaiting approval decision */
-    PENDING = "Pending",
-    /** Payout has been approved */
-    APPROVED = "Approved",
-    /** Payout has been rejected during approval process */
-    REJECTED = "Rejected"
-}
-//# sourceMappingURL=status.d.ts.map

package/script/npm/src/src/models/payout/status.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"status.d.ts","sourceRoot":"","sources":["../../../../../../src/src/models/payout/status.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,oBAAY,aAAa;IACvB,MAAM,WAAW;IAEjB,oCAAoC;IACpC,OAAO,YAAY;IACnB,6CAA6C;IAC7C,IAAI,SAAS;IACb,mCAAmC;IACnC,MAAM,WAAW;IACjB,+BAA+B;IAC/B,QAAQ,aAAa;IACrB,8DAA8D;IAC9D,OAAO,YAAY;IAEnB,QAAQ,aAAa;CACtB;AAED;;;;GAIG;AACH,oBAAY,sBAAsB;IAChC,2CAA2C;IAC3C,OAAO,YAAY;IACnB,+BAA+B;IAC/B,QAAQ,aAAa;IACrB,uDAAuD;IACvD,QAAQ,aAAa;CACtB"}

package/script/npm/src/src/models/payout/status.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PAYOUT_APPROVAL_STATUS = exports.PAYOUT_STATUS = void 0;
-/**
- * Represents the current status of a payout transaction.
- * @enum {string}
- * @readonly
- */
-var PAYOUT_STATUS;
-(function (PAYOUT_STATUS) {
-    PAYOUT_STATUS["QUEUED"] = "QUEUED";
-    /** Payout is awaiting processing */
-    PAYOUT_STATUS["PENDING"] = "PENDING";
-    /** Payout has been successfully processed */
-    PAYOUT_STATUS["PAID"] = "PAID";
-    /** Payout processing has failed */
-    PAYOUT_STATUS["FAILED"] = "FAILED";
-    /** Payout has been rejected */
-    PAYOUT_STATUS["REJECTED"] = "REJECTED";
-    /** Payout has been initially created but not yet processed */
-    PAYOUT_STATUS["CREATED"] = "CREATED";
-    PAYOUT_STATUS["REVERSED"] = "REVERSED";
-})(PAYOUT_STATUS || (exports.PAYOUT_STATUS = PAYOUT_STATUS = {}));
-/**
- * Represents the approval status for payouts that require authorization.
- * @enum {string}
- * @readonly
- */
-var PAYOUT_APPROVAL_STATUS;
-(function (PAYOUT_APPROVAL_STATUS) {
-    /** Payout is awaiting approval decision */
-    PAYOUT_APPROVAL_STATUS["PENDING"] = "Pending";
-    /** Payout has been approved */
-    PAYOUT_APPROVAL_STATUS["APPROVED"] = "Approved";
-    /** Payout has been rejected during approval process */
-    PAYOUT_APPROVAL_STATUS["REJECTED"] = "Rejected";
-})(PAYOUT_APPROVAL_STATUS || (exports.PAYOUT_APPROVAL_STATUS = PAYOUT_APPROVAL_STATUS = {}));

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

@@ -1,55 +0,0 @@
-/**
- * All Afloat Permissions
- */
-export declare const Permissions: {
-    readonly Profile: {
-        readonly ViewCurrent: "profile.getCurrent";
-        readonly Update: "profile.update";
-    };
-    readonly Contact: {
-        readonly View: "contact.findById";
-        readonly List: "contact.findAll";
-        readonly Create: "contact.create";
-        readonly Update: "contact.update";
-        readonly Delete: "contact.delete";
-    };
-    readonly Payment: {
-        readonly View: "payment.findById";
-        readonly List: "payment.findAll";
-        readonly Create: "payment.create";
-    };
-    readonly Payout: {
-        readonly View: "payout.findById";
-        readonly List: "payout.findAll";
-        readonly Create: "payout.create";
-        readonly Approve: "payout.approve";
-    };
-    readonly Transfer: {
-        readonly View: "transfer.findById";
-        readonly List: "transfer.findAll";
-        readonly Create: "transfer.create";
-        readonly Approve: "transfer.approve";
-    };
-    readonly Wallet: {
-        readonly ViewBalance: "wallet.getBalance";
-        readonly ViewStatement: "wallet.getStatement";
-    };
-    readonly Role: {
-        readonly ViewRoles: "role.findAll";
-        readonly ViewRole: "role.findById";
-    };
-    readonly UserManagement: {
-        readonly ViewUsers: "login.findAll";
-        readonly ViewUser: "login.findById";
-        readonly CreateUser: "login.create";
-        readonly UpdateUser: "login.update";
-        readonly ArchiveUser: "login.archive";
-        readonly UnArchiveUser: "login.unarchive";
-        readonly ResetPassword: "login.resetPassword";
-    };
-};
-/**
- * Permission Type
- */
-export type Permission = typeof Permissions.Profile[keyof typeof Permissions.Profile] | typeof Permissions.Contact[keyof typeof Permissions.Contact] | typeof Permissions.Payment[keyof typeof Permissions.Payment] | typeof Permissions.Payout[keyof typeof Permissions.Payout] | typeof Permissions.Transfer[keyof typeof Permissions.Transfer] | typeof Permissions.UserManagement[keyof typeof Permissions.UserManagement] | typeof Permissions.Role[keyof typeof Permissions.Role] | typeof Permissions.Wallet[keyof typeof Permissions.Wallet];
-//# sourceMappingURL=permission.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"permission.d.ts","sourceRoot":"","sources":["../../../../../src/src/models/permission.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8Cd,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,cAAc,CAAC,MAAM,OAAO,WAAW,CAAC,cAAc,CAAC,GAC1E,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,OAAO,WAAW,CAAC,IAAI,CAAC,GACtD,OAAO,WAAW,CAAC,MAAM,CAAC,MAAM,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC"}

package/script/npm/src/src/models/permission.js

@@ -1,53 +0,0 @@
-"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",
-    },
-    Role: {
-        ViewRoles: "role.findAll",
-        ViewRole: "role.findById",
-    },
-    UserManagement: {
-        ViewUsers: "login.findAll",
-        ViewUser: "login.findById",
-        CreateUser: "login.create",
-        UpdateUser: "login.update",
-        ArchiveUser: "login.archive",
-        UnArchiveUser: "login.unarchive",
-        ResetPassword: "login.resetPassword",
-    },
-}; // Make it deeply readonly

package/script/npm/src/src/models/role.d.ts

@@ -1,21 +0,0 @@
-export interface RoleData {
-    id: string;
-    name: string;
-    description?: string;
-    access: string[];
-    createdAt: string;
-    updatedAt: string;
-}
-export declare class Role {
-    readonly id: string;
-    readonly name: string;
-    readonly description?: string;
-    readonly permissions: ReadonlySet<string>;
-    readonly createdAt: Date;
-    readonly updatedAt: Date;
-    constructor(data: RoleData);
-    hasPermission(permission: string): boolean;
-    static from(data: any): Role | undefined;
-    toJSON(): any;
-}
-//# sourceMappingURL=role.d.ts.map

package/script/npm/src/src/models/role.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"role.d.ts","sourceRoot":"","sources":["../../../../../src/src/models/role.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,qBAAa,IAAI;IACf,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrC,SAAgB,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IACjD,SAAgB,SAAS,EAAE,IAAI,CAAC;IAChC,SAAgB,SAAS,EAAE,IAAI,CAAC;gBAEpB,IAAI,EAAE,QAAQ;IAS1B,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAI1C,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS;IAYxC,MAAM,IAAI,GAAG;CAUd"}

package/script/npm/src/src/models/role.js

@@ -1,77 +0,0 @@
-"use strict";
-// deno-lint-ignore-file no-explicit-any
-// ====================== Role Entity ====================== //
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Role = void 0;
-class Role {
-    constructor(data) {
-        Object.defineProperty(this, "id", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "name", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "description", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "permissions", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "createdAt", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "updatedAt", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.id = data.id;
-        this.name = data.name;
-        this.description = data.description;
-        this.permissions = new Set(data.access);
-        this.createdAt = new Date(data.createdAt);
-        this.updatedAt = new Date(data.updatedAt);
-    }
-    hasPermission(permission) {
-        return this.permissions.has(permission);
-    }
-    static from(data) {
-        try {
-            if (!data?.id || !data?.name || !Array.isArray(data?.access)) {
-                return undefined;
-            }
-            return new Role(data);
-        }
-        catch (error) {
-            console.error("Error creating Role:", error);
-            return undefined;
-        }
-    }
-    toJSON() {
-        return {
-            id: this.id,
-            name: this.name,
-            description: this.description,
-            access: Array.from(this.permissions),
-            createdAt: this.createdAt.toISOString(),
-            updatedAt: this.updatedAt.toISOString(),
-        };
-    }
-}
-exports.Role = Role;

package/script/npm/src/src/models/user/authenticated-user.d.ts

@@ -1,77 +0,0 @@
-import { 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 containing the user's profile, token,
-     * permissions (access list), and the `resetPassword` flag.
-     */
-    private constructor();
-    /**
-     * 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. (Requires profile.toJSON() method)
-     * - `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, or undefined if jsonString is invalid.
-     */
-    static fromJSON(jsonString: string): User | undefined;
-    /**
-     * Creates a new `User` instance from a data object, JSON string, or object with a Profile instance/object.
-     *
-     * @param data - The data object, JSON string, or object with Profile instance/object containing user information.
-     * @returns A `User` instance, or undefined if data is invalid.
-     */
-    static from(data: any): User | undefined;
-}
-//# sourceMappingURL=authenticated-user.d.ts.map

package/script/npm/src/src/models/user/authenticated-user.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"authenticated-user.d.ts","sourceRoot":"","sources":["../../../../../../src/src/models/user/authenticated-user.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC;;;;;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;IACH,OAAO;IAwBP;;;;;OAKG;IACI,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAIvC;;;;;;;;OAQG;IACI,MAAM,IAAI,MAAM;IAavB;;;;;OAKG;WACW,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAS5D;;;;;OAKG;WACW,IAAI,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS;CA4FhD"}