@octanejs/tanstack-form 0.0.1

package/src/createFormHook.tsrx.d.ts

@@ -0,0 +1,101 @@
+// Declaration companion generated from createFormHook.tsrx.
+import type { AnyFieldApi, AnyFormApi, BaseFormOptions, DeepKeysOfType, FieldApi, FieldsMap, FormAsyncValidateOrFn, FormOptions, FormValidateOrFn } from '@tanstack/form-core';
+import type { Context } from 'octane';
+import type { FieldComponent } from './useField.tsrx';
+import type { OctaneFormExtendedApi } from './useForm.tsrx';
+import type { AppFieldExtendedOctaneFieldGroupApi } from './useFieldGroup.tsrx';
+type HookRenderable = unknown;
+type HookPropsWithChildren<P = object> = P & {
+    children?: HookRenderable;
+};
+type HookFunctionComponent<P = object> = (props: P) => HookRenderable;
+type HookComponentType<P = object> = HookFunctionComponent<P>;
+/**
+ * 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 occurred.
+ */
+type UnwrapOrAny<T> = [unknown] extends [T] ? any : T;
+type UnwrapDefaultOrAny<DefaultT, T> = [DefaultT] extends [T] ? [T] extends [DefaultT] ? any : T : T;
+declare function useFormContext(): OctaneFormExtendedApi<Record<string, never>, any, any, any, any, any, any, any, any, any, any, any>;
+export declare function createFormHookContexts(): {
+    fieldContext: Context<AnyFieldApi>;
+    useFieldContext: <TData>() => FieldApi<any, string, TData, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any>;
+    useFormContext: typeof useFormContext;
+    formContext: Context<AnyFormApi>;
+};
+interface CreateFormHookProps<TFieldComponents extends Record<string, HookComponentType<any>>, TFormComponents extends Record<string, HookComponentType<any>>> {
+    fieldComponents: TFieldComponents;
+    fieldContext: Context<AnyFieldApi>;
+    formComponents: TFormComponents;
+    formContext: Context<AnyFormApi>;
+}
+/**
+ * @private
+ */
+export type AppFieldExtendedOctaneFormApi<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, HookComponentType<any>>, TFormComponents extends Record<string, HookComponentType<any>>> = OctaneFormExtendedApi<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: HookComponentType<HookPropsWithChildren<{}>>;
+};
+export interface WithFormProps<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, HookComponentType<any>>, TFormComponents extends Record<string, HookComponentType<any>>, TRenderProps extends object = Record<string, never>> extends FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta> {
+    props?: TRenderProps;
+    render: HookFunctionComponent<HookPropsWithChildren<NoInfer<TRenderProps> & {
+        form: AppFieldExtendedOctaneFormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, TFieldComponents, TFormComponents>;
+    }>>;
+}
+export interface WithFieldGroupProps<TFieldGroupData, TFieldComponents extends Record<string, HookComponentType<any>>, TFormComponents extends Record<string, HookComponentType<any>>, TSubmitMeta, TRenderProps extends object = Record<string, never>> extends BaseFormOptions<TFieldGroupData, TSubmitMeta> {
+    props?: TRenderProps;
+    render: HookFunctionComponent<HookPropsWithChildren<NoInfer<TRenderProps> & {
+        group: AppFieldExtendedOctaneFieldGroupApi<unknown, TFieldGroupData, string | FieldsMap<unknown, TFieldGroupData>, undefined | FormValidateOrFn<unknown>, undefined | FormValidateOrFn<unknown>, undefined | FormAsyncValidateOrFn<unknown>, undefined | FormValidateOrFn<unknown>, undefined | FormAsyncValidateOrFn<unknown>, undefined | FormValidateOrFn<unknown>, undefined | FormAsyncValidateOrFn<unknown>, undefined | FormValidateOrFn<unknown>, undefined | FormAsyncValidateOrFn<unknown>, undefined | FormAsyncValidateOrFn<unknown>, unknown extends TSubmitMeta ? never : TSubmitMeta, TFieldComponents, TFormComponents>;
+    }>>;
+}
+type UseAppForm<TComponents extends Record<string, HookComponentType<any>>, TFormComponents extends Record<string, HookComponentType<any>>> = <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>) => AppFieldExtendedOctaneFormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, TComponents, TFormComponents>;
+type WithForm<TComponents extends Record<string, HookComponentType<any>>, TFormComponents extends Record<string, HookComponentType<any>>> = <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, TRenderProps extends object = {}>(props: WithFormProps<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, TComponents, TFormComponents, TRenderProps>) => WithFormProps<UnwrapOrAny<TFormData>, UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnMount>, UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnChange>, UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnChangeAsync>, UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnBlur>, UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnBlurAsync>, UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnSubmit>, UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnSubmitAsync>, UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnDynamic>, UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnDynamicAsync>, UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnServer>, UnwrapOrAny<TSubmitMeta>, UnwrapOrAny<TComponents>, UnwrapOrAny<TFormComponents>, UnwrapOrAny<TRenderProps>>['render'];
+type WithFieldGroup<TComponents extends Record<string, HookComponentType<any>>, TFormComponents extends Record<string, HookComponentType<any>>> = <TFieldGroupData, TSubmitMeta, TRenderProps extends object = {}>(props: WithFieldGroupProps<TFieldGroupData, TComponents, TFormComponents, TSubmitMeta, TRenderProps>) => <TFormData, TFields extends DeepKeysOfType<TFormData, TFieldGroupData | null | undefined> | FieldsMap<TFormData, TFieldGroupData>, 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>, TFormSubmitMeta>(params: HookPropsWithChildren<NoInfer<TRenderProps> & {
+    form: AppFieldExtendedOctaneFormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, unknown extends TSubmitMeta ? TFormSubmitMeta : TSubmitMeta, TComponents, TFormComponents> | AppFieldExtendedOctaneFieldGroupApi<unknown, TFormData, string | FieldsMap<unknown, TFormData>, any, any, any, any, any, any, any, any, any, any, unknown extends TSubmitMeta ? TFormSubmitMeta : TSubmitMeta, TComponents, TFormComponents>;
+    fields: TFields;
+}>) => ReturnType<HookFunctionComponent>;
+type UseTypedAppFormContext<TComponents extends Record<string, HookComponentType<any>>, TFormComponents extends Record<string, HookComponentType<any>>> = <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>) => AppFieldExtendedOctaneFormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, TComponents, TFormComponents>;
+type FieldComponentExtension<TComponents extends Record<string, HookComponentType<any>>> = Record<string, HookComponentType<any>> & {
+    [K in keyof TComponents]?: 'Error: field component names must be unique — this key already exists in the base form';
+};
+type FormComponentExtension<TComponents extends Record<string, HookComponentType<any>>> = Record<string, HookComponentType<any>> & {
+    [K in keyof TComponents]?: 'Error: form component names must be unique — this key already exists in the base form';
+};
+export interface CreateFormHookReturn<TComponents extends Record<string, HookComponentType<any>>, TFormComponents extends Record<string, HookComponentType<any>>> {
+    useAppForm: UseAppForm<TComponents, TFormComponents>;
+    withForm: WithForm<TComponents, TFormComponents>;
+    withFieldGroup: WithFieldGroup<TComponents, TFormComponents>;
+    useTypedAppFormContext: UseTypedAppFormContext<TComponents, TFormComponents>;
+    extendForm: <TNewField extends FieldComponentExtension<TComponents>, TNewForm extends FormComponentExtension<TFormComponents>>(extension: {
+        fieldComponents?: TNewField;
+        formComponents?: TNewForm;
+    }) => CreateFormHookReturn<TComponents & TNewField, TFormComponents & TNewForm>;
+}
+export declare function createFormHook<TComponents extends Record<string, HookComponentType<any>>, TFormComponents extends Record<string, HookComponentType<any>>>({ fieldComponents, fieldContext, formContext, formComponents, }: CreateFormHookProps<TComponents, TFormComponents>): CreateFormHookReturn<TComponents, TFormComponents>;
+export {};

package/src/index.ts

@@ -0,0 +1,11 @@
+export * from '@tanstack/form-core';
+
+export { useSelector, useStore } from '@octanejs/tanstack-store';
+
+export * from './createFormHook.tsrx';
+export * from './types';
+export * from './useField.tsrx';
+export * from './useFieldGroup.tsrx';
+export * from './useForm.tsrx';
+export * from './useFormGroup.tsrx';
+export * from './useIsomorphicLayoutEffect';

package/src/types.ts

@@ -0,0 +1,122 @@
+import type {
+	DeepKeys,
+	DeepValue,
+	FieldApiOptions,
+	FieldAsyncValidateOrFn,
+	FieldOptions,
+	FieldValidateOrFn,
+	FormAsyncValidateOrFn,
+	FormState,
+	FormValidateOrFn,
+} from '@tanstack/form-core';
+
+interface FieldOptionsMode {
+	mode?: 'value' | 'array';
+}
+
+/**
+ * The field options.
+ */
+export interface UseFieldOptions<
+	TParentData,
+	TName extends DeepKeys<TParentData>,
+	TData extends DeepValue<TParentData, TName>,
+	TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
+	TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
+	TOnChangeAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>,
+	TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
+	TOnBlurAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>,
+	TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
+	TOnSubmitAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>,
+	TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
+	TOnDynamicAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>,
+	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,
+>
+	extends
+		FieldApiOptions<
+			TParentData,
+			TName,
+			TData,
+			TOnMount,
+			TOnChange,
+			TOnChangeAsync,
+			TOnBlur,
+			TOnBlurAsync,
+			TOnSubmit,
+			TOnSubmitAsync,
+			TOnDynamic,
+			TOnDynamicAsync,
+			TFormOnMount,
+			TFormOnChange,
+			TFormOnChangeAsync,
+			TFormOnBlur,
+			TFormOnBlurAsync,
+			TFormOnSubmit,
+			TFormOnSubmitAsync,
+			TFormOnDynamic,
+			TFormOnDynamicAsync,
+			TFormOnServer,
+			TSubmitMeta
+		>,
+		FieldOptionsMode {}
+
+export interface UseFieldOptionsBound<
+	TParentData,
+	TName extends DeepKeys<TParentData>,
+	TData extends DeepValue<TParentData, TName>,
+	TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
+	TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
+	TOnChangeAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>,
+	TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
+	TOnBlurAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>,
+	TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
+	TOnSubmitAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>,
+	TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
+	TOnDynamicAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>,
+>
+	extends
+		FieldOptions<
+			TParentData,
+			TName,
+			TData,
+			TOnMount,
+			TOnChange,
+			TOnChangeAsync,
+			TOnBlur,
+			TOnBlurAsync,
+			TOnSubmit,
+			TOnSubmitAsync,
+			TOnDynamic,
+			TOnDynamicAsync
+		>,
+		FieldOptionsMode {}
+
+export type ServerFormState<
+	TFormData,
+	TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
+> = Pick<
+	FormState<
+		TFormData,
+		undefined,
+		undefined,
+		undefined,
+		undefined,
+		undefined,
+		undefined,
+		undefined,
+		undefined,
+		undefined,
+		TOnServer
+	>,
+	'values' | 'errors' | 'errorMap'
+>;