fix: allow not generating types tree with types.tree = false

hey-api · Jul 15, 2024 · 668eb81 · 668eb81
1 parent 8bd45bf
commit 668eb81
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 14 deletions.
diff --git a/.changeset/hungry-pants-care.md b/.changeset/hungry-pants-care.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: allow not generating types tree with types.tree = false
diff --git a/packages/openapi-ts/src/generate/types.ts b/packages/openapi-ts/src/generate/types.ts
@@ -29,7 +29,7 @@ export interface TypesProps {
   onRemoveNode?: VoidFunction;
 }
 
-const serviceExportedNamespace = () => '$OpenApiTs';
+const treeName = '$OpenApiTs';
 
 export const emptyModel: Model = {
   $refs: [],
@@ -489,18 +489,20 @@ const processServiceTypes = ({
     return pathKey;
   });
 
-  generateType({
-    client,
-    meta: {
-      $ref: '@hey-api/openapi-ts',
-      name: serviceExportedNamespace(),
-    },
-    onNode,
-    type: toType({
-      ...emptyModel,
-      properties,
-    }),
-  });
+  if (config.types.tree) {
+    generateType({
+      client,
+      meta: {
+        $ref: '@hey-api/openapi-ts',
+        name: treeName,
+      },
+      onNode,
+      type: toType({
+        ...emptyModel,
+        properties,
+      }),
+    });
+  }
 };
 
 export const generateTypes = async ({

diff --git a/packages/openapi-ts/src/index.ts b/packages/openapi-ts/src/index.ts
@@ -170,6 +170,7 @@ const getTypes = (userConfig: ClientConfig): Config['types'] => {
     enums: false,
     export: true,
     name: 'preserve',
+    tree: true,
   };
   if (typeof userConfig.types === 'boolean') {
     types.export = userConfig.types;

diff --git a/packages/openapi-ts/src/types/config.ts b/packages/openapi-ts/src/types/config.ts
@@ -185,6 +185,12 @@ export interface ClientConfig {
          * @default 'preserve'
          */
         name?: 'PascalCase' | 'preserve';
+        /**
+         * Generate a tree of types containing all operations? It will be named
+         * $OpenApiTs and is generated by default.
+         * @default true
+         */
+        tree?: boolean;
       };
   /**
    * Use options or arguments functions

diff --git a/packages/openapi-ts/test/index.spec.ts b/packages/openapi-ts/test/index.spec.ts
@@ -271,9 +271,21 @@ describe('OpenAPI v3', () => {
         services: false,
         types: {},
       }),
-      description: 'generate only types',
+      description: 'generate only types with default settings',
       name: 'v3_types',
     },
+    {
+      config: createConfig({
+        exportCore: false,
+        schemas: false,
+        services: false,
+        types: {
+          tree: false,
+        },
+      }),
+      description: 'generate only types without tree',
+      name: 'v3_types_no_tree',
+    },
   ];
 
   it.each(clientScenarios.concat(allScenarios))(