attaform 0.0.1 → 0.14.0

package/dist/index.d.cts

@@ -0,0 +1,493 @@
+import { Plugin, App, InjectionKey } from 'vue';
+import { A as AttaformDefaults, C as CoercionRegistry, S as SlimPrimitiveKind, a as CoercionEntry, F as FormKey, G as GenericForm, U as UseFormConfiguration, b as AbstractSchema, D as DeepPartial, c as DefaultValuesShape, d as UseFormReturnType, R as RegisterValue, e as RegisterModelDynamicCustomDirective, V as ValidationError, f as ApiErrorEnvelope, g as ApiErrorDetails } from './shared/attaform.DDXrY-1Q.cjs';
+export { h as ApiErrorEntry, i as CoercionResult, j as CustomDirectiveRegisterAssignerFn, k as DefaultValuesResponse, l as FieldState, m as FieldStateLeaf, n as FieldStateMap, o as FieldStateMapEntry, p as FlatPath, q as FormErrorRecord, r as FormErrorsSurface, s as FormMeta, t as FormStorage, u as FormStorageKind, H as HandleSubmit, v as HistoryConfig, I as IsTuple, M as MetaTrackerValue, N as NestedReadType, w as NestedType, O as OnError, x as OnInvalidSubmitPolicy, y as OnSubmit, P as Path, z as PathKey, B as PendingValidationStatus, E as PersistConfig, J as PersistConfigOptions, K as PersistIncludeMode, L as ROOT_PATH, Q as ROOT_PATH_KEY, T as ReactiveValidationStatus, W as RegisterDirective, X as RegisterFlatPath, Y as RegisterOptions, Z as RegisterSelectModifier, _ as RegisterTextModifier, $ as RegisterTransform, a0 as Segment, a1 as SetValueCallback, a2 as SetValuePayload, a3 as SettledValidationStatus, a4 as SlimRuntimeOf, a5 as SubmitHandler, a6 as Unset, a7 as ValidateOn, a8 as ValidateOnConfig, a9 as ValidationResponse, aa as ValidationResponseWithoutValue, ab as WriteMeta, ac as canonicalizePath, ad as isUnset, ae as parseDottedPath, af as unset } from './shared/attaform.DDXrY-1Q.cjs';
+export { A as AttaformErrorCode, i as injectForm, u as useRegister } from './shared/attaform.CXZgUECn.cjs';
+export { A as AnonPersistError, a as AttaformError, I as InvalidPathError, O as OutsideSetupError, R as RegistryNotInstalledError, b as ReservedFormKeyError, S as SensitivePersistFieldError, c as SubmitErrorHandlerError } from './shared/attaform.BwaYWtMs.cjs';
+
+/**
+ * Portable SSR detection. The plugin captures this value at install time and
+ * exposes it via the registry so every runtime branch reads a single source
+ * of truth instead of sniffing `import.meta.*` (bundler-specific) at each
+ * call site.
+ *
+ * Consumers can override explicitly via `createAttaform({ ssr: true })`;
+ * the default heuristic handles the common Node-vs-browser split without
+ * relying on any bundler-injected flag.
+ */
+interface SSRDetectOptions {
+    override?: boolean;
+}
+
+/**
+ * Options for `createAttaform()`.
+ */
+type AttaformPluginOptions = SSRDetectOptions & {
+    /**
+     * Whether to install the Vue DevTools integration. Default `true`.
+     * The DevTools peer dependency is loaded lazily — in production
+     * builds where it's absent, the import fails silently and no
+     * extra bundle is shipped. Pass `false` to skip even attempting
+     * the import.
+     */
+    devtools?: boolean;
+    /**
+     * App-level defaults applied to every `useForm` call in this app.
+     * Per-form options always win. See `AttaformDefaults` for
+     * the supported option set and the merge rules.
+     *
+     * ```ts
+     * app.use(
+     *   createAttaform({
+     *     defaults: { debounceMs: 100 },
+     *   })
+     * )
+     * ```
+     */
+    defaults?: AttaformDefaults;
+};
+/**
+ * Create the Vue plugin that installs the form library on a Vue
+ * application. Call once per app, then `app.use(...)` the result.
+ *
+ * ```ts
+ * import { createApp } from 'vue'
+ * import { createAttaform } from 'attaform'
+ *
+ * createApp(App)
+ *   .use(createAttaform())
+ *   .mount('#app')
+ * ```
+ *
+ * Under SSR with bare Vue 3, pass `{ ssr: true }` from your server
+ * entry. Under Nuxt, install via `attaform/nuxt` instead —
+ * the Nuxt module wires both server and client automatically.
+ *
+ * Installing more than once on the same app is a no-op (the second
+ * call logs a dev-mode warning).
+ */
+declare function createAttaform(options?: AttaformPluginOptions): Plugin;
+
+/**
+ * Schema-driven coercion of user-typed DOM values at the v-register
+ * directive layer. When the slim schema declares a numeric or
+ * boolean type at a path, the directive coerces incoming string
+ * values (`'25'` → `25`, `'true'` → `true`) before the slim-primitive
+ * gate sees the write — making the schema authoritative for storage
+ * shape and freeing consumers from sprinkling `.number` modifiers
+ * across templates.
+ *
+ * Coercion is consumer-extensible: a `CoercionRegistry` is just an
+ * `Array<CoercionEntry>` keyed at config time by `(input, output)`
+ * `SlimPrimitiveKind` literals. The library ships
+ * `defaultCoercionRules` (string→number, string→boolean) and
+ * `defineCoercion` for type-narrowed authoring; consumers spread the
+ * defaults to extend or supply their own array to replace.
+ *
+ * Coercion applies ONLY to user-typed DOM values flowing through
+ * the directive's assigner. Programmatic writes (`form.setValue`,
+ * `setValueWithInternalPath`) bypass coercion — they're authoritative
+ * writes whose strict typing is on the caller. This mirrors the
+ * `transforms` pipeline's user-input-only contract.
+ */
+
+/**
+ * Type-narrowing helper for authoring entries. At runtime it's
+ * identity; at compile time it preserves the `input` / `output`
+ * literal types so `transform`'s parameter is narrowed to the
+ * runtime type instead of widening to `SlimRuntimeOf<SlimPrimitiveKind>`.
+ *
+ * Without this helper, authoring `{ input: 'string', output:
+ * 'number', transform: (s) => ... }` against the broader
+ * `CoercionEntry` widens `s` to `string | number | boolean | ...`,
+ * forcing a cast in every transform body. `defineCoercion` is the
+ * opaque-free idiom.
+ */
+declare function defineCoercion<I extends SlimPrimitiveKind, O extends SlimPrimitiveKind>(entry: CoercionEntry<I, O>): CoercionEntry<I, O>;
+/**
+ * The library's built-in registry. Two cells: string→number and
+ * string→boolean. Re-exported so consumers can spread it when
+ * supplying a custom registry that extends defaults.
+ */
+declare const defaultCoercionRules: CoercionRegistry;
+
+/**
+ * Per-Vue-app container for all form state instances. Each
+ * `app.use(createAttaform())` call gets its own registry,
+ * so the library runs under bare Vue 3 + SSR (via
+ * `@vue/server-renderer`) and Nuxt with the same code path.
+ *
+ * Each form's state lives in `forms: Map<FormKey, FormStore<GenericForm>>`.
+ * The type relaxation at storage time is necessary because different
+ * forms in the same app have different `Form` generics; callers recover
+ * the specific form type via `useForm`'s overloads.
+ */
+/**
+ * Serialised snapshot of one form's state, captured by
+ * `renderAttaformState` for SSR and replayed by
+ * `hydrateAttaformState` on the client. Round-trips through
+ * JSON-safe tuples; field references are intentionally omitted
+ * (DOM nodes don't survive serialisation).
+ */
+type SerializedFormData = {
+    /** The form's value at snapshot time. */
+    readonly form: unknown;
+    /**
+     * Errors produced by the schema at snapshot time. Replayed into
+     * the client form's error state at hydration; cleared on
+     * successful re-validation client-side.
+     */
+    readonly schemaErrors: ReadonlyArray<readonly [string, unknown]>;
+    /**
+     * Errors set explicitly via `setFieldErrors` / `addFieldErrors`
+     * (typically from a server response parsed via `parseApiErrors`)
+     * at snapshot time. Replayed at hydration; persists across
+     * client-side re-validation.
+     */
+    readonly userErrors: ReadonlyArray<readonly [string, unknown]>;
+    /** Per-field metadata (timestamps, raw values, connection flags) captured at snapshot time. */
+    readonly fields: ReadonlyArray<readonly [string, unknown]>;
+    /**
+     * Path keys that were in the form's `blankPaths` set at
+     * snapshot time. Round-trips the "displayed empty" UI state across
+     * the SSR boundary — without it, the client briefly renders
+     * `String(slim-default)` (e.g. `'0'`) for fields the server
+     * rendered as blank. Optional in the wire format so older payload
+     * shapes deserialise cleanly.
+     */
+    readonly blankPaths?: ReadonlyArray<string>;
+};
+/**
+ * The library's per-Vue-app container. One `AttaformRegistry` is
+ * created per `app.use(createAttaform())` call.
+ *
+ * Most consumers never touch this directly — `useForm` and
+ * `injectForm` reach the registry on your behalf. Access it
+ * explicitly only when wiring SSR or a custom plugin integration.
+ */
+type AttaformRegistry = {
+    /** `true` while running on the server during SSR; `false` on the client. */
+    readonly isSSR: boolean;
+    /** App-level defaults applied to every `useForm` call. */
+    readonly defaults: AttaformDefaults;
+};
+/**
+ * The Vue `InjectionKey` under which the registry is provided on the
+ * app. Most consumers never need this — `useForm` and
+ * `injectForm` resolve the registry automatically.
+ */
+declare const kAttaformRegistry: InjectionKey<AttaformRegistry>;
+declare module 'vue' {
+    interface App {
+    }
+}
+/** Options for `createRegistry`. */
+type CreateRegistryOptions = SSRDetectOptions & {
+    /**
+     * App-level defaults applied to every `useForm` call. Per-form
+     * options always win. Omitted is equivalent to `{}`.
+     */
+    defaults?: AttaformDefaults;
+};
+/**
+ * Create a fresh `AttaformRegistry`. `createAttaform()` calls
+ * this internally — most consumers never need to call it directly.
+ * Use it when building a custom plugin that doesn't want the
+ * `createAttaform` plugin's auto-install behaviour (e.g. test
+ * harnesses, embedded apps).
+ */
+declare function createRegistry(options?: CreateRegistryOptions): AttaformRegistry;
+/**
+ * Look up the current app's registry from inside a component's
+ * `setup()` (or any synchronous code on the setup call stack).
+ *
+ * Most consumers don't need this — `useForm` and `injectForm`
+ * call it on your behalf. Reach for it directly when building
+ * custom integrations that need the raw registry.
+ *
+ * Throws:
+ * - `OutsideSetupError` when called outside a Vue setup context
+ *   (e.g. from an event handler or async callback). Move the call
+ *   into setup, or trigger it from a child component.
+ * - `RegistryNotInstalledError` when called inside setup but the
+ *   plugin wasn't installed. Add
+ *   `app.use(createAttaform())` to your app entry.
+ */
+declare function useRegistry(): AttaformRegistry;
+/**
+ * Look up a Vue app's registry by `App` reference. Used by
+ * SSR helpers (`renderAttaformState`, `hydrateAttaformState`) that
+ * run outside a component setup context.
+ *
+ * Throws `RegistryNotInstalledError` when the app hasn't been wired
+ * with `createAttaform()`.
+ */
+declare function getRegistryFromApp(app: App): AttaformRegistry;
+
+/**
+ * Serialised snapshot of every form in a Vue app, produced by
+ * `renderAttaformState` and consumed by `hydrateAttaformState`.
+ *
+ * JSON-safe — pass to `JSON.stringify`, `devalue`, or any other
+ * serialiser before embedding in your SSR payload.
+ */
+type SerializedAttaformState = {
+    /** Tuples of `[formKey, snapshot]` for every form in the app. */
+    readonly forms: ReadonlyArray<readonly [FormKey, SerializedFormData]>;
+};
+/**
+ * Snapshot every form on a Vue app for SSR. Call from your server
+ * entry after rendering the app:
+ *
+ * ```ts
+ * import { renderToString } from '@vue/server-renderer'
+ * import { renderAttaformState, escapeForInlineScript } from 'attaform'
+ *
+ * const html = await renderToString(app)
+ * const state = renderAttaformState(app)
+ * const payload = escapeForInlineScript(JSON.stringify(state))
+ *
+ * return `
+ *   ${html}
+ *   <script>window.__ATTAFORM_STATE__ = ${payload}</script>
+ * `
+ * ```
+ *
+ * Pair with `hydrateAttaformState` on the client to restore the
+ * forms in their server-rendered state. Nuxt users don't need this —
+ * `attaform/nuxt` wires SSR automatically.
+ */
+declare function renderAttaformState(app: App): SerializedAttaformState;
+/**
+ * Restore forms from a server-rendered snapshot on the client. Call
+ * from your client entry before mounting:
+ *
+ * ```ts
+ * import { createApp } from 'vue'
+ * import { createAttaform, hydrateAttaformState } from 'attaform'
+ *
+ * const app = createApp(App).use(createAttaform())
+ * hydrateAttaformState(app, window.__ATTAFORM_STATE__)
+ * app.mount('#app')
+ * ```
+ *
+ * The next `useForm({ key })` call for each serialised form picks up
+ * the snapshot transparently — no further action is required.
+ */
+declare function hydrateAttaformState(app: App, payload: SerializedAttaformState): void;
+
+/**
+ * Escape a JSON string so it's safe to embed inside an inline
+ * `<script>` tag during SSR. Plain `JSON.stringify` is not safe — a
+ * form value containing the literal substring `</script>` would
+ * break out of the script tag.
+ *
+ * ```ts
+ * const payload = escapeForInlineScript(JSON.stringify(renderAttaformState(app)))
+ * // `<script>window.__ATTAFORM_STATE__ = ${payload}</script>` is safe.
+ * ```
+ *
+ * Output remains valid JSON — `JSON.parse` round-trips back to the
+ * original value on the client.
+ */
+declare function escapeForInlineScript(json: string): string;
+
+/**
+ * Schema-agnostic `useForm`. Accepts any object that implements
+ * `AbstractSchema` — useful when integrating a custom schema
+ * adapter or a third-party validation library.
+ *
+ * ```ts
+ * import { useForm } from 'attaform'
+ *
+ * const form = useForm({
+ *   schema: myCustomAdapter,
+ *   defaultValues: { name: '' },
+ * })
+ * ```
+ *
+ * Most consumers prefer a typed entry point — e.g.
+ * `attaform/zod` (v4) or `attaform/zod-v3` —
+ * which wrap the underlying library's schema with the matching
+ * adapter automatically.
+ *
+ * Returns the same form API as the typed entry points; see
+ * `UseFormReturnType` for the full surface.
+ */
+declare function useAbstractForm<Form extends GenericForm, GetValueFormType extends GenericForm = Form>(configuration: UseFormConfiguration<Form, GetValueFormType, AbstractSchema<Form, GetValueFormType>, DeepPartial<DefaultValuesShape<Form>>>): UseFormReturnType<Form, GetValueFormType>;
+
+/**
+ * Symbol slot used by custom directive integrations to install an
+ * assigner on the bound element. Read by the v-register directive
+ * when a DOM event fires:
+ *
+ * ```ts
+ * import { assignKey } from 'attaform'
+ * el[assignKey] = (value) => myCustomWriter(value)
+ * ```
+ *
+ * Most consumers never need this — the built-in directives wire
+ * default assigners for text inputs, checkboxes, radios, and selects.
+ */
+declare const assignKey: unique symbol;
+/**
+ * Type guard for a `RegisterValue`. Returns `true` when `val` looks
+ * like the object returned from `form.register(path)`.
+ *
+ * ```ts
+ * if (isRegisterValue(slotValue)) {
+ *   // slotValue.innerRef is now a Ref<unknown>
+ * }
+ * ```
+ *
+ * Useful when building wrapper components that accept either a
+ * `RegisterValue` or a plain ref via the same prop.
+ */
+declare function isRegisterValue<Value = unknown>(val: unknown): val is RegisterValue<Value>;
+/**
+ * The `v-register` directive. Bind a form field to a native input,
+ * select, textarea, checkbox, or radio:
+ *
+ * ```vue
+ * <input v-register="form.register('email')" />
+ * <select v-register="form.register('country')">
+ *   <option value="us">US</option>
+ *   <option value="uk">UK</option>
+ * </select>
+ * ```
+ *
+ * The directive picks the right binding strategy automatically based
+ * on the element's `tagName` and `type`. Registered globally by
+ * `createAttaform()` — most consumers never import it
+ * directly, but it's exposed for advanced integrations that wire
+ * directives manually.
+ */
+declare const vRegister: RegisterModelDynamicCustomDirective;
+
+/**
+ * Result of `parseApiErrors`. Branch on `ok` to handle the two cases:
+ *
+ * ```ts
+ * const result = parseApiErrors(payload, { formKey: form.key })
+ * if (result.ok) {
+ *   form.setFieldErrors(result.errors)
+ * } else {
+ *   console.warn('Bad error payload:', result.rejected)
+ * }
+ * ```
+ *
+ * `ok: true` means the payload was recognised — `errors` may still be
+ * empty if the payload was valid but had no actual errors.
+ * `ok: false` means the payload didn't match a known shape; `rejected`
+ * carries a one-line description of why.
+ */
+type ParseApiErrorsResult = {
+    /** `true` when the payload was recognised; `false` when the shape was unfamiliar. */
+    readonly ok: boolean;
+    /** Errors extracted from the payload. May be empty even when `ok: true`. */
+    readonly errors: ValidationError[];
+    /** When `ok: false`, a one-line description of why the payload was rejected. */
+    readonly rejected?: string;
+};
+/**
+ * Options for `parseApiErrors`. The size caps protect against
+ * misbehaving or hostile servers — exceeding any cap causes the
+ * parser to reject the payload wholesale rather than partially apply.
+ */
+type ParseApiErrorsOptions = {
+    /**
+     * The form's identifier — pass `form.key`. Stamped on every
+     * produced `ValidationError` so errors route to the right form.
+     */
+    readonly formKey: FormKey;
+    /**
+     * Code stamped on `ValidationError`s synthesized from bare-string
+     * entries (the Rails / DRF / Laravel `{ field: ["msg"] }` shape).
+     * Default `'api:unknown'`. Pick something more specific
+     * (`'api:server-validation'`, `'myapp:legacy'`, …) when you know
+     * the source.
+     *
+     * Structured `{ message, code }` entries forward their `code`
+     * verbatim and ignore this option.
+     */
+    readonly defaultCode?: string;
+    /**
+     * Maximum number of distinct keys to accept. Default `1000`.
+     * Raise for trusted backends that legitimately produce more.
+     */
+    readonly maxEntries?: number;
+    /**
+     * Maximum number of path segments per key. Default `32`. Keys
+     * deeper than this are dropped (the rest of the payload still
+     * applies if it stays under the other caps).
+     */
+    readonly maxPathDepth?: number;
+    /**
+     * Maximum total path segments summed across every accepted key.
+     * Default `10000`. Bounds the worst-case traversal cost.
+     */
+    readonly maxTotalSegments?: number;
+};
+/**
+ * Default size caps + default fallback code used by `parseApiErrors`.
+ * Conservative; pass larger values (or a more specific code) via the
+ * options bag for trusted-backend integrations.
+ */
+declare const PARSE_API_ERRORS_DEFAULTS: {
+    readonly maxEntries: 1000;
+    readonly maxPathDepth: 32;
+    readonly maxTotalSegments: 10000;
+    readonly defaultCode: "api:unknown";
+};
+/**
+ * Normalise a server-side validation error payload into
+ * `ValidationError[]`. Pair with `form.setFieldErrors` /
+ * `form.addFieldErrors` to surface server errors on the form:
+ *
+ * ```ts
+ * const response = await fetch('/api/signup', { … })
+ * if (!response.ok) {
+ *   const payload = await response.json()
+ *   const result = parseApiErrors(payload, { formKey: form.key })
+ *   if (result.ok) form.setFieldErrors(result.errors)
+ * }
+ * ```
+ *
+ * Recognised payload shapes:
+ *
+ * - Wrapped envelope:
+ *   `{ error: { details: { email: { message: 'taken', code: 'api:duplicate-email' } } } }`
+ * - Unwrapped envelope:
+ *   `{ details: { email: { message: 'taken', code: 'api:duplicate-email' } } }`
+ * - Raw details record:
+ *   `{ email: { message: 'taken', code: 'api:duplicate-email' } }`
+ * - **Bare-string Rails / DRF / Laravel shape:**
+ *   `{ email: ['Email already taken.'], username: 'too short' }`
+ * - `null` / `undefined` — returns `{ ok: true, errors: [] }`
+ *
+ * Two entry shapes are accepted:
+ *
+ * 1. **Structured** — `{ message: string, code: string }`. The `code`
+ *    is forwarded verbatim onto the produced `ValidationError`.
+ * 2. **Bare-string** — a plain string. Synthesized into
+ *    `{ message: <string>, code: <defaultCode> }` where `defaultCode`
+ *    comes from `options.defaultCode` (default `'api:unknown'`).
+ *    Useful for the Rails / Django REST Framework / FastAPI / Laravel
+ *    JSON shape that doesn't carry a per-field code.
+ *
+ * Each detail key's value can be a single entry, an array, or a mix
+ * of structured and bare-string entries; arrays expand into one
+ * `ValidationError` per entry. Pick a prefix on the server (`api:`,
+ * `auth:`, etc.) and stay consistent so error renderers can branch
+ * on `code` — or rely on `defaultCode` when the wire shape is
+ * message-only.
+ *
+ * Dotted keys (`"address.line1"`) are split into structured paths
+ * automatically. Use a custom server response shape outside these
+ * patterns? Build the `ValidationError[]` array yourself and pass
+ * it to `setFieldErrors` directly — `parseApiErrors` is just a
+ * convenience for the common shapes.
+ */
+declare function parseApiErrors(payload: ApiErrorEnvelope | ApiErrorDetails | null | undefined | unknown, options: ParseApiErrorsOptions): ParseApiErrorsResult;
+
+export { AbstractSchema, ApiErrorDetails, ApiErrorEnvelope, AttaformDefaults, CoercionEntry, CoercionRegistry, DeepPartial, DefaultValuesShape, FormKey, GenericForm, PARSE_API_ERRORS_DEFAULTS, RegisterValue, SlimPrimitiveKind, UseFormConfiguration, UseFormReturnType, ValidationError, assignKey, createAttaform, createRegistry, defaultCoercionRules, defineCoercion, escapeForInlineScript, getRegistryFromApp, hydrateAttaformState, isRegisterValue, kAttaformRegistry, parseApiErrors, renderAttaformState, useAbstractForm as useForm, useRegistry, vRegister };
+export type { AttaformPluginOptions, AttaformRegistry, ParseApiErrorsOptions, ParseApiErrorsResult, SerializedAttaformState, SerializedFormData };