@8ms/helpers 2.2.26 → 2.3.3

package/brightData/server/brightData.js

@@ -0,0 +1,15 @@
+/**
+ * Return the Zone based on the username.
+ */
+export const getZone = (auth) => {
+    const segments = auth.username.split("-");
+    return segments[segments.length - 1];
+};
+/**
+ * Return the customer Id based on the username.
+ */
+export const getCustomerId = (auth, prefix) => {
+    const segments = auth.username.split("-")[2];
+    const customerId = segments[2].replace("hl_", "");
+    return (prefix || "") + customerId;
+};

package/brightData/server/index.d.ts

@@ -1,15 +1 @@
-export type Auth = {
-    apiKey: string;
-    host: string;
-    port: string;
-    username: string;
-    password: string;
-};
-/**
- * Return the Zone based on the username.
- */
-export declare const getZone: (auth: Auth) => string;
-/**
- * Return the customer Id based on the username.
- */
-export declare const getCustomerId: (auth: Auth, prefix?: string) => string;
+export * from "./brightData";

package/brightData/server/index.js

@@ -1,15 +1 @@
-/**
- * Return the Zone based on the username.
- */
-export const getZone = (auth) => {
-    const segments = auth.username.split("-");
-    return segments[segments.length - 1];
-};
-/**
- * Return the customer Id based on the username.
- */
-export const getCustomerId = (auth, prefix) => {
-    const segments = auth.username.split("-")[2];
-    const customerId = segments[2].replace("hl_", "");
-    return (prefix || "") + customerId;
-};
+export * from "./brightData";

package/brightData/webScraperIde/server/getRealtime.js

@@ -1,5 +1,5 @@
 import { get, post } from "../../../axios";
-import { ApiState } from "../../../api";
+import { apiState } from "../../../api";
 import { sleep } from "../../../util";
 /**
  * Depends on the Scraper setup!
@@ -17,8 +17,8 @@ export const getRealtime = async (auth, scraperId, data = {}) => {
     if (requestResponse.isSuccess()) {
         const responseId = requestResponse.getBodyDefaultTo(["response_id"], "");
         if ("" !== responseId) {
-            let state = ApiState.PENDING;
-            while (ApiState.PENDING === state) {
+            let state = apiState.PENDING;
+            while (apiState.PENDING === state) {
                 const resultUrl = `https://api.brightdata.com/dca/get_result?response_id=${responseId}`;
                 // Use fetch with the agent option to make an HTTP request through the proxy
                 // Replace <target_url> with the URL you want to request
@@ -30,10 +30,10 @@ export const getRealtime = async (auth, scraperId, data = {}) => {
                 if (resultResponse.isSuccess()) {
                     if (undefined !== resultResponse.body.pending &&
                         true === resultResponse.body.pending) {
-                        state = ApiState.PENDING;
+                        state = apiState.PENDING;
                     }
                     else {
-                        state = ApiState.SUCCESS;
+                        state = apiState.SUCCESS;
                         response = resultResponse.getBody();
                     }
                 }

package/brightData/webScraperIde/server/index.d.ts

@@ -1,2 +1,2 @@
-export { getBatch } from "./getBatch";
-export { getRealtime } from "./getRealtime";
+export * from "./getBatch";
+export * from "./getRealtime";

package/brightData/webScraperIde/server/index.js

@@ -1,2 +1,2 @@
-export { getBatch } from "./getBatch";
-export { getRealtime } from "./getRealtime";
+export * from "./getBatch";
+export * from "./getRealtime";

package/cache/server/cache.d.ts

@@ -0,0 +1,7 @@
+export type CacheEntry = {
+    data: any;
+    expires: number;
+    insertedAt: number;
+};
+export declare const getCache: (key: string) => any;
+export declare const setCache: (key: string, data: any, expires?: number, force?: boolean) => any;

package/cache/server/cache.js

@@ -0,0 +1,43 @@
+const cache = new Map();
+export const getCache = (key) => {
+    let response = null;
+    if (cache.has(key)) {
+        const cacheItem = cache.get(key);
+        // Timed expiry
+        if (cacheItem.expires > 0) {
+            // https://ui.dev/get-current-timestamp-javascript
+            const expiresAt = Math.floor(cacheItem.insertedAt / 1000) + cacheItem.expires;
+            const now = Math.floor(Date.now() / 1000);
+            // If we are now beyond the expiry date, update the data
+            if (now < expiresAt) {
+                response = cacheItem;
+            }
+        }
+        // 0 - Never expires
+        else {
+            response = cacheItem;
+        }
+    }
+    return response;
+};
+export const setCache = (key, data, expires = 0, force = false) => {
+    const now = Math.floor(Date.now() / 1000);
+    if (cache.has(key) && !force) {
+        const cacheItem = cache.get(key);
+        // 0 - Never expires
+        if (cacheItem.expires > 0) {
+            // https://ui.dev/get-current-timestamp-javascript
+            const expiresAt = Math.floor(cacheItem.insertedAt / 1000) + cacheItem.expires;
+            // If we are now beyond the expiry date, update the data
+            if (now < expiresAt) {
+                return cacheItem;
+            }
+        }
+    }
+    cache.set(key, {
+        data,
+        expires,
+        insertedAt: now,
+    });
+    return data;
+};

package/cache/server/index.d.ts

@@ -1,7 +1 @@
-export type CacheEntry = {
-    data: any;
-    expires: number;
-    insertedAt: number;
-};
-export declare const getCache: (key: string) => any;
-export declare const setCache: (key: string, data: any, expires?: number, force?: boolean) => any;
+export * from "./cache";

package/cache/server/index.js

@@ -1,43 +1 @@
-const cache = new Map();
-export const getCache = (key) => {
-    let response = null;
-    if (cache.has(key)) {
-        const cacheItem = cache.get(key);
-        // Timed expiry
-        if (cacheItem.expires > 0) {
-            // https://ui.dev/get-current-timestamp-javascript
-            const expiresAt = Math.floor(cacheItem.insertedAt / 1000) + cacheItem.expires;
-            const now = Math.floor(Date.now() / 1000);
-            // If we are now beyond the expiry date, update the data
-            if (now < expiresAt) {
-                response = cacheItem;
-            }
-        }
-        // 0 - Never expires
-        else {
-            response = cacheItem;
-        }
-    }
-    return response;
-};
-export const setCache = (key, data, expires = 0, force = false) => {
-    const now = Math.floor(Date.now() / 1000);
-    if (cache.has(key) && !force) {
-        const cacheItem = cache.get(key);
-        // 0 - Never expires
-        if (cacheItem.expires > 0) {
-            // https://ui.dev/get-current-timestamp-javascript
-            const expiresAt = Math.floor(cacheItem.insertedAt / 1000) + cacheItem.expires;
-            // If we are now beyond the expiry date, update the data
-            if (now < expiresAt) {
-                return cacheItem;
-            }
-        }
-    }
-    cache.set(key, {
-        data,
-        expires,
-        insertedAt: now,
-    });
-    return data;
-};
+export * from "./cache";

package/crud/crud.d.ts

@@ -0,0 +1,7 @@
+export declare const crudState: {
+    readonly CREATE: "CREATE";
+    readonly READ: "READ";
+    readonly UPDATE: "UPDATE";
+    readonly DELETE: "DELETE";
+};
+export type CrudState = typeof crudState[keyof typeof crudState];

package/crud/crud.js

@@ -0,0 +1,6 @@
+export const crudState = {
+    CREATE: "CREATE",
+    READ: "READ",
+    UPDATE: "UPDATE",
+    DELETE: "DELETE",
+};

package/crud/index.d.ts

@@ -1,7 +1 @@
-export declare const CrudState: {
-    readonly CREATE: "CREATE";
-    readonly READ: "READ";
-    readonly UPDATE: "UPDATE";
-    readonly DELETE: "DELETE";
-};
-export type CrudState = typeof CrudState[keyof typeof CrudState];
+export * from "./crud";

package/crud/index.js

@@ -1,6 +1 @@
-export const CrudState = {
-    CREATE: "CREATE",
-    READ: "READ",
-    UPDATE: "UPDATE",
-    DELETE: "DELETE",
-};
+export * from "./crud";

package/crypto/index.d.ts

@@ -1,4 +1,4 @@
-export { getDecrypt } from "./getDecrypt";
-export { getEncrypt } from "./getEncrypt";
-export { getRandom } from "./getRandom";
-export { getSha256 } from "./getSha256";
+export * from "./getDecrypt";
+export * from "./getEncrypt";
+export * from "./getRandom";
+export * from "./getSha256";

package/crypto/index.js

@@ -1,4 +1,4 @@
-export { getDecrypt } from "./getDecrypt";
-export { getEncrypt } from "./getEncrypt";
-export { getRandom } from "./getRandom";
-export { getSha256 } from "./getSha256";
+export * from "./getDecrypt";
+export * from "./getEncrypt";
+export * from "./getRandom";
+export * from "./getSha256";

package/date/calculation.d.ts

@@ -1,5 +1,8 @@
 import { DateTime } from "luxon";
-import { InputDate, Timeframe } from "./type";
+import { InputDate, Timeframe } from "./date";
+/**
+ * Return unix timestamp in seconds.
+ */
 export declare const getUnix: (input?: InputDate) => number;
 /**
  * Assume the input is always UTC.

package/date/calculation.js

@@ -1,4 +1,7 @@
 import { DateTime, Interval } from "luxon";
+/**
+ * Return unix timestamp in seconds.
+ */
 export const getUnix = (input) => {
     return getLuxonDate(input)
         .toUnixInteger();

package/date/{type.d.ts → date.d.ts}

@@ -19,7 +19,7 @@ export declare const defaultDateTime: "1901-01-01 00:00:00";
 /**
  * Used by Google Ads API.
  */
-export declare const Month: {
+export declare const month: {
     readonly JANUARY: "JANUARY";
     readonly FEBRUARY: "FEBRUARY";
     readonly MARCH: "MARCH";
@@ -33,4 +33,4 @@ export declare const Month: {
     readonly NOVEMBER: "NOVEMBER";
     readonly DECEMBER: "DECEMBER";
 };
-export type Month = typeof Month[keyof typeof Month];
+export type Month = typeof month[keyof typeof month];

package/date/{type.js → date.js}

@@ -4,7 +4,7 @@ export const defaultDateTime = "1901-01-01 00:00:00";
 /**
  * Used by Google Ads API.
  */
-export const Month = {
+export const month = {
     JANUARY: "JANUARY",
     FEBRUARY: "FEBRUARY",
     MARCH: "MARCH",

package/date/financialYear.d.ts

@@ -1,7 +1,7 @@
-import { Timeframe } from "./type";
+import { Timeframe } from "./date";
 import { Interval } from "luxon";
 /**
- * Get the current financial year.
+ * Get the financial year based on an optional year.
  */
 export declare const getFinancialYear: (year?: number) => Timeframe;
 /**

package/date/financialYear.js

@@ -1,7 +1,7 @@
 import { getLuxonDate, getToday, getYesterday } from "./calculation";
 import { Interval } from "luxon";
 /**
- * Get the current financial year.
+ * Get the financial year based on an optional year.
  */
 export const getFinancialYear = (year) => {
     // Either use the current year or a specified year

package/date/format.d.ts

@@ -1,4 +1,4 @@
-import { InputDate } from "./type";
+import { InputDate } from "./date";
 import { DateTime } from "luxon";
 /**
  * Convert a number of seconds into HH:MM:SS

package/date/index.d.ts

@@ -1,4 +1,4 @@
-export * from "./type";
+export * from "./date";
 export * from "./calculation";
 export * from "./financialYear";
 export * from "./format";

package/date/index.js

@@ -1,4 +1,4 @@
-export * from "./type";
+export * from "./date";
 export * from "./calculation";
 export * from "./financialYear";
 export * from "./format";

package/environment/environment.d.ts

@@ -0,0 +1,34 @@
+export declare const environment: {
+    readonly DEVELOPMENT: "development";
+    readonly STAGING: "staging";
+    readonly PRODUCTION: "production";
+};
+export type Environment = typeof environment[keyof typeof environment];
+export declare const platform: {
+    readonly AWS: "AWS";
+    readonly VERCEL: "VERCEL";
+};
+export type Platform = typeof platform[keyof typeof platform];
+/**
+ * Determine the environment we're using.
+ */
+export declare const getEnvironment: () => Environment;
+/**
+ * Check to see if we are working on AWS Lambda.
+ */
+export declare const isAws: () => boolean;
+export declare const isVercel: () => boolean;
+/**
+ * Some code should only run on the server side to protect the data.
+ */
+export declare const isServer: boolean;
+/**
+ * Check the environment currently running.
+ */
+export declare const isDevelopment: () => boolean;
+export declare const isStaging: () => boolean;
+export declare const isProduction: () => boolean;
+/**
+ * Check to see if we are developing locally or on the hosted platform.
+ */
+export declare const isLocalhost: () => boolean;

package/environment/environment.js

@@ -0,0 +1,79 @@
+export const environment = {
+    DEVELOPMENT: "development",
+    STAGING: "staging",
+    PRODUCTION: "production",
+};
+export const platform = {
+    AWS: "AWS",
+    VERCEL: "VERCEL",
+};
+/**
+ * Determine the environment we're using.
+ */
+export const getEnvironment = () => {
+    let platformEnvironment = process.env.ENVIRONMENT;
+    let response;
+    // Custom - Backend/AWS
+    if (process.env.EMS_ENVIRONMENT) {
+        platformEnvironment = process.env.EMS_ENVIRONMENT;
+    }
+    // Custom - Frontend
+    else if (process.env.NEXT_PUBLIC_EMS_ENVIRONMENT) {
+        platformEnvironment = process.env.NEXT_PUBLIC_EMS_ENVIRONMENT;
+    }
+    // Vercel - Frontend
+    else if (process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF) {
+        platformEnvironment = process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF;
+    }
+    // Vercel - Backend
+    else if (process.env.VERCEL_GIT_COMMIT_REF) {
+        platformEnvironment = process.env.VERCEL_GIT_COMMIT_REF;
+    }
+    const platformEnvironmentClean = platformEnvironment
+        .toLowerCase()
+        .trim();
+    switch (platformEnvironmentClean) {
+        case "production":
+            response = environment.PRODUCTION;
+            break;
+        case "demo":
+        case "preview":
+        case "staging":
+            response = environment.STAGING;
+            break;
+        default:
+            response = environment.DEVELOPMENT;
+    }
+    return response;
+};
+/**
+ * Check to see if we are working on AWS Lambda.
+ */
+export const isAws = () => platform.AWS === process.env["EMS_PLATFORM"];
+export const isVercel = () => undefined !== process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF;
+/**
+ * Some code should only run on the server side to protect the data.
+ */
+export const isServer = typeof window === "undefined";
+/**
+ * Check the environment currently running.
+ */
+export const isDevelopment = () => environment.DEVELOPMENT === getEnvironment();
+export const isStaging = () => environment.STAGING === getEnvironment();
+export const isProduction = () => environment.PRODUCTION === getEnvironment();
+/**
+ * Check to see if we are developing locally or on the hosted platform.
+ */
+export const isLocalhost = () => {
+    if ("true" === process.env["IS_LOCAL"]) {
+        return true;
+    }
+    if (isAws()) {
+        return "true" === process.env["AWS_SAM_LOCAL"];
+    }
+    // This value needs to only be included in Vercel but undefined in locally
+    if (isVercel()) {
+        return undefined === process.env["NEXT_PUBLIC_VERCEL_GIT_REPO_ID"];
+    }
+    return false;
+};

package/environment/index.d.ts

@@ -1,34 +1 @@
-export declare const Environment: {
-    readonly DEVELOPMENT: "development";
-    readonly STAGING: "staging";
-    readonly PRODUCTION: "production";
-};
-export type Environment = typeof Environment[keyof typeof Environment];
-export declare const Platform: {
-    readonly AWS: "AWS";
-    readonly VERCEL: "VERCEL";
-};
-export type Platform = typeof Platform[keyof typeof Platform];
-/**
- * Determine the environment we're using.
- */
-export declare const getEnvironment: () => Environment;
-/**
- * Check to see if we are working on AWS Lambda.
- */
-export declare const isAws: () => boolean;
-export declare const isVercel: () => boolean;
-/**
- * Some code should only run on the server side to protect the data.
- */
-export declare const isServer: boolean;
-/**
- * Check the environment currently running.
- */
-export declare const isDevelopment: () => boolean;
-export declare const isStaging: () => boolean;
-export declare const isProduction: () => boolean;
-/**
- * Check to see if we are developing locally or on the hosted platform.
- */
-export declare const isLocalhost: () => boolean;
+export * from "./environment";

package/environment/index.js

@@ -1,79 +1 @@
-export const Environment = {
-    DEVELOPMENT: "development",
-    STAGING: "staging",
-    PRODUCTION: "production",
-};
-export const Platform = {
-    AWS: "AWS",
-    VERCEL: "VERCEL",
-};
-/**
- * Determine the environment we're using.
- */
-export const getEnvironment = () => {
-    let platformEnvironment = process.env.ENVIRONMENT;
-    let response;
-    // Custom - Backend/AWS
-    if (process.env.EMS_ENVIRONMENT) {
-        platformEnvironment = process.env.EMS_ENVIRONMENT;
-    }
-    // Custom - Frontend
-    else if (process.env.NEXT_PUBLIC_EMS_ENVIRONMENT) {
-        platformEnvironment = process.env.NEXT_PUBLIC_EMS_ENVIRONMENT;
-    }
-    // Vercel - Frontend
-    else if (process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF) {
-        platformEnvironment = process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF;
-    }
-    // Vercel - Backend
-    else if (process.env.VERCEL_GIT_COMMIT_REF) {
-        platformEnvironment = process.env.VERCEL_GIT_COMMIT_REF;
-    }
-    const platformEnvironmentClean = platformEnvironment
-        .toLowerCase()
-        .trim();
-    switch (platformEnvironmentClean) {
-        case "production":
-            response = Environment.PRODUCTION;
-            break;
-        case "demo":
-        case "preview":
-        case "staging":
-            response = Environment.STAGING;
-            break;
-        default:
-            response = Environment.DEVELOPMENT;
-    }
-    return response;
-};
-/**
- * Check to see if we are working on AWS Lambda.
- */
-export const isAws = () => Platform.AWS === process.env["EMS_PLATFORM"];
-export const isVercel = () => undefined !== process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF;
-/**
- * Some code should only run on the server side to protect the data.
- */
-export const isServer = typeof window === "undefined";
-/**
- * Check the environment currently running.
- */
-export const isDevelopment = () => Environment.DEVELOPMENT === getEnvironment();
-export const isStaging = () => Environment.STAGING === getEnvironment();
-export const isProduction = () => Environment.PRODUCTION === getEnvironment();
-/**
- * Check to see if we are developing locally or on the hosted platform.
- */
-export const isLocalhost = () => {
-    if ("true" === process.env["IS_LOCAL"]) {
-        return true;
-    }
-    if (isAws()) {
-        return "true" === process.env["AWS_SAM_LOCAL"];
-    }
-    // This value needs to only be included in Vercel but undefined in locally
-    if (isVercel()) {
-        return undefined === process.env["NEXT_PUBLIC_VERCEL_GIT_REPO_ID"];
-    }
-    return false;
-};
+export * from "./environment";

package/eskimi/eskimi.d.ts

@@ -0,0 +1,49 @@
+import { z } from "zod/v4";
+/**
+ * https://dsp-api.eskimi.com/docs/api/v1/#api-Report-GetCampaignReportByAgeGroups
+ */
+export declare const endpoints: {
+    campaign: {
+        age: string;
+        gender: string;
+        list: string;
+        performance: string;
+        video: string;
+    };
+    site: {
+        list: string;
+    };
+};
+declare const campaignSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    name: z.ZodString;
+    type: z.ZodNumber;
+    user_id: z.ZodNumber;
+    ad_domain: z.ZodString;
+    click_url: z.ZodString;
+    bid: z.ZodString;
+    budget: z.ZodAny;
+    dates: z.ZodAny;
+    creative_set_ids: z.ZodAny;
+    audience_ids: z.ZodAny;
+    ad_placement_type_ids: z.ZodAny;
+    ad_placement_position_ids: z.ZodAny;
+    operator_ids: z.ZodAny;
+    devices: z.ZodAny;
+    auto_start: z.ZodNumber;
+    created_at: z.ZodString;
+}, z.core.$strip>;
+export type CampaignSchemaType = z.infer<typeof campaignSchema>;
+export declare const ageGroups: {
+    id: number;
+    name: string;
+}[];
+export declare const devices: {
+    id: number;
+    name: string;
+}[];
+export declare const genders: {
+    id: number;
+    name: string;
+}[];
+export {};