Merge pull request #1906 from hey-api/feat/exclude-deprecated

mrlubos · web-flow · commit cb70338dee7b · 2025-04-02T12:31:04.000+01:00
fix: support excluding deprecated fields
diff --git a/.changeset/spotty-garlics-burn.md b/.changeset/spotty-garlics-burn.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: exclude and include expressions can be an array
diff --git a/.changeset/wicked-zoos-beam.md b/.changeset/wicked-zoos-beam.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: support excluding deprecated fields with '@deprecated'
diff --git a/packages/openapi-ts-tests/test/2.0.x.test.ts b/packages/openapi-ts-tests/test/2.0.x.test.ts
@@ -15,23 +15,34 @@ const version = '2.0.x';
 const outputDir = path.join(__dirname, 'generated', version);
 
 describe(`OpenAPI ${version}`, () => {
-  const createConfig = (userConfig: UserConfig): UserConfig => ({
-    plugins: ['@hey-api/typescript'],
-    ...userConfig,
-    input: path.join(
+  const createConfig = (userConfig: UserConfig): UserConfig => {
+    const inputPath = path.join(
       __dirname,
       'spec',
       version,
-      typeof userConfig.input === 'string' ? userConfig.input : '',
-    ),
-    logs: {
-      level: 'silent',
-    },
-    output: path.join(
-      outputDir,
-      typeof userConfig.output === 'string' ? userConfig.output : '',
-    ),
-  });
+      typeof userConfig.input === 'string'
+        ? userConfig.input
+        : (userConfig.input.path as string),
+    );
+    return {
+      plugins: ['@hey-api/typescript'],
+      ...userConfig,
+      input:
+        typeof userConfig.input === 'string'
+          ? inputPath
+          : {
+              ...userConfig.input,
+              path: inputPath,
+            },
+      logs: {
+        level: 'silent',
+      },
+      output: path.join(
+        outputDir,
+        typeof userConfig.output === 'string' ? userConfig.output : '',
+      ),
+    };
+  };
 
   const scenarios = [
     {
@@ -203,6 +214,16 @@ describe(`OpenAPI ${version}`, () => {
       description:
         'handles various enum names and values (TypeScript, preserve)',
     },
+    {
+      config: createConfig({
+        input: {
+          exclude: ['@deprecated'],
+          path: 'exclude-deprecated.yaml',
+        },
+        output: 'exclude-deprecated',
+      }),
+      description: 'excludes deprecated fields',
+    },
     {
       config: createConfig({
         input: 'form-data.json',
diff --git a/packages/openapi-ts-tests/test/3.0.x.test.ts b/packages/openapi-ts-tests/test/3.0.x.test.ts
@@ -15,23 +15,34 @@ const version = '3.0.x';
 const outputDir = path.join(__dirname, 'generated', version);
 
 describe(`OpenAPI ${version}`, () => {
-  const createConfig = (userConfig: UserConfig): UserConfig => ({
-    plugins: ['@hey-api/typescript'],
-    ...userConfig,
-    input: path.join(
+  const createConfig = (userConfig: UserConfig): UserConfig => {
+    const inputPath = path.join(
       __dirname,
       'spec',
       version,
-      typeof userConfig.input === 'string' ? userConfig.input : '',
-    ),
-    logs: {
-      level: 'silent',
-    },
-    output: path.join(
-      outputDir,
-      typeof userConfig.output === 'string' ? userConfig.output : '',
-    ),
-  });
+      typeof userConfig.input === 'string'
+        ? userConfig.input
+        : (userConfig.input.path as string),
+    );
+    return {
+      plugins: ['@hey-api/typescript'],
+      ...userConfig,
+      input:
+        typeof userConfig.input === 'string'
+          ? inputPath
+          : {
+              ...userConfig.input,
+              path: inputPath,
+            },
+      logs: {
+        level: 'silent',
+      },
+      output: path.join(
+        outputDir,
+        typeof userConfig.output === 'string' ? userConfig.output : '',
+      ),
+    };
+  };
 
   const scenarios = [
     {
@@ -388,6 +399,16 @@ describe(`OpenAPI ${version}`, () => {
       }),
       description: 'handles null enums',
     },
+    {
+      config: createConfig({
+        input: {
+          exclude: ['@deprecated'],
+          path: 'exclude-deprecated.yaml',
+        },
+        output: 'exclude-deprecated',
+      }),
+      description: 'excludes deprecated fields',
+    },
     {
       config: createConfig({
         input: 'internal-name-conflict.json',
diff --git a/packages/openapi-ts-tests/test/3.1.x.test.ts b/packages/openapi-ts-tests/test/3.1.x.test.ts
@@ -15,23 +15,34 @@ const version = '3.1.x';
 const outputDir = path.join(__dirname, 'generated', version);
 
 describe(`OpenAPI ${version}`, () => {
-  const createConfig = (userConfig: UserConfig): UserConfig => ({
-    plugins: ['@hey-api/typescript'],
-    ...userConfig,
-    input: path.join(
+  const createConfig = (userConfig: UserConfig): UserConfig => {
+    const inputPath = path.join(
       __dirname,
       'spec',
       version,
-      typeof userConfig.input === 'string' ? userConfig.input : '',
-    ),
-    logs: {
-      level: 'silent',
-    },
-    output: path.join(
-      outputDir,
-      typeof userConfig.output === 'string' ? userConfig.output : '',
-    ),
-  });
+      typeof userConfig.input === 'string'
+        ? userConfig.input
+        : (userConfig.input.path as string),
+    );
+    return {
+      plugins: ['@hey-api/typescript'],
+      ...userConfig,
+      input:
+        typeof userConfig.input === 'string'
+          ? inputPath
+          : {
+              ...userConfig.input,
+              path: inputPath,
+            },
+      logs: {
+        level: 'silent',
+      },
+      output: path.join(
+        outputDir,
+        typeof userConfig.output === 'string' ? userConfig.output : '',
+      ),
+    };
+  };
 
   const scenarios = [
     {
@@ -402,6 +413,16 @@ describe(`OpenAPI ${version}`, () => {
       }),
       description: 'handles null enums',
     },
+    {
+      config: createConfig({
+        input: {
+          exclude: ['@deprecated'],
+          path: 'exclude-deprecated.yaml',
+        },
+        output: 'exclude-deprecated',
+      }),
+      description: 'excludes deprecated fields',
+    },
     {
       config: createConfig({
         input: 'internal-name-conflict.json',
diff --git a/packages/openapi-ts-tests/test/__snapshots__/2.0.x/exclude-deprecated/index.ts b/packages/openapi-ts-tests/test/__snapshots__/2.0.x/exclude-deprecated/index.ts
@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';
diff --git a/packages/openapi-ts-tests/test/__snapshots__/2.0.x/exclude-deprecated/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/2.0.x/exclude-deprecated/types.gen.ts
@@ -0,0 +1,21 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type Foo = string;
+
+export type PostFooData = {
+    body: Foo;
+    path?: never;
+    query?: never;
+    url: '/foo';
+};
+
+export type PostFooResponses = {
+    /**
+     * OK
+     */
+    200: unknown;
+};
+
+export type ClientOptions = {
+    baseUrl: string;
+};
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.0.x/exclude-deprecated/index.ts b/packages/openapi-ts-tests/test/__snapshots__/3.0.x/exclude-deprecated/index.ts
@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.0.x/exclude-deprecated/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/3.0.x/exclude-deprecated/types.gen.ts
@@ -0,0 +1,21 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type Foo = string;
+
+export type PostFooData = {
+    body: Foo;
+    path?: never;
+    query?: never;
+    url: '/foo';
+};
+
+export type PostFooResponses = {
+    /**
+     * OK
+     */
+    200: unknown;
+};
+
+export type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.1.x/exclude-deprecated/index.ts b/packages/openapi-ts-tests/test/__snapshots__/3.1.x/exclude-deprecated/index.ts
@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.1.x/exclude-deprecated/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/3.1.x/exclude-deprecated/types.gen.ts
@@ -0,0 +1,21 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type Foo = string;
+
+export type PostFooData = {
+    body: Foo;
+    path?: never;
+    query?: never;
+    url: '/foo';
+};
+
+export type PostFooResponses = {
+    /**
+     * OK
+     */
+    200: unknown;
+};
+
+export type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};
diff --git a/packages/openapi-ts-tests/test/openapi-ts.config.ts b/packages/openapi-ts-tests/test/openapi-ts.config.ts
@@ -16,7 +16,10 @@ export default defineConfig(() => {
     // experimentalParser: false,
     input: {
       // branch: 'main',
-      // exclude: '^#/components/schemas/ModelWithCircularReference$',
+      // exclude: [
+      //   '^#/components/schemas/ModelWithCircularReference$',
+      //   '@deprecated',
+      // ],
       // fetch: {
       //   headers: {
       //     'x-foo': 'bar',
@@ -33,7 +36,7 @@ export default defineConfig(() => {
       //   openapi: '3.1.0',
       //   paths: {},
       // },
-      path: path.resolve(__dirname, 'spec', '3.1.x', 'validators.json'),
+      path: path.resolve(__dirname, 'spec', '3.1.x', 'full.json'),
       // path: path.resolve(__dirname, 'spec', '3.1.x', 'read-write-only.yaml'),
       // path: 'http://localhost:4000/',
       // path: 'https://get.heyapi.dev/',
diff --git a/packages/openapi-ts-tests/test/spec/2.0.x/exclude-deprecated.yaml b/packages/openapi-ts-tests/test/spec/2.0.x/exclude-deprecated.yaml
@@ -0,0 +1,38 @@
+swagger: '2.0'
+info:
+  title: OpenAPI 2.0 exclude deprecated example
+  version: '1'
+produces:
+  - application/json
+consumes:
+  - application/json
+paths:
+  /foo:
+    post:
+      parameters:
+        - name: body
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/Foo'
+      responses:
+        '200':
+          description: OK
+  /bar:
+    post:
+      deprecated: true
+      parameters:
+        - name: body
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/Bar'
+      responses:
+        '200':
+          description: OK
+definitions:
+  Foo:
+    type: string
+  Bar:
+    deprecated: true
+    type: string
diff --git a/packages/openapi-ts-tests/test/spec/3.0.x/exclude-deprecated.yaml b/packages/openapi-ts-tests/test/spec/3.0.x/exclude-deprecated.yaml
@@ -0,0 +1,35 @@
+openapi: 3.0.4
+info:
+  title: OpenAPI 3.0.4 exclude deprecated example
+  version: 1
+paths:
+  /foo:
+    post:
+      requestBody:
+        content:
+          'application/json':
+            schema:
+              $ref: '#/components/schemas/Foo'
+        required: true
+      responses:
+        '200':
+          description: OK
+  /bar:
+    post:
+      deprecated: true
+      requestBody:
+        content:
+          'application/json':
+            schema:
+              $ref: '#/components/schemas/Bar'
+        required: true
+      responses:
+        '200':
+          description: OK
+components:
+  schemas:
+    Foo:
+      type: string
+    Bar:
+      deprecated: true
+      type: string
diff --git a/packages/openapi-ts-tests/test/spec/3.1.x/exclude-deprecated.yaml b/packages/openapi-ts-tests/test/spec/3.1.x/exclude-deprecated.yaml
diff --git a/packages/openapi-ts/src/openApi/2.0.x/parser/index.ts b/packages/openapi-ts/src/openApi/2.0.x/parser/index.ts
diff --git a/packages/openapi-ts/src/openApi/3.0.x/parser/index.ts b/packages/openapi-ts/src/openApi/3.0.x/parser/index.ts
diff --git a/packages/openapi-ts/src/openApi/3.1.x/parser/index.ts b/packages/openapi-ts/src/openApi/3.1.x/parser/index.ts
diff --git a/packages/openapi-ts/src/openApi/shared/utils/filter.ts b/packages/openapi-ts/src/openApi/shared/utils/filter.ts
diff --git a/packages/openapi-ts/src/types/config.d.ts b/packages/openapi-ts/src/types/config.d.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@hey-api/openapi-ts': patch
 +---
++
 +fix: exclude and include expressions can be an array
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+// This file is auto-generated by @hey-api/openapi-ts`
	`2`	`+export * from './types.gen';`