Merge pull request #3530 from hey-api/refactor/plugin-typescript

refactor: typescript plugin

Author: mrlubos

dev/typescript/presets.ts

@@ -10,10 +10,6 @@ export const presets = {
     zod({ metadata: true }),
     tanstackReactQuery({ queryKeys: { tags: true } }),
   ],
-  minimal: () => [
-    /** Just types, nothing else */
-    typescript(),
-  ],
   sdk: () => [
     /** SDK with types */
     typescript(),
@@ -31,6 +27,10 @@ export const presets = {
     sdk(),
     tanstackReactQuery({ queryKeys: { tags: true } }),
   ],
+  types: () => [
+    /** Just types, nothing else */
+    typescript(),
+  ],
   validated: () => [
     /** SDK + Zod validation */
     typescript(),

packages/openapi-python/src/plugins/pydantic/shared/meta.ts

@@ -17,8 +17,6 @@ export function defaultMeta(schema: IR.SchemaObject): PydanticMeta {
 /**
  * Composes metadata from child results.
  *
- * Automatically propagates hasForwardReference, nullable, readonly from children.
- *
  * @param children - Results from walking child schemas
  * @param overrides - Explicit overrides (e.g., from parent schema)
  */

packages/openapi-python/src/plugins/pydantic/shared/processor.ts

@@ -1,17 +1,17 @@
-import type {
-  IR,
-  NamingConfig,
-  SchemaProcessorContext,
-  SchemaProcessorResult,
-} from '@hey-api/shared';
+import type { IR, NamingConfig, SchemaProcessorContext } from '@hey-api/shared';
 
 import type { PydanticPlugin } from '../types';
+import type { PydanticFinal } from './types';
 
 export type ProcessorContext = SchemaProcessorContext & {
+  /** Whether to export the result (default: true) */
+  export?: boolean;
   naming: NamingConfig;
   /** The plugin instance. */
   plugin: PydanticPlugin['Instance'];
   schema: IR.SchemaObject;
 };
 
-export type ProcessorResult = SchemaProcessorResult<ProcessorContext>;
+export type ProcessorResult = {
+  process: (ctx: ProcessorContext) => PydanticFinal | void;
+};

packages/openapi-python/src/plugins/pydantic/v2/processor.ts

@@ -42,10 +42,12 @@ export function createProcessor(plugin: PydanticPlugin['Instance']): ProcessorRe
     return ctx.schema;
   }
 
-  function process(ctx: ProcessorContext): void {
+  function process(ctx: ProcessorContext): PydanticFinal | void {
     if (!processor.markEmitted(ctx.path)) return;
 
-    processor.withContext({ anchor: ctx.namingAnchor, tags: ctx.tags }, () => {
+    const shouldExport = ctx.export !== false;
+
+    return processor.withContext({ anchor: ctx.namingAnchor, tags: ctx.tags }, () => {
       const visitor = createVisitor({ schemaExtractor: extractor });
       const walk = createSchemaWalker(visitor);
 
@@ -59,7 +61,12 @@ export function createProcessor(plugin: PydanticPlugin['Instance']): ProcessorRe
         plugin,
       }) as PydanticFinal;
 
-      exportAst({ ...ctx, final, plugin });
+      if (shouldExport) {
+        exportAst({ ...ctx, final, plugin });
+        return;
+      }
+
+      return final;
     });
   }
 

packages/openapi-ts/src/plugins/@hey-api/sdk/shared/operation.ts

@@ -1,5 +1,4 @@
 import type { SymbolMeta } from '@hey-api/codegen-core';
-import { refs } from '@hey-api/codegen-core';
 import type { IR } from '@hey-api/shared';
 import { statusCodeToGroup } from '@hey-api/shared';
 
@@ -108,15 +107,9 @@ export function operationParameters({
           isParametersRequired = true;
         }
         flatParams.prop(parameter.name, (p) =>
-          p.required(parameter.isRequired).type(
-            pluginTypeScript.api.schemaToType({
-              plugin: pluginTypeScript,
-              schema: parameter.schema,
-              state: refs({
-                path: [],
-              }),
-            }),
-          ),
+          p
+            .required(parameter.isRequired)
+            .type(pluginTypeScript.api.schemaToType(pluginTypeScript, parameter.schema)),
         );
       }
 

packages/openapi-ts/src/plugins/@hey-api/typescript/api.ts

@@ -1,12 +1,38 @@
-import type { MaybeTsDsl, TypeTsDsl } from '../../../ts-dsl';
-import { irSchemaToAstV1 } from './v1/api';
+import type { IR } from '@hey-api/shared';
+
+import { $ } from '../../../ts-dsl';
+import type { TypeScriptResult } from './shared/types';
+import type { HeyApiTypeScriptPlugin } from './types';
+import { createProcessor } from './v1/processor';
 
 export type IApi = {
-  schemaToType: (args: Parameters<typeof irSchemaToAstV1>[0]) => MaybeTsDsl<TypeTsDsl>;
+  schemaToType: (
+    plugin: HeyApiTypeScriptPlugin['Instance'],
+    schema: IR.SchemaObject,
+  ) => TypeScriptResult['type'];
 };
 
 export class Api implements IApi {
-  schemaToType(args: Parameters<typeof irSchemaToAstV1>[0]): MaybeTsDsl<TypeTsDsl> {
-    return irSchemaToAstV1(args);
+  schemaToType(
+    plugin: HeyApiTypeScriptPlugin['Instance'],
+    schema: IR.SchemaObject,
+  ): TypeScriptResult['type'] {
+    const processor = createProcessor(plugin);
+    const result = processor.process({
+      export: false,
+      meta: {
+        resource: 'definition',
+        resourceId: '',
+      },
+      naming: plugin.config.definitions,
+      path: [],
+      plugin,
+      schema,
+    });
+
+    if (!result) {
+      return $.type(plugin.config.topType);
+    }
+    return result.type;
   }
 }