@dereekb/date 9.25.16 → 10.0.0

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

@@ -1,431 +0,0 @@
-import { StringOrder, Maybe, DayOfWeek, DecisionFunction, FilterFunction, IndexRange, EnabledDays, ArrayOrValue, TimezoneString } from '@dereekb/util';
-import { DateBlock, DateBlockDurationSpan, DateBlockIndex, DateBlockRangeOrDateRange, DateBlockRangeWithRange, DateBlocksExpansionFactory, DateBlockTiming, DateBlockTimingStartEndRange, DateBlockTimingRelativeIndexFactoryInput } from './date.block';
-import { DateTimezoneUtcNormalInstance } from './date.timezone';
-import { YearWeekCodeConfig } from './date.week';
-/**
- * @deprecated use DateCellScheduleDayCode instead
- */
-export declare enum DateScheduleDayCode {
-    /**
-     * 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
-}
-/**
- * @deprecated use DateCell implementation instead.
- */
-export declare function fullWeekDayScheduleDayCodes(): DateScheduleDayCode[];
-/**
- * @deprecated use DateCell implementation instead.
- */
-export declare function weekdayDateScheduleDayCodes(): DateScheduleDayCode[];
-/**
- * @deprecated use DateCell implementation instead.
- */
-export declare function weekendDateScheduleDayCodes(): DateScheduleDayCode[];
-/**
- * Creates an EnabledDays from the input.
- *
- * @deprecated use DateCell implementation instead.
- * @param input
- * @returns
- */
-export declare function enabledDaysFromDateScheduleDayCodes(input: Maybe<Iterable<DateScheduleDayCode>>): EnabledDays;
-/**
- * Creates an array of simplified DateScheduleDayCode[] values from the input.
- *
- * @deprecated use DateCell implementation instead.
- * @param input
- * @returns
- */
-export declare function dateScheduleDayCodesFromEnabledDays(input: Maybe<EnabledDays>): DateScheduleDayCode[];
-/**
- * Encoded days of the week that the job block schedule should contain.
- *
- * @deprecated use DateCell implementation instead.
- */
-export declare type DateScheduleEncodedWeek = '' | StringOrder<`${DateScheduleDayCode}`, ''>;
-/**
- * @deprecated use DateCell implementation instead.
- */
-export declare const DATE_SCHEDULE_ENCODED_WEEK_REGEX: RegExp;
-/**
- * Returns true if the input is a DateScheduleEncodedWeek.
- *
- * @deprecated use DateCell implementation instead.
- * @param input
- * @returns
- */
-export declare function isDateScheduleEncodedWeek(input: string): input is DateScheduleEncodedWeek;
-/**
- * Returns true if the input string represents an empty DateScheduleEncodedWeek.
- *
- * @deprecated use DateCell implementation instead.
- * @param input
- * @returns
- */
-export declare function isEmptyDateScheduleEncodedWeek(input: string): input is DateScheduleEncodedWeek;
-/**
- * Creates a DateScheduleEncodedWeek from an array of DateScheduleDayCode values.
- *
- * The returned encoded week is simplified.
- *
- * @deprecated use DateCell implementation instead.
- * @param codes
- */
-export declare function dateScheduleEncodedWeek(codes: Iterable<DateScheduleDayCode>): DateScheduleEncodedWeek;
-/**
- * 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".
- *
- * @deprecated use DateCell implementation instead.
- * @param codes
- * @returns
- */
-export declare function simplifyDateScheduleDayCodes(codes: Iterable<DateScheduleDayCode>): DateScheduleDayCode[];
-/**
- * @deprecated use DateCell implementation instead.
- */
-export declare type DateScheduleDayCodesInput = DateScheduleEncodedWeek | ArrayOrValue<DateScheduleDayCode> | Set<DateScheduleDayCode>;
-/**
- * Expands the input DateScheduleDayCodesInput to a Set of DayOfWeek values.
- *
- * @deprecated use DateCell implementation instead.
- * @param input
- * @returns
- */
-export declare function expandDateScheduleDayCodesToDayOfWeekSet(input: DateScheduleDayCodesInput): Set<DayOfWeek>;
-/**
- *
- * @deprecated use DateCell implementation instead.
- * @param input
- * @returns
- */
-export declare function dateScheduleDayCodesSetFromDaysOfWeek(input: Iterable<DayOfWeek>): Set<DateScheduleDayCode>;
-/**
- * Expands the input into an array of DateScheduleDayCode values.
- *
- * @deprecated use DateCell implementation instead.
- * @param input
- * @returns
- */
-export declare function expandDateScheduleDayCodes(input: DateScheduleDayCodesInput): DateScheduleDayCode[];
-/**
- * Expands the input DateScheduleDayCodesInput to a Set of DayOfWeek values.
- *
- * @deprecated use DateCell implementation instead.
- * @param input
- * @returns
- */
-export declare function expandDateScheduleDayCodesToDayCodesSet(input: DateScheduleDayCodesInput): Set<DateScheduleDayCode>;
-/**
- * Converts the input DateScheduleDayCodesInput to an array of DateScheduleDayCode values, but does not expand
- *
- * @deprecated use DateCell implementation instead.
- * @param input
- * @returns
- */
-export declare function rawDateScheduleDayCodes(input: DateScheduleDayCodesInput): DateScheduleDayCode[];
-/**
- * Used to convert the input dates into a DateScheduleDayCode.
- *
- * @deprecated use DateCell implementation instead.
- */
-export declare type DateScheduleDayCodeFactory = (date: Date) => DateScheduleDayCode;
-/**
- * @deprecated use DateCell implementation instead.
- */
-export declare type DateScheduleDayCodeConfig = Pick<YearWeekCodeConfig, 'timezone'>;
-/**
- * Creates a DateScheduleDayCodeFactory using the optional input config.
- *
- * @deprecated use DateCell implementation instead.
- * @param config
- * @returns
- */
-export declare function dateScheduleDayCodeFactory(config?: DateScheduleDayCodeConfig): DateScheduleDayCodeFactory;
-/**
- * Returns true if the input codes, when expanded, are equivalent.
- *
- * @deprecated use DateCell implementation instead.
- * @param a
- * @param b
- * @returns
- */
-export declare function dateScheduleDayCodesAreSetsEquivalent(a: DateScheduleDayCodesInput, b: DateScheduleDayCodesInput): boolean;
-/**
- * Scheduled used to filter to disable DateBlock values for a job.
- *
- * @deprecated use DateCell implementation instead.
- */
-export interface DateSchedule {
-    /**
-     * Days of the week to include.
-     */
-    w: DateScheduleEncodedWeek;
-    /**
-     * Specific DateBlockIndex values to include.
-     */
-    d?: DateBlockIndex[];
-    /**
-     * Specific DateBlockIndex values to exclude.
-     */
-    ex?: DateBlockIndex[];
-}
-/**
- *
- * @deprecated use DateCell implementation instead.
- * @param a
- * @param b
- * @returns
- */
-export declare function isSameDateSchedule(a: Maybe<DateSchedule>, b: Maybe<DateSchedule>): boolean;
-/**
- *
- * @deprecated use DateCell implementation instead.
- */
-export declare class DateSchedule implements DateSchedule {
-    w: DateScheduleEncodedWeek;
-    d?: DateBlockIndex[];
-    ex?: DateBlockIndex[];
-    constructor(template?: DateSchedule);
-}
-/**
- * A schedule that occurs during a specific range.
- *
- * @deprecated use DateCell implementation instead.
- */
-export interface DateScheduleRange extends DateSchedule, DateBlockTimingStartEndRange {
-}
-/**
- * Returns true if both inputs have the same schedule and date range.
- *
- * @deprecated use DateCell implementation instead.
- * @param a
- * @param b
- * @returns
- */
-export declare function isSameDateScheduleRange(a: Maybe<DateScheduleRange>, b: Maybe<DateScheduleRange>): boolean;
-/**
- * Creates a DateBlockTiming for the input DateScheduleRange.
- *
- * The Timezone the timing is in is recommended. If not provided, may produce incorrect results when dealing with daylight savings time changes.
- *
- * @deprecated use DateCell implementation instead.
- * @param dateScheduleRange
- * @param duration
- * @param startsAtTime
- * @param timezone
- * @returns
- */
-export declare function dateBlockTimingForDateScheduleRange(dateScheduleRange: DateScheduleRange, duration: number, startsAtTime?: Date, timezone?: DateTimezoneUtcNormalInstance | TimezoneString): DateBlockTiming;
-/**
- * DateScheduleDateFilter input.
- *
- * @deprecated use DateCell implementation instead.
- */
-export declare type DateScheduleDateFilterInput = DateBlockTimingRelativeIndexFactoryInput;
-/**
- * Returns true if the date falls within the schedule.
- *
- * @deprecated use DateCell implementation instead.
- */
-export declare type DateScheduleDateFilter = DecisionFunction<DateScheduleDateFilterInput>;
-/**
- * dateScheduleDateFilter() configuration.
- *
- * The input date range is a DateBlockTimingStartEndRange, where the start date is expected to be a DateBlockTimingStart.
- *
- * @deprecated use DateCell implementation instead.
- */
-export interface DateScheduleDateFilterConfig extends DateSchedule, Partial<DateBlockTimingStartEndRange> {
-    minMaxDateRange?: Maybe<Partial<DateBlockRangeOrDateRange>>;
-    /**
-     * 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;
-}
-/**
- *
- * @deprecated use DateCell implementation instead.
- * @param inputFilter
- * @returns
- */
-export declare function copyDateScheduleDateFilterConfig(inputFilter: DateScheduleDateFilterConfig): DateScheduleDateFilterConfig;
-/**
- * Creates a DateScheduleDateFilter.
- *
- * @deprecated use DateCell implementation instead.
- * @param config
- * @returns
- */
-export declare function dateScheduleDateFilter(config: DateScheduleDateFilterConfig): DateScheduleDateFilter;
-/**
- *
- * @deprecated use DateCell implementation instead.
- */
-export declare type DateScheduleDateBlockTimingFilter<B extends DateBlock = DateBlock> = DecisionFunction<B>;
-/**
- * Configuration for dateScheduleDateBlockTimingFilter()
- *
- * @deprecated use DateCell implementation instead.
- */
-export interface DateScheduleDateBlockTimingFilterConfig {
-    /**
-     * Timing to filter with.
-     */
-    timing: DateBlockTiming;
-    /**
-     * Schedule to filter with.
-     */
-    schedule: DateSchedule;
-    /**
-     * 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<DateBlockDurationSpan<DateBlock>>;
-    /**
-     * (Optional) Maximum number of blocks to return.
-     */
-    maxDateBlocksToReturn?: number;
-}
-/**
- * Creates a DateScheduleDateBlockTimingFilter.
- *
- * @deprecated use DateCell implementation instead.
- * @param param0
- * @returns
- */
-export declare function dateScheduleDateBlockTimingFilter<B extends DateBlock = DateBlock>({ timing, schedule }: DateScheduleDateBlockTimingFilterConfig): DateScheduleDateBlockTimingFilter<B>;
-/**
- * Creates a DateBlocksExpansionFactory using the input DateScheduleDateBlockTimingFilterConfig.
- *
- * @deprecated use DateCell implementation instead.
- * @param config
- * @returns
- */
-export declare function expandDateScheduleFactory<B extends DateBlock = DateBlock>(config: DateScheduleDateBlockTimingFilterConfig): DateBlocksExpansionFactory<B>;
-/**
- * @deprecated use DateCell implementation instead.
- */
-export interface ExpandDateScheduleInput extends DateScheduleDateBlockTimingFilterConfig {
-    inputRange?: IndexRange;
-}
-/**
- * Expands the input DateBlockTiming and DateSchedule into an array of DateBlockDurationSpan 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.
- *
- * @deprecated use DateCell implementation instead.
- * @param timing
- * @param schedule
- * @param inputRange
- * @returns
- */
-export declare function expandDateSchedule(input: ExpandDateScheduleInput): DateBlockDurationSpan<DateBlock>[];
-/**
- * Input for ExpandDateScheduleRangeInput
- *
- * @deprecated use DateCell implementation instead.
- */
-export interface ExpandDateScheduleRangeInput extends Omit<DateScheduleDateBlockTimingFilterConfig, 'schedule' | 'timing'> {
-    readonly dateScheduleRange: DateScheduleRange;
-    /**
-     * Duration of the timing.
-     */
-    readonly duration: number;
-    /**
-     * (Optional) Hours/Minutes to copy from. Note, this will modify the timing's end date to be a valid time.
-     */
-    readonly startsAtTime?: Date;
-    /**
-     * (Recommended) Timezone the timing is in. If not provided, may produce incorrect results when dealing with daylight savings time changes.
-     */
-    readonly timezone?: DateTimezoneUtcNormalInstance | TimezoneString;
-}
-/**
- * Creates a DateBlockTiming for the input ExpandDateScheduleRangeInput.
- *
- * @deprecated use DateCell implementation instead.
- * @param input
- * @returns
- */
-export declare function dateBlockTimingForExpandDateScheduleRangeInput(input: ExpandDateScheduleRangeInput): DateBlockTiming;
-/**
- *
- * @deprecated use DateCell implementation instead.
- * @param input
- * @returns
- */
-export declare function expandDateScheduleRange(input: ExpandDateScheduleRangeInput): DateBlockDurationSpan<DateBlock>[];
-/**
- *
- * @deprecated use DateCell implementation instead.
- */
-export declare type ExpandDateScheduleRangeToDateBlockRangeInput = ExpandDateScheduleRangeInput;
-/**
- *
- * @deprecated use DateCell implementation instead.
- * @param input
- * @returns
- */
-export declare function expandDateScheduleRangeToDateBlockRanges(input: ExpandDateScheduleRangeToDateBlockRangeInput): DateBlockRangeWithRange[];
-/**
- * Converts the input DateScheduleDayCodesInput to an array of DateScheduleDayCode values.
- *
- * @param input
- * @returns
- *
- * @deprecated Use expandDateScheduleDayCodes or rawDateScheduleDayCodes depending on the need case.
- */
-export declare const dateScheduleDayCodes: typeof expandDateScheduleDayCodes;
-/**
- * Expands a DateScheduleEncodedWeek to an array of DateScheduleDayCode valeus.
- *
- * @param week
- * @returns
- *
- * @deprecated Use expandDateScheduleDayCodes instead.
- */
-export declare const expandDateScheduleEncodedWeek: typeof expandDateScheduleDayCodes;