@8ms/helpers 1.0.1

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

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

package/dist/aws/ses/getClient.js

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

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

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

package/dist/aws/ses/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.SimpleEmail = exports.getClient = void 0;
+var getClient_1 = __importDefault(require("./getClient"));
+exports.getClient = getClient_1.default;
+var SimpleEmail_1 = __importDefault(require("./SimpleEmail"));
+exports.SimpleEmail = SimpleEmail_1.default;

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

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

package/dist/aws/ssm/getClient.js

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

package/dist/aws/ssm/getParameter.d.ts

@@ -0,0 +1,12 @@
+declare type GetParameterType = {
+    SsmLib: any;
+    client: any;
+    name: string;
+    withDecryption: boolean;
+    isJson: boolean;
+};
+/**
+ * Get a parameter and decryption if necessary (secure string)
+ */
+declare const getParameter: ({ SsmLib, client, name, withDecryption, isJson }: GetParameterType) => Promise<any>;
+export default getParameter;

package/dist/aws/ssm/getParameter.js

@@ -0,0 +1,85 @@
+"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 });
+var ssmParameters = {};
+/**
+ * Get a parameter and decryption if necessary (secure string)
+ */
+var getParameter = function (_a) {
+    var SsmLib = _a.SsmLib, client = _a.client, name = _a.name, withDecryption = _a.withDecryption, isJson = _a.isJson;
+    return __awaiter(void 0, void 0, void 0, function () {
+        var response, GetParameterCommand, apiResponse, error_1;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    response = undefined;
+                    if (!(undefined === ssmParameters[name])) return [3 /*break*/, 5];
+                    _b.label = 1;
+                case 1:
+                    _b.trys.push([1, 3, , 4]);
+                    GetParameterCommand = SsmLib.GetParameterCommand;
+                    return [4 /*yield*/, client.send(new GetParameterCommand({
+                            Name: name,
+                            WithDecryption: withDecryption || true,
+                        }))];
+                case 2:
+                    apiResponse = _b.sent();
+                    if (apiResponse.Parameter.Value) {
+                        response = apiResponse.Parameter.Value;
+                        ssmParameters[name] = response;
+                        if (isJson && undefined !== response) {
+                            response = JSON.parse(response) || undefined;
+                            ssmParameters[name] = response;
+                        }
+                    }
+                    return [3 /*break*/, 4];
+                case 3:
+                    error_1 = _b.sent();
+                    // @ts-ignore
+                    console.log("SSM Error: ".concat(error_1.message));
+                    return [3 /*break*/, 4];
+                case 4: return [3 /*break*/, 6];
+                case 5:
+                    response = ssmParameters[name];
+                    _b.label = 6;
+                case 6: return [2 /*return*/, response];
+            }
+        });
+    });
+};
+exports.default = getParameter;

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

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

package/dist/aws/ssm/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.getParameter = exports.getClient = void 0;
+var getClient_1 = __importDefault(require("./getClient"));
+exports.getClient = getClient_1.default;
+var getParameter_1 = __importDefault(require("./getParameter"));
+exports.getParameter = getParameter_1.default;

package/dist/aws/types.d.ts

@@ -0,0 +1,5 @@
+export declare type AwsConfigType = {
+    accessKeyId: string;
+    region: string;
+    secretAccessKey: string;
+};

package/dist/aws/types.js

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

package/dist/boolean/getBoolean.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Convert an input from a variety of forms into boolean.
+ */
+declare const getBoolean: (input: any) => boolean;
+export default getBoolean;

package/dist/boolean/getBoolean.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var isBoolean_1 = __importDefault(require("lodash/isBoolean"));
+/**
+ * Convert an input from a variety of forms into boolean.
+ */
+var getBoolean = function (input) {
+    if ((0, isBoolean_1.default)(input)) {
+        return input;
+    }
+    return 'true' === input || 1 === input || '1' === input || 'yes' === input || 'y' === input;
+};
+exports.default = getBoolean;

package/dist/boolean/index.d.ts

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

package/dist/boolean/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.getBoolean = void 0;
+var getBoolean_1 = __importDefault(require("./getBoolean"));
+exports.getBoolean = getBoolean_1.default;

package/dist/crud/constants.d.ts

@@ -0,0 +1,6 @@
+export declare const CrudStatus: {
+    CREATE: string;
+    READ: string;
+    UPDATE: string;
+    DELETE: string;
+};

package/dist/crud/constants.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CrudStatus = void 0;
+exports.CrudStatus = {
+    CREATE: 'create',
+    READ: 'read',
+    UPDATE: 'update',
+    DELETE: 'delete',
+};

package/dist/crud/index.d.ts

@@ -0,0 +1,4 @@
+import { CrudStatus } from './constants';
+import { CrudType } from './types';
+export type { CrudType, };
+export { CrudStatus, };

package/dist/crud/index.js

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

package/dist/crud/types.d.ts

@@ -0,0 +1,2 @@
+import { CrudStatus } from './constants';
+export declare type CrudType = typeof CrudStatus.CREATE | typeof CrudStatus.READ | typeof CrudStatus.UPDATE | typeof CrudStatus.DELETE;

package/dist/crud/types.js

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

package/dist/crypto/getDecrypt.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Decrypt an encoding string using a salt
+ * Library: crypto-js
+ */
+declare const getDecrypt: ({ CryptoLib, appSalt, salt, value }: {
+    CryptoLib: any;
+    value: string;
+    salt: string;
+    appSalt: string;
+}) => string;
+export default getDecrypt;

package/dist/crypto/getDecrypt.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Decrypt an encoding string using a salt
+ * Library: crypto-js
+ */
+var getDecrypt = function (_a) {
+    var CryptoLib = _a.CryptoLib, appSalt = _a.appSalt, salt = _a.salt, value = _a.value;
+    var customSalt = "".concat(appSalt, "-").concat(salt);
+    return CryptoLib.AES.decrypt(value, customSalt)
+        .toString(CryptoLib.enc.Utf8);
+};
+exports.default = getDecrypt;

package/dist/crypto/getEncrypt.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Encrypt an encoding string using a salt
+ * Library: crypto-js
+ */
+declare const getEncrypt: ({ CryptoLib, appSalt, salt, value }: {
+    CryptoLib: any;
+    value: string;
+    salt: string;
+    appSalt: string;
+}) => string;
+export default getEncrypt;

package/dist/crypto/getEncrypt.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Encrypt an encoding string using a salt
+ * Library: crypto-js
+ */
+var getEncrypt = function (_a) {
+    var CryptoLib = _a.CryptoLib, appSalt = _a.appSalt, salt = _a.salt, value = _a.value;
+    var customSalt = "".concat(appSalt, "-").concat(salt);
+    return CryptoLib.AES.encrypt(value, customSalt)
+        .toString();
+};
+exports.default = getEncrypt;

package/dist/crypto/getRandom.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Create a random string and return a number of characters from it
+ */
+declare const getRandom: ({ length }: {
+    length: number;
+}) => string;
+export default getRandom;

package/dist/crypto/getRandom.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Create a random string and return a number of characters from it
+ */
+var getRandom = function (_a) {
+    var length = _a.length;
+    return Math.random()
+        .toString(36)
+        .substr(0, length);
+};
+exports.default = getRandom;

package/dist/crypto/getSha256.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Encrypt a string using sha256
+ */
+declare const getSha256: ({ CryptoLib, input }: {
+    CryptoLib: any;
+    input: string;
+}) => string;
+export default getSha256;

package/dist/crypto/getSha256.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Encrypt a string using sha256
+ */
+var getSha256 = function (_a) {
+    var CryptoLib = _a.CryptoLib, input = _a.input;
+    var sha256 = CryptoLib.sha256;
+    return sha256(input)
+        .toString();
+};
+exports.default = getSha256;

package/dist/crypto/index.d.ts

@@ -0,0 +1,6 @@
+import getDecrypt from './getDecrypt';
+import getEncrypt from './getEncrypt';
+import getRandom from './getRandom';
+import getSha256 from './getSha256';
+export type {};
+export { getDecrypt, getEncrypt, getRandom, getSha256, };

package/dist/crypto/index.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 });
+exports.getSha256 = exports.getRandom = exports.getEncrypt = exports.getDecrypt = void 0;
+var getDecrypt_1 = __importDefault(require("./getDecrypt"));
+exports.getDecrypt = getDecrypt_1.default;
+var getEncrypt_1 = __importDefault(require("./getEncrypt"));
+exports.getEncrypt = getEncrypt_1.default;
+var getRandom_1 = __importDefault(require("./getRandom"));
+exports.getRandom = getRandom_1.default;
+var getSha256_1 = __importDefault(require("./getSha256"));
+exports.getSha256 = getSha256_1.default;

package/dist/date/constants.d.ts

@@ -0,0 +1,21 @@
+export declare const Duration: {
+    FOREVER: string;
+    MONTHS: string;
+    DAYS: string;
+    HOURS: string;
+    MINUTES: string;
+};
+export declare const DurationComparison: {
+    VS_NOW: string;
+    VS_MIDNIGHT: string;
+};
+export declare const Timeframe: {
+    CURRENT: string;
+    COMPARISON: string;
+};
+export declare const TimeframePredefined: {
+    NONE: string;
+    CUSTOM: string;
+    THIS_WEEK: string;
+    LAST_WEEK: string;
+};

package/dist/date/constants.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimeframePredefined = exports.Timeframe = exports.DurationComparison = exports.Duration = void 0;
+exports.Duration = {
+    FOREVER: 'forever',
+    MONTHS: 'months',
+    DAYS: 'days',
+    HOURS: 'hours',
+    MINUTES: 'minutes',
+};
+exports.DurationComparison = {
+    VS_NOW: 'vsNow',
+    VS_MIDNIGHT: 'vsMidnight',
+};
+exports.Timeframe = {
+    CURRENT: 'current',
+    COMPARISON: 'comparison',
+};
+exports.TimeframePredefined = {
+    NONE: 'none',
+    CUSTOM: 'custom',
+    THIS_WEEK: 'thisWeek',
+    LAST_WEEK: 'lastWeek',
+};

package/dist/date/format.d.ts

@@ -0,0 +1,9 @@
+import { DateType } from './types';
+/**
+ * Convert a (number | string | Date) into a "yyyy-MM-dd" string or a specified format.
+ */
+declare const format: ({ input, dateFormat }: {
+    input: DateType;
+    dateFormat?: string;
+}) => string;
+export default format;

package/dist/date/format.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var format_1 = __importDefault(require("date-fns/format"));
+var getDate_1 = __importDefault(require("./getDate"));
+/**
+ * Convert a (number | string | Date) into a "yyyy-MM-dd" string or a specified format.
+ */
+var format = function (_a) {
+    var input = _a.input, dateFormat = _a.dateFormat;
+    return (0, format_1.default)((0, getDate_1.default)({ input: input }), dateFormat || 'yyyy-MM-dd');
+};
+exports.default = format;

package/dist/date/getDate.d.ts

@@ -0,0 +1,8 @@
+import { DateType } from './types';
+/**
+ * Convert a (number | string | Date) into a Date object.
+ */
+declare const getDate: ({ input }: {
+    input: DateType;
+}) => any;
+export default getDate;

package/dist/date/getDate.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var addHours_1 = __importDefault(require("date-fns/addHours"));
+var parse_1 = __importDefault(require("date-fns/parse"));
+var subHours_1 = __importDefault(require("date-fns/subHours"));
+/**
+ * Convert a (number | string | Date) into a Date object.
+ */
+var getDate = function (_a) {
+    var input = _a.input;
+    var date;
+    if (input instanceof Date) {
+        date = new Date(input.valueOf());
+    }
+    else if ('string' === typeof input) {
+        var dateString = input.toString() + ' 00:00:00';
+        date = (0, parse_1.default)(dateString, 'yyyy-MM-dd HH:mm:ss', new Date());
+    }
+    else if ('number' === typeof input) {
+        var dateString = input.toString() + ' 00:00:00';
+        date = (0, parse_1.default)(dateString, 'yyyyMMdd HH:mm:ss', new Date());
+    }
+    // Behind an hour (going back to DST)
+    if (date.getTimezoneOffset() < 0) {
+        date = (0, addHours_1.default)(date, 1);
+    }
+    // Forward an hour (going into BST)
+    else if (date.getTimezoneOffset() > 0) {
+        date = (0, subHours_1.default)(date, 1);
+    }
+    // Otherwise set to UTC hours
+    else {
+        date.setHours(0, 0, 0, 0);
+    }
+    return date;
+};
+exports.default = getDate;

package/dist/date/getDurationHours.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Convert a number 1000 seconds into HH:MM:SS
+ * https://stackoverflow.com/a/1322771
+ */
+declare const getDurationHours: ({ seconds }: {
+    seconds: number;
+}) => string;
+export default getDurationHours;

package/dist/date/getDurationHours.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var intervalToDuration_1 = __importDefault(require("date-fns/intervalToDuration"));
+/**
+ * Convert a number 1000 seconds into HH:MM:SS
+ * https://stackoverflow.com/a/1322771
+ */
+var getDurationHours = function (_a) {
+    var seconds = _a.seconds;
+    var response = '00:00:00';
+    if (seconds > 0) {
+        var duration = (0, intervalToDuration_1.default)({
+            start: 0,
+            end: seconds * 1000,
+        });
+        var output = {
+            hours: duration.hours < 10 ? '0' + duration.hours : duration.hours,
+            minutes: duration.minutes < 10 ? '0' + duration.minutes : duration.minutes,
+            seconds: duration.seconds < 10 ? '0' + duration.seconds : duration.seconds,
+        };
+        response = "".concat(output.hours, ":").concat(output.minutes, ":").concat(output.seconds);
+    }
+    return response;
+};
+exports.default = getDurationHours;

package/dist/date/getDurationMinutes.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Convert a number 1000 seconds into MM:SS
+ * https://stackoverflow.com/a/1322771
+ */
+declare const getDurationMinutes: ({ seconds }: {
+    seconds: number;
+}) => string;
+export default getDurationMinutes;

package/dist/date/getDurationMinutes.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var intervalToDuration_1 = __importDefault(require("date-fns/intervalToDuration"));
+/**
+ * Convert a number 1000 seconds into MM:SS
+ * https://stackoverflow.com/a/1322771
+ */
+var getDurationMinutes = function (_a) {
+    var seconds = _a.seconds;
+    var response = '00:00';
+    if (seconds > 0) {
+        var duration = (0, intervalToDuration_1.default)({
+            start: 0,
+            end: seconds * 1000,
+        });
+        var output = {
+            minutes: duration.minutes < 10 ? '0' + duration.minutes : duration.minutes,
+            seconds: duration.seconds < 10 ? '0' + duration.seconds : duration.seconds,
+        };
+        response = "".concat(output.minutes, ":").concat(output.seconds);
+    }
+    return response;
+};
+exports.default = getDurationMinutes;

package/dist/date/getFinancialYear.d.ts

@@ -0,0 +1,8 @@
+import { FinancialYearType } from './types';
+/**
+ * Get the current financial year.
+ */
+declare const getFinancialYear: ({ year }: {
+    year: number;
+}) => FinancialYearType;
+export default getFinancialYear;