@8ms/helpers 1.39.0 → 1.40.1

package/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/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/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/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/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/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/atInternet/request.js

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

package/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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 {};

package/aws/ecs/getTasks.js

@@ -1,38 +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.getTasks = void 0;
-const isResponse200_1 = __importDefault(require("../isResponse200"));
-/**
- * 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);
-        // console.log("listClustersResponse", apiResponse);
-        if ((0, isResponse200_1.default)({ apiResponse })) {
-            response = [
-                ...response,
-                ...apiResponse.taskArns,
-            ];
-        }
-    }
-    return response;
-};
-exports.getTasks = getTasks;

package/aws/ecs/initClient.d.ts

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

package/aws/ecs/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.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 = (0, getConfig_1.default)({
-            config: props.config
-        });
-        global.awsEcsClient = new ECSClient(formattedConfig);
-    }
-};
-exports.initClient = initClient;

package/aws/ecs/runTask.d.ts

@@ -1,16 +0,0 @@
-import { LaunchType, NetworkConfiguration, TaskOverride } from "@aws-sdk/client-ecs";
-type RunTask = {
-    cluster?: string;
-    count?: number;
-    launchType?: LaunchType;
-    networkConfiguration?: NetworkConfiguration;
-    overrides?: TaskOverride;
-    taskDefinition?: string;
-};
-/**
- * Initialise and run a task
- * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/RunTaskCommand/
- * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/RunTaskCommandInput/
- */
-export declare const runTask: (props: RunTask) => Promise<boolean>;
-export {};

package/aws/ecs/runTask.js

@@ -1,30 +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.runTask = void 0;
-const isResponse200_1 = __importDefault(require("../isResponse200"));
-/**
- * Initialise and run a task
- * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/RunTaskCommand/
- * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/RunTaskCommandInput/
- */
-const runTask = async (props) => {
-    let response = false;
-    const { RunTaskCommand } = require("@aws-sdk/client-ecs");
-    const runtTaskCommand = new RunTaskCommand({
-        cluster: props?.cluster,
-        launchType: props?.launchType,
-        networkConfiguration: props?.networkConfiguration,
-        overrides: props?.overrides,
-        taskDefinition: props?.taskDefinition,
-    });
-    const apiResponse = await global.awsEcsClient.send(runtTaskCommand);
-    // console.log("runTaskCommandResponse", apiResponse);
-    if ((0, isResponse200_1.default)({ apiResponse })) {
-        response = apiResponse;
-    }
-    return response;
-};
-exports.runTask = runTask;

package/aws/getConfig.d.ts

@@ -1,13 +0,0 @@
-export type Config = {
-    accessKeyId: string;
-    region: string;
-    secretAccessKey: string;
-};
-/**
- * The config must be in a specific structure, if the properties aren't defined don't specify them as they could be inferred (e.g. Lambda).
- */
-declare const getConfig: ({ config, isAthenaExpress }: {
-    config: Config;
-    isAthenaExpress?: boolean;
-}) => object;
-export default getConfig;

package/aws/getConfig.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * The config must be in a specific structure, if the properties aren't defined don't specify them as they could be inferred (e.g. Lambda).
- */
-const getConfig = ({ config, isAthenaExpress }) => {
-    let response = {
-        region: config.region,
-    };
-    // Set the key id and access key if its defined (not required for AWS SAM)
-    if ('' !== config.accessKeyId && '' !== config.secretAccessKey) {
-        // Athena is a flat structure
-        if (true === isAthenaExpress) {
-            response['accessKeyId'] = config.accessKeyId;
-            response['secretAccessKey'] = config.secretAccessKey;
-        }
-        // AWS services are under credentials
-        else {
-            response['credentials'] = {
-                accessKeyId: config.accessKeyId,
-                secretAccessKey: config.secretAccessKey,
-            };
-        }
-    }
-    return response;
-};
-exports.default = getConfig;

package/aws/glue/initClient.d.ts

@@ -1,10 +0,0 @@
-import { Config } from '../getConfig';
-type InitClient = {
-    config: Config;
-};
-/**
- * Shorthand function to get the Glue Client.
- * Library: @aws-sdk/client-glue
- */
-declare const initClient: (props: InitClient) => void;
-export default initClient;

package/aws/glue/initClient.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 getConfig_1 = __importDefault(require("../getConfig"));
-global.awsGlueClient = null;
-/**
- * Shorthand function to get the Glue Client.
- * Library: @aws-sdk/client-glue
- */
-const initClient = (props) => {
-    if (!global.awsGlueClient) {
-        const { GlueClient } = require('@aws-sdk/client-glue');
-        const formattedConfig = (0, getConfig_1.default)({
-            config: props.config
-        });
-        global.awsGlueClient = new GlueClient(formattedConfig);
-    }
-};
-exports.default = initClient;

package/aws/glue/invoke.d.ts

@@ -1,9 +0,0 @@
-type Invoke = {
-    crawler: string;
-};
-/**
- * Invoke an AWS Glue Crawler by passing in the name of the Crawler.
- * Library: @aws-sdk/client-glue
- */
-declare const invoke: (props: Invoke) => Promise<boolean>;
-export default invoke;

package/aws/glue/invoke.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 });
-const isResponse200_1 = __importDefault(require("../isResponse200"));
-/**
- * Invoke an AWS Glue Crawler by passing in the name of the Crawler.
- * Library: @aws-sdk/client-glue
- */
-const invoke = async (props) => {
-    const { StartCrawlerCommand } = require('@aws-sdk/client-glue');
-    const command = new StartCrawlerCommand({
-        Name: props.crawler,
-    });
-    // Fire the event but don't wait for it to complete
-    const apiResponse = await global.awsGlueClient.send(command);
-    // Success
-    return (0, isResponse200_1.default)({
-        apiResponse
-    });
-};
-exports.default = invoke;

package/aws/isResponse200.d.ts

@@ -1,7 +0,0 @@
-/**
- * Was the API response a 200?
- */
-declare const isResponse200: ({ apiResponse }: {
-    apiResponse: any;
-}) => boolean;
-export default isResponse200;

package/aws/isResponse200.js

@@ -1,22 +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"));
-/**
- * Was the API response a 200?
- */
-const isResponse200 = ({ apiResponse }) => {
-    let response = false;
-    const responseCode = (0, defaultTo_1.default)({
-        defaultValue: 0,
-        instance: apiResponse,
-        keys: ['$metadata', 'httpStatusCode'],
-    });
-    if (200 === responseCode) {
-        response = true;
-    }
-    return response;
-};
-exports.default = isResponse200;

package/aws/lambda/getHandlerPath.d.ts

@@ -1,5 +0,0 @@
-type GetHandlerPath = {
-    input: string;
-};
-declare const getHandlerPath: (props: GetHandlerPath) => string;
-export default getHandlerPath;