@poppinss/utils 3.2.0 → 4.0.0

package/README.md

@@ -113,6 +113,7 @@ string.titleCase()
 - [Safe stringify](#safe-stringify)
 - [Safe parse](#safe-parse)
 - [defineStaticProperty](#definestaticproperty)
+- [flatten](#flatten)
 - [Helpers](#helpers)
   - [fsReadAll](#fsreadall)
   - [requireAll](#requireall)
@@ -379,6 +380,48 @@ The `defineStaticProperty` takes a total of three arguments.
 - The `inherit` strategy will copy the properties from the base class.
 - The `define` strategy will always use the `defaultValue` to define the property on the class. In other words, there is no copy behavior, but prototypal inheritance chain is also breaked by explicitly re-defining the property.
 
+## flatten
+Flatten an object/array. The method wraps the [flattie](https://github.com/lukeed/flattie) package.
+
+```ts
+import { flatten } from '@poppinss/utils'
+
+flatten({
+  a: 'hi',
+  b: {
+    a: null,
+    b: ['foo', '', null, 'bar'],
+    d: 'hello',
+    e: {
+      a: 'yo',
+      b: undefined,
+      c: 'sup',
+      d: 0,
+      f: [
+        { foo: 123, bar: 123 },
+        { foo: 465, bar: 456 },
+      ]
+    }
+  },
+  c: 'world'
+});
+// {
+//   'a': 'hi',
+//   'b.b.0': 'foo',
+//   'b.b.1': '',
+//   'b.b.3': 'bar',
+//   'b.d': 'hello',
+//   'b.e.a': 'yo',
+//   'b.e.c': 'sup',
+//   'b.e.d': 0,
+//   'b.e.f.0.foo': 123,
+//   'b.e.f.0.bar': 123,
+//   'b.e.f.1.foo': 465,
+//   'b.e.f.1.bar': 456,
+//   'c': 'world'
+// }
+```
+
 ## Helpers
 
 The helpers module is also available in AdonisJS applications as follows:
@@ -426,6 +469,16 @@ const config = requireAll(join(__dirname, 'config'))
 }
 ```
 
+The method also accepts the following options
+
+```ts
+requireAll(join(__dirname, 'config'), recursive, optional, filter)
+```
+
+- `recursive` Load all files recursively. Defaults to true.
+- `optional` Do not raise exception when the root directory is missing. Defaults to false.
+- `filter` Cherry pick files to require. By default, all JavaScript, TypeScript and JSON files are required.
+
 ### resolveFrom
 
 Works similar to `require.resolve`, however it handles the absolute paths properly.

package/build/index.d.ts

@@ -1,5 +1,6 @@
 export * as lodash from './src/lodash';
 export { slash } from './src/slash';
+export { flatten } from './src/flatten';
 export { Exception } from './src/Exception';
 export { safeParse } from './src/safeParse';
 export { esmRequire } from './src/esmRequire';

package/build/index.js

@@ -27,10 +27,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ManagerConfigValidator = exports.defineStaticProperty = exports.safeStringify = exports.esmResolver = exports.esmRequire = exports.safeParse = exports.Exception = exports.slash = exports.lodash = void 0;
+exports.ManagerConfigValidator = exports.defineStaticProperty = exports.safeStringify = exports.esmResolver = exports.esmRequire = exports.safeParse = exports.Exception = exports.flatten = exports.slash = exports.lodash = void 0;
 exports.lodash = __importStar(require("./src/lodash"));
 var slash_1 = require("./src/slash");
 Object.defineProperty(exports, "slash", { enumerable: true, get: function () { return slash_1.slash; } });
+var flatten_1 = require("./src/flatten");
+Object.defineProperty(exports, "flatten", { enumerable: true, get: function () { return flatten_1.flatten; } });
 var Exception_1 = require("./src/Exception");
 Object.defineProperty(exports, "Exception", { enumerable: true, get: function () { return Exception_1.Exception; } });
 var safeParse_1 = require("./src/safeParse");

package/build/src/Helpers/MessageBuilder.js

@@ -33,7 +33,7 @@ class MessageBuilder {
         if (!expiresIn) {
             return undefined;
         }
-        const expiryMs = typeof expiresIn === 'string' ? ms_1.default(expiresIn) : expiresIn;
+        const expiryMs = typeof expiresIn === 'string' ? (0, ms_1.default)(expiresIn) : expiresIn;
         if (expiryMs === undefined || expiryMs === null) {
             throw new Error(`Invalid value for expiresIn "${expiresIn}"`);
         }
@@ -59,13 +59,13 @@ class MessageBuilder {
      */
     build(message, expiresIn, purpose) {
         const expiryDate = this.getExpiryDate(expiresIn);
-        return safeStringify_1.safeStringify({ message, purpose, expiryDate });
+        return (0, safeStringify_1.safeStringify)({ message, purpose, expiryDate });
     }
     /**
      * Verifies the message for expiry and purpose
      */
     verify(message, purpose) {
-        const parsed = safeParse_1.safeParse(message);
+        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

package/build/src/Helpers/fsReadAll.js

@@ -18,6 +18,6 @@ const isScriptFile_1 = require("../isScriptFile");
  * Returns an array of file paths from the given location.
  */
 function fsReadAll(location, callback) {
-    return fs_readdir_recursive_1.default(location).filter(typeof callback === 'function' ? callback : isScriptFile_1.isScriptFile);
+    return (0, fs_readdir_recursive_1.default)(location).filter(typeof callback === 'function' ? callback : isScriptFile_1.isScriptFile);
 }
 exports.fsReadAll = fsReadAll;

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

@@ -3,6 +3,6 @@
  * for files ending with `.ts`, `.js` and `.json`. Also files ending with
  * `.d.ts` are ignored.
  */
-export declare function requireAll(location: string, recursive?: boolean, optional?: boolean): {
+export declare function requireAll(location: string, recursive?: boolean, optional?: boolean, filter?: (file: string) => boolean | string): {
     [key: string]: any;
 } | undefined;

package/build/src/Helpers/requireAll.js

@@ -17,26 +17,39 @@ const require_all_1 = __importDefault(require("require-all"));
 const esmResolver_1 = require("../esmResolver");
 const isScriptFile_1 = require("../isScriptFile");
 /**
- * Function to filter selected files only
+ * Function to filter and keep script files only
  */
 function fileFilter(file) {
-    const ext = path_1.extname(file);
-    if (!isScriptFile_1.isScriptFile(file)) {
-        return false;
-    }
-    return file.replace(new RegExp(`${ext}$`), '');
+    return (0, isScriptFile_1.isScriptFile)(file);
 }
 /**
  * Require all files from a given directory. The method automatically looks
  * for files ending with `.ts`, `.js` and `.json`. Also files ending with
  * `.d.ts` are ignored.
  */
-function requireAll(location, recursive = true, optional = false) {
+function requireAll(location, recursive = true, optional = false, filter = fileFilter) {
     try {
-        return require_all_1.default({
+        return (0, require_all_1.default)({
             dirname: location,
             recursive,
-            filter: fileFilter,
+            filter: (file) => {
+                let result = true;
+                /**
+                 * Invoke user defined function
+                 */
+                if (typeof filter === 'function') {
+                    result = filter(file);
+                }
+                /**
+                 * Use the default file name when file is meant to
+                 * be kept
+                 */
+                if (result === true) {
+                    const ext = (0, path_1.extname)(file);
+                    return file.replace(new RegExp(`${ext}$`), '');
+                }
+                return result;
+            },
             resolve: esmResolver_1.esmResolver,
         });
     }

package/build/src/Helpers/resolveDir.js

@@ -19,14 +19,14 @@ const path_1 = require("path");
  * but also works for directories with no `index.js` file.
  */
 function resolveDir(fromLocation, dirPath) {
-    if (path_1.isAbsolute(dirPath)) {
+    if ((0, path_1.isAbsolute)(dirPath)) {
         return dirPath;
     }
     /**
      * Relative paths are made by joining the baseDir
      */
     if (dirPath.startsWith('./') || dirPath.startsWith(`.${path_1.sep}`)) {
-        return path_1.join(fromLocation, dirPath);
+        return (0, path_1.join)(fromLocation, dirPath);
     }
     /**
      * From here on, we are dealing with a package inside node module.
@@ -37,10 +37,10 @@ function resolveDir(fromLocation, dirPath) {
         packageName = `${tokens.shift()}/`;
     }
     packageName += tokens.shift();
-    const resolved = resolve_from_1.default.silent(fromLocation, path_1.join(packageName, 'package.json'));
+    const resolved = resolve_from_1.default.silent(fromLocation, (0, path_1.join)(packageName, 'package.json'));
     if (!resolved) {
         throw new Error(`Cannot locate directory "${dirPath}"`);
     }
-    return path_1.join(path_1.dirname(resolved), tokens.join('/'));
+    return (0, path_1.join)((0, path_1.dirname)(resolved), tokens.join('/'));
 }
 exports.resolveDir = resolveDir;

package/build/src/Helpers/resolveFrom.js

@@ -19,9 +19,9 @@ const resolve_from_1 = __importDefault(require("resolve-from"));
  * but carefull handles the absolute paths.
  */
 function resolveFrom(fromLocation, modulePath) {
-    if (path_1.isAbsolute(modulePath)) {
+    if ((0, path_1.isAbsolute)(modulePath)) {
         return modulePath;
     }
-    return resolve_from_1.default(fromLocation, modulePath);
+    return (0, resolve_from_1.default)(fromLocation, modulePath);
 }
 exports.resolveFrom = resolveFrom;

package/build/src/Helpers/safeEqual.js

@@ -27,19 +27,19 @@ function safeEqual(value, comparisonValue) {
         /**
          * Value A
          */
-        const valueBuffer = buffer_alloc_1.default(expectedLength, 0, 'utf-8');
+        const valueBuffer = (0, buffer_alloc_1.default)(expectedLength, 0, 'utf-8');
         valueBuffer.write(value);
         /**
          * Value B
          */
-        const comparisonValueBuffer = buffer_alloc_1.default(expectedLength, 0, 'utf-8');
+        const comparisonValueBuffer = (0, buffer_alloc_1.default)(expectedLength, 0, 'utf-8');
         comparisonValueBuffer.write(comparisonValue);
         /**
          * Ensure values are same and also have same length
          */
-        return (crypto_1.timingSafeEqual(valueBuffer, comparisonValueBuffer) &&
+        return ((0, crypto_1.timingSafeEqual)(valueBuffer, comparisonValueBuffer) &&
             expectedLength === Buffer.byteLength(comparisonValue));
     }
-    return crypto_1.timingSafeEqual(Buffer.from(value), Buffer.from(comparisonValue));
+    return (0, crypto_1.timingSafeEqual)(Buffer.from(value), Buffer.from(comparisonValue));
 }
 exports.safeEqual = safeEqual;

package/build/src/Helpers/string.js

@@ -76,14 +76,14 @@ function normalizeBase64(value) {
  * Define an irregular rule
  */
 function defineIrregularRule(singleValue, pluralValue) {
-    pluralize_1.addIrregularRule(singleValue, pluralValue);
+    (0, pluralize_1.addIrregularRule)(singleValue, pluralValue);
 }
 exports.defineIrregularRule = defineIrregularRule;
 /**
  * Define uncountable rule
  */
 function defineUncountableRule(word) {
-    pluralize_1.addUncountableRule(word);
+    (0, pluralize_1.addUncountableRule)(word);
 }
 exports.defineUncountableRule = defineUncountableRule;
 /**
@@ -149,21 +149,21 @@ exports.noCase = noCase;
  * Pluralize a word
  */
 function pluralize(word) {
-    return pluralize_1.plural(word);
+    return (0, pluralize_1.plural)(word);
 }
 exports.pluralize = pluralize;
 /**
  * Singularize a word
  */
 function singularize(word) {
-    return pluralize_1.singular(word);
+    return (0, pluralize_1.singular)(word);
 }
 exports.singularize = singularize;
 /**
  * Truncate a sentence till a give limit of characters
  */
 function truncate(sentence, charactersLimit, options) {
-    return truncatise_1.default(sentence, {
+    return (0, truncatise_1.default)(sentence, {
         TruncateLength: charactersLimit,
         /**
          * Do not complete words when "completeWords" is not explicitly set
@@ -180,7 +180,7 @@ exports.truncate = truncate;
  * Same as truncate, but strips out the HTML
  */
 function excerpt(sentence, charactersLimit, options) {
-    return truncatise_1.default(sentence, {
+    return (0, truncatise_1.default)(sentence, {
         TruncateLength: charactersLimit,
         /**
          * Do not complete words when "completeWords" is not explicitly set
@@ -258,7 +258,7 @@ exports.prettyBytes = prettyBytes;
  * Convert milliseconds to a human readable string
  */
 function prettyMs(value, options) {
-    return ms_1.default(value, options);
+    return (0, ms_1.default)(value, options);
 }
 exports.prettyMs = prettyMs;
 /**
@@ -310,7 +310,7 @@ function toMs(value) {
     if (typeof value === 'number') {
         return value;
     }
-    return ms_1.default(value);
+    return (0, ms_1.default)(value);
 }
 exports.toMs = toMs;
 /**
@@ -318,7 +318,7 @@ exports.toMs = toMs;
  */
 function generateRandom(size) {
     const bits = (size + 1) * 6;
-    const buffer = crypto_1.randomBytes(Math.ceil(bits / 8));
+    const buffer = (0, crypto_1.randomBytes)(Math.ceil(bits / 8));
     return normalizeBase64(buffer.toString('base64')).slice(0, size);
 }
 exports.generateRandom = generateRandom;

package/build/src/Helpers/types.js

@@ -18,7 +18,7 @@ const toString = Function.prototype.toString;
  * Lookup the type for a given value
  */
 function lookup(value) {
-    const kind = kind_of_1.default(value);
+    const kind = (0, kind_of_1.default)(value);
     if (kind === 'function' && /^class\s/.test(toString.call(value))) {
         return 'class';
     }

package/build/src/defineStaticProperty.d.ts

@@ -1,8 +1,11 @@
+declare type Constructor = new (...args: any[]) => any;
+declare type AbstractConstructor = abstract new (...args: any[]) => any;
 /**
  * Define static properties on a class with inheritance in play.
  */
-export declare function defineStaticProperty<Base extends Function, Prop extends keyof Base>(self: any, BaseClass: Base, { propertyName, defaultValue, strategy, }: {
+export declare function defineStaticProperty<T extends Constructor | AbstractConstructor, Prop extends keyof T>(self: T, BaseClass: Constructor | AbstractConstructor, { propertyName, defaultValue, strategy, }: {
     propertyName: Prop;
-    defaultValue: Base[Prop];
-    strategy: 'inherit' | 'define' | ((value: Base[Prop]) => Base[Prop]);
+    defaultValue: T[Prop];
+    strategy: 'inherit' | 'define' | ((value: T[Prop]) => T[Prop]);
 }): void;
+export {};

package/build/src/defineStaticProperty.js

@@ -47,7 +47,7 @@ function defineStaticProperty(self, BaseClass, { propertyName, defaultValue, str
             return;
         }
         Object.defineProperty(self, propertyName, {
-            value: typeof strategy === 'function' ? strategy(value) : cloneDeep_1.default(value),
+            value: typeof strategy === 'function' ? strategy(value) : (0, cloneDeep_1.default)(value),
             configurable: true,
             enumerable: true,
             writable: true,

package/build/src/esmRequire.js

@@ -15,6 +15,6 @@ const esmResolver_1 = require("./esmResolver");
  * exports are only entertained, when `esmEnabled` is set to true.
  */
 function esmRequire(filePath) {
-    return esmResolver_1.esmResolver(require(filePath));
+    return (0, esmResolver_1.esmResolver)(require(filePath));
 }
 exports.esmRequire = esmRequire;

package/build/src/flatten.d.ts

@@ -0,0 +1 @@
+export { flattie as flatten } from 'flattie';

package/build/src/flatten.js

@@ -0,0 +1,13 @@
+"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.flatten = void 0;
+var flattie_1 = require("flattie");
+Object.defineProperty(exports, "flatten", { enumerable: true, get: function () { return flattie_1.flattie; } });

package/build/src/isScriptFile.js

@@ -16,7 +16,7 @@ const JS_MODULES = ['.js', '.json'];
  * `.ts` but not `.d.ts`.
  */
 function isScriptFile(file) {
-    const ext = path_1.extname(file);
+    const ext = (0, path_1.extname)(file);
     if (JS_MODULES.includes(ext)) {
         return true;
     }

package/build/src/safeStringify.js

@@ -33,7 +33,7 @@ function safeStringify(value, replacer, space) {
         return JSON.stringify(value, jsonStringifyReplacer(replacer, false), space);
     }
     catch {
-        return fast_safe_stringify_1.stringify(value, jsonStringifyReplacer(replacer, true), space);
+        return (0, fast_safe_stringify_1.stringify)(value, jsonStringifyReplacer(replacer, true), space);
     }
 }
 exports.safeStringify = safeStringify;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@poppinss/utils",
-	"version": "3.2.0",
+	"version": "4.0.0",
 	"description": "Handy utilities for repetitive work",
 	"main": "build/index.js",
 	"files": [
@@ -14,12 +14,12 @@
 	"scripts": {
 		"mrm": "mrm --preset=@adonisjs/mrm-preset",
 		"pretest": "npm run lint",
-		"test": "node japaFile.js",
+		"test": "node .bin/test.js",
 		"clean": "del build",
 		"compile": "npm run lint && npm run clean && tsc",
 		"build": "npm run compile",
 		"commit": "git-cz",
-		"release": "np",
+		"release": "np --message=\"chore(release): %s\"",
 		"version": "npm run build",
 		"format": "prettier --write .",
 		"prepublishOnly": "npm run build",
@@ -32,28 +32,28 @@
 	"author": "virk,poppinss",
 	"license": "MIT",
 	"devDependencies": {
-		"@adonisjs/mrm-preset": "^4.1.2",
-		"@adonisjs/require-ts": "^2.0.7",
+		"@adonisjs/mrm-preset": "^5.0.2",
+		"@adonisjs/require-ts": "^2.0.8",
 		"@poppinss/dev-utils": "^1.1.5",
 		"@types/fs-readdir-recursive": "^1.0.0",
-		"@types/lodash": "^4.14.171",
+		"@types/lodash": "^4.14.178",
 		"@types/ms": "^0.7.31",
-		"@types/node": "^16.4.5",
+		"@types/node": "^17.0.0",
 		"@types/pluralize": "0.0.29",
 		"@types/require-all": "^3.0.3",
 		"del-cli": "^4.0.1",
-		"doctoc": "^2.0.1",
-		"eslint": "^7.31.0",
+		"doctoc": "^2.1.0",
+		"eslint": "^8.4.1",
 		"eslint-config-prettier": "^8.3.0",
-		"eslint-plugin-adonis": "^1.3.3",
-		"eslint-plugin-prettier": "^3.4.0",
+		"eslint-plugin-adonis": "^2.1.0",
+		"eslint-plugin-prettier": "^4.0.0",
 		"github-label-sync": "^2.0.2",
-		"husky": "^7.0.1",
-		"japa": "^3.1.1",
-		"mrm": "^3.0.5",
-		"np": "^7.5.0",
-		"prettier": "^2.3.2",
-		"typescript": "^4.3.5"
+		"husky": "^7.0.4",
+		"japa": "^4.0.0",
+		"mrm": "^3.0.10",
+		"np": "^7.6.0",
+		"prettier": "^2.5.1",
+		"typescript": "^4.5.4"
 	},
 	"nyc": {
 		"exclude": [
@@ -76,9 +76,10 @@
 		"@types/bytes": "^3.1.1",
 		"@types/he": "^1.1.2",
 		"buffer-alloc": "^1.2.0",
-		"bytes": "^3.1.0",
+		"bytes": "^3.1.1",
 		"change-case": "^4.1.2",
 		"cuid": "^2.1.8",
+		"flattie": "^1.1.0",
 		"fs-readdir-recursive": "^1.1.0",
 		"he": "^1.2.0",
 		"kind-of": "^6.0.3",
@@ -87,7 +88,7 @@
 		"pluralize": "^8.0.0",
 		"require-all": "^3.0.0",
 		"resolve-from": "^5.0.0",
-		"slugify": "^1.6.0",
+		"slugify": "^1.6.4",
 		"truncatise": "0.0.8"
 	},
 	"directories": {
@@ -101,5 +102,50 @@
 	"bugs": {
 		"url": "https://github.com/poppinss/utils/issues"
 	},
-	"homepage": "https://github.com/poppinss/utils#readme"
+	"homepage": "https://github.com/poppinss/utils#readme",
+	"eslintConfig": {
+		"extends": [
+			"plugin:adonis/typescriptPackage",
+			"prettier",
+			"prettier"
+		],
+		"plugins": [
+			"prettier",
+			"prettier"
+		],
+		"rules": {
+			"prettier/prettier": [
+				"error",
+				{
+					"endOfLine": "auto"
+				}
+			]
+		}
+	},
+	"eslintIgnore": [
+		"build"
+	],
+	"prettier": {
+		"trailingComma": "es5",
+		"semi": false,
+		"singleQuote": true,
+		"useTabs": false,
+		"quoteProps": "consistent",
+		"bracketSpacing": true,
+		"arrowParens": "always",
+		"printWidth": 100
+	},
+	"mrmConfig": {
+		"core": false,
+		"license": "MIT",
+		"services": [
+			"github-actions"
+		],
+		"minNodeVersion": "16.13.1",
+		"probotApps": [
+			"stale",
+			"lock"
+		],
+		"runGhActionsOnWindows": true
+	}
 }