Open History to see the last commit
1import type { FormOptions } from './FormApi/FormApi.public'
2import type {
3 FormValidateResultFromErrorTypes,
4 FormValidators,
5 ToServerFormErrorTypes,
6 ToServerFormOutputs,
7} from './validation.public'
8β
9export const initialServerFormState: ServerFormState<any, any> = {
10 values: undefined,
11 validationResults: [],
12 submissionAttempts: 0,
13}
14β
15type ServerValidateHelperResult<
16 TFramework extends ServerValidateFrameworkPlugin,
17> = Omit<TFramework, 'id'> & {
18 initialServerFormState: ServerFormState<any, any>
19}
20β
21export function serverValidateHelper<
22 const TFramework extends ServerValidateFrameworkPlugin,
23>(options: { framework: TFramework }): ServerValidateHelperResult<TFramework> {
24 const { id: _unused, ...framework } = options.framework
25β
26 return {
27 initialServerFormState,
28 ...framework,
29 }
30}
31β
32interface ServerStateValidationResult<out TResult> {
33 validatorIndex: number
34 result: TResult
35 output: unknown | null
36 hasOutput?: boolean
37}
38β
39interface ServerFormStateByResult<in out TFormData, out TResult> {
40 values: TFormData | undefined
41 validationResults: Array<ServerStateValidationResult<TResult>>
42 submissionAttempts: number
43}
44β
45export type ServerFormState<
46 TFormData,
47 TFormValidators extends FormValidators<TFormData>,
48> = ServerFormStateByResult<
49 TFormData,
50 FormValidateResultFromErrorTypes<
51 TFormData,
52 ToServerFormErrorTypes<TFormValidators>
53 >
54>
55β
56export interface ServerValidateSuccess<
57 in out TFormData,
58 in out TFormValidators extends FormValidators<TFormData>,
59> {
60 success: true
61 values: TFormData
62 /**
63 * Schema outputs and `createOutput` payloads from this server validation,
64 * ordered by validator index. Validators without a server trigger or output
65 * contribute `undefined`. These are separate from client submission outputs.
66 */
67 validatorOutputs: ToServerFormOutputs<TFormValidators>
68}
69β
70export interface ServerValidateFailure<
71 in out TFormData,
72 in out TFormValidators extends FormValidators<TFormData>,
73> {
74 success: false
75 serverState: ServerFormState<TFormData, TFormValidators>
76}
77β
78export type ServerValidateResult<
79 TFormData,
80 TFormValidators extends FormValidators<TFormData>,
81> =
82 | ServerValidateSuccess<TFormData, TFormValidators>
83 | ServerValidateFailure<TFormData, TFormValidators>
84β
85type ServerValidateFrameworkCreateServerValidate = <
86 TFormData,
87 const TFormValidators extends FormValidators<TFormData>,
88 TSubmitReturn,
89>(
90 formOptions: FormOptions<TFormData, TFormValidators, TSubmitReturn, unknown>,
91 pluginOptions?: any,
92) => unknown
93β
94export interface ServerValidateFrameworkPlugin<
95 TCreateServerValidate extends ServerValidateFrameworkCreateServerValidate =
96 ServerValidateFrameworkCreateServerValidate,
97> {
98 id: `react-form-${string}`
99 createServerValidate: TCreateServerValidate
100}