fix: handle async response transformers

hey-api · Jul 1, 2024 · 8410046 · 8410046
1 parent 0a31408
commit 8410046
Show file tree

Hide file tree

Showing 52 changed files with 109 additions and 92 deletions.
diff --git a/.changeset/two-cooks-kiss.md b/.changeset/two-cooks-kiss.md
@@ -0,0 +1,6 @@
+---
+'@hey-api/client-fetch': patch
+'@hey-api/openapi-ts': patch
+---
+
+fix: handle async response transformers
diff --git a/packages/client-axios/src/index.ts b/packages/client-axios/src/index.ts
@@ -226,7 +226,7 @@ export const request = <T>(
 
         let transformedBody = responseBody;
         if (options.responseTransformer && isSuccess(response.status)) {
-          transformedBody = options.responseTransformer(responseBody);
+          transformedBody = await options.responseTransformer(responseBody);
         }
 
         const result: ApiResult = {

diff --git a/packages/client-core/src/types.ts b/packages/client-core/src/types.ts
@@ -26,7 +26,7 @@ export type ApiRequestOptions<T = unknown> = {
   readonly path?: Record<string, unknown>;
   readonly query?: Record<string, unknown>;
   readonly responseHeader?: string;
-  readonly responseTransformer?: (data: unknown) => T;
+  readonly responseTransformer?: (data: unknown) => Promise<T>;
   readonly url: string;
 };
 

diff --git a/packages/client-fetch/src/index.ts b/packages/client-fetch/src/index.ts
@@ -122,7 +122,7 @@ export const createClient = (config: Config): Client => {
 
       let data = await response[parseAs]();
       if (parseAs === 'json' && options.responseTransformer) {
-        data = options.responseTransformer(data);
+        data = await options.responseTransformer(data);
       }
 
       return {

diff --git a/packages/client-fetch/src/types.ts b/packages/client-fetch/src/types.ts
@@ -90,8 +90,12 @@ export interface Config
    * {@link https://swagger.io/docs/specification/serialization/#query View examples}
    */
   querySerializer?: QuerySerializer | QuerySerializerOptions;
-
-  responseTransformer?: (data: unknown) => unknown;
+  /**
+   * A function for transforming response data before it's returned to the
+   * caller function. This is an ideal place to post-process server data,
+   * e.g. convert date ISO strings into native Date objects.
+   */
+  responseTransformer?: (data: unknown) => Promise<unknown>;
 }
 
 interface RequestOptionsBase extends Omit<Config, 'global'> {

diff --git a/packages/openapi-ts/src/compiler/types.ts b/packages/openapi-ts/src/compiler/types.ts
@@ -108,20 +108,22 @@ export const toParameterDeclarations = (parameters: FunctionParameter[]) =>
  * Create Function type expression.
  */
 export const createFunction = ({
+  async,
   comment,
   multiLine,
   parameters = [],
   returnType,
   statements = [],
 }: {
+  async?: boolean;
   comment?: Comments;
   multiLine?: boolean;
   parameters?: FunctionParameter[];
   returnType?: string | ts.TypeNode;
   statements?: ts.Statement[];
 }) => {
   const expression = ts.factory.createArrowFunction(
-    undefined,
+    async ? [ts.factory.createModifier(ts.SyntaxKind.AsyncKeyword)] : undefined,
     undefined,
     toParameterDeclarations(parameters),
     returnType ? createTypeNode(returnType) : undefined,

diff --git a/packages/openapi-ts/src/templates/core/ApiRequestOptions.hbs b/packages/openapi-ts/src/templates/core/ApiRequestOptions.hbs
@@ -9,6 +9,6 @@ export type ApiRequestOptions<T = unknown> = {
 	readonly body?: any;
 	readonly mediaType?: string;
 	readonly responseHeader?: string;
-	readonly responseTransformer?: (data: unknown) => T;
+	readonly responseTransformer?: (data: unknown) => Promise<T>;
 	readonly errors?: Record<number | string, string>;
 };
diff --git a/packages/openapi-ts/src/templates/core/angular/request.hbs b/packages/openapi-ts/src/templates/core/angular/request.hbs
@@ -80,7 +80,7 @@ export const request = <T>(config: OpenAPIConfig, http: HttpClient, options: Api
 
 			let transformedBody = responseBody;
 			if (options.responseTransformer && response.ok) {
-				transformedBody = options.responseTransformer(responseBody)
+				transformedBody = await options.responseTransformer(responseBody)
 			}
 
 			return {

diff --git a/packages/openapi-ts/src/templates/core/axios/request.hbs b/packages/openapi-ts/src/templates/core/axios/request.hbs
@@ -84,7 +84,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions<T>,
 
 				let transformedBody = responseBody;
 				if (options.responseTransformer && isSuccess(response.status)) {
-					transformedBody = options.responseTransformer(responseBody)
+					transformedBody = await options.responseTransformer(responseBody)
 				}
 
 				const result: ApiResult = {

diff --git a/packages/openapi-ts/src/templates/core/fetch/request.hbs b/packages/openapi-ts/src/templates/core/fetch/request.hbs
@@ -82,7 +82,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions<T>)
 
 				let transformedBody = responseBody;
 				if (options.responseTransformer && response.ok) {
-					transformedBody = options.responseTransformer(responseBody)
+					transformedBody = await options.responseTransformer(responseBody)
 				}
 
 				const result: ApiResult = {

diff --git a/packages/openapi-ts/src/templates/core/xhr/request.hbs b/packages/openapi-ts/src/templates/core/xhr/request.hbs
@@ -80,7 +80,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions<T>)
 
 				let transformedBody = responseBody;
 				if (options.responseTransformer && isSuccess(response.status)) {
-					transformedBody = options.responseTransformer(responseBody)
+					transformedBody = await options.responseTransformer(responseBody)
 				}
 
 				const result: ApiResult = {

diff --git a/packages/openapi-ts/src/utils/write/transformers.ts b/packages/openapi-ts/src/utils/write/transformers.ts
@@ -66,6 +66,7 @@ const ensureModelResponseTransformerExists = (
       });
       generateResponseTransformer({
         ...props,
+        async: false,
         name,
         statements,
       });
@@ -179,12 +180,14 @@ const processModel = (props: ModelProps): ts.Statement[] => {
 };
 
 const generateResponseTransformer = ({
+  async,
   client,
   name,
   onNode,
   onRemoveNode,
   statements,
 }: Pick<TypesProps, 'client' | 'onNode' | 'onRemoveNode'> & {
+  async: boolean;
   name: string;
   statements: Array<ts.Statement>;
 }) => {
@@ -205,6 +208,7 @@ const generateResponseTransformer = ({
   }
 
   const expression = compiler.types.function({
+    async,
     multiLine: true,
     parameters: [
       {
@@ -313,6 +317,7 @@ export const processResponseTransformers = async ({
                   path: [dataVariableName],
                 });
           generateResponseTransformer({
+            async: true,
             client,
             name: nameCreated,
             onNode,
@@ -321,7 +326,7 @@ export const processResponseTransformers = async ({
           });
         },
         onNode,
-        type: `(${dataVariableName}: any) => ${name}`,
+        type: `(${dataVariableName}: any) => Promise<${name}>`,
       });
     }
   }

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v2/core/ApiRequestOptions.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v2/core/ApiRequestOptions.ts.snap
@@ -9,6 +9,6 @@ export type ApiRequestOptions<T = unknown> = {
 	readonly body?: any;
 	readonly mediaType?: string;
 	readonly responseHeader?: string;
-	readonly responseTransformer?: (data: unknown) => T;
+	readonly responseTransformer?: (data: unknown) => Promise<T>;
 	readonly errors?: Record<number | string, string>;
 };
diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v2/core/request.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v2/core/request.ts.snap
@@ -328,7 +328,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions<T>)
 
 				let transformedBody = responseBody;
 				if (options.responseTransformer && response.ok) {
-					transformedBody = options.responseTransformer(responseBody)
+					transformedBody = await options.responseTransformer(responseBody)
 				}
 
 				const result: ApiResult = {

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3/core/ApiRequestOptions.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3/core/ApiRequestOptions.ts.snap
@@ -9,6 +9,6 @@ export type ApiRequestOptions<T = unknown> = {
 	readonly body?: any;
 	readonly mediaType?: string;
 	readonly responseHeader?: string;
-	readonly responseTransformer?: (data: unknown) => T;
+	readonly responseTransformer?: (data: unknown) => Promise<T>;
 	readonly errors?: Record<number | string, string>;
 };
diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3/core/request.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3/core/request.ts.snap
@@ -328,7 +328,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions<T>)
 
 				let transformedBody = responseBody;
 				if (options.responseTransformer && response.ok) {
-					transformedBody = options.responseTransformer(responseBody)
+					transformedBody = await options.responseTransformer(responseBody)
 				}
 
 				const result: ApiResult = {

diff --git a/...es/openapi-ts/test/__snapshots__/test/generated/v3_angular/core/ApiRequestOptions.ts.snap b/...es/openapi-ts/test/__snapshots__/test/generated/v3_angular/core/ApiRequestOptions.ts.snap
@@ -9,6 +9,6 @@ export type ApiRequestOptions<T = unknown> = {
 	readonly body?: any;
 	readonly mediaType?: string;
 	readonly responseHeader?: string;
-	readonly responseTransformer?: (data: unknown) => T;
+	readonly responseTransformer?: (data: unknown) => Promise<T>;
 	readonly errors?: Record<number | string, string>;
 };
diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/core/request.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/core/request.ts.snap
@@ -303,7 +303,7 @@ export const request = <T>(config: OpenAPIConfig, http: HttpClient, options: Api
 
 			let transformedBody = responseBody;
 			if (options.responseTransformer && response.ok) {
-				transformedBody = options.responseTransformer(responseBody)
+				transformedBody = await options.responseTransformer(responseBody)
 			}
 
 			return {

diff --git a/...-ts/test/__snapshots__/test/generated/v3_angular_transform/core/ApiRequestOptions.ts.snap b/...-ts/test/__snapshots__/test/generated/v3_angular_transform/core/ApiRequestOptions.ts.snap
@@ -9,6 +9,6 @@ export type ApiRequestOptions<T = unknown> = {
 	readonly body?: any;
 	readonly mediaType?: string;
 	readonly responseHeader?: string;
-	readonly responseTransformer?: (data: unknown) => T;
+	readonly responseTransformer?: (data: unknown) => Promise<T>;
 	readonly errors?: Record<number | string, string>;
 };
diff --git a/...es/openapi-ts/test/__snapshots__/test/generated/v3_angular_transform/core/request.ts.snap b/...es/openapi-ts/test/__snapshots__/test/generated/v3_angular_transform/core/request.ts.snap
@@ -303,7 +303,7 @@ export const request = <T>(config: OpenAPIConfig, http: HttpClient, options: Api
 
 			let transformedBody = responseBody;
 			if (options.responseTransformer && response.ok) {
-				transformedBody = options.responseTransformer(responseBody)
+				transformedBody = await options.responseTransformer(responseBody)
 			}
 
 			return {

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular_transform/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular_transform/types.gen.ts.snap
@@ -115,7 +115,7 @@ export type $OpenApiTs = {
     };
 };
 
-export type ParentModelWithDatesResponseTransformer = (data: any) => ParentModelWithDatesResponse;
+export type ParentModelWithDatesResponseTransformer = (data: any) => Promise<ParentModelWithDatesResponse>;
 
 export type ParentModelWithDatesModelResponseTransformer = (data: any) => ParentModelWithDates;
 
@@ -147,23 +147,23 @@ export const ParentModelWithDatesModelResponseTransformer: ParentModelWithDatesM
     return data;
 };
 
-export const ParentModelWithDatesResponseTransformer: ParentModelWithDatesResponseTransformer = data => {
+export const ParentModelWithDatesResponseTransformer: ParentModelWithDatesResponseTransformer = async (data) => {
     if (data) {
         ParentModelWithDatesModelResponseTransformer(data);
     }
     return data;
 };
 
-export type ModelWithDatesResponseTransformer = (data: any) => ModelWithDatesResponse;
+export type ModelWithDatesResponseTransformer = (data: any) => Promise<ModelWithDatesResponse>;
 
-export const ModelWithDatesResponseTransformer: ModelWithDatesResponseTransformer = data => {
+export const ModelWithDatesResponseTransformer: ModelWithDatesResponseTransformer = async (data) => {
     ModelWithDatesModelResponseTransformer(data);
     return data;
 };
 
-export type ModelWithDatesArrayResponseTransformer = (data: any) => ModelWithDatesArrayResponse;
+export type ModelWithDatesArrayResponseTransformer = (data: any) => Promise<ModelWithDatesArrayResponse>;
 
-export const ModelWithDatesArrayResponseTransformer: ModelWithDatesArrayResponseTransformer = data => {
+export const ModelWithDatesArrayResponseTransformer: ModelWithDatesArrayResponseTransformer = async (data) => {
     if (Array.isArray(data)) {
         data.forEach(ModelWithDatesModelResponseTransformer);
     }

diff --git a/...ages/openapi-ts/test/__snapshots__/test/generated/v3_axios/core/ApiRequestOptions.ts.snap b/...ages/openapi-ts/test/__snapshots__/test/generated/v3_axios/core/ApiRequestOptions.ts.snap
@@ -9,6 +9,6 @@ export type ApiRequestOptions<T = unknown> = {
 	readonly body?: any;
 	readonly mediaType?: string;
 	readonly responseHeader?: string;
-	readonly responseTransformer?: (data: unknown) => T;
+	readonly responseTransformer?: (data: unknown) => Promise<T>;
 	readonly errors?: Record<number | string, string>;
 };
diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_axios/core/request.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_axios/core/request.ts.snap
@@ -325,7 +325,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions<T>,
 
 				let transformedBody = responseBody;
 				if (options.responseTransformer && isSuccess(response.status)) {
-					transformedBody = options.responseTransformer(responseBody)
+					transformedBody = await options.responseTransformer(responseBody)
 				}
 
 				const result: ApiResult = {

diff --git a/...pi-ts/test/__snapshots__/test/generated/v3_axios_transform/core/ApiRequestOptions.ts.snap b/...pi-ts/test/__snapshots__/test/generated/v3_axios_transform/core/ApiRequestOptions.ts.snap
@@ -9,6 +9,6 @@ export type ApiRequestOptions<T = unknown> = {
 	readonly body?: any;
 	readonly mediaType?: string;
 	readonly responseHeader?: string;
-	readonly responseTransformer?: (data: unknown) => T;
+	readonly responseTransformer?: (data: unknown) => Promise<T>;
 	readonly errors?: Record<number | string, string>;
 };
diff --git a/...ages/openapi-ts/test/__snapshots__/test/generated/v3_axios_transform/core/request.ts.snap b/...ages/openapi-ts/test/__snapshots__/test/generated/v3_axios_transform/core/request.ts.snap
@@ -325,7 +325,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions<T>,
 
 				let transformedBody = responseBody;
 				if (options.responseTransformer && isSuccess(response.status)) {
-					transformedBody = options.responseTransformer(responseBody)
+					transformedBody = await options.responseTransformer(responseBody)
 				}
 
 				const result: ApiResult = {

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_axios_transform/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_axios_transform/types.gen.ts.snap
@@ -115,7 +115,7 @@ export type $OpenApiTs = {
     };
 };
 
-export type ParentModelWithDatesResponseTransformer = (data: any) => ParentModelWithDatesResponse;
+export type ParentModelWithDatesResponseTransformer = (data: any) => Promise<ParentModelWithDatesResponse>;
 
 export type ParentModelWithDatesModelResponseTransformer = (data: any) => ParentModelWithDates;
 
@@ -147,23 +147,23 @@ export const ParentModelWithDatesModelResponseTransformer: ParentModelWithDatesM
     return data;
 };
 
-export const ParentModelWithDatesResponseTransformer: ParentModelWithDatesResponseTransformer = data => {
+export const ParentModelWithDatesResponseTransformer: ParentModelWithDatesResponseTransformer = async (data) => {
     if (data) {
         ParentModelWithDatesModelResponseTransformer(data);
     }
     return data;
 };
 
-export type ModelWithDatesResponseTransformer = (data: any) => ModelWithDatesResponse;
+export type ModelWithDatesResponseTransformer = (data: any) => Promise<ModelWithDatesResponse>;
 
-export const ModelWithDatesResponseTransformer: ModelWithDatesResponseTransformer = data => {
+export const ModelWithDatesResponseTransformer: ModelWithDatesResponseTransformer = async (data) => {
     ModelWithDatesModelResponseTransformer(data);
     return data;
 };
 
-export type ModelWithDatesArrayResponseTransformer = (data: any) => ModelWithDatesArrayResponse;
+export type ModelWithDatesArrayResponseTransformer = (data: any) => Promise<ModelWithDatesArrayResponse>;
 
-export const ModelWithDatesArrayResponseTransformer: ModelWithDatesArrayResponseTransformer = data => {
+export const ModelWithDatesArrayResponseTransformer: ModelWithDatesArrayResponseTransformer = async (data) => {
     if (Array.isArray(data)) {
         data.forEach(ModelWithDatesModelResponseTransformer);
     }

diff --git a/...ges/openapi-ts/test/__snapshots__/test/generated/v3_client/core/ApiRequestOptions.ts.snap b/...ges/openapi-ts/test/__snapshots__/test/generated/v3_client/core/ApiRequestOptions.ts.snap
@@ -9,6 +9,6 @@ export type ApiRequestOptions<T = unknown> = {
 	readonly body?: any;
 	readonly mediaType?: string;
 	readonly responseHeader?: string;
-	readonly responseTransformer?: (data: unknown) => T;
+	readonly responseTransformer?: (data: unknown) => Promise<T>;
 	readonly errors?: Record<number | string, string>;
 };
diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/core/request.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/core/request.ts.snap
@@ -328,7 +328,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions<T>)
 
 				let transformedBody = responseBody;
 				if (options.responseTransformer && response.ok) {
-					transformedBody = options.responseTransformer(responseBody)
+					transformedBody = await options.responseTransformer(responseBody)
 				}
 
 				const result: ApiResult = {

diff --git a/...i-ts/test/__snapshots__/test/generated/v3_client_transform/core/ApiRequestOptions.ts.snap b/...i-ts/test/__snapshots__/test/generated/v3_client_transform/core/ApiRequestOptions.ts.snap
@@ -9,6 +9,6 @@ export type ApiRequestOptions<T = unknown> = {
 	readonly body?: any;
 	readonly mediaType?: string;
 	readonly responseHeader?: string;
-	readonly responseTransformer?: (data: unknown) => T;
+	readonly responseTransformer?: (data: unknown) => Promise<T>;
 	readonly errors?: Record<number | string, string>;
 };
diff --git a/...ges/openapi-ts/test/__snapshots__/test/generated/v3_client_transform/core/request.ts.snap b/...ges/openapi-ts/test/__snapshots__/test/generated/v3_client_transform/core/request.ts.snap
@@ -328,7 +328,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions<T>)
 
 				let transformedBody = responseBody;
 				if (options.responseTransformer && response.ok) {
-					transformedBody = options.responseTransformer(responseBody)
+					transformedBody = await options.responseTransformer(responseBody)
 				}
 
 				const result: ApiResult = {