@8ms/helpers 1.1.49 → 1.1.52

package/{dist/date → date}/format.d.ts

@@ -1,7 +1,7 @@
 import { DateType } from './date';
-import { GetMidnightType } from './getMidnight';
-import { GetTimeZonedType } from './getTimeZoned';
-declare type FormatType = GetTimeZonedType & GetMidnightType & {
+import { GetMidnight } from './getMidnight';
+import { GetTimeZoned } from './getTimeZoned';
+declare type Format = GetTimeZoned & GetMidnight & {
     dateFormat?: string;
     input: DateType;
 };
@@ -9,5 +9,5 @@ declare type FormatType = GetTimeZonedType & GetMidnightType & {
  * Convert a (number | string | Date) into a "yyyy-MM-dd" string or a specified format.
  * As the user would be providing the input we don't want to change the timezone typically.
  */
-declare const format: ({ input, dateFormat, setMidnight, setTimeZone }: FormatType) => string;
+declare const format: ({ input, dateFormat, setMidnight, setTimeZone }: Format) => string;
 export default format;

package/date/getDate.d.ts

@@ -0,0 +1,12 @@
+import { DateType } from './date';
+import { GetMidnight } from './getMidnight';
+import { GetTimeZoned } from './getTimeZoned';
+declare type GetDate = GetTimeZoned & GetMidnight & {
+    input: DateType;
+};
+/**
+ * Convert a (number | string | Date) into a Date object.
+ * As the user would be providing the input we don't want to change the timezone typically.
+ */
+declare const getDate: ({ input, setMidnight, setTimeZone }: GetDate) => Date;
+export default getDate;

package/{dist/date → date}/getFinancialYear.d.ts

@@ -1,9 +1,9 @@
-import { FinancialYearType } from './financialYear';
+import { FinancialYear } from './financialYear';
 declare type GetFinancialYearType = {
     year?: number;
 };
 /**
  * Get the current financial year.
  */
-declare const getFinancialYear: ({ year }?: GetFinancialYearType) => FinancialYearType;
+declare const getFinancialYear: ({ year }?: GetFinancialYearType) => FinancialYear;
 export default getFinancialYear;

package/{dist/date → date}/getFinancialYearToDate.d.ts

@@ -1,7 +1,7 @@
-import { FinancialYearType } from './financialYear';
+import { FinancialYear } from './financialYear';
 /**
  * Return the current financial year up to today.
  * Timezone should always be London based
  */
-declare const getFinancialYearToDate: () => FinancialYearType;
+declare const getFinancialYearToDate: () => FinancialYear;
 export default getFinancialYearToDate;

package/{dist/date → date}/getFinancialYearToYesterday.d.ts

@@ -1,7 +1,7 @@
-import { FinancialYearType } from './financialYear';
+import { FinancialYear } from './financialYear';
 /**
  * Return the current financial year up to yesterday.
  * Timezone should always be London based
  */
-declare const getFinancialYearToYesterday: () => FinancialYearType;
+declare const getFinancialYearToYesterday: () => FinancialYear;
 export default getFinancialYearToYesterday;

package/{dist/date → date}/getFinancialYearWeeks.d.ts

@@ -1,9 +1,9 @@
 import { FinancialYearWeekType } from './financialYearWeek';
-declare type GetFinancialYearWeeksType = {
+declare type GetFinancialYearWeeks = {
     year?: number;
 };
 /**
  * Get the current financial year.
  */
-declare const getFinancialYearWeeks: ({ year }?: GetFinancialYearWeeksType) => FinancialYearWeekType[];
+declare const getFinancialYearWeeks: ({ year }?: GetFinancialYearWeeks) => FinancialYearWeekType[];
 export default getFinancialYearWeeks;

package/{dist/date → date}/getLastWeek.d.ts

@@ -1,10 +1,10 @@
-import { GetMidnightType } from './getMidnight';
-import { GetTimeZonedType } from './getTimeZoned';
-import { TimeframeType } from './timeframe';
-declare type GetLastWeekType = GetTimeZonedType & GetMidnightType;
+import { GetMidnight } from './getMidnight';
+import { GetTimeZoned } from './getTimeZoned';
+import { Timeframe } from './timeframe';
+declare type GetLastWeek = GetTimeZoned & GetMidnight;
 /**
  * Return an object of start/end predefined date of Last Week.
  * Creating a date from scratch (no user input), thus needs to be London time.
  */
-declare const getLastWeek: ({ setMidnight, setTimeZone }?: GetLastWeekType) => TimeframeType;
+declare const getLastWeek: ({ setMidnight, setTimeZone }?: GetLastWeek) => Timeframe;
 export default getLastWeek;

package/date/getMax.d.ts

@@ -0,0 +1,12 @@
+import { DateType } from './date';
+import { GetMidnight } from './getMidnight';
+import { GetTimeZoned } from './getTimeZoned';
+declare type GetMax = GetTimeZoned & GetMidnight & {
+    input: DateType;
+    max: DateType;
+};
+/**
+ * If a given date is beyond the maximum, return the maximum.
+ */
+declare const getMax: ({ input, max, setMidnight }: GetMax) => Date;
+export default getMax;

package/{dist/date → date}/getMidnight.d.ts

@@ -1,10 +1,10 @@
-export declare type GetMidnightType = {
+export declare type GetMidnight = {
     setMidnight?: boolean;
 };
 /**
  * Set a date's time to 0 hours, 0 minutes, 0 seconds, 0 milliseconds
  */
-declare const getMidnight: ({ input, setMidnight }: GetMidnightType & {
+declare const getMidnight: ({ input, setMidnight }: GetMidnight & {
     input: Date;
 }) => Date;
 export default getMidnight;

package/date/getMin.d.ts

@@ -0,0 +1,12 @@
+import { DateType } from './date';
+import { GetMidnight } from './getMidnight';
+import { GetTimeZoned } from './getTimeZoned';
+declare type GetMin = GetTimeZoned & GetMidnight & {
+    input: DateType;
+    min: DateType;
+};
+/**
+ * If a given date is before the minimum, return the minimum.
+ */
+declare const getMin: ({ input, min, setMidnight }: GetMin) => Date;
+export default getMin;

package/{dist/date → date}/getMonday.d.ts

@@ -1,7 +1,7 @@
 import { DateType } from './date';
-import { GetMidnightType } from './getMidnight';
-import { GetTimeZonedType } from './getTimeZoned';
-declare type GetMondayType = GetTimeZonedType & GetMidnightType & {
+import { GetMidnight } from './getMidnight';
+import { GetTimeZoned } from './getTimeZoned';
+declare type GetMonday = GetTimeZoned & GetMidnight & {
     input?: DateType;
     weeksAgo: number;
 };
@@ -10,5 +10,5 @@ declare type GetMondayType = GetTimeZonedType & GetMidnightType & {
  * 0 weeksAgo - Tuesday (10th), return Monday (8th)
  * 1 weeksAgo - Tuesday (10th), return Monday (1st)
  */
-declare const getMonday: ({ weeksAgo, input, setMidnight, setTimeZone }: GetMondayType) => Date;
+declare const getMonday: ({ weeksAgo, input, setMidnight, setTimeZone }: GetMonday) => Date;
 export default getMonday;

package/{dist/date → date}/getNumber.d.ts

@@ -1,11 +1,11 @@
 import { DateType } from './date';
-import { GetMidnightType } from './getMidnight';
-import { GetTimeZonedType } from './getTimeZoned';
-declare type GetNumberType = GetTimeZonedType & GetMidnightType & {
+import { GetMidnight } from './getMidnight';
+import { GetTimeZoned } from './getTimeZoned';
+declare type GetNumber = GetTimeZoned & GetMidnight & {
     input: DateType;
 };
 /**
  * Convert a (number | string | Date) into a YYYYMMDD number.
  */
-declare const getNumber: ({ input, setMidnight, setTimeZone }: GetNumberType) => number;
+declare const getNumber: ({ input, setMidnight, setTimeZone }: GetNumber) => number;
 export default getNumber;

package/date/getPredefinedTimeframe.d.ts

@@ -0,0 +1,9 @@
+import { PredefinedTimeframes } from './predefinedTimeframes';
+import { Timeframe } from './timeframe';
+/**
+ * Check to see the date matches a predefined time frame
+ */
+declare const getPredefinedTimeframe: ({ timeframe }: {
+    timeframe: Timeframe;
+}) => PredefinedTimeframes;
+export default getPredefinedTimeframe;

package/{dist/date → date}/getSunday.d.ts

@@ -1,7 +1,7 @@
 import { DateType } from './date';
-import { GetMidnightType } from './getMidnight';
-import { GetTimeZonedType } from './getTimeZoned';
-declare type GetSundayType = GetTimeZonedType & GetMidnightType & {
+import { GetMidnight } from './getMidnight';
+import { GetTimeZoned } from './getTimeZoned';
+declare type GetSunday = GetTimeZoned & GetMidnight & {
     input?: DateType;
     weeksAgo: number;
 };
@@ -10,5 +10,5 @@ declare type GetSundayType = GetTimeZonedType & GetMidnightType & {
  * 0 weeksAgo - Tuesday (17th), return Sunday (14th)
  * 1 weeksAgo - Tuesday (17th), return Monday (7th)
  */
-declare const getSunday: ({ weeksAgo, input, setMidnight, setTimeZone }: GetSundayType) => Date;
+declare const getSunday: ({ weeksAgo, input, setMidnight, setTimeZone }: GetSunday) => Date;
 export default getSunday;

package/{dist/date → date}/getThisWeek.d.ts

@@ -1,10 +1,10 @@
-import { GetMidnightType } from './getMidnight';
-import { GetTimeZonedType } from './getTimeZoned';
-import { TimeframeType } from './timeframe';
-declare type GetThisWeekType = GetTimeZonedType & GetMidnightType;
+import { GetMidnight } from './getMidnight';
+import { GetTimeZoned } from './getTimeZoned';
+import { Timeframe } from './timeframe';
+declare type GetThisWeek = GetTimeZoned & GetMidnight;
 /**
  * Return an object of start/end predefined date of This Week.
  * Creating a date from scratch (no user input), thus needs to be London time.
  */
-declare const getThisWeek: ({ setMidnight, setTimeZone }?: GetThisWeekType) => TimeframeType;
+declare const getThisWeek: ({ setMidnight, setTimeZone }?: GetThisWeek) => Timeframe;
 export default getThisWeek;

package/{dist/date → date}/getTimeZoned.d.ts

@@ -1,4 +1,4 @@
-export declare type GetTimeZonedType = {
+export declare type GetTimeZoned = {
     setTimeZone?: string | false;
 };
 export declare const timeZoneLondon = "Europe/London";
@@ -7,7 +7,7 @@ export declare const timeZoneLondon = "Europe/London";
  * We can't use getDate here as it becomes a circular issue.
  * Returns a new Date instance.
  */
-declare const getTimeZoned: ({ input, setTimeZone, }: GetTimeZonedType & {
+declare const getTimeZoned: ({ input, setTimeZone }: GetTimeZoned & {
     input: Date;
 }) => Date;
 export default getTimeZoned;

package/{dist/date → date}/getToday.d.ts

@@ -1,9 +1,9 @@
-import { GetMidnightType } from './getMidnight';
-import { GetTimeZonedType } from './getTimeZoned';
-declare type GetTodayType = GetTimeZonedType & GetMidnightType;
+import { GetMidnight } from './getMidnight';
+import { GetTimeZoned } from './getTimeZoned';
+declare type GetToday = GetTimeZoned & GetMidnight;
 /**
  * Shortcut to get today's date.
  * Creating a date from scratch (no user input), thus needs to be London time.
  */
-declare const getToday: ({ setMidnight, setTimeZone }?: GetTodayType) => Date;
+declare const getToday: ({ setMidnight, setTimeZone }?: GetToday) => Date;
 export default getToday;

package/date/getTwoWeeksAgo.d.ts

@@ -0,0 +1,10 @@
+import { GetMidnight } from './getMidnight';
+import { GetTimeZoned } from './getTimeZoned';
+import { Timeframe } from './timeframe';
+declare type GetTwoWeeksAgo = GetTimeZoned & GetMidnight;
+/**
+ * Return an object of start/end predefined date of Two Weeks Ago.
+ * Creating a date from scratch (no user input), thus needs to be London time.
+ */
+declare const getTwoWeeksAgo: ({ setMidnight, setTimeZone }?: GetTwoWeeksAgo) => Timeframe;
+export default getTwoWeeksAgo;

package/{dist/date → date}/getWeeksAgo.d.ts

@@ -1,6 +1,6 @@
 import { DateType } from './date';
-import { GetTimeZonedType } from './getTimeZoned';
-declare type GetWeeksAgoType = GetTimeZonedType & {
+import { GetTimeZoned } from './getTimeZoned';
+declare type GetWeeksAgo = GetTimeZoned & {
     input: DateType;
     weeksAgo: number;
     setMidnight?: boolean;
@@ -8,5 +8,5 @@ declare type GetWeeksAgoType = GetTimeZonedType & {
 /**
  * From a given input, move the date back X weeksAgo
  */
-declare const getWeeksAgo: ({ input, weeksAgo, setMidnight, setTimeZone }: GetWeeksAgoType) => number;
+declare const getWeeksAgo: ({ input, weeksAgo, setMidnight, setTimeZone }: GetWeeksAgo) => number;
 export default getWeeksAgo;

package/{dist/date → date}/getYesterday.d.ts

@@ -1,9 +1,9 @@
-import { GetMidnightType } from './getMidnight';
-import { GetTimeZonedType } from './getTimeZoned';
-declare type GetYesterdayType = GetTimeZonedType & GetMidnightType;
+import { GetMidnight } from './getMidnight';
+import { GetTimeZoned } from './getTimeZoned';
+declare type GetYesterday = GetTimeZoned & GetMidnight;
 /**
  * Shortcut to get yesterday's date.
  * Creating a date from scratch (no user input), thus needs to be London time.
  */
-declare const getYesterday: ({ setMidnight, setTimeZone }?: GetYesterdayType) => Date;
+declare const getYesterday: ({ setMidnight, setTimeZone }?: GetYesterday) => Date;
 export default getYesterday;

package/date/isLastWeek.d.ts

@@ -0,0 +1,6 @@
+import { Timeframe } from './timeframe';
+/**
+ * Check to see if a given timeframe is Last Week.
+ */
+declare const isLastWeek: ({ end, start }: Timeframe) => boolean;
+export default isLastWeek;

package/date/isThisWeek.d.ts

@@ -0,0 +1,6 @@
+import { Timeframe } from './timeframe';
+/**
+ * Check to see if a given timeframe is Last Week.
+ */
+declare const isThisWeek: ({ end, start }: Timeframe) => boolean;
+export default isThisWeek;

package/date/predefinedTimeframes.d.ts

@@ -0,0 +1,7 @@
+export declare const predefinedTimeframes: {
+    NONE: string;
+    CUSTOM: string;
+    THIS_WEEK: string;
+    LAST_WEEK: string;
+};
+export declare type PredefinedTimeframes = typeof predefinedTimeframes.NONE | typeof predefinedTimeframes.CUSTOM | typeof predefinedTimeframes.LAST_WEEK | typeof predefinedTimeframes.THIS_WEEK;

package/{dist/date → date}/timeframe.d.ts

@@ -2,7 +2,7 @@ import { DateType } from './date';
 /**
  * A timeframe has a start and an end date.
  */
-export declare type TimeframeType = {
+export declare type Timeframe = {
     end: DateType;
     start: DateType;
 };

package/environment/environments.d.ts

@@ -0,0 +1,7 @@
+declare const environments: {
+    DEVELOPMENT: string;
+    STAGING: string;
+    PRODUCTION: string;
+};
+export declare type Environment = typeof environments.DEVELOPMENT | typeof environments.STAGING | typeof environments.PRODUCTION;
+export default environments;

package/{dist/environment → environment}/environments.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.environments = void 0;
-exports.environments = {
+var environments = {
     DEVELOPMENT: 'development',
     STAGING: 'staging',
     PRODUCTION: 'production',
 };
+exports.default = environments;

package/environment/getEnvironment.d.ts

@@ -0,0 +1,6 @@
+import { Environment } from './environments';
+/**
+ * Determine the environment we're using.
+ */
+declare const getEnvironment: () => Environment;
+export default getEnvironment;

package/{dist/environment → environment}/getEnvironment.js

@@ -1,6 +1,9 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var environments_1 = require("./environments");
+var environments_1 = __importDefault(require("./environments"));
 /**
  * Determine the environment we're using.
  */
@@ -25,15 +28,15 @@ var getEnvironment = function () {
     }
     switch (platformEnvironment) {
         case 'development':
-            response = environments_1.environments.DEVELOPMENT;
+            response = environments_1.default.DEVELOPMENT;
             break;
         case 'demo':
         case 'preview':
         case 'staging':
-            response = environments_1.environments.STAGING;
+            response = environments_1.default.STAGING;
             break;
         default:
-            response = environments_1.environments.PRODUCTION;
+            response = environments_1.default.PRODUCTION;
     }
     return response;
 };

package/environment/isAws.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var platforms_1 = __importDefault(require("./platforms"));
+/**
+ * Check to see if we are working on AWS Lambda.
+ */
+var isAws = function () { return platforms_1.default.AWS === process.env['EMS_PLATFORM']; };
+exports.default = isAws;

package/{dist/environment → environment}/isDevelopment.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 });
-var environments_1 = require("./environments");
+var environments_1 = __importDefault(require("./environments"));
 var getEnvironment_1 = __importDefault(require("./getEnvironment"));
-var isDevelopment = function () { return environments_1.environments.DEVELOPMENT === (0, getEnvironment_1.default)(); };
+var isDevelopment = function () { return environments_1.default.DEVELOPMENT === (0, getEnvironment_1.default)(); };
 exports.default = isDevelopment;

package/{dist/environment → environment}/isProduction.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 });
-var environments_1 = require("./environments");
+var environments_1 = __importDefault(require("./environments"));
 var getEnvironment_1 = __importDefault(require("./getEnvironment"));
-var isProduction = function () { return environments_1.environments.PRODUCTION === (0, getEnvironment_1.default)(); };
+var isProduction = function () { return environments_1.default.PRODUCTION === (0, getEnvironment_1.default)(); };
 exports.default = isProduction;

package/{dist/environment → environment}/isStaging.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 });
-var environments_1 = require("./environments");
+var environments_1 = __importDefault(require("./environments"));
 var getEnvironment_1 = __importDefault(require("./getEnvironment"));
-var isStaging = function () { return environments_1.environments.STAGING === (0, getEnvironment_1.default)(); };
+var isStaging = function () { return environments_1.default.STAGING === (0, getEnvironment_1.default)(); };
 exports.default = isStaging;

package/environment/platforms.d.ts

@@ -0,0 +1,6 @@
+declare const platforms: {
+    AWS: string;
+    VERCEL: string;
+};
+export declare type Platforms = typeof platforms.AWS | typeof platforms.VERCEL;
+export default platforms;

package/{dist/environment → environment}/platforms.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.platforms = void 0;
-exports.platforms = {
+var platforms = {
     AWS: 'aws',
     VERCEL: 'vercel',
 };
+exports.default = platforms;

package/eskimi/ageGroups.d.ts

@@ -0,0 +1,5 @@
+declare const ageGroups: {
+    id: number;
+    name: string;
+}[];
+export default ageGroups;

package/{dist/eskimi → eskimi}/ageGroups.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ageGroups = void 0;
-exports.ageGroups = [
+var ageGroups = [
     {
         "id": 0,
         "name": "0-17",
@@ -39,3 +38,4 @@ exports.ageGroups = [
         "name": "65+",
     },
 ];
+exports.default = ageGroups;

package/{dist/eskimi → eskimi}/campaign.d.ts

@@ -1,4 +1,4 @@
-export declare type CampaignType = {
+export declare type Campaign = {
     id: number;
     name: string;
     type: number;

package/eskimi/devices.d.ts

@@ -0,0 +1,5 @@
+declare const devices: {
+    id: number;
+    name: string;
+}[];
+export default devices;