@8ms/helpers 1.39.0 → 1.40.1

package/dist/date/parseExcelDate.d.mts

@@ -0,0 +1,12 @@
+//#region src/date/parseExcelDate.d.ts
+/**
+ * Convert an excel date "e.g. 44216" into a JavaScript date object.
+ * https://stackoverflow.com/questions/16229494/converting-excel-date-serial-number-to-date-using-javascript
+ */
+declare const parseExcelDate: ({
+  serial
+}: {
+  serial: number;
+}) => Date;
+//#endregion
+export { parseExcelDate as default };

package/dist/date/parseExcelDate.mjs

@@ -0,0 +1,18 @@
+//#region src/date/parseExcelDate.ts
+/**
+* Convert an excel date "e.g. 44216" into a JavaScript date object.
+* https://stackoverflow.com/questions/16229494/converting-excel-date-serial-number-to-date-using-javascript
+*/
+const parseExcelDate = ({ serial }) => {
+	const utcValue = Math.floor(serial - 25569) * 86400;
+	const dateInfo = /* @__PURE__ */ new Date(utcValue * 1e3);
+	const fractionalDay = serial - Math.floor(serial) + 1e-7;
+	let totalSeconds = Math.floor(86400 * fractionalDay);
+	const seconds = totalSeconds % 60;
+	totalSeconds -= seconds;
+	const hours = Math.floor(totalSeconds / 3600);
+	const minutes = Math.floor(totalSeconds / 60) % 60;
+	return new Date(dateInfo.getFullYear(), dateInfo.getMonth(), dateInfo.getDate(), hours, minutes, seconds);
+};
+//#endregion
+export { parseExcelDate as default };

package/dist/environment/getEnvironment.d.mts

@@ -0,0 +1,9 @@
+import { Environment } from "./index.mjs";
+
+//#region src/environment/getEnvironment.d.ts
+/**
+ * Determine the environment we're using.
+ */
+declare const getEnvironment: () => Environment;
+//#endregion
+export { getEnvironment as default };

package/dist/environment/getEnvironment.mjs

@@ -0,0 +1,27 @@
+import { Environment } from "./index.mjs";
+//#region src/environment/getEnvironment.ts
+/**
+* Determine the environment we're using.
+*/
+const getEnvironment = () => {
+	let platformEnvironment = process.env.ENVIRONMENT;
+	let response;
+	if (process.env.EMS_ENVIRONMENT) platformEnvironment = process.env.EMS_ENVIRONMENT;
+	else if (process.env.NEXT_PUBLIC_EMS_ENVIRONMENT) platformEnvironment = process.env.NEXT_PUBLIC_EMS_ENVIRONMENT;
+	else if (process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF) platformEnvironment = process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF;
+	else if (process.env.VERCEL_GIT_COMMIT_REF) platformEnvironment = process.env.VERCEL_GIT_COMMIT_REF;
+	switch (platformEnvironment.toLowerCase().trim()) {
+		case "development":
+			response = Environment.DEVELOPMENT;
+			break;
+		case "demo":
+		case "preview":
+		case "staging":
+			response = Environment.STAGING;
+			break;
+		default: response = Environment.PRODUCTION;
+	}
+	return response;
+};
+//#endregion
+export { getEnvironment as default };

package/dist/environment/index.d.mts

@@ -0,0 +1,12 @@
+//#region src/environment/index.d.ts
+declare enum Environment {
+  DEVELOPMENT = "development",
+  STAGING = "staging",
+  PRODUCTION = "production"
+}
+declare enum Platform {
+  AWS = "AWS",
+  VERCEL = "VERCEL"
+}
+//#endregion
+export { Environment, Platform };

package/dist/environment/index.mjs

@@ -0,0 +1,14 @@
+//#region src/environment/index.ts
+let Environment = /* @__PURE__ */ function(Environment) {
+	Environment["DEVELOPMENT"] = "development";
+	Environment["STAGING"] = "staging";
+	Environment["PRODUCTION"] = "production";
+	return Environment;
+}({});
+let Platform = /* @__PURE__ */ function(Platform) {
+	Platform["AWS"] = "AWS";
+	Platform["VERCEL"] = "VERCEL";
+	return Platform;
+}({});
+//#endregion
+export { Environment, Platform };

package/dist/environment/isAws.d.mts

@@ -0,0 +1,7 @@
+//#region src/environment/isAws.d.ts
+/**
+ * Check to see if we are working on AWS Lambda.
+ */
+declare const isAws: () => boolean;
+//#endregion
+export { isAws as default };

package/dist/environment/isAws.mjs

@@ -0,0 +1,8 @@
+import { Platform } from "./index.mjs";
+//#region src/environment/isAws.ts
+/**
+* Check to see if we are working on AWS Lambda.
+*/
+const isAws = () => Platform.AWS === process.env["EMS_PLATFORM"];
+//#endregion
+export { isAws as default };

package/dist/environment/isDevelopment.d.mts

@@ -0,0 +1,4 @@
+//#region src/environment/isDevelopment.d.ts
+declare const isDevelopment: () => boolean;
+//#endregion
+export { isDevelopment as default };

package/dist/environment/isDevelopment.mjs

@@ -0,0 +1,6 @@
+import { Environment } from "./index.mjs";
+import getEnvironment from "./getEnvironment.mjs";
+//#region src/environment/isDevelopment.ts
+const isDevelopment = () => Environment.DEVELOPMENT === getEnvironment();
+//#endregion
+export { isDevelopment as default };

package/dist/environment/isLocalhost.d.mts

@@ -0,0 +1,7 @@
+//#region src/environment/isLocalhost.d.ts
+/**
+ * Check to see if we are developing locally or on the hosted platform.
+ */
+declare const isLocalhost: () => boolean;
+//#endregion
+export { isLocalhost as default };

package/dist/environment/isLocalhost.mjs

@@ -0,0 +1,15 @@
+import isAws from "./isAws.mjs";
+import isVercel from "./isVercel.mjs";
+//#region src/environment/isLocalhost.ts
+/**
+* Check to see if we are developing locally or on the hosted platform.
+*/
+const isLocalhost = () => {
+	let response = false;
+	if ("true" === process.env["IS_LOCAL"]) response = true;
+	else if (isAws()) response = "true" === process.env["AWS_SAM_LOCAL"];
+	else if (isVercel()) response = void 0 === process.env["NEXT_PUBLIC_VERCEL_GIT_REPO_ID"];
+	return response;
+};
+//#endregion
+export { isLocalhost as default };

package/dist/environment/isProduction.d.mts

@@ -0,0 +1,4 @@
+//#region src/environment/isProduction.d.ts
+declare const isProduction: () => boolean;
+//#endregion
+export { isProduction as default };

package/dist/environment/isProduction.mjs

@@ -0,0 +1,6 @@
+import { Environment } from "./index.mjs";
+import getEnvironment from "./getEnvironment.mjs";
+//#region src/environment/isProduction.ts
+const isProduction = () => Environment.PRODUCTION === getEnvironment();
+//#endregion
+export { isProduction as default };

package/dist/environment/isStaging.d.mts

@@ -0,0 +1,4 @@
+//#region src/environment/isStaging.d.ts
+declare const isStaging: () => boolean;
+//#endregion
+export { isStaging as default };

package/dist/environment/isStaging.mjs

@@ -0,0 +1,6 @@
+import { Environment } from "./index.mjs";
+import getEnvironment from "./getEnvironment.mjs";
+//#region src/environment/isStaging.ts
+const isStaging = () => Environment.STAGING === getEnvironment();
+//#endregion
+export { isStaging as default };

package/dist/environment/isVercel.d.mts

@@ -0,0 +1,7 @@
+//#region src/environment/isVercel.d.ts
+/**
+ * Check to see if we are working on Vercel.
+ */
+declare const isVercel: () => boolean;
+//#endregion
+export { isVercel as default };

package/dist/environment/isVercel.mjs

@@ -0,0 +1,7 @@
+//#region src/environment/isVercel.ts
+/**
+* Check to see if we are working on Vercel.
+*/
+const isVercel = () => void 0 !== process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF;
+//#endregion
+export { isVercel as default };

package/dist/eskimi/ageGroups.d.mts

@@ -0,0 +1,7 @@
+//#region src/eskimi/ageGroups.d.ts
+declare const ageGroups: {
+  id: number;
+  name: string;
+}[];
+//#endregion
+export { ageGroups as default };

package/dist/eskimi/ageGroups.mjs

@@ -0,0 +1,41 @@
+//#region src/eskimi/ageGroups.ts
+const ageGroups = [
+	{
+		"id": 0,
+		"name": "0-17"
+	},
+	{
+		"id": 1,
+		"name": "18-24"
+	},
+	{
+		"id": 2,
+		"name": "25-29"
+	},
+	{
+		"id": 3,
+		"name": "30-34"
+	},
+	{
+		"id": 4,
+		"name": "35-39"
+	},
+	{
+		"id": 5,
+		"name": "40-44"
+	},
+	{
+		"id": 6,
+		"name": "45-54"
+	},
+	{
+		"id": 7,
+		"name": "55-64"
+	},
+	{
+		"id": 8,
+		"name": "65+"
+	}
+];
+//#endregion
+export { ageGroups as default };

package/dist/eskimi/campaign.d.mts

@@ -0,0 +1,22 @@
+//#region src/eskimi/campaign.d.ts
+type Campaign = {
+  id: number;
+  name: string;
+  type: number;
+  user_id: number;
+  ad_domain: string;
+  click_url: string;
+  bid: string;
+  budget: any;
+  dates: any;
+  creative_set_ids: any;
+  audience_ids: any;
+  ad_placement_type_ids: any;
+  ad_placement_position_ids: any;
+  operator_ids: any;
+  devices: any;
+  auto_start: number;
+  created_at: string;
+};
+//#endregion
+export { Campaign };

package/dist/eskimi/campaign.mjs

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

package/dist/eskimi/devices.d.mts

@@ -0,0 +1,7 @@
+//#region src/eskimi/devices.d.ts
+declare const devices: {
+  id: number;
+  name: string;
+}[];
+//#endregion
+export { devices as default };

package/dist/eskimi/devices.mjs

@@ -0,0 +1,10 @@
+//#region src/eskimi/devices.ts
+const devices = [{
+	"id": 2,
+	"name": "Personal Computer"
+}, {
+	"id": 3,
+	"name": "Connected TV"
+}];
+//#endregion
+export { devices as default };

package/dist/eskimi/endpoints.d.mts

@@ -0,0 +1,18 @@
+//#region src/eskimi/endpoints.d.ts
+/**
+ * https://dsp-api.eskimi.com/docs/api/v1/#api-Report-GetCampaignReportByAgeGroups
+ */
+declare const endpoints: {
+  campaign: {
+    age: string;
+    gender: string;
+    list: string;
+    performance: string;
+    video: string;
+  };
+  site: {
+    list: string;
+  };
+};
+//#endregion
+export { endpoints as default };

package/dist/eskimi/endpoints.mjs

@@ -0,0 +1,16 @@
+//#region src/eskimi/endpoints.ts
+/**
+* https://dsp-api.eskimi.com/docs/api/v1/#api-Report-GetCampaignReportByAgeGroups
+*/
+const endpoints = {
+	campaign: {
+		age: "https://dsp-api.eskimi.com/api/v1/report/ageGroups/get",
+		gender: "https://dsp-api.eskimi.com/api/v1/report/genders/get",
+		list: "https://dsp-api.eskimi.com/api/v1/campaign/get",
+		performance: "https://dsp-api.eskimi.com/api/v1/report/campaigns/get",
+		video: "https://dsp-api.eskimi.com/api/v1/report/videoCampaigns/get"
+	},
+	site: { list: "https://dsp-api.eskimi.com/api/v1/report/sites/get" }
+};
+//#endregion
+export { endpoints as default };

package/dist/eskimi/genders.d.mts

@@ -0,0 +1,7 @@
+//#region src/eskimi/genders.d.ts
+declare const genders: {
+  id: number;
+  name: string;
+}[];
+//#endregion
+export { genders as default };

package/dist/eskimi/genders.mjs

@@ -0,0 +1,10 @@
+//#region src/eskimi/genders.ts
+const genders = [{
+	"id": 1,
+	"name": "Male"
+}, {
+	"id": 2,
+	"name": "Female"
+}];
+//#endregion
+export { genders as default };

package/dist/eskimi/getAccessToken.d.mts

@@ -0,0 +1,14 @@
+//#region src/eskimi/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, getAccessToken as default };

package/dist/eskimi/getAccessToken.mjs

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

package/dist/eskimi/getAgeGroup.d.mts

@@ -0,0 +1,11 @@
+//#region src/eskimi/getAgeGroup.d.ts
+/**
+ * Map the Age Group and return the user-friendly string.
+ */
+declare const getAgeGroup: ({
+  input
+}: {
+  input: number;
+}) => string;
+//#endregion
+export { getAgeGroup as default };

package/dist/eskimi/getAgeGroup.mjs

@@ -0,0 +1,12 @@
+import ageGroups from "./ageGroups.mjs";
+//#region src/eskimi/getAgeGroup.ts
+/**
+* Map the Age Group and return the user-friendly string.
+*/
+const getAgeGroup = ({ input }) => {
+	const matches = ageGroups.filter((group) => group.id === input);
+	if (1 === matches.length) return matches[0].name;
+	return "Undefined";
+};
+//#endregion
+export { getAgeGroup as default };

package/dist/eskimi/getCampaignIds.d.mts

@@ -0,0 +1,11 @@
+//#region src/eskimi/getCampaignIds.d.ts
+/**
+ * Convert the Regex of Campaign Ids into an array of integers.
+ */
+declare const getCampaignIds: ({
+  accounts
+}: {
+  accounts: any;
+}) => number[];
+//#endregion
+export { getCampaignIds as default };

package/dist/eskimi/getCampaignIds.mjs

@@ -0,0 +1,9 @@
+//#region src/eskimi/getCampaignIds.ts
+/**
+* Convert the Regex of Campaign Ids into an array of integers.
+*/
+const getCampaignIds = ({ accounts }) => {
+	return accounts[0].campaignIdRegex.replace("(", "").replace(")", "").split("|").map((id) => parseInt(id));
+};
+//#endregion
+export { getCampaignIds as default };

package/dist/eskimi/getData.d.mts

@@ -0,0 +1,13 @@
+//#region src/eskimi/getData.d.ts
+/**
+ * Make the request to Eskimi API using the access token.
+ */
+declare const getData: ({
+  data,
+  url
+}: {
+  data: object;
+  url: string;
+}) => Promise<any>;
+//#endregion
+export { getData as default };

package/dist/eskimi/getData.mjs

@@ -0,0 +1,20 @@
+import post from "../axios/post.mjs";
+//#region src/eskimi/getData.ts
+/**
+* Make the request to Eskimi API using the access token.
+*/
+const getData = async ({ data, url }) => {
+	return (await post({
+		config: { headers: {
+			Authorization: `Bearer ${global.eskimiAccessToken}`,
+			"Content-Type": "application/json"
+		} },
+		data,
+		url
+	})).getBodyDefaultTo({
+		defaultValue: null,
+		keys: ["data"]
+	});
+};
+//#endregion
+export { getData as default };

package/dist/eskimi/getDevice.d.mts

@@ -0,0 +1,11 @@
+//#region src/eskimi/getDevice.d.ts
+/**
+ * Map the Devices and return the user-friendly string.
+ */
+declare const getDevice: ({
+  input
+}: {
+  input: number;
+}) => string;
+//#endregion
+export { getDevice as default };

package/dist/eskimi/getDevice.mjs

@@ -0,0 +1,12 @@
+import devices from "./devices.mjs";
+//#region src/eskimi/getDevice.ts
+/**
+* Map the Devices and return the user-friendly string.
+*/
+const getDevice = ({ input }) => {
+	const matches = devices.filter((device) => device.id === input);
+	if (1 === matches.length) return matches[0].name;
+	return "Undefined";
+};
+//#endregion
+export { getDevice as default };

package/dist/eskimi/getGender.d.mts

@@ -0,0 +1,11 @@
+//#region src/eskimi/getGender.d.ts
+/**
+ * Map the Gender and return the user-friendly string.
+ */
+declare const getGender: ({
+  input
+}: {
+  input: number;
+}) => string;
+//#endregion
+export { getGender as default };

package/dist/eskimi/getGender.mjs

@@ -0,0 +1,12 @@
+import genders from "./genders.mjs";
+//#region src/eskimi/getGender.ts
+/**
+* Map the Gender and return the user-friendly string.
+*/
+const getGender = ({ input }) => {
+	const matches = genders.filter((gender) => gender.id === input);
+	if (1 === matches.length) return matches[0].name;
+	return "Undefined";
+};
+//#endregion
+export { getGender as default };

package/dist/file/createDirectory.d.mts

@@ -0,0 +1,13 @@
+//#region src/file/createDirectory.d.ts
+type CreateDirectory = {
+  filePath: string;
+};
+/**
+ * Create a directory recursively.
+ * Requires fs-extra
+ */
+declare const createDirectory: ({
+  filePath
+}: CreateDirectory) => Promise<unknown>;
+//#endregion
+export { createDirectory as default };

package/dist/file/createDirectory.mjs

@@ -0,0 +1,16 @@
+import { t as __require } from "../chunk-y_GBKt04.mjs";
+//#region src/file/createDirectory.ts
+/**
+* Create a directory recursively.
+* Requires fs-extra
+*/
+const createDirectory = ({ filePath }) => {
+	return new Promise(async (resolve, reject) => {
+		const fs = __require("fs-extra");
+		const fileDir = __require("path").parse(filePath).dir;
+		fs.ensureDirSync(fileDir);
+		resolve(true);
+	});
+};
+//#endregion
+export { createDirectory as default };

package/dist/file/writeFile.d.mts

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

package/dist/file/writeFile.mjs

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

package/dist/getMidnight-Cr5sAuOj.d.mts

@@ -0,0 +1,12 @@
+//#region src/date/getMidnight.d.ts
+type GetMidnight = {
+  setMidnight?: boolean;
+};
+/**
+ * Set a date's time to 0 hours, 0 minutes, 0 seconds, 0 milliseconds
+ */
+declare const getMidnight: (props: GetMidnight & {
+  input: Date;
+}) => Date;
+//#endregion
+export { getMidnight as n, GetMidnight as t };

package/dist/getTimeZoned-D7uY_mE6.d.mts

@@ -0,0 +1,15 @@
+//#region src/date/getTimeZoned.d.ts
+type GetTimeZoned = {
+  setTimeZone?: string | false;
+};
+declare const timeZoneLondon = "Europe/London";
+/**
+ * Convert an input into a given timezone.
+ * We can't use getDate here as it becomes a circular issue.
+ * Returns a new Date instance.
+ */
+declare const getTimeZoned: (props: GetTimeZoned & {
+  input: Date;
+}) => Date;
+//#endregion
+export { getTimeZoned as n, timeZoneLondon as r, GetTimeZoned as t };

package/dist/global/forceUpdate.d.mts

@@ -0,0 +1,12 @@
+//#region src/global/forceUpdate.d.ts
+type ForceUpdate = {
+  key: string;
+};
+/**
+ * Force an update of the cached data
+ */
+declare const forceUpdate: ({
+  key
+}: ForceUpdate) => Promise<any>;
+//#endregion
+export { forceUpdate as default };

package/dist/global/forceUpdate.mjs

@@ -0,0 +1,16 @@
+//#region src/global/forceUpdate.ts
+/**
+* Force an update of the cached data
+*/
+const forceUpdate = 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 global["ems_cache"][key] = {
+		expires: global["ems_cache"][key].expires,
+		insertedAt: Date.now(),
+		updateFn: global["ems_cache"][key].updateFn,
+		value: await global["ems_cache"][key].updateFn()
+	};
+	return global["ems_cache"][key];
+};
+//#endregion
+export { forceUpdate as default };

package/dist/global/init.d.mts

@@ -0,0 +1,16 @@
+//#region src/global/init.d.ts
+type Init = {
+  expires: number;
+  key: string;
+  updateFn: Function;
+};
+/**
+ * Initialise a new global data.
+ */
+declare const init: ({
+  expires,
+  key,
+  updateFn
+}: Init) => Promise<any>;
+//#endregion
+export { init as default };