@8ms/helpers 1.40.6 → 1.40.10

package/lumar/graphql/getData.js

@@ -0,0 +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"));
+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,
+        },
+        url: 'https://api.lumar.io/graphql',
+    });
+    return apiResponse;
+};
+exports.default = getData;

package/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/lumar/graphql/getReportKey.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Shorthand function to return the report key.
+ */
+const getReportKey = ({ templateCode, typeCode }) => {
+    return `${templateCode}-${typeCode}`.toLowerCase();
+};
+exports.default = getReportKey;

package/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/lumar/graphql/initClient.js

@@ -0,0 +1,38 @@
+"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,
+};
+/**
+ * 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;
+        }
+    }
+};
+exports.default = initClient;

package/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/lumar/graphql/operands.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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',
+};
+exports.default = operands;

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

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

package/lumar/graphql/queries/crawl.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/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/lumar/graphql/queries/getCrawls.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * 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,
+    },
+});
+exports.default = getCrawls;

package/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/lumar/graphql/queries/getReportDifferences.js

@@ -0,0 +1,40 @@
+"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"));
+/**
+ * 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_1.default.BASIC,
+        },
+    },
+});
+exports.default = getReportDifferences;

package/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/lumar/graphql/queries/getRows.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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,
+    },
+});
+exports.default = getRows;

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

package/lumar/graphql/queries/getTotals.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const getTotals = ({ crawlId, filter, filterKey, reportTemplateCode, reportTypeCode }) => ({
+    id: `get-totals-${crawlId}-${reportTemplateCode}-${reportTypeCode}`.toLowerCase(),
+    crawlId,
+    filter,
+    filterKey,
+    query: `
+	query GetTotals($input: GetReportInputType!, $filter: JSONObject) {
+	  getReport(input: $input) {
+	    rawID
+	    reportTemplateCode
+	    reportTypeCode
+	    totalRows
+	    id
+		diffReportTotals(includeSelf: true, filter: $filter) {
+			totalRows
+			reportTypeCode
+			__typename
+		}
+	    rows(
+	      filter: $filter
+	    ) {
+	      totalCount
+	    }
+	  }
+	}
+	`,
+    reportTemplateCode,
+    reportTypeCode,
+    variables: {
+        filter,
+        input: {
+            crawlId,
+            reportTemplateCode,
+            reportTypeCode,
+        },
+    },
+});
+exports.default = getTotals;

package/lumar/graphql/queries/row.d.ts

@@ -0,0 +1,157 @@
+type RedirectChain = {
+    "isMetaRedirect": boolean;
+    "redirectsTo": null | string;
+    "result": string;
+    "statusCode": string;
+    "url": string;
+};
+export type Row = {
+    "canonicalLinksInCount": number;
+    "canonicalUrlIsConsistent": boolean;
+    "canonicalizedPage": boolean;
+    "contentHtmlRatio": string;
+    "contentSize": number;
+    "crawlDatetime": string;
+    "css": boolean;
+    "customExtractionMatch": boolean;
+    "customExtraction1": any[];
+    "customExtraction2": any[];
+    "deeprank": number;
+    "description": string;
+    "descriptionLengthPx": number;
+    "descriptionLength": number;
+    "disallowedPage": boolean;
+    "duplicateBodyCount": number;
+    "duplicateBodyNonIndexable": boolean;
+    "duplicateBody": boolean;
+    "duplicateDescriptionCount": number;
+    "duplicateDescriptionNonIndexable": boolean;
+    "duplicateDescriptionPrimaryUrl": string;
+    "duplicateDescription": boolean;
+    "duplicatePageCount": number;
+    "duplicatePageNonIndexable": boolean;
+    "duplicatePage": boolean;
+    "duplicateTitleCount": number;
+    "duplicateTitleNonIndexable": boolean;
+    "duplicateTitlePrimaryUrl": string;
+    "duplicateTitle": boolean;
+    "encodingHeader": string;
+    "externalLinksCount": number;
+    "fetchTime": string;
+    "folderCount": number;
+    "followedExternalLinksOutCount": number;
+    "followedLinksInCount": number;
+    "foundAtUrl": string;
+    "foundInBacklinks": boolean;
+    "foundInGoogleAnalytics": boolean;
+    "foundInGoogleSearchConsole": boolean;
+    "foundInList": boolean;
+    "foundInLogSummary": boolean;
+    "foundInSitemap": boolean;
+    "foundInWebCrawl": boolean;
+    "h1Count": number;
+    "h1Length": number;
+    "headerContentType": string;
+    "headerNoarchive": boolean;
+    "headerNofollow": boolean;
+    "headerNoindex": boolean;
+    "headerNoodp": boolean;
+    "headerNosnippet": boolean;
+    "headerNoydir": boolean;
+    "hreflangLinksInCount": number;
+    "hreflangLinksOutCount": number;
+    "hreflangOnHeader": boolean;
+    "hreflangOnPage": boolean;
+    "hreflangOnSitemap": boolean;
+    "hreflangUrlCount": number;
+    "hsts": string;
+    "htmlSize": number;
+    "httpStatusCode": number;
+    "https": boolean;
+    "indexable": boolean;
+    "internalLinksCount": number;
+    "internal": boolean;
+    "isImage": boolean;
+    "isRedirectLoop": boolean;
+    "isRedirect": boolean;
+    "isSelfCanonical": boolean;
+    "js": boolean;
+    "level": number;
+    "linksInCount": number;
+    "linksOutCount": number;
+    "metaDisabledSitelinks": boolean;
+    "metaNoarchive": boolean;
+    "metaNofollow": boolean;
+    "metaNoindex": boolean;
+    "metaNoodp": boolean;
+    "metaNosnippet": boolean;
+    "metaNoydir": boolean;
+    "metaRedirect": boolean;
+    "mobileDesktopContentMismatch": boolean;
+    "mobileRelAlternateUrlIsConsistent": boolean;
+    "mobileRelAlternate": boolean;
+    "mobileRelAmphtml": boolean;
+    "newsarticleAuthorSchemaValue": string;
+    "noarchive": boolean;
+    "nofollowedPage": boolean;
+    "noindex": boolean;
+    "noodp": boolean;
+    "nosnippet": boolean;
+    "noydir": boolean;
+    "page1": boolean;
+    "pageTitle": string;
+    "pageTitleLengthPx": number;
+    "pageTitleLength": number;
+    "paginatedPage": boolean;
+    "productAvailabilitySchemaValue": string;
+    "productBrandSchemaValue": string;
+    "productSkuSchemaValue": string;
+    "primaryPage": boolean;
+    "primaryUrlFrom": string;
+    "primaryUrlFromStatusCode": string;
+    "paramCount": number;
+    "path0": string;
+    "path1": string;
+    "path2": string;
+    "path3": string;
+    "pathCount": number;
+    "performanceCls"?: number;
+    "performanceDcl"?: number;
+    "performanceFcp"?: number;
+    "performanceLcp"?: number;
+    "performanceTtfb"?: number;
+    "performanceTti"?: number;
+    "previousPath": string;
+    "previousPathDigest": string;
+    "rawHeader": {
+        [key: string]: string;
+    };
+    "redirectChain": RedirectChain[];
+    "redirectCount": number;
+    "redirectedToStatusCode": number;
+    "redirectedToUrlDigest": string;
+    "redirectedToUrl": string;
+    "redirectsInCount": number;
+    "relLinksInCount": number;
+    "relNextUrlIsConsistent": boolean;
+    "relPrevUrlIsConsistent": boolean;
+    "responsive": boolean;
+    "robotsNoindex": boolean;
+    "secureFormInputField": boolean;
+    "separateDesktop": boolean;
+    "separateMobile": boolean;
+    "sitemapsInCount": number;
+    "sourceUrl": string;
+    "urlAliasDigest": string;
+    "urlAlias": string;
+    "urlDigest": string;
+    "urlLength": number;
+    "url": string;
+    "urlCount": number;
+    "urlTo": string;
+    "urlToStatusCode": number;
+    "validTwitterCard": boolean;
+    "varyUserAgent": boolean;
+    "wordCount": number;
+};
+export {};

package/lumar/graphql/queries/row.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lumar/graphql/reportTemplates.d.ts

@@ -0,0 +1,68 @@
+declare const reportTemplates: {
+    "200_PAGES": string;
+    "301_REDIRECTS": string;
+    "4XX_ERRORS": string;
+    "5XX_ERRORS": string;
+    ALL_PAGES: string;
+    BROKEN_EXTERNAL_LINKS: string;
+    BROKEN_INTERNAL_LINKS: string;
+    BROKEN_SITEMAP_PAGES: string;
+    CANONICAL_CONFLICTING: string;
+    CANONICAL_NON_200: string;
+    CANONICAL_NON_INDEXABLE: string;
+    CANONICAL_ORPHANED: string;
+    CUSTOM_EXTRACTION_1: string;
+    CUSTOM_EXTRACTION_2: string;
+    DUPLICATE_CONTENT: string;
+    DUPLICATE_DESCRIPTIONS: string;
+    DUPLICATE_TITLES: string;
+    EMPTY_PAGES: string;
+    INDEXABLE_PAGES: string;
+    LINKED_DOMAINS: string;
+    MAX_DESCRIPTIONS: string;
+    MAX_MOBILE_DESCRIPTIONS: string;
+    MAX_TITLES: string;
+    MISSING_DESCRIPTIONS: string;
+    MISSING_TITLES: string;
+    NON_301_REDIRECTS: string;
+    NON_INDEXABLE_PAGES: string;
+    NON_INDEXABLE_SITEMAP_PAGES: string;
+    ORPHANED_CANONICAL: string;
+    ORPHANED_ANALYTICS_PAGES: string;
+    ORPHANED_SEARCH_CONSOLE_PAGES: string;
+    ORPHANED_SITEMAP_PAGES: string;
+    PAGES_WITH_HIGH_EXTERNAL_LINKS: string;
+    PERFORMANCE_MAX_FETCH_TIME: string;
+    PERFORMANCE_POOR_CLS: string;
+    PERFORMANCE_SLOW_DCL: string;
+    PERFORMANCE_SLOW_FCP: string;
+    PERFORMANCE_SLOW_LCP: string;
+    PERFORMANCE_SLOW_TTFB: string;
+    PERFORMANCE_SLOW_TTI: string;
+    PRIMARY_PAGES: string;
+    REDIRECTS_BROKEN: string;
+    REDIRECTS_CHAIN: string;
+    REDIRECTS_LOOP: string;
+    SCHEMA_BREADCRUMB: string;
+    SCHEMA_EVENT: string;
+    SCHEMA_FAQ: string;
+    SCHEMA_HOW_TO: string;
+    SCHEMA_NEWS_ARTICLE: string;
+    SCHEMA_PRODUCT: string;
+    SCHEMA_QA: string;
+    SCHEMA_RECIPE: string;
+    SCHEMA_REVIEW: string;
+    SCHEMA_VIDEO: string;
+    SHORT_DESCRIPTIONS: string;
+    SHORT_TITLES: string;
+    SITEMAP_PAGES: string;
+    SITEMAPS_NON_INDEXABLE_PAGES: string;
+    SITEMAPS_ORPHANED_PAGES: string;
+    SITEMAPS_MISSING_PAGES: string;
+    THIN_PAGES: string;
+    TRUE_UNIQUE_PAGES: string;
+    UNIQUE_EXTERNAL_LINKS: string;
+    UNIQUE_INTERNAL_LINKS: string;
+    XML_SITEMAPS: string;
+};
+export default reportTemplates;