@atscript/vue-form 0.1.103 → 0.1.105

package/dist/as-form.vue-Dg_5GYWG.d.cts

@@ -1,285 +0,0 @@
-import { n as TAsChangeType, o as TAsComponentProps, s as TAsTypeComponents } from "./types-BYfe1QEF.cjs";
-import * as vue from "vue";
-import { Component } from "vue";
-import * as _atscript_ui0 from "@atscript/ui";
-import { ClientFactory, FormDef } from "@atscript/ui";
-
-//#region src/composables/types.d.ts
-type TFormRule<TValue, TFormData, TContext> = (v: TValue, data?: TFormData, context?: TContext) => boolean | string;
-interface TFormFieldCallbacks {
-  validate: () => boolean | string;
-  clearErrors: () => void;
-  reset: () => void;
-  setExternalError: (msg?: string) => void;
-}
-interface TFormFieldRegistration {
-  path: () => string;
-  callbacks: TFormFieldCallbacks;
-}
-interface TFormState {
-  firstSubmitHappened: boolean;
-  firstValidation: "on-change" | "touched-on-blur" | "on-blur" | "on-submit" | "none";
-  /**
-   * Fields registered AFTER `firstSubmitHappened` flipped to true. They stay
-   * in this set until either the user edits the field (model watch removes
-   * the id) or the next submit fires (set is cleared). Live validation is
-   * suppressed for these fields so a freshly-added array item doesn't render
-   * red required-field errors before the user has had a chance to type.
-   */
-  freshFields: Set<symbol>;
-  register: (id: symbol, registration: TFormFieldRegistration) => void;
-  unregister: (id: symbol) => void;
-}
-//#endregion
-//#region src/components/as-form.vue.d.ts
-interface Props<TF, TC> {
-  def: FormDef;
-  formData?: TF;
-  formContext?: TC;
-  firstValidation?: TFormState["firstValidation"];
-  components?: Record<string, Component<TAsComponentProps>>;
-  /**
-   * Type-to-component map for field rendering. Maps field types to Vue components.
-   * Must include entries for all built-in field types. Use `createDefaultTypes()`
-   * for a pre-filled map, or supply your own.
-   */
-  types: TAsTypeComponents;
-  errors?: Record<string, string | undefined>;
-  /**
-   * Per-form client factory override. Creates `Client` instances from URL paths
-   * for FK value-help pickers inside this form. Falls back to the app-wide
-   * default (`setDefaultClientFactory`) and then to the built-in `new Client(url)`
-   * factory when unset.
-   */
-  clientFactory?: ClientFactory;
-  /**
-   * Suppress the root field's title rendering. Use when the form is mounted
-   * inside a chrome that already shows the form's `@meta.label` (e.g. a
-   * dialog header). Nested fields keep their own headings.
-   */
-  hideRootTitle?: boolean;
-  /**
-   * Suppress the default submit button. Use when the host chrome owns the
-   * submit affordance (e.g. a dialog footer with its own submit button
-   * wired via HTML5 `<button form="...">`). Vue 3 treats an empty
-   * `<template #form.submit />` as "slot not provided" and falls back to
-   * the default button — this prop is the explicit way to skip it.
-   */
-  hideSubmit?: boolean;
-  /**
-   * When true, freezes the form: the body becomes `inert` (blocks pointer
-   * events + keyboard focus) and a loading overlay paints over the entire
-   * form area. Used by `<AsWfForm>` to lock interaction during a server
-   * round-trip so the user can't edit a field whose response is racing in.
-   * Visual is shared with `<AsTable>`'s query overlay via vunor
-   * `inner-loading`.
-   */
-  loading?: boolean;
-  /**
-   * Enable change tracking. When set, the form captures a deep-clone baseline
-   * of its data and surfaces both a changed-fields list and an `@atscript/db`
-   * patch object. The tracking surface (`isDirty` / `changes` / `getPatch` /
-   * `getChanges`) is spread into every slot AND exposed on the component
-   * instance (template ref → `asForm.value.getPatch()`); descendants read it
-   * with `useAsFormPatch()`. Off by default — zero overhead when unset.
-   */
-  trackChanges?: boolean;
-}
-declare const __VLS_export: <TFormData = any, TFormContext = any>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
-  props: vue.PublicProps & __VLS_PrettifyLocal<Props<TFormData, TFormContext> & {
-    onError?: ((errors: {
-      path: string;
-      message: string;
-    }[]) => any) | undefined;
-    onAction?: ((name: string, data: TFormData) => any) | undefined;
-    onSubmit?: ((data: TFormData) => any) | undefined;
-    "onUnsupported-action"?: ((name: string, data: TFormData) => any) | undefined;
-    onChange?: ((type: TAsChangeType, path: string, value: unknown, formData: TFormData) => any) | undefined;
-  }> & (typeof globalThis extends {
-    __VLS_PROPS_FALLBACK: infer P;
-  } ? P : {});
-  expose: (exposed: vue.ShallowUnwrapRef<{
-    submit: () => void;
-    reset: () => Promise<void>; /** True when `track-changes` is on AND data differs from baseline. */
-    readonly isDirty: boolean; /** Revert-aware per-field change list (empty when tracking is off). */
-    readonly changes: _atscript_ui0.FormFieldChange[]; /** Build the `@atscript/db` patch object on demand (`{}` when off). */
-    getPatch: ((opts?: _atscript_ui0.FormDiffOptions) => Record<string, unknown>) | (() => {}); /** Build the per-field change list on demand (`[]` when off). */
-    getChanges: () => _atscript_ui0.FormFieldChange[]; /** Re-baseline to current data after a successful save (no-op when off). */
-    rebase: () => void;
-  }>) => void;
-  attrs: any;
-  slots: {
-    'form.header'?: (props: {
-      title: string | undefined;
-      description: string | undefined;
-      data: TFormData;
-      errors: Record<string, string | undefined> | undefined;
-      formError: string | undefined;
-      disabled: boolean;
-      loading: boolean;
-      submitText: string;
-      submit: () => void;
-      reset: () => Promise<void>;
-      clearErrors: () => void;
-      setErrors: (errors: Record<string, string>) => void;
-      dismissError: (path: string) => void;
-      dismissFormError: () => void;
-      formContext: TFormContext | undefined;
-      isDirty: boolean;
-      changes: readonly _atscript_ui0.FormFieldChange[];
-      getPatch: (opts?: _atscript_ui0.FormDiffOptions) => Record<string, unknown>;
-      getChanges: () => _atscript_ui0.FormFieldChange[];
-    }) => any;
-  } & {
-    'form.before'?: (props: {
-      title: string | undefined;
-      description: string | undefined;
-      data: TFormData;
-      errors: Record<string, string | undefined> | undefined;
-      formError: string | undefined;
-      disabled: boolean;
-      loading: boolean;
-      submitText: string;
-      submit: () => void;
-      reset: () => Promise<void>;
-      clearErrors: () => void;
-      setErrors: (errors: Record<string, string>) => void;
-      dismissError: (path: string) => void;
-      dismissFormError: () => void;
-      formContext: TFormContext | undefined;
-      isDirty: boolean;
-      changes: readonly _atscript_ui0.FormFieldChange[];
-      getPatch: (opts?: _atscript_ui0.FormDiffOptions) => Record<string, unknown>;
-      getChanges: () => _atscript_ui0.FormFieldChange[];
-    }) => any;
-  } & {
-    'form.after'?: (props: {
-      title: string | undefined;
-      description: string | undefined;
-      data: TFormData;
-      errors: Record<string, string | undefined> | undefined;
-      formError: string | undefined;
-      disabled: boolean;
-      loading: boolean;
-      submitText: string;
-      submit: () => void;
-      reset: () => Promise<void>;
-      clearErrors: () => void;
-      setErrors: (errors: Record<string, string>) => void;
-      dismissError: (path: string) => void;
-      dismissFormError: () => void;
-      formContext: TFormContext | undefined;
-      isDirty: boolean;
-      changes: readonly _atscript_ui0.FormFieldChange[];
-      getPatch: (opts?: _atscript_ui0.FormDiffOptions) => Record<string, unknown>;
-      getChanges: () => _atscript_ui0.FormFieldChange[];
-    }) => any;
-  } & {
-    'form.error'?: (props: {
-      message: string;
-      dismiss: () => void;
-      title: string | undefined;
-      description: string | undefined;
-      data: TFormData;
-      errors: Record<string, string | undefined> | undefined;
-      formError: string | undefined;
-      disabled: boolean;
-      loading: boolean;
-      submitText: string;
-      submit: () => void;
-      reset: () => Promise<void>;
-      clearErrors: () => void;
-      setErrors: (errors: Record<string, string>) => void;
-      dismissError: (path: string) => void;
-      dismissFormError: () => void;
-      formContext: TFormContext | undefined;
-      isDirty: boolean;
-      changes: readonly _atscript_ui0.FormFieldChange[];
-      getPatch: (opts?: _atscript_ui0.FormDiffOptions) => Record<string, unknown>;
-      getChanges: () => _atscript_ui0.FormFieldChange[];
-    }) => any;
-  } & {
-    'form.submit'?: (props: {
-      text: string;
-      title: string | undefined;
-      description: string | undefined;
-      data: TFormData;
-      errors: Record<string, string | undefined> | undefined;
-      formError: string | undefined;
-      disabled: boolean;
-      loading: boolean;
-      submitText: string;
-      submit: () => void;
-      reset: () => Promise<void>;
-      clearErrors: () => void;
-      setErrors: (errors: Record<string, string>) => void;
-      dismissError: (path: string) => void;
-      dismissFormError: () => void;
-      formContext: TFormContext | undefined;
-      isDirty: boolean;
-      changes: readonly _atscript_ui0.FormFieldChange[];
-      getPatch: (opts?: _atscript_ui0.FormDiffOptions) => Record<string, unknown>;
-      getChanges: () => _atscript_ui0.FormFieldChange[];
-    }) => any;
-  } & {
-    'form.footer'?: (props: {
-      title: string | undefined;
-      description: string | undefined;
-      data: TFormData;
-      errors: Record<string, string | undefined> | undefined;
-      formError: string | undefined;
-      disabled: boolean;
-      loading: boolean;
-      submitText: string;
-      submit: () => void;
-      reset: () => Promise<void>;
-      clearErrors: () => void;
-      setErrors: (errors: Record<string, string>) => void;
-      dismissError: (path: string) => void;
-      dismissFormError: () => void;
-      formContext: TFormContext | undefined;
-      isDirty: boolean;
-      changes: readonly _atscript_ui0.FormFieldChange[];
-      getPatch: (opts?: _atscript_ui0.FormDiffOptions) => Record<string, unknown>;
-      getChanges: () => _atscript_ui0.FormFieldChange[];
-    }) => any;
-  } & {
-    'form.loading'?: (props: {
-      title: string | undefined;
-      description: string | undefined;
-      data: TFormData;
-      errors: Record<string, string | undefined> | undefined;
-      formError: string | undefined;
-      disabled: boolean;
-      loading: boolean;
-      submitText: string;
-      submit: () => void;
-      reset: () => Promise<void>;
-      clearErrors: () => void;
-      setErrors: (errors: Record<string, string>) => void;
-      dismissError: (path: string) => void;
-      dismissFormError: () => void;
-      formContext: TFormContext | undefined;
-      isDirty: boolean;
-      changes: readonly _atscript_ui0.FormFieldChange[];
-      getPatch: (opts?: _atscript_ui0.FormDiffOptions) => Record<string, unknown>;
-      getChanges: () => _atscript_ui0.FormFieldChange[];
-    }) => any;
-  };
-  emit: {
-    (e: "submit", data: TFormData): void;
-    (e: "error", errors: {
-      path: string;
-      message: string;
-    }[]): void;
-    (e: "action", name: string, data: TFormData): void;
-    (e: "unsupported-action", name: string, data: TFormData): void;
-    (e: "change", type: TAsChangeType, path: string, value: unknown, formData: TFormData): void;
-  };
-}>) => vue.VNode & {
-  __ctx?: Awaited<typeof __VLS_setup>;
-};
-declare const _default: typeof __VLS_export;
-type __VLS_PrettifyLocal<T> = (T extends any ? { [K in keyof T]: T[K] } : { [K in keyof T as K]: T[K] }) & {};
-//#endregion
-export { TFormRule as a, TFormFieldRegistration as i, _default as n, TFormState as o, TFormFieldCallbacks as r, Props as t };