@8ms/helpers 1.38.0 → 2.0.0

package/number/getPercentIncrease.d.ts

@@ -1,10 +0,0 @@
-type GetPercentageIncrease = {
-    comparison: any;
-    current: any;
-    defaultValue: number;
-};
-/**
- * Formula to work out the percentage increase/decrease.
- */
-declare const getPercentageIncrease: ({ comparison, current, defaultValue }: GetPercentageIncrease) => number;
-export default getPercentageIncrease;

package/number/getPercentIncrease.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 getNumber_1 = __importDefault(require("./getNumber"));
-/**
- * Formula to work out the percentage increase/decrease.
- */
-const getPercentageIncrease = ({ comparison, current, defaultValue }) => {
-    const currentValue = (0, getNumber_1.default)({
-        input: current
-    });
-    const comparisonValue = (0, getNumber_1.default)({
-        input: comparison
-    });
-    if (0 === comparisonValue) {
-        return defaultValue;
-    }
-    return (currentValue - comparisonValue) / comparisonValue * 100;
-};
-exports.default = getPercentageIncrease;

package/object/replaceKeys.d.ts

@@ -1,10 +0,0 @@
-type ReplaceKeys = {
-    instance: any;
-    getNewKey: Function;
-};
-/**
- * Iteratively replace all the keys in an object.
- * https://www.techighness.com/post/replace-all-keys-of-deeply-nested-objects-or-array-of-objects/
- */
-declare const replaceKeys: ({ instance, getNewKey }: ReplaceKeys) => object;
-export default replaceKeys;

package/object/replaceKeys.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Iteratively replace all the keys in an object.
- * https://www.techighness.com/post/replace-all-keys-of-deeply-nested-objects-or-array-of-objects/
- */
-const replaceKeys = ({ instance, getNewKey }) => {
-    let response = instance;
-    if (Array.isArray(instance)) {
-        response = [];
-        for (let i = 0; i < instance.length; i++) {
-            response[i] = replaceKeys({
-                instance: instance[i],
-                getNewKey,
-            });
-        }
-    }
-    else if ("object" === typeof instance) {
-        response = {};
-        for (const key in instance) {
-            const newKey = getNewKey(key);
-            response[newKey] = replaceKeys({
-                instance: instance[key],
-                getNewKey,
-            });
-        }
-    }
-    return response;
-};
-exports.default = replaceKeys;

package/prisma/getDecimal.d.ts

@@ -1,9 +0,0 @@
-type GetDecimal = {
-    input: any;
-    dp?: number;
-};
-/**
- * Fetch the number from a prisma decimal (comes through as an object).
- */
-declare const getDecimal: (props: GetDecimal) => number;
-export default getDecimal;

package/prisma/getDecimal.js

@@ -1,18 +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 getDecimal_1 = __importDefault(require("../number/getDecimal"));
-/**
- * Fetch the number from a prisma decimal (comes through as an object).
- */
-const getDecimal = (props) => {
-    let whole = props?.input?.d?.[0] || 0;
-    let decimal = props?.input?.d?.[1] || 0;
-    return (0, getDecimal_1.default)({
-        input: `${whole}.${decimal}`,
-        dp: props?.dp
-    });
-};
-exports.default = getDecimal;

package/prisma/initClient.d.ts

@@ -1,6 +0,0 @@
-type InitClient = {
-    debug?: boolean;
-    planetScale?: boolean;
-};
-declare const initClient: (props?: InitClient) => void;
-export default initClient;

package/prisma/initClient.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-global.prisma = null;
-const initClient = (props = {}) => {
-    if (!global.prisma) {
-        const { PrismaClient } = require("@prisma/client");
-        let adapter = null;
-        if (true === props?.planetScale) {
-            const { Client } = require("@planetscale/database");
-            const client = new Client({
-                url: process.env.DATABASE_URL
-            });
-            const { PrismaPlanetScale } = require("@prisma/adapter-planetscale");
-            adapter = new PrismaPlanetScale(client);
-        }
-        // Show the full query if debugging
-        if (true === props?.debug) {
-            global.prisma = new PrismaClient({
-                adapter,
-                log: [
-                    {
-                        emit: "event",
-                        level: "query",
-                    },
-                ],
-            });
-        }
-        // Standard prisma
-        else {
-            global.prisma = new PrismaClient({
-                adapter
-            });
-        }
-    }
-};
-exports.default = initClient;

package/snapchat/getAccessToken.d.ts

@@ -1,9 +0,0 @@
-type GetAccessToken = {
-    force?: boolean;
-    parameterName: string;
-};
-/**
- * Renew the access token as it expires every 3 hours.
- */
-declare const getAccessToken: ({ force, parameterName }: GetAccessToken) => Promise<void>;
-export default getAccessToken;

package/snapchat/getAccessToken.js

@@ -1,35 +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 getParameter_1 = __importDefault(require("../aws/ssm/getParameter"));
-const post_1 = __importDefault(require("../axios/post"));
-global.snapchatAccessToken = null;
-/**
- * Renew the access token as it expires every 3 hours.
- */
-const getAccessToken = async ({ force, parameterName }) => {
-    if (!global.snapchatAccessToken || force) {
-        // Get the credentials from SSM
-        const parameter = await (0, getParameter_1.default)({
-            name: parameterName,
-            withDecryption: true,
-            isJson: true,
-        });
-        // Build the token request for Snapchat
-        let url = `https://accounts.snapchat.com/login/oauth2/access_token`;
-        url += `?client_id=${parameter.clientId}`;
-        url += `&client_secret=${parameter.clientSecret}`;
-        url += `&grant_type=refresh_token`;
-        url += `&refresh_token=${parameter.refreshToken}`;
-        const apiResponse = await (0, post_1.default)({
-            url,
-        });
-        if (apiResponse.isSuccess()) {
-            global.snapchatAccessToken = apiResponse.getBodyDefaultTo({ defaultValue: null, keys: ['data', 'access_token'] });
-        }
-    }
-    return global.snapchatAccessToken;
-};
-exports.default = getAccessToken;

package/sorting/byNumberAscending.d.ts

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

package/sorting/byNumberAscending.js

@@ -1,17 +0,0 @@
-"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

@@ -1,8 +0,0 @@
-/**
- * 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

@@ -1,17 +0,0 @@
-"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

@@ -1,8 +0,0 @@
-/**
- * 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

@@ -1,21 +0,0 @@
-"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

@@ -1,8 +0,0 @@
-/**
- * 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

@@ -1,21 +0,0 @@
-"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

@@ -1,14 +0,0 @@
-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 {
-    static [x: string]: any;
-    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

@@ -1,50 +0,0 @@
-"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

@@ -1,10 +0,0 @@
-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

@@ -1,17 +0,0 @@
-"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

@@ -1,18 +0,0 @@
-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

@@ -1,65 +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 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

@@ -1,10 +0,0 @@
-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

@@ -1,26 +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 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

@@ -1,8 +0,0 @@
-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

@@ -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 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

@@ -1,11 +0,0 @@
-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

@@ -1,27 +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 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

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

package/string/getString.js

@@ -1,34 +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 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

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