@poppinss/utils 4.0.4 → 6.0.0-0

package/build/src/Helpers/string.js

@@ -1,328 +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.generateRandom = exports.toMs = exports.toBytes = exports.ordinalize = exports.isEmpty = exports.prettyMs = exports.prettyBytes = exports.toSentence = exports.encodeSymbols = exports.escapeHTML = exports.condenseWhitespace = exports.excerpt = exports.truncate = exports.singularize = exports.pluralize = exports.noCase = exports.dotCase = exports.sentenceCase = exports.capitalCase = exports.pascalCase = exports.dashCase = exports.snakeCase = exports.camelCase = exports.defineUncountableRule = exports.defineIrregularRule = exports.titleCase = exports.toSlug = void 0;
-const ms_1 = __importDefault(require("ms"));
-const truncatise_1 = __importDefault(require("truncatise"));
-const crypto_1 = require("crypto");
-const he_1 = __importDefault(require("he"));
-const changeCase = __importStar(require("change-case"));
-const bytes_1 = __importDefault(require("bytes"));
-const pluralize_1 = require("pluralize");
-var slugify_1 = require("slugify");
-Object.defineProperty(exports, "toSlug", { enumerable: true, get: function () { return __importDefault(slugify_1).default; } });
-const SMALL_WORDS = /\b(?:an?d?|a[st]|because|but|by|en|for|i[fn]|neither|nor|o[fnr]|only|over|per|so|some|tha[tn]|the|to|up|upon|vs?\.?|versus|via|when|with|without|yet)\b/i;
-const TOKENS = /[^\s:–—-]+|./g;
-const WHITESPACE = /\s/;
-const IS_MANUAL_CASE = /.(?=[A-Z]|\..)/;
-const ALPHANUMERIC_PATTERN = /[A-Za-z0-9\u00C0-\u00FF]/;
-/**
- * The method is a copy/paste from the "title-case" package. They have
- * a dependency on "tslib", which I don't want.
- */
-function titleCase(input) {
-    let output = '';
-    let result;
-    while ((result = TOKENS.exec(input)) !== null) {
-        const { 0: token, index } = result;
-        if (!IS_MANUAL_CASE.test(token) &&
-            (!SMALL_WORDS.test(token) || index === 0 || index + token.length === input.length) &&
-            (input.charAt(index + token.length) !== ':' ||
-                WHITESPACE.test(input.charAt(index + token.length + 1)))) {
-            output += token.replace(ALPHANUMERIC_PATTERN, (char) => char.toUpperCase());
-            continue;
-        }
-        output += token;
-    }
-    return output;
-}
-exports.titleCase = titleCase;
-/**
- * Normalizes base64 string by removing special chars and padding
- */
-function normalizeBase64(value) {
-    return value.replace(/\+/g, '-').replace(/\//g, '_').replace(/\=/g, '');
-}
-/**
- * Define an irregular rule
- */
-function defineIrregularRule(singleValue, pluralValue) {
-    (0, pluralize_1.addIrregularRule)(singleValue, pluralValue);
-}
-exports.defineIrregularRule = defineIrregularRule;
-/**
- * Define uncountable rule
- */
-function defineUncountableRule(word) {
-    (0, pluralize_1.addUncountableRule)(word);
-}
-exports.defineUncountableRule = defineUncountableRule;
-/**
- * Convert string to camelcase
- */
-function camelCase(value) {
-    return changeCase.camelCase(value);
-}
-exports.camelCase = camelCase;
-/**
- * Convert string to snakecase
- */
-function snakeCase(value) {
-    return changeCase.snakeCase(value);
-}
-exports.snakeCase = snakeCase;
-/**
- * Convert string to dashcase
- */
-function dashCase(value, options) {
-    if (options && options.capitalize) {
-        return changeCase.headerCase(value);
-    }
-    return changeCase.paramCase(value);
-}
-exports.dashCase = dashCase;
-/**
- * Convert string to pascal case
- */
-function pascalCase(value) {
-    return changeCase.pascalCase(value);
-}
-exports.pascalCase = pascalCase;
-/**
- * Convert string to capital case
- */
-function capitalCase(value) {
-    return changeCase.capitalCase(value);
-}
-exports.capitalCase = capitalCase;
-/**
- * Convert string to sentence case
- */
-function sentenceCase(value) {
-    return changeCase.sentenceCase(value);
-}
-exports.sentenceCase = sentenceCase;
-/**
- * Convert string to dot case
- */
-function dotCase(value) {
-    return changeCase.dotCase(value);
-}
-exports.dotCase = dotCase;
-/**
- * Remove all sort of casing from the string
- */
-function noCase(value) {
-    return changeCase.noCase(value);
-}
-exports.noCase = noCase;
-/**
- * Pluralize a word
- */
-function pluralize(word) {
-    return (0, pluralize_1.plural)(word);
-}
-exports.pluralize = pluralize;
-/**
- * Singularize a word
- */
-function singularize(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 (0, truncatise_1.default)(sentence, {
-        TruncateLength: charactersLimit,
-        /**
-         * Do not complete words when "completeWords" is not explicitly set
-         * to true
-         */
-        Strict: options && options.completeWords === true ? false : true,
-        StripHTML: false,
-        TruncateBy: 'characters',
-        Suffix: options && options.suffix,
-    });
-}
-exports.truncate = truncate;
-/**
- * Same as truncate, but strips out the HTML
- */
-function excerpt(sentence, charactersLimit, options) {
-    return (0, truncatise_1.default)(sentence, {
-        TruncateLength: charactersLimit,
-        /**
-         * Do not complete words when "completeWords" is not explicitly set
-         * to true
-         */
-        Strict: options && options.completeWords === true ? false : true,
-        StripHTML: true,
-        TruncateBy: 'characters',
-        Suffix: options && options.suffix,
-    });
-}
-exports.excerpt = excerpt;
-/**
- * Condenses multiple whitespaces from a string
- */
-function condenseWhitespace(value) {
-    return value.trim().replace(/\s{2,}/g, ' ');
-}
-exports.condenseWhitespace = condenseWhitespace;
-/**
- * Escape HTML entities
- */
-function escapeHTML(value, options) {
-    value = he_1.default.escape(value);
-    if (options && options.encodeSymbols) {
-        value = encodeSymbols(value, { allowUnsafeSymbols: true });
-    }
-    return value;
-}
-exports.escapeHTML = escapeHTML;
-/**
- * Encode symbols that aren’t printable ASCII symbols
- */
-function encodeSymbols(value, options) {
-    return he_1.default.encode(value, options);
-}
-exports.encodeSymbols = encodeSymbols;
-/**
- * Convert array of values to a sentence
- */
-function toSentence(values, options) {
-    /**
-     * Empty array
-     */
-    if (values.length === 0) {
-        return '';
-    }
-    /**
-     * Just one item
-     */
-    if (values.length === 1) {
-        return values[0];
-    }
-    /**
-     * Giving some love to two items, so that one can use oxford comma's
-     */
-    if (values.length === 2) {
-        return `${values[0]}${options?.pairSeparator || ' and '}${values[1]}`;
-    }
-    const normalized = Object.assign({ separator: ', ', lastSeparator: ', and ' }, options);
-    /**
-     * Make sentence
-     */
-    return `${values.slice(0, -1).join(normalized.separator)}${normalized.lastSeparator}${values[values.length - 1]}`;
-}
-exports.toSentence = toSentence;
-/**
- * Convert a number to a human readable string
- */
-function prettyBytes(value, options) {
-    return bytes_1.default.format(value, options);
-}
-exports.prettyBytes = prettyBytes;
-/**
- * Convert milliseconds to a human readable string
- */
-function prettyMs(value, options) {
-    return (0, ms_1.default)(value, options);
-}
-exports.prettyMs = prettyMs;
-/**
- * Find if a string is empty. Including any number of whitespaces
- */
-function isEmpty(value) {
-    return value.trim().length === 0;
-}
-exports.isEmpty = isEmpty;
-/**
- * Ordinalize a give number or string
- */
-function ordinalize(value) {
-    const transformedValue = Math.abs(typeof value === 'string' ? parseInt(value) : value);
-    if (!Number.isFinite(transformedValue) || Number.isNaN(transformedValue)) {
-        throw new Error('Cannot ordinalize NAN or infinite numbers');
-    }
-    const percent = transformedValue % 100;
-    if (percent >= 10 && percent <= 20) {
-        return `${value}th`;
-    }
-    const decimal = transformedValue % 10;
-    switch (decimal) {
-        case 1:
-            return `${value}st`;
-        case 2:
-            return `${value}nd`;
-        case 3:
-            return `${value}rd`;
-        default:
-            return `${value}th`;
-    }
-}
-exports.ordinalize = ordinalize;
-/**
- * Converts unit expression to bytes
- */
-function toBytes(value) {
-    if (typeof value === 'number') {
-        return value;
-    }
-    return bytes_1.default.parse(value);
-}
-exports.toBytes = toBytes;
-/**
- * Converts time expression to milliseconds
- */
-function toMs(value) {
-    if (typeof value === 'number') {
-        return value;
-    }
-    return (0, ms_1.default)(value);
-}
-exports.toMs = toMs;
-/**
- * Generates a random string for a given size
- */
-function generateRandom(size) {
-    const bits = (size + 1) * 6;
-    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.d.ts

@@ -1,86 +0,0 @@
-/// <reference types="node" />
-/**
- * Lookup the type for a given value
- */
-export declare function lookup(value: any): 'undefined' | 'null' | 'boolean' | 'buffer' | 'number' | 'string' | 'arguments' | 'object' | 'date' | 'array' | 'regexp' | 'error' | 'function' | 'class' | 'generatorfunction' | 'symbol' | 'map' | 'weakmap' | 'set' | 'weakset' | 'int8array' | 'uint8array' | 'uint8clampedarray' | 'int16array' | 'uint16array' | 'int32array' | 'uint32array' | 'float32array' | 'float64array';
-/**
- * Find if a given value is undefined
- */
-export declare function isUndefined(value: any): value is undefined;
-/**
- * Find if a given value is null
- */
-export declare function isNull(value: any): value is null;
-/**
- * Find if a given value is a boolean
- */
-export declare function isBoolean(value: any): value is boolean;
-/**
- * Find if a given value is a buffer
- */
-export declare function isBuffer(value: any): value is Buffer;
-/**
- * Find if a given value is a number
- */
-export declare function isNumber(value: any): value is number;
-/**
- * Find if a given value is a string
- */
-export declare function isString(value: any): value is string;
-/**
- * Find if a given value is function arguments
- */
-export declare function isArguments(value: any): boolean;
-/**
- * Find if a given value is a plain object
- */
-export declare function isObject(value: any): boolean;
-/**
- * Find if a given value is a date instance
- */
-export declare function isDate(value: any): value is Date;
-/**
- * Find if a given value is an array
- */
-export declare function isArray(value: any): value is any[];
-/**
- * Find if a given value is an regularExpression
- */
-export declare function isRegexp(value: any): value is RegExp;
-/**
- * Find if a given value is an instance of Error class
- */
-export declare function isError(value: any): boolean;
-/**
- * Find if a given value is a Function
- */
-export declare function isFunction(value: any): value is Function;
-/**
- * Find if a given value is a class. Uses regular expression, since there
- * is no way to natively distinguish a class and a function in Javascript
- */
-export declare function isClass(value: any): boolean;
-/**
- * Find if a value is an integer or not
- */
-export declare function isInteger(value: number): value is number;
-/**
- * Find if a value is float value or not. The values with more than
- * zero remainder returns true
- */
-export declare function isFloat(value: number): value is number;
-/**
- * Find if the value has given decimal place or not.
- *
- * Since there is no direct way in Javascript to check for decimal place. We make
- * use of regex to find it out.
- *
- * Numeric values are converted to string by calling `value.toString()` before
- * testing it against the regex.
- *
- * If this method returns `true`, then you can safely parse the string with `parseFloat`
- * method.
- */
-export declare function isDecimal(value: string | number, options?: {
-    decimalPlaces?: string;
-}): boolean;

package/build/src/Helpers/types.js

@@ -1,161 +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.isDecimal = exports.isFloat = exports.isInteger = exports.isClass = exports.isFunction = exports.isError = exports.isRegexp = exports.isArray = exports.isDate = exports.isObject = exports.isArguments = exports.isString = exports.isNumber = exports.isBuffer = exports.isBoolean = exports.isNull = exports.isUndefined = exports.lookup = void 0;
-const kind_of_1 = __importDefault(require("kind-of"));
-const toString = Function.prototype.toString;
-/**
- * Lookup the type for a given value
- */
-function lookup(value) {
-    const kind = (0, kind_of_1.default)(value);
-    if (kind === 'function' && /^class\s/.test(toString.call(value))) {
-        return 'class';
-    }
-    return kind;
-}
-exports.lookup = lookup;
-/**
- * Find if a given value is undefined
- */
-function isUndefined(value) {
-    return lookup(value) === 'undefined';
-}
-exports.isUndefined = isUndefined;
-/**
- * Find if a given value is null
- */
-function isNull(value) {
-    return lookup(value) === 'null';
-}
-exports.isNull = isNull;
-/**
- * Find if a given value is a boolean
- */
-function isBoolean(value) {
-    return lookup(value) === 'boolean';
-}
-exports.isBoolean = isBoolean;
-/**
- * Find if a given value is a buffer
- */
-function isBuffer(value) {
-    return lookup(value) === 'buffer';
-}
-exports.isBuffer = isBuffer;
-/**
- * Find if a given value is a number
- */
-function isNumber(value) {
-    return lookup(value) === 'number';
-}
-exports.isNumber = isNumber;
-/**
- * Find if a given value is a string
- */
-function isString(value) {
-    return lookup(value) === 'string';
-}
-exports.isString = isString;
-/**
- * Find if a given value is function arguments
- */
-function isArguments(value) {
-    return lookup(value) === 'arguments';
-}
-exports.isArguments = isArguments;
-/**
- * Find if a given value is a plain object
- */
-function isObject(value) {
-    return lookup(value) === 'object';
-}
-exports.isObject = isObject;
-/**
- * Find if a given value is a date instance
- */
-function isDate(value) {
-    return lookup(value) === 'date';
-}
-exports.isDate = isDate;
-/**
- * Find if a given value is an array
- */
-function isArray(value) {
-    return lookup(value) === 'array';
-}
-exports.isArray = isArray;
-/**
- * Find if a given value is an regularExpression
- */
-function isRegexp(value) {
-    return lookup(value) === 'regexp';
-}
-exports.isRegexp = isRegexp;
-/**
- * Find if a given value is an instance of Error class
- */
-function isError(value) {
-    return lookup(value) === 'error';
-}
-exports.isError = isError;
-/**
- * Find if a given value is a Function
- */
-function isFunction(value) {
-    return lookup(value) === 'function';
-}
-exports.isFunction = isFunction;
-/**
- * Find if a given value is a class. Uses regular expression, since there
- * is no way to natively distinguish a class and a function in Javascript
- */
-function isClass(value) {
-    return lookup(value) === 'class';
-}
-exports.isClass = isClass;
-/**
- * Find if a value is an integer or not
- */
-function isInteger(value) {
-    return Number.isInteger(value);
-}
-exports.isInteger = isInteger;
-/**
- * Find if a value is float value or not. The values with more than
- * zero remainder returns true
- */
-function isFloat(value) {
-    return value !== (value | 0);
-}
-exports.isFloat = isFloat;
-/**
- * Find if the value has given decimal place or not.
- *
- * Since there is no direct way in Javascript to check for decimal place. We make
- * use of regex to find it out.
- *
- * Numeric values are converted to string by calling `value.toString()` before
- * testing it against the regex.
- *
- * If this method returns `true`, then you can safely parse the string with `parseFloat`
- * method.
- */
-function isDecimal(value, options) {
-    if (typeof value === 'number') {
-        value = value.toString();
-    }
-    const decimalPlaces = (options && options.decimalPlaces) || '1,';
-    return new RegExp(`^[-+]?([0-9]+)?(\\.[0-9]{${decimalPlaces}})$`).test(value);
-}
-exports.isDecimal = isDecimal;

package/build/src/ManagerConfigValidator.d.ts

@@ -1,20 +0,0 @@
-/**
- * A simple class to raise consistent exceptions for invalid config
- * for driver based implementations.
- */
-export declare class ManagerConfigValidator {
-    private config;
-    private serviceName;
-    private configLocation;
-    constructor(config: any, serviceName: string, configLocation: string);
-    /**
-     * Validates that the default key name is defined inside the config
-     * for a given module/service
-     */
-    validateDefault(keyName: string): void;
-    /**
-     * Validates that the list to ensure that is is defined and the default
-     * key name is also part of the list.
-     */
-    validateList(listName: string, keyName: string): void;
-}

package/build/src/ManagerConfigValidator.js

@@ -1,55 +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.ManagerConfigValidator = void 0;
-const Exception_1 = require("./Exception");
-/**
- * A simple class to raise consistent exceptions for invalid config
- * for driver based implementations.
- */
-class ManagerConfigValidator {
-    constructor(config, serviceName, configLocation) {
-        this.config = config;
-        this.serviceName = serviceName;
-        this.configLocation = configLocation;
-    }
-    /**
-     * Validates that the default key name is defined inside the config
-     * for a given module/service
-     */
-    validateDefault(keyName) {
-        if (!this.config[keyName]) {
-            throw new Exception_1.Exception([
-                `Invalid "${this.serviceName}" config. Missing value for "${keyName}".`,
-                `Make sure to set it inside the "${this.configLocation}" file`,
-            ].join(' '));
-        }
-    }
-    /**
-     * Validates that the list to ensure that is is defined and the default
-     * key name is also part of the list.
-     */
-    validateList(listName, keyName) {
-        if (!this.config[listName]) {
-            throw new Exception_1.Exception([
-                `Invalid "${this.serviceName}" config. Missing value for "${listName}".`,
-                `Make sure to set it inside the "${this.configLocation}" file`,
-            ].join(' '));
-        }
-        const defaultValue = this.config[keyName];
-        if (!this.config[listName][defaultValue]) {
-            throw new Exception_1.Exception([
-                `Invalid "${this.serviceName}" config. "${defaultValue}" is not defined inside "${listName}".`,
-                `Make sure to set it inside the "${this.configLocation}" file`,
-            ].join(' '));
-        }
-    }
-}
-exports.ManagerConfigValidator = ManagerConfigValidator;