@temboplus/afloat 0.1.0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,64 @@
+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} debitOrCredit - Indicator if transaction is debit or credit
+ * @property {string} tranRefNo - Transaction reference number
+ * @property {string} narration - Description of the transaction
+ * @property {Date} txnDate - Date when transaction was initiated
+ * @property {Date} valueDate - Date when transaction value was applied
+ * @property {number} amountCredited - Amount credited in transaction (if credit)
+ * @property {number} amountDebited - Amount debited in transaction (if debit)
+ * @property {number} balance - Running balance after transaction
+ */
+const statementEntrySchema = z.object({
+    accountNo: makeOptional(z.string()),
+    cbaRefNo: makeOptional(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"),
+    txnDate: z.coerce.date(),
+    valueDate: z.coerce.date(),
+    amountCredited: z.number().min(0, "Credited amount must be non-negative"),
+    amountDebited: z.number().min(0, "Debited amount must be non-negative"),
+    balance: z.number(),
+});
+/**
+ * Schema definition for a wallet.
+ * Represents a digital wallet that can hold funds and process transactions.
+ *
+ * @property {string} id - Unique identifier for the wallet
+ * @property {string} profileId - ID of the profile that owns this wallet
+ * @property {string} accountNo - Account number associated with the wallet
+ * @property {string} accountName - Name of the account holder
+ * @property {string} channel - Payment channel or provider (e.g., "MPESA", "BANK")
+ * @property {string} createdAt - ISO datetime string of wallet creation
+ * @property {string} updatedAt - ISO datetime string of last wallet update
+ */
+const walletSchema = z.object({
+    id: z.string().uuid("Invalid wallet ID format"),
+    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"),
+    channel: z.string().min(1, "Channel is required"),
+    createdAt: z.string().datetime("Invalid creation timestamp"),
+    updatedAt: z.string().datetime("Invalid update timestamp"),
+});
+/**
+ * Collection of wallet-related schemas for export.
+ * Provides access to both wallet and statement entry validation schemas.
+ */
+export const WalletSchemas = {
+    wallet: walletSchema,
+    statementEntry: statementEntrySchema,
+};

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

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

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

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

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

@@ -0,0 +1,13 @@
+/**
+ * Enum representing the supported output formats for statement generation.
+ * Used to specify the desired file format when requesting statement downloads.
+ *
+ * @enum {string}
+ */
+export var STATEMENT_OUTPUT_TYPE;
+(function (STATEMENT_OUTPUT_TYPE) {
+    /** Generate statement as a PDF document */
+    STATEMENT_OUTPUT_TYPE["PDF"] = "PDF";
+    /** Generate statement as an Excel spreadsheet */
+    STATEMENT_OUTPUT_TYPE["EXCEL"] = "EXCEL";
+})(STATEMENT_OUTPUT_TYPE || (STATEMENT_OUTPUT_TYPE = {}));

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

@@ -0,0 +1,56 @@
+import { type AppRouter } from "@ts-rest/core";
+import type { InitClientArgs } from "@ts-rest/core";
+/**
+ * BaseRepository
+ *
+ * A generic base class to build repositories for interacting with the Afloat API.
+ * This class initializes a "ts-rest" client using a specified "ts-rest" contract and provides
+ * helper methods to handle API responses consistently.
+ *
+ * @template TContract - The API contract extending `AppRouter` from `@npm/ts_rest.ts`.
+ */
+export declare class BaseRepository<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;
+    /**
+     * Constructs a new instance of `BaseRepository`.
+     *
+     * @param contract - The "ts-rest" contract
+     * @param endpoint - API endpoint
+     */
+    constructor(endpoint: string, contract: TContract, args?: {
+        root?: string;
+    });
+    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; };
+    /**
+     * 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=base_repository.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"base_repository.d.ts","sourceRoot":"","sources":["../../../src/src/shared/base_repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAc,MAAM,eAAe,CAAC;AAG3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAIpD;;;;;;;;GAQG;AACH,qBAAa,cAAc,CAAC,SAAS,SAAS,SAAS;IACrD;;;;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;;;;;OAKG;gBACS,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE;IAM3E,IAAI,MAAM,k0LAcT;IAED;;;;;;;;;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/base_repository.js

@@ -0,0 +1,95 @@
+import { initClient } from "@ts-rest/core";
+import { APIError } from "../errors/api_error.js";
+import { v4 as uuidv4 } from "uuid";
+import { AfloatAuth } from "../features/auth/index.js";
+/**
+ * BaseRepository
+ *
+ * A generic base class to build repositories for interacting with the Afloat API.
+ * This class initializes a "ts-rest" client using a specified "ts-rest" contract and provides
+ * helper methods to handle API responses consistently.
+ *
+ * @template TContract - The API contract extending `AppRouter` from `@npm/ts_rest.ts`.
+ */
+export class BaseRepository {
+    /**
+     * Constructs a new instance of `BaseRepository`.
+     *
+     * @param contract - The "ts-rest" contract
+     * @param endpoint - API endpoint
+     */
+    constructor(endpoint, contract, args) {
+        /**
+         * 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
+        });
+        this.contract = contract;
+        this.endpoint = endpoint;
+        this.root = args?.root;
+    }
+    get client() {
+        const baseUrl = this.root
+            ? `${this.root}/${this.endpoint}`
+            : `https://api.afloat.money/v1/${this.endpoint}`;
+        const args = {
+            baseUrl,
+            baseHeaders: {
+                "token": AfloatAuth.instance.getUserToken() ?? "",
+                "x-request-id": uuidv4(),
+            },
+        };
+        return initClient(this.contract, args);
+    }
+    /**
+     * 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/esm/src/shared/common_responses.d.ts

@@ -0,0 +1,13 @@
+import type { AppRouteResponse } from "@ts-rest/core";
+import { z } from "zod";
+type ApiErrorResponseSchemaType = z.ZodObject<{
+    statusCode: z.ZodNumber;
+    message: z.ZodString;
+    error: z.ZodString;
+    details: z.ZodOptional<z.ZodRecord>;
+}>;
+export declare const common400ResponseSchema: ApiErrorResponseSchemaType;
+export type Common400APIResponse = z.infer<typeof common400ResponseSchema>;
+export declare const commonAPIResponses: Record<number, AppRouteResponse>;
+export {};
+//# sourceMappingURL=common_responses.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"common_responses.d.ts","sourceRoot":"","sources":["../../../src/src/shared/common_responses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,KAAK,0BAA0B,GAAG,CAAC,CAAC,SAAS,CAAC;IAC5C,UAAU,EAAE,CAAC,CAAC,SAAS,CAAC;IACxB,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC;IACrB,KAAK,EAAE,CAAC,CAAC,SAAS,CAAC;IACnB,OAAO,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;CACrC,CAAC,CAAC;AACH,eAAO,MAAM,uBAAuB,EAAE,0BAKpC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAE3E,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAE/D,CAAC"}

package/esm/src/shared/common_responses.js

@@ -0,0 +1,10 @@
+import { z } from "zod";
+export const common400ResponseSchema = z.object({
+    statusCode: z.number(),
+    message: z.string(),
+    error: z.string(),
+    details: z.record(z.string()).optional(),
+});
+export const commonAPIResponses = {
+    400: common400ResponseSchema,
+};

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/src/shared/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC"}

package/esm/src/shared/index.js

@@ -0,0 +1,2 @@
+export * from "./common_responses.js";
+export * from "./base_repository.js";

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@temboplus/afloat",
+  "version": "0.1.0",
+  "description": "A JavaScript/TypeScript package providing common utilities and logic shared across all Temboplus-Afloat Projects",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TemboPlus-Frontend/afloat-js"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/TemboPlus-Frontend/afloat-js/issues"
+  },
+  "main": "./script/mod.js",
+  "module": "./esm/mod.js",
+  "exports": {
+    ".": {
+      "import": "./esm/mod.js",
+      "require": "./script/mod.js"
+    }
+  },
+  "scripts": {
+    "test": "node test_runner.js"
+  },
+  "private": false,
+  "dependencies": {
+    "@temboplus/frontend-core": "^0.1.0",
+    "@ts-rest/core": "^3.51.0",
+    "antd": "^5.22.7",
+    "uuid": "^11.0.3",
+    "zod": "^3.24.1",
+    "zustand": "^5.0.2"
+  },
+  "devDependencies": {
+    "@types/node": "^20.9.0",
+    "picocolors": "^1.0.0",
+    "@faker-js/faker": "9.3.0",
+    "@deno/shim-deno": "~0.18.0"
+  },
+  "_generatedBy": "dnt@dev"
+}

package/script/_dnt.test_shims.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_dnt.test_shims.d.ts","sourceRoot":"","sources":["../src/_dnt.test_shims.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAKvC,eAAO,MAAM,aAAa;;CAA2C,CAAC"}

package/script/deps/jsr.io/@std/assert/1.0.10/almost_equals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"almost_equals.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/1.0.10/almost_equals.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,SAAS,CAAC,EAAE,MAAM,EAClB,GAAG,CAAC,EAAE,MAAM,QAmBb"}

package/script/deps/jsr.io/@std/assert/1.0.10/array_includes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"array_includes.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/1.0.10/array_includes.ts"],"names":[],"mappings":"AAMA,0FAA0F;AAC1F,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EACnC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EACvB,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,EACzB,GAAG,CAAC,EAAE,MAAM,QAwBb"}

package/script/deps/jsr.io/@std/assert/1.0.10/assert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/1.0.10/assert.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;GAaG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,SAAK,GAAG,OAAO,CAAC,IAAI,CAI5D"}

package/script/deps/jsr.io/@std/assert/1.0.10/assertion_error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertion_error.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/1.0.10/assertion_error.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,cAAe,SAAQ,KAAK;IACvC;;;;OAIG;gBACS,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;CAIpD"}

package/script/deps/jsr.io/@std/assert/1.0.10/equal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"equal.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/1.0.10/equal.ts"],"names":[],"mappings":"AA2FA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,CAuGrD"}

package/script/deps/jsr.io/@std/assert/1.0.10/equals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"equals.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/1.0.10/equals.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,MAAM,EAAE,CAAC,EACT,QAAQ,EAAE,CAAC,EACX,GAAG,CAAC,EAAE,MAAM,QAkBb"}

package/script/deps/jsr.io/@std/assert/1.0.10/exists.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exists.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/1.0.10/exists.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,MAAM,EAAE,CAAC,EACT,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,MAAM,IAAI,WAAW,CAAC,CAAC,CAAC,CAOlC"}

package/script/deps/jsr.io/@std/assert/1.0.10/fail.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fail.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/1.0.10/fail.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;GAYG;AACH,wBAAgB,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,CAGxC"}