@redocly/openapi-core 1.0.0-beta.98 → 1.0.0-rc.1

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 (380) hide show
  1. package/README.md +6 -6
  2. package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.js +0 -1
  3. package/lib/benchmark/benches/recommended-oas3.bench.js +1 -1
  4. package/lib/benchmark/benches/resolve-with-no-external.bench.js +1 -1
  5. package/lib/benchmark/utils.d.ts +2 -2
  6. package/lib/benchmark/utils.js +2 -2
  7. package/lib/bundle.d.ts +12 -15
  8. package/lib/bundle.js +38 -15
  9. package/lib/config/all.d.ts +2 -2
  10. package/lib/config/all.js +17 -6
  11. package/lib/config/builtIn.d.ts +2 -2
  12. package/lib/config/builtIn.js +2 -2
  13. package/lib/config/config-resolvers.d.ts +5 -5
  14. package/lib/config/config-resolvers.js +121 -66
  15. package/lib/config/config.d.ts +12 -18
  16. package/lib/config/config.js +42 -26
  17. package/lib/config/load.d.ts +16 -3
  18. package/lib/config/load.js +36 -14
  19. package/lib/config/minimal.d.ts +2 -2
  20. package/lib/config/minimal.js +10 -6
  21. package/lib/config/recommended.d.ts +2 -2
  22. package/lib/config/recommended.js +10 -6
  23. package/lib/config/rules.d.ts +7 -4
  24. package/lib/config/rules.js +5 -4
  25. package/lib/config/types.d.ts +72 -23
  26. package/lib/config/types.js +13 -0
  27. package/lib/config/utils.d.ts +6 -5
  28. package/lib/config/utils.js +110 -32
  29. package/lib/decorators/common/filters/filter-helper.d.ts +3 -0
  30. package/lib/decorators/common/filters/filter-helper.js +67 -0
  31. package/lib/decorators/common/filters/filter-in.d.ts +2 -0
  32. package/lib/decorators/common/filters/filter-in.js +17 -0
  33. package/lib/decorators/common/filters/filter-out.d.ts +2 -0
  34. package/lib/decorators/common/filters/filter-out.js +17 -0
  35. package/lib/decorators/common/info-override.d.ts +2 -0
  36. package/lib/decorators/common/info-override.js +28 -0
  37. package/lib/decorators/common/media-type-examples-override.d.ts +2 -0
  38. package/lib/decorators/common/media-type-examples-override.js +53 -0
  39. package/lib/decorators/common/registry-dependencies.js +2 -2
  40. package/lib/decorators/common/remove-x-internal.js +2 -2
  41. package/lib/decorators/oas2/index.d.ts +3 -0
  42. package/lib/decorators/oas2/index.js +7 -1
  43. package/lib/decorators/oas3/index.d.ts +4 -0
  44. package/lib/decorators/oas3/index.js +9 -1
  45. package/lib/env.d.ts +3 -0
  46. package/lib/env.js +8 -0
  47. package/lib/format/codeframes.js +16 -10
  48. package/lib/format/format.d.ts +1 -1
  49. package/lib/format/format.js +64 -32
  50. package/lib/index.d.ts +6 -6
  51. package/lib/index.js +7 -2
  52. package/lib/js-yaml/index.js +2 -6
  53. package/lib/lint.d.ts +4 -2
  54. package/lib/lint.js +36 -11
  55. package/lib/logger.d.ts +10 -0
  56. package/lib/logger.js +31 -0
  57. package/lib/output.d.ts +3 -0
  58. package/lib/output.js +9 -0
  59. package/lib/redocly/index.js +10 -9
  60. package/lib/redocly/registry-api-types.d.ts +28 -28
  61. package/lib/redocly/registry-api.d.ts +3 -3
  62. package/lib/redocly/registry-api.js +10 -2
  63. package/lib/ref-utils.d.ts +1 -0
  64. package/lib/ref-utils.js +8 -2
  65. package/lib/resolve.d.ts +1 -1
  66. package/lib/resolve.js +33 -3
  67. package/lib/rules/ajv.d.ts +2 -2
  68. package/lib/rules/ajv.js +12 -12
  69. package/lib/rules/common/assertions/asserts.d.ts +29 -4
  70. package/lib/rules/common/assertions/asserts.js +227 -97
  71. package/lib/rules/common/assertions/index.d.ts +27 -2
  72. package/lib/rules/common/assertions/index.js +9 -37
  73. package/lib/rules/common/assertions/utils.d.ts +16 -8
  74. package/lib/rules/common/assertions/utils.js +160 -76
  75. package/lib/rules/common/info-license-url.d.ts +1 -1
  76. package/lib/rules/common/info-license-url.js +5 -10
  77. package/lib/rules/common/info-license.d.ts +2 -0
  78. package/lib/rules/common/info-license.js +17 -0
  79. package/lib/rules/common/no-ambiguous-paths.js +1 -1
  80. package/lib/rules/common/no-enum-type-mismatch.js +1 -3
  81. package/lib/rules/common/no-identical-paths.js +4 -4
  82. package/lib/rules/common/no-invalid-parameter-examples.js +3 -3
  83. package/lib/rules/common/no-invalid-schema-examples.js +3 -3
  84. package/lib/rules/common/operation-2xx-response.js +15 -9
  85. package/lib/rules/common/operation-4xx-response.js +15 -9
  86. package/lib/rules/common/operation-operationId.js +2 -2
  87. package/lib/rules/common/operation-tag-defined.js +1 -1
  88. package/lib/rules/common/path-not-include-query.js +2 -2
  89. package/lib/rules/common/path-params-defined.js +7 -2
  90. package/lib/rules/common/paths-kebab-case.js +4 -1
  91. package/lib/rules/common/required-string-property-missing-min-length.d.ts +2 -0
  92. package/lib/rules/common/required-string-property-missing-min-length.js +37 -0
  93. package/lib/rules/common/response-contains-header.d.ts +2 -0
  94. package/lib/rules/common/response-contains-header.js +29 -0
  95. package/lib/rules/common/scalar-property-missing-example.d.ts +2 -0
  96. package/lib/rules/common/scalar-property-missing-example.js +42 -0
  97. package/lib/rules/common/security-defined.d.ts +2 -0
  98. package/lib/rules/common/{operation-security-defined.js → security-defined.js} +25 -6
  99. package/lib/rules/common/spec-strict-refs.d.ts +2 -0
  100. package/lib/rules/common/spec-strict-refs.js +30 -0
  101. package/lib/rules/common/spec.js +41 -18
  102. package/lib/rules/common/tags-alphabetical.js +1 -1
  103. package/lib/rules/oas2/index.d.ts +6 -2
  104. package/lib/rules/oas2/index.js +16 -8
  105. package/lib/rules/oas2/remove-unused-components.js +6 -6
  106. package/lib/rules/oas2/request-mime-type.d.ts +1 -1
  107. package/lib/rules/oas2/request-mime-type.js +1 -1
  108. package/lib/rules/oas2/response-contains-property.d.ts +2 -0
  109. package/lib/rules/oas2/response-contains-property.js +38 -0
  110. package/lib/rules/oas2/response-mime-type.d.ts +1 -1
  111. package/lib/rules/oas2/response-mime-type.js +1 -1
  112. package/lib/rules/oas3/component-name-unique.d.ts +2 -0
  113. package/lib/rules/oas3/component-name-unique.js +124 -0
  114. package/lib/rules/oas3/index.js +24 -10
  115. package/lib/rules/oas3/no-empty-servers.js +2 -2
  116. package/lib/rules/oas3/no-invalid-media-type-examples.js +2 -2
  117. package/lib/rules/oas3/no-server-variables-empty-enum.d.ts +2 -0
  118. package/lib/rules/oas3/{no-servers-empty-enum.js → no-server-variables-empty-enum.js} +5 -5
  119. package/lib/rules/oas3/no-unused-components.js +2 -2
  120. package/lib/rules/oas3/operation-4xx-problem-details-rfc7807.d.ts +5 -0
  121. package/lib/rules/oas3/operation-4xx-problem-details-rfc7807.js +36 -0
  122. package/lib/rules/oas3/remove-unused-components.js +6 -6
  123. package/lib/rules/oas3/request-mime-type.d.ts +1 -1
  124. package/lib/rules/oas3/request-mime-type.js +1 -1
  125. package/lib/rules/oas3/response-contains-property.d.ts +2 -0
  126. package/lib/rules/oas3/response-contains-property.js +40 -0
  127. package/lib/rules/oas3/response-mime-type.d.ts +1 -1
  128. package/lib/rules/oas3/response-mime-type.js +1 -1
  129. package/lib/rules/oas3/spec-components-invalid-map-name.d.ts +2 -0
  130. package/lib/rules/oas3/spec-components-invalid-map-name.js +62 -0
  131. package/lib/rules/other/stats.d.ts +2 -2
  132. package/lib/rules/other/stats.js +45 -16
  133. package/lib/rules/utils.d.ts +5 -2
  134. package/lib/rules/utils.js +54 -6
  135. package/lib/types/config-external-schemas.d.ts +2193 -0
  136. package/lib/types/config-external-schemas.js +805 -0
  137. package/lib/types/index.d.ts +3 -2
  138. package/lib/types/index.js +9 -1
  139. package/lib/types/oas2.js +91 -15
  140. package/lib/types/oas3.js +139 -49
  141. package/lib/types/oas3_1.js +32 -26
  142. package/lib/types/redocly-yaml.js +414 -58
  143. package/lib/typings/openapi.d.ts +3 -2
  144. package/lib/utils.d.ts +15 -3
  145. package/lib/utils.js +73 -7
  146. package/lib/visitors.d.ts +20 -16
  147. package/lib/visitors.js +28 -3
  148. package/lib/walk.d.ts +11 -19
  149. package/lib/walk.js +74 -53
  150. package/package.json +5 -6
  151. package/__tests__/__snapshots__/bundle.test.ts.snap +0 -229
  152. package/__tests__/bundle.test.ts +0 -132
  153. package/__tests__/codeframes.test.ts +0 -531
  154. package/__tests__/fixtures/extension.js +0 -24
  155. package/__tests__/fixtures/refs/definitions.yaml +0 -3
  156. package/__tests__/fixtures/refs/examples.yaml +0 -8
  157. package/__tests__/fixtures/refs/external-request-body.yaml +0 -13
  158. package/__tests__/fixtures/refs/externalref.yaml +0 -35
  159. package/__tests__/fixtures/refs/hosted.yaml +0 -35
  160. package/__tests__/fixtures/refs/openapi-with-external-refs-conflicting-names.yaml +0 -21
  161. package/__tests__/fixtures/refs/openapi-with-external-refs.yaml +0 -33
  162. package/__tests__/fixtures/refs/param-b.yaml +0 -1
  163. package/__tests__/fixtures/refs/param-c.yaml +0 -1
  164. package/__tests__/fixtures/refs/rename.yaml +0 -1
  165. package/__tests__/fixtures/refs/requestBody.yaml +0 -9
  166. package/__tests__/fixtures/refs/schema-a.yaml +0 -1
  167. package/__tests__/fixtures/refs/simple.yaml +0 -1
  168. package/__tests__/fixtures/refs/vendor.schema.yaml +0 -20
  169. package/__tests__/fixtures/resolve/External.yaml +0 -10
  170. package/__tests__/fixtures/resolve/External2.yaml +0 -4
  171. package/__tests__/fixtures/resolve/description.md +0 -3
  172. package/__tests__/fixtures/resolve/externalInfo.yaml +0 -4
  173. package/__tests__/fixtures/resolve/externalLicense.yaml +0 -1
  174. package/__tests__/fixtures/resolve/openapi-with-back.yaml +0 -13
  175. package/__tests__/fixtures/resolve/openapi-with-md-description.yaml +0 -5
  176. package/__tests__/fixtures/resolve/openapi.yaml +0 -28
  177. package/__tests__/fixtures/resolve/schemas/type-a.yaml +0 -10
  178. package/__tests__/fixtures/resolve/schemas/type-b.yaml +0 -6
  179. package/__tests__/fixtures/resolve/transitive/a.yaml +0 -1
  180. package/__tests__/fixtures/resolve/transitive/components.yaml +0 -5
  181. package/__tests__/fixtures/resolve/transitive/schemas.yaml +0 -3
  182. package/__tests__/lint.test.ts +0 -17
  183. package/__tests__/login.test.ts +0 -17
  184. package/__tests__/normalizeVisitors.test.ts +0 -151
  185. package/__tests__/ref-utils.test.ts +0 -120
  186. package/__tests__/resolve-http.test.ts +0 -77
  187. package/__tests__/resolve.test.ts +0 -405
  188. package/__tests__/utils.ts +0 -86
  189. package/__tests__/walk.test.ts +0 -1485
  190. package/lib/rules/common/info-description.d.ts +0 -2
  191. package/lib/rules/common/info-description.js +0 -12
  192. package/lib/rules/common/license-url.d.ts +0 -2
  193. package/lib/rules/common/license-url.js +0 -12
  194. package/lib/rules/common/operation-security-defined.d.ts +0 -2
  195. package/lib/rules/oas3/no-servers-empty-enum.d.ts +0 -2
  196. package/src/__tests__/js-yaml.test.ts +0 -71
  197. package/src/__tests__/lint.test.ts +0 -182
  198. package/src/__tests__/utils.test.ts +0 -74
  199. package/src/benchmark/benches/lint-with-many-rules.bench.ts +0 -35
  200. package/src/benchmark/benches/lint-with-nested-rule.bench.ts +0 -39
  201. package/src/benchmark/benches/lint-with-no-rules.bench.ts +0 -20
  202. package/src/benchmark/benches/lint-with-top-level-rule-report.bench.ts +0 -36
  203. package/src/benchmark/benches/lint-with-top-level-rule.bench.ts +0 -32
  204. package/src/benchmark/benches/rebilly.yaml +0 -32267
  205. package/src/benchmark/benches/recommended-oas3.bench.ts +0 -22
  206. package/src/benchmark/benches/resolve-with-no-external.bench.ts +0 -23
  207. package/src/benchmark/benchmark.js +0 -307
  208. package/src/benchmark/colors.js +0 -29
  209. package/src/benchmark/fork.js +0 -83
  210. package/src/benchmark/utils.ts +0 -36
  211. package/src/bundle.ts +0 -371
  212. package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap +0 -157
  213. package/src/config/__tests__/config-resolvers.test.ts +0 -429
  214. package/src/config/__tests__/config.test.ts +0 -244
  215. package/src/config/__tests__/fixtures/plugin-config.yaml +0 -3
  216. package/src/config/__tests__/fixtures/plugin.js +0 -56
  217. package/src/config/__tests__/fixtures/resolve-config/api/nested-config.yaml +0 -12
  218. package/src/config/__tests__/fixtures/resolve-config/api/plugin.js +0 -67
  219. package/src/config/__tests__/fixtures/resolve-config/local-config-with-circular.yaml +0 -8
  220. package/src/config/__tests__/fixtures/resolve-config/local-config-with-file.yaml +0 -19
  221. package/src/config/__tests__/fixtures/resolve-config/local-config.yaml +0 -10
  222. package/src/config/__tests__/fixtures/resolve-config/plugin.js +0 -66
  223. package/src/config/__tests__/fixtures/resolve-remote-configs/nested-remote-config.yaml +0 -4
  224. package/src/config/__tests__/fixtures/resolve-remote-configs/remote-config.yaml +0 -5
  225. package/src/config/__tests__/load.test.ts +0 -83
  226. package/src/config/__tests__/resolve-plugins.test.ts +0 -27
  227. package/src/config/all.ts +0 -65
  228. package/src/config/builtIn.ts +0 -37
  229. package/src/config/config-resolvers.ts +0 -359
  230. package/src/config/config.ts +0 -312
  231. package/src/config/index.ts +0 -7
  232. package/src/config/load.ts +0 -84
  233. package/src/config/minimal.ts +0 -58
  234. package/src/config/recommended.ts +0 -58
  235. package/src/config/rules.ts +0 -46
  236. package/src/config/types.ts +0 -168
  237. package/src/config/utils.ts +0 -208
  238. package/src/decorators/__tests__/remove-x-internal.test.ts +0 -316
  239. package/src/decorators/common/info-description-override.ts +0 -24
  240. package/src/decorators/common/operation-description-override.ts +0 -30
  241. package/src/decorators/common/registry-dependencies.ts +0 -25
  242. package/src/decorators/common/remove-x-internal.ts +0 -59
  243. package/src/decorators/common/tag-description-override.ts +0 -25
  244. package/src/decorators/oas2/index.ts +0 -14
  245. package/src/decorators/oas3/index.ts +0 -14
  246. package/src/format/codeframes.ts +0 -210
  247. package/src/format/format.ts +0 -339
  248. package/src/index.ts +0 -68
  249. package/src/js-yaml/index.ts +0 -18
  250. package/src/lint.ts +0 -125
  251. package/src/oas-types.ts +0 -62
  252. package/src/redocly/__tests__/redocly-client.test.ts +0 -140
  253. package/src/redocly/index.ts +0 -182
  254. package/src/redocly/redocly-client-types.ts +0 -10
  255. package/src/redocly/registry-api-types.ts +0 -32
  256. package/src/redocly/registry-api.ts +0 -134
  257. package/src/ref-utils.ts +0 -79
  258. package/src/resolve.ts +0 -378
  259. package/src/rules/__tests__/fixtures/invalid-yaml.yaml +0 -1
  260. package/src/rules/__tests__/fixtures/ref.yaml +0 -1
  261. package/src/rules/__tests__/no-unresolved-refs.test.ts +0 -168
  262. package/src/rules/ajv.ts +0 -103
  263. package/src/rules/common/__tests__/info-description.test.ts +0 -102
  264. package/src/rules/common/__tests__/info-license.test.ts +0 -62
  265. package/src/rules/common/__tests__/license-url.test.ts +0 -63
  266. package/src/rules/common/__tests__/no-ambiguous-paths.test.ts +0 -96
  267. package/src/rules/common/__tests__/no-enum-type-mismatch.test.ts +0 -209
  268. package/src/rules/common/__tests__/no-identical-paths.test.ts +0 -58
  269. package/src/rules/common/__tests__/no-path-trailing-slash.test.ts +0 -85
  270. package/src/rules/common/__tests__/operation-2xx-response.test.ts +0 -91
  271. package/src/rules/common/__tests__/operation-4xx-response.test.ts +0 -107
  272. package/src/rules/common/__tests__/operation-operationId-unique.test.ts +0 -76
  273. package/src/rules/common/__tests__/operation-operationId-url-safe.test.ts +0 -45
  274. package/src/rules/common/__tests__/operation-parameters-unique.test.ts +0 -167
  275. package/src/rules/common/__tests__/operation-security-defined.test.ts +0 -69
  276. package/src/rules/common/__tests__/operation-singular-tag.test.ts +0 -72
  277. package/src/rules/common/__tests__/path-http-verbs-order.test.ts +0 -95
  278. package/src/rules/common/__tests__/path-not-include-query.test.ts +0 -64
  279. package/src/rules/common/__tests__/path-params-defined.test.ts +0 -133
  280. package/src/rules/common/__tests__/paths-kebab-case.test.ts +0 -108
  281. package/src/rules/common/__tests__/spec.test.ts +0 -62
  282. package/src/rules/common/__tests__/tag-description.test.ts +0 -65
  283. package/src/rules/common/__tests__/tags-alphabetical.test.ts +0 -64
  284. package/src/rules/common/assertions/__tests__/asserts.test.ts +0 -231
  285. package/src/rules/common/assertions/__tests__/index.test.ts +0 -65
  286. package/src/rules/common/assertions/__tests__/utils.test.ts +0 -89
  287. package/src/rules/common/assertions/asserts.ts +0 -137
  288. package/src/rules/common/assertions/index.ts +0 -75
  289. package/src/rules/common/assertions/utils.ts +0 -167
  290. package/src/rules/common/info-contact.ts +0 -15
  291. package/src/rules/common/info-description.ts +0 -10
  292. package/src/rules/common/info-license-url.ts +0 -15
  293. package/src/rules/common/license-url.ts +0 -10
  294. package/src/rules/common/no-ambiguous-paths.ts +0 -50
  295. package/src/rules/common/no-enum-type-mismatch.ts +0 -49
  296. package/src/rules/common/no-http-verbs-in-paths.ts +0 -36
  297. package/src/rules/common/no-identical-paths.ts +0 -24
  298. package/src/rules/common/no-invalid-parameter-examples.ts +0 -36
  299. package/src/rules/common/no-invalid-schema-examples.ts +0 -27
  300. package/src/rules/common/no-path-trailing-slash.ts +0 -15
  301. package/src/rules/common/operation-2xx-response.ts +0 -16
  302. package/src/rules/common/operation-4xx-response.ts +0 -17
  303. package/src/rules/common/operation-description.ts +0 -13
  304. package/src/rules/common/operation-operationId-unique.ts +0 -21
  305. package/src/rules/common/operation-operationId-url-safe.ts +0 -19
  306. package/src/rules/common/operation-operationId.ts +0 -17
  307. package/src/rules/common/operation-parameters-unique.ts +0 -48
  308. package/src/rules/common/operation-security-defined.ts +0 -45
  309. package/src/rules/common/operation-singular-tag.ts +0 -17
  310. package/src/rules/common/operation-summary.ts +0 -13
  311. package/src/rules/common/operation-tag-defined.ts +0 -26
  312. package/src/rules/common/parameter-description.ts +0 -22
  313. package/src/rules/common/path-declaration-must-exist.ts +0 -15
  314. package/src/rules/common/path-excludes-patterns.ts +0 -23
  315. package/src/rules/common/path-http-verbs-order.ts +0 -30
  316. package/src/rules/common/path-not-include-query.ts +0 -17
  317. package/src/rules/common/path-params-defined.ts +0 -58
  318. package/src/rules/common/path-segment-plural.ts +0 -31
  319. package/src/rules/common/paths-kebab-case.ts +0 -16
  320. package/src/rules/common/spec.ts +0 -143
  321. package/src/rules/common/tag-description.ts +0 -10
  322. package/src/rules/common/tags-alphabetical.ts +0 -20
  323. package/src/rules/no-unresolved-refs.ts +0 -51
  324. package/src/rules/oas2/__tests__/boolean-parameter-prefixes.test.ts +0 -110
  325. package/src/rules/oas2/__tests__/spec/fixtures/description.md +0 -1
  326. package/src/rules/oas2/__tests__/spec/info.test.ts +0 -355
  327. package/src/rules/oas2/__tests__/spec/operation.test.ts +0 -123
  328. package/src/rules/oas2/__tests__/spec/paths.test.ts +0 -245
  329. package/src/rules/oas2/__tests__/spec/referenceableScalars.test.ts +0 -31
  330. package/src/rules/oas2/__tests__/spec/utils.ts +0 -32
  331. package/src/rules/oas2/boolean-parameter-prefixes.ts +0 -26
  332. package/src/rules/oas2/index.ts +0 -83
  333. package/src/rules/oas2/remove-unused-components.ts +0 -76
  334. package/src/rules/oas2/request-mime-type.ts +0 -17
  335. package/src/rules/oas2/response-mime-type.ts +0 -17
  336. package/src/rules/oas3/__tests__/boolean-parameter-prefixes.test.ts +0 -111
  337. package/src/rules/oas3/__tests__/fixtures/common.yaml +0 -11
  338. package/src/rules/oas3/__tests__/no-empty-enum-servers.com.test.ts +0 -205
  339. package/src/rules/oas3/__tests__/no-example-value-and-externalValue.test.ts +0 -65
  340. package/src/rules/oas3/__tests__/no-invalid-media-type-examples.test.ts +0 -392
  341. package/src/rules/oas3/__tests__/no-server-example.com.test.ts +0 -60
  342. package/src/rules/oas3/__tests__/no-server-trailing-slash.test.ts +0 -79
  343. package/src/rules/oas3/__tests__/no-unused-components.test.ts +0 -131
  344. package/src/rules/oas3/__tests__/spec/callbacks.test.ts +0 -41
  345. package/src/rules/oas3/__tests__/spec/fixtures/description.md +0 -1
  346. package/src/rules/oas3/__tests__/spec/info.test.ts +0 -391
  347. package/src/rules/oas3/__tests__/spec/operation.test.ts +0 -253
  348. package/src/rules/oas3/__tests__/spec/paths.test.ts +0 -284
  349. package/src/rules/oas3/__tests__/spec/referenceableScalars.test.ts +0 -77
  350. package/src/rules/oas3/__tests__/spec/servers.test.ts +0 -499
  351. package/src/rules/oas3/__tests__/spec/spec.test.ts +0 -288
  352. package/src/rules/oas3/__tests__/spec/utils.ts +0 -32
  353. package/src/rules/oas3/boolean-parameter-prefixes.ts +0 -28
  354. package/src/rules/oas3/index.ts +0 -99
  355. package/src/rules/oas3/no-empty-servers.ts +0 -22
  356. package/src/rules/oas3/no-example-value-and-externalValue.ts +0 -14
  357. package/src/rules/oas3/no-invalid-media-type-examples.ts +0 -41
  358. package/src/rules/oas3/no-server-example.com.ts +0 -14
  359. package/src/rules/oas3/no-server-trailing-slash.ts +0 -15
  360. package/src/rules/oas3/no-servers-empty-enum.ts +0 -67
  361. package/src/rules/oas3/no-undefined-server-variable.ts +0 -30
  362. package/src/rules/oas3/no-unused-components.ts +0 -75
  363. package/src/rules/oas3/remove-unused-components.ts +0 -84
  364. package/src/rules/oas3/request-mime-type.ts +0 -31
  365. package/src/rules/oas3/response-mime-type.ts +0 -31
  366. package/src/rules/other/stats.ts +0 -44
  367. package/src/rules/utils.ts +0 -123
  368. package/src/types/index.ts +0 -138
  369. package/src/types/oas2.ts +0 -397
  370. package/src/types/oas3.ts +0 -506
  371. package/src/types/oas3_1.ts +0 -251
  372. package/src/types/redocly-yaml.ts +0 -637
  373. package/src/typings/common.ts +0 -9
  374. package/src/typings/openapi.ts +0 -297
  375. package/src/typings/swagger.ts +0 -236
  376. package/src/utils.ts +0 -190
  377. package/src/visitors.ts +0 -448
  378. package/src/walk.ts +0 -416
  379. package/tsconfig.json +0 -8
  380. package/tsconfig.tsbuildinfo +0 -1
@@ -1,637 +0,0 @@
1
- import { NodeType, listOf } from '.';
2
- import { omitObjectProps, pickObjectProps } from '../utils';
3
-
4
- const ConfigRoot: NodeType = {
5
- properties: {
6
- organization: { type: 'string' },
7
- apis: 'ConfigApis',
8
- lint: 'RootConfigLint',
9
- 'features.openapi': 'ConfigReferenceDocs',
10
- 'features.mockServer': 'ConfigMockServer',
11
- },
12
- };
13
-
14
- const ConfigApis: NodeType = {
15
- properties: {},
16
- additionalProperties: 'ConfigApisProperties',
17
- };
18
-
19
- const ConfigApisProperties: NodeType = {
20
- properties: {
21
- root: { type: 'string' },
22
- lint: 'ConfigLint',
23
- 'features.openapi': 'ConfigReferenceDocs',
24
- },
25
- };
26
-
27
- const ConfigHTTP: NodeType = {
28
- properties: {
29
- headers: {
30
- type: 'array',
31
- items: {
32
- type: 'string',
33
- },
34
- },
35
- },
36
- };
37
-
38
- const ConfigLint: NodeType = {
39
- properties: {
40
- extends: {
41
- type: 'array',
42
- items: {
43
- type: 'string',
44
- },
45
- },
46
- doNotResolveExamples: { type: 'boolean' },
47
- rules: { type: 'object' },
48
- oas2Rules: { type: 'object' },
49
- oas3_0Rules: { type: 'object' },
50
- oas3_1Rules: { type: 'object' },
51
- preprocessors: { type: 'object' },
52
- oas2Preprocessors: { type: 'object' },
53
- oas3_0Preprocessors: { type: 'object' },
54
- oas3_1Preprocessors: { type: 'object' },
55
- decorators: { type: 'object' },
56
- oas2Decorators: { type: 'object' },
57
- oas3_0Decorators: { type: 'object' },
58
- oas3_1Decorators: { type: 'object' },
59
- resolve: {
60
- properties: {
61
- http: 'ConfigHTTP',
62
- },
63
- },
64
- },
65
- };
66
-
67
- const RootConfigLint: NodeType = {
68
- properties: {
69
- plugins: {
70
- type: 'array',
71
- items: { type: 'string' },
72
- },
73
- ...ConfigLint.properties,
74
- },
75
- };
76
-
77
- const ConfigLanguage: NodeType = {
78
- properties: {
79
- label: { type: 'string' },
80
- lang: { type: 'string' },
81
- },
82
- };
83
-
84
- const ConfigLabels: NodeType = {
85
- properties: {
86
- enum: { type: 'string' },
87
- enumSingleValue: { type: 'string' },
88
- enumArray: { type: 'string' },
89
- default: { type: 'string' },
90
- deprecated: { type: 'string' },
91
- example: { type: 'string' },
92
- examples: { type: 'string' },
93
- nullable: { type: 'string' },
94
- recursive: { type: 'string' },
95
- arrayOf: { type: 'string' },
96
- webhook: { type: 'string' },
97
- authorizations: { type: 'string' },
98
- tryItAuthBasicUsername: { type: 'string' },
99
- tryItAuthBasicPassword: { type: 'string' },
100
- },
101
- };
102
-
103
- const ConfigSidebarLinks: NodeType = {
104
- properties: {
105
- placement: { type: 'string' },
106
- label: { type: 'string' },
107
- link: { type: 'string' },
108
- target: { type: 'string' },
109
- },
110
- };
111
-
112
- const CommonThemeColors: NodeType = {
113
- properties: {
114
- main: { type: 'string' },
115
- light: { type: 'string' },
116
- dark: { type: 'string' },
117
- contrastText: { type: 'string' },
118
- },
119
- };
120
-
121
- const CommonColorProps: NodeType = {
122
- properties: {
123
- backgroundColor: { type: 'string' },
124
- borderColor: { type: 'string' },
125
- color: { type: 'string' },
126
- tabTextColor: { type: 'string' },
127
- },
128
- };
129
-
130
- const BorderThemeColors: NodeType = {
131
- properties: pickObjectProps(CommonThemeColors.properties, ['light', 'dark']),
132
- };
133
-
134
- const HttpColors: NodeType = {
135
- properties: {
136
- basic: { type: 'string' },
137
- delete: { type: 'string' },
138
- get: { type: 'string' },
139
- head: { type: 'string' },
140
- link: { type: 'string' },
141
- options: { type: 'string' },
142
- patch: { type: 'string' },
143
- post: { type: 'string' },
144
- put: { type: 'string' },
145
- },
146
- };
147
-
148
- const ResponseColors: NodeType = {
149
- properties: {
150
- errors: 'CommonColorProps',
151
- info: 'CommonColorProps',
152
- redirect: 'CommonColorProps',
153
- success: 'CommonColorProps',
154
- },
155
- };
156
-
157
- const SecondaryColors: NodeType = {
158
- properties: omitObjectProps(CommonThemeColors.properties, ['dark']),
159
- };
160
-
161
- const TextThemeColors: NodeType = {
162
- properties: {
163
- primary: { type: 'string' },
164
- secondary: { type: 'string' },
165
- light: { type: 'string' },
166
- },
167
- };
168
-
169
- const ThemeColors: NodeType = {
170
- properties: {
171
- accent: 'CommonThemeColors',
172
- border: 'BorderThemeColors',
173
- error: 'CommonThemeColors',
174
- http: 'HttpColors',
175
- primary: 'CommonThemeColors',
176
- responses: 'ResponseColors',
177
- secondary: 'SecondaryColors',
178
- success: 'CommonThemeColors',
179
- text: 'TextThemeColors',
180
- tonalOffset: { type: 'number' },
181
- warning: 'CommonThemeColors',
182
- },
183
- };
184
-
185
- const SizeProps: NodeType = {
186
- properties: {
187
- fontSize: { type: 'string' },
188
- padding: { type: 'string' },
189
- minWidth: { type: 'string' },
190
- },
191
- };
192
-
193
- const Sizes: NodeType = {
194
- properties: {
195
- small: 'SizeProps',
196
- medium: 'SizeProps',
197
- large: 'SizeProps',
198
- xlarge: 'SizeProps',
199
- },
200
- };
201
-
202
- const FontConfig: NodeType = {
203
- properties: {
204
- fontFamily: { type: 'string' },
205
- fontSize: { type: 'string' },
206
- fontWeight: { type: 'string' },
207
- lineHeight: { type: 'string' },
208
- },
209
- };
210
-
211
- const ButtonsConfig: NodeType = {
212
- properties: {
213
- ...omitObjectProps(FontConfig.properties, ['fontSize', 'lineHeight']),
214
- borderRadius: { type: 'string' },
215
- hoverStyle: { type: 'string' },
216
- boxShadow: { type: 'string' },
217
- hoverBoxShadow: { type: 'string' },
218
- sizes: 'Sizes',
219
- },
220
- };
221
-
222
- const BadgeFontConfig: NodeType = {
223
- properties: pickObjectProps(FontConfig.properties, ['fontSize', 'lineHeight']),
224
- };
225
-
226
- const BadgeSizes: NodeType = {
227
- properties: {
228
- medium: 'BadgeFontConfig',
229
- small: 'BadgeFontConfig',
230
- },
231
- };
232
-
233
- const HttpBadgesConfig: NodeType = {
234
- properties: {
235
- ...omitObjectProps(FontConfig.properties, ['fontSize', 'lineHeight']),
236
- borderRadius: { type: 'string' },
237
- color: { type: 'string' },
238
- sizes: 'BadgeSizes',
239
- },
240
- };
241
-
242
- const LabelControls: NodeType = {
243
- properties: {
244
- top: { type: 'string' },
245
- },
246
- };
247
-
248
- const Panels: NodeType = {
249
- properties: {
250
- borderRadius: { type: 'string' },
251
- },
252
- };
253
-
254
- const TryItButton: NodeType = {
255
- properties: {
256
- fullWidth: { type: 'boolean' },
257
- },
258
- };
259
-
260
- const Components: NodeType = {
261
- properties: {
262
- buttons: 'ButtonsConfig',
263
- httpBadges: 'HttpBadgesConfig',
264
- layoutControls: 'LabelControls',
265
- panels: 'Panels',
266
- tryItButton: 'TryItButton',
267
- tryItSendButton: 'TryItButton',
268
- },
269
- };
270
-
271
- const Breakpoints: NodeType = {
272
- properties: {
273
- small: { type: 'string' },
274
- medium: { type: 'string' },
275
- large: { type: 'string' },
276
- },
277
- };
278
-
279
- const StackedConfig: NodeType = {
280
- properties: {
281
- maxWidth: 'Breakpoints',
282
- },
283
- };
284
-
285
- const ThreePanelConfig: NodeType = {
286
- properties: {
287
- maxWidth: 'Breakpoints',
288
- },
289
- };
290
-
291
- const Layout: NodeType = {
292
- properties: {
293
- showDarkRightPanel: { type: 'boolean' },
294
- stacked: 'StackedConfig',
295
- 'three-panel': 'ThreePanelConfig',
296
- },
297
- };
298
-
299
- const SchemaColorsConfig: NodeType = {
300
- properties: {
301
- backgroundColor: { type: 'string' },
302
- border: { type: 'string' },
303
- },
304
- };
305
-
306
- const Schema: NodeType = {
307
- properties: {
308
- breakFieldNames: { type: 'boolean' },
309
- caretColor: { type: 'string' },
310
- caretSize: { type: 'string' },
311
- constraints: 'SchemaColorsConfig',
312
- defaultDetailsWidth: { type: 'string' },
313
- examples: 'SchemaColorsConfig',
314
- labelsTextSize: { type: 'string' },
315
- linesColor: { type: 'string' },
316
- nestedBackground: { type: 'string' },
317
- nestingSpacing: { type: 'string' },
318
- requireLabelColor: { type: 'string' },
319
- typeNameColor: { type: 'string' },
320
- typeTitleColor: { type: 'string' },
321
- },
322
- };
323
-
324
- const GroupItemsConfig: NodeType = {
325
- properties: {
326
- subItemsColor: { type: 'string' },
327
- textTransform: { type: 'string' },
328
- fontWeight: { type: 'string' },
329
- },
330
- };
331
-
332
- const Level1Items: NodeType = {
333
- properties: pickObjectProps(GroupItemsConfig.properties, ['textTransform']),
334
- };
335
-
336
- const SpacingConfig: NodeType = {
337
- properties: {
338
- unit: { type: 'number' },
339
- paddingHorizontal: { type: 'string' },
340
- paddingVertical: { type: 'string' },
341
- offsetTop: { type: 'string' },
342
- offsetLeft: { type: 'string' },
343
- offsetNesting: { type: 'string' },
344
- },
345
- };
346
-
347
- const Sidebar: NodeType = {
348
- properties: {
349
- ...omitObjectProps(FontConfig.properties, ['fontWeight', 'lineHeight']),
350
- activeBgColor: { type: 'string' },
351
- activeTextColor: { type: 'string' },
352
- backgroundColor: { type: 'string' },
353
- borderRadius: { type: 'string' },
354
- breakPath: { type: 'boolean' },
355
- caretColor: { type: 'string' },
356
- caretSize: { type: 'string' },
357
- groupItems: 'GroupItemsConfig',
358
- level1items: 'Level1Items',
359
- rightLineColor: { type: 'string' },
360
- separatorLabelColor: { type: 'string' },
361
- showAtBreakpoint: { type: 'string' },
362
- spacing: 'SpacingConfig',
363
- textColor: { type: 'string' },
364
- width: { type: 'string' },
365
- },
366
- };
367
-
368
- const Heading: NodeType = {
369
- properties: {
370
- ...FontConfig.properties,
371
- color: { type: 'string' },
372
- transform: { type: 'string' },
373
- },
374
- };
375
-
376
- const CodeConfig: NodeType = {
377
- properties: {
378
- ...FontConfig.properties,
379
- backgroundColor: { type: 'string' },
380
- color: { type: 'string' },
381
- wordBreak: { type: 'string' },
382
- wrap: { type: 'boolean' },
383
- },
384
- };
385
-
386
- const HeadingsConfig: NodeType = {
387
- properties: omitObjectProps(FontConfig.properties, ['fontSize']),
388
- };
389
-
390
- const LinksConfig: NodeType = {
391
- properties: {
392
- color: { type: 'string' },
393
- hover: { type: 'string' },
394
- textDecoration: { type: 'string' },
395
- visited: { type: 'string' },
396
- },
397
- };
398
-
399
- const Typography: NodeType = {
400
- properties: {
401
- code: 'CodeConfig',
402
- fieldName: 'FontConfig',
403
- ...pickObjectProps(FontConfig.properties, ['fontSize', 'fontFamily']),
404
- fontWeightBold: { type: 'string' },
405
- fontWeightLight: { type: 'string' },
406
- fontWeightRegular: { type: 'string' },
407
- heading1: 'Heading',
408
- heading2: 'Heading',
409
- heading3: 'Heading',
410
- headings: 'HeadingsConfig',
411
- lineHeight: { type: 'string' },
412
- links: 'LinksConfig',
413
- optimizeSpeed: { type: 'boolean' },
414
- rightPanelHeading: 'Heading',
415
- smoothing: { type: 'string' },
416
- },
417
- };
418
-
419
- const TokenProps: NodeType = {
420
- properties: {
421
- color: { type: 'string' },
422
- ...omitObjectProps(FontConfig.properties, ['fontWeight']),
423
- },
424
- };
425
-
426
- const CodeBlock: NodeType = {
427
- properties: {
428
- backgroundColor: { type: 'string' },
429
- borderRadius: { type: 'string' },
430
- tokens: 'TokenProps',
431
- },
432
- };
433
-
434
- const Logo: NodeType = {
435
- properties: {
436
- gutter: { type: 'string' },
437
- maxHeight: { type: 'string' },
438
- maxWidth: { type: 'string' },
439
- },
440
- };
441
-
442
- const ButtonOverrides: NodeType = {
443
- properties: {
444
- custom: { type: 'string' },
445
- },
446
- };
447
-
448
- const Overrides: NodeType = {
449
- properties: {
450
- DownloadButton: 'ButtonOverrides',
451
- NextSectionButton: 'ButtonOverrides',
452
- },
453
- };
454
-
455
- const RightPanel: NodeType = {
456
- properties: {
457
- backgroundColor: { type: 'string' },
458
- panelBackgroundColor: { type: 'string' },
459
- panelControlsBackgroundColor: { type: 'string' },
460
- showAtBreakpoint: { type: 'string' },
461
- textColor: { type: 'string' },
462
- width: { type: 'string' },
463
- },
464
- };
465
-
466
- const Shape: NodeType = {
467
- properties: { borderRadius: { type: 'string' } },
468
- };
469
-
470
- const ThemeSpacing: NodeType = {
471
- properties: {
472
- sectionHorizontal: { type: 'number' },
473
- sectionVertical: { type: 'number' },
474
- unit: { type: 'number' },
475
- },
476
- };
477
-
478
- const ConfigTheme: NodeType = {
479
- properties: {
480
- breakpoints: 'Breakpoints',
481
- codeBlock: 'CodeBlock',
482
- colors: 'ThemeColors',
483
- components: 'Components',
484
- layout: 'Layout',
485
- logo: 'Logo',
486
- overrides: 'Overrides',
487
- rightPanel: 'RightPanel',
488
- schema: 'Schema',
489
- shape: 'Shape',
490
- sidebar: 'Sidebar',
491
- spacing: 'ThemeSpacing',
492
- typography: 'Typography',
493
- links: { properties: { color: { type: 'string' } } },
494
- codeSample: { properties: { backgroundColor: { type: 'string' } } },
495
- },
496
- };
497
-
498
- const GenerateCodeSamples: NodeType = {
499
- properties: {
500
- skipOptionalParameters: { type: 'boolean' },
501
- languages: listOf('ConfigLanguage'),
502
- },
503
- };
504
-
505
- const ConfigReferenceDocs: NodeType = {
506
- properties: {
507
- theme: 'ConfigTheme',
508
- corsProxyUrl: { type: 'string' },
509
- ctrlFHijack: { type: 'boolean' },
510
- defaultSampleLanguage: { type: 'string' },
511
- disableDeepLinks: { type: 'boolean' },
512
- disableSearch: { type: 'boolean' },
513
- disableSidebar: { type: 'boolean' },
514
- downloadDefinitionUrl: { type: 'string' },
515
- expandDefaultServerVariables: { type: 'boolean' },
516
- expandResponses: { type: 'string' },
517
- expandSingleSchemaField: { type: 'boolean' },
518
- generateCodeSamples: 'GenerateCodeSamples',
519
- generatedPayloadSamplesMaxDepth: { type: 'number' },
520
- hideDownloadButton: { type: 'boolean' },
521
- hideHostname: { type: 'boolean' },
522
- hideInfoSection: { type: 'boolean' },
523
- hideLoading: { type: 'boolean' },
524
- hideLogo: { type: 'boolean' },
525
- hideRequestPayloadSample: { type: 'boolean' },
526
- hideSchemaPattern: { type: 'boolean' },
527
- hideSchemaTitles: { type: 'boolean' },
528
- hideSingleRequestSampleTab: { type: 'boolean' },
529
- hideTryItPanel: { type: 'boolean' },
530
- htmlTemplate: { type: 'string' },
531
- jsonSampleExpandLevel: { type: 'string' },
532
- labels: 'ConfigLabels',
533
- layout: { type: 'string' },
534
- maxDisplayedEnumValues: { type: 'number' },
535
- menuToggle: { type: 'boolean' },
536
- nativeScrollbars: { type: 'boolean' },
537
- noAutoAuth: { type: 'boolean' },
538
- oAuth2RedirectURI: { type: 'string' },
539
- onDeepLinkClick: { type: 'object' },
540
- onlyRequiredInSamples: { type: 'boolean' },
541
- pagination: { type: 'string' },
542
- pathInMiddlePanel: { type: 'boolean' },
543
- payloadSampleIdx: { type: 'number' },
544
- requestInterceptor: { type: 'object' },
545
- requiredPropsFirst: { type: 'boolean' },
546
- routingBasePath: { type: 'string' },
547
- samplesTabsMaxCount: { type: 'number' },
548
- schemaExpansionLevel: { type: 'string' },
549
- schemaDefinitionsTagName: { type: 'string' },
550
- scrollYOffset: { type: 'string' },
551
- searchAutoExpand: { type: 'boolean' },
552
- searchFieldLevelBoost: { type: 'number' },
553
- searchMode: { type: 'string' },
554
- searchOperationTitleBoost: { type: 'number' },
555
- searchTagTitleBoost: { type: 'number' },
556
- showChangeLayoutButton: { type: 'boolean' },
557
- showConsole: { type: 'boolean' },
558
- showExtensions: { type: 'boolean' },
559
- showNextButton: { type: 'boolean' },
560
- showRightPanelToggle: { type: 'boolean' },
561
- sidebarLinks: 'ConfigSidebarLinks',
562
- sideNavStyle: { type: 'string' },
563
- simpleOneOfTypeLabel: { type: 'boolean' },
564
- sortEnumValuesAlphabetically: { type: 'boolean' },
565
- sortOperationsAlphabetically: { type: 'boolean' },
566
- sortPropsAlphabetically: { type: 'boolean' },
567
- sortTagsAlphabetically: { type: 'boolean' },
568
- unstable_ignoreMimeParameters: { type: 'boolean' },
569
- untrustedDefinition: { type: 'boolean' },
570
- },
571
- additionalProperties: { type: 'string' },
572
- };
573
-
574
- const ConfigMockServer: NodeType = {
575
- properties: {
576
- strictExamples: { type: 'boolean' },
577
- errorIfForcedExampleNotFound: { type: 'boolean' },
578
- },
579
- };
580
-
581
- export const ConfigTypes: Record<string, NodeType> = {
582
- ConfigRoot,
583
- ConfigApis,
584
- ConfigApisProperties,
585
- RootConfigLint,
586
- ConfigLint,
587
- ConfigReferenceDocs,
588
- ConfigMockServer,
589
- ConfigHTTP,
590
- ConfigLanguage,
591
- ConfigLabels,
592
- ConfigSidebarLinks,
593
- ConfigTheme,
594
- ThemeColors,
595
- CommonThemeColors,
596
- BorderThemeColors,
597
- HttpColors,
598
- ResponseColors,
599
- SecondaryColors,
600
- TextThemeColors,
601
- Sizes,
602
- ButtonsConfig,
603
- CommonColorProps,
604
- BadgeFontConfig,
605
- BadgeSizes,
606
- HttpBadgesConfig,
607
- LabelControls,
608
- Panels,
609
- TryItButton,
610
- Breakpoints,
611
- StackedConfig,
612
- ThreePanelConfig,
613
- SchemaColorsConfig,
614
- SizeProps,
615
- Level1Items,
616
- SpacingConfig,
617
- FontConfig,
618
- CodeConfig,
619
- HeadingsConfig,
620
- LinksConfig,
621
- TokenProps,
622
- CodeBlock,
623
- Logo,
624
- ButtonOverrides,
625
- Overrides,
626
- RightPanel,
627
- Shape,
628
- ThemeSpacing,
629
- GenerateCodeSamples,
630
- GroupItemsConfig,
631
- Components,
632
- Layout,
633
- Schema,
634
- Sidebar,
635
- Heading,
636
- Typography,
637
- };
@@ -1,9 +0,0 @@
1
- export interface StatsRow {
2
- metric: string;
3
- total: number;
4
- color: 'red' | 'yellow' | 'green' | 'white' | 'magenta' | 'cyan';
5
- items?: Set<string>;
6
- }
7
-
8
- export type StatsName = 'operations' | 'refs' | 'tags' | 'externalDocs' | 'pathItems' | 'links' | 'schemas' | 'parameters';
9
- export type StatsAccumulator = Record<StatsName, StatsRow>;