@8ms/helpers 2.0.31 → 2.0.32

package/date/calculation.d.ts

@@ -1,5 +1,5 @@
 import { DateTime } from "luxon";
-import { InputDate, Timeframe } from "./";
+import { InputDate, Timeframe } from "./type";
 export declare const getUnix: (input?: InputDate) => number;
 /**
  * Assume the input is always UTC.

package/date/financialYear.d.ts

@@ -1,4 +1,4 @@
-import { Timeframe } from "./";
+import { Timeframe } from "./type";
 import { Interval } from "luxon";
 /**
  * Get the current financial year.

package/date/financialYear.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getFinancialYearWeeks = exports.getFinancialYearToYesterday = exports.getFinancialYearToDate = exports.getFinancialYear = void 0;
-const _1 = require("./");
+const calculation_1 = require("./calculation");
 const luxon_1 = require("luxon");
 /**
  * Get the current financial year.
@@ -10,9 +10,9 @@ const getFinancialYear = (year) => {
     // Either use the current year or a specified year
     let financialYear = year;
     if ("undefined" === typeof year) {
-        const todayInstance = (0, _1.getToday)();
+        const todayInstance = (0, calculation_1.getToday)();
         // If today is before 1st of April, then use last year
-        if (todayInstance < (0, _1.getDate)(`${todayInstance.toFormat("yyyy")}-04-01`)) {
+        if (todayInstance < (0, calculation_1.getDate)(`${todayInstance.toFormat("yyyy")}-04-01`)) {
             financialYear = Number(todayInstance.toFormat("yyyy")) - 1;
         }
         // On or after 1st of April, use this year
@@ -21,7 +21,7 @@ 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 = (0, _1.getDate)(`${financialYear}-04-01`);
+    let yearStartInstance = (0, calculation_1.getDate)(`${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)
@@ -32,7 +32,7 @@ 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 = (0, _1.getDate)(`${(financialYear + 1)}-03-31`);
+    let yearEndInstance = (0, calculation_1.getDate)(`${(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)
@@ -51,7 +51,7 @@ exports.getFinancialYear = getFinancialYear;
  * Return the current financial year up to today.
  */
 const getFinancialYearToDate = () => {
-    const todayInstance = (0, _1.getToday)();
+    const todayInstance = (0, calculation_1.getToday)();
     const thisFinancialYear = (0, exports.getFinancialYear)();
     return {
         end: todayInstance,
@@ -64,7 +64,7 @@ exports.getFinancialYearToDate = getFinancialYearToDate;
  * Timezone should always be London based
  */
 const getFinancialYearToYesterday = () => {
-    const yesterdayInstance = (0, _1.getYesterday)();
+    const yesterdayInstance = (0, calculation_1.getYesterday)();
     const thisFinancialYear = (0, exports.getFinancialYear)();
     return {
         end: yesterdayInstance,

package/date/format.d.ts

@@ -1,4 +1,4 @@
-import { InputDate } from "./";
+import { InputDate } from "./type";
 import { DateTime } from "luxon";
 /**
  * Convert a number of seconds into HH:MM:SS
@@ -37,6 +37,10 @@ export declare const getMonthYearString: (input: InputDate) => string;
  * Shorthand to get the current date.
  */
 export declare const getTodayYmdString: () => string;
+/**
+ * Shorthand to get the current date.
+ */
+export declare const getTodayYmdNumber: () => number;
 /**
  * Convert a Date into a YYYY number.
  */

package/date/format.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseExcelDate = exports.getYmdString = exports.getYmdNumber = exports.getYmdHisString = exports.getYmdHisNumber = exports.getYearNumber = exports.getTodayYmdString = exports.getMonthYearString = exports.getFullDateTime = exports.getFullDate = exports.getDayNumber = exports.format = exports.getDurationMinutes = exports.getDurationHours = void 0;
-const _1 = require("./");
+exports.parseExcelDate = exports.getYmdString = exports.getYmdNumber = exports.getYmdHisString = exports.getYmdHisNumber = exports.getYearNumber = exports.getTodayYmdNumber = exports.getTodayYmdString = exports.getMonthYearString = exports.getFullDateTime = exports.getFullDate = exports.getDayNumber = exports.format = exports.getDurationMinutes = exports.getDurationHours = void 0;
+const calculation_1 = require("./calculation");
 const luxon_1 = require("luxon");
 /**
  * Convert a number of seconds into HH:MM:SS
@@ -49,7 +49,7 @@ exports.getDurationMinutes = getDurationMinutes;
  * Simple function takes any DateTime, String or Number and formats it.
  */
 const format = (input, dateFormat) => {
-    const instance = (0, _1.getDate)(input);
+    const instance = (0, calculation_1.getDate)(input);
     return instance.toFormat(dateFormat);
 };
 exports.format = format;
@@ -88,10 +88,18 @@ exports.getMonthYearString = getMonthYearString;
  * Shorthand to get the current date.
  */
 const getTodayYmdString = () => {
-    const today = (0, _1.getToday)();
+    const today = (0, calculation_1.getToday)();
     return (0, exports.getYmdString)(today);
 };
 exports.getTodayYmdString = getTodayYmdString;
+/**
+ * Shorthand to get the current date.
+ */
+const getTodayYmdNumber = () => {
+    const today = (0, calculation_1.getToday)();
+    return (0, exports.getYmdNumber)(today);
+};
+exports.getTodayYmdNumber = getTodayYmdNumber;
 /**
  * Convert a Date into a YYYY number.
  */

package/date/index.d.ts

@@ -1,38 +1,4 @@
-import type { DateTime } from "luxon";
-export type InputDate = Date | DateTime | string | number;
-export type FinancialWeek = {
-    end: DateTime;
-    start: DateTime;
-    weekNumber: number;
-    year: number;
-};
-/**
- * A timeframe has a start and an end date.
- */
-export type Timeframe = {
-    end: DateTime;
-    start: DateTime;
-};
-export declare const defaultDate: "1901-01-01";
-export declare const defaultDateNumber: 19010101;
-export declare const defaultDateTime: "1901-01-01 00:00:00";
-/**
- * Used by Google Ads API.
- */
-export declare enum Month {
-    JANUARY = "JANUARY",
-    FEBRUARY = "FEBRUARY",
-    MARCH = "MARCH",
-    APRIL = "APRIL",
-    MAY = "MAY",
-    JUNE = "JUNE",
-    JULY = "JULY",
-    AUGUST = "AUGUST",
-    SEPTEMBER = "SEPTEMBER",
-    OCTOBER = "OCTOBER",
-    NOVEMBER = "NOVEMBER",
-    DECEMBER = "DECEMBER"
-}
+export * from "./type";
 export * from "./calculation";
 export * from "./financialYear";
 export * from "./format";

package/date/index.js

@@ -14,28 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Month = exports.defaultDateTime = exports.defaultDateNumber = exports.defaultDate = void 0;
-exports.defaultDate = "1901-01-01";
-exports.defaultDateNumber = 19010101;
-exports.defaultDateTime = "1901-01-01 00:00:00";
-/**
- * Used by Google Ads API.
- */
-var Month;
-(function (Month) {
-    Month["JANUARY"] = "JANUARY";
-    Month["FEBRUARY"] = "FEBRUARY";
-    Month["MARCH"] = "MARCH";
-    Month["APRIL"] = "APRIL";
-    Month["MAY"] = "MAY";
-    Month["JUNE"] = "JUNE";
-    Month["JULY"] = "JULY";
-    Month["AUGUST"] = "AUGUST";
-    Month["SEPTEMBER"] = "SEPTEMBER";
-    Month["OCTOBER"] = "OCTOBER";
-    Month["NOVEMBER"] = "NOVEMBER";
-    Month["DECEMBER"] = "DECEMBER";
-})(Month || (exports.Month = Month = {}));
+__exportStar(require("./type"), exports);
 __exportStar(require("./calculation"), exports);
 __exportStar(require("./financialYear"), exports);
 __exportStar(require("./format"), exports);

package/date/type.d.ts

@@ -0,0 +1,35 @@
+import type { DateTime } from "luxon";
+export type InputDate = Date | DateTime | string | number;
+export type FinancialWeek = {
+    end: DateTime;
+    start: DateTime;
+    weekNumber: number;
+    year: number;
+};
+/**
+ * A timeframe has a start and an end date.
+ */
+export type Timeframe = {
+    end: DateTime;
+    start: DateTime;
+};
+export declare const defaultDate: "1901-01-01";
+export declare const defaultDateNumber: 19010101;
+export declare const defaultDateTime: "1901-01-01 00:00:00";
+/**
+ * Used by Google Ads API.
+ */
+export declare enum Month {
+    JANUARY = "JANUARY",
+    FEBRUARY = "FEBRUARY",
+    MARCH = "MARCH",
+    APRIL = "APRIL",
+    MAY = "MAY",
+    JUNE = "JUNE",
+    JULY = "JULY",
+    AUGUST = "AUGUST",
+    SEPTEMBER = "SEPTEMBER",
+    OCTOBER = "OCTOBER",
+    NOVEMBER = "NOVEMBER",
+    DECEMBER = "DECEMBER"
+}

package/date/type.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Month = exports.defaultDateTime = exports.defaultDateNumber = exports.defaultDate = void 0;
+exports.defaultDate = "1901-01-01";
+exports.defaultDateNumber = 19010101;
+exports.defaultDateTime = "1901-01-01 00:00:00";
+/**
+ * Used by Google Ads API.
+ */
+var Month;
+(function (Month) {
+    Month["JANUARY"] = "JANUARY";
+    Month["FEBRUARY"] = "FEBRUARY";
+    Month["MARCH"] = "MARCH";
+    Month["APRIL"] = "APRIL";
+    Month["MAY"] = "MAY";
+    Month["JUNE"] = "JUNE";
+    Month["JULY"] = "JULY";
+    Month["AUGUST"] = "AUGUST";
+    Month["SEPTEMBER"] = "SEPTEMBER";
+    Month["OCTOBER"] = "OCTOBER";
+    Month["NOVEMBER"] = "NOVEMBER";
+    Month["DECEMBER"] = "DECEMBER";
+})(Month || (exports.Month = Month = {}));

package/package.json

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