Skip to content

added a new option scalarSchemas #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,32 @@ type: `boolean` default: `false`

Generates validation string schema as do not allow empty characters by default.

### `scalarSchemas`

type: `ScalarSchemas`

Extends or overrides validation schema for the built-in scalars and custom GraphQL scalars.

#### yup schema

```yml
config:
schema: yup
scalarSchemas:
Date: yup.date()
Email: yup.string().email()
```

#### zod schema

```yml
config:
schema: zod
scalarSchemas:
Date: z.date()
Email: z.string().email()
```

### `directives`

type: `DirectiveConfig`
Expand Down
26 changes: 26 additions & 0 deletions src/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ export interface DirectiveObjectArguments {
[matched: string]: string | string[];
}

interface ScalarSchemas {
[name: string]: string;
}

export interface ValidationSchemaPluginConfig extends TypeScriptPluginConfig {
/**
* @description specify generate schema
Expand Down Expand Up @@ -88,6 +92,28 @@ export interface ValidationSchemaPluginConfig extends TypeScriptPluginConfig {
* ```
*/
notAllowEmptyString?: boolean;
/**
* @description Extends or overrides validation schema for the built-in scalars and custom GraphQL scalars.
*
* @exampleMarkdown
* ```yml
* config:
* schema: yup
* scalarSchemas:
* Date: yup.date()
* Email: yup.string().email()
* ```
*
* @exampleMarkdown
* ```yml
* config:
* schema: zod
* scalarSchemas:
* Date: z.date()
* Email: z.string().email()
* ```
*/
scalarSchemas?: ScalarSchemas;
/**
* @description Generates validation schema with more API based on directive schema.
* @exampleMarkdown
Expand Down
7 changes: 5 additions & 2 deletions src/yup/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ const generateNameNodeYupSchema = (
return `${enumName}Schema`;
}

const primitive = yup4Scalar(tsVisitor, node.value);
const primitive = yup4Scalar(config, tsVisitor, node.value);
return primitive;
};

Expand Down Expand Up @@ -180,7 +180,10 @@ const maybeNonEmptyString = (
return `${schema}.defined()`;
};

const yup4Scalar = (tsVisitor: TsVisitor, scalarName: string): string => {
const yup4Scalar = (config: ValidationSchemaPluginConfig, tsVisitor: TsVisitor, scalarName: string): string => {
if (config.scalarSchemas?.[scalarName]) {
return config.scalarSchemas[scalarName];
}
const tsType = tsVisitor.scalars[scalarName];
switch (tsType) {
case 'string':
Expand Down
16 changes: 12 additions & 4 deletions src/zod/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ const generateInputObjectFieldTypeZodSchema = (
return maybeLazy(type.type, gen);
}
if (isNamedType(type)) {
const gen = generateNameNodeZodSchema(tsVisitor, schema, type.name);
const gen = generateNameNodeZodSchema(config, tsVisitor, schema, type.name);
if (isNonNullType(parentType)) {
if (config.notAllowEmptyString === true) {
const tsType = tsVisitor.scalars[type.name.value];
Expand All @@ -131,7 +131,12 @@ const generateInputObjectFieldTypeZodSchema = (
return '';
};

const generateNameNodeZodSchema = (tsVisitor: TsVisitor, schema: GraphQLSchema, node: NameNode): string => {
const generateNameNodeZodSchema = (
config: ValidationSchemaPluginConfig,
tsVisitor: TsVisitor,
schema: GraphQLSchema,
node: NameNode
): string => {
const typ = schema.getType(node.value);

if (typ && typ.astNode?.kind === 'InputObjectTypeDefinition') {
Expand All @@ -144,7 +149,7 @@ const generateNameNodeZodSchema = (tsVisitor: TsVisitor, schema: GraphQLSchema,
return `${enumName}Schema`;
}

return zod4Scalar(tsVisitor, node.value);
return zod4Scalar(config, tsVisitor, node.value);
};

const maybeLazy = (type: TypeNode, schema: string): string => {
Expand All @@ -154,7 +159,10 @@ const maybeLazy = (type: TypeNode, schema: string): string => {
return schema;
};

const zod4Scalar = (tsVisitor: TsVisitor, scalarName: string): string => {
const zod4Scalar = (config: ValidationSchemaPluginConfig, tsVisitor: TsVisitor, scalarName: string): string => {
if (config.scalarSchemas?.[scalarName]) {
return config.scalarSchemas[scalarName];
}
const tsType = tsVisitor.scalars[scalarName];
switch (tsType) {
case 'string':
Expand Down
32 changes: 32 additions & 0 deletions tests/yup.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -243,4 +243,36 @@ describe('yup', () => {
expect(result.content).toContain(wantContain);
}
});

it('with scalarSchemas', async () => {
const schema = buildSchema(/* GraphQL */ `
input ScalarsInput {
date: Date!
email: Email
str: String!
}
scalar Date
scalar Email
`);
const result = await plugin(
schema,
[],
{
scalarSchemas: {
Date: 'yup.date()',
Email: 'yup.string().email()',
},
},
{}
);
const wantContains = [
'export function ScalarsInputSchema(): yup.SchemaOf<ScalarsInput>',
'date: yup.date().defined(),',
'email: yup.string().email(),',
'str: yup.string().defined()',
];
for (const wantContain of wantContains) {
expect(result.content).toContain(wantContain);
}
});
});
33 changes: 33 additions & 0 deletions tests/zod.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -247,4 +247,37 @@ describe('zod', () => {
expect(result.content).toContain(wantContain);
}
});

it('with scalarSchemas', async () => {
const schema = buildSchema(/* GraphQL */ `
input ScalarsInput {
date: Date!
email: Email
str: String!
}
scalar Date
scalar Email
`);
const result = await plugin(
schema,
[],
{
schema: 'zod',
scalarSchemas: {
Date: 'z.date()',
Email: 'z.string().email()',
},
},
{}
);
const wantContains = [
'export function ScalarsInputSchema(): z.ZodSchema<ScalarsInput>',
'date: z.date(),',
'email: z.string().email().nullish(),',
'str: z.string()',
];
for (const wantContain of wantContains) {
expect(result.content).toContain(wantContain);
}
});
});