@8ms/helpers 1.39.0 → 1.40.1

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

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/index.d.mts

@@ -0,0 +1,241 @@
+//#region src/googleAds/keywordPlanner/index.d.ts
+/**
+ * As defined in=
+ * https=//docs.google.com/spreadsheets/d/1T2ObmYoo6BNzrqYKb2ts75A6IKfnXmnndr2wujgNpak/edit#gid=2146701026
+ */
+declare enum Country {
+  AFGHANISTAN = 2004,
+  ALBANIA = 2008,
+  ANTARCTICA = 2010,
+  ALGERIA = 2012,
+  AMERICAN_SAMOA = 2016,
+  ANDORRA = 2020,
+  ANGOLA = 2024,
+  ANTIGUA_AND_BARBUDA = 2028,
+  AZERBAIJAN = 2031,
+  ARGENTINA = 2032,
+  AUSTRALIA = 2036,
+  AUSTRIA = 2040,
+  THE_BAHAMAS = 2044,
+  BAHRAIN = 2048,
+  BANGLADESH = 2050,
+  ARMENIA = 2051,
+  BARBADOS = 2052,
+  BELGIUM = 2056,
+  BHUTAN = 2064,
+  BOLIVIA = 2068,
+  BOSNIA_AND_HERZEGOVINA = 2070,
+  BOTSWANA = 2072,
+  BRAZIL = 2076,
+  BELIZE = 2084,
+  SOLOMON_ISLANDS = 2090,
+  BRUNEI = 2096,
+  BULGARIA = 2100,
+  MYANMAR_BURMA = 2104,
+  BURUNDI = 2108,
+  BELARUS = 2112,
+  CAMBODIA = 2116,
+  CAMEROON = 2120,
+  CANADA = 2124,
+  CAPE_VERDE = 2132,
+  CENTRAL_AFRICAN_REPUBLIC = 2140,
+  SRI_LANKA = 2144,
+  CHAD = 2148,
+  CHILE = 2152,
+  CHINA = 2156,
+  CHRISTMAS_ISLAND = 2162,
+  COCOS_KEELING_ISLANDS = 2166,
+  COLOMBIA = 2170,
+  COMOROS = 2174,
+  REPUBLIC_OF_THE_CONGO = 2178,
+  DEMOCRATIC_REPUBLIC_OF_THE_CONGO = 2180,
+  COOK_ISLANDS = 2184,
+  COSTA_RICA = 2188,
+  CROATIA = 2191,
+  CYPRUS = 2196,
+  CZECHIA = 2203,
+  BENIN = 2204,
+  DENMARK = 2208,
+  DOMINICA = 2212,
+  DOMINICAN_REPUBLIC = 2214,
+  ECUADOR = 2218,
+  EL_SALVADOR = 2222,
+  EQUATORIAL_GUINEA = 2226,
+  ETHIOPIA = 2231,
+  ERITREA = 2232,
+  ESTONIA = 2233,
+  SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS = 2239,
+  FIJI = 2242,
+  FINLAND = 2246,
+  FRANCE = 2250,
+  FRENCH_POLYNESIA = 2258,
+  FRENCH_SOUTHERN_AND_ANTARCTIC_LANDS = 2260,
+  DJIBOUTI = 2262,
+  GABON = 2266,
+  GEORGIA = 2268,
+  THE_GAMBIA = 2270,
+  GERMANY = 2276,
+  GHANA = 2288,
+  KIRIBATI = 2296,
+  GREECE = 2300,
+  GRENADA = 2308,
+  GUAM = 2316,
+  GUATEMALA = 2320,
+  GUINEA = 2324,
+  GUYANA = 2328,
+  HAITI = 2332,
+  HEARD_ISLAND_AND_MCDONALD_ISLANDS = 2334,
+  VATICAN_CITY = 2336,
+  HONDURAS = 2340,
+  HUNGARY = 2348,
+  ICELAND = 2352,
+  INDIA = 2356,
+  INDONESIA = 2360,
+  IRAQ = 2368,
+  IRELAND = 2372,
+  ISRAEL = 2376,
+  ITALY = 2380,
+  COTE_DIVOIRE = 2384,
+  JAMAICA = 2388,
+  JAPAN = 2392,
+  KAZAKHSTAN = 2398,
+  JORDAN = 2400,
+  KENYA = 2404,
+  SOUTH_KOREA = 2410,
+  KUWAIT = 2414,
+  KYRGYZSTAN = 2417,
+  LAOS = 2418,
+  LEBANON = 2422,
+  LESOTHO = 2426,
+  LATVIA = 2428,
+  LIBERIA = 2430,
+  LIBYA = 2434,
+  LIECHTENSTEIN = 2438,
+  LITHUANIA = 2440,
+  LUXEMBOURG = 2442,
+  MADAGASCAR = 2450,
+  MALAWI = 2454,
+  MALAYSIA = 2458,
+  MALDIVES = 2462,
+  MALI = 2466,
+  MALTA = 2470,
+  MAURITANIA = 2478,
+  MAURITIUS = 2480,
+  MEXICO = 2484,
+  MONACO = 2492,
+  MONGOLIA = 2496,
+  MOLDOVA = 2498,
+  MONTENEGRO = 2499,
+  MOROCCO = 2504,
+  MOZAMBIQUE = 2508,
+  OMAN = 2512,
+  NAMIBIA = 2516,
+  NAURU = 2520,
+  NEPAL = 2524,
+  NETHERLANDS = 2528,
+  CURACAO = 2531,
+  SINT_MAARTEN = 2534,
+  CARIBBEAN_NETHERLANDS = 2535,
+  NEW_CALEDONIA = 2540,
+  VANUATU = 2548,
+  NEW_ZEALAND = 2554,
+  NICARAGUA = 2558,
+  NIGER = 2562,
+  NIGERIA = 2566,
+  NIUE = 2570,
+  NORFOLK_ISLAND = 2574,
+  NORWAY = 2578,
+  NORTHERN_MARIANA_ISLANDS = 2580,
+  UNITED_STATES_MINOR_OUTLYING_ISLANDS = 2581,
+  FEDERATED_STATES_OF_MICRONESIA = 2583,
+  MARSHALL_ISLANDS = 2584,
+  PALAU = 2585,
+  PAKISTAN = 2586,
+  PANAMA = 2591,
+  PAPUA_NEW_GUINEA = 2598,
+  PARAGUAY = 2600,
+  PERU = 2604,
+  PHILIPPINES = 2608,
+  PITCAIRN_ISLANDS = 2612,
+  POLAND = 2616,
+  PORTUGAL = 2620,
+  GUINEA_BISSAU = 2624,
+  TIMOR_LESTE = 2626,
+  QATAR = 2634,
+  ROMANIA = 2642,
+  RUSSIA = 2643,
+  RWANDA = 2646,
+  SAINT_HELENA__ASCENSION_AND_TRISTAN_DA_CUNHA = 2654,
+  SAINT_KITTS_AND_NEVIS = 2659,
+  SAINT_LUCIA = 2662,
+  SAINT_PIERRE_AND_MIQUELON = 2666,
+  SAINT_VINCENT_AND_THE_GRENADINES = 2670,
+  SAN_MARINO = 2674,
+  SAO_TOME_AND_PRINCIPE = 2678,
+  SAUDI_ARABIA = 2682,
+  SENEGAL = 2686,
+  SERBIA = 2688,
+  SEYCHELLES = 2690,
+  SIERRA_LEONE = 2694,
+  SINGAPORE = 2702,
+  SLOVAKIA = 2703,
+  VIETNAM = 2704,
+  SLOVENIA = 2705,
+  SOMALIA = 2706,
+  SOUTH_AFRICA = 2710,
+  ZIMBABWE = 2716,
+  SPAIN = 2724,
+  SUDAN = 2736,
+  SURINAME = 2740,
+  ESWATINI = 2748,
+  SWEDEN = 2752,
+  SWITZERLAND = 2756,
+  TAJIKISTAN = 2762,
+  THAILAND = 2764,
+  TOGO = 2768,
+  TOKELAU = 2772,
+  TONGA = 2776,
+  TRINIDAD_AND_TOBAGO = 2780,
+  UNITED_ARAB_EMIRATES = 2784,
+  TUNISIA = 2788,
+  TURKEY = 2792,
+  TURKMENISTAN = 2795,
+  TUVALU = 2798,
+  UGANDA = 2800,
+  UKRAINE = 2804,
+  NORTH_MACEDONIA = 2807,
+  EGYPT = 2818,
+  UNITED_KINGDOM = 2826,
+  GUERNSEY = 2831,
+  JERSEY = 2832,
+  TANZANIA = 2834,
+  UNITED_STATES = 2840,
+  BURKINA_FASO = 2854,
+  URUGUAY = 2858,
+  UZBEKISTAN = 2860,
+  VENEZUELA = 2862,
+  WALLIS_AND_FUTUNA = 2876,
+  SAMOA = 2882,
+  YEMEN = 2887,
+  ZAMBIA = 2894
+}
+declare enum Month {
+  JANUARY = "JANUARY",
+  FEBRUARY = "FEBRUARY",
+  MARCH = "MARCH",
+  APRIL = "APRIL",
+  MAY = "MAY",
+  JUNE = "JUNE",
+  JULY = "JULY",
+  AUGUST = "AUGUST",
+  SEPTEMBER = "SEPTEMBER",
+  OCTOBER = "OCTOBER",
+  NOVEMBER = "NOVEMBER",
+  DECEMBER = "DECEMBER"
+}
+declare enum Network {
+  GOOGLE_SEARCH_ONLY = 2,
+  GOOGLE_SEARCH_AND_PARTNERS = 3
+}
+//#endregion
+export { Country, Month, Network };