strom-research 1.18.0-beta.4 → 1.18.0-beta.5

package/CHANGELOG.cs.md

@@ -7,7 +7,7 @@ Změny každé verze ve zkratce. Úplné poznámky a instalační řádky jsou n
 
 ## 1.18.0
 
-*Připravuje se: bety do 1.18.0-beta.4. Oddíl bude úplný s vydáním.*
+*Připravuje se: bety do 1.18.0-beta.5. Oddíl bude úplný s vydáním.*
 
 - **Fotky z telefonu nastojato.** Fotka otočená podle údaje EXIF se čte tak, jak se má dívat, nastojato; místa na ní
   vyznačená (výřezy, poloviny dvoustrany, uložená část) jsou místa obrázku, jak se ukazuje. Fotka sama zůstává, jak
@@ -21,7 +21,7 @@ Změny každé verze ve zkratce. Úplné poznámky a instalační řádky jsou n
   a osoby, které jmenuje, i s tím, kdo ze stromu to může být. Nic se nedomýšlí: jméno, které v dokumentu není,
   vypadne — i příjmení, nikdy se nebere od otce ani z jiné rodiny —, co nejde přečíst, je označené; druhý čtenář
   může číst naslepo. Do stromu se z toho nic nezapíše samo. Dokument už přečtený to o sobě řekne, takže se omylem
-  nečte podruhé.
+  nečte podruhé. Dokument čtený znovu se ukazuje pod názvem svého souboru, nikdy pod kódem.
 - **Fotky z telefonu.** `strom phone on`, které zapíná jen člověk, pustí k počítači telefon v domácí síti (Wi-Fi
   nebo kabel — nikdy mobilní síť ani VPN). Telefon se jednou spáruje přes QR kód; jeho stránka pak fotí nebo vybírá
   z galerie a posílá fotky celé do stromu výzkumu, s poznámkou a osobou, kterou ukazují — stejně jako „Přidat

package/CHANGELOG.de.md

@@ -7,7 +7,7 @@ Die Änderungen jeder Version in Kürze. Die vollständigen Hinweise und die Ins
 
 ## 1.18.0
 
-*In Vorbereitung: die Betas bis 1.18.0-beta.4. Der Abschnitt ist mit dem Release vollständig.*
+*In Vorbereitung: die Betas bis 1.18.0-beta.5. Der Abschnitt ist mit dem Release vollständig.*
 
 - **Handyfotos aufrecht.** Ein Foto, das nach seiner EXIF-Ausrichtung gedreht ist, wird gelesen, wie es gesehen
   werden soll, aufrecht; die darauf markierten Stellen (Ausschnitte, die Hälften einer Doppelseite, ein gespeicherter
@@ -22,7 +22,8 @@ Die Änderungen jeder Version in Kürze. Die vollständigen Hinweise und die Ins
   samt wem im Stammbaum sie entsprechen können. Nichts wird ergänzt: ein Name, der nicht im Dokument steht, fällt
   weg — auch ein Nachname, nie vom Vater oder aus einer anderen Familie genommen —, Unleserliches wird markiert; ein
   zweiter Leser kann blind lesen. In den Stammbaum gelangt nichts von selbst. Ein schon gelesenes Dokument sagt es,
-  so wird es nicht versehentlich ein zweites Mal gelesen.
+  so wird es nicht versehentlich ein zweites Mal gelesen. Ein erneut gelesenes Dokument wird unter dem Namen seiner
+  Datei gezeigt, nie unter einem Code.
 - **Fotos vom Handy.** `strom phone on`, das nur ein Mensch einschaltet, lässt ein Handy im Heimnetz (WLAN oder
   Kabel — nie ein Mobilfunknetz oder ein VPN) zu diesem Computer. Das Handy wird einmal per QR-Code gekoppelt; seine
   Seite fotografiert dann oder wählt aus der Galerie und schickt die Fotos ganz in einen Stammbaum der Forschung, mit

package/CHANGELOG.md

@@ -7,7 +7,7 @@ The changes of each version in short. The full notes and the install lines are o
 
 ## 1.18.0
 
-*In preparation: the betas up to 1.18.0-beta.4. The section is complete with the release.*
+*In preparation: the betas up to 1.18.0-beta.5. The section is complete with the release.*
 
 - **Phone photos upright.** A photo turned by its EXIF orientation is read as it is meant to be seen, upright; the
   places marked on it (excerpts, the halves of a spread, a cut-out part) are of the picture as it is shown. The
@@ -21,7 +21,8 @@ The changes of each version in short. The full notes and the install lines are o
   old words and abbreviations mean, and the people it names, with who of the tree they may be. Nothing is filled in:
   a name the document does not have is left out — a surname too, never taken from a father or another family —,
   what cannot be read is marked; a second reader can read it blind. Nothing of it enters the tree by itself. A
-  document read already says so, so it is not read a second time by mistake.
+  document read already says so, so it is not read a second time by mistake. A document read again is shown under
+  the name of its file, never a code.
 - **Photos from a phone.** `strom phone on`, turned on by the person alone, lets a phone on the home network (Wi-Fi
   or a cable — never a mobile network or a VPN) reach this computer. The phone is paired once by its QR code; its
   page then takes photos or picks them from the gallery and sends them whole into a tree of the research, with a

package/dist/commands/document.js

@@ -20,7 +20,7 @@ import { addReaders } from "../core/session.js";
 import { READER_MINUTES_HELP } from "../core/reader.js";
 import { stamp } from "../core/net.js";
 import { readers } from "./readers.js";
-import { alive, APP_READ_FROM, backBefore, beforeOf, buildResult, cancelPath, DOC_NEXT, DOC_PAGES, DOC_VIEWS, docPrompt, endState, FINAL_STATES, listReadings, loadState, newReadId, nextVersion, parseRegion, READ_ID, reportPath, resultPath, saveState, SMALL_PX, withoutDocNext, } from "../core/document.js";
+import { alive, APP_READ_FROM, backBefore, beforeOf, buildResult, cancelPath, DOC_NEXT, DOC_PAGES, DOC_VIEWS, docPrompt, endState, FINAL_STATES, listReadings, loadState, newReadId, nextVersion, parseRegion, READ_ID, reportPath, resultPath, saveState, shownName, SMALL_PX, withoutDocNext, } from "../core/document.js";
 /** How often a reading at work looks whether it was cancelled (strom document cancel, from another process). */
 const CANCEL_LOOK_MS = 500;
 /** The image types a document is read from: a photo, a scan, a PDF (HEIC and PDF converted for the reader). */
@@ -73,6 +73,24 @@ function regionsOf(said) {
     }
     return out;
 }
+/** --name [<file>:]<name>: the name each file is shown under in the reading (the first file's without a number). */
+function namesOf(said, files) {
+    const out = new Map();
+    for (const v of Array.isArray(said) ? said : said === undefined ? [] : [said]) {
+        const m = /^(\d{1,2}):(.*)$/su.exec(String(v));
+        const at = m && Number(m[1]) >= 1 && Number(m[1]) <= files ? Number(m[1]) : 1;
+        const name = shownName(m && at === Number(m[1]) ? m[2] : String(v));
+        if (!name)
+            throw new UsageError(`invalid --name "${String(v).slice(0, 60)}"`, { hint: 'the file\'s name as the person knows it: --name "back of the photo.jpg" (the second file\'s: --name 2:<name>)' });
+        out.set(at, name);
+    }
+    return out;
+}
+/** An image's name for a person: the file it came as (its `from`: "the Strom app: x.jpg", "portal · x.jpg"), else its ID — never its hash. */
+function mediaName(m) {
+    const last = m.from?.split(/: | · /u).at(-1)?.trim();
+    return (last && !last.includes(m.sha.slice(0, 12)) && shownName(last)) || m.id;
+}
 function readersOf(said, dflt) {
     if (said === undefined)
         return dflt;
@@ -97,7 +115,7 @@ function filesOf(ctx, tree, args, persons, note) {
             const id = normId(a.trim(), a.trim().toUpperCase().startsWith("M") ? "media" : "input");
             const file = fileOf(tree, shared, id);
             const rec = id.startsWith("M") ? requireRecord(tree, id, "media") : requireRecord(tree, id, "input");
-            records.push({ id, file, name: "name" in rec && rec.name ? rec.name : path.basename(file), ...(rec.sha ? { sha: rec.sha } : {}) });
+            records.push({ id, file, name: rec.type === "input" ? rec.name : mediaName(rec), ...(rec.sha ? { sha: rec.sha } : {}) });
             continue;
         }
         const p = ctx.resolvePath(a);
@@ -442,6 +460,7 @@ register({
         { name: "region", type: "string", multiple: true, value: "[<page>:]x,y,w,h", description: "read only this part of a page: fractions of it from its top left (repeatable, one per page)" },
         { name: "note", type: "string", value: "<text>", description: "what the person says the document is (\"the back of a photo\") — a description only, never names to find" },
         { name: "person", type: "string", multiple: true, value: "<P…>", description: "a person it is of, as the person says (repeatable)" },
+        { name: "name", type: "string", multiple: true, value: "[<file>:]<name>", description: "the name a file is shown under in the reading (default: its input's name, an image's original file name; repeatable, 2:<name> for the second file)" },
         { name: "model", type: "string", value: "<model>", description: "model of the readers (default: model.vision — never weaker for handwriting)" },
         { name: "minutes", type: "string", value: "<n>", description: READER_MINUTES_HELP, mistaken: ["timeout", "time", "time-limit", "max-minutes"] },
         { name: "queue", type: "boolean", description: "keep it to be read later, read nothing now (strom document read D… reads it)" },
@@ -465,6 +484,8 @@ register({
         tree.withTreeLock(() => {
             try {
                 const { records, added } = filesOf(ctx, tree, args, persons, note);
+                for (const [at, name] of namesOf(opts.name, records.length))
+                    records[at - 1].name = name;
                 pages = pagesOf(tree, records, regions);
                 for (const r of new Set(records.map((x) => x.id)))
                     if (r.startsWith("I"))

package/dist/core/document.js

@@ -831,6 +831,10 @@ export function backBefore(s) {
 export function nextVersion(s) {
     return Math.max(s.version, ...s.reports.map((r) => r.version)) + 1;
 }
+/** A file's name for a person: its last part, no control characters, at most 200 characters. */
+export function shownName(name) {
+    return path.basename(name.normalize("NFC").replace(/[\\/]+/gu, "/")).replace(/[\p{Cc}]/gu, "").trim().slice(0, 200);
+}
 /** Whoever asked a reading from the Strom app (its bridge). */
 export const APP_READ_FROM = "app:read";
 export function readsDir(root) {

package/dist/core/live-read.js

@@ -15,7 +15,7 @@ import path from "node:path";
 import { spawn } from "node:child_process";
 import { newerTree, Tree } from "./tree.js";
 import { actsAsArchive } from "./state.js";
-import { APP_READ_FROM, alive, backBefore, buildResult, DOC_PAGES, FINAL_STATES, loadState, parseRegion, READ_ID, readsDir, reportPath, resultPath, saveState, statePath } from "./document.js";
+import { APP_READ_FROM, alive, backBefore, buildResult, DOC_PAGES, FINAL_STATES, loadState, parseRegion, READ_ID, readsDir, reportPath, resultPath, saveState, shownName, statePath } from "./document.js";
 import { knownOriginal } from "./originals.js";
 import { readableTypes } from "./readable.js";
 import { makeView } from "./views.js";
@@ -297,6 +297,8 @@ function notReady(tree, settings, env, seen, now) {
     return undefined;
 }
 const BODY_MAX = 16 * 1024;
+/** The names of files sent to be read kept until they are asked (the last ones). */
+const NAMES_KEPT = 200;
 /**
  * The readings of the app: POST /read, /read/<id>/again, /read/<id>/cancel; GET /read/<id>, /read/<id>/page/<n>.jpg,
  * /reads; the queue read one at a time (tick, each tick of the bridge); what changed, for the event read.
@@ -309,11 +311,26 @@ export class AppReadings {
     starting = new Map();
     told = new Map();
     primed = false;
+    /** The name each file to read came under (X-Strom-Name of its last PUT): a file the research had already keeps its own. */
+    names = new Map();
     b;
     constructor(b) {
         this.b = b;
         this.seen = new ReadingsSeen(b.root, b.env);
     }
+    /** A file sent to be read (PUT /media with X-Strom-Read) under its name in the app: the reading of it shown so (sent with no name: its record's own). */
+    named(sha, name) {
+        this.names.delete(sha);
+        // cleaned as strom document read --name cleans it: nothing left (only slashes, control characters) = no name
+        const shown = name && shownName(name);
+        if (shown)
+            this.names.set(sha, shown);
+        for (const old of this.names.keys()) {
+            if (this.names.size <= NAMES_KEPT)
+                break;
+            this.names.delete(old);
+        }
+    }
     /** A reading of the app at work or queued (the bridge does not end idle meanwhile). */
     active() {
         return this.pending > 0 || this.appStates().some((s) => !FINAL_STATES.includes(s.state));
@@ -508,6 +525,8 @@ export class AppReadings {
         }
         const shared = this.b.settings().shared()?.value;
         const records = [];
+        // each file under the name the app sent it with last, else its record's own (never its hash)
+        const names = [];
         const types = readableTypes(this.b.env);
         for (const f of files) {
             const sha = f.toLowerCase();
@@ -521,13 +540,16 @@ export class AppReadings {
             if (known.bytes > READ_MAX_BYTES)
                 return { code: 413, body: refusal(`larger than a reading takes (${READ_MAX_BYTES / 1024 / 1024} MB)`, "read.large", { sha, mb: String(READ_MAX_BYTES / 1024 / 1024) }) };
             records.push(known.id);
+            const name = this.names.get(sha);
+            if (name)
+                names.push(`--name=${records.length}:${name}`);
         }
         const limited = this.limited();
         if (limited)
             return limited;
         return {
             what: "a reading",
-            args: ["document", "read", ...records, "--queue", "--readers", String(readers), "--into", lang, ...(person ? ["--person", person] : []), ...(note ? [`--note=${note}`] : []), ...(region ? [`--region=${region}`] : [])],
+            args: ["document", "read", ...records, "--queue", "--readers", String(readers), "--into", lang, ...(person ? ["--person", person] : []), ...(note ? [`--note=${note}`] : []), ...(region ? [`--region=${region}`] : []), ...names],
             asked: "read",
         };
     }

package/dist/core/live.js

@@ -1970,6 +1970,7 @@ export function serveLive(root, env) {
             return typeof v === "string" ? v : undefined;
         };
         let name;
+        let named;
         let note;
         let meta;
         let region;
@@ -1991,7 +1992,8 @@ export function serveLive(root, env) {
             at = "X-Strom-Path";
             where = header("x-strom-path") ? batchPath(decodeURIComponent(header("x-strom-path"))) : undefined;
             at = "X-Strom-Name";
-            name = decodeURIComponent(header("x-strom-name") ?? "") || sha.slice(0, 12);
+            named = decodeURIComponent(header("x-strom-name") ?? "").trim() || undefined;
+            name = named ?? sha.slice(0, 12);
             at = "X-Strom-Note";
             note = header("x-strom-note") ? decodeURIComponent(header("x-strom-note")).slice(0, 500) : undefined;
             at = "X-Strom-Person";
@@ -2034,6 +2036,9 @@ export function serveLive(root, env) {
             if (no)
                 return refuse(409, refusal(no.message, no.code === "task.no-file" ? "waiting.no-file" : "waiting.none", { id: forTask }));
         }
+        // a file to read: its reading shown under the name it came with now — also when the research had it already
+        if (read)
+            reads.named(sha, named);
         receiveOriginal(receiver, req, res, { sha, name, note, persons: meta.persons, source: meta.source, region, batch, where, zip, task: forTask, ...(read ? { read } : {}) });
     };
     const closeBatchNow = (id, extra, reply) => closeBatchBy(receiver, id, extra, reply);

package/dist/core/tree.js

@@ -27,7 +27,7 @@ import { lastBackup } from "./backup.js";
 export const TREE_FILE = "strom.json";
 // between releases the candidate being made (a bridge run from the sources says what it is: the Strom app goes by it);
 // at a release the release's own (package.json)
-export const VERSION = "1.18.0-beta.4";
+export const VERSION = "1.18.0-beta.5";
 const GITIGNORE = `# Strom Research — local state and large files are not versioned
 .strom/
 /media/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strom-research",
-  "version": "1.18.0-beta.4",
+  "version": "1.18.0-beta.5",
   "description": "Genealogical research toolkit for AI coding agents",
   "type": "module",
   "bin": {