@glasshome/widget-sdk 1.4.2 → 1.6.0

package/dist/types.d.ts

@@ -7,11 +7,23 @@ export interface GridSize {
     w: number;
     h: number;
 }
+/**
+ * A curated showcase state for preview-image generation. Config references
+ * demo-fixture entity ids; the preview harness renders it at `size` and
+ * screenshots light + dark. `examples[0]` is the thumbnail.
+ *
+ * @template C - Widget configuration type
+ */
+export interface WidgetExample<C = Record<string, unknown>> {
+    config: C;
+    size: GridSize;
+    label?: string;
+}
 /**
  * Widget manifest — declarative metadata about a widget.
  * Framework-agnostic: no SolidJS imports.
  */
-export interface WidgetManifest {
+export interface WidgetManifest<C = Record<string, unknown>> {
     name: string;
     description?: string;
     minSize: GridSize;
@@ -24,6 +36,7 @@ export interface WidgetManifest {
     configVersion?: number;
     capabilities?: CapabilityGrant[];
     cssUrl?: string;
+    examples?: WidgetExample<C>[];
 }
 /**
  * Runtime context provided to widgets by the host.
@@ -49,7 +62,7 @@ export interface WidgetContext {
  * @template C - Widget configuration type
  */
 export interface WidgetDefinition<C = Record<string, unknown>> {
-    manifest: WidgetManifest;
+    manifest: WidgetManifest<C>;
     configSchema?: ZodType<C, unknown>;
     migrate?: (config: Record<string, unknown>, fromConfigVersion: number) => Record<string, unknown>;
     component: (props: {

package/dist/vite/index.d.ts

@@ -3,7 +3,13 @@ export interface GlasshomeWidgetOptions {
     /** Entry file for the widget (default: "src/index.tsx") */
     entry?: string;
 }
-/** Packages provided by the host import map — widgets must not bundle these. */
+/**
+ * Packages provided by the host import map — widgets must not bundle these.
+ * Delegates to the shared list in @glasshome/widget-contract so the host's
+ * import map and the widget build can never disagree again. Exact match only:
+ * a specifier the import map does not serve (e.g. "@glasshome/ui/tokens")
+ * must be bundled, because leaving it external is a runtime 404.
+ */
 export declare function isWidgetExternal(id: string): boolean;
 interface DiscoveredWidget {
     name: string;

package/dist/vite/index.js

@@ -1,26 +1,26 @@
-import { formatSchemaError as e, widgetManifestSchema as t } from "@glasshome/widget-contract";
-import { createHash as n } from "node:crypto";
-import { existsSync as r, mkdirSync as i, readFileSync as a, readdirSync as o, rmSync as s, statSync as c, writeFileSync as l } from "node:fs";
-import { createRequire as u } from "node:module";
-import { dirname as d, join as f, resolve as p, sep as m } from "node:path";
-import { fileURLToPath as h } from "node:url";
-import g from "@tailwindcss/vite";
+import { formatSchemaError as e, isHostProvidedModule as t, widgetManifestSchema as n } from "@glasshome/widget-contract";
+import { createHash as r } from "node:crypto";
+import { existsSync as i, mkdirSync as a, readFileSync as o, readdirSync as s, rmSync as c, statSync as l, writeFileSync as u } from "node:fs";
+import { createRequire as d } from "node:module";
+import { dirname as f, join as p, resolve as m, sep as h } from "node:path";
+import { fileURLToPath as g } from "node:url";
+import _ from "@tailwindcss/vite";
 //#region src/vite/index.ts
-function _(e) {
+function v(e) {
 	let t = JSON.stringify(e, Object.keys(e).sort());
-	return n("sha256").update(t).digest("hex").slice(0, 16);
+	return r("sha256").update(t).digest("hex").slice(0, 16);
 }
-var v = "virtual:glasshome-widget", y = "\0virtual:glasshome-widget", b = "/@glasshome/preview";
-function x(e) {
-	return m === "\\" ? e.split(m).join("/") : e;
+var y = "virtual:glasshome-widget", b = "\0virtual:glasshome-widget", x = "/@glasshome/preview";
+function S(e) {
+	return h === "\\" ? e.split(h).join("/") : e;
 }
-function S() {
-	return p(d(h(import.meta.url)), "../../preview");
+function C() {
+	return m(f(g(import.meta.url)), "../../preview");
 }
-function C(e) {
-	return e === "solid-js" || e.startsWith("solid-js/") || e === "@glasshome/widget-sdk" || e.startsWith("@glasshome/widget-sdk/") || e === "@glasshome/ui" || e.startsWith("@glasshome/ui/");
+function w(e) {
+	return t(e);
 }
-function w() {
+function T() {
 	return {
 		name: "glasshome-widget:sync-layer-guard",
 		apply: "build",
@@ -30,15 +30,15 @@ function w() {
 		}
 	};
 }
-var T = "node_modules/.cache/glasshome-widgets";
-function E(e) {
+var E = "node_modules/.cache/glasshome-widgets";
+function D(e) {
 	try {
-		return u(f(process.cwd(), "package.json")).resolve(e);
+		return d(p(process.cwd(), "package.json")).resolve(e);
 	} catch {
 		return null;
 	}
 }
-var D = [
+var O = [
 	"--radius",
 	"--background",
 	"--foreground",
@@ -48,124 +48,124 @@ var D = [
 	"--muted",
 	"--accent"
 ];
-function O(e, t) {
-	let n = f(e, `${t}.css`);
-	if (!r(n)) return;
-	let i = a(n, "utf-8");
-	for (let e of i.matchAll(/:host[^{]*\{([^}]*)\}/g)) {
-		let n = e[1] ?? "", r = D.find((e) => n.includes(`${e}:`));
+function k(e, t) {
+	let n = p(e, `${t}.css`);
+	if (!i(n)) return;
+	let r = o(n, "utf-8");
+	for (let e of r.matchAll(/:host[^{]*\{([^}]*)\}/g)) {
+		let n = e[1] ?? "", r = O.find((e) => n.includes(`${e}:`));
 		if (r) throw Error(`[glasshome-widget] "${t}.css" defines theme variable "${r}" on :host. Theme variables must inherit from the document so widgets follow the household theme — never re-scope them into the widget's shadow root.`);
 	}
 }
-function k(e, t, n) {
-	let a = p(e, T);
-	i(a, { recursive: !0 });
-	let o = E("@glasshome/ui/styles");
+function A(e, t, n) {
+	let r = m(e, E);
+	a(r, { recursive: !0 });
+	let o = D("@glasshome/ui/styles");
 	if (!o) throw Error("[widget-sdk] @glasshome/ui is required to build widgets (it provides the theme every GlassHome widget ships with). Add it to your widget's dependencies.");
-	let s = p(d(o), "../.."), c = E("@glasshome/widget-sdk/tailwind-sources"), u = c ? d(c) : null, m = [
-		f(s, "src"),
-		f(s, "dist"),
-		...u ? [f(u, "src"), f(u, "dist")] : [],
-		d(n)
-	].filter((e) => r(e)), h = p(a, `${t}.tailwind.css`);
-	l(h, [
+	let s = m(f(o), "../.."), c = D("@glasshome/widget-sdk/tailwind-sources"), l = c ? f(c) : null, d = [
+		p(s, "src"),
+		p(s, "dist"),
+		...l ? [p(l, "src"), p(l, "dist")] : [],
+		f(n)
+	].filter((e) => i(e)), h = m(r, `${t}.tailwind.css`);
+	u(h, [
 		"@import \"tailwindcss\" source(none);",
 		"@import \"tw-animate-css\";",
 		"@import \"@glasshome/ui/styles/theme\";",
-		...m.map((e) => `@source "${x(e)}";`),
+		...d.map((e) => `@source "${S(e)}";`),
 		"@custom-variant dark {",
 		"  &:is(.dark *) { @slot }",
 		"  :host(.dark) & { @slot }",
 		"}",
 		""
 	].join("\n"));
-	let g = p(a, `${t}.entry.ts`);
-	return l(g, [
-		`import "${x(h)}";`,
-		`export { default } from "${x(n)}";`,
+	let g = m(r, `${t}.entry.ts`);
+	return u(g, [
+		`import "${S(h)}";`,
+		`export { default } from "${S(n)}";`,
 		""
 	].join("\n")), g;
 }
-function A() {
-	let e = g();
+function j() {
+	let e = _();
 	for (let t of e) t.apply ??= "build";
 	return e;
 }
-function j(e) {
+function M(e) {
 	let t = [];
-	if (!r(e)) return t;
-	for (let n of o(e)) {
-		let i = p(e, n);
-		if (!c(i).isDirectory()) continue;
-		let a = p(i, "index.tsx"), o = p(i, "manifest.json");
-		r(a) && r(o) && t.push({
+	if (!i(e)) return t;
+	for (let n of s(e)) {
+		let r = m(e, n);
+		if (!l(r).isDirectory()) continue;
+		let a = m(r, "index.tsx"), o = m(r, "manifest.json");
+		i(a) && i(o) && t.push({
 			name: n,
 			entry: a
 		});
 	}
 	return t;
 }
-function M(n, s) {
-	let u = [];
-	if (r(n)) for (let i of o(n)) {
-		if (!c(f(n, i)).isDirectory()) continue;
-		let o = f(n, i, "manifest.json");
-		if (!r(o)) continue;
-		let l = t.safeParse(JSON.parse(a(o, "utf-8")));
-		if (!l.success) throw Error(`[registry] Invalid manifest for "${i}": ${e(l.error)}`);
-		let d = r(f(s, `${i}.css`));
-		u.push({
-			...l.data,
-			bundleUrl: `./${i}.js`,
-			...d ? { cssUrl: `./${i}.css` } : {}
+function N(t, r) {
+	let c = [];
+	if (i(t)) for (let a of s(t)) {
+		if (!l(p(t, a)).isDirectory()) continue;
+		let s = p(t, a, "manifest.json");
+		if (!i(s)) continue;
+		let u = n.safeParse(JSON.parse(o(s, "utf-8")));
+		if (!u.success) throw Error(`[registry] Invalid manifest for "${a}": ${e(u.error)}`);
+		let d = i(p(r, `${a}.css`));
+		c.push({
+			...u.data,
+			bundleUrl: `./${a}.js`,
+			...d ? { cssUrl: `./${a}.css` } : {}
 		});
 	}
 	let d = {
 		version: 1,
 		generatedAt: (/* @__PURE__ */ new Date()).toISOString(),
 		baseUrl: "./",
-		widgets: u
+		widgets: c
 	};
-	r(s) || i(s, { recursive: !0 }), l(f(s, "registry.json"), JSON.stringify(d, null, 2)), console.log(`[registry] Generated registry.json with ${u.length} widget(s)`);
+	i(r) || a(r, { recursive: !0 }), u(p(r, "registry.json"), JSON.stringify(d, null, 2)), console.log(`[registry] Generated registry.json with ${c.length} widget(s)`);
 }
-async function N(e) {
-	let { build: t } = await import("vite"), n = process.cwd(), a = p(n, e?.srcDir ?? "src"), o = p(n, e?.outDir ?? "dist"), c = j(a);
-	if (c.length === 0) {
-		console.warn("[glasshome-widgets] No widgets found in", a);
+async function P(e) {
+	let { build: t } = await import("vite"), n = process.cwd(), r = m(n, e?.srcDir ?? "src"), o = m(n, e?.outDir ?? "dist"), s = M(r);
+	if (s.length === 0) {
+		console.warn("[glasshome-widgets] No widgets found in", r);
 		return;
 	}
 	if (e?.only) {
 		let t = new Set(e.only);
-		c = c.filter((e) => t.has(e.name));
+		s = s.filter((e) => t.has(e.name));
 	}
-	e?.only || r(o) && s(o, { recursive: !0 }), r(o) || i(o, { recursive: !0 });
-	for (let r of c) await t({
+	e?.only || i(o) && c(o, { recursive: !0 }), i(o) || a(o, { recursive: !0 });
+	for (let r of s) await t({
 		configFile: !1,
 		root: n,
 		plugins: [
-			...A(),
+			...j(),
 			...e?.plugins ?? [],
-			w()
+			T()
 		],
 		...e?.viteConfig,
 		build: {
 			lib: {
-				entry: k(n, r.name, r.entry),
+				entry: A(n, r.name, r.entry),
 				formats: ["es"],
 				fileName: r.name,
 				cssFileName: r.name
 			},
-			rollupOptions: { external: C },
+			rollupOptions: { external: w },
 			outDir: o,
 			emptyOutDir: !1,
 			copyPublicDir: !1,
 			...e?.viteConfig?.build
 		},
 		logLevel: "warn"
-	}), O(o, r.name);
-	M(a, o);
+	}), k(o, r.name);
+	N(r, o);
 }
-function P(e) {
+function F(e) {
 	let t = e?.entry ?? "src/index.tsx", n = {
 		name: "glasshome-widget:build",
 		apply: "build",
@@ -173,31 +173,31 @@ function P(e) {
 			let e = process.cwd();
 			return { build: {
 				lib: {
-					entry: k(e, "index", p(e, t)),
+					entry: A(e, "index", m(e, t)),
 					formats: ["es"],
 					fileName: "index",
 					cssFileName: "index"
 				},
-				rollupOptions: { external: C }
+				rollupOptions: { external: w }
 			} };
 		}
-	}, i = {
+	}, r = {
 		name: "glasshome-widget:dev",
 		apply: "serve",
 		enforce: "pre",
 		config() {
-			let e = S(), t = process.cwd();
+			let e = C(), t = process.cwd();
 			return { server: { fs: { allow: [
 				e,
 				t,
-				p(t, "..", "..")
+				m(t, "..", "..")
 			] } } };
 		},
 		configureServer(e) {
-			let t = f(S(), "preview.html");
+			let t = p(C(), "preview.html");
 			e.middlewares.use(async (n, r, i) => {
 				if (n.url === "/" || n.url === "/index.html") try {
-					let i = a(t, "utf-8");
+					let i = o(t, "utf-8");
 					i = await e.transformIndexHtml(n.url, i), r.setHeader("Content-Type", "text/html"), r.statusCode = 200, r.end(i);
 				} catch (e) {
 					i(e);
@@ -206,44 +206,44 @@ function P(e) {
 			});
 		},
 		resolveId(e) {
-			if (e === b) return x(f(S(), "host.tsx"));
-			if (e === v) return y;
+			if (e === x) return S(p(C(), "host.tsx"));
+			if (e === y) return b;
 		},
 		load(e) {
-			if (e === y) return `export { default } from "${x(p(process.cwd(), t))}";`;
+			if (e === b) return `export { default } from "${S(m(process.cwd(), t))}";`;
 		}
-	}, o = {
+	}, a = {
 		name: "glasshome-widget:schema",
 		apply: "build",
 		async closeBundle() {
-			O(p(process.cwd(), "dist"), "index");
-			let e = p(process.cwd(), "dist", "index.js");
-			if (r(e)) try {
+			k(m(process.cwd(), "dist"), "index");
+			let e = m(process.cwd(), "dist", "index.js");
+			if (i(e)) try {
 				let t = (await import(`${e}?t=${Date.now()}`)).default;
 				if (!t?.configSchema) return;
-				let { z: n } = await import("zod"), i = n.toJSONSchema(t.configSchema, { unrepresentable: "any" }), o = p(process.cwd(), "manifest.json");
-				if (r(o)) {
-					let e = JSON.parse(a(o, "utf-8"));
-					e.schema = i, l(o, JSON.stringify(e, null, 2));
+				let { z: n } = await import("zod"), r = n.toJSONSchema(t.configSchema, { unrepresentable: "any" }), a = m(process.cwd(), "manifest.json");
+				if (i(a)) {
+					let e = JSON.parse(o(a, "utf-8"));
+					e.schema = r, u(a, JSON.stringify(e, null, 2));
 				}
-				let s = _(i), c = p(process.cwd(), ".schema-hash");
-				if (r(c) && a(c, "utf-8").trim() !== s) {
+				let s = v(r), c = m(process.cwd(), ".schema-hash");
+				if (i(c) && o(c, "utf-8").trim() !== s) {
 					let e = t.manifest?.name ?? "unknown";
 					console.warn(`[widget-sdk] Schema shape changed for "${e}" — verify configVersion was bumped`);
 				}
-				l(c, s);
+				u(c, s);
 			} catch {}
 		}
 	};
 	return [
-		...A(),
+		...j(),
 		n,
-		w(),
-		o,
-		i
+		T(),
+		a,
+		r
 	];
 }
-function F(e) {
+function I(e) {
 	let t = e?.srcDir ?? "src", n = e?.outDir ?? "dist", r = [];
 	return [{
 		name: "glasshome-widgets:build",
@@ -262,7 +262,7 @@ function F(e) {
 			if (e === "\0glasshome-noop") return "export {}";
 		},
 		async closeBundle() {
-			await N({
+			await P({
 				srcDir: t,
 				outDir: n,
 				plugins: r
@@ -271,4 +271,4 @@ function F(e) {
 	}];
 }
 //#endregion
-export { N as buildWidgets, j as discoverWidgets, M as generateRegistry, P as glasshomeWidget, F as glasshomeWidgets, C as isWidgetExternal };
+export { P as buildWidgets, M as discoverWidgets, N as generateRegistry, F as glasshomeWidget, I as glasshomeWidgets, w as isWidgetExternal };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glasshome/widget-sdk",
-  "version": "1.4.2",
+  "version": "1.6.0",
   "description": "SDK for building GlassHome dashboard widgets with SolidJS",
   "keywords": [
     "glasshome",
@@ -52,11 +52,11 @@
     "typecheck:test": "tsc --noEmit -p tsconfig.test.json"
   },
   "peerDependencies": {
-    "@glasshome/sync-layer": "0.3.1",
+    "@glasshome/sync-layer": "0.3.2",
     "solid-js": "^1.9.11"
   },
   "dependencies": {
-    "@glasshome/widget-contract": "0.1.0",
+    "@glasshome/widget-contract": "0.2.0",
     "@modular-forms/solid": "^0.25.1",
     "clsx": "^2.1.1",
     "tailwind-merge": "^3.5.0",