chore: consistent response type

Author: mrlubos

dev/inputs.ts

@@ -7,6 +7,7 @@ export const inputs = {
   full: path.resolve(specsPath, '3.1.x', 'full.yaml'),
   heyapi: 'hey-api/backend',
   local: 'http://localhost:8000/openapi.json',
+  mockers: path.resolve(specsPath, '3.1.x', 'mockers.yaml'),
   opencode: path.resolve(specsPath, '3.1.x', 'opencode.yaml'),
   petstore:
     'https://raw.githubusercontent.com/swagger-api/swagger-petstore/master/src/main/resources/openapi.yaml',

dev/playground.ts

@@ -36,9 +36,7 @@ const server = setupServer(
   // }),
   ...handlers.all({
     pick: {
-      // get(info) {
-      //   console.log('Received request for projectUpdate with info:', info);
-      // },
+      // ...
     },
   }),
 );
@@ -47,9 +45,6 @@ server.listen();
 async function run() {
   // const { client, server } = await createOpencode();
   // console.log(client, server);
-  client.setConfig({
-    baseUrl: 'https://api.heyapi.dev/',
-  });
   const sdk = new Sdk({ client });
   // const published = await sdk.tui.publish({
   //   body: {
@@ -62,7 +57,7 @@ async function run() {
   //   directory: 'main',
   // });
   // console.log('Published:', published.data, published.error);
-  const project = await sdk.get({
+  const project = await sdk.getFoo({
     // ...
   });
   console.log('Updated Project:', project.data, project.error);

packages/openapi-ts/src/plugins/msw/shared/handler.ts

@@ -7,7 +7,7 @@ import type { MswPlugin } from '../types';
 import { computeDominantResponse, type DominantResponse } from './computeDominantResponse';
 import { getOperationComment } from './operation';
 import { sanitizeParamName, sanitizePath } from './path';
-import { createHandlerResponse } from './response';
+import { createHttpResponse } from './response';
 
 const emitToResponseUnion = (plugin: MswPlugin['Instance']) => {
   const symbol = plugin.symbol('ToResponseUnion', {
@@ -42,21 +42,19 @@ const emitToResponseUnion = (plugin: MswPlugin['Instance']) => {
 function createHandlerNode({
   baseUrl,
   bodyType,
-  method,
   operation,
   paramsType,
   plugin,
   response,
-  responseOrResolverType,
+  responseParamType,
 }: {
   baseUrl: string | undefined;
   bodyType: ReturnType<typeof $.type.idx | typeof $.type>;
-  method: string;
   operation: IR.OperationObject;
   paramsType: ReturnType<typeof $.type | typeof $.type.object>;
   plugin: MswPlugin['Instance'];
   response: DominantResponse;
-  responseOrResolverType: ReturnType<typeof $.type | typeof $.type.or>;
+  responseParamType: ReturnType<typeof $.type | typeof $.type.or>;
 }): Symbol {
   const symbolHttp = plugin.external('msw.http');
   const symbolResponse = plugin.symbol('response');
@@ -82,7 +80,7 @@ function createHandlerNode({
   const handlerFunc = $.func(symbol)
     .export()
     .$if(plugin.config.comments && getOperationComment(operation), (f, v) => f.doc(v))
-    .param(symbolResponse, (p) => p.optional().type(responseOrResolverType))
+    .param(symbolResponse, (p) => p.optional().type(responseParamType))
     .param(symbolOptions, (p) =>
       p.optional().type(
         plugin.referenceSymbol({
@@ -95,7 +93,7 @@ function createHandlerNode({
     .returns(plugin.external('msw.HttpHandler'))
     .do(
       $(symbolHttp)
-        .attr(method)
+        .attr(operation.method)
         .call(
           $.template(
             $(symbolOptions)
@@ -116,7 +114,7 @@ function createHandlerNode({
                   .$if(hasResponse, (c) => c.coalesce($.fromValue(response.example))),
               ),
               $.if($('body').neq($('undefined'))).do(
-                createHandlerResponse({
+                createHttpResponse({
                   plugin,
                   response,
                   symbol: symbolResponse,
@@ -227,30 +225,43 @@ export function getHandler({
     response.example = undefined;
   }
 
-  let responseOrResolverType: ReturnType<typeof $.type | typeof $.type.or>;
-  if (response.statusCode != null && symbolResponsesType) {
-    const responseType = $.type
-      .object()
-      .prop('body', (p) =>
-        p.type($.type(symbolResponsesType).idx($.type.literal(response.statusCode!))),
-      )
-      .prop('status', (p) => p.optional().type($.type.literal(response.statusCode!)));
-    responseOrResolverType = $.type.or(
-      responseType,
-      responsesOverrideType ? $.type.or(responsesOverrideType, resolverType) : resolverType,
+  const responseType = $.type
+    .object()
+    .prop('body', (p) =>
+      p.type(
+        response.statusCode !== undefined && symbolResponsesType
+          ? $.type(symbolResponsesType).idx($.type.literal(response.statusCode))
+          : $.type(plugin.external('msw.DefaultBodyType')),
+      ),
+    )
+    .prop('status', (p) =>
+      p
+        .optional()
+        .type(
+          response.statusCode !== undefined
+            ? $.type.literal(response.statusCode)
+            : $.type('number'),
+        ),
     );
-  } else {
-    responseOrResolverType = resolverType;
-  }
+  const symbolResponseType = plugin.symbol(
+    applyNaming(`handle-${operation.id}-response`, {
+      casing: 'PascalCase', // TODO: expose as a config option
+    }),
+  );
+  plugin.node($.type.alias(symbolResponseType).export().type(responseType));
+
+  const responseParamType = $.type.or(
+    symbolResponseType,
+    responsesOverrideType ? $.type.or(responsesOverrideType, resolverType) : resolverType,
+  );
 
   return createHandlerNode({
     baseUrl,
     bodyType,
-    method: operation.method,
     operation,
     paramsType,
     plugin,
     response,
-    responseOrResolverType,
+    responseParamType,
   });
 }

packages/openapi-ts/src/plugins/msw/shared/response.ts

@@ -4,10 +4,7 @@ import { $ } from '../../../ts-dsl';
 import type { MswPlugin } from '../types';
 import type { DominantResponse } from './computeDominantResponse';
 
-/**
- * Builds the response override expression for the `res` parameter.
- */
-export function createHandlerResponse({
+export function createHttpResponse({
   plugin,
   response,
   symbol,

packages/openapi-ts/src/plugins/msw/v2/plugin.ts

@@ -11,6 +11,10 @@ export const handlerV2: MswPlugin['Handler'] = ({ plugin }) => {
   plugin.symbol('http', {
     external: 'msw',
   });
+  plugin.symbol('DefaultBodyType', {
+    external: 'msw',
+    kind: 'type',
+  });
   const symbolHttpHandler = plugin.symbol('HttpHandler', {
     external: 'msw',
     kind: 'type',