@8ms/helpers 2.2.22 → 2.2.24

package/adverity/server/getJobs.js

@@ -1,4 +1,4 @@
-import { getDate, getToday, getYesterday, getYmdString } from "../../date";
+import { getLuxonDate, getToday, getYesterday, getYmdString } from "../../date";
 import { get } from "../../axios";
 /**
  * Fetch all the jobs that ran yesterday by default.
@@ -6,8 +6,8 @@ import { get } from "../../axios";
  * As a result, we only store the Transfer jobs as this is when it gets moved into Bigquery. If it's not in Bigquery we cant use it anyway.
  */
 export const getJobs = async (apiKey, start, end, url) => {
-    const startYmd = getYmdString(start ? getDate(start) : getYesterday());
-    const endYmd = getYmdString(end ? getDate(end) : getToday());
+    const startYmd = getYmdString(start ? getLuxonDate(start) : getYesterday());
+    const endYmd = getYmdString(end ? getLuxonDate(end) : getToday());
     const finalUrl = "undefined" !== typeof url ? url : `https://8ms.datatap.adverity.com/api/jobs/?start=${startYmd}&end=${endYmd}&page_size=300`;
     let response = [];
     const apiResponse = await get(finalUrl, {

package/date/calculation.d.ts

@@ -6,7 +6,7 @@ export declare const getUnix: (input?: InputDate) => number;
  *
  * If it's not UTC, it needs to be converted to UTC before being used.
  */
-export declare const getDate: (input?: InputDate, setMidnight?: boolean) => DateTime<boolean>;
+export declare const getLuxonDate: (input?: InputDate, setMidnight?: boolean) => DateTime<boolean>;
 export declare const isMonday: (input?: InputDate) => boolean;
 export declare const isTuesday: (input?: InputDate) => boolean;
 export declare const isWednesday: (input?: InputDate) => boolean;

package/date/calculation.js

@@ -1,6 +1,6 @@
 import { DateTime, Interval } from "luxon";
 export const getUnix = (input) => {
-    return getDate(input)
+    return getLuxonDate(input)
         .toUnixInteger();
 };
 /**
@@ -8,7 +8,7 @@ export const getUnix = (input) => {
  *
  * If it's not UTC, it needs to be converted to UTC before being used.
  */
-export const getDate = (input, setMidnight) => {
+export const getLuxonDate = (input, setMidnight) => {
     let instance = DateTime.now()
         .toUTC();
     if (input) {
@@ -57,32 +57,25 @@ export const getDate = (input, setMidnight) => {
     return instance;
 };
 export const isMonday = (input) => {
-    const date = getDate(input);
-    return date.weekday === 1;
+    return getLuxonDate(input).weekday === 1;
 };
 export const isTuesday = (input) => {
-    const date = getDate(input);
-    return date.weekday === 2;
+    return getLuxonDate(input).weekday === 2;
 };
 export const isWednesday = (input) => {
-    const date = getDate(input);
-    return date.weekday === 3;
+    return getLuxonDate(input).weekday === 3;
 };
 export const isThursday = (input) => {
-    const date = getDate(input);
-    return date.weekday === 4;
+    return getLuxonDate(input).weekday === 4;
 };
 export const isFriday = (input) => {
-    const date = getDate(input);
-    return date.weekday === 6;
+    return getLuxonDate(input).weekday === 6;
 };
 export const isSaturday = (input) => {
-    const date = getDate(input);
-    return date.weekday === 6;
+    return getLuxonDate(input).weekday === 6;
 };
 export const isSunday = (input) => {
-    const date = getDate(input);
-    return date.weekday === 7;
+    return getLuxonDate(input).weekday === 7;
 };
 /**
  * Determines if a given date falls on a weekend.
@@ -91,15 +84,15 @@ export const isSunday = (input) => {
  * to Saturday or Sunday, where weekday values of 6 and 7 represent Saturday and Sunday, respectively.
  */
 export const isWeekend = (input) => {
-    const date = getDate(input);
-    return 6 === date.weekday || 7 === date.weekday;
+    const luxonDate = getLuxonDate(input);
+    return 6 === luxonDate.weekday || 7 === luxonDate.weekday;
 };
 /**
  * Calculates the difference in minutes between two provided dates.
  */
 export const differenceInMinutes = (start, end) => {
-    const startDate = getDate(start);
-    const endDate = getDate(end);
+    const startDate = getLuxonDate(start);
+    const endDate = getLuxonDate(end);
     return endDate.diff(startDate, "minutes").minutes;
 };
 /**
@@ -107,8 +100,8 @@ export const differenceInMinutes = (start, end) => {
  * Business days are considered as weekdays (Monday to Friday).
  */
 export const differenceInBusinessDays = (start, end) => {
-    const startDate = getDate(start);
-    const endDate = getDate(end);
+    const startDate = getLuxonDate(start);
+    const endDate = getLuxonDate(end);
     let businessDays = 0;
     let current = startDate.startOf("day");
     while (current < endDate.startOf("day")) {
@@ -126,10 +119,12 @@ export const differenceInBusinessDays = (start, end) => {
  * https://www.gov.uk/when-do-the-clocks-change
  */
 export const getDatesBetween = (start, end) => {
-    const startInstance = getDate(start);
-    const endInstance = getDate(end);
+    const startInstance = getLuxonDate(start);
+    const endInstance = getLuxonDate(end);
     const response = Interval.fromDateTimes(startInstance.startOf("day"), endInstance.endOf("day"))
-        .splitBy({ day: 1 })
+        .splitBy({
+        day: 1
+    })
         .map(d => d.start);
     return response;
 };
@@ -138,10 +133,10 @@ export const getDatesBetween = (start, end) => {
  */
 export const getMonthsBetween = (start, end) => {
     const months = [];
-    const endDate = getDate(end)
+    const endDate = getLuxonDate(end)
         .startOf("month");
     // Start from the 1st of the month containing startDate
-    let current = getDate(start)
+    let current = getLuxonDate(start)
         .startOf("month");
     while (current <= endDate) {
         months.push(current);
@@ -168,7 +163,7 @@ export const getMin = (input, min) => {
  * 1 weeksAgo - Tuesday (10th), return Monday (1st)
  */
 export const getMonday = (input, weeksAgo) => {
-    let instance = getDate(input);
+    let instance = getLuxonDate(input);
     if ("Mon" !== instance.toFormat("EEE")) {
         // Get the ISO Day of week (Monday - 1 to Sunday - 7)
         const isoDay = Number(instance.toFormat("E")) - 1;
@@ -184,7 +179,7 @@ export const getMonday = (input, weeksAgo) => {
  * 1 weeksAgo - Tuesday (17th), return Monday (7th)
  */
 export const getSunday = (input, weeksAgo) => {
-    let instance = getDate(input);
+    let instance = getLuxonDate(input);
     if ("Sun" !== instance.toFormat("EEE")) {
         // Get the ISO Day of week (Monday - 1 to Sunday - 7)
         const isoDay = Number(instance.toFormat("E"));
@@ -229,13 +224,13 @@ export const getTwoWeeksAgo = () => {
  * Creating a date from scratch (no user input), thus needs to be London time.
  */
 export const getToday = (setMidnight) => {
-    return getDate(undefined, setMidnight);
+    return getLuxonDate(undefined, setMidnight);
 };
 /**
  * From a given input, move the date back X weeksAgo
  */
 export const getWeeksAgo = (input, weeksAgo) => {
-    let instance = getDate(input);
+    let instance = getLuxonDate(input);
     instance = instance.plus({ weeks: weeksAgo });
     return instance;
 };
@@ -244,7 +239,7 @@ export const getWeeksAgo = (input, weeksAgo) => {
  * Creating a date from scratch (no user input), thus needs to be London time.
  */
 export const getYesterday = (input) => {
-    let instance = getDate(input);
+    let instance = getLuxonDate(input);
     instance = instance.minus({ days: 1 });
     return instance;
 };
@@ -253,8 +248,8 @@ export const getYesterday = (input) => {
  */
 export const isThisWeek = (start, end) => {
     const inputWeek = {
-        start: getDate(start),
-        end: getDate(end),
+        start: getLuxonDate(start),
+        end: getLuxonDate(end),
     };
     const thisWeek = getThisWeek();
     // Day confirms same year and month and day
@@ -265,8 +260,8 @@ export const isThisWeek = (start, end) => {
  */
 export const isLastWeek = (start, end) => {
     const inputWeek = {
-        start: getDate(start),
-        end: getDate(end),
+        start: getLuxonDate(start),
+        end: getLuxonDate(end),
     };
     const lastWeek = getLastWeek();
     // Day confirms same year and month and day

package/date/financialYear.js

@@ -1,4 +1,4 @@
-import { getDate, getToday, getYesterday } from "./calculation";
+import { getLuxonDate, getToday, getYesterday } from "./calculation";
 import { Interval } from "luxon";
 /**
  * Get the current financial year.
@@ -9,7 +9,7 @@ export const getFinancialYear = (year) => {
     if ("undefined" === typeof year) {
         const todayInstance = getToday();
         // If today is before 1st of April, then use last year
-        if (todayInstance < getDate(`${todayInstance.toFormat("yyyy")}-04-01`)) {
+        if (todayInstance < getLuxonDate(`${todayInstance.toFormat("yyyy")}-04-01`)) {
             financialYear = Number(todayInstance.toFormat("yyyy")) - 1;
         }
         // On or after 1st of April, use this year
@@ -18,7 +18,7 @@ export const getFinancialYear = (year) => {
         }
     }
     // The year start needs to be 1st April this year - if its not a monday we need to shift this to the next monday.
-    let yearStartInstance = getDate(`${financialYear}-04-01`);
+    let yearStartInstance = getLuxonDate(`${financialYear}-04-01`);
     // Get the previous Monday if the 1st of April isn't a Monday
     if ("Mon" !== yearStartInstance.toFormat("EEE")) {
         // Get the ISO Day of the week (Monday - 1 to Sunday - 7)
@@ -29,7 +29,7 @@ export const getFinancialYear = (year) => {
     }
     // The year-end needs to be 31st March next year
     // We are specifying the date, so don't change the timezone
-    let yearEndInstance = getDate(`${(financialYear + 1)}-03-31`);
+    let yearEndInstance = getLuxonDate(`${(financialYear + 1)}-03-31`);
     // Get the next Sunday if the 31st of March isn't a Sunday
     if ("Sun" !== yearEndInstance.toFormat("EEE")) {
         // Get the ISO Day of the week (Monday - 1 to Sunday - 7)

package/date/format.d.ts

@@ -82,4 +82,4 @@ export declare const getYmdString: (input: InputDate) => string;
  * Convert an Excel date "e.g. 44216" into a JavaScript date object.
  * https://stackoverflow.com/questions/16229494/converting-excel-date-serial-number-to-date-using-javascript
  */
-export declare const parseExcelDate: (serial: number) => DateTime<true> | DateTime<false>;
+export declare const getLuxonDateFromExcel: (serial: number) => DateTime<true> | DateTime<false>;

package/date/format.js

@@ -1,4 +1,4 @@
-import { getDate, getToday } from "./calculation";
+import { getLuxonDate, getToday } from "./calculation";
 import { DateTime } from "luxon";
 /**
  * Convert a number of seconds into HH:MM:SS
@@ -44,8 +44,7 @@ export const getDurationMinutes = (seconds) => {
  * Simple function takes any DateTime, String or Number and formats it.
  */
 export const format = (input, dateFormat) => {
-    const instance = getDate(input);
-    return instance.toFormat(dateFormat);
+    return getLuxonDate(input).toFormat(dateFormat);
 };
 /**
  * Convert a Date into a dd number.
@@ -147,7 +146,7 @@ export const getYmdString = (input) => {
  * Convert an Excel date "e.g. 44216" into a JavaScript date object.
  * https://stackoverflow.com/questions/16229494/converting-excel-date-serial-number-to-date-using-javascript
  */
-export const parseExcelDate = (serial) => {
+export const getLuxonDateFromExcel = (serial) => {
     const utcDates = Math.floor(serial - 25569);
     const utcValue = utcDates * 86400;
     const dateInfo = new Date(utcValue * 1000);

package/number/getPercent.d.ts

@@ -0,0 +1 @@
+export declare const getPercent: (numerator: any, divisor: any, dp?: number) => number;

package/number/getPercent.js

@@ -0,0 +1,11 @@
+import { getSafeDivide } from "./getSafeDivide";
+export const getPercent = (numerator, divisor, dp) => {
+    const finalNumerator = Number(numerator);
+    const finalDivisor = Number(divisor);
+    const finalDp = Number(dp || 1);
+    return Number((getSafeDivide({
+        defaultValue: 0,
+        numerator: finalNumerator,
+        divisor: finalDivisor,
+    }) * 100).toFixed(finalDp));
+};

package/number/index.d.ts

@@ -2,5 +2,6 @@ export * from "./format";
 export * from "./formatCurrency";
 export * from "./getDecimal";
 export * from "./getSafeDivide";
+export * from "./getPercent";
 export * from "./getNumber";
 export * from "./getPercentIncrease";

package/number/index.js

@@ -2,5 +2,6 @@ export * from "./format";
 export * from "./formatCurrency";
 export * from "./getDecimal";
 export * from "./getSafeDivide";
+export * from "./getPercent";
 export * from "./getNumber";
 export * from "./getPercentIncrease";

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@8ms/helpers",
 	"license": "UNLICENSED",
-	"version": "2.2.22",
+	"version": "2.2.24",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"