@8ms/helpers 1.40.0 → 1.40.2

package/dist/google/sheets/initClient.mjs

@@ -0,0 +1,21 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+import getConfig from "../getConfig.mjs";
+//#region src/google/sheets/initClient.ts
+global.googleSheetsClient = null;
+/**
+* Initialise the Google Sheets instance using the separate service method.
+* https://github.com/googleapis/google-api-nodejs-client
+* Library: @googleapis/sheets
+*/
+const initClient = ({ parameter }) => {
+	if (!global.googleSheetsClient) {
+		const googleApisSheets = __require("@googleapis/sheets");
+		const formattedConfig = getConfig({ parameter });
+		global.googleSheetsClient = new googleApisSheets.auth.GoogleAuth({
+			credentials: formattedConfig,
+			scopes: ["https://www.googleapis.com/auth/spreadsheets"]
+		});
+	}
+};
+//#endregion
+export { initClient as default };

package/dist/google/sheets/isCellNa.d.mts

@@ -0,0 +1,11 @@
+//#region src/google/sheets/isCellNa.d.ts
+/**
+ * Noticed sometimes Google Sheets can struggle with import XML resulting to N/A values.
+ */
+declare const isCellNa: ({
+  input
+}: {
+  input: any;
+}) => boolean;
+//#endregion
+export { isCellNa as default };

package/dist/google/sheets/isCellNa.mjs

@@ -0,0 +1,7 @@
+//#region src/google/sheets/isCellNa.ts
+/**
+* Noticed sometimes Google Sheets can struggle with import XML resulting to N/A values.
+*/
+const isCellNa = ({ input }) => "#N/A" === input;
+//#endregion
+export { isCellNa as default };

package/dist/google/storage/copyToCloud.d.mts

@@ -0,0 +1,18 @@
+//#region src/google/storage/copyToCloud.d.ts
+type CopyToCloud = {
+  bucket: string;
+  localFile: string;
+  options?: object;
+  projectId?: string;
+};
+/**
+ * Copy a local file to Google Cloud Storage.
+ */
+declare const copyToCloud: ({
+  bucket,
+  localFile,
+  options,
+  projectId
+}: CopyToCloud) => Promise<any>;
+//#endregion
+export { copyToCloud, copyToCloud as default };

package/dist/google/storage/copyToCloud.mjs

@@ -0,0 +1,10 @@
+import getClient from "./getClient.mjs";
+//#region src/google/storage/copyToCloud.ts
+/**
+* Copy a local file to Google Cloud Storage.
+*/
+const copyToCloud = async ({ bucket, localFile, options, projectId }) => {
+	return await getClient({ projectId }).bucket(bucket).upload(localFile, options);
+};
+//#endregion
+export { copyToCloud, copyToCloud as default };

package/dist/google/storage/getClient.d.mts

@@ -0,0 +1,12 @@
+//#region src/google/storage/getClient.d.ts
+type GetClient = {
+  projectId?: string;
+};
+/**
+ * Create a new client if the project id differs from the global.
+ */
+declare const getClient: ({
+  projectId
+}: GetClient) => any;
+//#endregion
+export { getClient as default };

package/dist/google/storage/getClient.mjs

@@ -0,0 +1,19 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+//#region src/google/storage/getClient.ts
+/**
+* Create a new client if the project id differs from the global.
+*/
+const getClient = ({ projectId }) => {
+	let client = global.googleStorageClient;
+	if (void 0 !== projectId && projectId !== global.googleStorageDefault.projectId) {
+		const { Storage } = __require("@google-cloud/storage");
+		client = new Storage({
+			credentials: global.googleStorageDefault.credentials,
+			location: "europe-west2",
+			projectId
+		});
+	}
+	return client;
+};
+//#endregion
+export { getClient as default };

package/dist/google/storage/initClient.d.mts

@@ -0,0 +1,18 @@
+import { Config } from "../getConfig.mjs";
+
+//#region src/google/storage/initClient.d.ts
+type InitClient = {
+  parameter: Config;
+  projectId: string;
+};
+/**
+ * Initialise the Google Sheets instance using the separate service method.
+ * https://github.com/googleapis/google-api-nodejs-client
+ * Library: @googleapis/sheets
+ */
+declare const initClient: ({
+  parameter,
+  projectId
+}: InitClient) => void;
+//#endregion
+export { initClient as default };

package/dist/google/storage/initClient.mjs

@@ -0,0 +1,27 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+import getConfig from "../getConfig.mjs";
+//#region src/google/storage/initClient.ts
+global.googleStorageDefault = {
+	credentials: null,
+	projectId: null
+};
+global.googleStorageClient = null;
+/**
+* Initialise the Google Sheets instance using the separate service method.
+* https://github.com/googleapis/google-api-nodejs-client
+* Library: @googleapis/sheets
+*/
+const initClient = ({ parameter, projectId }) => {
+	if (!global.googleStorageClient) {
+		const { Storage } = __require("@google-cloud/storage");
+		const formattedConfig = getConfig({ parameter });
+		global.googleStorageDefault.credentials = formattedConfig;
+		global.googleStorageDefault.projectId = projectId;
+		global.googleStorageClient = new Storage({
+			credentials: formattedConfig,
+			projectId
+		});
+	}
+};
+//#endregion
+export { initClient as default };

package/dist/google/storage/isFileExists.d.mts

@@ -0,0 +1,12 @@
+//#region src/google/storage/isFileExists.d.ts
+type IsFileExists = {
+  bucket: string;
+  key: string;
+  projectId?: string;
+};
+/**
+ * Check to see if a file exists but don't get the contents.
+ */
+declare const isFileExists: (props: IsFileExists) => Promise<boolean>;
+//#endregion
+export { isFileExists as default };

package/dist/google/storage/isFileExists.mjs

@@ -0,0 +1,11 @@
+import getClient from "./getClient.mjs";
+//#region src/google/storage/isFileExists.ts
+/**
+* Check to see if a file exists but don't get the contents.
+*/
+const isFileExists = async (props) => {
+	const { bucket, key, projectId } = props;
+	return (await getClient({ projectId }).bucket(bucket).file(key).exists())?.[0];
+};
+//#endregion
+export { isFileExists as default };

package/dist/google/storage/writeFile.d.mts

@@ -0,0 +1,13 @@
+//#region src/google/storage/writeFile.d.ts
+type WriteFile = {
+  bucket: string;
+  data: any;
+  key: string;
+  [options: string]: any;
+};
+/**
+ * Write a file to Google Cloud Storage.
+ */
+declare const writeFile: (props: WriteFile) => Promise<any>;
+//#endregion
+export { writeFile as default, writeFile };

package/dist/google/storage/writeFile.mjs

@@ -0,0 +1,28 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+import getClient from "./getClient.mjs";
+//#region src/google/storage/writeFile.ts
+/**
+* Write a file to Google Cloud Storage.
+*/
+const writeFile = async (props) => {
+	const { bucket, contentType, data, key, projectId, ...options } = props;
+	const dataStream = new (__require("stream")).PassThrough();
+	const googleFile = getClient({ projectId }).bucket(bucket).file(key);
+	dataStream.push(data);
+	dataStream.push(null);
+	return await new Promise((resolve, reject) => {
+		dataStream.pipe(googleFile.createWriteStream({
+			contentType: "auto",
+			resumable: false,
+			validation: false,
+			metadata: {},
+			...options
+		})).on("error", (error) => {
+			reject(error);
+		}).on("finish", () => {
+			resolve(true);
+		});
+	});
+};
+//#endregion
+export { writeFile as default, writeFile };

package/dist/googleAds/getCustomer.d.mts

@@ -0,0 +1,12 @@
+//#region src/googleAds/getCustomer.d.ts
+type GetCustomer = {
+  customerId: string;
+};
+/**
+ * Return the Google Ads Client with the specified customer set.
+ */
+declare const getCustomer: ({
+  customerId
+}: GetCustomer) => Promise<any>;
+//#endregion
+export { getCustomer as default };

package/dist/googleAds/getCustomer.mjs

@@ -0,0 +1,13 @@
+//#region src/googleAds/getCustomer.ts
+/**
+* Return the Google Ads Client with the specified customer set.
+*/
+const getCustomer = async ({ customerId }) => {
+	return global.googleAdsClient.instance.Customer({
+		customer_id: customerId,
+		login_customer_id: global.googleAdsClient.mccAccountId,
+		refresh_token: global.googleAdsClient.refreshToken
+	});
+};
+//#endregion
+export { getCustomer as default };

package/dist/googleAds/initClient.d.mts

@@ -0,0 +1,20 @@
+//#region src/googleAds/initClient.d.ts
+type GoogleAdsParameter = {
+  clientId: string;
+  clientSecret: string;
+  developerToken: string;
+  mccAccountId: string;
+  refreshToken: string;
+};
+type InitClient = {
+  parameter: GoogleAdsParameter;
+};
+/**
+ * Shorthand function to get the Google Ads Client.
+ * Library: google-ads-api
+ */
+declare const initClient: ({
+  parameter
+}: InitClient) => Promise<void>;
+//#endregion
+export { GoogleAdsParameter, initClient as default };

package/dist/googleAds/initClient.mjs

@@ -0,0 +1,25 @@
+import { t as __require } from "../chunk-y_GBKt04.mjs";
+//#region src/googleAds/initClient.ts
+global.googleAdsClient = {
+	instance: null,
+	mccAccountId: "",
+	refreshToken: ""
+};
+/**
+* Shorthand function to get the Google Ads Client.
+* Library: google-ads-api
+*/
+const initClient = async ({ parameter }) => {
+	if (!global.googleAdsClient.instance) {
+		const { GoogleAdsApi } = __require("google-ads-api");
+		global.googleAdsClient.instance = new GoogleAdsApi({
+			client_id: parameter.clientId,
+			client_secret: parameter.clientSecret,
+			developer_token: parameter.developerToken
+		});
+		global.googleAdsClient.mccAccountId = parameter.mccAccountId;
+		global.googleAdsClient.refreshToken = parameter.refreshToken;
+	}
+};
+//#endregion
+export { initClient as default };

package/dist/googleAds/keywordPlanner/request.d.mts

@@ -0,0 +1,21 @@
+import { Country, Month, Network } from "./index.mjs";
+
+//#region src/googleAds/keywordPlanner/request.d.ts
+type Request = {
+  countries?: Country[] | null;
+  customerId?: string;
+  historicalMetricsOptions?: {
+    startMonth: Month;
+    startYear: number;
+    endMonth: Month;
+    endYear: number;
+  };
+  includeAdultKeywords?: boolean;
+  keywordPlanNetwork?: Network;
+  queries?: string[];
+  language?: number | null;
+  url?: string;
+};
+declare const request: Request;
+//#endregion
+export { Request, request as default };

package/dist/googleAds/keywordPlanner/request.mjs

@@ -0,0 +1,13 @@
+import { Network } from "./index.mjs";
+//#region src/googleAds/keywordPlanner/request.ts
+const request = {
+	countries: [],
+	customerId: "",
+	historicalMetricsOptions: null,
+	includeAdultKeywords: false,
+	keywordPlanNetwork: Network.GOOGLE_SEARCH_ONLY,
+	queries: [],
+	language: null
+};
+//#endregion
+export { request as default };

package/dist/googleAds/keywordPlanner/response.d.mts

@@ -0,0 +1,28 @@
+import { t as State } from "../../index-gGQBTUJU.mjs";
+
+//#region src/googleAds/keywordPlanner/response.d.ts
+type Month = {
+  date: string;
+  month: number;
+  searchVolume: number;
+  year: number;
+};
+type Keyword = {
+  payload: object;
+  keyword: string;
+  avgCpc: number;
+  avgSearchVolume: number;
+  competition: number;
+  competitionIndex: number;
+  months: Month[];
+  topOfPageBidHigh: number;
+  topOfPageBidLow: number;
+  totalSearchVolume: number;
+};
+type Response = {
+  body: Keyword[];
+  error: null | string;
+  state: State;
+};
+//#endregion
+export { Response };

package/dist/googleAds/keywordPlanner/response.mjs

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

package/dist/index-CiGy7MyK.d.mts

@@ -0,0 +1,58 @@
+//#region src/date/index.d.ts
+/**
+ * A date can be either a number (YYYYMMDD), string (YYYY-MM-DD) or Date instance.
+ */
+type DateType = number | string | Date;
+/**
+ * When a date isn't specified and we need a value.
+ */
+declare const defaultDate = "1901-01-01";
+/**
+ * When a date time isn't specified and we need a value.
+ */
+declare const defaultDateTime = "1901-01-01 00:00:00";
+type Duration = {
+  hours: number;
+  minutes: number;
+  seconds: number;
+};
+declare enum DurationComparison {
+  VS_NOW = "VS_NOW",
+  VS_MIDNIGHT = "VS_MIDNIGHT"
+}
+declare enum Interval {
+  FOREVER = "FOREVER",
+  MONTHS = "MONTHS",
+  DAYS = "DAYS",
+  HOURS = "HOURS",
+  MINUTES = "MINUTES"
+}
+type FinancialYear = {
+  end: Date;
+  start: Date;
+};
+type FinancialYearWeekType = {
+  end: Date;
+  financialWeek: number;
+  financialYear: number;
+  start: Date;
+};
+/**
+ * A timeframe has a start and an end date.
+ */
+type Timeframe = {
+  end: DateType;
+  start: DateType;
+};
+declare enum Timeframes {
+  CURRENT = "CURRENT",
+  COMPARISON = "COMPARISON"
+}
+declare enum PredefinedTimeframe {
+  NONE = "NONE",
+  CUSTOM = "CUSTOM",
+  THIS_WEEK = "THIS_WEEK",
+  LAST_WEEK = "LAST_WEEK"
+}
+//#endregion
+export { FinancialYearWeekType as a, Timeframe as c, defaultDateTime as d, FinancialYear as i, Timeframes as l, Duration as n, Interval as o, DurationComparison as r, PredefinedTimeframe as s, DateType as t, defaultDate as u };

package/dist/index-gGQBTUJU.d.mts

@@ -0,0 +1,12 @@
+//#region src/api/index.d.ts
+declare enum State {
+  CANCELLED = "CANCELLED",
+  ERROR = "ERROR",
+  IDLE = "IDLE",
+  PENDING = "PENDING",
+  SUCCESS = "SUCCESS",
+  VALIDATION_ERROR = "VALIDATION_ERROR"
+}
+declare const unexpectedError: string;
+//#endregion
+export { unexpectedError as n, State as t };

package/dist/initClients.d.mts

@@ -0,0 +1,46 @@
+import { Config } from "./aws/getConfig.mjs";
+
+//#region src/initClients.d.ts
+type InitClients = {
+  athenaExpress?: {
+    database: string;
+    s3Bucket: string;
+    s3Key: string;
+  };
+  awsConfig?: Config;
+  awsEc2?: boolean;
+  awsEcs?: boolean;
+  awsGlue?: boolean;
+  awsLambda?: boolean;
+  awsS3?: boolean;
+  awsSes?: boolean;
+  awsSsm?: boolean;
+  lumarApi?: {
+    parameterName: string;
+  };
+  lumarGraphql?: {
+    parameterName: string;
+  };
+  eskimi?: boolean;
+  googleAds?: {
+    parameterName: string;
+  };
+  googleConfig?: {
+    parameterName: string;
+    projectId: string;
+  };
+  googleBigQuery?: boolean;
+  googleSheets?: boolean;
+  googleStorage?: boolean;
+  prisma?: {
+    debug?: boolean;
+    planetScale?: boolean;
+  };
+  myTarget?: boolean;
+};
+/**
+ * Function to simplify initialising the clients.
+ */
+declare const initClients: (props: InitClients) => Promise<void>;
+//#endregion
+export { initClients as default };

package/dist/initClients.mjs

@@ -0,0 +1,56 @@
+import initClient from "./aws/athenaExpress/initClient.mjs";
+import { initClient as initClient$1 } from "./aws/ec2/initClient.mjs";
+import { initClient as initClient$2 } from "./aws/ecs/initClient.mjs";
+import initClient$3 from "./aws/glue/initClient.mjs";
+import initClient$4 from "./aws/lambda/initClient.mjs";
+import initClient$5 from "./aws/s3/initClient.mjs";
+import initClient$6 from "./aws/ses/initClient.mjs";
+import getParameter from "./aws/ssm/getParameter.mjs";
+import initClient$7 from "./aws/ssm/initClient.mjs";
+import initClient$8 from "./lumar/api/initClient.mjs";
+import initClient$9 from "./lumar/graphql/initClient.mjs";
+import initClient$10 from "./google/bigQuery/initClient.mjs";
+import initClient$11 from "./google/sheets/initClient.mjs";
+import initClient$12 from "./google/storage/initClient.mjs";
+import initClient$13 from "./googleAds/initClient.mjs";
+import initClient$14 from "./prisma/initClient.mjs";
+//#region src/initClients.ts
+/**
+* Function to simplify initialising the clients.
+*/
+const initClients = async (props) => {
+	if (props?.athenaExpress) initClient({
+		config: props.awsConfig,
+		database: props.athenaExpress.database,
+		s3Bucket: props.athenaExpress.s3Bucket,
+		s3Key: props.athenaExpress.s3Key
+	});
+	if (props?.awsEc2) initClient$1({ config: props.awsConfig });
+	if (props?.awsEcs) initClient$2({ config: props.awsConfig });
+	if (props?.awsGlue) initClient$3({ config: props.awsConfig });
+	if (props?.awsLambda) initClient$4({ config: props.awsConfig });
+	if (props?.awsS3) initClient$5({ config: props.awsConfig });
+	if (props?.awsSes) initClient$6({ config: props.awsConfig });
+	if (props?.awsSsm || props?.lumarApi || props?.lumarGraphql || props?.googleAds || props?.googleConfig) initClient$7({ config: props.awsConfig });
+	if (props?.lumarApi) await initClient$8({ auth: await getParameter({ name: props.lumarApi.parameterName }) });
+	if (props?.lumarGraphql) await initClient$9({ auth: await getParameter({ name: props.lumarGraphql.parameterName }) });
+	if (props?.googleConfig) {
+		const googleParameter = await getParameter({ name: props.googleConfig.parameterName });
+		if (props?.googleBigQuery && props?.googleConfig?.projectId) initClient$10({
+			parameter: googleParameter,
+			projectId: props.googleConfig.projectId
+		});
+		if (props?.googleSheets) initClient$11({ parameter: googleParameter });
+		if (props?.googleStorage && props?.googleConfig?.projectId) initClient$12({
+			parameter: googleParameter,
+			projectId: props.googleConfig.projectId
+		});
+	}
+	if (props?.googleAds) await initClient$13({ parameter: await getParameter({ name: props.googleAds.parameterName }) });
+	if (props?.prisma) initClient$14({
+		debug: props?.prisma?.debug ?? false,
+		planetScale: props?.prisma?.planetScale ?? false
+	});
+};
+//#endregion
+export { initClients as default };

package/dist/json/getJsonNewline.d.mts

@@ -0,0 +1,9 @@
+//#region src/json/getJsonNewline.d.ts
+type GetGlueJson = {
+  data: any;
+};
+declare const GetJsonNewline: ({
+  data
+}: GetGlueJson) => string;
+//#endregion
+export { GetJsonNewline as default };

package/dist/json/getJsonNewline.mjs

@@ -0,0 +1,7 @@
+import getArray from "../array/getArray.mjs";
+//#region src/json/getJsonNewline.ts
+const GetJsonNewline = ({ data }) => {
+	return getArray({ input: data }).map((row) => JSON.stringify(row)).join("\n");
+};
+//#endregion
+export { GetJsonNewline as default };

package/dist/json/isJson.d.mts

@@ -0,0 +1,12 @@
+//#region src/json/isJson.d.ts
+/**
+ * Is the provided input JSON?
+ * https://stackoverflow.com/a/33369954
+ */
+declare const isJson: ({
+  input
+}: {
+  input: any;
+}) => boolean;
+//#endregion
+export { isJson as default };

package/dist/json/isJson.mjs

@@ -0,0 +1,17 @@
+//#region src/json/isJson.ts
+/**
+* Is the provided input JSON?
+* https://stackoverflow.com/a/33369954
+*/
+const isJson = ({ input }) => {
+	input = "string" === typeof input ? input : JSON.stringify(input);
+	try {
+		input = JSON.parse(input);
+	} catch (e) {
+		return false;
+	}
+	if ("object" === typeof input && null !== input) return true;
+	return false;
+};
+//#endregion
+export { isJson as default };

package/dist/littleWarden/getUrlStatus.d.mts

@@ -0,0 +1,14 @@
+//#region src/littleWarden/getUrlStatus.d.ts
+type GetUrlStatus = {
+  apiKey: string;
+  urlId: string;
+};
+/**
+ * Get the URL Status for a given URL ID from Little Warden.
+ */
+declare const getUrlStatus: ({
+  apiKey,
+  urlId
+}: GetUrlStatus) => Promise<any>;
+//#endregion
+export { getUrlStatus as default };

package/dist/littleWarden/getUrlStatus.mjs

@@ -0,0 +1,16 @@
+import get from "../axios/get.mjs";
+//#region src/littleWarden/getUrlStatus.ts
+/**
+* Get the URL Status for a given URL ID from Little Warden.
+*/
+const getUrlStatus = async ({ apiKey, urlId }) => {
+	return (await get({
+		config: { headers: { "Authorization": `Token token="${apiKey}"` } },
+		url: `https://littlewarden.com/api/sites/${urlId}`
+	})).getBodyDefaultTo({
+		defaultValue: {},
+		keys: ["data", "site"]
+	});
+};
+//#endregion
+export { getUrlStatus as default };

package/dist/littleWarden/isAllGood.d.mts

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

package/dist/littleWarden/isAllGood.mjs

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

package/dist/littleWarden/isDanger.d.mts

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