@8ms/helpers 1.40.0 → 1.40.1

package/dist/global/isSet.mjs

@@ -0,0 +1,9 @@
+//#region src/global/isSet.ts
+/**
+* Checks to see if a global key is set.
+*/
+const isSet = async ({ key }) => {
+	return void 0 === global["ems_cache"][key];
+};
+//#endregion
+export { isSet as default };

package/dist/global/maxCache.d.mts

@@ -0,0 +1,12 @@
+//#region src/global/maxCache.d.ts
+type MaxCache = {
+  limit: number;
+};
+/**
+ * Clear cache more than the provided number of cache.
+ */
+declare const maxCache: ({
+  limit
+}: MaxCache) => void;
+//#endregion
+export { maxCache as default };

package/dist/global/maxCache.mjs

@@ -0,0 +1,15 @@
+//#region src/global/maxCache.ts
+/**
+* Clear cache more than the provided number of cache.
+*/
+const maxCache = ({ limit }) => {
+	if (void 0 !== global["ems_cache"]) {
+		let counter = 0;
+		for (let cacheKey in global["ems_cache"]) {
+			if (counter > limit) delete global["ems_cache"][cacheKey];
+			counter++;
+		}
+	}
+};
+//#endregion
+export { maxCache as default };

package/dist/global/read.d.mts

@@ -0,0 +1,12 @@
+//#region src/global/read.d.ts
+type Update = {
+  key: string;
+};
+/**
+ * Retrieve a value from global memory.
+ */
+declare const read: ({
+  key
+}: Update) => Promise<any>;
+//#endregion
+export { read as default };

package/dist/global/read.mjs

@@ -0,0 +1,15 @@
+import forceUpdate from "./forceUpdate.mjs";
+//#region src/global/read.ts
+/**
+* Retrieve a value from global memory.
+*/
+const read = async ({ key }) => {
+	if (void 0 === global["ems_cache"] || void 0 === global["ems_cache"]?.[key] || null === global["ems_cache"]?.[key]) throw `Global key '${key}' does not exist, requires initialisation.`;
+	else if (0 != global["ems_cache"][key].expires) {
+		const expiresAt = Math.floor(global["ems_cache"][key].insertedAt / 1e3) + global["ems_cache"][key].expires;
+		if (Math.floor(Date.now() / 1e3) > expiresAt) await forceUpdate({ key });
+	}
+	return global["ems_cache"][key].value;
+};
+//#endregion
+export { read as default };

package/dist/global.d.mts

@@ -0,0 +1,42 @@
+import { Config } from "./google/getConfig.mjs";
+
+//#region src/global.d.ts
+declare global {
+  var awsAthenaExpressClient: any;
+  var awsGlueClient: any;
+  var awsEc2Client: any;
+  var awsEcsClient: any;
+  var awsLambdaClient: any;
+  var awsS3Client: any;
+  var awsSesClient: any;
+  var awsSsmClient: {
+    [key: string]: any;
+  };
+  var awsSqsClient: any;
+  var deepcrawlApi: {
+    token: string;
+    updatedAt: null | number;
+  };
+  var deepcrawlGraphql: {
+    token: string;
+    updatedAt: null | number;
+  };
+  var eskimiAccessToken: any;
+  var googleBigQueryDefault: {
+    credentials: Config;
+    projectId: string;
+  };
+  var googleBigQueryClient: any;
+  var googleAdsClient: {
+    [projectId: string]: any;
+  };
+  var googleSheetsClient: any;
+  var googleStorageDefault: {
+    credentials: Config;
+    projectId: string;
+  };
+  var googleStorageClient: any;
+  var myTargetAccessToken: any;
+  var prisma: any;
+  var snapchatAccessToken: any;
+}

package/dist/google/bigQuery/IsTableExists.d.mts

@@ -0,0 +1,17 @@
+//#region src/google/bigQuery/IsTableExists.d.ts
+type IsTableExists = {
+  datasetId: string;
+  projectId?: string;
+  tableId: string;
+};
+/**
+ * Check to see whether a given BigQuery table exists.
+ * https://cloud.google.com/bigquery/docs/samples/bigquery-table-exists
+ */
+declare const isTableExists: ({
+  datasetId,
+  projectId,
+  tableId
+}: IsTableExists) => Promise<boolean>;
+//#endregion
+export { isTableExists as default };

package/dist/google/bigQuery/IsTableExists.mjs

@@ -0,0 +1,19 @@
+import getClient from "./getClient.mjs";
+//#region src/google/bigQuery/IsTableExists.ts
+/**
+* Check to see whether a given BigQuery table exists.
+* https://cloud.google.com/bigquery/docs/samples/bigquery-table-exists
+*/
+const isTableExists = async ({ datasetId, projectId, tableId }) => {
+	let response;
+	const dataset = getClient({ projectId }).dataset(datasetId);
+	try {
+		await dataset.table(tableId).get();
+		response = true;
+	} catch (exception) {
+		response = false;
+	}
+	return response;
+};
+//#endregion
+export { isTableExists as default };

package/dist/google/bigQuery/createDataset.d.mts

@@ -0,0 +1,17 @@
+//#region src/google/bigQuery/createDataset.d.ts
+type CreateDataset = {
+  datasetId: string;
+  projectId?: string;
+  options: object;
+};
+/**
+ * Create a Dataset if it doesn't already exist.
+ * Returns table instance.
+ */
+declare const createDataset: ({
+  datasetId,
+  options,
+  projectId
+}: CreateDataset) => Promise<void>;
+//#endregion
+export { createDataset as default };

package/dist/google/bigQuery/createDataset.mjs

@@ -0,0 +1,15 @@
+import getClient from "./getClient.mjs";
+import isDatasetExists from "./isDatasetExists.mjs";
+//#region src/google/bigQuery/createDataset.ts
+/**
+* Create a Dataset if it doesn't already exist.
+* Returns table instance.
+*/
+const createDataset = async ({ datasetId, options, projectId }) => {
+	if (!await isDatasetExists({
+		datasetId,
+		projectId
+	})) await getClient({ projectId }).createDataset(datasetId, options || {});
+};
+//#endregion
+export { createDataset as default };

package/dist/google/bigQuery/createTable.d.mts

@@ -0,0 +1,20 @@
+//#region src/google/bigQuery/createTable.d.ts
+type CreateTable = {
+  datasetId: string;
+  datasetOptions?: object;
+  projectId?: string;
+  options?: object;
+  tableId: string;
+};
+/**
+ * Create a Table if it doesn't already exist.
+ */
+declare const createTable: ({
+  datasetId,
+  datasetOptions,
+  options,
+  projectId,
+  tableId
+}: CreateTable) => Promise<void>;
+//#endregion
+export { createTable as default };

package/dist/google/bigQuery/createTable.mjs

@@ -0,0 +1,21 @@
+import getClient from "./getClient.mjs";
+import isTableExists from "./IsTableExists.mjs";
+import createDataset from "./createDataset.mjs";
+//#region src/google/bigQuery/createTable.ts
+/**
+* Create a Table if it doesn't already exist.
+*/
+const createTable = async ({ datasetId, datasetOptions, options, projectId, tableId }) => {
+	await createDataset({
+		datasetId,
+		options: datasetOptions,
+		projectId
+	});
+	if (!await isTableExists({
+		datasetId,
+		projectId,
+		tableId
+	})) await getClient({ projectId }).dataset(datasetId).createTable(tableId, options || {});
+};
+//#endregion
+export { createTable as default };

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

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

package/dist/google/bigQuery/getClient.mjs

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

package/dist/google/bigQuery/getDatasets.d.mts

@@ -0,0 +1,17 @@
+//#region src/google/bigQuery/getDatasets.d.ts
+type GetDatasets = {
+  projectId?: string;
+};
+type Datasets = {
+  id: string;
+  location: string;
+  projectId: string;
+};
+/**
+ * Retrieve all the Datasets from a given Project.
+ */
+declare const getDatasets: ({
+  projectId
+}: GetDatasets) => Promise<Datasets[]>;
+//#endregion
+export { getDatasets as default };

package/dist/google/bigQuery/getDatasets.mjs

@@ -0,0 +1,17 @@
+import getClient from "./getClient.mjs";
+//#region src/google/bigQuery/getDatasets.ts
+/**
+* Retrieve all the Datasets from a given Project.
+*/
+const getDatasets = async ({ projectId }) => {
+	let response = [];
+	const datasets = await getClient({ projectId }).getDatasets();
+	if (datasets?.[0]) for (let i = 0; i < datasets[0].length; i++) response.push({
+		id: datasets[0][i].id,
+		location: datasets[0][i].location,
+		projectId: datasets[0][i].bigQuery.projectId
+	});
+	return response;
+};
+//#endregion
+export { getDatasets as default };

package/dist/google/bigQuery/getTables.d.mts

@@ -0,0 +1,14 @@
+//#region src/google/bigQuery/getTables.d.ts
+type GetTables = {
+  datasetId?: string;
+  projectId?: string;
+};
+type Tables = {
+  id: string;
+};
+/**
+ * Retrieve all the Tables from a given Project/Dataset.
+ */
+declare const getTables: (props: GetTables) => Promise<Tables[]>;
+//#endregion
+export { getTables as default };

package/dist/google/bigQuery/getTables.mjs

@@ -0,0 +1,13 @@
+import getClient from "./getClient.mjs";
+//#region src/google/bigQuery/getTables.ts
+/**
+* Retrieve all the Tables from a given Project/Dataset.
+*/
+const getTables = async (props) => {
+	let response = [];
+	const tables = await getClient({ projectId: props.projectId }).dataset(props.datasetId).getTables();
+	if (tables?.[0]) for (let i = 0; i < tables[0].length; i++) response.push({ id: tables[0][i].id });
+	return response;
+};
+//#endregion
+export { getTables as default };

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

@@ -0,0 +1,17 @@
+import { Config } from "../getConfig.mjs";
+
+//#region src/google/bigQuery/initClient.d.ts
+type InitClient = {
+  parameter: Config;
+  projectId: string;
+};
+/**
+ * Initialise the Big Query client.
+ * It's possible to use multiple clients, so we set one up per project id.
+ */
+declare const initClient: ({
+  parameter,
+  projectId
+}: InitClient) => void;
+//#endregion
+export { initClient as default };

package/dist/google/bigQuery/initClient.mjs

@@ -0,0 +1,27 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+import getConfig from "../getConfig.mjs";
+//#region src/google/bigQuery/initClient.ts
+global.googleBigQueryDefault = {
+	credentials: null,
+	projectId: null
+};
+global.googleBigQueryClient = null;
+/**
+* Initialise the Big Query client.
+* It's possible to use multiple clients, so we set one up per project id.
+*/
+const initClient = ({ parameter, projectId }) => {
+	if (!global.googleBigQueryClient) {
+		const { BigQuery } = __require("@google-cloud/bigquery");
+		const formattedConfig = getConfig({ parameter });
+		global.googleBigQueryDefault.credentials = formattedConfig;
+		global.googleBigQueryDefault.projectId = projectId;
+		global.googleBigQueryClient = new BigQuery({
+			credentials: global.googleBigQueryDefault.credentials,
+			location: "europe-west2",
+			projectId: global.googleBigQueryDefault.projectId
+		});
+	}
+};
+//#endregion
+export { initClient as default };

package/dist/google/bigQuery/isDatasetExists.d.mts

@@ -0,0 +1,16 @@
+//#region src/google/bigQuery/isDatasetExists.d.ts
+type IsDatasetExists = {
+  datasetId: string;
+  projectId?: string;
+};
+/**
+ * Check to see whether a given BigQuery dataset exists.
+ * Based off:
+ * https://github.com/googleapis/nodejs-bigquery/blob/main/samples/getDataset.js
+ */
+declare const isDatasetExists: ({
+  datasetId,
+  projectId
+}: IsDatasetExists) => Promise<boolean>;
+//#endregion
+export { isDatasetExists as default };

package/dist/google/bigQuery/isDatasetExists.mjs

@@ -0,0 +1,20 @@
+import getClient from "./getClient.mjs";
+//#region src/google/bigQuery/isDatasetExists.ts
+/**
+* Check to see whether a given BigQuery dataset exists.
+* Based off:
+* https://github.com/googleapis/nodejs-bigquery/blob/main/samples/getDataset.js
+*/
+const isDatasetExists = async ({ datasetId, projectId }) => {
+	let response;
+	let client = getClient({ projectId });
+	try {
+		await client.dataset(datasetId).get();
+		response = true;
+	} catch (exception) {
+		response = false;
+	}
+	return response;
+};
+//#endregion
+export { isDatasetExists as default };

package/dist/google/bigQuery/loadData.d.mts

@@ -0,0 +1,23 @@
+//#region src/google/bigQuery/loadData.d.ts
+type LoadData = {
+  file: {
+    bucket: string;
+    key: string;
+    metadata: object;
+    projectId?: string;
+  };
+  table: {
+    projectId?: string;
+    datasetId: string;
+    tableId: string;
+  };
+};
+/**
+ * Load data into a given table.
+ */
+declare const loadData: ({
+  file,
+  table
+}: LoadData) => Promise<void>;
+//#endregion
+export { loadData as default };

package/dist/google/bigQuery/loadData.mjs

@@ -0,0 +1,20 @@
+import getClient from "./getClient.mjs";
+import isTableExists from "./IsTableExists.mjs";
+import getClient$1 from "../storage/getClient.mjs";
+//#region src/google/bigQuery/loadData.ts
+/**
+* Load data into a given table.
+*/
+const loadData = async ({ file, table }) => {
+	if (await isTableExists({
+		datasetId: table.datasetId,
+		projectId: table.projectId,
+		tableId: table.tableId
+	})) {
+		let bigqueryClient = getClient({ projectId: table.projectId });
+		let storageClient = getClient$1({ projectId: file.projectId });
+		await bigqueryClient.dataset(table.datasetId).table(table.tableId).load(storageClient.bucket(file.bucket).file(file.key), file.metadata);
+	}
+};
+//#endregion
+export { loadData as default };

package/dist/google/bigQuery/query.d.mts

@@ -0,0 +1,24 @@
+//#region src/google/bigQuery/query.d.ts
+/**
+ * https://cloud.google.com/bigquery/docs/parameterized-queries
+ */
+type QueryInput = string | {
+  query: string;
+  location?: string;
+  params: {
+    [key: string]: any;
+  };
+};
+type Query = {
+  input: QueryInput;
+  projectId?: string;
+};
+/**
+ * Build the query and return the data.
+ */
+declare const query: ({
+  input,
+  projectId
+}: Query) => Promise<any>;
+//#endregion
+export { Query, QueryInput, query as default };

package/dist/google/bigQuery/query.mjs

@@ -0,0 +1,10 @@
+import getClient from "./getClient.mjs";
+//#region src/google/bigQuery/query.ts
+/**
+* Build the query and return the data.
+*/
+const query = async ({ input, projectId }) => {
+	return await getClient({ projectId }).query(input);
+};
+//#endregion
+export { query as default };

package/dist/google/getConfig.d.mts

@@ -0,0 +1,24 @@
+//#region src/google/getConfig.d.ts
+type Config = {
+  type: string;
+  project_id: string;
+  private_key_id: string;
+  private_key: string;
+  client_email: string;
+  client_id: string;
+  auth_uri: string;
+  token_uri: string;
+  auth_provider_x509_cert_url: string;
+  client_x509_cert_url: string;
+};
+type GetConfig = {
+  parameter: Config;
+};
+/**
+ * Using the response from Parameter Store and format it ready to be used with Google API.
+ */
+declare const getConfig: ({
+  parameter
+}: GetConfig) => Config;
+//#endregion
+export { Config, GetConfig, getConfig as default };

package/dist/google/getConfig.mjs

@@ -0,0 +1,21 @@
+//#region src/google/getConfig.ts
+/**
+* Using the response from Parameter Store and format it ready to be used with Google API.
+*/
+const getConfig = ({ parameter }) => {
+	const privateKey = parameter["private_key"].replace(/\\n/g, "\n");
+	return {
+		type: parameter["type"],
+		project_id: parameter["project_id"],
+		private_key_id: parameter["private_key_id"],
+		private_key: privateKey,
+		client_email: parameter["client_email"],
+		client_id: parameter["client_id"],
+		auth_uri: parameter["auth_uri"],
+		token_uri: parameter["token_uri"],
+		auth_provider_x509_cert_url: parameter["auth_provider_x509_cert_url"],
+		client_x509_cert_url: parameter["client_x509_cert_url"]
+	};
+};
+//#endregion
+export { getConfig as default };

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

@@ -0,0 +1,18 @@
+//#region src/google/sheets/getAssociatedData.d.ts
+type GetAssociatedData = {
+  spreadsheetId: string;
+  ranges: [format: string, defaultRange: string, heading: string, data: string];
+  dateTimeRender: 'FORMATTED_STRING' | 'SERIAL_NUMBER';
+  valueRender: 'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA';
+};
+/**
+ * Make a batch get to Google Sheets to retrieve the data correctly formatted, with default values provided.
+ */
+declare const getAssociatedData: ({
+  dateTimeRender,
+  ranges,
+  spreadsheetId,
+  valueRender
+}: GetAssociatedData) => Promise<object[]>;
+//#endregion
+export { getAssociatedData as default };

package/dist/google/sheets/getAssociatedData.mjs

@@ -0,0 +1,35 @@
+import getBatchData from "./getBatchData.mjs";
+//#region src/google/sheets/getAssociatedData.ts
+/**
+* Make a batch get to Google Sheets to retrieve the data correctly formatted, with default values provided.
+*/
+const getAssociatedData = async ({ dateTimeRender, ranges, spreadsheetId, valueRender }) => {
+	const apiResponse = await getBatchData({
+		spreadsheetId,
+		ranges,
+		dateTimeRender,
+		valueRender
+	});
+	let template = [];
+	let response = [];
+	if (4 !== apiResponse.valueRanges.length) throw new Error("Associated data response length must be 4.");
+	const initialRangeLength = apiResponse.valueRanges[0].values[0].length;
+	for (let i = 0; i < initialRangeLength; i++) template.push({
+		format: apiResponse.valueRanges[0].values[0][i],
+		default: apiResponse.valueRanges[1].values[0][i],
+		heading: apiResponse.valueRanges[2].values[0][i],
+		index: i
+	});
+	if (void 0 !== apiResponse.valueRanges[3].values) for (let rowIndex = 0; rowIndex < apiResponse.valueRanges[3].values.length; rowIndex++) {
+		let row = {};
+		for (let columnIndex = 0; columnIndex < apiResponse.valueRanges[3].values[rowIndex].length; columnIndex++) {
+			const refValue = apiResponse.valueRanges[3].values[rowIndex][columnIndex];
+			const value = "" === refValue ? template[columnIndex]["default"] : refValue;
+			row[template[columnIndex]["heading"]] = value;
+		}
+		response.push(row);
+	}
+	return response;
+};
+//#endregion
+export { getAssociatedData as default };

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

@@ -0,0 +1,23 @@
+//#region src/google/sheets/getBatchData.d.ts
+type BatchData = {
+  spreadsheetId: string;
+  valueRanges: {
+    range: string;
+    majorDimension: 'rows' | 'dimension';
+    values: [any[]];
+  }[];
+};
+type GetBatchData = {
+  spreadsheetId: string;
+  ranges: string[];
+  dateTimeRender?: string;
+  valueRender?: string;
+};
+declare const getBatchData: ({
+  spreadsheetId,
+  ranges,
+  dateTimeRender,
+  valueRender
+}: GetBatchData) => Promise<BatchData>;
+//#endregion
+export { getBatchData as default };

package/dist/google/sheets/getBatchData.mjs

@@ -0,0 +1,15 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+//#region src/google/sheets/getBatchData.ts
+const getBatchData = async ({ spreadsheetId, ranges, dateTimeRender = "FORMATTED_STRING", valueRender = "UNFORMATTED_VALUE" }) => {
+	const googleApisSheets = __require("@googleapis/sheets");
+	const request = {
+		auth: global.googleSheetsClient,
+		dateTimeRenderOption: dateTimeRender,
+		ranges,
+		spreadsheetId,
+		valueRenderOption: valueRender
+	};
+	return (await googleApisSheets.sheets("v4").spreadsheets.values.batchGet(request)).data;
+};
+//#endregion
+export { getBatchData as default };

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

@@ -0,0 +1,16 @@
+import { Config } from "../getConfig.mjs";
+
+//#region src/google/sheets/initClient.d.ts
+type InitClient = {
+  parameter: Config;
+};
+/**
+ * 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
+}: InitClient) => void;
+//#endregion
+export { initClient as default };