@orpc/openapi 0.41.1 → 0.42.0

package/README.md

@@ -0,0 +1,91 @@
+<div align="center">
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+</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">
+    <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fopenapi?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`
+
+Generate OpenAPI specs and handle OpenAPI requests. Read the [documentation](https://orpc.unnoq.com/docs/openapi/getting-started) for more information.
+
+```ts
+import { createServer } from 'node:http'
+import { OpenAPIHandler } from '@orpc/openapi/node'
+import { CORSPlugin } from '@orpc/server/plugins'
+
+const handler = new OpenAPIHandler(router, {
+  plugins: [new CORSPlugin()]
+})
+
+const server = createServer(async (req, res) => {
+  const result = await handler.handle(req, res, {
+    context: { headers: req.headers }
+  })
+
+  if (!result.matched) {
+    res.statusCode = 404
+    res.end('No procedure matched')
+  }
+})
+
+server.listen(3000, '127.0.0.1', () => console.log('Listening on 127.0.0.1:3000'))
+```
+
+## License
+
+Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.

package/dist/{chunk-UU2TTVB2.js → chunk-ATDLVTJE.js}

@@ -1,7 +1,7 @@
 import {
   OpenAPICodec,
   OpenAPIMatcher
-} from "./chunk-LPBZEW4B.js";
+} from "./chunk-PGCWJMRO.js";
 
 // src/adapters/fetch/openapi-handler.ts
 import { toFetchResponse, toStandardRequest } from "@orpc/server-standard-fetch";
@@ -9,8 +9,8 @@ import { StandardHandler } from "@orpc/server/standard";
 var OpenAPIHandler = class {
   standardHandler;
   constructor(router, options) {
-    const matcher = options?.matcher ?? new OpenAPIMatcher(options);
-    const codec = options?.codec ?? new OpenAPICodec(options);
+    const matcher = options?.matcher ?? new OpenAPIMatcher();
+    const codec = options?.codec ?? new OpenAPICodec();
     this.standardHandler = new StandardHandler(router, matcher, codec, options);
   }
   async handle(request, ...rest) {
@@ -29,4 +29,4 @@ var OpenAPIHandler = class {
 export {
   OpenAPIHandler
 };
-//# sourceMappingURL=chunk-UU2TTVB2.js.map
+//# sourceMappingURL=chunk-ATDLVTJE.js.map

package/dist/{chunk-LPBZEW4B.js → chunk-PGCWJMRO.js}

@@ -7,9 +7,8 @@ import { OpenAPISerializer } from "@orpc/client/openapi";
 import { fallbackContractConfig } from "@orpc/contract";
 import { isObject } from "@orpc/shared";
 var OpenAPICodec = class {
-  serializer;
-  constructor(options) {
-    this.serializer = options?.serializer ?? new OpenAPISerializer();
+  constructor(serializer = new OpenAPISerializer()) {
+    this.serializer = serializer;
   }
   async decode(request, params, procedure) {
     const inputStructure = fallbackContractConfig("defaultInputStructure", procedure["~orpc"].route.inputStructure);
@@ -79,19 +78,12 @@ import { convertPathToHttpPath, createContractedProcedure, eachContractProcedure
 import { addRoute, createRouter, findRoute } from "rou3";
 var OpenAPIMatcher = class {
   tree = createRouter();
-  ignoreUndefinedMethod;
-  constructor(options) {
-    this.ignoreUndefinedMethod = options?.ignoreUndefinedMethod ?? false;
-  }
   pendingRouters = [];
   init(router, path = []) {
     const laziedOptions = eachContractProcedure({
       router,
       path
     }, ({ path: path2, contract }) => {
-      if (!contract["~orpc"].route.method && this.ignoreUndefinedMethod) {
-        return;
-      }
       const method = fallbackContractConfig2("defaultMethod", contract["~orpc"].route.method);
       const httpPath = contract["~orpc"].route.path ? toRou3Pattern(contract["~orpc"].route.path) : convertPathToHttpPath(path2);
       if (isProcedure(contract)) {
@@ -162,4 +154,4 @@ export {
   OpenAPICodec,
   OpenAPIMatcher
 };
-//# sourceMappingURL=chunk-LPBZEW4B.js.map
+//# sourceMappingURL=chunk-PGCWJMRO.js.map

package/dist/fetch.js

@@ -1,7 +1,7 @@
 import {
   OpenAPIHandler
-} from "./chunk-UU2TTVB2.js";
-import "./chunk-LPBZEW4B.js";
+} from "./chunk-ATDLVTJE.js";
+import "./chunk-PGCWJMRO.js";
 import "./chunk-XGHV4TH3.js";
 export {
   OpenAPIHandler

package/dist/hono.js

@@ -1,7 +1,7 @@
 import {
   OpenAPIHandler
-} from "./chunk-UU2TTVB2.js";
-import "./chunk-LPBZEW4B.js";
+} from "./chunk-ATDLVTJE.js";
+import "./chunk-PGCWJMRO.js";
 import "./chunk-XGHV4TH3.js";
 export {
   OpenAPIHandler

package/dist/index.js

@@ -672,7 +672,7 @@ var OpenAPIGenerator = class {
         }
       }
     });
-    return this.jsonSerializer.serialize(builder.getSpec());
+    return this.jsonSerializer.serialize(builder.getSpec())[0];
   }
 };
 

package/dist/next.js

@@ -1,7 +1,7 @@
 import {
   OpenAPIHandler
-} from "./chunk-UU2TTVB2.js";
-import "./chunk-LPBZEW4B.js";
+} from "./chunk-ATDLVTJE.js";
+import "./chunk-PGCWJMRO.js";
 import "./chunk-XGHV4TH3.js";
 export {
   OpenAPIHandler

package/dist/node.js

@@ -1,7 +1,7 @@
 import {
   OpenAPICodec,
   OpenAPIMatcher
-} from "./chunk-LPBZEW4B.js";
+} from "./chunk-PGCWJMRO.js";
 import "./chunk-XGHV4TH3.js";
 
 // src/adapters/node/openapi-handler.ts
@@ -10,8 +10,8 @@ import { StandardHandler } from "@orpc/server/standard";
 var OpenAPIHandler = class {
   standardHandler;
   constructor(router, options) {
-    const matcher = options?.matcher ?? new OpenAPIMatcher(options);
-    const codec = options?.codec ?? new OpenAPICodec(options);
+    const matcher = options?.matcher ?? new OpenAPIMatcher();
+    const codec = options?.codec ?? new OpenAPICodec();
     this.standardHandler = new StandardHandler(router, matcher, codec, { ...options });
   }
   async handle(req, res, ...rest) {

package/dist/src/adapters/standard/openapi-codec.d.ts

@@ -3,12 +3,9 @@ import type { AnyProcedure } from '@orpc/server';
 import type { StandardRequest, StandardResponse } from '@orpc/server-standard';
 import type { StandardCodec, StandardParams } from '@orpc/server/standard';
 import { OpenAPISerializer } from '@orpc/client/openapi';
-export interface OpenAPICodecOptions {
-    serializer?: OpenAPISerializer;
-}
 export declare class OpenAPICodec implements StandardCodec {
     private readonly serializer;
-    constructor(options?: OpenAPICodecOptions);
+    constructor(serializer?: OpenAPISerializer);
     decode(request: StandardRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
     encode(output: unknown, procedure: AnyProcedure): StandardResponse;
     encodeError(error: ORPCError<any, any>): StandardResponse;

package/dist/src/adapters/standard/openapi-handler.d.ts

@@ -1,7 +1,5 @@
 import type { Context } from '@orpc/server';
 import type { RPCHandlerOptions } from '@orpc/server/standard';
-import type { OpenAPICodecOptions } from './openapi-codec';
-import type { OpenAPIMatcherOptions } from './openapi-matcher';
-export interface OpenAPIHandlerOptions<T extends Context> extends RPCHandlerOptions<T>, OpenAPIMatcherOptions, OpenAPICodecOptions {
+export interface OpenAPIHandlerOptions<T extends Context> extends RPCHandlerOptions<T> {
 }
 //# sourceMappingURL=openapi-handler.d.ts.map

package/dist/src/adapters/standard/openapi-matcher.d.ts

@@ -1,18 +1,8 @@
 import type { AnyRouter } from '@orpc/server';
 import type { StandardMatcher, StandardMatchResult } from '@orpc/server/standard';
 import { type HTTPPath } from '@orpc/contract';
-export interface OpenAPIMatcherOptions {
-    /**
-     * Ignore procedure that does not have a method defined in the contract.
-     *
-     * @default false
-     */
-    ignoreUndefinedMethod?: boolean;
-}
 export declare class OpenAPIMatcher implements StandardMatcher {
     private readonly tree;
-    private readonly ignoreUndefinedMethod;
-    constructor(options?: OpenAPIMatcherOptions);
     private pendingRouters;
     init(router: AnyRouter, path?: string[]): void;
     match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;

package/dist/src/openapi-generator.d.ts

@@ -2,7 +2,7 @@ import type { PublicOpenAPIInputStructureParser } from './openapi-input-structur
 import type { PublicOpenAPIOutputStructureParser } from './openapi-output-structure-parser';
 import type { PublicOpenAPIPathParser } from './openapi-path-parser';
 import type { SchemaConverter } from './schema-converter';
-import { type PublicOpenAPIJsonSerializer } from '@orpc/client/openapi';
+import { OpenAPIJsonSerializer } from '@orpc/client/openapi';
 import { type ContractRouter } from '@orpc/contract';
 import { type AnyRouter } from '@orpc/server';
 import { type OpenAPI } from './openapi';
@@ -15,7 +15,7 @@ export interface OpenAPIGeneratorOptions {
     parametersBuilder?: PublicOpenAPIParametersBuilder;
     schemaConverters?: SchemaConverter[];
     schemaUtils?: PublicSchemaUtils;
-    jsonSerializer?: PublicOpenAPIJsonSerializer;
+    jsonSerializer?: OpenAPIJsonSerializer;
     pathParser?: PublicOpenAPIPathParser;
     inputStructureParser?: PublicOpenAPIInputStructureParser;
     outputStructureParser?: PublicOpenAPIOutputStructureParser;

package/dist/standard.js

@@ -1,7 +1,7 @@
 import {
   OpenAPICodec,
   OpenAPIMatcher
-} from "./chunk-LPBZEW4B.js";
+} from "./chunk-PGCWJMRO.js";
 import "./chunk-XGHV4TH3.js";
 export {
   OpenAPICodec,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/openapi",
   "type": "module",
-  "version": "0.41.1",
+  "version": "0.42.0",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -60,10 +60,10 @@
     "json-schema-typed": "^8.0.1",
     "openapi3-ts": "^4.4.0",
     "rou3": "^0.5.1",
-    "@orpc/client": "0.41.1",
-    "@orpc/contract": "0.41.1",
-    "@orpc/server": "0.41.1",
-    "@orpc/shared": "0.41.1"
+    "@orpc/client": "0.42.0",
+    "@orpc/contract": "0.42.0",
+    "@orpc/shared": "0.42.0",
+    "@orpc/server": "0.42.0"
   },
   "devDependencies": {
     "zod": "^3.24.1"