@8ms/helpers 1.40.4 → 1.40.9

package/util/getGzipDecompressed.d.ts

@@ -0,0 +1,9 @@
+type GetBrotliDecompressed = {
+    input?: any;
+    options?: object;
+};
+/**
+ * Decompress a given Gzip input into a string.
+ */
+declare const getGzipDecompressed: ({ input, options }?: GetBrotliDecompressed) => Promise<unknown>;
+export default getGzipDecompressed;

package/util/getGzipDecompressed.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Decompress a given Gzip input into a string.
+ */
+const getGzipDecompressed = async ({ input, options } = {}) => {
+    return new Promise(async (resolve, reject) => {
+        const zlib = require('zlib');
+        const compressedData = Buffer.from(input || '', "base64");
+        zlib.gunzip(compressedData, options || {}, (err, data) => {
+            if (err) {
+                reject(`Error decompressing - ${err.code}`);
+            }
+            else {
+                resolve(data.toString('utf8'));
+            }
+        });
+    });
+};
+exports.default = getGzipDecompressed;

package/util/getWithoutHash.d.ts

@@ -0,0 +1,8 @@
+type GetWithoutHash = {
+    input: string;
+};
+/**
+ * Get a URL without the parameter query.
+ */
+declare const getWithoutHash: ({ input }: GetWithoutHash) => string;
+export default getWithoutHash;

package/util/getWithoutHash.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Get a URL without the parameter query.
+ */
+const getWithoutHash = ({ input }) => {
+    let response = input;
+    // Contains parameter query
+    if (-1 !== response.indexOf('#')) {
+        const split = response.split('#');
+        if (split.length > 1) {
+            response = split[0];
+        }
+    }
+    return response;
+};
+exports.default = getWithoutHash;

package/util/getWithoutParameter.d.ts

@@ -0,0 +1,8 @@
+type GetWithoutParameter = {
+    input: string;
+};
+/**
+ * Get a URL without the parameter query.
+ */
+declare const getWithoutParameter: ({ input }: GetWithoutParameter) => string;
+export default getWithoutParameter;

package/util/getWithoutParameter.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Get a URL without the parameter query.
+ */
+const getWithoutParameter = ({ input }) => {
+    let response = input;
+    // Contains parameter query
+    if (-1 !== response.indexOf('?')) {
+        const split = response.split('?');
+        if (split.length > 1) {
+            response = split[0];
+        }
+    }
+    return response;
+};
+exports.default = getWithoutParameter;

package/util/isUndefined.d.ts

@@ -0,0 +1,9 @@
+type IsUndefined = {
+    instance: any;
+    keys: any | any[];
+};
+/**
+ * Check to see if a value is undefined.
+ */
+declare const isUndefined: ({ instance, keys }: IsUndefined) => boolean;
+export default isUndefined;

package/util/isUndefined.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const defaultTo_1 = __importDefault(require("./defaultTo"));
+/**
+ * Check to see if a value is undefined.
+ */
+const isUndefined = ({ instance, keys }) => {
+    const undefinedValue = '__!!UNDEFINED!!__';
+    const value = (0, defaultTo_1.default)({
+        defaultValue: undefinedValue,
+        instance,
+        keys,
+    });
+    return undefinedValue === value;
+};
+exports.default = isUndefined;

package/util/promiseChunks.d.ts

@@ -0,0 +1,10 @@
+type PromiseChunks = {
+    promises: Promise<any>[];
+    size: number;
+};
+/**
+ * Chunk a queue of promises into controlled chunks to prevent overloading.
+ * https://stackoverflow.com/a/53964407
+ */
+declare const promiseChunks: (props: PromiseChunks) => Promise<any[]>;
+export default promiseChunks;

package/util/promiseChunks.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chunk_1 = __importDefault(require("lodash/chunk"));
+const flatten_1 = __importDefault(require("lodash/flatten"));
+/**
+ * Chunk a queue of promises into controlled chunks to prevent overloading.
+ * https://stackoverflow.com/a/53964407
+ */
+const promiseChunks = async (props) => {
+    const batches = (0, chunk_1.default)(props.promises, props.size);
+    let results = [];
+    while (batches.length) {
+        const batch = batches.shift();
+        const result = await Promise.all(batch);
+        results.push(result);
+    }
+    return (0, flatten_1.default)(results);
+};
+exports.default = promiseChunks;

package/util/sleep.d.ts

@@ -0,0 +1,5 @@
+type Sleep = {
+    seconds: number;
+};
+declare const sleep: (props: Sleep) => Promise<void>;
+export default sleep;

package/util/sleep.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const sleep = (props) => {
+    return new Promise(resolve => setTimeout(resolve, props.seconds * 1000));
+};
+exports.default = sleep;

package/webWorker/index.d.ts

@@ -0,0 +1,5 @@
+export declare enum State {
+    ERROR = "ERROR",
+    SUCCESS = "SUCCESS",
+    PROGRESS = "PROGRESS"
+}

package/webWorker/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.State = void 0;
+var State;
+(function (State) {
+    State["ERROR"] = "ERROR";
+    State["SUCCESS"] = "SUCCESS";
+    State["PROGRESS"] = "PROGRESS";
+})(State || (exports.State = State = {}));

package/xml/getXml.d.ts

@@ -0,0 +1,5 @@
+type GetXml = {
+    url: string;
+};
+declare const getXml: (props: GetXml) => Promise<string>;
+export default getXml;

package/xml/getXml.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const get_1 = __importDefault(require("../axios/get"));
+const getXml = async (props) => {
+    let response = '';
+    const apiResponse = await (0, get_1.default)({
+        url: props.url,
+    });
+    if (apiResponse.isSuccess()) {
+        response = apiResponse.getBody()
+            .toString();
+        // Trim the contents
+        response = response.trim();
+        // Remove tabs, new lines, double spaces
+        response = response.replace(/[ ]{2}|\r\n|\n|\r|\t/gm, '');
+    }
+    return response;
+};
+exports.default = getXml;

package/dist/api/ApiResponse.d.mts

@@ -1,73 +0,0 @@
-import { t as State } from "../index-gGQBTUJU.mjs";
-import { t as Response } from "../response-CKsarnP-.mjs";
-
-//#region src/api/ApiResponse.d.ts
-type Constructor = {
-  body?: any;
-  error?: any;
-  state?: State;
-};
-/**
- * Class version of the API to enable quicker instances.
- */
-declare class ApiResponse {
-  state: State;
-  body: any;
-  error: any;
-  constructor({
-    body,
-    error,
-    state
-  }?: Constructor);
-  fromJson({
-    input
-  }: {
-    input: Response;
-  }): this;
-  getBody(): any;
-  getBodyDefaultTo({
-    defaultValue,
-    keys
-  }: {
-    defaultValue: any;
-    keys: any | any[];
-  }): any;
-  getError(): any;
-  getJson(): Response;
-  getState(): State;
-  isError(): boolean;
-  isIdle(): boolean;
-  isPending(): boolean;
-  isSuccess(): boolean;
-  setToIdle(): this;
-  setToPending(): this;
-  setToError({
-    body,
-    error
-  }: {
-    body?: any;
-    error: any;
-  }): this;
-  setToSuccess({
-    body
-  }: {
-    body: any;
-  }): this;
-  setBody({
-    body
-  }: {
-    body: any;
-  }): this;
-  setError({
-    error
-  }: {
-    error: any;
-  }): this;
-  setState({
-    state
-  }: {
-    state: State;
-  }): this;
-}
-//#endregion
-export { ApiResponse as default };

package/dist/api/ApiResponse.mjs

@@ -1,91 +0,0 @@
-import defaultTo from "../util/defaultTo.mjs";
-import { State } from "./index.mjs";
-//#region src/api/ApiResponse.ts
-/**
-* Class version of the API to enable quicker instances.
-*/
-var ApiResponse = class {
-	state = State.IDLE;
-	body = null;
-	error = null;
-	constructor({ body, error, state } = {}) {
-		this.body = body || null;
-		this.error = error || null;
-		this.state = state || State.IDLE;
-		return this;
-	}
-	fromJson({ input }) {
-		this.body = input.body;
-		this.error = input.error;
-		this.state = input.state;
-		return this;
-	}
-	getBody() {
-		return this.body;
-	}
-	getBodyDefaultTo({ defaultValue, keys }) {
-		return defaultTo({
-			defaultValue,
-			instance: this.body,
-			keys
-		});
-	}
-	getError() {
-		return this.error;
-	}
-	getJson() {
-		return {
-			body: this.body,
-			error: this.error,
-			state: this.state
-		};
-	}
-	getState() {
-		return this.state;
-	}
-	isError() {
-		return this.state === State.ERROR;
-	}
-	isIdle() {
-		return this.state === State.IDLE;
-	}
-	isPending() {
-		return this.state === State.PENDING;
-	}
-	isSuccess() {
-		return this.state === State.SUCCESS;
-	}
-	setToIdle() {
-		this.state = State.IDLE;
-		return this;
-	}
-	setToPending() {
-		this.state = State.PENDING;
-		return this;
-	}
-	setToError({ body, error }) {
-		this.body = body || null;
-		this.error = error;
-		this.state = State.ERROR;
-		return this;
-	}
-	setToSuccess({ body }) {
-		this.body = body;
-		this.state = State.SUCCESS;
-		return this;
-	}
-	setBody({ body }) {
-		this.body = body;
-		return this;
-	}
-	setError({ error }) {
-		this.error = error;
-		return this;
-	}
-	setState({ state }) {
-		this.state = state;
-		return this;
-	}
-};
-//#endregion
-export { ApiResponse as default };

package/dist/api/index.d.mts

@@ -1,2 +0,0 @@
-import { n as unexpectedError, t as State } from "../index-gGQBTUJU.mjs";
-export { State, unexpectedError };

package/dist/api/index.mjs

@@ -1,13 +0,0 @@
-//#region src/api/index.ts
-let State = /* @__PURE__ */ function(State) {
-	State["CANCELLED"] = "CANCELLED";
-	State["ERROR"] = "ERROR";
-	State["IDLE"] = "IDLE";
-	State["PENDING"] = "PENDING";
-	State["SUCCESS"] = "SUCCESS";
-	State["VALIDATION_ERROR"] = "VALIDATION_ERROR";
-	return State;
-}({});
-const unexpectedError = "An unexpected error occurred, please try again.";
-//#endregion
-export { State, unexpectedError };

package/dist/api/isError.d.mts

@@ -1,9 +0,0 @@
-import { t as Response } from "../response-CKsarnP-.mjs";
-
-//#region src/api/isError.d.ts
-type IsError = {
-  response: Response;
-};
-declare const isError: (props: IsError) => boolean;
-//#endregion
-export { isError as default };

package/dist/api/isError.mjs

@@ -1,7 +0,0 @@
-import { State } from "./index.mjs";
-//#region src/api/isError.ts
-const isError = (props) => {
-	return State.ERROR === props.response.state;
-};
-//#endregion
-export { isError as default };

package/dist/api/isSuccess.d.mts

@@ -1,9 +0,0 @@
-import { t as Response } from "../response-CKsarnP-.mjs";
-
-//#region src/api/isSuccess.d.ts
-type IsSuccess = {
-  response: Response;
-};
-declare const isSuccess: (props: IsSuccess) => boolean;
-//#endregion
-export { isSuccess as default };

package/dist/api/isSuccess.mjs

@@ -1,7 +0,0 @@
-import { State } from "./index.mjs";
-//#region src/api/isSuccess.ts
-const isSuccess = (props) => {
-	return State.SUCCESS === props.response.state;
-};
-//#endregion
-export { isSuccess as default };

package/dist/api/response.d.mts

@@ -1,2 +0,0 @@
-import { n as response, t as Response } from "../response-CKsarnP-.mjs";
-export { Response, response as default };

package/dist/api/response.mjs

@@ -1,9 +0,0 @@
-import { State } from "./index.mjs";
-//#region src/api/response.ts
-const response = {
-	body: null,
-	error: null,
-	state: State.IDLE
-};
-//#endregion
-export { response as default };

package/dist/array/contains.d.mts

@@ -1,11 +0,0 @@
-//#region src/array/contains.d.ts
-type Contains = {
-  haystack: any;
-  needle: any;
-};
-/**
- * Shorthand to check if an array or string contains a needle.
- */
-declare const contains: (props: Contains) => boolean;
-//#endregion
-export { contains as default };

package/dist/array/contains.mjs

@@ -1,7 +0,0 @@
-//#region src/array/contains.ts
-/**
-* Shorthand to check if an array or string contains a needle.
-*/
-const contains = (props) => -1 !== props.haystack.indexOf(props.needle);
-//#endregion
-export { contains as default };

package/dist/array/getArray.d.mts

@@ -1,10 +0,0 @@
-//#region src/array/getArray.d.ts
-type GetArray = {
-  input: any;
-};
-/**
- * Convert an array into an array or return if already an array.
- */
-declare const getArray: (props: GetArray) => any[];
-//#endregion
-export { getArray as default };

package/dist/array/getArray.mjs

@@ -1,8 +0,0 @@
-import isArray from "lodash/isArray.js";
-//#region src/array/getArray.ts
-/**
-* Convert an array into an array or return if already an array.
-*/
-const getArray = (props) => isArray(props.input) ? props.input : [props.input];
-//#endregion
-export { getArray as default };

package/dist/atInternet/request.d.mts

@@ -1,31 +0,0 @@
-//#region src/atInternet/request.d.ts
-/**
- * The request in the structure required by AT Internet.
- */
-type Request = {
-  columns: string[];
-  evo?: {
-    [evoKey: string]: object;
-  };
-  filter?: {
-    [filterKey: string]: object;
-  };
-  "max-results": number;
-  options: {
-    "ignore_null_properties": boolean;
-  };
-  "page-num": number;
-  period: {
-    [periodKey: string]: [{
-      type: string;
-      start: string;
-      end: string;
-    }];
-  };
-  sort: string[];
-  space: {
-    s: number[];
-  };
-};
-//#endregion
-export { Request };

package/dist/aws/athenaExpress/initClient.d.mts

@@ -1,15 +0,0 @@
-import { Config } from "../getConfig.mjs";
-
-//#region src/aws/athenaExpress/initClient.d.ts
-type InitClient = {
-  config: Config;
-  database: string;
-  s3Bucket: string;
-  s3Key: string;
-};
-/**
- * Initialise the database using manually provided credentials.
- */
-declare const initClient: (props: InitClient) => void;
-//#endregion
-export { initClient as default };

package/dist/aws/athenaExpress/initClient.mjs

@@ -1,28 +0,0 @@
-import { t as __require } from "../../chunk-y_GBKt04.mjs";
-import getConfig from "../getConfig.mjs";
-//#region src/aws/athenaExpress/initClient.ts
-global.awsAthenaExpressClient = null;
-/**
-* Initialise the database using manually provided credentials.
-*/
-const initClient = (props) => {
-	if (!global.awsAthenaExpressClient) {
-		const athenaExpress = __require("athena-express");
-		const awsSdk = __require("aws-sdk");
-		const formattedConfig = getConfig({
-			config: props.config,
-			isAthenaExpress: true
-		});
-		awsSdk.config.update(formattedConfig);
-		global.awsAthenaExpressClient = new athenaExpress.AthenaExpress({
-			aws: awsSdk,
-			s3: `s3://${props.s3Bucket}/${props.s3Key}`,
-			db: props.database,
-			formatJson: true,
-			retry: 200,
-			getStats: false
-		});
-	}
-};
-//#endregion
-export { initClient as default };

package/dist/aws/athenaExpress/query.d.mts

@@ -1,10 +0,0 @@
-//#region src/aws/athenaExpress/query.d.ts
-type Query = {
-  query: string;
-};
-/**
- * Build the query and return the data.
- */
-declare const query: (props: Query) => Promise<any>;
-//#endregion
-export { query as default };

package/dist/aws/athenaExpress/query.mjs

@@ -1,13 +0,0 @@
-//#region src/aws/athenaExpress/query.ts
-/**
-* Build the query and return the data.
-*/
-const query = async (props) => {
-	return await global.awsAthenaExpressClient.query(props.query).then((data) => {
-		let subResponse = [];
-		if (void 0 !== data["Items"]) subResponse = data["Items"];
-		return subResponse;
-	});
-};
-//#endregion
-export { query as default };

package/dist/aws/ec2/initClient.d.mts

@@ -1,14 +0,0 @@
-import { Config } from "../getConfig.mjs";
-
-//#region src/aws/ec2/initClient.d.ts
-type InitClient = {
-  config: Config;
-};
-/**
- * Shorthand function to get the EC2 Client.
- * Library: @aws-sdk/client-ec2
- * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ec2/
- */
-declare const initClient: (props: InitClient) => void;
-//#endregion
-export { initClient };

package/dist/aws/ec2/initClient.mjs

@@ -1,18 +0,0 @@
-import { t as __require } from "../../chunk-y_GBKt04.mjs";
-import getConfig from "../getConfig.mjs";
-//#region src/aws/ec2/initClient.ts
-global.awsEc2Client = null;
-/**
-* Shorthand function to get the EC2 Client.
-* Library: @aws-sdk/client-ec2
-* https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ec2/
-*/
-const initClient = (props) => {
-	if (!global.awsEc2Client) {
-		const { EC2Client } = __require("@aws-sdk/client-ec2");
-		const formattedConfig = getConfig({ config: props.config });
-		global.awsEc2Client = new EC2Client(formattedConfig);
-	}
-};
-//#endregion
-export { initClient };

package/dist/aws/ec2/startInstances.d.mts

@@ -1,13 +0,0 @@
-//#region src/aws/ec2/startInstances.d.ts
-type StartInstances = {
-  additionalInfo?: string;
-  instanceIds: string[];
-  dryRun?: boolean;
-};
-/**
- * Start one or more Ec2 Instances.
- * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ec2/command/StartInstancesCommand/
- */
-declare const startInstances: (props: StartInstances) => Promise<any>;
-//#endregion
-export { startInstances };

package/dist/aws/ec2/startInstances.mjs

@@ -1,17 +0,0 @@
-import { t as __require } from "../../chunk-y_GBKt04.mjs";
-//#region src/aws/ec2/startInstances.ts
-/**
-* Start one or more Ec2 Instances.
-* https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ec2/command/StartInstancesCommand/
-*/
-const startInstances = async (props) => {
-	const { StartInstancesCommand } = __require("@aws-sdk/client-ec2");
-	const command = new StartInstancesCommand({
-		InstanceIds: props.instanceIds,
-		AdditionalInfo: props?.additionalInfo,
-		DryRun: props?.dryRun
-	});
-	return await global.awsEc2Client.send(command);
-};
-//#endregion
-export { startInstances };