@8ms/helpers 1.42.3 → 1.42.6

package/dist/cjs/lumar/graphql/reportTemplates.js

@@ -1,70 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const reportTemplates = {
-    "200_PAGES": "200_pages",
-    "301_REDIRECTS": "301_redirects",
-    "4XX_ERRORS": "4xx_errors",
-    "5XX_ERRORS": "5xx_errors",
-    ALL_PAGES: 'all_pages',
-    BROKEN_EXTERNAL_LINKS: 'broken_links_external',
-    BROKEN_INTERNAL_LINKS: 'all_broken_links',
-    BROKEN_SITEMAP_PAGES: 'broken_sitemap_links',
-    CANONICAL_CONFLICTING: 'conflicting_canonical_tags',
-    CANONICAL_NON_200: 'canonical_to_non_200',
-    CANONICAL_NON_INDEXABLE: 'non_indexable_canonical_links_in',
-    CANONICAL_ORPHANED: 'unlinked_canonical_pages',
-    CUSTOM_EXTRACTION_1: 'custom_extraction_1',
-    CUSTOM_EXTRACTION_2: 'custom_extraction_2',
-    DUPLICATE_CONTENT: 'duplicate_body_content',
-    DUPLICATE_DESCRIPTIONS: 'pages_with_duplicate_descriptions',
-    DUPLICATE_TITLES: 'pages_with_duplicate_titles',
-    EMPTY_PAGES: 'empty_pages',
-    INDEXABLE_PAGES: 'indexable_pages',
-    LINKED_DOMAINS: 'linked_domains',
-    MAX_DESCRIPTIONS: 'max_description_length',
-    MAX_MOBILE_DESCRIPTIONS: 'max_mobile_description_length',
-    MAX_TITLES: 'max_title_length',
-    MISSING_DESCRIPTIONS: 'missing_descriptions',
-    MISSING_TITLES: 'missing_titles',
-    NON_301_REDIRECTS: 'non_301_redirects',
-    NON_INDEXABLE_PAGES: 'non_indexable_pages',
-    NON_INDEXABLE_SITEMAP_PAGES: 'sitemaps_non_indexable_links',
-    ORPHANED_CANONICAL: 'unlinked_canonical_pages',
-    ORPHANED_ANALYTICS_PAGES: 'orphaned_organic_landing_pages',
-    ORPHANED_SEARCH_CONSOLE_PAGES: 'orphaned_google_search_console_pages',
-    ORPHANED_SITEMAP_PAGES: 'orphaned_sitemaps_pages',
-    PAGES_WITH_HIGH_EXTERNAL_LINKS: 'max_external_links',
-    PERFORMANCE_MAX_FETCH_TIME: 'max_load_time',
-    PERFORMANCE_POOR_CLS: 'poor_cls',
-    PERFORMANCE_SLOW_DCL: 'slow_dcl',
-    PERFORMANCE_SLOW_FCP: 'slow_fcp',
-    PERFORMANCE_SLOW_LCP: 'slow_lcp',
-    PERFORMANCE_SLOW_TTFB: 'slow_server_response',
-    PERFORMANCE_SLOW_TTI: 'slow_tti',
-    PRIMARY_PAGES: 'unique_pages',
-    REDIRECTS_BROKEN: 'all_broken_redirects',
-    REDIRECTS_CHAIN: 'redirect_chains',
-    REDIRECTS_LOOP: 'redirection_loop',
-    SCHEMA_BREADCRUMB: 'pages_with_breadcrumb_schema',
-    SCHEMA_EVENT: 'pages_with_event_schema',
-    SCHEMA_FAQ: 'pages_with_faqpage_schema',
-    SCHEMA_HOW_TO: 'pages_with_howto_schema',
-    SCHEMA_NEWS_ARTICLE: 'pages_with_news_article_schema',
-    SCHEMA_PRODUCT: 'pages_with_product_schema',
-    SCHEMA_QA: 'pages_with_qapage_schema',
-    SCHEMA_RECIPE: 'pages_with_recipe_schema',
-    SCHEMA_REVIEW: 'pages_with_review_schema',
-    SCHEMA_VIDEO: 'pages_with_videoobject_schema',
-    SHORT_DESCRIPTIONS: 'short_descriptions',
-    SHORT_TITLES: 'short_titles',
-    SITEMAP_PAGES: 'all_sitemaps_links',
-    SITEMAPS_NON_INDEXABLE_PAGES: 'sitemaps_non_indexable_links',
-    SITEMAPS_ORPHANED_PAGES: 'orphaned_sitemaps_pages',
-    SITEMAPS_MISSING_PAGES: 'not_in_sitemaps_primary_indexable',
-    THIN_PAGES: 'thin_pages',
-    TRUE_UNIQUE_PAGES: 'true_uniques',
-    UNIQUE_EXTERNAL_LINKS: 'unique_external_links',
-    UNIQUE_INTERNAL_LINKS: 'unique_internal_links',
-    XML_SITEMAPS: 'xml_sitemaps',
-};
-exports.default = reportTemplates;

package/dist/cjs/lumar/graphql/reportTypes.d.ts

@@ -1,7 +0,0 @@
-declare const reportTypes: {
-    ADDED: string;
-    BASIC: string;
-    MISSING: string;
-    REMOVED: string;
-};
-export default reportTypes;

package/dist/cjs/lumar/graphql/reportTypes.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const reportTypes = {
-    ADDED: "Added",
-    BASIC: "Basic",
-    MISSING: "Missing",
-    REMOVED: "Removed",
-};
-exports.default = reportTypes;

package/dist/cjs/myTarget/getAccessToken.d.ts

@@ -1,9 +0,0 @@
-type GetAccessToken = {
-    force: boolean;
-    parameterName: string;
-};
-/**
- * Retrieve the access token from SSM Parameter Store.
- */
-declare const getAccessToken: ({ force, parameterName }: GetAccessToken) => Promise<void>;
-export default getAccessToken;

package/dist/cjs/myTarget/getAccessToken.js

@@ -1,23 +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"));
-global.myTargetAccessToken = null;
-/**
- * Retrieve the access token from SSM Parameter Store.
- */
-const getAccessToken = async ({ force, parameterName }) => {
-    if (!global.myTargetAccessToken || force) {
-        // Get the credentials from SSM
-        const parameter = await (0, getParameter_1.default)({
-            name: parameterName,
-            withDecryption: true,
-            isJson: true,
-        });
-        global.myTargetAccessToken = parameter.accessToken;
-    }
-    return global.myTargetAccessToken;
-};
-exports.default = getAccessToken;

package/dist/cjs/myTarget/request.d.ts

@@ -1,9 +0,0 @@
-import ApiResponse from '../api/ApiResponse';
-/**
- * Make the request to MyTarget API using the access token.
- */
-declare const request: ({ data, url }: {
-    data: object;
-    url: string;
-}) => Promise<ApiResponse>;
-export default request;

package/dist/cjs/myTarget/request.js

@@ -1,23 +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 post_1 = __importDefault(require("../axios/post"));
-/**
- * Make the request to MyTarget API using the access token.
- */
-const request = async ({ data, url }) => {
-    const response = await (0, post_1.default)({
-        config: {
-            headers: {
-                Authorization: `Bearer ${global.myTargetAccessToken}`,
-                "Content-Type": "application/json",
-            },
-        },
-        data: data,
-        url: url,
-    });
-    return response;
-};
-exports.default = request;

package/dist/cjs/nextAuth/index.d.ts

@@ -1,5 +0,0 @@
-export declare enum State {
-    AUTHENTICATED = "authenticated",
-    PENDING = "loading",// Defined by NextAuth
-    UNAUTHENTICATED = "unauthenticated"
-}

package/dist/cjs/nextAuth/index.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.State = void 0;
-var State;
-(function (State) {
-    State["AUTHENTICATED"] = "authenticated";
-    State["PENDING"] = "loading";
-    State["UNAUTHENTICATED"] = "unauthenticated";
-})(State || (exports.State = State = {}));

package/dist/cjs/nextAuth/isSessionReady.d.ts

@@ -1,4 +0,0 @@
-declare const isSessionReady: ({ session }: {
-    session: any;
-}) => boolean;
-export default isSessionReady;

package/dist/cjs/nextAuth/isSessionReady.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const isSessionReady = ({ session }) => {
-    let response = false;
-    if (undefined !== session && null !== session) {
-        if (undefined !== session.user && null !== session.user) {
-            response = true;
-        }
-    }
-    return response;
-};
-exports.default = isSessionReady;

package/dist/cjs/nextJs/getIp.d.ts

@@ -1,7 +0,0 @@
-/**
- * Get the user's remote IP Address
- */
-declare const getIp: ({ req }: {
-    req: any;
-}) => string;
-export default getIp;

package/dist/cjs/nextJs/getIp.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Get the user's remote IP Address
- */
-const getIp = ({ req }) => {
-    let response = 'unset';
-    if (undefined !== req.headers['x-real-ip']) {
-        response = String(req.headers['x-real-ip']);
-    }
-    return response;
-};
-exports.default = getIp;

package/dist/cjs/nextJs/getUserAgent.d.ts

@@ -1,7 +0,0 @@
-/**
- * Get the user's User Agent
- */
-declare const getUserAgent: ({ req }: {
-    req: any;
-}) => string;
-export default getUserAgent;

package/dist/cjs/nextJs/getUserAgent.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Get the user's User Agent
- */
-const getUserAgent = ({ req }) => req.headers['user-agent'] || 'unset';
-exports.default = getUserAgent;

package/dist/cjs/nextJs/tests/getIp.d.ts

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

package/dist/cjs/nextJs/tests/getIp.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 getIp_1 = __importDefault(require("../getIp"));
-test('getIp - Exists', () => {
-    const request = {
-        headers: {
-            'x-real-ip': 'value',
-        }
-    };
-    expect((0, getIp_1.default)({ req: request }))
-        .toBe('value');
-});
-test('getIp - Undefined', () => {
-    const request = {
-        headers: {}
-    };
-    expect((0, getIp_1.default)({ req: request }))
-        .toBe('unset');
-});

package/dist/cjs/nextJs/tests/getUserAgent.test.d.ts

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

package/dist/cjs/nextJs/tests/getUserAgent.test.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 getUserAgent_1 = __importDefault(require("../getUserAgent"));
-test('getUserAgent - Exists', () => {
-    const request = {
-        headers: {
-            'user-agent': 'value',
-        },
-    };
-    expect((0, getUserAgent_1.default)({ req: request }))
-        .toBe('value');
-});
-test('getUserAgent - Undefined', () => {
-    const request = {
-        headers: {},
-    };
-    expect((0, getUserAgent_1.default)({ req: request }))
-        .toBe('unset');
-});

package/dist/cjs/number/format.d.ts

@@ -1,11 +0,0 @@
-type Format = {
-    compact?: boolean;
-    input: any;
-    minDp?: number;
-    maxDp?: number;
-};
-/**
- * Take a given number and format it.
- */
-declare const format: (props: Format) => string;
-export default format;

package/dist/cjs/number/format.js

@@ -1,23 +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"));
-/**
- * Take a given number and format it.
- */
-const format = (props) => {
-    const inputValue = (0, getNumber_1.default)({
-        input: props.input,
-    });
-    const options = {
-        minimumFractionDigits: undefined !== props?.minDp ? props?.minDp : 0,
-        maximumFractionDigits: undefined !== props?.maxDp ? props?.maxDp : 2,
-        notation: true === props?.compact ? "compact" : "standard",
-    };
-    // @ts-ignore
-    return Intl.NumberFormat('en-GB', options)
-        .format(inputValue);
-};
-exports.default = format;

package/dist/cjs/number/getCurrency.d.ts

@@ -1,10 +0,0 @@
-type GetCurrency = {
-    currency: string;
-    input: any;
-};
-/**
- * Use the International number formatting to return the currency value.
- * https://www.freecodecamp.org/news/how-to-format-number-as-currency-in-javascript-one-line-of-code/
- */
-declare const getCurrency: ({ currency, input }: GetCurrency) => string;
-export default getCurrency;

package/dist/cjs/number/getCurrency.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Use the International number formatting to return the currency value.
- * https://www.freecodecamp.org/news/how-to-format-number-as-currency-in-javascript-one-line-of-code/
- */
-const getCurrency = ({ currency, input }) => {
-    const value = Number(input);
-    const currencyClean = currency.toUpperCase()
-        .trim();
-    let formatted = new Intl.NumberFormat('en-GB', {
-        style: 'currency',
-        currency: currencyClean,
-    }).format(value);
-    if ('USD' === currencyClean) {
-        formatted = formatted.replace('US$', '$');
-    }
-    return formatted;
-};
-exports.default = getCurrency;

package/dist/cjs/number/getDecimal.d.ts

@@ -1,9 +0,0 @@
-type GetDecimal = {
-    dp?: number;
-    input: any;
-};
-/**
- * Return a decimal number after rounding.
- */
-declare const getDecimal: (props: GetDecimal) => number;
-export default getDecimal;

package/dist/cjs/number/getDecimal.js

@@ -1,16 +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"));
-/**
- * Return a decimal number after rounding.
- */
-const getDecimal = (props) => {
-    const number = (0, getNumber_1.default)({
-        input: props.input,
-    });
-    return Number(number.toFixed(props?.dp || 2));
-};
-exports.default = getDecimal;

package/dist/cjs/number/getDivide.d.ts

@@ -1,11 +0,0 @@
-type GetDivide = {
-    defaultValue?: number;
-    dp?: number;
-    divisor: any;
-    numerator: any;
-};
-/**
- * Shorthand function to divide number, but fallback if the divisor is 0.
- */
-declare const getDivide: (props: GetDivide) => number;
-export default getDivide;

package/dist/cjs/number/getDivide.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 getNumber_1 = __importDefault(require("./getNumber"));
-const getDecimal_1 = __importDefault(require("./getDecimal"));
-/**
- * Shorthand function to divide number, but fallback if the divisor is 0.
- */
-const getDivide = (props) => {
-    const numeratorInt = (0, getNumber_1.default)({
-        input: props.numerator
-    });
-    const divisorInt = (0, getNumber_1.default)({
-        input: props.divisor
-    });
-    if (0 === divisorInt) {
-        return props.defaultValue || 0;
-    }
-    return (0, getDecimal_1.default)({
-        dp: props?.dp,
-        input: numeratorInt / divisorInt
-    });
-};
-exports.default = getDivide;

package/dist/cjs/number/getNumber.d.ts

@@ -1,8 +0,0 @@
-/**
- * Take an input and return a number.
- */
-declare const getNumber: ({ defaultValue, input }: {
-    defaultValue?: number;
-    input: any;
-}) => number;
-export default getNumber;

package/dist/cjs/number/getNumber.js

@@ -1,51 +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 isJson_1 = __importDefault(require("../json/isJson"));
-/**
- * Take an input and return a number.
- */
-const getNumber = ({ defaultValue = 0, input = '' }) => {
-    const actualDefaultValue = defaultValue || 0;
-    let response = input;
-    // JSON - Decode the value
-    if ((0, isJson_1.default)({ input })) {
-        // Only parse this if it's a string
-        if ('string' === typeof input) {
-            response = JSON.parse(input);
-        }
-        // Already decoded
-        else {
-            response = input;
-        }
-    }
-    // Already a number
-    if ('number' === typeof response) {
-        response = response;
-    }
-    // String input
-    else if ('string' === typeof response) {
-        // Attempt to convert to number
-        response = Number(response);
-        // Not a number, try extracting the number value
-        if (isNaN(response)) {
-            const match = RegExp(/^\D*([0-9\.]*)\D*$/, 'g')
-                .exec(input);
-            if (match.length) {
-                response = Number(match[1]);
-            }
-        }
-    }
-    // Attempt to convert to a number
-    else {
-        response = Number(response);
-    }
-    // Trouble converting the number, use default value
-    if (isNaN(response)) {
-        response = actualDefaultValue;
-    }
-    return response;
-};
-exports.default = getNumber;

package/dist/cjs/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/dist/cjs/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/dist/cjs/number/tests/format.test.d.ts

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

package/dist/cjs/number/tests/format.test.js

@@ -1,58 +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 format_1 = __importDefault(require("../format"));
-test('format - compact 2dp', () => {
-    const formatted = (0, format_1.default)({
-        input: 123456778,
-        compact: true,
-        minDp: 2,
-        maxDp: 2,
-    });
-    const expected = "123.46M";
-    expect(formatted)
-        .toBe(expected);
-});
-test('format - compact 0dp', () => {
-    const formatted = (0, format_1.default)({
-        input: 123456778,
-        compact: true,
-        minDp: 0,
-        maxDp: 0,
-    });
-    const expected = "123M";
-    expect(formatted)
-        .toBe(expected);
-});
-test('format - long 0dp', () => {
-    const formatted = (0, format_1.default)({
-        input: 123456778,
-        compact: false,
-        minDp: 0,
-        maxDp: 0,
-    });
-    const expected = "123,456,778";
-    expect(formatted)
-        .toBe(expected);
-});
-test('format - long 2dp', () => {
-    const formatted = (0, format_1.default)({
-        input: 123456778,
-        compact: false,
-        minDp: 2,
-        maxDp: 2,
-    });
-    const expected = "123,456,778.00";
-    expect(formatted)
-        .toBe(expected);
-});
-test('format - simple', () => {
-    const formatted = (0, format_1.default)({
-        input: 123456778,
-    });
-    const expected = "123,456,778";
-    expect(formatted)
-        .toBe(expected);
-});

package/dist/cjs/number/tests/getCurrency.test.d.ts

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

package/dist/cjs/number/tests/getCurrency.test.js

@@ -1,23 +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 getCurrency_1 = __importDefault(require("../getCurrency"));
-test('getCurrency', () => {
-    expect((0, getCurrency_1.default)({
-        currency: 'GBP',
-        input: '5',
-    }))
-        .toBe('£5.00');
-    expect((0, getCurrency_1.default)({
-        currency: 'GBP',
-        input: '123.456',
-    }))
-        .toBe('£123.46');
-    expect((0, getCurrency_1.default)({
-        currency: 'USD',
-        input: '123.456',
-    }))
-        .toBe('$123.46');
-});

package/dist/cjs/number/tests/getNumber.test.d.ts

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

package/dist/cjs/number/tests/getNumber.test.js

@@ -1,24 +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"));
-test('getNumber - should be number', () => {
-    expect((0, getNumber_1.default)({ defaultValue: 10, input: 99 }))
-        .toBe(99);
-    expect((0, getNumber_1.default)({ defaultValue: 10, input: '99' }))
-        .toBe(99);
-    expect((0, getNumber_1.default)({ defaultValue: 10, input: 5 * 25 }))
-        .toBe(125);
-    expect((0, getNumber_1.default)({ defaultValue: 10, input: '_50' }))
-        .toBe(50);
-    expect((0, getNumber_1.default)({ defaultValue: 10, input: '33.3232%' }))
-        .toBe(33.3232);
-});
-test('getNumber - revert to default', () => {
-    expect((0, getNumber_1.default)({ defaultValue: 10, input: {} }))
-        .toBe(10);
-    expect((0, getNumber_1.default)({ input: {} }))
-        .toBe(0);
-});

package/dist/cjs/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;