@openspecui/core 4.1.0 → 6.0.0-beta.0

package/dist/schemas-BFroDdOC.mjs

@@ -0,0 +1,287 @@
+import { z } from "zod";
+
+//#region src/file-preview.ts
+const MIME_BY_EXTENSION = new Map([
+	[".md", "text/markdown"],
+	[".markdown", "text/markdown"],
+	[".mdown", "text/markdown"],
+	[".mkd", "text/markdown"],
+	[".txt", "text/plain"],
+	[".log", "text/plain"],
+	[".yaml", "application/yaml"],
+	[".yml", "application/yaml"],
+	[".json", "application/json"],
+	[".jsonc", "application/json"],
+	[".toml", "application/toml"],
+	[".ini", "text/plain"],
+	[".cfg", "text/plain"],
+	[".conf", "text/plain"],
+	[".html", "text/html"],
+	[".htm", "text/html"],
+	[".svg", "image/svg+xml"],
+	[".png", "image/png"],
+	[".jpg", "image/jpeg"],
+	[".jpeg", "image/jpeg"],
+	[".gif", "image/gif"],
+	[".webp", "image/webp"],
+	[".avif", "image/avif"],
+	[".bmp", "image/bmp"],
+	[".mp3", "audio/mpeg"],
+	[".wav", "audio/wav"],
+	[".ogg", "audio/ogg"],
+	[".oga", "audio/ogg"],
+	[".m4a", "audio/mp4"],
+	[".aac", "audio/aac"],
+	[".flac", "audio/flac"],
+	[".mp4", "video/mp4"],
+	[".m4v", "video/mp4"],
+	[".webm", "video/webm"],
+	[".mov", "video/quicktime"],
+	[".mkv", "video/x-matroska"],
+	[".ogv", "video/ogg"],
+	[".pdf", "application/pdf"],
+	[".js", "text/javascript"],
+	[".jsx", "text/javascript"],
+	[".ts", "text/typescript"],
+	[".tsx", "text/typescript"],
+	[".css", "text/css"],
+	[".sh", "text/plain"],
+	[".py", "text/plain"],
+	[".rs", "text/plain"],
+	[".go", "text/plain"],
+	[".java", "text/plain"],
+	[".c", "text/plain"],
+	[".cc", "text/plain"],
+	[".cpp", "text/plain"],
+	[".h", "text/plain"],
+	[".hpp", "text/plain"]
+]);
+const TEXT_MIME_PREFIXES = ["text/"];
+const TEXT_MIME_VALUES = new Set([
+	"application/json",
+	"application/yaml",
+	"application/toml",
+	"application/xml",
+	"image/svg+xml"
+]);
+const FILE_PREVIEW_KINDS = [
+	"markdown",
+	"html",
+	"image",
+	"audio",
+	"video",
+	"pdf",
+	"text",
+	"none"
+];
+function getExtension(path) {
+	const normalized = path.replace(/\\/g, "/");
+	const name = normalized.split("/").pop() ?? normalized;
+	const dotIndex = name.lastIndexOf(".");
+	if (dotIndex < 0) return "";
+	return name.slice(dotIndex).toLowerCase();
+}
+function inferFileMime(path) {
+	return MIME_BY_EXTENSION.get(getExtension(path)) ?? null;
+}
+function inferFilePreviewKind(path, mime) {
+	const resolvedMime = mime ?? inferFileMime(path);
+	if (!resolvedMime) return "none";
+	if (resolvedMime === "text/markdown") return "markdown";
+	if (resolvedMime === "text/html") return "html";
+	if (resolvedMime.startsWith("image/")) return resolvedMime === "image/svg+xml" ? "text" : "image";
+	if (resolvedMime.startsWith("audio/")) return "audio";
+	if (resolvedMime.startsWith("video/")) return "video";
+	if (resolvedMime === "application/pdf") return "pdf";
+	if (isTextLikeMime(resolvedMime)) return "text";
+	return "none";
+}
+function isTextLikeMime(mime) {
+	if (!mime) return false;
+	if (TEXT_MIME_VALUES.has(mime)) return true;
+	return TEXT_MIME_PREFIXES.some((prefix) => mime.startsWith(prefix));
+}
+function isTextLikeFile(path, mime) {
+	return isTextLikeMime(mime ?? inferFileMime(path));
+}
+function isPreviewableFile(path, mime) {
+	return inferFilePreviewKind(path, mime) !== "none";
+}
+
+//#endregion
+//#region src/schemas.ts
+/**
+* Orthogonal intents (updated 2026-07-23 Asia/Shanghai):
+* 1. Define Zod schemas and TypeScript types for OpenSpec documents and Change tasks.
+* 2. Preserve tracked-task progress as a reusable typed contract for live Change projections.
+*
+* Original request (2026-07-23): "现在页面数据的加载数据非常慢（比如dashboard页面、changes页面都要等待非常久，页面刷新后，似乎后台没有缓存一样，也要加载很久。"
+* @module schemas
+*/
+/**
+* File metadata for a change directory entry.
+*/
+const ChangeFileSchema = z.object({
+	path: z.string(),
+	type: z.enum(["file", "directory"]),
+	content: z.string().optional(),
+	size: z.number().optional(),
+	mime: z.string().optional(),
+	previewKind: z.enum(FILE_PREVIEW_KINDS).optional()
+});
+const ScenarioStepKeywordSchema = z.enum([
+	"GIVEN",
+	"WHEN",
+	"THEN",
+	"AND",
+	"BUT"
+]);
+const ScenarioStepSchema = z.object({
+	keyword: ScenarioStepKeywordSchema,
+	contentMarkdown: z.string(),
+	rawText: z.string()
+});
+/**
+* A requirement within a specification.
+* Requirements should use RFC 2119 keywords (SHALL, MUST, etc.)
+*/
+const RequirementSchema = z.object({
+	id: z.string(),
+	title: z.string(),
+	bodyMarkdown: z.string(),
+	text: z.string(),
+	scenarios: z.array(z.object({
+		title: z.string(),
+		bodyMarkdown: z.string(),
+		rawText: z.string(),
+		steps: z.array(ScenarioStepSchema).optional()
+	}))
+});
+/**
+* A specification document.
+* Located at: openspec/specs/{id}/spec.md
+*/
+const SpecSchema = z.object({
+	id: z.string(),
+	name: z.string(),
+	overview: z.string(),
+	requirements: z.array(RequirementSchema),
+	metadata: z.object({
+		version: z.string().default("1.0.0"),
+		format: z.literal("openspec").default("openspec"),
+		sourcePath: z.string().optional()
+	}).optional()
+});
+/**
+* A delta describes changes to a spec within a change proposal.
+* Deltas track which specs are affected and how.
+*/
+const DeltaOperationType = z.enum([
+	"ADDED",
+	"MODIFIED",
+	"REMOVED",
+	"RENAMED"
+]);
+const DeltaSchema = z.object({
+	spec: z.string(),
+	operation: DeltaOperationType,
+	description: z.string(),
+	requirement: RequirementSchema.optional(),
+	requirements: z.array(RequirementSchema).optional(),
+	rename: z.object({
+		from: z.string(),
+		to: z.string()
+	}).optional()
+});
+/**
+* A task within a change proposal.
+* Tasks are parsed from tasks.md using checkbox syntax: - [ ] or - [x]
+*/
+const TaskSchema = z.object({
+	id: z.string(),
+	text: z.string(),
+	completed: z.boolean(),
+	section: z.string().optional()
+});
+const TrackedTaskSourceSchema = z.discriminatedUnion("kind", [
+	z.object({
+		kind: z.literal("artifact"),
+		artifactId: z.string(),
+		outputPath: z.string(),
+		filePaths: z.array(z.string())
+	}),
+	z.object({
+		kind: z.literal("top-level-fallback"),
+		artifactId: z.null(),
+		outputPath: z.literal("tasks.md"),
+		filePaths: z.tuple([z.literal("tasks.md")])
+	}),
+	z.object({
+		kind: z.literal("none"),
+		artifactId: z.null(),
+		outputPath: z.null(),
+		filePaths: z.tuple([])
+	})
+]);
+const TrackedTaskSchema = TaskSchema.extend({ location: z.object({
+	filePath: z.string(),
+	taskIndex: z.number().int().positive()
+}) });
+const TrackedTaskProgressSchema = z.object({
+	tasks: z.array(TrackedTaskSchema),
+	total: z.number(),
+	completed: z.number(),
+	remaining: z.number(),
+	phase: z.enum([
+		"no-tasks",
+		"in-progress",
+		"complete"
+	]),
+	source: TrackedTaskSourceSchema
+});
+const DocumentChecklistSummarySchema = z.object({
+	groups: z.array(z.object({
+		artifactIds: z.array(z.string()),
+		filePath: z.string(),
+		tasks: z.array(TaskSchema),
+		total: z.number(),
+		completed: z.number(),
+		remaining: z.number()
+	})),
+	total: z.number(),
+	completed: z.number(),
+	remaining: z.number()
+});
+/**
+* A delta spec file from changes/{id}/specs/{specId}/spec.md
+* Contains the proposed changes to a spec
+*/
+const DeltaSpecSchema = z.object({
+	specId: z.string(),
+	content: z.string()
+});
+/**
+* A change proposal document.
+* Located at: openspec/changes/{id}/proposal.md + tasks.md
+*
+* Change proposals describe why a change is needed, what will change,
+* which specs are affected (deltas), and trackable tasks.
+*/
+const ChangeSchema = z.object({
+	id: z.string(),
+	name: z.string(),
+	why: z.string(),
+	whatChanges: z.string(),
+	deltas: z.array(DeltaSchema),
+	trackedTaskProgress: TrackedTaskProgressSchema,
+	documentChecklistSummary: DocumentChecklistSummarySchema,
+	design: z.string().optional(),
+	deltaSpecs: z.array(DeltaSpecSchema).optional(),
+	metadata: z.object({
+		version: z.string().default("1.0.0"),
+		format: z.literal("openspec-change").default("openspec-change")
+	}).optional()
+});
+
+//#endregion
+export { isTextLikeMime as _, DeltaSpecSchema as a, ScenarioStepSchema as c, TrackedTaskProgressSchema as d, FILE_PREVIEW_KINDS as f, isTextLikeFile as g, isPreviewableFile as h, DeltaSchema as i, SpecSchema as l, inferFilePreviewKind as m, ChangeSchema as n, RequirementSchema as o, inferFileMime as p, DeltaOperationType as r, ScenarioStepKeywordSchema as s, ChangeFileSchema as t, TaskSchema as u };