@8ms/helpers 1.40.0 → 1.40.2

package/dist/api/ApiResponse.d.mts

@@ -0,0 +1,73 @@
+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

@@ -0,0 +1,91 @@
+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,12 +1,2 @@
-//#region src/api/index.d.ts
-declare enum State {
-  CANCELLED = "CANCELLED",
-  ERROR = "ERROR",
-  IDLE = "IDLE",
-  PENDING = "PENDING",
-  SUCCESS = "SUCCESS",
-  VALIDATION_ERROR = "VALIDATION_ERROR"
-}
-declare const unexpectedError: string;
-//#endregion
+import { n as unexpectedError, t as State } from "../index-gGQBTUJU.mjs";
 export { State, unexpectedError };

package/dist/api/isError.d.mts

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,7 @@
+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

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

package/dist/api/response.mjs

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,11 @@
+//#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

@@ -0,0 +1,7 @@
+//#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

@@ -0,0 +1,10 @@
+//#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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,31 @@
+//#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/atInternet/request.mjs

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

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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,28 @@
+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

@@ -0,0 +1,10 @@
+//#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

@@ -0,0 +1,13 @@
+//#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

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,18 @@
+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

@@ -0,0 +1,13 @@
+//#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

@@ -0,0 +1,17 @@
+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 };

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

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

package/dist/aws/ec2/stopInstances.mjs

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

package/dist/aws/ecs/getClusters.d.mts

@@ -0,0 +1,11 @@
+//#region src/aws/ecs/getClusters.d.ts
+type GetClusters = {
+  maxResults?: number;
+};
+/**
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/ListClustersCommand/
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/ListClustersCommandInput/
+ */
+declare const getClusters: (props: GetClusters) => Promise<string[]>;
+//#endregion
+export { getClusters };

package/dist/aws/ecs/getClusters.mjs

@@ -0,0 +1,23 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+import isResponse200 from "../isResponse200.mjs";
+//#region src/aws/ecs/getClusters.ts
+/**
+* https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/ListClustersCommand/
+* https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/ListClustersCommandInput/
+*/
+const getClusters = async (props) => {
+	let response = [];
+	let apiResponse = null;
+	const { ListClustersCommand } = __require("@aws-sdk/client-ecs");
+	while (null === apiResponse || apiResponse?.nextToken) {
+		const listClustersCommand = new ListClustersCommand({
+			maxResults: props?.maxResults,
+			nextToken: apiResponse?.nextToken
+		});
+		apiResponse = await global.awsEcsClient.send(listClustersCommand);
+		if (isResponse200({ apiResponse })) response = [...response, ...apiResponse.clusterArns];
+	}
+	return response;
+};
+//#endregion
+export { getClusters };

package/dist/aws/ecs/getTaskDefinitions.d.mts

@@ -0,0 +1,16 @@
+import { SortOrder, TaskDefinitionStatus } from "@aws-sdk/client-ecs";
+
+//#region src/aws/ecs/getTaskDefinitions.d.ts
+type GetTaskDefinitions = {
+  familyPrefix?: string;
+  maxResults?: number;
+  sort?: SortOrder;
+  status?: TaskDefinitionStatus;
+};
+/**
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/ListTaskDefinitionsCommand/
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/ListTaskDefinitionsCommandInput/
+ */
+declare const getTaskDefinitions: (props: GetTaskDefinitions) => Promise<string[]>;
+//#endregion
+export { getTaskDefinitions };

package/dist/aws/ecs/getTaskDefinitions.mjs

@@ -0,0 +1,26 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+import isResponse200 from "../isResponse200.mjs";
+//#region src/aws/ecs/getTaskDefinitions.ts
+/**
+* https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/ListTaskDefinitionsCommand/
+* https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/ListTaskDefinitionsCommandInput/
+*/
+const getTaskDefinitions = async (props) => {
+	let response = [];
+	let apiResponse = null;
+	const { ListTaskDefinitionsCommand } = __require("@aws-sdk/client-ecs");
+	while (null === apiResponse || apiResponse?.nextToken) {
+		const listTaskDefinitionsCommand = new ListTaskDefinitionsCommand({
+			maxResults: props?.maxResults,
+			familyPrefix: props?.familyPrefix,
+			sort: props?.sort,
+			status: props?.status,
+			nextToken: apiResponse?.nextToken
+		});
+		apiResponse = await global.awsEcsClient.send(listTaskDefinitionsCommand);
+		if (isResponse200({ apiResponse })) response = [...response, ...apiResponse.taskDefinitionArns];
+	}
+	return response;
+};
+//#endregion
+export { getTaskDefinitions };

package/dist/aws/ecs/getTasks.d.mts

@@ -0,0 +1,19 @@
+import { DesiredStatus } from "@aws-sdk/client-ecs";
+
+//#region src/aws/ecs/getTasks.d.ts
+type GetTasks = {
+  cluster?: string;
+  containerInstance?: string;
+  desiredStatus?: DesiredStatus;
+  family?: string;
+  maxResults?: number;
+  serviceName?: string;
+  startedBy?: string;
+};
+/**
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/ListTasksCommand/
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/ListTasksCommandInput/
+ */
+declare const getTasks: (props: GetTasks) => Promise<string[]>;
+//#endregion
+export { getTasks };

package/dist/aws/ecs/getTasks.mjs

@@ -0,0 +1,29 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+import isResponse200 from "../isResponse200.mjs";
+//#region src/aws/ecs/getTasks.ts
+/**
+* https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/ListTasksCommand/
+* https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/ListTasksCommandInput/
+*/
+const getTasks = async (props) => {
+	let response = [];
+	let apiResponse = null;
+	const { ListTasksCommand } = __require("@aws-sdk/client-ecs");
+	while (null === apiResponse || apiResponse?.nextToken) {
+		const listTasksCommand = new ListTasksCommand({
+			cluster: props?.cluster,
+			containerInstance: props?.containerInstance,
+			desiredStatus: props?.desiredStatus,
+			family: props?.family,
+			maxResults: props?.maxResults,
+			nextToken: apiResponse?.nextToken,
+			serviceName: props?.serviceName,
+			startedBy: props?.startedBy
+		});
+		apiResponse = await global.awsEcsClient.send(listTasksCommand);
+		if (isResponse200({ apiResponse })) response = [...response, ...apiResponse.taskArns];
+	}
+	return response;
+};
+//#endregion
+export { getTasks };

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

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

package/dist/aws/ecs/initClient.mjs

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