attaform 0.22.0 → 0.24.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -11
- package/dist/chunks/dev-key-collision-warnings.cjs +0 -33
- package/dist/chunks/dev-key-collision-warnings.cjs.map +1 -1
- package/dist/chunks/dev-key-collision-warnings.mjs +1 -33
- package/dist/chunks/dev-key-collision-warnings.mjs.map +1 -1
- package/dist/chunks/devtools.cjs +3 -5
- package/dist/chunks/devtools.cjs.map +1 -1
- package/dist/chunks/devtools.mjs +3 -5
- package/dist/chunks/devtools.mjs.map +1 -1
- package/dist/chunks/fingerprint2.cjs +1 -1
- package/dist/chunks/fingerprint2.mjs +1 -1
- package/dist/index.cjs +3 -151
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +7 -168
- package/dist/index.d.mts +7 -168
- package/dist/index.d.ts +7 -168
- package/dist/index.mjs +4 -150
- package/dist/index.mjs.map +1 -1
- package/dist/nuxt.d.cts +1 -1
- package/dist/nuxt.d.mts +1 -1
- package/dist/nuxt.d.ts +1 -1
- package/dist/runtime/components/AttaformDevtoolsPanel.vue +5 -13
- package/dist/runtime/plugins/attaform.cjs +2 -2
- package/dist/runtime/plugins/attaform.mjs +2 -2
- package/dist/shared/{attaform.DgCfLqay.mjs → attaform.BJ_W7q3U.mjs} +8 -6
- package/dist/shared/attaform.BJ_W7q3U.mjs.map +1 -0
- package/dist/shared/{attaform.aekT7mMx.d.cts → attaform.BNmkKz0q.d.mts} +38 -6
- package/dist/shared/{attaform.Q3eAD2wD.cjs → attaform.BV_HyaMO.cjs} +6 -4
- package/dist/shared/attaform.BV_HyaMO.cjs.map +1 -0
- package/dist/shared/{attaform.AyujQoHp.cjs → attaform.BnUXV01g.cjs} +4 -4
- package/dist/shared/attaform.BnUXV01g.cjs.map +1 -0
- package/dist/shared/{attaform.DNuiFCXG.mjs → attaform.C-dAB90u.mjs} +4 -4
- package/dist/shared/attaform.C-dAB90u.mjs.map +1 -0
- package/dist/shared/{attaform.CjMcwV7W.cjs → attaform.C42wL7EJ.cjs} +272 -776
- package/dist/shared/attaform.C42wL7EJ.cjs.map +1 -0
- package/dist/shared/{attaform.D4XYaasQ.d.ts → attaform.C6eE50re.d.ts} +27 -87
- package/dist/shared/{attaform.6xE0Lcfd.mjs → attaform.CAWKNCzc.mjs} +2 -2
- package/dist/shared/{attaform.6xE0Lcfd.mjs.map → attaform.CAWKNCzc.mjs.map} +1 -1
- package/dist/shared/{attaform.DkA5J8NW.d.cts → attaform.CO0e7YVY.d.cts} +1 -46
- package/dist/shared/{attaform.DkA5J8NW.d.ts → attaform.CO0e7YVY.d.mts} +1 -46
- package/dist/shared/{attaform.DkA5J8NW.d.mts → attaform.CO0e7YVY.d.ts} +1 -46
- package/dist/shared/{attaform.CsB-iKbU.mjs → attaform.CuBdtfbe.mjs} +274 -767
- package/dist/shared/attaform.CuBdtfbe.mjs.map +1 -0
- package/dist/shared/{attaform.FN0vaQAg.d.mts → attaform.CwFZGv5-.d.ts} +38 -6
- package/dist/shared/{attaform.BGwNZ9GV.d.cts → attaform.DdUYEhkV.d.cts} +27 -87
- package/dist/shared/attaform.DdjDqTah.d.cts +56 -0
- package/dist/shared/attaform.DdjDqTah.d.mts +56 -0
- package/dist/shared/attaform.DdjDqTah.d.ts +56 -0
- package/dist/shared/{attaform.BKFwekY2.mjs → attaform.Df-s8j1X.mjs} +3 -289
- package/dist/shared/attaform.Df-s8j1X.mjs.map +1 -0
- package/dist/shared/{attaform.CCCeEPwa.d.mts → attaform.DiWNbKWa.d.mts} +27 -87
- package/dist/shared/{attaform.01iKS_lz.cjs → attaform.DwkU0oY9.cjs} +2 -298
- package/dist/shared/attaform.DwkU0oY9.cjs.map +1 -0
- package/dist/shared/{attaform.DvUH4a3o.d.ts → attaform.GJbSmwLB.d.cts} +224 -824
- package/dist/shared/{attaform.DvUH4a3o.d.cts → attaform.GJbSmwLB.d.mts} +224 -824
- package/dist/shared/{attaform.DvUH4a3o.d.mts → attaform.GJbSmwLB.d.ts} +224 -824
- package/dist/shared/{attaform.DUMWQefY.d.ts → attaform.K-3glmiT.d.cts} +38 -6
- package/dist/shared/{attaform.C-RtnCJM.cjs → attaform.Z1qTwOYE.cjs} +8 -6
- package/dist/shared/attaform.Z1qTwOYE.cjs.map +1 -0
- package/dist/shared/{attaform.CRzpFCjV.cjs → attaform.nycEksJn.cjs} +2 -2
- package/dist/shared/{attaform.CRzpFCjV.cjs.map → attaform.nycEksJn.cjs.map} +1 -1
- package/dist/shared/{attaform.DCjgGir_.mjs → attaform.o95Kjd3U.mjs} +6 -4
- package/dist/shared/attaform.o95Kjd3U.mjs.map +1 -0
- package/dist/zod-v3.cjs +2 -2
- package/dist/zod-v3.d.cts +12 -11
- package/dist/zod-v3.d.mts +12 -11
- package/dist/zod-v3.d.ts +12 -11
- package/dist/zod-v3.mjs +2 -2
- package/dist/zod-v4.cjs +2 -2
- package/dist/zod-v4.d.cts +7 -6
- package/dist/zod-v4.d.mts +7 -6
- package/dist/zod-v4.d.ts +7 -6
- package/dist/zod-v4.mjs +2 -2
- package/dist/zod.cjs +5 -5
- package/dist/zod.cjs.map +1 -1
- package/dist/zod.d.cts +21 -52
- package/dist/zod.d.mts +21 -52
- package/dist/zod.d.ts +21 -52
- package/dist/zod.mjs +5 -5
- package/dist/zod.mjs.map +1 -1
- package/package.json +1 -1
- package/dist/chunks/indexeddb.cjs +0 -119
- package/dist/chunks/indexeddb.cjs.map +0 -1
- package/dist/chunks/indexeddb.mjs +0 -117
- package/dist/chunks/indexeddb.mjs.map +0 -1
- package/dist/chunks/local-storage.cjs +0 -58
- package/dist/chunks/local-storage.cjs.map +0 -1
- package/dist/chunks/local-storage.mjs +0 -56
- package/dist/chunks/local-storage.mjs.map +0 -1
- package/dist/chunks/multi-tab-sync.cjs +0 -367
- package/dist/chunks/multi-tab-sync.cjs.map +0 -1
- package/dist/chunks/multi-tab-sync.mjs +0 -364
- package/dist/chunks/multi-tab-sync.mjs.map +0 -1
- package/dist/chunks/session-storage.cjs +0 -58
- package/dist/chunks/session-storage.cjs.map +0 -1
- package/dist/chunks/session-storage.mjs +0 -56
- package/dist/chunks/session-storage.mjs.map +0 -1
- package/dist/chunks/wire-persistence.cjs +0 -396
- package/dist/chunks/wire-persistence.cjs.map +0 -1
- package/dist/chunks/wire-persistence.mjs +0 -394
- package/dist/chunks/wire-persistence.mjs.map +0 -1
- package/dist/shared/attaform.01iKS_lz.cjs.map +0 -1
- package/dist/shared/attaform.AyujQoHp.cjs.map +0 -1
- package/dist/shared/attaform.BKFwekY2.mjs.map +0 -1
- package/dist/shared/attaform.C-RtnCJM.cjs.map +0 -1
- package/dist/shared/attaform.CjMcwV7W.cjs.map +0 -1
- package/dist/shared/attaform.CsB-iKbU.mjs.map +0 -1
- package/dist/shared/attaform.DCjgGir_.mjs.map +0 -1
- package/dist/shared/attaform.DNuiFCXG.mjs.map +0 -1
- package/dist/shared/attaform.DgCfLqay.mjs.map +0 -1
- package/dist/shared/attaform.Q3eAD2wD.cjs.map +0 -1
- package/dist/shared/attaform.nf83TIR5.d.cts +0 -35
- package/dist/shared/attaform.nf83TIR5.d.mts +0 -35
- package/dist/shared/attaform.nf83TIR5.d.ts +0 -35
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
import { G as GenericForm,
|
|
2
|
+
import { G as GenericForm, u as FlatPath, O as NestedType, F as FormKey, U as UseFormConfiguration, a as AbstractSchema, D as DefaultValuesInput, af as ValidateOnConfig, b as UseFormReturnType } from './attaform.GJbSmwLB.js';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* The shape `form.values.<key>` returns at runtime.
|
|
@@ -120,6 +120,38 @@ type StorageLeaf<L> = InputIsUnknown<L> extends true ? unknown : L extends {
|
|
|
120
120
|
};
|
|
121
121
|
} ? Out : never;
|
|
122
122
|
|
|
123
|
+
/**
|
|
124
|
+
* The Zod v4 schema roots `useForm` accepts. A fixed-shape
|
|
125
|
+
* `z.object({ … })` is the common case; `z.record(K, V)` admits a
|
|
126
|
+
* dictionary form (a homogeneous map with runtime-known keys);
|
|
127
|
+
* `z.discriminatedUnion(disc, [...])` admits a variant form (one of
|
|
128
|
+
* several object shapes, picked by a discriminator). Each projects to
|
|
129
|
+
* a `GenericForm`-shaped value the form engine drives: an object root
|
|
130
|
+
* descends into its fixed keys, a record root treats its entries as an
|
|
131
|
+
* open live-keyed container, a variant root lifts the active variant's
|
|
132
|
+
* keys into one addressable surface.
|
|
133
|
+
*
|
|
134
|
+
* Other roots (a bare `z.union`, a root `z.array`, primitives,
|
|
135
|
+
* `z.map` / `z.set`) are not form roots; wrap them under a key. The
|
|
136
|
+
* adapter's runtime construction rejects them with a legible error.
|
|
137
|
+
*
|
|
138
|
+
* `z.ZodObject` MUST keep its `z.ZodRawShape` argument, and the
|
|
139
|
+
* discriminated-union arm MUST stay fully applied. The unified entry's
|
|
140
|
+
* v4 overload constrains on `SupportedRootSchema & ZodV4Internals` to
|
|
141
|
+
* keep v3 schemas out (see `../unified/types-zod-major.ts`). In a
|
|
142
|
+
* single-major (v3-only) consumer install, the published `.d.mts`
|
|
143
|
+
* resolves this `z` to v3, where a bare or under-applied Zod class is
|
|
144
|
+
* missing its required arguments and degrades to an `any`-like error
|
|
145
|
+
* type; `any` then absorbs the union and `any & ZodV4Internals`
|
|
146
|
+
* collapses back to `any`, so the marker stops excluding v3 schemas and
|
|
147
|
+
* the read slot poisons to `never`. `z.ZodRecord` carries defaults for
|
|
148
|
+
* both arguments, so it stays concrete in either major.
|
|
149
|
+
* `z.ZodDiscriminatedUnion` does NOT (v3 requires both arguments, and
|
|
150
|
+
* its parameter order is the reverse of v4's), so the arm is written
|
|
151
|
+
* fully applied; the v3-only bundled-types fixture guards it.
|
|
152
|
+
*/
|
|
153
|
+
type SupportedRootSchema = z.ZodObject<z.ZodRawShape> | z.ZodRecord | z.ZodDiscriminatedUnion<readonly z.ZodObject<z.ZodRawShape>[], string>;
|
|
154
|
+
|
|
123
155
|
/**
|
|
124
156
|
* Zod v4 adapter entry point. Re-exports the adapter + the useForm
|
|
125
157
|
* wrapper that threads zod-v4-specific schema types through
|
|
@@ -188,12 +220,12 @@ type PathOutput<Schema extends z.ZodType, Path extends string> = z.output<Schema
|
|
|
188
220
|
* generics ride on the alias rather than re-evaluating the
|
|
189
221
|
* conditional from scratch.
|
|
190
222
|
*/
|
|
191
|
-
type FormOf<Schema extends
|
|
192
|
-
type OutOf<Schema extends
|
|
193
|
-
type ReadOf<Schema extends
|
|
194
|
-
declare function useForm<Schema extends
|
|
223
|
+
type FormOf<Schema extends SupportedRootSchema> = z.input<Schema> extends GenericForm ? z.input<Schema> : never;
|
|
224
|
+
type OutOf<Schema extends SupportedRootSchema> = z.output<Schema> extends GenericForm ? z.output<Schema> : never;
|
|
225
|
+
type ReadOf<Schema extends SupportedRootSchema> = StorageShape<Schema> extends GenericForm ? StorageShape<Schema> : never;
|
|
226
|
+
declare function useForm<Schema extends SupportedRootSchema, K extends FormKey = FormKey>(configuration: Omit<UseFormConfiguration<FormOf<Schema>, OutOf<Schema>, AbstractSchema<FormOf<Schema>, OutOf<Schema>>, DefaultValuesInput<FormOf<Schema>>, K>, 'schema' | 'validateOn' | 'debounceMs'> & {
|
|
195
227
|
schema: Schema;
|
|
196
228
|
} & ValidateOnConfig): UseFormReturnType<FormOf<Schema>, OutOf<Schema>, ReadOf<Schema>, K>;
|
|
197
229
|
|
|
198
230
|
export { useForm as u };
|
|
199
|
-
export type { PathInput as P,
|
|
231
|
+
export type { PathInput as P, SupportedRootSchema as S, PathOutput as a, StorageShape as b };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { F as FormKey,
|
|
1
|
+
import { F as FormKey, W as PathKey, m as DisplayCtx, d as GetDisplayState, n as DisplayMachine, V as Path, aa as SlimPrimitiveKind, C as CoercionEntry, g as CoercionRegistry, G as GenericForm, ag as ValidationError, a as AbstractSchema, ak as WriteMeta, j as DeepPartial, al as WriteShape, as as TransformAbortHolder, ae as ValidateOn, A as AttaformDefaults, b as UseFormReturnType, c as RegisterValue } from './attaform.GJbSmwLB.cjs';
|
|
2
2
|
import { Ref, ComputedRef, App, InjectionKey } from 'vue';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -643,12 +643,12 @@ type FormStore<F extends GenericForm, G extends GenericForm = F> = {
|
|
|
643
643
|
* Schema-driven errors. Written ONLY by the schema validation pipeline:
|
|
644
644
|
* `scheduleFieldValidation`, `handleSubmit`, the construction-time seed,
|
|
645
645
|
* history restore, and hydration. Cleared by `reset` / `resetField` and by
|
|
646
|
-
* a successful submit. `
|
|
646
|
+
* a successful submit. `setErrors` / `clearErrors` do NOT touch this Map.
|
|
647
647
|
*/
|
|
648
648
|
readonly schemaErrors: Map<PathKey, ValidationError[]>;
|
|
649
649
|
/**
|
|
650
|
-
* User-injected errors. Written ONLY by the `
|
|
651
|
-
* (and history / hydration replay). Survives schema revalidation and
|
|
650
|
+
* User-injected errors. Written ONLY by the `setErrors` / `clearErrors`
|
|
651
|
+
* API surface (and history / hydration replay). Survives schema revalidation and
|
|
652
652
|
* successful submits — the consumer owns its lifetime explicitly.
|
|
653
653
|
*/
|
|
654
654
|
readonly userErrors: Map<PathKey, ValidationError[]>;
|
|
@@ -967,17 +967,13 @@ type FormStore<F extends GenericForm, G extends GenericForm = F> = {
|
|
|
967
967
|
/**
|
|
968
968
|
* Replace the form value wholesale. Optional `meta` is forwarded to
|
|
969
969
|
* every `onFormChange` listener so they can decide whether THIS write
|
|
970
|
-
* is one they care about
|
|
971
|
-
* only writes when `meta?.persist === true`. Internal callers that
|
|
972
|
-
* don't pass meta default to no-persist.
|
|
970
|
+
* is one they care about (e.g. history tagging a hydration replay).
|
|
973
971
|
*/
|
|
974
972
|
applyFormReplacement(next: F, meta?: WriteMeta): void;
|
|
975
973
|
/**
|
|
976
974
|
* Set a single path's value. `meta` is forwarded to listeners via
|
|
977
|
-
* `applyFormReplacement` (see above).
|
|
978
|
-
*
|
|
979
|
-
* internal call sites pass `meta.persist = hasAnyOptInForPath(path)`.
|
|
980
|
-
* Public `form.setValue` passes no meta.
|
|
975
|
+
* `applyFormReplacement` (see above). Public `form.setValue` passes no
|
|
976
|
+
* meta.
|
|
981
977
|
*
|
|
982
978
|
* Returns `false` when the slim-primitive gate rejects the write
|
|
983
979
|
* (the value's primitive shape doesn't match the schema's slim
|
|
@@ -1009,7 +1005,7 @@ type FormStore<F extends GenericForm, G extends GenericForm = F> = {
|
|
|
1009
1005
|
*/
|
|
1010
1006
|
applySchemaErrorsForSubtree(path: Path, errors: ValidationError[]): void;
|
|
1011
1007
|
setAllUserErrors(errors: readonly ValidationError[]): void;
|
|
1012
|
-
|
|
1008
|
+
setUserErrorsForPath(path: Path, errors: readonly ValidationError[]): void;
|
|
1013
1009
|
clearUserErrors(path?: Path): void;
|
|
1014
1010
|
/**
|
|
1015
1011
|
* Merged read — returns `[...schemaErrors[path], ...userErrors[path]]`.
|
|
@@ -1191,28 +1187,17 @@ type FormStore<F extends GenericForm, G extends GenericForm = F> = {
|
|
|
1191
1187
|
/**
|
|
1192
1188
|
* Subscribe to every `applyFormReplacement`. Fires synchronously
|
|
1193
1189
|
* after `form.value` has been swapped to `next` and all field /
|
|
1194
|
-
* originals bookkeeping has run. Used by
|
|
1195
|
-
*
|
|
1196
|
-
*
|
|
1197
|
-
*
|
|
1198
|
-
* about meta can ignore the parameter. Returns an unsubscribe
|
|
1199
|
-
* function.
|
|
1190
|
+
* originals bookkeeping has run. Used by undo/redo to hook the single
|
|
1191
|
+
* mutation funnel. The optional `meta` carries the originating call
|
|
1192
|
+
* site's intent; subscribers that don't care about meta can ignore the
|
|
1193
|
+
* parameter. Returns an unsubscribe function.
|
|
1200
1194
|
*/
|
|
1201
1195
|
onFormChange(listener: (next: F, meta?: WriteMeta) => void): () => void;
|
|
1202
|
-
/**
|
|
1203
|
-
* Register a `form.onChange` side-channel handler. `source === undefined`
|
|
1204
|
-
* is the whole form (root); `getForm` lazily resolves the public form
|
|
1205
|
-
* handle for `ctx.form`. Returns an idempotent `stop()`. A no-op on SSR.
|
|
1206
|
-
* The public `form.onChange` overloads and `useForm({ onChange })` wire
|
|
1207
|
-
* through here; dispatch happens in `commitWritePatches`.
|
|
1208
|
-
*/
|
|
1209
|
-
registerOnChange(source: OnChangeSource | undefined, handler: OnChangeHandler, options: OnChangeOptions | undefined, getForm: () => unknown): () => void;
|
|
1210
1196
|
/**
|
|
1211
1197
|
* Subscribe to successful submissions. Fires after the consumer's
|
|
1212
1198
|
* `onSubmit` callback has resolved — not on validation failure,
|
|
1213
|
-
* not on callback throw.
|
|
1214
|
-
*
|
|
1215
|
-
* server round-trip. Returns an unsubscribe function.
|
|
1199
|
+
* not on callback throw. The DevTools panel rides this to surface a
|
|
1200
|
+
* submit event. Returns an unsubscribe function.
|
|
1216
1201
|
*/
|
|
1217
1202
|
onSubmitSuccess(listener: () => void): () => void;
|
|
1218
1203
|
/**
|
|
@@ -1258,58 +1243,6 @@ type FormStore<F extends GenericForm, G extends GenericForm = F> = {
|
|
|
1258
1243
|
* owned by the caller (e.g. `'history'`).
|
|
1259
1244
|
*/
|
|
1260
1245
|
readonly modules: Map<string, unknown>;
|
|
1261
|
-
/**
|
|
1262
|
-
* Per-element persistence opt-in tracker. Empty by default; the
|
|
1263
|
-
* `v-register` directive populates entries on `mount` for each binding
|
|
1264
|
-
* that passed `register('foo', { persist: true })` and clears them on
|
|
1265
|
-
* `beforeUnmount`. Two SFCs sharing a key share this registry — opt-ins
|
|
1266
|
-
* are per-DOM-element, not per-component. Internal to the persistence
|
|
1267
|
-
* subsystem; not part of the consumer API surface.
|
|
1268
|
-
*/
|
|
1269
|
-
readonly persistOptIns: PersistOptInRegistry;
|
|
1270
|
-
/**
|
|
1271
|
-
* Resolved sensitive-path predicate for THIS form. Honors the
|
|
1272
|
-
* cascade (`useForm({ sensitiveNames })` > global default >
|
|
1273
|
-
* library `DEFAULT_SENSITIVE_NAMES`). Used by:
|
|
1274
|
-
* - the persistence opt-in gate (`allowSensitivePersist`);
|
|
1275
|
-
* - the multi-tab sync module (outbound strip + inbound reject);
|
|
1276
|
-
* - DevTools edit rejection;
|
|
1277
|
-
* - any future surface that needs to flag "this path holds
|
|
1278
|
-
* sensitive data."
|
|
1279
|
-
*
|
|
1280
|
-
* Frozen at FormStore construction. Two callsites sharing a key
|
|
1281
|
-
* share the predicate — consistent with the rest of the per-form
|
|
1282
|
-
* resolved-config surface.
|
|
1283
|
-
*/
|
|
1284
|
-
readonly isSensitivePath: (path: Path | PathKey | string) => boolean;
|
|
1285
|
-
/**
|
|
1286
|
-
* Canonical path keys explicitly opted OUT of multi-tab sync by
|
|
1287
|
-
* `register(path, { multiTab: false })`. The sync module's outbound
|
|
1288
|
-
* broadcaster strips patches at these paths AND the inbound listener
|
|
1289
|
-
* rejects them — symmetric tab-local behaviour for selected fields.
|
|
1290
|
-
*
|
|
1291
|
-
* Read-only Set view; mutate via `incrementNoSyncOptOut` /
|
|
1292
|
-
* `decrementNoSyncOptOut` which maintain a per-path ref count so
|
|
1293
|
-
* multiple bindings on the same path balance correctly across
|
|
1294
|
-
* dynamic conditional renders. Empty by default.
|
|
1295
|
-
*/
|
|
1296
|
-
readonly noSyncPaths: ReadonlySet<PathKey>;
|
|
1297
|
-
/**
|
|
1298
|
-
* Ref-counted "this path is tab-local" registration. Called by
|
|
1299
|
-
* `v-register`'s `created` hook for any binding that declared
|
|
1300
|
-
* `register('x', { multiTab: false })`. The first call for a given
|
|
1301
|
-
* path adds it to `noSyncPaths`; subsequent calls just bump the
|
|
1302
|
-
* ref count. Pair with `decrementNoSyncOptOut`.
|
|
1303
|
-
*/
|
|
1304
|
-
incrementNoSyncOptOut(path: PathKey): void;
|
|
1305
|
-
/**
|
|
1306
|
-
* Symmetric companion to `incrementNoSyncOptOut`. Called by
|
|
1307
|
-
* `v-register`'s `beforeUnmount` hook. When the ref count for a
|
|
1308
|
-
* path drops to zero, the path is removed from `noSyncPaths` —
|
|
1309
|
-
* dynamic toggling (the binding rendered conditionally) restores
|
|
1310
|
-
* full sync to the path when the last opt-out unmounts.
|
|
1311
|
-
*/
|
|
1312
|
-
decrementNoSyncOptOut(path: PathKey): void;
|
|
1313
1246
|
/**
|
|
1314
1247
|
* Resolved schema-coercion index — the merged config from
|
|
1315
1248
|
* `createAttaform({ defaults: { coerce } })` ∪ `useForm({ coerce })`,
|
|
@@ -1378,9 +1311,8 @@ type SerializedFormData = {
|
|
|
1378
1311
|
*/
|
|
1379
1312
|
readonly schemaErrors: ReadonlyArray<readonly [string, unknown]>;
|
|
1380
1313
|
/**
|
|
1381
|
-
* Errors set explicitly via `
|
|
1382
|
-
*
|
|
1383
|
-
* at snapshot time. Replayed at hydration; persists across
|
|
1314
|
+
* Errors set explicitly via `setErrors` (typically a server
|
|
1315
|
+
* response) at snapshot time. Replayed at hydration; persists across
|
|
1384
1316
|
* client-side re-validation.
|
|
1385
1317
|
*/
|
|
1386
1318
|
readonly userErrors: ReadonlyArray<readonly [string, unknown]>;
|
|
@@ -1808,9 +1740,9 @@ declare function lazy<Ctx = WizardCtx>(resolve: (ctx: Ctx) => AnyForm | string |
|
|
|
1808
1740
|
* `issue.code` (e.g. `zod:too_small`). No enum here because
|
|
1809
1741
|
* Zod's code list evolves.
|
|
1810
1742
|
* - consumer-defined — anything the consumer's backend / app stamps
|
|
1811
|
-
* onto a `ValidationError` (
|
|
1812
|
-
* or
|
|
1813
|
-
*
|
|
1743
|
+
* onto a `ValidationError` (a server response handed to `setErrors`,
|
|
1744
|
+
* or a code passed inline). Pick a scope (`api:`, `auth:`, etc.) and
|
|
1745
|
+
* stay consistent.
|
|
1814
1746
|
*
|
|
1815
1747
|
* Use these constants in tests and error-routing UI:
|
|
1816
1748
|
*
|
|
@@ -1854,6 +1786,14 @@ declare const AttaformErrorCode: {
|
|
|
1854
1786
|
* `form.hydrateError` for retry UX.
|
|
1855
1787
|
*/
|
|
1856
1788
|
readonly ActivationFailed: "atta:activation-failed";
|
|
1789
|
+
/**
|
|
1790
|
+
* Default code stamped on a manual error set through `form.setErrors`
|
|
1791
|
+
* when the caller omits an explicit `code`. The `setErrors` input is
|
|
1792
|
+
* lenient (`code` optional), so this is the fallback that keeps every
|
|
1793
|
+
* produced `ValidationError` carrying a stable, branchable identifier.
|
|
1794
|
+
* Override it per error by passing your own `code` (`api:…`, `auth:…`).
|
|
1795
|
+
*/
|
|
1796
|
+
readonly UserError: "atta:user-error";
|
|
1857
1797
|
};
|
|
1858
1798
|
type AttaformErrorCode = (typeof AttaformErrorCode)[keyof typeof AttaformErrorCode];
|
|
1859
1799
|
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Peel `.optional()` / `.nullable()` / `.default()` / `.refine()` /
|
|
5
|
+
* `.transform()` wrappers off a Zod v3 schema to reach the form root,
|
|
6
|
+
* then return it: a `ZodObject` (fixed-shape form), a `ZodRecord`
|
|
7
|
+
* (dictionary form), or a `ZodDiscriminatedUnion` (variant form).
|
|
8
|
+
* Returns `never` for any other root, which makes the `useForm`
|
|
9
|
+
* projections collapse to `never` so the call fails to typecheck
|
|
10
|
+
* rather than producing a misshapen form type.
|
|
11
|
+
*
|
|
12
|
+
* Used internally by the v3 `useForm` overload to project an arbitrary
|
|
13
|
+
* supported root to its input / output / storage-read shapes.
|
|
14
|
+
*/
|
|
15
|
+
type UnwrapZodRoot<T> = T extends z.ZodEffects<infer Inner> ? UnwrapZodRoot<Inner> : T extends z.ZodOptional<infer Inner> ? UnwrapZodRoot<Inner> : T extends z.ZodNullable<infer Inner> ? UnwrapZodRoot<Inner> : T extends z.ZodDefault<infer Inner> ? UnwrapZodRoot<Inner> : T extends z.ZodObject<infer Shape> ? z.ZodObject<Shape> : T extends z.ZodRecord<infer Key, infer Value> ? z.ZodRecord<Key, Value> : T extends z.ZodDiscriminatedUnion<infer Disc, infer Options> ? z.ZodDiscriminatedUnion<Disc, Options> : never;
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* The Zod v3 schema roots `useForm` accepts. Mirror of the v4
|
|
19
|
+
* `SupportedRootSchema`, expressed in v3's type vocabulary: a
|
|
20
|
+
* fixed-shape `z.object({ … })`, a `z.record(K, V)` dictionary form, or
|
|
21
|
+
* a `z.discriminatedUnion(disc, [...])` variant form.
|
|
22
|
+
*
|
|
23
|
+
* Other roots (a bare `z.union`, a root `z.array`, primitives,
|
|
24
|
+
* `z.map` / `z.set`) are not form roots; wrap them under a key. The
|
|
25
|
+
* adapter's runtime construction rejects them with a legible error.
|
|
26
|
+
*
|
|
27
|
+
* The discriminated-union arm is written with v3's parameter order
|
|
28
|
+
* (`<Discriminator, Options>`), the reverse of v4's; both classes
|
|
29
|
+
* require their arguments, so the arm stays fully applied to avoid the
|
|
30
|
+
* single-major `any`-collapse the v4 alias documents.
|
|
31
|
+
*/
|
|
32
|
+
type SupportedRootSchema = z.ZodObject<z.ZodRawShape> | z.ZodRecord<z.ZodTypeAny, z.ZodTypeAny> | z.ZodDiscriminatedUnion<string, readonly z.ZodDiscriminatedUnionOption<string>[]>;
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* v3 mirror of the Zod v4 `StorageShape`. Per top-level key, default
|
|
36
|
+
* to `z.output<Shape[K]>` (the post-init view — defaults have fired,
|
|
37
|
+
* Zod's own recursion peels nested defaults inside structural
|
|
38
|
+
* containers); fall back to `z.input<Shape[K]>` for transform / pipe
|
|
39
|
+
* carriers (`ZodEffects`, `ZodPipeline`) where storage holds the
|
|
40
|
+
* pre-transform input — transforms only run at submission /
|
|
41
|
+
* validation, not at the write boundary.
|
|
42
|
+
*
|
|
43
|
+
* v3 quirk: `ZodEffects` covers BOTH `.transform()` and
|
|
44
|
+
* `z.preprocess()` at the TS level — v3 doesn't carry a separate
|
|
45
|
+
* preprocess class the way v4 does. Deferring to `z.input` for
|
|
46
|
+
* `ZodEffects` means a top-level `z.preprocess(fn, T)` leaf reads as
|
|
47
|
+
* the preprocess input (commonly `unknown`); reach for the
|
|
48
|
+
* `AbstractSchema` escape hatch if a stronger type is needed.
|
|
49
|
+
* Transforms preserve their pre-transform input shape, which matches
|
|
50
|
+
* storage.
|
|
51
|
+
*/
|
|
52
|
+
type StorageShape<S extends z.ZodTypeAny> = S extends z.ZodObject<infer Shape> ? {
|
|
53
|
+
[K in keyof Shape]-?: Shape[K] extends z.ZodEffects<z.ZodTypeAny> | z.ZodPipeline<z.ZodTypeAny, z.ZodTypeAny> ? z.input<Shape[K]> : z.output<Shape[K]>;
|
|
54
|
+
} : z.input<S>;
|
|
55
|
+
|
|
56
|
+
export type { SupportedRootSchema as S, UnwrapZodRoot as U, StorageShape as a };
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Peel `.optional()` / `.nullable()` / `.default()` / `.refine()` /
|
|
5
|
+
* `.transform()` wrappers off a Zod v3 schema to reach the form root,
|
|
6
|
+
* then return it: a `ZodObject` (fixed-shape form), a `ZodRecord`
|
|
7
|
+
* (dictionary form), or a `ZodDiscriminatedUnion` (variant form).
|
|
8
|
+
* Returns `never` for any other root, which makes the `useForm`
|
|
9
|
+
* projections collapse to `never` so the call fails to typecheck
|
|
10
|
+
* rather than producing a misshapen form type.
|
|
11
|
+
*
|
|
12
|
+
* Used internally by the v3 `useForm` overload to project an arbitrary
|
|
13
|
+
* supported root to its input / output / storage-read shapes.
|
|
14
|
+
*/
|
|
15
|
+
type UnwrapZodRoot<T> = T extends z.ZodEffects<infer Inner> ? UnwrapZodRoot<Inner> : T extends z.ZodOptional<infer Inner> ? UnwrapZodRoot<Inner> : T extends z.ZodNullable<infer Inner> ? UnwrapZodRoot<Inner> : T extends z.ZodDefault<infer Inner> ? UnwrapZodRoot<Inner> : T extends z.ZodObject<infer Shape> ? z.ZodObject<Shape> : T extends z.ZodRecord<infer Key, infer Value> ? z.ZodRecord<Key, Value> : T extends z.ZodDiscriminatedUnion<infer Disc, infer Options> ? z.ZodDiscriminatedUnion<Disc, Options> : never;
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* The Zod v3 schema roots `useForm` accepts. Mirror of the v4
|
|
19
|
+
* `SupportedRootSchema`, expressed in v3's type vocabulary: a
|
|
20
|
+
* fixed-shape `z.object({ … })`, a `z.record(K, V)` dictionary form, or
|
|
21
|
+
* a `z.discriminatedUnion(disc, [...])` variant form.
|
|
22
|
+
*
|
|
23
|
+
* Other roots (a bare `z.union`, a root `z.array`, primitives,
|
|
24
|
+
* `z.map` / `z.set`) are not form roots; wrap them under a key. The
|
|
25
|
+
* adapter's runtime construction rejects them with a legible error.
|
|
26
|
+
*
|
|
27
|
+
* The discriminated-union arm is written with v3's parameter order
|
|
28
|
+
* (`<Discriminator, Options>`), the reverse of v4's; both classes
|
|
29
|
+
* require their arguments, so the arm stays fully applied to avoid the
|
|
30
|
+
* single-major `any`-collapse the v4 alias documents.
|
|
31
|
+
*/
|
|
32
|
+
type SupportedRootSchema = z.ZodObject<z.ZodRawShape> | z.ZodRecord<z.ZodTypeAny, z.ZodTypeAny> | z.ZodDiscriminatedUnion<string, readonly z.ZodDiscriminatedUnionOption<string>[]>;
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* v3 mirror of the Zod v4 `StorageShape`. Per top-level key, default
|
|
36
|
+
* to `z.output<Shape[K]>` (the post-init view — defaults have fired,
|
|
37
|
+
* Zod's own recursion peels nested defaults inside structural
|
|
38
|
+
* containers); fall back to `z.input<Shape[K]>` for transform / pipe
|
|
39
|
+
* carriers (`ZodEffects`, `ZodPipeline`) where storage holds the
|
|
40
|
+
* pre-transform input — transforms only run at submission /
|
|
41
|
+
* validation, not at the write boundary.
|
|
42
|
+
*
|
|
43
|
+
* v3 quirk: `ZodEffects` covers BOTH `.transform()` and
|
|
44
|
+
* `z.preprocess()` at the TS level — v3 doesn't carry a separate
|
|
45
|
+
* preprocess class the way v4 does. Deferring to `z.input` for
|
|
46
|
+
* `ZodEffects` means a top-level `z.preprocess(fn, T)` leaf reads as
|
|
47
|
+
* the preprocess input (commonly `unknown`); reach for the
|
|
48
|
+
* `AbstractSchema` escape hatch if a stronger type is needed.
|
|
49
|
+
* Transforms preserve their pre-transform input shape, which matches
|
|
50
|
+
* storage.
|
|
51
|
+
*/
|
|
52
|
+
type StorageShape<S extends z.ZodTypeAny> = S extends z.ZodObject<infer Shape> ? {
|
|
53
|
+
[K in keyof Shape]-?: Shape[K] extends z.ZodEffects<z.ZodTypeAny> | z.ZodPipeline<z.ZodTypeAny, z.ZodTypeAny> ? z.input<Shape[K]> : z.output<Shape[K]>;
|
|
54
|
+
} : z.input<S>;
|
|
55
|
+
|
|
56
|
+
export type { SupportedRootSchema as S, UnwrapZodRoot as U, StorageShape as a };
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Peel `.optional()` / `.nullable()` / `.default()` / `.refine()` /
|
|
5
|
+
* `.transform()` wrappers off a Zod v3 schema to reach the form root,
|
|
6
|
+
* then return it: a `ZodObject` (fixed-shape form), a `ZodRecord`
|
|
7
|
+
* (dictionary form), or a `ZodDiscriminatedUnion` (variant form).
|
|
8
|
+
* Returns `never` for any other root, which makes the `useForm`
|
|
9
|
+
* projections collapse to `never` so the call fails to typecheck
|
|
10
|
+
* rather than producing a misshapen form type.
|
|
11
|
+
*
|
|
12
|
+
* Used internally by the v3 `useForm` overload to project an arbitrary
|
|
13
|
+
* supported root to its input / output / storage-read shapes.
|
|
14
|
+
*/
|
|
15
|
+
type UnwrapZodRoot<T> = T extends z.ZodEffects<infer Inner> ? UnwrapZodRoot<Inner> : T extends z.ZodOptional<infer Inner> ? UnwrapZodRoot<Inner> : T extends z.ZodNullable<infer Inner> ? UnwrapZodRoot<Inner> : T extends z.ZodDefault<infer Inner> ? UnwrapZodRoot<Inner> : T extends z.ZodObject<infer Shape> ? z.ZodObject<Shape> : T extends z.ZodRecord<infer Key, infer Value> ? z.ZodRecord<Key, Value> : T extends z.ZodDiscriminatedUnion<infer Disc, infer Options> ? z.ZodDiscriminatedUnion<Disc, Options> : never;
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* The Zod v3 schema roots `useForm` accepts. Mirror of the v4
|
|
19
|
+
* `SupportedRootSchema`, expressed in v3's type vocabulary: a
|
|
20
|
+
* fixed-shape `z.object({ … })`, a `z.record(K, V)` dictionary form, or
|
|
21
|
+
* a `z.discriminatedUnion(disc, [...])` variant form.
|
|
22
|
+
*
|
|
23
|
+
* Other roots (a bare `z.union`, a root `z.array`, primitives,
|
|
24
|
+
* `z.map` / `z.set`) are not form roots; wrap them under a key. The
|
|
25
|
+
* adapter's runtime construction rejects them with a legible error.
|
|
26
|
+
*
|
|
27
|
+
* The discriminated-union arm is written with v3's parameter order
|
|
28
|
+
* (`<Discriminator, Options>`), the reverse of v4's; both classes
|
|
29
|
+
* require their arguments, so the arm stays fully applied to avoid the
|
|
30
|
+
* single-major `any`-collapse the v4 alias documents.
|
|
31
|
+
*/
|
|
32
|
+
type SupportedRootSchema = z.ZodObject<z.ZodRawShape> | z.ZodRecord<z.ZodTypeAny, z.ZodTypeAny> | z.ZodDiscriminatedUnion<string, readonly z.ZodDiscriminatedUnionOption<string>[]>;
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* v3 mirror of the Zod v4 `StorageShape`. Per top-level key, default
|
|
36
|
+
* to `z.output<Shape[K]>` (the post-init view — defaults have fired,
|
|
37
|
+
* Zod's own recursion peels nested defaults inside structural
|
|
38
|
+
* containers); fall back to `z.input<Shape[K]>` for transform / pipe
|
|
39
|
+
* carriers (`ZodEffects`, `ZodPipeline`) where storage holds the
|
|
40
|
+
* pre-transform input — transforms only run at submission /
|
|
41
|
+
* validation, not at the write boundary.
|
|
42
|
+
*
|
|
43
|
+
* v3 quirk: `ZodEffects` covers BOTH `.transform()` and
|
|
44
|
+
* `z.preprocess()` at the TS level — v3 doesn't carry a separate
|
|
45
|
+
* preprocess class the way v4 does. Deferring to `z.input` for
|
|
46
|
+
* `ZodEffects` means a top-level `z.preprocess(fn, T)` leaf reads as
|
|
47
|
+
* the preprocess input (commonly `unknown`); reach for the
|
|
48
|
+
* `AbstractSchema` escape hatch if a stronger type is needed.
|
|
49
|
+
* Transforms preserve their pre-transform input shape, which matches
|
|
50
|
+
* storage.
|
|
51
|
+
*/
|
|
52
|
+
type StorageShape<S extends z.ZodTypeAny> = S extends z.ZodObject<infer Shape> ? {
|
|
53
|
+
[K in keyof Shape]-?: Shape[K] extends z.ZodEffects<z.ZodTypeAny> | z.ZodPipeline<z.ZodTypeAny, z.ZodTypeAny> ? z.input<Shape[K]> : z.output<Shape[K]>;
|
|
54
|
+
} : z.input<S>;
|
|
55
|
+
|
|
56
|
+
export type { SupportedRootSchema as S, UnwrapZodRoot as U, StorageShape as a };
|