@poppinss/utils 4.0.4 → 6.0.0-0

package/package.json

@@ -1,99 +1,87 @@
 {
 	"name": "@poppinss/utils",
-	"version": "4.0.4",
+	"version": "6.0.0-0",
 	"description": "Handy utilities for repetitive work",
 	"main": "build/index.js",
+	"type": "module",
 	"files": [
 		"build/src",
+		"lodash",
+		"build/lodash",
 		"build/index.d.ts",
-		"build/index.js",
-		"types",
-		"build/helpers.d.ts",
-		"build/helpers.js"
+		"build/index.js"
 	],
+	"exports": {
+		".": "./build/index.js",
+		"./lodash": {
+			"types": "./lodash/lodash.types.d.ts",
+			"node": "./build/lodash/main.cjs"
+		},
+		"./string": "./build/src/string/main.js",
+		"./json": "./build/src/json/main.js",
+		"./types": "./build/src/types.js"
+	},
 	"scripts": {
-		"mrm": "mrm --preset=@adonisjs/mrm-preset",
 		"pretest": "npm run lint",
-		"test": "node .bin/test.js",
-		"clean": "del build",
+		"test": "npm run build:lodash && npm run vscode:test",
+		"build:lodash": "lodash include=\"pick,omit,has,get,set,unset,mergeWith,merge,size,clone,cloneDeep,toPath\" --production && move-file ./lodash.custom.min.js build/lodash/main.cjs",
+		"vscode:test": "node --loader=ts-node/esm bin/test.ts",
+		"clean": "del-cli build",
 		"compile": "npm run lint && npm run clean && tsc",
-		"build": "npm run compile",
-		"commit": "git-cz",
-		"release": "np --message=\"chore(release): %s\"",
+		"build": "npm run compile && npm run build:lodash",
+		"release": "np",
 		"version": "npm run build",
-		"format": "prettier --write .",
-		"prepublishOnly": "npm run build",
+		"prepublishOnly": "npm run build && cd build && node bin/test.js",
 		"lint": "eslint . --ext=.ts",
-		"sync-labels": "github-label-sync --labels ./node_modules/@adonisjs/mrm-preset/gh-labels.json poppinss/utils"
+		"format": "prettier --write .",
+		"sync-labels": "github-label-sync --labels .github/labels.json poppinss/utils"
 	},
 	"keywords": [
-		"utils"
+		"toolkit",
+		"utilities"
 	],
 	"author": "virk,poppinss",
 	"license": "MIT",
 	"devDependencies": {
-		"@adonisjs/mrm-preset": "^5.0.3",
-		"@adonisjs/require-ts": "^2.0.11",
-		"@poppinss/dev-utils": "^2.0.3",
-		"@types/fs-readdir-recursive": "^1.0.0",
-		"@types/lodash": "^4.14.181",
-		"@types/ms": "^0.7.31",
-		"@types/node": "^17.0.23",
-		"@types/pluralize": "0.0.29",
-		"@types/require-all": "^3.0.3",
-		"del-cli": "^4.0.1",
-		"doctoc": "^2.1.0",
-		"eslint": "^8.13.0",
+		"@commitlint/cli": "^17.1.2",
+		"@commitlint/config-conventional": "^17.1.0",
+		"@japa/assert": "^1.3.6",
+		"@japa/expect-type": "^1.0.1",
+		"@japa/run-failed-tests": "^1.1.0",
+		"@japa/runner": "^2.2.1",
+		"@japa/spec-reporter": "^1.3.1",
+		"@swc/core": "^1.3.3",
+		"@types/fs-extra": "^9.0.13",
+		"@types/node": "^18.7.19",
+		"del-cli": "^5.0.0",
+		"eslint": "^8.24.0",
 		"eslint-config-prettier": "^8.5.0",
-		"eslint-plugin-adonis": "^2.1.0",
-		"eslint-plugin-prettier": "^4.0.0",
+		"eslint-plugin-adonis": "^3.0.2",
+		"eslint-plugin-prettier": "^4.2.1",
+		"fs-extra": "^10.1.0",
 		"github-label-sync": "^2.2.0",
-		"husky": "^7.0.4",
-		"japa": "^4.0.0",
-		"mrm": "^4.0.0",
-		"np": "^7.6.1",
-		"prettier": "^2.6.2",
-		"typescript": "^4.6.3"
-	},
-	"nyc": {
-		"exclude": [
-			"test"
-		],
-		"extension": [
-			".ts"
-		]
-	},
-	"config": {
-		"commitizen": {
-			"path": "cz-conventional-changelog"
-		}
-	},
-	"np": {
-		"contents": ".",
-		"anyBranch": false
+		"husky": "^8.0.1",
+		"lodash": "^4.17.21",
+		"lodash-cli": "^4.17.5",
+		"move-file-cli": "^3.0.0",
+		"np": "^7.6.2",
+		"prettier": "^2.7.1",
+		"ts-node": "^10.9.1",
+		"typescript": "^4.8.3"
 	},
 	"dependencies": {
-		"@poppinss/file-generator": "^1.0.2",
+		"@lukeed/ms": "^2.0.0",
 		"@types/bytes": "^3.1.1",
-		"@types/he": "^1.1.2",
+		"@types/pluralize": "^0.0.29",
 		"bytes": "^3.1.2",
-		"change-case": "^4.1.2",
-		"cuid": "^2.1.8",
+		"case-anything": "^2.1.10",
 		"flattie": "^1.1.0",
-		"fs-readdir-recursive": "^1.1.0",
-		"he": "^1.2.0",
-		"kind-of": "^6.0.3",
-		"lodash": "^4.17.21",
-		"ms": "^2.1.3",
 		"pluralize": "^8.0.0",
-		"require-all": "^3.0.0",
-		"resolve-from": "^5.0.0",
+		"safe-stable-stringify": "^2.4.0",
+		"secure-json-parse": "^2.5.0",
+		"slash": "^4.0.0",
 		"slugify": "^1.6.5",
-		"truncatise": "0.0.8"
-	},
-	"directories": {
-		"doc": "docs",
-		"test": "test"
+		"truncatise": "^0.0.8"
 	},
 	"repository": {
 		"type": "git",
@@ -106,11 +94,9 @@
 	"eslintConfig": {
 		"extends": [
 			"plugin:adonis/typescriptPackage",
-			"prettier",
 			"prettier"
 		],
 		"plugins": [
-			"prettier",
 			"prettier"
 		],
 		"rules": {
@@ -135,17 +121,19 @@
 		"arrowParens": "always",
 		"printWidth": 100
 	},
-	"mrmConfig": {
-		"core": false,
-		"license": "MIT",
-		"services": [
-			"github-actions"
-		],
-		"minNodeVersion": "16.13.1",
-		"probotApps": [
-			"stale",
-			"lock"
-		],
-		"runGhActionsOnWindows": true
+	"commitlint": {
+		"extends": [
+			"@commitlint/config-conventional"
+		]
+	},
+	"publishConfig": {
+		"access": "public",
+		"tag": "next"
+	},
+	"np": {
+		"message": "chore(release): %s",
+		"tag": "next",
+		"branch": "main",
+		"anyBranch": false
 	}
 }

package/build/helpers.d.ts

@@ -1 +0,0 @@
-export * from './src/Helpers';

package/build/helpers.js

@@ -1,25 +0,0 @@
-"use strict";
-/*
- * @poppinss/utils
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-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/Helpers"), exports);

package/build/src/Exception.d.ts

@@ -1,17 +0,0 @@
-/**
- * Extended Error object with the option to set error `status` and `code`.
- * At AdonisJs, we prefer exceptions with proper error codes to handle
- * them without relying on message pattern matching.
- *
- * ```js
- * new Exception('message', 500, 'E_RUNTIME_EXCEPTION')
- * ```
- */
-export declare class Exception extends Error {
-    name: string;
-    message: string;
-    help?: string;
-    code?: string;
-    status: number;
-    constructor(message: string, status?: number, code?: string);
-}

package/build/src/Exception.js

@@ -1,68 +0,0 @@
-"use strict";
-/*
- * @poppinss/utils
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Exception = void 0;
-/**
- * Extended Error object with the option to set error `status` and `code`.
- * At AdonisJs, we prefer exceptions with proper error codes to handle
- * them without relying on message pattern matching.
- *
- * ```js
- * new Exception('message', 500, 'E_RUNTIME_EXCEPTION')
- * ```
- */
-class Exception extends Error {
-    constructor(message, status = 500, code) {
-        super(message);
-        /**
-         * Set error message
-         */
-        Object.defineProperty(this, 'message', {
-            configurable: true,
-            enumerable: false,
-            value: code ? `${code}: ${message}` : message,
-            writable: true,
-        });
-        /**
-         * Set error name as a public property
-         */
-        Object.defineProperty(this, 'name', {
-            configurable: true,
-            enumerable: false,
-            value: this.constructor.name,
-            writable: true,
-        });
-        /**
-         * Set status as a public property
-         */
-        Object.defineProperty(this, 'status', {
-            configurable: true,
-            enumerable: false,
-            value: status,
-            writable: true,
-        });
-        /**
-         * Set error code as a public property (only when defined)
-         */
-        if (code) {
-            Object.defineProperty(this, 'code', {
-                configurable: true,
-                enumerable: false,
-                value: code,
-                writable: true,
-            });
-        }
-        /**
-         * Update the stack trace
-         */
-        Error.captureStackTrace(this, this.constructor);
-    }
-}
-exports.Exception = Exception;

package/build/src/Helpers/MessageBuilder.d.ts

@@ -1,28 +0,0 @@
-/**
- * Message builder exposes an API to JSON.stringify values by encoding purpose
- * and expiryDate inside them. It returns a readable string, which is the
- * output of `JSON.stringify`.
- *
- * Why use this over `JSON.stringify`?
- *
- * - It protects you from JSON poisioning
- * - Allows encoding expiry dates to the message. It means, the message builer is
- *   helpful, when you want to encode a message and pass it around, but also control
- *   the TTL of the message
- * - Allows encoding purpose. Again, useful for distribution.
- */
-export declare class MessageBuilder {
-    private getExpiryDate;
-    /**
-     * Returns a boolean telling, if message has been expired or not
-     */
-    private isExpired;
-    /**
-     * Builds a message by encoding expiry and purpose inside it
-     */
-    build(message: any, expiresIn?: string | number, purpose?: string): string;
-    /**
-     * Verifies the message for expiry and purpose
-     */
-    verify<T extends any>(message: any, purpose?: string): null | T;
-}

package/build/src/Helpers/MessageBuilder.js

@@ -1,97 +0,0 @@
-"use strict";
-/*
- * @adonisjs/encryption
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MessageBuilder = void 0;
-const ms_1 = __importDefault(require("ms"));
-const safeParse_1 = require("../safeParse");
-const safeStringify_1 = require("../safeStringify");
-/**
- * Message builder exposes an API to JSON.stringify values by encoding purpose
- * and expiryDate inside them. It returns a readable string, which is the
- * output of `JSON.stringify`.
- *
- * Why use this over `JSON.stringify`?
- *
- * - It protects you from JSON poisioning
- * - Allows encoding expiry dates to the message. It means, the message builer is
- *   helpful, when you want to encode a message and pass it around, but also control
- *   the TTL of the message
- * - Allows encoding purpose. Again, useful for distribution.
- */
-class MessageBuilder {
-    getExpiryDate(expiresIn) {
-        if (!expiresIn) {
-            return undefined;
-        }
-        const expiryMs = typeof expiresIn === 'string' ? (0, ms_1.default)(expiresIn) : expiresIn;
-        if (expiryMs === undefined || expiryMs === null) {
-            throw new Error(`Invalid value for expiresIn "${expiresIn}"`);
-        }
-        return new Date(Date.now() + expiryMs);
-    }
-    /**
-     * Returns a boolean telling, if message has been expired or not
-     */
-    isExpired(message) {
-        if (!message.expiryDate) {
-            return false;
-        }
-        try {
-            const expiryDate = new Date(message.expiryDate);
-            return isNaN(expiryDate.getTime()) || expiryDate < new Date();
-        }
-        catch (error) {
-            return true;
-        }
-    }
-    /**
-     * Builds a message by encoding expiry and purpose inside it
-     */
-    build(message, expiresIn, purpose) {
-        const expiryDate = this.getExpiryDate(expiresIn);
-        return (0, safeStringify_1.safeStringify)({ message, purpose, expiryDate });
-    }
-    /**
-     * Verifies the message for expiry and purpose
-     */
-    verify(message, purpose) {
-        const parsed = (0, safeParse_1.safeParse)(message);
-        /**
-         * Safe parse returns the value as it is when unable to JSON.parse it. However, in
-         * our case if value was correctly parsed, it should never match the input
-         */
-        if (parsed === message) {
-            return null;
-        }
-        /**
-         * Missing ".message" property
-         */
-        if (!parsed.message) {
-            return null;
-        }
-        /**
-         * Ensure purposes are same.
-         */
-        if (parsed.purpose !== purpose) {
-            return null;
-        }
-        /**
-         * Ensure isn't expired
-         */
-        if (this.isExpired(parsed)) {
-            return null;
-        }
-        return parsed.message;
-    }
-}
-exports.MessageBuilder = MessageBuilder;

package/build/src/Helpers/ObjectBuilder.d.ts

@@ -1,46 +0,0 @@
-/**
- * A simple class to build an object incrementally. It is helpful when you
- * want to add properties to the object conditionally.
- *
- * Instead of writing
- * ```
- * const obj = {
- *   ...(user.id ? { id: user.id } : {}),
- *   ...(user.firstName && user.lastName ? { name: `${user.firstName} ${user.lastName}` } : {}),
- * }
- * ```
- *
- * You can write
- *
- * const obj = new ObjectBuilder()
- *   .add('id', user.id)
- *   .add(
- *     'fullName',
- *     user.firstName && user.lastName ? `${user.firstName} ${user.lastName}` : undefined
- *   )
- *   .value
- */
-export declare class ObjectBuilder {
-    private ignoreNull?;
-    value: any;
-    constructor(ignoreNull?: boolean | undefined);
-    /**
-     * Add value to the property.
-     *
-     * - Undefined values are ignored
-     * - Null values are ignored, when `ignoreNull` is set to true
-     */
-    add(key: string, value: any): this;
-    /**
-     * Remove value from the object
-     */
-    remove(key: string): this;
-    /**
-     * Find if a value exists
-     */
-    has(key: string): boolean;
-    /**
-     * Get the existing value
-     */
-    get<T extends any>(key: string): T;
-}

package/build/src/Helpers/ObjectBuilder.js

@@ -1,75 +0,0 @@
-"use strict";
-/*
- * @poppinss/utils
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectBuilder = void 0;
-/**
- * A simple class to build an object incrementally. It is helpful when you
- * want to add properties to the object conditionally.
- *
- * Instead of writing
- * ```
- * const obj = {
- *   ...(user.id ? { id: user.id } : {}),
- *   ...(user.firstName && user.lastName ? { name: `${user.firstName} ${user.lastName}` } : {}),
- * }
- * ```
- *
- * You can write
- *
- * const obj = new ObjectBuilder()
- *   .add('id', user.id)
- *   .add(
- *     'fullName',
- *     user.firstName && user.lastName ? `${user.firstName} ${user.lastName}` : undefined
- *   )
- *   .value
- */
-class ObjectBuilder {
-    constructor(ignoreNull) {
-        this.ignoreNull = ignoreNull;
-        this.value = {};
-    }
-    /**
-     * Add value to the property.
-     *
-     * - Undefined values are ignored
-     * - Null values are ignored, when `ignoreNull` is set to true
-     */
-    add(key, value) {
-        if (value === undefined) {
-            return this;
-        }
-        if (this.ignoreNull === true && value === null) {
-            return this;
-        }
-        this.value[key] = value;
-        return this;
-    }
-    /**
-     * Remove value from the object
-     */
-    remove(key) {
-        delete this.value[key];
-        return this;
-    }
-    /**
-     * Find if a value exists
-     */
-    has(key) {
-        return this.get(key) !== undefined;
-    }
-    /**
-     * Get the existing value
-     */
-    get(key) {
-        return this.value[key];
-    }
-}
-exports.ObjectBuilder = ObjectBuilder;

package/build/src/Helpers/compose.d.ts

@@ -1,21 +0,0 @@
-declare type Constructor = new (...args: any[]) => any;
-/**
- * Converting unions to intersection
- */
-declare type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) extends (x: infer R) => any ? R : never;
-/**
- * Normalizes constructor to work with mixins. There is an open bug for mixins
- * to allow constructors other than `...args: any[]`
- *
- * https://github.com/microsoft/TypeScript/issues/37142
- */
-export declare type NormalizeConstructor<T extends Constructor> = {
-    new (...args: any[]): InstanceType<T>;
-} & Omit<T, 'constructor'>;
-/**
- * Compose a class by applying mixins to it.
- * The code is inspired by https://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/, its
- * just that I have added the support for static types too.
- */
-export declare const compose: <SuperClass extends Constructor, M extends ((superclass: SuperClass) => Constructor)[]>(superclass: SuperClass, ...mixins: M) => SuperClass & UnionToIntersection<ReturnType<M[number]>>;
-export {};

package/build/src/Helpers/compose.js

@@ -1,20 +0,0 @@
-"use strict";
-/*
- * @poppinss/utils
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compose = void 0;
-/**
- * Compose a class by applying mixins to it.
- * The code is inspired by https://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/, its
- * just that I have added the support for static types too.
- */
-const compose = (superclass, ...mixins) => {
-    return mixins.reduce((c, mixin) => mixin(c), superclass);
-};
-exports.compose = compose;

package/build/src/Helpers/fsReadAll.d.ts

@@ -1,4 +0,0 @@
-/**
- * Returns an array of file paths from the given location.
- */
-export declare function fsReadAll(location: string, callback?: (file: string) => boolean): string[];

package/build/src/Helpers/fsReadAll.js

@@ -1,23 +0,0 @@
-"use strict";
-/*
- * @poppinss/utils
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fsReadAll = void 0;
-const fs_readdir_recursive_1 = __importDefault(require("fs-readdir-recursive"));
-const isScriptFile_1 = require("../isScriptFile");
-/**
- * Returns an array of file paths from the given location.
- */
-function fsReadAll(location, callback) {
-    return (0, fs_readdir_recursive_1.default)(location).filter(typeof callback === 'function' ? callback : isScriptFile_1.isScriptFile);
-}
-exports.fsReadAll = fsReadAll;

package/build/src/Helpers/index.d.ts

@@ -1,14 +0,0 @@
-export { default as cuid } from 'cuid';
-export * as file from '@poppinss/file-generator';
-export { base64 } from './base64';
-export { compose, NormalizeConstructor } from './compose';
-export { fsReadAll } from './fsReadAll';
-export { interpolate } from './interpolate';
-export { MessageBuilder } from './MessageBuilder';
-export { ObjectBuilder } from './ObjectBuilder';
-export { requireAll } from './requireAll';
-export { resolveDir } from './resolveDir';
-export { resolveFrom } from './resolveFrom';
-export { safeEqual } from './safeEqual';
-export * as string from './string';
-export * as types from './types';