Merge pull request #2285 from hey-api/refactor/transformers-types

refactor(transformers): rename types

Author: mrlubos

packages/openapi-ts/src/index.ts

@@ -124,7 +124,7 @@ export {
 } 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';
+export type { ExpressionTransformer } from './plugins/@hey-api/transformers/expressions';
 export { definePluginConfig } from './plugins/shared/utils/config';
 export type { DefinePlugin, Plugin } from './plugins/types';
 export type { UserConfig } from './types/config';

…transformers/expressions-transformers.ts …ins/@hey-api/transformers/expressions.tspackages/openapi-ts/src/plugins/@hey-api/transformers/expressions-transformers.ts renamed to packages/openapi-ts/src/plugins/@hey-api/transformers/expressions.ts packages/openapi-ts/src/plugins/@hey-api/transformers/expressions-transformers.ts renamed to packages/openapi-ts/src/plugins/@hey-api/transformers/expressions.ts

@@ -5,24 +5,24 @@ import type { TypeScriptFile } from '../../../generate/files';
 import type { IR } from '../../../ir/types';
 import type { Config } from './types';
 
-export type expressionTransformer = ({
+export type ExpressionTransformer = ({
   config,
   dataExpression,
   file,
   schema,
 }: {
-  config: Config;
+  config: Omit<Config, 'name'>;
   dataExpression?: ts.Expression | string;
   file: TypeScriptFile;
   schema: IR.SchemaObject;
 }) => Array<ts.Expression> | undefined;
 
-export const bigIntExpressions: expressionTransformer = ({
+export const bigIntExpressions: ExpressionTransformer = ({
   dataExpression,
   schema,
 }) => {
   if (schema.type !== 'integer' || schema.format !== 'int64') {
-    return undefined;
+    return;
   }
 
   const bigIntCallExpression =
@@ -55,18 +55,18 @@ export const bigIntExpressions: expressionTransformer = ({
     }
   }
 
-  return [];
+  return;
 };
 
-export const dateExpressions: expressionTransformer = ({
+export const dateExpressions: ExpressionTransformer = ({
   dataExpression,
   schema,
 }) => {
   if (
     schema.type !== 'string' ||
     !(schema.format === 'date' || schema.format === 'date-time')
   ) {
-    return undefined;
+    return;
   }
 
   const identifierDate = compiler.identifier({ text: 'Date' });
@@ -92,5 +92,5 @@ export const dateExpressions: expressionTransformer = ({
     ];
   }
 
-  return [];
+  return;
 };

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

@@ -1,4 +1,3 @@
 export { compiler } from '../../../compiler';
 export { defaultConfig, defineConfig } from './config';
-export { type expressionTransformer } from './expressions-transformers';
 export type { HeyApiTransformersPlugin } from './types';

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

@@ -10,7 +10,7 @@ import { irRef } from '../../../utils/ref';
 import { stringCase } from '../../../utils/stringCase';
 import { operationIrRef } from '../../shared/utils/ref';
 import { typesId } from '../typescript/ref';
-import { bigIntExpressions, dateExpressions } from './expressions-transformers';
+import { bigIntExpressions, dateExpressions } from './expressions';
 import type { HeyApiTransformersPlugin } from './types';
 
 interface OperationIRRef {

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

@@ -1,4 +1,5 @@
 import type { DefinePlugin, Plugin } from '../../types';
+import type { ExpressionTransformer } from './expressions';
 
 export type Config = Plugin.Name<'@hey-api/transformers'> & {
   /**
@@ -26,13 +27,10 @@ export type Config = Plugin.Name<'@hey-api/transformers'> & {
    * @default 'transformers'
    */
   output?: string;
-
   /**
-   * transformers to apply to the generated code
-   * @default []
+   * Custom transforms to apply to the generated code.
    */
-
-  transformers?: expressionTransformer[];
+  transformers?: ReadonlyArray<ExpressionTransformer>;
 };
 
 export type HeyApiTransformersPlugin = DefinePlugin<Config>;