Open History to see the last commit
1import { defaultFieldMeta } from '@tanstack/form-core/internals'
2import { describe, expect, it } from 'vitest'
3import {
4 createBaselinePatch,
5 defaultDevtoolsMountedFieldSummary,
6 diffBaselinePatches,
7 hydrateDevtoolsMountedFieldSummary,
8 toDevtoolsMountedFieldSummaryPatch,
9} from '../src/fieldSummaryMeta'
10β
11describe('field summary meta', () => {
12 it('creates a generic sparse patch against a baseline', () => {
13 expect(
14 createBaselinePatch(
15 { isDirty: true, errorCount: 0, status: 'invalid' },
16 { isDirty: false, errorCount: 0, status: 'valid' },
17 ),
18 ).toEqual({ isDirty: true, status: 'invalid' })
19 })
20β
21 it('omits default field meta and includes non-default field meta', () => {
22 expect(toDevtoolsMountedFieldSummaryPatch(defaultFieldMeta)).toBeUndefined()
23 expect(
24 toDevtoolsMountedFieldSummaryPatch({
25 ...defaultFieldMeta,
26 isDirty: true,
27 isPristine: false,
28 }),
29 ).toEqual({ isDirty: true })
30 expect(
31 toDevtoolsMountedFieldSummaryPatch({
32 ...defaultFieldMeta,
33 isTouched: true,
34 }),
35 ).toEqual({ isTouched: true })
36 expect(
37 toDevtoolsMountedFieldSummaryPatch({
38 ...defaultFieldMeta,
39 isBlurred: true,
40 }),
41 ).toEqual({ isBlurred: true })
42 expect(
43 toDevtoolsMountedFieldSummaryPatch(defaultFieldMeta, {
44 isLongValidating: true,
45 }),
46 ).toEqual({ isLongValidating: true })
47 expect(
48 toDevtoolsMountedFieldSummaryPatch({
49 ...defaultFieldMeta,
50 isValidating: true,
51 }),
52 ).toBeUndefined()
53 expect(
54 toDevtoolsMountedFieldSummaryPatch({
55 ...defaultFieldMeta,
56 isDefaultValue: false,
57 }),
58 ).toEqual({ isDefaultValue: false })
59 expect(
60 toDevtoolsMountedFieldSummaryPatch({
61 ...defaultFieldMeta,
62 isValid: false,
63 isInvalid: true,
64 }),
65 ).toEqual({ validity: 'invalid' })
66 expect(
67 toDevtoolsMountedFieldSummaryPatch({
68 ...defaultFieldMeta,
69 original: {
70 ...defaultFieldMeta.original,
71 isValid: false,
72 isInvalid: true,
73 },
74 }),
75 ).toEqual({ validity: 'invalidHidden' })
76 expect(
77 toDevtoolsMountedFieldSummaryPatch({
78 ...defaultFieldMeta,
79 original: {
80 ...defaultFieldMeta.original,
81 errors: [{ message: 'Hidden error' }],
82 isValid: false,
83 isInvalid: true,
84 },
85 }),
86 ).toEqual({ hasSelfErrors: true, validity: 'invalidHidden' })
87 })
88β
89 it('hydrates sparse patches against the Devtools baseline', () => {
90 expect(hydrateDevtoolsMountedFieldSummary()).toBe(
91 defaultDevtoolsMountedFieldSummary,
92 )
93 expect(hydrateDevtoolsMountedFieldSummary({})).toBe(
94 defaultDevtoolsMountedFieldSummary,
95 )
96 expect(hydrateDevtoolsMountedFieldSummary({ isDirty: true })).toEqual({
97 isDirty: true,
98 isTouched: false,
99 isBlurred: false,
100 isLongValidating: false,
101 isDefaultValue: true,
102 hasSelfErrors: false,
103 validity: 'valid',
104 })
105 expect(hydrateDevtoolsMountedFieldSummary({ isTouched: true })).toEqual({
106 isDirty: false,
107 isTouched: true,
108 isBlurred: false,
109 isLongValidating: false,
110 isDefaultValue: true,
111 hasSelfErrors: false,
112 validity: 'valid',
113 })
114 expect(
115 hydrateDevtoolsMountedFieldSummary({ isLongValidating: true }),
116 ).toEqual({
117 isDirty: false,
118 isTouched: false,
119 isBlurred: false,
120 isLongValidating: true,
121 isDefaultValue: true,
122 hasSelfErrors: false,
123 validity: 'valid',
124 })
125 expect(
126 hydrateDevtoolsMountedFieldSummary({ validity: 'invalidHidden' }),
127 ).toEqual({
128 isDirty: false,
129 isTouched: false,
130 isBlurred: false,
131 isLongValidating: false,
132 isDefaultValue: true,
133 hasSelfErrors: false,
134 validity: 'invalidHidden',
135 })
136 })
137β
138 it('diffs sparse patches into set and clear operations', () => {
139 expect(
140 diffBaselinePatches<{
141 isDirty: boolean
142 status: string
143 errorCount: number
144 }>(
145 { isDirty: false, status: 'invalid' },
146 { isDirty: true, errorCount: 2 },
147 ),
148 ).toEqual({
149 set: { isDirty: true, errorCount: 2 },
150 clear: ['status'],
151 })
152β
153 expect(diffBaselinePatches({ isDirty: true }, { isDirty: true })).toEqual({
154 set: undefined,
155 clear: undefined,
156 })
157 })
158})