@tanstack/svelte-form 1.33.5 → 2.0.0-alpha.1

package/src/createForm.svelte.ts

@@ -1,350 +0,0 @@
-import { FormApi } from '@tanstack/form-core'
-import { useSelector } from '@tanstack/svelte-store'
-import { onMount } from 'svelte'
-import Field from './Field.svelte'
-import FormGroup from './FormGroup.svelte'
-import Subscribe from './Subscribe.svelte'
-import type {
-  Component,
-  ComponentConstructorOptions,
-  Snippet,
-  SvelteComponent,
-} from 'svelte'
-import type {
-  FormAsyncValidateOrFn,
-  FormOptions,
-  FormState,
-  FormValidateOrFn,
-} from '@tanstack/form-core'
-import type {
-  FieldComponent,
-  FormGroupComponent,
-  WithoutFunction,
-} from './types.js'
-
-export interface SvelteFormApi<
-  TParentData,
-  TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
-  TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
-  TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
-  TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
-  TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
-  TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
-  TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
-  TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
-  TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
-  TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
-  TSubmitMeta,
-> {
-  Field: FieldComponent<
-    TParentData,
-    TFormOnMount,
-    TFormOnChange,
-    TFormOnChangeAsync,
-    TFormOnBlur,
-    TFormOnBlurAsync,
-    TFormOnSubmit,
-    TFormOnSubmitAsync,
-    TFormOnDynamic,
-    TFormOnDynamicAsync,
-    TFormOnServer,
-    TSubmitMeta
-  >
-  FormGroup: FormGroupComponent<
-    TParentData,
-    TFormOnMount,
-    TFormOnChange,
-    TFormOnChangeAsync,
-    TFormOnBlur,
-    TFormOnBlurAsync,
-    TFormOnSubmit,
-    TFormOnSubmitAsync,
-    TFormOnDynamic,
-    TFormOnDynamicAsync,
-    TFormOnServer,
-    TSubmitMeta
-  >
-  useSelector: <
-    TSelected = NoInfer<
-      FormState<
-        TParentData,
-        TFormOnMount,
-        TFormOnChange,
-        TFormOnChangeAsync,
-        TFormOnBlur,
-        TFormOnBlurAsync,
-        TFormOnSubmit,
-        TFormOnSubmitAsync,
-        TFormOnDynamic,
-        TFormOnDynamicAsync,
-        TFormOnServer
-      >
-    >,
-  >(
-    selector?: (
-      state: NoInfer<
-        FormState<
-          TParentData,
-          TFormOnMount,
-          TFormOnChange,
-          TFormOnChangeAsync,
-          TFormOnBlur,
-          TFormOnBlurAsync,
-          TFormOnSubmit,
-          TFormOnSubmitAsync,
-          TFormOnDynamic,
-          TFormOnDynamicAsync,
-          TFormOnServer
-        >
-      >,
-    ) => TSelected,
-  ) => { current: TSelected }
-  /**
-   * @deprecated Use `form.useSelector` instead.
-   */
-  useStore: <
-    TSelected = NoInfer<
-      FormState<
-        TParentData,
-        TFormOnMount,
-        TFormOnChange,
-        TFormOnChangeAsync,
-        TFormOnBlur,
-        TFormOnBlurAsync,
-        TFormOnSubmit,
-        TFormOnSubmitAsync,
-        TFormOnDynamic,
-        TFormOnDynamicAsync,
-        TFormOnServer
-      >
-    >,
-  >(
-    selector?: (
-      state: NoInfer<
-        FormState<
-          TParentData,
-          TFormOnMount,
-          TFormOnChange,
-          TFormOnChangeAsync,
-          TFormOnBlur,
-          TFormOnBlurAsync,
-          TFormOnSubmit,
-          TFormOnSubmitAsync,
-          TFormOnDynamic,
-          TFormOnDynamicAsync,
-          TFormOnServer
-        >
-      >,
-    ) => TSelected,
-  ) => { current: TSelected }
-  // This giant type allows the type
-  // - to be used as a function (which they are now in Svelte 5)
-  // - to be used as a class (which they were in Svelte 4, and which Svelte intellisense still uses for backwards compat)
-  // - to preserve the generics correctly
-  // Once Svelte intellisense no longer has/needs backwards compat, we can remove the class constructor part
-  Subscribe: (<
-    TSelected = NoInfer<
-      FormState<
-        TParentData,
-        TFormOnMount,
-        TFormOnChange,
-        TFormOnChangeAsync,
-        TFormOnBlur,
-        TFormOnBlurAsync,
-        TFormOnSubmit,
-        TFormOnSubmitAsync,
-        TFormOnDynamic,
-        TFormOnDynamicAsync,
-        TFormOnServer
-      >
-    >,
-  >(
-    internal: any,
-    props: {
-      selector?: (
-        state: NoInfer<
-          FormState<
-            TParentData,
-            TFormOnMount,
-            TFormOnChange,
-            TFormOnChangeAsync,
-            TFormOnBlur,
-            TFormOnBlurAsync,
-            TFormOnSubmit,
-            TFormOnSubmitAsync,
-            TFormOnDynamic,
-            TFormOnDynamicAsync,
-            TFormOnServer
-          >
-        >,
-      ) => TSelected
-      children: Snippet<[NoInfer<TSelected>]>
-    },
-  ) => {}) &
-    (new <
-      TSelected = NoInfer<
-        FormState<
-          TParentData,
-          TFormOnMount,
-          TFormOnChange,
-          TFormOnChangeAsync,
-          TFormOnBlur,
-          TFormOnBlurAsync,
-          TFormOnSubmit,
-          TFormOnSubmitAsync,
-          TFormOnDynamic,
-          TFormOnDynamicAsync,
-          TFormOnServer
-        >
-      >,
-    >(
-      opts: ComponentConstructorOptions<{
-        selector?: (
-          state: NoInfer<
-            FormState<
-              TParentData,
-              TFormOnMount,
-              TFormOnChange,
-              TFormOnChangeAsync,
-              TFormOnBlur,
-              TFormOnBlurAsync,
-              TFormOnSubmit,
-              TFormOnSubmitAsync,
-              TFormOnDynamic,
-              TFormOnDynamicAsync,
-              TFormOnServer
-            >
-          >,
-        ) => TSelected
-        children: Snippet<[NoInfer<TSelected>]>
-      }>,
-    ) => SvelteComponent) &
-    WithoutFunction<Component>
-}
-
-/**
- * An extended version of the `FormApi` class that includes Svelte-specific functionalities from `SvelteFormApi`
- */
-export type SvelteFormExtendedApi<
-  TFormData,
-  TOnMount extends undefined | FormValidateOrFn<TFormData>,
-  TOnChange extends undefined | FormValidateOrFn<TFormData>,
-  TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
-  TOnBlur extends undefined | FormValidateOrFn<TFormData>,
-  TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
-  TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
-  TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
-  TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
-  TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
-  TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
-  TSubmitMeta,
-> = FormApi<
-  TFormData,
-  TOnMount,
-  TOnChange,
-  TOnChangeAsync,
-  TOnBlur,
-  TOnBlurAsync,
-  TOnSubmit,
-  TOnSubmitAsync,
-  TOnDynamic,
-  TOnDynamicAsync,
-  TOnServer,
-  TSubmitMeta
-> &
-  SvelteFormApi<
-    TFormData,
-    TOnMount,
-    TOnChange,
-    TOnChangeAsync,
-    TOnBlur,
-    TOnBlurAsync,
-    TOnSubmit,
-    TOnSubmitAsync,
-    TOnDynamic,
-    TOnDynamicAsync,
-    TOnServer,
-    TSubmitMeta
-  >
-
-export function createForm<
-  TParentData,
-  TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
-  TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
-  TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
-  TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
-  TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
-  TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
-  TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
-  TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
-  TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
-  TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
-  TSubmitMeta,
->(
-  opts?: () => FormOptions<
-    TParentData,
-    TFormOnMount,
-    TFormOnChange,
-    TFormOnChangeAsync,
-    TFormOnBlur,
-    TFormOnBlurAsync,
-    TFormOnSubmit,
-    TFormOnSubmitAsync,
-    TFormOnDynamic,
-    TFormOnDynamicAsync,
-    TFormOnServer,
-    TSubmitMeta
-  >,
-) {
-  const options = opts?.()
-  const api = new FormApi<
-    TParentData,
-    TFormOnMount,
-    TFormOnChange,
-    TFormOnChangeAsync,
-    TFormOnBlur,
-    TFormOnBlurAsync,
-    TFormOnSubmit,
-    TFormOnSubmitAsync,
-    TFormOnDynamic,
-    TFormOnDynamicAsync,
-    TFormOnServer,
-    TSubmitMeta
-  >(options)
-  const extendedApi: typeof api &
-    SvelteFormApi<
-      TParentData,
-      TFormOnMount,
-      TFormOnChange,
-      TFormOnChangeAsync,
-      TFormOnBlur,
-      TFormOnBlurAsync,
-      TFormOnSubmit,
-      TFormOnSubmitAsync,
-      TFormOnDynamic,
-      TFormOnDynamicAsync,
-      TFormOnServer,
-      TSubmitMeta
-    > = api as never
-
-  // @ts-expect-error constructor definition exists only on a type level
-  extendedApi.Field = (internal, props) =>
-    Field(internal, { ...props, form: api as never } as never)
-  // @ts-expect-error constructor definition exists only on a type level
-  extendedApi.FormGroup = (internal, props) =>
-    FormGroup(internal, { ...props, form: api as never } as never)
-  extendedApi.useSelector = (selector) => useSelector(api.store, selector)
-  /** @deprecated Use `form.useSelector` instead. */
-  extendedApi.useStore = extendedApi.useSelector
-  // @ts-expect-error constructor definition exists only on a type level
-  extendedApi.Subscribe = (internal, props) =>
-    Subscribe(internal, { ...props, store: api.store })
-
-  onMount(api.mount)
-
-  // formApi.update should not have any side effects. Think of it like a `useRef`
-  // that we need to keep updated every render with the most up-to-date information.
-  $effect.pre(() => api.update(opts?.()))
-
-  return extendedApi
-}

package/src/createFormCreator.svelte.ts

@@ -1,321 +0,0 @@
-import { getContext } from 'svelte'
-import { createForm } from './createForm.svelte'
-import AppFormSvelte from './AppForm.svelte'
-import AppFieldSvelte from './AppField.svelte'
-import { fieldContextKey, formContextKey } from './context-keys.js'
-import type {
-  AnyFieldApi,
-  AnyFormApi,
-  FieldApi,
-  FormAsyncValidateOrFn,
-  FormOptions,
-  FormValidateOrFn,
-} from '@tanstack/form-core'
-import type { FieldComponent } from './types.js'
-import type { SvelteFormExtendedApi } from './createForm.svelte'
-import type { Component, Snippet } from 'svelte'
-
-/**
- * TypeScript inferencing is weird.
- *
- * If you have:
- *
- * @example
- *
- * interface Args<T> {
- *     arg?: T
- * }
- *
- * function test<T>(arg?: Partial<Args<T>>): T {
- *     return 0 as any;
- * }
- *
- * const a = test({});
- *
- * Then `T` will default to `unknown`.
- *
- * However, if we change `test` to be:
- *
- * @example
- *
- * function test<T extends undefined>(arg?: Partial<Args<T>>): T;
- *
- * Then `T` becomes `undefined`.
- *
- * Here, we are checking if the passed type `T` extends `DefaultT` and **only**
- * `DefaultT`, as if that's the case we assume that inferencing has not occured.
- */
-type UnwrapOrAny<T> = [unknown] extends [T] ? any : T
-type UnwrapDefaultOrAny<DefaultT, T> = [DefaultT] extends [T]
-  ? [T] extends [DefaultT]
-    ? any
-    : T
-  : T
-
-export function createFormCreatorContexts() {
-  function useFieldContext<TData>() {
-    const field = getContext(fieldContextKey) as AnyFieldApi
-
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    if (!field) {
-      throw new Error(
-        '`fieldContext` only works when within a `fieldComponent` passed to `createFormCreator`',
-      )
-    }
-
-    return field as FieldApi<
-      any,
-      string,
-      TData,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any
-    >
-  }
-
-  function useFormContext() {
-    const form = getContext(formContextKey) as AnyFormApi
-
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    if (!form) {
-      throw new Error(
-        '`formContext` only works when within a `formComponent` passed to `createFormCreator`',
-      )
-    }
-
-    return form as SvelteFormExtendedApi<
-      // If you need access to the form data, you need to use `withForm` instead
-      Record<string, never>,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any,
-      any
-    >
-  }
-
-  return { useFieldContext, useFormContext }
-}
-
-interface CreateFormRuneProps<
-  TFieldComponents extends Record<string, Component<any, any>>,
-  TFormComponents extends Record<string, Component<any, any>>,
-> {
-  fieldComponents: TFieldComponents
-  formComponents: TFormComponents
-}
-
-/**
- * @private
- */
-type AppFieldExtendedSvelteFormApi<
-  TFormData,
-  TOnMount extends undefined | FormValidateOrFn<TFormData>,
-  TOnChange extends undefined | FormValidateOrFn<TFormData>,
-  TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
-  TOnBlur extends undefined | FormValidateOrFn<TFormData>,
-  TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
-  TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
-  TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
-  TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
-  TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
-  TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
-  TSubmitMeta,
-  TFieldComponents extends Record<string, Component<any, any>>,
-  TFormComponents extends Record<string, Component<any, any>>,
-> = SvelteFormExtendedApi<
-  TFormData,
-  TOnMount,
-  TOnChange,
-  TOnChangeAsync,
-  TOnBlur,
-  TOnBlurAsync,
-  TOnSubmit,
-  TOnSubmitAsync,
-  TOnDynamic,
-  TOnDynamicAsync,
-  TOnServer,
-  TSubmitMeta
-> &
-  NoInfer<TFormComponents> & {
-    AppField: FieldComponent<
-      TFormData,
-      TOnMount,
-      TOnChange,
-      TOnChangeAsync,
-      TOnBlur,
-      TOnBlurAsync,
-      TOnSubmit,
-      TOnSubmitAsync,
-      TOnDynamic,
-      TOnDynamicAsync,
-      TOnServer,
-      TSubmitMeta,
-      NoInfer<TFieldComponents>
-    >
-    AppForm: Component<{ children: Snippet }>
-  }
-
-export function createFormCreator<
-  const TComponents extends Record<string, Component<any, any>>,
-  const TFormComponents extends Record<string, Component<any, any>>,
->({
-  fieldComponents,
-  formComponents,
-}: CreateFormRuneProps<TComponents, TFormComponents>) {
-  function createAppForm<
-    TFormData,
-    TOnMount extends undefined | FormValidateOrFn<TFormData>,
-    TOnChange extends undefined | FormValidateOrFn<TFormData>,
-    TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
-    TOnBlur extends undefined | FormValidateOrFn<TFormData>,
-    TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
-    TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
-    TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
-    TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
-    TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
-    TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
-    TSubmitMeta,
-  >(
-    props: () => FormOptions<
-      TFormData,
-      TOnMount,
-      TOnChange,
-      TOnChangeAsync,
-      TOnBlur,
-      TOnBlurAsync,
-      TOnSubmit,
-      TOnSubmitAsync,
-      TOnDynamic,
-      TOnDynamicAsync,
-      TOnServer,
-      TSubmitMeta
-    >,
-  ): AppFieldExtendedSvelteFormApi<
-    TFormData,
-    TOnMount,
-    TOnChange,
-    TOnChangeAsync,
-    TOnBlur,
-    TOnBlurAsync,
-    TOnSubmit,
-    TOnSubmitAsync,
-    TOnDynamic,
-    TOnDynamicAsync,
-    TOnServer,
-    TSubmitMeta,
-    TComponents,
-    TFormComponents
-  > {
-    const form = createForm(props)
-
-    const AppForm = ((internal, props) => {
-      return AppFormSvelte(internal, { ...props, form })
-    }) as Component<{ children: Snippet }>
-
-    const AppField = ((internal, { children, ...fieldProps }) =>
-      AppFieldSvelte(internal, {
-        fieldProps,
-        form,
-        fieldComponents,
-        children,
-      } as never)) as FieldComponent<
-      TFormData,
-      TOnMount,
-      TOnChange,
-      TOnChangeAsync,
-      TOnBlur,
-      TOnBlurAsync,
-      TOnSubmit,
-      TOnSubmitAsync,
-      TOnDynamic,
-      TOnDynamicAsync,
-      TOnServer,
-      TSubmitMeta,
-      TComponents
-    >
-
-    const extendedForm = Object.assign(form, {
-      AppField,
-      AppForm,
-      ...formComponents,
-    })
-
-    return extendedForm
-  }
-
-  function getFormType<
-    TFormData,
-    TOnMount extends undefined | FormValidateOrFn<TFormData>,
-    TOnChange extends undefined | FormValidateOrFn<TFormData>,
-    TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
-    TOnBlur extends undefined | FormValidateOrFn<TFormData>,
-    TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
-    TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
-    TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
-    TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
-    TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
-    TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
-    TSubmitMeta,
-  >(
-    _formProps: FormOptions<
-      TFormData,
-      TOnMount,
-      TOnChange,
-      TOnChangeAsync,
-      TOnBlur,
-      TOnBlurAsync,
-      TOnSubmit,
-      TOnSubmitAsync,
-      TOnDynamic,
-      TOnDynamicAsync,
-      TOnServer,
-      TSubmitMeta
-    >,
-  ): AppFieldExtendedSvelteFormApi<
-    TFormData,
-    TOnMount,
-    TOnChange,
-    TOnChangeAsync,
-    TOnBlur,
-    TOnBlurAsync,
-    TOnSubmit,
-    TOnSubmitAsync,
-    TOnDynamic,
-    TOnDynamicAsync,
-    TOnServer,
-    TSubmitMeta,
-    TComponents,
-    TFormComponents
-  > {
-    return undefined as never
-  }
-
-  return {
-    createAppForm,
-    getFormType,
-  }
-}

package/src/index.ts

@@ -1,16 +0,0 @@
-export * from '@tanstack/form-core'
-
-export { useSelector, useStore } from '@tanstack/svelte-store'
-
-export { createForm, type SvelteFormApi } from './createForm.svelte.js'
-
-export { default as Field, createField } from './Field.svelte'
-
-export { default as FormGroup, createFormGroup } from './FormGroup.svelte'
-
-export type { FieldComponent, FormGroupComponent } from './types.js'
-
-export {
-  createFormCreator,
-  createFormCreatorContexts,
-} from './createFormCreator.svelte.js'