@redocly/openapi-core 1.0.0-beta.100
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -0
- package/__tests__/utils.ts +86 -0
- package/lib/benchmark/benches/lint-with-many-rules.bench.d.ts +3 -0
- package/lib/benchmark/benches/lint-with-many-rules.bench.js +34 -0
- package/lib/benchmark/benches/lint-with-nested-rule.bench.d.ts +3 -0
- package/lib/benchmark/benches/lint-with-nested-rule.bench.js +40 -0
- package/lib/benchmark/benches/lint-with-no-rules.bench.d.ts +3 -0
- package/lib/benchmark/benches/lint-with-no-rules.bench.js +21 -0
- package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.d.ts +3 -0
- package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.js +34 -0
- package/lib/benchmark/benches/lint-with-top-level-rule.bench.d.ts +3 -0
- package/lib/benchmark/benches/lint-with-top-level-rule.bench.js +32 -0
- package/lib/benchmark/benches/recommended-oas3.bench.d.ts +3 -0
- package/lib/benchmark/benches/recommended-oas3.bench.js +21 -0
- package/lib/benchmark/benches/resolve-with-no-external.bench.d.ts +3 -0
- package/lib/benchmark/benches/resolve-with-no-external.bench.js +22 -0
- package/lib/benchmark/utils.d.ts +6 -0
- package/lib/benchmark/utils.js +31 -0
- package/lib/bundle.d.ts +47 -0
- package/lib/bundle.js +291 -0
- package/lib/config/all.d.ts +3 -0
- package/lib/config/all.js +65 -0
- package/lib/config/builtIn.d.ts +3 -0
- package/lib/config/builtIn.js +36 -0
- package/lib/config/config-resolvers.d.ts +16 -0
- package/lib/config/config-resolvers.js +242 -0
- package/lib/config/config.d.ts +64 -0
- package/lib/config/config.js +244 -0
- package/lib/config/index.d.ts +7 -0
- package/lib/config/index.js +19 -0
- package/lib/config/load.d.ts +6 -0
- package/lib/config/load.js +93 -0
- package/lib/config/minimal.d.ts +3 -0
- package/lib/config/minimal.js +58 -0
- package/lib/config/recommended.d.ts +3 -0
- package/lib/config/recommended.js +58 -0
- package/lib/config/rules.d.ts +7 -0
- package/lib/config/rules.js +34 -0
- package/lib/config/types.d.ts +113 -0
- package/lib/config/types.js +2 -0
- package/lib/config/utils.d.ts +13 -0
- package/lib/config/utils.js +160 -0
- package/lib/decorators/common/info-description-override.d.ts +2 -0
- package/lib/decorators/common/info-description-override.js +24 -0
- package/lib/decorators/common/operation-description-override.d.ts +2 -0
- package/lib/decorators/common/operation-description-override.js +29 -0
- package/lib/decorators/common/registry-dependencies.d.ts +2 -0
- package/lib/decorators/common/registry-dependencies.js +24 -0
- package/lib/decorators/common/remove-x-internal.d.ts +2 -0
- package/lib/decorators/common/remove-x-internal.js +58 -0
- package/lib/decorators/common/tag-description-override.d.ts +2 -0
- package/lib/decorators/common/tag-description-override.js +25 -0
- package/lib/decorators/oas2/index.d.ts +8 -0
- package/lib/decorators/oas2/index.js +15 -0
- package/lib/decorators/oas3/index.d.ts +8 -0
- package/lib/decorators/oas3/index.js +15 -0
- package/lib/format/codeframes.d.ts +22 -0
- package/lib/format/codeframes.js +177 -0
- package/lib/format/format.d.ts +20 -0
- package/lib/format/format.js +236 -0
- package/lib/index.d.ts +22 -0
- package/lib/index.js +69 -0
- package/lib/js-yaml/index.d.ts +3 -0
- package/lib/js-yaml/index.js +19 -0
- package/lib/lint.d.ts +23 -0
- package/lib/lint.js +99 -0
- package/lib/oas-types.d.ts +19 -0
- package/lib/oas-types.js +45 -0
- package/lib/redocly/index.d.ts +30 -0
- package/lib/redocly/index.js +153 -0
- package/lib/redocly/redocly-client-types.d.ts +8 -0
- package/lib/redocly/redocly-client-types.js +2 -0
- package/lib/redocly/registry-api-types.d.ts +29 -0
- package/lib/redocly/registry-api-types.js +2 -0
- package/lib/redocly/registry-api.d.ts +17 -0
- package/lib/redocly/registry-api.js +106 -0
- package/lib/ref-utils.d.ts +25 -0
- package/lib/ref-utils.js +75 -0
- package/lib/resolve.d.ts +66 -0
- package/lib/resolve.js +311 -0
- package/lib/rules/ajv.d.ts +10 -0
- package/lib/rules/ajv.js +80 -0
- package/lib/rules/common/assertions/asserts.d.ts +5 -0
- package/lib/rules/common/assertions/asserts.js +143 -0
- package/lib/rules/common/assertions/index.d.ts +2 -0
- package/lib/rules/common/assertions/index.js +52 -0
- package/lib/rules/common/assertions/utils.d.ts +20 -0
- package/lib/rules/common/assertions/utils.js +127 -0
- package/lib/rules/common/info-contact.d.ts +2 -0
- package/lib/rules/common/info-contact.js +17 -0
- package/lib/rules/common/info-description.d.ts +2 -0
- package/lib/rules/common/info-description.js +12 -0
- package/lib/rules/common/info-license-url.d.ts +2 -0
- package/lib/rules/common/info-license-url.js +17 -0
- package/lib/rules/common/license-url.d.ts +2 -0
- package/lib/rules/common/license-url.js +12 -0
- package/lib/rules/common/no-ambiguous-paths.d.ts +2 -0
- package/lib/rules/common/no-ambiguous-paths.js +45 -0
- package/lib/rules/common/no-enum-type-mismatch.d.ts +2 -0
- package/lib/rules/common/no-enum-type-mismatch.js +43 -0
- package/lib/rules/common/no-http-verbs-in-paths.d.ts +2 -0
- package/lib/rules/common/no-http-verbs-in-paths.js +33 -0
- package/lib/rules/common/no-identical-paths.d.ts +2 -0
- package/lib/rules/common/no-identical-paths.js +24 -0
- package/lib/rules/common/no-invalid-parameter-examples.d.ts +1 -0
- package/lib/rules/common/no-invalid-parameter-examples.js +25 -0
- package/lib/rules/common/no-invalid-schema-examples.d.ts +1 -0
- package/lib/rules/common/no-invalid-schema-examples.js +23 -0
- package/lib/rules/common/no-path-trailing-slash.d.ts +2 -0
- package/lib/rules/common/no-path-trailing-slash.js +16 -0
- package/lib/rules/common/operation-2xx-response.d.ts +2 -0
- package/lib/rules/common/operation-2xx-response.js +17 -0
- package/lib/rules/common/operation-4xx-response.d.ts +2 -0
- package/lib/rules/common/operation-4xx-response.js +17 -0
- package/lib/rules/common/operation-description.d.ts +2 -0
- package/lib/rules/common/operation-description.js +12 -0
- package/lib/rules/common/operation-operationId-unique.d.ts +2 -0
- package/lib/rules/common/operation-operationId-unique.js +20 -0
- package/lib/rules/common/operation-operationId-url-safe.d.ts +2 -0
- package/lib/rules/common/operation-operationId-url-safe.js +17 -0
- package/lib/rules/common/operation-operationId.d.ts +2 -0
- package/lib/rules/common/operation-operationId.js +16 -0
- package/lib/rules/common/operation-parameters-unique.d.ts +2 -0
- package/lib/rules/common/operation-parameters-unique.js +40 -0
- package/lib/rules/common/operation-security-defined.d.ts +2 -0
- package/lib/rules/common/operation-security-defined.js +38 -0
- package/lib/rules/common/operation-singular-tag.d.ts +2 -0
- package/lib/rules/common/operation-singular-tag.js +16 -0
- package/lib/rules/common/operation-summary.d.ts +2 -0
- package/lib/rules/common/operation-summary.js +12 -0
- package/lib/rules/common/operation-tag-defined.d.ts +2 -0
- package/lib/rules/common/operation-tag-defined.js +25 -0
- package/lib/rules/common/parameter-description.d.ts +2 -0
- package/lib/rules/common/parameter-description.js +22 -0
- package/lib/rules/common/path-declaration-must-exist.d.ts +2 -0
- package/lib/rules/common/path-declaration-must-exist.js +16 -0
- package/lib/rules/common/path-excludes-patterns.d.ts +2 -0
- package/lib/rules/common/path-excludes-patterns.js +22 -0
- package/lib/rules/common/path-http-verbs-order.d.ts +2 -0
- package/lib/rules/common/path-http-verbs-order.js +26 -0
- package/lib/rules/common/path-not-include-query.d.ts +2 -0
- package/lib/rules/common/path-not-include-query.js +18 -0
- package/lib/rules/common/path-params-defined.d.ts +2 -0
- package/lib/rules/common/path-params-defined.js +53 -0
- package/lib/rules/common/path-segment-plural.d.ts +2 -0
- package/lib/rules/common/path-segment-plural.js +32 -0
- package/lib/rules/common/paths-kebab-case.d.ts +2 -0
- package/lib/rules/common/paths-kebab-case.js +17 -0
- package/lib/rules/common/response-contains-header.d.ts +2 -0
- package/lib/rules/common/response-contains-header.js +29 -0
- package/lib/rules/common/scalar-property-missing-example.d.ts +2 -0
- package/lib/rules/common/scalar-property-missing-example.js +42 -0
- package/lib/rules/common/spec.d.ts +2 -0
- package/lib/rules/common/spec.js +136 -0
- package/lib/rules/common/tag-description.d.ts +2 -0
- package/lib/rules/common/tag-description.js +12 -0
- package/lib/rules/common/tags-alphabetical.d.ts +2 -0
- package/lib/rules/common/tags-alphabetical.js +20 -0
- package/lib/rules/no-unresolved-refs.d.ts +5 -0
- package/lib/rules/no-unresolved-refs.js +47 -0
- package/lib/rules/oas2/boolean-parameter-prefixes.d.ts +5 -0
- package/lib/rules/oas2/boolean-parameter-prefixes.js +22 -0
- package/lib/rules/oas2/index.d.ts +46 -0
- package/lib/rules/oas2/index.js +89 -0
- package/lib/rules/oas2/remove-unused-components.d.ts +2 -0
- package/lib/rules/oas2/remove-unused-components.js +73 -0
- package/lib/rules/oas2/request-mime-type.d.ts +2 -0
- package/lib/rules/oas2/request-mime-type.js +17 -0
- package/lib/rules/oas2/response-contains-property.d.ts +2 -0
- package/lib/rules/oas2/response-contains-property.js +38 -0
- package/lib/rules/oas2/response-mime-type.d.ts +2 -0
- package/lib/rules/oas2/response-mime-type.js +17 -0
- package/lib/rules/oas3/boolean-parameter-prefixes.d.ts +5 -0
- package/lib/rules/oas3/boolean-parameter-prefixes.js +24 -0
- package/lib/rules/oas3/index.d.ts +3 -0
- package/lib/rules/oas3/index.js +105 -0
- package/lib/rules/oas3/no-empty-servers.d.ts +2 -0
- package/lib/rules/oas3/no-empty-servers.js +23 -0
- package/lib/rules/oas3/no-example-value-and-externalValue.d.ts +2 -0
- package/lib/rules/oas3/no-example-value-and-externalValue.js +16 -0
- package/lib/rules/oas3/no-invalid-media-type-examples.d.ts +2 -0
- package/lib/rules/oas3/no-invalid-media-type-examples.js +37 -0
- package/lib/rules/oas3/no-server-example.com.d.ts +2 -0
- package/lib/rules/oas3/no-server-example.com.js +16 -0
- package/lib/rules/oas3/no-server-trailing-slash.d.ts +2 -0
- package/lib/rules/oas3/no-server-trailing-slash.js +18 -0
- package/lib/rules/oas3/no-servers-empty-enum.d.ts +2 -0
- package/lib/rules/oas3/no-servers-empty-enum.js +67 -0
- package/lib/rules/oas3/no-undefined-server-variable.d.ts +2 -0
- package/lib/rules/oas3/no-undefined-server-variable.js +32 -0
- package/lib/rules/oas3/no-unused-components.d.ts +2 -0
- package/lib/rules/oas3/no-unused-components.js +74 -0
- package/lib/rules/oas3/remove-unused-components.d.ts +2 -0
- package/lib/rules/oas3/remove-unused-components.js +83 -0
- package/lib/rules/oas3/request-mime-type.d.ts +2 -0
- package/lib/rules/oas3/request-mime-type.js +31 -0
- package/lib/rules/oas3/response-contains-property.d.ts +2 -0
- package/lib/rules/oas3/response-contains-property.js +40 -0
- package/lib/rules/oas3/response-mime-type.d.ts +2 -0
- package/lib/rules/oas3/response-mime-type.js +31 -0
- package/lib/rules/other/stats.d.ts +41 -0
- package/lib/rules/other/stats.js +44 -0
- package/lib/rules/utils.d.ts +17 -0
- package/lib/rules/utils.js +107 -0
- package/lib/types/index.d.ts +56 -0
- package/lib/types/index.js +77 -0
- package/lib/types/oas2.d.ts +2 -0
- package/lib/types/oas2.js +380 -0
- package/lib/types/oas3.d.ts +2 -0
- package/lib/types/oas3.js +479 -0
- package/lib/types/oas3_1.d.ts +2 -0
- package/lib/types/oas3_1.js +247 -0
- package/lib/types/redocly-yaml.d.ts +2 -0
- package/lib/types/redocly-yaml.js +533 -0
- package/lib/typings/common.d.ts +8 -0
- package/lib/typings/common.js +2 -0
- package/lib/typings/openapi.d.ts +299 -0
- package/lib/typings/openapi.js +2 -0
- package/lib/typings/swagger.d.ts +217 -0
- package/lib/typings/swagger.js +2 -0
- package/lib/utils.d.ts +41 -0
- package/lib/utils.js +177 -0
- package/lib/visitors.d.ts +175 -0
- package/lib/visitors.js +140 -0
- package/lib/walk.d.ts +87 -0
- package/lib/walk.js +253 -0
- package/package.json +56 -0
- package/src/__tests__/__snapshots__/bundle.test.ts.snap +255 -0
- package/src/__tests__/bundle.test.ts +156 -0
- package/src/__tests__/codeframes.test.ts +531 -0
- package/src/__tests__/fixtures/extension.js +24 -0
- package/src/__tests__/fixtures/refs/definitions.yaml +3 -0
- package/src/__tests__/fixtures/refs/examples.yaml +8 -0
- package/src/__tests__/fixtures/refs/external-request-body.yaml +13 -0
- package/src/__tests__/fixtures/refs/externalref.yaml +35 -0
- package/src/__tests__/fixtures/refs/hosted.yaml +35 -0
- package/src/__tests__/fixtures/refs/openapi-with-external-refs-conflicting-names.yaml +21 -0
- package/src/__tests__/fixtures/refs/openapi-with-external-refs.yaml +33 -0
- package/src/__tests__/fixtures/refs/openapi-with-url-refs.yaml +18 -0
- package/src/__tests__/fixtures/refs/param-b.yaml +1 -0
- package/src/__tests__/fixtures/refs/param-c.yaml +1 -0
- package/src/__tests__/fixtures/refs/rename.yaml +1 -0
- package/src/__tests__/fixtures/refs/requestBody.yaml +9 -0
- package/src/__tests__/fixtures/refs/schema-a.yaml +1 -0
- package/src/__tests__/fixtures/refs/simple.yaml +1 -0
- package/src/__tests__/fixtures/refs/vendor.schema.yaml +20 -0
- package/src/__tests__/fixtures/resolve/External.yaml +10 -0
- package/src/__tests__/fixtures/resolve/External2.yaml +4 -0
- package/src/__tests__/fixtures/resolve/description.md +3 -0
- package/src/__tests__/fixtures/resolve/externalInfo.yaml +4 -0
- package/src/__tests__/fixtures/resolve/externalLicense.yaml +1 -0
- package/src/__tests__/fixtures/resolve/openapi-with-back.yaml +13 -0
- package/src/__tests__/fixtures/resolve/openapi-with-md-description.yaml +5 -0
- package/src/__tests__/fixtures/resolve/openapi.yaml +28 -0
- package/src/__tests__/fixtures/resolve/schemas/type-a.yaml +10 -0
- package/src/__tests__/fixtures/resolve/schemas/type-b.yaml +6 -0
- package/src/__tests__/fixtures/resolve/transitive/a.yaml +1 -0
- package/src/__tests__/fixtures/resolve/transitive/components.yaml +5 -0
- package/src/__tests__/fixtures/resolve/transitive/schemas.yaml +3 -0
- package/src/__tests__/js-yaml.test.ts +71 -0
- package/src/__tests__/lint.test.ts +232 -0
- package/src/__tests__/login.test.ts +17 -0
- package/src/__tests__/normalizeVisitors.test.ts +151 -0
- package/src/__tests__/ref-utils.test.ts +120 -0
- package/src/__tests__/resolve-http.test.ts +77 -0
- package/src/__tests__/resolve.test.ts +405 -0
- package/src/__tests__/utils.test.ts +85 -0
- package/src/__tests__/walk.test.ts +1485 -0
- package/src/benchmark/benches/lint-with-many-rules.bench.ts +35 -0
- package/src/benchmark/benches/lint-with-nested-rule.bench.ts +39 -0
- package/src/benchmark/benches/lint-with-no-rules.bench.ts +20 -0
- package/src/benchmark/benches/lint-with-top-level-rule-report.bench.ts +36 -0
- package/src/benchmark/benches/lint-with-top-level-rule.bench.ts +32 -0
- package/src/benchmark/benches/rebilly.yaml +32267 -0
- package/src/benchmark/benches/recommended-oas3.bench.ts +22 -0
- package/src/benchmark/benches/resolve-with-no-external.bench.ts +23 -0
- package/src/benchmark/benchmark.js +307 -0
- package/src/benchmark/colors.js +29 -0
- package/src/benchmark/fork.js +83 -0
- package/src/benchmark/utils.ts +36 -0
- package/src/bundle.ts +386 -0
- package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap +157 -0
- package/src/config/__tests__/config-resolvers.test.ts +429 -0
- package/src/config/__tests__/config.test.ts +244 -0
- package/src/config/__tests__/fixtures/plugin-config.yaml +3 -0
- package/src/config/__tests__/fixtures/plugin.js +56 -0
- package/src/config/__tests__/fixtures/resolve-config/api/nested-config.yaml +12 -0
- package/src/config/__tests__/fixtures/resolve-config/api/plugin.js +67 -0
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-circular.yaml +8 -0
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-file.yaml +19 -0
- package/src/config/__tests__/fixtures/resolve-config/local-config.yaml +10 -0
- package/src/config/__tests__/fixtures/resolve-config/plugin.js +66 -0
- package/src/config/__tests__/fixtures/resolve-remote-configs/nested-remote-config.yaml +4 -0
- package/src/config/__tests__/fixtures/resolve-remote-configs/remote-config.yaml +5 -0
- package/src/config/__tests__/load.test.ts +83 -0
- package/src/config/__tests__/resolve-plugins.test.ts +27 -0
- package/src/config/all.ts +66 -0
- package/src/config/builtIn.ts +37 -0
- package/src/config/config-resolvers.ts +359 -0
- package/src/config/config.ts +312 -0
- package/src/config/index.ts +7 -0
- package/src/config/load.ts +84 -0
- package/src/config/minimal.ts +58 -0
- package/src/config/recommended.ts +58 -0
- package/src/config/rules.ts +46 -0
- package/src/config/types.ts +168 -0
- package/src/config/utils.ts +208 -0
- package/src/decorators/__tests__/remove-x-internal.test.ts +316 -0
- package/src/decorators/common/info-description-override.ts +24 -0
- package/src/decorators/common/operation-description-override.ts +30 -0
- package/src/decorators/common/registry-dependencies.ts +25 -0
- package/src/decorators/common/remove-x-internal.ts +59 -0
- package/src/decorators/common/tag-description-override.ts +25 -0
- package/src/decorators/oas2/index.ts +14 -0
- package/src/decorators/oas3/index.ts +14 -0
- package/src/format/codeframes.ts +210 -0
- package/src/format/format.ts +339 -0
- package/src/index.ts +68 -0
- package/src/js-yaml/index.ts +18 -0
- package/src/lint.ts +125 -0
- package/src/oas-types.ts +62 -0
- package/src/redocly/__tests__/redocly-client.test.ts +140 -0
- package/src/redocly/index.ts +182 -0
- package/src/redocly/redocly-client-types.ts +10 -0
- package/src/redocly/registry-api-types.ts +32 -0
- package/src/redocly/registry-api.ts +134 -0
- package/src/ref-utils.ts +80 -0
- package/src/resolve.ts +378 -0
- package/src/rules/__tests__/fixtures/invalid-yaml.yaml +1 -0
- package/src/rules/__tests__/fixtures/ref.yaml +1 -0
- package/src/rules/__tests__/no-unresolved-refs.test.ts +168 -0
- package/src/rules/ajv.ts +103 -0
- package/src/rules/common/__tests__/info-description.test.ts +102 -0
- package/src/rules/common/__tests__/info-license.test.ts +62 -0
- package/src/rules/common/__tests__/license-url.test.ts +63 -0
- package/src/rules/common/__tests__/no-ambiguous-paths.test.ts +96 -0
- package/src/rules/common/__tests__/no-enum-type-mismatch.test.ts +209 -0
- package/src/rules/common/__tests__/no-identical-paths.test.ts +58 -0
- package/src/rules/common/__tests__/no-path-trailing-slash.test.ts +85 -0
- package/src/rules/common/__tests__/operation-2xx-response.test.ts +91 -0
- package/src/rules/common/__tests__/operation-4xx-response.test.ts +107 -0
- package/src/rules/common/__tests__/operation-operationId-unique.test.ts +76 -0
- package/src/rules/common/__tests__/operation-operationId-url-safe.test.ts +45 -0
- package/src/rules/common/__tests__/operation-parameters-unique.test.ts +167 -0
- package/src/rules/common/__tests__/operation-security-defined.test.ts +69 -0
- package/src/rules/common/__tests__/operation-singular-tag.test.ts +72 -0
- package/src/rules/common/__tests__/path-http-verbs-order.test.ts +95 -0
- package/src/rules/common/__tests__/path-not-include-query.test.ts +64 -0
- package/src/rules/common/__tests__/path-params-defined.test.ts +133 -0
- package/src/rules/common/__tests__/paths-kebab-case.test.ts +108 -0
- package/src/rules/common/__tests__/scalar-property-missing-example.test.ts +264 -0
- package/src/rules/common/__tests__/spec.test.ts +62 -0
- package/src/rules/common/__tests__/tag-description.test.ts +65 -0
- package/src/rules/common/__tests__/tags-alphabetical.test.ts +64 -0
- package/src/rules/common/assertions/__tests__/asserts.test.ts +231 -0
- package/src/rules/common/assertions/__tests__/index.test.ts +65 -0
- package/src/rules/common/assertions/__tests__/utils.test.ts +89 -0
- package/src/rules/common/assertions/asserts.ts +137 -0
- package/src/rules/common/assertions/index.ts +75 -0
- package/src/rules/common/assertions/utils.ts +167 -0
- package/src/rules/common/info-contact.ts +15 -0
- package/src/rules/common/info-description.ts +10 -0
- package/src/rules/common/info-license-url.ts +15 -0
- package/src/rules/common/license-url.ts +10 -0
- package/src/rules/common/no-ambiguous-paths.ts +50 -0
- package/src/rules/common/no-enum-type-mismatch.ts +49 -0
- package/src/rules/common/no-http-verbs-in-paths.ts +36 -0
- package/src/rules/common/no-identical-paths.ts +24 -0
- package/src/rules/common/no-invalid-parameter-examples.ts +36 -0
- package/src/rules/common/no-invalid-schema-examples.ts +27 -0
- package/src/rules/common/no-path-trailing-slash.ts +15 -0
- package/src/rules/common/operation-2xx-response.ts +16 -0
- package/src/rules/common/operation-4xx-response.ts +17 -0
- package/src/rules/common/operation-description.ts +13 -0
- package/src/rules/common/operation-operationId-unique.ts +21 -0
- package/src/rules/common/operation-operationId-url-safe.ts +19 -0
- package/src/rules/common/operation-operationId.ts +17 -0
- package/src/rules/common/operation-parameters-unique.ts +48 -0
- package/src/rules/common/operation-security-defined.ts +45 -0
- package/src/rules/common/operation-singular-tag.ts +17 -0
- package/src/rules/common/operation-summary.ts +13 -0
- package/src/rules/common/operation-tag-defined.ts +26 -0
- package/src/rules/common/parameter-description.ts +22 -0
- package/src/rules/common/path-declaration-must-exist.ts +15 -0
- package/src/rules/common/path-excludes-patterns.ts +23 -0
- package/src/rules/common/path-http-verbs-order.ts +30 -0
- package/src/rules/common/path-not-include-query.ts +17 -0
- package/src/rules/common/path-params-defined.ts +58 -0
- package/src/rules/common/path-segment-plural.ts +31 -0
- package/src/rules/common/paths-kebab-case.ts +16 -0
- package/src/rules/common/response-contains-header.ts +30 -0
- package/src/rules/common/scalar-property-missing-example.ts +58 -0
- package/src/rules/common/spec.ts +143 -0
- package/src/rules/common/tag-description.ts +10 -0
- package/src/rules/common/tags-alphabetical.ts +20 -0
- package/src/rules/no-unresolved-refs.ts +51 -0
- package/src/rules/oas2/__tests__/boolean-parameter-prefixes.test.ts +110 -0
- package/src/rules/oas2/__tests__/response-contains-header.test.ts +174 -0
- package/src/rules/oas2/__tests__/response-contains-property.test.ts +155 -0
- package/src/rules/oas2/__tests__/spec/fixtures/description.md +1 -0
- package/src/rules/oas2/__tests__/spec/info.test.ts +355 -0
- package/src/rules/oas2/__tests__/spec/operation.test.ts +123 -0
- package/src/rules/oas2/__tests__/spec/paths.test.ts +245 -0
- package/src/rules/oas2/__tests__/spec/referenceableScalars.test.ts +31 -0
- package/src/rules/oas2/__tests__/spec/utils.ts +32 -0
- package/src/rules/oas2/boolean-parameter-prefixes.ts +26 -0
- package/src/rules/oas2/index.ts +89 -0
- package/src/rules/oas2/remove-unused-components.ts +76 -0
- package/src/rules/oas2/request-mime-type.ts +17 -0
- package/src/rules/oas2/response-contains-property.ts +36 -0
- package/src/rules/oas2/response-mime-type.ts +17 -0
- package/src/rules/oas3/__tests__/boolean-parameter-prefixes.test.ts +111 -0
- package/src/rules/oas3/__tests__/fixtures/common.yaml +11 -0
- package/src/rules/oas3/__tests__/no-empty-enum-servers.com.test.ts +205 -0
- package/src/rules/oas3/__tests__/no-example-value-and-externalValue.test.ts +65 -0
- package/src/rules/oas3/__tests__/no-invalid-media-type-examples.test.ts +392 -0
- package/src/rules/oas3/__tests__/no-server-example.com.test.ts +60 -0
- package/src/rules/oas3/__tests__/no-server-trailing-slash.test.ts +79 -0
- package/src/rules/oas3/__tests__/no-unused-components.test.ts +131 -0
- package/src/rules/oas3/__tests__/response-contains-header.test.ts +273 -0
- package/src/rules/oas3/__tests__/response-contains-property.test.ts +403 -0
- package/src/rules/oas3/__tests__/spec/callbacks.test.ts +41 -0
- package/src/rules/oas3/__tests__/spec/fixtures/description.md +1 -0
- package/src/rules/oas3/__tests__/spec/info.test.ts +391 -0
- package/src/rules/oas3/__tests__/spec/operation.test.ts +253 -0
- package/src/rules/oas3/__tests__/spec/paths.test.ts +284 -0
- package/src/rules/oas3/__tests__/spec/referenceableScalars.test.ts +77 -0
- package/src/rules/oas3/__tests__/spec/servers.test.ts +499 -0
- package/src/rules/oas3/__tests__/spec/spec.test.ts +288 -0
- package/src/rules/oas3/__tests__/spec/utils.ts +32 -0
- package/src/rules/oas3/boolean-parameter-prefixes.ts +28 -0
- package/src/rules/oas3/index.ts +105 -0
- package/src/rules/oas3/no-empty-servers.ts +22 -0
- package/src/rules/oas3/no-example-value-and-externalValue.ts +14 -0
- package/src/rules/oas3/no-invalid-media-type-examples.ts +41 -0
- package/src/rules/oas3/no-server-example.com.ts +14 -0
- package/src/rules/oas3/no-server-trailing-slash.ts +15 -0
- package/src/rules/oas3/no-servers-empty-enum.ts +67 -0
- package/src/rules/oas3/no-undefined-server-variable.ts +30 -0
- package/src/rules/oas3/no-unused-components.ts +75 -0
- package/src/rules/oas3/remove-unused-components.ts +84 -0
- package/src/rules/oas3/request-mime-type.ts +31 -0
- package/src/rules/oas3/response-contains-property.ts +38 -0
- package/src/rules/oas3/response-mime-type.ts +31 -0
- package/src/rules/other/stats.ts +44 -0
- package/src/rules/utils.ts +123 -0
- package/src/types/index.ts +138 -0
- package/src/types/oas2.ts +397 -0
- package/src/types/oas3.ts +510 -0
- package/src/types/oas3_1.ts +253 -0
- package/src/types/redocly-yaml.ts +647 -0
- package/src/typings/common.ts +9 -0
- package/src/typings/openapi.ts +298 -0
- package/src/typings/swagger.ts +236 -0
- package/src/utils.ts +193 -0
- package/src/visitors.ts +448 -0
- package/src/walk.ts +416 -0
- package/tsconfig.json +8 -0
- package/tsconfig.tsbuildinfo +1 -0
package/lib/resolve.d.ts
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import type { YAMLNode, LoadOptions } from 'yaml-ast-parser';
|
|
2
|
+
import { NormalizedNodeType } from './types';
|
|
3
|
+
import { ResolveConfig } from './config/types';
|
|
4
|
+
export declare type CollectedRefs = Map<string, Document>;
|
|
5
|
+
export declare class Source {
|
|
6
|
+
absoluteRef: string;
|
|
7
|
+
body: string;
|
|
8
|
+
mimeType?: string | undefined;
|
|
9
|
+
constructor(absoluteRef: string, body: string, mimeType?: string | undefined);
|
|
10
|
+
private _ast;
|
|
11
|
+
private _lines;
|
|
12
|
+
getAst(safeLoad: (input: string, options?: LoadOptions | undefined) => YAMLNode): YAMLNode;
|
|
13
|
+
getLines(): string[];
|
|
14
|
+
}
|
|
15
|
+
export declare class ResolveError extends Error {
|
|
16
|
+
originalError: Error;
|
|
17
|
+
constructor(originalError: Error);
|
|
18
|
+
}
|
|
19
|
+
export declare class YamlParseError extends Error {
|
|
20
|
+
originalError: Error;
|
|
21
|
+
source: Source;
|
|
22
|
+
col: number;
|
|
23
|
+
line: number;
|
|
24
|
+
constructor(originalError: Error, source: Source);
|
|
25
|
+
}
|
|
26
|
+
export declare type Document = {
|
|
27
|
+
source: Source;
|
|
28
|
+
parsed: any;
|
|
29
|
+
};
|
|
30
|
+
export declare function makeRefId(absoluteRef: string, pointer: string): string;
|
|
31
|
+
export declare function makeDocumentFromString(sourceString: string, absoluteRef: string): {
|
|
32
|
+
source: Source;
|
|
33
|
+
parsed: unknown;
|
|
34
|
+
};
|
|
35
|
+
export declare class BaseResolver {
|
|
36
|
+
private config;
|
|
37
|
+
cache: Map<string, Promise<Document | ResolveError>>;
|
|
38
|
+
constructor(config?: ResolveConfig);
|
|
39
|
+
getFiles(): Set<string>;
|
|
40
|
+
resolveExternalRef(base: string | null, ref: string): string;
|
|
41
|
+
loadExternalRef(absoluteRef: string): Promise<Source>;
|
|
42
|
+
parseDocument(source: Source, isRoot?: boolean): Document;
|
|
43
|
+
resolveDocument(base: string | null, ref: string, isRoot?: boolean): Promise<Document | ResolveError | YamlParseError>;
|
|
44
|
+
}
|
|
45
|
+
export declare type ResolvedRef = {
|
|
46
|
+
resolved: false;
|
|
47
|
+
isRemote: boolean;
|
|
48
|
+
nodePointer?: string;
|
|
49
|
+
document?: Document;
|
|
50
|
+
source?: Source;
|
|
51
|
+
error?: ResolveError | YamlParseError;
|
|
52
|
+
node?: any;
|
|
53
|
+
} | {
|
|
54
|
+
resolved: true;
|
|
55
|
+
node: any;
|
|
56
|
+
document: Document;
|
|
57
|
+
nodePointer: string;
|
|
58
|
+
isRemote: boolean;
|
|
59
|
+
error?: undefined;
|
|
60
|
+
};
|
|
61
|
+
export declare type ResolvedRefMap = Map<string, ResolvedRef>;
|
|
62
|
+
export declare function resolveDocument(opts: {
|
|
63
|
+
rootDocument: Document;
|
|
64
|
+
externalRefResolver: BaseResolver;
|
|
65
|
+
rootType: NormalizedNodeType;
|
|
66
|
+
}): Promise<ResolvedRefMap>;
|
package/lib/resolve.js
ADDED
|
@@ -0,0 +1,311 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.resolveDocument = exports.BaseResolver = exports.makeDocumentFromString = exports.makeRefId = exports.YamlParseError = exports.ResolveError = exports.Source = void 0;
|
|
13
|
+
const fs = require("fs");
|
|
14
|
+
const path = require("path");
|
|
15
|
+
const ref_utils_1 = require("./ref-utils");
|
|
16
|
+
const types_1 = require("./types");
|
|
17
|
+
const utils_1 = require("./utils");
|
|
18
|
+
class Source {
|
|
19
|
+
constructor(absoluteRef, body, mimeType) {
|
|
20
|
+
this.absoluteRef = absoluteRef;
|
|
21
|
+
this.body = body;
|
|
22
|
+
this.mimeType = mimeType;
|
|
23
|
+
}
|
|
24
|
+
// pass safeLoad as argument to separate it from browser bundle
|
|
25
|
+
getAst(safeLoad) {
|
|
26
|
+
var _a;
|
|
27
|
+
if (this._ast === undefined) {
|
|
28
|
+
this._ast = (_a = safeLoad(this.body, { filename: this.absoluteRef })) !== null && _a !== void 0 ? _a : undefined;
|
|
29
|
+
// fix ast representation of file with newlines only
|
|
30
|
+
if (this._ast &&
|
|
31
|
+
this._ast.kind === 0 && // KIND.scalar = 0
|
|
32
|
+
this._ast.value === '' &&
|
|
33
|
+
this._ast.startPosition !== 1) {
|
|
34
|
+
this._ast.startPosition = 1;
|
|
35
|
+
this._ast.endPosition = 1;
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
return this._ast;
|
|
39
|
+
}
|
|
40
|
+
getLines() {
|
|
41
|
+
if (this._lines === undefined) {
|
|
42
|
+
this._lines = this.body.split(/\r\n|[\n\r]/g);
|
|
43
|
+
}
|
|
44
|
+
return this._lines;
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
exports.Source = Source;
|
|
48
|
+
class ResolveError extends Error {
|
|
49
|
+
constructor(originalError) {
|
|
50
|
+
super(originalError.message);
|
|
51
|
+
this.originalError = originalError;
|
|
52
|
+
// Set the prototype explicitly.
|
|
53
|
+
Object.setPrototypeOf(this, ResolveError.prototype);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
exports.ResolveError = ResolveError;
|
|
57
|
+
const jsYamlErrorLineColRegexp = /\((\d+):(\d+)\)$/;
|
|
58
|
+
class YamlParseError extends Error {
|
|
59
|
+
constructor(originalError, source) {
|
|
60
|
+
super(originalError.message.split('\n')[0]);
|
|
61
|
+
this.originalError = originalError;
|
|
62
|
+
this.source = source;
|
|
63
|
+
// Set the prototype explicitly.
|
|
64
|
+
Object.setPrototypeOf(this, YamlParseError.prototype);
|
|
65
|
+
const [, line, col] = this.message.match(jsYamlErrorLineColRegexp) || [];
|
|
66
|
+
this.line = parseInt(line, 10);
|
|
67
|
+
this.col = parseInt(col, 10);
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
exports.YamlParseError = YamlParseError;
|
|
71
|
+
function makeRefId(absoluteRef, pointer) {
|
|
72
|
+
return absoluteRef + '::' + pointer;
|
|
73
|
+
}
|
|
74
|
+
exports.makeRefId = makeRefId;
|
|
75
|
+
function makeDocumentFromString(sourceString, absoluteRef) {
|
|
76
|
+
const source = new Source(absoluteRef, sourceString);
|
|
77
|
+
try {
|
|
78
|
+
return {
|
|
79
|
+
source,
|
|
80
|
+
parsed: utils_1.parseYaml(sourceString, { filename: absoluteRef }),
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
catch (e) {
|
|
84
|
+
throw new YamlParseError(e, source);
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
exports.makeDocumentFromString = makeDocumentFromString;
|
|
88
|
+
class BaseResolver {
|
|
89
|
+
constructor(config = { http: { headers: [] } }) {
|
|
90
|
+
this.config = config;
|
|
91
|
+
this.cache = new Map();
|
|
92
|
+
}
|
|
93
|
+
getFiles() {
|
|
94
|
+
return new Set(Array.from(this.cache.keys()));
|
|
95
|
+
}
|
|
96
|
+
resolveExternalRef(base, ref) {
|
|
97
|
+
if (ref_utils_1.isAbsoluteUrl(ref)) {
|
|
98
|
+
return ref;
|
|
99
|
+
}
|
|
100
|
+
if (base && ref_utils_1.isAbsoluteUrl(base)) {
|
|
101
|
+
return new URL(ref, base).href;
|
|
102
|
+
}
|
|
103
|
+
return path.resolve(base ? path.dirname(base) : process.cwd(), ref);
|
|
104
|
+
}
|
|
105
|
+
loadExternalRef(absoluteRef) {
|
|
106
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107
|
+
try {
|
|
108
|
+
if (ref_utils_1.isAbsoluteUrl(absoluteRef)) {
|
|
109
|
+
const { body, mimeType } = yield utils_1.readFileFromUrl(absoluteRef, this.config.http);
|
|
110
|
+
return new Source(absoluteRef, body, mimeType);
|
|
111
|
+
}
|
|
112
|
+
else {
|
|
113
|
+
return new Source(absoluteRef, yield fs.promises.readFile(absoluteRef, 'utf-8'));
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
catch (error) {
|
|
117
|
+
throw new ResolveError(error);
|
|
118
|
+
}
|
|
119
|
+
});
|
|
120
|
+
}
|
|
121
|
+
parseDocument(source, isRoot = false) {
|
|
122
|
+
var _a;
|
|
123
|
+
const ext = source.absoluteRef.substr(source.absoluteRef.lastIndexOf('.'));
|
|
124
|
+
if (!['.json', '.json', '.yml', '.yaml'].includes(ext) &&
|
|
125
|
+
!((_a = source.mimeType) === null || _a === void 0 ? void 0 : _a.match(/(json|yaml|openapi)/)) &&
|
|
126
|
+
!isRoot // always parse root
|
|
127
|
+
) {
|
|
128
|
+
return { source, parsed: source.body };
|
|
129
|
+
}
|
|
130
|
+
try {
|
|
131
|
+
return {
|
|
132
|
+
source,
|
|
133
|
+
parsed: utils_1.parseYaml(source.body, { filename: source.absoluteRef }),
|
|
134
|
+
};
|
|
135
|
+
}
|
|
136
|
+
catch (e) {
|
|
137
|
+
throw new YamlParseError(e, source);
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
resolveDocument(base, ref, isRoot = false) {
|
|
141
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
142
|
+
const absoluteRef = this.resolveExternalRef(base, ref);
|
|
143
|
+
const cachedDocument = this.cache.get(absoluteRef);
|
|
144
|
+
if (cachedDocument) {
|
|
145
|
+
return cachedDocument;
|
|
146
|
+
}
|
|
147
|
+
const doc = this.loadExternalRef(absoluteRef).then((source) => {
|
|
148
|
+
return this.parseDocument(source, isRoot);
|
|
149
|
+
});
|
|
150
|
+
this.cache.set(absoluteRef, doc);
|
|
151
|
+
return doc;
|
|
152
|
+
});
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
exports.BaseResolver = BaseResolver;
|
|
156
|
+
function pushRef(head, node) {
|
|
157
|
+
return {
|
|
158
|
+
prev: head,
|
|
159
|
+
node,
|
|
160
|
+
};
|
|
161
|
+
}
|
|
162
|
+
function hasRef(head, node) {
|
|
163
|
+
while (head) {
|
|
164
|
+
if (head.node === node) {
|
|
165
|
+
return true;
|
|
166
|
+
}
|
|
167
|
+
head = head.prev;
|
|
168
|
+
}
|
|
169
|
+
return false;
|
|
170
|
+
}
|
|
171
|
+
const unknownType = { name: 'unknown', properties: {} };
|
|
172
|
+
const resolvableScalarType = { name: 'scalar', properties: {} };
|
|
173
|
+
function resolveDocument(opts) {
|
|
174
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
175
|
+
const { rootDocument, externalRefResolver, rootType } = opts;
|
|
176
|
+
const resolvedRefMap = new Map();
|
|
177
|
+
const seedNodes = new Set(); // format "${type}::${absoluteRef}${pointer}"
|
|
178
|
+
const resolvePromises = [];
|
|
179
|
+
resolveRefsInParallel(rootDocument.parsed, rootDocument, '#/', rootType);
|
|
180
|
+
let resolved;
|
|
181
|
+
do {
|
|
182
|
+
resolved = yield Promise.all(resolvePromises);
|
|
183
|
+
} while (resolvePromises.length !== resolved.length);
|
|
184
|
+
return resolvedRefMap;
|
|
185
|
+
function resolveRefsInParallel(rootNode, rootNodeDocument, rootNodePointer, type) {
|
|
186
|
+
const rootNodeDocAbsoluteRef = rootNodeDocument.source.absoluteRef;
|
|
187
|
+
walk(rootNode, type, rootNodeDocAbsoluteRef + rootNodePointer);
|
|
188
|
+
function walk(node, type, nodeAbsoluteRef) {
|
|
189
|
+
if (typeof node !== 'object' || node === null) {
|
|
190
|
+
return;
|
|
191
|
+
}
|
|
192
|
+
const nodeId = `${type.name}::${nodeAbsoluteRef}`;
|
|
193
|
+
if (seedNodes.has(nodeId)) {
|
|
194
|
+
return;
|
|
195
|
+
}
|
|
196
|
+
seedNodes.add(nodeId);
|
|
197
|
+
if (Array.isArray(node)) {
|
|
198
|
+
const itemsType = type.items;
|
|
199
|
+
// we continue resolving unknown types, but stop early on known scalars
|
|
200
|
+
if (type !== unknownType && itemsType === undefined) {
|
|
201
|
+
return;
|
|
202
|
+
}
|
|
203
|
+
for (let i = 0; i < node.length; i++) {
|
|
204
|
+
walk(node[i], itemsType || unknownType, ref_utils_1.joinPointer(nodeAbsoluteRef, i));
|
|
205
|
+
}
|
|
206
|
+
return;
|
|
207
|
+
}
|
|
208
|
+
for (const propName of Object.keys(node)) {
|
|
209
|
+
let propValue = node[propName];
|
|
210
|
+
let propType = type.properties[propName];
|
|
211
|
+
if (propType === undefined)
|
|
212
|
+
propType = type.additionalProperties;
|
|
213
|
+
if (typeof propType === 'function')
|
|
214
|
+
propType = propType(propValue, propName);
|
|
215
|
+
if (propType === undefined)
|
|
216
|
+
propType = unknownType;
|
|
217
|
+
if (!types_1.isNamedType(propType) && (propType === null || propType === void 0 ? void 0 : propType.directResolveAs)) {
|
|
218
|
+
propType = propType.directResolveAs;
|
|
219
|
+
propValue = { $ref: propValue };
|
|
220
|
+
}
|
|
221
|
+
if (propType && propType.name === undefined && propType.resolvable !== false) {
|
|
222
|
+
propType = resolvableScalarType;
|
|
223
|
+
}
|
|
224
|
+
if (!types_1.isNamedType(propType) || typeof propValue !== 'object') {
|
|
225
|
+
continue;
|
|
226
|
+
}
|
|
227
|
+
walk(propValue, propType, ref_utils_1.joinPointer(nodeAbsoluteRef, ref_utils_1.escapePointer(propName)));
|
|
228
|
+
}
|
|
229
|
+
if (ref_utils_1.isRef(node)) {
|
|
230
|
+
const promise = followRef(rootNodeDocument, node, {
|
|
231
|
+
prev: null,
|
|
232
|
+
node,
|
|
233
|
+
}).then((resolvedRef) => {
|
|
234
|
+
if (resolvedRef.resolved) {
|
|
235
|
+
resolveRefsInParallel(resolvedRef.node, resolvedRef.document, resolvedRef.nodePointer, type);
|
|
236
|
+
}
|
|
237
|
+
});
|
|
238
|
+
resolvePromises.push(promise);
|
|
239
|
+
}
|
|
240
|
+
}
|
|
241
|
+
function followRef(document, ref, refStack) {
|
|
242
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
243
|
+
if (hasRef(refStack.prev, ref)) {
|
|
244
|
+
throw new Error('Self-referencing circular pointer');
|
|
245
|
+
}
|
|
246
|
+
const { uri, pointer } = ref_utils_1.parseRef(ref.$ref);
|
|
247
|
+
const isRemote = uri !== null;
|
|
248
|
+
let targetDoc;
|
|
249
|
+
try {
|
|
250
|
+
targetDoc = isRemote
|
|
251
|
+
? (yield externalRefResolver.resolveDocument(document.source.absoluteRef, uri))
|
|
252
|
+
: document;
|
|
253
|
+
}
|
|
254
|
+
catch (error) {
|
|
255
|
+
const resolvedRef = {
|
|
256
|
+
resolved: false,
|
|
257
|
+
isRemote,
|
|
258
|
+
document: undefined,
|
|
259
|
+
error: error,
|
|
260
|
+
};
|
|
261
|
+
const refId = makeRefId(document.source.absoluteRef, ref.$ref);
|
|
262
|
+
resolvedRefMap.set(refId, resolvedRef);
|
|
263
|
+
return resolvedRef;
|
|
264
|
+
}
|
|
265
|
+
let resolvedRef = {
|
|
266
|
+
resolved: true,
|
|
267
|
+
document: targetDoc,
|
|
268
|
+
isRemote,
|
|
269
|
+
node: document.parsed,
|
|
270
|
+
nodePointer: '#/',
|
|
271
|
+
};
|
|
272
|
+
let target = targetDoc.parsed;
|
|
273
|
+
const segments = pointer;
|
|
274
|
+
for (let segment of segments) {
|
|
275
|
+
if (typeof target !== 'object') {
|
|
276
|
+
target = undefined;
|
|
277
|
+
break;
|
|
278
|
+
}
|
|
279
|
+
else if (target[segment] !== undefined) {
|
|
280
|
+
target = target[segment];
|
|
281
|
+
resolvedRef.nodePointer = ref_utils_1.joinPointer(resolvedRef.nodePointer, ref_utils_1.escapePointer(segment));
|
|
282
|
+
}
|
|
283
|
+
else if (ref_utils_1.isRef(target)) {
|
|
284
|
+
resolvedRef = yield followRef(targetDoc, target, pushRef(refStack, target));
|
|
285
|
+
targetDoc = resolvedRef.document || targetDoc;
|
|
286
|
+
if (typeof resolvedRef.node !== 'object') {
|
|
287
|
+
target = undefined;
|
|
288
|
+
break;
|
|
289
|
+
}
|
|
290
|
+
target = resolvedRef.node[segment];
|
|
291
|
+
resolvedRef.nodePointer = ref_utils_1.joinPointer(resolvedRef.nodePointer, ref_utils_1.escapePointer(segment));
|
|
292
|
+
}
|
|
293
|
+
else {
|
|
294
|
+
target = undefined;
|
|
295
|
+
break;
|
|
296
|
+
}
|
|
297
|
+
}
|
|
298
|
+
resolvedRef.node = target;
|
|
299
|
+
resolvedRef.document = targetDoc;
|
|
300
|
+
const refId = makeRefId(document.source.absoluteRef, ref.$ref);
|
|
301
|
+
if (resolvedRef.document && ref_utils_1.isRef(target)) {
|
|
302
|
+
resolvedRef = yield followRef(resolvedRef.document, target, pushRef(refStack, target));
|
|
303
|
+
}
|
|
304
|
+
resolvedRefMap.set(refId, resolvedRef);
|
|
305
|
+
return Object.assign({}, resolvedRef);
|
|
306
|
+
});
|
|
307
|
+
}
|
|
308
|
+
}
|
|
309
|
+
});
|
|
310
|
+
}
|
|
311
|
+
exports.resolveDocument = resolveDocument;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { ErrorObject } from '@redocly/ajv';
|
|
2
|
+
import { Location } from '../ref-utils';
|
|
3
|
+
import { ResolveFn } from '../walk';
|
|
4
|
+
export declare function releaseAjvInstance(): void;
|
|
5
|
+
export declare function validateJsonSchema(data: any, schema: any, schemaLoc: Location, instancePath: string, resolve: ResolveFn<any>, disallowAdditionalProperties: boolean): {
|
|
6
|
+
valid: boolean;
|
|
7
|
+
errors: (ErrorObject & {
|
|
8
|
+
suggest?: string[];
|
|
9
|
+
})[];
|
|
10
|
+
};
|
package/lib/rules/ajv.js
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.validateJsonSchema = exports.releaseAjvInstance = void 0;
|
|
4
|
+
const ajv_1 = require("@redocly/ajv");
|
|
5
|
+
const ref_utils_1 = require("../ref-utils");
|
|
6
|
+
let ajvInstance = null;
|
|
7
|
+
function releaseAjvInstance() {
|
|
8
|
+
ajvInstance = null;
|
|
9
|
+
}
|
|
10
|
+
exports.releaseAjvInstance = releaseAjvInstance;
|
|
11
|
+
function getAjv(resolve, disallowAdditionalProperties) {
|
|
12
|
+
if (!ajvInstance) {
|
|
13
|
+
ajvInstance = new ajv_1.default({
|
|
14
|
+
schemaId: '$id',
|
|
15
|
+
meta: true,
|
|
16
|
+
allErrors: true,
|
|
17
|
+
strictSchema: false,
|
|
18
|
+
inlineRefs: false,
|
|
19
|
+
validateSchema: false,
|
|
20
|
+
discriminator: true,
|
|
21
|
+
allowUnionTypes: true,
|
|
22
|
+
validateFormats: false,
|
|
23
|
+
defaultAdditionalProperties: !disallowAdditionalProperties,
|
|
24
|
+
loadSchemaSync(base, $ref) {
|
|
25
|
+
const resolvedRef = resolve({ $ref }, base.split('#')[0]);
|
|
26
|
+
if (!resolvedRef || !resolvedRef.location)
|
|
27
|
+
return undefined;
|
|
28
|
+
return Object.assign({ $id: resolvedRef.location.absolutePointer }, resolvedRef.node);
|
|
29
|
+
},
|
|
30
|
+
logger: false,
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
return ajvInstance;
|
|
34
|
+
}
|
|
35
|
+
function getAjvValidator(schema, loc, resolve, disallowAdditionalProperties) {
|
|
36
|
+
const ajv = getAjv(resolve, disallowAdditionalProperties);
|
|
37
|
+
if (!ajv.getSchema(loc.absolutePointer)) {
|
|
38
|
+
ajv.addSchema(Object.assign({ $id: loc.absolutePointer }, schema), loc.absolutePointer);
|
|
39
|
+
}
|
|
40
|
+
return ajv.getSchema(loc.absolutePointer);
|
|
41
|
+
}
|
|
42
|
+
function validateJsonSchema(data, schema, schemaLoc, instancePath, resolve, disallowAdditionalProperties) {
|
|
43
|
+
const validate = getAjvValidator(schema, schemaLoc, resolve, disallowAdditionalProperties);
|
|
44
|
+
if (!validate)
|
|
45
|
+
return { valid: true, errors: [] }; // unresolved refs are reported
|
|
46
|
+
const valid = validate(data, {
|
|
47
|
+
instancePath,
|
|
48
|
+
parentData: { fake: {} },
|
|
49
|
+
parentDataProperty: 'fake',
|
|
50
|
+
rootData: {},
|
|
51
|
+
dynamicAnchors: {},
|
|
52
|
+
});
|
|
53
|
+
return {
|
|
54
|
+
valid: !!valid,
|
|
55
|
+
errors: (validate.errors || []).map(beatifyErrorMessage),
|
|
56
|
+
};
|
|
57
|
+
function beatifyErrorMessage(error) {
|
|
58
|
+
let message = error.message;
|
|
59
|
+
let suggest = error.keyword === 'enum' ? error.params.allowedValues : undefined;
|
|
60
|
+
if (suggest) {
|
|
61
|
+
message += ` ${suggest.map((e) => `"${e}"`).join(', ')}`;
|
|
62
|
+
}
|
|
63
|
+
if (error.keyword === 'type') {
|
|
64
|
+
message = `type ${message}`;
|
|
65
|
+
}
|
|
66
|
+
const relativePath = error.instancePath.substring(instancePath.length + 1);
|
|
67
|
+
const propName = relativePath.substring(relativePath.lastIndexOf('/') + 1);
|
|
68
|
+
if (propName) {
|
|
69
|
+
message = `\`${propName}\` property ${message}`;
|
|
70
|
+
}
|
|
71
|
+
if (error.keyword === 'additionalProperties') {
|
|
72
|
+
const property = error.params.additionalProperty;
|
|
73
|
+
message = `${message} \`${property}\``;
|
|
74
|
+
error.instancePath += '/' + ref_utils_1.escapePointer(property);
|
|
75
|
+
}
|
|
76
|
+
return Object.assign(Object.assign({}, error), { message,
|
|
77
|
+
suggest });
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
exports.validateJsonSchema = validateJsonSchema;
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.asserts = exports.runOnValuesSet = exports.runOnKeysSet = void 0;
|
|
4
|
+
const utils_1 = require("./utils");
|
|
5
|
+
exports.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
|
+
exports.runOnValuesSet = new Set([
|
|
18
|
+
'pattern',
|
|
19
|
+
'enum',
|
|
20
|
+
'defined',
|
|
21
|
+
'undefined',
|
|
22
|
+
'nonEmpty',
|
|
23
|
+
'minLength',
|
|
24
|
+
'maxLength',
|
|
25
|
+
'casing',
|
|
26
|
+
'sortOrder',
|
|
27
|
+
]);
|
|
28
|
+
exports.asserts = {
|
|
29
|
+
pattern: (value, condition) => {
|
|
30
|
+
if (typeof value === 'undefined')
|
|
31
|
+
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, condition) => {
|
|
44
|
+
if (typeof value === 'undefined')
|
|
45
|
+
return true; // property doesn't exist, no need to lint it with this assert
|
|
46
|
+
const values = typeof value === 'string' ? [value] : value;
|
|
47
|
+
for (let _val of values) {
|
|
48
|
+
if (!condition.includes(_val)) {
|
|
49
|
+
return false;
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
return true;
|
|
53
|
+
},
|
|
54
|
+
defined: (value, condition = true) => {
|
|
55
|
+
const isDefined = typeof value !== 'undefined';
|
|
56
|
+
return condition ? isDefined : !isDefined;
|
|
57
|
+
},
|
|
58
|
+
required: (value, keys) => {
|
|
59
|
+
for (const requiredKey of keys) {
|
|
60
|
+
if (!value.includes(requiredKey)) {
|
|
61
|
+
return false;
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
return true;
|
|
65
|
+
},
|
|
66
|
+
disallowed: (value, condition) => {
|
|
67
|
+
if (typeof value === 'undefined')
|
|
68
|
+
return true; // property doesn't exist, no need to lint it with this assert
|
|
69
|
+
const values = typeof value === 'string' ? [value] : value;
|
|
70
|
+
for (let _val of values) {
|
|
71
|
+
if (condition.includes(_val)) {
|
|
72
|
+
return false;
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
return true;
|
|
76
|
+
},
|
|
77
|
+
undefined: (value, condition = true) => {
|
|
78
|
+
const isUndefined = typeof value === 'undefined';
|
|
79
|
+
return condition ? isUndefined : !isUndefined;
|
|
80
|
+
},
|
|
81
|
+
nonEmpty: (value, condition = true) => {
|
|
82
|
+
const isEmpty = typeof value === 'undefined' || value === null || value === '';
|
|
83
|
+
return condition ? !isEmpty : isEmpty;
|
|
84
|
+
},
|
|
85
|
+
minLength: (value, condition) => {
|
|
86
|
+
if (typeof value === 'undefined')
|
|
87
|
+
return true; // property doesn't exist, no need to lint it with this assert
|
|
88
|
+
return value.length >= condition;
|
|
89
|
+
},
|
|
90
|
+
maxLength: (value, condition) => {
|
|
91
|
+
if (typeof value === 'undefined')
|
|
92
|
+
return true; // property doesn't exist, no need to lint it with this assert
|
|
93
|
+
return value.length <= condition;
|
|
94
|
+
},
|
|
95
|
+
casing: (value, condition) => {
|
|
96
|
+
if (typeof value === 'undefined')
|
|
97
|
+
return true; // property doesn't exist, no need to lint it with this assert
|
|
98
|
+
const values = typeof value === 'string' ? [value] : value;
|
|
99
|
+
for (let _val of values) {
|
|
100
|
+
let matchCase = false;
|
|
101
|
+
switch (condition) {
|
|
102
|
+
case 'camelCase':
|
|
103
|
+
matchCase = !!_val.match(/^[a-z][a-zA-Z0-9]+$/g);
|
|
104
|
+
break;
|
|
105
|
+
case 'kebab-case':
|
|
106
|
+
matchCase = !!_val.match(/^([a-z][a-z0-9]*)(-[a-z0-9]+)*$/g);
|
|
107
|
+
break;
|
|
108
|
+
case 'snake_case':
|
|
109
|
+
matchCase = !!_val.match(/^([a-z][a-z0-9]*)(_[a-z0-9]+)*$/g);
|
|
110
|
+
break;
|
|
111
|
+
case 'PascalCase':
|
|
112
|
+
matchCase = !!_val.match(/^[A-Z][a-zA-Z0-9]+$/g);
|
|
113
|
+
break;
|
|
114
|
+
case 'MACRO_CASE':
|
|
115
|
+
matchCase = !!_val.match(/^([A-Z][A-Z0-9]*)(_[A-Z0-9]+)*$/g);
|
|
116
|
+
break;
|
|
117
|
+
case 'COBOL-CASE':
|
|
118
|
+
matchCase = !!_val.match(/^([A-Z][A-Z0-9]*)(-[A-Z0-9]+)*$/g);
|
|
119
|
+
break;
|
|
120
|
+
case 'flatcase':
|
|
121
|
+
matchCase = !!_val.match(/^[a-z][a-z0-9]+$/g);
|
|
122
|
+
break;
|
|
123
|
+
}
|
|
124
|
+
if (!matchCase) {
|
|
125
|
+
return false;
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
return true;
|
|
129
|
+
},
|
|
130
|
+
sortOrder: (value, condition) => {
|
|
131
|
+
if (typeof value === 'undefined')
|
|
132
|
+
return true;
|
|
133
|
+
return utils_1.isOrdered(value, condition);
|
|
134
|
+
},
|
|
135
|
+
mutuallyExclusive: (value, condition) => {
|
|
136
|
+
return utils_1.getIntersectionLength(value, condition) < 2;
|
|
137
|
+
},
|
|
138
|
+
mutuallyRequired: (value, condition) => {
|
|
139
|
+
return utils_1.getIntersectionLength(value, condition) > 0
|
|
140
|
+
? utils_1.getIntersectionLength(value, condition) === condition.length
|
|
141
|
+
: true;
|
|
142
|
+
},
|
|
143
|
+
};
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Assertions = void 0;
|
|
4
|
+
const asserts_1 = require("./asserts");
|
|
5
|
+
const utils_1 = require("./utils");
|
|
6
|
+
const Assertions = (opts) => {
|
|
7
|
+
let visitors = [];
|
|
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 = Object.values(opts).filter((opt) => typeof opt === 'object' && opt !== null);
|
|
14
|
+
for (const [index, assertion] of assertions.entries()) {
|
|
15
|
+
const assertId = (assertion.assertionId && `${assertion.assertionId} assertion`) || `assertion #${index + 1}`;
|
|
16
|
+
if (!assertion.subject) {
|
|
17
|
+
throw new Error(`${assertId}: 'subject' is required`);
|
|
18
|
+
}
|
|
19
|
+
const subjects = Array.isArray(assertion.subject)
|
|
20
|
+
? assertion.subject
|
|
21
|
+
: [assertion.subject];
|
|
22
|
+
const assertsToApply = Object.keys(asserts_1.asserts)
|
|
23
|
+
.filter((assertName) => assertion[assertName] !== undefined)
|
|
24
|
+
.map((assertName) => {
|
|
25
|
+
return {
|
|
26
|
+
assertId,
|
|
27
|
+
name: assertName,
|
|
28
|
+
conditions: assertion[assertName],
|
|
29
|
+
message: assertion.message,
|
|
30
|
+
severity: assertion.severity || 'error',
|
|
31
|
+
suggest: assertion.suggest || [],
|
|
32
|
+
runsOnKeys: asserts_1.runOnKeysSet.has(assertName),
|
|
33
|
+
runsOnValues: asserts_1.runOnValuesSet.has(assertName),
|
|
34
|
+
};
|
|
35
|
+
});
|
|
36
|
+
const shouldRunOnKeys = assertsToApply.find((assert) => assert.runsOnKeys && !assert.runsOnValues);
|
|
37
|
+
const shouldRunOnValues = assertsToApply.find((assert) => assert.runsOnValues && !assert.runsOnKeys);
|
|
38
|
+
if (shouldRunOnValues && !assertion.property) {
|
|
39
|
+
throw new Error(`${shouldRunOnValues.name} can't be used on all keys. Please provide a single property.`);
|
|
40
|
+
}
|
|
41
|
+
if (shouldRunOnKeys && assertion.property) {
|
|
42
|
+
throw new Error(`${shouldRunOnKeys.name} can't be used on a single property. Please use 'property'.`);
|
|
43
|
+
}
|
|
44
|
+
for (const subject of subjects) {
|
|
45
|
+
const subjectVisitor = utils_1.buildSubjectVisitor(assertion.property, assertsToApply, assertion.context);
|
|
46
|
+
const visitorObject = utils_1.buildVisitorObject(subject, assertion.context, subjectVisitor);
|
|
47
|
+
visitors.push(visitorObject);
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
return visitors;
|
|
51
|
+
};
|
|
52
|
+
exports.Assertions = Assertions;
|