DSH familySearch GitHub

plugin / Classic

plugin-dsh-batchstate

Holds the state of an open batch

0.2.1 plugin Classic

Facts

Package
@playform/plugin-dsh-batchstate
Version
0.2.1
Kind
plugin
Release
Classic
Licence
CC0-1.0
Directory
Classic/packages/plugin-dsh-batchstate

What it does

Holds the state of an open batch.

Read the full description in the README.

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.

session 7c41e0a2 | deepseek-v4.1-flash | max | 3 turns | 9 steps | 40 records | simulated

*emit~waterfall=serial>parallel

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.

Turn 1Read the specimens14 records | 3 steps

Step 12 calls, 265 chars

Step 24 calls, 313 chars

Step 33 calls, 153 chars

Turn 2Write the run13 records | 3 steps

Step 43 calls, 174 chars

Step 52 calls, 258 chars

Step 62 calls, 115 chars

Turn 3Repair the run13 records | 3 steps

Step 72 calls, 143 chars

Step 83 calls, 184 chars

Step 92 calls, 123 chars

The turn

The same 3 calls on every plugin page, so a reader who moves between plugins stays in the same frame.

The 3 calls every plugin page shares, in sequence order
SeqCallOutcome
20bash ls -laok
21write src/index.tsok
22read src/index.tsok

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.

  1. 01
    1. seam the write API: setTask, setStatus, setScope, queue, setGate, clear
    why

    The parent's activations and the agents' phase reports flow through the plugin.

  2. 02
    emit batch/state-change
    why

    Every change is an event the plugin owns.

  3. 03
    persist the full state
    why

    The storage domain first, and the JSON file only when no domain opens.

  4. 04
    compile the block from the state
    why

    Pure functions, recompiled on every change.

  5. 05
    1. seam agent/inbox/spliced, or the live agent/inbox/inserted
    why

    A batch proposal or decision arrives as text.

  6. 06
    parse the first block, and de-duplicate on the message id
  7. 07
    branch the message carries no batch block
    why

    Ordinary messages are silence.

  8. 08
    project the proposal or the decision into the board
    why

    The queue line is read from the queue service, never recomputed.

  9. 09
    store 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.

The surfaces plugin-dsh-batchstate registers
KindNameWhat
servicebatchstate(the read API listed above) is the only programmatic surface.
toolis noThere is no tool and no file write beyond the JSON fallback state file and the ledger.

Install

The package as the profile adds it.

Install sh
pnpm add @playform/plugin-dsh-batchstate

Configuration

Every knob this plugin documents, with its default.

Configuration of plugin-dsh-batchstate
FieldTypeDefaultMeaning
enabledfalsethe master switch (IDLE-forever posture)
logtruethe ledger switch (shared cell)
logFile~/.dsh/playform/plugin-dsh-batchstate.logthe ledger
batchdefaultthe active batch id
domainbatch_statethe primary KV domain
stateFile~/.dsh/batch-state.jsonthe JSON fallback state file
maxRecent8the recent-activity ring bound
maxProposals16the proposal list bound
policy.*D6 defaultsthe 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 ets-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.

Dependencies of plugin-dsh-batchstate
PackageRole
@playform/lib-dsh-corefamily
@playform/plugin-dsh-factoryfamily

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

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

Source

The package as the repository holds it.

Open the package source

Origin

The files this page was built from, and what each one supplies.

The files this page was read from 5
The files behind https://github.com/PlayForm/DeepSeek/tree/Current/Classic/packages/plugin-dsh-batchstate
FileContributedState
package.jsonThe name, the version, the private flag, and the dependencies.read
README.mdThe summary, the surface table, and the configuration table.read
CHANGELOG.mdThe release lines and their versions.read
cordis.patch.ymlActivation: the bundle entry that mounts the plugin.read
Source/Function/Apply.tsThe 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.