@openfairygui/backend 0.2.0 → 0.3.0-alpha.2

package/README.md

@@ -28,6 +28,8 @@ It also provides:
 - polling runtime events with per-runtime monotonic sequence and bounded retention
 - `cache.refresh` in-memory jobs with cooperative cancel and terminal retention
 - revision-bound derived read-only cache snapshots
+- revision-bound project identity outlines for transaction planning
+- revision-bound read-only project validation reports
 - explicit Node bridge boundaries for publish/restore
 
 It does **not** redefine transaction grammar or expose `Document`.
@@ -67,6 +69,12 @@ const runtime = new BackendRuntime();
 const opened = runtime.openProjectSession({ project: uamProject });
 if (!opened.ok) throw new Error(opened.error.message);
 
+const outline = runtime.getProjectOutline({ sessionId: opened.data.sessionId });
+if (!outline.ok) throw new Error(outline.error.message);
+
+const validation = runtime.validateSession({ sessionId: opened.data.sessionId });
+if (!validation.ok) throw new Error(validation.error.message);
+
 const applied = await runtime.applyTransaction({
 	sessionId: opened.data.sessionId,
 	expectedRevision: opened.data.revision,

package/dist/index.cjs

@@ -2,9 +2,10 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 let _openfairygui_core_uam = require("@openfairygui/core/uam");
 let _openfairygui_functions_uam = require("@openfairygui/functions/uam");
 let _openfairygui_core_project_io = require("@openfairygui/core/project-io");
+let _openfairygui_functions = require("@openfairygui/functions");
 //#region src/contracts.ts
 const BACKEND_CONTRACT_VERSION = "1.1.0-p2";
-const BACKEND_CAPABILITY_SCHEMA_VERSION = 2;
+const BACKEND_CAPABILITY_SCHEMA_VERSION = 3;
 const BACKEND_COMPATIBILITY_POLICY = {
 	incompatibleChange: "requires contractVersion bump",
 	capabilitySchemaChange: "requires capabilitySchemaVersion bump",
@@ -97,7 +98,7 @@ function createMeta(stage, startedAt, options) {
 		diagnostics: options?.diagnostics ?? [],
 		stage,
 		contractVersion: BACKEND_CONTRACT_VERSION,
-		capabilitySchemaVersion: 2
+		capabilitySchemaVersion: 3
 	};
 }
 function success(stage, startedAt, data, options) {
@@ -1051,6 +1052,48 @@ var JobService = class {
 };
 //#endregion
 //#region src/services/read-service.ts
+function toProjectOutline(session) {
+	const project = session.project;
+	return {
+		sessionId: session.sessionId,
+		revision: session.revision,
+		projectId: project.projectId,
+		projectType: project.projectType,
+		version: project.version,
+		branches: [...project.branches],
+		packages: project.packages.map((pkg) => ({
+			id: pkg.id,
+			name: pkg.name,
+			branchNames: [...pkg.branchNames],
+			folders: pkg.folders.map((folder) => ({
+				branch: folder.branch,
+				path: folder.path
+			})),
+			resources: pkg.resources.map((resource) => ({
+				id: resource.id,
+				name: resource.name,
+				path: resource.path,
+				kind: resource.kind,
+				branch: resource.branch,
+				...resource.kind === "component" ? { component: {
+					displayList: resource.component.displayList.map((node) => ({
+						id: node.id,
+						name: node.name,
+						kind: node.kind
+					})),
+					controllers: resource.component.controllers.map((controller) => ({
+						name: controller.name,
+						pages: controller.pages.map((page) => ({
+							id: page.id,
+							name: page.name
+						}))
+					})),
+					transitions: resource.component.transitions.map((transition) => ({ name: transition.name }))
+				} } : {}
+			}))
+		}))
+	};
+}
 var ReadService = class {
 	constructor(context) {
 		this.context = context;
@@ -1067,6 +1110,35 @@ var ReadService = class {
 			revision: session.revision
 		});
 	}
+	getProjectOutline(input) {
+		const startedAt = Date.now();
+		const session = this.context.sessions.get(input.sessionId);
+		if (!session || session.closed) return failure("read", startedAt, createSessionNotFoundError(input.sessionId));
+		return success("read", startedAt, toProjectOutline(session), {
+			sessionId: session.sessionId,
+			revision: session.revision
+		});
+	}
+	validateSession(input) {
+		const startedAt = Date.now();
+		const session = this.context.sessions.get(input.sessionId);
+		if (!session || session.closed) return failure("read", startedAt, createSessionNotFoundError(input.sessionId));
+		const report = (0, _openfairygui_functions.validateProject)(session.project, {
+			readDiagnostics: session.readDiagnostics,
+			complete: session.readComplete,
+			validateSources: true
+		});
+		return success("read", startedAt, report, {
+			sessionId: session.sessionId,
+			revision: session.revision,
+			diagnostics: report.diagnostics.map(({ code, message, severity, path }) => ({
+				code,
+				message,
+				severity,
+				path
+			}))
+		});
+	}
 };
 //#endregion
 //#region src/services/runtime-service.ts
@@ -1222,7 +1294,9 @@ var RuntimeService = class {
 				createdAt: (/* @__PURE__ */ new Date()).toISOString(),
 				canonicalPathKey
 			}));
-			const document = await new _openfairygui_core_project_io.ProjectReader(createProjectReaderFileSystem(fileSystem)).read(fairyPath, { hydrateResourceBytes: true });
+			const read = await new _openfairygui_core_project_io.ProjectReader(createProjectReaderFileSystem(fileSystem)).readDetailed(fairyPath, { hydrateResourceBytes: true });
+			if (!read.document) throw new Error(read.diagnostics[0]?.message ?? `Unable to read project: ${fairyPath}`);
+			const document = read.document;
 			const project = (0, _openfairygui_core_uam.liftDocumentToUamProject)(document);
 			const sessionId = randomId();
 			const session = {
@@ -1234,6 +1308,8 @@ var RuntimeService = class {
 				sessionLock,
 				fileSystem,
 				project,
+				readDiagnostics: read.diagnostics,
+				readComplete: read.complete,
 				uamFidelity: await hasFullUamFidelity(document, project) ? "full" : "unsupported",
 				revision: 0,
 				lastSavedRevision: 0,
@@ -1297,6 +1373,8 @@ var RuntimeService = class {
 			sessionLock: null,
 			fileSystem: storage?.fileSystem,
 			project: (0, _openfairygui_core_uam.normalizeUamProject)(input.project),
+			readDiagnostics: [],
+			readComplete: true,
 			uamFidelity: "full",
 			revision: 0,
 			lastSavedRevision: 0,
@@ -1380,6 +1458,8 @@ const BACKEND_METHODS = [
 	"openSession",
 	"openProjectSession",
 	"getSession",
+	"getProjectOutline",
+	"validateSession",
 	"applyTransaction",
 	"saveSession",
 	"materializeSession",
@@ -1401,14 +1481,16 @@ const ARTIFACT_BRIDGE_CAPABILITY = {
 function createCapabilities() {
 	return {
 		contractVersion: BACKEND_CONTRACT_VERSION,
-		capabilitySchemaVersion: 2,
+		capabilitySchemaVersion: 3,
 		transactionKernelOwner: "@openfairygui/core",
 		appSeamOwner: "@openfairygui/functions",
 		runtimeOwner: "@openfairygui/backend",
 		methods: BACKEND_METHODS,
 		read: {
 			capabilitySnapshot: true,
-			sessionSnapshot: true
+			sessionSnapshot: true,
+			projectOutline: true,
+			projectValidation: true
 		},
 		authoring: {
 			applyTransaction: true,
@@ -1548,6 +1630,12 @@ var BackendRuntime = class {
 	getSession(input) {
 		return this.readService.getSession(input);
 	}
+	getProjectOutline(input) {
+		return this.readService.getProjectOutline(input);
+	}
+	validateSession(input) {
+		return this.readService.validateSession(input);
+	}
 	async applyTransaction(input) {
 		return this.authoringService.applyTransaction(input);
 	}

package/dist/index.d.cts

@@ -1,10 +1,11 @@
 import { ApplyUamTransactionAppError } from "@openfairygui/functions/uam";
-import { UamProject, UamTransactionOperation } from "@openfairygui/core/uam";
+import { ProjectValidationReport } from "@openfairygui/core";
+import { UamDisplayNodeKind, UamProject, UamResource, UamTransactionOperation } from "@openfairygui/core/uam";
 import { FileSystem } from "@openfairygui/core/project-io";
 
 //#region src/contracts.d.ts
 declare const BACKEND_CONTRACT_VERSION: "1.1.0-p2";
-declare const BACKEND_CAPABILITY_SCHEMA_VERSION: 2;
+declare const BACKEND_CAPABILITY_SCHEMA_VERSION: 3;
 declare const BACKEND_COMPATIBILITY_POLICY: {
   readonly incompatibleChange: "requires contractVersion bump";
   readonly capabilitySchemaChange: "requires capabilitySchemaVersion bump";
@@ -130,10 +131,12 @@ interface BackendCapabilities {
   transactionKernelOwner: '@openfairygui/core';
   appSeamOwner: '@openfairygui/functions';
   runtimeOwner: '@openfairygui/backend';
-  methods: readonly ['getCapabilities', 'openSession', 'openProjectSession', 'getSession', 'applyTransaction', 'saveSession', 'materializeSession', 'closeSession', 'getEvents', 'getJob', 'listJobs', 'cancelJob', 'getCacheSnapshot', 'refreshCache'];
+  methods: readonly ['getCapabilities', 'openSession', 'openProjectSession', 'getSession', 'getProjectOutline', 'validateSession', 'applyTransaction', 'saveSession', 'materializeSession', 'closeSession', 'getEvents', 'getJob', 'listJobs', 'cancelJob', 'getCacheSnapshot', 'refreshCache'];
   read: {
     capabilitySnapshot: true;
     sessionSnapshot: true;
+    projectOutline: true;
+    projectValidation: true;
   };
   authoring: {
     applyTransaction: true;
@@ -202,6 +205,49 @@ interface BackendSessionSnapshot {
   lockHeld: boolean;
   capabilities: BackendCapabilities;
 }
+interface BackendProjectOutline {
+  sessionId: string;
+  revision: number;
+  projectId: string;
+  projectType: number;
+  version: string;
+  branches: string[];
+  packages: BackendProjectOutlinePackage[];
+}
+interface BackendProjectOutlinePackage {
+  id: string;
+  name: string;
+  branchNames: string[];
+  folders: Array<{
+    branch: string;
+    path: string;
+  }>;
+  resources: BackendProjectOutlineResource[];
+}
+interface BackendProjectOutlineResource {
+  id: string;
+  name: string;
+  path: string;
+  kind: UamResource['kind'];
+  branch: string;
+  component?: {
+    displayList: Array<{
+      id: string;
+      name: string;
+      kind: UamDisplayNodeKind;
+    }>;
+    controllers: Array<{
+      name: string;
+      pages: Array<{
+        id: string;
+        name: string;
+      }>;
+    }>;
+    transitions: Array<{
+      name: string;
+    }>;
+  };
+}
 interface MaterializeSessionSnapshot extends BackendSessionSnapshot {
   mode: 'fullProject';
   reason?: string;
@@ -427,6 +473,12 @@ interface ApplySessionTransactionInput {
   expectedRevision: number;
   operations: UamTransactionOperation[];
 }
+interface GetProjectOutlineInput {
+  sessionId: string;
+}
+interface ValidateSessionInput {
+  sessionId: string;
+}
 interface OpenProjectSessionInput {
   /** Authoritative UAM project. Use BackendRuntime.openSession() when importing an existing project from storage. */
   project: UamProject;
@@ -490,6 +542,8 @@ declare class BackendRuntime {
   getSession(input: {
     sessionId: string;
   }): BackendResult<BackendSessionSnapshot, SessionNotFoundError>;
+  getProjectOutline(input: GetProjectOutlineInput): BackendResult<BackendProjectOutline, SessionNotFoundError>;
+  validateSession(input: ValidateSessionInput): BackendResult<ProjectValidationReport, SessionNotFoundError>;
   applyTransaction(input: ApplySessionTransactionInput): Promise<BackendResult<BackendSessionSnapshot, SessionNotFoundError | SessionStaleWriteError | ApplyUamTransactionAppError>>;
   saveSession(input: SaveSessionInput): Promise<BackendResult<BackendSessionSnapshot | MaterializeSessionSnapshot, SessionNotFoundError | SessionStaleWriteError | SavePartialFailureError | UamFidelityUnsupportedError | MaterializeValidationFailedError | MaterializeWriteFailedError | PathPolicyViolationError | InProcessLockConflictError | BackendCapabilityUnavailableError>>;
   materializeSession(input: MaterializeSessionInput): Promise<BackendResult<MaterializeSessionSnapshot, SessionNotFoundError | SessionStaleWriteError | UamFidelityUnsupportedError | MaterializeValidationFailedError | MaterializeWriteFailedError | PathPolicyViolationError | InProcessLockConflictError | BackendCapabilityUnavailableError>>;
@@ -542,4 +596,4 @@ interface BackendAsyncStorageAdapter {
 type BackendStorageFileSystem = BackendFileSystem & FileSystem;
 declare function createBackendStorageFileSystem(storage: BackendAsyncStorageAdapter): BackendStorageFileSystem;
 //#endregion
-export { type AdvisoryLockConflictError, type ApplySessionTransactionInput, BACKEND_CAPABILITY_SCHEMA_VERSION, BACKEND_COMPATIBILITY_POLICY, BACKEND_CONTRACT_VERSION, type BackendArtifactBridgeCapability, type BackendAsyncStorageAdapter, type BackendCacheEntry, type BackendCacheSnapshot, type BackendCapabilities, type BackendCapabilityManifest, type BackendCapabilityUnavailableError, type BackendDiagnostic, type BackendError, type BackendEvent, type BackendEventKind, type BackendFailure, type BackendFileStat, type BackendFileSystem, type BackendHostAdapter, type BackendJobErrors, type BackendJobKind, type BackendJobListSnapshot, type BackendJobListStatusFilter, type BackendJobNotCancellableError, type BackendJobNotFoundError, type BackendJobProgress, type BackendJobSnapshot, type BackendJobStatus, type BackendMessage, type BackendProjectSessionStorage, type BackendResponseMeta, type BackendResult, BackendRuntime, type BackendRuntimeOptions, type BackendSessionLock, type BackendSessionSnapshot, type BackendStage, type BackendStorageFileSystem, type BackendStorageStatLike, type BackendSuccess, type CacheRefreshFailedError, type CancelJobInput, type EventCursorInvalidError, type GetCacheSnapshotInput, type GetEventsInput, type GetEventsSnapshot, type GetJobInput, type InProcessLockConflictError, type ListJobsInput, type MaterializeSessionInput, type MaterializeSessionSnapshot, type MaterializeValidationFailedError, type MaterializeWriteFailedError, type OpenProjectSessionInput, type RefreshCacheInput, type SavePartialFailureError, type SaveSessionInput, type SessionNotFoundError, type SessionStaleWriteError, type UamFidelityUnsupportedError, createBackendStorageFileSystem };
+export { type AdvisoryLockConflictError, type ApplySessionTransactionInput, BACKEND_CAPABILITY_SCHEMA_VERSION, BACKEND_COMPATIBILITY_POLICY, BACKEND_CONTRACT_VERSION, type BackendArtifactBridgeCapability, type BackendAsyncStorageAdapter, type BackendCacheEntry, type BackendCacheSnapshot, type BackendCapabilities, type BackendCapabilityManifest, type BackendCapabilityUnavailableError, type BackendDiagnostic, type BackendError, type BackendEvent, type BackendEventKind, type BackendFailure, type BackendFileStat, type BackendFileSystem, type BackendHostAdapter, type BackendJobErrors, type BackendJobKind, type BackendJobListSnapshot, type BackendJobListStatusFilter, type BackendJobNotCancellableError, type BackendJobNotFoundError, type BackendJobProgress, type BackendJobSnapshot, type BackendJobStatus, type BackendMessage, type BackendProjectOutline, type BackendProjectOutlinePackage, type BackendProjectOutlineResource, type BackendProjectSessionStorage, type BackendResponseMeta, type BackendResult, BackendRuntime, type BackendRuntimeOptions, type BackendSessionLock, type BackendSessionSnapshot, type BackendStage, type BackendStorageFileSystem, type BackendStorageStatLike, type BackendSuccess, type CacheRefreshFailedError, type CancelJobInput, type EventCursorInvalidError, type GetCacheSnapshotInput, type GetEventsInput, type GetEventsSnapshot, type GetJobInput, type GetProjectOutlineInput, type InProcessLockConflictError, type ListJobsInput, type MaterializeSessionInput, type MaterializeSessionSnapshot, type MaterializeValidationFailedError, type MaterializeWriteFailedError, type OpenProjectSessionInput, type RefreshCacheInput, type SavePartialFailureError, type SaveSessionInput, type SessionNotFoundError, type SessionStaleWriteError, type UamFidelityUnsupportedError, type ValidateSessionInput, createBackendStorageFileSystem };

package/dist/index.d.mts

@@ -1,10 +1,11 @@
-import { UamProject, UamTransactionOperation } from "@openfairygui/core/uam";
+import { UamDisplayNodeKind, UamProject, UamResource, UamTransactionOperation } from "@openfairygui/core/uam";
 import { ApplyUamTransactionAppError } from "@openfairygui/functions/uam";
 import { FileSystem } from "@openfairygui/core/project-io";
+import { ProjectValidationReport } from "@openfairygui/core";
 
 //#region src/contracts.d.ts
 declare const BACKEND_CONTRACT_VERSION: "1.1.0-p2";
-declare const BACKEND_CAPABILITY_SCHEMA_VERSION: 2;
+declare const BACKEND_CAPABILITY_SCHEMA_VERSION: 3;
 declare const BACKEND_COMPATIBILITY_POLICY: {
   readonly incompatibleChange: "requires contractVersion bump";
   readonly capabilitySchemaChange: "requires capabilitySchemaVersion bump";
@@ -130,10 +131,12 @@ interface BackendCapabilities {
   transactionKernelOwner: '@openfairygui/core';
   appSeamOwner: '@openfairygui/functions';
   runtimeOwner: '@openfairygui/backend';
-  methods: readonly ['getCapabilities', 'openSession', 'openProjectSession', 'getSession', 'applyTransaction', 'saveSession', 'materializeSession', 'closeSession', 'getEvents', 'getJob', 'listJobs', 'cancelJob', 'getCacheSnapshot', 'refreshCache'];
+  methods: readonly ['getCapabilities', 'openSession', 'openProjectSession', 'getSession', 'getProjectOutline', 'validateSession', 'applyTransaction', 'saveSession', 'materializeSession', 'closeSession', 'getEvents', 'getJob', 'listJobs', 'cancelJob', 'getCacheSnapshot', 'refreshCache'];
   read: {
     capabilitySnapshot: true;
     sessionSnapshot: true;
+    projectOutline: true;
+    projectValidation: true;
   };
   authoring: {
     applyTransaction: true;
@@ -202,6 +205,49 @@ interface BackendSessionSnapshot {
   lockHeld: boolean;
   capabilities: BackendCapabilities;
 }
+interface BackendProjectOutline {
+  sessionId: string;
+  revision: number;
+  projectId: string;
+  projectType: number;
+  version: string;
+  branches: string[];
+  packages: BackendProjectOutlinePackage[];
+}
+interface BackendProjectOutlinePackage {
+  id: string;
+  name: string;
+  branchNames: string[];
+  folders: Array<{
+    branch: string;
+    path: string;
+  }>;
+  resources: BackendProjectOutlineResource[];
+}
+interface BackendProjectOutlineResource {
+  id: string;
+  name: string;
+  path: string;
+  kind: UamResource['kind'];
+  branch: string;
+  component?: {
+    displayList: Array<{
+      id: string;
+      name: string;
+      kind: UamDisplayNodeKind;
+    }>;
+    controllers: Array<{
+      name: string;
+      pages: Array<{
+        id: string;
+        name: string;
+      }>;
+    }>;
+    transitions: Array<{
+      name: string;
+    }>;
+  };
+}
 interface MaterializeSessionSnapshot extends BackendSessionSnapshot {
   mode: 'fullProject';
   reason?: string;
@@ -427,6 +473,12 @@ interface ApplySessionTransactionInput {
   expectedRevision: number;
   operations: UamTransactionOperation[];
 }
+interface GetProjectOutlineInput {
+  sessionId: string;
+}
+interface ValidateSessionInput {
+  sessionId: string;
+}
 interface OpenProjectSessionInput {
   /** Authoritative UAM project. Use BackendRuntime.openSession() when importing an existing project from storage. */
   project: UamProject;
@@ -490,6 +542,8 @@ declare class BackendRuntime {
   getSession(input: {
     sessionId: string;
   }): BackendResult<BackendSessionSnapshot, SessionNotFoundError>;
+  getProjectOutline(input: GetProjectOutlineInput): BackendResult<BackendProjectOutline, SessionNotFoundError>;
+  validateSession(input: ValidateSessionInput): BackendResult<ProjectValidationReport, SessionNotFoundError>;
   applyTransaction(input: ApplySessionTransactionInput): Promise<BackendResult<BackendSessionSnapshot, SessionNotFoundError | SessionStaleWriteError | ApplyUamTransactionAppError>>;
   saveSession(input: SaveSessionInput): Promise<BackendResult<BackendSessionSnapshot | MaterializeSessionSnapshot, SessionNotFoundError | SessionStaleWriteError | SavePartialFailureError | UamFidelityUnsupportedError | MaterializeValidationFailedError | MaterializeWriteFailedError | PathPolicyViolationError | InProcessLockConflictError | BackendCapabilityUnavailableError>>;
   materializeSession(input: MaterializeSessionInput): Promise<BackendResult<MaterializeSessionSnapshot, SessionNotFoundError | SessionStaleWriteError | UamFidelityUnsupportedError | MaterializeValidationFailedError | MaterializeWriteFailedError | PathPolicyViolationError | InProcessLockConflictError | BackendCapabilityUnavailableError>>;
@@ -542,4 +596,4 @@ interface BackendAsyncStorageAdapter {
 type BackendStorageFileSystem = BackendFileSystem & FileSystem;
 declare function createBackendStorageFileSystem(storage: BackendAsyncStorageAdapter): BackendStorageFileSystem;
 //#endregion
-export { type AdvisoryLockConflictError, type ApplySessionTransactionInput, BACKEND_CAPABILITY_SCHEMA_VERSION, BACKEND_COMPATIBILITY_POLICY, BACKEND_CONTRACT_VERSION, type BackendArtifactBridgeCapability, type BackendAsyncStorageAdapter, type BackendCacheEntry, type BackendCacheSnapshot, type BackendCapabilities, type BackendCapabilityManifest, type BackendCapabilityUnavailableError, type BackendDiagnostic, type BackendError, type BackendEvent, type BackendEventKind, type BackendFailure, type BackendFileStat, type BackendFileSystem, type BackendHostAdapter, type BackendJobErrors, type BackendJobKind, type BackendJobListSnapshot, type BackendJobListStatusFilter, type BackendJobNotCancellableError, type BackendJobNotFoundError, type BackendJobProgress, type BackendJobSnapshot, type BackendJobStatus, type BackendMessage, type BackendProjectSessionStorage, type BackendResponseMeta, type BackendResult, BackendRuntime, type BackendRuntimeOptions, type BackendSessionLock, type BackendSessionSnapshot, type BackendStage, type BackendStorageFileSystem, type BackendStorageStatLike, type BackendSuccess, type CacheRefreshFailedError, type CancelJobInput, type EventCursorInvalidError, type GetCacheSnapshotInput, type GetEventsInput, type GetEventsSnapshot, type GetJobInput, type InProcessLockConflictError, type ListJobsInput, type MaterializeSessionInput, type MaterializeSessionSnapshot, type MaterializeValidationFailedError, type MaterializeWriteFailedError, type OpenProjectSessionInput, type RefreshCacheInput, type SavePartialFailureError, type SaveSessionInput, type SessionNotFoundError, type SessionStaleWriteError, type UamFidelityUnsupportedError, createBackendStorageFileSystem };
+export { type AdvisoryLockConflictError, type ApplySessionTransactionInput, BACKEND_CAPABILITY_SCHEMA_VERSION, BACKEND_COMPATIBILITY_POLICY, BACKEND_CONTRACT_VERSION, type BackendArtifactBridgeCapability, type BackendAsyncStorageAdapter, type BackendCacheEntry, type BackendCacheSnapshot, type BackendCapabilities, type BackendCapabilityManifest, type BackendCapabilityUnavailableError, type BackendDiagnostic, type BackendError, type BackendEvent, type BackendEventKind, type BackendFailure, type BackendFileStat, type BackendFileSystem, type BackendHostAdapter, type BackendJobErrors, type BackendJobKind, type BackendJobListSnapshot, type BackendJobListStatusFilter, type BackendJobNotCancellableError, type BackendJobNotFoundError, type BackendJobProgress, type BackendJobSnapshot, type BackendJobStatus, type BackendMessage, type BackendProjectOutline, type BackendProjectOutlinePackage, type BackendProjectOutlineResource, type BackendProjectSessionStorage, type BackendResponseMeta, type BackendResult, BackendRuntime, type BackendRuntimeOptions, type BackendSessionLock, type BackendSessionSnapshot, type BackendStage, type BackendStorageFileSystem, type BackendStorageStatLike, type BackendSuccess, type CacheRefreshFailedError, type CancelJobInput, type EventCursorInvalidError, type GetCacheSnapshotInput, type GetEventsInput, type GetEventsSnapshot, type GetJobInput, type GetProjectOutlineInput, type InProcessLockConflictError, type ListJobsInput, type MaterializeSessionInput, type MaterializeSessionSnapshot, type MaterializeValidationFailedError, type MaterializeWriteFailedError, type OpenProjectSessionInput, type RefreshCacheInput, type SavePartialFailureError, type SaveSessionInput, type SessionNotFoundError, type SessionStaleWriteError, type UamFidelityUnsupportedError, type ValidateSessionInput, createBackendStorageFileSystem };

package/dist/index.mjs

@@ -1,9 +1,10 @@
 import { UAM_SUPPORTED_MATERIALIZATION_SCOPE, UAM_SUPPORTED_TRANSACTION_SCOPE, commitUamProjectSourcePaths, liftDocumentToUamProject, materializeUamProject, normalizeUamProject, staleBranchDirectories, staleResourceFolders, staleSourceFiles, validateUamProject } from "@openfairygui/core/uam";
 import { applyUamTransactionAppAsync } from "@openfairygui/functions/uam";
 import { ProjectReader, ProjectWriter } from "@openfairygui/core/project-io";
+import { validateProject } from "@openfairygui/functions";
 //#region src/contracts.ts
 const BACKEND_CONTRACT_VERSION = "1.1.0-p2";
-const BACKEND_CAPABILITY_SCHEMA_VERSION = 2;
+const BACKEND_CAPABILITY_SCHEMA_VERSION = 3;
 const BACKEND_COMPATIBILITY_POLICY = {
 	incompatibleChange: "requires contractVersion bump",
 	capabilitySchemaChange: "requires capabilitySchemaVersion bump",
@@ -96,7 +97,7 @@ function createMeta(stage, startedAt, options) {
 		diagnostics: options?.diagnostics ?? [],
 		stage,
 		contractVersion: BACKEND_CONTRACT_VERSION,
-		capabilitySchemaVersion: 2
+		capabilitySchemaVersion: 3
 	};
 }
 function success(stage, startedAt, data, options) {
@@ -1050,6 +1051,48 @@ var JobService = class {
 };
 //#endregion
 //#region src/services/read-service.ts
+function toProjectOutline(session) {
+	const project = session.project;
+	return {
+		sessionId: session.sessionId,
+		revision: session.revision,
+		projectId: project.projectId,
+		projectType: project.projectType,
+		version: project.version,
+		branches: [...project.branches],
+		packages: project.packages.map((pkg) => ({
+			id: pkg.id,
+			name: pkg.name,
+			branchNames: [...pkg.branchNames],
+			folders: pkg.folders.map((folder) => ({
+				branch: folder.branch,
+				path: folder.path
+			})),
+			resources: pkg.resources.map((resource) => ({
+				id: resource.id,
+				name: resource.name,
+				path: resource.path,
+				kind: resource.kind,
+				branch: resource.branch,
+				...resource.kind === "component" ? { component: {
+					displayList: resource.component.displayList.map((node) => ({
+						id: node.id,
+						name: node.name,
+						kind: node.kind
+					})),
+					controllers: resource.component.controllers.map((controller) => ({
+						name: controller.name,
+						pages: controller.pages.map((page) => ({
+							id: page.id,
+							name: page.name
+						}))
+					})),
+					transitions: resource.component.transitions.map((transition) => ({ name: transition.name }))
+				} } : {}
+			}))
+		}))
+	};
+}
 var ReadService = class {
 	constructor(context) {
 		this.context = context;
@@ -1066,6 +1109,35 @@ var ReadService = class {
 			revision: session.revision
 		});
 	}
+	getProjectOutline(input) {
+		const startedAt = Date.now();
+		const session = this.context.sessions.get(input.sessionId);
+		if (!session || session.closed) return failure("read", startedAt, createSessionNotFoundError(input.sessionId));
+		return success("read", startedAt, toProjectOutline(session), {
+			sessionId: session.sessionId,
+			revision: session.revision
+		});
+	}
+	validateSession(input) {
+		const startedAt = Date.now();
+		const session = this.context.sessions.get(input.sessionId);
+		if (!session || session.closed) return failure("read", startedAt, createSessionNotFoundError(input.sessionId));
+		const report = validateProject(session.project, {
+			readDiagnostics: session.readDiagnostics,
+			complete: session.readComplete,
+			validateSources: true
+		});
+		return success("read", startedAt, report, {
+			sessionId: session.sessionId,
+			revision: session.revision,
+			diagnostics: report.diagnostics.map(({ code, message, severity, path }) => ({
+				code,
+				message,
+				severity,
+				path
+			}))
+		});
+	}
 };
 //#endregion
 //#region src/services/runtime-service.ts
@@ -1221,7 +1293,9 @@ var RuntimeService = class {
 				createdAt: (/* @__PURE__ */ new Date()).toISOString(),
 				canonicalPathKey
 			}));
-			const document = await new ProjectReader(createProjectReaderFileSystem(fileSystem)).read(fairyPath, { hydrateResourceBytes: true });
+			const read = await new ProjectReader(createProjectReaderFileSystem(fileSystem)).readDetailed(fairyPath, { hydrateResourceBytes: true });
+			if (!read.document) throw new Error(read.diagnostics[0]?.message ?? `Unable to read project: ${fairyPath}`);
+			const document = read.document;
 			const project = liftDocumentToUamProject(document);
 			const sessionId = randomId();
 			const session = {
@@ -1233,6 +1307,8 @@ var RuntimeService = class {
 				sessionLock,
 				fileSystem,
 				project,
+				readDiagnostics: read.diagnostics,
+				readComplete: read.complete,
 				uamFidelity: await hasFullUamFidelity(document, project) ? "full" : "unsupported",
 				revision: 0,
 				lastSavedRevision: 0,
@@ -1296,6 +1372,8 @@ var RuntimeService = class {
 			sessionLock: null,
 			fileSystem: storage?.fileSystem,
 			project: normalizeUamProject(input.project),
+			readDiagnostics: [],
+			readComplete: true,
 			uamFidelity: "full",
 			revision: 0,
 			lastSavedRevision: 0,
@@ -1379,6 +1457,8 @@ const BACKEND_METHODS = [
 	"openSession",
 	"openProjectSession",
 	"getSession",
+	"getProjectOutline",
+	"validateSession",
 	"applyTransaction",
 	"saveSession",
 	"materializeSession",
@@ -1400,14 +1480,16 @@ const ARTIFACT_BRIDGE_CAPABILITY = {
 function createCapabilities() {
 	return {
 		contractVersion: BACKEND_CONTRACT_VERSION,
-		capabilitySchemaVersion: 2,
+		capabilitySchemaVersion: 3,
 		transactionKernelOwner: "@openfairygui/core",
 		appSeamOwner: "@openfairygui/functions",
 		runtimeOwner: "@openfairygui/backend",
 		methods: BACKEND_METHODS,
 		read: {
 			capabilitySnapshot: true,
-			sessionSnapshot: true
+			sessionSnapshot: true,
+			projectOutline: true,
+			projectValidation: true
 		},
 		authoring: {
 			applyTransaction: true,
@@ -1547,6 +1629,12 @@ var BackendRuntime = class {
 	getSession(input) {
 		return this.readService.getSession(input);
 	}
+	getProjectOutline(input) {
+		return this.readService.getProjectOutline(input);
+	}
+	validateSession(input) {
+		return this.readService.validateSession(input);
+	}
 	async applyTransaction(input) {
 		return this.authoringService.applyTransaction(input);
 	}