@openfairygui/backend 0.2.0 → 0.3.0-alpha.2

package/dist/node.cjs

@@ -28,6 +28,7 @@ node_path = __toESM(node_path);
 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/path-policy.ts
 function normalizeComparablePath(value) {
 	const normalized = value.replace(/[/\\]+$/, "").replace(/\\/g, "/");
@@ -122,7 +123,7 @@ function createMeta(stage, startedAt, options) {
 		diagnostics: options?.diagnostics ?? [],
 		stage,
 		contractVersion: BACKEND_CONTRACT_VERSION,
-		capabilitySchemaVersion: 2
+		capabilitySchemaVersion: 3
 	};
 }
 function success(stage, startedAt, data, options) {
@@ -1076,6 +1077,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;
@@ -1092,6 +1135,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
@@ -1247,7 +1319,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 = {
@@ -1259,6 +1333,8 @@ var RuntimeService = class {
 				sessionLock,
 				fileSystem,
 				project,
+				readDiagnostics: read.diagnostics,
+				readComplete: read.complete,
 				uamFidelity: await hasFullUamFidelity(document, project) ? "full" : "unsupported",
 				revision: 0,
 				lastSavedRevision: 0,
@@ -1322,6 +1398,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,
@@ -1405,6 +1483,8 @@ const BACKEND_METHODS = [
 	"openSession",
 	"openProjectSession",
 	"getSession",
+	"getProjectOutline",
+	"validateSession",
 	"applyTransaction",
 	"saveSession",
 	"materializeSession",
@@ -1426,14 +1506,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,
@@ -1573,6 +1655,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/node.d.cts

@@ -1,5 +1,6 @@
 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";
 
 //#region src/path-policy.d.ts
 interface PathPolicyViolationError {
@@ -12,7 +13,7 @@ interface PathPolicyViolationError {
 //#endregion
 //#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";
@@ -129,10 +130,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;
@@ -201,6 +204,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;
@@ -425,6 +471,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;
@@ -488,6 +540,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>>;

package/dist/node.d.mts

@@ -1,5 +1,6 @@
-import { UamProject, UamTransactionOperation } from "@openfairygui/core/uam";
+import { UamDisplayNodeKind, UamProject, UamResource, UamTransactionOperation } from "@openfairygui/core/uam";
 import { ApplyUamTransactionAppError } from "@openfairygui/functions/uam";
+import { ProjectValidationReport } from "@openfairygui/core";
 
 //#region src/path-policy.d.ts
 interface PathPolicyViolationError {
@@ -12,7 +13,7 @@ interface PathPolicyViolationError {
 //#endregion
 //#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";
@@ -129,10 +130,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;
@@ -201,6 +204,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;
@@ -425,6 +471,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;
@@ -488,6 +540,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>>;

package/dist/node.mjs

@@ -3,6 +3,7 @@ import path from "node:path";
 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/path-policy.ts
 function normalizeComparablePath(value) {
 	const normalized = value.replace(/[/\\]+$/, "").replace(/\\/g, "/");
@@ -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 = 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 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 = {
@@ -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: 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfairygui/backend",
-  "version": "0.2.0",
+  "version": "0.3.0-alpha.2",
   "description": "FairyGUI Headless Authoring SDK — stateful backend runtime and session services.",
   "author": "OpenFairyGUI Contributors",
   "license": "MIT",
@@ -52,8 +52,8 @@
     "runtime"
   ],
   "dependencies": {
-    "@openfairygui/core": "0.2.0",
-    "@openfairygui/functions": "0.2.0"
+    "@openfairygui/core": "0.3.0-alpha.2",
+    "@openfairygui/functions": "0.3.0-alpha.2"
   },
   "devDependencies": {
     "ava": "^7.0.0",

package/src/contracts.ts

@@ -1,5 +1,5 @@
 export const BACKEND_CONTRACT_VERSION = '1.1.0-p2' as const;
-export const BACKEND_CAPABILITY_SCHEMA_VERSION = 2 as const;
+export const BACKEND_CAPABILITY_SCHEMA_VERSION = 3 as const;
 export const BACKEND_COMPATIBILITY_POLICY = {
 	incompatibleChange: 'requires contractVersion bump',
 	capabilitySchemaChange: 'requires capabilitySchemaVersion bump',

package/src/index.ts

@@ -32,6 +32,9 @@ export {
 	type BackendJobProgress,
 	type BackendJobSnapshot,
 	type BackendJobStatus,
+	type BackendProjectOutline,
+	type BackendProjectOutlinePackage,
+	type BackendProjectOutlineResource,
 	type BackendProjectSessionStorage,
 	type BackendResult,
 	BackendRuntime,
@@ -46,6 +49,7 @@ export {
 	type GetEventsInput,
 	type GetEventsSnapshot,
 	type GetJobInput,
+	type GetProjectOutlineInput,
 	type InProcessLockConflictError,
 	type ListJobsInput,
 	type MaterializeSessionInput,
@@ -59,6 +63,7 @@ export {
 	type SessionNotFoundError,
 	type SessionStaleWriteError,
 	type UamFidelityUnsupportedError,
+	type ValidateSessionInput,
 } from './runtime.js';
 export {
 	type BackendAsyncStorageAdapter,

package/src/runtime/capabilities.ts

@@ -16,6 +16,8 @@ const BACKEND_METHODS = [
 	'openSession',
 	'openProjectSession',
 	'getSession',
+	'getProjectOutline',
+	'validateSession',
 	'applyTransaction',
 	'saveSession',
 	'materializeSession',
@@ -47,6 +49,8 @@ export function createCapabilities(): BackendCapabilities {
 		read: {
 			capabilitySnapshot: true,
 			sessionSnapshot: true,
+			projectOutline: true,
+			projectValidation: true,
 		},
 		authoring: {
 			applyTransaction: true,

package/src/runtime/contracts.ts

@@ -1,4 +1,9 @@
-import type { UamProject, UamTransactionOperation } from '@openfairygui/core/uam';
+import type {
+	UamDisplayNodeKind,
+	UamProject,
+	UamResource,
+	UamTransactionOperation,
+} from '@openfairygui/core/uam';
 import type { ApplyUamTransactionAppError } from '@openfairygui/functions/uam';
 import type {
 	BACKEND_CAPABILITY_SCHEMA_VERSION,
@@ -94,6 +99,8 @@ export interface BackendCapabilities {
 		'openSession',
 		'openProjectSession',
 		'getSession',
+		'getProjectOutline',
+		'validateSession',
 		'applyTransaction',
 		'saveSession',
 		'materializeSession',
@@ -108,6 +115,8 @@ export interface BackendCapabilities {
 	read: {
 		capabilitySnapshot: true;
 		sessionSnapshot: true;
+		projectOutline: true;
+		projectValidation: true;
 	};
 	authoring: {
 		applyTransaction: true;
@@ -178,6 +187,37 @@ export interface BackendSessionSnapshot {
 	capabilities: BackendCapabilities;
 }
 
+export interface BackendProjectOutline {
+	sessionId: string;
+	revision: number;
+	projectId: string;
+	projectType: number;
+	version: string;
+	branches: string[];
+	packages: BackendProjectOutlinePackage[];
+}
+
+export interface BackendProjectOutlinePackage {
+	id: string;
+	name: string;
+	branchNames: string[];
+	folders: Array<{ branch: string; path: string }>;
+	resources: BackendProjectOutlineResource[];
+}
+
+export 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 }>;
+	};
+}
+
 export interface MaterializeSessionSnapshot extends BackendSessionSnapshot {
 	mode: 'fullProject';
 	reason?: string;
@@ -476,6 +516,14 @@ export interface ApplySessionTransactionInput {
 	operations: UamTransactionOperation[];
 }
 
+export interface GetProjectOutlineInput {
+	sessionId: string;
+}
+
+export interface ValidateSessionInput {
+	sessionId: string;
+}
+
 export interface OpenProjectSessionInput {
 	/** Authoritative UAM project. Use BackendRuntime.openSession() when importing an existing project from storage. */
 	project: UamProject;