@temboplus/afloat 0.1.77-beta.9 → 0.1.79

package/script/npm/src/mod.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/features/auth/index.js"), exports);
+__exportStar(require("./src/features/contact/index.js"), exports);
+__exportStar(require("./src/features/wallet/index.js"), exports);
+__exportStar(require("./src/features/payout/index.js"), exports);
+__exportStar(require("./src/features/admin/index.js"), exports);
+__exportStar(require("./src/errors/index.js"), exports);
+__exportStar(require("./src/models/index.js"), exports);

package/script/npm/src/src/errors/api_error.d.ts

@@ -0,0 +1,63 @@
+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 declare class APIError extends Error {
+    /**
+     * The HTTP status code associated with the error.
+     * @type {number}
+     */
+    readonly statusCode: number;
+    /**
+     * An optional error identifier or code.
+     * @type {string | undefined}
+     */
+    readonly error?: string;
+    /**
+     * Additional details about the error, often used for debugging purposes.
+     * @type {Record<string, unknown> | undefined}
+     */
+    readonly details?: Record<string, unknown>;
+    /**
+     * 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: {
+        message: string;
+        statusCode: number;
+        error?: string;
+        details?: Record<string, unknown>;
+    });
+    /**
+     * 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: unknown): error is APIError;
+    static unknown(message?: string): APIError;
+    static get schema(): z.ZodObject<{
+        message: z.ZodString;
+        statusCode: z.ZodNumber;
+        error: z.ZodOptional<z.ZodString>;
+        details: z.ZodOptional<z.AnyZodObject>;
+    }>;
+}
+//# sourceMappingURL=api_error.d.ts.map

package/script/npm/src/src/errors/api_error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api_error.d.ts","sourceRoot":"","sources":["../../../../../src/src/errors/api_error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,qBAAa,QAAS,SAAQ,KAAK;IACjC;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IAEnC;;;OAGG;IACH,SAAgB,KAAK,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,SAAgB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElD;;;;;;;OAOG;gBACS,IAAI,EAAE;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC;IASD;;;;;;;;;;;;;;;;;OAiBG;WACW,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,QAAQ;WAKrC,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,QAAQ;IAOjD,WAAkB,MAAM,IAAI,CAAC,CAAC,SAAS,CAAC;QACtC,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC;QACrB,UAAU,EAAE,CAAC,CAAC,SAAS,CAAC;QACxB,KAAK,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAClC,OAAO,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;KACxC,CAAC,CAOD;CACF"}

package/script/npm/src/src/errors/api_error.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIError = void 0;
+const zod_1 = require("zod");
+/**
+ * Custom error class representing API-related errors.
+ * Extends the built-in `Error` class to include additional properties such as `statusCode`, `error`, and `details`.
+ */
+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 zod_1.z.object({
+            message: zod_1.z.string(),
+            statusCode: zod_1.z.number().int(),
+            error: zod_1.z.string().optional(),
+            details: zod_1.z.object({}).optional(),
+        });
+    }
+}
+exports.APIError = APIError;

package/script/npm/src/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/script/npm/src/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/script/npm/src/src/errors/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api_error.js"), exports);
+__exportStar(require("./permission_error.js"), exports);

package/script/npm/src/src/errors/permission_error.d.ts

@@ -0,0 +1,48 @@
+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.
+ */
+export declare class PermissionError extends Error {
+    /**
+     * The permissions that are required but were not present, causing the error.
+     * @type {Permission[]}
+     */
+    readonly requiredPermissions: Permission[];
+    /**
+     * 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: {
+        requiredPermissions: Permission[];
+        message?: string;
+    });
+    /**
+     * 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: unknown): error is PermissionError;
+}
+//# sourceMappingURL=permission_error.d.ts.map

package/script/npm/src/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/script/npm/src/src/errors/permission_error.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PermissionError = void 0;
+const permission_js_1 = require("../models/permission.js");
+const zod_1 = require("zod");
+/**
+ * Custom error class representing an error caused by missing required permissions.
+ * Extends the built-in {@link Error} class to include the `requiredPermissions` property.
+ */
+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 = zod_1.z.union([
+            zod_1.z.enum(Object.values(permission_js_1.Permissions.Profile)),
+            zod_1.z.enum(Object.values(permission_js_1.Permissions.Contact)),
+            zod_1.z.enum(Object.values(permission_js_1.Permissions.Payment)),
+            zod_1.z.enum(Object.values(permission_js_1.Permissions.Payout)),
+            zod_1.z.enum(Object.values(permission_js_1.Permissions.Transfer)),
+            zod_1.z.enum(Object.values(permission_js_1.Permissions.Wallet)),
+        ]);
+        const errorSchema = zod_1.z.object({
+            name: zod_1.z.literal("PermissionError"),
+            message: zod_1.z.string(),
+            requiredPermissions: zod_1.z.array(permissionSchema),
+        });
+        return errorSchema.safeParse(error).success;
+    }
+}
+exports.PermissionError = PermissionError;