@vgai/live 0.5.15 → 0.5.17

package/dist/editor.d.ts

@@ -10,7 +10,7 @@
  * hand-rolls a `fetch` to `/__editor/command` itself. (WO-8 removed the one
  * exception, `applyDiff`, which was FILE mode rather than a live wire command.)
  */
-import type { ActiveDocumentCapture, AnimationCaptureAction, AssetKind, AssetPreviewCapture, AssetPreviewOptions, AssetPreviewSource, EditorClient, EditorState, EditorView, HistoryStep, InspectedFieldWrite, InspectedHierarchy, InspectedInspection, PresentedEditorView, ShadingMode, ViewPreset, ViewportCapture } from '@vgai/editor-sdk';
+import type { ActiveDocumentCapture, AnimationCaptureAction, AssetKind, AssetPreviewCapture, AssetPreviewOptions, AssetPreviewSource, EditorClient, EditorState, EditorView, HistoryStep, InspectedFieldWrite, InspectedHierarchy, InspectedInspection, OpenedDocument, PresentedEditorView, RagdollGenerationResult, ShadingMode, ViewPreset, ViewportCapture } from '@vgai/editor-sdk';
 import { LiveEditorDocument } from './editor-document.js';
 import { LiveGameplayRecording } from './recording.js';
 /** `vgai show <...>`'s four sub-verbs folded into one action name — see `showPanel`. */
@@ -96,6 +96,11 @@ export declare class LiveEditor {
     showPanel(name: PanelName): Promise<void>;
     /** `kind` inferred from `path`'s extension when omitted (`inferAssetKind`) — pass it explicitly to override. */
     openAsset(path: string, kind?: AssetKind): Promise<void>;
+    /**
+     * Fit native Rapier bodies and joints to a rigged GLB/glTF, copy the reusable
+     * project capability, and open the generated TSX prefab's Setup story.
+     */
+    generateRagdoll(assetPath: string): Promise<RagdollGenerationResult>;
     /**
      * Captures the editor's native four-view preview. A bare string is a
      * project-relative asset path (the common case); an explicit source object
@@ -145,6 +150,9 @@ export declare class LiveEditor {
      * `{position, rotation, scale}`, rotation in Euler XYZ degrees).
      */
     inspect(): Promise<InspectedInspection>;
+    /** Run one verb listed by `inspect().quickActions`, through the same action
+     * the human Inspector button invokes. */
+    runAction(actionId: string): Promise<InspectedInspection>;
     /**
      * READ the hierarchy panel, as data — the rows a human is looking at right
      * now, nested exactly as the panel nests them.
@@ -185,6 +193,47 @@ export declare class LiveEditor {
      * it went ("live-only (not saved)" is a destination, never silence).
      */
     setField(path: string, value: unknown): Promise<InspectedFieldWrite>;
+    /**
+     * REMOVE one field's authored override — the revert arrow, as a command.
+     *
+     * Reach for this instead of `setField` whenever you are UNDOING an edit that
+     * added a property the source did not carry: `setField` can only write a
+     * value, so setting the default back leaves `position={[0, 0, 0]}` in the
+     * file where there was nothing before. Only this door restores the bytes.
+     *
+     * The answer is the same `{ subject, write }` shape, awaited past the bytes.
+     * It rejects with `code: 'REMOVAL_UNAVAILABLE'` when the field is not
+     * declared removable or the lane has no removal door — which is a missing
+     * seam to report, not a removal that failed.
+     */
+    removeField(path: string): Promise<InspectedFieldWrite>;
+    /**
+     * OPEN one piece of the game's own SCENE TABLE by id.
+     *
+     * The address space is the adapter's declaration, not a path: `status()`'s
+     * `adapter.scenes.entries` lists every id, and the same verb opens a scene, a
+     * prefab or a story state, because the table makes them siblings — they
+     * differ only in where they are instanced.
+     *
+     * With a game LIVE in this session, a scene the adapter declares reachable
+     * through the game's own scenes contract is opened by NAVIGATING the running
+     * game (its own call, not a synthetic one), and the answer carries the game's
+     * own reading back in `scene`.
+     *
+     * Rejects with a CODE, because the classes are graded differently:
+     * `SCENE_NOT_FOUND` (which names the ids that do exist),
+     * `SCENE_NOT_OPENABLE` carrying the adapter's OWN sentence about a scene it
+     * declares unreachable, `SCENE_NAVIGATION_NOT_RUNNING` for a live-only scene
+     * while nothing is running (start the game and ask again),
+     * `SCENE_CONTRACT_UNAVAILABLE` / `SCENE_NOT_IN_CONTRACT` / `SCENE_SWITCH_FAILED`
+     * from the running game's own scenes surface, `SCENE_NOT_OPENABLE_LIVE` when
+     * this session has no remount for a native swap-slot scene,
+     * `SCENE_TABLE_UNAVAILABLE` before the adapter has
+     * loaded, and `SCENE_DOCUMENT_NOT_MOUNTED` for a piece the table says is
+     * openable and this host has no document for — a missing seam to report, not
+     * a scene that refused.
+     */
+    open(id: string): Promise<OpenedDocument>;
     /** Undo / redo one project transaction, through the session's own history
      *  queue — the same one the keyboard shortcut drives. */
     undo(): Promise<HistoryStep>;

package/dist/editor.js

@@ -194,6 +194,13 @@ export class LiveEditor {
     async openAsset(path, kind) {
         await this.#client.openAsset(path, kind ?? inferAssetKind(path));
     }
+    /**
+     * Fit native Rapier bodies and joints to a rigged GLB/glTF, copy the reusable
+     * project capability, and open the generated TSX prefab's Setup story.
+     */
+    async generateRagdoll(assetPath) {
+        return this.#client.generateRagdoll(assetPath);
+    }
     /**
      * Captures the editor's native four-view preview. A bare string is a
      * project-relative asset path (the common case); an explicit source object
@@ -257,6 +264,11 @@ export class LiveEditor {
     async inspect() {
         return this.#client.inspect();
     }
+    /** Run one verb listed by `inspect().quickActions`, through the same action
+     * the human Inspector button invokes. */
+    async runAction(actionId) {
+        return this.#client.runInspectionAction(actionId);
+    }
     /**
      * READ the hierarchy panel, as data — the rows a human is looking at right
      * now, nested exactly as the panel nests them.
@@ -301,6 +313,51 @@ export class LiveEditor {
     async setField(path, value) {
         return this.#client.setInspectionField(path, value);
     }
+    /**
+     * REMOVE one field's authored override — the revert arrow, as a command.
+     *
+     * Reach for this instead of `setField` whenever you are UNDOING an edit that
+     * added a property the source did not carry: `setField` can only write a
+     * value, so setting the default back leaves `position={[0, 0, 0]}` in the
+     * file where there was nothing before. Only this door restores the bytes.
+     *
+     * The answer is the same `{ subject, write }` shape, awaited past the bytes.
+     * It rejects with `code: 'REMOVAL_UNAVAILABLE'` when the field is not
+     * declared removable or the lane has no removal door — which is a missing
+     * seam to report, not a removal that failed.
+     */
+    async removeField(path) {
+        return this.#client.removeInspectionField(path);
+    }
+    /**
+     * OPEN one piece of the game's own SCENE TABLE by id.
+     *
+     * The address space is the adapter's declaration, not a path: `status()`'s
+     * `adapter.scenes.entries` lists every id, and the same verb opens a scene, a
+     * prefab or a story state, because the table makes them siblings — they
+     * differ only in where they are instanced.
+     *
+     * With a game LIVE in this session, a scene the adapter declares reachable
+     * through the game's own scenes contract is opened by NAVIGATING the running
+     * game (its own call, not a synthetic one), and the answer carries the game's
+     * own reading back in `scene`.
+     *
+     * Rejects with a CODE, because the classes are graded differently:
+     * `SCENE_NOT_FOUND` (which names the ids that do exist),
+     * `SCENE_NOT_OPENABLE` carrying the adapter's OWN sentence about a scene it
+     * declares unreachable, `SCENE_NAVIGATION_NOT_RUNNING` for a live-only scene
+     * while nothing is running (start the game and ask again),
+     * `SCENE_CONTRACT_UNAVAILABLE` / `SCENE_NOT_IN_CONTRACT` / `SCENE_SWITCH_FAILED`
+     * from the running game's own scenes surface, `SCENE_NOT_OPENABLE_LIVE` when
+     * this session has no remount for a native swap-slot scene,
+     * `SCENE_TABLE_UNAVAILABLE` before the adapter has
+     * loaded, and `SCENE_DOCUMENT_NOT_MOUNTED` for a piece the table says is
+     * openable and this host has no document for — a missing seam to report, not
+     * a scene that refused.
+     */
+    async open(id) {
+        return this.#client.open(id);
+    }
     /** Undo / redo one project transaction, through the session's own history
      *  queue — the same one the keyboard shortcut drives. */
     async undo() {

package/package.json

@@ -2,7 +2,7 @@
   "name": "@vgai/live",
   "author": "Volter AI, Inc.",
   "license": "Apache-2.0",
-  "version": "0.5.15",
+  "version": "0.5.17",
   "type": "module",
   "repository": {
     "type": "git",
@@ -28,11 +28,12 @@
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
-    "dev": "tsc -p tsconfig.build.json --watch --preserveWatchOutput"
+    "dev": "tsc -p tsconfig.build.json --watch --preserveWatchOutput",
+    "prepack": "npm run build"
   },
   "dependencies": {
-    "@vgai/editor-sdk": "0.5.15",
-    "@vgai/sdk": "0.5.15"
+    "@vgai/editor-sdk": "0.5.17",
+    "@vgai/sdk": "0.5.17"
   },
   "peerDependencies": {
     "@playwright/test": ">=1.58.2 <2"

package/src/editor.ts

@@ -25,7 +25,9 @@ import type {
   InspectedFieldWrite,
   InspectedHierarchy,
   InspectedInspection,
+  OpenedDocument,
   PresentedEditorView,
+  RagdollGenerationResult,
   ShadingMode,
   ViewPreset,
   ViewportCapture,
@@ -241,6 +243,14 @@ export class LiveEditor {
     await this.#client.openAsset(path, kind ?? inferAssetKind(path));
   }
 
+  /**
+   * Fit native Rapier bodies and joints to a rigged GLB/glTF, copy the reusable
+   * project capability, and open the generated TSX prefab's Setup story.
+   */
+  async generateRagdoll(assetPath: string): Promise<RagdollGenerationResult> {
+    return this.#client.generateRagdoll(assetPath);
+  }
+
   /**
    * Captures the editor's native four-view preview. A bare string is a
    * project-relative asset path (the common case); an explicit source object
@@ -317,6 +327,12 @@ export class LiveEditor {
     return this.#client.inspect();
   }
 
+  /** Run one verb listed by `inspect().quickActions`, through the same action
+   * the human Inspector button invokes. */
+  async runAction(actionId: string): Promise<InspectedInspection> {
+    return this.#client.runInspectionAction(actionId);
+  }
+
   /**
    * READ the hierarchy panel, as data — the rows a human is looking at right
    * now, nested exactly as the panel nests them.
@@ -363,6 +379,53 @@ export class LiveEditor {
     return this.#client.setInspectionField(path, value);
   }
 
+  /**
+   * REMOVE one field's authored override — the revert arrow, as a command.
+   *
+   * Reach for this instead of `setField` whenever you are UNDOING an edit that
+   * added a property the source did not carry: `setField` can only write a
+   * value, so setting the default back leaves `position={[0, 0, 0]}` in the
+   * file where there was nothing before. Only this door restores the bytes.
+   *
+   * The answer is the same `{ subject, write }` shape, awaited past the bytes.
+   * It rejects with `code: 'REMOVAL_UNAVAILABLE'` when the field is not
+   * declared removable or the lane has no removal door — which is a missing
+   * seam to report, not a removal that failed.
+   */
+  async removeField(path: string): Promise<InspectedFieldWrite> {
+    return this.#client.removeInspectionField(path);
+  }
+
+  /**
+   * OPEN one piece of the game's own SCENE TABLE by id.
+   *
+   * The address space is the adapter's declaration, not a path: `status()`'s
+   * `adapter.scenes.entries` lists every id, and the same verb opens a scene, a
+   * prefab or a story state, because the table makes them siblings — they
+   * differ only in where they are instanced.
+   *
+   * With a game LIVE in this session, a scene the adapter declares reachable
+   * through the game's own scenes contract is opened by NAVIGATING the running
+   * game (its own call, not a synthetic one), and the answer carries the game's
+   * own reading back in `scene`.
+   *
+   * Rejects with a CODE, because the classes are graded differently:
+   * `SCENE_NOT_FOUND` (which names the ids that do exist),
+   * `SCENE_NOT_OPENABLE` carrying the adapter's OWN sentence about a scene it
+   * declares unreachable, `SCENE_NAVIGATION_NOT_RUNNING` for a live-only scene
+   * while nothing is running (start the game and ask again),
+   * `SCENE_CONTRACT_UNAVAILABLE` / `SCENE_NOT_IN_CONTRACT` / `SCENE_SWITCH_FAILED`
+   * from the running game's own scenes surface, `SCENE_NOT_OPENABLE_LIVE` when
+   * this session has no remount for a native swap-slot scene,
+   * `SCENE_TABLE_UNAVAILABLE` before the adapter has
+   * loaded, and `SCENE_DOCUMENT_NOT_MOUNTED` for a piece the table says is
+   * openable and this host has no document for — a missing seam to report, not
+   * a scene that refused.
+   */
+  async open(id: string): Promise<OpenedDocument> {
+    return this.#client.open(id);
+  }
+
   /** Undo / redo one project transaction, through the session's own history
    *  queue — the same one the keyboard shortcut drives. */
   async undo(): Promise<HistoryStep> {