feat: add timeUntilStatusChange to OpenStatusDayAndTime interface (#18)

* feat: add timeUntilStatusChange to OpenStatusDayAndTime interface * test: fix failing tests * refactor: pull date string calculations into separate variables, change variable names * docs: generate documentation * refactor: change timeUntilStatusChange to millisecondsUntilStatusChange * refactor: Update test/helpers.location.test.ts Co-authored-by: Allen <[email protected]> * refactor: rename time until status change variable --------- Co-authored-by: Allen <[email protected]>
square · Nov 5, 2024 · caa7d61 · caa7d61
1 parent 5d6b703
commit caa7d61
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 3 deletions.
diff --git a/src/helpers/location.ts b/src/helpers/location.ts
@@ -94,21 +94,27 @@ export class Location {
             const closeTime = localizeDate(dateObj, locale, DateFormats.hourNminuteNsecondN, timezone, false);
             const openUntil = getFormattedTime(dateObj, closeTime, DateFormats.hourNminuteN, locale, timezone, tzOffsetString);
             const openUntilDay = getFormattedTime(dateObj, closeTime, DateFormats.weekdayLong, locale, timezone, tzOffsetString);
+            const timeUntilClose = dateObj.getTime() - dateNow.getTime();
             return {
                 status: this.OpenStatus.CURRENTLY_OPEN,
                 time: openUntil,
                 day: openUntilDay,
+                timeUntilStatusChangeMs: timeUntilClose,
             };
         }
 
         const nextOpenIntervalToday = this.getNextOpenIntervalToday(locale, timezone, hours);
         if (nextOpenIntervalToday) {
             const opensAt = getFormattedTime(dateNow, nextOpenIntervalToday.open, DateFormats.hourNminuteN, locale, timezone, tzOffsetString);
             const opensAtDay = getFormattedTime(dateNow, nextOpenIntervalToday.open, DateFormats.weekdayLong, locale, timezone, tzOffsetString);
+            const opensAtDateString = localizeDate(dateNow, locale, DateFormats.yearNmonthNdayN, timezone);
+            const opensAtDateObj = getDateObjInTimezone(opensAtDateString, nextOpenIntervalToday.open, tzOffsetString);
+            const timeUntilOpen = opensAtDateObj.getTime() - dateNow.getTime();
             return {
                 status: this.OpenStatus.OPENS_LATER_TODAY,
                 time: opensAt,
                 day: opensAtDay,
+                timeUntilStatusChangeMs: timeUntilOpen,
             };
         }
 
@@ -117,10 +123,14 @@ export class Location {
             const { date, interval: nextInterval } = nextOpenIntervalAfterToday;
             const opensAt = getFormattedTime(date, nextInterval.open, DateFormats.hourNminuteN, locale, timezone, tzOffsetString);
             const opensAtDay = getFormattedTime(date, nextInterval.open, DateFormats.weekdayLong, locale, timezone, tzOffsetString);
+            const opensAtDateString = localizeDate(date, locale, DateFormats.yearNmonthNdayN, timezone);
+            const opensAtDateObj = getDateObjInTimezone(opensAtDateString, nextOpenIntervalAfterToday.interval.open, tzOffsetString);
+            const timeUntilOpen = opensAtDateObj.getTime() - dateNow.getTime();
             return {
                 status: this.OpenStatus.OPENS_ANOTHER_DAY,
                 time: opensAt,
                 day: opensAtDay,
+                timeUntilStatusChangeMs: timeUntilOpen,
             };
         }
 

diff --git a/src/types/helpers/location/index.ts b/src/types/helpers/location/index.ts
@@ -22,6 +22,10 @@ export interface OpenStatusDayAndTime {
 	status: OpenStatus;
 	time: string;
 	day: string;
+	/**
+	 * Milliseconds until the `status` changes to a different `OpenStatus` value
+	 */
+	timeUntilStatusChangeMs?: number;
 }
 
 export interface Address {

diff --git a/test/helpers.location.test.ts b/test/helpers.location.test.ts
@@ -439,6 +439,7 @@ describe('Location fulfillment status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.CURRENTLY_OPEN,
             time: '3:00 pm',
             day: 'Monday',
+            timeUntilStatusChangeMs: 7200000,
         });
     });
 
@@ -453,6 +454,7 @@ describe('Location fulfillment status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.OPENS_LATER_TODAY,
             time: '4:00 pm',
             day: 'Monday',
+            timeUntilStatusChangeMs: 1800000,
         });
     });
 
@@ -467,6 +469,7 @@ describe('Location fulfillment status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.OPENS_ANOTHER_DAY,
             time: '12:00 pm',
             day: 'Tuesday',
+            timeUntilStatusChangeMs: 46800000,
         });
     });
 
@@ -481,6 +484,7 @@ describe('Location fulfillment status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.OPENS_LATER_TODAY,
             time: '12:00 pm',
             day: 'Monday',
+            timeUntilStatusChangeMs: 7200000,
         });
     });
 
@@ -502,7 +506,7 @@ describe('Location fulfillment status day and time variations', () => {
                 'close_formatted': '4:00 AM'
             },
         ];
-        // Monday January 1, 2024 10:00:00 pm
+        // Monday January 1, 2024 8:00:00 pm
         const date = new Date(2024, 0, 1, 20, 0);
         vi.setSystemTime(date);
 
@@ -511,6 +515,7 @@ describe('Location fulfillment status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.CURRENTLY_OPEN,
             time: '4:00 am',
             day: 'Tuesday',
+            timeUntilStatusChangeMs: 28800000,
         });
     });
 
@@ -532,7 +537,7 @@ describe('Location fulfillment status day and time variations', () => {
                 'close_formatted': '12:30 AM'
             },
         ];
-        // Monday January 1, 2024 10:00:00 am
+        // Monday January 1, 2024 8:00:00 pm
         const date = new Date(2024, 0, 1, 20);
         vi.setSystemTime(date);
 
@@ -541,6 +546,7 @@ describe('Location fulfillment status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.CURRENTLY_OPEN,
             time: '12:30 am',
             day: 'Tuesday',
+            timeUntilStatusChangeMs: 16200000,
         });
     });
 
@@ -572,6 +578,7 @@ describe('Location fulfillment status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.CURRENTLY_OPEN,
             time: '12:30 am',
             day: 'Tuesday',
+            timeUntilStatusChangeMs: 1800000,
         });
     });
 
@@ -603,6 +610,7 @@ describe('Location fulfillment status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.CURRENTLY_OPEN,
             time: '12:30 am',
             day: 'Tuesday',
+            timeUntilStatusChangeMs: 1800000,
         });
     });
 
@@ -625,6 +633,7 @@ describe('Location fulfillment status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.CURRENTLY_OPEN,
             time: '12:59 am',
             day: 'Monday',
+            timeUntilStatusChangeMs: 2940000,
         });
     });
 
@@ -769,6 +778,7 @@ describe('Location fulfillment status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.CURRENTLY_OPEN,
             time: '12:00 am',
             day: 'Saturday',
+            timeUntilStatusChangeMs: 396000000,
         });
     });
 
@@ -788,6 +798,7 @@ describe('Location fulfillment status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.CURRENTLY_OPEN,
             time: '3:00 pm',
             day: 'Monday',
+            timeUntilStatusChangeMs: 7200000,
         });
     });
 
@@ -807,6 +818,7 @@ describe('Location fulfillment status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.OPENS_LATER_TODAY,
             time: '4:00 pm',
             day: 'Monday',
+            timeUntilStatusChangeMs: 1800000,
         });
     });
 
@@ -826,6 +838,7 @@ describe('Location fulfillment status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.OPENS_ANOTHER_DAY,
             time: '12:00 pm',
             day: 'Tuesday',
+            timeUntilStatusChangeMs: 46800000,
         });
     });
 });
@@ -852,6 +865,7 @@ describe('Location business hours status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.CURRENTLY_OPEN,
             time: '3:00 pm',
             day: 'Monday',
+            timeUntilStatusChangeMs: 7200000,
         });
     });
 
@@ -866,6 +880,7 @@ describe('Location business hours status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.OPENS_LATER_TODAY,
             time: '4:00 pm',
             day: 'Monday',
+            timeUntilStatusChangeMs: 1800000,
         });
     });
 
@@ -880,6 +895,7 @@ describe('Location business hours status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.OPENS_ANOTHER_DAY,
             time: '12:00 pm',
             day: 'Tuesday',
+            timeUntilStatusChangeMs: 46800000,
         });
     });
 
@@ -894,6 +910,7 @@ describe('Location business hours status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.OPENS_LATER_TODAY,
             time: '12:00 pm',
             day: 'Monday',
+            timeUntilStatusChangeMs: 7200000,
         });
     });
 
@@ -915,7 +932,7 @@ describe('Location business hours status day and time variations', () => {
                 'close_formatted': '4:00 AM'
             },
         ];
-        // Monday January 1, 2024 10:00:00 pm
+        // Monday January 1, 2024 8:00:00 pm
         const date = new Date(2024, 0, 1, 20, 0);
         vi.setSystemTime(date);
 
@@ -924,6 +941,7 @@ describe('Location business hours status day and time variations', () => {
             status: sdk.helpers.location.OpenStatus.CURRENTLY_OPEN,
             time: '4:00 am',
             day: 'Tuesday',
+            timeUntilStatusChangeMs: 28800000,
         });
     });
 

diff --git a/typedocs/interfaces/types_helpers_location.OpenStatusDayAndTime.md b/typedocs/interfaces/types_helpers_location.OpenStatusDayAndTime.md