feat(client): add requestValidator option

Author: mrlubos

examples/openapi-ts-fetch/src/client/client/client.ts

@@ -46,6 +46,10 @@ export const createClient = (config: Config = {}): Client => {
       });
     }
 
+    if (opts.requestValidator) {
+      await opts.requestValidator(opts);
+    }
+
     if (opts.body && opts.bodySerializer) {
       opts.body = opts.bodySerializer(opts.body);
     }
@@ -103,16 +107,24 @@ export const createClient = (config: Config = {}): Client => {
           ? getParseAs(response.headers.get('Content-Type'))
           : opts.parseAs) ?? 'json';
 
-      if (parseAs === 'stream') {
-        return opts.responseStyle === 'data'
-          ? response.body
-          : {
-              data: response.body,
-              ...result,
-            };
+      let data: any;
+      switch (parseAs) {
+        case 'arrayBuffer':
+        case 'blob':
+        case 'formData':
+        case 'json':
+        case 'text':
+          data = await response[parseAs]();
+          break;
+        case 'stream':
+          return opts.responseStyle === 'data'
+            ? response.body
+            : {
+                data: response.body,
+                ...result,
+              };
       }
 
-      let data = await response[parseAs]();
       if (parseAs === 'json') {
         if (opts.responseValidator) {
           await opts.responseValidator(data);

examples/openapi-ts-fetch/src/client/client/types.ts

@@ -33,7 +33,14 @@ export interface Config<T extends ClientOptions = ClientOptions>
    *
    * @default 'auto'
    */
-  parseAs?: Exclude<keyof Body, 'body' | 'bodyUsed'> | 'auto' | 'stream';
+  parseAs?:
+    | 'arrayBuffer'
+    | 'auto'
+    | 'blob'
+    | 'formData'
+    | 'json'
+    | 'stream'
+    | 'text';
   /**
    * Should we return only data or multiple fields (data, error, response, etc.)?
    *

examples/openapi-ts-fetch/src/client/client/utils.ts

@@ -182,6 +182,8 @@ export const getParseAs = (
   if (cleanContent.startsWith('text/')) {
     return 'text';
   }
+
+  return;
 };
 
 export const setAuthParams = async ({

examples/openapi-ts-fetch/src/client/core/bodySerializer.ts

@@ -57,7 +57,7 @@ export const formDataBodySerializer = {
 
 export const jsonBodySerializer = {
   bodySerializer: <T>(body: T) =>
-    JSON.stringify(body, (key, value) =>
+    JSON.stringify(body, (_key, value) =>
       typeof value === 'bigint' ? value.toString() : value,
     ),
 };

examples/openapi-ts-fetch/src/client/core/types.ts

@@ -84,6 +84,12 @@ export interface Config {
    * {@link https://swagger.io/docs/specification/serialization/#query View examples}
    */
   querySerializer?: QuerySerializer | QuerySerializerOptions;
+  /**
+   * A function validating request data. This is useful if you want to ensure
+   * the request conforms to the desired shape, so it can be safely sent to
+   * the server.
+   */
+  requestValidator?: (data: unknown) => Promise<unknown>;
   /**
    * A function transforming response data before it's returned. This is useful
    * for post-processing data, e.g. converting ISO strings into Date objects.

examples/openapi-ts-fetch/src/client/types.gen.ts

@@ -560,7 +560,7 @@ export type LoginUserResponses = {
   /**
    * successful operation
    */
-  200: Blob | File;
+  200: string;
 };
 
 export type LoginUserResponse = LoginUserResponses[keyof LoginUserResponses];

examples/openapi-ts-sample/openapi-ts.config.ts

@@ -14,7 +14,10 @@ export default defineConfig({
       runtimeConfigPath: './src/hey-api.ts',
     },
     '@hey-api/schemas',
-    '@hey-api/sdk',
+    {
+      name: '@hey-api/sdk',
+      validator: 'zod',
+    },
     {
       enums: 'javascript',
       name: '@hey-api/typescript',

examples/openapi-ts-sample/package.json

@@ -16,7 +16,9 @@
     "@radix-ui/react-icons": "1.3.2",
     "@radix-ui/themes": "3.1.6",
     "react": "19.0.0",
-    "react-dom": "19.0.0"
+    "react-dom": "19.0.0",
+    "valibot": "1.1.0",
+    "zod": "3.23.8"
   },
   "devDependencies": {
     "@config/vite-base": "workspace:*",

examples/openapi-ts-sample/src/App.tsx

@@ -9,16 +9,18 @@ import {
   Section,
 } from '@radix-ui/themes';
 
-// @ts-expect-error
-import { postFoo } from './client/sdk.gen';
+import { getPetById } from './client/sdk.gen';
 
 function App() {
   const onClick = async () => {
-    postFoo({
-      body: {
-        foo: [[1, 2]],
+    const response = await getPetById({
+      path: {
+        // @ts-expect-error
+        foo: 3,
+        petId: 3,
       },
     });
+    console.log(response);
   };
 
   return (

examples/openapi-ts-sample/src/client/client/client.ts

@@ -46,6 +46,10 @@ export const createClient = (config: Config = {}): Client => {
       });
     }
 
+    if (opts.requestValidator) {
+      await opts.requestValidator(opts);
+    }
+
     if (opts.body && opts.bodySerializer) {
       opts.body = opts.bodySerializer(opts.body);
     }
@@ -103,16 +107,24 @@ export const createClient = (config: Config = {}): Client => {
           ? getParseAs(response.headers.get('Content-Type'))
           : opts.parseAs) ?? 'json';
 
-      if (parseAs === 'stream') {
-        return opts.responseStyle === 'data'
-          ? response.body
-          : {
-              data: response.body,
-              ...result,
-            };
+      let data: any;
+      switch (parseAs) {
+        case 'arrayBuffer':
+        case 'blob':
+        case 'formData':
+        case 'json':
+        case 'text':
+          data = await response[parseAs]();
+          break;
+        case 'stream':
+          return opts.responseStyle === 'data'
+            ? response.body
+            : {
+                data: response.body,
+                ...result,
+              };
       }
 
-      let data = await response[parseAs]();
       if (parseAs === 'json') {
         if (opts.responseValidator) {
           await opts.responseValidator(data);