@north-light/crouter 0.3.354 → 0.3.356

package/dist/clients/attach/session/doc-materialize.d.ts

@@ -0,0 +1,53 @@
+/** Environment variable carrying the edited document path to the reattached viewer. */
+export declare const DOC_SAVEBACK_ENV = "CRTR_ATTACH_DOC_SAVEBACK";
+/** The document a materialized file was read from. */
+export interface MaterializedDoc {
+    /** The ref as the transcript wrote it (no brackets). */
+    ref: string;
+    id: string;
+    /** Canonical `<owner>/<name>` (or the ref when no owner). */
+    name: string;
+    revision: number;
+    /** The heads the body was read at — the base a save-back is made from. */
+    heads_key: string;
+    /** sha256 of the body as written. */
+    sha256: string;
+}
+/** The subset of a document read this module needs. */
+export interface DocumentSnapshot {
+    id: string;
+    name: string;
+    revision: number;
+    heads_key: string;
+    body: string;
+}
+export declare function docMaterializeRoot(): string;
+/** Write the snapshot's body to its stable path (idempotent) and return the path.
+ *  An existing file at that path is kept: it may hold the person's unsaved edit. */
+export declare function materializeDocument(ref: string, snap: DocumentSnapshot, root?: string): string;
+/** The document a local path was materialized from, or undefined for a plain file. */
+export declare function documentForPath(path: string, root?: string): MaterializedDoc | undefined;
+/** Save a person's edit of a materialized document. */
+export type DocSaveOutcome = {
+    outcome: 'unchanged';
+} | {
+    outcome: 'saved';
+    revision: number;
+} | {
+    outcome: 'stale';
+    path: string;
+} | {
+    outcome: 'missing';
+} | {
+    outcome: 'failed';
+    message: string;
+};
+/** The document write the save-back uses: `crtr doc edit`'s body replacement,
+ *  made from an explicit base. Resolves `stale` rather than throwing on a
+ *  moved document. */
+export type DocEditFn = (id: string, body: string, base: string) => Promise<{
+    revision: number;
+} | 'stale'>;
+export declare function saveDocumentEdit(path: string, edit: DocEditFn, root?: string): Promise<DocSaveOutcome>;
+/** The notice a save-back outcome shows, or undefined for none. */
+export declare function saveOutcomeNotice(name: string, outcome: DocSaveOutcome): string | undefined;

package/dist/clients/attach/session/doc-materialize.js

@@ -0,0 +1,3 @@
+var l=Object.defineProperty;var o=(e,t)=>l(e,"name",{value:t,configurable:!0});import{createHash as S}from"node:crypto";import{existsSync as d,mkdirSync as $,readFileSync as y,renameSync as _,writeFileSync as p}from"node:fs";import{tmpdir as x}from"node:os";import{basename as A,dirname as g,join as c}from"node:path";const N="CRTR_ATTACH_DOC_SAVEBACK",a=".crtr-doc.json";function u(){return c(x(),"crtr-docs")}o(u,"docMaterializeRoot");const f=o(e=>S("sha256").update(e).digest("hex"),"sha");function h(e){return e.replace(/[^A-Za-z0-9._-]/g,"_").slice(0,120)||"doc"}o(h,"safeSegment");function b(e,t,r=u()){const n=c(r,h(t.id),`r${t.revision}`),s=c(n,`${h(A(t.name))}.md`),i=c(n,a);if(d(s)&&d(i))return s;$(n,{recursive:!0});const v={ref:e,id:t.id,name:t.name,revision:t.revision,heads_key:t.heads_key,sha256:f(t.body)};return m(s,t.body),m(i,`${JSON.stringify(v)}
+`),s}o(b,"materializeDocument");function m(e,t){const r=`${e}.${process.pid}.tmp`;p(r,t),_(r,e)}o(m,"writeAtomic");function C(e,t=u()){if(e.startsWith(`${t}/`))try{const r=JSON.parse(y(c(g(e),a),"utf8"));return typeof r.id=="string"&&typeof r.heads_key=="string"?r:void 0}catch{return}}o(C,"documentForPath");async function R(e,t,r=u()){const n=C(e,r);if(n===void 0||!d(e))return{outcome:"missing"};const s=y(e,"utf8");if(f(s)===n.sha256)return{outcome:"unchanged"};try{const i=await t(n.id,s,n.heads_key);return i==="stale"?{outcome:"stale",path:e}:(m(c(g(e),a),`${JSON.stringify({...n,sha256:f(s)})}
+`),{outcome:"saved",revision:i.revision})}catch(i){return{outcome:"failed",message:i instanceof Error?i.message:String(i)}}}o(R,"saveDocumentEdit");function z(e,t){switch(t.outcome){case"unchanged":return;case"saved":return`Saved ${e} as revision ${t.revision}`;case"stale":return`${e} changed while you edited it \u2014 not saved; your text is kept at ${t.path}`;case"missing":return`Could not find the edited copy of ${e}`;case"failed":return`Could not save ${e}: ${t.message}`}}o(z,"saveOutcomeNotice");export{N as DOC_SAVEBACK_ENV,u as docMaterializeRoot,C as documentForPath,b as materializeDocument,R as saveDocumentEdit,z as saveOutcomeNotice};

package/dist/clients/attach/session/document-links.d.ts

@@ -0,0 +1,21 @@
+import type { CanvasSource } from '../../../core/canvas/source.js';
+export interface DocumentLinks {
+    /** Whether a clicked local path is a materialized document. */
+    isDocumentPath(path: string): boolean;
+    /** Re-read a clicked document and return the path to open (its current revision). */
+    prepareOpen(path: string): Promise<{
+        path: string;
+    } | {
+        notice: string;
+    }>;
+    /** The save-back a reattaching viewer was handed, if any. */
+    consumeSaveBack(notify: (message: string) => void): Promise<void>;
+    dispose(): void;
+}
+export declare function createDocumentLinks(opts: {
+    selfNodeId: string;
+    remote: boolean;
+    canvasSource: CanvasSource;
+    /** Re-render the transcript's Markdown after a name or path lands. */
+    refresh: () => void;
+}): DocumentLinks;

package/dist/clients/attach/session/document-links.js

@@ -0,0 +1 @@
+var k=Object.defineProperty;var i=(n,o)=>k(n,"name",{value:o,configurable:!0});import{APIError as C}from"../../../api/errors.js";import{cliClient as v}from"../../../commands/api-client.js";import{setDocLinkContext as y}from"../render/doc-links.js";import{DOC_SAVEBACK_ENV as g,documentForPath as h,materializeDocument as b,saveDocumentEdit as E,saveOutcomeNotice as L}from"./doc-materialize.js";async function w(n){const o=await v().objects.read(n);if(o.state!=="object"||o.type!=="document")return`${n} is not a readable document`;const a=o.data;if(a.needs_merge||a.bodies.length!==1)return`${n} has ${a.heads.length} heads and needs a merge`;const s=o.object.owner?.handle;return{id:o.object.id,name:s===void 0?o.object.name:`${s}/${o.object.name}`,revision:a.revision,heads_key:a.heads.map(d=>d.rev_id).sort().join(","),body:a.bodies[0]}}i(w,"readSnapshot");function z(n){const o=new Map,a=new Map,s=new Set,d=new Set;let m=!1,f=!1,l=!1;const j=i(()=>{m||f||(f=!0,n.canvasSource.listNodes().then(t=>{for(const e of t)o.set(e.node_id,e.name);m=!0,l||n.refresh()}).catch(()=>{m=!0}).finally(()=>{f=!1}))},"loadRoster"),N=i(t=>{n.remote||s.has(t)||d.has(t)||(s.add(t),w(t).then(e=>{if(typeof e=="string"){d.add(t);return}a.set(t,b(t,e)),l||n.refresh()}).catch(()=>{d.add(t)}).finally(()=>{s.delete(t)}))},"materialize"),S={selfNodeId:n.selfNodeId,nodeName:i(t=>{const e=o.get(t);return e===void 0&&j(),e},"nodeName"),pathFor:i(t=>{const e=a.get(t);return e===void 0&&N(t),e},"pathFor")};return y(S),{isDocumentPath:i(t=>h(t)!==void 0,"isDocumentPath"),async prepareOpen(t){if(n.remote)return{notice:"Opening a document is unavailable in a remote attach"};const e=h(t);if(e===void 0)return{notice:"Not a document link"};try{const r=await w(e.id);if(typeof r=="string")return{notice:r};const c=b(e.ref,r);return a.set(e.ref,c),{path:c}}catch(r){return{notice:`Could not read ${e.name}: ${r instanceof Error?r.message:String(r)}`}}},async consumeSaveBack(t){const e=process.env[g];if(e===void 0||e==="")return;delete process.env[g];const r=h(e),c=await E(e,async(_,$,D)=>{try{return{revision:(await v().docs.edit(_,{body:$,base:D,rationale:"edited by the person in the attach viewer"})).revision}}catch(u){if(u instanceof C&&u.code==="stale_revision")return"stale";throw u}}),p=L(r?.name??e,c);p!==void 0&&t(p)},dispose(){l=!0,y(void 0)}}}i(z,"createDocumentLinks");export{z as createDocumentLinks};

package/dist/clients/attach/session/file-links.d.ts

@@ -17,6 +17,8 @@ export declare function openLinkedFileInPane(opts: {
     cwd: string;
     nodeId: string;
     observer: boolean;
+    /** A materialized canvas document: the reattaching viewer saves its edit back. */
+    saveBackEnv?: string;
     /** Clear viewer-local pane identity immediately before the pane runs Neovim. */
     beforeRespawn: () => void;
 }): LinkedFileOpenResult;

package/dist/clients/attach/session/file-links.js

@@ -1 +1 @@
-var o=Object.defineProperty;var r=(e,n)=>o(e,"name",{value:n,configurable:!0});import{existsSync as s}from"node:fs";import{respawnPaneInBackground as u,shellQuote as c,viewerSplitEnv as l}from"../../../core/runtime/placement-tmux.js";const d="\x1B_crtr-file-open;",f="\x1B\\";function P(e){const n=e.indexOf(d);if(n===-1)return;const t=n+d.length,i=e.indexOf(f,t);return i===-1?void 0:{file:h(e.slice(t,i)),remaining:e.slice(0,n)+e.slice(i+f.length)}}r(P,"extractFileOpenInput");function h(e){const n=e.startsWith("'")?x(e):a(e);return n!==void 0&&n.startsWith("/")&&!/[\x00-\x1f\x7f]/.test(n)?n:void 0}r(h,"decodeShellEscapedPath");function x(e){let n="",t=1;for(;;){const i=e.indexOf("'",t);if(i===-1)return;if(n+=e.slice(t,i),t=i+1,t===e.length)return n;if(e.slice(t,t+3)!=="\\''")return;n+="'",t+=3}}r(x,"decodeSingleQuotedPath");function a(e){let n="";for(let t=0;t<e.length;t++){if(e[t]!=="\\"){n+=e[t];continue}const i=e[++t];if(i===void 0)return;n+=i}return n}r(a,"decodeBackslashPath");function w(e){if(!s(e.file))return"missing";const n=`crtr surface attach to ${c(e.nodeId)}${e.observer?" --observer":""}`,t=`nvim ${c(e.file)} || :; exec ${n}`;return e.beforeRespawn(),u({pane:e.pane,cwd:e.cwd,env:l(),command:t})?"opened":"failed"}r(w,"openLinkedFileInPane");export{P as extractFileOpenInput,w as openLinkedFileInPane};
+var s=Object.defineProperty;var r=(e,n)=>s(e,"name",{value:n,configurable:!0});import{existsSync as o}from"node:fs";import{respawnPaneInBackground as u,shellQuote as c,viewerSplitEnv as l}from"../../../core/runtime/placement-tmux.js";const d="\x1B_crtr-file-open;",f="\x1B\\";function I(e){const n=e.indexOf(d);if(n===-1)return;const t=n+d.length,i=e.indexOf(f,t);return i===-1?void 0:{file:a(e.slice(t,i)),remaining:e.slice(0,n)+e.slice(i+f.length)}}r(I,"extractFileOpenInput");function a(e){const n=e.startsWith("'")?h(e):x(e);return n!==void 0&&n.startsWith("/")&&!/[\x00-\x1f\x7f]/.test(n)?n:void 0}r(a,"decodeShellEscapedPath");function h(e){let n="",t=1;for(;;){const i=e.indexOf("'",t);if(i===-1)return;if(n+=e.slice(t,i),t=i+1,t===e.length)return n;if(e.slice(t,t+3)!=="\\''")return;n+="'",t+=3}}r(h,"decodeSingleQuotedPath");function x(e){let n="";for(let t=0;t<e.length;t++){if(e[t]!=="\\"){n+=e[t];continue}const i=e[++t];if(i===void 0)return;n+=i}return n}r(x,"decodeBackslashPath");function P(e){if(!o(e.file))return"missing";const n=`crtr surface attach to ${c(e.nodeId)}${e.observer?" --observer":""}`,t=e.saveBackEnv===void 0?"":`env ${e.saveBackEnv}=${c(e.file)} `,i=`nvim ${c(e.file)} || :; exec ${t}${n}`;return e.beforeRespawn(),u({pane:e.pane,cwd:e.cwd,env:l(),command:i})?"opened":"failed"}r(P,"openLinkedFileInPane");export{I as extractFileOpenInput,P as openLinkedFileInPane};