@8ms/helpers 1.38.0 → 2.0.0

package/url/writeUrlContents.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 axios_1 = __importDefault(require("axios"));
-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 fs = require('fs-extra');
-    await (0, createDirectory_1.default)({
-        filePath,
-    });
-    const writer = fs.createWriteStream(filePath);
-    await (0, axios_1.default)({
-        method: "get",
-        url,
-        responseType: "stream"
-    })
-        .then(response => {
-        return new Promise(async (resolve, reject) => {
-            response.data.pipe(writer);
-            let error = null;
-            writer.on('error', err => {
-                error = err;
-                writer.close();
-                reject(err);
-            });
-            writer.on('close', () => {
-                if (!error) {
-                    resolve(true);
-                }
-                //no need to call the reject here, as it will have been called in the
-                //'error' stream;
-            });
-        });
-    });
-};
-exports.default = saveUrlContents;

package/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/util/promiseChunks.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const lodash_1 = require("lodash");
-/**
- * Chunk a queue of promises into controlled chunks to prevent overloading.
- * https://stackoverflow.com/a/53964407
- */
-const promiseChunks = async (props) => {
-    const batches = (0, lodash_1.chunk)(props.promises, props.size);
-    let results = [];
-    while (batches.length) {
-        const batch = batches.shift();
-        const result = await Promise.all(batch);
-        results.push(result);
-    }
-    return (0, lodash_1.flatten)(results);
-};
-exports.default = promiseChunks;

package/util/sleep.d.ts

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

package/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/webWorker/index.d.ts

@@ -1,5 +0,0 @@
-export declare enum State {
-    ERROR = "ERROR",
-    SUCCESS = "SUCCESS",
-    PROGRESS = "PROGRESS"
-}

package/webWorker/index.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.State = void 0;
-var State;
-(function (State) {
-    State["ERROR"] = "ERROR";
-    State["SUCCESS"] = "SUCCESS";
-    State["PROGRESS"] = "PROGRESS";
-})(State || (exports.State = State = {}));

package/xml/getXml.d.ts

@@ -1,5 +0,0 @@
-type GetXml = {
-    url: string;
-};
-declare const getXml: (props: GetXml) => Promise<string>;
-export default getXml;

package/xml/getXml.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 get_1 = __importDefault(require("../axios/get"));
-const getXml = async (props) => {
-    let response = '';
-    const apiResponse = await (0, get_1.default)({
-        url: props.url,
-    });
-    if (apiResponse.isSuccess()) {
-        response = apiResponse.getBody()
-            .toString();
-        // Trim the contents
-        response = response.trim();
-        // Remove tabs, new lines, double spaces
-        response = response.replace(/[ ]{2}|\r\n|\n|\r|\t/gm, '');
-    }
-    return response;
-};
-exports.default = getXml;