attaform 0.0.1 → 0.14.0

package/dist/zod-v3.d.mts

@@ -0,0 +1,164 @@
+import { z } from 'zod';
+import { a8 as ValidateOnConfig, F as FormKey, x as OnInvalidSubmitPolicy, E as PersistConfig, v as HistoryConfig, C as CoercionRegistry, G as GenericForm, U as UseFormConfiguration, b as AbstractSchema, D as DeepPartial, c as DefaultValuesShape, d as UseFormReturnType } from './shared/attaform.DDXrY-1Q.mjs';
+export { a6 as Unset, ad as isUnset, af as unset } from './shared/attaform.DDXrY-1Q.mjs';
+export { A as AttaformErrorCode, i as injectForm, u as useRegister } from './shared/attaform.DOKOyb3Y.mjs';
+import 'vue';
+
+/**
+ * Narrow accessor type for Zod v3's internal `_def`. Only useful
+ * when writing a custom adapter that needs to read internals
+ * directly. Most consumers should never reach for this.
+ */
+interface ZodTypeWithInnerType extends z.ZodTypeAny {
+    _def: {
+        typeName: string;
+        innerType: z.ZodTypeAny;
+    };
+}
+/**
+ * The "honest read shape" of a Zod v3 schema — fields under records,
+ * arrays, and dynamic boundaries are tagged optional/undefined to
+ * reflect the runtime reality that those slots may be missing.
+ *
+ * Used internally by the v3 adapter as the read-side type for
+ * `getValue` / `getFieldState`. Not commonly needed in consumer code.
+ */
+type TypeWithNullableDynamicKeys<Schema extends z.ZodSchema, CrossedBoundary extends boolean = false> = Schema extends z.ZodRecord<infer KeySchema extends z.ZodTypeAny, infer ValueSchema extends z.ZodTypeAny> ? {
+    [Key in z.infer<KeySchema>]?: TypeWithNullableDynamicKeys<ValueSchema, true>;
+} : Schema extends z.ZodArray<infer ItemSchema extends z.ZodTypeAny> ? (TypeWithNullableDynamicKeys<ItemSchema, true> | undefined)[] : Schema extends z.ZodObject<infer Shape> ? {
+    [Key in keyof Shape]: TypeWithNullableDynamicKeys<Shape[Key], CrossedBoundary> | (CrossedBoundary extends true ? undefined : never);
+} : Schema extends z.ZodDiscriminatedUnion<string, infer Options> ? {
+    [Key in keyof Options]: TypeWithNullableDynamicKeys<Options[Key], true>;
+}[keyof Options & number] : // Fallback to z.infer for all other schemas
+z.infer<Schema> | (CrossedBoundary extends true ? undefined : never);
+
+/**
+ * Configuration object for the Zod v3 `useForm` overload. Same
+ * shape as the schema-agnostic `UseFormConfiguration`, but with
+ * `schema` constrained to a `z.ZodObject` (or wrapped form).
+ */
+type UseFormConfigurationWithZod<Schema extends z.ZodType<unknown>, DefaultValues> = ValidateOnConfig & {
+    /** A Zod v3 `ZodObject` schema (or one wrapped in `.optional()` / `.nullable()` / `.default()` / `.refine()`). */
+    schema: Schema extends z.ZodType<unknown> ? UnwrapZodObject<Schema> extends z.ZodObject<z.ZodRawShape> ? Schema : never : never;
+    key?: FormKey;
+    defaultValues?: DefaultValues;
+    strict?: boolean;
+    onInvalidSubmit?: OnInvalidSubmitPolicy;
+    persist?: PersistConfig;
+    history?: HistoryConfig;
+    rememberVariants?: boolean;
+    coerce?: boolean | CoercionRegistry;
+};
+/**
+ * Peel `.optional()` / `.nullable()` / `.default()` / `.refine()` /
+ * `.transform()` wrappers off a Zod v3 schema to reach the inner
+ * `ZodObject`. Returns `never` if no `ZodObject` is found.
+ *
+ * Used internally by the v3 `useForm` overload to verify the
+ * supplied schema bottoms out at a `ZodObject`.
+ */
+type UnwrapZodObject<T> = T extends z.ZodEffects<infer Inner> ? UnwrapZodObject<Inner> : T extends z.ZodOptional<infer Inner> ? UnwrapZodObject<Inner> : T extends z.ZodNullable<infer Inner> ? UnwrapZodObject<Inner> : T extends z.ZodDefault<infer Inner> ? UnwrapZodObject<Inner> : T extends z.ZodObject<infer Shape> ? z.ZodObject<Shape> : never;
+
+/**
+ * Create a form bound to a custom `AbstractSchema` adapter.
+ *
+ * ```ts
+ * import { useForm } from 'attaform/zod-v3'
+ *
+ * const form = useForm({ schema: myAdapter, defaultValues: { … } })
+ * ```
+ *
+ * For Zod schemas, prefer the overload that accepts a `ZodObject`
+ * directly — it wraps the adapter automatically. For Zod v4, import
+ * from `attaform/zod` instead.
+ */
+declare function useForm<Form extends GenericForm, GetValueFormType extends GenericForm = Form>(configuration: UseFormConfiguration<Form, GetValueFormType, AbstractSchema<Form, GetValueFormType>, DeepPartial<DefaultValuesShape<Form>>>): UseFormReturnType<Form, GetValueFormType>;
+/**
+ * Create a form bound to a Zod v3 `ZodObject` schema.
+ *
+ * ```ts
+ * import { useForm } from 'attaform/zod-v3'
+ * import { z } from 'zod'
+ *
+ * const form = useForm({
+ *   schema: z.object({
+ *     email: z.string().email(),
+ *     password: z.string().min(8),
+ *   }),
+ *   defaultValues: { email: '' },
+ *   validateOn: 'blur',
+ * })
+ * ```
+ *
+ * Returns a form API exposing `register`, `values`, `errors`,
+ * `fields`, `setValue`, `handleSubmit`, `meta`, field-array
+ * helpers, and more. See `UseFormReturnType` for the full
+ * surface.
+ *
+ * For Zod v4, import from `attaform/zod` instead.
+ */
+declare function useForm<Schema extends z.ZodObject<z.ZodRawShape>, GetValueFormType extends GenericForm = TypeWithNullableDynamicKeys<Schema>>(configuration: UseFormConfigurationWithZod<Schema, DeepPartial<DefaultValuesShape<z.infer<UnwrapZodObject<Schema>>>>>): UseFormReturnType<z.infer<UnwrapZodObject<Schema>>, GetValueFormType>;
+
+/**
+ * Wrap a Zod v3 `ZodObject` schema in an `AbstractSchema` factory.
+ *
+ * Most consumers never call this directly — `useForm` from
+ * `attaform/zod-v3` does the wrapping automatically. Reach
+ * for it only when integrating with a custom code path that needs
+ * the adapter outside of `useForm`.
+ *
+ * Throws if the underlying schema isn't a `ZodObject`.
+ */
+declare function zodAdapter<FormSchema extends z.ZodSchema, Form extends z.infer<FormSchema>, GetValueFormType extends TypeWithNullableDynamicKeys<FormSchema>>(zodSchema: FormSchema): (formKey: FormKey) => AbstractSchema<Form, GetValueFormType>;
+
+type ZodTypeMap = {
+    ZodObject: z.AnyZodObject;
+    ZodDiscriminatedUnion: z.ZodDiscriminatedUnion<string, [
+        z.ZodDiscriminatedUnionOption<string>,
+        ...z.ZodDiscriminatedUnionOption<string>[]
+    ]>;
+    ZodArray: z.ZodArray<z.ZodTypeAny>;
+    ZodSet: z.ZodSet<z.ZodTypeAny>;
+    ZodRecord: z.ZodRecord<z.ZodTypeAny, z.ZodTypeAny>;
+    ZodDefault: z.ZodDefault<z.ZodTypeAny>;
+    ZodOptional: z.ZodOptional<z.ZodTypeAny>;
+    ZodNullable: z.ZodNullable<z.ZodTypeAny>;
+    ZodType: z.ZodTypeAny;
+    ZodEffects: z.ZodEffects<z.ZodTypeAny>;
+    ZodBoolean: z.ZodBoolean;
+    ZodEnum: z.ZodEnum<[string, ...string[]]>;
+    ZodNull: z.ZodNull;
+    ZodUndefined: z.ZodUndefined;
+    ZodLiteral: z.ZodLiteral<unknown>;
+    ZodUnion: z.ZodUnion<[z.ZodTypeAny, z.ZodTypeAny, ...z.ZodTypeAny[]]>;
+    ZodTuple: z.ZodTuple<[z.ZodTypeAny, ...z.ZodTypeAny[]]>;
+    ZodString: z.ZodString;
+    ZodNumber: z.ZodNumber;
+    ZodBigInt: z.ZodBigInt;
+    ZodDate: z.ZodDate;
+    ZodPipeline: z.ZodPipeline<z.ZodTypeAny, z.ZodTypeAny>;
+    ZodReadonly: z.ZodReadonly<z.ZodTypeAny>;
+    ZodBranded: z.ZodBranded<z.ZodTypeAny, string | number | symbol>;
+    ZodCatch: z.ZodCatch<z.ZodTypeAny>;
+    ZodIntersection: z.ZodIntersection<z.ZodTypeAny, z.ZodTypeAny>;
+    ZodLazy: z.ZodLazy<z.ZodTypeAny>;
+    ZodNativeEnum: z.ZodNativeEnum<z.EnumLike>;
+};
+/**
+ * Type guard for a Zod v3 schema kind. Returns `true` when `schema`
+ * is a Zod v3 instance of the named kind (`ZodString`, `ZodObject`,
+ * etc.) and narrows the type accordingly.
+ *
+ * ```ts
+ * if (isZodSchemaType(schema, 'ZodObject')) {
+ *   // schema is now typed as z.AnyZodObject
+ * }
+ * ```
+ *
+ * Useful when building adapters or introspection helpers that branch
+ * on schema shape. Most consumers don't need this.
+ */
+declare function isZodSchemaType<K extends keyof ZodTypeMap>(schema: unknown, expectedType: K): schema is ZodTypeMap[K];
+
+export { isZodSchemaType, useForm, zodAdapter };
+export type { TypeWithNullableDynamicKeys, UnwrapZodObject, UseFormConfigurationWithZod, ZodTypeWithInnerType };

package/dist/zod-v3.d.ts

@@ -0,0 +1,164 @@
+import { z } from 'zod';
+import { a8 as ValidateOnConfig, F as FormKey, x as OnInvalidSubmitPolicy, E as PersistConfig, v as HistoryConfig, C as CoercionRegistry, G as GenericForm, U as UseFormConfiguration, b as AbstractSchema, D as DeepPartial, c as DefaultValuesShape, d as UseFormReturnType } from './shared/attaform.DDXrY-1Q.js';
+export { a6 as Unset, ad as isUnset, af as unset } from './shared/attaform.DDXrY-1Q.js';
+export { A as AttaformErrorCode, i as injectForm, u as useRegister } from './shared/attaform.BYc9kugA.js';
+import 'vue';
+
+/**
+ * Narrow accessor type for Zod v3's internal `_def`. Only useful
+ * when writing a custom adapter that needs to read internals
+ * directly. Most consumers should never reach for this.
+ */
+interface ZodTypeWithInnerType extends z.ZodTypeAny {
+    _def: {
+        typeName: string;
+        innerType: z.ZodTypeAny;
+    };
+}
+/**
+ * The "honest read shape" of a Zod v3 schema — fields under records,
+ * arrays, and dynamic boundaries are tagged optional/undefined to
+ * reflect the runtime reality that those slots may be missing.
+ *
+ * Used internally by the v3 adapter as the read-side type for
+ * `getValue` / `getFieldState`. Not commonly needed in consumer code.
+ */
+type TypeWithNullableDynamicKeys<Schema extends z.ZodSchema, CrossedBoundary extends boolean = false> = Schema extends z.ZodRecord<infer KeySchema extends z.ZodTypeAny, infer ValueSchema extends z.ZodTypeAny> ? {
+    [Key in z.infer<KeySchema>]?: TypeWithNullableDynamicKeys<ValueSchema, true>;
+} : Schema extends z.ZodArray<infer ItemSchema extends z.ZodTypeAny> ? (TypeWithNullableDynamicKeys<ItemSchema, true> | undefined)[] : Schema extends z.ZodObject<infer Shape> ? {
+    [Key in keyof Shape]: TypeWithNullableDynamicKeys<Shape[Key], CrossedBoundary> | (CrossedBoundary extends true ? undefined : never);
+} : Schema extends z.ZodDiscriminatedUnion<string, infer Options> ? {
+    [Key in keyof Options]: TypeWithNullableDynamicKeys<Options[Key], true>;
+}[keyof Options & number] : // Fallback to z.infer for all other schemas
+z.infer<Schema> | (CrossedBoundary extends true ? undefined : never);
+
+/**
+ * Configuration object for the Zod v3 `useForm` overload. Same
+ * shape as the schema-agnostic `UseFormConfiguration`, but with
+ * `schema` constrained to a `z.ZodObject` (or wrapped form).
+ */
+type UseFormConfigurationWithZod<Schema extends z.ZodType<unknown>, DefaultValues> = ValidateOnConfig & {
+    /** A Zod v3 `ZodObject` schema (or one wrapped in `.optional()` / `.nullable()` / `.default()` / `.refine()`). */
+    schema: Schema extends z.ZodType<unknown> ? UnwrapZodObject<Schema> extends z.ZodObject<z.ZodRawShape> ? Schema : never : never;
+    key?: FormKey;
+    defaultValues?: DefaultValues;
+    strict?: boolean;
+    onInvalidSubmit?: OnInvalidSubmitPolicy;
+    persist?: PersistConfig;
+    history?: HistoryConfig;
+    rememberVariants?: boolean;
+    coerce?: boolean | CoercionRegistry;
+};
+/**
+ * Peel `.optional()` / `.nullable()` / `.default()` / `.refine()` /
+ * `.transform()` wrappers off a Zod v3 schema to reach the inner
+ * `ZodObject`. Returns `never` if no `ZodObject` is found.
+ *
+ * Used internally by the v3 `useForm` overload to verify the
+ * supplied schema bottoms out at a `ZodObject`.
+ */
+type UnwrapZodObject<T> = T extends z.ZodEffects<infer Inner> ? UnwrapZodObject<Inner> : T extends z.ZodOptional<infer Inner> ? UnwrapZodObject<Inner> : T extends z.ZodNullable<infer Inner> ? UnwrapZodObject<Inner> : T extends z.ZodDefault<infer Inner> ? UnwrapZodObject<Inner> : T extends z.ZodObject<infer Shape> ? z.ZodObject<Shape> : never;
+
+/**
+ * Create a form bound to a custom `AbstractSchema` adapter.
+ *
+ * ```ts
+ * import { useForm } from 'attaform/zod-v3'
+ *
+ * const form = useForm({ schema: myAdapter, defaultValues: { … } })
+ * ```
+ *
+ * For Zod schemas, prefer the overload that accepts a `ZodObject`
+ * directly — it wraps the adapter automatically. For Zod v4, import
+ * from `attaform/zod` instead.
+ */
+declare function useForm<Form extends GenericForm, GetValueFormType extends GenericForm = Form>(configuration: UseFormConfiguration<Form, GetValueFormType, AbstractSchema<Form, GetValueFormType>, DeepPartial<DefaultValuesShape<Form>>>): UseFormReturnType<Form, GetValueFormType>;
+/**
+ * Create a form bound to a Zod v3 `ZodObject` schema.
+ *
+ * ```ts
+ * import { useForm } from 'attaform/zod-v3'
+ * import { z } from 'zod'
+ *
+ * const form = useForm({
+ *   schema: z.object({
+ *     email: z.string().email(),
+ *     password: z.string().min(8),
+ *   }),
+ *   defaultValues: { email: '' },
+ *   validateOn: 'blur',
+ * })
+ * ```
+ *
+ * Returns a form API exposing `register`, `values`, `errors`,
+ * `fields`, `setValue`, `handleSubmit`, `meta`, field-array
+ * helpers, and more. See `UseFormReturnType` for the full
+ * surface.
+ *
+ * For Zod v4, import from `attaform/zod` instead.
+ */
+declare function useForm<Schema extends z.ZodObject<z.ZodRawShape>, GetValueFormType extends GenericForm = TypeWithNullableDynamicKeys<Schema>>(configuration: UseFormConfigurationWithZod<Schema, DeepPartial<DefaultValuesShape<z.infer<UnwrapZodObject<Schema>>>>>): UseFormReturnType<z.infer<UnwrapZodObject<Schema>>, GetValueFormType>;
+
+/**
+ * Wrap a Zod v3 `ZodObject` schema in an `AbstractSchema` factory.
+ *
+ * Most consumers never call this directly — `useForm` from
+ * `attaform/zod-v3` does the wrapping automatically. Reach
+ * for it only when integrating with a custom code path that needs
+ * the adapter outside of `useForm`.
+ *
+ * Throws if the underlying schema isn't a `ZodObject`.
+ */
+declare function zodAdapter<FormSchema extends z.ZodSchema, Form extends z.infer<FormSchema>, GetValueFormType extends TypeWithNullableDynamicKeys<FormSchema>>(zodSchema: FormSchema): (formKey: FormKey) => AbstractSchema<Form, GetValueFormType>;
+
+type ZodTypeMap = {
+    ZodObject: z.AnyZodObject;
+    ZodDiscriminatedUnion: z.ZodDiscriminatedUnion<string, [
+        z.ZodDiscriminatedUnionOption<string>,
+        ...z.ZodDiscriminatedUnionOption<string>[]
+    ]>;
+    ZodArray: z.ZodArray<z.ZodTypeAny>;
+    ZodSet: z.ZodSet<z.ZodTypeAny>;
+    ZodRecord: z.ZodRecord<z.ZodTypeAny, z.ZodTypeAny>;
+    ZodDefault: z.ZodDefault<z.ZodTypeAny>;
+    ZodOptional: z.ZodOptional<z.ZodTypeAny>;
+    ZodNullable: z.ZodNullable<z.ZodTypeAny>;
+    ZodType: z.ZodTypeAny;
+    ZodEffects: z.ZodEffects<z.ZodTypeAny>;
+    ZodBoolean: z.ZodBoolean;
+    ZodEnum: z.ZodEnum<[string, ...string[]]>;
+    ZodNull: z.ZodNull;
+    ZodUndefined: z.ZodUndefined;
+    ZodLiteral: z.ZodLiteral<unknown>;
+    ZodUnion: z.ZodUnion<[z.ZodTypeAny, z.ZodTypeAny, ...z.ZodTypeAny[]]>;
+    ZodTuple: z.ZodTuple<[z.ZodTypeAny, ...z.ZodTypeAny[]]>;
+    ZodString: z.ZodString;
+    ZodNumber: z.ZodNumber;
+    ZodBigInt: z.ZodBigInt;
+    ZodDate: z.ZodDate;
+    ZodPipeline: z.ZodPipeline<z.ZodTypeAny, z.ZodTypeAny>;
+    ZodReadonly: z.ZodReadonly<z.ZodTypeAny>;
+    ZodBranded: z.ZodBranded<z.ZodTypeAny, string | number | symbol>;
+    ZodCatch: z.ZodCatch<z.ZodTypeAny>;
+    ZodIntersection: z.ZodIntersection<z.ZodTypeAny, z.ZodTypeAny>;
+    ZodLazy: z.ZodLazy<z.ZodTypeAny>;
+    ZodNativeEnum: z.ZodNativeEnum<z.EnumLike>;
+};
+/**
+ * Type guard for a Zod v3 schema kind. Returns `true` when `schema`
+ * is a Zod v3 instance of the named kind (`ZodString`, `ZodObject`,
+ * etc.) and narrows the type accordingly.
+ *
+ * ```ts
+ * if (isZodSchemaType(schema, 'ZodObject')) {
+ *   // schema is now typed as z.AnyZodObject
+ * }
+ * ```
+ *
+ * Useful when building adapters or introspection helpers that branch
+ * on schema shape. Most consumers don't need this.
+ */
+declare function isZodSchemaType<K extends keyof ZodTypeMap>(schema: unknown, expectedType: K): schema is ZodTypeMap[K];
+
+export { isZodSchemaType, useForm, zodAdapter };
+export type { TypeWithNullableDynamicKeys, UnwrapZodObject, UseFormConfigurationWithZod, ZodTypeWithInnerType };