@8ms/helpers 1.1.7 → 1.1.10

package/dist/Class/BaseClass.d.ts

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

package/dist/Class/BaseClass.js

@@ -1,13 +1,4 @@
 "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 };
 };
@@ -21,44 +12,35 @@ var BaseClass = /** @class */ (function () {
     /**
      * 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);
+    BaseClass.prototype._setArray = function (_a) {
+        var input = _a.input, fields = _a.fields;
+        if ((0, isArray_1.default)(input)) {
+            (0, set_1.default)(this, fields, input);
         }
         else {
-            (0, set_1.default)(this, fields, [value]);
+            (0, set_1.default)(this, fields, [input]);
         }
         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);
+    BaseClass.prototype._setValue = function (_a) {
+        var input = _a.input, fields = _a.fields;
+        (0, set_1.default)(this, fields, input);
         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);
+    BaseClass.prototype._push = function (_a) {
+        var input = _a.input, fields = _a.fields;
+        var temp = this._get({ defaultValue: [], fields: fields });
+        if ((0, isArray_1.default)(input)) {
+            temp = temp.concat(input);
         }
         else {
-            temp = temp.push(value);
+            temp = temp.push(input);
         }
         (0, set_1.default)(this, fields, temp);
         return this;
@@ -66,11 +48,8 @@ var BaseClass = /** @class */ (function () {
     /**
      * 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];
-        }
+    BaseClass.prototype._get = function (_a) {
+        var defaultValue = _a.defaultValue, fields = _a.fields;
         return (0, defaultTo_1.default)({ defaultValue: defaultValue, instance: this, keys: fields });
     };
     return BaseClass;

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

@@ -1,10 +1,10 @@
 /**
  * Delete a single file.
  */
-declare const deleteFile: ({ S3Lib, bucket, client, file }: {
+declare const deleteFile: ({ S3Lib, bucket, client, key }: {
     S3Lib: any;
     bucket: string;
     client: any;
-    file: string;
+    key: string;
 }) => Promise<void>;
 export default deleteFile;

package/dist/aws/s3/deleteFile.js

@@ -40,7 +40,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * Delete a single file.
  */
 var deleteFile = function (_a) {
-    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, file = _a.file;
+    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, key = _a.key;
     return __awaiter(void 0, void 0, void 0, function () {
         var DeleteObjectCommand;
         return __generator(this, function (_b) {
@@ -49,7 +49,7 @@ var deleteFile = function (_a) {
                     DeleteObjectCommand = S3Lib.DeleteObjectCommand;
                     return [4 /*yield*/, client.send(new DeleteObjectCommand({
                             Bucket: bucket,
-                            Key: file,
+                            Key: key,
                         }))];
                 case 1:
                     _b.sent();

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

@@ -1,10 +1,10 @@
 /**
  * Delete multiple files.
  */
-declare const deleteFiles: ({ S3Lib, bucket, client, files }: {
+declare const deleteFiles: ({ S3Lib, bucket, client, keys }: {
     S3Lib: any;
     bucket: string;
     client: any;
-    files: string[];
+    keys: string[];
 }) => Promise<void>;
 export default deleteFiles;

package/dist/aws/s3/deleteFiles.js

@@ -40,7 +40,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * Delete multiple files.
  */
 var deleteFiles = function (_a) {
-    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, files = _a.files;
+    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, keys = _a.keys;
     return __awaiter(void 0, void 0, void 0, function () {
         var DeleteObjectsCommand;
         return __generator(this, function (_b) {
@@ -50,8 +50,8 @@ var deleteFiles = function (_a) {
                     return [4 /*yield*/, client.send(new DeleteObjectsCommand({
                             Bucket: bucket,
                             Delete: {
-                                Objects: files.map(function (file) { return ({
-                                    Key: file,
+                                Objects: keys.map(function (key) { return ({
+                                    Key: key,
                                 }); }),
                             },
                         }))];

package/dist/aws/s3/{deleteDirectory.d.ts → deleteFolder.d.ts}

@@ -1,10 +1,10 @@
 /**
  * Iteratively delete all the files within a directory and delete the directory.
  */
-declare const deleteDirectory: ({ S3Lib, bucket, client, folder }: {
+declare const deleteFolder: ({ S3Lib, bucket, client, folder }: {
     S3Lib: any;
     bucket: string;
     client: any;
     folder: string;
 }) => Promise<void>;
-export default deleteDirectory;
+export default deleteFolder;

package/dist/aws/s3/{deleteDirectory.js → deleteFolder.js}

@@ -40,7 +40,7 @@ var string_1 = require("../../string");
 /**
  * Iteratively delete all the files within a directory and delete the directory.
  */
-var deleteDirectory = function (_a) {
+var deleteFolder = function (_a) {
     var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, folder = _a.folder;
     return __awaiter(void 0, void 0, void 0, function () {
         var cleanFolder, ListObjectsV2Command, DeleteObjectsCommand, apiResponse, keys;
@@ -71,7 +71,7 @@ var deleteDirectory = function (_a) {
                     // Delete the files
                     _b.sent();
                     if (!apiResponse.IsTruncated) return [3 /*break*/, 4];
-                    return [4 /*yield*/, deleteDirectory({ S3Lib: S3Lib, bucket: bucket, client: client, folder: folder })];
+                    return [4 /*yield*/, deleteFolder({ S3Lib: S3Lib, bucket: bucket, client: client, folder: folder })];
                 case 3:
                     _b.sent();
                     _b.label = 4;
@@ -80,4 +80,4 @@ var deleteDirectory = function (_a) {
         });
     });
 };
-exports.default = deleteDirectory;
+exports.default = deleteFolder;

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

@@ -4,17 +4,17 @@ declare type PresignedPostType = {
     client: any;
     conditions: any[];
     expires: number;
-    file: string;
     fields: {
         [key: string]: string;
     };
+    key: string;
 };
 /**
  * Returns a presigned post to upload a file directly to S3.
  * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_s3_presigned_post.html
  * https://github.com/8millionstories-organisation/test-vercel-upload-2/blob/50eb12fcb3870a59ab455811bfaa1bdcb886edf2/pages/api/upload-url.js
  */
-declare const getPresignedPost: ({ S3Lib, bucket, client, conditions, expires, file, fields }: PresignedPostType) => Promise<{
+declare const getPresignedPost: ({ S3Lib, bucket, client, conditions, expires, fields, key }: PresignedPostType) => Promise<{
     url: any;
     fields: any;
 }>;

package/dist/aws/s3/getPresignedPost.js

@@ -42,7 +42,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * https://github.com/8millionstories-organisation/test-vercel-upload-2/blob/50eb12fcb3870a59ab455811bfaa1bdcb886edf2/pages/api/upload-url.js
  */
 var getPresignedPost = function (_a) {
-    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, conditions = _a.conditions, expires = _a.expires, file = _a.file, fields = _a.fields;
+    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, conditions = _a.conditions, expires = _a.expires, fields = _a.fields, key = _a.key;
     return __awaiter(void 0, void 0, void 0, function () {
         var createPresignedPost, apiResponse;
         return __generator(this, function (_b) {
@@ -51,7 +51,7 @@ var getPresignedPost = function (_a) {
                     createPresignedPost = S3Lib.createPresignedPost;
                     return [4 /*yield*/, createPresignedPost(client, {
                             Bucket: bucket,
-                            Key: file,
+                            Key: key,
                             Conditions: undefined === conditions ? [] : conditions,
                             Fields: undefined === fields ? {} : fields,
                             Expires: undefined === expires ? 60 : expires, // Seconds

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

@@ -5,11 +5,11 @@ declare type GetSignedUrlType = {
     bucket: string;
     client: any;
     expires: number;
-    file: string;
+    key: string;
 };
 /**
  * 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<ResponseType>;
+declare const getSignedUrl: ({ S3Lib, S3PresignerLib, bucket, client, expires, key }: GetSignedUrlType) => Promise<ResponseType>;
 export default getSignedUrl;

package/dist/aws/s3/getSignedUrl.js

@@ -53,7 +53,7 @@ var api_1 = require("../../api");
  * Library: @aws-sdk/s3-request-presigner
  */
 var getSignedUrl = function (_a) {
-    var S3Lib = _a.S3Lib, S3PresignerLib = _a.S3PresignerLib, bucket = _a.bucket, client = _a.client, expires = _a.expires, file = _a.file;
+    var S3Lib = _a.S3Lib, S3PresignerLib = _a.S3PresignerLib, bucket = _a.bucket, client = _a.client, expires = _a.expires, key = _a.key;
     return __awaiter(void 0, void 0, void 0, function () {
         var response, GetObjectCommand, getSignedUrl, command, awsResponse;
         return __generator(this, function (_b) {
@@ -64,7 +64,7 @@ var getSignedUrl = function (_a) {
                     getSignedUrl = S3PresignerLib.getSignedUrl;
                     command = new GetObjectCommand({
                         Bucket: bucket,
-                        Key: file,
+                        Key: key,
                     });
                     return [4 /*yield*/, getSignedUrl(client, command, { expiresIn: expires })];
                 case 1:

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

@@ -1,16 +1,15 @@
-import deleteDirectory from './deleteDirectory';
 import deleteFile from './deleteFile';
 import deleteFiles from './deleteFiles';
+import deleteFolder from './deleteFolder';
 import getClient from './getClient';
 import getPresignedPost from './getPresignedPost';
 import getSignedUrl from './getSignedUrl';
 import listFiles from './listFiles';
 import listFolders from './listFolders';
-import readBuffer from './readBuffer';
-import readFile from './readFile';
-import { ReadBufferType, ReadFileType, ReadType } from './types';
+import readBuffer, { ReadBufferType } from './readBuffer';
+import readFile, { ReadFileType, ReadType } from './readFile';
 import writeFile from './writeFile';
 import writeGlueJsonFile from './writeGlueJsonFile';
 import writePresignedPost from './writePresignedPost';
 export type { ReadType, ReadBufferType, ReadFileType, };
-export { deleteDirectory, deleteFile, deleteFiles, getClient, getPresignedPost, getSignedUrl, listFiles, listFolders, readBuffer, readFile, writeFile, writeGlueJsonFile, writePresignedPost, };
+export { deleteFolder, deleteFile, deleteFiles, getClient, getPresignedPost, getSignedUrl, listFiles, listFolders, readBuffer, readFile, writeFile, writeGlueJsonFile, writePresignedPost, };

package/dist/aws/s3/index.js

@@ -3,13 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writePresignedPost = exports.writeGlueJsonFile = exports.writeFile = exports.readFile = exports.readBuffer = exports.listFolders = exports.listFiles = exports.getSignedUrl = exports.getPresignedPost = exports.getClient = exports.deleteFiles = exports.deleteFile = exports.deleteDirectory = void 0;
-var deleteDirectory_1 = __importDefault(require("./deleteDirectory"));
-exports.deleteDirectory = deleteDirectory_1.default;
+exports.writePresignedPost = exports.writeGlueJsonFile = exports.writeFile = exports.readFile = exports.readBuffer = exports.listFolders = exports.listFiles = exports.getSignedUrl = exports.getPresignedPost = exports.getClient = exports.deleteFiles = exports.deleteFile = exports.deleteFolder = void 0;
 var deleteFile_1 = __importDefault(require("./deleteFile"));
 exports.deleteFile = deleteFile_1.default;
 var deleteFiles_1 = __importDefault(require("./deleteFiles"));
 exports.deleteFiles = deleteFiles_1.default;
+var deleteFolder_1 = __importDefault(require("./deleteFolder"));
+exports.deleteFolder = deleteFolder_1.default;
 var getClient_1 = __importDefault(require("./getClient"));
 exports.getClient = getClient_1.default;
 var getPresignedPost_1 = __importDefault(require("./getPresignedPost"));

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

@@ -1,11 +1,14 @@
-import { ReadBufferType } from './types';
+import { ReadType } from './readFile';
+export declare type ReadBufferType = ReadType & {
+    buffer: any;
+};
 /**
  * Similar function to reading the S3 file, but instead of a text file return a buffer.
  */
-declare const readBuffer: ({ S3Lib, bucket, client, file }: {
+declare const readBuffer: ({ S3Lib, bucket, client, key }: {
     S3Lib: any;
     bucket: string;
     client: any;
-    file: string;
+    key: string;
 }) => Promise<ReadBufferType>;
 export default readBuffer;

package/dist/aws/s3/readBuffer.js

@@ -45,7 +45,7 @@ var isResponse200_1 = __importDefault(require("../isResponse200"));
  * Similar function to reading the S3 file, but instead of a text file return a buffer.
  */
 var readBuffer = function (_a) {
-    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, file = _a.file;
+    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, key = _a.key;
     return __awaiter(void 0, void 0, void 0, function () {
         var response, GetObjectCommand, apiResponse, chunks_1, _b;
         return __generator(this, function (_c) {
@@ -71,7 +71,7 @@ var readBuffer = function (_a) {
                     GetObjectCommand = S3Lib.GetObjectCommand;
                     return [4 /*yield*/, client.send(new GetObjectCommand({
                             Bucket: bucket,
-                            Key: file,
+                            Key: key,
                         }))];
                 case 1:
                     apiResponse = _c.sent();

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

@@ -1,12 +1,30 @@
-import { ReadFileType } from './types';
+export declare type ReadType = {
+    now: number;
+    modified: {
+        unix: null | number;
+        vsNow: {
+            months: number;
+            days: number;
+            hours: number;
+            minutes: number;
+        };
+        vsMidnight: {
+            hours: number;
+            minutes: number;
+        };
+    };
+};
+export declare type ReadFileType = ReadType & {
+    body: any;
+};
 /**
  * Read a file from S3 and return either null, the content or JSON decoded.
  */
-declare const readFile: ({ S3Lib, bucket, client, file, isJson }: {
+declare const readFile: ({ S3Lib, bucket, client, key, isJson }: {
     S3Lib: any;
     bucket: string;
     client: any;
-    file: string;
+    key: string;
     isJson: boolean;
 }) => Promise<ReadFileType>;
 export default readFile;

package/dist/aws/s3/readFile.js

@@ -52,7 +52,7 @@ var isResponse200_1 = __importDefault(require("../isResponse200"));
  * Read a file from S3 and return either null, the content or JSON decoded.
  */
 var readFile = function (_a) {
-    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, file = _a.file, isJson = _a.isJson;
+    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, key = _a.key, isJson = _a.isJson;
     return __awaiter(void 0, void 0, void 0, function () {
         var response, GetObjectCommand, apiResponse, now, modified, _b;
         return __generator(this, function (_c) {
@@ -78,7 +78,7 @@ var readFile = function (_a) {
                     GetObjectCommand = S3Lib.GetObjectCommand;
                     return [4 /*yield*/, client.send(new GetObjectCommand({
                             Bucket: bucket,
-                            Key: file,
+                            Key: key,
                         }))];
                 case 1:
                     apiResponse = _c.sent();

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

@@ -1,11 +1,11 @@
 /**
  * Write a file to S3.
  */
-export declare const writeFile: ({ S3Lib, bucket, client, file, content }: {
+export declare const writeFile: ({ S3Lib, bucket, client, data, key }: {
     S3Lib: any;
     bucket: string;
     client: any;
-    file: string;
-    content: any;
+    data: any;
+    key: string;
 }) => Promise<any>;
 export default writeFile;

package/dist/aws/s3/writeFile.js

@@ -41,7 +41,7 @@ exports.writeFile = void 0;
  * Write a file to S3.
  */
 var writeFile = function (_a) {
-    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, file = _a.file, content = _a.content;
+    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, data = _a.data, key = _a.key;
     return __awaiter(void 0, void 0, void 0, function () {
         var PutObjectCommand, apiResponse;
         return __generator(this, function (_b) {
@@ -50,8 +50,8 @@ var writeFile = function (_a) {
                     PutObjectCommand = S3Lib.PutObjectCommand;
                     return [4 /*yield*/, client.send(new PutObjectCommand({
                             Bucket: bucket,
-                            Body: content,
-                            Key: file,
+                            Body: data,
+                            Key: key,
                         }))];
                 case 1:
                     apiResponse = _b.sent();

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

@@ -5,11 +5,11 @@ declare type WritePresignedPostType = {
     config: ConfigType;
     fields: any;
     file: any;
-    fileName: string;
+    key: string;
     url: string;
 };
 /**
  * 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<ResponseType>;
+declare const writePresignedPost: ({ bucket, config, fields, file, key, url }: WritePresignedPostType) => Promise<ResponseType>;
 export default writePresignedPost;

package/dist/aws/s3/writePresignedPost.js

@@ -52,7 +52,7 @@ var api_1 = require("../../api");
  * Get a presigned post URL so we can upload directly to S3 via frontend.
  */
 var writePresignedPost = function (_a) {
-    var bucket = _a.bucket, config = _a.config, fields = _a.fields, file = _a.file, fileName = _a.fileName, url = _a.url;
+    var bucket = _a.bucket, config = _a.config, fields = _a.fields, file = _a.file, key = _a.key, url = _a.url;
     return __awaiter(void 0, void 0, void 0, function () {
         return __generator(this, function (_b) {
             return [2 /*return*/, new Promise(function (resolve, reject) { return __awaiter(void 0, void 0, void 0, function () {
@@ -78,7 +78,7 @@ var writePresignedPost = function (_a) {
                                 if (upload.ok) {
                                     response.state = api_1.states.SUCCESS;
                                     response.body = {
-                                        url: "https://".concat(bucket, ".s3.").concat(config.region, ".amazonaws.com/").concat(fileName),
+                                        url: "https://".concat(bucket, ".s3.").concat(config.region, ".amazonaws.com/").concat(key),
                                     };
                                     resolve(response);
                                 }

package/dist/aws/s3cache/getCache.js

@@ -48,7 +48,7 @@ var getCache = function (_a) {
             switch (_b.label) {
                 case 0:
                     client = (0, s3_1.getClient)({ S3Lib: S3Lib, config: config });
-                    return [4 /*yield*/, (0, s3_1.readFile)({ S3Lib: S3Lib, bucket: bucket, client: client, file: key, isJson: isJson })];
+                    return [4 /*yield*/, (0, s3_1.readFile)({ S3Lib: S3Lib, bucket: bucket, client: client, key: key, isJson: isJson })];
                 case 1:
                     _b.sent();
                     return [2 /*return*/];

package/dist/aws/s3cache/saveCache.js

@@ -48,7 +48,7 @@ var saveCache = function (_a) {
             switch (_b.label) {
                 case 0:
                     client = (0, s3_1.getClient)({ S3Lib: S3Lib, config: config });
-                    return [4 /*yield*/, (0, s3_1.writeFile)({ S3Lib: S3Lib, bucket: bucket, client: client, file: key, content: data })];
+                    return [4 /*yield*/, (0, s3_1.writeFile)({ S3Lib: S3Lib, bucket: bucket, client: client, data: data, key: key })];
                 case 1:
                     _b.sent();
                     return [2 /*return*/];

package/dist/aws/s3cache/updateCache.js

@@ -52,7 +52,7 @@ var updateCache = function (_a) {
             switch (_b.label) {
                 case 0:
                     client = (0, s3_1.getClient)({ S3Lib: S3Lib, config: config });
-                    return [4 /*yield*/, (0, s3_1.deleteFile)({ S3Lib: S3Lib, bucket: bucket, client: client, file: key })];
+                    return [4 /*yield*/, (0, s3_1.deleteFile)({ S3Lib: S3Lib, bucket: bucket, client: client, key: key })];
                 case 1:
                     _b.sent();
                     return [4 /*yield*/, (0, saveCache_1.default)({ S3Lib: S3Lib, bucket: bucket, config: config, data: data, key: key })];

package/dist/aws/ses/SimpleEmail.js

@@ -105,39 +105,39 @@ var SimpleEmail = /** @class */ (function (_super) {
     }
     SimpleEmail.prototype.setFrom = function (_a) {
         var from = _a.from;
-        return this._setValue(from, 'from');
+        return this._setValue({ input: from, fields: 'from' });
     };
     SimpleEmail.prototype.setHtml = function (_a) {
         var html = _a.html;
-        return this._setValue(html, 'html');
+        return this._setValue({ input: html, fields: 'html' });
     };
     SimpleEmail.prototype.setSubject = function (_a) {
         var subject = _a.subject;
-        return this._setValue(subject, 'subject');
+        return this._setValue({ input: subject, fields: 'subject' });
     };
     SimpleEmail.prototype.pushBcc = function (_a) {
         var recipient = _a.recipient;
-        return this._push(recipient, 'bcc');
+        return this._push({ input: recipient, fields: 'bcc' });
     };
     SimpleEmail.prototype.pushCc = function (_a) {
         var recipient = _a.recipient;
-        return this._push(recipient, 'cc');
+        return this._push({ input: recipient, fields: 'cc' });
     };
     SimpleEmail.prototype.pushTo = function (_a) {
         var recipient = _a.recipient;
-        return this._push(recipient, 'to');
+        return this._push({ input: recipient, fields: 'to' });
     };
     SimpleEmail.prototype.setBcc = function (_a) {
         var recipient = _a.recipient;
-        return this._setArray(recipient, 'bcc');
+        return this._setArray({ input: recipient, fields: 'bcc' });
     };
     SimpleEmail.prototype.setCc = function (_a) {
         var recipient = _a.recipient;
-        return this._setArray(recipient, 'cc');
+        return this._setArray({ input: recipient, fields: 'cc' });
     };
     SimpleEmail.prototype.setTo = function (_a) {
         var recipient = _a.recipient;
-        return this._setArray(recipient, 'to');
+        return this._setArray({ input: recipient, fields: 'to' });
     };
     SimpleEmail.prototype.send = function (_a) {
         var SesLib = _a.SesLib, client = _a.client;

package/dist/boolean/getBoolean.d.ts

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

package/dist/boolean/getBoolean.js

@@ -7,7 +7,8 @@ var isBoolean_1 = __importDefault(require("lodash/isBoolean"));
 /**
  * Convert an input from a variety of forms into boolean.
  */
-var getBoolean = function (input) {
+var getBoolean = function (_a) {
+    var input = _a.input;
     if ((0, isBoolean_1.default)(input)) {
         return input;
     }

package/dist/crypto/getDecrypt.d.ts

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

package/dist/crypto/getDecrypt.js

@@ -5,9 +5,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * Library: crypto-js
  */
 var getDecrypt = function (_a) {
-    var CryptoLib = _a.CryptoLib, appSalt = _a.appSalt, salt = _a.salt, value = _a.value;
+    var CryptoLib = _a.CryptoLib, appSalt = _a.appSalt, input = _a.input, salt = _a.salt;
     var customSalt = "".concat(appSalt, "-").concat(salt);
-    return CryptoLib.AES.decrypt(value, customSalt)
+    return CryptoLib.AES.decrypt(input, customSalt)
         .toString(CryptoLib.enc.Utf8);
 };
 exports.default = getDecrypt;

package/dist/crypto/getEncrypt.d.ts

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

package/dist/crypto/getEncrypt.js

@@ -5,9 +5,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * Library: crypto-js
  */
 var getEncrypt = function (_a) {
-    var CryptoLib = _a.CryptoLib, appSalt = _a.appSalt, salt = _a.salt, value = _a.value;
+    var CryptoLib = _a.CryptoLib, appSalt = _a.appSalt, input = _a.input, salt = _a.salt;
     var customSalt = "".concat(appSalt, "-").concat(salt);
-    return CryptoLib.AES.encrypt(value, customSalt)
+    return CryptoLib.AES.encrypt(input, customSalt)
         .toString();
 };
 exports.default = getEncrypt;

package/package.json

@@ -1,15 +1,12 @@
 {
   "name": "@8ms/helpers",
-  "version": "1.1.7",
+  "version": "1.1.10",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"
   },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": [
-    "dist/**/*"
-  ],
   "scripts": {
     "build": "rimraf dist && tsc",
     "jest": "jest --watch"

package/dist/array/tests/contains.test.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var index_1 = require("../index");
-test('contains - does contain', function () {
-    var haystack = [1, 2, 3, 4];
-    expect((0, index_1.contains)({ haystack: haystack, needle: 1 }))
-        .toBeTruthy();
-    expect((0, index_1.contains)({ haystack: haystack, needle: 2 }))
-        .toBeTruthy();
-    expect((0, index_1.contains)({ haystack: haystack, needle: 3 }))
-        .toBeTruthy();
-    expect((0, index_1.contains)({ haystack: haystack, needle: 4 }))
-        .toBeTruthy();
-});
-test('contains - does not contain', function () {
-    expect((0, index_1.contains)({ haystack: [1, 2, 3, 4], needle: 9 }))
-        .toBeFalsy();
-});

package/dist/array/tests/getArray.test.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var index_1 = require("../index");
-test('getArray - string', function () {
-    var inputString = 'some-input';
-    var expected = ['some-input'];
-    expect((0, index_1.getArray)({ input: inputString }))
-        .toStrictEqual(expected);
-});
-test('getArray - string[]', function () {
-    var inputArray = ['some-input'];
-    var expected = ['some-input'];
-    expect((0, index_1.getArray)({ input: inputArray }))
-        .toStrictEqual(expected);
-});

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

@@ -1,22 +0,0 @@
-export declare type ReadType = {
-    now: number;
-    modified: {
-        unix: null | number;
-        vsNow: {
-            months: number;
-            days: number;
-            hours: number;
-            minutes: number;
-        };
-        vsMidnight: {
-            hours: number;
-            minutes: number;
-        };
-    };
-};
-export declare type ReadBufferType = ReadType & {
-    buffer: any;
-};
-export declare type ReadFileType = ReadType & {
-    body: any;
-};

package/dist/aws/s3/types.js

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

package/dist/boolean/tests/getBoolean.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/boolean/tests/getBoolean.test.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var index_1 = require("../index");
-test('getBoolean - True', function () {
-    expect((0, index_1.getBoolean)(true))
-        .toBeTruthy();
-    expect((0, index_1.getBoolean)(1))
-        .toBeTruthy();
-    expect((0, index_1.getBoolean)('1'))
-        .toBeTruthy();
-});
-test('getBoolean - False', function () {
-    expect((0, index_1.getBoolean)(false))
-        .toBeFalsy();
-    expect((0, index_1.getBoolean)(0))
-        .toBeFalsy();
-    expect((0, index_1.getBoolean)('0'))
-        .toBeFalsy();
-});
-test('getBoolean - Unexpected', function () {
-    expect((0, index_1.getBoolean)('test'))
-        .toBeFalsy();
-});

package/dist/crypto/tests/getEncryptDecrypt.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/crypto/tests/getEncryptDecrypt.test.js

@@ -1,46 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var CryptoJS = __importStar(require("crypto-js"));
-var index_1 = require("../index");
-var index_2 = require("../index");
-test('getEncrypt and getDecrypt', function () {
-    var input = 'this is a test';
-    // Value changes based on the time, cannot verify
-    var encrypted = (0, index_1.getEncrypt)({
-        CryptoLib: CryptoJS,
-        appSalt: 'abc',
-        salt: '123',
-        value: input,
-    });
-    var decrypted = (0, index_2.getDecrypt)({
-        CryptoLib: CryptoJS,
-        appSalt: 'abc',
-        salt: '123',
-        value: encrypted,
-    });
-    expect(input)
-        .toBe(decrypted);
-});

package/dist/crypto/tests/getSha256.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/crypto/tests/getSha256.test.js

@@ -1,37 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var CryptoJS = __importStar(require("crypto-js"));
-var index_1 = require("../index");
-test('getSha256', function () {
-    var input = 'this is a test';
-    var expected = '2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c';
-    var encrypted = (0, index_1.getSha256)({
-        CryptoLib: CryptoJS,
-        input: input,
-    });
-    expect(encrypted)
-        .toBe(expected);
-});

package/dist/date/tests/format.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/date/tests/format.test.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var index_1 = require("../index");
-test('format', function () {
-    var expected = '01/02/2021';
-    var dateFormat = 'dd/MM/yyyy';
-    var dateNumber = 20210201;
-    expect((0, index_1.format)({ input: dateNumber, dateFormat: dateFormat }))
-        .toBe(expected);
-});

package/dist/date/tests/getDate.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/date/tests/getDate.test.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var index_1 = require("../index");
-test('getDate', function () {
-    var expected = new Date('2021-02-01 00:00:00');
-    var parsed = (0, index_1.getDate)({ input: 20210201 });
-    expect(parsed)
-        .toMatchObject(expected);
-});

package/dist/date/tests/getNumber.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/date/tests/getNumber.test.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var index_1 = require("../index");
-test('getNumber', function () {
-    var expected = 20210201;
-    var parsed = (0, index_1.getNumber)({ input: new Date('2021-02-01 00:00:00') });
-    expect(parsed)
-        .toBe(expected);
-});

package/dist/nextJs/tests/getIp.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/nextJs/tests/getIp.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var index_1 = require("../index");
-test('getIp - Exists', function () {
-    var request = {
-        headers: {
-            'x-real-ip': 'value',
-        }
-    };
-    expect((0, index_1.getIp)({ req: request }))
-        .toBe('value');
-});
-test('getIp - Undefined', function () {
-    var request = {
-        headers: {}
-    };
-    expect((0, index_1.getIp)({ req: request }))
-        .toBe('unset');
-});

package/dist/nextJs/tests/getUserAgent.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/nextJs/tests/getUserAgent.test.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var index_1 = require("../index");
-test('getUserAgent - Exists', function () {
-    var request = {
-        headers: {
-            'user-agent': 'value',
-        },
-    };
-    expect((0, index_1.getUserAgent)({ req: request }))
-        .toBe('value');
-});
-test('getUserAgent - Undefined', function () {
-    var request = {
-        headers: {},
-    };
-    expect((0, index_1.getUserAgent)({ req: request }))
-        .toBe('unset');
-});

package/dist/number/tests/getNumber.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/number/tests/getNumber.test.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var index_1 = require("../index");
-test('getNumber - should be number', function () {
-    expect((0, index_1.getNumber)({ defaultValue: 10, input: 99 }))
-        .toBe(99);
-    expect((0, index_1.getNumber)({ defaultValue: 10, input: '99' }))
-        .toBe(99);
-    expect((0, index_1.getNumber)({ defaultValue: 10, input: 5 * 25 }))
-        .toBe(125);
-    expect((0, index_1.getNumber)({ defaultValue: 10, input: '_50' }))
-        .toBe(50);
-    expect((0, index_1.getNumber)({ defaultValue: 10, input: '33.3232%' }))
-        .toBe(33.3232);
-});
-test('getNumber - revert to default', function () {
-    expect((0, index_1.getNumber)({ defaultValue: 10, input: {} }))
-        .toBe(10);
-    expect((0, index_1.getNumber)({ input: {} }))
-        .toBe(0);
-});

package/dist/string/tests/getCleanFolder.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/string/tests/getCleanFolder.test.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var index_1 = require("../index");
-test('getCleanFolder', function () {
-    var input = ' /some-folder/ ';
-    var expected = '/some-folder/';
-    expect((0, index_1.getCleanFolder)({ input: input }))
-        .toBe(expected);
-});

package/dist/url/tests/isAbsolute.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/url/tests/isAbsolute.test.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var index_1 = require("../index");
-test('isAbsolute', function () {
-    var absolute = 'https://www.google.com';
-    var relative = '/something';
-    expect((0, index_1.isAbsolute)({ input: absolute }))
-        .toBeTruthy();
-    expect((0, index_1.isAbsolute)({ input: relative }))
-        .toBeFalsy();
-});

package/dist/url/tests/isRelative.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/url/tests/isRelative.test.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var index_1 = require("../index");
-test('isRelative', function () {
-    var absolute = 'https://www.google.com';
-    var relative = '/something';
-    expect((0, index_1.isRelative)({ input: absolute }))
-        .toBeFalsy();
-    expect((0, index_1.isRelative)({ input: relative }))
-        .toBeTruthy();
-});

package/dist/util/tests/defaultTo.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/util/tests/defaultTo.test.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var index_1 = require("../index");
-test('defaultTo - exists', function () {
-    var instance = {
-        'something': 'a b c',
-        'level one': {
-            'level two': 'inner',
-        },
-    };
-    expect((0, index_1.defaultTo)({ defaultValue: 'not found', instance: instance, keys: 'something' }))
-        .toBe('a b c');
-    expect((0, index_1.defaultTo)({ defaultValue: 'not found', instance: instance, keys: ['level one', 'level two'] }))
-        .toBe('inner');
-});
-test('defaultTo - doesnt exist', function () {
-    var instance = {
-        'something': 'a b c',
-        'level one': {
-            'level two': 'inner',
-        },
-    };
-    expect((0, index_1.defaultTo)({ defaultValue: true, instance: instance, keys: 'not here' }))
-        .toBeTruthy();
-    expect((0, index_1.defaultTo)({ defaultValue: 'not found', instance: instance, keys: ['level one', 'level two', 'level three'] }))
-        .toBe('not found');
-});