@openreachtech/furo-vue 1.3.1

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

@@ -0,0 +1,435 @@
+/**
+ * Furo-only parcel keys that are not forwarded to the composed date atom.
+ * The molecule owns these and derives the child parcels explicitly.
+ */
+export const FURO_DATE_TIME_PICKER_PARCEL_KEYS: Set<string>;
+/**
+ * Context class for managing FuroDateTimePicker molecule.
+ *
+ * Composes `FuroDatePicker` (calendar) and `FuroTimeField` (segmented time) into a
+ * single popover and exposes one combined `v-model:value` as a canonical
+ * `YYYY-MM-DDTHH:MM:SS` string (timezone-naive v1).
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroDateTimePickerContext extends BaseFuroContext<null, Props, "CHANGE_VALUE" | "UPDATE_VALUE" | "COMMIT_VALUE"> {
+    /**
+     * Factory method.
+     *
+     * @template {X extends typeof FuroDateTimePickerContext ? X : never} T, X
+     * @override
+     * @param {FuroDateTimePickerContextFactoryParams} params - Parameters of this factory method.
+     * @returns {InstanceType<T>} An instance of this class.
+     * @this {T}
+     */
+    static override create<T extends X extends typeof FuroDateTimePickerContext ? X : never, X>(this: T, { props, componentContext, refHash, }: FuroDateTimePickerContextFactoryParams): InstanceType<T>;
+    /**
+     * Build ref hash.
+     *
+     * @override
+     * @returns {FuroDateTimePickerContextParams['refHash']}
+     */
+    static override buildRefHash(): FuroDateTimePickerContextParams["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('./DateTimePickerEmitPayload.js').default) => void
+     *   'commit-value': (payload: import('./DateTimePickerEmitPayload.js').default) => void
+     *   'update:value': (value: string | null) => void
+     * }}
+     */
+    static get EMIT_EVENT_HASH(): {
+        "change-value": (payload: import("./DateTimePickerEmitPayload.js").default) => void;
+        "commit-value": (payload: import("./DateTimePickerEmitPayload.js").default) => void;
+        "update:value": (value: string | null) => void;
+    };
+    /**
+     * Get the EmitPayload constructor.
+     *
+     * @returns {typeof DateTimePickerEmitPayload}
+     */
+    static get EmitPayloadCtor(): typeof DateTimePickerEmitPayload;
+    /**
+     * Split a combined ISO `YYYY-MM-DDTHH:MM:SS` string into its date and time parts.
+     * Returns `null` parts for any value that does not contain the matching segment.
+     *
+     * @param {{
+     *   value: string | null
+     * }} params - Parameters of this method.
+     * @returns {{
+     *   datePart: string | null
+     *   timePart: string | null
+     * }}
+     */
+    static splitValue({ value, }: {
+        value: string | null;
+    }): {
+        datePart: string | null;
+        timePart: string | null;
+    };
+    /**
+     * Normalize a blank (empty / nullish) string segment to `null`.
+     *
+     * @param {{
+     *   segment: string | null
+     * }} params - Parameters of this method.
+     * @returns {string | null}
+     */
+    static blankToNull({ segment, }: {
+        segment: string | null;
+    }): string | null;
+    /**
+     * Combine a date part and a time part into a canonical `YYYY-MM-DDTHH:MM:SS` string.
+     * Returns `null` until BOTH parts are present (Q2 — never fabricates a default time).
+     * The time part is normalized to second precision (`HH:MM:SS`, seconds default `00` — Q4).
+     *
+     * @param {{
+     *   datePart: string | null
+     *   timePart: string | null
+     * }} params - Parameters of this method.
+     * @returns {string | null}
+     */
+    static combineValue({ datePart, timePart, }: {
+        datePart: string | null;
+        timePart: string | null;
+    }): string | null;
+    /**
+     * Pad a time part to second precision (`HH:MM` → `HH:MM:SS`).
+     *
+     * @param {{
+     *   timePart: string
+     * }} params - Parameters of this method.
+     * @returns {string}
+     */
+    static normalizeTimeToSeconds({ timePart, }: {
+        timePart: string;
+    }): string;
+    /**
+     * Constructor.
+     *
+     * @param {FuroDateTimePickerContextParams} params - Parameters of this constructor.
+     */
+    constructor({ props, componentContext, refHash, }: FuroDateTimePickerContextParams);
+    refHash: {
+        rootElementRef: import("vue").Ref<HTMLElement | null>;
+        datePartRef: import("vue").Ref<string | null>;
+        timePartRef: import("vue").Ref<string | null>;
+    };
+    /**
+     * Get the constructor of this class.
+     *
+     * @override
+     * @returns {typeof FuroDateTimePickerContext}
+     */
+    override get Ctor(): typeof FuroDateTimePickerContext;
+    /**
+     * Get root element ref.
+     *
+     * @returns {import('vue').Ref<HTMLElement | null>}
+     */
+    get rootElementRef(): import("vue").Ref<HTMLElement | null>;
+    /**
+     * Get the current date part ref (`YYYY-MM-DD` | `null`).
+     *
+     * @returns {import('vue').Ref<string | null>}
+     */
+    get datePartRef(): import("vue").Ref<string | null>;
+    /**
+     * Get the current time part ref (`HH:MM:SS` | `null`).
+     *
+     * @returns {import('vue').Ref<string | null>}
+     */
+    get timePartRef(): import("vue").Ref<string | null>;
+    /**
+     * Current date part (`YYYY-MM-DD` | `null`).
+     *
+     * @returns {string | null}
+     */
+    get datePart(): string | null;
+    /**
+     * Current time part (`HH:MM:SS` | `null`).
+     *
+     * @returns {string | null}
+     */
+    get timePart(): string | null;
+    /**
+     * Placeholder text.
+     *
+     * @returns {string}
+     */
+    get placeholder(): string;
+    /**
+     * IANA timezone identifier forwarded to both atoms (naive v1; atoms own normalization).
+     *
+     * @returns {string | null}
+     */
+    get timezone(): string | null;
+    /**
+     * Segment granularity forwarded to the time atom (`hour` | `minute` | `second`).
+     *
+     * @returns {string | null}
+     */
+    get granularity(): string | null;
+    /**
+     * Step amount forwarded to the time atom's steppers.
+     *
+     * @returns {number | null}
+     */
+    get step(): number | null;
+    /**
+     * Time format (12 or 24) forwarded to the time atom.
+     *
+     * @returns {number | null}
+     */
+    get timeFormat(): number | null;
+    /**
+     * Combined minimum datetime (`YYYY-MM-DDTHH:MM:SS` | `null`).
+     *
+     * @returns {string | null}
+     */
+    get minValue(): string | null;
+    /**
+     * Combined maximum datetime (`YYYY-MM-DDTHH:MM:SS` | `null`).
+     *
+     * @returns {string | null}
+     */
+    get maxValue(): string | null;
+    /**
+     * Whether the control is in an invalid state.
+     *
+     * @returns {boolean}
+     */
+    get isInvalid(): boolean;
+    /**
+     * Whether the control is disabled.
+     *
+     * @returns {boolean}
+     */
+    get isDisabled(): boolean;
+    /**
+     * Whether a date part is currently set.
+     *
+     * @returns {boolean}
+     */
+    get hasDate(): boolean;
+    /**
+     * Whether a time part is currently set.
+     *
+     * @returns {boolean}
+     */
+    get hasTime(): boolean;
+    /**
+     * Whether both date and time parts are set (a complete combined value exists — Q2).
+     *
+     * @returns {boolean}
+     */
+    get hasCompleteValue(): boolean;
+    /**
+     * Setup component — split the external combined value into date/time part refs.
+     *
+     * @template {X extends FuroDateTimePickerContext ? X : never} T, X
+     * @override
+     * @returns {T} - For method chaining.
+     * @this {T}
+     */
+    override setupComponent<T extends X extends FuroDateTimePickerContext ? X : never, X>(this: T): T;
+    /**
+     * Sync the internal date/time parts from an external combined value.
+     *
+     * Skips when the external value already equals what the current parts combine to. This
+     * preserves an in-progress part — e.g. a time picked before a date — from being wiped by
+     * the molecule's own `null` echo through the parent's `v-model` (Q2 emits `null` until both
+     * parts are set, so stepping the time before choosing a date would otherwise reset itself).
+     *
+     * @param {{
+     *   raw: string | null
+     * }} params - Parameters of this method.
+     */
+    syncFromExternalValue({ raw, }: {
+        raw: string | null;
+    }): void;
+    /**
+     * Derive the parcel forwarded to the composed `FuroDatePicker`.
+     * Strips molecule-only keys, then re-applies the date-scoped value and bounds.
+     * Optional value attributes are omitted when `null` (F-3 parity).
+     *
+     * `modal: true` is forced so the popover traps focus (reka renders `PopoverContentModal`
+     * → `FocusScope` with `trapped`). Without it the non-modal popover lets Tab escape the
+     * teleported content and jump to the inline time field in the trigger, breaking the
+     * calendar → time-field focus order.
+     *
+     * `closeOnSelect: false` keeps the popover open after a date is picked, so the user can set
+     * the time in the same session (the date atom defaults to closing on select).
+     *
+     * @returns {Record<string, unknown>}
+     */
+    extractDateParcel(): Record<string, unknown>;
+    /**
+     * Derive the parcel forwarded to the composed `FuroTimeField`.
+     * Strips molecule-only keys, then re-applies the time-scoped value and cross-field bounds.
+     * Optional value attributes are omitted when `null` (F-3 parity).
+     *
+     * @returns {Record<string, unknown>}
+     */
+    extractTimeParcel(): Record<string, unknown>;
+    /**
+     * Strip Furo-only molecule parcel keys, leaving only consumer passthrough attributes.
+     *
+     * @returns {Record<string, unknown>}
+     */
+    stripFuroParcelKeys(): Record<string, unknown>;
+    /**
+     * Extract the date part of a combined datetime bound for the date atom.
+     *
+     * @param {{
+     *   bound: string | null
+     * }} params - Parameters of this method.
+     * @returns {string | null}
+     */
+    extractDateBound({ bound, }: {
+        bound: string | null;
+    }): string | null;
+    /**
+     * Cross-field minimum TIME bound (Q3): applies only when the selected date equals the
+     * minimum date; otherwise the full day is allowed (`null`).
+     *
+     * @returns {string | null}
+     */
+    extractTimeMinBound(): string | null;
+    /**
+     * Cross-field maximum TIME bound (Q3): applies only when the selected date equals the
+     * maximum date; otherwise the full day is allowed (`null`).
+     *
+     * @returns {string | null}
+     */
+    extractTimeMaxBound(): string | null;
+    /**
+     * Resolve a cross-field time bound: the bound's time part applies only when the currently
+     * selected date equals the bound's date part (Q3). Returns `null` (full day) otherwise.
+     *
+     * @param {{
+     *   bound: string | null
+     * }} params - Parameters of this method.
+     * @returns {string | null}
+     */
+    extractCrossFieldTimeBound({ bound, }: {
+        bound: string | null;
+    }): string | null;
+    /**
+     * Build a custom event carrying the combined value for the emit payload.
+     *
+     * @param {{
+     *   name: string
+     *   value: string | null
+     * }} params - Parameters of this method.
+     * @returns {CustomEvent<{
+     *   target: HTMLElement | null
+     *   value: string | null
+     *   datePart: string | null
+     *   timePart: string | null
+     * }>}
+     */
+    buildCustomEvent({ name, value, }: {
+        name: string;
+        value: string | null;
+    }): CustomEvent<{
+        target: HTMLElement | null;
+        value: string | null;
+        datePart: string | null;
+        timePart: string | null;
+    }>;
+    /**
+     * Respond to the composed date atom's `update:value`.
+     * Updates the date part, preserves the existing time part, and re-emits the trio.
+     *
+     * @param {{
+     *   value: string | null
+     * }} params - Parameters of this method.
+     */
+    onDateChange({ value, }: {
+        value: string | null;
+    }): void;
+    /**
+     * Reconcile the time part after a date change. Clearing the date (the footer Clear button,
+     * with `preventDeselect` on) also clears the time so the whole value resets; selecting a
+     * date fabricates the default time when none is set yet.
+     */
+    syncTimeWithDateSelection(): void;
+    /**
+     * Fabricate a default time (`12:00:00`) the first time a date is selected without an
+     * existing time, so the combined value becomes complete immediately while the popover stays
+     * open for the user to refine the time. No-op when no date is set or a time already exists.
+     */
+    applyDefaultTimeOnDateSelection(): void;
+    /**
+     * Respond to the composed time atom's `update:value`.
+     * Updates the time part, preserves the existing date part, and re-emits the trio.
+     *
+     * @param {{
+     *   value: string | null
+     * }} params - Parameters of this method.
+     */
+    onTimeChange({ value, }: {
+        value: string | null;
+    }): void;
+    /**
+     * Recombine the current parts and emit `change-value`, `update:value`, `commit-value`.
+     * Emits `null` until both parts are present (Q2).
+     */
+    emitCombinedValue(): void;
+}
+export type FuroDateTimePickerContextParams = import("../../../contexts/BaseFuroContext.js").BaseFuroContextParams & {
+    props: Props;
+    componentContext: ComponentContext;
+    refHash: {
+        rootElementRef: import("vue").Ref<HTMLElement | null>;
+        datePartRef: import("vue").Ref<string | null>;
+        timePartRef: import("vue").Ref<string | null>;
+    };
+};
+export type FuroDateTimePickerContextFactoryParams = Omit<FuroDateTimePickerContextParams, "refHash"> & {
+    refHash?: {
+        rootElementRef: import("vue").Ref<HTMLElement | null>;
+        datePartRef: import("vue").Ref<string | null>;
+        timePartRef: import("vue").Ref<string | null>;
+    };
+};
+export type EmitEventName = keyof typeof FuroDateTimePickerContext.EMIT_EVENT_NAME;
+export type Props = import("vue").HTMLAttributes & {
+    parcel?: DateTimePickerParcel | null;
+};
+export type DateTimePickerParcel = Record<string, unknown> & {
+    value?: string | null;
+    invalid?: boolean;
+    placeholder?: string | null;
+    disabled?: boolean;
+    minValue?: string | null;
+    maxValue?: string | null;
+    timezone?: string | null;
+    granularity?: "hour" | "minute" | "second" | null;
+    step?: number | null;
+    timeFormat?: number | null;
+};
+export type ComponentContext = import("vue").SetupContext<FuroDateTimePickerEmitHash>;
+export type FuroDateTimePickerEmitHash = typeof FuroDateTimePickerContext.EMIT_EVENT_HASH;
+export type FuroDateTimePickerSetup = (props: Props, componentContext: ComponentContext) => {
+    context: FuroDateTimePickerContext;
+};
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js';
+import DateTimePickerEmitPayload from './DateTimePickerEmitPayload.js';

package/types/generated/components/molecules/FuroDropdownMenu/DropdownMenuOptionSelectEmitPayload.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Emit payload for FuroDropdownMenu option selection.
+ *
+ * @extends {BaseEmitPayload<Event, HTMLElement>}
+ */
+export default class DropdownMenuOptionSelectEmitPayload extends BaseEmitPayload<Event, HTMLElement> {
+    /**
+     * Factory method.
+     *
+     * @template {X extends typeof DropdownMenuOptionSelectEmitPayload ? X : never} T, X
+     * @override
+     * @param {DropdownMenuOptionSelectEmitPayloadFactoryParams} params
+     * @returns {InstanceType<T>}
+     * @this {T}
+     */
+    static override create<T extends X extends typeof DropdownMenuOptionSelectEmitPayload ? X : never, X>(this: T, { rawEvent, option, }: DropdownMenuOptionSelectEmitPayloadFactoryParams): InstanceType<T>;
+    /**
+     * Constructor.
+     *
+     * @param {DropdownMenuOptionSelectEmitPayloadParams} params
+     */
+    constructor({ rawEvent, option, }: DropdownMenuOptionSelectEmitPayloadParams);
+    option: FuroDropdownMenuOption;
+    /**
+     * Whether the native event called preventDefault().
+     *
+     * @returns {boolean}
+     */
+    isDefaultPrevented(): boolean;
+}
+export type FuroDropdownMenuOptionType = "action" | "checkbox" | "submenu";
+export type FuroDropdownMenuOption = {
+    label?: string;
+    value?: string;
+    disabled?: boolean;
+    separator?: boolean;
+    variant?: "default" | "destructive";
+    type?: FuroDropdownMenuOptionType;
+    checked?: boolean;
+    keepOpen?: boolean;
+    options?: Array<FuroDropdownMenuOption>;
+};
+export type DropdownMenuOptionSelectEmitPayloadParams = {
+    rawEvent: Event;
+    option: FuroDropdownMenuOption;
+};
+export type DropdownMenuOptionSelectEmitPayloadFactoryParams = DropdownMenuOptionSelectEmitPayloadParams;
+import BaseEmitPayload from '../../../emit-payload/BaseEmitPayload.js';