@chipschat/protocol 0.0.0-stage → 1.0.1

package/dist/src/events/workspace.d.ts

@@ -0,0 +1,222 @@
+/**
+ * Events Chips records about itself.
+ *
+ * Agent Connect is the vocabulary a harness speaks. It is not the whole log. Decision 4 says
+ * every Agent Connect event **and every human action** is an event, and creating a space
+ * or adding somebody to one is a human action. Without these, `spaces` and `memberships`
+ * would be read models that no replay could reconstruct — which would make `rebuild` a lie.
+ *
+ * These never travel to a harness, with three exceptions: `space.updated` is also something a
+ * harness sends, for a space it opened itself (M3.3); `space.erased` names no space and so goes
+ * to everyone in the workspace, a harness included, which is how an adapter learns to forget a
+ * room it had cached (ADR 0067); and a `space.created` that asks a harness into a new room goes
+ * to that harness, which answers with `space.claimed` through its own door. A harness learns that
+ * it was added to a space from `message.new`, not from here. See ADR 0018 for the line between
+ * what is event-sourced and what is a registry.
+ */
+/** Why an agent left a room (ADR 0087): the moment table's reasons, and a person's removal. */
+export declare const RELEASE_REASONS: readonly ["archived", "deleted", "moved", "agent_archived", "removed", "agent_deleted"];
+export type ReleaseReason = (typeof RELEASE_REASONS)[number];
+export declare const spaceCreated: import("../envelope.js").EventDefinition<"space.created">;
+export declare const spaceClaimed: import("../envelope.js").EventDefinition<"space.claimed">;
+export declare const spaceUpdated: import("../envelope.js").EventDefinition<"space.updated">;
+/**
+ * A space erased from the server (ADR 0067): its events, its rows, its files and its search
+ * entries are gone, and this is the one line the log keeps about it. It carries no `space_id`
+ * in its envelope on purpose — an event that names a space brings that space back on any device
+ * that folds it — so every device in the workspace is sent it, and each drops the rooms it names.
+ */
+export declare const spaceErased: import("../envelope.js").EventDefinition<"space.erased">;
+export declare const membershipAdded: import("../envelope.js").EventDefinition<"membership.added">;
+export declare const membershipRemoved: import("../envelope.js").EventDefinition<"membership.removed">;
+/**
+ * An agent put in a room (ADR 0087): added, moved in, brought back by an unarchive, or in its
+ * harness's place. Chips writes it beside the membership. Its `space_id` is the room; the room is
+ * sent it, and so is the agent's harness, with the room's last lines before it joined (ADR 0088,
+ * point 5).
+ */
+export declare const agentAttached: import("../envelope.js").EventDefinition<"agent.attached">;
+/**
+ * An agent taken out of its room (ADR 0087): by an archive, a delete, a move, its being archived
+ * or deleted (ADR 0095), or a person. Its `space_id` is the room it left; the room is sent it, and so is
+ * the agent's harness, which is out of the room by then. The room an archive took it from is
+ * remembered, so an unarchive brings it back while it is still free.
+ */
+export declare const agentReleased: import("../envelope.js").EventDefinition<"agent.released">;
+/**
+ * A person asks an agent's harness for a copy of it in a room (ADR 0087, Fork). Its `space_id` is
+ * the room the copy is for; the room is sent it, and so is the agent's harness, which copies the
+ * agent and registers the copy with `forked_from` and this room. The room says it is forking
+ * until the copy joins, and that the harness didn't make it once `FORK_WAIT_MS` has passed.
+ */
+export declare const agentFork: import("../envelope.js").EventDefinition<"agent.fork">;
+/**
+ * A person asks a harness for a new agent in a room (ADR 0108): Fork's ask with no agent to copy.
+ * Its `space_id` is the room; the room is sent it, and so is the harness asked, which is in no
+ * room itself. The harness makes an agent that remembers nothing from elsewhere and registers it
+ * with `made_for` (this event's id) and the room, where Chips puts it. The room says it is asking
+ * until the agent joins, and that the harness didn't make it once `NEW_AGENT_WAIT_MS` has passed.
+ */
+export declare const agentAsked: import("../envelope.js").EventDefinition<"agent.asked">;
+/**
+ * What an agent said while in no room (ADR 0087, rule 6): kept by Chips, not shown anywhere, and
+ * posted in the next room it is attached to, oldest first.
+ */
+export declare const messageHeld: import("../envelope.js").EventDefinition<"message.held">;
+/**
+ * A person pauses the agents in a room, or lets them carry on (ADR 0097). While paused, every
+ * message an agent sends an agent there is held, as at the referee's ceiling. Carrying on is a
+ * person acting in the room, so the count starts again and what was held is handed over; pausing
+ * is not, so the count stands.
+ *
+ * Or Chips pauses them, with `why: "spend"`, when the room's job reaches what the room allows a
+ * job (ADR 0118); the actor is the system, and `spend` says how far it got. Carrying on is then a
+ * new job, with the room's whole ceiling again.
+ */
+export declare const exchangeSet: import("../envelope.js").EventDefinition<"exchange.set">;
+/**
+ * A message Chips held from the agents it named (ADR 0097), handed to one of them now a person has
+ * acted: the newest held message for each agent, once. The agent's harness is sent it as
+ * `message.new`, the message's own words with `handed: true`; the room marks the message handed.
+ *
+ * Or, with `lead` (ADR 0104), an agent's message that was nobody's turn, handed to the room's lead
+ * once the room went still: nobody working, and nothing for anybody to answer. The lead's harness
+ * is sent it as `message.new` with `handed` and `lead`, and its note says why; the room shows one
+ * quiet line under the message.
+ */
+export declare const messageHanded: import("../envelope.js").EventDefinition<"message.handed">;
+/**
+ * An agent had nothing to say (ADR 0105): it posted `NO_REPLY` and nothing else, which Chips records
+ * as this rather than as a message, so nobody is shown it and no agent is handed it. Its actor is
+ * the agent, in the room the post was for, on the run it was said on when it had one.
+ */
+export declare const turnPassed: import("../envelope.js").EventDefinition<"turn.passed">;
+/**
+ * An agent's context compacted (ADR 0146): its harness's copy of its context window says it
+ * compacted since the last, so Chips writes one quiet line in the room the agent is in, to say why
+ * it may have forgotten details. Its actor is the agent; the numbers are the harness's.
+ */
+export declare const contextCompacted: import("../envelope.js").EventDefinition<"context.compacted">;
+/**
+ * Who leads a room (ADR 0104): the agent that hands out the work there, and that Chips hands what
+ * was nobody's turn once the room goes still. A person in the room chooses it, or takes it away;
+ * a room asked of a harness from the + is led, from its claim, by the agent that claimed it. One
+ * at a time, and an agent that leaves the room leads it no more.
+ */
+export declare const spaceLeadSet: import("../envelope.js").EventDefinition<"space.lead_set">;
+/**
+ * What a room allows a job (ADR 0117): the most its agents' runs may spend after the last thing a
+ * person did there before Chips holds them. The workspace's owner, in the room, sets it, or sets
+ * it back to the default (ADR 0196); `null` is the default, so a room that never chose follows it.
+ */
+export declare const spaceSpendCeilingSet: import("../envelope.js").EventDefinition<"space.spend_ceiling_set">;
+/**
+ * A room's changes locked or let go (ADR 0156): while they are locked, no person renames, archives
+ * or deletes it. A person in the room who is not a guest sets it; a room that never chose is not
+ * locked. A harness's own rename or close of a room it opened still lands, so that what it keeps
+ * and what Chips shows stay one.
+ */
+export declare const spaceLockSet: import("../envelope.js").EventDefinition<"space.lock_set">;
+/**
+ * A harness's agent, made or found by its key (ADR 0087): who the harness takes part in rooms as.
+ * A harness registers its own; the upgrade registers one for each room a harness was in before
+ * agents, as the system. Registering a key again is `agent.updated`, not this.
+ */
+export declare const agentRegistered: import("../envelope.js").EventDefinition<"agent.registered">;
+/**
+ * An agent's name, state, face or Main changed: renamed by its harness, archived with the thing it
+ * is, renamed or given a face by a person (ADR 0089, ADR 0091), archived or unarchived by a person
+ * (ADR 0095), or made its harness's Main agent in place of another (ADR 0183). With a person as
+ * the actor, its harness archives or restores its own side.
+ */
+export declare const agentUpdated: import("../envelope.js").EventDefinition<"agent.updated">;
+/**
+ * An agent deleted by a person (ADR 0095): gone from every list, for everybody. What it said stays
+ * in the rooms it was in, under its name and face, as a removed harness's words do (ADR 0078). It
+ * has been taken out of its room already. Its harness deletes its own side, and Chips refuses
+ * anything that would bring it back or speak as it.
+ */
+export declare const agentDeleted: import("../envelope.js").EventDefinition<"agent.deleted">;
+/**
+ * An agent's changes locked or let go (ADR 0199): while they are locked, no person renames,
+ * archives or deletes it. Its harness's owner, or an owner or admin of the workspace, sets it; an
+ * agent that never chose is not locked. A harness's own archive of its agent still lands, so that
+ * what it keeps and what Chips shows stay one. Told to the people who read the whole directory,
+ * never to a harness.
+ */
+export declare const agentLockSet: import("../envelope.js").EventDefinition<"agent.lock_set">;
+/**
+ * One member of a room taking another's place (ADR 0087, point 9): a harness's agent in the room
+ * the harness was in itself. What the one said there is the other's from then on, on every screen
+ * and in the agent's history; the log keeps what was sent.
+ */
+export declare const membershipReplaced: import("../envelope.js").EventDefinition<"membership.replaced">;
+export declare const attachmentFetched: import("../envelope.js").EventDefinition<"attachment.fetched">;
+/**
+ * A push that moved a room's project forward (ADR 0220): who pushed, from where to where, the
+ * newest commit's first line and the files it changed. Written by Chips after git takes the push,
+ * for every push that moves `main`. It shows no line of its own: a change goes with the reply
+ * that made it (ADR 0222).
+ */
+export declare const projectChanged: import("../envelope.js").EventDefinition<"project.changed">;
+export { type WorkspaceRole, workspaceRole } from "../primitives.js";
+export declare const personJoined: import("../envelope.js").EventDefinition<"person.joined">;
+/**
+ * A person named themselves again (ADR 0082). Their name is the people registry's, as their
+ * joining is (ADR 0018), so this is the change's line in the log: the audit reads it, and every
+ * screen and every harness that keeps names reads them again.
+ */
+export declare const personRenamed: import("../envelope.js").EventDefinition<"person.renamed">;
+/**
+ * A person chose the face they wear (ADR 0139): a mark from Chips' library, or a letter or two, on
+ * one of its grounds, in place of the initials of their name; or the initials back. It is theirs
+ * and one for everybody, as an agent's is (ADR 0089), so it is the log's: the directory carries
+ * it, and every screen that draws them reads it again. A harness is not sent it: it draws nobody.
+ */
+export declare const personFaceSet: import("../envelope.js").EventDefinition<"person.face_set">;
+export declare const roleChanged: import("../envelope.js").EventDefinition<"role.changed">;
+export declare const harnessTransferred: import("../envelope.js").EventDefinition<"harness.transferred">;
+/**
+ * A harness taken out of the workspace (ADR 0078). Its tokens are withdrawn and it is marked
+ * removed in the registry, which is the truth for it, as with a handing-on (ADR 0023). This is the
+ * line the audit and the screens read, and the one that stops its homes being homes: a replay
+ * clears them again, so a rebuild agrees with the live server.
+ */
+export declare const harnessRemoved: import("../envelope.js").EventDefinition<"harness.removed">;
+/**
+ * A person taken out of the workspace by an owner or admin (ADR 0160), or gone by deleting their own
+ * account (ADR 0243), when `removed_by` is themselves. Their devices, passkeys, pairing codes and
+ * open invites are withdrawn and the registry marks them removed, which is the truth for them, as
+ * for a removed harness (ADR 0078); each room they were in has its own `membership.removed` beside
+ * this. What they said stays, under their name. Coming back takes a new invite, which makes a new
+ * person.
+ */
+export declare const personRemoved: import("../envelope.js").EventDefinition<"person.removed">;
+export declare const joinAllowed: import("../envelope.js").EventDefinition<"join.allowed">;
+export declare const joinDenied: import("../envelope.js").EventDefinition<"join.denied">;
+export declare const messageEdited: import("../envelope.js").EventDefinition<"message.edited">;
+export declare const messageDeleted: import("../envelope.js").EventDefinition<"message.deleted">;
+export declare const messageHidden: import("../envelope.js").EventDefinition<"message.hidden">;
+export declare const messageShown: import("../envelope.js").EventDefinition<"message.shown">;
+export declare const messagePinned: import("../envelope.js").EventDefinition<"message.pinned">;
+export declare const messageUnpinned: import("../envelope.js").EventDefinition<"message.unpinned">;
+export declare const approvalRouted: import("../envelope.js").EventDefinition<"approval.routed">;
+export declare const attachmentLimitsSet: import("../envelope.js").EventDefinition<"attachment.limits_set">;
+export declare const exchangeLimitsSet: import("../envelope.js").EventDefinition<"exchange.limits_set">;
+/**
+ * The workspace named again by an owner (ADR 0194). Its name is the registry's, as a person's is
+ * (ADR 0018), so this is the change's line in the log: every device that is connected takes the
+ * new name from it at once, as a device that connects later takes it from the hello (ADR 0193),
+ * and the audit says who renamed it.
+ */
+export declare const workspaceRenamed: import("../envelope.js").EventDefinition<"workspace.renamed">;
+/**
+ * The relay turned off or on by an owner (ADR 0211, Phase 4). The switch is the server's
+ * registry's, as a workspace's name is, so this is the change's line in the log: every device
+ * connected hears it, those on the relay before it goes, and can say why they cannot connect
+ * after; and the audit says who.
+ */
+export declare const relaySet: import("../envelope.js").EventDefinition<"relay.set">;
+/** Every event Chips records about a workspace, in the order the reference lists them. */
+export declare const WORKSPACE_EVENTS: readonly [import("../envelope.js").EventDefinition<"space.created">, import("../envelope.js").EventDefinition<"space.updated">, import("../envelope.js").EventDefinition<"space.claimed">, import("../envelope.js").EventDefinition<"space.erased">, import("../envelope.js").EventDefinition<"membership.added">, import("../envelope.js").EventDefinition<"membership.removed">, import("../envelope.js").EventDefinition<"membership.replaced">, import("../envelope.js").EventDefinition<"agent.registered">, import("../envelope.js").EventDefinition<"agent.updated">, import("../envelope.js").EventDefinition<"agent.deleted">, import("../envelope.js").EventDefinition<"agent.lock_set">, import("../envelope.js").EventDefinition<"agent.attached">, import("../envelope.js").EventDefinition<"agent.released">, import("../envelope.js").EventDefinition<"agent.fork">, import("../envelope.js").EventDefinition<"agent.asked">, import("../envelope.js").EventDefinition<"message.held">, import("../envelope.js").EventDefinition<"exchange.set">, import("../envelope.js").EventDefinition<"message.handed">, import("../envelope.js").EventDefinition<"space.lead_set">, import("../envelope.js").EventDefinition<"space.spend_ceiling_set">, import("../envelope.js").EventDefinition<"space.lock_set">, import("../envelope.js").EventDefinition<"turn.passed">, import("../envelope.js").EventDefinition<"context.compacted">, import("../envelope.js").EventDefinition<"attachment.fetched">, import("../envelope.js").EventDefinition<"project.changed">, import("../envelope.js").EventDefinition<"person.joined">, import("../envelope.js").EventDefinition<"person.renamed">, import("../envelope.js").EventDefinition<"person.face_set">, import("../envelope.js").EventDefinition<"role.changed">, import("../envelope.js").EventDefinition<"harness.transferred">, import("../envelope.js").EventDefinition<"harness.removed">, import("../envelope.js").EventDefinition<"person.removed">, import("../envelope.js").EventDefinition<"join.allowed">, import("../envelope.js").EventDefinition<"join.denied">, import("../envelope.js").EventDefinition<"message.edited">, import("../envelope.js").EventDefinition<"message.deleted">, import("../envelope.js").EventDefinition<"message.hidden">, import("../envelope.js").EventDefinition<"message.shown">, import("../envelope.js").EventDefinition<"message.pinned">, import("../envelope.js").EventDefinition<"message.unpinned">, import("../envelope.js").EventDefinition<"approval.routed">, import("../envelope.js").EventDefinition<"attachment.limits_set">, import("../envelope.js").EventDefinition<"exchange.limits_set">, import("../envelope.js").EventDefinition<"workspace.renamed">, import("../envelope.js").EventDefinition<"relay.set">];
+//# sourceMappingURL=workspace.d.ts.map

package/dist/src/events/workspace.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace.d.ts","sourceRoot":"","sources":["../../../src/events/workspace.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAmBH,+FAA+F;AAC/F,eAAO,MAAM,eAAe,yFAOlB,CAAC;AACX,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAQ7D,eAAO,MAAM,YAAY,2DAmDvB,CAAC;AAEH,eAAO,MAAM,YAAY,2DAwBvB,CAAC;AAEH,eAAO,MAAM,YAAY,2DA6BvB,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,WAAW,0DA0BtB,CAAC;AAEH,eAAO,MAAM,eAAe,8DAgD1B,CAAC;AAEH,eAAO,MAAM,iBAAiB,gEAyB5B,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,aAAa,4DA4BxB,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,aAAa,4DAwBxB,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,SAAS,wDAapB,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,yDAoBrB,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,WAAW,0DAgBtB,CAAC;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,0DAqBtB,CAAC;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,4DAiBxB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,UAAU,yDAWrB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,+DAc3B,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,YAAY,4DAWvB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,qEAW/B,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,YAAY,4DAcvB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,eAAe,8DA4B1B,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,YAAY,2DAoCvB,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,YAAY,2DAsBvB,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,4DAevB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,iEAW7B,CAAC;AAEH,eAAO,MAAM,iBAAiB,gEAY5B,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,cAAc,6DAQzB,CAAC;AAIH,OAAO,EAAE,KAAK,aAAa,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAErE,eAAO,MAAM,YAAY,2DAgBvB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,aAAa,4DAYxB,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,aAAa,6DAexB,CAAC;AAEH,eAAO,MAAM,WAAW,0DAWtB,CAAC;AAEH,eAAO,MAAM,kBAAkB,iEAa7B,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,cAAc,6DAuBzB,CAAC;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,4DA8BxB,CAAC;AAmBH,eAAO,MAAM,WAAW,0DAuBtB,CAAC;AAEH,eAAO,MAAM,UAAU,yDAOrB,CAAC;AAEH,eAAO,MAAM,aAAa,4DAWxB,CAAC;AAEH,eAAO,MAAM,cAAc,6DAWzB,CAAC;AAEH,eAAO,MAAM,aAAa,4DAUxB,CAAC;AAEH,eAAO,MAAM,YAAY,2DAQvB,CAAC;AAEH,eAAO,MAAM,aAAa,4DAOxB,CAAC;AAEH,eAAO,MAAM,eAAe,8DAO1B,CAAC;AAEH,eAAO,MAAM,cAAc,6DAyDzB,CAAC;AAKH,eAAO,MAAM,mBAAmB,mEAgB9B,CAAC;AAEH,eAAO,MAAM,iBAAiB,iEAgC5B,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,+DAW3B,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,uDAUnB,CAAC;AAEH,0FAA0F;AAC1F,eAAO,MAAM,gBAAgB,4qFA8CnB,CAAC"}