@iwsdk/cli 1.1.0 → 1.2.0-rc.0
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 +79 -2
- package/dist/agent-adapters.d.ts +12 -1
- package/dist/agent-adapters.d.ts.map +1 -1
- package/dist/agent-guidance/files/.agents/skills/iwsdk-build-model/SKILL.md +312 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-build-model/agents/openai.yaml +4 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-build-model/assets/hardsurface.ts.template +599 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-compose-scene/SKILL.md +277 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-compose-scene/agents/openai.yaml +4 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-compose-scene/references/environment-recipes.md +234 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-compose-scene/references/extended-workflow.md +166 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-compose-scene/references/image-intake.md +190 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-compose-scene/references/scene-composition.md +80 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-compose-scene/references/scene-format.md +466 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-compose-scene/references/scene-review.md +66 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-compose-scene/references/text-intake.md +80 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-debug/SKILL.md +74 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-depth-occlusion/SKILL.md +88 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-dev/SKILL.md +46 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-dev/references/api-reference.md +1531 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-dev/references/headless-rendering.md +82 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-dev/references/iterate.md +263 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-dev/references/planner.md +307 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-glasses-test/SKILL.md +282 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-grab/SKILL.md +75 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-hosting/SKILL.md +178 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-hosting/references/existing-hosts.md +181 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-hosting/references/vercel.md +114 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-native-xr-test/SKILL.md +262 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-physics/SKILL.md +106 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-physics/references/component-reference.md +152 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-physics/references/tuning-and-config.md +101 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-physics/references/workflows.md +303 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-pwa-packaging/SKILL.md +219 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-pwa-packaging/references/app-modes.md +104 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-pwa-packaging/references/bubblewrap.md +219 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-pwa-packaging/references/manifest-and-icons.md +149 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-pwa-packaging/references/store-upload.md +104 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-pwa-packaging/references/troubleshooting.md +178 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-ray/SKILL.md +70 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-ui/SKILL.md +328 -0
- package/dist/agent-guidance/files/.agents/skills/iwsdk-upgrade/SKILL.md +74 -0
- package/dist/agent-guidance/files/.claude/agents/iwsdk-project-code-reviewer.md +521 -0
- package/dist/agent-guidance/files/.claude/rules/assets-and-manifest.md +60 -0
- package/dist/agent-guidance/files/.claude/rules/ecs-api.md +103 -0
- package/dist/agent-guidance/files/.claude/rules/scene-json.md +72 -0
- package/dist/agent-guidance/files/.claude/rules/uikitml.md +66 -0
- package/dist/agent-guidance/files/.claude/settings.json +29 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-build-model/SKILL.md +312 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-build-model/agents/openai.yaml +4 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-build-model/assets/hardsurface.ts.template +599 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-compose-scene/SKILL.md +277 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-compose-scene/agents/openai.yaml +4 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-compose-scene/references/environment-recipes.md +234 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-compose-scene/references/extended-workflow.md +166 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-compose-scene/references/image-intake.md +190 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-compose-scene/references/scene-composition.md +80 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-compose-scene/references/scene-format.md +466 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-compose-scene/references/scene-review.md +66 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-compose-scene/references/text-intake.md +80 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-debug/SKILL.md +74 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-depth-occlusion/SKILL.md +88 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-dev/SKILL.md +46 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-dev/references/api-reference.md +1531 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-dev/references/headless-rendering.md +82 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-dev/references/iterate.md +263 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-dev/references/planner.md +307 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-glasses-test/SKILL.md +282 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-grab/SKILL.md +75 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-hosting/SKILL.md +178 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-hosting/references/existing-hosts.md +181 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-hosting/references/vercel.md +114 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-native-xr-test/SKILL.md +262 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-physics/SKILL.md +106 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-physics/references/component-reference.md +152 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-physics/references/tuning-and-config.md +101 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-physics/references/workflows.md +303 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-pwa-packaging/SKILL.md +219 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-pwa-packaging/references/app-modes.md +104 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-pwa-packaging/references/bubblewrap.md +219 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-pwa-packaging/references/manifest-and-icons.md +149 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-pwa-packaging/references/store-upload.md +104 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-pwa-packaging/references/troubleshooting.md +178 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-ray/SKILL.md +70 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-ui/SKILL.md +328 -0
- package/dist/agent-guidance/files/.claude/skills/iwsdk-upgrade/SKILL.md +74 -0
- package/dist/agent-guidance/files/.cursor/rules/assets-and-manifest.mdc +62 -0
- package/dist/agent-guidance/files/.cursor/rules/ecs-api.mdc +105 -0
- package/dist/agent-guidance/files/.cursor/rules/scene-json.mdc +74 -0
- package/dist/agent-guidance/files/.cursor/rules/uikitml.mdc +68 -0
- package/dist/agent-guidance/files/.github/instructions/assets-and-manifest.instructions.md +55 -0
- package/dist/agent-guidance/files/.github/instructions/ecs-api.instructions.md +101 -0
- package/dist/agent-guidance/files/.github/instructions/scene-json.instructions.md +71 -0
- package/dist/agent-guidance/files/.github/instructions/uikitml.instructions.md +65 -0
- package/{guidance → dist/agent-guidance/files}/AGENTS.md +107 -27
- package/dist/agent-guidance/files/CLAUDE.md +3 -0
- package/dist/agent-guidance/files/public/scenes/AGENTS.md +72 -0
- package/dist/agent-guidance/files/public/ui/AGENTS.md +66 -0
- package/dist/agent-guidance/files/src/AGENTS.md +153 -0
- package/dist/agent-guidance/manifest.json +854 -0
- package/dist/agent-guidance.d.ts +113 -0
- package/dist/agent-guidance.d.ts.map +1 -0
- package/dist/agent-guidance.js +3403 -0
- package/dist/agent-guidance.js.map +1 -0
- package/dist/cli.js +2407 -144
- package/dist/cli.js.map +1 -1
- package/dist/commands/adapter.d.ts +1 -0
- package/dist/commands/adapter.d.ts.map +1 -1
- package/dist/commands/agents.d.ts +11 -0
- package/dist/commands/agents.d.ts.map +1 -0
- package/dist/commands/browser.d.ts +11 -0
- package/dist/commands/browser.d.ts.map +1 -1
- package/dist/commands/dev.d.ts +1 -0
- package/dist/commands/dev.d.ts.map +1 -1
- package/dist/commands/reference.d.ts +15 -1
- package/dist/commands/reference.d.ts.map +1 -1
- package/dist/commands/runtime.d.ts.map +1 -1
- package/dist/commands/upgrade.d.ts +51 -0
- package/dist/commands/upgrade.d.ts.map +1 -0
- package/dist/contract.js +32 -0
- package/dist/contract.js.map +1 -1
- package/dist/guidance-refresh.d.ts +33 -0
- package/dist/guidance-refresh.d.ts.map +1 -0
- package/dist/help.d.ts +2 -0
- package/dist/help.d.ts.map +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4744 -135
- package/dist/index.js.map +1 -1
- package/dist/mcp-stdio.d.ts.map +1 -1
- package/dist/migrations/iwsdk-migrate-0-5/SKILL.md +413 -0
- package/dist/migrations.d.ts +36 -0
- package/dist/migrations.d.ts.map +1 -0
- package/dist/package-manager.d.ts +28 -0
- package/dist/package-manager.d.ts.map +1 -0
- package/dist/release-notes.d.ts +28 -0
- package/dist/release-notes.d.ts.map +1 -0
- package/dist/release-notes.json +1374 -0
- package/dist/runtime-contract.d.ts +8 -0
- package/dist/runtime-contract.d.ts.map +1 -1
- package/dist/runtime-telemetry.d.ts +8 -1
- package/dist/runtime-telemetry.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/package.json +9 -3
package/dist/mcp-stdio.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mcp-stdio.d.ts","sourceRoot":"","sources":["../src/mcp-stdio.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAQH,OAAO,EAKL,KAAK,cAAc,EACpB,MAAM,uBAAuB,CAAC;AAiB/B,MAAM,WAAW,iCAAiC;IAChD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;CACtD;AAoND,wBAAsB,0BAA0B,CAAC,EAC/C,UAAoB,EACpB,OAAqB,EACrB,cAAc,GACf,EAAE,iCAAiC,GAAG,OAAO,CAAC,IAAI,CAAC,
|
|
1
|
+
{"version":3,"file":"mcp-stdio.d.ts","sourceRoot":"","sources":["../src/mcp-stdio.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAQH,OAAO,EAKL,KAAK,cAAc,EACpB,MAAM,uBAAuB,CAAC;AAiB/B,MAAM,WAAW,iCAAiC;IAChD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;CACtD;AAoND,wBAAsB,0BAA0B,CAAC,EAC/C,UAAoB,EACpB,OAAqB,EACrB,cAAc,GACf,EAAE,iCAAiC,GAAG,OAAO,CAAC,IAAI,CAAC,CAyLnD"}
|
|
@@ -0,0 +1,413 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: iwsdk-migrate-0-5
|
|
3
|
+
description: Migrate an existing IWSDK 0.4.x application to IWSDK 0.5.0. Use when upgrading across the 0.5 boundary, replacing Meta Spatial Editor or GLXF, removing retired Vite plugins, moving UIKitML to runtime-loaded assets, adopting native scene JSON, or resolving 0.5 migration errors.
|
|
4
|
+
argument-hint: '[project path or migration problem]'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Migrate IWSDK 0.4.x to 0.5.0
|
|
8
|
+
|
|
9
|
+
Upgrade an existing IWSDK application without losing behavior or authored
|
|
10
|
+
content. This is a migration, not a rewrite: preserve working runtime logic,
|
|
11
|
+
move only static composition into the native scene format, and prove parity in
|
|
12
|
+
the live runtime.
|
|
13
|
+
|
|
14
|
+
User context is in `$ARGUMENTS`.
|
|
15
|
+
|
|
16
|
+
## Scope
|
|
17
|
+
|
|
18
|
+
This skill is specifically for `0.4.x -> 0.5.0`. First inspect the installed
|
|
19
|
+
versions in `package.json` and the lockfile.
|
|
20
|
+
|
|
21
|
+
- If the project is already on `0.5.x`, diagnose the reported issue without
|
|
22
|
+
replaying the migration.
|
|
23
|
+
- If it is older than `0.4.x`, apply the intervening release migrations first.
|
|
24
|
+
- If it is newer than `0.5.x`, use the skill for that release boundary instead.
|
|
25
|
+
|
|
26
|
+
The public comparison baseline for this guide is IWSDK `0.4.2`.
|
|
27
|
+
|
|
28
|
+
## Non-negotiable safety rules
|
|
29
|
+
|
|
30
|
+
1. Inspect `git status` before editing. Preserve all existing work; never reset,
|
|
31
|
+
clean, or overwrite unrelated changes.
|
|
32
|
+
2. Create a recoverable checkpoint before transforming GLXF, scene files, or UI
|
|
33
|
+
sources. Use the project's established version-control workflow; do not
|
|
34
|
+
commit unless the user authorized commits.
|
|
35
|
+
3. Inventory the app before deleting a package. A package is removable only
|
|
36
|
+
after all of its imports, config hooks, scripts, and generated outputs have
|
|
37
|
+
been replaced.
|
|
38
|
+
4. Do not claim that a GLXF or Meta Spatial scene was migrated merely because
|
|
39
|
+
the app compiles. IWSDK 0.5 has no GLXF runtime fallback; reproduce and
|
|
40
|
+
verify the authored hierarchy in native scene JSON.
|
|
41
|
+
5. Keep dynamic behavior in TypeScript/JavaScript. Native scenes own static
|
|
42
|
+
composition, component values, transforms, lights, panels, and player-space
|
|
43
|
+
attachments—not runtime-dependent entity counts or game logic.
|
|
44
|
+
|
|
45
|
+
## Release boundary at a glance
|
|
46
|
+
|
|
47
|
+
| 0.4.x surface | 0.5.0 replacement |
|
|
48
|
+
| -------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
|
49
|
+
| GLXF levels and `@iwsdk/glxf` | Native scene selected by `iwsdk.config.json` (or explicit low-level `WorldOptions.level`) |
|
|
50
|
+
| Meta Spatial Editor and `@iwsdk/vite-plugin-metaspatial` | IWSDK managed editor in `@iwsdk/vite-plugin-dev` |
|
|
51
|
+
| `@iwsdk/vite-plugin-uikitml` generated JSON | Runtime parsing of source `.uikitml` files from `public/ui/` |
|
|
52
|
+
| `@iwsdk/vite-plugin-gltf-optimizer` | Pre-optimized source assets or the normal IWSDK glTF asset pipeline |
|
|
53
|
+
| `vite-plugin-mkcert` | Cached, untrusted HTTPS certificate generated by `iwsdkDev()` |
|
|
54
|
+
| `PanelUI.config: './ui/panel.json'` | UIKitML manifest asset using a `BASE_URL`-safe source `.uikitml` URL |
|
|
55
|
+
| `PanelUI.maxWidth` / `maxHeight` | Entity transform scale plus the document's intrinsic dimensions |
|
|
56
|
+
| `features.spatialUI.kits` | `features.spatialUI.kit` and optional `componentSets` |
|
|
57
|
+
| `GLXFComponentRegistry` | `defineComponents([...])` plus native scene component props |
|
|
58
|
+
| `LevelGLXFImporter` / `LevelEntityCreator` | `World.loadLevel()` for native scenes / `World.createTransformEntity()` for dynamic objects |
|
|
59
|
+
| `iwsdkDev({ assetManifest, componentManifest, emulator })` | `iwsdk.config.json` plus bare `iwsdkDev()` |
|
|
60
|
+
| `iwsdkDev({ ai, workspace })` | Launch-time `iwsdk dev up` session flags |
|
|
61
|
+
| Remote Chef starter recipes / `@iwsdk/starter-assets` | Common source, scenes, and guidance embedded in `@iwsdk/create` |
|
|
62
|
+
| `xr.features.lightEstimation` | Authored light components and `IBLTexture`/`IBLGradient` |
|
|
63
|
+
| `render.defaultLighting` and implicit gradients | Explicit dome and IBL components on each native scene root |
|
|
64
|
+
| Static entities created in the startup callback | Asset/component manifests plus native scene nodes |
|
|
65
|
+
| Ad hoc custom-component registration | `defineComponents([...])`, shared by runtime and editor |
|
|
66
|
+
|
|
67
|
+
The `Interactable` compatibility alias still exists, but new and migrated code
|
|
68
|
+
should use `RayInteractable`.
|
|
69
|
+
|
|
70
|
+
## Phase 1: Inventory before editing
|
|
71
|
+
|
|
72
|
+
Determine the package manager from the lockfile, then collect:
|
|
73
|
+
|
|
74
|
+
- every `@iwsdk/*` dependency and its installed version;
|
|
75
|
+
- every import or config call involving `glxf`, `metaspatial`, `compileUIKit`,
|
|
76
|
+
`vite-plugin-uikitml`, `vite-plugin-gltf-optimizer`, `mkcert`, or
|
|
77
|
+
`IWSDK_DISABLE_MKCERT`;
|
|
78
|
+
- every `World.create`, `World.loadLevel`, `PanelUI`, `ScreenSpace`,
|
|
79
|
+
`Visibility`, `render.defaultLighting`, and `features.spatialUI` use;
|
|
80
|
+
- all `.glxf`, `.uikitml`, generated UI JSON, Meta Spatial project files, and
|
|
81
|
+
generated glTF folders;
|
|
82
|
+
- static entity creation in startup code and the systems that later locate or
|
|
83
|
+
manipulate those entities.
|
|
84
|
+
|
|
85
|
+
Classify each static object as one of:
|
|
86
|
+
|
|
87
|
+
- `asset`: glTF, UIKitML, or a parentless procedural `Object3D` prototype;
|
|
88
|
+
- `scene node`: a stable id, transform, asset reference, and component values;
|
|
89
|
+
- `player-space child`: content attached to player, camera/head, target-ray, or
|
|
90
|
+
grip space;
|
|
91
|
+
- `dynamic`: keep in code because runtime state determines its existence.
|
|
92
|
+
|
|
93
|
+
Record the inventory in the migration report. This is the parity checklist.
|
|
94
|
+
|
|
95
|
+
## Phase 2: Align packages
|
|
96
|
+
|
|
97
|
+
Update every IWSDK package already used by the application to `0.5.0`. Keep
|
|
98
|
+
IWSDK packages on one version; do not mix `0.4.x` and `0.5.x` packages.
|
|
99
|
+
|
|
100
|
+
Remove these retired packages when present:
|
|
101
|
+
|
|
102
|
+
```text
|
|
103
|
+
@iwsdk/glxf
|
|
104
|
+
@iwsdk/vite-plugin-gltf-optimizer
|
|
105
|
+
@iwsdk/vite-plugin-metaspatial
|
|
106
|
+
@iwsdk/vite-plugin-uikitml
|
|
107
|
+
vite-plugin-mkcert
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Do not add `@iwsdk/scene-composition` merely because it is new. It is already a
|
|
111
|
+
core dependency; add it directly only if application code imports its document,
|
|
112
|
+
validation, or composition APIs.
|
|
113
|
+
|
|
114
|
+
After editing `package.json`, use the project's package manager to update the
|
|
115
|
+
lockfile and installation. Do not delete the lockfile as a shortcut.
|
|
116
|
+
|
|
117
|
+
## Phase 3: Simplify Vite configuration
|
|
118
|
+
|
|
119
|
+
Remove imports and plugin entries for mkcert, Meta Spatial, UIKitML compilation,
|
|
120
|
+
and the glTF optimizer. A migrated config should follow this shape:
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
import { iwsdkDev } from '@iwsdk/vite-plugin-dev';
|
|
124
|
+
import { defineConfig } from 'vite';
|
|
125
|
+
|
|
126
|
+
export default defineConfig({
|
|
127
|
+
plugins: [iwsdkDev()],
|
|
128
|
+
server: { host: '0.0.0.0', open: false },
|
|
129
|
+
});
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Important behavior:
|
|
133
|
+
|
|
134
|
+
- Create `iwsdk.config.json` as the committed project authority. It selects the
|
|
135
|
+
scene plus extensionless `assets.module` and `components.module` paths and
|
|
136
|
+
stores serializable world/emulator options.
|
|
137
|
+
- Manifest-first dev servers always expose the managed editor. Choose AI mode,
|
|
138
|
+
headed/headless launch, open behavior, and screenshot size with `iwsdk dev`
|
|
139
|
+
flags rather than committed Vite options.
|
|
140
|
+
- The managed browser is the browser surface. Keep Vite `server.open` false so
|
|
141
|
+
it does not create a second unmanaged tab.
|
|
142
|
+
- HTTPS is on by default. IWSDK caches an untrusted certificate without
|
|
143
|
+
installing a local CA. Managed Playwright accepts it automatically; a
|
|
144
|
+
physical headset shows the expected certificate warning.
|
|
145
|
+
- Use `iwsdkDev({ https: false })` only when HTTP is intentional. A custom
|
|
146
|
+
`server.https` certificate takes precedence.
|
|
147
|
+
- Keep asset and component modules free of system imports and side effects so
|
|
148
|
+
the editor can load them in its own realm.
|
|
149
|
+
|
|
150
|
+
Remove obsolete generated-output ignore rules only after confirming nothing
|
|
151
|
+
else creates those directories. Common stale paths are generated UIKit JSON,
|
|
152
|
+
Meta Spatial GLXF output, and plugin-generated glTF folders.
|
|
153
|
+
|
|
154
|
+
## Phase 4: Create shared manifests
|
|
155
|
+
|
|
156
|
+
Move the asset catalog into a dedicated module:
|
|
157
|
+
|
|
158
|
+
```ts
|
|
159
|
+
// src/assets.ts
|
|
160
|
+
import { AssetType, defineAssets } from '@iwsdk/core';
|
|
161
|
+
|
|
162
|
+
const publicAssetUrl = (path: string) =>
|
|
163
|
+
`${import.meta.env.BASE_URL}${path.replace(/^\/+/u, '')}`;
|
|
164
|
+
|
|
165
|
+
export default defineAssets({
|
|
166
|
+
environment: {
|
|
167
|
+
name: 'Environment',
|
|
168
|
+
type: AssetType.GLTF,
|
|
169
|
+
url: publicAssetUrl('models/environment.glb'),
|
|
170
|
+
},
|
|
171
|
+
'settings-panel': {
|
|
172
|
+
name: 'Settings Panel',
|
|
173
|
+
type: AssetType.UIKitML,
|
|
174
|
+
url: publicAssetUrl('ui/settings.uikitml'),
|
|
175
|
+
},
|
|
176
|
+
});
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
An asset manifest may also contain parentless procedural `Object3D` prototypes.
|
|
180
|
+
Do not place a prototype in the Three scene or parent it before registration.
|
|
181
|
+
|
|
182
|
+
Declare application components separately:
|
|
183
|
+
|
|
184
|
+
```ts
|
|
185
|
+
// src/components.ts
|
|
186
|
+
import { defineComponents } from '@iwsdk/core';
|
|
187
|
+
import { MyBehavior } from './components/my-behavior.js';
|
|
188
|
+
|
|
189
|
+
export default defineComponents([MyBehavior]);
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
Point the project authority at both extensionless modules:
|
|
193
|
+
|
|
194
|
+
```json
|
|
195
|
+
{
|
|
196
|
+
"$schema": "./node_modules/@iwsdk/core/dist/schemas/iwsdk-project.v1.schema.json",
|
|
197
|
+
"version": "iwsdk.project.v1",
|
|
198
|
+
"scene": "./public/scenes/main.iwsdk.scene.json",
|
|
199
|
+
"assets": { "module": "./src/assets" },
|
|
200
|
+
"components": { "module": "./src/components" },
|
|
201
|
+
"world": {
|
|
202
|
+
"xr": { "mode": "vr", "offer": "always" },
|
|
203
|
+
"features": { "spatialUI": true }
|
|
204
|
+
},
|
|
205
|
+
"dev": { "emulator": { "device": "metaQuest3" } }
|
|
206
|
+
}
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
The Vite virtual module supplies the same exact exports to `World.create()`:
|
|
210
|
+
|
|
211
|
+
```ts
|
|
212
|
+
import { World } from '@iwsdk/core';
|
|
213
|
+
import projectOptions from 'virtual:iwsdk-project';
|
|
214
|
+
|
|
215
|
+
const world = await World.create(container, projectOptions);
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
Do not also import the manifests into `index.ts` or configure them in
|
|
219
|
+
`iwsdkDev()`. `iwsdk.config.json` is the single runtime/editor authority.
|
|
220
|
+
|
|
221
|
+
Delete GLXF registry setup and field mappers. Native scene component objects
|
|
222
|
+
store ordinary props keyed by the component id, and the shared component
|
|
223
|
+
manifest supplies their schemas to both runtime and editor.
|
|
224
|
+
|
|
225
|
+
## Phase 5: Replace GLXF or code-authored static layout
|
|
226
|
+
|
|
227
|
+
Create `public/scenes/main.iwsdk.scene.json`. A minimal asset-backed panel and
|
|
228
|
+
model look like this:
|
|
229
|
+
|
|
230
|
+
```json
|
|
231
|
+
{
|
|
232
|
+
"version": "iwsdk.scene.v1",
|
|
233
|
+
"units": "meters",
|
|
234
|
+
"components": {},
|
|
235
|
+
"resources": {},
|
|
236
|
+
"nodes": [
|
|
237
|
+
{
|
|
238
|
+
"id": "environment",
|
|
239
|
+
"content": { "type": "asset", "asset": "environment" },
|
|
240
|
+
"transform": { "position": [0, 0, 0] },
|
|
241
|
+
"components": { "LocomotionEnvironment": {} }
|
|
242
|
+
},
|
|
243
|
+
{
|
|
244
|
+
"id": "settings-panel",
|
|
245
|
+
"content": { "type": "asset", "asset": "settings-panel" },
|
|
246
|
+
"transform": {
|
|
247
|
+
"position": [0, 1.5, -2],
|
|
248
|
+
"scale": 0.4
|
|
249
|
+
},
|
|
250
|
+
"components": {
|
|
251
|
+
"RayInteractable": {},
|
|
252
|
+
"ScreenSpace": {
|
|
253
|
+
"top": "20px",
|
|
254
|
+
"left": "20px",
|
|
255
|
+
"width": "25vw",
|
|
256
|
+
"height": "40vh"
|
|
257
|
+
}
|
|
258
|
+
}
|
|
259
|
+
}
|
|
260
|
+
]
|
|
261
|
+
}
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
Migration rules:
|
|
265
|
+
|
|
266
|
+
- Node `id` is the stable runtime/editor identity. Preserve meaningful unique
|
|
267
|
+
identifiers and use them from code; do not locate authored objects by array
|
|
268
|
+
position or display name.
|
|
269
|
+
- Scene asset references must resolve in `src/assets.ts`.
|
|
270
|
+
- Move static component values into the scene. Keep systems and event logic in
|
|
271
|
+
code.
|
|
272
|
+
- Preserve hierarchy with `children`. Use a node `parent` of type
|
|
273
|
+
`player-space` for content attached to `player`, `camera`, `head`, target-ray,
|
|
274
|
+
or grip spaces.
|
|
275
|
+
- Author the player origin under the top-level `player.transform`. Tracked
|
|
276
|
+
head/controller transforms are runtime-owned and overridden by XR tracking.
|
|
277
|
+
- Use `visible: false` for authored initial visibility. Visibility and
|
|
278
|
+
Transform are intrinsic editor properties, not ordinary add-component UI.
|
|
279
|
+
- Put fog, tone mapping, exposure, and shadow renderer settings under the scene
|
|
280
|
+
`environment` object. Use `DomeGradient`/`DomeTexture` for the visible
|
|
281
|
+
background and `IBLGradient`/`IBLTexture` for image-based lighting. There is
|
|
282
|
+
no separate AR background policy; immersive AR remains transparent.
|
|
283
|
+
- Remove `render.defaultLighting`. IWSDK no longer injects either environment
|
|
284
|
+
component. Author both gradient components for the former default look, or
|
|
285
|
+
omit either independently when the scene intentionally has no background or
|
|
286
|
+
no image-based lighting.
|
|
287
|
+
- Use IWSDK light components on scene nodes for authored ambient,
|
|
288
|
+
hemisphere, directional, point, spot, or rect-area lights.
|
|
289
|
+
|
|
290
|
+
There is no supported 0.5 runtime path for `.glxf`. For a Meta Spatial/GLXF
|
|
291
|
+
project, use the old scene and screenshots as the visual reference, recreate
|
|
292
|
+
its static hierarchy in native scene JSON, then compare multiple editor and
|
|
293
|
+
runtime views before deleting legacy sources. If parity cannot be established,
|
|
294
|
+
stop and report that migration as incomplete.
|
|
295
|
+
|
|
296
|
+
Code-created dynamic entities can stay in code. It is valid to migrate the
|
|
297
|
+
static shell first and leave gameplay spawning, effects, and variable-count
|
|
298
|
+
objects in systems.
|
|
299
|
+
|
|
300
|
+
## Phase 6: Migrate UIKitML
|
|
301
|
+
|
|
302
|
+
Move source UIKitML files into `public/ui/` and delete the generated intermediate
|
|
303
|
+
JSON once no code references it. Change panel URLs from `.json` to `.uikitml`.
|
|
304
|
+
|
|
305
|
+
For editor-authored panels, prefer an `AssetType.UIKitML` manifest entry and an
|
|
306
|
+
asset-backed scene node, as shown above. `PanelUI` remains a compatibility path
|
|
307
|
+
for code-created panels, but it is hidden from generic editor authoring.
|
|
308
|
+
|
|
309
|
+
Remove `maxWidth` and `maxHeight` from `PanelUI`; 0.5 no longer performs a
|
|
310
|
+
second fit. The UIKitML document owns intrinsic dimensions and the entity
|
|
311
|
+
transform owns world scale. Give `ScreenSpace` explicit CSS dimensions rather
|
|
312
|
+
than relying on `auto`.
|
|
313
|
+
|
|
314
|
+
Replace spatial-UI kit configuration:
|
|
315
|
+
|
|
316
|
+
```ts
|
|
317
|
+
features: {
|
|
318
|
+
spatialUI: {
|
|
319
|
+
kit: 'horizon',
|
|
320
|
+
componentSets: [],
|
|
321
|
+
},
|
|
322
|
+
}
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
The default kit is `horizon`. UIKitML can load TTF fonts declared with
|
|
326
|
+
`@font-face`, including remote HTTPS URLs. Keep font loading CORS-compatible and
|
|
327
|
+
verify text after the document reports stable layout; do not add arbitrary
|
|
328
|
+
frame-count sleeps.
|
|
329
|
+
|
|
330
|
+
Locate and manipulate an authored panel by stable scene and element ids:
|
|
331
|
+
|
|
332
|
+
```ts
|
|
333
|
+
import { UIKitMLAsset } from '@iwsdk/core';
|
|
334
|
+
|
|
335
|
+
const panel = world.requireSceneObject<UIKitMLAsset>('settings-panel');
|
|
336
|
+
const saveButton = panel.requireElementById('save-button');
|
|
337
|
+
saveButton.addEventListener('click', onSave);
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
Do not traverse the entire Three scene looking for an anonymous
|
|
341
|
+
`UIKitDocument`, and do not key logic off generated JSON paths.
|
|
342
|
+
|
|
343
|
+
## Phase 7: Resolve behavior-level compatibility
|
|
344
|
+
|
|
345
|
+
Audit these cases even when TypeScript compiles:
|
|
346
|
+
|
|
347
|
+
- `createTransformEntity()` now gives every transform entity intrinsic
|
|
348
|
+
`Visibility`. If old code adds `Visibility` itself, change it to set the
|
|
349
|
+
existing value or assign `entity.object3D.visible`.
|
|
350
|
+
- Prefer `RayInteractable` over the deprecated `Interactable` alias.
|
|
351
|
+
- Remove `xr.features.lightEstimation`; IWSDK 0.5 no longer requests the
|
|
352
|
+
unsupported feature. Replace its visual role with authored lights and IBL.
|
|
353
|
+
- Immersive AR always hides authored dome/background visuals for passthrough
|
|
354
|
+
while retaining IBL. Re-test any app that previously expected a virtual AR
|
|
355
|
+
background.
|
|
356
|
+
- `AssetManager.getGLTF()` returns a fresh clone by default. Use
|
|
357
|
+
`{ shared: true }` only when shared mutable state is intentional.
|
|
358
|
+
- `ScreenSpace` `width`/`height: 'auto'` warns and falls back to viewport
|
|
359
|
+
sizing. Author explicit dimensions and test browser resize plus XR exit.
|
|
360
|
+
- If custom UIKitML components were passed through `kits`, migrate them to
|
|
361
|
+
`componentSets`; select the built-in collection with `kit`.
|
|
362
|
+
- If systems stored references to startup-created objects, replace static
|
|
363
|
+
object plumbing with `world.getSceneObject`, `requireSceneObject`,
|
|
364
|
+
`getSceneEntity`, or `requireSceneEntity` and stable node ids.
|
|
365
|
+
- Preserve cleanup functions for signal/query subscriptions and DOM/UIKit
|
|
366
|
+
listeners. `World.destroy()` is now available for hot reload, tests, and
|
|
367
|
+
multi-world hosts.
|
|
368
|
+
|
|
369
|
+
## Phase 8: Verify in increasing scope
|
|
370
|
+
|
|
371
|
+
Run the project's normal formatter, typecheck, tests, and production build.
|
|
372
|
+
Then verify the actual app:
|
|
373
|
+
|
|
374
|
+
1. Start the 0.5 dev server and wait for `npx @iwsdk/cli dev status --json` to report
|
|
375
|
+
`browserConnected: true` and `browserCommandReady: true`.
|
|
376
|
+
2. Validate and open every native scene. Fix missing manifest assets,
|
|
377
|
+
components, entity references, and file paths.
|
|
378
|
+
3. In Editor view, compare hierarchy, transforms, visibility, authored lights,
|
|
379
|
+
panels, player-space children, and representative camera views with the
|
|
380
|
+
pre-migration inventory.
|
|
381
|
+
4. In Runtime view, test every interaction and inspect console logs. Browser
|
|
382
|
+
screenshots are runtime-only by design.
|
|
383
|
+
5. Enter and exit XR through both the application UI and the emulator/session
|
|
384
|
+
controls. Confirm screen-space panels return after XR exit.
|
|
385
|
+
6. Resize the desktop window and verify UIKit layout, clipping, fonts, rounded
|
|
386
|
+
corners, and perceived scale.
|
|
387
|
+
7. If a physical headset is available, open the reported HTTPS network URL,
|
|
388
|
+
accept its self-signed-certificate warning, and enter XR.
|
|
389
|
+
8. Run a production build from a clean install using the committed lockfile.
|
|
390
|
+
|
|
391
|
+
Do not regenerate IWSDK's library reference corpus as part of an application
|
|
392
|
+
migration.
|
|
393
|
+
|
|
394
|
+
## Completion report
|
|
395
|
+
|
|
396
|
+
Return a concise report containing:
|
|
397
|
+
|
|
398
|
+
- detected source and target versions;
|
|
399
|
+
- package additions/removals;
|
|
400
|
+
- old GLXF/Meta Spatial/UIKit generated artifacts retained or deleted;
|
|
401
|
+
- scene, asset, component, and UIKitML files migrated;
|
|
402
|
+
- behavior changes made for compatibility;
|
|
403
|
+
- exact automated and live tests run;
|
|
404
|
+
- any visual or physical-headset checks still requiring a human;
|
|
405
|
+
- any unresolved parity gap that prevents calling the migration complete.
|
|
406
|
+
|
|
407
|
+
## Optional 0.5 modernization (not required for parity)
|
|
408
|
+
|
|
409
|
+
After migration is green, consider these additions separately: signal helpers
|
|
410
|
+
re-exported from `@iwsdk/core`, authored light components, raw XR frame/session
|
|
411
|
+
and hit-test helpers, `World.destroy()`, `World.loadSceneDocument()`, renderable
|
|
412
|
+
asset instantiation, player-space authoring, and managed scene review tools.
|
|
413
|
+
Do not mix these refactors into the compatibility pass unless the user asks.
|
|
@@ -0,0 +1,36 @@
|
|
|
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
|
+
* Migration skills for releases that need more than a version bump. They ship
|
|
9
|
+
* with the CLI rather than as project skills: `npx @iwsdk/cli@latest upgrade`
|
|
10
|
+
* carries every guide the newest release knows about, even for a project whose
|
|
11
|
+
* installed IWSDK predates the guide. The CLI build copies each guide from
|
|
12
|
+
* docs/public/skills/<id>/SKILL.md, which iwsdk.dev also serves.
|
|
13
|
+
*/
|
|
14
|
+
export interface MigrationGuide {
|
|
15
|
+
id: string;
|
|
16
|
+
/** First release that needs the migration. */
|
|
17
|
+
introducedIn: string;
|
|
18
|
+
summary: string;
|
|
19
|
+
}
|
|
20
|
+
export declare const MIGRATION_GUIDES: MigrationGuide[];
|
|
21
|
+
export interface MaterializedMigration extends MigrationGuide {
|
|
22
|
+
/** Project-relative path of the written guide. */
|
|
23
|
+
path: string;
|
|
24
|
+
}
|
|
25
|
+
/** Guides for every release boundary in (from, to], oldest first. */
|
|
26
|
+
export declare function migrationsBetween(from: string | null, to: string): MigrationGuide[];
|
|
27
|
+
/**
|
|
28
|
+
* Write the guides into the project's ignored .iwsdk/ directory, where an
|
|
29
|
+
* agent can read them during the upgrade without them becoming project skills
|
|
30
|
+
* that trigger long after it.
|
|
31
|
+
*/
|
|
32
|
+
export declare function materializeMigrations(projectRoot: string, guides: MigrationGuide[]): Promise<MaterializedMigration[]>;
|
|
33
|
+
/** Add .iwsdk/ to the project's .gitignore unless it is already there. */
|
|
34
|
+
export declare function ensureIwsdkDirectoryIgnored(projectRoot: string): Promise<void>;
|
|
35
|
+
export declare function formatMigrationNotice(from: string | null, to: string, migrations: MaterializedMigration[]): string;
|
|
36
|
+
//# sourceMappingURL=migrations.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"migrations.d.ts","sourceRoot":"","sources":["../src/migrations.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAQH;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,8CAA8C;IAC9C,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,eAAO,MAAM,gBAAgB,EAAE,cAAc,EAO5C,CAAC;AAEF,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAC3D,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAC;CACd;AAID,qEAAqE;AACrE,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,EACnB,EAAE,EAAE,MAAM,GACT,cAAc,EAAE,CAelB;AAWD;;;;GAIG;AACH,wBAAsB,qBAAqB,CACzC,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,cAAc,EAAE,GACvB,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAalC;AAED,0EAA0E;AAC1E,wBAAsB,2BAA2B,CAC/C,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,IAAI,CAAC,CAaf;AAED,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,GAAG,IAAI,EACnB,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,qBAAqB,EAAE,GAClC,MAAM,CAWR"}
|
|
@@ -0,0 +1,28 @@
|
|
|
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
|
+
export type PackageManagerName = 'npm' | 'pnpm' | 'yarn' | 'bun';
|
|
8
|
+
export interface PackageManagerInfo {
|
|
9
|
+
name: PackageManagerName;
|
|
10
|
+
/** Where the lockfile or workspace lives; the project itself when alone. */
|
|
11
|
+
root: string;
|
|
12
|
+
/** The lockfile found at `root`, if any. */
|
|
13
|
+
lockfile: string | null;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* The package manager a project uses: the nearest lockfile at or above it, so
|
|
17
|
+
* an app inside a monorepo uses the monorepo's tool and lockfile, with the
|
|
18
|
+
* nearest `packageManager` field taking precedence. Without a lockfile, the
|
|
19
|
+
* field or a pnpm workspace decides. Stops at the repository root.
|
|
20
|
+
*/
|
|
21
|
+
export declare function findPackageManager(projectRoot: string): PackageManagerInfo;
|
|
22
|
+
/**
|
|
23
|
+
* The @iwsdk/core version the lockfile resolves for this project, or null
|
|
24
|
+
* when there is no lockfile this can read. Handles workspace lockfiles, where
|
|
25
|
+
* the project is one importer among several.
|
|
26
|
+
*/
|
|
27
|
+
export declare function readLockedCoreVersion(projectRoot: string): string | null;
|
|
28
|
+
//# sourceMappingURL=package-manager.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"package-manager.d.ts","sourceRoot":"","sources":["../src/package-manager.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,MAAM,MAAM,kBAAkB,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC;AAEjE,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,kBAAkB,CAAC;IACzB,4EAA4E;IAC5E,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAoFD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,kBAAkB,CAiC1E;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAuExE"}
|
|
@@ -0,0 +1,28 @@
|
|
|
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
|
+
* Changelog entries of the release group, built into dist/release-notes.json
|
|
9
|
+
* by scripts/build-release-notes.mjs. `iwsdk upgrade` writes the entries
|
|
10
|
+
* between two versions where the agent doing the upgrade can read them.
|
|
11
|
+
*/
|
|
12
|
+
export interface ReleaseNote {
|
|
13
|
+
version: string;
|
|
14
|
+
kind: 'major' | 'minor' | 'patch';
|
|
15
|
+
packages: string[];
|
|
16
|
+
text: string;
|
|
17
|
+
}
|
|
18
|
+
export interface WrittenReleaseNotes {
|
|
19
|
+
path: string;
|
|
20
|
+
count: number;
|
|
21
|
+
/** Major and minor entries: the ones that can need app changes. */
|
|
22
|
+
notable: number;
|
|
23
|
+
}
|
|
24
|
+
/** Entries for every release in (from, to], oldest first. */
|
|
25
|
+
export declare function releaseNotesBetween(from: string | null, to: string, notes?: ReleaseNote[]): ReleaseNote[];
|
|
26
|
+
export declare function writeReleaseNotes(projectRoot: string, from: string | null, to: string): Promise<WrittenReleaseNotes | null>;
|
|
27
|
+
export declare function formatReleaseNotesNotice(from: string | null, to: string, written: WrittenReleaseNotes | null): string;
|
|
28
|
+
//# sourceMappingURL=release-notes.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"release-notes.d.ts","sourceRoot":"","sources":["../src/release-notes.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AASH;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;IAClC,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,mEAAmE;IACnE,OAAO,EAAE,MAAM,CAAC;CACjB;AAqBD,6DAA6D;AAC7D,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,MAAM,GAAG,IAAI,EACnB,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,WAAW,EAAuB,GACxC,WAAW,EAAE,CAiBf;AA0BD,wBAAsB,iBAAiB,CACrC,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,MAAM,GAAG,IAAI,EACnB,EAAE,EAAE,MAAM,GACT,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAcrC;AAED,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,MAAM,GAAG,IAAI,EACnB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,mBAAmB,GAAG,IAAI,GAClC,MAAM,CAIR"}
|