@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,231 +0,0 @@
1
- import { asserts } from '../asserts';
2
-
3
- describe('oas3 assertions', () => {
4
- describe('generic rules', () => {
5
- const fakeNode = {
6
- foo: '',
7
- bar: '',
8
- baz: '',
9
- };
10
-
11
- describe('pattern', () => {
12
- it('value should match regex pattern', () => {
13
- expect(asserts.pattern('test string', '/test/')).toBeTruthy();
14
- expect(asserts.pattern('test string', '/test me/')).toBeFalsy();
15
- expect(asserts.pattern(['test string', 'test me'], '/test/')).toBeTruthy();
16
- expect(asserts.pattern(['test string', 'test me'], '/test me/')).toBeFalsy();
17
- });
18
- });
19
-
20
- describe('enum', () => {
21
- it('value should be among predefined keys', () => {
22
- expect(asserts.enum('test', ['test', 'example'])).toBeTruthy();
23
- expect(asserts.enum(['test'], ['test', 'example'])).toBeTruthy();
24
- expect(asserts.enum(['test', 'example'], ['test', 'example'])).toBeTruthy();
25
- expect(asserts.enum(['test', 'example', 'foo'], ['test', 'example'])).toBeFalsy();
26
- expect(asserts.enum('test', ['foo', 'example'])).toBeFalsy();
27
- expect(asserts.enum(['test', 'foo'], ['test', 'example'])).toBeFalsy();
28
- });
29
- });
30
-
31
- describe('defined', () => {
32
- it('value should be defined', () => {
33
- expect(asserts.defined('test', true)).toBeTruthy();
34
- expect(asserts.defined(undefined, true)).toBeFalsy();
35
- });
36
- it('value should be undefined', () => {
37
- expect(asserts.defined(undefined, false)).toBeTruthy();
38
- expect(asserts.defined('test', false)).toBeFalsy();
39
- });
40
- });
41
-
42
- describe('undefined', () => {
43
- it('value should be undefined', () => {
44
- expect(asserts.undefined(undefined, true)).toBeTruthy();
45
- expect(asserts.undefined('test', true)).toBeFalsy();
46
- });
47
- it('value should be defined', () => {
48
- expect(asserts.undefined('test', false)).toBeTruthy();
49
- expect(asserts.undefined(undefined, false)).toBeFalsy();
50
- });
51
- });
52
-
53
- describe('required', () => {
54
- it('values should be required', () => {
55
- expect(asserts.required(['one', 'two', 'three'], ['one', 'two'])).toBeTruthy();
56
- expect(asserts.required(['one', 'two'], ['one', 'two', 'three'])).toBeFalsy();
57
- });
58
- });
59
-
60
- describe('nonEmpty', () => {
61
- it('value should not be empty', () => {
62
- expect(asserts.nonEmpty('test', true)).toBeTruthy();
63
- expect(asserts.nonEmpty('', true)).toBeFalsy();
64
- expect(asserts.nonEmpty(null, true)).toBeFalsy();
65
- expect(asserts.nonEmpty(undefined, true)).toBeFalsy();
66
- });
67
- it('value should be empty', () => {
68
- expect(asserts.nonEmpty('', false)).toBeTruthy();
69
- expect(asserts.nonEmpty(null, false)).toBeTruthy();
70
- expect(asserts.nonEmpty(undefined, false)).toBeTruthy();
71
- expect(asserts.nonEmpty('test', false)).toBeFalsy();
72
- });
73
- });
74
-
75
- describe('minLength', () => {
76
- it('value should have less or equal than 5 symbols length', () => {
77
- expect(asserts.minLength('test', 5)).toBeFalsy();
78
- expect(asserts.minLength([1, 2, 3, 4], 5)).toBeFalsy();
79
- expect(asserts.minLength([1, 2, 3, 4, 5], 5)).toBeTruthy();
80
- expect(asserts.minLength([1, 2, 3, 4, 5, 6], 5)).toBeTruthy();
81
- expect(asserts.minLength('example', 5)).toBeTruthy();
82
- expect(asserts.minLength([], 5)).toBeFalsy();
83
- expect(asserts.minLength('', 5)).toBeFalsy();
84
- });
85
- });
86
-
87
- describe('maxLength', () => {
88
- it('value should have more or equal than 5 symbols length', () => {
89
- expect(asserts.maxLength('test', 5)).toBeTruthy();
90
- expect(asserts.maxLength([1, 2, 3, 4], 5)).toBeTruthy();
91
- expect(asserts.maxLength([1, 2, 3, 4, 5], 5)).toBeTruthy();
92
- expect(asserts.maxLength([1, 2, 3, 4, 5, 6], 5)).toBeFalsy();
93
- expect(asserts.maxLength('example', 5)).toBeFalsy();
94
- expect(asserts.maxLength([], 5)).toBeTruthy();
95
- expect(asserts.maxLength('', 5)).toBeTruthy();
96
- });
97
- });
98
-
99
- describe('casing', () => {
100
- it('value should be camelCase', () => {
101
- expect(asserts.casing(['testExample', 'fooBar'], 'camelCase')).toBeTruthy();
102
- expect(asserts.casing(['testExample', 'FooBar'], 'camelCase')).toBeFalsy();
103
- expect(asserts.casing('testExample', 'camelCase')).toBeTruthy();
104
- expect(asserts.casing('TestExample', 'camelCase')).toBeFalsy();
105
- expect(asserts.casing('test-example', 'camelCase')).toBeFalsy();
106
- expect(asserts.casing('test_example', 'camelCase')).toBeFalsy();
107
- });
108
- it('value should be PascalCase', () => {
109
- expect(asserts.casing('TestExample', 'PascalCase')).toBeTruthy();
110
- expect(asserts.casing(['TestExample', 'FooBar'], 'PascalCase')).toBeTruthy();
111
- expect(asserts.casing(['TestExample', 'fooBar'], 'PascalCase')).toBeFalsy();
112
- expect(asserts.casing('testExample', 'PascalCase')).toBeFalsy();
113
- expect(asserts.casing('test-example', 'PascalCase')).toBeFalsy();
114
- expect(asserts.casing('test_example', 'PascalCase')).toBeFalsy();
115
- });
116
- it('value should be kebab-case', () => {
117
- expect(asserts.casing('test-example', 'kebab-case')).toBeTruthy();
118
- expect(asserts.casing(['test-example', 'foo-bar'], 'kebab-case')).toBeTruthy();
119
- expect(asserts.casing(['test-example', 'foo_bar'], 'kebab-case')).toBeFalsy();
120
- expect(asserts.casing('testExample', 'kebab-case')).toBeFalsy();
121
- expect(asserts.casing('TestExample', 'kebab-case')).toBeFalsy();
122
- expect(asserts.casing('test_example', 'kebab-case')).toBeFalsy();
123
- });
124
- it('value should be snake_case', () => {
125
- expect(asserts.casing('test_example', 'snake_case')).toBeTruthy();
126
- expect(asserts.casing(['test_example', 'foo_bar'], 'snake_case')).toBeTruthy();
127
- expect(asserts.casing(['test_example', 'foo-bar'], 'snake_case')).toBeFalsy();
128
- expect(asserts.casing('testExample', 'snake_case')).toBeFalsy();
129
- expect(asserts.casing('TestExample', 'snake_case')).toBeFalsy();
130
- expect(asserts.casing('test-example', 'snake_case')).toBeFalsy();
131
- });
132
- it('value should be MACRO_CASE', () => {
133
- expect(asserts.casing('TEST_EXAMPLE', 'MACRO_CASE')).toBeTruthy();
134
- expect(asserts.casing(['TEST_EXAMPLE', 'FOO_BAR'], 'MACRO_CASE')).toBeTruthy();
135
- expect(asserts.casing(['TEST_EXAMPLE', 'FOO-BAR'], 'MACRO_CASE')).toBeFalsy();
136
- expect(asserts.casing('TEST_EXAMPLE_', 'MACRO_CASE')).toBeFalsy();
137
- expect(asserts.casing('_TEST_EXAMPLE', 'MACRO_CASE')).toBeFalsy();
138
- expect(asserts.casing('TEST__EXAMPLE', 'MACRO_CASE')).toBeFalsy();
139
- expect(asserts.casing('TEST-EXAMPLE', 'MACRO_CASE')).toBeFalsy();
140
- expect(asserts.casing('testExample', 'MACRO_CASE')).toBeFalsy();
141
- expect(asserts.casing('TestExample', 'MACRO_CASE')).toBeFalsy();
142
- expect(asserts.casing('test-example', 'MACRO_CASE')).toBeFalsy();
143
- });
144
- it('value should be COBOL-CASE', () => {
145
- expect(asserts.casing('TEST-EXAMPLE', 'COBOL-CASE')).toBeTruthy();
146
- expect(asserts.casing(['TEST-EXAMPLE', 'FOO-BAR'], 'COBOL-CASE')).toBeTruthy();
147
- expect(asserts.casing(['TEST-EXAMPLE', 'FOO_BAR'], 'COBOL-CASE')).toBeFalsy();
148
- expect(asserts.casing('TEST-EXAMPLE-', 'COBOL-CASE')).toBeFalsy();
149
- expect(asserts.casing('0TEST-EXAMPLE', 'COBOL-CASE')).toBeFalsy();
150
- expect(asserts.casing('-TEST-EXAMPLE', 'COBOL-CASE')).toBeFalsy();
151
- expect(asserts.casing('TEST--EXAMPLE', 'COBOL-CASE')).toBeFalsy();
152
- expect(asserts.casing('TEST_EXAMPLE', 'COBOL-CASE')).toBeFalsy();
153
- expect(asserts.casing('testExample', 'COBOL-CASE')).toBeFalsy();
154
- expect(asserts.casing('TestExample', 'COBOL-CASE')).toBeFalsy();
155
- expect(asserts.casing('test-example', 'COBOL-CASE')).toBeFalsy();
156
- });
157
- it('value should be flatcase', () => {
158
- expect(asserts.casing('testexample', 'flatcase')).toBeTruthy();
159
- expect(asserts.casing(['testexample', 'foobar'], 'flatcase')).toBeTruthy();
160
- expect(asserts.casing(['testexample', 'foo_bar'], 'flatcase')).toBeFalsy();
161
- expect(asserts.casing('testexample_', 'flatcase')).toBeFalsy();
162
- expect(asserts.casing('0testexample', 'flatcase')).toBeFalsy();
163
- expect(asserts.casing('testExample', 'flatcase')).toBeFalsy();
164
- expect(asserts.casing('TestExample', 'flatcase')).toBeFalsy();
165
- expect(asserts.casing('test-example', 'flatcase')).toBeFalsy();
166
- });
167
- });
168
-
169
- describe.skip('sortOrder', () => {
170
- it('value should be ordered in ASC direction', () => {
171
- expect(asserts.sortOrder(['example', 'foo', 'test'], 'asc')).toBeTruthy();
172
- expect(asserts.sortOrder(['example', 'foo', 'test'], { direction: 'asc' })).toBeTruthy();
173
- expect(asserts.sortOrder(['example'], 'asc')).toBeTruthy();
174
- expect(asserts.sortOrder(['example', 'test', 'foo'], 'asc')).toBeFalsy();
175
- expect(asserts.sortOrder(['example', 'foo', 'test'], 'desc')).toBeFalsy();
176
- expect(
177
- asserts.sortOrder([{ name: 'bar' }, { name: 'baz' }, { name: 'foo' }], {
178
- direction: 'asc',
179
- property: 'name',
180
- }),
181
- ).toBeTruthy();
182
- expect(
183
- asserts.sortOrder([{ name: 'bar' }, { name: 'baz' }, { name: 'foo' }], {
184
- direction: 'desc',
185
- property: 'name',
186
- }),
187
- ).toBeFalsy();
188
- });
189
- it('value should be ordered in DESC direction', () => {
190
- expect(asserts.sortOrder(['test', 'foo', 'example'], 'desc')).toBeTruthy();
191
- expect(asserts.sortOrder(['test', 'foo', 'example'], { direction: 'desc' })).toBeTruthy();
192
- expect(asserts.sortOrder(['example'], 'desc')).toBeTruthy();
193
- expect(asserts.sortOrder(['example', 'test', 'foo'], 'desc')).toBeFalsy();
194
- expect(asserts.sortOrder(['test', 'foo', 'example'], 'asc')).toBeFalsy();
195
- expect(
196
- asserts.sortOrder([{ name: 'foo' }, { name: 'baz' }, { name: 'bar' }], {
197
- direction: 'desc',
198
- property: 'name',
199
- }),
200
- ).toBeTruthy();
201
- expect(
202
- asserts.sortOrder([{ name: 'foo' }, { name: 'baz' }, { name: 'bar' }], {
203
- direction: 'asc',
204
- property: 'name',
205
- }),
206
- ).toBeFalsy();
207
- });
208
- });
209
-
210
- describe('mutuallyExclusive', () => {
211
- it('node should not have more than one property from predefined list', () => {
212
- expect(asserts.mutuallyExclusive(Object.keys(fakeNode), ['foo', 'test'])).toBeTruthy();
213
- expect(asserts.mutuallyExclusive(Object.keys(fakeNode), [])).toBeTruthy();
214
- expect(asserts.mutuallyExclusive(Object.keys(fakeNode), ['foo', 'bar'])).toBeFalsy();
215
- expect(
216
- asserts.mutuallyExclusive(Object.keys(fakeNode), ['foo', 'bar', 'test']),
217
- ).toBeFalsy();
218
- });
219
- });
220
-
221
- describe('mutuallyRequired', () => {
222
- it('node should have all the properties from predefined list', () => {
223
- expect(asserts.mutuallyRequired(Object.keys(fakeNode), ['foo', 'bar'])).toBeTruthy();
224
- expect(asserts.mutuallyRequired(Object.keys(fakeNode), ['foo', 'bar', 'baz'])).toBeTruthy();
225
- expect(asserts.mutuallyRequired(Object.keys(fakeNode), [])).toBeTruthy();
226
- expect(asserts.mutuallyRequired(Object.keys(fakeNode), ['foo', 'test'])).toBeFalsy();
227
- expect(asserts.mutuallyRequired(Object.keys(fakeNode), ['foo', 'bar', 'test'])).toBeFalsy();
228
- });
229
- });
230
- });
231
- });
@@ -1,65 +0,0 @@
1
- import { Assertions } from '../.';
2
-
3
- const opts = {
4
- '0': {
5
- subject: 'Operation',
6
- property: 'summary',
7
- description: 'example warn text',
8
- severity: 'warn',
9
- pattern: '/example/',
10
- },
11
- '1': {
12
- subject: 'PathItem',
13
- context: [{ type: 'Operation', matchParentKeys: ['post'] }],
14
- description: 'example warn text',
15
- severity: 'warn',
16
- mutuallyExclusive: ['summary', 'security'],
17
- },
18
- '2': {
19
- subject: ['PathItem'],
20
- context: [{ type: 'Operation' }],
21
- property: 'tags',
22
- description: 'example warn text',
23
- severity: 'warn',
24
- sortOrder: 'desc',
25
- },
26
- '3': {
27
- subject: ['Foo'],
28
- context: [{ type: 'Bar' }, { type: 'Baz' }],
29
- property: 'test',
30
- description: 'example warn text',
31
- severity: 'warn',
32
- sortOrder: 'desc',
33
- },
34
- };
35
-
36
- describe('Oas3 assertions', () => {
37
- it('should return the right visitor structure', () => {
38
- const visitors = Assertions(opts) as any;
39
- expect(visitors).toMatchInlineSnapshot(`
40
- Array [
41
- Object {
42
- "Operation": [Function],
43
- },
44
- Object {
45
- "Operation": Object {
46
- "PathItem": [Function],
47
- "skip": [Function],
48
- },
49
- },
50
- Object {
51
- "Operation": Object {
52
- "PathItem": [Function],
53
- },
54
- },
55
- Object {
56
- "Bar": Object {
57
- "Baz": Object {
58
- "Foo": [Function],
59
- },
60
- },
61
- },
62
- ]
63
- `);
64
- });
65
- });
@@ -1,89 +0,0 @@
1
- import { isOrdered, buildVisitorObject, getIntersectionLength } from '../utils';
2
-
3
- describe('Oas3 assertions', () => {
4
- describe('Utils', () => {
5
- describe('getCounts', () => {
6
- it('should return the right counts', () => {
7
- const arr = ['foo', 'bar', 'baz'];
8
- expect(getIntersectionLength(arr, ['foo'])).toBe(1);
9
- expect(getIntersectionLength(arr, ['foo', 'bar', 'baz'])).toBe(3);
10
- expect(getIntersectionLength(arr, ['foo', 'test', 'baz'])).toBe(2);
11
- expect(getIntersectionLength(arr, ['example', 'test'])).toBe(0);
12
- });
13
- });
14
-
15
- describe('isOrdered', () => {
16
- it('should say if array is ordered or not in specific direction', () => {
17
- expect(isOrdered(['example', 'foo', 'test'], 'asc')).toBeTruthy();
18
- expect(isOrdered(['example'], 'asc')).toBeTruthy();
19
- expect(isOrdered(['test', 'foo', 'example'], 'desc')).toBeTruthy();
20
- expect(isOrdered(['example'], 'desc')).toBeTruthy();
21
- expect(isOrdered(['example', 'test', 'foo'], 'asc')).toBeFalsy();
22
- expect(isOrdered(['example', 'foo', 'test'], 'desc')).toBeFalsy();
23
- });
24
- });
25
-
26
- describe('buildVisitorObject', () => {
27
- it('should return a consistent visitor structure', () => {
28
- const context = [
29
- {
30
- type: 'Foo',
31
- matchParentKeys: ['test'],
32
- },
33
- {
34
- type: 'Bar',
35
- matchParentKeys: ['test'],
36
- },
37
- {
38
- type: 'Roof',
39
- matchParentKeys: ['test'],
40
- },
41
- ];
42
-
43
- const visitors = buildVisitorObject('Bar', context, () => {}) as any;
44
-
45
- expect(visitors).toMatchInlineSnapshot(`
46
- Object {
47
- "Foo": Object {
48
- "Bar": Object {
49
- "Roof": Object {
50
- "Bar": [Function],
51
- "skip": [Function],
52
- },
53
- "skip": [Function],
54
- },
55
- "skip": [Function],
56
- },
57
- }
58
- `);
59
- });
60
-
61
- it('should return the right visitor structure', () => {
62
- const context = [
63
- {
64
- type: 'Operation',
65
- matchParentKeys: ['put'],
66
- },
67
- {
68
- type: 'ResponsesMap',
69
- matchParentKeys: [201, 200],
70
- },
71
- ];
72
-
73
- const visitors = buildVisitorObject('MediaTypeMap', context, () => {}) as any;
74
-
75
- expect(visitors).toMatchInlineSnapshot(`
76
- Object {
77
- "Operation": Object {
78
- "ResponsesMap": Object {
79
- "MediaTypeMap": [Function],
80
- "skip": [Function],
81
- },
82
- "skip": [Function],
83
- },
84
- }
85
- `);
86
- });
87
- });
88
- });
89
- });
@@ -1,137 +0,0 @@
1
- import { OrderOptions, OrderDirection, isOrdered, getIntersectionLength } from './utils';
2
-
3
- type Asserts = Record<string, (value: any, condition: any) => boolean>;
4
-
5
- export const runOnKeysSet = new Set([
6
- 'mutuallyExclusive',
7
- 'mutuallyRequired',
8
- 'enum',
9
- 'pattern',
10
- 'minLength',
11
- 'maxLength',
12
- 'casing',
13
- 'sortOrder',
14
- 'disallowed',
15
- 'required',
16
- ]);
17
- export const runOnValuesSet = new Set([
18
- 'pattern',
19
- 'enum',
20
- 'defined',
21
- 'undefined',
22
- 'nonEmpty',
23
- 'minLength',
24
- 'maxLength',
25
- 'casing',
26
- 'sortOrder',
27
- ]);
28
-
29
- export const asserts: Asserts = {
30
- pattern: (value: string | string[], condition: string): boolean => {
31
- if (typeof value === 'undefined') return true; // property doesn't exist, no need to lint it with this assert
32
- const values = typeof value === 'string' ? [value] : value;
33
- const regexOptions = condition.match(/(\b\/\b)(.+)/g) || ['/'];
34
- condition = condition.slice(1).replace(regexOptions[0], '');
35
- const regx = new RegExp(condition, regexOptions[0].slice(1));
36
- for (let _val of values) {
37
- if (!_val.match(regx)) {
38
- return false;
39
- }
40
- }
41
- return true;
42
- },
43
- enum: (value: string | string[], condition: string[]): boolean => {
44
- if (typeof value === 'undefined') return true; // property doesn't exist, no need to lint it with this assert
45
- const values = typeof value === 'string' ? [value] : value;
46
- for (let _val of values) {
47
- if (!condition.includes(_val)) {
48
- return false;
49
- }
50
- }
51
- return true;
52
- },
53
- defined: (value: string | undefined, condition: boolean = true): boolean => {
54
- const isDefined = typeof value !== 'undefined';
55
- return condition ? isDefined : !isDefined;
56
- },
57
- required: (value: string[], keys: string[]): boolean => {
58
- for (const requiredKey of keys) {
59
- if (!value.includes(requiredKey)) {
60
- return false;
61
- }
62
- }
63
- return true;
64
- },
65
- disallowed: (value: string | string[], condition: string[]): boolean => {
66
- if (typeof value === 'undefined') return true; // property doesn't exist, no need to lint it with this assert
67
- const values = typeof value === 'string' ? [value] : value;
68
- for (let _val of values) {
69
- if (condition.includes(_val)) {
70
- return false;
71
- }
72
- }
73
- return true;
74
- },
75
- undefined: (value: any, condition: boolean = true): boolean => {
76
- const isUndefined = typeof value === 'undefined';
77
- return condition ? isUndefined : !isUndefined;
78
- },
79
- nonEmpty: (value: string | undefined | null, condition: boolean = true): boolean => {
80
- const isEmpty = typeof value === 'undefined' || value === null || value === '';
81
- return condition ? !isEmpty : isEmpty;
82
- },
83
- minLength: (value: string | any[], condition: number): boolean => {
84
- if (typeof value === 'undefined') return true; // property doesn't exist, no need to lint it with this assert
85
- return value.length >= condition;
86
- },
87
- maxLength: (value: string | any[], condition: number): boolean => {
88
- if (typeof value === 'undefined') return true; // property doesn't exist, no need to lint it with this assert
89
- return value.length <= condition;
90
- },
91
- casing: (value: string | string[], condition: string): boolean => {
92
- if (typeof value === 'undefined') return true; // property doesn't exist, no need to lint it with this assert
93
- const values = typeof value === 'string' ? [value] : value;
94
- for (let _val of values) {
95
- let matchCase = false;
96
- switch (condition) {
97
- case 'camelCase':
98
- matchCase = !!_val.match(/^[a-z][a-zA-Z0-9]+$/g);
99
- break;
100
- case 'kebab-case':
101
- matchCase = !!_val.match(/^([a-z][a-z0-9]*)(-[a-z0-9]+)*$/g);
102
- break;
103
- case 'snake_case':
104
- matchCase = !!_val.match(/^([a-z][a-z0-9]*)(_[a-z0-9]+)*$/g);
105
- break;
106
- case 'PascalCase':
107
- matchCase = !!_val.match(/^[A-Z][a-zA-Z0-9]+$/g);
108
- break;
109
- case 'MACRO_CASE':
110
- matchCase = !!_val.match(/^([A-Z][A-Z0-9]*)(_[A-Z0-9]+)*$/g);
111
- break;
112
- case 'COBOL-CASE':
113
- matchCase = !!_val.match(/^([A-Z][A-Z0-9]*)(-[A-Z0-9]+)*$/g);
114
- break;
115
- case 'flatcase':
116
- matchCase = !!_val.match(/^[a-z][a-z0-9]+$/g);
117
- break;
118
- }
119
- if (!matchCase) {
120
- return false;
121
- }
122
- }
123
- return true;
124
- },
125
- sortOrder: (value: any[], condition: OrderOptions | OrderDirection): boolean => {
126
- if (typeof value === 'undefined') return true;
127
- return isOrdered(value, condition);
128
- },
129
- mutuallyExclusive: (value: string[], condition: string[]): boolean => {
130
- return getIntersectionLength(value, condition) < 2;
131
- },
132
- mutuallyRequired: (value: string[], condition: string[]): boolean => {
133
- return getIntersectionLength(value, condition) > 0
134
- ? getIntersectionLength(value, condition) === condition.length
135
- : true;
136
- },
137
- };
@@ -1,75 +0,0 @@
1
- import { asserts, runOnKeysSet, runOnValuesSet } from './asserts';
2
- import { AssertToApply, buildSubjectVisitor, buildVisitorObject } from './utils';
3
- import { Oas2Rule, Oas3Rule } from '../../../visitors';
4
-
5
- export const Assertions: Oas3Rule | Oas2Rule = (opts: object) => {
6
- let visitors: any[] = [];
7
-
8
- // As 'Assertions' has an array of asserts,
9
- // that array spreads into an 'opts' object on init rules phase here
10
- // https://github.com/Redocly/redocly-cli/blob/master/packages/core/src/config/config.ts#L311
11
- // that is why we need to iterate through 'opts' values;
12
- // before - filter only object 'opts' values
13
- const assertions: any[] = Object.values(opts).filter(
14
- (opt: unknown) => typeof opt === 'object' && opt !== null,
15
- );
16
-
17
- for (const [index, assertion] of assertions.entries()) {
18
- const assertId =
19
- (assertion.assertionId && `${assertion.assertionId} assertion`) || `assertion #${index + 1}`;
20
-
21
- if (!assertion.subject) {
22
- throw new Error(`${assertId}: 'subject' is required`);
23
- }
24
-
25
- const subjects: string[] = Array.isArray(assertion.subject)
26
- ? assertion.subject
27
- : [assertion.subject];
28
-
29
- const assertsToApply: AssertToApply[] = Object.keys(asserts)
30
- .filter((assertName: string) => assertion[assertName] !== undefined)
31
- .map((assertName: string) => {
32
- return {
33
- assertId,
34
- name: assertName,
35
- conditions: assertion[assertName],
36
- message: assertion.message,
37
- severity: assertion.severity || 'error',
38
- suggest: assertion.suggest || [],
39
- runsOnKeys: runOnKeysSet.has(assertName),
40
- runsOnValues: runOnValuesSet.has(assertName),
41
- };
42
- });
43
-
44
- const shouldRunOnKeys: AssertToApply | undefined = assertsToApply.find(
45
- (assert: AssertToApply) => assert.runsOnKeys && !assert.runsOnValues,
46
- );
47
- const shouldRunOnValues: AssertToApply | undefined = assertsToApply.find(
48
- (assert: AssertToApply) => assert.runsOnValues && !assert.runsOnKeys,
49
- );
50
-
51
- if (shouldRunOnValues && !assertion.property) {
52
- throw new Error(
53
- `${shouldRunOnValues.name} can't be used on all keys. Please provide a single property.`,
54
- );
55
- }
56
-
57
- if (shouldRunOnKeys && assertion.property) {
58
- throw new Error(
59
- `${shouldRunOnKeys.name} can't be used on a single property. Please use 'property'.`,
60
- );
61
- }
62
-
63
- for (const subject of subjects) {
64
- const subjectVisitor = buildSubjectVisitor(
65
- assertion.property,
66
- assertsToApply,
67
- assertion.context,
68
- );
69
- const visitorObject = buildVisitorObject(subject, assertion.context, subjectVisitor);
70
- visitors.push(visitorObject);
71
- }
72
- }
73
-
74
- return visitors;
75
- };