openapi-typesafe 1.0.0-rc.4 → 1.0.0-rc.5
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/CHANGELOG.md +141 -0
- package/dist/adapters/node-file-system/node-file-system.cjs +7 -0
- package/dist/adapters/node-file-system/node-file-system.cjs.map +1 -1
- package/dist/adapters/node-file-system/node-file-system.mjs +7 -0
- package/dist/adapters/node-file-system/node-file-system.mjs.map +1 -1
- package/dist/adapters/pipe-safe-writer/pipe-safe-writer.cjs +19 -0
- package/dist/adapters/pipe-safe-writer/pipe-safe-writer.cjs.map +1 -0
- package/dist/adapters/pipe-safe-writer/pipe-safe-writer.mjs +17 -0
- package/dist/adapters/pipe-safe-writer/pipe-safe-writer.mjs.map +1 -0
- package/dist/adapters/redocly-loader/bundled-mapping-copies.cjs +5 -32
- package/dist/adapters/redocly-loader/bundled-mapping-copies.cjs.map +1 -1
- package/dist/adapters/redocly-loader/bundled-mapping-copies.mjs +6 -33
- package/dist/adapters/redocly-loader/bundled-mapping-copies.mjs.map +1 -1
- package/dist/adapters/redocly-loader/component-schemas.cjs +17 -0
- package/dist/adapters/redocly-loader/component-schemas.cjs.map +1 -0
- package/dist/adapters/redocly-loader/component-schemas.mjs +14 -0
- package/dist/adapters/redocly-loader/component-schemas.mjs.map +1 -0
- package/dist/adapters/redocly-loader/mapping-schema-names.cjs +22 -0
- package/dist/adapters/redocly-loader/mapping-schema-names.cjs.map +1 -0
- package/dist/adapters/redocly-loader/mapping-schema-names.mjs +20 -0
- package/dist/adapters/redocly-loader/mapping-schema-names.mjs.map +1 -0
- package/dist/adapters/redocly-loader/query-named-components.cjs +137 -0
- package/dist/adapters/redocly-loader/query-named-components.cjs.map +1 -0
- package/dist/adapters/redocly-loader/query-named-components.mjs +134 -0
- package/dist/adapters/redocly-loader/query-named-components.mjs.map +1 -0
- package/dist/adapters/redocly-loader/redocly-schema-loader.cjs +26 -14
- package/dist/adapters/redocly-loader/redocly-schema-loader.cjs.map +1 -1
- package/dist/adapters/redocly-loader/redocly-schema-loader.mjs +26 -14
- package/dist/adapters/redocly-loader/redocly-schema-loader.mjs.map +1 -1
- package/dist/adapters/redocly-loader/ref-access.cjs +16 -3
- package/dist/adapters/redocly-loader/ref-access.cjs.map +1 -1
- package/dist/adapters/redocly-loader/ref-access.mjs +16 -3
- package/dist/adapters/redocly-loader/ref-access.mjs.map +1 -1
- package/dist/adapters/redocly-loader/ref-holders.cjs +52 -10
- package/dist/adapters/redocly-loader/ref-holders.cjs.map +1 -1
- package/dist/adapters/redocly-loader/ref-holders.mjs +52 -11
- package/dist/adapters/redocly-loader/ref-holders.mjs.map +1 -1
- package/dist/adapters/redocly-loader/remote-fetch.cjs +5 -3
- package/dist/adapters/redocly-loader/remote-fetch.cjs.map +1 -1
- package/dist/adapters/redocly-loader/remote-fetch.mjs +5 -3
- package/dist/adapters/redocly-loader/remote-fetch.mjs.map +1 -1
- package/dist/adapters/redocly-loader/remote-node-limit.cjs +17 -3
- package/dist/adapters/redocly-loader/remote-node-limit.cjs.map +1 -1
- package/dist/adapters/redocly-loader/remote-node-limit.mjs +17 -3
- package/dist/adapters/redocly-loader/remote-node-limit.mjs.map +1 -1
- package/dist/adapters/redocly-loader/schema-source.cjs +7 -2
- package/dist/adapters/redocly-loader/schema-source.cjs.map +1 -1
- package/dist/adapters/redocly-loader/schema-source.mjs +8 -3
- package/dist/adapters/redocly-loader/schema-source.mjs.map +1 -1
- package/dist/adapters/terminal-logger/terminal-logger.cjs +7 -3
- package/dist/adapters/terminal-logger/terminal-logger.cjs.map +1 -1
- package/dist/adapters/terminal-logger/terminal-logger.mjs +7 -3
- package/dist/adapters/terminal-logger/terminal-logger.mjs.map +1 -1
- package/dist/api/document-refs.cjs +16 -1
- package/dist/api/document-refs.cjs.map +1 -1
- package/dist/api/document-refs.mjs +16 -1
- package/dist/api/document-refs.mjs.map +1 -1
- package/dist/api/document-run.cjs +4 -10
- package/dist/api/document-run.cjs.map +1 -1
- package/dist/api/document-run.mjs +4 -10
- package/dist/api/document-run.mjs.map +1 -1
- package/dist/api/openapi-ts.cjs +1 -2
- package/dist/api/openapi-ts.cjs.map +1 -1
- package/dist/api/openapi-ts.mjs +2 -3
- package/dist/api/openapi-ts.mjs.map +1 -1
- package/dist/api/ref-limit-options.cjs +63 -0
- package/dist/api/ref-limit-options.cjs.map +1 -0
- package/dist/api/ref-limit-options.mjs +57 -0
- package/dist/api/ref-limit-options.mjs.map +1 -0
- package/dist/api/transform-schema.cjs +12 -5
- package/dist/api/transform-schema.cjs.map +1 -1
- package/dist/api/transform-schema.mjs +12 -5
- package/dist/api/transform-schema.mjs.map +1 -1
- package/dist/application/transform/declared-value-types.cjs +36 -0
- package/dist/application/transform/declared-value-types.cjs.map +1 -0
- package/dist/application/transform/declared-value-types.mjs +34 -0
- package/dist/application/transform/declared-value-types.mjs.map +1 -0
- package/dist/application/transform/document/document.cjs +3 -1
- package/dist/application/transform/document/document.cjs.map +1 -1
- package/dist/application/transform/document/document.mjs +3 -1
- package/dist/application/transform/document/document.mjs.map +1 -1
- package/dist/application/transform/document/exploded-query-values.cjs +63 -0
- package/dist/application/transform/document/exploded-query-values.cjs.map +1 -0
- package/dist/application/transform/document/exploded-query-values.mjs +59 -0
- package/dist/application/transform/document/exploded-query-values.mjs.map +1 -0
- package/dist/application/transform/document/header.cjs +11 -3
- package/dist/application/transform/document/header.cjs.map +1 -1
- package/dist/application/transform/document/header.mjs +10 -2
- package/dist/application/transform/document/header.mjs.map +1 -1
- package/dist/application/transform/document/parameter.cjs +1 -1
- package/dist/application/transform/document/parameter.cjs.map +1 -1
- package/dist/application/transform/document/parameter.mjs +1 -1
- package/dist/application/transform/document/parameter.mjs.map +1 -1
- package/dist/application/transform/document/parameters.cjs +23 -5
- package/dist/application/transform/document/parameters.cjs.map +1 -1
- package/dist/application/transform/document/parameters.mjs +23 -5
- package/dist/application/transform/document/parameters.mjs.map +1 -1
- package/dist/application/transform/document/path-item.cjs +4 -3
- package/dist/application/transform/document/path-item.cjs.map +1 -1
- package/dist/application/transform/document/path-item.mjs +4 -4
- package/dist/application/transform/document/path-item.mjs.map +1 -1
- package/dist/application/transform/document/path-template-key.cjs +84 -0
- package/dist/application/transform/document/path-template-key.cjs.map +1 -0
- package/dist/application/transform/document/path-template-key.mjs +79 -0
- package/dist/application/transform/document/path-template-key.mjs.map +1 -0
- package/dist/application/transform/document/path-template-refs.cjs +70 -0
- package/dist/application/transform/document/path-template-refs.cjs.map +1 -0
- package/dist/application/transform/document/path-template-refs.mjs +67 -0
- package/dist/application/transform/document/path-template-refs.mjs.map +1 -0
- package/dist/application/transform/document/paths-enum.cjs +7 -6
- package/dist/application/transform/document/paths-enum.cjs.map +1 -1
- package/dist/application/transform/document/paths-enum.mjs +7 -6
- package/dist/application/transform/document/paths-enum.mjs.map +1 -1
- package/dist/application/transform/document/paths.cjs +38 -66
- package/dist/application/transform/document/paths.cjs.map +1 -1
- package/dist/application/transform/document/paths.mjs +36 -66
- package/dist/application/transform/document/paths.mjs.map +1 -1
- package/dist/application/transform/document/webhooks.cjs +10 -3
- package/dist/application/transform/document/webhooks.cjs.map +1 -1
- package/dist/application/transform/document/webhooks.mjs +9 -2
- package/dist/application/transform/document/webhooks.mjs.map +1 -1
- package/dist/application/transform/footer/document-footer.cjs +6 -3
- package/dist/application/transform/footer/document-footer.cjs.map +1 -1
- package/dist/application/transform/footer/document-footer.mjs +6 -3
- package/dist/application/transform/footer/document-footer.mjs.map +1 -1
- package/dist/application/transform/helper-types.cjs +3 -3
- package/dist/application/transform/helper-types.cjs.map +1 -1
- package/dist/application/transform/helper-types.mjs +3 -3
- package/dist/application/transform/helper-types.mjs.map +1 -1
- package/dist/application/transform/ref-pointer/generated-location.cjs +4 -4
- package/dist/application/transform/ref-pointer/generated-location.cjs.map +1 -1
- package/dist/application/transform/ref-pointer/generated-location.mjs +1 -1
- package/dist/application/transform/ref-pointer/generated-location.mjs.map +1 -1
- package/dist/application/transform/ref-pointer/generated-shape.cjs +47 -66
- package/dist/application/transform/ref-pointer/generated-shape.cjs.map +1 -1
- package/dist/application/transform/ref-pointer/generated-shape.mjs +36 -50
- package/dist/application/transform/ref-pointer/generated-shape.mjs.map +1 -1
- package/dist/application/transform/ref-pointer/inline-cycles.cjs +2 -2
- package/dist/application/transform/ref-pointer/inline-cycles.cjs.map +1 -1
- package/dist/application/transform/ref-pointer/inline-cycles.mjs +1 -1
- package/dist/application/transform/ref-pointer/inline-cycles.mjs.map +1 -1
- package/dist/application/transform/ref-pointer/located-node.cjs +23 -0
- package/dist/application/transform/ref-pointer/located-node.cjs.map +1 -0
- package/dist/application/transform/ref-pointer/located-node.mjs +18 -0
- package/dist/application/transform/ref-pointer/located-node.mjs.map +1 -0
- package/dist/application/transform/ref-pointer/original-index.cjs +68 -13
- package/dist/application/transform/ref-pointer/original-index.cjs.map +1 -1
- package/dist/application/transform/ref-pointer/original-index.mjs +70 -15
- package/dist/application/transform/ref-pointer/original-index.mjs.map +1 -1
- package/dist/application/transform/ref-pointer/pointer-type.cjs +2 -2
- package/dist/application/transform/ref-pointer/pointer-type.cjs.map +1 -1
- package/dist/application/transform/ref-pointer/pointer-type.mjs +1 -1
- package/dist/application/transform/ref-pointer/pointer-type.mjs.map +1 -1
- package/dist/application/transform/ref-pointer/pointer-walk.cjs +54 -13
- package/dist/application/transform/ref-pointer/pointer-walk.cjs.map +1 -1
- package/dist/application/transform/ref-pointer/pointer-walk.mjs +46 -7
- package/dist/application/transform/ref-pointer/pointer-walk.mjs.map +1 -1
- package/dist/application/transform/ref-pointer/property-shape.cjs +52 -0
- package/dist/application/transform/ref-pointer/property-shape.cjs.map +1 -0
- package/dist/application/transform/ref-pointer/property-shape.mjs +45 -0
- package/dist/application/transform/ref-pointer/property-shape.mjs.map +1 -0
- package/dist/application/transform/ref-pointer/typed-walk.cjs +79 -21
- package/dist/application/transform/ref-pointer/typed-walk.cjs.map +1 -1
- package/dist/application/transform/ref-pointer/typed-walk.mjs +76 -18
- package/dist/application/transform/ref-pointer/typed-walk.mjs.map +1 -1
- package/dist/application/transform/schema/access-flags.cjs.map +1 -1
- package/dist/application/transform/schema/access-flags.mjs.map +1 -1
- package/dist/application/transform/schema/index-signature-type.cjs +21 -0
- package/dist/application/transform/schema/index-signature-type.cjs.map +1 -0
- package/dist/application/transform/schema/index-signature-type.mjs +19 -0
- package/dist/application/transform/schema/index-signature-type.mjs.map +1 -0
- package/dist/application/transform/schema/input-location.cjs +23 -0
- package/dist/application/transform/schema/input-location.cjs.map +1 -0
- package/dist/application/transform/schema/input-location.mjs +21 -0
- package/dist/application/transform/schema/input-location.mjs.map +1 -0
- package/dist/application/transform/schema/object-type.cjs +15 -5
- package/dist/application/transform/schema/object-type.cjs.map +1 -1
- package/dist/application/transform/schema/object-type.mjs +15 -5
- package/dist/application/transform/schema/object-type.mjs.map +1 -1
- package/dist/application/transform/schema/schema-transform.cjs +2 -1
- package/dist/application/transform/schema/schema-transform.cjs.map +1 -1
- package/dist/application/transform/schema/schema-transform.mjs +2 -1
- package/dist/application/transform/schema/schema-transform.mjs.map +1 -1
- package/dist/application/transform/schema/unevaluated-properties.cjs +2 -30
- package/dist/application/transform/schema/unevaluated-properties.cjs.map +1 -1
- package/dist/application/transform/schema/unevaluated-properties.mjs +3 -31
- package/dist/application/transform/schema/unevaluated-properties.mjs.map +1 -1
- package/dist/cli/api-logger.cjs +13 -0
- package/dist/cli/api-logger.cjs.map +1 -0
- package/dist/cli/api-logger.mjs +11 -0
- package/dist/cli/api-logger.mjs.map +1 -0
- package/dist/cli/api-settings.cjs +7 -15
- package/dist/cli/api-settings.cjs.map +1 -1
- package/dist/cli/api-settings.mjs +8 -16
- package/dist/cli/api-settings.mjs.map +1 -1
- package/dist/cli/cli-arguments.cjs +51 -11
- package/dist/cli/cli-arguments.cjs.map +1 -1
- package/dist/cli/cli-arguments.mjs +51 -11
- package/dist/cli/cli-arguments.mjs.map +1 -1
- package/dist/cli/cli-errors.cjs +17 -0
- package/dist/cli/cli-errors.cjs.map +1 -1
- package/dist/cli/cli-errors.mjs +17 -1
- package/dist/cli/cli-errors.mjs.map +1 -1
- package/dist/cli/cli-output.cjs +6 -4
- package/dist/cli/cli-output.cjs.map +1 -1
- package/dist/cli/cli-output.mjs +7 -5
- package/dist/cli/cli-output.mjs.map +1 -1
- package/dist/cli/main.cjs +10 -4
- package/dist/cli/main.cjs.map +1 -1
- package/dist/cli/main.mjs +10 -4
- package/dist/cli/main.mjs.map +1 -1
- package/dist/cli/redocly-apis.cjs +20 -9
- package/dist/cli/redocly-apis.cjs.map +1 -1
- package/dist/cli/redocly-apis.mjs +22 -11
- package/dist/cli/redocly-apis.mjs.map +1 -1
- package/dist/cli/ref-limits.cjs +15 -1
- package/dist/cli/ref-limits.cjs.map +1 -1
- package/dist/cli/ref-limits.mjs +15 -2
- package/dist/cli/ref-limits.mjs.map +1 -1
- package/dist/cli/run-cli.cjs +24 -7
- package/dist/cli/run-cli.cjs.map +1 -1
- package/dist/cli/run-cli.mjs +25 -8
- package/dist/cli/run-cli.mjs.map +1 -1
- package/dist/domain/cause-secrets.cjs +31 -16
- package/dist/domain/cause-secrets.cjs.map +1 -1
- package/dist/domain/cause-secrets.mjs +31 -16
- package/dist/domain/cause-secrets.mjs.map +1 -1
- package/dist/domain/errors.cjs +2 -0
- package/dist/domain/errors.cjs.map +1 -1
- package/dist/domain/errors.mjs +2 -0
- package/dist/domain/errors.mjs.map +1 -1
- package/dist/domain/location-text.cjs +9 -0
- package/dist/domain/location-text.cjs.map +1 -0
- package/dist/domain/location-text.mjs +7 -0
- package/dist/domain/location-text.mjs.map +1 -0
- package/dist/domain/openapi/document-places.cjs +55 -0
- package/dist/domain/openapi/document-places.cjs.map +1 -0
- package/dist/domain/openapi/document-places.mjs +53 -0
- package/dist/domain/openapi/document-places.mjs.map +1 -0
- package/dist/domain/output-fixes.cjs +8 -2
- package/dist/domain/output-fixes.cjs.map +1 -1
- package/dist/domain/output-fixes.mjs +8 -2
- package/dist/domain/output-fixes.mjs.map +1 -1
- package/dist/domain/terminal-text.cjs +31 -0
- package/dist/domain/terminal-text.cjs.map +1 -0
- package/dist/domain/terminal-text.mjs +29 -0
- package/dist/domain/terminal-text.mjs.map +1 -0
- package/dist/domain/warnings.cjs +1 -0
- package/dist/domain/warnings.cjs.map +1 -1
- package/dist/domain/warnings.mjs +1 -0
- package/dist/domain/warnings.mjs.map +1 -1
- package/dist/index.d.cts +26 -18
- package/dist/index.d.mts +26 -18
- package/dist/index.d.ts +26 -18
- package/package.json +1 -1
- package/src/adapters/node-file-system/node-file-system.ts +14 -1
- package/src/adapters/pipe-safe-writer/pipe-safe-writer.ts +29 -0
- package/src/adapters/redocly-loader/bundled-mapping-copies.ts +7 -42
- package/src/adapters/redocly-loader/component-schemas.ts +19 -0
- package/src/adapters/redocly-loader/mapping-schema-names.ts +25 -0
- package/src/adapters/redocly-loader/query-named-components.ts +201 -0
- package/src/adapters/redocly-loader/redocly-schema-loader.ts +46 -14
- package/src/adapters/redocly-loader/ref-access.ts +16 -3
- package/src/adapters/redocly-loader/ref-holders.ts +75 -14
- package/src/adapters/redocly-loader/remote-fetch.ts +11 -2
- package/src/adapters/redocly-loader/remote-node-limit.ts +44 -4
- package/src/adapters/redocly-loader/schema-source.ts +15 -3
- package/src/adapters/terminal-logger/terminal-logger.ts +10 -4
- package/src/api/document-refs.ts +29 -1
- package/src/api/document-run.ts +6 -16
- package/src/api/openapi-ts.ts +6 -3
- package/src/api/ref-limit-options.ts +76 -0
- package/src/api/transform-schema.ts +20 -5
- package/src/application/ports/file-system.ts +8 -0
- package/src/application/transform/declared-value-types.ts +42 -0
- package/src/application/transform/document/document.ts +4 -2
- package/src/application/transform/document/exploded-query-values.ts +88 -0
- package/src/application/transform/document/header.ts +25 -5
- package/src/application/transform/document/parameter.ts +4 -4
- package/src/application/transform/document/parameters.ts +45 -10
- package/src/application/transform/document/path-item.ts +3 -3
- package/src/application/transform/document/path-template-key.ts +152 -0
- package/src/application/transform/document/path-template-refs.ts +106 -0
- package/src/application/transform/document/paths-enum.ts +23 -9
- package/src/application/transform/document/paths.ts +53 -123
- package/src/application/transform/document/webhooks.ts +18 -5
- package/src/application/transform/footer/document-footer.ts +18 -8
- package/src/application/transform/helper-types.ts +4 -4
- package/src/application/transform/ref-pointer/generated-location.ts +1 -1
- package/src/application/transform/ref-pointer/generated-shape.ts +67 -78
- package/src/application/transform/ref-pointer/inline-cycles.ts +1 -1
- package/src/application/transform/ref-pointer/located-node.ts +38 -0
- package/src/application/transform/ref-pointer/original-index.ts +100 -17
- package/src/application/transform/ref-pointer/pointer-type.ts +1 -1
- package/src/application/transform/ref-pointer/pointer-walk.ts +82 -8
- package/src/application/transform/ref-pointer/property-shape.ts +97 -0
- package/src/application/transform/ref-pointer/typed-walk.ts +117 -25
- package/src/application/transform/schema/access-flags.ts +5 -2
- package/src/application/transform/schema/index-signature-type.ts +31 -0
- package/src/application/transform/schema/input-location.ts +35 -0
- package/src/application/transform/schema/object-type.ts +18 -8
- package/src/application/transform/schema/schema-transform.ts +2 -1
- package/src/application/transform/schema/unevaluated-properties.ts +4 -44
- package/src/cli/api-logger.ts +17 -0
- package/src/cli/api-settings.ts +12 -20
- package/src/cli/cli-arguments.ts +90 -14
- package/src/cli/cli-dependencies.ts +7 -2
- package/src/cli/cli-errors.ts +22 -0
- package/src/cli/cli-output.ts +11 -10
- package/src/cli/main.ts +10 -4
- package/src/cli/redocly-apis.ts +37 -17
- package/src/cli/ref-limits.ts +21 -2
- package/src/cli/run-cli.ts +39 -7
- package/src/domain/cause-secrets.ts +59 -25
- package/src/domain/errors.ts +2 -0
- package/src/domain/location-text.ts +12 -0
- package/src/domain/openapi/document-places.ts +78 -0
- package/src/domain/output-fixes.ts +9 -2
- package/src/domain/terminal-text.ts +44 -0
- package/src/domain/warnings.ts +1 -0
|
@@ -1,11 +1,14 @@
|
|
|
1
1
|
import { fileURLToPath } from 'node:url';
|
|
2
2
|
import { lintDocument, bundle } from '@redocly/openapi-core';
|
|
3
3
|
import { withStackOverflowReportedAsync } from '../../application/stack-overflow.mjs';
|
|
4
|
+
import { redactUrlSecrets } from '../../domain/url-secrets.mjs';
|
|
4
5
|
import { warningText, WARNING_CODES } from '../../domain/warnings.mjs';
|
|
5
6
|
import { schemaKeysOf, removeBundledMappingCopies } from './bundled-mapping-copies.mjs';
|
|
6
7
|
import { repairBundledRefs } from './bundled-ref-repair.mjs';
|
|
7
8
|
import { localFilesRead, loadedDocuments } from './loaded-documents.mjs';
|
|
8
9
|
import { malformedRefsError, findMalformedRefs } from './malformed-refs.mjs';
|
|
10
|
+
import { pointMappingNamesAtSchemas } from './mapping-schema-names.mjs';
|
|
11
|
+
import { componentKeysOf, renameQueryNamedComponents } from './query-named-components.mjs';
|
|
9
12
|
import { RefAccessResolver } from './ref-access.mjs';
|
|
10
13
|
import { checkRefsResolve } from './ref-resolution-check.mjs';
|
|
11
14
|
import { REF_CYCLE_MESSAGE } from './ref-resolution-steps.mjs';
|
|
@@ -91,6 +94,7 @@ class RedoclySchemaLoader {
|
|
|
91
94
|
const document = await parseSchema(request.source, { absoluteRef, resolver });
|
|
92
95
|
logger.debug("Parsed schema", "redoc", now() - parseStartedAt);
|
|
93
96
|
assertOpenAPI3(document.parsed);
|
|
97
|
+
pointMappingNamesAtSchemas(document.parsed);
|
|
94
98
|
const bundled = await this.#lintAndBundle(document, resolver, request.shouldLint);
|
|
95
99
|
const isRootAFile = request.source instanceof URL && request.source.protocol === "file:";
|
|
96
100
|
const localFiles = await localFilesRead(document, resolver, isRootAFile);
|
|
@@ -101,6 +105,7 @@ class RedoclySchemaLoader {
|
|
|
101
105
|
const config = resolveConfigWithAccess(redoc.resolve, {
|
|
102
106
|
timeoutMs: remoteRefTimeoutMs,
|
|
103
107
|
access: request.refAccess,
|
|
108
|
+
rootUrl: request.source instanceof URL ? request.source.href : void 0,
|
|
104
109
|
maxParallelFetches: remoteDocumentLimits.maxParallelFetches,
|
|
105
110
|
bodyLimits: remoteDocumentLimits
|
|
106
111
|
});
|
|
@@ -125,21 +130,24 @@ class RedoclySchemaLoader {
|
|
|
125
130
|
config: this.#options.redoc.styleguide,
|
|
126
131
|
externalRefResolver: resolver
|
|
127
132
|
});
|
|
128
|
-
this.#report(problems);
|
|
133
|
+
this.#report(problems, document.source.absoluteRef);
|
|
129
134
|
this.#options.logger.debug("Linted schema", "lint", this.#options.now() - startedAt);
|
|
130
135
|
}
|
|
131
136
|
async #bundle(document, resolver) {
|
|
132
137
|
const startedAt = this.#options.now();
|
|
133
138
|
const schemaKeys = schemaKeysOf(document.parsed);
|
|
139
|
+
const componentKeys = componentKeysOf(document.parsed);
|
|
134
140
|
const bundled = await bundle({
|
|
135
141
|
config: this.#options.redoc,
|
|
136
142
|
dereference: false,
|
|
137
143
|
doc: document,
|
|
138
144
|
externalRefResolver: resolver
|
|
139
145
|
});
|
|
140
|
-
this.#report(bundled.problems);
|
|
141
146
|
removeBundledMappingCopies(bundled.bundle.parsed, schemaKeys);
|
|
142
147
|
repairBundledRefs(bundled.bundle.parsed);
|
|
148
|
+
const documentRefs = resolver.getFiles();
|
|
149
|
+
const renaming = renameQueryNamedComponents(bundled.bundle.parsed, componentKeys, documentRefs);
|
|
150
|
+
this.#report(bundled.problems, document.source.absoluteRef, renaming);
|
|
143
151
|
this.#options.logger.debug("Bundled schema", "bundle", this.#options.now() - startedAt);
|
|
144
152
|
return bundled.bundle.parsed;
|
|
145
153
|
}
|
|
@@ -148,22 +156,22 @@ class RedoclySchemaLoader {
|
|
|
148
156
|
* config's `.redocly.lint-ignore.yaml` lists is left out, as `redocly lint` leaves it out
|
|
149
157
|
* (upstream #2189).
|
|
150
158
|
*/
|
|
151
|
-
#report(problems) {
|
|
159
|
+
#report(problems, rootRef, renaming = UNRENAMED) {
|
|
152
160
|
const errorMessages = [];
|
|
153
161
|
for (const problem of problems) {
|
|
154
162
|
if (problem.ignored === true) {
|
|
155
163
|
this.#options.logger.debug(
|
|
156
|
-
`Ignored by the lint ignore file: ${problemMessage(problem)}`,
|
|
164
|
+
`Ignored by the lint ignore file: ${problemMessage(problem, renaming, rootRef)}`,
|
|
157
165
|
"lint"
|
|
158
166
|
);
|
|
159
167
|
continue;
|
|
160
168
|
}
|
|
161
|
-
const message = problemMessage(problem);
|
|
169
|
+
const message = problemMessage(problem, renaming, rootRef);
|
|
162
170
|
if (problem.severity === "error") {
|
|
163
171
|
errorMessages.push(message);
|
|
164
172
|
this.#options.logger.error(message);
|
|
165
173
|
} else {
|
|
166
|
-
this.#options.logger.warn(lintWarningText(problem));
|
|
174
|
+
this.#options.logger.warn(lintWarningText(message, problem.ruleId));
|
|
167
175
|
}
|
|
168
176
|
}
|
|
169
177
|
if (errorMessages.length > 0) {
|
|
@@ -171,15 +179,19 @@ class RedoclySchemaLoader {
|
|
|
171
179
|
}
|
|
172
180
|
}
|
|
173
181
|
}
|
|
174
|
-
function lintWarningText(
|
|
175
|
-
return warningText(
|
|
176
|
-
`${problemMessage(problem)}, rule ${problem.ruleId}`,
|
|
177
|
-
WARNING_CODES.LINT_PROBLEM
|
|
178
|
-
);
|
|
182
|
+
function lintWarningText(message, ruleId) {
|
|
183
|
+
return warningText(`${message}, rule ${ruleId}`, WARNING_CODES.LINT_PROBLEM);
|
|
179
184
|
}
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
185
|
+
const UNRENAMED = { pointer: (pointer) => pointer, text: (text) => text };
|
|
186
|
+
function locationText(location, renaming, rootRef) {
|
|
187
|
+
const pointer = renaming.pointer(location.pointer);
|
|
188
|
+
const documentRef = location.source.absoluteRef;
|
|
189
|
+
return documentRef === rootRef ? pointer : `${pointer} in ${redactUrlSecrets(documentRef)}`;
|
|
190
|
+
}
|
|
191
|
+
function problemMessage(problem, renaming, rootRef) {
|
|
192
|
+
const location = problem.location?.[0];
|
|
193
|
+
const message = renaming.text(problem.message);
|
|
194
|
+
return location?.pointer ? `${message} at ${locationText(location, renaming, rootRef)}` : message;
|
|
183
195
|
}
|
|
184
196
|
function createRedoclySchemaLoader(options) {
|
|
185
197
|
return new RedoclySchemaLoader(options);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"redocly-schema-loader.mjs","sources":["../../../src/adapters/redocly-loader/redocly-schema-loader.ts"],"sourcesContent":["import { fileURLToPath } from \"node:url\";\nimport {\n type BaseResolver,\n bundle,\n type Document,\n lintDocument,\n type NormalizedProblem,\n type Config as RedoclyConfig,\n} from \"@redocly/openapi-core\";\nimport type { Logger } from \"../../application/ports/logger.js\";\nimport type {\n LoadedSchema,\n SchemaLoader,\n SchemaLoadRequest,\n} from \"../../application/ports/schema-loader.js\";\nimport { withStackOverflowReportedAsync } from \"../../application/stack-overflow.js\";\nimport { WARNING_CODES, warningText } from \"../../domain/warnings.js\";\nimport type { OpenAPI3 } from \"../../types.js\";\nimport { removeBundledMappingCopies, schemaKeysOf } from \"./bundled-mapping-copies.js\";\nimport { repairBundledRefs } from \"./bundled-ref-repair.js\";\nimport { loadedDocuments, localFilesRead } from \"./loaded-documents.js\";\nimport { findMalformedRefs, malformedRefsError } from \"./malformed-refs.js\";\nimport { RefAccessResolver } from \"./ref-access.js\";\nimport { checkRefsResolve } from \"./ref-resolution-check.js\";\nimport { REF_CYCLE_MESSAGE } from \"./ref-resolution-steps.js\";\nimport { type RemoteDocumentLimits, resolveConfigWithAccess } from \"./remote-fetch.js\";\nimport {\n loadFailedError,\n refCycleError,\n schemaInvalidError,\n versionUnsupportedError,\n} from \"./schema-load-errors.js\";\nimport { parseSchema } from \"./schema-source.js\";\nimport { findUnsupportedKeys, unsupportedKeysError } from \"./unsupported-keys.js\";\n\n/**\n * The SchemaLoader port on Redocly 1.34 (ADR-005): parse any inherited source type, then lint and\n * bundle with the given Redocly config. Problems go to the logger; errors fail the load.\n */\nexport interface RedoclySchemaLoaderOptions {\n readonly redoc: RedoclyConfig;\n readonly logger: Logger;\n /** A monotonic time in milliseconds, for the debug durations. */\n readonly now: () => number;\n /** Time limit of one remote fetch, unless the Redocly config brings its own `customFetch`. */\n readonly remoteRefTimeoutMs: number;\n readonly remoteDocumentLimits: RemoteDocumentLimits;\n}\n\nconst UNSUPPORTED_FORMAT_MESSAGE = \"Unsupported schema format, expected `openapi: 3.x`\";\n\n/**\n * Accept OpenAPI 3.x only; Swagger 2 and other formats get their own message. An empty file or a\n * `null` root parses to nothing, so it is checked before any field is read.\n */\nfunction assertOpenAPI3(document: unknown): void {\n if (typeof document !== \"object\" || document === null) {\n throw versionUnsupportedError(UNSUPPORTED_FORMAT_MESSAGE, {});\n }\n const parsed = document as Record<string, unknown>;\n const openapiVersion = Number.parseFloat(parsed.openapi as string);\n const isOpenAPI3 =\n !parsed.swagger &&\n Boolean(parsed.openapi) &&\n !Number.isNaN(openapiVersion) &&\n openapiVersion >= 3 &&\n openapiVersion < 4;\n if (isOpenAPI3) {\n return;\n }\n if (parsed.swagger) {\n throw versionUnsupportedError(\n \"Unsupported Swagger version: 2.x. Use OpenAPI 3.x instead.\",\n parsed,\n );\n }\n if (parsed.openapi || openapiVersion < 3 || openapiVersion >= 4) {\n throw versionUnsupportedError(`Unsupported OpenAPI version: ${parsed.openapi}`, parsed);\n }\n throw versionUnsupportedError(UNSUPPORTED_FORMAT_MESSAGE, parsed);\n}\n\n/**\n * The name an inline source (a string, object, buffer or stream) gets inside the working\n * directory. Redocly resolves relative `$ref`s against the directory of the document, so the\n * document must be named as a file in the working directory, not as the directory itself.\n */\nconst INLINE_SOURCE_NAME = \"inline-source\";\n\n/** The base for relative `$ref`s: the source file or URL itself, else a file in the cwd. */\nfunction sourceAbsoluteRef(source: unknown, cwd: URL): string {\n const document = source instanceof URL ? source : new URL(INLINE_SOURCE_NAME, cwd);\n return document.protocol === \"file:\" ? sourceFilePath(document) : document.href;\n}\n\n/**\n * The path of a `file:` source. A URL that names no path on this platform (an encoded slash, a\n * host on POSIX, no drive letter on Windows) cannot be read, so it fails as a read would.\n */\nfunction sourceFilePath(source: URL): string {\n try {\n return fileURLToPath(source);\n } catch (error) {\n // Node.js reports these as TypeErrors (ERR_INVALID_FILE_URL_PATH, ERR_INVALID_FILE_URL_HOST).\n if (!(error instanceof TypeError)) {\n throw error;\n }\n throw loadFailedError(source.href, error);\n }\n}\n\n/** Report the document problems Redocly throws as typed errors; anything else passes through. */\nasync function rethrowDocumentError(\n error: unknown,\n root: Document,\n resolver: BaseResolver,\n): Promise<never> {\n if (error instanceof Error && error.message === REF_CYCLE_MESSAGE) {\n throw refCycleError(error);\n }\n if (error instanceof URIError) {\n throw malformedRefsError(findMalformedRefs(await loadedDocuments(root, resolver)), error);\n }\n if (error instanceof TypeError) {\n const keys = findUnsupportedKeys(await loadedDocuments(root, resolver));\n throw keys.length === 0 ? error : unsupportedKeysError(keys, error);\n }\n throw error;\n}\n\nclass RedoclySchemaLoader implements SchemaLoader {\n readonly #options: RedoclySchemaLoaderOptions;\n\n constructor(options: RedoclySchemaLoaderOptions) {\n this.#options = options;\n }\n\n async load(request: SchemaLoadRequest): Promise<LoadedSchema> {\n const resolver = this.#resolver(request);\n // Parsing is guarded too: `JSON.stringify` of a deep object source overflows the stack on\n // Node.js 22 and 24, before linting starts.\n const bundled = await withStackOverflowReportedAsync(\"load\", () =>\n this.#parseAndBundle(request, resolver),\n ).catch((error: unknown) => {\n throw resolver.firstRefusal ?? error;\n });\n // A refused `$ref` is an unresolved-`$ref` problem, which a Redocly config can turn off.\n if (resolver.firstRefusal !== undefined) {\n throw resolver.firstRefusal;\n }\n return bundled;\n }\n\n async #parseAndBundle(request: SchemaLoadRequest, resolver: BaseResolver): Promise<LoadedSchema> {\n const { logger, now } = this.#options;\n const configLoadedAt = now();\n logger.debug(\"Loaded Redoc config\", \"redoc\", now() - configLoadedAt);\n const parseStartedAt = now();\n const absoluteRef = sourceAbsoluteRef(request.source, request.cwd);\n const document = await parseSchema(request.source, { absoluteRef, resolver });\n logger.debug(\"Parsed schema\", \"redoc\", now() - parseStartedAt);\n assertOpenAPI3(document.parsed);\n const bundled = await this.#lintAndBundle(document, resolver, request.shouldLint);\n const isRootAFile = request.source instanceof URL && request.source.protocol === \"file:\";\n const localFiles = await localFilesRead(document, resolver, isRootAFile);\n return { document: bundled, localFiles };\n }\n\n #resolver(request: SchemaLoadRequest): RefAccessResolver {\n const { redoc, remoteRefTimeoutMs, remoteDocumentLimits } = this.#options;\n const config = resolveConfigWithAccess(redoc.resolve, {\n timeoutMs: remoteRefTimeoutMs,\n access: request.refAccess,\n maxParallelFetches: remoteDocumentLimits.maxParallelFetches,\n bodyLimits: remoteDocumentLimits,\n });\n return new RefAccessResolver(config, {\n access: request.refAccess,\n maxRemoteDocuments: remoteDocumentLimits.maxDocuments,\n maxRemoteNodes: remoteDocumentLimits.maxNodes,\n });\n }\n\n async #lintAndBundle(\n document: Document,\n resolver: BaseResolver,\n shouldLint: boolean,\n ): Promise<OpenAPI3> {\n const rethrow = (error: unknown) => rethrowDocumentError(error, document, resolver);\n // Redocly leaves unhandled rejections behind when a `$ref` fails in two documents (ADR-031).\n await checkRefsResolve(document, resolver, this.#options.redoc.styleguide).catch(rethrow);\n if (shouldLint) {\n await this.#lint(document, resolver).catch(rethrow);\n }\n return this.#bundle(document, resolver).catch(rethrow);\n }\n\n async #lint(document: Document, resolver: BaseResolver): Promise<void> {\n const startedAt = this.#options.now();\n const problems = await lintDocument({\n document,\n config: this.#options.redoc.styleguide,\n externalRefResolver: resolver,\n });\n this.#report(problems);\n this.#options.logger.debug(\"Linted schema\", \"lint\", this.#options.now() - startedAt);\n }\n\n async #bundle(document: Document, resolver: BaseResolver): Promise<OpenAPI3> {\n const startedAt = this.#options.now();\n const schemaKeys = schemaKeysOf(document.parsed);\n // The lint resolver: documents it already loaded are not fetched again.\n const bundled = await bundle({\n config: this.#options.redoc,\n dereference: false,\n doc: document,\n externalRefResolver: resolver,\n });\n this.#report(bundled.problems);\n removeBundledMappingCopies(bundled.bundle.parsed, schemaKeys);\n repairBundledRefs(bundled.bundle.parsed);\n this.#options.logger.debug(\"Bundled schema\", \"bundle\", this.#options.now() - startedAt);\n return bundled.bundle.parsed;\n }\n\n /**\n * Report every problem; then throw if any of them is an error. A problem that the Redocly\n * config's `.redocly.lint-ignore.yaml` lists is left out, as `redocly lint` leaves it out\n * (upstream #2189).\n */\n #report(problems: readonly NormalizedProblem[]): void {\n const errorMessages: string[] = [];\n for (const problem of problems) {\n if (problem.ignored === true) {\n this.#options.logger.debug(\n `Ignored by the lint ignore file: ${problemMessage(problem)}`,\n \"lint\",\n );\n continue;\n }\n const message = problemMessage(problem);\n if (problem.severity === \"error\") {\n errorMessages.push(message);\n this.#options.logger.error(message);\n } else {\n this.#options.logger.warn(lintWarningText(problem));\n }\n }\n if (errorMessages.length > 0) {\n throw schemaInvalidError(errorMessages);\n }\n }\n}\n\n/** A lint warning names its rule, which `redocly.yaml` can turn off, and ends with its code. */\nfunction lintWarningText(problem: NormalizedProblem): string {\n return warningText(\n `${problemMessage(problem)}, rule ${problem.ruleId}`,\n WARNING_CODES.LINT_PROBLEM,\n );\n}\n\nfunction problemMessage(problem: NormalizedProblem): string {\n const location = problem.location?.[0]?.pointer;\n return location ? `${problem.message} at ${location}` : problem.message;\n}\n\n/** A schema loader with one Redocly config and logger, for one or more loads. */\nexport function createRedoclySchemaLoader(options: RedoclySchemaLoaderOptions): SchemaLoader {\n return new RedoclySchemaLoader(options);\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAiDA,MAAM,0BAAA,GAA6B,oDAAA;AAMnC,SAAS,eAAe,QAAA,EAAyB;AAC/C,EAAA,IAAI,OAAO,QAAA,KAAa,QAAA,IAAY,QAAA,KAAa,IAAA,EAAM;AACrD,IAAA,MAAM,uBAAA,CAAwB,0BAAA,EAA4B,EAAE,CAAA;AAAA,EAC9D;AACA,EAAA,MAAM,MAAA,GAAS,QAAA;AACf,EAAA,MAAM,cAAA,GAAiB,MAAA,CAAO,UAAA,CAAW,MAAA,CAAO,OAAiB,CAAA;AACjE,EAAA,MAAM,UAAA,GACJ,CAAC,MAAA,CAAO,OAAA,IACR,QAAQ,MAAA,CAAO,OAAO,CAAA,IACtB,CAAC,OAAO,KAAA,CAAM,cAAc,CAAA,IAC5B,cAAA,IAAkB,KAClB,cAAA,GAAiB,CAAA;AACnB,EAAA,IAAI,UAAA,EAAY;AACd,IAAA;AAAA,EACF;AACA,EAAA,IAAI,OAAO,OAAA,EAAS;AAClB,IAAA,MAAM,uBAAA;AAAA,MACJ,4DAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AACA,EAAA,IAAI,MAAA,CAAO,OAAA,IAAW,cAAA,GAAiB,CAAA,IAAK,kBAAkB,CAAA,EAAG;AAC/D,IAAA,MAAM,uBAAA,CAAwB,CAAA,6BAAA,EAAgC,MAAA,CAAO,OAAO,IAAI,MAAM,CAAA;AAAA,EACxF;AACA,EAAA,MAAM,uBAAA,CAAwB,4BAA4B,MAAM,CAAA;AAClE;AAOA,MAAM,kBAAA,GAAqB,eAAA;AAG3B,SAAS,iBAAA,CAAkB,QAAiB,GAAA,EAAkB;AAC5D,EAAA,MAAM,WAAW,MAAA,YAAkB,GAAA,GAAM,SAAS,IAAI,GAAA,CAAI,oBAAoB,GAAG,CAAA;AACjF,EAAA,OAAO,SAAS,QAAA,KAAa,OAAA,GAAU,cAAA,CAAe,QAAQ,IAAI,QAAA,CAAS,IAAA;AAC7E;AAMA,SAAS,eAAe,MAAA,EAAqB;AAC3C,EAAA,IAAI;AACF,IAAA,OAAO,cAAc,MAAM,CAAA;AAAA,EAC7B,SAAS,KAAA,EAAO;AAEd,IAAA,IAAI,EAAE,iBAAiB,SAAA,CAAA,EAAY;AACjC,MAAA,MAAM,KAAA;AAAA,IACR;AACA,IAAA,MAAM,eAAA,CAAgB,MAAA,CAAO,IAAA,EAAM,KAAK,CAAA;AAAA,EAC1C;AACF;AAGA,eAAe,oBAAA,CACb,KAAA,EACA,IAAA,EACA,QAAA,EACgB;AAChB,EAAA,IAAI,KAAA,YAAiB,KAAA,IAAS,KAAA,CAAM,OAAA,KAAY,iBAAA,EAAmB;AACjE,IAAA,MAAM,cAAc,KAAK,CAAA;AAAA,EAC3B;AACA,EAAA,IAAI,iBAAiB,QAAA,EAAU;AAC7B,IAAA,MAAM,kBAAA,CAAmB,kBAAkB,MAAM,eAAA,CAAgB,MAAM,QAAQ,CAAC,GAAG,KAAK,CAAA;AAAA,EAC1F;AACA,EAAA,IAAI,iBAAiB,SAAA,EAAW;AAC9B,IAAA,MAAM,OAAO,mBAAA,CAAoB,MAAM,eAAA,CAAgB,IAAA,EAAM,QAAQ,CAAC,CAAA;AACtE,IAAA,MAAM,KAAK,MAAA,KAAW,CAAA,GAAI,KAAA,GAAQ,oBAAA,CAAqB,MAAM,KAAK,CAAA;AAAA,EACpE;AACA,EAAA,MAAM,KAAA;AACR;AAEA,MAAM,mBAAA,CAA4C;AAAA,EACvC,QAAA;AAAA,EAET,YAAY,OAAA,EAAqC;AAC/C,IAAA,IAAA,CAAK,QAAA,GAAW,OAAA;AAAA,EAClB;AAAA,EAEA,MAAM,KAAK,OAAA,EAAmD;AAC5D,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,SAAA,CAAU,OAAO,CAAA;AAGvC,IAAA,MAAM,UAAU,MAAM,8BAAA;AAAA,MAA+B,MAAA;AAAA,MAAQ,MAC3D,IAAA,CAAK,eAAA,CAAgB,OAAA,EAAS,QAAQ;AAAA,KACxC,CAAE,KAAA,CAAM,CAAC,KAAA,KAAmB;AAC1B,MAAA,MAAM,SAAS,YAAA,IAAgB,KAAA;AAAA,IACjC,CAAC,CAAA;AAED,IAAA,IAAI,QAAA,CAAS,iBAAiB,MAAA,EAAW;AACvC,MAAA,MAAM,QAAA,CAAS,YAAA;AAAA,IACjB;AACA,IAAA,OAAO,OAAA;AAAA,EACT;AAAA,EAEA,MAAM,eAAA,CAAgB,OAAA,EAA4B,QAAA,EAA+C;AAC/F,IAAA,MAAM,EAAE,MAAA,EAAQ,GAAA,EAAI,GAAI,IAAA,CAAK,QAAA;AAC7B,IAAA,MAAM,iBAAiB,GAAA,EAAI;AAC3B,IAAA,MAAA,CAAO,KAAA,CAAM,qBAAA,EAAuB,OAAA,EAAS,GAAA,KAAQ,cAAc,CAAA;AACnE,IAAA,MAAM,iBAAiB,GAAA,EAAI;AAC3B,IAAA,MAAM,WAAA,GAAc,iBAAA,CAAkB,OAAA,CAAQ,MAAA,EAAQ,QAAQ,GAAG,CAAA;AACjE,IAAA,MAAM,QAAA,GAAW,MAAM,WAAA,CAAY,OAAA,CAAQ,QAAQ,EAAE,WAAA,EAAa,UAAU,CAAA;AAC5E,IAAA,MAAA,CAAO,KAAA,CAAM,eAAA,EAAiB,OAAA,EAAS,GAAA,KAAQ,cAAc,CAAA;AAC7D,IAAA,cAAA,CAAe,SAAS,MAAM,CAAA;AAC9B,IAAA,MAAM,UAAU,MAAM,IAAA,CAAK,eAAe,QAAA,EAAU,QAAA,EAAU,QAAQ,UAAU,CAAA;AAChF,IAAA,MAAM,cAAc,OAAA,CAAQ,MAAA,YAAkB,GAAA,IAAO,OAAA,CAAQ,OAAO,QAAA,KAAa,OAAA;AACjF,IAAA,MAAM,UAAA,GAAa,MAAM,cAAA,CAAe,QAAA,EAAU,UAAU,WAAW,CAAA;AACvE,IAAA,OAAO,EAAE,QAAA,EAAU,OAAA,EAAS,UAAA,EAAW;AAAA,EACzC;AAAA,EAEA,UAAU,OAAA,EAA+C;AACvD,IAAA,MAAM,EAAE,KAAA,EAAO,kBAAA,EAAoB,oBAAA,KAAyB,IAAA,CAAK,QAAA;AACjE,IAAA,MAAM,MAAA,GAAS,uBAAA,CAAwB,KAAA,CAAM,OAAA,EAAS;AAAA,MACpD,SAAA,EAAW,kBAAA;AAAA,MACX,QAAQ,OAAA,CAAQ,SAAA;AAAA,MAChB,oBAAoB,oBAAA,CAAqB,kBAAA;AAAA,MACzC,UAAA,EAAY;AAAA,KACb,CAAA;AACD,IAAA,OAAO,IAAI,kBAAkB,MAAA,EAAQ;AAAA,MACnC,QAAQ,OAAA,CAAQ,SAAA;AAAA,MAChB,oBAAoB,oBAAA,CAAqB,YAAA;AAAA,MACzC,gBAAgB,oBAAA,CAAqB;AAAA,KACtC,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,cAAA,CACJ,QAAA,EACA,QAAA,EACA,UAAA,EACmB;AACnB,IAAA,MAAM,UAAU,CAAC,KAAA,KAAmB,oBAAA,CAAqB,KAAA,EAAO,UAAU,QAAQ,CAAA;AAElF,IAAA,MAAM,gBAAA,CAAiB,UAAU,QAAA,EAAU,IAAA,CAAK,SAAS,KAAA,CAAM,UAAU,CAAA,CAAE,KAAA,CAAM,OAAO,CAAA;AACxF,IAAA,IAAI,UAAA,EAAY;AACd,MAAA,MAAM,KAAK,KAAA,CAAM,QAAA,EAAU,QAAQ,CAAA,CAAE,MAAM,OAAO,CAAA;AAAA,IACpD;AACA,IAAA,OAAO,KAAK,OAAA,CAAQ,QAAA,EAAU,QAAQ,CAAA,CAAE,MAAM,OAAO,CAAA;AAAA,EACvD;AAAA,EAEA,MAAM,KAAA,CAAM,QAAA,EAAoB,QAAA,EAAuC;AACrE,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,QAAA,CAAS,GAAA,EAAI;AACpC,IAAA,MAAM,QAAA,GAAW,MAAM,YAAA,CAAa;AAAA,MAClC,QAAA;AAAA,MACA,MAAA,EAAQ,IAAA,CAAK,QAAA,CAAS,KAAA,CAAM,UAAA;AAAA,MAC5B,mBAAA,EAAqB;AAAA,KACtB,CAAA;AACD,IAAA,IAAA,CAAK,QAAQ,QAAQ,CAAA;AACrB,IAAA,IAAA,CAAK,QAAA,CAAS,OAAO,KAAA,CAAM,eAAA,EAAiB,QAAQ,IAAA,CAAK,QAAA,CAAS,GAAA,EAAI,GAAI,SAAS,CAAA;AAAA,EACrF;AAAA,EAEA,MAAM,OAAA,CAAQ,QAAA,EAAoB,QAAA,EAA2C;AAC3E,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,QAAA,CAAS,GAAA,EAAI;AACpC,IAAA,MAAM,UAAA,GAAa,YAAA,CAAa,QAAA,CAAS,MAAM,CAAA;AAE/C,IAAA,MAAM,OAAA,GAAU,MAAM,MAAA,CAAO;AAAA,MAC3B,MAAA,EAAQ,KAAK,QAAA,CAAS,KAAA;AAAA,MACtB,WAAA,EAAa,KAAA;AAAA,MACb,GAAA,EAAK,QAAA;AAAA,MACL,mBAAA,EAAqB;AAAA,KACtB,CAAA;AACD,IAAA,IAAA,CAAK,OAAA,CAAQ,QAAQ,QAAQ,CAAA;AAC7B,IAAA,0BAAA,CAA2B,OAAA,CAAQ,MAAA,CAAO,MAAA,EAAQ,UAAU,CAAA;AAC5D,IAAA,iBAAA,CAAkB,OAAA,CAAQ,OAAO,MAAM,CAAA;AACvC,IAAA,IAAA,CAAK,QAAA,CAAS,OAAO,KAAA,CAAM,gBAAA,EAAkB,UAAU,IAAA,CAAK,QAAA,CAAS,GAAA,EAAI,GAAI,SAAS,CAAA;AACtF,IAAA,OAAO,QAAQ,MAAA,CAAO,MAAA;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,QAAQ,QAAA,EAA8C;AACpD,IAAA,MAAM,gBAA0B,EAAC;AACjC,IAAA,KAAA,MAAW,WAAW,QAAA,EAAU;AAC9B,MAAA,IAAI,OAAA,CAAQ,YAAY,IAAA,EAAM;AAC5B,QAAA,IAAA,CAAK,SAAS,MAAA,CAAO,KAAA;AAAA,UACnB,CAAA,iCAAA,EAAoC,cAAA,CAAe,OAAO,CAAC,CAAA,CAAA;AAAA,UAC3D;AAAA,SACF;AACA,QAAA;AAAA,MACF;AACA,MAAA,MAAM,OAAA,GAAU,eAAe,OAAO,CAAA;AACtC,MAAA,IAAI,OAAA,CAAQ,aAAa,OAAA,EAAS;AAChC,QAAA,aAAA,CAAc,KAAK,OAAO,CAAA;AAC1B,QAAA,IAAA,CAAK,QAAA,CAAS,MAAA,CAAO,KAAA,CAAM,OAAO,CAAA;AAAA,MACpC,CAAA,MAAO;AACL,QAAA,IAAA,CAAK,QAAA,CAAS,MAAA,CAAO,IAAA,CAAK,eAAA,CAAgB,OAAO,CAAC,CAAA;AAAA,MACpD;AAAA,IACF;AACA,IAAA,IAAI,aAAA,CAAc,SAAS,CAAA,EAAG;AAC5B,MAAA,MAAM,mBAAmB,aAAa,CAAA;AAAA,IACxC;AAAA,EACF;AACF;AAGA,SAAS,gBAAgB,OAAA,EAAoC;AAC3D,EAAA,OAAO,WAAA;AAAA,IACL,GAAG,cAAA,CAAe,OAAO,CAAC,CAAA,OAAA,EAAU,QAAQ,MAAM,CAAA,CAAA;AAAA,IAClD,aAAA,CAAc;AAAA,GAChB;AACF;AAEA,SAAS,eAAe,OAAA,EAAoC;AAC1D,EAAA,MAAM,QAAA,GAAW,OAAA,CAAQ,QAAA,GAAW,CAAC,CAAA,EAAG,OAAA;AACxC,EAAA,OAAO,WAAW,CAAA,EAAG,OAAA,CAAQ,OAAO,CAAA,IAAA,EAAO,QAAQ,KAAK,OAAA,CAAQ,OAAA;AAClE;AAGO,SAAS,0BAA0B,OAAA,EAAmD;AAC3F,EAAA,OAAO,IAAI,oBAAoB,OAAO,CAAA;AACxC;;"}
|
|
1
|
+
{"version":3,"file":"redocly-schema-loader.mjs","sources":["../../../src/adapters/redocly-loader/redocly-schema-loader.ts"],"sourcesContent":["import { fileURLToPath } from \"node:url\";\nimport {\n type BaseResolver,\n bundle,\n type Document,\n type LocationObject,\n lintDocument,\n type NormalizedProblem,\n type Config as RedoclyConfig,\n} from \"@redocly/openapi-core\";\nimport type { Logger } from \"../../application/ports/logger.js\";\nimport type {\n LoadedSchema,\n SchemaLoader,\n SchemaLoadRequest,\n} from \"../../application/ports/schema-loader.js\";\nimport { withStackOverflowReportedAsync } from \"../../application/stack-overflow.js\";\nimport { redactUrlSecrets } from \"../../domain/url-secrets.js\";\nimport { WARNING_CODES, warningText } from \"../../domain/warnings.js\";\nimport type { OpenAPI3 } from \"../../types.js\";\nimport { removeBundledMappingCopies, schemaKeysOf } from \"./bundled-mapping-copies.js\";\nimport { repairBundledRefs } from \"./bundled-ref-repair.js\";\nimport { loadedDocuments, localFilesRead } from \"./loaded-documents.js\";\nimport { findMalformedRefs, malformedRefsError } from \"./malformed-refs.js\";\nimport { pointMappingNamesAtSchemas } from \"./mapping-schema-names.js\";\nimport {\n type ComponentRenaming,\n componentKeysOf,\n renameQueryNamedComponents,\n} from \"./query-named-components.js\";\nimport { RefAccessResolver } from \"./ref-access.js\";\nimport { checkRefsResolve } from \"./ref-resolution-check.js\";\nimport { REF_CYCLE_MESSAGE } from \"./ref-resolution-steps.js\";\nimport { type RemoteDocumentLimits, resolveConfigWithAccess } from \"./remote-fetch.js\";\nimport {\n loadFailedError,\n refCycleError,\n schemaInvalidError,\n versionUnsupportedError,\n} from \"./schema-load-errors.js\";\nimport { parseSchema } from \"./schema-source.js\";\nimport { findUnsupportedKeys, unsupportedKeysError } from \"./unsupported-keys.js\";\n\n/**\n * The SchemaLoader port on Redocly 1.34 (ADR-005): parse any inherited source type, then lint and\n * bundle with the given Redocly config. Problems go to the logger; errors fail the load.\n */\nexport interface RedoclySchemaLoaderOptions {\n readonly redoc: RedoclyConfig;\n readonly logger: Logger;\n /** A monotonic time in milliseconds, for the debug durations. */\n readonly now: () => number;\n /** Time limit of one remote fetch, unless the Redocly config brings its own `customFetch`. */\n readonly remoteRefTimeoutMs: number;\n readonly remoteDocumentLimits: RemoteDocumentLimits;\n}\n\nconst UNSUPPORTED_FORMAT_MESSAGE = \"Unsupported schema format, expected `openapi: 3.x`\";\n\n/**\n * Accept OpenAPI 3.x only; Swagger 2 and other formats get their own message. An empty file or a\n * `null` root parses to nothing, so it is checked before any field is read.\n */\nfunction assertOpenAPI3(document: unknown): void {\n if (typeof document !== \"object\" || document === null) {\n throw versionUnsupportedError(UNSUPPORTED_FORMAT_MESSAGE, {});\n }\n const parsed = document as Record<string, unknown>;\n const openapiVersion = Number.parseFloat(parsed.openapi as string);\n const isOpenAPI3 =\n !parsed.swagger &&\n Boolean(parsed.openapi) &&\n !Number.isNaN(openapiVersion) &&\n openapiVersion >= 3 &&\n openapiVersion < 4;\n if (isOpenAPI3) {\n return;\n }\n if (parsed.swagger) {\n throw versionUnsupportedError(\n \"Unsupported Swagger version: 2.x. Use OpenAPI 3.x instead.\",\n parsed,\n );\n }\n if (parsed.openapi || openapiVersion < 3 || openapiVersion >= 4) {\n throw versionUnsupportedError(`Unsupported OpenAPI version: ${parsed.openapi}`, parsed);\n }\n throw versionUnsupportedError(UNSUPPORTED_FORMAT_MESSAGE, parsed);\n}\n\n/**\n * The name an inline source (a string, object, buffer or stream) gets inside the working\n * directory. Redocly resolves relative `$ref`s against the directory of the document, so the\n * document must be named as a file in the working directory, not as the directory itself.\n */\nconst INLINE_SOURCE_NAME = \"inline-source\";\n\n/** The base for relative `$ref`s: the source file or URL itself, else a file in the cwd. */\nfunction sourceAbsoluteRef(source: unknown, cwd: URL): string {\n const document = source instanceof URL ? source : new URL(INLINE_SOURCE_NAME, cwd);\n return document.protocol === \"file:\" ? sourceFilePath(document) : document.href;\n}\n\n/**\n * The path of a `file:` source. A URL that names no path on this platform (an encoded slash, a\n * host on POSIX, no drive letter on Windows) cannot be read, so it fails as a read would.\n */\nfunction sourceFilePath(source: URL): string {\n try {\n return fileURLToPath(source);\n } catch (error) {\n // Node.js reports these as TypeErrors (ERR_INVALID_FILE_URL_PATH, ERR_INVALID_FILE_URL_HOST).\n if (!(error instanceof TypeError)) {\n throw error;\n }\n throw loadFailedError(source.href, error);\n }\n}\n\n/** Report the document problems Redocly throws as typed errors; anything else passes through. */\nasync function rethrowDocumentError(\n error: unknown,\n root: Document,\n resolver: BaseResolver,\n): Promise<never> {\n if (error instanceof Error && error.message === REF_CYCLE_MESSAGE) {\n throw refCycleError(error);\n }\n if (error instanceof URIError) {\n throw malformedRefsError(findMalformedRefs(await loadedDocuments(root, resolver)), error);\n }\n if (error instanceof TypeError) {\n const keys = findUnsupportedKeys(await loadedDocuments(root, resolver));\n throw keys.length === 0 ? error : unsupportedKeysError(keys, error);\n }\n throw error;\n}\n\nclass RedoclySchemaLoader implements SchemaLoader {\n readonly #options: RedoclySchemaLoaderOptions;\n\n constructor(options: RedoclySchemaLoaderOptions) {\n this.#options = options;\n }\n\n async load(request: SchemaLoadRequest): Promise<LoadedSchema> {\n const resolver = this.#resolver(request);\n // Parsing is guarded too: `JSON.stringify` of a deep object source overflows the stack on\n // Node.js 22 and 24, before linting starts.\n const bundled = await withStackOverflowReportedAsync(\"load\", () =>\n this.#parseAndBundle(request, resolver),\n ).catch((error: unknown) => {\n throw resolver.firstRefusal ?? error;\n });\n // A refused `$ref` is an unresolved-`$ref` problem, which a Redocly config can turn off.\n if (resolver.firstRefusal !== undefined) {\n throw resolver.firstRefusal;\n }\n return bundled;\n }\n\n async #parseAndBundle(request: SchemaLoadRequest, resolver: BaseResolver): Promise<LoadedSchema> {\n const { logger, now } = this.#options;\n const configLoadedAt = now();\n logger.debug(\"Loaded Redoc config\", \"redoc\", now() - configLoadedAt);\n const parseStartedAt = now();\n const absoluteRef = sourceAbsoluteRef(request.source, request.cwd);\n const document = await parseSchema(request.source, { absoluteRef, resolver });\n logger.debug(\"Parsed schema\", \"redoc\", now() - parseStartedAt);\n assertOpenAPI3(document.parsed);\n pointMappingNamesAtSchemas(document.parsed);\n const bundled = await this.#lintAndBundle(document, resolver, request.shouldLint);\n const isRootAFile = request.source instanceof URL && request.source.protocol === \"file:\";\n const localFiles = await localFilesRead(document, resolver, isRootAFile);\n return { document: bundled, localFiles };\n }\n\n #resolver(request: SchemaLoadRequest): RefAccessResolver {\n const { redoc, remoteRefTimeoutMs, remoteDocumentLimits } = this.#options;\n const config = resolveConfigWithAccess(redoc.resolve, {\n timeoutMs: remoteRefTimeoutMs,\n access: request.refAccess,\n rootUrl: request.source instanceof URL ? request.source.href : undefined,\n maxParallelFetches: remoteDocumentLimits.maxParallelFetches,\n bodyLimits: remoteDocumentLimits,\n });\n return new RefAccessResolver(config, {\n access: request.refAccess,\n maxRemoteDocuments: remoteDocumentLimits.maxDocuments,\n maxRemoteNodes: remoteDocumentLimits.maxNodes,\n });\n }\n\n async #lintAndBundle(\n document: Document,\n resolver: BaseResolver,\n shouldLint: boolean,\n ): Promise<OpenAPI3> {\n const rethrow = (error: unknown) => rethrowDocumentError(error, document, resolver);\n // Redocly leaves unhandled rejections behind when a `$ref` fails in two documents (ADR-031).\n await checkRefsResolve(document, resolver, this.#options.redoc.styleguide).catch(rethrow);\n if (shouldLint) {\n await this.#lint(document, resolver).catch(rethrow);\n }\n return this.#bundle(document, resolver).catch(rethrow);\n }\n\n async #lint(document: Document, resolver: BaseResolver): Promise<void> {\n const startedAt = this.#options.now();\n const problems = await lintDocument({\n document,\n config: this.#options.redoc.styleguide,\n externalRefResolver: resolver,\n });\n this.#report(problems, document.source.absoluteRef);\n this.#options.logger.debug(\"Linted schema\", \"lint\", this.#options.now() - startedAt);\n }\n\n async #bundle(document: Document, resolver: BaseResolver): Promise<OpenAPI3> {\n const startedAt = this.#options.now();\n const schemaKeys = schemaKeysOf(document.parsed);\n const componentKeys = componentKeysOf(document.parsed);\n // The lint resolver: documents it already loaded are not fetched again.\n const bundled = await bundle({\n config: this.#options.redoc,\n dereference: false,\n doc: document,\n externalRefResolver: resolver,\n });\n removeBundledMappingCopies(bundled.bundle.parsed, schemaKeys);\n repairBundledRefs(bundled.bundle.parsed);\n const documentRefs = resolver.getFiles();\n const renaming = renameQueryNamedComponents(bundled.bundle.parsed, componentKeys, documentRefs);\n // The problems name the components the bundle made, so they are shown by their new names.\n this.#report(bundled.problems, document.source.absoluteRef, renaming);\n this.#options.logger.debug(\"Bundled schema\", \"bundle\", this.#options.now() - startedAt);\n return bundled.bundle.parsed;\n }\n\n /**\n * Report every problem; then throw if any of them is an error. A problem that the Redocly\n * config's `.redocly.lint-ignore.yaml` lists is left out, as `redocly lint` leaves it out\n * (upstream #2189).\n */\n #report(problems: readonly NormalizedProblem[], rootRef: string, renaming = UNRENAMED): void {\n const errorMessages: string[] = [];\n for (const problem of problems) {\n if (problem.ignored === true) {\n this.#options.logger.debug(\n `Ignored by the lint ignore file: ${problemMessage(problem, renaming, rootRef)}`,\n \"lint\",\n );\n continue;\n }\n const message = problemMessage(problem, renaming, rootRef);\n if (problem.severity === \"error\") {\n errorMessages.push(message);\n this.#options.logger.error(message);\n } else {\n this.#options.logger.warn(lintWarningText(message, problem.ruleId));\n }\n }\n if (errorMessages.length > 0) {\n throw schemaInvalidError(errorMessages);\n }\n }\n}\n\n/** A lint warning names its rule, which `redocly.yaml` can turn off, and ends with its code. */\nfunction lintWarningText(message: string, ruleId: string): string {\n return warningText(`${message}, rule ${ruleId}`, WARNING_CODES.LINT_PROBLEM);\n}\n\n/** Problems found before the bundle named any component. */\nconst UNRENAMED: ComponentRenaming = { pointer: (pointer) => pointer, text: (text) => text };\n\n/** A problem location that names a JSON Pointer, not a line and column. */\ntype PointerLocation = Extract<LocationObject, { pointer: string }>;\n\n/**\n * Where a problem is: its pointer, and the document when it is not the root (URL secrets left\n * out).\n */\nfunction locationText(location: PointerLocation, renaming: ComponentRenaming, rootRef: string) {\n const pointer = renaming.pointer(location.pointer);\n const documentRef = location.source.absoluteRef;\n return documentRef === rootRef ? pointer : `${pointer} in ${redactUrlSecrets(documentRef)}`;\n}\n\nfunction problemMessage(\n problem: NormalizedProblem,\n renaming: ComponentRenaming,\n rootRef: string,\n): string {\n const location = problem.location?.[0];\n const message = renaming.text(problem.message);\n return location?.pointer ? `${message} at ${locationText(location, renaming, rootRef)}` : message;\n}\n\n/** A schema loader with one Redocly config and logger, for one or more loads. */\nexport function createRedoclySchemaLoader(options: RedoclySchemaLoaderOptions): SchemaLoader {\n return new RedoclySchemaLoader(options);\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAyDA,MAAM,0BAAA,GAA6B,oDAAA;AAMnC,SAAS,eAAe,QAAA,EAAyB;AAC/C,EAAA,IAAI,OAAO,QAAA,KAAa,QAAA,IAAY,QAAA,KAAa,IAAA,EAAM;AACrD,IAAA,MAAM,uBAAA,CAAwB,0BAAA,EAA4B,EAAE,CAAA;AAAA,EAC9D;AACA,EAAA,MAAM,MAAA,GAAS,QAAA;AACf,EAAA,MAAM,cAAA,GAAiB,MAAA,CAAO,UAAA,CAAW,MAAA,CAAO,OAAiB,CAAA;AACjE,EAAA,MAAM,UAAA,GACJ,CAAC,MAAA,CAAO,OAAA,IACR,QAAQ,MAAA,CAAO,OAAO,CAAA,IACtB,CAAC,OAAO,KAAA,CAAM,cAAc,CAAA,IAC5B,cAAA,IAAkB,KAClB,cAAA,GAAiB,CAAA;AACnB,EAAA,IAAI,UAAA,EAAY;AACd,IAAA;AAAA,EACF;AACA,EAAA,IAAI,OAAO,OAAA,EAAS;AAClB,IAAA,MAAM,uBAAA;AAAA,MACJ,4DAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AACA,EAAA,IAAI,MAAA,CAAO,OAAA,IAAW,cAAA,GAAiB,CAAA,IAAK,kBAAkB,CAAA,EAAG;AAC/D,IAAA,MAAM,uBAAA,CAAwB,CAAA,6BAAA,EAAgC,MAAA,CAAO,OAAO,IAAI,MAAM,CAAA;AAAA,EACxF;AACA,EAAA,MAAM,uBAAA,CAAwB,4BAA4B,MAAM,CAAA;AAClE;AAOA,MAAM,kBAAA,GAAqB,eAAA;AAG3B,SAAS,iBAAA,CAAkB,QAAiB,GAAA,EAAkB;AAC5D,EAAA,MAAM,WAAW,MAAA,YAAkB,GAAA,GAAM,SAAS,IAAI,GAAA,CAAI,oBAAoB,GAAG,CAAA;AACjF,EAAA,OAAO,SAAS,QAAA,KAAa,OAAA,GAAU,cAAA,CAAe,QAAQ,IAAI,QAAA,CAAS,IAAA;AAC7E;AAMA,SAAS,eAAe,MAAA,EAAqB;AAC3C,EAAA,IAAI;AACF,IAAA,OAAO,cAAc,MAAM,CAAA;AAAA,EAC7B,SAAS,KAAA,EAAO;AAEd,IAAA,IAAI,EAAE,iBAAiB,SAAA,CAAA,EAAY;AACjC,MAAA,MAAM,KAAA;AAAA,IACR;AACA,IAAA,MAAM,eAAA,CAAgB,MAAA,CAAO,IAAA,EAAM,KAAK,CAAA;AAAA,EAC1C;AACF;AAGA,eAAe,oBAAA,CACb,KAAA,EACA,IAAA,EACA,QAAA,EACgB;AAChB,EAAA,IAAI,KAAA,YAAiB,KAAA,IAAS,KAAA,CAAM,OAAA,KAAY,iBAAA,EAAmB;AACjE,IAAA,MAAM,cAAc,KAAK,CAAA;AAAA,EAC3B;AACA,EAAA,IAAI,iBAAiB,QAAA,EAAU;AAC7B,IAAA,MAAM,kBAAA,CAAmB,kBAAkB,MAAM,eAAA,CAAgB,MAAM,QAAQ,CAAC,GAAG,KAAK,CAAA;AAAA,EAC1F;AACA,EAAA,IAAI,iBAAiB,SAAA,EAAW;AAC9B,IAAA,MAAM,OAAO,mBAAA,CAAoB,MAAM,eAAA,CAAgB,IAAA,EAAM,QAAQ,CAAC,CAAA;AACtE,IAAA,MAAM,KAAK,MAAA,KAAW,CAAA,GAAI,KAAA,GAAQ,oBAAA,CAAqB,MAAM,KAAK,CAAA;AAAA,EACpE;AACA,EAAA,MAAM,KAAA;AACR;AAEA,MAAM,mBAAA,CAA4C;AAAA,EACvC,QAAA;AAAA,EAET,YAAY,OAAA,EAAqC;AAC/C,IAAA,IAAA,CAAK,QAAA,GAAW,OAAA;AAAA,EAClB;AAAA,EAEA,MAAM,KAAK,OAAA,EAAmD;AAC5D,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,SAAA,CAAU,OAAO,CAAA;AAGvC,IAAA,MAAM,UAAU,MAAM,8BAAA;AAAA,MAA+B,MAAA;AAAA,MAAQ,MAC3D,IAAA,CAAK,eAAA,CAAgB,OAAA,EAAS,QAAQ;AAAA,KACxC,CAAE,KAAA,CAAM,CAAC,KAAA,KAAmB;AAC1B,MAAA,MAAM,SAAS,YAAA,IAAgB,KAAA;AAAA,IACjC,CAAC,CAAA;AAED,IAAA,IAAI,QAAA,CAAS,iBAAiB,MAAA,EAAW;AACvC,MAAA,MAAM,QAAA,CAAS,YAAA;AAAA,IACjB;AACA,IAAA,OAAO,OAAA;AAAA,EACT;AAAA,EAEA,MAAM,eAAA,CAAgB,OAAA,EAA4B,QAAA,EAA+C;AAC/F,IAAA,MAAM,EAAE,MAAA,EAAQ,GAAA,EAAI,GAAI,IAAA,CAAK,QAAA;AAC7B,IAAA,MAAM,iBAAiB,GAAA,EAAI;AAC3B,IAAA,MAAA,CAAO,KAAA,CAAM,qBAAA,EAAuB,OAAA,EAAS,GAAA,KAAQ,cAAc,CAAA;AACnE,IAAA,MAAM,iBAAiB,GAAA,EAAI;AAC3B,IAAA,MAAM,WAAA,GAAc,iBAAA,CAAkB,OAAA,CAAQ,MAAA,EAAQ,QAAQ,GAAG,CAAA;AACjE,IAAA,MAAM,QAAA,GAAW,MAAM,WAAA,CAAY,OAAA,CAAQ,QAAQ,EAAE,WAAA,EAAa,UAAU,CAAA;AAC5E,IAAA,MAAA,CAAO,KAAA,CAAM,eAAA,EAAiB,OAAA,EAAS,GAAA,KAAQ,cAAc,CAAA;AAC7D,IAAA,cAAA,CAAe,SAAS,MAAM,CAAA;AAC9B,IAAA,0BAAA,CAA2B,SAAS,MAAM,CAAA;AAC1C,IAAA,MAAM,UAAU,MAAM,IAAA,CAAK,eAAe,QAAA,EAAU,QAAA,EAAU,QAAQ,UAAU,CAAA;AAChF,IAAA,MAAM,cAAc,OAAA,CAAQ,MAAA,YAAkB,GAAA,IAAO,OAAA,CAAQ,OAAO,QAAA,KAAa,OAAA;AACjF,IAAA,MAAM,UAAA,GAAa,MAAM,cAAA,CAAe,QAAA,EAAU,UAAU,WAAW,CAAA;AACvE,IAAA,OAAO,EAAE,QAAA,EAAU,OAAA,EAAS,UAAA,EAAW;AAAA,EACzC;AAAA,EAEA,UAAU,OAAA,EAA+C;AACvD,IAAA,MAAM,EAAE,KAAA,EAAO,kBAAA,EAAoB,oBAAA,KAAyB,IAAA,CAAK,QAAA;AACjE,IAAA,MAAM,MAAA,GAAS,uBAAA,CAAwB,KAAA,CAAM,OAAA,EAAS;AAAA,MACpD,SAAA,EAAW,kBAAA;AAAA,MACX,QAAQ,OAAA,CAAQ,SAAA;AAAA,MAChB,SAAS,OAAA,CAAQ,MAAA,YAAkB,GAAA,GAAM,OAAA,CAAQ,OAAO,IAAA,GAAO,MAAA;AAAA,MAC/D,oBAAoB,oBAAA,CAAqB,kBAAA;AAAA,MACzC,UAAA,EAAY;AAAA,KACb,CAAA;AACD,IAAA,OAAO,IAAI,kBAAkB,MAAA,EAAQ;AAAA,MACnC,QAAQ,OAAA,CAAQ,SAAA;AAAA,MAChB,oBAAoB,oBAAA,CAAqB,YAAA;AAAA,MACzC,gBAAgB,oBAAA,CAAqB;AAAA,KACtC,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,cAAA,CACJ,QAAA,EACA,QAAA,EACA,UAAA,EACmB;AACnB,IAAA,MAAM,UAAU,CAAC,KAAA,KAAmB,oBAAA,CAAqB,KAAA,EAAO,UAAU,QAAQ,CAAA;AAElF,IAAA,MAAM,gBAAA,CAAiB,UAAU,QAAA,EAAU,IAAA,CAAK,SAAS,KAAA,CAAM,UAAU,CAAA,CAAE,KAAA,CAAM,OAAO,CAAA;AACxF,IAAA,IAAI,UAAA,EAAY;AACd,MAAA,MAAM,KAAK,KAAA,CAAM,QAAA,EAAU,QAAQ,CAAA,CAAE,MAAM,OAAO,CAAA;AAAA,IACpD;AACA,IAAA,OAAO,KAAK,OAAA,CAAQ,QAAA,EAAU,QAAQ,CAAA,CAAE,MAAM,OAAO,CAAA;AAAA,EACvD;AAAA,EAEA,MAAM,KAAA,CAAM,QAAA,EAAoB,QAAA,EAAuC;AACrE,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,QAAA,CAAS,GAAA,EAAI;AACpC,IAAA,MAAM,QAAA,GAAW,MAAM,YAAA,CAAa;AAAA,MAClC,QAAA;AAAA,MACA,MAAA,EAAQ,IAAA,CAAK,QAAA,CAAS,KAAA,CAAM,UAAA;AAAA,MAC5B,mBAAA,EAAqB;AAAA,KACtB,CAAA;AACD,IAAA,IAAA,CAAK,OAAA,CAAQ,QAAA,EAAU,QAAA,CAAS,MAAA,CAAO,WAAW,CAAA;AAClD,IAAA,IAAA,CAAK,QAAA,CAAS,OAAO,KAAA,CAAM,eAAA,EAAiB,QAAQ,IAAA,CAAK,QAAA,CAAS,GAAA,EAAI,GAAI,SAAS,CAAA;AAAA,EACrF;AAAA,EAEA,MAAM,OAAA,CAAQ,QAAA,EAAoB,QAAA,EAA2C;AAC3E,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,QAAA,CAAS,GAAA,EAAI;AACpC,IAAA,MAAM,UAAA,GAAa,YAAA,CAAa,QAAA,CAAS,MAAM,CAAA;AAC/C,IAAA,MAAM,aAAA,GAAgB,eAAA,CAAgB,QAAA,CAAS,MAAM,CAAA;AAErD,IAAA,MAAM,OAAA,GAAU,MAAM,MAAA,CAAO;AAAA,MAC3B,MAAA,EAAQ,KAAK,QAAA,CAAS,KAAA;AAAA,MACtB,WAAA,EAAa,KAAA;AAAA,MACb,GAAA,EAAK,QAAA;AAAA,MACL,mBAAA,EAAqB;AAAA,KACtB,CAAA;AACD,IAAA,0BAAA,CAA2B,OAAA,CAAQ,MAAA,CAAO,MAAA,EAAQ,UAAU,CAAA;AAC5D,IAAA,iBAAA,CAAkB,OAAA,CAAQ,OAAO,MAAM,CAAA;AACvC,IAAA,MAAM,YAAA,GAAe,SAAS,QAAA,EAAS;AACvC,IAAA,MAAM,WAAW,0BAAA,CAA2B,OAAA,CAAQ,MAAA,CAAO,MAAA,EAAQ,eAAe,YAAY,CAAA;AAE9F,IAAA,IAAA,CAAK,QAAQ,OAAA,CAAQ,QAAA,EAAU,QAAA,CAAS,MAAA,CAAO,aAAa,QAAQ,CAAA;AACpE,IAAA,IAAA,CAAK,QAAA,CAAS,OAAO,KAAA,CAAM,gBAAA,EAAkB,UAAU,IAAA,CAAK,QAAA,CAAS,GAAA,EAAI,GAAI,SAAS,CAAA;AACtF,IAAA,OAAO,QAAQ,MAAA,CAAO,MAAA;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAA,CAAQ,QAAA,EAAwC,OAAA,EAAiB,QAAA,GAAW,SAAA,EAAiB;AAC3F,IAAA,MAAM,gBAA0B,EAAC;AACjC,IAAA,KAAA,MAAW,WAAW,QAAA,EAAU;AAC9B,MAAA,IAAI,OAAA,CAAQ,YAAY,IAAA,EAAM;AAC5B,QAAA,IAAA,CAAK,SAAS,MAAA,CAAO,KAAA;AAAA,UACnB,CAAA,iCAAA,EAAoC,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,OAAO,CAAC,CAAA,CAAA;AAAA,UAC9E;AAAA,SACF;AACA,QAAA;AAAA,MACF;AACA,MAAA,MAAM,OAAA,GAAU,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,OAAO,CAAA;AACzD,MAAA,IAAI,OAAA,CAAQ,aAAa,OAAA,EAAS;AAChC,QAAA,aAAA,CAAc,KAAK,OAAO,CAAA;AAC1B,QAAA,IAAA,CAAK,QAAA,CAAS,MAAA,CAAO,KAAA,CAAM,OAAO,CAAA;AAAA,MACpC,CAAA,MAAO;AACL,QAAA,IAAA,CAAK,SAAS,MAAA,CAAO,IAAA,CAAK,gBAAgB,OAAA,EAAS,OAAA,CAAQ,MAAM,CAAC,CAAA;AAAA,MACpE;AAAA,IACF;AACA,IAAA,IAAI,aAAA,CAAc,SAAS,CAAA,EAAG;AAC5B,MAAA,MAAM,mBAAmB,aAAa,CAAA;AAAA,IACxC;AAAA,EACF;AACF;AAGA,SAAS,eAAA,CAAgB,SAAiB,MAAA,EAAwB;AAChE,EAAA,OAAO,YAAY,CAAA,EAAG,OAAO,UAAU,MAAM,CAAA,CAAA,EAAI,cAAc,YAAY,CAAA;AAC7E;AAGA,MAAM,SAAA,GAA+B,EAAE,OAAA,EAAS,CAAC,YAAY,OAAA,EAAS,IAAA,EAAM,CAAC,IAAA,KAAS,IAAA,EAAK;AAS3F,SAAS,YAAA,CAAa,QAAA,EAA2B,QAAA,EAA6B,OAAA,EAAiB;AAC7F,EAAA,MAAM,OAAA,GAAU,QAAA,CAAS,OAAA,CAAQ,QAAA,CAAS,OAAO,CAAA;AACjD,EAAA,MAAM,WAAA,GAAc,SAAS,MAAA,CAAO,WAAA;AACpC,EAAA,OAAO,WAAA,KAAgB,UAAU,OAAA,GAAU,CAAA,EAAG,OAAO,CAAA,IAAA,EAAO,gBAAA,CAAiB,WAAW,CAAC,CAAA,CAAA;AAC3F;AAEA,SAAS,cAAA,CACP,OAAA,EACA,QAAA,EACA,OAAA,EACQ;AACR,EAAA,MAAM,QAAA,GAAW,OAAA,CAAQ,QAAA,GAAW,CAAC,CAAA;AACrC,EAAA,MAAM,OAAA,GAAU,QAAA,CAAS,IAAA,CAAK,OAAA,CAAQ,OAAO,CAAA;AAC7C,EAAA,OAAO,QAAA,EAAU,OAAA,GAAU,CAAA,EAAG,OAAO,CAAA,IAAA,EAAO,aAAa,QAAA,EAAU,QAAA,EAAU,OAAO,CAAC,CAAA,CAAA,GAAK,OAAA;AAC5F;AAGO,SAAS,0BAA0B,OAAA,EAAmD;AAC3F,EAAA,OAAO,IAAI,oBAAoB,OAAO,CAAA;AACxC;;"}
|
|
@@ -8,6 +8,7 @@ const errors = require('../../domain/errors.cjs');
|
|
|
8
8
|
const urlSecrets = require('../../domain/url-secrets.cjs');
|
|
9
9
|
const aliasLimit = require('./alias-limit.cjs');
|
|
10
10
|
const allowedHosts = require('./allowed-hosts.cjs');
|
|
11
|
+
const mappingSchemaNames = require('./mapping-schema-names.cjs');
|
|
11
12
|
const remoteNodeLimit = require('./remote-node-limit.cjs');
|
|
12
13
|
const schemaLoadErrors = require('./schema-load-errors.cjs');
|
|
13
14
|
|
|
@@ -100,20 +101,32 @@ class RefAccessResolver extends openapiCore.BaseResolver {
|
|
|
100
101
|
}
|
|
101
102
|
return super.resolveDocument(base, ref, isRoot);
|
|
102
103
|
}
|
|
103
|
-
/**
|
|
104
|
+
/**
|
|
105
|
+
* Refuse a YAML alias bomb before Redocly walks it (pre-beta test plan 10.2). A document a
|
|
106
|
+
* `$ref` loads has its own `components.schemas`, so its mapping names point at those schemas
|
|
107
|
+
* before Redocly resolves them, as the root's do (`pointMappingNamesAtSchemas`).
|
|
108
|
+
*/
|
|
104
109
|
parseDocument(source, isRoot = false) {
|
|
105
110
|
const document = this.#parsed(source, isRoot);
|
|
106
111
|
const failure = aliasLimit.aliasExpansionFailure(document.parsed);
|
|
107
112
|
if (failure !== void 0) {
|
|
108
113
|
throw new openapiCore.YamlParseError(failure, source);
|
|
109
114
|
}
|
|
115
|
+
mappingSchemaNames.pointMappingNamesAtSchemas(document.parsed);
|
|
110
116
|
return document;
|
|
111
117
|
}
|
|
112
|
-
/**
|
|
118
|
+
/**
|
|
119
|
+
* A remote document is parsed within the node limit; a local one as Redocly parses it. Whether
|
|
120
|
+
* a remote one is parsed at all is decided here (`isParsedSource`), since Redocly read the
|
|
121
|
+
* extension of a URL with its query.
|
|
122
|
+
*/
|
|
113
123
|
#parsed(source, isRoot) {
|
|
114
|
-
if (!isRemoteRef(source.absoluteRef)
|
|
124
|
+
if (!isRemoteRef(source.absoluteRef)) {
|
|
115
125
|
return super.parseDocument(source, isRoot);
|
|
116
126
|
}
|
|
127
|
+
if (!remoteNodeLimit.isParsedSource(source, isRoot)) {
|
|
128
|
+
return { source, parsed: source.body };
|
|
129
|
+
}
|
|
117
130
|
try {
|
|
118
131
|
return this.#nodeLimit.parse(source);
|
|
119
132
|
} catch (error) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ref-access.cjs","sources":["../../../src/adapters/redocly-loader/ref-access.ts"],"sourcesContent":["import { realpath } from \"node:fs/promises\";\nimport path from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\nimport {\n BaseResolver,\n type Document,\n type Config as RedoclyConfig,\n type Source,\n YamlParseError,\n} from \"@redocly/openapi-core\";\nimport type { RefAccess } from \"../../application/ports/schema-loader.js\";\nimport { ERROR_CODES, type OpenAPITypesafeError } from \"../../domain/errors.js\";\nimport { redactUrlSecrets } from \"../../domain/url-secrets.js\";\nimport { aliasExpansionFailure } from \"./alias-limit.js\";\nimport { isHostAllowed } from \"./allowed-hosts.js\";\nimport { isParsedSource, RemoteNodeLimit } from \"./remote-node-limit.js\";\nimport { refForbiddenError } from \"./schema-load-errors.js\";\n\n/**\n * Limits on where `$ref` documents may be loaded from (threat model R1 and R2, ADR-017). The root\n * document is chosen by the developer and is always loaded; every other document must pass.\n */\n\ntype ResolveConfig = RedoclyConfig[\"resolve\"];\n\n/** Redocly treats only these prefixes as remote; any other `$ref` is a local file path. */\nfunction isRemoteRef(absoluteRef: string): boolean {\n return absoluteRef.startsWith(\"http://\") || absoluteRef.startsWith(\"https://\");\n}\n\n/** Whether `target` is `root` or below it; both are absolute paths. */\nexport function isInsideDirectory(target: string, root: string): boolean {\n const relative = path.relative(root, target);\n // Compare the first segment: a directory named `..hidden` is inside, `../x` is not.\n const isParent = relative === \"..\" || relative.startsWith(`..${path.sep}`);\n return !isParent && !path.isAbsolute(relative);\n}\n\n/** The real path, so a link inside the root that points outside it is caught. */\nasync function realPathOrSelf(file: string): Promise<string> {\n const absolute = path.resolve(file);\n try {\n return await realpath(absolute);\n } catch (error) {\n // A missing file is never read, and Redocly reports it. Resolve its nearest existing\n // directory instead, so it compares with the root's real path: the root may be reached\n // through a link (macOS `/tmp` is one), and the missing file must not look outside it.\n const parent = path.dirname(absolute);\n if ((error as NodeJS.ErrnoException).code === \"ENOENT\" && parent !== absolute) {\n return path.join(await realPathOrSelf(parent), path.basename(absolute));\n }\n throw error;\n }\n}\n\nasync function localRefusal(\n absoluteRef: string,\n localRoot: URL,\n): Promise<OpenAPITypesafeError | undefined> {\n const root = await realPathOrSelf(fileURLToPath(localRoot));\n if (isInsideDirectory(await realPathOrSelf(absoluteRef), root)) {\n return undefined;\n }\n return refForbiddenError(absoluteRef, { reason: \"outside-local-root\", localRoot: root });\n}\n\n/** The refusal for one document, or undefined when the limits allow it. */\nexport async function refusalOf(\n absoluteRef: string,\n access: RefAccess,\n): Promise<OpenAPITypesafeError | undefined> {\n if (!isRemoteRef(absoluteRef)) {\n return access.localRoot === undefined ? undefined : localRefusal(absoluteRef, access.localRoot);\n }\n if (access.remoteHosts === undefined || isHostAllowed(new URL(absoluteRef), access.remoteHosts)) {\n return undefined;\n }\n return refForbiddenError(absoluteRef, {\n reason: \"host-not-allowed\",\n allowedHosts: [...access.remoteHosts],\n });\n}\n\n/**\n * A remote document may refer only to other URLs (threat model T3). Redocly resolves a `$ref`\n * against a URL base with `new URL()`, so `C:/x` becomes `c:/x` and `file:///x` stays as it is;\n * Redocly then reads either from disk, and on Windows a drive letter is an absolute path.\n */\nfunction localFromRemoteRefusal(\n base: string,\n absoluteRef: string,\n): OpenAPITypesafeError | undefined {\n if (!isRemoteRef(base) || isRemoteRef(absoluteRef)) {\n return undefined;\n }\n const shownBase = redactUrlSecrets(base);\n return refForbiddenError(absoluteRef, { reason: \"local-ref-from-remote\", base: shownBase });\n}\n\n/** The scheme of an `http(s)` URL, in any case. */\nconst REMOTE_SCHEME_RE = /^https?:(?=\\/\\/)/i;\n\n/** The limits one resolver checks; each load gets its own resolver. */\nexport interface RefAccessLimits {\n readonly access: RefAccess;\n /** Remote documents one load may fetch, the root included (threat model T2). */\n readonly maxRemoteDocuments: number;\n /** Nodes the remote documents of one load may parse into together (threat model T2). */\n readonly maxRemoteNodes: number;\n}\n\n/**\n * A Redocly resolver that checks each document before it loads it. Redocly turns a failed load\n * into an unresolved-`$ref` problem, so the refusals are also kept for the loader to report as\n * the typed error.\n */\nexport class RefAccessResolver extends BaseResolver {\n readonly #limits: RefAccessLimits;\n readonly #nodeLimit: RemoteNodeLimit;\n readonly #refusals: OpenAPITypesafeError[] = [];\n /** The root document's ref: it is chosen by the developer, so it is not limited. */\n #rootRef: string | undefined;\n /** Remote documents asked for so far; Redocly caches each one, so each is counted once. */\n #remoteDocumentCount = 0;\n\n constructor(config: ResolveConfig, limits: RefAccessLimits) {\n super(config);\n this.#limits = limits;\n this.#nodeLimit = new RemoteNodeLimit(limits.maxRemoteNodes);\n }\n\n /** The first document that was refused, if any. */\n get firstRefusal(): OpenAPITypesafeError | undefined {\n return this.#refusals[0];\n }\n\n /**\n * A scheme is the same in any case (RFC 3986, section 3.1), but Redocly takes only `http://` and\n * `https://` as URLs: it read `HTTP://host/x.yaml` as a file path, and its \"not found\" message\n * showed the user info and the query of the URL, which no longer looked like one. The scheme\n * is written in lowercase first, so the `$ref` loads as the URL it is, within the same limits.\n */\n override resolveExternalRef(base: string | null, ref: string): string {\n const normalized = ref.replace(REMOTE_SCHEME_RE, (scheme) => scheme.toLowerCase());\n return super.resolveExternalRef(base, normalized);\n }\n\n override resolveDocument(\n base: string | null,\n ref: string,\n isRoot = false,\n ): ReturnType<BaseResolver[\"resolveDocument\"]> {\n if (isRoot) {\n this.#rootRef = this.resolveExternalRef(base, ref);\n }\n const refusal =\n base === null ? undefined : localFromRemoteRefusal(base, this.resolveExternalRef(base, ref));\n if (refusal !== undefined) {\n this.#refusals.push(refusal);\n return Promise.reject(refusal);\n }\n return super.resolveDocument(base, ref, isRoot);\n }\n\n /** Refuse a YAML alias bomb before Redocly walks it (pre-beta test plan 10.2). */\n override parseDocument(source: Source, isRoot = false): Document {\n const document = this.#parsed(source, isRoot);\n const failure = aliasExpansionFailure(document.parsed);\n if (failure !== undefined) {\n throw new YamlParseError(failure, source);\n }\n return document;\n }\n\n /** A remote document is parsed within the node limit; any other one as Redocly parses it. */\n #parsed(source: Source, isRoot: boolean): Document {\n if (!isRemoteRef(source.absoluteRef) || !isParsedSource(source, isRoot)) {\n return super.parseDocument(source, isRoot);\n }\n try {\n return this.#nodeLimit.parse(source);\n } catch (error) {\n if (isRefusal(error)) {\n this.#refusals.push(error);\n }\n throw new YamlParseError(error as Error, source);\n }\n }\n\n override async loadExternalRef(absoluteRef: string): Promise<Source> {\n const refusal = this.#countRefusal(absoluteRef) ?? (await this.#accessRefusal(absoluteRef));\n if (refusal !== undefined) {\n this.#refusals.push(refusal);\n throw refusal;\n }\n try {\n return await super.loadExternalRef(absoluteRef);\n } catch (error) {\n // A refused redirect throws inside the fetch, and Redocly wraps it in a ResolveError.\n const cause = (error as { originalError?: unknown }).originalError;\n if (isRefusal(cause)) {\n this.#refusals.push(cause);\n }\n throw error;\n }\n }\n\n #accessRefusal(absoluteRef: string): Promise<OpenAPITypesafeError | undefined> {\n return absoluteRef === this.#rootRef\n ? Promise.resolve(undefined)\n : refusalOf(absoluteRef, this.#limits.access);\n }\n\n /**\n * A document that changes all its URLs can fan out without end: 150 `$ref`s per document, three\n * levels deep, made 16,212 requests and exhausted the local ports (audit B2, F4).\n */\n #countRefusal(absoluteRef: string): OpenAPITypesafeError | undefined {\n if (!isRemoteRef(absoluteRef)) {\n return undefined;\n }\n this.#remoteDocumentCount += 1;\n const { maxRemoteDocuments } = this.#limits;\n return this.#remoteDocumentCount > maxRemoteDocuments\n ? refForbiddenError(absoluteRef, {\n reason: \"too-many-remote-documents\",\n maxDocuments: maxRemoteDocuments,\n })\n : undefined;\n }\n}\n\nfunction isRefusal(value: unknown): value is OpenAPITypesafeError {\n return (value as { code?: unknown } | null)?.code === ERROR_CODES.SCHEMA_REF_FORBIDDEN;\n}\n"],"names":["path","realpath","fileURLToPath","refForbiddenError","isHostAllowed","redactUrlSecrets","BaseResolver","RemoteNodeLimit","aliasExpansionFailure","YamlParseError","isParsedSource","ERROR_CODES"],"mappings":";;;;;;;;;;;;;;;;;AA0BA,SAAS,YAAY,WAAA,EAA8B;AACjD,EAAA,OAAO,YAAY,UAAA,CAAW,SAAS,CAAA,IAAK,WAAA,CAAY,WAAW,UAAU,CAAA;AAC/E;AAGO,SAAS,iBAAA,CAAkB,QAAgB,IAAA,EAAuB;AACvE,EAAA,MAAM,QAAA,GAAWA,aAAA,CAAK,QAAA,CAAS,IAAA,EAAM,MAAM,CAAA;AAE3C,EAAA,MAAM,QAAA,GAAW,aAAa,IAAA,IAAQ,QAAA,CAAS,WAAW,CAAA,EAAA,EAAKA,aAAA,CAAK,GAAG,CAAA,CAAE,CAAA;AACzE,EAAA,OAAO,CAAC,QAAA,IAAY,CAACA,aAAA,CAAK,WAAW,QAAQ,CAAA;AAC/C;AAGA,eAAe,eAAe,IAAA,EAA+B;AAC3D,EAAA,MAAM,QAAA,GAAWA,aAAA,CAAK,OAAA,CAAQ,IAAI,CAAA;AAClC,EAAA,IAAI;AACF,IAAA,OAAO,MAAMC,kBAAS,QAAQ,CAAA;AAAA,EAChC,SAAS,KAAA,EAAO;AAId,IAAA,MAAM,MAAA,GAASD,aAAA,CAAK,OAAA,CAAQ,QAAQ,CAAA;AACpC,IAAA,IAAK,KAAA,CAAgC,IAAA,KAAS,QAAA,IAAY,MAAA,KAAW,QAAA,EAAU;AAC7E,MAAA,OAAOA,aAAA,CAAK,KAAK,MAAM,cAAA,CAAe,MAAM,CAAA,EAAGA,aAAA,CAAK,QAAA,CAAS,QAAQ,CAAC,CAAA;AAAA,IACxE;AACA,IAAA,MAAM,KAAA;AAAA,EACR;AACF;AAEA,eAAe,YAAA,CACb,aACA,SAAA,EAC2C;AAC3C,EAAA,MAAM,IAAA,GAAO,MAAM,cAAA,CAAeE,sBAAA,CAAc,SAAS,CAAC,CAAA;AAC1D,EAAA,IAAI,kBAAkB,MAAM,cAAA,CAAe,WAAW,CAAA,EAAG,IAAI,CAAA,EAAG;AAC9D,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,OAAOC,mCAAkB,WAAA,EAAa,EAAE,QAAQ,oBAAA,EAAsB,SAAA,EAAW,MAAM,CAAA;AACzF;AAGA,eAAsB,SAAA,CACpB,aACA,MAAA,EAC2C;AAC3C,EAAA,IAAI,CAAC,WAAA,CAAY,WAAW,CAAA,EAAG;AAC7B,IAAA,OAAO,OAAO,SAAA,KAAc,MAAA,GAAY,SAAY,YAAA,CAAa,WAAA,EAAa,OAAO,SAAS,CAAA;AAAA,EAChG;AACA,EAAA,IAAI,MAAA,CAAO,WAAA,KAAgB,MAAA,IAAaC,0BAAA,CAAc,IAAI,IAAI,WAAW,CAAA,EAAG,MAAA,CAAO,WAAW,CAAA,EAAG;AAC/F,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,OAAOD,mCAAkB,WAAA,EAAa;AAAA,IACpC,MAAA,EAAQ,kBAAA;AAAA,IACR,YAAA,EAAc,CAAC,GAAG,MAAA,CAAO,WAAW;AAAA,GACrC,CAAA;AACH;AAOA,SAAS,sBAAA,CACP,MACA,WAAA,EACkC;AAClC,EAAA,IAAI,CAAC,WAAA,CAAY,IAAI,CAAA,IAAK,WAAA,CAAY,WAAW,CAAA,EAAG;AAClD,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,MAAM,SAAA,GAAYE,4BAAiB,IAAI,CAAA;AACvC,EAAA,OAAOF,mCAAkB,WAAA,EAAa,EAAE,QAAQ,uBAAA,EAAyB,IAAA,EAAM,WAAW,CAAA;AAC5F;AAGA,MAAM,gBAAA,GAAmB,mBAAA;AAgBlB,MAAM,0BAA0BG,wBAAA,CAAa;AAAA,EACzC,OAAA;AAAA,EACA,UAAA;AAAA,EACA,YAAoC,EAAC;AAAA;AAAA,EAE9C,QAAA;AAAA;AAAA,EAEA,oBAAA,GAAuB,CAAA;AAAA,EAEvB,WAAA,CAAY,QAAuB,MAAA,EAAyB;AAC1D,IAAA,KAAA,CAAM,MAAM,CAAA;AACZ,IAAA,IAAA,CAAK,OAAA,GAAU,MAAA;AACf,IAAA,IAAA,CAAK,UAAA,GAAa,IAAIC,+BAAA,CAAgB,MAAA,CAAO,cAAc,CAAA;AAAA,EAC7D;AAAA;AAAA,EAGA,IAAI,YAAA,GAAiD;AACnD,IAAA,OAAO,IAAA,CAAK,UAAU,CAAC,CAAA;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQS,kBAAA,CAAmB,MAAqB,GAAA,EAAqB;AACpE,IAAA,MAAM,UAAA,GAAa,IAAI,OAAA,CAAQ,gBAAA,EAAkB,CAAC,MAAA,KAAW,MAAA,CAAO,aAAa,CAAA;AACjF,IAAA,OAAO,KAAA,CAAM,kBAAA,CAAmB,IAAA,EAAM,UAAU,CAAA;AAAA,EAClD;AAAA,EAES,eAAA,CACP,IAAA,EACA,GAAA,EACA,MAAA,GAAS,KAAA,EACoC;AAC7C,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,IAAA,CAAK,QAAA,GAAW,IAAA,CAAK,kBAAA,CAAmB,IAAA,EAAM,GAAG,CAAA;AAAA,IACnD;AACA,IAAA,MAAM,OAAA,GACJ,IAAA,KAAS,IAAA,GAAO,MAAA,GAAY,sBAAA,CAAuB,MAAM,IAAA,CAAK,kBAAA,CAAmB,IAAA,EAAM,GAAG,CAAC,CAAA;AAC7F,IAAA,IAAI,YAAY,MAAA,EAAW;AACzB,MAAA,IAAA,CAAK,SAAA,CAAU,KAAK,OAAO,CAAA;AAC3B,MAAA,OAAO,OAAA,CAAQ,OAAO,OAAO,CAAA;AAAA,IAC/B;AACA,IAAA,OAAO,KAAA,CAAM,eAAA,CAAgB,IAAA,EAAM,GAAA,EAAK,MAAM,CAAA;AAAA,EAChD;AAAA;AAAA,EAGS,aAAA,CAAc,MAAA,EAAgB,MAAA,GAAS,KAAA,EAAiB;AAC/D,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,OAAA,CAAQ,MAAA,EAAQ,MAAM,CAAA;AAC5C,IAAA,MAAM,OAAA,GAAUC,gCAAA,CAAsB,QAAA,CAAS,MAAM,CAAA;AACrD,IAAA,IAAI,YAAY,MAAA,EAAW;AACzB,MAAA,MAAM,IAAIC,0BAAA,CAAe,OAAA,EAAS,MAAM,CAAA;AAAA,IAC1C;AACA,IAAA,OAAO,QAAA;AAAA,EACT;AAAA;AAAA,EAGA,OAAA,CAAQ,QAAgB,MAAA,EAA2B;AACjD,IAAA,IAAI,CAAC,YAAY,MAAA,CAAO,WAAW,KAAK,CAACC,8BAAA,CAAe,MAAA,EAAQ,MAAM,CAAA,EAAG;AACvE,MAAA,OAAO,KAAA,CAAM,aAAA,CAAc,MAAA,EAAQ,MAAM,CAAA;AAAA,IAC3C;AACA,IAAA,IAAI;AACF,MAAA,OAAO,IAAA,CAAK,UAAA,CAAW,KAAA,CAAM,MAAM,CAAA;AAAA,IACrC,SAAS,KAAA,EAAO;AACd,MAAA,IAAI,SAAA,CAAU,KAAK,CAAA,EAAG;AACpB,QAAA,IAAA,CAAK,SAAA,CAAU,KAAK,KAAK,CAAA;AAAA,MAC3B;AACA,MAAA,MAAM,IAAID,0BAAA,CAAe,KAAA,EAAgB,MAAM,CAAA;AAAA,IACjD;AAAA,EACF;AAAA,EAEA,MAAe,gBAAgB,WAAA,EAAsC;AACnE,IAAA,MAAM,OAAA,GAAU,KAAK,aAAA,CAAc,WAAW,KAAM,MAAM,IAAA,CAAK,eAAe,WAAW,CAAA;AACzF,IAAA,IAAI,YAAY,MAAA,EAAW;AACzB,MAAA,IAAA,CAAK,SAAA,CAAU,KAAK,OAAO,CAAA;AAC3B,MAAA,MAAM,OAAA;AAAA,IACR;AACA,IAAA,IAAI;AACF,MAAA,OAAO,MAAM,KAAA,CAAM,eAAA,CAAgB,WAAW,CAAA;AAAA,IAChD,SAAS,KAAA,EAAO;AAEd,MAAA,MAAM,QAAS,KAAA,CAAsC,aAAA;AACrD,MAAA,IAAI,SAAA,CAAU,KAAK,CAAA,EAAG;AACpB,QAAA,IAAA,CAAK,SAAA,CAAU,KAAK,KAAK,CAAA;AAAA,MAC3B;AACA,MAAA,MAAM,KAAA;AAAA,IACR;AAAA,EACF;AAAA,EAEA,eAAe,WAAA,EAAgE;AAC7E,IAAA,OAAO,WAAA,KAAgB,IAAA,CAAK,QAAA,GACxB,OAAA,CAAQ,OAAA,CAAQ,MAAS,CAAA,GACzB,SAAA,CAAU,WAAA,EAAa,IAAA,CAAK,OAAA,CAAQ,MAAM,CAAA;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,cAAc,WAAA,EAAuD;AACnE,IAAA,IAAI,CAAC,WAAA,CAAY,WAAW,CAAA,EAAG;AAC7B,MAAA,OAAO,MAAA;AAAA,IACT;AACA,IAAA,IAAA,CAAK,oBAAA,IAAwB,CAAA;AAC7B,IAAA,MAAM,EAAE,kBAAA,EAAmB,GAAI,IAAA,CAAK,OAAA;AACpC,IAAA,OAAO,IAAA,CAAK,oBAAA,GAAuB,kBAAA,GAC/BN,kCAAA,CAAkB,WAAA,EAAa;AAAA,MAC7B,MAAA,EAAQ,2BAAA;AAAA,MACR,YAAA,EAAc;AAAA,KACf,CAAA,GACD,MAAA;AAAA,EACN;AACF;AAEA,SAAS,UAAU,KAAA,EAA+C;AAChE,EAAA,OAAQ,KAAA,EAAqC,SAASQ,kBAAA,CAAY,oBAAA;AACpE;;;;"}
|
|
1
|
+
{"version":3,"file":"ref-access.cjs","sources":["../../../src/adapters/redocly-loader/ref-access.ts"],"sourcesContent":["import { realpath } from \"node:fs/promises\";\nimport path from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\nimport {\n BaseResolver,\n type Document,\n type Config as RedoclyConfig,\n type Source,\n YamlParseError,\n} from \"@redocly/openapi-core\";\nimport type { RefAccess } from \"../../application/ports/schema-loader.js\";\nimport { ERROR_CODES, type OpenAPITypesafeError } from \"../../domain/errors.js\";\nimport { redactUrlSecrets } from \"../../domain/url-secrets.js\";\nimport { aliasExpansionFailure } from \"./alias-limit.js\";\nimport { isHostAllowed } from \"./allowed-hosts.js\";\nimport { pointMappingNamesAtSchemas } from \"./mapping-schema-names.js\";\nimport { isParsedSource, RemoteNodeLimit } from \"./remote-node-limit.js\";\nimport { refForbiddenError } from \"./schema-load-errors.js\";\n\n/**\n * Limits on where `$ref` documents may be loaded from (threat model R1 and R2, ADR-017). The root\n * document is chosen by the developer and is always loaded; every other document must pass.\n */\n\ntype ResolveConfig = RedoclyConfig[\"resolve\"];\n\n/** Redocly treats only these prefixes as remote; any other `$ref` is a local file path. */\nfunction isRemoteRef(absoluteRef: string): boolean {\n return absoluteRef.startsWith(\"http://\") || absoluteRef.startsWith(\"https://\");\n}\n\n/** Whether `target` is `root` or below it; both are absolute paths. */\nexport function isInsideDirectory(target: string, root: string): boolean {\n const relative = path.relative(root, target);\n // Compare the first segment: a directory named `..hidden` is inside, `../x` is not.\n const isParent = relative === \"..\" || relative.startsWith(`..${path.sep}`);\n return !isParent && !path.isAbsolute(relative);\n}\n\n/** The real path, so a link inside the root that points outside it is caught. */\nasync function realPathOrSelf(file: string): Promise<string> {\n const absolute = path.resolve(file);\n try {\n return await realpath(absolute);\n } catch (error) {\n // A missing file is never read, and Redocly reports it. Resolve its nearest existing\n // directory instead, so it compares with the root's real path: the root may be reached\n // through a link (macOS `/tmp` is one), and the missing file must not look outside it.\n const parent = path.dirname(absolute);\n if ((error as NodeJS.ErrnoException).code === \"ENOENT\" && parent !== absolute) {\n return path.join(await realPathOrSelf(parent), path.basename(absolute));\n }\n throw error;\n }\n}\n\nasync function localRefusal(\n absoluteRef: string,\n localRoot: URL,\n): Promise<OpenAPITypesafeError | undefined> {\n const root = await realPathOrSelf(fileURLToPath(localRoot));\n if (isInsideDirectory(await realPathOrSelf(absoluteRef), root)) {\n return undefined;\n }\n return refForbiddenError(absoluteRef, { reason: \"outside-local-root\", localRoot: root });\n}\n\n/** The refusal for one document, or undefined when the limits allow it. */\nexport async function refusalOf(\n absoluteRef: string,\n access: RefAccess,\n): Promise<OpenAPITypesafeError | undefined> {\n if (!isRemoteRef(absoluteRef)) {\n return access.localRoot === undefined ? undefined : localRefusal(absoluteRef, access.localRoot);\n }\n if (access.remoteHosts === undefined || isHostAllowed(new URL(absoluteRef), access.remoteHosts)) {\n return undefined;\n }\n return refForbiddenError(absoluteRef, {\n reason: \"host-not-allowed\",\n allowedHosts: [...access.remoteHosts],\n });\n}\n\n/**\n * A remote document may refer only to other URLs (threat model T3). Redocly resolves a `$ref`\n * against a URL base with `new URL()`, so `C:/x` becomes `c:/x` and `file:///x` stays as it is;\n * Redocly then reads either from disk, and on Windows a drive letter is an absolute path.\n */\nfunction localFromRemoteRefusal(\n base: string,\n absoluteRef: string,\n): OpenAPITypesafeError | undefined {\n if (!isRemoteRef(base) || isRemoteRef(absoluteRef)) {\n return undefined;\n }\n const shownBase = redactUrlSecrets(base);\n return refForbiddenError(absoluteRef, { reason: \"local-ref-from-remote\", base: shownBase });\n}\n\n/** The scheme of an `http(s)` URL, in any case. */\nconst REMOTE_SCHEME_RE = /^https?:(?=\\/\\/)/i;\n\n/** The limits one resolver checks; each load gets its own resolver. */\nexport interface RefAccessLimits {\n readonly access: RefAccess;\n /** Remote documents one load may fetch, the root included (threat model T2). */\n readonly maxRemoteDocuments: number;\n /** Nodes the remote documents of one load may parse into together (threat model T2). */\n readonly maxRemoteNodes: number;\n}\n\n/**\n * A Redocly resolver that checks each document before it loads it. Redocly turns a failed load\n * into an unresolved-`$ref` problem, so the refusals are also kept for the loader to report as\n * the typed error.\n */\nexport class RefAccessResolver extends BaseResolver {\n readonly #limits: RefAccessLimits;\n readonly #nodeLimit: RemoteNodeLimit;\n readonly #refusals: OpenAPITypesafeError[] = [];\n /** The root document's ref: it is chosen by the developer, so it is not limited. */\n #rootRef: string | undefined;\n /** Remote documents asked for so far; Redocly caches each one, so each is counted once. */\n #remoteDocumentCount = 0;\n\n constructor(config: ResolveConfig, limits: RefAccessLimits) {\n super(config);\n this.#limits = limits;\n this.#nodeLimit = new RemoteNodeLimit(limits.maxRemoteNodes);\n }\n\n /** The first document that was refused, if any. */\n get firstRefusal(): OpenAPITypesafeError | undefined {\n return this.#refusals[0];\n }\n\n /**\n * A scheme is the same in any case (RFC 3986, section 3.1), but Redocly takes only `http://` and\n * `https://` as URLs: it read `HTTP://host/x.yaml` as a file path, and its \"not found\" message\n * showed the user info and the query of the URL, which no longer looked like one. The scheme\n * is written in lowercase first, so the `$ref` loads as the URL it is, within the same limits.\n */\n override resolveExternalRef(base: string | null, ref: string): string {\n const normalized = ref.replace(REMOTE_SCHEME_RE, (scheme) => scheme.toLowerCase());\n return super.resolveExternalRef(base, normalized);\n }\n\n override resolveDocument(\n base: string | null,\n ref: string,\n isRoot = false,\n ): ReturnType<BaseResolver[\"resolveDocument\"]> {\n if (isRoot) {\n this.#rootRef = this.resolveExternalRef(base, ref);\n }\n const refusal =\n base === null ? undefined : localFromRemoteRefusal(base, this.resolveExternalRef(base, ref));\n if (refusal !== undefined) {\n this.#refusals.push(refusal);\n return Promise.reject(refusal);\n }\n return super.resolveDocument(base, ref, isRoot);\n }\n\n /**\n * Refuse a YAML alias bomb before Redocly walks it (pre-beta test plan 10.2). A document a\n * `$ref` loads has its own `components.schemas`, so its mapping names point at those schemas\n * before Redocly resolves them, as the root's do (`pointMappingNamesAtSchemas`).\n */\n override parseDocument(source: Source, isRoot = false): Document {\n const document = this.#parsed(source, isRoot);\n const failure = aliasExpansionFailure(document.parsed);\n if (failure !== undefined) {\n throw new YamlParseError(failure, source);\n }\n pointMappingNamesAtSchemas(document.parsed);\n return document;\n }\n\n /**\n * A remote document is parsed within the node limit; a local one as Redocly parses it. Whether\n * a remote one is parsed at all is decided here (`isParsedSource`), since Redocly read the\n * extension of a URL with its query.\n */\n #parsed(source: Source, isRoot: boolean): Document {\n if (!isRemoteRef(source.absoluteRef)) {\n return super.parseDocument(source, isRoot);\n }\n if (!isParsedSource(source, isRoot)) {\n return { source, parsed: source.body };\n }\n try {\n return this.#nodeLimit.parse(source);\n } catch (error) {\n if (isRefusal(error)) {\n this.#refusals.push(error);\n }\n throw new YamlParseError(error as Error, source);\n }\n }\n\n override async loadExternalRef(absoluteRef: string): Promise<Source> {\n const refusal = this.#countRefusal(absoluteRef) ?? (await this.#accessRefusal(absoluteRef));\n if (refusal !== undefined) {\n this.#refusals.push(refusal);\n throw refusal;\n }\n try {\n return await super.loadExternalRef(absoluteRef);\n } catch (error) {\n // A refused redirect throws inside the fetch, and Redocly wraps it in a ResolveError.\n const cause = (error as { originalError?: unknown }).originalError;\n if (isRefusal(cause)) {\n this.#refusals.push(cause);\n }\n throw error;\n }\n }\n\n #accessRefusal(absoluteRef: string): Promise<OpenAPITypesafeError | undefined> {\n return absoluteRef === this.#rootRef\n ? Promise.resolve(undefined)\n : refusalOf(absoluteRef, this.#limits.access);\n }\n\n /**\n * A document that changes all its URLs can fan out without end: 150 `$ref`s per document, three\n * levels deep, made 16,212 requests and exhausted the local ports (audit B2, F4).\n */\n #countRefusal(absoluteRef: string): OpenAPITypesafeError | undefined {\n if (!isRemoteRef(absoluteRef)) {\n return undefined;\n }\n this.#remoteDocumentCount += 1;\n const { maxRemoteDocuments } = this.#limits;\n return this.#remoteDocumentCount > maxRemoteDocuments\n ? refForbiddenError(absoluteRef, {\n reason: \"too-many-remote-documents\",\n maxDocuments: maxRemoteDocuments,\n })\n : undefined;\n }\n}\n\nfunction isRefusal(value: unknown): value is OpenAPITypesafeError {\n return (value as { code?: unknown } | null)?.code === ERROR_CODES.SCHEMA_REF_FORBIDDEN;\n}\n"],"names":["path","realpath","fileURLToPath","refForbiddenError","isHostAllowed","redactUrlSecrets","BaseResolver","RemoteNodeLimit","aliasExpansionFailure","YamlParseError","pointMappingNamesAtSchemas","isParsedSource","ERROR_CODES"],"mappings":";;;;;;;;;;;;;;;;;;AA2BA,SAAS,YAAY,WAAA,EAA8B;AACjD,EAAA,OAAO,YAAY,UAAA,CAAW,SAAS,CAAA,IAAK,WAAA,CAAY,WAAW,UAAU,CAAA;AAC/E;AAGO,SAAS,iBAAA,CAAkB,QAAgB,IAAA,EAAuB;AACvE,EAAA,MAAM,QAAA,GAAWA,aAAA,CAAK,QAAA,CAAS,IAAA,EAAM,MAAM,CAAA;AAE3C,EAAA,MAAM,QAAA,GAAW,aAAa,IAAA,IAAQ,QAAA,CAAS,WAAW,CAAA,EAAA,EAAKA,aAAA,CAAK,GAAG,CAAA,CAAE,CAAA;AACzE,EAAA,OAAO,CAAC,QAAA,IAAY,CAACA,aAAA,CAAK,WAAW,QAAQ,CAAA;AAC/C;AAGA,eAAe,eAAe,IAAA,EAA+B;AAC3D,EAAA,MAAM,QAAA,GAAWA,aAAA,CAAK,OAAA,CAAQ,IAAI,CAAA;AAClC,EAAA,IAAI;AACF,IAAA,OAAO,MAAMC,kBAAS,QAAQ,CAAA;AAAA,EAChC,SAAS,KAAA,EAAO;AAId,IAAA,MAAM,MAAA,GAASD,aAAA,CAAK,OAAA,CAAQ,QAAQ,CAAA;AACpC,IAAA,IAAK,KAAA,CAAgC,IAAA,KAAS,QAAA,IAAY,MAAA,KAAW,QAAA,EAAU;AAC7E,MAAA,OAAOA,aAAA,CAAK,KAAK,MAAM,cAAA,CAAe,MAAM,CAAA,EAAGA,aAAA,CAAK,QAAA,CAAS,QAAQ,CAAC,CAAA;AAAA,IACxE;AACA,IAAA,MAAM,KAAA;AAAA,EACR;AACF;AAEA,eAAe,YAAA,CACb,aACA,SAAA,EAC2C;AAC3C,EAAA,MAAM,IAAA,GAAO,MAAM,cAAA,CAAeE,sBAAA,CAAc,SAAS,CAAC,CAAA;AAC1D,EAAA,IAAI,kBAAkB,MAAM,cAAA,CAAe,WAAW,CAAA,EAAG,IAAI,CAAA,EAAG;AAC9D,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,OAAOC,mCAAkB,WAAA,EAAa,EAAE,QAAQ,oBAAA,EAAsB,SAAA,EAAW,MAAM,CAAA;AACzF;AAGA,eAAsB,SAAA,CACpB,aACA,MAAA,EAC2C;AAC3C,EAAA,IAAI,CAAC,WAAA,CAAY,WAAW,CAAA,EAAG;AAC7B,IAAA,OAAO,OAAO,SAAA,KAAc,MAAA,GAAY,SAAY,YAAA,CAAa,WAAA,EAAa,OAAO,SAAS,CAAA;AAAA,EAChG;AACA,EAAA,IAAI,MAAA,CAAO,WAAA,KAAgB,MAAA,IAAaC,0BAAA,CAAc,IAAI,IAAI,WAAW,CAAA,EAAG,MAAA,CAAO,WAAW,CAAA,EAAG;AAC/F,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,OAAOD,mCAAkB,WAAA,EAAa;AAAA,IACpC,MAAA,EAAQ,kBAAA;AAAA,IACR,YAAA,EAAc,CAAC,GAAG,MAAA,CAAO,WAAW;AAAA,GACrC,CAAA;AACH;AAOA,SAAS,sBAAA,CACP,MACA,WAAA,EACkC;AAClC,EAAA,IAAI,CAAC,WAAA,CAAY,IAAI,CAAA,IAAK,WAAA,CAAY,WAAW,CAAA,EAAG;AAClD,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,MAAM,SAAA,GAAYE,4BAAiB,IAAI,CAAA;AACvC,EAAA,OAAOF,mCAAkB,WAAA,EAAa,EAAE,QAAQ,uBAAA,EAAyB,IAAA,EAAM,WAAW,CAAA;AAC5F;AAGA,MAAM,gBAAA,GAAmB,mBAAA;AAgBlB,MAAM,0BAA0BG,wBAAA,CAAa;AAAA,EACzC,OAAA;AAAA,EACA,UAAA;AAAA,EACA,YAAoC,EAAC;AAAA;AAAA,EAE9C,QAAA;AAAA;AAAA,EAEA,oBAAA,GAAuB,CAAA;AAAA,EAEvB,WAAA,CAAY,QAAuB,MAAA,EAAyB;AAC1D,IAAA,KAAA,CAAM,MAAM,CAAA;AACZ,IAAA,IAAA,CAAK,OAAA,GAAU,MAAA;AACf,IAAA,IAAA,CAAK,UAAA,GAAa,IAAIC,+BAAA,CAAgB,MAAA,CAAO,cAAc,CAAA;AAAA,EAC7D;AAAA;AAAA,EAGA,IAAI,YAAA,GAAiD;AACnD,IAAA,OAAO,IAAA,CAAK,UAAU,CAAC,CAAA;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQS,kBAAA,CAAmB,MAAqB,GAAA,EAAqB;AACpE,IAAA,MAAM,UAAA,GAAa,IAAI,OAAA,CAAQ,gBAAA,EAAkB,CAAC,MAAA,KAAW,MAAA,CAAO,aAAa,CAAA;AACjF,IAAA,OAAO,KAAA,CAAM,kBAAA,CAAmB,IAAA,EAAM,UAAU,CAAA;AAAA,EAClD;AAAA,EAES,eAAA,CACP,IAAA,EACA,GAAA,EACA,MAAA,GAAS,KAAA,EACoC;AAC7C,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,IAAA,CAAK,QAAA,GAAW,IAAA,CAAK,kBAAA,CAAmB,IAAA,EAAM,GAAG,CAAA;AAAA,IACnD;AACA,IAAA,MAAM,OAAA,GACJ,IAAA,KAAS,IAAA,GAAO,MAAA,GAAY,sBAAA,CAAuB,MAAM,IAAA,CAAK,kBAAA,CAAmB,IAAA,EAAM,GAAG,CAAC,CAAA;AAC7F,IAAA,IAAI,YAAY,MAAA,EAAW;AACzB,MAAA,IAAA,CAAK,SAAA,CAAU,KAAK,OAAO,CAAA;AAC3B,MAAA,OAAO,OAAA,CAAQ,OAAO,OAAO,CAAA;AAAA,IAC/B;AACA,IAAA,OAAO,KAAA,CAAM,eAAA,CAAgB,IAAA,EAAM,GAAA,EAAK,MAAM,CAAA;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOS,aAAA,CAAc,MAAA,EAAgB,MAAA,GAAS,KAAA,EAAiB;AAC/D,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,OAAA,CAAQ,MAAA,EAAQ,MAAM,CAAA;AAC5C,IAAA,MAAM,OAAA,GAAUC,gCAAA,CAAsB,QAAA,CAAS,MAAM,CAAA;AACrD,IAAA,IAAI,YAAY,MAAA,EAAW;AACzB,MAAA,MAAM,IAAIC,0BAAA,CAAe,OAAA,EAAS,MAAM,CAAA;AAAA,IAC1C;AACA,IAAAC,6CAAA,CAA2B,SAAS,MAAM,CAAA;AAC1C,IAAA,OAAO,QAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAA,CAAQ,QAAgB,MAAA,EAA2B;AACjD,IAAA,IAAI,CAAC,WAAA,CAAY,MAAA,CAAO,WAAW,CAAA,EAAG;AACpC,MAAA,OAAO,KAAA,CAAM,aAAA,CAAc,MAAA,EAAQ,MAAM,CAAA;AAAA,IAC3C;AACA,IAAA,IAAI,CAACC,8BAAA,CAAe,MAAA,EAAQ,MAAM,CAAA,EAAG;AACnC,MAAA,OAAO,EAAE,MAAA,EAAQ,MAAA,EAAQ,MAAA,CAAO,IAAA,EAAK;AAAA,IACvC;AACA,IAAA,IAAI;AACF,MAAA,OAAO,IAAA,CAAK,UAAA,CAAW,KAAA,CAAM,MAAM,CAAA;AAAA,IACrC,SAAS,KAAA,EAAO;AACd,MAAA,IAAI,SAAA,CAAU,KAAK,CAAA,EAAG;AACpB,QAAA,IAAA,CAAK,SAAA,CAAU,KAAK,KAAK,CAAA;AAAA,MAC3B;AACA,MAAA,MAAM,IAAIF,0BAAA,CAAe,KAAA,EAAgB,MAAM,CAAA;AAAA,IACjD;AAAA,EACF;AAAA,EAEA,MAAe,gBAAgB,WAAA,EAAsC;AACnE,IAAA,MAAM,OAAA,GAAU,KAAK,aAAA,CAAc,WAAW,KAAM,MAAM,IAAA,CAAK,eAAe,WAAW,CAAA;AACzF,IAAA,IAAI,YAAY,MAAA,EAAW;AACzB,MAAA,IAAA,CAAK,SAAA,CAAU,KAAK,OAAO,CAAA;AAC3B,MAAA,MAAM,OAAA;AAAA,IACR;AACA,IAAA,IAAI;AACF,MAAA,OAAO,MAAM,KAAA,CAAM,eAAA,CAAgB,WAAW,CAAA;AAAA,IAChD,SAAS,KAAA,EAAO;AAEd,MAAA,MAAM,QAAS,KAAA,CAAsC,aAAA;AACrD,MAAA,IAAI,SAAA,CAAU,KAAK,CAAA,EAAG;AACpB,QAAA,IAAA,CAAK,SAAA,CAAU,KAAK,KAAK,CAAA;AAAA,MAC3B;AACA,MAAA,MAAM,KAAA;AAAA,IACR;AAAA,EACF;AAAA,EAEA,eAAe,WAAA,EAAgE;AAC7E,IAAA,OAAO,WAAA,KAAgB,IAAA,CAAK,QAAA,GACxB,OAAA,CAAQ,OAAA,CAAQ,MAAS,CAAA,GACzB,SAAA,CAAU,WAAA,EAAa,IAAA,CAAK,OAAA,CAAQ,MAAM,CAAA;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,cAAc,WAAA,EAAuD;AACnE,IAAA,IAAI,CAAC,WAAA,CAAY,WAAW,CAAA,EAAG;AAC7B,MAAA,OAAO,MAAA;AAAA,IACT;AACA,IAAA,IAAA,CAAK,oBAAA,IAAwB,CAAA;AAC7B,IAAA,MAAM,EAAE,kBAAA,EAAmB,GAAI,IAAA,CAAK,OAAA;AACpC,IAAA,OAAO,IAAA,CAAK,oBAAA,GAAuB,kBAAA,GAC/BN,kCAAA,CAAkB,WAAA,EAAa;AAAA,MAC7B,MAAA,EAAQ,2BAAA;AAAA,MACR,YAAA,EAAc;AAAA,KACf,CAAA,GACD,MAAA;AAAA,EACN;AACF;AAEA,SAAS,UAAU,KAAA,EAA+C;AAChE,EAAA,OAAQ,KAAA,EAAqC,SAASS,kBAAA,CAAY,oBAAA;AACpE;;;;"}
|
|
@@ -6,6 +6,7 @@ import { ERROR_CODES } from '../../domain/errors.mjs';
|
|
|
6
6
|
import { redactUrlSecrets } from '../../domain/url-secrets.mjs';
|
|
7
7
|
import { aliasExpansionFailure } from './alias-limit.mjs';
|
|
8
8
|
import { isHostAllowed } from './allowed-hosts.mjs';
|
|
9
|
+
import { pointMappingNamesAtSchemas } from './mapping-schema-names.mjs';
|
|
9
10
|
import { RemoteNodeLimit, isParsedSource } from './remote-node-limit.mjs';
|
|
10
11
|
import { refForbiddenError } from './schema-load-errors.mjs';
|
|
11
12
|
|
|
@@ -94,20 +95,32 @@ class RefAccessResolver extends BaseResolver {
|
|
|
94
95
|
}
|
|
95
96
|
return super.resolveDocument(base, ref, isRoot);
|
|
96
97
|
}
|
|
97
|
-
/**
|
|
98
|
+
/**
|
|
99
|
+
* Refuse a YAML alias bomb before Redocly walks it (pre-beta test plan 10.2). A document a
|
|
100
|
+
* `$ref` loads has its own `components.schemas`, so its mapping names point at those schemas
|
|
101
|
+
* before Redocly resolves them, as the root's do (`pointMappingNamesAtSchemas`).
|
|
102
|
+
*/
|
|
98
103
|
parseDocument(source, isRoot = false) {
|
|
99
104
|
const document = this.#parsed(source, isRoot);
|
|
100
105
|
const failure = aliasExpansionFailure(document.parsed);
|
|
101
106
|
if (failure !== void 0) {
|
|
102
107
|
throw new YamlParseError(failure, source);
|
|
103
108
|
}
|
|
109
|
+
pointMappingNamesAtSchemas(document.parsed);
|
|
104
110
|
return document;
|
|
105
111
|
}
|
|
106
|
-
/**
|
|
112
|
+
/**
|
|
113
|
+
* A remote document is parsed within the node limit; a local one as Redocly parses it. Whether
|
|
114
|
+
* a remote one is parsed at all is decided here (`isParsedSource`), since Redocly read the
|
|
115
|
+
* extension of a URL with its query.
|
|
116
|
+
*/
|
|
107
117
|
#parsed(source, isRoot) {
|
|
108
|
-
if (!isRemoteRef(source.absoluteRef)
|
|
118
|
+
if (!isRemoteRef(source.absoluteRef)) {
|
|
109
119
|
return super.parseDocument(source, isRoot);
|
|
110
120
|
}
|
|
121
|
+
if (!isParsedSource(source, isRoot)) {
|
|
122
|
+
return { source, parsed: source.body };
|
|
123
|
+
}
|
|
111
124
|
try {
|
|
112
125
|
return this.#nodeLimit.parse(source);
|
|
113
126
|
} catch (error) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ref-access.mjs","sources":["../../../src/adapters/redocly-loader/ref-access.ts"],"sourcesContent":["import { realpath } from \"node:fs/promises\";\nimport path from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\nimport {\n BaseResolver,\n type Document,\n type Config as RedoclyConfig,\n type Source,\n YamlParseError,\n} from \"@redocly/openapi-core\";\nimport type { RefAccess } from \"../../application/ports/schema-loader.js\";\nimport { ERROR_CODES, type OpenAPITypesafeError } from \"../../domain/errors.js\";\nimport { redactUrlSecrets } from \"../../domain/url-secrets.js\";\nimport { aliasExpansionFailure } from \"./alias-limit.js\";\nimport { isHostAllowed } from \"./allowed-hosts.js\";\nimport { isParsedSource, RemoteNodeLimit } from \"./remote-node-limit.js\";\nimport { refForbiddenError } from \"./schema-load-errors.js\";\n\n/**\n * Limits on where `$ref` documents may be loaded from (threat model R1 and R2, ADR-017). The root\n * document is chosen by the developer and is always loaded; every other document must pass.\n */\n\ntype ResolveConfig = RedoclyConfig[\"resolve\"];\n\n/** Redocly treats only these prefixes as remote; any other `$ref` is a local file path. */\nfunction isRemoteRef(absoluteRef: string): boolean {\n return absoluteRef.startsWith(\"http://\") || absoluteRef.startsWith(\"https://\");\n}\n\n/** Whether `target` is `root` or below it; both are absolute paths. */\nexport function isInsideDirectory(target: string, root: string): boolean {\n const relative = path.relative(root, target);\n // Compare the first segment: a directory named `..hidden` is inside, `../x` is not.\n const isParent = relative === \"..\" || relative.startsWith(`..${path.sep}`);\n return !isParent && !path.isAbsolute(relative);\n}\n\n/** The real path, so a link inside the root that points outside it is caught. */\nasync function realPathOrSelf(file: string): Promise<string> {\n const absolute = path.resolve(file);\n try {\n return await realpath(absolute);\n } catch (error) {\n // A missing file is never read, and Redocly reports it. Resolve its nearest existing\n // directory instead, so it compares with the root's real path: the root may be reached\n // through a link (macOS `/tmp` is one), and the missing file must not look outside it.\n const parent = path.dirname(absolute);\n if ((error as NodeJS.ErrnoException).code === \"ENOENT\" && parent !== absolute) {\n return path.join(await realPathOrSelf(parent), path.basename(absolute));\n }\n throw error;\n }\n}\n\nasync function localRefusal(\n absoluteRef: string,\n localRoot: URL,\n): Promise<OpenAPITypesafeError | undefined> {\n const root = await realPathOrSelf(fileURLToPath(localRoot));\n if (isInsideDirectory(await realPathOrSelf(absoluteRef), root)) {\n return undefined;\n }\n return refForbiddenError(absoluteRef, { reason: \"outside-local-root\", localRoot: root });\n}\n\n/** The refusal for one document, or undefined when the limits allow it. */\nexport async function refusalOf(\n absoluteRef: string,\n access: RefAccess,\n): Promise<OpenAPITypesafeError | undefined> {\n if (!isRemoteRef(absoluteRef)) {\n return access.localRoot === undefined ? undefined : localRefusal(absoluteRef, access.localRoot);\n }\n if (access.remoteHosts === undefined || isHostAllowed(new URL(absoluteRef), access.remoteHosts)) {\n return undefined;\n }\n return refForbiddenError(absoluteRef, {\n reason: \"host-not-allowed\",\n allowedHosts: [...access.remoteHosts],\n });\n}\n\n/**\n * A remote document may refer only to other URLs (threat model T3). Redocly resolves a `$ref`\n * against a URL base with `new URL()`, so `C:/x` becomes `c:/x` and `file:///x` stays as it is;\n * Redocly then reads either from disk, and on Windows a drive letter is an absolute path.\n */\nfunction localFromRemoteRefusal(\n base: string,\n absoluteRef: string,\n): OpenAPITypesafeError | undefined {\n if (!isRemoteRef(base) || isRemoteRef(absoluteRef)) {\n return undefined;\n }\n const shownBase = redactUrlSecrets(base);\n return refForbiddenError(absoluteRef, { reason: \"local-ref-from-remote\", base: shownBase });\n}\n\n/** The scheme of an `http(s)` URL, in any case. */\nconst REMOTE_SCHEME_RE = /^https?:(?=\\/\\/)/i;\n\n/** The limits one resolver checks; each load gets its own resolver. */\nexport interface RefAccessLimits {\n readonly access: RefAccess;\n /** Remote documents one load may fetch, the root included (threat model T2). */\n readonly maxRemoteDocuments: number;\n /** Nodes the remote documents of one load may parse into together (threat model T2). */\n readonly maxRemoteNodes: number;\n}\n\n/**\n * A Redocly resolver that checks each document before it loads it. Redocly turns a failed load\n * into an unresolved-`$ref` problem, so the refusals are also kept for the loader to report as\n * the typed error.\n */\nexport class RefAccessResolver extends BaseResolver {\n readonly #limits: RefAccessLimits;\n readonly #nodeLimit: RemoteNodeLimit;\n readonly #refusals: OpenAPITypesafeError[] = [];\n /** The root document's ref: it is chosen by the developer, so it is not limited. */\n #rootRef: string | undefined;\n /** Remote documents asked for so far; Redocly caches each one, so each is counted once. */\n #remoteDocumentCount = 0;\n\n constructor(config: ResolveConfig, limits: RefAccessLimits) {\n super(config);\n this.#limits = limits;\n this.#nodeLimit = new RemoteNodeLimit(limits.maxRemoteNodes);\n }\n\n /** The first document that was refused, if any. */\n get firstRefusal(): OpenAPITypesafeError | undefined {\n return this.#refusals[0];\n }\n\n /**\n * A scheme is the same in any case (RFC 3986, section 3.1), but Redocly takes only `http://` and\n * `https://` as URLs: it read `HTTP://host/x.yaml` as a file path, and its \"not found\" message\n * showed the user info and the query of the URL, which no longer looked like one. The scheme\n * is written in lowercase first, so the `$ref` loads as the URL it is, within the same limits.\n */\n override resolveExternalRef(base: string | null, ref: string): string {\n const normalized = ref.replace(REMOTE_SCHEME_RE, (scheme) => scheme.toLowerCase());\n return super.resolveExternalRef(base, normalized);\n }\n\n override resolveDocument(\n base: string | null,\n ref: string,\n isRoot = false,\n ): ReturnType<BaseResolver[\"resolveDocument\"]> {\n if (isRoot) {\n this.#rootRef = this.resolveExternalRef(base, ref);\n }\n const refusal =\n base === null ? undefined : localFromRemoteRefusal(base, this.resolveExternalRef(base, ref));\n if (refusal !== undefined) {\n this.#refusals.push(refusal);\n return Promise.reject(refusal);\n }\n return super.resolveDocument(base, ref, isRoot);\n }\n\n /** Refuse a YAML alias bomb before Redocly walks it (pre-beta test plan 10.2). */\n override parseDocument(source: Source, isRoot = false): Document {\n const document = this.#parsed(source, isRoot);\n const failure = aliasExpansionFailure(document.parsed);\n if (failure !== undefined) {\n throw new YamlParseError(failure, source);\n }\n return document;\n }\n\n /** A remote document is parsed within the node limit; any other one as Redocly parses it. */\n #parsed(source: Source, isRoot: boolean): Document {\n if (!isRemoteRef(source.absoluteRef) || !isParsedSource(source, isRoot)) {\n return super.parseDocument(source, isRoot);\n }\n try {\n return this.#nodeLimit.parse(source);\n } catch (error) {\n if (isRefusal(error)) {\n this.#refusals.push(error);\n }\n throw new YamlParseError(error as Error, source);\n }\n }\n\n override async loadExternalRef(absoluteRef: string): Promise<Source> {\n const refusal = this.#countRefusal(absoluteRef) ?? (await this.#accessRefusal(absoluteRef));\n if (refusal !== undefined) {\n this.#refusals.push(refusal);\n throw refusal;\n }\n try {\n return await super.loadExternalRef(absoluteRef);\n } catch (error) {\n // A refused redirect throws inside the fetch, and Redocly wraps it in a ResolveError.\n const cause = (error as { originalError?: unknown }).originalError;\n if (isRefusal(cause)) {\n this.#refusals.push(cause);\n }\n throw error;\n }\n }\n\n #accessRefusal(absoluteRef: string): Promise<OpenAPITypesafeError | undefined> {\n return absoluteRef === this.#rootRef\n ? Promise.resolve(undefined)\n : refusalOf(absoluteRef, this.#limits.access);\n }\n\n /**\n * A document that changes all its URLs can fan out without end: 150 `$ref`s per document, three\n * levels deep, made 16,212 requests and exhausted the local ports (audit B2, F4).\n */\n #countRefusal(absoluteRef: string): OpenAPITypesafeError | undefined {\n if (!isRemoteRef(absoluteRef)) {\n return undefined;\n }\n this.#remoteDocumentCount += 1;\n const { maxRemoteDocuments } = this.#limits;\n return this.#remoteDocumentCount > maxRemoteDocuments\n ? refForbiddenError(absoluteRef, {\n reason: \"too-many-remote-documents\",\n maxDocuments: maxRemoteDocuments,\n })\n : undefined;\n }\n}\n\nfunction isRefusal(value: unknown): value is OpenAPITypesafeError {\n return (value as { code?: unknown } | null)?.code === ERROR_CODES.SCHEMA_REF_FORBIDDEN;\n}\n"],"names":[],"mappings":";;;;;;;;;;;AA0BA,SAAS,YAAY,WAAA,EAA8B;AACjD,EAAA,OAAO,YAAY,UAAA,CAAW,SAAS,CAAA,IAAK,WAAA,CAAY,WAAW,UAAU,CAAA;AAC/E;AAGO,SAAS,iBAAA,CAAkB,QAAgB,IAAA,EAAuB;AACvE,EAAA,MAAM,QAAA,GAAW,IAAA,CAAK,QAAA,CAAS,IAAA,EAAM,MAAM,CAAA;AAE3C,EAAA,MAAM,QAAA,GAAW,aAAa,IAAA,IAAQ,QAAA,CAAS,WAAW,CAAA,EAAA,EAAK,IAAA,CAAK,GAAG,CAAA,CAAE,CAAA;AACzE,EAAA,OAAO,CAAC,QAAA,IAAY,CAAC,IAAA,CAAK,WAAW,QAAQ,CAAA;AAC/C;AAGA,eAAe,eAAe,IAAA,EAA+B;AAC3D,EAAA,MAAM,QAAA,GAAW,IAAA,CAAK,OAAA,CAAQ,IAAI,CAAA;AAClC,EAAA,IAAI;AACF,IAAA,OAAO,MAAM,SAAS,QAAQ,CAAA;AAAA,EAChC,SAAS,KAAA,EAAO;AAId,IAAA,MAAM,MAAA,GAAS,IAAA,CAAK,OAAA,CAAQ,QAAQ,CAAA;AACpC,IAAA,IAAK,KAAA,CAAgC,IAAA,KAAS,QAAA,IAAY,MAAA,KAAW,QAAA,EAAU;AAC7E,MAAA,OAAO,IAAA,CAAK,KAAK,MAAM,cAAA,CAAe,MAAM,CAAA,EAAG,IAAA,CAAK,QAAA,CAAS,QAAQ,CAAC,CAAA;AAAA,IACxE;AACA,IAAA,MAAM,KAAA;AAAA,EACR;AACF;AAEA,eAAe,YAAA,CACb,aACA,SAAA,EAC2C;AAC3C,EAAA,MAAM,IAAA,GAAO,MAAM,cAAA,CAAe,aAAA,CAAc,SAAS,CAAC,CAAA;AAC1D,EAAA,IAAI,kBAAkB,MAAM,cAAA,CAAe,WAAW,CAAA,EAAG,IAAI,CAAA,EAAG;AAC9D,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,OAAO,kBAAkB,WAAA,EAAa,EAAE,QAAQ,oBAAA,EAAsB,SAAA,EAAW,MAAM,CAAA;AACzF;AAGA,eAAsB,SAAA,CACpB,aACA,MAAA,EAC2C;AAC3C,EAAA,IAAI,CAAC,WAAA,CAAY,WAAW,CAAA,EAAG;AAC7B,IAAA,OAAO,OAAO,SAAA,KAAc,MAAA,GAAY,SAAY,YAAA,CAAa,WAAA,EAAa,OAAO,SAAS,CAAA;AAAA,EAChG;AACA,EAAA,IAAI,MAAA,CAAO,WAAA,KAAgB,MAAA,IAAa,aAAA,CAAc,IAAI,IAAI,WAAW,CAAA,EAAG,MAAA,CAAO,WAAW,CAAA,EAAG;AAC/F,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,OAAO,kBAAkB,WAAA,EAAa;AAAA,IACpC,MAAA,EAAQ,kBAAA;AAAA,IACR,YAAA,EAAc,CAAC,GAAG,MAAA,CAAO,WAAW;AAAA,GACrC,CAAA;AACH;AAOA,SAAS,sBAAA,CACP,MACA,WAAA,EACkC;AAClC,EAAA,IAAI,CAAC,WAAA,CAAY,IAAI,CAAA,IAAK,WAAA,CAAY,WAAW,CAAA,EAAG;AAClD,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,MAAM,SAAA,GAAY,iBAAiB,IAAI,CAAA;AACvC,EAAA,OAAO,kBAAkB,WAAA,EAAa,EAAE,QAAQ,uBAAA,EAAyB,IAAA,EAAM,WAAW,CAAA;AAC5F;AAGA,MAAM,gBAAA,GAAmB,mBAAA;AAgBlB,MAAM,0BAA0B,YAAA,CAAa;AAAA,EACzC,OAAA;AAAA,EACA,UAAA;AAAA,EACA,YAAoC,EAAC;AAAA;AAAA,EAE9C,QAAA;AAAA;AAAA,EAEA,oBAAA,GAAuB,CAAA;AAAA,EAEvB,WAAA,CAAY,QAAuB,MAAA,EAAyB;AAC1D,IAAA,KAAA,CAAM,MAAM,CAAA;AACZ,IAAA,IAAA,CAAK,OAAA,GAAU,MAAA;AACf,IAAA,IAAA,CAAK,UAAA,GAAa,IAAI,eAAA,CAAgB,MAAA,CAAO,cAAc,CAAA;AAAA,EAC7D;AAAA;AAAA,EAGA,IAAI,YAAA,GAAiD;AACnD,IAAA,OAAO,IAAA,CAAK,UAAU,CAAC,CAAA;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQS,kBAAA,CAAmB,MAAqB,GAAA,EAAqB;AACpE,IAAA,MAAM,UAAA,GAAa,IAAI,OAAA,CAAQ,gBAAA,EAAkB,CAAC,MAAA,KAAW,MAAA,CAAO,aAAa,CAAA;AACjF,IAAA,OAAO,KAAA,CAAM,kBAAA,CAAmB,IAAA,EAAM,UAAU,CAAA;AAAA,EAClD;AAAA,EAES,eAAA,CACP,IAAA,EACA,GAAA,EACA,MAAA,GAAS,KAAA,EACoC;AAC7C,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,IAAA,CAAK,QAAA,GAAW,IAAA,CAAK,kBAAA,CAAmB,IAAA,EAAM,GAAG,CAAA;AAAA,IACnD;AACA,IAAA,MAAM,OAAA,GACJ,IAAA,KAAS,IAAA,GAAO,MAAA,GAAY,sBAAA,CAAuB,MAAM,IAAA,CAAK,kBAAA,CAAmB,IAAA,EAAM,GAAG,CAAC,CAAA;AAC7F,IAAA,IAAI,YAAY,MAAA,EAAW;AACzB,MAAA,IAAA,CAAK,SAAA,CAAU,KAAK,OAAO,CAAA;AAC3B,MAAA,OAAO,OAAA,CAAQ,OAAO,OAAO,CAAA;AAAA,IAC/B;AACA,IAAA,OAAO,KAAA,CAAM,eAAA,CAAgB,IAAA,EAAM,GAAA,EAAK,MAAM,CAAA;AAAA,EAChD;AAAA;AAAA,EAGS,aAAA,CAAc,MAAA,EAAgB,MAAA,GAAS,KAAA,EAAiB;AAC/D,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,OAAA,CAAQ,MAAA,EAAQ,MAAM,CAAA;AAC5C,IAAA,MAAM,OAAA,GAAU,qBAAA,CAAsB,QAAA,CAAS,MAAM,CAAA;AACrD,IAAA,IAAI,YAAY,MAAA,EAAW;AACzB,MAAA,MAAM,IAAI,cAAA,CAAe,OAAA,EAAS,MAAM,CAAA;AAAA,IAC1C;AACA,IAAA,OAAO,QAAA;AAAA,EACT;AAAA;AAAA,EAGA,OAAA,CAAQ,QAAgB,MAAA,EAA2B;AACjD,IAAA,IAAI,CAAC,YAAY,MAAA,CAAO,WAAW,KAAK,CAAC,cAAA,CAAe,MAAA,EAAQ,MAAM,CAAA,EAAG;AACvE,MAAA,OAAO,KAAA,CAAM,aAAA,CAAc,MAAA,EAAQ,MAAM,CAAA;AAAA,IAC3C;AACA,IAAA,IAAI;AACF,MAAA,OAAO,IAAA,CAAK,UAAA,CAAW,KAAA,CAAM,MAAM,CAAA;AAAA,IACrC,SAAS,KAAA,EAAO;AACd,MAAA,IAAI,SAAA,CAAU,KAAK,CAAA,EAAG;AACpB,QAAA,IAAA,CAAK,SAAA,CAAU,KAAK,KAAK,CAAA;AAAA,MAC3B;AACA,MAAA,MAAM,IAAI,cAAA,CAAe,KAAA,EAAgB,MAAM,CAAA;AAAA,IACjD;AAAA,EACF;AAAA,EAEA,MAAe,gBAAgB,WAAA,EAAsC;AACnE,IAAA,MAAM,OAAA,GAAU,KAAK,aAAA,CAAc,WAAW,KAAM,MAAM,IAAA,CAAK,eAAe,WAAW,CAAA;AACzF,IAAA,IAAI,YAAY,MAAA,EAAW;AACzB,MAAA,IAAA,CAAK,SAAA,CAAU,KAAK,OAAO,CAAA;AAC3B,MAAA,MAAM,OAAA;AAAA,IACR;AACA,IAAA,IAAI;AACF,MAAA,OAAO,MAAM,KAAA,CAAM,eAAA,CAAgB,WAAW,CAAA;AAAA,IAChD,SAAS,KAAA,EAAO;AAEd,MAAA,MAAM,QAAS,KAAA,CAAsC,aAAA;AACrD,MAAA,IAAI,SAAA,CAAU,KAAK,CAAA,EAAG;AACpB,QAAA,IAAA,CAAK,SAAA,CAAU,KAAK,KAAK,CAAA;AAAA,MAC3B;AACA,MAAA,MAAM,KAAA;AAAA,IACR;AAAA,EACF;AAAA,EAEA,eAAe,WAAA,EAAgE;AAC7E,IAAA,OAAO,WAAA,KAAgB,IAAA,CAAK,QAAA,GACxB,OAAA,CAAQ,OAAA,CAAQ,MAAS,CAAA,GACzB,SAAA,CAAU,WAAA,EAAa,IAAA,CAAK,OAAA,CAAQ,MAAM,CAAA;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,cAAc,WAAA,EAAuD;AACnE,IAAA,IAAI,CAAC,WAAA,CAAY,WAAW,CAAA,EAAG;AAC7B,MAAA,OAAO,MAAA;AAAA,IACT;AACA,IAAA,IAAA,CAAK,oBAAA,IAAwB,CAAA;AAC7B,IAAA,MAAM,EAAE,kBAAA,EAAmB,GAAI,IAAA,CAAK,OAAA;AACpC,IAAA,OAAO,IAAA,CAAK,oBAAA,GAAuB,kBAAA,GAC/B,iBAAA,CAAkB,WAAA,EAAa;AAAA,MAC7B,MAAA,EAAQ,2BAAA;AAAA,MACR,YAAA,EAAc;AAAA,KACf,CAAA,GACD,MAAA;AAAA,EACN;AACF;AAEA,SAAS,UAAU,KAAA,EAA+C;AAChE,EAAA,OAAQ,KAAA,EAAqC,SAAS,WAAA,CAAY,oBAAA;AACpE;;"}
|
|
1
|
+
{"version":3,"file":"ref-access.mjs","sources":["../../../src/adapters/redocly-loader/ref-access.ts"],"sourcesContent":["import { realpath } from \"node:fs/promises\";\nimport path from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\nimport {\n BaseResolver,\n type Document,\n type Config as RedoclyConfig,\n type Source,\n YamlParseError,\n} from \"@redocly/openapi-core\";\nimport type { RefAccess } from \"../../application/ports/schema-loader.js\";\nimport { ERROR_CODES, type OpenAPITypesafeError } from \"../../domain/errors.js\";\nimport { redactUrlSecrets } from \"../../domain/url-secrets.js\";\nimport { aliasExpansionFailure } from \"./alias-limit.js\";\nimport { isHostAllowed } from \"./allowed-hosts.js\";\nimport { pointMappingNamesAtSchemas } from \"./mapping-schema-names.js\";\nimport { isParsedSource, RemoteNodeLimit } from \"./remote-node-limit.js\";\nimport { refForbiddenError } from \"./schema-load-errors.js\";\n\n/**\n * Limits on where `$ref` documents may be loaded from (threat model R1 and R2, ADR-017). The root\n * document is chosen by the developer and is always loaded; every other document must pass.\n */\n\ntype ResolveConfig = RedoclyConfig[\"resolve\"];\n\n/** Redocly treats only these prefixes as remote; any other `$ref` is a local file path. */\nfunction isRemoteRef(absoluteRef: string): boolean {\n return absoluteRef.startsWith(\"http://\") || absoluteRef.startsWith(\"https://\");\n}\n\n/** Whether `target` is `root` or below it; both are absolute paths. */\nexport function isInsideDirectory(target: string, root: string): boolean {\n const relative = path.relative(root, target);\n // Compare the first segment: a directory named `..hidden` is inside, `../x` is not.\n const isParent = relative === \"..\" || relative.startsWith(`..${path.sep}`);\n return !isParent && !path.isAbsolute(relative);\n}\n\n/** The real path, so a link inside the root that points outside it is caught. */\nasync function realPathOrSelf(file: string): Promise<string> {\n const absolute = path.resolve(file);\n try {\n return await realpath(absolute);\n } catch (error) {\n // A missing file is never read, and Redocly reports it. Resolve its nearest existing\n // directory instead, so it compares with the root's real path: the root may be reached\n // through a link (macOS `/tmp` is one), and the missing file must not look outside it.\n const parent = path.dirname(absolute);\n if ((error as NodeJS.ErrnoException).code === \"ENOENT\" && parent !== absolute) {\n return path.join(await realPathOrSelf(parent), path.basename(absolute));\n }\n throw error;\n }\n}\n\nasync function localRefusal(\n absoluteRef: string,\n localRoot: URL,\n): Promise<OpenAPITypesafeError | undefined> {\n const root = await realPathOrSelf(fileURLToPath(localRoot));\n if (isInsideDirectory(await realPathOrSelf(absoluteRef), root)) {\n return undefined;\n }\n return refForbiddenError(absoluteRef, { reason: \"outside-local-root\", localRoot: root });\n}\n\n/** The refusal for one document, or undefined when the limits allow it. */\nexport async function refusalOf(\n absoluteRef: string,\n access: RefAccess,\n): Promise<OpenAPITypesafeError | undefined> {\n if (!isRemoteRef(absoluteRef)) {\n return access.localRoot === undefined ? undefined : localRefusal(absoluteRef, access.localRoot);\n }\n if (access.remoteHosts === undefined || isHostAllowed(new URL(absoluteRef), access.remoteHosts)) {\n return undefined;\n }\n return refForbiddenError(absoluteRef, {\n reason: \"host-not-allowed\",\n allowedHosts: [...access.remoteHosts],\n });\n}\n\n/**\n * A remote document may refer only to other URLs (threat model T3). Redocly resolves a `$ref`\n * against a URL base with `new URL()`, so `C:/x` becomes `c:/x` and `file:///x` stays as it is;\n * Redocly then reads either from disk, and on Windows a drive letter is an absolute path.\n */\nfunction localFromRemoteRefusal(\n base: string,\n absoluteRef: string,\n): OpenAPITypesafeError | undefined {\n if (!isRemoteRef(base) || isRemoteRef(absoluteRef)) {\n return undefined;\n }\n const shownBase = redactUrlSecrets(base);\n return refForbiddenError(absoluteRef, { reason: \"local-ref-from-remote\", base: shownBase });\n}\n\n/** The scheme of an `http(s)` URL, in any case. */\nconst REMOTE_SCHEME_RE = /^https?:(?=\\/\\/)/i;\n\n/** The limits one resolver checks; each load gets its own resolver. */\nexport interface RefAccessLimits {\n readonly access: RefAccess;\n /** Remote documents one load may fetch, the root included (threat model T2). */\n readonly maxRemoteDocuments: number;\n /** Nodes the remote documents of one load may parse into together (threat model T2). */\n readonly maxRemoteNodes: number;\n}\n\n/**\n * A Redocly resolver that checks each document before it loads it. Redocly turns a failed load\n * into an unresolved-`$ref` problem, so the refusals are also kept for the loader to report as\n * the typed error.\n */\nexport class RefAccessResolver extends BaseResolver {\n readonly #limits: RefAccessLimits;\n readonly #nodeLimit: RemoteNodeLimit;\n readonly #refusals: OpenAPITypesafeError[] = [];\n /** The root document's ref: it is chosen by the developer, so it is not limited. */\n #rootRef: string | undefined;\n /** Remote documents asked for so far; Redocly caches each one, so each is counted once. */\n #remoteDocumentCount = 0;\n\n constructor(config: ResolveConfig, limits: RefAccessLimits) {\n super(config);\n this.#limits = limits;\n this.#nodeLimit = new RemoteNodeLimit(limits.maxRemoteNodes);\n }\n\n /** The first document that was refused, if any. */\n get firstRefusal(): OpenAPITypesafeError | undefined {\n return this.#refusals[0];\n }\n\n /**\n * A scheme is the same in any case (RFC 3986, section 3.1), but Redocly takes only `http://` and\n * `https://` as URLs: it read `HTTP://host/x.yaml` as a file path, and its \"not found\" message\n * showed the user info and the query of the URL, which no longer looked like one. The scheme\n * is written in lowercase first, so the `$ref` loads as the URL it is, within the same limits.\n */\n override resolveExternalRef(base: string | null, ref: string): string {\n const normalized = ref.replace(REMOTE_SCHEME_RE, (scheme) => scheme.toLowerCase());\n return super.resolveExternalRef(base, normalized);\n }\n\n override resolveDocument(\n base: string | null,\n ref: string,\n isRoot = false,\n ): ReturnType<BaseResolver[\"resolveDocument\"]> {\n if (isRoot) {\n this.#rootRef = this.resolveExternalRef(base, ref);\n }\n const refusal =\n base === null ? undefined : localFromRemoteRefusal(base, this.resolveExternalRef(base, ref));\n if (refusal !== undefined) {\n this.#refusals.push(refusal);\n return Promise.reject(refusal);\n }\n return super.resolveDocument(base, ref, isRoot);\n }\n\n /**\n * Refuse a YAML alias bomb before Redocly walks it (pre-beta test plan 10.2). A document a\n * `$ref` loads has its own `components.schemas`, so its mapping names point at those schemas\n * before Redocly resolves them, as the root's do (`pointMappingNamesAtSchemas`).\n */\n override parseDocument(source: Source, isRoot = false): Document {\n const document = this.#parsed(source, isRoot);\n const failure = aliasExpansionFailure(document.parsed);\n if (failure !== undefined) {\n throw new YamlParseError(failure, source);\n }\n pointMappingNamesAtSchemas(document.parsed);\n return document;\n }\n\n /**\n * A remote document is parsed within the node limit; a local one as Redocly parses it. Whether\n * a remote one is parsed at all is decided here (`isParsedSource`), since Redocly read the\n * extension of a URL with its query.\n */\n #parsed(source: Source, isRoot: boolean): Document {\n if (!isRemoteRef(source.absoluteRef)) {\n return super.parseDocument(source, isRoot);\n }\n if (!isParsedSource(source, isRoot)) {\n return { source, parsed: source.body };\n }\n try {\n return this.#nodeLimit.parse(source);\n } catch (error) {\n if (isRefusal(error)) {\n this.#refusals.push(error);\n }\n throw new YamlParseError(error as Error, source);\n }\n }\n\n override async loadExternalRef(absoluteRef: string): Promise<Source> {\n const refusal = this.#countRefusal(absoluteRef) ?? (await this.#accessRefusal(absoluteRef));\n if (refusal !== undefined) {\n this.#refusals.push(refusal);\n throw refusal;\n }\n try {\n return await super.loadExternalRef(absoluteRef);\n } catch (error) {\n // A refused redirect throws inside the fetch, and Redocly wraps it in a ResolveError.\n const cause = (error as { originalError?: unknown }).originalError;\n if (isRefusal(cause)) {\n this.#refusals.push(cause);\n }\n throw error;\n }\n }\n\n #accessRefusal(absoluteRef: string): Promise<OpenAPITypesafeError | undefined> {\n return absoluteRef === this.#rootRef\n ? Promise.resolve(undefined)\n : refusalOf(absoluteRef, this.#limits.access);\n }\n\n /**\n * A document that changes all its URLs can fan out without end: 150 `$ref`s per document, three\n * levels deep, made 16,212 requests and exhausted the local ports (audit B2, F4).\n */\n #countRefusal(absoluteRef: string): OpenAPITypesafeError | undefined {\n if (!isRemoteRef(absoluteRef)) {\n return undefined;\n }\n this.#remoteDocumentCount += 1;\n const { maxRemoteDocuments } = this.#limits;\n return this.#remoteDocumentCount > maxRemoteDocuments\n ? refForbiddenError(absoluteRef, {\n reason: \"too-many-remote-documents\",\n maxDocuments: maxRemoteDocuments,\n })\n : undefined;\n }\n}\n\nfunction isRefusal(value: unknown): value is OpenAPITypesafeError {\n return (value as { code?: unknown } | null)?.code === ERROR_CODES.SCHEMA_REF_FORBIDDEN;\n}\n"],"names":[],"mappings":";;;;;;;;;;;;AA2BA,SAAS,YAAY,WAAA,EAA8B;AACjD,EAAA,OAAO,YAAY,UAAA,CAAW,SAAS,CAAA,IAAK,WAAA,CAAY,WAAW,UAAU,CAAA;AAC/E;AAGO,SAAS,iBAAA,CAAkB,QAAgB,IAAA,EAAuB;AACvE,EAAA,MAAM,QAAA,GAAW,IAAA,CAAK,QAAA,CAAS,IAAA,EAAM,MAAM,CAAA;AAE3C,EAAA,MAAM,QAAA,GAAW,aAAa,IAAA,IAAQ,QAAA,CAAS,WAAW,CAAA,EAAA,EAAK,IAAA,CAAK,GAAG,CAAA,CAAE,CAAA;AACzE,EAAA,OAAO,CAAC,QAAA,IAAY,CAAC,IAAA,CAAK,WAAW,QAAQ,CAAA;AAC/C;AAGA,eAAe,eAAe,IAAA,EAA+B;AAC3D,EAAA,MAAM,QAAA,GAAW,IAAA,CAAK,OAAA,CAAQ,IAAI,CAAA;AAClC,EAAA,IAAI;AACF,IAAA,OAAO,MAAM,SAAS,QAAQ,CAAA;AAAA,EAChC,SAAS,KAAA,EAAO;AAId,IAAA,MAAM,MAAA,GAAS,IAAA,CAAK,OAAA,CAAQ,QAAQ,CAAA;AACpC,IAAA,IAAK,KAAA,CAAgC,IAAA,KAAS,QAAA,IAAY,MAAA,KAAW,QAAA,EAAU;AAC7E,MAAA,OAAO,IAAA,CAAK,KAAK,MAAM,cAAA,CAAe,MAAM,CAAA,EAAG,IAAA,CAAK,QAAA,CAAS,QAAQ,CAAC,CAAA;AAAA,IACxE;AACA,IAAA,MAAM,KAAA;AAAA,EACR;AACF;AAEA,eAAe,YAAA,CACb,aACA,SAAA,EAC2C;AAC3C,EAAA,MAAM,IAAA,GAAO,MAAM,cAAA,CAAe,aAAA,CAAc,SAAS,CAAC,CAAA;AAC1D,EAAA,IAAI,kBAAkB,MAAM,cAAA,CAAe,WAAW,CAAA,EAAG,IAAI,CAAA,EAAG;AAC9D,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,OAAO,kBAAkB,WAAA,EAAa,EAAE,QAAQ,oBAAA,EAAsB,SAAA,EAAW,MAAM,CAAA;AACzF;AAGA,eAAsB,SAAA,CACpB,aACA,MAAA,EAC2C;AAC3C,EAAA,IAAI,CAAC,WAAA,CAAY,WAAW,CAAA,EAAG;AAC7B,IAAA,OAAO,OAAO,SAAA,KAAc,MAAA,GAAY,SAAY,YAAA,CAAa,WAAA,EAAa,OAAO,SAAS,CAAA;AAAA,EAChG;AACA,EAAA,IAAI,MAAA,CAAO,WAAA,KAAgB,MAAA,IAAa,aAAA,CAAc,IAAI,IAAI,WAAW,CAAA,EAAG,MAAA,CAAO,WAAW,CAAA,EAAG;AAC/F,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,OAAO,kBAAkB,WAAA,EAAa;AAAA,IACpC,MAAA,EAAQ,kBAAA;AAAA,IACR,YAAA,EAAc,CAAC,GAAG,MAAA,CAAO,WAAW;AAAA,GACrC,CAAA;AACH;AAOA,SAAS,sBAAA,CACP,MACA,WAAA,EACkC;AAClC,EAAA,IAAI,CAAC,WAAA,CAAY,IAAI,CAAA,IAAK,WAAA,CAAY,WAAW,CAAA,EAAG;AAClD,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,MAAM,SAAA,GAAY,iBAAiB,IAAI,CAAA;AACvC,EAAA,OAAO,kBAAkB,WAAA,EAAa,EAAE,QAAQ,uBAAA,EAAyB,IAAA,EAAM,WAAW,CAAA;AAC5F;AAGA,MAAM,gBAAA,GAAmB,mBAAA;AAgBlB,MAAM,0BAA0B,YAAA,CAAa;AAAA,EACzC,OAAA;AAAA,EACA,UAAA;AAAA,EACA,YAAoC,EAAC;AAAA;AAAA,EAE9C,QAAA;AAAA;AAAA,EAEA,oBAAA,GAAuB,CAAA;AAAA,EAEvB,WAAA,CAAY,QAAuB,MAAA,EAAyB;AAC1D,IAAA,KAAA,CAAM,MAAM,CAAA;AACZ,IAAA,IAAA,CAAK,OAAA,GAAU,MAAA;AACf,IAAA,IAAA,CAAK,UAAA,GAAa,IAAI,eAAA,CAAgB,MAAA,CAAO,cAAc,CAAA;AAAA,EAC7D;AAAA;AAAA,EAGA,IAAI,YAAA,GAAiD;AACnD,IAAA,OAAO,IAAA,CAAK,UAAU,CAAC,CAAA;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQS,kBAAA,CAAmB,MAAqB,GAAA,EAAqB;AACpE,IAAA,MAAM,UAAA,GAAa,IAAI,OAAA,CAAQ,gBAAA,EAAkB,CAAC,MAAA,KAAW,MAAA,CAAO,aAAa,CAAA;AACjF,IAAA,OAAO,KAAA,CAAM,kBAAA,CAAmB,IAAA,EAAM,UAAU,CAAA;AAAA,EAClD;AAAA,EAES,eAAA,CACP,IAAA,EACA,GAAA,EACA,MAAA,GAAS,KAAA,EACoC;AAC7C,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,IAAA,CAAK,QAAA,GAAW,IAAA,CAAK,kBAAA,CAAmB,IAAA,EAAM,GAAG,CAAA;AAAA,IACnD;AACA,IAAA,MAAM,OAAA,GACJ,IAAA,KAAS,IAAA,GAAO,MAAA,GAAY,sBAAA,CAAuB,MAAM,IAAA,CAAK,kBAAA,CAAmB,IAAA,EAAM,GAAG,CAAC,CAAA;AAC7F,IAAA,IAAI,YAAY,MAAA,EAAW;AACzB,MAAA,IAAA,CAAK,SAAA,CAAU,KAAK,OAAO,CAAA;AAC3B,MAAA,OAAO,OAAA,CAAQ,OAAO,OAAO,CAAA;AAAA,IAC/B;AACA,IAAA,OAAO,KAAA,CAAM,eAAA,CAAgB,IAAA,EAAM,GAAA,EAAK,MAAM,CAAA;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOS,aAAA,CAAc,MAAA,EAAgB,MAAA,GAAS,KAAA,EAAiB;AAC/D,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,OAAA,CAAQ,MAAA,EAAQ,MAAM,CAAA;AAC5C,IAAA,MAAM,OAAA,GAAU,qBAAA,CAAsB,QAAA,CAAS,MAAM,CAAA;AACrD,IAAA,IAAI,YAAY,MAAA,EAAW;AACzB,MAAA,MAAM,IAAI,cAAA,CAAe,OAAA,EAAS,MAAM,CAAA;AAAA,IAC1C;AACA,IAAA,0BAAA,CAA2B,SAAS,MAAM,CAAA;AAC1C,IAAA,OAAO,QAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAA,CAAQ,QAAgB,MAAA,EAA2B;AACjD,IAAA,IAAI,CAAC,WAAA,CAAY,MAAA,CAAO,WAAW,CAAA,EAAG;AACpC,MAAA,OAAO,KAAA,CAAM,aAAA,CAAc,MAAA,EAAQ,MAAM,CAAA;AAAA,IAC3C;AACA,IAAA,IAAI,CAAC,cAAA,CAAe,MAAA,EAAQ,MAAM,CAAA,EAAG;AACnC,MAAA,OAAO,EAAE,MAAA,EAAQ,MAAA,EAAQ,MAAA,CAAO,IAAA,EAAK;AAAA,IACvC;AACA,IAAA,IAAI;AACF,MAAA,OAAO,IAAA,CAAK,UAAA,CAAW,KAAA,CAAM,MAAM,CAAA;AAAA,IACrC,SAAS,KAAA,EAAO;AACd,MAAA,IAAI,SAAA,CAAU,KAAK,CAAA,EAAG;AACpB,QAAA,IAAA,CAAK,SAAA,CAAU,KAAK,KAAK,CAAA;AAAA,MAC3B;AACA,MAAA,MAAM,IAAI,cAAA,CAAe,KAAA,EAAgB,MAAM,CAAA;AAAA,IACjD;AAAA,EACF;AAAA,EAEA,MAAe,gBAAgB,WAAA,EAAsC;AACnE,IAAA,MAAM,OAAA,GAAU,KAAK,aAAA,CAAc,WAAW,KAAM,MAAM,IAAA,CAAK,eAAe,WAAW,CAAA;AACzF,IAAA,IAAI,YAAY,MAAA,EAAW;AACzB,MAAA,IAAA,CAAK,SAAA,CAAU,KAAK,OAAO,CAAA;AAC3B,MAAA,MAAM,OAAA;AAAA,IACR;AACA,IAAA,IAAI;AACF,MAAA,OAAO,MAAM,KAAA,CAAM,eAAA,CAAgB,WAAW,CAAA;AAAA,IAChD,SAAS,KAAA,EAAO;AAEd,MAAA,MAAM,QAAS,KAAA,CAAsC,aAAA;AACrD,MAAA,IAAI,SAAA,CAAU,KAAK,CAAA,EAAG;AACpB,QAAA,IAAA,CAAK,SAAA,CAAU,KAAK,KAAK,CAAA;AAAA,MAC3B;AACA,MAAA,MAAM,KAAA;AAAA,IACR;AAAA,EACF;AAAA,EAEA,eAAe,WAAA,EAAgE;AAC7E,IAAA,OAAO,WAAA,KAAgB,IAAA,CAAK,QAAA,GACxB,OAAA,CAAQ,OAAA,CAAQ,MAAS,CAAA,GACzB,SAAA,CAAU,WAAA,EAAa,IAAA,CAAK,OAAA,CAAQ,MAAM,CAAA;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,cAAc,WAAA,EAAuD;AACnE,IAAA,IAAI,CAAC,WAAA,CAAY,WAAW,CAAA,EAAG;AAC7B,MAAA,OAAO,MAAA;AAAA,IACT;AACA,IAAA,IAAA,CAAK,oBAAA,IAAwB,CAAA;AAC7B,IAAA,MAAM,EAAE,kBAAA,EAAmB,GAAI,IAAA,CAAK,OAAA;AACpC,IAAA,OAAO,IAAA,CAAK,oBAAA,GAAuB,kBAAA,GAC/B,iBAAA,CAAkB,WAAA,EAAa;AAAA,MAC7B,MAAA,EAAQ,2BAAA;AAAA,MACR,YAAA,EAAc;AAAA,KACf,CAAA,GACD,MAAA;AAAA,EACN;AACF;AAEA,SAAS,UAAU,KAAA,EAA+C;AAChE,EAAA,OAAQ,KAAA,EAAqC,SAAS,WAAA,CAAY,oBAAA;AACpE;;"}
|
|
@@ -2,30 +2,72 @@
|
|
|
2
2
|
|
|
3
3
|
const jsonPointer = require('../../domain/openapi/json-pointer.cjs');
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
5
|
+
const DATA_KEYWORDS = /* @__PURE__ */ new Set(["example", "examples", "default", "const", "enum"]);
|
|
6
|
+
const EXTENSION_PREFIX = "x-";
|
|
7
|
+
const NAME_MAPS = /* @__PURE__ */ new Set([
|
|
8
|
+
"properties",
|
|
9
|
+
"patternProperties",
|
|
10
|
+
"dependentSchemas",
|
|
11
|
+
"$defs",
|
|
12
|
+
"definitions",
|
|
13
|
+
"schemas",
|
|
14
|
+
"responses",
|
|
15
|
+
"parameters",
|
|
16
|
+
"requestBodies",
|
|
17
|
+
"headers",
|
|
18
|
+
"securitySchemes",
|
|
19
|
+
"links",
|
|
20
|
+
"callbacks",
|
|
21
|
+
"pathItems",
|
|
22
|
+
"mediaTypes",
|
|
23
|
+
"content",
|
|
24
|
+
"encoding",
|
|
25
|
+
"paths",
|
|
26
|
+
"webhooks"
|
|
27
|
+
]);
|
|
28
|
+
function isDataKey(key) {
|
|
29
|
+
return DATA_KEYWORDS.has(key) || key.startsWith(EXTENSION_PREFIX);
|
|
7
30
|
}
|
|
8
|
-
function
|
|
31
|
+
function openApiNodes(document) {
|
|
9
32
|
const found = [];
|
|
10
33
|
const visited = /* @__PURE__ */ new WeakSet();
|
|
11
34
|
const pending = [];
|
|
12
|
-
const enqueue = (value, pointer) => {
|
|
35
|
+
const enqueue = (value, pointer, hasNameKeys) => {
|
|
13
36
|
if (typeof value === "object" && value !== null && !visited.has(value)) {
|
|
14
37
|
visited.add(value);
|
|
15
|
-
pending.push({ value, pointer });
|
|
38
|
+
pending.push({ value, pointer, hasNameKeys });
|
|
16
39
|
}
|
|
17
40
|
};
|
|
18
|
-
enqueue(document, jsonPointer.ROOT_POINTER);
|
|
41
|
+
enqueue(document, jsonPointer.ROOT_POINTER, false);
|
|
19
42
|
for (let next = pending.pop(); next !== void 0; next = pending.pop()) {
|
|
20
|
-
|
|
21
|
-
found.push({ node: next.value, pointer: next.pointer });
|
|
22
|
-
}
|
|
43
|
+
found.push(next);
|
|
23
44
|
for (const [key, child] of Object.entries(next.value)) {
|
|
24
|
-
|
|
45
|
+
if (next.hasNameKeys || !isDataKey(key)) {
|
|
46
|
+
enqueue(child, jsonPointer.childPointer(next.pointer, key), !next.hasNameKeys && NAME_MAPS.has(key));
|
|
47
|
+
}
|
|
25
48
|
}
|
|
26
49
|
}
|
|
27
50
|
return found;
|
|
28
51
|
}
|
|
52
|
+
function hasStringRef(value) {
|
|
53
|
+
return !Array.isArray(value) && typeof value.$ref === "string";
|
|
54
|
+
}
|
|
55
|
+
function findRefHolders(document) {
|
|
56
|
+
return openApiNodes(document).flatMap(
|
|
57
|
+
({ value, pointer, hasNameKeys }) => !hasNameKeys && hasStringRef(value) ? [{ node: value, pointer }] : []
|
|
58
|
+
);
|
|
59
|
+
}
|
|
60
|
+
function isMapping(value) {
|
|
61
|
+
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
62
|
+
}
|
|
63
|
+
function findMappings(document) {
|
|
64
|
+
return openApiNodes(document).flatMap(({ value, hasNameKeys }) => {
|
|
65
|
+
const { discriminator } = value;
|
|
66
|
+
const mapping = !hasNameKeys && isMapping(discriminator) ? discriminator.mapping : void 0;
|
|
67
|
+
return isMapping(mapping) ? [mapping] : [];
|
|
68
|
+
});
|
|
69
|
+
}
|
|
29
70
|
|
|
71
|
+
exports.findMappings = findMappings;
|
|
30
72
|
exports.findRefHolders = findRefHolders;
|
|
31
73
|
//# sourceMappingURL=ref-holders.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ref-holders.cjs","sources":["../../../src/adapters/redocly-loader/ref-holders.ts"],"sourcesContent":["import { childPointer, ROOT_POINTER } from \"../../domain/openapi/json-pointer.js\";\n\n/** An object with a string `$ref`, and its JSON Pointer in the document. */\nexport interface RefHolder {\n readonly node: { $ref: string };\n readonly pointer: string;\n}\n\ninterface PendingNode {\n readonly value: object;\n readonly pointer: string;\n}\n\nfunction
|
|
1
|
+
{"version":3,"file":"ref-holders.cjs","sources":["../../../src/adapters/redocly-loader/ref-holders.ts"],"sourcesContent":["import { childPointer, ROOT_POINTER } from \"../../domain/openapi/json-pointer.js\";\n\n/** An object with a string `$ref`, and its JSON Pointer in the document. */\nexport interface RefHolder {\n readonly node: { $ref: string };\n readonly pointer: string;\n}\n\n/**\n * Keywords whose value is data, not OpenAPI: a `$ref` or a `discriminator` in an example, a\n * default, a `const` or an `enum` value, or an extension is part of the data and stays as written.\n */\nconst DATA_KEYWORDS = new Set([\"example\", \"examples\", \"default\", \"const\", \"enum\"]);\nconst EXTENSION_PREFIX = \"x-\";\n\n/**\n * Keywords whose value maps names to objects: a property, a schema or a response may be named\n * `default` or `example`, and is OpenAPI all the same.\n */\nconst NAME_MAPS = new Set([\n \"properties\",\n \"patternProperties\",\n \"dependentSchemas\",\n \"$defs\",\n \"definitions\",\n \"schemas\",\n \"responses\",\n \"parameters\",\n \"requestBodies\",\n \"headers\",\n \"securitySchemes\",\n \"links\",\n \"callbacks\",\n \"pathItems\",\n \"mediaTypes\",\n \"content\",\n \"encoding\",\n \"paths\",\n \"webhooks\",\n]);\n\ninterface PendingNode {\n readonly value: object;\n readonly pointer: string;\n /** Whether the keys of `value` are names (of properties, schemas, responses), not keywords. */\n readonly hasNameKeys: boolean;\n}\n\nfunction isDataKey(key: string): boolean {\n return DATA_KEYWORDS.has(key) || key.startsWith(EXTENSION_PREFIX);\n}\n\n/**\n * Every object of a parsed document that is OpenAPI, not data (`DATA_KEYWORDS`), with its JSON\n * Pointer, in no particular order. The walk uses its own stack, so a deeply nested document does\n * not run out of call stack, and a node shared by YAML aliases (or a cycle of them) is visited\n * once.\n */\nfunction openApiNodes(document: unknown): PendingNode[] {\n const found: PendingNode[] = [];\n const visited = new WeakSet<object>();\n const pending: PendingNode[] = [];\n const enqueue = (value: unknown, pointer: string, hasNameKeys: boolean): void => {\n if (typeof value === \"object\" && value !== null && !visited.has(value)) {\n visited.add(value);\n pending.push({ value, pointer, hasNameKeys });\n }\n };\n enqueue(document, ROOT_POINTER, false);\n for (let next = pending.pop(); next !== undefined; next = pending.pop()) {\n found.push(next);\n // One push per child: spreading an array of millions of children overflows the stack.\n for (const [key, child] of Object.entries(next.value)) {\n if (next.hasNameKeys || !isDataKey(key)) {\n enqueue(child, childPointer(next.pointer, key), !next.hasNameKeys && NAME_MAPS.has(key));\n }\n }\n }\n return found;\n}\n\nfunction hasStringRef(value: object): value is { $ref: string } {\n return !Array.isArray(value) && typeof (value as { $ref?: unknown }).$ref === \"string\";\n}\n\n/** Every object with a string `$ref` in a parsed document, outside data, in no particular order. */\nexport function findRefHolders(document: unknown): RefHolder[] {\n return openApiNodes(document).flatMap(({ value, pointer, hasNameKeys }) =>\n !hasNameKeys && hasStringRef(value) ? [{ node: value, pointer }] : [],\n );\n}\n\nfunction isMapping(value: unknown): value is Record<string, unknown> {\n return typeof value === \"object\" && value !== null && !Array.isArray(value);\n}\n\n/** Every `discriminator.mapping` object of a parsed document, outside data. */\nexport function findMappings(document: unknown): Record<string, unknown>[] {\n return openApiNodes(document).flatMap(({ value, hasNameKeys }) => {\n const { discriminator } = value as { discriminator?: unknown };\n const mapping = !hasNameKeys && isMapping(discriminator) ? discriminator.mapping : undefined;\n return isMapping(mapping) ? [mapping] : [];\n });\n}\n"],"names":["ROOT_POINTER","childPointer"],"mappings":";;;;AAYA,MAAM,aAAA,uBAAoB,GAAA,CAAI,CAAC,WAAW,UAAA,EAAY,SAAA,EAAW,OAAA,EAAS,MAAM,CAAC,CAAA;AACjF,MAAM,gBAAA,GAAmB,IAAA;AAMzB,MAAM,SAAA,uBAAgB,GAAA,CAAI;AAAA,EACxB,YAAA;AAAA,EACA,mBAAA;AAAA,EACA,kBAAA;AAAA,EACA,OAAA;AAAA,EACA,aAAA;AAAA,EACA,SAAA;AAAA,EACA,WAAA;AAAA,EACA,YAAA;AAAA,EACA,eAAA;AAAA,EACA,SAAA;AAAA,EACA,iBAAA;AAAA,EACA,OAAA;AAAA,EACA,WAAA;AAAA,EACA,WAAA;AAAA,EACA,YAAA;AAAA,EACA,SAAA;AAAA,EACA,UAAA;AAAA,EACA,OAAA;AAAA,EACA;AACF,CAAC,CAAA;AASD,SAAS,UAAU,GAAA,EAAsB;AACvC,EAAA,OAAO,cAAc,GAAA,CAAI,GAAG,CAAA,IAAK,GAAA,CAAI,WAAW,gBAAgB,CAAA;AAClE;AAQA,SAAS,aAAa,QAAA,EAAkC;AACtD,EAAA,MAAM,QAAuB,EAAC;AAC9B,EAAA,MAAM,OAAA,uBAAc,OAAA,EAAgB;AACpC,EAAA,MAAM,UAAyB,EAAC;AAChC,EAAA,MAAM,OAAA,GAAU,CAAC,KAAA,EAAgB,OAAA,EAAiB,WAAA,KAA+B;AAC/E,IAAA,IAAI,OAAO,UAAU,QAAA,IAAY,KAAA,KAAU,QAAQ,CAAC,OAAA,CAAQ,GAAA,CAAI,KAAK,CAAA,EAAG;AACtE,MAAA,OAAA,CAAQ,IAAI,KAAK,CAAA;AACjB,MAAA,OAAA,CAAQ,IAAA,CAAK,EAAE,KAAA,EAAO,OAAA,EAAS,aAAa,CAAA;AAAA,IAC9C;AAAA,EACF,CAAA;AACA,EAAA,OAAA,CAAQ,QAAA,EAAUA,0BAAc,KAAK,CAAA;AACrC,EAAA,KAAA,IAAS,IAAA,GAAO,QAAQ,GAAA,EAAI,EAAG,SAAS,MAAA,EAAW,IAAA,GAAO,OAAA,CAAQ,GAAA,EAAI,EAAG;AACvE,IAAA,KAAA,CAAM,KAAK,IAAI,CAAA;AAEf,IAAA,KAAA,MAAW,CAAC,KAAK,KAAK,CAAA,IAAK,OAAO,OAAA,CAAQ,IAAA,CAAK,KAAK,CAAA,EAAG;AACrD,MAAA,IAAI,IAAA,CAAK,WAAA,IAAe,CAAC,SAAA,CAAU,GAAG,CAAA,EAAG;AACvC,QAAA,OAAA,CAAQ,KAAA,EAAOC,wBAAA,CAAa,IAAA,CAAK,OAAA,EAAS,GAAG,CAAA,EAAG,CAAC,IAAA,CAAK,WAAA,IAAe,SAAA,CAAU,GAAA,CAAI,GAAG,CAAC,CAAA;AAAA,MACzF;AAAA,IACF;AAAA,EACF;AACA,EAAA,OAAO,KAAA;AACT;AAEA,SAAS,aAAa,KAAA,EAA0C;AAC9D,EAAA,OAAO,CAAC,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,IAAK,OAAQ,MAA6B,IAAA,KAAS,QAAA;AAChF;AAGO,SAAS,eAAe,QAAA,EAAgC;AAC7D,EAAA,OAAO,YAAA,CAAa,QAAQ,CAAA,CAAE,OAAA;AAAA,IAAQ,CAAC,EAAE,KAAA,EAAO,SAAS,WAAA,EAAY,KACnE,CAAC,WAAA,IAAe,YAAA,CAAa,KAAK,CAAA,GAAI,CAAC,EAAE,IAAA,EAAM,OAAO,OAAA,EAAS,IAAI;AAAC,GACtE;AACF;AAEA,SAAS,UAAU,KAAA,EAAkD;AACnE,EAAA,OAAO,OAAO,UAAU,QAAA,IAAY,KAAA,KAAU,QAAQ,CAAC,KAAA,CAAM,QAAQ,KAAK,CAAA;AAC5E;AAGO,SAAS,aAAa,QAAA,EAA8C;AACzE,EAAA,OAAO,YAAA,CAAa,QAAQ,CAAA,CAAE,OAAA,CAAQ,CAAC,EAAE,KAAA,EAAO,aAAY,KAAM;AAChE,IAAA,MAAM,EAAE,eAAc,GAAI,KAAA;AAC1B,IAAA,MAAM,UAAU,CAAC,WAAA,IAAe,UAAU,aAAa,CAAA,GAAI,cAAc,OAAA,GAAU,MAAA;AACnF,IAAA,OAAO,UAAU,OAAO,CAAA,GAAI,CAAC,OAAO,IAAI,EAAC;AAAA,EAC3C,CAAC,CAAA;AACH;;;"}
|