feat: export operations interface

Author: gr2m

src/types/OpenAPI3.ts

@@ -15,6 +15,7 @@ export interface OpenAPI3Paths {
 }
 
 export interface OpenAPI3Operation {
+  operationId?: string;
   description?: string;
   parameters?: Parameter[];
   requestBody?: OpenAPI3RequestBody;
@@ -57,6 +58,9 @@ export interface OpenAPI3 {
   openapi: string;
   paths?: OpenAPI3Paths; // technically required by spec, but this library tries to be lenient
   components?: OpenAPI3Components;
+  operations?: {
+    [key: string]: OpenAPI3Operation;
+  };
   [key: string]: any; // handle other properties beyond this library’s concern
 }
 

src/v3.ts

@@ -50,6 +50,8 @@ export default function generateTypesV3(
     }
   }
 
+  const operations: Record<string, OpenAPI3Operation> = {};
+
   // propertyMapper
   const propertyMapped = options
     ? propertyMapper(components.schemas, options.propertyMapper)
@@ -211,13 +213,9 @@ export default function generateTypesV3(
     return output;
   }
 
-  function transformOperation(
-    method: string,
-    operation: OpenAPI3Operation
-  ): string {
+  function transformOperation(operation: OpenAPI3Operation): string {
     let output = "";
-    if (operation.description) output += comment(operation.description);
-    output += `"${method}": {\n`;
+    output += `{\n`;
 
     // handle operation parameters
     if (operation.parameters) {
@@ -269,7 +267,17 @@ export default function generateTypesV3(
       Object.entries(methods).forEach(([method, operation]) => {
         // skip the parameters "method" for shared parameters - we'll handle it later
         if (method !== "parameters") {
-          output += transformOperation(method, operation as OpenAPI3Operation);
+          operation = operation as OpenAPI3Operation;
+
+          if (operation.operationId) {
+            output += `"${method}": operations["${operation.operationId}"];\n`;
+            operations[operation.operationId] = operation;
+          } else {
+            if (operation.description) output += comment(operation.description);
+            output += `"${method}": ${transformOperation(
+              operation as OpenAPI3Operation
+            )}`;
+          }
         }
       });
 
@@ -300,6 +308,16 @@ export default function generateTypesV3(
 `;
   }
 
+  finalOutput += "export interface operations {\n";
+  for (const [operationId, operation] of Object.entries(operations)) {
+    if (operation.description) finalOutput += comment(operation.description);
+    finalOutput += `"${operationId}": ${transformOperation(
+      operation as OpenAPI3Operation
+    )}`;
+  }
+  // close operations wrapper
+  finalOutput += "\n}\n\n";
+
   finalOutput += "export interface components {\n";
 
   if (components.parameters && Object.keys(components.parameters).length) {