Merge pull request #3617 from hey-api/fix/transformers-plugin-arg-2

fix: pass plugin to type transformer

Author: mrlubos

.changeset/dark-areas-give.md

@@ -3,4 +3,4 @@
 "@hey-api/shared": patch
 ---
 
-**output**: pass context as second argument in `resolveModuleName()` function
+**output**: pass context as second argument in `module.resolve()` function

.changeset/two-cameras-check.md

@@ -2,4 +2,4 @@
 "@hey-api/openapi-ts": patch
 ---
 
-**plugin(@hey-api/transformers)**: expose plugin in context
+**plugin(@hey-api/transformers)**: expose plugin in transformer function context

packages/openapi-ts/src/index.ts

@@ -169,8 +169,7 @@ export type { UserConfig } from './config/types';
 export { clientDefaultConfig, clientDefaultMeta } from './plugins/@hey-api/client-core/config';
 export { clientPluginHandler } from './plugins/@hey-api/client-core/plugin';
 export type { Client } from './plugins/@hey-api/client-core/types';
-export type { ExpressionTransformer } from './plugins/@hey-api/transformers/expressions';
-export type { TypeTransformer } from './plugins/@hey-api/transformers/types';
+export type { ExpressionTransformer, TypeTransformer } from './plugins/@hey-api/transformers/types';
 export * from './ts-dsl';
 export { Logger } from '@hey-api/codegen-core';
 export type {

packages/openapi-ts/src/plugins/@hey-api/transformers/expressions.ts

@@ -1,16 +1,5 @@
-import type { IR } from '@hey-api/shared';
-import type ts from 'typescript';
-
 import { $ } from '../../../ts-dsl';
-import type { HeyApiTransformersPlugin, UserConfig } from './types';
-
-export type ExpressionTransformer = (ctx: {
-  /** @deprecated Use `plugin` instead and access the config via `plugin.config` */
-  config: Omit<UserConfig, 'name'>;
-  dataExpression?: ts.Expression | ReturnType<typeof $.attr | typeof $.expr> | string;
-  plugin: HeyApiTransformersPlugin['Instance'];
-  schema: IR.SchemaObject;
-}) => Array<ReturnType<typeof $.fromValue>> | undefined;
+import type { ExpressionTransformer } from './types';
 
 export const bigIntExpressions: ExpressionTransformer = ({ dataExpression, schema }) => {
   if (schema.type !== 'integer' || schema.format !== 'int64') {

packages/openapi-ts/src/plugins/@hey-api/transformers/types.ts

@@ -2,13 +2,26 @@ import type { IR } from '@hey-api/shared';
 import type { DefinePlugin, Plugin } from '@hey-api/shared';
 import type ts from 'typescript';
 
-import type { ExpressionTransformer } from './expressions';
+import type { $, MaybeTsDsl, TsDsl } from '../../../ts-dsl';
+
+interface BaseTransformer {
+  plugin: HeyApiTransformersPlugin['Instance'];
+  schema: IR.SchemaObject;
+}
+
+export type ExpressionTransformer = (
+  ctx: BaseTransformer & {
+    /** @deprecated Use `plugin` instead and access the config via `plugin.config` */
+    config: Omit<UserConfig, 'name'>;
+    dataExpression?: ts.Expression | ReturnType<typeof $.attr | typeof $.expr> | string;
+  },
+) => Array<TsDsl<ts.Expression>> | undefined;
 
 /**
  * Returns the TypeScript type node for a schema with a specific format.
  * If undefined is returned, the default type will be used.
  */
-export type TypeTransformer = ({ schema }: { schema: IR.SchemaObject }) => ts.TypeNode | undefined;
+export type TypeTransformer = (ctx: BaseTransformer) => MaybeTsDsl<ts.TypeNode> | undefined;
 
 export type UserConfig = Plugin.Name<'@hey-api/transformers'> &
   Plugin.Hooks &

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

@@ -94,7 +94,7 @@ export function createVisitor(
       const transformersPlugin = ctx.plugin.getPlugin('@hey-api/transformers');
       if (transformersPlugin?.config.typeTransformers) {
         for (const typeTransformer of transformersPlugin.config.typeTransformers) {
-          const typeNode = typeTransformer({ schema });
+          const typeNode = typeTransformer({ plugin: transformersPlugin, schema });
           if (typeNode) {
             return { meta: defaultMeta(schema), type: typeNode };
           }