@supersuit/artifacts 0.40.1 → 0.41.0

package/CHANGELOG.md

@@ -3,6 +3,37 @@
 `@supersuit/artifacts`. One entry per version, newest first. Each entry says what changed, how a
 host can tell whether it is affected (DETECTOR), what a host does about it (REMEDY), and the tests.
 
+## 0.41.0
+
+**A reader who may not see a page's history is no longer told its version number.** The line under
+the summary read "Version N · Updated <minute>" to everyone. A page sent to someone reads as a
+message, and "Version 9" on a message tells its reader about eight drafts they were never meant to
+think about. The number now goes with the history: whoever `history` lets see past versions
+(the owner and `admins` by default, every reader under `history: 'everyone'`) sees
+"Version N · Updated <minute>", and everyone else sees "Updated <minute>". There is no new config
+key; the existing `history` setting is the toggle, and its default is off for readers.
+
+- `CoverProps` gains `showVersion: boolean`, true exactly when this reader may see the number. The
+  `meta` node a Cover places already follows it. `version` is still handed over unchanged, so a
+  Cover that draws the number itself keeps drawing it until it reads `showVersion`.
+- A past version's page (`/<id>/v/<n>`) is unchanged: only a reader who may see the history reaches
+  it, so it still names its version.
+
+DETECTOR: a host whose pack has a `Cover` that renders `version`: `rg -n "version" <your packs>`.
+Such a Cover still shows the number to every reader after this release, because the shell cannot
+take a prop away from a pack. A host that relied on every reader seeing the version line and does
+not set `history: 'everyone'` will find the number gone for signed-out readers.
+
+REMEDY: in a Cover that draws the number, draw it only when `showVersion` is true. To show every
+reader the number (and the history with it), set `history: 'everyone'`.
+
+Tests: `src/routes/page-menu.test.tsx` (a visitor, a reader and a stranger get "Updated" with no
+version number; an admin and `history: 'everyone'` get "Version 2 · Updated"),
+`src/routes/extension-points.test.tsx` (a Cover is handed `showVersion` false for a reader and true
+under `history: 'everyone'`), `src/routes/versions.test.tsx` and `src/routes/broadcast.test.tsx`
+(the two tests that pinned the old line now pin the new one). All three new tests failed against
+0.40.1.
+
 ## 0.40.1
 
 **0.40.0 was tagged and never published: this is the first release carrying it.** The publish

package/README.md

@@ -194,7 +194,8 @@ before 0.31.0 has no `declared` and takes its file on its next publish, as every
 
 ## Version history
 
-Every page names its version under the summary, "Version 4 · Updated <minute>", and the page
+Every page says when it was last updated under the summary, and to its admins that line also names
+the version: "Version 4 · Updated <minute>". The page
 menu's **Version history** opens a panel listing every version newest first: its number, the minute it went live in
 the reader's own time zone, and its change note. The panel is drawn over the page (a sheet on a
 phone, a side panel on a desk), so opening it moves no text. Each past version is readable at
@@ -205,9 +206,15 @@ the same password or confidential door as the page itself. A version that does n
 **Past versions are for admins by default (0.21.0).** An earlier draft can hold what the current
 one was edited to remove, so only the page's admins see Version history in the page menu or open
 `/<id>/v/<n>`: the reader signed in as `ownerEmail` or any address in `admins` (case does not
-matter). Everyone else still sees "Version N · Updated <minute>", and a past version is a 404 to
-them. With neither configured, nobody does. `history: 'everyone'` in the config restores the old
-behaviour, where every reader who can open the page reads its history.
+matter). A past version is a 404 to everyone else. With neither configured, nobody does.
+`history: 'everyone'` in the config restores the old behaviour, where every reader who can open
+the page reads its history.
+
+**The version number goes with the history (0.41.0).** A page sent to someone reads as a message,
+and "Version 9" on a message tells its reader about eight drafts. So whoever may not see past
+versions sees only "Updated <minute>" under the summary; admins, and every reader under
+`history: 'everyone'`, see "Version N · Updated <minute>". A pack's `Cover` is handed
+`showVersion` alongside `version`, and draws the number itself only when it is true.
 
 ```ts
 createArtifactRoutes({ ..., ownerEmail: 'owner@example.com', admins: ['editor@example.com'] })

package/lib/brand/pack.d.ts

@@ -84,6 +84,10 @@ export type CoverProps = {
     /** The version line and, for a signed-in reader, who they are signed in as. Unspoken. */
     meta: ReactNode;
     version: number;
+    /** Whether this reader may be shown the version number: true for whoever the host's `history`
+     *  lets see past versions (admins by default), false for everyone else. A Cover that draws
+     *  `version` itself draws it only when this is true; `meta` already follows it. */
+    showVersion: boolean;
     updatedAt: string;
     createdAt: string;
 };

package/lib/routes/artifacts.d.ts

@@ -80,8 +80,9 @@ export type ArtifactRoutesConfig = {
     /** Sign-in emails, besides `ownerEmail`, of the people who administer this host's pages. They
      *  see a page's version history; with `history: 'admins'` (the default) nobody else does. */
     admins?: readonly string[];
-    /** Who sees a page's past versions: the History control under the summary and every
-     *  `/<id>/v/<n>`. `'admins'` (default): only `ownerEmail` and `admins`, signed in; to everyone
+    /** Who sees a page's past versions and its version number: Version history in the page menu,
+     *  every `/<id>/v/<n>`, and "Version N" on the line under the summary (0.41.0; to everyone else
+     *  that line is only "Updated <minute>"). `'admins'` (default): only `ownerEmail` and `admins`, signed in; to everyone
      *  else the History control is absent and a past version is not found, because an earlier draft
      *  can hold what the current one was edited to remove. `'everyone'`: every reader who can open
      *  the page, which was the only behaviour before 0.21.0. */

package/lib/routes/artifacts.js

@@ -408,9 +408,12 @@ export function createArtifactRoutes(config) {
         return store.history(id).catch(() => null);
     }
     /** "Version N · Updated <minute>": the line under the summary. The way into the history is the
-     *  page menu's Version history (0.30.0), for whoever `history` lets see it. */
-    function VersionLine({ n, at }) {
-        return (_jsxs("p", { "data-nospeak": true, className: "mt-4 text-xs opacity-60", children: [`Version ${n} · Updated `, _jsx(UpdatedTime, { iso: at })] }));
+     *  page menu's Version history (0.30.0), for whoever `history` lets see it. The number is part of
+     *  that history, so the same readers see it (0.41.0): to anyone else the line is only "Updated
+     *  <minute>", because a page sent to someone reads as a message, and "Version 9" on a message
+     *  tells its reader about eight drafts they were never meant to think about. */
+    function VersionLine({ n, at, numbered }) {
+        return (_jsxs("p", { "data-nospeak": true, className: "mt-4 text-xs opacity-60", children: [numbered ? `Version ${n} · Updated ` : 'Updated ', _jsx(UpdatedTime, { iso: at })] }));
     }
     /** The source of one version as published: its front matter's identifying lines, then the body,
      *  so it pastes into a session and republishes onto the same page. Quoted as JSON strings, which
@@ -443,7 +446,7 @@ export function createArtifactRoutes(config) {
         const title = v.title ?? a.title;
         const summary = v.summary ?? a.summary;
         const toc = showToc(v.markdown, a.toc) ? tocOf(v.markdown) : [];
-        return (_jsxs(_Fragment, { children: [_jsx(Menu, { a: a, reader: reader, history: history, viewing: n, settings: await settingsFor(a, reader), source: isAdmin(reader) ? sourceOf(a.id, { title, subtitle: v.subtitle, summary, to: v.to }, v.markdown) : null }), toc.length ? _jsx(TocRail, { items: toc }) : null, _jsx("div", { "data-nospeak": true, className: `mx-auto max-w-2xl px-6 ${top ? 'pt-20 sm:pt-24' : 'pt-8'}`, children: _jsxs("p", { "data-version-banner": true, role: "status", className: "rounded-lg border px-4 py-3 text-sm", style: { borderColor: brand.accent }, children: [`You are reading version ${n} of ${of}. `, _jsx("a", { href: pagePath(a.id), className: "underline underline-offset-4", style: { color: brand.accent }, children: "Read the current version" })] }) }), _jsx(Framed, { pack: pack, toc: toc.length ? _jsx(TocInline, { items: toc }) : null, cover: pack.Cover ? (_jsx(pack.Cover, { title: title, subtitle: v.subtitle, summary: summary, to: v.to, markdown: v.markdown, kicker: _jsx(Kicker, { to: v.to, brand: brand }), meta: _jsx(VersionLine, { n: n, at: v.at }), version: n, updatedAt: v.at, createdAt: a.createdAt })) : (_jsxs("div", { className: `mx-auto max-w-2xl px-6 ${top ? 'pt-10 sm:pt-12' : 'pt-10'} pb-8 text-center`, children: [_jsx(Kicker, { to: v.to, brand: brand }), _jsx("h1", { className: "text-4xl sm:text-5xl", style: { fontFamily: brand.type.display, color: brand.ink }, children: title }), v.subtitle ? (_jsx("p", { className: "mx-auto mt-4 max-w-xl text-xl sm:text-2xl", style: { fontFamily: brand.type.display, color: brand.ink }, children: v.subtitle })) : null, _jsx("p", { className: "mx-auto mt-6 max-w-xl text-lg italic opacity-80", children: summary }), _jsx(VersionLine, { n: n, at: v.at })] })), children: _jsx(ArtifactMarkdown, { markdown: v.markdown, simulator: config.simulatorEmbed ? { embed: config.simulatorEmbed } : undefined, messages: config.messagesEmbed ? { embed: config.messagesEmbed } : undefined, definitions: a.definitions, checklist: { artifactId: a.id, accent: brand.accent }, Section: pack.Section, figure: pack.figure }) })] }));
+        return (_jsxs(_Fragment, { children: [_jsx(Menu, { a: a, reader: reader, history: history, viewing: n, settings: await settingsFor(a, reader), source: isAdmin(reader) ? sourceOf(a.id, { title, subtitle: v.subtitle, summary, to: v.to }, v.markdown) : null }), toc.length ? _jsx(TocRail, { items: toc }) : null, _jsx("div", { "data-nospeak": true, className: `mx-auto max-w-2xl px-6 ${top ? 'pt-20 sm:pt-24' : 'pt-8'}`, children: _jsxs("p", { "data-version-banner": true, role: "status", className: "rounded-lg border px-4 py-3 text-sm", style: { borderColor: brand.accent }, children: [`You are reading version ${n} of ${of}. `, _jsx("a", { href: pagePath(a.id), className: "underline underline-offset-4", style: { color: brand.accent }, children: "Read the current version" })] }) }), _jsx(Framed, { pack: pack, toc: toc.length ? _jsx(TocInline, { items: toc }) : null, cover: pack.Cover ? (_jsx(pack.Cover, { title: title, subtitle: v.subtitle, summary: summary, to: v.to, markdown: v.markdown, kicker: _jsx(Kicker, { to: v.to, brand: brand }), meta: _jsx(VersionLine, { n: n, at: v.at, numbered: true }), version: n, showVersion: true, updatedAt: v.at, createdAt: a.createdAt })) : (_jsxs("div", { className: `mx-auto max-w-2xl px-6 ${top ? 'pt-10 sm:pt-12' : 'pt-10'} pb-8 text-center`, children: [_jsx(Kicker, { to: v.to, brand: brand }), _jsx("h1", { className: "text-4xl sm:text-5xl", style: { fontFamily: brand.type.display, color: brand.ink }, children: title }), v.subtitle ? (_jsx("p", { className: "mx-auto mt-4 max-w-xl text-xl sm:text-2xl", style: { fontFamily: brand.type.display, color: brand.ink }, children: v.subtitle })) : null, _jsx("p", { className: "mx-auto mt-6 max-w-xl text-lg italic opacity-80", children: summary }), _jsx(VersionLine, { n: n, at: v.at, numbered: true })] })), children: _jsx(ArtifactMarkdown, { markdown: v.markdown, simulator: config.simulatorEmbed ? { embed: config.simulatorEmbed } : undefined, messages: config.messagesEmbed ? { embed: config.messagesEmbed } : undefined, definitions: a.definitions, checklist: { artifactId: a.id, accent: brand.accent }, Section: pack.Section, figure: pack.figure }) })] }));
     }
     /** A broadcast: one message card. The sender's words at the top, then the media (a video with
      *  sound and controls, photos, a voice note's player, link cards) in the order the words put
@@ -481,8 +484,8 @@ export function createArtifactRoutes(config) {
         const current = a.version ?? (a.versions?.length ?? 0) + 1;
         return (_jsxs(_Fragment, { children: [_jsx(Menu, { a: a, reader: reader, comments: mode !== 'off', history: history, viewing: current, settings: await settingsFor(a, reader), source: isAdmin(reader) ? sourceOf(a.id, a, a.markdown) : null }), toc.length ? _jsx(TocRail, { items: toc }) : null, _jsx("div", { id: "artifact-narration-root", children: await (async () => {
                         const n = a.version ?? (a.versions?.length ?? 0) + 1;
-                        const meta = (_jsxs(_Fragment, { children: [_jsx(VersionLine, { n: n, at: a.updatedAt }), top && reader ? (_jsxs("p", { "data-nospeak": true, "data-reader-line": true, className: "mt-2 text-xs opacity-60", children: [`Signed in as ${reader.email} · `, _jsx("a", { href: switchUrl(a.id), className: "underline", children: "Use a different account" }), ' · ', _jsx("a", { href: signOutUrl(a.id), className: "underline", children: "Sign out" })] })) : null] }));
-                        const header = pack.Cover ? (_jsx(pack.Cover, { title: a.title, subtitle: a.subtitle, summary: a.summary, to: a.to, markdown: a.markdown, kicker: _jsx(Kicker, { to: a.to, brand: brand }), meta: meta, version: n, updatedAt: a.updatedAt, createdAt: a.createdAt })) : (_jsxs("div", { className: `mx-auto max-w-2xl px-6 ${top ? 'pt-24 sm:pt-28' : 'pt-12'} pb-8 text-center`, children: [_jsx(Kicker, { to: a.to, brand: brand }), _jsx("h1", { className: "text-4xl sm:text-5xl", style: { fontFamily: brand.type.display, color: brand.ink }, children: a.title }), a.subtitle ? (_jsx("p", { className: "mx-auto mt-4 max-w-xl text-xl sm:text-2xl", style: { fontFamily: brand.type.display, color: brand.ink }, children: a.subtitle })) : null, _jsx("p", { className: "mx-auto mt-6 max-w-xl text-lg italic opacity-80", children: a.summary }), meta] }));
+                        const meta = (_jsxs(_Fragment, { children: [_jsx(VersionLine, { n: n, at: a.updatedAt, numbered: seesHistory(reader) }), top && reader ? (_jsxs("p", { "data-nospeak": true, "data-reader-line": true, className: "mt-2 text-xs opacity-60", children: [`Signed in as ${reader.email} · `, _jsx("a", { href: switchUrl(a.id), className: "underline", children: "Use a different account" }), ' · ', _jsx("a", { href: signOutUrl(a.id), className: "underline", children: "Sign out" })] })) : null] }));
+                        const header = pack.Cover ? (_jsx(pack.Cover, { title: a.title, subtitle: a.subtitle, summary: a.summary, to: a.to, markdown: a.markdown, kicker: _jsx(Kicker, { to: a.to, brand: brand }), meta: meta, version: n, showVersion: seesHistory(reader), updatedAt: a.updatedAt, createdAt: a.createdAt })) : (_jsxs("div", { className: `mx-auto max-w-2xl px-6 ${top ? 'pt-24 sm:pt-28' : 'pt-12'} pb-8 text-center`, children: [_jsx(Kicker, { to: a.to, brand: brand }), _jsx("h1", { className: "text-4xl sm:text-5xl", style: { fontFamily: brand.type.display, color: brand.ink }, children: a.title }), a.subtitle ? (_jsx("p", { className: "mx-auto mt-4 max-w-xl text-xl sm:text-2xl", style: { fontFamily: brand.type.display, color: brand.ink }, children: a.subtitle })) : null, _jsx("p", { className: "mx-auto mt-6 max-w-xl text-lg italic opacity-80", children: a.summary }), meta] }));
                         return (_jsx(Framed, { pack: pack, toc: toc.length ? _jsx(TocInline, { items: toc }) : null, cover: _jsxs(_Fragment, { children: [perReader?.closesAt && !perReader.owner ? (_jsx(FeedbackWindow, { owner: owner, label: perReader.label, note: perReader.note, group: perReader.group, closesAt: perReader.closesAt })) : perReader?.note ? (_jsx("p", { "data-for-reader": true, className: "mx-auto mt-6 mb-0 max-w-2xl px-6 text-lg", children: `For ${perReader.label}: ${perReader.note}` })) : null, header, a.cover ? (_jsx("div", { className: "mx-auto max-w-2xl px-6 pb-8", children: _jsx("img", { src: a.cover, alt: "", className: "w-full rounded-xl border border-[color:var(--a-line)]" }) })) : null] }), children: _jsx(ArtifactMarkdown, { markdown: a.markdown, definitions: a.definitions, notes: config.state && a.state ? { artifactId: a.id, accent: brand.accent } : undefined, 
                                 // Ticks are kept in the reader's browser on any host; Send needs one that keeps answers.
                                 checklist: { artifactId: a.id, send: !!config.state && !!a.state && Object.hasOwn(a.state.slots, CHECKLIST_SLOT), owner, accent: brand.accent }, Section: pack.Section, figure: pack.figure, simulator: config.simulatorEmbed ? { embed: config.simulatorEmbed } : undefined, messages: config.messagesEmbed ? { embed: config.messagesEmbed } : undefined }) }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supersuit/artifacts",
-  "version": "0.40.1",
+  "version": "0.41.0",
   "description": "Publish markdown as branded, read-aloud pages from a Next.js app: the artifacts store, the route factory, the read-along reader, brand packs, password and confidential pages, and share cards.",
   "license": "MIT",
   "type": "module",