Merge branch 'main' into fix-requestBodies

phk422 · phk422 · commit bc8ef3426d5b · 2024-07-09T16:25:59.000+08:00
diff --git a/docs/advanced.md b/docs/advanced.md
@@ -68,6 +68,8 @@ enum ErrorCode {
 
 :::
 
+To generate in this fashion, `--enum` needs to be specified on the [command line](cli.md#flags).
+
 Alternatively you can use `x-enumNames` and `x-enumDescriptions` ([NSwag/NJsonSchema](https://github.com/RicoSuter/NJsonSchema/wiki/Enums#enum-names-and-descriptions)).
 
 ## Styleguide
diff --git a/docs/node.md b/docs/node.md
@@ -116,7 +116,7 @@ By default, openapiTS will generate `updated_at?: string;` because it’s not su
 import openapiTS from "openapi-typescript";
 import ts from "typescript";
 
-const DATE = ts.factory.createIdentifier("Date"); // `Date`
+const DATE = ts.factory.createTypeReferenceNode(ts.factory.createIdentifier("Date")); // `Date`
 const NULL = ts.factory.createLiteralTypeNode(ts.factory.createNull()); // `null`
 
 const ast = await openapiTS(mySchema, {
@@ -168,7 +168,7 @@ Use the same pattern to transform the types:
 import openapiTS from "openapi-typescript";
 import ts from "typescript";
 
-const BLOB = ts.factory.createIdentifier("Blob"); // `Blob`
+const BLOB = ts.factory.createTypeReferenceNode(ts.factory.createIdentifier("Blob")); // `Blob`
 const NULL = ts.factory.createLiteralTypeNode(ts.factory.createNull()); // `null`
 
 const ast = await openapiTS(mySchema, {
@@ -221,7 +221,7 @@ Here we return an object with a schema property, which is the same as the above
 import openapiTS from "openapi-typescript";
 import ts from "typescript";
 
-const BLOB = ts.factory.createIdentifier("Blob"); // `Blob`
+const BLOB = ts.factory.createTypeReferenceNode(ts.factory.createIdentifier("Blob")); // `Blob`
 const NULL = ts.factory.createLiteralTypeNode(ts.factory.createNull()); // `null`
 
 const ast = await openapiTS(mySchema, {
diff --git a/docs/zh/openapi-fetch/middleware-auth.md b/docs/zh/openapi-fetch/middleware-auth.md
@@ -123,7 +123,7 @@ import type { paths } from "./my-openapi-3-schema"; // 由openapi-typescript生
 let accessToken: string | undefined = undefined;
 
 const authMiddleware: Middleware = {
-  async onRequest(req) {
+  async onRequest({ request }) {
     // 获取令牌，如果不存在
     if (!accessToken) {
       const authRes = await someAuthFunc();
@@ -137,8 +137,8 @@ const authMiddleware: Middleware = {
     // (可选) 在此添加逻辑以在令牌过期时刷新令牌
 
     // 在每个请求中添加 Authorization 标头
-    req.headers.set("Authorization", `Bearer ${accessToken}`);
-    return req;
+    request.headers.set("Authorization", `Bearer ${accessToken}`);
+    return request;
   },
 };
 
diff --git a/packages/openapi-typescript/CHANGELOG.md b/packages/openapi-typescript/CHANGELOG.md
@@ -1,5 +1,11 @@
 # openapi-typescript
 
+## 7.0.2
+
+### Patch Changes
+
+- [#1743](https://github.com/openapi-ts/openapi-typescript/pull/1743) [`8f6ec20`](https://github.com/openapi-ts/openapi-typescript/commit/8f6ec20d5d26396c1745690f0e42675776e1a691) Thanks [@avaly](https://github.com/avaly)! - Generate valid types for referenced nested properties
+
 ## 7.0.1
 
 ### Patch Changes
diff --git a/packages/openapi-typescript/bin/cli.js b/packages/openapi-typescript/bin/cli.js
@@ -78,6 +78,18 @@ const flags = parser(args, {
   },
 });
 
+/**
+ * Normalize the output path into a file URL.
+ * @param {string} output - The output path to be transformed.
+ * @returns {URL} The transformed file URL.
+ */
+function normalizeOutput(output) {
+  if (path.isAbsolute(output)) {
+    return new URL(`file://${output}}`);
+  }
+  return new URL(output, CWD);
+}
+
 /**
  * @param {string | URL} schema
  * @param {@type import('@redocly/openapi-core').Config} redocly
@@ -179,7 +191,7 @@ async function main() {
       // if stdout, (still) don’t log anything to console!
       process.stdout.write(result);
     } else {
-      const outFile = new URL(flags.output, CWD);
+      const outFile = normalizeOutput(flags.output);
       fs.mkdirSync(new URL(".", outFile), { recursive: true });
       fs.writeFileSync(outFile, result, "utf8");
       done("stdin", flags.output, performance.now() - timeStart);
@@ -202,7 +214,7 @@ async function main() {
       // if stdout, (still) don’t log anything to console!
       process.stdout.write(result);
     } else {
-      const outFile = new URL(flags.output, CWD);
+      const outFile = normalizeOutput(flags.output);
       fs.mkdirSync(new URL(".", outFile), { recursive: true });
       fs.writeFileSync(outFile, result, "utf8");
       done(input, flags.output, performance.now() - timeStart);
diff --git a/packages/openapi-typescript/package.json b/packages/openapi-typescript/package.json
@@ -1,7 +1,7 @@
 {
   "name": "openapi-typescript",
   "description": "Convert OpenAPI 3.0 & 3.1 schemas to TypeScript",
-  "version": "7.0.1",
+  "version": "7.0.2",
   "author": {
     "name": "Drew Powers",
     "email": "drew@pow.rs"
diff --git a/packages/openapi-typescript/src/lib/ts.ts b/packages/openapi-typescript/src/lib/ts.ts
@@ -122,6 +122,11 @@ export function oapiRef(path: string): ts.TypeNode {
   );
   if (pointer.length > 1) {
     for (let i = 1; i < pointer.length; i++) {
+      // Skip `properties` items when in the middle of the pointer
+      // See: https://github.com/openapi-ts/openapi-typescript/issues/1742
+      if (i > 2 && i < pointer.length - 1 && pointer[i] === "properties") {
+        continue;
+      }
       t = ts.factory.createIndexedAccessTypeNode(
         t,
         ts.factory.createLiteralTypeNode(
diff --git a/packages/openapi-typescript/src/transform/paths-object.ts b/packages/openapi-typescript/src/transform/paths-object.ts
@@ -35,6 +35,7 @@ export default function transformPathsObject(pathsObject: PathsObject, ctx: Glob
         /* type          */ oapiRef(pathItemObject.$ref),
       );
       addJSDocComment(pathItemObject, property);
+      type.push(property);
     } else {
       const pathItemType = transformPathItemObject(pathItemObject, {
         path: createRef(["paths", url]),
diff --git a/packages/openapi-typescript/test/fixtures/path-item-components.yaml b/packages/openapi-typescript/test/fixtures/path-item-components.yaml
@@ -0,0 +1,56 @@
+openapi: 3.1.0
+
+info:
+  title: Path Items
+  version: 1.0.0
+  license:
+    name: MIT
+    url: https://opensource.org/licenses/MIT
+
+servers:
+  - url: https://my-example-server
+
+paths:
+  /users:
+    $ref: '#/components/pathItems/users'
+
+security:
+  - bearerAuth: []
+
+components:
+  pathItems:
+    users:
+      post:
+        summary: Create user
+        operationId: createUser
+
+        requestBody:
+          description: The user to create
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  name:
+                    type: string
+
+        responses:
+          200:
+            description: The user was created successfully
+            content:
+              application/json:
+                schema:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                    name:
+                      type: string
+          400:
+            description: Bad request
+
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
diff --git a/packages/openapi-typescript/test/lib/ts.test.ts b/packages/openapi-typescript/test/lib/ts.test.ts
@@ -64,6 +64,16 @@ describe("oapiRef", () => {
   test("multiple parts", () => {
     expect(astToString(oapiRef("#/components/schemas/User")).trim()).toBe(`components["schemas"]["User"]`);
   });
+
+  test("removes inner `properties`", () => {
+    expect(astToString(oapiRef("#/components/schemas/User/properties/username")).trim()).toBe(
+      `components["schemas"]["User"]["username"]`,
+    );
+  });
+
+  test("leaves final `properties` intact", () => {
+    expect(astToString(oapiRef("#/components/schemas/properties")).trim()).toBe(`components["schemas"]["properties"]`);
+  });
 });
 
 describe("tsEnum", () => {
diff --git a/packages/openapi-typescript/test/transform/components-object.test.ts b/packages/openapi-typescript/test/transform/components-object.test.ts
@@ -503,6 +503,60 @@ describe("transformComponentsObject", () => {
         },
       },
     ],
+    [
+      "$ref nested properties",
+      {
+        given: {
+          parameters: {
+            direct: {
+              name: "direct",
+              in: "query",
+              required: true,
+              schema: {
+                $ref: "#/components/aaa",
+              },
+            },
+            nested: {
+              name: "nested",
+              in: "query",
+              required: true,
+              schema: {
+                $ref: "#/components/schemas/bbb/properties/ccc",
+              },
+            },
+          },
+          schemas: {
+            aaa: {
+              type: "string",
+            },
+            bbb: {
+              type: "object",
+              properties: {
+                ccc: {
+                  type: "string",
+                },
+              },
+            },
+          },
+        },
+        want: `{
+    schemas: {
+        aaa: string;
+        bbb: {
+            ccc?: string;
+        };
+    };
+    responses: never;
+    parameters: {
+        direct: components["aaa"];
+        nested: components["schemas"]["bbb"]["ccc"];
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}`,
+      },
+    ],
   ];
 
   for (const [testName, { given, want, options = DEFAULT_OPTIONS, ci }] of tests) {
diff --git a/packages/openapi-typescript/test/yaml.test.ts b/packages/openapi-typescript/test/yaml.test.ts
@@ -83,6 +83,87 @@ export interface operations {
             };
         };
     };
+}`);
+  });
+
+  test("not ignore path item components in paths", async () => {
+    const result = await execa(cmd, ["./test/fixtures/path-item-components.yaml"], {
+      cwd,
+    });
+    expect(result.stdout).toBe(`/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+    "/users": components["pathItems"]["users"];
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: never;
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: {
+        users: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            get?: never;
+            put?: never;
+            /** Create user */
+            post: operations["createUser"];
+            delete?: never;
+            options?: never;
+            head?: never;
+            patch?: never;
+            trace?: never;
+        };
+    };
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    createUser: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description The user to create */
+        requestBody?: {
+            content: {
+                "application/json": {
+                    name?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description The user was created successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        id?: string;
+                        name?: string;
+                    };
+                };
+            };
+            /** @description Bad request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
 }`);
   });
 });

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "openapi-typescript",`
`3`	`3`	`"description": "Convert OpenAPI 3.0 & 3.1 schemas to TypeScript",`
`4`		`- "version": "7.0.1",`
	`4`	`+ "version": "7.0.2",`
`5`	`5`	`"author": {`
`6`	`6`	`"name": "Drew Powers",`
`7`	`7`	`"email": "[email protected]"`