IF Commons GitHub

surfaces/headless/mod

Written to: 5 requirements: 5 proved, 0 partly, 0 failing, 0 with no test recorded. 0009-integrations-verbs FR-001, 0009-integrations-verbs FR-002, 0009-integrations-verbs FR-003, 0009-integrations-verbs FR-004, 0009-integrations-verbs FR-005

The headless verbs of Integrations (commons integrations 0009-integrations-verbs): integrations observe|probe|check for connectors and integrations validate|translate|send|receive|explain for exchange, as commands of Headless built from the typed cores, with their actions and reach policies declared, their outcome typed, and every outcome passed through the redaction of Headless over the values of the payload so that a payload never appears in what a verb says.

Every effect is a port of Deps: the connectors and the way each reaches its system, the files, the transport of an agreement. A verb is a function of them, so that a test runs it over in-memory ports, and a program (the command line, a tool server, a REST interface) draws the same verbs.

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

4 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.

Depstype
type Deps = { readonly connectors: ReadonlyMap<ConnectorId, Connector>; /** The read port of a connector's system, m… (804 characters)
type Deps = {
  readonly connectors: ReadonlyMap<ConnectorId, Connector>;
  /** The read port of a connector's system, made from its credential reference at the edge. */
  readonly readPort: (c: Connector) => Promise<Result<ReadPort, CredentialError>>;
  readonly plugins: PluginRegistry;
  readonly schemas: ReadonlyMap<string, Schema>;
  readonly terminologies: Terminologies;
  readonly agreements: ReadonlyMap<AgreementId, ExchangeAgreement>;
  readonly readFile: (path: string) => Promise<Result<string, { readonly kind: "not-found" }>>;
  readonly writeFile: (path: string, text: string) => Promise<Result<void, { readonly kind: "not-writable" }>>;
  readonly transportOf: (a: ExchangeAgreement) => Promise<Result<ExchangeTransport, { readonly kind: "no-credential" }>>;
  readonly clock: Clock;
};

Every effect the verbs need, as ports.

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

EXPLANATIONSconst
const EXPLANATIONS: Readonly<Record<FindingCode, string>>

One sentence for each code of a finding: what explain says.

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

integrationsCommandsfunction
function integrationsCommands(deps: Deps): readonly Command[]

The verbs of Integrations.

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

integrationsBranchfunction
function integrationsBranch(deps: Deps): Branch

The program node integrations, with its verbs.

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

acknowledgementStatusconstno test imports it
const acknowledgementStatus: (a: Acknowledgement) => AckStatus

An acknowledgement's status, re-exported for a surface that draws it.

describeFailurefunctionno test imports it
function describeFailure(f: TransportFailure): string

Exhaustive over the ways a delivery fails, for a surface that draws them.

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