IF Commons GitHub

surfaces/headless/mod

Written to: 6 requirements: 6 proved, 0 partly, 0 failing, 0 with no test recorded. 0007-grc-surface FR-001, 0007-grc-surface FR-002, 0007-grc-surface FR-003, 0007-grc-surface FR-004, 0007-grc-surface FR-005, 0007-grc-surface FR-006

The headless verbs of GRC (0007-grc-surface, 0011-grc-bundles): a branch grc with check, assess, explain, evidence and bundle verify, made with Headless (commons headless 0002-headless-governance, 0003-headless-output) from a host that gives the governance documents, the registries of runners, serializers and the evidence store, and the clock. The branch names no runner and no store.

import { grcBranch } from "@intellectual-frontiers/grc/surfaces/headless";
// programOf({ name: "tool", summary: "A tool.", version: "1", children: [grcBranch(host)] })

Source: commons/grc/src/surfaces/headless/mod.ts

4 of 4 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

GrcHosttype
type GrcHost = { readonly frameworks: readonly Framework[]; readonly crosswalks: readonly Crosswalk[]; readonly po… (620 characters)
type GrcHost = {
  readonly frameworks: readonly Framework[];
  readonly crosswalks: readonly Crosswalk[];
  readonly policies: readonly Policy[];
  readonly checks: readonly Check[];
  readonly requirements: readonly Requirement[];
  readonly exceptions: readonly Exception[];
  readonly subjects: readonly Subject[];
  readonly runners: Runners;
  readonly serializers: Serializers;
  readonly store?: EvidenceStore;
  /** The signers that verify a bundle's signature, by id (`bundle verify --signer`, `dsse` by default). */
  readonly signers?: Signers;
  readonly now: () => string;
  readonly timeoutMs?: number;
};

What the program gives the branch.

Imported by 18 tests of the run (18 passed, 0 failed): the library's results

BUNDLE_CATALOGUEconst
const BUNDLE_CATALOGUE: Readonly<Record<string, Explanation>>

The explanation of every problem code grc bundle verify gives, for grc explain <code>.

BUNDLE_CATALOGUE["E-BUNDLE-ITEM-MISSING"]?.title; // "An item the manifest lists is missing"

Imported by 12 tests of the run (12 passed, 0 failed): the library's results

bundleCatalogueProblemsfunction
function bundleCatalogueProblems(): readonly string[]

The problems of BUNDLE_CATALOGUE, as data: none.

bundleCatalogueProblems(); // []

Imported by 12 tests of the run (12 passed, 0 failed): the library's results

grcBranchfunction
function grcBranch(host: GrcHost): Node

The branch grc.

Imported by 18 tests of the run (18 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.