@maverickcer/env-cap 0.7.4 → 0.7.6
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/ADOPTION.md +106 -124
- package/AGENTS.md +94 -128
- package/CHANGELOG.md +42 -0
- package/CODE_REVIEW.md +69 -173
- package/CONTRIBUTING.md +57 -74
- package/GUIDE.md +405 -866
- package/README.md +112 -89
- package/RELEASING.md +81 -65
- package/SECURITY.md +76 -227
- package/SUPPORT.md +21 -45
- package/VERSIONING.md +69 -105
- package/benchmarks/READING-BENCHMARKS.md +103 -81
- package/benchmarks/README.md +12 -9
- package/benchmarks/WRITING-BENCHMARKS.md +90 -80
- package/benchmarks/performance-buildtime/BENCHMARKS.md +20 -20
- package/benchmarks/performance-runtime/BENCHMARKS.md +107 -107
- package/dist/.dts/_ipc/build-fs.d.ts +12 -17
- package/dist/.dts/_ipc/build-fs.d.ts.map +1 -1
- package/dist/.dts/_ipc/compiler-api.d.ts +6 -6
- package/dist/.dts/_ipc/display-path.d.ts +1 -1
- package/dist/.dts/_ipc/display-path.d.ts.map +1 -1
- package/dist/.dts/_ipc/generated-banner.d.ts +8 -8
- package/dist/.dts/_ipc/glob.d.ts +9 -8
- package/dist/.dts/_ipc/glob.d.ts.map +1 -1
- package/dist/.dts/_ipc/no-node-fs.d.ts +2 -2
- package/dist/.dts/_ipc/no-node-fs.d.ts.map +1 -1
- package/dist/.dts/_ipc/resolve-tsconfig-paths.d.ts +16 -16
- package/dist/.dts/_ipc/resolve-tsconfig-paths.d.ts.map +1 -1
- package/dist/.dts/_ipc/typescript.d.ts +4 -4
- package/dist/.dts/build/assemble-project.d.ts +14 -15
- package/dist/.dts/build/assemble-project.d.ts.map +1 -1
- package/dist/.dts/build/change-model.d.ts +14 -14
- package/dist/.dts/build/change-model.d.ts.map +1 -1
- package/dist/.dts/build/check-artifacts.d.ts +4 -4
- package/dist/.dts/build/check-artifacts.d.ts.map +1 -1
- package/dist/.dts/build/citation-verification.d.ts +13 -14
- package/dist/.dts/build/citation-verification.d.ts.map +1 -1
- package/dist/.dts/build/compatibility.d.ts +24 -24
- package/dist/.dts/build/compatibility.d.ts.map +1 -1
- package/dist/.dts/build/contract-model.d.ts +10 -10
- package/dist/.dts/build/contract-model.d.ts.map +1 -1
- package/dist/.dts/build/deep-equal.d.ts +2 -2
- package/dist/.dts/build/deep-freeze.d.ts +2 -2
- package/dist/.dts/build/dependency-graph.d.ts +48 -55
- package/dist/.dts/build/dependency-graph.d.ts.map +1 -1
- package/dist/.dts/build/dependency-model.d.ts +18 -18
- package/dist/.dts/build/dependency-model.d.ts.map +1 -1
- package/dist/.dts/build/discover.d.ts +11 -11
- package/dist/.dts/build/discover.d.ts.map +1 -1
- package/dist/.dts/build/docs.d.ts +34 -38
- package/dist/.dts/build/docs.d.ts.map +1 -1
- package/dist/.dts/build/env-example.d.ts +13 -13
- package/dist/.dts/build/env-example.d.ts.map +1 -1
- package/dist/.dts/build/errors.d.ts +8 -8
- package/dist/.dts/build/evidence-cache.d.ts +23 -23
- package/dist/.dts/build/evidence-cache.d.ts.map +1 -1
- package/dist/.dts/build/evidence-model.d.ts +3 -3
- package/dist/.dts/build/evidence-reference.d.ts +15 -15
- package/dist/.dts/build/evidence-reference.d.ts.map +1 -1
- package/dist/.dts/build/evidence-snapshot.d.ts +47 -53
- package/dist/.dts/build/evidence-snapshot.d.ts.map +1 -1
- package/dist/.dts/build/exclusive-group.d.ts +4 -4
- package/dist/.dts/build/exclusive-group.d.ts.map +1 -1
- package/dist/.dts/build/finding-model.d.ts +12 -12
- package/dist/.dts/build/finding-model.d.ts.map +1 -1
- package/dist/.dts/build/generate-documentation.d.ts +19 -19
- package/dist/.dts/build/generate-documentation.d.ts.map +1 -1
- package/dist/.dts/build/generate-env-artifacts.d.ts +43 -43
- package/dist/.dts/build/generate-env-artifacts.d.ts.map +1 -1
- package/dist/.dts/build/generate-evidence.d.ts +19 -19
- package/dist/.dts/build/generate-evidence.d.ts.map +1 -1
- package/dist/.dts/build/generate-manifest.d.ts +11 -12
- package/dist/.dts/build/generate-manifest.d.ts.map +1 -1
- package/dist/.dts/build/generate-usage.d.ts +23 -24
- package/dist/.dts/build/generate-usage.d.ts.map +1 -1
- package/dist/.dts/build/generated-banner.d.ts +5 -5
- package/dist/.dts/build/governance-fields.d.ts +7 -7
- package/dist/.dts/build/humanize-key.d.ts +1 -1
- package/dist/.dts/build/humanize-key.d.ts.map +1 -1
- package/dist/.dts/build/index.d.ts +20 -36
- package/dist/.dts/build/index.d.ts.map +1 -1
- package/dist/.dts/build/lifecycle-model.d.ts +90 -83
- package/dist/.dts/build/lifecycle-model.d.ts.map +1 -1
- package/dist/.dts/build/link.d.ts +38 -39
- package/dist/.dts/build/link.d.ts.map +1 -1
- package/dist/.dts/build/literal-eval.d.ts +2 -2
- package/dist/.dts/build/literal-eval.d.ts.map +1 -1
- package/dist/.dts/build/live-expirations.d.ts +14 -13
- package/dist/.dts/build/live-expirations.d.ts.map +1 -1
- package/dist/.dts/build/manifest.d.ts +6 -6
- package/dist/.dts/build/map-utils.d.ts +4 -4
- package/dist/.dts/build/merge-documentation.d.ts +9 -8
- package/dist/.dts/build/merge-documentation.d.ts.map +1 -1
- package/dist/.dts/build/ownership-model.d.ts +14 -15
- package/dist/.dts/build/ownership-model.d.ts.map +1 -1
- package/dist/.dts/build/parse.d.ts +20 -21
- package/dist/.dts/build/parse.d.ts.map +1 -1
- package/dist/.dts/build/reference-projections.d.ts +36 -38
- package/dist/.dts/build/reference-projections.d.ts.map +1 -1
- package/dist/.dts/build/resolution/resolve-import.d.ts +18 -14
- package/dist/.dts/build/resolution/resolve-import.d.ts.map +1 -1
- package/dist/.dts/build/resolution/resolve-package-schema.d.ts +26 -26
- package/dist/.dts/build/resolution/resolve-package-schema.d.ts.map +1 -1
- package/dist/.dts/build/resolution/resolve-within-root.d.ts +9 -9
- package/dist/.dts/build/sarif.d.ts +5 -5
- package/dist/.dts/build/sarif.d.ts.map +1 -1
- package/dist/.dts/build/scan-dependencies.d.ts +17 -16
- package/dist/.dts/build/scan-dependencies.d.ts.map +1 -1
- package/dist/.dts/build/sort-by-identity.d.ts +1 -1
- package/dist/.dts/build/source-position.d.ts +13 -13
- package/dist/.dts/build/tool-version.d.ts +1 -1
- package/dist/.dts/build/usage-report.d.ts +19 -19
- package/dist/.dts/build/usage-report.d.ts.map +1 -1
- package/dist/.dts/eslint-plugin/index.d.ts +16 -5
- package/dist/.dts/eslint-plugin/index.d.ts.map +1 -1
- package/dist/.dts/eslint-plugin/no-raw-process-env.d.ts +4 -4
- package/dist/.dts/evidence/define-projection.d.ts +15 -16
- package/dist/.dts/evidence/define-projection.d.ts.map +1 -1
- package/dist/.dts/evidence/index.d.ts +11 -15
- package/dist/.dts/evidence/index.d.ts.map +1 -1
- package/dist/.dts/helpers/index.d.ts +15 -18
- package/dist/.dts/helpers/index.d.ts.map +1 -1
- package/dist/.dts/helpers/validators.d.ts +2 -2
- package/dist/.dts/helpers/validators.d.ts.map +1 -1
- package/dist/.dts/node/index.d.ts +19 -0
- package/dist/.dts/node/index.d.ts.map +1 -1
- package/dist/.dts/runtime/create.d.ts +6 -3
- package/dist/.dts/runtime/create.d.ts.map +1 -1
- package/dist/.dts/runtime/document.d.ts +91 -97
- package/dist/.dts/runtime/document.d.ts.map +1 -1
- package/dist/.dts/runtime/errors.d.ts +5 -5
- package/dist/.dts/runtime/index.d.ts +11 -10
- package/dist/.dts/runtime/index.d.ts.map +1 -1
- package/dist/.dts/runtime/reset.d.ts +1 -1
- package/dist/.dts/runtime/types.d.ts +39 -24
- package/dist/.dts/runtime/types.d.ts.map +1 -1
- package/dist/.dts/runtime/validate.d.ts +15 -2
- package/dist/.dts/runtime/validate.d.ts.map +1 -1
- package/dist/.dts7/_ipc/build-fs.d.ts +48 -0
- package/dist/.dts7/_ipc/build-fs.d.ts.map +1 -0
- package/dist/.dts7/_ipc/compiler-api.d.ts +17 -0
- package/dist/.dts7/_ipc/compiler-api.d.ts.map +1 -0
- package/dist/.dts7/_ipc/display-path.d.ts +27 -0
- package/dist/.dts7/_ipc/display-path.d.ts.map +1 -0
- package/dist/.dts7/_ipc/generated-banner.d.ts +58 -0
- package/dist/.dts7/_ipc/generated-banner.d.ts.map +1 -0
- package/dist/.dts7/_ipc/glob.d.ts +23 -0
- package/dist/.dts7/_ipc/glob.d.ts.map +1 -0
- package/dist/.dts7/_ipc/no-node-fs.d.ts +21 -0
- package/dist/.dts7/_ipc/no-node-fs.d.ts.map +1 -0
- package/dist/.dts7/_ipc/resolve-tsconfig-paths.d.ts +134 -0
- package/dist/.dts7/_ipc/resolve-tsconfig-paths.d.ts.map +1 -0
- package/dist/.dts7/_ipc/typescript.d.ts +20 -0
- package/dist/.dts7/_ipc/typescript.d.ts.map +1 -0
- package/dist/.dts7/build/assemble-project.d.ts +46 -0
- package/dist/.dts7/build/assemble-project.d.ts.map +1 -0
- package/dist/.dts7/build/change-model.d.ts +63 -0
- package/dist/.dts7/build/change-model.d.ts.map +1 -0
- package/dist/.dts7/build/check-artifacts.d.ts +48 -0
- package/dist/.dts7/build/check-artifacts.d.ts.map +1 -0
- package/dist/.dts7/build/citation-verification.d.ts +61 -0
- package/dist/.dts7/build/citation-verification.d.ts.map +1 -0
- package/dist/.dts7/build/compatibility.d.ts +83 -0
- package/dist/.dts7/build/compatibility.d.ts.map +1 -0
- package/dist/.dts7/build/compiler-api.d.ts +12 -0
- package/dist/.dts7/build/compiler-api.d.ts.map +1 -0
- package/dist/.dts7/build/contract-model.d.ts +93 -0
- package/dist/.dts7/build/contract-model.d.ts.map +1 -0
- package/dist/.dts7/build/deep-equal.d.ts +9 -0
- package/dist/.dts7/build/deep-equal.d.ts.map +1 -0
- package/dist/.dts7/build/deep-freeze.d.ts +20 -0
- package/dist/.dts7/build/deep-freeze.d.ts.map +1 -0
- package/dist/.dts7/build/dependency-graph.d.ts +163 -0
- package/dist/.dts7/build/dependency-graph.d.ts.map +1 -0
- package/dist/.dts7/build/dependency-model.d.ts +81 -0
- package/dist/.dts7/build/dependency-model.d.ts.map +1 -0
- package/dist/.dts7/build/discover.d.ts +41 -0
- package/dist/.dts7/build/discover.d.ts.map +1 -0
- package/dist/.dts7/build/display-path.d.ts +6 -0
- package/dist/.dts7/build/display-path.d.ts.map +1 -0
- package/dist/.dts7/build/docs.d.ts +172 -0
- package/dist/.dts7/build/docs.d.ts.map +1 -0
- package/dist/.dts7/build/env-example.d.ts +85 -0
- package/dist/.dts7/build/env-example.d.ts.map +1 -0
- package/dist/.dts7/build/errors.d.ts +78 -0
- package/dist/.dts7/build/errors.d.ts.map +1 -0
- package/dist/.dts7/build/evidence-cache.d.ts +74 -0
- package/dist/.dts7/build/evidence-cache.d.ts.map +1 -0
- package/dist/.dts7/build/evidence-model.d.ts +50 -0
- package/dist/.dts7/build/evidence-model.d.ts.map +1 -0
- package/dist/.dts7/build/evidence-reference.d.ts +67 -0
- package/dist/.dts7/build/evidence-reference.d.ts.map +1 -0
- package/dist/.dts7/build/evidence-snapshot.d.ts +142 -0
- package/dist/.dts7/build/evidence-snapshot.d.ts.map +1 -0
- package/dist/.dts7/build/exclusive-group.d.ts +19 -0
- package/dist/.dts7/build/exclusive-group.d.ts.map +1 -0
- package/dist/.dts7/build/finding-model.d.ts +80 -0
- package/dist/.dts7/build/finding-model.d.ts.map +1 -0
- package/dist/.dts7/build/generate-documentation.d.ts +176 -0
- package/dist/.dts7/build/generate-documentation.d.ts.map +1 -0
- package/dist/.dts7/build/generate-env-artifacts.d.ts +191 -0
- package/dist/.dts7/build/generate-env-artifacts.d.ts.map +1 -0
- package/dist/.dts7/build/generate-evidence.d.ts +77 -0
- package/dist/.dts7/build/generate-evidence.d.ts.map +1 -0
- package/dist/.dts7/build/generate-manifest.d.ts +100 -0
- package/dist/.dts7/build/generate-manifest.d.ts.map +1 -0
- package/dist/.dts7/build/generate-usage.d.ts +94 -0
- package/dist/.dts7/build/generate-usage.d.ts.map +1 -0
- package/dist/.dts7/build/generated-banner.d.ts +43 -0
- package/dist/.dts7/build/generated-banner.d.ts.map +1 -0
- package/dist/.dts7/build/glob.d.ts +6 -0
- package/dist/.dts7/build/glob.d.ts.map +1 -0
- package/dist/.dts7/build/governance-fields.d.ts +34 -0
- package/dist/.dts7/build/governance-fields.d.ts.map +1 -0
- package/dist/.dts7/build/humanize-key.d.ts +14 -0
- package/dist/.dts7/build/humanize-key.d.ts.map +1 -0
- package/dist/.dts7/build/index.d.ts +89 -0
- package/dist/.dts7/build/index.d.ts.map +1 -0
- package/dist/.dts7/build/lifecycle-model.d.ts +181 -0
- package/dist/.dts7/build/lifecycle-model.d.ts.map +1 -0
- package/dist/.dts7/build/link.d.ts +222 -0
- package/dist/.dts7/build/link.d.ts.map +1 -0
- package/dist/.dts7/build/literal-eval.d.ts +24 -0
- package/dist/.dts7/build/literal-eval.d.ts.map +1 -0
- package/dist/.dts7/build/live-expirations.d.ts +48 -0
- package/dist/.dts7/build/live-expirations.d.ts.map +1 -0
- package/dist/.dts7/build/manifest.d.ts +31 -0
- package/dist/.dts7/build/manifest.d.ts.map +1 -0
- package/dist/.dts7/build/map-utils.d.ts +8 -0
- package/dist/.dts7/build/map-utils.d.ts.map +1 -0
- package/dist/.dts7/build/merge-documentation.d.ts +36 -0
- package/dist/.dts7/build/merge-documentation.d.ts.map +1 -0
- package/dist/.dts7/build/ownership-model.d.ts +58 -0
- package/dist/.dts7/build/ownership-model.d.ts.map +1 -0
- package/dist/.dts7/build/parse.d.ts +206 -0
- package/dist/.dts7/build/parse.d.ts.map +1 -0
- package/dist/.dts7/build/reference-projections.d.ts +168 -0
- package/dist/.dts7/build/reference-projections.d.ts.map +1 -0
- package/dist/.dts7/build/resolution/resolve-import.d.ts +62 -0
- package/dist/.dts7/build/resolution/resolve-import.d.ts.map +1 -0
- package/dist/.dts7/build/resolution/resolve-package-schema.d.ts +83 -0
- package/dist/.dts7/build/resolution/resolve-package-schema.d.ts.map +1 -0
- package/dist/.dts7/build/resolution/resolve-tsconfig-paths.d.ts +18 -0
- package/dist/.dts7/build/resolution/resolve-tsconfig-paths.d.ts.map +1 -0
- package/dist/.dts7/build/resolution/resolve-within-root.d.ts +35 -0
- package/dist/.dts7/build/resolution/resolve-within-root.d.ts.map +1 -0
- package/dist/.dts7/build/sarif.d.ts +66 -0
- package/dist/.dts7/build/sarif.d.ts.map +1 -0
- package/dist/.dts7/build/scan-dependencies.d.ts +71 -0
- package/dist/.dts7/build/scan-dependencies.d.ts.map +1 -0
- package/dist/.dts7/build/sort-by-identity.d.ts +14 -0
- package/dist/.dts7/build/sort-by-identity.d.ts.map +1 -0
- package/dist/.dts7/build/source-position.d.ts +69 -0
- package/dist/.dts7/build/source-position.d.ts.map +1 -0
- package/dist/.dts7/build/tool-version.d.ts +8 -0
- package/dist/.dts7/build/tool-version.d.ts.map +1 -0
- package/dist/.dts7/build/types.d.ts +7 -0
- package/dist/.dts7/build/types.d.ts.map +1 -0
- package/dist/.dts7/build/typescript.d.ts +6 -0
- package/dist/.dts7/build/typescript.d.ts.map +1 -0
- package/dist/.dts7/build/usage-report.d.ts +124 -0
- package/dist/.dts7/build/usage-report.d.ts.map +1 -0
- package/dist/.dts7/cli/filesystem.d.ts +7 -0
- package/dist/.dts7/cli/filesystem.d.ts.map +1 -0
- package/dist/.dts7/eslint-plugin/glob.d.ts +7 -0
- package/dist/.dts7/eslint-plugin/glob.d.ts.map +1 -0
- package/dist/.dts7/eslint-plugin/index.d.ts +38 -0
- package/dist/.dts7/eslint-plugin/index.d.ts.map +1 -0
- package/dist/.dts7/eslint-plugin/no-node-fs.d.ts +15 -0
- package/dist/.dts7/eslint-plugin/no-node-fs.d.ts.map +1 -0
- package/dist/.dts7/eslint-plugin/no-raw-process-env.d.ts +23 -0
- package/dist/.dts7/eslint-plugin/no-raw-process-env.d.ts.map +1 -0
- package/dist/.dts7/evidence/define-projection.d.ts +51 -0
- package/dist/.dts7/evidence/define-projection.d.ts.map +1 -0
- package/dist/.dts7/evidence/index.d.ts +19 -0
- package/dist/.dts7/evidence/index.d.ts.map +1 -0
- package/dist/.dts7/helpers/index.d.ts +132 -0
- package/dist/.dts7/helpers/index.d.ts.map +1 -0
- package/dist/.dts7/helpers/processors.d.ts +32 -0
- package/dist/.dts7/helpers/processors.d.ts.map +1 -0
- package/dist/.dts7/helpers/validators.d.ts +68 -0
- package/dist/.dts7/helpers/validators.d.ts.map +1 -0
- package/dist/.dts7/node/index.d.ts +21 -0
- package/dist/.dts7/node/index.d.ts.map +1 -0
- package/dist/.dts7/runtime/cache.d.ts +17 -0
- package/dist/.dts7/runtime/cache.d.ts.map +1 -0
- package/dist/.dts7/runtime/create.d.ts +23 -0
- package/dist/.dts7/runtime/create.d.ts.map +1 -0
- package/dist/.dts7/runtime/document.d.ts +214 -0
- package/dist/.dts7/runtime/document.d.ts.map +1 -0
- package/dist/.dts7/runtime/errors.d.ts +55 -0
- package/dist/.dts7/runtime/errors.d.ts.map +1 -0
- package/dist/.dts7/runtime/index.d.ts +25 -0
- package/dist/.dts7/runtime/index.d.ts.map +1 -0
- package/dist/.dts7/runtime/registry.d.ts +12 -0
- package/dist/.dts7/runtime/registry.d.ts.map +1 -0
- package/dist/.dts7/runtime/reset.d.ts +8 -0
- package/dist/.dts7/runtime/reset.d.ts.map +1 -0
- package/dist/.dts7/runtime/types.d.ts +190 -0
- package/dist/.dts7/runtime/types.d.ts.map +1 -0
- package/dist/.dts7/runtime/validate.d.ts +27 -0
- package/dist/.dts7/runtime/validate.d.ts.map +1 -0
- package/dist/{build-6XFHJFQK.js → build-UEENZEUX.js} +43 -42
- package/dist/build-UEENZEUX.js.map +1 -0
- package/dist/build.cjs +42 -41
- package/dist/build.cjs.map +1 -1
- package/dist/build.js +42 -41
- package/dist/build.js.map +1 -1
- package/dist/build.ts7.d.cts +1 -0
- package/dist/build.ts7.d.ts +1 -0
- package/dist/{chunk-RL5KFVUT.js → chunk-TBL3O7IG.js} +2 -2
- package/dist/cli/index.js +29 -28
- package/dist/cli/index.js.map +1 -1
- package/dist/eslint-plugin/index.cjs.map +1 -1
- package/dist/eslint-plugin/index.js.map +1 -1
- package/dist/eslint-plugin/index.ts7.d.cts +1 -0
- package/dist/eslint-plugin/index.ts7.d.ts +1 -0
- package/dist/evidence.cjs +1 -1
- package/dist/evidence.cjs.map +1 -1
- package/dist/evidence.js +1 -1
- package/dist/evidence.js.map +1 -1
- package/dist/evidence.ts7.d.cts +1 -0
- package/dist/evidence.ts7.d.ts +1 -0
- package/dist/helpers.cjs +4 -4
- package/dist/helpers.cjs.map +1 -1
- package/dist/helpers.js +4 -4
- package/dist/helpers.js.map +1 -1
- package/dist/helpers.ts7.d.cts +1 -0
- package/dist/helpers.ts7.d.ts +1 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.ts7.d.cts +1 -0
- package/dist/index.ts7.d.ts +1 -0
- package/dist/node.ts7.d.cts +1 -0
- package/dist/node.ts7.d.ts +1 -0
- package/examples/README.md +46 -80
- package/package.json +43 -12
- package/schemas/contract-model.schema.json +7 -7
- package/schemas/env-cap-report.schema.json +88 -88
- package/skills/env-cap/SKILL.md +12 -13
- package/skills/env-cap/references/api.md +1 -1
- package/specs/architecture.md +147 -122
- package/specs/decisions/0001-runtime-documentation-separation.md +1 -1
- package/specs/decisions/0014-cross-package-schema-discovery.md +4 -1
- package/specs/decisions/0023-tsconfig-path-alias-resolution.md +4 -1
- package/specs/decisions/0049-typescript-7-scanner-uses-a-bundled-typescript-6.md +13 -8
- package/specs/generated-artifacts.md +91 -71
- package/specs/migrations/README.md +6 -6
- package/specs/migrations/from-centralized-schema.md +1 -1
- package/specs/migrations/from-t3-env.md +9 -9
- package/PROMPT.md +0 -89
- package/dist/build-6XFHJFQK.js.map +0 -1
- /package/dist/{chunk-RL5KFVUT.js.map → chunk-TBL3O7IG.js.map} +0 -0
|
@@ -1,45 +1,29 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* The build entry point (`@maverickcer/env-cap/build`): find every contract in a project and write the
|
|
3
|
+
* files built from them. Those are the manifest, the environment docs, `.env.example`, the ownership
|
|
4
|
+
* report and the evidence file.
|
|
3
5
|
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* `
|
|
9
|
-
* discovered schema file.
|
|
6
|
+
* Run it from a build script or CI, never from application code. It parses schema files as TypeScript
|
|
7
|
+
* syntax trees and never imports or runs them. Only literal values resolve; anything dynamic becomes a
|
|
8
|
+
* warning, never a guess. It imports `node:path` and a TypeScript compiler, but never `node:fs`
|
|
9
|
+
* (ADR 0040). So every options object takes a required `fs: BuildFileSystem`. Node build scripts pass
|
|
10
|
+
* `nodeBuildFileSystem` from `@maverickcer/env-cap/node`, the same adapter the `env-cap` CLI uses.
|
|
10
11
|
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* running these functions from their own Node build script imports the same
|
|
16
|
-
* adapter from `@maverickcer/env-cap/node` (`{ nodeBuildFileSystem }`).
|
|
12
|
+
* Four orchestrators cover most uses: `generateEnvManifest`, `generateDocumentation`,
|
|
13
|
+
* `generateUsageReport` and `generateEnvArtifacts`. The lower-level discovery and linking primitives
|
|
14
|
+
* serve custom CI scripts and bundler plugins. Both groups are Stable (ADR 0045, `VERSIONING.md`).
|
|
15
|
+
* The ownership engine's scanning, graph and derivation internals stay unexported (ADR 0010, ADR 0011).
|
|
17
16
|
*
|
|
18
|
-
* The
|
|
19
|
-
*
|
|
20
|
-
* `
|
|
21
|
-
* justified by real external use (custom CI scripts, bundler plugins) and
|
|
22
|
-
* promoted to Stable alongside the orchestrators per ADR 0045 -- see
|
|
23
|
-
* `VERSIONING.md`. The dependency-ownership engine's internals (scanning,
|
|
24
|
-
* graph-building, derivation) are intentionally NOT exported here -- see ADR
|
|
25
|
-
* 0010 and ADR 0011. `env-cap` answers ownership/visibility questions; it
|
|
26
|
-
* doesn't ship a general-purpose static-analysis toolkit. The scanner
|
|
27
|
-
* follows object-destructuring and one level of file-unique `const`
|
|
28
|
-
* aliasing, and records every other shape as an explicit `escape` (ADR
|
|
29
|
-
* 0039); a variable on an escaped contract is `indeterminate`, never a false
|
|
30
|
-
* `unconsumed`, and the finding's `reason` cites every escape site.
|
|
17
|
+
* The usage scanner follows object destructuring and one level of file-unique `const` aliasing. It
|
|
18
|
+
* records every other access shape as an `escape` (ADR 0039). A variable on an escaped contract is
|
|
19
|
+
* `indeterminate`, never a false `unconsumed`, and the finding's `reason` cites every escape site.
|
|
31
20
|
*
|
|
32
|
-
* Each generator also
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
21
|
+
* Each generator also takes two discovery options. `packages` is an allowlist of installed packages
|
|
22
|
+
* whose published schema it reads (ADR 0014). `tsconfig` resolves path aliases such as `"@/lib/env"`
|
|
23
|
+
* from the project's `tsconfig.json`; it is on by default because it never crosses a package
|
|
24
|
+
* boundary (ADR 0023).
|
|
36
25
|
*
|
|
37
|
-
*
|
|
38
|
-
* import specifiers written as TypeScript path aliases (e.g. `"@/lib/env"`)
|
|
39
|
-
* against a project's own `tsconfig.json` `paths`/`baseUrl` during static
|
|
40
|
-
* analysis. Unlike `packages`, this is on by default (auto-detecting
|
|
41
|
-
* `tsconfig.json` at `root`) since it never crosses a trust/versioning
|
|
42
|
-
* boundary -- see ADR 0023 and `VERSIONING.md`.
|
|
26
|
+
* @packageDocumentation
|
|
43
27
|
*/
|
|
44
28
|
export { checkEnvArtifacts } from "./check-artifacts.js";
|
|
45
29
|
export type { ArtifactCheckFinding, CheckEnvArtifactsResult } from "./check-artifacts.js";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/build/index.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/build/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,YAAY,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AACzF,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAA;AACnE,OAAO,EACL,2BAA2B,EAC3B,KAAK,qBAAqB,EAC1B,KAAK,4BAA4B,EACjC,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,GACjC,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAA;AAClE,YAAY,EACV,2BAA2B,EAC3B,0BAA0B,GAC3B,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAC5D,YAAY,EAAE,0BAA0B,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAA;AAQnG,YAAY,EACV,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EACnB,sBAAsB,GACvB,MAAM,wBAAwB,CAAA;AAG/B,OAAO,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AAChF,YAAY,EACV,+BAA+B,EAC/B,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AACzD,YAAY,EAAE,0BAA0B,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAA;AAShG,OAAO,EACL,iBAAiB,EACjB,KAAK,wBAAwB,EAC7B,KAAK,4BAA4B,EACjC,KAAK,6BAA6B,EAClC,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,8BAA8B,EACnC,KAAK,yBAAyB,GAC/B,MAAM,mBAAmB,CAAA;AAI1B,YAAY,EAAE,4BAA4B,EAAE,MAAM,4BAA4B,CAAA;AAE9E,YAAY,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AACpF,OAAO,EACL,+BAA+B,EAC/B,0BAA0B,EAC1B,yBAAyB,EACzB,qBAAqB,GACtB,MAAM,aAAa,CAAA;AACpB,YAAY,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAA;AAM1D,OAAO,EAAE,gBAAgB,EAAE,2BAA2B,EAAE,MAAM,mBAAmB,CAAA;AACjF,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACrE,OAAO,EAAE,yBAAyB,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAA;AAK7F,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAG/C,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAC1C,YAAY,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAG1C,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,qBAAqB,EACrB,gBAAgB,GACjB,MAAM,4BAA4B,CAAA;AACnC,YAAY,EACV,sBAAsB,EACtB,2BAA2B,EAC3B,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,qBAAqB,GACtB,MAAM,4BAA4B,CAAA;AAKnC,OAAO,EAAE,kBAAkB,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAA;AACvF,YAAY,EACV,aAAa,EACb,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,qBAAqB,CAAA;AAI5B,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAK7C,OAAO,EAAE,oBAAoB,EAAE,+BAA+B,EAAE,MAAM,uBAAuB,CAAA;AAC7F,YAAY,EACV,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACvB,0BAA0B,EAC1B,uBAAuB,GACxB,MAAM,uBAAuB,CAAA;AAI9B,YAAY,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAA;AAMjF,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AACnD,OAAO,EACL,sBAAsB,EACtB,6BAA6B,EAC7B,+BAA+B,EAC/B,UAAU,GACX,MAAM,WAAW,CAAA;AAClB,YAAY,EACV,aAAa,EACb,iBAAiB,EACjB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,GACxB,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,wBAAwB,EACxB,gBAAgB,EAChB,eAAe,GAChB,MAAM,kBAAkB,CAAA;AACzB,YAAY,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAC9F,YAAY,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAIlF,OAAO,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAA;AACnE,YAAY,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAM5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAA;AAC9D,YAAY,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAA;AAK1E,YAAY,EACV,uBAAuB,EACvB,yBAAyB,EACzB,WAAW,EACX,iBAAiB,EACjB,0BAA0B,GAC3B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAA;AACjE,OAAO,EAAE,iBAAiB,EAAE,4BAA4B,EAAE,MAAM,oBAAoB,CAAA;AACpF,YAAY,EACV,sBAAsB,EACtB,OAAO,EACP,WAAW,EACX,aAAa,EACb,YAAY,GACb,MAAM,oBAAoB,CAAA;AAI3B,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,8BAA8B,EAC9B,uBAAuB,GACxB,MAAM,sBAAsB,CAAA;AAC7B,YAAY,EACV,cAAc,EACd,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,GACzB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AACrD,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AACnG,OAAO,EACL,4BAA4B,EAC5B,oBAAoB,EACpB,0BAA0B,GAC3B,MAAM,uBAAuB,CAAA;AAC9B,YAAY,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAI9C,OAAO,EAAE,mBAAmB,EAAE,8BAA8B,EAAE,MAAM,sBAAsB,CAAA;AAC1F,YAAY,EACV,cAAc,EACd,sBAAsB,EACtB,yBAAyB,EACzB,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AACzF,YAAY,EACV,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,EAC1B,eAAe,EACf,aAAa,EACb,YAAY,EACZ,SAAS,GACV,MAAM,YAAY,CAAA;AACnB,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAA;AAQtE,YAAY,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAA;AAK3E,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAG1E,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA"}
|
|
@@ -1,36 +1,41 @@
|
|
|
1
1
|
import type { ExpiringEntry } from "./docs.js";
|
|
2
2
|
import type { DiscoveredContract } from "./link.js";
|
|
3
3
|
/**
|
|
4
|
-
* The fifth of env-cap's seven canonical fact models (ADR 0024)
|
|
4
|
+
* The fifth of env-cap's seven canonical fact models (ADR 0024): every
|
|
5
5
|
* contract and variable's lifecycle data (expiry, deprecation, rename
|
|
6
|
-
* correlation)
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
6
|
+
* correlation). It promotes `ExpiringEntry`/`computeExpiringEntries()` into a
|
|
7
|
+
* canonical, versioned shape alongside the new deprecation/rename fields.
|
|
8
|
+
* Those were already real, exported, and reused across `renderDocs()` and
|
|
9
|
+
* `generate-documentation.ts`. See ADR 0029.
|
|
10
10
|
*
|
|
11
11
|
* As of schema version 3, this also carries NIST SP 800-53 IA-5 rotation
|
|
12
12
|
* data (`authenticatorType`/`rotationPeriod`/`lastRotatedAt`/
|
|
13
|
-
* `rotationTriggerEvents`) and a computed `rotationStatus` per variable
|
|
14
|
-
*
|
|
15
|
-
* call
|
|
16
|
-
*
|
|
13
|
+
* `rotationTriggerEvents`) and a computed `rotationStatus` per variable.
|
|
14
|
+
* See `computeRotationStatus()` below for the compliance-status judgment
|
|
15
|
+
* call. The `rotation-log` example generator (peer to `generate-docs/`) is
|
|
16
|
+
* the first real consumer.
|
|
17
17
|
*/
|
|
18
|
-
/** Bump only when a reader could misinterpret the new shape
|
|
18
|
+
/** Bump only when a reader could misinterpret the new shape: same discipline every other canonical model's `schemaVersion` follows. */
|
|
19
19
|
export declare const LIFECYCLE_MODEL_SCHEMA_VERSION = 3;
|
|
20
20
|
/**
|
|
21
|
-
* One variable's computed NIST SP 800-53 IA-5 rotation
|
|
21
|
+
* One variable's computed NIST SP 800-53 IA-5 rotation status (a policy-window judgement):
|
|
22
22
|
* see `computeRotationStatus()` for exactly how it's derived. Always present
|
|
23
|
-
* on a `LifecycleModelVariable` (never `undefined`)
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
23
|
+
* on a `LifecycleModelVariable` (never `undefined`). A variable with nothing
|
|
24
|
+
* lifecycle-relevant set never reaches this model (`hasLifecycleData()`
|
|
25
|
+
* below). So `"undeclared"` is the honest value for "reached this model for
|
|
26
|
+
* another lifecycle reason (e.g. `deprecated`) but declares none of the four
|
|
27
|
+
* rotation-specific fields".
|
|
28
|
+
*
|
|
29
|
+
* This is a policy-window judgement from the declared metadata ("within the declared
|
|
30
|
+
* rotation period"). It never states that any control is met or that a rotation
|
|
31
|
+
* happened. env-cap never checks a declaration against reality. Renaming the value
|
|
32
|
+
* `"compliant"` would be a breaking change, so it can only happen in a major release.
|
|
28
33
|
*/
|
|
29
34
|
export type RotationComplianceStatus = "compliant" | "overdue" | "expired" | "undeclared";
|
|
30
35
|
/**
|
|
31
36
|
* One variable's lifecycle data (expiry, deprecation, rename correlation).
|
|
32
37
|
*
|
|
33
|
-
* @see {@link ContractModelVariable}
|
|
38
|
+
* @see {@link ContractModelVariable}: this same declared variable's canonical starting point.
|
|
34
39
|
*/
|
|
35
40
|
export interface LifecycleModelVariable {
|
|
36
41
|
readonly key: string;
|
|
@@ -39,9 +44,9 @@ export interface LifecycleModelVariable {
|
|
|
39
44
|
readonly deprecated: boolean | undefined;
|
|
40
45
|
readonly deprecatedReason: string | undefined;
|
|
41
46
|
readonly removeBy: string | undefined;
|
|
42
|
-
/** The previous variable name this one renames, if set
|
|
47
|
+
/** The previous variable name this one renames, if set: see `ManifestChangeReport`'s rename correlation (ADR 0029/0030). */
|
|
43
48
|
readonly renamedFrom: string | undefined;
|
|
44
|
-
/** Descriptive retention policy (e.g. "delete after 90 days")
|
|
49
|
+
/** Descriptive retention policy (e.g. "delete after 90 days"): a policy statement, never computed or parsed, deliberately independent of `expiresAt`'s actual temporal constraint. See ADR 0035. */
|
|
45
50
|
readonly retention: string | undefined;
|
|
46
51
|
/** See {@link runtime.VariableDocs.authenticatorType}. */
|
|
47
52
|
readonly authenticatorType: string | undefined;
|
|
@@ -51,12 +56,12 @@ export interface LifecycleModelVariable {
|
|
|
51
56
|
readonly lastRotatedAt: string | undefined;
|
|
52
57
|
/** See {@link runtime.VariableDocs.rotationTriggerEvents}. */
|
|
53
58
|
readonly rotationTriggerEvents: readonly string[] | undefined;
|
|
54
|
-
/** Computed, not stored
|
|
59
|
+
/** Computed, not stored: see {@link RotationComplianceStatus} and `computeRotationStatus()`. */
|
|
55
60
|
readonly rotationStatus: RotationComplianceStatus;
|
|
56
61
|
}
|
|
57
62
|
/** One contract's own lifecycle data plus every variable of its that has at least one lifecycle field set. See {@link LifecycleModelVariable} for the per-variable shape. */
|
|
58
63
|
export interface LifecycleModelContract {
|
|
59
|
-
/** Root-relative, POSIX-separated
|
|
64
|
+
/** Root-relative, POSIX-separated: matches `ContractModelContract.file`. */
|
|
60
65
|
readonly file: string;
|
|
61
66
|
readonly exportName: string;
|
|
62
67
|
readonly contractName: string;
|
|
@@ -65,22 +70,22 @@ export interface LifecycleModelContract {
|
|
|
65
70
|
readonly deprecatedReason: string | undefined;
|
|
66
71
|
/** See {@link LifecycleModelVariable.retention}. */
|
|
67
72
|
readonly retention: string | undefined;
|
|
68
|
-
/** Only variables with at least one lifecycle field set (`expiresAt`, `refreshInstructions`, `deprecated`, `removeBy`, `renamedFrom`, `retention`, `authenticatorType`, `rotationPeriod`, `lastRotatedAt`, `rotationTriggerEvents`)
|
|
73
|
+
/** Only variables with at least one lifecycle field set (`expiresAt`, `refreshInstructions`, `deprecated`, `removeBy`, `renamedFrom`, `retention`, `authenticatorType`, `rotationPeriod`, `lastRotatedAt`, `rotationTriggerEvents`). `renderLifecycleReport()` uses the same "only what's relevant" scope for its rows. */
|
|
69
74
|
readonly variables: readonly LifecycleModelVariable[];
|
|
70
75
|
}
|
|
71
|
-
/** The versioned, JSON-serializable root of the Lifecycle Model
|
|
76
|
+
/** The versioned, JSON-serializable root of the Lifecycle Model: see this module's own doc comment for the full picture. */
|
|
72
77
|
export interface LifecycleModel {
|
|
73
78
|
readonly schemaVersion: typeof LIFECYCLE_MODEL_SCHEMA_VERSION;
|
|
74
79
|
/** Only contracts with at least one lifecycle-relevant field set, at the contract level or on at least one variable. */
|
|
75
80
|
readonly contracts: readonly LifecycleModelContract[];
|
|
76
81
|
/**
|
|
77
82
|
* Every contract-/variable-level `expiresAt` within the configured window,
|
|
78
|
-
* soonest-first
|
|
79
|
-
* and POSIX-separated here, matching `LifecycleModelContract.file
|
|
80
|
-
* other canonical model
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
*
|
|
83
|
+
* soonest-first: see `computeExpiringEntries()`. `file` is root-relative
|
|
84
|
+
* and POSIX-separated here, matching `LifecycleModelContract.file` and
|
|
85
|
+
* every other canonical model. `ExpiringEntry`'s own doc comment describes
|
|
86
|
+
* a different case: `computeExpiringEntries()`'s other direct consumers
|
|
87
|
+
* (e.g. `DocumentationFindings.expiringSoon`). There `file` stays the
|
|
88
|
+
* absolute path `renderDocs()` itself expects.
|
|
84
89
|
*/
|
|
85
90
|
readonly expiring: readonly ExpiringEntry[];
|
|
86
91
|
}
|
|
@@ -90,73 +95,75 @@ export interface LifecycleModel {
|
|
|
90
95
|
*
|
|
91
96
|
* @remarks
|
|
92
97
|
* `rotationPeriod` is documented (`runtime/document.ts`) as an organization-defined string much
|
|
93
|
-
* like `retention
|
|
94
|
-
* `computeRotationStatus()`
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
98
|
+
* like `retention`. But `retention` is *never* parsed (a pure policy statement), while
|
|
99
|
+
* `computeRotationStatus()` needs a numeric due date to compare against `now`. This function is
|
|
100
|
+
* the one place that tension is resolved. It recognizes two small, common, unambiguous grammars
|
|
101
|
+
* and does not attempt to parse arbitrary prose ("quarterly", "every other release", ...):
|
|
102
|
+
*
|
|
103
|
+
* - a plain "<n> <unit>": singular/plural/abbreviated, case-insensitive, with or without a
|
|
104
|
+
* space, e.g. "90 days"/"90day"/"12weeks";
|
|
105
|
+
* - ISO 8601's calendar-duration form, date components only (`PnYnMnD`). There is no
|
|
106
|
+
* `T`/time-of-day component, since a rotation period is never meaningfully finer than a day.
|
|
107
|
+
* A bare `"P"` is not a duration.
|
|
108
|
+
*
|
|
109
|
+
* A policy string that fits neither grammar is still stored and rendered verbatim everywhere
|
|
110
|
+
* else. It just can't feed a computed due date, and `computeRotationStatus()` fails closed
|
|
111
|
+
* (`"overdue"`) rather than guessing at one. Month/year are calendar approximations (30/365 days).
|
|
112
|
+
* That is acceptable for a rotation-window signal, but not for anything billing/calendar-accurate.
|
|
105
113
|
*
|
|
106
|
-
* A computed total of zero days (e.g. "0 days", "P0D", "P0Y0M0D"
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
* policy should read as un-computable, not
|
|
112
|
-
* due date.
|
|
114
|
+
* A computed total of zero days (e.g. "0 days", "P0D", "P0Y0M0D") is treated the same as an
|
|
115
|
+
* unparseable string, not a real duration. The digit grammar can't produce a *negative* total,
|
|
116
|
+
* but zero is reachable. It returns `undefined` rather than `0`. `computeRotationStatus()` then
|
|
117
|
+
* takes its "declared but unverifiable" fail-closed path (`"overdue"`) instead of computing a
|
|
118
|
+
* degenerate due date equal to `lastRotatedAt` itself. A nonsensical "rotate every zero days"
|
|
119
|
+
* policy should read as un-computable, not produce a technically-correct-but-meaningless due date.
|
|
113
120
|
*
|
|
114
121
|
* Both patterns are inlined at their `.exec()` call site, deliberately not hoisted to a
|
|
115
|
-
* module-level `const`
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
* every call.
|
|
122
|
+
* module-level `const` (as in `source-position.ts`'s `parsePositionCitation()`). A module-level
|
|
123
|
+
* regex literal is a load-time-only ("static") mutation target. Stryker's `perTest` coverage
|
|
124
|
+
* analysis can't attribute it to a specific covering test (see `stryker.config.mjs`). An inline
|
|
125
|
+
* literal is re-evaluated, and so mutation-tested, on every call.
|
|
120
126
|
*/
|
|
121
127
|
export declare function parseRotationPeriodDays(value: string): number | undefined;
|
|
122
128
|
/**
|
|
123
|
-
* Computes one variable's NIST SP 800-53 IA-5 rotation
|
|
129
|
+
* Computes one variable's NIST SP 800-53 IA-5 rotation status (a policy-window judgement) from its lifecycle facts,
|
|
124
130
|
* relative to `now`.
|
|
125
131
|
*
|
|
126
132
|
* @remarks
|
|
127
|
-
* **The judgment call this function makes
|
|
128
|
-
*
|
|
129
|
-
* occur"
|
|
130
|
-
* `lastRotatedAt` pair
|
|
133
|
+
* **The judgment call this function makes.** IA-5's main statement only says "change or refresh
|
|
134
|
+
* authenticators [by an organization-defined period] or when [organization-defined events]
|
|
135
|
+
* occur". It doesn't define how a *pre-existing* `expiresAt` and a *new* `rotationPeriod`/
|
|
136
|
+
* `lastRotatedAt` pair interact when both are declared on the same variable. This function
|
|
137
|
+
* decides:
|
|
131
138
|
*
|
|
132
|
-
* - No rotation field declared at all (`hasRotationData()` false) -> `"undeclared"`. Not an error
|
|
133
|
-
*
|
|
139
|
+
* - No rotation field declared at all (`hasRotationData()` false) -> `"undeclared"`. Not an error.
|
|
140
|
+
* Most variables aren't authenticators. Saying nothing about rotation is the common, correct
|
|
134
141
|
* case, not a violation to report.
|
|
135
|
-
* - `expiresAt` is treated as authoritative and checked first, independent of everything else
|
|
136
|
-
* it's a valid date already in the past, the status is `"expired"`, full stop.
|
|
137
|
-
* is a pre-existing, often externally-imposed hard deadline (an API key's own
|
|
138
|
-
* expiry, a certificate's NotAfter)
|
|
139
|
-
* being valid
|
|
140
|
-
*
|
|
141
|
-
* - Otherwise, if `rotationPeriod` is declared, it's checked against `lastRotatedAt
|
|
142
|
-
* both parseable (see `parseRotationPeriodDays()`), *and* `lastRotatedAt` no
|
|
143
|
-
* compute `lastRotatedAt + rotationPeriod` and compare to `now
|
|
144
|
-
* passed, else `"compliant"
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
* on schedule
|
|
149
|
-
* non-compliant rather than silently passed as compliant.
|
|
150
|
-
* - Otherwise
|
|
151
|
-
* `rotationTriggerEvents`
|
|
152
|
-
*
|
|
142
|
+
* - `expiresAt` is treated as authoritative and checked first, independent of everything else. If
|
|
143
|
+
* it's a valid date already in the past, the status is `"expired"`, full stop. The reason:
|
|
144
|
+
* `expiresAt` is a pre-existing, often externally-imposed hard deadline (an API key's own
|
|
145
|
+
* issuer-enforced expiry, a certificate's NotAfter). Once that date passes, the value has
|
|
146
|
+
* *literally* stopped being valid. That is categorically worse than being overdue for an internal policy rotation,
|
|
147
|
+
* and no internal rotation record can retroactively un-expire it.
|
|
148
|
+
* - Otherwise, if `rotationPeriod` is declared, it's checked against `lastRotatedAt`. The good
|
|
149
|
+
* case: both present, both parseable (see `parseRotationPeriodDays()`), *and* `lastRotatedAt` no
|
|
150
|
+
* later than `now`. Then compute `lastRotatedAt + rotationPeriod` and compare to `now`. The
|
|
151
|
+
* status is `"overdue"` if that due date has passed, else `"compliant"`. Any other case with
|
|
152
|
+
* `rotationPeriod` declared fails closed to `"overdue"`. That covers `lastRotatedAt` missing,
|
|
153
|
+
* either value not statically parseable, or `lastRotatedAt` in the future. A future rotation
|
|
154
|
+
* can't have happened yet. Trusting it would let a bad timestamp manufacture false compliance. IA-5 asks for evidence a rotation
|
|
155
|
+
* happened on schedule. A declared obligation that can't be shown to have been met is reported
|
|
156
|
+
* as non-compliant rather than silently passed as compliant.
|
|
157
|
+
* - Otherwise -> `"compliant"`. Here rotation metadata is declared (`authenticatorType` and/or
|
|
158
|
+
* `lastRotatedAt` and/or `rotationTriggerEvents`), with no `rotationPeriod` and no past-due
|
|
159
|
+
* `expiresAt`. Nothing states a time-based obligation this variable could be failing to meet.
|
|
153
160
|
*
|
|
154
161
|
* `rotationTriggerEvents` (the event-based trigger) deliberately never changes the returned status
|
|
155
|
-
* by itself
|
|
156
|
-
*
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
*
|
|
162
|
+
* by itself. env-cap cannot observe whether a listed event (a suspected compromise, a personnel
|
|
163
|
+
* change, ...) actually occurred. Treating its mere presence as either compliant or overdue would
|
|
164
|
+
* fabricate a signal. It's presence-only evidence that the event-based half of IA-5's
|
|
165
|
+
* two-trigger model was at least *declared*. A generator should still surface it, but never fold
|
|
166
|
+
* it into this computed status.
|
|
160
167
|
*/
|
|
161
168
|
export declare function computeRotationStatus(variable: {
|
|
162
169
|
readonly expiresAt: string | undefined;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"lifecycle-model.d.ts","sourceRoot":"","sources":["../../../src/build/lifecycle-model.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAC9C,OAAO,KAAK,EAAE,kBAAkB,EAAsB,MAAM,WAAW,CAAA;AAEvE;;;;;;;;;;;;;;GAcG;AAEH,
|
|
1
|
+
{"version":3,"file":"lifecycle-model.d.ts","sourceRoot":"","sources":["../../../src/build/lifecycle-model.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAC9C,OAAO,KAAK,EAAE,kBAAkB,EAAsB,MAAM,WAAW,CAAA;AAEvE;;;;;;;;;;;;;;GAcG;AAEH,uIAAuI;AACvI,eAAO,MAAM,8BAA8B,IAAI,CAAA;AAE/C;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,wBAAwB,GAAG,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,YAAY,CAAA;AAEzF;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAA;IAChD,QAAQ,CAAC,UAAU,EAAE,OAAO,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,4HAA4H;IAC5H,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC,oMAAoM;IACpM,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,0DAA0D;IAC1D,QAAQ,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9C,uDAAuD;IACvD,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3C,sDAAsD;IACtD,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1C,8DAA8D;IAC9D,QAAQ,CAAC,qBAAqB,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAA;IAC7D,gGAAgG;IAChG,QAAQ,CAAC,cAAc,EAAE,wBAAwB,CAAA;CAClD;AAED,6KAA6K;AAC7K,MAAM,WAAW,sBAAsB;IACrC,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,UAAU,EAAE,OAAO,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7C,oDAAoD;IACpD,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,2TAA2T;IAC3T,QAAQ,CAAC,SAAS,EAAE,SAAS,sBAAsB,EAAE,CAAA;CACtD;AAED,4HAA4H;AAC5H,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,aAAa,EAAE,OAAO,8BAA8B,CAAA;IAC7D,wHAAwH;IACxH,QAAQ,CAAC,SAAS,EAAE,SAAS,sBAAsB,EAAE,CAAA;IACrD;;;;;;;;OAQG;IACH,QAAQ,CAAC,QAAQ,EAAE,SAAS,aAAa,EAAE,CAAA;CAC5C;AAoCD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CA8CzE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE;IACR,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9C,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3C,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1C,QAAQ,CAAC,qBAAqB,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAA;CAC9D,EACD,GAAG,EAAE,IAAI,GACR,wBAAwB,CA2B1B;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,SAAS,kBAAkB,EAAE,EACxC,kBAAkB,EAAE,MAAM,EAC1B,GAAG,EAAE,IAAI,EACT,IAAI,EAAE,MAAM,GACX,cAAc,CAoDhB"}
|
|
@@ -6,7 +6,7 @@ import type { SourcePosition } from "./source-position.js";
|
|
|
6
6
|
/** One schema variable, merged with its linked `documentEnv()` documentation (if any). */
|
|
7
7
|
/**
|
|
8
8
|
* One schema variable merged with its linked `documentEnv()` documentation. Its
|
|
9
|
-
* governance fields (`owner` .. `metadata`) are `EnvGovernanceFields
|
|
9
|
+
* governance fields (`owner` .. `metadata`) are `EnvGovernanceFields`:
|
|
10
10
|
* each an individual-variable override of the contract's own value, from the
|
|
11
11
|
* linked `documentEnv()` call's matching `variables` entry, or `undefined`.
|
|
12
12
|
*/
|
|
@@ -33,14 +33,14 @@ export interface DiscoveredVariable extends DiscoveredSchemaVariable, EnvGoverna
|
|
|
33
33
|
readonly deprecatedReason: string | undefined;
|
|
34
34
|
/** From the linked `documentEnv()` call's matching `variables` entry, if any. */
|
|
35
35
|
readonly removeBy: string | undefined;
|
|
36
|
-
/** From the linked `documentEnv()` call's matching `variables` entry, if any
|
|
36
|
+
/** From the linked `documentEnv()` call's matching `variables` entry, if any. The previous variable name this one renames, if this declaration is the result of a rename. */
|
|
37
37
|
readonly renamedFrom: string | undefined;
|
|
38
|
-
/** The linked `documentEnv()` entry's `evidence` sub-object
|
|
38
|
+
/** The linked `documentEnv()` entry's `evidence` sub-object: the re-verified-every-run half of this variable's documentation, deliberately not flattened in alongside the declared-only fields above. See {@link runtime.VariableEvidenceDocs} and ADR 0037. */
|
|
39
39
|
readonly evidence: DiscoveredVariableEvidence | undefined;
|
|
40
40
|
/** Whether this specific key had a matching entry in the linked `documentEnv()` call, if any. */
|
|
41
41
|
readonly documented: boolean;
|
|
42
42
|
}
|
|
43
|
-
/** One `createEnv()` contract, merged with its linked `documentEnv()` documentation (if any). Its governance fields (`owner` .. `metadata`) are `EnvGovernanceFields
|
|
43
|
+
/** One `createEnv()` contract, merged with its linked `documentEnv()` documentation (if any). Its governance fields (`owner` .. `metadata`) are `EnvGovernanceFields`: contract-level defaults that individual variables may override. */
|
|
44
44
|
export interface DiscoveredContract extends EnvGovernanceFields {
|
|
45
45
|
/** Absolute path of the file declaring the `createEnv()` call. */
|
|
46
46
|
readonly file: string;
|
|
@@ -52,7 +52,7 @@ export interface DiscoveredContract extends EnvGovernanceFields {
|
|
|
52
52
|
readonly active: boolean;
|
|
53
53
|
/** From the linked `documentEnv()` call, if any. */
|
|
54
54
|
readonly category: string | undefined;
|
|
55
|
-
/** From the linked `documentEnv()` call, if any
|
|
55
|
+
/** From the linked `documentEnv()` call, if any: see {@link runtime.ContractDocs.exclusiveGroup}. */
|
|
56
56
|
readonly exclusiveGroup: string | undefined;
|
|
57
57
|
/** From the linked `documentEnv()` call, if any. */
|
|
58
58
|
readonly deprecated: boolean | undefined;
|
|
@@ -63,11 +63,11 @@ export interface DiscoveredContract extends EnvGovernanceFields {
|
|
|
63
63
|
/** Whether *any* `documentEnv()` call is linked to this contract at all. */
|
|
64
64
|
readonly documented: boolean;
|
|
65
65
|
/** Set when this contract was discovered via an allow-listed package's
|
|
66
|
-
* declared schema entry point rather than local discovery
|
|
67
|
-
* package name `renderManifest()`
|
|
68
|
-
*
|
|
66
|
+
* declared schema entry point rather than local discovery. It is the bare
|
|
67
|
+
* package name `renderManifest()` imports from. A relative path to the
|
|
68
|
+
* (analysis-only) resolved file would be wrong. See ADR 0014. */
|
|
69
69
|
readonly packageOrigin: PackageOrigin | undefined;
|
|
70
|
-
/** Where this contract's `createEnv(...)` call is declared. Always present
|
|
70
|
+
/** Where this contract's `createEnv(...)` call is declared. Always present: every discovered contract has one, by definition. See ADR 0036. */
|
|
71
71
|
readonly declaration: SourcePosition;
|
|
72
72
|
/** Where this contract's `documentEnv(...)` call is declared, if one exists. Undefined for a contract that's never been documented. See ADR 0036. */
|
|
73
73
|
readonly documentation: SourcePosition | undefined;
|
|
@@ -115,24 +115,24 @@ export interface LinkResult {
|
|
|
115
115
|
}
|
|
116
116
|
/**
|
|
117
117
|
* Parses every discovered file, then resolves and links `createEnv`/
|
|
118
|
-
* `documentEnv` calls into the merged, docs-enriched contract shape
|
|
119
|
-
* of the generator (`compatibility.ts`,
|
|
120
|
-
* `docs.ts`, `env-example.ts`)
|
|
118
|
+
* `documentEnv` calls into the merged, docs-enriched contract shape. The
|
|
119
|
+
* rest of the generator consumes that shape (`compatibility.ts`,
|
|
120
|
+
* `exclusive-group.ts`, `manifest.ts`, `docs.ts`, `env-example.ts`).
|
|
121
121
|
*
|
|
122
122
|
* @remarks
|
|
123
|
-
* Cross-file linking is deliberately narrow (see `resolveImportSpecifier`)
|
|
124
|
-
*
|
|
125
|
-
* its own file
|
|
126
|
-
* `const
|
|
127
|
-
* entry point. Anything else
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
123
|
+
* Cross-file linking is deliberately narrow (see `resolveImportSpecifier`).
|
|
124
|
+
* A `documentEnv()` call's schema reference resolves to one of three things.
|
|
125
|
+
* The first is a `const` in its own file. The second is a directly-imported
|
|
126
|
+
* named export of another file's `const`. The third is an allow-listed
|
|
127
|
+
* package's declared schema entry point (ADR 0014). Anything else becomes an `unresolvedLinks` entry, not a throw
|
|
128
|
+
* or a guess. Examples: a re-export barrel, a namespace import, an unlisted
|
|
129
|
+
* bare package specifier. Every other static-analysis boundary in this codebase
|
|
130
|
+
* does the same.
|
|
131
131
|
*
|
|
132
132
|
* `packageOrigins` (from `resolveAllowlistedPackages()`) tags any discovered
|
|
133
133
|
* contract whose `file` matches a package-resolved path with that package's
|
|
134
|
-
* origin
|
|
135
|
-
* files (
|
|
134
|
+
* origin. It is purely a lookup. `discoveredFiles` must already include
|
|
135
|
+
* those files (the caller merges them in via `mergeLocalAndPackageFiles()`).
|
|
136
136
|
*
|
|
137
137
|
* @param context - See `ImportResolutionContext`; drives how a resolved import specifier maps back to a file on disk.
|
|
138
138
|
*/
|
|
@@ -166,55 +166,54 @@ export declare function summarizeContract(contract: DiscoveredContract, root: st
|
|
|
166
166
|
* variable itself doesn't set one.
|
|
167
167
|
*
|
|
168
168
|
* @remarks
|
|
169
|
-
* The one place this resolution rule should live
|
|
170
|
-
* caller that needs "who owns this variable"
|
|
171
|
-
*
|
|
172
|
-
*
|
|
173
|
-
*
|
|
174
|
-
*
|
|
175
|
-
* `usage-report.ts` once did.
|
|
169
|
+
* The one place this resolution rule should live: see ADR 0028. Every
|
|
170
|
+
* caller that needs "who owns this variable" must go through this, not
|
|
171
|
+
* `variable.owner` or `contract.owner` alone. Those callers are the docs
|
|
172
|
+
* Catalog, ownership matrix and security review, and the usage report's
|
|
173
|
+
* variable-level ownership findings (ADR 0028). One rule means two call
|
|
174
|
+
* sites can never disagree about who owns a variable.
|
|
176
175
|
*
|
|
177
|
-
* Structurally typed (not pinned to `DiscoveredContract`/`DiscoveredVariable`)
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
*
|
|
176
|
+
* Structurally typed (not pinned to `DiscoveredContract`/`DiscoveredVariable`).
|
|
177
|
+
* So the same rule also serves `ContractModelContract`/`ContractModelVariable`
|
|
178
|
+
* (`contract-model.ts`). Both shapes carry the same field, and this rule must
|
|
179
|
+
* never have two independent implementations.
|
|
181
180
|
*/
|
|
182
181
|
export declare function effectiveOwner(contract: {
|
|
183
182
|
readonly owner: string | undefined;
|
|
184
183
|
}, variable: {
|
|
185
184
|
readonly owner: string | undefined;
|
|
186
185
|
}): string | undefined;
|
|
187
|
-
/** A variable's sensitivity, falling back to its contract's default
|
|
186
|
+
/** A variable's sensitivity, falling back to its contract's default: see {@link effectiveOwner}. */
|
|
188
187
|
export declare function effectiveSensitivity(contract: {
|
|
189
188
|
readonly sensitivity: string | undefined;
|
|
190
189
|
}, variable: {
|
|
191
190
|
readonly sensitivity: string | undefined;
|
|
192
191
|
}): string | undefined;
|
|
193
|
-
/** A variable's purpose, falling back to its contract's default
|
|
192
|
+
/** A variable's purpose, falling back to its contract's default: see {@link effectiveOwner}. */
|
|
194
193
|
export declare function effectivePurpose(contract: {
|
|
195
194
|
readonly purpose: string | undefined;
|
|
196
195
|
}, variable: {
|
|
197
196
|
readonly purpose: string | undefined;
|
|
198
197
|
}): string | undefined;
|
|
199
|
-
/** A variable's legal basis, falling back to its contract's default
|
|
198
|
+
/** A variable's legal basis, falling back to its contract's default: see {@link effectiveOwner}. */
|
|
200
199
|
export declare function effectiveLegalBasis(contract: {
|
|
201
200
|
readonly legalBasis: string | undefined;
|
|
202
201
|
}, variable: {
|
|
203
202
|
readonly legalBasis: string | undefined;
|
|
204
203
|
}): string | undefined;
|
|
205
|
-
/** A variable's retention policy, falling back to its contract's default
|
|
204
|
+
/** A variable's retention policy, falling back to its contract's default: see {@link effectiveOwner}. */
|
|
206
205
|
export declare function effectiveRetention(contract: {
|
|
207
206
|
readonly retention: string | undefined;
|
|
208
207
|
}, variable: {
|
|
209
208
|
readonly retention: string | undefined;
|
|
210
209
|
}): string | undefined;
|
|
211
|
-
/** A variable's data residency, falling back to its contract's default
|
|
210
|
+
/** A variable's data residency, falling back to its contract's default: see {@link effectiveOwner}. */
|
|
212
211
|
export declare function effectiveDataResidency(contract: {
|
|
213
212
|
readonly dataResidency: string | readonly string[] | undefined;
|
|
214
213
|
}, variable: {
|
|
215
214
|
readonly dataResidency: string | readonly string[] | undefined;
|
|
216
215
|
}): string | readonly string[] | undefined;
|
|
217
|
-
/** A variable's audit-required assertion, falling back to its contract's default
|
|
216
|
+
/** A variable's audit-required assertion, falling back to its contract's default: see {@link effectiveOwner}. */
|
|
218
217
|
export declare function effectiveAuditRequired(contract: {
|
|
219
218
|
readonly auditRequired: boolean | undefined;
|
|
220
219
|
}, variable: {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"link.d.ts","sourceRoot":"","sources":["../../../src/build/link.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAG1B,YAAY,EAEb,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAIjE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAA;AAC7E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAA;AAE3E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D,0FAA0F;AAC1F;;;;;GAKG;AACH,MAAM,WAAW,kBAAmB,SAAQ,wBAAwB,EAAE,mBAAmB;IACvF,iFAAiF;IACjF,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC,iFAAiF;IACjF,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAA;IAChD,iFAAiF;IACjF,QAAQ,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9C,iFAAiF;IACjF,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3C,iFAAiF;IACjF,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1C,iFAAiF;IACjF,QAAQ,CAAC,qBAAqB,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAA;IAC7D,iFAAiF;IACjF,QAAQ,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9C,iFAAiF;IACjF,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,iFAAiF;IACjF,QAAQ,CAAC,UAAU,EAAE,OAAO,GAAG,SAAS,CAAA;IACxC,iFAAiF;IACjF,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7C,iFAAiF;IACjF,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC
|
|
1
|
+
{"version":3,"file":"link.d.ts","sourceRoot":"","sources":["../../../src/build/link.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAG1B,YAAY,EAEb,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAIjE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAA;AAC7E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAA;AAE3E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D,0FAA0F;AAC1F;;;;;GAKG;AACH,MAAM,WAAW,kBAAmB,SAAQ,wBAAwB,EAAE,mBAAmB;IACvF,iFAAiF;IACjF,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC,iFAAiF;IACjF,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAA;IAChD,iFAAiF;IACjF,QAAQ,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9C,iFAAiF;IACjF,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3C,iFAAiF;IACjF,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1C,iFAAiF;IACjF,QAAQ,CAAC,qBAAqB,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAA;IAC7D,iFAAiF;IACjF,QAAQ,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9C,iFAAiF;IACjF,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,iFAAiF;IACjF,QAAQ,CAAC,UAAU,EAAE,OAAO,GAAG,SAAS,CAAA;IACxC,iFAAiF;IACjF,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7C,iFAAiF;IACjF,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,6KAA6K;IAC7K,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC,gQAAgQ;IAChQ,QAAQ,CAAC,QAAQ,EAAE,0BAA0B,GAAG,SAAS,CAAA;IACzD,iGAAiG;IACjG,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAA;CAG7B;AAED,0OAA0O;AAC1O,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,kEAAkE;IAClE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,gEAAgE;IAChE,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,yHAAyH;IACzH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,0GAA0G;IAC1G,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;IACxB,oDAAoD;IACpD,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,qGAAqG;IACrG,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3C,oDAAoD;IACpD,QAAQ,CAAC,UAAU,EAAE,OAAO,GAAG,SAAS,CAAA;IACxC,oDAAoD;IACpD,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7C,mFAAmF;IACnF,QAAQ,CAAC,SAAS,EAAE,SAAS,kBAAkB,EAAE,CAAA;IACjD,4EAA4E;IAC5E,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAA;IAC5B;;;sEAGkE;IAClE,QAAQ,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,CAAA;IACjD,+IAA+I;IAC/I,QAAQ,CAAC,WAAW,EAAE,cAAc,CAAA;IACpC,qJAAqJ;IACrJ,QAAQ,CAAC,aAAa,EAAE,cAAc,GAAG,SAAS,CAAA;CACnD;AAED,iGAAiG;AACjG,MAAM,WAAW,cAAc;IAC7B,gEAAgE;IAChE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,uEAAuE;IACvE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB;AAED,0HAA0H;AAC1H,MAAM,WAAW,UAAU;IACzB,yEAAyE;IACzE,QAAQ,CAAC,SAAS,EAAE,SAAS,kBAAkB,EAAE,CAAA;IACjD,gEAAgE;IAChE,QAAQ,CAAC,QAAQ,EAAE,SAAS,YAAY,EAAE,CAAA;IAC1C,4EAA4E;IAC5E,QAAQ,CAAC,eAAe,EAAE,SAAS,cAAc,EAAE,CAAA;IACnD,4DAA4D;IAC5D,QAAQ,CAAC,qBAAqB,EAAE,SAAS;QACvC,wDAAwD;QACxD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,4CAA4C;QAC5C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;KAC5B,EAAE,CAAA;IACH,wFAAwF;IACxF,QAAQ,CAAC,qBAAqB,EAAE,SAAS;QACvC,wDAAwD;QACxD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,4CAA4C;QAC5C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;QAC3B,kDAAkD;QAClD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;KACrB,EAAE,CAAA;IACH,4GAA4G;IAC5G,QAAQ,CAAC,eAAe,EAAE,SAAS;QACjC,wDAAwD;QACxD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,4CAA4C;QAC5C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;QAC3B,0CAA0C;QAC1C,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;KACrB,EAAE,CAAA;CACJ;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,SAAS,CAC7B,eAAe,EAAE,SAAS,MAAM,EAAE,EAClC,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,EAC/C,OAAO,EAAE,uBAAuB,EAChC,cAAc,GAAE,WAAW,CAAC,MAAM,EAAE,aAAa,CAAa,GAC7D,OAAO,CAAC,UAAU,CAAC,CAyQrB;AAED,0IAA0I;AAC1I,MAAM,WAAW,yBAAyB;IACxC,gDAAgD;IAChD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,gEAAgE;IAChE,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,2EAA2E;IAC3E,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,8DAA8D;IAC9D,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,gGAAgG;IAChG,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;IACxB,iEAAiE;IACjE,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAA;CAC7B;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,kBAAkB,EAC5B,IAAI,EAAE,MAAM,GACX,yBAAyB,CAS3B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,EAChD,QAAQ,EAAE;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAC/C,MAAM,GAAG,SAAS,CAEpB;AAED,oGAAoG;AACpG,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE;IAAE,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,EACtD,QAAQ,EAAE;IAAE,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GACrD,MAAM,GAAG,SAAS,CAEpB;AAED,gGAAgG;AAChG,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE;IAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,EAClD,QAAQ,EAAE;IAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GACjD,MAAM,GAAG,SAAS,CAEpB;AAED,oGAAoG;AACpG,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE;IAAE,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,EACrD,QAAQ,EAAE;IAAE,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GACpD,MAAM,GAAG,SAAS,CAEpB;AAED,yGAAyG;AACzG,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE;IAAE,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,EACpD,QAAQ,EAAE;IAAE,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GACnD,MAAM,GAAG,SAAS,CAEpB;AAED,uGAAuG;AACvG,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE;IAAE,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,GAAG,SAAS,CAAA;CAAE,EAC5E,QAAQ,EAAE;IAAE,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,GAAG,SAAS,CAAA;CAAE,GAC3E,MAAM,GAAG,SAAS,MAAM,EAAE,GAAG,SAAS,CAExC;AAED,iHAAiH;AACjH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE;IAAE,QAAQ,CAAC,aAAa,EAAE,OAAO,GAAG,SAAS,CAAA;CAAE,EACzD,QAAQ,EAAE;IAAE,QAAQ,CAAC,aAAa,EAAE,OAAO,GAAG,SAAS,CAAA;CAAE,GACxD,OAAO,GAAG,SAAS,CAErB"}
|
|
@@ -12,13 +12,13 @@ export type LiteralEvalResult = {
|
|
|
12
12
|
};
|
|
13
13
|
/**
|
|
14
14
|
* Structurally evaluates a *literal* AST expression (strings, numbers, booleans, null, arrays,
|
|
15
|
-
* and object literals of the same) into a real JS value
|
|
15
|
+
* and object literals of the same) into a real JS value: without ever executing code.
|
|
16
16
|
*
|
|
17
17
|
* @remarks
|
|
18
18
|
* Anything that isn't a literal (identifiers, calls, imports, template expressions with
|
|
19
19
|
* interpolation) resolves to `{ ok: false }` rather than being guessed at.
|
|
20
20
|
*/
|
|
21
21
|
export declare function evaluateLiteral(node: TS.Expression): LiteralEvalResult;
|
|
22
|
-
/** Reads a property name statically (identifier, string literal, or numeric literal)
|
|
22
|
+
/** Reads a property name statically (identifier, string literal, or numeric literal): a computed key (e.g. `[expr]`) resolves to `undefined` rather than being guessed at. */
|
|
23
23
|
export declare function getStaticPropertyName(name: TS.PropertyName): string | undefined;
|
|
24
24
|
//# sourceMappingURL=literal-eval.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"literal-eval.d.ts","sourceRoot":"","sources":["../../../src/build/literal-eval.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,YAAY,CAAA;AAEhC;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,CAAA;AAE/F;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,GAAG,iBAAiB,CA4CtE;AAED,
|
|
1
|
+
{"version":3,"file":"literal-eval.d.ts","sourceRoot":"","sources":["../../../src/build/literal-eval.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,YAAY,CAAA;AAEhC;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,CAAA;AAE/F;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,GAAG,iBAAiB,CA4CtE;AAED,8KAA8K;AAC9K,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,GAAG,MAAM,GAAG,SAAS,CAK/E"}
|