@8ms/helpers 2.2.26 → 2.3.3

package/littleWarden/server/littleWarden.d.ts

@@ -0,0 +1,30 @@
+import { LittleWardenNamespace } from "./LittleWardenNamespace";
+export type LittleWardenConfig = {
+    apiKey: string;
+};
+export declare const littleWardenClient: (key?: string, config?: LittleWardenConfig, vaultId?: string, itemId?: string) => Promise<LittleWardenNamespace>;
+export declare const littleWardenState: {
+    readonly ALL_GOOD: "all_good";
+    readonly DANGER: "danger";
+    readonly WARNING: "warning";
+};
+export type LittleWardenState = typeof littleWardenState[keyof typeof littleWardenState];
+/**
+ * Check if the field is All Good.
+ */
+export declare const isAllGood: ({ field }: {
+    field: any;
+}) => boolean;
+/**
+ * Check if the field is Warning.
+ */
+export declare const isWarning: ({ field }: {
+    field: any;
+}) => boolean;
+/**
+ * Check if the field is Danger.
+ */
+export declare const isDanger: ({ field }: {
+    field: any;
+}) => boolean;
+export * from "./getUrlStatus";

package/littleWarden/server/littleWarden.js

@@ -0,0 +1,65 @@
+import { LittleWardenNamespace } from "./LittleWardenNamespace";
+import { onePasswordClient } from "../../onePassword/server";
+const littleWardenNamespaces = new Map();
+export const littleWardenClient = async (key = "default", config, vaultId, itemId) => {
+    if (littleWardenNamespaces.has(key)) {
+        return littleWardenNamespaces.get(key);
+    }
+    let instanceConfig;
+    if (config) {
+        instanceConfig = config;
+    }
+    else if (vaultId && itemId) {
+        instanceConfig = await (await onePasswordClient())
+            .getJsonNote(vaultId, itemId);
+    }
+    else if (process.env.LITTLE_WARDEN_VAULT_ID && process.env.LITTLE_WARDEN_ITEM_ID) {
+        instanceConfig = await (await onePasswordClient())
+            .getJsonNote(process.env.LITTLE_WARDEN_VAULT_ID, process.env.LITTLE_WARDEN_ITEM_ID);
+    }
+    else {
+        throw new Error(`Config required for namespace '${key}'`);
+    }
+    const namespace = new LittleWardenNamespace(key, instanceConfig);
+    littleWardenNamespaces.set(key, namespace);
+    return namespace;
+};
+export const littleWardenState = {
+    ALL_GOOD: "all_good",
+    DANGER: "danger",
+    WARNING: "warning",
+};
+/**
+ * Check if the field is All Good.
+ */
+export const isAllGood = ({ field }) => {
+    let response = false;
+    // Check that the status field exists
+    if (undefined !== field && undefined !== field["status"]) {
+        response = littleWardenState.ALL_GOOD === field["status"];
+    }
+    return response;
+};
+/**
+ * Check if the field is Warning.
+ */
+export const isWarning = ({ field }) => {
+    let response = false;
+    // Check that the status field exists
+    if (undefined !== field && undefined !== field["status"]) {
+        response = littleWardenState.WARNING === field["status"];
+    }
+    return response;
+};
+/**
+ * Check if the field is Danger.
+ */
+export const isDanger = ({ field }) => {
+    let response = false;
+    // Check that the status field exists
+    if (undefined !== field && undefined !== field["status"]) {
+        response = littleWardenState.DANGER === field["status"];
+    }
+    return response;
+};
+export * from "./getUrlStatus";

package/lumar/api/server/buildRequest.d.ts

@@ -1,13 +1,13 @@
-import { Filter, Order } from "./";
+import { Filter, OrderRow, Report } from "./";
 export type BuildRequestProps = {
     crawlId?: number;
     customPath?: string;
     filters?: Filter[];
     limit?: number;
-    orders?: Order[];
+    orders?: OrderRow[];
     page?: number;
     projectId?: number;
-    report?: string;
+    report?: Report;
     subReport?: string;
 };
 export declare const buildRequest: (props: BuildRequestProps) => string;

package/lumar/api/server/buildRequest.js

@@ -1,4 +1,4 @@
-import { orders, reports } from "./";
+import { order, report } from "./";
 export const buildRequest = (props) => {
     let url = `https://api.deepcrawl.com/accounts/37204`;
     // Limit must be greater than 0 but also less than 200
@@ -15,35 +15,35 @@ export const buildRequest = (props) => {
         props.limit = 200;
     }
     // If a report other than List Crawls is selected, Crawl ID must be defined
-    if (undefined !== props.report && reports.LIST_CRAWLS !== props.report && undefined == props.crawlId) {
+    if (undefined !== props.report && report.LIST_CRAWLS !== props.report && undefined == props.crawlId) {
         throw `Crawl ID must be defined.`;
     }
     switch (props.report) {
-        case reports.LIST_CRAWLS:
+        case report.LIST_CRAWLS:
             url += `/projects/${props.projectId}/crawls`;
             break;
-        case reports.LIST_PROJECTS:
+        case report.LIST_PROJECTS:
             url += `/projects`;
             break;
-        case reports.CUSTOM:
+        case report.CUSTOM:
             url += props.customPath;
             url = url.replace("[PROJECT]", props.projectId.toString());
             url = url.replace("[CRAWL]", props.crawlId.toString());
             break;
-        case reports.CRAWL_STATISTICS:
+        case report.CRAWL_STATISTICS:
             url += `/projects/${props.projectId}/crawls/${props.crawlId}/statistics`;
             break;
-        case reports.LIST_REPORTS:
+        case report.LIST_REPORTS:
             url += `/projects/${props.projectId}/crawls/${props.crawlId}/reports`;
             break;
-        case reports.REPORT_ROWS:
-        case reports.REPORT_STATISTICS:
-        case reports.REPORT_SUMMARY:
+        case report.REPORT_ROWS:
+        case report.REPORT_STATISTICS:
+        case report.REPORT_SUMMARY:
             url += `/projects/${props.projectId}/crawls/${props.crawlId}/reports/${props.subReport}`;
-            if (reports.REPORT_ROWS === props.report) {
+            if (report.REPORT_ROWS === props.report) {
                 url += `/report_rows`;
             }
-            else if (reports.REPORT_STATISTICS === props.report) {
+            else if (report.REPORT_STATISTICS === props.report) {
                 url += `/statistics`;
             }
             break;
@@ -66,10 +66,10 @@ export const buildRequest = (props) => {
     // Order the data
     if (undefined !== props.orders) {
         url += -1 === url.indexOf("?") ? "?" : "&";
-        props.orders.map((order, index) => {
+        props.orders.map((orderRow, index) => {
             url += 0 === index ? "sort=" : ",";
-            url += orders.DESCENDING === order.direction ? "-" : "";
-            url += order.field;
+            url += order.DESCENDING === orderRow.direction ? "-" : "";
+            url += orderRow.field;
         });
     }
     return url;

package/lumar/api/server/index.d.ts

@@ -1,36 +1,4 @@
-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 * from "./lumarApi";
 export * from "./buildRequest";
 export * from "./getData";
 export * from "./initClient";

package/lumar/api/server/index.js

@@ -1,27 +1,4 @@
-export 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 const orders = {
-    ASCENDING: 'asc',
-    DESCENDING: 'desc',
-};
-export 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 * from "./lumarApi";
 export * from "./buildRequest";
 export * from "./getData";
 export * from "./initClient";

package/lumar/api/server/lumarApi.d.ts

@@ -0,0 +1,36 @@
+export type Filter = {
+    field: string;
+    operand: string;
+    value: string;
+};
+export declare const operand: {
+    readonly EQUALS: "eql";
+    readonly CONTAINS: "cont";
+    readonly LESS_THAN: "lt";
+    readonly LESS_THAN_OR_EQUAL: "lte";
+    readonly GREATER_THAN: "gt";
+    readonly GREATER_THAN_OR_EQUAL: "gte";
+    readonly REGEX: "rgx";
+    readonly NOT_REGEX: "nrgx";
+};
+export type Operand = typeof operand[keyof typeof operand];
+export declare const order: {
+    readonly ASCENDING: "asc";
+    readonly DESCENDING: "desc";
+};
+export type Order = typeof order[keyof typeof order];
+export type OrderRow = {
+    direction: Order;
+    field: string;
+};
+export declare const report: {
+    readonly CRAWL_STATISTICS: "crawl_statistics";
+    readonly CUSTOM: "custom";
+    readonly LIST_PROJECTS: "list_projects";
+    readonly LIST_CRAWLS: "list_crawls";
+    readonly LIST_REPORTS: "list_reports";
+    readonly REPORT_ROWS: "report_rows";
+    readonly REPORT_STATISTICS: "report_statistics";
+    readonly REPORT_SUMMARY: "report_summary";
+};
+export type Report = typeof report[keyof typeof report];

package/lumar/api/server/lumarApi.js

@@ -0,0 +1,24 @@
+export const operand = {
+    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 const order = {
+    ASCENDING: 'asc',
+    DESCENDING: 'desc',
+};
+export const report = {
+    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',
+};

package/lumar/graphql/server/columns.d.ts

@@ -1,28 +1,29 @@
-export 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 declare const column: {
+    readonly CUSTOM_EXTRACTION_1: "customExtraction1";
+    readonly CUSTOM_EXTRACTION_2: "customExtraction2";
+    readonly DEEP_RANK: "deepRank";
+    readonly DESCRIPTION: "description";
+    readonly DUPLICATE_PAGE: "duplicatePage";
+    readonly DUPLICATE_DESCRIPTION_FROM: "duplicateDescriptionPrimaryUrl";
+    readonly DUPLICATE_TITLE_FROM: "duplicateTitlePrimaryUrl";
+    readonly FOUND_AT_URL: "foundAtUrl";
+    readonly FOUND_IN_CRAWL: "foundInWebCrawl";
+    readonly FOUND_IN_SEARCH_CONSOLE: "foundInGoogleSearchConsole";
+    readonly FOUND_IN_SITEMAP: "foundInSitemap";
+    readonly LEVEL: "level";
+    readonly PAGE_TITLE: "pageTitle";
+    readonly PRIMARY_PAGE: "primaryPage";
+    readonly PRIMARY_URL_FROM: "primaryUrlFrom";
+    readonly PRIMARY_URL_FROM_STATUS_CODE: "primaryUrlFromStatusCode";
+    readonly REDIRECTED_TO_URL: "redirectedToUrl";
+    readonly REDIRECTED_TO_STATUS_CODE: "redirectedToStatusCode";
+    readonly REDIRECTION_CHAIN: "redirectionChain";
+    readonly SOURCE_URL: "sourceUrl";
+    readonly STATUS_CODE: "httpStatusCode";
+    readonly TARGET_STATUS_CODE: "targetStatusCode";
+    readonly URL: "url";
+    readonly URL_COUNT: "urlCount";
+    readonly URL_TO: "urlTo";
+    readonly URL_TO_STATUS_CODE: "urlToStatusCode";
 };
+export type Column = typeof column[keyof typeof column];

package/lumar/graphql/server/columns.js

@@ -1,4 +1,4 @@
-export const columns = {
+export const column = {
     CUSTOM_EXTRACTION_1: 'customExtraction1',
     CUSTOM_EXTRACTION_2: 'customExtraction2',
     DEEP_RANK: 'deepRank',

package/lumar/graphql/server/getData.js

@@ -4,7 +4,7 @@ export const getData = async (query, variables, accessToken) => {
     queryClean = queryClean.replace(/\n/g, " ");
     queryClean = queryClean.replace(/\t/g, " ");
     queryClean = queryClean.replace(/  /g, " ");
-    const apiResponse = await post("https://api.lumar.io/graphql", {
+    return await post("https://api.lumar.io/graphql", {
         query: queryClean,
         variables,
     }, {
@@ -12,5 +12,4 @@ export const getData = async (query, variables, accessToken) => {
             "x-auth-token": accessToken,
         },
     });
-    return apiResponse;
 };

package/lumar/graphql/server/index.d.ts

@@ -1,29 +1,11 @@
-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";
+export * from "./lumarGraphql";
+export * from "./columns";
+export * from "./getData";
+export * from "./initClient";
+export * from "./reportTemplates";
+export * from "./queries/crawl";
+export * from "./queries/getCrawls";
+export * from "./queries/getReportDifferences";
+export * from "./queries/getRows";
+export * from "./queries/getTotals";
+export * from "./queries/row";

package/lumar/graphql/server/index.js

@@ -1,31 +1,11 @@
-export 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 const reportTypes = {
-    ADDED: "Added",
-    BASIC: "Basic",
-    MISSING: "Missing",
-    REMOVED: "Removed",
-};
-/**
- * Shorthand function to return the report key.
- */
-export const getReportKey = (templateCode, typeCode) => {
-    return `${templateCode}-${typeCode}`.toLowerCase();
-};
-export { columns } from "./columns";
-export { reportTemplates } from "./reportTemplates";
-export { getData } from "./getData";
-export { initClient } from "./initClient";
+export * from "./lumarGraphql";
+export * from "./columns";
+export * from "./getData";
+export * from "./initClient";
+export * from "./reportTemplates";
+export * from "./queries/crawl";
+export * from "./queries/getCrawls";
+export * from "./queries/getReportDifferences";
+export * from "./queries/getRows";
+export * from "./queries/getTotals";
+export * from "./queries/row";

package/lumar/graphql/server/lumarGraphql.d.ts

@@ -0,0 +1,27 @@
+export declare const operand: {
+    readonly CONTAINS: "contains";
+    readonly DOESNT_CONTAIN: "notContains";
+    readonly DOESNT_MATCH_REGEX: "notMatchesRegex";
+    readonly ENDS_WITH: "endsWith";
+    readonly EQUALS: "eq";
+    readonly GREATER_THAN: "gt";
+    readonly GREATER_THAN_OR_EQUAL: "ge";
+    readonly IS_EMPTY: "isEmpty";
+    readonly LESS_THAN: "lt";
+    readonly LESS_THAN_OR_EQUAL: "le";
+    readonly MATCHES_REGEX: "matchesRegex";
+    readonly NOT_EQUALS: "ne";
+    readonly STARTS_WITH: "beginsWith";
+};
+export type Operand = typeof operand[keyof typeof operand];
+export declare const reportType: {
+    readonly ADDED: "Added";
+    readonly BASIC: "Basic";
+    readonly MISSING: "Missing";
+    readonly REMOVED: "Removed";
+};
+export type ReportType = typeof reportType[keyof typeof reportType];
+/**
+ * Shorthand function to return the report key.
+ */
+export declare const getReportKey: (templateCode: string, typeCode: string) => string;

package/lumar/graphql/server/lumarGraphql.js

@@ -0,0 +1,27 @@
+export const operand = {
+    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 const reportType = {
+    ADDED: "Added",
+    BASIC: "Basic",
+    MISSING: "Missing",
+    REMOVED: "Removed",
+};
+/**
+ * Shorthand function to return the report key.
+ */
+export const getReportKey = (templateCode, typeCode) => {
+    return `${templateCode}-${typeCode}`.toLowerCase();
+};

package/lumar/graphql/server/queries/getReportDifferences.d.ts

@@ -17,7 +17,7 @@ declare const getReportDifferences: ({ crawlId, filter, reportTemplateCode }: Ge
         input: {
             crawlId: number;
             reportTemplateCode: string;
-            reportTypeCode: string;
+            reportTypeCode: "Basic";
         };
     };
 };

package/lumar/graphql/server/queries/getReportDifferences.js

@@ -1,4 +1,4 @@
-import { reportTypes } from "../";
+import { reportType } from "../";
 /**
  * Used to return the number for: Basic, Added, Missing, Removed for a given report.
  */
@@ -28,7 +28,7 @@ const getReportDifferences = ({ crawlId, filter, reportTemplateCode }) => ({
         input: {
             crawlId,
             reportTemplateCode,
-            reportTypeCode: reportTypes.BASIC,
+            reportTypeCode: reportType.BASIC,
         },
     },
 });