@8ms/helpers 1.0.23 → 1.1.0

package/dist/api/index.d.ts

@@ -1,4 +1,5 @@
-import { ApiPlaceholder, ApiStatus, UnexpectedError } from './constants';
-import { ApiResponseType } from './types';
-export type { ApiResponseType, };
-export { ApiPlaceholder, ApiStatus, UnexpectedError, };
+import { response, ResponseType } from './response';
+import { states, StateType } from './states';
+import { unexpectedError } from './unexpectedError';
+export type { ResponseType, StateType, };
+export { response, states, unexpectedError, };

package/dist/api/index.js

@@ -1,7 +1,9 @@
 "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; } });
+exports.unexpectedError = exports.states = exports.response = void 0;
+var response_1 = require("./response");
+Object.defineProperty(exports, "response", { enumerable: true, get: function () { return response_1.response; } });
+var states_1 = require("./states");
+Object.defineProperty(exports, "states", { enumerable: true, get: function () { return states_1.states; } });
+var unexpectedError_1 = require("./unexpectedError");
+Object.defineProperty(exports, "unexpectedError", { enumerable: true, get: function () { return unexpectedError_1.unexpectedError; } });

package/dist/api/response.d.ts

@@ -0,0 +1,7 @@
+import { StateType } from './states';
+export declare type ResponseType = {
+    body: any | null;
+    error: string | null;
+    status: StateType;
+};
+export declare const response: ResponseType;

package/dist/api/response.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.response = void 0;
+var states_1 = require("./states");
+exports.response = {
+    body: null,
+    error: null,
+    status: states_1.states.IDLE,
+};

package/dist/api/states.d.ts

@@ -0,0 +1,8 @@
+export declare const states: {
+    ERROR: string;
+    IDLE: string;
+    PENDING: string;
+    SUCCESS: string;
+    VALIDATION_ERROR: string;
+};
+export declare type StateType = typeof states.ERROR | typeof states.IDLE | typeof states.PENDING | typeof states.SUCCESS | typeof states.VALIDATION_ERROR;

package/dist/api/states.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.states = void 0;
+exports.states = {
+    ERROR: 'error',
+    IDLE: 'idle',
+    PENDING: 'pending',
+    SUCCESS: 'success',
+    VALIDATION_ERROR: 'validationError',
+};

package/dist/api/unexpectedError.d.ts

@@ -0,0 +1 @@
+export declare const unexpectedError: string;

package/dist/api/unexpectedError.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unexpectedError = void 0;
+exports.unexpectedError = 'An unexpected error occurred, please try again.';

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

@@ -1,9 +1,9 @@
-import { AwsConfigType } from '../types';
+import { ConfigType } from '../config';
 declare type GetClientType = {
     AthenaExpress: any;
     AwsSdk: any;
     athenaS3: string;
-    config: AwsConfigType;
+    config: ConfigType;
     database: string;
 };
 /**

package/dist/aws/{types.d.ts → config.d.ts}

@@ -1,4 +1,4 @@
-export declare type AwsConfigType = {
+export declare type ConfigType = {
     accessKeyId: string;
     region: string;
     secretAccessKey: string;

package/dist/aws/getConfig.d.ts

@@ -1,9 +1,9 @@
-import { AwsConfigType } from './types';
+import { ConfigType } from './config';
 /**
  * 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: AwsConfigType;
+    config: ConfigType;
     isAthenaExpress: boolean;
 }) => object;
 export default getConfig;

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

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

package/dist/aws/index.d.ts

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

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

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

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

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

package/dist/aws/s3/getSignedUrl.d.ts

@@ -1,4 +1,4 @@
-import { ApiResponseType } from '../../api';
+import { ResponseType } from '../../api';
 declare type GetSignedUrlType = {
     S3Lib: any;
     S3PresignerLib: any;
@@ -11,5 +11,5 @@ declare type GetSignedUrlType = {
  * Returns a signed for URL to allow download of private buckets for a given duration.
  * Library: @aws-sdk/s3-request-presigner
  */
-declare const getSignedUrl: ({ S3Lib, S3PresignerLib, bucket, client, expires, file }: GetSignedUrlType) => Promise<ApiResponseType>;
+declare const getSignedUrl: ({ S3Lib, S3PresignerLib, bucket, client, expires, file }: GetSignedUrlType) => Promise<ResponseType>;
 export default getSignedUrl;

package/dist/aws/s3/getSignedUrl.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 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) {
@@ -44,11 +55,11 @@ var api_1 = require("../../api");
 var getSignedUrl = function (_a) {
     var S3Lib = _a.S3Lib, S3PresignerLib = _a.S3PresignerLib, bucket = _a.bucket, client = _a.client, expires = _a.expires, file = _a.file;
     return __awaiter(void 0, void 0, void 0, function () {
-        var response, GetObjectCommand, getSignedUrl, command, apiResponse;
+        var response, GetObjectCommand, getSignedUrl, command, awsResponse;
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
-                    response = api_1.ApiPlaceholder;
+                    response = __assign({}, api_1.response);
                     GetObjectCommand = S3Lib.GetObjectCommand;
                     getSignedUrl = S3PresignerLib.getSignedUrl;
                     command = new GetObjectCommand({
@@ -57,10 +68,10 @@ var getSignedUrl = function (_a) {
                     });
                     return [4 /*yield*/, getSignedUrl(client, command, { expiresIn: expires })];
                 case 1:
-                    apiResponse = _b.sent();
-                    if (apiResponse && 'string' === typeof apiResponse) {
-                        response.status = api_1.ApiStatus.SUCCESS;
-                        response.body = apiResponse;
+                    awsResponse = _b.sent();
+                    if (awsResponse && 'string' === typeof awsResponse) {
+                        response.status = api_1.states.SUCCESS;
+                        response.body = awsResponse;
                     }
                     return [2 /*return*/, response];
             }

package/dist/aws/s3/writePresignedPost.d.ts

@@ -1,8 +1,8 @@
-import { ApiResponseType } from '../../api';
-import { AwsConfigType } from '../types';
+import { ResponseType } from '../../api';
+import { ConfigType } from '../config';
 declare type WritePresignedPostType = {
     bucket: string;
-    config: AwsConfigType;
+    config: ConfigType;
     fields: any;
     file: any;
     fileName: string;
@@ -11,5 +11,5 @@ declare type WritePresignedPostType = {
 /**
  * Get a presigned post URL so we can upload directly to S3 via frontend.
  */
-declare const writePresignedPost: ({ bucket, config, fields, file, fileName, url }: WritePresignedPostType) => Promise<ApiResponseType>;
+declare const writePresignedPost: ({ bucket, config, fields, file, fileName, url }: WritePresignedPostType) => Promise<ResponseType>;
 export default writePresignedPost;

package/dist/aws/s3/writePresignedPost.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 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) {
@@ -49,7 +60,7 @@ var writePresignedPost = function (_a) {
                     return __generator(this, function (_a) {
                         switch (_a.label) {
                             case 0:
-                                response = api_1.ApiPlaceholder;
+                                response = __assign({}, api_1.response);
                                 formData = new FormData();
                                 Object.entries({ fields: fields, file: file })
                                     .forEach(function (_a) {
@@ -65,7 +76,7 @@ var writePresignedPost = function (_a) {
                                 upload = _a.sent();
                                 // Uploaded to S3
                                 if (upload.ok) {
-                                    response.status = api_1.ApiStatus.SUCCESS;
+                                    response.status = api_1.states.SUCCESS;
                                     response.body = {
                                         url: "https://".concat(bucket, ".s3.").concat(config.region, ".amazonaws.com/").concat(fileName),
                                     };
@@ -73,7 +84,7 @@ var writePresignedPost = function (_a) {
                                 }
                                 // Failed to upload to S3
                                 else {
-                                    response.status = api_1.ApiStatus.ERROR;
+                                    response.status = api_1.states.ERROR;
                                     response.error = 'Failed to upload file, please try again.';
                                     reject(response);
                                 }

package/dist/aws/s3cache/cache.d.ts

@@ -0,0 +1,6 @@
+import { durationComparisons, durations } from '../../date';
+export declare type CacheType = {
+    duration: number;
+    from: typeof durationComparisons.VS_MIDNIGHT | typeof durationComparisons.VS_NOW;
+    timeframe: typeof durations.FOREVER | typeof durations.MONTHS | typeof durations.DAYS | typeof durations.HOURS | typeof durations.MINUTES;
+};

package/dist/aws/s3cache/getCache.d.ts

@@ -1,4 +1,4 @@
-import { AwsConfigType } from '../types';
+import { ConfigType } from '../config';
 /**
  * Get the stored cache if it exists.
  */
@@ -6,7 +6,7 @@ declare const getCache: {
     ({ S3Lib, bucket, config, key, isJson }: {
         S3Lib: any;
         bucket: string;
-        config: AwsConfigType;
+        config: ConfigType;
         key: string;
         isJson: boolean;
     }): Promise<any>;

package/dist/aws/s3cache/getKey.d.ts

@@ -1,4 +1,4 @@
-import { PlatformType } from '../../environment/types';
+import { PlatformsType } from '../../environment/platforms';
 /**
  * Take an input and return the key.
  * Always in the "_cache" folder with the "environment" followed by the optional folder then the key.
@@ -7,6 +7,6 @@ declare const getKey: ({ CryptoLib, fileName, folder, platform }: {
     CryptoLib: any;
     fileName: any;
     folder: string;
-    platform: PlatformType;
+    platform: PlatformsType;
 }) => string;
 export default getKey;

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

@@ -1,7 +1,7 @@
 import getCache from './getCache';
 import getKey from './getKey';
 import saveCache from './saveCache';
-import { CacheExpiresType } from './types';
+import { CacheType } from './cache';
 import updateCache from './updateCache';
-export type { CacheExpiresType, };
+export type { CacheType, };
 export { getCache, getKey, saveCache, updateCache, };

package/dist/aws/s3cache/saveCache.d.ts

@@ -1,11 +1,11 @@
-import { AwsConfigType } from '../types';
+import { ConfigType } from '../config';
 /**
  * Save the cache.
  */
 declare const saveCache: ({ S3Lib, bucket, config, data, key }: {
     S3Lib: any;
     bucket: string;
-    config: AwsConfigType;
+    config: ConfigType;
     key: string;
     data: any;
 }) => Promise<void>;

package/dist/aws/s3cache/updateCache.d.ts

@@ -1,11 +1,11 @@
-import { AwsConfigType } from '../types';
+import { ConfigType } from '../config';
 /**
  * Delete other caches if present, then save the new file.
  */
 declare const updateCache: ({ S3Lib, bucket, config, data, key }: {
     S3Lib: any;
     bucket: string;
-    config: AwsConfigType;
+    config: ConfigType;
     data: any;
     key: string;
 }) => Promise<void>;

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

@@ -1,4 +1,4 @@
-import { ApiResponseType } from '../../api';
+import { ResponseType } from '../../api';
 import { BaseClass } from '../../Class';
 /**
  * Class to build and send an AWS SES email.
@@ -48,7 +48,7 @@ declare class SimpleEmail extends BaseClass {
     send({ SesLib, client }: {
         SesLib: any;
         client: any;
-    }): Promise<ApiResponseType>;
+    }): Promise<ResponseType>;
     private _filterRecipients;
 }
 export default SimpleEmail;

package/dist/aws/ses/SimpleEmail.js

@@ -142,12 +142,12 @@ var SimpleEmail = /** @class */ (function (_super) {
     SimpleEmail.prototype.send = function (_a) {
         var SesLib = _a.SesLib, client = _a.client;
         return __awaiter(this, void 0, void 0, function () {
-            var SendEmailCommand, response, params, command, apiResponse, error_1;
+            var SendEmailCommand, response, params, command, apiResponse_1, error_1;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         SendEmailCommand = SesLib.SendEmailCommand;
-                        response = __assign({}, api_1.ApiPlaceholder);
+                        response = __assign({}, api_1.response);
                         params = {
                             Destination: {
                                 BccAddresses: this._filterRecipients({ field: 'bcc' }),
@@ -178,19 +178,19 @@ var SimpleEmail = /** @class */ (function (_super) {
                         command = new SendEmailCommand(params);
                         return [4 /*yield*/, client.send(command)];
                     case 2:
-                        apiResponse = _b.sent();
-                        if ((0, isResponse200_1.default)({ apiResponse: apiResponse })) {
-                            response.status = api_1.ApiStatus.SUCCESS;
+                        apiResponse_1 = _b.sent();
+                        if ((0, isResponse200_1.default)({ apiResponse: apiResponse_1 })) {
+                            response.status = api_1.states.SUCCESS;
                         }
                         else {
-                            response.status = api_1.ApiStatus.ERROR;
+                            response.status = api_1.states.ERROR;
                             // @ts-ignore
                             response.error = "An unexpected error occurred.";
                         }
                         return [3 /*break*/, 4];
                     case 3:
                         error_1 = _b.sent();
-                        response.status = api_1.ApiStatus.ERROR;
+                        response.status = api_1.states.ERROR;
                         // @ts-ignore
                         response.error = error_1.message;
                         return [3 /*break*/, 4];

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

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

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

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

package/dist/axios/get.d.ts

@@ -1,3 +1,8 @@
-import { GetType } from './types';
+export declare type GetType = {
+    config?: object;
+    onError?: Function;
+    onSuccess?: Function;
+    url: string;
+};
 declare const get: ({ config, onError, onSuccess, url }: GetType) => Promise<any>;
 export default get;

package/dist/axios/get.js

@@ -55,7 +55,7 @@ var get = function (_a) {
                                 case 0:
                                     if (!(200 === response.status)) return [3 /*break*/, 12];
                                     if (!(undefined !== response.data.body && undefined !== response.data.error && undefined !== response.data.status)) return [3 /*break*/, 8];
-                                    if (!(api_1.ApiStatus.SUCCESS === response.data.status)) return [3 /*break*/, 4];
+                                    if (!(api_1.states.SUCCESS === response.data.status)) return [3 /*break*/, 4];
                                     if (!onSuccess) return [3 /*break*/, 2];
                                     return [4 /*yield*/, onSuccess(response.data.body)];
                                 case 1:

package/dist/axios/index.d.ts

@@ -1,5 +1,4 @@
-import { GetType, PostType } from './types';
-import get from './get';
-import post from './post';
+import get, { GetType } from './get';
+import post, { PostType } from './post';
 export type { GetType, PostType, };
 export { get, post, };

package/dist/axios/post.d.ts

@@ -1,4 +1,10 @@
-import { PostType } from './types';
+export declare type PostType = {
+    config?: object;
+    data?: object;
+    onError?: Function;
+    onSuccess?: Function;
+    url: string;
+};
 /**
  * Make a POST request.
  */

package/dist/axios/post.js

@@ -58,7 +58,7 @@ var post = function (_a) {
                                 case 0:
                                     if (!(200 === response.status)) return [3 /*break*/, 12];
                                     if (!(undefined !== response.data.body && undefined !== response.data.error && undefined !== response.data.status)) return [3 /*break*/, 8];
-                                    if (!(api_1.ApiStatus.SUCCESS === response.data.status)) return [3 /*break*/, 4];
+                                    if (!(api_1.states.SUCCESS === response.data.status)) return [3 /*break*/, 4];
                                     if (!onSuccess) return [3 /*break*/, 2];
                                     return [4 /*yield*/, onSuccess(response.data.body)];
                                 case 1:

package/dist/crud/index.d.ts

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

package/dist/crud/index.js

@@ -1,5 +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; } });
+exports.states = void 0;
+var states_1 = require("./states");
+Object.defineProperty(exports, "states", { enumerable: true, get: function () { return states_1.states; } });

package/dist/crud/states.d.ts

@@ -0,0 +1,7 @@
+export declare const states: {
+    CREATE: string;
+    READ: string;
+    UPDATE: string;
+    DELETE: string;
+};
+export declare type StateType = typeof states.CREATE | typeof states.READ | typeof states.UPDATE | typeof states.DELETE;

package/dist/crud/{constants.js → states.js}

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

package/dist/date/date.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A date can be either a number (YYYYMMDD), string (YYYY-MM-DD) or Date instance.
+ */
+export declare type DateType = number | string | Date;

package/dist/date/duration.d.ts

@@ -0,0 +1,5 @@
+export declare type DurationType = {
+    hours: number;
+    minutes: number;
+    seconds: number;
+};

package/dist/date/durationComparisons.d.ts

@@ -0,0 +1,4 @@
+export declare const durationComparisons: {
+    VS_NOW: string;
+    VS_MIDNIGHT: string;
+};

package/dist/date/durationComparisons.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.durationComparisons = void 0;
+exports.durationComparisons = {
+    VS_NOW: 'vsNow',
+    VS_MIDNIGHT: 'vsMidnight',
+};

package/dist/date/durations.d.ts

@@ -0,0 +1,7 @@
+export declare const durations: {
+    FOREVER: string;
+    MONTHS: string;
+    DAYS: string;
+    HOURS: string;
+    MINUTES: string;
+};

package/dist/date/durations.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.durations = void 0;
+exports.durations = {
+    FOREVER: 'forever',
+    MONTHS: 'months',
+    DAYS: 'days',
+    HOURS: 'hours',
+    MINUTES: 'minutes',
+};

package/dist/date/financialYear.d.ts

@@ -0,0 +1,4 @@
+export declare type FinancialYearType = {
+    end: Date;
+    start: Date;
+};

package/dist/date/financialYearWeek.d.ts

@@ -0,0 +1,6 @@
+export declare type FinancialYearWeekType = {
+    end: Date;
+    financialWeek: number;
+    financialYear: number;
+    start: Date;
+};

package/dist/date/format.d.ts

@@ -1,4 +1,4 @@
-import { DateType } from './types';
+import { DateType } from './date';
 /**
  * Convert a (number | string | Date) into a "yyyy-MM-dd" string or a specified format.
  */

package/dist/date/getDate.d.ts

@@ -1,4 +1,4 @@
-import { DateType } from './types';
+import { DateType } from './date';
 /**
  * Convert a (number | string | Date) into a Date object.
  */