@8ms/helpers 1.42.3 → 1.42.6

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.cjs

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

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

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

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.cjs

@@ -0,0 +1,19 @@
+const require_aws_ssm_getParameter = require("../aws/ssm/getParameter.cjs");
+//#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 require_aws_ssm_getParameter({
+			name: parameterName,
+			withDecryption: true,
+			isJson: true
+		});
+		global.myTargetAccessToken = parameter.accessToken;
+	}
+	return global.myTargetAccessToken;
+};
+//#endregion
+module.exports = getAccessToken;

package/dist/myTarget/getAccessToken.d.cts

@@ -0,0 +1,13 @@
+//#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>;
+export = getAccessToken;

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.cjs

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

package/dist/myTarget/request.d.cts

@@ -0,0 +1,14 @@
+import ApiResponse from "../api/ApiResponse.cjs";
+
+//#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>;
+export = request;

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/index.cjs

@@ -0,0 +1,10 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/nextAuth/index.ts
+let State = /* @__PURE__ */ function(State) {
+	State["AUTHENTICATED"] = "authenticated";
+	State["PENDING"] = "loading";
+	State["UNAUTHENTICATED"] = "unauthenticated";
+	return State;
+}({});
+//#endregion
+exports.State = State;

package/dist/nextAuth/index.d.cts

@@ -0,0 +1,9 @@
+//#region src/nextAuth/index.d.ts
+declare enum State {
+  AUTHENTICATED = "authenticated",
+  PENDING = "loading",
+  // Defined by NextAuth
+  UNAUTHENTICATED = "unauthenticated"
+}
+//#endregion
+export { State };

package/dist/nextAuth/index.d.mts

@@ -0,0 +1,9 @@
+//#region src/nextAuth/index.d.ts
+declare enum State {
+  AUTHENTICATED = "authenticated",
+  PENDING = "loading",
+  // Defined by NextAuth
+  UNAUTHENTICATED = "unauthenticated"
+}
+//#endregion
+export { State };

package/dist/nextAuth/index.mjs

@@ -0,0 +1,9 @@
+//#region src/nextAuth/index.ts
+let State = /* @__PURE__ */ function(State) {
+	State["AUTHENTICATED"] = "authenticated";
+	State["PENDING"] = "loading";
+	State["UNAUTHENTICATED"] = "unauthenticated";
+	return State;
+}({});
+//#endregion
+export { State };

package/dist/nextAuth/isSessionReady.cjs

@@ -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
+module.exports = isSessionReady;

package/dist/nextAuth/isSessionReady.d.cts

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

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.cjs

@@ -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
+module.exports = getIp;

package/dist/nextJs/getIp.d.cts

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

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.cjs

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

package/dist/nextJs/getUserAgent.d.cts

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

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/nextJs/tests/getIp.cjs

@@ -0,0 +1,9 @@
+const require_nextJs_getIp = require("../getIp.cjs");
+//#region src/nextJs/tests/getIp.ts
+test("getIp - Exists", () => {
+	expect(require_nextJs_getIp({ req: { headers: { "x-real-ip": "value" } } })).toBe("value");
+});
+test("getIp - Undefined", () => {
+	expect(require_nextJs_getIp({ req: { headers: {} } })).toBe("unset");
+});
+//#endregion

package/dist/nextJs/tests/getIp.d.cts

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

package/dist/nextJs/tests/getIp.d.mts

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

package/dist/nextJs/tests/getIp.mjs

@@ -0,0 +1,10 @@
+import getIp from "../getIp.mjs";
+//#region src/nextJs/tests/getIp.ts
+test("getIp - Exists", () => {
+	expect(getIp({ req: { headers: { "x-real-ip": "value" } } })).toBe("value");
+});
+test("getIp - Undefined", () => {
+	expect(getIp({ req: { headers: {} } })).toBe("unset");
+});
+//#endregion
+export {};

package/dist/number/format.cjs

@@ -0,0 +1,16 @@
+const require_number_getNumber = require("./getNumber.cjs");
+//#region src/number/format.ts
+/**
+* Take a given number and format it.
+*/
+const format = (props) => {
+	const inputValue = require_number_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
+module.exports = format;

package/dist/number/format.d.cts

@@ -0,0 +1,12 @@
+//#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;
+export = format;

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 };

package/dist/number/getCurrency.cjs

@@ -0,0 +1,17 @@
+//#region src/number/getCurrency.ts
+/**
+* Use the International number formatting to return the currency value.
+* https://www.freecodecamp.org/news/how-to-format-number-as-currency-in-javascript-one-line-of-code/
+*/
+const getCurrency = ({ currency, input }) => {
+	const value = Number(input);
+	const currencyClean = currency.toUpperCase().trim();
+	let formatted = new Intl.NumberFormat("en-GB", {
+		style: "currency",
+		currency: currencyClean
+	}).format(value);
+	if ("USD" === currencyClean) formatted = formatted.replace("US$", "$");
+	return formatted;
+};
+//#endregion
+module.exports = getCurrency;

package/dist/number/getCurrency.d.cts

@@ -0,0 +1,14 @@
+//#region src/number/getCurrency.d.ts
+type GetCurrency = {
+  currency: string;
+  input: any;
+};
+/**
+ * Use the International number formatting to return the currency value.
+ * https://www.freecodecamp.org/news/how-to-format-number-as-currency-in-javascript-one-line-of-code/
+ */
+declare const getCurrency: ({
+  currency,
+  input
+}: GetCurrency) => string;
+export = getCurrency;

package/dist/number/getCurrency.d.mts

@@ -0,0 +1,15 @@
+//#region src/number/getCurrency.d.ts
+type GetCurrency = {
+  currency: string;
+  input: any;
+};
+/**
+ * Use the International number formatting to return the currency value.
+ * https://www.freecodecamp.org/news/how-to-format-number-as-currency-in-javascript-one-line-of-code/
+ */
+declare const getCurrency: ({
+  currency,
+  input
+}: GetCurrency) => string;
+//#endregion
+export { getCurrency as default };

package/dist/number/getCurrency.mjs

@@ -0,0 +1,17 @@
+//#region src/number/getCurrency.ts
+/**
+* Use the International number formatting to return the currency value.
+* https://www.freecodecamp.org/news/how-to-format-number-as-currency-in-javascript-one-line-of-code/
+*/
+const getCurrency = ({ currency, input }) => {
+	const value = Number(input);
+	const currencyClean = currency.toUpperCase().trim();
+	let formatted = new Intl.NumberFormat("en-GB", {
+		style: "currency",
+		currency: currencyClean
+	}).format(value);
+	if ("USD" === currencyClean) formatted = formatted.replace("US$", "$");
+	return formatted;
+};
+//#endregion
+export { getCurrency as default };

package/dist/number/getDecimal.cjs

@@ -0,0 +1,11 @@
+const require_number_getNumber = require("./getNumber.cjs");
+//#region src/number/getDecimal.ts
+/**
+* Return a decimal number after rounding.
+*/
+const getDecimal = (props) => {
+	const number = require_number_getNumber({ input: props.input });
+	return Number(number.toFixed(props?.dp || 2));
+};
+//#endregion
+module.exports = getDecimal;

package/dist/number/getDecimal.d.cts

@@ -0,0 +1,10 @@
+//#region src/number/getDecimal.d.ts
+type GetDecimal = {
+  dp?: number;
+  input: any;
+};
+/**
+ * Return a decimal number after rounding.
+ */
+declare const getDecimal: (props: GetDecimal) => number;
+export = getDecimal;

package/dist/number/getDecimal.d.mts

@@ -0,0 +1,11 @@
+//#region src/number/getDecimal.d.ts
+type GetDecimal = {
+  dp?: number;
+  input: any;
+};
+/**
+ * Return a decimal number after rounding.
+ */
+declare const getDecimal: (props: GetDecimal) => number;
+//#endregion
+export { getDecimal as default };

package/dist/number/getDecimal.mjs

@@ -0,0 +1,11 @@
+import getNumber from "./getNumber.mjs";
+//#region src/number/getDecimal.ts
+/**
+* Return a decimal number after rounding.
+*/
+const getDecimal = (props) => {
+	const number = getNumber({ input: props.input });
+	return Number(number.toFixed(props?.dp || 2));
+};
+//#endregion
+export { getDecimal as default };