create-grist-widget 0.3.1 → 0.3.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-grist-widget",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "Scaffold a new Grist custom widget from the grist-widget-sdk Vite template",
   "license": "MIT",
   "type": "module",
@@ -25,7 +25,7 @@
   "bugs": {
     "url": "https://github.com/ArthurBlanchon/grist-widget-sdk/issues"
   },
-  "homepage": "https://grist-widgets.com",
+  "homepage": "https://gristwidgets.com",
   "keywords": [
     "grist",
     "widget",

package/template/README.md

@@ -6,14 +6,14 @@ Base template to build a Grist widget with `grist-widget-sdk`.
 
 Opened outside a Grist iframe, `main.tsx` picks between two components purely by URL shape (`src/lib/showcase-routing.ts`, no router needed): a bare path with no recognized channel suffix renders `TemplateLanding` (its own hero, onboarding, and released-version index); `/latest/`, `/dev/`, or `/v<version>/` renders `ChannelNotice` instead — a distinct hero explaining which build this is, chips to jump to any other version/channel (`src/lib/showcase-versions.ts`), and a copy-this-URL helper for pasting into Grist's custom widget field. Both render `ScaffoldFooter` (`src/components/scaffold-footer.tsx`) at the bottom — a small, purely informational note ("Scaffolded from `create-grist-widget@X.Y.Z`") built from `package.json`'s `createGristWidgetVersion` field, which the CLI stamps on every real scaffold (`vite.config.ts` injects it as `__CREATE_GRIST_WIDGET_VERSION__`). Renders nothing if that field is absent, e.g. this pristine template source itself.
 
-When actually embedded, `GristStatusChip` (`src/components/grist-status-chip.tsx`) shows a small pill with live handshake status — connecting, retrying with a countdown, connected, or unavailable — using `useAmbientGristHandshake()` from `grist-widget-sdk/advanced`. It must be mounted *inside* `GristWidgetProvider` (see `src/main.tsx`): it only observes that provider's own handshake manager and never mounts a second one, so it's purely observational and can never duplicate or race the real handshake (see `apps/docs/api/handshake.md`).
+When actually embedded, `GristStatusChip` (`src/components/grist-status-chip.tsx`) shows a small pill with live handshake status — connecting, retrying with a countdown, connected, or unavailable — using `useAmbientGristHandshake()` from `grist-widget-sdk/advanced`. It must be mounted *inside* `GristWidgetProvider` (see `src/main.tsx`): it only observes that provider's own handshake manager and never mounts a second one, so it's purely observational and can never duplicate or race the real handshake (see the [handshake API reference](https://gristwidgets.com/docs/sdk/api/handshake)).
 
 `src/App.tsx` uses `useGrist<TaskRow, TaskMapped>()` for the selected row (`w.record`, `w.mode`) and remounts the UI with `key={rowKey}` when the row changes — same pattern as `widgets/create-email-draft`. See `src/grist-types.example.ts` for typing patterns.
 
 - **ESLint** blocks direct `grist` global usage in `src/` — use the SDK only.
 - Uncomment `GRIST_OPTIONS.columns` in `App.tsx` to enable column mapping; `main.tsx` sets `GristBoundary gate="canRender"` when columns are declared. Mapping alerts use `GristSdkAlerts`.
 
-To add widget tests later, see [Testing](https://github.com/ArthurBlanchon/grist-widget-sdk/blob/main/apps/docs/guide/testing.md) (`renderWithGrist` from `grist-widget-sdk/emulator/testing`).
+To add widget tests later, see [Testing](https://gristwidgets.com/docs/sdk/guide/testing) (`renderWithGrist` from `grist-widget-sdk/emulator/testing`).
 
 **Monorepo dev:** this template resolves `grist-widget-sdk` from `packages/core/dist` (like the other widgets), not from SDK source. After changing the SDK, run `pnpm prebuild` or `pnpm --filter grist-widget-sdk build` before `pnpm dev`.
 
@@ -34,29 +34,21 @@ This is the **source** template. It is consumed two ways:
 standalone `pnpm install` (pnpm 11) exits cleanly; inside the monorepo it's
 ignored (the root workspace governs).
 
-### Live preview inside the monorepo (this template's own showcase)
-
-This repo also deploys this template's own **unmodified** source to its own
-GitHub Pages — a live showcase of exactly what `npm create grist-widget`
-scaffolds, at `https://arthurblanchon.github.io/grist-widget-sdk/template/`.
-Same workflow every widget already uses:
-
-- Push template changes to the persistent `dev/template-showcase` branch —
-  every push auto-deploys a live preview at `.../template/dev/` that
-  self-reloads a few seconds later, same as a scaffolded widget's own `dev`
-  channel. Kept around permanently (not deleted after each round), so
-  `.../template/dev/` is always live to preview whatever's currently being
-  iterated on here.
-- Ready to release? **Bump `packages/create-grist-widget/package.json`'s
-  version**, open a PR from your feature branch into `main`, and merge —
-  merging is what actually publishes `.../template/v<version>/` +
-  `.../template/latest/` (and a real `create-grist-widget` npm release,
-  since that package embeds this template verbatim — see
-  `scripts/build-template.mjs`). Merging without a version bump publishes
-  nothing (same idempotent-skip rule as every other deploy pipeline here).
-
-See `scripts/deploy/template-showcase.mjs` + `.github/workflows/
-deploy-template-showcase.yml` (monorepo root) for the pipeline itself.
+### Live preview
+
+This template has no live-preview deploy of its own inside this monorepo —
+that used to exist (a `/template/` showcase on this repo's own GitHub
+Pages) but has been retired. The only live preview of this template's
+current source is external: `template-canary.yml` scaffolds it via the
+*published* `create-grist-widget` package and pushes to the `dev` and
+`canary/latest` branches of
+[`grist-widget-template`](https://github.com/ArthurBlanchon/grist-widget-template)
+after every release — see https://gristwidgets.com/docs/contributing/releasing for the full
+mechanism. There is no live preview of *unreleased* changes to this
+template; to try one locally, scaffold from your working tree with
+`pnpm --filter create-grist-widget build` (embeds this template verbatim —
+see `scripts/build-template.mjs`) and run the packed CLI against a scratch
+directory, same as `scripts/smoke/create-widget.sh` does.
 
 ## Deployment
 

package/template/package.json

@@ -13,7 +13,7 @@
   },
   "dependencies": {
     "@fontsource-variable/geist": "^5.2.8",
-    "grist-widget-sdk": "^0.3.0",
+    "grist-widget-sdk": "^0.3.3",
     "@tailwindcss/vite": "^4.2.1",
     "class-variance-authority": "^0.7.1",
     "clsx": "^2.1.1",