logical.STATUSESconstno test imports itconst STATUSES: readonly ["not-applicable", "pass", "accepted", "pending", "warn", "gap", "fail", "error"]A status, from the one that says least to the one that says most (the order of join).
The documents of the logical layer (0003-grc-logical): result, finding, evidence, attestation, assessment, risk, a ledger entry and an evidence manifest, each a kind of the envelope; the statuses a result may have and the order in which they join.
The status gap (a control that nothing shows) and pending (a question a person has not yet answered) are unaligned: no outside standard defines them.
logical.STATUSESconstno test imports itconst STATUSES: readonly ["not-applicable", "pass", "accepted", "pending", "warn", "gap", "fail", "error"]A status, from the one that says least to the one that says most (the order of join).
logical.Statustypeno test imports ittype Status = (typeof STATUSES)[number];A status.
logical.resultconstno test imports itconst result: DocumentKind<Document & { readonly check: string; readonly controls: readonly string[]; readonly subject: … (627 characters)const result: DocumentKind<Document & { readonly check: string; readonly controls: readonly string[]; readonly subject: string; readonly status: "accepted" | "error" | "fail" | "gap" | "not-applicable" | "pass" | "pending" | "warn"; readonly severity: "critical" | "high" | "info" | "low" | "medium"; readonly reason: string; readonly observedAt: string; } & { readonly value?: Json | undefined; readonly via?: string | undefined; readonly policy?: string | undefined; readonly exception?: string | undefined; readonly was?: "accepted" | "error" | "fail" | "gap" | "not-applicable" | "pass" | "pending" | "warn" | undefined; }>What a check run on a subject gave.
logical.Resulttypeno test imports ittype Result = Decoded<typeof result.decode>;A result.
logical.findingconstno test imports itconst finding: DocumentKind<Document & { readonly result: string; readonly check: string; readonly controls: readonly st… (506 characters)const finding: DocumentKind<Document & { readonly result: string; readonly check: string; readonly controls: readonly string[]; readonly subject: string; readonly status: "accepted" | "error" | "fail" | "gap" | "not-applicable" | "pass" | "pending" | "warn"; readonly severity: "critical" | "high" | "info" | "low" | "medium"; readonly title: string; readonly detail: string; readonly evidence: readonly string[]; } & { readonly remediation?: string | undefined; readonly exception?: string | undefined; }>A result that needs attention.
logical.Findingtypeno test imports ittype Finding = Decoded<typeof finding.decode>;A finding.
logical.evidenceconstno test imports itconst evidence: DocumentKind<Document & { readonly subject: string; readonly type: string; readonly digest: string; readonly mediaType: string; readonly size: number; readonly observedAt: string; } & { readonly store?: string | undefined; readonly producer?: string | undefined; }>What was observed, kept by digest.
logical.Evidencetypeno test imports ittype Evidence = Decoded<typeof evidence.decode>;An item of evidence.
logical.attestationconstno test imports itconst attestation: DocumentKind<Document & { readonly subject: string; readonly check: string; readonly claim: "fail" | "pass"; readonly statement: string; readonly attester: string; readonly role: string; readonly evidence: readonly string[]; } & { readonly signature?: string | undefined; readonly signer?: string | undefined; }>A person or key states something about a subject.
logical.Attestationtypeno test imports ittype Attestation = Decoded<typeof attestation.decode>;An attestation.
logical.riskconstno test imports itconst risk: DocumentKind<Document & { readonly title: string; readonly description: string; readonly likelihood: "high" … (476 characters)const risk: DocumentKind<Document & { readonly title: string; readonly description: string; readonly likelihood: "high" | "low" | "moderate" | "very-high" | "very-low"; readonly impact: "high" | "low" | "moderate" | "very-high" | "very-low"; readonly level: "high" | "low" | "moderate" | "very-high" | "very-low"; readonly treatment: "accept" | "avoid" | "mitigate" | "transfer"; readonly owner: string; readonly reviewBy: string; readonly controls: readonly string[]; } & {}>A risk.
logical.Risktypeno test imports ittype Risk = Decoded<typeof risk.decode>;A risk.
logical.assessmentconstno test imports itconst assessment: DocumentKind<Document & { readonly title: string; readonly frameworks: readonly (Document & { readonly… (5893 characters)const assessment: DocumentKind<Document & { readonly title: string; readonly frameworks: readonly (Document & { readonly version: string; readonly title: string; readonly controls: readonly ObjectOf<{ id: Decoder<string>; title: Decoder<string>; statement: Decoder<string>; }, { family: Decoder<string>; }>[]; } & { readonly publisher?: string | undefined; readonly source?: string | undefined; })[]; readonly results: readonly (Document & { readonly check: string; readonly controls: readonly string[]; readonly subject: string; readonly status: "accepted" | "error" | "fail" | "gap" | "not-applicable" | "pass" | "pending" | "warn"; readonly severity: "critical" | "high" | "info" | "low" | "medium"; readonly reason: string; readonly observedAt: string; } & { readonly value?: Json | undefined; readonly via?: string | undefined; readonly policy?: string | undefined; readonly exception?: string | undefined; readonly was?: "accepted" | "error" | "fail" | "gap" | "not-applicable" | "pass" | "pending" | "warn" | undefined; })[]; readonly findings: readonly (Document & { readonly result: string; readonly check: string; readonly controls: readonly string[]; readonly subject: string; readonly status: "accepted" | "error" | "fail" | "gap" | "not-applicable" | "pass" | "pending" | "warn"; readonly severity: "critical" | "high" | "info" | "low" | "medium"; readonly title: string; readonly detail: string; readonly evidence: readonly string[]; } & { readonly remediation?: string | undefined; readonly exception?: string | undefined; })[]; readonly evidence: readonly (Document & { readonly subject: string; readonly type: string; readonly digest: string; readonly mediaType: string; readonly size: number; readonly observedAt: string; } & { readonly store?: string | undefined; readonly producer?: string | undefined; })[]; readonly attestations: readonly (Document & { readonly subject: string; readonly check: string; readonly claim: "fail" | "pass"; readonly statement: string; readonly attester: string; readonly role: string; readonly evidence: readonly string[]; } & { readonly signature?: string | undefined; readonly signer?: string | undefined; })[]; readonly exceptions: readonly (Document & { readonly excuses: ObjectOf<{ type: Decoder<"check" | "control" | "policy">; ref: Decoder<string>; }, Record<never, never>>; readonly subjects: readonly string[]; readonly reason: string; readonly approvedBy: string; readonly grantedAt: string; readonly expiresAt: string; } & { readonly acceptedRisk?: ObjectOf<{ owner: Decoder<string>; level: Decoder<"high" | "low" | "moderate" | "very-high" | "very-low">; reviewBy: Decoder<string>; }, Record<never, never>> | undefined; readonly inheritable?: boolean | undefined; })[]; readonly risks: readonly (Document & { readonly title: string; readonly description: string; readonly likelihood: "high" | "low" | "moderate" | "very-high" | "very-low"; readonly impact: "high" | "low" | "moderate" | "very-high" | "very-low"; readonly level: "high" | "low" | "moderate" | "very-high" | "very-low"; readonly treatment: "accept" | "avoid" | "mitigate" | "transfer"; readonly owner: string; readonly reviewBy: string; readonly controls: readonly string[]; } & {})[]; } & { readonly policies?: readonly (Document & { readonly title: string; readonly scope: ObjectOf<{ platforms: Decoder<readonly string[]>; tags: Decoder<readonly string[]>; }, Record<never, never>>; readonly severity: "critical" | "high" | "info" | "low" | "medium"; readonly rationale: string; readonly controls: readonly string[]; readonly checks: readonly string[]; readonly owner: string; readonly review: ObjectOf<{ cadence: Decoder<string>; }, { lastReviewed: Decoder<string>; }>; } & { readonly exceptions?: readonly string[] | undefined; })[] | undefined; readonly checks?: readonly (Document & { readonly ask: string; readonly expect: import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"empty">; }, Record<never, never>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"non-empty">; }, Record<never, never>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"equals">; value: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/grc/src/governance/kinds").Json>; }, Record<never, never>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"count">; }, { min: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; max: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; }> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"every">; field: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; op: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"eq" | "ge" | "gt" | "in" | "le" | "lt" | "matches" | "ne">; value: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/grc/src/governance/kinds").Json>; }, Record<never, never>>; readonly platforms: readonly string[]; readonly freshness: string; readonly controls: readonly string[]; readonly runner: ObjectOf<{ kind: Decoder<string>; input: Decoder<Json>; }, Record<never, never>>; } & { readonly severity?: "critical" | "high" | "info" | "low" | "medium" | undefined; })[] | undefined; }>An assessment: what was judged, with what, and what it gave, self-contained so that a serializer needs nothing else.
logical.Assessmenttypeno test imports ittype Assessment = Decoded<typeof assessment.decode>;An assessment.
logical.ledgerEntryconstno test imports itconst ledgerEntry: DocumentKind<Document & { readonly seq: number; readonly previous: string; readonly type: string; readonly subject: string; readonly evidence: string; readonly digest: string; } & {}>An entry of a hash-chained ledger.
logical.LedgerEntrytypeno test imports ittype LedgerEntry = Decoded<typeof ledgerEntry.decode>;A ledger entry.
logical.evidenceManifestconstno test imports itconst evidenceManifest: DocumentKind<Document & { readonly items: readonly ObjectOf<{ digest: Decoder<string>; size: Decoder<number>; mediaType: Decoder<string>; }, Record<never, never>>[]; readonly ledgerHead: string; } & {}>The manifest of an evidence bundle: what it holds by digest, and where the ledger stood.
logical.EvidenceManifesttypeno test imports ittype EvidenceManifest = Decoded<typeof evidenceManifest.decode>;An evidence manifest.
STATUSESconstconst STATUSES: readonly ["not-applicable", "pass", "accepted", "pending", "warn", "gap", "fail", "error"]A status, from the one that says least to the one that says most (the order of join).
Statustypetype Status = (typeof STATUSES)[number];A status.
resultconstconst result: DocumentKind<Document & { readonly check: string; readonly controls: readonly string[]; readonly subject: … (627 characters)const result: DocumentKind<Document & { readonly check: string; readonly controls: readonly string[]; readonly subject: string; readonly status: "accepted" | "error" | "fail" | "gap" | "not-applicable" | "pass" | "pending" | "warn"; readonly severity: "critical" | "high" | "info" | "low" | "medium"; readonly reason: string; readonly observedAt: string; } & { readonly value?: Json | undefined; readonly via?: string | undefined; readonly policy?: string | undefined; readonly exception?: string | undefined; readonly was?: "accepted" | "error" | "fail" | "gap" | "not-applicable" | "pass" | "pending" | "warn" | undefined; }>What a check run on a subject gave.
Resulttypetype Result = Decoded<typeof result.decode>;A result.
findingconstconst finding: DocumentKind<Document & { readonly result: string; readonly check: string; readonly controls: readonly st… (506 characters)const finding: DocumentKind<Document & { readonly result: string; readonly check: string; readonly controls: readonly string[]; readonly subject: string; readonly status: "accepted" | "error" | "fail" | "gap" | "not-applicable" | "pass" | "pending" | "warn"; readonly severity: "critical" | "high" | "info" | "low" | "medium"; readonly title: string; readonly detail: string; readonly evidence: readonly string[]; } & { readonly remediation?: string | undefined; readonly exception?: string | undefined; }>A result that needs attention.
Findingtypeno test imports ittype Finding = Decoded<typeof finding.decode>;A finding.
evidenceconstconst evidence: DocumentKind<Document & { readonly subject: string; readonly type: string; readonly digest: string; readonly mediaType: string; readonly size: number; readonly observedAt: string; } & { readonly store?: string | undefined; readonly producer?: string | undefined; }>What was observed, kept by digest.
Evidencetypeno test imports ittype Evidence = Decoded<typeof evidence.decode>;An item of evidence.
attestationconstconst attestation: DocumentKind<Document & { readonly subject: string; readonly check: string; readonly claim: "fail" | "pass"; readonly statement: string; readonly attester: string; readonly role: string; readonly evidence: readonly string[]; } & { readonly signature?: string | undefined; readonly signer?: string | undefined; }>A person or key states something about a subject.
Attestationtypetype Attestation = Decoded<typeof attestation.decode>;An attestation.
riskconstconst risk: DocumentKind<Document & { readonly title: string; readonly description: string; readonly likelihood: "high" … (476 characters)const risk: DocumentKind<Document & { readonly title: string; readonly description: string; readonly likelihood: "high" | "low" | "moderate" | "very-high" | "very-low"; readonly impact: "high" | "low" | "moderate" | "very-high" | "very-low"; readonly level: "high" | "low" | "moderate" | "very-high" | "very-low"; readonly treatment: "accept" | "avoid" | "mitigate" | "transfer"; readonly owner: string; readonly reviewBy: string; readonly controls: readonly string[]; } & {}>A risk.
Risktypetype Risk = Decoded<typeof risk.decode>;A risk.
assessmentconstconst assessment: DocumentKind<Document & { readonly title: string; readonly frameworks: readonly (Document & { readonly… (5893 characters)const assessment: DocumentKind<Document & { readonly title: string; readonly frameworks: readonly (Document & { readonly version: string; readonly title: string; readonly controls: readonly ObjectOf<{ id: Decoder<string>; title: Decoder<string>; statement: Decoder<string>; }, { family: Decoder<string>; }>[]; } & { readonly publisher?: string | undefined; readonly source?: string | undefined; })[]; readonly results: readonly (Document & { readonly check: string; readonly controls: readonly string[]; readonly subject: string; readonly status: "accepted" | "error" | "fail" | "gap" | "not-applicable" | "pass" | "pending" | "warn"; readonly severity: "critical" | "high" | "info" | "low" | "medium"; readonly reason: string; readonly observedAt: string; } & { readonly value?: Json | undefined; readonly via?: string | undefined; readonly policy?: string | undefined; readonly exception?: string | undefined; readonly was?: "accepted" | "error" | "fail" | "gap" | "not-applicable" | "pass" | "pending" | "warn" | undefined; })[]; readonly findings: readonly (Document & { readonly result: string; readonly check: string; readonly controls: readonly string[]; readonly subject: string; readonly status: "accepted" | "error" | "fail" | "gap" | "not-applicable" | "pass" | "pending" | "warn"; readonly severity: "critical" | "high" | "info" | "low" | "medium"; readonly title: string; readonly detail: string; readonly evidence: readonly string[]; } & { readonly remediation?: string | undefined; readonly exception?: string | undefined; })[]; readonly evidence: readonly (Document & { readonly subject: string; readonly type: string; readonly digest: string; readonly mediaType: string; readonly size: number; readonly observedAt: string; } & { readonly store?: string | undefined; readonly producer?: string | undefined; })[]; readonly attestations: readonly (Document & { readonly subject: string; readonly check: string; readonly claim: "fail" | "pass"; readonly statement: string; readonly attester: string; readonly role: string; readonly evidence: readonly string[]; } & { readonly signature?: string | undefined; readonly signer?: string | undefined; })[]; readonly exceptions: readonly (Document & { readonly excuses: ObjectOf<{ type: Decoder<"check" | "control" | "policy">; ref: Decoder<string>; }, Record<never, never>>; readonly subjects: readonly string[]; readonly reason: string; readonly approvedBy: string; readonly grantedAt: string; readonly expiresAt: string; } & { readonly acceptedRisk?: ObjectOf<{ owner: Decoder<string>; level: Decoder<"high" | "low" | "moderate" | "very-high" | "very-low">; reviewBy: Decoder<string>; }, Record<never, never>> | undefined; readonly inheritable?: boolean | undefined; })[]; readonly risks: readonly (Document & { readonly title: string; readonly description: string; readonly likelihood: "high" | "low" | "moderate" | "very-high" | "very-low"; readonly impact: "high" | "low" | "moderate" | "very-high" | "very-low"; readonly level: "high" | "low" | "moderate" | "very-high" | "very-low"; readonly treatment: "accept" | "avoid" | "mitigate" | "transfer"; readonly owner: string; readonly reviewBy: string; readonly controls: readonly string[]; } & {})[]; } & { readonly policies?: readonly (Document & { readonly title: string; readonly scope: ObjectOf<{ platforms: Decoder<readonly string[]>; tags: Decoder<readonly string[]>; }, Record<never, never>>; readonly severity: "critical" | "high" | "info" | "low" | "medium"; readonly rationale: string; readonly controls: readonly string[]; readonly checks: readonly string[]; readonly owner: string; readonly review: ObjectOf<{ cadence: Decoder<string>; }, { lastReviewed: Decoder<string>; }>; } & { readonly exceptions?: readonly string[] | undefined; })[] | undefined; readonly checks?: readonly (Document & { readonly ask: string; readonly expect: import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"empty">; }, Record<never, never>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"non-empty">; }, Record<never, never>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"equals">; value: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/grc/src/governance/kinds").Json>; }, Record<never, never>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"count">; }, { min: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; max: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; }> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"every">; field: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; op: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"eq" | "ge" | "gt" | "in" | "le" | "lt" | "matches" | "ne">; value: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/grc/src/governance/kinds").Json>; }, Record<never, never>>; readonly platforms: readonly string[]; readonly freshness: string; readonly controls: readonly string[]; readonly runner: ObjectOf<{ kind: Decoder<string>; input: Decoder<Json>; }, Record<never, never>>; } & { readonly severity?: "critical" | "high" | "info" | "low" | "medium" | undefined; })[] | undefined; }>An assessment: what was judged, with what, and what it gave, self-contained so that a serializer needs nothing else.
Assessmenttypetype Assessment = Decoded<typeof assessment.decode>;An assessment.
ledgerEntryconstno test imports itconst ledgerEntry: DocumentKind<Document & { readonly seq: number; readonly previous: string; readonly type: string; readonly subject: string; readonly evidence: string; readonly digest: string; } & {}>An entry of a hash-chained ledger.
LedgerEntrytypetype LedgerEntry = Decoded<typeof ledgerEntry.decode>;A ledger entry.
evidenceManifestconstno test imports itconst evidenceManifest: DocumentKind<Document & { readonly items: readonly ObjectOf<{ digest: Decoder<string>; size: Decoder<number>; mediaType: Decoder<string>; }, Record<never, never>>[]; readonly ledgerHead: string; } & {}>The manifest of an evidence bundle: what it holds by digest, and where the ledger stood.
EvidenceManifesttypetype EvidenceManifest = Decoded<typeof evidenceManifest.decode>;An evidence manifest.