@orion-js/helpers 3.11.15 → 4.0.0-alpha.2

package/package.json

@@ -1,29 +1,36 @@
 {
   "name": "@orion-js/helpers",
-  "version": "3.11.15",
-  "main": "lib/index.js",
+  "version": "4.0.0-alpha.2",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs"
+  },
+  "files": [
+    "dist"
+  ],
   "author": "nicolaslopezj",
   "license": "MIT",
   "scripts": {
-    "test": "jest",
-    "prepare": "yarn run build",
-    "clean": "rm -rf ./lib",
-    "build": "yarn run clean && tsc",
-    "watch": "tsc -w",
-    "upgrade-interactive": "yarn upgrade-interactive"
+    "test": "bun test",
+    "build": "bun run build.ts",
+    "dev": "bun --watch src/index.ts",
+    "clean": "rm -rf ./dist"
   },
   "dependencies": {
     "object-hash": "^2.2.0"
   },
   "devDependencies": {
-    "@shelf/jest-mongodb": "^2.1.0",
-    "@types/jest": "^27.0.2",
-    "jest": "^29.5.0",
-    "ts-jest": "^29.0.5",
-    "typescript": "^4.4.4"
+    "@types/bun": "^1.2.4",
+    "@types/node": "^20.9.0",
+    "typescript": "^4.4.4",
+    "vitest": "^0.34.6"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a5c95d9fd18f779c834644eb757928cdb840643c"
-}
+  "gitHead": "a485b1fe6a1840ee6cb58fd69d6de62585f1ed10"
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Orionjs Team
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/jest.config.js

@@ -1,8 +0,0 @@
-module.exports = {
-  roots: ['./src'],
-  testMatch: ['**/__tests__/**/*.+(ts|tsx|js)', '**/?(*.)+(spec|test).+(ts|tsx|js)'],
-  transform: {
-    '^.+\\.(ts|tsx)$': 'ts-jest'
-  },
-  verbose: true
-}

package/lib/Errors/OrionError.d.ts

@@ -1,39 +0,0 @@
-/**
- * Interface representing the standardized error information structure for Orion errors.
- * This is used by the getInfo method to provide consistent error reporting.
- */
-export interface OrionErrorInformation {
-    /** The error code or identifier */
-    error: string;
-    /** Human-readable error message */
-    message: string;
-    /** Additional error metadata or context */
-    extra: any;
-    /** The sub-type of error. For example for permissions errors it could be 'read', 'write', 'admin' */
-    type?: string;
-}
-/**
- * Base error class for all Orion-specific errors.
- *
- * This abstract class provides common properties and methods for all error types
- * used in the Orion framework. It's extended by more specific error classes
- * like UserError and PermissionsError.
- *
- * @property isOrionError - Flag indicating this is an Orion error (always true)
- * @property isUserError - Flag indicating if this is a user-facing error
- * @property isPermissionsError - Flag indicating if this is a permissions-related error
- * @property code - Error code for identifying the error type
- * @property extra - Additional error context or metadata
- */
-export declare class OrionError extends Error {
-    isOrionError: boolean;
-    isUserError: boolean;
-    isPermissionsError: boolean;
-    code: string;
-    extra: any;
-    /**
-     * Returns a standardized representation of the error information.
-     * @returns An object containing error details in a consistent format
-     */
-    getInfo: () => OrionErrorInformation;
-}

package/lib/Errors/OrionError.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrionError = void 0;
-/**
- * Base error class for all Orion-specific errors.
- *
- * This abstract class provides common properties and methods for all error types
- * used in the Orion framework. It's extended by more specific error classes
- * like UserError and PermissionsError.
- *
- * @property isOrionError - Flag indicating this is an Orion error (always true)
- * @property isUserError - Flag indicating if this is a user-facing error
- * @property isPermissionsError - Flag indicating if this is a permissions-related error
- * @property code - Error code for identifying the error type
- * @property extra - Additional error context or metadata
- */
-class OrionError extends Error {
-    constructor() {
-        super(...arguments);
-        this.isOrionError = true;
-    }
-}
-exports.OrionError = OrionError;

package/lib/Errors/OrionError.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/Errors/OrionError.test.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const OrionError_1 = require("./OrionError");
-// Since OrionError is an abstract class with unimplemented methods,
-// we'll create a concrete implementation for testing
-class TestOrionError extends OrionError_1.OrionError {
-    constructor(message, code = 'test_error', extra = {}) {
-        super(message);
-        this.code = code;
-        this.extra = extra;
-        this.isUserError = false;
-        this.isPermissionsError = false;
-        this.getInfo = () => {
-            return {
-                error: this.code,
-                message: this.message,
-                extra: this.extra
-            };
-        };
-    }
-}
-describe('OrionError', () => {
-    it('should be an instance of Error', () => {
-        const error = new TestOrionError('Test error message');
-        expect(error).toBeInstanceOf(Error);
-    });
-    it('should have OrionError properties', () => {
-        const error = new TestOrionError('Test error message');
-        expect(error.isOrionError).toBe(true);
-        expect(error.isUserError).toBe(false);
-        expect(error.isPermissionsError).toBe(false);
-        expect(error.code).toBe('test_error');
-        expect(error.message).toBe('Test error message');
-    });
-    it('should have a getInfo method that returns the correct structure', () => {
-        const extraData = { userId: '123', context: 'testing' };
-        const error = new TestOrionError('Test error message', 'custom_code', extraData);
-        const info = error.getInfo();
-        expect(info).toEqual({
-            error: 'custom_code',
-            message: 'Test error message',
-            extra: extraData
-        });
-    });
-    it('should be extendable with custom properties', () => {
-        const error = new TestOrionError('Test error message');
-        error.customProp = 'custom value';
-        expect(error.customProp).toBe('custom value');
-        expect(error.message).toBe('Test error message');
-        expect(error.isOrionError).toBe(true);
-    });
-});

package/lib/Errors/PermissionsError.d.ts

@@ -1,37 +0,0 @@
-import { OrionError } from './OrionError';
-/**
- * Error class for permission-related errors in the Orion framework.
- *
- * PermissionsError represents authorization failures where a user or client
- * attempts to perform an action they don't have permission to execute.
- * This is used to distinguish security/permissions errors from other types
- * of errors for proper error handling and user feedback.
- *
- * @extends OrionError
- */
-export default class PermissionsError extends OrionError {
-    /**
-     * Creates a new PermissionsError instance.
-     *
-     * @param permissionErrorType - Identifies the specific permission that was violated
-     *                              (e.g., 'read', 'write', 'admin')
-     * @param extra - Additional error context or metadata. Can include a custom message
-     *                via the message property.
-     *
-     * @example
-     * // Basic usage
-     * throw new PermissionsError('delete_document')
-     *
-     * @example
-     * // With custom message
-     * throw new PermissionsError('access_admin', { message: 'Admin access required' })
-     *
-     * @example
-     * // With additional context
-     * throw new PermissionsError('edit_user', {
-     *   userId: 'user123',
-     *   requiredRole: 'admin'
-     * })
-     */
-    constructor(permissionErrorType: any, extra?: any);
-}

package/lib/Errors/PermissionsError.js

@@ -1,57 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const OrionError_1 = require("./OrionError");
-/**
- * Error class for permission-related errors in the Orion framework.
- *
- * PermissionsError represents authorization failures where a user or client
- * attempts to perform an action they don't have permission to execute.
- * This is used to distinguish security/permissions errors from other types
- * of errors for proper error handling and user feedback.
- *
- * @extends OrionError
- */
-class PermissionsError extends OrionError_1.OrionError {
-    /**
-     * Creates a new PermissionsError instance.
-     *
-     * @param permissionErrorType - Identifies the specific permission that was violated
-     *                              (e.g., 'read', 'write', 'admin')
-     * @param extra - Additional error context or metadata. Can include a custom message
-     *                via the message property.
-     *
-     * @example
-     * // Basic usage
-     * throw new PermissionsError('delete_document')
-     *
-     * @example
-     * // With custom message
-     * throw new PermissionsError('access_admin', { message: 'Admin access required' })
-     *
-     * @example
-     * // With additional context
-     * throw new PermissionsError('edit_user', {
-     *   userId: 'user123',
-     *   requiredRole: 'admin'
-     * })
-     */
-    constructor(permissionErrorType, extra = {}) {
-        // Calling parent constructor of base Error class.
-        const message = extra.message || `Client is not allowed to perform this action [${permissionErrorType}]`;
-        super(message);
-        Error.captureStackTrace(this, this.constructor);
-        this.isOrionError = true;
-        this.isPermissionsError = true;
-        this.code = 'PermissionsError';
-        this.extra = extra;
-        this.getInfo = () => {
-            return {
-                ...extra,
-                error: 'PermissionsError',
-                message,
-                type: permissionErrorType
-            };
-        };
-    }
-}
-exports.default = PermissionsError;

package/lib/Errors/PermissionsError.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/Errors/PermissionsError.test.js

@@ -1,62 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const PermissionsError_1 = __importDefault(require("./PermissionsError"));
-const OrionError_1 = require("./OrionError");
-describe('PermissionsError', () => {
-    it('should extend OrionError', () => {
-        const error = new PermissionsError_1.default('read_document');
-        expect(error).toBeInstanceOf(OrionError_1.OrionError);
-    });
-    it('should set isPermissionsError to true', () => {
-        const error = new PermissionsError_1.default('read_document');
-        expect(error.isPermissionsError).toBe(true);
-        expect(error.isOrionError).toBe(true);
-        expect(error.isUserError).toBeUndefined();
-    });
-    it('should set code to "PermissionsError"', () => {
-        const error = new PermissionsError_1.default('read_document');
-        expect(error.code).toBe('PermissionsError');
-    });
-    it('should generate a default message with permissionErrorType', () => {
-        const error = new PermissionsError_1.default('update_user');
-        expect(error.message).toBe('Client is not allowed to perform this action [update_user]');
-    });
-    it('should support custom message in extra', () => {
-        const error = new PermissionsError_1.default('delete_document', {
-            message: 'You need admin rights to delete this document'
-        });
-        expect(error.message).toBe('You need admin rights to delete this document');
-    });
-    it('should store extra data', () => {
-        const extraData = {
-            documentId: '123',
-            requiredRole: 'admin'
-        };
-        const error = new PermissionsError_1.default('read_document', extraData);
-        expect(error.extra).toEqual(extraData);
-    });
-    it('should have a getInfo method that returns the correct structure', () => {
-        const extraData = { documentId: '123', requiredRole: 'admin' };
-        const error = new PermissionsError_1.default('read_document', extraData);
-        const info = error.getInfo();
-        expect(info).toEqual({
-            ...extraData,
-            error: 'PermissionsError',
-            message: 'Client is not allowed to perform this action [read_document]',
-            type: 'read_document'
-        });
-    });
-    it('should include the permission type in getInfo', () => {
-        const error = new PermissionsError_1.default('admin_action');
-        const info = error.getInfo();
-        expect(info.type).toBe('admin_action');
-    });
-    it('should have proper stack trace', () => {
-        const error = new PermissionsError_1.default('read_document');
-        expect(error.stack).toBeDefined();
-        expect(error.stack.includes('PermissionsError.test.ts')).toBe(true);
-    });
-});

package/lib/Errors/UserError.d.ts

@@ -1,33 +0,0 @@
-import { OrionError } from './OrionError';
-/**
- * Error class for user-facing errors in the Orion framework.
- *
- * UserError is designed to represent errors that should be displayed to end users,
- * as opposed to system errors or unexpected failures. These errors typically represent
- * validation issues, business rule violations, or other expected error conditions.
- *
- * @extends OrionError
- */
-export default class UserError extends OrionError {
-    /**
-     * Creates a new UserError instance.
-     *
-     * @param code - Error code identifier. If only one parameter is provided,
-     *               this will be used as the message and code will default to 'error'.
-     * @param message - Human-readable error message. Optional if code is provided.
-     * @param extra - Additional error context or metadata.
-     *
-     * @example
-     * // Basic usage
-     * throw new UserError('invalid_input', 'The provided email is invalid')
-     *
-     * @example
-     * // Using only a message (code will be 'error')
-     * throw new UserError('Input validation failed')
-     *
-     * @example
-     * // With extra metadata
-     * throw new UserError('rate_limit', 'Too many requests', { maxRequests: 100 })
-     */
-    constructor(code: string, message?: string, extra?: any);
-}

package/lib/Errors/UserError.js

@@ -1,54 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const OrionError_1 = require("./OrionError");
-/**
- * Error class for user-facing errors in the Orion framework.
- *
- * UserError is designed to represent errors that should be displayed to end users,
- * as opposed to system errors or unexpected failures. These errors typically represent
- * validation issues, business rule violations, or other expected error conditions.
- *
- * @extends OrionError
- */
-class UserError extends OrionError_1.OrionError {
-    /**
-     * Creates a new UserError instance.
-     *
-     * @param code - Error code identifier. If only one parameter is provided,
-     *               this will be used as the message and code will default to 'error'.
-     * @param message - Human-readable error message. Optional if code is provided.
-     * @param extra - Additional error context or metadata.
-     *
-     * @example
-     * // Basic usage
-     * throw new UserError('invalid_input', 'The provided email is invalid')
-     *
-     * @example
-     * // Using only a message (code will be 'error')
-     * throw new UserError('Input validation failed')
-     *
-     * @example
-     * // With extra metadata
-     * throw new UserError('rate_limit', 'Too many requests', { maxRequests: 100 })
-     */
-    constructor(code, message, extra) {
-        if (!message && code) {
-            message = code;
-            code = 'error';
-        }
-        super(message);
-        Error.captureStackTrace(this, this.constructor);
-        this.isOrionError = true;
-        this.isUserError = true;
-        this.code = code;
-        this.extra = extra;
-        this.getInfo = () => {
-            return {
-                error: code,
-                message,
-                extra
-            };
-        };
-    }
-}
-exports.default = UserError;

package/lib/Errors/UserError.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/Errors/UserError.test.js

@@ -1,49 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const UserError_1 = __importDefault(require("./UserError"));
-const OrionError_1 = require("./OrionError");
-describe('UserError', () => {
-    it('should extend OrionError', () => {
-        const error = new UserError_1.default('test_code', 'Test error message');
-        expect(error).toBeInstanceOf(OrionError_1.OrionError);
-    });
-    it('should set isUserError to true', () => {
-        const error = new UserError_1.default('test_code', 'Test error message');
-        expect(error.isUserError).toBe(true);
-        expect(error.isOrionError).toBe(true);
-        expect(error.isPermissionsError).toBeUndefined();
-    });
-    it('should set code and message correctly', () => {
-        const error = new UserError_1.default('test_code', 'Test error message');
-        expect(error.code).toBe('test_code');
-        expect(error.message).toBe('Test error message');
-    });
-    it('should support providing only a message (code defaults to "error")', () => {
-        const error = new UserError_1.default('Test error message');
-        expect(error.code).toBe('error');
-        expect(error.message).toBe('Test error message');
-    });
-    it('should support extra data', () => {
-        const extraData = { field: 'username', constraint: 'required' };
-        const error = new UserError_1.default('validation_error', 'Validation failed', extraData);
-        expect(error.extra).toEqual(extraData);
-    });
-    it('should have a getInfo method that returns the correct structure', () => {
-        const extraData = { field: 'email', constraint: 'format' };
-        const error = new UserError_1.default('invalid_email', 'Invalid email format', extraData);
-        const info = error.getInfo();
-        expect(info).toEqual({
-            error: 'invalid_email',
-            message: 'Invalid email format',
-            extra: extraData
-        });
-    });
-    it('should have proper stack trace', () => {
-        const error = new UserError_1.default('test_code', 'Test error message');
-        expect(error.stack).toBeDefined();
-        expect(error.stack.includes('UserError.test.ts')).toBe(true);
-    });
-});

package/lib/Errors/index.d.ts

@@ -1,43 +0,0 @@
-/**
- * @file Exports all error classes used in the Orion framework
- */
-import { OrionError, OrionErrorInformation } from './OrionError';
-import PermissionsError from './PermissionsError';
-import UserError from './UserError';
-/**
- * Re-export all error types for convenient importing
- */
-export { OrionError, OrionErrorInformation, PermissionsError, UserError };
-/**
- * Type guard to check if an error is an OrionError
- *
- * @param error - Any error object to test
- * @returns True if the error is an OrionError instance
- *
- * @example
- * try {
- *   // some code that might throw
- * } catch (error) {
- *   if (isOrionError(error)) {
- *     // Handle Orion-specific error
- *     console.log(error.code, error.getInfo())
- *   } else {
- *     // Handle general error
- *   }
- * }
- */
-export declare function isOrionError(error: any): error is OrionError;
-/**
- * Type guard to check if an error is a UserError
- *
- * @param error - Any error object to test
- * @returns True if the error is a UserError instance
- */
-export declare function isUserError(error: any): error is UserError;
-/**
- * Type guard to check if an error is a PermissionsError
- *
- * @param error - Any error object to test
- * @returns True if the error is a PermissionsError instance
- */
-export declare function isPermissionsError(error: any): error is PermissionsError;

package/lib/Errors/index.js

@@ -1,57 +0,0 @@
-"use strict";
-/**
- * @file Exports all error classes used in the Orion framework
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isPermissionsError = exports.isUserError = exports.isOrionError = exports.UserError = exports.PermissionsError = exports.OrionError = void 0;
-const OrionError_1 = require("./OrionError");
-Object.defineProperty(exports, "OrionError", { enumerable: true, get: function () { return OrionError_1.OrionError; } });
-const PermissionsError_1 = __importDefault(require("./PermissionsError"));
-exports.PermissionsError = PermissionsError_1.default;
-const UserError_1 = __importDefault(require("./UserError"));
-exports.UserError = UserError_1.default;
-/**
- * Type guard to check if an error is an OrionError
- *
- * @param error - Any error object to test
- * @returns True if the error is an OrionError instance
- *
- * @example
- * try {
- *   // some code that might throw
- * } catch (error) {
- *   if (isOrionError(error)) {
- *     // Handle Orion-specific error
- *     console.log(error.code, error.getInfo())
- *   } else {
- *     // Handle general error
- *   }
- * }
- */
-function isOrionError(error) {
-    return Boolean(error && typeof error === 'object' && error.isOrionError === true);
-}
-exports.isOrionError = isOrionError;
-/**
- * Type guard to check if an error is a UserError
- *
- * @param error - Any error object to test
- * @returns True if the error is a UserError instance
- */
-function isUserError(error) {
-    return Boolean(error && typeof error === 'object' && error.isOrionError === true && error.isUserError === true);
-}
-exports.isUserError = isUserError;
-/**
- * Type guard to check if an error is a PermissionsError
- *
- * @param error - Any error object to test
- * @returns True if the error is a PermissionsError instance
- */
-function isPermissionsError(error) {
-    return Boolean(error && typeof error === 'object' && error.isOrionError === true && error.isPermissionsError === true);
-}
-exports.isPermissionsError = isPermissionsError;

package/lib/Errors/index.test.d.ts

@@ -1 +0,0 @@
-export {};