@poppinss/utils 5.0.0 → 6.0.0-0

package/build/src/Helpers/index.js

@@ -1,62 +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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.types = exports.string = exports.safeEqual = exports.resolveFrom = exports.resolveDir = exports.requireAll = exports.ObjectBuilder = exports.MessageBuilder = exports.interpolate = exports.fsReadAll = exports.compose = exports.base64 = exports.file = exports.cuid = void 0;
-var cuid_1 = require("cuid");
-Object.defineProperty(exports, "cuid", { enumerable: true, get: function () { return __importDefault(cuid_1).default; } });
-exports.file = __importStar(require("@poppinss/file-generator"));
-var base64_1 = require("./base64");
-Object.defineProperty(exports, "base64", { enumerable: true, get: function () { return base64_1.base64; } });
-var compose_1 = require("./compose");
-Object.defineProperty(exports, "compose", { enumerable: true, get: function () { return compose_1.compose; } });
-var fsReadAll_1 = require("./fsReadAll");
-Object.defineProperty(exports, "fsReadAll", { enumerable: true, get: function () { return fsReadAll_1.fsReadAll; } });
-var interpolate_1 = require("./interpolate");
-Object.defineProperty(exports, "interpolate", { enumerable: true, get: function () { return interpolate_1.interpolate; } });
-var MessageBuilder_1 = require("./MessageBuilder");
-Object.defineProperty(exports, "MessageBuilder", { enumerable: true, get: function () { return MessageBuilder_1.MessageBuilder; } });
-var ObjectBuilder_1 = require("./ObjectBuilder");
-Object.defineProperty(exports, "ObjectBuilder", { enumerable: true, get: function () { return ObjectBuilder_1.ObjectBuilder; } });
-var requireAll_1 = require("./requireAll");
-Object.defineProperty(exports, "requireAll", { enumerable: true, get: function () { return requireAll_1.requireAll; } });
-var resolveDir_1 = require("./resolveDir");
-Object.defineProperty(exports, "resolveDir", { enumerable: true, get: function () { return resolveDir_1.resolveDir; } });
-var resolveFrom_1 = require("./resolveFrom");
-Object.defineProperty(exports, "resolveFrom", { enumerable: true, get: function () { return resolveFrom_1.resolveFrom; } });
-var safeEqual_1 = require("./safeEqual");
-Object.defineProperty(exports, "safeEqual", { enumerable: true, get: function () { return safeEqual_1.safeEqual; } });
-exports.string = __importStar(require("./string"));
-exports.types = __importStar(require("./types"));

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

@@ -1,7 +0,0 @@
-/**
- * A simple function interpolate values inside curly braces.
- *
- * @example
- * `interpolate('hello {{ username }}', { username: 'virk' })`
- */
-export declare function interpolate(input: string, data: any): string;

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

@@ -1,8 +0,0 @@
-/**
- * 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.
- */
-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

@@ -1,65 +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.requireAll = void 0;
-const path_1 = require("path");
-const require_all_1 = __importDefault(require("require-all"));
-const esmResolver_1 = require("../esmResolver");
-const isScriptFile_1 = require("../isScriptFile");
-/**
- * Function to filter and keep script files only
- */
-function fileFilter(file) {
-    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, filter = fileFilter) {
-    try {
-        return (0, require_all_1.default)({
-            dirname: location,
-            recursive,
-            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,
-        });
-    }
-    catch (error) {
-        if (error.code === 'ENOENT' && optional) {
-            return;
-        }
-        else {
-            throw error;
-        }
-    }
-}
-exports.requireAll = requireAll;

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

@@ -1,5 +0,0 @@
-/**
- * Resolves path to a given directory. The method is similar to `require.resolve`,
- * but also works for directories with no `index.js` file.
- */
-export declare function resolveDir(fromLocation: string, dirPath: string): string;

package/build/src/Helpers/resolveDir.js

@@ -1,46 +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.resolveDir = void 0;
-const resolve_from_1 = __importDefault(require("resolve-from"));
-const path_1 = require("path");
-/**
- * Resolves path to a given directory. The method is similar to `require.resolve`,
- * but also works for directories with no `index.js` file.
- */
-function resolveDir(fromLocation, 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 (0, path_1.join)(fromLocation, dirPath);
-    }
-    /**
-     * From here on, we are dealing with a package inside node module.
-     */
-    let packageName = '';
-    const tokens = dirPath.replace(/\\/g, '/').split('/');
-    if (tokens.length && tokens[0].startsWith('@')) {
-        packageName = `${tokens.shift()}/`;
-    }
-    packageName += tokens.shift();
-    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 (0, path_1.join)((0, path_1.dirname)(resolved), tokens.join('/'));
-}
-exports.resolveDir = resolveDir;

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

@@ -1,5 +0,0 @@
-/**
- * Resolves module from a given directory. It is similar to `require.resolve`
- * but carefull handles the absolute paths.
- */
-export declare function resolveFrom(fromLocation: string, modulePath: string): string;

package/build/src/Helpers/resolveFrom.js

@@ -1,27 +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.resolveFrom = void 0;
-const path_1 = require("path");
-const resolve_from_1 = __importDefault(require("resolve-from"));
-/**
- * Resolves module from a given directory. It is similar to `require.resolve`
- * but carefull handles the absolute paths.
- */
-function resolveFrom(fromLocation, modulePath) {
-    if ((0, path_1.isAbsolute)(modulePath)) {
-        return modulePath;
-    }
-    return (0, resolve_from_1.default)(fromLocation, modulePath);
-}
-exports.resolveFrom = resolveFrom;

package/build/src/Helpers/safeEqual.js

@@ -1,42 +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.safeEqual = void 0;
-const buffer_1 = require("buffer");
-const crypto_1 = require("crypto");
-/**
- * Generates a random string for a given size
- */
-function safeEqual(value, comparisonValue) {
-    if (typeof value === 'string' && typeof comparisonValue === 'string') {
-        /**
-         * The length of the main value to ensure that we compare equal strings
-         * against each other to get a constant time.
-         */
-        const expectedLength = buffer_1.Buffer.byteLength(value);
-        /**
-         * Value A
-         */
-        const valueBuffer = buffer_1.Buffer.alloc(expectedLength, 0, 'utf-8');
-        valueBuffer.write(value);
-        /**
-         * Value B
-         */
-        const comparisonValueBuffer = buffer_1.Buffer.alloc(expectedLength, 0, 'utf-8');
-        comparisonValueBuffer.write(comparisonValue);
-        /**
-         * Ensure values are same and also have same length
-         */
-        return ((0, crypto_1.timingSafeEqual)(valueBuffer, comparisonValueBuffer) &&
-            expectedLength === buffer_1.Buffer.byteLength(comparisonValue));
-    }
-    return (0, crypto_1.timingSafeEqual)(buffer_1.Buffer.from(value), buffer_1.Buffer.from(comparisonValue));
-}
-exports.safeEqual = safeEqual;

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

@@ -1,124 +0,0 @@
-import { EncodeOptions } from 'he';
-import { BytesOptions } from 'bytes';
-export { default as toSlug } from 'slugify';
-/**
- * The method is a copy/paste from the "title-case" package. They have
- * a dependency on "tslib", which I don't want.
- */
-export declare function titleCase(input: string): string;
-/**
- * Define an irregular rule
- */
-export declare function defineIrregularRule(singleValue: string, pluralValue: string): void;
-/**
- * Define uncountable rule
- */
-export declare function defineUncountableRule(word: string): void;
-/**
- * Convert string to camelcase
- */
-export declare function camelCase(value: string): string;
-/**
- * Convert string to snakecase
- */
-export declare function snakeCase(value: string): string;
-/**
- * Convert string to dashcase
- */
-export declare function dashCase(value: string, options?: {
-    capitalize?: boolean;
-}): string;
-/**
- * Convert string to pascal case
- */
-export declare function pascalCase(value: string): string;
-/**
- * Convert string to capital case
- */
-export declare function capitalCase(value: string): string;
-/**
- * Convert string to sentence case
- */
-export declare function sentenceCase(value: string): string;
-/**
- * Convert string to dot case
- */
-export declare function dotCase(value: string): string;
-/**
- * Remove all sort of casing from the string
- */
-export declare function noCase(value: string): string;
-/**
- * Pluralize a word
- */
-export declare function pluralize(word: string): string;
-/**
- * Singularize a word
- */
-export declare function singularize(word: string): string;
-/**
- * Truncate a sentence till a give limit of characters
- */
-export declare function truncate(sentence: string, charactersLimit: number, options?: {
-    completeWords?: boolean;
-    suffix?: string;
-}): string;
-/**
- * Same as truncate, but strips out the HTML
- */
-export declare function excerpt(sentence: string, charactersLimit: number, options?: {
-    completeWords?: boolean;
-    suffix?: string;
-}): string;
-/**
- * Condenses multiple whitespaces from a string
- */
-export declare function condenseWhitespace(value: string): string;
-/**
- * Escape HTML entities
- */
-export declare function escapeHTML(value: string, options?: {
-    encodeSymbols?: boolean;
-}): string;
-/**
- * Encode symbols that aren’t printable ASCII symbols
- */
-export declare function encodeSymbols(value: string, options?: EncodeOptions): string;
-/**
- * Convert array of values to a sentence
- */
-export declare function toSentence(values: any[], options?: {
-    separator?: string;
-    pairSeparator?: string;
-    lastSeparator?: string;
-}): string;
-/**
- * Convert a number to a human readable string
- */
-export declare function prettyBytes(value: number, options?: BytesOptions): string;
-/**
- * Convert milliseconds to a human readable string
- */
-export declare function prettyMs(value: number, options?: {
-    long: boolean;
-}): string;
-/**
- * Find if a string is empty. Including any number of whitespaces
- */
-export declare function isEmpty(value: string): boolean;
-/**
- * Ordinalize a give number or string
- */
-export declare function ordinalize(value: string | number): string;
-/**
- * Converts unit expression to bytes
- */
-export declare function toBytes(value: string | number): number;
-/**
- * Converts time expression to milliseconds
- */
-export declare function toMs(value: string | number): number;
-/**
- * Generates a random string for a given size
- */
-export declare function generateRandom(size: number): string;