@volverjs/form-vue 0.0.10-beta.9 → 0.0.11-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/README.md +4 -4
  2. package/dist/VvForm.d.ts +4 -0
  3. package/dist/VvFormTemplate.d.ts +1 -0
  4. package/dist/VvFormWrapper.d.ts +8 -0
  5. package/dist/index.d.ts +26 -0
  6. package/dist/index.es.js +273 -256
  7. package/dist/index.umd.js +1 -1
  8. package/dist/types.d.ts +1 -0
  9. package/package.json +1 -1
  10. package/src/VvForm.ts +22 -12
  11. package/src/VvFormField.ts +6 -0
  12. package/src/VvFormTemplate.ts +2 -0
  13. package/src/VvFormWrapper.ts +8 -0
  14. package/src/types.d.ts +1 -0
  15. package/src/utils.ts +34 -31
package/README.md CHANGED
@@ -171,7 +171,7 @@ The **default settings** are **inherited** from the plugin (if it's installed).
171
171
  `useForm()` can create a form also outside a Vue 3 Component, plugin settings are **not inherited**.
172
172
 
173
173
  ```ts
174
- import { formFactory } from '@volverjs/form-vue'
174
+ import { useForm } from '@volverjs/form-vue'
175
175
  import { z } from 'zod'
176
176
 
177
177
  const schema = z.object({
@@ -187,7 +187,7 @@ const {
187
187
  formData,
188
188
  status,
189
189
  errors
190
- } = formFactory(schema, {
190
+ } = useForm(schema, {
191
191
  lazyLoad: true
192
192
  })
193
193
 
@@ -290,7 +290,7 @@ By default UI components must be installed globally, they can be lazy-loaded wit
290
290
  </template>
291
291
  ```
292
292
 
293
- Check the [`VvFormField`](./docs/VvFormField.md) documentation to learn more about form fields.
293
+ Check the [`VvFormField` documentation](./docs/VvFormField.md) to learn more about form fields.
294
294
 
295
295
  ## VvFormTemplate
296
296
 
@@ -308,7 +308,7 @@ Forms can also be created using a template. A template is an **array of objects*
308
308
  street: z.string(),
309
309
  number: z.string(),
310
310
  city: z.string(),
311
- zip: z.string()
311
+ zip: z.number()
312
312
  })
313
313
  })
314
314
 
package/dist/VvForm.d.ts CHANGED
@@ -70,6 +70,7 @@ export declare const defineForm: <Schema extends FormSchema>(schema: Schema, pro
70
70
  }, {
71
71
  formData: Ref<Partial<z.TypeOf<Schema> | undefined>>;
72
72
  submit: () => boolean;
73
+ validate: (value?: Partial<z.TypeOf<Schema> | undefined>) => boolean;
73
74
  errors: Readonly<Ref<DeepReadonly<z.ZodFormattedError<z.TypeOf<Schema>>> | undefined>>;
74
75
  status: Readonly<Ref<FormStatus | undefined>>;
75
76
  invalid: import("vue").ComputedRef<boolean>;
@@ -118,6 +119,7 @@ export declare const defineForm: <Schema extends FormSchema>(schema: Schema, pro
118
119
  } & import("vue").ShallowUnwrapRef<{
119
120
  formData: Ref<Partial<z.TypeOf<Schema> | undefined>>;
120
121
  submit: () => boolean;
122
+ validate: (value?: Partial<z.TypeOf<Schema> | undefined>) => boolean;
121
123
  errors: Readonly<Ref<DeepReadonly<z.ZodFormattedError<z.TypeOf<Schema>>> | undefined>>;
122
124
  status: Readonly<Ref<FormStatus | undefined>>;
123
125
  invalid: import("vue").ComputedRef<boolean>;
@@ -146,6 +148,7 @@ export declare const defineForm: <Schema extends FormSchema>(schema: Schema, pro
146
148
  }, {
147
149
  formData: Ref<Partial<z.TypeOf<Schema> | undefined>>;
148
150
  submit: () => boolean;
151
+ validate: (value?: Partial<z.TypeOf<Schema> | undefined>) => boolean;
149
152
  errors: Readonly<Ref<DeepReadonly<z.ZodFormattedError<z.TypeOf<Schema>>> | undefined>>;
150
153
  status: Readonly<Ref<FormStatus | undefined>>;
151
154
  invalid: import("vue").ComputedRef<boolean>;
@@ -158,6 +161,7 @@ export declare const defineForm: <Schema extends FormSchema>(schema: Schema, pro
158
161
  default: (_: {
159
162
  formData: unknown extends Partial<z.TypeOf<Schema>> | undefined ? undefined : Partial<z.TypeOf<Schema>> | undefined;
160
163
  submit: () => boolean;
164
+ validate: () => boolean;
161
165
  errors: Readonly<Ref<DeepReadonly<z.inferFormattedError<Schema, string>>>>;
162
166
  status: Ref<DeepReadonly<`${FormStatus}` | undefined>>;
163
167
  invalid: Ref<DeepReadonly<boolean>>;
package/dist/VvFormTemplate.d.ts CHANGED
@@ -12,6 +12,7 @@ export declare const defineFormTemplate: <Schema extends FormSchema>(formProvide
12
12
  default: (_: {
13
13
  formData: unknown extends Partial<TypeOf<Schema>> | undefined ? undefined : Partial<TypeOf<Schema>> | undefined;
14
14
  submit: () => boolean;
15
+ validate: () => boolean;
15
16
  errors: Readonly<Ref<DeepReadonly<z.inferFormattedError<Schema, string>>>>;
16
17
  status: Ref<DeepReadonly<`${FormStatus}` | undefined>>;
17
18
  invalid: Ref<DeepReadonly<boolean>>;
package/dist/VvFormWrapper.d.ts CHANGED
@@ -48,6 +48,8 @@ export declare const defineFormWrapper: <Schema extends FormSchema>(formProvideK
48
48
  }, {
49
49
  formData: Ref<Partial<TypeOf<Schema>> | undefined> | undefined;
50
50
  errors: Readonly<Ref<DeepReadonly<z.inferFormattedError<Schema_1, string>>>> | undefined;
51
+ submit: (() => boolean) | undefined;
52
+ validate: (() => boolean) | undefined;
51
53
  invalid: import("vue").ComputedRef<boolean>;
52
54
  fields: Ref<Set<string>>;
53
55
  fieldsErrors: Ref<Map<string, Record<string, {
@@ -90,6 +92,8 @@ export declare const defineFormWrapper: <Schema extends FormSchema>(formProvideK
90
92
  } & import("vue").ShallowUnwrapRef<{
91
93
  formData: Ref<Partial<TypeOf<Schema>> | undefined> | undefined;
92
94
  errors: Readonly<Ref<DeepReadonly<z.inferFormattedError<Schema_1, string>>>> | undefined;
95
+ submit: (() => boolean) | undefined;
96
+ validate: (() => boolean) | undefined;
93
97
  invalid: import("vue").ComputedRef<boolean>;
94
98
  fields: Ref<Set<string>>;
95
99
  fieldsErrors: Ref<Map<string, Record<string, {
@@ -114,6 +118,8 @@ export declare const defineFormWrapper: <Schema extends FormSchema>(formProvideK
114
118
  }, {
115
119
  formData: Ref<Partial<TypeOf<Schema>> | undefined> | undefined;
116
120
  errors: Readonly<Ref<DeepReadonly<z.inferFormattedError<Schema_1, string>>>> | undefined;
121
+ submit: (() => boolean) | undefined;
122
+ validate: (() => boolean) | undefined;
117
123
  invalid: import("vue").ComputedRef<boolean>;
118
124
  fields: Ref<Set<string>>;
119
125
  fieldsErrors: Ref<Map<string, Record<string, {
@@ -126,6 +132,8 @@ export declare const defineFormWrapper: <Schema extends FormSchema>(formProvideK
126
132
  default: (_: {
127
133
  invalid: boolean;
128
134
  formData: unknown extends Partial<TypeOf<Schema>> | undefined ? undefined : Partial<TypeOf<Schema>> | undefined;
135
+ submit: () => boolean;
136
+ validate: () => boolean;
129
137
  errors: Readonly<Ref<DeepReadonly<z.inferFormattedError<Schema, string>>>>;
130
138
  fieldsErrors: Map<string, Record<string, {
131
139
  _errors: string[];
package/dist/index.d.ts CHANGED
@@ -68,6 +68,7 @@ export declare const useForm: <Schema extends FormSchema>(schema: Schema, option
68
68
  }, {
69
69
  formData: import("vue").Ref<Partial<import("zod").TypeOf<Schema> | undefined>>;
70
70
  submit: () => boolean;
71
+ validate: (value?: Partial<import("zod").TypeOf<Schema> | undefined>) => boolean;
71
72
  errors: Readonly<import("vue").Ref<import("vue").DeepReadonly<import("zod").ZodFormattedError<import("zod").TypeOf<Schema>>> | undefined>>;
72
73
  status: Readonly<import("vue").Ref<import("./enums").FormStatus | undefined>>;
73
74
  invalid: import("vue").ComputedRef<boolean>;
@@ -116,6 +117,7 @@ export declare const useForm: <Schema extends FormSchema>(schema: Schema, option
116
117
  } & import("vue").ShallowUnwrapRef<{
117
118
  formData: import("vue").Ref<Partial<import("zod").TypeOf<Schema> | undefined>>;
118
119
  submit: () => boolean;
120
+ validate: (value?: Partial<import("zod").TypeOf<Schema> | undefined>) => boolean;
119
121
  errors: Readonly<import("vue").Ref<import("vue").DeepReadonly<import("zod").ZodFormattedError<import("zod").TypeOf<Schema>>> | undefined>>;
120
122
  status: Readonly<import("vue").Ref<import("./enums").FormStatus | undefined>>;
121
123
  invalid: import("vue").ComputedRef<boolean>;
@@ -144,6 +146,7 @@ export declare const useForm: <Schema extends FormSchema>(schema: Schema, option
144
146
  }, {
145
147
  formData: import("vue").Ref<Partial<import("zod").TypeOf<Schema> | undefined>>;
146
148
  submit: () => boolean;
149
+ validate: (value?: Partial<import("zod").TypeOf<Schema> | undefined>) => boolean;
147
150
  errors: Readonly<import("vue").Ref<import("vue").DeepReadonly<import("zod").ZodFormattedError<import("zod").TypeOf<Schema>>> | undefined>>;
148
151
  status: Readonly<import("vue").Ref<import("./enums").FormStatus | undefined>>;
149
152
  invalid: import("vue").ComputedRef<boolean>;
@@ -156,6 +159,7 @@ export declare const useForm: <Schema extends FormSchema>(schema: Schema, option
156
159
  default: (_: {
157
160
  formData: unknown extends Partial<import("zod").TypeOf<Schema>> | undefined ? undefined : Partial<import("zod").TypeOf<Schema>> | undefined;
158
161
  submit: () => boolean;
162
+ validate: () => boolean;
159
163
  errors: Readonly<import("vue").Ref<import("vue").DeepReadonly<import("zod").inferFormattedError<Schema, string>>>>;
160
164
  status: import("vue").Ref<import("vue").DeepReadonly<"invalid" | "valid" | undefined>>;
161
165
  invalid: import("vue").Ref<import("vue").DeepReadonly<boolean>>;
@@ -209,6 +213,8 @@ export declare const useForm: <Schema extends FormSchema>(schema: Schema, option
209
213
  }, {
210
214
  formData: import("vue").Ref<Partial<import("zod").TypeOf<Schema>> | undefined> | undefined;
211
215
  errors: Readonly<import("vue").Ref<DeepReadonly<import("zod").inferFormattedError<Schema_1, string>>>> | undefined;
216
+ submit: (() => boolean) | undefined;
217
+ validate: (() => boolean) | undefined;
212
218
  invalid: import("vue").ComputedRef<boolean>;
213
219
  fields: import("vue").Ref<Set<string>>;
214
220
  fieldsErrors: import("vue").Ref<Map<string, Record<string, {
@@ -251,6 +257,8 @@ export declare const useForm: <Schema extends FormSchema>(schema: Schema, option
251
257
  } & import("vue").ShallowUnwrapRef<{
252
258
  formData: import("vue").Ref<Partial<import("zod").TypeOf<Schema>> | undefined> | undefined;
253
259
  errors: Readonly<import("vue").Ref<DeepReadonly<import("zod").inferFormattedError<Schema_1, string>>>> | undefined;
260
+ submit: (() => boolean) | undefined;
261
+ validate: (() => boolean) | undefined;
254
262
  invalid: import("vue").ComputedRef<boolean>;
255
263
  fields: import("vue").Ref<Set<string>>;
256
264
  fieldsErrors: import("vue").Ref<Map<string, Record<string, {
@@ -275,6 +283,8 @@ export declare const useForm: <Schema extends FormSchema>(schema: Schema, option
275
283
  }, {
276
284
  formData: import("vue").Ref<Partial<import("zod").TypeOf<Schema>> | undefined> | undefined;
277
285
  errors: Readonly<import("vue").Ref<DeepReadonly<import("zod").inferFormattedError<Schema_1, string>>>> | undefined;
286
+ submit: (() => boolean) | undefined;
287
+ validate: (() => boolean) | undefined;
278
288
  invalid: import("vue").ComputedRef<boolean>;
279
289
  fields: import("vue").Ref<Set<string>>;
280
290
  fieldsErrors: import("vue").Ref<Map<string, Record<string, {
@@ -287,6 +297,8 @@ export declare const useForm: <Schema extends FormSchema>(schema: Schema, option
287
297
  default: (_: {
288
298
  invalid: boolean;
289
299
  formData: unknown extends Partial<import("zod").TypeOf<Schema>> | undefined ? undefined : Partial<import("zod").TypeOf<Schema>> | undefined;
300
+ submit: () => boolean;
301
+ validate: () => boolean;
290
302
  errors: Readonly<import("vue").Ref<import("vue").DeepReadonly<import("zod").inferFormattedError<Schema, string>>>>;
291
303
  fieldsErrors: Map<string, Record<string, {
292
304
  _errors: string[];
@@ -392,6 +404,7 @@ export declare const useForm: <Schema extends FormSchema>(schema: Schema, option
392
404
  default: (_: {
393
405
  formData: unknown extends Partial<import("zod").TypeOf<Schema>> | undefined ? undefined : Partial<import("zod").TypeOf<Schema>> | undefined;
394
406
  submit: () => boolean;
407
+ validate: () => boolean;
395
408
  errors: Readonly<import("vue").Ref<import("vue").DeepReadonly<import("zod").inferFormattedError<Schema, string>>>>;
396
409
  status: import("vue").Ref<import("vue").DeepReadonly<"invalid" | "valid" | undefined>>;
397
410
  invalid: import("vue").Ref<import("vue").DeepReadonly<boolean>>;
@@ -477,6 +490,7 @@ export declare const formFactory: <Schema extends FormSchema>(schema: Schema, op
477
490
  }, {
478
491
  formData: import("vue").Ref<Partial<import("zod").TypeOf<Schema> | undefined>>;
479
492
  submit: () => boolean;
493
+ validate: (value?: Partial<import("zod").TypeOf<Schema> | undefined>) => boolean;
480
494
  errors: Readonly<import("vue").Ref<import("vue").DeepReadonly<import("zod").ZodFormattedError<import("zod").TypeOf<Schema>>> | undefined>>;
481
495
  status: Readonly<import("vue").Ref<import("./enums").FormStatus | undefined>>;
482
496
  invalid: import("vue").ComputedRef<boolean>;
@@ -525,6 +539,7 @@ export declare const formFactory: <Schema extends FormSchema>(schema: Schema, op
525
539
  } & import("vue").ShallowUnwrapRef<{
526
540
  formData: import("vue").Ref<Partial<import("zod").TypeOf<Schema> | undefined>>;
527
541
  submit: () => boolean;
542
+ validate: (value?: Partial<import("zod").TypeOf<Schema> | undefined>) => boolean;
528
543
  errors: Readonly<import("vue").Ref<import("vue").DeepReadonly<import("zod").ZodFormattedError<import("zod").TypeOf<Schema>>> | undefined>>;
529
544
  status: Readonly<import("vue").Ref<import("./enums").FormStatus | undefined>>;
530
545
  invalid: import("vue").ComputedRef<boolean>;
@@ -553,6 +568,7 @@ export declare const formFactory: <Schema extends FormSchema>(schema: Schema, op
553
568
  }, {
554
569
  formData: import("vue").Ref<Partial<import("zod").TypeOf<Schema> | undefined>>;
555
570
  submit: () => boolean;
571
+ validate: (value?: Partial<import("zod").TypeOf<Schema> | undefined>) => boolean;
556
572
  errors: Readonly<import("vue").Ref<import("vue").DeepReadonly<import("zod").ZodFormattedError<import("zod").TypeOf<Schema>>> | undefined>>;
557
573
  status: Readonly<import("vue").Ref<import("./enums").FormStatus | undefined>>;
558
574
  invalid: import("vue").ComputedRef<boolean>;
@@ -565,6 +581,7 @@ export declare const formFactory: <Schema extends FormSchema>(schema: Schema, op
565
581
  default: (_: {
566
582
  formData: unknown extends Partial<import("zod").TypeOf<Schema>> | undefined ? undefined : Partial<import("zod").TypeOf<Schema>> | undefined;
567
583
  submit: () => boolean;
584
+ validate: () => boolean;
568
585
  errors: Readonly<import("vue").Ref<import("vue").DeepReadonly<import("zod").inferFormattedError<Schema, string>>>>;
569
586
  status: import("vue").Ref<import("vue").DeepReadonly<"invalid" | "valid" | undefined>>;
570
587
  invalid: import("vue").Ref<import("vue").DeepReadonly<boolean>>;
@@ -618,6 +635,8 @@ export declare const formFactory: <Schema extends FormSchema>(schema: Schema, op
618
635
  }, {
619
636
  formData: import("vue").Ref<Partial<import("zod").TypeOf<Schema>> | undefined> | undefined;
620
637
  errors: Readonly<import("vue").Ref<DeepReadonly<import("zod").inferFormattedError<Schema_1, string>>>> | undefined;
638
+ submit: (() => boolean) | undefined;
639
+ validate: (() => boolean) | undefined;
621
640
  invalid: import("vue").ComputedRef<boolean>;
622
641
  fields: import("vue").Ref<Set<string>>;
623
642
  fieldsErrors: import("vue").Ref<Map<string, Record<string, {
@@ -660,6 +679,8 @@ export declare const formFactory: <Schema extends FormSchema>(schema: Schema, op
660
679
  } & import("vue").ShallowUnwrapRef<{
661
680
  formData: import("vue").Ref<Partial<import("zod").TypeOf<Schema>> | undefined> | undefined;
662
681
  errors: Readonly<import("vue").Ref<DeepReadonly<import("zod").inferFormattedError<Schema_1, string>>>> | undefined;
682
+ submit: (() => boolean) | undefined;
683
+ validate: (() => boolean) | undefined;
663
684
  invalid: import("vue").ComputedRef<boolean>;
664
685
  fields: import("vue").Ref<Set<string>>;
665
686
  fieldsErrors: import("vue").Ref<Map<string, Record<string, {
@@ -684,6 +705,8 @@ export declare const formFactory: <Schema extends FormSchema>(schema: Schema, op
684
705
  }, {
685
706
  formData: import("vue").Ref<Partial<import("zod").TypeOf<Schema>> | undefined> | undefined;
686
707
  errors: Readonly<import("vue").Ref<DeepReadonly<import("zod").inferFormattedError<Schema_1, string>>>> | undefined;
708
+ submit: (() => boolean) | undefined;
709
+ validate: (() => boolean) | undefined;
687
710
  invalid: import("vue").ComputedRef<boolean>;
688
711
  fields: import("vue").Ref<Set<string>>;
689
712
  fieldsErrors: import("vue").Ref<Map<string, Record<string, {
@@ -696,6 +719,8 @@ export declare const formFactory: <Schema extends FormSchema>(schema: Schema, op
696
719
  default: (_: {
697
720
  invalid: boolean;
698
721
  formData: unknown extends Partial<import("zod").TypeOf<Schema>> | undefined ? undefined : Partial<import("zod").TypeOf<Schema>> | undefined;
722
+ submit: () => boolean;
723
+ validate: () => boolean;
699
724
  errors: Readonly<import("vue").Ref<import("vue").DeepReadonly<import("zod").inferFormattedError<Schema, string>>>>;
700
725
  fieldsErrors: Map<string, Record<string, {
701
726
  _errors: string[];
@@ -801,6 +826,7 @@ export declare const formFactory: <Schema extends FormSchema>(schema: Schema, op
801
826
  default: (_: {
802
827
  formData: unknown extends Partial<import("zod").TypeOf<Schema>> | undefined ? undefined : Partial<import("zod").TypeOf<Schema>> | undefined;
803
828
  submit: () => boolean;
829
+ validate: () => boolean;
804
830
  errors: Readonly<import("vue").Ref<import("vue").DeepReadonly<import("zod").inferFormattedError<Schema, string>>>>;
805
831
  status: import("vue").Ref<import("vue").DeepReadonly<"invalid" | "valid" | undefined>>;
806
832
  invalid: import("vue").Ref<import("vue").DeepReadonly<boolean>>;