@8ms/helpers 1.40.6 → 1.40.9

package/sorting/byNumberAscending.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Take two values, ensure they are numbers and return the sorting value.
+ */
+const byNumberAscending = ({ valueA, valueB }) => {
+    let valueAClean = Number(valueA);
+    let valueBClean = Number(valueB);
+    if (valueAClean > valueBClean) {
+        return 1;
+    }
+    if (valueBClean > valueAClean) {
+        return -1;
+    }
+    return 0;
+};
+exports.default = byNumberAscending;

package/sorting/byNumberDescending.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Take two values, ensure they are numbers and return the sorting value.
+ */
+declare const byNumberDescending: ({ valueA, valueB }: {
+    valueA: any;
+    valueB: any;
+}) => number;
+export default byNumberDescending;

package/sorting/byNumberDescending.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Take two values, ensure they are numbers and return the sorting value.
+ */
+const byNumberDescending = ({ valueA, valueB }) => {
+    let valueAClean = Number(valueA);
+    let valueBClean = Number(valueB);
+    if (valueAClean > valueBClean) {
+        return -1;
+    }
+    if (valueBClean > valueAClean) {
+        return 1;
+    }
+    return 0;
+};
+exports.default = byNumberDescending;

package/sorting/byStringAscending.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Take two values, clean the strings and return the sorting value.
+ */
+declare const byStringAscending: ({ valueA, valueB }: {
+    valueA: any;
+    valueB: any;
+}) => number;
+export default byStringAscending;

package/sorting/byStringAscending.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Take two values, clean the strings and return the sorting value.
+ */
+const byStringAscending = ({ valueA, valueB }) => {
+    let valueAClean = valueA
+        .trim()
+        .toLowerCase();
+    let valueBClean = valueB
+        .trim()
+        .toLowerCase();
+    if (valueAClean > valueBClean) {
+        return 1;
+    }
+    if (valueBClean > valueAClean) {
+        return -1;
+    }
+    return 0;
+};
+exports.default = byStringAscending;

package/sorting/byStringDescending.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Take two values, clean the strings and return the sorting value.
+ */
+declare const byStringDescending: ({ valueA, valueB }: {
+    valueA: any;
+    valueB: any;
+}) => number;
+export default byStringDescending;

package/sorting/byStringDescending.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Take two values, clean the strings and return the sorting value.
+ */
+const byStringDescending = ({ valueA, valueB }) => {
+    let valueAClean = valueA
+        .trim()
+        .toLowerCase();
+    let valueBClean = valueB
+        .trim()
+        .toLowerCase();
+    if (valueAClean > valueBClean) {
+        return -1;
+    }
+    if (valueBClean > valueAClean) {
+        return 1;
+    }
+    return 0;
+};
+exports.default = byStringDescending;

package/stream/sort.d.ts

@@ -0,0 +1,13 @@
+declare const Transform: any;
+/**
+ * Batch sort stream without overloading the memory limit.
+ * https://www.npmjs.com/package/fast-stream-sort
+ */
+declare class SortStreamer extends Transform {
+    constructor(options: any, comp: any);
+    _transform(data: any, _: any, callback: any): void;
+    _flush(): void;
+    fullflush(): void;
+}
+declare const sort: (comp: any, options: any) => SortStreamer;
+export default sort;

package/stream/sort.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Transform = require('stream').Transform;
+const batch = 15000;
+/**
+ * Batch sort stream without overloading the memory limit.
+ * https://www.npmjs.com/package/fast-stream-sort
+ */
+class SortStreamer extends Transform {
+    constructor(options, comp) {
+        super(options);
+        this.a = new Array(batch);
+        this.i = 0;
+        this.k = 0;
+        this.currentSize = batch;
+        this.isDone = false;
+        this.sortedArray = undefined;
+        this.comp = comp;
+    }
+    _transform(data, _, callback) {
+        if (data) {
+            this.a[this.i++] = data;
+            if (this.i == this.currentSize) {
+                this.currentSize = this.currentSize * 2;
+                var tmp = new Array(this.currentSize);
+                for (var j = 0; j < this.i; j++) {
+                    tmp[j] = this.a[j];
+                }
+                this.a = tmp;
+            }
+        }
+        callback();
+    }
+    _flush() {
+        this.sortedArray = this.a.slice(0, this.i)
+            .sort(this.comp);
+        this.fullflush();
+    }
+    fullflush() {
+        while (this.k < this.i) {
+            this.push(this.sortedArray[this.k++]);
+        }
+        this.push(null);
+    }
+}
+const sort = (comp, options) => {
+    options = options || { objectMode: true };
+    return new SortStreamer(options, comp);
+};
+exports.default = sort;

package/string/getCapitalised.d.ts

@@ -0,0 +1,10 @@
+type GetCapitalised = {
+    input: string;
+    split?: string;
+};
+/**
+ * Convert a string into Capitalised Text.
+ * https://stackoverflow.com/a/196991/2664955
+ */
+declare const getCapitalised: ({ input, split }: GetCapitalised) => string;
+export default getCapitalised;

package/string/getCapitalised.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Convert a string into Capitalised Text.
+ * https://stackoverflow.com/a/196991/2664955
+ */
+const getCapitalised = ({ input, split }) => {
+    const regex = new RegExp(split || '_', 'g');
+    return input
+        .replace(regex, ' ')
+        .replace(/\w\S*/g, function (txt) {
+        return txt.charAt(0)
+            .toUpperCase() + txt.substr(1)
+            .toLowerCase();
+    });
+};
+exports.default = getCapitalised;

package/string/getClean.d.ts

@@ -0,0 +1,18 @@
+type GetClean = {
+    accents?: boolean;
+    decoded?: boolean;
+    htmlTags?: boolean;
+    input: any;
+    lowercase?: boolean;
+    propercase?: boolean;
+    punctuation?: boolean;
+    trim?: boolean;
+    underscores?: boolean;
+    uppercase?: boolean;
+    whitespace?: boolean;
+};
+/**
+ * Shorthand function to get a clean version of a string.
+ */
+declare const getClean: ({ accents, decoded, htmlTags, input, lowercase, propercase, punctuation, trim, underscores, uppercase, whitespace }: GetClean) => string;
+export default getClean;

package/string/getClean.js

@@ -0,0 +1,65 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getString_1 = __importDefault(require("./getString"));
+const getWithoutHtmlTags_1 = __importDefault(require("./getWithoutHtmlTags"));
+const getWithoutAccents_1 = __importDefault(require("./getWithoutAccents"));
+const getProperCase_1 = __importDefault(require("./getProperCase"));
+const getWithoutWhitespaces_1 = __importDefault(require("./getWithoutWhitespaces"));
+const getWithoutPunctuation_1 = __importDefault(require("./getWithoutPunctuation"));
+const getWithoutUnderscores_1 = __importDefault(require("./getWithoutUnderscores"));
+const getDecoded_1 = __importDefault(require("./getDecoded"));
+/**
+ * Shorthand function to get a clean version of a string.
+ */
+const getClean = ({ accents, decoded, htmlTags, input, lowercase, propercase, punctuation, trim, underscores, uppercase, whitespace }) => {
+    let response = (0, getString_1.default)({ input });
+    if (decoded) {
+        response = (0, getDecoded_1.default)({
+            input: response,
+        });
+    }
+    if (accents) {
+        response = (0, getWithoutAccents_1.default)({
+            input: response
+        });
+    }
+    if (htmlTags) {
+        response = (0, getWithoutHtmlTags_1.default)({
+            input: response
+        });
+    }
+    if (underscores) {
+        response = (0, getWithoutUnderscores_1.default)({
+            input: response,
+        });
+    }
+    if (punctuation) {
+        response = (0, getWithoutPunctuation_1.default)({
+            input: response
+        });
+    }
+    if (whitespace) {
+        response = (0, getWithoutWhitespaces_1.default)({
+            input: response
+        });
+    }
+    if (lowercase) {
+        response = response.toLowerCase();
+    }
+    if (propercase) {
+        response = (0, getProperCase_1.default)({
+            input: response
+        });
+    }
+    if (uppercase) {
+        response = response.toUpperCase();
+    }
+    if (trim) {
+        response = response.trim();
+    }
+    return response;
+};
+exports.default = getClean;

package/string/getDecoded.d.ts

@@ -0,0 +1,10 @@
+type GetDecoded = {
+    input: any;
+};
+/**
+ * Convert escaped copy into unescaped.
+ * E.g. there's => there's
+ * https://stackoverflow.com/a/42182294/2664955
+ */
+declare const getDecoded: ({ input }: GetDecoded) => string;
+export default getDecoded;

package/string/getDecoded.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getString_1 = __importDefault(require("./getString"));
+const unescape_1 = __importDefault(require("lodash/unescape"));
+/**
+ * Convert escaped copy into unescaped.
+ * E.g. there's => there's
+ * https://stackoverflow.com/a/42182294/2664955
+ */
+const getDecoded = ({ input }) => {
+    let response = (0, getString_1.default)({ input });
+    // Only works if DOM exists
+    if ('undefined' !== typeof document) {
+        let el = document.createElement("textarea");
+        el.innerHTML = response;
+        response = el.value;
+    }
+    else {
+        response = (0, unescape_1.default)(response);
+    }
+    return response;
+};
+exports.default = getDecoded;

package/string/getFolder.d.ts

@@ -0,0 +1,8 @@
+type GetFolder = {
+    input: string;
+};
+/**
+ * Take an input that may have a / before or after the input and return just the folder.
+ */
+declare const getFolder: ({ input }: GetFolder) => string;
+export default getFolder;

package/string/getFolder.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const trim_1 = __importDefault(require("lodash/trim"));
+/**
+ * Take an input that may have a / before or after the input and return just the folder.
+ */
+const getFolder = ({ input }) => {
+    return (0, trim_1.default)(input, '/')
+        .trim();
+};
+exports.default = getFolder;

package/string/getProperCase.d.ts

@@ -0,0 +1,11 @@
+type GetProperCase = {
+    input: any;
+    hyphen?: boolean;
+    pipe?: boolean;
+    underscore?: boolean;
+};
+/**
+ * Return a string "With Proper Casing".
+ */
+declare const getProperCase: (props: GetProperCase) => string;
+export default getProperCase;

package/string/getProperCase.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getString_1 = __importDefault(require("./getString"));
+/**
+ * Return a string "With Proper Casing".
+ */
+const getProperCase = (props) => {
+    let string = (0, getString_1.default)({
+        input: props.input,
+    });
+    if (props?.hyphen) {
+        string = string.split(/-/g).join(' ');
+    }
+    if (props?.pipe) {
+        string = string.split(/\|/g).join(' ');
+    }
+    if (props?.underscore) {
+        string = string.split(/_/g).join(' ');
+    }
+    return string.replace(/\w\S*/g, word => word.charAt(0)
+        .toUpperCase() + word.substr(1)
+        .toLowerCase());
+};
+exports.default = getProperCase;

package/string/getString.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Convert into string.
+ */
+declare const getString: ({ input }: {
+    input: any;
+}) => string;
+export default getString;

package/string/getString.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const isArray_1 = __importDefault(require("lodash/isArray"));
+const isDate_1 = __importDefault(require("lodash/isDate"));
+const isObject_1 = __importDefault(require("lodash/isObject"));
+const getNumber_1 = __importDefault(require("../date/getNumber"));
+/**
+ * Convert into string.
+ */
+const getString = ({ input }) => {
+    let string = '';
+    // Already a string
+    if ('string' === typeof input) {
+        string = input;
+    }
+    // Convert a number into a date
+    else if ('number' === typeof input) {
+        string = input.toString();
+    }
+    // Object or array to JSON
+    else if ((0, isObject_1.default)(input) || (0, isArray_1.default)(input)) {
+        string = JSON.stringify(input);
+    }
+    // Date
+    else if ((0, isDate_1.default)(input)) {
+        string = (0, getNumber_1.default)({ input })
+            .toString();
+    }
+    return string;
+};
+exports.default = getString;

package/string/getStringFromStream.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Converts a stream into a string.
+ * https://stackoverflow.com/a/49428486
+ */
+declare const getStringFromStream: ({ stream }: {
+    stream: any;
+}) => Promise<string>;
+export default getStringFromStream;

package/string/getStringFromStream.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Converts a stream into a string.
+ * https://stackoverflow.com/a/49428486
+ */
+const getStringFromStream = ({ stream }) => {
+    const chunks = [];
+    return new Promise((resolve, reject) => {
+        stream.on('data', (chunk) => chunks.push(Buffer.from(chunk)));
+        stream.on('error', (err) => reject(err));
+        stream.on('end', () => resolve(Buffer.concat(chunks)
+            .toString('utf8')));
+    });
+};
+exports.default = getStringFromStream;

package/string/getWithoutAccents.d.ts

@@ -0,0 +1,9 @@
+type GetWithoutAccents = {
+    input: string;
+};
+/**
+ * Remove the accents from a string.
+ * https://stackoverflow.com/a/37511463
+ */
+declare const getWithoutAccents: ({ input }: GetWithoutAccents) => string;
+export default getWithoutAccents;

package/string/getWithoutAccents.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getString_1 = __importDefault(require("./getString"));
+/**
+ * Remove the accents from a string.
+ * https://stackoverflow.com/a/37511463
+ */
+const getWithoutAccents = ({ input }) => {
+    return (0, getString_1.default)({ input })
+        .normalize("NFD")
+        .replace(/[\u0300-\u036f]/g, "");
+};
+exports.default = getWithoutAccents;

package/string/getWithoutHtmlTags.d.ts

@@ -0,0 +1,9 @@
+type GetWithoutHtmlTags = {
+    input: any;
+};
+/**
+ * Removes all HTML tags from an input.
+ * https://css-tricks.com/snippets/javascript/strip-html-tags-in-javascript/
+ */
+declare const getWithoutHtmlTags: ({ input }: GetWithoutHtmlTags) => string;
+export default getWithoutHtmlTags;

package/string/getWithoutHtmlTags.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getString_1 = __importDefault(require("./getString"));
+/**
+ * Removes all HTML tags from an input.
+ * https://css-tricks.com/snippets/javascript/strip-html-tags-in-javascript/
+ */
+const getWithoutHtmlTags = ({ input }) => {
+    return (0, getString_1.default)({ input })
+        .replace(/(<([^>]+)>)/gi, '');
+};
+exports.default = getWithoutHtmlTags;

package/string/getWithoutPunctuation.d.ts

@@ -0,0 +1,9 @@
+type GetWithoutPunctuation = {
+    input: string;
+};
+/**
+ * Remove all punctuation from a string and replace with a space.
+ * https://stackoverflow.com/a/25575009
+ */
+declare const getWithoutPunctuation: ({ input }: GetWithoutPunctuation) => string;
+export default getWithoutPunctuation;

package/string/getWithoutPunctuation.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getString_1 = __importDefault(require("./getString"));
+/**
+ * Remove all punctuation from a string and replace with a space.
+ * https://stackoverflow.com/a/25575009
+ */
+const getWithoutPunctuation = ({ input }) => {
+    return (0, getString_1.default)({ input })
+        .replace(/[\u2000-\u206F\u2E00-\u2E7F\\'!"#$%&()*+,\-.\/:;<=>?@\[\]^_`{|}~]/g, '')
+        .replace(/\s+/g, ' ');
+};
+exports.default = getWithoutPunctuation;

package/string/getWithoutUnderscores.d.ts

@@ -0,0 +1,8 @@
+type GetWithoutUnderscores = {
+    input: string;
+};
+/**
+ * Replace all underscores with a space.
+ */
+declare const getWithoutUnderscores: ({ input }: GetWithoutUnderscores) => string;
+export default getWithoutUnderscores;

package/string/getWithoutUnderscores.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getString_1 = __importDefault(require("./getString"));
+/**
+ * Replace all underscores with a space.
+ */
+const getWithoutUnderscores = ({ input }) => {
+    return (0, getString_1.default)({ input })
+        .replace('_', ' ');
+};
+exports.default = getWithoutUnderscores;

package/string/getWithoutWhitespaces.d.ts

@@ -0,0 +1,9 @@
+type GetWithoutWhitespaces = {
+    input: string;
+};
+/**
+ * Remove all new lines, tabs multiple spaces, with a single space.
+ * https://stackoverflow.com/a/45029224
+ */
+declare const getWithoutWhitespaces: ({ input }: GetWithoutWhitespaces) => string;
+export default getWithoutWhitespaces;

package/string/getWithoutWhitespaces.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getString_1 = __importDefault(require("./getString"));
+/**
+ * Remove all new lines, tabs multiple spaces, with a single space.
+ * https://stackoverflow.com/a/45029224
+ */
+const getWithoutWhitespaces = ({ input }) => {
+    return (0, getString_1.default)({ input })
+        .replace(/\s+/g, ' ')
+        .trim();
+};
+exports.default = getWithoutWhitespaces;

package/swr/isAllData.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Are all SWRs data ready.
+ */
+declare const isAllData: ({ swrs }: {
+    swrs: any;
+}) => boolean;
+export default isAllData;

package/swr/isAllData.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const isData_1 = __importDefault(require("./isData"));
+/**
+ * Are all SWRs data ready.
+ */
+const isAllData = ({ swrs }) => {
+    let fetcherWithData = 0;
+    for (const swr in swrs) {
+        if ((0, isData_1.default)({ swr: swrs[swr] })) {
+            fetcherWithData++;
+        }
+    }
+    return fetcherWithData === Object.keys(swrs).length;
+};
+exports.default = isAllData;

package/swr/isAnyError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Are any of the SWRs marked as an error.
+ */
+declare const isAnyError: ({ swrs }: {
+    swrs: any;
+}) => boolean;
+export default isAnyError;

package/swr/isAnyError.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const isError_1 = __importDefault(require("./isError"));
+/**
+ * Are any of the SWRs marked as an error.
+ */
+const isAnyError = ({ swrs }) => {
+    let fetcherError = 0;
+    for (const swr in swrs) {
+        if ((0, isError_1.default)({ swr: swrs[swr] })) {
+            fetcherError++;
+        }
+    }
+    return fetcherError > 0;
+};
+exports.default = isAnyError;