@tanstack/form-core 0.0.1

package/build/stats-react.json

@@ -0,0 +1,190 @@
+{
+  "version": 2,
+  "tree": {
+    "name": "root",
+    "children": [
+      {
+        "name": "index.production.js",
+        "children": [
+          {
+            "name": "node_modules/.pnpm/@tanstack+store@0.0.1-beta.84/node_modules/@tanstack/store/build/esm/index.js",
+            "uid": "52cd-13"
+          },
+          {
+            "name": "packages/form-core/src",
+            "children": [
+              {
+                "uid": "52cd-15",
+                "name": "utils.ts"
+              },
+              {
+                "uid": "52cd-17",
+                "name": "FormApi.ts"
+              },
+              {
+                "uid": "52cd-21",
+                "name": "FieldApi.ts"
+              },
+              {
+                "uid": "52cd-23",
+                "name": "index.ts"
+              }
+            ]
+          },
+          {
+            "uid": "52cd-19",
+            "name": "\u0000rollupPluginBabelHelpers.js"
+          }
+        ]
+      }
+    ],
+    "isRoot": true
+  },
+  "nodeParts": {
+    "52cd-13": {
+      "renderedLength": 1288,
+      "gzipLength": 497,
+      "brotliLength": 0,
+      "mainUid": "52cd-12"
+    },
+    "52cd-15": {
+      "renderedLength": 1944,
+      "gzipLength": 684,
+      "brotliLength": 0,
+      "mainUid": "52cd-14"
+    },
+    "52cd-17": {
+      "renderedLength": 10266,
+      "gzipLength": 2308,
+      "brotliLength": 0,
+      "mainUid": "52cd-16"
+    },
+    "52cd-19": {
+      "renderedLength": 353,
+      "gzipLength": 227,
+      "brotliLength": 0,
+      "mainUid": "52cd-18"
+    },
+    "52cd-21": {
+      "renderedLength": 7553,
+      "gzipLength": 1868,
+      "brotliLength": 0,
+      "mainUid": "52cd-20"
+    },
+    "52cd-23": {
+      "renderedLength": 0,
+      "gzipLength": 0,
+      "brotliLength": 0,
+      "mainUid": "52cd-22"
+    }
+  },
+  "nodeMetas": {
+    "52cd-12": {
+      "id": "/node_modules/.pnpm/@tanstack+store@0.0.1-beta.84/node_modules/@tanstack/store/build/esm/index.js",
+      "moduleParts": {
+        "index.production.js": "52cd-13"
+      },
+      "imported": [],
+      "importedBy": [
+        {
+          "uid": "52cd-16"
+        },
+        {
+          "uid": "52cd-20"
+        }
+      ]
+    },
+    "52cd-14": {
+      "id": "/packages/form-core/src/utils.ts",
+      "moduleParts": {
+        "index.production.js": "52cd-15"
+      },
+      "imported": [],
+      "importedBy": [
+        {
+          "uid": "52cd-22"
+        },
+        {
+          "uid": "52cd-16"
+        }
+      ]
+    },
+    "52cd-16": {
+      "id": "/packages/form-core/src/FormApi.ts",
+      "moduleParts": {
+        "index.production.js": "52cd-17"
+      },
+      "imported": [
+        {
+          "uid": "52cd-12"
+        },
+        {
+          "uid": "52cd-14"
+        }
+      ],
+      "importedBy": [
+        {
+          "uid": "52cd-22"
+        }
+      ]
+    },
+    "52cd-18": {
+      "id": "\u0000rollupPluginBabelHelpers.js",
+      "moduleParts": {
+        "index.production.js": "52cd-19"
+      },
+      "imported": [],
+      "importedBy": [
+        {
+          "uid": "52cd-20"
+        }
+      ]
+    },
+    "52cd-20": {
+      "id": "/packages/form-core/src/FieldApi.ts",
+      "moduleParts": {
+        "index.production.js": "52cd-21"
+      },
+      "imported": [
+        {
+          "uid": "52cd-18"
+        },
+        {
+          "uid": "52cd-12"
+        }
+      ],
+      "importedBy": [
+        {
+          "uid": "52cd-22"
+        }
+      ]
+    },
+    "52cd-22": {
+      "id": "/packages/form-core/src/index.ts",
+      "moduleParts": {
+        "index.production.js": "52cd-23"
+      },
+      "imported": [
+        {
+          "uid": "52cd-16"
+        },
+        {
+          "uid": "52cd-20"
+        },
+        {
+          "uid": "52cd-14"
+        }
+      ],
+      "importedBy": [],
+      "isEntry": true
+    }
+  },
+  "env": {
+    "rollup": "2.78.1"
+  },
+  "options": {
+    "gzip": true,
+    "brotli": false,
+    "sourcemap": false
+  }
+}

package/build/types/FieldApi.d.ts

@@ -0,0 +1,69 @@
+import type { DeepKeys, DeepValue, RequiredByKey, Updater } from './utils';
+import type { FormApi, ValidationError } from './FormApi';
+import { Store } from '@tanstack/store';
+declare type ValidateOn = 'change' | 'blur' | 'submit';
+export declare type FieldOptions<TData, TFormData> = {
+    name: unknown extends TFormData ? string : DeepKeys<TFormData>;
+    defaultValue?: TData;
+    form?: FormApi<TFormData>;
+    validate?: (value: TData, fieldApi: FieldApi<TData, TFormData>) => ValidationError;
+    validateAsync?: (value: TData, fieldApi: FieldApi<TData, TFormData>) => ValidationError | Promise<ValidationError>;
+    validatePristine?: boolean;
+    validateOn?: ValidateOn;
+    validateAsyncOn?: ValidateOn;
+    validateAsyncDebounceMs?: number;
+    filterValue?: (value: TData) => TData;
+    defaultMeta?: Partial<FieldMeta>;
+    change?: boolean;
+    blur?: boolean;
+    submit?: boolean;
+};
+export declare type FieldMeta = {
+    isTouched: boolean;
+    touchedError?: ValidationError;
+    error?: ValidationError;
+    isValidating: boolean;
+};
+export declare type ChangeProps<TData> = {
+    onChange?: (updater: Updater<TData>) => void;
+    onBlur?: (event: any) => void;
+};
+export declare type InputProps = {
+    onChange?: (event: any) => void;
+    onBlur?: (event: any) => void;
+};
+export declare type FieldApiOptions<TData, TFormData> = RequiredByKey<FieldOptions<TData, TFormData>, 'form'>;
+export declare type FieldState<TData> = {
+    value: TData;
+    meta: FieldMeta;
+};
+export declare class FieldApi<TData, TFormData> {
+    #private;
+    uid: number;
+    form: FormApi<TFormData>;
+    name: DeepKeys<TFormData>;
+    store: Store<FieldState<TData>>;
+    state: FieldState<TData>;
+    options: RequiredByKey<FieldOptions<TData, TFormData>, 'validateOn' | 'validateAsyncOn'>;
+    constructor(opts: FieldApiOptions<TData, TFormData>);
+    mount: () => () => void;
+    update: (opts: FieldApiOptions<TData, TFormData>) => void;
+    getValue: () => TData;
+    setValue: (updater: Updater<TData>, options?: {
+        touch?: boolean;
+        notify?: boolean;
+    }) => void;
+    getMeta: () => FieldMeta;
+    setMeta: (updater: Updater<FieldMeta>) => void;
+    getInfo: () => Record<DeepKeys<TFormData>, import("./FormApi").FieldInfo<TFormData>>[DeepKeys<TFormData>];
+    pushValue: (value: TData) => void;
+    insertValue: (index: number, value: TData) => void;
+    removeValue: (index: number) => void;
+    swapValues: (aIndex: number, bIndex: number) => void;
+    getSubField: <TName extends DeepKeys<TData>>(name: TName) => FieldApi<DeepValue<TData, TName>, TFormData>;
+    validate: () => Promise<ValidationError>;
+    validateAsync: () => Promise<ValidationError>;
+    getChangeProps: <T extends ChangeProps<any>>(props?: T) => ChangeProps<TData> & Omit<T, keyof ChangeProps<TData>>;
+    getInputProps: <T extends InputProps>(props?: T) => InputProps & Omit<T, keyof InputProps>;
+}
+export {};

package/build/types/FormApi.d.ts

@@ -0,0 +1,74 @@
+import type { FormEvent } from 'react';
+import { Store } from '@tanstack/store';
+import type { DeepKeys, DeepValue, Updater } from './utils';
+import type { FieldApi, FieldMeta } from './FieldApi';
+export declare type FormOptions<TData> = {
+    defaultValues?: TData;
+    defaultState?: Partial<FormState<TData>>;
+    onSubmit?: (values: TData, formApi: FormApi<TData>) => Promise<any>;
+    onInvalidSubmit?: (values: TData, formApi: FormApi<TData>) => void;
+    validate?: (values: TData, formApi: FormApi<TData>) => Promise<any>;
+    debugForm?: boolean;
+    validatePristine?: boolean;
+};
+export declare type FieldInfo<TFormData> = {
+    instances: Record<string, FieldApi<any, TFormData>>;
+} & ValidationMeta;
+export declare type ValidationMeta = {
+    validationCount?: number;
+    validationPromise?: Promise<ValidationError>;
+    validationResolve?: (error: ValidationError) => void;
+    validationReject?: (error: unknown) => void;
+};
+export declare type ValidationError = undefined | false | null | string;
+export declare type FormState<TData> = {
+    values: TData;
+    isFormValidating: boolean;
+    formValidationCount: number;
+    isFormValid: boolean;
+    formError?: ValidationError;
+    fieldMeta: Record<DeepKeys<TData>, FieldMeta>;
+    isFieldsValidating: boolean;
+    isFieldsValid: boolean;
+    isSubmitting: boolean;
+    isTouched: boolean;
+    isSubmitted: boolean;
+    isValidating: boolean;
+    isValid: boolean;
+    canSubmit: boolean;
+    submissionAttempts: number;
+};
+export declare function getDefaultFormState<TData>(defaultState: Partial<FormState<TData>>): FormState<TData>;
+export declare class FormApi<TFormData> {
+    options: FormOptions<TFormData>;
+    store: Store<FormState<TFormData>>;
+    state: FormState<TFormData>;
+    fieldInfo: Record<DeepKeys<TFormData>, FieldInfo<TFormData>>;
+    fieldName?: string;
+    validationMeta: ValidationMeta;
+    constructor(opts?: FormOptions<TFormData>);
+    update: (options: FormOptions<TFormData>) => void;
+    reset: () => void;
+    validateAllFields: () => Promise<ValidationError[]>;
+    validateForm: () => Promise<ValidationError>;
+    handleSubmit: (e: FormEvent & {
+        __handled?: boolean;
+    }) => Promise<void>;
+    getFieldValue: <TField extends DeepKeys<TFormData>>(field: TField) => DeepValue<TFormData, TField>;
+    getFieldMeta: <TField extends DeepKeys<TFormData>>(field: TField) => FieldMeta;
+    getFieldInfo: <TField extends DeepKeys<TFormData>>(field: TField) => Record<DeepKeys<TFormData>, FieldInfo<TFormData>>[TField];
+    setFieldMeta: <TField extends DeepKeys<TFormData>>(field: TField, updater: Updater<FieldMeta>) => void;
+    setFieldValue: <TField extends DeepKeys<TFormData>>(field: TField, updater: Updater<DeepValue<TFormData, TField>, DeepValue<TFormData, TField>>, opts?: {
+        touch?: boolean;
+    }) => void;
+    pushFieldValue: <TField extends DeepKeys<TFormData>>(field: TField, value: DeepValue<TFormData, TField>, opts?: {
+        touch?: boolean;
+    }) => void;
+    insertFieldValue: <TField extends DeepKeys<TFormData>>(field: TField, index: number, value: DeepValue<TFormData, TField>, opts?: {
+        touch?: boolean;
+    }) => void;
+    spliceFieldValue: <TField extends DeepKeys<TFormData>>(field: TField, index: number, opts?: {
+        touch?: boolean;
+    }) => void;
+    swapFieldValues: <TField extends DeepKeys<TFormData>>(field: TField, index1: number, index2: number) => void;
+}

package/build/types/index.d.ts

@@ -0,0 +1,167 @@
+/**
+ * form-core
+ *
+ * Copyright (c) TanStack
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE.md file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+import { FormEvent } from 'react';
+import { Store } from '@tanstack/store';
+
+declare type UpdaterFn<TInput, TOutput = TInput> = (input: TInput) => TOutput;
+declare type Updater<TInput, TOutput = TInput> = TOutput | UpdaterFn<TInput, TOutput>;
+declare function functionalUpdate<TInput, TOutput = TInput>(updater: Updater<TInput, TOutput>, input: TInput): TOutput;
+declare function getBy(obj: any, path: any): any;
+declare function setBy(obj: any, _path: any, updater: Updater<any>): any;
+declare type RequiredByKey<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
+declare type ComputeRange<N extends number, Result extends Array<unknown> = []> = Result['length'] extends N ? Result : ComputeRange<N, [...Result, Result['length']]>;
+declare type Index40 = ComputeRange<40>[number];
+declare type IsTuple<T> = T extends readonly any[] & {
+    length: infer Length;
+} ? Length extends Index40 ? T : never : never;
+declare type AllowedIndexes<Tuple extends ReadonlyArray<any>, Keys extends number = never> = Tuple extends readonly [] ? Keys : Tuple extends readonly [infer _, ...infer Tail] ? AllowedIndexes<Tail, Keys | Tail['length']> : Keys;
+declare type DeepKeys<T> = unknown extends T ? keyof T : object extends T ? string : T extends readonly any[] & IsTuple<T> ? AllowedIndexes<T> | DeepKeysPrefix<T, AllowedIndexes<T>> : T extends any[] ? never & 'Dynamic length array indexing is not supported' : T extends Date ? never : T extends object ? (keyof T & string) | DeepKeysPrefix<T, keyof T> : never;
+declare type DeepKeysPrefix<T, TPrefix> = TPrefix extends keyof T & (number | string) ? `${TPrefix}.${DeepKeys<T[TPrefix]> & string}` : never;
+declare type DeepValue<T, TProp> = T extends Record<string | number, any> ? TProp extends `${infer TBranch}.${infer TDeepProp}` ? DeepValue<T[TBranch], TDeepProp> : T[TProp & string] : never;
+
+declare type ValidateOn = 'change' | 'blur' | 'submit';
+declare type FieldOptions<TData, TFormData> = {
+    name: unknown extends TFormData ? string : DeepKeys<TFormData>;
+    defaultValue?: TData;
+    form?: FormApi<TFormData>;
+    validate?: (value: TData, fieldApi: FieldApi<TData, TFormData>) => ValidationError;
+    validateAsync?: (value: TData, fieldApi: FieldApi<TData, TFormData>) => ValidationError | Promise<ValidationError>;
+    validatePristine?: boolean;
+    validateOn?: ValidateOn;
+    validateAsyncOn?: ValidateOn;
+    validateAsyncDebounceMs?: number;
+    filterValue?: (value: TData) => TData;
+    defaultMeta?: Partial<FieldMeta>;
+    change?: boolean;
+    blur?: boolean;
+    submit?: boolean;
+};
+declare type FieldMeta = {
+    isTouched: boolean;
+    touchedError?: ValidationError;
+    error?: ValidationError;
+    isValidating: boolean;
+};
+declare type ChangeProps<TData> = {
+    onChange?: (updater: Updater<TData>) => void;
+    onBlur?: (event: any) => void;
+};
+declare type InputProps = {
+    onChange?: (event: any) => void;
+    onBlur?: (event: any) => void;
+};
+declare type FieldApiOptions<TData, TFormData> = RequiredByKey<FieldOptions<TData, TFormData>, 'form'>;
+declare type FieldState<TData> = {
+    value: TData;
+    meta: FieldMeta;
+};
+declare class FieldApi<TData, TFormData> {
+    #private;
+    uid: number;
+    form: FormApi<TFormData>;
+    name: DeepKeys<TFormData>;
+    store: Store<FieldState<TData>>;
+    state: FieldState<TData>;
+    options: RequiredByKey<FieldOptions<TData, TFormData>, 'validateOn' | 'validateAsyncOn'>;
+    constructor(opts: FieldApiOptions<TData, TFormData>);
+    mount: () => () => void;
+    update: (opts: FieldApiOptions<TData, TFormData>) => void;
+    getValue: () => TData;
+    setValue: (updater: Updater<TData>, options?: {
+        touch?: boolean;
+        notify?: boolean;
+    }) => void;
+    getMeta: () => FieldMeta;
+    setMeta: (updater: Updater<FieldMeta>) => void;
+    getInfo: () => Record<DeepKeys<TFormData>, FieldInfo<TFormData>>[DeepKeys<TFormData>];
+    pushValue: (value: TData) => void;
+    insertValue: (index: number, value: TData) => void;
+    removeValue: (index: number) => void;
+    swapValues: (aIndex: number, bIndex: number) => void;
+    getSubField: <TName extends DeepKeys<TData>>(name: TName) => FieldApi<DeepValue<TData, TName>, TFormData>;
+    validate: () => Promise<ValidationError>;
+    validateAsync: () => Promise<ValidationError>;
+    getChangeProps: <T extends ChangeProps<any>>(props?: T) => ChangeProps<TData> & Omit<T, keyof ChangeProps<TData>>;
+    getInputProps: <T extends InputProps>(props?: T) => InputProps & Omit<T, keyof InputProps>;
+}
+
+declare type FormOptions<TData> = {
+    defaultValues?: TData;
+    defaultState?: Partial<FormState<TData>>;
+    onSubmit?: (values: TData, formApi: FormApi<TData>) => Promise<any>;
+    onInvalidSubmit?: (values: TData, formApi: FormApi<TData>) => void;
+    validate?: (values: TData, formApi: FormApi<TData>) => Promise<any>;
+    debugForm?: boolean;
+    validatePristine?: boolean;
+};
+declare type FieldInfo<TFormData> = {
+    instances: Record<string, FieldApi<any, TFormData>>;
+} & ValidationMeta;
+declare type ValidationMeta = {
+    validationCount?: number;
+    validationPromise?: Promise<ValidationError>;
+    validationResolve?: (error: ValidationError) => void;
+    validationReject?: (error: unknown) => void;
+};
+declare type ValidationError = undefined | false | null | string;
+declare type FormState<TData> = {
+    values: TData;
+    isFormValidating: boolean;
+    formValidationCount: number;
+    isFormValid: boolean;
+    formError?: ValidationError;
+    fieldMeta: Record<DeepKeys<TData>, FieldMeta>;
+    isFieldsValidating: boolean;
+    isFieldsValid: boolean;
+    isSubmitting: boolean;
+    isTouched: boolean;
+    isSubmitted: boolean;
+    isValidating: boolean;
+    isValid: boolean;
+    canSubmit: boolean;
+    submissionAttempts: number;
+};
+declare function getDefaultFormState<TData>(defaultState: Partial<FormState<TData>>): FormState<TData>;
+declare class FormApi<TFormData> {
+    options: FormOptions<TFormData>;
+    store: Store<FormState<TFormData>>;
+    state: FormState<TFormData>;
+    fieldInfo: Record<DeepKeys<TFormData>, FieldInfo<TFormData>>;
+    fieldName?: string;
+    validationMeta: ValidationMeta;
+    constructor(opts?: FormOptions<TFormData>);
+    update: (options: FormOptions<TFormData>) => void;
+    reset: () => void;
+    validateAllFields: () => Promise<ValidationError[]>;
+    validateForm: () => Promise<ValidationError>;
+    handleSubmit: (e: FormEvent & {
+        __handled?: boolean;
+    }) => Promise<void>;
+    getFieldValue: <TField extends DeepKeys<TFormData>>(field: TField) => DeepValue<TFormData, TField>;
+    getFieldMeta: <TField extends DeepKeys<TFormData>>(field: TField) => FieldMeta;
+    getFieldInfo: <TField extends DeepKeys<TFormData>>(field: TField) => Record<DeepKeys<TFormData>, FieldInfo<TFormData>>[TField];
+    setFieldMeta: <TField extends DeepKeys<TFormData>>(field: TField, updater: Updater<FieldMeta>) => void;
+    setFieldValue: <TField extends DeepKeys<TFormData>>(field: TField, updater: Updater<DeepValue<TFormData, TField>, DeepValue<TFormData, TField>>, opts?: {
+        touch?: boolean;
+    }) => void;
+    pushFieldValue: <TField extends DeepKeys<TFormData>>(field: TField, value: DeepValue<TFormData, TField>, opts?: {
+        touch?: boolean;
+    }) => void;
+    insertFieldValue: <TField extends DeepKeys<TFormData>>(field: TField, index: number, value: DeepValue<TFormData, TField>, opts?: {
+        touch?: boolean;
+    }) => void;
+    spliceFieldValue: <TField extends DeepKeys<TFormData>>(field: TField, index: number, opts?: {
+        touch?: boolean;
+    }) => void;
+    swapFieldValues: <TField extends DeepKeys<TFormData>>(field: TField, index1: number, index2: number) => void;
+}
+
+export { ChangeProps, DeepKeys, DeepValue, FieldApi, FieldApiOptions, FieldInfo, FieldMeta, FieldOptions, FieldState, FormApi, FormOptions, FormState, InputProps, RequiredByKey, Updater, UpdaterFn, ValidationError, ValidationMeta, functionalUpdate, getBy, getDefaultFormState, setBy };

package/build/types/utils.d.ts

@@ -0,0 +1,16 @@
+export declare type UpdaterFn<TInput, TOutput = TInput> = (input: TInput) => TOutput;
+export declare type Updater<TInput, TOutput = TInput> = TOutput | UpdaterFn<TInput, TOutput>;
+export declare function functionalUpdate<TInput, TOutput = TInput>(updater: Updater<TInput, TOutput>, input: TInput): TOutput;
+export declare function getBy(obj: any, path: any): any;
+export declare function setBy(obj: any, _path: any, updater: Updater<any>): any;
+export declare type RequiredByKey<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
+declare type ComputeRange<N extends number, Result extends Array<unknown> = []> = Result['length'] extends N ? Result : ComputeRange<N, [...Result, Result['length']]>;
+declare type Index40 = ComputeRange<40>[number];
+declare type IsTuple<T> = T extends readonly any[] & {
+    length: infer Length;
+} ? Length extends Index40 ? T : never : never;
+declare type AllowedIndexes<Tuple extends ReadonlyArray<any>, Keys extends number = never> = Tuple extends readonly [] ? Keys : Tuple extends readonly [infer _, ...infer Tail] ? AllowedIndexes<Tail, Keys | Tail['length']> : Keys;
+export declare type DeepKeys<T> = unknown extends T ? keyof T : object extends T ? string : T extends readonly any[] & IsTuple<T> ? AllowedIndexes<T> | DeepKeysPrefix<T, AllowedIndexes<T>> : T extends any[] ? never & 'Dynamic length array indexing is not supported' : T extends Date ? never : T extends object ? (keyof T & string) | DeepKeysPrefix<T, keyof T> : never;
+declare type DeepKeysPrefix<T, TPrefix> = TPrefix extends keyof T & (number | string) ? `${TPrefix}.${DeepKeys<T[TPrefix]> & string}` : never;
+export declare type DeepValue<T, TProp> = T extends Record<string | number, any> ? TProp extends `${infer TBranch}.${infer TDeepProp}` ? DeepValue<T[TBranch], TDeepProp> : T[TProp & string] : never;
+export {};