@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.
Files changed (353) hide show
  1. package/ADOPTION.md +106 -124
  2. package/AGENTS.md +94 -128
  3. package/CHANGELOG.md +42 -0
  4. package/CODE_REVIEW.md +69 -173
  5. package/CONTRIBUTING.md +57 -74
  6. package/GUIDE.md +405 -866
  7. package/README.md +112 -89
  8. package/RELEASING.md +81 -65
  9. package/SECURITY.md +76 -227
  10. package/SUPPORT.md +21 -45
  11. package/VERSIONING.md +69 -105
  12. package/benchmarks/READING-BENCHMARKS.md +103 -81
  13. package/benchmarks/README.md +12 -9
  14. package/benchmarks/WRITING-BENCHMARKS.md +90 -80
  15. package/benchmarks/performance-buildtime/BENCHMARKS.md +20 -20
  16. package/benchmarks/performance-runtime/BENCHMARKS.md +107 -107
  17. package/dist/.dts/_ipc/build-fs.d.ts +12 -17
  18. package/dist/.dts/_ipc/build-fs.d.ts.map +1 -1
  19. package/dist/.dts/_ipc/compiler-api.d.ts +6 -6
  20. package/dist/.dts/_ipc/display-path.d.ts +1 -1
  21. package/dist/.dts/_ipc/display-path.d.ts.map +1 -1
  22. package/dist/.dts/_ipc/generated-banner.d.ts +8 -8
  23. package/dist/.dts/_ipc/glob.d.ts +9 -8
  24. package/dist/.dts/_ipc/glob.d.ts.map +1 -1
  25. package/dist/.dts/_ipc/no-node-fs.d.ts +2 -2
  26. package/dist/.dts/_ipc/no-node-fs.d.ts.map +1 -1
  27. package/dist/.dts/_ipc/resolve-tsconfig-paths.d.ts +16 -16
  28. package/dist/.dts/_ipc/resolve-tsconfig-paths.d.ts.map +1 -1
  29. package/dist/.dts/_ipc/typescript.d.ts +4 -4
  30. package/dist/.dts/build/assemble-project.d.ts +14 -15
  31. package/dist/.dts/build/assemble-project.d.ts.map +1 -1
  32. package/dist/.dts/build/change-model.d.ts +14 -14
  33. package/dist/.dts/build/change-model.d.ts.map +1 -1
  34. package/dist/.dts/build/check-artifacts.d.ts +4 -4
  35. package/dist/.dts/build/check-artifacts.d.ts.map +1 -1
  36. package/dist/.dts/build/citation-verification.d.ts +13 -14
  37. package/dist/.dts/build/citation-verification.d.ts.map +1 -1
  38. package/dist/.dts/build/compatibility.d.ts +24 -24
  39. package/dist/.dts/build/compatibility.d.ts.map +1 -1
  40. package/dist/.dts/build/contract-model.d.ts +10 -10
  41. package/dist/.dts/build/contract-model.d.ts.map +1 -1
  42. package/dist/.dts/build/deep-equal.d.ts +2 -2
  43. package/dist/.dts/build/deep-freeze.d.ts +2 -2
  44. package/dist/.dts/build/dependency-graph.d.ts +48 -55
  45. package/dist/.dts/build/dependency-graph.d.ts.map +1 -1
  46. package/dist/.dts/build/dependency-model.d.ts +18 -18
  47. package/dist/.dts/build/dependency-model.d.ts.map +1 -1
  48. package/dist/.dts/build/discover.d.ts +11 -11
  49. package/dist/.dts/build/discover.d.ts.map +1 -1
  50. package/dist/.dts/build/docs.d.ts +34 -38
  51. package/dist/.dts/build/docs.d.ts.map +1 -1
  52. package/dist/.dts/build/env-example.d.ts +13 -13
  53. package/dist/.dts/build/env-example.d.ts.map +1 -1
  54. package/dist/.dts/build/errors.d.ts +8 -8
  55. package/dist/.dts/build/evidence-cache.d.ts +23 -23
  56. package/dist/.dts/build/evidence-cache.d.ts.map +1 -1
  57. package/dist/.dts/build/evidence-model.d.ts +3 -3
  58. package/dist/.dts/build/evidence-reference.d.ts +15 -15
  59. package/dist/.dts/build/evidence-reference.d.ts.map +1 -1
  60. package/dist/.dts/build/evidence-snapshot.d.ts +47 -53
  61. package/dist/.dts/build/evidence-snapshot.d.ts.map +1 -1
  62. package/dist/.dts/build/exclusive-group.d.ts +4 -4
  63. package/dist/.dts/build/exclusive-group.d.ts.map +1 -1
  64. package/dist/.dts/build/finding-model.d.ts +12 -12
  65. package/dist/.dts/build/finding-model.d.ts.map +1 -1
  66. package/dist/.dts/build/generate-documentation.d.ts +19 -19
  67. package/dist/.dts/build/generate-documentation.d.ts.map +1 -1
  68. package/dist/.dts/build/generate-env-artifacts.d.ts +43 -43
  69. package/dist/.dts/build/generate-env-artifacts.d.ts.map +1 -1
  70. package/dist/.dts/build/generate-evidence.d.ts +19 -19
  71. package/dist/.dts/build/generate-evidence.d.ts.map +1 -1
  72. package/dist/.dts/build/generate-manifest.d.ts +11 -12
  73. package/dist/.dts/build/generate-manifest.d.ts.map +1 -1
  74. package/dist/.dts/build/generate-usage.d.ts +23 -24
  75. package/dist/.dts/build/generate-usage.d.ts.map +1 -1
  76. package/dist/.dts/build/generated-banner.d.ts +5 -5
  77. package/dist/.dts/build/governance-fields.d.ts +7 -7
  78. package/dist/.dts/build/humanize-key.d.ts +1 -1
  79. package/dist/.dts/build/humanize-key.d.ts.map +1 -1
  80. package/dist/.dts/build/index.d.ts +20 -36
  81. package/dist/.dts/build/index.d.ts.map +1 -1
  82. package/dist/.dts/build/lifecycle-model.d.ts +90 -83
  83. package/dist/.dts/build/lifecycle-model.d.ts.map +1 -1
  84. package/dist/.dts/build/link.d.ts +38 -39
  85. package/dist/.dts/build/link.d.ts.map +1 -1
  86. package/dist/.dts/build/literal-eval.d.ts +2 -2
  87. package/dist/.dts/build/literal-eval.d.ts.map +1 -1
  88. package/dist/.dts/build/live-expirations.d.ts +14 -13
  89. package/dist/.dts/build/live-expirations.d.ts.map +1 -1
  90. package/dist/.dts/build/manifest.d.ts +6 -6
  91. package/dist/.dts/build/map-utils.d.ts +4 -4
  92. package/dist/.dts/build/merge-documentation.d.ts +9 -8
  93. package/dist/.dts/build/merge-documentation.d.ts.map +1 -1
  94. package/dist/.dts/build/ownership-model.d.ts +14 -15
  95. package/dist/.dts/build/ownership-model.d.ts.map +1 -1
  96. package/dist/.dts/build/parse.d.ts +20 -21
  97. package/dist/.dts/build/parse.d.ts.map +1 -1
  98. package/dist/.dts/build/reference-projections.d.ts +36 -38
  99. package/dist/.dts/build/reference-projections.d.ts.map +1 -1
  100. package/dist/.dts/build/resolution/resolve-import.d.ts +18 -14
  101. package/dist/.dts/build/resolution/resolve-import.d.ts.map +1 -1
  102. package/dist/.dts/build/resolution/resolve-package-schema.d.ts +26 -26
  103. package/dist/.dts/build/resolution/resolve-package-schema.d.ts.map +1 -1
  104. package/dist/.dts/build/resolution/resolve-within-root.d.ts +9 -9
  105. package/dist/.dts/build/sarif.d.ts +5 -5
  106. package/dist/.dts/build/sarif.d.ts.map +1 -1
  107. package/dist/.dts/build/scan-dependencies.d.ts +17 -16
  108. package/dist/.dts/build/scan-dependencies.d.ts.map +1 -1
  109. package/dist/.dts/build/sort-by-identity.d.ts +1 -1
  110. package/dist/.dts/build/source-position.d.ts +13 -13
  111. package/dist/.dts/build/tool-version.d.ts +1 -1
  112. package/dist/.dts/build/usage-report.d.ts +19 -19
  113. package/dist/.dts/build/usage-report.d.ts.map +1 -1
  114. package/dist/.dts/eslint-plugin/index.d.ts +16 -5
  115. package/dist/.dts/eslint-plugin/index.d.ts.map +1 -1
  116. package/dist/.dts/eslint-plugin/no-raw-process-env.d.ts +4 -4
  117. package/dist/.dts/evidence/define-projection.d.ts +15 -16
  118. package/dist/.dts/evidence/define-projection.d.ts.map +1 -1
  119. package/dist/.dts/evidence/index.d.ts +11 -15
  120. package/dist/.dts/evidence/index.d.ts.map +1 -1
  121. package/dist/.dts/helpers/index.d.ts +15 -18
  122. package/dist/.dts/helpers/index.d.ts.map +1 -1
  123. package/dist/.dts/helpers/validators.d.ts +2 -2
  124. package/dist/.dts/helpers/validators.d.ts.map +1 -1
  125. package/dist/.dts/node/index.d.ts +19 -0
  126. package/dist/.dts/node/index.d.ts.map +1 -1
  127. package/dist/.dts/runtime/create.d.ts +6 -3
  128. package/dist/.dts/runtime/create.d.ts.map +1 -1
  129. package/dist/.dts/runtime/document.d.ts +91 -97
  130. package/dist/.dts/runtime/document.d.ts.map +1 -1
  131. package/dist/.dts/runtime/errors.d.ts +5 -5
  132. package/dist/.dts/runtime/index.d.ts +11 -10
  133. package/dist/.dts/runtime/index.d.ts.map +1 -1
  134. package/dist/.dts/runtime/reset.d.ts +1 -1
  135. package/dist/.dts/runtime/types.d.ts +39 -24
  136. package/dist/.dts/runtime/types.d.ts.map +1 -1
  137. package/dist/.dts/runtime/validate.d.ts +15 -2
  138. package/dist/.dts/runtime/validate.d.ts.map +1 -1
  139. package/dist/.dts7/_ipc/build-fs.d.ts +48 -0
  140. package/dist/.dts7/_ipc/build-fs.d.ts.map +1 -0
  141. package/dist/.dts7/_ipc/compiler-api.d.ts +17 -0
  142. package/dist/.dts7/_ipc/compiler-api.d.ts.map +1 -0
  143. package/dist/.dts7/_ipc/display-path.d.ts +27 -0
  144. package/dist/.dts7/_ipc/display-path.d.ts.map +1 -0
  145. package/dist/.dts7/_ipc/generated-banner.d.ts +58 -0
  146. package/dist/.dts7/_ipc/generated-banner.d.ts.map +1 -0
  147. package/dist/.dts7/_ipc/glob.d.ts +23 -0
  148. package/dist/.dts7/_ipc/glob.d.ts.map +1 -0
  149. package/dist/.dts7/_ipc/no-node-fs.d.ts +21 -0
  150. package/dist/.dts7/_ipc/no-node-fs.d.ts.map +1 -0
  151. package/dist/.dts7/_ipc/resolve-tsconfig-paths.d.ts +134 -0
  152. package/dist/.dts7/_ipc/resolve-tsconfig-paths.d.ts.map +1 -0
  153. package/dist/.dts7/_ipc/typescript.d.ts +20 -0
  154. package/dist/.dts7/_ipc/typescript.d.ts.map +1 -0
  155. package/dist/.dts7/build/assemble-project.d.ts +46 -0
  156. package/dist/.dts7/build/assemble-project.d.ts.map +1 -0
  157. package/dist/.dts7/build/change-model.d.ts +63 -0
  158. package/dist/.dts7/build/change-model.d.ts.map +1 -0
  159. package/dist/.dts7/build/check-artifacts.d.ts +48 -0
  160. package/dist/.dts7/build/check-artifacts.d.ts.map +1 -0
  161. package/dist/.dts7/build/citation-verification.d.ts +61 -0
  162. package/dist/.dts7/build/citation-verification.d.ts.map +1 -0
  163. package/dist/.dts7/build/compatibility.d.ts +83 -0
  164. package/dist/.dts7/build/compatibility.d.ts.map +1 -0
  165. package/dist/.dts7/build/compiler-api.d.ts +12 -0
  166. package/dist/.dts7/build/compiler-api.d.ts.map +1 -0
  167. package/dist/.dts7/build/contract-model.d.ts +93 -0
  168. package/dist/.dts7/build/contract-model.d.ts.map +1 -0
  169. package/dist/.dts7/build/deep-equal.d.ts +9 -0
  170. package/dist/.dts7/build/deep-equal.d.ts.map +1 -0
  171. package/dist/.dts7/build/deep-freeze.d.ts +20 -0
  172. package/dist/.dts7/build/deep-freeze.d.ts.map +1 -0
  173. package/dist/.dts7/build/dependency-graph.d.ts +163 -0
  174. package/dist/.dts7/build/dependency-graph.d.ts.map +1 -0
  175. package/dist/.dts7/build/dependency-model.d.ts +81 -0
  176. package/dist/.dts7/build/dependency-model.d.ts.map +1 -0
  177. package/dist/.dts7/build/discover.d.ts +41 -0
  178. package/dist/.dts7/build/discover.d.ts.map +1 -0
  179. package/dist/.dts7/build/display-path.d.ts +6 -0
  180. package/dist/.dts7/build/display-path.d.ts.map +1 -0
  181. package/dist/.dts7/build/docs.d.ts +172 -0
  182. package/dist/.dts7/build/docs.d.ts.map +1 -0
  183. package/dist/.dts7/build/env-example.d.ts +85 -0
  184. package/dist/.dts7/build/env-example.d.ts.map +1 -0
  185. package/dist/.dts7/build/errors.d.ts +78 -0
  186. package/dist/.dts7/build/errors.d.ts.map +1 -0
  187. package/dist/.dts7/build/evidence-cache.d.ts +74 -0
  188. package/dist/.dts7/build/evidence-cache.d.ts.map +1 -0
  189. package/dist/.dts7/build/evidence-model.d.ts +50 -0
  190. package/dist/.dts7/build/evidence-model.d.ts.map +1 -0
  191. package/dist/.dts7/build/evidence-reference.d.ts +67 -0
  192. package/dist/.dts7/build/evidence-reference.d.ts.map +1 -0
  193. package/dist/.dts7/build/evidence-snapshot.d.ts +142 -0
  194. package/dist/.dts7/build/evidence-snapshot.d.ts.map +1 -0
  195. package/dist/.dts7/build/exclusive-group.d.ts +19 -0
  196. package/dist/.dts7/build/exclusive-group.d.ts.map +1 -0
  197. package/dist/.dts7/build/finding-model.d.ts +80 -0
  198. package/dist/.dts7/build/finding-model.d.ts.map +1 -0
  199. package/dist/.dts7/build/generate-documentation.d.ts +176 -0
  200. package/dist/.dts7/build/generate-documentation.d.ts.map +1 -0
  201. package/dist/.dts7/build/generate-env-artifacts.d.ts +191 -0
  202. package/dist/.dts7/build/generate-env-artifacts.d.ts.map +1 -0
  203. package/dist/.dts7/build/generate-evidence.d.ts +77 -0
  204. package/dist/.dts7/build/generate-evidence.d.ts.map +1 -0
  205. package/dist/.dts7/build/generate-manifest.d.ts +100 -0
  206. package/dist/.dts7/build/generate-manifest.d.ts.map +1 -0
  207. package/dist/.dts7/build/generate-usage.d.ts +94 -0
  208. package/dist/.dts7/build/generate-usage.d.ts.map +1 -0
  209. package/dist/.dts7/build/generated-banner.d.ts +43 -0
  210. package/dist/.dts7/build/generated-banner.d.ts.map +1 -0
  211. package/dist/.dts7/build/glob.d.ts +6 -0
  212. package/dist/.dts7/build/glob.d.ts.map +1 -0
  213. package/dist/.dts7/build/governance-fields.d.ts +34 -0
  214. package/dist/.dts7/build/governance-fields.d.ts.map +1 -0
  215. package/dist/.dts7/build/humanize-key.d.ts +14 -0
  216. package/dist/.dts7/build/humanize-key.d.ts.map +1 -0
  217. package/dist/.dts7/build/index.d.ts +89 -0
  218. package/dist/.dts7/build/index.d.ts.map +1 -0
  219. package/dist/.dts7/build/lifecycle-model.d.ts +181 -0
  220. package/dist/.dts7/build/lifecycle-model.d.ts.map +1 -0
  221. package/dist/.dts7/build/link.d.ts +222 -0
  222. package/dist/.dts7/build/link.d.ts.map +1 -0
  223. package/dist/.dts7/build/literal-eval.d.ts +24 -0
  224. package/dist/.dts7/build/literal-eval.d.ts.map +1 -0
  225. package/dist/.dts7/build/live-expirations.d.ts +48 -0
  226. package/dist/.dts7/build/live-expirations.d.ts.map +1 -0
  227. package/dist/.dts7/build/manifest.d.ts +31 -0
  228. package/dist/.dts7/build/manifest.d.ts.map +1 -0
  229. package/dist/.dts7/build/map-utils.d.ts +8 -0
  230. package/dist/.dts7/build/map-utils.d.ts.map +1 -0
  231. package/dist/.dts7/build/merge-documentation.d.ts +36 -0
  232. package/dist/.dts7/build/merge-documentation.d.ts.map +1 -0
  233. package/dist/.dts7/build/ownership-model.d.ts +58 -0
  234. package/dist/.dts7/build/ownership-model.d.ts.map +1 -0
  235. package/dist/.dts7/build/parse.d.ts +206 -0
  236. package/dist/.dts7/build/parse.d.ts.map +1 -0
  237. package/dist/.dts7/build/reference-projections.d.ts +168 -0
  238. package/dist/.dts7/build/reference-projections.d.ts.map +1 -0
  239. package/dist/.dts7/build/resolution/resolve-import.d.ts +62 -0
  240. package/dist/.dts7/build/resolution/resolve-import.d.ts.map +1 -0
  241. package/dist/.dts7/build/resolution/resolve-package-schema.d.ts +83 -0
  242. package/dist/.dts7/build/resolution/resolve-package-schema.d.ts.map +1 -0
  243. package/dist/.dts7/build/resolution/resolve-tsconfig-paths.d.ts +18 -0
  244. package/dist/.dts7/build/resolution/resolve-tsconfig-paths.d.ts.map +1 -0
  245. package/dist/.dts7/build/resolution/resolve-within-root.d.ts +35 -0
  246. package/dist/.dts7/build/resolution/resolve-within-root.d.ts.map +1 -0
  247. package/dist/.dts7/build/sarif.d.ts +66 -0
  248. package/dist/.dts7/build/sarif.d.ts.map +1 -0
  249. package/dist/.dts7/build/scan-dependencies.d.ts +71 -0
  250. package/dist/.dts7/build/scan-dependencies.d.ts.map +1 -0
  251. package/dist/.dts7/build/sort-by-identity.d.ts +14 -0
  252. package/dist/.dts7/build/sort-by-identity.d.ts.map +1 -0
  253. package/dist/.dts7/build/source-position.d.ts +69 -0
  254. package/dist/.dts7/build/source-position.d.ts.map +1 -0
  255. package/dist/.dts7/build/tool-version.d.ts +8 -0
  256. package/dist/.dts7/build/tool-version.d.ts.map +1 -0
  257. package/dist/.dts7/build/types.d.ts +7 -0
  258. package/dist/.dts7/build/types.d.ts.map +1 -0
  259. package/dist/.dts7/build/typescript.d.ts +6 -0
  260. package/dist/.dts7/build/typescript.d.ts.map +1 -0
  261. package/dist/.dts7/build/usage-report.d.ts +124 -0
  262. package/dist/.dts7/build/usage-report.d.ts.map +1 -0
  263. package/dist/.dts7/cli/filesystem.d.ts +7 -0
  264. package/dist/.dts7/cli/filesystem.d.ts.map +1 -0
  265. package/dist/.dts7/eslint-plugin/glob.d.ts +7 -0
  266. package/dist/.dts7/eslint-plugin/glob.d.ts.map +1 -0
  267. package/dist/.dts7/eslint-plugin/index.d.ts +38 -0
  268. package/dist/.dts7/eslint-plugin/index.d.ts.map +1 -0
  269. package/dist/.dts7/eslint-plugin/no-node-fs.d.ts +15 -0
  270. package/dist/.dts7/eslint-plugin/no-node-fs.d.ts.map +1 -0
  271. package/dist/.dts7/eslint-plugin/no-raw-process-env.d.ts +23 -0
  272. package/dist/.dts7/eslint-plugin/no-raw-process-env.d.ts.map +1 -0
  273. package/dist/.dts7/evidence/define-projection.d.ts +51 -0
  274. package/dist/.dts7/evidence/define-projection.d.ts.map +1 -0
  275. package/dist/.dts7/evidence/index.d.ts +19 -0
  276. package/dist/.dts7/evidence/index.d.ts.map +1 -0
  277. package/dist/.dts7/helpers/index.d.ts +132 -0
  278. package/dist/.dts7/helpers/index.d.ts.map +1 -0
  279. package/dist/.dts7/helpers/processors.d.ts +32 -0
  280. package/dist/.dts7/helpers/processors.d.ts.map +1 -0
  281. package/dist/.dts7/helpers/validators.d.ts +68 -0
  282. package/dist/.dts7/helpers/validators.d.ts.map +1 -0
  283. package/dist/.dts7/node/index.d.ts +21 -0
  284. package/dist/.dts7/node/index.d.ts.map +1 -0
  285. package/dist/.dts7/runtime/cache.d.ts +17 -0
  286. package/dist/.dts7/runtime/cache.d.ts.map +1 -0
  287. package/dist/.dts7/runtime/create.d.ts +23 -0
  288. package/dist/.dts7/runtime/create.d.ts.map +1 -0
  289. package/dist/.dts7/runtime/document.d.ts +214 -0
  290. package/dist/.dts7/runtime/document.d.ts.map +1 -0
  291. package/dist/.dts7/runtime/errors.d.ts +55 -0
  292. package/dist/.dts7/runtime/errors.d.ts.map +1 -0
  293. package/dist/.dts7/runtime/index.d.ts +25 -0
  294. package/dist/.dts7/runtime/index.d.ts.map +1 -0
  295. package/dist/.dts7/runtime/registry.d.ts +12 -0
  296. package/dist/.dts7/runtime/registry.d.ts.map +1 -0
  297. package/dist/.dts7/runtime/reset.d.ts +8 -0
  298. package/dist/.dts7/runtime/reset.d.ts.map +1 -0
  299. package/dist/.dts7/runtime/types.d.ts +190 -0
  300. package/dist/.dts7/runtime/types.d.ts.map +1 -0
  301. package/dist/.dts7/runtime/validate.d.ts +27 -0
  302. package/dist/.dts7/runtime/validate.d.ts.map +1 -0
  303. package/dist/{build-6XFHJFQK.js → build-UEENZEUX.js} +43 -42
  304. package/dist/build-UEENZEUX.js.map +1 -0
  305. package/dist/build.cjs +42 -41
  306. package/dist/build.cjs.map +1 -1
  307. package/dist/build.js +42 -41
  308. package/dist/build.js.map +1 -1
  309. package/dist/build.ts7.d.cts +1 -0
  310. package/dist/build.ts7.d.ts +1 -0
  311. package/dist/{chunk-RL5KFVUT.js → chunk-TBL3O7IG.js} +2 -2
  312. package/dist/cli/index.js +29 -28
  313. package/dist/cli/index.js.map +1 -1
  314. package/dist/eslint-plugin/index.cjs.map +1 -1
  315. package/dist/eslint-plugin/index.js.map +1 -1
  316. package/dist/eslint-plugin/index.ts7.d.cts +1 -0
  317. package/dist/eslint-plugin/index.ts7.d.ts +1 -0
  318. package/dist/evidence.cjs +1 -1
  319. package/dist/evidence.cjs.map +1 -1
  320. package/dist/evidence.js +1 -1
  321. package/dist/evidence.js.map +1 -1
  322. package/dist/evidence.ts7.d.cts +1 -0
  323. package/dist/evidence.ts7.d.ts +1 -0
  324. package/dist/helpers.cjs +4 -4
  325. package/dist/helpers.cjs.map +1 -1
  326. package/dist/helpers.js +4 -4
  327. package/dist/helpers.js.map +1 -1
  328. package/dist/helpers.ts7.d.cts +1 -0
  329. package/dist/helpers.ts7.d.ts +1 -0
  330. package/dist/index.cjs.map +1 -1
  331. package/dist/index.js.map +1 -1
  332. package/dist/index.ts7.d.cts +1 -0
  333. package/dist/index.ts7.d.ts +1 -0
  334. package/dist/node.ts7.d.cts +1 -0
  335. package/dist/node.ts7.d.ts +1 -0
  336. package/examples/README.md +46 -80
  337. package/package.json +43 -12
  338. package/schemas/contract-model.schema.json +7 -7
  339. package/schemas/env-cap-report.schema.json +88 -88
  340. package/skills/env-cap/SKILL.md +12 -13
  341. package/skills/env-cap/references/api.md +1 -1
  342. package/specs/architecture.md +147 -122
  343. package/specs/decisions/0001-runtime-documentation-separation.md +1 -1
  344. package/specs/decisions/0014-cross-package-schema-discovery.md +4 -1
  345. package/specs/decisions/0023-tsconfig-path-alias-resolution.md +4 -1
  346. package/specs/decisions/0049-typescript-7-scanner-uses-a-bundled-typescript-6.md +13 -8
  347. package/specs/generated-artifacts.md +91 -71
  348. package/specs/migrations/README.md +6 -6
  349. package/specs/migrations/from-centralized-schema.md +1 -1
  350. package/specs/migrations/from-t3-env.md +9 -9
  351. package/PROMPT.md +0 -89
  352. package/dist/build-6XFHJFQK.js.map +0 -1
  353. /package/dist/{chunk-RL5KFVUT.js.map → chunk-TBL3O7IG.js.map} +0 -0
@@ -0,0 +1,94 @@
1
+ import type { BuildFileSystem } from "./types.js";
2
+ import type { DependencyGraph, ScannedSurface } from "./dependency-graph.js";
3
+ import type { DiscoveredContract } from "./link.js";
4
+ import type { ImportResolutionContext } from "./resolution/resolve-import.js";
5
+ import type { PackageOrigin } from "./resolution/resolve-package-schema.js";
6
+ import type { DynamicAccessAssertion } from "./source-position.js";
7
+ import { type RenderUsageReportOptions } from "./usage-report.js";
8
+ /**
9
+ * Computes the full usage-scan surface: the local project root, plus (ADR
10
+ * 0036) each allow-listed `packages` (ADR 0014) name whose schema was
11
+ * successfully resolved. Each such package's `packageDir` becomes a bounded
12
+ * scan root. It is reused from `origins` (computed by
13
+ * `resolveAllowlistedPackages()` for contract discovery), not re-resolved
14
+ * here. That root is walked with the same `discoverFiles()` +
15
+ * `SCAN_INCLUDE`/`defaultExclude()` policy as the local root, never as a
16
+ * naive, unbounded walk of the package's whole directory. Shared by
17
+ * `generateUsageReport()` and `generateEvidenceModel()` so both agree on
18
+ * exactly the same scanned surface.
19
+ */
20
+ export declare function computeScanSurface(root: string, exclude: readonly string[], origins: ReadonlyMap<string, PackageOrigin>, fs: BuildFileSystem): Promise<{
21
+ scanFiles: string[];
22
+ scannedSurfaces: ScannedSurface[];
23
+ }>;
24
+ /** Options for {@link generateUsageReport}. */
25
+ export interface GenerateUsageReportOptions {
26
+ /** The filesystem capability: `./build` never imports `node:fs` (ADR 0040). */
27
+ fs: BuildFileSystem;
28
+ /** Directory glob patterns are resolved against. Defaults to `process.cwd()`. */
29
+ root?: string | undefined;
30
+ /** Schema-discovery glob, for the contract graph: self-sufficient like the other two generator functions. */
31
+ include?: string[] | undefined;
32
+ /** Glob patterns to exclude, for both schema discovery and the usage scan. Defaults to node_modules/dist/.git. */
33
+ exclude?: string[] | undefined;
34
+ /** See `GenerateEnvManifestOptions.packages`; see ADR 0014. */
35
+ packages?: readonly string[] | undefined;
36
+ /** See `GenerateEnvManifestOptions.tsconfig`; see ADR 0023. */
37
+ tsconfig?: string | false | undefined;
38
+ /** Also write the rendered Markdown report to this path, relative to `root`. Omitted: the report is only returned, not written. */
39
+ report?: {
40
+ /** Output path for the report, relative to `root`. */
41
+ location: string;
42
+ } | undefined;
43
+ }
44
+ /**
45
+ * Public result of {@link generateUsageReport}.
46
+ *
47
+ * @remarks
48
+ * Composed from the building-block types `usage-report.ts` (the renderer) owns. That mirrors how
49
+ * `GenerateDocumentationResult` composes from `docs.ts`'s `CatalogContract`. It keeps the
50
+ * renderer importable without its orchestrator (see `RenderUsageReportOptions`'s own doc
51
+ * comment).
52
+ */
53
+ export interface GenerateUsageReportResult extends RenderUsageReportOptions {
54
+ /** Absolute path the report was written to, or `undefined` if `options.report` wasn't passed. */
55
+ readonly reportPath: string | undefined;
56
+ }
57
+ export interface UsageComputation {
58
+ readonly graph: DependencyGraph;
59
+ /** Everything the report renders except `parseWarnings`, which the caller owns (it comes from discovery, not from this analysis). */
60
+ readonly result: Omit<RenderUsageReportOptions, "parseWarnings">;
61
+ }
62
+ /**
63
+ * Builds the dependency graph and maps it into the public, ownership-framed
64
+ * result. Never blocks: see the doc comments on `RenderUsageReportOptions`'s
65
+ * finding fields. A team that wants to gate CI on an ownership issue reads
66
+ * `Finding[]` (the "ownership" family) from the persisted evidence artifact.
67
+ * It then decides for itself. See ADR 0038.
68
+ *
69
+ * @remarks
70
+ * This mapping is the actual API boundary: internal AST vocabulary
71
+ * ("member accessed", "dynamic") becomes ownership vocabulary ("who owns
72
+ * it", "who consumes it", "abandoned", "unresolved"). The result is a
73
+ * renderer-agnostic domain model. A future JSON or SARIF exporter would
74
+ * consume the same data; it is not coupled to the Markdown renderer.
75
+ */
76
+ export declare function computeUsage(root: string, contracts: readonly DiscoveredContract[], scanFiles: readonly string[], readFile: (filePath: string) => Promise<string>, context: ImportResolutionContext, scannedSurfaces?: readonly ScannedSurface[], dynamicAccessAcknowledgments?: ReadonlyMap<string, readonly DynamicAccessAssertion[]>): Promise<UsageComputation>;
77
+ /** Writes the Dependency & Ownership Report. Callers must have already confirmed `reportPath` is safe and nothing is blocking. */
78
+ export declare function writeUsageReport(reportPath: string, computed: Omit<GenerateUsageReportResult, "reportPath">, fs: BuildFileSystem): Promise<void>;
79
+ /**
80
+ * Build-time only. Answers who owns each contract, which features depend on
81
+ * it, and what the blast radius is if it changes. It is the mirror image of
82
+ * {@link generateEnvManifest}'s "safer migrations" story. A schema that was
83
+ * never wired up, or was abandoned mid-removal, shows up here instead of
84
+ * sitting unnoticed.
85
+ *
86
+ * @remarks
87
+ * This is an additional, separate artifact, not a replacement for
88
+ * {@link generateDocumentation}'s Catalog: the two serve different audiences
89
+ * (see ADR 0010).
90
+ *
91
+ * @throws {EnvUsageAnalysisError} If `report.location` escapes `root`.
92
+ */
93
+ export declare function generateUsageReport(options: GenerateUsageReportOptions): Promise<GenerateUsageReportResult>;
94
+ //# sourceMappingURL=generate-usage.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generate-usage.d.ts","sourceRoot":"","sources":["../../../src/build/generate-usage.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAEjD,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAS5E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAA;AAC7E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAA;AAE3E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,EAML,KAAK,wBAAwB,EAG9B,MAAM,mBAAmB,CAAA;AAE1B;;;;;;;;;;;GAWG;AACH,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,SAAS,MAAM,EAAE,EAC1B,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,aAAa,CAAC,EAC3C,EAAE,EAAE,eAAe,GAClB,OAAO,CAAC;IAAE,SAAS,EAAE,MAAM,EAAE,CAAC;IAAC,eAAe,EAAE,cAAc,EAAE,CAAA;CAAE,CAAC,CAmCrE;AAED,+CAA+C;AAC/C,MAAM,WAAW,0BAA0B;IACzC,+EAA+E;IAC/E,EAAE,EAAE,eAAe,CAAA;IACnB,iFAAiF;IACjF,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,6GAA6G;IAC7G,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC9B,kHAAkH;IAClH,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC9B,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAA;IACxC,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CAAA;IACrC,mIAAmI;IACnI,MAAM,CAAC,EACH;QACE,sDAAsD;QACtD,QAAQ,EAAE,MAAM,CAAA;KACjB,GACD,SAAS,CAAA;CACd;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,yBAA0B,SAAQ,wBAAwB;IACzE,iGAAiG;IACjG,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;CACxC;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAA;IAC/B,qIAAqI;IACrI,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,wBAAwB,EAAE,eAAe,CAAC,CAAA;CACjE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,YAAY,CAChC,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,SAAS,kBAAkB,EAAE,EACxC,SAAS,EAAE,SAAS,MAAM,EAAE,EAC5B,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,EAC/C,OAAO,EAAE,uBAAuB,EAChC,eAAe,CAAC,EAAE,SAAS,cAAc,EAAE,EAC3C,4BAA4B,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,sBAAsB,EAAE,CAAC,GACpF,OAAO,CAAC,gBAAgB,CAAC,CAsI3B;AAED,kIAAkI;AAClI,wBAAsB,gBAAgB,CACpC,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,IAAI,CAAC,yBAAyB,EAAE,YAAY,CAAC,EACvD,EAAE,EAAE,eAAe,GAClB,OAAO,CAAC,IAAI,CAAC,CAQf;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,mBAAmB,CACvC,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,yBAAyB,CAAC,CAkDpC"}
@@ -0,0 +1,43 @@
1
+ /**
2
+ * Regeneration instruction for a report the CLI does not write (ADR 0046): it is produced by the project's own
3
+ * script calling the `@maverickcer/env-cap/build` generators, so naming `npx env-cap` there would send a reader to a command that
4
+ * cannot regenerate it.
5
+ * @returns The instruction, as a sentence.
6
+ */
7
+ export declare function reportRegenerateHint(): string;
8
+ /**
9
+ * Renders the "do not edit by hand" marker in the given comment syntax.
10
+ * @param format - Comment syntax to render in.
11
+ * @param regenerate - How to regenerate; defaults to the CLI, which writes the manifest.
12
+ * @returns The comment line.
13
+ */
14
+ export declare function generatedBanner(format?: "ts" | "markdown", regenerate?: string): string;
15
+ /**
16
+ * Whether `content` carries a {@link generatedBanner}-produced marker, in either format.
17
+ *
18
+ * @remarks
19
+ * Deliberately not a bare `content.startsWith(generatedBanner(...))`. A shebang, a `"use strict"` pragma, or a
20
+ * license header pushes a real banner off line one. A stricter check would then read a generated file as
21
+ * hand-written. The dependency scan would take that as "a real consumer imports this" and so permanently mask an
22
+ * abandoned contract. The marker is looked for across the first 20 non-empty lines instead,
23
+ * which clears every realistic preamble without scanning a whole file.
24
+ * @param content - A file's text.
25
+ * @returns `true` when the file is generated.
26
+ */
27
+ export declare function isGeneratedFile(content: string): boolean;
28
+ /**
29
+ * Short disclaimer stamped into every artifact that renders sensitivity, ownership or expiry claims. Never omit
30
+ * it from an artifact that renders such metadata: it is what keeps "documented" from being misread as
31
+ * "verified" or "compliant". Every fact in those artifacts is either a statically-provable code fact or an
32
+ * author's own declaration; env-cap never validates a declaration against reality.
33
+ * @returns The disclaimer.
34
+ */
35
+ export declare function evidenceDisclaimer(): string;
36
+ /**
37
+ * States, by concept, that an artifact is a projection of env-cap's Evidence Model, and by path when one is known.
38
+ * It never hardcodes a path, because the evidence file only exists on a run that passed `--evidence`.
39
+ * @param evidencePath - The path the evidence was also written to, when this run wrote it.
40
+ * @returns The note.
41
+ */
42
+ export declare function evidenceProjectionNote(evidencePath?: string): string;
43
+ //# sourceMappingURL=generated-banner.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generated-banner.d.ts","sourceRoot":"","sources":["../../../src/build/generated-banner.ts"],"names":[],"mappings":"AAwBA;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,MAAM,CAAC,EAAE,IAAI,GAAG,UAAU,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAEvF;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAExD;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,IAAI,MAAM,CAE3C;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAEpE"}
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Glob-to-RegExp conversion for discovery. The behavior lives in `../_ipc/glob.ts`, a managed copy of
3
+ * internal-package-contract's `runtime/glob.ts`. Not re-exported from `./index.js`: Private tier per `VERSIONING.md`.
4
+ */
5
+ export { globToRegExp } from "../_ipc/glob.js";
6
+ //# sourceMappingURL=glob.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"glob.d.ts","sourceRoot":"","sources":["../../../src/build/glob.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA"}
@@ -0,0 +1,34 @@
1
+ /**
2
+ * The declared governance-metadata field set every pipeline-stage contract and
3
+ * variable type carries: `owner` through `metadata`. The field names and types
4
+ * are identical at every stage (parse -> link -> contract-model -> docs). Only
5
+ * the surrounding context differs. A `parse`-stage value is "statically resolved
6
+ * from a string literal, or `undefined`". A `link`/`contract-model`-stage value
7
+ * is "from the linked `documentEnv()` call, or `undefined`". This is the single
8
+ * source of truth for the shape; each stage interface `extends` it.
9
+ *
10
+ * `metadata` is the open bag for keys `env-cap` has no named concept for (ADR
11
+ * 0037); `dataResidency`/`auditRequired`/`legalBasis`/`purpose`/`retention` are
12
+ * presence-only governance facts, never verified.
13
+ *
14
+ * Internal: not re-exported from the public `.` barrel.
15
+ */
16
+ export interface EnvGovernanceFields {
17
+ readonly owner: string | undefined;
18
+ readonly sensitivity: string | undefined;
19
+ readonly expiresAt: string | undefined;
20
+ readonly purpose: string | undefined;
21
+ readonly legalBasis: string | undefined;
22
+ readonly retention: string | undefined;
23
+ readonly dataResidency: string | readonly string[] | undefined;
24
+ readonly auditRequired: boolean | undefined;
25
+ readonly metadata: Readonly<Record<string, unknown>> | undefined;
26
+ }
27
+ /**
28
+ * Copies exactly the `EnvGovernanceFields` out of a value that carries
29
+ * them: for projecting one pipeline stage's contract/variable into the next
30
+ * (`link` -> `contract-model` -> `docs` catalog, ...) without re-listing all
31
+ * nine fields at every hop.
32
+ */
33
+ export declare function governanceFieldsOf(source: EnvGovernanceFields): EnvGovernanceFields;
34
+ //# sourceMappingURL=governance-fields.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"governance-fields.d.ts","sourceRoot":"","sources":["../../../src/build/governance-fields.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IAClC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IACvC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,GAAG,SAAS,CAAA;IAC9D,QAAQ,CAAC,aAAa,EAAE,OAAO,GAAG,SAAS,CAAA;IAC3C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,SAAS,CAAA;CACjE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,mBAAmB,GAAG,mBAAmB,CAYnF"}
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Formats a metadata key for display in generated docs/examples:
3
+ * "lastRotation" -> "Last Rotation". Shared by `docs.ts` and `env-example.ts`
4
+ * so both generated artifacts label metadata the same way.
5
+ */
6
+ export declare function humanizeKey(key: string): string;
7
+ /**
8
+ * Formats a `metadata`/`dataResidency` value for display in generated docs/examples: a string
9
+ * renders as-is; anything else (ADR 0035 widened `metadata` to any value) renders as its JSON
10
+ * text, so an object/array value never prints `[object Object]`. Shared by `docs.ts` and
11
+ * `env-example.ts`, same rationale as {@link humanizeKey}.
12
+ */
13
+ export declare function renderMetadataValue(value: unknown): string;
14
+ //# sourceMappingURL=humanize-key.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"humanize-key.d.ts","sourceRoot":"","sources":["../../../src/build/humanize-key.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAO/C;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAE1D"}
@@ -0,0 +1,89 @@
1
+ /**
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.
5
+ *
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.
11
+ *
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).
16
+ *
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.
20
+ *
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).
25
+ *
26
+ * @packageDocumentation
27
+ */
28
+ export { checkEnvArtifacts } from "./check-artifacts.js";
29
+ export type { ArtifactCheckFinding, CheckEnvArtifactsResult } from "./check-artifacts.js";
30
+ export { generateDocumentation } from "./generate-documentation.js";
31
+ export { STANDARD_SENSITIVITY_LEVELS, type DocumentationFindings, type GenerateDocumentationOptions, type GenerateDocumentationResult, type NonstandardSensitivityEntry, } from "./generate-documentation.js";
32
+ export { generateEnvArtifacts } from "./generate-env-artifacts.js";
33
+ export type { GenerateEnvArtifactsOptions, GenerateEnvArtifactsResult, } from "./generate-env-artifacts.js";
34
+ export { generateEnvManifest } from "./generate-manifest.js";
35
+ export type { GenerateEnvManifestOptions, GenerateEnvManifestResult } from "./generate-manifest.js";
36
+ export type { ManifestChangeReport, ManifestContractRef, ManifestContractUpdate, ManifestFieldChange, ManifestVariableRef, ManifestVariableUpdate, } from "./evidence-snapshot.js";
37
+ export { computeSourceFingerprint, getEvidenceModel } from "./evidence-cache.js";
38
+ export type { ComputeSourceFingerprintOptions, GetEvidenceModelOptions, GetEvidenceModelResult, } from "./evidence-cache.js";
39
+ export { generateUsageReport } from "./generate-usage.js";
40
+ export type { GenerateUsageReportOptions, GenerateUsageReportResult } from "./generate-usage.js";
41
+ export { renderUsageReport, type AbandonedContractFinding, type AssertedDynamicAccessFinding, type IndeterminateOwnershipFinding, type OwnershipDependencyEntry, type RenderUsageReportOptions, type UnconsumedOwnedVariableFinding, type UnresolvedConsumerFinding, } from "./usage-report.js";
42
+ export type { DynamicAccessCitationProblem } from "./citation-verification.js";
43
+ export type { CompatibilityIssue, CompatibilityIssueCode } from "./compatibility.js";
44
+ export { EnvDocumentationGenerationError, EnvManifestGenerationError, EnvProjectGenerationError, EnvUsageAnalysisError, } from "./errors.js";
45
+ export type { DiscoveredContractSummary } from "./link.js";
46
+ export { buildChangeModel, CHANGE_MODEL_SCHEMA_VERSION } from "./change-model.js";
47
+ export type { ChangeModel, RenamedVariable } from "./change-model.js";
48
+ export { detectCompatibilityIssues, detectDuplicateVariableShapes } from "./compatibility.js";
49
+ export { displayPath } from "./display-path.js";
50
+ export { buildSarifLog } from "./sarif.js";
51
+ export type { SarifLog } from "./sarif.js";
52
+ export { configurationReference, expiringSoonReport, groupVariablesByOwner, ownershipSummary, } from "./reference-projections.js";
53
+ export type { ConfigurationReference, ConfigurationReferenceEntry, ExpiringSoonEntry, ExpiringSoonReport, OwnerBearingContract, OwnershipSummary, OwnershipSummaryEntry, } from "./reference-projections.js";
54
+ export { buildContractModel, CONTRACT_MODEL_SCHEMA_VERSION } from "./contract-model.js";
55
+ export type { ContractModel, ContractModelContract, ContractModelVariable, } from "./contract-model.js";
56
+ export { deepFreeze } from "./deep-freeze.js";
57
+ export { buildDependencyModel, DEPENDENCY_MODEL_SCHEMA_VERSION } from "./dependency-model.js";
58
+ export type { DependencyModel, DependencyModelConsumer, DependencyModelContract, DependencyModelContractRef, DependencyModelVariable, } from "./dependency-model.js";
59
+ export type { ScannedSurface, VariableAccessStatus } from "./dependency-graph.js";
60
+ export { discoverSchemaFiles } from "./discover.js";
61
+ export { computeExpiringEntries, computeSecurityReviewCounters, extractPreviouslyDocumentedKeys, renderDocs, } from "./docs.js";
62
+ export type { ExpiringEntry, RenderDocsOptions, SecurityReviewCounters, UndocumentedContractRef, UndocumentedVariableRef, } from "./docs.js";
63
+ export { computeReconciliation, extractCommentedVariables, extractDeclaredVariables, renderEnvExample, writeEnvExample, } from "./env-example.js";
64
+ export type { EnvExampleOnExisting, EnvExampleResult, Reconciliation } from "./env-example.js";
65
+ export type { DynamicAccessAssertion, SourcePosition } from "./source-position.js";
66
+ export { EVIDENCE_MODEL_SCHEMA_VERSION } from "./evidence-model.js";
67
+ export type { EvidenceModel, EvidenceProvenance } from "./evidence-model.js";
68
+ export { generateEvidenceModel } from "./generate-evidence.js";
69
+ export type { GenerateEvidenceModelOptions } from "./generate-evidence.js";
70
+ export type { ChangeEvidenceReference, ContractEvidenceReference, ContractRef, EvidenceReference, OwnershipEvidenceReference, } from "./evidence-reference.js";
71
+ export { detectExclusiveGroupIssues } from "./exclusive-group.js";
72
+ export { buildFindingModel, FINDING_MODEL_SCHEMA_VERSION } from "./finding-model.js";
73
+ export type { BuildFindingModelInput, Finding, FindingCode, FindingFamily, FindingModel, } from "./finding-model.js";
74
+ export { buildLifecycleModel, computeRotationStatus, LIFECYCLE_MODEL_SCHEMA_VERSION, parseRotationPeriodDays, } from "./lifecycle-model.js";
75
+ export type { LifecycleModel, LifecycleModelContract, LifecycleModelVariable, RotationComplianceStatus, } from "./lifecycle-model.js";
76
+ export { effectiveOwner, linkFiles } from "./link.js";
77
+ export type { DiscoveredContract, DiscoveredVariable, LinkResult, UnresolvedLink } from "./link.js";
78
+ export { applyLiveExpirationOverrides, collectVariableNames, resolveLiveExpirationDates, } from "./live-expirations.js";
79
+ export type { LiveExpirationDates } from "./live-expirations.js";
80
+ export { renderManifest } from "./manifest.js";
81
+ export { buildOwnershipModel, OWNERSHIP_MODEL_SCHEMA_VERSION } from "./ownership-model.js";
82
+ export type { OwnershipModel, OwnershipModelContract, OwnershipModelContractRef, OwnershipModelVariable, OwnershipModelVariableRef, } from "./ownership-model.js";
83
+ export { extractContractDocs, extractSchemaVariables, parseSchemaFile } from "./parse.js";
84
+ export type { DiscoveredContractDocs, DiscoveredSchemaVariable, DiscoveredVariableDocs, DiscoveredVariableEvidence, FileParseResult, ImportBinding, ParseWarning, SchemaRef, } from "./parse.js";
85
+ export { resolveRelativeImport } from "./resolution/resolve-import.js";
86
+ export type { PackageOrigin } from "./resolution/resolve-package-schema.js";
87
+ export type { BuildDirent, BuildFileSystem, BuildStats } from "./types.js";
88
+ export { readToolVersion } from "./tool-version.js";
89
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,181 @@
1
+ import type { ExpiringEntry } from "./docs.js";
2
+ import type { DiscoveredContract } from "./link.js";
3
+ /**
4
+ * The fifth of env-cap's seven canonical fact models (ADR 0024): every
5
+ * contract and variable's lifecycle data (expiry, deprecation, rename
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
+ *
11
+ * As of schema version 3, this also carries NIST SP 800-53 IA-5 rotation
12
+ * data (`authenticatorType`/`rotationPeriod`/`lastRotatedAt`/
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
+ */
18
+ /** Bump only when a reader could misinterpret the new shape: same discipline every other canonical model's `schemaVersion` follows. */
19
+ export declare const LIFECYCLE_MODEL_SCHEMA_VERSION = 3;
20
+ /**
21
+ * One variable's computed NIST SP 800-53 IA-5 rotation status (a policy-window judgement):
22
+ * see `computeRotationStatus()` for exactly how it's derived. Always present
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.
33
+ */
34
+ export type RotationComplianceStatus = "compliant" | "overdue" | "expired" | "undeclared";
35
+ /**
36
+ * One variable's lifecycle data (expiry, deprecation, rename correlation).
37
+ *
38
+ * @see {@link ContractModelVariable}: this same declared variable's canonical starting point.
39
+ */
40
+ export interface LifecycleModelVariable {
41
+ readonly key: string;
42
+ readonly expiresAt: string | undefined;
43
+ readonly refreshInstructions: string | undefined;
44
+ readonly deprecated: boolean | undefined;
45
+ readonly deprecatedReason: string | undefined;
46
+ readonly removeBy: string | undefined;
47
+ /** The previous variable name this one renames, if set: see `ManifestChangeReport`'s rename correlation (ADR 0029/0030). */
48
+ readonly renamedFrom: string | undefined;
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. */
50
+ readonly retention: string | undefined;
51
+ /** See {@link runtime.VariableDocs.authenticatorType}. */
52
+ readonly authenticatorType: string | undefined;
53
+ /** See {@link runtime.VariableDocs.rotationPeriod}. */
54
+ readonly rotationPeriod: string | undefined;
55
+ /** See {@link runtime.VariableDocs.lastRotatedAt}. */
56
+ readonly lastRotatedAt: string | undefined;
57
+ /** See {@link runtime.VariableDocs.rotationTriggerEvents}. */
58
+ readonly rotationTriggerEvents: readonly string[] | undefined;
59
+ /** Computed, not stored: see {@link RotationComplianceStatus} and `computeRotationStatus()`. */
60
+ readonly rotationStatus: RotationComplianceStatus;
61
+ }
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. */
63
+ export interface LifecycleModelContract {
64
+ /** Root-relative, POSIX-separated: matches `ContractModelContract.file`. */
65
+ readonly file: string;
66
+ readonly exportName: string;
67
+ readonly contractName: string;
68
+ readonly expiresAt: string | undefined;
69
+ readonly deprecated: boolean | undefined;
70
+ readonly deprecatedReason: string | undefined;
71
+ /** See {@link LifecycleModelVariable.retention}. */
72
+ readonly retention: string | undefined;
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. */
74
+ readonly variables: readonly LifecycleModelVariable[];
75
+ }
76
+ /** The versioned, JSON-serializable root of the Lifecycle Model: see this module's own doc comment for the full picture. */
77
+ export interface LifecycleModel {
78
+ readonly schemaVersion: typeof LIFECYCLE_MODEL_SCHEMA_VERSION;
79
+ /** Only contracts with at least one lifecycle-relevant field set, at the contract level or on at least one variable. */
80
+ readonly contracts: readonly LifecycleModelContract[];
81
+ /**
82
+ * Every contract-/variable-level `expiresAt` within the configured window,
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.
89
+ */
90
+ readonly expiring: readonly ExpiringEntry[];
91
+ }
92
+ /**
93
+ * Parses `rotationPeriod` (e.g. "90 days", "P90D", "6 months") into a whole number of days, or
94
+ * `undefined` when it isn't in either recognized grammar.
95
+ *
96
+ * @remarks
97
+ * `rotationPeriod` is documented (`runtime/document.ts`) as an organization-defined string much
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.
113
+ *
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.
120
+ *
121
+ * Both patterns are inlined at their `.exec()` call site, deliberately not hoisted to a
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.
126
+ */
127
+ export declare function parseRotationPeriodDays(value: string): number | undefined;
128
+ /**
129
+ * Computes one variable's NIST SP 800-53 IA-5 rotation status (a policy-window judgement) from its lifecycle facts,
130
+ * relative to `now`.
131
+ *
132
+ * @remarks
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:
138
+ *
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
141
+ * case, not a violation to report.
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.
160
+ *
161
+ * `rotationTriggerEvents` (the event-based trigger) deliberately never changes the returned status
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.
167
+ */
168
+ export declare function computeRotationStatus(variable: {
169
+ readonly expiresAt: string | undefined;
170
+ readonly authenticatorType: string | undefined;
171
+ readonly rotationPeriod: string | undefined;
172
+ readonly lastRotatedAt: string | undefined;
173
+ readonly rotationTriggerEvents: readonly string[] | undefined;
174
+ }, now: Date): RotationComplianceStatus;
175
+ /**
176
+ * Projects every discovered contract with at least one lifecycle-relevant
177
+ * field set into the Lifecycle Model's versioned, JSON-serializable shape,
178
+ * plus the already-established `expiring` view.
179
+ */
180
+ export declare function buildLifecycleModel(contracts: readonly DiscoveredContract[], expiringWithinDays: number, now: Date, root: string): LifecycleModel;
181
+ //# sourceMappingURL=lifecycle-model.d.ts.map
@@ -0,0 +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,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"}