@forgeax/engine-devkit 0.1.4 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/README.md +19 -4
  2. package/dist/.tsbuildinfo +1 -1
  3. package/dist/__tests__/cli-output.unit.test.d.ts +2 -0
  4. package/dist/__tests__/cli-output.unit.test.d.ts.map +1 -0
  5. package/dist/__tests__/gltf-source-key-diagnostics.integration.test.d.ts +2 -0
  6. package/dist/__tests__/gltf-source-key-diagnostics.integration.test.d.ts.map +1 -0
  7. package/dist/__tests__/preview-port.integration.test.d.ts +2 -0
  8. package/dist/__tests__/preview-port.integration.test.d.ts.map +1 -0
  9. package/dist/__tests__/rhi-debug-build-graph.integration.test.d.ts +2 -0
  10. package/dist/__tests__/rhi-debug-build-graph.integration.test.d.ts.map +1 -0
  11. package/dist/__tests__/sdk-update.unit.test.d.ts +2 -0
  12. package/dist/__tests__/sdk-update.unit.test.d.ts.map +1 -0
  13. package/dist/assets.d.ts.map +1 -1
  14. package/dist/bootstrap-commands.d.ts.map +1 -1
  15. package/dist/cli-output.d.ts +4 -0
  16. package/dist/cli-output.d.ts.map +1 -0
  17. package/dist/cli.mjs +380 -567
  18. package/dist/cli.mjs.map +1 -1
  19. package/dist/commands.d.ts.map +1 -1
  20. package/dist/host/__tests__/bootstrap-root-owner.test-d.d.ts +2 -0
  21. package/dist/host/__tests__/bootstrap-root-owner.test-d.d.ts.map +1 -0
  22. package/dist/host/project-bootstrap.d.ts +4 -2
  23. package/dist/host/project-bootstrap.d.ts.map +1 -1
  24. package/dist/host/resource-bootstrap.d.ts +5 -3
  25. package/dist/host/resource-bootstrap.d.ts.map +1 -1
  26. package/dist/host.d.ts +2 -1
  27. package/dist/host.d.ts.map +1 -1
  28. package/dist/index.d.ts +4 -0
  29. package/dist/index.d.ts.map +1 -1
  30. package/dist/index.mjs +303 -570
  31. package/dist/index.mjs.map +1 -1
  32. package/dist/project.d.ts +0 -1
  33. package/dist/project.d.ts.map +1 -1
  34. package/dist/rhi-debug/cli-context.d.ts.map +1 -1
  35. package/dist/sdk-bootstrap.d.ts +9 -0
  36. package/dist/sdk-bootstrap.d.ts.map +1 -1
  37. package/dist/sdk-cli.mjs +190 -24
  38. package/dist/sdk-cli.mjs.map +1 -1
  39. package/dist/sdk-install.d.ts.map +1 -1
  40. package/dist/sdk-update.d.ts +23 -0
  41. package/dist/sdk-update.d.ts.map +1 -0
  42. package/dist/tools/benchmark/__tests__/benchmark-vocabulary-owner.test-d.d.ts +2 -0
  43. package/dist/tools/benchmark/__tests__/benchmark-vocabulary-owner.test-d.d.ts.map +1 -0
  44. package/dist/tools/benchmark/harness.d.ts.map +1 -1
  45. package/dist/tools/browser-host.d.ts.map +1 -1
  46. package/dist/tools/native-preview.d.ts.map +1 -1
  47. package/dist/types.d.ts +7 -0
  48. package/dist/types.d.ts.map +1 -1
  49. package/package.json +29 -30
  50. package/dist/__tests__/tool-migration.test.d.ts +0 -2
  51. package/dist/__tests__/tool-migration.test.d.ts.map +0 -1
package/README.md CHANGED
@@ -36,11 +36,16 @@ forgeax list --json
36
36
  forgeax describe project.build --json
37
37
  forgeax run project.build --input request.json --json
38
38
  forgeax exec program.mjs --json
39
- forgeax run rhi.capture
40
- forgeax run rhi.summary --artifact {ArtifactRef}
41
- forgeax run rhi.inspect --artifact {ArtifactRef} --work-index {workIndex}
39
+ forgeax run rhi.summary --artifact .forgeax-debug/{runId}/frame.rhitape --digest {sha256}
40
+ forgeax run rhi.inspect --artifact .forgeax-debug/{runId}/frame.rhitape --digest {sha256} --work-index {workIndex}
42
41
  ```
43
42
 
43
+ > [!IMPORTANT]
44
+ > `forgeax dev` is a source-development server and `forgeax preview` is a
45
+ > verified static `dist/` server. Their `--json` startup envelopes expose
46
+ > `mode`, `serves`, and the current `rhi.capture` capability. Neither command
47
+ > silently invents a live capture attachment.
48
+
44
49
  Static deployment is an Engine-owned build product. A publishing host supplies
45
50
  the project root, public URL base, and dedicated output directory; DevKit owns
46
51
  the generated host, asset cooking, shader compilation, Pack index, and
@@ -85,13 +90,23 @@ through to another realm.
85
90
 
86
91
  ## RHI-debug operations
87
92
 
93
+ The operation manifest describes the complete host contract, but a standalone
94
+ CLI process does not own a running browser App. Consequently,
95
+ `forgeax run rhi.capture --json` is a structured capability probe and returns
96
+ `capture-unavailable` until a recorder-enabled live host supplies the
97
+ `rhiCapture` eval root. Use the browser live bridge described by the
98
+ `forgeax-engine-cli` skill to invoke that root; preserve the resulting tape's
99
+ `digest` and `path` for the offline commands below. `rhi.summary` and
100
+ `rhi.inspect` remain directly executable because they consume the persisted
101
+ artifact rather than live App state.
102
+
88
103
  ```mermaid
89
104
  sequenceDiagram
90
105
  participant AI as "AI or CLI"
91
106
  participant H as "Host"
92
107
  participant D as "DevKit"
93
108
  participant R as "Fresh replay backend"
94
- AI->>H: "rhi.capture"
109
+ AI->>H: "rhiCapture.captureFrame through the live host"
95
110
  H-->>AI: "one ArtifactRef"
96
111
  AI->>D: "rhi.summary + ArtifactRef"
97
112
  D-->>AI: "FrameModel and workIndex"