@orpc/openapi 0.0.0-next.fd117b2 → 0.0.0-next.fd13879

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 (55) hide show
  1. package/README.md +28 -18
  2. package/dist/adapters/fetch/index.d.mts +17 -0
  3. package/dist/adapters/fetch/index.d.ts +17 -0
  4. package/dist/adapters/fetch/index.mjs +18 -0
  5. package/dist/adapters/node/index.d.mts +17 -0
  6. package/dist/adapters/node/index.d.ts +17 -0
  7. package/dist/adapters/node/index.mjs +18 -0
  8. package/dist/adapters/standard/index.d.mts +35 -0
  9. package/dist/adapters/standard/index.d.ts +35 -0
  10. package/dist/adapters/standard/index.mjs +9 -0
  11. package/dist/index.d.mts +105 -0
  12. package/dist/index.d.ts +105 -0
  13. package/dist/index.mjs +41 -0
  14. package/dist/plugins/index.d.mts +70 -0
  15. package/dist/plugins/index.d.ts +70 -0
  16. package/dist/plugins/index.mjs +108 -0
  17. package/dist/{chunk-PGCWJMRO.js → shared/openapi.C_UtQ8Us.mjs} +65 -43
  18. package/dist/shared/openapi.CwdCLgSU.d.mts +53 -0
  19. package/dist/shared/openapi.CwdCLgSU.d.ts +53 -0
  20. package/dist/shared/openapi.D3j94c9n.d.mts +12 -0
  21. package/dist/shared/openapi.D3j94c9n.d.ts +12 -0
  22. package/dist/shared/openapi.PDTdnRIU.mjs +595 -0
  23. package/package.json +28 -39
  24. package/dist/chunk-ATDLVTJE.js +0 -32
  25. package/dist/chunk-XGHV4TH3.js +0 -13
  26. package/dist/fetch.js +0 -9
  27. package/dist/hono.js +0 -9
  28. package/dist/index.js +0 -701
  29. package/dist/next.js +0 -9
  30. package/dist/node.js +0 -30
  31. package/dist/src/adapters/fetch/index.d.ts +0 -2
  32. package/dist/src/adapters/fetch/openapi-handler.d.ts +0 -11
  33. package/dist/src/adapters/hono/index.d.ts +0 -2
  34. package/dist/src/adapters/next/index.d.ts +0 -2
  35. package/dist/src/adapters/node/index.d.ts +0 -2
  36. package/dist/src/adapters/node/openapi-handler.d.ts +0 -11
  37. package/dist/src/adapters/standard/index.d.ts +0 -4
  38. package/dist/src/adapters/standard/openapi-codec.d.ts +0 -13
  39. package/dist/src/adapters/standard/openapi-handler.d.ts +0 -5
  40. package/dist/src/adapters/standard/openapi-matcher.d.ts +0 -10
  41. package/dist/src/index.d.ts +0 -16
  42. package/dist/src/openapi-content-builder.d.ts +0 -10
  43. package/dist/src/openapi-error.d.ts +0 -3
  44. package/dist/src/openapi-generator.d.ts +0 -67
  45. package/dist/src/openapi-input-structure-parser.d.ts +0 -22
  46. package/dist/src/openapi-operation-extender.d.ts +0 -7
  47. package/dist/src/openapi-output-structure-parser.d.ts +0 -18
  48. package/dist/src/openapi-parameters-builder.d.ts +0 -12
  49. package/dist/src/openapi-path-parser.d.ts +0 -8
  50. package/dist/src/openapi.d.ts +0 -3
  51. package/dist/src/schema-converter.d.ts +0 -16
  52. package/dist/src/schema-utils.d.ts +0 -11
  53. package/dist/src/schema.d.ts +0 -12
  54. package/dist/src/utils.d.ts +0 -4
  55. package/dist/standard.js +0 -10
package/README.md CHANGED
@@ -1,5 +1,5 @@
1
1
  <div align="center">
2
- <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
2
+ <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
3
3
  </div>
4
4
 
5
5
  <h1></h1>
@@ -21,28 +21,24 @@
21
21
 
22
22
  <h3 align="center">Typesafe APIs Made Simple 🪄</h3>
23
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, ensuring a smooth and enjoyable developer experience.
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
25
 
26
26
  ---
27
27
 
28
28
  ## Highlights
29
29
 
30
- - **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
31
- - **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
32
- - **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
33
- - **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
34
- - **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
35
- - **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue), Pinia Colada, and more.
36
- - **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
37
- - **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
38
- - **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
39
- - **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
40
- - **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
41
- - **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
42
- - **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
43
- - **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
44
- - **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
45
- - **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
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
+ - **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
34
+ - **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
35
+ - **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
36
+ - **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
37
+ - **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
38
+ - **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
39
+ - **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
40
+ - **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
41
+ - **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
46
42
 
47
43
  ## Documentation
48
44
 
@@ -53,11 +49,17 @@ You can find the full documentation [here](https://orpc.unnoq.com).
53
49
  - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
54
50
  - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
55
51
  - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
52
+ - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with NestJS.
53
+ - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
56
54
  - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
57
55
  - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
56
+ - [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
57
+ - [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
58
58
  - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
59
59
  - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
60
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/).
61
63
 
62
64
  ## `@orpc/openapi`
63
65
 
@@ -86,6 +88,14 @@ const server = createServer(async (req, res) => {
86
88
  server.listen(3000, '127.0.0.1', () => console.log('Listening on 127.0.0.1:3000'))
87
89
  ```
88
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
+
89
99
  ## License
90
100
 
91
101
  Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
@@ -0,0 +1,17 @@
1
+ import { Context, Router } from '@orpc/server';
2
+ import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.mjs';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
6
+
7
+ /**
8
+ * OpenAPI Handler for Fetch Server
9
+ *
10
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
11
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
12
+ */
13
+ declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
14
+ constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & FetchHandlerOptions<T>>);
15
+ }
16
+
17
+ export { OpenAPIHandler };
@@ -0,0 +1,17 @@
1
+ import { Context, Router } from '@orpc/server';
2
+ import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.js';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
6
+
7
+ /**
8
+ * OpenAPI Handler for Fetch Server
9
+ *
10
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
11
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
12
+ */
13
+ declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
14
+ constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & FetchHandlerOptions<T>>);
15
+ }
16
+
17
+ export { OpenAPIHandler };
@@ -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.C_UtQ8Us.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,17 @@
1
+ import { Context, Router } from '@orpc/server';
2
+ import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.mjs';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
6
+
7
+ /**
8
+ * OpenAPI Handler for Node Server
9
+ *
10
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
11
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
12
+ */
13
+ declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
14
+ constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & NodeHttpHandlerOptions<T>>);
15
+ }
16
+
17
+ export { OpenAPIHandler };
@@ -0,0 +1,17 @@
1
+ import { Context, Router } from '@orpc/server';
2
+ import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.js';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
6
+
7
+ /**
8
+ * OpenAPI Handler for Node Server
9
+ *
10
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
11
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
12
+ */
13
+ declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
14
+ constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & NodeHttpHandlerOptions<T>>);
15
+ }
16
+
17
+ export { OpenAPIHandler };
@@ -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.C_UtQ8Us.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,35 @@
1
+ import { ORPCError, HTTPPath } from '@orpc/client';
2
+ import { StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
3
+ import { AnyProcedure, AnyRouter } from '@orpc/server';
4
+ import { StandardCodec, StandardParams, StandardMatcher, StandardMatchResult } from '@orpc/server/standard';
5
+ import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
6
+ export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.mjs';
7
+
8
+ declare class StandardOpenAPICodec implements StandardCodec {
9
+ #private;
10
+ private readonly serializer;
11
+ constructor(serializer: StandardOpenAPISerializer);
12
+ decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
13
+ encode(output: unknown, procedure: AnyProcedure): StandardResponse;
14
+ encodeError(error: ORPCError<any, any>): StandardResponse;
15
+ }
16
+
17
+ declare class StandardOpenAPIMatcher implements StandardMatcher {
18
+ private readonly tree;
19
+ private pendingRouters;
20
+ init(router: AnyRouter, path?: readonly string[]): void;
21
+ match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
22
+ }
23
+
24
+ /**
25
+ * {@link https://github.com/unjs/rou3}
26
+ *
27
+ * @internal
28
+ */
29
+ declare function toRou3Pattern(path: HTTPPath): string;
30
+ /**
31
+ * @internal
32
+ */
33
+ declare function decodeParams(params: Record<string, string>): Record<string, string>;
34
+
35
+ export { StandardOpenAPICodec, StandardOpenAPIMatcher, decodeParams, toRou3Pattern };
@@ -0,0 +1,35 @@
1
+ import { ORPCError, HTTPPath } from '@orpc/client';
2
+ import { StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
3
+ import { AnyProcedure, AnyRouter } from '@orpc/server';
4
+ import { StandardCodec, StandardParams, StandardMatcher, StandardMatchResult } from '@orpc/server/standard';
5
+ import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
6
+ export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.js';
7
+
8
+ declare class StandardOpenAPICodec implements StandardCodec {
9
+ #private;
10
+ private readonly serializer;
11
+ constructor(serializer: StandardOpenAPISerializer);
12
+ decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
13
+ encode(output: unknown, procedure: AnyProcedure): StandardResponse;
14
+ encodeError(error: ORPCError<any, any>): StandardResponse;
15
+ }
16
+
17
+ declare class StandardOpenAPIMatcher implements StandardMatcher {
18
+ private readonly tree;
19
+ private pendingRouters;
20
+ init(router: AnyRouter, path?: readonly string[]): void;
21
+ match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
22
+ }
23
+
24
+ /**
25
+ * {@link https://github.com/unjs/rou3}
26
+ *
27
+ * @internal
28
+ */
29
+ declare function toRou3Pattern(path: HTTPPath): string;
30
+ /**
31
+ * @internal
32
+ */
33
+ declare function decodeParams(params: Record<string, string>): Record<string, string>;
34
+
35
+ export { StandardOpenAPICodec, StandardOpenAPIMatcher, 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.C_UtQ8Us.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,105 @@
1
+ import { AnyContractProcedure } from '@orpc/contract';
2
+ import { OpenAPIV3_1 } from 'openapi-types';
3
+ export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
4
+ export { d as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, S as SchemaConvertOptions, c as SchemaConverter } from './shared/openapi.CwdCLgSU.mjs';
5
+ import { HTTPPath, HTTPMethod } from '@orpc/client';
6
+ import { JSONSchema } from 'json-schema-typed/draft-2020-12';
7
+ export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
8
+ import { JsonifiedClient } from '@orpc/openapi-client';
9
+ import { AnyRouter, ClientContext, Lazyable, CreateProcedureClientOptions, InferRouterInitialContext, Schema, ErrorMap, Meta, RouterClient } from '@orpc/server';
10
+ import { MaybeOptionalOptions } from '@orpc/shared';
11
+ import '@orpc/openapi-client/standard';
12
+
13
+ type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
14
+ /**
15
+ * Customize The Operation Object by proxy an error map item or a middleware.
16
+ *
17
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#customizing-operation-objects Customizing Operation Objects Docs}
18
+ */
19
+ declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
20
+ declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
21
+ declare function applyCustomOpenAPIOperation(operation: OpenAPIV3_1.OperationObject, contract: AnyContractProcedure): OpenAPIV3_1.OperationObject;
22
+
23
+ /**
24
+ * @internal
25
+ */
26
+ type ObjectSchema = JSONSchema & {
27
+ type: 'object';
28
+ } & object;
29
+ /**
30
+ * @internal
31
+ */
32
+ type FileSchema = JSONSchema & {
33
+ type: 'string';
34
+ contentMediaType: string;
35
+ } & object;
36
+ /**
37
+ * @internal
38
+ */
39
+ declare const LOGIC_KEYWORDS: string[];
40
+
41
+ /**
42
+ * @internal
43
+ */
44
+ declare function toOpenAPIPath(path: HTTPPath): string;
45
+ /**
46
+ * @internal
47
+ */
48
+ declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
49
+ /**
50
+ * @internal
51
+ */
52
+ declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPIV3_1.MediaTypeObject>;
53
+ /**
54
+ * @internal
55
+ */
56
+ declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPIV3_1.MediaTypeObject>;
57
+ /**
58
+ * @internal
59
+ */
60
+ declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPIV3_1.ParameterObject[];
61
+ /**
62
+ * @internal
63
+ */
64
+ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
65
+ /**
66
+ * @internal
67
+ */
68
+ declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
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
+
100
+ declare const oo: {
101
+ spec: typeof customOpenAPIOperation;
102
+ };
103
+
104
+ export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
105
+ export type { FileSchema, ObjectSchema, OverrideOperationValue };
@@ -0,0 +1,105 @@
1
+ import { AnyContractProcedure } from '@orpc/contract';
2
+ import { OpenAPIV3_1 } from 'openapi-types';
3
+ export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
4
+ export { d as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, S as SchemaConvertOptions, c as SchemaConverter } from './shared/openapi.CwdCLgSU.js';
5
+ import { HTTPPath, HTTPMethod } from '@orpc/client';
6
+ import { JSONSchema } from 'json-schema-typed/draft-2020-12';
7
+ export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
8
+ import { JsonifiedClient } from '@orpc/openapi-client';
9
+ import { AnyRouter, ClientContext, Lazyable, CreateProcedureClientOptions, InferRouterInitialContext, Schema, ErrorMap, Meta, RouterClient } from '@orpc/server';
10
+ import { MaybeOptionalOptions } from '@orpc/shared';
11
+ import '@orpc/openapi-client/standard';
12
+
13
+ type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
14
+ /**
15
+ * Customize The Operation Object by proxy an error map item or a middleware.
16
+ *
17
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#customizing-operation-objects Customizing Operation Objects Docs}
18
+ */
19
+ declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
20
+ declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
21
+ declare function applyCustomOpenAPIOperation(operation: OpenAPIV3_1.OperationObject, contract: AnyContractProcedure): OpenAPIV3_1.OperationObject;
22
+
23
+ /**
24
+ * @internal
25
+ */
26
+ type ObjectSchema = JSONSchema & {
27
+ type: 'object';
28
+ } & object;
29
+ /**
30
+ * @internal
31
+ */
32
+ type FileSchema = JSONSchema & {
33
+ type: 'string';
34
+ contentMediaType: string;
35
+ } & object;
36
+ /**
37
+ * @internal
38
+ */
39
+ declare const LOGIC_KEYWORDS: string[];
40
+
41
+ /**
42
+ * @internal
43
+ */
44
+ declare function toOpenAPIPath(path: HTTPPath): string;
45
+ /**
46
+ * @internal
47
+ */
48
+ declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
49
+ /**
50
+ * @internal
51
+ */
52
+ declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPIV3_1.MediaTypeObject>;
53
+ /**
54
+ * @internal
55
+ */
56
+ declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPIV3_1.MediaTypeObject>;
57
+ /**
58
+ * @internal
59
+ */
60
+ declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPIV3_1.ParameterObject[];
61
+ /**
62
+ * @internal
63
+ */
64
+ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
65
+ /**
66
+ * @internal
67
+ */
68
+ declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
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
+
100
+ declare const oo: {
101
+ spec: typeof customOpenAPIOperation;
102
+ };
103
+
104
+ export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
105
+ export type { FileSchema, ObjectSchema, OverrideOperationValue };
package/dist/index.mjs ADDED
@@ -0,0 +1,41 @@
1
+ import { c as customOpenAPIOperation } from './shared/openapi.PDTdnRIU.mjs';
2
+ export { C as CompositeSchemaConverter, L as LOGIC_KEYWORDS, O as OpenAPIGenerator, a as applyCustomOpenAPIOperation, n as applySchemaOptionality, h as checkParamsSchema, o as expandUnionSchema, m as filterSchemaBranches, g as getCustomOpenAPIOperation, l as isAnySchema, j as isFileSchema, k as isObjectSchema, s as separateObjectSchema, d as toOpenAPIContent, e as toOpenAPIEventIteratorContent, b as toOpenAPIMethod, f as toOpenAPIParameters, t as toOpenAPIPath, i as toOpenAPISchema } from './shared/openapi.PDTdnRIU.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 } from '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 };
@@ -0,0 +1,70 @@
1
+ import { Context, HTTPPath, Router } from '@orpc/server';
2
+ import { StandardHandlerInterceptorOptions, StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
3
+ import { Value } from '@orpc/shared';
4
+ import { OpenAPIV3_1 } from 'openapi-types';
5
+ import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.CwdCLgSU.mjs';
6
+ import '@orpc/contract';
7
+ import '@orpc/openapi-client/standard';
8
+ import 'json-schema-typed/draft-2020-12';
9
+
10
+ interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGeneratorOptions {
11
+ /**
12
+ * Options to pass to the OpenAPI generate.
13
+ *
14
+ */
15
+ specGenerateOptions?: Value<OpenAPIGeneratorGenerateOptions, [StandardHandlerInterceptorOptions<T>]>;
16
+ /**
17
+ * The URL path at which to serve the OpenAPI JSON.
18
+ *
19
+ * @default '/spec.json'
20
+ */
21
+ specPath?: HTTPPath;
22
+ /**
23
+ * The URL path at which to serve the API reference UI.
24
+ *
25
+ * @default '/'
26
+ */
27
+ docsPath?: HTTPPath;
28
+ /**
29
+ * The document title for the API reference UI.
30
+ *
31
+ * @default 'API Reference'
32
+ */
33
+ docsTitle?: Value<string, [StandardHandlerInterceptorOptions<T>]>;
34
+ /**
35
+ * Arbitrary configuration object for the UI.
36
+ */
37
+ docsConfig?: Value<Record<string, unknown>, [StandardHandlerInterceptorOptions<T>]>;
38
+ /**
39
+ * HTML to inject into the <head> of the docs page.
40
+ *
41
+ * @default ''
42
+ */
43
+ docsHead?: Value<string, [StandardHandlerInterceptorOptions<T>]>;
44
+ /**
45
+ * URL of the external script bundle for the reference UI.
46
+ *
47
+ * @default 'https://cdn.jsdelivr.net/npm/@scalar/api-reference'
48
+ */
49
+ docsScriptUrl?: Value<string, [StandardHandlerInterceptorOptions<T>]>;
50
+ /**
51
+ * Override function to generate the full HTML for the docs page.
52
+ */
53
+ renderDocsHtml?: (specUrl: string, title: string, head: string, scriptUrl: string, config: Record<string, unknown> | undefined, spec: OpenAPIV3_1.Document) => string;
54
+ }
55
+ declare class OpenAPIReferencePlugin<T extends Context> implements StandardHandlerPlugin<T> {
56
+ private readonly generator;
57
+ private readonly specGenerateOptions;
58
+ private readonly specPath;
59
+ private readonly docsPath;
60
+ private readonly docsTitle;
61
+ private readonly docsHead;
62
+ private readonly docsScriptUrl;
63
+ private readonly docsConfig;
64
+ private readonly renderDocsHtml;
65
+ constructor(options?: OpenAPIReferencePluginOptions<T>);
66
+ init(options: StandardHandlerOptions<T>, router: Router<any, T>): void;
67
+ }
68
+
69
+ export { OpenAPIReferencePlugin };
70
+ export type { OpenAPIReferencePluginOptions };