@8ms/helpers 1.0.22 → 1.0.23

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

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

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

@@ -0,0 +1,18 @@
+"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/aws/s3/deleteDirectory.js

@@ -47,7 +47,7 @@ var deleteDirectory = function (_a) {
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
-                    cleanFolder = (0, string_1.getCleanFolder)(folder);
+                    cleanFolder = (0, string_1.getCleanFolder)({ input: folder });
                     ListObjectsV2Command = S3Lib.ListObjectsV2Command, DeleteObjectsCommand = S3Lib.DeleteObjectsCommand;
                     return [4 /*yield*/, client.send(new ListObjectsV2Command({
                             Bucket: bucket,

package/dist/aws/s3/listFiles.js

@@ -47,7 +47,7 @@ var listFiles = function (_a) {
         return __generator(this, function (_c) {
             switch (_c.label) {
                 case 0:
-                    cleanFolder = (0, string_1.getCleanFolder)(folder);
+                    cleanFolder = (0, string_1.getCleanFolder)({ input: folder });
                     response = [];
                     valid = [];
                     ListObjectsV2Command = S3Lib.ListObjectsV2Command;

package/dist/aws/s3/listFolders.js

@@ -47,7 +47,7 @@ var listFolders = function (_a) {
         return __generator(this, function (_c) {
             switch (_c.label) {
                 case 0:
-                    cleanFolder = (0, string_1.getCleanFolder)(folder);
+                    cleanFolder = (0, string_1.getCleanFolder)({ input: folder });
                     response = [];
                     ListObjectsV2Command = S3Lib.ListObjectsV2Command;
                     return [4 /*yield*/, client.send(new ListObjectsV2Command({

package/dist/aws/s3/readFile.js

@@ -97,7 +97,7 @@ var readFile = function (_a) {
                     response.modified.vsMidnight.minutes = (0, getMinutes_1.default)(now);
                     // Convert stream into a string
                     _b = response;
-                    return [4 /*yield*/, (0, string_1.getStringFromStream)(apiResponse.Body)];
+                    return [4 /*yield*/, (0, string_1.getStringFromStream)({ stream: apiResponse.Body })];
                 case 2:
                     // Convert stream into a string
                     _b.body = _c.sent();

package/dist/number/getNumber.d.ts

@@ -1,7 +1,7 @@
 /**
  * Take an input and return a number.
  */
-declare const getNumber: ({ defaultValue, input }?: {
+declare const getNumber: ({ defaultValue, input }: {
     defaultValue?: number;
     input: any;
 }) => number;

package/dist/number/getNumber.js

@@ -5,15 +5,26 @@ var json_1 = require("../json");
  * Take an input and return a number.
  */
 var getNumber = function (_a) {
-    var _b = _a === void 0 ? { defaultValue: 0, input: '' } : _a, defaultValue = _b.defaultValue, input = _b.input;
+    var _b = _a.defaultValue, defaultValue = _b === void 0 ? 0 : _b, _c = _a.input, input = _c === void 0 ? '' : _c;
     var actualDefaultValue = defaultValue || 0;
-    var response;
+    var response = input;
     // JSON - Decode the value
     if ((0, json_1.isJson)({ input: input })) {
-        response = JSON.parse(input);
+        // Only parse this if it's a string
+        if ('string' === typeof input) {
+            response = JSON.parse(input);
+        }
+        // Already decoded
+        else {
+            response = input;
+        }
+    }
+    // Already a number
+    if ('number' === typeof response) {
+        response = response;
     }
     // String input
-    if ('string' === typeof response) {
+    else if ('string' === typeof response) {
         // Attempt to convert to number
         response = Number(response);
         // Not a number, try extracting the number value

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

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

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

@@ -0,0 +1,21 @@
+"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/getCleanFolder.d.ts

@@ -1,5 +1,7 @@
 /**
  * Take an input that may have a / before or after the input and return just the folder.
  */
-declare const getCleanFolder: (input: string) => string;
+declare const getCleanFolder: ({ input }: {
+    input: string;
+}) => string;
 export default getCleanFolder;

package/dist/string/getCleanFolder.js

@@ -7,6 +7,9 @@ var trim_1 = __importDefault(require("lodash/trim"));
 /**
  * Take an input that may have a / before or after the input and return just the folder.
  */
-var getCleanFolder = function (input) { return (0, trim_1.default)(input, '/')
-    .trim(); };
+var getCleanFolder = function (_a) {
+    var input = _a.input;
+    return (0, trim_1.default)(input, '/')
+        .trim();
+};
 exports.default = getCleanFolder;

package/dist/string/getStringFromStream.d.ts

@@ -2,5 +2,7 @@
  * Converts a stream into a string.
  * https://stackoverflow.com/a/49428486
  */
-declare const getStringFromStream: (stream: any) => Promise<string>;
+declare const getStringFromStream: ({ stream }: {
+    stream: any;
+}) => Promise<string>;
 export default getStringFromStream;

package/dist/string/getStringFromStream.js

@@ -4,7 +4,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * Converts a stream into a string.
  * https://stackoverflow.com/a/49428486
  */
-var getStringFromStream = function (stream) {
+var getStringFromStream = function (_a) {
+    var stream = _a.stream;
     var chunks = [];
     return new Promise(function (resolve, reject) {
         stream.on('data', function (chunk) { return chunks.push(Buffer.from(chunk)); });

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

@@ -4,6 +4,6 @@ var index_1 = require("../index");
 test('getCleanFolder', function () {
     var input = ' /some-folder/ ';
     var expected = '/some-folder/';
-    expect((0, index_1.getCleanFolder)(input))
+    expect((0, index_1.getCleanFolder)({ input: input }))
         .toBe(expected);
 });

package/dist/util/defaultTo.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Function to default to a value, whilst filtering through an instance
+ */
 declare const defaultTo: ({ defaultValue, instance, keys }: {
     defaultValue: any;
     instance: any;

package/dist/util/defaultTo.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+var array_1 = require("../array");
 /**
  * Function to default to a value, whilst filtering through an instance
  */
-var array_1 = require("../array");
 var defaultTo = function (_a) {
     var defaultValue = _a.defaultValue, instance = _a.instance, keys = _a.keys;
     var keysArray = (0, array_1.getArray)({ input: keys });

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

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

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

@@ -0,0 +1,27 @@
+"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');
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@8ms/helpers",
-  "version": "1.0.22",
+  "version": "1.0.23",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"