oas 28.8.3 → 29.0.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.
Files changed (45) hide show
  1. package/dist/analyzer/index.cjs +39 -164
  2. package/dist/analyzer/index.cjs.map +1 -1
  3. package/dist/analyzer/index.d.cts +129 -3
  4. package/dist/analyzer/index.d.ts +129 -3
  5. package/dist/analyzer/index.js +38 -161
  6. package/dist/analyzer/index.js.map +1 -1
  7. package/dist/analyzer/types.d.cts +0 -26
  8. package/dist/analyzer/types.d.ts +0 -26
  9. package/dist/{chunk-S5RDPESN.cjs → chunk-7GDJGM5N.cjs} +39 -23
  10. package/dist/chunk-7GDJGM5N.cjs.map +1 -0
  11. package/dist/{chunk-74JB5SAQ.js → chunk-AGDSUQ52.js} +20 -4
  12. package/dist/chunk-AGDSUQ52.js.map +1 -0
  13. package/dist/{chunk-VYHVLFAE.js → chunk-H7UPQPL6.js} +20 -18
  14. package/dist/chunk-H7UPQPL6.js.map +1 -0
  15. package/dist/{chunk-LV26LN7C.js → chunk-MTQDFD77.js} +4 -2
  16. package/dist/{chunk-LV26LN7C.js.map → chunk-MTQDFD77.js.map} +1 -1
  17. package/dist/{chunk-HQOKPTBP.cjs → chunk-PGMLBMGX.cjs} +27 -25
  18. package/dist/chunk-PGMLBMGX.cjs.map +1 -0
  19. package/dist/{chunk-LNQ2I4RW.cjs → chunk-R2ZT35NQ.cjs} +4 -2
  20. package/dist/chunk-R2ZT35NQ.cjs.map +1 -0
  21. package/dist/{extensions-DoxE-Jq4.d.ts → extensions-B25HCG0C.d.ts} +8 -0
  22. package/dist/{extensions-D_XcbwoY.d.cts → extensions-CCun4i0A.d.cts} +8 -0
  23. package/dist/extensions.d.cts +1 -1
  24. package/dist/extensions.d.ts +1 -1
  25. package/dist/index.cjs +4 -4
  26. package/dist/index.d.cts +3 -2
  27. package/dist/index.d.ts +3 -2
  28. package/dist/index.js +3 -3
  29. package/dist/operation/index.cjs +3 -3
  30. package/dist/operation/index.d.cts +1 -1
  31. package/dist/operation/index.d.ts +1 -1
  32. package/dist/operation/index.js +2 -2
  33. package/dist/operation/lib/get-parameters-as-json-schema.d.cts +1 -1
  34. package/dist/operation/lib/get-parameters-as-json-schema.d.ts +1 -1
  35. package/dist/utils.cjs +4 -2
  36. package/dist/utils.cjs.map +1 -1
  37. package/dist/utils.d.cts +3 -2
  38. package/dist/utils.d.ts +3 -2
  39. package/dist/utils.js +3 -1
  40. package/package.json +2 -2
  41. package/dist/chunk-74JB5SAQ.js.map +0 -1
  42. package/dist/chunk-HQOKPTBP.cjs.map +0 -1
  43. package/dist/chunk-LNQ2I4RW.cjs.map +0 -1
  44. package/dist/chunk-S5RDPESN.cjs.map +0 -1
  45. package/dist/chunk-VYHVLFAE.js.map +0 -1
@@ -4,10 +4,136 @@ import 'json-schema';
4
4
  import 'openapi-types';
5
5
 
6
6
  /**
7
- * Analyze a given OpenAPI or Swagger definition for any OpenAPI, JSON Schema, and ReadMe-specific
8
- * feature uses it may contain.
7
+ * Determine if a given API definition uses the `additionalProperties` schema property.
8
+ *
9
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object}
10
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object}
11
+ */
12
+ declare function additionalProperties(definition: OASDocument): string[];
13
+ /**
14
+ * Determine if a given API definition utilizes `callbacks`.
15
+ *
16
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#callback-object}
17
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#callback-object}
18
+ */
19
+ declare function callbacks(definition: OASDocument): string[];
20
+ /**
21
+ * Determine if a given API definition has circular refs.
22
+ *
23
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object}
24
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object}
25
+ */
26
+ declare function circularRefs(definition: OASDocument): Promise<string[]>;
27
+ /**
28
+ * Determine if a given API definition utilizes common parameters.
29
+ *
30
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#path-item-object}
31
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#path-item-object}
32
+ */
33
+ declare function commonParameters(definition: OASDocument): string[];
34
+ /**
35
+ * Determine if a given API definition utilizes discriminators.
36
+ *
37
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#discriminator-object}
38
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#discriminator-object}
39
+ */
40
+ declare function discriminators(definition: OASDocument): string[];
41
+ /**
42
+ * Calculate the size of the raw and dereferenced OpenAPI file in MB.
43
+ *
44
+ * If a dereferenced API definition is too large to be stringified the file size will be returned
45
+ * as NaN.
46
+ *
47
+ */
48
+ declare function fileSize(definition: OASDocument): Promise<{
49
+ raw: number;
50
+ dereferenced: number | typeof NaN;
51
+ }>;
52
+ /**
53
+ * Determine if a given API definition utilizes `links`.
54
+ *
55
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#link-object}
56
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#link-object}
57
+ */
58
+ declare function links(definition: OASDocument): string[];
59
+ /**
60
+ * Determine all of the available media types used within an API definition.
61
+ *
62
+ * @todo This query currently picks up false positives if there is an object named `content`.
63
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#request-body-object}
64
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#request-body-object}
65
+ */
66
+ declare function mediaTypes(definition: OASDocument): string[];
67
+ /**
68
+ * Determine if a given API definition uses parameter serialization.
69
+ *
70
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameter-object}
71
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-object}
72
+ */
73
+ declare function parameterSerialization(definition: OASDocument): string[];
74
+ /**
75
+ * Determine if a given API definition utilizes schema polymorphism and/of interitance.
76
+ *
77
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object}
78
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object}
79
+ */
80
+ declare function polymorphism(definition: OASDocument): string[];
81
+ /**
82
+ * Determine every kind of security type that a given API definition has documented.
83
+ *
84
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object}
85
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object}
86
+ */
87
+ declare function securityTypes(definition: OASDocument): string[];
88
+ /**
89
+ * Determine if a given API definition utilizes server variables.
90
+ *
91
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#server-variable-object}
92
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-variable-object}
93
+ */
94
+ declare function serverVariables(definition: OASDocument): string[];
95
+ /**
96
+ * Determine how many operations are defined in a given API definition.
97
+ *
98
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#operation-object}
99
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operation-object}
100
+ */
101
+ declare function totalOperations(definition: OASDocument): number;
102
+ /**
103
+ * Determine if a given API definition utilizes `webhooks` support in OpenAPI 3.1.
104
+ *
105
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oasWebhooks}
106
+ */
107
+ declare function webhooks(definition: OASDocument): string[];
108
+ /**
109
+ * Determine if a given API definition uses XML in a request body payload.
110
+ *
111
+ * @todo detect `+xml` media types
112
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}
113
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}
114
+ */
115
+ declare function xmlRequests(definition: OASDocument): string[];
116
+ /**
117
+ * Determine if a given API definition uses XML in a response body.
118
+ *
119
+ * @todo detect `+xml` media types
120
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}
121
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}
122
+ */
123
+ declare function xmlResponses(definition: OASDocument): string[];
124
+ /**
125
+ * Determine if a given API definition utilises the XML object for defining XML schemas.
126
+ *
127
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#xml-object}
128
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#xml-object}
129
+ */
130
+ declare function xmlSchemas(definition: OASDocument): string[];
131
+
132
+ /**
133
+ * Analyze a given OpenAPI or Swagger definition for any OpenAPI or JSON Schema feature uses it
134
+ * may contain or utilize.
9
135
  *
10
136
  */
11
137
  declare function analyzer(definition: OASDocument): Promise<OASAnalysis>;
12
138
 
13
- export { analyzer as default };
139
+ export { additionalProperties as analyzeAdditionalProperties, callbacks as analyzeCallbacks, circularRefs as analyzeCircularRefs, commonParameters as analyzeCommonParameters, discriminators as analyzeDiscriminators, fileSize as analyzeFileSize, links as analyzeLinks, mediaTypes as analyzeMediaTypes, parameterSerialization as analyzeParameterSerialization, polymorphism as analyzePolymorphism, securityTypes as analyzeSecurityTypes, serverVariables as analyzeServerVariables, totalOperations as analyzeTotalOperations, webhooks as analyzeWebhooks, xmlRequests as analyzeXMLRequests, xmlResponses as analyzeXMLResponses, xmlSchemas as analyzeXMLSchemas, analyzer };
@@ -1,15 +1,15 @@
1
1
  import {
2
2
  Oas
3
- } from "../chunk-VYHVLFAE.js";
3
+ } from "../chunk-H7UPQPL6.js";
4
+ import "../chunk-AGDSUQ52.js";
5
+ import "../chunk-MTQDFD77.js";
6
+ import "../chunk-SH63AK3O.js";
7
+ import "../chunk-TTCGKV5E.js";
8
+ import "../chunk-L3V5TF63.js";
4
9
  import {
5
10
  query,
6
11
  refizePointer
7
12
  } from "../chunk-CKC36IL7.js";
8
- import "../chunk-74JB5SAQ.js";
9
- import "../chunk-LV26LN7C.js";
10
- import "../chunk-SH63AK3O.js";
11
- import "../chunk-TTCGKV5E.js";
12
- import "../chunk-L3V5TF63.js";
13
13
 
14
14
  // src/analyzer/queries/openapi.ts
15
15
  function additionalProperties(definition) {
@@ -38,8 +38,17 @@ async function fileSize(definition) {
38
38
  const originalSizeInBytes = Buffer.from(JSON.stringify(oas.api)).length;
39
39
  const raw = Number((originalSizeInBytes / (1024 * 1024)).toFixed(2));
40
40
  await oas.dereference();
41
- const dereferencedSizeInBytes = Buffer.from(JSON.stringify(oas)).length;
42
- const dereferenced = Number((dereferencedSizeInBytes / (1024 * 1024)).toFixed(2));
41
+ let dereferenced;
42
+ try {
43
+ const dereferencedSizeInBytes = Buffer.from(JSON.stringify(oas.api)).length;
44
+ dereferenced = Number((dereferencedSizeInBytes / (1024 * 1024)).toFixed(2));
45
+ } catch (err) {
46
+ if (err instanceof RangeError) {
47
+ dereferenced = NaN;
48
+ } else {
49
+ throw err;
50
+ }
51
+ }
43
52
  return { raw, dereferenced };
44
53
  }
45
54
  function links(definition) {
@@ -78,33 +87,6 @@ function totalOperations(definition) {
78
87
  function webhooks(definition) {
79
88
  return query(["$.webhooks[*]"], definition).map((res) => refizePointer(res.pointer));
80
89
  }
81
- function xml(definition) {
82
- return query(
83
- [
84
- "$.components.schemas..xml^",
85
- "$..parameters..xml^",
86
- "$..requestBody..xml^",
87
- "$..requestBody..['application/xml']",
88
- "$..requestBody..['application/xml-external-parsed-entity']",
89
- "$..requestBody..['application/xml-dtd']",
90
- "$..requestBody..['text/xml']",
91
- "$..requestBody..['text/xml-external-parsed-entity']",
92
- "$..requestBody.content[?(@property.match(/\\+xml$/i))]",
93
- "$..responses..['application/xml']",
94
- "$..responses..['application/xml-external-parsed-entity']",
95
- "$..responses..['application/xml-dtd']",
96
- "$..responses..['text/xml']",
97
- "$..responses..['text/xml-external-parsed-entity']",
98
- "$..responses[*].content[?(@property.match(/\\+xml$/i))]"
99
- ],
100
- definition
101
- ).map((res) => refizePointer(res.pointer));
102
- }
103
- function xmlSchemas(definition) {
104
- return query(["$.components.schemas..xml^", "$..parameters..xml^", "$..requestBody..xml^"], definition).map(
105
- (res) => refizePointer(res.pointer)
106
- );
107
- }
108
90
  function xmlRequests(definition) {
109
91
  return query(
110
92
  [
@@ -131,77 +113,11 @@ function xmlResponses(definition) {
131
113
  definition
132
114
  ).map((res) => refizePointer(res.pointer));
133
115
  }
134
-
135
- // src/analyzer/queries/readme.ts
136
- function authDefaults(definition) {
137
- return query(["$.components.securitySchemes..['x-default']^"], definition).map((res) => refizePointer(res.pointer));
138
- }
139
- function codeSampleLanguages(definition) {
140
- const results = Array.from(
141
- new Set(
142
- query(["$..['x-readme']['samples-languages']", "$..['x-samples-languages']"], definition).map((res) => res.value).reduce((prev, next) => prev.concat(next), [])
143
- )
144
- );
145
- results.sort();
146
- return results;
147
- }
148
- function codeSamplesDisabled(definition) {
149
- return Array.from(
150
- new Set(
151
- query(
152
- [
153
- "$['x-samples-enabled']^",
154
- "$['x-readme']['samples-enabled']",
155
- "$..paths[*]..['x-samples-enabled']^",
156
- "$..paths[*]..['x-readme']['samples-enabled']^^"
157
- ],
158
- definition
159
- ).map((res) => refizePointer(res.pointer))
160
- )
161
- );
162
- }
163
- function corsProxyDisabled(definition) {
164
- return Array.from(
165
- new Set(
166
- query(
167
- [
168
- "$['x-proxy-enabled']^",
169
- "$['x-readme']['proxy-enabled']",
170
- "$..paths[*]..['x-proxy-enabled']^",
171
- "$..paths[*]..['x-readme']['proxy-enabled']^^"
172
- ],
173
- definition
174
- ).map((res) => refizePointer(res.pointer))
175
- )
116
+ function xmlSchemas(definition) {
117
+ return query(["$.components.schemas..xml^", "$..parameters..xml^", "$..requestBody..xml^"], definition).map(
118
+ (res) => refizePointer(res.pointer)
176
119
  );
177
120
  }
178
- function customCodeSamples(definition) {
179
- return query(["$..['x-code-samples']", "$..['x-readme']['code-samples']"], definition).filter((res) => {
180
- return Array.isArray(res.value) && res.value.length ? res : false;
181
- }).map((res) => refizePointer(res.pointer));
182
- }
183
- function explorerDisabled(definition) {
184
- return query(
185
- [
186
- "$['x-explorer-enabled']^",
187
- "$['x-readme']['explorer-enabled']",
188
- "$..paths[*]..['x-explorer-enabled']^",
189
- "$..paths[*]..['x-readme']['explorer-enabled']^^"
190
- ],
191
- definition
192
- ).map((res) => refizePointer(res.pointer));
193
- }
194
- function rawBody(definition) {
195
- return query(["$..RAW_BODY^^"], definition).map((res) => refizePointer(res.pointer));
196
- }
197
- function staticHeaders(definition) {
198
- return query(["$..['x-headers']", "$..['x-readme']['headers']"], definition).filter((res) => {
199
- return Array.isArray(res.value) && res.value.length ? res : false;
200
- }).map((res) => refizePointer(res.pointer));
201
- }
202
- function refNames(definition) {
203
- return query(["$..['x-readme-ref-name']"], definition).map((res) => refizePointer(res.pointer));
204
- }
205
121
 
206
122
  // src/analyzer/index.ts
207
123
  async function analyzer(definition) {
@@ -215,19 +131,9 @@ async function analyzer(definition) {
215
131
  const polymorphism2 = polymorphism(definition);
216
132
  const serverVariables2 = serverVariables(definition);
217
133
  const webhooks2 = webhooks(definition);
218
- const xml2 = xml(definition);
219
134
  const xmlSchemas2 = xmlSchemas(definition);
220
135
  const xmlRequests2 = xmlRequests(definition);
221
136
  const xmlResponses2 = xmlResponses(definition);
222
- const authDefaults2 = authDefaults(definition);
223
- const codeSampleLanguages2 = codeSampleLanguages(definition);
224
- const customCodeSamples2 = customCodeSamples(definition);
225
- const codeSamplesDisabled2 = codeSamplesDisabled(definition);
226
- const disabledCorsProxy = corsProxyDisabled(definition);
227
- const explorerDisabled2 = explorerDisabled(definition);
228
- const staticHeaders2 = staticHeaders(definition);
229
- const rawBody2 = rawBody(definition);
230
- const refNames2 = refNames(definition);
231
137
  const { raw: rawFileSize, dereferenced: dereferencedFileSize } = await fileSize(definition);
232
138
  const analysis = {
233
139
  general: {
@@ -293,10 +199,6 @@ async function analyzer(definition) {
293
199
  present: !!webhooks2.length,
294
200
  locations: webhooks2
295
201
  },
296
- xml: {
297
- present: !!xml2.length,
298
- locations: xml2
299
- },
300
202
  xmlSchemas: {
301
203
  present: !!xmlSchemas2.length,
302
204
  locations: xmlSchemas2
@@ -309,53 +211,28 @@ async function analyzer(definition) {
309
211
  present: !!xmlResponses2.length,
310
212
  locations: xmlResponses2
311
213
  }
312
- },
313
- readme: {
314
- "x-default": {
315
- present: !!authDefaults2.length,
316
- locations: authDefaults2
317
- },
318
- "x-readme.code-samples": {
319
- present: !!customCodeSamples2.length,
320
- locations: customCodeSamples2
321
- },
322
- "x-readme.headers": {
323
- present: !!staticHeaders2.length,
324
- locations: staticHeaders2
325
- },
326
- "x-readme.explorer-enabled": {
327
- present: !!explorerDisabled2.length,
328
- locations: explorerDisabled2
329
- },
330
- "x-readme.proxy-enabled": {
331
- present: !!disabledCorsProxy.length,
332
- locations: disabledCorsProxy
333
- },
334
- "x-readme.samples-languages": {
335
- present: !!codeSampleLanguages2.length,
336
- locations: codeSampleLanguages2
337
- },
338
- "x-readme-ref-name": {
339
- present: !!refNames2.length,
340
- locations: refNames2
341
- }
342
214
  }
343
215
  };
344
- if (codeSamplesDisabled2.length) {
345
- analysis.readme["x-readme.samples-enabled"] = {
346
- present: !!codeSamplesDisabled2.length,
347
- locations: codeSamplesDisabled2
348
- };
349
- }
350
- if (rawBody2.length) {
351
- analysis.readme.raw_body = {
352
- present: !!rawBody2.length,
353
- locations: rawBody2
354
- };
355
- }
356
216
  return analysis;
357
217
  }
358
218
  export {
359
- analyzer as default
219
+ additionalProperties as analyzeAdditionalProperties,
220
+ callbacks as analyzeCallbacks,
221
+ circularRefs as analyzeCircularRefs,
222
+ commonParameters as analyzeCommonParameters,
223
+ discriminators as analyzeDiscriminators,
224
+ fileSize as analyzeFileSize,
225
+ links as analyzeLinks,
226
+ mediaTypes as analyzeMediaTypes,
227
+ parameterSerialization as analyzeParameterSerialization,
228
+ polymorphism as analyzePolymorphism,
229
+ securityTypes as analyzeSecurityTypes,
230
+ serverVariables as analyzeServerVariables,
231
+ totalOperations as analyzeTotalOperations,
232
+ webhooks as analyzeWebhooks,
233
+ xmlRequests as analyzeXMLRequests,
234
+ xmlResponses as analyzeXMLResponses,
235
+ xmlSchemas as analyzeXMLSchemas,
236
+ analyzer
360
237
  };
361
238
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/analyzer/queries/openapi.ts","../../src/analyzer/queries/readme.ts","../../src/analyzer/index.ts"],"sourcesContent":["import type { OASDocument } from '../../types.js';\n\nimport Oas from '../../index.js';\nimport { query, refizePointer } from '../util.js';\n\n/**\n * Determine if a given API definition uses the `additionalProperties` schema property.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object}\n */\nexport function additionalProperties(definition: OASDocument): string[] {\n return query(['$..additionalProperties'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition utilizes `callbacks`.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#callback-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#callback-object}\n */\nexport function callbacks(definition: OASDocument): string[] {\n return query(['$.components.callbacks', '$.paths.*[?(@.callbacks)].callbacks'], definition).map(res =>\n refizePointer(res.pointer),\n );\n}\n\n/**\n * Determine if a given API definition has circular refs.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object}\n */\nexport async function circularRefs(definition: OASDocument): Promise<string[]> {\n // Dereferencing will update the passed in variable, which we don't want to do, so we\n // instantiated `Oas` with a clone.\n const oas = new Oas(JSON.parse(JSON.stringify(definition)));\n await oas.dereference();\n\n const results = oas.getCircularReferences();\n\n results.sort();\n return results;\n}\n\n/**\n * Determine if a given API definition utilizes common parameters.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#path-item-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#path-item-object}\n */\nexport function commonParameters(definition: OASDocument): string[] {\n return query(['$..paths[*].parameters'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition utilizes discriminators.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#discriminator-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#discriminator-object}\n */\nexport function discriminators(definition: OASDocument): string[] {\n return query(['$..discriminator'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Calculate the size of the raw and dereferenced OpenAPI file in MB.\n *\n */\nexport async function fileSize(definition: OASDocument): Promise<{ raw: number; dereferenced: number }> {\n const oas = new Oas(structuredClone(definition));\n\n const originalSizeInBytes = Buffer.from(JSON.stringify(oas.api)).length;\n const raw = Number((originalSizeInBytes / (1024 * 1024)).toFixed(2));\n\n await oas.dereference();\n\n const dereferencedSizeInBytes = Buffer.from(JSON.stringify(oas)).length;\n const dereferenced = Number((dereferencedSizeInBytes / (1024 * 1024)).toFixed(2));\n\n return { raw, dereferenced };\n}\n\n/**\n * Determine if a given API definition utilizes `links`.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#link-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#link-object}\n */\nexport function links(definition: OASDocument): string[] {\n return query(['$.components.links', '$.paths..responses.*.links'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine all of the available media types used within an API definition.\n *\n * @todo This query currently picks up false positives if there is an object named `content`.\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#request-body-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#request-body-object}\n */\nexport function mediaTypes(definition: OASDocument): string[] {\n const results = Array.from(\n new Set(\n query(['$..paths..content'], definition).flatMap(res => {\n // This'll transform `results`, which looks like `[['application/json'], ['text/xml']]`\n // into `['application/json', 'text/xml']`.\n return Object.keys(res.value);\n }),\n ),\n );\n\n results.sort();\n return results;\n}\n\n/**\n * Determine if a given API definition uses parameter serialization.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameter-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-object}\n */\nexport function parameterSerialization(definition: OASDocument): string[] {\n return query(['$..parameters[*].style^'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition utilizes schema polymorphism and/of interitance.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object}\n */\nexport function polymorphism(definition: OASDocument): string[] {\n const results = Array.from(\n new Set(query(['$..allOf^', '$..anyOf^', '$..oneOf^'], definition).map(res => refizePointer(res.pointer))),\n );\n\n results.sort();\n return results;\n}\n\n/**\n * Determine every kind of security type that a given API definition has documented.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object}\n */\nexport function securityTypes(definition: OASDocument): string[] {\n return Array.from(new Set(query(['$.components.securitySchemes..type'], definition).map(res => res.value as string)));\n}\n\n/**\n * Determine if a given API definition utilizes server variables.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#server-variable-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-variable-object}\n */\nexport function serverVariables(definition: OASDocument): string[] {\n return query(['$.servers..variables^'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine how many operations are defined in a given API definition.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#operation-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operation-object}\n */\nexport function totalOperations(definition: OASDocument): number {\n return query(['$..paths[*]'], definition).flatMap(res => Object.keys(res.value)).length;\n}\n\n/**\n * Determine if a given API definition utilizes `webhooks` support in OpenAPI 3.1.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oasWebhooks}\n */\nexport function webhooks(definition: OASDocument): string[] {\n return query(['$.webhooks[*]'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition has XML schemas, payloads, or responses.\n *\n * @deprecated The data contained within this has been split apart into `xmlSchemas`, `xmlRequests`, and `xmlResponses`. This property will be removed in a future release.\n * @see xmlSchemas\n * @see xmlRequests\n * @see xmlResponses\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#xml-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#xml-object}\n */\nexport function xml(definition: OASDocument): string[] {\n return query(\n [\n '$.components.schemas..xml^',\n '$..parameters..xml^',\n '$..requestBody..xml^',\n\n \"$..requestBody..['application/xml']\",\n \"$..requestBody..['application/xml-external-parsed-entity']\",\n \"$..requestBody..['application/xml-dtd']\",\n \"$..requestBody..['text/xml']\",\n \"$..requestBody..['text/xml-external-parsed-entity']\",\n '$..requestBody.content[?(@property.match(/\\\\+xml$/i))]',\n\n \"$..responses..['application/xml']\",\n \"$..responses..['application/xml-external-parsed-entity']\",\n \"$..responses..['application/xml-dtd']\",\n \"$..responses..['text/xml']\",\n \"$..responses..['text/xml-external-parsed-entity']\",\n '$..responses[*].content[?(@property.match(/\\\\+xml$/i))]',\n ],\n definition,\n ).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition utilises the XML object for defining XML schemas.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#xml-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#xml-object}\n */\nexport function xmlSchemas(definition: OASDocument): string[] {\n return query(['$.components.schemas..xml^', '$..parameters..xml^', '$..requestBody..xml^'], definition).map(res =>\n refizePointer(res.pointer),\n );\n}\n\n/**\n * Determine if a given API definition uses XML in a request body payload.\n *\n * @todo detect `+xml` media types\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}\n */\nexport function xmlRequests(definition: OASDocument): string[] {\n return query(\n [\n \"$..requestBody..['application/xml']\",\n \"$..requestBody..['application/xml-external-parsed-entity']\",\n \"$..requestBody..['application/xml-dtd']\",\n \"$..requestBody..['text/xml']\",\n \"$..requestBody..['text/xml-external-parsed-entity']\",\n '$..requestBody.content[?(@property.match(/\\\\+xml$/i))]',\n ],\n definition,\n ).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition uses XML in a response body.\n *\n * @todo detect `+xml` media types\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}\n */\nexport function xmlResponses(definition: OASDocument): string[] {\n return query(\n [\n \"$..responses..['application/xml']\",\n \"$..responses..['application/xml-external-parsed-entity']\",\n \"$..responses..['application/xml-dtd']\",\n \"$..responses..['text/xml']\",\n \"$..responses..['text/xml-external-parsed-entity']\",\n '$..responses[*].content[?(@property.match(/\\\\+xml$/i))]',\n ],\n definition,\n ).map(res => refizePointer(res.pointer));\n}\n","import type { OASDocument } from '../../types.js';\n\nimport { query, refizePointer } from '../util.js';\n\n/**\n * Determine if a given API definition is using our `x-default` extension for defining auth\n * defaults.\n *\n * @see {@link https://docs.readme.com/main/docs/openapi-extensions#authentication-defaults}\n */\nexport function authDefaults(definition: OASDocument): string[] {\n return query([\"$.components.securitySchemes..['x-default']^\"], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine all of the code sample languages, using the `x-readme.samples-languages` extension\n * that are specified within an API definition.\n *\n * @see {@link https://docs.readme.com/main/docs/openapi-extensions#code-sample-languages}\n */\nexport function codeSampleLanguages(definition: OASDocument): string[] {\n const results: string[] = Array.from(\n new Set(\n query([\"$..['x-readme']['samples-languages']\", \"$..['x-samples-languages']\"], definition)\n .map(res => res.value as string)\n .reduce((prev, next) => prev.concat(next), []),\n ),\n );\n\n results.sort();\n return results;\n}\n\n/**\n * Determine if a given API defintion is using the `x-samples-enabled` extension for disabling\n * code samples.\n *\n * @see {@link https://docs.readme.com/main/docs/openapi-extensions#disable-code-examples}\n */\nexport function codeSamplesDisabled(definition: OASDocument): string[] {\n return Array.from(\n new Set(\n query(\n [\n \"$['x-samples-enabled']^\",\n \"$['x-readme']['samples-enabled']\",\n \"$..paths[*]..['x-samples-enabled']^\",\n \"$..paths[*]..['x-readme']['samples-enabled']^^\",\n ],\n definition,\n ).map(res => refizePointer(res.pointer)),\n ),\n );\n}\n\n/**\n * Determine if a given API definition is using our `x-proxy-enabled` extension for disabling the\n * \"Try It\" CORS proxy.\n *\n * @see {@link https://docs.readme.com/main/docs/openapi-extensions#cors-proxy-enabled}\n */\nexport function corsProxyDisabled(definition: OASDocument): string[] {\n return Array.from(\n new Set(\n query(\n [\n \"$['x-proxy-enabled']^\",\n \"$['x-readme']['proxy-enabled']\",\n \"$..paths[*]..['x-proxy-enabled']^\",\n \"$..paths[*]..['x-readme']['proxy-enabled']^^\",\n ],\n definition,\n ).map(res => refizePointer(res.pointer)),\n ),\n );\n}\n\n/**\n * Determine if a given API definition is using our `x-code-samples` extension for documentating\n * custom code samples.\n *\n * @see {@link https://docs.readme.com/main/docs/openapi-extensions#custom-code-samples}\n */\nexport function customCodeSamples(definition: OASDocument): string[] {\n return query([\"$..['x-code-samples']\", \"$..['x-readme']['code-samples']\"], definition)\n .filter(res => {\n // If `code-samples` is an empty array then we ignore it.\n return Array.isArray(res.value) && res.value.length ? res : false;\n })\n .map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition is using our `x-explorer-enabled` extension for disabling\n * \"Try It\" functionality.\n *\n * @see {@link https://docs.readme.com/main/docs/openapi-extensions#disable-the-api-explorer}\n */\nexport function explorerDisabled(definition: OASDocument): string[] {\n return query(\n [\n \"$['x-explorer-enabled']^\",\n \"$['x-readme']['explorer-enabled']\",\n \"$..paths[*]..['x-explorer-enabled']^\",\n \"$..paths[*]..['x-readme']['explorer-enabled']^^\",\n ],\n definition,\n ).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition uses the `RAW_BODY` manual API hack for raw body content.\n *\n * @see {@link https://docs.readme.com/main/docs/manual-api-editor#raw-body-content-body-content}\n */\nexport function rawBody(definition: OASDocument): string[] {\n return query(['$..RAW_BODY^^'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition is using our `x-readme.headers` extension for defining\n * static headers.\n *\n * @see {@link https://docs.readme.com/main/docs/openapi-extensions#static-headers}\n */\nexport function staticHeaders(definition: OASDocument): string[] {\n return query([\"$..['x-headers']\", \"$..['x-readme']['headers']\"], definition)\n .filter(res => {\n // If `headers` is an empty array then we ignore it.\n return Array.isArray(res.value) && res.value.length ? res : false;\n })\n .map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition previously had references by checking if we added the\n * `x-readme-ref-name` extension after dereferencing.\n */\nexport function refNames(definition: OASDocument): string[] {\n return query([\"$..['x-readme-ref-name']\"], definition).map(res => refizePointer(res.pointer));\n}\n","import type { OASDocument } from '../types.js';\nimport type { OASAnalysis } from './types.js';\n\nimport {\n additionalProperties as queryAdditionalProperties,\n callbacks as queryCallbacks,\n circularRefs as queryCircularRefs,\n commonParameters as queryCommonParameters,\n discriminators as queryDiscriminators,\n fileSize as queryFileSize,\n links as queryLinks,\n mediaTypes as queryMediaTypes,\n parameterSerialization as queryParameterSerialization,\n polymorphism as queryPolymorphism,\n securityTypes as querySecurityTypes,\n serverVariables as queryServerVariables,\n totalOperations as queryTotalOperations,\n webhooks as queryWebhooks,\n xml as queryXml,\n xmlRequests as queryXmlRequests,\n xmlResponses as queryXmlResponses,\n xmlSchemas as queryXmlSchemas,\n} from './queries/openapi.js';\nimport {\n authDefaults as queryAuthDefaults,\n codeSampleLanguages as queryCodeSampleLanguages,\n codeSamplesDisabled as queryCodeSamplesDisabled,\n corsProxyDisabled as queryCorsProxyDisabled,\n customCodeSamples as queryCustomCodeSamples,\n explorerDisabled as queryExplorerDisabled,\n rawBody as queryRawBody,\n refNames as queryRefNames,\n staticHeaders as queryStaticHeaders,\n} from './queries/readme.js';\n\n/**\n * Analyze a given OpenAPI or Swagger definition for any OpenAPI, JSON Schema, and ReadMe-specific\n * feature uses it may contain.\n *\n */\n// biome-ignore lint/style/noDefaultExport: This is safe for now.\nexport default async function analyzer(definition: OASDocument): Promise<OASAnalysis> {\n const additionalProperties = queryAdditionalProperties(definition);\n const callbacks = queryCallbacks(definition);\n const circularRefs = await queryCircularRefs(definition);\n const commonParameters = queryCommonParameters(definition);\n const discriminators = queryDiscriminators(definition);\n const links = queryLinks(definition);\n const parameterSerialization = queryParameterSerialization(definition);\n const polymorphism = queryPolymorphism(definition);\n const serverVariables = queryServerVariables(definition);\n const webhooks = queryWebhooks(definition);\n const xml = queryXml(definition);\n const xmlSchemas = queryXmlSchemas(definition);\n const xmlRequests = queryXmlRequests(definition);\n const xmlResponses = queryXmlResponses(definition);\n\n const authDefaults = queryAuthDefaults(definition);\n const codeSampleLanguages = queryCodeSampleLanguages(definition);\n const customCodeSamples = queryCustomCodeSamples(definition);\n const codeSamplesDisabled = queryCodeSamplesDisabled(definition);\n const disabledCorsProxy = queryCorsProxyDisabled(definition);\n const explorerDisabled = queryExplorerDisabled(definition);\n const staticHeaders = queryStaticHeaders(definition);\n const rawBody = queryRawBody(definition);\n const refNames = queryRefNames(definition);\n\n const { raw: rawFileSize, dereferenced: dereferencedFileSize } = await queryFileSize(definition);\n\n const analysis: OASAnalysis = {\n general: {\n dereferencedFileSize: {\n name: 'Dereferenced File Size',\n found: dereferencedFileSize,\n },\n mediaTypes: {\n name: 'Media Type',\n found: queryMediaTypes(definition),\n },\n operationTotal: {\n name: 'Operation',\n found: queryTotalOperations(definition),\n },\n rawFileSize: {\n name: 'Raw File Size',\n found: rawFileSize,\n },\n securityTypes: {\n name: 'Security Type',\n found: querySecurityTypes(definition),\n },\n },\n openapi: {\n additionalProperties: {\n present: !!additionalProperties.length,\n locations: additionalProperties,\n },\n callbacks: {\n present: !!callbacks.length,\n locations: callbacks,\n },\n circularRefs: {\n present: !!circularRefs.length,\n locations: circularRefs,\n },\n commonParameters: {\n present: !!commonParameters.length,\n locations: commonParameters,\n },\n discriminators: {\n present: !!discriminators.length,\n locations: discriminators,\n },\n links: {\n present: !!links.length,\n locations: links,\n },\n style: {\n present: !!parameterSerialization.length,\n locations: parameterSerialization,\n },\n polymorphism: {\n present: !!polymorphism.length,\n locations: polymorphism,\n },\n serverVariables: {\n present: !!serverVariables.length,\n locations: serverVariables,\n },\n webhooks: {\n present: !!webhooks.length,\n locations: webhooks,\n },\n xml: {\n present: !!xml.length,\n locations: xml,\n },\n xmlSchemas: {\n present: !!xmlSchemas.length,\n locations: xmlSchemas,\n },\n xmlRequests: {\n present: !!xmlRequests.length,\n locations: xmlRequests,\n },\n xmlResponses: {\n present: !!xmlResponses.length,\n locations: xmlResponses,\n },\n },\n readme: {\n 'x-default': {\n present: !!authDefaults.length,\n locations: authDefaults,\n },\n 'x-readme.code-samples': {\n present: !!customCodeSamples.length,\n locations: customCodeSamples,\n },\n 'x-readme.headers': {\n present: !!staticHeaders.length,\n locations: staticHeaders,\n },\n 'x-readme.explorer-enabled': {\n present: !!explorerDisabled.length,\n locations: explorerDisabled,\n },\n 'x-readme.proxy-enabled': {\n present: !!disabledCorsProxy.length,\n locations: disabledCorsProxy,\n },\n 'x-readme.samples-languages': {\n present: !!codeSampleLanguages.length,\n locations: codeSampleLanguages,\n },\n 'x-readme-ref-name': {\n present: !!refNames.length,\n locations: refNames,\n },\n },\n };\n\n // We should only surface analysis for deprecated features and extensions if they have them as\n // there's no reason to give them information about something they can't use and should no longer\n // know about.\n if (codeSamplesDisabled.length) {\n analysis.readme['x-readme.samples-enabled'] = {\n present: !!codeSamplesDisabled.length,\n locations: codeSamplesDisabled,\n };\n }\n\n if (rawBody.length) {\n analysis.readme.raw_body = {\n present: !!rawBody.length,\n locations: rawBody,\n };\n }\n\n return analysis;\n}\n"],"mappings":";;;;;;;;;;;;;;AAWO,SAAS,qBAAqB,YAAmC;AACtE,SAAO,MAAM,CAAC,yBAAyB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC7F;AAQO,SAAS,UAAU,YAAmC;AAC3D,SAAO,MAAM,CAAC,0BAA0B,qCAAqC,GAAG,UAAU,EAAE;AAAA,IAAI,SAC9F,cAAc,IAAI,OAAO;AAAA,EAC3B;AACF;AAQA,eAAsB,aAAa,YAA4C;AAG7E,QAAM,MAAM,IAAI,IAAI,KAAK,MAAM,KAAK,UAAU,UAAU,CAAC,CAAC;AAC1D,QAAM,IAAI,YAAY;AAEtB,QAAM,UAAU,IAAI,sBAAsB;AAE1C,UAAQ,KAAK;AACb,SAAO;AACT;AAQO,SAAS,iBAAiB,YAAmC;AAClE,SAAO,MAAM,CAAC,wBAAwB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC5F;AAQO,SAAS,eAAe,YAAmC;AAChE,SAAO,MAAM,CAAC,kBAAkB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACtF;AAMA,eAAsB,SAAS,YAAyE;AACtG,QAAM,MAAM,IAAI,IAAI,gBAAgB,UAAU,CAAC;AAE/C,QAAM,sBAAsB,OAAO,KAAK,KAAK,UAAU,IAAI,GAAG,CAAC,EAAE;AACjE,QAAM,MAAM,QAAQ,uBAAuB,OAAO,OAAO,QAAQ,CAAC,CAAC;AAEnE,QAAM,IAAI,YAAY;AAEtB,QAAM,0BAA0B,OAAO,KAAK,KAAK,UAAU,GAAG,CAAC,EAAE;AACjE,QAAM,eAAe,QAAQ,2BAA2B,OAAO,OAAO,QAAQ,CAAC,CAAC;AAEhF,SAAO,EAAE,KAAK,aAAa;AAC7B;AAQO,SAAS,MAAM,YAAmC;AACvD,SAAO,MAAM,CAAC,sBAAsB,4BAA4B,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACtH;AASO,SAAS,WAAW,YAAmC;AAC5D,QAAM,UAAU,MAAM;AAAA,IACpB,IAAI;AAAA,MACF,MAAM,CAAC,mBAAmB,GAAG,UAAU,EAAE,QAAQ,SAAO;AAGtD,eAAO,OAAO,KAAK,IAAI,KAAK;AAAA,MAC9B,CAAC;AAAA,IACH;AAAA,EACF;AAEA,UAAQ,KAAK;AACb,SAAO;AACT;AAQO,SAAS,uBAAuB,YAAmC;AACxE,SAAO,MAAM,CAAC,yBAAyB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC7F;AAQO,SAAS,aAAa,YAAmC;AAC9D,QAAM,UAAU,MAAM;AAAA,IACpB,IAAI,IAAI,MAAM,CAAC,aAAa,aAAa,WAAW,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC,CAAC;AAAA,EAC3G;AAEA,UAAQ,KAAK;AACb,SAAO;AACT;AAQO,SAAS,cAAc,YAAmC;AAC/D,SAAO,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,oCAAoC,GAAG,UAAU,EAAE,IAAI,SAAO,IAAI,KAAe,CAAC,CAAC;AACtH;AAQO,SAAS,gBAAgB,YAAmC;AACjE,SAAO,MAAM,CAAC,uBAAuB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC3F;AAQO,SAAS,gBAAgB,YAAiC;AAC/D,SAAO,MAAM,CAAC,aAAa,GAAG,UAAU,EAAE,QAAQ,SAAO,OAAO,KAAK,IAAI,KAAK,CAAC,EAAE;AACnF;AAOO,SAAS,SAAS,YAAmC;AAC1D,SAAO,MAAM,CAAC,eAAe,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACnF;AAYO,SAAS,IAAI,YAAmC;AACrD,SAAO;AAAA,IACL;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MAEA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MAEA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,IACA;AAAA,EACF,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACzC;AAQO,SAAS,WAAW,YAAmC;AAC5D,SAAO,MAAM,CAAC,8BAA8B,uBAAuB,sBAAsB,GAAG,UAAU,EAAE;AAAA,IAAI,SAC1G,cAAc,IAAI,OAAO;AAAA,EAC3B;AACF;AASO,SAAS,YAAY,YAAmC;AAC7D,SAAO;AAAA,IACL;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,IACA;AAAA,EACF,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACzC;AASO,SAAS,aAAa,YAAmC;AAC9D,SAAO;AAAA,IACL;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,IACA;AAAA,EACF,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACzC;;;AChQO,SAAS,aAAa,YAAmC;AAC9D,SAAO,MAAM,CAAC,8CAA8C,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAClH;AAQO,SAAS,oBAAoB,YAAmC;AACrE,QAAM,UAAoB,MAAM;AAAA,IAC9B,IAAI;AAAA,MACF,MAAM,CAAC,wCAAwC,4BAA4B,GAAG,UAAU,EACrF,IAAI,SAAO,IAAI,KAAe,EAC9B,OAAO,CAAC,MAAM,SAAS,KAAK,OAAO,IAAI,GAAG,CAAC,CAAC;AAAA,IACjD;AAAA,EACF;AAEA,UAAQ,KAAK;AACb,SAAO;AACT;AAQO,SAAS,oBAAoB,YAAmC;AACrE,SAAO,MAAM;AAAA,IACX,IAAI;AAAA,MACF;AAAA,QACE;AAAA,UACE;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QACF;AAAA,QACA;AAAA,MACF,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAAA,IACzC;AAAA,EACF;AACF;AAQO,SAAS,kBAAkB,YAAmC;AACnE,SAAO,MAAM;AAAA,IACX,IAAI;AAAA,MACF;AAAA,QACE;AAAA,UACE;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QACF;AAAA,QACA;AAAA,MACF,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAAA,IACzC;AAAA,EACF;AACF;AAQO,SAAS,kBAAkB,YAAmC;AACnE,SAAO,MAAM,CAAC,yBAAyB,iCAAiC,GAAG,UAAU,EAClF,OAAO,SAAO;AAEb,WAAO,MAAM,QAAQ,IAAI,KAAK,KAAK,IAAI,MAAM,SAAS,MAAM;AAAA,EAC9D,CAAC,EACA,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC1C;AAQO,SAAS,iBAAiB,YAAmC;AAClE,SAAO;AAAA,IACL;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,IACA;AAAA,EACF,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACzC;AAOO,SAAS,QAAQ,YAAmC;AACzD,SAAO,MAAM,CAAC,eAAe,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACnF;AAQO,SAAS,cAAc,YAAmC;AAC/D,SAAO,MAAM,CAAC,oBAAoB,4BAA4B,GAAG,UAAU,EACxE,OAAO,SAAO;AAEb,WAAO,MAAM,QAAQ,IAAI,KAAK,KAAK,IAAI,MAAM,SAAS,MAAM;AAAA,EAC9D,CAAC,EACA,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC1C;AAMO,SAAS,SAAS,YAAmC;AAC1D,SAAO,MAAM,CAAC,0BAA0B,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC9F;;;ACnGA,eAAO,SAAgC,YAA+C;AACpF,QAAMA,wBAAuB,qBAA0B,UAAU;AACjE,QAAMC,aAAY,UAAe,UAAU;AAC3C,QAAMC,gBAAe,MAAM,aAAkB,UAAU;AACvD,QAAMC,oBAAmB,iBAAsB,UAAU;AACzD,QAAMC,kBAAiB,eAAoB,UAAU;AACrD,QAAMC,SAAQ,MAAW,UAAU;AACnC,QAAMC,0BAAyB,uBAA4B,UAAU;AACrE,QAAMC,gBAAe,aAAkB,UAAU;AACjD,QAAMC,mBAAkB,gBAAqB,UAAU;AACvD,QAAMC,YAAW,SAAc,UAAU;AACzC,QAAMC,OAAM,IAAS,UAAU;AAC/B,QAAMC,cAAa,WAAgB,UAAU;AAC7C,QAAMC,eAAc,YAAiB,UAAU;AAC/C,QAAMC,gBAAe,aAAkB,UAAU;AAEjD,QAAMC,gBAAe,aAAkB,UAAU;AACjD,QAAMC,uBAAsB,oBAAyB,UAAU;AAC/D,QAAMC,qBAAoB,kBAAuB,UAAU;AAC3D,QAAMC,uBAAsB,oBAAyB,UAAU;AAC/D,QAAM,oBAAoB,kBAAuB,UAAU;AAC3D,QAAMC,oBAAmB,iBAAsB,UAAU;AACzD,QAAMC,iBAAgB,cAAmB,UAAU;AACnD,QAAMC,WAAU,QAAa,UAAU;AACvC,QAAMC,YAAW,SAAc,UAAU;AAEzC,QAAM,EAAE,KAAK,aAAa,cAAc,qBAAqB,IAAI,MAAM,SAAc,UAAU;AAE/F,QAAM,WAAwB;AAAA,IAC5B,SAAS;AAAA,MACP,sBAAsB;AAAA,QACpB,MAAM;AAAA,QACN,OAAO;AAAA,MACT;AAAA,MACA,YAAY;AAAA,QACV,MAAM;AAAA,QACN,OAAO,WAAgB,UAAU;AAAA,MACnC;AAAA,MACA,gBAAgB;AAAA,QACd,MAAM;AAAA,QACN,OAAO,gBAAqB,UAAU;AAAA,MACxC;AAAA,MACA,aAAa;AAAA,QACX,MAAM;AAAA,QACN,OAAO;AAAA,MACT;AAAA,MACA,eAAe;AAAA,QACb,MAAM;AAAA,QACN,OAAO,cAAmB,UAAU;AAAA,MACtC;AAAA,IACF;AAAA,IACA,SAAS;AAAA,MACP,sBAAsB;AAAA,QACpB,SAAS,CAAC,CAACrB,sBAAqB;AAAA,QAChC,WAAWA;AAAA,MACb;AAAA,MACA,WAAW;AAAA,QACT,SAAS,CAAC,CAACC,WAAU;AAAA,QACrB,WAAWA;AAAA,MACb;AAAA,MACA,cAAc;AAAA,QACZ,SAAS,CAAC,CAACC,cAAa;AAAA,QACxB,WAAWA;AAAA,MACb;AAAA,MACA,kBAAkB;AAAA,QAChB,SAAS,CAAC,CAACC,kBAAiB;AAAA,QAC5B,WAAWA;AAAA,MACb;AAAA,MACA,gBAAgB;AAAA,QACd,SAAS,CAAC,CAACC,gBAAe;AAAA,QAC1B,WAAWA;AAAA,MACb;AAAA,MACA,OAAO;AAAA,QACL,SAAS,CAAC,CAACC,OAAM;AAAA,QACjB,WAAWA;AAAA,MACb;AAAA,MACA,OAAO;AAAA,QACL,SAAS,CAAC,CAACC,wBAAuB;AAAA,QAClC,WAAWA;AAAA,MACb;AAAA,MACA,cAAc;AAAA,QACZ,SAAS,CAAC,CAACC,cAAa;AAAA,QACxB,WAAWA;AAAA,MACb;AAAA,MACA,iBAAiB;AAAA,QACf,SAAS,CAAC,CAACC,iBAAgB;AAAA,QAC3B,WAAWA;AAAA,MACb;AAAA,MACA,UAAU;AAAA,QACR,SAAS,CAAC,CAACC,UAAS;AAAA,QACpB,WAAWA;AAAA,MACb;AAAA,MACA,KAAK;AAAA,QACH,SAAS,CAAC,CAACC,KAAI;AAAA,QACf,WAAWA;AAAA,MACb;AAAA,MACA,YAAY;AAAA,QACV,SAAS,CAAC,CAACC,YAAW;AAAA,QACtB,WAAWA;AAAA,MACb;AAAA,MACA,aAAa;AAAA,QACX,SAAS,CAAC,CAACC,aAAY;AAAA,QACvB,WAAWA;AAAA,MACb;AAAA,MACA,cAAc;AAAA,QACZ,SAAS,CAAC,CAACC,cAAa;AAAA,QACxB,WAAWA;AAAA,MACb;AAAA,IACF;AAAA,IACA,QAAQ;AAAA,MACN,aAAa;AAAA,QACX,SAAS,CAAC,CAACC,cAAa;AAAA,QACxB,WAAWA;AAAA,MACb;AAAA,MACA,yBAAyB;AAAA,QACvB,SAAS,CAAC,CAACE,mBAAkB;AAAA,QAC7B,WAAWA;AAAA,MACb;AAAA,MACA,oBAAoB;AAAA,QAClB,SAAS,CAAC,CAACG,eAAc;AAAA,QACzB,WAAWA;AAAA,MACb;AAAA,MACA,6BAA6B;AAAA,QAC3B,SAAS,CAAC,CAACD,kBAAiB;AAAA,QAC5B,WAAWA;AAAA,MACb;AAAA,MACA,0BAA0B;AAAA,QACxB,SAAS,CAAC,CAAC,kBAAkB;AAAA,QAC7B,WAAW;AAAA,MACb;AAAA,MACA,8BAA8B;AAAA,QAC5B,SAAS,CAAC,CAACH,qBAAoB;AAAA,QAC/B,WAAWA;AAAA,MACb;AAAA,MACA,qBAAqB;AAAA,QACnB,SAAS,CAAC,CAACM,UAAS;AAAA,QACpB,WAAWA;AAAA,MACb;AAAA,IACF;AAAA,EACF;AAKA,MAAIJ,qBAAoB,QAAQ;AAC9B,aAAS,OAAO,0BAA0B,IAAI;AAAA,MAC5C,SAAS,CAAC,CAACA,qBAAoB;AAAA,MAC/B,WAAWA;AAAA,IACb;AAAA,EACF;AAEA,MAAIG,SAAQ,QAAQ;AAClB,aAAS,OAAO,WAAW;AAAA,MACzB,SAAS,CAAC,CAACA,SAAQ;AAAA,MACnB,WAAWA;AAAA,IACb;AAAA,EACF;AAEA,SAAO;AACT;","names":["additionalProperties","callbacks","circularRefs","commonParameters","discriminators","links","parameterSerialization","polymorphism","serverVariables","webhooks","xml","xmlSchemas","xmlRequests","xmlResponses","authDefaults","codeSampleLanguages","customCodeSamples","codeSamplesDisabled","explorerDisabled","staticHeaders","rawBody","refNames"]}
1
+ {"version":3,"sources":["../../src/analyzer/queries/openapi.ts","../../src/analyzer/index.ts"],"sourcesContent":["import type { OASDocument } from '../../types.js';\n\nimport Oas from '../../index.js';\nimport { query, refizePointer } from '../util.js';\n\n/**\n * Determine if a given API definition uses the `additionalProperties` schema property.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object}\n */\nexport function additionalProperties(definition: OASDocument): string[] {\n return query(['$..additionalProperties'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition utilizes `callbacks`.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#callback-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#callback-object}\n */\nexport function callbacks(definition: OASDocument): string[] {\n return query(['$.components.callbacks', '$.paths.*[?(@.callbacks)].callbacks'], definition).map(res =>\n refizePointer(res.pointer),\n );\n}\n\n/**\n * Determine if a given API definition has circular refs.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object}\n */\nexport async function circularRefs(definition: OASDocument): Promise<string[]> {\n // Dereferencing will update the passed in variable, which we don't want to do, so we\n // instantiated `Oas` with a clone.\n const oas = new Oas(JSON.parse(JSON.stringify(definition)));\n await oas.dereference();\n\n const results = oas.getCircularReferences();\n\n results.sort();\n return results;\n}\n\n/**\n * Determine if a given API definition utilizes common parameters.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#path-item-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#path-item-object}\n */\nexport function commonParameters(definition: OASDocument): string[] {\n return query(['$..paths[*].parameters'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition utilizes discriminators.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#discriminator-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#discriminator-object}\n */\nexport function discriminators(definition: OASDocument): string[] {\n return query(['$..discriminator'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Calculate the size of the raw and dereferenced OpenAPI file in MB.\n *\n * If a dereferenced API definition is too large to be stringified the file size will be returned\n * as NaN.\n *\n */\nexport async function fileSize(definition: OASDocument): Promise<{ raw: number; dereferenced: number | typeof NaN }> {\n const oas = new Oas(structuredClone(definition));\n\n const originalSizeInBytes = Buffer.from(JSON.stringify(oas.api)).length;\n const raw = Number((originalSizeInBytes / (1024 * 1024)).toFixed(2));\n\n await oas.dereference();\n\n let dereferenced: number;\n try {\n const dereferencedSizeInBytes = Buffer.from(JSON.stringify(oas.api)).length;\n dereferenced = Number((dereferencedSizeInBytes / (1024 * 1024)).toFixed(2));\n } catch (err) {\n // If the dereferenced API definition is too large to be stringified then we don't have a safer\n // way to estimate its size that wouldn't sacrifice accuracy so we'll just return NaN.\n if (err instanceof RangeError) {\n dereferenced = NaN;\n } else {\n throw err;\n }\n }\n\n return { raw, dereferenced };\n}\n\n/**\n * Determine if a given API definition utilizes `links`.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#link-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#link-object}\n */\nexport function links(definition: OASDocument): string[] {\n return query(['$.components.links', '$.paths..responses.*.links'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine all of the available media types used within an API definition.\n *\n * @todo This query currently picks up false positives if there is an object named `content`.\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#request-body-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#request-body-object}\n */\nexport function mediaTypes(definition: OASDocument): string[] {\n const results = Array.from(\n new Set(\n query(['$..paths..content'], definition).flatMap(res => {\n // This'll transform `results`, which looks like `[['application/json'], ['text/xml']]`\n // into `['application/json', 'text/xml']`.\n return Object.keys(res.value);\n }),\n ),\n );\n\n results.sort();\n return results;\n}\n\n/**\n * Determine if a given API definition uses parameter serialization.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameter-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-object}\n */\nexport function parameterSerialization(definition: OASDocument): string[] {\n return query(['$..parameters[*].style^'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition utilizes schema polymorphism and/of interitance.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object}\n */\nexport function polymorphism(definition: OASDocument): string[] {\n const results = Array.from(\n new Set(query(['$..allOf^', '$..anyOf^', '$..oneOf^'], definition).map(res => refizePointer(res.pointer))),\n );\n\n results.sort();\n return results;\n}\n\n/**\n * Determine every kind of security type that a given API definition has documented.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object}\n */\nexport function securityTypes(definition: OASDocument): string[] {\n return Array.from(new Set(query(['$.components.securitySchemes..type'], definition).map(res => res.value as string)));\n}\n\n/**\n * Determine if a given API definition utilizes server variables.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#server-variable-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-variable-object}\n */\nexport function serverVariables(definition: OASDocument): string[] {\n return query(['$.servers..variables^'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine how many operations are defined in a given API definition.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#operation-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operation-object}\n */\nexport function totalOperations(definition: OASDocument): number {\n return query(['$..paths[*]'], definition).flatMap(res => Object.keys(res.value)).length;\n}\n\n/**\n * Determine if a given API definition utilizes `webhooks` support in OpenAPI 3.1.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oasWebhooks}\n */\nexport function webhooks(definition: OASDocument): string[] {\n return query(['$.webhooks[*]'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition uses XML in a request body payload.\n *\n * @todo detect `+xml` media types\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}\n */\nexport function xmlRequests(definition: OASDocument): string[] {\n return query(\n [\n \"$..requestBody..['application/xml']\",\n \"$..requestBody..['application/xml-external-parsed-entity']\",\n \"$..requestBody..['application/xml-dtd']\",\n \"$..requestBody..['text/xml']\",\n \"$..requestBody..['text/xml-external-parsed-entity']\",\n '$..requestBody.content[?(@property.match(/\\\\+xml$/i))]',\n ],\n definition,\n ).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition uses XML in a response body.\n *\n * @todo detect `+xml` media types\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}\n */\nexport function xmlResponses(definition: OASDocument): string[] {\n return query(\n [\n \"$..responses..['application/xml']\",\n \"$..responses..['application/xml-external-parsed-entity']\",\n \"$..responses..['application/xml-dtd']\",\n \"$..responses..['text/xml']\",\n \"$..responses..['text/xml-external-parsed-entity']\",\n '$..responses[*].content[?(@property.match(/\\\\+xml$/i))]',\n ],\n definition,\n ).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition utilises the XML object for defining XML schemas.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#xml-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#xml-object}\n */\nexport function xmlSchemas(definition: OASDocument): string[] {\n return query(['$.components.schemas..xml^', '$..parameters..xml^', '$..requestBody..xml^'], definition).map(res =>\n refizePointer(res.pointer),\n );\n}\n","import type { OASDocument } from '../types.js';\nimport type { OASAnalysis } from './types.js';\n\nimport {\n additionalProperties as analyzeAdditionalProperties,\n callbacks as analyzeCallbacks,\n circularRefs as analyzeCircularRefs,\n commonParameters as analyzeCommonParameters,\n discriminators as analyzeDiscriminators,\n fileSize as analyzeFileSize,\n links as analyzeLinks,\n mediaTypes as analyzeMediaTypes,\n parameterSerialization as analyzeParameterSerialization,\n polymorphism as analyzePolymorphism,\n securityTypes as analyzeSecurityTypes,\n serverVariables as analyzeServerVariables,\n totalOperations as analyzeTotalOperations,\n webhooks as analyzeWebhooks,\n xmlRequests as analyzeXMLRequests,\n xmlResponses as analyzeXMLResponses,\n xmlSchemas as analyzeXMLSchemas,\n} from './queries/openapi.js';\n\nexport {\n analyzeAdditionalProperties,\n analyzeCallbacks,\n analyzeCircularRefs,\n analyzeCommonParameters,\n analyzeDiscriminators,\n analyzeFileSize,\n analyzeLinks,\n analyzeMediaTypes,\n analyzeParameterSerialization,\n analyzePolymorphism,\n analyzeSecurityTypes,\n analyzeServerVariables,\n analyzeTotalOperations,\n analyzeWebhooks,\n analyzeXMLRequests,\n analyzeXMLResponses,\n analyzeXMLSchemas,\n};\n\n/**\n * Analyze a given OpenAPI or Swagger definition for any OpenAPI or JSON Schema feature uses it\n * may contain or utilize.\n *\n */\nexport async function analyzer(definition: OASDocument): Promise<OASAnalysis> {\n const additionalProperties = analyzeAdditionalProperties(definition);\n const callbacks = analyzeCallbacks(definition);\n const circularRefs = await analyzeCircularRefs(definition);\n const commonParameters = analyzeCommonParameters(definition);\n const discriminators = analyzeDiscriminators(definition);\n const links = analyzeLinks(definition);\n const parameterSerialization = analyzeParameterSerialization(definition);\n const polymorphism = analyzePolymorphism(definition);\n const serverVariables = analyzeServerVariables(definition);\n const webhooks = analyzeWebhooks(definition);\n const xmlSchemas = analyzeXMLSchemas(definition);\n const xmlRequests = analyzeXMLRequests(definition);\n const xmlResponses = analyzeXMLResponses(definition);\n\n const { raw: rawFileSize, dereferenced: dereferencedFileSize } = await analyzeFileSize(definition);\n\n const analysis: OASAnalysis = {\n general: {\n dereferencedFileSize: {\n name: 'Dereferenced File Size',\n found: dereferencedFileSize,\n },\n mediaTypes: {\n name: 'Media Type',\n found: analyzeMediaTypes(definition),\n },\n operationTotal: {\n name: 'Operation',\n found: analyzeTotalOperations(definition),\n },\n rawFileSize: {\n name: 'Raw File Size',\n found: rawFileSize,\n },\n securityTypes: {\n name: 'Security Type',\n found: analyzeSecurityTypes(definition),\n },\n },\n openapi: {\n additionalProperties: {\n present: !!additionalProperties.length,\n locations: additionalProperties,\n },\n callbacks: {\n present: !!callbacks.length,\n locations: callbacks,\n },\n circularRefs: {\n present: !!circularRefs.length,\n locations: circularRefs,\n },\n commonParameters: {\n present: !!commonParameters.length,\n locations: commonParameters,\n },\n discriminators: {\n present: !!discriminators.length,\n locations: discriminators,\n },\n links: {\n present: !!links.length,\n locations: links,\n },\n style: {\n present: !!parameterSerialization.length,\n locations: parameterSerialization,\n },\n polymorphism: {\n present: !!polymorphism.length,\n locations: polymorphism,\n },\n serverVariables: {\n present: !!serverVariables.length,\n locations: serverVariables,\n },\n webhooks: {\n present: !!webhooks.length,\n locations: webhooks,\n },\n xmlSchemas: {\n present: !!xmlSchemas.length,\n locations: xmlSchemas,\n },\n xmlRequests: {\n present: !!xmlRequests.length,\n locations: xmlRequests,\n },\n xmlResponses: {\n present: !!xmlResponses.length,\n locations: xmlResponses,\n },\n },\n };\n\n return analysis;\n}\n"],"mappings":";;;;;;;;;;;;;;AAWO,SAAS,qBAAqB,YAAmC;AACtE,SAAO,MAAM,CAAC,yBAAyB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC7F;AAQO,SAAS,UAAU,YAAmC;AAC3D,SAAO,MAAM,CAAC,0BAA0B,qCAAqC,GAAG,UAAU,EAAE;AAAA,IAAI,SAC9F,cAAc,IAAI,OAAO;AAAA,EAC3B;AACF;AAQA,eAAsB,aAAa,YAA4C;AAG7E,QAAM,MAAM,IAAI,IAAI,KAAK,MAAM,KAAK,UAAU,UAAU,CAAC,CAAC;AAC1D,QAAM,IAAI,YAAY;AAEtB,QAAM,UAAU,IAAI,sBAAsB;AAE1C,UAAQ,KAAK;AACb,SAAO;AACT;AAQO,SAAS,iBAAiB,YAAmC;AAClE,SAAO,MAAM,CAAC,wBAAwB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC5F;AAQO,SAAS,eAAe,YAAmC;AAChE,SAAO,MAAM,CAAC,kBAAkB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACtF;AASA,eAAsB,SAAS,YAAsF;AACnH,QAAM,MAAM,IAAI,IAAI,gBAAgB,UAAU,CAAC;AAE/C,QAAM,sBAAsB,OAAO,KAAK,KAAK,UAAU,IAAI,GAAG,CAAC,EAAE;AACjE,QAAM,MAAM,QAAQ,uBAAuB,OAAO,OAAO,QAAQ,CAAC,CAAC;AAEnE,QAAM,IAAI,YAAY;AAEtB,MAAI;AACJ,MAAI;AACF,UAAM,0BAA0B,OAAO,KAAK,KAAK,UAAU,IAAI,GAAG,CAAC,EAAE;AACrE,mBAAe,QAAQ,2BAA2B,OAAO,OAAO,QAAQ,CAAC,CAAC;AAAA,EAC5E,SAAS,KAAK;AAGZ,QAAI,eAAe,YAAY;AAC7B,qBAAe;AAAA,IACjB,OAAO;AACL,YAAM;AAAA,IACR;AAAA,EACF;AAEA,SAAO,EAAE,KAAK,aAAa;AAC7B;AAQO,SAAS,MAAM,YAAmC;AACvD,SAAO,MAAM,CAAC,sBAAsB,4BAA4B,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACtH;AASO,SAAS,WAAW,YAAmC;AAC5D,QAAM,UAAU,MAAM;AAAA,IACpB,IAAI;AAAA,MACF,MAAM,CAAC,mBAAmB,GAAG,UAAU,EAAE,QAAQ,SAAO;AAGtD,eAAO,OAAO,KAAK,IAAI,KAAK;AAAA,MAC9B,CAAC;AAAA,IACH;AAAA,EACF;AAEA,UAAQ,KAAK;AACb,SAAO;AACT;AAQO,SAAS,uBAAuB,YAAmC;AACxE,SAAO,MAAM,CAAC,yBAAyB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC7F;AAQO,SAAS,aAAa,YAAmC;AAC9D,QAAM,UAAU,MAAM;AAAA,IACpB,IAAI,IAAI,MAAM,CAAC,aAAa,aAAa,WAAW,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC,CAAC;AAAA,EAC3G;AAEA,UAAQ,KAAK;AACb,SAAO;AACT;AAQO,SAAS,cAAc,YAAmC;AAC/D,SAAO,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,oCAAoC,GAAG,UAAU,EAAE,IAAI,SAAO,IAAI,KAAe,CAAC,CAAC;AACtH;AAQO,SAAS,gBAAgB,YAAmC;AACjE,SAAO,MAAM,CAAC,uBAAuB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC3F;AAQO,SAAS,gBAAgB,YAAiC;AAC/D,SAAO,MAAM,CAAC,aAAa,GAAG,UAAU,EAAE,QAAQ,SAAO,OAAO,KAAK,IAAI,KAAK,CAAC,EAAE;AACnF;AAOO,SAAS,SAAS,YAAmC;AAC1D,SAAO,MAAM,CAAC,eAAe,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACnF;AASO,SAAS,YAAY,YAAmC;AAC7D,SAAO;AAAA,IACL;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,IACA;AAAA,EACF,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACzC;AASO,SAAS,aAAa,YAAmC;AAC9D,SAAO;AAAA,IACL;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,IACA;AAAA,EACF,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACzC;AAQO,SAAS,WAAW,YAAmC;AAC5D,SAAO,MAAM,CAAC,8BAA8B,uBAAuB,sBAAsB,GAAG,UAAU,EAAE;AAAA,IAAI,SAC1G,cAAc,IAAI,OAAO;AAAA,EAC3B;AACF;;;ACrMA,eAAsB,SAAS,YAA+C;AAC5E,QAAMA,wBAAuB,qBAA4B,UAAU;AACnE,QAAMC,aAAY,UAAiB,UAAU;AAC7C,QAAMC,gBAAe,MAAM,aAAoB,UAAU;AACzD,QAAMC,oBAAmB,iBAAwB,UAAU;AAC3D,QAAMC,kBAAiB,eAAsB,UAAU;AACvD,QAAMC,SAAQ,MAAa,UAAU;AACrC,QAAMC,0BAAyB,uBAA8B,UAAU;AACvE,QAAMC,gBAAe,aAAoB,UAAU;AACnD,QAAMC,mBAAkB,gBAAuB,UAAU;AACzD,QAAMC,YAAW,SAAgB,UAAU;AAC3C,QAAMC,cAAa,WAAkB,UAAU;AAC/C,QAAMC,eAAc,YAAmB,UAAU;AACjD,QAAMC,gBAAe,aAAoB,UAAU;AAEnD,QAAM,EAAE,KAAK,aAAa,cAAc,qBAAqB,IAAI,MAAM,SAAgB,UAAU;AAEjG,QAAM,WAAwB;AAAA,IAC5B,SAAS;AAAA,MACP,sBAAsB;AAAA,QACpB,MAAM;AAAA,QACN,OAAO;AAAA,MACT;AAAA,MACA,YAAY;AAAA,QACV,MAAM;AAAA,QACN,OAAO,WAAkB,UAAU;AAAA,MACrC;AAAA,MACA,gBAAgB;AAAA,QACd,MAAM;AAAA,QACN,OAAO,gBAAuB,UAAU;AAAA,MAC1C;AAAA,MACA,aAAa;AAAA,QACX,MAAM;AAAA,QACN,OAAO;AAAA,MACT;AAAA,MACA,eAAe;AAAA,QACb,MAAM;AAAA,QACN,OAAO,cAAqB,UAAU;AAAA,MACxC;AAAA,IACF;AAAA,IACA,SAAS;AAAA,MACP,sBAAsB;AAAA,QACpB,SAAS,CAAC,CAACZ,sBAAqB;AAAA,QAChC,WAAWA;AAAA,MACb;AAAA,MACA,WAAW;AAAA,QACT,SAAS,CAAC,CAACC,WAAU;AAAA,QACrB,WAAWA;AAAA,MACb;AAAA,MACA,cAAc;AAAA,QACZ,SAAS,CAAC,CAACC,cAAa;AAAA,QACxB,WAAWA;AAAA,MACb;AAAA,MACA,kBAAkB;AAAA,QAChB,SAAS,CAAC,CAACC,kBAAiB;AAAA,QAC5B,WAAWA;AAAA,MACb;AAAA,MACA,gBAAgB;AAAA,QACd,SAAS,CAAC,CAACC,gBAAe;AAAA,QAC1B,WAAWA;AAAA,MACb;AAAA,MACA,OAAO;AAAA,QACL,SAAS,CAAC,CAACC,OAAM;AAAA,QACjB,WAAWA;AAAA,MACb;AAAA,MACA,OAAO;AAAA,QACL,SAAS,CAAC,CAACC,wBAAuB;AAAA,QAClC,WAAWA;AAAA,MACb;AAAA,MACA,cAAc;AAAA,QACZ,SAAS,CAAC,CAACC,cAAa;AAAA,QACxB,WAAWA;AAAA,MACb;AAAA,MACA,iBAAiB;AAAA,QACf,SAAS,CAAC,CAACC,iBAAgB;AAAA,QAC3B,WAAWA;AAAA,MACb;AAAA,MACA,UAAU;AAAA,QACR,SAAS,CAAC,CAACC,UAAS;AAAA,QACpB,WAAWA;AAAA,MACb;AAAA,MACA,YAAY;AAAA,QACV,SAAS,CAAC,CAACC,YAAW;AAAA,QACtB,WAAWA;AAAA,MACb;AAAA,MACA,aAAa;AAAA,QACX,SAAS,CAAC,CAACC,aAAY;AAAA,QACvB,WAAWA;AAAA,MACb;AAAA,MACA,cAAc;AAAA,QACZ,SAAS,CAAC,CAACC,cAAa;AAAA,QACxB,WAAWA;AAAA,MACb;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;","names":["additionalProperties","callbacks","circularRefs","commonParameters","discriminators","links","parameterSerialization","polymorphism","serverVariables","webhooks","xmlSchemas","xmlRequests","xmlResponses"]}
@@ -25,36 +25,10 @@ interface OASAnalysis {
25
25
  serverVariables: OASAnalysisFeature;
26
26
  style: OASAnalysisFeature;
27
27
  webhooks: OASAnalysisFeature;
28
- /**
29
- * @deprecated The data contained within this has been split apart into `xmlSchemas`, `xmlRequests`, and `xmlResponses`. This property will be removed in a future release.
30
- */
31
- xml: OASAnalysisFeature;
32
28
  xmlSchemas: OASAnalysisFeature;
33
29
  xmlRequests: OASAnalysisFeature;
34
30
  xmlResponses: OASAnalysisFeature;
35
31
  };
36
- readme: {
37
- /**
38
- * RAW_BODY is specific to our Manual API editor and we don't recommend anyone writing their
39
- * own API definition should use it so this is considered deprecated.
40
- */
41
- raw_body?: OASAnalysisFeature;
42
- 'x-default': OASAnalysisFeature;
43
- /**
44
- * x-readme-ref-name is added by our tooling after dereferencing so our UI can display the
45
- * reference name.
46
- */
47
- 'x-readme-ref-name': OASAnalysisFeature;
48
- 'x-readme.code-samples': OASAnalysisFeature;
49
- 'x-readme.explorer-enabled': OASAnalysisFeature;
50
- 'x-readme.headers': OASAnalysisFeature;
51
- 'x-readme.proxy-enabled': OASAnalysisFeature;
52
- /**
53
- * This extension is deprecated.
54
- */
55
- 'x-readme.samples-enabled'?: OASAnalysisFeature;
56
- 'x-readme.samples-languages'?: OASAnalysisFeature;
57
- };
58
32
  }
59
33
 
60
34
  export type { OASAnalysis, OASAnalysisFeature, OASAnalysisGeneral };
@@ -25,36 +25,10 @@ interface OASAnalysis {
25
25
  serverVariables: OASAnalysisFeature;
26
26
  style: OASAnalysisFeature;
27
27
  webhooks: OASAnalysisFeature;
28
- /**
29
- * @deprecated The data contained within this has been split apart into `xmlSchemas`, `xmlRequests`, and `xmlResponses`. This property will be removed in a future release.
30
- */
31
- xml: OASAnalysisFeature;
32
28
  xmlSchemas: OASAnalysisFeature;
33
29
  xmlRequests: OASAnalysisFeature;
34
30
  xmlResponses: OASAnalysisFeature;
35
31
  };
36
- readme: {
37
- /**
38
- * RAW_BODY is specific to our Manual API editor and we don't recommend anyone writing their
39
- * own API definition should use it so this is considered deprecated.
40
- */
41
- raw_body?: OASAnalysisFeature;
42
- 'x-default': OASAnalysisFeature;
43
- /**
44
- * x-readme-ref-name is added by our tooling after dereferencing so our UI can display the
45
- * reference name.
46
- */
47
- 'x-readme-ref-name': OASAnalysisFeature;
48
- 'x-readme.code-samples': OASAnalysisFeature;
49
- 'x-readme.explorer-enabled': OASAnalysisFeature;
50
- 'x-readme.headers': OASAnalysisFeature;
51
- 'x-readme.proxy-enabled': OASAnalysisFeature;
52
- /**
53
- * This extension is deprecated.
54
- */
55
- 'x-readme.samples-enabled'?: OASAnalysisFeature;
56
- 'x-readme.samples-languages'?: OASAnalysisFeature;
57
- };
58
32
  }
59
33
 
60
34
  export type { OASAnalysis, OASAnalysisFeature, OASAnalysisGeneral };