sunpeak 0.3.7 โ†’ 0.3.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +23 -31
  2. package/package.json +1 -1
  3. package/template/README.md +2 -14
package/README.md CHANGED
@@ -17,9 +17,17 @@
17
17
 
18
18
  The ChatGPT Apps SDK.
19
19
 
20
- Build and test your ChatGPT App UI locally with OpenAI apps-sdk-ui React components.
20
+ Build and test your MCP App UI locally with OpenAI apps-sdk-ui React components.
21
21
 
22
- ![ChatGPT Simulator](https://sunpeak.ai/images/chatgpt-simulator.png)
22
+ [Documentation](https://docs.sunpeak.ai/)
23
+
24
+ <div align="center">
25
+ <a href="https://docs.sunpeak.ai/library/chatgpt-simulator">
26
+ <picture>
27
+ <img alt="ChatGPT Simulator" src="https://sunpeak.ai/images/chatgpt-simulator.png">
28
+ </picture>
29
+ </a>
30
+ </div>
23
31
 
24
32
  ## Quickstart
25
33
 
@@ -31,27 +39,14 @@ Requirements: Node (20+), pnpm (10+)
31
39
  pnpm dlx sunpeak new
32
40
  ```
33
41
 
34
- ### Existing Projects
35
-
36
- Requirements: React (18+), Tailwind 4
37
-
38
- ```bash
39
- pnpm add sunpeak
40
- ```
41
-
42
- When using `ChatGPTSimulator`, import the styles in your entry file:
43
-
44
- ```tsx
45
- import 'sunpeak/style.css';
46
- import { ChatGPTSimulator } from 'sunpeak';
47
- ```
42
+ To add sunpeak to an existing project, refer to the [documentation](https://docs.sunpeak.ai/add-to-existing-project).
48
43
 
49
44
  ## Key Features
50
- - ๐Ÿ“บ ChatGPT simulator for local UI component development.
51
- - ๐Ÿ“š Pre-built component library built on [openai/apps-sdk-ui](https://github.com/openai/apps-sdk-ui).
52
- - ๐Ÿ“ฑ Interface for cross-platforms MCP UI App development.
53
- - ๐Ÿ›œ Basic MCP server to serve your UI to ChatGPT prod out-of-the-box.
54
- - ๐Ÿงช Testing framework that replicates advanced ChatGPT behavior locally.
45
+ - ๐Ÿ“บ [ChatGPT simulator](https://docs.sunpeak.ai/library/chatgpt-simulator) for local UI component development.
46
+ - ๐Ÿ“š [Pre-built component library](https://docs.sunpeak.ai/template/ui-components) built on [openai/apps-sdk-ui](https://github.com/openai/apps-sdk-ui).
47
+ - ๐Ÿ“ฑ [Multi-platform interface](https://docs.sunpeak.ai/library/multi-platform-apis) for portable MCP UI App development.
48
+ - ๐Ÿ›œ [Basic MCP server](https://docs.sunpeak.ai/library/mcp-server) to serve your UI to ChatGPT prod out-of-the-box.
49
+ - ๐Ÿงช [Testing framework](https://docs.sunpeak.ai/guides/testing) that replicates advanced ChatGPT behavior locally.
55
50
 
56
51
  ## Example Component
57
52
  ```tsx
@@ -74,21 +69,18 @@ export default function App() {
74
69
  }
75
70
  ```
76
71
 
77
- ## Supported Platforms
78
-
79
- - โœ… **OpenAI ChatGPT** - Fully supported ([design guidelines](https://developers.openai.com/apps-sdk/concepts/design-guidelines))
80
- - ๐Ÿ”„ **Google Gemini** - Design system available (SDK support coming soon)
81
- - ๐Ÿ”„ **Anthropic Claude** - Design system available (SDK support coming soon)
82
- - ๐Ÿ”ง **Custom platforms** - Implement your own platform adapter
83
-
84
72
  ## What is sunpeak exactly?
85
73
 
86
74
  sunpeak is an npm package consisting of:
87
75
 
88
76
  1. **A CLI utility** for working with sunpeak (`./bin`).
89
- 2. **A `sunpeak` library** (`./src`). This library contains common runtime APIs and testing utilities, including a ChatGPT simulator, to be used as a dependency by sunpeak projects.
90
- 3. **A templated npm package** (`./template`) that is initialized by the CLI to help developers set up sunpeak projects. These projects have the `sunpeak` dependency already wired up alongside a collection of pre-built UI components (`./template/src/components`) to copy, modify, or use as an example.
91
- 1. Developers build their UI in the `App` component.
77
+ 2. **A templated npm package** (`./template`). This template includes:
78
+ 1. Project scaffold - Complete development setup with build, test, and dev tooling.
79
+ 2. Pre-built UI components - Production-ready components following ChatGPT design guidelines.
80
+ 3. **The `sunpeak` library** (`./src`). This library contains:
81
+ 1. Multi-platform APIs - Abstraction layer for future platform support (Gemini, Claude).
82
+ 2. ChatGPT simulator - Local development environment replicating ChatGPT's widget runtime.
83
+ 3. MCP server - View local widgets in the real ChatGPT.
92
84
 
93
85
  ## Contributing
94
86
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sunpeak",
3
- "version": "0.3.7",
3
+ "version": "0.3.8",
4
4
  "description": "The ChatGPT Apps UI SDK. Build and test your ChatGPT App UI locally with OpenAI apps-sdk-ui components.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
package/template/README.md CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  A ChatGPT App UI built with [sunpeak](https://github.com/Sunpeak-AI/sunpeak).
4
4
 
5
+ For an initial overview of your new app and the sunpeak API, refer to the [documentation](https://docs.sunpeak.ai/template/project-structure).
6
+
5
7
  ## Quickstart
6
8
 
7
9
  ```bash
@@ -12,20 +14,6 @@ Edit [src/App.tsx](./src/App.tsx) to build your app UI.
12
14
 
13
15
  ## Development
14
16
 
15
- ### Initial Project Structure
16
-
17
- ```
18
- src/
19
- โ”œโ”€โ”€ App.tsx # Your main app component
20
- โ””โ”€โ”€ components/ # Your React components
21
-
22
- mcp/
23
- โ””โ”€โ”€ server.ts # MCP server for testing in ChatGPT
24
-
25
- dist/ # Build output (generated)
26
- โ””โ”€โ”€ chatgpt/ # ChatGPT builds
27
- ```
28
-
29
17
  ## Testing
30
18
 
31
19
  ### Testing Locally