@8ms/helpers 1.41.0 → 1.42.0

package/dist/esm/lumar/api/buildRequest.js

@@ -0,0 +1,78 @@
+import reports from './reports';
+import ordersConstants from './orders';
+const buildRequest = ({ crawlId, customPath, filters, limit, orders, page, projectId, report, subReport, }) => {
+    let url = `https://api.deepcrawl.com/accounts/37204`;
+    // Limit must be greater than 0 but also less than 200
+    if (undefined !== limit) {
+        if (limit > 200) {
+            throw `Maximum row limit is 200.`;
+        }
+        else if (0 === limit) {
+            throw `Row limit must be greater than 0.`;
+        }
+    }
+    // Set limit to 200 by default
+    else {
+        limit = 200;
+    }
+    // If a report other than List Crawls is selected, Crawl ID must be defined
+    if (undefined !== report && reports.LIST_CRAWLS !== report && undefined == crawlId) {
+        throw `Crawl ID must be defined.`;
+    }
+    switch (report) {
+        case reports.LIST_CRAWLS:
+            url += `/projects/${projectId}/crawls`;
+            break;
+        case reports.LIST_PROJECTS:
+            url += `/projects`;
+            break;
+        case reports.CUSTOM:
+            url += customPath;
+            url = url.replace('[PROJECT]', projectId.toString());
+            url = url.replace('[CRAWL]', crawlId.toString());
+            break;
+        case reports.CRAWL_STATISTICS:
+            url += `/projects/${projectId}/crawls/${crawlId}/statistics`;
+            break;
+        case reports.LIST_REPORTS:
+            url += `/projects/${projectId}/crawls/${crawlId}/reports`;
+            break;
+        case reports.REPORT_ROWS:
+        case reports.REPORT_STATISTICS:
+        case reports.REPORT_SUMMARY:
+            url += `/projects/${projectId}/crawls/${crawlId}/reports/${subReport}`;
+            if (reports.REPORT_ROWS === report) {
+                url += `/report_rows`;
+            }
+            else if (reports.REPORT_STATISTICS === report) {
+                url += `/statistics`;
+            }
+            break;
+    }
+    // Specify the limit
+    url += -1 === url.indexOf('?') ? '?' : '&';
+    url += `per_page=${limit}`;
+    // Set the page number
+    if (undefined !== page) {
+        url += -1 === url.indexOf('?') ? '?' : '&';
+        url += `page=${page}`;
+    }
+    // Apply any filters
+    if (undefined !== filters) {
+        filters.map(filter => {
+            url += -1 === url.indexOf('?') ? '?' : '&';
+            url += `q[${filter.field}_${filter.operand}]=${filter.value}`;
+        });
+    }
+    // Order the data
+    if (undefined !== orders) {
+        url += -1 === url.indexOf('?') ? '?' : '&';
+        orders.map((order, index) => {
+            url += 0 === index ? 'sort=' : ',';
+            url += ordersConstants.DESCENDING === order.direction ? '-' : '';
+            url += order.field;
+        });
+    }
+    return url;
+};
+export default buildRequest;

package/dist/esm/lumar/api/filter.d.ts

@@ -0,0 +1,5 @@
+export type Filter = {
+    field: string;
+    operand: string;
+    value: string;
+};

package/dist/esm/lumar/api/filter.js

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

package/dist/esm/lumar/api/getData.d.ts

@@ -0,0 +1,6 @@
+import ApiResponse from '../../api/ApiResponse';
+type GetData = {
+    url: string;
+};
+declare const getData: ({ url }: GetData) => Promise<ApiResponse>;
+export default getData;

package/dist/esm/lumar/api/getData.js

@@ -0,0 +1,13 @@
+import get from '../../axios/get';
+const getData = async ({ url }) => {
+    const apiResponse = await get({
+        config: {
+            headers: {
+                'X-AUTH-TOKEN': global.deepcrawlApi.token,
+            },
+        },
+        url,
+    });
+    return apiResponse;
+};
+export default getData;

package/dist/esm/lumar/api/initClient.d.ts

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

package/dist/esm/lumar/api/initClient.js

@@ -0,0 +1,33 @@
+import post from '../../axios/post';
+global.lumarApi = {
+    token: null,
+    updatedAt: null,
+};
+/**
+ * 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 post({
+            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;
+        }
+    }
+};
+export default initClient;

package/dist/esm/lumar/api/operands.d.ts

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

package/dist/esm/lumar/api/operands.js

@@ -0,0 +1,11 @@
+const 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',
+};
+export default operands;

package/dist/esm/lumar/api/orders.d.ts

@@ -0,0 +1,9 @@
+export type Order = {
+    direction: string;
+    field: string;
+};
+declare const orders: {
+    ASCENDING: string;
+    DESCENDING: string;
+};
+export default orders;

package/dist/esm/lumar/api/orders.js

@@ -0,0 +1,5 @@
+const orders = {
+    ASCENDING: 'asc',
+    DESCENDING: 'desc',
+};
+export default orders;

package/dist/esm/lumar/api/reports.d.ts

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

package/dist/esm/lumar/api/reports.js

@@ -0,0 +1,11 @@
+const 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',
+};
+export default reports;

package/dist/esm/lumar/graphql/columns.d.ts

@@ -0,0 +1,29 @@
+declare const columns: {
+    CUSTOM_EXTRACTION_1: string;
+    CUSTOM_EXTRACTION_2: string;
+    DEEP_RANK: string;
+    DESCRIPTION: string;
+    DUPLICATE_PAGE: string;
+    DUPLICATE_DESCRIPTION_FROM: string;
+    DUPLICATE_TITLE_FROM: string;
+    FOUND_AT_URL: string;
+    FOUND_IN_CRAWL: string;
+    FOUND_IN_SEARCH_CONSOLE: string;
+    FOUND_IN_SITEMAP: string;
+    LEVEL: string;
+    PAGE_TITLE: string;
+    PRIMARY_PAGE: string;
+    PRIMARY_URL_FROM: string;
+    PRIMARY_URL_FROM_STATUS_CODE: string;
+    REDIRECTED_TO_URL: string;
+    REDIRECTED_TO_STATUS_CODE: string;
+    REDIRECTION_CHAIN: string;
+    SOURCE_URL: string;
+    STATUS_CODE: string;
+    TARGET_STATUS_CODE: string;
+    URL: string;
+    URL_COUNT: string;
+    URL_TO: string;
+    URL_TO_STATUS_CODE: string;
+};
+export default columns;

package/dist/esm/lumar/graphql/columns.js

@@ -0,0 +1,29 @@
+const columns = {
+    CUSTOM_EXTRACTION_1: 'customExtraction1',
+    CUSTOM_EXTRACTION_2: 'customExtraction2',
+    DEEP_RANK: 'deepRank',
+    DESCRIPTION: 'description',
+    DUPLICATE_PAGE: 'duplicatePage',
+    DUPLICATE_DESCRIPTION_FROM: 'duplicateDescriptionPrimaryUrl',
+    DUPLICATE_TITLE_FROM: 'duplicateTitlePrimaryUrl',
+    FOUND_AT_URL: 'foundAtUrl',
+    FOUND_IN_CRAWL: 'foundInWebCrawl',
+    FOUND_IN_SEARCH_CONSOLE: 'foundInGoogleSearchConsole',
+    FOUND_IN_SITEMAP: 'foundInSitemap',
+    LEVEL: 'level',
+    PAGE_TITLE: 'pageTitle',
+    PRIMARY_PAGE: 'primaryPage',
+    PRIMARY_URL_FROM: 'primaryUrlFrom',
+    PRIMARY_URL_FROM_STATUS_CODE: 'primaryUrlFromStatusCode',
+    REDIRECTED_TO_URL: 'redirectedToUrl',
+    REDIRECTED_TO_STATUS_CODE: 'redirectedToStatusCode',
+    REDIRECTION_CHAIN: 'redirectionChain',
+    SOURCE_URL: 'sourceUrl',
+    STATUS_CODE: 'httpStatusCode',
+    TARGET_STATUS_CODE: 'targetStatusCode',
+    URL: 'url',
+    URL_COUNT: 'urlCount',
+    URL_TO: 'urlTo',
+    URL_TO_STATUS_CODE: 'urlToStatusCode',
+};
+export default columns;

package/dist/esm/lumar/graphql/getData.d.ts

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

package/dist/esm/lumar/graphql/getData.js

@@ -0,0 +1,21 @@
+import post from '../../axios/post';
+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 post({
+        config: {
+            headers: {
+                'x-auth-token': global.lumarGraphql.token,
+            },
+        },
+        data: {
+            query: queryClean,
+            variables,
+        },
+        url: 'https://api.lumar.io/graphql',
+    });
+    return apiResponse;
+};
+export default getData;

package/dist/esm/lumar/graphql/getReportKey.d.ts

@@ -0,0 +1,9 @@
+type GetReportKey = {
+    templateCode: string;
+    typeCode: string;
+};
+/**
+ * Shorthand function to return the report key.
+ */
+declare const getReportKey: ({ templateCode, typeCode }: GetReportKey) => string;
+export default getReportKey;

package/dist/esm/lumar/graphql/getReportKey.js

@@ -0,0 +1,7 @@
+/**
+ * Shorthand function to return the report key.
+ */
+const getReportKey = ({ templateCode, typeCode }) => {
+    return `${templateCode}-${typeCode}`.toLowerCase();
+};
+export default getReportKey;

package/dist/esm/lumar/graphql/initClient.d.ts

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

package/dist/esm/lumar/graphql/initClient.js

@@ -0,0 +1,33 @@
+import post from '../../axios/post';
+// Initialise
+global.lumarGraphql = {
+    token: null,
+    updatedAt: null,
+};
+/**
+ * https://api-docs.lumar.io/graphql/explorer/
+ * Renew the Lumar user token.
+ */
+const initClient = async ({ auth }) => {
+    if (null === global.lumarGraphql.token) {
+        const apiResponse = await post({
+            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;
+        }
+    }
+};
+export default initClient;

package/dist/esm/lumar/graphql/operands.d.ts

@@ -0,0 +1,16 @@
+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 default operands;

package/dist/esm/lumar/graphql/operands.js

@@ -0,0 +1,16 @@
+const 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',
+};
+export default operands;

package/dist/esm/lumar/graphql/queries/crawl.d.ts

@@ -0,0 +1,5 @@
+export type Crawl = {
+    finishedAt: string;
+    id: number;
+    status: string;
+};

package/dist/esm/lumar/graphql/queries/crawl.js

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

package/dist/esm/lumar/graphql/queries/getCrawls.d.ts

@@ -0,0 +1,18 @@
+type GetCrawls = {
+    first: number;
+    projectId: number;
+};
+/**
+ * For a given Project ID return all the crawls that were completed in descending order.
+ */
+declare const getCrawls: ({ first, projectId }: GetCrawls) => {
+    id: string;
+    first: number;
+    projectId: number;
+    query: string;
+    variables: {
+        first: number;
+        projectId: number;
+    };
+};
+export default getCrawls;

package/dist/esm/lumar/graphql/queries/getCrawls.js

@@ -0,0 +1,31 @@
+/**
+ * For a given Project ID return all the crawls that were completed in descending order.
+ */
+const getCrawls = ({ first, projectId }) => ({
+    id: `get-crawls-${projectId}`.toLowerCase(),
+    first,
+    projectId,
+    query: `
+	query GetCrawls($projectId: ObjectID!, $first: Int) {
+		getProject(id: $projectId) {
+			id
+            rawID
+			crawls(
+				first: $first
+				orderBy: [{field: finishedAt, direction: DESC}]
+			) {
+			nodes {
+				finishedAt
+				rawID
+				status
+				}
+			}
+		}
+	}
+	`,
+    variables: {
+        first,
+        projectId,
+    },
+});
+export default getCrawls;

package/dist/esm/lumar/graphql/queries/getReportDifferences.d.ts

@@ -0,0 +1,24 @@
+type GetReportDifferences = {
+    crawlId: number;
+    filter: object;
+    reportTemplateCode: string;
+};
+/**
+ * Used to return the number for: Basic, Added, Missing, Removed for a given report.
+ */
+declare const getReportDifferences: ({ crawlId, filter, reportTemplateCode }: GetReportDifferences) => {
+    id: string;
+    crawlId: number;
+    filter: object;
+    query: string;
+    reportTemplateCode: string;
+    variables: {
+        filter: object;
+        input: {
+            crawlId: number;
+            reportTemplateCode: string;
+            reportTypeCode: string;
+        };
+    };
+};
+export default getReportDifferences;

package/dist/esm/lumar/graphql/queries/getReportDifferences.js

@@ -0,0 +1,35 @@
+import reportTypes from '../reportTypes';
+/**
+ * Used to return the number for: Basic, Added, Missing, Removed for a given report.
+ */
+const getReportDifferences = ({ crawlId, filter, reportTemplateCode }) => ({
+    id: `get-report-differences-${crawlId}-${reportTemplateCode}`.toLowerCase(),
+    crawlId,
+    filter,
+    query: `
+	query GetReportDifferences($input: GetReportInputType!, $filter: JSONObject) {
+	  getReport(input: $input) {
+	    rawID
+	    reportTemplateCode
+	    reportTypeCode
+	    totalRows
+	    id
+		diffReportTotals(includeSelf: true, filter: $filter) {
+			totalRows
+			reportTypeCode
+			__typename
+		}
+	  }
+	}
+	`,
+    reportTemplateCode,
+    variables: {
+        filter,
+        input: {
+            crawlId,
+            reportTemplateCode,
+            reportTypeCode: reportTypes.BASIC,
+        },
+    },
+});
+export default getReportDifferences;

package/dist/esm/lumar/graphql/queries/getRows.d.ts

@@ -0,0 +1,38 @@
+type GetRows = {
+    after?: string;
+    before?: string;
+    crawlId: number;
+    first: number;
+    filter: object;
+    last: number;
+    orderBy?: object;
+    reportTemplateCode: string;
+    reportTypeCode: string;
+};
+declare const getRows: ({ after, before, crawlId, filter, first, last, orderBy, reportTemplateCode, reportTypeCode }: GetRows) => {
+    id: string;
+    after: string;
+    before: string;
+    crawlId: number;
+    filter: object;
+    first: number;
+    last: number;
+    orderBy: object;
+    query: string;
+    reportTemplateCode: string;
+    reportTypeCode: string;
+    variables: {
+        after: string;
+        before: string;
+        filter: object;
+        first: number;
+        input: {
+            crawlId: number;
+            reportTemplateCode: string;
+            reportTypeCode: string;
+        };
+        last: number;
+        orderBy: object;
+    };
+};
+export default getRows;

package/dist/esm/lumar/graphql/queries/getRows.js

@@ -0,0 +1,55 @@
+const getRows = ({ after, before, crawlId, filter, first, last, orderBy, reportTemplateCode, reportTypeCode }) => ({
+    id: `get-rows-${crawlId}-${reportTemplateCode}-${reportTypeCode}`.toLowerCase(),
+    after,
+    before,
+    crawlId,
+    filter,
+    first,
+    last,
+    orderBy,
+    query: `
+	query GetRows($input: GetReportInputType!, $orderBy: [JSONObject!], $filter: JSONObject, $first: Int, $after: String, $last: Int, $before: String) {
+	  getReport(input: $input) {
+	    totalRows
+	    rawID
+	    reportTemplateCode
+	    reportTypeCode
+	    id
+	    rowsWithAllMetrics(
+	      filter: $filter
+	      orderBy: $orderBy
+	      last: $last
+	      first: $first
+	      before: $before
+	      after: $after
+	    ) {
+	      __typename
+	      totalCount
+	      nodes
+          pageInfo {
+	        hasNextPage
+	        endCursor
+	        startCursor
+	        hasPreviousPage
+	      }
+	    }
+	  }
+	}
+	`,
+    reportTemplateCode,
+    reportTypeCode,
+    variables: {
+        after,
+        before,
+        filter,
+        first,
+        input: {
+            crawlId,
+            reportTemplateCode,
+            reportTypeCode,
+        },
+        last,
+        orderBy: orderBy || null,
+    },
+});
+export default getRows;

package/dist/esm/lumar/graphql/queries/getTotals.d.ts

@@ -0,0 +1,25 @@
+type GetTotals = {
+    crawlId: number;
+    filter: object;
+    filterKey?: string;
+    reportTemplateCode: string;
+    reportTypeCode: string;
+};
+declare const getTotals: ({ crawlId, filter, filterKey, reportTemplateCode, reportTypeCode }: GetTotals) => {
+    id: string;
+    crawlId: number;
+    filter: object;
+    filterKey: string;
+    query: string;
+    reportTemplateCode: string;
+    reportTypeCode: string;
+    variables: {
+        filter: object;
+        input: {
+            crawlId: number;
+            reportTemplateCode: string;
+            reportTypeCode: string;
+        };
+    };
+};
+export default getTotals;