forgebook 0.0.0-stage → 0.1.0

package/dist/bin/forgebook-texts/storyTextsReport.types.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The `--json` document of `forgebook-texts`: the keys the stories use, what is wrong with them, and what each language
+ * still has to translate.
+ *
+ * @module
+ */
+/** A text one language still lacks: its key and the English to translate. */
+export type UntranslatedText = {
+    /** The key (`skeleton.dashboard.title`). */
+    readonly key: string;
+    /** The English text. */
+    readonly text: string;
+};
+/** What `forgebook-texts` reports. */
+export type StoryTextsReport = {
+    /** How many keys the stories use. */
+    readonly used: number;
+    /** Keys a story uses that the English file lacks: the story would show the key. */
+    readonly missing: readonly string[];
+    /** Keys of the English file no story uses. */
+    readonly unused: readonly string[];
+    /** By language id (every file but English), the texts it lacks. */
+    readonly untranslated: Readonly<Record<string, readonly UntranslatedText[]>>;
+};
+//# sourceMappingURL=storyTextsReport.types.d.ts.map

package/dist/bin/forgebook-texts/storyTextsReport.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storyTextsReport.types.d.ts","sourceRoot":"","sources":["../../../bin/forgebook-texts/storyTextsReport.types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,6EAA6E;AAC7E,MAAM,MAAM,gBAAgB,GAAG;IAC7B,4CAA4C;IAC5C,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,wBAAwB;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,sCAAsC;AACtC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,mFAAmF;IACnF,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,8CAA8C;IAC9C,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,mEAAmE;IACnE,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,gBAAgB,EAAE,CAAC,CAAC,CAAC;CAC9E,CAAC"}

package/dist/bin/forgebook-texts/storyTextsReport.types.js

@@ -0,0 +1,7 @@
+/**
+ * The `--json` document of `forgebook-texts`: the keys the stories use, what is wrong with them, and what each language
+ * still has to translate.
+ *
+ * @module
+ */
+//# sourceMappingURL=storyTextsReport.types.js.map

package/dist/bin/forgebook-texts/storyTextsReport.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storyTextsReport.types.js","sourceRoot":"","sources":["../../../bin/forgebook-texts/storyTextsReport.types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/src/a11y.d.ts

@@ -0,0 +1,28 @@
+/**
+ * A violation of the accessibility check of a story, as the catalogue's Accessibility card shows it; the rules
+ * checked are the catalogue's (`catalogue.ts`, WCAG 2.2 A and AA by default), the same in the generated tests.
+ *
+ * @remarks
+ * The card runs the check in the story's frame, on what the story shows at that moment (an open menu, a dark theme),
+ * so a problem is seen while the story is written, not first in CI.
+ *
+ * @module
+ */
+/** How bad a violation is, as axe rates it. */
+export type ViolationImpact = "minor" | "moderate" | "serious" | "critical";
+/** One rule a story breaks. */
+export type Violation = {
+    /** The rule's id (`color-contrast`). */
+    readonly id: string;
+    /** What the rule asks, in a sentence. */
+    readonly help: string;
+    /** How bad it is; none when axe does not say. */
+    readonly impact: ViolationImpact | undefined;
+    /** The page explaining the rule. */
+    readonly helpUrl: string;
+    /** A selector of each element that breaks it. */
+    readonly targets: readonly string[];
+};
+/** Whether a value is a violation, as it arrives in a message. */
+export declare const isViolation: (value: unknown) => value is Violation;
+//# sourceMappingURL=a11y.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"a11y.d.ts","sourceRoot":"","sources":["../../src/a11y.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+CAA+C;AAC/C,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,UAAU,GAAG,SAAS,GAAG,UAAU,CAAC;AAE5E,+BAA+B;AAC/B,MAAM,MAAM,SAAS,GAAG;IACtB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,yCAAyC;IACzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,iDAAiD;IACjD,QAAQ,CAAC,MAAM,EAAE,eAAe,GAAG,SAAS,CAAC;IAC7C,oCAAoC;IACpC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF,kEAAkE;AAClE,eAAO,MAAM,WAAW,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,SAiBrD,CAAC"}

package/dist/src/a11y.js

@@ -0,0 +1,29 @@
+/**
+ * A violation of the accessibility check of a story, as the catalogue's Accessibility card shows it; the rules
+ * checked are the catalogue's (`catalogue.ts`, WCAG 2.2 A and AA by default), the same in the generated tests.
+ *
+ * @remarks
+ * The card runs the check in the story's frame, on what the story shows at that moment (an open menu, a dark theme),
+ * so a problem is seen while the story is written, not first in CI.
+ *
+ * @module
+ */
+/** Whether a value is a violation, as it arrives in a message. */
+export const isViolation = (value) => {
+    if (typeof value !== "object" || value === null)
+        return false;
+    const record = { ...value };
+    const impact = record["impact"];
+    const targets = record["targets"];
+    return (typeof record["id"] === "string" &&
+        typeof record["help"] === "string" &&
+        typeof record["helpUrl"] === "string" &&
+        (impact === undefined ||
+            impact === "minor" ||
+            impact === "moderate" ||
+            impact === "serious" ||
+            impact === "critical") &&
+        Array.isArray(targets) &&
+        targets.every((target) => typeof target === "string"));
+};
+//# sourceMappingURL=a11y.js.map

package/dist/src/a11y.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"a11y.js","sourceRoot":"","sources":["../../src/a11y.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAmBH,kEAAkE;AAClE,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAc,EAAsB,EAAE;IAChE,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,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IAClC,OAAO,CACL,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,QAAQ;QAChC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,QAAQ;QAClC,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,QAAQ;QACrC,CAAC,MAAM,KAAK,SAAS;YACnB,MAAM,KAAK,OAAO;YAClB,MAAM,KAAK,UAAU;YACrB,MAAM,KAAK,SAAS;YACpB,MAAM,KAAK,UAAU,CAAC;QACxB,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;QACtB,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,CACtD,CAAC;AACJ,CAAC,CAAC"}

package/dist/src/argTypes.d.ts

@@ -0,0 +1,114 @@
+/**
+ * A story's `argTypes` (Storybook's): read in the frame from the meta and the story, sent to the shell in a form that
+ * crosses between the documents, laid over the props the component's types give, and their `mapping` applied to the
+ * args the story receives.
+ *
+ * @remarks
+ * The panel's props come from the component's types (`componentDocs.ts`); `argTypes` say otherwise where a story
+ * means another control, other options, other names, or an arg the types do not name. Without `argTypes` the panel
+ * shows the props exactly as the types give them. Option values that cannot cross (a component, a function) are
+ * sent as their `mapping` keys, which the frame turns back into the values. `object` and `file` controls have no
+ * control in the panel: their args are listed for reading. Pure.
+ *
+ * @module
+ */
+import type { StoryControlsSetting } from "@forgebook/story-format/source";
+import type { PropDocs } from "./componentDocs.ts";
+/** A control as the panel draws it; `none` for an arg the panel lists without a control. */
+export type PanelControl = "select" | "radio" | "check" | "multi-select" | "boolean" | "text" | "number" | "range" | "color" | "date" | "none";
+/** How the panel shows one arg, from its `argTypes` entry: what crosses from the frame to the shell. */
+export type PanelArgType = {
+    /** The name the panel shows, when it is not the arg's. */
+    readonly label?: string;
+    /** What the arg does, over its TSDoc. */
+    readonly description?: string;
+    /** Whether the panel leaves the arg out. */
+    readonly isHidden: boolean;
+    /** Its control, when the entry names one (or gives options, which make a choice). */
+    readonly control?: PanelControl;
+    /** A choice's options: texts and numbers, or the `mapping` keys the story receives values for. */
+    readonly options?: readonly (string | number)[];
+    /** The names shown for the options, by option. */
+    readonly labels?: Readonly<Record<string, string>>;
+    /** A range's or a number's lowest value. */
+    readonly min?: number;
+    /** A range's or a number's highest value. */
+    readonly max?: number;
+    /** A range's or a number's step. */
+    readonly step?: number;
+};
+/** The panel's arg types, by arg. */
+export type PanelArgTypes = Readonly<Record<string, PanelArgType>>;
+/** A prop as the panel shows it: its docs with what `argTypes` say laid over them. */
+export type PanelProp = PropDocs & {
+    /** The name the panel shows, when it is not the prop's. */
+    readonly label?: string;
+    /** The control `argTypes` name; none leaves it to the prop's kind. */
+    readonly control?: PanelControl;
+    /** The names shown for a choice's values, by value. */
+    readonly labels?: Readonly<Record<string, string>>;
+    /** A range's or a number's lowest value. */
+    readonly min?: number;
+    /** A range's or a number's highest value. */
+    readonly max?: number;
+    /** A range's or a number's step. */
+    readonly step?: number;
+};
+/**
+ * The `argTypes` of the meta and the story, merged: each arg's entry from both, the story's fields over the meta's.
+ *
+ * @param meta - the meta's `argTypes`.
+ * @param story - the story's `argTypes`.
+ */
+export declare const mergedArgTypes: (meta: unknown, story: unknown) => Readonly<Record<string, Readonly<Record<string, unknown>>>>;
+/**
+ * The arg types the frame sends: each entry read, and the args `parameters.controls.exclude` names hidden.
+ *
+ * @param argTypes - the merged `argTypes`.
+ * @param excluded - the args `parameters.controls.exclude` names.
+ */
+export declare const panelArgTypesOf: (argTypes: Readonly<Record<string, Readonly<Record<string, unknown>>>>, excluded: readonly string[]) => PanelArgTypes;
+/**
+ * The args with each `mapping` applied: an arg whose value is a key of its entry's `mapping` receives the value the
+ * key stands for, as Storybook's (an arg written as the key in the story, or chosen in the panel).
+ *
+ * @param args - the args.
+ * @param argTypes - the merged `argTypes`.
+ */
+export declare const mappedArgs: (args: Readonly<Record<string, unknown>>, argTypes: Readonly<Record<string, Readonly<Record<string, unknown>>>>) => Readonly<Record<string, unknown>>;
+/**
+ * The panel's props: the component's, with their arg types laid over them, the hidden ones left out, then the args
+ * only the arg types name, in their order.
+ *
+ * @param props - the props the component's types give.
+ * @param argTypes - the story's arg types; none leaves the props as they are.
+ */
+export declare const panelProps: (props: readonly PropDocs[], argTypes: PanelArgTypes) => readonly PanelProp[];
+/**
+ * The props the panel can set, as the story's parameters say: `false` none, a list or `{ include }` those, anything
+ * else every one.
+ *
+ * @param value - `parameters.controls`.
+ */
+export declare const controlsOfParameter: (value: unknown) => StoryControlsSetting;
+/**
+ * The args `parameters.controls.exclude` hides.
+ *
+ * @param value - `parameters.controls`.
+ */
+export declare const excludedControls: (value: unknown) => readonly string[];
+/**
+ * Whether a value received from a frame is a story's panel arg types.
+ *
+ * @param value - the message's field.
+ */
+export declare const isPanelArgTypes: (value: unknown) => value is PanelArgTypes;
+/**
+ * The args whose calls the Events tab records as actions: those whose value is a spy, and those whose `argTypes`
+ * entry names an `action`. Explicit only: no arg is recorded for its name alone.
+ *
+ * @param args - the story's args.
+ * @param argTypes - the merged `argTypes`.
+ */
+export declare const actionNames: (args: Readonly<Record<string, unknown>>, argTypes: Readonly<Record<string, Readonly<Record<string, unknown>>>>) => readonly string[];
+//# sourceMappingURL=argTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"argTypes.d.ts","sourceRoot":"","sources":["../../src/argTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAE3E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEnD,4FAA4F;AAC5F,MAAM,MAAM,YAAY,GACpB,QAAQ,GACR,OAAO,GACP,OAAO,GACP,cAAc,GACd,SAAS,GACT,MAAM,GACN,QAAQ,GACR,OAAO,GACP,OAAO,GACP,MAAM,GACN,MAAM,CAAC;AAEX,wGAAwG;AACxG,MAAM,MAAM,YAAY,GAAG;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,yCAAyC;IACzC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,qFAAqF;IACrF,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC;IAChC,kGAAkG;IAClG,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAChD,kDAAkD;IAClD,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACnD,4CAA4C;IAC5C,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,6CAA6C;IAC7C,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,qCAAqC;AACrC,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;AAEnE,sFAAsF;AACtF,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG;IACjC,2DAA2D;IAC3D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,sEAAsE;IACtE,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC;IAChC,uDAAuD;IACvD,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACnD,4CAA4C;IAC5C,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,6CAA6C;IAC7C,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAgGF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GACzB,MAAM,OAAO,EACb,OAAO,OAAO,KACb,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAS5D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAC1B,UAAU,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,EACrE,UAAU,SAAS,MAAM,EAAE,KAC1B,aAKF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,GACrB,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EACvC,UAAU,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,KACpE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAShC,CAAC;AA6CJ;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,GAAI,OAAO,SAAS,QAAQ,EAAE,EAAE,UAAU,aAAa,KAAG,SAAS,SAAS,EAWlG,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,GAAI,OAAO,OAAO,KAAG,oBAMpD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAAI,OAAO,OAAO,KAAG,SAAS,MAAM,EAGhE,CAAC;AAWF;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,aACK,CAAC;AAKhE;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GACtB,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EACvC,UAAU,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,KACpE,SAAS,MAAM,EAOjB,CAAC"}

package/dist/src/argTypes.js

@@ -0,0 +1,254 @@
+/**
+ * A story's `argTypes` (Storybook's): read in the frame from the meta and the story, sent to the shell in a form that
+ * crosses between the documents, laid over the props the component's types give, and their `mapping` applied to the
+ * args the story receives.
+ *
+ * @remarks
+ * The panel's props come from the component's types (`componentDocs.ts`); `argTypes` say otherwise where a story
+ * means another control, other options, other names, or an arg the types do not name. Without `argTypes` the panel
+ * shows the props exactly as the types give them. Option values that cannot cross (a component, a function) are
+ * sent as their `mapping` keys, which the frame turns back into the values. `object` and `file` controls have no
+ * control in the panel: their args are listed for reading. Pure.
+ *
+ * @module
+ */
+/** Whether a value is a plain object. */
+const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+/** Storybook's control names, as the panel draws them (the inline variants look the same here). */
+const CONTROLS = {
+    select: "select",
+    radio: "radio",
+    "inline-radio": "radio",
+    check: "check",
+    "inline-check": "check",
+    "multi-select": "multi-select",
+    boolean: "boolean",
+    text: "text",
+    number: "number",
+    range: "range",
+    color: "color",
+    date: "date",
+    object: "none",
+    file: "none"
+};
+/** The panel controls, for the check on arrival. */
+const PANEL_CONTROLS = [...new Set(Object.values(CONTROLS))];
+/** A number field of an object, when it is a finite number. */
+const numberOf = (part, name) => {
+    const value = part[name];
+    return typeof value === "number" && Number.isFinite(value) ? value : undefined;
+};
+/** The labels of a control, when every one is a text. */
+const labelsOf = (value) => isRecord(value) && Object.values(value).every((label) => typeof label === "string")
+    ? Object.fromEntries(Object.entries(value).map(([option, label]) => [option, String(label)]))
+    : undefined;
+/**
+ * The control an entry names: `false` and a disabled control are none, a name or `{ type }` is that control, and
+ * options without a control make a select.
+ */
+const controlOf = (entry) => {
+    const control = entry["control"];
+    if (control === false)
+        return "none";
+    if (typeof control === "string")
+        return CONTROLS[control];
+    if (isRecord(control)) {
+        if (control["disable"] === true)
+            return "none";
+        if (typeof control["type"] === "string")
+            return CONTROLS[control["type"]];
+    }
+    return Array.isArray(entry["options"]) ? "select" : undefined;
+};
+/**
+ * The options as they cross: texts and numbers as they are; any other value only through `mapping`, whose keys are
+ * the options then.
+ */
+const optionsOf = (entry) => {
+    const options = entry["options"];
+    if (!Array.isArray(options))
+        return undefined;
+    return options.filter((option) => typeof option === "string" || typeof option === "number");
+};
+/**
+ * One entry as the panel reads it.
+ *
+ * @param entry - the `argTypes` entry, the story's laid over the meta's.
+ * @param isExcluded - whether `parameters.controls.exclude` names the arg.
+ */
+const panelArgTypeOf = (entry, isExcluded) => {
+    const control = controlOf(entry);
+    const options = optionsOf(entry);
+    const settings = isRecord(entry["control"]) ? entry["control"] : {};
+    const table = entry["table"];
+    const name = entry["name"];
+    const description = entry["description"];
+    const labels = labelsOf(settings["labels"]);
+    const min = numberOf(settings, "min");
+    const max = numberOf(settings, "max");
+    const step = numberOf(settings, "step");
+    return {
+        isHidden: isExcluded || (isRecord(table) && table["disable"] === true),
+        ...(typeof name === "string" ? { label: name } : {}),
+        ...(typeof description === "string" ? { description } : {}),
+        ...(control === undefined ? {} : { control }),
+        ...(options === undefined ? {} : { options }),
+        ...(labels === undefined ? {} : { labels }),
+        ...(min === undefined ? {} : { min }),
+        ...(max === undefined ? {} : { max }),
+        ...(step === undefined ? {} : { step })
+    };
+};
+/**
+ * The `argTypes` of the meta and the story, merged: each arg's entry from both, the story's fields over the meta's.
+ *
+ * @param meta - the meta's `argTypes`.
+ * @param story - the story's `argTypes`.
+ */
+export const mergedArgTypes = (meta, story) => {
+    const merged = {};
+    for (const part of [meta, story]) {
+        if (!isRecord(part))
+            continue;
+        for (const [name, entry] of Object.entries(part)) {
+            if (isRecord(entry))
+                merged[name] = { ...merged[name], ...entry };
+        }
+    }
+    return merged;
+};
+/**
+ * The arg types the frame sends: each entry read, and the args `parameters.controls.exclude` names hidden.
+ *
+ * @param argTypes - the merged `argTypes`.
+ * @param excluded - the args `parameters.controls.exclude` names.
+ */
+export const panelArgTypesOf = (argTypes, excluded) => {
+    const names = [...new Set([...Object.keys(argTypes), ...excluded])];
+    return Object.fromEntries(names.map((name) => [name, panelArgTypeOf(argTypes[name] ?? {}, excluded.includes(name))]));
+};
+/**
+ * The args with each `mapping` applied: an arg whose value is a key of its entry's `mapping` receives the value the
+ * key stands for, as Storybook's (an arg written as the key in the story, or chosen in the panel).
+ *
+ * @param args - the args.
+ * @param argTypes - the merged `argTypes`.
+ */
+export const mappedArgs = (args, argTypes) => Object.fromEntries(Object.entries(args).map(([name, value]) => {
+    const mapping = argTypes[name]?.["mapping"];
+    if (!isRecord(mapping) || (typeof value !== "string" && typeof value !== "number"))
+        return [name, value];
+    const key = String(value);
+    return [name, key in mapping ? mapping[key] : value];
+}));
+/** The prop kind a control sets, for the panel's groups. */
+const KIND_OF_CONTROL = {
+    select: "choice",
+    radio: "choice",
+    check: "choice",
+    "multi-select": "choice",
+    boolean: "toggle",
+    text: "text",
+    number: "number",
+    range: "number",
+    color: "text",
+    date: "number",
+    none: "other"
+};
+/**
+ * A prop with its arg type laid over it.
+ *
+ * @param prop - the prop as the types give it.
+ * @param argType - its arg type.
+ */
+const withArgType = (prop, argType) => {
+    const { control } = argType;
+    // a control the panel cannot draw makes the prop one it lists for reading, never one that takes a text
+    const isReadOnly = control === "none";
+    const { canTakeText: _canTakeText, ...rest } = prop;
+    return {
+        ...(isReadOnly ? rest : prop),
+        ...(control === undefined ? {} : { kind: KIND_OF_CONTROL[control], control }),
+        ...(argType.options === undefined ? {} : { choices: argType.options }),
+        ...(argType.description === undefined ? {} : { description: argType.description }),
+        ...(argType.label === undefined ? {} : { label: argType.label }),
+        ...(argType.labels === undefined ? {} : { labels: argType.labels }),
+        ...(argType.min === undefined ? {} : { min: argType.min }),
+        ...(argType.max === undefined ? {} : { max: argType.max }),
+        ...(argType.step === undefined ? {} : { step: argType.step })
+    };
+};
+/** A prop the types do not name, made from its arg type alone: a text when it names no control. */
+const propOfArgType = (name, argType) => withArgType({ name, kind: "text", type: "", description: "", isRequired: false }, argType);
+/**
+ * The panel's props: the component's, with their arg types laid over them, the hidden ones left out, then the args
+ * only the arg types name, in their order.
+ *
+ * @param props - the props the component's types give.
+ * @param argTypes - the story's arg types; none leaves the props as they are.
+ */
+export const panelProps = (props, argTypes) => {
+    const typed = new Set(props.map((prop) => prop.name));
+    const fromTypes = props.flatMap((prop) => {
+        const argType = argTypes[prop.name];
+        if (argType === undefined)
+            return [prop];
+        return argType.isHidden ? [] : [withArgType(prop, argType)];
+    });
+    const fromArgTypes = Object.entries(argTypes).flatMap(([name, argType]) => typed.has(name) || argType.isHidden ? [] : [propOfArgType(name, argType)]);
+    return [...fromTypes, ...fromArgTypes];
+};
+/**
+ * The props the panel can set, as the story's parameters say: `false` none, a list or `{ include }` those, anything
+ * else every one.
+ *
+ * @param value - `parameters.controls`.
+ */
+export const controlsOfParameter = (value) => {
+    if (value === false)
+        return [];
+    if (Array.isArray(value) && value.every((name) => typeof name === "string"))
+        return value;
+    const include = isRecord(value) ? value["include"] : undefined;
+    if (Array.isArray(include) && include.every((name) => typeof name === "string"))
+        return include;
+    return "all";
+};
+/**
+ * The args `parameters.controls.exclude` hides.
+ *
+ * @param value - `parameters.controls`.
+ */
+export const excludedControls = (value) => {
+    const exclude = isRecord(value) ? value["exclude"] : undefined;
+    return Array.isArray(exclude) ? exclude.filter((name) => typeof name === "string") : [];
+};
+/** Whether a value is one arg's panel arg type. */
+const isPanelArgType = (value) => isRecord(value) &&
+    typeof value["isHidden"] === "boolean" &&
+    (value["control"] === undefined || PANEL_CONTROLS.some((control) => control === value["control"])) &&
+    (value["options"] === undefined ||
+        (Array.isArray(value["options"]) &&
+            value["options"].every((option) => typeof option === "string" || typeof option === "number")));
+/**
+ * Whether a value received from a frame is a story's panel arg types.
+ *
+ * @param value - the message's field.
+ */
+export const isPanelArgTypes = (value) => isRecord(value) && Object.values(value).every(isPanelArgType);
+/** Whether a value is a spy (`fn()` of `storybook/test` or Vitest): a function with its calls under `mock`. */
+const isSpy = (value) => typeof value === "function" && "mock" in value;
+/**
+ * The args whose calls the Events tab records as actions: those whose value is a spy, and those whose `argTypes`
+ * entry names an `action`. Explicit only: no arg is recorded for its name alone.
+ *
+ * @param args - the story's args.
+ * @param argTypes - the merged `argTypes`.
+ */
+export const actionNames = (args, argTypes) => [
+    ...new Set([
+        ...Object.entries(args).flatMap(([name, value]) => (isSpy(value) ? [name] : [])),
+        ...Object.entries(argTypes).flatMap(([name, entry]) => typeof entry["action"] === "string" || entry["action"] === true ? [name] : [])
+    ])
+];
+//# sourceMappingURL=argTypes.js.map

package/dist/src/argTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"argTypes.js","sourceRoot":"","sources":["../../src/argTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AA6DH,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,mGAAmG;AACnG,MAAM,QAAQ,GAA2C;IACvD,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;IACd,cAAc,EAAE,OAAO;IACvB,KAAK,EAAE,OAAO;IACd,cAAc,EAAE,OAAO;IACvB,cAAc,EAAE,cAAc;IAC9B,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,MAAM;CACb,CAAC;AAEF,oDAAoD;AACpD,MAAM,cAAc,GAA4B,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;AAEtF,+DAA+D;AAC/D,MAAM,QAAQ,GAAG,CAAC,IAAuC,EAAE,IAAY,EAAsB,EAAE;IAC7F,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACjF,CAAC,CAAC;AAEF,yDAAyD;AACzD,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAgD,EAAE,CAChF,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC;IACjF,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC7F,CAAC,CAAC,SAAS,CAAC;AAEhB;;;GAGG;AACH,MAAM,SAAS,GAAG,CAAC,KAAwC,EAA4B,EAAE;IACvF,MAAM,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;IACjC,IAAI,OAAO,KAAK,KAAK;QAAE,OAAO,MAAM,CAAC;IACrC,IAAI,OAAO,OAAO,KAAK,QAAQ;QAAE,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC1D,IAAI,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACtB,IAAI,OAAO,CAAC,SAAS,CAAC,KAAK,IAAI;YAAE,OAAO,MAAM,CAAC;QAC/C,IAAI,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,QAAQ;YAAE,OAAO,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5E,CAAC;IACD,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;AAChE,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,SAAS,GAAG,CAAC,KAAwC,EAA4C,EAAE;IACvG,MAAM,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;IACjC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;QAAE,OAAO,SAAS,CAAC;IAC9C,OAAO,OAAO,CAAC,MAAM,CACnB,CAAC,MAAM,EAA6B,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ,CAChG,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,cAAc,GAAG,CAAC,KAAwC,EAAE,UAAmB,EAAgB,EAAE;IACrG,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACpE,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAC3B,MAAM,WAAW,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;IACzC,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC5C,MAAM,GAAG,GAAG,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACtC,MAAM,GAAG,GAAG,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACtC,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACxC,OAAO;QACL,QAAQ,EAAE,UAAU,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC;QACtE,GAAG,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACpD,GAAG,CAAC,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC;QAC7C,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC;QAC7C,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;QAC3C,GAAG,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC;QACrC,GAAG,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC;QACrC,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;KACxC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,IAAa,EACb,KAAc,EAC+C,EAAE;IAC/D,MAAM,MAAM,GAAsD,EAAE,CAAC;IACrE,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;QACjC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,SAAS;QAC9B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACjD,IAAI,QAAQ,CAAC,KAAK,CAAC;gBAAE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,KAAK,EAAE,CAAC;QACpE,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,QAAqE,EACrE,QAA2B,EACZ,EAAE;IACjB,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IACpE,OAAO,MAAM,CAAC,WAAW,CACvB,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAC3F,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,IAAuC,EACvC,QAAqE,EAClC,EAAE,CACrC,MAAM,CAAC,WAAW,CAChB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE;IACzC,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;IAC5C,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;QAChF,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACvB,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1B,OAAO,CAAC,IAAI,EAAE,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AACvD,CAAC,CAAC,CACH,CAAC;AAEJ,4DAA4D;AAC5D,MAAM,eAAe,GAAqD;IACxE,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,QAAQ;IACf,KAAK,EAAE,QAAQ;IACf,cAAc,EAAE,QAAQ;IACxB,OAAO,EAAE,QAAQ;IACjB,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,QAAQ;IACf,KAAK,EAAE,MAAM;IACb,IAAI,EAAE,QAAQ;IACd,IAAI,EAAE,OAAO;CACd,CAAC;AAEF;;;;;GAKG;AACH,MAAM,WAAW,GAAG,CAAC,IAAc,EAAE,OAAqB,EAAa,EAAE;IACvE,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAC5B,uGAAuG;IACvG,MAAM,UAAU,GAAG,OAAO,KAAK,MAAM,CAAC;IACtC,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;IACpD,OAAO;QACL,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QAC7B,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;QAC7E,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;QACtE,GAAG,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC;QAClF,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;QAChE,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;QACnE,GAAG,CAAC,OAAO,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;QAC1D,GAAG,CAAC,OAAO,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;QAC1D,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;KAC9D,CAAC;AACJ,CAAC,CAAC;AAEF,mGAAmG;AACnG,MAAM,aAAa,GAAG,CAAC,IAAY,EAAE,OAAqB,EAAa,EAAE,CACvE,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;AAE7F;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAA0B,EAAE,QAAuB,EAAwB,EAAE;IACtG,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACtD,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAe,EAAE;QACpD,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QACzC,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IACH,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,EAAe,EAAE,CACrF,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAC1E,CAAC;IACF,OAAO,CAAC,GAAG,SAAS,EAAE,GAAG,YAAY,CAAC,CAAC;AACzC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,KAAc,EAAwB,EAAE;IAC1E,IAAI,KAAK,KAAK,KAAK;QAAE,OAAO,EAAE,CAAC;IAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC;QAAE,OAAO,KAAK,CAAC;IAC1F,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/D,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC;QAAE,OAAO,OAAO,CAAC;IAChG,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAAqB,EAAE;IACpE,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/D,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC1G,CAAC,CAAC;AAEF,mDAAmD;AACnD,MAAM,cAAc,GAAG,CAAC,KAAc,EAAyB,EAAE,CAC/D,QAAQ,CAAC,KAAK,CAAC;IACf,OAAO,KAAK,CAAC,UAAU,CAAC,KAAK,SAAS;IACtC,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,SAAS,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IAClG,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,SAAS;QAC7B,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAC9B,KAAK,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC;AAErG;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,KAAc,EAA0B,EAAE,CACxE,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;AAEhE,+GAA+G;AAC/G,MAAM,KAAK,GAAG,CAAC,KAAc,EAAW,EAAE,CAAC,OAAO,KAAK,KAAK,UAAU,IAAI,MAAM,IAAI,KAAK,CAAC;AAE1F;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,IAAuC,EACvC,QAAqE,EAClD,EAAE,CAAC;IACtB,GAAG,IAAI,GAAG,CAAC;QACT,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAChF,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CACpD,OAAO,KAAK,CAAC,QAAQ,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAC9E;KACF,CAAC;CACH,CAAC"}

package/dist/src/backdrops.d.ts

@@ -0,0 +1,88 @@
+/**
+ * The backdrops Forgebook draws behind a story in place of its page's colour (D-644): a checkerboard, a vivid
+ * abstract picture, a light and a dark desktop-like picture, a page of content, and a catalogue's own. They show what a translucent
+ * surface (a menu's or a popover's glass, its blur) does, which the page's plain colour hides.
+ *
+ * @remarks
+ * Every picture is drawn here in CSS gradients and inline SVG: no image file, nothing fetched, nothing of the library
+ * the catalogue shows (D-67), invented words only. The frame turns the chosen backdrop into a style sheet of its
+ * own (`backdropSheet`) that replaces the `body` background its source sets, so the story's own layout and colours
+ * are unchanged; the shell reads the backdrop's colour (`backdropColor`) for the box a story waits in while it loads.
+ * The desktop pictures are fixed whatever the theme; the page of content follows the theme, as an app's page would
+ * (D-651). With forced colours nothing is drawn: the system's palette decides the page (D-650). Pure.
+ *
+ * @module
+ */
+/** A backdrop as CSS, for one colour scheme. */
+export type BackdropLook = {
+    /** The colour under the pictures, which the box of a loading story waits on. */
+    readonly color: string;
+    /** The picture's layers, as the `background` shorthand writes them (image, position, size, repeat), top first. */
+    readonly layers: string;
+};
+/** A drawn backdrop: its look in a light and a dark theme, the same look when it does not follow the theme. */
+export type DrawnBackdrop = {
+    /** The look in the light theme. */
+    readonly light: BackdropLook;
+    /** The look in the dark theme. */
+    readonly dark: BackdropLook;
+};
+/** A backdrop the View menu offers: its id (the address's `backdrop`), its name, its look. */
+export type Backdrop = {
+    /** Its id, as the address writes it (`checkerboard`). */
+    readonly id: string;
+    /** Its name in the View menu. */
+    readonly label: string;
+    /** Its look in each scheme. */
+    readonly drawn: DrawnBackdrop;
+};
+/**
+ * A catalogue's own backdrop, as its configuration writes it: a colour and, optionally, CSS layers over it, for the
+ * light scheme and, when it differs, the dark one.
+ */
+export type CustomBackdrop = {
+    /** Its id, as the address writes it. */
+    readonly id: string;
+    /** Its name in the View menu. */
+    readonly label: string;
+    /** Its look in the light scheme (and the dark one without `dark`). */
+    readonly light: {
+        readonly color: string;
+        readonly layers?: string;
+    };
+    /** Its look in the dark scheme; the light one by default. */
+    readonly dark?: {
+        readonly color: string;
+        readonly layers?: string;
+    };
+};
+/** The backdrops Forgebook draws, in the View menu's order: every one but the page's own colour. */
+export declare const BUILT_IN_BACKDROPS: readonly Backdrop[];
+/**
+ * A catalogue's own backdrop, drawn as the built-in ones are.
+ *
+ * @param custom - the backdrop as the configuration writes it.
+ */
+export declare const customBackdrop: (custom: CustomBackdrop) => Backdrop;
+/**
+ * The colour a backdrop is drawn on, which the box of a loading story waits on.
+ *
+ * @param backdrop - the backdrop; none for the page's own colour.
+ * @param isDark - whether the story is drawn in the dark scheme (a backdrop may follow it).
+ * @returns the CSS colour; none for the page's own colour.
+ */
+export declare const backdropColor: (backdrop: Backdrop | undefined, isDark: boolean) => string | undefined;
+/**
+ * The style sheet that draws a backdrop behind a frame's story.
+ *
+ * @remarks
+ * The rule sits on `body`, where the sources set their page colour, and wins over it with `!important`, so the
+ * story's own elements keep every colour they set. The dark look follows the scheme the view draws in (its colour
+ * scheme switch's, `switches.ts`), the system's preference for `system`; with forced colours the sheet draws nothing.
+ *
+ * @param backdrop - the backdrop; none for the page's own colour.
+ * @param scheme - the scheme the story is drawn in.
+ * @returns the CSS; empty for the page's own colour.
+ */
+export declare const backdropSheet: (backdrop: Backdrop | undefined, scheme: "light" | "dark" | "system") => string;
+//# sourceMappingURL=backdrops.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"backdrops.d.ts","sourceRoot":"","sources":["../../src/backdrops.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,gDAAgD;AAChD,MAAM,MAAM,YAAY,GAAG;IACzB,gFAAgF;IAChF,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,kHAAkH;IAClH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,+GAA+G;AAC/G,MAAM,MAAM,aAAa,GAAG;IAC1B,mCAAmC;IACnC,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC;IAC7B,kCAAkC;IAClC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;CAC7B,CAAC;AAEF,8FAA8F;AAC9F,MAAM,MAAM,QAAQ,GAAG;IACrB,yDAAyD;IACzD,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,+BAA+B;IAC/B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,wCAAwC;IACxC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,sEAAsE;IACtE,QAAQ,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACrE,6DAA6D;IAC7D,QAAQ,CAAC,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACtE,CAAC;AAqMF,oGAAoG;AACpG,eAAO,MAAM,kBAAkB,EAAE,SAAS,QAAQ,EAMjD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,cAAc,KAAG,QAUvD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,GAAI,UAAU,QAAQ,GAAG,SAAS,EAAE,QAAQ,OAAO,KAAG,MAAM,GAAG,SACS,CAAC;AAMnG;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,aAAa,GACxB,UAAU,QAAQ,GAAG,SAAS,EAC9B,QAAQ,OAAO,GAAG,MAAM,GAAG,QAAQ,KAClC,MAUF,CAAC"}