@openspecui/server 3.6.1 → 3.7.0

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import { CliExecutor, CodeEditorThemeSchema, ConfigManager, CustomSoundHashSchema, DASHBOARD_METRIC_KEYS, DashboardConfigSchema, GitConfigSchema, HOSTED_SHELL_PROTOCOL_VERSION, MarkdownParser, NotificationPublishInputSchema, NotificationSettingsSchema, OPENSPECUI_HOOKS_VERSION, OpenSpecAdapter, OpenSpecWatcher, OpsxConfigSchema, OpsxKernel, PtyClientMessageSchema, ReactiveContext, TerminalConfigSchema, TerminalControlParser, TerminalRendererEngineSchema, getAllTools, getAvailableTools, getConfiguredTools, getDefaultCliCommandString, getDetectedProjectTools, getToolInitStates, getWatcherRuntimeStatus, initWatcherPool, isWatcherPoolInitialized, resolveTerminalShellDefaults, sniffGlobalCli, subscribeWatcherRuntimeStatus, terminalNotificationEventToPublishInput } from "@openspecui/core";
-import { basename, dirname, join, relative, resolve, sep } from "node:path";
+import { CliExecutor, CodeEditorThemeSchema, ConfigManager, CustomSoundHashSchema, DASHBOARD_METRIC_KEYS, DashboardConfigSchema, DocumentTranslationConfigSchema, GitConfigSchema, HOSTED_SHELL_PROTOCOL_VERSION, MarkdownParser, NotificationPublishInputSchema, NotificationSettingsSchema, OPENSPECUI_HOOKS_VERSION, OpenSpecAdapter, OpenSpecWatcher, OpsxConfigSchema, OpsxKernel, PtyClientMessageSchema, ReactiveContext, TerminalConfigSchema, TerminalControlParser, TerminalRendererEngineSchema, getAllTools, getAvailableTools, getConfiguredTools, getDefaultCliCommandString, getDetectedProjectTools, getToolInitStates, getWatcherRuntimeStatus, initWatcherPool, isWatcherPoolInitialized, parseOpsxEntityMetadata, parseOpsxSchemaDetail, resolveTerminalShellDefaults, sniffGlobalCli, subscribeWatcherRuntimeStatus, terminalNotificationEventToPublishInput } from "@openspecui/core";
+import { basename, dirname, join, matchesGlob, relative, resolve, sep } from "node:path";
 import { access, mkdir, readFile, realpath, rm, stat, writeFile } from "node:fs/promises";
 import { fileURLToPath, pathToFileURL } from "node:url";
 import { createServer as createServer$1 } from "node:net";
@@ -35,6 +35,9 @@ function toErrorDiagnostic$1(error) {
 function isNotNull(value) {
 	return value !== null;
 }
+function normalizeChangeFilePath(path) {
+	return path.replace(/\\/g, "/").replace(/^\/+/, "");
+}
 var DocumentService = class {
 	parser = new MarkdownParser();
 	constructor(projectDir, adapter, hookRuntime) {
@@ -176,37 +179,125 @@ var DocumentService = class {
 			return null;
 		}
 	}
+	async readEntityDetail(stage, changeId, consumer = "view", mode = "processed", options = {}) {
+		const detail = await this.adapter.readEntityDetail(stage, changeId, options);
+		if (!detail) return null;
+		const root = stage === "change" ? `openspec/changes/${changeId}` : `openspec/changes/archive/${changeId}`;
+		const processedByPath = /* @__PURE__ */ new Map();
+		const processArtifactFile = async (artifact, file) => {
+			const artifactFile = {
+				...await this.processEntityFile({
+					stage,
+					changeId,
+					root,
+					file,
+					consumer,
+					mode,
+					schemaName: detail.schemaName,
+					artifactId: artifact.id,
+					artifactOutputPath: artifact.outputPath
+				}),
+				type: "file"
+			};
+			processedByPath.set(file.path, artifactFile);
+			return artifactFile;
+		};
+		const artifacts = await Promise.all(detail.artifacts.map(async (artifact) => ({
+			...artifact,
+			files: await Promise.all(artifact.files.map((file) => processArtifactFile(artifact, file)))
+		})));
+		const files = await Promise.all(detail.files.map(async (file) => {
+			const processed = processedByPath.get(file.path);
+			if (processed) return processed;
+			return this.processEntityFile({
+				stage,
+				changeId,
+				root,
+				file,
+				consumer,
+				mode,
+				schemaName: detail.schemaName
+			});
+		}));
+		const filesByPath = new Map(files.map((file) => [file.path, file]));
+		const ungroupedFiles = detail.ungroupedFiles.map((file) => filesByPath.get(file.path) ?? file);
+		return {
+			...detail,
+			files,
+			artifacts,
+			ungroupedFiles
+		};
+	}
 	async readChangeFiles(changeId, consumer = "view", mode = "processed") {
 		const files = await this.adapter.readChangeFiles(changeId);
 		return this.processChangeFiles("change", changeId, files, consumer, mode);
 	}
+	async readChangeArtifactOutput(changeId, outputPath, consumer = "view", mode = "processed") {
+		const normalizedPath = normalizeChangeFilePath(outputPath);
+		return (await this.readChangeArtifactFiles(changeId, normalizedPath, consumer, mode)).find((file) => file.path === normalizedPath)?.content ?? null;
+	}
+	async readChangeGlobArtifactFiles(changeId, outputPath, consumer = "view", mode = "processed") {
+		const normalizedPattern = normalizeChangeFilePath(outputPath);
+		return this.readChangeArtifactFiles(changeId, normalizedPattern, consumer, mode);
+	}
 	async readArchivedChangeFiles(changeId, consumer = "view", mode = "processed") {
 		const files = await this.adapter.readArchivedChangeFiles(changeId);
 		return this.processChangeFiles("archive", changeId, files, consumer, mode);
 	}
 	async processChangeFiles(stage, changeId, files, consumer, mode) {
 		const root = stage === "change" ? `openspec/changes/${changeId}` : `openspec/changes/archive/${changeId}`;
-		return (await Promise.all(files.map(async (file) => {
-			if (file.type !== "file" || file.content === void 0 || !file.path.endsWith(".md")) return file;
-			const kind = this.inferChangeFileKind(file.path);
-			if (!kind) return file;
-			const result = await this.processDocument({
-				consumer,
-				mode,
-				document: {
-					stage,
-					kind,
-					changeId,
-					relativePath: `${root}/${file.path}`,
-					absolutePath: join(this.projectDir, root, file.path)
-				},
-				source: file.content
-			});
-			return {
-				...file,
-				content: result.markdown
-			};
-		}))).filter(isNotNull);
+		return (await Promise.all(files.map((file) => this.processChangeFile(stage, changeId, root, file, consumer, mode)))).filter(isNotNull);
+	}
+	async readChangeArtifactFiles(changeId, outputPath, consumer, mode) {
+		const matchingFiles = (await this.adapter.readChangeFiles(changeId)).filter((file) => {
+			if (file.type !== "file" || file.content === void 0) return false;
+			return matchesGlob(file.path, outputPath) || file.path === outputPath;
+		});
+		const root = `openspec/changes/${changeId}`;
+		return (await Promise.all(matchingFiles.map((file) => this.processChangeFile("change", changeId, root, file, consumer, mode)))).filter(isNotNull).filter((file) => file.type === "file" && file.content !== void 0);
+	}
+	async processChangeFile(stage, changeId, root, file, consumer, mode) {
+		if (file.type !== "file" || file.content === void 0 || !file.path.endsWith(".md")) return file;
+		const kind = this.inferChangeFileKind(file.path);
+		if (!kind) return file;
+		const result = await this.processDocument({
+			consumer,
+			mode,
+			document: {
+				stage,
+				kind,
+				changeId,
+				relativePath: `${root}/${file.path}`,
+				absolutePath: join(this.projectDir, root, file.path)
+			},
+			source: file.content
+		});
+		return {
+			...file,
+			content: result.markdown
+		};
+	}
+	async processEntityFile(input) {
+		if (input.file.type !== "file" || input.file.content === void 0 || !input.file.path.endsWith(".md")) return input.file;
+		const result = await this.processDocument({
+			consumer: input.consumer,
+			mode: input.mode,
+			document: {
+				stage: input.stage,
+				kind: "artifact",
+				changeId: input.changeId,
+				schemaName: input.schemaName,
+				artifactId: input.artifactId,
+				artifactOutputPath: input.artifactOutputPath,
+				relativePath: `${input.root}/${input.file.path}`,
+				absolutePath: join(this.projectDir, input.root, input.file.path)
+			},
+			source: input.file.content
+		});
+		return {
+			...input.file,
+			content: result.markdown
+		};
 	}
 	inferChangeFileKind(path) {
 		if (path === "proposal.md") return "proposal";
@@ -1194,16 +1285,11 @@ async function loadDashboardOverview(ctx, reason = "dashboard-refresh") {
 		updatedAt: changeMeta.updatedAt
 	}));
 	const activeChanges = selectRecentDashboardItems(allActiveChanges);
-	const archivedChanges = (await Promise.all(archiveMetas.map(async (meta) => {
-		const change = await ctx.adapter.readArchivedChange(meta.id);
-		if (!change) return null;
-		return {
-			id: meta.id,
-			createdAt: meta.createdAt,
-			updatedAt: meta.updatedAt,
-			tasksCompleted: change.tasks.filter((task) => task.completed).length
-		};
-	}))).filter((item) => item !== null);
+	const archivedChanges = archiveMetas.map((meta) => ({
+		id: meta.id,
+		createdAt: meta.createdAt,
+		updatedAt: meta.updatedAt
+	}));
 	const allSpecifications = (await Promise.all(specMetas.map(async (meta) => {
 		const spec = await ctx.adapter.readSpec(meta.id);
 		if (!spec) return null;
@@ -1218,7 +1304,7 @@ async function loadDashboardOverview(ctx, reason = "dashboard-refresh") {
 	const requirements = allSpecifications.reduce((sum, spec) => sum + spec.requirements, 0);
 	const tasksTotal = allActiveChanges.reduce((sum, change) => sum + change.progress.total, 0);
 	const tasksCompleted = allActiveChanges.reduce((sum, change) => sum + change.progress.completed, 0);
-	const archivedTasksCompleted = archivedChanges.reduce((sum, change) => sum + change.tasksCompleted, 0);
+	const archivedTasksCompleted = 0;
 	const taskCompletionPercent = tasksTotal > 0 ? Math.round(tasksCompleted / tasksTotal * 100) : null;
 	const inProgressChanges = allActiveChanges.filter((change) => change.progress.total > 0 && change.progress.completed < change.progress.total).length;
 	const specificationTrendEvents = specMetas.flatMap((spec) => {
@@ -1232,7 +1318,7 @@ async function loadDashboardOverview(ctx, reason = "dashboard-refresh") {
 		const ts = parseDatedIdTimestamp(archive.id) ?? resolveTrendTimestamp(archive.updatedAt, archive.createdAt);
 		return ts === null ? [] : [{
 			ts,
-			value: archive.tasksCompleted
+			value: 1
 		}];
 	});
 	const specMetaById = new Map(specMetas.map((meta) => [meta.id, meta]));
@@ -1339,6 +1425,29 @@ async function loadDashboardOverview(ctx, reason = "dashboard-refresh") {
 	};
 }
 
+//#endregion
+//#region src/entity-read-options.ts
+async function readEntityMetadata(ctx, stage, id) {
+	return (stage === "change" ? await ctx.adapter.readChangeFiles(id) : await ctx.adapter.readArchivedChangeFiles(id)).find((file) => file.type === "file" && file.path === ".openspec.yaml")?.content ?? null;
+}
+async function buildEntityReadOptions(ctx, stage, id) {
+	const schemaName = parseOpsxEntityMetadata(await readEntityMetadata(ctx, stage, id)).schemaName;
+	if (!schemaName) return {};
+	try {
+		await ctx.kernel.waitForWarmup();
+		await ctx.kernel.ensureSchemaDetail(schemaName);
+		await ctx.kernel.ensureSchemaYaml(schemaName);
+		const schemaYaml = ctx.kernel.getSchemaYaml(schemaName);
+		const diagnostics = schemaYaml ? parseOpsxSchemaDetail(schemaYaml, schemaName, { path: `schema:${schemaName}` }).diagnostics : [];
+		return {
+			schemas: { [schemaName]: ctx.kernel.getSchemaDetail(schemaName) },
+			schemaDiagnostics: diagnostics.length > 0 ? { [schemaName]: diagnostics } : void 0
+		};
+	} catch {
+		return { schemas: {} };
+	}
+}
+
 //#endregion
 //#region src/notification-service.ts
 var NotificationService = class {
@@ -3283,19 +3392,21 @@ const archiveRouter = router({
 		return ctx.adapter.listArchivedChangesWithMeta();
 	}),
 	get: publicProcedure.input(z.object({ id: z.string() })).query(async ({ ctx, input }) => {
-		return ctx.documentService.readArchivedChange(input.id);
+		return ctx.documentService.readEntityDetail("archive", input.id, "view", "processed", await buildEntityReadOptions(ctx, "archive", input.id));
 	}),
 	getRaw: publicProcedure.input(z.object({ id: z.string() })).query(async ({ ctx, input }) => {
-		return ctx.adapter.readArchivedChangeRaw(input.id);
+		return ctx.documentService.readEntityDetail("archive", input.id, "view", "source", await buildEntityReadOptions(ctx, "archive", input.id));
 	}),
 	subscribe: publicProcedure.subscription(({ ctx }) => {
 		return createReactiveSubscription(() => ctx.adapter.listArchivedChangesWithMeta());
 	}),
 	subscribeOne: publicProcedure.input(z.object({ id: z.string() })).subscription(({ ctx, input }) => {
-		return createReactiveSubscriptionWithInput((id) => ctx.documentService.readArchivedChange(id))(input.id);
+		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((id) => ctx.adapter.readArchivedChangeFiles(id))(input.id);
+		return createReactiveSubscriptionWithInput(async (id) => {
+			return (await ctx.documentService.readEntityDetail("archive", id, "view", "processed", await buildEntityReadOptions(ctx, "archive", id)))?.files ?? [];
+		})(input.id);
 	})
 });
 z.object({
@@ -3397,13 +3508,14 @@ const configRouter = router({
 		terminal: TerminalConfigSchema.omit({ rendererEngine: true }).partial().extend({ rendererEngine: TerminalRendererEngineSchema.optional() }).optional(),
 		dashboard: DashboardConfigSchema.partial().optional(),
 		git: GitConfigSchema.partial().optional(),
-		notifications: NotificationSettingsSchema.partial().optional()
+		notifications: NotificationSettingsSchema.partial().optional(),
+		translation: DocumentTranslationConfigSchema.partial().optional()
 	})).mutation(async ({ ctx, input }) => {
 		const hasCliCommand = input.cli !== void 0 && Object.prototype.hasOwnProperty.call(input.cli, "command");
 		const hasCliArgs = input.cli !== void 0 && Object.prototype.hasOwnProperty.call(input.cli, "args");
 		if (hasCliCommand && !hasCliArgs) {
 			await ctx.configManager.setCliCommand(input.cli?.command ?? "");
-			if (input.theme !== void 0 || input.codeEditor !== void 0 || input.appBaseUrl !== void 0 || input.opsx !== void 0 || input.terminal !== void 0 || input.dashboard !== void 0 || input.git !== void 0 || input.notifications !== void 0) await ctx.configManager.writeConfig({
+			if (input.theme !== void 0 || input.codeEditor !== void 0 || input.appBaseUrl !== void 0 || input.opsx !== void 0 || input.terminal !== void 0 || input.dashboard !== void 0 || input.git !== void 0 || input.notifications !== void 0 || input.translation !== void 0) await ctx.configManager.writeConfig({
 				theme: input.theme,
 				codeEditor: input.codeEditor,
 				appBaseUrl: input.appBaseUrl,
@@ -3411,7 +3523,8 @@ const configRouter = router({
 				terminal: input.terminal,
 				dashboard: input.dashboard,
 				git: input.git,
-				notifications: input.notifications
+				notifications: input.notifications,
+				translation: input.translation
 			});
 			return { success: true };
 		}
@@ -3820,7 +3933,7 @@ const opsxRouter = router({
 	})).query(async ({ ctx, input }) => {
 		await ctx.kernel.waitForWarmup();
 		await ctx.kernel.ensureArtifactOutput(input.changeId, input.outputPath);
-		return ctx.kernel.getArtifactOutput(input.changeId, input.outputPath);
+		return ctx.documentService.readChangeArtifactOutput(input.changeId, input.outputPath, "view", "processed");
 	}),
 	subscribeArtifactOutput: publicProcedure.input(z.object({
 		changeId: z.string(),
@@ -3829,7 +3942,7 @@ const opsxRouter = router({
 		return createReactiveSubscription(async () => {
 			await ctx.kernel.waitForWarmup();
 			await ctx.kernel.ensureArtifactOutput(input.changeId, input.outputPath);
-			return ctx.kernel.getArtifactOutput(input.changeId, input.outputPath);
+			return ctx.documentService.readChangeArtifactOutput(input.changeId, input.outputPath, "view", "processed");
 		});
 	}),
 	readGlobArtifactFiles: publicProcedure.input(z.object({
@@ -3838,7 +3951,7 @@ const opsxRouter = router({
 	})).query(async ({ ctx, input }) => {
 		await ctx.kernel.waitForWarmup();
 		await ctx.kernel.ensureGlobArtifactFiles(input.changeId, input.outputPath);
-		return ctx.kernel.getGlobArtifactFiles(input.changeId, input.outputPath);
+		return ctx.documentService.readChangeGlobArtifactFiles(input.changeId, input.outputPath, "view", "processed");
 	}),
 	subscribeGlobArtifactFiles: publicProcedure.input(z.object({
 		changeId: z.string(),
@@ -3847,7 +3960,7 @@ const opsxRouter = router({
 		return createReactiveSubscription(async () => {
 			await ctx.kernel.waitForWarmup();
 			await ctx.kernel.ensureGlobArtifactFiles(input.changeId, input.outputPath);
-			return ctx.kernel.getGlobArtifactFiles(input.changeId, input.outputPath);
+			return ctx.documentService.readChangeGlobArtifactFiles(input.changeId, input.outputPath, "view", "processed");
 		});
 	}),
 	writeArtifactOutput: publicProcedure.input(z.object({
@@ -4067,7 +4180,7 @@ const appRouter = router({
 function joinParts(parts) {
 	return parts.map((part) => part?.trim() ?? "").filter((part) => part.length > 0).join("\n\n");
 }
-async function collectSearchDocuments(adapter, documentService) {
+async function collectSearchDocuments(adapter, documentService, resolveEntityReadOptions) {
 	const docs = [];
 	const specs = await adapter.listSpecsWithMeta();
 	for (const spec of specs) {
@@ -4104,20 +4217,16 @@ async function collectSearchDocuments(adapter, documentService) {
 	}
 	const archives = await adapter.listArchivedChangesWithMeta();
 	for (const archive of archives) {
-		const raw = documentService ? await documentService.readArchivedChangeRaw(archive.id, "search", "processed") : await adapter.readArchivedChangeRaw(archive.id);
-		if (!raw) continue;
+		const entityOptions = resolveEntityReadOptions ? await resolveEntityReadOptions("archive", archive.id) : void 0;
+		const entity = documentService ? await documentService.readEntityDetail("archive", archive.id, "search", "processed", entityOptions) : await adapter.readEntityDetail("archive", archive.id);
+		if (!entity) continue;
 		docs.push({
 			id: `archive:${archive.id}`,
 			kind: "archive",
 			title: archive.name,
 			href: `/archive/${encodeURIComponent(archive.id)}`,
 			path: `openspec/changes/archive/${archive.id}`,
-			content: joinParts([
-				typeof raw.proposal === "string" ? raw.proposal : raw.proposal.markdown,
-				typeof raw.tasks === "string" ? raw.tasks : raw.tasks.markdown,
-				typeof raw.design === "string" ? raw.design : raw.design?.markdown,
-				...raw.deltaSpecs.map((deltaSpec) => deltaSpec.content)
-			]),
+			content: joinParts(entity.files.filter((file) => file.type === "file").map((file) => file.content)),
 			updatedAt: archive.updatedAt
 		});
 	}
@@ -4133,9 +4242,10 @@ var SearchService = class {
 	initPromise = null;
 	rebuildPromise = null;
 	rebuildTimer = null;
-	constructor(adapter, watcher, provider = new NodeWorkerSearchProvider(), documentService) {
+	constructor(adapter, watcher, provider = new NodeWorkerSearchProvider(), documentService, resolveEntityReadOptions) {
 		this.adapter = adapter;
 		this.documentService = documentService;
+		this.resolveEntityReadOptions = resolveEntityReadOptions;
 		this.provider = provider;
 		watcher?.on("change", () => {
 			this.scheduleRebuild();
@@ -4181,7 +4291,7 @@ var SearchService = class {
 		if (!forceInit && !this.initialized) return;
 		if (this.rebuildPromise) return this.rebuildPromise;
 		this.rebuildPromise = (async () => {
-			const docs = await collectSearchDocuments(this.adapter, this.documentService);
+			const docs = await collectSearchDocuments(this.adapter, this.documentService, this.resolveEntityReadOptions);
 			if (this.initialized) await this.provider.replaceAll(docs);
 			else {
 				await this.provider.init(docs);
@@ -4454,7 +4564,11 @@ function createServer(config) {
 	const notificationService = new NotificationService();
 	const customSoundService = new CustomSoundService();
 	const watcher = config.enableWatcher !== false ? new OpenSpecWatcher(config.projectDir) : void 0;
-	const searchService = new SearchService(adapter, watcher, void 0, documentService);
+	const entityReadOptionsContext = {
+		adapter,
+		kernel
+	};
+	const searchService = new SearchService(adapter, watcher, void 0, documentService, (stage, id) => buildEntityReadOptions(entityReadOptionsContext, stage, id));
 	const dashboardOverviewService = new DashboardOverviewService((reason) => loadDashboardOverview({
 		adapter,
 		configManager,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openspecui/server",
-  "version": "3.6.1",
+  "version": "3.7.0",
   "type": "module",
   "main": "dist/index.mjs",
   "exports": {