@samline/forms 2.4.0 → 2.7.0

package/dist/index.d.cts

@@ -1,167 +1,13 @@
-type FormatType = 'general' | 'phone' | 'numeral' | 'date' | 'time' | 'creditCard' | 'creditCardType';
-interface FieldFormatConfig {
-    /** One of the supported `@samline/formatter` `FormatType` values. */
-    type: FormatType;
-    /**
-     * Canonical name of the formatted field. The value the backend
-     * ultimately receives (the `raw` output of the formatter) is
-     * exposed under this name; the formatter is responsible for
-     * keeping it in sync with the visible input.
-     */
-    field: string | string[];
-    /**
-     * Name of the visible input that shows the formatted value to
-     * the user. Defaults to `${fieldName}_displayed`.
-     *
-     * The visible is **renamed** from `field` to `displayField` on
-     * the first `format()` call (idempotent on re-binding). A hidden
-     * `<input type="hidden" name="<field>">` is created next to it
-     * to carry the raw value. Both names are first-class in the
-     * controller's API (`getValue`, `getField`, `setValue`, `watch`,
-     * `getData`) — see `docs/api/format.md` for the full contract.
-     */
-    displayField?: string;
-    /**
-     * Format-specific options forwarded to `@samline/formatter`.
-     * Any key documented for the chosen `type` is accepted (e.g.
-     * `country`, `delimiter`, `numeralDecimalMark`, `datePattern`).
-     */
-    options?: Record<string, unknown>;
-}
-type FieldFormatConfigMap = Record<string, FieldFormatConfig>;
-type FormDataPrimitive = FormDataEntryValue;
-type SerializedFormValue = FormDataPrimitive | FormDataPrimitive[];
-type FormFieldValue = string | string[] | File[] | undefined;
-type FormValues = Record<string, FormFieldValue>;
-type FormErrors = Record<string, string[]>;
-type RuleConfig<T> = T | {
-    value: T;
-    message?: string;
-};
-interface FieldValidationContext {
-    field: string;
-    value: FormFieldValue;
-    values: FormValues;
-}
-type FieldValidator = (context: FieldValidationContext) => string | undefined | null | false | true;
-interface FieldValidationRules {
-    required?: RuleConfig<boolean>;
-    minLength?: RuleConfig<number>;
-    maxLength?: RuleConfig<number>;
-    pattern?: RuleConfig<RegExp>;
-    validate?: FieldValidator | FieldValidator[];
-}
-type ValidationSchema = Record<string, FieldValidationRules>;
-interface VisualAttributes {
-    filled: string;
-    error: string;
-}
-interface AutoSubmitOptions {
-    debounce?: number;
-}
-interface FormControllerOptions {
-    attributes?: Partial<VisualAttributes>;
-    autoValidate?: boolean;
-    autoSubmit?: boolean | AutoSubmitOptions;
-    clearManualErrorsOnChange?: boolean;
-    clearErrorsOnSubmit?: boolean;
-    validators?: ValidationSchema;
-    /**
-     * Declarative format configuration. Each entry is applied during
-     * `form()` initialization using the same logic as `controller.format(...)`.
-     * The key is just an identifier — the visible field name lives in
-     * `FieldFormatConfig.field`.
-     */
-    formats?: FieldFormatConfigMap;
-}
-interface SerializedFormResult {
-    data: Record<string, SerializedFormValue>;
-    formData: FormData;
-}
-interface ValidationResult {
-    isValid: boolean;
-    errors: FormErrors;
-}
-interface FormStateSnapshot {
-    values: FormValues;
-    errors: FormErrors;
-    filledFields: string[];
-    isValid: boolean;
-    isValidated: boolean;
-    autoSubmit: boolean;
-    submitCount: number;
-}
-type FormStateListener = (state: FormStateSnapshot) => void;
-type FormFieldElement = HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement;
-type FormTarget = string | HTMLFormElement | {
-    current: HTMLFormElement | null;
-} | null | undefined;
-interface AppendContentOptions {
-    tag: keyof HTMLElementTagNameMap;
-    content: string;
-    class?: string;
-    atStart?: boolean;
-}
-type FormFieldWatcher = (value: FormFieldValue, field: FormFieldElement | FormFieldElement[] | null, form: HTMLFormElement, state: FormStateSnapshot) => void;
-type FormSubmitHandler = (form: HTMLFormElement, data: Record<string, SerializedFormValue>, formData: FormData, state: FormStateSnapshot) => void;
-interface FormController {
-    readonly element: HTMLFormElement | null;
-    readonly f: HTMLFormElement | null;
-    readonly options: FormControllerOptions;
-    onSubmit: (callback: FormSubmitHandler, preventDefault?: boolean) => FormController;
-    watch: (field: string, callback: FormFieldWatcher) => FormController;
-    observe: (field: string, callback: FormFieldWatcher) => () => void;
-    unwatch: (field?: string, callback?: FormFieldWatcher) => FormController;
-    subscribe: (listener: FormStateListener) => () => void;
-    prefill: (fieldName?: string) => FormController;
-    append: (options: AppendContentOptions) => HTMLElement | null;
-    setErrors: (fields: string[] | FormErrors) => FormController;
-    clearErrors: (fields?: string[]) => FormController;
-    setValue: (name: string, value: unknown) => FormController;
-    validate: (fields?: string[]) => ValidationResult;
-    revalidate: (fields?: string[]) => ValidationResult;
-    /**
-     * Apply the same `@samline/formatter` pipeline to a single field or
-     * to a list of fields sharing one configuration. Chainable.
-     *
-     * Requires the optional peer dependency `@samline/formatter`. When
-     * the peer is not installed the call logs a single `console.error`
-     * and returns the controller unchanged.
-     */
-    format: (config: FieldFormatConfig) => FormController;
-    formatAll: (config: FieldFormatConfig) => FormController;
-    reset: () => FormController;
-    autoSubmit: (options?: boolean | AutoSubmitOptions) => FormController;
-    disableAutoSubmit: () => FormController;
-    getValue: (name: string) => FormFieldValue;
-    getField: (name: string) => FormFieldElement | FormFieldElement[] | null;
-    getData: () => SerializedFormResult;
-    getState: () => FormStateSnapshot;
-    destroy: () => void;
-}
+import { F as FormTarget, a as FormControllerOptions, b as FormController, S as SerializedFormResult, c as FormFieldValue, d as FieldValidationRules, e as FormValues, V as ValidationSchema, f as ValidationResult } from './registry-GzopYPCR.cjs';
+export { A as AppendContentOptions, g as AutoSubmitOptions, h as FieldFormatConfig, i as FieldFormatConfigMap, j as FieldValidationContext, k as FieldValidator, l as FormCleanup, m as FormDataPrimitive, n as FormErrors, o as FormFieldElement, p as FormFieldWatcher, q as FormStateListener, r as FormStateSnapshot, s as FormSubmitHandler, t as FormatType, u as FormsApi, v as FormsAvailable, N as NewFormInput, R as RuleConfig, w as SerializedFormValue, x as ValueValidationRules, y as VisualAttributes, z as browser } from './registry-GzopYPCR.cjs';
 
 declare const form: (target: FormTarget, options?: FormControllerOptions) => FormController;
 
 declare const createFormController: (target: FormTarget, options?: FormControllerOptions) => FormController;
 
-interface NewFormInput {
-    id: string;
-    options?: FormControllerOptions;
-}
-interface FormsAvailable {
-    [id: string]: FormController;
-}
-interface FormsApi {
-    form: (target: FormTarget, options?: FormControllerOptions) => FormController;
-    newForm: (input: NewFormInput) => FormController | undefined;
-    destroyForm: (id: string) => void;
-    available: FormsAvailable;
-}
-declare const browser: FormsApi;
-
-declare const parseFormData: (formElement: HTMLFormElement) => SerializedFormResult;
+declare const parseFormData: (formElement: HTMLFormElement, submitter?: HTMLElement | null) => SerializedFormResult;
 
 declare const validateFieldValue: (field: string, value: FormFieldValue, rules: FieldValidationRules, values: FormValues) => string[];
 declare const validateValues: (values: FormValues, schema: ValidationSchema) => ValidationResult;
 
-export { type AppendContentOptions, type AutoSubmitOptions, type FieldFormatConfig, type FieldFormatConfigMap, type FieldValidationContext, type FieldValidationRules, type FieldValidator, type FormController, type FormControllerOptions, type FormErrors, type FormFieldElement, type FormFieldValue, type FormStateListener, type FormStateSnapshot, type FormSubmitHandler, type FormTarget, type FormValues, type FormatType, type FormsApi, type FormsAvailable, type NewFormInput, type RuleConfig, type SerializedFormResult, type SerializedFormValue, type ValidationResult, type ValidationSchema, type VisualAttributes, browser, createFormController, form, parseFormData, validateFieldValue, validateValues };
+export { FieldValidationRules, FormController, FormControllerOptions, FormFieldValue, FormTarget, FormValues, SerializedFormResult, ValidationResult, ValidationSchema, createFormController, form, parseFormData, validateFieldValue, validateValues };

package/dist/index.d.ts

@@ -1,167 +1,13 @@
-type FormatType = 'general' | 'phone' | 'numeral' | 'date' | 'time' | 'creditCard' | 'creditCardType';
-interface FieldFormatConfig {
-    /** One of the supported `@samline/formatter` `FormatType` values. */
-    type: FormatType;
-    /**
-     * Canonical name of the formatted field. The value the backend
-     * ultimately receives (the `raw` output of the formatter) is
-     * exposed under this name; the formatter is responsible for
-     * keeping it in sync with the visible input.
-     */
-    field: string | string[];
-    /**
-     * Name of the visible input that shows the formatted value to
-     * the user. Defaults to `${fieldName}_displayed`.
-     *
-     * The visible is **renamed** from `field` to `displayField` on
-     * the first `format()` call (idempotent on re-binding). A hidden
-     * `<input type="hidden" name="<field>">` is created next to it
-     * to carry the raw value. Both names are first-class in the
-     * controller's API (`getValue`, `getField`, `setValue`, `watch`,
-     * `getData`) — see `docs/api/format.md` for the full contract.
-     */
-    displayField?: string;
-    /**
-     * Format-specific options forwarded to `@samline/formatter`.
-     * Any key documented for the chosen `type` is accepted (e.g.
-     * `country`, `delimiter`, `numeralDecimalMark`, `datePattern`).
-     */
-    options?: Record<string, unknown>;
-}
-type FieldFormatConfigMap = Record<string, FieldFormatConfig>;
-type FormDataPrimitive = FormDataEntryValue;
-type SerializedFormValue = FormDataPrimitive | FormDataPrimitive[];
-type FormFieldValue = string | string[] | File[] | undefined;
-type FormValues = Record<string, FormFieldValue>;
-type FormErrors = Record<string, string[]>;
-type RuleConfig<T> = T | {
-    value: T;
-    message?: string;
-};
-interface FieldValidationContext {
-    field: string;
-    value: FormFieldValue;
-    values: FormValues;
-}
-type FieldValidator = (context: FieldValidationContext) => string | undefined | null | false | true;
-interface FieldValidationRules {
-    required?: RuleConfig<boolean>;
-    minLength?: RuleConfig<number>;
-    maxLength?: RuleConfig<number>;
-    pattern?: RuleConfig<RegExp>;
-    validate?: FieldValidator | FieldValidator[];
-}
-type ValidationSchema = Record<string, FieldValidationRules>;
-interface VisualAttributes {
-    filled: string;
-    error: string;
-}
-interface AutoSubmitOptions {
-    debounce?: number;
-}
-interface FormControllerOptions {
-    attributes?: Partial<VisualAttributes>;
-    autoValidate?: boolean;
-    autoSubmit?: boolean | AutoSubmitOptions;
-    clearManualErrorsOnChange?: boolean;
-    clearErrorsOnSubmit?: boolean;
-    validators?: ValidationSchema;
-    /**
-     * Declarative format configuration. Each entry is applied during
-     * `form()` initialization using the same logic as `controller.format(...)`.
-     * The key is just an identifier — the visible field name lives in
-     * `FieldFormatConfig.field`.
-     */
-    formats?: FieldFormatConfigMap;
-}
-interface SerializedFormResult {
-    data: Record<string, SerializedFormValue>;
-    formData: FormData;
-}
-interface ValidationResult {
-    isValid: boolean;
-    errors: FormErrors;
-}
-interface FormStateSnapshot {
-    values: FormValues;
-    errors: FormErrors;
-    filledFields: string[];
-    isValid: boolean;
-    isValidated: boolean;
-    autoSubmit: boolean;
-    submitCount: number;
-}
-type FormStateListener = (state: FormStateSnapshot) => void;
-type FormFieldElement = HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement;
-type FormTarget = string | HTMLFormElement | {
-    current: HTMLFormElement | null;
-} | null | undefined;
-interface AppendContentOptions {
-    tag: keyof HTMLElementTagNameMap;
-    content: string;
-    class?: string;
-    atStart?: boolean;
-}
-type FormFieldWatcher = (value: FormFieldValue, field: FormFieldElement | FormFieldElement[] | null, form: HTMLFormElement, state: FormStateSnapshot) => void;
-type FormSubmitHandler = (form: HTMLFormElement, data: Record<string, SerializedFormValue>, formData: FormData, state: FormStateSnapshot) => void;
-interface FormController {
-    readonly element: HTMLFormElement | null;
-    readonly f: HTMLFormElement | null;
-    readonly options: FormControllerOptions;
-    onSubmit: (callback: FormSubmitHandler, preventDefault?: boolean) => FormController;
-    watch: (field: string, callback: FormFieldWatcher) => FormController;
-    observe: (field: string, callback: FormFieldWatcher) => () => void;
-    unwatch: (field?: string, callback?: FormFieldWatcher) => FormController;
-    subscribe: (listener: FormStateListener) => () => void;
-    prefill: (fieldName?: string) => FormController;
-    append: (options: AppendContentOptions) => HTMLElement | null;
-    setErrors: (fields: string[] | FormErrors) => FormController;
-    clearErrors: (fields?: string[]) => FormController;
-    setValue: (name: string, value: unknown) => FormController;
-    validate: (fields?: string[]) => ValidationResult;
-    revalidate: (fields?: string[]) => ValidationResult;
-    /**
-     * Apply the same `@samline/formatter` pipeline to a single field or
-     * to a list of fields sharing one configuration. Chainable.
-     *
-     * Requires the optional peer dependency `@samline/formatter`. When
-     * the peer is not installed the call logs a single `console.error`
-     * and returns the controller unchanged.
-     */
-    format: (config: FieldFormatConfig) => FormController;
-    formatAll: (config: FieldFormatConfig) => FormController;
-    reset: () => FormController;
-    autoSubmit: (options?: boolean | AutoSubmitOptions) => FormController;
-    disableAutoSubmit: () => FormController;
-    getValue: (name: string) => FormFieldValue;
-    getField: (name: string) => FormFieldElement | FormFieldElement[] | null;
-    getData: () => SerializedFormResult;
-    getState: () => FormStateSnapshot;
-    destroy: () => void;
-}
+import { F as FormTarget, a as FormControllerOptions, b as FormController, S as SerializedFormResult, c as FormFieldValue, d as FieldValidationRules, e as FormValues, V as ValidationSchema, f as ValidationResult } from './registry-GzopYPCR.js';
+export { A as AppendContentOptions, g as AutoSubmitOptions, h as FieldFormatConfig, i as FieldFormatConfigMap, j as FieldValidationContext, k as FieldValidator, l as FormCleanup, m as FormDataPrimitive, n as FormErrors, o as FormFieldElement, p as FormFieldWatcher, q as FormStateListener, r as FormStateSnapshot, s as FormSubmitHandler, t as FormatType, u as FormsApi, v as FormsAvailable, N as NewFormInput, R as RuleConfig, w as SerializedFormValue, x as ValueValidationRules, y as VisualAttributes, z as browser } from './registry-GzopYPCR.js';
 
 declare const form: (target: FormTarget, options?: FormControllerOptions) => FormController;
 
 declare const createFormController: (target: FormTarget, options?: FormControllerOptions) => FormController;
 
-interface NewFormInput {
-    id: string;
-    options?: FormControllerOptions;
-}
-interface FormsAvailable {
-    [id: string]: FormController;
-}
-interface FormsApi {
-    form: (target: FormTarget, options?: FormControllerOptions) => FormController;
-    newForm: (input: NewFormInput) => FormController | undefined;
-    destroyForm: (id: string) => void;
-    available: FormsAvailable;
-}
-declare const browser: FormsApi;
-
-declare const parseFormData: (formElement: HTMLFormElement) => SerializedFormResult;
+declare const parseFormData: (formElement: HTMLFormElement, submitter?: HTMLElement | null) => SerializedFormResult;
 
 declare const validateFieldValue: (field: string, value: FormFieldValue, rules: FieldValidationRules, values: FormValues) => string[];
 declare const validateValues: (values: FormValues, schema: ValidationSchema) => ValidationResult;
 
-export { type AppendContentOptions, type AutoSubmitOptions, type FieldFormatConfig, type FieldFormatConfigMap, type FieldValidationContext, type FieldValidationRules, type FieldValidator, type FormController, type FormControllerOptions, type FormErrors, type FormFieldElement, type FormFieldValue, type FormStateListener, type FormStateSnapshot, type FormSubmitHandler, type FormTarget, type FormValues, type FormatType, type FormsApi, type FormsAvailable, type NewFormInput, type RuleConfig, type SerializedFormResult, type SerializedFormValue, type ValidationResult, type ValidationSchema, type VisualAttributes, browser, createFormController, form, parseFormData, validateFieldValue, validateValues };
+export { FieldValidationRules, FormController, FormControllerOptions, FormFieldValue, FormTarget, FormValues, SerializedFormResult, ValidationResult, ValidationSchema, createFormController, form, parseFormData, validateFieldValue, validateValues };