@temboplus/afloat 0.1.0

package/esm/src/models/payout/schemas.d.ts

@@ -0,0 +1,154 @@
+import { z } from "zod";
+import { PAYOUT_APPROVAL_STATUS, PAYOUT_STATUS } from "./status.js";
+/**
+ * Type definition for identifier schema
+ * Used for tracking who created or actioned a payout
+ * Contains a name and unique identity string
+ */
+type IdentifierType = z.ZodObject<{
+    name: z.ZodString;
+    identity: z.ZodString;
+}>;
+/**
+ * Type definition for payout status enum
+ * Represents all possible states of a payout:
+ *
+ * @see {@link PAYOUT_STATUS} for the enum definition in "@models/payout/status.ts"
+ */
+type PayoutStatusType = z.ZodEnum<[
+    typeof PAYOUT_STATUS.CREATED,
+    typeof PAYOUT_STATUS.PAID,
+    typeof PAYOUT_STATUS.FAILED,
+    typeof PAYOUT_STATUS.REJECTED,
+    typeof PAYOUT_STATUS.PENDING
+]>;
+/**
+ * Type definition for payout approval status enum
+ * Represents the approval state of a payout:
+ *
+ * @see {@link PAYOUT_APPROVAL_STATUS} for the enum definition in "@models/payout/status.ts"
+ */
+type ApprovalPayoutStatusType = z.ZodEnum<[
+    typeof PAYOUT_APPROVAL_STATUS.APPROVED,
+    typeof PAYOUT_APPROVAL_STATUS.PENDING,
+    typeof PAYOUT_APPROVAL_STATUS.REJECTED
+]>;
+/**
+ * Type definition for payout input schema
+ * Extends the base payout type with payee information required for creating new payouts
+ *
+ * @extends {BasePayoutType}
+ * @property {z.ZodString} payeeName - Name of the payment recipient
+ */
+type PayoutInputType = z.ZodObject<{
+    channel: z.ZodString;
+    msisdn: z.ZodString;
+    amount: z.ZodNumber;
+    description: z.ZodString;
+    notes: Optional<z.ZodString>;
+    payeeName: z.ZodString;
+}>;
+/**
+ * Type definition for complete payout schema
+ * Extends the base payout type with additional fields for tracking
+ * the full lifecycle of a payout transaction
+ *
+ * @extends {BasePayoutType}
+ * @property {z.ZodString} id - Unique identifier for the payout
+ * @property {z.ZodString} profileId - ID of the profile initiating the payout
+ * @property {z.ZodString} payeeName - Name of the payment recipient
+ * @property {PayoutStatusType} status - Current status of the payout
+ * @property {z.ZodString} statusMessage - Detailed message about the current status
+ * @property {z.ZodString} partnerReference - Optional reference from payment partner
+ * @property {z.ZodDate} createdAt - Timestamp of payout creation
+ * @property {z.ZodDate} updatedAt - Timestamp of last payout update
+ * @property {ApprovalPayoutStatusType} approvalStatus - Current approval state
+ * @property {IdentifierType} createdBy - User who created the payout
+ * @property {IdentifierType} actionedBy - User who last actioned the payout
+ */
+type PayoutType = z.ZodObject<{
+    channel: z.ZodString;
+    msisdn: z.ZodString;
+    amount: z.ZodNumber;
+    description: z.ZodString;
+    notes: Optional<z.ZodString>;
+    id: z.ZodString;
+    profileId: z.ZodString;
+    payeeName: z.ZodString;
+    status: PayoutStatusType;
+    statusMessage: z.ZodString;
+    partnerReference: Optional<z.ZodString>;
+    createdAt: z.ZodDate;
+    updatedAt: z.ZodDate;
+    approvalStatus: ApprovalPayoutStatusType;
+    createdBy: Optional<IdentifierType>;
+    actionedBy: Optional<IdentifierType>;
+}>;
+/**
+ * Type representing a Zod schema that transforms nullable values to undefined
+ * @template T - The original Zod schema type
+ * @property {z.ZodNullable<T>} - The nullable version of the input schema
+ * @property {T["_output"] | undefined} - The output type, allowing the original type or undefined
+ * @property {T["_input"] | null} - The input type, allowing the original type or null
+ */
+type MakeOptionalResult<T extends z.ZodType> = z.ZodEffects<z.ZodNullable<T>, T["_output"] | undefined, T["_input"] | null>;
+/**
+ * Type representing a fully optional field that transforms nulls to undefined
+ * @template T - The original Zod schema type
+ * Combines MakeOptionalResult with ZodOptional to allow both:
+ * 1. The field to be optional (can be omitted from object)
+ * 2. When present, the value can be null (transformed to undefined) or the original type
+ */
+type Optional<T extends z.ZodType> = z.ZodOptional<MakeOptionalResult<T>>;
+/**
+ * Schema for identifying users in the payout process
+ * Used to track who created or actioned a payout
+ */
+declare const identifierSchema: IdentifierType;
+/**
+ * Type definition inferred from identifierSchema
+ * Represents the structure of a user who actions the payout
+ */
+type PayoutApprover = z.infer<typeof identifierSchema>;
+/**
+ * Type definition inferred from payoutInputSchema
+ * Represents the structure of data required to create a new payout
+ */
+type PayoutInput = z.infer<typeof payoutInputSchema>;
+/**
+ * Schema for creating a new payout
+ * Extends base payout schema with payee information
+ */
+declare const payoutInputSchema: PayoutInputType;
+/**
+ * Type definition inferred from payoutSchema
+ * Represents the complete payout record structure
+ */
+type PayoutData = z.infer<typeof payoutSchema>;
+/**
+ * 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)
+ */
+declare const payoutSchema: PayoutType;
+/**
+ * Export object containing all payout-related schemas
+ * Used for validation and type checking throughout the application
+ */
+export declare const PayoutSchemas: {
+    readonly payoutData: PayoutType;
+    readonly payoutInput: PayoutInputType;
+    readonly payoutTransactionStatus: PayoutStatusType;
+    readonly payoutApprovalStatus: ApprovalPayoutStatusType;
+    readonly payoutApprover: IdentifierType;
+};
+/**
+ * Export types for use in other parts of the application
+ * These types can be used for type checking and documentation
+ */
+export type { PayoutApprover, PayoutData, PayoutInput };
+//# sourceMappingURL=schemas.d.ts.map

package/esm/src/models/payout/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../../src/src/models/payout/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,sBAAsB,EACtB,aAAa,EACd,MAAM,aAAa,CAAC;AAErB;;;;GAIG;AACH,KAAK,cAAc,GAAG,CAAC,CAAC,SAAS,CAAC;IAChC,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC;IAClB,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC;CACvB,CAAC,CAAC;AAEH;;;;;GAKG;AACH,KAAK,gBAAgB,GAAG,CAAC,CAAC,OAAO,CAAC;IAChC,OAAO,aAAa,CAAC,OAAO;IAC5B,OAAO,aAAa,CAAC,IAAI;IACzB,OAAO,aAAa,CAAC,MAAM;IAC3B,OAAO,aAAa,CAAC,QAAQ;IAC7B,OAAO,aAAa,CAAC,OAAO;CAC7B,CAAC,CAAC;AAEH;;;;;GAKG;AACH,KAAK,wBAAwB,GAAG,CAAC,CAAC,OAAO,CAAC;IACxC,OAAO,sBAAsB,CAAC,QAAQ;IACtC,OAAO,sBAAsB,CAAC,OAAO;IACrC,OAAO,sBAAsB,CAAC,QAAQ;CACvC,CAAC,CAAC;AAkBH;;;;;;GAMG;AACH,KAAK,eAAe,GAAG,CAAC,CAAC,SAAS,CAAC;IACjC,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC;IACrB,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC;IACpB,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC;IACpB,WAAW,EAAE,CAAC,CAAC,SAAS,CAAC;IACzB,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC7B,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC;CACxB,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,KAAK,UAAU,GAAG,CAAC,CAAC,SAAS,CAAC;IAC5B,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC;IACrB,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC;IACpB,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC;IACpB,WAAW,EAAE,CAAC,CAAC,SAAS,CAAC;IACzB,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC7B,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC;IAChB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC;IACvB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC;IACvB,MAAM,EAAE,gBAAgB,CAAC;IACzB,aAAa,EAAE,CAAC,CAAC,SAAS,CAAC;IAC3B,gBAAgB,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACxC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC;IACrB,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC;IACrB,cAAc,EAAE,wBAAwB,CAAC;IACzC,SAAS,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;IACpC,UAAU,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;CACtC,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,KAAK,kBAAkB,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,UAAU,CACzD,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAChB,CAAC,CAAC,SAAS,CAAC,GAAG,SAAS,EACxB,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,CACnB,CAAC;AAEF;;;;;;GAMG;AACH,KAAK,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;AA2B1E;;;GAGG;AACH,QAAA,MAAM,gBAAgB,EAAE,cAGtB,CAAC;AAEH;;;GAGG;AACH,KAAK,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAoCvD;;;GAGG;AACH,KAAK,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAErD;;;GAGG;AACH,QAAA,MAAM,iBAAiB,EAAE,eAEvB,CAAC;AAEH;;;GAGG;AACH,KAAK,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAE/C;;;;;;;;GAQG;AACH,QAAA,MAAM,YAAY,EAAE,UAalB,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,aAAa;;;;;;CAMhB,CAAC;AAEX;;;GAGG;AACH,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC"}

package/esm/src/models/payout/schemas.js

@@ -0,0 +1,103 @@
+import { z } from "zod";
+import { PAYOUT_APPROVAL_STATUS, PAYOUT_STATUS, } from "./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 = z.object({
+    name: z.string(),
+    identity: z.string(),
+});
+/**
+ * Schema for payout status
+ * Defines all possible states a payout can be in
+ */
+const payoutStatusSchema = z.enum([
+    PAYOUT_STATUS.CREATED,
+    PAYOUT_STATUS.PAID,
+    PAYOUT_STATUS.FAILED,
+    PAYOUT_STATUS.REJECTED,
+    PAYOUT_STATUS.PENDING,
+]);
+/**
+ * Schema for payout approval status
+ * Defines all possible approval states
+ */
+const approvalPayoutStatusSchema = z.enum([
+    PAYOUT_APPROVAL_STATUS.APPROVED,
+    PAYOUT_APPROVAL_STATUS.PENDING,
+    PAYOUT_APPROVAL_STATUS.REJECTED,
+]);
+/**
+ * Base schema for payout operations
+ * Contains common fields used across all payout operations
+ */
+const basePayoutSchema = z.object({
+    channel: z.string(),
+    msisdn: z.string(),
+    amount: z.coerce.number(),
+    description: z.string(),
+    notes: makeOptional(z.string()).optional(),
+});
+/**
+ * Schema for creating a new payout
+ * Extends base payout schema with payee information
+ */
+const payoutInputSchema = basePayoutSchema.extend({
+    payeeName: 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: z.string(),
+    profileId: z.string(),
+    payeeName: z.string(),
+    status: payoutStatusSchema,
+    statusMessage: z.string(),
+    partnerReference: makeOptional(z.string()).optional(),
+    createdAt: z.coerce.date(),
+    updatedAt: z.coerce.date(),
+    actionedAt: makeOptional(z.coerce.date()).optional(),
+    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
+ */
+export const 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/esm/src/models/payout/status.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Represents the current status of a payout transaction.
+ * @enum {string}
+ * @readonly
+ */
+export declare enum PAYOUT_STATUS {
+    /** 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"
+}
+/**
+ * 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/esm/src/models/payout/status.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"status.d.ts","sourceRoot":"","sources":["../../../../src/src/models/payout/status.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,oBAAY,aAAa;IACvB,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;CACpB;AAED;;;;GAIG;AACH,oBAAY,sBAAsB;IAChC,2CAA2C;IAC3C,OAAO,YAAY;IACnB,+BAA+B;IAC/B,QAAQ,aAAa;IACrB,uDAAuD;IACvD,QAAQ,aAAa;CACtB"}

package/esm/src/models/payout/status.js

@@ -0,0 +1,32 @@
+/**
+ * Represents the current status of a payout transaction.
+ * @enum {string}
+ * @readonly
+ */
+export var PAYOUT_STATUS;
+(function (PAYOUT_STATUS) {
+    /** 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 || (PAYOUT_STATUS = {}));
+/**
+ * Represents the approval status for payouts that require authorization.
+ * @enum {string}
+ * @readonly
+ */
+export 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 || (PAYOUT_APPROVAL_STATUS = {}));

package/esm/src/models/permission.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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";
+    };
+};
+/**
+ * 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.Wallet[keyof typeof Permissions.Wallet];
+//# sourceMappingURL=permission.d.ts.map

package/esm/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/esm/src/models/permission.js

@@ -0,0 +1,37 @@
+/**
+ * All Afloat Permissions
+ */
+export const 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/esm/src/models/user/index.d.ts

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

package/esm/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/esm/src/models/user/index.js

@@ -0,0 +1,2 @@
+export * from "./profile.js";
+export * from "./user.js";

package/esm/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/esm/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/esm/src/models/user/profile.js

@@ -0,0 +1,25 @@
+import { z } from "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
+ */
+export const profileSchema = z.object({
+    id: z.string().uuid("Invalid profile ID format"),
+    firstName: z.string().min(1, "First name is required"),
+    lastName: z.string().min(1, "Last name is required"),
+    displayName: z.string().min(1, "Display name is required"),
+    phone: z.string().min(1, "Phone number is required")
+        .regex(/^\+?[\d\s-]+$/, "Invalid phone number format"),
+    accountNo: z.string().min(1, "Account number is required"),
+    email: z.string().email("Invalid email format"),
+});

package/esm/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/esm/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"}