@temboplus/afloat 0.1.13 → 0.1.30

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

@@ -1,4 +1,5 @@
 import { z } from "zod";
+import { PhoneNumber } from "@temboplus/frontend-core";
 /**
  * Zod schema for validating user profile data.
  * Defines validation rules and constraints for each profile field.
@@ -6,20 +7,325 @@ import { z } from "zod";
  * @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 | null | undefined} firstName - User's first name, can be null or undefined
+ * @property {string | null | undefined} lastName - User's last name, can be null or undefined
  * @property {string} displayName - User's display name
- * @property {string} phone - User's contact phone number
+ * @property {string | null | undefined} phone - User's contact phone number, can be null or undefined
  * @property {string} accountNo - User's account number
- * @property {string} email - User's email address
+ * @property {string | null | undefined} email - User's email address, can be null or undefined
  */
 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"),
+    id: z.string(),
+    firstName: z.string().optional().nullable(),
+    lastName: z.string().optional().nullable(),
+    displayName: z.string(),
+    phone: z.string().optional().nullable(),
+    accountNo: z.string().min(1),
+    email: z.string().email().optional().nullable(),
 });
+/**
+ * Represents a user profile in the system.
+ *
+ * This class provides methods for creating, validating, and manipulating user profile data.
+ * It integrates with the Zod schema validation for data integrity.
+ */
+export class Profile {
+    /**
+     * Gets the profile schema used for validation.
+     */
+    static get schema() {
+        return profileSchema;
+    }
+    /**
+     * Creates a new Profile instance with the provided data.
+     *
+     * Private constructor to enforce use of static factory methods.
+     *
+     * @param data - Object containing profile information
+     */
+    constructor(data) {
+        /** Unique identifier for the profile */
+        Object.defineProperty(this, "_id", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** User's first name */
+        Object.defineProperty(this, "_firstName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** User's last name */
+        Object.defineProperty(this, "_lastName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** User's display name, can be used for presentation */
+        Object.defineProperty(this, "_displayName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** User's phone number, stored as a PhoneNumber object */
+        Object.defineProperty(this, "_phone", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** User's account number */
+        Object.defineProperty(this, "_accountNo", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** User's email address */
+        Object.defineProperty(this, "_email", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this._id = data.id;
+        this._firstName = data.firstName;
+        this._lastName = data.lastName;
+        this._displayName = data.displayName;
+        this._phone = data.phone;
+        this._accountNo = data.accountNo;
+        this._email = data.email;
+    }
+    /**
+     * Creates a new Profile instance with the provided data.
+     *
+     * @param data - Object containing profile information.
+     */
+    static create(data) {
+        let phoneObj = undefined;
+        if (data.phone !== undefined && data.phone !== null) {
+            phoneObj = PhoneNumber.from(data.phone);
+            if (!phoneObj) {
+                console.error("Failed to parse phone number:", data.phone);
+                return undefined;
+            }
+        }
+        else {
+            phoneObj = data.phone; // Preserve null or undefined
+        }
+        return new Profile({
+            id: data.id,
+            firstName: data.firstName,
+            lastName: data.lastName,
+            displayName: data.displayName,
+            phone: phoneObj,
+            accountNo: data.accountNo,
+            email: data.email,
+        });
+    }
+    /**
+     * Gets the profile's unique identifier.
+     */
+    get id() {
+        return this._id;
+    }
+    /**
+     * Gets the user's first name.
+     */
+    get firstName() {
+        return this._firstName;
+    }
+    /**
+     * Gets the user's last name.
+     */
+    get lastName() {
+        return this._lastName;
+    }
+    /**
+     * Gets the user's display name.
+     */
+    get displayName() {
+        return this._displayName;
+    }
+    /**
+     * Gets the user's phone number object.
+     */
+    get phone() {
+        return this._phone;
+    }
+    /**
+     * Gets the user's account number.
+     */
+    get accountNo() {
+        return this._accountNo;
+    }
+    /**
+     * Gets the user's email address.
+     */
+    get email() {
+        return this._email;
+    }
+    /**
+     * Gets the user's formatted phone number in international format.
+     */
+    get formattedPhone() {
+        if (this._phone === undefined) {
+            return undefined;
+        }
+        return this._phone?.label ?? null;
+    }
+    /**
+     * Gets the user's name for display purposes.
+     * Returns the display name if it exists, otherwise returns the first and last name combined.
+     */
+    getName() {
+        if (this._displayName && this._displayName.trim() !== "") {
+            return this._displayName;
+        }
+        const firstName = this._firstName ?? "";
+        const lastName = this._lastName ?? "";
+        return `${firstName} ${lastName}`.trim();
+    }
+    /**
+     * Creates a plain object representation of the profile for validation or serialization.
+     *
+     * @returns A plain object matching the ProfileType interface
+     */
+    toObject() {
+        // Handle the phone specially to ensure we preserve undefined vs null
+        let phoneString = undefined;
+        if (this._phone !== undefined) {
+            phoneString = this._phone?.label ?? null;
+        }
+        return {
+            id: this._id,
+            firstName: this._firstName,
+            lastName: this._lastName,
+            displayName: this._displayName,
+            phone: phoneString,
+            accountNo: this._accountNo,
+            email: this._email,
+        };
+    }
+    /**
+     * Converts the profile to a JSON string.
+     *
+     * @returns A JSON string representation of the profile
+     */
+    toJSON() {
+        return JSON.stringify(this.toObject());
+    }
+    /**
+     * Validates the profile data against the Zod schema.
+     *
+     * @returns True if the profile is valid, false otherwise
+     */
+    validate() {
+        try {
+            const result = Profile.schema.safeParse(this.toObject());
+            return result.success;
+        }
+        catch (error) {
+            console.error("Profile validation error:", error);
+            return false;
+        }
+    }
+    /**
+     * Creates a Profile instance from a JSON string.
+     *
+     * @param jsonString - JSON string containing profile data
+     * @returns A new Profile instance, or undefined if parsing failed
+     */
+    static fromJSON(jsonString) {
+        try {
+            const data = JSON.parse(jsonString);
+            return Profile.from(data);
+        }
+        catch (error) {
+            console.error("Error parsing profile JSON:", error);
+            return undefined;
+        }
+    }
+    /**
+     * Creates a Profile instance from a plain object.
+     *
+     * @param data - Object containing profile data
+     * @returns A new Profile instance, or undefined if parsing failed
+     */
+    // deno-lint-ignore no-explicit-any
+    static from(data) {
+        try {
+            if (!data) {
+                console.error("Data is null or undefined");
+                return undefined;
+            }
+            if (typeof data !== "object") {
+                console.error("Data is not an object");
+                return undefined;
+            }
+            if (!data.id || !data.accountNo || !data.displayName) {
+                console.error("Missing required profile fields");
+                return undefined;
+            }
+            return Profile.create({
+                id: data.id,
+                firstName: data.firstName,
+                lastName: data.lastName,
+                displayName: data.displayName,
+                phone: data.phone,
+                accountNo: data.accountNo,
+                email: data.email,
+            });
+        }
+        catch (error) {
+            console.error("Error creating profile from object:", error);
+            return undefined;
+        }
+    }
+    /**
+     * Type guard to check if an unknown object is a valid Profile instance.
+     *
+     * @param obj - The object to check
+     * @returns Type predicate indicating if the object is a valid Profile
+     */
+    static is(obj) {
+        if (!obj || typeof obj !== "object")
+            return false;
+        const maybeProfile = obj;
+        // Check required properties
+        if (typeof maybeProfile._id !== "string" ||
+            typeof maybeProfile._displayName !== "string" ||
+            typeof maybeProfile._accountNo !== "string") {
+            return false;
+        }
+        // Check nullable/optional properties have the right type when present
+        if (maybeProfile._firstName !== null &&
+            maybeProfile._firstName !== undefined &&
+            typeof maybeProfile._firstName !== "string") {
+            return false;
+        }
+        if (maybeProfile._lastName !== null &&
+            maybeProfile._lastName !== undefined &&
+            typeof maybeProfile._lastName !== "string") {
+            return false;
+        }
+        if (maybeProfile._email !== null &&
+            maybeProfile._email !== undefined &&
+            typeof maybeProfile._email !== "string") {
+            return false;
+        }
+        // Check phone number
+        const phone = maybeProfile._phone;
+        if (phone !== null &&
+            phone !== undefined &&
+            !PhoneNumber.is(phone)) {
+            return false;
+        }
+        return true;
+    }
+}

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

@@ -1,6 +1,6 @@
-import type { Profile } from "./profile.js";
+import { Profile } from "./profile.js";
 /**
- * Represents a user in Afloat
+ * 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.
@@ -38,19 +38,10 @@ export declare class User {
     /**
      * Creates a new instance of the `User` class.
      *
-     * @param userData - An object of type `CoreUser` containing the user's profile, token,
+     * @param userData - An object 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;
-        };
-    });
+    private constructor();
     /**
      * Checks if the user has a specific permission.
      *
@@ -62,7 +53,7 @@ export declare class User {
      * Serializes the `User` instance to a JSON string.
      *
      * @returns A JSON string representation of the `User` instance, including:
-     * - `profile`: The user's profile information.
+     * - `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.
@@ -72,9 +63,15 @@ export declare class User {
      * 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.
+     * @returns A `User` instance reconstructed from the JSON data, or undefined if jsonString is invalid.
      */
-    static fromJSON(jsonString: string): User;
+    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=user.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../../../src/src/models/user/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;IA6BP;;;;;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"}

package/esm/src/models/user/user.js

@@ -1,6 +1,8 @@
+// deno-lint-ignore-file no-explicit-any
 import { Permissions } from "../permission.js";
+import { Profile } from "./profile.js";
 /**
- * Represents a user in Afloat
+ * 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.
@@ -9,7 +11,7 @@ export class User {
     /**
      * Creates a new instance of the `User` class.
      *
-     * @param userData - An object of type `CoreUser` containing the user's profile, token,
+     * @param userData - An object containing the user's profile, token,
      * permissions (access list), and the `resetPassword` flag.
      */
     constructor(data) {
@@ -72,12 +74,12 @@ export class User {
             writable: true,
             value: void 0
         });
-        const { profile, token, access, resetPassword } = data;
+        const { profile, token, access, resetPassword, name, identity } = data;
         this.profile = profile;
         this.token = token;
         this.resetPassword = resetPassword;
-        this.name = data.loginCredentials.name;
-        this.identity = data.loginCredentials.identity;
+        this.name = name;
+        this.identity = identity;
         // Initialize the permissions map
         this.permissionsMap = {};
         for (const permission of Object.values(Permissions)) {
@@ -86,6 +88,9 @@ export class User {
                     this.permissionsMap[perm] = access.includes(perm);
                 });
             }
+            else {
+                this.permissionsMap[permission] = access.includes(permission);
+            }
         }
     }
     /**
@@ -101,14 +106,14 @@ export class User {
      * Serializes the `User` instance to a JSON string.
      *
      * @returns A JSON string representation of the `User` instance, including:
-     * - `profile`: The user's profile information.
+     * - `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() {
         return JSON.stringify({
-            profile: this.profile,
+            profile: this.profile.toObject(),
             token: this.token,
             resetPassword: this.resetPassword,
             name: this.name,
@@ -120,29 +125,107 @@ export class User {
      * 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.
+     * @returns A `User` instance reconstructed from the JSON data, or undefined if jsonString is invalid.
      */
     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");
+        try {
+            return User.from(JSON.parse(jsonString));
+        }
+        catch (e) {
+            console.error("Invalid JSON string:", e);
+            return 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) {
+        let parsedData;
+        // Parse JSON string if needed
+        if (typeof data === "string") {
+            try {
+                parsedData = JSON.parse(data);
+            }
+            catch (error) {
+                console.error("Invalid JSON string:", error);
+                return undefined;
+            }
+        }
+        else {
+            parsedData = data;
+        }
+        if (!parsedData) {
+            console.error("Data is null or undefined.");
+            return undefined;
+        }
+        // Handle different profile formats
+        let profile;
+        let rawProfile = parsedData.profile;
+        // Handle stringified profile (the case in the provided sample)
+        if (typeof rawProfile === "string") {
+            try {
+                // Attempt to parse the stringified profile
+                rawProfile = JSON.parse(rawProfile);
+            }
+            catch (error) {
+                console.error("Failed to parse profile JSON string:", error);
+                return undefined;
+            }
+        }
+        // Create Profile instance based on what we received
+        if (Profile.is(rawProfile)) {
+            // Already a Profile instance
+            profile = rawProfile;
+        }
+        else if (typeof rawProfile === "object" && rawProfile !== null) {
+            // Convert object to Profile instance
+            profile = Profile.from(rawProfile);
+            if (!profile) {
+                console.error("Failed to create Profile from data:", rawProfile);
+                return undefined;
+            }
+        }
+        else if (typeof rawProfile === "string") {
+            profile = Profile.fromJSON(rawProfile);
+            if (!profile) {
+                console.error("Failed to create Profile from JSON data:", rawProfile);
+                return undefined;
+            }
+        }
+        else {
+            console.error("Invalid profile format:", typeof rawProfile);
+            return undefined;
+        }
+        // Validate other required fields
+        if (!parsedData.token || typeof parsedData.token !== "string" ||
+            !parsedData.name || typeof parsedData.name !== "string" ||
+            !parsedData.identity || typeof parsedData.identity !== "string" ||
+            !Array.isArray(parsedData.permissions) &&
+                !Array.isArray(parsedData.access) ||
+            typeof parsedData.resetPassword !== "boolean") {
+            console.error("Missing or invalid required User fields:", {
+                token: typeof parsedData.token,
+                name: typeof parsedData.name,
+                identity: typeof parsedData.identity,
+                permissions: Array.isArray(parsedData.permissions),
+                access: Array.isArray(parsedData.access),
+                resetPassword: typeof parsedData.resetPassword,
+            });
+            return undefined;
         }
-        // Reconstruct the CoreUser structure
+        // Support both 'permissions' and 'access' field names
+        const access = parsedData.access || parsedData.permissions;
+        // Create and return the User instance
         const args = {
-            profile: data.profile,
-            token: data.token,
-            access: data.permissions,
-            resetPassword: data.resetPassword,
-            loginCredentials: {
-                name: data.name,
-                identity: data.identity,
-            },
+            profile: profile,
+            token: parsedData.token,
+            access: access,
+            resetPassword: parsedData.resetPassword,
+            name: parsedData.name,
+            identity: parsedData.identity,
         };
         return new User(args);
     }

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

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

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

@@ -1 +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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/src/models/wallet/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}

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

@@ -1,3 +1,2 @@
 export * from "./guards.js";
 export * from "./schemas.js";
-export * from "./statement.js";