@miadi/chronicle-tui 0.4.2 → 0.6.0

package/README.md

@@ -1,8 +1,11 @@
 # @miadi/chronicle-tui
 
-Browse the Miadi Chronicle from a terminal. `miadi-chronicle` lists every
-episode, filters them as you type, searches their text, reads a vessel's
-files, and opens the room, the wheel or the vessel.
+Browse the Miadi Chronicle from a terminal, and take part in its talking
+circles. `miadi-chronicle` lists every episode, filters them as you type,
+searches their text, reads a vessel's files, and opens the room, the wheel or
+the vessel. With your person token it enters the circles you sit in: you read
+the turns and the diary, speak, witness, write in the diary and close a
+ceremony, as yourself.
 
 ```bash
 npm i -g @miadi/chronicle-tui
@@ -22,14 +25,16 @@ On Termux, install with `--ignore-scripts`. Node 22 or later.
 | Tab | title filter or full-text search. In an open file: the next reference (Shift+Tab: the previous one) |
 | ↑ ↓ `j` `k`, PgUp PgDn, `g` `G` | move |
 | Enter, `l`, → | open: an episode's files, a file, a search hit |
-| Enter on a reference | a chronicle reference opens that episode. A ceremony or circle shows its doors |
+| Enter on a reference | a chronicle reference opens that episode. A ceremony or circle opens as your seat allows (else its pages) |
 | Esc, `h`, ← | back |
 | `o` | the doors of the reference, file or episode in focus: room (local, tailnet, public), wheel, vessel. Enter opens one |
 | `r` | the phone door as a QR code (`i` inverts it for a light terminal) |
 | `p` | the five-stage proof (git and the wheel, on demand) |
 | `a` | the episode's attention items, Open and History (Tab), each with what it cites. Enter reads one; Enter again answers an open one |
 | `!` | the chronicle's attention board: every open item, newest asked first, filtered by `/`. `e` on an item opens its episode |
+| `c` | talking circles: the ceremonies held in the episode in focus, the circles gathered for it, yours, the others |
 | `v` | hold a Miadi review in the episode (writer token) |
+| `L` | relate episodes: `L` marks the one in focus, move to the other, `L` again, say why (relates to or continues from, one way or both). Esc forgets the mark |
 | `?` | all keys · `q` quits |
 
 Under 90 columns (a phone, a narrow split) one pane shows at a time: the list
@@ -71,20 +76,58 @@ miadi-chronicle --url https://miadi.tail3b11eb.ts.net
   visitor sees no `community` episode and nothing under `captures/` or
   `ceremonies/`. A reader the app names sees community episodes (◇); a reader
   the app lets write sees the room's private folders too.
-- **A ceremony or circle reference** opens as a card for a person the app
-  seats (`GET /api/ceremony/{id}`, `GET /api/circles/{id}`): its kind,
-  direction, intention, episode or facilitator, and what your seat may do.
-  Never its turns. Otherwise it shows its pages, and never the wheel's record.
+- **A ceremony or circle reference** opens as the ceremony or circle itself
+  for a person the app seats, as its page would. Otherwise it shows its pages,
+  and never the wheel's record.
 - **Attention** works as in the web room, through `@miadi/attention-core`: the
   board (`!`) and each episode's panel (`a`) read the vessels exactly as the
   room does; an answer is checked the same way and posted to
   `POST /api/chronicle/attention`, and the wheel is reported, never assumed.
 - **A review** (`v`) posts to `POST /api/chronicle/episodes/{ref}/reviews`;
   with your person token its talking circle opens in your name.
+- **Lineage** (`L`) is the room's lineage form
+  (`POST /api/chronicle/episodes/{ref}/lineage`): the door writes
+  `episode.yaml`, puts the edge and its words on the wheel, and lands the
+  commit. Offered when the episode door says it would take the write
+  (`capabilities.mint`). The episode card shows what each episode continues
+  from and relates to.
 
 Write actions declare `effect: "write"` and are offered only when the app said
 it would record them.
 
+## Talking circles
+
+`c` opens the circles, from the episode in focus: the ceremonies held in it
+that you may read, the circles gathered for it, the circles you sit in, then
+the others. It is the web's `/circles` and `/ceremony/{id}` pages, through
+their routes:
+
+| where | key | does | route |
+|---|---|---|---|
+| circles | Enter | enter a ceremony, or a circle | `GET /api/circles`, `GET /api/chronicle/episodes/{ref}/wheel` |
+| a circle | Enter, `n` | enter a ceremony; open one (kind, direction, and the episode it binds to) | `GET /api/circles/{id}`, `POST /api/circles/{id}/ceremonies` |
+| a ceremony | Tab | its turns, or its diary | `GET /api/ceremony/{id}`, read again every 10 s |
+| a ceremony | `s` | speak a turn | `POST /api/ceremony/{id}/turns` |
+| a ceremony | `w` | witness the selected turn (not your own, once) | `POST …/turns/{turn}/witness` |
+| a ceremony | `d` | write in the diary, in a phase and a kind | `POST /api/ceremony/{id}/diary` |
+| a ceremony | `x` | close it, with what the circle learned | `POST /api/ceremony/{id}/close` |
+| a ceremony | `e`, `o` | its episode; its pages | |
+
+- **Each act is yours.** A turn, a witness, a diary entry, a close and a new
+  ceremony go with `MIADI_PERSON_TOKEN` as the only bearer: those routes take
+  the act from whoever the bearer is and refuse the writer token. Without a
+  person token, `c` says what to set and sends nothing.
+- **Offered as the page offers it.** Each key appears only when the app's
+  `can` says the route would accept it from you now: a seat in the circle and
+  the role's permission, an open ceremony, a facilitator to close.
+- **A turn is a person's words.** It shows inside its ceremony to a reader the
+  app lets read that ceremony, never in a list (jgwill/Miadi#680, D3). Its
+  text passes the same sanitizer as every file.
+- **Typing a turn.** Enter sends, Esc cancels. A paste arrives whole, line
+  breaks kept. ↑↓ change a choice (a diary phase, a direction) and Tab moves
+  between choices. Learnings for a close go one per line, or separated by
+  ` | `.
+
 ## Safe to point at any chronicle
 
 Chronicle files are written by many agents and people. Every string the
@@ -106,10 +149,11 @@ The browser holds no chronicle rules of its own:
 | references in a file: `miadi-chronicle:`, `miadi-ceremony:`, `miadi-circle:`, `{{ … }}` | `@miadi/inquiry-weave` (`findTextReferences`) |
 | the doors, as OSC 8 links | `@miadi/inquiry-weave` (`resolveForTerminal`, `resolveWheelRefForTerminal`) |
 | the five-stage proof | `@miadi/inquiry-weave` (`episodeDoorStatus`) |
+| circles, ceremonies, turns and the diary | the Miadi app's circle routes, as the person; closings folded into what they close as the web folds them (`lib/ceremony-view.ts`) |
 
-A ceremony or circle shows its addresses only. Ceremonies are private until
-their page sees the reader's seat, so nothing the wheel holds about one is
-read here (jgwill/Miadi#680).
+A ceremony or circle is read only through the app, as the person whose seat
+it is. Ceremonies are private until their page sees the reader's seat, so
+nothing is read from the wheel directly (jgwill/Miadi#680).
 
 Readings are guesses from keywords in an episode's name and title, and an
 episode with no keyword reads by its number's turn of the wheel. The detail
@@ -140,6 +184,8 @@ render(<App root={process.env.MIADI_CHRONICLE_ROOT!} actions={[mine]} />)
 
 An action that changes anything declares `effect: "write"` and calls the
 existing door for it (the episode API, inquiry-weave, the ceremony routes),
-never the files directly. Version 0.1 registers reading actions only.
+never the files directly. A person's acts inside a ceremony (speak, witness,
+the diary, close) are keys of its overlay, offered where the app's `can`
+allows them.
 
 Ref: jgwill/Miadi#706

package/dist/App.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../src/App.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAiD,MAAM,OAAO,CAAA;AAGrE,OAAO,EAIL,KAAK,eAAe,EAGrB,MAAM,cAAc,CAAA;AA0CrB,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,oCAAoC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,+CAA+C;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,4DAA4D;IAC5D,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,gDAAgD;IAChD,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,2CAA2C;IAC3C,OAAO,CAAC,EAAE,SAAS,eAAe,EAAE,CAAA;IACpC,kFAAkF;IAClF,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,sEAAsE;IACtE,QAAQ,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;CAC7B;AAoHD,wBAAgB,GAAG,CAAC,KAAK,EAAE,QAAQ,qBA+9BlC"}
+{"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../src/App.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAiD,MAAM,OAAO,CAAA;AAIrE,OAAO,EAML,KAAK,eAAe,EAIrB,MAAM,cAAc,CAAA;AAmErB,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,oCAAoC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,+CAA+C;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,4DAA4D;IAC5D,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,gDAAgD;IAChD,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,2CAA2C;IAC3C,OAAO,CAAC,EAAE,SAAS,eAAe,EAAE,CAAA;IACpC,kFAAkF;IAClF,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,sEAAsE;IACtE,QAAQ,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;CAC7B;AAuHD,wBAAgB,GAAG,CAAC,KAAK,EAAE,QAAQ,qBAg8ClC"}