refactor(openapi-client, client): move openapi serializer to its own package (#186)

dinwwwh · web-flow · commit b0f324ecb37c · 2025-03-01T15:26:35.000+07:00
* init

* separate

* refactor client itself with standard adapter

* wip

* improve
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>
diff --git a/packages/client/README.md b/packages/client/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>
diff --git a/packages/client/package.json b/packages/client/package.json
@@ -20,15 +20,10 @@
         "import": "./dist/index.mjs",
         "default": "./dist/index.mjs"
       },
-      "./openapi": {
-        "types": "./dist/openapi/index.d.mts",
-        "import": "./dist/openapi/index.mjs",
-        "default": "./dist/openapi/index.mjs"
-      },
-      "./rpc": {
-        "types": "./dist/rpc/index.d.mts",
-        "import": "./dist/rpc/index.mjs",
-        "default": "./dist/rpc/index.mjs"
+      "./standard": {
+        "types": "./dist/adapters/standard/index.d.mts",
+        "import": "./dist/adapters/standard/index.mjs",
+        "default": "./dist/adapters/standard/index.mjs"
       },
       "./fetch": {
         "types": "./dist/adapters/fetch/index.d.mts",
@@ -39,8 +34,7 @@
   },
   "exports": {
     ".": "./src/index.ts",
-    "./openapi": "./src/openapi/index.ts",
-    "./rpc": "./src/rpc/index.ts",
+    "./standard": "./src/adapters/standard/index.ts",
     "./fetch": "./src/adapters/fetch/index.ts"
   },
   "files": [
diff --git a/packages/client/src/adapters/fetch/rpc-link.ts b/packages/client/src/adapters/fetch/rpc-link.ts
@@ -7,7 +7,7 @@ import { isAsyncIteratorObject, stringifyJSON, trim, value } from '@orpc/shared'
 import { toFetchBody, toStandardBody } from '@orpc/standard-server-fetch'
 import { ORPCError } from '../../error'
 import { createAutoRetryEventIterator, type EventIteratorReconnectOptions } from '../../event-iterator'
-import { RPCSerializer } from '../../rpc'
+import { RPCSerializer } from '../standard'
 
 type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'
 
diff --git a/packages/client/src/adapters/standard/index.ts b/packages/client/src/adapters/standard/index.ts
@@ -0,0 +1,2 @@
+export * from './rpc-json-serializer'
+export * from './rpc-serializer'
diff --git a/packages/client/src/adapters/standard/rpc-json-serializer.ts b/packages/client/src/adapters/standard/rpc-json-serializer.ts
diff --git a/packages/client/src/adapters/standard/rpc-serializer.test.ts b/packages/client/src/adapters/standard/rpc-serializer.test.ts
@@ -1,8 +1,8 @@
 import { ORPCError } from '@orpc/contract'
 import { isAsyncIteratorObject, parseEmptyableJSON } from '@orpc/shared'
 import { ErrorEvent, getEventMeta, withEventMeta } from '@orpc/standard-server'
-import { supportedDataTypes } from '../../tests/shared'
-import { RPCSerializer } from './serializer'
+import { supportedDataTypes } from '../../../tests/shared'
+import { RPCSerializer } from './rpc-serializer'
 
 describe.each(supportedDataTypes)('rpcSerializer: $name', ({ value, expected }) => {
   const serializer = new RPCSerializer()
diff --git a/packages/client/src/adapters/standard/rpc-serializer.ts b/packages/client/src/adapters/standard/rpc-serializer.ts
@@ -1,8 +1,8 @@
 import { isAsyncIteratorObject, stringifyJSON } from '@orpc/shared'
 import { ErrorEvent } from '@orpc/standard-server'
-import { ORPCError, toORPCError } from '../error'
-import { mapEventIterator } from '../event-iterator'
-import { RPCJsonSerializer } from './json-serializer'
+import { ORPCError, toORPCError } from '../../error'
+import { mapEventIterator } from '../../event-iterator'
+import { RPCJsonSerializer } from './rpc-json-serializer'
 
 export class RPCSerializer {
   constructor(
diff --git a/packages/client/src/openapi/index.ts b/packages/client/src/openapi/index.ts
diff --git a/packages/client/src/rpc/index.ts b/packages/client/src/rpc/index.ts
diff --git a/packages/contract/README.md b/packages/contract/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>
diff --git a/packages/openapi-client/.gitignore b/packages/openapi-client/.gitignore
@@ -0,0 +1,26 @@
+# Hidden folders and files
+.*
+!.gitignore
+!.*.example
+
+# Common generated folders
+logs/
+node_modules/
+out/
+dist/
+dist-ssr/
+build/
+coverage/
+temp/
+
+# Common generated files
+*.log
+*.log.*
+*.tsbuildinfo
+*.vitest-temp.json
+vite.config.ts.timestamp-*
+vitest.config.ts.timestamp-*
+
+# Common manual ignore files
+*.local
+*.pem
diff --git a/packages/openapi-client/README.md b/packages/openapi-client/README.md
@@ -0,0 +1,68 @@
+<div align="center">
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
+</div>
+
+<h1></h1>
+
+<div align="center">
+  <a href="https://codecov.io/gh/unnoq/orpc">
+    <img alt="codecov" src="https://codecov.io/gh/unnoq/orpc/branch/main/graph/badge.svg">
+  </a>
+  <a href="https://www.npmjs.com/package/@orpc/openapi-client">
+    <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fopenapi-client?logo=npm" />
+  </a>
+  <a href="https://github.com/unnoq/orpc/blob/main/LICENSE">
+    <img alt="MIT License" src="https://img.shields.io/github/license/unnoq/orpc?logo=open-source-initiative" />
+  </a>
+  <a href="https://discord.gg/TXEbwRBvQn">
+    <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
+  </a>
+</div>
+
+<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
+
+**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards, ensuring a smooth and enjoyable developer experience.
+
+---
+
+## Highlights
+
+- **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
+- **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
+- **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
+- **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
+- **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
+- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue), Pinia Colada, and more.
+- **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
+- **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
+- **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
+- **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
+- **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
+- **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
+- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
+- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
+- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
+- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
+
+## Documentation
+
+You can find the full documentation [here](https://orpc.unnoq.com).
+
+## Packages
+
+- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
+- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
+- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
+- [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
+- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
+- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
+- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
+- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
+
+## `@orpc/openapi-client`
+
+Provides core serializer for OpenAPI requests and responses.
+
+## License
+
+Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
diff --git a/packages/openapi-client/package.json b/packages/openapi-client/package.json
@@ -0,0 +1,47 @@
+{
+  "name": "@orpc/openapi-client",
+  "type": "module",
+  "version": "0.0.0",
+  "license": "MIT",
+  "homepage": "https://orpc.unnoq.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/unnoq/orpc.git",
+    "directory": "packages/openapi-client"
+  },
+  "keywords": [
+    "unnoq",
+    "orpc"
+  ],
+  "publishConfig": {
+    "exports": {
+      ".": {
+        "types": "./dist/index.d.mts",
+        "import": "./dist/index.mjs",
+        "default": "./dist/index.mjs"
+      },
+      "./standard": {
+        "types": "./dist/adapters/standard/index.d.mts",
+        "import": "./dist/adapters/standard/index.mjs",
+        "default": "./dist/adapters/standard/index.mjs"
+      }
+    }
+  },
+  "exports": {
+    ".": "./src/index.ts",
+    "./standard": "./src/adapters/standard/index.ts"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "unbuild",
+    "build:watch": "pnpm run build --watch",
+    "type:check": "tsc -b"
+  },
+  "dependencies": {
+    "@orpc/client": "workspace:*",
+    "@orpc/shared": "workspace:*",
+    "@orpc/standard-server": "workspace:*"
+  }
+}
diff --git a/packages/openapi-client/src/adapters/standard/bracket-notation.test.ts b/packages/openapi-client/src/adapters/standard/bracket-notation.test.ts
diff --git a/packages/openapi-client/src/adapters/standard/bracket-notation.ts b/packages/openapi-client/src/adapters/standard/bracket-notation.ts
diff --git a/packages/openapi-client/src/adapters/standard/index.ts b/packages/openapi-client/src/adapters/standard/index.ts
@@ -0,0 +1,3 @@
+export * from './bracket-notation'
+export * from './openapi-json-serializer'
+export * from './openapi-serializer'
diff --git a/packages/openapi-client/src/adapters/standard/openapi-json-serializer.ts b/packages/openapi-client/src/adapters/standard/openapi-json-serializer.ts
diff --git a/packages/openapi-client/src/adapters/standard/openapi-serializer.test.ts b/packages/openapi-client/src/adapters/standard/openapi-serializer.test.ts
@@ -1,7 +1,7 @@
 import { ORPCError } from '@orpc/contract'
 import { ErrorEvent, getEventMeta, withEventMeta } from '@orpc/standard-server'
-import { OpenAPIJsonSerializer } from './json-serializer'
-import { OpenAPISerializer } from './serializer'
+import { OpenAPIJsonSerializer } from './openapi-json-serializer'
+import { OpenAPISerializer } from './openapi-serializer'
 
 beforeEach(() => {
   vi.clearAllMocks()
diff --git a/packages/openapi-client/src/adapters/standard/openapi-serializer.ts b/packages/openapi-client/src/adapters/standard/openapi-serializer.ts
@@ -1,9 +1,8 @@
+import { mapEventIterator, ORPCError, toORPCError } from '@orpc/client'
 import { isAsyncIteratorObject } from '@orpc/shared'
 import { ErrorEvent } from '@orpc/standard-server'
-import { ORPCError, toORPCError } from '../error'
-import { mapEventIterator } from '../event-iterator'
 import { BracketNotationSerializer } from './bracket-notation'
-import { OpenAPIJsonSerializer } from './json-serializer'
+import { OpenAPIJsonSerializer } from './openapi-json-serializer'
 
 export class OpenAPISerializer {
   constructor(
diff --git a/packages/openapi-client/src/index.ts b/packages/openapi-client/src/index.ts
diff --git a/packages/openapi-client/tsconfig.json b/packages/openapi-client/tsconfig.json
@@ -0,0 +1,16 @@
+{
+  "extends": "../../tsconfig.lib.json",
+  "references": [
+    { "path": "../client" },
+    { "path": "../shared" }
+  ],
+  "include": ["src"],
+  "exclude": [
+    "**/*.test.*",
+    "**/*.bench.*",
+    "**/*.test-d.ts",
+    "**/__tests__/**",
+    "**/__mocks__/**",
+    "**/__snapshots__/**"
+  ]
+}
diff --git a/packages/openapi/README.md b/packages/openapi/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>
diff --git a/packages/openapi/package.json b/packages/openapi/package.json
@@ -66,6 +66,7 @@
   "dependencies": {
     "@orpc/client": "workspace:*",
     "@orpc/contract": "workspace:*",
+    "@orpc/openapi-client": "workspace:*",
     "@orpc/server": "workspace:*",
     "@orpc/shared": "workspace:*",
     "@orpc/standard-server": "workspace:*",
diff --git a/packages/openapi/src/adapters/standard/openapi-codec.ts b/packages/openapi/src/adapters/standard/openapi-codec.ts
@@ -2,8 +2,8 @@ import type { ORPCError } from '@orpc/client'
 import type { AnyProcedure } from '@orpc/server'
 import type { StandardCodec, StandardParams } from '@orpc/server/standard'
 import type { StandardBody, StandardHeaders, StandardRequest, StandardResponse } from '@orpc/standard-server'
-import { OpenAPISerializer } from '@orpc/client/openapi'
 import { fallbackContractConfig } from '@orpc/contract'
+import { OpenAPISerializer } from '@orpc/openapi-client/standard'
 import { isObject } from '@orpc/shared'
 
 export class OpenAPICodec implements StandardCodec {
diff --git a/packages/openapi/src/openapi-generator.ts b/packages/openapi/src/openapi-generator.ts
@@ -4,8 +4,8 @@ import type { PublicOpenAPIPathParser } from './openapi-path-parser'
 import type { JSONSchema } from './schema'
 import type { SchemaConverter } from './schema-converter'
 import { fallbackORPCErrorStatus } from '@orpc/client'
-import { OpenAPIJsonSerializer } from '@orpc/client/openapi'
 import { type ContractRouter, fallbackContractConfig, getEventIteratorSchemaDetails } from '@orpc/contract'
+import { OpenAPIJsonSerializer } from '@orpc/openapi-client/standard'
 import { type AnyRouter, eachAllContractProcedure } from '@orpc/server'
 import { group } from '@orpc/shared'
 import { type OpenAPI, OpenApiBuilder } from './openapi'
diff --git a/packages/openapi/tsconfig.json b/packages/openapi/tsconfig.json
@@ -2,6 +2,7 @@
   "extends": "../../tsconfig.lib.json",
   "references": [
     { "path": "../client" },
+    { "path": "../openapi-client" },
     { "path": "../contract" },
     { "path": "../server" },
     { "path": "../standard-server" },
diff --git a/packages/react-query/README.md b/packages/react-query/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>
diff --git a/packages/server/README.md b/packages/server/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>
diff --git a/packages/server/src/adapters/standard/rpc-codec.ts b/packages/server/src/adapters/standard/rpc-codec.ts
@@ -2,7 +2,7 @@ import type { ORPCError } from '@orpc/client'
 import type { StandardBody, StandardRequest, StandardResponse } from '@orpc/standard-server'
 import type { AnyProcedure } from '../../procedure'
 import type { StandardCodec, StandardParams } from './types'
-import { RPCSerializer } from '@orpc/client/rpc'
+import { RPCSerializer } from '@orpc/client/standard'
 import { parseEmptyableJSON } from '@orpc/shared'
 
 export interface StandardCodecOptions {
diff --git a/packages/shared/README.md b/packages/shared/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>
diff --git a/packages/standard-server-fetch/README.md b/packages/standard-server-fetch/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>
diff --git a/packages/standard-server-node/README.md b/packages/standard-server-node/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>
diff --git a/packages/standard-server/README.md b/packages/standard-server/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>
diff --git a/packages/vue-colada/README.md b/packages/vue-colada/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>
diff --git a/packages/vue-colada/src/key.ts b/packages/vue-colada/src/key.ts
@@ -1,5 +1,5 @@
 import type { EntryKey } from '@pinia/colada'
-import { RPCJsonSerializer } from '@orpc/client/rpc'
+import { RPCJsonSerializer } from '@orpc/client/standard'
 import { stringifyJSON } from '@orpc/shared'
 
 export interface BuildKeyOptions<TInput> {
diff --git a/packages/vue-query/README.md b/packages/vue-query/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>
diff --git a/packages/zod/README.md b/packages/zod/README.md
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export * from './rpc-json-serializer'`
	`2`	`+export * from './rpc-serializer'`