@8ms/helpers 1.0.1

package/dist/Class/BaseClass.d.ts

@@ -0,0 +1,19 @@
+declare class BaseClass {
+    /**
+     * Shortcut to set a value to an array and return the instance.
+     */
+    protected _setArray(value: any | any[], ...fields: string[]): this;
+    /**
+     * Shortcut to set a value and return the instance.
+     */
+    protected _setValue(value: any, ...fields: any[]): this;
+    /**
+     * Shortcut to add a value to an existing array.
+     */
+    protected _push(value: any | any[], ...fields: any[]): this;
+    /**
+     * Shortcut to get a value, but default if the fields don't exist.
+     */
+    protected _get(defaultValue: any, ...fields: any[]): any;
+}
+export default BaseClass;

package/dist/Class/BaseClass.js

@@ -0,0 +1,78 @@
+"use strict";
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var defaultTo_1 = __importDefault(require("../util/defaultTo"));
+var isArray_1 = __importDefault(require("lodash/isArray"));
+var set_1 = __importDefault(require("lodash/set"));
+var BaseClass = /** @class */ (function () {
+    function BaseClass() {
+    }
+    /**
+     * Shortcut to set a value to an array and return the instance.
+     */
+    BaseClass.prototype._setArray = function (value) {
+        var fields = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            fields[_i - 1] = arguments[_i];
+        }
+        if ((0, isArray_1.default)(value)) {
+            (0, set_1.default)(this, fields, value);
+        }
+        else {
+            (0, set_1.default)(this, fields, [value]);
+        }
+        return this;
+    };
+    /**
+     * Shortcut to set a value and return the instance.
+     */
+    BaseClass.prototype._setValue = function (value) {
+        var fields = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            fields[_i - 1] = arguments[_i];
+        }
+        (0, set_1.default)(this, fields, value);
+        return this;
+    };
+    /**
+     * Shortcut to add a value to an existing array.
+     */
+    BaseClass.prototype._push = function (value) {
+        var fields = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            fields[_i - 1] = arguments[_i];
+        }
+        var temp = this._get.apply(this, __spreadArray([[]], fields, false));
+        if ((0, isArray_1.default)(value)) {
+            temp = temp.concat(value);
+        }
+        else {
+            temp = temp.push(value);
+        }
+        (0, set_1.default)(this, fields, temp);
+        return this;
+    };
+    /**
+     * Shortcut to get a value, but default if the fields don't exist.
+     */
+    BaseClass.prototype._get = function (defaultValue) {
+        var fields = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            fields[_i - 1] = arguments[_i];
+        }
+        return defaultTo_1.default.apply(void 0, __spreadArray([defaultValue, this], fields, false));
+    };
+    return BaseClass;
+}());
+exports.default = BaseClass;

package/dist/Class/index.d.ts

@@ -0,0 +1,3 @@
+import BaseClass from './BaseClass';
+export type {};
+export { BaseClass, };

package/dist/Class/index.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseClass = void 0;
+var BaseClass_1 = __importDefault(require("./BaseClass"));
+exports.BaseClass = BaseClass_1.default;

package/dist/api/constants.d.ts

@@ -0,0 +1,13 @@
+export declare const ApiStatus: {
+    ERROR: string;
+    IDLE: string;
+    PENDING: string;
+    SUCCESS: string;
+    VALIDATION_ERROR: string;
+};
+export declare const ApiPlaceholder: {
+    data: any;
+    error: any;
+    status: string;
+};
+export declare const UnexpectedError: string;

package/dist/api/constants.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnexpectedError = exports.ApiPlaceholder = exports.ApiStatus = void 0;
+exports.ApiStatus = {
+    ERROR: 'error',
+    IDLE: 'idle',
+    PENDING: 'pending',
+    SUCCESS: 'success',
+    VALIDATION_ERROR: 'validationError',
+};
+exports.ApiPlaceholder = {
+    data: null,
+    error: null,
+    status: exports.ApiStatus.IDLE,
+};
+exports.UnexpectedError = 'An unexpected error occurred, please try again.';

package/dist/api/index.d.ts

@@ -0,0 +1,4 @@
+import { ApiPlaceholder, ApiStatus, UnexpectedError } from './constants';
+import { ApiResponseType } from './types';
+export type { ApiResponseType, };
+export { ApiPlaceholder, ApiStatus, UnexpectedError, };

package/dist/api/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnexpectedError = exports.ApiStatus = exports.ApiPlaceholder = void 0;
+var constants_1 = require("./constants");
+Object.defineProperty(exports, "ApiPlaceholder", { enumerable: true, get: function () { return constants_1.ApiPlaceholder; } });
+Object.defineProperty(exports, "ApiStatus", { enumerable: true, get: function () { return constants_1.ApiStatus; } });
+Object.defineProperty(exports, "UnexpectedError", { enumerable: true, get: function () { return constants_1.UnexpectedError; } });

package/dist/api/types.d.ts

@@ -0,0 +1,6 @@
+import { ApiStatus } from './constants';
+export declare type ApiResponseType = {
+    data: any | null;
+    error: string | null;
+    status: typeof ApiStatus.ERROR | typeof ApiStatus.IDLE | typeof ApiStatus.PENDING | typeof ApiStatus.SUCCESS | typeof ApiStatus.VALIDATION_ERROR;
+};

package/dist/api/types.js

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

package/dist/array/getArray.d.ts

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

package/dist/array/getArray.js

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

package/dist/array/index.d.ts

@@ -0,0 +1,3 @@
+import getArray from './getArray';
+export type {};
+export { getArray, };

package/dist/array/index.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getArray = void 0;
+var getArray_1 = __importDefault(require("./getArray"));
+exports.getArray = getArray_1.default;

package/dist/atInternet/index.d.ts

@@ -0,0 +1,3 @@
+import { RequestType } from './types';
+export type { RequestType, };
+export {};

package/dist/atInternet/index.js

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

package/dist/atInternet/types.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The request in the structure required by AT Internet.
+ */
+export declare type RequestType = {
+    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/atInternet/types.js

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

package/dist/aws/athenaExpress/getClient.d.ts

@@ -0,0 +1,13 @@
+import { AwsConfigType } from '../types';
+declare type GetClientType = {
+    AthenaExpress: any;
+    AwsSdk: any;
+    athenaS3: string;
+    config: AwsConfigType;
+    database: string;
+};
+/**
+ * Initialise the database using manually provided credentials.
+ */
+declare const getClient: ({ AthenaExpress, AwsSdk, athenaS3, config, database }: GetClientType) => any;
+export default getClient;

package/dist/aws/athenaExpress/getClient.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var athenaClient = undefined;
+/**
+ * Initialise the database using manually provided credentials.
+ */
+var getClient = function (_a) {
+    var AthenaExpress = _a.AthenaExpress, AwsSdk = _a.AwsSdk, athenaS3 = _a.athenaS3, config = _a.config, database = _a.database;
+    if (undefined === athenaClient) {
+        // Set the aws authentication
+        AwsSdk.config.update(config);
+        athenaClient = new AthenaExpress.AthenaExpress({
+            aws: AwsSdk,
+            s3: athenaS3,
+            db: database,
+            formatJson: true,
+            retry: 200,
+            getStats: false,
+        });
+    }
+    return athenaClient;
+};
+exports.default = getClient;

package/dist/aws/athenaExpress/index.d.ts

@@ -0,0 +1,4 @@
+import getClient from './getClient';
+import request from './request';
+export type {};
+export { getClient, request, };

package/dist/aws/athenaExpress/index.js

@@ -0,0 +1,10 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.request = exports.getClient = void 0;
+var getClient_1 = __importDefault(require("./getClient"));
+exports.getClient = getClient_1.default;
+var request_1 = __importDefault(require("./request"));
+exports.request = request_1.default;

package/dist/aws/athenaExpress/request.d.ts

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

package/dist/aws/athenaExpress/request.js

@@ -0,0 +1,54 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Build the query and return the data.
+ */
+var request = function (_a) {
+    var client = _a.client, query = _a.query;
+    return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, client.query(query)
+                        .then(function (data) { return undefined === data['Items'] ? [] : data['Items']; })];
+                case 1: return [2 /*return*/, _b.sent()];
+            }
+        });
+    });
+};
+exports.default = request;

package/dist/aws/glue/getClient.d.ts

@@ -0,0 +1,10 @@
+import { AwsConfigType } from '../types';
+/**
+ * Shorthand function to get the Glue Client.
+ * Library: @aws-sdk/client-glue
+ */
+declare const getClient: ({ GlueLib, config }: {
+    GlueLib: any;
+    config: AwsConfigType;
+}) => any;
+export default getClient;

package/dist/aws/glue/getClient.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var glueClient = undefined;
+/**
+ * Shorthand function to get the Glue Client.
+ * Library: @aws-sdk/client-glue
+ */
+var getClient = function (_a) {
+    var GlueLib = _a.GlueLib, config = _a.config;
+    if (undefined === glueClient) {
+        var GlueClient = GlueLib.GlueClient;
+        glueClient = new GlueClient(config);
+    }
+    return glueClient;
+};
+exports.default = getClient;

package/dist/aws/glue/index.d.ts

@@ -0,0 +1,4 @@
+import getClient from './getClient';
+import invoke from './invoke';
+export type {};
+export { getClient, invoke, };

package/dist/aws/glue/index.js

@@ -0,0 +1,10 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invoke = exports.getClient = void 0;
+var getClient_1 = __importDefault(require("./getClient"));
+exports.getClient = getClient_1.default;
+var invoke_1 = __importDefault(require("./invoke"));
+exports.invoke = invoke_1.default;

package/dist/aws/glue/invoke.d.ts

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

package/dist/aws/glue/invoke.js

@@ -0,0 +1,71 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var isResponse200_1 = __importDefault(require("../isResponse200"));
+/**
+ * Invoke an AWS Glue Crawler by passing in the name of the Crawler.
+ * Library: @aws-sdk/client-glue
+ */
+var invoke = function (_a) {
+    var GlueLib = _a.GlueLib, client = _a.client, crawler = _a.crawler;
+    return __awaiter(void 0, void 0, void 0, function () {
+        var params, StartCrawlerCommand, command, apiResponse;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    params = {
+                        Name: crawler,
+                    };
+                    StartCrawlerCommand = GlueLib.StartCrawlerCommand;
+                    command = new StartCrawlerCommand(params);
+                    return [4 /*yield*/, client.send(command)];
+                case 1:
+                    apiResponse = _b.sent();
+                    // Success
+                    if ((0, isResponse200_1.default)({ apiResponse: apiResponse })) {
+                        return [2 /*return*/, true];
+                    }
+                    return [2 /*return*/, false];
+            }
+        });
+    });
+};
+exports.default = invoke;

package/dist/aws/index.d.ts

@@ -0,0 +1,4 @@
+import isResponse200 from './isResponse200';
+import { AwsConfigType } from './types';
+export type { AwsConfigType, };
+export { isResponse200, };

package/dist/aws/index.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isResponse200 = void 0;
+var isResponse200_1 = __importDefault(require("./isResponse200"));
+exports.isResponse200 = isResponse200_1.default;

package/dist/aws/isResponse200.d.ts

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

package/dist/aws/isResponse200.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Was the API response a 200?
+ */
+var isResponse200 = function (_a) {
+    var apiResponse = _a.apiResponse;
+    var response = false;
+    if (undefined !== apiResponse['$metadata'] &&
+        undefined !== apiResponse['$metadata']['httpStatusCode'] &&
+        200 === apiResponse['$metadata']['httpStatusCode']) {
+        response = true;
+    }
+    return response;
+};
+exports.default = isResponse200;

package/dist/aws/lambda/getClient.d.ts

@@ -0,0 +1,10 @@
+import { AwsConfigType } from '../types';
+/**
+ * Shorthand function to get the Lambda Client.
+ * Library: @aws-sdk/client-lambda
+ */
+declare const getClient: ({ LambdaLib, config }: {
+    LambdaLib: any;
+    config: AwsConfigType;
+}) => any;
+export default getClient;

package/dist/aws/lambda/getClient.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var lambdaClient = undefined;
+/**
+ * Shorthand function to get the Lambda Client.
+ * Library: @aws-sdk/client-lambda
+ */
+var getClient = function (_a) {
+    var LambdaLib = _a.LambdaLib, config = _a.config;
+    if (undefined === lambdaClient) {
+        var LambdaClient = LambdaLib.LambdaClient;
+        lambdaClient = new LambdaClient(config);
+    }
+    return lambdaClient;
+};
+exports.default = getClient;

package/dist/aws/lambda/index.d.ts

@@ -0,0 +1,4 @@
+import getClient from './getClient';
+import invoke from './invoke';
+export type {};
+export { getClient, invoke, };

package/dist/aws/lambda/index.js

@@ -0,0 +1,10 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invoke = exports.getClient = void 0;
+var getClient_1 = __importDefault(require("./getClient"));
+exports.getClient = getClient_1.default;
+var invoke_1 = __importDefault(require("./invoke"));
+exports.invoke = invoke_1.default;

package/dist/aws/lambda/invoke.d.ts

@@ -0,0 +1,20 @@
+declare type InvokeType = {
+    LambdaLib: any;
+    client: any;
+    functionName: string;
+    payload?: object;
+    response?: boolean;
+};
+/**
+ * Invoke a AWS Lambda function by passing in the Function name and optional Payload data.
+ * Runs asynchronously, doesn't wait for function to fully end.
+ * Library: @aws-sdk/client-lambda
+ */
+declare const invoke: {
+    ({ LambdaLib, client, functionName, payload, response }: InvokeType): Promise<any>;
+    defaultProps: {
+        payload: any;
+        response: any;
+    };
+};
+export default invoke;