@full-ui/headless-calendar 7.0.0-beta.5

package/esm/index.d.ts

@@ -0,0 +1,284 @@
+type DurationInput = DurationObjectInput | string | number;
+interface DurationObjectInput {
+    years?: number;
+    year?: number;
+    months?: number;
+    month?: number;
+    weeks?: number;
+    week?: number;
+    days?: number;
+    day?: number;
+    hours?: number;
+    hour?: number;
+    minutes?: number;
+    minute?: number;
+    seconds?: number;
+    second?: number;
+    milliseconds?: number;
+    millisecond?: number;
+    ms?: number;
+}
+interface Duration {
+    years: number;
+    months: number;
+    days: number;
+    milliseconds: number;
+    specifiedWeeks?: boolean;
+}
+declare function createDuration(input: DurationInput, unit?: string): Duration | null;
+declare function durationsEqual(d0: Duration, d1: Duration): boolean;
+declare function asCleanDays(dur: Duration): number;
+declare function addDurations(d0: Duration, d1: Duration): {
+    years: number;
+    months: number;
+    days: number;
+    milliseconds: number;
+};
+declare function subtractDurations(d1: Duration, d0: Duration): Duration;
+declare function multiplyDuration(d: Duration, n: number): {
+    years: number;
+    months: number;
+    days: number;
+    milliseconds: number;
+};
+declare function asRoughYears(dur: Duration): number;
+declare function asRoughMonths(dur: Duration): number;
+declare function asRoughDays(dur: Duration): number;
+declare function asRoughHours(dur: Duration): number;
+declare function asRoughMinutes(dur: Duration): number;
+declare function asRoughSeconds(dur: Duration): number;
+declare function asRoughMs(dur: Duration): number;
+declare function wholeDivideDurations(numerator: Duration, denominator: Duration): number;
+declare function greatestDurationDenominator(dur: Duration): {
+    unit: string;
+    value: number;
+};
+
+type DateMarker = Date;
+declare function addWeeks(m: DateMarker, n: number): Date;
+declare function addDays(m: DateMarker, n: number): Date;
+declare function addMs(m: DateMarker, n: number): Date;
+declare function diffWeeks(m0: any, m1: any): number;
+declare function diffDays(m0: any, m1: any): number;
+declare function diffHours(m0: any, m1: any): number;
+declare function diffMinutes(m0: any, m1: any): number;
+declare function diffSeconds(m0: any, m1: any): number;
+declare function diffDayAndTime(m0: DateMarker, m1: DateMarker): Duration;
+declare function diffWholeWeeks(m0: DateMarker, m1: DateMarker): number;
+declare function diffWholeDays(m0: DateMarker, m1: DateMarker): number;
+declare function startOfDay(m: DateMarker): DateMarker;
+declare function startOfHour(m: DateMarker): Date;
+declare function startOfMinute(m: DateMarker): Date;
+declare function startOfSecond(m: DateMarker): Date;
+declare function weekOfYear(marker: any, dow: any, doy: any): number;
+declare function dateToLocalArray(date: any): any[];
+declare function arrayToLocalDate(a: any): Date;
+declare function dateToUtcArray(date: any): any[];
+declare function arrayToUtcDate(a: any): Date;
+declare function isValidDate(m: DateMarker): boolean;
+declare function timeAsMs(m: DateMarker): number;
+
+interface CalendarSystem {
+    getMarkerYear(d: DateMarker): number;
+    getMarkerMonth(d: DateMarker): number;
+    getMarkerDay(d: DateMarker): number;
+    arrayToMarker(arr: number[]): DateMarker;
+    markerToArray(d: DateMarker): number[];
+}
+declare function registerCalendarSystem(name: any, theClass: any): void;
+declare function createCalendarSystem(name: any): any;
+
+type LocaleCodeArg = string | string[];
+interface Locale {
+    codeArg: LocaleCodeArg;
+    codes: string[];
+    week: {
+        dow: number;
+        doy: number;
+    };
+    simpleNumberFormat: Intl.NumberFormat;
+    options: any;
+}
+
+declare abstract class NamedTimeZoneImpl {
+    timeZoneName: string;
+    constructor(timeZoneName: string);
+    abstract offsetForArray(a: number[]): number;
+    abstract timestampToArray(ms: number): number[];
+}
+type NamedTimeZoneImplClass = {
+    new (timeZoneName: string): NamedTimeZoneImpl;
+};
+
+interface ZonedMarker {
+    marker: DateMarker;
+    timeZoneOffset: number;
+}
+interface ExpandedZonedMarker extends ZonedMarker {
+    array: number[];
+    year: number;
+    month: number;
+    day: number;
+    hour: number;
+    minute: number;
+    second: number;
+    millisecond: number;
+}
+declare function expandZonedMarker(dateInfo: ZonedMarker, calendarSystem: CalendarSystem): ExpandedZonedMarker;
+
+interface VerboseFormattingData {
+    date: ExpandedZonedMarker;
+    start: ExpandedZonedMarker;
+    end?: ExpandedZonedMarker;
+    timeZone: string;
+    localeCodes: string[];
+    defaultSeparator: string;
+}
+declare function createVerboseFormattingArg(start: ZonedMarker, end: ZonedMarker, context: DateFormattingContext, betterDefaultSeparator?: string): VerboseFormattingData;
+type CmdFormatterFunc = (cmd: string, data: VerboseFormattingData) => string | Intl.DateTimeFormatPart[];
+interface DateFormattingContext {
+    timeZone: string;
+    locale: Locale;
+    calendarSystem: CalendarSystem;
+    computeWeekNumber: (d: DateMarker) => number;
+    weekText: string;
+    weekTextShort: string;
+    cmdFormatter?: CmdFormatterFunc;
+    defaultSeparator: string;
+}
+interface DateFormatter {
+    format(date: ZonedMarker, context: DateFormattingContext): [string, Intl.DateTimeFormatPart[]];
+    formatRange(start: ZonedMarker, end: ZonedMarker, context: DateFormattingContext, betterDefaultSeparator?: string): string;
+}
+
+type WeekNumberCalculation = 'local' | 'ISO' | ((m: Date) => number);
+interface DateEnvSettings {
+    timeZone: string;
+    namedTimeZoneImpl?: NamedTimeZoneImplClass;
+    calendarSystem: string;
+    locale: Locale;
+    weekNumberCalculation?: WeekNumberCalculation;
+    firstDay?: number;
+    weekText?: string;
+    weekTextShort?: string;
+    cmdFormatter?: CmdFormatterFunc;
+    defaultSeparator?: string;
+}
+type DateInput = Date | string | number | number[];
+interface DateMarkerMeta {
+    marker: DateMarker;
+    isTimeUnspecified: boolean;
+    forcedTzo: number | null;
+}
+declare class DateEnv {
+    timeZone: string;
+    namedTimeZoneImpl: NamedTimeZoneImpl;
+    canComputeOffset: boolean;
+    calendarSystem: CalendarSystem;
+    locale: Locale;
+    weekDow: number;
+    weekDoy: number;
+    weekNumberFunc: any;
+    weekText: string;
+    weekTextShort: string;
+    cmdFormatter?: CmdFormatterFunc;
+    defaultSeparator: string;
+    constructor(settings: DateEnvSettings);
+    createMarker(input: DateInput): DateMarker;
+    createNowMarker(): DateMarker;
+    createMarkerMeta(input: DateInput): DateMarkerMeta;
+    parse(s: string): {
+        marker: Date;
+        isTimeUnspecified: boolean;
+        forcedTzo: any;
+    };
+    getYear(marker: DateMarker): number;
+    getMonth(marker: DateMarker): number;
+    getDay(marker: DateMarker): number;
+    add(marker: DateMarker, dur: Duration): DateMarker;
+    subtract(marker: DateMarker, dur: Duration): DateMarker;
+    addYears(marker: DateMarker, n: number): Date;
+    addMonths(marker: DateMarker, n: number): Date;
+    diffWholeYears(m0: DateMarker, m1: DateMarker): number;
+    diffWholeMonths(m0: DateMarker, m1: DateMarker): number;
+    greatestWholeUnit(m0: DateMarker, m1: DateMarker): {
+        unit: string;
+        value: number;
+    };
+    countDurationsBetween(m0: DateMarker, m1: DateMarker, d: Duration): number;
+    startOf(m: DateMarker, unit: string): Date;
+    startOfYear(m: DateMarker): DateMarker;
+    startOfMonth(m: DateMarker): DateMarker;
+    startOfWeek(m: DateMarker): DateMarker;
+    computeWeekNumber(marker: DateMarker): number;
+    format(marker: DateMarker, formatter: DateFormatter, dateOptions?: {
+        forcedTzo?: number;
+    }): [string, Intl.DateTimeFormatPart[]];
+    formatRange(start: DateMarker, end: DateMarker, formatter: DateFormatter, dateOptions?: {
+        forcedStartTzo?: number;
+        forcedEndTzo?: number;
+        isEndExclusive?: boolean;
+        defaultSeparator?: string;
+    }): string;
+    formatIso(marker: DateMarker, extraOptions?: any): string;
+    timestampToMarker(ms: number): Date;
+    offsetForMarker(m: DateMarker): number;
+    toDate(m: DateMarker, forcedTzo?: number): Date;
+}
+
+interface DateRangeInput {
+    start?: DateInput;
+    end?: DateInput;
+}
+interface OpenDateRange {
+    start: DateMarker | null;
+    end: DateMarker | null;
+}
+interface DateRange {
+    start: DateMarker;
+    end: DateMarker;
+}
+declare function parseRange(input: DateRangeInput, dateEnv: DateEnv): OpenDateRange;
+declare function invertRanges(ranges: DateRange[], constraintRange: DateRange): DateRange[];
+declare function intersectRanges(range0: OpenDateRange, range1: OpenDateRange): OpenDateRange;
+declare function rangesEqual(range0: OpenDateRange, range1: OpenDateRange): boolean;
+declare function rangesIntersect(range0: OpenDateRange, range1: OpenDateRange): boolean;
+declare function rangeContainsRange(outerRange: OpenDateRange, innerRange: OpenDateRange): boolean;
+declare function rangeContainsMarker(range: OpenDateRange, date: DateMarker | number): boolean;
+declare function constrainMarkerToRange(date: DateMarker, range: DateRange): DateMarker;
+
+declare class CmdFormatter implements DateFormatter {
+    cmdStr: string;
+    constructor(cmdStr: string);
+    format(date: ZonedMarker, context: DateFormattingContext, betterDefaultSeparator?: string): [string, Intl.DateTimeFormatPart[]];
+    formatRange(start: ZonedMarker, end: ZonedMarker, context: DateFormattingContext, betterDefaultSeparator?: string): string;
+}
+
+type FuncFormatterFunc = (data: VerboseFormattingData) => string;
+declare class FuncFormatter implements DateFormatter {
+    func: FuncFormatterFunc;
+    constructor(func: FuncFormatterFunc);
+    format(date: ZonedMarker, context: DateFormattingContext, betterDefaultSeparator?: string): [string, Intl.DateTimeFormatPart[]];
+    formatRange(start: ZonedMarker, end: ZonedMarker, context: DateFormattingContext, betterDefaultSeparator?: string): string;
+}
+
+declare function buildIsoString(marker: DateMarker, timeZoneOffset?: number, stripZeroTime?: boolean): string;
+declare function formatDayString(marker: DateMarker): string;
+declare function formatIsoMonthStr(marker: DateMarker): string;
+declare function formatIsoTimeString(marker: DateMarker): string;
+declare function formatTimeZoneOffset(minutes: number, doIso?: boolean): string;
+declare function joinDateTimeFormatParts(parts: {
+    value: string;
+}[]): string;
+
+declare function parse(str: any): {
+    marker: Date;
+    isTimeUnspecified: boolean;
+    timeZoneOffset: any;
+};
+
+declare function isInt(n: any): boolean;
+declare function trimEnd(s: string): string;
+declare function padStart(val: any, len: any): string;
+
+export { CalendarSystem, CmdFormatter, CmdFormatterFunc, DateEnv, DateEnvSettings, DateFormatter, DateFormattingContext, DateInput, DateMarker, DateMarkerMeta, DateRange, DateRangeInput, Duration, DurationInput, DurationObjectInput, ExpandedZonedMarker, FuncFormatter, FuncFormatterFunc, Locale, LocaleCodeArg, NamedTimeZoneImpl, NamedTimeZoneImplClass, OpenDateRange, VerboseFormattingData, WeekNumberCalculation, ZonedMarker, addDays, addDurations, addMs, addWeeks, arrayToLocalDate, arrayToUtcDate, asCleanDays, asRoughDays, asRoughHours, asRoughMinutes, asRoughMonths, asRoughMs, asRoughSeconds, asRoughYears, buildIsoString, constrainMarkerToRange, createCalendarSystem, createDuration, createVerboseFormattingArg, dateToLocalArray, dateToUtcArray, diffDayAndTime, diffDays, diffHours, diffMinutes, diffSeconds, diffWeeks, diffWholeDays, diffWholeWeeks, durationsEqual, expandZonedMarker, formatDayString, formatIsoMonthStr, formatIsoTimeString, formatTimeZoneOffset, greatestDurationDenominator, intersectRanges, invertRanges, isInt, isValidDate, joinDateTimeFormatParts, multiplyDuration, padStart, parse, parseRange, rangeContainsMarker, rangeContainsRange, rangesEqual, rangesIntersect, registerCalendarSystem, startOfDay, startOfHour, startOfMinute, startOfSecond, subtractDurations, timeAsMs, trimEnd, weekOfYear, wholeDivideDurations };