@miadi/chronicle-tui 0.3.0 → 0.4.0

package/README.md

@@ -27,7 +27,8 @@ On Termux, install with `--ignore-scripts`. Node 22 or later.
 | `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. With the writer token, Enter on an open one answers it |
+| `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 |
 | `v` | hold a Miadi review in the episode (writer token) |
 | `?` | all keys · `q` quits |
 
@@ -53,26 +54,45 @@ miadi-chronicle --env ~/.env.miadi-writer        # a file holding MIADI_API_TOKE
 miadi-chronicle --url https://miadi.tail3b11eb.ts.net
 ```
 
-- **The token** is `MIADI_API_TOKEN_WRITER`, sent as `Authorization: Bearer`.
-  `--env <file>` loads `KEY=value` lines first (`export`, quotes and `#`
-  comments are understood, nothing is expanded), so the file can also set
-  `MIADI_CHRONICLE_ROOT`.
-- **The app** is `--url`, else the first of `MIADI_WEB_URL` (or
-  `127.0.0.1:3335`), `MIADI_URL_BASE_INTERNAL`, `MIADI_URL_BASE` whose
-  `/api/health` answers.
-- **The header** names who the app says is reading (`GET /api/identity/me`),
-  or says `read-only`.
-- **A ceremony or circle reference** opens as a card for a reader the app lets
-  in (`GET /api/ceremony/{id}`, `GET /api/circles/{id}`): its kind, direction,
-  intention, episode or facilitator, and what your seat may do. Never its
-  turns. Anyone else, or a refusal, gets its doors.
-- **Attention** (`a`) lists the episode's items through the app, or from the
-  vessel on disk when no app answers. Answering posts to
-  `POST /api/chronicle/attention`.
-- **A review** (`v`) posts to `POST /api/chronicle/episodes/{ref}/reviews`.
-
-Write actions declare `effect: "write"` and are offered only when the app
-accepted the token.
+- **Two tokens, each for what it is.** `MIADI_PERSON_TOKEN` is you: it is the
+  bearer of every read, so the header names you and a ceremony or circle shows
+  what your seat allows. `MIADI_API_TOKEN_WRITER` passes the write gate: it is
+  the bearer of writes, with you named beside it in `x-miadi-person-token`, as
+  the app expects an agent acting for a person. Either alone does what it can.
+- **`--env <file>`** loads only these keys from a `KEY=value` file (`export`,
+  quotes and `#` comments are understood, nothing is expanded, `PATH` is never
+  touched): the two tokens, `MIADI_CHRONICLE_ROOT`, `MIADI_WEB_URL`,
+  `MIADI_URL_BASE_INTERNAL`, `MIADI_URL_BASE`, `MIADI_CHRONICLE_MW_URL`.
+- **The app** is `--url`, else the local app (`MIADI_WEB_URL` or
+  `127.0.0.1:3335`), then the tailnet one (`MIADI_URL_BASE_INTERNAL`). The
+  public front is used only when named with `--url`. A token travels over
+  https, or plain http to this machine only.
+- **What you see is what the web room would show you** (jgwill/Miadi#712). A
+  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.
+- **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.
+
+Write actions declare `effect: "write"` and are offered only when the app said
+it would record them.
+
+## Safe to point at any chronicle
+
+Chronicle files are written by many agents and people. Every string the
+browser prints goes through one sanitizer: terminal escape sequences, control
+characters and bidi overrides are removed, tabs are expanded, and only
+http(s) and `file:` URLs without controls become links. A door opens through
+the system opener only when it is a web page, or a folder or a text, document
+or media file inside the chronicle; the opener and `rg` never inherit a token.
 
 ## Where each read comes from
 

package/dist/App.d.ts

@@ -1,9 +1,14 @@
 /**
  * The terminal browser's screen. It draws the panes and routes keys; every
- * read goes through `data.ts`, every operation through the action registry.
+ * read goes through `data.ts` and `attention.ts`, every operation through the
+ * action registry, every printed string through `text.ts`.
  *
- * Keys are plain letters, arrows, Tab, Enter and Esc. No Ctrl chord is taken,
- * so tmux (C-b) and herdr (prefix+…) keep all of theirs.
+ * State lives in one ref and is read from there, so keys that arrive together
+ * (fast typing, a paste, ssh) each act on the state the previous one left, not
+ * on the last render (jgwill/Miadi#706 UI review, F5 and F13).
+ *
+ * Keys are plain letters, arrows, Tab, Enter and Esc. No Ctrl or Meta chord is
+ * taken, so tmux (C-b) and herdr (prefix+…) keep all of theirs.
  */
 import React from "react";
 import { type ChronicleAction } from "./actions.js";
@@ -15,10 +20,14 @@ export interface AppProps {
     search?: string;
     /** Start on this episode (number, epNNN or folder name). */
     episode?: string;
+    /** Start on the chronicle's attention board. */
+    attention?: boolean;
     /** Operations beyond the built-in ones. */
     actions?: readonly ChronicleAction[];
-    /** The Miadi app to act through. Default: the first of the known bases that answers. */
+    /** The Miadi app to act through. Default: the local app, then the tailnet one. */
     url?: string;
+    /** Environment keys `--env` loaded: an opener never inherits them. */
+    withheld?: readonly string[];
 }
-export declare function App({ root, query: initialQuery, search: initialSearch, episode, actions: extra, url }: AppProps): React.JSX.Element;
+export declare function App(props: AppProps): React.JSX.Element;
 //# sourceMappingURL=App.d.ts.map

package/dist/App.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../src/App.tsx"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAA+C,MAAM,OAAO,CAAA;AAInE,OAAO,EAAoE,KAAK,eAAe,EAA2B,MAAM,cAAc,CAAA;AAgB9I,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,2CAA2C;IAC3C,OAAO,CAAC,EAAE,SAAS,eAAe,EAAE,CAAA;IACpC,wFAAwF;IACxF,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AA+CD,wBAAgB,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,YAAiB,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,KAAU,EAAE,GAAG,EAAE,EAAE,QAAQ,qBAmqBzH"}
+{"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"}