V2 - TypeScript/Tests improvements + Vest fix #110

jorisre · 2021-01-05T22:24:20Z

Last step before starting new features :)

Fix validateAllFieldCriteria bug in Vest resolver
Add preactjs/compressed-size-action
Add tests and add consistency between tests
Adding test components to prevent TypeScript's errors with useForm — related to Type problems after update resolver to 1.3.0 #97
Improving Resolver types ⬇️

Before

After

Related to #97

github-actions · 2021-01-07T11:53:55Z

Size Change: +88 B (+1%)

Total Size: 14.3 kB

Filename	Size	Change
`superstruct/dist/superstruct.js`	991 B	+24 B (+2%)
`superstruct/dist/superstruct.modern.js`	928 B	+3 B (0%)
`superstruct/dist/superstruct.module.js`	1.01 kB	+27 B (+3%)
`superstruct/dist/superstruct.umd.js`	1.09 kB	+25 B (+2%)
`vest/dist/vest.js`	494 B	+2 B (0%)
`vest/dist/vest.modern.js`	442 B	+2 B (0%)
`vest/dist/vest.module.js`	506 B	+3 B (+1%)
`vest/dist/vest.umd.js`	592 B	+2 B (0%)

ℹ️ View Unchanged

Filename	Size	Change
`dist/resolvers.js`	169 B	0 B
`dist/resolvers.modern.js`	177 B	0 B
`dist/resolvers.module.js`	182 B	0 B
`dist/resolvers.umd.js`	260 B	0 B
`joi/dist/joi.js`	604 B	0 B
`joi/dist/joi.modern.js`	503 B	0 B
`joi/dist/joi.module.js`	616 B	0 B
`joi/dist/joi.umd.js`	704 B	0 B
`yup/dist/yup.js`	695 B	0 B
`yup/dist/yup.modern.js`	602 B	0 B
`yup/dist/yup.module.js`	704 B	0 B
`yup/dist/yup.umd.js`	791 B	0 B
`zod/dist/zod.js`	534 B	0 B
`zod/dist/zod.modern.js`	485 B	0 B
`zod/dist/zod.module.js`	547 B	0 B
`zod/dist/zod.umd.js`	637 B	0 B

_{compressed-size-action}

jorisre · 2021-01-08T12:38:22Z

@bluebill1049 PR ready for review ;)

joi/src/__tests__/Form.tsx

bluebill1049 · 2021-01-08T22:09:58Z

joi/src/__tests__/joi.ts

+      birthYear: 'birthYear',
+    };
+
+    const result = await joiResolver(schema)(data, undefined, true);


just a quick note, going to change this true to an object.

{ isValidateAllFieldCriteria: boolean, field: { name: string, }, // potential more }

maybe call it formContext, not sure if that's going to be too confusing, but we figure out a good name later.

Ok, sound good to me. I'll change it in another PR.

Does field contains ref too ?
Do you think we have to add an option to allow users to validate only the current instead all field ? (except on submit event)
Or users have to create a custom resolver ?

Does field contains ref too ?

Yes.

Do you think we have to add an option to allow users to validate only the current instead all field ? (except on submit event)

Yes, That would be awesome. I am not sure how easy it is going to be for all resolvers.

bluebill1049 · 2021-01-08T22:11:25Z

joi/src/__tests__/joi.ts

+
+    const result = await joiResolver(schema)(data);
+
+    expect(result).toMatchSnapshot();


Minor: (don't have to change as well) maybe be specific with the error? I normally use snapshots for a successful responses.

bluebill1049

I love those:

Tests
Type improvement
Structure improvement

Awesome stuff!! 🎖

bluebill1049 · 2021-01-08T22:14:32Z

joi/src/types.ts

+} from 'react-hook-form';
+import type { AsyncValidationOptions, Schema } from 'joi';
+
+export type Resolver = <T extends Schema>(


here is the type in the react-hook-form repo:

I think maybe it's better to leave that at react-hook-form and centralize there?

export type Resolver< TFieldValues extends FieldValues = FieldValues, TContext extends object = object > = ( values: UnpackNestedValue<TFieldValues>, context?: TContext, validateAllFieldCriteria?: boolean, ) => Promise<ResolverResult<TFieldValues>> | ResolverResult<TFieldValues>;

It's not the same type

From react-hook-form:

export type Resolver< TFieldValues extends FieldValues = FieldValues, TContext extends object = object > = ( values: UnpackNestedValue<TFieldValues>, context?: TContext, validateAllFieldCriteria?: boolean, ) => Promise<ResolverResult<TFieldValues>> | ResolverResult<TFieldValues>;

And from resolvers:

export type Resolver = <T extends Schema>( schema: T, options?: AsyncValidationOptions, ) => <TFieldValues extends FieldValues, TContext>( values: UnpackNestedValue<TFieldValues>, context?: TContext, validateAllFieldCriteria?: boolean, ) => Promise<ResolverResult<TFieldValues>>;

The generic type isn't placed at the same point. This update improve resolver's return type. But I'm open for a better idea 😉

I tried to centralized but it breaks severals things: react-hook-form/react-hook-form#3821

all good, I realize that after reviewing the rest of the resolvers.

superstruct/src/__tests__/Form.tsx

superstruct/src/__tests__/superstruct.ts

bluebill1049 · 2021-01-08T22:18:49Z

superstruct/src/types.ts

+} from 'react-hook-form';
+import { validate, Struct } from 'superstruct';
+
+type Options = Parameters<typeof validate>[2];


oh, I see why you need to leave those type here, that's fine as well. probably need to include that in the doc, so user don't get confused where the type is, perhaps we should remove that type from the core repo.

vest/src/__tests__/Form.tsx

bluebill1049 · 2021-01-08T22:21:04Z

vest/src/vest.ts

 };

-export const vestResolver = <TFieldValues extends FieldValues>(
-  schema: ICreateResult,


bluebill1049 · 2021-01-08T22:21:16Z

vest/src/vest.ts

-  _: any = {},
+export const vestResolver: Resolver = (schema, _ = {}) => async (
+  values,
+  _context,


yup/src/__tests__/Form.tsx

yup/src/types.ts

zod/src/__tests__/Form.tsx

github-actions · 2021-01-21T09:04:17Z

🎉 This PR is included in version 2.0.0-beta.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

test: add components test to ensure TypeScript is working as expected

627cc39

Related to #97

jorisre changed the base branch from master to beta January 5, 2021 22:24

chore: improve zod resolvers types

2721382

jorisre force-pushed the improve-resolvers-typescript branch from 98633da to 2721382 Compare January 6, 2021 10:42

jorisre added 2 commits January 6, 2021 21:35

chore(eslint): remove warnings

87992b0

test: add severals tests & improve typings

e4c750a

jorisre force-pushed the improve-resolvers-typescript branch from 3d3d46d to e4c750a Compare January 6, 2021 22:17

chore: setup compressed-size

0cfd849

jorisre requested a review from bluebill1049 January 7, 2021 11:59

jorisre marked this pull request as ready for review January 7, 2021 12:00

jorisre changed the title ~~V2 - TypeScript improvements~~ V2 - TypeScript/Tests improvements + Vest fix Jan 8, 2021

bluebill1049 reviewed Jan 8, 2021

View reviewed changes

joi/src/__tests__/Form.tsx Show resolved Hide resolved

bluebill1049 reviewed Jan 8, 2021

View reviewed changes

bluebill1049 approved these changes Jan 8, 2021

View reviewed changes

test: update describe

dc229cd

jorisre merged commit b7dd0e6 into beta Jan 9, 2021

jorisre mentioned this pull request Jan 9, 2021

V2 🚀 #108

Merged

5 tasks

github-actions bot added the released on @beta label Jan 21, 2021

jorisre deleted the improve-resolvers-typescript branch February 6, 2021 08:17


		const result = await joiResolver(schema)(data);

		expect(result).toMatchSnapshot();

Uh oh!

V2 - TypeScript/Tests improvements + Vest fix #110

V2 - TypeScript/Tests improvements + Vest fix #110

Uh oh!

Conversation

jorisre commented Jan 5, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jan 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jorisre commented Jan 8, 2021

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bluebill1049 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jan 21, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jorisre commented Jan 5, 2021 •

edited

Loading

github-actions bot commented Jan 7, 2021 •

edited

Loading