Remove obsolete workspace-manifest documentKind usage - PR_26140_055-remove-workspace-manifest-documentkind

Author: DavidQ

docs/dev/reports/workspace_manifest_documentkind_removal_report.md

@@ -0,0 +1,49 @@
+# Workspace Manifest DocumentKind Removal Report
+
+PR: `PR_26140_055-remove-workspace-manifest-documentkind`
+
+## Summary
+- Replaced active `documentKind: "workspace-manifest"` usage with `documentKind: "project-manifest"`.
+- Kept the existing `schema: "html-js-gaming.project"` contract and Workspace Manager V2 manifest/toolState behavior.
+- Removed active code and test expectations that accepted `workspace-manifest` as the valid document kind.
+
+## Updated Active Paths
+- `tools/workspace-manager-v2/js/services/WorkspaceManagerV2ContextService.js`
+  - Generates Workspace Manager contexts with `project-manifest`.
+  - Validates generated contexts against `project-manifest`.
+- `tools/shared/projectManifestContract.js`
+  - Uses `PROJECT_DOCUMENT_KIND = "project-manifest"`.
+- `tools/asset-manager-v2/js/services/WorkspaceBridge.js`
+  - Validates workspace-launched contexts as project manifest contexts.
+- `tools/preview-generator-v2/PreviewGeneratorV2App.js`
+  - Resolves workspace launch contexts using the project manifest document kind.
+- `tools/shared/documentModeGuards.js` and `tools/shared/platformShell.js`
+  - Detect project manifests using `project-manifest` or `schema: "html-js-gaming.project"`.
+- `scripts/validate-json-contracts.mjs`
+  - Skips project-manifest sample-style documents using the new document kind.
+- Template manifests:
+  - `games/_template/workspace-manager-v2-template.manifest.json`
+  - `games/_template/workspace-manager-v2-UAT.manifest.json`
+- Tests and fixtures:
+  - Workspace Manager V2 Playwright fixtures and assertions.
+  - Asset Manager V2 workspace launch fixtures and assertions.
+  - Collision Inspector V2 workspace launch fixture.
+  - V2 Asset Manager workspace persistence runtime fixture.
+
+## Active Reference Audit
+- PASS: no active `"documentKind": "workspace-manifest"` JSON values remain outside excluded historical or out-of-scope paths.
+- PASS: no active code/test expectations remain for `documentKind === "workspace-manifest"`, `PROJECT_DOCUMENT_KIND = "workspace-manifest"`, or `toBe("workspace-manifest")`.
+- A non-documentKind schema id remains in the root `workspace.manifest.json`: `html-js-gaming.workspace-manifest.palette-links/1`. It was left unchanged because this PR is scoped to documentKind terminology.
+
+## Validation
+- PASS: targeted JSON parse validation for changed manifests.
+- PASS: targeted syntax/import validation for changed files.
+- PASS: `npm run test:workspace-v2` with 58 passed.
+- PASS: active documentKind search checks.
+- PASS: `git diff --check`.
+
+## Out Of Scope
+- Sample JSON was not modified.
+- Roadmap text was not modified.
+- Full samples smoke test was skipped as requested.
+- Historical reports/docs snapshots were not modified.

games/_template/workspace-manager-v2-UAT.manifest.json

@@ -1,5 +1,5 @@
 {
-  "documentKind": "workspace-manifest",
+  "documentKind": "project-manifest",
   "schema": "html-js-gaming.project",
   "version": 1,
   "id": "workspace-manager-v2-UAT-template",

games/_template/workspace-manager-v2-template.manifest.json

@@ -1,5 +1,5 @@
 {
-  "documentKind": "workspace-manifest",
+  "documentKind": "project-manifest",
   "schema": "html-js-gaming.project",
   "version": 1,
   "id": "workspace-manager-v2-template",

scripts/validate-json-contracts.mjs

@@ -564,7 +564,7 @@ function validateSamples(schemaIndex, validate) {
     }
 
     let schemaPath = "";
-    const isWorkspaceManifest = String(document?.documentKind || "").trim() === "workspace-manifest"
+    const isWorkspaceManifest = String(document?.documentKind || "").trim() === "project-manifest"
       || String(document?.schema || "").trim().toLowerCase() === "html-js-gaming.project";
     if (isWorkspaceManifest) {
       rows.push({ filePath: rel, schemaPath: "", status: "skipped", errorCount: 0, firstErrors: "", note: "separate workspace validation contract removed; sample workspace JSON is out of scope" });

tests/playwright/tools/AssetManagerV2.spec.mjs

@@ -1292,7 +1292,7 @@ test.describe("Asset Manager V2", () => {
 
   test("shows Asset Manager V2 launch guard when Workspace Manager V2 palette context is missing", async ({ page }) => {
     const server = await openAssetManagerWithSessionContext(page, {
-      documentKind: "workspace-manifest",
+      documentKind: "project-manifest",
       schema: "html-js-gaming.project",
       version: 1,
       id: "workspace-manager-v2-Asteroids",
@@ -1341,7 +1341,7 @@ test.describe("Asset Manager V2", () => {
       toolId: "asset-manager-v2",
       gameId: "Asteroids",
       workspaceManifest: {
-        documentKind: "workspace-manifest",
+        documentKind: "project-manifest",
         schema: "html-js-gaming.project",
         version: 1,
         id: "legacy-workspace-v2-Asteroids",
@@ -1547,7 +1547,7 @@ test.describe("Asset Manager V2", () => {
       await expect(page.locator("#statusLog")).toHaveValue(/OK workspace\.tools\.asset-manager-v2 now has 19 validated assets\./);
 
       const storedContext = await page.evaluate((id) => JSON.parse(sessionStorage.getItem(id)), hostContextId);
-      expect(storedContext.documentKind).toBe("workspace-manifest");
+      expect(storedContext.documentKind).toBe("project-manifest");
       expect(storedContext.toolId).toBeUndefined();
       expect(storedContext.activePalette).toBeUndefined();
       expect(storedContext.workspaceManifest).toBeUndefined();

tests/playwright/tools/CollisionInspectorV2.spec.mjs

@@ -813,7 +813,7 @@ test.describe("Collision Inspector V2", () => {
     try {
       const gameManifest = JSON.parse(await readFile(join(server.repoRoot, "games", "Asteroids", "game.manifest.json"), "utf8"));
       const workspaceContext = {
-        documentKind: "workspace-manifest",
+        documentKind: "project-manifest",
         schema: "html-js-gaming.project",
         version: 1,
         id: "workspace-manager-v2-Asteroids",

tests/playwright/tools/WorkspaceManagerV2.spec.mjs

@@ -740,7 +740,7 @@ function workspaceContextFromGameManifest(gameManifest, { repoPath = "", repoRoo
   const game = gameManifest.game || {};
   const gameRoot = `games/${game.folder}/`;
   const context = {
-    documentKind: "workspace-manifest",
+    documentKind: "project-manifest",
     schema: "html-js-gaming.project",
     version: 1,
     id: `workspace-manager-v2-${game.id}`,
@@ -9837,7 +9837,7 @@ test.describe("Workspace Manager V2 bootstrap", () => {
         const invalidRuntimeWorkspaceManifest = structuredClone(manifest);
         invalidRuntimeWorkspaceManifest.game.gameData = { workspace: {} };
         const invalidEmbeddedWorkspaceManifest = structuredClone(manifest);
-        invalidEmbeddedWorkspaceManifest.game["workspace"] = { documentKind: "workspace-manifest" };
+        invalidEmbeddedWorkspaceManifest.game["workspace"] = { documentKind: "project-manifest" };
         const invalidObjectVectorRuntimeManifest = structuredClone(manifest);
         invalidObjectVectorRuntimeManifest.objectVectorRuntime = {
           objectIds: {
@@ -10551,7 +10551,7 @@ test.describe("Workspace Manager V2 bootstrap", () => {
         const hostContextId = url.searchParams.get("hostContextId");
         return JSON.parse(sessionStorage.getItem(hostContextId));
       });
-      expect(storedContext.documentKind).toBe("workspace-manifest");
+      expect(storedContext.documentKind).toBe("project-manifest");
       expect(storedContext.toolId).toBeUndefined();
       expect(storedContext.activePalette).toBeUndefined();
       expect(storedContext.workspaceManifest).toBeUndefined();

tests/runtime/V2AssetManagerWorkspacePersistence.test.mjs

@@ -47,7 +47,7 @@ function simulatePersistence(hostContextId, toolStateContext, limitBytes) {
 
 function simulateWorkspaceExportDocument(activeHostContextId, activeToolStatePayload, savedToolStates) {
   return {
-    documentKind: "workspace-manifest",
+    documentKind: "project-manifest",
     schema: "html-js-gaming.project",
     version: 1,
     id: `workspace-v2-${activeHostContextId}`,

tools/asset-manager-v2/js/services/WorkspaceBridge.js

@@ -19,9 +19,9 @@ function hasOnlyGamesRoot(value) {
   return path.startsWith("games/") && !path.includes("/samples/") && !path.includes("/tools/");
 }
 
-function isWorkspaceManifest(value) {
+function isProjectManifestContext(value) {
   return isPlainObject(value)
-    && value.documentKind === "workspace-manifest"
+    && value.documentKind === "project-manifest"
     && typeof value.schema === "string"
     && isPlainObject(value.tools);
 }
@@ -80,7 +80,7 @@ export class WorkspaceBridge {
     if (!isPlainObject(workspaceManifest)) {
       return { ok: false, message: "Workspace Manager V2 manifest context is invalid." };
     }
-    if (!isWorkspaceManifest(workspaceManifest)) {
+    if (!isProjectManifestContext(workspaceManifest)) {
       return { ok: false, message: "Workspace Manager V2 launch requires a valid manifest/toolState context." };
     }
     if (Object.prototype.hasOwnProperty.call(workspaceManifest, "workspaceManifest")

tools/preview-generator-v2/PreviewGeneratorV2App.js

@@ -179,15 +179,15 @@ function readWorkspacePreviewGeneratorWorkspace(manifest) {
   return { ok: true, workspace };
 }
 
-function isWorkspaceManifest(value) {
-  return isPlainObject(value) && value.documentKind === "workspace-manifest";
+function isProjectManifestContext(value) {
+  return isPlainObject(value) && value.documentKind === "project-manifest";
 }
 
 function workspaceManifestFromLaunchContext(launchContext) {
-  if (isWorkspaceManifest(launchContext)) {
+  if (isProjectManifestContext(launchContext)) {
     return launchContext;
   }
-  if (isWorkspaceManifest(launchContext?.manifest)) {
+  if (isProjectManifestContext(launchContext?.manifest)) {
     return launchContext.manifest;
   }
   return null;