Skip to content

docs(metadata): add guardrails for observed_absent usage #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
saraeloop merged 1 commit into from
Apr 14, 2026
Merged

docs(metadata): add guardrails for observed_absent usage #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@synsoftworks/depgraph-cli",
"version": "0.2.8",
"version": "0.2.9",
"description": "Graph-first dependency risk analysis for npm packages and dependency trees",
"type": "module",
"keywords": [
Expand Down
13 changes: 0 additions & 13 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 7 additions & 2 deletions src/domain/metadata-field-state.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,9 @@ export interface MetadataFieldState<T> {
* these helpers instead of inferring meaning directly from `null` or `false`.
*
* This contract distinguishes between "observed absence" and "not collected yet".
* Fields that are not currently ingested MUST return `unavailable`, not
* `observed_absent`.
* Observed absence means the system actually checked the field and confirmed
* that the value is absent or clean. Fields that are not currently ingested
* MUST return `unavailable`, not `observed_absent`.
*
* `observed_absent` is part of the contract for fields that are explicitly
* checked clean, but current advisory ingestion does not produce that state yet.
Expand All @@ -54,6 +55,10 @@ export function observedPresentMetadataFieldState<T>(value: T): MetadataFieldSta
/**
* Creates a state representing an observed explicit absence.
*
* Use this only when DepGraph actually checked the field and confirmed the
* absence. Fields that are not ingested yet must return `unavailable`, not
* `observed_absent`.
*
* @param value Field value that encodes a checked-clean or otherwise observed absence.
* @returns Metadata field state marked as observed absent.
*/
Expand Down
Loading