@8ms/helpers 1.1.10 → 1.1.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,11 +3,11 @@
3
3
  * Input: Must be an array of objects that are the same.
4
4
  * Output: No array [] brackets, each object must on its own new line.
5
5
  */
6
- export declare const writeGlueJsonFile: ({ S3Lib, bucket, client, file, input }: {
6
+ export declare const writeGlueJsonFile: ({ S3Lib, bucket, client, data, key }: {
7
7
  S3Lib: any;
8
8
  bucket: string;
9
9
  client: any;
10
- file: string;
11
- input: object[];
10
+ data: object[];
11
+ key: string;
12
12
  }) => Promise<any>;
13
13
  export default writeGlueJsonFile;
@@ -45,16 +45,16 @@ var writeFile_1 = require("./writeFile");
45
45
  * Output: No array [] brackets, each object must on its own new line.
46
46
  */
47
47
  var writeGlueJsonFile = function (_a) {
48
- var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, file = _a.file, input = _a.input;
48
+ var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, data = _a.data, key = _a.key;
49
49
  return __awaiter(void 0, void 0, void 0, function () {
50
50
  var inputArray, stringRows, concatString;
51
51
  return __generator(this, function (_b) {
52
52
  switch (_b.label) {
53
53
  case 0:
54
- inputArray = (0, array_1.getArray)({ input: input });
54
+ inputArray = (0, array_1.getArray)({ input: data });
55
55
  stringRows = inputArray.map(function (row) { return JSON.stringify(row); });
56
56
  concatString = stringRows.join("\n");
57
- return [4 /*yield*/, (0, writeFile_1.writeFile)({ S3Lib: S3Lib, bucket: bucket, client: client, file: file, content: concatString })];
57
+ return [4 /*yield*/, (0, writeFile_1.writeFile)({ S3Lib: S3Lib, bucket: bucket, client: client, data: concatString, key: key })];
58
58
  case 1: return [2 /*return*/, _b.sent()];
59
59
  }
60
60
  });
@@ -21,6 +21,7 @@ import getSunday from './getSunday';
21
21
  import getThisWeek from './getThisWeek';
22
22
  import getToday from './getToday';
23
23
  import getTwoWeeksAgo from './getTwoWeeksAgo';
24
+ import getWeeksAgo from './getWeeksAgo';
24
25
  import getYesterday from './getYesterday';
25
26
  import isDateValid from './isDateValid';
26
27
  import isLastWeek from './isLastWeek';
@@ -30,4 +31,4 @@ import { predefinedTimeframes, PredefinedTimeframesType } from './predefinedTime
30
31
  import { TimeframeType } from './timeframe';
31
32
  import { timeframes } from './timeframes';
32
33
  export type { DateType, DurationType, FinancialYearType, FinancialYearWeekType, PredefinedTimeframesType, TimeframeType, };
33
- export { durations, durationComparisons, predefinedTimeframes, timeframes, format, getDate, getDurationHours, getDurationMinutes, getFinancialYear, getFinancialYearToDate, getFinancialYearWeeks, getLastWeek, getMax, getMin, getMonday, getNumber, getPredefinedTimeframe, getSunday, getThisWeek, getToday, getTwoWeeksAgo, getYesterday, isDateValid, isLastWeek, isThisWeek, parseExcelDate, };
34
+ export { durations, durationComparisons, predefinedTimeframes, timeframes, format, getDate, getDurationHours, getDurationMinutes, getFinancialYear, getFinancialYearToDate, getFinancialYearWeeks, getLastWeek, getMax, getMin, getMonday, getNumber, getPredefinedTimeframe, getSunday, getThisWeek, getToday, getTwoWeeksAgo, getWeeksAgo, getYesterday, isDateValid, isLastWeek, isThisWeek, parseExcelDate, };
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- 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.getFinancialYearWeeks = exports.getFinancialYearToDate = exports.getFinancialYear = exports.getDurationMinutes = exports.getDurationHours = exports.getDate = exports.format = exports.timeframes = exports.predefinedTimeframes = exports.durationComparisons = exports.durations = void 0;
6
+ exports.parseExcelDate = exports.isThisWeek = exports.isLastWeek = exports.isDateValid = exports.getYesterday = exports.getWeeksAgo = exports.getTwoWeeksAgo = exports.getToday = exports.getThisWeek = exports.getSunday = exports.getPredefinedTimeframe = exports.getNumber = exports.getMonday = exports.getMin = exports.getMax = exports.getLastWeek = exports.getFinancialYearWeeks = exports.getFinancialYearToDate = exports.getFinancialYear = exports.getDurationMinutes = exports.getDurationHours = exports.getDate = exports.format = exports.timeframes = exports.predefinedTimeframes = exports.durationComparisons = exports.durations = void 0;
7
7
  var durationComparisons_1 = require("./durationComparisons");
8
8
  Object.defineProperty(exports, "durationComparisons", { enumerable: true, get: function () { return durationComparisons_1.durationComparisons; } });
9
9
  var durations_1 = require("./durations");
@@ -42,6 +42,8 @@ var getToday_1 = __importDefault(require("./getToday"));
42
42
  exports.getToday = getToday_1.default;
43
43
  var getTwoWeeksAgo_1 = __importDefault(require("./getTwoWeeksAgo"));
44
44
  exports.getTwoWeeksAgo = getTwoWeeksAgo_1.default;
45
+ var getWeeksAgo_1 = __importDefault(require("./getWeeksAgo"));
46
+ exports.getWeeksAgo = getWeeksAgo_1.default;
45
47
  var getYesterday_1 = __importDefault(require("./getYesterday"));
46
48
  exports.getYesterday = getYesterday_1.default;
47
49
  var isDateValid_1 = __importDefault(require("./isDateValid"));
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * Map the Age Group and return the user-friendly string.
3
3
  */
4
- export declare const getAgeGroup: ({ input }: {
4
+ declare const getAgeGroup: ({ input }: {
5
5
  input: number;
6
6
  }) => string;
7
7
  export default getAgeGroup;
@@ -1,6 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.getAgeGroup = void 0;
4
3
  var ageGroups_1 = require("./ageGroups");
5
4
  /**
6
5
  * Map the Age Group and return the user-friendly string.
@@ -13,5 +12,4 @@ var getAgeGroup = function (_a) {
13
12
  }
14
13
  return 'Undefined';
15
14
  };
16
- exports.getAgeGroup = getAgeGroup;
17
- exports.default = exports.getAgeGroup;
15
+ exports.default = getAgeGroup;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Shorthand function to divide number, but fallback if the divisor is 0.
3
+ */
4
+ declare const getDivide: ({ defaultValue, divisor, numerator }: {
5
+ defaultValue: number;
6
+ divisor: any;
7
+ numerator: any;
8
+ }) => number;
9
+ export default getDivide;
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ var getNumber_1 = __importDefault(require("./getNumber"));
7
+ /**
8
+ * Shorthand function to divide number, but fallback if the divisor is 0.
9
+ */
10
+ var getDivide = function (_a) {
11
+ var _b = _a.defaultValue, defaultValue = _b === void 0 ? 0 : _b, divisor = _a.divisor, numerator = _a.numerator;
12
+ var numeratorInt = (0, getNumber_1.default)({ input: numerator });
13
+ var divisorInt = (0, getNumber_1.default)({ input: divisor });
14
+ if (0 === divisorInt) {
15
+ return defaultValue;
16
+ }
17
+ return numeratorInt / divisorInt;
18
+ };
19
+ exports.default = getDivide;
@@ -1,9 +1,9 @@
1
1
  /**
2
2
  * Get the percentage of two numbers.
3
3
  */
4
- declare const getPercentage: ({ defaultValue, divisor, value }: {
4
+ declare const getPercent: ({ defaultValue, divisor, value }: {
5
5
  defaultValue: number;
6
6
  divisor: any;
7
7
  value: any;
8
8
  }) => number;
9
- export default getPercentage;
9
+ export default getPercent;
@@ -7,7 +7,7 @@ var getNumber_1 = __importDefault(require("./getNumber"));
7
7
  /**
8
8
  * Get the percentage of two numbers.
9
9
  */
10
- var getPercentage = function (_a) {
10
+ var getPercent = function (_a) {
11
11
  var defaultValue = _a.defaultValue, divisor = _a.divisor, value = _a.value;
12
12
  var cleanValue = (0, getNumber_1.default)({ input: value });
13
13
  var cleanDivisor = (0, getNumber_1.default)({ input: divisor });
@@ -16,4 +16,4 @@ var getPercentage = function (_a) {
16
16
  }
17
17
  return cleanValue / cleanDivisor;
18
18
  };
19
- exports.default = getPercentage;
19
+ exports.default = getPercent;
@@ -1,5 +1,6 @@
1
1
  import getNumber from './getNumber';
2
+ import getDivide from './getDivide';
2
3
  import getPercent from './getPercent';
3
4
  import getPercentIncrease from './getPercentIncrease';
4
5
  export type {};
5
- export { getNumber, getPercent, getPercentIncrease, };
6
+ export { getDivide, getNumber, getPercent, getPercentIncrease, };
@@ -3,9 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.getPercentIncrease = exports.getPercent = exports.getNumber = void 0;
6
+ exports.getPercentIncrease = exports.getPercent = exports.getNumber = exports.getDivide = void 0;
7
7
  var getNumber_1 = __importDefault(require("./getNumber"));
8
8
  exports.getNumber = getNumber_1.default;
9
+ var getDivide_1 = __importDefault(require("./getDivide"));
10
+ exports.getDivide = getDivide_1.default;
9
11
  var getPercent_1 = __importDefault(require("./getPercent"));
10
12
  exports.getPercent = getPercent_1.default;
11
13
  var getPercentIncrease_1 = __importDefault(require("./getPercentIncrease"));
@@ -4,6 +4,6 @@
4
4
  declare const defaultTo: ({ defaultValue, instance, keys }: {
5
5
  defaultValue: any;
6
6
  instance: any;
7
- keys: string | string[];
7
+ keys: any | any[];
8
8
  }) => any;
9
9
  export default defaultTo;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@8ms/helpers",
3
- "version": "1.1.10",
3
+ "version": "1.1.13",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"