@forgeax/engine-devkit 0.1.3 → 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 (53) hide show
  1. package/README.md +30 -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 +728 -641
  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 +662 -655
  31. package/dist/index.mjs.map +1 -1
  32. package/dist/init.d.ts +2 -1
  33. package/dist/init.d.ts.map +1 -1
  34. package/dist/project.d.ts +0 -1
  35. package/dist/project.d.ts.map +1 -1
  36. package/dist/rhi-debug/cli-context.d.ts.map +1 -1
  37. package/dist/sdk-bootstrap.d.ts +34 -0
  38. package/dist/sdk-bootstrap.d.ts.map +1 -0
  39. package/dist/sdk-cli.mjs +412 -66
  40. package/dist/sdk-cli.mjs.map +1 -1
  41. package/dist/sdk-install.d.ts.map +1 -1
  42. package/dist/sdk-update.d.ts +23 -0
  43. package/dist/sdk-update.d.ts.map +1 -0
  44. package/dist/tools/benchmark/__tests__/benchmark-vocabulary-owner.test-d.d.ts +2 -0
  45. package/dist/tools/benchmark/__tests__/benchmark-vocabulary-owner.test-d.d.ts.map +1 -0
  46. package/dist/tools/benchmark/harness.d.ts.map +1 -1
  47. package/dist/tools/browser-host.d.ts.map +1 -1
  48. package/dist/tools/native-preview.d.ts.map +1 -1
  49. package/dist/types.d.ts +7 -0
  50. package/dist/types.d.ts.map +1 -1
  51. package/package.json +29 -30
  52. package/dist/__tests__/tool-migration.test.d.ts +0 -2
  53. package/dist/__tests__/tool-migration.test.d.ts.map +0 -1
package/README.md CHANGED
@@ -36,16 +36,28 @@ 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
47
52
  `forgeax-dist.json` closure.
48
53
 
54
+ > [!IMPORTANT]
55
+ > DevKit also closes the Engine builtin-mesh dependency boundary. During a
56
+ > standalone build it adds a generated Pack descriptor only for builtin mesh
57
+ > GUIDs absent from the project; the Geometry decoder turns those descriptors
58
+ > into validated primitive meshes. Project-authored descriptors remain the
59
+ > single declaration, so the generated Pack never creates a GUID collision.
60
+
49
61
  ```bash
50
62
  forgeax build ./games/my-game \
51
63
  --base /games/my-game/ \
@@ -78,13 +90,23 @@ through to another realm.
78
90
 
79
91
  ## RHI-debug operations
80
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
+
81
103
  ```mermaid
82
104
  sequenceDiagram
83
105
  participant AI as "AI or CLI"
84
106
  participant H as "Host"
85
107
  participant D as "DevKit"
86
108
  participant R as "Fresh replay backend"
87
- AI->>H: "rhi.capture"
109
+ AI->>H: "rhiCapture.captureFrame through the live host"
88
110
  H-->>AI: "one ArtifactRef"
89
111
  AI->>D: "rhi.summary + ArtifactRef"
90
112
  D-->>AI: "FrameModel and workIndex"
@@ -140,6 +162,10 @@ RhiNull readiness are not visual proof.
140
162
  Game projects keep authority in `forge.json`, package manifests,
141
163
  `package.json#forgeax.assets`, source Meta/Pack files, and imported game code.
142
164
  DevKit derives Vite and producer assembly from those facts.
165
+ The [asset authority audit schema](../../asset-authority.schema.json) records
166
+ the subject, execution, lifecycle, and runtime boundary for each producer; use
167
+ the producer's inspect/rebuild or cold-cook evidence when a derived Catalog is
168
+ stale instead of treating the runtime projection as author authority.
143
169
 
144
170
  `forge.json#entry` is the required game bootstrap authority. When that module
145
171
  is not also named by `forge.json.plugins[]`, DevKit adapts its named