@8ms/helpers 1.40.0 → 1.40.1

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,159 @@
+//#region src/lumar/graphql/queries/row.d.ts
+type RedirectChain = {
+  "isMetaRedirect": boolean;
+  "redirectsTo": null | string;
+  "result": string;
+  "statusCode": string;
+  "url": string;
+};
+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;
+};
+//#endregion
+export { Row };

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

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

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

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

package/dist/lumar/graphql/reportTemplates.mjs

@@ -0,0 +1,70 @@
+//#region src/lumar/graphql/reportTemplates.ts
+const reportTemplates = {
+	"200_PAGES": "200_pages",
+	"301_REDIRECTS": "301_redirects",
+	"4XX_ERRORS": "4xx_errors",
+	"5XX_ERRORS": "5xx_errors",
+	ALL_PAGES: "all_pages",
+	BROKEN_EXTERNAL_LINKS: "broken_links_external",
+	BROKEN_INTERNAL_LINKS: "all_broken_links",
+	BROKEN_SITEMAP_PAGES: "broken_sitemap_links",
+	CANONICAL_CONFLICTING: "conflicting_canonical_tags",
+	CANONICAL_NON_200: "canonical_to_non_200",
+	CANONICAL_NON_INDEXABLE: "non_indexable_canonical_links_in",
+	CANONICAL_ORPHANED: "unlinked_canonical_pages",
+	CUSTOM_EXTRACTION_1: "custom_extraction_1",
+	CUSTOM_EXTRACTION_2: "custom_extraction_2",
+	DUPLICATE_CONTENT: "duplicate_body_content",
+	DUPLICATE_DESCRIPTIONS: "pages_with_duplicate_descriptions",
+	DUPLICATE_TITLES: "pages_with_duplicate_titles",
+	EMPTY_PAGES: "empty_pages",
+	INDEXABLE_PAGES: "indexable_pages",
+	LINKED_DOMAINS: "linked_domains",
+	MAX_DESCRIPTIONS: "max_description_length",
+	MAX_MOBILE_DESCRIPTIONS: "max_mobile_description_length",
+	MAX_TITLES: "max_title_length",
+	MISSING_DESCRIPTIONS: "missing_descriptions",
+	MISSING_TITLES: "missing_titles",
+	NON_301_REDIRECTS: "non_301_redirects",
+	NON_INDEXABLE_PAGES: "non_indexable_pages",
+	NON_INDEXABLE_SITEMAP_PAGES: "sitemaps_non_indexable_links",
+	ORPHANED_CANONICAL: "unlinked_canonical_pages",
+	ORPHANED_ANALYTICS_PAGES: "orphaned_organic_landing_pages",
+	ORPHANED_SEARCH_CONSOLE_PAGES: "orphaned_google_search_console_pages",
+	ORPHANED_SITEMAP_PAGES: "orphaned_sitemaps_pages",
+	PAGES_WITH_HIGH_EXTERNAL_LINKS: "max_external_links",
+	PERFORMANCE_MAX_FETCH_TIME: "max_load_time",
+	PERFORMANCE_POOR_CLS: "poor_cls",
+	PERFORMANCE_SLOW_DCL: "slow_dcl",
+	PERFORMANCE_SLOW_FCP: "slow_fcp",
+	PERFORMANCE_SLOW_LCP: "slow_lcp",
+	PERFORMANCE_SLOW_TTFB: "slow_server_response",
+	PERFORMANCE_SLOW_TTI: "slow_tti",
+	PRIMARY_PAGES: "unique_pages",
+	REDIRECTS_BROKEN: "all_broken_redirects",
+	REDIRECTS_CHAIN: "redirect_chains",
+	REDIRECTS_LOOP: "redirection_loop",
+	SCHEMA_BREADCRUMB: "pages_with_breadcrumb_schema",
+	SCHEMA_EVENT: "pages_with_event_schema",
+	SCHEMA_FAQ: "pages_with_faqpage_schema",
+	SCHEMA_HOW_TO: "pages_with_howto_schema",
+	SCHEMA_NEWS_ARTICLE: "pages_with_news_article_schema",
+	SCHEMA_PRODUCT: "pages_with_product_schema",
+	SCHEMA_QA: "pages_with_qapage_schema",
+	SCHEMA_RECIPE: "pages_with_recipe_schema",
+	SCHEMA_REVIEW: "pages_with_review_schema",
+	SCHEMA_VIDEO: "pages_with_videoobject_schema",
+	SHORT_DESCRIPTIONS: "short_descriptions",
+	SHORT_TITLES: "short_titles",
+	SITEMAP_PAGES: "all_sitemaps_links",
+	SITEMAPS_NON_INDEXABLE_PAGES: "sitemaps_non_indexable_links",
+	SITEMAPS_ORPHANED_PAGES: "orphaned_sitemaps_pages",
+	SITEMAPS_MISSING_PAGES: "not_in_sitemaps_primary_indexable",
+	THIN_PAGES: "thin_pages",
+	TRUE_UNIQUE_PAGES: "true_uniques",
+	UNIQUE_EXTERNAL_LINKS: "unique_external_links",
+	UNIQUE_INTERNAL_LINKS: "unique_internal_links",
+	XML_SITEMAPS: "xml_sitemaps"
+};
+//#endregion
+export { reportTemplates as default };

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

@@ -0,0 +1,9 @@
+//#region src/lumar/graphql/reportTypes.d.ts
+declare const reportTypes: {
+  ADDED: string;
+  BASIC: string;
+  MISSING: string;
+  REMOVED: string;
+};
+//#endregion
+export { reportTypes as default };

package/dist/lumar/graphql/reportTypes.mjs

@@ -0,0 +1,9 @@
+//#region src/lumar/graphql/reportTypes.ts
+const reportTypes = {
+	ADDED: "Added",
+	BASIC: "Basic",
+	MISSING: "Missing",
+	REMOVED: "Removed"
+};
+//#endregion
+export { reportTypes as default };

package/dist/myTarget/getAccessToken.d.mts

@@ -0,0 +1,14 @@
+//#region src/myTarget/getAccessToken.d.ts
+type GetAccessToken = {
+  force: boolean;
+  parameterName: string;
+};
+/**
+ * Retrieve the access token from SSM Parameter Store.
+ */
+declare const getAccessToken: ({
+  force,
+  parameterName
+}: GetAccessToken) => Promise<void>;
+//#endregion
+export { getAccessToken as default };

package/dist/myTarget/getAccessToken.mjs

@@ -0,0 +1,19 @@
+import getParameter from "../aws/ssm/getParameter.mjs";
+//#region src/myTarget/getAccessToken.ts
+global.myTargetAccessToken = null;
+/**
+* Retrieve the access token from SSM Parameter Store.
+*/
+const getAccessToken = async ({ force, parameterName }) => {
+	if (!global.myTargetAccessToken || force) {
+		const parameter = await getParameter({
+			name: parameterName,
+			withDecryption: true,
+			isJson: true
+		});
+		global.myTargetAccessToken = parameter.accessToken;
+	}
+	return global.myTargetAccessToken;
+};
+//#endregion
+export { getAccessToken as default };

package/dist/myTarget/request.d.mts

@@ -0,0 +1,15 @@
+import ApiResponse from "../api/ApiResponse.mjs";
+
+//#region src/myTarget/request.d.ts
+/**
+ * Make the request to MyTarget API using the access token.
+ */
+declare const request: ({
+  data,
+  url
+}: {
+  data: object;
+  url: string;
+}) => Promise<ApiResponse>;
+//#endregion
+export { request as default };

package/dist/myTarget/request.mjs

@@ -0,0 +1,17 @@
+import post from "../axios/post.mjs";
+//#region src/myTarget/request.ts
+/**
+* Make the request to MyTarget API using the access token.
+*/
+const request = async ({ data, url }) => {
+	return await post({
+		config: { headers: {
+			Authorization: `Bearer ${global.myTargetAccessToken}`,
+			"Content-Type": "application/json"
+		} },
+		data,
+		url
+	});
+};
+//#endregion
+export { request as default };

package/dist/nextAuth/isSessionReady.d.mts

@@ -0,0 +1,8 @@
+//#region src/nextAuth/isSessionReady.d.ts
+declare const isSessionReady: ({
+  session
+}: {
+  session: any;
+}) => boolean;
+//#endregion
+export { isSessionReady as default };

package/dist/nextAuth/isSessionReady.mjs

@@ -0,0 +1,10 @@
+//#region src/nextAuth/isSessionReady.ts
+const isSessionReady = ({ session }) => {
+	let response = false;
+	if (void 0 !== session && null !== session) {
+		if (void 0 !== session.user && null !== session.user) response = true;
+	}
+	return response;
+};
+//#endregion
+export { isSessionReady as default };

package/dist/nextJs/getIp.d.mts

@@ -0,0 +1,11 @@
+//#region src/nextJs/getIp.d.ts
+/**
+ * Get the user's remote IP Address
+ */
+declare const getIp: ({
+  req
+}: {
+  req: any;
+}) => string;
+//#endregion
+export { getIp as default };

package/dist/nextJs/getIp.mjs

@@ -0,0 +1,11 @@
+//#region src/nextJs/getIp.ts
+/**
+* Get the user's remote IP Address
+*/
+const getIp = ({ req }) => {
+	let response = "unset";
+	if (void 0 !== req.headers["x-real-ip"]) response = String(req.headers["x-real-ip"]);
+	return response;
+};
+//#endregion
+export { getIp as default };

package/dist/nextJs/getUserAgent.d.mts

@@ -0,0 +1,11 @@
+//#region src/nextJs/getUserAgent.d.ts
+/**
+ * Get the user's User Agent
+ */
+declare const getUserAgent: ({
+  req
+}: {
+  req: any;
+}) => string;
+//#endregion
+export { getUserAgent as default };

package/dist/nextJs/getUserAgent.mjs

@@ -0,0 +1,7 @@
+//#region src/nextJs/getUserAgent.ts
+/**
+* Get the user's User Agent
+*/
+const getUserAgent = ({ req }) => req.headers["user-agent"] || "unset";
+//#endregion
+export { getUserAgent as default };

package/dist/number/format.d.mts

@@ -0,0 +1,13 @@
+//#region src/number/format.d.ts
+type Format = {
+  compact?: boolean;
+  input: any;
+  minDp?: number;
+  maxDp?: number;
+};
+/**
+ * Take a given number and format it.
+ */
+declare const format: (props: Format) => string;
+//#endregion
+export { format as default };

package/dist/number/format.mjs

@@ -0,0 +1,16 @@
+import getNumber from "./getNumber.mjs";
+//#region src/number/format.ts
+/**
+* Take a given number and format it.
+*/
+const format = (props) => {
+	const inputValue = getNumber({ input: props.input });
+	const options = {
+		minimumFractionDigits: void 0 !== props?.minDp ? props?.minDp : 0,
+		maximumFractionDigits: void 0 !== props?.maxDp ? props?.maxDp : 2,
+		notation: true === props?.compact ? "compact" : "standard"
+	};
+	return Intl.NumberFormat("en-GB", options).format(inputValue);
+};
+//#endregion
+export { format as default };