@8ms/helpers 1.39.0 → 2.0.1

package/lumar/api/getData.js

@@ -1,18 +1,13 @@
 "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"));
+exports.getData = void 0;
+const axios_1 = require("../../axios");
 const getData = async ({ url }) => {
-    const apiResponse = await (0, get_1.default)({
-        config: {
-            headers: {
-                'X-AUTH-TOKEN': global.deepcrawlApi.token,
-            },
+    const apiResponse = await (0, axios_1.get)(url, {
+        headers: {
+            "X-AUTH-TOKEN": global.deepcrawlApi.token,
         },
-        url,
     });
     return apiResponse;
 };
-exports.default = getData;
+exports.getData = getData;

package/lumar/api/index.d.ts

@@ -0,0 +1,36 @@
+export type Filter = {
+    field: string;
+    operand: string;
+    value: string;
+};
+export declare const operands: {
+    EQUALS: string;
+    CONTAINS: string;
+    LESS_THAN: string;
+    LESS_THAN_OR_EQUAL: string;
+    GREATER_THAN: string;
+    GREATER_THAN_OR_EQUAL: string;
+    REGEX: string;
+    NOT_REGEX: string;
+};
+export type Order = {
+    direction: string;
+    field: string;
+};
+export declare const orders: {
+    ASCENDING: string;
+    DESCENDING: string;
+};
+export declare const reports: {
+    CRAWL_STATISTICS: string;
+    CUSTOM: string;
+    LIST_PROJECTS: string;
+    LIST_CRAWLS: string;
+    LIST_REPORTS: string;
+    REPORT_ROWS: string;
+    REPORT_STATISTICS: string;
+    REPORT_SUMMARY: string;
+};
+export { buildRequest } from "./buildRequest";
+export { getData } from "./getData";
+export { initClient } from "./initClient";

package/lumar/api/index.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initClient = exports.getData = exports.buildRequest = exports.reports = exports.orders = exports.operands = void 0;
+exports.operands = {
+    EQUALS: 'eql',
+    CONTAINS: 'cont',
+    LESS_THAN: 'lt',
+    LESS_THAN_OR_EQUAL: 'lte',
+    GREATER_THAN: 'gt',
+    GREATER_THAN_OR_EQUAL: 'gte',
+    REGEX: 'rgx',
+    NOT_REGEX: 'nrgx',
+};
+exports.orders = {
+    ASCENDING: 'asc',
+    DESCENDING: 'desc',
+};
+exports.reports = {
+    CRAWL_STATISTICS: 'crawl_statistics',
+    CUSTOM: 'custom',
+    LIST_PROJECTS: 'list_projects',
+    LIST_CRAWLS: 'list_crawls',
+    LIST_REPORTS: 'list_reports',
+    REPORT_ROWS: 'report_rows',
+    REPORT_STATISTICS: 'report_statistics',
+    REPORT_SUMMARY: 'report_summary',
+};
+var buildRequest_1 = require("./buildRequest");
+Object.defineProperty(exports, "buildRequest", { enumerable: true, get: function () { return buildRequest_1.buildRequest; } });
+var getData_1 = require("./getData");
+Object.defineProperty(exports, "getData", { enumerable: true, get: function () { return getData_1.getData; } });
+var initClient_1 = require("./initClient");
+Object.defineProperty(exports, "initClient", { enumerable: true, get: function () { return initClient_1.initClient; } });

package/lumar/api/initClient.d.ts

@@ -1,13 +1,6 @@
-type InitClient = {
-    auth: {
-        apiId: string;
-        apiKey: string;
-    };
-};
 /**
  * http://api-docs.deepcrawl.com/
  * Renew the Lumar user token.
  * Token lasts for 6 hours.
  */
-declare const initClient: ({ auth }: InitClient) => Promise<void>;
-export default initClient;
+export declare const initClient: (apiId: string, apiKey: string) => Promise<any>;

package/lumar/api/initClient.js

@@ -1,38 +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 post_1 = __importDefault(require("../../axios/post"));
-global.lumarApi = {
-    token: null,
-    updatedAt: null,
-};
+exports.initClient = void 0;
+const axios_1 = require("../../axios");
+const lumarApis = new Map();
 /**
  * http://api-docs.deepcrawl.com/
  * Renew the Lumar user token.
  * Token lasts for 6 hours.
  */
-const initClient = async ({ auth }) => {
-    // todo: Or was more than 6 hours ago
-    if (null === global.lumarApi.token) {
-        const apiResponse = await (0, post_1.default)({
-            config: {
-                auth: {
-                    username: auth.apiId,
-                    password: auth.apiKey,
-                },
-            },
-            url: `https://api.deepcrawl.com/sessions`,
-        });
-        // Ensure the value exists
-        const token = apiResponse.getBodyDefaultTo({
-            defaultValue: null,
-            keys: ['token'],
-        });
-        if (token) {
-            global.lumarApi.token = token;
-        }
+const initClient = async (apiId, apiKey) => {
+    if (lumarApis.has(apiId)) {
+        return lumarApis.get(apiId);
     }
+    const apiResponse = await (0, axios_1.post)(`https://api.deepcrawl.com/sessions`, {
+        auth: {
+            username: apiId,
+            password: apiKey,
+        },
+    });
+    // Ensure the value exists
+    const token = apiResponse.getBodyDefaultTo(["token"], null);
+    lumarApis.set(apiId, token);
+    return token;
 };
-exports.default = initClient;
+exports.initClient = initClient;

package/lumar/graphql/columns.d.ts

@@ -1,4 +1,4 @@
-declare const columns: {
+export declare const columns: {
     CUSTOM_EXTRACTION_1: string;
     CUSTOM_EXTRACTION_2: string;
     DEEP_RANK: string;
@@ -26,4 +26,3 @@ declare const columns: {
     URL_TO: string;
     URL_TO_STATUS_CODE: string;
 };
-export default columns;

package/lumar/graphql/columns.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const columns = {
+exports.columns = void 0;
+exports.columns = {
     CUSTOM_EXTRACTION_1: 'customExtraction1',
     CUSTOM_EXTRACTION_2: 'customExtraction2',
     DEEP_RANK: 'deepRank',
@@ -28,4 +29,3 @@ const columns = {
     URL_TO: 'urlTo',
     URL_TO_STATUS_CODE: 'urlToStatusCode',
 };
-exports.default = columns;

package/lumar/graphql/getData.d.ts

@@ -1,9 +1 @@
-import ApiResponse from '../../api/ApiResponse';
-type GetData = {
-    query: string;
-    variables?: {
-        [key: string]: any;
-    };
-};
-declare const getData: ({ query, variables }: GetData) => Promise<ApiResponse>;
-export default getData;
+export declare const getData: (query: string, variables?: {}) => Promise<import("../../api").ApiResponseClass<any, any>>;

package/lumar/graphql/getData.js

@@ -1,26 +1,20 @@
 "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"));
-const getData = async ({ query, variables }) => {
+exports.getData = void 0;
+const axios_1 = require("../../axios");
+const getData = async (query, variables = {}) => {
     let queryClean = query.trim();
-    queryClean = queryClean.replace(/\n/g, ' ');
-    queryClean = queryClean.replace(/\t/g, ' ');
-    queryClean = queryClean.replace(/  /g, ' ');
-    const apiResponse = await (0, post_1.default)({
-        config: {
-            headers: {
-                'x-auth-token': global.lumarGraphql.token,
-            },
-        },
-        data: {
-            query: queryClean,
-            variables,
+    queryClean = queryClean.replace(/\n/g, " ");
+    queryClean = queryClean.replace(/\t/g, " ");
+    queryClean = queryClean.replace(/  /g, " ");
+    const apiResponse = await (0, axios_1.post)("https://api.lumar.io/graphql", {
+        query: queryClean,
+        variables,
+    }, {
+        headers: {
+            "x-auth-token": global.lumarGraphql.token,
         },
-        url: 'https://api.lumar.io/graphql',
     });
     return apiResponse;
 };
-exports.default = getData;
+exports.getData = getData;

package/lumar/graphql/index.d.ts

@@ -0,0 +1,29 @@
+export declare const operands: {
+    CONTAINS: string;
+    DOESNT_CONTAIN: string;
+    DOESNT_MATCH_REGEX: string;
+    ENDS_WITH: string;
+    EQUALS: string;
+    GREATER_THAN: string;
+    GREATER_THAN_OR_EQUAL: string;
+    IS_EMPTY: string;
+    LESS_THAN: string;
+    LESS_THAN_OR_EQUAL: string;
+    MATCHES_REGEX: string;
+    NOT_EQUALS: string;
+    STARTS_WITH: string;
+};
+export declare const reportTypes: {
+    ADDED: string;
+    BASIC: string;
+    MISSING: string;
+    REMOVED: string;
+};
+/**
+ * Shorthand function to return the report key.
+ */
+export declare const getReportKey: (templateCode: string, typeCode: string) => string;
+export { columns } from "./columns";
+export { reportTemplates } from "./reportTemplates";
+export { getData } from "./getData";
+export { initClient } from "./initClient";

package/lumar/graphql/index.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initClient = exports.getData = exports.reportTemplates = exports.columns = exports.getReportKey = exports.reportTypes = exports.operands = void 0;
+exports.operands = {
+    CONTAINS: "contains",
+    DOESNT_CONTAIN: "notContains",
+    DOESNT_MATCH_REGEX: "notMatchesRegex",
+    ENDS_WITH: "endsWith",
+    EQUALS: "eq",
+    GREATER_THAN: "gt",
+    GREATER_THAN_OR_EQUAL: "ge",
+    IS_EMPTY: "isEmpty",
+    LESS_THAN: "lt",
+    LESS_THAN_OR_EQUAL: "le",
+    MATCHES_REGEX: "matchesRegex",
+    NOT_EQUALS: "ne",
+    STARTS_WITH: "beginsWith",
+};
+exports.reportTypes = {
+    ADDED: "Added",
+    BASIC: "Basic",
+    MISSING: "Missing",
+    REMOVED: "Removed",
+};
+/**
+ * Shorthand function to return the report key.
+ */
+const getReportKey = (templateCode, typeCode) => {
+    return `${templateCode}-${typeCode}`.toLowerCase();
+};
+exports.getReportKey = getReportKey;
+var columns_1 = require("./columns");
+Object.defineProperty(exports, "columns", { enumerable: true, get: function () { return columns_1.columns; } });
+var reportTemplates_1 = require("./reportTemplates");
+Object.defineProperty(exports, "reportTemplates", { enumerable: true, get: function () { return reportTemplates_1.reportTemplates; } });
+var getData_1 = require("./getData");
+Object.defineProperty(exports, "getData", { enumerable: true, get: function () { return getData_1.getData; } });
+var initClient_1 = require("./initClient");
+Object.defineProperty(exports, "initClient", { enumerable: true, get: function () { return initClient_1.initClient; } });

package/lumar/graphql/initClient.d.ts

@@ -1,12 +1,5 @@
-type InitClient = {
-    auth: {
-        id: string;
-        secret: string;
-    };
-};
 /**
  * https://api-docs.lumar.io/graphql/explorer/
  * Renew the Lumar user token.
  */
-declare const initClient: ({ auth }: InitClient) => Promise<void>;
-export default initClient;
+export declare const initClient: (id: string, secret: string) => Promise<any>;

package/lumar/graphql/initClient.js

@@ -1,38 +1,25 @@
 "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"));
-// Initialise
-global.lumarGraphql = {
-    token: null,
-    updatedAt: null,
-};
+exports.initClient = void 0;
+const axios_1 = require("../../axios");
+const lumarGraphQls = new Map();
 /**
  * https://api-docs.lumar.io/graphql/explorer/
  * Renew the Lumar user token.
  */
-const initClient = async ({ auth }) => {
-    if (null === global.lumarGraphql.token) {
-        const apiResponse = await (0, post_1.default)({
-            data: {
-                query: "mutation LoginWithUserKey($secret: String!, $userKeyId: ObjectID!) {  createSessionUsingUserKey(input: {userKeyId: $userKeyId, secret: $secret}) {    token  }}",
-                variables: {
-                    userKeyId: auth.id,
-                    secret: auth.secret,
-                },
-            },
-            url: `https://api.lumar.io/graphql`,
-        });
-        const token = apiResponse.getBodyDefaultTo({
-            defaultValue: null,
-            keys: ['data', 'createSessionUsingUserKey', 'token'],
-        });
-        // Ensure the value exists
-        if (token) {
-            global.lumarGraphql.token = token;
-        }
+const initClient = async (id, secret) => {
+    if (lumarGraphQls.has(id)) {
+        return lumarGraphQls.get(id);
     }
+    const apiResponse = await (0, axios_1.post)(`https://api.lumar.io/graphql`, {
+        query: "mutation LoginWithUserKey($secret: String!, $userKeyId: ObjectID!) {  createSessionUsingUserKey(input: {userKeyId: $userKeyId, secret: $secret}) {    token  }}",
+        variables: {
+            userKeyId: id,
+            secret: secret,
+        },
+    });
+    const token = apiResponse.getBodyDefaultTo(["data", "createSessionUsingUserKey", "token"], null);
+    lumarGraphQls.set(id, token);
+    return token;
 };
-exports.default = initClient;
+exports.initClient = initClient;

package/lumar/graphql/queries/getReportDifferences.js

@@ -1,9 +1,6 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const reportTypes_1 = __importDefault(require("../reportTypes"));
+const __1 = require("../");
 /**
  * Used to return the number for: Basic, Added, Missing, Removed for a given report.
  */
@@ -33,7 +30,7 @@ const getReportDifferences = ({ crawlId, filter, reportTemplateCode }) => ({
         input: {
             crawlId,
             reportTemplateCode,
-            reportTypeCode: reportTypes_1.default.BASIC,
+            reportTypeCode: __1.reportTypes.BASIC,
         },
     },
 });

package/lumar/graphql/reportTemplates.d.ts

@@ -1,4 +1,4 @@
-declare const reportTemplates: {
+export declare const reportTemplates: {
     "200_PAGES": string;
     "301_REDIRECTS": string;
     "4XX_ERRORS": string;
@@ -65,4 +65,3 @@ declare const reportTemplates: {
     UNIQUE_INTERNAL_LINKS: string;
     XML_SITEMAPS: string;
 };
-export default reportTemplates;

package/lumar/graphql/reportTemplates.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const reportTemplates = {
+exports.reportTemplates = void 0;
+exports.reportTemplates = {
     "200_PAGES": "200_pages",
     "301_REDIRECTS": "301_redirects",
     "4XX_ERRORS": "4xx_errors",
@@ -67,4 +68,3 @@ const reportTemplates = {
     UNIQUE_INTERNAL_LINKS: 'unique_internal_links',
     XML_SITEMAPS: 'xml_sitemaps',
 };
-exports.default = reportTemplates;

package/myTarget/request.d.ts

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

package/myTarget/request.js

@@ -1,23 +1,17 @@
 "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"));
+exports.request = void 0;
+const axios_1 = require("../axios");
 /**
  * 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",
-            },
+const request = async (data, url) => {
+    const response = await (0, axios_1.post)(url, data, {
+        headers: {
+            Authorization: `Bearer ${global.myTargetAccessToken}`,
+            "Content-Type": "application/json",
         },
-        data: data,
-        url: url,
     });
     return response;
 };
-exports.default = request;
+exports.request = request;

package/nextAuth/index.d.ts

@@ -1,4 +1,5 @@
-export declare enum State {
+export { isSessionReady } from "./isSessionReady";
+export declare enum NextAuthState {
     AUTHENTICATED = "authenticated",
     PENDING = "loading",// Defined by NextAuth
     UNAUTHENTICATED = "unauthenticated"

package/nextAuth/index.js

@@ -1,9 +1,11 @@
 "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 = {}));
+exports.NextAuthState = exports.isSessionReady = void 0;
+var isSessionReady_1 = require("./isSessionReady");
+Object.defineProperty(exports, "isSessionReady", { enumerable: true, get: function () { return isSessionReady_1.isSessionReady; } });
+var NextAuthState;
+(function (NextAuthState) {
+    NextAuthState["AUTHENTICATED"] = "authenticated";
+    NextAuthState["PENDING"] = "loading";
+    NextAuthState["UNAUTHENTICATED"] = "unauthenticated";
+})(NextAuthState || (exports.NextAuthState = NextAuthState = {}));

package/nextAuth/isSessionReady.d.ts

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

package/nextAuth/isSessionReady.js

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

package/nextJs/getIp.d.ts

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

package/nextJs/getIp.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getIp = void 0;
 /**
  * Get the user's remote IP Address
  */
@@ -10,4 +11,4 @@ const getIp = ({ req }) => {
     }
     return response;
 };
-exports.default = getIp;
+exports.getIp = getIp;

package/nextJs/getUserAgent.d.ts

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

package/nextJs/getUserAgent.js

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

package/nextJs/index.d.ts

@@ -0,0 +1,2 @@
+export { getIp } from "./getIp";
+export { getUserAgent } from "./getUserAgent";

package/nextJs/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserAgent = exports.getIp = void 0;
+var getIp_1 = require("./getIp");
+Object.defineProperty(exports, "getIp", { enumerable: true, get: function () { return getIp_1.getIp; } });
+var getUserAgent_1 = require("./getUserAgent");
+Object.defineProperty(exports, "getUserAgent", { enumerable: true, get: function () { return getUserAgent_1.getUserAgent; } });

package/number/format.d.ts

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

package/number/format.js

@@ -1,23 +1,20 @@
 "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"));
+exports.format = void 0;
+const getNumber_1 = 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)
+    const minDp = props?.minDp ?? 0;
+    const maxDp = props?.maxDp ?? 2;
+    const compact = props?.compact || false;
+    const inputValue = (0, getNumber_1.getNumber)(props.input);
+    return Intl.NumberFormat(props?.locale || "en-GB", {
+        minimumFractionDigits: minDp,
+        maximumFractionDigits: maxDp,
+        notation: compact ? "compact" : "standard",
+    })
         .format(inputValue);
 };
-exports.default = format;
+exports.format = format;