@redocly/openapi-core 1.18.0 → 1.19.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/CHANGELOG.md +20 -0
- package/lib/benchmark/benches/lint-with-many-rules.bench.js +2 -2
- package/lib/benchmark/benches/lint-with-nested-rule.bench.js +2 -2
- package/lib/benchmark/benches/lint-with-no-rules.bench.js +2 -2
- package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.js +2 -2
- package/lib/benchmark/benches/lint-with-top-level-rule.bench.js +2 -2
- package/lib/benchmark/benches/recommended-oas3.bench.js +2 -2
- package/lib/benchmark/benches/resolve-with-no-external.bench.js +2 -2
- package/lib/benchmark/utils.js +7 -4
- package/lib/bundle.d.ts +3 -3
- package/lib/bundle.js +128 -122
- package/lib/config/all.js +9 -0
- package/lib/config/builtIn.js +7 -1
- package/lib/config/config-resolvers.js +179 -138
- package/lib/config/config.d.ts +2 -2
- package/lib/config/config.js +53 -34
- package/lib/config/load.d.ts +1 -2
- package/lib/config/load.js +105 -117
- package/lib/config/minimal.js +9 -0
- package/lib/config/recommended-strict.js +9 -0
- package/lib/config/recommended.js +9 -0
- package/lib/config/rules.d.ts +3 -3
- package/lib/config/rules.js +1 -2
- package/lib/config/types.d.ts +9 -3
- package/lib/config/utils.js +70 -49
- package/lib/decorators/async3/index.d.ts +1 -0
- package/lib/decorators/async3/index.js +4 -0
- package/lib/decorators/common/filters/filter-helper.js +2 -3
- package/lib/decorators/common/filters/filter-in.js +1 -1
- package/lib/decorators/common/filters/filter-out.js +1 -1
- package/lib/decorators/common/info-override.js +1 -12
- package/lib/decorators/common/media-type-examples-override.js +8 -2
- package/lib/decorators/common/remove-x-internal.js +4 -5
- package/lib/decorators/oas2/remove-unused-components.js +1 -2
- package/lib/decorators/oas3/remove-unused-components.js +1 -2
- package/lib/env.d.ts +0 -1
- package/lib/env.js +1 -1
- package/lib/format/codeframes.js +10 -8
- package/lib/format/format.js +23 -15
- package/lib/index.d.ts +2 -1
- package/lib/index.js +6 -4
- package/lib/js-yaml/index.js +1 -1
- package/lib/lint.d.ts +2 -0
- package/lib/lint.js +92 -99
- package/lib/oas-types.d.ts +9 -5
- package/lib/oas-types.js +22 -12
- package/lib/redocly/domains.js +6 -6
- package/lib/redocly/index.js +60 -73
- package/lib/redocly/registry-api.js +64 -82
- package/lib/ref-utils.js +13 -13
- package/lib/resolve.js +186 -205
- package/lib/rules/ajv.js +10 -8
- package/lib/rules/async3/channels-kebab-case.d.ts +2 -0
- package/lib/rules/async3/channels-kebab-case.js +19 -0
- package/lib/rules/async3/index.d.ts +3 -0
- package/lib/rules/async3/index.js +22 -0
- package/lib/rules/async3/no-channel-trailing-slash.d.ts +2 -0
- package/lib/rules/async3/no-channel-trailing-slash.js +16 -0
- package/lib/rules/common/assertions/asserts.js +5 -5
- package/lib/rules/common/assertions/index.d.ts +5 -4
- package/lib/rules/common/assertions/utils.js +43 -28
- package/lib/rules/common/no-invalid-parameter-examples.js +1 -2
- package/lib/rules/common/no-invalid-schema-examples.js +1 -2
- package/lib/rules/common/no-required-schema-properties-undefined.js +1 -2
- package/lib/rules/common/operation-tag-defined.js +1 -2
- package/lib/rules/common/path-http-verbs-order.js +1 -1
- package/lib/rules/common/path-segment-plural.js +2 -1
- package/lib/rules/common/required-string-property-missing-min-length.js +2 -2
- package/lib/rules/common/response-contains-header.js +2 -2
- package/lib/rules/common/security-defined.js +3 -7
- package/lib/rules/common/spec.d.ts +2 -2
- package/lib/rules/common/spec.js +6 -7
- package/lib/rules/no-unresolved-refs.js +3 -4
- package/lib/rules/oas2/response-contains-property.js +1 -2
- package/lib/rules/oas3/array-parameter-serialization.js +1 -2
- package/lib/rules/oas3/component-name-unique.js +2 -4
- package/lib/rules/oas3/no-invalid-media-type-examples.js +1 -2
- package/lib/rules/oas3/no-server-variables-empty-enum.js +1 -2
- package/lib/rules/oas3/no-undefined-server-variable.js +2 -3
- package/lib/rules/oas3/no-unused-components.js +1 -2
- package/lib/rules/oas3/response-contains-property.js +1 -2
- package/lib/rules/utils.js +14 -12
- package/lib/types/arazzo.d.ts +1299 -73
- package/lib/types/arazzo.js +41 -36
- package/lib/types/asyncapi2.d.ts +17 -0
- package/lib/types/{asyncapi.js → asyncapi2.js} +71 -93
- package/lib/types/asyncapi3.d.ts +2 -0
- package/lib/types/asyncapi3.js +347 -0
- package/lib/types/index.js +19 -10
- package/lib/types/json-schema-adapter.js +4 -18
- package/lib/types/oas2.js +6 -6
- package/lib/types/oas3.js +10 -10
- package/lib/types/oas3_1.js +15 -9
- package/lib/types/redocly-yaml.d.ts +3 -1
- package/lib/types/redocly-yaml.js +131 -35
- package/lib/typings/arazzo.d.ts +28 -1
- package/lib/typings/asyncapi3.d.ts +53 -0
- package/lib/typings/asyncapi3.js +2 -0
- package/lib/utils.d.ts +12 -7
- package/lib/utils.js +91 -77
- package/lib/visitors.d.ts +11 -0
- package/lib/visitors.js +21 -8
- package/lib/walk.js +30 -23
- package/package.json +3 -3
- package/src/__tests__/bundle.test.ts +142 -0
- package/src/__tests__/lint.test.ts +0 -50
- package/src/bundle.ts +19 -6
- package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap +22 -0
- package/src/config/__tests__/__snapshots__/config.test.ts.snap +24 -0
- package/src/config/__tests__/config.test.ts +11 -0
- package/src/config/all.ts +9 -0
- package/src/config/builtIn.ts +6 -0
- package/src/config/config-resolvers.ts +15 -2
- package/src/config/config.ts +24 -5
- package/src/config/load.ts +1 -2
- package/src/config/minimal.ts +9 -0
- package/src/config/recommended-strict.ts +9 -0
- package/src/config/recommended.ts +9 -0
- package/src/config/rules.ts +12 -4
- package/src/config/types.ts +15 -2
- package/src/config/utils.ts +15 -0
- package/src/decorators/async3/index.ts +1 -0
- package/src/decorators/common/remove-x-internal.ts +2 -2
- package/src/index.ts +2 -1
- package/src/lint.ts +26 -3
- package/src/oas-types.ts +31 -13
- package/src/rules/arazzo/index.ts +1 -1
- package/src/rules/async2/index.ts +5 -5
- package/src/rules/async3/__tests__/channels-kebab-case.test.ts +141 -0
- package/src/rules/async3/__tests__/no-channel-trailing-slash.test.ts +96 -0
- package/src/rules/async3/channels-kebab-case.ts +19 -0
- package/src/rules/async3/index.ts +23 -0
- package/src/rules/async3/no-channel-trailing-slash.ts +16 -0
- package/src/rules/common/__tests__/spec.test.ts +47 -0
- package/src/rules/common/assertions/index.ts +13 -4
- package/src/rules/common/no-invalid-schema-examples.ts +3 -2
- package/src/rules/common/path-segment-plural.ts +3 -2
- package/src/rules/common/spec.ts +2 -2
- package/src/rules/oas2/index.ts +4 -4
- package/src/rules/oas3/index.ts +39 -37
- package/src/types/arazzo.ts +28 -23
- package/src/types/{asyncapi.ts → asyncapi2.ts} +58 -76
- package/src/types/asyncapi3.ts +381 -0
- package/src/types/oas3_1.ts +3 -2
- package/src/types/redocly-yaml.ts +14 -0
- package/src/typings/arazzo.ts +41 -1
- package/src/typings/asyncapi3.ts +61 -0
- package/src/utils.ts +46 -11
- package/src/visitors.ts +18 -0
- package/tsconfig.tsbuildinfo +1 -1
- package/lib/types/asyncapi.d.ts +0 -2
|
@@ -0,0 +1,347 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.AsyncApi3Types = void 0;
|
|
4
|
+
const _1 = require(".");
|
|
5
|
+
const asyncapi2_1 = require("./asyncapi2");
|
|
6
|
+
const Root = {
|
|
7
|
+
properties: {
|
|
8
|
+
asyncapi: { type: 'string', enum: ['3.0.0'] },
|
|
9
|
+
info: 'Info',
|
|
10
|
+
id: { type: 'string' },
|
|
11
|
+
servers: 'ServerMap',
|
|
12
|
+
channels: 'NamedChannels',
|
|
13
|
+
components: 'Components',
|
|
14
|
+
operations: 'NamedOperations',
|
|
15
|
+
defaultContentType: { type: 'string' },
|
|
16
|
+
},
|
|
17
|
+
required: ['asyncapi', 'info'],
|
|
18
|
+
};
|
|
19
|
+
const Channel = {
|
|
20
|
+
properties: {
|
|
21
|
+
address: { type: 'string' },
|
|
22
|
+
messages: 'NamedMessages',
|
|
23
|
+
title: { type: 'string' },
|
|
24
|
+
summary: { type: 'string' },
|
|
25
|
+
description: { type: 'string' },
|
|
26
|
+
servers: 'ServerList',
|
|
27
|
+
parameters: 'ParametersMap',
|
|
28
|
+
bindings: 'ChannelBindings',
|
|
29
|
+
tags: 'TagList',
|
|
30
|
+
externalDocs: 'ExternalDocs',
|
|
31
|
+
},
|
|
32
|
+
};
|
|
33
|
+
const Server = {
|
|
34
|
+
properties: {
|
|
35
|
+
host: { type: 'string' },
|
|
36
|
+
pathname: { type: 'string' },
|
|
37
|
+
protocol: { type: 'string' },
|
|
38
|
+
protocolVersion: { type: 'string' },
|
|
39
|
+
description: { type: 'string' },
|
|
40
|
+
variables: 'ServerVariablesMap',
|
|
41
|
+
security: 'SecuritySchemeList',
|
|
42
|
+
bindings: 'ServerBindings',
|
|
43
|
+
externalDocs: 'ExternalDocs',
|
|
44
|
+
tags: 'TagList',
|
|
45
|
+
},
|
|
46
|
+
required: ['host', 'protocol'],
|
|
47
|
+
};
|
|
48
|
+
const Info = {
|
|
49
|
+
properties: {
|
|
50
|
+
title: { type: 'string' },
|
|
51
|
+
version: { type: 'string' },
|
|
52
|
+
description: { type: 'string' },
|
|
53
|
+
termsOfService: { type: 'string' },
|
|
54
|
+
contact: 'Contact',
|
|
55
|
+
license: 'License',
|
|
56
|
+
tags: 'TagList',
|
|
57
|
+
externalDocs: 'ExternalDocs',
|
|
58
|
+
},
|
|
59
|
+
required: ['title', 'version'],
|
|
60
|
+
};
|
|
61
|
+
const Parameter = {
|
|
62
|
+
properties: {
|
|
63
|
+
description: { type: 'string' },
|
|
64
|
+
enum: { type: 'array', items: { type: 'string' } },
|
|
65
|
+
default: { type: 'string' },
|
|
66
|
+
examples: { type: 'array', items: { type: 'string' } },
|
|
67
|
+
location: { type: 'string' },
|
|
68
|
+
},
|
|
69
|
+
};
|
|
70
|
+
const Message = {
|
|
71
|
+
properties: {
|
|
72
|
+
headers: 'Schema',
|
|
73
|
+
payload: (value) => {
|
|
74
|
+
if (!!value && value?.['schemaFormat']) {
|
|
75
|
+
return {
|
|
76
|
+
properties: {
|
|
77
|
+
schema: 'Schema',
|
|
78
|
+
schemaFormat: { type: 'string' },
|
|
79
|
+
},
|
|
80
|
+
required: ['schema', 'schemaFormat'],
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
else {
|
|
84
|
+
return 'Schema';
|
|
85
|
+
}
|
|
86
|
+
},
|
|
87
|
+
correlationId: 'CorrelationId',
|
|
88
|
+
contentType: { type: 'string' },
|
|
89
|
+
name: { type: 'string' },
|
|
90
|
+
title: { type: 'string' },
|
|
91
|
+
summary: { type: 'string' },
|
|
92
|
+
description: { type: 'string' },
|
|
93
|
+
tags: 'TagList',
|
|
94
|
+
externalDocs: 'ExternalDocs',
|
|
95
|
+
bindings: 'MessageBindings',
|
|
96
|
+
examples: 'MessageExampleList',
|
|
97
|
+
traits: 'MessageTraitList',
|
|
98
|
+
},
|
|
99
|
+
additionalProperties: {},
|
|
100
|
+
};
|
|
101
|
+
const OperationTrait = {
|
|
102
|
+
properties: {
|
|
103
|
+
tags: 'TagList',
|
|
104
|
+
title: { type: 'string' },
|
|
105
|
+
summary: { type: 'string' },
|
|
106
|
+
description: { type: 'string' },
|
|
107
|
+
externalDocs: 'ExternalDocs',
|
|
108
|
+
security: 'SecuritySchemeList',
|
|
109
|
+
bindings: 'OperationBindings',
|
|
110
|
+
},
|
|
111
|
+
required: [],
|
|
112
|
+
};
|
|
113
|
+
const MessageTrait = {
|
|
114
|
+
properties: {
|
|
115
|
+
headers: (value) => {
|
|
116
|
+
if (typeof value === 'function' || (typeof value === 'object' && !!value)) {
|
|
117
|
+
return {
|
|
118
|
+
properties: {
|
|
119
|
+
schema: 'Schema',
|
|
120
|
+
schemaFormat: { type: 'string' },
|
|
121
|
+
},
|
|
122
|
+
};
|
|
123
|
+
}
|
|
124
|
+
else {
|
|
125
|
+
return 'Schema';
|
|
126
|
+
}
|
|
127
|
+
},
|
|
128
|
+
correlationId: 'CorrelationId',
|
|
129
|
+
contentType: { type: 'string' },
|
|
130
|
+
name: { type: 'string' },
|
|
131
|
+
title: { type: 'string' },
|
|
132
|
+
summary: { type: 'string' },
|
|
133
|
+
description: { type: 'string' },
|
|
134
|
+
tags: 'TagList',
|
|
135
|
+
externalDocs: 'ExternalDocs',
|
|
136
|
+
bindings: 'MessageBindings',
|
|
137
|
+
examples: 'MessageExampleList',
|
|
138
|
+
},
|
|
139
|
+
additionalProperties: {},
|
|
140
|
+
};
|
|
141
|
+
const Operation = {
|
|
142
|
+
properties: {
|
|
143
|
+
action: { type: 'string', enum: ['send', 'receive'] },
|
|
144
|
+
channel: 'Channel',
|
|
145
|
+
title: { type: 'string' },
|
|
146
|
+
tags: 'TagList',
|
|
147
|
+
summary: { type: 'string' },
|
|
148
|
+
description: { type: 'string' },
|
|
149
|
+
externalDocs: 'ExternalDocs',
|
|
150
|
+
operationId: { type: 'string' },
|
|
151
|
+
security: 'SecuritySchemeList',
|
|
152
|
+
bindings: 'OperationBindings',
|
|
153
|
+
traits: 'OperationTraitList',
|
|
154
|
+
messages: 'MessageList',
|
|
155
|
+
reply: 'OperationReply',
|
|
156
|
+
},
|
|
157
|
+
required: ['action', 'channel'],
|
|
158
|
+
};
|
|
159
|
+
const OperationReply = {
|
|
160
|
+
properties: {
|
|
161
|
+
channel: 'Channel',
|
|
162
|
+
messages: 'MessageList',
|
|
163
|
+
address: 'OperationReplyAddress',
|
|
164
|
+
},
|
|
165
|
+
};
|
|
166
|
+
const OperationReplyAddress = {
|
|
167
|
+
properties: {
|
|
168
|
+
location: { type: 'string' },
|
|
169
|
+
description: { type: 'string' },
|
|
170
|
+
},
|
|
171
|
+
required: ['location'],
|
|
172
|
+
};
|
|
173
|
+
const Components = {
|
|
174
|
+
properties: {
|
|
175
|
+
messages: 'NamedMessages',
|
|
176
|
+
parameters: 'NamedParameters',
|
|
177
|
+
schemas: 'NamedSchemas',
|
|
178
|
+
replies: 'NamedOperationReplies',
|
|
179
|
+
replyAddresses: 'NamedOperationRelyAddresses',
|
|
180
|
+
correlationIds: 'NamedCorrelationIds',
|
|
181
|
+
messageTraits: 'NamedMessageTraits',
|
|
182
|
+
operationTraits: 'NamedOperationTraits',
|
|
183
|
+
tags: 'NamedTags',
|
|
184
|
+
externalDocs: 'NamedExternalDocs',
|
|
185
|
+
securitySchemes: 'NamedSecuritySchemes',
|
|
186
|
+
servers: 'ServerMap',
|
|
187
|
+
serverVariables: 'ServerVariablesMap',
|
|
188
|
+
channels: 'NamedChannels',
|
|
189
|
+
operations: 'NamedOperations',
|
|
190
|
+
serverBindings: 'ServerBindings',
|
|
191
|
+
channelBindings: 'ChannelBindings',
|
|
192
|
+
operationBindings: 'OperationBindings',
|
|
193
|
+
messageBindings: 'MessageBindings',
|
|
194
|
+
},
|
|
195
|
+
};
|
|
196
|
+
const ImplicitFlow = {
|
|
197
|
+
properties: {
|
|
198
|
+
refreshUrl: { type: 'string' },
|
|
199
|
+
availableScopes: { type: 'object', additionalProperties: { type: 'string' } },
|
|
200
|
+
authorizationUrl: { type: 'string' },
|
|
201
|
+
},
|
|
202
|
+
required: ['authorizationUrl', 'availableScopes'],
|
|
203
|
+
};
|
|
204
|
+
const PasswordFlow = {
|
|
205
|
+
properties: {
|
|
206
|
+
refreshUrl: { type: 'string' },
|
|
207
|
+
availableScopes: { type: 'object', additionalProperties: { type: 'string' } },
|
|
208
|
+
tokenUrl: { type: 'string' },
|
|
209
|
+
},
|
|
210
|
+
required: ['tokenUrl', 'availableScopes'],
|
|
211
|
+
};
|
|
212
|
+
const ClientCredentials = {
|
|
213
|
+
properties: {
|
|
214
|
+
refreshUrl: { type: 'string' },
|
|
215
|
+
availableScopes: { type: 'object', additionalProperties: { type: 'string' } },
|
|
216
|
+
tokenUrl: { type: 'string' },
|
|
217
|
+
},
|
|
218
|
+
required: ['tokenUrl', 'availableScopes'],
|
|
219
|
+
};
|
|
220
|
+
const AuthorizationCode = {
|
|
221
|
+
properties: {
|
|
222
|
+
refreshUrl: { type: 'string' },
|
|
223
|
+
authorizationUrl: { type: 'string' },
|
|
224
|
+
availableScopes: { type: 'object', additionalProperties: { type: 'string' } },
|
|
225
|
+
tokenUrl: { type: 'string' },
|
|
226
|
+
},
|
|
227
|
+
required: ['authorizationUrl', 'tokenUrl', 'availableScopes'],
|
|
228
|
+
};
|
|
229
|
+
const SecurityScheme = {
|
|
230
|
+
properties: {
|
|
231
|
+
type: {
|
|
232
|
+
enum: [
|
|
233
|
+
'userPassword',
|
|
234
|
+
'apiKey',
|
|
235
|
+
'X509',
|
|
236
|
+
'symmetricEncryption',
|
|
237
|
+
'asymmetricEncryption',
|
|
238
|
+
'httpApiKey',
|
|
239
|
+
'http',
|
|
240
|
+
'oauth2',
|
|
241
|
+
'openIdConnect',
|
|
242
|
+
'plain',
|
|
243
|
+
'scramSha256',
|
|
244
|
+
'scramSha512',
|
|
245
|
+
'gssapi',
|
|
246
|
+
],
|
|
247
|
+
},
|
|
248
|
+
description: { type: 'string' },
|
|
249
|
+
name: { type: 'string' },
|
|
250
|
+
in: { type: 'string', enum: ['query', 'header', 'cookie', 'user', 'password'] },
|
|
251
|
+
scheme: { type: 'string' },
|
|
252
|
+
bearerFormat: { type: 'string' },
|
|
253
|
+
flows: 'SecuritySchemeFlows',
|
|
254
|
+
openIdConnectUrl: { type: 'string' },
|
|
255
|
+
scopes: { type: 'array', items: { type: 'string' } },
|
|
256
|
+
},
|
|
257
|
+
required(value) {
|
|
258
|
+
switch (value?.type) {
|
|
259
|
+
case 'apiKey':
|
|
260
|
+
return ['type', 'in'];
|
|
261
|
+
case 'httpApiKey':
|
|
262
|
+
return ['type', 'name', 'in'];
|
|
263
|
+
case 'http':
|
|
264
|
+
return ['type', 'scheme'];
|
|
265
|
+
case 'oauth2':
|
|
266
|
+
return ['type', 'flows'];
|
|
267
|
+
case 'openIdConnect':
|
|
268
|
+
return ['type', 'openIdConnectUrl'];
|
|
269
|
+
default:
|
|
270
|
+
return ['type'];
|
|
271
|
+
}
|
|
272
|
+
},
|
|
273
|
+
allowed(value) {
|
|
274
|
+
switch (value?.type) {
|
|
275
|
+
case 'apiKey':
|
|
276
|
+
return ['type', 'in', 'description'];
|
|
277
|
+
case 'httpApiKey':
|
|
278
|
+
return ['type', 'name', 'in', 'description'];
|
|
279
|
+
case 'http':
|
|
280
|
+
return ['type', 'scheme', 'bearerFormat', 'description'];
|
|
281
|
+
case 'oauth2':
|
|
282
|
+
return ['type', 'flows', 'description', 'scopes'];
|
|
283
|
+
case 'openIdConnect':
|
|
284
|
+
return ['type', 'openIdConnectUrl', 'description', 'scopes'];
|
|
285
|
+
default:
|
|
286
|
+
return ['type', 'description'];
|
|
287
|
+
}
|
|
288
|
+
},
|
|
289
|
+
extensionsPrefix: 'x-',
|
|
290
|
+
};
|
|
291
|
+
exports.AsyncApi3Types = {
|
|
292
|
+
// from asyncapi2
|
|
293
|
+
...asyncapi2_1.AsyncApi2Bindings,
|
|
294
|
+
CorrelationId: asyncapi2_1.CorrelationId,
|
|
295
|
+
SecuritySchemeFlows: asyncapi2_1.SecuritySchemeFlows,
|
|
296
|
+
ServerVariable: asyncapi2_1.ServerVariable,
|
|
297
|
+
Contact: asyncapi2_1.Contact,
|
|
298
|
+
License: asyncapi2_1.License,
|
|
299
|
+
MessageExample: asyncapi2_1.MessageExample,
|
|
300
|
+
Tag: asyncapi2_1.Tag,
|
|
301
|
+
Dependencies: asyncapi2_1.Dependencies,
|
|
302
|
+
Schema: asyncapi2_1.Schema,
|
|
303
|
+
Discriminator: asyncapi2_1.Discriminator,
|
|
304
|
+
DiscriminatorMapping: asyncapi2_1.DiscriminatorMapping,
|
|
305
|
+
SchemaProperties: asyncapi2_1.SchemaProperties,
|
|
306
|
+
ServerMap: asyncapi2_1.ServerMap,
|
|
307
|
+
ExternalDocs: asyncapi2_1.ExternalDocs,
|
|
308
|
+
Root,
|
|
309
|
+
Channel,
|
|
310
|
+
Parameter,
|
|
311
|
+
Info,
|
|
312
|
+
Server,
|
|
313
|
+
MessageTrait,
|
|
314
|
+
Operation,
|
|
315
|
+
OperationReply,
|
|
316
|
+
OperationReplyAddress,
|
|
317
|
+
Components,
|
|
318
|
+
ImplicitFlow,
|
|
319
|
+
PasswordFlow,
|
|
320
|
+
ClientCredentials,
|
|
321
|
+
AuthorizationCode,
|
|
322
|
+
SecurityScheme,
|
|
323
|
+
Message,
|
|
324
|
+
OperationTrait,
|
|
325
|
+
ServerVariablesMap: (0, _1.mapOf)('ServerVariable'),
|
|
326
|
+
NamedTags: (0, _1.mapOf)('Tag'),
|
|
327
|
+
NamedExternalDocs: (0, _1.mapOf)('ExternalDocs'),
|
|
328
|
+
NamedChannels: (0, _1.mapOf)('Channel'),
|
|
329
|
+
ParametersMap: (0, _1.mapOf)('Parameter'),
|
|
330
|
+
NamedOperations: (0, _1.mapOf)('Operation'),
|
|
331
|
+
NamedOperationReplies: (0, _1.mapOf)('OperationReply'),
|
|
332
|
+
NamedOperationRelyAddresses: (0, _1.mapOf)('OperationReplyAddress'),
|
|
333
|
+
NamedSchemas: (0, _1.mapOf)('Schema'),
|
|
334
|
+
NamedMessages: (0, _1.mapOf)('Message'),
|
|
335
|
+
NamedMessageTraits: (0, _1.mapOf)('MessageTrait'),
|
|
336
|
+
NamedOperationTraits: (0, _1.mapOf)('OperationTrait'),
|
|
337
|
+
NamedParameters: (0, _1.mapOf)('Parameter'),
|
|
338
|
+
NamedSecuritySchemes: (0, _1.mapOf)('SecurityScheme'),
|
|
339
|
+
NamedCorrelationIds: (0, _1.mapOf)('CorrelationId'),
|
|
340
|
+
ServerList: (0, _1.listOf)('Server'),
|
|
341
|
+
SecuritySchemeList: (0, _1.listOf)('SecurityScheme'),
|
|
342
|
+
MessageList: (0, _1.listOf)('Message'),
|
|
343
|
+
OperationTraitList: (0, _1.listOf)('OperationTrait'),
|
|
344
|
+
MessageTraitList: (0, _1.listOf)('MessageTrait'),
|
|
345
|
+
MessageExampleList: (0, _1.listOf)('MessageExample'),
|
|
346
|
+
TagList: (0, _1.listOf)('Tag'),
|
|
347
|
+
};
|
package/lib/types/index.js
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
3
|
+
exports.SpecExtension = void 0;
|
|
4
|
+
exports.listOf = listOf;
|
|
5
|
+
exports.mapOf = mapOf;
|
|
6
|
+
exports.normalizeTypes = normalizeTypes;
|
|
7
|
+
exports.isNamedType = isNamedType;
|
|
4
8
|
function listOf(typeName) {
|
|
5
9
|
return {
|
|
6
10
|
name: `${typeName}List`,
|
|
@@ -8,7 +12,6 @@ function listOf(typeName) {
|
|
|
8
12
|
items: typeName,
|
|
9
13
|
};
|
|
10
14
|
}
|
|
11
|
-
exports.listOf = listOf;
|
|
12
15
|
function mapOf(typeName) {
|
|
13
16
|
return {
|
|
14
17
|
name: `${typeName}Map`,
|
|
@@ -16,7 +19,6 @@ function mapOf(typeName) {
|
|
|
16
19
|
additionalProperties: () => typeName,
|
|
17
20
|
};
|
|
18
21
|
}
|
|
19
|
-
exports.mapOf = mapOf;
|
|
20
22
|
exports.SpecExtension = {
|
|
21
23
|
name: 'SpecExtension',
|
|
22
24
|
properties: {},
|
|
@@ -26,7 +28,10 @@ exports.SpecExtension = {
|
|
|
26
28
|
function normalizeTypes(types, options = {}) {
|
|
27
29
|
const normalizedTypes = {};
|
|
28
30
|
for (const typeName of Object.keys(types)) {
|
|
29
|
-
normalizedTypes[typeName] =
|
|
31
|
+
normalizedTypes[typeName] = {
|
|
32
|
+
...types[typeName],
|
|
33
|
+
name: typeName,
|
|
34
|
+
};
|
|
30
35
|
}
|
|
31
36
|
for (const type of Object.values(normalizedTypes)) {
|
|
32
37
|
normalizeType(type);
|
|
@@ -46,7 +51,10 @@ function normalizeTypes(types, options = {}) {
|
|
|
46
51
|
for (const [propName, prop] of Object.entries(type.properties)) {
|
|
47
52
|
mappedProps[propName] = resolveType(prop);
|
|
48
53
|
if (options.doNotResolveExamples && prop && prop.isExample) {
|
|
49
|
-
mappedProps[propName] =
|
|
54
|
+
mappedProps[propName] = {
|
|
55
|
+
...prop,
|
|
56
|
+
resolvable: false,
|
|
57
|
+
};
|
|
50
58
|
}
|
|
51
59
|
}
|
|
52
60
|
type.properties = mappedProps;
|
|
@@ -66,20 +74,21 @@ function normalizeTypes(types, options = {}) {
|
|
|
66
74
|
};
|
|
67
75
|
}
|
|
68
76
|
else if (type && type.name) {
|
|
69
|
-
type =
|
|
77
|
+
type = { ...type };
|
|
70
78
|
normalizeType(type);
|
|
71
79
|
return type;
|
|
72
80
|
}
|
|
73
81
|
else if (type && type.directResolveAs) {
|
|
74
|
-
return
|
|
82
|
+
return {
|
|
83
|
+
...type,
|
|
84
|
+
directResolveAs: resolveType(type.directResolveAs),
|
|
85
|
+
};
|
|
75
86
|
}
|
|
76
87
|
else {
|
|
77
88
|
return type;
|
|
78
89
|
}
|
|
79
90
|
}
|
|
80
91
|
}
|
|
81
|
-
exports.normalizeTypes = normalizeTypes;
|
|
82
92
|
function isNamedType(t) {
|
|
83
|
-
return typeof
|
|
93
|
+
return typeof t?.name === 'string';
|
|
84
94
|
}
|
|
85
|
-
exports.isNamedType = isNamedType;
|
|
@@ -1,18 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// For internal usage only
|
|
3
|
-
var __rest = (this && this.__rest) || function (s, e) {
|
|
4
|
-
var t = {};
|
|
5
|
-
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
6
|
-
t[p] = s[p];
|
|
7
|
-
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
8
|
-
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
9
|
-
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
10
|
-
t[p[i]] = s[p[i]];
|
|
11
|
-
}
|
|
12
|
-
return t;
|
|
13
|
-
};
|
|
14
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
-
exports.getNodeTypesFromJSONSchema =
|
|
4
|
+
exports.getNodeTypesFromJSONSchema = getNodeTypesFromJSONSchema;
|
|
16
5
|
const _2020_1 = require("@redocly/ajv/dist/2020");
|
|
17
6
|
const utils_1 = require("../utils");
|
|
18
7
|
const ajv = new _2020_1.default({
|
|
@@ -37,7 +26,6 @@ function findOneOf(schemaOneOf, oneOfs) {
|
|
|
37
26
|
};
|
|
38
27
|
}
|
|
39
28
|
function transformJSONSchemaToNodeType(propertyName, schema, ctx) {
|
|
40
|
-
var _a;
|
|
41
29
|
if (!schema || typeof schema === 'boolean') {
|
|
42
30
|
throw new Error(`Unexpected schema in ${propertyName}.`);
|
|
43
31
|
}
|
|
@@ -54,7 +42,7 @@ function transformJSONSchemaToNodeType(propertyName, schema, ctx) {
|
|
|
54
42
|
schema.type === 'number' ||
|
|
55
43
|
schema.type === 'integer' ||
|
|
56
44
|
schema.type === 'boolean') {
|
|
57
|
-
const { default: _, format: _format
|
|
45
|
+
const { default: _, format: _format, ...rest } = schema;
|
|
58
46
|
return rest;
|
|
59
47
|
}
|
|
60
48
|
if (schema.type === 'object' && !schema.properties && !schema.oneOf) {
|
|
@@ -82,16 +70,15 @@ function transformJSONSchemaToNodeType(propertyName, schema, ctx) {
|
|
|
82
70
|
}
|
|
83
71
|
if (schema.oneOf) {
|
|
84
72
|
if (schema.discriminator) {
|
|
85
|
-
const discriminatedPropertyName =
|
|
73
|
+
const discriminatedPropertyName = schema.discriminator?.propertyName;
|
|
86
74
|
if (!discriminatedPropertyName) {
|
|
87
75
|
throw new Error(`Unexpected discriminator without a propertyName in ${propertyName}.`);
|
|
88
76
|
}
|
|
89
77
|
const oneOfs = schema.oneOf.map((option, i) => {
|
|
90
|
-
var _a;
|
|
91
78
|
if (typeof option === 'boolean') {
|
|
92
79
|
throw new Error(`Unexpected boolean schema in ${propertyName} at position ${i} in oneOf.`);
|
|
93
80
|
}
|
|
94
|
-
const discriminatedProperty =
|
|
81
|
+
const discriminatedProperty = option?.properties?.[discriminatedPropertyName];
|
|
95
82
|
if (!discriminatedProperty || typeof discriminatedProperty === 'boolean') {
|
|
96
83
|
throw new Error(`Unexpected property '${discriminatedProperty}' schema in ${propertyName} at position ${i} in oneOf.`);
|
|
97
84
|
}
|
|
@@ -170,4 +157,3 @@ function getNodeTypesFromJSONSchema(schemaName, entrySchema) {
|
|
|
170
157
|
transformJSONSchemaToNodeType(schemaName, entrySchema, ctx);
|
|
171
158
|
return ctx;
|
|
172
159
|
}
|
|
173
|
-
exports.getNodeTypesFromJSONSchema = getNodeTypesFromJSONSchema;
|
package/lib/types/oas2.js
CHANGED
|
@@ -71,7 +71,7 @@ const Paths = {
|
|
|
71
71
|
};
|
|
72
72
|
const PathItem = {
|
|
73
73
|
properties: {
|
|
74
|
-
$ref: { type: 'string' },
|
|
74
|
+
$ref: { type: 'string' }, // TODO: verify special $ref handling for Path Item
|
|
75
75
|
parameters: 'ParameterList',
|
|
76
76
|
get: 'Operation',
|
|
77
77
|
put: 'Operation',
|
|
@@ -98,7 +98,7 @@ const Operation = {
|
|
|
98
98
|
deprecated: { type: 'boolean' },
|
|
99
99
|
security: 'SecurityRequirementList',
|
|
100
100
|
'x-codeSamples': 'XCodeSampleList',
|
|
101
|
-
'x-code-samples': 'XCodeSampleList',
|
|
101
|
+
'x-code-samples': 'XCodeSampleList', // deprecated
|
|
102
102
|
'x-hideTryItPanel': { type: 'boolean' },
|
|
103
103
|
},
|
|
104
104
|
required: ['responses'],
|
|
@@ -359,11 +359,11 @@ const SecurityScheme = {
|
|
|
359
359
|
'x-defaultClientId': { type: 'string' },
|
|
360
360
|
},
|
|
361
361
|
required(value) {
|
|
362
|
-
switch (value
|
|
362
|
+
switch (value?.type) {
|
|
363
363
|
case 'apiKey':
|
|
364
364
|
return ['type', 'name', 'in'];
|
|
365
365
|
case 'oauth2':
|
|
366
|
-
switch (value
|
|
366
|
+
switch (value?.flow) {
|
|
367
367
|
case 'implicit':
|
|
368
368
|
return ['type', 'flow', 'authorizationUrl', 'scopes'];
|
|
369
369
|
case 'accessCode':
|
|
@@ -379,13 +379,13 @@ const SecurityScheme = {
|
|
|
379
379
|
}
|
|
380
380
|
},
|
|
381
381
|
allowed(value) {
|
|
382
|
-
switch (value
|
|
382
|
+
switch (value?.type) {
|
|
383
383
|
case 'basic':
|
|
384
384
|
return ['type', 'description'];
|
|
385
385
|
case 'apiKey':
|
|
386
386
|
return ['type', 'name', 'in', 'description'];
|
|
387
387
|
case 'oauth2':
|
|
388
|
-
switch (value
|
|
388
|
+
switch (value?.flow) {
|
|
389
389
|
case 'implicit':
|
|
390
390
|
return ['type', 'flow', 'authorizationUrl', 'description', 'scopes'];
|
|
391
391
|
case 'accessCode':
|
package/lib/types/oas3.js
CHANGED
|
@@ -119,7 +119,7 @@ const WebhooksMap = {
|
|
|
119
119
|
};
|
|
120
120
|
const PathItem = {
|
|
121
121
|
properties: {
|
|
122
|
-
$ref: { type: 'string' },
|
|
122
|
+
$ref: { type: 'string' }, // TODO: verify special $ref handling for Path Item
|
|
123
123
|
servers: 'ServerList',
|
|
124
124
|
parameters: 'ParameterList',
|
|
125
125
|
summary: { type: 'string' },
|
|
@@ -175,7 +175,7 @@ const Operation = {
|
|
|
175
175
|
deprecated: { type: 'boolean' },
|
|
176
176
|
callbacks: 'CallbacksMap',
|
|
177
177
|
'x-codeSamples': 'XCodeSampleList',
|
|
178
|
-
'x-code-samples': 'XCodeSampleList',
|
|
178
|
+
'x-code-samples': 'XCodeSampleList', // deprecated
|
|
179
179
|
'x-hideTryItPanel': { type: 'boolean' },
|
|
180
180
|
},
|
|
181
181
|
required: ['responses'],
|
|
@@ -273,8 +273,8 @@ const Link = {
|
|
|
273
273
|
properties: {
|
|
274
274
|
operationRef: { type: 'string' },
|
|
275
275
|
operationId: { type: 'string' },
|
|
276
|
-
parameters: null,
|
|
277
|
-
requestBody: null,
|
|
276
|
+
parameters: null, // TODO: figure out how to describe/validate this
|
|
277
|
+
requestBody: null, // TODO: figure out how to describe/validate this
|
|
278
278
|
description: { type: 'string' },
|
|
279
279
|
server: 'Server',
|
|
280
280
|
},
|
|
@@ -389,7 +389,7 @@ const Components = {
|
|
|
389
389
|
const ImplicitFlow = {
|
|
390
390
|
properties: {
|
|
391
391
|
refreshUrl: { type: 'string' },
|
|
392
|
-
scopes: { type: 'object', additionalProperties: { type: 'string' } },
|
|
392
|
+
scopes: { type: 'object', additionalProperties: { type: 'string' } }, // TODO: validate scopes
|
|
393
393
|
authorizationUrl: { type: 'string' },
|
|
394
394
|
},
|
|
395
395
|
required: ['authorizationUrl', 'scopes'],
|
|
@@ -398,7 +398,7 @@ const ImplicitFlow = {
|
|
|
398
398
|
const PasswordFlow = {
|
|
399
399
|
properties: {
|
|
400
400
|
refreshUrl: { type: 'string' },
|
|
401
|
-
scopes: { type: 'object', additionalProperties: { type: 'string' } },
|
|
401
|
+
scopes: { type: 'object', additionalProperties: { type: 'string' } }, // TODO: validate scopes
|
|
402
402
|
tokenUrl: { type: 'string' },
|
|
403
403
|
},
|
|
404
404
|
required: ['tokenUrl', 'scopes'],
|
|
@@ -407,7 +407,7 @@ const PasswordFlow = {
|
|
|
407
407
|
const ClientCredentials = {
|
|
408
408
|
properties: {
|
|
409
409
|
refreshUrl: { type: 'string' },
|
|
410
|
-
scopes: { type: 'object', additionalProperties: { type: 'string' } },
|
|
410
|
+
scopes: { type: 'object', additionalProperties: { type: 'string' } }, // TODO: validate scopes
|
|
411
411
|
tokenUrl: { type: 'string' },
|
|
412
412
|
},
|
|
413
413
|
required: ['tokenUrl', 'scopes'],
|
|
@@ -417,7 +417,7 @@ const AuthorizationCode = {
|
|
|
417
417
|
properties: {
|
|
418
418
|
refreshUrl: { type: 'string' },
|
|
419
419
|
authorizationUrl: { type: 'string' },
|
|
420
|
-
scopes: { type: 'object', additionalProperties: { type: 'string' } },
|
|
420
|
+
scopes: { type: 'object', additionalProperties: { type: 'string' } }, // TODO: validate scopes
|
|
421
421
|
tokenUrl: { type: 'string' },
|
|
422
422
|
'x-usePkce': (value) => {
|
|
423
423
|
if (typeof value === 'boolean') {
|
|
@@ -453,7 +453,7 @@ const SecurityScheme = {
|
|
|
453
453
|
'x-defaultClientId': { type: 'string' },
|
|
454
454
|
},
|
|
455
455
|
required(value) {
|
|
456
|
-
switch (value
|
|
456
|
+
switch (value?.type) {
|
|
457
457
|
case 'apiKey':
|
|
458
458
|
return ['type', 'name', 'in'];
|
|
459
459
|
case 'http':
|
|
@@ -467,7 +467,7 @@ const SecurityScheme = {
|
|
|
467
467
|
}
|
|
468
468
|
},
|
|
469
469
|
allowed(value) {
|
|
470
|
-
switch (value
|
|
470
|
+
switch (value?.type) {
|
|
471
471
|
case 'apiKey':
|
|
472
472
|
return ['type', 'name', 'in', 'description'];
|
|
473
473
|
case 'http':
|
package/lib/types/oas3_1.js
CHANGED
|
@@ -76,7 +76,7 @@ const Operation = {
|
|
|
76
76
|
deprecated: { type: 'boolean' },
|
|
77
77
|
callbacks: 'CallbacksMap',
|
|
78
78
|
'x-codeSamples': 'XCodeSampleList',
|
|
79
|
-
'x-code-samples': 'XCodeSampleList',
|
|
79
|
+
'x-code-samples': 'XCodeSampleList', // deprecated
|
|
80
80
|
'x-hideTryItPanel': { type: 'boolean' },
|
|
81
81
|
},
|
|
82
82
|
extensionsPrefix: 'x-',
|
|
@@ -128,13 +128,13 @@ const Schema = {
|
|
|
128
128
|
if: 'Schema',
|
|
129
129
|
then: 'Schema',
|
|
130
130
|
else: 'Schema',
|
|
131
|
-
dependentSchemas: (0, _1.
|
|
131
|
+
dependentSchemas: (0, _1.mapOf)('Schema'),
|
|
132
132
|
dependentRequired: 'DependentRequired',
|
|
133
133
|
prefixItems: (0, _1.listOf)('Schema'),
|
|
134
134
|
contains: 'Schema',
|
|
135
135
|
minContains: { type: 'integer', minimum: 0 },
|
|
136
136
|
maxContains: { type: 'integer', minimum: 0 },
|
|
137
|
-
patternProperties:
|
|
137
|
+
patternProperties: 'PatternProperties',
|
|
138
138
|
propertyNames: 'Schema',
|
|
139
139
|
unevaluatedItems: (value) => {
|
|
140
140
|
if (typeof value === 'boolean') {
|
|
@@ -206,7 +206,7 @@ const SecurityScheme = {
|
|
|
206
206
|
openIdConnectUrl: { type: 'string' },
|
|
207
207
|
},
|
|
208
208
|
required(value) {
|
|
209
|
-
switch (value
|
|
209
|
+
switch (value?.type) {
|
|
210
210
|
case 'apiKey':
|
|
211
211
|
return ['type', 'name', 'in'];
|
|
212
212
|
case 'http':
|
|
@@ -220,13 +220,13 @@ const SecurityScheme = {
|
|
|
220
220
|
}
|
|
221
221
|
},
|
|
222
222
|
allowed(value) {
|
|
223
|
-
switch (value
|
|
223
|
+
switch (value?.type) {
|
|
224
224
|
case 'apiKey':
|
|
225
225
|
return ['type', 'name', 'in', 'description'];
|
|
226
226
|
case 'http':
|
|
227
227
|
return ['type', 'scheme', 'bearerFormat', 'description'];
|
|
228
228
|
case 'oauth2':
|
|
229
|
-
switch (value
|
|
229
|
+
switch (value?.flows) {
|
|
230
230
|
case 'implicit':
|
|
231
231
|
return ['type', 'flows', 'authorizationUrl', 'refreshUrl', 'description', 'scopes'];
|
|
232
232
|
case 'password':
|
|
@@ -267,11 +267,17 @@ const DependentRequired = {
|
|
|
267
267
|
properties: {},
|
|
268
268
|
additionalProperties: { type: 'array', items: { type: 'string' } },
|
|
269
269
|
};
|
|
270
|
-
exports.Oas3_1Types =
|
|
270
|
+
exports.Oas3_1Types = {
|
|
271
|
+
...oas3_1.Oas3Types,
|
|
272
|
+
Info,
|
|
271
273
|
Root,
|
|
272
274
|
Schema,
|
|
273
275
|
SchemaProperties,
|
|
276
|
+
PatternProperties: SchemaProperties,
|
|
274
277
|
License,
|
|
275
|
-
Components,
|
|
278
|
+
Components,
|
|
279
|
+
NamedPathItems: (0, _1.mapOf)('PathItem'),
|
|
280
|
+
SecurityScheme,
|
|
276
281
|
Operation,
|
|
277
|
-
DependentRequired
|
|
282
|
+
DependentRequired,
|
|
283
|
+
};
|