fix: do not use a body serializer on text/plain sdks

hey-api · Jan 21, 2025 · 4784727 · 4784727
1 parent 548e5d8
commit 4784727
Show file tree

Hide file tree

Showing 37 changed files with 486 additions and 29 deletions.
diff --git a/.changeset/neat-donkeys-pay.md b/.changeset/neat-donkeys-pay.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: do not use a body serializer on text/plain sdks
diff --git a/.changeset/six-horses-report.md b/.changeset/six-horses-report.md
@@ -0,0 +1,8 @@
+---
+'@hey-api/client-axios': patch
+'@hey-api/client-fetch': patch
+'@hey-api/client-nuxt': patch
+'@hey-api/openapi-ts': patch
+---
+
+fix: add null to valid bodySerializer types
diff --git a/examples/openapi-ts-sample/.gitignore b/examples/openapi-ts-sample/.gitignore
@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
diff --git a/examples/openapi-ts-sample/index.html b/examples/openapi-ts-sample/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <!-- <link rel="icon" type="image/svg+xml" href="/vite.svg" /> -->
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Hey API + Fetch API Demo</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>
diff --git a/examples/openapi-ts-sample/openapi-ts.config.ts b/examples/openapi-ts-sample/openapi-ts.config.ts
@@ -0,0 +1,20 @@
+import { defineConfig } from '@hey-api/openapi-ts';
+
+export default defineConfig({
+  client: '@hey-api/client-fetch',
+  input:
+    '../../packages/openapi-ts/test/spec/2.0.x/body-response-text-plain.yaml',
+  output: {
+    format: 'prettier',
+    lint: 'eslint',
+    path: './src/client',
+  },
+  plugins: [
+    '@hey-api/schemas',
+    '@hey-api/sdk',
+    {
+      enums: 'javascript',
+      name: '@hey-api/typescript',
+    },
+  ],
+});
diff --git a/examples/openapi-ts-sample/package.json b/examples/openapi-ts-sample/package.json
@@ -0,0 +1,39 @@
+{
+  "name": "@example/openapi-ts-sample",
+  "private": true,
+  "version": "0.0.1",
+  "type": "module",
+  "scripts": {
+    "build": "tsc && vite build",
+    "dev": "vite",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "openapi-ts": "openapi-ts",
+    "preview": "vite preview",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@hey-api/client-fetch": "workspace:*",
+    "@radix-ui/react-form": "0.1.1",
+    "@radix-ui/react-icons": "1.3.2",
+    "@radix-ui/themes": "3.1.6",
+    "react": "19.0.0",
+    "react-dom": "19.0.0"
+  },
+  "devDependencies": {
+    "@hey-api/openapi-ts": "workspace:*",
+    "@types/react": "19.0.1",
+    "@types/react-dom": "19.0.1",
+    "@typescript-eslint/eslint-plugin": "7.18.0",
+    "@typescript-eslint/parser": "7.15.0",
+    "@vitejs/plugin-react": "4.3.1",
+    "autoprefixer": "10.4.19",
+    "eslint": "9.17.0",
+    "eslint-plugin-react-hooks": "4.6.2",
+    "eslint-plugin-react-refresh": "0.4.7",
+    "postcss": "8.4.39",
+    "prettier": "3.4.2",
+    "tailwindcss": "3.4.4",
+    "typescript": "5.5.3",
+    "vite": "6.0.7"
+  }
+}
diff --git a/examples/openapi-ts-sample/postcss.config.js b/examples/openapi-ts-sample/postcss.config.js
@@ -0,0 +1,6 @@
+export default {
+  plugins: {
+    autoprefixer: {},
+    tailwindcss: {},
+  },
+};
diff --git a/examples/openapi-ts-sample/src/App.css b/examples/openapi-ts-sample/src/App.css
@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
diff --git a/examples/openapi-ts-sample/src/App.tsx b/examples/openapi-ts-sample/src/App.tsx
@@ -0,0 +1,40 @@
+import './App.css';
+
+import {
+  Box,
+  Button,
+  Container,
+  Flex,
+  Heading,
+  Section,
+} from '@radix-ui/themes';
+
+import { postFoo } from './client/sdk.gen';
+
+function App() {
+  const onClick = async () => {
+    postFoo({
+      body: 'foo',
+    });
+  };
+
+  return (
+    <Box
+      style={{ background: 'var(--gray-a2)', borderRadius: 'var(--radius-3)' }}
+    >
+      <Container size="1">
+        <Section size="1" />
+        <Flex align="center">
+          <Heading>sample for internal testing</Heading>
+        </Flex>
+        <Section size="1" />
+        <Flex direction="column" gapY="2">
+          <Button onClick={onClick}>Click me</Button>
+        </Flex>
+        <Section size="1" />
+      </Container>
+    </Box>
+  );
+}
+
+export default App;
diff --git a/examples/openapi-ts-sample/src/client/index.ts b/examples/openapi-ts-sample/src/client/index.ts
@@ -0,0 +1,3 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './sdk.gen';
+export * from './types.gen';
diff --git a/examples/openapi-ts-sample/src/client/sdk.gen.ts b/examples/openapi-ts-sample/src/client/sdk.gen.ts
@@ -0,0 +1,24 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import {
+  createClient,
+  createConfig,
+  type Options,
+} from '@hey-api/client-fetch';
+
+import type { PostFooData, PostFooResponse } from './types.gen';
+
+export const client = createClient(createConfig());
+
+export const postFoo = <ThrowOnError extends boolean = false>(
+  options: Options<PostFooData, ThrowOnError>,
+) =>
+  (options?.client ?? client).post<PostFooResponse, unknown, ThrowOnError>({
+    bodySerializer: null,
+    url: '/foo',
+    ...options,
+    headers: {
+      'Content-Type': 'text/plain',
+      ...options?.headers,
+    },
+  });
diff --git a/examples/openapi-ts-sample/src/client/types.gen.ts b/examples/openapi-ts-sample/src/client/types.gen.ts
@@ -0,0 +1,17 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type PostFooData = {
+  body: string;
+  path?: never;
+  query?: never;
+  url: '/foo';
+};
+
+export type PostFooResponses = {
+  /**
+   * OK
+   */
+  200: string;
+};
+
+export type PostFooResponse = PostFooResponses[keyof PostFooResponses];
diff --git a/examples/openapi-ts-sample/src/main.tsx b/examples/openapi-ts-sample/src/main.tsx
@@ -0,0 +1,26 @@
+import '@radix-ui/themes/styles.css';
+
+import { Theme } from '@radix-ui/themes';
+import React from 'react';
+import ReactDOM from 'react-dom/client';
+
+import App from './App.tsx';
+import { client } from './client/sdk.gen';
+
+// configure internal service client
+client.setConfig({
+  // set default base url for requests
+  baseUrl: 'https://petstore3.swagger.io/api/v3',
+  // set default headers for requests
+  headers: {
+    Authorization: 'Bearer <token_from_service_client>',
+  },
+});
+
+ReactDOM.createRoot(document.getElementById('root')!).render(
+  <React.StrictMode>
+    <Theme appearance="dark">
+      <App />
+    </Theme>
+  </React.StrictMode>,
+);
diff --git a/examples/openapi-ts-sample/src/vite-env.d.ts b/examples/openapi-ts-sample/src/vite-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="vite/client" />
diff --git a/examples/openapi-ts-sample/tailwind.config.js b/examples/openapi-ts-sample/tailwind.config.js
@@ -0,0 +1,8 @@
+/** @type {import('tailwindcss').Config} */
+export default {
+  content: ['./index.html', './src/**/*.{html,js,ts,jsx,tsx}'],
+  plugins: [],
+  theme: {
+    extend: {},
+  },
+};
diff --git a/examples/openapi-ts-sample/tsconfig.json b/examples/openapi-ts-sample/tsconfig.json
@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "react-jsx",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "include": ["src"],
+  "references": [{ "path": "./tsconfig.node.json" }]
+}
diff --git a/examples/openapi-ts-sample/tsconfig.node.json b/examples/openapi-ts-sample/tsconfig.node.json
@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "skipLibCheck": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true,
+    "strict": true
+  },
+  "include": ["vite.config.ts"]
+}
diff --git a/examples/openapi-ts-sample/vite.config.ts b/examples/openapi-ts-sample/vite.config.ts
@@ -0,0 +1,7 @@
+import react from '@vitejs/plugin-react';
+import { defineConfig } from 'vite';
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [react()],
+});
diff --git a/packages/client-axios/src/types.ts b/packages/client-axios/src/types.ts
@@ -32,7 +32,7 @@ export interface Config<ThrowOnError extends boolean = boolean>
    * A function for serializing request body parameter. By default,
    * {@link JSON.stringify()} will be used.
    */
-  bodySerializer?: BodySerializer;
+  bodySerializer?: BodySerializer | null;
   /**
    * An object containing any HTTP headers that you want to pre-populate your
    * `Headers` object with.

diff --git a/packages/client-fetch/src/types.ts b/packages/client-fetch/src/types.ts
@@ -24,7 +24,7 @@ export interface Config<ThrowOnError extends boolean = boolean>
    * A function for serializing request body parameter. By default,
    * {@link JSON.stringify()} will be used.
    */
-  bodySerializer?: BodySerializer;
+  bodySerializer?: BodySerializer | null;
   /**
    * Fetch API implementation. You can use this option to provide a custom
    * fetch instance.

diff --git a/packages/client-nuxt/src/types.ts b/packages/client-nuxt/src/types.ts
@@ -65,7 +65,7 @@ export interface Config
    * A function for serializing request body parameter. By default,
    * {@link JSON.stringify()} will be used.
    */
-  bodySerializer?: BodySerializer;
+  bodySerializer?: BodySerializer | null;
   /**
    * An object containing any HTTP headers that you want to pre-populate your
    * `Headers` object with.