@jam-overture/loom/testing/contracts

heldProposalFixturefunction

A hold against a real tree.

const heldProposalFixture: (options?: {
    readonly heldAt?: string;
    readonly treeId?: TreeId;
    readonly actor?: string;
    readonly policyFingerprint?: string;
}) => HeldProposal

describeHoldStoreContractfunction

const describeHoldStoreContract: (name: string, makeStore: () => HoldStore | Promise<HoldStore>) => void

sampleEpisodefunction

A whole episode, narrated: an intent, the proposal it produced, the Gate accepting it, and the change landing. Built through recordOf rather than by hand so the suite exercises the narrowing every host will use.

const sampleEpisode: (namespace?: string) => readonly TelemetryRecord[]

describeTelemetryJournalContractfunction

const describeTelemetryJournalContract: (name: string, makeJournal: () => Promise<TelemetryJournal> | TelemetryJournal) => void

ModelSituationtype

What happened, in terms every vendor has rather than one vendor's.

type ModelSituation = 
/** The service answered, with this text, served by this model. */
"answers"
/** The service answered, and there was nothing in the reply that was text. */
 | "answers-without-text"
/** The answer stopped at the output ceiling, mid-sentence. */
 | "truncates"
/** The model declined to answer this content. */
 | "refuses"
/** A credential, entitlement or billing problem: 401, 402, 403. */
 | "refuses-the-caller"
/** The request itself is wrong and would fail again unchanged: 400, 404, 413, 422. */
 | "refuses-the-request"
/** Busy now, fine later: 408, 409, 429, 500, 503. */
 | "asks-for-later"
/** No response at all — a closed socket, a DNS failure, a TLS error. */
 | "never-answers";

MODEL_SITUATIONSvalue

const MODEL_SITUATIONS: readonly ModelSituation[]

CONTRACT_REPLYvalue

The text this suite sends through, and the model it says served it.

const CONTRACT_REPLY: string

CONTRACT_SERVED_BYvalue

const CONTRACT_SERVED_BY = "a-model-that-served-it"

ModelSituationClienttype

A client wired to behave as one situation does, or a statement that this vendor has no such situation.

type ModelSituationClient = (() => ModelClient | Promise<ModelClient>) | "not-expressible";

ModelClientContracttype

type ModelClientContract = Readonly<Record<ModelSituation, ModelSituationClient>>;

contractRequestfunction

The request every case sends. Fixed, because none of these turn on its content.

const contractRequest: () => ModelRequest

describeModelClientContractfunction

const describeModelClientContract: (name: string, contract: ModelClientContract) => void

rowSecurityOnfunction

Whether Postgres has row level security on a table, read from the catalogue rather than inferred from having run the statement.

const rowSecurityOn: (db: LoomDatabase, table: string) => Promise<boolean>

appendOffunction

const appendOf: (delta: TreeDelta, proposal?: string) => AppendRequest

removalOffunction

const removalOf: (tree: LoomTree, nodeId: string, baseRevision?: number) => TreeDelta

treeNamedfunction

const treeNamed: (namespace: string) => LoomTree

describeTreeStoreContractfunction

makeStore returns a store with nothing in it. Each test gets its own, so the suite never depends on the order it runs in.

const describeTreeStoreContract: (name: string, makeStore: () => Promise<TreeStore> | TreeStore) => void