@8ms/helpers 1.42.3 → 1.42.6

package/tsdown.config.ts

@@ -0,0 +1,18 @@
+import {defineConfig} from "tsdown";
+
+export default defineConfig({
+	entry   : [
+		"src/**/*.ts",
+		"!src/**/*.test.ts",
+		"!src/**/*.d.ts"
+	],
+	format  : ["esm", "cjs"],
+	outDir  : "dist",
+	unbundle: true,
+	dts     : true,
+	exports : true,
+	clean   : true,
+	deps    : {
+		skipNodeModulesBundle: true,
+	},
+});

package/dist/cjs/api/ApiResponse.d.ts

@@ -1,50 +0,0 @@
-import { Response } from "./response";
-import { State } from "./";
-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;
-}
-export default ApiResponse;

package/dist/cjs/api/ApiResponse.js

@@ -1,94 +0,0 @@
-"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("../util/defaultTo"));
-const _1 = require("./");
-/**
- * Class version of the API to enable quicker instances.
- */
-class ApiResponse {
-    constructor({ body, error, state } = {}) {
-        this.state = _1.State.IDLE;
-        this.body = null;
-        this.error = null;
-        this.body = body || null;
-        this.error = error || null;
-        this.state = state || _1.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 (0, defaultTo_1.default)({
-            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 === _1.State.ERROR;
-    }
-    isIdle() {
-        return this.state === _1.State.IDLE;
-    }
-    isPending() {
-        return this.state === _1.State.PENDING;
-    }
-    isSuccess() {
-        return this.state === _1.State.SUCCESS;
-    }
-    setToIdle() {
-        this.state = _1.State.IDLE;
-        return this;
-    }
-    setToPending() {
-        this.state = _1.State.PENDING;
-        return this;
-    }
-    setToError({ body, error }) {
-        this.body = body || null;
-        this.error = error;
-        this.state = _1.State.ERROR;
-        return this;
-    }
-    setToSuccess({ body }) {
-        this.body = body;
-        this.state = _1.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;
-    }
-}
-exports.default = ApiResponse;

package/dist/cjs/api/index.d.ts

@@ -1,9 +0,0 @@
-export declare enum State {
-    CANCELLED = "CANCELLED",
-    ERROR = "ERROR",
-    IDLE = "IDLE",
-    PENDING = "PENDING",
-    SUCCESS = "SUCCESS",
-    VALIDATION_ERROR = "VALIDATION_ERROR"
-}
-export declare const unexpectedError: string;

package/dist/cjs/api/index.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.unexpectedError = exports.State = void 0;
-var State;
-(function (State) {
-    State["CANCELLED"] = "CANCELLED";
-    State["ERROR"] = "ERROR";
-    State["IDLE"] = "IDLE";
-    State["PENDING"] = "PENDING";
-    State["SUCCESS"] = "SUCCESS";
-    State["VALIDATION_ERROR"] = "VALIDATION_ERROR";
-})(State || (exports.State = State = {}));
-exports.unexpectedError = "An unexpected error occurred, please try again.";

package/dist/cjs/api/isError.d.ts

@@ -1,6 +0,0 @@
-import { Response } from "./response";
-type IsError = {
-    response: Response;
-};
-declare const isError: (props: IsError) => boolean;
-export default isError;

package/dist/cjs/api/isError.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = require("./");
-const isError = (props) => {
-    return _1.State.ERROR === props.response.state;
-};
-exports.default = isError;

package/dist/cjs/api/isSuccess.d.ts

@@ -1,6 +0,0 @@
-import { Response } from './response';
-type IsSuccess = {
-    response: Response;
-};
-declare const isSuccess: (props: IsSuccess) => boolean;
-export default isSuccess;

package/dist/cjs/api/isSuccess.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = require("./");
-const isSuccess = (props) => {
-    return _1.State.SUCCESS === props.response.state;
-};
-exports.default = isSuccess;

package/dist/cjs/api/response.d.ts

@@ -1,8 +0,0 @@
-import { State } from "./";
-export type Response = {
-    body: any | null;
-    error: string | null;
-    state: State;
-};
-declare const response: Response;
-export default response;

package/dist/cjs/api/response.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = require("./");
-const response = {
-    body: null,
-    error: null,
-    state: _1.State.IDLE,
-};
-exports.default = response;

package/dist/cjs/array/contains.d.ts

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

package/dist/cjs/array/contains.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Shorthand to check if an array or string contains a needle.
- */
-const contains = (props) => -1 !== props.haystack.indexOf(props.needle);
-exports.default = contains;

package/dist/cjs/array/getArray.d.ts

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

package/dist/cjs/array/getArray.js

@@ -1,11 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const isArray_1 = __importDefault(require("lodash/isArray"));
-/**
- * Convert an array into an array or return if already an array.
- */
-const getArray = (props) => (0, isArray_1.default)(props.input) ? props.input : [props.input];
-exports.default = getArray;

package/dist/cjs/array/tests/contains.test.js

@@ -1,21 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const contains_1 = __importDefault(require("../contains"));
-test('contains - does contain', () => {
-    const haystack = [1, 2, 3, 4];
-    expect((0, contains_1.default)({ haystack, needle: 1 }))
-        .toBeTruthy();
-    expect((0, contains_1.default)({ haystack, needle: 2 }))
-        .toBeTruthy();
-    expect((0, contains_1.default)({ haystack, needle: 3 }))
-        .toBeTruthy();
-    expect((0, contains_1.default)({ haystack, needle: 4 }))
-        .toBeTruthy();
-});
-test('contains - does not contain', () => {
-    expect((0, contains_1.default)({ haystack: [1, 2, 3, 4], needle: 9 }))
-        .toBeFalsy();
-});

package/dist/cjs/array/tests/getArray.test.js

@@ -1,18 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const getArray_1 = __importDefault(require("../getArray"));
-test('getArray - string', () => {
-    const inputString = 'some-input';
-    const expected = ['some-input'];
-    expect((0, getArray_1.default)({ input: inputString }))
-        .toStrictEqual(expected);
-});
-test('getArray - string[]', () => {
-    const inputArray = ['some-input'];
-    const expected = ['some-input'];
-    expect((0, getArray_1.default)({ input: inputArray }))
-        .toStrictEqual(expected);
-});

package/dist/cjs/atInternet/request.d.ts

@@ -1,30 +0,0 @@
-/**
- * The request in the structure required by AT Internet.
- */
-export 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[];
-    };
-};

package/dist/cjs/atInternet/request.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/aws/athenaExpress/initClient.d.ts

@@ -1,12 +0,0 @@
-import { Config } from '../getConfig';
-type InitClient = {
-    config: Config;
-    database: string;
-    s3Bucket: string;
-    s3Key: string;
-};
-/**
- * Initialise the database using manually provided credentials.
- */
-declare const initClient: (props: InitClient) => void;
-export default initClient;

package/dist/cjs/aws/athenaExpress/initClient.js

@@ -1,31 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const getConfig_1 = __importDefault(require("../getConfig"));
-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 = (0, getConfig_1.default)({
-            config: props.config,
-            isAthenaExpress: true
-        });
-        // Set the aws authentication
-        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,
-        });
-    }
-};
-exports.default = initClient;

package/dist/cjs/aws/athenaExpress/query.d.ts

@@ -1,8 +0,0 @@
-type Query = {
-    query: string;
-};
-/**
- * Build the query and return the data.
- */
-declare const query: (props: Query) => Promise<any>;
-export default query;

package/dist/cjs/aws/athenaExpress/query.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Build the query and return the data.
- */
-const query = async (props) => {
-    return await global.awsAthenaExpressClient.query(props.query)
-        .then(data => {
-        let subResponse = [];
-        if (undefined !== data['Items']) {
-            subResponse = data['Items'];
-        }
-        return subResponse;
-    });
-};
-exports.default = query;

package/dist/cjs/aws/ec2/initClient.d.ts

@@ -1,11 +0,0 @@
-import { Config } from "../getConfig";
-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/
- */
-export declare const initClient: (props: InitClient) => void;
-export {};

package/dist/cjs/aws/ec2/initClient.js

@@ -1,23 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.initClient = void 0;
-const getConfig_1 = __importDefault(require("../getConfig"));
-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 = (0, getConfig_1.default)({
-            config: props.config
-        });
-        global.awsEc2Client = new EC2Client(formattedConfig);
-    }
-};
-exports.initClient = initClient;

package/dist/cjs/aws/ec2/startInstances.d.ts

@@ -1,11 +0,0 @@
-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/
- */
-export declare const startInstances: (props: StartInstances) => Promise<any>;
-export {};

package/dist/cjs/aws/ec2/startInstances.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.startInstances = void 0;
-/**
- * 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,
-    });
-    const response = await global.awsEc2Client.send(command);
-    return response;
-};
-exports.startInstances = startInstances;

package/dist/cjs/aws/ec2/stopInstances.d.ts

@@ -1,12 +0,0 @@
-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/
- */
-export declare const stopInstances: (props: StopInstances) => Promise<any>;
-export {};

package/dist/cjs/aws/ec2/stopInstances.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.stopInstances = void 0;
-/**
- * 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,
-    });
-    const response = await global.awsEc2Client.send(command);
-    return response;
-};
-exports.stopInstances = stopInstances;

package/dist/cjs/aws/ecs/getClusters.d.ts

@@ -1,9 +0,0 @@
-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/
- */
-export declare const getClusters: (props: GetClusters) => Promise<string[]>;
-export {};

package/dist/cjs/aws/ecs/getClusters.js

@@ -1,32 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getClusters = void 0;
-const isResponse200_1 = __importDefault(require("../isResponse200"));
-/**
- * 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);
-        // console.log("listClustersResponse", apiResponse);
-        if ((0, isResponse200_1.default)({ apiResponse })) {
-            response = [
-                ...response,
-                ...apiResponse.clusterArns,
-            ];
-        }
-    }
-    return response;
-};
-exports.getClusters = getClusters;

package/dist/cjs/aws/ecs/getTaskDefinitions.d.ts

@@ -1,13 +0,0 @@
-import { SortOrder, TaskDefinitionStatus } from "@aws-sdk/client-ecs";
-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/
- */
-export declare const getTaskDefinitions: (props: GetTaskDefinitions) => Promise<string[]>;
-export {};

package/dist/cjs/aws/ecs/getTaskDefinitions.js

@@ -1,35 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTaskDefinitions = void 0;
-const isResponse200_1 = __importDefault(require("../isResponse200"));
-/**
- * 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);
-        // console.log("listTaskDefinitionsResponse", apiResponse);
-        if ((0, isResponse200_1.default)({ apiResponse })) {
-            response = [
-                ...response,
-                ...apiResponse.taskDefinitionArns,
-            ];
-        }
-    }
-    return response;
-};
-exports.getTaskDefinitions = getTaskDefinitions;

package/dist/cjs/aws/ecs/getTasks.d.ts

@@ -1,16 +0,0 @@
-import { DesiredStatus } from "@aws-sdk/client-ecs";
-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/
- */
-export declare const getTasks: (props: GetTasks) => Promise<string[]>;
-export {};