@celljs/openapi 0.0.0-stage → 4.4.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/README.md +85 -2
- package/cell.schema.json +41 -0
- package/cell.yml +12 -0
- package/esm/common/annotation.d.ts +60 -0
- package/esm/common/annotation.js +73 -0
- package/esm/common/annotation.js.map +1 -0
- package/esm/common/constants.d.ts +11 -0
- package/esm/common/constants.js +12 -0
- package/esm/common/constants.js.map +1 -0
- package/esm/common/index.d.ts +3 -0
- package/esm/common/index.js +4 -0
- package/esm/common/index.js.map +1 -0
- package/esm/common/openapi-protocol.d.ts +143 -0
- package/esm/common/openapi-protocol.js +2 -0
- package/esm/common/openapi-protocol.js.map +1 -0
- package/esm/node/index.d.ts +6 -0
- package/esm/node/index.js +7 -0
- package/esm/node/index.js.map +1 -0
- package/esm/node/module.d.ts +3 -0
- package/esm/node/module.js +4 -0
- package/esm/node/module.js.map +1 -0
- package/esm/node/openapi-document-provider.d.ts +39 -0
- package/esm/node/openapi-document-provider.js +310 -0
- package/esm/node/openapi-document-provider.js.map +1 -0
- package/esm/node/openapi-middleware.d.ts +17 -0
- package/esm/node/openapi-middleware.js +76 -0
- package/esm/node/openapi-middleware.js.map +1 -0
- package/esm/node/openapi-node-protocol.d.ts +7 -0
- package/esm/node/openapi-node-protocol.js +4 -0
- package/esm/node/openapi-node-protocol.js.map +1 -0
- package/esm/node/openapi-path-util.d.ts +10 -0
- package/esm/node/openapi-path-util.js +84 -0
- package/esm/node/openapi-path-util.js.map +1 -0
- package/esm/node/schema-builder.d.ts +39 -0
- package/esm/node/schema-builder.js +271 -0
- package/esm/node/schema-builder.js.map +1 -0
- package/esm/node/swagger-ui.d.ts +10 -0
- package/esm/node/swagger-ui.js +31 -0
- package/esm/node/swagger-ui.js.map +1 -0
- package/esm/package.json +3 -0
- package/lib/common/annotation.d.ts +61 -0
- package/lib/common/annotation.d.ts.map +1 -0
- package/lib/common/annotation.js +86 -0
- package/lib/common/annotation.js.map +1 -0
- package/lib/common/constants.d.ts +12 -0
- package/lib/common/constants.d.ts.map +1 -0
- package/lib/common/constants.js +15 -0
- package/lib/common/constants.js.map +1 -0
- package/lib/common/index.d.ts +4 -0
- package/lib/common/index.d.ts.map +1 -0
- package/lib/common/index.js +20 -0
- package/lib/common/index.js.map +1 -0
- package/lib/common/openapi-protocol.d.ts +144 -0
- package/lib/common/openapi-protocol.d.ts.map +1 -0
- package/lib/common/openapi-protocol.js +3 -0
- package/lib/common/openapi-protocol.js.map +1 -0
- package/lib/node/index.d.ts +7 -0
- package/lib/node/index.d.ts.map +1 -0
- package/lib/node/index.js +23 -0
- package/lib/node/index.js.map +1 -0
- package/lib/node/module.d.ts +4 -0
- package/lib/node/module.d.ts.map +1 -0
- package/lib/node/module.js +6 -0
- package/lib/node/module.js.map +1 -0
- package/lib/node/openapi-document-provider.d.ts +40 -0
- package/lib/node/openapi-document-provider.d.ts.map +1 -0
- package/lib/node/openapi-document-provider.js +313 -0
- package/lib/node/openapi-document-provider.js.map +1 -0
- package/lib/node/openapi-middleware.d.ts +18 -0
- package/lib/node/openapi-middleware.d.ts.map +1 -0
- package/lib/node/openapi-middleware.js +79 -0
- package/lib/node/openapi-middleware.js.map +1 -0
- package/lib/node/openapi-node-protocol.d.ts +8 -0
- package/lib/node/openapi-node-protocol.d.ts.map +1 -0
- package/lib/node/openapi-node-protocol.js +7 -0
- package/lib/node/openapi-node-protocol.js.map +1 -0
- package/lib/node/openapi-path-util.d.ts +11 -0
- package/lib/node/openapi-path-util.d.ts.map +1 -0
- package/lib/node/openapi-path-util.js +87 -0
- package/lib/node/openapi-path-util.js.map +1 -0
- package/lib/node/openapi.spec.d.ts +30 -0
- package/lib/node/openapi.spec.d.ts.map +1 -0
- package/lib/node/openapi.spec.js +268 -0
- package/lib/node/openapi.spec.js.map +1 -0
- package/lib/node/schema-builder.d.ts +40 -0
- package/lib/node/schema-builder.d.ts.map +1 -0
- package/lib/node/schema-builder.js +275 -0
- package/lib/node/schema-builder.js.map +1 -0
- package/lib/node/schema-builder.spec.d.ts +2 -0
- package/lib/node/schema-builder.spec.d.ts.map +1 -0
- package/lib/node/schema-builder.spec.js +143 -0
- package/lib/node/schema-builder.spec.js.map +1 -0
- package/lib/node/swagger-ui.d.ts +11 -0
- package/lib/node/swagger-ui.d.ts.map +1 -0
- package/lib/node/swagger-ui.js +34 -0
- package/lib/node/swagger-ui.js.map +1 -0
- package/lib/package.spec.d.ts +2 -0
- package/lib/package.spec.d.ts.map +1 -0
- package/lib/package.spec.js +7 -0
- package/lib/package.spec.js.map +1 -0
- package/package.json +78 -4
- package/src/common/annotation.ts +130 -0
- package/src/common/constants.ts +12 -0
- package/src/common/index.ts +3 -0
- package/src/common/openapi-protocol.ts +154 -0
- package/src/node/index.ts +6 -0
- package/src/node/module.ts +4 -0
- package/src/node/openapi-document-provider.ts +334 -0
- package/src/node/openapi-middleware.ts +59 -0
- package/src/node/openapi-node-protocol.ts +11 -0
- package/src/node/openapi-path-util.ts +75 -0
- package/src/node/openapi.spec.ts +219 -0
- package/src/node/schema-builder.spec.ts +124 -0
- package/src/node/schema-builder.ts +282 -0
- package/src/node/swagger-ui.ts +38 -0
- package/src/package.spec.ts +5 -0
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The parts of an OpenAPI 3.0 document that Cell generates. Fields Cell does not know are kept as they are,
|
|
3
|
+
* so a document can carry any extension from `openapi.document`.
|
|
4
|
+
*/
|
|
5
|
+
export interface OpenApiDocument {
|
|
6
|
+
openapi: string;
|
|
7
|
+
info: InfoObject;
|
|
8
|
+
servers?: ServerObject[];
|
|
9
|
+
paths: Record<string, PathItemObject>;
|
|
10
|
+
components?: ComponentsObject;
|
|
11
|
+
security?: SecurityRequirementObject[];
|
|
12
|
+
tags?: TagObject[];
|
|
13
|
+
externalDocs?: {
|
|
14
|
+
url: string;
|
|
15
|
+
description?: string;
|
|
16
|
+
};
|
|
17
|
+
[extension: string]: any;
|
|
18
|
+
}
|
|
19
|
+
export interface InfoObject {
|
|
20
|
+
title: string;
|
|
21
|
+
version: string;
|
|
22
|
+
description?: string;
|
|
23
|
+
[extension: string]: any;
|
|
24
|
+
}
|
|
25
|
+
export interface ServerObject {
|
|
26
|
+
url: string;
|
|
27
|
+
description?: string;
|
|
28
|
+
[extension: string]: any;
|
|
29
|
+
}
|
|
30
|
+
export interface TagObject {
|
|
31
|
+
name: string;
|
|
32
|
+
description?: string;
|
|
33
|
+
[extension: string]: any;
|
|
34
|
+
}
|
|
35
|
+
export type PathItemObject = Record<string, OperationObject>;
|
|
36
|
+
export interface OperationObject {
|
|
37
|
+
tags?: string[];
|
|
38
|
+
summary?: string;
|
|
39
|
+
description?: string;
|
|
40
|
+
operationId?: string;
|
|
41
|
+
parameters?: ParameterObject[];
|
|
42
|
+
requestBody?: RequestBodyObject;
|
|
43
|
+
responses: Record<string, ResponseObject>;
|
|
44
|
+
deprecated?: boolean;
|
|
45
|
+
security?: SecurityRequirementObject[];
|
|
46
|
+
[extension: string]: any;
|
|
47
|
+
}
|
|
48
|
+
export type ParameterLocation = 'path' | 'query' | 'header' | 'cookie';
|
|
49
|
+
export interface ParameterObject {
|
|
50
|
+
name: string;
|
|
51
|
+
in: ParameterLocation;
|
|
52
|
+
description?: string;
|
|
53
|
+
required?: boolean;
|
|
54
|
+
deprecated?: boolean;
|
|
55
|
+
schema?: SchemaObject;
|
|
56
|
+
example?: any;
|
|
57
|
+
[extension: string]: any;
|
|
58
|
+
}
|
|
59
|
+
export interface RequestBodyObject {
|
|
60
|
+
description?: string;
|
|
61
|
+
required?: boolean;
|
|
62
|
+
content: Record<string, MediaTypeObject>;
|
|
63
|
+
}
|
|
64
|
+
export interface MediaTypeObject {
|
|
65
|
+
schema?: SchemaObject;
|
|
66
|
+
example?: any;
|
|
67
|
+
}
|
|
68
|
+
export interface ResponseObject {
|
|
69
|
+
description: string;
|
|
70
|
+
content?: Record<string, MediaTypeObject>;
|
|
71
|
+
headers?: Record<string, {
|
|
72
|
+
description?: string;
|
|
73
|
+
schema?: SchemaObject;
|
|
74
|
+
}>;
|
|
75
|
+
}
|
|
76
|
+
export interface SchemaObject {
|
|
77
|
+
$ref?: string;
|
|
78
|
+
type?: 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object';
|
|
79
|
+
format?: string;
|
|
80
|
+
items?: SchemaObject;
|
|
81
|
+
properties?: Record<string, SchemaObject>;
|
|
82
|
+
required?: string[];
|
|
83
|
+
additionalProperties?: boolean | SchemaObject;
|
|
84
|
+
enum?: any[];
|
|
85
|
+
description?: string;
|
|
86
|
+
example?: any;
|
|
87
|
+
default?: any;
|
|
88
|
+
nullable?: boolean;
|
|
89
|
+
deprecated?: boolean;
|
|
90
|
+
readOnly?: boolean;
|
|
91
|
+
writeOnly?: boolean;
|
|
92
|
+
minimum?: number;
|
|
93
|
+
maximum?: number;
|
|
94
|
+
exclusiveMinimum?: boolean;
|
|
95
|
+
exclusiveMaximum?: boolean;
|
|
96
|
+
minLength?: number;
|
|
97
|
+
maxLength?: number;
|
|
98
|
+
pattern?: string;
|
|
99
|
+
minItems?: number;
|
|
100
|
+
maxItems?: number;
|
|
101
|
+
oneOf?: SchemaObject[];
|
|
102
|
+
allOf?: SchemaObject[];
|
|
103
|
+
anyOf?: SchemaObject[];
|
|
104
|
+
[extension: string]: any;
|
|
105
|
+
}
|
|
106
|
+
export interface ComponentsObject {
|
|
107
|
+
schemas?: Record<string, SchemaObject>;
|
|
108
|
+
securitySchemes?: Record<string, SecuritySchemeObject>;
|
|
109
|
+
[extension: string]: any;
|
|
110
|
+
}
|
|
111
|
+
export interface SecuritySchemeObject {
|
|
112
|
+
type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
|
|
113
|
+
description?: string;
|
|
114
|
+
name?: string;
|
|
115
|
+
in?: 'query' | 'header' | 'cookie';
|
|
116
|
+
scheme?: string;
|
|
117
|
+
bearerFormat?: string;
|
|
118
|
+
[extension: string]: any;
|
|
119
|
+
}
|
|
120
|
+
export type SecurityRequirementObject = Record<string, string[]>;
|
|
121
|
+
/**
|
|
122
|
+
* What describes the type of a property, a parameter, a body or a response:
|
|
123
|
+
* a class (`User`, `String`, `Number`, `Boolean`, `Date`), an array of one (`[User]`) or an OpenAPI type name (`'integer'`).
|
|
124
|
+
*/
|
|
125
|
+
export type TypeRef = Constructor | [Constructor] | [string] | NonNullable<SchemaObject['type']>;
|
|
126
|
+
/** A class, including the built-in ones (`String`, `Date`...) and abstract classes. */
|
|
127
|
+
export type Constructor = abstract new (...args: any[]) => any;
|
|
128
|
+
/** `openapi` in cell.yml (backend). */
|
|
129
|
+
export interface OpenApiOptions {
|
|
130
|
+
/** false: neither the document nor the UI is served. */
|
|
131
|
+
enabled: boolean;
|
|
132
|
+
/** Path of the JSON document, under `server.path`. */
|
|
133
|
+
url: string;
|
|
134
|
+
ui: {
|
|
135
|
+
enabled: boolean;
|
|
136
|
+
/** Path of the Swagger UI page, under `server.path`. */
|
|
137
|
+
url: string;
|
|
138
|
+
/** Where the page loads swagger-ui-dist from (swagger-ui.css, swagger-ui-bundle.js). */
|
|
139
|
+
cdn: string;
|
|
140
|
+
};
|
|
141
|
+
/** Merged into the generated document: info, servers, tags, components.securitySchemes, security... */
|
|
142
|
+
document: Partial<OpenApiDocument>;
|
|
143
|
+
}
|
|
144
|
+
//# sourceMappingURL=openapi-protocol.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi-protocol.d.ts","sourceRoot":"","sources":["../../src/common/openapi-protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACtC,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,QAAQ,CAAC,EAAE,yBAAyB,EAAE,CAAC;IACvC,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC;IACnB,YAAY,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACrD,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,CAAC;CAC5B;AAED,MAAM,WAAW,UAAU;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,CAAC;CAC5B;AAED,MAAM,WAAW,YAAY;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,CAAC;CAC5B;AAED,MAAM,WAAW,SAAS;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,CAAC;CAC5B;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AAE7D,MAAM,WAAW,eAAe;IAC5B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;IAC/B,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC1C,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,yBAAyB,EAAE,CAAC;IACvC,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,CAAC;CAC5B;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEvE,MAAM,WAAW,eAAe;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,iBAAiB,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,eAAe;IAC5B,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,OAAO,CAAC,EAAE,GAAG,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,YAAY,CAAA;KAAE,CAAC,CAAC;CAC7E;AAED,MAAM,WAAW,YAAY;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,CAAC;IACxE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC1C,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,oBAAoB,CAAC,EAAE,OAAO,GAAG,YAAY,CAAC;IAC9C,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;IACvB,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;IACvB,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;IACvB,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAgB;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IACvD,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACjC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,eAAe,CAAC;IACrD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,CAAC;CAC5B;AAED,MAAM,MAAM,yBAAyB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;AAEjE;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,WAAW,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;AAEjG,uFAAuF;AACvF,MAAM,MAAM,WAAW,GAAG,QAAQ,MAAM,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAE/D,uCAAuC;AACvC,MAAM,WAAW,cAAc;IAC3B,wDAAwD;IACxD,OAAO,EAAE,OAAO,CAAC;IACjB,sDAAsD;IACtD,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE;QACA,OAAO,EAAE,OAAO,CAAC;QACjB,wDAAwD;QACxD,GAAG,EAAE,MAAM,CAAC;QACZ,wFAAwF;QACxF,GAAG,EAAE,MAAM,CAAC;KACf,CAAC;IACF,uGAAuG;IACvG,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;CACtC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi-protocol.js","sourceRoot":"","sources":["../../src/common/openapi-protocol.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export * from './openapi-document-provider';
|
|
2
|
+
export * from './openapi-middleware';
|
|
3
|
+
export * from './openapi-node-protocol';
|
|
4
|
+
export * from './openapi-path-util';
|
|
5
|
+
export * from './schema-builder';
|
|
6
|
+
export * from './swagger-ui';
|
|
7
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/node/index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./openapi-document-provider"), exports);
|
|
18
|
+
__exportStar(require("./openapi-middleware"), exports);
|
|
19
|
+
__exportStar(require("./openapi-node-protocol"), exports);
|
|
20
|
+
__exportStar(require("./openapi-path-util"), exports);
|
|
21
|
+
__exportStar(require("./schema-builder"), exports);
|
|
22
|
+
__exportStar(require("./swagger-ui"), exports);
|
|
23
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/node/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8DAA4C;AAC5C,uDAAqC;AACrC,0DAAwC;AACxC,sDAAoC;AACpC,mDAAiC;AACjC,+CAA6B"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../src/node/module.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"module.js","sourceRoot":"","sources":["../../src/node/module.ts"],"names":[],"mappings":";;AAAA,uCAAwC;AACxC,mBAAiB;kBAEF,IAAA,eAAQ,GAAE"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { type PathRouteMetadata, type Route, RouteProvider } from '@celljs/mvc/lib/node';
|
|
2
|
+
import { type Constructor, type OpenApiDocument, type OpenApiOptions, type OperationObject, type ParameterObject, type PathItemObject, type RequestBodyObject, type ResponseObject, type SchemaObject } from '../common';
|
|
3
|
+
import { OpenApiDocumentProvider } from './openapi-node-protocol';
|
|
4
|
+
import { SchemaBuilder } from './schema-builder';
|
|
5
|
+
/** What one route of a controller method contributes, before it is placed under its paths. */
|
|
6
|
+
interface RouteOperation {
|
|
7
|
+
method: string;
|
|
8
|
+
pattern: string;
|
|
9
|
+
operation: OperationObject;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Builds the OpenAPI document from the routes of `@celljs/mvc` (the same metadata that serves the requests)
|
|
13
|
+
* and the `@Api*` decorators; `openapi.document` is merged over it.
|
|
14
|
+
*/
|
|
15
|
+
export declare class OpenApiDocumentProviderImpl implements OpenApiDocumentProvider {
|
|
16
|
+
protected readonly routeProvider: RouteProvider;
|
|
17
|
+
protected readonly options: OpenApiOptions;
|
|
18
|
+
protected readonly defaultViewName: string;
|
|
19
|
+
protected document?: Promise<OpenApiDocument>;
|
|
20
|
+
provide(): Promise<OpenApiDocument>;
|
|
21
|
+
protected build(route: Route): OpenApiDocument;
|
|
22
|
+
/** Places the operations under their OpenAPI paths, sorted by path then by method; operation ids stay unique. */
|
|
23
|
+
protected buildPaths(routes: RouteOperation[]): Record<string, PathItemObject>;
|
|
24
|
+
/** Keeps the path parameters of this path (optional parts differ), adds the undeclared ones as strings. */
|
|
25
|
+
protected withPathParameters(operation: OperationObject, names: string[], operationIds: Set<string>): OperationObject;
|
|
26
|
+
protected buildOperation(metadata: PathRouteMetadata, schemas: SchemaBuilder): OperationObject;
|
|
27
|
+
protected buildParameters(metadata: PathRouteMetadata, schemas: SchemaBuilder): ParameterObject[];
|
|
28
|
+
protected buildRequestBody(metadata: PathRouteMetadata, schemas: SchemaBuilder): RequestBodyObject | undefined;
|
|
29
|
+
protected buildResponses(metadata: PathRouteMetadata, schemas: SchemaBuilder): Record<string, ResponseObject>;
|
|
30
|
+
protected isExcluded(metadata: PathRouteMetadata): boolean;
|
|
31
|
+
protected usesScheme(paths: Record<string, PathItemObject>, scheme: string): boolean;
|
|
32
|
+
/** Path, query, header and cookie values are strings on the wire; a class or `any` there is documented as one. */
|
|
33
|
+
protected scalarSchema(schema: SchemaObject | undefined): SchemaObject;
|
|
34
|
+
protected isClass(type: any): type is Constructor;
|
|
35
|
+
protected parameterTypes(metadata: PathRouteMetadata): any[];
|
|
36
|
+
protected methodKey(metadata: PathRouteMetadata): string | symbol;
|
|
37
|
+
protected getMetadata(key: string, target: any, propertyKey?: string | symbol): any;
|
|
38
|
+
}
|
|
39
|
+
export {};
|
|
40
|
+
//# sourceMappingURL=openapi-document-provider.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi-document-provider.d.ts","sourceRoot":"","sources":["../../src/node/openapi-document-provider.ts"],"names":[],"mappings":"AACA,OAAO,EAA2C,KAAK,iBAAiB,EAAE,KAAK,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAClI,OAAO,EAIH,KAAK,WAAW,EAGhB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,eAAe,EAEpB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,YAAY,EAEpB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAElE,OAAO,EAAE,aAAa,EAAc,MAAM,kBAAkB,CAAC;AAiC7D,8FAA8F;AAC9F,UAAU,cAAc;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,eAAe,CAAC;CAC9B;AAED;;;GAGG;AACH,qBACa,2BAA4B,YAAW,uBAAuB;IAEvE,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IAGhD,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IAG3C,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAE3C,SAAS,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IAE9C,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,CAKlC;IAED,SAAS,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe,CAgC7C;IAED,iHAAiH;IACjH,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAsB7E;IAED,2GAA2G;IAC3G,SAAS,CAAC,kBAAkB,CAAC,SAAS,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,eAAe,CAuBpH;IAED,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,iBAAiB,EAAE,OAAO,EAAE,aAAa,GAAG,eAAe,CAuB7F;IAED,SAAS,CAAC,eAAe,CAAC,QAAQ,EAAE,iBAAiB,EAAE,OAAO,EAAE,aAAa,GAAG,eAAe,EAAE,CAmDhG;IAED,SAAS,CAAC,gBAAgB,CAAC,QAAQ,EAAE,iBAAiB,EAAE,OAAO,EAAE,aAAa,GAAG,iBAAiB,GAAG,SAAS,CAkB7G;IAED,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,iBAAiB,EAAE,OAAO,EAAE,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CA4B5G;IAED,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,GAAG,OAAO,CAGzD;IAED,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAInF;IAED,kHAAkH;IAClH,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,YAAY,GAAG,SAAS,GAAG,YAAY,CAKrE;IAED,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,IAAI,WAAW,CAEhD;IAED,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,iBAAiB,GAAG,GAAG,EAAE,CAE3D;IAED,SAAS,CAAC,SAAS,CAAC,QAAQ,EAAE,iBAAiB,GAAG,MAAM,GAAG,MAAM,CAEhE;IAED,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,GAAG,CAElF;CACJ"}
|
|
@@ -0,0 +1,313 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.OpenApiDocumentProviderImpl = void 0;
|
|
13
|
+
const core_1 = require("@celljs/core");
|
|
14
|
+
const node_1 = require("@celljs/mvc/lib/node");
|
|
15
|
+
const common_1 = require("../common");
|
|
16
|
+
const openapi_node_protocol_1 = require("./openapi-node-protocol");
|
|
17
|
+
const openapi_path_util_1 = require("./openapi-path-util");
|
|
18
|
+
const schema_builder_1 = require("./schema-builder");
|
|
19
|
+
const METHOD_ORDER = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace'];
|
|
20
|
+
const STATUS_DESCRIPTIONS = {
|
|
21
|
+
200: 'OK',
|
|
22
|
+
201: 'Created',
|
|
23
|
+
202: 'Accepted',
|
|
24
|
+
204: 'No Content',
|
|
25
|
+
301: 'Moved Permanently',
|
|
26
|
+
302: 'Found',
|
|
27
|
+
304: 'Not Modified',
|
|
28
|
+
400: 'Bad Request',
|
|
29
|
+
401: 'Unauthorized',
|
|
30
|
+
403: 'Forbidden',
|
|
31
|
+
404: 'Not Found',
|
|
32
|
+
409: 'Conflict',
|
|
33
|
+
422: 'Unprocessable Entity',
|
|
34
|
+
429: 'Too Many Requests',
|
|
35
|
+
500: 'Internal Server Error',
|
|
36
|
+
default: 'Unexpected error',
|
|
37
|
+
};
|
|
38
|
+
const VIEW_CONTENT_TYPES = {
|
|
39
|
+
json: 'application/json',
|
|
40
|
+
text: 'text/plain',
|
|
41
|
+
html: 'text/html',
|
|
42
|
+
file: 'application/octet-stream',
|
|
43
|
+
};
|
|
44
|
+
/** Types that are not classes of the application. */
|
|
45
|
+
const BUILT_IN_TYPES = [String, Number, Boolean, Date, Object, Array, Promise, Function, Symbol];
|
|
46
|
+
/**
|
|
47
|
+
* Builds the OpenAPI document from the routes of `@celljs/mvc` (the same metadata that serves the requests)
|
|
48
|
+
* and the `@Api*` decorators; `openapi.document` is merged over it.
|
|
49
|
+
*/
|
|
50
|
+
let OpenApiDocumentProviderImpl = class OpenApiDocumentProviderImpl {
|
|
51
|
+
provide() {
|
|
52
|
+
if (!this.document) {
|
|
53
|
+
this.document = this.routeProvider.provide().then(route => this.build(route));
|
|
54
|
+
}
|
|
55
|
+
return this.document;
|
|
56
|
+
}
|
|
57
|
+
build(route) {
|
|
58
|
+
var _a, _b, _c;
|
|
59
|
+
const base = ((_a = this.options) === null || _a === void 0 ? void 0 : _a.document) || {};
|
|
60
|
+
const schemas = new schema_builder_1.SchemaBuilder();
|
|
61
|
+
const routes = [];
|
|
62
|
+
for (const [method, metadatas] of route.mapping) {
|
|
63
|
+
for (const metadata of metadatas) {
|
|
64
|
+
if (typeof metadata.path === 'string' && !this.isExcluded(metadata)) {
|
|
65
|
+
routes.push({ method: method.toLowerCase(), pattern: metadata.path, operation: this.buildOperation(metadata, schemas) });
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
const paths = this.buildPaths(routes);
|
|
70
|
+
const securitySchemes = { ...(_b = base.components) === null || _b === void 0 ? void 0 : _b.securitySchemes };
|
|
71
|
+
if (this.usesScheme(paths, common_1.DEFAULT_BEARER_SCHEME) && !securitySchemes[common_1.DEFAULT_BEARER_SCHEME]) {
|
|
72
|
+
securitySchemes[common_1.DEFAULT_BEARER_SCHEME] = { type: 'http', scheme: 'bearer', bearerFormat: 'JWT' };
|
|
73
|
+
}
|
|
74
|
+
const components = { ...base.components, schemas: { ...schemas.schemas, ...(_c = base.components) === null || _c === void 0 ? void 0 : _c.schemas }, securitySchemes };
|
|
75
|
+
for (const key of ['schemas', 'securitySchemes']) {
|
|
76
|
+
if (!Object.keys(components[key]).length) {
|
|
77
|
+
delete components[key];
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
const document = {
|
|
81
|
+
...base,
|
|
82
|
+
openapi: base.openapi || '3.0.3',
|
|
83
|
+
info: { title: 'API', version: '1.0.0', ...base.info },
|
|
84
|
+
paths: { ...paths, ...base.paths },
|
|
85
|
+
};
|
|
86
|
+
if (Object.keys(components).length) {
|
|
87
|
+
document.components = components;
|
|
88
|
+
}
|
|
89
|
+
return document;
|
|
90
|
+
}
|
|
91
|
+
/** Places the operations under their OpenAPI paths, sorted by path then by method; operation ids stay unique. */
|
|
92
|
+
buildPaths(routes) {
|
|
93
|
+
const items = {};
|
|
94
|
+
const operationIds = new Set();
|
|
95
|
+
for (const { method, pattern, operation } of routes) {
|
|
96
|
+
for (const expanded of openapi_path_util_1.OpenApiPathUtil.expand(pattern)) {
|
|
97
|
+
const { path, names } = openapi_path_util_1.OpenApiPathUtil.convert(expanded);
|
|
98
|
+
items[path] = items[path] || {};
|
|
99
|
+
const item = items[path];
|
|
100
|
+
if (item[method]) {
|
|
101
|
+
continue;
|
|
102
|
+
}
|
|
103
|
+
item[method] = this.withPathParameters({ ...operation }, names, operationIds);
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
const sorted = {};
|
|
107
|
+
for (const path of Object.keys(items).sort()) {
|
|
108
|
+
sorted[path] = {};
|
|
109
|
+
for (const method of Object.keys(items[path]).sort((a, b) => METHOD_ORDER.indexOf(a) - METHOD_ORDER.indexOf(b))) {
|
|
110
|
+
sorted[path][method] = items[path][method];
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
return sorted;
|
|
114
|
+
}
|
|
115
|
+
/** Keeps the path parameters of this path (optional parts differ), adds the undeclared ones as strings. */
|
|
116
|
+
withPathParameters(operation, names, operationIds) {
|
|
117
|
+
const declared = operation.parameters || [];
|
|
118
|
+
const parameters = declared.filter(p => p.in !== 'path' || names.includes(p.name));
|
|
119
|
+
for (const name of names) {
|
|
120
|
+
if (!parameters.some(p => p.in === 'path' && p.name === name)) {
|
|
121
|
+
parameters.push({ name, in: 'path', required: true, schema: { type: 'string' } });
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
parameters.sort((a, b) => Number(b.in === 'path') - Number(a.in === 'path'));
|
|
125
|
+
if (parameters.length) {
|
|
126
|
+
operation.parameters = parameters;
|
|
127
|
+
}
|
|
128
|
+
else {
|
|
129
|
+
delete operation.parameters;
|
|
130
|
+
}
|
|
131
|
+
if (operation.operationId) {
|
|
132
|
+
let id = operation.operationId;
|
|
133
|
+
for (let i = 2; operationIds.has(id); i++) {
|
|
134
|
+
id = `${operation.operationId}_${i}`;
|
|
135
|
+
}
|
|
136
|
+
operationIds.add(id);
|
|
137
|
+
operation.operationId = id;
|
|
138
|
+
}
|
|
139
|
+
return operation;
|
|
140
|
+
}
|
|
141
|
+
buildOperation(metadata, schemas) {
|
|
142
|
+
const target = metadata.controllerMetadata.target;
|
|
143
|
+
const key = metadata.methodMetadata.key;
|
|
144
|
+
const options = this.getMetadata(common_1.OPENAPI_METADATA_KEY.operation, target, key) || {};
|
|
145
|
+
const tags = this.getMetadata(common_1.OPENAPI_METADATA_KEY.tags, target, key) ||
|
|
146
|
+
this.getMetadata(common_1.OPENAPI_METADATA_KEY.tags, target) || [target.name.replace(/Controller$/, '') || target.name];
|
|
147
|
+
const operation = {
|
|
148
|
+
tags,
|
|
149
|
+
summary: options.summary,
|
|
150
|
+
description: options.description,
|
|
151
|
+
operationId: options.operationId || `${target.name}_${key.toString()}`,
|
|
152
|
+
parameters: this.buildParameters(metadata, schemas),
|
|
153
|
+
requestBody: this.buildRequestBody(metadata, schemas),
|
|
154
|
+
responses: this.buildResponses(metadata, schemas),
|
|
155
|
+
deprecated: options.deprecated,
|
|
156
|
+
security: this.getMetadata(common_1.OPENAPI_METADATA_KEY.security, target, key) || this.getMetadata(common_1.OPENAPI_METADATA_KEY.security, target),
|
|
157
|
+
};
|
|
158
|
+
for (const name of Object.keys(operation)) {
|
|
159
|
+
if (operation[name] === undefined) {
|
|
160
|
+
delete operation[name];
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
return operation;
|
|
164
|
+
}
|
|
165
|
+
buildParameters(metadata, schemas) {
|
|
166
|
+
const types = this.parameterTypes(metadata);
|
|
167
|
+
const parameters = [];
|
|
168
|
+
const add = (location, list = []) => {
|
|
169
|
+
var _a;
|
|
170
|
+
for (const { name, parameterIndex } of list) {
|
|
171
|
+
const type = types[parameterIndex];
|
|
172
|
+
if (name) {
|
|
173
|
+
parameters.push({ name, in: location, required: location === 'path' || undefined, schema: this.scalarSchema(schemas.resolve(type)) });
|
|
174
|
+
}
|
|
175
|
+
else if (location === 'query' && this.isClass(type)) {
|
|
176
|
+
// `@Query() filter: Filter`: the properties of the class are the query parameters.
|
|
177
|
+
const schema = schemas.build(type);
|
|
178
|
+
for (const [property, propertySchema] of Object.entries(schema.properties || {})) {
|
|
179
|
+
const { description, example, deprecated, ...rest } = propertySchema;
|
|
180
|
+
const required = ((_a = schema.required) === null || _a === void 0 ? void 0 : _a.includes(property)) || undefined;
|
|
181
|
+
parameters.push({ name: property, in: 'query', description, required, deprecated, example, schema: rest });
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
};
|
|
186
|
+
add('path', metadata.paramMetadata);
|
|
187
|
+
add('query', metadata.queryMetadata);
|
|
188
|
+
add('header', metadata.requestHeaderMetadata);
|
|
189
|
+
add('cookie', metadata.requestCookieMetadata);
|
|
190
|
+
const explicit = this.getMetadata(common_1.OPENAPI_METADATA_KEY.parameters, metadata.controllerMetadata.target, this.methodKey(metadata)) || [];
|
|
191
|
+
for (const { name, in: location, description, example, deprecated, ...schemaOptions } of explicit) {
|
|
192
|
+
const index = parameters.findIndex(p => p.name === name && p.in === location);
|
|
193
|
+
const found = index === -1 ? { name, in: location, schema: { type: 'string' } } : parameters[index];
|
|
194
|
+
const { required } = schemaOptions;
|
|
195
|
+
const parameter = {
|
|
196
|
+
...found,
|
|
197
|
+
description: description !== null && description !== void 0 ? description : found.description,
|
|
198
|
+
required: location === 'path' ? true : (required !== null && required !== void 0 ? required : found.required),
|
|
199
|
+
deprecated: deprecated !== null && deprecated !== void 0 ? deprecated : found.deprecated,
|
|
200
|
+
example: example !== null && example !== void 0 ? example : found.example,
|
|
201
|
+
schema: schema_builder_1.SchemaUtil.normalize(schemas.fromOptions(schemaOptions, found.schema)),
|
|
202
|
+
};
|
|
203
|
+
if (index === -1) {
|
|
204
|
+
parameters.push(parameter);
|
|
205
|
+
}
|
|
206
|
+
else {
|
|
207
|
+
parameters[index] = parameter;
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
for (const parameter of parameters) {
|
|
211
|
+
for (const field of ['description', 'required', 'deprecated', 'example']) {
|
|
212
|
+
if (parameter[field] === undefined) {
|
|
213
|
+
delete parameter[field];
|
|
214
|
+
}
|
|
215
|
+
}
|
|
216
|
+
}
|
|
217
|
+
return parameters;
|
|
218
|
+
}
|
|
219
|
+
buildRequestBody(metadata, schemas) {
|
|
220
|
+
const bodies = metadata.bodyMetadata || [];
|
|
221
|
+
if (!bodies.length) {
|
|
222
|
+
return undefined;
|
|
223
|
+
}
|
|
224
|
+
const types = this.parameterTypes(metadata);
|
|
225
|
+
const whole = bodies.find(body => !body.name);
|
|
226
|
+
let schema;
|
|
227
|
+
if (whole) {
|
|
228
|
+
schema = schemas.resolve(types[whole.parameterIndex]) || { type: 'object' };
|
|
229
|
+
}
|
|
230
|
+
else {
|
|
231
|
+
const properties = {};
|
|
232
|
+
for (const { name, parameterIndex } of bodies) {
|
|
233
|
+
properties[name] = schemas.resolve(types[parameterIndex]) || {};
|
|
234
|
+
}
|
|
235
|
+
schema = { type: 'object', properties, required: Object.keys(properties) };
|
|
236
|
+
}
|
|
237
|
+
return { required: true, content: { 'application/json': { schema } } };
|
|
238
|
+
}
|
|
239
|
+
buildResponses(metadata, schemas) {
|
|
240
|
+
var _a;
|
|
241
|
+
var _b;
|
|
242
|
+
const target = metadata.controllerMetadata.target;
|
|
243
|
+
const key = this.methodKey(metadata);
|
|
244
|
+
const contentType = VIEW_CONTENT_TYPES[((_a = metadata.viewMetadata) === null || _a === void 0 ? void 0 : _a.viewName) || this.defaultViewName] || VIEW_CONTENT_TYPES.json;
|
|
245
|
+
const declared = [
|
|
246
|
+
...(this.getMetadata(common_1.OPENAPI_METADATA_KEY.responses, target) || []),
|
|
247
|
+
...(this.getMetadata(common_1.OPENAPI_METADATA_KEY.responses, target, key) || []),
|
|
248
|
+
];
|
|
249
|
+
const responses = {};
|
|
250
|
+
for (const options of declared) {
|
|
251
|
+
const status = String((_b = options.status) !== null && _b !== void 0 ? _b : 200);
|
|
252
|
+
const response = { description: options.description || STATUS_DESCRIPTIONS[status] || 'Response' };
|
|
253
|
+
const schema = options.schema || schemas.resolve(options.type);
|
|
254
|
+
if (schema) {
|
|
255
|
+
response.content = { [options.contentType || contentType]: { schema } };
|
|
256
|
+
}
|
|
257
|
+
responses[status] = response;
|
|
258
|
+
}
|
|
259
|
+
if (!Object.keys(responses).some(status => status.startsWith('2'))) {
|
|
260
|
+
const returnType = Reflect.getMetadata('design:returntype', target.prototype, key);
|
|
261
|
+
const response = { description: 'OK' };
|
|
262
|
+
if (returnType !== undefined) {
|
|
263
|
+
const schema = contentType === VIEW_CONTENT_TYPES.text ? { type: 'string' } : schemas.resolve(returnType);
|
|
264
|
+
response.content = { [contentType]: schema ? { schema } : {} };
|
|
265
|
+
}
|
|
266
|
+
responses['200'] = response;
|
|
267
|
+
}
|
|
268
|
+
return Object.fromEntries(Object.entries(responses).sort(([a], [b]) => a.localeCompare(b)));
|
|
269
|
+
}
|
|
270
|
+
isExcluded(metadata) {
|
|
271
|
+
const target = metadata.controllerMetadata.target;
|
|
272
|
+
return !!(this.getMetadata(common_1.OPENAPI_METADATA_KEY.exclude, target) || this.getMetadata(common_1.OPENAPI_METADATA_KEY.exclude, target, this.methodKey(metadata)));
|
|
273
|
+
}
|
|
274
|
+
usesScheme(paths, scheme) {
|
|
275
|
+
return Object.values(paths).some(item => Object.values(item).some(operation => (operation.security || []).some((requirement) => scheme in requirement)));
|
|
276
|
+
}
|
|
277
|
+
/** Path, query, header and cookie values are strings on the wire; a class or `any` there is documented as one. */
|
|
278
|
+
scalarSchema(schema) {
|
|
279
|
+
if (!schema || schema.$ref || schema.type === 'object') {
|
|
280
|
+
return { type: 'string' };
|
|
281
|
+
}
|
|
282
|
+
return schema;
|
|
283
|
+
}
|
|
284
|
+
isClass(type) {
|
|
285
|
+
return typeof type === 'function' && !BUILT_IN_TYPES.includes(type);
|
|
286
|
+
}
|
|
287
|
+
parameterTypes(metadata) {
|
|
288
|
+
return Reflect.getMetadata('design:paramtypes', metadata.controllerMetadata.target.prototype, this.methodKey(metadata)) || [];
|
|
289
|
+
}
|
|
290
|
+
methodKey(metadata) {
|
|
291
|
+
return metadata.methodMetadata.key;
|
|
292
|
+
}
|
|
293
|
+
getMetadata(key, target, propertyKey) {
|
|
294
|
+
return propertyKey === undefined ? Reflect.getMetadata(key, target) : Reflect.getMetadata(key, target, propertyKey);
|
|
295
|
+
}
|
|
296
|
+
};
|
|
297
|
+
exports.OpenApiDocumentProviderImpl = OpenApiDocumentProviderImpl;
|
|
298
|
+
__decorate([
|
|
299
|
+
(0, core_1.Autowired)(node_1.RouteProvider),
|
|
300
|
+
__metadata("design:type", Object)
|
|
301
|
+
], OpenApiDocumentProviderImpl.prototype, "routeProvider", void 0);
|
|
302
|
+
__decorate([
|
|
303
|
+
(0, core_1.Value)('openapi'),
|
|
304
|
+
__metadata("design:type", Object)
|
|
305
|
+
], OpenApiDocumentProviderImpl.prototype, "options", void 0);
|
|
306
|
+
__decorate([
|
|
307
|
+
(0, core_1.Value)('mvc.defaultViewName'),
|
|
308
|
+
__metadata("design:type", String)
|
|
309
|
+
], OpenApiDocumentProviderImpl.prototype, "defaultViewName", void 0);
|
|
310
|
+
exports.OpenApiDocumentProviderImpl = OpenApiDocumentProviderImpl = __decorate([
|
|
311
|
+
(0, core_1.Component)(openapi_node_protocol_1.OpenApiDocumentProvider)
|
|
312
|
+
], OpenApiDocumentProviderImpl);
|
|
313
|
+
//# sourceMappingURL=openapi-document-provider.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi-document-provider.js","sourceRoot":"","sources":["../../src/node/openapi-document-provider.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uCAA2D;AAC3D,+CAAkI;AAClI,sCAiBmB;AACnB,mEAAkE;AAClE,2DAAsD;AACtD,qDAA6D;AAE7D,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;AAE3F,MAAM,mBAAmB,GAA2B;IAChD,GAAG,EAAE,IAAI;IACT,GAAG,EAAE,SAAS;IACd,GAAG,EAAE,UAAU;IACf,GAAG,EAAE,YAAY;IACjB,GAAG,EAAE,mBAAmB;IACxB,GAAG,EAAE,OAAO;IACZ,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,aAAa;IAClB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,UAAU;IACf,GAAG,EAAE,sBAAsB;IAC3B,GAAG,EAAE,mBAAmB;IACxB,GAAG,EAAE,uBAAuB;IAC5B,OAAO,EAAE,kBAAkB;CAC9B,CAAC;AAEF,MAAM,kBAAkB,GAA2B;IAC/C,IAAI,EAAE,kBAAkB;IACxB,IAAI,EAAE,YAAY;IAClB,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,0BAA0B;CACnC,CAAC;AAEF,qDAAqD;AACrD,MAAM,cAAc,GAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AAS5G;;;GAGG;AAEI,IAAM,2BAA2B,GAAjC,MAAM,2BAA2B;IAYpC,OAAO;QACH,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QAClF,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAES,KAAK,CAAC,KAAY;;QACxB,MAAM,IAAI,GAAG,CAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,QAAQ,KAAI,EAAE,CAAC;QAC1C,MAAM,OAAO,GAAG,IAAI,8BAAa,EAAE,CAAC;QACpC,MAAM,MAAM,GAAqB,EAAE,CAAC;QACpC,KAAK,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAC9C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBAC/B,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAClE,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;gBAC7H,CAAC;YACL,CAAC;QACL,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACtC,MAAM,eAAe,GAAG,EAAE,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,eAAe,EAAE,CAAC;QAChE,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,8BAAqB,CAAC,IAAI,CAAC,eAAe,CAAC,8BAAqB,CAAC,EAAE,CAAC;YAC3F,eAAe,CAAC,8BAAqB,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC;QACrG,CAAC;QACD,MAAM,UAAU,GAAG,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,OAAO,EAAE,EAAE,eAAe,EAAE,CAAC;QACzH,KAAK,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,iBAAiB,CAAU,EAAE,CAAC;YACxD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;gBACvC,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC;YAC3B,CAAC;QACL,CAAC;QACD,MAAM,QAAQ,GAAoB;YAC9B,GAAG,IAAI;YACP,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,OAAO;YAChC,IAAI,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE;YACtD,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE;SACrC,CAAC;QACF,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC;YACjC,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC;QACrC,CAAC;QACD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,iHAAiH;IACvG,UAAU,CAAC,MAAwB;QACzC,MAAM,KAAK,GAAmC,EAAE,CAAC;QACjD,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAC;QACvC,KAAK,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,MAAM,EAAE,CAAC;YAClD,KAAK,MAAM,QAAQ,IAAI,mCAAe,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBACrD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,mCAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAC1D,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBAChC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;gBACzB,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;oBACf,SAAS;gBACb,CAAC;gBACD,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC,EAAE,GAAG,SAAS,EAAE,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;YAClF,CAAC;QACL,CAAC;QACD,MAAM,MAAM,GAAmC,EAAE,CAAC;QAClD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;YAC3C,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YAClB,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC9G,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;YAC/C,CAAC;QACL,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,2GAA2G;IACjG,kBAAkB,CAAC,SAA0B,EAAE,KAAe,EAAE,YAAyB;QAC/F,MAAM,QAAQ,GAAG,SAAS,CAAC,UAAU,IAAI,EAAE,CAAC;QAC5C,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACnF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,IAAI,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;gBAC5D,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;YACtF,CAAC;QACL,CAAC;QACD,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC,CAAC;QAC7E,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;YACpB,SAAS,CAAC,UAAU,GAAG,UAAU,CAAC;QACtC,CAAC;aAAM,CAAC;YACJ,OAAO,SAAS,CAAC,UAAU,CAAC;QAChC,CAAC;QACD,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;YACxB,IAAI,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC;YAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBACxC,EAAE,GAAG,GAAG,SAAS,CAAC,WAAW,IAAI,CAAC,EAAE,CAAC;YACzC,CAAC;YACD,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACrB,SAAS,CAAC,WAAW,GAAG,EAAE,CAAC;QAC/B,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAES,cAAc,CAAC,QAA2B,EAAE,OAAsB;QACxE,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,MAAM,CAAC;QAClD,MAAM,GAAG,GAAI,QAAQ,CAAC,cAAiD,CAAC,GAAG,CAAC;QAC5E,MAAM,OAAO,GAAwB,IAAI,CAAC,WAAW,CAAC,6BAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC;QACzG,MAAM,IAAI,GAAa,IAAI,CAAC,WAAW,CAAC,6BAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC;YAC3E,IAAI,CAAC,WAAW,CAAC,6BAAoB,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;QACnH,MAAM,SAAS,GAAoB;YAC/B,IAAI;YACJ,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,GAAG,CAAC,QAAQ,EAAE,EAAE;YACtE,UAAU,EAAE,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,OAAO,CAAC;YACnD,WAAW,EAAE,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC;YACrD,SAAS,EAAE,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC;YACjD,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,6BAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,6BAAoB,CAAC,QAAQ,EAAE,MAAM,CAAC;SACpI,CAAC;QACF,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACxC,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBAChC,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;YAC3B,CAAC;QACL,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAES,eAAe,CAAC,QAA2B,EAAE,OAAsB;QACzE,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC5C,MAAM,UAAU,GAAsB,EAAE,CAAC;QACzC,MAAM,GAAG,GAAG,CAAC,QAA2B,EAAE,IAAI,GAAgD,EAAE,EAAE,EAAE;;YAChG,KAAK,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,IAAI,EAAE,CAAC;gBAC1C,MAAM,IAAI,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;gBACnC,IAAI,IAAI,EAAE,CAAC;oBACP,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,KAAK,MAAM,IAAI,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;gBAC1I,CAAC;qBAAM,IAAI,QAAQ,KAAK,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBACpD,mFAAmF;oBACnF,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACnC,KAAK,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,EAAE,CAAC;wBAC/E,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,cAAc,CAAC;wBACrE,MAAM,QAAQ,GAAG,CAAA,MAAA,MAAM,CAAC,QAAQ,0CAAE,QAAQ,CAAC,QAAQ,CAAC,KAAI,SAAS,CAAC;wBAClE,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;oBAC/G,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC,CAAC;QACF,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;QACpC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;QACrC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,qBAAqB,CAAC,CAAC;QAC9C,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,qBAAqB,CAAC,CAAC;QAC9C,MAAM,QAAQ,GACV,IAAI,CAAC,WAAW,CAAC,6BAAoB,CAAC,UAAU,EAAE,QAAQ,CAAC,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;QAC1H,KAAK,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,aAAa,EAAE,IAAI,QAAQ,EAAE,CAAC;YAChG,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC;YAC9E,MAAM,KAAK,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAE,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAsB,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACzH,MAAM,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC;YACnC,MAAM,SAAS,GAAoB;gBAC/B,GAAG,KAAK;gBACR,WAAW,EAAE,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,KAAK,CAAC,WAAW;gBAC7C,QAAQ,EAAE,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,KAAK,CAAC,QAAQ,CAAC;gBACnE,UAAU,EAAE,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,KAAK,CAAC,UAAU;gBAC1C,OAAO,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,KAAK,CAAC,OAAO;gBACjC,MAAM,EAAE,2BAAU,CAAC,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;aACjF,CAAC;YACF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBACf,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACJ,UAAU,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;YAClC,CAAC;QACL,CAAC;QACD,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACjC,KAAK,MAAM,KAAK,IAAI,CAAC,aAAa,EAAE,UAAU,EAAE,YAAY,EAAE,SAAS,CAAU,EAAE,CAAC;gBAChF,IAAI,SAAS,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;oBACjC,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC;gBAC5B,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,UAAU,CAAC;IACtB,CAAC;IAES,gBAAgB,CAAC,QAA2B,EAAE,OAAsB;QAC1E,MAAM,MAAM,GAAG,QAAQ,CAAC,YAAY,IAAI,EAAE,CAAC;QAC3C,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACjB,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC5C,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,MAAoB,CAAC;QACzB,IAAI,KAAK,EAAE,CAAC;YACR,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAChF,CAAC;aAAM,CAAC;YACJ,MAAM,UAAU,GAAiC,EAAE,CAAC;YACpD,KAAK,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,MAAM,EAAE,CAAC;gBAC5C,UAAU,CAAC,IAAc,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,IAAI,EAAE,CAAC;YAC9E,CAAC;YACD,MAAM,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/E,CAAC;QACD,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAC3E,CAAC;IAES,cAAc,CAAC,QAA2B,EAAE,OAAsB;;;QACxE,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,MAAM,CAAC;QAClD,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACrC,MAAM,WAAW,GAAG,kBAAkB,CAAC,CAAA,MAAA,QAAQ,CAAC,YAAY,0CAAE,QAAQ,KAAI,IAAI,CAAC,eAAe,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC;QAC3H,MAAM,QAAQ,GAAyB;YACnC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,6BAAoB,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;YACnE,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,6BAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC;SAC3E,CAAC;QACF,MAAM,SAAS,GAAmC,EAAE,CAAC;QACrD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAG,MAAM,OAAC,OAAO,CAAC,MAAM,mCAAI,GAAG,CAAC,CAAC;YAC7C,MAAM,QAAQ,GAAmB,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,mBAAmB,CAAC,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;YACnH,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC/D,IAAI,MAAM,EAAE,CAAC;gBACT,QAAQ,CAAC,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,WAAW,IAAI,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC;YAC5E,CAAC;YACD,SAAS,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC;QACjC,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YACjE,MAAM,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,mBAAmB,EAAE,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;YACnF,MAAM,QAAQ,GAAmB,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;YACvD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC3B,MAAM,MAAM,GAAG,WAAW,KAAK,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAiB,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;gBACnH,QAAQ,CAAC,OAAO,GAAG,EAAE,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;YACnE,CAAC;YACD,SAAS,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC;QAChC,CAAC;QACD,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChG,CAAC;IAES,UAAU,CAAC,QAA2B;QAC5C,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,MAAM,CAAC;QAClD,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,6BAAoB,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,6BAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC1J,CAAC;IAES,UAAU,CAAC,KAAqC,EAAE,MAAc;QACtE,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACpC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,WAAsC,EAAE,EAAE,CAAC,MAAM,IAAI,WAAW,CAAC,CAAC,CAC5I,CAAC;IACN,CAAC;IAED,kHAAkH;IACxG,YAAY,CAAC,MAAgC;QACnD,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACrD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC9B,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAES,OAAO,CAAC,IAAS;QACvB,OAAO,OAAO,IAAI,KAAK,UAAU,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACxE,CAAC;IAES,cAAc,CAAC,QAA2B;QAChD,OAAO,OAAO,CAAC,WAAW,CAAC,mBAAmB,EAAE,QAAQ,CAAC,kBAAkB,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;IAClI,CAAC;IAES,SAAS,CAAC,QAA2B;QAC3C,OAAQ,QAAQ,CAAC,cAAiC,CAAC,GAAG,CAAC;IAC3D,CAAC;IAES,WAAW,CAAC,GAAW,EAAE,MAAW,EAAE,WAA6B;QACzE,OAAO,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IACxH,CAAC;CACJ,CAAA;;AAxQsB;IADlB,IAAA,gBAAS,EAAC,oBAAa,CAAC;;kEACuB;AAG7B;IADlB,IAAA,YAAK,EAAC,SAAS,CAAC;;4DAC0B;AAGxB;IADlB,IAAA,YAAK,EAAC,qBAAqB,CAAC;;oEACc;sCARlC,2BAA2B;IADvC,IAAA,gBAAS,EAAC,+CAAuB,CAAC;GACtB,2BAA2B,CA0QvC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { PathResolver } from '@celljs/web';
|
|
2
|
+
import { type Context, Middleware, RequestMatcher } from '@celljs/web/lib/node';
|
|
3
|
+
import type { OpenApiOptions } from '../common';
|
|
4
|
+
import { OpenApiDocumentProvider } from './openapi-node-protocol';
|
|
5
|
+
/**
|
|
6
|
+
* Serves the document (`openapi.url`) and the Swagger UI page (`openapi.ui.url`) for GET requests
|
|
7
|
+
* that no controller answered, so it costs nothing to the other requests.
|
|
8
|
+
*/
|
|
9
|
+
export declare class OpenApiMiddleware implements Middleware {
|
|
10
|
+
protected readonly documentProvider: OpenApiDocumentProvider;
|
|
11
|
+
protected readonly requestMatcher: RequestMatcher;
|
|
12
|
+
protected readonly pathResolver: PathResolver;
|
|
13
|
+
protected readonly options: OpenApiOptions;
|
|
14
|
+
readonly priority: number;
|
|
15
|
+
handle(ctx: Context, next: () => Promise<void>): Promise<void>;
|
|
16
|
+
protected serve({ response }: Context): Promise<boolean>;
|
|
17
|
+
}
|
|
18
|
+
//# sourceMappingURL=openapi-middleware.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi-middleware.d.ts","sourceRoot":"","sources":["../../src/node/openapi-middleware.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,KAAK,OAAO,EAAE,UAAU,EAAiB,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC/F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAA+B,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAG/F;;;GAGG;AACH,qBACa,iBAAkB,YAAW,UAAU;IAEhD,SAAS,CAAC,QAAQ,CAAC,gBAAgB,EAAE,uBAAuB,CAAC;IAG7D,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IAGlD,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAG9C,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IAE3C,QAAQ,CAAC,QAAQ,SAA+B;IAE1C,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CASnE;IAED,UAAgB,KAAK,CAAC,EAAE,QAAQ,EAAE,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAkB7D;CACJ"}
|