@vobs/ui 0.3.0 → 1.1.0

package/dist/forms.d.ts

@@ -1,378 +0,0 @@
-/** @license MIT
- * Copyright (c) 2026 vobsjs
- * @vobs/ui
- */
-import { type FormFieldRenderControl, type FormFieldSchemaRecord, type FormFieldViewItem, type FormInstance, type FormRenderer, type FormRendererOptions, type FormSchema, type FormValues, type FormView } from '@vobs/forms';
-import { type UiAttributes, type UiDomPlan } from './primitives.js';
-export type UiInputSelectionOrientation = 'horizontal' | 'vertical';
-export type UiSliderMode = 'range' | 'single';
-export interface UiSliderMark {
-    readonly value: number;
-    readonly label?: string;
-}
-export interface UiSliderPlanOptions {
-    readonly id: string;
-    readonly name?: string;
-    readonly label?: string;
-    readonly value: number | readonly [number, number];
-    readonly min?: number;
-    readonly max?: number;
-    readonly step?: number;
-    readonly disabled?: boolean;
-    readonly readonly?: boolean;
-    readonly valueText?: string | readonly [string, string];
-    readonly marks?: readonly UiSliderMark[];
-    readonly orientation?: UiInputSelectionOrientation;
-    readonly className?: string;
-    readonly attrs?: UiAttributes;
-}
-export interface UiSliderPlans {
-    readonly root: UiDomPlan<'div'>;
-    readonly track: UiDomPlan<'div'>;
-    readonly range: UiDomPlan<'span'>;
-    readonly thumbs: readonly UiDomPlan<'input'>[];
-    readonly marks: readonly UiDomPlan<'span'>[];
-}
-export type UiSliderTooltipVisibilityState = 'hidden' | 'partial' | 'visible';
-export type UiSliderFormatState = 'formatted' | 'raw';
-export type UiSliderFilterSummaryState = 'empty' | 'ready';
-export interface UiSliderTooltipFormatterStateContractOptions {
-    readonly id: string;
-    readonly value: number | readonly [number, number];
-    readonly min?: number;
-    readonly max?: number;
-    readonly tooltipVisible?: boolean | readonly [boolean, boolean];
-    readonly formattedValue?: string | readonly [string, string];
-    readonly filterSummary?: string;
-}
-export interface UiSliderTooltipFormatterThumbContract {
-    readonly id: string;
-    readonly value: number;
-    readonly formattedValue: string;
-    readonly tooltipVisible: boolean;
-    readonly attrs: UiAttributes;
-    readonly tooltipAttrs: UiAttributes;
-}
-export interface UiSliderTooltipFormatterStateContract {
-    readonly mode: UiSliderMode;
-    readonly tooltipState: UiSliderTooltipVisibilityState;
-    readonly formatState: UiSliderFormatState;
-    readonly filterSummaryState: UiSliderFilterSummaryState;
-    readonly tooltipVisibleCount: number;
-    readonly formattedValues: readonly [string, string];
-    readonly valueText: string | readonly [string, string];
-    readonly filterSummary: string;
-    readonly attrs: UiAttributes;
-    readonly thumbs: readonly UiSliderTooltipFormatterThumbContract[];
-}
-export interface UiSelectionOption {
-    readonly id: string;
-    readonly label: string;
-    readonly value: string;
-    readonly description?: string;
-    readonly disabled?: boolean;
-    readonly icon?: boolean;
-}
-export interface UiSegmentedPlanOptions {
-    readonly id: string;
-    readonly options: readonly UiSelectionOption[];
-    readonly value?: string;
-    readonly label?: string;
-    readonly orientation?: UiInputSelectionOrientation;
-    readonly disabled?: boolean;
-    readonly className?: string;
-    readonly attrs?: UiAttributes;
-}
-export interface UiSegmentedPlans {
-    readonly root: UiDomPlan<'div'>;
-    readonly items: readonly UiDomPlan<'button'>[];
-    readonly icons: readonly (UiDomPlan<'span'> | undefined)[];
-}
-export type UiSegmentedOverflowState = 'empty' | 'expanded' | 'overflow';
-export type UiSegmentedWrapState = 'nowrap' | 'wrapped';
-export interface UiSegmentedResponsiveStateContractOptions {
-    readonly options: readonly UiSelectionOption[];
-    readonly iconIds?: readonly string[];
-    readonly visibleIds?: readonly string[];
-    readonly overflowIds?: readonly string[];
-    readonly wrapped?: boolean;
-}
-export interface UiSegmentedResponsiveItemContract {
-    readonly id: string;
-    readonly option: UiSelectionOption;
-    readonly icon: boolean;
-    readonly visible: boolean;
-    readonly overflow: boolean;
-    readonly attrs: UiAttributes;
-}
-export interface UiSegmentedResponsiveStateContract {
-    readonly overflowState: UiSegmentedOverflowState;
-    readonly wrapState: UiSegmentedWrapState;
-    readonly itemCount: number;
-    readonly iconCount: number;
-    readonly visibleCount: number;
-    readonly overflowCount: number;
-    readonly iconIds: readonly string[];
-    readonly visibleIds: readonly string[];
-    readonly overflowIds: readonly string[];
-    readonly attrs: UiAttributes;
-    readonly items: readonly UiSegmentedResponsiveItemContract[];
-}
-export interface UiChoiceGroupPlanOptions {
-    readonly id: string;
-    readonly name: string;
-    readonly legend: string;
-    readonly options: readonly UiSelectionOption[];
-    readonly value?: string;
-    readonly values?: ReadonlySet<string> | readonly string[];
-    readonly indeterminateValues?: ReadonlySet<string> | readonly string[];
-    readonly orientation?: UiInputSelectionOrientation;
-    readonly disabled?: boolean;
-    readonly className?: string;
-    readonly attrs?: UiAttributes;
-}
-export interface UiChoiceGroupPlans {
-    readonly root: UiDomPlan<'fieldset'>;
-    readonly legend: UiDomPlan<'legend'>;
-    readonly options: readonly UiDomPlan<'label'>[];
-    readonly inputs: readonly UiDomPlan<'input'>[];
-    readonly descriptions: readonly (UiDomPlan<'span'> | undefined)[];
-}
-export type UiChoiceGroupCardState = 'cards' | 'empty' | 'partial' | 'plain';
-export type UiChoiceGroupCardOptionState = 'disabled' | 'idle' | 'selected';
-export type UiChoiceGroupCardActionState = 'disabled' | 'hidden' | 'ready';
-export type UiChoiceGroupCardDescriptionState = 'hidden' | 'visible';
-export interface UiChoiceGroupCardOptionStateContractOptions {
-    readonly type: 'checkbox' | 'radio';
-    readonly options: readonly UiSelectionOption[];
-    readonly value?: string;
-    readonly values?: ReadonlySet<string> | readonly string[];
-    readonly cardIds?: readonly string[];
-    readonly selectedEmphasisIds?: readonly string[];
-    readonly disabledEmphasisIds?: readonly string[];
-    readonly descriptionIds?: readonly string[];
-    readonly actionIds?: readonly string[];
-    readonly actionDisabledIds?: readonly string[];
-}
-export interface UiChoiceGroupCardOptionContract {
-    readonly id: string;
-    readonly option: UiSelectionOption;
-    readonly state: UiChoiceGroupCardOptionState;
-    readonly actionState: UiChoiceGroupCardActionState;
-    readonly descriptionState: UiChoiceGroupCardDescriptionState;
-    readonly card: boolean;
-    readonly selectedEmphasis: boolean;
-    readonly disabledEmphasis: boolean;
-    readonly attrs: UiAttributes;
-    readonly actionAttrs: UiAttributes;
-}
-export interface UiChoiceGroupCardOptionStateContract {
-    readonly type: 'checkbox' | 'radio';
-    readonly state: UiChoiceGroupCardState;
-    readonly optionCount: number;
-    readonly cardCount: number;
-    readonly selectedEmphasisCount: number;
-    readonly disabledEmphasisCount: number;
-    readonly descriptionCount: number;
-    readonly actionCount: number;
-    readonly actionDisabledCount: number;
-    readonly cardIds: readonly string[];
-    readonly selectedEmphasisIds: readonly string[];
-    readonly disabledEmphasisIds: readonly string[];
-    readonly descriptionIds: readonly string[];
-    readonly actionIds: readonly string[];
-    readonly actionDisabledIds: readonly string[];
-    readonly attrs: UiAttributes;
-    readonly items: readonly UiChoiceGroupCardOptionContract[];
-}
-export type UiChoiceGroupBulkSelectionState = 'all' | 'disabled' | 'empty' | 'none' | 'partial';
-export type UiChoiceGroupBulkSelectAllState = 'checked' | 'disabled' | 'mixed' | 'unchecked';
-export interface UiChoiceGroupBulkSelectionContractOptions {
-    readonly id: string;
-    readonly type: 'checkbox' | 'radio';
-    readonly options: readonly UiSelectionOption[];
-    readonly value?: string;
-    readonly values?: ReadonlySet<string> | readonly string[];
-    readonly indeterminateValues?: ReadonlySet<string> | readonly string[];
-    readonly disabled?: boolean;
-    readonly disabledReason?: string;
-    readonly selectAllLabel?: string;
-}
-export interface UiChoiceGroupBulkSelectionOptionContract {
-    readonly id: string;
-    readonly value: string;
-    readonly checked: boolean;
-    readonly indeterminate: boolean;
-    readonly disabled: boolean;
-    readonly attrs: UiAttributes;
-}
-export interface UiChoiceGroupBulkSelectionContract {
-    readonly type: 'checkbox' | 'radio';
-    readonly state: UiChoiceGroupBulkSelectionState;
-    readonly selectAllState: UiChoiceGroupBulkSelectAllState;
-    readonly totalCount: number;
-    readonly enabledCount: number;
-    readonly checkedCount: number;
-    readonly indeterminateCount: number;
-    readonly checkedIds: readonly string[];
-    readonly indeterminateIds: readonly string[];
-    readonly nextCheckedIds: readonly string[];
-    readonly disabledReason: string;
-    readonly canSelectAll: boolean;
-    readonly attrs: UiAttributes;
-    readonly selectAllAttrs: UiAttributes;
-    readonly optionContracts: readonly UiChoiceGroupBulkSelectionOptionContract[];
-}
-export interface UiFormOptions<Fields extends FormFieldSchemaRecord> {
-    readonly id: string;
-    readonly initialValues?: Partial<FormValues<Fields>>;
-    readonly renderer?: FormRendererOptions<Fields>;
-    readonly descriptions?: Partial<Record<keyof Fields & string, string>>;
-}
-export interface UiForm<Fields extends FormFieldSchemaRecord> {
-    readonly form: FormInstance<Fields>;
-    readonly renderer: FormRenderer<Fields>;
-    readonly view: FormView<Fields>;
-    readonly root: UiDomPlan<'form'>;
-    readonly fields: readonly UiFormFieldPlan[];
-    readonly errorSummary: UiErrorSummaryPlan;
-    submit(callback: (values: FormValues<Fields>) => void | Promise<void>): Promise<boolean>;
-}
-export interface UiFormFieldPlan {
-    readonly name: string;
-    readonly label: string;
-    readonly control: FormFieldRenderControl;
-    readonly root: UiDomPlan<'div'>;
-    readonly labelPlan: UiDomPlan<'label'>;
-    readonly description?: UiDomPlan<'p'>;
-    readonly descriptionText?: string;
-    readonly controlPlan: UiDomPlan;
-    readonly error: UiDomPlan<'p'>;
-    readonly errorText: string;
-}
-export interface UiErrorSummaryPlan {
-    readonly root: UiDomPlan<'div'>;
-    readonly title: UiDomPlan<'h2'>;
-    readonly items: readonly UiErrorSummaryItemPlan[];
-}
-export interface UiErrorSummaryItemPlan {
-    readonly id: string;
-    readonly href: string;
-    readonly controlId: string;
-    readonly message: string;
-}
-export type UiServerErrors<Fields extends FormFieldSchemaRecord> = Partial<Record<keyof Fields & string, string | readonly string[]>>;
-export type UiFormDrawerSubmissionMode = 'create' | 'edit';
-export type UiFormDrawerSubmissionState = 'dirty' | 'disabled' | 'idle' | 'invalid' | 'server-error' | 'submitting' | 'success';
-export interface UiFormDrawerSubmissionContractOptions<Fields extends FormFieldSchemaRecord> {
-    readonly view: FormView<Fields>;
-    readonly drawerId: string;
-    readonly mode?: UiFormDrawerSubmissionMode;
-    readonly open?: boolean;
-    readonly dirty?: boolean;
-    readonly disabled?: boolean;
-    readonly submitting?: boolean;
-    readonly success?: boolean;
-    readonly serverErrorCount?: number;
-    readonly submitIntent?: string;
-    readonly cancelIntent?: string;
-}
-export interface UiFormDrawerSubmissionContract {
-    readonly drawerId: string;
-    readonly mode: UiFormDrawerSubmissionMode;
-    readonly state: UiFormDrawerSubmissionState;
-    readonly open: boolean;
-    readonly dirty: boolean;
-    readonly disabled: boolean;
-    readonly submitting: boolean;
-    readonly invalid: boolean;
-    readonly success: boolean;
-    readonly errorCount: number;
-    readonly serverErrorCount: number;
-    readonly canSubmit: boolean;
-    readonly focusTarget: string;
-    readonly attrs: UiAttributes;
-    readonly submitAttrs: UiAttributes;
-    readonly cancelAttrs: UiAttributes;
-}
-export declare function createFormDrawerSubmissionContract<Fields extends FormFieldSchemaRecord>(options: UiFormDrawerSubmissionContractOptions<Fields>): UiFormDrawerSubmissionContract;
-export declare function createSliderPlans(options: UiSliderPlanOptions): UiSliderPlans;
-export declare function getNextSliderValue(value: number, key: string, options?: Pick<UiSliderPlanOptions, 'max' | 'min' | 'step'>): number;
-export declare function createSliderTooltipFormatterStateContract(options: UiSliderTooltipFormatterStateContractOptions): UiSliderTooltipFormatterStateContract;
-export declare function createSegmentedPlans(options: UiSegmentedPlanOptions): UiSegmentedPlans;
-export declare function getNextSegmentedValue(options: readonly UiSelectionOption[], value: string | undefined, key: string, orientation?: UiInputSelectionOrientation): string | undefined;
-export declare function createSegmentedResponsiveStateContract(options: UiSegmentedResponsiveStateContractOptions): UiSegmentedResponsiveStateContract;
-export declare function createRadioGroupPlans(options: UiChoiceGroupPlanOptions): UiChoiceGroupPlans;
-export declare function createCheckboxGroupPlans(options: UiChoiceGroupPlanOptions): UiChoiceGroupPlans;
-export declare function getNextRadioGroupValue(options: readonly UiSelectionOption[], value: string | undefined, key: string, orientation?: UiInputSelectionOrientation): string | undefined;
-export declare function toggleCheckboxGroupValue(values: ReadonlySet<string>, value: string): ReadonlySet<string>;
-export declare function createChoiceGroupCardOptionStateContract(options: UiChoiceGroupCardOptionStateContractOptions): UiChoiceGroupCardOptionStateContract;
-export declare function createChoiceGroupBulkSelectionContract(options: UiChoiceGroupBulkSelectionContractOptions): UiChoiceGroupBulkSelectionContract;
-export declare function createFormUi<const Fields extends FormFieldSchemaRecord>(schema: FormSchema<Fields>, options: UiFormOptions<Fields>): UiForm<Fields>;
-export declare function createFormUiFromView<const Fields extends FormFieldSchemaRecord>(view: FormView<Fields>, options: Pick<UiFormOptions<Fields>, 'descriptions' | 'id'>): UiForm<Fields>;
-export declare function applyFormServerErrors<Fields extends FormFieldSchemaRecord>(view: FormView<Fields>, errors: UiServerErrors<Fields>): void;
-export declare function readFirstErrorFocusTarget<Fields extends FormFieldSchemaRecord>(view: FormView<Fields>): string | undefined;
-export declare function createFormRootPlan<Fields extends FormFieldSchemaRecord>(view: FormView<Fields>): UiDomPlan<'form'>;
-export declare function createErrorSummaryPlan<Fields extends FormFieldSchemaRecord>(view: FormView<Fields>): UiErrorSummaryPlan;
-export declare function createFormFieldPlan(item: FormFieldViewItem, description: string | undefined): UiFormFieldPlan;
-/**
- * Setting Row plans — settings panel: groups (label + panel); each row = title/description + control.
- * Spec source: UIStyle/preview/component-setting-row.html (ds-settingrow).
- */
-export type SettingRowControlKind = 'select' | 'button' | 'icon-button';
-export interface SettingRowPlanOptions {
-    readonly id: string;
-    readonly title: string;
-    readonly description?: string;
-    /** Control kind (default 'select'). */
-    readonly control?: SettingRowControlKind;
-    /** Control text (shown on select/button). */
-    readonly controlLabel?: string;
-    /** Danger button (btn--danger style). */
-    readonly danger?: boolean;
-    readonly disabled?: boolean;
-    readonly className?: string;
-    readonly attrs?: UiAttributes;
-}
-export interface SettingRowPlans {
-    readonly root: UiDomPlan<'div'>;
-    readonly main: UiDomPlan<'div'>;
-    readonly title: UiDomPlan<'span'>;
-    readonly description: UiDomPlan<'span'>;
-    /** Control: select shape (button + chevron) or a plain button. */
-    readonly control: UiDomPlan<'button'>;
-}
-export interface SettingRowGroupInput {
-    readonly id: string;
-    readonly label: string;
-    readonly rows: readonly SettingRowPlanOptions[];
-}
-export interface SettingRowGroupPlans extends UiDomPlan<'div'> {
-    readonly groupId: string;
-    readonly groupLabel: UiDomPlan<'span'>;
-    readonly panel: UiDomPlan<'div'>;
-    readonly rows: readonly SettingRowPlans[];
-}
-export declare function createSettingRowPlans(options: SettingRowPlanOptions): SettingRowPlans;
-export declare function createSettingRowGroupPlans(options: SettingRowGroupInput): SettingRowGroupPlans;
-/**
- * Rate plans — star-rating input.
- * Spec source: common enterprise-backend component set (no UIStyle spec, this is an out-of-spec component).
- */
-export interface RatePlans {
-    readonly root: UiDomPlan<'div'>;
-    /** Star buttons (max items), with data-index + data-state (active/disabled). */
-    readonly stars: readonly UiDomPlan<'button'>[];
-}
-export interface RatePlanOptions {
-    readonly id: string;
-    /** Current value (1..max). */
-    readonly value?: number;
-    /** Star count (default 5). */
-    readonly max?: number;
-    readonly disabled?: boolean;
-    readonly readonly?: boolean;
-    readonly className?: string;
-    readonly attrs?: UiAttributes;
-}
-export declare function createRatePlans(options: RatePlanOptions): RatePlans;