@8ms/helpers 2.3.2 → 2.3.3

package/api/ApiResponseClass.js

@@ -1,16 +1,16 @@
 import { defaultTo } from "../util";
-import { ApiState } from "./api";
+import { apiState } from "./api";
 /**
  * Class version of the API to enable quicker instances.
  */
 export class ApiResponseClass {
-    state = ApiState.IDLE;
+    state = apiState.IDLE;
     body = null;
     error = null;
     constructor({ body, error, state } = {}) {
         this.body = body || null;
         this.error = error || null;
-        this.state = state || ApiState.IDLE;
+        this.state = state || apiState.IDLE;
         return this;
     }
     fromJson = (input) => {
@@ -39,34 +39,34 @@ export class ApiResponseClass {
         return this.state;
     };
     isError = () => {
-        return this.state === ApiState.ERROR;
+        return this.state === apiState.ERROR;
     };
     isIdle = () => {
-        return this.state === ApiState.IDLE;
+        return this.state === apiState.IDLE;
     };
     isPending = () => {
-        return this.state === ApiState.PENDING;
+        return this.state === apiState.PENDING;
     };
     isSuccess = () => {
-        return this.state === ApiState.SUCCESS;
+        return this.state === apiState.SUCCESS;
     };
     setToIdle = () => {
-        this.state = ApiState.IDLE;
+        this.state = apiState.IDLE;
         return this;
     };
     setToPending = () => {
-        this.state = ApiState.PENDING;
+        this.state = apiState.PENDING;
         return this;
     };
     setToError = (error, body) => {
         this.body = body || null;
         this.error = error;
-        this.state = ApiState.ERROR;
+        this.state = apiState.ERROR;
         return this;
     };
     setToSuccess = (body) => {
         this.body = body;
-        this.state = ApiState.SUCCESS;
+        this.state = apiState.SUCCESS;
         return this;
     };
     setBody = (body) => {
@@ -87,7 +87,7 @@ export class ApiResponseClass {
             return new ApiResponseClass({ body: validatedBody, state: this.state });
         }
         catch (error) {
-            return new ApiResponseClass({ error, state: ApiState.ERROR });
+            return new ApiResponseClass({ error, state: apiState.ERROR });
         }
     };
 }

package/api/api.d.ts

@@ -1,5 +1,5 @@
 export { ApiResponseClass } from "./ApiResponseClass";
-export declare const ApiState: {
+export declare const apiState: {
     readonly CANCELLED: "CANCELLED";
     readonly ERROR: "ERROR";
     readonly IDLE: "IDLE";
@@ -7,7 +7,7 @@ export declare const ApiState: {
     readonly SUCCESS: "SUCCESS";
     readonly VALIDATION_ERROR: "VALIDATION_ERROR";
 };
-export type ApiState = typeof ApiState[keyof typeof ApiState];
+export type ApiState = typeof apiState[keyof typeof apiState];
 export type ApiResponse<T = any, E = any> = {
     body: T | null;
     error: E | null;

package/api/api.js

@@ -1,5 +1,5 @@
 export { ApiResponseClass } from "./ApiResponseClass";
-export const ApiState = {
+export const apiState = {
     CANCELLED: "CANCELLED",
     ERROR: "ERROR",
     IDLE: "IDLE",
@@ -10,6 +10,6 @@ export const ApiState = {
 export const defaultResponse = {
     body: null,
     error: null,
-    state: ApiState.IDLE,
+    state: apiState.IDLE,
 };
 export const unexpectedError = "An unexpected error occurred, please try again.";

package/api/functions.js

@@ -1,19 +1,19 @@
-import { ApiState } from "./api";
+import { apiState } from "./api";
 export const isCancelled = (apiResponse) => {
-    return ApiState.CANCELLED === apiResponse.state;
+    return apiState.CANCELLED === apiResponse.state;
 };
 export const isError = (apiResponse) => {
-    return ApiState.ERROR === apiResponse.state;
+    return apiState.ERROR === apiResponse.state;
 };
 export const isIdle = (apiResponse) => {
-    return ApiState.IDLE === apiResponse.state;
+    return apiState.IDLE === apiResponse.state;
 };
 export const isPending = (apiResponse) => {
-    return ApiState.PENDING === apiResponse.state;
+    return apiState.PENDING === apiResponse.state;
 };
 export const isSuccess = (apiResponse) => {
-    return ApiState.SUCCESS === apiResponse.state;
+    return apiState.SUCCESS === apiResponse.state;
 };
 export const isValidationError = (apiResponse) => {
-    return ApiState.VALIDATION_ERROR === apiResponse.state;
+    return apiState.VALIDATION_ERROR === apiResponse.state;
 };

package/brightData/serpApi/server/brightDataSerpApi.d.ts

@@ -1,4 +1,4 @@
-export declare const BrightDataSerpApiType: {
+export declare const brightDataSerpApiType: {
     readonly GOOGLE_FLIGHTS: "GOOGLE_FLIGHTS";
     readonly GOOGLE_HOTELS: "GOOGLE_HOTELS";
     readonly GOOGLE_LENS: "GOOGLE_LENS";
@@ -7,4 +7,4 @@ export declare const BrightDataSerpApiType: {
     readonly GOOGLE_SEARCH: "GOOGLE_SEARCH";
     readonly GOOGLE_TRENDS: "GOOGLE_TRENDS";
 };
-export type BrightDataSerpApiType = typeof BrightDataSerpApiType[keyof typeof BrightDataSerpApiType];
+export type BrightDataSerpApiType = typeof brightDataSerpApiType[keyof typeof brightDataSerpApiType];

package/brightData/serpApi/server/brightDataSerpApi.js

@@ -1,4 +1,4 @@
-export const BrightDataSerpApiType = {
+export const brightDataSerpApiType = {
     GOOGLE_FLIGHTS: "GOOGLE_FLIGHTS",
     GOOGLE_HOTELS: "GOOGLE_HOTELS",
     GOOGLE_LENS: "GOOGLE_LENS",

package/brightData/serpApi/server/getAsyncRequestId.js

@@ -1,6 +1,6 @@
 import { post } from "../../../axios";
 import { getCustomerId, getZone } from "../../server";
-import { BrightDataSerpApiType } from "../server";
+import { brightDataSerpApiType } from "../server";
 /**
  * Make an async request to the SERP API using the Bright Data proxy.
  * Returns a request ID used with getAsyncResults
@@ -14,7 +14,7 @@ export const getAsyncRequestId = async (auth, data = {}, type) => {
     const customerId = getCustomerId(auth);
     const zone = getZone(auth);
     switch (type) {
-        case BrightDataSerpApiType.GOOGLE_TRENDS:
+        case brightDataSerpApiType.GOOGLE_TRENDS:
             url = `https://api.brightdata.com/serp/trends?customer=${customerId}&zone=${zone}`;
             break;
         default:

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/crud/crud.d.ts

@@ -1,7 +1,7 @@
-export declare const CrudState: {
+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 type CrudState = typeof crudState[keyof typeof crudState];

package/crud/crud.js

@@ -1,4 +1,4 @@
-export const CrudState = {
+export const crudState = {
     CREATE: "CREATE",
     READ: "READ",
     UPDATE: "UPDATE",

package/date/calculation.d.ts

@@ -1,5 +1,8 @@
 import { DateTime } from "luxon";
 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/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/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 "./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/environment/environment.d.ts

@@ -1,14 +1,14 @@
-export declare const Environment: {
+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: {
+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];
+export type Platform = typeof platform[keyof typeof platform];
 /**
  * Determine the environment we're using.
  */

package/environment/environment.js

@@ -1,9 +1,9 @@
-export const Environment = {
+export const environment = {
     DEVELOPMENT: "development",
     STAGING: "staging",
     PRODUCTION: "production",
 };
-export const Platform = {
+export const platform = {
     AWS: "AWS",
     VERCEL: "VERCEL",
 };
@@ -34,22 +34,22 @@ export const getEnvironment = () => {
         .trim();
     switch (platformEnvironmentClean) {
         case "production":
-            response = Environment.PRODUCTION;
+            response = environment.PRODUCTION;
             break;
         case "demo":
         case "preview":
         case "staging":
-            response = Environment.STAGING;
+            response = environment.STAGING;
             break;
         default:
-            response = Environment.DEVELOPMENT;
+            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 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.
@@ -58,9 +58,9 @@ 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();
+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.
  */

package/file/getFileKey.js

@@ -1,5 +1,5 @@
 import { DateTime } from "luxon";
-import { format } from "../date";
+import { getYmdString } from "../date";
 /**
  * Create a file key from the inputs so it can handle objects/number/etc.
  */
@@ -13,7 +13,7 @@ export const getFileKey = (inputs) => {
             response += inputs[i];
         }
         else if (inputs[i] instanceof Date || inputs[i] instanceof DateTime) {
-            response += format(inputs[i], "YYYY-MM-DD");
+            response += getYmdString(inputs[i]);
         }
         else {
             response += JSON.stringify(inputs[i]);

package/googleAds/keywordPlanner/server/googleAdsKeywordPlanner.d.ts

@@ -1,9 +1,9 @@
 import { z } from "zod/v4";
-export declare const Network: {
+export declare const network: {
     readonly GOOGLE_SEARCH_ONLY: 2;
     readonly GOOGLE_SEARCH_AND_PARTNERS: 3;
 };
-export type Network = typeof Network[keyof typeof Network];
+export type Network = typeof network[keyof typeof network];
 export declare const requestSchema: z.ZodObject<{
     countries: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
     customerId: z.ZodOptional<z.ZodString>;

package/googleAds/keywordPlanner/server/googleAdsKeywordPlanner.js

@@ -1,5 +1,5 @@
 import { z } from "zod/v4";
-export const Network = {
+export const network = {
     GOOGLE_SEARCH_ONLY: 2,
     GOOGLE_SEARCH_AND_PARTNERS: 3,
 };
@@ -31,7 +31,7 @@ export const defaultRequest = {
     customerId: "",
     historicalMetricsOptions: null,
     includeAdultKeywords: false,
-    keywordPlanNetwork: Network.GOOGLE_SEARCH_ONLY,
+    keywordPlanNetwork: network.GOOGLE_SEARCH_ONLY,
     queries: [],
     language: null,
 };

package/googleAds/server/GoogleAdsNamespace.js

@@ -21,11 +21,10 @@ export class GoogleAdsNamespace extends BaseNamespace {
     };
     getCustomer = async (customerId) => {
         await this.ensureInit();
-        const customer = this.client.Customer({
+        return this.client.Customer({
             customer_id: customerId,
             login_customer_id: this.mccAccountId,
             refresh_token: this.refreshToken,
         });
-        return customer;
     };
 }

package/googlePageSpeed/server/GooglePageSpeedNamespace.d.ts

@@ -7,5 +7,5 @@ export declare class GooglePageSpeedNamespace extends BaseNamespace {
     client: boolean;
     config: GooglePageSpeedConfig;
     ensureInit: () => Promise<void>;
-    getReport: (url: string, category?: Category, strategy?: Strategy) => Promise<any>;
+    getReport: (url: string, inputCategory?: Category, inputStrategy?: Strategy) => Promise<any>;
 }

package/googlePageSpeed/server/GooglePageSpeedNamespace.js

@@ -1,5 +1,5 @@
 import { BaseNamespace } from "../../_class";
-import { Category, Strategy } from "./";
+import { category, strategy } from "./";
 import { get } from "../../axios";
 /**
  * Based on https://developers.google.com/speed/docs/insights/rest/v5/pagespeedapi/runpagespeed
@@ -16,8 +16,8 @@ export class GooglePageSpeedNamespace extends BaseNamespace {
             }
         }
     };
-    getReport = async (url, category = Category.PERFORMANCE, strategy = Strategy.MOBILE) => {
-        const requestUrl = `https://www.googleapis.com/pagespeedonline/v5/runPagespeed?url=${url}&strategy=${strategy}&category=${category}&key=${this.config.apiKey}`;
+    getReport = async (url, inputCategory = category.PERFORMANCE, inputStrategy = strategy.MOBILE) => {
+        const requestUrl = `https://www.googleapis.com/pagespeedonline/v5/runPagespeed?url=${url}&strategy=${inputStrategy}&category=${inputCategory}&key=${this.config.apiKey}`;
         const apiResponse = await get(requestUrl);
         if (apiResponse.isSuccess()) {
             return apiResponse.getBody();

package/googlePageSpeed/server/googlePageSpeed.d.ts

@@ -3,17 +3,17 @@ export type GooglePageSpeedConfig = {
     apiKey: string;
 };
 export declare const googlePageSpeedClient: (key?: string, config?: GooglePageSpeedConfig, vaultId?: string, itemId?: string) => Promise<GooglePageSpeedNamespace>;
-export declare const Category: {
+export declare const category: {
     readonly CATEGORY_UNSPECIFIED: "CATEGORY_UNSPECIFIED";
     readonly ACCESSIBILITY: "ACCESSIBILITY";
     readonly BEST_PRACTICES: "BEST_PRACTICES";
     readonly PERFORMANCE: "PERFORMANCE";
     readonly SEO: "SEO";
 };
-export type Category = typeof Category[keyof typeof Category];
-export declare const Strategy: {
+export type Category = typeof category[keyof typeof category];
+export declare const strategy: {
     readonly STRATEGY_UNSPECIFIED: "STRATEGY_UNSPECIFIED";
     readonly DESKTOP: "DESKTOP";
     readonly MOBILE: "MOBILE";
 };
-export type Strategy = typeof Strategy[keyof typeof Strategy];
+export type Strategy = typeof strategy[keyof typeof strategy];

package/googlePageSpeed/server/googlePageSpeed.js

@@ -24,14 +24,14 @@ export const googlePageSpeedClient = async (key = "default", config, vaultId, it
     googlePageSpeedNamespaces.set(key, namespace);
     return namespace;
 };
-export const Category = {
+export const category = {
     CATEGORY_UNSPECIFIED: "CATEGORY_UNSPECIFIED",
     ACCESSIBILITY: "ACCESSIBILITY",
     BEST_PRACTICES: "BEST_PRACTICES",
     PERFORMANCE: "PERFORMANCE",
     SEO: "SEO",
 };
-export const Strategy = {
+export const strategy = {
     STRATEGY_UNSPECIFIED: "STRATEGY_UNSPECIFIED",
     DESKTOP: "DESKTOP",
     MOBILE: "MOBILE",

package/inngest/inngest.d.ts

@@ -1,7 +1,7 @@
-export declare const InngestState: {
+export declare const inngestState: {
     RUNNING: string;
     COMPLETED: string;
     FAILED: string;
     CANCELLED: string;
 };
-export type InngestState = typeof InngestState[keyof typeof InngestState];
+export type InngestState = typeof inngestState[keyof typeof inngestState];

package/inngest/inngest.js

@@ -1,4 +1,4 @@
-export const InngestState = {
+export const inngestState = {
     RUNNING: "Running",
     COMPLETED: "Completed",
     FAILED: "Failed",

package/littleWarden/server/littleWarden.d.ts

@@ -3,12 +3,12 @@ export type LittleWardenConfig = {
     apiKey: string;
 };
 export declare const littleWardenClient: (key?: string, config?: LittleWardenConfig, vaultId?: string, itemId?: string) => Promise<LittleWardenNamespace>;
-export declare const LittleWardenState: {
+export declare const littleWardenState: {
     readonly ALL_GOOD: "all_good";
     readonly DANGER: "danger";
     readonly WARNING: "warning";
 };
-export type LittleWardenState = typeof LittleWardenState[keyof typeof LittleWardenState];
+export type LittleWardenState = typeof littleWardenState[keyof typeof littleWardenState];
 /**
  * Check if the field is All Good.
  */

package/littleWarden/server/littleWarden.js

@@ -24,7 +24,7 @@ export const littleWardenClient = async (key = "default", config, vaultId, itemI
     littleWardenNamespaces.set(key, namespace);
     return namespace;
 };
-export const LittleWardenState = {
+export const littleWardenState = {
     ALL_GOOD: "all_good",
     DANGER: "danger",
     WARNING: "warning",
@@ -36,7 +36,7 @@ export const isAllGood = ({ field }) => {
     let response = false;
     // Check that the status field exists
     if (undefined !== field && undefined !== field["status"]) {
-        response = LittleWardenState.ALL_GOOD === field["status"];
+        response = littleWardenState.ALL_GOOD === field["status"];
     }
     return response;
 };
@@ -47,7 +47,7 @@ export const isWarning = ({ field }) => {
     let response = false;
     // Check that the status field exists
     if (undefined !== field && undefined !== field["status"]) {
-        response = LittleWardenState.WARNING === field["status"];
+        response = littleWardenState.WARNING === field["status"];
     }
     return response;
 };
@@ -58,7 +58,7 @@ export const isDanger = ({ field }) => {
     let response = false;
     // Check that the status field exists
     if (undefined !== field && undefined !== field["status"]) {
-        response = LittleWardenState.DANGER === field["status"];
+        response = littleWardenState.DANGER === field["status"];
     }
     return response;
 };

package/lumar/api/server/buildRequest.d.ts

@@ -1,13 +1,13 @@
-import { Filter, Order } from "./";
+import { Filter, OrderRow, Report } from "./";
 export type BuildRequestProps = {
     crawlId?: number;
     customPath?: string;
     filters?: Filter[];
     limit?: number;
-    orders?: Order[];
+    orders?: OrderRow[];
     page?: number;
     projectId?: number;
-    report?: string;
+    report?: Report;
     subReport?: string;
 };
 export declare const buildRequest: (props: BuildRequestProps) => string;

package/lumar/api/server/buildRequest.js

@@ -1,4 +1,4 @@
-import { orders, reports } from "./";
+import { order, report } from "./";
 export const buildRequest = (props) => {
     let url = `https://api.deepcrawl.com/accounts/37204`;
     // Limit must be greater than 0 but also less than 200
@@ -15,35 +15,35 @@ export const buildRequest = (props) => {
         props.limit = 200;
     }
     // If a report other than List Crawls is selected, Crawl ID must be defined
-    if (undefined !== props.report && reports.LIST_CRAWLS !== props.report && undefined == props.crawlId) {
+    if (undefined !== props.report && report.LIST_CRAWLS !== props.report && undefined == props.crawlId) {
         throw `Crawl ID must be defined.`;
     }
     switch (props.report) {
-        case reports.LIST_CRAWLS:
+        case report.LIST_CRAWLS:
             url += `/projects/${props.projectId}/crawls`;
             break;
-        case reports.LIST_PROJECTS:
+        case report.LIST_PROJECTS:
             url += `/projects`;
             break;
-        case reports.CUSTOM:
+        case report.CUSTOM:
             url += props.customPath;
             url = url.replace("[PROJECT]", props.projectId.toString());
             url = url.replace("[CRAWL]", props.crawlId.toString());
             break;
-        case reports.CRAWL_STATISTICS:
+        case report.CRAWL_STATISTICS:
             url += `/projects/${props.projectId}/crawls/${props.crawlId}/statistics`;
             break;
-        case reports.LIST_REPORTS:
+        case report.LIST_REPORTS:
             url += `/projects/${props.projectId}/crawls/${props.crawlId}/reports`;
             break;
-        case reports.REPORT_ROWS:
-        case reports.REPORT_STATISTICS:
-        case reports.REPORT_SUMMARY:
+        case report.REPORT_ROWS:
+        case report.REPORT_STATISTICS:
+        case report.REPORT_SUMMARY:
             url += `/projects/${props.projectId}/crawls/${props.crawlId}/reports/${props.subReport}`;
-            if (reports.REPORT_ROWS === props.report) {
+            if (report.REPORT_ROWS === props.report) {
                 url += `/report_rows`;
             }
-            else if (reports.REPORT_STATISTICS === props.report) {
+            else if (report.REPORT_STATISTICS === props.report) {
                 url += `/statistics`;
             }
             break;
@@ -66,10 +66,10 @@ export const buildRequest = (props) => {
     // Order the data
     if (undefined !== props.orders) {
         url += -1 === url.indexOf("?") ? "?" : "&";
-        props.orders.map((order, index) => {
+        props.orders.map((orderRow, index) => {
             url += 0 === index ? "sort=" : ",";
-            url += orders.DESCENDING === order.direction ? "-" : "";
-            url += order.field;
+            url += order.DESCENDING === orderRow.direction ? "-" : "";
+            url += orderRow.field;
         });
     }
     return url;

package/lumar/api/server/lumarApi.d.ts

@@ -3,34 +3,34 @@ export type Filter = {
     operand: string;
     value: string;
 };
-export declare const operands: {
-    EQUALS: string;
-    CONTAINS: string;
-    LESS_THAN: string;
-    LESS_THAN_OR_EQUAL: string;
-    GREATER_THAN: string;
-    GREATER_THAN_OR_EQUAL: string;
-    REGEX: string;
-    NOT_REGEX: string;
+export declare const operand: {
+    readonly EQUALS: "eql";
+    readonly CONTAINS: "cont";
+    readonly LESS_THAN: "lt";
+    readonly LESS_THAN_OR_EQUAL: "lte";
+    readonly GREATER_THAN: "gt";
+    readonly GREATER_THAN_OR_EQUAL: "gte";
+    readonly REGEX: "rgx";
+    readonly NOT_REGEX: "nrgx";
 };
-export type Order = {
-    direction: string;
-    field: string;
+export type Operand = typeof operand[keyof typeof operand];
+export declare const order: {
+    readonly ASCENDING: "asc";
+    readonly DESCENDING: "desc";
 };
-export declare const orders: {
-    ASCENDING: string;
-    DESCENDING: string;
+export type Order = typeof order[keyof typeof order];
+export type OrderRow = {
+    direction: Order;
+    field: string;
 };
-export declare const reports: {
-    CRAWL_STATISTICS: string;
-    CUSTOM: string;
-    LIST_PROJECTS: string;
-    LIST_CRAWLS: string;
-    LIST_REPORTS: string;
-    REPORT_ROWS: string;
-    REPORT_STATISTICS: string;
-    REPORT_SUMMARY: string;
+export declare const report: {
+    readonly CRAWL_STATISTICS: "crawl_statistics";
+    readonly CUSTOM: "custom";
+    readonly LIST_PROJECTS: "list_projects";
+    readonly LIST_CRAWLS: "list_crawls";
+    readonly LIST_REPORTS: "list_reports";
+    readonly REPORT_ROWS: "report_rows";
+    readonly REPORT_STATISTICS: "report_statistics";
+    readonly REPORT_SUMMARY: "report_summary";
 };
-export * from "./buildRequest";
-export * from "./getData";
-export * from "./initClient";
+export type Report = typeof report[keyof typeof report];

package/lumar/api/server/lumarApi.js

@@ -1,4 +1,4 @@
-export const operands = {
+export const operand = {
     EQUALS: 'eql',
     CONTAINS: 'cont',
     LESS_THAN: 'lt',
@@ -8,11 +8,11 @@ export const operands = {
     REGEX: 'rgx',
     NOT_REGEX: 'nrgx',
 };
-export const orders = {
+export const order = {
     ASCENDING: 'asc',
     DESCENDING: 'desc',
 };
-export const reports = {
+export const report = {
     CRAWL_STATISTICS: 'crawl_statistics',
     CUSTOM: 'custom',
     LIST_PROJECTS: 'list_projects',
@@ -22,6 +22,3 @@ export const reports = {
     REPORT_STATISTICS: 'report_statistics',
     REPORT_SUMMARY: 'report_summary',
 };
-export * from "./buildRequest";
-export * from "./getData";
-export * from "./initClient";

package/lumar/graphql/server/columns.d.ts

@@ -1,28 +1,29 @@
-export declare const columns: {
-    CUSTOM_EXTRACTION_1: string;
-    CUSTOM_EXTRACTION_2: string;
-    DEEP_RANK: string;
-    DESCRIPTION: string;
-    DUPLICATE_PAGE: string;
-    DUPLICATE_DESCRIPTION_FROM: string;
-    DUPLICATE_TITLE_FROM: string;
-    FOUND_AT_URL: string;
-    FOUND_IN_CRAWL: string;
-    FOUND_IN_SEARCH_CONSOLE: string;
-    FOUND_IN_SITEMAP: string;
-    LEVEL: string;
-    PAGE_TITLE: string;
-    PRIMARY_PAGE: string;
-    PRIMARY_URL_FROM: string;
-    PRIMARY_URL_FROM_STATUS_CODE: string;
-    REDIRECTED_TO_URL: string;
-    REDIRECTED_TO_STATUS_CODE: string;
-    REDIRECTION_CHAIN: string;
-    SOURCE_URL: string;
-    STATUS_CODE: string;
-    TARGET_STATUS_CODE: string;
-    URL: string;
-    URL_COUNT: string;
-    URL_TO: string;
-    URL_TO_STATUS_CODE: string;
+export declare const column: {
+    readonly CUSTOM_EXTRACTION_1: "customExtraction1";
+    readonly CUSTOM_EXTRACTION_2: "customExtraction2";
+    readonly DEEP_RANK: "deepRank";
+    readonly DESCRIPTION: "description";
+    readonly DUPLICATE_PAGE: "duplicatePage";
+    readonly DUPLICATE_DESCRIPTION_FROM: "duplicateDescriptionPrimaryUrl";
+    readonly DUPLICATE_TITLE_FROM: "duplicateTitlePrimaryUrl";
+    readonly FOUND_AT_URL: "foundAtUrl";
+    readonly FOUND_IN_CRAWL: "foundInWebCrawl";
+    readonly FOUND_IN_SEARCH_CONSOLE: "foundInGoogleSearchConsole";
+    readonly FOUND_IN_SITEMAP: "foundInSitemap";
+    readonly LEVEL: "level";
+    readonly PAGE_TITLE: "pageTitle";
+    readonly PRIMARY_PAGE: "primaryPage";
+    readonly PRIMARY_URL_FROM: "primaryUrlFrom";
+    readonly PRIMARY_URL_FROM_STATUS_CODE: "primaryUrlFromStatusCode";
+    readonly REDIRECTED_TO_URL: "redirectedToUrl";
+    readonly REDIRECTED_TO_STATUS_CODE: "redirectedToStatusCode";
+    readonly REDIRECTION_CHAIN: "redirectionChain";
+    readonly SOURCE_URL: "sourceUrl";
+    readonly STATUS_CODE: "httpStatusCode";
+    readonly TARGET_STATUS_CODE: "targetStatusCode";
+    readonly URL: "url";
+    readonly URL_COUNT: "urlCount";
+    readonly URL_TO: "urlTo";
+    readonly URL_TO_STATUS_CODE: "urlToStatusCode";
 };
+export type Column = typeof column[keyof typeof column];

package/lumar/graphql/server/columns.js

@@ -1,4 +1,4 @@
-export const columns = {
+export const column = {
     CUSTOM_EXTRACTION_1: 'customExtraction1',
     CUSTOM_EXTRACTION_2: 'customExtraction2',
     DEEP_RANK: 'deepRank',

package/lumar/graphql/server/getData.js

@@ -4,7 +4,7 @@ export const getData = async (query, variables, accessToken) => {
     queryClean = queryClean.replace(/\n/g, " ");
     queryClean = queryClean.replace(/\t/g, " ");
     queryClean = queryClean.replace(/  /g, " ");
-    const apiResponse = await post("https://api.lumar.io/graphql", {
+    return await post("https://api.lumar.io/graphql", {
         query: queryClean,
         variables,
     }, {
@@ -12,5 +12,4 @@ export const getData = async (query, variables, accessToken) => {
             "x-auth-token": accessToken,
         },
     });
-    return apiResponse;
 };

package/lumar/graphql/server/lumarGraphql.d.ts

@@ -1,29 +1,27 @@
-export declare const operands: {
-    CONTAINS: string;
-    DOESNT_CONTAIN: string;
-    DOESNT_MATCH_REGEX: string;
-    ENDS_WITH: string;
-    EQUALS: string;
-    GREATER_THAN: string;
-    GREATER_THAN_OR_EQUAL: string;
-    IS_EMPTY: string;
-    LESS_THAN: string;
-    LESS_THAN_OR_EQUAL: string;
-    MATCHES_REGEX: string;
-    NOT_EQUALS: string;
-    STARTS_WITH: string;
+export declare const operand: {
+    readonly CONTAINS: "contains";
+    readonly DOESNT_CONTAIN: "notContains";
+    readonly DOESNT_MATCH_REGEX: "notMatchesRegex";
+    readonly ENDS_WITH: "endsWith";
+    readonly EQUALS: "eq";
+    readonly GREATER_THAN: "gt";
+    readonly GREATER_THAN_OR_EQUAL: "ge";
+    readonly IS_EMPTY: "isEmpty";
+    readonly LESS_THAN: "lt";
+    readonly LESS_THAN_OR_EQUAL: "le";
+    readonly MATCHES_REGEX: "matchesRegex";
+    readonly NOT_EQUALS: "ne";
+    readonly STARTS_WITH: "beginsWith";
 };
-export declare const reportTypes: {
-    ADDED: string;
-    BASIC: string;
-    MISSING: string;
-    REMOVED: string;
+export type Operand = typeof operand[keyof typeof operand];
+export declare const reportType: {
+    readonly ADDED: "Added";
+    readonly BASIC: "Basic";
+    readonly MISSING: "Missing";
+    readonly REMOVED: "Removed";
 };
+export type ReportType = typeof reportType[keyof typeof reportType];
 /**
  * Shorthand function to return the report key.
  */
 export declare const getReportKey: (templateCode: string, typeCode: string) => string;
-export { columns } from "./columns";
-export { reportTemplates } from "./reportTemplates";
-export { getData } from "./getData";
-export { initClient } from "./initClient";

package/lumar/graphql/server/lumarGraphql.js

@@ -1,4 +1,4 @@
-export const operands = {
+export const operand = {
     CONTAINS: "contains",
     DOESNT_CONTAIN: "notContains",
     DOESNT_MATCH_REGEX: "notMatchesRegex",
@@ -13,7 +13,7 @@ export const operands = {
     NOT_EQUALS: "ne",
     STARTS_WITH: "beginsWith",
 };
-export const reportTypes = {
+export const reportType = {
     ADDED: "Added",
     BASIC: "Basic",
     MISSING: "Missing",
@@ -25,7 +25,3 @@ export const reportTypes = {
 export const getReportKey = (templateCode, typeCode) => {
     return `${templateCode}-${typeCode}`.toLowerCase();
 };
-export { columns } from "./columns";
-export { reportTemplates } from "./reportTemplates";
-export { getData } from "./getData";
-export { initClient } from "./initClient";

package/lumar/graphql/server/queries/getReportDifferences.d.ts

@@ -17,7 +17,7 @@ declare const getReportDifferences: ({ crawlId, filter, reportTemplateCode }: Ge
         input: {
             crawlId: number;
             reportTemplateCode: string;
-            reportTypeCode: string;
+            reportTypeCode: "Basic";
         };
     };
 };

package/lumar/graphql/server/queries/getReportDifferences.js

@@ -1,4 +1,4 @@
-import { reportTypes } from "../";
+import { reportType } from "../";
 /**
  * Used to return the number for: Basic, Added, Missing, Removed for a given report.
  */
@@ -28,7 +28,7 @@ const getReportDifferences = ({ crawlId, filter, reportTemplateCode }) => ({
         input: {
             crawlId,
             reportTemplateCode,
-            reportTypeCode: reportTypes.BASIC,
+            reportTypeCode: reportType.BASIC,
         },
     },
 });

package/lumar/graphql/server/reportTemplates.d.ts

@@ -1,67 +1,68 @@
-export declare const reportTemplates: {
-    "200_PAGES": string;
-    "301_REDIRECTS": string;
-    "4XX_ERRORS": string;
-    "5XX_ERRORS": string;
-    ALL_PAGES: string;
-    BROKEN_EXTERNAL_LINKS: string;
-    BROKEN_INTERNAL_LINKS: string;
-    BROKEN_SITEMAP_PAGES: string;
-    CANONICAL_CONFLICTING: string;
-    CANONICAL_NON_200: string;
-    CANONICAL_NON_INDEXABLE: string;
-    CANONICAL_ORPHANED: string;
-    CUSTOM_EXTRACTION_1: string;
-    CUSTOM_EXTRACTION_2: string;
-    DUPLICATE_CONTENT: string;
-    DUPLICATE_DESCRIPTIONS: string;
-    DUPLICATE_TITLES: string;
-    EMPTY_PAGES: string;
-    INDEXABLE_PAGES: string;
-    LINKED_DOMAINS: string;
-    MAX_DESCRIPTIONS: string;
-    MAX_MOBILE_DESCRIPTIONS: string;
-    MAX_TITLES: string;
-    MISSING_DESCRIPTIONS: string;
-    MISSING_TITLES: string;
-    NON_301_REDIRECTS: string;
-    NON_INDEXABLE_PAGES: string;
-    NON_INDEXABLE_SITEMAP_PAGES: string;
-    ORPHANED_CANONICAL: string;
-    ORPHANED_ANALYTICS_PAGES: string;
-    ORPHANED_SEARCH_CONSOLE_PAGES: string;
-    ORPHANED_SITEMAP_PAGES: string;
-    PAGES_WITH_HIGH_EXTERNAL_LINKS: string;
-    PERFORMANCE_MAX_FETCH_TIME: string;
-    PERFORMANCE_POOR_CLS: string;
-    PERFORMANCE_SLOW_DCL: string;
-    PERFORMANCE_SLOW_FCP: string;
-    PERFORMANCE_SLOW_LCP: string;
-    PERFORMANCE_SLOW_TTFB: string;
-    PERFORMANCE_SLOW_TTI: string;
-    PRIMARY_PAGES: string;
-    REDIRECTS_BROKEN: string;
-    REDIRECTS_CHAIN: string;
-    REDIRECTS_LOOP: string;
-    SCHEMA_BREADCRUMB: string;
-    SCHEMA_EVENT: string;
-    SCHEMA_FAQ: string;
-    SCHEMA_HOW_TO: string;
-    SCHEMA_NEWS_ARTICLE: string;
-    SCHEMA_PRODUCT: string;
-    SCHEMA_QA: string;
-    SCHEMA_RECIPE: string;
-    SCHEMA_REVIEW: string;
-    SCHEMA_VIDEO: string;
-    SHORT_DESCRIPTIONS: string;
-    SHORT_TITLES: string;
-    SITEMAP_PAGES: string;
-    SITEMAPS_NON_INDEXABLE_PAGES: string;
-    SITEMAPS_ORPHANED_PAGES: string;
-    SITEMAPS_MISSING_PAGES: string;
-    THIN_PAGES: string;
-    TRUE_UNIQUE_PAGES: string;
-    UNIQUE_EXTERNAL_LINKS: string;
-    UNIQUE_INTERNAL_LINKS: string;
-    XML_SITEMAPS: string;
+export declare const reportTemplate: {
+    readonly "200_PAGES": "200_pages";
+    readonly "301_REDIRECTS": "301_redirects";
+    readonly "4XX_ERRORS": "4xx_errors";
+    readonly "5XX_ERRORS": "5xx_errors";
+    readonly ALL_PAGES: "all_pages";
+    readonly BROKEN_EXTERNAL_LINKS: "broken_links_external";
+    readonly BROKEN_INTERNAL_LINKS: "all_broken_links";
+    readonly BROKEN_SITEMAP_PAGES: "broken_sitemap_links";
+    readonly CANONICAL_CONFLICTING: "conflicting_canonical_tags";
+    readonly CANONICAL_NON_200: "canonical_to_non_200";
+    readonly CANONICAL_NON_INDEXABLE: "non_indexable_canonical_links_in";
+    readonly CANONICAL_ORPHANED: "unlinked_canonical_pages";
+    readonly CUSTOM_EXTRACTION_1: "custom_extraction_1";
+    readonly CUSTOM_EXTRACTION_2: "custom_extraction_2";
+    readonly DUPLICATE_CONTENT: "duplicate_body_content";
+    readonly DUPLICATE_DESCRIPTIONS: "pages_with_duplicate_descriptions";
+    readonly DUPLICATE_TITLES: "pages_with_duplicate_titles";
+    readonly EMPTY_PAGES: "empty_pages";
+    readonly INDEXABLE_PAGES: "indexable_pages";
+    readonly LINKED_DOMAINS: "linked_domains";
+    readonly MAX_DESCRIPTIONS: "max_description_length";
+    readonly MAX_MOBILE_DESCRIPTIONS: "max_mobile_description_length";
+    readonly MAX_TITLES: "max_title_length";
+    readonly MISSING_DESCRIPTIONS: "missing_descriptions";
+    readonly MISSING_TITLES: "missing_titles";
+    readonly NON_301_REDIRECTS: "non_301_redirects";
+    readonly NON_INDEXABLE_PAGES: "non_indexable_pages";
+    readonly NON_INDEXABLE_SITEMAP_PAGES: "sitemaps_non_indexable_links";
+    readonly ORPHANED_CANONICAL: "unlinked_canonical_pages";
+    readonly ORPHANED_ANALYTICS_PAGES: "orphaned_organic_landing_pages";
+    readonly ORPHANED_SEARCH_CONSOLE_PAGES: "orphaned_google_search_console_pages";
+    readonly ORPHANED_SITEMAP_PAGES: "orphaned_sitemaps_pages";
+    readonly PAGES_WITH_HIGH_EXTERNAL_LINKS: "max_external_links";
+    readonly PERFORMANCE_MAX_FETCH_TIME: "max_load_time";
+    readonly PERFORMANCE_POOR_CLS: "poor_cls";
+    readonly PERFORMANCE_SLOW_DCL: "slow_dcl";
+    readonly PERFORMANCE_SLOW_FCP: "slow_fcp";
+    readonly PERFORMANCE_SLOW_LCP: "slow_lcp";
+    readonly PERFORMANCE_SLOW_TTFB: "slow_server_response";
+    readonly PERFORMANCE_SLOW_TTI: "slow_tti";
+    readonly PRIMARY_PAGES: "unique_pages";
+    readonly REDIRECTS_BROKEN: "all_broken_redirects";
+    readonly REDIRECTS_CHAIN: "redirect_chains";
+    readonly REDIRECTS_LOOP: "redirection_loop";
+    readonly SCHEMA_BREADCRUMB: "pages_with_breadcrumb_schema";
+    readonly SCHEMA_EVENT: "pages_with_event_schema";
+    readonly SCHEMA_FAQ: "pages_with_faqpage_schema";
+    readonly SCHEMA_HOW_TO: "pages_with_howto_schema";
+    readonly SCHEMA_NEWS_ARTICLE: "pages_with_news_article_schema";
+    readonly SCHEMA_PRODUCT: "pages_with_product_schema";
+    readonly SCHEMA_QA: "pages_with_qapage_schema";
+    readonly SCHEMA_RECIPE: "pages_with_recipe_schema";
+    readonly SCHEMA_REVIEW: "pages_with_review_schema";
+    readonly SCHEMA_VIDEO: "pages_with_videoobject_schema";
+    readonly SHORT_DESCRIPTIONS: "short_descriptions";
+    readonly SHORT_TITLES: "short_titles";
+    readonly SITEMAP_PAGES: "all_sitemaps_links";
+    readonly SITEMAPS_NON_INDEXABLE_PAGES: "sitemaps_non_indexable_links";
+    readonly SITEMAPS_ORPHANED_PAGES: "orphaned_sitemaps_pages";
+    readonly SITEMAPS_MISSING_PAGES: "not_in_sitemaps_primary_indexable";
+    readonly THIN_PAGES: "thin_pages";
+    readonly TRUE_UNIQUE_PAGES: "true_uniques";
+    readonly UNIQUE_EXTERNAL_LINKS: "unique_external_links";
+    readonly UNIQUE_INTERNAL_LINKS: "unique_internal_links";
+    readonly XML_SITEMAPS: "xml_sitemaps";
 };
+export type ReportTemplate = typeof reportTemplate[keyof typeof reportTemplate];

package/lumar/graphql/server/reportTemplates.js

@@ -1,4 +1,4 @@
-export const reportTemplates = {
+export const reportTemplate = {
     "200_PAGES": "200_pages",
     "301_REDIRECTS": "301_redirects",
     "4XX_ERRORS": "4xx_errors",

package/nextAuth/nextAuth.d.ts

@@ -1,7 +1,7 @@
 export { isSessionReady } from "./isSessionReady";
 export declare const NextAuthState: {
-    AUTHENTICATED: string;
-    PENDING: string;
-    UNAUTHENTICATED: string;
+    readonly AUTHENTICATED: "authenticated";
+    readonly PENDING: "loading";
+    readonly UNAUTHENTICATED: "unauthenticated";
 };
 export type NextAuthState = typeof NextAuthState[keyof typeof NextAuthState];

package/nextJs/nextJs.js

@@ -1,14 +1,8 @@
 /**
  * Get the user's remote IP Address
  */
-export const getIp = ({ req }) => {
-    let response = 'unset';
-    if (undefined !== req.headers['x-real-ip']) {
-        response = String(req.headers['x-real-ip']);
-    }
-    return response;
-};
+export const getIp = ({ req }) => String(req.headers?.["x-real-ip"] || "unset");
 /**
  * Get the user's User Agent
  */
-export const getUserAgent = ({ req }) => req.headers['user-agent'] || 'unset';
+export const getUserAgent = ({ req }) => String(req.headers["user-agent"] || "unset");

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@8ms/helpers",
 	"license": "UNLICENSED",
-	"version": "2.3.2",
+	"version": "2.3.3",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"

package/sorting/sorting.d.ts

@@ -1,4 +1,4 @@
-export { byNumberAscending } from "./byNumberAscending";
-export { byNumberDescending } from "./byNumberDescending";
-export { byStringAscending } from "./byStringAscending";
-export { byStringDescending } from "./byStringDescending";
+export * from "./byNumberAscending";
+export * from "./byNumberDescending";
+export * from "./byStringAscending";
+export * from "./byStringDescending";

package/sorting/sorting.js

@@ -1,4 +1,4 @@
-export { byNumberAscending } from "./byNumberAscending";
-export { byNumberDescending } from "./byNumberDescending";
-export { byStringAscending } from "./byStringAscending";
-export { byStringDescending } from "./byStringDescending";
+export * from "./byNumberAscending";
+export * from "./byNumberDescending";
+export * from "./byStringAscending";
+export * from "./byStringDescending";

package/util/isUndefined.js

@@ -1,5 +1,5 @@
-import { defaultTo } from './defaultTo';
-const undefinedValue = '__!!UNDEFINED!!__';
+import { defaultTo } from "./defaultTo";
+const undefinedValue = "__!!UNDEFINED!!__";
 /**
  * Check to see if a value is undefined.
  */