vde-open 0.1.10 → 0.1.11

package/README.md

@@ -2,7 +2,7 @@
 
 [日本語](README.ja.md)
 
-A local document viewer for agents and people who work from the same material. Open Markdown and HTML documents, read them in a management UI in the browser, and let an agent search and read the same documents from the CLI. An agent can also ask a person questions, and the person submits the answers from the management UI.
+A local document viewer for agents and people who work from the same material. Open Markdown, HTML, and image files, read them in a management UI in the browser, and let an agent search and read the same documents from the CLI. An agent can also ask a person questions, and the person submits the answers from the management UI.
 
 - Agents can search and read only the documents you opened.
 - When you save a document, the management UI updates automatically.
@@ -28,7 +28,7 @@ To install from a clone of this repository (Node.js 24.21.0 is pinned in `mise.t
 pnpm install --frozen-lockfile
 pnpm build
 pnpm test:pack                                   # builds artifacts/vde-open-<version>.tgz and verifies an install in a separate directory
-bun add -g "$PWD/artifacts/vde-open-0.1.10.tgz"   # bun add -g needs an absolute path
+bun add -g "$PWD/artifacts/vde-open-0.1.11.tgz"   # bun add -g needs an absolute path
 ```
 
 ## `vde-open` and `vo`
@@ -97,6 +97,20 @@ Markdown is rendered with TanStack Markdown 1.0.0. It is not fully compatible wi
 - Code is highlighted only for JS, JSX, TS, TSX, JSON, YAML, HTML, CSS, Bash, and Markdown. Code larger than 256 KiB and other languages are not highlighted.
 - Documents that cannot be parsed within 2 seconds, or that have more than 100,000 elements or more than 64 levels of nesting, are shown as source.
 
+## Image files
+
+```bash
+vo diagram.png                          # open an image directly
+vo open photo.jpg animation.gif --focus  # open images and switch the view
+vo open images -w                        # also open images added later
+```
+
+Recognized extensions include PNG/APNG, JPEG (`jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `pjpeg`, `pjp`), GIF, WebP, AVIF, SVG, BMP, ICO/CUR, JPEG XL, TIFF, and HEIC/HEIF. Images initially fit the view; "Actual size" shows the original dimensions with scrolling. Saving the file updates the view. Pausing updates keeps the displayed revision. You can open the same image's management UI URL in another browser on the same machine.
+
+The browser decodes the original file without conversion. Supported formats depend on the browser and OS. Unsupported or damaged images show an error. SVG is displayed as an image; scripts and external references cannot run.
+
+Images are searchable by title and path (`vo search diagram --mode path`). Text extraction, `vo read`, and PDF export are for Markdown and HTML; images have no OCR. The existing 10 MiB per-file limit also applies to images.
+
 ## Exporting to PDF
 
 "Export PDF" in the header of a document saves the shown revision as a PDF, without a print dialog.

package/dist/cli.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
-import { C as decodeStateFile, D as daemonEntryPath, E as resolveStateRoot, O as referencedBlobs, S as renameWithRetry, T as resolveRuntimeLocation, a as DAEMON_LOCK_NAME, b as proofMatches, c as readIpcKey, d as inspectOwner, f as readCurrentLock, g as encodeFrame, h as FrameDecoder, i as requirePrivateDirectoryIfExists, k as version, l as readPointer, m as systemProcessProbe, n as ensurePrivateDirectory, o as POINTER_FILE, p as releaseLock, r as inspectPrivateDirectory, s as START_LOCK_NAME, t as startDaemon, u as acquireLock, v as computeProof, w as currentPathEnvironment, x as removeWithRetry, y as createNonce } from "./main-BI-4X6_3.js";
-import { A as successEnvelope, C as VdeError, D as ExitCode, E as isVdeError, O as envelopeSchema, T as isErrorCode, Y as LIMITS, k as errorEnvelope, w as exitCodeForError } from "./search-index-NiN4l6Hg.js";
+import { C as decodeStateFile, D as daemonEntryPath, E as resolveStateRoot, O as referencedBlobs, S as renameWithRetry, T as resolveRuntimeLocation, a as DAEMON_LOCK_NAME, b as proofMatches, c as readIpcKey, d as inspectOwner, f as readCurrentLock, g as encodeFrame, h as FrameDecoder, i as requirePrivateDirectoryIfExists, k as version, l as readPointer, m as systemProcessProbe, n as ensurePrivateDirectory, o as POINTER_FILE, p as releaseLock, r as inspectPrivateDirectory, s as START_LOCK_NAME, t as startDaemon, u as acquireLock, v as computeProof, w as currentPathEnvironment, x as removeWithRetry, y as createNonce } from "./main-BH6i8EXC.js";
+import { A as successEnvelope, C as VdeError, D as ExitCode, E as isVdeError, O as envelopeSchema, T as isErrorCode, Y as LIMITS, k as errorEnvelope, w as exitCodeForError } from "./search-index-BoGly_y4.js";
 import fs, { fstatSync } from "node:fs";
 import { lstat, readFile, readdir, stat as stat$1, writeFile } from "node:fs/promises";
 import path, { join, resolve } from "node:path";
@@ -3848,7 +3848,7 @@ async function runCli(rawArgv, context) {
 		}
 	};
 	const program = new Command();
-	program.name(PROGRAM_NAME).description("Local CLI that shows opened Markdown and HTML in the browser and lets agents list, search, and read parts of them").version(CLI_VERSION, "-V, --version", "Show the version").helpOption("-h, --help", "Show help").addHelpText("after", "\n`vo` is the same command as `vde-open`. Passing a file directly is treated as `open` (for example: vo a.md).\nRunning with no arguments opens the management UI in the browser.").exitOverride().configureOutput({
+	program.name(PROGRAM_NAME).description("Local CLI that shows Markdown, HTML, and images in the browser and lets agents search documents and read text").version(CLI_VERSION, "-V, --version", "Show the version").helpOption("-h, --help", "Show help").addHelpText("after", "\n`vo` is the same command as `vde-open`. Passing a file directly is treated as `open` (for example: vo a.md).\nRunning with no arguments opens the management UI in the browser.").exitOverride().configureOutput({
 		writeOut: context.stdout,
 		writeErr: context.stderr
 	}).action(async () => {

package/dist/daemon.js

@@ -1,5 +1,5 @@
-import { k as version, t as startDaemon, w as currentPathEnvironment } from "./main-BI-4X6_3.js";
-import { E as isVdeError } from "./search-index-NiN4l6Hg.js";
+import { k as version, t as startDaemon, w as currentPathEnvironment } from "./main-BH6i8EXC.js";
+import { E as isVdeError } from "./search-index-BoGly_y4.js";
 //#region src/daemon.ts
 function notifyParent(message) {
 	if (!process.send) return;

package/dist/{html-static-BDV6MgA7.js → html-static-C_wwQAJx.js}

@@ -8090,6 +8090,10 @@ const ASSET_TYPES = {
 		mime: "image/png",
 		role: "image"
 	},
+	apng: {
+		mime: "image/apng",
+		role: "image"
+	},
 	jpg: {
 		mime: "image/jpeg",
 		role: "image"
@@ -8098,6 +8102,26 @@ const ASSET_TYPES = {
 		mime: "image/jpeg",
 		role: "image"
 	},
+	jpe: {
+		mime: "image/jpeg",
+		role: "image"
+	},
+	jif: {
+		mime: "image/jpeg",
+		role: "image"
+	},
+	jfif: {
+		mime: "image/jpeg",
+		role: "image"
+	},
+	pjpeg: {
+		mime: "image/jpeg",
+		role: "image"
+	},
+	pjp: {
+		mime: "image/jpeg",
+		role: "image"
+	},
 	webp: {
 		mime: "image/webp",
 		role: "image"
@@ -8114,6 +8138,38 @@ const ASSET_TYPES = {
 		mime: "image/svg+xml",
 		role: "svg"
 	},
+	bmp: {
+		mime: "image/bmp",
+		role: "image"
+	},
+	ico: {
+		mime: "image/x-icon",
+		role: "image"
+	},
+	cur: {
+		mime: "image/x-icon",
+		role: "image"
+	},
+	jxl: {
+		mime: "image/jxl",
+		role: "image"
+	},
+	tif: {
+		mime: "image/tiff",
+		role: "image"
+	},
+	tiff: {
+		mime: "image/tiff",
+		role: "image"
+	},
+	heic: {
+		mime: "image/heic",
+		role: "image"
+	},
+	heif: {
+		mime: "image/heif",
+		role: "image"
+	},
 	css: {
 		mime: "text/css; charset=utf-8",
 		role: "style"
@@ -8682,6 +8738,17 @@ function analyzeHtml(source) {
 	};
 }
 function analyzeDocument(source, format) {
+	if (format === "image") return {
+		title: null,
+		outline: [],
+		sections: [{
+			sectionId: "sec_0000",
+			level: 0,
+			title: "",
+			headingPath: [],
+			text: ""
+		}]
+	};
 	return format === "markdown" ? analyzeMarkdown(source) : analyzeHtml(source);
 }
 //#endregion

package/dist/{main-BI-4X6_3.js → main-BH6i8EXC.js}

@@ -1,6 +1,6 @@
-import { C as roleAllowed, N as __commonJSMin, P as __toESM, S as isValidLogicalPath, _ as classifyLink, b as encodeLogicalPath, d as analyzeDocument, g as assetTypeOf, u as ParseLimitError, v as classifyReference, x as hasHiddenSegment, y as dirnameOfLogicalPath } from "./html-static-BDV6MgA7.js";
-import { $ as literal, A as successEnvelope, B as readParamsSchema, C as VdeError, D as ExitCode, E as isVdeError, F as htmlModeChangeParamsSchema, G as sha256Schema, H as reorderParamsSchema, I as htmlModeSchema, J as watchRuleSchema, K as sourceKindSchema, L as linkOpenParamsSchema, M as closeParamsSchema, N as documentFormatSchema, P as documentIdSchema, Q as boolean, R as listParamsSchema, S as validateAnswers, U as revisionSchema, V as renderGrantParamsSchema, W as searchParamsSchema, X as _enum, Y as LIMITS, Z as array, _ as feedbackWaitParamsSchema, a as uniqueTokens, at as canonicalJson, b as submissionSchema, c as feedbackAckParamsSchema, d as feedbackDraftParamsSchema, et as number, f as feedbackForgetParamsSchema, g as feedbackSubmitParamsSchema, h as feedbackStatusSchema, i as codePointLength, it as ZodError, j as assetRecordSchema, k as errorEnvelope, l as feedbackCancelParamsSchema, m as feedbackListParamsSchema, n as batchesOf, nt as strictObject, o as answersSchema, p as feedbackIdParamsSchema, q as sourceStateSchema, r as partsOf, rt as string, s as cancellationSchema, tt as record, u as feedbackCreateParamsSchema, v as questionnaireSchema, w as exitCodeForError, x as utf8Length, y as requestIdSchema, z as openParamsSchema } from "./search-index-NiN4l6Hg.js";
-import { n as scanReferences, r as extractTitle } from "./render-BX3arVZj.js";
+import { C as roleAllowed, N as __commonJSMin, P as __toESM, S as isValidLogicalPath, _ as classifyLink, b as encodeLogicalPath, d as analyzeDocument, g as assetTypeOf, u as ParseLimitError, v as classifyReference, x as hasHiddenSegment, y as dirnameOfLogicalPath } from "./html-static-C_wwQAJx.js";
+import { $ as literal, A as successEnvelope, B as readParamsSchema, C as VdeError, D as ExitCode, E as isVdeError, F as htmlModeChangeParamsSchema, G as sha256Schema, H as reorderParamsSchema, I as htmlModeSchema, J as watchRuleSchema, K as sourceKindSchema, L as linkOpenParamsSchema, M as closeParamsSchema, N as documentFormatSchema, P as documentIdSchema, Q as boolean, R as listParamsSchema, S as validateAnswers, U as revisionSchema, V as renderGrantParamsSchema, W as searchParamsSchema, X as _enum, Y as LIMITS, Z as array, _ as feedbackWaitParamsSchema, a as uniqueTokens, at as canonicalJson, b as submissionSchema, c as feedbackAckParamsSchema, d as feedbackDraftParamsSchema, et as number, f as feedbackForgetParamsSchema, g as feedbackSubmitParamsSchema, h as feedbackStatusSchema, i as codePointLength, it as ZodError, j as assetRecordSchema, k as errorEnvelope, l as feedbackCancelParamsSchema, m as feedbackListParamsSchema, n as batchesOf, nt as strictObject, o as answersSchema, p as feedbackIdParamsSchema, q as sourceStateSchema, r as partsOf, rt as string, s as cancellationSchema, tt as record, u as feedbackCreateParamsSchema, v as questionnaireSchema, w as exitCodeForError, x as utf8Length, y as requestIdSchema, z as openParamsSchema } from "./search-index-BoGly_y4.js";
+import { n as scanReferences, r as extractTitle } from "./render-BJa4uW0H.js";
 import { n as measureHeap, t as collectGarbage } from "./heap-C3qHm7SE.js";
 import { accessSync, constants, existsSync, stat, statSync, unwatchFile, watch, watchFile } from "node:fs";
 import { appendFile, chmod, link, lstat, mkdir, mkdtemp, open, readFile, readdir, readlink, realpath, rename, rm, rmdir, stat as stat$1, writeFile } from "node:fs/promises";
@@ -154,7 +154,7 @@ function parseStrictJson(text) {
 }
 //#endregion
 //#region package.json
-var version = "0.1.10";
+var version = "0.1.11";
 //#endregion
 //#region src/documents/cursor.ts
 function invalidCursor(reason) {
@@ -283,7 +283,7 @@ function decodeSource(bytes, label) {
 		throw invalid(label, "invalid-utf8");
 	}
 }
-async function readSourceFile(path) {
+async function readSourceFile(path, format = "markdown") {
 	let canonicalPath;
 	try {
 		canonicalPath = await realpath(path);
@@ -317,7 +317,7 @@ async function readSourceFile(path) {
 			return {
 				canonicalPath,
 				bytes,
-				text: decodeSource(bytes, path),
+				text: format === "image" ? "" : decodeSource(bytes, path),
 				signature: statSignature(after)
 			};
 		} finally {
@@ -3387,7 +3387,10 @@ const FORMAT_BY_EXTENSION = /* @__PURE__ */ new Map([
 	[".htm", "html"]
 ]);
 function formatOfPath(path) {
-	return FORMAT_BY_EXTENSION.get(extname(path).toLowerCase()) ?? null;
+	const document = FORMAT_BY_EXTENSION.get(extname(path).toLowerCase());
+	if (document) return document;
+	const asset = assetTypeOf(path);
+	return asset?.role === "image" || asset?.role === "svg" ? "image" : null;
 }
 function compareText(a, b) {
 	return a < b ? -1 : a > b ? 1 : 0;
@@ -4086,6 +4089,7 @@ const ANALYSIS_CACHE_BYTES = 33554432;
 const MISSING_RETRY_MS = 1e3;
 const MISSING_RETRY_INTERVAL_MS = 100;
 function profileOf(format) {
+	if (format === "image") return "image-v1";
 	return format === "markdown" ? MARKDOWN_PARSER_PROFILE : HTML_STATIC_PARSER_PROFILE;
 }
 function toSummary(record, order, searchState = "excluded", pendingRequestIds = [], interactiveAllowed = false, repository = null) {
@@ -4290,6 +4294,20 @@ var DocumentService = class {
 			});
 			documentLogicalPath = fromRoot.split(sep).join("/");
 		}
+		if (source.format === "image") {
+			const type = assetTypeOf(documentLogicalPath);
+			if (type?.role !== "image" && type?.role !== "svg") throw new VdeError("E_UNSUPPORTED_FORMAT", "The file extension is not an image format.");
+			if (extraAssets.length > 0) throw new VdeError("E_INVALID_ARGUMENT", "--asset is not available for standalone images.");
+			return {
+				...source,
+				assetsRoot,
+				extraAssets: [],
+				documentLogicalPath,
+				assets: [],
+				trackedFiles: [],
+				assetScanFailed: false
+			};
+		}
 		let assetScanFailed = false;
 		const manifest = await buildManifest({
 			format: source.format,
@@ -4598,7 +4616,7 @@ var DocumentService = class {
 		for (const [canonicalPath, { candidate, format }] of resolved.unique) {
 			let loaded;
 			try {
-				loaded = await this.#readSource(candidate.absolutePath);
+				loaded = await this.#readSource(candidate.absolutePath, format);
 			} catch (error) {
 				if (!(error instanceof VdeError)) throw error;
 				problems.push({
@@ -4699,7 +4717,7 @@ var DocumentService = class {
 				sha256
 			}))
 		});
-		const title = options.title ?? extractTitle(item.text, item.format) ?? item.fallbackTitle;
+		const title = options.title ?? (item.format === "image" ? null : extractTitle(item.text, item.format)) ?? item.fallbackTitle;
 		const revisionRecord = {
 			revision,
 			format: item.format,
@@ -4869,6 +4887,10 @@ var DocumentService = class {
 			sectionId = payload["sectionId"];
 		}
 		const entry = this.#requireRevision(record, revision);
+		if (entry.format === "image") throw new VdeError("E_UNSUPPORTED_FORMAT", "Images have no text source, outline, or sections.", {
+			documentId: record.documentId,
+			format: "image"
+		});
 		if (mode === "outline") return this.#readOutline(record, entry, params.maxBytes, offset ?? 0);
 		if (mode === "section") return this.#readSection(record, entry, sectionId ?? "", params.maxBytes, offset ?? 0);
 		const source = await this.#store.readBlob(entry.sourceSha256);
@@ -5245,7 +5267,12 @@ var DocumentService = class {
 		let failure = "error";
 		const deadline = Date.now() + MISSING_RETRY_MS;
 		for (;;) try {
-			loaded = await this.#readSource(canonicalPath);
+			const format = this.#store.payload.documents[documentId]?.format;
+			if (format === void 0) return {
+				changed: false,
+				signature: null
+			};
+			loaded = await this.#readSource(canonicalPath, format);
 			break;
 		} catch (error) {
 			if (!(error instanceof VdeError)) throw error;
@@ -5362,7 +5389,7 @@ var DocumentService = class {
 			if (isOpenPath(before, path) || rule.suppressedPaths.includes(path)) continue;
 			let loaded;
 			try {
-				loaded = await this.#readSource(path);
+				loaded = await this.#readSource(path, format);
 			} catch (error) {
 				if (error instanceof VdeError) continue;
 				throw error;
@@ -5825,6 +5852,7 @@ function createPdfService(options) {
 	const run = async (documentId, revision, signal) => {
 		const started = Date.now();
 		const { record, entry } = documents.describeRevision(documentId, revision);
+		if (entry.format === "image") throw new VdeError("E_UNSUPPORTED_FORMAT", "PDF export is available for Markdown and HTML.");
 		const source = (await store.readBlob(entry.sourceSha256)).toString("utf8");
 		const slot = randomBytes(16).toString("hex");
 		let assets = entry.assets.filter((asset) => asset.role === "image" || asset.role === "svg");
@@ -6916,6 +6944,28 @@ function createRenderService(options) {
 				snapshot: cached
 			};
 		}
+		if (entry.format === "image") {
+			const type = assetTypeOf(entry.documentLogicalPath);
+			if (type?.role !== "image" && type?.role !== "svg") throw new VdeError("E_UNSUPPORTED_FORMAT", "The file extension is not an image format.");
+			return {
+				record,
+				entry,
+				snapshot: {
+					format: "image",
+					documentLogicalPath: entry.documentLogicalPath,
+					hasDocument: true,
+					files: /* @__PURE__ */ new Map([[entry.documentLogicalPath, {
+						kind: "blob",
+						sha256: entry.sourceSha256,
+						...type
+					}]]),
+					assets: [],
+					links: [],
+					diagnostics: [],
+					headingTargets: []
+				}
+			};
+		}
 		const source = (await store.readBlob(entry.sourceSha256)).toString("utf8");
 		const stylesheets = [];
 		for (const asset of entry.assets) {
@@ -7469,7 +7519,7 @@ function createSearchService(options) {
 			if (indexed.get(documentId) === attempt) indexed.delete(documentId);
 		};
 		try {
-			const text = (await store.readBlob(entry.sourceSha256)).toString("utf8");
+			const text = entry.format === "image" ? "" : (await store.readBlob(entry.sourceSha256)).toString("utf8");
 			const { sections } = await analyzeOnce(entry.format, text);
 			if (!current()) {
 				await giveUp(false);

package/dist/{print-Cfa1Ytrj.js → print-vae7mHCU.js}

@@ -1,4 +1,4 @@
-import { A as escapeAttr, D as defaultTreeAdapter, E as serialize, M as footnoteReferenceId, O as NS, T as parseFragment, c as renderedLinkOf, h as parseMarkdownDocument, i as transformStaticHtml, j as escapeHtml$2, k as parseMarkdown, l as MARKDOWN_PARSE_OPTIONS, n as resolveAssetUrl, o as transformCss, s as localImagePath, t as DiagnosticLog, w as parse, y as dirnameOfLogicalPath } from "./html-static-BDV6MgA7.js";
+import { A as escapeAttr, D as defaultTreeAdapter, E as serialize, M as footnoteReferenceId, O as NS, T as parseFragment, c as renderedLinkOf, h as parseMarkdownDocument, i as transformStaticHtml, j as escapeHtml$2, k as parseMarkdown, l as MARKDOWN_PARSE_OPTIONS, n as resolveAssetUrl, o as transformCss, s as localImagePath, t as DiagnosticLog, w as parse, y as dirnameOfLogicalPath } from "./html-static-C_wwQAJx.js";
 //#region ../../node_modules/.pnpm/@tanstack+markdown@1.0.0_react@19.3.0/node_modules/@tanstack/markdown/dist/html.js
 function renderHtml(input, options = {}) {
 	return (typeof input === "string" ? parseMarkdown(input, options) : input).children.map((node) => renderBlock(node, options)).join("\n");

package/dist/{render-BX3arVZj.js → render-BJa4uW0H.js}

@@ -1,4 +1,4 @@
-import { _ as classifyLink, a as scanCssReferences, f as assertWithinLimits, i as transformStaticHtml, k as parseMarkdown, l as MARKDOWN_PARSE_OPTIONS, m as markdownUrlTransform, n as resolveAssetUrl, o as transformCss, p as inlineText$1, r as scanHtmlReferences, t as DiagnosticLog, w as parse, y as dirnameOfLogicalPath } from "./html-static-BDV6MgA7.js";
+import { _ as classifyLink, a as scanCssReferences, f as assertWithinLimits, i as transformStaticHtml, k as parseMarkdown, l as MARKDOWN_PARSE_OPTIONS, m as markdownUrlTransform, n as resolveAssetUrl, o as transformCss, p as inlineText$1, r as scanHtmlReferences, t as DiagnosticLog, w as parse, y as dirnameOfLogicalPath } from "./html-static-C_wwQAJx.js";
 //#region ../../packages/document/src/title.ts
 const TITLE_SCAN_CHARS = 65536;
 const MAX_TITLE_LENGTH = 160;

package/dist/{search-index-NiN4l6Hg.js → search-index-BoGly_y4.js}

@@ -5632,7 +5632,11 @@ const LIMITS = {
 const documentIdSchema = string().regex(/^doc_[0-9a-f-]{36}$/);
 const revisionSchema = string().regex(/^rev_[0-9a-f]{64}$/);
 const sha256Schema = string().regex(/^[0-9a-f]{64}$/);
-const documentFormatSchema = _enum(["markdown", "html"]);
+const documentFormatSchema = _enum([
+	"markdown",
+	"html",
+	"image"
+]);
 const sourceKindSchema = _enum([
 	"file",
 	"stdin",
@@ -5964,7 +5968,11 @@ const searchHitSchema = strictObject({
 	]),
 	score: number(),
 	sourceRange: sourceRangeSchema.nullable(),
-	extraction: _enum(["markdown", "static-html"])
+	extraction: _enum([
+		"markdown",
+		"static-html",
+		"image"
+	])
 });
 strictObject({
 	query: string(),
@@ -8852,7 +8860,7 @@ var SearchIndex = class {
 				matchKind: kind,
 				score: Math.round(score * 1e3) / 1e3,
 				sourceRange: null,
-				extraction: meta.format === "markdown" ? "markdown" : "static-html"
+				extraction: meta.format === "image" ? "image" : meta.format === "markdown" ? "markdown" : "static-html"
 			});
 		}
 		return hits;