sunpeak 0.1.19 โ 0.1.22
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/LICENSE +21 -0
- package/README.md +12 -19
- package/package.json +8 -8
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Sunpeak AI
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -14,17 +14,19 @@ React library for cross-platform genAI App UIs. Supports **OpenAI ChatGPT Apps**
|
|
|
14
14
|
**Key Features:**
|
|
15
15
|
- ๐บ ChatGPT simulator for rapid UI component development.
|
|
16
16
|
- ๐ฑ Interface for cross-platform custom components.
|
|
17
|
-
- ๐ค [
|
|
17
|
+
- ๐ค [Material UI](https://mui.com/material-ui/)-based components compliant with the OpenAI design system.
|
|
18
18
|
- ๐ Library of approved Apps.
|
|
19
19
|
- ๐งช Testing framework that replicates advanced platform behavior locally.
|
|
20
20
|
|
|
21
|
-
##
|
|
21
|
+
## Quickstart
|
|
22
22
|
|
|
23
|
-
Requirements: Node 20
|
|
23
|
+
Requirements: Node (20+), pnpm (10+)
|
|
24
|
+
|
|
25
|
+
Use our `create-sunpeak` utility to scaffold your own sunpeak app:
|
|
24
26
|
|
|
25
27
|
```bash
|
|
26
|
-
|
|
27
|
-
pnpm dev
|
|
28
|
+
pnpm dlx create-sunpeak my-app
|
|
29
|
+
cd my-app && pnpm dev
|
|
28
30
|
```
|
|
29
31
|
|
|
30
32
|
## Building Apps
|
|
@@ -77,10 +79,6 @@ export const MyApp = GenAI(({ maxHeight, colorScheme }) => (
|
|
|
77
79
|
- ๐ **Anthropic Claude** - Design system available (SDK support coming soon)
|
|
78
80
|
- ๐ง **Custom platforms** - Implement your own platform adapter
|
|
79
81
|
|
|
80
|
-
### Platform Auto-Detection
|
|
81
|
-
|
|
82
|
-
Sunpeak automatically detects the active platform. No configuration needed for basic usage!
|
|
83
|
-
|
|
84
82
|
## What's Included
|
|
85
83
|
|
|
86
84
|
### Components
|
|
@@ -89,7 +87,7 @@ Sunpeak automatically detects the active platform. No configuration needed for b
|
|
|
89
87
|
- Platform constraints (maxHeight)
|
|
90
88
|
- **Card** - Responsive card component
|
|
91
89
|
- **Carousel** - Horizontal scrolling carousel
|
|
92
|
-
- **ChatGPTSimulator** - Local development environment
|
|
90
|
+
- **ChatGPTSimulator** - Local development & testing environment
|
|
93
91
|
|
|
94
92
|
### Hooks
|
|
95
93
|
- **usePlatformGlobal** - Platform-agnostic global state access
|
|
@@ -102,20 +100,15 @@ Sunpeak automatically detects the active platform. No configuration needed for b
|
|
|
102
100
|
|
|
103
101
|
### Design Systems
|
|
104
102
|
- **ChatGPT** - MUI theme following OpenAI Apps SDK guidelines
|
|
105
|
-
- **Custom** - Build your own MUI theme
|
|
103
|
+
- **Custom** - Build your own MUI theme
|
|
106
104
|
|
|
107
|
-
|
|
105
|
+
## Contributing
|
|
108
106
|
|
|
109
|
-
|
|
107
|
+
We welcome your contributions!
|
|
110
108
|
|
|
111
|
-
|
|
109
|
+
For development quickstart on this package, see [DEVELOPMENT.md](./DEVELOPMENT.md).
|
|
112
110
|
|
|
113
111
|
## Resources
|
|
114
112
|
|
|
115
113
|
- [OpenAI ChatGPT Apps SDK Design Guidelines](https://developers.openai.com/apps-sdk/concepts/design-guidelines)
|
|
116
114
|
- [OpenAI ChatGPT Apps SDK Examples](https://github.com/openai/openai-apps-sdk-examples)
|
|
117
|
-
- [Theming Guide](./THEMING.md)
|
|
118
|
-
|
|
119
|
-
## License
|
|
120
|
-
|
|
121
|
-
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "sunpeak",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.22",
|
|
4
4
|
"description": "React library for cross-platform genAI App UIs.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -25,15 +25,15 @@
|
|
|
25
25
|
],
|
|
26
26
|
"sideEffects": false,
|
|
27
27
|
"keywords": [
|
|
28
|
+
"openai-app",
|
|
29
|
+
"chatgpt-app",
|
|
30
|
+
"chatgpt-simulator",
|
|
31
|
+
"testing",
|
|
32
|
+
"multi-platform",
|
|
28
33
|
"react",
|
|
29
34
|
"components",
|
|
30
|
-
"ui",
|
|
31
|
-
"
|
|
32
|
-
"openai-apps-sdk",
|
|
33
|
-
"chatgpt",
|
|
34
|
-
"chatgpt-apps",
|
|
35
|
-
"apps-sdk",
|
|
36
|
-
"multi-platform"
|
|
35
|
+
"material-ui",
|
|
36
|
+
"sunpeak"
|
|
37
37
|
],
|
|
38
38
|
"author": "Sunpeak AI",
|
|
39
39
|
"license": "MIT",
|