@dereekb/date 9.24.46 → 9.25.0

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

@@ -0,0 +1,409 @@
+import { DateRange } from '@dereekb/date';
+import { StringOrder, Maybe, DayOfWeek, DecisionFunction, FilterFunction, IndexRange, EnabledDays, ArrayOrValue, TimezoneStringRef } from '@dereekb/util';
+import { DateCell, DateCellDurationSpan, DateCellIndex, DateCellTiming, DateCellTimingDateRange, DateCellTimingStartsAtEndRange, FullDateCellTiming, DateCellTimingEventStartsAt } from './date.cell';
+import { DateCellTimingRelativeIndexFactoryInput, DateCellTimingExpansionFactory } from './date.cell.factory';
+import { DateCellRangeOrDateRange, DateCellRangeWithRange } from './date.cell.index';
+import { YearWeekCodeConfig } from './date.week';
+export declare enum DateCellScheduleDayCode {
+    /**
+     * Special no-op/unused code
+     */
+    NONE = 0,
+    SUNDAY = 1,
+    MONDAY = 2,
+    TUESDAY = 3,
+    WEDNESDAY = 4,
+    THURSDAY = 5,
+    FRIDAY = 6,
+    SATURDAY = 7,
+    /**
+     * All weekdays (Mon-Fri)
+     */
+    WEEKDAY = 8,
+    /**
+     * All weekend days (Sat/Sun)
+     */
+    WEEKEND = 9
+}
+export declare function fullWeekDateCellScheduleDayCodes(): DateCellScheduleDayCode[];
+export declare function weekdayDateCellScheduleDayCodes(): DateCellScheduleDayCode[];
+export declare function weekendDateCellScheduleDayCodes(): DateCellScheduleDayCode[];
+/**
+ * Creates an EnabledDays from the input.
+ *
+ * @param input
+ * @returns
+ */
+export declare function enabledDaysFromDateCellScheduleDayCodes(input: Maybe<Iterable<DateCellScheduleDayCode>>): EnabledDays;
+/**
+ * Creates an array of simplified DateCellScheduleDayCode[] values from the input.
+ *
+ * @param input
+ * @returns
+ */
+export declare function dateCellScheduleDayCodesFromEnabledDays(input: Maybe<EnabledDays>): DateCellScheduleDayCode[];
+/**
+ * Encoded days of the week that the job block schedule should contain.
+ */
+export declare type DateCellScheduleEncodedWeek = '' | StringOrder<`${DateCellScheduleDayCode}`, ''>;
+export declare const DATE_CELL_SCHEDULE_ENCODED_WEEK_REGEX: RegExp;
+/**
+ * Returns true if the input is a DateCellScheduleEncodedWeek.
+ *
+ * @param input
+ * @returns
+ */
+export declare function isDateCellScheduleEncodedWeek(input: string): input is DateCellScheduleEncodedWeek;
+/**
+ * Returns true if the input string represents an empty DateCellScheduleEncodedWeek.
+ *
+ * @param input
+ * @returns
+ */
+export declare function isEmptyDateCellScheduleEncodedWeek(input: string): input is DateCellScheduleEncodedWeek;
+/**
+ * Creates a DateCellScheduleEncodedWeek from an array of DateCellScheduleDayCode values.
+ *
+ * The returned encoded week is simplified.
+ *
+ * @param codes
+ */
+export declare function dateCellScheduleEncodedWeek(codes: Iterable<DateCellScheduleDayCode>): DateCellScheduleEncodedWeek;
+/**
+ * Reduces/merges any day codes into more simplified day codes.
+ *
+ * For instance, if all days of the week are selected, they will be reduced to "8".
+ *
+ * @param codes
+ * @returns
+ */
+export declare function simplifyDateCellScheduleDayCodes(codes: Iterable<DateCellScheduleDayCode>): DateCellScheduleDayCode[];
+export declare type DateCellScheduleDayCodesInput = DateCellScheduleEncodedWeek | ArrayOrValue<DateCellScheduleDayCode> | Set<DateCellScheduleDayCode>;
+/**
+ * Expands the input DateCellScheduleDayCodesInput to a Set of DayOfWeek values.
+ *
+ * @param input
+ * @returns
+ */
+export declare function expandDateCellScheduleDayCodesToDayOfWeekSet(input: DateCellScheduleDayCodesInput): Set<DayOfWeek>;
+export declare function dateCellScheduleDayCodesSetFromDaysOfWeek(input: Iterable<DayOfWeek>): Set<DateCellScheduleDayCode>;
+/**
+ * Expands the input into an array of DateCellScheduleDayCode values.
+ *
+ * @param input
+ * @returns
+ */
+export declare function expandDateCellScheduleDayCodes(input: DateCellScheduleDayCodesInput): DateCellScheduleDayCode[];
+/**
+ * Expands the input DateCellScheduleDayCodesInput to a Set of DayOfWeek values.
+ *
+ * @param input
+ * @returns
+ */
+export declare function expandDateCellScheduleDayCodesToDayCodesSet(input: DateCellScheduleDayCodesInput): Set<DateCellScheduleDayCode>;
+/**
+ * Converts the input DateCellScheduleDayCodesInput to an array of DateCellScheduleDayCode values, but does not expand
+ *
+ * @param input
+ * @returns
+ */
+export declare function rawDateCellScheduleDayCodes(input: DateCellScheduleDayCodesInput): DateCellScheduleDayCode[];
+/**
+ * Used to convert the input dates into a DateCellScheduleDayCode.
+ */
+export declare type DateCellScheduleDayCodeFactory = (date: Date) => DateCellScheduleDayCode;
+export declare type DateCellScheduleDayCodeConfig = Pick<YearWeekCodeConfig, 'timezone'>;
+/**
+ * Creates a DateCellScheduleDayCodeFactory using the optional input config.
+ *
+ * @param config
+ * @returns
+ */
+export declare function dateCellScheduleDayCodeFactory(config?: DateCellScheduleDayCodeConfig): DateCellScheduleDayCodeFactory;
+/**
+ * Returns true if the input codes, when expanded, are equivalent.
+ *
+ * @param a
+ * @param b
+ * @returns
+ */
+export declare function dateCellScheduleDayCodesAreSetsEquivalent(a: DateCellScheduleDayCodesInput, b: DateCellScheduleDayCodesInput): boolean;
+/**
+ * Scheduled used to filter to disable DateCell values for a job.
+ */
+export interface DateCellSchedule {
+    /**
+     * Days of the week to include.
+     */
+    w: DateCellScheduleEncodedWeek;
+    /**
+     * Specific DateCellIndex values to include.
+     */
+    d?: DateCellIndex[];
+    /**
+     * Specific DateCellIndex values to exclude.
+     */
+    ex?: DateCellIndex[];
+}
+/**
+ * Returns true if the input is a DateCellSchedule.
+ *
+ * @param input
+ * @returns
+ */
+export declare function isDateCellSchedule(input: object): input is DateCellSchedule;
+export declare function isSameDateCellSchedule(a: Maybe<DateCellSchedule>, b: Maybe<DateCellSchedule>): boolean;
+export declare class DateCellSchedule implements DateCellSchedule {
+    w: DateCellScheduleEncodedWeek;
+    d?: DateCellIndex[];
+    ex?: DateCellIndex[];
+    constructor(template?: DateCellSchedule);
+}
+/**
+ * A DateCellSchedule with a DateRange that signifies and end days.
+ */
+export interface DateCellScheduleDateRange extends DateCellSchedule, DateCellTimingDateRange {
+}
+/**
+ * A special DateCellScheduleDateRange that has both the start and end times at the start of the day in the target timezone for their given ranges.
+ */
+export declare type DateCellScheduleStartOfDayDateRange = DateCellScheduleDateRange;
+/**
+ * Returns true if the input is possibly a FullDateCellScheduleRange.
+ *
+ * Does not check that the input is a valid FullDateCellScheduleRange.
+ *
+ * @param input
+ * @returns
+ */
+export declare function isDateCellScheduleDateRange(input: object): input is DateCellScheduleDateRange;
+/**
+ * Returns true if the input is a DateCellScheduleDateRange without a duration or startsAt.
+ *
+ * @param input
+ * @returns
+ */
+export declare function isDateCellScheduleStartOfDayDateRange(input: object): input is DateCellScheduleStartOfDayDateRange;
+/**
+ * Returns true if both inputs have the same schedule and date range.
+ *
+ * @param a
+ * @param b
+ * @returns
+ */
+export declare function isSameDateCellScheduleDateRange(a: Maybe<DateCellScheduleDateRange>, b: Maybe<DateCellScheduleDateRange>): boolean;
+/**
+ * Input for dateCellScheduleDateRange().
+ *
+ * It should be comprised of parts of a valid DateCellScheduleDateRange already. This means the start/end or startsAt/end is valid and for the given timezone.
+ *
+ * Invalid input has undetermined behavior.
+ */
+export declare type DateCellScheduleDateRangeInput = DateCellSchedule & Partial<TimezoneStringRef & (DateRange | DateCellTimingStartsAtEndRange)>;
+/**
+ * Creates a DateCellScheduleDateRange from the input.
+ *
+ * @param input
+ * @returns
+ */
+export declare function dateCellScheduleDateRange(input: DateCellScheduleDateRangeInput): DateCellScheduleDateRange;
+/**
+ * A DateCellScheduleDateRange that also includes the event's startsAt time.
+ */
+export interface DateCellScheduleEventRange extends DateCellScheduleDateRange, DateCellTimingEventStartsAt {
+}
+/**
+ * Returns true if both inputs have the same FullDateCellScheduleRange.
+ *
+ * @param a
+ * @param b
+ * @returns
+ */
+export declare function isSameDateCellScheduleEventRange(a: Maybe<DateCellScheduleEventRange>, b: Maybe<DateCellScheduleEventRange>): boolean;
+/**
+ * A DateCellScheduleEventRange that includes the duration and implements FullDateCellTiming.
+ */
+export interface FullDateCellScheduleRange extends DateCellScheduleEventRange, FullDateCellTiming {
+}
+/**
+ * Returns true if the input is possibly a FullDateCellScheduleRange.
+ *
+ * Does not check that the input is a valid FullDateCellScheduleRange.
+ *
+ * @param input
+ * @returns
+ */
+export declare function isFullDateCellScheduleDateRange(input: object): input is FullDateCellScheduleRange;
+/**
+ * Returns true if both inputs have the same FullDateCellScheduleRange.
+ *
+ * @param a
+ * @param b
+ * @returns
+ */
+export declare function isSameFullDateCellScheduleDateRange(a: Maybe<FullDateCellScheduleRange>, b: Maybe<FullDateCellScheduleRange>): boolean;
+/**
+ * Different types of inputs for fullDateCellScheduleRange() that can be used to derive a FullDateCellScheduleRange.
+ */
+export declare type FullDateCellScheduleRangeInputDateRange = DateCellScheduleDateRange | DateCellScheduleEventRange | FullDateCellScheduleRange | DateCellScheduleDateRangeInput;
+export interface FullDateCellScheduleRangeInput {
+    /**
+     * Input schedule range to expand from.
+     */
+    readonly dateCellScheduleRange: FullDateCellScheduleRangeInputDateRange;
+    /**
+     * (Optional) Duration of the timing to use.
+     *
+     * If a duration is provided in the timing, this is ignored unless updateWithDefaults is true.
+     */
+    readonly duration?: number;
+    /**
+     * (Optional) Hours/Minutes to copy from when setting the inital startsAt.
+     *
+     * This will not change the timing's start/end date range, but it will update the end date.
+     *
+     * If a startsAt is provided in the timing, this is ignored unless updateWithDefaults is true.
+     */
+    readonly startsAtTime?: Date;
+    /**
+     * Whether or not to always update the range with the default duration/startsAt time
+     */
+    readonly updateWithDefaults?: boolean;
+}
+/**
+ * If a duration is not set, this is the default used.
+ */
+export declare const DEFAULT_FULL_DATE_SCHEDULE_RANGE_DURATION = 1;
+/**
+ * Creates a FullDateCellScheduleRange from the input.
+ */
+export declare function fullDateCellScheduleRange(input: FullDateCellScheduleRangeInput): FullDateCellScheduleRange;
+/**
+ * DateCellScheduleDateFilter input.
+ */
+export declare type DateCellScheduleDateFilterInput = DateCellTimingRelativeIndexFactoryInput;
+/**
+ * Returns true if the date falls within the schedule.
+ */
+export declare type DateCellScheduleDateFilter = DecisionFunction<DateCellScheduleDateFilterInput>;
+/**
+ * dateCellScheduleDateFilter() configuration.
+ */
+export interface DateCellScheduleDateFilterConfig extends DateCellSchedule, Partial<DateCellTimingStartsAtEndRange & DateCellTimingDateRange> {
+    minMaxDateRange?: Maybe<Partial<DateCellRangeOrDateRange>>;
+    /**
+     * Whether or not to restrict the start as the min date if a min date is not set in minMaxDateRange. True by default.
+     */
+    setStartAsMinDate?: boolean;
+}
+export declare function copyDateCellScheduleDateFilterConfig(inputFilter: DateCellScheduleDateFilterConfig): DateCellScheduleDateFilterConfig;
+/**
+ * Creates a DateCellScheduleDateFilter.
+ *
+ * @param config
+ * @returns
+ */
+export declare function dateCellScheduleDateFilter(config: DateCellScheduleDateFilterConfig): DateCellScheduleDateFilter;
+export declare type DateCellScheduleDateCellTimingFilter<B extends DateCell = DateCell> = DecisionFunction<B>;
+/**
+ * Configuration for dateCellScheduleDateCellTimingFilter()
+ */
+export interface DateCellScheduleDateCellTimingFilterConfig {
+    /**
+     * Timing to filter with.
+     */
+    timing: DateCellTiming;
+    /**
+     * Schedule to filter with.
+     */
+    schedule: DateCellSchedule;
+    /**
+     * Wether or not to expand on the inverse of the schedule, returning blocks that are not in the schedule.
+     *
+     * Other date filtering behaves the same (I.E. onlyBlocksNotYetStarted, etc.)
+     */
+    invertSchedule?: boolean;
+    /**
+     * (Optional) date to use when filtering from now.
+     */
+    now?: Date;
+    /**
+     * (Optional) filters in blocks that have not yet started. Can be combined with the other filters.
+     */
+    onlyBlocksThatHaveStarted?: boolean;
+    /**
+     * (Optional) filters in blocks that have not yet ended. Can be combined with the other filters.
+     */
+    onlyBlocksThatHaveEnded?: boolean;
+    /**
+     * (Optional) filters in blocks that have not yet started. Can be combined with the other filters.
+     */
+    onlyBlocksNotYetStarted?: boolean;
+    /**
+     * (Optional) filters in blocks that have not yet ended. Can be combined with the other filters.
+     */
+    onlyBlocksNotYetEnded?: boolean;
+    /**
+     * (Optional) custom filter function. Can be combined with the other filters.
+     */
+    durationSpanFilter?: FilterFunction<DateCellDurationSpan<DateCell>>;
+    /**
+     * (Optional) Maximum number of blocks to return.
+     */
+    maxDateCellsToReturn?: number;
+}
+/**
+ * Creates a DateCellScheduleDateCellTimingFilter.
+ *
+ * @param param0
+ * @returns
+ */
+export declare function dateCellScheduleDateCellTimingFilter<B extends DateCell = DateCell>({ timing, schedule }: DateCellScheduleDateCellTimingFilterConfig): DateCellScheduleDateCellTimingFilter<B>;
+/**
+ * Creates a DateCellTimingExpansionFactory using the input DateCellScheduleDateCellTimingFilterConfig.
+ *
+ * @param config
+ * @returns
+ */
+export declare function expandDateCellScheduleFactory<B extends DateCell = DateCell>(config: DateCellScheduleDateCellTimingFilterConfig): DateCellTimingExpansionFactory<B>;
+export interface ExpandDateCellScheduleInput extends DateCellScheduleDateCellTimingFilterConfig {
+    /**
+     * Index range to limit the expansion to.
+     */
+    readonly limitIndexRange?: IndexRange;
+}
+/**
+ * Expands the input DateCellTiming and DateCellSchedule into an array of DateCellDurationSpan value that correspond with blocks in the event.
+ *
+ * Can optionally provide an IndexRange to specify a specific range to filter on. The range will be capped to the range of the timing.
+ *
+ * @param timing
+ * @param schedule
+ * @param inputRange
+ * @returns
+ */
+export declare function expandDateCellSchedule(input: ExpandDateCellScheduleInput): DateCellDurationSpan<DateCell>[];
+/**
+ * Input for ExpandDateCellScheduleRangeInput
+ */
+export interface ExpandDateCellScheduleRangeInput extends Omit<DateCellScheduleDateCellTimingFilterConfig, 'schedule' | 'timing'> {
+    readonly dateCellScheduleRange: FullDateCellScheduleRangeInputDateRange;
+    /**
+     * (Optional) Duration of the timing to replace the dateCellScheduleRange's duration.
+     */
+    readonly duration?: number;
+    /**
+     * (Optional) Hours/Minutes to replace the dateCellScheduleRange's startsAt time.
+     *
+     * Note, this will modify the timing's end date to be a valid time.
+     */
+    readonly startsAtTime?: Date;
+}
+/**
+ *
+ * @param input
+ * @returns
+ */
+export declare function expandDateCellScheduleRange(input: ExpandDateCellScheduleRangeInput): DateCellDurationSpan<DateCell>[];
+export declare type ExpandDateCellScheduleRangeToDateCellRangeInput = ExpandDateCellScheduleRangeInput;
+export declare function expandDateCellScheduleRangeToDateCellRanges(input: ExpandDateCellScheduleRangeToDateCellRangeInput): DateCellRangeWithRange[];

package/src/lib/date/date.cell.schedule.day.d.ts

@@ -0,0 +1,9 @@
+import { DateCellIndex } from './date.cell';
+import { DateCellScheduleDayCodesInput } from './date.cell.schedule';
+/**
+ * Converts the input day codes into DateCellIndex values.
+ *
+ * @param dayCodes
+ * @returns
+ */
+export declare function dateCellIndexsForDateCellScheduleDayCodes(sundayIndex: DateCellIndex, dayCodes: DateCellScheduleDayCodesInput): DateCellIndex[];

package/src/lib/date/date.cell.schedule.day.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dateCellIndexsForDateCellScheduleDayCodes = void 0;
+const date_cell_schedule_1 = require("./date.cell.schedule");
+/**
+ * Converts the input day codes into DateCellIndex values.
+ *
+ * @param dayCodes
+ * @returns
+ */
+function dateCellIndexsForDateCellScheduleDayCodes(sundayIndex, dayCodes) {
+    return (0, date_cell_schedule_1.expandDateCellScheduleDayCodes)(dayCodes).map((x) => sundayIndex + x - 1);
+}
+exports.dateCellIndexsForDateCellScheduleDayCodes = dateCellIndexsForDateCellScheduleDayCodes;
+//# sourceMappingURL=date.cell.schedule.day.js.map

package/src/lib/date/date.cell.schedule.day.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"date.cell.schedule.day.js","sourceRoot":"","sources":["../../../../../../packages/date/src/lib/date/date.cell.schedule.day.ts"],"names":[],"mappings":";;;AACA,6DAAqG;AAErG;;;;;GAKG;AACH,SAAgB,yCAAyC,CAAC,WAA0B,EAAE,QAAuC;IAC3H,OAAO,IAAA,mDAA8B,EAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;AAClF,CAAC;AAFD,8FAEC"}