@redocly/openapi-core 1.34.3 → 2.0.0-next.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +42 -4
- package/lib/bundle.d.ts +16 -15
- package/lib/bundle.d.ts.map +1 -0
- package/lib/bundle.js +88 -109
- package/lib/bundle.js.map +1 -0
- package/lib/config/all.d.ts +3 -2
- package/lib/config/all.d.ts.map +1 -0
- package/lib/config/all.js +5 -3
- package/lib/config/all.js.map +1 -0
- package/lib/config/builtIn.d.ts +3 -2
- package/lib/config/builtIn.d.ts.map +1 -0
- package/lib/config/builtIn.js +44 -49
- package/lib/config/builtIn.js.map +1 -0
- package/lib/config/bundle-extends.d.ts +8 -0
- package/lib/config/bundle-extends.d.ts.map +1 -0
- package/lib/config/bundle-extends.js +27 -0
- package/lib/config/bundle-extends.js.map +1 -0
- package/lib/config/config-resolvers.d.ts +15 -27
- package/lib/config/config-resolvers.d.ts.map +1 -0
- package/lib/config/config-resolvers.js +259 -373
- package/lib/config/config-resolvers.js.map +1 -0
- package/lib/config/config.d.ts +22 -26
- package/lib/config/config.d.ts.map +1 -0
- package/lib/config/config.js +104 -112
- package/lib/config/config.js.map +1 -0
- package/lib/config/index.d.ts +8 -7
- package/lib/config/index.d.ts.map +1 -0
- package/lib/config/index.js +8 -23
- package/lib/config/index.js.map +1 -0
- package/lib/config/load.d.ts +8 -19
- package/lib/config/load.d.ts.map +1 -0
- package/lib/config/load.js +62 -107
- package/lib/config/load.js.map +1 -0
- package/lib/config/minimal.d.ts +3 -2
- package/lib/config/minimal.d.ts.map +1 -0
- package/lib/config/minimal.js +5 -3
- package/lib/config/minimal.js.map +1 -0
- package/lib/config/recommended-strict.d.ts +3 -2
- package/lib/config/recommended-strict.d.ts.map +1 -0
- package/lib/config/recommended-strict.js +5 -3
- package/lib/config/recommended-strict.js.map +1 -0
- package/lib/config/recommended.d.ts +3 -2
- package/lib/config/recommended.d.ts.map +1 -0
- package/lib/config/recommended.js +5 -3
- package/lib/config/recommended.js.map +1 -0
- package/lib/config/rules.d.ts +5 -4
- package/lib/config/rules.d.ts.map +1 -0
- package/lib/config/rules.js +4 -6
- package/lib/config/rules.js.map +1 -0
- package/lib/config/spec.d.ts +3 -2
- package/lib/config/spec.d.ts.map +1 -0
- package/lib/config/spec.js +6 -4
- package/lib/config/spec.js.map +1 -0
- package/lib/config/types.d.ts +19 -62
- package/lib/config/types.d.ts.map +1 -0
- package/lib/config/types.js +2 -2
- package/lib/config/types.js.map +1 -0
- package/lib/config/utils.d.ts +5 -9
- package/lib/config/utils.d.ts.map +1 -0
- package/lib/config/utils.js +56 -258
- package/lib/config/utils.js.map +1 -0
- package/lib/config/visitors.d.ts +36 -0
- package/lib/config/visitors.d.ts.map +1 -0
- package/lib/config/visitors.js +88 -0
- package/lib/config/visitors.js.map +1 -0
- package/lib/decorators/arazzo/index.d.ts +1 -0
- package/lib/decorators/arazzo/index.d.ts.map +1 -0
- package/lib/decorators/arazzo/index.js +2 -4
- package/lib/decorators/arazzo/index.js.map +1 -0
- package/lib/decorators/async2/index.d.ts +1 -0
- package/lib/decorators/async2/index.d.ts.map +1 -0
- package/lib/decorators/async2/index.js +2 -4
- package/lib/decorators/async2/index.js.map +1 -0
- package/lib/decorators/async3/index.d.ts +1 -0
- package/lib/decorators/async3/index.d.ts.map +1 -0
- package/lib/decorators/async3/index.js +2 -4
- package/lib/decorators/async3/index.js.map +1 -0
- package/lib/decorators/common/filters/filter-helper.d.ts +2 -1
- package/lib/decorators/common/filters/filter-helper.d.ts.map +1 -0
- package/lib/decorators/common/filters/filter-helper.js +9 -12
- package/lib/decorators/common/filters/filter-helper.js.map +1 -0
- package/lib/decorators/common/filters/filter-in.d.ts +2 -1
- package/lib/decorators/common/filters/filter-in.d.ts.map +1 -0
- package/lib/decorators/common/filters/filter-in.js +5 -8
- package/lib/decorators/common/filters/filter-in.js.map +1 -0
- package/lib/decorators/common/filters/filter-out.d.ts +2 -1
- package/lib/decorators/common/filters/filter-out.d.ts.map +1 -0
- package/lib/decorators/common/filters/filter-out.js +5 -8
- package/lib/decorators/common/filters/filter-out.js.map +1 -0
- package/lib/decorators/common/info-description-override.d.ts +2 -1
- package/lib/decorators/common/info-description-override.d.ts.map +1 -0
- package/lib/decorators/common/info-description-override.js +4 -7
- package/lib/decorators/common/info-description-override.js.map +1 -0
- package/lib/decorators/common/info-override.d.ts +2 -1
- package/lib/decorators/common/info-override.d.ts.map +1 -0
- package/lib/decorators/common/info-override.js +2 -5
- package/lib/decorators/common/info-override.js.map +1 -0
- package/lib/decorators/common/media-type-examples-override.d.ts +2 -1
- package/lib/decorators/common/media-type-examples-override.d.ts.map +1 -0
- package/lib/decorators/common/media-type-examples-override.js +7 -10
- package/lib/decorators/common/media-type-examples-override.js.map +1 -0
- package/lib/decorators/common/operation-description-override.d.ts +2 -1
- package/lib/decorators/common/operation-description-override.d.ts.map +1 -0
- package/lib/decorators/common/operation-description-override.js +4 -7
- package/lib/decorators/common/operation-description-override.js.map +1 -0
- package/lib/decorators/common/remove-x-internal.d.ts +2 -1
- package/lib/decorators/common/remove-x-internal.d.ts.map +1 -0
- package/lib/decorators/common/remove-x-internal.js +11 -14
- package/lib/decorators/common/remove-x-internal.js.map +1 -0
- package/lib/decorators/common/tag-description-override.d.ts +2 -1
- package/lib/decorators/common/tag-description-override.d.ts.map +1 -0
- package/lib/decorators/common/tag-description-override.js +4 -7
- package/lib/decorators/common/tag-description-override.js.map +1 -0
- package/lib/decorators/oas2/index.d.ts +2 -2
- package/lib/decorators/oas2/index.d.ts.map +1 -0
- package/lib/decorators/oas2/index.js +16 -20
- package/lib/decorators/oas2/index.js.map +1 -0
- package/lib/decorators/oas2/remove-unused-components.d.ts +2 -1
- package/lib/decorators/oas2/remove-unused-components.d.ts.map +1 -0
- package/lib/decorators/oas2/remove-unused-components.js +4 -7
- package/lib/decorators/oas2/remove-unused-components.js.map +1 -0
- package/lib/decorators/oas3/index.d.ts +2 -2
- package/lib/decorators/oas3/index.d.ts.map +1 -0
- package/lib/decorators/oas3/index.js +18 -22
- package/lib/decorators/oas3/index.js.map +1 -0
- package/lib/decorators/oas3/remove-unused-components.d.ts +2 -1
- package/lib/decorators/oas3/remove-unused-components.d.ts.map +1 -0
- package/lib/decorators/oas3/remove-unused-components.js +5 -8
- package/lib/decorators/oas3/remove-unused-components.js.map +1 -0
- package/lib/decorators/overlay1/index.d.ts +1 -0
- package/lib/decorators/overlay1/index.d.ts.map +1 -0
- package/lib/decorators/overlay1/index.js +2 -4
- package/lib/decorators/overlay1/index.js.map +1 -0
- package/lib/env.d.ts +1 -0
- package/lib/env.d.ts.map +1 -0
- package/lib/env.js +3 -5
- package/lib/env.js.map +1 -0
- package/lib/format/codeframes.d.ts +2 -1
- package/lib/format/codeframes.d.ts.map +1 -0
- package/lib/format/codeframes.js +15 -19
- package/lib/format/codeframes.js.map +1 -0
- package/lib/format/format.d.ts +2 -1
- package/lib/format/format.d.ts.map +1 -0
- package/lib/format/format.js +57 -62
- package/lib/format/format.js.map +1 -0
- package/lib/index.d.ts +31 -26
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +25 -98
- package/lib/index.js.map +1 -0
- package/lib/js-yaml/index.d.ts +1 -0
- package/lib/js-yaml/index.d.ts.map +1 -0
- package/lib/js-yaml/index.js +7 -11
- package/lib/js-yaml/index.js.map +1 -0
- package/lib/lint.d.ts +12 -13
- package/lib/lint.d.ts.map +1 -0
- package/lib/lint.js +46 -50
- package/lib/lint.js.map +1 -0
- package/lib/logger.d.ts +2 -1
- package/lib/logger.d.ts.map +1 -0
- package/lib/logger.js +15 -17
- package/lib/logger.js.map +1 -0
- package/lib/oas-types.d.ts +395 -3
- package/lib/oas-types.d.ts.map +1 -0
- package/lib/oas-types.js +28 -32
- package/lib/oas-types.js.map +1 -0
- package/lib/ref-utils.d.ts +5 -2
- package/lib/ref-utils.d.ts.map +1 -0
- package/lib/ref-utils.js +30 -33
- package/lib/ref-utils.js.map +1 -0
- package/lib/resolve.d.ts +7 -9
- package/lib/resolve.d.ts.map +1 -0
- package/lib/resolve.js +40 -47
- package/lib/resolve.js.map +1 -0
- package/lib/rules/ajv.d.ts +4 -3
- package/lib/rules/ajv.d.ts.map +1 -0
- package/lib/rules/ajv.js +7 -10
- package/lib/rules/ajv.js.map +1 -0
- package/lib/rules/arazzo/criteria-unique.d.ts +2 -1
- package/lib/rules/arazzo/criteria-unique.d.ts.map +1 -0
- package/lib/rules/arazzo/criteria-unique.js +2 -5
- package/lib/rules/arazzo/criteria-unique.js.map +1 -0
- package/lib/rules/arazzo/index.d.ts +2 -1
- package/lib/rules/arazzo/index.d.ts.map +1 -0
- package/lib/rules/arazzo/index.js +39 -35
- package/lib/rules/arazzo/index.js.map +1 -0
- package/lib/rules/arazzo/parameters-unique.d.ts +2 -1
- package/lib/rules/arazzo/parameters-unique.d.ts.map +1 -0
- package/lib/rules/arazzo/parameters-unique.js +2 -5
- package/lib/rules/arazzo/parameters-unique.js.map +1 -0
- package/lib/rules/arazzo/requestBody-replacements-unique.d.ts +2 -1
- package/lib/rules/arazzo/requestBody-replacements-unique.d.ts.map +1 -0
- package/lib/rules/arazzo/requestBody-replacements-unique.js +2 -5
- package/lib/rules/arazzo/requestBody-replacements-unique.js.map +1 -0
- package/lib/rules/arazzo/sourceDescription-type.d.ts +2 -1
- package/lib/rules/arazzo/sourceDescription-type.d.ts.map +1 -0
- package/lib/rules/arazzo/sourceDescription-type.js +2 -5
- package/lib/rules/arazzo/sourceDescription-type.js.map +1 -0
- package/lib/rules/arazzo/sourceDescriptions-name-unique.d.ts +2 -1
- package/lib/rules/arazzo/sourceDescriptions-name-unique.d.ts.map +1 -0
- package/lib/rules/arazzo/sourceDescriptions-name-unique.js +2 -5
- package/lib/rules/arazzo/sourceDescriptions-name-unique.js.map +1 -0
- package/lib/rules/arazzo/sourceDescriptions-not-empty.d.ts +2 -1
- package/lib/rules/arazzo/sourceDescriptions-not-empty.d.ts.map +1 -0
- package/lib/rules/arazzo/sourceDescriptions-not-empty.js +2 -5
- package/lib/rules/arazzo/sourceDescriptions-not-empty.js.map +1 -0
- package/lib/rules/arazzo/step-onFailure-unique.d.ts +2 -1
- package/lib/rules/arazzo/step-onFailure-unique.d.ts.map +1 -0
- package/lib/rules/arazzo/step-onFailure-unique.js +2 -5
- package/lib/rules/arazzo/step-onFailure-unique.js.map +1 -0
- package/lib/rules/arazzo/step-onSuccess-unique.d.ts +2 -1
- package/lib/rules/arazzo/step-onSuccess-unique.d.ts.map +1 -0
- package/lib/rules/arazzo/step-onSuccess-unique.js +2 -5
- package/lib/rules/arazzo/step-onSuccess-unique.js.map +1 -0
- package/lib/rules/arazzo/stepId-unique.d.ts +2 -1
- package/lib/rules/arazzo/stepId-unique.d.ts.map +1 -0
- package/lib/rules/arazzo/stepId-unique.js +2 -5
- package/lib/rules/arazzo/stepId-unique.js.map +1 -0
- package/lib/rules/arazzo/workflow-dependsOn.d.ts +2 -1
- package/lib/rules/arazzo/workflow-dependsOn.d.ts.map +1 -0
- package/lib/rules/arazzo/workflow-dependsOn.js +2 -5
- package/lib/rules/arazzo/workflow-dependsOn.js.map +1 -0
- package/lib/rules/arazzo/workflowId-unique.d.ts +2 -1
- package/lib/rules/arazzo/workflowId-unique.d.ts.map +1 -0
- package/lib/rules/arazzo/workflowId-unique.js +2 -5
- package/lib/rules/arazzo/workflowId-unique.js.map +1 -0
- package/lib/rules/async2/channels-kebab-case.d.ts +2 -1
- package/lib/rules/async2/channels-kebab-case.d.ts.map +1 -0
- package/lib/rules/async2/channels-kebab-case.js +2 -5
- package/lib/rules/async2/channels-kebab-case.js.map +1 -0
- package/lib/rules/async2/index.d.ts +2 -1
- package/lib/rules/async2/index.d.ts.map +1 -0
- package/lib/rules/async2/index.js +21 -26
- package/lib/rules/async2/index.js.map +1 -0
- package/lib/rules/async2/no-channel-trailing-slash.d.ts +2 -1
- package/lib/rules/async2/no-channel-trailing-slash.d.ts.map +1 -0
- package/lib/rules/async2/no-channel-trailing-slash.js +2 -5
- package/lib/rules/async2/no-channel-trailing-slash.js.map +1 -0
- package/lib/rules/async3/channels-kebab-case.d.ts +2 -1
- package/lib/rules/async3/channels-kebab-case.d.ts.map +1 -0
- package/lib/rules/async3/channels-kebab-case.js +2 -5
- package/lib/rules/async3/channels-kebab-case.js.map +1 -0
- package/lib/rules/async3/index.d.ts +2 -1
- package/lib/rules/async3/index.d.ts.map +1 -0
- package/lib/rules/async3/index.js +21 -26
- package/lib/rules/async3/index.js.map +1 -0
- package/lib/rules/async3/no-channel-trailing-slash.d.ts +2 -1
- package/lib/rules/async3/no-channel-trailing-slash.d.ts.map +1 -0
- package/lib/rules/async3/no-channel-trailing-slash.js +3 -6
- package/lib/rules/async3/no-channel-trailing-slash.js.map +1 -0
- package/lib/rules/common/assertions/asserts.d.ts +3 -3
- package/lib/rules/common/assertions/asserts.d.ts.map +1 -0
- package/lib/rules/common/assertions/asserts.js +35 -51
- package/lib/rules/common/assertions/asserts.js.map +1 -0
- package/lib/rules/common/assertions/index.d.ts +4 -3
- package/lib/rules/common/assertions/index.d.ts.map +1 -0
- package/lib/rules/common/assertions/index.js +7 -10
- package/lib/rules/common/assertions/index.js.map +1 -0
- package/lib/rules/common/assertions/utils.d.ts +5 -4
- package/lib/rules/common/assertions/utils.d.ts.map +1 -0
- package/lib/rules/common/assertions/utils.js +21 -29
- package/lib/rules/common/assertions/utils.js.map +1 -0
- package/lib/rules/common/info-contact.d.ts +2 -1
- package/lib/rules/common/info-contact.d.ts.map +1 -0
- package/lib/rules/common/info-contact.js +4 -7
- package/lib/rules/common/info-contact.js.map +1 -0
- package/lib/rules/common/info-license-strict.d.ts +2 -1
- package/lib/rules/common/info-license-strict.d.ts.map +1 -0
- package/lib/rules/common/info-license-strict.js +7 -10
- package/lib/rules/common/info-license-strict.js.map +1 -0
- package/lib/rules/common/info-license-url.d.ts +2 -1
- package/lib/rules/common/info-license-url.d.ts.map +1 -0
- package/lib/rules/common/info-license-url.js +4 -7
- package/lib/rules/common/info-license-url.js.map +1 -0
- package/lib/rules/common/info-license.d.ts +2 -1
- package/lib/rules/common/info-license.d.ts.map +1 -0
- package/lib/rules/common/info-license.js +4 -7
- package/lib/rules/common/info-license.js.map +1 -0
- package/lib/rules/common/no-ambiguous-paths.d.ts +2 -1
- package/lib/rules/common/no-ambiguous-paths.d.ts.map +1 -0
- package/lib/rules/common/no-ambiguous-paths.js +2 -5
- package/lib/rules/common/no-ambiguous-paths.js.map +1 -0
- package/lib/rules/common/no-enum-type-mismatch.d.ts +2 -1
- package/lib/rules/common/no-enum-type-mismatch.d.ts.map +1 -0
- package/lib/rules/common/no-enum-type-mismatch.js +6 -9
- package/lib/rules/common/no-enum-type-mismatch.js.map +1 -0
- package/lib/rules/common/no-http-verbs-in-paths.d.ts +2 -1
- package/lib/rules/common/no-http-verbs-in-paths.d.ts.map +1 -0
- package/lib/rules/common/no-http-verbs-in-paths.js +5 -8
- package/lib/rules/common/no-http-verbs-in-paths.js.map +1 -0
- package/lib/rules/common/no-identical-paths.d.ts +2 -1
- package/lib/rules/common/no-identical-paths.d.ts.map +1 -0
- package/lib/rules/common/no-identical-paths.js +2 -5
- package/lib/rules/common/no-identical-paths.js.map +1 -0
- package/lib/rules/common/no-invalid-parameter-examples.d.ts +1 -0
- package/lib/rules/common/no-invalid-parameter-examples.d.ts.map +1 -0
- package/lib/rules/common/no-invalid-parameter-examples.js +5 -9
- package/lib/rules/common/no-invalid-parameter-examples.js.map +1 -0
- package/lib/rules/common/no-invalid-schema-examples.d.ts +2 -1
- package/lib/rules/common/no-invalid-schema-examples.d.ts.map +1 -0
- package/lib/rules/common/no-invalid-schema-examples.js +5 -9
- package/lib/rules/common/no-invalid-schema-examples.js.map +1 -0
- package/lib/rules/common/no-path-trailing-slash.d.ts +2 -1
- package/lib/rules/common/no-path-trailing-slash.d.ts.map +1 -0
- package/lib/rules/common/no-path-trailing-slash.js +2 -5
- package/lib/rules/common/no-path-trailing-slash.js.map +1 -0
- package/lib/rules/common/no-required-schema-properties-undefined.d.ts +2 -1
- package/lib/rules/common/no-required-schema-properties-undefined.d.ts.map +1 -0
- package/lib/rules/common/no-required-schema-properties-undefined.js +6 -8
- package/lib/rules/common/no-required-schema-properties-undefined.js.map +1 -0
- package/lib/rules/common/no-schema-type-mismatch.d.ts +2 -1
- package/lib/rules/common/no-schema-type-mismatch.d.ts.map +1 -0
- package/lib/rules/common/no-schema-type-mismatch.js +2 -5
- package/lib/rules/common/no-schema-type-mismatch.js.map +1 -0
- package/lib/rules/common/operation-2xx-response.d.ts +2 -1
- package/lib/rules/common/operation-2xx-response.d.ts.map +1 -0
- package/lib/rules/common/operation-2xx-response.js +5 -8
- package/lib/rules/common/operation-2xx-response.js.map +1 -0
- package/lib/rules/common/operation-4xx-response.d.ts +2 -1
- package/lib/rules/common/operation-4xx-response.d.ts.map +1 -0
- package/lib/rules/common/operation-4xx-response.js +5 -8
- package/lib/rules/common/operation-4xx-response.js.map +1 -0
- package/lib/rules/common/operation-description.d.ts +2 -1
- package/lib/rules/common/operation-description.d.ts.map +1 -0
- package/lib/rules/common/operation-description.js +4 -7
- package/lib/rules/common/operation-description.js.map +1 -0
- package/lib/rules/common/operation-operationId-unique.d.ts +2 -1
- package/lib/rules/common/operation-operationId-unique.d.ts.map +1 -0
- package/lib/rules/common/operation-operationId-unique.js +2 -5
- package/lib/rules/common/operation-operationId-unique.js.map +1 -0
- package/lib/rules/common/operation-operationId-url-safe.d.ts +2 -1
- package/lib/rules/common/operation-operationId-url-safe.d.ts.map +1 -0
- package/lib/rules/common/operation-operationId-url-safe.js +2 -5
- package/lib/rules/common/operation-operationId-url-safe.js.map +1 -0
- package/lib/rules/common/operation-operationId.d.ts +2 -1
- package/lib/rules/common/operation-operationId.d.ts.map +1 -0
- package/lib/rules/common/operation-operationId.js +4 -7
- package/lib/rules/common/operation-operationId.js.map +1 -0
- package/lib/rules/common/operation-parameters-unique.d.ts +2 -1
- package/lib/rules/common/operation-parameters-unique.d.ts.map +1 -0
- package/lib/rules/common/operation-parameters-unique.js +2 -5
- package/lib/rules/common/operation-parameters-unique.js.map +1 -0
- package/lib/rules/common/operation-singular-tag.d.ts +2 -1
- package/lib/rules/common/operation-singular-tag.d.ts.map +1 -0
- package/lib/rules/common/operation-singular-tag.js +2 -5
- package/lib/rules/common/operation-singular-tag.js.map +1 -0
- package/lib/rules/common/operation-summary.d.ts +2 -1
- package/lib/rules/common/operation-summary.d.ts.map +1 -0
- package/lib/rules/common/operation-summary.js +4 -7
- package/lib/rules/common/operation-summary.js.map +1 -0
- package/lib/rules/common/operation-tag-defined.d.ts +2 -1
- package/lib/rules/common/operation-tag-defined.d.ts.map +1 -0
- package/lib/rules/common/operation-tag-defined.js +2 -5
- package/lib/rules/common/operation-tag-defined.js.map +1 -0
- package/lib/rules/common/parameter-description.d.ts +2 -1
- package/lib/rules/common/parameter-description.d.ts.map +1 -0
- package/lib/rules/common/parameter-description.js +2 -5
- package/lib/rules/common/parameter-description.js.map +1 -0
- package/lib/rules/common/path-declaration-must-exist.d.ts +2 -1
- package/lib/rules/common/path-declaration-must-exist.d.ts.map +1 -0
- package/lib/rules/common/path-declaration-must-exist.js +2 -5
- package/lib/rules/common/path-declaration-must-exist.js.map +1 -0
- package/lib/rules/common/path-excludes-patterns.d.ts +2 -1
- package/lib/rules/common/path-excludes-patterns.d.ts.map +1 -0
- package/lib/rules/common/path-excludes-patterns.js +2 -5
- package/lib/rules/common/path-excludes-patterns.js.map +1 -0
- package/lib/rules/common/path-http-verbs-order.d.ts +2 -1
- package/lib/rules/common/path-http-verbs-order.d.ts.map +1 -0
- package/lib/rules/common/path-http-verbs-order.js +2 -5
- package/lib/rules/common/path-http-verbs-order.js.map +1 -0
- package/lib/rules/common/path-not-include-query.d.ts +2 -1
- package/lib/rules/common/path-not-include-query.d.ts.map +1 -0
- package/lib/rules/common/path-not-include-query.js +2 -5
- package/lib/rules/common/path-not-include-query.js.map +1 -0
- package/lib/rules/common/path-params-defined.d.ts +2 -1
- package/lib/rules/common/path-params-defined.d.ts.map +1 -0
- package/lib/rules/common/path-params-defined.js +2 -5
- package/lib/rules/common/path-params-defined.js.map +1 -0
- package/lib/rules/common/path-segment-plural.d.ts +2 -1
- package/lib/rules/common/path-segment-plural.d.ts.map +1 -0
- package/lib/rules/common/path-segment-plural.js +6 -9
- package/lib/rules/common/path-segment-plural.js.map +1 -0
- package/lib/rules/common/paths-kebab-case.d.ts +2 -1
- package/lib/rules/common/paths-kebab-case.d.ts.map +1 -0
- package/lib/rules/common/paths-kebab-case.js +2 -5
- package/lib/rules/common/paths-kebab-case.js.map +1 -0
- package/lib/rules/common/required-string-property-missing-min-length.d.ts +2 -1
- package/lib/rules/common/required-string-property-missing-min-length.d.ts.map +1 -0
- package/lib/rules/common/required-string-property-missing-min-length.js +2 -5
- package/lib/rules/common/required-string-property-missing-min-length.js.map +1 -0
- package/lib/rules/common/response-contains-header.d.ts +2 -1
- package/lib/rules/common/response-contains-header.d.ts.map +1 -0
- package/lib/rules/common/response-contains-header.js +5 -8
- package/lib/rules/common/response-contains-header.js.map +1 -0
- package/lib/rules/common/scalar-property-missing-example.d.ts +2 -1
- package/lib/rules/common/scalar-property-missing-example.d.ts.map +1 -0
- package/lib/rules/common/scalar-property-missing-example.js +6 -8
- package/lib/rules/common/scalar-property-missing-example.js.map +1 -0
- package/lib/rules/common/security-defined.d.ts +2 -1
- package/lib/rules/common/security-defined.d.ts.map +1 -0
- package/lib/rules/common/security-defined.js +2 -5
- package/lib/rules/common/security-defined.js.map +1 -0
- package/lib/rules/common/spec-strict-refs.d.ts +2 -1
- package/lib/rules/common/spec-strict-refs.d.ts.map +1 -0
- package/lib/rules/common/spec-strict-refs.js +4 -7
- package/lib/rules/common/spec-strict-refs.js.map +1 -0
- package/lib/rules/common/struct.d.ts +2 -1
- package/lib/rules/common/struct.d.ts.map +1 -0
- package/lib/rules/common/struct.js +19 -22
- package/lib/rules/common/struct.js.map +1 -0
- package/lib/rules/common/tag-description.d.ts +2 -1
- package/lib/rules/common/tag-description.d.ts.map +1 -0
- package/lib/rules/common/tag-description.js +4 -7
- package/lib/rules/common/tag-description.js.map +1 -0
- package/lib/rules/common/tags-alphabetical.d.ts +2 -1
- package/lib/rules/common/tags-alphabetical.d.ts.map +1 -0
- package/lib/rules/common/tags-alphabetical.js +2 -5
- package/lib/rules/common/tags-alphabetical.js.map +1 -0
- package/lib/rules/no-unresolved-refs.d.ts +4 -3
- package/lib/rules/no-unresolved-refs.d.ts.map +1 -0
- package/lib/rules/no-unresolved-refs.js +5 -9
- package/lib/rules/no-unresolved-refs.js.map +1 -0
- package/lib/rules/oas2/boolean-parameter-prefixes.d.ts +2 -1
- package/lib/rules/oas2/boolean-parameter-prefixes.d.ts.map +1 -0
- package/lib/rules/oas2/boolean-parameter-prefixes.js +2 -5
- package/lib/rules/oas2/boolean-parameter-prefixes.js.map +1 -0
- package/lib/rules/oas2/index.d.ts +2 -1
- package/lib/rules/oas2/index.d.ts.map +1 -0
- package/lib/rules/oas2/index.js +94 -99
- package/lib/rules/oas2/index.js.map +1 -0
- package/lib/rules/oas2/request-mime-type.d.ts +2 -1
- package/lib/rules/oas2/request-mime-type.d.ts.map +1 -0
- package/lib/rules/oas2/request-mime-type.js +5 -8
- package/lib/rules/oas2/request-mime-type.js.map +1 -0
- package/lib/rules/oas2/response-contains-property.d.ts +2 -1
- package/lib/rules/oas2/response-contains-property.d.ts.map +1 -0
- package/lib/rules/oas2/response-contains-property.js +5 -8
- package/lib/rules/oas2/response-contains-property.js.map +1 -0
- package/lib/rules/oas2/response-mime-type.d.ts +2 -1
- package/lib/rules/oas2/response-mime-type.d.ts.map +1 -0
- package/lib/rules/oas2/response-mime-type.js +5 -8
- package/lib/rules/oas2/response-mime-type.js.map +1 -0
- package/lib/rules/oas3/array-parameter-serialization.d.ts +2 -1
- package/lib/rules/oas3/array-parameter-serialization.d.ts.map +1 -0
- package/lib/rules/oas3/array-parameter-serialization.js +4 -7
- package/lib/rules/oas3/array-parameter-serialization.js.map +1 -0
- package/lib/rules/oas3/boolean-parameter-prefixes.d.ts +2 -1
- package/lib/rules/oas3/boolean-parameter-prefixes.d.ts.map +1 -0
- package/lib/rules/oas3/boolean-parameter-prefixes.js +2 -5
- package/lib/rules/oas3/boolean-parameter-prefixes.js.map +1 -0
- package/lib/rules/oas3/component-name-unique.d.ts +2 -1
- package/lib/rules/oas3/component-name-unique.d.ts.map +1 -0
- package/lib/rules/oas3/component-name-unique.js +2 -5
- package/lib/rules/oas3/component-name-unique.js.map +1 -0
- package/lib/rules/oas3/index.d.ts +2 -1
- package/lib/rules/oas3/index.d.ts.map +1 -0
- package/lib/rules/oas3/index.js +118 -123
- package/lib/rules/oas3/index.js.map +1 -0
- package/lib/rules/oas3/no-empty-servers.d.ts +2 -1
- package/lib/rules/oas3/no-empty-servers.d.ts.map +1 -0
- package/lib/rules/oas3/no-empty-servers.js +2 -5
- package/lib/rules/oas3/no-empty-servers.js.map +1 -0
- package/lib/rules/oas3/no-example-value-and-externalValue.d.ts +2 -1
- package/lib/rules/oas3/no-example-value-and-externalValue.d.ts.map +1 -0
- package/lib/rules/oas3/no-example-value-and-externalValue.js +2 -5
- package/lib/rules/oas3/no-example-value-and-externalValue.js.map +1 -0
- package/lib/rules/oas3/no-invalid-media-type-examples.d.ts +2 -1
- package/lib/rules/oas3/no-invalid-media-type-examples.d.ts.map +1 -0
- package/lib/rules/oas3/no-invalid-media-type-examples.js +6 -10
- package/lib/rules/oas3/no-invalid-media-type-examples.js.map +1 -0
- package/lib/rules/oas3/no-server-example.com.d.ts +2 -1
- package/lib/rules/oas3/no-server-example.com.d.ts.map +1 -0
- package/lib/rules/oas3/no-server-example.com.js +2 -5
- package/lib/rules/oas3/no-server-example.com.js.map +1 -0
- package/lib/rules/oas3/no-server-trailing-slash.d.ts +2 -1
- package/lib/rules/oas3/no-server-trailing-slash.d.ts.map +1 -0
- package/lib/rules/oas3/no-server-trailing-slash.js +2 -5
- package/lib/rules/oas3/no-server-trailing-slash.js.map +1 -0
- package/lib/rules/oas3/no-server-variables-empty-enum.d.ts +2 -1
- package/lib/rules/oas3/no-server-variables-empty-enum.d.ts.map +1 -0
- package/lib/rules/oas3/no-server-variables-empty-enum.js +2 -5
- package/lib/rules/oas3/no-server-variables-empty-enum.js.map +1 -0
- package/lib/rules/oas3/no-undefined-server-variable.d.ts +2 -1
- package/lib/rules/oas3/no-undefined-server-variable.d.ts.map +1 -0
- package/lib/rules/oas3/no-undefined-server-variable.js +3 -6
- package/lib/rules/oas3/no-undefined-server-variable.js.map +1 -0
- package/lib/rules/oas3/no-unused-components.d.ts +2 -1
- package/lib/rules/oas3/no-unused-components.d.ts.map +1 -0
- package/lib/rules/oas3/no-unused-components.js +2 -5
- package/lib/rules/oas3/no-unused-components.js.map +1 -0
- package/lib/rules/oas3/operation-4xx-problem-details-rfc7807.d.ts +2 -1
- package/lib/rules/oas3/operation-4xx-problem-details-rfc7807.d.ts.map +1 -0
- package/lib/rules/oas3/operation-4xx-problem-details-rfc7807.js +6 -9
- package/lib/rules/oas3/operation-4xx-problem-details-rfc7807.js.map +1 -0
- package/lib/rules/oas3/request-mime-type.d.ts +2 -1
- package/lib/rules/oas3/request-mime-type.d.ts.map +1 -0
- package/lib/rules/oas3/request-mime-type.js +6 -9
- package/lib/rules/oas3/request-mime-type.js.map +1 -0
- package/lib/rules/oas3/response-contains-property.d.ts +2 -1
- package/lib/rules/oas3/response-contains-property.d.ts.map +1 -0
- package/lib/rules/oas3/response-contains-property.js +5 -8
- package/lib/rules/oas3/response-contains-property.js.map +1 -0
- package/lib/rules/oas3/response-mime-type.d.ts +2 -1
- package/lib/rules/oas3/response-mime-type.d.ts.map +1 -0
- package/lib/rules/oas3/response-mime-type.js +6 -9
- package/lib/rules/oas3/response-mime-type.js.map +1 -0
- package/lib/rules/oas3/spec-components-invalid-map-name.d.ts +2 -1
- package/lib/rules/oas3/spec-components-invalid-map-name.d.ts.map +1 -0
- package/lib/rules/oas3/spec-components-invalid-map-name.js +2 -5
- package/lib/rules/oas3/spec-components-invalid-map-name.js.map +1 -0
- package/lib/rules/other/stats.d.ts +4 -3
- package/lib/rules/other/stats.d.ts.map +1 -0
- package/lib/rules/other/stats.js +2 -5
- package/lib/rules/other/stats.js.map +1 -0
- package/lib/rules/overlay1/index.d.ts +2 -1
- package/lib/rules/overlay1/index.d.ts.map +1 -0
- package/lib/rules/overlay1/index.js +9 -11
- package/lib/rules/overlay1/index.js.map +1 -0
- package/lib/rules/respect/no-criteria-xpath.d.ts +2 -1
- package/lib/rules/respect/no-criteria-xpath.d.ts.map +1 -0
- package/lib/rules/respect/no-criteria-xpath.js +2 -5
- package/lib/rules/respect/no-criteria-xpath.js.map +1 -0
- package/lib/rules/respect/no-x-security-scheme-name-in-workflow.d.ts +3 -0
- package/lib/rules/respect/no-x-security-scheme-name-in-workflow.d.ts.map +1 -0
- package/lib/rules/respect/no-x-security-scheme-name-in-workflow.js +21 -0
- package/lib/rules/respect/no-x-security-scheme-name-in-workflow.js.map +1 -0
- package/lib/rules/respect/no-x-security-scheme-name-without-openapi.d.ts +3 -0
- package/lib/rules/respect/no-x-security-scheme-name-without-openapi.d.ts.map +1 -0
- package/lib/rules/respect/no-x-security-scheme-name-without-openapi.js +25 -0
- package/lib/rules/respect/no-x-security-scheme-name-without-openapi.js.map +1 -0
- package/lib/rules/respect/respect-supported-versions.d.ts +2 -1
- package/lib/rules/respect/respect-supported-versions.d.ts.map +1 -0
- package/lib/rules/respect/respect-supported-versions.js +7 -10
- package/lib/rules/respect/respect-supported-versions.js.map +1 -0
- package/lib/rules/respect/x-security-scheme-required-values.d.ts +3 -0
- package/lib/rules/respect/x-security-scheme-required-values.d.ts.map +1 -0
- package/lib/rules/respect/x-security-scheme-required-values.js +60 -0
- package/lib/rules/respect/x-security-scheme-required-values.js.map +1 -0
- package/lib/rules/utils.d.ts +4 -4
- package/lib/rules/utils.d.ts.map +1 -0
- package/lib/rules/utils.js +20 -43
- package/lib/rules/utils.js.map +1 -0
- package/lib/types/arazzo.d.ts +2 -1
- package/lib/types/arazzo.d.ts.map +1 -0
- package/lib/types/arazzo.js +40 -23
- package/lib/types/arazzo.js.map +1 -0
- package/lib/types/asyncapi2.d.ts +2 -1
- package/lib/types/asyncapi2.d.ts.map +1 -0
- package/lib/types/asyncapi2.js +54 -56
- package/lib/types/asyncapi2.js.map +1 -0
- package/lib/types/asyncapi3.d.ts +2 -1
- package/lib/types/asyncapi3.d.ts.map +1 -0
- package/lib/types/asyncapi3.js +41 -43
- package/lib/types/asyncapi3.js.map +1 -0
- package/lib/types/index.d.ts +2 -0
- package/lib/types/index.d.ts.map +1 -0
- package/lib/types/index.js +7 -13
- package/lib/types/index.js.map +1 -0
- package/lib/types/json-schema-adapter.d.ts +2 -1
- package/lib/types/json-schema-adapter.d.ts.map +1 -0
- package/lib/types/json-schema-adapter.js +15 -17
- package/lib/types/json-schema-adapter.js.map +1 -0
- package/lib/types/oas2.d.ts +85 -3
- package/lib/types/oas2.d.ts.map +1 -0
- package/lib/types/oas2.js +17 -19
- package/lib/types/oas2.js.map +1 -0
- package/lib/types/oas3.d.ts +159 -3
- package/lib/types/oas3.d.ts.map +1 -0
- package/lib/types/oas3.js +44 -46
- package/lib/types/oas3.js.map +1 -0
- package/lib/types/oas3_1.d.ts +162 -3
- package/lib/types/oas3_1.d.ts.map +1 -0
- package/lib/types/oas3_1.js +19 -21
- package/lib/types/oas3_1.js.map +1 -0
- package/lib/types/overlay.d.ts +2 -1
- package/lib/types/overlay.d.ts.map +1 -0
- package/lib/types/overlay.js +4 -6
- package/lib/types/overlay.js.map +1 -0
- package/lib/types/redocly-yaml.d.ts +6 -10
- package/lib/types/redocly-yaml.d.ts.map +1 -0
- package/lib/types/redocly-yaml.js +74 -813
- package/lib/types/redocly-yaml.js.map +1 -0
- package/lib/typings/arazzo.d.ts +41 -0
- package/lib/typings/arazzo.d.ts.map +1 -0
- package/lib/typings/arazzo.js +3 -5
- package/lib/typings/arazzo.js.map +1 -0
- package/lib/typings/asyncapi.d.ts +1 -0
- package/lib/typings/asyncapi.d.ts.map +1 -0
- package/lib/typings/asyncapi.js +2 -2
- package/lib/typings/asyncapi.js.map +1 -0
- package/lib/typings/asyncapi3.d.ts +1 -0
- package/lib/typings/asyncapi3.d.ts.map +1 -0
- package/lib/typings/asyncapi3.js +2 -2
- package/lib/typings/asyncapi3.js.map +1 -0
- package/lib/typings/common.d.ts +1 -0
- package/lib/typings/common.d.ts.map +1 -0
- package/lib/typings/common.js +2 -2
- package/lib/typings/common.js.map +1 -0
- package/lib/typings/openapi.d.ts +45 -15
- package/lib/typings/openapi.d.ts.map +1 -0
- package/lib/typings/openapi.js +2 -2
- package/lib/typings/openapi.js.map +1 -0
- package/lib/typings/overlay.d.ts +1 -0
- package/lib/typings/overlay.d.ts.map +1 -0
- package/lib/typings/overlay.js +2 -4
- package/lib/typings/overlay.js.map +1 -0
- package/lib/typings/swagger.d.ts +2 -1
- package/lib/typings/swagger.d.ts.map +1 -0
- package/lib/typings/swagger.js +2 -2
- package/lib/typings/swagger.js.map +1 -0
- package/lib/utils/error.d.ts +3 -0
- package/lib/utils/error.d.ts.map +1 -0
- package/lib/utils/error.js +3 -0
- package/lib/utils/error.js.map +1 -0
- package/lib/utils.d.ts +6 -11
- package/lib/utils.d.ts.map +1 -0
- package/lib/utils.js +50 -123
- package/lib/utils.js.map +1 -0
- package/lib/visitors.d.ts +16 -15
- package/lib/visitors.d.ts.map +1 -0
- package/lib/visitors.js +4 -6
- package/lib/visitors.js.map +1 -0
- package/lib/walk.d.ts +9 -8
- package/lib/walk.d.ts.map +1 -0
- package/lib/walk.js +31 -28
- package/lib/walk.js.map +1 -0
- package/package.json +31 -10
- package/CHANGELOG.md +0 -561
- package/__tests__/utils.ts +0 -92
- package/lib/benchmark/benches/lint-with-many-rules.bench.d.ts +0 -4
- package/lib/benchmark/benches/lint-with-many-rules.bench.js +0 -38
- package/lib/benchmark/benches/lint-with-nested-rule.bench.d.ts +0 -4
- package/lib/benchmark/benches/lint-with-nested-rule.bench.js +0 -44
- package/lib/benchmark/benches/lint-with-no-rules.bench.d.ts +0 -4
- package/lib/benchmark/benches/lint-with-no-rules.bench.js +0 -25
- package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.d.ts +0 -4
- package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.js +0 -37
- package/lib/benchmark/benches/lint-with-top-level-rule.bench.d.ts +0 -4
- package/lib/benchmark/benches/lint-with-top-level-rule.bench.js +0 -36
- package/lib/benchmark/benches/recommended-oas3.bench.d.ts +0 -3
- package/lib/benchmark/benches/recommended-oas3.bench.js +0 -21
- package/lib/benchmark/benches/resolve-with-no-external.bench.d.ts +0 -3
- package/lib/benchmark/benches/resolve-with-no-external.bench.js +0 -22
- package/lib/benchmark/utils.d.ts +0 -6
- package/lib/benchmark/utils.js +0 -34
- package/lib/decorators/common/registry-dependencies.d.ts +0 -2
- package/lib/decorators/common/registry-dependencies.js +0 -24
- package/lib/output.d.ts +0 -3
- package/lib/output.js +0 -9
- package/lib/redocly/domains.d.ts +0 -14
- package/lib/redocly/domains.js +0 -41
- package/lib/redocly/index.d.ts +0 -30
- package/lib/redocly/index.js +0 -131
- package/lib/redocly/redocly-client-types.d.ts +0 -8
- package/lib/redocly/redocly-client-types.js +0 -2
- package/lib/redocly/registry-api-types.d.ts +0 -29
- package/lib/redocly/registry-api-types.js +0 -2
- package/lib/redocly/registry-api.d.ts +0 -17
- package/lib/redocly/registry-api.js +0 -100
- package/src/__tests__/__snapshots__/bundle.test.ts.snap +0 -461
- package/src/__tests__/bundle.test.ts +0 -478
- package/src/__tests__/codeframes.test.ts +0 -530
- package/src/__tests__/fixtures/.redocly.lint-ignore.yaml +0 -5
- package/src/__tests__/fixtures/extension.js +0 -24
- package/src/__tests__/fixtures/lint/openapi.yaml +0 -10
- package/src/__tests__/fixtures/redocly.yaml +0 -2
- package/src/__tests__/fixtures/refs/definitions.yaml +0 -3
- package/src/__tests__/fixtures/refs/examples.yaml +0 -8
- package/src/__tests__/fixtures/refs/external-request-body.yaml +0 -13
- package/src/__tests__/fixtures/refs/externalref.yaml +0 -35
- package/src/__tests__/fixtures/refs/hosted.yaml +0 -35
- package/src/__tests__/fixtures/refs/openapi-with-external-refs-conflicting-names.yaml +0 -21
- package/src/__tests__/fixtures/refs/openapi-with-external-refs.yaml +0 -33
- package/src/__tests__/fixtures/refs/openapi-with-special-names-in-props.yaml +0 -19
- package/src/__tests__/fixtures/refs/openapi-with-url-refs.yaml +0 -18
- package/src/__tests__/fixtures/refs/param-b.yaml +0 -1
- package/src/__tests__/fixtures/refs/param-c.yaml +0 -1
- package/src/__tests__/fixtures/refs/rename.yaml +0 -1
- package/src/__tests__/fixtures/refs/requestBody.yaml +0 -9
- package/src/__tests__/fixtures/refs/schema-a.yaml +0 -1
- package/src/__tests__/fixtures/refs/simple.yaml +0 -1
- package/src/__tests__/fixtures/refs/vendor.schema.yaml +0 -20
- package/src/__tests__/fixtures/resolve/External.yaml +0 -10
- package/src/__tests__/fixtures/resolve/External2.yaml +0 -4
- package/src/__tests__/fixtures/resolve/description.md +0 -3
- package/src/__tests__/fixtures/resolve/externalInfo.yaml +0 -4
- package/src/__tests__/fixtures/resolve/externalLicense.yaml +0 -1
- package/src/__tests__/fixtures/resolve/openapi-with-back.yaml +0 -13
- package/src/__tests__/fixtures/resolve/openapi-with-md-description.yaml +0 -5
- package/src/__tests__/fixtures/resolve/openapi.yaml +0 -28
- package/src/__tests__/fixtures/resolve/schemas/type-a.yaml +0 -10
- package/src/__tests__/fixtures/resolve/schemas/type-b.yaml +0 -6
- package/src/__tests__/fixtures/resolve/transitive/a.yaml +0 -1
- package/src/__tests__/fixtures/resolve/transitive/components.yaml +0 -5
- package/src/__tests__/fixtures/resolve/transitive/schemas.yaml +0 -3
- package/src/__tests__/format.test.ts +0 -147
- package/src/__tests__/js-yaml.test.ts +0 -73
- package/src/__tests__/lint.test.ts +0 -1772
- package/src/__tests__/logger-browser.test.ts +0 -53
- package/src/__tests__/logger.test.ts +0 -47
- package/src/__tests__/login.test.ts +0 -17
- package/src/__tests__/normalizeVisitors.test.ts +0 -169
- package/src/__tests__/output-browser.test.ts +0 -18
- package/src/__tests__/output.test.ts +0 -15
- package/src/__tests__/ref-utils.test.ts +0 -142
- package/src/__tests__/resolve-http.test.ts +0 -77
- package/src/__tests__/resolve.test.ts +0 -431
- package/src/__tests__/utils-browser.test.ts +0 -11
- package/src/__tests__/utils.test.ts +0 -144
- package/src/__tests__/walk.test.ts +0 -1596
- package/src/benchmark/benches/lint-with-many-rules.bench.ts +0 -41
- package/src/benchmark/benches/lint-with-nested-rule.bench.ts +0 -45
- package/src/benchmark/benches/lint-with-no-rules.bench.ts +0 -27
- package/src/benchmark/benches/lint-with-top-level-rule-report.bench.ts +0 -40
- package/src/benchmark/benches/lint-with-top-level-rule.bench.ts +0 -38
- package/src/benchmark/benches/rebilly.yaml +0 -32272
- package/src/benchmark/benches/recommended-oas3.bench.ts +0 -22
- package/src/benchmark/benches/resolve-with-no-external.bench.ts +0 -23
- package/src/benchmark/benchmark.js +0 -311
- package/src/benchmark/colors.js +0 -29
- package/src/benchmark/fork.js +0 -87
- package/src/benchmark/utils.ts +0 -37
- package/src/bundle.ts +0 -531
- package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap +0 -485
- package/src/config/__tests__/__snapshots__/config.test.ts.snap +0 -232
- package/src/config/__tests__/config-resolvers.test.ts +0 -668
- package/src/config/__tests__/config.test.ts +0 -356
- package/src/config/__tests__/fixtures/ingore-file.ts +0 -8
- package/src/config/__tests__/fixtures/load-external.yaml +0 -2
- package/src/config/__tests__/fixtures/load-redocly.yaml +0 -2
- package/src/config/__tests__/fixtures/plugin-config.yaml +0 -2
- package/src/config/__tests__/fixtures/plugin.js +0 -56
- package/src/config/__tests__/fixtures/resolve-config/api/nested-config.yaml +0 -11
- package/src/config/__tests__/fixtures/resolve-config/api/plugin.js +0 -69
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-circular.yaml +0 -7
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-commonjs-export-function.yaml +0 -2
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-custom-function.yaml +0 -17
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-esm.yaml +0 -2
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-file.yaml +0 -18
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-plugin-init.yaml +0 -2
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-realm-plugin.yaml +0 -2
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-wrong-custom-function.yaml +0 -15
- package/src/config/__tests__/fixtures/resolve-config/local-config.yaml +0 -9
- package/src/config/__tests__/fixtures/resolve-config/plugin-esm.mjs +0 -10
- package/src/config/__tests__/fixtures/resolve-config/plugin-with-export-function.cjs +0 -10
- package/src/config/__tests__/fixtures/resolve-config/plugin-with-init-logic.js +0 -9
- package/src/config/__tests__/fixtures/resolve-config/plugin.js +0 -80
- package/src/config/__tests__/fixtures/resolve-config/realm-plugin.js +0 -12
- package/src/config/__tests__/fixtures/resolve-refs-in-config/config-with-refs.yaml +0 -8
- package/src/config/__tests__/fixtures/resolve-refs-in-config/rules.yaml +0 -2
- package/src/config/__tests__/fixtures/resolve-refs-in-config/seo.yaml +0 -1
- package/src/config/__tests__/fixtures/resolve-remote-configs/nested-remote-config.yaml +0 -3
- package/src/config/__tests__/fixtures/resolve-remote-configs/remote-config.yaml +0 -4
- package/src/config/__tests__/load.test.ts +0 -320
- package/src/config/__tests__/resolve-plugins.test.ts +0 -30
- package/src/config/__tests__/utils.test.ts +0 -225
- package/src/config/all.ts +0 -234
- package/src/config/builtIn.ts +0 -59
- package/src/config/config-resolvers.ts +0 -657
- package/src/config/config.ts +0 -423
- package/src/config/index.ts +0 -7
- package/src/config/load.ts +0 -213
- package/src/config/minimal.ts +0 -210
- package/src/config/recommended-strict.ts +0 -210
- package/src/config/recommended.ts +0 -210
- package/src/config/rules.ts +0 -72
- package/src/config/spec.ts +0 -33
- package/src/config/types.ts +0 -306
- package/src/config/utils.ts +0 -439
- package/src/decorators/__tests__/filter-in.test.ts +0 -313
- package/src/decorators/__tests__/filter-out.test.ts +0 -344
- package/src/decorators/__tests__/media-type-examples-override.test.ts +0 -665
- package/src/decorators/__tests__/remove-x-internal.test.ts +0 -416
- package/src/decorators/__tests__/resources/request.yaml +0 -3
- package/src/decorators/__tests__/resources/response.yaml +0 -3
- package/src/decorators/arazzo/index.ts +0 -1
- package/src/decorators/async2/index.ts +0 -1
- package/src/decorators/async3/index.ts +0 -1
- package/src/decorators/common/filters/filter-helper.ts +0 -73
- package/src/decorators/common/filters/filter-in.ts +0 -19
- package/src/decorators/common/filters/filter-out.ts +0 -19
- package/src/decorators/common/info-description-override.ts +0 -25
- package/src/decorators/common/info-override.ts +0 -15
- package/src/decorators/common/media-type-examples-override.ts +0 -80
- package/src/decorators/common/operation-description-override.ts +0 -31
- package/src/decorators/common/registry-dependencies.ts +0 -25
- package/src/decorators/common/remove-x-internal.ts +0 -77
- package/src/decorators/common/tag-description-override.ts +0 -26
- package/src/decorators/oas2/__tests__/remove-unused-components.test.ts +0 -228
- package/src/decorators/oas2/index.ts +0 -21
- package/src/decorators/oas2/remove-unused-components.ts +0 -109
- package/src/decorators/oas3/__tests__/remove-unused-components.test.ts +0 -313
- package/src/decorators/oas3/index.ts +0 -23
- package/src/decorators/oas3/remove-unused-components.ts +0 -138
- package/src/decorators/overlay1/index.ts +0 -1
- package/src/env.ts +0 -5
- package/src/format/codeframes.ts +0 -217
- package/src/format/format.ts +0 -479
- package/src/index.ts +0 -91
- package/src/js-yaml/index.ts +0 -16
- package/src/lint.ts +0 -190
- package/src/logger.ts +0 -36
- package/src/oas-types.ts +0 -178
- package/src/output.ts +0 -7
- package/src/redocly/__tests__/domains.test.ts +0 -52
- package/src/redocly/__tests__/redocly-client.test.ts +0 -156
- package/src/redocly/domains.ts +0 -48
- package/src/redocly/index.ts +0 -177
- package/src/redocly/redocly-client-types.ts +0 -10
- package/src/redocly/registry-api-types.ts +0 -32
- package/src/redocly/registry-api.ts +0 -147
- package/src/ref-utils.ts +0 -91
- package/src/resolve.ts +0 -461
- package/src/rules/__tests__/fixtures/code-sample.php +0 -9
- package/src/rules/__tests__/fixtures/invalid-yaml.yaml +0 -1
- package/src/rules/__tests__/fixtures/ref.yaml +0 -1
- package/src/rules/__tests__/no-unresolved-refs.test.ts +0 -271
- package/src/rules/__tests__/utils.test.ts +0 -160
- package/src/rules/ajv.ts +0 -105
- package/src/rules/arazzo/__tests__/criteria-unique.test.ts +0 -160
- package/src/rules/arazzo/__tests__/no-criteria-xpath.test.ts +0 -126
- package/src/rules/arazzo/__tests__/parameters-unique.test.ts +0 -113
- package/src/rules/arazzo/__tests__/requestBody-replacements-unique.test.ts +0 -108
- package/src/rules/arazzo/__tests__/respect-supported-versions.test.ts +0 -116
- package/src/rules/arazzo/__tests__/source-description-type.test.ts +0 -78
- package/src/rules/arazzo/__tests__/sourceDescription-name-unique.test.ts +0 -78
- package/src/rules/arazzo/__tests__/sourceDescriptions-not-empty.test.ts +0 -104
- package/src/rules/arazzo/__tests__/step-onFailure-unique.test.ts +0 -110
- package/src/rules/arazzo/__tests__/step-onSuccess-unique.test.ts +0 -110
- package/src/rules/arazzo/__tests__/stepId-unique.test.ts +0 -94
- package/src/rules/arazzo/__tests__/workflow-dependsOn.test.ts +0 -209
- package/src/rules/arazzo/__tests__/workflowId-unique.test.ts +0 -88
- package/src/rules/arazzo/criteria-unique.ts +0 -70
- package/src/rules/arazzo/index.ts +0 -38
- package/src/rules/arazzo/parameters-unique.ts +0 -33
- package/src/rules/arazzo/requestBody-replacements-unique.ts +0 -33
- package/src/rules/arazzo/sourceDescription-type.ts +0 -21
- package/src/rules/arazzo/sourceDescriptions-name-unique.ts +0 -23
- package/src/rules/arazzo/sourceDescriptions-not-empty.ts +0 -17
- package/src/rules/arazzo/step-onFailure-unique.ts +0 -33
- package/src/rules/arazzo/step-onSuccess-unique.ts +0 -33
- package/src/rules/arazzo/stepId-unique.ts +0 -24
- package/src/rules/arazzo/workflow-dependsOn.ts +0 -56
- package/src/rules/arazzo/workflowId-unique.ts +0 -21
- package/src/rules/async2/__tests__/channels-kebab-case.test.ts +0 -145
- package/src/rules/async2/__tests__/no-channel-trailing-slash.test.ts +0 -97
- package/src/rules/async2/channels-kebab-case.ts +0 -18
- package/src/rules/async2/index.ts +0 -29
- package/src/rules/async2/no-channel-trailing-slash.ts +0 -15
- package/src/rules/async3/__tests__/channels-kebab-case.test.ts +0 -145
- package/src/rules/async3/__tests__/no-channel-trailing-slash.test.ts +0 -96
- package/src/rules/async3/channels-kebab-case.ts +0 -19
- package/src/rules/async3/index.ts +0 -29
- package/src/rules/async3/no-channel-trailing-slash.ts +0 -16
- package/src/rules/common/__tests__/info-license-strict.test.ts +0 -141
- package/src/rules/common/__tests__/info-license.test.ts +0 -62
- package/src/rules/common/__tests__/license-url.test.ts +0 -63
- package/src/rules/common/__tests__/no-ambiguous-paths.test.ts +0 -96
- package/src/rules/common/__tests__/no-enum-type-mismatch.test.ts +0 -210
- package/src/rules/common/__tests__/no-identical-paths.test.ts +0 -58
- package/src/rules/common/__tests__/no-invalid-parameter-examples.test.ts +0 -53
- package/src/rules/common/__tests__/no-invalid-schema-examples.test.ts +0 -86
- package/src/rules/common/__tests__/no-path-trailing-slash.test.ts +0 -126
- package/src/rules/common/__tests__/no-required-schema-properties-undefined.test.ts +0 -550
- package/src/rules/common/__tests__/no-schema-type-mismatch.test.ts +0 -126
- package/src/rules/common/__tests__/operation-2xx-response.test.ts +0 -194
- package/src/rules/common/__tests__/operation-4xx-response.test.ts +0 -233
- package/src/rules/common/__tests__/operation-operationId-unique.test.ts +0 -76
- package/src/rules/common/__tests__/operation-operationId-url-safe.test.ts +0 -45
- package/src/rules/common/__tests__/operation-parameters-unique.test.ts +0 -167
- package/src/rules/common/__tests__/operation-singular-tag.test.ts +0 -72
- package/src/rules/common/__tests__/operation-tag-defined.test.ts +0 -68
- package/src/rules/common/__tests__/path-http-verbs-order.test.ts +0 -95
- package/src/rules/common/__tests__/path-not-include-query.test.ts +0 -64
- package/src/rules/common/__tests__/path-params-defined.test.ts +0 -202
- package/src/rules/common/__tests__/paths-kebab-case.test.ts +0 -110
- package/src/rules/common/__tests__/scalar-property-missing-example.test.ts +0 -264
- package/src/rules/common/__tests__/security-defined.test.ts +0 -284
- package/src/rules/common/__tests__/spec-strict-refs.test.ts +0 -69
- package/src/rules/common/__tests__/struct.test.ts +0 -657
- package/src/rules/common/__tests__/tag-description.test.ts +0 -65
- package/src/rules/common/__tests__/tags-alphabetical.test.ts +0 -124
- package/src/rules/common/assertions/__tests__/asserts.test.ts +0 -877
- package/src/rules/common/assertions/__tests__/index.test.ts +0 -100
- package/src/rules/common/assertions/__tests__/utils.test.ts +0 -236
- package/src/rules/common/assertions/asserts.ts +0 -365
- package/src/rules/common/assertions/index.ts +0 -68
- package/src/rules/common/assertions/utils.ts +0 -333
- package/src/rules/common/info-contact.ts +0 -16
- package/src/rules/common/info-license-strict.ts +0 -24
- package/src/rules/common/info-license-url.ts +0 -11
- package/src/rules/common/info-license.ts +0 -16
- package/src/rules/common/no-ambiguous-paths.ts +0 -50
- package/src/rules/common/no-enum-type-mismatch.ts +0 -53
- package/src/rules/common/no-http-verbs-in-paths.ts +0 -37
- package/src/rules/common/no-identical-paths.ts +0 -24
- package/src/rules/common/no-invalid-parameter-examples.ts +0 -37
- package/src/rules/common/no-invalid-schema-examples.ts +0 -40
- package/src/rules/common/no-path-trailing-slash.ts +0 -15
- package/src/rules/common/no-required-schema-properties-undefined.ts +0 -54
- package/src/rules/common/no-schema-type-mismatch.ts +0 -24
- package/src/rules/common/operation-2xx-response.ts +0 -25
- package/src/rules/common/operation-4xx-response.ts +0 -25
- package/src/rules/common/operation-description.ts +0 -14
- package/src/rules/common/operation-operationId-unique.ts +0 -21
- package/src/rules/common/operation-operationId-url-safe.ts +0 -20
- package/src/rules/common/operation-operationId.ts +0 -18
- package/src/rules/common/operation-parameters-unique.ts +0 -48
- package/src/rules/common/operation-singular-tag.ts +0 -17
- package/src/rules/common/operation-summary.ts +0 -14
- package/src/rules/common/operation-tag-defined.ts +0 -31
- package/src/rules/common/parameter-description.ts +0 -22
- package/src/rules/common/path-declaration-must-exist.ts +0 -15
- package/src/rules/common/path-excludes-patterns.ts +0 -23
- package/src/rules/common/path-http-verbs-order.ts +0 -30
- package/src/rules/common/path-not-include-query.ts +0 -17
- package/src/rules/common/path-params-defined.ts +0 -65
- package/src/rules/common/path-segment-plural.ts +0 -33
- package/src/rules/common/paths-kebab-case.ts +0 -19
- package/src/rules/common/required-string-property-missing-min-length.ts +0 -44
- package/src/rules/common/response-contains-header.ts +0 -36
- package/src/rules/common/scalar-property-missing-example.ts +0 -59
- package/src/rules/common/security-defined.ts +0 -89
- package/src/rules/common/spec-strict-refs.ts +0 -31
- package/src/rules/common/struct.ts +0 -189
- package/src/rules/common/tag-description.ts +0 -11
- package/src/rules/common/tags-alphabetical.ts +0 -27
- package/src/rules/no-unresolved-refs.ts +0 -52
- package/src/rules/oas2/__tests__/boolean-parameter-prefixes.test.ts +0 -112
- package/src/rules/oas2/__tests__/response-contains-header.test.ts +0 -180
- package/src/rules/oas2/__tests__/response-contains-property.test.ts +0 -161
- package/src/rules/oas2/__tests__/spec/fixtures/description.md +0 -1
- package/src/rules/oas2/__tests__/spec/info.test.ts +0 -355
- package/src/rules/oas2/__tests__/spec/operation.test.ts +0 -123
- package/src/rules/oas2/__tests__/spec/paths.test.ts +0 -245
- package/src/rules/oas2/__tests__/spec/referenceableScalars.test.ts +0 -37
- package/src/rules/oas2/__tests__/spec/utils.ts +0 -32
- package/src/rules/oas2/boolean-parameter-prefixes.ts +0 -26
- package/src/rules/oas2/index.ts +0 -102
- package/src/rules/oas2/request-mime-type.ts +0 -17
- package/src/rules/oas2/response-contains-property.ts +0 -37
- package/src/rules/oas2/response-mime-type.ts +0 -17
- package/src/rules/oas3/__tests__/array-parameter-serialization.test.ts +0 -275
- package/src/rules/oas3/__tests__/boolean-parameter-prefixes.test.ts +0 -113
- package/src/rules/oas3/__tests__/component-name-unique.test.ts +0 -966
- package/src/rules/oas3/__tests__/fixtures/common.yaml +0 -11
- package/src/rules/oas3/__tests__/fixtures/external-value.yaml +0 -2
- package/src/rules/oas3/__tests__/no-empty-enum-servers.com.test.ts +0 -205
- package/src/rules/oas3/__tests__/no-example-value-and-externalValue.test.ts +0 -65
- package/src/rules/oas3/__tests__/no-invalid-media-type-examples.test.ts +0 -732
- package/src/rules/oas3/__tests__/no-server-example.com.test.ts +0 -95
- package/src/rules/oas3/__tests__/no-server-trailing-slash.test.ts +0 -79
- package/src/rules/oas3/__tests__/no-unused-components.test.ts +0 -131
- package/src/rules/oas3/__tests__/operation-4xx-problem-details-rfc7807.test.ts +0 -145
- package/src/rules/oas3/__tests__/response-contains-header.test.ts +0 -401
- package/src/rules/oas3/__tests__/response-contains-property.test.ts +0 -417
- package/src/rules/oas3/__tests__/spec/callbacks.test.ts +0 -41
- package/src/rules/oas3/__tests__/spec/fixtures/description.md +0 -1
- package/src/rules/oas3/__tests__/spec/info.test.ts +0 -391
- package/src/rules/oas3/__tests__/spec/operation.test.ts +0 -253
- package/src/rules/oas3/__tests__/spec/paths.test.ts +0 -284
- package/src/rules/oas3/__tests__/spec/referenceableScalars.test.ts +0 -77
- package/src/rules/oas3/__tests__/spec/servers.test.ts +0 -505
- package/src/rules/oas3/__tests__/spec/spec.test.ts +0 -307
- package/src/rules/oas3/__tests__/spec/utils.ts +0 -32
- package/src/rules/oas3/__tests__/spec-components-invalid-map-name.test.ts +0 -282
- package/src/rules/oas3/__tests__/utils/lint-document-for-test.ts +0 -23
- package/src/rules/oas3/array-parameter-serialization.ts +0 -47
- package/src/rules/oas3/boolean-parameter-prefixes.ts +0 -28
- package/src/rules/oas3/component-name-unique.ts +0 -162
- package/src/rules/oas3/index.ts +0 -126
- package/src/rules/oas3/no-empty-servers.ts +0 -22
- package/src/rules/oas3/no-example-value-and-externalValue.ts +0 -14
- package/src/rules/oas3/no-invalid-media-type-examples.ts +0 -54
- package/src/rules/oas3/no-server-example.com.ts +0 -16
- package/src/rules/oas3/no-server-trailing-slash.ts +0 -15
- package/src/rules/oas3/no-server-variables-empty-enum.ts +0 -66
- package/src/rules/oas3/no-undefined-server-variable.ts +0 -30
- package/src/rules/oas3/no-unused-components.ts +0 -75
- package/src/rules/oas3/operation-4xx-problem-details-rfc7807.ts +0 -36
- package/src/rules/oas3/request-mime-type.ts +0 -31
- package/src/rules/oas3/response-contains-property.ts +0 -39
- package/src/rules/oas3/response-mime-type.ts +0 -31
- package/src/rules/oas3/spec-components-invalid-map-name.ts +0 -69
- package/src/rules/other/stats.ts +0 -75
- package/src/rules/overlay1/__tests__/info-contact.test.ts +0 -112
- package/src/rules/overlay1/index.ts +0 -14
- package/src/rules/respect/no-criteria-xpath.ts +0 -20
- package/src/rules/respect/respect-supported-versions.ts +0 -24
- package/src/rules/utils.ts +0 -230
- package/src/types/arazzo.ts +0 -305
- package/src/types/asyncapi2.ts +0 -1121
- package/src/types/asyncapi3.ts +0 -383
- package/src/types/index.ts +0 -144
- package/src/types/json-schema-adapter.ts +0 -217
- package/src/types/oas2.ts +0 -481
- package/src/types/oas3.ts +0 -594
- package/src/types/oas3_1.ts +0 -290
- package/src/types/overlay.ts +0 -40
- package/src/types/redocly-yaml.ts +0 -1226
- package/src/typings/arazzo.ts +0 -172
- package/src/typings/asyncapi.ts +0 -26
- package/src/typings/asyncapi3.ts +0 -61
- package/src/typings/common.ts +0 -18
- package/src/typings/openapi.ts +0 -347
- package/src/typings/overlay.ts +0 -19
- package/src/typings/swagger.ts +0 -236
- package/src/utils.ts +0 -357
- package/src/visitors.ts +0 -598
- package/src/walk.ts +0 -467
- package/tsconfig.json +0 -8
- package/tsconfig.tsbuildinfo +0 -1
package/src/lint.ts
DELETED
|
@@ -1,190 +0,0 @@
|
|
|
1
|
-
import { rootRedoclyConfigSchema } from '@redocly/config';
|
|
2
|
-
import { BaseResolver, resolveDocument, makeDocumentFromString } from './resolve';
|
|
3
|
-
import { normalizeVisitors } from './visitors';
|
|
4
|
-
import { walkDocument } from './walk';
|
|
5
|
-
import { initRules } from './config';
|
|
6
|
-
import { normalizeTypes } from './types';
|
|
7
|
-
import { releaseAjvInstance } from './rules/ajv';
|
|
8
|
-
import { SpecVersion, getMajorSpecVersion, detectSpec, getTypes } from './oas-types';
|
|
9
|
-
import { createConfigTypes } from './types/redocly-yaml';
|
|
10
|
-
import { Struct } from './rules/common/struct';
|
|
11
|
-
import { NoUnresolvedRefs } from './rules/no-unresolved-refs';
|
|
12
|
-
|
|
13
|
-
import type { StyleguideConfig, Config } from './config';
|
|
14
|
-
import type { Document, ResolvedRefMap } from './resolve';
|
|
15
|
-
import type { ProblemSeverity, WalkContext } from './walk';
|
|
16
|
-
import type { NodeType } from './types';
|
|
17
|
-
import type {
|
|
18
|
-
Arazzo1Visitor,
|
|
19
|
-
Async2Visitor,
|
|
20
|
-
Async3Visitor,
|
|
21
|
-
NestedVisitObject,
|
|
22
|
-
Oas2Visitor,
|
|
23
|
-
Oas3Visitor,
|
|
24
|
-
Overlay1Visitor,
|
|
25
|
-
RuleInstanceConfig,
|
|
26
|
-
} from './visitors';
|
|
27
|
-
import type { CollectFn } from './utils';
|
|
28
|
-
|
|
29
|
-
export async function lint(opts: {
|
|
30
|
-
ref: string;
|
|
31
|
-
config: Config;
|
|
32
|
-
externalRefResolver?: BaseResolver;
|
|
33
|
-
collectSpecData?: CollectFn;
|
|
34
|
-
}) {
|
|
35
|
-
const { ref, externalRefResolver = new BaseResolver(opts.config.resolve) } = opts;
|
|
36
|
-
const document = (await externalRefResolver.resolveDocument(null, ref, true)) as Document;
|
|
37
|
-
opts.collectSpecData?.(document.parsed);
|
|
38
|
-
|
|
39
|
-
return lintDocument({
|
|
40
|
-
document,
|
|
41
|
-
...opts,
|
|
42
|
-
externalRefResolver,
|
|
43
|
-
config: opts.config.styleguide,
|
|
44
|
-
});
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
export async function lintFromString(opts: {
|
|
48
|
-
source: string;
|
|
49
|
-
absoluteRef?: string;
|
|
50
|
-
config: Config;
|
|
51
|
-
externalRefResolver?: BaseResolver;
|
|
52
|
-
}) {
|
|
53
|
-
const { source, absoluteRef, externalRefResolver = new BaseResolver(opts.config.resolve) } = opts;
|
|
54
|
-
const document = makeDocumentFromString(source, absoluteRef || '/');
|
|
55
|
-
|
|
56
|
-
return lintDocument({
|
|
57
|
-
document,
|
|
58
|
-
...opts,
|
|
59
|
-
externalRefResolver,
|
|
60
|
-
config: opts.config.styleguide,
|
|
61
|
-
});
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
export async function lintDocument(opts: {
|
|
65
|
-
document: Document;
|
|
66
|
-
config: StyleguideConfig;
|
|
67
|
-
customTypes?: Record<string, NodeType>;
|
|
68
|
-
externalRefResolver: BaseResolver;
|
|
69
|
-
}) {
|
|
70
|
-
releaseAjvInstance(); // FIXME: preprocessors can modify nodes which are then cached to ajv-instance by absolute path
|
|
71
|
-
|
|
72
|
-
const { document, customTypes, externalRefResolver, config } = opts;
|
|
73
|
-
const specVersion = detectSpec(document.parsed);
|
|
74
|
-
const specMajorVersion = getMajorSpecVersion(specVersion);
|
|
75
|
-
const rules = config.getRulesForSpecVersion(specMajorVersion);
|
|
76
|
-
const types = normalizeTypes(
|
|
77
|
-
config.extendTypes(customTypes ?? getTypes(specVersion), specVersion),
|
|
78
|
-
config
|
|
79
|
-
);
|
|
80
|
-
|
|
81
|
-
const ctx: WalkContext = {
|
|
82
|
-
problems: [],
|
|
83
|
-
oasVersion: specVersion,
|
|
84
|
-
visitorsData: {},
|
|
85
|
-
};
|
|
86
|
-
|
|
87
|
-
const preprocessors = initRules(rules, config, 'preprocessors', specVersion);
|
|
88
|
-
const regularRules = initRules(rules, config, 'rules', specVersion);
|
|
89
|
-
|
|
90
|
-
let resolvedRefMap = await resolveDocument({
|
|
91
|
-
rootDocument: document,
|
|
92
|
-
rootType: types.Root,
|
|
93
|
-
externalRefResolver,
|
|
94
|
-
});
|
|
95
|
-
|
|
96
|
-
if (preprocessors.length > 0) {
|
|
97
|
-
// Make additional pass to resolve refs defined in preprocessors.
|
|
98
|
-
walkDocument({
|
|
99
|
-
document,
|
|
100
|
-
rootType: types.Root,
|
|
101
|
-
normalizedVisitors: normalizeVisitors(preprocessors, types),
|
|
102
|
-
resolvedRefMap,
|
|
103
|
-
ctx,
|
|
104
|
-
});
|
|
105
|
-
resolvedRefMap = await resolveDocument({
|
|
106
|
-
rootDocument: document,
|
|
107
|
-
rootType: types.Root,
|
|
108
|
-
externalRefResolver,
|
|
109
|
-
});
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
const normalizedVisitors = normalizeVisitors(regularRules, types);
|
|
113
|
-
|
|
114
|
-
walkDocument({
|
|
115
|
-
document,
|
|
116
|
-
rootType: types.Root,
|
|
117
|
-
normalizedVisitors,
|
|
118
|
-
resolvedRefMap,
|
|
119
|
-
ctx,
|
|
120
|
-
});
|
|
121
|
-
return ctx.problems.map((problem) => config.addProblemToIgnore(problem));
|
|
122
|
-
}
|
|
123
|
-
|
|
124
|
-
export async function lintConfig(opts: {
|
|
125
|
-
document: Document;
|
|
126
|
-
config: Config;
|
|
127
|
-
resolvedRefMap?: ResolvedRefMap;
|
|
128
|
-
severity?: ProblemSeverity;
|
|
129
|
-
externalRefResolver?: BaseResolver;
|
|
130
|
-
externalConfigTypes?: Record<string, NodeType>;
|
|
131
|
-
}) {
|
|
132
|
-
const { document, severity, externalRefResolver = new BaseResolver(), config } = opts;
|
|
133
|
-
|
|
134
|
-
const ctx: WalkContext = {
|
|
135
|
-
problems: [],
|
|
136
|
-
oasVersion: SpecVersion.OAS3_0,
|
|
137
|
-
visitorsData: {},
|
|
138
|
-
};
|
|
139
|
-
|
|
140
|
-
const types = normalizeTypes(
|
|
141
|
-
opts.externalConfigTypes || createConfigTypes(rootRedoclyConfigSchema, config),
|
|
142
|
-
{ doNotResolveExamples: config.styleguide.doNotResolveExamples }
|
|
143
|
-
);
|
|
144
|
-
|
|
145
|
-
const rules: (RuleInstanceConfig & {
|
|
146
|
-
visitor: NestedVisitObject<
|
|
147
|
-
unknown,
|
|
148
|
-
| Oas3Visitor
|
|
149
|
-
| Oas3Visitor[]
|
|
150
|
-
| Oas2Visitor
|
|
151
|
-
| Oas2Visitor[]
|
|
152
|
-
| Async2Visitor
|
|
153
|
-
| Async2Visitor[]
|
|
154
|
-
| Async3Visitor
|
|
155
|
-
| Async3Visitor[]
|
|
156
|
-
| Arazzo1Visitor
|
|
157
|
-
| Arazzo1Visitor[]
|
|
158
|
-
| Overlay1Visitor
|
|
159
|
-
| Overlay1Visitor[]
|
|
160
|
-
>;
|
|
161
|
-
})[] = [
|
|
162
|
-
{
|
|
163
|
-
severity: severity || 'error',
|
|
164
|
-
ruleId: 'configuration spec',
|
|
165
|
-
visitor: Struct({ severity: 'error' }),
|
|
166
|
-
},
|
|
167
|
-
{
|
|
168
|
-
severity: severity || 'error',
|
|
169
|
-
ruleId: 'configuration no-unresolved-refs',
|
|
170
|
-
visitor: NoUnresolvedRefs({ severity: 'error' }),
|
|
171
|
-
},
|
|
172
|
-
];
|
|
173
|
-
const normalizedVisitors = normalizeVisitors(rules, types);
|
|
174
|
-
const resolvedRefMap =
|
|
175
|
-
opts.resolvedRefMap ||
|
|
176
|
-
(await resolveDocument({
|
|
177
|
-
rootDocument: document,
|
|
178
|
-
rootType: types.ConfigRoot,
|
|
179
|
-
externalRefResolver,
|
|
180
|
-
}));
|
|
181
|
-
walkDocument({
|
|
182
|
-
document,
|
|
183
|
-
rootType: types.ConfigRoot,
|
|
184
|
-
normalizedVisitors,
|
|
185
|
-
resolvedRefMap,
|
|
186
|
-
ctx,
|
|
187
|
-
});
|
|
188
|
-
|
|
189
|
-
return ctx.problems;
|
|
190
|
-
}
|
package/src/logger.ts
DELETED
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
import * as colorette from 'colorette';
|
|
2
|
-
import { isBrowser } from './env';
|
|
3
|
-
import { identity } from './utils';
|
|
4
|
-
|
|
5
|
-
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
6
|
-
// @ts-ignore this works but some types are not working
|
|
7
|
-
export const colorOptions = colorette.options;
|
|
8
|
-
|
|
9
|
-
export const colorize = new Proxy(colorette, {
|
|
10
|
-
get(target: typeof colorette, prop: string): typeof identity {
|
|
11
|
-
if (isBrowser) {
|
|
12
|
-
return identity;
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
return (target as any)[prop];
|
|
16
|
-
},
|
|
17
|
-
});
|
|
18
|
-
class Logger {
|
|
19
|
-
protected stderr(str: string) {
|
|
20
|
-
return process.stderr.write(str);
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
info(str: string) {
|
|
24
|
-
return isBrowser ? console.log(str) : this.stderr(str);
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
warn(str: string) {
|
|
28
|
-
return isBrowser ? console.warn(str) : this.stderr(colorize.yellow(str));
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
error(str: string) {
|
|
32
|
-
return isBrowser ? console.error(str) : this.stderr(colorize.red(str));
|
|
33
|
-
}
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
export const logger = new Logger();
|
package/src/oas-types.ts
DELETED
|
@@ -1,178 +0,0 @@
|
|
|
1
|
-
import { Oas2Types } from './types/oas2';
|
|
2
|
-
import { Oas3Types } from './types/oas3';
|
|
3
|
-
import { Oas3_1Types } from './types/oas3_1';
|
|
4
|
-
import { AsyncApi2Types } from './types/asyncapi2';
|
|
5
|
-
import { AsyncApi3Types } from './types/asyncapi3';
|
|
6
|
-
import { Arazzo1Types } from './types/arazzo';
|
|
7
|
-
import { Overlay1Types } from './types/overlay';
|
|
8
|
-
import { isPlainObject } from './utils';
|
|
9
|
-
import { VERSION_PATTERN } from './typings/arazzo';
|
|
10
|
-
|
|
11
|
-
import type {
|
|
12
|
-
BuiltInAsync2RuleId,
|
|
13
|
-
BuiltInAsync3RuleId,
|
|
14
|
-
BuiltInArazzo1RuleId,
|
|
15
|
-
BuiltInOAS2RuleId,
|
|
16
|
-
BuiltInOAS3RuleId,
|
|
17
|
-
BuiltInOverlay1RuleId,
|
|
18
|
-
} from './types/redocly-yaml';
|
|
19
|
-
import type {
|
|
20
|
-
Oas3Rule,
|
|
21
|
-
Oas3Preprocessor,
|
|
22
|
-
Oas2Rule,
|
|
23
|
-
Oas2Preprocessor,
|
|
24
|
-
Async2Preprocessor,
|
|
25
|
-
Async2Rule,
|
|
26
|
-
Async3Preprocessor,
|
|
27
|
-
Async3Rule,
|
|
28
|
-
Arazzo1Preprocessor,
|
|
29
|
-
Arazzo1Rule,
|
|
30
|
-
Overlay1Preprocessor,
|
|
31
|
-
Overlay1Rule,
|
|
32
|
-
} from './visitors';
|
|
33
|
-
|
|
34
|
-
export enum SpecVersion {
|
|
35
|
-
OAS2 = 'oas2',
|
|
36
|
-
OAS3_0 = 'oas3_0',
|
|
37
|
-
OAS3_1 = 'oas3_1',
|
|
38
|
-
Async2 = 'async2',
|
|
39
|
-
Async3 = 'async3',
|
|
40
|
-
Arazzo1 = 'arazzo1',
|
|
41
|
-
Overlay1 = 'overlay1',
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
export enum SpecMajorVersion {
|
|
45
|
-
OAS2 = 'oas2',
|
|
46
|
-
OAS3 = 'oas3',
|
|
47
|
-
Async2 = 'async2',
|
|
48
|
-
Async3 = 'async3',
|
|
49
|
-
Arazzo1 = 'arazzo1',
|
|
50
|
-
Overlay1 = 'overlay1',
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
const typesMap = {
|
|
54
|
-
[SpecVersion.OAS2]: Oas2Types,
|
|
55
|
-
[SpecVersion.OAS3_0]: Oas3Types,
|
|
56
|
-
[SpecVersion.OAS3_1]: Oas3_1Types,
|
|
57
|
-
[SpecVersion.Async2]: AsyncApi2Types,
|
|
58
|
-
[SpecVersion.Async3]: AsyncApi3Types,
|
|
59
|
-
[SpecVersion.Arazzo1]: Arazzo1Types,
|
|
60
|
-
[SpecVersion.Overlay1]: Overlay1Types,
|
|
61
|
-
};
|
|
62
|
-
|
|
63
|
-
export type RuleMap<Key extends string, RuleConfig, T> = Record<
|
|
64
|
-
T extends 'built-in' ? Key : string,
|
|
65
|
-
RuleConfig
|
|
66
|
-
>;
|
|
67
|
-
export type Oas3RuleSet<T = undefined> = RuleMap<
|
|
68
|
-
BuiltInOAS3RuleId | 'struct' | 'assertions',
|
|
69
|
-
Oas3Rule,
|
|
70
|
-
T
|
|
71
|
-
>;
|
|
72
|
-
export type Oas2RuleSet<T = undefined> = RuleMap<
|
|
73
|
-
BuiltInOAS2RuleId | 'struct' | 'assertions',
|
|
74
|
-
Oas2Rule,
|
|
75
|
-
T
|
|
76
|
-
>;
|
|
77
|
-
export type Async2RuleSet<T = undefined> = RuleMap<
|
|
78
|
-
BuiltInAsync2RuleId | 'struct' | 'assertions',
|
|
79
|
-
Async2Rule,
|
|
80
|
-
T
|
|
81
|
-
>;
|
|
82
|
-
export type Async3RuleSet<T = undefined> = RuleMap<
|
|
83
|
-
BuiltInAsync3RuleId | 'struct' | 'assertions',
|
|
84
|
-
Async3Rule,
|
|
85
|
-
T
|
|
86
|
-
>;
|
|
87
|
-
export type Arazzo1RuleSet<T = undefined> = RuleMap<
|
|
88
|
-
BuiltInArazzo1RuleId | 'struct' | 'assertions',
|
|
89
|
-
Arazzo1Rule,
|
|
90
|
-
T
|
|
91
|
-
>;
|
|
92
|
-
|
|
93
|
-
export type Overlay1RuleSet<T = undefined> = RuleMap<
|
|
94
|
-
BuiltInOverlay1RuleId | 'struct' | 'assertions',
|
|
95
|
-
Overlay1Rule,
|
|
96
|
-
T
|
|
97
|
-
>;
|
|
98
|
-
export type Oas3PreprocessorsSet = Record<string, Oas3Preprocessor>;
|
|
99
|
-
export type Oas2PreprocessorsSet = Record<string, Oas2Preprocessor>;
|
|
100
|
-
export type Async2PreprocessorsSet = Record<string, Async2Preprocessor>;
|
|
101
|
-
export type Async3PreprocessorsSet = Record<string, Async3Preprocessor>;
|
|
102
|
-
export type Arazzo1PreprocessorsSet = Record<string, Arazzo1Preprocessor>;
|
|
103
|
-
export type Overlay1PreprocessorsSet = Record<string, Overlay1Preprocessor>;
|
|
104
|
-
|
|
105
|
-
export type Oas3DecoratorsSet = Record<string, Oas3Preprocessor>;
|
|
106
|
-
export type Oas2DecoratorsSet = Record<string, Oas2Preprocessor>;
|
|
107
|
-
export type Async2DecoratorsSet = Record<string, Async2Preprocessor>;
|
|
108
|
-
export type Async3DecoratorsSet = Record<string, Async3Preprocessor>;
|
|
109
|
-
export type Arazzo1DecoratorsSet = Record<string, Arazzo1Preprocessor>;
|
|
110
|
-
export type Overlay1DecoratorsSet = Record<string, Overlay1Preprocessor>;
|
|
111
|
-
|
|
112
|
-
export function detectSpec(root: unknown): SpecVersion {
|
|
113
|
-
if (!isPlainObject(root)) {
|
|
114
|
-
throw new Error(`Document must be JSON object, got ${typeof root}`);
|
|
115
|
-
}
|
|
116
|
-
|
|
117
|
-
if (root.openapi && typeof root.openapi !== 'string') {
|
|
118
|
-
throw new Error(`Invalid OpenAPI version: should be a string but got "${typeof root.openapi}"`);
|
|
119
|
-
}
|
|
120
|
-
|
|
121
|
-
if (typeof root.openapi === 'string' && root.openapi.startsWith('3.0')) {
|
|
122
|
-
return SpecVersion.OAS3_0;
|
|
123
|
-
}
|
|
124
|
-
|
|
125
|
-
if (typeof root.openapi === 'string' && root.openapi.startsWith('3.1')) {
|
|
126
|
-
return SpecVersion.OAS3_1;
|
|
127
|
-
}
|
|
128
|
-
|
|
129
|
-
if (root.swagger && root.swagger === '2.0') {
|
|
130
|
-
return SpecVersion.OAS2;
|
|
131
|
-
}
|
|
132
|
-
|
|
133
|
-
if (root.openapi || root.swagger) {
|
|
134
|
-
throw new Error(`Unsupported OpenAPI version: ${root.openapi || root.swagger}`);
|
|
135
|
-
}
|
|
136
|
-
|
|
137
|
-
if (typeof root.asyncapi === 'string' && root.asyncapi.startsWith('2.')) {
|
|
138
|
-
return SpecVersion.Async2;
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
if (typeof root.asyncapi === 'string' && root.asyncapi.startsWith('3.')) {
|
|
142
|
-
return SpecVersion.Async3;
|
|
143
|
-
}
|
|
144
|
-
|
|
145
|
-
if (root.asyncapi) {
|
|
146
|
-
throw new Error(`Unsupported AsyncAPI version: ${root.asyncapi}`);
|
|
147
|
-
}
|
|
148
|
-
|
|
149
|
-
if (typeof root.arazzo === 'string' && VERSION_PATTERN.test(root.arazzo)) {
|
|
150
|
-
return SpecVersion.Arazzo1;
|
|
151
|
-
}
|
|
152
|
-
|
|
153
|
-
if (typeof root.overlay === 'string' && VERSION_PATTERN.test(root.overlay)) {
|
|
154
|
-
return SpecVersion.Overlay1;
|
|
155
|
-
}
|
|
156
|
-
|
|
157
|
-
throw new Error(`Unsupported specification`);
|
|
158
|
-
}
|
|
159
|
-
|
|
160
|
-
export function getMajorSpecVersion(version: SpecVersion): SpecMajorVersion {
|
|
161
|
-
if (version === SpecVersion.OAS2) {
|
|
162
|
-
return SpecMajorVersion.OAS2;
|
|
163
|
-
} else if (version === SpecVersion.Async2) {
|
|
164
|
-
return SpecMajorVersion.Async2;
|
|
165
|
-
} else if (version === SpecVersion.Async3) {
|
|
166
|
-
return SpecMajorVersion.Async3;
|
|
167
|
-
} else if (version === SpecVersion.Arazzo1) {
|
|
168
|
-
return SpecMajorVersion.Arazzo1;
|
|
169
|
-
} else if (version === SpecVersion.Overlay1) {
|
|
170
|
-
return SpecMajorVersion.Overlay1;
|
|
171
|
-
} else {
|
|
172
|
-
return SpecMajorVersion.OAS3;
|
|
173
|
-
}
|
|
174
|
-
}
|
|
175
|
-
|
|
176
|
-
export function getTypes(spec: SpecVersion) {
|
|
177
|
-
return typesMap[spec];
|
|
178
|
-
}
|
package/src/output.ts
DELETED
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
import { RedoclyClient } from '../../index';
|
|
2
|
-
import { setRedoclyDomain, getRedoclyDomain, getDomains, AVAILABLE_REGIONS } from '../domains';
|
|
3
|
-
|
|
4
|
-
describe('domains', () => {
|
|
5
|
-
const REDOCLY_DOMAIN_US = 'redocly.com';
|
|
6
|
-
const TEST_DOMAIN = 'redoclyDomain.com';
|
|
7
|
-
const TEST_LAB_DOMAIN = 'lab.redocly.host';
|
|
8
|
-
const TEST_REDOC_ONLINE_DOMAIN = 'redoc.online';
|
|
9
|
-
|
|
10
|
-
afterEach(() => {
|
|
11
|
-
delete process.env.REDOCLY_DOMAIN;
|
|
12
|
-
setRedoclyDomain('');
|
|
13
|
-
});
|
|
14
|
-
|
|
15
|
-
it('should resolve the US domain by default', () => {
|
|
16
|
-
expect(getRedoclyDomain()).toBe(REDOCLY_DOMAIN_US);
|
|
17
|
-
});
|
|
18
|
-
|
|
19
|
-
it('should resolve the US and EU regions by default', () => {
|
|
20
|
-
expect(AVAILABLE_REGIONS).toStrictEqual(['us', 'eu']);
|
|
21
|
-
});
|
|
22
|
-
|
|
23
|
-
it('should resolve the specified domain if used with setter', () => {
|
|
24
|
-
setRedoclyDomain(TEST_DOMAIN);
|
|
25
|
-
expect(getRedoclyDomain()).toBe(TEST_DOMAIN);
|
|
26
|
-
});
|
|
27
|
-
|
|
28
|
-
it('should resolve the specified domain provided in environmental variable, after initializing RedoclyClient', () => {
|
|
29
|
-
process.env.REDOCLY_DOMAIN = TEST_DOMAIN;
|
|
30
|
-
const client = new RedoclyClient();
|
|
31
|
-
expect(getRedoclyDomain()).toBe(TEST_DOMAIN);
|
|
32
|
-
expect(client.domain).toBe(TEST_DOMAIN);
|
|
33
|
-
});
|
|
34
|
-
|
|
35
|
-
it('should return correct object when redocly domain is set to lab env', () => {
|
|
36
|
-
setRedoclyDomain(TEST_LAB_DOMAIN);
|
|
37
|
-
const domains = getDomains();
|
|
38
|
-
expect(domains).toEqual({ us: 'redocly.com', eu: 'eu.redocly.com', lab: 'lab.redocly.host' });
|
|
39
|
-
expect(getRedoclyDomain()).toBe(TEST_LAB_DOMAIN);
|
|
40
|
-
});
|
|
41
|
-
|
|
42
|
-
it('should return correct object when redocly domain is set to redoc.online env', () => {
|
|
43
|
-
setRedoclyDomain(TEST_REDOC_ONLINE_DOMAIN);
|
|
44
|
-
const domains = getDomains();
|
|
45
|
-
expect(domains).toEqual({
|
|
46
|
-
us: 'redocly.com',
|
|
47
|
-
eu: 'eu.redocly.com',
|
|
48
|
-
'redoc.online': 'redoc.online',
|
|
49
|
-
});
|
|
50
|
-
expect(getRedoclyDomain()).toBe(TEST_REDOC_ONLINE_DOMAIN);
|
|
51
|
-
});
|
|
52
|
-
});
|
|
@@ -1,156 +0,0 @@
|
|
|
1
|
-
import { setRedoclyDomain } from '../domains';
|
|
2
|
-
import { RedoclyClient } from '../index';
|
|
3
|
-
|
|
4
|
-
const originalFetch = global.fetch;
|
|
5
|
-
|
|
6
|
-
describe('RedoclyClient', () => {
|
|
7
|
-
const REDOCLY_DOMAIN_US = 'redocly.com';
|
|
8
|
-
const REDOCLY_DOMAIN_EU = 'eu.redocly.com';
|
|
9
|
-
const REDOCLY_AUTHORIZATION_TOKEN = 'redocly-auth-token';
|
|
10
|
-
const testRedoclyDomain = 'redoclyDomain.com';
|
|
11
|
-
const testToken = 'test-token';
|
|
12
|
-
|
|
13
|
-
beforeAll(() => {
|
|
14
|
-
global.fetch = jest.fn(() =>
|
|
15
|
-
Promise.resolve({
|
|
16
|
-
ok: true,
|
|
17
|
-
json: jest.fn().mockResolvedValue({}),
|
|
18
|
-
} as any)
|
|
19
|
-
);
|
|
20
|
-
});
|
|
21
|
-
|
|
22
|
-
afterAll(() => {
|
|
23
|
-
global.fetch = originalFetch;
|
|
24
|
-
});
|
|
25
|
-
|
|
26
|
-
afterEach(() => {
|
|
27
|
-
delete process.env.REDOCLY_DOMAIN;
|
|
28
|
-
setRedoclyDomain('');
|
|
29
|
-
});
|
|
30
|
-
|
|
31
|
-
it('should resolve the US domain by default', () => {
|
|
32
|
-
const client = new RedoclyClient();
|
|
33
|
-
expect(client.domain).toBe(REDOCLY_DOMAIN_US);
|
|
34
|
-
});
|
|
35
|
-
|
|
36
|
-
it('should resolve domain from RedoclyDomain env', () => {
|
|
37
|
-
process.env.REDOCLY_DOMAIN = testRedoclyDomain;
|
|
38
|
-
const client = new RedoclyClient();
|
|
39
|
-
expect(client.domain).toBe(testRedoclyDomain);
|
|
40
|
-
});
|
|
41
|
-
|
|
42
|
-
it('should resolve a domain by US region', () => {
|
|
43
|
-
const client = new RedoclyClient('us');
|
|
44
|
-
expect(client.domain).toBe(REDOCLY_DOMAIN_US);
|
|
45
|
-
});
|
|
46
|
-
|
|
47
|
-
it('should resolve a domain by EU region', () => {
|
|
48
|
-
const client = new RedoclyClient('eu');
|
|
49
|
-
expect(client.domain).toBe(REDOCLY_DOMAIN_EU);
|
|
50
|
-
});
|
|
51
|
-
|
|
52
|
-
it('should resolve domain by EU region prioritizing flag over env variable', () => {
|
|
53
|
-
setRedoclyDomain(testRedoclyDomain);
|
|
54
|
-
const client = new RedoclyClient('eu');
|
|
55
|
-
expect(client.domain).toBe(REDOCLY_DOMAIN_EU);
|
|
56
|
-
});
|
|
57
|
-
|
|
58
|
-
it('should resolve domain by US region prioritizing flag over env variable', () => {
|
|
59
|
-
setRedoclyDomain(testRedoclyDomain);
|
|
60
|
-
const client = new RedoclyClient('us');
|
|
61
|
-
expect(client.domain).toBe(REDOCLY_DOMAIN_US);
|
|
62
|
-
});
|
|
63
|
-
|
|
64
|
-
it('should resolve domain by US region when REDOCLY_DOMAIN consists EU domain', () => {
|
|
65
|
-
setRedoclyDomain(REDOCLY_DOMAIN_EU);
|
|
66
|
-
const client = new RedoclyClient();
|
|
67
|
-
expect(client.getRegion()).toBe('eu');
|
|
68
|
-
});
|
|
69
|
-
|
|
70
|
-
it('should resolve all tokens', async () => {
|
|
71
|
-
let spy = jest.spyOn(RedoclyClient.prototype, 'readCredentialsFile').mockImplementation(() => {
|
|
72
|
-
return { token: 'accessToken', us: 'accessToken', eu: 'eu-accessToken' };
|
|
73
|
-
});
|
|
74
|
-
const client = new RedoclyClient();
|
|
75
|
-
const tokens = client.getAllTokens();
|
|
76
|
-
expect(tokens).toStrictEqual([
|
|
77
|
-
{ region: 'us', token: 'accessToken' },
|
|
78
|
-
{ region: 'eu', token: 'eu-accessToken' },
|
|
79
|
-
]);
|
|
80
|
-
spy.mockRestore();
|
|
81
|
-
});
|
|
82
|
-
|
|
83
|
-
it('should resolve valid tokens data', async () => {
|
|
84
|
-
let spy = jest.spyOn(RedoclyClient.prototype, 'readCredentialsFile').mockImplementation(() => {
|
|
85
|
-
return { us: 'accessToken', eu: 'eu-accessToken' };
|
|
86
|
-
});
|
|
87
|
-
const client = new RedoclyClient();
|
|
88
|
-
const tokens = await client.getValidTokens();
|
|
89
|
-
expect(tokens).toStrictEqual([
|
|
90
|
-
{ region: 'us', token: 'accessToken', valid: true },
|
|
91
|
-
{ region: 'eu', token: 'eu-accessToken', valid: true },
|
|
92
|
-
]);
|
|
93
|
-
spy.mockRestore();
|
|
94
|
-
});
|
|
95
|
-
|
|
96
|
-
it('should not call setAccessTokens by default', () => {
|
|
97
|
-
let spy = jest
|
|
98
|
-
.spyOn(RedoclyClient.prototype, 'readCredentialsFile')
|
|
99
|
-
.mockImplementation(() => ({}));
|
|
100
|
-
jest.spyOn(RedoclyClient.prototype, 'setAccessTokens').mockImplementation();
|
|
101
|
-
const client = new RedoclyClient();
|
|
102
|
-
expect(client.setAccessTokens).not.toHaveBeenCalled();
|
|
103
|
-
spy.mockRestore();
|
|
104
|
-
});
|
|
105
|
-
|
|
106
|
-
it('should set correct accessTokens - backward compatibility: default US region', () => {
|
|
107
|
-
let spy = jest
|
|
108
|
-
.spyOn(RedoclyClient.prototype, 'readCredentialsFile')
|
|
109
|
-
.mockImplementation(() => ({ token: testToken }));
|
|
110
|
-
jest.spyOn(RedoclyClient.prototype, 'setAccessTokens').mockImplementation();
|
|
111
|
-
const client = new RedoclyClient();
|
|
112
|
-
expect(client.setAccessTokens).toBeCalledWith(expect.objectContaining({ us: testToken }));
|
|
113
|
-
spy.mockRestore();
|
|
114
|
-
});
|
|
115
|
-
|
|
116
|
-
it('should set correct accessTokens - backward compatibility: EU region', () => {
|
|
117
|
-
let spy = jest
|
|
118
|
-
.spyOn(RedoclyClient.prototype, 'readCredentialsFile')
|
|
119
|
-
.mockImplementation(() => ({ token: testToken }));
|
|
120
|
-
jest.spyOn(RedoclyClient.prototype, 'setAccessTokens').mockImplementation();
|
|
121
|
-
const client = new RedoclyClient('eu');
|
|
122
|
-
expect(client.setAccessTokens).toBeCalledWith(expect.objectContaining({ eu: testToken }));
|
|
123
|
-
spy.mockRestore();
|
|
124
|
-
});
|
|
125
|
-
|
|
126
|
-
it('should set correct accessTokens - REDOCLY_AUTHORIZATION env', () => {
|
|
127
|
-
process.env.REDOCLY_AUTHORIZATION = REDOCLY_AUTHORIZATION_TOKEN;
|
|
128
|
-
let spy = jest.spyOn(RedoclyClient.prototype, 'readCredentialsFile').mockImplementation();
|
|
129
|
-
jest.spyOn(RedoclyClient.prototype, 'setAccessTokens').mockImplementation();
|
|
130
|
-
const client = new RedoclyClient();
|
|
131
|
-
expect(client.setAccessTokens).toHaveBeenNthCalledWith(1, { us: REDOCLY_AUTHORIZATION_TOKEN });
|
|
132
|
-
spy.mockRestore();
|
|
133
|
-
});
|
|
134
|
-
|
|
135
|
-
it('should set correct accessTokens prioritizing REDOCLY_AUTHORIZATION env over token in file', () => {
|
|
136
|
-
process.env.REDOCLY_AUTHORIZATION = REDOCLY_AUTHORIZATION_TOKEN;
|
|
137
|
-
let spy = jest
|
|
138
|
-
.spyOn(RedoclyClient.prototype, 'readCredentialsFile')
|
|
139
|
-
.mockImplementation(() => ({ token: testToken }));
|
|
140
|
-
jest.spyOn(RedoclyClient.prototype, 'setAccessTokens').mockImplementation();
|
|
141
|
-
const client = new RedoclyClient();
|
|
142
|
-
expect(client.setAccessTokens).toHaveBeenNthCalledWith(2, { us: REDOCLY_AUTHORIZATION_TOKEN });
|
|
143
|
-
spy.mockRestore();
|
|
144
|
-
});
|
|
145
|
-
|
|
146
|
-
it('should set correct accessTokens prioritizing REDOCLY_AUTHORIZATION env over EU token', () => {
|
|
147
|
-
process.env.REDOCLY_AUTHORIZATION = REDOCLY_AUTHORIZATION_TOKEN;
|
|
148
|
-
let spy = jest
|
|
149
|
-
.spyOn(RedoclyClient.prototype, 'readCredentialsFile')
|
|
150
|
-
.mockImplementation(() => ({ us: testToken }));
|
|
151
|
-
jest.spyOn(RedoclyClient.prototype, 'setAccessTokens').mockImplementation();
|
|
152
|
-
const client = new RedoclyClient('eu');
|
|
153
|
-
expect(client.setAccessTokens).toHaveBeenNthCalledWith(2, { eu: REDOCLY_AUTHORIZATION_TOKEN });
|
|
154
|
-
spy.mockRestore();
|
|
155
|
-
});
|
|
156
|
-
});
|
package/src/redocly/domains.ts
DELETED
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
import type { Region } from '../config/types';
|
|
2
|
-
|
|
3
|
-
let redoclyDomain = 'redocly.com';
|
|
4
|
-
|
|
5
|
-
export const DEFAULT_REGION = 'us';
|
|
6
|
-
|
|
7
|
-
export const DOMAINS = getDomains();
|
|
8
|
-
export const AVAILABLE_REGIONS = Object.keys(DOMAINS) as Region[];
|
|
9
|
-
|
|
10
|
-
export function getDomains() {
|
|
11
|
-
const domains: { [region in Region]: string } = {
|
|
12
|
-
us: 'redocly.com',
|
|
13
|
-
eu: 'eu.redocly.com',
|
|
14
|
-
};
|
|
15
|
-
|
|
16
|
-
// FIXME: temporary fix for our lab environments
|
|
17
|
-
const domain = redoclyDomain;
|
|
18
|
-
if (domain?.endsWith('.redocly.host')) {
|
|
19
|
-
domains[domain.split('.')[0] as Region] = domain;
|
|
20
|
-
}
|
|
21
|
-
if (domain === 'redoc.online') {
|
|
22
|
-
domains[domain as Region] = domain;
|
|
23
|
-
}
|
|
24
|
-
return domains;
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
export function setRedoclyDomain(domain: string) {
|
|
28
|
-
redoclyDomain = domain;
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
export function getRedoclyDomain(): string {
|
|
32
|
-
return redoclyDomain;
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
export function isRedoclyRegistryURL(link: string): boolean {
|
|
36
|
-
const domain = getRedoclyDomain() || DOMAINS[DEFAULT_REGION];
|
|
37
|
-
|
|
38
|
-
const legacyDomain = domain === 'redocly.com' ? 'redoc.ly' : domain;
|
|
39
|
-
|
|
40
|
-
if (
|
|
41
|
-
!link.startsWith(`https://api.${domain}/registry/`) &&
|
|
42
|
-
!link.startsWith(`https://api.${legacyDomain}/registry/`)
|
|
43
|
-
) {
|
|
44
|
-
return false;
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
return true;
|
|
48
|
-
}
|