Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

defaultOptions.spec.ts

88 lines2.7 KB

1import { describe, expect, it } from 'vitest'
2import { resolveDefaultOptions } from '../src/defaultOptions.lib'
3import type {
4 DefaultFormOptions,
5 DefaultListenersMergeMode,
6} from '../src/defaultOptions.public'
7​
8const defaultListener = {
9 triggers: ['change'] as Array<'change'>,
10 run: () => undefined,
12const incomingListener = {
13 triggers: ['change'] as Array<'change'>,
14 run: () => undefined,
16​
17describe('resolveDefaultOptions', () => {
18 it('returns the original options when defaults are omitted', () => {
19 const options = { defaultValues: { name: '' } }
20​
21 const resolved = resolveDefaultOptions(options)
22​
23 expect(resolved).toBe(options)
24 })
25​
26 it('applies defaults before incoming options and strips merge metadata', () => {
27 const defaultErrorVisibility = () => true
28 const options = {
29 defaultValues: { name: '' },
30 errorVisibility: undefined,
31 }
32 const defaultOptions: DefaultFormOptions = {
33 errorVisibility: defaultErrorVisibility,
34 onSubmitInvalid: () => undefined,
35 listenersMerge: 'append',
36 }
37​
38 const resolved = resolveDefaultOptions(options, defaultOptions)
39​
40 expect(resolved).toMatchObject({
41 defaultValues: { name: '' },
42 errorVisibility: undefined,
43 onSubmitInvalid: defaultOptions.onSubmitInvalid,
44 })
45 expect(resolved).not.toHaveProperty('listenersMerge')
46 })
47​
48 it.each<{
49 mode: DefaultListenersMergeMode
50 expected: Array<typeof defaultListener | typeof incomingListener>
51 }>([
52 { mode: 'replace', expected: [incomingListener] },
53 { mode: 'append', expected: [defaultListener, incomingListener] },
54 { mode: 'prepend', expected: [incomingListener, defaultListener] },
55 ])('resolves listeners using $mode', ({ mode, expected }) => {
56 const defaultListeners = [defaultListener]
57 const incomingListeners = [incomingListener]
58​
59 const resolved = resolveDefaultOptions(
60 { defaultValues: {}, listeners: incomingListeners },
61 {
62 listeners: defaultListeners,
63 listenersMerge: mode,
64 },
65 )
66​
67 expect(resolved.listeners).toEqual(expected)
68 expect(defaultListeners).toEqual([defaultListener])
69 expect(incomingListeners).toEqual([incomingListener])
70 })
71​
72 it('uses defaults for omitted properties and respects explicit undefined', () => {
73 const defaults = {
74 listeners: [defaultListener],
75 listenersMerge: 'append' as const,
76 }
77 const inherited = resolveDefaultOptions({ defaultValues: {} }, defaults)
78 const suppressed = resolveDefaultOptions(
79 { defaultValues: {}, listeners: undefined },
80 defaults,
81 )
82​
83 expect(
84 (inherited as typeof inherited & { listeners: Array<unknown> }).listeners,
85 ).toEqual([defaultListener])
86 expect(suppressed.listeners).toBeUndefined()
87 })
88})