@agimon-ai/doompi-file-edit 0.0.1-alpha.9 → 0.0.1-alpha.91

package/README.md

@@ -1,38 +1,135 @@
 # @agimon-ai/doompi-file-edit
 
-Pi session file edit timeline and external editor overlay.
+A session-scoped file-change timeline and external-editor launcher for Pi.
 
-A timeline of every file the session edited, plus an external editor handoff.
+Part of the [DoomPi distribution](https://www.npmjs.com/package/@agimon-ai/doompi).
 
-Part of [Doompi](https://www.npmjs.com/package/@agimon-ai/doompi), a coding agent that loads
-only the skills and tools you name. This package is composed by Doompi and is not usually
-installed on its own.
+The package tracks files changed through session tool calls and captures content for diffs, without
+requiring a Git repository. `edit` and `write` name their file in the call, so the package can capture
+the before and after content within its size and format limits. Bash calls instead trigger a bounded
+tree comparison. See [What this cannot see](#what-this-cannot-see) for gaps in that coverage.
+
+> **Alpha:** timeline and UI contracts may change between releases.
+
+## Requirements
+
+- Node.js 22.19.0 or newer
+- Pi 0.85.0 and Pi TUI 0.85.0
+- Git for diffs against `HEAD`
 
 ## Install
 
+`doompi init` and `dpi init` include File Edit in `default.packages` in `.doom/modes.yaml`.
+Remove it or move it to a named layer to change which major modes load it. Standalone Pi loads the
+same extension:
+
 ```bash
-npm install @agimon-ai/doompi-file-edit
+pi install npm:@agimon-ai/doompi-file-edit
 ```
 
-## How it loads
+| Entry                                           | Purpose                                                  |
+| ----------------------------------------------- | -------------------------------------------------------- |
+| `@agimon-ai/doompi-file-edit/extensions/pi`     | Timeline and DoomPi Leader shortcut                      |
+| `@agimon-ai/doompi-file-edit/extensions/server` | Server-owned file API and changed-file channel lifecycle |
+| `@agimon-ai/doompi-file-edit`                   | Library API                                              |
+
+## Open the timeline
+
+Use `SPC e f` in DoomPi. Select a file to inspect its diff or open it in the configured editor.
+
+TUI diffs compare the working tree with Git `HEAD` and are capped at 200 lines and 256 KiB. The
+overlay and external-editor handoff require an interactive TUI. Headless hosts can consume the
+timeline services but cannot display the panel.
+
+## In the cockpit
 
-Doompi loads this unconditionally. It is core, not a layer, so it does not appear in
-`.doom/modes.yaml`: making it optional would only create broken configurations.
+The `# files` group in the activity dock lists every file the session changed. Selecting one opens a
+temporary tab holding three views of it:
 
-Extension entry: `@agimon-ai/doompi-file-edit/extensions/doom`
+- **diff**: what the session did to the file, followed by each recorded change on its own, so a file
+  edited four times shows four distinct diffs rather than one merged blur.
+- **source**: the file as it stands, editable. Saving writes straight to disk and is refused if the
+  file changed since it was opened, so a hand edit cannot silently discard what the agent wrote.
+- **preview**: rendered Markdown, or HTML in a sandboxed frame.
 
-## Leader
+Selecting text in any view raises a comment box. Comments queue on the tab and one **send review**
+builds a single message quoting each anchor, so several comments cost one turn.
+
+Diffs here do not use Git. The package captures the file's content before an `edit` or `write` runs
+and keeps it, content-addressed, beside the session timeline; both go when the session ends.
+
+### What this cannot see
+
+- A file the session changed and then deleted. The dock lists things to open, so a row that can only
+  answer "this is gone" is left out. The timeline still holds the change, so a tab already open on
+  the file keeps working and says why it has nothing to show.
+- A file changed by a background process that outlives its Bash call. The tree is compared when the
+  call ends.
+- A file changed outside any tool. There is no always-on watcher.
+- Content past 1 MiB, and binary files. These are listed as changed, without content.
+- A file found only by comparing the tree has no baseline, so it is listed, readable and editable,
+  but never diffed. Rows and versions say so rather than showing an empty diff.
+- The tree walk skips dependency and build directories and is capped on entries and depth, so a very
+  deep or very large checkout can under-report.
+
+## Configure the editor
+
+Set the shared DoomPi configuration in `~/.pi/.doom/config.yaml`:
+
+```yaml
+editor:
+  command: nvim +{line} {file}
+```
 
-`SPC e f` opens session edits, once the extension is loaded.
+For a standalone installation, the package falls back to
+`~/.pi/agent/doom-file-edit/config.yaml`. Resolution order is:
 
-## Entry points
+1. DoomPi `editor.command`;
+2. package fallback configuration;
+3. `$VISUAL`;
+4. `$EDITOR`;
+5. `nano {file}` on Unix-like systems.
 
-| Import                                        |
-| --------------------------------------------- |
-| `@agimon-ai/doompi-file-edit`                 |
-| `@agimon-ai/doompi-file-edit/extensions/pi`   |
-| `@agimon-ai/doompi-file-edit/extensions/doom` |
+Only `{file}` and `{line}` placeholders are expanded. The command is split and spawned directly,
+not passed through a shell, so shell operators and expansions are not interpreted.
+
+## Data behavior
+
+The timeline contains file paths, and the snapshot store holds copies of the file content the
+session changed. That content can be sensitive. Both live under the Pi agent directory,
+`$PI_CODING_AGENT_DIR` or `~/.pi/agent/doom-file-edit`, never inside the working tree, and should be
+protected with the same access controls as Pi session data.
+
+A session removes its own timeline and snapshots when it ends. A session that is killed cannot, so
+each session also sweeps state that no longer belongs to anyone: a timeline and its snapshots are
+removed once nothing has written to them for a week. An older build kept this state in the
+repository's git common directory, and that directory is cleared away under the same rule.
+
+The session API reads and writes only files the timeline already records, so a request cannot reach
+a file this session never changed.
+
+## Public API
+
+```ts
+import { createFileEditDependencies, fileEditExtension } from '@agimon-ai/doompi-file-edit';
+import type { FileDiff, FileEditEntry } from '@agimon-ai/doompi-file-edit';
+```
+
+The root also exports editor-resolution and timeline domain types for host integrations.
+
+## Development
+
+```bash
+pnpm build
+pnpm typecheck
+pnpm test
+pnpm lint
+```
+
+Maintained by [Agimon](https://agimon.ai/about).
 
 ## License
 
 MIT
+
+The public Pi and server loaders live in `src/extensions`. Controllers declare commands, events, APIs, and tracking activities. Services own filesystem and timeline logic; TUI modules assemble and present the review workflow. Public reusable types and dependency construction are exposed through flat `src/exports` entries. The Pi factory owns its optional UI service and awaits cleanup through `onDispose`.

package/dist/apiContracts.cjs

@@ -0,0 +1,156 @@
+Object.defineProperties(exports, {
+	__esModule: { value: true },
+	[Symbol.toStringTag]: { value: "Module" }
+});
+let _agimon_ai_doompi_core_apiContracts = require("@agimon-ai/doompi-core/apiContracts");
+let typebox = require("typebox");
+//#region src/schemas/apiContracts.ts
+const S = typebox.Type.String();
+const N = typebox.Type.Number();
+const B = typebox.Type.Boolean();
+const O = typebox.Type.Optional;
+const literals = (values) => typebox.Type.Union(values.map((value) => typebox.Type.Literal(value)));
+const Tool = literals([
+	"edit",
+	"write",
+	"bash",
+	"user"
+]);
+const Hunk = typebox.Type.Object({
+	start: N,
+	rows: typebox.Type.Array(typebox.Type.Object({
+		marker: literals([
+			"+",
+			"-",
+			" "
+		]),
+		line: N,
+		content: S
+	}))
+});
+const Diff = {
+	additions: N,
+	removals: N,
+	hunks: O(typebox.Type.Array(Hunk)),
+	note: O(S)
+};
+const Working = typebox.Type.Object({
+	content: S,
+	hash: S,
+	unavailable: B,
+	reason: O(S)
+});
+const FileDetailSchema = typebox.Type.Object({
+	path: S,
+	relPath: S,
+	versions: typebox.Type.Array(typebox.Type.Object({
+		index: N,
+		tool: Tool,
+		at: N,
+		origin: literals(["tool", "scan"]),
+		...Diff
+	})),
+	cumulative: typebox.Type.Object(Diff),
+	working: Working
+});
+const FilesPayloadSchema = typebox.Type.Object({ items: typebox.Type.Array(typebox.Type.Object({
+	path: S,
+	relPath: S,
+	tool: Tool,
+	at: N,
+	count: N,
+	diffable: B
+})) });
+const query = [{
+	name: "path",
+	in: "query",
+	required: true,
+	schema: typebox.Type.String({ minLength: 1 })
+}];
+const apiContracts = (0, _agimon_ai_doompi_core_apiContracts.defineApiContract)({
+	version: 1,
+	dynamic: [],
+	http: [
+		{
+			id: "files.detail",
+			scope: "session",
+			basePath: "file-edits",
+			path: "/detail",
+			method: "GET",
+			authentication: "owner",
+			description: "Read recorded changes and current file content.",
+			parameters: query,
+			responses: (0, _agimon_ai_doompi_core_apiContracts.jsonApiResponses)(FileDetailSchema)
+		},
+		{
+			id: "files.preview",
+			scope: "session",
+			basePath: "file-edits",
+			path: "/preview",
+			method: "GET",
+			authentication: "owner",
+			description: "Read a file contained in the session directory.",
+			parameters: query,
+			responses: (0, _agimon_ai_doompi_core_apiContracts.jsonApiResponses)(typebox.Type.Object({
+				path: S,
+				relPath: S,
+				working: Working
+			}))
+		},
+		{
+			id: "files.save",
+			scope: "session",
+			basePath: "file-edits",
+			path: "/content",
+			method: "PUT",
+			authentication: "owner",
+			description: "Save a recorded file if its hash still matches.",
+			body: {
+				required: true,
+				contentType: "application/json",
+				schema: typebox.Type.Object({
+					path: S,
+					expectedHash: S,
+					content: S
+				})
+			},
+			responses: (0, _agimon_ai_doompi_core_apiContracts.jsonApiResponses)(typebox.Type.Object({ hash: S }))
+		},
+		{
+			id: "files.delete",
+			scope: "session",
+			basePath: "file-edits",
+			path: "/content",
+			method: "DELETE",
+			authentication: "owner",
+			description: "Delete a recorded file.",
+			parameters: query,
+			responses: {
+				"204": { description: "File deleted or already absent." },
+				"404": {
+					description: "Unrecorded file.",
+					schema: typebox.Type.Object({ error: S })
+				},
+				"409": {
+					description: "Deletion failed.",
+					schema: typebox.Type.Object({ error: S })
+				}
+			}
+		}
+	],
+	sockets: ["global", "workspace"].map((scope) => ({
+		id: "files.channel",
+		scope,
+		service: "doompi.hub.v1",
+		member: "file_edits",
+		kind: "channel",
+		direction: "server-to-client",
+		description: "File edits channel payload in the hub frame payload property.",
+		input: FilesPayloadSchema
+	}))
+});
+//#endregion
+exports.apiContracts = apiContracts;
+exports.default = apiContracts;
+
+//# sourceMappingURL=apiContracts.cjs.map

package/dist/apiContracts.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiContracts.cjs","names":["Type","defineApiContract","jsonApiResponses"],"sources":["../src/schemas/apiContracts.ts"],"sourcesContent":["import { defineApiContract, jsonApiResponses } from '@agimon-ai/doompi-core/apiContracts';\nimport { Type } from 'typebox';\n\nconst S = Type.String();\nconst N = Type.Number();\nconst B = Type.Boolean();\nconst O = Type.Optional;\nconst literals = <T extends string>(values: T[]) => Type.Union(values.map((value) => Type.Literal(value)));\nconst Tool = literals(['edit', 'write', 'bash', 'user']);\nconst Hunk = Type.Object({\n  start: N,\n  rows: Type.Array(Type.Object({ marker: literals(['+', '-', ' ']), line: N, content: S })),\n});\nconst Diff = { additions: N, removals: N, hunks: O(Type.Array(Hunk)), note: O(S) };\nconst Working = Type.Object({ content: S, hash: S, unavailable: B, reason: O(S) });\nexport const FileDetailSchema = Type.Object({\n  path: S,\n  relPath: S,\n  versions: Type.Array(Type.Object({ index: N, tool: Tool, at: N, origin: literals(['tool', 'scan']), ...Diff })),\n  cumulative: Type.Object(Diff),\n  working: Working,\n});\nexport const FilesPayloadSchema = Type.Object({\n  items: Type.Array(Type.Object({ path: S, relPath: S, tool: Tool, at: N, count: N, diffable: B })),\n});\nconst query = [{ name: 'path', in: 'query' as const, required: true, schema: Type.String({ minLength: 1 }) }];\nexport const apiContracts = defineApiContract({\n  version: 1,\n  dynamic: [],\n  http: [\n    {\n      id: 'files.detail',\n      scope: 'session',\n      basePath: 'file-edits',\n      path: '/detail',\n      method: 'GET',\n      authentication: 'owner',\n      description: 'Read recorded changes and current file content.',\n      parameters: query,\n      responses: jsonApiResponses(FileDetailSchema),\n    },\n    {\n      id: 'files.preview',\n      scope: 'session',\n      basePath: 'file-edits',\n      path: '/preview',\n      method: 'GET',\n      authentication: 'owner',\n      description: 'Read a file contained in the session directory.',\n      parameters: query,\n      responses: jsonApiResponses(Type.Object({ path: S, relPath: S, working: Working })),\n    },\n    {\n      id: 'files.save',\n      scope: 'session',\n      basePath: 'file-edits',\n      path: '/content',\n      method: 'PUT',\n      authentication: 'owner',\n      description: 'Save a recorded file if its hash still matches.',\n      body: {\n        required: true,\n        contentType: 'application/json',\n        schema: Type.Object({ path: S, expectedHash: S, content: S }),\n      },\n      responses: jsonApiResponses(Type.Object({ hash: S })),\n    },\n    {\n      id: 'files.delete',\n      scope: 'session',\n      basePath: 'file-edits',\n      path: '/content',\n      method: 'DELETE',\n      authentication: 'owner',\n      description: 'Delete a recorded file.',\n      parameters: query,\n      responses: {\n        '204': { description: 'File deleted or already absent.' },\n        '404': { description: 'Unrecorded file.', schema: Type.Object({ error: S }) },\n        '409': { description: 'Deletion failed.', schema: Type.Object({ error: S }) },\n      },\n    },\n  ],\n  sockets: (['global', 'workspace'] as const).map((scope) => ({\n    id: 'files.channel',\n    scope,\n    service: 'doompi.hub.v1',\n    member: 'file_edits',\n    kind: 'channel',\n    direction: 'server-to-client',\n    description: 'File edits channel payload in the hub frame payload property.',\n    input: FilesPayloadSchema,\n  })),\n});\nexport default apiContracts;\n"],"mappings":";;;;;;;AAGA,MAAM,IAAIA,QAAAA,KAAK,OAAO;AACtB,MAAM,IAAIA,QAAAA,KAAK,OAAO;AACtB,MAAM,IAAIA,QAAAA,KAAK,QAAQ;AACvB,MAAM,IAAIA,QAAAA,KAAK;AACf,MAAM,YAA8B,WAAgBA,QAAAA,KAAK,MAAM,OAAO,KAAK,UAAUA,QAAAA,KAAK,QAAQ,KAAK,CAAC,CAAC;AACzG,MAAM,OAAO,SAAS;CAAC;CAAQ;CAAS;CAAQ;AAAM,CAAC;AACvD,MAAM,OAAOA,QAAAA,KAAK,OAAO;CACvB,OAAO;CACP,MAAMA,QAAAA,KAAK,MAAMA,QAAAA,KAAK,OAAO;EAAE,QAAQ,SAAS;GAAC;GAAK;GAAK;EAAG,CAAC;EAAG,MAAM;EAAG,SAAS;CAAE,CAAC,CAAC;AAC1F,CAAC;AACD,MAAM,OAAO;CAAE,WAAW;CAAG,UAAU;CAAG,OAAO,EAAEA,QAAAA,KAAK,MAAM,IAAI,CAAC;CAAG,MAAM,EAAE,CAAC;AAAE;AACjF,MAAM,UAAUA,QAAAA,KAAK,OAAO;CAAE,SAAS;CAAG,MAAM;CAAG,aAAa;CAAG,QAAQ,EAAE,CAAC;AAAE,CAAC;AACjF,MAAa,mBAAmBA,QAAAA,KAAK,OAAO;CAC1C,MAAM;CACN,SAAS;CACT,UAAUA,QAAAA,KAAK,MAAMA,QAAAA,KAAK,OAAO;EAAE,OAAO;EAAG,MAAM;EAAM,IAAI;EAAG,QAAQ,SAAS,CAAC,QAAQ,MAAM,CAAC;EAAG,GAAG;CAAK,CAAC,CAAC;CAC9G,YAAYA,QAAAA,KAAK,OAAO,IAAI;CAC5B,SAAS;AACX,CAAC;AACD,MAAa,qBAAqBA,QAAAA,KAAK,OAAO,EAC5C,OAAOA,QAAAA,KAAK,MAAMA,QAAAA,KAAK,OAAO;CAAE,MAAM;CAAG,SAAS;CAAG,MAAM;CAAM,IAAI;CAAG,OAAO;CAAG,UAAU;AAAE,CAAC,CAAC,EAClG,CAAC;AACD,MAAM,QAAQ,CAAC;CAAE,MAAM;CAAQ,IAAI;CAAkB,UAAU;CAAM,QAAQA,QAAAA,KAAK,OAAO,EAAE,WAAW,EAAE,CAAC;AAAE,CAAC;AAC5G,MAAa,gBAAA,GAAeC,oCAAAA,kBAAAA,CAAkB;CAC5C,SAAS;CACT,SAAS,CAAC;CACV,MAAM;EACJ;GACE,IAAI;GACJ,OAAO;GACP,UAAU;GACV,MAAM;GACN,QAAQ;GACR,gBAAgB;GAChB,aAAa;GACb,YAAY;GACZ,YAAA,GAAWC,oCAAAA,iBAAAA,CAAiB,gBAAgB;EAC9C;EACA;GACE,IAAI;GACJ,OAAO;GACP,UAAU;GACV,MAAM;GACN,QAAQ;GACR,gBAAgB;GAChB,aAAa;GACb,YAAY;GACZ,YAAA,GAAWA,oCAAAA,iBAAAA,CAAiBF,QAAAA,KAAK,OAAO;IAAE,MAAM;IAAG,SAAS;IAAG,SAAS;GAAQ,CAAC,CAAC;EACpF;EACA;GACE,IAAI;GACJ,OAAO;GACP,UAAU;GACV,MAAM;GACN,QAAQ;GACR,gBAAgB;GAChB,aAAa;GACb,MAAM;IACJ,UAAU;IACV,aAAa;IACb,QAAQA,QAAAA,KAAK,OAAO;KAAE,MAAM;KAAG,cAAc;KAAG,SAAS;IAAE,CAAC;GAC9D;GACA,YAAA,GAAWE,oCAAAA,iBAAAA,CAAiBF,QAAAA,KAAK,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;EACtD;EACA;GACE,IAAI;GACJ,OAAO;GACP,UAAU;GACV,MAAM;GACN,QAAQ;GACR,gBAAgB;GAChB,aAAa;GACb,YAAY;GACZ,WAAW;IACT,OAAO,EAAE,aAAa,kCAAkC;IACxD,OAAO;KAAE,aAAa;KAAoB,QAAQA,QAAAA,KAAK,OAAO,EAAE,OAAO,EAAE,CAAC;IAAE;IAC5E,OAAO;KAAE,aAAa;KAAoB,QAAQA,QAAAA,KAAK,OAAO,EAAE,OAAO,EAAE,CAAC;IAAE;GAC9E;EACF;CACF;CACA,SAAU,CAAC,UAAU,WAAW,CAAC,CAAW,KAAK,WAAW;EAC1D,IAAI;EACJ;EACA,SAAS;EACT,QAAQ;EACR,MAAM;EACN,WAAW;EACX,aAAa;EACb,OAAO;CACT,EAAE;AACJ,CAAC"}

package/dist/apiContracts.d.mts

@@ -0,0 +1,53 @@
+import { Type } from "typebox";
+//#region src/schemas/apiContracts.d.ts
+export declare const apiContracts: {
+  version: 1;
+  protocols?: Record<string, string> | undefined;
+  schemas?: Record<string, boolean | object> | undefined;
+  http: {
+    id: string;
+    scope: "global" | "session" | "workspace";
+    basePath?: string | undefined;
+    path: string;
+    method: "DELETE" | "GET" | "HEAD" | "OPTIONS" | "PATCH" | "POST" | "PUT";
+    description: string;
+    availability?: string | undefined;
+    authentication: "device" | "none" | "owner";
+    parameters?: {
+      name: string;
+      in: "header" | "path" | "query";
+      required: boolean;
+      schema: boolean | object;
+    }[] | undefined;
+    body?: {
+      contentType: string;
+      contentTypes?: string[] | undefined;
+      required: boolean;
+      schema: boolean | object;
+    } | undefined;
+    responses: Record<string, {
+      description: string;
+      contentType?: string | undefined;
+      schema?: boolean | object | undefined;
+      events?: Record<string, boolean | object> | undefined;
+    }>;
+  }[];
+  sockets: {
+    id: string;
+    scope: "global" | "session" | "workspace";
+    description: string;
+    availability?: string | undefined;
+    service: string;
+    member: string;
+    direction: "client-to-server" | "server-to-client";
+    kind: "channel" | "method" | "state";
+    input: boolean | object;
+    output?: boolean | object | undefined;
+    errors?: boolean | object | undefined;
+  }[];
+  dynamic: string[];
+  gaps?: string[] | undefined;
+};
+//#endregion
+export { apiContracts as default };
+//# sourceMappingURL=apiContracts.d.mts.map

package/dist/apiContracts.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiContracts.d.mts","names":[],"sources":["../src/schemas/apiContracts.ts"],"mappings":";;qBA0Ba"}

package/dist/apiContracts.mjs

@@ -0,0 +1,151 @@
+import { defineApiContract, jsonApiResponses } from "@agimon-ai/doompi-core/apiContracts";
+import { Type } from "typebox";
+//#region src/schemas/apiContracts.ts
+const S = Type.String();
+const N = Type.Number();
+const B = Type.Boolean();
+const O = Type.Optional;
+const literals = (values) => Type.Union(values.map((value) => Type.Literal(value)));
+const Tool = literals([
+	"edit",
+	"write",
+	"bash",
+	"user"
+]);
+const Hunk = Type.Object({
+	start: N,
+	rows: Type.Array(Type.Object({
+		marker: literals([
+			"+",
+			"-",
+			" "
+		]),
+		line: N,
+		content: S
+	}))
+});
+const Diff = {
+	additions: N,
+	removals: N,
+	hunks: O(Type.Array(Hunk)),
+	note: O(S)
+};
+const Working = Type.Object({
+	content: S,
+	hash: S,
+	unavailable: B,
+	reason: O(S)
+});
+const FileDetailSchema = Type.Object({
+	path: S,
+	relPath: S,
+	versions: Type.Array(Type.Object({
+		index: N,
+		tool: Tool,
+		at: N,
+		origin: literals(["tool", "scan"]),
+		...Diff
+	})),
+	cumulative: Type.Object(Diff),
+	working: Working
+});
+const FilesPayloadSchema = Type.Object({ items: Type.Array(Type.Object({
+	path: S,
+	relPath: S,
+	tool: Tool,
+	at: N,
+	count: N,
+	diffable: B
+})) });
+const query = [{
+	name: "path",
+	in: "query",
+	required: true,
+	schema: Type.String({ minLength: 1 })
+}];
+const apiContracts = defineApiContract({
+	version: 1,
+	dynamic: [],
+	http: [
+		{
+			id: "files.detail",
+			scope: "session",
+			basePath: "file-edits",
+			path: "/detail",
+			method: "GET",
+			authentication: "owner",
+			description: "Read recorded changes and current file content.",
+			parameters: query,
+			responses: jsonApiResponses(FileDetailSchema)
+		},
+		{
+			id: "files.preview",
+			scope: "session",
+			basePath: "file-edits",
+			path: "/preview",
+			method: "GET",
+			authentication: "owner",
+			description: "Read a file contained in the session directory.",
+			parameters: query,
+			responses: jsonApiResponses(Type.Object({
+				path: S,
+				relPath: S,
+				working: Working
+			}))
+		},
+		{
+			id: "files.save",
+			scope: "session",
+			basePath: "file-edits",
+			path: "/content",
+			method: "PUT",
+			authentication: "owner",
+			description: "Save a recorded file if its hash still matches.",
+			body: {
+				required: true,
+				contentType: "application/json",
+				schema: Type.Object({
+					path: S,
+					expectedHash: S,
+					content: S
+				})
+			},
+			responses: jsonApiResponses(Type.Object({ hash: S }))
+		},
+		{
+			id: "files.delete",
+			scope: "session",
+			basePath: "file-edits",
+			path: "/content",
+			method: "DELETE",
+			authentication: "owner",
+			description: "Delete a recorded file.",
+			parameters: query,
+			responses: {
+				"204": { description: "File deleted or already absent." },
+				"404": {
+					description: "Unrecorded file.",
+					schema: Type.Object({ error: S })
+				},
+				"409": {
+					description: "Deletion failed.",
+					schema: Type.Object({ error: S })
+				}
+			}
+		}
+	],
+	sockets: ["global", "workspace"].map((scope) => ({
+		id: "files.channel",
+		scope,
+		service: "doompi.hub.v1",
+		member: "file_edits",
+		kind: "channel",
+		direction: "server-to-client",
+		description: "File edits channel payload in the hub frame payload property.",
+		input: FilesPayloadSchema
+	}))
+});
+//#endregion
+export { apiContracts, apiContracts as default };
+
+//# sourceMappingURL=apiContracts.mjs.map

package/dist/apiContracts.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiContracts.mjs","names":[],"sources":["../src/schemas/apiContracts.ts"],"sourcesContent":["import { defineApiContract, jsonApiResponses } from '@agimon-ai/doompi-core/apiContracts';\nimport { Type } from 'typebox';\n\nconst S = Type.String();\nconst N = Type.Number();\nconst B = Type.Boolean();\nconst O = Type.Optional;\nconst literals = <T extends string>(values: T[]) => Type.Union(values.map((value) => Type.Literal(value)));\nconst Tool = literals(['edit', 'write', 'bash', 'user']);\nconst Hunk = Type.Object({\n  start: N,\n  rows: Type.Array(Type.Object({ marker: literals(['+', '-', ' ']), line: N, content: S })),\n});\nconst Diff = { additions: N, removals: N, hunks: O(Type.Array(Hunk)), note: O(S) };\nconst Working = Type.Object({ content: S, hash: S, unavailable: B, reason: O(S) });\nexport const FileDetailSchema = Type.Object({\n  path: S,\n  relPath: S,\n  versions: Type.Array(Type.Object({ index: N, tool: Tool, at: N, origin: literals(['tool', 'scan']), ...Diff })),\n  cumulative: Type.Object(Diff),\n  working: Working,\n});\nexport const FilesPayloadSchema = Type.Object({\n  items: Type.Array(Type.Object({ path: S, relPath: S, tool: Tool, at: N, count: N, diffable: B })),\n});\nconst query = [{ name: 'path', in: 'query' as const, required: true, schema: Type.String({ minLength: 1 }) }];\nexport const apiContracts = defineApiContract({\n  version: 1,\n  dynamic: [],\n  http: [\n    {\n      id: 'files.detail',\n      scope: 'session',\n      basePath: 'file-edits',\n      path: '/detail',\n      method: 'GET',\n      authentication: 'owner',\n      description: 'Read recorded changes and current file content.',\n      parameters: query,\n      responses: jsonApiResponses(FileDetailSchema),\n    },\n    {\n      id: 'files.preview',\n      scope: 'session',\n      basePath: 'file-edits',\n      path: '/preview',\n      method: 'GET',\n      authentication: 'owner',\n      description: 'Read a file contained in the session directory.',\n      parameters: query,\n      responses: jsonApiResponses(Type.Object({ path: S, relPath: S, working: Working })),\n    },\n    {\n      id: 'files.save',\n      scope: 'session',\n      basePath: 'file-edits',\n      path: '/content',\n      method: 'PUT',\n      authentication: 'owner',\n      description: 'Save a recorded file if its hash still matches.',\n      body: {\n        required: true,\n        contentType: 'application/json',\n        schema: Type.Object({ path: S, expectedHash: S, content: S }),\n      },\n      responses: jsonApiResponses(Type.Object({ hash: S })),\n    },\n    {\n      id: 'files.delete',\n      scope: 'session',\n      basePath: 'file-edits',\n      path: '/content',\n      method: 'DELETE',\n      authentication: 'owner',\n      description: 'Delete a recorded file.',\n      parameters: query,\n      responses: {\n        '204': { description: 'File deleted or already absent.' },\n        '404': { description: 'Unrecorded file.', schema: Type.Object({ error: S }) },\n        '409': { description: 'Deletion failed.', schema: Type.Object({ error: S }) },\n      },\n    },\n  ],\n  sockets: (['global', 'workspace'] as const).map((scope) => ({\n    id: 'files.channel',\n    scope,\n    service: 'doompi.hub.v1',\n    member: 'file_edits',\n    kind: 'channel',\n    direction: 'server-to-client',\n    description: 'File edits channel payload in the hub frame payload property.',\n    input: FilesPayloadSchema,\n  })),\n});\nexport default apiContracts;\n"],"mappings":";;;AAGA,MAAM,IAAI,KAAK,OAAO;AACtB,MAAM,IAAI,KAAK,OAAO;AACtB,MAAM,IAAI,KAAK,QAAQ;AACvB,MAAM,IAAI,KAAK;AACf,MAAM,YAA8B,WAAgB,KAAK,MAAM,OAAO,KAAK,UAAU,KAAK,QAAQ,KAAK,CAAC,CAAC;AACzG,MAAM,OAAO,SAAS;CAAC;CAAQ;CAAS;CAAQ;AAAM,CAAC;AACvD,MAAM,OAAO,KAAK,OAAO;CACvB,OAAO;CACP,MAAM,KAAK,MAAM,KAAK,OAAO;EAAE,QAAQ,SAAS;GAAC;GAAK;GAAK;EAAG,CAAC;EAAG,MAAM;EAAG,SAAS;CAAE,CAAC,CAAC;AAC1F,CAAC;AACD,MAAM,OAAO;CAAE,WAAW;CAAG,UAAU;CAAG,OAAO,EAAE,KAAK,MAAM,IAAI,CAAC;CAAG,MAAM,EAAE,CAAC;AAAE;AACjF,MAAM,UAAU,KAAK,OAAO;CAAE,SAAS;CAAG,MAAM;CAAG,aAAa;CAAG,QAAQ,EAAE,CAAC;AAAE,CAAC;AACjF,MAAa,mBAAmB,KAAK,OAAO;CAC1C,MAAM;CACN,SAAS;CACT,UAAU,KAAK,MAAM,KAAK,OAAO;EAAE,OAAO;EAAG,MAAM;EAAM,IAAI;EAAG,QAAQ,SAAS,CAAC,QAAQ,MAAM,CAAC;EAAG,GAAG;CAAK,CAAC,CAAC;CAC9G,YAAY,KAAK,OAAO,IAAI;CAC5B,SAAS;AACX,CAAC;AACD,MAAa,qBAAqB,KAAK,OAAO,EAC5C,OAAO,KAAK,MAAM,KAAK,OAAO;CAAE,MAAM;CAAG,SAAS;CAAG,MAAM;CAAM,IAAI;CAAG,OAAO;CAAG,UAAU;AAAE,CAAC,CAAC,EAClG,CAAC;AACD,MAAM,QAAQ,CAAC;CAAE,MAAM;CAAQ,IAAI;CAAkB,UAAU;CAAM,QAAQ,KAAK,OAAO,EAAE,WAAW,EAAE,CAAC;AAAE,CAAC;AAC5G,MAAa,eAAe,kBAAkB;CAC5C,SAAS;CACT,SAAS,CAAC;CACV,MAAM;EACJ;GACE,IAAI;GACJ,OAAO;GACP,UAAU;GACV,MAAM;GACN,QAAQ;GACR,gBAAgB;GAChB,aAAa;GACb,YAAY;GACZ,WAAW,iBAAiB,gBAAgB;EAC9C;EACA;GACE,IAAI;GACJ,OAAO;GACP,UAAU;GACV,MAAM;GACN,QAAQ;GACR,gBAAgB;GAChB,aAAa;GACb,YAAY;GACZ,WAAW,iBAAiB,KAAK,OAAO;IAAE,MAAM;IAAG,SAAS;IAAG,SAAS;GAAQ,CAAC,CAAC;EACpF;EACA;GACE,IAAI;GACJ,OAAO;GACP,UAAU;GACV,MAAM;GACN,QAAQ;GACR,gBAAgB;GAChB,aAAa;GACb,MAAM;IACJ,UAAU;IACV,aAAa;IACb,QAAQ,KAAK,OAAO;KAAE,MAAM;KAAG,cAAc;KAAG,SAAS;IAAE,CAAC;GAC9D;GACA,WAAW,iBAAiB,KAAK,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;EACtD;EACA;GACE,IAAI;GACJ,OAAO;GACP,UAAU;GACV,MAAM;GACN,QAAQ;GACR,gBAAgB;GAChB,aAAa;GACb,YAAY;GACZ,WAAW;IACT,OAAO,EAAE,aAAa,kCAAkC;IACxD,OAAO;KAAE,aAAa;KAAoB,QAAQ,KAAK,OAAO,EAAE,OAAO,EAAE,CAAC;IAAE;IAC5E,OAAO;KAAE,aAAa;KAAoB,QAAQ,KAAK,OAAO,EAAE,OAAO,EAAE,CAAC;IAAE;GAC9E;EACF;CACF;CACA,SAAU,CAAC,UAAU,WAAW,CAAC,CAAW,KAAK,WAAW;EAC1D,IAAI;EACJ;EACA,SAAS;EACT,QAAQ;EACR,MAAM;EACN,WAAW;EACX,aAAa;EACb,OAAO;CACT,EAAE;AACJ,CAAC"}