create-shapio 0.5.0 → 0.5.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-shapio",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "Scaffold a new Shapio project (npx create-shapio my-cms) or a site starter (--site astro|next|sveltekit)",
   "license": "Apache-2.0",
   "homepage": "https://shapio.dev",

package/templates/astro/.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/astro/README.md

@@ -17,7 +17,25 @@ npm run smoke:http  # checks the served pages over HTTP (in another terminal, wh
 
 `npm run seed` applies the models in `shapio/` to Shapio live, creates the content and writes `SHAPIO_URL` and
 `SHAPIO_DELIVERY_TOKEN` to `.env`. Other settings (`SHAPIO_SNAPSHOT`, `SHAPIO_SITE`, `PUBLIC_SHAPIO_URL`) are
-in `.env.example`. Astro's telemetry is turned off in the npm scripts.
+in `.env.example`. Settings are read from the environment and `.env` only (not `.env.local` or
+`.env.production`). Astro's telemetry is turned off in the npm scripts.
+
+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:4321; 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).
+
+Incremental builds: `npm run build` re-renders only the pages whose data or code changed and restores the rest
+from the previous build (Astro's `experimental.incrementalBuild`; each page's `cacheKey` is a digest of what it
+renders, `src/lib/cacheKey.ts`). The cache is `node_modules/.astro`: on Cloudflare Pages, turn on build caching
+(Settings → Builds → Build cache) so it survives between builds; without it every build is a full one.
+`npm run check:incremental` checks this against the seeded Shapio (it publishes one edit and puts it back).
+`npm run build:incremental` is a local and CI tool on top: it skips the build entirely when nothing the site
+reads changed since the `dist/` on disk, and always builds where there is none.
 
 Preview: the seed creates a deployment connection named **Preview** that opens drafts at
 `http://localhost:4321/preview/` (set `SITE_URL` when seeding for another address). Add that origin to Shapio's

package/templates/astro/astro.config.mjs

@@ -47,4 +47,11 @@ export default defineConfig({
   build: { format: 'directory' },
   server: { headers: { 'Content-Security-Policy': FRAME_ANCESTORS } },
   integrations: [frameAncestorsHeaders],
+  /**
+   * Incremental builds: a page whose `cacheKey` (src/lib/cacheKey.ts) and code are unchanged is restored from
+   * the previous build instead of rendered. The cache lives in Astro's cacheDir, `node_modules/.astro`, which
+   * Cloudflare Pages build caching (Settings → Builds → Build cache) restores between builds. Do not set
+   * `cacheDir`: the cache would silently stop surviving there, and every build would render every page.
+   */
+  experimental: { incrementalBuild: true },
 });

package/templates/astro/package.json

@@ -13,19 +13,23 @@
     "preview": "ASTRO_TELEMETRY_DISABLED=1 astro preview",
     "seed": "node --env-file-if-exists=.env --import tsx scripts/seed.ts --site-url http://localhost:4321",
     "smoke": "node --env-file-if-exists=.env --import tsx scripts/smoke.ts",
+    "smoke:drafts": "node --env-file-if-exists=.env --import tsx scripts/smokeDrafts.ts --url http://localhost:4321",
     "smoke:http": "node --import tsx scripts/smokeHttp.ts --url http://localhost:4321",
     "report-status": "node --env-file-if-exists=.env --import tsx scripts/reportStatus.ts",
     "build:incremental": "node --env-file-if-exists=.env --import tsx scripts/incrementalBuild.ts",
-    "typecheck": "tsc -p tsconfig.json"
+    "check:incremental": "node --env-file-if-exists=.env --import tsx scripts/incrementalCheck.ts",
+    "typecheck": "tsc -p tsconfig.json",
+    "test": "vitest run"
   },
   "dependencies": {
-    "@shapio/client": "^0.5.0",
-    "@shapio/visual": "^0.5.0",
+    "@shapio/client": "^0.5.2",
+    "@shapio/visual": "^0.5.2",
     "astro": "7.3.5"
   },
   "devDependencies": {
     "@types/node": "24.19.1",
     "tsx": "4.23.15",
-    "typescript": "6.0.3"
+    "typescript": "6.0.3",
+    "vitest": "5.0.3"
   }
 }

package/templates/astro/scripts/incrementalBuild.ts

@@ -1,10 +1,12 @@
 import { spawn } from 'node:child_process';
+import { existsSync } from 'node:fs';
 import { readFile } from 'node:fs/promises';
 import { resolve } from 'node:path';
 import { createClient, ShapioApiError, type SnapshotChange } from '@shapio/client';
 
 /**
- * `npm run build:incremental [--dry-run]`: builds only when content changed.
+ * `npm run build:incremental [--dry-run]`: skips a build that would change nothing. A local and CI tool, for
+ * machines where `dist/` survives between builds.
  *
  * It asks Shapio what changed between the snapshot the last build showed (`dist/build.json`, or
  * SHAPIO_FROM_SNAPSHOT) and the current one (`/api/snapshots/changes`), prints the routes those changes
@@ -12,6 +14,11 @@ import { createClient, ShapioApiError, type SnapshotChange } from '@shapio/clien
  * schema change between the two snapshots, or no previous build, means a full rebuild. The printed routes
  * are what a server-rendered site would revalidate (documentation/snapshots.md shows `revalidatePath`).
  *
+ * The per-page work is Astro's: the build itself restores every page whose data and code are unchanged
+ * (`experimental.incrementalBuild`, src/lib/cacheKey.ts). This script only decides whether to build at all, and
+ * it never skips without a `dist/` to keep: on a host that starts every build from a fresh checkout (Cloudflare
+ * Pages, Netlify), a skipped build would leave nothing to deploy, so there it always builds.
+ *
  * Settings: SHAPIO_URL and SHAPIO_DELIVERY_TOKEN (as for `npm run build`), SHAPIO_FROM_SNAPSHOT (optional).
  */
 const DIST_BUILD_INFO = resolve(import.meta.dirname, '../dist/build.json');
@@ -108,7 +115,10 @@ const main = async () => {
   const say = (line: string) => process.stdout.write(`${line}\n`);
 
   if (from === undefined) {
-    say(`No previous build: building everything at snapshot ${to}.`);
+    say(`No previous build: building at snapshot ${to}.`);
+  } else if (!existsSync(DIST_BUILD_INFO)) {
+    // SHAPIO_FROM_SNAPSHOT without the build it names: skipping would leave no dist/ to deploy.
+    say(`No dist/ from snapshot ${from} here: building at snapshot ${to}.`);
   } else if (from === to) {
     say(`Nothing published since snapshot ${from}: skipping the build.`);
     return;
@@ -125,7 +135,9 @@ const main = async () => {
       for (const change of diff.items) {
         (await routesOf(change, from, to)).forEach((route) => routes.add(route));
       }
-      say(`Snapshots ${from} → ${to}: ${diff.items.length} changed entries; routes to refresh:`);
+      say(
+        `Snapshots ${from} → ${to}: ${diff.items.length} changed entries; the routes they touch (the build re-renders only pages whose data changed):`,
+      );
       [...routes].sort().forEach((route) => say(`  ${route}`));
     }
   }

package/templates/astro/scripts/incrementalCheck.ts

@@ -0,0 +1,218 @@
+import { spawn } from 'node:child_process';
+import { cp, mkdtemp, readdir, readFile, rm } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import { join, relative, resolve } from 'node:path';
+import { createClient } from '@shapio/client';
+import { connectAdmin, type AdminConnection } from './lib/admin.js';
+
+/**
+ * `npm run check:incremental`, after `npm run seed`: checks Astro's incremental build end to end against a running
+ * Shapio. Each step runs `astro build`:
+ * 1. a full build (`--force`), kept as the reference;
+ * 2. the same snapshot again: every keyed page is restored, and dist/ matches the reference except build.json
+ *    (its `builtAt` changes on every build);
+ * 3. the same content pinned with SHAPIO_SNAPSHOT (as a webhook-triggered build is): every keyed page is still
+ *    restored, so no setting's value leaks into the code Astro hashes;
+ * 4. one article's English title edited and published: only that page re-renders among the keyed ones, with the
+ *    new title (the title is put back afterwards);
+ * 5. the cache removed: a full build, nothing restored.
+ * Changes content (and puts it back): run it after anything else that reads the seeded site. Needs
+ * SHAPIO_ADMIN_EMAIL and SHAPIO_ADMIN_PASSWORD (or SHAPIO_TOKEN) to publish the edit, as the seed does.
+ */
+const ROOT = resolve(import.meta.dirname, '..');
+const DIST = join(ROOT, 'dist');
+const CACHE_DIR = join(ROOT, 'node_modules', '.astro');
+const MANIFEST = join(CACHE_DIR, 'incremental-build.json');
+const ARTICLE = 'modelling-without-a-deploy';
+const EDITED_PAGE = `en/articles/${ARTICLE}/index.html`;
+/** Always rendered, and carries the build time: the only file two builds of one snapshot may differ in. */
+const TIMESTAMPED = new Set(['build.json']);
+/** How long a publish may take to become the current snapshot: polled, so a fast server costs nothing. */
+const SNAPSHOT_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 say = (line: string) => process.stdout.write(`${line}\n`);
+
+/** Runs `astro build` (with `npm run build`, as a site's host does) and returns its output. */
+const build = (args: string[] = [], env: NodeJS.ProcessEnv = {}) =>
+  new Promise<string>((resolveBuild, reject) => {
+    const child = spawn('npm', ['run', 'build', '--', ...args], {
+      cwd: ROOT,
+      env: { ...process.env, ...env, FORCE_COLOR: '0', NO_COLOR: '1' },
+    });
+    let output = '';
+    child.stdout.on('data', (chunk: Buffer) => (output += chunk.toString()));
+    child.stderr.on('data', (chunk: Buffer) => (output += chunk.toString()));
+    child.on('error', reject);
+    child.on('exit', (code) =>
+      code === 0 ? resolveBuild(output) : reject(new Error(`astro build exited with ${code}:\n${output}`)),
+    );
+  });
+
+type Manifest = { routes: Record<string, { paths: Record<string, { outputFile: string }> }> };
+
+/** The output files of every keyed page (a page whose getStaticPaths entry has a cacheKey). */
+const keyedFiles = async (): Promise<string[]> => {
+  const manifest = JSON.parse(await readFile(MANIFEST, 'utf8')) as Manifest;
+  return Object.values(manifest.routes)
+    .flatMap((route) => Object.values(route.paths).map((path) => path.outputFile))
+    .sort();
+};
+
+/** How a build treated each keyed page: Astro logs `├─ /<file> (restored)` for one it did not render. */
+const outcomes = (output: string, files: string[]) => {
+  const lines = output.split('\n');
+  const restored = files.filter((file) =>
+    lines.some((line) => line.includes(` /${file} `) && /\((restored|cached)\)/.test(line)),
+  );
+  return { restored, rendered: files.filter((file) => !restored.includes(file)) };
+};
+
+const listTree = async (root: string): Promise<string[]> =>
+  (await readdir(root, { recursive: true, withFileTypes: true }))
+    .filter((entry) => entry.isFile())
+    .map((entry) => relative(root, join(entry.parentPath, entry.name)).split('\\').join('/'))
+    .sort();
+
+/** Files that differ between two output directories (missing on either side, or different bytes). */
+const differences = async (left: string, right: string): Promise<string[]> => {
+  const [a, b] = await Promise.all([listTree(left), listTree(right)]);
+  const all = [...new Set([...a, ...b])].sort();
+  const differing: string[] = [];
+  for (const file of all) {
+    if (!a.includes(file) || !b.includes(file)) {
+      differing.push(file);
+      continue;
+    }
+    const [x, y] = await Promise.all([readFile(join(left, file)), readFile(join(right, file))]);
+    if (!x.equals(y)) {
+      differing.push(file);
+    }
+  }
+  return differing;
+};
+
+const delivery = () => {
+  const token = process.env.SHAPIO_DELIVERY_TOKEN;
+  if (!token) {
+    throw new Error('Set SHAPIO_DELIVERY_TOKEN (npm run seed writes it to .env)');
+  }
+  return createClient({ baseUrl: process.env.SHAPIO_URL ?? 'http://localhost:4300', token });
+};
+
+/** Waits until the current snapshot is past `after` (a real condition, not a fixed wait). */
+const waitForSnapshotAfter = async (after: number) => {
+  const deadline = Date.now() + SNAPSHOT_WITHIN_MS;
+  while (Date.now() < deadline) {
+    const { snapshot } = await delivery().snapshots.current();
+    if (snapshot > after) {
+      return snapshot;
+    }
+    await new Promise((resolveWait) => setTimeout(resolveWait, POLL_EVERY_MS));
+  }
+  throw new Error(`No snapshot after ${after} within ${SNAPSHOT_WITHIN_MS} ms of publishing`);
+};
+
+/** Saves and publishes the article's English title; returns a function that publishes the old one again. */
+const publishTitle = async ({ client }: AdminConnection, 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;
+  const publish = async (expectedVersion: number, value: unknown) => {
+    const before = (await delivery().snapshots.current()).snapshot;
+    const saved = await client.admin.content.update('article', item.id, {
+      locale: 'en',
+      expectedVersion,
+      data: { title: value },
+    });
+    await client.admin.content.publish('article', item.id, { locales: ['en'] });
+    await waitForSnapshotAfter(before);
+    return saved.version;
+  };
+  const version = await publish(entry.version, title);
+  return () => publish(version, original);
+};
+
+const main = async () => {
+  const reference = await mkdtemp(join(tmpdir(), 'shapio-astro-incremental-'));
+  const admin = await connectAdmin(process.env);
+  try {
+    say('1. Full build (--force)');
+    await build(['--force']);
+    await cp(DIST, reference, { recursive: true });
+    const keyed = await keyedFiles();
+    check(keyed.length > 0, `${keyed.length} keyed pages recorded in the cache`);
+
+    say('2. The same snapshot again');
+    const second = outcomes(await build(), keyed);
+    check(
+      second.rendered.length === 0,
+      `${second.restored.length}/${keyed.length} keyed pages restored${second.rendered.length > 0 ? `; rendered: ${second.rendered.join(', ')}` : ''}`,
+    );
+    const changed = await differences(reference, DIST);
+    check(
+      changed.every((file) => TIMESTAMPED.has(file)),
+      `dist/ matches the full build except build.json (differs: ${changed.join(', ') || 'nothing'})`,
+    );
+
+    say('3. The same content, pinned with SHAPIO_SNAPSHOT');
+    const { snapshot } = await delivery().snapshots.current();
+    const pinned = outcomes(await build([], { SHAPIO_SNAPSHOT: String(snapshot) }), keyed);
+    check(
+      pinned.rendered.length === 0,
+      `${pinned.restored.length}/${keyed.length} keyed pages restored with SHAPIO_SNAPSHOT=${snapshot}${pinned.rendered.length > 0 ? `; rendered: ${pinned.rendered.join(', ')}` : ''}`,
+    );
+
+    say('4. One article edited and published');
+    const marker = `Incremental check ${Date.now()}`;
+    const restore = await publishTitle(admin, marker);
+    try {
+      const third = outcomes(await build(), keyed);
+      check(
+        third.rendered.length === 1 && third.rendered[0] === EDITED_PAGE,
+        `only ${EDITED_PAGE} re-rendered among keyed pages (rendered: ${third.rendered.join(', ') || 'none'}; restored ${third.restored.length})`,
+      );
+      check(
+        (await readFile(join(DIST, EDITED_PAGE), 'utf8')).includes(marker),
+        `${EDITED_PAGE} has the new title`,
+      );
+    } finally {
+      await restore();
+    }
+
+    say('5. No cache');
+    await rm(CACHE_DIR, { recursive: true, force: true });
+    const fourth = await build();
+    check(!/\((restored|cached)\)/.test(fourth), 'a build without the cache renders every page');
+    const afterRestore = await differences(reference, DIST);
+    check(
+      afterRestore.every((file) => TIMESTAMPED.has(file)),
+      `with the title put back, dist/ matches the first build except build.json (differs: ${afterRestore.join(', ') || 'nothing'})`,
+    );
+  } finally {
+    await admin.close();
+    await rm(reference, { recursive: true, force: true });
+  }
+
+  if (failures.length > 0) {
+    throw new Error(`${failures.length} check(s) failed`);
+  }
+  say('Incremental build check passed.');
+};
+
+main().catch((error: unknown) => {
+  process.stderr.write(`check:incremental: ${error instanceof Error ? error.message : String(error)}\n`);
+  process.exitCode = 1;
+});

package/templates/astro/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/astro/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/astro/src/layouts/Base.astro

@@ -1,8 +1,8 @@
 ---
 import '../styles/site.css';
 import type { SeoResolved } from '@shapio/client';
+import { layoutInputs } from '../lib/layoutInputs.js';
 import { seoHead, type SeoHead } from '../lib/seo.js';
-import { getSite, getSiteSettings } from '../lib/shapio.js';
 import {
   articlesPath,
   colophonPath,
@@ -30,12 +30,13 @@ const { title, seo, type, locale, alternatePath, noindex = false } = Astro.props
 const strings = stringsFor(locale);
 const other = otherLocale(locale);
 // The name, tagline and footer come from the siteSettings singleton (the built-in strings until it is published).
-const settings = await getSiteSettings(locale);
+// Read through layoutInputs, which keyed pages fold into their cacheKey (src/lib/cacheKey.ts).
+const { settings, site, env } = await layoutInputs(locale);
 const siteName = settings?.siteName ?? strings.siteName;
 // Title, description, social tags and canonical: the entry's SEO fields over the site's SEO defaults.
 const head = seoHead({
   seo: seo ?? null,
-  site: await getSite(),
+  site,
   locale,
   localeChain: [locale, DEFAULT_LOCALE],
   title,
@@ -90,5 +91,12 @@ const robotsNoindex = noindex || head.noindex;
     <footer class="site-footer">
       <p>{siteName} · {settings?.footer ?? 'Built with Shapio'} · Astro</p>
     </footer>
+    {
+      env.drafts ? (
+        <p class="drafts-badge" title={strings.draftsNote} data-shapio-drafts="">
+          {strings.drafts}
+        </p>
+      ) : null
+    }
   </body>
 </html>