@8ms/helpers 1.41.0 → 1.42.0

package/dist/esm/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/dist/esm/string/getDecoded.js

@@ -0,0 +1,21 @@
+import getString from "./getString";
+import _unescape from 'lodash/unescape';
+/**
+ * Convert escaped copy into unescaped.
+ * E.g. there's => there's
+ * https://stackoverflow.com/a/42182294/2664955
+ */
+const getDecoded = ({ input }) => {
+    let response = getString({ input });
+    // Only works if DOM exists
+    if ('undefined' !== typeof document) {
+        let el = document.createElement("textarea");
+        el.innerHTML = response;
+        response = el.value;
+    }
+    else {
+        response = _unescape(response);
+    }
+    return response;
+};
+export default getDecoded;

package/dist/esm/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/dist/esm/string/getFolder.js

@@ -0,0 +1,9 @@
+import trim from 'lodash/trim';
+/**
+ * Take an input that may have a / before or after the input and return just the folder.
+ */
+const getFolder = ({ input }) => {
+    return trim(input, '/')
+        .trim();
+};
+export default getFolder;

package/dist/esm/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/dist/esm/string/getProperCase.js

@@ -0,0 +1,22 @@
+import getString from './getString';
+/**
+ * Return a string "With Proper Casing".
+ */
+const getProperCase = (props) => {
+    let string = getString({
+        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());
+};
+export default getProperCase;

package/dist/esm/string/getString.d.ts

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

package/dist/esm/string/getString.js

@@ -0,0 +1,29 @@
+import isArray from 'lodash/isArray';
+import isDate from 'lodash/isDate';
+import isObject from 'lodash/isObject';
+import getNumber from '../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 (isObject(input) || isArray(input)) {
+        string = JSON.stringify(input);
+    }
+    // Date
+    else if (isDate(input)) {
+        string = getNumber({ input })
+            .toString();
+    }
+    return string;
+};
+export default getString;

package/dist/esm/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/dist/esm/string/getStringFromStream.js

@@ -0,0 +1,14 @@
+/**
+ * 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')));
+    });
+};
+export default getStringFromStream;

package/dist/esm/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/dist/esm/string/getWithoutAccents.js

@@ -0,0 +1,11 @@
+import getString from "./getString";
+/**
+ * Remove the accents from a string.
+ * https://stackoverflow.com/a/37511463
+ */
+const getWithoutAccents = ({ input }) => {
+    return getString({ input })
+        .normalize("NFD")
+        .replace(/[\u0300-\u036f]/g, "");
+};
+export default getWithoutAccents;

package/dist/esm/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/dist/esm/string/getWithoutHtmlTags.js

@@ -0,0 +1,10 @@
+import getString from './getString';
+/**
+ * Removes all HTML tags from an input.
+ * https://css-tricks.com/snippets/javascript/strip-html-tags-in-javascript/
+ */
+const getWithoutHtmlTags = ({ input }) => {
+    return getString({ input })
+        .replace(/(<([^>]+)>)/gi, '');
+};
+export default getWithoutHtmlTags;

package/dist/esm/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/dist/esm/string/getWithoutPunctuation.js

@@ -0,0 +1,11 @@
+import getString from "./getString";
+/**
+ * Remove all punctuation from a string and replace with a space.
+ * https://stackoverflow.com/a/25575009
+ */
+const getWithoutPunctuation = ({ input }) => {
+    return getString({ input })
+        .replace(/[\u2000-\u206F\u2E00-\u2E7F\\'!"#$%&()*+,\-.\/:;<=>?@\[\]^_`{|}~]/g, '')
+        .replace(/\s+/g, ' ');
+};
+export default getWithoutPunctuation;

package/dist/esm/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/dist/esm/string/getWithoutUnderscores.js

@@ -0,0 +1,9 @@
+import getString from "./getString";
+/**
+ * Replace all underscores with a space.
+ */
+const getWithoutUnderscores = ({ input }) => {
+    return getString({ input })
+        .replace('_', ' ');
+};
+export default getWithoutUnderscores;

package/dist/esm/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/dist/esm/string/getWithoutWhitespaces.js

@@ -0,0 +1,11 @@
+import getString from "./getString";
+/**
+ * Remove all new lines, tabs multiple spaces, with a single space.
+ * https://stackoverflow.com/a/45029224
+ */
+const getWithoutWhitespaces = ({ input }) => {
+    return getString({ input })
+        .replace(/\s+/g, ' ')
+        .trim();
+};
+export default getWithoutWhitespaces;

package/dist/esm/string/tests/getCapitalised.test.d.ts

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

package/dist/esm/string/tests/getCapitalised.test.js

@@ -0,0 +1,7 @@
+import getCapitalised from '../getCapitalised';
+test('getCapitalised', () => {
+    const input = 'GOOGLE_ADS';
+    const expected = "Google Ads";
+    expect(getCapitalised({ input }))
+        .toBe(expected);
+});

package/dist/esm/string/tests/getDecoded.test.d.ts

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

package/dist/esm/string/tests/getDecoded.test.js

@@ -0,0 +1,7 @@
+import getDecoded from '../getDecoded';
+test('getUnescaped', () => {
+    const input = 'there's';
+    const expected = "there's";
+    expect(getDecoded({ input }))
+        .toBe(expected);
+});

package/dist/esm/string/tests/getFolder.test.d.ts

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

package/dist/esm/string/tests/getFolder.test.js

@@ -0,0 +1,7 @@
+import getFolder from '../getFolder';
+test('getFolder', () => {
+    const input = ' /some-folder/ ';
+    const expected = '/some-folder/';
+    expect(getFolder({ input }))
+        .toBe(expected);
+});

package/dist/esm/string/tests/getString.test.d.ts

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

package/dist/esm/string/tests/getString.test.js

@@ -0,0 +1,29 @@
+import getString from '../getString';
+test('getString - string', () => {
+    const input = 'this is a test';
+    const expected = 'this is a test';
+    expect(getString({ input }))
+        .toBe(expected);
+});
+test('getString - array', () => {
+    const input = ['a', 'b', 'c'];
+    const expected = "[\"a\",\"b\",\"c\"]";
+    expect(getString({ input }))
+        .toBe(expected);
+});
+test('getString - number', () => {
+    const input = 124;
+    const expected = "124";
+    expect(getString({ input }))
+        .toBe(expected);
+});
+test('getString - object', () => {
+    const input = {
+        something: 'not true',
+        or: 'else',
+        else: [1, 3, 4],
+    };
+    const expected = "{\"something\":\"not true\",\"or\":\"else\",\"else\":[1,3,4]}";
+    expect(getString({ input }))
+        .toBe(expected);
+});

package/dist/esm/string/tests/getWithoutHtmlTags.test.d.ts

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

package/dist/esm/string/tests/getWithoutHtmlTags.test.js

@@ -0,0 +1,13 @@
+import getWithoutHtmlTags from '../getWithoutHtmlTags';
+test('getWithoutHtmlTags - single tag', () => {
+    const input = 'what could happen to <b>Example</b> shares';
+    const expected = 'what could happen to Example shares';
+    expect(getWithoutHtmlTags({ input }))
+        .toBe(expected);
+});
+test('getWithoutHtmlTags - nested tag', () => {
+    const input = 'what could happen to <b><span>Example</span></b> shares';
+    const expected = 'what could happen to Example shares';
+    expect(getWithoutHtmlTags({ input }))
+        .toBe(expected);
+});

package/dist/esm/swr/isAllData.d.ts

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

package/dist/esm/swr/isAllData.js

@@ -0,0 +1,14 @@
+import isData from './isData';
+/**
+ * Are all SWRs data ready.
+ */
+const isAllData = ({ swrs }) => {
+    let fetcherWithData = 0;
+    for (const swr in swrs) {
+        if (isData({ swr: swrs[swr] })) {
+            fetcherWithData++;
+        }
+    }
+    return fetcherWithData === Object.keys(swrs).length;
+};
+export default isAllData;

package/dist/esm/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/dist/esm/swr/isAnyError.js

@@ -0,0 +1,14 @@
+import isError from './isError';
+/**
+ * Are any of the SWRs marked as an error.
+ */
+const isAnyError = ({ swrs }) => {
+    let fetcherError = 0;
+    for (const swr in swrs) {
+        if (isError({ swr: swrs[swr] })) {
+            fetcherError++;
+        }
+    }
+    return fetcherError > 0;
+};
+export default isAnyError;

package/dist/esm/swr/isAnyLoading.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Are any of SWRs loading
+ */
+export declare const isAnyLoading: ({ swrs }: {
+    swrs: any;
+}) => boolean;
+export default isAnyLoading;

package/dist/esm/swr/isAnyLoading.js

@@ -0,0 +1,14 @@
+import isLoading from './isLoading';
+/**
+ * Are any of SWRs loading
+ */
+export const isAnyLoading = ({ swrs }) => {
+    let fetcherLoading = 0;
+    for (const swr in swrs) {
+        if (isLoading({ swr: swrs[swr] })) {
+            fetcherLoading++;
+        }
+    }
+    return fetcherLoading > 0;
+};
+export default isAnyLoading;

package/dist/esm/swr/isData.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Check to see if a single SWR has an error.
+ */
+declare const isData: ({ swr }: {
+    swr: any;
+}) => boolean;
+export default isData;

package/dist/esm/swr/isData.js

@@ -0,0 +1,7 @@
+/**
+ * Check to see if a single SWR has an error.
+ */
+const isData = ({ swr }) => (undefined === swr.error || null === swr.error) &&
+    undefined !== swr.data &&
+    'undefined' !== swr.data;
+export default isData;

package/dist/esm/swr/isError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Check to see if a single SWR has an error.
+ */
+declare const isError: ({ swr }: {
+    swr: any;
+}) => boolean;
+export default isError;

package/dist/esm/swr/isError.js

@@ -0,0 +1,5 @@
+/**
+ * Check to see if a single SWR has an error.
+ */
+const isError = ({ swr }) => undefined !== swr.error && null !== swr.error;
+export default isError;

package/dist/esm/swr/isLoading.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Check to see if a single SWR is loading.
+ */
+declare const isLoading: ({ swr }: {
+    swr: any;
+}) => boolean;
+export default isLoading;

package/dist/esm/swr/isLoading.js

@@ -0,0 +1,7 @@
+import isData from './isData';
+import isError from './isError';
+/**
+ * Check to see if a single SWR is loading.
+ */
+const isLoading = ({ swr }) => !isError({ swr }) && !isData({ swr });
+export default isLoading;

package/dist/esm/upTimeRobot/getMonitors.d.ts

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

package/dist/esm/upTimeRobot/getMonitors.js

@@ -0,0 +1,28 @@
+import isArray from 'lodash/isArray';
+import post from '../axios/post';
+/**
+ * Use the Up Time Robot API to retrieve up to 50 monitors at a time.
+ * https://uptimerobot.com/api/
+ */
+const getMonitors = async ({ apiKey, params }) => {
+    let finalParams = {};
+    if (undefined !== params) {
+        finalParams = {
+            ...params,
+        };
+        if (undefined !== params.monitors && isArray(params.monitors)) {
+            finalParams['monitors'] = params.monitors.join('-');
+        }
+        if (undefined !== params.statuses && isArray(params.statuses)) {
+            finalParams['statuses'] = params.statuses.join('-');
+        }
+        if (undefined !== params.types && isArray(params.types)) {
+            finalParams['types'] = params.types.join('-');
+        }
+    }
+    const response = await post({
+        data: finalParams,
+        url: `https://api.uptimerobot.com/v2/getMonitors?api_key=${apiKey}`,
+    });
+    return response;
+};

package/dist/esm/upTimeRobot/logTypes.d.ts

@@ -0,0 +1,7 @@
+declare const logTypes: {
+    DOWN: number;
+    UP: number;
+    PAUSED: number;
+    STARTED: number;
+};
+export default logTypes;

package/dist/esm/upTimeRobot/logTypes.js

@@ -0,0 +1,7 @@
+const logTypes = {
+    DOWN: 1,
+    UP: 2,
+    PAUSED: 99,
+    STARTED: 98,
+};
+export default logTypes;

package/dist/esm/upTimeRobot/monitorStatuses.d.ts

@@ -0,0 +1,8 @@
+declare const monitorStatuses: {
+    PAUSED: number;
+    NOT_CHECKED: number;
+    UP: number;
+    SEEMS_DOWN: number;
+    DOWN: number;
+};
+export default monitorStatuses;

package/dist/esm/upTimeRobot/monitorStatuses.js

@@ -0,0 +1,8 @@
+const monitorStatuses = {
+    PAUSED: 0,
+    NOT_CHECKED: 1,
+    UP: 2,
+    SEEMS_DOWN: 8,
+    DOWN: 9,
+};
+export default monitorStatuses;

package/dist/esm/upTimeRobot/monitorSubTypes.d.ts

@@ -0,0 +1,10 @@
+declare const monitorSubTypes: {
+    HTTP: number;
+    HTTPS: number;
+    FTP: number;
+    SMTP: number;
+    POP3: number;
+    IMAP: number;
+    CUSTOM_PORT: number;
+};
+export default monitorSubTypes;

package/dist/esm/upTimeRobot/monitorSubTypes.js

@@ -0,0 +1,10 @@
+const monitorSubTypes = {
+    HTTP: 1,
+    HTTPS: 2,
+    FTP: 3,
+    SMTP: 4,
+    POP3: 5,
+    IMAP: 6,
+    CUSTOM_PORT: 99,
+};
+export default monitorSubTypes;

package/dist/esm/upTimeRobot/monitorTypes.d.ts

@@ -0,0 +1,8 @@
+declare const monitorTypes: {
+    HTTPS: number;
+    KEYWORD: number;
+    PING: number;
+    PORT: number;
+    HEARTBEAT: number;
+};
+export default monitorTypes;

package/dist/esm/upTimeRobot/monitorTypes.js

@@ -0,0 +1,8 @@
+const monitorTypes = {
+    HTTPS: 1,
+    KEYWORD: 2,
+    PING: 3,
+    PORT: 4,
+    HEARTBEAT: 5,
+};
+export default monitorTypes;

package/dist/esm/upTimeRobot/requestStatuses.d.ts

@@ -0,0 +1,5 @@
+declare const requestStatuses: {
+    ERROR: string;
+    SUCCESS: string;
+};
+export default requestStatuses;

package/dist/esm/upTimeRobot/requestStatuses.js

@@ -0,0 +1,5 @@
+const requestStatuses = {
+    ERROR: 'fail',
+    SUCCESS: 'ok',
+};
+export default requestStatuses;

package/dist/esm/url/buildParameters.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Take an object and return the parameter for a given URL irrespective of path.
+ */
+declare const buildParameters: ({ existing, updated }: {
+    existing: object;
+    updated: object;
+}) => string;
+export default buildParameters;

package/dist/esm/url/buildParameters.js

@@ -0,0 +1,17 @@
+import merge from 'lodash/merge';
+/**
+ * Take an object and return the parameter for a given URL irrespective of path.
+ */
+const buildParameters = ({ existing, updated }) => {
+    const merged = merge(existing, updated);
+    let response = '';
+    if (Object.values(merged).length) {
+        for (const key in merged) {
+            const value = undefined === updated[key] ? existing[key] : updated[key];
+            response += '' === response ? '?' : '&';
+            response += `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
+        }
+    }
+    return response;
+};
+export default buildParameters;

package/dist/esm/url/buildRelative.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Create a new relative URL based on the current path.
+ */
+declare const buildRelative: ({ router, updated }: {
+    router: any;
+    updated: object;
+}) => string;
+export default buildRelative;