feat: add namespace supporting for enums

Author: LeeChSien

.changeset/bright-poets-confess.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': minor
+---
+
+feat: add namespace supporting for enums

packages/openapi-ts/src/compiler/index.ts

@@ -179,6 +179,7 @@ export const compiler = {
     array: types.createArrayType,
     enum: types.createEnumDeclaration,
     function: types.createFunction,
+    namespace: types.createNamespaceDeclaration,
     object: types.createObjectType,
   },
   utils: {

packages/openapi-ts/src/compiler/types.ts

@@ -355,3 +355,25 @@ export const createEnumDeclaration = <T extends object>({
   }
   return declaration;
 };
+
+/**
+ * Create namespace declaration. Example `export namespace MyNamespace { ... }`
+ * @param name - the name of the namespace.
+ * @param nodes - the nodes in the namespace.
+ * @returns
+ */
+export const createNamespaceDeclaration = <
+  T extends Array<ts.EnumDeclaration>,
+>({
+  name,
+  statements,
+}: {
+  name: string;
+  statements: T;
+}) =>
+  ts.factory.createModuleDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    ts.factory.createIdentifier(name),
+    ts.factory.createModuleBlock(statements),
+    ts.NodeFlags.Namespace,
+  );

packages/openapi-ts/src/generate/types.ts

@@ -1,3 +1,5 @@
+import { EnumDeclaration } from 'typescript';
+
 import {
   type Comments,
   compiler,
@@ -121,10 +123,34 @@ export const generateType = ({
 };
 
 const processComposition = (props: TypesProps) => {
-  processType(props);
-  props.model.enums.forEach((enumerator) =>
-    processEnum({ ...props, model: enumerator }),
-  );
+  const config = getConfig();
+
+  if (config.types.enums !== 'typescript+namespace') {
+    processType(props);
+    props.model.enums.forEach((enumerator) =>
+      processEnum({ ...props, model: enumerator }),
+    );
+  } else {
+    const enumDeclarations = [] as EnumDeclaration[];
+    props.model.enums.forEach((enumerator) =>
+      processScopedEnum({
+        ...props,
+        model: enumerator,
+        onNode: (node) => {
+          enumDeclarations.push(node as EnumDeclaration);
+        },
+      }),
+    );
+    processType(props);
+    if (enumDeclarations.length > 0) {
+      props.onNode(
+        compiler.types.namespace({
+          name: props.model.name,
+          statements: enumDeclarations,
+        }),
+      );
+    }
+  }
 };
 
 const processEnum = ({ client, model, onNode }: TypesProps) => {
@@ -146,7 +172,10 @@ const processEnum = ({ client, model, onNode }: TypesProps) => {
     model.deprecated && '@deprecated',
   ];
 
-  if (config.types.enums === 'typescript') {
+  if (
+    config.types.enums === 'typescript' ||
+    config.types.enums === 'typescript+namespace'
+  ) {
     generateEnum({
       client,
       comments,
@@ -185,6 +214,30 @@ const processEnum = ({ client, model, onNode }: TypesProps) => {
   });
 };
 
+const processScopedEnum = ({ model, onNode }: TypesProps) => {
+  const properties: Record<string | number, unknown> = {};
+  const comments: Record<string | number, Comments> = {};
+  model.enum.forEach((enumerator) => {
+    const { key, value } = enumEntry(enumerator);
+    properties[key] = value;
+    const comment = enumerator.customDescription || enumerator.description;
+    if (comment) {
+      comments[key] = [escapeComment(comment)];
+    }
+  });
+  onNode(
+    compiler.types.enum({
+      comments,
+      leadingComment: [
+        model.description && escapeComment(model.description),
+        model.deprecated && '@deprecated',
+      ],
+      name: model.meta?.name || model.name,
+      obj: properties,
+    }),
+  );
+};
+
 const processType = ({ client, model, onNode }: TypesProps) => {
   generateType({
     client,

packages/openapi-ts/src/types/config.ts

@@ -198,7 +198,7 @@ export interface ClientConfig {
          * Generate enum definitions?
          * @default false
          */
-        enums?: 'javascript' | 'typescript' | false;
+        enums?: 'javascript' | 'typescript' | 'typescript+namespace' | false;
         /**
          * Generate types?
          * @default true

packages/openapi-ts/test/index.spec.ts

@@ -234,6 +234,19 @@ describe('OpenAPI v3', () => {
       description: 'generate TypeScript enums',
       name: 'v3_enums_typescript',
     },
+    {
+      config: createConfig({
+        schemas: false,
+        services: {
+          asClass: true,
+        },
+        types: {
+          enums: 'typescript+namespace',
+        },
+      }),
+      description: 'generate TypeScript enums',
+      name: 'v3_enums_typescript_namespace',
+    },
     {
       config: createConfig({
         exportCore: false,