@orpc/openapi 0.45.1 → 0.47.0
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.
- package/dist/adapters/fetch/index.d.mts +3 -4
- package/dist/adapters/fetch/index.d.ts +3 -4
- package/dist/adapters/fetch/index.mjs +5 -4
- package/dist/adapters/hono/index.d.mts +0 -1
- package/dist/adapters/hono/index.d.ts +0 -1
- package/dist/adapters/hono/index.mjs +5 -4
- package/dist/adapters/next/index.d.mts +0 -1
- package/dist/adapters/next/index.d.ts +0 -1
- package/dist/adapters/next/index.mjs +5 -4
- package/dist/adapters/node/index.d.mts +3 -4
- package/dist/adapters/node/index.d.ts +3 -4
- package/dist/adapters/node/index.mjs +15 -11
- package/dist/adapters/standard/index.d.mts +16 -6
- package/dist/adapters/standard/index.d.ts +16 -6
- package/dist/adapters/standard/index.mjs +3 -3
- package/dist/index.d.mts +88 -138
- package/dist/index.d.ts +88 -138
- package/dist/index.mjs +225 -583
- package/dist/shared/openapi.C015V43J.mjs +31 -0
- package/dist/shared/{openapi.CDsfPHgw.mjs → openapi.DFXD6scT.mjs} +10 -10
- package/dist/shared/openapi.DZzpQAb-.mjs +231 -0
- package/package.json +11 -11
- package/dist/shared/openapi.BHG_gu5Z.mjs +0 -8
- package/dist/shared/openapi.D0VMNR6V.mjs +0 -25
- package/dist/shared/openapi.Dz_6xooR.d.mts +0 -7
- package/dist/shared/openapi.Dz_6xooR.d.ts +0 -7
@@ -1,14 +1,13 @@
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
2
2
|
import { FetchHandler, FetchHandleResult } from '@orpc/server/fetch';
|
3
|
-
import { StandardHandleOptions } from '@orpc/server/standard';
|
3
|
+
import { StandardHandlerOptions, StandardHandleOptions } from '@orpc/server/standard';
|
4
4
|
import { MaybeOptionalOptions } from '@orpc/shared';
|
5
5
|
import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
|
6
|
-
import { O as OpenAPIHandlerOptions } from '../../shared/openapi.Dz_6xooR.mjs';
|
7
6
|
|
8
7
|
declare class OpenAPIHandler<T extends Context> implements FetchHandler<T> {
|
9
8
|
private readonly standardHandler;
|
10
|
-
constructor(router: Router<T, any>, options?: NoInfer<
|
11
|
-
handle(request: Request, ...[options]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>): Promise<FetchHandleResult>;
|
9
|
+
constructor(router: Router<T, any>, options?: NoInfer<StandardHandlerOptions<T>>);
|
10
|
+
handle(request: Request, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>): Promise<FetchHandleResult>;
|
12
11
|
}
|
13
12
|
|
14
13
|
export { OpenAPIHandler };
|
@@ -1,14 +1,13 @@
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
2
2
|
import { FetchHandler, FetchHandleResult } from '@orpc/server/fetch';
|
3
|
-
import { StandardHandleOptions } from '@orpc/server/standard';
|
3
|
+
import { StandardHandlerOptions, StandardHandleOptions } from '@orpc/server/standard';
|
4
4
|
import { MaybeOptionalOptions } from '@orpc/shared';
|
5
5
|
import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
|
6
|
-
import { O as OpenAPIHandlerOptions } from '../../shared/openapi.Dz_6xooR.js';
|
7
6
|
|
8
7
|
declare class OpenAPIHandler<T extends Context> implements FetchHandler<T> {
|
9
8
|
private readonly standardHandler;
|
10
|
-
constructor(router: Router<T, any>, options?: NoInfer<
|
11
|
-
handle(request: Request, ...[options]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>): Promise<FetchHandleResult>;
|
9
|
+
constructor(router: Router<T, any>, options?: NoInfer<StandardHandlerOptions<T>>);
|
10
|
+
handle(request: Request, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>): Promise<FetchHandleResult>;
|
12
11
|
}
|
13
12
|
|
14
13
|
export { OpenAPIHandler };
|
@@ -1,10 +1,11 @@
|
|
1
|
-
export { O as OpenAPIHandler } from '../../shared/openapi.
|
1
|
+
export { O as OpenAPIHandler } from '../../shared/openapi.C015V43J.mjs';
|
2
|
+
import '@orpc/openapi-client/standard';
|
2
3
|
import '@orpc/server/standard';
|
3
4
|
import '@orpc/standard-server-fetch';
|
4
|
-
import '../../shared/openapi.
|
5
|
+
import '../../shared/openapi.DFXD6scT.mjs';
|
5
6
|
import '@orpc/contract';
|
6
|
-
import '@orpc/openapi-client/standard';
|
7
7
|
import '@orpc/shared';
|
8
8
|
import '@orpc/server';
|
9
9
|
import 'rou3';
|
10
|
-
import '../../shared/openapi.
|
10
|
+
import '../../shared/openapi.DZzpQAb-.mjs';
|
11
|
+
import 'json-schema-typed/draft-2020-12';
|
@@ -1,10 +1,11 @@
|
|
1
|
-
export { O as OpenAPIHandler } from '../../shared/openapi.
|
1
|
+
export { O as OpenAPIHandler } from '../../shared/openapi.C015V43J.mjs';
|
2
|
+
import '@orpc/openapi-client/standard';
|
2
3
|
import '@orpc/server/standard';
|
3
4
|
import '@orpc/standard-server-fetch';
|
4
|
-
import '../../shared/openapi.
|
5
|
+
import '../../shared/openapi.DFXD6scT.mjs';
|
5
6
|
import '@orpc/contract';
|
6
|
-
import '@orpc/openapi-client/standard';
|
7
7
|
import '@orpc/shared';
|
8
8
|
import '@orpc/server';
|
9
9
|
import 'rou3';
|
10
|
-
import '../../shared/openapi.
|
10
|
+
import '../../shared/openapi.DZzpQAb-.mjs';
|
11
|
+
import 'json-schema-typed/draft-2020-12';
|
@@ -1,10 +1,11 @@
|
|
1
|
-
export { O as OpenAPIHandler } from '../../shared/openapi.
|
1
|
+
export { O as OpenAPIHandler } from '../../shared/openapi.C015V43J.mjs';
|
2
|
+
import '@orpc/openapi-client/standard';
|
2
3
|
import '@orpc/server/standard';
|
3
4
|
import '@orpc/standard-server-fetch';
|
4
|
-
import '../../shared/openapi.
|
5
|
+
import '../../shared/openapi.DFXD6scT.mjs';
|
5
6
|
import '@orpc/contract';
|
6
|
-
import '@orpc/openapi-client/standard';
|
7
7
|
import '@orpc/shared';
|
8
8
|
import '@orpc/server';
|
9
9
|
import 'rou3';
|
10
|
-
import '../../shared/openapi.
|
10
|
+
import '../../shared/openapi.DZzpQAb-.mjs';
|
11
|
+
import 'json-schema-typed/draft-2020-12';
|
@@ -1,14 +1,13 @@
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
2
2
|
import { NodeHttpHandler, NodeHttpRequest, NodeHttpResponse, NodeHttpHandleResult } from '@orpc/server/node';
|
3
|
-
import { StandardHandleOptions } from '@orpc/server/standard';
|
3
|
+
import { StandardHandlerOptions, StandardHandleOptions } from '@orpc/server/standard';
|
4
4
|
import { MaybeOptionalOptions } from '@orpc/shared';
|
5
5
|
import { SendStandardResponseOptions } from '@orpc/standard-server-node';
|
6
|
-
import { O as OpenAPIHandlerOptions } from '../../shared/openapi.Dz_6xooR.mjs';
|
7
6
|
|
8
7
|
declare class OpenAPIHandler<T extends Context> implements NodeHttpHandler<T> {
|
9
8
|
private readonly standardHandler;
|
10
|
-
constructor(router: Router<T, any>, options?: NoInfer<
|
11
|
-
handle(req: NodeHttpRequest, res: NodeHttpResponse, ...[options]: MaybeOptionalOptions<StandardHandleOptions<T> & SendStandardResponseOptions>): Promise<NodeHttpHandleResult>;
|
9
|
+
constructor(router: Router<T, any>, options?: NoInfer<StandardHandlerOptions<T>>);
|
10
|
+
handle(req: NodeHttpRequest, res: NodeHttpResponse, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & SendStandardResponseOptions>): Promise<NodeHttpHandleResult>;
|
12
11
|
}
|
13
12
|
|
14
13
|
export { OpenAPIHandler };
|
@@ -1,14 +1,13 @@
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
2
2
|
import { NodeHttpHandler, NodeHttpRequest, NodeHttpResponse, NodeHttpHandleResult } from '@orpc/server/node';
|
3
|
-
import { StandardHandleOptions } from '@orpc/server/standard';
|
3
|
+
import { StandardHandlerOptions, StandardHandleOptions } from '@orpc/server/standard';
|
4
4
|
import { MaybeOptionalOptions } from '@orpc/shared';
|
5
5
|
import { SendStandardResponseOptions } from '@orpc/standard-server-node';
|
6
|
-
import { O as OpenAPIHandlerOptions } from '../../shared/openapi.Dz_6xooR.js';
|
7
6
|
|
8
7
|
declare class OpenAPIHandler<T extends Context> implements NodeHttpHandler<T> {
|
9
8
|
private readonly standardHandler;
|
10
|
-
constructor(router: Router<T, any>, options?: NoInfer<
|
11
|
-
handle(req: NodeHttpRequest, res: NodeHttpResponse, ...[options]: MaybeOptionalOptions<StandardHandleOptions<T> & SendStandardResponseOptions>): Promise<NodeHttpHandleResult>;
|
9
|
+
constructor(router: Router<T, any>, options?: NoInfer<StandardHandlerOptions<T>>);
|
10
|
+
handle(req: NodeHttpRequest, res: NodeHttpResponse, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & SendStandardResponseOptions>): Promise<NodeHttpHandleResult>;
|
12
11
|
}
|
13
12
|
|
14
13
|
export { OpenAPIHandler };
|
@@ -1,22 +1,26 @@
|
|
1
|
+
import { OpenAPISerializer } from '@orpc/openapi-client/standard';
|
1
2
|
import { StandardHandler } from '@orpc/server/standard';
|
2
|
-
import {
|
3
|
-
import { a as OpenAPIMatcher, O as OpenAPICodec } from '../../shared/openapi.
|
4
|
-
import '@orpc/contract';
|
5
|
-
import '@orpc/openapi-client/standard';
|
3
|
+
import { toStandardLazyRequest, sendStandardResponse } from '@orpc/standard-server-node';
|
4
|
+
import { a as OpenAPIMatcher, O as OpenAPICodec } from '../../shared/openapi.DFXD6scT.mjs';
|
6
5
|
import '@orpc/shared';
|
6
|
+
import 'json-schema-typed/draft-2020-12';
|
7
|
+
import '@orpc/contract';
|
7
8
|
import '@orpc/server';
|
8
9
|
import 'rou3';
|
9
|
-
import '../../shared/openapi.
|
10
|
+
import '../../shared/openapi.DZzpQAb-.mjs';
|
10
11
|
|
11
12
|
class OpenAPIHandler {
|
12
13
|
standardHandler;
|
13
|
-
constructor(router, options) {
|
14
|
-
const
|
15
|
-
const
|
16
|
-
|
14
|
+
constructor(router, options = {}) {
|
15
|
+
const serializer = new OpenAPISerializer();
|
16
|
+
const matcher = new OpenAPIMatcher();
|
17
|
+
const codec = new OpenAPICodec(serializer);
|
18
|
+
this.standardHandler = new StandardHandler(router, matcher, codec, options);
|
17
19
|
}
|
18
|
-
async handle(req, res, ...[
|
19
|
-
|
20
|
+
async handle(req, res, ...[
|
21
|
+
options = {}
|
22
|
+
]) {
|
23
|
+
const standardRequest = toStandardLazyRequest(req, res);
|
20
24
|
const result = await this.standardHandler.handle(standardRequest, options);
|
21
25
|
if (!result.matched) {
|
22
26
|
return { matched: false };
|
@@ -1,15 +1,14 @@
|
|
1
1
|
import { ORPCError } from '@orpc/client';
|
2
|
+
import { OpenAPISerializer } from '@orpc/openapi-client/standard';
|
2
3
|
import { AnyProcedure, AnyRouter } from '@orpc/server';
|
3
4
|
import { StandardCodec, StandardParams, StandardMatcher, StandardMatchResult } from '@orpc/server/standard';
|
4
|
-
import {
|
5
|
-
import { OpenAPISerializer } from '@orpc/openapi-client/standard';
|
6
|
-
export { O as OpenAPIHandlerOptions } from '../../shared/openapi.Dz_6xooR.mjs';
|
5
|
+
import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
|
7
6
|
import { HTTPPath } from '@orpc/contract';
|
8
7
|
|
9
8
|
declare class OpenAPICodec implements StandardCodec {
|
10
9
|
private readonly serializer;
|
11
|
-
constructor(serializer
|
12
|
-
decode(request:
|
10
|
+
constructor(serializer: OpenAPISerializer);
|
11
|
+
decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
|
13
12
|
encode(output: unknown, procedure: AnyProcedure): StandardResponse;
|
14
13
|
encodeError(error: ORPCError<any, any>): StandardResponse;
|
15
14
|
}
|
@@ -21,4 +20,15 @@ declare class OpenAPIMatcher implements StandardMatcher {
|
|
21
20
|
match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
|
22
21
|
}
|
23
22
|
|
24
|
-
|
23
|
+
/**
|
24
|
+
* {@link https://github.com/unjs/rou3}
|
25
|
+
*
|
26
|
+
* @internal
|
27
|
+
*/
|
28
|
+
declare function toRou3Pattern(path: HTTPPath): string;
|
29
|
+
/**
|
30
|
+
* @internal
|
31
|
+
*/
|
32
|
+
declare function decodeParams(params: Record<string, string>): Record<string, string>;
|
33
|
+
|
34
|
+
export { OpenAPICodec, OpenAPIMatcher, decodeParams, toRou3Pattern };
|
@@ -1,15 +1,14 @@
|
|
1
1
|
import { ORPCError } from '@orpc/client';
|
2
|
+
import { OpenAPISerializer } from '@orpc/openapi-client/standard';
|
2
3
|
import { AnyProcedure, AnyRouter } from '@orpc/server';
|
3
4
|
import { StandardCodec, StandardParams, StandardMatcher, StandardMatchResult } from '@orpc/server/standard';
|
4
|
-
import {
|
5
|
-
import { OpenAPISerializer } from '@orpc/openapi-client/standard';
|
6
|
-
export { O as OpenAPIHandlerOptions } from '../../shared/openapi.Dz_6xooR.js';
|
5
|
+
import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
|
7
6
|
import { HTTPPath } from '@orpc/contract';
|
8
7
|
|
9
8
|
declare class OpenAPICodec implements StandardCodec {
|
10
9
|
private readonly serializer;
|
11
|
-
constructor(serializer
|
12
|
-
decode(request:
|
10
|
+
constructor(serializer: OpenAPISerializer);
|
11
|
+
decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
|
13
12
|
encode(output: unknown, procedure: AnyProcedure): StandardResponse;
|
14
13
|
encodeError(error: ORPCError<any, any>): StandardResponse;
|
15
14
|
}
|
@@ -21,4 +20,15 @@ declare class OpenAPIMatcher implements StandardMatcher {
|
|
21
20
|
match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
|
22
21
|
}
|
23
22
|
|
24
|
-
|
23
|
+
/**
|
24
|
+
* {@link https://github.com/unjs/rou3}
|
25
|
+
*
|
26
|
+
* @internal
|
27
|
+
*/
|
28
|
+
declare function toRou3Pattern(path: HTTPPath): string;
|
29
|
+
/**
|
30
|
+
* @internal
|
31
|
+
*/
|
32
|
+
declare function decodeParams(params: Record<string, string>): Record<string, string>;
|
33
|
+
|
34
|
+
export { OpenAPICodec, OpenAPIMatcher, decodeParams, toRou3Pattern };
|
@@ -1,7 +1,7 @@
|
|
1
|
-
export { O as OpenAPICodec, a as OpenAPIMatcher } from '../../shared/openapi.
|
1
|
+
export { O as OpenAPICodec, a as OpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.DFXD6scT.mjs';
|
2
2
|
import '@orpc/contract';
|
3
|
-
import '@orpc/openapi-client/standard';
|
4
3
|
import '@orpc/shared';
|
5
4
|
import '@orpc/server';
|
6
5
|
import 'rou3';
|
7
|
-
import '../../shared/openapi.
|
6
|
+
import '../../shared/openapi.DZzpQAb-.mjs';
|
7
|
+
import 'json-schema-typed/draft-2020-12';
|
package/dist/index.d.mts
CHANGED
@@ -1,169 +1,119 @@
|
|
1
|
-
import { AnyContractProcedure, Schema,
|
2
|
-
import
|
3
|
-
export { OpenAPI };
|
4
|
-
export { OpenApiBuilder } from 'openapi3-ts/oas31';
|
5
|
-
import * as JSONSchema from 'json-schema-typed/draft-2020-12';
|
6
|
-
export { JSONSchema };
|
7
|
-
export { Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
|
8
|
-
import { OpenAPIJsonSerializer } from '@orpc/openapi-client/standard';
|
1
|
+
import { AnyContractProcedure, Schema, AnyContractRouter, HTTPPath, HTTPMethod } from '@orpc/contract';
|
2
|
+
import { OpenAPIV3_1 } from 'openapi-types';
|
3
|
+
export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
|
9
4
|
import { AnyRouter } from '@orpc/server';
|
5
|
+
import { JSONSchema } from 'json-schema-typed/draft-2020-12';
|
6
|
+
export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
|
10
7
|
|
11
|
-
type OverrideOperationValue =
|
12
|
-
declare function
|
13
|
-
declare function
|
14
|
-
declare function
|
8
|
+
type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
|
9
|
+
declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
|
10
|
+
declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
|
11
|
+
declare function applyCustomOpenAPIOperation(operation: OpenAPIV3_1.OperationObject, contract: AnyContractProcedure): OpenAPIV3_1.OperationObject;
|
15
12
|
|
16
|
-
|
13
|
+
/**
|
14
|
+
* @internal
|
15
|
+
*/
|
16
|
+
type ObjectSchema = JSONSchema & {
|
17
17
|
type: 'object';
|
18
18
|
} & object;
|
19
|
-
|
19
|
+
/**
|
20
|
+
* @internal
|
21
|
+
*/
|
22
|
+
type FileSchema = JSONSchema & {
|
20
23
|
type: 'string';
|
21
24
|
contentMediaType: string;
|
22
25
|
} & object;
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
isObjectSchema(schema: JSONSchema.JSONSchema): schema is ObjectSchema;
|
28
|
-
isAnySchema(schema: JSONSchema.JSONSchema): boolean;
|
29
|
-
isUndefinableSchema(schema: JSONSchema.JSONSchema): boolean;
|
30
|
-
separateObjectSchema(schema: ObjectSchema, separatedProperties: string[]): [matched: ObjectSchema, rest: ObjectSchema];
|
31
|
-
filterSchemaBranches(schema: JSONSchema.JSONSchema, check: (schema: JSONSchema.JSONSchema) => boolean, matches?: JSONSchema.JSONSchema[]): [matches: JSONSchema.JSONSchema[], rest: JSONSchema.JSONSchema | undefined];
|
32
|
-
}
|
33
|
-
type PublicSchemaUtils = Pick<SchemaUtils, keyof SchemaUtils>;
|
34
|
-
|
35
|
-
declare class OpenAPIContentBuilder {
|
36
|
-
private readonly schemaUtils;
|
37
|
-
constructor(schemaUtils: PublicSchemaUtils);
|
38
|
-
build(jsonSchema: JSONSchema.JSONSchema, options?: Partial<OpenAPI.MediaTypeObject>): OpenAPI.ContentObject;
|
39
|
-
}
|
40
|
-
type PublicOpenAPIContentBuilder = Pick<OpenAPIContentBuilder, keyof OpenAPIContentBuilder>;
|
41
|
-
|
42
|
-
declare class OpenAPIPathParser {
|
43
|
-
parseDynamicParams(path: string): {
|
44
|
-
name: string;
|
45
|
-
raw: string;
|
46
|
-
}[];
|
47
|
-
}
|
48
|
-
type PublicOpenAPIPathParser = Pick<OpenAPIPathParser, keyof OpenAPIPathParser>;
|
26
|
+
/**
|
27
|
+
* @internal
|
28
|
+
*/
|
29
|
+
declare const LOGIC_KEYWORDS: string[];
|
49
30
|
|
50
31
|
interface SchemaConvertOptions {
|
51
32
|
strategy: 'input' | 'output';
|
52
33
|
}
|
53
34
|
interface SchemaConverter {
|
35
|
+
convert(schema: Schema, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
|
36
|
+
}
|
37
|
+
interface ConditionalSchemaConverter extends SchemaConverter {
|
54
38
|
condition(schema: Schema, options: SchemaConvertOptions): boolean;
|
55
|
-
convert(schema: Schema, options: SchemaConvertOptions): JSONSchema.JSONSchema;
|
56
39
|
}
|
57
40
|
declare class CompositeSchemaConverter implements SchemaConverter {
|
58
41
|
private readonly converters;
|
59
|
-
constructor(converters:
|
60
|
-
|
61
|
-
convert(schema: Schema, options: SchemaConvertOptions): JSONSchema.JSONSchema;
|
62
|
-
}
|
63
|
-
|
64
|
-
interface OpenAPIInputStructureParseResult {
|
65
|
-
paramsSchema: ObjectSchema | undefined;
|
66
|
-
querySchema: ObjectSchema | undefined;
|
67
|
-
headersSchema: ObjectSchema | undefined;
|
68
|
-
bodySchema: JSONSchema.JSONSchema | undefined;
|
69
|
-
}
|
70
|
-
declare class OpenAPIInputStructureParser {
|
71
|
-
private readonly schemaConverter;
|
72
|
-
private readonly schemaUtils;
|
73
|
-
private readonly pathParser;
|
74
|
-
constructor(schemaConverter: SchemaConverter, schemaUtils: PublicSchemaUtils, pathParser: PublicOpenAPIPathParser);
|
75
|
-
parse(contract: AnyContractProcedure, structure: 'compact' | 'detailed'): OpenAPIInputStructureParseResult;
|
76
|
-
private parseDetailedSchema;
|
77
|
-
private parseCompactSchema;
|
78
|
-
}
|
79
|
-
type PublicOpenAPIInputStructureParser = Pick<OpenAPIInputStructureParser, keyof OpenAPIInputStructureParser>;
|
80
|
-
|
81
|
-
interface OpenAPIOutputStructureParseResult {
|
82
|
-
headersSchema: ObjectSchema | undefined;
|
83
|
-
bodySchema: JSONSchema.JSONSchema | undefined;
|
84
|
-
}
|
85
|
-
declare class OpenAPIOutputStructureParser {
|
86
|
-
private readonly schemaConverter;
|
87
|
-
private readonly schemaUtils;
|
88
|
-
constructor(schemaConverter: SchemaConverter, schemaUtils: PublicSchemaUtils);
|
89
|
-
parse(contract: AnyContractProcedure, structure: 'compact' | 'detailed'): OpenAPIOutputStructureParseResult;
|
90
|
-
private parseDetailedSchema;
|
91
|
-
private parseCompactSchema;
|
92
|
-
}
|
93
|
-
type PublicOpenAPIOutputStructureParser = Pick<OpenAPIOutputStructureParser, keyof OpenAPIOutputStructureParser>;
|
94
|
-
|
95
|
-
declare class OpenAPIParametersBuilder {
|
96
|
-
build(paramIn: OpenAPI.ParameterObject['in'], jsonSchema: JSONSchema.JSONSchema & {
|
97
|
-
type: 'object';
|
98
|
-
} & object, options?: Pick<OpenAPI.ParameterObject, 'example' | 'style' | 'required'>): OpenAPI.ParameterObject[];
|
99
|
-
buildHeadersObject(jsonSchema: JSONSchema.JSONSchema & {
|
100
|
-
type: 'object';
|
101
|
-
} & object, options?: Pick<OpenAPI.ParameterObject, 'example' | 'style' | 'required'>): OpenAPI.HeadersObject;
|
42
|
+
constructor(converters: ConditionalSchemaConverter[]);
|
43
|
+
convert(schema: Schema, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
|
102
44
|
}
|
103
|
-
type PublicOpenAPIParametersBuilder = Pick<OpenAPIParametersBuilder, keyof OpenAPIParametersBuilder>;
|
104
45
|
|
105
|
-
type ErrorHandlerStrategy = 'throw' | 'log' | 'ignore';
|
106
46
|
interface OpenAPIGeneratorOptions {
|
107
|
-
|
108
|
-
parametersBuilder?: PublicOpenAPIParametersBuilder;
|
109
|
-
schemaConverters?: SchemaConverter[];
|
110
|
-
schemaUtils?: PublicSchemaUtils;
|
111
|
-
jsonSerializer?: OpenAPIJsonSerializer;
|
112
|
-
pathParser?: PublicOpenAPIPathParser;
|
113
|
-
inputStructureParser?: PublicOpenAPIInputStructureParser;
|
114
|
-
outputStructureParser?: PublicOpenAPIOutputStructureParser;
|
115
|
-
/**
|
116
|
-
* Throw error when you missing define tag definition on OpenAPI root tags
|
117
|
-
*
|
118
|
-
* Example: if procedure has tags ['foo', 'bar'], and OpenAPI root tags is ['foo'], then error will be thrown
|
119
|
-
* Because OpenAPI root tags is missing 'bar' tag
|
120
|
-
*
|
121
|
-
* @default false
|
122
|
-
*/
|
123
|
-
considerMissingTagDefinitionAsError?: boolean;
|
124
|
-
/**
|
125
|
-
* Weather ignore procedures that has no path defined.
|
126
|
-
*
|
127
|
-
* @default false
|
128
|
-
*/
|
129
|
-
ignoreUndefinedPathProcedures?: boolean;
|
130
|
-
/**
|
131
|
-
* What to do when we found an error with our router
|
132
|
-
*
|
133
|
-
* @default 'throw'
|
134
|
-
*/
|
135
|
-
errorHandlerStrategy?: ErrorHandlerStrategy;
|
136
|
-
/**
|
137
|
-
* Strict error response
|
138
|
-
*
|
139
|
-
* @default true
|
140
|
-
*/
|
141
|
-
strictErrorResponses?: boolean;
|
47
|
+
schemaConverters?: ConditionalSchemaConverter[];
|
142
48
|
}
|
143
49
|
declare class OpenAPIGenerator {
|
144
|
-
private
|
145
|
-
private readonly
|
146
|
-
private readonly
|
147
|
-
private readonly schemaUtils;
|
148
|
-
private readonly jsonSerializer;
|
149
|
-
private readonly pathParser;
|
150
|
-
private readonly inputStructureParser;
|
151
|
-
private readonly outputStructureParser;
|
152
|
-
private readonly errorHandlerStrategy;
|
153
|
-
private readonly ignoreUndefinedPathProcedures;
|
154
|
-
private readonly considerMissingTagDefinitionAsError;
|
155
|
-
private readonly strictErrorResponses;
|
50
|
+
#private;
|
51
|
+
private readonly serializer;
|
52
|
+
private readonly converter;
|
156
53
|
constructor(options?: OpenAPIGeneratorOptions);
|
157
|
-
generate(router:
|
54
|
+
generate(router: AnyContractRouter | AnyRouter, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
|
158
55
|
}
|
159
56
|
|
57
|
+
/**
|
58
|
+
* @internal
|
59
|
+
*/
|
160
60
|
declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
|
161
|
-
|
61
|
+
/**
|
62
|
+
* @internal
|
63
|
+
*/
|
64
|
+
declare function toOpenAPIPath(path: HTTPPath): string;
|
65
|
+
/**
|
66
|
+
* @internal
|
67
|
+
*/
|
68
|
+
declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
|
69
|
+
/**
|
70
|
+
* @internal
|
71
|
+
*/
|
72
|
+
declare function getDynamicParams(path: HTTPPath | undefined): string[] | undefined;
|
73
|
+
/**
|
74
|
+
* @internal
|
75
|
+
*/
|
76
|
+
declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPIV3_1.MediaTypeObject>;
|
77
|
+
/**
|
78
|
+
* @internal
|
79
|
+
*/
|
80
|
+
declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPIV3_1.MediaTypeObject>;
|
81
|
+
/**
|
82
|
+
* @internal
|
83
|
+
*/
|
84
|
+
declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPIV3_1.ParameterObject[];
|
85
|
+
/**
|
86
|
+
* @internal
|
87
|
+
*/
|
88
|
+
declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
|
89
|
+
/**
|
90
|
+
* @internal
|
91
|
+
*/
|
92
|
+
declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
|
162
93
|
|
163
|
-
/**
|
94
|
+
/**
|
95
|
+
*@internal
|
96
|
+
*/
|
97
|
+
declare function isFileSchema(schema: JSONSchema): schema is FileSchema;
|
98
|
+
/**
|
99
|
+
* @internal
|
100
|
+
*/
|
101
|
+
declare function isObjectSchema(schema: JSONSchema): schema is ObjectSchema;
|
102
|
+
/**
|
103
|
+
* @internal
|
104
|
+
*/
|
105
|
+
declare function isAnySchema(schema: JSONSchema): boolean;
|
106
|
+
/**
|
107
|
+
* @internal
|
108
|
+
*/
|
109
|
+
declare function separateObjectSchema(schema: ObjectSchema, separatedProperties: string[]): [matched: ObjectSchema, rest: ObjectSchema];
|
110
|
+
/**
|
111
|
+
* @internal
|
112
|
+
*/
|
113
|
+
declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
|
164
114
|
|
165
115
|
declare const oo: {
|
166
|
-
spec: typeof
|
116
|
+
spec: typeof customOpenAPIOperation;
|
167
117
|
};
|
168
118
|
|
169
|
-
export { CompositeSchemaConverter, type FileSchema,
|
119
|
+
export { CompositeSchemaConverter, type ConditionalSchemaConverter, type FileSchema, LOGIC_KEYWORDS, type ObjectSchema, OpenAPIGenerator, type OpenAPIGeneratorOptions, type OverrideOperationValue, type SchemaConvertOptions, type SchemaConverter, applyCustomOpenAPIOperation, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, getDynamicParams, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, standardizeHTTPPath, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
|