breaches · Umwelt docs

Reference/Queries/breaches

breachesquerysince 0.1

Every time a secret was told to someone outside the circle it was shared with.

Command lineTypeScript.NET

Request

umwelt call story.umw breaches '{
  "projectId": "ball",
  "owner": "bob"
}'

Request

const result = await client.breaches({ projectId: 'ball', owner: 'bob' });

Request

var result = engine.Breaches(new BreachesPayload { ProjectId = "ball", Owner = "bob" });

Response

[
  {
    "eventId": "01a1cbd8-63e7-79a2-b499-79f2f92d2d0f",
    "recordId": "ana-heard",
    "position": { "tick": 5 },
    "owner": "bob",
    "recipient": "ana",
    "secretRecordId": "bob-hid",
    "toldBy": "bob"
  }
]

Payload

Field	Type	Description
`projectId`required	string	The project to read.
`owner`	string	Only the secrets kept by this holder.
`at`	Atdefault {}	Where to read: `tick`, an optional `axis`, and `asOfVersion`. Defaults to the latest.
`timelineId`	stringdefault "main"	The timeline to read.

Result

A list of Breach, each with:

Field	Type	Description
`secretRecordId`always	string	The secret Holding.
`owner`always	string	Who keeps the secret.
`toldBy`always	string	Who told it.
`recipient`always	string	Who heard it.
`recordId`always	string	The recipient’s Holding, acquired by being told.
`position`always	Position	Where it was told.
`eventId`always	string	The event it was told in.

Rules

Telling is never blocked. A secret told outside secrecy.sharedWith is recorded, and the write returns the warning SECRET_BREACH. The engine applies no policy.

Second-hand retelling. Someone who heard the secret and tells it again is reached through trace.

Errors

VALIDATION_FAILEDThe payload is malformed.

NOT_FOUNDThe project or timeline does not exist, or the draft read was purged.

INVALID_STATEThe timeline read is a draft that was promoted. details.promotedInto names the timeline to read instead.

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

Payload

Result

Rules

Errors

See also