@8ms/helpers 1.40.0 → 1.40.2

package/dist/littleWarden/isDanger.mjs

@@ -0,0 +1,12 @@
+import { State } from "./index.mjs";
+//#region src/littleWarden/isDanger.ts
+/**
+* Check if the field is Danger.
+*/
+const isDanger = ({ field }) => {
+	let response = false;
+	if (void 0 !== field && void 0 !== field["status"]) response = State.DANGER === field["status"];
+	return response;
+};
+//#endregion
+export { isDanger as default };

package/dist/littleWarden/isWarning.d.mts

@@ -0,0 +1,11 @@
+//#region src/littleWarden/isWarning.d.ts
+/**
+ * Check if the field is Warning.
+ */
+declare const isWarning: ({
+  field
+}: {
+  field: any;
+}) => boolean;
+//#endregion
+export { isWarning as default };

package/dist/littleWarden/isWarning.mjs

@@ -0,0 +1,12 @@
+import { State } from "./index.mjs";
+//#region src/littleWarden/isWarning.ts
+/**
+* Check if the field is Warning.
+*/
+const isWarning = ({ field }) => {
+	let response = false;
+	if (void 0 !== field && void 0 !== field["status"]) response = State.WARNING === field["status"];
+	return response;
+};
+//#endregion
+export { isWarning as default };

package/dist/lumar/api/buildRequest.d.mts

@@ -0,0 +1,28 @@
+import { Filter } from "./filter.mjs";
+import { Order } from "./orders.mjs";
+
+//#region src/lumar/api/buildRequest.d.ts
+type Request = {
+  crawlId?: number;
+  customPath?: string;
+  filters?: Filter[];
+  limit?: number;
+  orders?: Order[];
+  page?: number;
+  projectId?: number;
+  report?: string;
+  subReport?: string;
+};
+declare const buildRequest: ({
+  crawlId,
+  customPath,
+  filters,
+  limit,
+  orders,
+  page,
+  projectId,
+  report,
+  subReport
+}: Request) => string;
+//#endregion
+export { Request, buildRequest as default };

package/dist/lumar/api/buildRequest.mjs

@@ -0,0 +1,58 @@
+import reports from "./reports.mjs";
+import orders from "./orders.mjs";
+//#region src/lumar/api/buildRequest.ts
+const buildRequest = ({ crawlId, customPath, filters, limit, orders: orders$1, page, projectId, report, subReport }) => {
+	let url = `https://api.deepcrawl.com/accounts/37204`;
+	if (void 0 !== limit) {
+		if (limit > 200) throw `Maximum row limit is 200.`;
+		else if (0 === limit) throw `Row limit must be greater than 0.`;
+	} else limit = 200;
+	if (void 0 !== report && reports.LIST_CRAWLS !== report && void 0 == 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;
+	}
+	url += -1 === url.indexOf("?") ? "?" : "&";
+	url += `per_page=${limit}`;
+	if (void 0 !== page) {
+		url += -1 === url.indexOf("?") ? "?" : "&";
+		url += `page=${page}`;
+	}
+	if (void 0 !== filters) filters.map((filter) => {
+		url += -1 === url.indexOf("?") ? "?" : "&";
+		url += `q[${filter.field}_${filter.operand}]=${filter.value}`;
+	});
+	if (void 0 !== orders$1) {
+		url += -1 === url.indexOf("?") ? "?" : "&";
+		orders$1.map((order, index) => {
+			url += 0 === index ? "sort=" : ",";
+			url += orders.DESCENDING === order.direction ? "-" : "";
+			url += order.field;
+		});
+	}
+	return url;
+};
+//#endregion
+export { buildRequest as default };

package/dist/lumar/api/filter.d.mts

@@ -0,0 +1,8 @@
+//#region src/lumar/api/filter.d.ts
+type Filter = {
+  field: string;
+  operand: string;
+  value: string;
+};
+//#endregion
+export { Filter };

package/dist/lumar/api/filter.mjs

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

package/dist/lumar/api/getData.d.mts

@@ -0,0 +1,11 @@
+import ApiResponse from "../../api/ApiResponse.mjs";
+
+//#region src/lumar/api/getData.d.ts
+type GetData = {
+  url: string;
+};
+declare const getData: ({
+  url
+}: GetData) => Promise<ApiResponse>;
+//#endregion
+export { getData as default };

package/dist/lumar/api/getData.mjs

@@ -0,0 +1,10 @@
+import get from "../../axios/get.mjs";
+//#region src/lumar/api/getData.ts
+const getData = async ({ url }) => {
+	return await get({
+		config: { headers: { "X-AUTH-TOKEN": global.deepcrawlApi.token } },
+		url
+	});
+};
+//#endregion
+export { getData as default };

package/dist/lumar/api/initClient.d.mts

@@ -0,0 +1,17 @@
+//#region src/lumar/api/initClient.d.ts
+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>;
+//#endregion
+export { initClient as default };

package/dist/lumar/api/initClient.mjs

@@ -0,0 +1,28 @@
+import post from "../../axios/post.mjs";
+//#region src/lumar/api/initClient.ts
+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 }) => {
+	if (null === global.lumarApi.token) {
+		const token = (await post({
+			config: { auth: {
+				username: auth.apiId,
+				password: auth.apiKey
+			} },
+			url: `https://api.deepcrawl.com/sessions`
+		})).getBodyDefaultTo({
+			defaultValue: null,
+			keys: ["token"]
+		});
+		if (token) global.lumarApi.token = token;
+	}
+};
+//#endregion
+export { initClient as default };

package/dist/lumar/api/operands.d.mts

@@ -0,0 +1,13 @@
+//#region src/lumar/api/operands.d.ts
+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;
+};
+//#endregion
+export { operands as default };

package/dist/lumar/api/operands.mjs

@@ -0,0 +1,13 @@
+//#region src/lumar/api/operands.ts
+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"
+};
+//#endregion
+export { operands as default };

package/dist/lumar/api/orders.d.mts

@@ -0,0 +1,11 @@
+//#region src/lumar/api/orders.d.ts
+type Order = {
+  direction: string;
+  field: string;
+};
+declare const orders: {
+  ASCENDING: string;
+  DESCENDING: string;
+};
+//#endregion
+export { Order, orders as default };

package/dist/lumar/api/orders.mjs

@@ -0,0 +1,7 @@
+//#region src/lumar/api/orders.ts
+const orders = {
+	ASCENDING: "asc",
+	DESCENDING: "desc"
+};
+//#endregion
+export { orders as default };

package/dist/lumar/api/reports.d.mts

@@ -0,0 +1,13 @@
+//#region src/lumar/api/reports.d.ts
+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;
+};
+//#endregion
+export { reports as default };

package/dist/lumar/api/reports.mjs

@@ -0,0 +1,13 @@
+//#region src/lumar/api/reports.ts
+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"
+};
+//#endregion
+export { reports as default };

package/dist/lumar/graphql/columns.d.mts

@@ -0,0 +1,31 @@
+//#region src/lumar/graphql/columns.d.ts
+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;
+};
+//#endregion
+export { columns as default };

package/dist/lumar/graphql/columns.mjs

@@ -0,0 +1,31 @@
+//#region src/lumar/graphql/columns.ts
+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"
+};
+//#endregion
+export { columns as default };

package/dist/lumar/graphql/getData.d.mts

@@ -0,0 +1,15 @@
+import ApiResponse from "../../api/ApiResponse.mjs";
+
+//#region src/lumar/graphql/getData.d.ts
+type GetData = {
+  query: string;
+  variables?: {
+    [key: string]: any;
+  };
+};
+declare const getData: ({
+  query,
+  variables
+}: GetData) => Promise<ApiResponse>;
+//#endregion
+export { getData as default };

package/dist/lumar/graphql/getData.mjs

@@ -0,0 +1,18 @@
+import post from "../../axios/post.mjs";
+//#region src/lumar/graphql/getData.ts
+const getData = async ({ query, variables }) => {
+	let queryClean = query.trim();
+	queryClean = queryClean.replace(/\n/g, " ");
+	queryClean = queryClean.replace(/\t/g, " ");
+	queryClean = queryClean.replace(/  /g, " ");
+	return await post({
+		config: { headers: { "x-auth-token": global.lumarGraphql.token } },
+		data: {
+			query: queryClean,
+			variables
+		},
+		url: "https://api.lumar.io/graphql"
+	});
+};
+//#endregion
+export { getData as default };

package/dist/lumar/graphql/getReportKey.d.mts

@@ -0,0 +1,14 @@
+//#region src/lumar/graphql/getReportKey.d.ts
+type GetReportKey = {
+  templateCode: string;
+  typeCode: string;
+};
+/**
+ * Shorthand function to return the report key.
+ */
+declare const getReportKey: ({
+  templateCode,
+  typeCode
+}: GetReportKey) => string;
+//#endregion
+export { getReportKey as default };

package/dist/lumar/graphql/getReportKey.mjs

@@ -0,0 +1,9 @@
+//#region src/lumar/graphql/getReportKey.ts
+/**
+* Shorthand function to return the report key.
+*/
+const getReportKey = ({ templateCode, typeCode }) => {
+	return `${templateCode}-${typeCode}`.toLowerCase();
+};
+//#endregion
+export { getReportKey as default };

package/dist/lumar/graphql/initClient.d.mts

@@ -0,0 +1,16 @@
+//#region src/lumar/graphql/initClient.d.ts
+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>;
+//#endregion
+export { initClient as default };

package/dist/lumar/graphql/initClient.mjs

@@ -0,0 +1,34 @@
+import post from "../../axios/post.mjs";
+//#region src/lumar/graphql/initClient.ts
+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 token = (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`
+		})).getBodyDefaultTo({
+			defaultValue: null,
+			keys: [
+				"data",
+				"createSessionUsingUserKey",
+				"token"
+			]
+		});
+		if (token) global.lumarGraphql.token = token;
+	}
+};
+//#endregion
+export { initClient as default };

package/dist/lumar/graphql/operands.d.mts

@@ -0,0 +1,18 @@
+//#region src/lumar/graphql/operands.d.ts
+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;
+};
+//#endregion
+export { operands as default };

package/dist/lumar/graphql/operands.mjs

@@ -0,0 +1,18 @@
+//#region src/lumar/graphql/operands.ts
+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"
+};
+//#endregion
+export { operands as default };

package/dist/lumar/graphql/queries/crawl.d.mts

@@ -0,0 +1,8 @@
+//#region src/lumar/graphql/queries/crawl.d.ts
+type Crawl = {
+  finishedAt: string;
+  id: number;
+  status: string;
+};
+//#endregion
+export { Crawl };

package/dist/lumar/graphql/queries/crawl.mjs

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

package/dist/lumar/graphql/queries/getCrawls.d.mts

@@ -0,0 +1,23 @@
+//#region src/lumar/graphql/queries/getCrawls.d.ts
+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;
+  };
+};
+//#endregion
+export { getCrawls as default };

package/dist/lumar/graphql/queries/getCrawls.mjs

@@ -0,0 +1,33 @@
+//#region src/lumar/graphql/queries/getCrawls.ts
+/**
+* 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
+	}
+});
+//#endregion
+export { getCrawls as default };

package/dist/lumar/graphql/queries/getReportDifferences.d.mts

@@ -0,0 +1,30 @@
+//#region src/lumar/graphql/queries/getReportDifferences.d.ts
+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;
+    };
+  };
+};
+//#endregion
+export { getReportDifferences as default };

package/dist/lumar/graphql/queries/getReportDifferences.mjs

@@ -0,0 +1,37 @@
+import reportTypes from "../reportTypes.mjs";
+//#region src/lumar/graphql/queries/getReportDifferences.ts
+/**
+* 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
+		}
+	}
+});
+//#endregion
+export { getReportDifferences as default };