@astrosheep/pi-context 0.19.0 → 0.21.0

package/dist/src/notes/store.js

@@ -0,0 +1,270 @@
+import { randomUUID } from "node:crypto";
+import { existsSync, mkdirSync, readFileSync, readdirSync, renameSync, rmSync, writeFileSync } from "node:fs";
+import { dirname } from "node:path";
+import { generateDiffString } from "@earendil-works/pi-coding-agent";
+import { assertGlobPattern, assertVirtualPath, globToRegExp } from "./model.js";
+import { MAX_NOTE_BYTES, MAX_NOTE_PATH_BYTES } from "../protocol.js";
+import { isOrigin, isScope, parseNote, serializeNote, stripLeadingFrontmatter } from "./frontmatter.js";
+import { addressFor } from "./address.js";
+import { physicalPath, scopeDir } from "./paths.js";
+import { earliestMatchOffsetChars } from "../tool-output.js";
+/** Typed store refusal. `line_numbers` and `edit_index` are the edit error's addressing fields. */
+export class NoteError extends Error {
+    code;
+    line_numbers;
+    edit_index;
+    constructor(code, message, extra = {}) {
+        super(message);
+        this.name = "NoteError";
+        this.code = code;
+        this.line_numbers = extra.line_numbers;
+        this.edit_index = extra.edit_index;
+    }
+}
+const SCOPE_ORDER = ["session", "project", "global"];
+function assertScope(value) {
+    if (!isScope(value))
+        throw new NoteError("invalid_scope", `scope must be one of session, project, global (got ${JSON.stringify(value)})`);
+    return value;
+}
+function assertOrigin(value) {
+    if (!isOrigin(value))
+        throw new NoteError("invalid_origin", `origin must be one of user, self, external (got ${JSON.stringify(value)})`);
+    return value;
+}
+/** Recursively list `.md` files under `dir` as forward-slash virtual paths relative to `base`. */
+function walkMarkdown(dir, base = dir) {
+    let entries;
+    try {
+        entries = readdirSync(dir, { withFileTypes: true });
+    }
+    catch {
+        return [];
+    }
+    const paths = [];
+    for (const entry of entries.sort((a, b) => a.name.localeCompare(b.name))) {
+        const child = `${dir}/${entry.name}`;
+        if (entry.isDirectory())
+            paths.push(...walkMarkdown(child, base));
+        else if (entry.isFile() && entry.name.endsWith(".md"))
+            paths.push(child.slice(base.length + 1).split("\\").join("/"));
+    }
+    return paths;
+}
+function matcherFor(pattern) {
+    const normalized = assertGlobPattern(pattern);
+    return normalized === undefined ? undefined : globToRegExp(normalized);
+}
+/**
+ * Every mutation lands through a tmp file renamed into place in the same directory, so a crash
+ * never leaves a torn note. No cross-process locking: out of scope by decision.
+ */
+function atomicWrite(path, content) {
+    mkdirSync(dirname(path), { recursive: true });
+    const tmp = `${path}.${process.pid}.${randomUUID()}.tmp`;
+    try {
+        writeFileSync(tmp, content);
+        renameSync(tmp, path);
+    }
+    catch (error) {
+        rmSync(tmp, { force: true });
+        throw error;
+    }
+}
+/** Write-time vpath guard: the byte cap is a tool-boundary rule, never a jail rule. */
+function assertWritablePath(vpath) {
+    const bytes = Buffer.byteLength(vpath, "utf8");
+    if (bytes > MAX_NOTE_PATH_BYTES)
+        throw new NoteError("too_large", `note path exceeds ${MAX_NOTE_PATH_BYTES} UTF-8 bytes (got ${bytes})`);
+}
+/** Serialized-size guard applied after the frontmatter is merged, before any bytes are written. */
+function assertSerializedSize(content) {
+    const bytes = Buffer.byteLength(content, "utf8");
+    if (bytes > MAX_NOTE_BYTES)
+        throw new NoteError("too_large", `note exceeds ${MAX_NOTE_BYTES} UTF-8 bytes (serialized ${bytes})`);
+}
+/** Frontmatter block only (the body separator stripped), for the metadata-only diff. */
+function frontmatterOf(meta) {
+    return serializeNote(meta, "").slice(0, -2);
+}
+/** Line numbers (1-based) of every occurrence of `needle` in `body`. */
+function matchLineNumbers(body, needle) {
+    const lines = [];
+    let cursor = 0;
+    for (;;) {
+        const index = body.indexOf(needle, cursor);
+        if (index === -1)
+            break;
+        lines.push(body.slice(0, index).split("\n").length);
+        cursor = index + Math.max(needle.length, 1);
+    }
+    return lines;
+}
+/** Create or overwrite a note; overwrite keeps created_at and every unknown key. */
+export function writeNote(ctx, vpath, body, opts) {
+    assertVirtualPath(vpath);
+    assertWritablePath(vpath);
+    const scope = assertScope(opts.scope);
+    const origin = assertOrigin(opts.origin);
+    const path = physicalPath(scope, vpath, ctx);
+    const now = Date.now();
+    const cleanBody = stripLeadingFrontmatter(body);
+    const existing = existsSync(path) ? parseNote(readFileSync(path, "utf8"), now).meta : undefined;
+    const meta = existing ?? {
+        scope,
+        origin,
+        status: "active",
+        stale: false,
+        created_at: now,
+        updated_at: now,
+        last_accessed: now,
+        access_count: 0,
+    };
+    meta.scope = scope;
+    meta.origin = origin;
+    meta.status = "active";
+    meta.stale = opts.stale ?? false;
+    meta.updated_at = now;
+    const serialized = serializeNote(meta, cleanBody);
+    assertSerializedSize(serialized);
+    atomicWrite(path, serialized);
+    return { meta };
+}
+/** Dream harness mutation: metadata changes still use the store's atomic writer. */
+export function updateNoteMeta(ctx, vpath, scope, mutate) {
+    assertVirtualPath(vpath);
+    const path = physicalPath(scope, vpath, ctx);
+    if (!existsSync(path))
+        throw new NoteError("not_found", `note not found: ${vpath}`);
+    const parsed = parseNote(readFileSync(path, "utf8"));
+    const meta = { ...parsed.meta, scope };
+    mutate(meta);
+    meta.updated_at = Date.now();
+    const serialized = serializeNote(meta, parsed.body);
+    assertSerializedSize(serialized);
+    atomicWrite(path, serialized);
+    return { meta, body: parsed.body };
+}
+/** Apply body-only edits against one explicit home; origin and stale are its metadata setters. */
+export function editNote(ctx, vpath, scope, edits, opts = {}) {
+    assertVirtualPath(vpath);
+    assertWritablePath(vpath);
+    const operations = edits ?? [];
+    if (operations.length === 0 && opts.origin === undefined && opts.stale === undefined) {
+        throw new NoteError("nothing_to_do", "nothing to do: provide edits or at least one of origin, stale");
+    }
+    const path = physicalPath(scope, vpath, ctx);
+    if (!existsSync(path))
+        throw new NoteError("not_found", "note not found");
+    const raw = readFileSync(path, "utf8");
+    const { meta, body } = parseNote(raw);
+    meta.scope = scope;
+    // Snapshot the pre-edit frontmatter so the diff can name exactly what the setters changed.
+    const beforeMeta = { ...meta };
+    // Every edit runs against this one snapshot; nothing is written until all of them succeed,
+    // so a failing edit leaves the file byte-identical (frontmatter included).
+    let next = body;
+    operations.forEach((edit, index) => {
+        const oldText = edit?.oldText;
+        const newText = edit?.newText;
+        if (typeof oldText !== "string" || oldText.length === 0)
+            throw new NoteError("no_match", `edit ${index}: oldText must be a non-empty string`, { edit_index: index });
+        if (typeof newText !== "string")
+            throw new NoteError("no_match", `edit ${index}: newText must be a string`, { edit_index: index });
+        const lines = matchLineNumbers(next, oldText);
+        if (lines.length === 0)
+            throw new NoteError("no_match", `edit ${index}: oldText does not occur in the note body`, { edit_index: index });
+        if (lines.length > 1 && !opts.replaceAll) {
+            throw new NoteError("ambiguous_edit", `edit ${index}: oldText occurs ${lines.length} times (lines ${lines.join(", ")}); pass replace_all to replace every occurrence`, { line_numbers: lines, edit_index: index });
+        }
+        // Single replacement is positional splicing, never String.replace: user text must be
+        // inserted byte-for-byte, without $-pattern substitution ($&, $`, $', $1, $$).
+        if (opts.replaceAll) {
+            next = next.split(oldText).join(newText);
+        }
+        else {
+            const matchIndex = next.indexOf(oldText);
+            next = next.substring(0, matchIndex) + newText + next.substring(matchIndex + oldText.length);
+        }
+    });
+    if (opts.origin !== undefined)
+        meta.origin = assertOrigin(opts.origin);
+    if (opts.stale !== undefined)
+        meta.stale = opts.stale;
+    meta.updated_at = Date.now();
+    const serialized = serializeNote(meta, next);
+    assertSerializedSize(serialized);
+    // pi-edit-style diff: body only for a content edit, frontmatter only for a metadata-only
+    // update, one combined file diff when both change.
+    const bodyChanged = body !== next;
+    const metadataChanged = beforeMeta.origin !== meta.origin || beforeMeta.stale !== meta.stale;
+    const diff = bodyChanged && metadataChanged
+        ? generateDiffString(raw, serialized).diff
+        : bodyChanged
+            ? generateDiffString(body, next).diff
+            : metadataChanged
+                ? generateDiffString(frontmatterOf(beforeMeta), frontmatterOf(meta)).diff
+                : "";
+    atomicWrite(path, serialized);
+    return { meta, applied: operations.length, resolved_scope: scope, diff };
+}
+/** Read a note and, as a side effect, bump last_accessed/access_count in the file. */
+export function readNote(ctx, vpath, scope) {
+    assertVirtualPath(vpath);
+    const path = physicalPath(scope, vpath, ctx);
+    if (!existsSync(path))
+        return undefined;
+    const now = Date.now();
+    const { meta, body } = parseNote(readFileSync(path, "utf8"), now);
+    meta.scope = scope;
+    // Only the two access keys move; updated_at and every other key keep their bytes.
+    meta.last_accessed = now;
+    meta.access_count = (typeof meta.access_count === "number" ? meta.access_count : 0) + 1;
+    atomicWrite(path, serializeNote(meta, body));
+    return { meta, body, resolvedScope: scope };
+}
+/** Merged rows across homes, most recently updated first (address breaks ties). */
+export function listNotes(ctx, opts = {}) {
+    const matcher = matcherFor(opts.pattern);
+    const rows = [];
+    for (const scope of opts.scope === undefined ? SCOPE_ORDER : [opts.scope]) {
+        const root = scopeDir(scope, ctx);
+        for (const path of walkMarkdown(root)) {
+            const address = addressFor(scope, path);
+            if (matcher && !matcher.test(address))
+                continue;
+            const { meta, body } = parseNote(readFileSync(`${root}/${path}`, "utf8"));
+            meta.scope = scope;
+            rows.push({ address, scope, path, meta, body, sizeBytes: Buffer.byteLength(body, "utf8") });
+        }
+    }
+    rows.sort((a, b) => b.meta.updated_at - a.meta.updated_at || a.address.localeCompare(b.address));
+    return rows;
+}
+/** Case-sensitive literal substring search over note bodies, with a match address per line. */
+export function searchNotes(ctx, queries, opts = {}) {
+    const matcher = matcherFor(opts.pattern);
+    const rows = [];
+    for (const scope of opts.scope === undefined ? SCOPE_ORDER : [opts.scope]) {
+        const root = scopeDir(scope, ctx);
+        for (const path of walkMarkdown(root)) {
+            const address = addressFor(scope, path);
+            if (matcher && !matcher.test(address))
+                continue;
+            const { meta, body } = parseNote(readFileSync(`${root}/${path}`, "utf8"));
+            meta.scope = scope;
+            let baseChars = 0;
+            const matches = [];
+            for (const [index, line] of body.split("\n").entries()) {
+                if (queries.some((query) => line.includes(query))) {
+                    matches.push({ line: index + 1, text: line, offsetChars: baseChars + earliestMatchOffsetChars(line, queries) });
+                }
+                baseChars += Array.from(line).length + 1;
+            }
+            if (matches.length > 0)
+                rows.push({ address, path, scope, meta, matches });
+        }
+    }
+    rows.sort((a, b) => a.address.localeCompare(b.address));
+    return rows;
+}

package/dist/src/notes/tools.js

@@ -0,0 +1,153 @@
+import { Type } from "@earendil-works/pi-ai";
+import { defineTool } from "@earendil-works/pi-coding-agent";
+import { localIso } from "./model.js";
+import { characterWindowHeader, DEFAULT_READ_WINDOW_CHARS, MAX_READ_WINDOW_CHARS, middleTruncate, output, outputRaw, page, prefixFit, readCharacterWindow, withinTextBudget } from "../tool-output.js";
+import { cursor, nullableString, positiveInteger, searchQueries, searchQuery } from "../tool-schema.js";
+import { assertAddress } from "./address.js";
+import { serializeNote, stripLeadingFrontmatter } from "./frontmatter.js";
+import { NoteError, editNote, listNotes, readNote, searchNotes, writeNote } from "./store.js";
+const ORIGIN = Type.Optional(Type.Union([Type.Literal("user"), Type.Literal("self"), Type.Literal("external")], {
+    description: "Where the note's content came from. user: written or dictated by the human. self: written by you, the agent (default). external: anything else — third-party text, tool output, fetched material.",
+}));
+const ADDRESS_DESCRIPTION = "Address forms are bare `<vpath>` for this session, `@project/<vpath>` for this project's home, and `@global/<vpath>` for the global home. `@` means leaving home. Any other `@` prefix, or `@` inside a vpath, is a hard error: legal prefixes are `@project/` and `@global/`; bare names are the session home. There is no cross-home fallback. Paths reject `..`, absolute paths, and backslashes.";
+function wireMeta(meta) {
+    return { ...meta, created_at: localIso(meta.created_at), updated_at: localIso(meta.updated_at), last_accessed: localIso(meta.last_accessed) };
+}
+function failure(error) {
+    if (error instanceof NoteError) {
+        const payload = { error: error.message };
+        if (error.line_numbers)
+            payload.line_numbers = error.line_numbers;
+        if (error.edit_index !== undefined)
+            payload.edit_index = error.edit_index;
+        return output(payload);
+    }
+    throw error;
+}
+export function registerNotesTools(pi) {
+    pi.registerTool(defineTool({
+        name: "notes_write", label: "Notes write",
+        description: `Create or replace a note as a real markdown file, and name it for what it holds: a fresh window sees only an index entry, never the note itself. ${ADDRESS_DESCRIPTION} Keep notes small and split by topic — by what the note is about, never by who said it (authorship is origin's job); a rewrite replaces the body whole while preserving created_at and every other frontmatter key. stale: true marks the note closed so it leaves the boot index but stays readable and searchable.`,
+        parameters: Type.Object({ address: Type.String(), content: Type.String(), origin: ORIGIN, stale: Type.Optional(Type.Boolean()) }, { additionalProperties: false }), executionMode: "sequential",
+        async execute(_id, params, _signal, _update, ctx) {
+            const content = params.content;
+            try {
+                const destination = assertAddress(params.address);
+                const { meta } = writeNote(ctx, destination.path, content, { scope: destination.scope, origin: (params.origin ?? "self"), stale: params.stale });
+                return output({ address: params.address, scope: meta.scope, size_bytes: Buffer.byteLength(stripLeadingFrontmatter(content), "utf8"), meta: wireMeta(meta) });
+            }
+            catch (error) {
+                return failure(error);
+            }
+        },
+    }));
+    pi.registerTool(defineTool({
+        name: "notes_edit", label: "Notes edit",
+        description: `Edit a note body by exact-text replacement; frontmatter is never editable this way. ${ADDRESS_DESCRIPTION} Each oldText must occur exactly once unless replace_all is set; a multi-match anchor fails with its match line numbers and a zero-match anchor names the failing edit index. edits may be omitted (or empty) for a metadata-only update, which requires at least one of origin/stale. Moving while awake means notes_write at a new address and notes_edit at the old address with stale=true. The success return carries resolved_scope and a diff of what changed.`,
+        parameters: Type.Object({ address: Type.String(), edits: Type.Optional(Type.Array(Type.Object({ oldText: Type.String(), newText: Type.String() }, { additionalProperties: false }))), origin: ORIGIN, stale: Type.Optional(Type.Boolean()), replace_all: Type.Optional(Type.Boolean()) }, { additionalProperties: false }), executionMode: "sequential",
+        async execute(_id, params, _signal, _update, ctx) {
+            try {
+                const destination = assertAddress(params.address);
+                const { meta, applied, resolved_scope, diff } = editNote(ctx, destination.path, destination.scope, params.edits, { origin: params.origin, stale: params.stale, replaceAll: params.replace_all });
+                return output({ address: params.address, applied, resolved_scope, diff, meta: wireMeta(meta) });
+            }
+            catch (error) {
+                return failure(error);
+            }
+        },
+    }));
+    pi.registerTool(defineTool({
+        name: "notes_read", label: "Notes read",
+        description: `Read a character window of a note file, frontmatter included. ${ADDRESS_DESCRIPTION} offset_chars is the code-point offset to start from (default 0) — a negative value counts back from the end — and limit_chars caps the window (default ${DEFAULT_READ_WINDOW_CHARS}, max ${MAX_READ_WINDOW_CHARS}). Each response delivers the longest fitting prefix of that window: concatenate pages in order to reconstruct the note. The response is the raw frontmatter + body behind a one-line [bracketed] header naming the address, the resolved offset, the delivered char range, and the resume cursor.`,
+        parameters: Type.Object({ address: Type.String(), offset_chars: Type.Optional(Type.Integer({ description: "Code-point offset to start from (default 0). A negative value counts back from the end; the response echoes the resolved absolute offset. Pass the previous next_offset_chars back unchanged to continue." })), limit_chars: Type.Optional(Type.Integer({ minimum: 1, maximum: MAX_READ_WINDOW_CHARS, description: `Largest requested window in code points (default ${DEFAULT_READ_WINDOW_CHARS}). A window too large for the wire budget is cut short; next_offset_chars names where the next read resumes.` })) }, { additionalProperties: false }),
+        async execute(_id, params, _signal, _update, ctx) {
+            let note;
+            try {
+                const destination = assertAddress(params.address);
+                note = readNote(ctx, destination.path, destination.scope);
+            }
+            catch (error) {
+                return failure(error);
+            }
+            if (!note)
+                return output({ error: "note not found", address: params.address });
+            const text = serializeNote(note.meta, note.body);
+            const totalChars = Array.from(text).length;
+            if (typeof params.offset_chars === "number" && params.offset_chars > totalChars)
+                return output({ error: `offset_chars ${params.offset_chars} is past the end: the note has ${totalChars} chars; the largest legal offset is ${totalChars} (an empty end-read)`, address: params.address, offset_chars: params.offset_chars, total_chars: totalChars });
+            const created_at = localIso(note.meta.created_at);
+            const updated_at = localIso(note.meta.updated_at);
+            const limit_chars = Math.min(params.limit_chars ?? DEFAULT_READ_WINDOW_CHARS, MAX_READ_WINDOW_CHARS);
+            return readCharacterWindow(text, params.offset_chars, params.limit_chars, (window) => {
+                const { content, ...rest } = window;
+                return outputRaw(characterWindowHeader(params.address, window, ` · ${note.resolvedScope} · created ${created_at} · updated ${updated_at}`), content, { address: params.address, scope: note.resolvedScope, ...rest, limit_chars, created_at, updated_at });
+            }, (result) => withinTextBudget(result.content[0].text));
+        },
+    }));
+    pi.registerTool(defineTool({
+        name: "notes_list", label: "Notes list",
+        description: `List note files as rows carrying address, scope, origin, status, stale, size_bytes, created_at, and updated_at, most recently updated first. ${ADDRESS_DESCRIPTION} All three homes are merged. A glob pattern (* within a path segment, ** across segments) filters full address strings: *.md is session-only, @project/** is project-only, and ** covers every home.`,
+        parameters: Type.Object({ pattern: nullableString(), cursor: cursor(), max_results: positiveInteger() }, { additionalProperties: false }),
+        async execute(_id, params, _signal, _update, ctx) {
+            let rows;
+            try {
+                rows = listNotes(ctx, { pattern: params.pattern ?? undefined });
+            }
+            catch (error) {
+                return failure(error);
+            }
+            const files = rows.map((row) => ({ address: row.address, scope: row.scope, origin: row.meta.origin, status: row.meta.status, stale: row.meta.stale, size_bytes: row.sizeBytes, created_at: localIso(row.meta.created_at), updated_at: localIso(row.meta.updated_at) }));
+            return output(page(files, params.cursor ?? 0, "files", params.max_results, (file, fits) => {
+                if (fits(file))
+                    return file;
+                const address = middleTruncate(file.address, (candidate) => fits({ ...file, address: candidate, address_truncated: true }));
+                return { ...file, address, address_truncated: true };
+            }));
+        },
+    }));
+    pi.registerTool(defineTool({
+        name: "notes_search", label: "Notes search",
+        description: `Case-sensitive literal substring search over note bodies; query is one string or several (OR), each matched line appears once. ${ADDRESS_DESCRIPTION} All three homes are merged and every entry carries its full address and derived scope. Patterns glob over full address strings. Each file entry carries matches_total, its full match count before capping. Each match carries line, text, offset_chars (the body-absolute code-point offset of the earliest match).`,
+        parameters: Type.Object({ query: searchQuery(), pattern: nullableString(), cursor: cursor(), max_matches_per_file: positiveInteger(), max_files: positiveInteger() }, { additionalProperties: false }),
+        async execute(_id, params, _signal, _update, ctx) {
+            const queries = searchQueries(params.query);
+            let rows;
+            try {
+                rows = searchNotes(ctx, queries, { pattern: params.pattern ?? undefined });
+            }
+            catch (error) {
+                return failure(error);
+            }
+            const maxPerFile = params.max_matches_per_file ?? Number.POSITIVE_INFINITY;
+            const result = rows.map((row) => {
+                const matches = row.matches.map((match) => ({ line: match.line, text: match.text, truncated: false, total_chars: Array.from(match.text).length, offset_chars: match.offsetChars }));
+                return { address: row.address, scope: row.scope, created_at: localIso(row.meta.created_at), updated_at: localIso(row.meta.updated_at), matches_total: matches.length, matches: matches.slice(0, maxPerFile) };
+            });
+            const fitFile = (file, fits) => {
+                if (fits(file))
+                    return file;
+                const matches = file.matches;
+                let low = 0;
+                let high = matches.length;
+                while (low < high) {
+                    const mid = Math.ceil((low + high) / 2);
+                    if (mid >= 1 && fits({ ...file, matches: matches.slice(0, mid) }))
+                        low = mid;
+                    else
+                        high = mid - 1;
+                }
+                if (low >= 1)
+                    return { ...file, matches: matches.slice(0, low) };
+                const first = matches[0];
+                const fitted = (text) => ({ ...file, matches: [{ ...first, text, truncated: true }] });
+                const text = prefixFit(first.text, (candidate) => fits(fitted(candidate)));
+                const prefix = fitted(text);
+                if (fits(prefix))
+                    return prefix;
+                const address = middleTruncate(prefix.address, (candidate) => fits({ ...prefix, address: candidate, address_truncated: true }));
+                return { ...prefix, address, address_truncated: true };
+            };
+            return output(page(result, params.cursor ?? 0, "files", params.max_files, fitFile));
+        },
+    }));
+}

package/dist/src/prompts.js

@@ -0,0 +1,81 @@
+import { historyFromSession } from "./history.js";
+import { localIso } from "./notes/model.js";
+import { listNotes } from "./notes/store.js";
+import { CONTEXT_WINDOW_OPEN_TAG, CONTEXT_WINDOW_CLOSE_TAG, POCKET_GLOBAL_LIMIT, POCKET_PROJECT_LIMIT, POCKET_SESSION_LIMIT, RESET_SUMMARY, PROTOCOL_BLOCK, GUIDANCE_OPEN_TAG, GUIDANCE_CLOSE_TAG } from "./protocol.js";
+/** Codex-style <context_window> identity block: agent name and first/current/previous window ids only. */
+function identityBlock(agentName, firstWindowId, currentWindowId, previousWindowId) {
+    const lines = [
+        `Agent name: ${agentName}`,
+        `First context window id: ${firstWindowId}`,
+        `Current context window id: ${currentWindowId}`,
+    ];
+    if (previousWindowId)
+        lines.push(`Previous context window id: ${previousWindowId}`);
+    return `${CONTEXT_WINDOW_OPEN_TAG}\n${lines.join("\n")}\n${CONTEXT_WINDOW_CLOSE_TAG}`;
+}
+/**
+ * Boot notes index. Map residency ("地图在场"): fresh MAP.md bodies from the global and
+ * project homes are both injected, broadest first; stale maps are skipped per home, and the
+ * session home is never peeked — a session MAP.md is an ordinary note. The pocket then lists
+ * recent fresh notes under per-home quotas (POCKET_SESSION_LIMIT / POCKET_PROJECT_LIMIT /
+ * POCKET_GLOBAL_LIMIT), most-recently-updated first within each home, one metadata line
+ * each: address, line count, UTF-8 byte count, local ISO update time. Bodies never render
+ * in the pocket; stale notes are excluded; MAP.md itself never takes a pocket seat.
+ */
+function notesIndex(ctx) {
+    const sections = [];
+    // Map residency ("地图在场"): scope-native maps, both fresh ones injected broadest-first.
+    // A session MAP.md is an ordinary note, never resident; stale maps skip independently.
+    for (const scope of ["global", "project"]) {
+        const toc = listNotes(ctx, { scope }).find((row) => row.path === "MAP.md");
+        if (toc && !toc.meta.stale) {
+            if (toc.body.length > 0)
+                sections.push(toc.body);
+        }
+    }
+    // listNotes is most-recently-updated first within each home. Per-home quotas keep session
+    // churn from evicting project or global notes; maps never take pocket seats.
+    const recentNotes = [
+        ...listNotes(ctx, { scope: "session" }).filter((row) => !row.meta.stale && row.path !== "MAP.md").slice(0, POCKET_SESSION_LIMIT),
+        ...listNotes(ctx, { scope: "project" }).filter((row) => !row.meta.stale && row.path !== "MAP.md").slice(0, POCKET_PROJECT_LIMIT),
+        ...listNotes(ctx, { scope: "global" }).filter((row) => !row.meta.stale && row.path !== "MAP.md").slice(0, POCKET_GLOBAL_LIMIT),
+    ];
+    if (recentNotes.length > 0) {
+        const lines = [`You find ${recentNotes.length} crumpled note${recentNotes.length === 1 ? "" : "s"} in your pocket (by home, most recent first within each: up to ${POCKET_SESSION_LIMIT} from this session, ${POCKET_PROJECT_LIMIT} from this project, ${POCKET_GLOBAL_LIMIT} from global). A note's content never appears here, so its name has to say what the note is about:`];
+        for (const row of recentNotes) {
+            lines.push(`- ${row.address} (${row.body.split("\n").length} lines, ${row.sizeBytes} UTF-8 bytes, updated ${localIso(row.meta.updated_at)})`);
+        }
+        sections.push(lines.join("\n"));
+    }
+    return sections.join("\n\n");
+}
+function notesHomeBlock() {
+    return "Notes_* addresses have three homes: bare <vpath> is this session, @project/<vpath> is this project, and @global/<vpath> is global. @ means leaving home; there is no cross-home fallback. Any other note is a plain file — use the file tools.";
+}
+/**
+ * Assemble the static, once-per-window boot block: the reset line for resets, the
+ * <context_window> identity block, the recent-notes index at window-open time, and
+ * the <context_window_protocol> teaching block. Nothing here is re-injected, so the
+ * head of the window stays cache-stable.
+ */
+export function bootBlock(ctx, currentId, previousId, resetLine) {
+    const firstId = historyFromSession(ctx)[0]?.windowId ?? currentId;
+    const parts = [];
+    if (resetLine)
+        parts.push(RESET_SUMMARY);
+    parts.push(identityBlock(ctx.sessionManager.getSessionName() ?? "root", firstId, currentId, previousId));
+    parts.push(notesHomeBlock());
+    const index = notesIndex(ctx);
+    if (index)
+        parts.push(index);
+    parts.push(PROTOCOL_BLOCK);
+    return parts.join("\n\n");
+}
+/**
+ * Codex-equivalent low-budget reminder. The measured remaining count is frozen into
+ * the text at the crossing that fires it, so each persisted copy is a snapshot true
+ * at write time; get_context_remaining remains the live source for the current figure.
+ */
+export function tokenBudgetGuidance(remaining) {
+    return `${GUIDANCE_OPEN_TAG}\nYour brain is almost out of room — ${remaining} tokens left, and then your memory gets wiped. The wipe is automatic: there is no final turn to write then. Grab the notebook now — the goal, decisions, progress, learnings, next steps, the skills you still need, the window ID and item ID of every relevant user request still being solved, and important actions/tool calls for future reference. Replacing an older checkpoint? Mark it stale. Then end the window yourself — anything you do after the checkpoint isn't in it.\n${GUIDANCE_CLOSE_TAG}`;
+}

package/dist/src/protocol.js

@@ -0,0 +1,56 @@
+export const STATE_TYPE = "pi-context/state";
+export const NOTE_TYPE = "pi-context/note";
+export const BOOT_TYPE = "pi-context/boot";
+export const GUIDANCE_TYPE = "pi-context/guidance";
+export const WARNING_TYPE = "pi-context/warning";
+export const RESET_MARKER_TYPE = "pi-context/reset-marker";
+export const CONTINUATION_TYPE = "pi-context/continuation";
+export const RESET_V2 = "reset-v2";
+export const MAX_NOTE_BYTES = 1_000_000;
+export const POCKET_SESSION_LIMIT = 5;
+export const POCKET_PROJECT_LIMIT = 2;
+export const POCKET_GLOBAL_LIMIT = 2;
+// Write-time cap on a virtual note path. Deliberately NOT enforced by assertVirtualPath:
+// notesFromSession replays already-persisted operations, which must keep loading sessions
+// that contain a longer legacy path. Reads and replay stay un-capped.
+export const MAX_NOTE_PATH_BYTES = 512;
+export const CONTEXT_WINDOW_OPEN_TAG = "<context_window>";
+export const CONTEXT_WINDOW_CLOSE_TAG = "</context_window>";
+export const CONTEXT_WINDOW_PROTOCOL_OPEN_TAG = "<context_window_protocol>";
+export const CONTEXT_WINDOW_PROTOCOL_CLOSE_TAG = "</context_window_protocol>";
+export const GUIDANCE_OPEN_TAG = "<context_window_guidance>";
+export const GUIDANCE_CLOSE_TAG = "</context_window_guidance>";
+export const PI_CONTEXT_SETTINGS_KEY = "pi-context";
+export const DEFAULT_RESERVE_TOKENS = 16_384;
+export const DEFAULT_REMINDER_MARGIN_TOKENS = 24_576;
+/**
+ * The runway: the budget between the final warning and the wipe, deliberately
+ * invisible to the model. get_context_remaining counts down to zero at the warning
+ * line (reserve + WARNING_RUNWAY_TOKENS); what lies below is overdraft the model
+ * never sees — Codex's fallback buffer, relocated above the line.
+ */
+export const WARNING_RUNWAY_TOKENS = 12_288;
+export const RESET_SUMMARY = "You wake up. Your head is empty — no memories, the past a blank. But nothing is lost: the notes you wrote and the recorded history still remember for you.";
+export const CONTINUATION = "Your memory was just erased. Pull only the details you need from history_* and notes_*, then get back to work.";
+/**
+ * Static protocol teaching adapted from Codex's token_budget.guidance_message to
+ * pi-context's tool names. It lives once per window in the persisted boot block;
+ * it is never re-injected, so it stays cache-stable at the head of the window.
+ */
+export const PROTOCOL_BLOCK = `${CONTEXT_WINDOW_PROTOCOL_OPEN_TAG}
+Your memory resets whenever the context window fills; only what you wrote down survives. Two things remember for you, and both outlive every window in this session: your notes, and this session's recorded history. Write notes with notes_write, revise them with notes_edit, and read them back with notes_read / notes_search / notes_list; history is read-only through the history_* tools. Everything else wakes blank.
+Mark outdated or unneeded notes stale — leave them, and they will keep misleading you.
+
+Keep a running checkpoint while you work, not at the last minute — the next window wakes knowing nothing about the work: the goal, decisions, progress, learnings, next steps, the skills you still need, the window ID and item ID of every relevant user request still being solved, and important actions/tool calls for future reference. history_list returns those IDs; history_read pulls the exact item back out. Bookmark anything expensive the same way — a window/item ID beats re-running or re-searching.
+
+Use get_context_remaining to see how much of the window is left. When it runs out, this window is gone — with no final turn at the limit — and you continue in a fresh one, recovering only through notes_* and history_*. Once your checkpoint is written, you can end the window yourself with new_context instead of waiting for the erase. Do not let a window die undocumented.
+
+If <context_window> lists a Previous context window id, a reset just happened and the old conversation is not included. Read your note checkpoint first, then recover details through history_*: history_read directly when you know the window and item IDs, history_list or history_search to find them when you don't.
+
+Your notes live in three homes: this session (bare names), this repo (@project/<vpath>), everywhere you go (@global/<vpath>). @ means leaving home — and homes don't visit each other: there is no cross-home fallback.
+Notes carry what exists nowhere else — what the human told you, what you discovered, where you stand.
+Session notes belong to this trip — the goal, the progress, the loose ends, packed for the road. The next window of THIS trip wakes to them; once the trip is over, nobody does.
+@project notes hold what you learned by working here — the things you only know because you were here — for whoever works here next.
+@global notes travel with you. Every window. Every conversation. Every trip. So before you drop anything in there, ask yourself: does this deserve to stare you in the face every single time you talk to the human? No? Then keep your weird junk OUT.
+${CONTEXT_WINDOW_PROTOCOL_CLOSE_TAG}`;
+export const WARNING_PROMPT = "Your memory is about to be erased. Write the note. NOW. If it already exists, revise it with notes_edit (or rewrite it whole): the goal, decisions, progress, learnings, next steps, the skills you still need, the window ID and item ID of every relevant user request still being solved, and important actions/tool calls for future reference. Do not continue any task. Then call new_context IMMEDIATELY — anything not in the note dies with the window.";