@dereekb/date 13.3.1 → 13.4.1

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

@@ -57,6 +57,9 @@ export interface DateTimezoneConversionConfig {
  * isValidDateTimezoneConversionConfig({ timezone: 'America/Chicago' }); // true
  * isValidDateTimezoneConversionConfig({}); // false
  * ```
+ *
+ * @param input - the conversion config to validate
+ * @returns true if the config has at least one meaningful conversion property set
  */
 export declare function isValidDateTimezoneConversionConfig(input: DateTimezoneConversionConfig): boolean;
 /**
@@ -74,6 +77,10 @@ export type DateTimezoneConversionConfigUseSystemTimezone = {
  * isSameDateTimezoneConversionConfig({ timezone: 'UTC' }, { timezone: undefined }); // true
  * isSameDateTimezoneConversionConfig({ useSystemTimezone: true }, { timezone: 'America/Denver' }); // false
  * ```
+ *
+ * @param a - first conversion config to compare
+ * @param b - second conversion config to compare
+ * @returns true if both configs are logically equivalent
  */
 export declare function isSameDateTimezoneConversionConfig(a: DateTimezoneConversionConfig, b: DateTimezoneConversionConfig): boolean;
 /**
@@ -91,6 +98,7 @@ export declare function isSameDateTimezoneConversionConfig(a: DateTimezoneConver
  * ```
  *
  * @param date - required to determine the correct offset for that instant (DST-aware)
+ * @returns the system timezone UTC offset in milliseconds
  */
 export declare function getCurrentSystemOffsetInMs(date: Date): Milliseconds;
 /**
@@ -103,6 +111,7 @@ export declare function getCurrentSystemOffsetInMs(date: Date): Milliseconds;
  * ```
  *
  * @param date - required to determine the correct offset for that instant (DST-aware)
+ * @returns the system timezone UTC offset truncated to whole hours
  */
 export declare function getCurrentSystemOffsetInHours(date: Date): Hours;
 /**
@@ -118,6 +127,7 @@ export declare function getCurrentSystemOffsetInHours(date: Date): Hours;
  * ```
  *
  * @param date - required to determine the correct offset for that instant (DST-aware)
+ * @returns the system timezone UTC offset in minutes
  */
 export declare function getCurrentSystemOffsetInMinutes(date: Date): Minutes;
 /**
@@ -137,6 +147,7 @@ export declare function getCurrentSystemOffsetInMinutes(date: Date): Minutes;
  *
  * @param timezone - IANA timezone string (e.g. 'America/New_York')
  * @param date - the instant to evaluate, since DST may shift the offset
+ * @returns the UTC offset for the given timezone at the given instant, in milliseconds
  */
 export declare function calculateTimezoneOffset(timezone: TimezoneString, date: Date): Milliseconds;
 export type DateTimezoneConversionTarget = 'target' | 'base' | 'system';
@@ -194,6 +205,15 @@ export type DateTimezoneConversionMap<T = number> = {
     [key: string]: T;
 };
 export type DateTimezoneConversionFunction<T> = MapFunction<Milliseconds, T>;
+/**
+ * Calculates offset values for every pair of conversion targets (target, base, system)
+ * and returns them as a keyed map (e.g. `'target-base'`, `'base-system'`).
+ *
+ * @param date - the reference date used to compute offsets
+ * @param converter - the converter instance providing offset calculations
+ * @param map - optional mapping function applied to each raw millisecond offset
+ * @returns a map of conversion-pair keys to their computed offset values
+ */
 export declare function calculateAllConversions<T = number>(date: Date, converter: DateTimezoneBaseDateConverter, map?: DateTimezoneConversionFunction<T>): DateTimezoneConversionMap<T>;
 export type DateTimezoneUtcNormalInstanceInput = Maybe<TimezoneString> | DateTimezoneConversionConfig;
 export type DateTimezoneUtcNormalInstanceTransformType = 'targetDateToBaseDate' | 'targetDateToSystemDate' | 'baseDateToTargetDate' | 'baseDateToSystemDate' | 'systemDateToTargetDate' | 'systemDateToBaseDate';
@@ -205,8 +225,32 @@ export type DateTimezoneUtcNormalInstanceTransformType = 'targetDateToBaseDate'
  * inverseDateTimezoneUtcNormalInstanceTransformType('targetDateToBaseDate'); // 'baseDateToTargetDate'
  * inverseDateTimezoneUtcNormalInstanceTransformType('systemDateToTargetDate'); // 'targetDateToSystemDate'
  * ```
+ *
+ * @param input - the transform type to invert
+ * @returns the inverse transform type for round-trip conversion
  */
 export declare function inverseDateTimezoneUtcNormalInstanceTransformType(input: DateTimezoneUtcNormalInstanceTransformType): DateTimezoneUtcNormalInstanceTransformType;
+/**
+ * Configuration for {@link DateTimezoneUtcNormalInstance.safeMirroredConvertDate}.
+ */
+export interface SafeMirroredConvertDateConfig {
+    /**
+     * The base date. Should have been derived from the originalContextDate using convertDate().
+     */
+    readonly baseDate: BaseDateAsUTC;
+    /**
+     * Original date used to derive the baseDate.
+     */
+    readonly originalContextDate: Date;
+    /**
+     * The "type" of date the originalContextDate is.
+     */
+    readonly contextType: DateTimezoneConversionTarget;
+    /**
+     * Whether to apply safe DST correction. Defaults to true.
+     */
+    readonly safeConvert?: boolean;
+}
 /**
  * Central class for converting dates between the three date spaces (base, target, system).
  *
@@ -244,11 +288,10 @@ export declare class DateTimezoneUtcNormalInstance implements DateTimezoneBaseDa
      * For example, when daylight savings changed on November 3, 2024 the offset returned was 5 but to get back to the original an offset of 6 was required.
      * This is where some contextual data was not being used. This function uses that contextual data to make sure the reverse will be consistent.
      *
-     * @param baseDate The base date. Should have been derived from the originalContextDate using the convertDate() function
-     * @param originalContextDate Original date used to derive the baseDate.
-     * @param fromOrTo the "type" of date the originalContextDate is
+     * @param config - configuration for the safe mirrored conversion
+     * @returns the converted date and the DST offset adjustment applied
      */
-    safeMirroredConvertDate(baseDate: BaseDateAsUTC, originalContextDate: Date, contextType: DateTimezoneConversionTarget, safeConvert?: boolean): {
+    safeMirroredConvertDate(config: SafeMirroredConvertDateConfig): {
         date: Date;
         daylightSavingsOffset: number;
     };
@@ -277,46 +320,50 @@ export declare class DateTimezoneUtcNormalInstance implements DateTimezoneBaseDa
     /**
      * Returns true if the input is midnight in the target timezone.
      *
-     * @param date
+     * @param date - the date to check
+     * @returns true if the date is at the start of the day in the target timezone
      */
     isStartOfDayInTargetTimezone(date: Date): boolean;
     /**
      * Start of the given day in the target timezone.
      *
-     * @param date The input is treated as an instant in time.
+     * @param date - the input is treated as an instant in time
+     * @returns the start-of-day date in the target timezone
      */
     startOfDayInTargetTimezone(date?: Date | ISO8601DayString): Date;
     /**
      * Start of the given day in UTC.
      *
-     * @param date
+     * @param date - the date or ISO8601 day string to get the start of day for
+     * @returns the start of the day as a BaseDateAsUTC
      */
     startOfDayInBaseDate(date?: Date | ISO8601DayString): BaseDateAsUTC;
     /**
      * End of the given day in UTC.
      *
-     * @param date
-     * @returns
+     * @param date - the date or ISO8601 day string to get the end of day for
+     * @returns the end of the day as a BaseDateAsUTC (23:59:59.999)
      */
     endOfDayInBaseDate(date?: Date | ISO8601DayString): BaseDateAsUTC;
     /**
      * Start of the given day for the system.
      *
-     * @param date
-     * @returns
+     * @param date - the date or ISO8601 day string to get the start of day for
+     * @returns the start of the day in the system timezone
      */
     startOfDayInSystemDate(date?: Date | ISO8601DayString): Date;
     /**
      * End of the given day for the system.
      *
-     * @param date
-     * @returns
+     * @param date - the date or ISO8601 day string to get the end of day for
+     * @returns the end of the day in the system timezone
      */
     endOfDayInSystemDate(date?: Date | ISO8601DayString): Date;
     /**
-     * Whether or not the system experiences daylight savings for the given year.
+     * Whether or not the target timezone experiences daylight savings for the given year.
      *
-     * @param year
+     * @param year - the year to check, as a Date or number; defaults to the current year
+     * @returns true if the target timezone has different offsets in January and July
      */
     targetTimezoneExperiencesDaylightSavings(year?: Date | YearNumber): boolean;
     /**
@@ -351,6 +398,8 @@ export type DateTimezoneUtcNormalFunctionInput = DateTimezoneUtcNormalInstanceIn
  * const same = dateTimezoneUtcNormal(denver); // same reference
  * ```
  *
+ * @param config - timezone input: an existing instance, timezone string, millisecond offset, or config object
+ * @returns a DateTimezoneUtcNormalInstance for the given input
  * @throws Error if the input type is not recognized
  */
 export declare function dateTimezoneUtcNormal(config: DateTimezoneUtcNormalFunctionInput): DateTimezoneUtcNormalInstance;
@@ -370,6 +419,8 @@ export declare const UTC_DATE_TIMEZONE_UTC_NORMAL_INSTANCE: DateTimezoneUtcNorma
  *
  * Prefer this over constructing a new instance when you need system-timezone conversions,
  * as the singleton avoids unnecessary allocations.
+ *
+ * @returns the shared system-timezone DateTimezoneUtcNormalInstance singleton
  */
 export declare function systemDateTimezoneUtcNormal(): DateTimezoneUtcNormalInstance;
 /**
@@ -385,6 +436,10 @@ export declare function systemDateTimezoneUtcNormal(): DateTimezoneUtcNormalInst
  * const target = baseDateToTargetDate(base, 'America/Denver');
  * // target is 2024-06-15T14:00:00.000-06:00 (2PM MDT)
  * ```
+ *
+ * @param date - the BaseDateAsUTC to convert
+ * @param timezone - the target IANA timezone string
+ * @returns a real instant in the specified timezone
  */
 export declare function baseDateToTargetDate(date: Date, timezone: Maybe<TimezoneString>): Date;
 /**
@@ -400,32 +455,51 @@ export declare function baseDateToTargetDate(date: Date, timezone: Maybe<Timezon
  * const base = targetDateToBaseDate(target, 'America/Denver');
  * // base is 2024-06-15T14:00:00.000Z — wall-clock 2PM preserved as UTC
  * ```
+ *
+ * @param date - the target-timezone date to convert
+ * @param timezone - the IANA timezone the date is expressed in
+ * @returns a BaseDateAsUTC with wall-clock time preserved as UTC
  */
 export declare function targetDateToBaseDate(date: Date, timezone: Maybe<TimezoneString>): Date;
 /**
  * Converts a {@link BaseDateAsUTC} to a target date in the system's local timezone
  * using the shared system-timezone instance.
+ *
+ * @param date - the BaseDateAsUTC to convert
+ * @returns the date converted to the system's local timezone
  */
 export declare function systemBaseDateToNormalDate(date: Date): BaseDateAsUTC;
 /**
  * Converts a target date in the system's local timezone back to a {@link BaseDateAsUTC}
  * using the shared system-timezone instance.
+ *
+ * @param date - the system-timezone target date to convert back to base
+ * @returns the corresponding BaseDateAsUTC
  */
 export declare function systemNormalDateToBaseDate(date: BaseDateAsUTC): Date;
 /**
  * Returns the millisecond offset needed to convert a {@link BaseDateAsUTC} to a target date
  * in the system's local timezone.
+ *
+ * @param date - the date to compute the offset for
+ * @returns the offset in milliseconds
  */
 export declare function systemBaseDateToNormalDateOffset(date: Date): Milliseconds;
 /**
  * Returns the millisecond offset needed to convert a target date in the system's
  * local timezone back to a {@link BaseDateAsUTC}.
+ *
+ * @param date - the date to compute the offset for
+ * @returns the offset in milliseconds
  */
 export declare function systemNormalDateToBaseDateOffset(date: Date): Milliseconds;
 /**
  * Returns whether the system's local timezone observes daylight saving time in the given year.
  *
  * Compares the offset on January 1 and July 1; if they differ, DST is in effect for part of the year.
+ *
+ * @param year - the year to check, as a Date
+ * @returns true if the system timezone observes DST in the given year
  */
 export declare function systemExperiencesDaylightSavings(year: Date): boolean;
 /**
@@ -450,7 +524,9 @@ export type TransformDateInTimezoneNormalFunction = ((date: Date, transform: Map
  * const result = fn(someDate, (d) => startOfDay(d));
  * ```
  *
+ * @param timezoneInput - timezone configuration for the conversion
  * @param transformType - defaults to `'systemDateToTargetDate'`
+ * @returns a function that transforms dates within the specified timezone normalization
  */
 export declare function transformDateInTimezoneNormalFunction(timezoneInput: DateTimezoneUtcNormalFunctionInput, transformType?: DateTimezoneUtcNormalInstanceTransformType): TransformDateInTimezoneNormalFunction;
 /**
@@ -465,7 +541,9 @@ export type TransformDateRangeToTimezoneFunction = TransformDateRangeDatesFuncti
  * Creates a {@link TransformDateRangeToTimezoneFunction} that converts both dates in
  * a {@link DateRange} using the specified transform type.
  *
+ * @param timezoneInput - timezone configuration for the conversion
  * @param transformType - defaults to `'systemDateToTargetDate'`
+ * @returns a function that converts DateRange dates using the specified transform
  */
 export declare function transformDateRangeToTimezoneFunction(timezoneInput: DateTimezoneUtcNormalFunctionInput, transformType?: DateTimezoneUtcNormalInstanceTransformType): TransformDateRangeToTimezoneFunction;
 /**
@@ -481,7 +559,9 @@ export type TransformDateRangeInTimezoneNormalFunction = ((dateRange: DateRange,
  * Creates a {@link TransformDateRangeInTimezoneNormalFunction} that converts a date range
  * into the specified date space, applies a user-provided range transformation, then converts back.
  *
+ * @param timezoneInput - timezone configuration for the conversion
  * @param transformType - defaults to `'systemDateToTargetDate'`
+ * @returns a function that transforms date ranges within the specified timezone normalization
  */
 export declare function transformDateRangeInTimezoneNormalFunction(timezoneInput: DateTimezoneUtcNormalFunctionInput, transformType?: DateTimezoneUtcNormalInstanceTransformType): TransformDateRangeInTimezoneNormalFunction;
 /**
@@ -498,6 +578,9 @@ export type StartOfDayInTimezoneDayStringFactory = (day: ISO8601DayString) => Da
  * const midnight = startOfDayInDenver('2024-06-15');
  * // midnight is 2024-06-15T06:00:00.000Z (midnight MDT = 6AM UTC)
  * ```
+ *
+ * @param timezone - timezone configuration to bind the factory to
+ * @returns a factory that converts ISO8601 day strings to start-of-day dates
  */
 export declare function startOfDayInTimezoneDayStringFactory(timezone?: DateTimezoneUtcNormalFunctionInput): StartOfDayInTimezoneDayStringFactory;
 /**
@@ -509,6 +592,10 @@ export declare function startOfDayInTimezoneDayStringFactory(timezone?: DateTime
  * ```ts
  * const midnight = startOfDayInTimezoneFromISO8601DayString('2024-06-15', 'America/Denver');
  * ```
+ *
+ * @param day - the ISO8601 day string to parse
+ * @param timezone - timezone configuration for the start-of-day calculation
+ * @returns the start-of-day instant in the given timezone
  */
 export declare function startOfDayInTimezoneFromISO8601DayString(day: ISO8601DayString, timezone?: DateTimezoneUtcNormalFunctionInput): Date;
 export interface SetOnDateWithTimezoneNormalFunctionInput {
@@ -582,6 +669,9 @@ export type SetOnDateWithTimezoneNormalFunction = ((input: SetOnDateWithTimezone
  * const result = setOnDate({ date: someDate, hours: 14, minutes: 30, inputType: 'target' });
  * // result is someDate with hours set to 14:30 in Denver time
  * ```
+ *
+ * @param timezone - the timezone configuration to bind to
+ * @returns a function that sets hours/minutes on dates in the given timezone
  */
 export declare function setOnDateWithTimezoneNormalFunction(timezone: DateTimezoneUtcNormalFunctionInput): SetOnDateWithTimezoneNormalFunction;
 /**
@@ -591,6 +681,7 @@ export declare function setOnDateWithTimezoneNormalFunction(timezone: DateTimezo
  *
  * @param input - the date whose day is preserved
  * @param timezone - the timezone context for the hour/minute interpretation
+ * @returns the input date with hours and minutes set to the current time in the given timezone
  */
 export declare function copyHoursAndMinutesFromNowWithTimezoneNormal(input: Date, timezone: DateTimezoneUtcNormalFunctionInput): Date;
 /**
@@ -610,5 +701,6 @@ export declare function copyHoursAndMinutesFromNowWithTimezoneNormal(input: Date
  * @param input - the date whose day is preserved
  * @param copyFrom - the date (or `'now'`) whose hours/minutes are copied
  * @param timezone - the timezone context for interpreting both dates
+ * @returns the input date with hours and minutes copied from the source
  */
 export declare function copyHoursAndMinutesFromDateWithTimezoneNormal(input: Date, copyFrom: LogicalDate, timezone: DateTimezoneUtcNormalFunctionInput): Date;

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

@@ -104,7 +104,7 @@ export interface YearWeekCodeConfig {
      *
      * Configured to use the system timezone by default.
      */
-    timezone?: YearWeekCodeDateTimezoneInput;
+    readonly timezone?: YearWeekCodeDateTimezoneInput;
 }
 /**
  * Resolves a timezone input into a {@link DateTimezoneUtcNormalInstance} for use with YearWeekCode calculations.
@@ -118,6 +118,9 @@ export declare function yearWeekCodeDateTimezoneInstance(input: YearWeekCodeDate
 /**
  * Computes the {@link YearWeekCode} from a Date (using system timezone) or from explicit year and week values.
  *
+ * @param date - the date to compute the week code for
+ * @returns the encoded year+week code
+ *
  * @example
  * ```ts
  * yearWeekCode(new Date('2024-04-15')); // 202416
@@ -158,6 +161,7 @@ export declare function yearWeekCodeForDateRange(dateRange: DateRange): YearWeek
  *
  * @param dateRange - the range to compute week codes for
  * @param dateRangeTimezone - the timezone context for accurate week boundary calculation
+ * @returns an array of YearWeekCode values covering the range
  */
 export declare function yearWeekCodeForDateRangeInTimezone(dateRange: DateRange, dateRangeTimezone: YearWeekCodeDateTimezoneInput): YearWeekCode[];
 /**
@@ -175,6 +179,7 @@ export type YearWeekCodeForCalendarMonthFactory = (date: Date) => YearWeekCode[]
  * Returns all {@link YearWeekCode} values for the calendar month containing the given date, using the system timezone.
  *
  * @param date - a date within the target month
+ * @returns an array of YearWeekCode values for the month
  */
 export declare function yearWeekCodeForCalendarMonth(date: Date): YearWeekCode[];
 /**
@@ -232,9 +237,9 @@ export type YearWeekCodeGroupFactory<B> = (items: B[]) => YearWeekCodeGroup<B>[]
 export type YearWeekCodeDateReader<B> = MapFunction<B, Maybe<Date | YearWeekCode | YearWeekCodeString>>;
 export type YearWeekCodeReader = MapFunction<YearWeekCode | YearWeekCodeString, YearWeekCode>;
 export interface YearWeekCodeGroupFactoryConfig<B> {
-    yearWeekCodeFactory?: YearWeekCodeFactory | YearWeekCodeConfig;
-    yearWeekCodeReader?: YearWeekCodeReader;
-    dateReader: YearWeekCodeDateReader<B>;
+    readonly yearWeekCodeFactory?: YearWeekCodeFactory | YearWeekCodeConfig;
+    readonly yearWeekCodeReader?: YearWeekCodeReader;
+    readonly dateReader: YearWeekCodeDateReader<B>;
 }
 /**
  * Creates a {@link YearWeekCodeGroupFactory} that groups items by their {@link YearWeekCode}.

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

@@ -4,7 +4,6 @@ export * from './date.cell.index';
 export * from './date.cell.schedule';
 export * from './date.cell.schedule.day';
 export * from './date.cell';
-export * from './date.cell.validator';
 export * from './date.cell.week';
 export * from './date.calendar';
 export * from './date.duration';

package/src/lib/query/query.builder.mongo.d.ts

@@ -5,11 +5,17 @@ import { type DateQueryBuilder } from './query.builder';
  * used by {@link makeMongoDBLikeDateQueryBuilder} to produce query filters.
  */
 export interface TimeFieldsNameSet {
-    /** Field name storing the start (or combined start+end) timestamp. */
+    /**
+     * Field name storing the start (or combined start+end) timestamp.
+     */
     start: string;
-    /** Field name storing the end timestamp. Ignored when `singleFieldForStartAndEnd` is true. */
+    /**
+     * Field name storing the end timestamp. Ignored when `singleFieldForStartAndEnd` is true.
+     */
     end?: string;
-    /** When true, a single field represents both start and end so range bounds are merged. */
+    /**
+     * When true, a single field represents both start and end so range bounds are merged.
+     */
     singleFieldForStartAndEnd?: boolean;
 }
 /**

package/src/lib/rrule/date.recurrence.d.ts

@@ -7,9 +7,13 @@ import { type TimezoneString } from '@dereekb/util';
  * {@link ModelRecurrenceInfo} and a convenience boolean flag.
  */
 export interface RecurrenceModel {
-    /** Detailed recurrence metadata; undefined when the model does not recur. */
+    /**
+     * Detailed recurrence metadata; undefined when the model does not recur.
+     */
     recur?: ModelRecurrenceInfo;
-    /** Quick check for whether this model has active recurrence rules. */
+    /**
+     * Quick check for whether this model has active recurrence rules.
+     */
     recurs: boolean;
 }
 /**
@@ -19,15 +23,25 @@ export interface RecurrenceModel {
  * date-range utilities.
  */
 export interface ModelRecurrenceInfo extends DateRange {
-    /** Timezone the rule is a part of. Required for RRules that have timezone-sensitive implementations. */
+    /**
+     * Timezone the rule is a part of. Required for RRules that have timezone-sensitive implementations.
+     */
     timezone?: TimezoneString;
-    /** RRules for this recurrence. */
+    /**
+     * RRules for this recurrence.
+     */
     rrule: RRuleLines;
-    /** First instance of the recurrence. */
+    /**
+     * First instance of the recurrence.
+     */
     start: Date;
-    /** Final instance of the recurrence. */
+    /**
+     * Final instance of the recurrence.
+     */
     end: Date;
-    /** True if the recurrence has no end. */
+    /**
+     * True if the recurrence has no end.
+     */
     forever?: boolean;
 }
 /**

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

@@ -191,6 +191,8 @@ export declare class DateRRuleInstance {
     /**
      * Returns `true` when the underlying RRule has neither a `count` nor an
      * `until` constraint, meaning it recurs indefinitely.
+     *
+     * @returns `true` if the rule recurs indefinitely.
      */
     hasForeverRange(): boolean;
 }

package/src/lib/rrule/date.rrule.extension.d.ts

@@ -39,6 +39,8 @@ export declare class DateRRule extends RRule {
      * const rule = new DateRRule({ freq: RRule.DAILY, count: 5, dtstart: startDate });
      * const lastDate = rule.last(); // fifth occurrence
      * ```
+     *
+     * @returns The last occurrence date, or `undefined` if there are none.
      */
     last(): Maybe<Date>;
     /**
@@ -49,6 +51,9 @@ export declare class DateRRule extends RRule {
      * const rule = new DateRRule({ freq: RRule.WEEKLY, dtstart: startDate });
      * const nextDate = rule.next(new Date());
      * ```
+     *
+     * @param minDate - The earliest date to consider.
+     * @returns The first occurrence on or after `minDate`, or `undefined` if none.
      */
     next(minDate: Date): Maybe<Date>;
     /**
@@ -59,6 +64,11 @@ export declare class DateRRule extends RRule {
      * const rule = new DateRRule({ freq: RRule.DAILY, dtstart: startDate });
      * const exists = rule.any({ minDate: rangeStart, maxDate: rangeEnd });
      * ```
+     *
+     * @param filter - Optional date bounds with `minDate` and `maxDate`.
+     * @param filter.minDate - Optional minimum date bound.
+     * @param filter.maxDate - Optional maximum date bound.
+     * @returns `true` if at least one recurrence falls within the bounds.
      */
     any(filter?: {
         minDate?: Maybe<Date>;

package/src/lib/rrule/date.rrule.parse.d.ts

@@ -102,6 +102,10 @@ export interface RRuleExdateAttribute {
 /**
  * Delimiter separating the property name/params from values in an RRule line.
  */
+export declare const RRULE_STRING_SPLITTER = ":";
+/**
+ * @deprecated use RRULE_STRING_SPLITTER instead.
+ */
 export declare const RRuleStringSplitter = ":";
 /**
  * Utility class for parsing and manipulating RFC 5545 RRule strings.
@@ -128,21 +132,32 @@ export declare class DateRRuleParseUtility {
      * // result.basic = ['RRULE:FREQ=DAILY']
      * // result.exdates contains the parsed exclusion dates
      * ```
+     *
+     * @param input - The RRule string line set to separate.
+     * @returns The separated basic rules and parsed EXDATE exclusion dates.
      */
     static separateRRuleStringSetValues(input: RRuleStringLineSet): RRuleStringSetSeparation;
     /**
      * Parses an EXDATE line into its timezone and date components.
      *
+     * @param line - The raw EXDATE line string to parse.
+     * @returns The parsed EXDATE attribute with timezone and dates.
      * @throws Error if the line is not an EXDATE property.
      */
     static parseExdateAttributeFromLine(line: RRuleLineString): RRuleExdateAttribute;
     /**
      * Extracts timezone and UTC-normalized dates from an already-parsed EXDATE property.
+     *
+     * @param property - The parsed EXDATE property to extract from.
+     * @returns The EXDATE attribute containing timezone and UTC-normalized dates.
      */
     static parseExdateAttributeFromProperty(property: RRuleProperty): RRuleExdateAttribute;
     /**
      * Convenience wrapper that creates a timezone converter and delegates to {@link parseDateTimeString}.
      *
+     * @param rfcDateString - The RFC 5545 date or date-time string to parse.
+     * @param timezone - Optional timezone for non-UTC date strings.
+     * @returns The parsed JavaScript Date.
      * @throws Error if the date string is not UTC and no timezone is provided.
      */
     static parseDateTimeStringWithTimezone(rfcDateString: RFC5545DateString | RFC5545DateTimeString, timezone: Maybe<string>): Date;
@@ -152,6 +167,9 @@ export declare class DateRRuleParseUtility {
      * If the string does not end in `Z` (indicating UTC), the converter is used to normalize
      * the local date representation to its true UTC equivalent.
      *
+     * @param rfcDateString - The RFC 5545 date or date-time string to parse.
+     * @param converter - Optional timezone converter for non-UTC date strings.
+     * @returns The parsed JavaScript Date.
      * @throws Error if the string cannot be parsed or a non-UTC string lacks a converter.
      */
     static parseDateTimeString(rfcDateString: RFC5545DateString | RFC5545DateTimeString, converter: Maybe<DateTimezoneBaseDateConverter>): Date;
@@ -163,36 +181,59 @@ export declare class DateRRuleParseUtility {
      * DateRRuleParseUtility.formatDateTimeString(new Date('2021-06-11T11:00:00Z'));
      * // => '20210611T110000Z'
      * ```
+     *
+     * @param date - The date to format.
+     * @returns The RFC 5545 UTC date-time string representation.
      */
     static formatDateTimeString(date: Date): RFC5545DateTimeString;
     /**
      * Parses a full RRule line string into a structured {@link RRuleProperty}.
+     *
+     * @param line - The raw RRule line string to parse.
+     * @returns The structured property with type, params, and values.
      */
     static parseProperty(line: RRuleLineString): RRuleProperty;
     /**
      * Converts an {@link RRuleRawLine} into a structured {@link RRuleProperty} by splitting the type and params.
+     *
+     * @param rawLine - The raw line to convert.
+     * @returns The structured property with separated type, params, and values.
      */
     static propertyFromRawLine(rawLine: RRuleRawLine): RRuleProperty;
     /**
      * Splits a raw param string (e.g., `"TZID=America/New_York"`) into key-value form.
+     *
+     * @param param - The raw param string to split.
+     * @returns The parsed key-value param.
      */
     static parseRawParam(param: RRuleRawParamString): RRuleParam;
     /**
      * Splits a raw line at the colon delimiter into params and values portions.
      * Falls back to treating a single-segment line as an RRULE value.
+     *
+     * @param line - The raw RRule line string to split.
+     * @returns The raw line with separated params and values.
      */
     static parseRawLine(line: RRuleLineString): RRuleRawLine;
     /**
      * Splits a newline-delimited RRule string into individual line strings.
+     *
+     * @param lines - The newline-delimited RRule string to split.
+     * @returns An array of individual RRule line strings.
      */
     static toRRuleStringSet(lines: RRuleLines): RRuleStringLineSet;
     /**
      * Joins an array of RRule line strings into a single newline-delimited string.
+     *
+     * @param rruleStringSet - The array of RRule line strings to join.
+     * @returns A single newline-delimited RRule string.
      */
     static toRRuleLines(rruleStringSet: RRuleStringLineSet): RRuleLines;
     /**
      * Asserts that the property has the expected type, throwing if it does not match.
      *
+     * @param type - The expected property type.
+     * @param property - The property to check.
      * @throws Error if the property type does not match the expected type.
      */
     static assertPropertyType(type: RRulePropertyType, property: RRuleProperty): void;

package/src/lib/timezone/index.d.ts

@@ -1,2 +1 @@
 export * from './timezone';
-export * from './timezone.validator';