@openspecui/server 3.10.0 → 3.11.0

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import { BatchTranslateInputSchema, CliExecutor, CodeEditorThemeSchema, ConfigManager, CustomSoundHashSchema, DASHBOARD_METRIC_KEYS, DashboardConfigSchema, DocumentTranslationConfigSchema, GitConfigSchema, GlobalSettingsManager, LocalModelAssetStateSchema, MarkdownParser, NotificationPublishInputSchema, NotificationSettingsSchema, OPENSPECUI_HOOKS_VERSION, OpenSpecAdapter, OpenSpecUIGlobalSettingsSchema, OpenSpecWatcher, OpsxConfigSchema, OpsxKernel, PtyClientMessageSchema, ReactiveContext, ServiceTranslationEngineIdSchema, TRANSLATION_ENGINE_MANIFESTS, TerminalConfigSchema, TerminalControlParser, TerminalRendererEngineSchema, TranslationCacheReadInputSchema, TranslationCacheSettingsSchema, TranslationCacheWriteInputSchema, TranslationEngineIdSchema, TranslationLocalSettingsSchema, TranslationOpenAISettingsSchema, buildBackendHealthPayload, buildLocalDownloadPlanFromRepositoryFiles, clearCache, getAllTools, getAvailableTools, getConfiguredTools, getDefaultCliCommandString, getDetectedProjectTools, getToolInitStates, getWatcherRuntimeStatus, initWatcherPool, isWatcherPoolInitialized, parseOpsxEntityMetadata, parseOpsxSchemaDetail, resolveTerminalShellDefaults, selectLocalDownloadGroup, sniffGlobalCli, subscribeWatcherRuntimeStatus, terminalNotificationEventToPublishInput } from "@openspecui/core";
-import { basename, dirname, join, matchesGlob, relative, resolve, sep } from "node:path";
+import { BatchTranslateInputSchema, CliExecutor, CodeEditorThemeSchema, ConfigManager, CustomSoundHashSchema, DASHBOARD_METRIC_KEYS, DashboardConfigSchema, DocumentTranslationConfigSchema, GitConfigSchema, GlobalSettingsManager, LocalModelAssetStateSchema, MarkdownParser, NotificationPublishInputSchema, NotificationSettingsSchema, OPENSPECUI_HOOKS_VERSION, OpenSpecAdapter, OpenSpecUIGlobalSettingsSchema, OpenSpecWatcher, OpsxConfigSchema, OpsxKernel, PtyClientMessageSchema, ReactiveContext, ServiceTranslationEngineIdSchema, TRANSLATION_ENGINE_MANIFESTS, TerminalConfigSchema, TerminalControlParser, TerminalRendererEngineSchema, TranslationCacheReadInputSchema, TranslationCacheSettingsSchema, TranslationCacheWriteInputSchema, TranslationEngineIdSchema, TranslationLocalSettingsSchema, TranslationOpenAISettingsSchema, buildBackendHealthPayload, buildLocalDownloadPlanFromRepositoryFiles, clearCache, getAllTools, getAvailableTools, getConfiguredTools, getDefaultCliCommandString, getDetectedProjectTools, getOpsxEntityRootRelativePath, getToolInitStates, getWatcherRuntimeStatus, inferFileMime, inferFilePreviewKind, initWatcherPool, isWatcherPoolInitialized, normalizeOpsxEntityPath, parseOpsxEntityMetadata, parseOpsxSchemaDetail, resolveTerminalShellDefaults, selectLocalDownloadGroup, sniffGlobalCli, subscribeWatcherRuntimeStatus, terminalNotificationEventToPublishInput } from "@openspecui/core";
+import { basename, dirname, extname, join, matchesGlob, relative, resolve, sep } from "node:path";
 import { access, copyFile, lstat, mkdir, open, readFile, readlink, realpath, rename, rm, stat, symlink, unlink, writeFile } from "node:fs/promises";
 import { fileURLToPath, pathToFileURL } from "node:url";
 import { createServer as createServer$1 } from "node:net";
@@ -8,7 +8,7 @@ import { fetchRequestHandler } from "@trpc/server/adapters/fetch";
 import { applyWSSHandler } from "@trpc/server/adapters/ws";
 import { Hono } from "hono";
 import { cors } from "hono/cors";
-import { existsSync, readFileSync } from "node:fs";
+import { existsSync, readFileSync, statSync } from "node:fs";
 import { WebSocketServer } from "ws";
 import { CustomSoundHashSchema as CustomSoundHashSchema$1, CustomSoundIdSchema, CustomSoundMetadataFileSchema, customHashFromSoundId, soundIdFromCustomHash } from "@openspecui/core/sounds";
 import { createHash } from "node:crypto";
@@ -1450,6 +1450,160 @@ async function buildEntityReadOptions(ctx, stage, id) {
 	}
 }
 
+//#endregion
+//#region src/entity-file-paths.ts
+function ensureInsideRoot(rootPath, candidatePath) {
+	if (candidatePath === rootPath) return;
+	if (!candidatePath.startsWith(rootPath + "/")) throw new Error("Resolved path escaped entity root.");
+}
+function getEntityRootPath(projectDir, stage, changeId) {
+	return resolve(projectDir, getOpsxEntityRootRelativePath(stage, changeId));
+}
+function resolveEntityEntryPath(input) {
+	const relativePath$1 = normalizeOpsxEntityPath(input.path);
+	if (!relativePath$1) throw new Error("path is required");
+	const entityRoot = getEntityRootPath(input.projectDir, input.stage, input.changeId);
+	const absolutePath = resolve(entityRoot, relativePath$1);
+	ensureInsideRoot(entityRoot, absolutePath);
+	return {
+		entityRoot,
+		relativePath: relativePath$1,
+		absolutePath
+	};
+}
+
+//#endregion
+//#region src/file-preview-service.ts
+const PREVIEW_ENTRY_FILE_BY_KIND = {
+	image: "image-preview.html",
+	audio: "audio-preview.html",
+	video: "video-preview.html",
+	pdf: "pdf-preview.html"
+};
+const SESSION_PREVIEW_KINDS = new Set([
+	"html",
+	"image",
+	"audio",
+	"video",
+	"pdf"
+]);
+function isSessionPreviewKind(previewKind) {
+	return SESSION_PREVIEW_KINDS.has(previewKind);
+}
+function toHash(input) {
+	return createHash("sha256").update(input).digest("hex");
+}
+function stripLeadingSlash(path) {
+	return path.replace(/^\/+/, "");
+}
+function inferPreviewAssetContentType(path) {
+	switch (extname(path).toLowerCase()) {
+		case ".html": return "text/html";
+		case ".js":
+		case ".mjs": return "application/javascript";
+		case ".css": return "text/css";
+		case ".json": return "application/json";
+		case ".svg": return "image/svg+xml";
+		case ".png": return "image/png";
+		case ".jpg":
+		case ".jpeg": return "image/jpeg";
+		case ".woff": return "font/woff";
+		case ".woff2": return "font/woff2";
+		default: return inferFileMime(path) ?? "application/octet-stream";
+	}
+}
+function isRewritablePreviewAsset(path) {
+	const extension = extname(path).toLowerCase();
+	return extension === ".html" || extension === ".js" || extension === ".mjs" || extension === ".css";
+}
+function rewritePreviewAssetPaths(content, hash) {
+	const sessionAssetPrefix = `/api/file-preview/${hash}/assets/`;
+	return content.replaceAll("/assets/", sessionAssetPrefix);
+}
+var FilePreviewService = class {
+	sessions = /* @__PURE__ */ new Map();
+	constructor(projectDir, previewAssetsDir) {
+		this.projectDir = projectDir;
+		this.previewAssetsDir = previewAssetsDir;
+	}
+	prepareEntityFilePreview(input) {
+		const resolved = resolveEntityEntryPath({
+			projectDir: this.projectDir,
+			stage: input.stage,
+			changeId: input.changeId,
+			path: input.path
+		});
+		if (!statSync(resolved.absolutePath, { throwIfNoEntry: false })?.isFile()) throw new Error("Preview target file not found.");
+		const mime = inferFileMime(resolved.relativePath);
+		if (!mime) throw new Error("Preview target mime is unknown.");
+		const previewKind = inferFilePreviewKind(resolved.relativePath, mime);
+		if (!isSessionPreviewKind(previewKind)) throw new Error("Preview route is not supported for this file type.");
+		const directoryPath = resolve(resolved.absolutePath, "..");
+		const hash = toHash(`${directoryPath}:${mime}`);
+		const entryFileName = previewKind === "html" ? null : PREVIEW_ENTRY_FILE_BY_KIND[previewKind];
+		const fileName = basename(resolved.absolutePath);
+		this.sessions.set(hash, {
+			hash,
+			directoryPath,
+			mime,
+			previewKind,
+			entryFileName
+		});
+		const htmlPathname = `/api/file-preview/${hash}/${fileName}`;
+		const resourcePathname = previewKind === "html" ? null : `/api/file-preview/${hash}/resource/${fileName}`;
+		const entryPathname = previewKind === "html" ? htmlPathname : `/api/file-preview/${hash}/${entryFileName}`;
+		return {
+			hash,
+			mime,
+			previewKind,
+			relativePath: resolved.relativePath,
+			resourcePathname,
+			entryPathname,
+			urlPath: previewKind === "html" ? htmlPathname : `${entryPathname}?file=${encodeURIComponent(fileName)}`
+		};
+	}
+	readPreviewRequest(hash, requestPath) {
+		const session = this.sessions.get(hash);
+		if (!session) return null;
+		const normalized = stripLeadingSlash(requestPath);
+		if (session.previewKind === "html") {
+			const absolutePath$1 = resolve(session.directoryPath, normalized);
+			if (!absolutePath$1.startsWith(session.directoryPath + "/")) return null;
+			if (!existsSync(absolutePath$1) || !statSync(absolutePath$1).isFile()) return null;
+			return {
+				content: readFileSync(absolutePath$1),
+				contentType: inferFileMime(absolutePath$1) ?? "application/octet-stream"
+			};
+		}
+		if (normalized.startsWith("resource/")) {
+			const resourcePath = normalized.slice(9);
+			const absolutePath$1 = resolve(session.directoryPath, resourcePath);
+			if (!absolutePath$1.startsWith(session.directoryPath + "/")) return null;
+			if (!existsSync(absolutePath$1) || !statSync(absolutePath$1).isFile()) return null;
+			return {
+				content: readFileSync(absolutePath$1),
+				contentType: inferFileMime(absolutePath$1) ?? "application/octet-stream"
+			};
+		}
+		const assetName = normalized || session.entryFileName;
+		if (!assetName) return null;
+		const absolutePath = resolve(this.previewAssetsDir, assetName);
+		if (!absolutePath.startsWith(resolve(this.previewAssetsDir) + "/")) return null;
+		if (!existsSync(absolutePath) || !statSync(absolutePath).isFile()) return null;
+		if (isRewritablePreviewAsset(assetName)) {
+			const rewritten = rewritePreviewAssetPaths(readFileSync(absolutePath, "utf8"), hash);
+			return {
+				content: Buffer.from(rewritten, "utf8"),
+				contentType: inferPreviewAssetContentType(absolutePath)
+			};
+		}
+		return {
+			content: readFileSync(absolutePath),
+			contentType: inferPreviewAssetContentType(absolutePath)
+		};
+	}
+};
+
 //#endregion
 //#region src/huggingface-endpoint.ts
 const DEFAULT_HUGGING_FACE_ENDPOINT = "https://huggingface.co";
@@ -5290,6 +5444,31 @@ const changeRouter = router({
 	}),
 	subscribeFiles: publicProcedure.input(z.object({ id: z.string() })).subscription(({ ctx, input }) => {
 		return createReactiveSubscriptionWithInput((id) => ctx.adapter.readChangeFiles(id))(input.id);
+	}),
+	writeFile: publicProcedure.input(z.object({
+		id: z.string(),
+		path: z.string(),
+		content: z.string()
+	})).mutation(async ({ ctx, input }) => {
+		const info = resolveEntityEntryPath({
+			projectDir: ctx.projectDir,
+			stage: "change",
+			changeId: input.id,
+			path: input.path
+		});
+		await mkdir(dirname(info.absolutePath), { recursive: true });
+		await writeFile(info.absolutePath, input.content, "utf-8");
+		return { success: true };
+	}),
+	prepareFilePreview: publicProcedure.input(z.object({
+		id: z.string(),
+		path: z.string()
+	})).query(({ ctx, input }) => {
+		return ctx.filePreviewService.prepareEntityFilePreview({
+			stage: "change",
+			changeId: input.id,
+			path: input.path
+		});
 	})
 });
 /**
@@ -5322,9 +5501,32 @@ const archiveRouter = router({
 		return createReactiveSubscriptionWithInput(async (id) => ctx.documentService.readEntityDetail("archive", id, "view", "processed", await buildEntityReadOptions(ctx, "archive", id)))(input.id);
 	}),
 	subscribeFiles: publicProcedure.input(z.object({ id: z.string() })).subscription(({ ctx, input }) => {
-		return createReactiveSubscriptionWithInput(async (id) => {
-			return (await ctx.documentService.readEntityDetail("archive", id, "view", "processed", await buildEntityReadOptions(ctx, "archive", id)))?.files ?? [];
-		})(input.id);
+		return createReactiveSubscriptionWithInput((id) => ctx.documentService.readArchivedChangeFiles(id, "view", "source"))(input.id);
+	}),
+	writeFile: publicProcedure.input(z.object({
+		id: z.string(),
+		path: z.string(),
+		content: z.string()
+	})).mutation(async ({ ctx, input }) => {
+		const info = resolveEntityEntryPath({
+			projectDir: ctx.projectDir,
+			stage: "archive",
+			changeId: input.id,
+			path: input.path
+		});
+		await mkdir(dirname(info.absolutePath), { recursive: true });
+		await writeFile(info.absolutePath, input.content, "utf-8");
+		return { success: true };
+	}),
+	prepareFilePreview: publicProcedure.input(z.object({
+		id: z.string(),
+		path: z.string()
+	})).query(({ ctx, input }) => {
+		return ctx.filePreviewService.prepareEntityFilePreview({
+			stage: "archive",
+			changeId: input.id,
+			path: input.path
+		});
 	})
 });
 z.object({
@@ -6940,6 +7142,7 @@ function createServer(config) {
 	const kernel = config.kernel;
 	const hookRuntime = createHookRuntime(config.projectDir);
 	const documentService = new DocumentService(config.projectDir, adapter, hookRuntime);
+	const filePreviewService = new FilePreviewService(config.projectDir, config.previewAssetsDir ?? join(__dirname, "..", "..", "web", "dist"));
 	const workflowInvocationService = new WorkflowInvocationService({
 		projectDir: config.projectDir,
 		hookRuntime,
@@ -7054,6 +7257,21 @@ function createServer(config) {
 			"Cache-Control": "private, max-age=31536000, immutable"
 		} });
 	});
+	app.get("/api/file-preview/:hash/*", async (c) => {
+		const hash = c.req.param("hash");
+		const prefix = `/api/file-preview/${hash}/`;
+		const requestPath = c.req.path.startsWith(prefix) ? c.req.path.slice(prefix.length) : "";
+		const asset = filePreviewService.readPreviewRequest(hash, requestPath);
+		if (!asset) return c.notFound();
+		const stream = new ReadableStream({ start(controller) {
+			controller.enqueue(new Uint8Array(asset.content));
+			controller.close();
+		} });
+		return new Response(stream, {
+			status: 200,
+			headers: { "Content-Type": asset.contentType }
+		});
+	});
 	app.use("/trpc/*", async (c) => {
 		return await fetchRequestHandler({
 			endpoint: "/trpc",
@@ -7073,6 +7291,7 @@ function createServer(config) {
 				customSoundService,
 				globalSettingsManager,
 				translationCacheService,
+				filePreviewService,
 				translationEngineService,
 				localModelAssetService,
 				gitWorktreeHandoff: config.gitWorktreeHandoff,
@@ -7095,6 +7314,7 @@ function createServer(config) {
 		customSoundService,
 		globalSettingsManager,
 		translationCacheService,
+		filePreviewService,
 		translationEngineService,
 		localModelAssetService,
 		gitWorktreeHandoff: config.gitWorktreeHandoff,
@@ -7116,7 +7336,9 @@ function createServer(config) {
 		customSoundService,
 		globalSettingsManager,
 		translationCacheService,
+		filePreviewService,
 		translationEngineService,
+		localModelAssetService,
 		hookRuntime,
 		watcher,
 		createContext,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openspecui/server",
-  "version": "3.10.0",
+  "version": "3.11.0",
   "type": "module",
   "main": "dist/index.mjs",
   "exports": {
@@ -25,8 +25,8 @@
     "@huggingface/hub": "^2.12.0",
     "@huggingface/transformers": "^4.2.0",
     "@lydell/node-pty": "^1.1.0",
-    "@openspecui/core": "3.10.0",
-    "@openspecui/search": "3.10.0",
+    "@openspecui/core": "3.11.0",
+    "@openspecui/search": "3.11.0",
     "@trpc/server": "^11.0.0",
     "@types/better-sqlite3": "^7.6.13",
     "better-sqlite3": "^12.5.0",