Add the session view to the trace page. Read the specimens first, then build the lane strip, the tree, the document, and the inspector from one authored run. The family's plugins must be visible on the records they touch, and the page must read the same run with the family off.
plugin / EffectTS
ets-plugin-dsh-batchstate
Holds the state of an open batch
Facts
- Package
- @playform/ets-plugin-dsh-batchstate
- Version
- 0.2.1
- Kind
- plugin
- Release
- EffectTS
- Licence
- CC0-1.0
- Directory
- EffectTS/packages/ets-plugin-dsh-batchstate
What it does
Holds the state of an open batch.
Conversation
The turn as a document: the calls every plugin page shares, what this package changes in them, and the order its work happens in.
Conversational
Lane
The same run as time: one row per resource, a bar per span, and the clock every record shares. A wait is drawn as an outline, because nothing is busy.
Session
The tree, the document, and the inspector read one record list. The switch at the top of the document changes the face they read, and the run changes with it.
The turn
The same 3 calls on every plugin page, so a reader who moves between plugins stays in the same frame.
| Seq | Call | Outcome |
|---|---|---|
20 | bash ls -la | ok |
21 | write src/index.ts | ok |
22 | read src/index.ts | ok |
Flow
The order this package's work happens in, with the branch that decides it inline, transcribed from the source; the rule it obeys is the last band of Architecture.
- 01
- seam the write API: setTask, setStatus, setScope, queue, setGate, clear
why
The parent's activations and the agents' phase reports flow through the plugin.
- 02emit batch/state-change
why
Every change is an event the plugin owns.
- 03persist the full state
why
The storage domain first, and the JSON file only when no domain opens.
- 04compile the block from the state
why
Pure functions, recompiled on every change.
- 05
- seam agent/inbox/spliced, or the live agent/inbox/inserted
why
A batch proposal or decision arrives as text.
- 06parse the first block, and de-duplicate on the message id
- 07branch the message carries no batch block
why
Ordinary messages are silence.
- 08project the proposal or the decision into the board
why
The queue line is read from the queue service, never recomputed.
- 09store the batch_state domain, else ~/.dsh/batch-state.json
Harness
The laws the package states, the line it writes when it loads, the seam the harness dispatches with none of the family, and the surface and knobs a run can set.
Default
What the harness does at this package's seam with none of the family installed, so the surface below has something to be a difference from.
No documented seam
The behavior map does not document a seam for this package, so the page cannot show a default to compare against. It is a library, a base, or a package whose work is a tool rather than a listener.
Surface
Every listener, tool, service, and knob the README documents.
| Kind | Name | What |
|---|---|---|
| service | batchstate | (the read API listed above) is the only programmatic surface. |
| tool | is no | There is no tool and no file write beyond the JSON fallback state file and the ledger. |
Install
The package as the profile adds it.
pnpm add @playform/ets-plugin-dsh-batchstateConfiguration
Every knob this plugin documents, with its default.
| Field | Type | Default | Meaning |
|---|---|---|---|
| enabled | false | the master switch (IDLE-forever posture) | |
| log | true | the ledger switch (shared cell) | |
| logFile | ~/.dsh/playform/plugin-dsh-batchstate.log | the ledger | |
| batch | default | the active batch id | |
| domain | batch_state | the primary KV domain | |
| stateFile | ~/.dsh/batch-state.json | the JSON fallback state file | |
| maxRecent | 8 | the recent-activity ring bound | |
| maxProposals | 16 | the proposal list bound | |
| policy.* | D6 defaults | the per-action allowlist (see above) |
Family
The neighbours at the same seam, the arms beyond it, the twin in the other release tree, and the packages this one needs.
Neighbours
The behavior map documents no seam for this package, so it has no neighbour to name at one.
Arms
The seams its source also registers, beyond the one its README documents.
Its source registers no seam beyond the one its README documents.
Twin
The same package in the other release tree, when one exists.
Its twin is plugin-dsh-batchstate.
It registers the same surface under the other runtime, and the two trees differ in the wiring: the Effect tree returns Effect envelopes where this one returns the dispatch envelope.
Dependencies
The packages this one imports, and whether each one is the family's own.
| Package | Role |
|---|---|
| family | |
| family |
Person
What the person waits for, reads, and never sees.
The person sees the effect of a service another package calls, and the contract itself stays invisible until a caller breaks it.
Its shape machine belongs to Architecture.
Architecture
This plugin's own structure: the shape the portrait gives it, the facts its source documents, and the rule its flow obeys.
Shape
Plugs into the batchstate service, the agent-team inbox splice, and the batch/state-change event.
The live state board of the cooperative batch, compiled on every change and read by every lane.
- The members, their current activity, the queue, and the gates
- The parent's activations and the agents' reports as one write API
- Every change persisted, then compiled into the block a lane reads
- The inbox splice, de-duplicated on the message id
- getState the whole board: the members, the queue, the proposals, and the gates
- getContext one agent's compiled context block
- getScope the surfaces one agent owns
- whoElse the other lanes in the batch
- getProposals the proposals the inbox delivered
- getGates the compiled arbiter truth
- getQueue the queue's own compiled line, read-only
- setGate record the build state and the lane that owns the failure
- setTask record a lane's current activity
- setStatus move a lane between idle, active, completed, failed, and interrupted
- setScope declare the surfaces a lane owns
- queue set a lane's queue position
- clear clear one lane, or the whole board
- the parent's activations, through the write API
- every lane, through the spliced block
- plugin-dsh-queue, read-only for the queue line
Rule The board records and projects, and the service and the spliced block read the live state rather than a copy of it.
Record
The release line, the source, and the files this page was read from.
Release
The versions the package's own changelog records, newest first.
- 0.3.0
- 0.2.1
- 0.2.0
- 0.1.0
Source
The package as the repository holds it.
Origin
The files this page was built from, and what each one supplies.
The files this page was read from 5
| File | Contributed | State |
|---|---|---|
| package.json | The name, the version, the private flag, and the dependencies. | read |
| README.md | The summary, the surface table, and the configuration table. | read |
| CHANGELOG.md | The release lines and their versions. | read |
| cordis.patch.yml | Activation: the bundle entry that mounts the plugin. | read |
| Source/Function/Apply.ts | The listeners, their registration order, and the service the flow calls. | read |
- Data
- The monorepo, read during the build
- Connection
- Build-time read; nothing is fetched at runtime
- Capture
- package.json, README.md, CHANGELOG.md, Source/Function/Apply.ts
Expand provenance source
This page is static. It cannot invoke the plugin, read a ledger, or change a configuration. Every figure comes from those files; a missing README falls back to the manifest's own description, and a package with no surface table shows no surface section.