create-shapio 0.5.0 → 0.5.1

package/templates/next/src/lib/config.ts

@@ -16,6 +16,10 @@
  *   function calls in this server process (@shapio/local), from Shapio's database at DATABASE_URL. Previews
  *   and the browser still use SHAPIO_URL. See documentation/in-process.md.
  * - DATABASE_URL: Shapio's own database (PostgreSQL or MySQL), for SHAPIO_MODE=in-process only.
+ * - SHAPIO_DRAFTS: `true` turns on drafts mode, for your development server: every read shows saved drafts
+ *   instead of published content, fresh on every request (no snapshot, no cache), and pages carry a "Drafts"
+ *   badge. The token must be a delivery token whose role grants Read drafts: SHAPIO_DEV_DELIVERY_TOKEN when
+ *   set (`npm run seed` writes one), else SHAPIO_DELIVERY_TOKEN. Never set it in a production environment.
  */
 const read = (name: string): string | undefined => {
   const value = process.env[name];
@@ -24,8 +28,13 @@ const read = (name: string): string | undefined => {
 
 export const shapioUrl = () => read('SHAPIO_URL') ?? 'http://localhost:4300';
 
+/** Drafts mode (SHAPIO_DRAFTS=true): the site reads saved drafts. Never set in production. */
+export const isDraftsMode = () => read('SHAPIO_DRAFTS') === 'true';
+
 export const deliveryToken = () => {
-  const token = read('SHAPIO_DELIVERY_TOKEN');
+  // Drafts mode reads with the development token (Read drafts) when there is one.
+  const token =
+    (isDraftsMode() ? read('SHAPIO_DEV_DELIVERY_TOKEN') : undefined) ?? read('SHAPIO_DELIVERY_TOKEN');
   if (!token) {
     throw new Error(
       'Set SHAPIO_DELIVERY_TOKEN (a Shapio delivery token) to build the site; `npm run seed` writes one to .env',
@@ -76,6 +85,9 @@ export const configuredSnapshot = (): number | undefined => {
  */
 export const isSnapshotPinned = () => process.env.SHAPIO_SNAPSHOT_PINNED === 'true';
 
+/** True under `next dev`. Spelled out so Next inlines it. */
+export const isDevServer = () => process.env.NODE_ENV === 'development';
+
 /** The secret /api/revalidate checks webhook signatures with; undefined when it is not set. */
 export const webhookSecret = () => read('SHAPIO_WEBHOOK_SECRET');
 

package/templates/next/src/lib/revalidation.ts

@@ -1,6 +1,6 @@
 import { ShapioApiError, type SnapshotChange, type SnapshotChangeKind } from '@shapio/client';
 import { revalidatePath, revalidateTag } from 'next/cache';
-import { configuredSnapshot, isSnapshotPinned, siteKey } from './config';
+import { configuredSnapshot, isDraftsMode, isSnapshotPinned, siteKey } from './config';
 import { advanceTo, liveSnapshot } from './liveSnapshot';
 import { log } from './log';
 import { changeTags, siteTags } from './revalidationTags';
@@ -69,6 +69,9 @@ const changedEntries = async (items: readonly SnapshotChange[], from: number, to
 };
 
 const revalidateNow = async (): Promise<RevalidationResult> => {
+  if (isDraftsMode()) {
+    return { skipped: 'drafts mode (SHAPIO_DRAFTS=true) reads drafts, which are never pinned or cached' };
+  }
   if (isSnapshotPinned()) {
     return { skipped: `the build is pinned to snapshot ${configuredSnapshot()} by SHAPIO_SNAPSHOT` };
   }

package/templates/next/src/lib/shapio.ts

@@ -4,9 +4,11 @@ import {
   type DeliverySite,
   type ShapioDeliveryClient,
 } from '@shapio/client';
+import { configuredSnapshot, isDevServer, isDraftsMode } from './config';
 import { liveSnapshot } from './liveSnapshot';
 import { createShapioClient } from './shapioClient';
 import type { Locale } from './site';
+import { createSnapshotResolver } from './snapshotResolver';
 import type { Article, Page, SiteSettings } from './types';
 
 /**
@@ -14,7 +16,10 @@ import type { Article, Page, SiteSettings } from './types';
  * src/lib/shapioClient.ts), at one publication snapshot. Next
  * renders pages in several worker processes, so the snapshot is pinned once in next.config.ts (it sets
  * SHAPIO_SNAPSHOT for the whole build) and every request here sends it. Under `next start`, /api/revalidate
- * moves that snapshot forward (src/lib/liveSnapshot.ts).
+ * moves that snapshot forward (src/lib/liveSnapshot.ts). `next dev` pins nothing: it reads the current snapshot
+ * again once the last read is a second old, so a publish shows on reload (src/lib/snapshotResolver.ts). Drafts
+ * mode (SHAPIO_DRAFTS=true) reads saved drafts, which have no snapshot: no read sends one, and every read is
+ * fresh (the client never caches drafts).
  *
  * The client tags every read with the site, model and entry, and /api/revalidate expires the tags of what
  * changed (src/lib/revalidationTags.ts) as well as the pages. No `next: { cache }` option: reads pinned to a
@@ -36,7 +41,22 @@ const SITE_SETTINGS_FIELDS = ['siteName', 'tagline', 'footer', 'colophon'];
 let client: ShapioDeliveryClient | undefined;
 export const shapio = () => (client ??= createShapioClient());
 
-const snapshot = liveSnapshot;
+let devSnapshot: (() => Promise<number>) | undefined;
+
+/**
+ * The build's snapshot (moved forward by /api/revalidate); under `next dev`, the current one; in drafts mode,
+ * none (drafts cannot be pinned).
+ */
+const snapshot = async (): Promise<number | undefined> =>
+  isDraftsMode()
+    ? undefined
+    : isDevServer()
+      ? (devSnapshot ??= createSnapshotResolver({
+          dev: true,
+          configured: configuredSnapshot(),
+          current: async () => (await shapio().snapshots.current()).snapshot,
+        }))()
+      : liveSnapshot();
 
 /** Every published entry of a collection in one locale, page by page, at the pinned snapshot. */
 const listAll = async <T>(routeKey: string, query: DeliveryListQuery): Promise<T[]> => {
@@ -48,7 +68,7 @@ const listAll = async <T>(routeKey: string, query: DeliveryListQuery): Promise<T
       // its SEO fields with the site's defaults filled in.
       richText: 'html',
       seo: 'resolved',
-      snapshot: snapshot(),
+      snapshot: await snapshot(),
       page,
       pageSize: PAGE_SIZE,
     });
@@ -74,7 +94,7 @@ export const getSiteSettings = async (locale: Locale): Promise<SiteSettings | nu
   try {
     const { data } = await shapio().delivery.singleton<SiteSettings>(SITE_SETTINGS, {
       locale,
-      snapshot: snapshot(),
+      snapshot: await snapshot(),
       fields: SITE_SETTINGS_FIELDS,
       richText: 'html',
     });

package/templates/next/src/lib/shapioClient.ts

@@ -1,17 +1,19 @@
 import { createClient, type ShapioDeliveryClient } from '@shapio/client';
 import { createLocalClient } from '@shapio/local';
-import { databaseUrl, deliveryToken, shapioMode, shapioUrl, siteKey } from './config';
+import { databaseUrl, deliveryToken, isDraftsMode, shapioMode, shapioUrl, siteKey } from './config';
 
 /**
  * The client the site reads with: Shapio's delivery API over HTTP (SHAPIO_MODE=http, the default), or the same
  * API in this process (SHAPIO_MODE=in-process, `@shapio/local`), reading Shapio's database directly. Both
  * expose the same `delivery`, `site` and `snapshots` calls and answer them identically, with the same delivery
- * token deciding what the site may read.
+ * token deciding what the site may read. SHAPIO_DRAFTS=true: drafts mode (`drafts`), saved drafts instead of
+ * published content; Shapio refuses it with DRAFTS_FORBIDDEN unless the token's role grants Read drafts.
  */
 export const createShapioClient = (): ShapioDeliveryClient & { close?: () => Promise<void> } => {
   const site = siteKey();
+  const drafts = isDraftsMode();
   if (shapioMode() === 'in-process') {
-    return createLocalClient({ databaseUrl: databaseUrl(), token: deliveryToken(), site });
+    return createLocalClient({ databaseUrl: databaseUrl(), token: deliveryToken(), site, drafts });
   }
-  return createClient({ baseUrl: shapioUrl(), token: deliveryToken(), site });
+  return createClient({ baseUrl: shapioUrl(), token: deliveryToken(), site, drafts });
 };

package/templates/next/src/lib/site.ts

@@ -19,6 +19,8 @@ const STRINGS = {
     by: 'By',
     switchTo: 'Français',
     skipToContent: 'Skip to content',
+    drafts: 'Drafts',
+    draftsNote: 'Drafts mode: this server shows saved drafts, not the published site.',
     footer: 'Built with Shapio',
     previewBanner: 'Preview: this is a draft, not the published page.',
     previewLoading: 'Loading the draft…',
@@ -32,6 +34,8 @@ const STRINGS = {
     by: 'Par',
     switchTo: 'English',
     skipToContent: 'Aller au contenu',
+    drafts: 'Brouillons',
+    draftsNote: 'Mode brouillons : ce serveur montre les brouillons enregistrés, pas le site publié.',
     footer: 'Construit avec Shapio',
     previewBanner: 'Aperçu : ceci est un brouillon, pas la page publiée.',
     previewLoading: 'Chargement du brouillon…',

package/templates/next/src/lib/snapshotResolver.test.ts

@@ -0,0 +1,64 @@
+import { describe, expect, it, vi } from 'vitest';
+import { cachedRead, createSnapshotResolver, DEV_WINDOW_MS } from './snapshotResolver';
+
+const clock = (start = 0) => {
+  let time = start;
+  return { now: () => time, advance: (ms: number) => (time += ms) };
+};
+
+describe('createSnapshotResolver', () => {
+  it('pins the first snapshot for the whole build', async () => {
+    const { now, advance } = clock();
+    const current = vi.fn().mockResolvedValueOnce(7).mockResolvedValue(8);
+    const snapshot = createSnapshotResolver({ dev: false, configured: undefined, current, now });
+
+    expect(await snapshot()).toBe(7);
+    advance(60 * 60 * 1000);
+    expect(await snapshot()).toBe(7);
+    expect(current).toHaveBeenCalledTimes(1);
+  });
+
+  it('reuses a dev read within the window and reads the current snapshot again after it', async () => {
+    const { now, advance } = clock();
+    const current = vi.fn().mockResolvedValueOnce(7).mockResolvedValue(8);
+    const snapshot = createSnapshotResolver({ dev: true, configured: undefined, current, now });
+
+    expect(await snapshot()).toBe(7);
+    advance(DEV_WINDOW_MS - 1);
+    expect(await snapshot()).toBe(7);
+    expect(current).toHaveBeenCalledTimes(1);
+
+    advance(1);
+    expect(await snapshot()).toBe(8);
+    expect(current).toHaveBeenCalledTimes(2);
+  });
+
+  it('keeps SHAPIO_SNAPSHOT in dev and in builds, without asking Shapio', async () => {
+    const current = vi.fn().mockResolvedValue(8);
+    for (const dev of [true, false]) {
+      const snapshot = createSnapshotResolver({ dev, configured: 3, current });
+      expect(await snapshot()).toBe(3);
+    }
+    expect(current).not.toHaveBeenCalled();
+  });
+});
+
+describe('cachedRead', () => {
+  it('shares one read between calls that overlap it', async () => {
+    const read = vi.fn().mockResolvedValue('value');
+    const cached = cachedRead(read, DEV_WINDOW_MS, clock().now);
+
+    const [first, second] = await Promise.all([cached(), cached()]);
+    expect([first, second]).toEqual(['value', 'value']);
+    expect(read).toHaveBeenCalledTimes(1);
+  });
+
+  it('does not keep a failed read', async () => {
+    const read = vi.fn().mockRejectedValueOnce(new Error('down')).mockResolvedValue('value');
+    const cached = cachedRead(read, Number.POSITIVE_INFINITY, clock().now);
+
+    await expect(cached()).rejects.toThrow('down');
+    expect(await cached()).toBe('value');
+    expect(read).toHaveBeenCalledTimes(2);
+  });
+});

package/templates/next/src/lib/snapshotResolver.ts

@@ -0,0 +1,52 @@
+/**
+ * Which publication snapshot the site reads, and for how long a read is reused. A build pins one snapshot
+ * for all its pages (SHAPIO_SNAPSHOT, else the current one when the build starts). The dev server reads the
+ * current snapshot again once the last read is older than DEV_WINDOW_MS, so a publish shows on reload while
+ * the reads of one page render still share a snapshot.
+ */
+export const DEV_WINDOW_MS = 1000;
+
+/** How long a cached read is reused: for the whole process in a build, DEV_WINDOW_MS in dev. */
+export const cacheWindow = (dev: boolean): number => (dev ? DEV_WINDOW_MS : Number.POSITIVE_INFINITY);
+
+/** `read`, reused for `windowMs` after it starts. A read that fails is not kept: the next call tries again. */
+export const cachedRead = <T>(
+  read: () => Promise<T>,
+  windowMs: number,
+  now: () => number = Date.now,
+): (() => Promise<T>) => {
+  let cached: { value: Promise<T>; at: number } | undefined;
+  return () => {
+    const at = now();
+    if (cached && at - cached.at < windowMs) {
+      return cached.value;
+    }
+    const entry = { value: read(), at };
+    cached = entry;
+    entry.value.catch(() => {
+      if (cached === entry) {
+        cached = undefined;
+      }
+    });
+    return entry.value;
+  };
+};
+
+type SnapshotResolverOptions = {
+  /** True under the dev server. */
+  dev: boolean;
+  /** SHAPIO_SNAPSHOT: when set, the site shows exactly this snapshot, in dev too. */
+  configured: number | undefined;
+  /** Reads Shapio's current publication snapshot. */
+  current: () => Promise<number>;
+  now?: () => number;
+};
+
+/** The snapshot every delivery read sends. */
+export const createSnapshotResolver = ({
+  dev,
+  configured,
+  current,
+  now,
+}: SnapshotResolverOptions): (() => Promise<number>) =>
+  configured === undefined ? cachedRead(current, cacheWindow(dev), now) : () => Promise.resolve(configured);

package/templates/sveltekit/.env.example

@@ -10,3 +10,9 @@ SHAPIO_DELIVERY_TOKEN=
 # PUBLIC_SHAPIO_URL=https://cms.example.com
 # Optional: this site's public origin; pages then carry a canonical URL and og:url.
 # SITE_URL=https://www.example.com
+# Optional, development only: drafts mode. Every read shows saved drafts instead of published content, fresh
+# on every request, with a "Drafts" badge on each page. Needs a delivery token whose role grants Read drafts:
+# SHAPIO_DEV_DELIVERY_TOKEN (`npm run seed` writes one), else SHAPIO_DELIVERY_TOKEN. Never put that token or
+# this flag in a production environment.
+# SHAPIO_DRAFTS=true
+# SHAPIO_DEV_DELIVERY_TOKEN=

package/templates/sveltekit/README.md

@@ -28,6 +28,15 @@ one, read once when prerendering starts); `SHAPIO_SITE` picks the site on a mult
 | `vite.config.ts`             | `frame-ancestors` for the servers and `build/_headers`              |
 | `shapio/`, `scripts/seed.ts` | the models and the seed                                             |
 
+Drafts mode, for your development server: set `SHAPIO_DRAFTS=true` in `.env` and `npm run dev` shows saved
+drafts instead of published content, fresh on every reload, with a **Drafts** badge on every page. Save in
+Shapio, reload, and the change is there; publishing still rebuilds the live site. It reads with
+`SHAPIO_DEV_DELIVERY_TOKEN`, the seed's `<site> dev` token, whose delivery role grants Read drafts (a token
+without it fails with `DRAFTS_FORBIDDEN`). Never put that token or the flag in a production environment.
+`npm run smoke:drafts` checks a running drafts-mode dev server
+(http://localhost:5173; needs `SHAPIO_ADMIN_EMAIL`/`PASSWORD` to save a test change, which it puts back). Guide:
+[drafts mode](https://github.com/mybrokengnome/shapio/blob/main/documentation/starters.md#drafts-mode).
+
 Preview: the seed creates a deployment connection named **Preview** that opens drafts at
 `http://localhost:5173/preview/` (`npm run dev`; set `SITE_URL` when seeding for another address). Add that
 origin to Shapio's `CORS_ORIGINS`. In Shapio's preview pane, clicking the title, body or cover focuses that

package/templates/sveltekit/package.json

@@ -18,11 +18,13 @@
     "prepare": "svelte-kit sync || echo ''",
     "seed": "node --env-file-if-exists=.env --import tsx scripts/seed.ts --site-url http://localhost:5173",
     "smoke": "node --import tsx scripts/smokeHttp.ts --url http://localhost:4173",
-    "typecheck": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --fail-on-warnings"
+    "smoke:drafts": "node --env-file-if-exists=.env --import tsx scripts/smokeDrafts.ts --url http://localhost:5173",
+    "typecheck": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --fail-on-warnings",
+    "test": "vitest run"
   },
   "dependencies": {
-    "@shapio/client": "^0.5.0",
-    "@shapio/visual": "^0.5.0"
+    "@shapio/client": "^0.5.1",
+    "@shapio/visual": "^0.5.1"
   },
   "devDependencies": {
     "@sveltejs/adapter-static": "4.0.0",
@@ -33,6 +35,7 @@
     "svelte-check": "4.7.6",
     "tsx": "4.23.15",
     "typescript": "6.0.3",
-    "vite": "8.3.2"
+    "vite": "8.3.2",
+    "vitest": "5.0.3"
   }
 }

package/templates/sveltekit/scripts/seed.ts

@@ -40,13 +40,16 @@ import { createPng } from './lib/png.js';
  * 5. with `--revalidate-path` (the Next.js starter's /api/revalidate), a webhook named "Site revalidation" that
  *    sends publish, unpublish, delete, change set and schema events to SITE_URL + that path; its signing secret
  *    (rotated on every run, as Shapio shows it only once) is written to .env as SHAPIO_WEBHOOK_SECRET;
- * 6. a delivery role and token for the build, written with SHAPIO_URL to .env in the current directory.
+ * 6. a delivery role and token for the build, written with SHAPIO_URL to .env in the current directory;
+ * 7. a second delivery role and token for development servers, "<site> dev", that may also read drafts (drafts
+ *    mode: SHAPIO_DRAFTS=true), written to .env as SHAPIO_DEV_DELIVERY_TOKEN. Never put it in production.
  */
 const SCHEMA_DIR = resolve(import.meta.dirname, '..', 'shapio');
 const SCHEMA_KINDS = ['models', 'components'] as const;
 const SITE_MODELS = ['page', 'article', 'author', 'siteSettings'];
 const DELIVERY_ROLE_KEY = 'starter-delivery';
 const DELIVERY_TOKEN_NAME = 'starter build';
+const DEV_ROLE_KEY = 'starter-dev';
 const PREVIEW_CONNECTION_NAME = 'Preview';
 /** Where Shapio opens a draft: the starter's /preview/ page, the token in the fragment (never sent to a server). */
 const PREVIEW_PATH = '/preview/?model={modelKey}&id={entryId}&locale={locale}#token={token}';
@@ -308,35 +311,71 @@ const upsertEntry = async (client: ShapioClient, spec: EntrySpec) => {
   log(`${spec.publish ? 'Published' : 'Saved draft'} ${spec.model} ${spec.slug} (en, fr)`);
 };
 
-/** A delivery role that reads the site's models, and a fresh token bound to it (older ones are revoked). */
-const createDeliveryToken = async (client: ShapioClient) => {
+type DeliveryRoleSpec = {
+  key: string;
+  name: string;
+  description: string;
+  tokenName: string;
+  drafts: boolean;
+};
+
+/**
+ * A delivery role that reads the site's models (and, for development servers, their drafts), and a fresh token
+ * bound to it (older ones of the same name are revoked).
+ */
+const createDeliveryToken = async (client: ShapioClient, spec: DeliveryRoleSpec) => {
   const summary = await client.admin.schema.summary();
   const modelIds = summary.definitions
     .filter((definition) => SITE_MODELS.includes(definition.apiKey))
     .map((definition) => definition.id);
-  const permissions = modelIds.map((modelId) => ({
-    action: 'read' as const,
-    modelId,
-    condition: null,
-    fieldIds: null,
-  }));
+  const grant = { condition: null, fieldIds: null };
+  const permissions = [
+    ...modelIds.map((modelId) => ({ action: 'read' as const, modelId, ...grant })),
+    // Read drafts always covers every model; the role still reads only the models above.
+    ...(spec.drafts ? [{ action: 'readDrafts' as const, modelId: null, ...grant }] : []),
+  ];
   const roles = await client.admin.roles.list();
-  const existing = roles.find((role) => role.key === DELIVERY_ROLE_KEY);
+  const existing = roles.find((role) => role.key === spec.key);
   const role = existing
     ? await client.admin.roles.update(existing.id, { expectedVersion: existing.version, permissions })
     : await client.admin.roles.create({
-        key: DELIVERY_ROLE_KEY,
-        name: 'Starter site (delivery)',
-        description: 'Reads published pages, articles, authors and the site settings for the starter build.',
+        key: spec.key,
+        name: spec.name,
+        description: spec.description,
         kind: 'delivery',
         permissions,
       });
   for (const token of await client.admin.tokens.list()) {
-    if (token.name === DELIVERY_TOKEN_NAME && !token.revokedAt) {
+    if (token.name === spec.tokenName && !token.revokedAt) {
       await client.admin.tokens.revoke(token.id);
     }
   }
-  return (await client.admin.tokens.create({ name: DELIVERY_TOKEN_NAME, roleId: role.id })).token;
+  return (await client.admin.tokens.create({ name: spec.tokenName, roleId: role.id })).token;
+};
+
+const BUILD_ROLE: DeliveryRoleSpec = {
+  key: DELIVERY_ROLE_KEY,
+  name: 'Starter site (delivery)',
+  description: 'Reads published pages, articles, authors and the site settings for the starter build.',
+  tokenName: DELIVERY_TOKEN_NAME,
+  drafts: false,
+};
+
+/** The development token's role: the build role plus Read drafts. Named after the site it reads. */
+const devRole = (siteName: string): DeliveryRoleSpec => ({
+  key: DEV_ROLE_KEY,
+  name: 'Starter site dev (drafts)',
+  description:
+    'Reads the starter models and their drafts, for development servers (drafts mode). Never use its tokens in production.',
+  tokenName: `${siteName} dev`,
+  drafts: true,
+});
+
+/** The name of the site the seed works on: SHAPIO_SITE, else the primary site. */
+const siteNameOf = async (client: ShapioClient, siteKey: string | undefined) => {
+  const sites = await client.admin.sites.list();
+  const site = sites.find((candidate) => (siteKey ? candidate.key === siteKey : candidate.isPrimary));
+  return site?.name ?? siteKey ?? 'site';
 };
 
 /** The "Preview" connection, created once and pointed at this starter's /preview/ page on every run. */
@@ -402,24 +441,30 @@ const tryRevalidateWebhook = async (client: ShapioClient, siteUrl: string, path:
   }
 };
 
-const writeEnv = async (
-  url: string,
-  site: string | undefined,
-  deliveryToken: string,
-  webhookSecret: string | undefined,
-) => {
+type SeededEnv = {
+  url: string;
+  site: string | undefined;
+  deliveryToken: string;
+  devDeliveryToken: string;
+  webhookSecret: string | undefined;
+};
+
+const writeEnv = async ({ url, site, deliveryToken, devDeliveryToken, webhookSecret }: SeededEnv) => {
   const path = resolve('.env');
   const lines = [
-    '# Written by the seed. The delivery token is read-only; keep this file out of git.',
+    '# Written by the seed. The delivery tokens are read-only; keep this file out of git.',
     `SHAPIO_URL=${url}`,
     `SHAPIO_DELIVERY_TOKEN=${deliveryToken}`,
+    '# Development only: drafts mode (SHAPIO_DRAFTS=true) reads with this token, which may read drafts.',
+    '# Never put it in a production environment.',
+    `SHAPIO_DEV_DELIVERY_TOKEN=${devDeliveryToken}`,
     // The site the content was seeded on: the starter reads the same one.
     ...(site ? [`SHAPIO_SITE=${site}`] : []),
     ...(webhookSecret ? [`SHAPIO_WEBHOOK_SECRET=${webhookSecret}`] : []),
   ];
   await writeFile(path, `${lines.join('\n')}\n`, { mode: 0o600 });
   log(
-    `Wrote SHAPIO_URL, ${site ? 'SHAPIO_SITE, ' : ''}SHAPIO_DELIVERY_TOKEN${webhookSecret ? ' and SHAPIO_WEBHOOK_SECRET' : ''} to ${path}`,
+    `Wrote SHAPIO_URL, ${site ? 'SHAPIO_SITE, ' : ''}SHAPIO_DELIVERY_TOKEN, SHAPIO_DEV_DELIVERY_TOKEN${webhookSecret ? ' and SHAPIO_WEBHOOK_SECRET' : ''} to ${path}`,
   );
 };
 
@@ -444,7 +489,15 @@ const main = async () => {
     const webhookSecret = revalidatePath
       ? await tryRevalidateWebhook(admin.client, siteUrl, revalidatePath)
       : undefined;
-    await writeEnv(admin.url, admin.site, await createDeliveryToken(admin.client), webhookSecret);
+    const siteName = await siteNameOf(admin.client, admin.site);
+    await writeEnv({
+      url: admin.url,
+      site: admin.site,
+      deliveryToken: await createDeliveryToken(admin.client, BUILD_ROLE),
+      devDeliveryToken: await createDeliveryToken(admin.client, devRole(siteName)),
+      webhookSecret,
+    });
+    log(`Created the "${siteName} dev" token for drafts mode (SHAPIO_DRAFTS=true); keep it off production.`);
     log('Seeded. Build the site with: npm run build');
   } finally {
     await admin.close();

package/templates/sveltekit/scripts/smokeDrafts.ts

@@ -0,0 +1,109 @@
+import { parseArgs } from 'node:util';
+import { connectAdmin } from './lib/admin.js';
+
+/**
+ * `npm run smoke:drafts`, after `npm run seed` and starting the dev server with SHAPIO_DRAFTS=true (drafts mode,
+ * which reads with the seed's SHAPIO_DEV_DELIVERY_TOKEN): checks that the site shows drafts, that every page
+ * carries the "Drafts" badge, and that a change saved in Shapio (not published) shows on the next reload.
+ * The saved change is put back afterwards. Needs SHAPIO_ADMIN_EMAIL and SHAPIO_ADMIN_PASSWORD (or SHAPIO_TOKEN,
+ * an admin API token) to save the change, as the seed does.
+ *
+ * `--url` is the running dev server's origin (default: SMOKE_URL, then http://localhost:3000).
+ */
+const DRAFT_TITLE = 'Coming soon: our winter projects';
+const ARTICLE = 'modelling-without-a-deploy';
+const BADGE = 'data-shapio-drafts';
+/** How long a saved draft may take to show: the dev server reads fresh, so this only absorbs a slow render. */
+const SHOW_WITHIN_MS = 30_000;
+const POLL_EVERY_MS = 250;
+
+const failures: string[] = [];
+const check = (condition: boolean, message: string) => {
+  process.stdout.write(`${condition ? 'ok  ' : 'FAIL'} ${message}\n`);
+  if (!condition) {
+    failures.push(message);
+  }
+};
+
+const fetchPage = async (origin: string, path: string) => {
+  const response = await fetch(new URL(path, origin));
+  return { status: response.status, html: await response.text() };
+};
+
+/** Reloads `path` until it contains `needle` (a real condition, not a fixed wait); false when it never does. */
+const showsWithin = async (origin: string, path: string, needle: string): Promise<boolean> => {
+  const deadline = Date.now() + SHOW_WITHIN_MS;
+  while (Date.now() < deadline) {
+    if ((await fetchPage(origin, path)).html.includes(needle)) {
+      return true;
+    }
+    await new Promise((resolve) => setTimeout(resolve, POLL_EVERY_MS));
+  }
+  return false;
+};
+
+/** Saves (does not publish) the article's English title, and returns a function that puts the old one back. */
+const saveTitle = async (client: Awaited<ReturnType<typeof connectAdmin>>['client'], title: string) => {
+  const [item] = (
+    await client.admin.content.list('article', { locale: 'en', filters: { slug: { $eq: ARTICLE } } })
+  ).items;
+  if (!item) {
+    throw new Error(`The seeded article "${ARTICLE}" is missing; run npm run seed first`);
+  }
+  const entry = await client.admin.content.get('article', item.id, { locale: 'en' });
+  const original = entry.data.title;
+  // A save sends only the fields it changes.
+  const saved = await client.admin.content.update('article', item.id, {
+    locale: 'en',
+    expectedVersion: entry.version,
+    data: { title },
+  });
+  return async () => {
+    await client.admin.content.update('article', item.id, {
+      locale: 'en',
+      expectedVersion: saved.version,
+      data: { title: original },
+    });
+  };
+};
+
+const main = async () => {
+  const { values } = parseArgs({ options: { url: { type: 'string' } } });
+  const origin = values.url ?? process.env.SMOKE_URL ?? 'http://localhost:3000';
+
+  const list = await fetchPage(origin, '/en/articles/');
+  check(list.status === 200, `/en/articles/: HTTP ${list.status}`);
+  check(list.html.includes(BADGE), '/en/articles/: the Drafts badge');
+  check(list.html.includes(DRAFT_TITLE), 'the unpublished draft is listed (drafts mode)');
+  const draft = await fetchPage(origin, '/en/articles/winter-projects/');
+  check(
+    draft.status === 200 && draft.html.includes(DRAFT_TITLE),
+    `the unpublished draft is served (HTTP ${draft.status})`,
+  );
+
+  const admin = await connectAdmin(process.env);
+  try {
+    const marker = `Saved, not published ${Date.now()}`;
+    const restore = await saveTitle(admin.client, marker);
+    try {
+      check(
+        await showsWithin(origin, `/en/articles/${ARTICLE}/`, marker),
+        'a change saved in Shapio shows on reload, without publishing',
+      );
+    } finally {
+      await restore();
+    }
+  } finally {
+    await admin.close();
+  }
+
+  if (failures.length > 0) {
+    throw new Error(`${failures.length} check(s) failed against ${origin}`);
+  }
+  process.stdout.write(`Drafts smoke test passed against ${origin}.\n`);
+};
+
+main().catch((error: unknown) => {
+  process.stderr.write(`smoke:drafts: ${error instanceof Error ? error.message : String(error)}\n`);
+  process.exitCode = 1;
+});

package/templates/sveltekit/src/env.ts

@@ -10,6 +10,8 @@ const optional = (value: string | undefined) => (value === '' ? undefined : valu
 export const variables = defineEnvVars({
   SHAPIO_URL: { schema: optional },
   SHAPIO_DELIVERY_TOKEN: { schema: optional },
+  SHAPIO_DEV_DELIVERY_TOKEN: { schema: optional },
+  SHAPIO_DRAFTS: { schema: optional },
   SHAPIO_SNAPSHOT: { schema: optional },
   SHAPIO_SITE: { schema: optional },
   PUBLIC_SHAPIO_URL: { schema: optional },

package/templates/sveltekit/src/lib/server/config.ts

@@ -1,6 +1,8 @@
 import {
   PUBLIC_SHAPIO_URL,
   SHAPIO_DELIVERY_TOKEN,
+  SHAPIO_DEV_DELIVERY_TOKEN,
+  SHAPIO_DRAFTS,
   SHAPIO_SITE,
   SHAPIO_SNAPSHOT,
   SHAPIO_URL,
@@ -18,14 +20,22 @@ import {
  * - PUBLIC_SHAPIO_URL: the Shapio URL the browser calls for previews (defaults to SHAPIO_URL).
  * - SITE_URL: optional; this site's public origin, e.g. https://www.example.com. Pages then carry a canonical
  *   URL (and `og:url`) unless the entry sets its own.
+ * - SHAPIO_DRAFTS: `true` turns on drafts mode, for your development server: every read shows saved drafts
+ *   instead of published content (no snapshot), and pages carry a "Drafts" badge. The token must be a delivery
+ *   token whose role grants Read drafts: SHAPIO_DEV_DELIVERY_TOKEN when set (`npm run seed` writes one), else
+ *   SHAPIO_DELIVERY_TOKEN. Never set it in a production environment.
  */
 export const shapioUrl = () => SHAPIO_URL ?? 'http://localhost:4300';
 
 /** Handed to the preview page at build time: the URL its browser code reads drafts from. */
 export const publicShapioUrl = () => PUBLIC_SHAPIO_URL ?? shapioUrl();
 
+/** Drafts mode (SHAPIO_DRAFTS=true): the site reads saved drafts. Never set in production. */
+export const isDraftsMode = () => SHAPIO_DRAFTS === 'true';
+
 export const deliveryToken = () => {
-  const token = SHAPIO_DELIVERY_TOKEN;
+  // Drafts mode reads with the development token (Read drafts) when there is one.
+  const token = (isDraftsMode() ? SHAPIO_DEV_DELIVERY_TOKEN : undefined) ?? SHAPIO_DELIVERY_TOKEN;
   if (!token) {
     throw new Error(
       'Set SHAPIO_DELIVERY_TOKEN (a Shapio delivery token) to build the site; `npm run seed` writes one to .env',