@8ms/helpers 1.42.3 → 1.42.6

package/dist/cjs/url/buildUrl.js

@@ -1,29 +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 isDevelopment_1 = __importDefault(require("../environment/isDevelopment"));
-const isLocalhost_1 = __importDefault(require("../environment/isLocalhost"));
-const isProduction_1 = __importDefault(require("../environment/isProduction"));
-const isStaging_1 = __importDefault(require("../environment/isStaging"));
-/**
- * Get the current base url.
- */
-const buildUrl = ({ path, url }) => {
-    let response;
-    if ((0, isDevelopment_1.default)() && (0, isLocalhost_1.default)()) {
-        response = url.localhost;
-    }
-    else if ((0, isStaging_1.default)()) {
-        response = url.staging;
-    }
-    else if ((0, isProduction_1.default)()) {
-        response = url.production;
-    }
-    else {
-        response = url.development;
-    }
-    return response + path || '';
-};
-exports.default = buildUrl;

package/dist/cjs/url/isAbsolute.d.ts

@@ -1,7 +0,0 @@
-/**
- * Does the URL begin with HTTP or HTTPS?
- */
-declare const isAbsolute: ({ input }: {
-    input: string;
-}) => boolean;
-export default isAbsolute;

package/dist/cjs/url/isAbsolute.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Does the URL begin with HTTP or HTTPS?
- */
-const isAbsolute = ({ input }) => {
-    try {
-        new URL(input);
-    }
-    catch (error) {
-        return false;
-    }
-    return true;
-};
-exports.default = isAbsolute;

package/dist/cjs/url/isRelative.d.ts

@@ -1,7 +0,0 @@
-/**
- * Does the URL begin with a slash.
- */
-declare const isRelative: ({ input }: {
-    input: string;
-}) => boolean;
-export default isRelative;

package/dist/cjs/url/isRelative.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Does the URL begin with a slash.
- */
-const isRelative = ({ input }) => '/' === input.trim()
-    .charAt(0);
-exports.default = isRelative;

package/dist/cjs/url/tests/isAbsolute.test.d.ts

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

package/dist/cjs/url/tests/isAbsolute.test.js

@@ -1,14 +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 isAbsolute_1 = __importDefault(require("../isAbsolute"));
-test('isAbsolute', () => {
-    const absolute = 'https://www.google.com';
-    const relative = '/something';
-    expect((0, isAbsolute_1.default)({ input: absolute }))
-        .toBeTruthy();
-    expect((0, isAbsolute_1.default)({ input: relative }))
-        .toBeFalsy();
-});

package/dist/cjs/url/tests/isRelative.test.d.ts

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

package/dist/cjs/url/tests/isRelative.test.js

@@ -1,14 +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 isRelative_1 = __importDefault(require("../isRelative"));
-test('isRelative', () => {
-    const absolute = 'https://www.google.com';
-    const relative = '/something';
-    expect((0, isRelative_1.default)({ input: absolute }))
-        .toBeFalsy();
-    expect((0, isRelative_1.default)({ input: relative }))
-        .toBeTruthy();
-});

package/dist/cjs/url/url.d.ts

@@ -1,6 +0,0 @@
-export type Url = {
-    localhost: string;
-    development: string;
-    staging: string;
-    production: string;
-};

package/dist/cjs/url/url.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/url/writeUrlContents.d.ts

@@ -1,11 +0,0 @@
-type WriteUrlContents = {
-    filePath: string;
-    url: string;
-};
-/**
- * Downloads a given URL's contents to a local file.
- *
- * Requires fs-extra
- */
-declare const saveUrlContents: ({ filePath, url }: WriteUrlContents) => Promise<void>;
-export default saveUrlContents;

package/dist/cjs/url/writeUrlContents.js

@@ -1,72 +0,0 @@
-"use strict";
-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 () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __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 });
-const stream_1 = require("stream");
-const createDirectory_1 = __importDefault(require("../file/createDirectory"));
-/**
- * Downloads a given URL's contents to a local file.
- *
- * Requires fs-extra
- */
-const saveUrlContents = async ({ filePath, url }) => {
-    const { default: ky } = await Promise.resolve().then(() => __importStar(require("ky")));
-    const fs = await Promise.resolve().then(() => __importStar(require("fs-extra")));
-    await (0, createDirectory_1.default)({
-        filePath,
-    });
-    const writer = fs.createWriteStream(filePath);
-    const response = await ky.get(url);
-    const stream = stream_1.Readable.fromWeb(response.body);
-    await new Promise((resolve, reject) => {
-        stream.pipe(writer);
-        let error = null;
-        writer.on("error", err => {
-            error = err;
-            writer.close();
-            reject(err);
-        });
-        writer.on("close", () => {
-            if (!error) {
-                resolve();
-            }
-            //no need to call the reject here, as it will have been called in the
-            //'error' stream;
-        });
-    });
-};
-exports.default = saveUrlContents;

package/dist/cjs/util/defaultTo.d.ts

@@ -1,10 +0,0 @@
-type DefaultTo = {
-    defaultValue: any;
-    instance: any;
-    keys: any | any[];
-};
-/**
- * Function to default to a value, whilst filtering through an instance
- */
-declare const defaultTo: (props: DefaultTo) => any;
-export default defaultTo;

package/dist/cjs/util/defaultTo.js

@@ -1,43 +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 isObject_1 = __importDefault(require("lodash/isObject"));
-const getArray_1 = __importDefault(require("../array/getArray"));
-/**
- * Function to default to a value, whilst filtering through an instance
- */
-const defaultTo = (props) => {
-    const keysArray = (0, getArray_1.default)({
-        input: props.keys
-    });
-    let found = true;
-    let pointer = props.instance;
-    // Instance is undefined or is null
-    if (undefined === props.instance || null === pointer) {
-        found = false;
-    }
-    // Instance exists
-    else {
-        keysArray.forEach(key => {
-            if (found) {
-                // Sub key doesn't exist
-                if ((0, isObject_1.default)(pointer)) {
-                    if (undefined === pointer[key] || null === pointer[key]) {
-                        found = false;
-                    }
-                    // Sub key exists, update pointer
-                    else {
-                        pointer = pointer[key];
-                    }
-                }
-                else {
-                    found = false;
-                }
-            }
-        });
-    }
-    return found ? pointer : props.defaultValue;
-};
-exports.default = defaultTo;

package/dist/cjs/util/getBrotliCompressed.d.ts

@@ -1,9 +0,0 @@
-type GetBrotliCompressed = {
-    input?: any;
-    options?: object;
-};
-/**
- * Compress a given input using Brotli.
- */
-declare const getBrotliCompressed: ({ input, options }?: GetBrotliCompressed) => Promise<unknown>;
-export default getBrotliCompressed;

package/dist/cjs/util/getBrotliCompressed.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Compress a given input using Brotli.
- */
-const getBrotliCompressed = async ({ input, options } = {}) => {
-    return new Promise(async (resolve, reject) => {
-        const zlib = require('zlib');
-        zlib.brotliCompress(input || '', options || {}, (err, data) => {
-            if (err) {
-                reject(`Error compressing - ${err.code}`);
-            }
-            else {
-                resolve(data.toString('base64'));
-            }
-        });
-    });
-};
-exports.default = getBrotliCompressed;

package/dist/cjs/util/getBrotliDecompressed.d.ts

@@ -1,9 +0,0 @@
-type GetBrotliDecompressed = {
-    input?: any;
-    options?: object;
-};
-/**
- * Decompress a given Brotli input into a string.
- */
-declare const getBrotliDecompressed: ({ input, options }?: GetBrotliDecompressed) => Promise<unknown>;
-export default getBrotliDecompressed;

package/dist/cjs/util/getBrotliDecompressed.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Decompress a given Brotli input into a string.
- */
-const getBrotliDecompressed = async ({ input, options } = {}) => {
-    return new Promise(async (resolve, reject) => {
-        const zlib = require('zlib');
-        const compressedData = Buffer.from(input || '', "base64");
-        zlib.brotliDecompress(compressedData, options || {}, (err, data) => {
-            if (err) {
-                reject(`Error decompressing - ${err.code}`);
-            }
-            else {
-                resolve(data.toString('utf8'));
-            }
-        });
-    });
-};
-exports.default = getBrotliDecompressed;

package/dist/cjs/util/getClean.d.ts

@@ -1,11 +0,0 @@
-type GetClean = {
-    hash?: boolean;
-    input: string;
-    lowercase?: boolean;
-    parameter?: boolean;
-};
-/**
- * Return a clean URL with a few options.
- */
-declare const getClean: ({ hash, input, lowercase, parameter }: GetClean) => string;
-export default getClean;

package/dist/cjs/util/getClean.js

@@ -1,28 +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 getWithoutParameter_1 = __importDefault(require("./getWithoutParameter"));
-const getWithoutHash_1 = __importDefault(require("./getWithoutHash"));
-/**
- * Return a clean URL with a few options.
- */
-const getClean = ({ hash, input, lowercase, parameter }) => {
-    let response = input.trim();
-    if (parameter) {
-        response = (0, getWithoutParameter_1.default)({
-            input: response,
-        });
-    }
-    if (hash) {
-        response = (0, getWithoutHash_1.default)({
-            input: response,
-        });
-    }
-    if (lowercase) {
-        response = response.toLowerCase();
-    }
-    return response;
-};
-exports.default = getClean;

package/dist/cjs/util/getGzipCompressed.d.ts

@@ -1,9 +0,0 @@
-type GetGzipCompressed = {
-    input?: any;
-    options?: object;
-};
-/**
- * Compress a given input using Gzip.
- */
-declare const getGzipCompressed: ({ input, options }?: GetGzipCompressed) => Promise<unknown>;
-export default getGzipCompressed;

package/dist/cjs/util/getGzipCompressed.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Compress a given input using Gzip.
- */
-const getGzipCompressed = async ({ input, options } = {}) => {
-    return new Promise(async (resolve, reject) => {
-        const zlib = require('zlib');
-        zlib.gzip(input || '', options || {}, (err, data) => {
-            if (err) {
-                reject(`Error compressing - ${err.code}`);
-            }
-            else {
-                resolve(data.toString('base64'));
-            }
-        });
-    });
-};
-exports.default = getGzipCompressed;

package/dist/cjs/util/getGzipDecompressed.d.ts

@@ -1,9 +0,0 @@
-type GetBrotliDecompressed = {
-    input?: any;
-    options?: object;
-};
-/**
- * Decompress a given Gzip input into a string.
- */
-declare const getGzipDecompressed: ({ input, options }?: GetBrotliDecompressed) => Promise<unknown>;
-export default getGzipDecompressed;

package/dist/cjs/util/getGzipDecompressed.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Decompress a given Gzip input into a string.
- */
-const getGzipDecompressed = async ({ input, options } = {}) => {
-    return new Promise(async (resolve, reject) => {
-        const zlib = require('zlib');
-        const compressedData = Buffer.from(input || '', "base64");
-        zlib.gunzip(compressedData, options || {}, (err, data) => {
-            if (err) {
-                reject(`Error decompressing - ${err.code}`);
-            }
-            else {
-                resolve(data.toString('utf8'));
-            }
-        });
-    });
-};
-exports.default = getGzipDecompressed;

package/dist/cjs/util/getWithoutHash.d.ts

@@ -1,8 +0,0 @@
-type GetWithoutHash = {
-    input: string;
-};
-/**
- * Get a URL without the parameter query.
- */
-declare const getWithoutHash: ({ input }: GetWithoutHash) => string;
-export default getWithoutHash;

package/dist/cjs/util/getWithoutHash.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Get a URL without the parameter query.
- */
-const getWithoutHash = ({ input }) => {
-    let response = input;
-    // Contains parameter query
-    if (-1 !== response.indexOf('#')) {
-        const split = response.split('#');
-        if (split.length > 1) {
-            response = split[0];
-        }
-    }
-    return response;
-};
-exports.default = getWithoutHash;

package/dist/cjs/util/getWithoutParameter.d.ts

@@ -1,8 +0,0 @@
-type GetWithoutParameter = {
-    input: string;
-};
-/**
- * Get a URL without the parameter query.
- */
-declare const getWithoutParameter: ({ input }: GetWithoutParameter) => string;
-export default getWithoutParameter;

package/dist/cjs/util/getWithoutParameter.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Get a URL without the parameter query.
- */
-const getWithoutParameter = ({ input }) => {
-    let response = input;
-    // Contains parameter query
-    if (-1 !== response.indexOf('?')) {
-        const split = response.split('?');
-        if (split.length > 1) {
-            response = split[0];
-        }
-    }
-    return response;
-};
-exports.default = getWithoutParameter;

package/dist/cjs/util/isUndefined.d.ts

@@ -1,9 +0,0 @@
-type IsUndefined = {
-    instance: any;
-    keys: any | any[];
-};
-/**
- * Check to see if a value is undefined.
- */
-declare const isUndefined: ({ instance, keys }: IsUndefined) => boolean;
-export default isUndefined;

package/dist/cjs/util/isUndefined.js

@@ -1,19 +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 defaultTo_1 = __importDefault(require("./defaultTo"));
-/**
- * Check to see if a value is undefined.
- */
-const isUndefined = ({ instance, keys }) => {
-    const undefinedValue = '__!!UNDEFINED!!__';
-    const value = (0, defaultTo_1.default)({
-        defaultValue: undefinedValue,
-        instance,
-        keys,
-    });
-    return undefinedValue === value;
-};
-exports.default = isUndefined;

package/dist/cjs/util/promiseChunks.d.ts

@@ -1,10 +0,0 @@
-type PromiseChunks = {
-    promises: Promise<any>[];
-    size: number;
-};
-/**
- * Chunk a queue of promises into controlled chunks to prevent overloading.
- * https://stackoverflow.com/a/53964407
- */
-declare const promiseChunks: (props: PromiseChunks) => Promise<any[]>;
-export default promiseChunks;

package/dist/cjs/util/promiseChunks.js

@@ -1,22 +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 chunk_1 = __importDefault(require("lodash/chunk"));
-const flatten_1 = __importDefault(require("lodash/flatten"));
-/**
- * Chunk a queue of promises into controlled chunks to prevent overloading.
- * https://stackoverflow.com/a/53964407
- */
-const promiseChunks = async (props) => {
-    const batches = (0, chunk_1.default)(props.promises, props.size);
-    let results = [];
-    while (batches.length) {
-        const batch = batches.shift();
-        const result = await Promise.all(batch);
-        results.push(result);
-    }
-    return (0, flatten_1.default)(results);
-};
-exports.default = promiseChunks;

package/dist/cjs/util/sleep.d.ts

@@ -1,5 +0,0 @@
-type Sleep = {
-    seconds: number;
-};
-declare const sleep: (props: Sleep) => Promise<void>;
-export default sleep;

package/dist/cjs/util/sleep.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const sleep = (props) => {
-    return new Promise(resolve => setTimeout(resolve, props.seconds * 1000));
-};
-exports.default = sleep;

package/dist/cjs/util/tests/defaultTo.test.d.ts

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

package/dist/cjs/util/tests/defaultTo.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 defaultTo_1 = __importDefault(require("../defaultTo"));
-test('defaultTo - exists', () => {
-    const instance = {
-        'something': 'a b c',
-        'level one': {
-            'level two': 'inner',
-        },
-    };
-    expect((0, defaultTo_1.default)({ defaultValue: 'not found', instance, keys: 'something' }))
-        .toBe('a b c');
-    expect((0, defaultTo_1.default)({ defaultValue: 'not found', instance, keys: ['level one', 'level two'] }))
-        .toBe('inner');
-});
-test('defaultTo - doesnt exist', () => {
-    const instance = {
-        'something': 'a b c',
-        'level one': {
-            'level two': 'inner',
-        },
-    };
-    expect((0, defaultTo_1.default)({ defaultValue: true, instance, keys: 'not here' }))
-        .toBeTruthy();
-    expect((0, defaultTo_1.default)({ defaultValue: 'not found', instance, keys: ['level one', 'level two', 'level three'] }))
-        .toBe('not found');
-});

package/dist/cjs/util/tests/getBrotliCompressed.test.d.ts

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

package/dist/cjs/util/tests/getBrotliCompressed.test.js

@@ -1,15 +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 getBrotliCompressed_1 = __importDefault(require("../getBrotliCompressed"));
-test('getBrotliCompressed', async () => {
-    const input = 'this is a test';
-    const expected = 'Gw0A+CUASpBC6haZniIA';
-    const compressed = await (0, getBrotliCompressed_1.default)({
-        input,
-    });
-    expect(compressed)
-        .toBe(expected);
-});

package/dist/cjs/util/tests/getBrotliDecompressed.test.d.ts

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

package/dist/cjs/util/tests/getBrotliDecompressed.test.js

@@ -1,15 +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 getBrotliDecompressed_1 = __importDefault(require("../getBrotliDecompressed"));
-test('getBrotliDecompressed', async () => {
-    const input = 'Gw0A+CUASpBC6haZniIA';
-    const expected = 'this is a test';
-    const decompressed = await (0, getBrotliDecompressed_1.default)({
-        input,
-    });
-    expect(decompressed)
-        .toBe(expected);
-});

package/dist/cjs/util/tests/getGzipCompressed.test.d.ts

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