@8ms/helpers 1.1.28 → 1.1.31

package/dist/date/format.d.ts

@@ -1,9 +1,12 @@
 import { DateType } from './date';
+import { GetLondonTimeType } from './getLondonTime';
+declare type FormatType = GetLondonTimeType & {
+    dateFormat?: string;
+    input: DateType;
+    setMidnight?: boolean;
+};
 /**
  * Convert a (number | string | Date) into a "yyyy-MM-dd" string or a specified format.
  */
-declare const format: ({ input, dateFormat }: {
-    input: DateType;
-    dateFormat?: string;
-}) => string;
+declare const format: ({ input, dateFormat, setLondonTime, setMidnight }: FormatType) => string;
 export default format;

package/dist/date/format.js

@@ -9,7 +9,8 @@ var getDate_1 = __importDefault(require("./getDate"));
  * Convert a (number | string | Date) into a "yyyy-MM-dd" string or a specified format.
  */
 var format = function (_a) {
-    var input = _a.input, dateFormat = _a.dateFormat;
-    return (0, format_1.default)((0, getDate_1.default)({ input: input }), dateFormat || 'yyyy-MM-dd');
+    var input = _a.input, dateFormat = _a.dateFormat, _b = _a.setLondonTime, setLondonTime = _b === void 0 ? true : _b, _c = _a.setMidnight, setMidnight = _c === void 0 ? true : _c;
+    var dateInstance = (0, getDate_1.default)({ input: input, setLondonTime: setLondonTime, setMidnight: setMidnight });
+    return (0, format_1.default)(dateInstance, dateFormat || 'yyyy-MM-dd');
 };
 exports.default = format;

package/dist/date/getDate.d.ts

@@ -1,10 +1,11 @@
 import { DateType } from './date';
 declare type GetDateType = {
     input: DateType;
+    setLondonTime?: boolean;
     setMidnight?: boolean;
 };
 /**
  * Convert a (number | string | Date) into a Date object.
  */
-declare const getDate: ({ input, setMidnight }: GetDateType) => Date;
+declare const getDate: ({ input, setLondonTime, setMidnight }: GetDateType) => Date;
 export default getDate;

package/dist/date/getDate.js

@@ -3,14 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-var addHours_1 = __importDefault(require("date-fns/addHours"));
 var parse_1 = __importDefault(require("date-fns/parse"));
-var subHours_1 = __importDefault(require("date-fns/subHours"));
+var getLondonTime_1 = __importDefault(require("./getLondonTime"));
 /**
  * Convert a (number | string | Date) into a Date object.
  */
 var getDate = function (_a) {
-    var input = _a.input, _b = _a.setMidnight, setMidnight = _b === void 0 ? true : _b;
+    var input = _a.input, _b = _a.setLondonTime, setLondonTime = _b === void 0 ? true : _b, _c = _a.setMidnight, setMidnight = _c === void 0 ? true : _c;
     var date;
     if (input instanceof Date) {
         date = new Date(input.valueOf());
@@ -32,7 +31,7 @@ var getDate = function (_a) {
         }
         // 2022-04-12
         else if (10 === dateString.length) {
-            var dateTimeString = dateString + ' 00:00:00s';
+            var dateTimeString = dateString + ' 00:00:00';
             date = (0, parse_1.default)(dateTimeString, 'yyyy-MM-dd HH:mm:ss', new Date());
         }
         // 2022-04-12 01:01:01
@@ -44,17 +43,14 @@ var getDate = function (_a) {
             date = new Date(dateString);
         }
     }
-    // Reset to UTC hours
+    // Convert to London time
+    if (setLondonTime) {
+        date = (0, getLondonTime_1.default)({ input: date });
+    }
+    // Reset to midnight
     if (setMidnight) {
         date.setHours(0, 0, 0, 0);
     }
-    // Accommodate for DST
-    if (date.getTimezoneOffset() < 0) {
-        date = (0, addHours_1.default)(date, 1);
-    }
-    else if (date.getTimezoneOffset() > 0) {
-        date = (0, subHours_1.default)(date, 1);
-    }
     return date;
 };
 exports.default = getDate;

package/dist/date/getExcelDate.d.ts

@@ -1,6 +1,7 @@
 /**
  * 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
+ * @deprecated in favour of parseExcelDate
  */
 declare const getExcelDate: ({ input }: {
     input: number;

package/dist/date/getExcelDate.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * 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
+ * @deprecated in favour of parseExcelDate
  */
 var getExcelDate = function (_a) {
     var input = _a.input;

package/dist/date/getFinancialYear.d.ts

@@ -1,8 +1,11 @@
 import { FinancialYearType } from './financialYear';
+import { GetLondonTimeType } from './getLondonTime';
+declare type GetFinancialYearType = GetLondonTimeType & {
+    year?: number;
+    setMidnight?: boolean;
+};
 /**
  * Get the current financial year.
  */
-declare const getFinancialYear: ({ year }?: {
-    year?: number;
-}) => FinancialYearType;
+declare const getFinancialYear: ({ year, setLondonTime, setMidnight }?: GetFinancialYearType) => FinancialYearType;
 export default getFinancialYear;

package/dist/date/getFinancialYear.js

@@ -7,16 +7,17 @@ var isMonday_1 = __importDefault(require("date-fns/isMonday"));
 var isSunday_1 = __importDefault(require("date-fns/isSunday"));
 var nextSunday_1 = __importDefault(require("date-fns/nextSunday"));
 var previousMonday_1 = __importDefault(require("date-fns/previousMonday"));
+var getDate_1 = __importDefault(require("./getDate"));
 var getToday_1 = __importDefault(require("./getToday"));
 /**
  * Get the current financial year.
  */
 var getFinancialYear = function (_a) {
-    var _b = _a === void 0 ? {} : _a, _c = _b.year, year = _c === void 0 ? undefined : _c;
+    var _b = _a === void 0 ? { setLondonTime: true, setMidnight: true } : _a, _c = _b.year, year = _c === void 0 ? undefined : _c, _d = _b.setLondonTime, setLondonTime = _d === void 0 ? true : _d, _e = _b.setMidnight, setMidnight = _e === void 0 ? true : _e;
     // Either use the current year or a specified year
     var financialYear = year;
     if (undefined === year) {
-        var today = (0, getToday_1.default)();
+        var today = (0, getToday_1.default)({ setLondonTime: setLondonTime, setMidnight: setMidnight });
         // If today is before 1st of April, then use last year
         if (today < new Date(today.getFullYear(), 3, 1)) {
             financialYear = today.getFullYear() - 1;
@@ -27,11 +28,9 @@ var getFinancialYear = function (_a) {
         }
     }
     // The year-end needs to be 31st March next year
-    var yearEnd = new Date("".concat(financialYear + 1, "-03-31"));
-    yearEnd.setHours(0, 0, 0, 0);
+    var yearEnd = (0, getDate_1.default)({ input: "".concat(financialYear + 1, "-03-31"), setLondonTime: setLondonTime, setMidnight: setMidnight });
     // The year start needs to be 1st April this year
-    var yearStart = new Date("".concat(financialYear, "-04-01"));
-    yearStart.setHours(0, 0, 0, 0);
+    var yearStart = (0, getDate_1.default)({ input: "".concat(financialYear, "-04-01"), setLondonTime: setLondonTime, setMidnight: setMidnight });
     // Get the previous Monday if the 1st of April isn't a Monday
     if (!(0, isMonday_1.default)(yearStart)) {
         yearStart = (0, previousMonday_1.default)(yearStart);

package/dist/date/getFinancialYearToDate.d.ts

@@ -1,6 +1,10 @@
 import { FinancialYearType } from './financialYear';
+import { GetLondonTimeType } from './getLondonTime';
+declare type getFinancialYearToDateType = GetLondonTimeType & {
+    setMidnight?: boolean;
+};
 /**
  * Return the current financial year up to today.
  */
-declare const getFinancialYearToDate: () => FinancialYearType;
+declare const getFinancialYearToDate: ({ setLondonTime, setMidnight }?: getFinancialYearToDateType) => FinancialYearType;
 export default getFinancialYearToDate;

package/dist/date/getFinancialYearToDate.js

@@ -8,8 +8,11 @@ var getToday_1 = __importDefault(require("./getToday"));
 /**
  * Return the current financial year up to today.
  */
-var getFinancialYearToDate = function () { return ({
-    end: (0, getToday_1.default)(),
-    start: (0, getFinancialYear_1.default)({ year: undefined }).start,
-}); };
+var getFinancialYearToDate = function (_a) {
+    var _b = _a === void 0 ? { setLondonTime: true, setMidnight: true } : _a, _c = _b.setLondonTime, setLondonTime = _c === void 0 ? true : _c, _d = _b.setMidnight, setMidnight = _d === void 0 ? true : _d;
+    return ({
+        end: (0, getToday_1.default)(),
+        start: (0, getFinancialYear_1.default)({ year: undefined, setLondonTime: setLondonTime, setMidnight: setMidnight }).start,
+    });
+};
 exports.default = getFinancialYearToDate;

package/dist/date/getFinancialYearWeeks.d.ts

@@ -1,8 +1,11 @@
 import { FinancialYearWeekType } from './financialYearWeek';
+import { GetLondonTimeType } from './getLondonTime';
+declare type getFinancialYearWeeksType = GetLondonTimeType & {
+    year: number;
+    setMidnight?: boolean;
+};
 /**
  * Get the current financial year.
  */
-declare const getFinancialYearWeeks: ({ year }: {
-    year: number;
-}) => FinancialYearWeekType[];
+declare const getFinancialYearWeeks: ({ year, setLondonTime, setMidnight }: getFinancialYearWeeksType) => FinancialYearWeekType[];
 export default getFinancialYearWeeks;

package/dist/date/getFinancialYearWeeks.js

@@ -6,19 +6,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var addDays_1 = __importDefault(require("date-fns/addDays"));
 var eachWeekOfInterval_1 = __importDefault(require("date-fns/eachWeekOfInterval"));
 var getFinancialYear_1 = __importDefault(require("./getFinancialYear"));
-var index_1 = require("./index");
+var getLondonTime_1 = __importDefault(require("./getLondonTime"));
 /**
  * Get the current financial year.
  */
 var getFinancialYearWeeks = function (_a) {
-    var year = _a.year;
-    var weeks = (0, eachWeekOfInterval_1.default)((0, getFinancialYear_1.default)({ year: year }), { weekStartsOn: 1 });
+    var year = _a.year, _b = _a.setLondonTime, setLondonTime = _b === void 0 ? true : _b, _c = _a.setMidnight, setMidnight = _c === void 0 ? true : _c;
+    var financialYear = (0, getFinancialYear_1.default)({ year: year, setLondonTime: setLondonTime, setMidnight: setMidnight });
+    var weeks = (0, eachWeekOfInterval_1.default)(financialYear, { weekStartsOn: 1 });
     var response = weeks.map(function (week, index) {
         var weekStart = new Date(week.getTime());
+        if (setLondonTime) {
+            weekStart = (0, getLondonTime_1.default)({ input: weekStart });
+        }
         var weekEnd = (0, addDays_1.default)(weekStart, 6);
         return {
-            start: (0, index_1.getTimezoneFixed)({ input: weekStart }),
-            end: (0, index_1.getTimezoneFixed)({ input: weekEnd }),
+            start: weekStart,
+            end: weekEnd,
             financialWeek: (index + 1),
             financialYear: year,
         };

package/dist/date/getLastWeek.d.ts

@@ -1,6 +1,10 @@
+import { GetLondonTimeType } from './getLondonTime';
 import { TimeframeType } from './timeframe';
+declare type GetLastWeekType = GetLondonTimeType & {
+    setMidnight?: boolean;
+};
 /**
  * Return an object of start/end predefined date of Last Week.
  */
-declare const getLastWeek: () => TimeframeType;
+declare const getLastWeek: ({ setLondonTime, setMidnight }?: GetLastWeekType) => TimeframeType;
 export default getLastWeek;

package/dist/date/getLastWeek.js

@@ -9,8 +9,11 @@ var getSunday_1 = __importDefault(require("./getSunday"));
 /**
  * Return an object of start/end predefined date of Last Week.
  */
-var getLastWeek = function () { return ({
-    end: (0, getNumber_1.default)({ input: (0, getSunday_1.default)({ weeksAgo: 0 }) }),
-    start: (0, getNumber_1.default)({ input: (0, getMonday_1.default)({ weeksAgo: 1 }) }),
-}); };
+var getLastWeek = function (_a) {
+    var _b = _a === void 0 ? { setLondonTime: true, setMidnight: true } : _a, _c = _b.setLondonTime, setLondonTime = _c === void 0 ? true : _c, _d = _b.setMidnight, setMidnight = _d === void 0 ? true : _d;
+    return ({
+        end: (0, getNumber_1.default)({ input: (0, getSunday_1.default)({ weeksAgo: 0, setLondonTime: setLondonTime, setMidnight: setMidnight }) }),
+        start: (0, getNumber_1.default)({ input: (0, getMonday_1.default)({ weeksAgo: 1, setLondonTime: setLondonTime, setMidnight: setMidnight }) }),
+    });
+};
 exports.default = getLastWeek;

package/dist/date/getLondonTime.d.ts

@@ -0,0 +1,12 @@
+export declare type GetLondonTimeType = {
+    setLondonTime?: boolean;
+};
+/**
+ * Working with time zones is a pain,
+ * Input a localised time zone, converts this into London's timezone as a string.
+ * Returns a new Date instance.
+ */
+declare const getLondonTime: ({ input }: {
+    input: Date;
+}) => Date;
+export default getLondonTime;

package/dist/date/getLondonTime.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var date_fns_tz_1 = require("date-fns-tz");
+/**
+ * Working with time zones is a pain,
+ * Input a localised time zone, converts this into London's timezone as a string.
+ * Returns a new Date instance.
+ */
+var getLondonTime = function (_a) {
+    var input = _a.input;
+    var londonString = (0, date_fns_tz_1.formatInTimeZone)(input, 'Europe/London', 'yyyy-MM-dd HH:mm:ss');
+    return new Date(londonString);
+};
+exports.default = getLondonTime;

package/dist/date/getMax.d.ts

@@ -1,9 +1,12 @@
 import { DateType } from './date';
+import { GetLondonTimeType } from './getLondonTime';
+declare type GetMaxType = GetLondonTimeType & {
+    input: DateType;
+    max: DateType;
+    setMidnight?: boolean;
+};
 /**
  * If a given date is beyond the maximum, return the maximum.
  */
-declare const getMax: ({ input, max }: {
-    input: DateType;
-    max: DateType;
-}) => Date;
+declare const getMax: ({ input, max, setLondonTime, setMidnight }: GetMaxType) => Date;
 export default getMax;

package/dist/date/getMax.js

@@ -9,9 +9,9 @@ var getDate_1 = __importDefault(require("./getDate"));
  * If a given date is beyond the maximum, return the maximum.
  */
 var getMax = function (_a) {
-    var input = _a.input, max = _a.max;
-    var parsedMax = (0, getDate_1.default)({ input: max });
-    var parsedInput = (0, getDate_1.default)({ input: input });
+    var input = _a.input, max = _a.max, _b = _a.setLondonTime, setLondonTime = _b === void 0 ? true : _b, _c = _a.setMidnight, setMidnight = _c === void 0 ? true : _c;
+    var parsedMax = (0, getDate_1.default)({ input: max, setLondonTime: setLondonTime, setMidnight: setMidnight });
+    var parsedInput = (0, getDate_1.default)({ input: input, setLondonTime: setLondonTime, setMidnight: setMidnight });
     return (0, isAfter_1.default)(parsedInput, parsedMax) ? parsedMax : parsedInput;
 };
 exports.default = getMax;

package/dist/date/getMin.d.ts

@@ -1,9 +1,12 @@
 import { DateType } from './date';
+import { GetLondonTimeType } from './getLondonTime';
+declare type GetMinType = GetLondonTimeType & {
+    input: DateType;
+    min: DateType;
+    setMidnight?: boolean;
+};
 /**
  * If a given date is before the minimum, return the minimum.
  */
-declare const getMin: ({ input, min }: {
-    input: DateType;
-    min: DateType;
-}) => Date;
+declare const getMin: ({ input, min, setLondonTime, setMidnight }: GetMinType) => Date;
 export default getMin;

package/dist/date/getMin.js

@@ -9,9 +9,9 @@ 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 });
+    var input = _a.input, min = _a.min, _b = _a.setLondonTime, setLondonTime = _b === void 0 ? true : _b, _c = _a.setMidnight, setMidnight = _c === void 0 ? true : _c;
+    var parsedMin = (0, getDate_1.default)({ input: min, setLondonTime: setLondonTime, setMidnight: setMidnight });
+    var parsedInput = (0, getDate_1.default)({ input: input, setLondonTime: setLondonTime, setMidnight: setMidnight });
     return (0, isBefore_1.default)(parsedInput, parsedMin) ? parsedMin : parsedInput;
 };
 exports.default = getMin;

package/dist/date/getMonday.d.ts

@@ -1,11 +1,14 @@
 import { DateType } from './date';
+import { GetLondonTimeType } from './getLondonTime';
+declare type GetMondayType = GetLondonTimeType & {
+    input?: DateType;
+    weeksAgo: number;
+    setMidnight?: boolean;
+};
 /**
  * Retrieve the closest last Monday relative to the input or today.
  * 0 weeksAgo - Tuesday (10th), return Monday (8th)
  * 1 weeksAgo - Tuesday (10th), return Monday (1st)
  */
-declare const getMonday: ({ weeksAgo, input }: {
-    weeksAgo: number;
-    input?: DateType;
-}) => Date;
+declare const getMonday: ({ weeksAgo, input, setLondonTime, setMidnight }: GetMondayType) => Date;
 export default getMonday;

package/dist/date/getMonday.js

@@ -8,15 +8,14 @@ var isMonday_1 = __importDefault(require("date-fns/isMonday"));
 var subDays_1 = __importDefault(require("date-fns/subDays"));
 var getDate_1 = __importDefault(require("./getDate"));
 var getToday_1 = __importDefault(require("./getToday"));
-var index_1 = require("./index");
 /**
  * Retrieve the closest last Monday relative to the input or today.
  * 0 weeksAgo - Tuesday (10th), return Monday (8th)
  * 1 weeksAgo - Tuesday (10th), return Monday (1st)
  */
 var getMonday = function (_a) {
-    var weeksAgo = _a.weeksAgo, input = _a.input;
-    var date = input ? (0, getDate_1.default)({ input: input }) : (0, getToday_1.default)();
+    var weeksAgo = _a.weeksAgo, input = _a.input, _b = _a.setLondonTime, setLondonTime = _b === void 0 ? true : _b, _c = _a.setMidnight, setMidnight = _c === void 0 ? true : _c;
+    var date = input ? (0, getDate_1.default)({ input: input, setLondonTime: setLondonTime, setMidnight: setMidnight }) : (0, getToday_1.default)({ setLondonTime: setLondonTime, setMidnight: setMidnight });
     if (!(0, isMonday_1.default)(date)) {
         // Get the ISO Day of week (Monday - 1 to Sunday - 7)
         var isoDay = (0, getISODay_1.default)(date);
@@ -25,6 +24,6 @@ var getMonday = function (_a) {
     }
     // Move it back a given number of weeks
     date = (0, subDays_1.default)(date, 7 * weeksAgo);
-    return (0, index_1.getTimezoneFixed)({ input: date });
+    return date;
 };
 exports.default = getMonday;

package/dist/date/getNumber.d.ts

@@ -1,8 +1,11 @@
 import { DateType } from './date';
+import { GetLondonTimeType } from './getLondonTime';
+declare type GetNumberType = GetLondonTimeType & {
+    input: DateType;
+    setMidnight?: boolean;
+};
 /**
  * Convert a (number | string | Date) into a YYYYMMDD number.
  */
-declare const getNumber: ({ input }: {
-    input: DateType;
-}) => number;
+declare const getNumber: ({ input, setLondonTime, setMidnight }: GetNumberType) => number;
 export default getNumber;

package/dist/date/getNumber.js

@@ -9,8 +9,8 @@ var getDate_1 = __importDefault(require("./getDate"));
  * Convert a (number | string | Date) into a YYYYMMDD number.
  */
 var getNumber = function (_a) {
-    var input = _a.input;
-    var date = (0, getDate_1.default)({ input: input });
+    var input = _a.input, _b = _a.setLondonTime, setLondonTime = _b === void 0 ? true : _b, _c = _a.setMidnight, setMidnight = _c === void 0 ? true : _c;
+    var date = (0, getDate_1.default)({ input: input, setLondonTime: setLondonTime, setMidnight: setMidnight });
     return Number((0, format_1.default)(date, 'yyyyMMdd'));
 };
 exports.default = getNumber;

package/dist/date/getSunday.d.ts

@@ -1,11 +1,14 @@
 import { DateType } from './date';
+import { GetLondonTimeType } from './getLondonTime';
+declare type GetSundayType = GetLondonTimeType & {
+    input?: DateType;
+    weeksAgo: number;
+    setMidnight?: boolean;
+};
 /**
  * Retrieve the closest last Sunday relative to the input or today.
  * 0 weeksAgo - Tuesday (17th), return Sunday (14th)
  * 1 weeksAgo - Tuesday (17th), return Monday (7th)
  */
-declare const getSunday: ({ weeksAgo, input }: {
-    weeksAgo: number;
-    input?: DateType;
-}) => Date;
+declare const getSunday: ({ weeksAgo, input, setLondonTime, setMidnight }: GetSundayType) => Date;
 export default getSunday;

package/dist/date/getSunday.js

@@ -8,15 +8,14 @@ var isSunday_1 = __importDefault(require("date-fns/isSunday"));
 var subDays_1 = __importDefault(require("date-fns/subDays"));
 var getDate_1 = __importDefault(require("./getDate"));
 var getToday_1 = __importDefault(require("./getToday"));
-var index_1 = require("./index");
 /**
  * Retrieve the closest last Sunday relative to the input or today.
  * 0 weeksAgo - Tuesday (17th), return Sunday (14th)
  * 1 weeksAgo - Tuesday (17th), return Monday (7th)
  */
 var getSunday = function (_a) {
-    var weeksAgo = _a.weeksAgo, input = _a.input;
-    var date = input ? (0, getDate_1.default)({ input: input }) : (0, getToday_1.default)();
+    var weeksAgo = _a.weeksAgo, input = _a.input, _b = _a.setLondonTime, setLondonTime = _b === void 0 ? true : _b, _c = _a.setMidnight, setMidnight = _c === void 0 ? true : _c;
+    var date = input ? (0, getDate_1.default)({ input: input, setLondonTime: setLondonTime, setMidnight: setMidnight }) : (0, getToday_1.default)({ setLondonTime: setLondonTime, setMidnight: setMidnight });
     if (!(0, isSunday_1.default)(date)) {
         // Get the ISO Day of week (Monday - 1 to Sunday - 7)
         var isoDay = (0, getISODay_1.default)(date);
@@ -25,6 +24,6 @@ var getSunday = function (_a) {
     }
     // Move it back a given number of weeks
     date = (0, subDays_1.default)(date, 7 * weeksAgo);
-    return (0, index_1.getTimezoneFixed)({ input: date });
+    return date;
 };
 exports.default = getSunday;

package/dist/date/getThisWeek.d.ts

@@ -1,6 +1,10 @@
+import { GetLondonTimeType } from './getLondonTime';
 import { TimeframeType } from './timeframe';
+declare type GetThisWeekType = GetLondonTimeType & {
+    setMidnight?: boolean;
+};
 /**
  * Return an object of start/end predefined date of This Week.
  */
-declare const getThisWeek: () => TimeframeType;
+declare const getThisWeek: ({ setLondonTime, setMidnight }?: GetThisWeekType) => TimeframeType;
 export default getThisWeek;

package/dist/date/getThisWeek.js

@@ -9,8 +9,23 @@ var getSunday_1 = __importDefault(require("./getSunday"));
 /**
  * Return an object of start/end predefined date of This Week.
  */
-var getThisWeek = function () { return ({
-    end: (0, getNumber_1.default)({ input: (0, getSunday_1.default)({ weeksAgo: -1 }) }),
-    start: (0, getNumber_1.default)({ input: (0, getMonday_1.default)({ weeksAgo: 0 }) }),
-}); };
+var getThisWeek = function (_a) {
+    var _b = _a === void 0 ? { setLondonTime: true, setMidnight: true } : _a, _c = _b.setLondonTime, setLondonTime = _c === void 0 ? true : _c, _d = _b.setMidnight, setMidnight = _d === void 0 ? true : _d;
+    return ({
+        end: (0, getNumber_1.default)({
+            input: (0, getSunday_1.default)({
+                weeksAgo: -1,
+                setLondonTime: setLondonTime,
+                setMidnight: setMidnight,
+            }),
+        }),
+        start: (0, getNumber_1.default)({
+            input: (0, getMonday_1.default)({
+                weeksAgo: 0,
+                setLondonTime: setLondonTime,
+                setMidnight: setMidnight,
+            }),
+        }),
+    });
+};
 exports.default = getThisWeek;

package/dist/date/getToday.d.ts

@@ -1,5 +1,9 @@
+import { GetLondonTimeType } from './getLondonTime';
+declare type GetTodayType = GetLondonTimeType & {
+    setMidnight?: boolean;
+};
 /**
  * Shortcut to get today's date.
  */
-declare const getToday: () => Date;
+declare const getToday: ({ setLondonTime, setMidnight }?: GetTodayType) => Date;
 export default getToday;

package/dist/date/getToday.js

@@ -1,12 +1,21 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var index_1 = require("./index");
+var getLondonTime_1 = __importDefault(require("./getLondonTime"));
 /**
  * Shortcut to get today's date.
  */
-var getToday = function () {
+var getToday = function (_a) {
+    var _b = _a === void 0 ? { setLondonTime: true, setMidnight: true } : _a, _c = _b.setLondonTime, setLondonTime = _c === void 0 ? true : _c, _d = _b.setMidnight, setMidnight = _d === void 0 ? true : _d;
     var today = new Date();
-    today.setHours(0, 0, 0, 0);
-    return (0, index_1.getTimezoneFixed)({ input: today });
+    if (setLondonTime) {
+        today = (0, getLondonTime_1.default)({ input: today });
+    }
+    if (setMidnight) {
+        today.setHours(0, 0, 0, 0);
+    }
+    return today;
 };
 exports.default = getToday;

package/dist/date/getTwoWeeksAgo.d.ts

@@ -1,6 +1,10 @@
+import { GetLondonTimeType } from './getLondonTime';
 import { TimeframeType } from './timeframe';
+declare type GetTwoWeeksAgoType = GetLondonTimeType & {
+    setMidnight?: boolean;
+};
 /**
  * Return an object of start/end predefined date of Two Weeks Ago.
  */
-declare const getTwoWeeksAgo: () => TimeframeType;
+declare const getTwoWeeksAgo: ({ setLondonTime, setMidnight }?: GetTwoWeeksAgoType) => TimeframeType;
 export default getTwoWeeksAgo;

package/dist/date/getTwoWeeksAgo.js

@@ -9,8 +9,23 @@ var getSunday_1 = __importDefault(require("./getSunday"));
 /**
  * Return an object of start/end predefined date of Two Weeks Ago.
  */
-var getTwoWeeksAgo = function () { return ({
-    end: (0, getNumber_1.default)({ input: (0, getSunday_1.default)({ weeksAgo: 1 }) }),
-    start: (0, getNumber_1.default)({ input: (0, getMonday_1.default)({ weeksAgo: 2 }) }),
-}); };
+var getTwoWeeksAgo = function (_a) {
+    var _b = _a === void 0 ? { setLondonTime: true, setMidnight: true } : _a, _c = _b.setLondonTime, setLondonTime = _c === void 0 ? true : _c, _d = _b.setMidnight, setMidnight = _d === void 0 ? true : _d;
+    return ({
+        end: (0, getNumber_1.default)({
+            input: (0, getSunday_1.default)({
+                weeksAgo: 1,
+                setLondonTime: setLondonTime,
+                setMidnight: setMidnight,
+            }),
+        }),
+        start: (0, getNumber_1.default)({
+            input: (0, getMonday_1.default)({
+                weeksAgo: 2,
+                setLondonTime: setLondonTime,
+                setMidnight: setMidnight,
+            }),
+        }),
+    });
+};
 exports.default = getTwoWeeksAgo;

package/dist/date/getWeeksAgo.d.ts

@@ -1,9 +1,12 @@
 import { DateType } from './date';
+import { GetLondonTimeType } from './getLondonTime';
+declare type GetWeeksAgoType = GetLondonTimeType & {
+    input: DateType;
+    weeksAgo: number;
+    setMidnight?: boolean;
+};
 /**
  * From a given input, move the date back X weeksAgo
  */
-declare const getWeeksAgo: ({ input, weeksAgo }: {
-    input: DateType;
-    weeksAgo: number;
-}) => number;
+declare const getWeeksAgo: ({ input, weeksAgo, setLondonTime, setMidnight }: GetWeeksAgoType) => number;
 export default getWeeksAgo;

package/dist/date/getWeeksAgo.js

@@ -10,8 +10,9 @@ var getNumber_1 = __importDefault(require("./getNumber"));
  * From a given input, move the date back X weeksAgo
  */
 var getWeeksAgo = function (_a) {
-    var input = _a.input, _b = _a.weeksAgo, weeksAgo = _b === void 0 ? 0 : _b;
-    var response = (0, sub_1.default)((0, getDate_1.default)({ input: input }), { weeks: weeksAgo });
+    var input = _a.input, _b = _a.weeksAgo, weeksAgo = _b === void 0 ? 0 : _b, _c = _a.setLondonTime, setLondonTime = _c === void 0 ? true : _c, _d = _a.setMidnight, setMidnight = _d === void 0 ? true : _d;
+    var dateInstance = (0, getDate_1.default)({ input: input, setLondonTime: setLondonTime, setMidnight: setMidnight });
+    var response = (0, sub_1.default)(dateInstance, { weeks: weeksAgo });
     return (0, getNumber_1.default)({ input: response });
 };
 exports.default = getWeeksAgo;

package/dist/date/getYesterday.d.ts

@@ -1,5 +1,9 @@
+import { GetLondonTimeType } from './getLondonTime';
+declare type GetYesterdayType = GetLondonTimeType & {
+    setMidnight?: boolean;
+};
 /**
  * Shortcut to get yesterday's date.
  */
-declare const getYesterday: () => Date;
+declare const getYesterday: ({ setLondonTime, setMidnight }?: GetYesterdayType) => Date;
 export default getYesterday;

package/dist/date/getYesterday.js

@@ -8,5 +8,8 @@ var getToday_1 = __importDefault(require("./getToday"));
 /**
  * Shortcut to get yesterday's date.
  */
-var getYesterday = function () { return (0, subDays_1.default)((0, getToday_1.default)(), 1); };
+var getYesterday = function (_a) {
+    var _b = _a === void 0 ? { setLondonTime: true, setMidnight: true } : _a, _c = _b.setLondonTime, setLondonTime = _c === void 0 ? true : _c, _d = _b.setMidnight, setMidnight = _d === void 0 ? true : _d;
+    return (0, subDays_1.default)((0, getToday_1.default)({ setLondonTime: setLondonTime, setMidnight: setMidnight }), 1);
+};
 exports.default = getYesterday;

package/dist/date/index.d.ts

@@ -3,7 +3,6 @@ import { DurationType } from './duration';
 import { durationComparisons } from './durationComparisons';
 import { durations } from './durations';
 import { FinancialYearType } from './financialYear';
-import getTimezoneFixed from './getTimezoneFixed';
 import { FinancialYearWeekType } from './financialYearWeek';
 import format from './format';
 import getDate from './getDate';
@@ -33,4 +32,4 @@ import { predefinedTimeframes, PredefinedTimeframesType } from './predefinedTime
 import { TimeframeType } from './timeframe';
 import { timeframes } from './timeframes';
 export type { DateType, DurationType, FinancialYearType, FinancialYearWeekType, PredefinedTimeframesType, TimeframeType, };
-export { durations, durationComparisons, predefinedTimeframes, timeframes, format, getDate, getDurationHours, getDurationMinutes, getExcelDate, getFinancialYear, getFinancialYearToDate, getFinancialYearWeeks, getLastWeek, getMax, getMin, getMonday, getNumber, getPredefinedTimeframe, getSunday, getThisWeek, getTimezoneFixed, getToday, getTwoWeeksAgo, getWeeksAgo, getYesterday, isDateValid, isLastWeek, isThisWeek, parseExcelDate, };
+export { durations, durationComparisons, predefinedTimeframes, timeframes, format, getDate, getDurationHours, getDurationMinutes, getExcelDate, getFinancialYear, getFinancialYearToDate, getFinancialYearWeeks, getLastWeek, getMax, getMin, getMonday, getNumber, getPredefinedTimeframe, getSunday, getThisWeek, getToday, getTwoWeeksAgo, getWeeksAgo, getYesterday, isDateValid, isLastWeek, isThisWeek, parseExcelDate, };

package/dist/date/index.js

@@ -3,13 +3,11 @@ 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.getWeeksAgo = exports.getTwoWeeksAgo = exports.getToday = exports.getTimezoneFixed = exports.getThisWeek = exports.getSunday = exports.getPredefinedTimeframe = exports.getNumber = exports.getMonday = exports.getMin = exports.getMax = exports.getLastWeek = exports.getFinancialYearWeeks = exports.getFinancialYearToDate = exports.getFinancialYear = exports.getExcelDate = exports.getDurationMinutes = exports.getDurationHours = exports.getDate = exports.format = exports.timeframes = exports.predefinedTimeframes = exports.durationComparisons = exports.durations = void 0;
+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.getExcelDate = exports.getDurationMinutes = exports.getDurationHours = exports.getDate = exports.format = exports.timeframes = exports.predefinedTimeframes = exports.durationComparisons = exports.durations = void 0;
 var durationComparisons_1 = require("./durationComparisons");
 Object.defineProperty(exports, "durationComparisons", { enumerable: true, get: function () { return durationComparisons_1.durationComparisons; } });
 var durations_1 = require("./durations");
 Object.defineProperty(exports, "durations", { enumerable: true, get: function () { return durations_1.durations; } });
-var getTimezoneFixed_1 = __importDefault(require("./getTimezoneFixed"));
-exports.getTimezoneFixed = getTimezoneFixed_1.default;
 var format_1 = __importDefault(require("./format"));
 exports.format = format_1.default;
 var getDate_1 = __importDefault(require("./getDate"));

package/dist/environment/isAws.js

@@ -4,5 +4,5 @@ var platforms_1 = require("./platforms");
 /**
  * Check to see if we are working on AWS Lambda.
  */
-var isAws = function () { return platforms_1.platforms.AWS === process.env['EMS_ENVIRONMENT']; };
+var isAws = function () { return platforms_1.platforms.AWS === process.env['EMS_PLATFORM']; };
 exports.default = isAws;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name":            "@8ms/helpers",
-  "version":         "1.1.28",
+  "version":         "1.1.31",
   "repository":      {
 	"type": "git",
 	"url":  "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"
@@ -12,23 +12,23 @@
 	"jest":  "jest --watch"
   },
   "dependencies":    {
-	"axios":    "0.27.1",
-	"date-fns": "2.28.0",
-	"lodash":   "4.17.21"
+	"axios":       "0.27.2",
+	"date-fns":    "2.28.0",
+	"date-fns-tz": "1.3.4",
+	"lodash":      "4.17.21"
   },
   "devDependencies": {
-	"@babel/preset-env":        "7.16.11",
+	"@babel/preset-env":        "7.17.10",
 	"@babel/preset-flow":       "7.16.7",
 	"@babel/preset-typescript": "7.16.7",
-	"@types/jest":              "27.4.1",
+	"@types/jest":              "27.5.0",
 	"@types/lodash":            "4.14.182",
-	"@types/node":              "17.0.27",
-	"babel-jest":               "28.0.0",
+	"@types/node":              "17.0.31",
+	"babel-jest":               "28.0.3",
 	"crypto-js":                "4.1.1",
-	"date-fns-tz":              "1.3.3",
-	"jest":                     "28.0.0",
+	"jest":                     "28.0.3",
 	"ts-node":                  "10.7.0",
 	"tslib":                    "2.4.0",
-	"typescript":               "4.6.3"
+	"typescript":               "4.6.4"
   }
 }

package/dist/date/getTimezoneFixed.d.ts

@@ -1,5 +0,0 @@
-import { DateType } from './date';
-declare const getTimezoneFixed: ({ input }: {
-    input: DateType;
-}) => Date;
-export default getTimezoneFixed;

package/dist/date/getTimezoneFixed.js

@@ -1,21 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var addHours_1 = __importDefault(require("date-fns/addHours"));
-var subHours_1 = __importDefault(require("date-fns/subHours"));
-var index_1 = require("./index");
-var getTimezoneFixed = function (_a) {
-    var input = _a.input;
-    var inputDate = (0, index_1.getDate)({ input: input });
-    // Accommodate for DST
-    if (inputDate.getTimezoneOffset() < 0) {
-        inputDate = (0, addHours_1.default)(inputDate, 1);
-    }
-    else if (inputDate.getTimezoneOffset() > 0) {
-        inputDate = (0, subHours_1.default)(inputDate, 1);
-    }
-    return inputDate;
-};
-exports.default = getTimezoneFixed;