IF Commons GitHub

physical/entity

Written to: 4 requirements: 4 proved, 0 partly, 0 failing, 0 with no test recorded. 0009-grc-groups FR-002, 0009-grc-groups FR-006, 0009-grc-groups FR-007, 0009-grc-groups FR-010

The ports of one entity of a group (0009-grc-groups): its ledger, its results, its exceptions and its evidence store, which the host resolves for that entity alone, and the reference reader that makes the entity's snapshot from them. A reader takes only its own entity's ports; nothing here names how they are stored or kept apart from another entity's.

import { entityReader } from "./entity.ts";
// const read = entityReader(portsOfUnitA, { frameworks, crosswalks, checks });
// const snapshot = await read("2026-06-01T00:00:00Z");

Source: commons/grc/src/physical/entity.ts

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

physical.EntityPortstypeno test imports it
type EntityPorts = {
  readonly entity: EntityId;
  readonly ledger: { entries(): Promise<readonly LedgerEntry[]> };
  readonly results: { list(): Promise<readonly Outcome[]> };
  readonly exceptions: { list(): Promise<readonly Exception[]> };
  readonly store: EvidenceStore;
};

The ports of one entity, resolved by the host for that entity alone.

physical.GroupMaterialtypeno test imports it
type GroupMaterial = { readonly frameworks: readonly Framework[]; readonly crosswalks: readonly Crosswalk[]; readonly checks: readonly Check[] };

What the group defines once and every entity reads the same.

physical.entityReaderfunctionno test imports it
function entityReader(ports: EntityPorts, material: GroupMaterial): EntityReader

The reference reader of an entity: reads its ledger (a broken chain is malformed), its results and exceptions, and gives the snapshot; any port that fails is unreachable.

// const read = entityReader(ports, { frameworks, crosswalks, checks }); await read("2026-06-01T00:00:00Z");
EntityPortstype
type EntityPorts = {
  readonly entity: EntityId;
  readonly ledger: { entries(): Promise<readonly LedgerEntry[]> };
  readonly results: { list(): Promise<readonly Outcome[]> };
  readonly exceptions: { list(): Promise<readonly Exception[]> };
  readonly store: EvidenceStore;
};

The ports of one entity, resolved by the host for that entity alone.

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

GroupMaterialtype
type GroupMaterial = { readonly frameworks: readonly Framework[]; readonly crosswalks: readonly Crosswalk[]; readonly checks: readonly Check[] };

What the group defines once and every entity reads the same.

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

entityReaderfunction
function entityReader(ports: EntityPorts, material: GroupMaterial): EntityReader

The reference reader of an entity: reads its ledger (a broken chain is malformed), its results and exceptions, and gives the snapshot; any port that fails is unreachable.

// const read = entityReader(ports, { frameworks, crosswalks, checks }); await read("2026-06-01T00:00:00Z");

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

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