@maverickcer/env-cap 0.3.1 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. package/README.md +27 -7
  2. package/dist/.dts/build/change-model.d.ts +1 -0
  3. package/dist/.dts/build/change-model.d.ts.map +1 -1
  4. package/dist/.dts/build/check-artifacts.d.ts.map +1 -1
  5. package/dist/.dts/build/compatibility.d.ts +8 -1
  6. package/dist/.dts/build/compatibility.d.ts.map +1 -1
  7. package/dist/.dts/build/contract-model.d.ts +1 -0
  8. package/dist/.dts/build/contract-model.d.ts.map +1 -1
  9. package/dist/.dts/build/dependency-model.d.ts +2 -0
  10. package/dist/.dts/build/dependency-model.d.ts.map +1 -1
  11. package/dist/.dts/build/discover.d.ts.map +1 -1
  12. package/dist/.dts/build/docs.d.ts.map +1 -1
  13. package/dist/.dts/build/env-example.d.ts.map +1 -1
  14. package/dist/.dts/build/exclusive-group.d.ts.map +1 -1
  15. package/dist/.dts/build/finding-model.d.ts +1 -0
  16. package/dist/.dts/build/finding-model.d.ts.map +1 -1
  17. package/dist/.dts/build/generate-documentation.d.ts +2 -2
  18. package/dist/.dts/build/generate-documentation.d.ts.map +1 -1
  19. package/dist/.dts/build/generate-env-artifacts.d.ts +2 -2
  20. package/dist/.dts/build/generate-env-artifacts.d.ts.map +1 -1
  21. package/dist/.dts/build/generate-evidence.d.ts +2 -2
  22. package/dist/.dts/build/generate-evidence.d.ts.map +1 -1
  23. package/dist/.dts/build/generate-manifest.d.ts +2 -2
  24. package/dist/.dts/build/generate-usage.d.ts +2 -2
  25. package/dist/.dts/build/generate-usage.d.ts.map +1 -1
  26. package/dist/.dts/build/glob.d.ts.map +1 -1
  27. package/dist/.dts/build/governance-fields.d.ts +1 -1
  28. package/dist/.dts/build/index.d.ts +15 -17
  29. package/dist/.dts/build/index.d.ts.map +1 -1
  30. package/dist/.dts/build/lifecycle-model.d.ts +2 -0
  31. package/dist/.dts/build/lifecycle-model.d.ts.map +1 -1
  32. package/dist/.dts/build/link.d.ts +2 -2
  33. package/dist/.dts/build/link.d.ts.map +1 -1
  34. package/dist/.dts/build/live-expirations.d.ts.map +1 -1
  35. package/dist/.dts/build/manifest.d.ts.map +1 -1
  36. package/dist/.dts/build/ownership-model.d.ts +2 -0
  37. package/dist/.dts/build/ownership-model.d.ts.map +1 -1
  38. package/dist/.dts/build/parse.d.ts +2 -2
  39. package/dist/.dts/build/parse.d.ts.map +1 -1
  40. package/dist/.dts/build/resolution/resolve-package-schema.d.ts.map +1 -1
  41. package/dist/.dts/build/resolution/resolve-tsconfig-paths.d.ts +1 -1
  42. package/dist/.dts/build/resolution/resolve-tsconfig-paths.d.ts.map +1 -1
  43. package/dist/.dts/build/sarif.d.ts.map +1 -1
  44. package/dist/.dts/build/source-position.d.ts +2 -2
  45. package/dist/.dts/build/types.d.ts +3 -0
  46. package/dist/.dts/build/types.d.ts.map +1 -1
  47. package/dist/.dts/eslint-plugin/glob.d.ts.map +1 -1
  48. package/dist/.dts/evidence/define-projection.d.ts +1 -0
  49. package/dist/.dts/evidence/define-projection.d.ts.map +1 -1
  50. package/dist/.dts/helpers/validators.d.ts.map +1 -1
  51. package/dist/.dts/runtime/document.d.ts +1 -2
  52. package/dist/.dts/runtime/document.d.ts.map +1 -1
  53. package/dist/.dts/runtime/index.d.ts +1 -1
  54. package/dist/.dts/runtime/index.d.ts.map +1 -1
  55. package/dist/.dts/runtime/validate.d.ts.map +1 -1
  56. package/dist/build-ICYKXFRE.js +12 -0
  57. package/dist/build-ICYKXFRE.js.map +1 -0
  58. package/dist/build.cjs +4 -3
  59. package/dist/build.cjs.map +1 -1
  60. package/dist/build.js +4 -4
  61. package/dist/build.js.map +1 -1
  62. package/dist/chunk-QUSAQJ52.js +3 -0
  63. package/dist/chunk-QUSAQJ52.js.map +1 -0
  64. package/dist/cli/index.js +17 -26
  65. package/dist/cli/index.js.map +1 -1
  66. package/dist/eslint-plugin/index.cjs +1 -1
  67. package/dist/eslint-plugin/index.cjs.map +1 -1
  68. package/dist/eslint-plugin/index.js +1 -1
  69. package/dist/eslint-plugin/index.js.map +1 -1
  70. package/dist/evidence.cjs.map +1 -1
  71. package/dist/evidence.js.map +1 -1
  72. package/dist/helpers.cjs +1 -1
  73. package/dist/helpers.cjs.map +1 -1
  74. package/dist/helpers.js +1 -1
  75. package/dist/helpers.js.map +1 -1
  76. package/dist/index.cjs +1 -1
  77. package/dist/index.cjs.map +1 -1
  78. package/dist/index.js +1 -1
  79. package/dist/index.js.map +1 -1
  80. package/package.json +11 -9
  81. package/schemas/contract-model.schema.json +2 -1
  82. package/schemas/env-cap-report.schema.json +20 -11
@@ -183,7 +183,7 @@
183
183
  "items": {
184
184
  "type": "string"
185
185
  },
186
- "description": "Every file declaring a conflicting definition."
186
+ "description": "Every file declaring a conflicting definition. A pairwise comparison (compatibility.ts, exclusive-group.ts) always produces exactly two; a finding escalated from another family (generate-env-artifacts.ts's `escalatedFindings()`, via `findingFiles()`) can produce zero, one, or two, depending on what location information that finding actually carries -- genuinely variable arity, not a tuple."
187
187
  },
188
188
  "reason": {
189
189
  "type": "string",
@@ -1053,7 +1053,7 @@
1053
1053
  "line"
1054
1054
  ],
1055
1055
  "additionalProperties": false,
1056
- "description": "One developer-declared runtime.VariableDocs.dynamicAccess citation's current acknowledgment state -- a claim, never an observation. Kept fully separate from `VariableAccessStatus` (which stays exactly 3-valued and purely AST-derived) so a developer's assertion can never make env-cap claim it observed something it didn't. See `evidence-snapshot.ts`'s `computeDynamicAccessAcknowledgments()` (where this is computed) and ADR 0037."
1056
+ "description": "One developer-declared runtime.VariableEvidenceDocs.dynamicAccess citation's current acknowledgment state -- a claim, never an observation. Kept fully separate from `VariableAccessStatus` (which stays exactly 3-valued and purely AST-derived) so a developer's assertion can never make env-cap claim it observed something it didn't. See `evidence-snapshot.ts`'s `computeDynamicAccessAcknowledgments()` (where this is computed) and ADR 0037."
1057
1057
  },
1058
1058
  "ScannedSurface": {
1059
1059
  "type": "object",
@@ -1183,7 +1183,8 @@
1183
1183
  "schemaVersion",
1184
1184
  "contracts"
1185
1185
  ],
1186
- "additionalProperties": false
1186
+ "additionalProperties": false,
1187
+ "description": "The versioned, JSON-serializable root of the Contract Model -- every discovered `createEnv()` contract (active or not), each with its own full statically-discoverable shape. See ContractModelContract."
1187
1188
  },
1188
1189
  "ContractModelContract": {
1189
1190
  "type": "object",
@@ -1480,7 +1481,8 @@
1480
1481
  "warnings",
1481
1482
  "scannedSurfaces"
1482
1483
  ],
1483
- "additionalProperties": false
1484
+ "additionalProperties": false,
1485
+ "description": "The versioned, JSON-serializable root of the Dependency Model -- see this module's own doc comment for the full picture."
1484
1486
  },
1485
1487
  "DependencyModelContract": {
1486
1488
  "type": "object",
@@ -1540,7 +1542,8 @@
1540
1542
  "ambiguousBarrelFiles",
1541
1543
  "dynamicAccessSites"
1542
1544
  ],
1543
- "additionalProperties": false
1545
+ "additionalProperties": false,
1546
+ "description": "One contract's dependency-ownership facts: which variables were accessed, which files consume it, and every dynamic/ambiguous access site found. See DependencyModelVariable for the per-variable breakdown."
1544
1547
  },
1545
1548
  "DependencyModelVariable": {
1546
1549
  "type": "object",
@@ -1662,7 +1665,8 @@
1662
1665
  "unownedContracts",
1663
1666
  "unownedVariables"
1664
1667
  ],
1665
- "additionalProperties": false
1668
+ "additionalProperties": false,
1669
+ "description": "The versioned, JSON-serializable root of the Ownership Model -- see this module's own doc comment for the full picture."
1666
1670
  },
1667
1671
  "OwnershipModelContract": {
1668
1672
  "type": "object",
@@ -1694,7 +1698,8 @@
1694
1698
  "contractName",
1695
1699
  "variables"
1696
1700
  ],
1697
- "additionalProperties": false
1701
+ "additionalProperties": false,
1702
+ "description": "One contract's own default owner plus every variable's effective owner. See OwnershipModelVariable for the per-variable shape."
1698
1703
  },
1699
1704
  "OwnershipModelVariable": {
1700
1705
  "type": "object",
@@ -1767,7 +1772,8 @@
1767
1772
  "contracts",
1768
1773
  "expiring"
1769
1774
  ],
1770
- "additionalProperties": false
1775
+ "additionalProperties": false,
1776
+ "description": "The versioned, JSON-serializable root of the Lifecycle Model -- see this module's own doc comment for the full picture."
1771
1777
  },
1772
1778
  "LifecycleModelContract": {
1773
1779
  "type": "object",
@@ -1809,7 +1815,8 @@
1809
1815
  "contractName",
1810
1816
  "variables"
1811
1817
  ],
1812
- "additionalProperties": false
1818
+ "additionalProperties": false,
1819
+ "description": "One contract's own lifecycle data plus every variable of its that has at least one lifecycle field set. See LifecycleModelVariable for the per-variable shape."
1813
1820
  },
1814
1821
  "LifecycleModelVariable": {
1815
1822
  "type": "object",
@@ -1865,7 +1872,8 @@
1865
1872
  "schemaVersion",
1866
1873
  "findings"
1867
1874
  ],
1868
- "additionalProperties": false
1875
+ "additionalProperties": false,
1876
+ "description": "The versioned, JSON-serializable root of the Finding Model -- every rule violation and derived risk signal from this run, unified behind Finding 's one shape. See this module's own doc comment for the full picture."
1869
1877
  },
1870
1878
  "Finding": {
1871
1879
  "type": "object",
@@ -2105,7 +2113,8 @@
2105
2113
  "manifest",
2106
2114
  "renamedVariables"
2107
2115
  ],
2108
- "additionalProperties": false
2116
+ "additionalProperties": false,
2117
+ "description": "The versioned, JSON-serializable root of the Change Model -- what changed since the last persisted evidence snapshot. See this module's own doc comment for the full picture."
2109
2118
  },
2110
2119
  "ManifestChangeReport": {
2111
2120
  "type": "object",