forgebook 0.0.0-stage → 0.1.0

package/dist/src/storyBackground.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The colour a story's box waits on while the story loads: its source's page colour for the theme and contrast the
+ * view shows, so the box is not white before a dark story and does not change colour when the story appears; the
+ * colour of the backdrop Forgebook draws instead, when the view sets one (D-652). Pure.
+ *
+ * @module
+ */
+import type { StoryBackground } from "@forgebook/story-format/source";
+import type { CatalogueSettings } from "./catalogue.ts";
+import { type ViewState } from "./viewState.ts";
+/**
+ * A source's page colour for a view, or the colour of the view's backdrop.
+ *
+ * @param background - the source's colours; none when it gives none.
+ * @param view - the switches' values the story is drawn in, and the backdrop behind it.
+ * @param catalogue - the catalogue's switches (its colour scheme, its contrast) and backdrops.
+ * @param isSystemDark - whether the system prefers dark, for the `system` theme.
+ * @returns the CSS colour, or none when the source gives none.
+ */
+export declare const storyBackground: (background: StoryBackground | undefined, view: Pick<ViewState, "switches" | "backdrop">, catalogue: Pick<CatalogueSettings, "switches" | "backdrops">, isSystemDark: boolean) => string | undefined;
+//# sourceMappingURL=storyBackground.d.ts.map

package/dist/src/storyBackground.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storyBackground.d.ts","sourceRoot":"","sources":["../../src/storyBackground.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAGtE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAA8B,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE5E;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAC1B,YAAY,eAAe,GAAG,SAAS,EACvC,MAAM,IAAI,CAAC,SAAS,EAAE,UAAU,GAAG,UAAU,CAAC,EAC9C,WAAW,IAAI,CAAC,iBAAiB,EAAE,UAAU,GAAG,WAAW,CAAC,EAC5D,cAAc,OAAO,KACpB,MAAM,GAAG,SAWX,CAAC"}

package/dist/src/storyBackground.js

@@ -0,0 +1,27 @@
+import { backdropColor } from "./backdrops.js";
+import { isMoreContrastOf, schemeOf } from "./viewState.js";
+/**
+ * A source's page colour for a view, or the colour of the view's backdrop.
+ *
+ * @param background - the source's colours; none when it gives none.
+ * @param view - the switches' values the story is drawn in, and the backdrop behind it.
+ * @param catalogue - the catalogue's switches (its colour scheme, its contrast) and backdrops.
+ * @param isSystemDark - whether the system prefers dark, for the `system` theme.
+ * @returns the CSS colour, or none when the source gives none.
+ */
+export const storyBackground = (background, view, catalogue, isSystemDark) => {
+    const { switches } = catalogue;
+    const scheme = schemeOf(view, switches);
+    const isDark = scheme === "dark" || (scheme === "system" && isSystemDark);
+    const isMoreContrast = isMoreContrastOf(view, switches);
+    const shown = catalogue.backdrops.find((each) => each.id === view.backdrop);
+    const backdrop = backdropColor(shown, isDark);
+    if (backdrop !== undefined)
+        return backdrop;
+    if (background === undefined)
+        return undefined;
+    if (isDark)
+        return isMoreContrast ? (background.darkMore ?? background.dark) : background.dark;
+    return isMoreContrast ? (background.lightMore ?? background.light) : background.light;
+};
+//# sourceMappingURL=storyBackground.js.map

package/dist/src/storyBackground.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storyBackground.js","sourceRoot":"","sources":["../../src/storyBackground.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAkB,MAAM,gBAAgB,CAAC;AAE5E;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,UAAuC,EACvC,IAA8C,EAC9C,SAA4D,EAC5D,YAAqB,EACD,EAAE;IACtB,MAAM,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC;IAC/B,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxC,MAAM,MAAM,GAAG,MAAM,KAAK,MAAM,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,YAAY,CAAC,CAAC;IAC1E,MAAM,cAAc,GAAG,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxD,MAAM,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC5E,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC9C,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC;IAC5C,IAAI,UAAU,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC/C,IAAI,MAAM;QAAE,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC;IAC/F,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC;AACxF,CAAC,CAAC"}

package/dist/src/storyClock.d.ts

@@ -0,0 +1,62 @@
+/**
+ * The story clock's settings, shared by the shell (its controls), the frame (the clock it runs) and the tests (which
+ * hold it): the speeds, the state the controls set, and the address that holds the clock at its start (D-504).
+ *
+ * @remarks
+ * Pure. The clock a story reads is typed in `@forgebook/story-format/clock`; the frame runs it (`frame/frameClock.ts`).
+ * Holding the clock goes through the frame's address, as everything that changes what a frame draws does (one
+ * document per story): the generated and visual tests open a Live story held at its start, so its image never
+ * changes and its play function moves it on with `advance` (D-628).
+ *
+ * @module
+ */
+/** How fast the clock runs against real time: real time, or ten times faster. */
+export type ClockRate = 1 | 10;
+/** Every speed, in the controls' order. */
+export declare const CLOCK_RATES: readonly ClockRate[];
+/** What the shell's clock controls set on a frame's clock. */
+export type ClockState = {
+    /** Whether the clock runs; held, it keeps its moment until resumed or advanced. */
+    readonly isRunning: boolean;
+    /** How fast it runs. */
+    readonly rate: ClockRate;
+};
+/** A Live story's clock when it opens: running, at real time. */
+export declare const DEFAULT_CLOCK_STATE: ClockState;
+/**
+ * A frame's address with its story clock held at its start: what the tests open.
+ *
+ * @param address - the frame's address (`frame.html?story=…`).
+ * @returns the same address, holding the clock.
+ */
+export declare const heldClockAddress: (address: string) => string;
+/**
+ * Whether a frame's address holds its story clock at its start.
+ *
+ * @param search - the address's query (`?story=…&clock=held`).
+ */
+export declare const isClockHeldIn: (search: string) => boolean;
+/**
+ * Whether a value is one of the clock's speeds.
+ *
+ * @param value - any value.
+ */
+export declare const isClockRate: (value: unknown) => value is ClockRate;
+/** Where a running clock stands: its moment at a real instant, and how fast it moves from there. */
+export type ClockReading = {
+    /** The story's moment, in ms since the Unix epoch. */
+    readonly moment: number;
+    /** The real instant it was read at, in ms of the page's monotonic clock (`performance.now()`). */
+    readonly at: number;
+};
+/**
+ * The clock's moment at a later real instant: it moves `rate` times as fast as real time while it runs, not at all
+ * while held, and never backwards.
+ *
+ * @param reading - where it stood.
+ * @param state - whether it runs, and how fast.
+ * @param at - the later real instant, in ms of the same monotonic clock.
+ * @returns where it stands then.
+ */
+export declare const readClock: (reading: ClockReading, state: ClockState, at: number) => ClockReading;
+//# sourceMappingURL=storyClock.d.ts.map

package/dist/src/storyClock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storyClock.d.ts","sourceRoot":"","sources":["../../src/storyClock.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,iFAAiF;AACjF,MAAM,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,CAAC;AAE/B,2CAA2C;AAC3C,eAAO,MAAM,WAAW,EAAE,SAAS,SAAS,EAAY,CAAC;AAEzD,8DAA8D;AAC9D,MAAM,MAAM,UAAU,GAAG;IACvB,mFAAmF;IACnF,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,wBAAwB;IACxB,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;CAC1B,CAAC;AAEF,iEAAiE;AACjE,eAAO,MAAM,mBAAmB,EAAE,UAAyC,CAAC;AAK5E;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,SAAS,MAAM,KAAG,MACqC,CAAC;AAEzF;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,QAAQ,MAAM,KAAG,OACwB,CAAC;AAExE;;;;GAIG;AACH,eAAO,MAAM,WAAW,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,SAAuD,CAAC;AAE9G,oGAAoG;AACpG,MAAM,MAAM,YAAY,GAAG;IACzB,sDAAsD;IACtD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,kGAAkG;IAClG,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,GAAI,SAAS,YAAY,EAAE,OAAO,UAAU,EAAE,IAAI,MAAM,KAAG,YAGhF,CAAC"}

package/dist/src/storyClock.js

@@ -0,0 +1,51 @@
+/**
+ * The story clock's settings, shared by the shell (its controls), the frame (the clock it runs) and the tests (which
+ * hold it): the speeds, the state the controls set, and the address that holds the clock at its start (D-504).
+ *
+ * @remarks
+ * Pure. The clock a story reads is typed in `@forgebook/story-format/clock`; the frame runs it (`frame/frameClock.ts`).
+ * Holding the clock goes through the frame's address, as everything that changes what a frame draws does (one
+ * document per story): the generated and visual tests open a Live story held at its start, so its image never
+ * changes and its play function moves it on with `advance` (D-628).
+ *
+ * @module
+ */
+/** Every speed, in the controls' order. */
+export const CLOCK_RATES = [1, 10];
+/** A Live story's clock when it opens: running, at real time. */
+export const DEFAULT_CLOCK_STATE = { isRunning: true, rate: 1 };
+/** The frame address's parameter that holds the clock at its start, and its value. */
+const HELD_PARAM = { name: "clock", value: "held" };
+/**
+ * A frame's address with its story clock held at its start: what the tests open.
+ *
+ * @param address - the frame's address (`frame.html?story=…`).
+ * @returns the same address, holding the clock.
+ */
+export const heldClockAddress = (address) => `${address}${address.includes("?") ? "&" : "?"}${HELD_PARAM.name}=${HELD_PARAM.value}`;
+/**
+ * Whether a frame's address holds its story clock at its start.
+ *
+ * @param search - the address's query (`?story=…&clock=held`).
+ */
+export const isClockHeldIn = (search) => new URLSearchParams(search).get(HELD_PARAM.name) === HELD_PARAM.value;
+/**
+ * Whether a value is one of the clock's speeds.
+ *
+ * @param value - any value.
+ */
+export const isClockRate = (value) => CLOCK_RATES.some((rate) => rate === value);
+/**
+ * The clock's moment at a later real instant: it moves `rate` times as fast as real time while it runs, not at all
+ * while held, and never backwards.
+ *
+ * @param reading - where it stood.
+ * @param state - whether it runs, and how fast.
+ * @param at - the later real instant, in ms of the same monotonic clock.
+ * @returns where it stands then.
+ */
+export const readClock = (reading, state, at) => {
+    const elapsed = Math.max(0, at - reading.at);
+    return { moment: state.isRunning ? reading.moment + elapsed * state.rate : reading.moment, at };
+};
+//# sourceMappingURL=storyClock.js.map

package/dist/src/storyClock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storyClock.js","sourceRoot":"","sources":["../../src/storyClock.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAKH,2CAA2C;AAC3C,MAAM,CAAC,MAAM,WAAW,GAAyB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAUzD,iEAAiE;AACjE,MAAM,CAAC,MAAM,mBAAmB,GAAe,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;AAE5E,sFAAsF;AACtF,MAAM,UAAU,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAW,CAAC;AAE7D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAU,EAAE,CAC1D,GAAG,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,UAAU,CAAC,IAAI,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;AAEzF;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAc,EAAW,EAAE,CACvD,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,UAAU,CAAC,KAAK,CAAC;AAExE;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAc,EAAsB,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC;AAU9G;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,OAAqB,EAAE,KAAiB,EAAE,EAAU,EAAgB,EAAE;IAC9F,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IAC7C,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC;AAClG,CAAC,CAAC"}

package/dist/src/storyGlobals.d.ts

@@ -0,0 +1,60 @@
+/**
+ * What a story fixes of the view, as Storybook's stories write it: switches by its `globals` (`{ theme: "dark" }`),
+ * the background by `globals.backgrounds` or `parameters.backgrounds.default`, the width by `globals.viewport` or
+ * `parameters.viewport.defaultViewport`.
+ *
+ * @remarks
+ * A story that fixes a value is drawn with it whatever the toolbar says, and the toolbar shows it as set by the story,
+ * as Storybook locks a global a story sets. Only values the catalogue has are taken: a switch's value among its
+ * values, a background by its id or name, a width by its preset's name or its number. The address keeps the user's
+ * own view, so another story shows it again. Pure.
+ *
+ * @module
+ */
+import type { CatalogueSettings } from "./catalogue.ts";
+import type { ViewState } from "./viewState.ts";
+/** What a story fixes of the view; an empty `switches` and nothing else when it fixes nothing. */
+export type FixedView = {
+    /** The switches it fixes, by id. */
+    readonly switches: Readonly<Record<string, string>>;
+    /** The backdrop it fixes, by id. */
+    readonly backdrop?: string;
+    /** The width it fixes, in CSS px. */
+    readonly width?: number;
+};
+/** A story that fixes nothing. */
+export declare const NOT_FIXED: FixedView;
+/**
+ * What a story fixes of the view.
+ *
+ * @param globals - the story's `globals`, the meta's under its own.
+ * @param parameters - the story's parameters.
+ * @param catalogue - the catalogue's switches, backdrops and widths.
+ */
+export declare const fixedViewOf: (globals: Readonly<Record<string, unknown>>, parameters: Readonly<Record<string, unknown>>, catalogue: Pick<CatalogueSettings, "switches" | "backdrops" | "widths">) => FixedView;
+/** The parts of a view a story can fix. */
+type FixableView = Pick<ViewState, "switches" | "backdrop">;
+/**
+ * A view with what the story fixes over it: what it is drawn with and what the toolbar shows.
+ *
+ * @param view - the view.
+ * @param fixed - what the story fixes.
+ */
+export declare const withFixed: <TView extends FixableView & Partial<Pick<ViewState, "width">>>(view: TView, fixed: FixedView) => TView;
+/**
+ * A view changed from the one shown, with the user's own values back where the story fixes them: a change of another
+ * setting never writes the story's into the address.
+ *
+ * @param changed - the view as the toolbar changed it, from the one shown.
+ * @param own - the user's own view.
+ * @param fixed - what the story fixes.
+ */
+export declare const withOwnFixed: (changed: ViewState, own: ViewState, fixed: FixedView) => ViewState;
+/**
+ * Whether a value received from a frame is what a story fixes.
+ *
+ * @param value - the message's field.
+ */
+export declare const isFixedView: (value: unknown) => value is FixedView;
+export {};
+//# sourceMappingURL=storyGlobals.d.ts.map

package/dist/src/storyGlobals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storyGlobals.d.ts","sourceRoot":"","sources":["../../src/storyGlobals.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,kGAAkG;AAClG,MAAM,MAAM,SAAS,GAAG;IACtB,oCAAoC;IACpC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACpD,oCAAoC;IACpC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,qCAAqC;IACrC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,kCAAkC;AAClC,eAAO,MAAM,SAAS,EAAE,SAA4B,CAAC;AA+CrD;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GACtB,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAC1C,YAAY,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAC7C,WAAW,IAAI,CAAC,iBAAiB,EAAE,UAAU,GAAG,WAAW,GAAG,QAAQ,CAAC,KACtE,SAoBF,CAAC;AAEF,2CAA2C;AAC3C,KAAK,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,UAAU,GAAG,UAAU,CAAC,CAAC;AAE5D;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,KAAK,SAAS,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,EACrF,MAAM,KAAK,EACX,OAAO,SAAS,KACf,KAKD,CAAC;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,GAAI,SAAS,SAAS,EAAE,KAAK,SAAS,EAAE,OAAO,SAAS,KAAG,SAanF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,WAAW,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,SAKgB,CAAC"}

package/dist/src/storyGlobals.js

@@ -0,0 +1,117 @@
+/**
+ * What a story fixes of the view, as Storybook's stories write it: switches by its `globals` (`{ theme: "dark" }`),
+ * the background by `globals.backgrounds` or `parameters.backgrounds.default`, the width by `globals.viewport` or
+ * `parameters.viewport.defaultViewport`.
+ *
+ * @remarks
+ * A story that fixes a value is drawn with it whatever the toolbar says, and the toolbar shows it as set by the story,
+ * as Storybook locks a global a story sets. Only values the catalogue has are taken: a switch's value among its
+ * values, a background by its id or name, a width by its preset's name or its number. The address keeps the user's
+ * own view, so another story shows it again. Pure.
+ *
+ * @module
+ */
+/** A story that fixes nothing. */
+export const NOT_FIXED = { switches: {} };
+/** Whether a value is a plain object. */
+const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+/** A field of an object that is itself an object, or an empty one. */
+const recordAt = (part, name) => {
+    const value = part[name];
+    return isRecord(value) ? value : {};
+};
+/** A global written as Storybook's addons write theirs (`{ value: "dark" }`) or as a plain text. */
+const globalValue = (value) => {
+    if (typeof value === "string")
+        return value;
+    return isRecord(value) && typeof value["value"] === "string" ? value["value"] : undefined;
+};
+/** The same text, compared without case. */
+const isSameName = (left, right) => left.toLowerCase() === right.toLowerCase();
+/**
+ * The backdrop a name picks: by the catalogue's id or name.
+ *
+ * @param name - the story's background, by id or name.
+ * @param catalogue - the catalogue's backdrops.
+ */
+const backdropNamed = (name, catalogue) => catalogue.backdrops.find((backdrop) => isSameName(backdrop.id, name) || isSameName(backdrop.label, name))
+    ?.id;
+/**
+ * The width a name picks: a preset by its name, or a number of CSS px among the presets.
+ *
+ * @param name - the story's viewport, by name or width.
+ * @param catalogue - the catalogue's widths.
+ */
+const widthNamed = (name, catalogue) => catalogue.widths.find((preset) => (preset.label !== undefined && isSameName(preset.label, name)) ||
+    String(preset.width) === name.replace(/px$/, ""))?.width;
+/**
+ * What a story fixes of the view.
+ *
+ * @param globals - the story's `globals`, the meta's under its own.
+ * @param parameters - the story's parameters.
+ * @param catalogue - the catalogue's switches, backdrops and widths.
+ */
+export const fixedViewOf = (globals, parameters, catalogue) => {
+    const switches = Object.fromEntries(catalogue.switches.flatMap((each) => {
+        const value = globalValue(globals[each.id]);
+        return value !== undefined && each.values.some((known) => known.value === value)
+            ? [[each.id, value]]
+            : [];
+    }));
+    const background = globalValue(globals["backgrounds"]) ?? globalValue(recordAt(parameters, "backgrounds")["default"]);
+    const viewport = globalValue(globals["viewport"]) ?? globalValue(recordAt(parameters, "viewport")["defaultViewport"]);
+    const backdrop = background === undefined ? undefined : backdropNamed(background, catalogue);
+    const width = viewport === undefined ? undefined : widthNamed(viewport, catalogue);
+    return {
+        switches,
+        ...(backdrop === undefined ? {} : { backdrop }),
+        ...(width === undefined ? {} : { width })
+    };
+};
+/**
+ * A view with what the story fixes over it: what it is drawn with and what the toolbar shows.
+ *
+ * @param view - the view.
+ * @param fixed - what the story fixes.
+ */
+export const withFixed = (view, fixed) => ({
+    ...view,
+    switches: { ...view.switches, ...fixed.switches },
+    ...(fixed.backdrop === undefined ? {} : { backdrop: fixed.backdrop }),
+    ...(fixed.width === undefined || view.width === undefined ? {} : { width: fixed.width })
+});
+/**
+ * A view changed from the one shown, with the user's own values back where the story fixes them: a change of another
+ * setting never writes the story's into the address.
+ *
+ * @param changed - the view as the toolbar changed it, from the one shown.
+ * @param own - the user's own view.
+ * @param fixed - what the story fixes.
+ */
+export const withOwnFixed = (changed, own, fixed) => {
+    const switches = { ...changed.switches };
+    for (const id of Object.keys(fixed.switches)) {
+        const ownValue = own.switches[id];
+        if (ownValue === undefined)
+            delete switches[id];
+        else
+            switches[id] = ownValue;
+    }
+    return {
+        ...changed,
+        switches,
+        backdrop: fixed.backdrop === undefined ? changed.backdrop : own.backdrop,
+        width: fixed.width === undefined ? changed.width : own.width
+    };
+};
+/**
+ * Whether a value received from a frame is what a story fixes.
+ *
+ * @param value - the message's field.
+ */
+export const isFixedView = (value) => isRecord(value) &&
+    isRecord(value["switches"]) &&
+    Object.values(value["switches"]).every((switchValue) => typeof switchValue === "string") &&
+    (value["backdrop"] === undefined || typeof value["backdrop"] === "string") &&
+    (value["width"] === undefined || typeof value["width"] === "number");
+//# sourceMappingURL=storyGlobals.js.map

package/dist/src/storyGlobals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storyGlobals.js","sourceRoot":"","sources":["../../src/storyGlobals.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAeH,kCAAkC;AAClC,MAAM,CAAC,MAAM,SAAS,GAAc,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;AAErD,yCAAyC;AACzC,MAAM,QAAQ,GAAG,CAAC,KAAc,EAA8C,EAAE,CAC9E,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAEvE,sEAAsE;AACtE,MAAM,QAAQ,GAAG,CACf,IAAuC,EACvC,IAAY,EACuB,EAAE;IACrC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AACtC,CAAC,CAAC;AAEF,oGAAoG;AACpG,MAAM,WAAW,GAAG,CAAC,KAAc,EAAsB,EAAE;IACzD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5C,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC5F,CAAC,CAAC;AAEF,4CAA4C;AAC5C,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,KAAa,EAAW,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;AAExG;;;;;GAKG;AACH,MAAM,aAAa,GAAG,CAAC,IAAY,EAAE,SAA+C,EAAsB,EAAE,CAC1G,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACvG,EAAE,EAAE,CAAC;AAET;;;;;GAKG;AACH,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,SAA4C,EAAsB,EAAE,CACpG,SAAS,CAAC,MAAM,CAAC,IAAI,CACnB,CAAC,MAAM,EAAE,EAAE,CACT,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC9D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CACnD,EAAE,KAAK,CAAC;AAEX;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,OAA0C,EAC1C,UAA6C,EAC7C,SAAuE,EAC5D,EAAE;IACb,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CACjC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAClC,MAAM,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5C,OAAO,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC;YAC9E,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;YACpB,CAAC,CAAC,EAAE,CAAC;IACT,CAAC,CAAC,CACH,CAAC;IACF,MAAM,UAAU,GACd,WAAW,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IACrG,MAAM,QAAQ,GACZ,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACvG,MAAM,QAAQ,GAAG,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;IAC7F,MAAM,KAAK,GAAG,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACnF,OAAO;QACL,QAAQ;QACR,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC;QAC/C,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;KAC1C,CAAC;AACJ,CAAC,CAAC;AAKF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,IAAW,EACX,KAAgB,EACT,EAAE,CAAC,CAAC;IACX,GAAG,IAAI;IACP,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,GAAG,KAAK,CAAC,QAAQ,EAAE;IACjD,GAAG,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC;IACrE,GAAG,CAAC,KAAK,CAAC,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;CACzF,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAkB,EAAE,GAAc,EAAE,KAAgB,EAAa,EAAE;IAC9F,MAAM,QAAQ,GAA2B,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IACjE,KAAK,MAAM,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7C,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAClC,IAAI,QAAQ,KAAK,SAAS;YAAE,OAAO,QAAQ,CAAC,EAAE,CAAC,CAAC;;YAC3C,QAAQ,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC;IAC/B,CAAC;IACD,OAAO;QACL,GAAG,OAAO;QACV,QAAQ;QACR,QAAQ,EAAE,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ;QACxE,KAAK,EAAE,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK;KAC7D,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAc,EAAsB,EAAE,CAChE,QAAQ,CAAC,KAAK,CAAC;IACf,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC3B,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,OAAO,WAAW,KAAK,QAAQ,CAAC;IACxF,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,UAAU,CAAC,KAAK,QAAQ,CAAC;IAC1E,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC"}

package/dist/src/storyHeights.d.ts

@@ -0,0 +1,37 @@
+/**
+ * The stories' measured heights: how tall each story's frame is at a few widths, written by `forgebook-heights` and
+ * read by the shell, which gives a story's box that height while the story loads instead of a short guess.
+ *
+ * @remarks
+ * Only a hint for the wait: the frame takes its real height once its story reports it. The heights are measured in the
+ * default view (light theme, English, standard text size); the view's other choices change a story's height a little,
+ * which a loading box can live with. The document is generated, never committed: a style change would otherwise dirty
+ * it on every edit. Pure.
+ *
+ * @module
+ */
+/** The document `forgebook-heights` writes and the shell reads. */
+export type StoryHeights = {
+    /** The widths the stories were measured at, in CSS px, ascending. */
+    readonly widths: readonly number[];
+    /** Each story's height at each of `widths`, in CSS px, by story id; a story that failed is left out. */
+    readonly heights: Readonly<Record<string, readonly number[]>>;
+};
+/** The widths `forgebook-heights` measures at by default: the stage's presets, and a wide one for Fill. */
+export declare const HEIGHT_WIDTHS: readonly number[];
+/**
+ * Whether a value read from the file is the heights' document.
+ *
+ * @param value - the parsed file.
+ */
+export declare const isStoryHeights: (value: unknown) => value is StoryHeights;
+/**
+ * A story's measured height at the width nearest the one it is drawn at.
+ *
+ * @param document - the heights; none when the catalogue has none.
+ * @param storyId - the story's id.
+ * @param width - the width the story is drawn at, in CSS px.
+ * @returns the height in CSS px, or none when the story was not measured.
+ */
+export declare const knownHeight: (document: StoryHeights | undefined, storyId: string, width: number) => number | undefined;
+//# sourceMappingURL=storyHeights.d.ts.map

package/dist/src/storyHeights.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storyHeights.d.ts","sourceRoot":"","sources":["../../src/storyHeights.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,mEAAmE;AACnE,MAAM,MAAM,YAAY,GAAG;IACzB,qEAAqE;IACrE,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,wGAAwG;IACxG,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,CAAC,CAAC;CAC/D,CAAC;AAEF,2GAA2G;AAC3G,eAAO,MAAM,aAAa,EAAE,SAAS,MAAM,EAAgC,CAAC;AAO5E;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,YAMxD,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,GACtB,UAAU,YAAY,GAAG,SAAS,EAClC,SAAS,MAAM,EACf,OAAO,MAAM,KACZ,MAAM,GAAG,SASX,CAAC"}

package/dist/src/storyHeights.js

@@ -0,0 +1,53 @@
+/**
+ * The stories' measured heights: how tall each story's frame is at a few widths, written by `forgebook-heights` and
+ * read by the shell, which gives a story's box that height while the story loads instead of a short guess.
+ *
+ * @remarks
+ * Only a hint for the wait: the frame takes its real height once its story reports it. The heights are measured in the
+ * default view (light theme, English, standard text size); the view's other choices change a story's height a little,
+ * which a loading box can live with. The document is generated, never committed: a style change would otherwise dirty
+ * it on every edit. Pure.
+ *
+ * @module
+ */
+/** The widths `forgebook-heights` measures at by default: the stage's presets, and a wide one for Fill. */
+export const HEIGHT_WIDTHS = [360, 560, 768, 1024, 1440];
+/** Whether a value is a list of whole numbers of px. */
+const isLengths = (value) => Array.isArray(value) &&
+    value.every((item) => typeof item === "number" && Number.isFinite(item) && item >= 0);
+/**
+ * Whether a value read from the file is the heights' document.
+ *
+ * @param value - the parsed file.
+ */
+export const isStoryHeights = (value) => {
+    if (typeof value !== "object" || value === null)
+        return false;
+    if (!("widths" in value) || !isLengths(value.widths) || value.widths.length === 0)
+        return false;
+    const widthCount = value.widths.length;
+    if (!("heights" in value) || typeof value.heights !== "object" || value.heights === null)
+        return false;
+    return Object.values(value.heights).every((heights) => isLengths(heights) && heights.length === widthCount);
+};
+/**
+ * A story's measured height at the width nearest the one it is drawn at.
+ *
+ * @param document - the heights; none when the catalogue has none.
+ * @param storyId - the story's id.
+ * @param width - the width the story is drawn at, in CSS px.
+ * @returns the height in CSS px, or none when the story was not measured.
+ */
+export const knownHeight = (document, storyId, width) => {
+    const heights = document?.heights[storyId];
+    if (document === undefined || heights === undefined)
+        return undefined;
+    let nearest = 0;
+    document.widths.forEach((measured, index) => {
+        const best = document.widths[nearest] ?? measured;
+        if (Math.abs(measured - width) < Math.abs(best - width))
+            nearest = index;
+    });
+    return heights[nearest];
+};
+//# sourceMappingURL=storyHeights.js.map

package/dist/src/storyHeights.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storyHeights.js","sourceRoot":"","sources":["../../src/storyHeights.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAUH,2GAA2G;AAC3G,MAAM,CAAC,MAAM,aAAa,GAAsB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAE5E,wDAAwD;AACxD,MAAM,SAAS,GAAG,CAAC,KAAc,EAA8B,EAAE,CAC/D,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;IACpB,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC;AAExF;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAc,EAAyB,EAAE;IACtE,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAC9D,IAAI,CAAC,CAAC,QAAQ,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAChG,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;IACvC,IAAI,CAAC,CAAC,SAAS,IAAI,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IACvG,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC;AAC9G,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,QAAkC,EAClC,OAAe,EACf,KAAa,EACO,EAAE;IACtB,MAAM,OAAO,GAAG,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3C,IAAI,QAAQ,KAAK,SAAS,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACtE,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;QAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,QAAQ,CAAC;QAClD,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,CAAC;YAAE,OAAO,GAAG,KAAK,CAAC;IAC3E,CAAC,CAAC,CAAC;IACH,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;AAC1B,CAAC,CAAC"}

package/dist/src/storyIdsElement.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Where the shell writes its story ids for the catalogue's command-line tools: one name, shared by the shell that
+ * writes the element and the tools that read it.
+ *
+ * @module
+ */
+/** The id of the `<script type="application/json">` that holds every story's id, in the sidebar's order. */
+export declare const STORY_IDS_ELEMENT = "forgebook-story-ids";
+//# sourceMappingURL=storyIdsElement.d.ts.map

package/dist/src/storyIdsElement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storyIdsElement.d.ts","sourceRoot":"","sources":["../../src/storyIdsElement.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,4GAA4G;AAC5G,eAAO,MAAM,iBAAiB,wBAAwB,CAAC"}

package/dist/src/storyIdsElement.js

@@ -0,0 +1,9 @@
+/**
+ * Where the shell writes its story ids for the catalogue's command-line tools: one name, shared by the shell that
+ * writes the element and the tools that read it.
+ *
+ * @module
+ */
+/** The id of the `<script type="application/json">` that holds every story's id, in the sidebar's order. */
+export const STORY_IDS_ELEMENT = "forgebook-story-ids";
+//# sourceMappingURL=storyIdsElement.js.map

package/dist/src/storyIdsElement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storyIdsElement.js","sourceRoot":"","sources":["../../src/storyIdsElement.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,4GAA4G;AAC5G,MAAM,CAAC,MAAM,iBAAiB,GAAG,qBAAqB,CAAC"}

package/dist/src/storyTexts.d.ts

@@ -0,0 +1,43 @@
+/**
+ * The texts the stories are drawn with in the shown language: the source's English table with the language's own
+ * over it, or the English pseudo-translated for a pseudo-language.
+ *
+ * @remarks
+ * English is the table every key is in (`stories/locales/en.json`); a language that lacks a key shows the English
+ * one, so a story is never empty while a translation is under way. An arg written `storyText("key")` becomes the text
+ * of its key before the story receives it. Pure.
+ *
+ * @module
+ */
+import type { StoryLanguage, StorySource } from "@forgebook/story-format/source";
+import { type StoryTextFunction, type StoryTextTable } from "@forgebook/story-format/texts";
+/** The language every key is in. */
+export declare const BASE_LANGUAGE = "en";
+/**
+ * A text pseudo-translated: accented, about a third longer, in brackets, its `{name}` placeholders untouched; it shows
+ * a text written outside the tables, one cut too short, or one put together from pieces.
+ *
+ * @param text - an English text.
+ */
+export declare const pseudoText: (text: string) => string;
+/**
+ * The texts of the shown language.
+ *
+ * @param texts - the source's tables, by language id; none when the source has none.
+ * @param language - the shown language, when one is chosen; none for the stories' own (English).
+ */
+export declare const shownTexts: (texts: StorySource["texts"], language: StoryLanguage | undefined) => StoryTextTable;
+/**
+ * A story's args with each `storyText("key")` turned into the text in the shown language, as the story receives them.
+ *
+ * @param args - the story's args.
+ * @param text - the text function of the shown language.
+ */
+export declare const withStoryTexts: (args: Readonly<Record<string, unknown>>, text: StoryTextFunction) => Readonly<Record<string, unknown>>;
+/**
+ * The args that name a text, with their keys: the panel shows the key beside the text.
+ *
+ * @param args - the story's args.
+ */
+export declare const storyTextKeysOf: (args: Readonly<Record<string, unknown>>) => Readonly<Record<string, string>>;
+//# sourceMappingURL=storyTexts.d.ts.map

package/dist/src/storyTexts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storyTexts.d.ts","sourceRoot":"","sources":["../../src/storyTexts.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AACjF,OAAO,EAAkB,KAAK,iBAAiB,EAAE,KAAK,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAE5G,oCAAoC;AACpC,eAAO,MAAM,aAAa,OAAO,CAAC;AAuBlC;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,MAAM,MAAM,KAAG,MASzC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GACrB,OAAO,WAAW,CAAC,OAAO,CAAC,EAC3B,UAAU,aAAa,GAAG,SAAS,KAClC,cAOF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GACzB,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EACvC,MAAM,iBAAiB,KACtB,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAQzB,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAAI,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,KAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAKtG,CAAC"}

package/dist/src/storyTexts.js

@@ -0,0 +1,71 @@
+import { isStoryTextArg } from "@forgebook/story-format/texts";
+/** The language every key is in. */
+export const BASE_LANGUAGE = "en";
+/** The letters a pseudo-translation swaps for an accented look-alike. */
+const ACCENTED = {
+    a: "å",
+    c: "ç",
+    e: "é",
+    i: "î",
+    n: "ñ",
+    o: "ö",
+    s: "š",
+    u: "û",
+    y: "ý",
+    A: "Å",
+    C: "Ç",
+    E: "É",
+    I: "Î",
+    N: "Ñ",
+    O: "Ö",
+    S: "Š",
+    U: "Û"
+};
+/**
+ * A text pseudo-translated: accented, about a third longer, in brackets, its `{name}` placeholders untouched; it shows
+ * a text written outside the tables, one cut too short, or one put together from pieces.
+ *
+ * @param text - an English text.
+ */
+export const pseudoText = (text) => {
+    const accented = text
+        .split(/(\{\w+\})/)
+        .map((part) => part.startsWith("{") ? part : [...part].map((letter) => ACCENTED[letter] ?? letter).join(""))
+        .join("");
+    const padding = "·".repeat(Math.ceil(text.length / 3));
+    return `[${accented}${padding}]`;
+};
+/**
+ * The texts of the shown language.
+ *
+ * @param texts - the source's tables, by language id; none when the source has none.
+ * @param language - the shown language, when one is chosen; none for the stories' own (English).
+ */
+export const shownTexts = (texts, language) => {
+    const base = texts?.[BASE_LANGUAGE] ?? {};
+    if (language === undefined)
+        return base;
+    if (language.isPseudo === true) {
+        return Object.fromEntries(Object.entries(base).map(([key, text]) => [key, pseudoText(text)]));
+    }
+    return { ...base, ...texts?.[language.id] };
+};
+/**
+ * A story's args with each `storyText("key")` turned into the text in the shown language, as the story receives them.
+ *
+ * @param args - the story's args.
+ * @param text - the text function of the shown language.
+ */
+export const withStoryTexts = (args, text) => Object.values(args).some(isStoryTextArg)
+    ? Object.fromEntries(Object.entries(args).map(([name, value]) => [
+        name,
+        isStoryTextArg(value) ? text(value.storyText, value.values) : value
+    ]))
+    : args;
+/**
+ * The args that name a text, with their keys: the panel shows the key beside the text.
+ *
+ * @param args - the story's args.
+ */
+export const storyTextKeysOf = (args) => Object.fromEntries(Object.entries(args).flatMap(([name, value]) => isStoryTextArg(value) ? [[name, value.storyText]] : []));
+//# sourceMappingURL=storyTexts.js.map

package/dist/src/storyTexts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storyTexts.js","sourceRoot":"","sources":["../../src/storyTexts.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,cAAc,EAA+C,MAAM,+BAA+B,CAAC;AAE5G,oCAAoC;AACpC,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,CAAC;AAElC,yEAAyE;AACzE,MAAM,QAAQ,GAAqC;IACjD,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;CACP,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAY,EAAU,EAAE;IACjD,MAAM,QAAQ,GAAG,IAAI;SAClB,KAAK,CAAC,WAAW,CAAC;SAClB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACZ,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAC7F;SACA,IAAI,CAAC,EAAE,CAAC,CAAC;IACZ,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IACvD,OAAO,IAAI,QAAQ,GAAG,OAAO,GAAG,CAAC;AACnC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,KAA2B,EAC3B,QAAmC,EACnB,EAAE;IAClB,MAAM,IAAI,GAAG,KAAK,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;IAC1C,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACxC,IAAI,QAAQ,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;QAC/B,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAChG,CAAC;IACD,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;AAC9C,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,IAAuC,EACvC,IAAuB,EACY,EAAE,CACrC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC;IACtC,CAAC,CAAC,MAAM,CAAC,WAAW,CAChB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;QAC1C,IAAI;QACJ,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK;KACpE,CAAC,CACH;IACH,CAAC,CAAC,IAAI,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAuC,EAAoC,EAAE,CAC3G,MAAM,CAAC,WAAW,CAChB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAsB,EAAE,CACjE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CACvD,CACF,CAAC"}