@eifi1/ui-kit 0.42.0 → 0.43.0

package/src/tour/tour-catalogue.tsx

@@ -0,0 +1,316 @@
+import { useId, type ReactNode } from "react";
+import { Circle, CircleCheck, Clock, Play } from "lucide-react";
+import { cn } from "../lib/cn";
+import { useKitFormat } from "../lib/format";
+import { foldForSearch } from "../lib/text-match";
+import { useKitLabels, type LabelOverride } from "../i18n/kit-labels";
+import { Button } from "../components/button";
+import { Card } from "../components/card";
+import { Chip } from "../components/chip";
+import { Caption } from "../components/text";
+import { EmptyState } from "../components/empty-state";
+import { SearchField } from "../components/search-field";
+import { Select } from "../components/select";
+import { ToggleGroup } from "../components/toggle-group";
+import { DEFAULT_TOUR_CATALOGUE_LABELS, type TourCatalogueLabels } from "./tour-catalogue-labels";
+import { isTourDone, isTourNew, isTourReset, type TourCompletions, type TourGroup, type TourInfo } from "./tour-info";
+import type { TourCatalogueFilter, TourStateFilter } from "./use-tour-url-sync";
+
+export { DEFAULT_TOUR_CATALOGUE_LABELS };
+export type { TourCatalogueLabels };
+
+/* ── The card ───────────────────────────────────────────────────────────────── */
+
+export interface TourCatalogueCardProps {
+  tour: TourInfo;
+  /** The completion's ISO timestamp, `null` for one without a date; absent while untaken. */
+  completedAt?: string | null;
+  /** NEW — `isTourNew`. The catalogue works it out; a card on its own is told. */
+  isNew?: boolean;
+  onLaunch: (id: string) => void;
+  /** "Mark as not done". Without it, the link is not drawn. */
+  onReset?: (id: string) => void;
+  /** Formats the completion and update days. Default: the kit's medium date in the provider's locale. */
+  formatDate?: (iso: string) => string;
+  labels?: LabelOverride<TourCatalogueLabels>;
+  className?: string;
+}
+
+/**
+ * One tour's card — keksdose's (tours-page.tsx `TourCard`, dev#557), laid out top to
+ * bottom so the cards sit side by side: the state icon beside a column holding the tour's
+ * icon, title, NEW (or "Updated", §8) and the app's `badge`, the one-liner and, from `sm`,
+ * the longer account. The foot is pinned to the bottom edge, so every Start in a row of
+ * cards lands on one line: the points chip, the step count and the duration, the
+ * completion (or reset) line, "Mark as not done" and Start / Replay. Points, steps and
+ * duration are each left out when the tour has none — no gap, no "0 points" (KS).
+ */
+export function TourCatalogueCard({
+  tour,
+  completedAt,
+  isNew = false,
+  onLaunch,
+  onReset,
+  formatDate: formatDateProp,
+  labels: labelsProp,
+  className,
+}: TourCatalogueCardProps) {
+  const words = useKitLabels("tourCatalogue", DEFAULT_TOUR_CATALOGUE_LABELS, labelsProp);
+  const { formatDate } = useKitFormat();
+  const day = formatDateProp ?? ((iso: string) => formatDate(iso, "medium"));
+  const titleId = useId();
+  const done = isTourDone(tour, completedAt);
+  const reset = isTourReset(tour, completedAt);
+  const hasFacts = tour.points != null || tour.steps != null || tour.duration != null;
+  const note = done
+    ? completedAt
+      ? words.completedOn(day(completedAt))
+      : words.completed
+    : reset && tour.updated
+      ? words.resetOn(day(tour.updated.date), tour.updated.reason)
+      : null;
+
+  return (
+    <Card className={cn("flex h-full flex-col p-4", className)}>
+      {/* Title, one-liner and the long body share ONE left edge, in the column beside the
+          state icon. */}
+      <div className="flex flex-1 items-start gap-3">
+        <div className={cn("mt-0.5 shrink-0", done ? "text-success" : "text-muted")}>
+          {done ? <CircleCheck aria-hidden className="size-5" /> : <Circle aria-hidden className="size-5" />}
+          <span className="sr-only">{done ? words.completed : words.notCompleted}</span>
+        </div>
+        <div className="min-w-0 flex-1">
+          <div className="flex flex-wrap items-center gap-2">
+            {tour.icon != null && (
+              <span aria-hidden className="inline-flex shrink-0 text-brand [&_svg]:size-4">
+                {tour.icon}
+              </span>
+            )}
+            {/* The id on the words, not the heading: the Start button is described by them. */}
+            <h3 className="font-medium">
+              <span id={titleId}>{tour.title}</span>
+            </h3>
+            {/* It retires itself the moment the tour is taken — nothing to dismiss. */}
+            {isNew && !reset && (
+              <Chip size="sm" tone="brand" caps className="px-1.5">
+                {words.badgeNew}
+              </Chip>
+            )}
+            {reset && (
+              <Chip size="sm" tone="brand" caps className="px-1.5">
+                {words.badgeUpdated}
+              </Chip>
+            )}
+            {tour.badge}
+          </div>
+          {tour.description && <p className="mt-1 text-sm text-muted">{tour.description}</p>}
+          {/* `hidden sm:block`: one card per row is the phone, where these paragraphs
+              would turn the page into a scroll; the search still reads them. */}
+          {tour.about && <p className="mt-2 hidden text-sm leading-relaxed text-secondary sm:block">{tour.about}</p>}
+        </div>
+      </div>
+      <div className="mt-3 flex flex-wrap items-end justify-between gap-2">
+        <div className="min-w-0">
+          {hasFacts && (
+            <div className="flex flex-wrap items-center gap-1.5">
+              {tour.points != null && (
+                <Chip size="sm" tone="brand">
+                  {words.points(tour.points)}
+                </Chip>
+              )}
+              {tour.steps != null && <Caption as="span">{words.steps(tour.steps)}</Caption>}
+              {tour.duration != null && (
+                <Caption as="span" className="inline-flex items-center gap-1">
+                  <Clock aria-hidden className="size-3" />
+                  {words.duration(tour.duration)}
+                </Caption>
+              )}
+            </div>
+          )}
+          {note && <p className={cn("text-xs text-muted", hasFacts && "mt-1")}>{note}</p>}
+        </div>
+        <div className="flex shrink-0 items-center gap-2">
+          {done && onReset && (
+            <Button variant="link" tone="muted" size="sm" aria-describedby={titleId} onClick={() => onReset(tour.id)}>
+              {words.markUndone}
+            </Button>
+          )}
+          <Button aria-describedby={titleId} onClick={() => onLaunch(tour.id)}>
+            <Play aria-hidden className="size-4" /> {done ? words.replay : words.start}
+          </Button>
+        </div>
+      </div>
+    </Card>
+  );
+}
+
+/* ── The page body ─────────────────────────────────────────────────────────── */
+
+export interface TourCatalogueProps extends TourCatalogueFilter {
+  /** The tours this person may take, already filtered by role and data (§6.3). */
+  tours: readonly TourInfo[];
+  /** The sections, in the app's order. A tour whose group is not here is not listed. */
+  groups: readonly TourGroup[];
+  completed: TourCompletions;
+  /** The account's `created_at`: a tour shipped after it, untaken, is NEW. Unknown → none is. */
+  joined?: string | null;
+  /** A filter changed — `{query}`, `{group}`, `{state}`, or all three for "Clear filters". */
+  onChange: (patch: Partial<TourCatalogueFilter>) => void;
+  onLaunch: (id: string) => void;
+  /** "Mark as not done" — `useTourProgress().reset`. */
+  onReset?: (id: string) => void;
+  /** Above the filter bar: the app's page header with its points tile (§6.1). */
+  header?: ReactNode;
+  formatDate?: (iso: string) => string;
+  /** The search's locale (case folding). Default: the provider's. */
+  locale?: string;
+  labels?: LabelOverride<TourCatalogueLabels>;
+  className?: string;
+}
+
+const STATE_FILTERS: readonly TourStateFilter[] = ["all", "todo", "done"];
+
+/**
+ * The tours page's body (docs/tours-harmonization.md §2.1, §3) — keksdose's /tours:
+ *
+ * - **The filter bar**: a search, a group select and an all / to do / done toggle,
+ *   stacked below `lg` and side by side from it. Each count is what the OTHER filters
+ *   leave: the toggle counts the search and the group, each group the search and the
+ *   state. Under it, while a filter is on, "Showing X of Y tours".
+ * - **The sections**: one per group, in the app's order — an h2 with its icon and help
+ *   line over a `sm:2 / xl:3` grid of `TourCatalogueCard`s. A group the filters empty is
+ *   hidden; when nothing is left, an empty state with "Clear filters".
+ * - **Controlled**: `query`, `group`, `state` and `onChange`, so the app keeps them in its
+ *   URL (`useTourCatalogueUrlState`).
+ *
+ * A tour reset by an update (§8) is "to do" for the toggle and the counts.
+ */
+export function TourCatalogue({
+  tours,
+  groups,
+  completed,
+  joined,
+  query,
+  group: groupProp,
+  state: stateProp,
+  onChange,
+  onLaunch,
+  onReset,
+  header,
+  formatDate,
+  locale: localeProp,
+  labels: labelsProp,
+  className,
+}: TourCatalogueProps) {
+  const words = useKitLabels("tourCatalogue", DEFAULT_TOUR_CATALOGUE_LABELS, labelsProp);
+  const uid = useId();
+  const { locale: kitLocale } = useKitFormat();
+  const locale = localeProp ?? kitLocale;
+  // A group or state the list does not have is no filter at all (an old link).
+  const group = groups.some((g) => g.id === groupProp) ? groupProp : null;
+  const state = STATE_FILTERS.includes(stateProp) ? stateProp : "all";
+
+  const listed = tours.filter((t) => groups.some((g) => g.id === t.group));
+  const done = (tour: TourInfo) => isTourDone(tour, completed[tour.id]);
+  const needle = foldForSearch(query.trim(), locale);
+  const matchesQuery = (tour: TourInfo) =>
+    !needle || [tour.title, tour.description, tour.about].some((text) => !!text && foldForSearch(text, locale).includes(needle));
+  const inState = (tour: TourInfo) => (state === "all" ? true : state === "done" ? done(tour) : !done(tour));
+  const inGroup = (tour: TourInfo, id: string | null = group) => id === null || tour.group === id;
+
+  const found = listed.filter((t) => matchesQuery(t) && inGroup(t));
+  const foundDone = found.filter(done).length;
+  const visible = found.filter(inState);
+  const groupCount = (id: string | null) => listed.filter((t) => matchesQuery(t) && inState(t) && inGroup(t, id)).length;
+  const filtering = needle.length > 0 || state !== "all" || group !== null;
+  const sections = groups
+    .map((g) => ({ ...g, tours: visible.filter((t) => t.group === g.id) }))
+    .filter((g) => g.tours.length > 0);
+
+  return (
+    <div className={cn("space-y-4", className)}>
+      {header}
+      <div className="flex flex-col gap-2 lg:flex-row lg:items-center">
+        <SearchField
+          className="lg:max-w-xs lg:flex-1"
+          value={query}
+          onChange={(value) => onChange({ query: value })}
+          aria-label={words.searchLabel}
+          placeholder={words.searchPlaceholder}
+        />
+        {/* A select, not a chip per group: on a phone those wrap into rows above the list
+            they filter, and an app may have ten groups (ka F8). Named, not labelled: a
+            floating label makes it taller than the search box beside it (dev #589). */}
+        <Select
+          className="lg:w-60"
+          aria-label={words.groupLabel}
+          value={group ?? ""}
+          onChange={(event) => onChange({ group: event.target.value || null })}
+        >
+          <option value="">{words.groupAll(groupCount(null))}</option>
+          {groups.map((g) => (
+            <option key={g.id} value={g.id}>
+              {words.groupOption(g.title, groupCount(g.id))}
+            </option>
+          ))}
+        </Select>
+        <ToggleGroup
+          value={state}
+          onChange={(value: TourStateFilter) => onChange({ state: value })}
+          aria-label={words.stateLabel}
+          className="lg:w-auto"
+          options={[
+            { value: "all", label: words.stateAll(found.length) },
+            { value: "todo", label: words.stateTodo(found.length - foundDone) },
+            { value: "done", label: words.stateDone(foundDone) },
+          ]}
+        />
+      </div>
+      {filtering && (
+        <p role="status" className="-mt-2 text-xs text-muted">
+          {words.showing(visible.length, listed.length)}
+        </p>
+      )}
+
+      {visible.length === 0 ? (
+        <div className="space-y-3">
+          <EmptyState title={words.noMatches} hint={words.noMatchesHint} />
+          <div className="flex justify-center">
+            <Button variant="secondary" onClick={() => onChange({ query: "", group: null, state: "all" })}>
+              {words.clearFilters}
+            </Button>
+          </div>
+        </div>
+      ) : (
+        // A GRID, never columns: a section holding one card keeps a cell's width.
+        sections.map((section) => (
+          <section key={section.id} aria-labelledby={`${uid}-${section.id}`} className="space-y-3">
+            <h2 id={`${uid}-${section.id}`} className="flex items-center gap-1.5 text-sm font-semibold text-muted">
+              {section.icon != null && (
+                <span aria-hidden className="inline-flex shrink-0 [&_svg]:size-4">
+                  {section.icon}
+                </span>
+              )}
+              {section.title}
+            </h2>
+            {section.help && <p className="-mt-2 text-xs text-muted">{section.help}</p>}
+            <div className="grid gap-3 sm:grid-cols-2 xl:grid-cols-3">
+              {section.tours.map((tour) => (
+                <TourCatalogueCard
+                  key={tour.id}
+                  tour={tour}
+                  completedAt={completed[tour.id]}
+                  isNew={isTourNew({ since: tour.since, joined, completed: completed[tour.id] !== undefined })}
+                  onLaunch={onLaunch}
+                  onReset={onReset}
+                  formatDate={formatDate}
+                  labels={labelsProp}
+                />
+              ))}
+            </div>
+          </section>
+        ))
+      )}
+    </div>
+  );
+}

package/src/tour/tour-info.ts

@@ -0,0 +1,144 @@
+import type { ReactNode } from "react";
+
+/**
+ * The tours an app offers, as data (docs/tours-harmonization.md §2.2, §6) — one list for
+ * the tours page (`TourCatalogue`) and the top bar's `TourMenu`. The step lists stay the
+ * app's own: the kit's engine runs them (`useTour().start`), and this describes them.
+ *
+ * The kit takes finished strings, never i18n keys (§6.3, kk K-1). Role- and data-gated
+ * tours are filtered by the app before they come in; every count counts what it is given
+ * (§6.3, kk K-2, ka F6).
+ */
+export interface TourInfo {
+  /** Stable id: what `onLaunch` gets, the progress key, `?tour=`. */
+  id: string;
+  title: string;
+  /** The one-liner under the title (and what the menu could carry). */
+  description?: string;
+  /** The longer account: which screens it visits, what it explains. Shown from `sm`. */
+  about?: string;
+  /** The tour's icon, drawn at 16px in the brand colour. */
+  icon?: ReactNode;
+  /** The id of its `TourGroup`: the section it is listed under. */
+  group: string;
+  /** The page the tour starts on — `TourMenu`'s "On this page". */
+  route?: string;
+  /** The day it shipped (ISO `YYYY-MM-DD`): what makes it NEW (§6.4). Without it, never NEW. */
+  since?: string;
+  /** The last update or fix (§8): a completion from before `updated.date` no longer counts. */
+  updated?: TourUpdate;
+  /** How many steps it has. Left out, the card shows no step count. */
+  steps?: number;
+  /** The points it awards (§6.1). Left out, the card draws no chip (never "0 points"). */
+  points?: number;
+  /** About how long it takes, in minutes — worded by the kit ("About 3 min", §6.5). */
+  duration?: number;
+  /** A chip beside NEW in the app's words — kastlan's practice mode (§6.5, ka F1). */
+  badge?: ReactNode;
+}
+
+/** A tour's last update or fix (§8). One at a time: a later update replaces it. */
+export interface TourUpdate {
+  /** The day it shipped (ISO `YYYY-MM-DD`). */
+  date: string;
+  /** Why, in a short sentence in the app's words: "The import screen moved; the tour follows it now."
+   *  Only shown (the card's reset line); the reset itself reads `date` alone, so an app that
+   *  keeps a reason KEY on its tour definitions passes those to `complete(tour)` as they are. */
+  reason?: string;
+}
+
+/** A section of the tours page, in the app's words and order (§2.3). An empty one is hidden. */
+export interface TourGroup {
+  id: string;
+  title: string;
+  /** The help line under the heading. */
+  help?: string;
+  /** The heading's icon, drawn at 16px. */
+  icon?: ReactNode;
+}
+
+/**
+ * Which tours are completed and when: tour id → the ISO timestamp of the completion, or
+ * `null` for one recorded without a date (kastlan's old id list, §6.2). A tour that is
+ * not a key is untaken.
+ */
+export type TourCompletions = Readonly<Record<string, string | null>>;
+
+/** The calendar day of an ISO date or timestamp — `"2026-10-17T08:00:00Z"` → `"2026-10-17"`. */
+const dayOf = (iso: string) => iso.slice(0, 10);
+
+/** What a reset reads of a tour (§8): the update's day, nothing else. */
+type TourUpdated = { updated?: { date: string } | null };
+
+const BARE_DAY = /^\d{4}-\d{2}-\d{2}$/;
+
+/** The start of an ISO day (`YYYY-MM-DD`) in THIS device's time zone, as an instant. */
+function startOfLocalDay(day: string): number {
+  const [y, m, d] = dayOf(day).split("-").map(Number);
+  return new Date(y, m - 1, d).getTime();
+}
+
+/** A completion as an instant: a timestamp as written, a bare day from its local start. */
+const instantOf = (iso: string) => (BARE_DAY.test(iso) ? startOfLocalDay(iso) : Date.parse(iso));
+
+/**
+ * Is this tour NEW for the person looking at it (§2.4, §6.4)? It shipped AFTER the
+ * account was opened — compared by calendar day, so a tour shipped on the joining day was
+ * already there to be found — and it is not taken yet. No `since`, or no `joined` date,
+ * is never NEW: a pill that appears late is better than one that flickers, and a first
+ * tour shipped with a feature should not flash NEW at every older account (KS, ka F7).
+ *
+ * `completed` is whether the tour was EVER completed — a tour reset by an update (§8) is
+ * not NEW again; it carries the "Updated" pill instead, and `since` stays its first ship
+ * date.
+ */
+export function isTourNew({
+  since,
+  joined,
+  completed,
+}: {
+  since?: string | null;
+  /** The account's `created_at` (a date or a timestamp); unknown → never NEW. */
+  joined?: string | null;
+  completed?: boolean;
+}): boolean {
+  return !!since && !!joined && dayOf(since) > dayOf(joined) && !completed;
+}
+
+/**
+ * Was this completion reset by an update (§8)? True when the tour carries `updated` and
+ * the completion happened BEFORE the update day began on this device — instants compared:
+ * the completion's timestamp against the start of `updated.date` in local time, so one
+ * taken at 00:30 in Zurich on the update day counts (its UTC day is the day before) — or
+ * has no date at all, which predates any update. A tour never completed (`completedAt`
+ * undefined) is never reset: for that person there is nothing to reset. The check itself
+ * deletes nothing; a new `complete(tour)` replaces the old date.
+ */
+export function isTourReset(tour: TourUpdated, completedAt: string | null | undefined): boolean {
+  if (completedAt === undefined || !tour.updated) return false;
+  return completedAt === null || instantOf(completedAt) < startOfLocalDay(tour.updated.date);
+}
+
+/** Does this completion count — completed, and not reset by a later update (§8)? */
+export function isTourDone(tour: TourUpdated, completedAt: string | null | undefined): boolean {
+  return completedAt !== undefined && !isTourReset(tour, completedAt);
+}
+
+/**
+ * How many of `tours` count as done (§8): the header's "x of y". A tour reset by an update
+ * does not count until it is taken again, as on its card.
+ */
+export function doneCount(tours: readonly ({ id: string } & TourUpdated)[], completed: TourCompletions): number {
+  return tours.filter((tour) => isTourDone(tour, completed[tour.id])).length;
+}
+
+/**
+ * The points earned on `tours` (§6.1, §8): the sum of each done tour's `points`. A reset
+ * tour's points are not earned until it is taken again; a tour without points adds none.
+ */
+export function earnedPoints(
+  tours: readonly ({ id: string; points?: number | null } & TourUpdated)[],
+  completed: TourCompletions,
+): number {
+  return tours.reduce((sum, tour) => sum + (isTourDone(tour, completed[tour.id]) ? (tour.points ?? 0) : 0), 0);
+}

package/src/tour/use-tour-progress.ts

@@ -0,0 +1,198 @@
+import { useCallback, useEffect, useMemo, useRef, useSyncExternalStore } from "react";
+import { readStored, removeStored, writeStored } from "../lib/safe-storage";
+import { isTourDone, type TourCompletions } from "./tour-info";
+
+/**
+ * Which tours this device has completed (docs/tours-harmonization.md §2.6, §6.2) —
+ * keksdose's `tour-progress-store` and kastlan's `completions.ts`, as one hook.
+ *
+ * - **Device storage, the app's key.** `storageKey` is always the app's: an app on shared
+ *   devices scopes it per account (KS, bench PCs), and an app that lists its keys
+ *   (KS `storage-keys.ts`) spells it there. Every access is guarded: a blocked or full
+ *   storage keeps the marks for this page's life instead of throwing.
+ * - **One store, every reader.** A change notifies every hook on the same key in this tab
+ *   (an in-tab emitter) and in other tabs (the `storage` event), so the tours page and
+ *   `TourMenu` agree without a reload (ka F3).
+ * - **`migrate(raw)`** reads an older shape, so nobody loses their done marks at adoption:
+ *   it gets the stored JSON (or the raw text, if it is no JSON) and returns the record for
+ *   a shape it recognises, `undefined` for any other — the kit's own shape included,
+ *   which it then reads itself. keksdose: zustand's `{state: {completed}, version: 1}`;
+ *   kastlan: an array of ids, completed without a date (`null`). It runs only on a stored
+ *   text that is not the kit's shape already, once per text and key, whichever reader
+ *   reads it first; its identity is ignored. **Define `migrate` once, at module level**,
+ *   and hand every reader of the key the same one: readers of one key share one snapshot.
+ * - **Resetting the device** (settings §11): register the key with `reset: () =>
+ *   resetTourProgress(storageKey)`, which clears storage and the page's memory and tells
+ *   every reader in this tab.
+ *
+ * The kit's own shape is the record itself, `{ [id]: ISO | null }`; an empty string reads
+ * as `null` (kastlan's record of 0.42).
+ */
+export interface UseTourProgressOptions {
+  storageKey: string;
+  migrate?: (raw: unknown) => Record<string, string | null> | undefined;
+}
+
+export interface TourProgress {
+  /** Tour id → the completion's ISO timestamp, or `null` when recorded without a date. */
+  completed: TourCompletions;
+  /**
+   * Record a completion. Keeps the FIRST completion's date, so a replay changes nothing —
+   * unless the tour was reset by an update since (§8): pass the tour (`{id, updated}`) and
+   * a completion from before `updated.date` is replaced by today's.
+   *
+   * Returns `true` when this counts as a new completion — the moment to award the tour's
+   * points and show the app's toast (§6.1) — and `false` for a replay.
+   */
+  complete: (tour: string | { id: string; updated?: { date: string } | null }) => boolean;
+  /** "Mark as not done": forget the completion. */
+  reset: (id: string) => void;
+}
+
+/* ── The store: one per key, shared by every hook ───────────────────────────── */
+
+const EMPTY: TourCompletions = Object.freeze({});
+/** In-tab listeners per key. */
+const listeners = new Map<string, Set<() => void>>();
+/** What this page wrote where storage refused to keep it (blocked, full): per key. */
+const memory = new Map<string, string>();
+/**
+ * The last raw text read per key and what it parsed to, so a snapshot keeps its identity:
+ * the same text gives the same object, whichever reader asks and whatever `migrate` it
+ * holds. Several readers of one key with inline `migrate` arrows used to evict each other
+ * here and loop (kastlan B1, 0.43).
+ */
+const cache = new Map<string, { raw: string | null; value: TourCompletions }>();
+
+function emit(key: string) {
+  listeners.get(key)?.forEach((listener) => listener());
+}
+
+function rawOf(key: string): string | null {
+  return memory.get(key) ?? readStored(key);
+}
+
+/** Is this the kit's own shape already: a record whose every value is a string or null? */
+function isKitShape(value: unknown): boolean {
+  if (!value || typeof value !== "object" || Array.isArray(value)) return false;
+  return Object.values(value as Record<string, unknown>).every((at) => at === null || typeof at === "string");
+}
+
+/** The kit's own shape: a record of string or null; anything else is dropped. */
+function fromRecord(value: unknown): TourCompletions | undefined {
+  if (!value || typeof value !== "object" || Array.isArray(value)) return undefined;
+  const out: Record<string, string | null> = {};
+  for (const [id, at] of Object.entries(value as Record<string, unknown>)) {
+    if (at === null || at === "") out[id] = null;
+    else if (typeof at === "string") out[id] = at;
+  }
+  return out;
+}
+
+function parse(raw: string | null, migrate: UseTourProgressOptions["migrate"]): TourCompletions {
+  if (raw === null) return EMPTY;
+  let value: unknown = raw;
+  try {
+    value = JSON.parse(raw);
+  } catch {
+    // Not JSON: `migrate` still sees the text.
+  }
+  if (migrate && !isKitShape(value)) {
+    try {
+      const migrated = migrate(value);
+      if (migrated !== undefined) return fromRecord(migrated) ?? EMPTY;
+    } catch {
+      // A migrate that throws reads as "not a shape it knows".
+    }
+  }
+  return fromRecord(value) ?? EMPTY;
+}
+
+function snapshot(key: string, migrate: UseTourProgressOptions["migrate"]): TourCompletions {
+  const raw = rawOf(key);
+  const hit = cache.get(key);
+  if (hit && hit.raw === raw) return hit.value;
+  const value = parse(raw, migrate);
+  cache.set(key, { raw, value });
+  return value;
+}
+
+function write(key: string, record: TourCompletions) {
+  const raw = JSON.stringify(record);
+  writeStored(key, raw);
+  // Storage refused it (blocked, full): keep it for this page's life instead.
+  if (readStored(key) === raw) memory.delete(key);
+  else memory.set(key, raw);
+  emit(key);
+}
+
+function subscribe(key: string, listener: () => void): () => void {
+  let set = listeners.get(key);
+  if (!set) listeners.set(key, (set = new Set()));
+  set.add(listener);
+  // Another tab wrote (or cleared all storage: `key` null).
+  const onStorage = (event: StorageEvent) => {
+    if (event.key !== null && event.key !== key) return;
+    memory.delete(key);
+    listener();
+  };
+  if (typeof window !== "undefined") window.addEventListener("storage", onStorage);
+  return () => {
+    set.delete(listener);
+    if (typeof window !== "undefined") window.removeEventListener("storage", onStorage);
+  };
+}
+
+/**
+ * Forget every tour completion under `storageKey` on this device: the stored key, what the
+ * page kept in memory where storage refused it, and every reader in this tab moves at
+ * once. For "Reset this device's settings" (settings §11):
+ *
+ *     registerDeviceSetting({ key: TOUR_KEY, kind: "view", reset: () => resetTourProgress(TOUR_KEY) });
+ */
+export function resetTourProgress(storageKey: string): void {
+  removeStored(storageKey);
+  memory.delete(storageKey);
+  cache.delete(storageKey);
+  emit(storageKey);
+}
+
+/** The device's tour completions under `storageKey`; see {@link UseTourProgressOptions}. */
+export function useTourProgress({ storageKey, migrate }: UseTourProgressOptions): TourProgress {
+  // Held, not depended on: an inline arrow is a new function every render, and neither the
+  // snapshot nor the callbacks may change with it.
+  const migrateRef = useRef(migrate);
+  useEffect(() => {
+    migrateRef.current = migrate;
+  });
+  const completed = useSyncExternalStore(
+    useCallback((listener: () => void) => subscribe(storageKey, listener), [storageKey]),
+    () => snapshot(storageKey, migrateRef.current),
+    () => EMPTY,
+  );
+
+  const complete = useCallback(
+    (tour: string | { id: string; updated?: { date: string } | null }) => {
+      const subject = typeof tour === "string" ? { id: tour } : tour;
+      // Read now rather than from the render: two completions in one handler both count.
+      const current = snapshot(storageKey, migrateRef.current);
+      if (isTourDone(subject, current[subject.id])) return false;
+      write(storageKey, { ...current, [subject.id]: new Date().toISOString() });
+      return true;
+    },
+    [storageKey],
+  );
+
+  const reset = useCallback(
+    (id: string) => {
+      const current = snapshot(storageKey, migrateRef.current);
+      if (current[id] === undefined) return;
+      const next = { ...current };
+      delete next[id];
+      write(storageKey, next);
+    },
+    [storageKey],
+  );
+
+  return useMemo(() => ({ completed, complete, reset }), [completed, complete, reset]);
+}