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

package/package.json

@@ -1,29 +1,36 @@
 {
   "name": "@orion-js/helpers",
-  "version": "3.11.8",
-  "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": "78d70ac414964ec657cc000cedfad8a5efff5cc3"
-}
+  "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,13 +0,0 @@
-export interface OrionErrorInformation {
-    error: string;
-    message: string;
-    extra: any;
-}
-export declare class OrionError extends Error {
-    isOrionError: boolean;
-    isUserError: boolean;
-    isPermissionsError: boolean;
-    code: string;
-    extra: any;
-    getInfo: () => OrionErrorInformation;
-}

package/lib/Errors/OrionError.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrionError = void 0;
-class OrionError extends Error {
-    constructor() {
-        super(...arguments);
-        this.isOrionError = true;
-    }
-}
-exports.OrionError = OrionError;

package/lib/Errors/PermissionsError.d.ts

@@ -1,4 +0,0 @@
-import { OrionError } from './OrionError';
-export default class PermissionsError extends OrionError {
-    constructor(permissionErrorType: any, extra?: any);
-}

package/lib/Errors/PermissionsError.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const OrionError_1 = require("./OrionError");
-class PermissionsError extends OrionError_1.OrionError {
-    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/UserError.d.ts

@@ -1,4 +0,0 @@
-import { OrionError } from './OrionError';
-export default class UserError extends OrionError {
-    constructor(code: string, message?: string, extra?: any);
-}

package/lib/Errors/UserError.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const OrionError_1 = require("./OrionError");
-class UserError extends OrionError_1.OrionError {
-    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/composeMiddlewares.d.ts

@@ -1,6 +0,0 @@
-/**
- * Compose `middleware` returning
- * a fully valid middleware comprised
- * of all those which are passed.
- */
-export declare function composeMiddlewares(middleware: any): (context: any, next?: any) => Promise<any>;

package/lib/composeMiddlewares.js

@@ -1,44 +0,0 @@
-"use strict";
-// from https://github.com/koajs/compose/blob/master/index.js
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.composeMiddlewares = void 0;
-/**
- * Compose `middleware` returning
- * a fully valid middleware comprised
- * of all those which are passed.
- */
-function composeMiddlewares(middleware) {
-    if (!Array.isArray(middleware))
-        throw new TypeError('Middleware stack must be an array!');
-    for (const fn of middleware) {
-        if (typeof fn !== 'function')
-            throw new TypeError('Middleware must be composed of functions!');
-    }
-    /**
-     * @param {Object} context
-     * @return {Promise}
-     * @api public
-     */
-    return function (context, next) {
-        // last called middleware #
-        let index = -1;
-        return dispatch(0);
-        function dispatch(i) {
-            if (i <= index)
-                return Promise.reject(new Error('next() called multiple times'));
-            index = i;
-            let fn = middleware[i];
-            if (i === middleware.length)
-                fn = next;
-            if (!fn)
-                return Promise.resolve();
-            try {
-                return Promise.resolve(fn(context, dispatch.bind(null, i + 1)));
-            }
-            catch (err) {
-                return Promise.reject(err);
-            }
-        }
-    };
-}
-exports.composeMiddlewares = composeMiddlewares;

package/lib/createMap.d.ts

@@ -1 +0,0 @@
-export default function createMap<T>(array: Array<T>, key?: string): Record<string, T>;

package/lib/createMap.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function createMap(array, key = '_id') {
-    const map = {};
-    for (const item of array) {
-        map[item[key]] = item;
-    }
-    return map;
-}
-exports.default = createMap;

package/lib/createMapArray.d.ts

@@ -1 +0,0 @@
-export default function createMapArray<T>(array: Array<T>, key?: string): Record<string, Array<T>>;

package/lib/createMapArray.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function createMapArray(array, key = '_id') {
-    const map = {};
-    for (const item of array) {
-        map[item[key]] = map[item[key]] || [];
-        map[item[key]].push(item);
-    }
-    return map;
-}
-exports.default = createMapArray;

package/lib/generateId.d.ts

@@ -1,6 +0,0 @@
-/**
- * Returns a random ID
- * @param charsCount length of the ID
- * @param chars characters used to generate the ID
- */
-export default function generateId(charsCount?: number, chars?: string): string;

package/lib/generateId.js

@@ -1,54 +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 crypto_1 = __importDefault(require("crypto"));
-const UNMISTAKABLE_CHARS = '23456789ABCDEFGHJKLMNPQRSTWXYZabcdefghjkmnopqrstuvwxyz';
-const hexString = function (digits) {
-    var numBytes = Math.ceil(digits / 2);
-    var bytes;
-    // Try to get cryptographically strong randomness. Fall back to
-    // non-cryptographically strong if not available.
-    try {
-        bytes = crypto_1.default.randomBytes(numBytes);
-    }
-    catch (e) {
-        // XXX should re-throw any error except insufficient entropy
-        bytes = crypto_1.default.pseudoRandomBytes(numBytes);
-    }
-    var result = bytes.toString('hex');
-    // If the number of digits is odd, we'll have generated an extra 4 bits
-    // of randomness, so we need to trim the last digit.
-    return result.substring(0, digits);
-};
-const fraction = function () {
-    var numerator = parseInt(hexString(8), 16);
-    return numerator * 2.3283064365386963e-10; // 2^-32
-};
-const choice = function (arrayOrString) {
-    var index = Math.floor(fraction() * arrayOrString.length);
-    if (typeof arrayOrString === 'string')
-        return arrayOrString.substr(index, 1);
-    else
-        return arrayOrString[index];
-};
-const randomString = function (charsCount, alphabet) {
-    var digits = [];
-    for (var i = 0; i < charsCount; i++) {
-        digits[i] = choice(alphabet);
-    }
-    return digits.join('');
-};
-/**
- * Returns a random ID
- * @param charsCount length of the ID
- * @param chars characters used to generate the ID
- */
-function generateId(charsCount, chars = UNMISTAKABLE_CHARS) {
-    if (!charsCount) {
-        charsCount = 17;
-    }
-    return randomString(charsCount, chars);
-}
-exports.default = generateId;

package/lib/generateId.test.d.ts

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

package/lib/generateId.test.js

@@ -1,11 +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 generateId_1 = __importDefault(require("./generateId"));
-const isString_1 = __importDefault(require("lodash/isString"));
-it('should generate random ids', async () => {
-    expect((0, generateId_1.default)()).not.toBe((0, generateId_1.default)());
-    expect((0, isString_1.default)((0, generateId_1.default)())).toBe(true);
-});

package/lib/generateUUID.d.ts

@@ -1 +0,0 @@
-export declare function generateUUID(): any;

package/lib/generateUUID.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateUUID = void 0;
-const uuid_1 = require("uuid");
-function generateUUID() {
-    return (0, uuid_1.v4)();
-}
-exports.generateUUID = generateUUID;

package/lib/generateUUID.test.d.ts

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

package/lib/generateUUID.test.js

@@ -1,11 +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 isString_1 = __importDefault(require("lodash/isString"));
-const generateUUID_1 = require("./generateUUID");
-it('should generate random uuid v4', async () => {
-    expect((0, generateUUID_1.generateUUID)()).not.toBe((0, generateUUID_1.generateUUID)());
-    expect((0, isString_1.default)((0, generateUUID_1.generateUUID)())).toBe(true);
-});

package/lib/hashObject.d.ts

@@ -1 +0,0 @@
-export default function (object: any): string;

package/lib/hashObject.js

@@ -1,10 +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 object_hash_1 = __importDefault(require("object-hash"));
-function default_1(object) {
-    return (0, object_hash_1.default)(object);
-}
-exports.default = default_1;

package/lib/hashObject.test.d.ts

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

package/lib/hashObject.test.js

@@ -1,30 +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 hashObject_1 = __importDefault(require("./hashObject"));
-it('should create a string hash of an object', async () => {
-    const object = {
-        hello: 'world',
-        date: new Date(),
-        subObject: {
-            name: 'Nicolás'
-        }
-    };
-    const hash = (0, hashObject_1.default)(object);
-    expect(typeof hash).toBe('string');
-});
-it('object with different key orders should return same hash', async () => {
-    const object1 = {
-        one: '1',
-        two: '2'
-    };
-    const object2 = {
-        two: '2',
-        one: '1'
-    };
-    const hash1 = (0, hashObject_1.default)(object1);
-    const hash2 = (0, hashObject_1.default)(object2);
-    expect(hash1).toBe(hash2);
-});

package/lib/index.d.ts

@@ -1,12 +0,0 @@
-import sleep from './sleep';
-import hashObject from './hashObject';
-import generateId from './generateId';
-import createMap from './createMap';
-import { OrionError, OrionErrorInformation } from './Errors/OrionError';
-import PermissionsError from './Errors/PermissionsError';
-import UserError from './Errors/UserError';
-import createMapArray from './createMapArray';
-export * from './composeMiddlewares';
-export * from './retries';
-export * from './generateUUID';
-export { createMap, createMapArray, generateId, hashObject, sleep, OrionError, PermissionsError, UserError, OrionErrorInformation };

package/lib/index.js

@@ -1,35 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (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);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserError = exports.PermissionsError = exports.OrionError = exports.sleep = exports.hashObject = exports.generateId = exports.createMapArray = exports.createMap = void 0;
-const sleep_1 = __importDefault(require("./sleep"));
-exports.sleep = sleep_1.default;
-const hashObject_1 = __importDefault(require("./hashObject"));
-exports.hashObject = hashObject_1.default;
-const generateId_1 = __importDefault(require("./generateId"));
-exports.generateId = generateId_1.default;
-const createMap_1 = __importDefault(require("./createMap"));
-exports.createMap = createMap_1.default;
-const OrionError_1 = require("./Errors/OrionError");
-Object.defineProperty(exports, "OrionError", { enumerable: true, get: function () { return OrionError_1.OrionError; } });
-const PermissionsError_1 = __importDefault(require("./Errors/PermissionsError"));
-exports.PermissionsError = PermissionsError_1.default;
-const UserError_1 = __importDefault(require("./Errors/UserError"));
-exports.UserError = UserError_1.default;
-const createMapArray_1 = __importDefault(require("./createMapArray"));
-exports.createMapArray = createMapArray_1.default;
-__exportStar(require("./composeMiddlewares"), exports);
-__exportStar(require("./retries"), exports);
-__exportStar(require("./generateUUID"), exports);

package/lib/retries.d.ts

@@ -1 +0,0 @@
-export declare function executeWithRetries<TFunc extends () => Promise<any>>(fn: TFunc, retries: number, timeout: number): Promise<ReturnType<TFunc>>;

package/lib/retries.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.executeWithRetries = void 0;
-function executeWithRetries(fn, retries, timeout) {
-    return new Promise((resolve, reject) => {
-        const retry = async (retries) => {
-            try {
-                const result = await fn();
-                resolve(result);
-            }
-            catch (error) {
-                if (retries > 0) {
-                    setTimeout(() => retry(retries - 1), timeout);
-                }
-                else {
-                    reject(error);
-                }
-            }
-        };
-        retry(retries);
-    });
-}
-exports.executeWithRetries = executeWithRetries;

package/lib/retries.test.d.ts

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

package/lib/retries.test.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const retries_1 = require("./retries");
-describe('Retry helpers', () => {
-    it('should retry a function', async () => {
-        let counter = 0;
-        const fn = async () => {
-            counter++;
-            if (counter < 3) {
-                throw new Error('error');
-            }
-            return 'ok';
-        };
-        const result = await (0, retries_1.executeWithRetries)(fn, 3, 0);
-        expect(result).toEqual('ok');
-    });
-    it('should the throw the error if the retries are over', async () => {
-        let counter = 0;
-        const fn = async () => {
-            counter++;
-            throw new Error('error');
-        };
-        expect.assertions(2);
-        try {
-            await (0, retries_1.executeWithRetries)(fn, 3, 0);
-        }
-        catch (error) {
-            expect(error.message).toEqual('error');
-            expect(counter).toEqual(4);
-        }
-    });
-    it('should run only once a function with 0 or undefined retrires', async () => {
-        let counter = 0;
-        const fn = async () => {
-            counter++;
-            throw new Error('error');
-        };
-        expect.assertions(2);
-        try {
-            await (0, retries_1.executeWithRetries)(fn, null, 0);
-        }
-        catch (error) {
-            expect(error.message).toEqual('error');
-            expect(counter).toEqual(1);
-        }
-    });
-});

package/lib/sleep.d.ts

@@ -1,5 +0,0 @@
-declare const _default: (time: number) => Promise<void>;
-/**
- * Creates a timeout with a promise
- */
-export default _default;

package/lib/sleep.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Creates a timeout with a promise
- */
-exports.default = (time) => {
-    return new Promise(resolve => setTimeout(resolve, time));
-};

package/tsconfig.json

@@ -1,16 +0,0 @@
-{
-  "compilerOptions": {
-    "strict": false,
-    "outDir": "./lib",
-    "rootDir": "./src",
-    "module": "commonjs",
-    "target": "es2020",
-    "moduleResolution": "node",
-    "lib": ["es2020"],
-    "declaration": true,
-
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true
-  }
-}