scschedule 4.1.1 → 4.2.0

package/README.md

@@ -213,6 +213,25 @@ const isOpen = isScheduleAvailable(
 )
 ```
 
+#### `isInOvernightSpillover(schedule: Schedule, date: SDate | string, time: STime | string): boolean`
+
+Returns true if the given date and time fall within overnight spillover from the previous day's schedule. Useful when modifying the previous day's schedule would affect current availability (e.g., a business owner wanting to close early during an overnight shift that started yesterday).
+
+```typescript
+import { isInOvernightSpillover } from 'scschedule'
+import { sDate, sTime } from 'scdate'
+
+// Friday 01:00 is in Thursday's 22:00-02:00 spillover
+const inSpillover = isInOvernightSpillover(
+  schedule,
+  sDate('2025-01-11'),
+  sTime('01:00'),
+)
+if (inSpillover) {
+  // Modifying Thursday's schedule would affect current availability
+}
+```
+
 #### `getNextAvailableFromSchedule(schedule: Schedule, fromTimestamp: STimestamp | string, maxDaysToSearch: number): STimestamp | undefined`
 
 Find the next available timestamp from a given time. Searches up to `maxDaysToSearch` days forward.

package/dist/index.d.ts

@@ -8,4 +8,5 @@ export * from './getApplicableRuleForDate.js';
 export * from './getAvailableRangesFromSchedule.js';
 export * from './getNextAvailableFromSchedule.js';
 export * from './getNextUnavailableFromSchedule.js';
+export * from './isInOvernightSpillover.js';
 export * from './isScheduleAvailable.js';

package/dist/index.js

@@ -11,4 +11,5 @@ export * from './getApplicableRuleForDate.js';
 export * from './getAvailableRangesFromSchedule.js';
 export * from './getNextAvailableFromSchedule.js';
 export * from './getNextUnavailableFromSchedule.js';
+export * from './isInOvernightSpillover.js';
 export * from './isScheduleAvailable.js';

package/dist/isInOvernightSpillover.d.ts

@@ -0,0 +1,21 @@
+import { type SDate, type STime } from 'scdate';
+import type { Schedule, SDateString, STimeString } from './types.js';
+/**
+ * Returns true if the given date and time fall within overnight spillover from
+ * the previous day's schedule.
+ *
+ * An overnight rule (where `to` < `from`, e.g. 22:00-02:00) spills into the
+ * next calendar day. This function checks whether the given time on the given
+ * date falls before that rule's `to` time — i.e., within the spillover window.
+ *
+ * Use this to determine whether modifying the previous day's schedule would
+ * affect current availability. For example, a business owner wanting to close
+ * early during an overnight shift that started yesterday needs to know if
+ * today's early-morning availability is driven by yesterday's rules.
+ *
+ * @param schedule The schedule to check.
+ * @param date The date to check (the "current" day).
+ * @param time The time to check.
+ * @returns True if (date, time) is in spillover from the previous day.
+ */
+export declare const isInOvernightSpillover: (schedule: Schedule, date: SDate | SDateString, time: STime | STimeString) => boolean;

package/dist/isInOvernightSpillover.js

@@ -0,0 +1,36 @@
+import { addDaysToDate, getTimeAtMidnight, getWeekdayFromDate, isSameTime, } from 'scdate';
+import { getApplicableRuleForDate } from './getApplicableRuleForDate.js';
+import { getEffectiveTimesForWeekday } from './internal/getEffectiveTimesForWeekday.js';
+import { isTimeInTimeRange } from './internal/isTimeInTimeRange.js';
+/**
+ * Returns true if the given date and time fall within overnight spillover from
+ * the previous day's schedule.
+ *
+ * An overnight rule (where `to` < `from`, e.g. 22:00-02:00) spills into the
+ * next calendar day. This function checks whether the given time on the given
+ * date falls before that rule's `to` time — i.e., within the spillover window.
+ *
+ * Use this to determine whether modifying the previous day's schedule would
+ * affect current availability. For example, a business owner wanting to close
+ * early during an overnight shift that started yesterday needs to know if
+ * today's early-morning availability is driven by yesterday's rules.
+ *
+ * @param schedule The schedule to check.
+ * @param date The date to check (the "current" day).
+ * @param time The time to check.
+ * @returns True if (date, time) is in spillover from the previous day.
+ */
+export const isInOvernightSpillover = (schedule, date, time) => {
+    const previousDate = addDaysToDate(date, -1);
+    const currentWeekday = getWeekdayFromDate(date);
+    const previousResult = getApplicableRuleForDate(schedule, previousDate);
+    if (previousResult.rules === true) {
+        return false;
+    }
+    const midnight = getTimeAtMidnight();
+    return previousResult.rules.some((rule) => {
+        const effectiveTimes = getEffectiveTimesForWeekday(rule, currentWeekday);
+        const spilloverRanges = effectiveTimes.filter((range) => isSameTime(range.from, midnight));
+        return spilloverRanges.some((range) => isTimeInTimeRange(time, range, true));
+    });
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scschedule",
-  "version": "4.1.1",
+  "version": "4.2.0",
   "type": "module",
   "exports": {
     ".": "./dist/index.js"
@@ -20,7 +20,7 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "scdate": "4.1.1"
+    "scdate": "4.2.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.39.3",