Feature implementation from commits 89b41b5..494583f #4
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| import type { OpenAPIObject } from "openapi3-ts"; | ||
| import { expect, test } from "vitest"; | ||
| import { generateZodClientFromOpenAPI } from "../src"; | ||
|
|
||
| test("array-body-with-chains-tag-group-strategy", async () => { | ||
| const openApiDoc: OpenAPIObject = { | ||
| openapi: "3.0.0", | ||
| info: { title: "Test", version: "1.0.1" }, | ||
| paths: { | ||
| "/test": { | ||
| put: { | ||
| summary: "Test", | ||
| description: "Test", | ||
| tags: ["Test"], | ||
| requestBody: { | ||
| content: { | ||
| "application/json": { | ||
| schema: { | ||
| type: "array", | ||
| items: { | ||
| type: "object", | ||
| properties: { | ||
| testItem: { | ||
| type: "string", | ||
| }, | ||
| }, | ||
| additionalProperties: false, | ||
| }, | ||
| minItems: 1, | ||
| maxItems: 10, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| parameters: [], | ||
| responses: { | ||
| "200": { | ||
| description: "Success", | ||
| content: { "application/json": {} }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| components: {}, | ||
| tags: [], | ||
| }; | ||
|
|
||
| const output = await generateZodClientFromOpenAPI({ | ||
| disableWriteToFile: true, | ||
| openApiDoc, | ||
| options: { groupStrategy: "tag-file" }, | ||
| }); | ||
| expect(output).toMatchInlineSnapshot(` | ||
| { | ||
| "Test": "import { makeApi, Zodios, type ZodiosOptions } from "@zodios/core"; | ||
| import { z } from "zod"; | ||
|
|
||
| const putTest_Body = z.array(z.object({ testItem: z.string() }).partial()); | ||
|
|
||
| export const schemas = { | ||
| putTest_Body, | ||
| }; | ||
|
|
||
| const endpoints = makeApi([ | ||
| { | ||
| method: "put", | ||
| path: "/test", | ||
| description: \`Test\`, | ||
| requestFormat: "json", | ||
| parameters: [ | ||
| { | ||
| name: "body", | ||
| type: "Body", | ||
| schema: putTest_Body.min(1).max(10), | ||
| }, | ||
| ], | ||
| response: z.void(), | ||
| }, | ||
| ]); | ||
|
|
||
| export const TestApi = new Zodios(endpoints); | ||
|
|
||
| export function createApiClient(baseUrl: string, options?: ZodiosOptions) { | ||
| return new Zodios(baseUrl, endpoints, options); | ||
| } | ||
| ", | ||
| "__index": "export { TestApi } from "./Test"; | ||
| ", | ||
| } | ||
| `); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,6 +31,23 @@ test("description-in-zod", async () => { | |
| }, | ||
| description: "bar description", | ||
| }, | ||
| { | ||
| in: "query", | ||
| name: "baz", | ||
| schema: { | ||
| type: "number", | ||
| enum: [1.3, 34.1, -57.89], | ||
| }, | ||
| description: "baz\nmultiline\ndescription", | ||
| }, | ||
| { | ||
| in: "query", | ||
| name: "qux", | ||
| schema: { | ||
| type: "string", | ||
| }, | ||
| description: " ", // spaces only description | ||
| }, | ||
| ], | ||
| responses: { | ||
| "200": { | ||
|
|
@@ -73,6 +90,21 @@ test("description-in-zod", async () => { | |
| .describe("bar description") | ||
| .optional(), | ||
| }, | ||
| { | ||
| name: "baz", | ||
| type: "Query", | ||
| schema: z | ||
| .union([z.literal(1.3), z.literal(34.1), z.literal(-57.89)]) | ||
| .describe( | ||
| \`baz\nmultiline\ndescription\` | ||
| ) | ||
| .optional(), | ||
| }, | ||
| { | ||
| name: "qux", | ||
| type: "Query", | ||
| schema: z.string().optional(), | ||
| }, | ||
| ], | ||
| response: z.void(), | ||
| }, | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -58,6 +58,11 @@ test("export-all-named-schemas", async () => { | |
| }, | ||
| }, | ||
| parameters: [ | ||
| { | ||
| name: "sameSchemaDifferentName", | ||
| in: "query", | ||
| schema: { type: "string", enum: ["xxx", "yyy", "zzz"] }, | ||
| }, | ||
| { | ||
| name: "sameSchemaSameName", | ||
| in: "query", | ||
|
|
@@ -128,6 +133,11 @@ test("export-all-named-schemas", async () => { | |
| "errors": [], | ||
| "method": "delete", | ||
| "parameters": [ | ||
| { | ||
| "name": "sameSchemaDifferentName", | ||
| "schema": "sameSchemaDifferentName", | ||
| "type": "Query", | ||
| }, | ||
| { | ||
| "name": "sameSchemaSameName", | ||
| "schema": "sameSchemaSameName", | ||
|
|
@@ -160,6 +170,7 @@ test("export-all-named-schemas", async () => { | |
| "withAlias": false, | ||
| }, | ||
| "schemas": { | ||
| "sameSchemaDifferentName": "z.enum(["xxx", "yyy", "zzz"]).optional()", | ||
| "sameSchemaSameName": "z.enum(["xxx", "yyy", "zzz"]).optional()", | ||
| "schemaNameAlreadyUsed": "z.enum(["aaa", "bbb", "ccc"]).optional()", | ||
| "schemaNameAlreadyUsed__2": "z.enum(["ggg", "hhh", "iii"]).optional()", | ||
|
|
@@ -180,11 +191,13 @@ test("export-all-named-schemas", async () => { | |
|
|
||
| const sameSchemaSameName = z.enum(["xxx", "yyy", "zzz"]).optional(); | ||
| const schemaNameAlreadyUsed = z.enum(["aaa", "bbb", "ccc"]).optional(); | ||
| const sameSchemaDifferentName = z.enum(["xxx", "yyy", "zzz"]).optional(); | ||
| const schemaNameAlreadyUsed__2 = z.enum(["ggg", "hhh", "iii"]).optional(); | ||
|
|
||
| export const schemas = { | ||
| sameSchemaSameName, | ||
| schemaNameAlreadyUsed, | ||
| sameSchemaDifferentName, | ||
| schemaNameAlreadyUsed__2, | ||
| }; | ||
|
|
||
|
|
@@ -220,6 +233,11 @@ test("export-all-named-schemas", async () => { | |
| path: "/export-all-named-schemas", | ||
| requestFormat: "json", | ||
| parameters: [ | ||
| { | ||
| name: "sameSchemaDifferentName", | ||
| type: "Query", | ||
| schema: sameSchemaDifferentName, | ||
| }, | ||
| { | ||
| name: "sameSchemaSameName", | ||
| type: "Query", | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -398,7 +398,7 @@ describe("samples-generator", async () => { | |
| const perform_search_Body = z | ||
| .object({ | ||
| criteria: z.string().default("*:*"), | ||
| start: z.number().int().optional().default(0), | ||
| rows: z.number().int().optional().default(100), | ||
| }) | ||
| .passthrough(); | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🐛 Correctness Issue
Property name mismatch with type definition.
The code initializes ctx.schemasByName but the type definition uses schemaByName (without 's'), which will cause runtime errors when accessing this property.
Current Code (Diff):
📝 Committable suggestion
🔄 Dependencies Affected
lib/src/template-context.ts
Function:
any function using getZodiosEndpointDefinitionList resultIssue: Code expecting schemaByName property but receiving schemasByName
Suggestion: Update any code using ctx.schemasByName to use ctx.schemaByName instead