@8ms/helpers 1.0.11 → 1.0.12

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

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

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

@@ -0,0 +1,15 @@
+"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/boolean/tests/getBoolean.test.d.ts

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

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

@@ -0,0 +1,23 @@
+"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/date/tests/format.test.d.ts

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

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

@@ -0,0 +1,10 @@
+"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

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

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

@@ -0,0 +1,9 @@
+"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

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

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

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

@@ -0,0 +1,7 @@
+/**
+ * Get the user's remote IP Address
+ */
+declare const getIp: ({ req }: {
+    req: any;
+}) => string;
+export default getIp;

package/dist/nextJs/getIp.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Get the user's remote IP Address
+ */
+var getIp = function (_a) {
+    var req = _a.req;
+    var response = 'unset';
+    if (undefined !== req.headers['x-real-ip']) {
+        response = String(req.headers['x-real-ip']);
+    }
+    return response;
+};
+exports.default = getIp;

package/dist/nextJs/getUserAgent.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Get the user's User Agent
+ */
+declare const getUserAgent: ({ req }: {
+    req: any;
+}) => string;
+export default getUserAgent;

package/dist/nextJs/getUserAgent.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Get the user's User Agent
+ */
+var getUserAgent = function (_a) {
+    var req = _a.req;
+    return req.headers['user-agent'] || 'unset';
+};
+exports.default = getUserAgent;

package/dist/nextJs/index.d.ts

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

package/dist/nextJs/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.getUserAgent = exports.getIp = void 0;
+var getIp_1 = __importDefault(require("./getIp"));
+exports.getIp = getIp_1.default;
+var getUserAgent_1 = __importDefault(require("./getUserAgent"));
+exports.getUserAgent = getUserAgent_1.default;

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

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

package/dist/nextJs/tests/getIp.js

@@ -0,0 +1,19 @@
+"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

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

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

@@ -0,0 +1,19 @@
+"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/string/tests/getCleanFolder.test.d.ts

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

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

@@ -0,0 +1,9 @@
+"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))
+        .toBe(expected);
+});

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

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

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

@@ -0,0 +1,11 @@
+"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

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

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

@@ -0,0 +1,11 @@
+"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/package.json

@@ -1,27 +1,35 @@
 {
-  "name":            "@8ms/helpers",
-  "version":         "1.0.11",
-  "repository":      {
-	"type": "git",
-	"url":  "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"
+  "name": "@8ms/helpers",
+  "version": "1.0.12",
+  "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/**/*"
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*"
   ],
-  "scripts":         {
-	"build":   "rimraf dist && tsc"
+  "scripts": {
+    "build": "rimraf dist && tsc",
+    "jest": "jest --watch"
   },
-  "dependencies":    {
-	"axios":    "0.25.0",
-	"date-fns": "2.28.0",
-	"lodash":   "4.17.21"
+  "dependencies": {
+    "axios": "0.25.0",
+    "date-fns": "2.28.0",
+    "lodash": "4.17.21"
   },
   "devDependencies": {
-	"@types/lodash": "4.14.178",
-	"@types/node":   "17.0.12",
-	"tslib":         "2.3.1",
-	"typescript":    "4.5.5"
+    "@babel/preset-env": "7.16.11",
+    "@babel/preset-flow": "7.16.7",
+    "@babel/preset-typescript": "7.16.7",
+    "@types/jest": "27.4.0",
+    "@types/lodash": "4.14.178",
+    "@types/node": "17.0.14",
+    "babel-jest": "27.4.6",
+    "jest": "27.4.7",
+    "ts-node": "10.4.0",
+    "tslib": "2.3.1",
+    "typescript": "4.5.5"
   }
 }