forgebook 0.0.0-stage → 0.1.2

package/dist/src/languages.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The language a view shows, among the catalogue's (the View menu's Language row): its texts table is the source's
+ * (`StorySource.texts`), its provider a decorator of the catalogue's preview. Pure.
+ *
+ * @module
+ */
+import type { StoryLanguage } from "@forgebook/story-format/source";
+/**
+ * The language a view shows, among the catalogue's: none for the stories' own text, or for an id it does not offer.
+ *
+ * @param languages - the catalogue's languages.
+ * @param id - the view's language id; empty for the stories' own text.
+ */
+export declare const shownLanguage: (languages: readonly StoryLanguage[], id: string) => StoryLanguage | undefined;
+//# sourceMappingURL=languages.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"languages.d.ts","sourceRoot":"","sources":["../../src/languages.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAEpE;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,WAAW,SAAS,aAAa,EAAE,EAAE,IAAI,MAAM,KAAG,aAAa,GAAG,SAC9C,CAAC"}

package/dist/src/languages.js

@@ -0,0 +1,8 @@
+/**
+ * The language a view shows, among the catalogue's: none for the stories' own text, or for an id it does not offer.
+ *
+ * @param languages - the catalogue's languages.
+ * @param id - the view's language id; empty for the stories' own text.
+ */
+export const shownLanguage = (languages, id) => languages.find((language) => language.id === id);
+//# sourceMappingURL=languages.js.map

package/dist/src/languages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"languages.js","sourceRoot":"","sources":["../../src/languages.ts"],"names":[],"mappings":"AAQA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,SAAmC,EAAE,EAAU,EAA6B,EAAE,CAC1G,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC"}

package/dist/src/matrix.d.ts

@@ -0,0 +1,56 @@
+/**
+ * The matrix of a story: the story drawn once per value of one prop (the rows), or of two (rows by columns), in one
+ * frame, so every variant, tone and size is seen side by side without a story written for it.
+ *
+ * @remarks
+ * Only props with a known, short set of values make an axis: a choice (its literal values) or a toggle (`false`,
+ * `true`). The shell builds the matrix from the component's docs and the axes in the address, and sends it to the
+ * frames, which draw it over the story's args. Pure.
+ *
+ * @module
+ */
+import type { PropDocs } from "./componentDocs.ts";
+/** A value an axis takes: what a choice or a toggle prop can be set to. */
+export type MatrixValue = string | number | boolean;
+/** One axis: a prop and the values it takes, in order. */
+export type MatrixAxis = {
+    /** The prop's name. */
+    readonly name: string;
+    /** Its values. */
+    readonly values: readonly MatrixValue[];
+};
+/** The matrix: the rows' axis, and the columns' when there are two. */
+export type Matrix = {
+    /** One row per value. */
+    readonly rows: MatrixAxis;
+    /** One column per value; a single column without. */
+    readonly columns?: MatrixAxis;
+};
+/** The most values an axis takes: past it, the grid is no longer read at a glance. */
+export declare const MATRIX_MAX_VALUES = 12;
+/**
+ * The axis a prop makes, when it can make one.
+ *
+ * @param prop - the prop's docs.
+ */
+export declare const axisOf: (prop: PropDocs) => MatrixAxis | undefined;
+/**
+ * The props a story's matrix can use as an axis, in the docs' order.
+ *
+ * @param props - the component's props.
+ */
+export declare const matrixProps: (props: readonly PropDocs[]) => PropDocs[];
+/**
+ * The matrix of the named axes: the first is the rows, the second the columns; none when the first names no axis.
+ *
+ * @param props - the component's props.
+ * @param names - the axes' prop names, from the address.
+ */
+export declare const matrixOf: (props: readonly PropDocs[], names: readonly string[]) => Matrix | undefined;
+/**
+ * Whether a value is a matrix, as it arrives in a message.
+ *
+ * @param value - the message's matrix.
+ */
+export declare const isMatrix: (value: unknown) => value is Matrix;
+//# sourceMappingURL=matrix.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"matrix.d.ts","sourceRoot":"","sources":["../../src/matrix.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEnD,2EAA2E;AAC3E,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEpD,0DAA0D;AAC1D,MAAM,MAAM,UAAU,GAAG;IACvB,uBAAuB;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,kBAAkB;IAClB,QAAQ,CAAC,MAAM,EAAE,SAAS,WAAW,EAAE,CAAC;CACzC,CAAC;AAEF,uEAAuE;AACvE,MAAM,MAAM,MAAM,GAAG;IACnB,yBAAyB;IACzB,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,qDAAqD;IACrD,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;CAC/B,CAAC;AAEF,sFAAsF;AACtF,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAEpC;;;;GAIG;AACH,eAAO,MAAM,MAAM,GAAI,MAAM,QAAQ,KAAG,UAAU,GAAG,SAKpD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,WAAW,GAAI,OAAO,SAAS,QAAQ,EAAE,KAAG,QAAQ,EACb,CAAC;AAErD;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,GAAI,OAAO,SAAS,QAAQ,EAAE,EAAE,OAAO,SAAS,MAAM,EAAE,KAAG,MAAM,GAAG,SAUxF,CAAC;AAcF;;;;GAIG;AACH,eAAO,MAAM,QAAQ,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,MAIlD,CAAC"}

package/dist/src/matrix.js

@@ -0,0 +1,61 @@
+/** The most values an axis takes: past it, the grid is no longer read at a glance. */
+export const MATRIX_MAX_VALUES = 12;
+/**
+ * The axis a prop makes, when it can make one.
+ *
+ * @param prop - the prop's docs.
+ */
+export const axisOf = (prop) => {
+    if (prop.kind === "toggle")
+        return { name: prop.name, values: [false, true] };
+    if (prop.kind !== "choice")
+        return undefined;
+    const values = prop.choices ?? [];
+    return values.length >= 2 && values.length <= MATRIX_MAX_VALUES ? { name: prop.name, values } : undefined;
+};
+/**
+ * The props a story's matrix can use as an axis, in the docs' order.
+ *
+ * @param props - the component's props.
+ */
+export const matrixProps = (props) => props.filter((prop) => axisOf(prop) !== undefined);
+/**
+ * The matrix of the named axes: the first is the rows, the second the columns; none when the first names no axis.
+ *
+ * @param props - the component's props.
+ * @param names - the axes' prop names, from the address.
+ */
+export const matrixOf = (props, names) => {
+    const axisNamed = (name) => {
+        const prop = props.find((candidate) => candidate.name === name);
+        return prop === undefined ? undefined : axisOf(prop);
+    };
+    const [rowName, columnName] = names;
+    const rows = axisNamed(rowName);
+    if (rows === undefined)
+        return undefined;
+    const columns = columnName === rowName ? undefined : axisNamed(columnName);
+    return columns === undefined ? { rows } : { rows, columns };
+};
+/** Whether a value is an axis, as it arrives in a message. */
+const isAxis = (value) => {
+    if (typeof value !== "object" || value === null)
+        return false;
+    const record = { ...value };
+    const values = record["values"];
+    return (typeof record["name"] === "string" &&
+        Array.isArray(values) &&
+        values.every((item) => typeof item === "string" || typeof item === "number" || typeof item === "boolean"));
+};
+/**
+ * Whether a value is a matrix, as it arrives in a message.
+ *
+ * @param value - the message's matrix.
+ */
+export const isMatrix = (value) => {
+    if (typeof value !== "object" || value === null)
+        return false;
+    const record = { ...value };
+    return isAxis(record["rows"]) && (record["columns"] === undefined || isAxis(record["columns"]));
+};
+//# sourceMappingURL=matrix.js.map

package/dist/src/matrix.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"matrix.js","sourceRoot":"","sources":["../../src/matrix.ts"],"names":[],"mappings":"AAgCA,sFAAsF;AACtF,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAEpC;;;;GAIG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,IAAc,EAA0B,EAAE;IAC/D,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;IAC9E,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;IAClC,OAAO,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,MAAM,CAAC,MAAM,IAAI,iBAAiB,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AAC5G,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAA0B,EAAc,EAAE,CACpE,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC;AAErD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,KAA0B,EAAE,KAAwB,EAAsB,EAAE;IACnG,MAAM,SAAS,GAAG,CAAC,IAAwB,EAA0B,EAAE;QACrE,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAChE,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC,CAAC;IACF,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,KAAK,CAAC;IACpC,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IAChC,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACzC,MAAM,OAAO,GAAG,UAAU,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAC3E,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAC9D,CAAC,CAAC;AAEF,8DAA8D;AAC9D,MAAM,MAAM,GAAG,CAAC,KAAc,EAAuB,EAAE;IACrD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAC9D,MAAM,MAAM,GAAsC,EAAE,GAAG,KAAK,EAAE,CAAC;IAC/D,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;IAChC,OAAO,CACL,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,QAAQ;QAClC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QACrB,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,SAAS,CAAC,CAC1G,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAmB,EAAE;IAC1D,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAC9D,MAAM,MAAM,GAAsC,EAAE,GAAG,KAAK,EAAE,CAAC;IAC/D,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAClG,CAAC,CAAC"}

package/dist/src/messages.d.ts

@@ -0,0 +1,203 @@
+/**
+ * The messages between the shell and a story's frame, both on the same origin.
+ *
+ * @remarks
+ * The frame tells the shell what the loaded story can do (Replay, a story clock, its args), how tall it is (the shell sizes the frame
+ * to it, so a story never scrolls inside a box), every call of an event, or why it failed. The shell asks the frame to
+ * replay, sends the props panel's values, names the events to record, and runs, holds, speeds up or restarts the
+ * story clock. Every message is checked on arrival
+ * (`isFrameMessage`, `isShellMessage`): a page may receive messages from anything it embeds or is embedded in.
+ *
+ * @module
+ */
+import type { StoryControlsSetting } from "@forgebook/story-format/source";
+import { type Violation } from "./a11y.ts";
+import { type PanelArgTypes } from "./argTypes.ts";
+import { type Matrix } from "./matrix.ts";
+import { type PlayTrace } from "./playTrace.ts";
+import { type ClockState } from "./storyClock.ts";
+import { type FixedView } from "./storyGlobals.ts";
+import { type LiveView, type MeasureTool } from "./viewState.ts";
+/**
+ * An arg the props panel can show and set: what crosses between the documents as is. A list of texts or numbers is a
+ * multiple choice's (`check`, `multi-select`); a date is a number of ms since the Unix epoch, as Storybook's.
+ */
+export type ArgValue = string | number | boolean | null | readonly (string | number)[] | NamedArg;
+/**
+ * A value the panel names instead of sending it: one of the source's `namedValues` (an icon component), which cannot
+ * cross between the documents; the frame looks the name up in its own copy of the source.
+ */
+export type NamedArg = {
+    /** The type the value is offered for, as the props write it (`IconComponent`). */
+    readonly of: string;
+    /** The value's name (`IconFolder`). */
+    readonly named: string;
+};
+/** The args of a story the panel can show, by name. */
+export type PanelArgs = Readonly<Record<string, ArgValue>>;
+/** From a frame to the shell. */
+export type FrameMessage = {
+    /** The story rendered. */
+    readonly type: "forgebook:ready";
+    /** The story's id. */
+    readonly storyId: string;
+    /** Whether the story declares a replay. */
+    readonly canReplay: boolean;
+    /** Whether the story reads the story clock (`parameters.clock`): the stage then shows its controls. */
+    readonly hasClock: boolean;
+    /** The story's own args the panel can show (strings, numbers, booleans), a named text in the shown language. */
+    readonly args: PanelArgs;
+    /** The args written `storyText("key")`, with their keys, for the panel to show beside the text. */
+    readonly textKeys: Readonly<Record<string, string>>;
+    /** How the panel shows the args, from the story's `argTypes`, by arg. */
+    readonly argTypes: PanelArgTypes;
+    /** The props the panel can set, as the story's parameters say once it ran (written by code too). */
+    readonly controls: StoryControlsSetting;
+    /** The args the frame records as actions (a spy, an `argTypes` action), whatever the shell names. */
+    readonly actions: readonly string[];
+    /** What the story fixes of the view (its `globals`, Storybook's backgrounds and viewport). */
+    readonly fixed: FixedView;
+} | {
+    /** The story's height changed. */
+    readonly type: "forgebook:size";
+    /** The story's id. */
+    readonly storyId: string;
+    /** The document's height, in CSS px. */
+    readonly height: number;
+} | {
+    /** An event of the story's component was called. */
+    readonly type: "forgebook:call";
+    /** The story's id. */
+    readonly storyId: string;
+    /** The event's prop (`onValueChange`). */
+    readonly name: string;
+    /** Each argument, written short for the log (`"monthly"`, `Event`, `{…}`). */
+    readonly values: readonly string[];
+    /** Each argument's content as JSON for an object or a list, to open in the log; `null` for any other. */
+    readonly details: readonly (string | null)[];
+} | {
+    /** The play function's trace changed: a step began or ended, or the play did. */
+    readonly type: "forgebook:play";
+    /** The story's id. */
+    readonly storyId: string;
+    /** The trace. */
+    readonly trace: PlayTrace;
+} | {
+    /** The accessibility check the shell asked for is over. */
+    readonly type: "forgebook:checked";
+    /** The story's id. */
+    readonly storyId: string;
+    /** The rules the story breaks; empty when it passes. */
+    readonly violations: readonly Violation[];
+} | {
+    /** The accessibility check could not run. */
+    readonly type: "forgebook:check-error";
+    /** The story's id. */
+    readonly storyId: string;
+    /** What went wrong. */
+    readonly message: string;
+} | {
+    /** The story could not be shown. */
+    readonly type: "forgebook:error";
+    /** The story's id. */
+    readonly storyId: string;
+    /** What went wrong. */
+    readonly message: string;
+};
+/** From the shell to a frame. */
+export type ShellMessage = {
+    /** Replay the story, as it declares. */
+    readonly type: "forgebook:replay";
+} | {
+    /** The props panel's values, over the story's own args. */
+    readonly type: "forgebook:args";
+    /** The values set in the panel. */
+    readonly args: PanelArgs;
+} | {
+    /** The events to record: the component's `on…` props. */
+    readonly type: "forgebook:events";
+    /** Their names. */
+    readonly names: readonly string[];
+} | {
+    /** The tools drawn over the story changed: the frame draws these, without loading again. */
+    readonly type: "forgebook:tools";
+    /** The tools; none removes them. */
+    readonly tools: readonly MeasureTool[];
+} | {
+    /** Draw the story once per value of the matrix's axes, or as it is with none. */
+    readonly type: "forgebook:matrix";
+    /** The matrix; `null` draws the story alone. */
+    readonly matrix: Matrix | null;
+} | {
+    /** Mount the story again, so its play function runs again. */
+    readonly type: "forgebook:play-again";
+} | {
+    /** Run the accessibility check on the story as it is now. */
+    readonly type: "forgebook:check";
+} | {
+    /** Set whether the story clock runs, and how fast. */
+    readonly type: "forgebook:clock";
+    /** The clock's state. */
+    readonly state: ClockState;
+} | {
+    /** Bring the story clock back to its start and mount the story again. */
+    readonly type: "forgebook:clock-restart";
+} | {
+    /** The view's live part changed: the frame applies it on its root, without loading again. */
+    readonly type: "forgebook:view";
+    /** The switches' values, the backdrop and the text size. */
+    readonly view: LiveView;
+};
+/** Whether a value is a set of args the panel can show. */
+export declare const isPanelArgs: (value: unknown) => value is PanelArgs;
+/**
+ * Whether a value is a multiple choice's values: a list of texts and numbers.
+ *
+ * @param value - any value.
+ */
+export declare const isChoiceList: (value: unknown) => value is readonly (string | number)[];
+/**
+ * Whether a value is a named arg.
+ *
+ * @param value - any value.
+ */
+export declare const isNamedArg: (value: unknown) => value is NamedArg;
+/**
+ * Whether a received message is one a frame sends.
+ *
+ * @param value - the message's data.
+ */
+export declare const isFrameMessage: (value: unknown) => value is FrameMessage;
+/**
+ * Whether a received message is one the shell sends.
+ *
+ * @param value - the message's data.
+ */
+export declare const isShellMessage: (value: unknown) => value is ShellMessage;
+/**
+ * An event's argument written short for the call log.
+ *
+ * @param value - anything a callback received.
+ */
+export declare const previewValue: (value: unknown) => string;
+/**
+ * An argument's content for the log, when it is an object or a list: JSON, two spaces deep, a function as `ƒ`, an
+ * object met again as `[circular]`, cut past `DETAIL_LENGTH`; `null` for anything else (a text, a number, an event).
+ *
+ * @param value - anything a callback received.
+ */
+export declare const detailOf: (value: unknown) => string | null;
+/**
+ * The panel's values written in an address (`args`): JSON, the only form that keeps `"12"` and `12` apart.
+ *
+ * @param args - the values.
+ * @returns the parameter's text; empty when there is no value.
+ */
+export declare const panelArgsParam: (args: PanelArgs) => string;
+/**
+ * The panel's values an address names: none when the parameter is missing, not JSON, or not values the panel sets.
+ *
+ * @param param - the `args` parameter.
+ */
+export declare const parsePanelArgsParam: (param: string | null) => PanelArgs;
+//# sourceMappingURL=messages.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/messages.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAE3E,OAAO,EAAe,KAAK,SAAS,EAAE,MAAM,WAAW,CAAC;AACxD,OAAO,EAAmB,KAAK,aAAa,EAAE,MAAM,eAAe,CAAC;AACpE,OAAO,EAAY,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAe,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAE,KAAK,UAAU,EAAe,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,KAAK,SAAS,EAAe,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,KAAK,QAAQ,EAAiB,KAAK,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAEhF;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,QAAQ,CAAC;AAElG;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,kFAAkF;IAClF,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,uCAAuC;IACvC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,uDAAuD;AACvD,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;AAE3D,iCAAiC;AACjC,MAAM,MAAM,YAAY,GACpB;IACE,0BAA0B;IAC1B,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,sBAAsB;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,2CAA2C;IAC3C,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,uGAAuG;IACvG,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,gHAAgH;IAChH,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,mGAAmG;IACnG,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACpD,yEAAyE;IACzE,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,oGAAoG;IACpG,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,CAAC;IACxC,qGAAqG;IACrG,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,8FAA8F;IAC9F,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;CAC3B,GACD;IACE,kCAAkC;IAClC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,sBAAsB;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,wCAAwC;IACxC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB,GACD;IACE,oDAAoD;IACpD,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,sBAAsB;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,0CAA0C;IAC1C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,8EAA8E;IAC9E,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,yGAAyG;IACzG,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC;CAC9C,GACD;IACE,iFAAiF;IACjF,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,sBAAsB;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,iBAAiB;IACjB,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;CAC3B,GACD;IACE,2DAA2D;IAC3D,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC;IACnC,sBAAsB;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,wDAAwD;IACxD,QAAQ,CAAC,UAAU,EAAE,SAAS,SAAS,EAAE,CAAC;CAC3C,GACD;IACE,6CAA6C;IAC7C,QAAQ,CAAC,IAAI,EAAE,uBAAuB,CAAC;IACvC,sBAAsB;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,uBAAuB;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,GACD;IACE,oCAAoC;IACpC,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,sBAAsB;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,uBAAuB;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEN,iCAAiC;AACjC,MAAM,MAAM,YAAY,GACpB;IACE,wCAAwC;IACxC,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;CACnC,GACD;IACE,2DAA2D;IAC3D,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,mCAAmC;IACnC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;CAC1B,GACD;IACE,yDAAyD;IACzD,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAClC,mBAAmB;IACnB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC,GACD;IACE,4FAA4F;IAC5F,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,oCAAoC;IACpC,QAAQ,CAAC,KAAK,EAAE,SAAS,WAAW,EAAE,CAAC;CACxC,GACD;IACE,iFAAiF;IACjF,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAClC,gDAAgD;IAChD,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC,GACD;IACE,8DAA8D;IAC9D,QAAQ,CAAC,IAAI,EAAE,sBAAsB,CAAC;CACvC,GACD;IACE,6DAA6D;IAC7D,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;CAClC,GACD;IACE,sDAAsD;IACtD,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,yBAAyB;IACzB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;CAC5B,GACD;IACE,yEAAyE;IACzE,QAAQ,CAAC,IAAI,EAAE,yBAAyB,CAAC;CAC1C,GACD;IACE,6FAA6F;IAC7F,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,4DAA4D;IAC5D,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;CACzB,CAAC;AAMN,2DAA2D;AAC3D,eAAO,MAAM,WAAW,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,SAUnD,CAAC;AAEJ;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EACoB,CAAC;AAEtG;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,QACqC,CAAC;AA0B3F;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,YAiCxD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,YAmBxD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,OAAO,KAAG,MAS7C,CAAC;AAKF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,GAAI,OAAO,OAAO,KAAG,MAAM,GAAG,IAmBlD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,MAAM,SAAS,KAAG,MACW,CAAC;AAE7D;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,OAAO,MAAM,GAAG,IAAI,KAAG,SAQ1D,CAAC"}

package/dist/src/messages.js

@@ -0,0 +1,193 @@
+/**
+ * The messages between the shell and a story's frame, both on the same origin.
+ *
+ * @remarks
+ * The frame tells the shell what the loaded story can do (Replay, a story clock, its args), how tall it is (the shell sizes the frame
+ * to it, so a story never scrolls inside a box), every call of an event, or why it failed. The shell asks the frame to
+ * replay, sends the props panel's values, names the events to record, and runs, holds, speeds up or restarts the
+ * story clock. Every message is checked on arrival
+ * (`isFrameMessage`, `isShellMessage`): a page may receive messages from anything it embeds or is embedded in.
+ *
+ * @module
+ */
+import { isViolation } from "./a11y.js";
+import { isPanelArgTypes } from "./argTypes.js";
+import { isMatrix } from "./matrix.js";
+import { isPlayTrace } from "./playTrace.js";
+import { isClockRate } from "./storyClock.js";
+import { isFixedView } from "./storyGlobals.js";
+import { MEASURE_TOOLS } from "./viewState.js";
+/** Whether a value is a plain object. */
+const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+/** Whether a value is a set of args the panel can show. */
+export const isPanelArgs = (value) => isRecord(value) &&
+    Object.values(value).every((arg) => arg === null ||
+        typeof arg === "string" ||
+        typeof arg === "number" ||
+        typeof arg === "boolean" ||
+        isChoiceList(arg) ||
+        isNamedArg(arg));
+/**
+ * Whether a value is a multiple choice's values: a list of texts and numbers.
+ *
+ * @param value - any value.
+ */
+export const isChoiceList = (value) => Array.isArray(value) && value.every((item) => typeof item === "string" || typeof item === "number");
+/**
+ * Whether a value is a named arg.
+ *
+ * @param value - any value.
+ */
+export const isNamedArg = (value) => isRecord(value) && typeof value["of"] === "string" && typeof value["named"] === "string";
+/** Whether a value is the view's live part. */
+const isLiveView = (value) => isRecord(value) &&
+    isRecord(value["switches"]) &&
+    Object.values(value["switches"]).every((switchValue) => typeof switchValue === "string") &&
+    typeof value["backdrop"] === "string" &&
+    typeof value["text"] === "number";
+/** Whether a value is a story clock's state. */
+const isClockState = (value) => isRecord(value) && typeof value["isRunning"] === "boolean" && isClockRate(value["rate"]);
+/** Whether a value is a list of strings. */
+const isStringList = (value) => Array.isArray(value) && value.every((item) => typeof item === "string");
+/** Whether a value is a controls setting: every prop, or the listed ones. */
+const isControlsSetting = (value) => value === "all" || isStringList(value);
+/** Whether a value is the text keys of a story's args: names to keys. */
+const isTextKeys = (value) => isRecord(value) && Object.values(value).every((key) => typeof key === "string");
+/**
+ * Whether a received message is one a frame sends.
+ *
+ * @param value - the message's data.
+ */
+export const isFrameMessage = (value) => {
+    if (!isRecord(value) || typeof value["storyId"] !== "string")
+        return false;
+    switch (value["type"]) {
+        case "forgebook:ready":
+            return (typeof value["canReplay"] === "boolean" &&
+                typeof value["hasClock"] === "boolean" &&
+                isPanelArgs(value["args"]) &&
+                isTextKeys(value["textKeys"]) &&
+                isPanelArgTypes(value["argTypes"]) &&
+                isControlsSetting(value["controls"]) &&
+                isStringList(value["actions"]) &&
+                isFixedView(value["fixed"]));
+        case "forgebook:size":
+            return typeof value["height"] === "number";
+        case "forgebook:call":
+            return (typeof value["name"] === "string" &&
+                isStringList(value["values"]) &&
+                Array.isArray(value["details"]) &&
+                value["details"].every((detail) => detail === null || typeof detail === "string"));
+        case "forgebook:error":
+        case "forgebook:check-error":
+            return typeof value["message"] === "string";
+        case "forgebook:play":
+            return isPlayTrace(value["trace"]);
+        case "forgebook:checked":
+            return Array.isArray(value["violations"]) && value["violations"].every(isViolation);
+        default:
+            return false;
+    }
+};
+/**
+ * Whether a received message is one the shell sends.
+ *
+ * @param value - the message's data.
+ */
+export const isShellMessage = (value) => {
+    if (!isRecord(value))
+        return false;
+    if (value["type"] === "forgebook:replay" ||
+        value["type"] === "forgebook:check" ||
+        value["type"] === "forgebook:play-again" ||
+        value["type"] === "forgebook:clock-restart") {
+        return true;
+    }
+    if (value["type"] === "forgebook:args")
+        return isPanelArgs(value["args"]);
+    if (value["type"] === "forgebook:view")
+        return isLiveView(value["view"]);
+    if (value["type"] === "forgebook:clock")
+        return isClockState(value["state"]);
+    if (value["type"] === "forgebook:tools") {
+        const tools = value["tools"];
+        return Array.isArray(tools) && tools.every((tool) => MEASURE_TOOLS.some((known) => known === tool));
+    }
+    if (value["type"] === "forgebook:matrix")
+        return value["matrix"] === null || isMatrix(value["matrix"]);
+    return value["type"] === "forgebook:events" && isStringList(value["names"]);
+};
+/**
+ * An event's argument written short for the call log.
+ *
+ * @param value - anything a callback received.
+ */
+export const previewValue = (value) => {
+    if (typeof value === "string")
+        return JSON.stringify(value.length > 60 ? `${value.slice(0, 60)}…` : value);
+    if (typeof value === "number" || typeof value === "boolean" || typeof value === "bigint")
+        return String(value);
+    if (value === null || value === undefined)
+        return String(value);
+    if (typeof value === "function")
+        return "ƒ";
+    if (typeof Event !== "undefined" && value instanceof Event)
+        return value.constructor.name;
+    if (isRecord(value) && "nativeEvent" in value)
+        return "SyntheticEvent";
+    return Array.isArray(value) ? `[…${value.length}]` : "{…}";
+};
+/** The most characters an argument's content keeps in the log. */
+const DETAIL_LENGTH = 2000;
+/**
+ * An argument's content for the log, when it is an object or a list: JSON, two spaces deep, a function as `ƒ`, an
+ * object met again as `[circular]`, cut past `DETAIL_LENGTH`; `null` for anything else (a text, a number, an event).
+ *
+ * @param value - anything a callback received.
+ */
+export const detailOf = (value) => {
+    if (typeof value !== "object" || value === null)
+        return null;
+    if (typeof Event !== "undefined" && value instanceof Event)
+        return null;
+    if ("nativeEvent" in value)
+        return null;
+    const seen = new WeakSet();
+    const text = JSON.stringify(value, (_key, inner) => {
+        if (typeof inner === "function")
+            return "ƒ";
+        if (typeof inner === "bigint")
+            return `${inner}n`;
+        if (typeof inner === "object" && inner !== null) {
+            if (seen.has(inner))
+                return "[circular]";
+            seen.add(inner);
+        }
+        return inner;
+    }, 2);
+    return text.length > DETAIL_LENGTH ? `${text.slice(0, DETAIL_LENGTH)}…` : text;
+};
+/**
+ * The panel's values written in an address (`args`): JSON, the only form that keeps `"12"` and `12` apart.
+ *
+ * @param args - the values.
+ * @returns the parameter's text; empty when there is no value.
+ */
+export const panelArgsParam = (args) => Object.keys(args).length === 0 ? "" : JSON.stringify(args);
+/**
+ * The panel's values an address names: none when the parameter is missing, not JSON, or not values the panel sets.
+ *
+ * @param param - the `args` parameter.
+ */
+export const parsePanelArgsParam = (param) => {
+    if (param === null || param === "")
+        return {};
+    try {
+        const value = JSON.parse(param);
+        return isPanelArgs(value) ? value : {};
+    }
+    catch {
+        return {};
+    }
+};
+//# sourceMappingURL=messages.js.map

package/dist/src/messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../src/messages.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAIH,OAAO,EAAE,WAAW,EAAkB,MAAM,WAAW,CAAC;AACxD,OAAO,EAAE,eAAe,EAAsB,MAAM,eAAe,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAe,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,WAAW,EAAkB,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAmB,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAkB,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAiB,aAAa,EAAoB,MAAM,gBAAgB,CAAC;AA0JhF,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,2DAA2D;AAC3D,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAc,EAAsB,EAAE,CAChE,QAAQ,CAAC,KAAK,CAAC;IACf,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CACxB,CAAC,GAAG,EAAE,EAAE,CACN,GAAG,KAAK,IAAI;QACZ,OAAO,GAAG,KAAK,QAAQ;QACvB,OAAO,GAAG,KAAK,QAAQ;QACvB,OAAO,GAAG,KAAK,SAAS;QACxB,YAAY,CAAC,GAAG,CAAC;QACjB,UAAU,CAAC,GAAG,CAAC,CAClB,CAAC;AAEJ;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,KAAc,EAAyC,EAAE,CACpF,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC;AAEtG;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAc,EAAqB,EAAE,CAC9D,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC;AAE3F,+CAA+C;AAC/C,MAAM,UAAU,GAAG,CAAC,KAAc,EAAqB,EAAE,CACvD,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,OAAO,KAAK,CAAC,UAAU,CAAC,KAAK,QAAQ;IACrC,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC;AAEpC,gDAAgD;AAChD,MAAM,YAAY,GAAG,CAAC,KAAc,EAAuB,EAAE,CAC3D,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,SAAS,IAAI,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;AAE3F,4CAA4C;AAC5C,MAAM,YAAY,GAAG,CAAC,KAAc,EAA8B,EAAE,CAClE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC;AAE1E,6EAA6E;AAC7E,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAAiC,EAAE,CAC1E,KAAK,KAAK,KAAK,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;AAEzC,yEAAyE;AACzE,MAAM,UAAU,GAAG,CAAC,KAAc,EAA6C,EAAE,CAC/E,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC;AAElF;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAc,EAAyB,EAAE;IACtE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC3E,QAAQ,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,KAAK,iBAAiB;YACpB,OAAO,CACL,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,SAAS;gBACvC,OAAO,KAAK,CAAC,UAAU,CAAC,KAAK,SAAS;gBACtC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBAC1B,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBAC7B,eAAe,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBAClC,iBAAiB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBACpC,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBAC9B,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAC5B,CAAC;QACJ,KAAK,gBAAgB;YACnB,OAAO,OAAO,KAAK,CAAC,QAAQ,CAAC,KAAK,QAAQ,CAAC;QAC7C,KAAK,gBAAgB;YACnB,OAAO,CACL,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,QAAQ;gBACjC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBAC7B,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBAC/B,KAAK,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ,CAAC,CAClF,CAAC;QACJ,KAAK,iBAAiB,CAAC;QACvB,KAAK,uBAAuB;YAC1B,OAAO,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,QAAQ,CAAC;QAC9C,KAAK,gBAAgB;YACnB,OAAO,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACrC,KAAK,mBAAmB;YACtB,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACtF;YACE,OAAO,KAAK,CAAC;IACjB,CAAC;AACH,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAc,EAAyB,EAAE;IACtE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACnC,IACE,KAAK,CAAC,MAAM,CAAC,KAAK,kBAAkB;QACpC,KAAK,CAAC,MAAM,CAAC,KAAK,iBAAiB;QACnC,KAAK,CAAC,MAAM,CAAC,KAAK,sBAAsB;QACxC,KAAK,CAAC,MAAM,CAAC,KAAK,yBAAyB,EAC3C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,gBAAgB;QAAE,OAAO,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1E,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,gBAAgB;QAAE,OAAO,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACzE,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,iBAAiB;QAAE,OAAO,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAC7E,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,iBAAiB,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7B,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC;IACtG,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,kBAAkB;QAAE,OAAO,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI,IAAI,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvG,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,kBAAkB,IAAI,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;AAC9E,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,KAAc,EAAU,EAAE;IACrD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAC3G,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,QAAQ;QACtF,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IAChE,IAAI,OAAO,KAAK,KAAK,UAAU;QAAE,OAAO,GAAG,CAAC;IAC5C,IAAI,OAAO,KAAK,KAAK,WAAW,IAAI,KAAK,YAAY,KAAK;QAAE,OAAO,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC;IAC1F,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,aAAa,IAAI,KAAK;QAAE,OAAO,gBAAgB,CAAC;IACvE,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;AAC7D,CAAC,CAAC;AAEF,kEAAkE;AAClE,MAAM,aAAa,GAAG,IAAI,CAAC;AAE3B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAiB,EAAE;IACxD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAC7D,IAAI,OAAO,KAAK,KAAK,WAAW,IAAI,KAAK,YAAY,KAAK;QAAE,OAAO,IAAI,CAAC;IACxE,IAAI,aAAa,IAAI,KAAK;QAAE,OAAO,IAAI,CAAC;IACxC,MAAM,IAAI,GAAG,IAAI,OAAO,EAAU,CAAC;IACnC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CACzB,KAAK,EACL,CAAC,IAAY,EAAE,KAAc,EAAW,EAAE;QACxC,IAAI,OAAO,KAAK,KAAK,UAAU;YAAE,OAAO,GAAG,CAAC;QAC5C,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,GAAG,KAAK,GAAG,CAAC;QAClD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YAChD,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;gBAAE,OAAO,YAAY,CAAC;YACzC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAClB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,EACD,CAAC,CACF,CAAC;IACF,OAAO,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;AACjF,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAe,EAAU,EAAE,CACxD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAE7D;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,KAAoB,EAAa,EAAE;IACrE,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE;QAAE,OAAO,EAAE,CAAC;IAC9C,IAAI,CAAC;QACH,MAAM,KAAK,GAAY,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzC,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IACzC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC,CAAC"}

package/dist/src/namedValues.d.ts

@@ -0,0 +1,38 @@
+/**
+ * The values a source names for the props panel (`StorySource.namedValues`): a story's own value found by name for
+ * the panel to show, and a name the panel sent turned back into the value for the story.
+ *
+ * @remarks
+ * A component or a function cannot cross between the shell and a frame; its name can, and each side holds the same
+ * source. Pure.
+ *
+ * @module
+ */
+import type { StorySource } from "@forgebook/story-format/source";
+import { type NamedArg, type PanelArgs } from "./messages.ts";
+/** A source's named values: by the type as the props write it, then by name. */
+export type NamedValues = NonNullable<StorySource["namedValues"]>;
+/**
+ * The name of a value among the named ones, when it is one of them.
+ *
+ * @param value - a story's own arg.
+ * @param namedValues - the source's named values.
+ */
+export declare const nameOf: (value: unknown, namedValues: NamedValues) => NamedArg | undefined;
+/**
+ * A story's own args as the panel can show them: texts, numbers, booleans, `null` and lists of texts and numbers (a
+ * multiple choice's) as they are, a named value by its name; anything else is left out.
+ *
+ * @param args - the story's args.
+ * @param namedValues - the source's named values; none by default.
+ */
+export declare const panelArgsOf: (args: Readonly<Record<string, unknown>>, namedValues?: NamedValues) => PanelArgs;
+/**
+ * The panel's values as the story takes them: a name turned back into its value; a name the source no longer offers
+ * is left out, so the story keeps its own.
+ *
+ * @param args - the panel's values.
+ * @param namedValues - the source's named values; none by default.
+ */
+export declare const storyArgsOf: (args: PanelArgs, namedValues?: NamedValues) => Readonly<Record<string, unknown>>;
+//# sourceMappingURL=namedValues.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"namedValues.d.ts","sourceRoot":"","sources":["../../src/namedValues.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAElE,OAAO,EAA2C,KAAK,QAAQ,EAAE,KAAK,SAAS,EAAE,MAAM,eAAe,CAAC;AAEvG,gFAAgF;AAChF,MAAM,MAAM,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC;AAElE;;;;;GAKG;AACH,eAAO,MAAM,MAAM,GAAI,OAAO,OAAO,EAAE,aAAa,WAAW,KAAG,QAAQ,GAAG,SAO5E,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GACtB,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EACvC,cAAa,WAAgB,KAC5B,SAeA,CAAC;AAEJ;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GACtB,MAAM,SAAS,EACf,cAAa,WAAgB,KAC5B,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAOhC,CAAC"}