Releases: Sunpeak-AI/sunpeak
Release list
v0.18.2
v0.18.1
Simulator → Inspector
Everything named "Simulator" is now "Inspector":
| v0.17 | v0.18 |
|---|---|
import { Inspector } from 'sunpeak/simulator' |
import { Inspector } from 'sunpeak/inspector' |
createSimulatorUrl() |
createInspectorUrl() |
SimulatorUrlParams |
InspectorUrlParams |
SimulatorProps |
InspectorProps |
SimulatorConfig |
InspectorConfig |
useSimulatorState() |
useInspectorState() |
hideSimulatorModes prop |
hideInspectorModes |
CSS .sunpeak-simulator-root |
.sunpeak-inspector-root |
import { simulator } from 'sunpeak' |
import { inspector } from 'sunpeak' |
Removed deprecated APIs
| Removed | Replacement |
|---|---|
sunpeak/simulator export path |
sunpeak/inspector |
sunpeak/platform export path |
sunpeak/host |
sunpeak/platform/chatgpt export path |
sunpeak/host/chatgpt |
sunpeak/chatgpt/globals.css |
sunpeak/style.css |
detectPlatform() |
detectHost() |
Platform type |
Host type |
useGetFileDownloadUrl() |
useDownloadFile() from sunpeak |
?prodTools=true URL param |
?tool=X (without ?simulation=) |
Upgrade
sunpeak upgradeThen find-and-replace:
sunpeak/simulator→sunpeak/inspectorcreateSimulatorUrl→createInspectorUrlSimulator→Inspector(component)detectPlatform→detectHostsunpeak/platform→sunpeak/hostsunpeak/chatgpt/globals.css→sunpeak/style.cssuseGetFileDownloadUrl→useDownloadFile(fromsunpeakinstead ofsunpeak/host/chatgpt)
What's Changed
Full Changelog: v0.17.7...v0.18.1
v0.17.7
v0.17.6
v0.17.5
v0.17.4
v0.17.3
v0.17.2
v0.17.1
sunpeak's best-in-class MCP App inspector and testing engine now works with any arbitrary MCP server, not only sunpeak projects!
Breaking Changes in v0.17.0
1. Removed exports from sunpeak/simulator and sunpeak/chatgpt
The following functions and types have been deleted and are no longer available:
| Removed export | Type |
|---|---|
buildDevSimulations |
function |
buildSimulations |
function |
buildResourceMap |
function |
createResourceExports |
function |
BuildSimulationsOptions |
type |
BuildDevSimulationsOptions |
type |
ResourceMetadata |
type |
These were previously importable from sunpeak, sunpeak/simulator, or sunpeak/chatgpt. They are no longer needed because sunpeak dev now discovers tools/resources/simulations via MCP protocol instead of Vite globs.
2. Deleted template files
If you scaffolded a project with sunpeak new, these files in your project are now dead code and should be deleted:
.sunpeak/dev.tsx.sunpeak/resource-loader.html.sunpeak/resource-loader.tsxindex.html(root)src/resources/index.ts
3. Tool annotations are now explicit
Tool files should specify all three annotation hints explicitly:
- annotations: { readOnlyHint: true },
+ annotations: { readOnlyHint: true, destructiveHint: false, openWorldHint: false },This is non-breaking at runtime but your tests may fail if they assert on annotations.
Upgrade Instructions
-
Update sunpeak:
pnpm update sunpeak@^0.17.0
-
Delete obsolete files from your project root:
rm -rf .sunpeak/ index.html src/resources/index.ts
-
Remove dead imports — if you imported any of the removed functions (
buildDevSimulations,buildSimulations,buildResourceMap,createResourceExports), delete those imports. They are no longer needed;sunpeak devhandles simulation discovery automatically via MCP. -
Update tool annotations — add explicit
destructiveHintandopenWorldHintto each tool'sannotationsobject and update any test assertions accordingly. -
Run validation:
pnpm validate
Full Changelog: v0.16.30...v0.17.1