@orpc/openapi 0.0.0-next.ff5907c → 0.0.0-next.ff7ad2e

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 (58) 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 +19 -0
  6. package/dist/adapters/fetch/index.d.ts +19 -0
  7. package/dist/adapters/fetch/index.mjs +18 -0
  8. package/dist/adapters/node/index.d.mts +19 -0
  9. package/dist/adapters/node/index.d.ts +19 -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 +69 -0
  18. package/dist/plugins/index.d.ts +69 -0
  19. package/dist/plugins/index.mjs +108 -0
  20. package/dist/shared/openapi.1iT1iSZi.mjs +750 -0
  21. package/dist/{chunk-LPBZEW4B.js → shared/openapi.BVXcB0u4.mjs} +72 -50
  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 +32 -39
  27. package/dist/chunk-UU2TTVB2.js +0 -32
  28. package/dist/chunk-XGHV4TH3.js +0 -13
  29. package/dist/fetch.js +0 -9
  30. package/dist/hono.js +0 -9
  31. package/dist/index.js +0 -701
  32. package/dist/next.js +0 -9
  33. package/dist/node.js +0 -30
  34. package/dist/src/adapters/fetch/index.d.ts +0 -2
  35. package/dist/src/adapters/fetch/openapi-handler.d.ts +0 -11
  36. package/dist/src/adapters/hono/index.d.ts +0 -2
  37. package/dist/src/adapters/next/index.d.ts +0 -2
  38. package/dist/src/adapters/node/index.d.ts +0 -2
  39. package/dist/src/adapters/node/openapi-handler.d.ts +0 -11
  40. package/dist/src/adapters/standard/index.d.ts +0 -4
  41. package/dist/src/adapters/standard/openapi-codec.d.ts +0 -16
  42. package/dist/src/adapters/standard/openapi-handler.d.ts +0 -7
  43. package/dist/src/adapters/standard/openapi-matcher.d.ts +0 -20
  44. package/dist/src/index.d.ts +0 -16
  45. package/dist/src/openapi-content-builder.d.ts +0 -10
  46. package/dist/src/openapi-error.d.ts +0 -3
  47. package/dist/src/openapi-generator.d.ts +0 -67
  48. package/dist/src/openapi-input-structure-parser.d.ts +0 -22
  49. package/dist/src/openapi-operation-extender.d.ts +0 -7
  50. package/dist/src/openapi-output-structure-parser.d.ts +0 -18
  51. package/dist/src/openapi-parameters-builder.d.ts +0 -12
  52. package/dist/src/openapi-path-parser.d.ts +0 -8
  53. package/dist/src/openapi.d.ts +0 -3
  54. package/dist/src/schema-converter.d.ts +0 -16
  55. package/dist/src/schema-utils.d.ts +0 -11
  56. package/dist/src/schema.d.ts +0 -12
  57. package/dist/src/utils.d.ts +0 -4
  58. package/dist/standard.js +0 -10
@@ -1,15 +1,15 @@
1
- import {
2
- standardizeHTTPPath
3
- } from "./chunk-XGHV4TH3.js";
1
+ import { standardizeHTTPPath, StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer, StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
2
+ import { StandardHandler } from '@orpc/server/standard';
3
+ import { isORPCErrorStatus } from '@orpc/client';
4
+ import { fallbackContractConfig } from '@orpc/contract';
5
+ import { isObject, stringifyJSON, tryDecodeURIComponent, value } from '@orpc/shared';
6
+ import { toHttpPath } from '@orpc/client/standard';
7
+ import { traverseContractProcedures, isProcedure, getLazyMeta, unlazy, getRouter, createContractedProcedure } from '@orpc/server';
8
+ import { createRouter, addRoute, findRoute } from 'rou3';
4
9
 
5
- // src/adapters/standard/openapi-codec.ts
6
- import { OpenAPISerializer } from "@orpc/client/openapi";
7
- import { fallbackContractConfig } from "@orpc/contract";
8
- import { isObject } from "@orpc/shared";
9
- var OpenAPICodec = class {
10
- serializer;
11
- constructor(options) {
12
- this.serializer = options?.serializer ?? new OpenAPISerializer();
10
+ class StandardOpenAPICodec {
11
+ constructor(serializer) {
12
+ this.serializer = serializer;
13
13
  }
14
14
  async decode(request, params, procedure) {
15
15
  const inputStructure = fallbackContractConfig("defaultInputStructure", procedure["~orpc"].route.inputStructure);
@@ -53,13 +53,21 @@ var OpenAPICodec = class {
53
53
  body: this.serializer.serialize(output)
54
54
  };
55
55
  }
56
- if (!isObject(output)) {
57
- throw new Error(
58
- 'Invalid output structure for "detailed" output. Expected format: { body: any, headers?: Record<string, string | string[] | undefined> }'
59
- );
56
+ if (!this.#isDetailedOutput(output)) {
57
+ throw new Error(`
58
+ Invalid "detailed" output structure:
59
+ \u2022 Expected an object with optional properties:
60
+ - status (number 200-399)
61
+ - headers (Record<string, string | string[]>)
62
+ - body (any)
63
+ \u2022 No extra keys allowed.
64
+
65
+ Actual value:
66
+ ${stringifyJSON(output)}
67
+ `);
60
68
  }
61
69
  return {
62
- status: successStatus,
70
+ status: output.status ?? successStatus,
63
71
  headers: output.headers ?? {},
64
72
  body: this.serializer.serialize(output.body)
65
73
  };
@@ -68,32 +76,45 @@ var OpenAPICodec = class {
68
76
  return {
69
77
  status: error.status,
70
78
  headers: {},
71
- body: this.serializer.serialize(error.toJSON())
79
+ body: this.serializer.serialize(error.toJSON(), { outputFormat: "plain" })
72
80
  };
73
81
  }
74
- };
82
+ #isDetailedOutput(output) {
83
+ if (!isObject(output)) {
84
+ return false;
85
+ }
86
+ if (output.headers && !isObject(output.headers)) {
87
+ return false;
88
+ }
89
+ if (output.status !== void 0 && (typeof output.status !== "number" || !Number.isInteger(output.status) || isORPCErrorStatus(output.status))) {
90
+ return false;
91
+ }
92
+ return true;
93
+ }
94
+ }
75
95
 
76
- // src/adapters/standard/openapi-matcher.ts
77
- import { fallbackContractConfig as fallbackContractConfig2 } from "@orpc/contract";
78
- import { convertPathToHttpPath, createContractedProcedure, eachContractProcedure, getLazyRouterPrefix, getRouterChild, isProcedure, unlazy } from "@orpc/server";
79
- import { addRoute, createRouter, findRoute } from "rou3";
80
- var OpenAPIMatcher = class {
96
+ function toRou3Pattern(path) {
97
+ return standardizeHTTPPath(path).replace(/\/\{\+([^}]+)\}/g, "/**:$1").replace(/\/\{([^}]+)\}/g, "/:$1");
98
+ }
99
+ function decodeParams(params) {
100
+ return Object.fromEntries(Object.entries(params).map(([key, value]) => [key, tryDecodeURIComponent(value)]));
101
+ }
102
+
103
+ class StandardOpenAPIMatcher {
104
+ filter;
81
105
  tree = createRouter();
82
- ignoreUndefinedMethod;
83
- constructor(options) {
84
- this.ignoreUndefinedMethod = options?.ignoreUndefinedMethod ?? false;
85
- }
86
106
  pendingRouters = [];
107
+ constructor(options = {}) {
108
+ this.filter = options.filter ?? true;
109
+ }
87
110
  init(router, path = []) {
88
- const laziedOptions = eachContractProcedure({
89
- router,
90
- path
91
- }, ({ path: path2, contract }) => {
92
- if (!contract["~orpc"].route.method && this.ignoreUndefinedMethod) {
111
+ const laziedOptions = traverseContractProcedures({ router, path }, (traverseOptions) => {
112
+ if (!value(this.filter, traverseOptions)) {
93
113
  return;
94
114
  }
95
- const method = fallbackContractConfig2("defaultMethod", contract["~orpc"].route.method);
96
- const httpPath = contract["~orpc"].route.path ? toRou3Pattern(contract["~orpc"].route.path) : convertPathToHttpPath(path2);
115
+ const { path: path2, contract } = traverseOptions;
116
+ const method = fallbackContractConfig("defaultMethod", contract["~orpc"].route.method);
117
+ const httpPath = toRou3Pattern(contract["~orpc"].route.path ?? toHttpPath(path2));
97
118
  if (isProcedure(contract)) {
98
119
  addRoute(this.tree, method, httpPath, {
99
120
  path: path2,
@@ -113,8 +134,8 @@ var OpenAPIMatcher = class {
113
134
  });
114
135
  this.pendingRouters.push(...laziedOptions.map((option) => ({
115
136
  ...option,
116
- httpPathPrefix: convertPathToHttpPath(option.path),
117
- laziedPrefix: getLazyRouterPrefix(option.lazied)
137
+ httpPathPrefix: toHttpPath(option.path),
138
+ laziedPrefix: getLazyMeta(option.router).prefix
118
139
  })));
119
140
  }
120
141
  async match(method, pathname) {
@@ -122,7 +143,7 @@ var OpenAPIMatcher = class {
122
143
  const newPendingRouters = [];
123
144
  for (const pendingRouter of this.pendingRouters) {
124
145
  if (!pendingRouter.laziedPrefix || pathname.startsWith(pendingRouter.laziedPrefix) || pathname.startsWith(pendingRouter.httpPathPrefix)) {
125
- const { default: router } = await unlazy(pendingRouter.lazied);
146
+ const { default: router } = await unlazy(pendingRouter.router);
126
147
  this.init(router, pendingRouter.path);
127
148
  } else {
128
149
  newPendingRouters.push(pendingRouter);
@@ -135,14 +156,14 @@ var OpenAPIMatcher = class {
135
156
  return void 0;
136
157
  }
137
158
  if (!match.data.procedure) {
138
- const { default: maybeProcedure } = await unlazy(getRouterChild(match.data.router, ...match.data.path));
159
+ const { default: maybeProcedure } = await unlazy(getRouter(match.data.router, match.data.path));
139
160
  if (!isProcedure(maybeProcedure)) {
140
161
  throw new Error(`
141
- [Contract-First] Missing or invalid implementation for procedure at path: ${convertPathToHttpPath(match.data.path)}.
162
+ [Contract-First] Missing or invalid implementation for procedure at path: ${toHttpPath(match.data.path)}.
142
163
  Ensure that the procedure is correctly defined and matches the expected contract.
143
164
  `);
144
165
  }
145
- match.data.procedure = createContractedProcedure(match.data.contract, maybeProcedure);
166
+ match.data.procedure = createContractedProcedure(maybeProcedure, match.data.contract);
146
167
  }
147
168
  return {
148
169
  path: match.data.path,
@@ -150,16 +171,17 @@ var OpenAPIMatcher = class {
150
171
  params: match.params ? decodeParams(match.params) : void 0
151
172
  };
152
173
  }
153
- };
154
- function toRou3Pattern(path) {
155
- return standardizeHTTPPath(path).replace(/\{\+([^}]+)\}/g, "**:$1").replace(/\{([^}]+)\}/g, ":$1");
156
174
  }
157
- function decodeParams(params) {
158
- return Object.fromEntries(Object.entries(params).map(([key, value]) => [key, decodeURIComponent(value)]));
175
+
176
+ class StandardOpenAPIHandler extends StandardHandler {
177
+ constructor(router, options) {
178
+ const jsonSerializer = new StandardOpenAPIJsonSerializer(options);
179
+ const bracketNotationSerializer = new StandardBracketNotationSerializer(options);
180
+ const serializer = new StandardOpenAPISerializer(jsonSerializer, bracketNotationSerializer);
181
+ const matcher = new StandardOpenAPIMatcher(options);
182
+ const codec = new StandardOpenAPICodec(serializer);
183
+ super(router, matcher, codec, options);
184
+ }
159
185
  }
160
186
 
161
- export {
162
- OpenAPICodec,
163
- OpenAPIMatcher
164
- };
165
- //# sourceMappingURL=chunk-LPBZEW4B.js.map
187
+ export { StandardOpenAPICodec as S, StandardOpenAPIHandler as a, StandardOpenAPIMatcher as b, decodeParams as d, toRou3Pattern as t };
@@ -0,0 +1,31 @@
1
+ import { StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions } from '@orpc/openapi-client/standard';
2
+ import { TraverseContractProcedureCallbackOptions, AnyRouter, Context, Router } from '@orpc/server';
3
+ import { StandardMatcher, StandardMatchResult, StandardHandlerOptions, StandardHandler } from '@orpc/server/standard';
4
+ import { HTTPPath } from '@orpc/client';
5
+ import { Value } from '@orpc/shared';
6
+
7
+ interface StandardOpenAPIMatcherOptions {
8
+ /**
9
+ * Filter procedures. Return `false` to exclude a procedure from matching.
10
+ *
11
+ * @default true
12
+ */
13
+ filter?: Value<boolean, [options: TraverseContractProcedureCallbackOptions]>;
14
+ }
15
+ declare class StandardOpenAPIMatcher implements StandardMatcher {
16
+ private readonly filter;
17
+ private readonly tree;
18
+ private pendingRouters;
19
+ constructor(options?: StandardOpenAPIMatcherOptions);
20
+ init(router: AnyRouter, path?: readonly string[]): void;
21
+ match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
22
+ }
23
+
24
+ interface StandardOpenAPIHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions, StandardOpenAPIMatcherOptions {
25
+ }
26
+ declare class StandardOpenAPIHandler<T extends Context> extends StandardHandler<T> {
27
+ constructor(router: Router<any, T>, options: NoInfer<StandardOpenAPIHandlerOptions<T>>);
28
+ }
29
+
30
+ export { StandardOpenAPIHandler as a, StandardOpenAPIMatcher as c };
31
+ export type { StandardOpenAPIHandlerOptions as S, StandardOpenAPIMatcherOptions as b };
@@ -0,0 +1,31 @@
1
+ import { StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions } from '@orpc/openapi-client/standard';
2
+ import { TraverseContractProcedureCallbackOptions, AnyRouter, Context, Router } from '@orpc/server';
3
+ import { StandardMatcher, StandardMatchResult, StandardHandlerOptions, StandardHandler } from '@orpc/server/standard';
4
+ import { HTTPPath } from '@orpc/client';
5
+ import { Value } from '@orpc/shared';
6
+
7
+ interface StandardOpenAPIMatcherOptions {
8
+ /**
9
+ * Filter procedures. Return `false` to exclude a procedure from matching.
10
+ *
11
+ * @default true
12
+ */
13
+ filter?: Value<boolean, [options: TraverseContractProcedureCallbackOptions]>;
14
+ }
15
+ declare class StandardOpenAPIMatcher implements StandardMatcher {
16
+ private readonly filter;
17
+ private readonly tree;
18
+ private pendingRouters;
19
+ constructor(options?: StandardOpenAPIMatcherOptions);
20
+ init(router: AnyRouter, path?: readonly string[]): void;
21
+ match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
22
+ }
23
+
24
+ interface StandardOpenAPIHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions, StandardOpenAPIMatcherOptions {
25
+ }
26
+ declare class StandardOpenAPIHandler<T extends Context> extends StandardHandler<T> {
27
+ constructor(router: Router<any, T>, options: NoInfer<StandardOpenAPIHandlerOptions<T>>);
28
+ }
29
+
30
+ export { StandardOpenAPIHandler as a, StandardOpenAPIMatcher as c };
31
+ export type { StandardOpenAPIHandlerOptions as S, StandardOpenAPIMatcherOptions as b };
@@ -0,0 +1,108 @@
1
+ import { AnySchema, OpenAPI, AnyContractProcedure, AnyContractRouter } from '@orpc/contract';
2
+ import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
3
+ import { AnyProcedure, TraverseContractProcedureCallbackOptions, AnyRouter } from '@orpc/server';
4
+ import { Promisable, Value } from '@orpc/shared';
5
+ import { JSONSchema } from '@orpc/interop/json-schema-typed/draft-2020-12';
6
+
7
+ interface SchemaConverterComponent {
8
+ allowedStrategies: readonly SchemaConvertOptions['strategy'][];
9
+ schema: AnySchema;
10
+ required: boolean;
11
+ ref: string;
12
+ }
13
+ interface SchemaConvertOptions {
14
+ strategy: 'input' | 'output';
15
+ /**
16
+ * Common components should use `$ref` to represent themselves if matched.
17
+ */
18
+ components?: readonly SchemaConverterComponent[];
19
+ /**
20
+ * Minimum schema structure depth required before using `$ref` for components.
21
+ *
22
+ * For example, if set to 2, `$ref` will only be used for schemas nested at depth 2 or greater.
23
+ *
24
+ * @default 0 - No depth limit;
25
+ */
26
+ minStructureDepthForRef?: number;
27
+ }
28
+ interface SchemaConverter {
29
+ convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
30
+ }
31
+ interface ConditionalSchemaConverter extends SchemaConverter {
32
+ condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
33
+ }
34
+ declare class CompositeSchemaConverter implements SchemaConverter {
35
+ private readonly converters;
36
+ constructor(converters: readonly ConditionalSchemaConverter[]);
37
+ convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
38
+ }
39
+
40
+ interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
41
+ schemaConverters?: ConditionalSchemaConverter[];
42
+ }
43
+ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document, 'openapi'>> {
44
+ /**
45
+ * Exclude procedures from the OpenAPI specification.
46
+ *
47
+ * @deprecated Use `filter` option instead.
48
+ * @default () => false
49
+ */
50
+ exclude?: (procedure: AnyProcedure | AnyContractProcedure, path: readonly string[]) => boolean;
51
+ /**
52
+ * Filter procedures. Return `false` to exclude a procedure from the OpenAPI specification.
53
+ *
54
+ * @default true
55
+ */
56
+ filter?: Value<boolean, [options: TraverseContractProcedureCallbackOptions]>;
57
+ /**
58
+ * Common schemas to be used for $ref resolution.
59
+ */
60
+ commonSchemas?: Record<string, {
61
+ /**
62
+ * Determines which schema definition to use when input and output schemas differ.
63
+ * This is needed because some schemas transform data differently between input and output,
64
+ * making it impossible to use a single $ref for both cases.
65
+ *
66
+ * @example
67
+ * ```ts
68
+ * // This schema transforms a string input into a number output
69
+ * const Schema = z.string()
70
+ * .transform(v => Number(v))
71
+ * .pipe(z.number())
72
+ *
73
+ * // Input schema: { type: 'string' }
74
+ * // Output schema: { type: 'number' }
75
+ * ```
76
+ *
77
+ * When schemas differ between input and output, you must explicitly choose
78
+ * which version to use for the OpenAPI specification.
79
+ *
80
+ * @default 'input' - Uses the input schema definition by default
81
+ */
82
+ strategy?: SchemaConvertOptions['strategy'];
83
+ schema: AnySchema;
84
+ } | {
85
+ error: 'UndefinedError';
86
+ schema?: never;
87
+ }>;
88
+ }
89
+ /**
90
+ * The generator that converts oRPC routers/contracts to OpenAPI specifications.
91
+ *
92
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
93
+ */
94
+ declare class OpenAPIGenerator {
95
+ #private;
96
+ private readonly serializer;
97
+ private readonly converter;
98
+ constructor(options?: OpenAPIGeneratorOptions);
99
+ /**
100
+ * Generates OpenAPI specifications from oRPC routers/contracts.
101
+ *
102
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
103
+ */
104
+ generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
105
+ }
106
+
107
+ export { OpenAPIGenerator as b, CompositeSchemaConverter as e };
108
+ export type { ConditionalSchemaConverter as C, OpenAPIGeneratorOptions as O, SchemaConverterComponent as S, OpenAPIGeneratorGenerateOptions as a, SchemaConvertOptions as c, SchemaConverter as d };
@@ -0,0 +1,108 @@
1
+ import { AnySchema, OpenAPI, AnyContractProcedure, AnyContractRouter } from '@orpc/contract';
2
+ import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
3
+ import { AnyProcedure, TraverseContractProcedureCallbackOptions, AnyRouter } from '@orpc/server';
4
+ import { Promisable, Value } from '@orpc/shared';
5
+ import { JSONSchema } from '@orpc/interop/json-schema-typed/draft-2020-12';
6
+
7
+ interface SchemaConverterComponent {
8
+ allowedStrategies: readonly SchemaConvertOptions['strategy'][];
9
+ schema: AnySchema;
10
+ required: boolean;
11
+ ref: string;
12
+ }
13
+ interface SchemaConvertOptions {
14
+ strategy: 'input' | 'output';
15
+ /**
16
+ * Common components should use `$ref` to represent themselves if matched.
17
+ */
18
+ components?: readonly SchemaConverterComponent[];
19
+ /**
20
+ * Minimum schema structure depth required before using `$ref` for components.
21
+ *
22
+ * For example, if set to 2, `$ref` will only be used for schemas nested at depth 2 or greater.
23
+ *
24
+ * @default 0 - No depth limit;
25
+ */
26
+ minStructureDepthForRef?: number;
27
+ }
28
+ interface SchemaConverter {
29
+ convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
30
+ }
31
+ interface ConditionalSchemaConverter extends SchemaConverter {
32
+ condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
33
+ }
34
+ declare class CompositeSchemaConverter implements SchemaConverter {
35
+ private readonly converters;
36
+ constructor(converters: readonly ConditionalSchemaConverter[]);
37
+ convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
38
+ }
39
+
40
+ interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
41
+ schemaConverters?: ConditionalSchemaConverter[];
42
+ }
43
+ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document, 'openapi'>> {
44
+ /**
45
+ * Exclude procedures from the OpenAPI specification.
46
+ *
47
+ * @deprecated Use `filter` option instead.
48
+ * @default () => false
49
+ */
50
+ exclude?: (procedure: AnyProcedure | AnyContractProcedure, path: readonly string[]) => boolean;
51
+ /**
52
+ * Filter procedures. Return `false` to exclude a procedure from the OpenAPI specification.
53
+ *
54
+ * @default true
55
+ */
56
+ filter?: Value<boolean, [options: TraverseContractProcedureCallbackOptions]>;
57
+ /**
58
+ * Common schemas to be used for $ref resolution.
59
+ */
60
+ commonSchemas?: Record<string, {
61
+ /**
62
+ * Determines which schema definition to use when input and output schemas differ.
63
+ * This is needed because some schemas transform data differently between input and output,
64
+ * making it impossible to use a single $ref for both cases.
65
+ *
66
+ * @example
67
+ * ```ts
68
+ * // This schema transforms a string input into a number output
69
+ * const Schema = z.string()
70
+ * .transform(v => Number(v))
71
+ * .pipe(z.number())
72
+ *
73
+ * // Input schema: { type: 'string' }
74
+ * // Output schema: { type: 'number' }
75
+ * ```
76
+ *
77
+ * When schemas differ between input and output, you must explicitly choose
78
+ * which version to use for the OpenAPI specification.
79
+ *
80
+ * @default 'input' - Uses the input schema definition by default
81
+ */
82
+ strategy?: SchemaConvertOptions['strategy'];
83
+ schema: AnySchema;
84
+ } | {
85
+ error: 'UndefinedError';
86
+ schema?: never;
87
+ }>;
88
+ }
89
+ /**
90
+ * The generator that converts oRPC routers/contracts to OpenAPI specifications.
91
+ *
92
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
93
+ */
94
+ declare class OpenAPIGenerator {
95
+ #private;
96
+ private readonly serializer;
97
+ private readonly converter;
98
+ constructor(options?: OpenAPIGeneratorOptions);
99
+ /**
100
+ * Generates OpenAPI specifications from oRPC routers/contracts.
101
+ *
102
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
103
+ */
104
+ generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
105
+ }
106
+
107
+ export { OpenAPIGenerator as b, CompositeSchemaConverter as e };
108
+ export type { ConditionalSchemaConverter as C, OpenAPIGeneratorOptions as O, SchemaConverterComponent as S, OpenAPIGeneratorGenerateOptions as a, SchemaConvertOptions as c, SchemaConverter as d };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orpc/openapi",
3
3
  "type": "module",
4
- "version": "0.0.0-next.ff5907c",
4
+ "version": "0.0.0-next.ff7ad2e",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.unnoq.com",
7
7
  "repository": {
@@ -15,61 +15,54 @@
15
15
  ],
16
16
  "exports": {
17
17
  ".": {
18
- "types": "./dist/src/index.d.ts",
19
- "import": "./dist/index.js",
20
- "default": "./dist/index.js"
18
+ "types": "./dist/index.d.mts",
19
+ "import": "./dist/index.mjs",
20
+ "default": "./dist/index.mjs"
21
+ },
22
+ "./plugins": {
23
+ "types": "./dist/plugins/index.d.mts",
24
+ "import": "./dist/plugins/index.mjs",
25
+ "default": "./dist/plugins/index.mjs"
21
26
  },
22
27
  "./standard": {
23
- "types": "./dist/src/adapters/standard/index.d.ts",
24
- "import": "./dist/standard.js",
25
- "default": "./dist/standard.js"
28
+ "types": "./dist/adapters/standard/index.d.mts",
29
+ "import": "./dist/adapters/standard/index.mjs",
30
+ "default": "./dist/adapters/standard/index.mjs"
26
31
  },
27
32
  "./fetch": {
28
- "types": "./dist/src/adapters/fetch/index.d.ts",
29
- "import": "./dist/fetch.js",
30
- "default": "./dist/fetch.js"
31
- },
32
- "./hono": {
33
- "types": "./dist/src/adapters/hono/index.d.ts",
34
- "import": "./dist/hono.js",
35
- "default": "./dist/hono.js"
36
- },
37
- "./next": {
38
- "types": "./dist/src/adapters/next/index.d.ts",
39
- "import": "./dist/next.js",
40
- "default": "./dist/next.js"
33
+ "types": "./dist/adapters/fetch/index.d.mts",
34
+ "import": "./dist/adapters/fetch/index.mjs",
35
+ "default": "./dist/adapters/fetch/index.mjs"
41
36
  },
42
37
  "./node": {
43
- "types": "./dist/src/adapters/node/index.d.ts",
44
- "import": "./dist/node.js",
45
- "default": "./dist/node.js"
38
+ "types": "./dist/adapters/node/index.d.mts",
39
+ "import": "./dist/adapters/node/index.mjs",
40
+ "default": "./dist/adapters/node/index.mjs"
46
41
  },
47
- "./🔒/*": {
48
- "types": "./dist/src/*.d.ts"
42
+ "./aws-lambda": {
43
+ "types": "./dist/adapters/aws-lambda/index.d.mts",
44
+ "import": "./dist/adapters/aws-lambda/index.mjs",
45
+ "default": "./dist/adapters/aws-lambda/index.mjs"
49
46
  }
50
47
  },
51
48
  "files": [
52
- "!**/*.map",
53
- "!**/*.tsbuildinfo",
54
49
  "dist"
55
50
  ],
56
51
  "dependencies": {
57
- "@orpc/server-standard": "^0.4.0",
58
- "@orpc/server-standard-fetch": "^0.4.0",
59
- "@orpc/server-standard-node": "^0.4.0",
60
- "json-schema-typed": "^8.0.1",
61
- "openapi3-ts": "^4.4.0",
62
- "rou3": "^0.5.1",
63
- "@orpc/client": "0.0.0-next.ff5907c",
64
- "@orpc/contract": "0.0.0-next.ff5907c",
65
- "@orpc/shared": "0.0.0-next.ff5907c",
66
- "@orpc/server": "0.0.0-next.ff5907c"
52
+ "rou3": "^0.7.3",
53
+ "@orpc/client": "0.0.0-next.ff7ad2e",
54
+ "@orpc/contract": "0.0.0-next.ff7ad2e",
55
+ "@orpc/openapi-client": "0.0.0-next.ff7ad2e",
56
+ "@orpc/interop": "0.0.0-next.ff7ad2e",
57
+ "@orpc/shared": "0.0.0-next.ff7ad2e",
58
+ "@orpc/server": "0.0.0-next.ff7ad2e",
59
+ "@orpc/standard-server": "0.0.0-next.ff7ad2e"
67
60
  },
68
61
  "devDependencies": {
69
- "zod": "^3.24.1"
62
+ "zod": "^4.0.17"
70
63
  },
71
64
  "scripts": {
72
- "build": "tsup --onSuccess='tsc -b --noCheck'",
65
+ "build": "unbuild",
73
66
  "build:watch": "pnpm run build --watch",
74
67
  "type:check": "tsc -b"
75
68
  }
@@ -1,32 +0,0 @@
1
- import {
2
- OpenAPICodec,
3
- OpenAPIMatcher
4
- } from "./chunk-LPBZEW4B.js";
5
-
6
- // src/adapters/fetch/openapi-handler.ts
7
- import { toFetchResponse, toStandardRequest } from "@orpc/server-standard-fetch";
8
- import { StandardHandler } from "@orpc/server/standard";
9
- var OpenAPIHandler = class {
10
- standardHandler;
11
- constructor(router, options) {
12
- const matcher = options?.matcher ?? new OpenAPIMatcher(options);
13
- const codec = options?.codec ?? new OpenAPICodec(options);
14
- this.standardHandler = new StandardHandler(router, matcher, codec, options);
15
- }
16
- async handle(request, ...rest) {
17
- const standardRequest = toStandardRequest(request);
18
- const result = await this.standardHandler.handle(standardRequest, ...rest);
19
- if (!result.matched) {
20
- return result;
21
- }
22
- return {
23
- matched: true,
24
- response: toFetchResponse(result.response)
25
- };
26
- }
27
- };
28
-
29
- export {
30
- OpenAPIHandler
31
- };
32
- //# sourceMappingURL=chunk-UU2TTVB2.js.map
@@ -1,13 +0,0 @@
1
- // src/utils.ts
2
- function standardizeHTTPPath(path) {
3
- return `/${path.replace(/\/{2,}/g, "/").replace(/^\/|\/$/g, "")}`;
4
- }
5
- function toOpenAPI31RoutePattern(path) {
6
- return standardizeHTTPPath(path).replace(/\{\+([^}]+)\}/g, "{$1}");
7
- }
8
-
9
- export {
10
- standardizeHTTPPath,
11
- toOpenAPI31RoutePattern
12
- };
13
- //# sourceMappingURL=chunk-XGHV4TH3.js.map
package/dist/fetch.js DELETED
@@ -1,9 +0,0 @@
1
- import {
2
- OpenAPIHandler
3
- } from "./chunk-UU2TTVB2.js";
4
- import "./chunk-LPBZEW4B.js";
5
- import "./chunk-XGHV4TH3.js";
6
- export {
7
- OpenAPIHandler
8
- };
9
- //# sourceMappingURL=fetch.js.map
package/dist/hono.js DELETED
@@ -1,9 +0,0 @@
1
- import {
2
- OpenAPIHandler
3
- } from "./chunk-UU2TTVB2.js";
4
- import "./chunk-LPBZEW4B.js";
5
- import "./chunk-XGHV4TH3.js";
6
- export {
7
- OpenAPIHandler
8
- };
9
- //# sourceMappingURL=hono.js.map