@openreachtech/furo-vue 1.3.1

package/types/generated/components/molecules/FuroDatePicker/FuroDatePickerContext.d.ts

@@ -0,0 +1,516 @@
+/**
+ * Furo-only parcel keys that are not forwarded to Reka `DatePickerRoot`.
+ * These are stripped from the Reka v-bind spread.
+ */
+export const FURO_DATE_PICKER_PARCEL_KEYS: Set<string>;
+/**
+ * Context class for managing FuroDatePicker atom.
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroDatePickerContext extends BaseFuroContext<null, Props, "CHANGE_VALUE" | "UPDATE_VALUE" | "COMMIT_VALUE"> {
+    /**
+     * Factory method.
+     *
+     * @template {X extends typeof FuroDatePickerContext ? X : never} T, X
+     * @override
+     * @param {FuroDatePickerContextFactoryParams} params - Parameters of this factory method.
+     * @returns {InstanceType<T>} An instance of this class.
+     * @this {T}
+     */
+    static override create<T extends X extends typeof FuroDatePickerContext ? X : never, X>(this: T, { props, componentContext, refHash, }: FuroDatePickerContextFactoryParams): InstanceType<T>;
+    /**
+     * Build ref hash.
+     *
+     * @override
+     * @returns {FuroDatePickerContextParams['refHash']}
+     */
+    static override buildRefHash(): FuroDatePickerContextParams["refHash"];
+    /**
+     * Get emit event names.
+     *
+     * @override
+     * @returns {Readonly<{
+     *   CHANGE_VALUE: 'change-value'
+     *   COMMIT_VALUE: 'commit-value'
+     *   UPDATE_VALUE: 'update:value'
+     * }>}
+     */
+    static override get EMIT_EVENT_NAME(): Readonly<{
+        CHANGE_VALUE: "change-value";
+        COMMIT_VALUE: "commit-value";
+        UPDATE_VALUE: "update:value";
+    }>;
+    /**
+     * Get emit event hash.
+     *
+     * @returns {{
+     *   'change-value': (payload: import('./DatePickerEmitPayload.js').default) => void
+     *   'commit-value': (payload: import('./DatePickerEmitPayload.js').default) => void
+     *   'update:value': (value: string | null) => void
+     * }}
+     */
+    static get EMIT_EVENT_HASH(): {
+        "change-value": (payload: import("./DatePickerEmitPayload.js").default) => void;
+        "commit-value": (payload: import("./DatePickerEmitPayload.js").default) => void;
+        "update:value": (value: string | null) => void;
+    };
+    /**
+     * Get the EmitPayload constructor.
+     *
+     * @returns {typeof DatePickerEmitPayload}
+     */
+    static get EmitPayloadCtor(): typeof DatePickerEmitPayload;
+    /**
+     * Extract year / month / day string parts from a `Date` object in a specific IANA timezone
+     * via `Intl.DateTimeFormat`. Year is zero-padded to 4 digits to satisfy ISO 8601.
+     *
+     * @param {{
+     *   raw: Date
+     *   timezone: string
+     * }} params - Parameters of this method.
+     * @returns {{ year: string | null, month: string | null, day: string | null }}
+     */
+    static extractDatePartsInTimezone({ raw, timezone, }: {
+        raw: Date;
+        timezone: string;
+    }): {
+        year: string | null;
+        month: string | null;
+        day: string | null;
+    };
+    /**
+     * Detect the browser's locale string. Returns `'en'` when `navigator` is unavailable
+     * (e.g. server-side render).
+     *
+     * @returns {string}
+     */
+    static detectBrowserLocale(): string;
+    /**
+     * Constructor.
+     *
+     * @param {FuroDatePickerContextParams} params - Parameters of this constructor.
+     */
+    constructor({ props, componentContext, refHash, }: FuroDatePickerContextParams);
+    refHash: {
+        triggerElementRef: import("vue").Ref<HTMLElement | null>;
+        internalValueRef: import("vue").Ref<import("@internationalized/date").CalendarDate | null>;
+        placeholderRef: import("vue").Ref<import("@internationalized/date").CalendarDate | null>;
+    };
+    /**
+     * Get the constructor of this class.
+     *
+     * @override
+     * @returns {typeof FuroDatePickerContext}
+     */
+    override get Ctor(): typeof FuroDatePickerContext;
+    /**
+     * Get trigger element ref.
+     *
+     * @returns {import('vue').Ref<HTMLElement | null>}
+     */
+    get triggerElementRef(): import("vue").Ref<HTMLElement | null>;
+    /**
+     * Get internal CalendarDate value ref.
+     *
+     * @returns {import('vue').Ref<import('@internationalized/date').CalendarDate | null>}
+     */
+    get internalValueRef(): import("vue").Ref<import("@internationalized/date").CalendarDate | null>;
+    /**
+     * Get calendar view placeholder ref (controls which month/year the calendar shows).
+     *
+     * @returns {import('vue').Ref<import('@internationalized/date').CalendarDate | null>}
+     */
+    get placeholderRef(): import("vue").Ref<import("@internationalized/date").CalendarDate | null>;
+    /**
+     * Get trigger parcel.
+     *
+     * @returns {Props['triggerParcel']}
+     */
+    get triggerParcel(): Props["triggerParcel"];
+    /**
+     * Get content parcel.
+     *
+     * @returns {Props['contentParcel']}
+     */
+    get contentParcel(): Props["contentParcel"];
+    /**
+     * Whether the date picker is in an invalid state.
+     *
+     * @returns {boolean}
+     */
+    get isInvalid(): boolean;
+    /**
+     * Whether the date picker is disabled.
+     *
+     * @returns {boolean}
+     */
+    get isDisabled(): boolean;
+    /**
+     * Placeholder text.
+     *
+     * @returns {string}
+     */
+    get placeholder(): string;
+    /**
+     * IANA timezone identifier for Date object normalization (e.g. `'Asia/Tokyo'`).
+     * When `null`, normalization falls back to local date parts (timezone-naive).
+     *
+     * @returns {string | null}
+     */
+    get timezone(): string | null;
+    /**
+     * Footer "Today" button label. Defaults to `'Today'`; `null` hides the button.
+     *
+     * @returns {string | null}
+     */
+    get todayButtonText(): string | null;
+    /**
+     * Footer "Clear" button label. Defaults to `'Clear'`; `null` hides the button.
+     *
+     * @returns {string | null}
+     */
+    get clearButtonText(): string | null;
+    /**
+     * Setup component — sync external value into internal CalendarDate ref.
+     *
+     * @template {X extends FuroDatePickerContext ? X : never} T, X
+     * @override
+     * @returns {T} - For method chaining.
+     * @this {T}
+     */
+    override setupComponent<T extends X extends FuroDatePickerContext ? X : never, X>(this: T): T;
+    /**
+     * Normalize an external value to `CalendarDate | null`.
+     * Accepts `YYYY-MM-DD` strings, `Date` objects, `CalendarDate` instances, or `null`.
+     *
+     * @param {{
+     *   raw: string | Date | import('@internationalized/date').CalendarDate | null
+     * }} params - Parameters of this method.
+     * @returns {import('@internationalized/date').CalendarDate | null}
+     */
+    normalizeToCalendarDate({ raw, }: {
+        raw: string | Date | import("@internationalized/date").CalendarDate | null;
+    }): import("@internationalized/date").CalendarDate | null;
+    /**
+     * Parse an ISO `YYYY-MM-DD` string into a `CalendarDate`.
+     *
+     * @param {{
+     *   raw: string
+     * }} params - Parameters of this method.
+     * @returns {import('@internationalized/date').CalendarDate | null}
+     */
+    normalizeStringToCalendarDate({ raw, }: {
+        raw: string;
+    }): import("@internationalized/date").CalendarDate | null;
+    /**
+     * Convert a `Date` object to `CalendarDate`.
+     * When `parcel.timezone` is set, date parts are extracted in that IANA timezone.
+     * Otherwise falls back to local date parts (timezone-naive).
+     *
+     * @param {{
+     *   raw: Date
+     * }} params - Parameters of this method.
+     * @returns {import('@internationalized/date').CalendarDate | null}
+     */
+    normalizeDateToCalendarDate({ raw, }: {
+        raw: Date;
+    }): import("@internationalized/date").CalendarDate | null;
+    /**
+     * Convert a `Date` object to `CalendarDate` using a specific IANA timezone.
+     * Returns `null` when the timezone identifier is invalid.
+     *
+     * @param {{
+     *   raw: Date
+     *   timezone: string
+     * }} params - Parameters of this method.
+     * @returns {import('@internationalized/date').CalendarDate | null}
+     */
+    normalizeDateToCalendarDateInTimezone({ raw, timezone, }: {
+        raw: Date;
+        timezone: string;
+    }): import("@internationalized/date").CalendarDate | null;
+    /**
+     * Whether the footer actions row should be rendered (at least one button is visible).
+     *
+     * @returns {boolean}
+     */
+    hasFooterButtons(): boolean;
+    /**
+     * Whether the Today button is visible.
+     *
+     * @returns {boolean}
+     */
+    hasTodayButton(): boolean;
+    /**
+     * Whether the Clear button is visible.
+     *
+     * @returns {boolean}
+     */
+    hasClearButton(): boolean;
+    /**
+     * Normalize a `CalendarDate` to an ISO `YYYY-MM-DD` string or `null`.
+     *
+     * @param {{
+     *   calendarDate: import('@internationalized/date').CalendarDate | null
+     * }} params - Parameters of this method.
+     * @returns {string | null}
+     */
+    normalizeToIsoString({ calendarDate, }: {
+        calendarDate: import("@internationalized/date").CalendarDate | null;
+    }): string | null;
+    /**
+     * Normalize the parcel `minValue` to a `CalendarDate`.
+     *
+     * @returns {import('@internationalized/date').CalendarDate | null}
+     */
+    normalizeMinValue(): import("@internationalized/date").CalendarDate | null;
+    /**
+     * Normalize the parcel `maxValue` to a `CalendarDate`.
+     *
+     * @returns {import('@internationalized/date').CalendarDate | null}
+     */
+    normalizeMaxValue(): import("@internationalized/date").CalendarDate | null;
+    /**
+     * Resolve the calendar placeholder, which drives both the displayed month/year and the
+     * empty segment placeholders. Falls back to an explicit placeholder, then the current
+     * value, then today clamped into the `[minValue, maxValue]` window — so the year segment
+     * auto-fills within range when bounds are set but no value exists yet.
+     *
+     * @returns {import('@internationalized/date').CalendarDate | null}
+     */
+    resolveCalendarPlaceholder(): import("@internationalized/date").CalendarDate | null;
+    /**
+     * Clamp a `CalendarDate` into the `[minValue, maxValue]` window.
+     * Returns the bound when out of range, otherwise the original date.
+     *
+     * @param {{
+     *   date: import('@internationalized/date').CalendarDate
+     * }} params - Parameters of this method.
+     * @returns {import('@internationalized/date').CalendarDate}
+     */
+    clampDateToBounds({ date, }: {
+        date: import("@internationalized/date").CalendarDate;
+    }): import("@internationalized/date").CalendarDate;
+    /**
+     * Resolve whether the calendar popover closes when a date is selected.
+     * Defaults to `true` (single-date close-on-select UX). A consumer — e.g. the
+     * `FuroDateTimePicker` molecule — passes `closeOnSelect: false` to keep the popover open
+     * so a time can also be chosen in the same session.
+     *
+     * @returns {boolean}
+     */
+    resolveCloseOnSelect(): boolean;
+    /**
+     * Resolve whether re-selecting the already-selected date is prevented from clearing it.
+     * Defaults to `true` (re-clicking a selected date keeps it), with `parcel.preventDeselect`
+     * as an explicit override.
+     *
+     * @returns {boolean}
+     */
+    resolvePreventDeselect(): boolean;
+    /**
+     * Resolve the locale that drives the date field's segment order and formatting.
+     * Defaults to the browser locale so the segment order follows the user's locale
+     * (e.g. `dd/mm/yyyy`), with `parcel.locale` as an explicit override.
+     *
+     * @returns {string}
+     */
+    resolveLocale(): string;
+    /**
+     * Extract attributes for Reka `DatePickerRoot`.
+     * Strips all Furo-only keys and re-applies normalized Reka props.
+     *
+     * @returns {Record<string, unknown>}
+     */
+    extractRootAttributes(): Record<string, unknown>;
+    /**
+     * Strip Furo-only parcel keys from the parcel object.
+     *
+     * @returns {Record<string, unknown>}
+     */
+    stripFuroParcelKeys(): Record<string, unknown>;
+    /**
+     * Extract attributes for Reka `DatePickerField` / `DatePickerTrigger`.
+     *
+     * @returns {Props['triggerParcel']}
+     */
+    extractTriggerAttributes(): Props["triggerParcel"];
+    /**
+     * Extract attributes for Reka `DatePickerContent`.
+     *
+     * @returns {Props['contentParcel']}
+     */
+    extractContentAttributes(): Props["contentParcel"];
+    /**
+     * Build a custom event for the emit payload.
+     *
+     * @param {{
+     *   name: string
+     *   value: string | null
+     * }} params - Parameters of this method.
+     * @returns {CustomEvent<{
+     *   target: HTMLElement | null
+     *   value: string | null
+     * }>}
+     */
+    buildCustomEvent({ name, value, }: {
+        name: string;
+        value: string | null;
+    }): CustomEvent<{
+        target: HTMLElement | null;
+        value: string | null;
+    }>;
+    /**
+     * Respond to `update:modelValue` from Reka `DatePickerRoot`.
+     * Emits `change-value`, `update:value`, and `commit-value`.
+     *
+     * @param {{
+     *   calendarDate?: import('@internationalized/date').DateValue | null
+     * }} params - Parameters of this method.
+     */
+    onChangeValue({ calendarDate, }: {
+        calendarDate?: import("@internationalized/date").DateValue | null;
+    }): void;
+    /**
+     * Sync calendar view placeholder when Reka navigates (prev/next buttons).
+     *
+     * @param {{
+     *   calendarDate: import('@internationalized/date').DateValue | null
+     * }} params - Parameters of this method.
+     */
+    onPlaceholderChange({ calendarDate, }: {
+        calendarDate: import("@internationalized/date").DateValue | null;
+    }): void;
+    /**
+     * Navigate the calendar view to a specific month, keeping the current year.
+     *
+     * @param {{
+     *   changeEvent: Event
+     *   currentYear: number
+     * }} params - Parameters of this method.
+     */
+    onMonthChange({ changeEvent, currentYear, }: {
+        changeEvent: Event;
+        currentYear: number;
+    }): void;
+    /**
+     * Navigate the calendar view to a specific year, keeping the current month.
+     *
+     * @param {{
+     *   changeEvent: Event
+     *   currentMonth: number
+     * }} params - Parameters of this method.
+     */
+    onYearChange({ changeEvent, currentMonth, }: {
+        changeEvent: Event;
+        currentMonth: number;
+    }): void;
+    /**
+     * Select today's date (clamped into the `[minValue, maxValue]` window) from the footer
+     * "Today" button, navigating the calendar view to it and emitting the change trio.
+     */
+    onSelectToday(): void;
+    /**
+     * Clear the selected value from the footer "Clear" button, emitting the change trio with
+     * `null`.
+     */
+    onClearValue(): void;
+    /**
+     * Extract the 12 calendar months for the month dropdown.
+     *
+     * @returns {{ value: number, label: string }[]}
+     */
+    extractCalendarMonths(): {
+        value: number;
+        label: string;
+    }[];
+    /**
+     * Extract the year range for the year dropdown.
+     * Respects `minValue`/`maxValue` parcel constraints; defaults to ±100/+50 from today.
+     *
+     * @returns {{ value: number }[]}
+     */
+    extractCalendarYears(): {
+        value: number;
+    }[];
+    /**
+     * Whether the part is a slash character part.
+     *
+     * @param {{ part: import('reka-ui').SegmentPart }} params - Parameters of this method.
+     * @returns {boolean}
+     */
+    isSlashCharacterPart({ part, }: {
+        part: import("reka-ui").SegmentPart;
+    }): boolean;
+    /**
+     * Format a date field segment value for display. Day and month segments are zero-padded to
+     * two digits (e.g. `3` → `03`, `5` → `05`) so the field always shows `dd`/`mm`; placeholder
+     * text, the year, and literals pass through unchanged. The underlying primitive renders
+     * filled day/month segments with single-digit (`numeric`) formatting, so this restores the
+     * 2-digit display.
+     *
+     * @param {{
+     *   part: import('reka-ui').SegmentPart
+     *   value: string
+     * }} params - Parameters of this method.
+     * @returns {string}
+     */
+    formatSegmentValue({ part, value, }: {
+        part: import("reka-ui").SegmentPart;
+        value: string;
+    }): string;
+    /**
+     * Whether a segment part should display zero-padded to two digits (day or month).
+     *
+     * @param {{ part: import('reka-ui').SegmentPart }} params - Parameters of this method.
+     * @returns {boolean}
+     */
+    isTwoDigitSegmentPart({ part, }: {
+        part: import("reka-ui").SegmentPart;
+    }): boolean;
+}
+export type FuroDatePickerContextParams = import("../../../contexts/BaseFuroContext.js").BaseFuroContextParams & {
+    props: Props;
+    componentContext: ComponentContext;
+    refHash: {
+        triggerElementRef: import("vue").Ref<HTMLElement | null>;
+        internalValueRef: import("vue").Ref<import("@internationalized/date").CalendarDate | null>;
+        placeholderRef: import("vue").Ref<import("@internationalized/date").CalendarDate | null>;
+    };
+};
+export type FuroDatePickerContextFactoryParams = Omit<FuroDatePickerContextParams, "refHash"> & {
+    refHash?: {
+        triggerElementRef: import("vue").Ref<HTMLElement | null>;
+        internalValueRef: import("vue").Ref<import("@internationalized/date").CalendarDate | null>;
+        placeholderRef: import("vue").Ref<import("@internationalized/date").CalendarDate | null>;
+    };
+};
+export type EmitEventName = keyof typeof FuroDatePickerContext.EMIT_EVENT_NAME;
+export type Props = import("vue").HTMLAttributes & {
+    parcel?: DatePickerParcel | null;
+    triggerParcel?: Record<string, unknown> | null;
+    contentParcel?: Record<string, unknown> | null;
+};
+export type DatePickerParcel = Record<string, unknown> & {
+    value?: string | null;
+    invalid?: boolean;
+    placeholder?: string | null;
+    disabled?: boolean;
+    minValue?: string | null;
+    maxValue?: string | null;
+    displayFormat?: string | null;
+    timezone?: string | null;
+    closeOnSelect?: boolean | null;
+    preventDeselect?: boolean | null;
+    locale?: string | null;
+    todayButtonText?: string | null;
+    clearButtonText?: string | null;
+};
+export type ComponentContext = import("vue").SetupContext<FuroDatePickerEmitHash>;
+export type FuroDatePickerEmitHash = typeof FuroDatePickerContext.EMIT_EVENT_HASH;
+export type FuroDatePickerSetup = (props: Props, componentContext: ComponentContext) => {
+    context: FuroDatePickerContext;
+};
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js';
+import DatePickerEmitPayload from './DatePickerEmitPayload.js';

package/types/generated/components/molecules/FuroDateTimePicker/DateTimePickerEmitPayload.d.ts

@@ -0,0 +1,55 @@
+/**
+ * DateTimePickerEmitPayload.
+ *
+ * @extends {BaseEmitPayload<DateTimePickerRawEvent, HTMLElement>}
+ */
+export default class DateTimePickerEmitPayload extends BaseEmitPayload<DateTimePickerRawEvent, HTMLElement> {
+    constructor({ rawEvent, }: import("../../../emit-payload/BaseEmitPayload.js").BaseEmitPayloadParams<DateTimePickerRawEvent>);
+    /**
+     * Get the event detail.
+     *
+     * @returns {DateTimePickerRawEvent['detail'] | null}
+     */
+    get eventDetail(): DateTimePickerRawEvent["detail"] | null;
+    /**
+     * Combined datetime as ISO `YYYY-MM-DDTHH:MM:SS` string, or `null` until both parts are set.
+     *
+     * @returns {string | null}
+     */
+    get value(): string | null;
+    /**
+     * Date part of the combined value (`YYYY-MM-DD` | `null`).
+     *
+     * @returns {string | null}
+     */
+    get datePart(): string | null;
+    /**
+     * Time part of the combined value (`HH:MM:SS` | `null`).
+     *
+     * @returns {string | null}
+     */
+    get timePart(): string | null;
+    /**
+     * Whether the payload carries an empty (null) combined value.
+     *
+     * @returns {boolean}
+     */
+    hasEmptyValue(): boolean;
+    /**
+     * Whether the payload carries a non-null combined value.
+     *
+     * @returns {boolean}
+     */
+    hasValue(): boolean;
+}
+export type DateTimePickerRawEvent = CustomEvent<{
+    target: HTMLElement | null;
+    value: string | null;
+    datePart: string | null;
+    timePart: string | null;
+}>;
+export type DateTimePickerEmitPayloadParams = {
+    rawEvent: DateTimePickerRawEvent;
+};
+export type DateTimePickerEmitPayloadFactoryParams = DateTimePickerEmitPayloadParams;
+import BaseEmitPayload from '../../../emit-payload/BaseEmitPayload.js';