@8ms/helpers 1.0.11 → 1.0.15

package/dist/Class/BaseClass.js

@@ -12,9 +12,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-var defaultTo_1 = __importDefault(require("../util/defaultTo"));
 var isArray_1 = __importDefault(require("lodash/isArray"));
 var set_1 = __importDefault(require("lodash/set"));
+var defaultTo_1 = __importDefault(require("../util/defaultTo"));
 var BaseClass = /** @class */ (function () {
     function BaseClass() {
     }
@@ -71,7 +71,7 @@ var BaseClass = /** @class */ (function () {
         for (var _i = 1; _i < arguments.length; _i++) {
             fields[_i - 1] = arguments[_i];
         }
-        return defaultTo_1.default.apply(void 0, __spreadArray([defaultValue, this], fields, false));
+        return (0, defaultTo_1.default)({ defaultValue: defaultValue, instance: this, keys: fields });
     };
     return BaseClass;
 }());

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/getMax.d.ts

@@ -1,8 +1,9 @@
 import { DateType } from './types';
 /**
- * Return the maximum date (up to Yesterday) as a formatted string.
+ * If a given date is beyond the maximum, return the maximum.
  */
-declare const getMax: ({ input }: {
+declare const getMax: ({ input, max }: {
     input: DateType;
+    max: DateType;
 }) => Date;
 export default getMax;

package/dist/date/getMax.js

@@ -5,15 +5,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var isAfter_1 = __importDefault(require("date-fns/isAfter"));
 var getDate_1 = __importDefault(require("./getDate"));
-var getYesterday_1 = __importDefault(require("./getYesterday"));
 /**
- * Return the maximum date (up to Yesterday) as a formatted string.
+ * If a given date is beyond the maximum, return the maximum.
  */
 var getMax = function (_a) {
-    var input = _a.input;
-    var yesterday = (0, getYesterday_1.default)();
-    var parsed = (0, getDate_1.default)({ input: input });
-    var max = (0, isAfter_1.default)(parsed, yesterday) ? yesterday : parsed;
-    return max;
+    var input = _a.input, max = _a.max;
+    var parsedMax = (0, getDate_1.default)({ input: max });
+    var parsedInput = (0, getDate_1.default)({ input: input });
+    return (0, isAfter_1.default)(parsedInput, parsedMax) ? parsedMax : parsedInput;
 };
 exports.default = getMax;

package/dist/date/getMin.d.ts

@@ -0,0 +1,9 @@
+import { DateType } from './types';
+/**
+ * If a given date is before the minimum, return the minimum.
+ */
+declare const getMin: ({ input, min }: {
+    input: DateType;
+    min: DateType;
+}) => Date;
+export default getMin;

package/dist/date/getMin.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var isBefore_1 = __importDefault(require("date-fns/isBefore"));
+var getDate_1 = __importDefault(require("./getDate"));
+/**
+ * If a given date is before the minimum, return the minimum.
+ */
+var getMin = function (_a) {
+    var input = _a.input, min = _a.min;
+    var parsedMin = (0, getDate_1.default)({ input: min });
+    var parsedInput = (0, getDate_1.default)({ input: input });
+    return (0, isBefore_1.default)(parsedInput, parsedMin) ? parsedMin : parsedInput;
+};
+exports.default = getMin;

package/dist/date/index.d.ts

@@ -7,6 +7,7 @@ import getFinancialYear from './getFinancialYear';
 import getFinancialYearToDate from './getFinancialYearToDate';
 import getLastWeek from './getLastWeek';
 import getMax from './getMax';
+import getMin from './getMin';
 import getMonday from './getMonday';
 import getNumber from './getNumber';
 import getPredefinedTimeframe from './getPredefinedTimeframe';
@@ -21,4 +22,4 @@ import isThisWeek from './isThisWeek';
 import parseExcelDate from './parseExcelDate';
 import { DateType, FinancialYearType, FinancialYearWeekType, TimeframePredefinedType, TimeframeType } from './types';
 export type { DateType, FinancialYearType, FinancialYearWeekType, TimeframeType, TimeframePredefinedType, };
-export { Duration, DurationComparison, Timeframe, TimeframePredefined, format, getDate, getDurationHours, getDurationMinutes, getFinancialYear, getFinancialYearToDate, getLastWeek, getMax, getMonday, getNumber, getPredefinedTimeframe, getSunday, getThisWeek, getToday, getTwoWeeksAgo, getYesterday, isDateValid, isLastWeek, isThisWeek, parseExcelDate, };
+export { Duration, DurationComparison, Timeframe, TimeframePredefined, format, getDate, getDurationHours, getDurationMinutes, getFinancialYear, getFinancialYearToDate, getLastWeek, getMax, getMin, getMonday, getNumber, getPredefinedTimeframe, getSunday, getThisWeek, getToday, getTwoWeeksAgo, getYesterday, isDateValid, isLastWeek, isThisWeek, parseExcelDate, };

package/dist/date/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseExcelDate = exports.isThisWeek = exports.isLastWeek = exports.isDateValid = exports.getYesterday = exports.getTwoWeeksAgo = exports.getToday = exports.getThisWeek = exports.getSunday = exports.getPredefinedTimeframe = exports.getNumber = exports.getMonday = exports.getMax = exports.getLastWeek = exports.getFinancialYearToDate = exports.getFinancialYear = exports.getDurationMinutes = exports.getDurationHours = exports.getDate = exports.format = exports.TimeframePredefined = exports.Timeframe = exports.DurationComparison = exports.Duration = void 0;
+exports.parseExcelDate = exports.isThisWeek = exports.isLastWeek = exports.isDateValid = exports.getYesterday = exports.getTwoWeeksAgo = exports.getToday = exports.getThisWeek = exports.getSunday = exports.getPredefinedTimeframe = exports.getNumber = exports.getMonday = exports.getMin = exports.getMax = exports.getLastWeek = exports.getFinancialYearToDate = exports.getFinancialYear = exports.getDurationMinutes = exports.getDurationHours = exports.getDate = exports.format = exports.TimeframePredefined = exports.Timeframe = exports.DurationComparison = exports.Duration = void 0;
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "Duration", { enumerable: true, get: function () { return constants_1.Duration; } });
 Object.defineProperty(exports, "DurationComparison", { enumerable: true, get: function () { return constants_1.DurationComparison; } });
@@ -25,6 +25,8 @@ var getLastWeek_1 = __importDefault(require("./getLastWeek"));
 exports.getLastWeek = getLastWeek_1.default;
 var getMax_1 = __importDefault(require("./getMax"));
 exports.getMax = getMax_1.default;
+var getMin_1 = __importDefault(require("./getMin"));
+exports.getMin = getMin_1.default;
 var getMonday_1 = __importDefault(require("./getMonday"));
 exports.getMonday = getMonday_1.default;
 var getNumber_1 = __importDefault(require("./getNumber"));

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/swr/isAllData.d.ts

@@ -1,5 +1,7 @@
 /**
  * Are all SWRs data ready.
  */
-declare const isAllData: (swrs: any) => boolean;
+declare const isAllData: ({ swrs }: {
+    swrs: any;
+}) => boolean;
 export default isAllData;

package/dist/swr/isAllData.js

@@ -7,10 +7,11 @@ var isData_1 = __importDefault(require("./isData"));
 /**
  * Are all SWRs data ready.
  */
-var isAllData = function (swrs) {
+var isAllData = function (_a) {
+    var swrs = _a.swrs;
     var fetcherWithData = 0;
     for (var swr in swrs) {
-        if ((0, isData_1.default)(swrs[swr])) {
+        if ((0, isData_1.default)({ swr: swrs[swr] })) {
             fetcherWithData++;
         }
     }

package/dist/swr/isAnyError.d.ts

@@ -1,5 +1,7 @@
 /**
  * Are any of the SWRs marked as an error.
  */
-declare const isAnyError: (swrs: any) => boolean;
+declare const isAnyError: ({ swrs }: {
+    swrs: any;
+}) => boolean;
 export default isAnyError;

package/dist/swr/isAnyError.js

@@ -7,10 +7,11 @@ var isError_1 = __importDefault(require("./isError"));
 /**
  * Are any of the SWRs marked as an error.
  */
-var isAnyError = function (swrs) {
+var isAnyError = function (_a) {
+    var swrs = _a.swrs;
     var fetcherError = 0;
     for (var swr in swrs) {
-        if ((0, isError_1.default)(swrs[swr])) {
+        if ((0, isError_1.default)({ swr: swrs[swr] })) {
             fetcherError++;
         }
     }

package/dist/swr/isAnyLoading.d.ts

@@ -1,5 +1,7 @@
 /**
  * Are any of SWRs loading
  */
-export declare const isAnyLoading: (swrs: any) => boolean;
+export declare const isAnyLoading: ({ swrs }: {
+    swrs: any;
+}) => boolean;
 export default isAnyLoading;

package/dist/swr/isAnyLoading.js

@@ -8,10 +8,11 @@ var isLoading_1 = __importDefault(require("./isLoading"));
 /**
  * Are any of SWRs loading
  */
-var isAnyLoading = function (swrs) {
+var isAnyLoading = function (_a) {
+    var swrs = _a.swrs;
     var fetcherLoading = 0;
     for (var swr in swrs) {
-        if ((0, isLoading_1.default)(swrs[swr])) {
+        if ((0, isLoading_1.default)({ swr: swrs[swr] })) {
             fetcherLoading++;
         }
     }

package/dist/swr/isData.d.ts

@@ -1,5 +1,7 @@
 /**
  * Check to see if a single SWR has an error.
  */
-declare const isData: (swr: any) => boolean;
+declare const isData: ({ swr }: {
+    swr: any;
+}) => boolean;
 export default isData;

package/dist/swr/isData.js

@@ -3,5 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * Check to see if a single SWR has an error.
  */
-var isData = function (swr) { return undefined !== swr.fetcher.data && 'undefined' !== swr.fetcher.data; };
+var isData = function (_a) {
+    var swr = _a.swr;
+    return undefined !== swr.fetcher.data && 'undefined' !== swr.fetcher.data;
+};
 exports.default = isData;

package/dist/swr/isError.d.ts

@@ -1,5 +1,7 @@
 /**
  * Check to see if a single SWR has an error.
  */
-declare const isError: (swr: any) => boolean;
+declare const isError: ({ swr }: {
+    swr: any;
+}) => boolean;
 export default isError;

package/dist/swr/isError.js

@@ -3,5 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * Check to see if a single SWR has an error.
  */
-var isError = function (swr) { return undefined !== swr.fetcher.error; };
+var isError = function (_a) {
+    var swr = _a.swr;
+    return undefined !== swr.fetcher.error;
+};
 exports.default = isError;

package/dist/swr/isLoading.d.ts

@@ -1,5 +1,7 @@
 /**
  * Check to see if a single SWR is loading.
  */
-declare const isLoading: (swr: any) => boolean;
+declare const isLoading: ({ swr }: {
+    swr: any;
+}) => boolean;
 export default isLoading;

package/dist/swr/isLoading.js

@@ -8,5 +8,8 @@ var isError_1 = __importDefault(require("./isError"));
 /**
  * Check to see if a single SWR is loading.
  */
-var isLoading = function (swr) { return !(0, isError_1.default)(swr) && !(0, isData_1.default)(swr); };
+var isLoading = function (_a) {
+    var swr = _a.swr;
+    return !(0, isError_1.default)({ swr: swr }) && !(0, isData_1.default)({ swr: swr });
+};
 exports.default = isLoading;

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/dist/util/defaultTo.d.ts

@@ -1,5 +1,6 @@
-/**
- * Function to default to a value, whilst filtering through an instance
- */
-declare const defaultTo: (defaultValue: any, instance: any, ...keys: any[]) => any;
+declare const defaultTo: ({ defaultValue, instance, keys }: {
+    defaultValue: any;
+    instance: any;
+    keys: string | string[];
+}) => any;
 export default defaultTo;

package/dist/util/defaultTo.js

@@ -3,11 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * Function to default to a value, whilst filtering through an instance
  */
-var defaultTo = function (defaultValue, instance) {
-    var keys = [];
-    for (var _i = 2; _i < arguments.length; _i++) {
-        keys[_i - 2] = arguments[_i];
-    }
+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 });
     var found = true;
     var pointer = instance;
     // Instance is undefined
@@ -16,7 +15,7 @@ var defaultTo = function (defaultValue, instance) {
     }
     // Instance exists
     else {
-        keys.forEach(function (key) {
+        keysArray.forEach(function (key) {
             if (found) {
                 // Sub key doesn't exist
                 if (undefined === pointer[key]) {

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.15",
+  "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"
   }
 }