create-skybridge 0.0.0-dev.c367eac → 0.0.0-dev.c36b199
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/dist/index.js +449 -165
- package/package.json +9 -8
- package/templates/blank/.dockerignore +4 -0
- package/templates/blank/AGENTS.md +1 -0
- package/templates/blank/Dockerfile +53 -0
- package/templates/blank/README.md +93 -0
- package/templates/blank/_gitignore +7 -0
- package/templates/blank/alpic.json +3 -0
- package/templates/blank/node_modules/.bin/alpic +21 -0
- package/templates/blank/node_modules/.bin/sb +21 -0
- package/templates/blank/node_modules/.bin/skybridge +21 -0
- package/templates/blank/node_modules/.bin/tsc +21 -0
- package/templates/blank/node_modules/.bin/tsserver +21 -0
- package/templates/blank/node_modules/.bin/tsx +21 -0
- package/templates/blank/node_modules/.bin/vite +21 -0
- package/templates/blank/package.json +30 -0
- package/templates/blank/src/helpers.ts +4 -0
- package/templates/blank/src/index.ts +3 -0
- package/templates/blank/src/server.ts +12 -0
- package/templates/blank/tsconfig.json +5 -0
- package/templates/blank/vite.config.ts +12 -0
- package/templates/demo/.dockerignore +4 -0
- package/templates/demo/AGENTS.md +1 -0
- package/templates/demo/Dockerfile +53 -0
- package/templates/demo/README.md +97 -0
- package/templates/demo/_gitignore +7 -0
- package/templates/demo/alpic.json +3 -0
- package/templates/demo/evals/start.eval.ts +11 -0
- package/templates/demo/node_modules/.bin/alpic +21 -0
- package/templates/demo/node_modules/.bin/sb +21 -0
- package/templates/demo/node_modules/.bin/skybridge +21 -0
- package/templates/demo/node_modules/.bin/tsc +21 -0
- package/templates/demo/node_modules/.bin/tsserver +21 -0
- package/templates/demo/node_modules/.bin/tsx +21 -0
- package/templates/demo/node_modules/.bin/vite +21 -0
- package/templates/demo/node_modules/.bin/vitest +21 -0
- package/templates/demo/package.json +47 -0
- package/templates/demo/src/helpers.ts +4 -0
- package/templates/demo/src/index.css +59 -0
- package/templates/demo/src/index.ts +3 -0
- package/templates/demo/src/server.ts +92 -0
- package/templates/demo/src/views/components/doc-link.tsx +22 -0
- package/templates/demo/src/views/components/doc.tsx +21 -0
- package/templates/demo/src/views/components/nav.tsx +31 -0
- package/templates/demo/src/views/components/progress.tsx +35 -0
- package/templates/demo/src/views/components/steps/outro.tsx +68 -0
- package/templates/demo/src/views/components/steps/state.tsx +47 -0
- package/templates/demo/src/views/components/steps/tool-call.tsx +53 -0
- package/templates/demo/src/views/components/steps/tool-output.tsx +40 -0
- package/templates/demo/src/views/images/mascot/beret.png +0 -0
- package/templates/demo/src/views/images/mascot/chapka.png +0 -0
- package/templates/demo/src/views/images/mascot/cowboy-hat.png +0 -0
- package/templates/demo/src/views/images/mascot/fez.png +0 -0
- package/templates/demo/src/views/images/mascot/jester-hat.png +0 -0
- package/templates/demo/src/views/images/mascot/mitre.png +0 -0
- package/templates/demo/src/views/images/mascot/non-la.png +0 -0
- package/templates/demo/src/views/images/mascot/original.png +0 -0
- package/templates/demo/src/views/images/mascot/propeller-beanie.png +0 -0
- package/templates/demo/src/views/images/mascot/ski-mask.png +0 -0
- package/templates/demo/src/views/images/mascot/sombrero.png +0 -0
- package/templates/demo/src/views/images/mascot/top-hat.png +0 -0
- package/templates/demo/src/views/images/mascot/viking-helmet.png +0 -0
- package/templates/demo/src/views/onboarding.tsx +63 -0
- package/templates/demo/src/views/use-mascot.ts +60 -0
- package/templates/demo/tsconfig.evals.json +11 -0
- package/templates/demo/tsconfig.json +11 -0
- package/templates/demo/vite.config.ts +20 -0
- package/templates/ecom/.dockerignore +4 -0
- package/templates/ecom/.env.template +7 -0
- package/templates/ecom/.ladle/components.tsx +26 -0
- package/templates/ecom/.ladle/config.mjs +11 -0
- package/templates/ecom/.ladle/vite.config.ts +11 -0
- package/templates/ecom/AGENTS.md +2 -0
- package/templates/ecom/Dockerfile +53 -0
- package/templates/ecom/README.md +93 -0
- package/templates/ecom/_gitignore +9 -0
- package/templates/ecom/alpic.json +3 -0
- package/templates/ecom/node_modules/.bin/alpic +21 -0
- package/templates/ecom/node_modules/.bin/ladle +21 -0
- package/templates/ecom/node_modules/.bin/sb +21 -0
- package/templates/ecom/node_modules/.bin/skybridge +21 -0
- package/templates/ecom/node_modules/.bin/tsc +21 -0
- package/templates/ecom/node_modules/.bin/tsserver +21 -0
- package/templates/ecom/node_modules/.bin/tsx +21 -0
- package/templates/ecom/node_modules/.bin/vite +21 -0
- package/templates/ecom/package.json +42 -0
- package/templates/ecom/src/catalog/index.ts +19 -0
- package/templates/ecom/src/catalog/mock.ts +134 -0
- package/templates/ecom/src/catalog/shopify.ts +264 -0
- package/templates/ecom/src/components/chip.css.ts +63 -0
- package/templates/ecom/src/components/chip.stories.tsx +27 -0
- package/templates/ecom/src/components/chip.tsx +49 -0
- package/templates/ecom/src/components/empty-state.stories.tsx +3 -0
- package/templates/ecom/src/components/empty-state.tsx +12 -0
- package/templates/ecom/src/components/expandable-text.css.ts +49 -0
- package/templates/ecom/src/components/expandable-text.stories.tsx +20 -0
- package/templates/ecom/src/components/expandable-text.tsx +53 -0
- package/templates/ecom/src/components/image-gallery.css.ts +172 -0
- package/templates/ecom/src/components/image-gallery.stories.tsx +30 -0
- package/templates/ecom/src/components/image-gallery.tsx +163 -0
- package/templates/ecom/src/components/product-card.css.ts +159 -0
- package/templates/ecom/src/components/product-card.stories.tsx +58 -0
- package/templates/ecom/src/components/product-card.tsx +102 -0
- package/templates/ecom/src/components/product-carousel.css.ts +134 -0
- package/templates/ecom/src/components/product-carousel.stories.tsx +64 -0
- package/templates/ecom/src/components/product-carousel.tsx +202 -0
- package/templates/ecom/src/components/variant-picker.css.ts +27 -0
- package/templates/ecom/src/components/variant-picker.stories.tsx +67 -0
- package/templates/ecom/src/components/variant-picker.tsx +70 -0
- package/templates/ecom/src/components/view-frame.css.ts +22 -0
- package/templates/ecom/src/components/view-frame.tsx +27 -0
- package/templates/ecom/src/config.ts +12 -0
- package/templates/ecom/src/design/contract.css.ts +39 -0
- package/templates/ecom/src/design/fonts.css +15 -0
- package/templates/ecom/src/design/primitives.css.ts +101 -0
- package/templates/ecom/src/design/recipes/typography.css.ts +75 -0
- package/templates/ecom/src/design/sprinkles.css.ts +128 -0
- package/templates/ecom/src/design/themes/dark.css.ts +36 -0
- package/templates/ecom/src/design/themes/light.css.ts +36 -0
- package/templates/ecom/src/design/tokens.ts +8 -0
- package/templates/ecom/src/helpers.ts +4 -0
- package/templates/ecom/src/i18n.ts +35 -0
- package/templates/ecom/src/index.css +9 -0
- package/templates/ecom/src/index.ts +3 -0
- package/templates/ecom/src/lib/cx.ts +9 -0
- package/templates/ecom/src/lib/format.ts +9 -0
- package/templates/ecom/src/lib/variants.ts +150 -0
- package/templates/ecom/src/server.ts +39 -0
- package/templates/ecom/src/tools/render-carousel.ts +161 -0
- package/templates/ecom/src/tools/search-products.ts +196 -0
- package/templates/ecom/src/types.ts +87 -0
- package/templates/ecom/src/views/carousel/detail/detail.css.ts +115 -0
- package/templates/ecom/src/views/carousel/detail/detail.stories.tsx +133 -0
- package/templates/ecom/src/views/carousel/detail/index.tsx +254 -0
- package/templates/ecom/src/views/carousel/index.tsx +233 -0
- package/templates/ecom/tsconfig.json +11 -0
- package/templates/ecom/vite.config.ts +8 -0
- package/dist/index.test.d.ts +0 -1
- package/dist/index.test.js +0 -23
- package/template/README.md +0 -66
- package/template/_gitignore +0 -4
- package/template/alpic.json +0 -4
- package/template/package.json +0 -21
- package/template/pnpm-workspace.yaml +0 -7
- package/template/server/nodemon.json +0 -5
- package/template/server/package.json +0 -32
- package/template/server/src/index.ts +0 -36
- package/template/server/src/middleware.ts +0 -54
- package/template/server/src/server.ts +0 -66
- package/template/server/tsconfig.json +0 -17
- package/template/web/package.json +0 -24
- package/template/web/src/helpers.ts +0 -4
- package/template/web/src/index.css +0 -30
- package/template/web/src/widgets/magic-8-ball.tsx +0 -24
- package/template/web/tsconfig.app.json +0 -34
- package/template/web/tsconfig.json +0 -13
- package/template/web/tsconfig.node.json +0 -26
- package/template/web/vite.config.ts +0 -15
|
@@ -0,0 +1,233 @@
|
|
|
1
|
+
import "../../index.css";
|
|
2
|
+
|
|
3
|
+
import {
|
|
4
|
+
type ReactNode,
|
|
5
|
+
useEffect,
|
|
6
|
+
useLayoutEffect,
|
|
7
|
+
useRef,
|
|
8
|
+
useState,
|
|
9
|
+
} from "react";
|
|
10
|
+
import { useDisplayMode, useViewState } from "skybridge/web";
|
|
11
|
+
import { EmptyState } from "../../components/empty-state";
|
|
12
|
+
import {
|
|
13
|
+
ProductCard,
|
|
14
|
+
ProductCardSkeleton,
|
|
15
|
+
} from "../../components/product-card";
|
|
16
|
+
import * as cardStyles from "../../components/product-card.css";
|
|
17
|
+
import { ProductCarousel } from "../../components/product-carousel";
|
|
18
|
+
import { ViewFrame } from "../../components/view-frame";
|
|
19
|
+
import { sprinkles } from "../../design/tokens";
|
|
20
|
+
import { useToolInfo } from "../../helpers.js";
|
|
21
|
+
import { useLabels } from "../../i18n";
|
|
22
|
+
import { formatPrice } from "../../lib/format";
|
|
23
|
+
import type { Price, Product, Spec } from "../../types.js";
|
|
24
|
+
import { DetailView } from "./detail";
|
|
25
|
+
|
|
26
|
+
const SKELETON_COUNT = 4;
|
|
27
|
+
|
|
28
|
+
// One narration line per on-screen product. `id` ties the card back to its full
|
|
29
|
+
// record in structuredContent.
|
|
30
|
+
function narrate(product: Product, index: number): string {
|
|
31
|
+
const { card } = product;
|
|
32
|
+
const price = card.price ? ` - ${formatPrice(card.price)}` : "";
|
|
33
|
+
const oos = card.outOfStock ? " [out of stock]" : "";
|
|
34
|
+
return `${index + 1}. ${card.title} (id: ${product.id})${price}${oos}`;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
// View state, persisted on the host so an open detail survives a remount (e.g.
|
|
38
|
+
// after a follow-up message). scrollLeft restores the carousel position on the
|
|
39
|
+
// way back; spec is the full product spec (every variant) the model can answer
|
|
40
|
+
// from while the detail is open.
|
|
41
|
+
type VariantSpec = {
|
|
42
|
+
selection: Record<string, string>; // option label -> chosen value label
|
|
43
|
+
price?: Price;
|
|
44
|
+
available: boolean;
|
|
45
|
+
specs: Spec[];
|
|
46
|
+
};
|
|
47
|
+
type ProductSpec = { id: string; title: string; variants: VariantSpec[] };
|
|
48
|
+
type ViewState = {
|
|
49
|
+
selectedId: string | null;
|
|
50
|
+
scrollLeft: number;
|
|
51
|
+
spec: ProductSpec | null;
|
|
52
|
+
};
|
|
53
|
+
|
|
54
|
+
// The complete spec of the open product — every variant, not just the visible
|
|
55
|
+
// one — pushed to view state so the model can answer any detail question. The
|
|
56
|
+
// on-screen variant is narrated separately (data-llm, in the detail view). Keep
|
|
57
|
+
// it to a single product; a very large spec trips the view-state size warning.
|
|
58
|
+
function buildProductSpec(product: Product): ProductSpec {
|
|
59
|
+
const variants: VariantSpec[] = [];
|
|
60
|
+
for (const variant of product.variants) {
|
|
61
|
+
const selection: Record<string, string> = {};
|
|
62
|
+
for (const option of product.options) {
|
|
63
|
+
const valueId = variant.selection[option.id];
|
|
64
|
+
if (!valueId) {
|
|
65
|
+
continue;
|
|
66
|
+
}
|
|
67
|
+
let label = valueId;
|
|
68
|
+
for (const value of option.values) {
|
|
69
|
+
if (value.id === valueId) {
|
|
70
|
+
label = value.label;
|
|
71
|
+
break;
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
selection[option.label] = label;
|
|
75
|
+
}
|
|
76
|
+
variants.push({
|
|
77
|
+
selection,
|
|
78
|
+
price: variant.price,
|
|
79
|
+
available: !variant.outOfStock,
|
|
80
|
+
specs: variant.specs,
|
|
81
|
+
});
|
|
82
|
+
}
|
|
83
|
+
return { id: product.id, title: product.card.title, variants };
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* Carousel view + product detail, in one view. The carousel is the inline
|
|
88
|
+
* surface; tapping a card opens the detail fullscreen over it (the carousel is
|
|
89
|
+
* hidden, not unmounted). Both read the full products from `_meta`; the detail
|
|
90
|
+
* needs no extra fetch.
|
|
91
|
+
*/
|
|
92
|
+
function Carousel() {
|
|
93
|
+
const { responseMetadata } = useToolInfo<"render-carousel">();
|
|
94
|
+
const labels = useLabels();
|
|
95
|
+
const trackRef = useRef<HTMLElement>(null);
|
|
96
|
+
const [visibleIndices, setVisibleIndices] = useState<number[]>([]);
|
|
97
|
+
const [mode, setMode] = useDisplayMode();
|
|
98
|
+
const [nav, setNav] = useViewState<ViewState>({
|
|
99
|
+
selectedId: null,
|
|
100
|
+
scrollLeft: 0,
|
|
101
|
+
spec: null,
|
|
102
|
+
});
|
|
103
|
+
// True between requesting fullscreen and the host applying it, so the
|
|
104
|
+
// collapse-is-back effect below does not fire mid-transition.
|
|
105
|
+
const enteringRef = useRef(false);
|
|
106
|
+
|
|
107
|
+
const selectedId = nav.selectedId;
|
|
108
|
+
// The detail only mounts once the host is actually fullscreen: rendering the
|
|
109
|
+
// tall page inside the small inline frame would flash a cramped layout.
|
|
110
|
+
const showDetail = selectedId != null && mode === "fullscreen";
|
|
111
|
+
|
|
112
|
+
// A host-driven exit from fullscreen (the user used host chrome) means "back".
|
|
113
|
+
useEffect(() => {
|
|
114
|
+
if (mode === "fullscreen") {
|
|
115
|
+
enteringRef.current = false;
|
|
116
|
+
return;
|
|
117
|
+
}
|
|
118
|
+
if (selectedId != null && !enteringRef.current) {
|
|
119
|
+
setNav((prev) => ({ ...prev, selectedId: null, spec: null }));
|
|
120
|
+
}
|
|
121
|
+
}, [mode, selectedId, setNav]);
|
|
122
|
+
|
|
123
|
+
// Restore carousel scroll when back on the carousel. display:none resets
|
|
124
|
+
// scrollLeft, so re-apply once it is visible again (layout effect, not mount).
|
|
125
|
+
useLayoutEffect(() => {
|
|
126
|
+
if (!showDetail && trackRef.current) {
|
|
127
|
+
trackRef.current.scrollLeft = nav.scrollLeft;
|
|
128
|
+
}
|
|
129
|
+
}, [showDetail, nav.scrollLeft]);
|
|
130
|
+
|
|
131
|
+
function openProduct(id: string) {
|
|
132
|
+
enteringRef.current = true;
|
|
133
|
+
const list = responseMetadata?.products ?? [];
|
|
134
|
+
let spec: ProductSpec | null = null;
|
|
135
|
+
for (const product of list) {
|
|
136
|
+
if (product.id === id) {
|
|
137
|
+
spec = buildProductSpec(product);
|
|
138
|
+
break;
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
setNav({
|
|
142
|
+
selectedId: id,
|
|
143
|
+
scrollLeft: trackRef.current?.scrollLeft ?? 0,
|
|
144
|
+
spec,
|
|
145
|
+
});
|
|
146
|
+
setMode("fullscreen");
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
// Tool still resolving: reserve the layout with skeleton cards.
|
|
150
|
+
if (responseMetadata == null) {
|
|
151
|
+
const skeletons: ReactNode[] = [];
|
|
152
|
+
for (let i = 0; i < SKELETON_COUNT; i++) {
|
|
153
|
+
skeletons.push(<ProductCardSkeleton key={i} />);
|
|
154
|
+
}
|
|
155
|
+
return (
|
|
156
|
+
<ViewFrame>
|
|
157
|
+
<div className={sprinkles({ p: "3xs" })}>
|
|
158
|
+
<ProductCarousel loading>{skeletons}</ProductCarousel>
|
|
159
|
+
</div>
|
|
160
|
+
</ViewFrame>
|
|
161
|
+
);
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
const products = responseMetadata.products ?? [];
|
|
165
|
+
|
|
166
|
+
if (products.length === 0) {
|
|
167
|
+
return (
|
|
168
|
+
<ViewFrame>
|
|
169
|
+
<EmptyState message={labels.noProducts} />
|
|
170
|
+
</ViewFrame>
|
|
171
|
+
);
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
// Guard against a stale id (e.g. the model rendered a new carousel while a
|
|
175
|
+
// detail was open): fall back to the carousel rather than an empty page.
|
|
176
|
+
const selectedProduct =
|
|
177
|
+
selectedId != null
|
|
178
|
+
? products.find((product) => product.id === selectedId)
|
|
179
|
+
: undefined;
|
|
180
|
+
// The detail actually renders only when we have a product to show. Everything
|
|
181
|
+
// that hides the carousel keys off this, so a stale id shows the carousel, not
|
|
182
|
+
// a blank page.
|
|
183
|
+
const detailProduct = showDetail ? selectedProduct : undefined;
|
|
184
|
+
|
|
185
|
+
const cards: ReactNode[] = [];
|
|
186
|
+
for (const [index, product] of products.entries()) {
|
|
187
|
+
const { card } = product;
|
|
188
|
+
cards.push(
|
|
189
|
+
<div key={product.id} className={cardStyles.cardClickable}>
|
|
190
|
+
<ProductCard
|
|
191
|
+
// Drop per-card grounding while the detail owns the screen.
|
|
192
|
+
data-llm={
|
|
193
|
+
!detailProduct && visibleIndices.includes(index)
|
|
194
|
+
? narrate(product, index)
|
|
195
|
+
: ""
|
|
196
|
+
}
|
|
197
|
+
title={card.title}
|
|
198
|
+
price={card.price}
|
|
199
|
+
media={card.media}
|
|
200
|
+
outOfStock={card.outOfStock}
|
|
201
|
+
/>
|
|
202
|
+
<button
|
|
203
|
+
type="button"
|
|
204
|
+
aria-label={card.title}
|
|
205
|
+
className={cardStyles.cardButton}
|
|
206
|
+
onClick={() => openProduct(product.id)}
|
|
207
|
+
/>
|
|
208
|
+
</div>,
|
|
209
|
+
);
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
const narration = `Carousel of ${products.length} product(s); the user scrolls horizontally. On screen now:`;
|
|
213
|
+
|
|
214
|
+
return (
|
|
215
|
+
<ViewFrame>
|
|
216
|
+
<div
|
|
217
|
+
className={sprinkles({ p: "3xs" })}
|
|
218
|
+
style={{ display: detailProduct ? "none" : undefined }}
|
|
219
|
+
>
|
|
220
|
+
<ProductCarousel
|
|
221
|
+
trackRef={trackRef}
|
|
222
|
+
onVisibleChange={setVisibleIndices}
|
|
223
|
+
data-llm={detailProduct ? "" : narration}
|
|
224
|
+
>
|
|
225
|
+
{cards}
|
|
226
|
+
</ProductCarousel>
|
|
227
|
+
</div>
|
|
228
|
+
{detailProduct ? <DetailView product={detailProduct} /> : null}
|
|
229
|
+
</ViewFrame>
|
|
230
|
+
);
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
export default Carousel;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { skybridge } from "@skybridge/vite-plugin";
|
|
2
|
+
import { vanillaExtractPlugin } from "@vanilla-extract/vite-plugin";
|
|
3
|
+
import react from "@vitejs/plugin-react";
|
|
4
|
+
import { defineConfig, type PluginOption } from "vite";
|
|
5
|
+
|
|
6
|
+
export default defineConfig({
|
|
7
|
+
plugins: [skybridge() as PluginOption, react(), vanillaExtractPlugin()],
|
|
8
|
+
});
|
package/dist/index.test.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
package/dist/index.test.js
DELETED
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
import { randomBytes } from "node:crypto";
|
|
2
|
-
import fs from "node:fs/promises";
|
|
3
|
-
import path from "node:path";
|
|
4
|
-
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
|
5
|
-
import { init } from "./index.js";
|
|
6
|
-
describe("create-skybridge", () => {
|
|
7
|
-
let tempDirName;
|
|
8
|
-
beforeEach(() => {
|
|
9
|
-
tempDirName = `test-${randomBytes(2).toString("hex")}`;
|
|
10
|
-
});
|
|
11
|
-
afterEach(async () => {
|
|
12
|
-
await fs.rm(path.join(process.cwd(), tempDirName), {
|
|
13
|
-
recursive: true,
|
|
14
|
-
force: true,
|
|
15
|
-
});
|
|
16
|
-
});
|
|
17
|
-
it("should scaffold a new project", async () => {
|
|
18
|
-
const name = `../../${tempDirName}//project$`;
|
|
19
|
-
await init([name]);
|
|
20
|
-
await fs.access(path.join(process.cwd(), tempDirName, "project", ".gitignore"));
|
|
21
|
-
expect(fs.access(path.join(process.cwd(), tempDirName, "project", ".npmrc"))).rejects.toThrowError();
|
|
22
|
-
});
|
|
23
|
-
});
|
package/template/README.md
DELETED
|
@@ -1,66 +0,0 @@
|
|
|
1
|
-
# ChatGPT Apps SDK Alpic Starter
|
|
2
|
-
|
|
3
|
-
A minimal TypeScript template for building OpenAI Apps SDK compatible MCP servers with widget rendering in ChatGPT.
|
|
4
|
-
|
|
5
|
-
## Getting Started
|
|
6
|
-
|
|
7
|
-
### Prerequisites
|
|
8
|
-
|
|
9
|
-
- Node.js 22+
|
|
10
|
-
- pnpm (install with `npm install -g pnpm`)
|
|
11
|
-
- HTTP tunnel such as [ngrok](https://ngrok.com/download)
|
|
12
|
-
|
|
13
|
-
### Local Development
|
|
14
|
-
|
|
15
|
-
#### 1. Install
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
pnpm install
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
#### 2. Start your local server
|
|
22
|
-
|
|
23
|
-
Run the development server from the root directory:
|
|
24
|
-
|
|
25
|
-
```bash
|
|
26
|
-
pnpm dev
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
This command starts an Express server on port 3000. This server packages:
|
|
30
|
-
|
|
31
|
-
- an MCP endpoint on `/mcp` (the app backend)
|
|
32
|
-
- a React application on Vite HMR dev server (the UI elements to be displayed in ChatGPT)
|
|
33
|
-
|
|
34
|
-
#### 3. Connect to ChatGPT
|
|
35
|
-
|
|
36
|
-
- ChatGPT requires connectors to be publicly accessible. To expose your server on the Internet, run:
|
|
37
|
-
```bash
|
|
38
|
-
ngrok http 3000
|
|
39
|
-
```
|
|
40
|
-
- In ChatGPT, navigate to **Settings → Connectors → Create** and add the forwarding URL provided by ngrok suffixed with `/mcp` (e.g. `https://3785c5ddc4b6.ngrok-free.app/mcp`)
|
|
41
|
-
|
|
42
|
-
### Create your first widget
|
|
43
|
-
|
|
44
|
-
#### 1. Add a new widget
|
|
45
|
-
|
|
46
|
-
- Register a widget in `server/server.ts` with a unique name (e.g., `my-widget`)
|
|
47
|
-
- Create a matching React component at `web/src/widgets/my-widget.tsx`. The file name must match the widget name exactly
|
|
48
|
-
|
|
49
|
-
#### 2. Edit widgets with Hot Module Replacement (HMR)
|
|
50
|
-
|
|
51
|
-
Edit and save components in `web/src/widgets/` — changes appear instantly in ChatGPT
|
|
52
|
-
|
|
53
|
-
#### 3. Edit server code
|
|
54
|
-
|
|
55
|
-
Modify files in `server/` and reload your ChatGPT connector in **Settings → Connectors → [Your connector] → Reload**
|
|
56
|
-
|
|
57
|
-
## Deploy to Production
|
|
58
|
-
|
|
59
|
-
- Use [Alpic](https://alpic.ai/) to deploy your OpenAI App to production
|
|
60
|
-
- In ChatGPT, navigate to **Settings → Connectors → Create** and add your MCP server URL (e.g., `https://your-app-name.alpic.live`)
|
|
61
|
-
|
|
62
|
-
## Resources
|
|
63
|
-
|
|
64
|
-
- [Apps SDK Documentation](https://developers.openai.com/apps-sdk)
|
|
65
|
-
- [Model Context Protocol Documentation](https://modelcontextprotocol.io/)
|
|
66
|
-
- [Alpic Documentation](https://docs.alpic.ai/)
|
package/template/_gitignore
DELETED
package/template/alpic.json
DELETED
package/template/package.json
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "apps-sdk-template",
|
|
3
|
-
"version": "0.0.1",
|
|
4
|
-
"private": true,
|
|
5
|
-
"description": "Alpic MCP Server Template",
|
|
6
|
-
"type": "module",
|
|
7
|
-
"packageManager": "pnpm@10.18.3",
|
|
8
|
-
"scripts": {
|
|
9
|
-
"dev": "pnpm --filter @apps-sdk-template/server dev",
|
|
10
|
-
"build": "pnpm web:build && rm -rf server/dist && pnpm --filter=@apps-sdk-template/server --prod deploy server/dist && cp -r web/dist server/dist/assets && pnpm --filter=@apps-sdk-template/server build",
|
|
11
|
-
"start": "pnpm server:start",
|
|
12
|
-
"inspector": "pnpm --filter @apps-sdk-template/server inspector",
|
|
13
|
-
"server:build": "pnpm --filter @apps-sdk-template/server build",
|
|
14
|
-
"server:start": "pnpm --filter @apps-sdk-template/server start",
|
|
15
|
-
"web:build": "pnpm --filter @apps-sdk-template/web build",
|
|
16
|
-
"web:preview": "pnpm --filter @apps-sdk-template/web preview"
|
|
17
|
-
},
|
|
18
|
-
"devDependencies": {
|
|
19
|
-
"tsx": "^4.19.4"
|
|
20
|
-
}
|
|
21
|
-
}
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@apps-sdk-template/server",
|
|
3
|
-
"version": "0.0.1",
|
|
4
|
-
"private": true,
|
|
5
|
-
"main": "dist/index.js",
|
|
6
|
-
"description": "Alpic MCP Server Template",
|
|
7
|
-
"files": [
|
|
8
|
-
"dist"
|
|
9
|
-
],
|
|
10
|
-
"type": "module",
|
|
11
|
-
"scripts": {
|
|
12
|
-
"dev": "nodemon",
|
|
13
|
-
"build": "tsc",
|
|
14
|
-
"start": "node dist/index.js",
|
|
15
|
-
"inspector": "mcp-inspector http://localhost:3000/mcp"
|
|
16
|
-
},
|
|
17
|
-
"dependencies": {
|
|
18
|
-
"@modelcontextprotocol/sdk": "^1.24.3",
|
|
19
|
-
"express": "^5.1.0",
|
|
20
|
-
"skybridge": "catalog:",
|
|
21
|
-
"vite": "^7.1.11",
|
|
22
|
-
"zod": "^4.1.13"
|
|
23
|
-
},
|
|
24
|
-
"devDependencies": {
|
|
25
|
-
"@modelcontextprotocol/inspector": "^0.17.5",
|
|
26
|
-
"@types/express": "^5.0.3",
|
|
27
|
-
"@types/node": "^22.15.30",
|
|
28
|
-
"nodemon": "^3.1.10",
|
|
29
|
-
"tsx": "^4.19.2",
|
|
30
|
-
"typescript": "^5.7.2"
|
|
31
|
-
}
|
|
32
|
-
}
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
import express, { type Express } from "express";
|
|
2
|
-
|
|
3
|
-
import { widgetsDevServer, devtoolsStaticServer } from "skybridge/server";
|
|
4
|
-
import type { ViteDevServer } from "vite";
|
|
5
|
-
import { mcp } from "./middleware.js";
|
|
6
|
-
import server from "./server.js";
|
|
7
|
-
|
|
8
|
-
const app = express() as Express & { vite: ViteDevServer };
|
|
9
|
-
|
|
10
|
-
app.use(express.json());
|
|
11
|
-
|
|
12
|
-
app.use(mcp(server));
|
|
13
|
-
|
|
14
|
-
const env = process.env.NODE_ENV || "development";
|
|
15
|
-
|
|
16
|
-
if (env !== "production") {
|
|
17
|
-
app.use(await devtoolsStaticServer());
|
|
18
|
-
app.use(await widgetsDevServer());
|
|
19
|
-
}
|
|
20
|
-
|
|
21
|
-
app.listen(3000, (error) => {
|
|
22
|
-
if (error) {
|
|
23
|
-
console.error("Failed to start server:", error);
|
|
24
|
-
process.exit(1);
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
console.log(`Server listening on port 3000 - ${env}`);
|
|
28
|
-
console.log(
|
|
29
|
-
"Make your local server accessible with 'ngrok http 3000' and connect to ChatGPT with URL https://xxxxxx.ngrok-free.app/mcp",
|
|
30
|
-
);
|
|
31
|
-
});
|
|
32
|
-
|
|
33
|
-
process.on("SIGINT", async () => {
|
|
34
|
-
console.log("Server shutdown complete");
|
|
35
|
-
process.exit(0);
|
|
36
|
-
});
|
|
@@ -1,54 +0,0 @@
|
|
|
1
|
-
import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js";
|
|
2
|
-
import type { NextFunction, Request, Response } from "express";
|
|
3
|
-
|
|
4
|
-
import type { McpServer } from "skybridge/server";
|
|
5
|
-
|
|
6
|
-
export const mcp =
|
|
7
|
-
(server: McpServer) =>
|
|
8
|
-
async (req: Request, res: Response, next: NextFunction) => {
|
|
9
|
-
// Only handle requests to the /mcp path
|
|
10
|
-
if (req.path !== "/mcp") {
|
|
11
|
-
return next();
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
if (req.method === "POST") {
|
|
15
|
-
try {
|
|
16
|
-
const transport = new StreamableHTTPServerTransport({
|
|
17
|
-
sessionIdGenerator: undefined,
|
|
18
|
-
});
|
|
19
|
-
|
|
20
|
-
res.on("close", () => {
|
|
21
|
-
transport.close();
|
|
22
|
-
});
|
|
23
|
-
|
|
24
|
-
await server.connect(transport);
|
|
25
|
-
|
|
26
|
-
await transport.handleRequest(req, res, req.body);
|
|
27
|
-
} catch (error) {
|
|
28
|
-
console.error("Error handling MCP request:", error);
|
|
29
|
-
if (!res.headersSent) {
|
|
30
|
-
res.status(500).json({
|
|
31
|
-
jsonrpc: "2.0",
|
|
32
|
-
error: {
|
|
33
|
-
code: -32603,
|
|
34
|
-
message: "Internal server error",
|
|
35
|
-
},
|
|
36
|
-
id: null,
|
|
37
|
-
});
|
|
38
|
-
}
|
|
39
|
-
}
|
|
40
|
-
} else if (req.method === "GET" || req.method === "DELETE") {
|
|
41
|
-
res.writeHead(405).end(
|
|
42
|
-
JSON.stringify({
|
|
43
|
-
jsonrpc: "2.0",
|
|
44
|
-
error: {
|
|
45
|
-
code: -32000,
|
|
46
|
-
message: "Method not allowed.",
|
|
47
|
-
},
|
|
48
|
-
id: null,
|
|
49
|
-
}),
|
|
50
|
-
);
|
|
51
|
-
} else {
|
|
52
|
-
next();
|
|
53
|
-
}
|
|
54
|
-
};
|
|
@@ -1,66 +0,0 @@
|
|
|
1
|
-
import { McpServer } from "skybridge/server";
|
|
2
|
-
import { z } from "zod";
|
|
3
|
-
|
|
4
|
-
const Answers = [
|
|
5
|
-
"As I see it, yes",
|
|
6
|
-
"Ask again later",
|
|
7
|
-
"Better not tell you now",
|
|
8
|
-
"Cannot predict now",
|
|
9
|
-
"Concentrate and ask again",
|
|
10
|
-
"Don't count on it",
|
|
11
|
-
"It is certain",
|
|
12
|
-
"It is decidedly so",
|
|
13
|
-
"Most likely",
|
|
14
|
-
"My reply is no",
|
|
15
|
-
"My sources say no",
|
|
16
|
-
"Outlook good",
|
|
17
|
-
"Outlook not so good",
|
|
18
|
-
"Reply hazy, try again",
|
|
19
|
-
"Signs point to yes",
|
|
20
|
-
"Very doubtful",
|
|
21
|
-
"Without a doubt",
|
|
22
|
-
"Yes definitely",
|
|
23
|
-
"Yes",
|
|
24
|
-
"You may rely on it",
|
|
25
|
-
];
|
|
26
|
-
|
|
27
|
-
const server = new McpServer(
|
|
28
|
-
{
|
|
29
|
-
name: "alpic-openai-app",
|
|
30
|
-
version: "0.0.1",
|
|
31
|
-
},
|
|
32
|
-
{ capabilities: {} },
|
|
33
|
-
).registerWidget(
|
|
34
|
-
"magic-8-ball",
|
|
35
|
-
{
|
|
36
|
-
description: "Magic 8 Ball",
|
|
37
|
-
},
|
|
38
|
-
{
|
|
39
|
-
description: "For fortune-telling or seeking advice.",
|
|
40
|
-
inputSchema: {
|
|
41
|
-
question: z.string().describe("The user question."),
|
|
42
|
-
},
|
|
43
|
-
},
|
|
44
|
-
async ({ question }) => {
|
|
45
|
-
try {
|
|
46
|
-
// deterministic answer
|
|
47
|
-
const hash = question
|
|
48
|
-
.split("")
|
|
49
|
-
.reduce((acc, char) => acc + char.charCodeAt(0), 0);
|
|
50
|
-
const answer = Answers[hash % Answers.length];
|
|
51
|
-
return {
|
|
52
|
-
structuredContent: { answer },
|
|
53
|
-
content: [],
|
|
54
|
-
isError: false,
|
|
55
|
-
};
|
|
56
|
-
} catch (error) {
|
|
57
|
-
return {
|
|
58
|
-
content: [{ type: "text", text: `Error: ${error}` }],
|
|
59
|
-
isError: true,
|
|
60
|
-
};
|
|
61
|
-
}
|
|
62
|
-
},
|
|
63
|
-
);
|
|
64
|
-
|
|
65
|
-
export default server;
|
|
66
|
-
export type AppType = typeof server;
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"compilerOptions": {
|
|
3
|
-
"target": "ESNext",
|
|
4
|
-
"module": "ESNext",
|
|
5
|
-
"moduleResolution": "bundler",
|
|
6
|
-
"esModuleInterop": true,
|
|
7
|
-
"strict": true,
|
|
8
|
-
"skipLibCheck": true,
|
|
9
|
-
"forceConsistentCasingInFileNames": true,
|
|
10
|
-
"outDir": "dist",
|
|
11
|
-
"sourceMap": true,
|
|
12
|
-
"jsx": "react",
|
|
13
|
-
"inlineSources": true
|
|
14
|
-
},
|
|
15
|
-
"include": ["**/*.ts", "**/*.tsx"],
|
|
16
|
-
"exclude": ["dist", "node_modules"]
|
|
17
|
-
}
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@apps-sdk-template/web",
|
|
3
|
-
"private": true,
|
|
4
|
-
"version": "0.0.0",
|
|
5
|
-
"type": "module",
|
|
6
|
-
"scripts": {
|
|
7
|
-
"dev": "echo 'Not implemented",
|
|
8
|
-
"build": "tsc -b && vite build",
|
|
9
|
-
"preview": "vite preview"
|
|
10
|
-
},
|
|
11
|
-
"dependencies": {
|
|
12
|
-
"skybridge": "catalog:",
|
|
13
|
-
"react": "^19.1.1",
|
|
14
|
-
"react-dom": "^19.1.1"
|
|
15
|
-
},
|
|
16
|
-
"devDependencies": {
|
|
17
|
-
"@types/node": "^24.6.0",
|
|
18
|
-
"@types/react": "^19.1.16",
|
|
19
|
-
"@types/react-dom": "^19.1.9",
|
|
20
|
-
"@vitejs/plugin-react": "^5.0.4",
|
|
21
|
-
"typescript": "~5.9.3",
|
|
22
|
-
"vite": "^7.1.11"
|
|
23
|
-
}
|
|
24
|
-
}
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
.container {
|
|
2
|
-
display: flex;
|
|
3
|
-
justify-content: center;
|
|
4
|
-
align-items: center;
|
|
5
|
-
height: 100%;
|
|
6
|
-
}
|
|
7
|
-
|
|
8
|
-
.ball {
|
|
9
|
-
background-color: black;
|
|
10
|
-
border-radius: 50%;
|
|
11
|
-
width: 12rem;
|
|
12
|
-
height: 12rem;
|
|
13
|
-
display: flex;
|
|
14
|
-
flex-direction: column;
|
|
15
|
-
align-items: center;
|
|
16
|
-
justify-content: center;
|
|
17
|
-
font-family: monospace;
|
|
18
|
-
}
|
|
19
|
-
|
|
20
|
-
.question {
|
|
21
|
-
font-size: 0.75rem;
|
|
22
|
-
color: lightgrey;
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
.answer {
|
|
26
|
-
font-size: 1.125rem;
|
|
27
|
-
font-weight: bold;
|
|
28
|
-
margin-top: 0.5rem;
|
|
29
|
-
color: aqua;
|
|
30
|
-
}
|