Skip to content

fix(plugins/zod): fix support for string types in binary format #1616

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

fix(plugins/zod): fix support for string types in binary format #1616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dbb61e5
feat(plugins/zod): add support for string types in binary format
nedpals Jan 23, 2025
95b0d6b
fix: add changeset
nedpals Jan 23, 2025
d6da03c
fix: style and lint
nedpals Jan 23, 2025
f841028
fix: tests
nedpals Jan 24, 2025
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
5 changes: 5 additions & 0 deletions .changeset/funny-penguins-speak.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@hey-api/openapi-ts': minor
---

fix(plugins/zod): fix support for string type in binary format
21 changes: 21 additions & 0 deletions packages/openapi-ts/src/plugins/zod/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
const readonlyIdentifier = compiler.identifier({ text: 'readonly' });
const regexIdentifier = compiler.identifier({ text: 'regex' });
const unionIdentifier = compiler.identifier({ text: 'union' });
const instanceofIdentifier = compiler.identifier({ text: 'instanceof' });
const zIdentifier = compiler.identifier({ text: 'z' });

const nameTransformer = (name: string) => `z-${name}`;
Expand Down Expand Up @@ -493,6 +494,26 @@
}),
});
break;
case 'binary':
stringExpression = compiler.callExpression({
functionName: compiler.propertyAccessExpression({
expression: zIdentifier,
name: unionIdentifier,
}),
parameters: [
compiler.arrayLiteralExpression({
elements: ['File', 'Blob'].map((typeIdent) =>
compiler.callExpression({
functionName: compiler.propertyAccessExpression({
expression: zIdentifier,
name: instanceofIdentifier,
}),
parameters: [compiler.identifier({ text: typeIdent })],
}),
),
}),
],
});

Check warning on line 516 in packages/openapi-ts/src/plugins/zod/plugin.ts

View check run for this annotation

Codecov / codecov/patch

packages/openapi-ts/src/plugins/zod/plugin.ts#L497-L516 

Added lines #L497 - L516 were not covered by tests
}
}

Expand Down
12 changes: 9 additions & 3 deletions packages/openapi-ts/test/__snapshots__/2.0.x/plugins/zod/default/zod.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@ export const zSimpleString = z.string();

export const zNonAsciiStringæøåÆøÅöôêÊ字符串 = z.string();

export const zSimpleFile = z.string();
export const zSimpleFile = z.union([
z.instanceof(File),
z.instanceof(Blob)
]);

export const zSimpleReference = z.object({
prop: z.string().optional()
Expand Down Expand Up @@ -156,7 +159,10 @@ export const zModelWithReference = z.object({

export const zModelWithArray = z.object({
prop: z.array(zModelWithString).optional(),
propWithFile: z.array(z.string()).optional(),
propWithFile: z.array(z.union([
z.instanceof(File),
z.instanceof(Blob)
])).optional(),
propWithNumber: z.array(z.number()).optional()
});

Expand Down Expand Up @@ -286,4 +292,4 @@ export const zComplexTypesResponse = z.array(zModelWithString);

export const zNonAsciiæøåÆøÅöôêÊ字符串Response = zNonAsciiStringæøåÆøÅöôêÊ字符串;

export const zPostApiVbyApiVersionBodyResponse = zResponsePostActivityResponse;
export const zPostApiVbyApiVersionBodyResponse = zResponsePostActivityResponse;
27 changes: 21 additions & 6 deletions packages/openapi-ts/test/__snapshots__/3.0.x/plugins/zod/default/zod.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@ export const zSimpleString = z.string();

export const zNonAsciiStringæøåÆøÅöôêÊ字符串 = z.string();

export const zSimpleFile = z.string();
export const zSimpleFile = z.union([
z.instanceof(File),
z.instanceof(Blob)
]);

export const zSimpleReference = z.object({
prop: z.string().optional()
Expand Down Expand Up @@ -221,13 +224,19 @@ export const zModelWithArrayReadOnlyAndWriteOnly = z.object({
bar: z.string().readonly(),
baz: z.string()
})).optional(),
propWithFile: z.array(z.string()).optional(),
propWithFile: z.array(z.union([
z.instanceof(File),
z.instanceof(Blob)
])).optional(),
propWithNumber: z.array(z.number()).optional()
});

export const zModelWithArray = z.object({
prop: z.array(zModelWithString).optional(),
propWithFile: z.array(z.string()).optional(),
propWithFile: z.array(z.union([
z.instanceof(File),
z.instanceof(Blob)
])).optional(),
propWithNumber: z.array(z.number()).optional()
});

Expand Down Expand Up @@ -791,12 +800,18 @@ export const zTypesResponse = z.union([

export const zUploadFileResponse = z.boolean();

export const zFileResponseResponse = z.string();
export const zFileResponseResponse = z.union([
z.instanceof(File),
z.instanceof(Blob)
]);

export const zComplexTypesResponse = z.array(zModelWithString);

export const zMultipartResponseResponse = z.object({
file: z.string().optional(),
file: z.union([
z.instanceof(File),
z.instanceof(Blob)
]).optional(),
metadata: z.object({
foo: z.string().optional(),
bar: z.string().optional()
Expand All @@ -805,4 +820,4 @@ export const zMultipartResponseResponse = z.object({

export const zComplexParamsResponse = zModelWithString;

export const zNonAsciiæøåÆøÅöôêÊ字符串Response = z.array(zNonAsciiStringæøåÆøÅöôêÊ字符串);
export const zNonAsciiæøåÆøÅöôêÊ字符串Response = z.array(zNonAsciiStringæøåÆøÅöôêÊ字符串);
27 changes: 21 additions & 6 deletions packages/openapi-ts/test/__snapshots__/3.1.x/plugins/zod/default/zod.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@ export const zSimpleString = z.string();

export const zNonAsciiStringæøåÆøÅöôêÊ字符串 = z.string();

export const zSimpleFile = z.string();
export const zSimpleFile = z.union([
z.instanceof(File),
z.instanceof(Blob)
]);

export const zSimpleReference = z.object({
prop: z.string().optional()
Expand Down Expand Up @@ -224,13 +227,19 @@ export const zModelWithArrayReadOnlyAndWriteOnly = z.object({
bar: z.string().readonly(),
baz: z.string()
})).optional(),
propWithFile: z.array(z.string()).optional(),
propWithFile: z.array(z.union([
z.instanceof(File),
z.instanceof(Blob)
])).optional(),
propWithNumber: z.array(z.number()).optional()
});

export const zModelWithArray = z.object({
prop: z.array(zModelWithString).optional(),
propWithFile: z.array(z.string()).optional(),
propWithFile: z.array(z.union([
z.instanceof(File),
z.instanceof(Blob)
])).optional(),
propWithNumber: z.array(z.number()).optional()
});

Expand Down Expand Up @@ -782,12 +791,18 @@ export const zTypesResponse = z.union([

export const zUploadFileResponse = z.boolean();

export const zFileResponseResponse = z.string();
export const zFileResponseResponse = z.union([
z.instanceof(File),
z.instanceof(Blob)
]);

export const zComplexTypesResponse = z.array(zModelWithString);

export const zMultipartResponseResponse = z.object({
file: z.string().optional(),
file: z.union([
z.instanceof(File),
z.instanceof(Blob)
]).optional(),
metadata: z.object({
foo: z.string().optional(),
bar: z.string().optional()
Expand All @@ -796,4 +811,4 @@ export const zMultipartResponseResponse = z.object({

export const zComplexParamsResponse = zModelWithString;

export const zNonAsciiæøåÆøÅöôêÊ字符串Response = z.array(zNonAsciiStringæøåÆøÅöôêÊ字符串);
export const zNonAsciiæøåÆøÅöôêÊ字符串Response = z.array(zNonAsciiStringæøåÆøÅöôêÊ字符串);
Loading