@orpc/openapi 0.0.0-next.ed15210 → 0.0.0-next.ed87680

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/README.md +101 -0
  2. package/dist/adapters/aws-lambda/index.d.mts +19 -0
  3. package/dist/adapters/aws-lambda/index.d.ts +19 -0
  4. package/dist/adapters/aws-lambda/index.mjs +18 -0
  5. package/dist/adapters/fetch/index.d.mts +22 -0
  6. package/dist/adapters/fetch/index.d.ts +22 -0
  7. package/dist/adapters/fetch/index.mjs +18 -0
  8. package/dist/adapters/node/index.d.mts +22 -0
  9. package/dist/adapters/node/index.d.ts +22 -0
  10. package/dist/adapters/node/index.mjs +18 -0
  11. package/dist/adapters/standard/index.d.mts +29 -0
  12. package/dist/adapters/standard/index.d.ts +29 -0
  13. package/dist/adapters/standard/index.mjs +9 -0
  14. package/dist/index.d.mts +110 -0
  15. package/dist/index.d.ts +110 -0
  16. package/dist/index.mjs +41 -0
  17. package/dist/plugins/index.d.mts +84 -0
  18. package/dist/plugins/index.d.ts +84 -0
  19. package/dist/plugins/index.mjs +148 -0
  20. package/dist/shared/openapi.BVXcB0u4.mjs +187 -0
  21. package/dist/shared/openapi.BlSv9FKY.mjs +751 -0
  22. package/dist/shared/openapi.CQmjvnb0.d.mts +31 -0
  23. package/dist/shared/openapi.CQmjvnb0.d.ts +31 -0
  24. package/dist/shared/openapi.CfjfVeBJ.d.mts +108 -0
  25. package/dist/shared/openapi.CfjfVeBJ.d.ts +108 -0
  26. package/package.json +33 -38
  27. package/dist/chunk-7MA7YRRY.js +0 -25
  28. package/dist/chunk-BUMQYADN.js +0 -653
  29. package/dist/chunk-DSYVLQK3.js +0 -95
  30. package/dist/fetch.js +0 -34
  31. package/dist/hono.js +0 -34
  32. package/dist/index.js +0 -550
  33. package/dist/next.js +0 -34
  34. package/dist/node.js +0 -46
  35. package/dist/src/adapters/fetch/bracket-notation.d.ts +0 -84
  36. package/dist/src/adapters/fetch/index.d.ts +0 -10
  37. package/dist/src/adapters/fetch/input-structure-compact.d.ts +0 -6
  38. package/dist/src/adapters/fetch/input-structure-detailed.d.ts +0 -11
  39. package/dist/src/adapters/fetch/openapi-handler-server.d.ts +0 -7
  40. package/dist/src/adapters/fetch/openapi-handler-serverless.d.ts +0 -7
  41. package/dist/src/adapters/fetch/openapi-handler.d.ts +0 -32
  42. package/dist/src/adapters/fetch/openapi-payload-codec.d.ts +0 -15
  43. package/dist/src/adapters/fetch/openapi-procedure-matcher.d.ts +0 -19
  44. package/dist/src/adapters/fetch/schema-coercer.d.ts +0 -10
  45. package/dist/src/adapters/hono/index.d.ts +0 -2
  46. package/dist/src/adapters/next/index.d.ts +0 -2
  47. package/dist/src/adapters/node/index.d.ts +0 -5
  48. package/dist/src/adapters/node/openapi-handler-server.d.ts +0 -7
  49. package/dist/src/adapters/node/openapi-handler-serverless.d.ts +0 -7
  50. package/dist/src/adapters/node/openapi-handler.d.ts +0 -11
  51. package/dist/src/adapters/node/types.d.ts +0 -2
  52. package/dist/src/index.d.ts +0 -12
  53. package/dist/src/json-serializer.d.ts +0 -5
  54. package/dist/src/openapi-content-builder.d.ts +0 -10
  55. package/dist/src/openapi-error.d.ts +0 -3
  56. package/dist/src/openapi-generator.d.ts +0 -67
  57. package/dist/src/openapi-input-structure-parser.d.ts +0 -22
  58. package/dist/src/openapi-output-structure-parser.d.ts +0 -18
  59. package/dist/src/openapi-parameters-builder.d.ts +0 -12
  60. package/dist/src/openapi-path-parser.d.ts +0 -8
  61. package/dist/src/openapi.d.ts +0 -3
  62. package/dist/src/schema-converter.d.ts +0 -16
  63. package/dist/src/schema-utils.d.ts +0 -11
  64. package/dist/src/schema.d.ts +0 -12
  65. package/dist/src/utils.d.ts +0 -18
package/README.md ADDED
@@ -0,0 +1,101 @@
1
+ <div align="center">
2
+ <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
3
+ </div>
4
+
5
+ <h1></h1>
6
+
7
+ <div align="center">
8
+ <a href="https://codecov.io/gh/unnoq/orpc">
9
+ <img alt="codecov" src="https://codecov.io/gh/unnoq/orpc/branch/main/graph/badge.svg">
10
+ </a>
11
+ <a href="https://www.npmjs.com/package/@orpc/openapi">
12
+ <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fopenapi?logo=npm" />
13
+ </a>
14
+ <a href="https://github.com/unnoq/orpc/blob/main/LICENSE">
15
+ <img alt="MIT License" src="https://img.shields.io/github/license/unnoq/orpc?logo=open-source-initiative" />
16
+ </a>
17
+ <a href="https://discord.gg/TXEbwRBvQn">
18
+ <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
19
+ </a>
20
+ </div>
21
+
22
+ <h3 align="center">Typesafe APIs Made Simple 🪄</h3>
23
+
24
+ **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
25
+
26
+ ---
27
+
28
+ ## Highlights
29
+
30
+ - **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
31
+ - **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
32
+ - **📝 Contract-First Development**: Optionally define your API contract before implementation.
33
+ - **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
34
+ - **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
35
+ - **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
36
+ - **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
37
+ - **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
38
+ - **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
39
+ - **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
40
+ - **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
41
+ - **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
42
+
43
+ ## Documentation
44
+
45
+ You can find the full documentation [here](https://orpc.unnoq.com).
46
+
47
+ ## Packages
48
+
49
+ - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
50
+ - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
51
+ - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
52
+ - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
53
+ - [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
54
+ - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
55
+ - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
56
+ - [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
57
+ - [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
58
+ - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
59
+ - [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
60
+ - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
61
+ - [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
62
+ - [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
63
+
64
+ ## `@orpc/openapi`
65
+
66
+ Generate OpenAPI specs and handle OpenAPI requests. Read the [documentation](https://orpc.unnoq.com/docs/openapi/getting-started) for more information.
67
+
68
+ ```ts
69
+ import { createServer } from 'node:http'
70
+ import { OpenAPIHandler } from '@orpc/openapi/node'
71
+ import { CORSPlugin } from '@orpc/server/plugins'
72
+
73
+ const handler = new OpenAPIHandler(router, {
74
+ plugins: [new CORSPlugin()]
75
+ })
76
+
77
+ const server = createServer(async (req, res) => {
78
+ const result = await handler.handle(req, res, {
79
+ context: { headers: req.headers }
80
+ })
81
+
82
+ if (!result.matched) {
83
+ res.statusCode = 404
84
+ res.end('No procedure matched')
85
+ }
86
+ })
87
+
88
+ server.listen(3000, '127.0.0.1', () => console.log('Listening on 127.0.0.1:3000'))
89
+ ```
90
+
91
+ ## Sponsors
92
+
93
+ <p align="center">
94
+ <a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
95
+ <img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
96
+ </a>
97
+ </p>
98
+
99
+ ## License
100
+
101
+ Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
@@ -0,0 +1,19 @@
1
+ import { Context, Router } from '@orpc/server';
2
+ import { AwsLambdaHandler, AwsLambdaHandlerOptions } from '@orpc/server/aws-lambda';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.CQmjvnb0.mjs';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
6
+ import '@orpc/client';
7
+ import '@orpc/shared';
8
+
9
+ /**
10
+ * OpenAPI Handler for AWS Lambda.
11
+ *
12
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
13
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
14
+ */
15
+ declare class OpenAPIHandler<T extends Context> extends AwsLambdaHandler<T> {
16
+ constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & AwsLambdaHandlerOptions>);
17
+ }
18
+
19
+ export { OpenAPIHandler };
@@ -0,0 +1,19 @@
1
+ import { Context, Router } from '@orpc/server';
2
+ import { AwsLambdaHandler, AwsLambdaHandlerOptions } from '@orpc/server/aws-lambda';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.CQmjvnb0.js';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
6
+ import '@orpc/client';
7
+ import '@orpc/shared';
8
+
9
+ /**
10
+ * OpenAPI Handler for AWS Lambda.
11
+ *
12
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
13
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
14
+ */
15
+ declare class OpenAPIHandler<T extends Context> extends AwsLambdaHandler<T> {
16
+ constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & AwsLambdaHandlerOptions>);
17
+ }
18
+
19
+ export { OpenAPIHandler };
@@ -0,0 +1,18 @@
1
+ import { AwsLambdaHandler } from '@orpc/server/aws-lambda';
2
+ import '@orpc/client';
3
+ import '@orpc/contract';
4
+ import '@orpc/shared';
5
+ import { a as StandardOpenAPIHandler } from '../../shared/openapi.BVXcB0u4.mjs';
6
+ import '@orpc/client/standard';
7
+ import '@orpc/server';
8
+ import 'rou3';
9
+ import '@orpc/openapi-client/standard';
10
+ import '@orpc/server/standard';
11
+
12
+ class OpenAPIHandler extends AwsLambdaHandler {
13
+ constructor(router, options = {}) {
14
+ super(new StandardOpenAPIHandler(router, options), options);
15
+ }
16
+ }
17
+
18
+ export { OpenAPIHandler };
@@ -0,0 +1,22 @@
1
+ import { Context, Router } from '@orpc/server';
2
+ import { FetchHandlerOptions, FetchHandler } from '@orpc/server/fetch';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.CQmjvnb0.mjs';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
6
+ import '@orpc/client';
7
+ import '@orpc/shared';
8
+
9
+ interface OpenAPIHandlerOptions<T extends Context> extends FetchHandlerOptions<T>, Omit<StandardOpenAPIHandlerOptions<T>, 'plugins'> {
10
+ }
11
+ /**
12
+ * OpenAPI Handler for Fetch Server
13
+ *
14
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
15
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
16
+ */
17
+ declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
18
+ constructor(router: Router<any, T>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
19
+ }
20
+
21
+ export { OpenAPIHandler };
22
+ export type { OpenAPIHandlerOptions };
@@ -0,0 +1,22 @@
1
+ import { Context, Router } from '@orpc/server';
2
+ import { FetchHandlerOptions, FetchHandler } from '@orpc/server/fetch';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.CQmjvnb0.js';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
6
+ import '@orpc/client';
7
+ import '@orpc/shared';
8
+
9
+ interface OpenAPIHandlerOptions<T extends Context> extends FetchHandlerOptions<T>, Omit<StandardOpenAPIHandlerOptions<T>, 'plugins'> {
10
+ }
11
+ /**
12
+ * OpenAPI Handler for Fetch Server
13
+ *
14
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
15
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
16
+ */
17
+ declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
18
+ constructor(router: Router<any, T>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
19
+ }
20
+
21
+ export { OpenAPIHandler };
22
+ export type { OpenAPIHandlerOptions };
@@ -0,0 +1,18 @@
1
+ import { FetchHandler } from '@orpc/server/fetch';
2
+ import '@orpc/client';
3
+ import '@orpc/contract';
4
+ import '@orpc/shared';
5
+ import { a as StandardOpenAPIHandler } from '../../shared/openapi.BVXcB0u4.mjs';
6
+ import '@orpc/client/standard';
7
+ import '@orpc/server';
8
+ import 'rou3';
9
+ import '@orpc/openapi-client/standard';
10
+ import '@orpc/server/standard';
11
+
12
+ class OpenAPIHandler extends FetchHandler {
13
+ constructor(router, options = {}) {
14
+ super(new StandardOpenAPIHandler(router, options), options);
15
+ }
16
+ }
17
+
18
+ export { OpenAPIHandler };
@@ -0,0 +1,22 @@
1
+ import { Context, Router } from '@orpc/server';
2
+ import { NodeHttpHandlerOptions, NodeHttpHandler } from '@orpc/server/node';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.CQmjvnb0.mjs';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
6
+ import '@orpc/client';
7
+ import '@orpc/shared';
8
+
9
+ interface OpenAPIHandlerOptions<T extends Context> extends NodeHttpHandlerOptions<T>, Omit<StandardOpenAPIHandlerOptions<T>, 'plugins'> {
10
+ }
11
+ /**
12
+ * OpenAPI Handler for Node Server
13
+ *
14
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
15
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
16
+ */
17
+ declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
18
+ constructor(router: Router<any, T>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
19
+ }
20
+
21
+ export { OpenAPIHandler };
22
+ export type { OpenAPIHandlerOptions };
@@ -0,0 +1,22 @@
1
+ import { Context, Router } from '@orpc/server';
2
+ import { NodeHttpHandlerOptions, NodeHttpHandler } from '@orpc/server/node';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.CQmjvnb0.js';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
6
+ import '@orpc/client';
7
+ import '@orpc/shared';
8
+
9
+ interface OpenAPIHandlerOptions<T extends Context> extends NodeHttpHandlerOptions<T>, Omit<StandardOpenAPIHandlerOptions<T>, 'plugins'> {
10
+ }
11
+ /**
12
+ * OpenAPI Handler for Node Server
13
+ *
14
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
15
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
16
+ */
17
+ declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
18
+ constructor(router: Router<any, T>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
19
+ }
20
+
21
+ export { OpenAPIHandler };
22
+ export type { OpenAPIHandlerOptions };
@@ -0,0 +1,18 @@
1
+ import { NodeHttpHandler } from '@orpc/server/node';
2
+ import '@orpc/client';
3
+ import '@orpc/contract';
4
+ import '@orpc/shared';
5
+ import { a as StandardOpenAPIHandler } from '../../shared/openapi.BVXcB0u4.mjs';
6
+ import '@orpc/client/standard';
7
+ import '@orpc/server';
8
+ import 'rou3';
9
+ import '@orpc/openapi-client/standard';
10
+ import '@orpc/server/standard';
11
+
12
+ class OpenAPIHandler extends NodeHttpHandler {
13
+ constructor(router, options = {}) {
14
+ super(new StandardOpenAPIHandler(router, options), options);
15
+ }
16
+ }
17
+
18
+ export { OpenAPIHandler };
@@ -0,0 +1,29 @@
1
+ import { ORPCError, HTTPPath } from '@orpc/client';
2
+ import { StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
3
+ import { AnyProcedure } from '@orpc/server';
4
+ import { StandardCodec, StandardParams } from '@orpc/server/standard';
5
+ import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
6
+ export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions, c as StandardOpenAPIMatcher, b as StandardOpenAPIMatcherOptions } from '../../shared/openapi.CQmjvnb0.mjs';
7
+ import '@orpc/shared';
8
+
9
+ declare class StandardOpenAPICodec implements StandardCodec {
10
+ #private;
11
+ private readonly serializer;
12
+ constructor(serializer: StandardOpenAPISerializer);
13
+ decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
14
+ encode(output: unknown, procedure: AnyProcedure): StandardResponse;
15
+ encodeError(error: ORPCError<any, any>): StandardResponse;
16
+ }
17
+
18
+ /**
19
+ * {@link https://github.com/unjs/rou3}
20
+ *
21
+ * @internal
22
+ */
23
+ declare function toRou3Pattern(path: HTTPPath): string;
24
+ /**
25
+ * @internal
26
+ */
27
+ declare function decodeParams(params: Record<string, string>): Record<string, string>;
28
+
29
+ export { StandardOpenAPICodec, decodeParams, toRou3Pattern };
@@ -0,0 +1,29 @@
1
+ import { ORPCError, HTTPPath } from '@orpc/client';
2
+ import { StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
3
+ import { AnyProcedure } from '@orpc/server';
4
+ import { StandardCodec, StandardParams } from '@orpc/server/standard';
5
+ import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
6
+ export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions, c as StandardOpenAPIMatcher, b as StandardOpenAPIMatcherOptions } from '../../shared/openapi.CQmjvnb0.js';
7
+ import '@orpc/shared';
8
+
9
+ declare class StandardOpenAPICodec implements StandardCodec {
10
+ #private;
11
+ private readonly serializer;
12
+ constructor(serializer: StandardOpenAPISerializer);
13
+ decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
14
+ encode(output: unknown, procedure: AnyProcedure): StandardResponse;
15
+ encodeError(error: ORPCError<any, any>): StandardResponse;
16
+ }
17
+
18
+ /**
19
+ * {@link https://github.com/unjs/rou3}
20
+ *
21
+ * @internal
22
+ */
23
+ declare function toRou3Pattern(path: HTTPPath): string;
24
+ /**
25
+ * @internal
26
+ */
27
+ declare function decodeParams(params: Record<string, string>): Record<string, string>;
28
+
29
+ export { StandardOpenAPICodec, decodeParams, toRou3Pattern };
@@ -0,0 +1,9 @@
1
+ export { S as StandardOpenAPICodec, a as StandardOpenAPIHandler, b as StandardOpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.BVXcB0u4.mjs';
2
+ import '@orpc/openapi-client/standard';
3
+ import '@orpc/server/standard';
4
+ import '@orpc/client';
5
+ import '@orpc/contract';
6
+ import '@orpc/shared';
7
+ import '@orpc/client/standard';
8
+ import '@orpc/server';
9
+ import 'rou3';
@@ -0,0 +1,110 @@
1
+ import { OpenAPI, AnyContractProcedure } from '@orpc/contract';
2
+ export { OpenAPI } from '@orpc/contract';
3
+ export { e as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, c as SchemaConvertOptions, d as SchemaConverter, S as SchemaConverterComponent } from './shared/openapi.CfjfVeBJ.mjs';
4
+ import { HTTPPath, HTTPMethod } from '@orpc/client';
5
+ import { JSONSchema } from '@orpc/interop/json-schema-typed/draft-2020-12';
6
+ export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from '@orpc/interop/json-schema-typed/draft-2020-12';
7
+ import { JsonifiedClient } from '@orpc/openapi-client';
8
+ import { AnyRouter, ClientContext, Lazyable, CreateProcedureClientOptions, InferRouterInitialContext, Schema, ErrorMap, Meta, RouterClient } from '@orpc/server';
9
+ import { MaybeOptionalOptions } from '@orpc/shared';
10
+ import '@orpc/openapi-client/standard';
11
+
12
+ type OverrideOperationValue = Partial<OpenAPI.OperationObject> | ((current: OpenAPI.OperationObject, procedure: AnyContractProcedure) => OpenAPI.OperationObject);
13
+ /**
14
+ * Customize The Operation Object by proxy an error map item or a middleware.
15
+ *
16
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#customizing-operation-objects Customizing Operation Objects Docs}
17
+ */
18
+ declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
19
+ declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
20
+ declare function applyCustomOpenAPIOperation(operation: OpenAPI.OperationObject, contract: AnyContractProcedure): OpenAPI.OperationObject;
21
+
22
+ /**
23
+ * @internal
24
+ */
25
+ type ObjectSchema = JSONSchema & {
26
+ type: 'object';
27
+ } & object;
28
+ /**
29
+ * @internal
30
+ */
31
+ type FileSchema = JSONSchema & {
32
+ type: 'string';
33
+ contentMediaType: string;
34
+ } & object;
35
+ /**
36
+ * @internal
37
+ */
38
+ declare const LOGIC_KEYWORDS: string[];
39
+
40
+ /**
41
+ * @internal
42
+ */
43
+ declare function toOpenAPIPath(path: HTTPPath): string;
44
+ /**
45
+ * @internal
46
+ */
47
+ declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
48
+ /**
49
+ * @internal
50
+ */
51
+ declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPI.MediaTypeObject>;
52
+ /**
53
+ * @internal
54
+ */
55
+ declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPI.MediaTypeObject>;
56
+ /**
57
+ * @internal
58
+ */
59
+ declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPI.ParameterObject[];
60
+ /**
61
+ * @internal
62
+ */
63
+ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
64
+ /**
65
+ * @internal
66
+ */
67
+ declare function toOpenAPISchema(schema: JSONSchema): OpenAPI.SchemaObject & object;
68
+ declare function resolveOpenAPIJsonSchemaRef(doc: OpenAPI.Document, schema: JSONSchema): JSONSchema;
69
+
70
+ declare function createJsonifiedRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>, Schema<unknown, unknown>, ErrorMap, Meta, TClientContext>>): JsonifiedClient<RouterClient<T, TClientContext>>;
71
+
72
+ /**
73
+ *@internal
74
+ */
75
+ declare function isFileSchema(schema: JSONSchema): schema is FileSchema;
76
+ /**
77
+ * @internal
78
+ */
79
+ declare function isObjectSchema(schema: JSONSchema): schema is ObjectSchema;
80
+ /**
81
+ * @internal
82
+ */
83
+ declare function isAnySchema(schema: JSONSchema): boolean;
84
+ /**
85
+ * @internal
86
+ */
87
+ declare function separateObjectSchema(schema: ObjectSchema, separatedProperties: string[]): [matched: ObjectSchema, rest: ObjectSchema];
88
+ /**
89
+ * @internal
90
+ */
91
+ declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
92
+ declare function applySchemaOptionality(required: boolean, schema: JSONSchema): JSONSchema;
93
+ /**
94
+ * Takes a JSON schema and, if it's primarily a union type (anyOf, oneOf),
95
+ * recursively expands it into an array of its constituent, non-union base schemas.
96
+ * If the schema is not a simple union or is a base type, it's returned as a single-element array.
97
+ */
98
+ declare function expandUnionSchema(schema: JSONSchema): JSONSchema[];
99
+ declare function expandArrayableSchema(schema: JSONSchema): undefined | [items: JSONSchema, array: JSONSchema & {
100
+ type: 'array';
101
+ items?: JSONSchema;
102
+ }];
103
+ declare function isPrimitiveSchema(schema: JSONSchema): boolean;
104
+
105
+ declare const oo: {
106
+ spec: typeof customOpenAPIOperation;
107
+ };
108
+
109
+ export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
110
+ export type { FileSchema, ObjectSchema, OverrideOperationValue };
@@ -0,0 +1,110 @@
1
+ import { OpenAPI, AnyContractProcedure } from '@orpc/contract';
2
+ export { OpenAPI } from '@orpc/contract';
3
+ export { e as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, c as SchemaConvertOptions, d as SchemaConverter, S as SchemaConverterComponent } from './shared/openapi.CfjfVeBJ.js';
4
+ import { HTTPPath, HTTPMethod } from '@orpc/client';
5
+ import { JSONSchema } from '@orpc/interop/json-schema-typed/draft-2020-12';
6
+ export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from '@orpc/interop/json-schema-typed/draft-2020-12';
7
+ import { JsonifiedClient } from '@orpc/openapi-client';
8
+ import { AnyRouter, ClientContext, Lazyable, CreateProcedureClientOptions, InferRouterInitialContext, Schema, ErrorMap, Meta, RouterClient } from '@orpc/server';
9
+ import { MaybeOptionalOptions } from '@orpc/shared';
10
+ import '@orpc/openapi-client/standard';
11
+
12
+ type OverrideOperationValue = Partial<OpenAPI.OperationObject> | ((current: OpenAPI.OperationObject, procedure: AnyContractProcedure) => OpenAPI.OperationObject);
13
+ /**
14
+ * Customize The Operation Object by proxy an error map item or a middleware.
15
+ *
16
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#customizing-operation-objects Customizing Operation Objects Docs}
17
+ */
18
+ declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
19
+ declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
20
+ declare function applyCustomOpenAPIOperation(operation: OpenAPI.OperationObject, contract: AnyContractProcedure): OpenAPI.OperationObject;
21
+
22
+ /**
23
+ * @internal
24
+ */
25
+ type ObjectSchema = JSONSchema & {
26
+ type: 'object';
27
+ } & object;
28
+ /**
29
+ * @internal
30
+ */
31
+ type FileSchema = JSONSchema & {
32
+ type: 'string';
33
+ contentMediaType: string;
34
+ } & object;
35
+ /**
36
+ * @internal
37
+ */
38
+ declare const LOGIC_KEYWORDS: string[];
39
+
40
+ /**
41
+ * @internal
42
+ */
43
+ declare function toOpenAPIPath(path: HTTPPath): string;
44
+ /**
45
+ * @internal
46
+ */
47
+ declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
48
+ /**
49
+ * @internal
50
+ */
51
+ declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPI.MediaTypeObject>;
52
+ /**
53
+ * @internal
54
+ */
55
+ declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPI.MediaTypeObject>;
56
+ /**
57
+ * @internal
58
+ */
59
+ declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPI.ParameterObject[];
60
+ /**
61
+ * @internal
62
+ */
63
+ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
64
+ /**
65
+ * @internal
66
+ */
67
+ declare function toOpenAPISchema(schema: JSONSchema): OpenAPI.SchemaObject & object;
68
+ declare function resolveOpenAPIJsonSchemaRef(doc: OpenAPI.Document, schema: JSONSchema): JSONSchema;
69
+
70
+ declare function createJsonifiedRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>, Schema<unknown, unknown>, ErrorMap, Meta, TClientContext>>): JsonifiedClient<RouterClient<T, TClientContext>>;
71
+
72
+ /**
73
+ *@internal
74
+ */
75
+ declare function isFileSchema(schema: JSONSchema): schema is FileSchema;
76
+ /**
77
+ * @internal
78
+ */
79
+ declare function isObjectSchema(schema: JSONSchema): schema is ObjectSchema;
80
+ /**
81
+ * @internal
82
+ */
83
+ declare function isAnySchema(schema: JSONSchema): boolean;
84
+ /**
85
+ * @internal
86
+ */
87
+ declare function separateObjectSchema(schema: ObjectSchema, separatedProperties: string[]): [matched: ObjectSchema, rest: ObjectSchema];
88
+ /**
89
+ * @internal
90
+ */
91
+ declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
92
+ declare function applySchemaOptionality(required: boolean, schema: JSONSchema): JSONSchema;
93
+ /**
94
+ * Takes a JSON schema and, if it's primarily a union type (anyOf, oneOf),
95
+ * recursively expands it into an array of its constituent, non-union base schemas.
96
+ * If the schema is not a simple union or is a base type, it's returned as a single-element array.
97
+ */
98
+ declare function expandUnionSchema(schema: JSONSchema): JSONSchema[];
99
+ declare function expandArrayableSchema(schema: JSONSchema): undefined | [items: JSONSchema, array: JSONSchema & {
100
+ type: 'array';
101
+ items?: JSONSchema;
102
+ }];
103
+ declare function isPrimitiveSchema(schema: JSONSchema): boolean;
104
+
105
+ declare const oo: {
106
+ spec: typeof customOpenAPIOperation;
107
+ };
108
+
109
+ export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
110
+ export type { FileSchema, ObjectSchema, OverrideOperationValue };
package/dist/index.mjs ADDED
@@ -0,0 +1,41 @@
1
+ import { c as customOpenAPIOperation } from './shared/openapi.BlSv9FKY.mjs';
2
+ export { C as CompositeSchemaConverter, L as LOGIC_KEYWORDS, O as OpenAPIGenerator, a as applyCustomOpenAPIOperation, n as applySchemaOptionality, h as checkParamsSchema, p as expandArrayableSchema, o as expandUnionSchema, m as filterSchemaBranches, g as getCustomOpenAPIOperation, l as isAnySchema, j as isFileSchema, k as isObjectSchema, q as isPrimitiveSchema, r as resolveOpenAPIJsonSchemaRef, s as separateObjectSchema, d as toOpenAPIContent, e as toOpenAPIEventIteratorContent, b as toOpenAPIMethod, f as toOpenAPIParameters, t as toOpenAPIPath, i as toOpenAPISchema } from './shared/openapi.BlSv9FKY.mjs';
3
+ import { createORPCErrorFromJson } from '@orpc/client';
4
+ import { StandardOpenAPISerializer, StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer } from '@orpc/openapi-client/standard';
5
+ import { ORPCError, createRouterClient } from '@orpc/server';
6
+ import { resolveMaybeOptionalOptions } from '@orpc/shared';
7
+ export { ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from '@orpc/interop/json-schema-typed/draft-2020-12';
8
+ import '@orpc/client/standard';
9
+ import '@orpc/contract';
10
+
11
+ function createJsonifiedRouterClient(router, ...rest) {
12
+ const options = resolveMaybeOptionalOptions(rest);
13
+ const serializer = new StandardOpenAPISerializer(new StandardOpenAPIJsonSerializer(), new StandardBracketNotationSerializer());
14
+ options.interceptors ??= [];
15
+ options.interceptors.unshift(async (options2) => {
16
+ try {
17
+ return serializer.deserialize(
18
+ serializer.serialize(
19
+ await options2.next()
20
+ )
21
+ );
22
+ } catch (e) {
23
+ if (e instanceof ORPCError) {
24
+ throw createORPCErrorFromJson(serializer.deserialize(
25
+ serializer.serialize(
26
+ e.toJSON(),
27
+ { outputFormat: "plain" }
28
+ )
29
+ ));
30
+ }
31
+ throw e;
32
+ }
33
+ });
34
+ return createRouterClient(router, options);
35
+ }
36
+
37
+ const oo = {
38
+ spec: customOpenAPIOperation
39
+ };
40
+
41
+ export { createJsonifiedRouterClient, customOpenAPIOperation, oo };