@temboplus/afloat 0.1.13 → 0.1.31

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/guards.d.ts.map

@@ -1 +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"}
+{"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,CAQ/B"}

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

@@ -9,6 +9,12 @@ import { WalletSchemas, } from "./schemas.js";
  *                    false otherwise
  */
 export function isWalletStatementItemArray(data) {
-    const result = z.array(WalletSchemas.statementEntry).safeParse(data);
-    return result.success;
+    try {
+        z.array(WalletSchemas.statementEntry).parse(data);
+        return true;
+    }
+    catch (error) {
+        console.log("isWalletStatementItemArray?: false. Why?: ", error);
+        return false;
+    }
 }

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";

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

@@ -4,8 +4,7 @@ import { z } from "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>>;
+    accountNo: z.ZodString;
     debitOrCredit: z.ZodString;
     tranRefNo: z.ZodString;
     narration: z.ZodString;

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

@@ -1 +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"}
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../../src/src/models/wallet/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,KAAK,mBAAmB,GAAG,CAAC,CAAC,SAAS,CAAC;IACrC,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC;IACvB,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;AA4BH;;;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/esm/src/models/wallet/schemas.js

@@ -1,17 +1,9 @@
 import { z } from "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} accountNo - The account number associated with the transaction
  * @property {string} debitOrCredit - Indicator if transaction is debit or credit
  * @property {string} tranRefNo - Transaction reference number
  * @property {string} narration - Description of the transaction
@@ -22,8 +14,7 @@ const makeOptional = (schema) => schema.optional().transform((val) => val ?? und
  * @property {number} balance - Running balance after transaction
  */
 const statementEntrySchema = z.object({
-    accountNo: makeOptional(z.string()),
-    cbaRefNo: makeOptional(z.string()),
+    accountNo: z.string(),
     debitOrCredit: z.string().min(1, "Transaction type is required"),
     tranRefNo: z.string().min(1, "Transaction reference is required"),
     narration: z.string().min(1, "Transaction description is required"),
@@ -46,7 +37,7 @@ const statementEntrySchema = z.object({
  * @property {string} updatedAt - ISO datetime string of last wallet update
  */
 const walletSchema = z.object({
-    id: z.string().uuid("Invalid wallet ID format"),
+    id: z.string().min(1),
     profileId: z.string().min(1, "Profile ID is required"),
     accountNo: z.string().min(1, "Account number is required"),
     accountName: z.string().min(1, "Account name is required"),

package/esm/src/shared/token_required_repository.d.ts

@@ -0,0 +1,78 @@
+import { type AppRouter } from "@ts-rest/core";
+import type { InitClientArgs } from "@ts-rest/core";
+/**
+ * TokenRequiredRepository
+ *
+ * A generic base class to build repositories for interacting with the API,
+ * without any dependency on AfloatAuth. Instead, it requires token to be
+ * explicitly provided when initializing the repository.
+ *
+ * @template TContract - The API contract extending `AppRouter` from `@ts-rest/core`.
+ */
+export declare class TokenRequiredRepository<TContract extends AppRouter> {
+    /**
+     * A "ts-rest" contract
+     *
+     * @protected
+     */
+    protected contract: TContract;
+    /**
+     * An API endpoint
+     *
+     * @protected
+     */
+    protected endpoint: string;
+    /**
+     * An API Root URL
+     *
+     * @protected
+     */
+    protected root: string | undefined;
+    /**
+     * Authentication token
+     *
+     * @protected
+     */
+    protected token: string;
+    /**
+     * Constructs a new instance of `TokenRequiredRepository`.
+     *
+     * @param endpoint - API endpoint
+     * @param contract - The "ts-rest" contract
+     * @param token - Authentication token (required)
+     * @param root - Optional API root URL
+     */
+    constructor(endpoint: string, contract: TContract, token: string, root?: string);
+    /**
+     * Gets the initialized client for making API requests.
+     * Uses the provided authentication token.
+     */
+    get client(): { [TKey in keyof TContract]: TContract[TKey] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey], InitClientArgs>> : TContract[TKey] extends AppRouter ? TContract[TKey] extends infer T extends AppRouter ? { [TKey_1 in keyof T]: TContract[TKey][TKey_1] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1], InitClientArgs>> : TContract[TKey][TKey_1] extends AppRouter ? TContract[TKey][TKey_1] extends infer T_1 extends AppRouter ? { [TKey_2 in keyof T_1]: TContract[TKey][TKey_1][TKey_2] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2] extends AppRouter ? TContract[TKey][TKey_1][TKey_2] extends infer T_2 extends AppRouter ? { [TKey_3 in keyof T_2]: TContract[TKey][TKey_1][TKey_2][TKey_3] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2][TKey_3], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2][TKey_3], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2][TKey_3] extends AppRouter ? TContract[TKey][TKey_1][TKey_2][TKey_3] extends infer T_3 extends AppRouter ? { [TKey_4 in keyof T_3]: TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4] extends AppRouter ? TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4] extends infer T_4 extends AppRouter ? { [TKey_5 in keyof T_4]: TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5] extends AppRouter ? TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5] extends infer T_5 extends AppRouter ? { [TKey_6 in keyof T_5]: TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6] extends AppRouter ? TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6] extends infer T_6 extends AppRouter ? { [TKey_7 in keyof T_6]: TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7] extends AppRouter ? TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7] extends infer T_7 extends AppRouter ? { [TKey_8 in keyof T_7]: TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8] extends AppRouter ? TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8] extends infer T_8 extends AppRouter ? { [TKey_9 in keyof T_8]: TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9] extends AppRouter ? TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9] extends infer T_9 extends AppRouter ? { [TKey_10 in keyof T_9]: TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9][TKey_10] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9][TKey_10], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9][TKey_10], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9][TKey_10] extends AppRouter ? any : never; } : never : never; } : never : never; } : never : never; } : never : never; } : never : never; } : never : never; } : never : never; } : never : never; } : never : never; } : never : never; };
+    /**
+     * Updates the token used by this repository
+     *
+     * @param token - New authentication token
+     */
+    setToken(token: string): void;
+    /**
+     * Gets the current token
+     *
+     * @returns The current authentication token
+     */
+    getToken(): string;
+    /**
+     * Handles the API response by checking the HTTP status code and returning the response body
+     * for successful requests or throwing an `APIError` for errors.
+     *
+     * @template T - The expected type of the successful response body.
+     * @param result - The API response object containing the status code and response body.
+     * @param successStatusCode - The expected HTTP status code indicating success (e.g., 200, 201).
+     * @returns The response body typed as `T` if the status code matches the success criteria.
+     * @throws `APIError` - If the status code indicates a failure.
+     */
+    handleResponse<T>(result: {
+        status: number;
+        body: unknown;
+    }, successStatusCode: number): T;
+}
+//# sourceMappingURL=token_required_repository.d.ts.map

package/esm/src/shared/token_required_repository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"token_required_repository.d.ts","sourceRoot":"","sources":["../../../src/src/shared/token_required_repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAc,MAAM,eAAe,CAAC;AAG3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAGpD;;;;;;;;GAQG;AACH,qBAAa,uBAAuB,CAAC,SAAS,SAAS,SAAS;IAC9D;;;;OAIG;IACH,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC;IAE9B;;;;OAIG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;;;OAIG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC;IAExB;;;;;;;OAOG;gBAED,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,SAAS,EACnB,KAAK,EAAE,MAAM,EACb,IAAI,CAAC,EAAE,MAAM;IAQf;;;OAGG;IACH,IAAI,MAAM,k0LAcT;IAED;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI7B;;;;OAIG;IACH,QAAQ,IAAI,MAAM;IAIlB;;;;;;;;;OASG;IACH,cAAc,CAAC,CAAC,EACd,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,EACzC,iBAAiB,EAAE,MAAM,GACxB,CAAC;CAgBL"}

package/esm/src/shared/token_required_repository.js

@@ -0,0 +1,128 @@
+import { initClient } from "@ts-rest/core";
+import { APIError } from "../errors/api_error.js";
+import { v4 as uuidv4 } from "uuid";
+/**
+ * TokenRequiredRepository
+ *
+ * A generic base class to build repositories for interacting with the API,
+ * without any dependency on AfloatAuth. Instead, it requires token to be
+ * explicitly provided when initializing the repository.
+ *
+ * @template TContract - The API contract extending `AppRouter` from `@ts-rest/core`.
+ */
+export class TokenRequiredRepository {
+    /**
+     * Constructs a new instance of `TokenRequiredRepository`.
+     *
+     * @param endpoint - API endpoint
+     * @param contract - The "ts-rest" contract
+     * @param token - Authentication token (required)
+     * @param root - Optional API root URL
+     */
+    constructor(endpoint, contract, token, root) {
+        /**
+         * A "ts-rest" contract
+         *
+         * @protected
+         */
+        Object.defineProperty(this, "contract", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * An API endpoint
+         *
+         * @protected
+         */
+        Object.defineProperty(this, "endpoint", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * An API Root URL
+         *
+         * @protected
+         */
+        Object.defineProperty(this, "root", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * Authentication token
+         *
+         * @protected
+         */
+        Object.defineProperty(this, "token", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.contract = contract;
+        this.endpoint = endpoint;
+        this.token = token;
+        this.root = root;
+    }
+    /**
+     * Gets the initialized client for making API requests.
+     * Uses the provided authentication token.
+     */
+    get client() {
+        const baseUrl = this.root
+            ? `${this.root}/${this.endpoint}`
+            : `https://api.afloat.money/v1/${this.endpoint}`;
+        const args = {
+            baseUrl,
+            baseHeaders: {
+                "token": this.token,
+                "x-request-id": uuidv4(),
+            },
+        };
+        return initClient(this.contract, args);
+    }
+    /**
+     * Updates the token used by this repository
+     *
+     * @param token - New authentication token
+     */
+    setToken(token) {
+        this.token = token;
+    }
+    /**
+     * Gets the current token
+     *
+     * @returns The current authentication token
+     */
+    getToken() {
+        return this.token;
+    }
+    /**
+     * Handles the API response by checking the HTTP status code and returning the response body
+     * for successful requests or throwing an `APIError` for errors.
+     *
+     * @template T - The expected type of the successful response body.
+     * @param result - The API response object containing the status code and response body.
+     * @param successStatusCode - The expected HTTP status code indicating success (e.g., 200, 201).
+     * @returns The response body typed as `T` if the status code matches the success criteria.
+     * @throws `APIError` - If the status code indicates a failure.
+     */
+    handleResponse(result, successStatusCode) {
+        if (successStatusCode === result.status) {
+            return result.body;
+        }
+        if (result.status === 400) {
+            throw new APIError(result.body);
+        }
+        throw new APIError({
+            message: "We encountered an error trying to process your request. Please try again later",
+            statusCode: 520,
+            error: "UNKNOWN ERROR",
+        });
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temboplus/afloat",
-  "version": "0.1.13",
+  "version": "0.1.31",
   "description": "A JavaScript/TypeScript package providing common utilities and logic shared across all Temboplus-Afloat Projects",
   "repository": {
     "type": "git",
@@ -23,12 +23,12 @@
   },
   "private": false,
   "dependencies": {
-    "@temboplus/frontend-core": "^0.2.0",
-    "@ts-rest/core": "^3.51.0",
-    "antd": "^5.22.7",
-    "uuid": "^11.0.3",
-    "zod": "^3.24.1",
-    "zustand": "^5.0.2"
+    "@temboplus/frontend-core": "^0.2.4",
+    "@ts-rest/core": "^3.52.1",
+    "antd": "^5.24.5",
+    "uuid": "^11.1.0",
+    "zod": "^3.24.2",
+    "zustand": "^5.0.3"
   },
   "devDependencies": {
     "@types/node": "^20.9.0",

package/script/src/features/auth/access/contract.d.ts

@@ -0,0 +1,14 @@
+import { z } from "zod";
+/**
+ * Auth API contract
+ */
+export declare const accessContract: {
+    getAccessList: {
+        method: "GET";
+        path: "/access";
+        responses: {
+            200: z.ZodArray<z.ZodString, "many">;
+        };
+    };
+};
+//# sourceMappingURL=contract.d.ts.map

package/script/src/features/auth/access/contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../../../../../src/src/features/auth/access/contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;;;;CAQzB,CAAC"}

package/script/src/features/auth/access/contract.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.accessContract = void 0;
+const zod_1 = require("zod");
+const core_1 = require("@ts-rest/core");
+/**
+ * Auth API contract
+ */
+exports.accessContract = (0, core_1.initContract)().router({
+    getAccessList: {
+        method: "GET",
+        path: "/access",
+        responses: {
+            200: zod_1.z.string().array(),
+        },
+    },
+});

package/script/src/features/auth/contract.d.ts

@@ -23,28 +23,28 @@ export declare const authContract: {
             201: z.ZodObject<{
                 profile: z.ZodObject<{
                     id: z.ZodString;
-                    firstName: z.ZodString;
-                    lastName: z.ZodString;
+                    firstName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                    lastName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
                     displayName: z.ZodString;
-                    phone: z.ZodString;
+                    phone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
                     accountNo: z.ZodString;
-                    email: z.ZodString;
+                    email: z.ZodNullable<z.ZodOptional<z.ZodString>>;
                 }, z.UnknownKeysParam, z.ZodTypeAny, {
                     id: string;
-                    firstName: string;
-                    lastName: string;
                     displayName: string;
-                    phone: string;
                     accountNo: string;
-                    email: string;
+                    firstName?: string | null | undefined;
+                    lastName?: string | null | undefined;
+                    phone?: string | null | undefined;
+                    email?: string | null | undefined;
                 }, {
                     id: string;
-                    firstName: string;
-                    lastName: string;
                     displayName: string;
-                    phone: string;
                     accountNo: string;
-                    email: string;
+                    firstName?: string | null | undefined;
+                    lastName?: string | null | undefined;
+                    phone?: string | null | undefined;
+                    email?: string | null | undefined;
                 }>;
                 token: z.ZodString;
                 access: z.ZodArray<z.ZodString, "many">;
@@ -53,12 +53,12 @@ export declare const authContract: {
                 resetPassword: boolean;
                 profile: {
                     id: string;
-                    firstName: string;
-                    lastName: string;
                     displayName: string;
-                    phone: string;
                     accountNo: string;
-                    email: string;
+                    firstName?: string | null | undefined;
+                    lastName?: string | null | undefined;
+                    phone?: string | null | undefined;
+                    email?: string | null | undefined;
                 };
                 token: string;
                 access: string[];
@@ -66,12 +66,12 @@ export declare const authContract: {
                 resetPassword: boolean;
                 profile: {
                     id: string;
-                    firstName: string;
-                    lastName: string;
                     displayName: string;
-                    phone: string;
                     accountNo: string;
-                    email: string;
+                    firstName?: string | null | undefined;
+                    lastName?: string | null | undefined;
+                    phone?: string | null | undefined;
+                    email?: string | null | undefined;
                 };
                 token: string;
                 access: string[];

package/script/src/features/auth/contract.js

@@ -18,7 +18,7 @@ exports.authContract = (0, core_1.initContract)().router({
         }),
         responses: {
             201: zod_1.z.object({
-                profile: index_js_1.profileSchema,
+                profile: index_js_1.Profile.schema,
                 token: zod_1.z.string(),
                 access: zod_1.z.array(zod_1.z.string()),
                 resetPassword: zod_1.z.boolean(),