@temboplus/afloat 0.1.56 → 0.1.58

package/esm/src/errors/api_error.js

@@ -0,0 +1,90 @@
+import { z } from "zod";
+/**
+ * Custom error class representing API-related errors.
+ * Extends the built-in `Error` class to include additional properties such as `statusCode`, `error`, and `details`.
+ */
+export class APIError extends Error {
+    /**
+     * Creates a new `APIError` instance.
+     * @param {Object} args - The arguments to initialize the error.
+     * @param {string} args.message - The error message.
+     * @param {number} args.statusCode - The HTTP status code associated with the error.
+     * @param {string} [args.error] - An optional error identifier or code.
+     * @param {Record<string, unknown>} [args.details] - Additional details about the error.
+     */
+    constructor(args) {
+        super(args.message);
+        /**
+         * The HTTP status code associated with the error.
+         * @type {number}
+         */
+        Object.defineProperty(this, "statusCode", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * An optional error identifier or code.
+         * @type {string | undefined}
+         */
+        Object.defineProperty(this, "error", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * Additional details about the error, often used for debugging purposes.
+         * @type {Record<string, unknown> | undefined}
+         */
+        Object.defineProperty(this, "details", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.name = "ApiError";
+        this.statusCode = args.statusCode;
+        if (this.error)
+            this.error = args.error;
+        if (args.details)
+            this.details = args.details;
+    }
+    /**
+     * Validates whether an unknown value conforms to the APIError schema.
+     * This is more thorough than an instanceof check as it verifies all required properties
+     * and their types using the defined schema.
+     *
+     * @param {unknown} error - Any value to be validated
+     * @returns {error is APIError} Type predicate indicating if the value is a valid APIError
+     *
+     * @example
+     * try {
+     *   throw new Error('Network failed');
+     * } catch (err) {
+     *   if (APIError.is(err)) {
+     *     // err is typed as APIError here
+     *     console.log(err.statusCode);
+     *   }
+     * }
+     */
+    static is(error) {
+        const result = APIError.schema.safeParse(error);
+        return result.success;
+    }
+    static unknown(message) {
+        return new APIError({
+            message: message ?? "An unknown error occurred",
+            statusCode: 502,
+        });
+    }
+    static get schema() {
+        return z.object({
+            message: z.string(),
+            statusCode: z.number().int(),
+            error: z.string().optional(),
+            details: z.object({}).optional(),
+        });
+    }
+}

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

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

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

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

package/esm/src/errors/index.js

@@ -0,0 +1,2 @@
+export * from "./api_error.js";
+export * from "./permission_error.js";

package/{dist/lib/error/error.permission.d.ts → esm/src/errors/permission_error.d.ts}

@@ -1,4 +1,4 @@
-import { Permission } from "@/models/permission";
+import { type Permission } from "../models/permission.js";
 /**
  * Custom error class representing an error caused by missing required permissions.
  * Extends the built-in {@link Error} class to include the `requiredPermissions` property.
@@ -45,3 +45,4 @@ export declare class PermissionError extends Error {
      */
     static is(error: unknown): error is PermissionError;
 }
+//# sourceMappingURL=permission_error.d.ts.map

package/esm/src/errors/permission_error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permission_error.d.ts","sourceRoot":"","sources":["../../../src/src/errors/permission_error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAe,MAAM,yBAAyB,CAAC;AAGvE;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,KAAK;IACxC;;;OAGG;IACH,SAAgB,mBAAmB,EAAE,UAAU,EAAE,CAAC;IAElD;;;;;OAKG;gBACS,IAAI,EAAE;QAChB,mBAAmB,EAAE,UAAU,EAAE,CAAC;QAClC,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IASD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;WACW,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,eAAe;CAkB3D"}

package/esm/src/errors/permission_error.js

@@ -0,0 +1,70 @@
+import { Permissions } from "../models/permission.js";
+import { z } from "zod";
+/**
+ * Custom error class representing an error caused by missing required permissions.
+ * Extends the built-in {@link Error} class to include the `requiredPermissions` property.
+ */
+export class PermissionError extends Error {
+    /**
+     * Creates a new `PermissionError` instance.
+     * @param {Object} args - The constructor arguments.
+     * @param {Permission[]} args.requiredPermissions - An array of permissions required for the operation.
+     * @param {string} [args.message] - An optional custom error message. Defaults to listing the missing permissions.
+     */
+    constructor(args) {
+        super(args.message ??
+            `Missing required permissions: ${args.requiredPermissions.join(", ")}`);
+        /**
+         * The permissions that are required but were not present, causing the error.
+         * @type {Permission[]}
+         */
+        Object.defineProperty(this, "requiredPermissions", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.name = "PermissionError";
+        this.requiredPermissions = args.requiredPermissions;
+    }
+    /**
+     * Validates if an unknown value is a valid PermissionError instance.
+     * Performs structural validation of the error object and its properties.
+     *
+     * @param {unknown} error - The value to validate.
+     * @returns {error is PermissionError} Type predicate indicating if the value is a valid PermissionError.
+     *
+     * @example
+     * try {
+     *   throw new Error('Access denied');
+     * } catch (error) {
+     *   if (PermissionError.is(error)) {
+     *     // error is typed as PermissionError with properly typed requiredPermissions
+     *     console.log(error.requiredPermissions);
+     *   }
+     * }
+     *
+     * @remarks
+     * Validates the following:
+     * - Has all required Error properties
+     * - Has correct error name
+     * - Contains properly structured requiredPermissions array
+     * - Maintains proper prototype chain
+     */
+    static is(error) {
+        const permissionSchema = z.union([
+            z.enum(Object.values(Permissions.Profile)),
+            z.enum(Object.values(Permissions.Contact)),
+            z.enum(Object.values(Permissions.Payment)),
+            z.enum(Object.values(Permissions.Payout)),
+            z.enum(Object.values(Permissions.Transfer)),
+            z.enum(Object.values(Permissions.Wallet)),
+        ]);
+        const errorSchema = z.object({
+            name: z.literal("PermissionError"),
+            message: z.string(),
+            requiredPermissions: z.array(permissionSchema),
+        });
+        return errorSchema.safeParse(error).success;
+    }
+}

package/{dist/features/admin/admin.contract.d.ts → esm/src/features/admin/contract.d.ts}

@@ -17,9 +17,9 @@ export declare const userManagementContract: {
             eager: z.ZodOptional<z.ZodString>;
         }, z.UnknownKeysParam, z.ZodTypeAny, {
             type?: string | undefined;
-            name?: string | undefined;
             id?: string | undefined;
             resetPassword?: number | undefined;
+            name?: string | undefined;
             identity?: string | undefined;
             profileId?: string | undefined;
             createdAt?: string | undefined;
@@ -30,9 +30,9 @@ export declare const userManagementContract: {
             isArchived?: number | undefined;
         }, {
             type?: string | undefined;
-            name?: string | undefined;
             id?: string | undefined;
             resetPassword?: number | undefined;
+            name?: string | undefined;
             identity?: string | undefined;
             profileId?: string | undefined;
             createdAt?: string | undefined;
@@ -56,14 +56,21 @@ export declare const userManagementContract: {
                 resetPassword: z.ZodBoolean;
                 isActive: z.ZodBoolean;
                 isArchived: z.ZodBoolean;
-                role: z.ZodOptional<z.ZodType<import("./admin.dtos").RoleDTO>>;
+                role: z.ZodOptional<z.ZodType<{
+                    id: string;
+                    access: string[];
+                    name: string;
+                    createdAt: string;
+                    updatedAt: string;
+                    description?: string | undefined;
+                }>>;
                 createdAt: z.ZodString;
                 updatedAt: z.ZodString;
             }, z.UnknownKeysParam, z.ZodTypeAny, {
                 type: string;
-                name: string;
                 id: string;
                 resetPassword: boolean;
+                name: string;
                 identity: string;
                 profileId: string;
                 createdAt: string;
@@ -72,18 +79,18 @@ export declare const userManagementContract: {
                 isActive: boolean;
                 isArchived: boolean;
                 role?: {
-                    name: string;
                     id: string;
                     access: string[];
+                    name: string;
                     createdAt: string;
                     updatedAt: string;
                     description?: string | undefined;
                 } | undefined;
             }, {
                 type: string;
-                name: string;
                 id: string;
                 resetPassword: boolean;
+                name: string;
                 identity: string;
                 profileId: string;
                 createdAt: string;
@@ -92,9 +99,9 @@ export declare const userManagementContract: {
                 isActive: boolean;
                 isArchived: boolean;
                 role?: {
-                    name: string;
                     id: string;
                     access: string[];
+                    name: string;
                     createdAt: string;
                     updatedAt: string;
                     description?: string | undefined;
@@ -140,9 +147,9 @@ export declare const userManagementContract: {
             eager: z.ZodOptional<z.ZodString>;
         }, z.UnknownKeysParam, z.ZodTypeAny, {
             type?: string | undefined;
-            name?: string | undefined;
             id?: string | undefined;
             resetPassword?: number | undefined;
+            name?: string | undefined;
             identity?: string | undefined;
             profileId?: string | undefined;
             createdAt?: string | undefined;
@@ -153,9 +160,9 @@ export declare const userManagementContract: {
             isArchived?: number | undefined;
         }, {
             type?: string | undefined;
-            name?: string | undefined;
             id?: string | undefined;
             resetPassword?: number | undefined;
+            name?: string | undefined;
             identity?: string | undefined;
             profileId?: string | undefined;
             createdAt?: string | undefined;
@@ -179,14 +186,21 @@ export declare const userManagementContract: {
                 resetPassword: z.ZodBoolean;
                 isActive: z.ZodBoolean;
                 isArchived: z.ZodBoolean;
-                role: z.ZodOptional<z.ZodType<import("./admin.dtos").RoleDTO>>;
+                role: z.ZodOptional<z.ZodType<{
+                    id: string;
+                    access: string[];
+                    name: string;
+                    createdAt: string;
+                    updatedAt: string;
+                    description?: string | undefined;
+                }>>;
                 createdAt: z.ZodString;
                 updatedAt: z.ZodString;
             }, z.UnknownKeysParam, z.ZodTypeAny, {
                 type: string;
-                name: string;
                 id: string;
                 resetPassword: boolean;
+                name: string;
                 identity: string;
                 profileId: string;
                 createdAt: string;
@@ -195,18 +209,18 @@ export declare const userManagementContract: {
                 isActive: boolean;
                 isArchived: boolean;
                 role?: {
-                    name: string;
                     id: string;
                     access: string[];
+                    name: string;
                     createdAt: string;
                     updatedAt: string;
                     description?: string | undefined;
                 } | undefined;
             }, {
                 type: string;
-                name: string;
                 id: string;
                 resetPassword: boolean;
+                name: string;
                 identity: string;
                 profileId: string;
                 createdAt: string;
@@ -215,9 +229,9 @@ export declare const userManagementContract: {
                 isActive: boolean;
                 isArchived: boolean;
                 role?: {
-                    name: string;
                     id: string;
                     access: string[];
+                    name: string;
                     createdAt: string;
                     updatedAt: string;
                     description?: string | undefined;
@@ -260,14 +274,14 @@ export declare const userManagementContract: {
             name: string;
             identity: string;
             resetPassword?: boolean | undefined;
-            roleId?: string | undefined;
             password?: string | undefined;
+            roleId?: string | undefined;
         }, {
             name: string;
             identity: string;
             resetPassword?: boolean | undefined;
-            roleId?: string | undefined;
             password?: string | undefined;
+            roleId?: string | undefined;
         }>;
         path: "/login";
         responses: {
@@ -283,8 +297,8 @@ export declare const userManagementContract: {
                 createdAt: z.ZodString;
             }, z.UnknownKeysParam, z.ZodTypeAny, {
                 type: string;
-                name: string;
                 id: string;
+                name: string;
                 identity: string;
                 profileId: string;
                 createdAt: string;
@@ -293,8 +307,8 @@ export declare const userManagementContract: {
                 isArchived: boolean;
             }, {
                 type: string;
-                name: string;
                 id: string;
+                name: string;
                 identity: string;
                 profileId: string;
                 createdAt: string;
@@ -353,17 +367,17 @@ export declare const userManagementContract: {
             resetPassword: z.ZodOptional<z.ZodBoolean>;
             isActive: z.ZodOptional<z.ZodBoolean>;
         }, z.UnknownKeysParam, z.ZodTypeAny, {
-            name?: string | undefined;
             resetPassword?: boolean | undefined;
+            name?: string | undefined;
+            password?: string | undefined;
             roleId?: string | undefined;
             isActive?: boolean | undefined;
-            password?: string | undefined;
         }, {
-            name?: string | undefined;
             resetPassword?: boolean | undefined;
+            name?: string | undefined;
+            password?: string | undefined;
             roleId?: string | undefined;
             isActive?: boolean | undefined;
-            password?: string | undefined;
         }>;
         path: "/login/:id";
         responses: {
@@ -377,14 +391,21 @@ export declare const userManagementContract: {
                 resetPassword: z.ZodBoolean;
                 isActive: z.ZodBoolean;
                 isArchived: z.ZodBoolean;
-                role: z.ZodOptional<z.ZodType<import("./admin.dtos").RoleDTO>>;
+                role: z.ZodOptional<z.ZodType<{
+                    id: string;
+                    access: string[];
+                    name: string;
+                    createdAt: string;
+                    updatedAt: string;
+                    description?: string | undefined;
+                }>>;
                 createdAt: z.ZodString;
                 updatedAt: z.ZodString;
             }, z.UnknownKeysParam, z.ZodTypeAny, {
                 type: string;
-                name: string;
                 id: string;
                 resetPassword: boolean;
+                name: string;
                 identity: string;
                 profileId: string;
                 createdAt: string;
@@ -393,18 +414,18 @@ export declare const userManagementContract: {
                 isActive: boolean;
                 isArchived: boolean;
                 role?: {
-                    name: string;
                     id: string;
                     access: string[];
+                    name: string;
                     createdAt: string;
                     updatedAt: string;
                     description?: string | undefined;
                 } | undefined;
             }, {
                 type: string;
-                name: string;
                 id: string;
                 resetPassword: boolean;
+                name: string;
                 identity: string;
                 profileId: string;
                 createdAt: string;
@@ -413,9 +434,9 @@ export declare const userManagementContract: {
                 isActive: boolean;
                 isArchived: boolean;
                 role?: {
-                    name: string;
                     id: string;
                     access: string[];
+                    name: string;
                     createdAt: string;
                     updatedAt: string;
                     description?: string | undefined;
@@ -478,14 +499,21 @@ export declare const userManagementContract: {
                 resetPassword: z.ZodBoolean;
                 isActive: z.ZodBoolean;
                 isArchived: z.ZodBoolean;
-                role: z.ZodOptional<z.ZodType<import("./admin.dtos").RoleDTO>>;
+                role: z.ZodOptional<z.ZodType<{
+                    id: string;
+                    access: string[];
+                    name: string;
+                    createdAt: string;
+                    updatedAt: string;
+                    description?: string | undefined;
+                }>>;
                 createdAt: z.ZodString;
                 updatedAt: z.ZodString;
             }, z.UnknownKeysParam, z.ZodTypeAny, {
                 type: string;
-                name: string;
                 id: string;
                 resetPassword: boolean;
+                name: string;
                 identity: string;
                 profileId: string;
                 createdAt: string;
@@ -494,18 +522,18 @@ export declare const userManagementContract: {
                 isActive: boolean;
                 isArchived: boolean;
                 role?: {
-                    name: string;
                     id: string;
                     access: string[];
+                    name: string;
                     createdAt: string;
                     updatedAt: string;
                     description?: string | undefined;
                 } | undefined;
             }, {
                 type: string;
-                name: string;
                 id: string;
                 resetPassword: boolean;
+                name: string;
                 identity: string;
                 profileId: string;
                 createdAt: string;
@@ -514,9 +542,9 @@ export declare const userManagementContract: {
                 isActive: boolean;
                 isArchived: boolean;
                 role?: {
-                    name: string;
                     id: string;
                     access: string[];
+                    name: string;
                     createdAt: string;
                     updatedAt: string;
                     description?: string | undefined;
@@ -569,14 +597,21 @@ export declare const userManagementContract: {
                 resetPassword: z.ZodBoolean;
                 isActive: z.ZodBoolean;
                 isArchived: z.ZodBoolean;
-                role: z.ZodOptional<z.ZodType<import("./admin.dtos").RoleDTO>>;
+                role: z.ZodOptional<z.ZodType<{
+                    id: string;
+                    access: string[];
+                    name: string;
+                    createdAt: string;
+                    updatedAt: string;
+                    description?: string | undefined;
+                }>>;
                 createdAt: z.ZodString;
                 updatedAt: z.ZodString;
             }, z.UnknownKeysParam, z.ZodTypeAny, {
                 type: string;
-                name: string;
                 id: string;
                 resetPassword: boolean;
+                name: string;
                 identity: string;
                 profileId: string;
                 createdAt: string;
@@ -585,18 +620,18 @@ export declare const userManagementContract: {
                 isActive: boolean;
                 isArchived: boolean;
                 role?: {
-                    name: string;
                     id: string;
                     access: string[];
+                    name: string;
                     createdAt: string;
                     updatedAt: string;
                     description?: string | undefined;
                 } | undefined;
             }, {
                 type: string;
-                name: string;
                 id: string;
                 resetPassword: boolean;
+                name: string;
                 identity: string;
                 profileId: string;
                 createdAt: string;
@@ -605,9 +640,9 @@ export declare const userManagementContract: {
                 isActive: boolean;
                 isArchived: boolean;
                 role?: {
-                    name: string;
                     id: string;
                     access: string[];
+                    name: string;
                     createdAt: string;
                     updatedAt: string;
                     description?: string | undefined;
@@ -710,16 +745,16 @@ export declare const userManagementContract: {
                 createdAt: z.ZodString;
                 updatedAt: z.ZodString;
             }, z.UnknownKeysParam, z.ZodTypeAny, {
-                name: string;
                 id: string;
                 access: string[];
+                name: string;
                 createdAt: string;
                 updatedAt: string;
                 description?: string | undefined;
             }, {
-                name: string;
                 id: string;
                 access: string[];
+                name: string;
                 createdAt: string;
                 updatedAt: string;
                 description?: string | undefined;
@@ -761,16 +796,16 @@ export declare const userManagementContract: {
                 createdAt: z.ZodString;
                 updatedAt: z.ZodString;
             }, z.UnknownKeysParam, z.ZodTypeAny, {
-                name: string;
                 id: string;
                 access: string[];
+                name: string;
                 createdAt: string;
                 updatedAt: string;
                 description?: string | undefined;
             }, {
-                name: string;
                 id: string;
                 access: string[];
+                name: string;
                 createdAt: string;
                 updatedAt: string;
                 description?: string | undefined;
@@ -804,3 +839,4 @@ export declare const userManagementContract: {
  * Use this type for strongly typed API client implementations.
  */
 export type UserManagementContract = typeof userManagementContract;
+//# sourceMappingURL=contract.d.ts.map

package/esm/src/features/admin/contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../../../../src/src/features/admin/contract.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAMxB,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsNjC,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,OAAO,sBAAsB,CAAC"}