@dereekb/date 10.0.12 → 10.0.13

package/index.cjs.js

@@ -5126,20 +5126,59 @@ function expandUniqueDateCellsFunction(config) {
 function dateCellRangeOfTimingFactory(config) {
   const {
     timing,
-    fitToTimingRange = true
+    fitToTimingRange = true,
+    limitToCompletedIndexes: onlyIncludeIfComplete = false,
+    now: inputNowGetter
   } = config;
+  const nowGetter = util.asGetter(inputNowGetter !== null && inputNowGetter !== void 0 ? inputNowGetter : () => new Date());
   const indexFactory = dateCellTimingRelativeIndexFactory(timing);
   const minIndex = fitToTimingRange ? 0 : Number.MIN_SAFE_INTEGER;
   const maxIndex = fitToTimingRange ? indexFactory(indexFactory._timing.end) : Number.MAX_SAFE_INTEGER;
+  let getCurrentMaxIndex;
+  if (onlyIncludeIfComplete) {
+    const timingInfoFactory = dateCellDayTimingInfoFactory({
+      timing
+    });
+    const endAtFactory = dateCellTimingEndDateFactory(timing);
+    let nextExpectedIndexChangeAt;
+    let currentMaxDay;
+    function refreshCurrentInfo() {
+      const now = nowGetter();
+      const currentInfo = timingInfoFactory(now, now);
+      if (fitToTimingRange && currentInfo.isComplete) {
+        // if the timing is complete relative to now, then update to prevent any further updates since the max will not change anymore
+        currentMaxDay = indexFactory(indexFactory._timing.end);
+        getCurrentMaxIndex = () => currentMaxDay;
+      } else {
+        const latestCompletedIndex = currentInfo.isInProgress ? currentInfo.currentIndex - 1 : currentInfo.currentIndex;
+        // calculate the next max change. It occurs whenever the current index ends
+        nextExpectedIndexChangeAt = endAtFactory(latestCompletedIndex + 1);
+        currentMaxDay = fitToTimingRange ? Math.max(latestCompletedIndex, -1) : latestCompletedIndex; // the currentIndex day is not yet complete.
+      }
+    }
+
+    refreshCurrentInfo();
+    getCurrentMaxIndex = () => {
+      const now = nowGetter();
+      if (!dateFns.isBefore(now, nextExpectedIndexChangeAt)) {
+        // refresh since we're expecting the index change
+        refreshCurrentInfo();
+      }
+      return currentMaxDay;
+    };
+  } else {
+    getCurrentMaxIndex = () => maxIndex;
+  }
   return input => {
     const {
       i: start,
       to: end
     } = input;
     const startIndex = indexFactory(start !== null && start !== void 0 ? start : 0);
-    const endIndex = indexFactory(end !== null && end !== void 0 ? end : new Date());
-    const i = Math.max(minIndex, startIndex);
-    const to = Math.min(maxIndex, endIndex);
+    const endIndex = indexFactory(end !== null && end !== void 0 ? end : nowGetter());
+    const maxIndex = getCurrentMaxIndex();
+    const to = Math.min(maxIndex, endIndex); // calculate to first to get the max value
+    const i = Math.min(Math.max(minIndex, startIndex), to); // i should never be greater than to
     return {
       i,
       to
@@ -5319,12 +5358,12 @@ function dateCellDayTimingInfoFactory(config) {
     indexRange,
     inclusiveMaxIndex: false
   });
-  const dayIndexFactory = dateCellTimingRelativeIndexFactory(timing);
+  const indexFactory = dateCellTimingRelativeIndexFactory(timing);
   const dayFactory = dateCellTimingDateFactory(timing);
-  const startsAtFactory = dateCellTimingStartsAtDateFactory(dayIndexFactory);
-  return (input, inputNow) => {
+  const startsAtFactory = dateCellTimingStartsAtDateFactory(indexFactory);
+  const fn = (input, inputNow) => {
     const date = typeof input === 'number' ? dayFactory(input) : input;
-    const dayIndex = dayIndexFactory(input);
+    const dayIndex = indexFactory(input);
     const isInRange = checkIsInRange(dayIndex);
     const now = inputNow !== null && inputNow !== void 0 ? inputNow : date;
     const startsAtOnDay = startsAtFactory(dayIndex); // convert back to the proper date
@@ -5348,9 +5387,13 @@ function dateCellDayTimingInfoFactory(config) {
       startsAtOnDay,
       endsAtOnDay,
       nextIndexInRange,
-      isComplete
+      isComplete,
+      _indexRange: indexRange
     };
   };
+  fn._indexFactory = indexFactory;
+  fn._startsAtFactory = startsAtFactory;
+  return fn;
 }
 /**
  * Returns true if the input is a DateCellTimingRelativeIndexFactory.

package/index.esm.js

@@ -1,4 +1,4 @@
-import { MS_IN_HOUR, MS_IN_MINUTE, MINUTES_IN_DAY, isISO8601DateString, filterMaybeValues, asArray, dayOfWeek, sortNumbersAscendingFunction, SORT_VALUE_LESS_THAN, SORT_VALUE_GREATER_THAN, SORT_VALUE_EQUAL, copyArray, compareFnOrder, groupValues, daysOfWeekArray, MS_IN_DAY, minutesToFractionalHours, UTC_TIMEZONE_STRING, isSameNonNullValue, isConsideredUtcTimezoneString, parseISO8601DayStringToUTCDate, cachedGetter, replaceStringsFunction, sortAscendingIndexNumberRefFunction, range, addToSet, sumOfIntegersBetween, makeValuesGroupMap, lastValue, pushArrayItemsIntoArray, indexRangeCheckFunction, mergeFilterFunctions, isDate as isDate$2, HOURS_IN_DAY, getNextDay, enabledDaysFromDaysOfWeek, daysOfWeekFromEnabledDays, firstValueFromIterable, forEachInIterable, iterablesAreSetEquivalent, invertFilter, mapIdentityFunction, repeatString, HashSet, DATE_NOW_VALUE, roundNumberUpToStep, protectedFactory, MS_IN_SECOND, TimeAM, isLogicalDateStringCode as isLogicalDateStringCode$1, dateFromLogicalDate as dateFromLogicalDate$1, flattenArray, splitJoinRemainder } from '@dereekb/util';
+import { MS_IN_HOUR, MS_IN_MINUTE, MINUTES_IN_DAY, isISO8601DateString, filterMaybeValues, asArray, dayOfWeek, sortNumbersAscendingFunction, SORT_VALUE_LESS_THAN, SORT_VALUE_GREATER_THAN, SORT_VALUE_EQUAL, copyArray, compareFnOrder, groupValues, daysOfWeekArray, MS_IN_DAY, minutesToFractionalHours, UTC_TIMEZONE_STRING, isSameNonNullValue, isConsideredUtcTimezoneString, parseISO8601DayStringToUTCDate, cachedGetter, replaceStringsFunction, sortAscendingIndexNumberRefFunction, range, addToSet, sumOfIntegersBetween, makeValuesGroupMap, lastValue, pushArrayItemsIntoArray, asGetter, indexRangeCheckFunction, mergeFilterFunctions, isDate as isDate$2, HOURS_IN_DAY, getNextDay, enabledDaysFromDaysOfWeek, daysOfWeekFromEnabledDays, firstValueFromIterable, forEachInIterable, iterablesAreSetEquivalent, invertFilter, mapIdentityFunction, repeatString, HashSet, DATE_NOW_VALUE, roundNumberUpToStep, protectedFactory, MS_IN_SECOND, TimeAM, isLogicalDateStringCode as isLogicalDateStringCode$1, dateFromLogicalDate as dateFromLogicalDate$1, flattenArray, splitJoinRemainder } from '@dereekb/util';
 import { isDate as isDate$1, startOfMinute, isValid, parseISO, min as min$5, max as max$2, isAfter as isAfter$1, isEqual, isSameDay, isPast, addDays, set as set$1, differenceInDays, startOfMonth, endOfWeek, startOfWeek, endOfMonth, addHours, addMinutes, isBefore, addMilliseconds, startOfDay, addMonths, addWeeks, endOfDay, endOfHour, startOfHour, endOfMinute, minutesToHours, getMinutes, getSeconds, getMilliseconds, differenceInMilliseconds, differenceInHours, getWeek, getYear, setWeek, getDay, formatDistanceStrict, formatDistance, format, differenceInMinutes, formatDistanceToNow, parse, addSeconds } from 'date-fns';
 import { Expose, Type, Exclude } from 'class-transformer';
 import { IsDate, IsEnum, IsOptional, IsNumber, Min, registerDecorator, IsString, Matches, IsArray, IsBoolean } from 'class-validator';
@@ -5636,20 +5636,61 @@ function expandUniqueDateCellsFunction(config) {
 function dateCellRangeOfTimingFactory(config) {
   const {
     timing,
-    fitToTimingRange = true
+    fitToTimingRange = true,
+    limitToCompletedIndexes: onlyIncludeIfComplete = false,
+    now: inputNowGetter
   } = config;
+  const nowGetter = asGetter(inputNowGetter != null ? inputNowGetter : () => new Date());
   const indexFactory = dateCellTimingRelativeIndexFactory(timing);
   const minIndex = fitToTimingRange ? 0 : Number.MIN_SAFE_INTEGER;
   const maxIndex = fitToTimingRange ? indexFactory(indexFactory._timing.end) : Number.MAX_SAFE_INTEGER;
+  let getCurrentMaxIndex;
+  if (onlyIncludeIfComplete) {
+    const timingInfoFactory = dateCellDayTimingInfoFactory({
+      timing
+    });
+    const endAtFactory = dateCellTimingEndDateFactory(timing);
+    let nextExpectedIndexChangeAt;
+    let currentMaxDay;
+    function refreshCurrentInfo() {
+      const now = nowGetter();
+      const currentInfo = timingInfoFactory(now, now);
+      if (fitToTimingRange && currentInfo.isComplete) {
+        // if the timing is complete relative to now, then update to prevent any further updates since the max will not change anymore
+        currentMaxDay = indexFactory(indexFactory._timing.end);
+        getCurrentMaxIndex = () => currentMaxDay;
+      } else {
+        const latestCompletedIndex = currentInfo.isInProgress ? currentInfo.currentIndex - 1 : currentInfo.currentIndex;
+
+        // calculate the next max change. It occurs whenever the current index ends
+        nextExpectedIndexChangeAt = endAtFactory(latestCompletedIndex + 1);
+        currentMaxDay = fitToTimingRange ? Math.max(latestCompletedIndex, -1) : latestCompletedIndex; // the currentIndex day is not yet complete.
+      }
+    }
+
+    refreshCurrentInfo();
+    getCurrentMaxIndex = () => {
+      const now = nowGetter();
+      if (!isBefore(now, nextExpectedIndexChangeAt)) {
+        // refresh since we're expecting the index change
+        refreshCurrentInfo();
+      }
+      return currentMaxDay;
+    };
+  } else {
+    getCurrentMaxIndex = () => maxIndex;
+  }
   return input => {
     const {
       i: start,
       to: end
     } = input;
     const startIndex = indexFactory(start != null ? start : 0);
-    const endIndex = indexFactory(end != null ? end : new Date());
-    const i = Math.max(minIndex, startIndex);
-    const to = Math.min(maxIndex, endIndex);
+    const endIndex = indexFactory(end != null ? end : nowGetter());
+    const maxIndex = getCurrentMaxIndex();
+    const to = Math.min(maxIndex, endIndex); // calculate to first to get the max value
+    const i = Math.min(Math.max(minIndex, startIndex), to); // i should never be greater than to
+
     return {
       i,
       to
@@ -5858,12 +5899,12 @@ function dateCellDayTimingInfoFactory(config) {
     indexRange,
     inclusiveMaxIndex: false
   });
-  const dayIndexFactory = dateCellTimingRelativeIndexFactory(timing);
+  const indexFactory = dateCellTimingRelativeIndexFactory(timing);
   const dayFactory = dateCellTimingDateFactory(timing);
-  const startsAtFactory = dateCellTimingStartsAtDateFactory(dayIndexFactory);
-  return (input, inputNow) => {
+  const startsAtFactory = dateCellTimingStartsAtDateFactory(indexFactory);
+  const fn = (input, inputNow) => {
     const date = typeof input === 'number' ? dayFactory(input) : input;
-    const dayIndex = dayIndexFactory(input);
+    const dayIndex = indexFactory(input);
     const isInRange = checkIsInRange(dayIndex);
     const now = inputNow != null ? inputNow : date;
     const startsAtOnDay = startsAtFactory(dayIndex); // convert back to the proper date
@@ -5888,9 +5929,13 @@ function dateCellDayTimingInfoFactory(config) {
       startsAtOnDay,
       endsAtOnDay,
       nextIndexInRange,
-      isComplete
+      isComplete,
+      _indexRange: indexRange
     };
   };
+  fn._indexFactory = indexFactory;
+  fn._startsAtFactory = startsAtFactory;
+  return fn;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/date",
-  "version": "10.0.12",
+  "version": "10.0.13",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

package/src/lib/date/date.cell.factory.d.ts

@@ -1,4 +1,4 @@
-import { type Maybe, type ArrayOrValue, type FilterFunction, type IndexRange, type ISO8601DayString, type IndexNumber } from '@dereekb/util';
+import { type Maybe, type ArrayOrValue, type FilterFunction, type IndexRange, type ISO8601DayString, type IndexNumber, type GetterOrValue } from '@dereekb/util';
 import { type DateCell, type DateCellIndex, type DateOrDateCellIndex, type DateCellTiming, type DateCellArrayRef, type DateCellArray, type DateCellTimingRangeInput, type DateCellCollection, type DateCellDurationSpan, type DateCellTimingStartsAt, type DateCellTimingEvent, type DateCellTimingStartsAtEndRange, type FullDateCellTiming } from './date.cell';
 import { type DateCellRange, type DateCellRangeWithRange, type DateOrDateRangeOrDateCellIndexOrDateCellRange } from './date.cell.index';
 import { type DateRange, type DateRangeStart } from './date.range';
@@ -17,6 +17,18 @@ export interface DateCallIndexRangeFromDatesFactoryConfig {
      * Defaults to true.
      */
     readonly fitToTimingRange?: boolean;
+    /**
+     * Only include the index if the timing is marked as complete for that index.
+     *
+     * If no indexes have been completed, the returned value range will be -1 to -1.
+     *
+     * Defaults to false.
+     */
+    readonly limitToCompletedIndexes?: boolean;
+    /**
+     * (Optional) now date/getter used to influence the limitToCompletedIndexes calculations.
+     */
+    readonly now?: GetterOrValue<Date>;
 }
 /**
  * DateCellRangeOfTimingFactory input
@@ -25,11 +37,11 @@ export interface DateCellRangeOfTimingInput {
     /**
      * Start date or index
      */
-    readonly i?: DateOrDateCellIndex;
+    readonly i?: Maybe<DateOrDateCellIndex>;
     /**
      * End date or index
      */
-    readonly to?: DateOrDateCellIndex;
+    readonly to?: Maybe<DateOrDateCellIndex>;
 }
 /**
  * Creates a DateCellRange from the input.
@@ -192,7 +204,10 @@ export interface DateCellDayTimingInfo {
  *
  * Can optionally specify a now that is used for checking the inProgress functionality.
  */
-export type DateCellDayTimingInfoFactory = (date: DateOrDateCellIndex, now?: Date) => DateCellDayTimingInfo;
+export type DateCellDayTimingInfoFactory = ((date: DateOrDateCellIndex, now?: Date) => DateCellDayTimingInfo) & {
+    readonly _indexFactory: DateCellTimingRelativeIndexFactory;
+    readonly _startsAtFactory: DateCellTimingStartsAtDateFactory;
+};
 export declare function dateCellDayTimingInfoFactory(config: DateCellDayTimingInfoFactoryConfig): DateCellDayTimingInfoFactory;
 /**
  * DateCellTimingRelativeIndexFactory input. Can be a Date, DateCellIndex, or ISO8601DayString