@temboplus/afloat 0.1.77-beta.8 → 0.1.78

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 "@/modules/login/permission.type.js";
+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;
+    }
+}