@iwsdk/create 1.1.0 → 1.2.0-rc.1
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.
- package/README.md +68 -16
- package/dist/cli.js +7917 -3404
- package/dist/guidance/{agents → files}/.agents/skills/iwsdk-build-model/SKILL.md +1 -0
- package/dist/guidance/{claude/.claude → files/.agents}/skills/iwsdk-compose-scene/SKILL.md +3 -2
- package/dist/guidance/{claude/.claude → files/.agents}/skills/iwsdk-debug/SKILL.md +1 -0
- package/dist/guidance/{claude/.claude → files/.agents}/skills/iwsdk-depth-occlusion/SKILL.md +1 -0
- package/dist/guidance/{claude/.claude → files/.agents}/skills/iwsdk-dev/SKILL.md +1 -0
- package/dist/guidance/{agents → files}/.agents/skills/iwsdk-dev/references/api-reference.md +8 -1
- package/dist/guidance/files/.agents/skills/iwsdk-dev/references/headless-rendering.md +96 -0
- package/dist/guidance/{claude/.claude → files/.agents}/skills/iwsdk-dev/references/iterate.md +16 -7
- package/dist/guidance/{claude/.claude → files/.agents}/skills/iwsdk-dev/references/planner.md +9 -5
- package/dist/guidance/{agents → files}/.agents/skills/iwsdk-glasses-test/SKILL.md +1 -0
- package/dist/guidance/{claude/.claude → files/.agents}/skills/iwsdk-grab/SKILL.md +1 -0
- package/dist/guidance/{agents → files}/.agents/skills/iwsdk-hosting/SKILL.md +3 -1
- package/dist/guidance/{claude/.claude → files/.agents}/skills/iwsdk-native-xr-test/SKILL.md +17 -1
- package/dist/guidance/files/.agents/skills/iwsdk-offline/SKILL.md +217 -0
- package/dist/guidance/files/.agents/skills/iwsdk-offline/assets/offline.ts.template +99 -0
- package/dist/guidance/files/.agents/skills/iwsdk-offline/assets/sw.js.template +241 -0
- package/dist/guidance/files/.agents/skills/iwsdk-offline/assets/write-service-worker.mjs.template +72 -0
- package/dist/guidance/files/.agents/skills/iwsdk-offline/references/build-step.md +71 -0
- package/dist/guidance/files/.agents/skills/iwsdk-offline/references/page.md +70 -0
- package/dist/guidance/files/.agents/skills/iwsdk-offline/references/service-worker.md +107 -0
- package/dist/guidance/files/.agents/skills/iwsdk-offline/references/testing.md +57 -0
- package/dist/guidance/{agents → files}/.agents/skills/iwsdk-physics/SKILL.md +1 -0
- package/dist/guidance/{agents → files}/.agents/skills/iwsdk-physics/references/tuning-and-config.md +1 -0
- package/dist/guidance/{claude/.claude → files/.agents}/skills/iwsdk-physics/references/workflows.md +9 -3
- package/dist/guidance/{claude/.claude → files/.agents}/skills/iwsdk-pwa-packaging/SKILL.md +13 -1
- package/dist/guidance/{agents → files}/.agents/skills/iwsdk-pwa-packaging/references/manifest-and-icons.md +1 -1
- package/dist/guidance/{agents → files}/.agents/skills/iwsdk-pwa-packaging/references/troubleshooting.md +30 -0
- package/dist/guidance/{agents → files}/.agents/skills/iwsdk-ray/SKILL.md +1 -0
- package/dist/guidance/{claude/.claude → files/.agents}/skills/iwsdk-ui/SKILL.md +17 -7
- package/dist/guidance/files/.agents/skills/iwsdk-upgrade/SKILL.md +74 -0
- package/dist/guidance/{claude → files}/.claude/agents/iwsdk-project-code-reviewer.md +1 -0
- package/dist/guidance/{claude → files}/.claude/rules/assets-and-manifest.md +3 -0
- package/dist/guidance/{claude → files}/.claude/rules/ecs-api.md +1 -0
- package/dist/guidance/{claude → files}/.claude/rules/scene-json.md +1 -0
- package/dist/guidance/{claude → files}/.claude/rules/uikitml.md +1 -0
- package/dist/guidance/{claude → files}/.claude/settings.json +9 -3
- package/dist/guidance/{claude → files}/.claude/skills/iwsdk-build-model/SKILL.md +1 -0
- package/dist/guidance/{agents/.agents → files/.claude}/skills/iwsdk-compose-scene/SKILL.md +3 -2
- package/dist/guidance/{agents/.agents → files/.claude}/skills/iwsdk-debug/SKILL.md +1 -0
- package/dist/guidance/{agents/.agents → files/.claude}/skills/iwsdk-depth-occlusion/SKILL.md +1 -0
- package/dist/guidance/{agents/.agents → files/.claude}/skills/iwsdk-dev/SKILL.md +1 -0
- package/dist/guidance/{claude → files}/.claude/skills/iwsdk-dev/references/api-reference.md +8 -1
- package/dist/guidance/files/.claude/skills/iwsdk-dev/references/headless-rendering.md +96 -0
- package/dist/guidance/{agents/.agents → files/.claude}/skills/iwsdk-dev/references/iterate.md +16 -7
- package/dist/guidance/{agents/.agents → files/.claude}/skills/iwsdk-dev/references/planner.md +9 -5
- package/dist/guidance/{claude → files}/.claude/skills/iwsdk-glasses-test/SKILL.md +1 -0
- package/dist/guidance/{agents/.agents → files/.claude}/skills/iwsdk-grab/SKILL.md +1 -0
- package/dist/guidance/{claude → files}/.claude/skills/iwsdk-hosting/SKILL.md +3 -1
- package/dist/guidance/{agents/.agents → files/.claude}/skills/iwsdk-native-xr-test/SKILL.md +17 -1
- package/dist/guidance/files/.claude/skills/iwsdk-offline/SKILL.md +217 -0
- package/dist/guidance/files/.claude/skills/iwsdk-offline/assets/offline.ts.template +99 -0
- package/dist/guidance/files/.claude/skills/iwsdk-offline/assets/sw.js.template +241 -0
- package/dist/guidance/files/.claude/skills/iwsdk-offline/assets/write-service-worker.mjs.template +72 -0
- package/dist/guidance/files/.claude/skills/iwsdk-offline/references/build-step.md +71 -0
- package/dist/guidance/files/.claude/skills/iwsdk-offline/references/page.md +70 -0
- package/dist/guidance/files/.claude/skills/iwsdk-offline/references/service-worker.md +107 -0
- package/dist/guidance/files/.claude/skills/iwsdk-offline/references/testing.md +57 -0
- package/dist/guidance/{claude → files}/.claude/skills/iwsdk-physics/SKILL.md +1 -0
- package/dist/guidance/{claude → files}/.claude/skills/iwsdk-physics/references/tuning-and-config.md +1 -0
- package/dist/guidance/{agents/.agents → files/.claude}/skills/iwsdk-physics/references/workflows.md +9 -3
- package/dist/guidance/{agents/.agents → files/.claude}/skills/iwsdk-pwa-packaging/SKILL.md +13 -1
- package/dist/guidance/{claude → files}/.claude/skills/iwsdk-pwa-packaging/references/manifest-and-icons.md +1 -1
- package/dist/guidance/{claude → files}/.claude/skills/iwsdk-pwa-packaging/references/troubleshooting.md +30 -0
- package/dist/guidance/{claude → files}/.claude/skills/iwsdk-ray/SKILL.md +1 -0
- package/dist/guidance/{agents/.agents → files/.claude}/skills/iwsdk-ui/SKILL.md +17 -7
- package/dist/guidance/files/.claude/skills/iwsdk-upgrade/SKILL.md +74 -0
- package/dist/guidance/{cursor → files}/.cursor/rules/assets-and-manifest.mdc +3 -0
- package/dist/guidance/{cursor → files}/.cursor/rules/ecs-api.mdc +1 -0
- package/dist/guidance/{cursor → files}/.cursor/rules/scene-json.mdc +1 -0
- package/dist/guidance/{cursor → files}/.cursor/rules/uikitml.mdc +1 -0
- package/dist/guidance/{copilot → files}/.github/instructions/assets-and-manifest.instructions.md +2 -1
- package/dist/guidance/{copilot → files}/.github/instructions/ecs-api.instructions.md +1 -0
- package/dist/guidance/{copilot → files}/.github/instructions/scene-json.instructions.md +1 -0
- package/dist/guidance/{copilot → files}/.github/instructions/uikitml.instructions.md +1 -0
- package/dist/guidance/{common → files}/AGENTS.md +107 -27
- package/dist/guidance/{scoped-agents → files}/public/scenes/AGENTS.md +2 -0
- package/dist/guidance/{scoped-agents → files}/public/ui/AGENTS.md +2 -0
- package/dist/guidance/{scoped-agents → files}/src/AGENTS.md +2 -0
- package/dist/guidance/manifest.json +954 -0
- package/dist/template/common/.codex/config.toml +2 -0
- package/package.json +5 -5
- package/scripts/verify-release-ready.mjs +1 -2
- /package/dist/guidance/{agents → files}/.agents/skills/iwsdk-build-model/agents/openai.yaml +0 -0
- /package/dist/guidance/{agents → files}/.agents/skills/iwsdk-build-model/assets/hardsurface.ts.template +0 -0
- /package/dist/guidance/{agents → files}/.agents/skills/iwsdk-compose-scene/agents/openai.yaml +0 -0
- /package/dist/guidance/{agents → files}/.agents/skills/iwsdk-compose-scene/references/environment-recipes.md +0 -0
- /package/dist/guidance/{agents → files}/.agents/skills/iwsdk-compose-scene/references/extended-workflow.md +0 -0
- /package/dist/guidance/{agents → files}/.agents/skills/iwsdk-compose-scene/references/image-intake.md +0 -0
- /package/dist/guidance/{agents → files}/.agents/skills/iwsdk-compose-scene/references/scene-composition.md +0 -0
- /package/dist/guidance/{agents → files}/.agents/skills/iwsdk-compose-scene/references/scene-format.md +0 -0
- /package/dist/guidance/{agents → files}/.agents/skills/iwsdk-compose-scene/references/scene-review.md +0 -0
- /package/dist/guidance/{agents → files}/.agents/skills/iwsdk-compose-scene/references/text-intake.md +0 -0
- /package/dist/guidance/{agents → files}/.agents/skills/iwsdk-hosting/references/existing-hosts.md +0 -0
- /package/dist/guidance/{agents → files}/.agents/skills/iwsdk-hosting/references/vercel.md +0 -0
- /package/dist/guidance/{agents → files}/.agents/skills/iwsdk-physics/references/component-reference.md +0 -0
- /package/dist/guidance/{agents → files}/.agents/skills/iwsdk-pwa-packaging/references/app-modes.md +0 -0
- /package/dist/guidance/{agents → files}/.agents/skills/iwsdk-pwa-packaging/references/bubblewrap.md +0 -0
- /package/dist/guidance/{agents → files}/.agents/skills/iwsdk-pwa-packaging/references/store-upload.md +0 -0
- /package/dist/guidance/{claude → files}/.claude/skills/iwsdk-build-model/agents/openai.yaml +0 -0
- /package/dist/guidance/{claude → files}/.claude/skills/iwsdk-build-model/assets/hardsurface.ts.template +0 -0
- /package/dist/guidance/{claude → files}/.claude/skills/iwsdk-compose-scene/agents/openai.yaml +0 -0
- /package/dist/guidance/{claude → files}/.claude/skills/iwsdk-compose-scene/references/environment-recipes.md +0 -0
- /package/dist/guidance/{claude → files}/.claude/skills/iwsdk-compose-scene/references/extended-workflow.md +0 -0
- /package/dist/guidance/{claude → files}/.claude/skills/iwsdk-compose-scene/references/image-intake.md +0 -0
- /package/dist/guidance/{claude → files}/.claude/skills/iwsdk-compose-scene/references/scene-composition.md +0 -0
- /package/dist/guidance/{claude → files}/.claude/skills/iwsdk-compose-scene/references/scene-format.md +0 -0
- /package/dist/guidance/{claude → files}/.claude/skills/iwsdk-compose-scene/references/scene-review.md +0 -0
- /package/dist/guidance/{claude → files}/.claude/skills/iwsdk-compose-scene/references/text-intake.md +0 -0
- /package/dist/guidance/{claude → files}/.claude/skills/iwsdk-hosting/references/existing-hosts.md +0 -0
- /package/dist/guidance/{claude → files}/.claude/skills/iwsdk-hosting/references/vercel.md +0 -0
- /package/dist/guidance/{claude → files}/.claude/skills/iwsdk-physics/references/component-reference.md +0 -0
- /package/dist/guidance/{claude → files}/.claude/skills/iwsdk-pwa-packaging/references/app-modes.md +0 -0
- /package/dist/guidance/{claude → files}/.claude/skills/iwsdk-pwa-packaging/references/bubblewrap.md +0 -0
- /package/dist/guidance/{claude → files}/.claude/skills/iwsdk-pwa-packaging/references/store-upload.md +0 -0
- /package/dist/guidance/{claude → files}/CLAUDE.md +0 -0
- /package/dist/{guidance/codex → template/common-js}/.codex/config.toml +0 -0
|
@@ -309,3 +309,4 @@ Hand `iwsdk-compose-scene`:
|
|
|
309
309
|
|
|
310
310
|
Do not compensate for a model-local defect with a scene transform. Do not start scene
|
|
311
311
|
lighting or camera iteration until the model passes isolated review.
|
|
312
|
+
<!-- iwsdk-agent-guidance version=1.2.0-rc.1 sha256=95fc72ddf1f3915aa71a839558a3ce051b803214b25ad8c594e882068a3d7917 name=iwsdk-build-model (installed by IWSDK; `npx @iwsdk/cli@latest agents sync` refreshes it and leaves it alone once edited) -->
|
|
@@ -122,8 +122,8 @@ npx @iwsdk/cli scene state --raw
|
|
|
122
122
|
`iwsdk dev up` starts the server in the background and launches the configured
|
|
123
123
|
managed editor browser. It can return while that browser is still starting; use
|
|
124
124
|
`iwsdk runtime wait` or inspect `iwsdk runtime status` before browser-backed
|
|
125
|
-
commands.
|
|
126
|
-
startup workaround.
|
|
125
|
+
commands. Pass the `--ai-mode` that AGENTS.md's session rule picks; do not edit
|
|
126
|
+
`vite.config.ts` to change browser mode as an ad hoc startup workaround.
|
|
127
127
|
|
|
128
128
|
`scene_render_file` renders a file without replacing the editor's active document,
|
|
129
129
|
but it still uses the managed editor browser for manifest evaluation and WebGL.
|
|
@@ -274,3 +274,4 @@ components, schema errors, image reconstruction, or ambiguous composition eviden
|
|
|
274
274
|
When the Fast Path does not apply, read and follow
|
|
275
275
|
[extended-workflow.md](references/extended-workflow.md). Do not load that reference
|
|
276
276
|
for a routine scene assembled from known manifest assets.
|
|
277
|
+
<!-- iwsdk-agent-guidance version=1.2.0-rc.1 sha256=e6feb83023b2ddbe9a3cceea3b0deda0fe8beb9743d4af6b8e0a89ea31e61b93 name=iwsdk-compose-scene (installed by IWSDK; `npx @iwsdk/cli@latest agents sync` refreshes it and leaves it alone once edited) -->
|
|
@@ -71,3 +71,4 @@ established from the measured state.
|
|
|
71
71
|
Make at most one focused correction. Stop when the original symptom no longer
|
|
72
72
|
reproduces and the measured state agrees with the intended behavior. Call
|
|
73
73
|
`ecs_resume` before finishing and leave input buttons released.
|
|
74
|
+
<!-- iwsdk-agent-guidance version=1.2.0-rc.1 sha256=7dd8250ca95e23b6f0696a86a3dfcb2d038ac730a7578118fb21290c6169c3f0 name=iwsdk-debug (installed by IWSDK; `npx @iwsdk/cli@latest agents sync` refreshes it and leaves it alone once edited) -->
|
package/dist/guidance/{claude/.claude → files/.agents}/skills/iwsdk-depth-occlusion/SKILL.md
RENAMED
|
@@ -85,3 +85,4 @@ not alter the project camera or render extra authored angles to manufacture an
|
|
|
85
85
|
occlusion view; stage the requested nodes once, then judge the live AR capture.
|
|
86
86
|
Do not inspect framework source when the build, registered-system query, entity
|
|
87
87
|
components, and console warnings already establish the failing layer.
|
|
88
|
+
<!-- iwsdk-agent-guidance version=1.2.0-rc.1 sha256=819e3f213766f12b567fa8ffd5e343f1a17f83973642067d82ebd7c5dee1dbe3 name=iwsdk-depth-occlusion (installed by IWSDK; `npx @iwsdk/cli@latest agents sync` refreshes it and leaves it alone once edited) -->
|
|
@@ -43,3 +43,4 @@ Observable workspace state wins over wording:
|
|
|
43
43
|
|
|
44
44
|
iwsdk-dev does not add another implementation phase. The selected playbook owns
|
|
45
45
|
the work, evidence budget, specialist routing, verification, and stopping rule.
|
|
46
|
+
<!-- iwsdk-agent-guidance version=1.2.0-rc.1 sha256=58d4ce27ef04658c338d8bb0883b0718ba52037bd043fcc5f80783550bc20673 name=iwsdk-dev (installed by IWSDK; `npx @iwsdk/cli@latest agents sync` refreshes it and leaves it alone once edited) -->
|
|
@@ -461,7 +461,8 @@ PhysicsShapeType.Auto; // Auto-detect from Three.js geometry
|
|
|
461
461
|
|
|
462
462
|
**Teleporting / re-posing an existing body:** use the live physics system rather than
|
|
463
463
|
removing and re-adding components. It updates Havok and the Object3D immediately and
|
|
464
|
-
clears velocity by default
|
|
464
|
+
clears velocity by default. The pose is parent-relative unless you pass
|
|
465
|
+
`{ space: 'world' }`:
|
|
465
466
|
|
|
466
467
|
```typescript
|
|
467
468
|
const physics = world.getSystem(PhysicsSystem);
|
|
@@ -1387,6 +1388,12 @@ const texture = AssetManager.getTexture('myTexture');
|
|
|
1387
1388
|
const audio = AssetManager.getAudio('mySound');
|
|
1388
1389
|
```
|
|
1389
1390
|
|
|
1391
|
+
**Render loop (headless automation):** `world.renderMode` is `'continuous'`
|
|
1392
|
+
(default) or `'on-demand'`. On demand, systems still run every frame but only
|
|
1393
|
+
frames asked for are drawn: `await world.requestRender(frames)` or
|
|
1394
|
+
`const release = world.holdRender()` (draw every frame until `release()`).
|
|
1395
|
+
Headless dev sessions switch it on for you; shipped apps keep `'continuous'`.
|
|
1396
|
+
|
|
1390
1397
|
**Runtime loading (on-demand):**
|
|
1391
1398
|
|
|
1392
1399
|
```typescript
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# Headless rendering (no GPU)
|
|
2
|
+
|
|
3
|
+
Read this when the managed session is headless (`--ai-mode agent` or
|
|
4
|
+
`--headless`), the host has no GPU, or a result depends on frame rate, frame
|
|
5
|
+
timing, or which frame a screenshot shows.
|
|
6
|
+
|
|
7
|
+
## What headless sessions do
|
|
8
|
+
|
|
9
|
+
A headless managed session renders **on demand**. Every ECS system, input,
|
|
10
|
+
physics and UI update still runs on every frame, but the app draws a frame only
|
|
11
|
+
when a tool needs pixels. Without a GPU every draw is software-rasterized, so
|
|
12
|
+
this keeps the app at the browser's frame rate (60 fps) instead of a few frames
|
|
13
|
+
per second.
|
|
14
|
+
|
|
15
|
+
- `browser screenshot` draws a fresh frame first. Screenshots always show the
|
|
16
|
+
current state, in the browser view and in XR. In emulated AR, the synthetic
|
|
17
|
+
room behind the app draws with it, so the two always match.
|
|
18
|
+
- `scene render-stats` draws one fresh frame before it reads the stats.
|
|
19
|
+
`browser profile`, runtime evidence and `browser run` scripts draw every
|
|
20
|
+
frame while they run. A profile first draws three warm-up frames, so
|
|
21
|
+
one-time first-draw costs (shader compilation, texture uploads) stay out of
|
|
22
|
+
its numbers.
|
|
23
|
+
- Headed sessions, including collaborate mode, always draw every frame.
|
|
24
|
+
- To draw every frame in a headless session, start it with
|
|
25
|
+
`IWSDK_DEV_RENDER_MODE=continuous`.
|
|
26
|
+
|
|
27
|
+
## Check state, then look
|
|
28
|
+
|
|
29
|
+
Prove behavior with ECS state (`ecs query`, `ecs find`, `ecs snapshot`,
|
|
30
|
+
`ecs diff`). These need no pixels and see every frame. Take a screenshot only
|
|
31
|
+
for visual claims.
|
|
32
|
+
|
|
33
|
+
## Capture an exact frame
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
npx @iwsdk/cli ecs pause --input-json '{}'
|
|
37
|
+
npx @iwsdk/cli ecs step --input-json '{"count":1}'
|
|
38
|
+
npx @iwsdk/cli browser screenshot --input-json '{}' --output-file artifacts/frame.png
|
|
39
|
+
npx @iwsdk/cli ecs resume --input-json '{}'
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
A screenshot draws without advancing the simulation, so it shows exactly the
|
|
43
|
+
paused frame.
|
|
44
|
+
|
|
45
|
+
To see motion, capture a filmstrip: exact simulation frames at offsets 0, K,
|
|
46
|
+
2K, … in one contact-sheet image.
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
npx @iwsdk/cli browser filmstrip --count 6 --every 5 --output-file artifacts/fall.png
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Switch the render mode at runtime
|
|
53
|
+
|
|
54
|
+
The `RuntimeSettings` component controls the render mode. It exists only at
|
|
55
|
+
runtime and is never saved into scene files.
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
npx @iwsdk/cli ecs find --input-json '{"withComponents":["RuntimeSettings"]}'
|
|
59
|
+
npx @iwsdk/cli ecs set-component --input-json '{"entityIndex":<index>,"componentId":"RuntimeSettings","field":"renderMode","value":"continuous"}'
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Without a GPU, continuous drawing drops the app to a few frames per second, so
|
|
63
|
+
set it back to `"on-demand"` when done.
|
|
64
|
+
|
|
65
|
+
## Do not
|
|
66
|
+
|
|
67
|
+
- Judge performance from headless frame rates. Profile instead, which draws
|
|
68
|
+
every frame while it runs, or measure on a device:
|
|
69
|
+
`npx @iwsdk/cli browser profile --input-json '{"action":"start","mode":"rendering"}'`,
|
|
70
|
+
exercise the scene, then
|
|
71
|
+
`npx @iwsdk/cli browser profile --input-json '{"action":"stop"}'`.
|
|
72
|
+
- Trust the frame times of a profile that reports a `render-warmup-timeout`
|
|
73
|
+
interruption (the app did not draw its warm-up frames in the time the start
|
|
74
|
+
allowed, at most 5 seconds) or `render-loop-stopped` (the app drew nothing
|
|
75
|
+
for 30 or more animation frames in a row while the profile held rendering:
|
|
76
|
+
its render loop stopped, before the profile or during it, or stalled). The
|
|
77
|
+
usual cause is an uncaught error in a frame, which stops the render loop;
|
|
78
|
+
check `npx @iwsdk/cli browser logs`. After a warm-up timeout, the first
|
|
79
|
+
frames may also just be very slow. Fix the error, or profile again.
|
|
80
|
+
- Trust the frame times of a profile that reports
|
|
81
|
+
`render-warmup-skipped-budget` (less than a second of the command's time
|
|
82
|
+
was left for the warm-up) or `render-mode-unavailable`. It sampled without
|
|
83
|
+
warm-up frames, so its numbers may include first-draw costs. Profile again.
|
|
84
|
+
- Expect a frame to change between screenshots if the scene did not change.
|
|
85
|
+
- Restart into headed mode to "fix" a stale view; screenshots already draw a
|
|
86
|
+
fresh frame.
|
|
87
|
+
|
|
88
|
+
## Limits
|
|
89
|
+
|
|
90
|
+
- App code that reads pixels from the canvas itself (for example
|
|
91
|
+
`canvas.toDataURL()`) must draw and read in the same task (call
|
|
92
|
+
`renderer.render()`, then read), or create the renderer with
|
|
93
|
+
`preserveDrawingBuffer: true`. `await world.requestRender()` resolves after
|
|
94
|
+
the frame is presented, when the drawing buffer may already be cleared. See
|
|
95
|
+
the render loop API: `world.renderMode`, `world.requestRender(frames)` and
|
|
96
|
+
`world.holdRender()`.
|
package/dist/guidance/{claude/.claude → files/.agents}/skills/iwsdk-dev/references/iterate.md
RENAMED
|
@@ -87,11 +87,16 @@ the output bounded. The existing scaffold rules are already in context:
|
|
|
87
87
|
3. Implement the smallest complete vertical delta, including state/UI feedback
|
|
88
88
|
and recovery when the request needs them.
|
|
89
89
|
4. Run one batched typecheck and fix errors together.
|
|
90
|
-
5. Start the managed runtime directly
|
|
91
|
-
`npx @iwsdk/cli dev up --
|
|
90
|
+
5. Start the managed runtime directly in the mode AGENTS.md's session rule
|
|
91
|
+
picks: `npx @iwsdk/cli dev up --ai-mode agent --timeout 45000`, or
|
|
92
|
+
`--ai-mode collaborate` when the user is watching. Headless sessions draw
|
|
93
|
+
only when a tool needs pixels; read references/headless-rendering.md before
|
|
94
|
+
relying on frame rate, frame timing, or which frame a screenshot shows.
|
|
92
95
|
6. Exercise the changed path with real user input and query only the named state
|
|
93
96
|
needed to prove it. Direct ECS mutation may prepare/reset a scenario but is
|
|
94
|
-
not interaction proof.
|
|
97
|
+
not interaction proof. If the state you need to prepare lives in a plain
|
|
98
|
+
object outside ECS, move it into a component as part of the change rather
|
|
99
|
+
than editing constants temporarily or enabling browser automation.
|
|
95
100
|
7. Run one focused regression smoke for the preserved behavior most likely to
|
|
96
101
|
have been affected.
|
|
97
102
|
8. Run the production build and stop.
|
|
@@ -149,14 +154,18 @@ npx @iwsdk/cli xr run-sequence --input-json '{"device":"hand-right","steps":[{"t
|
|
|
149
154
|
npx @iwsdk/cli xr run-sequence --input-json '{"device":"hand-right","steps":[{"pinch":0,"duration":0.15}]}'
|
|
150
155
|
```
|
|
151
156
|
|
|
152
|
-
Query `Grabbed` between the grab and the release. A press result
|
|
153
|
-
|
|
154
|
-
|
|
157
|
+
Query `Grabbed` between the grab and the release. A press result reports
|
|
158
|
+
contact, not a click: confirm the click by the state it changes (`ui inspect`
|
|
159
|
+
on the control, or the app state it drives). A `presses[0].contactMs` of more
|
|
160
|
+
than 800 never clicks. A stalled frame can stretch a press that far, so run
|
|
161
|
+
that press once more before changing code. A control out of reach stretches it
|
|
162
|
+
too, because the body walks to it during the press: walk first, with
|
|
163
|
+
`{"body":{"stepTo":"Btn_Action"}}` as a step of its own, then press.
|
|
155
164
|
|
|
156
165
|
If a scene/source/UI edit happens after the managed runtime started and live
|
|
157
166
|
state becomes stale, do not call `scene open`, repeatedly poll `dev status`, or
|
|
158
167
|
loop on browser reload. Run one
|
|
159
|
-
`npx @iwsdk/cli dev restart --
|
|
168
|
+
`npx @iwsdk/cli dev restart --ai-mode <the session's current mode> --timeout 60000`, then resume the named-state
|
|
160
169
|
check. One failed restart may be diagnosed once; do not enter a recovery loop.
|
|
161
170
|
|
|
162
171
|
Do not perform a full product replay when the edit affects one bounded path.
|
package/dist/guidance/{claude/.claude → files/.agents}/skills/iwsdk-dev/references/planner.md
RENAMED
|
@@ -184,7 +184,9 @@ the same question.
|
|
|
184
184
|
Build the smallest structure that covers the whole contract:
|
|
185
185
|
|
|
186
186
|
1. native scene assets and deliberate hero/panel framing;
|
|
187
|
-
2. component schemas and explicit authored values
|
|
187
|
+
2. component schemas and explicit authored values, including game state such
|
|
188
|
+
as score, lives, phase and timers, so verification can jump to any state
|
|
189
|
+
with `ecs set-component` instead of playing there or scripting the page;
|
|
188
190
|
3. interaction/state systems;
|
|
189
191
|
4. UIKitML and runtime control wiring;
|
|
190
192
|
5. visible state feedback.
|
|
@@ -205,13 +207,15 @@ physics, deployment, and interactions with meaningful failure modes need
|
|
|
205
207
|
broader scenarios and stronger evidence.
|
|
206
208
|
|
|
207
209
|
After the coherent vertical slice typechecks, start one managed dev session
|
|
208
|
-
and keep it alive while iterating.
|
|
209
|
-
|
|
210
|
-
replacing
|
|
210
|
+
and keep it alive while iterating. Pick headed or headless with the session
|
|
211
|
+
rule in AGENTS.md (headless unless the user wants to watch) and announce a later
|
|
212
|
+
mode change before restarting rather than silently replacing a visible window. Do not start an untouched or
|
|
211
213
|
knowingly non-typechecking app. Exercise the real paths rather than inferring
|
|
212
214
|
behavior from code. Confirm `npx @iwsdk/cli xr status` is active before making pose,
|
|
213
215
|
controller/hand alignment, or immersive-interaction claims; a flat screenshot
|
|
214
|
-
outside XR cannot prove them.
|
|
216
|
+
outside XR cannot prove them. Headless sessions draw only when a tool needs
|
|
217
|
+
pixels; read references/headless-rendering.md before relying on frame rate,
|
|
218
|
+
frame timing, or which frame a screenshot shows.
|
|
215
219
|
|
|
216
220
|
Verify:
|
|
217
221
|
|
|
@@ -279,3 +279,4 @@ synthetic `fov: 90`. Keep using step 3 for framing.
|
|
|
279
279
|
- `[iwsdk][gaze]` console lines and other errors;
|
|
280
280
|
- for a headset run, its serial, which Quest mode was used, and whether the
|
|
281
281
|
page was paired.
|
|
282
|
+
<!-- iwsdk-agent-guidance version=1.2.0-rc.1 sha256=86e1e324dd71e8dd832b5d446e6bdc03bb5150cf5128c0650838cf6227b79817 name=iwsdk-glasses-test (installed by IWSDK; `npx @iwsdk/cli@latest agents sync` refreshes it and leaves it alone once edited) -->
|
|
@@ -72,3 +72,4 @@ to model context does not satisfy a requested file deliverable.
|
|
|
72
72
|
|
|
73
73
|
Stop once the requested grab/move/release path and final state are proven. Leave
|
|
74
74
|
the controller released and the XR session in the state the user requested.
|
|
75
|
+
<!-- iwsdk-agent-guidance version=1.2.0-rc.1 sha256=ad099acb82205620cb9cce44f245f40baf7e6808038d7d94ff9d873f316473d2 name=iwsdk-grab (installed by IWSDK; `npx @iwsdk/cli@latest agents sync` refreshes it and leaves it alone once edited) -->
|
|
@@ -174,4 +174,6 @@ trip:
|
|
|
174
174
|
| [`references/existing-hosts.md`](references/existing-hosts.md) | Route B — per-host publish recipes and their gotchas |
|
|
175
175
|
|
|
176
176
|
Packaging the hosted app into a signed Quest APK is the `iwsdk-pwa-packaging`
|
|
177
|
-
skill
|
|
177
|
+
skill, and keeping an offline copy on the device — with the `sw.js` cache
|
|
178
|
+
headers that copy needs — is `iwsdk-offline`. This skill only gets it online.
|
|
179
|
+
<!-- iwsdk-agent-guidance version=1.2.0-rc.1 sha256=360be8c5297e0b33bdbdf82188b95dbbcfc586b00d0c0840a21094eb9745e21d name=iwsdk-hosting (installed by IWSDK; `npx @iwsdk/cli@latest agents sync` refreshes it and leaves it alone once edited) -->
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: iwsdk-native-xr-test
|
|
3
|
-
description:
|
|
3
|
+
description: Drive an IWSDK app in a real Quest immersive session while you control headset and controller poses through the IWSDK CLI. Use when you will automate, script-test, or debug an app on a connected Quest. Not for the user trying the app by hand; native control takes over their head pose and controllers, so give them a plain dev session instead.
|
|
4
4
|
argument-hint: '[test scenario]'
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -14,6 +14,17 @@ override poses and input for the test.
|
|
|
14
14
|
|
|
15
15
|
The requested scenario is in `$ARGUMENTS`.
|
|
16
16
|
|
|
17
|
+
## Not for hands-on testing
|
|
18
|
+
|
|
19
|
+
Use this skill only when you drive the headset. If the user wants to put the
|
|
20
|
+
headset on and try the app themselves, do not start native control and do not
|
|
21
|
+
give them a pairing URL. A `--native-xr-control` session overrides the head pose
|
|
22
|
+
and controllers of every Quest Browser page it serves, even after the pairing
|
|
23
|
+
token is removed from the URL; the page shows an "Agent-controlled page"
|
|
24
|
+
notice saying so. Restart without the flag and hand over a plain URL as described in
|
|
25
|
+
AGENTS.md. If a native-control test is running when the user asks to try the
|
|
26
|
+
app, finish or stop it, clean up as in step 6, then do the same.
|
|
27
|
+
|
|
17
28
|
## Safety and scope
|
|
18
29
|
|
|
19
30
|
- Use only public Android platform tools and IWSDK commands. Do not depend on a
|
|
@@ -244,3 +255,8 @@ Report:
|
|
|
244
255
|
- before/after evidence for the requested behavior;
|
|
245
256
|
- console errors or capability notes;
|
|
246
257
|
- confirmation that the reverse route and dev session were removed.
|
|
258
|
+
|
|
259
|
+
If the user wants to try the app in the headset afterwards, start a plain
|
|
260
|
+
session (`npx @iwsdk/cli dev up` with the session's `--ai-mode`, without
|
|
261
|
+
`--native-xr-control`) and give them the plain URL from `dev status`.
|
|
262
|
+
<!-- iwsdk-agent-guidance version=1.2.0-rc.1 sha256=931a8822463f2bb6652cbbf2b7571db92e5331af44b598890057319b0177939b name=iwsdk-native-xr-test (installed by IWSDK; `npx @iwsdk/cli@latest agents sync` refreshes it and leaves it alone once edited) -->
|
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: iwsdk-offline
|
|
3
|
+
description: Make an IWSDK app run with no connection after one online visit — a service worker that keeps one hash-checked copy of the current release, downloads each file once, and swaps releases only when nothing would be interrupted. Use when the app must work offline or survive a dropped connection, when an installed PWA/TWA must launch without a network, or when an offline copy serves a stale release, misses files, or downloads everything twice.
|
|
4
|
+
argument-hint: '[offline goal, e.g. "work offline" or "launch offline from the Store"]'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Offline Copy
|
|
8
|
+
|
|
9
|
+
A built IWSDK app is a static `dist/`, so it can run with no connection once a
|
|
10
|
+
service worker holds a complete copy of it. This design keeps exactly one
|
|
11
|
+
release on the device: the build lists every file with its SHA-256, the worker
|
|
12
|
+
copies that list and answers from it cache-first, and the page alone decides
|
|
13
|
+
when the next release takes over. Each file crosses the wire once, nothing
|
|
14
|
+
unchecked is kept, and a release never swaps mid-session.
|
|
15
|
+
|
|
16
|
+
User request is in `$ARGUMENTS`.
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
1. Sort the files → release list, kept on request, or never cached
|
|
20
|
+
2. Copy the kit → build script, worker template, page module + build step
|
|
21
|
+
3. Adapt the worker → cache names and PINNED third-party paths
|
|
22
|
+
4. Wire the page → startOffline() and keepOfflineCopy() in src/index.ts
|
|
23
|
+
5. Hosting → sw.js uncached, hashed files immutable [iwsdk-hosting]
|
|
24
|
+
6. Verify → first visit, reload, offline, update, mid-session, two pages
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
The kit in `assets/` was tested end to end in Chromium against an IWSDK starter
|
|
28
|
+
build — first visit, reload, offline, update, and an update during an XR
|
|
29
|
+
session. Copy it verbatim and change only what steps 2–4 name; a rewrite loses
|
|
30
|
+
that.
|
|
31
|
+
|
|
32
|
+
## Step 1 — Sort the files
|
|
33
|
+
|
|
34
|
+
Ask of every file the build emits or the app fetches:
|
|
35
|
+
|
|
36
|
+
| Question | If yes |
|
|
37
|
+
| --- | --- |
|
|
38
|
+
| Does the build produce it, and does every user need it to run? | release list — copied at install |
|
|
39
|
+
| Do only some users need it (extra levels, other languages' fonts, HD packs)? | `ON_REQUEST` — kept the first time it is fetched |
|
|
40
|
+
| Is it a third-party file at a version named in its URL? | `PINNED` — kept in a long-lived cache on first fetch |
|
|
41
|
+
| Does the server decide it per user or per moment (APIs, sign-in, analytics, any non-GET)? | never cached |
|
|
42
|
+
|
|
43
|
+
What the user creates — saves, settings, progress — belongs in IndexedDB or
|
|
44
|
+
`localStorage`, never in the release cache, which is replaced on every update.
|
|
45
|
+
|
|
46
|
+
IWSDK and the starter fetch from other origins at runtime, and the kit's
|
|
47
|
+
`PINNED` already matches all three:
|
|
48
|
+
|
|
49
|
+
- **Controller models** —
|
|
50
|
+
`https://cdn.jsdelivr.net/npm/@webxr-input-profiles/assets@1.0/dist/profiles/<profile>/<handedness>.glb`.
|
|
51
|
+
The path is hard-coded, so the worker's cache is the only way to keep them
|
|
52
|
+
offline. `@1.0` is a release line, not one version; the worker keeps the
|
|
53
|
+
first copy it receives, and keeps the other hand's model with it.
|
|
54
|
+
- **Draco and KTX2 decoders** — `https://unpkg.com/three@0.<revision>.0/…`,
|
|
55
|
+
fetched only when the app loads compressed glTF files or KTX2 textures. Apps
|
|
56
|
+
cannot point IWSDK at self-hosted decoders.
|
|
57
|
+
|
|
58
|
+
- **Stock models** — the starter's `src/assets.ts` loads them from
|
|
59
|
+
`https://cdn.jsdelivr.net/npm/@iwsdk/example-assets@0.4.2/assets/…`. Mirroring
|
|
60
|
+
them under `public/` with `VITE_IWSDK_EXAMPLE_ASSET_BASE_URL` is better:
|
|
61
|
+
mirrored files become release files and are hash-checked like any other.
|
|
62
|
+
Then delete that path from `PINNED`.
|
|
63
|
+
|
|
64
|
+
## Step 2 — Copy the kit
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
kit="$(dirname "$(find .claude/skills .agents/skills -path '*/iwsdk-offline/assets/sw.js.template' -print -quit)")"
|
|
68
|
+
mkdir -p scripts
|
|
69
|
+
cp "$kit/write-service-worker.mjs.template" scripts/write-service-worker.mjs
|
|
70
|
+
cp "$kit/sw.js.template" scripts/sw.js.template
|
|
71
|
+
cp "$kit/offline.ts.template" src/offline.ts
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
In a JavaScript project, save the page module as `src/offline.js` and delete
|
|
75
|
+
its type annotations; nothing else changes. A TypeScript project needs the `.ts`
|
|
76
|
+
file: the scaffold's `tsconfig.json` has no `allowJs`. The worker keeps its
|
|
77
|
+
`.template` extension so Vite, `tsc`, and linters never touch its placeholders.
|
|
78
|
+
|
|
79
|
+
Make the build script the last step of `build` in `package.json`:
|
|
80
|
+
|
|
81
|
+
```json
|
|
82
|
+
"build": "vite build && node scripts/write-service-worker.mjs dist scripts/sw.js.template"
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Run it after `vite build`, never from a plugin's `closeBundle` hook: every
|
|
86
|
+
plugin must have finished writing, or a late file is missing from the list and
|
|
87
|
+
never kept. Its `LEFT_OUT` rules skip source maps (the starter emits them unless
|
|
88
|
+
`NODE_ENV=production`) and `AGENTS.md` (the scaffold keeps agent instructions in
|
|
89
|
+
`public/ui/` and `public/scenes/`, so Vite publishes them); add the app's own
|
|
90
|
+
`LEFT_OUT` and `ON_REQUEST` rules from step 1. Rules, hash signals, and a
|
|
91
|
+
duplicate finder: [`references/build-step.md`](references/build-step.md).
|
|
92
|
+
|
|
93
|
+
## Step 3 — Adapt the worker
|
|
94
|
+
|
|
95
|
+
In `scripts/sw.js.template`, change only:
|
|
96
|
+
|
|
97
|
+
- **`PREFIX`, `KEPT`, `HASH`** — rename for the app. `KEPT` must not start with
|
|
98
|
+
`PREFIX`, or the next activation deletes the third-party cache.
|
|
99
|
+
- **`PINNED`** — the kit pins `three@0.185.0` and `example-assets@0.4.2`, the
|
|
100
|
+
versions new projects get. Match `three@` to the project's `three` in
|
|
101
|
+
`package.json` (`super-three@0.181.0` → `three@0.181.0`) and
|
|
102
|
+
`example-assets@` to `src/assets.ts`, delete paths the app never loads, and
|
|
103
|
+
add any other third-party paths from step 1. If the app fetches nothing from
|
|
104
|
+
other origins, delete `PINNED`, `PAIRED`, `thirdParty()`, `keepPinned()`, and
|
|
105
|
+
`keepPair()`.
|
|
106
|
+
|
|
107
|
+
Never add `skipWaiting()` to `install` or `activate`, and never revalidate in
|
|
108
|
+
`fetch`: the page alone decides when a release takes over, and answers are
|
|
109
|
+
cache-first so that a page is exactly its release. The worker grants a
|
|
110
|
+
take-over only while the asking page is the app's only open page, because it
|
|
111
|
+
moves every open page onto the new release. Request routing, hash checks,
|
|
112
|
+
and updates: [`references/service-worker.md`](references/service-worker.md).
|
|
113
|
+
|
|
114
|
+
## Step 4 — Wire the page
|
|
115
|
+
|
|
116
|
+
In `src/index.ts`:
|
|
117
|
+
|
|
118
|
+
```ts
|
|
119
|
+
import { VisibilityState, World } from '@iwsdk/core';
|
|
120
|
+
import { checkIdle, keepOfflineCopy, startOffline } from './offline.js';
|
|
121
|
+
|
|
122
|
+
let world: World | undefined;
|
|
123
|
+
const isIdle = () =>
|
|
124
|
+
world?.visibilityState.peek() === VisibilityState.NonImmersive;
|
|
125
|
+
startOffline(isIdle); // before World.create()
|
|
126
|
+
|
|
127
|
+
World.create(container, projectOptions).then((created) => {
|
|
128
|
+
world = created;
|
|
129
|
+
// …system registration…
|
|
130
|
+
keepOfflineCopy(isIdle); // after the first screen, not at startup
|
|
131
|
+
created.visibilityState.subscribe(() => checkIdle()); // a session just ended
|
|
132
|
+
});
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
`isIdle()` must be `false` whenever a reload would interrupt anything: an XR
|
|
136
|
+
session (covered above), an unsaved edit, a game in progress. Call
|
|
137
|
+
`checkIdle()` whenever one of those ends, so a release that installed
|
|
138
|
+
meanwhile takes over then rather than at the next load. Registering only
|
|
139
|
+
once `World.create()` has resolved lets the worker take every file from the
|
|
140
|
+
HTTP cache instead of downloading it a second time. The reason for each line:
|
|
141
|
+
[`references/page.md`](references/page.md).
|
|
142
|
+
|
|
143
|
+
## Step 5 — Hosting
|
|
144
|
+
|
|
145
|
+
| Path | Header |
|
|
146
|
+
| --- | --- |
|
|
147
|
+
| `/sw.js` | `Cache-Control: no-cache` |
|
|
148
|
+
| `/assets/*` (Vite's hashed output) | `public, max-age=31536000, immutable` |
|
|
149
|
+
| Unhashed files: images, models, fonts, data | a short `max-age`, optionally `stale-while-revalidate` |
|
|
150
|
+
| HTML | `no-cache` or a short `max-age` |
|
|
151
|
+
| Every path, if a CSP is sent | `worker-src 'self'`, and a `connect-src` naming each `PINNED` path |
|
|
152
|
+
|
|
153
|
+
Serve `sw.js` from the root of the scope it controls; a worker cannot control
|
|
154
|
+
pages above its own folder. It needs a secure context — HTTPS, or
|
|
155
|
+
`http://localhost` for testing. On a host the developer owns, these headers are
|
|
156
|
+
part of the upload handoff, so take them through `iwsdk-hosting`. Then verify:
|
|
157
|
+
|
|
158
|
+
```bash
|
|
159
|
+
curl -sI https://<DOMAIN>/sw.js | grep -i '^cache-control' # want no-cache
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
The `vercel.json` headers for Vercel are in
|
|
163
|
+
[`references/service-worker.md`](references/service-worker.md).
|
|
164
|
+
|
|
165
|
+
## Step 6 — Verify
|
|
166
|
+
|
|
167
|
+
`npm run dev` serves no `sw.js`, so registration fails quietly there and proves
|
|
168
|
+
nothing — verify a production build. Six checks, each about what crosses the
|
|
169
|
+
wire:
|
|
170
|
+
|
|
171
|
+
1. **First visit** — the release cache holds every listed file, and no file was
|
|
172
|
+
sent in full twice.
|
|
173
|
+
2. **Reload** — the server is asked for nothing but `sw.js`.
|
|
174
|
+
3. **Offline** — with the network off, a reload starts the app and kept files
|
|
175
|
+
are served.
|
|
176
|
+
4. **Update while idle** — only the changed file downloads, the new release
|
|
177
|
+
takes over, and the old release cache is gone.
|
|
178
|
+
5. **Update mid-session** — the page is not reloaded during the session; when
|
|
179
|
+
it ends, the new release takes over.
|
|
180
|
+
6. **Two pages open** — an update takes over neither page; once one remains,
|
|
181
|
+
its next idle moment or load takes it.
|
|
182
|
+
|
|
183
|
+
The harness rules (logging server, no Playwright routes, persistent profile,
|
|
184
|
+
polling loops) and headset testing over `adb reverse`:
|
|
185
|
+
[`references/testing.md`](references/testing.md).
|
|
186
|
+
|
|
187
|
+
## Installed apps (PWA/TWA)
|
|
188
|
+
|
|
189
|
+
A packaged Quest app loads `<DOMAIN>` like any page, so the same copy serves it
|
|
190
|
+
offline — after **one online launch**, which is when the copy is made.
|
|
191
|
+
|
|
192
|
+
- `start_url` and `scope` in the manifest must sit inside the worker's scope;
|
|
193
|
+
`/sw.js` covers the whole origin. The worker ignores query strings, so
|
|
194
|
+
`"start_url": "/?source=pwa"` is served the cached `index.html`.
|
|
195
|
+
- The manifest and its icons live in `public/`, so they are in the release list.
|
|
196
|
+
- A web redeploy installs in the background during a launch and takes over when
|
|
197
|
+
the app is idle (no XR session), or on the launch after that — one launch later than without
|
|
198
|
+
the copy. Native changes still need a new APK.
|
|
199
|
+
- An immersive app that auto-enters XR (`iwsdk-pwa-packaging` step 1) spends the
|
|
200
|
+
launch tap on `world.launchXR()`. When a release is waiting, `startOffline()`
|
|
201
|
+
reloads the page at startup to take it, so verify on the headset that the
|
|
202
|
+
reloaded page still enters XR before shipping.
|
|
203
|
+
|
|
204
|
+
## Reference Files
|
|
205
|
+
|
|
206
|
+
| File | Load when |
|
|
207
|
+
| ---- | --------- |
|
|
208
|
+
| [`assets/`](assets/) | Step 2 — `write-service-worker.mjs.template`, `sw.js.template`, `offline.ts.template`; copy, never retype |
|
|
209
|
+
| [`references/build-step.md`](references/build-step.md) | Step 2 — `LEFT_OUT` and `ON_REQUEST`, hash signals, duplicate files |
|
|
210
|
+
| [`references/service-worker.md`](references/service-worker.md) | Step 3 — request routing, what to keep, hash checks, updates, Vercel headers |
|
|
211
|
+
| [`references/page.md`](references/page.md) | Step 4 — what each part of the page module does, and the wiring |
|
|
212
|
+
| [`references/testing.md`](references/testing.md) | Step 6 — the five checks, the harness, headset testing |
|
|
213
|
+
|
|
214
|
+
Publishing the build and its headers is the `iwsdk-hosting` skill, and packaging
|
|
215
|
+
it into a Quest APK is `iwsdk-pwa-packaging`. This skill only makes it work
|
|
216
|
+
offline.
|
|
217
|
+
<!-- iwsdk-agent-guidance version=1.2.0-rc.1 sha256=7f4f5034d84d6f0aaf3c353603e4d6d18eb99d107c5946ec018f8674e1001f38 name=iwsdk-offline (installed by IWSDK; `npx @iwsdk/cli@latest agents sync` refreshes it and leaves it alone once edited) -->
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
// src/offline.ts: the page's side. Call startOffline() first thing at startup, keepOfflineCopy()
|
|
9
|
+
// once the first screen is up, and checkIdle() whenever the app becomes idle (an XR session ends).
|
|
10
|
+
// isIdle() is your app's own test: would a reload now interrupt nothing?
|
|
11
|
+
|
|
12
|
+
export function startOffline(isIdle: () => boolean): void {
|
|
13
|
+
if (!('serviceWorker' in navigator)) return;
|
|
14
|
+
const hadCopy = navigator.serviceWorker.controller != null;
|
|
15
|
+
navigator.serviceWorker
|
|
16
|
+
.getRegistration()
|
|
17
|
+
.then((registration) => {
|
|
18
|
+
if (registration == null) return;
|
|
19
|
+
// A release that finished installing on an earlier visit takes over before anything starts.
|
|
20
|
+
if (registration.waiting != null && hadCopy)
|
|
21
|
+
takeOver(registration.waiting);
|
|
22
|
+
else watch(registration, isIdle);
|
|
23
|
+
})
|
|
24
|
+
.catch(() => {});
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export function keepOfflineCopy(isIdle: () => boolean): void {
|
|
28
|
+
if (!('serviceWorker' in navigator)) return;
|
|
29
|
+
navigator.serviceWorker
|
|
30
|
+
.register('./sw.js', { scope: './' })
|
|
31
|
+
.then((registration) => {
|
|
32
|
+
watch(registration, isIdle);
|
|
33
|
+
// Ask the browser not to evict the copy under storage pressure. It decides without a prompt.
|
|
34
|
+
navigator.storage?.persist?.().catch(() => {});
|
|
35
|
+
// Tell the worker what the page fetched before it took control, so it can keep optional files.
|
|
36
|
+
new PerformanceObserver((list) => {
|
|
37
|
+
const fetched = list.getEntries().map((entry) => entry.name);
|
|
38
|
+
navigator.serviceWorker.ready.then((ready) =>
|
|
39
|
+
ready.active?.postMessage({ fetched }),
|
|
40
|
+
);
|
|
41
|
+
}).observe({ type: 'resource', buffered: true });
|
|
42
|
+
})
|
|
43
|
+
.catch(() => {
|
|
44
|
+
// No offline copy (storage turned off, some private windows): the app still runs online.
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
// A release that installed while the app was busy waits; call this when the app becomes idle to
|
|
49
|
+
// let it take over now rather than at the next load.
|
|
50
|
+
export function checkIdle(): void {
|
|
51
|
+
retry?.();
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
const watched = new WeakSet<ServiceWorkerRegistration>();
|
|
55
|
+
let retry: (() => void) | undefined;
|
|
56
|
+
|
|
57
|
+
function watch(
|
|
58
|
+
registration: ServiceWorkerRegistration,
|
|
59
|
+
isIdle: () => boolean,
|
|
60
|
+
): void {
|
|
61
|
+
if (watched.has(registration)) return;
|
|
62
|
+
watched.add(registration);
|
|
63
|
+
const follow = (worker: ServiceWorker | null) => {
|
|
64
|
+
if (worker == null) return;
|
|
65
|
+
const settled = () => {
|
|
66
|
+
// Otherwise the release waits, and the next load takes it at startup.
|
|
67
|
+
if (
|
|
68
|
+
worker.state === 'installed' &&
|
|
69
|
+
navigator.serviceWorker.controller != null &&
|
|
70
|
+
isIdle()
|
|
71
|
+
) {
|
|
72
|
+
takeOver(worker);
|
|
73
|
+
}
|
|
74
|
+
};
|
|
75
|
+
if (worker.state === 'installed') settled();
|
|
76
|
+
else worker.addEventListener('statechange', settled);
|
|
77
|
+
};
|
|
78
|
+
retry = () => follow(registration.waiting);
|
|
79
|
+
follow(registration.waiting);
|
|
80
|
+
follow(registration.installing); // an update the navigation started before this script ran
|
|
81
|
+
registration.addEventListener('updatefound', () =>
|
|
82
|
+
follow(registration.installing),
|
|
83
|
+
);
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
let listening = false;
|
|
87
|
+
|
|
88
|
+
// The worker takes over only if this is the only page of the app open; asking again later is safe.
|
|
89
|
+
function takeOver(worker: ServiceWorker): void {
|
|
90
|
+
if (!listening) {
|
|
91
|
+
listening = true;
|
|
92
|
+
navigator.serviceWorker.addEventListener(
|
|
93
|
+
'controllerchange',
|
|
94
|
+
() => location.reload(),
|
|
95
|
+
{ once: true },
|
|
96
|
+
);
|
|
97
|
+
}
|
|
98
|
+
worker.postMessage('take-over');
|
|
99
|
+
}
|