forgebook 0.0.0-stage → 0.1.0

package/dist/src/viewState.js

@@ -0,0 +1,303 @@
+/**
+ * The toolbar's switches as a value, read from and written to the URL, so a view is shared with a link and the
+ * frames and the tests open the same address.
+ *
+ * @remarks
+ * Only values that differ from the defaults are written; an unknown or invalid value reads as the default. The view
+ * holds a value for each switch the catalogue declares (`switches.ts`: the theme, the contrast, the language, the
+ * library's own), which the frame applies on its root or hands the story; and Forgebook's own settings: the style
+ * sheets, the root font size and the backdrop Forgebook draws behind the story. The stage's width, height, zoom and tools and the panel (open, its tab) are the shell's alone: a frame's address leaves them
+ * out. Pure.
+ *
+ * @module
+ */
+import { switchValueOf, switchWithRole } from "./switches.js";
+/** The page's own colour: no backdrop drawn. */
+export const PLAIN_BACKDROP = "plain";
+/** Forgebook's own settings the compare view can set side by side. */
+export const OWN_COMPARE_AXES = ["text", "sheets"];
+/** The view without any change. */
+export const DEFAULT_VIEW = {
+    switches: {},
+    backdrop: "plain",
+    sheets: "full",
+    text: 100,
+    compare: [],
+    width: "fill",
+    height: "auto",
+    isPanelOpen: true,
+    panelTab: "props",
+    zoom: 100,
+    tools: []
+};
+/** Every style sheet setting, in the menu's order. */
+export const SHEETS_CHOICES = ["full", "structure", "restyled"];
+/**
+ * Whether the stage compares the story across a switch's values.
+ *
+ * @param view - the view.
+ */
+export const isComparing = (view) => view.compare.length > 0;
+/** Every tool, in the bar's order. */
+export const MEASURE_TOOLS = ["outline", "grid", "measure"];
+/** The tools a parameter names (`outline,measure`), in their order; unknown names are left out. */
+const toolsOf = (value) => {
+    const names = (value ?? "").split(",");
+    return MEASURE_TOOLS.filter((tool) => names.includes(tool));
+};
+/**
+ * A width kept in a catalogue's range, in whole pixels.
+ *
+ * @param width - a width in CSS px.
+ * @param range - the narrowest and widest a story may be set.
+ */
+export const clampedWidth = (width, range) => Math.round(Math.min(range.max, Math.max(range.min, width)));
+/** The width a parameter names: a whole number of px in the range, otherwise the stage's whole width. */
+const stageWidth = (value, range) => {
+    const width = Number(value);
+    return value !== null && Number.isInteger(width) && clampedWidth(width, range) === width ? width : "fill";
+};
+/** The lowest and highest story a height in the address or a drag may set, in CSS px. */
+export const STAGE_HEIGHT_RANGE = { min: 48, max: 4000 };
+/**
+ * A height kept in the range, in whole pixels.
+ *
+ * @param height - a height in CSS px.
+ */
+export const clampedHeight = (height) => Math.round(Math.min(STAGE_HEIGHT_RANGE.max, Math.max(STAGE_HEIGHT_RANGE.min, height)));
+/** The height a parameter names: a whole number of px in the range, otherwise the story's own. */
+const stageHeight = (value) => {
+    const height = Number(value);
+    return value !== null && Number.isInteger(height) && clampedHeight(height) === height ? height : "auto";
+};
+/** The value of a parameter when it is one of the choices, otherwise the default. */
+const choice = (value, choices, fallback) => choices.find((option) => String(option) === value) ?? fallback;
+/**
+ * Each declared switch's value an address names, the default for one it leaves out or names wrongly.
+ *
+ * @param params - the address's parameters.
+ * @param switches - the declared switches.
+ */
+const switchValuesOf = (params, switches) => Object.fromEntries(switches.map((each) => [
+    each.id,
+    switchValueOf(each, params.get(each.id) ?? undefined)?.value ?? each.default
+]));
+/**
+ * The compared axes a `compare` parameter names: one or two switch ids, `text` or `sheets`. `theme` (and `1`, the form
+ * older addresses wrote) is the colour scheme at both contrasts, `language` the language switch, as the toolbar
+ * named them before switches were declared.
+ *
+ * @param value - the parameter.
+ * @param switches - the declared switches.
+ */
+const compareAxesOf = (value, switches) => {
+    if (value === null || value === "")
+        return [];
+    const scheme = switchWithRole(switches, "colorScheme");
+    const contrast = switchWithRole(switches, "contrast");
+    const legacy = {
+        "1": [scheme?.id, contrast?.id],
+        theme: [scheme?.id, contrast?.id],
+        language: [switchWithRole(switches, "language")?.id]
+    };
+    const named = legacy[value] ?? value.split(",");
+    const known = [...switches.map((each) => each.id), ...OWN_COMPARE_AXES];
+    return named.filter((axis) => axis !== undefined && known.includes(axis)).slice(0, 2);
+};
+/**
+ * The view a URL's query describes.
+ *
+ * @param search - the query (`?theme=dark&motion=reduced`), with or without `?`.
+ * @param catalogue - the catalogue's switches and lists.
+ */
+export const parseView = (search, catalogue) => {
+    const params = new URLSearchParams(search);
+    return {
+        switches: switchValuesOf(params, catalogue.switches),
+        backdrop: choice(params.get("backdrop"), catalogue.backdrops.map((backdrop) => backdrop.id), DEFAULT_VIEW.backdrop),
+        sheets: choice(params.get("sheets"), SHEETS_CHOICES, DEFAULT_VIEW.sheets),
+        text: choice(params.get("text"), catalogue.textSizes, DEFAULT_VIEW.text),
+        compare: compareAxesOf(params.get("compare"), catalogue.switches),
+        width: stageWidth(params.get("width"), catalogue.widthRange),
+        height: stageHeight(params.get("height")),
+        isPanelOpen: params.get("panel") !== "closed",
+        panelTab: choice(params.get("tab"), catalogue.tabs, catalogue.tabs[0] ?? DEFAULT_VIEW.panelTab),
+        zoom: choice(params.get("zoom"), catalogue.zooms, DEFAULT_VIEW.zoom),
+        tools: toolsOf(params.get("tools"))
+    };
+};
+/**
+ * The view without any change, for a catalogue.
+ *
+ * @param catalogue - the catalogue's switches and lists.
+ */
+export const defaultView = (catalogue) => parseView("", catalogue);
+/**
+ * Whether a switch's value in a view is its default (a switch the view does not hold counts as its default).
+ *
+ * @param view - the view.
+ * @param each - the switch.
+ */
+const isDefault = (view, each) => (view.switches[each.id] ?? each.default) === each.default;
+/**
+ * The parameters a frame's document reads, only what differs from the defaults: the switches in their declared
+ * order, then Forgebook's own settings, then the language.
+ */
+const frameParams = (view, switches) => {
+    const params = new URLSearchParams();
+    const language = switchWithRole(switches, "language");
+    const setSwitch = (each) => {
+        if (!isDefault(view, each))
+            params.set(each.id, view.switches[each.id] ?? each.default);
+    };
+    for (const each of switches)
+        if (each !== language)
+            setSwitch(each);
+    if (view.backdrop !== DEFAULT_VIEW.backdrop)
+        params.set("backdrop", view.backdrop);
+    if (view.sheets !== DEFAULT_VIEW.sheets)
+        params.set("sheets", view.sheets);
+    if (view.text !== DEFAULT_VIEW.text)
+        params.set("text", String(view.text));
+    if (language !== undefined)
+        setSwitch(language);
+    return params;
+};
+/**
+ * The query parameters of a view: only what differs from the defaults.
+ *
+ * @param view - the view.
+ * @param switches - the catalogue's switches.
+ * @returns the parameters, in a stable order.
+ */
+export const viewParams = (view, switches) => {
+    const params = frameParams(view, switches);
+    if (isComparing(view))
+        params.set("compare", view.compare.join(","));
+    if (view.width !== DEFAULT_VIEW.width)
+        params.set("width", String(view.width));
+    if (view.height !== DEFAULT_VIEW.height)
+        params.set("height", String(view.height));
+    if (!view.isPanelOpen)
+        params.set("panel", "closed");
+    if (view.panelTab !== DEFAULT_VIEW.panelTab)
+        params.set("tab", view.panelTab);
+    if (view.zoom !== DEFAULT_VIEW.zoom)
+        params.set("zoom", String(view.zoom));
+    if (view.tools.length > 0)
+        params.set("tools", view.tools.join(","));
+    return params;
+};
+/**
+ * Whether one of the View menu's settings is changed (a switch the toolbar does not show itself, the background,
+ * the style sheets, the text size): the menu button then shows a dot, so a view is never left changed by mistake.
+ *
+ * @param view - the view.
+ * @param switches - the catalogue's switches.
+ */
+export const hasViewChanges = (view, switches) => switches.some((each) => isMenuSwitch(each) && !isDefault(view, each)) ||
+    view.backdrop !== DEFAULT_VIEW.backdrop ||
+    view.sheets !== DEFAULT_VIEW.sheets ||
+    view.text !== DEFAULT_VIEW.text;
+/**
+ * Whether a switch sits in the View menu: every one but the colour scheme and the contrast, which the toolbar shows.
+ *
+ * @param each - the switch.
+ */
+export const isMenuSwitch = (each) => each.role !== "colorScheme" && each.role !== "contrast";
+/**
+ * The address of a story's frame.
+ *
+ * @param frameUrl - the frame page (`frame.html`).
+ * @param id - the story's id.
+ * @param view - the view; what only the shell reads (compare, the stage's width, the panel) is left out.
+ * @param switches - the catalogue's switches.
+ */
+export const frameAddress = (frameUrl, id, view, switches) => {
+    const params = frameParams(view, switches);
+    params.set("story", id);
+    return `${frameUrl}?${params.toString()}`;
+};
+/**
+ * The part of a view a frame applies live.
+ *
+ * @param view - the view.
+ */
+export const liveView = (view) => ({
+    switches: view.switches,
+    backdrop: view.backdrop,
+    text: view.text
+});
+/**
+ * The scheme a view draws in: its colour scheme switch's, light when the catalogue has none.
+ *
+ * @param view - the view's switches.
+ * @param switches - the catalogue's switches.
+ */
+export const schemeOf = (view, switches) => {
+    const scheme = switchWithRole(switches, "colorScheme");
+    if (scheme === undefined)
+        return "light";
+    return switchValueOf(scheme, view.switches[scheme.id])?.scheme ?? "light";
+};
+/**
+ * Whether a view draws in the higher contrast: its contrast switch's value says so; never without one.
+ *
+ * @param view - the view's switches.
+ * @param switches - the catalogue's switches.
+ */
+export const isMoreContrastOf = (view, switches) => {
+    const contrast = switchWithRole(switches, "contrast");
+    if (contrast === undefined)
+        return false;
+    return switchValueOf(contrast, view.switches[contrast.id])?.isMore === true;
+};
+/**
+ * The language a view shows: the language switch's value, empty for the stories' own text.
+ *
+ * @param view - the view's switches.
+ * @param switches - the catalogue's switches.
+ */
+export const languageOf = (view, switches) => {
+    const language = switchWithRole(switches, "language");
+    return language === undefined ? "" : (view.switches[language.id] ?? language.default);
+};
+/**
+ * The values of the switches applied by code, by id: what the story reads as `context.globals`.
+ *
+ * @param view - the view's switches.
+ * @param switches - the catalogue's switches.
+ */
+export const codeGlobalsOf = (view, switches) => Object.fromEntries(switches
+    .filter((each) => each.apply.kind === "code")
+    .map((each) => [each.id, view.switches[each.id] ?? each.default]));
+/** The parameters only the shell reads: a frame's address leaves them out. */
+const SHELL_PARAMETERS = [
+    "compare",
+    "width",
+    "height",
+    "panel",
+    "tab",
+    "zoom",
+    "tools",
+    "args",
+    "matrix",
+    "component"
+];
+/**
+ * The address of a story's frame from a catalogue's address query, for a tool that does not know the catalogue's
+ * switches (`forgebook-shot`): every parameter but the shell's own is kept as written.
+ *
+ * @param frameUrl - the frame page (`frame.html`).
+ * @param id - the story's id.
+ * @param search - the catalogue's query (`theme=dark&lang=it`), with or without `?`.
+ */
+export const frameAddressOf = (frameUrl, id, search) => {
+    const params = new URLSearchParams(search);
+    for (const name of SHELL_PARAMETERS)
+        params.delete(name);
+    params.delete("story");
+    params.set("story", id);
+    return `${frameUrl}?${params.toString()}`;
+};
+//# sourceMappingURL=viewState.js.map

package/dist/src/viewState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"viewState.js","sourceRoot":"","sources":["../../src/viewState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAGH,OAAO,EAAE,aAAa,EAAE,cAAc,EAAmB,MAAM,eAAe,CAAC;AAS/E,gDAAgD;AAChD,MAAM,CAAC,MAAM,cAAc,GAAG,OAAO,CAAC;AActC,sEAAsE;AACtE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAU,CAAC;AAiD5D,mCAAmC;AACnC,MAAM,CAAC,MAAM,YAAY,GAAc;IACrC,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,OAAO;IACjB,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,GAAG;IACT,OAAO,EAAE,EAAE;IACX,KAAK,EAAE,MAAM;IACb,MAAM,EAAE,MAAM;IACd,WAAW,EAAE,IAAI;IACjB,QAAQ,EAAE,OAAO;IACjB,IAAI,EAAE,GAAG;IACT,KAAK,EAAE,EAAE;CACV,CAAC;AAEF,sDAAsD;AACtD,MAAM,CAAC,MAAM,cAAc,GAA4B,CAAC,MAAM,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;AAEzF;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAe,EAAW,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;AAEjF,sCAAsC;AACtC,MAAM,CAAC,MAAM,aAAa,GAA2B,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;AAEpF,mGAAmG;AACnG,MAAM,OAAO,GAAG,CAAC,KAAoB,EAAiB,EAAE;IACtD,MAAM,KAAK,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACvC,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9D,CAAC,CAAC;AAQF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,KAAa,EAAE,KAAkC,EAAU,EAAE,CACxF,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AAE9D,yGAAyG;AACzG,MAAM,UAAU,GAAG,CAAC,KAAoB,EAAE,KAAkC,EAAc,EAAE;IAC1F,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC5B,OAAO,KAAK,KAAK,IAAI,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;AAC5G,CAAC,CAAC;AAEF,yFAAyF;AACzF,MAAM,CAAC,MAAM,kBAAkB,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAW,CAAC;AAElE;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAc,EAAU,EAAE,CACtD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;AAEzF,kGAAkG;AAClG,MAAM,WAAW,GAAG,CAAC,KAAoB,EAAe,EAAE;IACxD,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC7B,OAAO,KAAK,KAAK,IAAI,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,aAAa,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;AAC1G,CAAC,CAAC;AAEF,qFAAqF;AACrF,MAAM,MAAM,GAAG,CACb,KAAoB,EACpB,OAA2B,EAC3B,QAAiB,EACR,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,KAAK,CAAC,IAAI,QAAQ,CAAC;AAE7E;;;;;GAKG;AACH,MAAM,cAAc,GAAG,CACrB,MAAuB,EACvB,QAA+B,EACG,EAAE,CACpC,MAAM,CAAC,WAAW,CAChB,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;IACrB,IAAI,CAAC,EAAE;IACP,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,SAAS,CAAC,EAAE,KAAK,IAAI,IAAI,CAAC,OAAO;CAC7E,CAAC,CACH,CAAC;AAEJ;;;;;;;GAOG;AACH,MAAM,aAAa,GAAG,CAAC,KAAoB,EAAE,QAA+B,EAAe,EAAE;IAC3F,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE;QAAE,OAAO,EAAE,CAAC;IAC9C,MAAM,MAAM,GAAG,cAAc,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;IACvD,MAAM,QAAQ,GAAG,cAAc,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACtD,MAAM,MAAM,GAA8D;QACxE,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC;QAC/B,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC;QACjC,QAAQ,EAAE,CAAC,cAAc,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC;KACrD,CAAC;IACF,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChD,MAAM,KAAK,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,GAAG,gBAAgB,CAAC,CAAC;IACxE,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACxG,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,MAAc,EAAE,SAAwB,EAAa,EAAE;IAC/E,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;IAC3C,OAAO;QACL,QAAQ,EAAE,cAAc,CAAC,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC;QACpD,QAAQ,EAAE,MAAM,CACd,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,EACtB,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,EAClD,YAAY,CAAC,QAAQ,CACtB;QACD,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,cAAc,EAAE,YAAY,CAAC,MAAM,CAAC;QACzE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,SAAS,EAAE,YAAY,CAAC,IAAI,CAAC;QACxE,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC;QACjE,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC;QAC5D,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACzC,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,QAAQ;QAC7C,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC;QAC/F,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC;QACpE,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;KACpC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,SAAwB,EAAa,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;AAE7F;;;;;GAKG;AACH,MAAM,SAAS,GAAG,CAAC,IAAiC,EAAE,IAAgB,EAAW,EAAE,CACjF,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,GAAG,CAAC,IAAe,EAAE,QAA+B,EAAmB,EAAE;IACxF,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;IACrC,MAAM,QAAQ,GAAG,cAAc,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACtD,MAAM,SAAS,GAAG,CAAC,IAAgB,EAAQ,EAAE;QAC3C,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC;YAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;IAC1F,CAAC,CAAC;IACF,KAAK,MAAM,IAAI,IAAI,QAAQ;QAAE,IAAI,IAAI,KAAK,QAAQ;YAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IACpE,IAAI,IAAI,CAAC,QAAQ,KAAK,YAAY,CAAC,QAAQ;QAAE,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnF,IAAI,IAAI,CAAC,MAAM,KAAK,YAAY,CAAC,MAAM;QAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3E,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,CAAC,IAAI;QAAE,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3E,IAAI,QAAQ,KAAK,SAAS;QAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;IAChD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAe,EAAE,QAA+B,EAAmB,EAAE;IAC9F,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC3C,IAAI,WAAW,CAAC,IAAI,CAAC;QAAE,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACrE,IAAI,IAAI,CAAC,KAAK,KAAK,YAAY,CAAC,KAAK;QAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/E,IAAI,IAAI,CAAC,MAAM,KAAK,YAAY,CAAC,MAAM;QAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACnF,IAAI,CAAC,IAAI,CAAC,WAAW;QAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACrD,IAAI,IAAI,CAAC,QAAQ,KAAK,YAAY,CAAC,QAAQ;QAAE,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9E,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,CAAC,IAAI;QAAE,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3E,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACrE,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAe,EAAE,QAA+B,EAAW,EAAE,CAC1F,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACrE,IAAI,CAAC,QAAQ,KAAK,YAAY,CAAC,QAAQ;IACvC,IAAI,CAAC,MAAM,KAAK,YAAY,CAAC,MAAM;IACnC,IAAI,CAAC,IAAI,KAAK,YAAY,CAAC,IAAI,CAAC;AAElC;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAgB,EAAW,EAAE,CACxD,IAAI,CAAC,IAAI,KAAK,aAAa,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC;AAE1D;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,QAAgB,EAChB,EAAU,EACV,IAAe,EACf,QAA+B,EACvB,EAAE;IACV,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC3C,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACxB,OAAO,GAAG,QAAQ,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;AAC5C,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,IAAe,EAAY,EAAE,CAAC,CAAC;IACtD,QAAQ,EAAE,IAAI,CAAC,QAAQ;IACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;IACvB,IAAI,EAAE,IAAI,CAAC,IAAI;CAChB,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CACtB,IAAiC,EACjC,QAA+B,EACF,EAAE;IAC/B,MAAM,MAAM,GAAG,cAAc,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;IACvD,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,OAAO,CAAC;IACzC,OAAO,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,IAAI,OAAO,CAAC;AAC5E,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,IAAiC,EACjC,QAA+B,EACtB,EAAE;IACX,MAAM,QAAQ,GAAG,cAAc,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACtD,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACzC,OAAO,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;AAC9E,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAiC,EAAE,QAA+B,EAAU,EAAE;IACvG,MAAM,QAAQ,GAAG,cAAc,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACtD,OAAO,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC;AACxF,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,IAAiC,EACjC,QAA+B,EACG,EAAE,CACpC,MAAM,CAAC,WAAW,CAChB,QAAQ;KACL,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC;KAC5C,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CACpE,CAAC;AAEJ,8EAA8E;AAC9E,MAAM,gBAAgB,GAAG;IACvB,SAAS;IACT,OAAO;IACP,QAAQ;IACR,OAAO;IACP,KAAK;IACL,MAAM;IACN,OAAO;IACP,MAAM;IACN,QAAQ;IACR,WAAW;CACZ,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,QAAgB,EAAE,EAAU,EAAE,MAAc,EAAU,EAAE;IACrF,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;IAC3C,KAAK,MAAM,IAAI,IAAI,gBAAgB;QAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACzD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACvB,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACxB,OAAO,GAAG,QAAQ,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;AAC5C,CAAC,CAAC"}

package/dist/src/vite/adapter.d.ts

@@ -0,0 +1,70 @@
+/**
+ * The contract between the Vite plugin and a framework, on Node: the module that reads a story file's component docs
+ * (its props, events and parts), loaded by the docs' worker and by `forgebook-docs`.
+ *
+ * @remarks
+ * Everything else the plugin does is the same for every framework: the story index, the meta's reading
+ * (`storyMeta.ts`), the TypeScript programs (`docsProgram.ts`), the worker, the code and the Markdown. A framework
+ * package (`@forgebook/react`) exports a docs module (`./docs`) with an `extractStoryComponent` of this type, and an
+ * adapter (`./vite`) that names it.
+ *
+ * @module
+ */
+import type { PluginOption } from "vite";
+import type { ComponentDocs, NoComponentDocs } from "../componentDocs.ts";
+/** A story file's component: its docs and the file that declares it. */
+export type StoryComponent = {
+    /** The component's docs. */
+    readonly docs: ComponentDocs;
+    /** The absolute path of the file that declares it. */
+    readonly file: string;
+    /**
+     * Every file the docs are read from: the component's and those declaring its own props, so an edit to any of them
+     * can renew the docs.
+     */
+    readonly sources: readonly string[];
+};
+/** What a framework reads of a story file: its component, `{ docs: { name: null } }` without one, or why it cannot. */
+export type StoryComponentResult = StoryComponent | {
+    readonly docs: NoComponentDocs;
+} | string;
+/**
+ * Reads the component of a story file.
+ *
+ * @param storyFile - the story file's absolute path.
+ */
+export type ExtractStoryComponent = (storyFile: string) => StoryComponentResult;
+/** A framework, as the plugin uses it. */
+export type FrameworkAdapter = {
+    /** The framework's name, as `forgebook-docs --framework` writes it (`react`). */
+    readonly name: string;
+    /** The URL of the module that exports the framework's `extractStoryComponent`, loaded in the docs' worker. */
+    readonly docsModule: string;
+    /**
+     * The browser modules the generated pages import, as specifiers the catalogue's folder resolves: the frame page's
+     * (`mountFrame` with the framework's renderer) and the code writer the shell writes a story's code with
+     * (`storyJsx`).
+     */
+    readonly pages: {
+        /** The module exporting the framework's `mountFrame` (`@forgebook/react/frame`). */
+        readonly frame: string;
+        /** The module exporting the framework's code writer as `codeOf` (`@forgebook/react/code`). */
+        readonly code: string;
+    };
+    /**
+     * The packages the framework's pages import in the browser (`react-dom/client`): pre-bundled before the first page
+     * opens, since Vite's scanner cannot read pages that are generated; none by default.
+     */
+    readonly browserDependencies?: readonly string[];
+    /** The Vite plugins the framework needs in a catalogue (React's Fast Refresh); none by default. */
+    readonly vitePlugins?: () => Promise<readonly PluginOption[]>;
+};
+/**
+ * Whether a loaded module is a docs module: it exports an `extractStoryComponent` function.
+ *
+ * @param module - the module, as `import()` gave it.
+ */
+export declare const isDocsModule: (module: unknown) => module is {
+    readonly extractStoryComponent: ExtractStoryComponent;
+};
+//# sourceMappingURL=adapter.d.ts.map

package/dist/src/vite/adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../../src/vite/adapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEzC,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAE1E,wEAAwE;AACxE,MAAM,MAAM,cAAc,GAAG;IAC3B,4BAA4B;IAC5B,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,sDAAsD;IACtD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF,uHAAuH;AACvH,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;CAAE,GAAG,MAAM,CAAC;AAEhG;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,SAAS,EAAE,MAAM,KAAK,oBAAoB,CAAC;AAEhF,0CAA0C;AAC1C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,iFAAiF;IACjF,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,8GAA8G;IAC9G,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE;QACd,oFAAoF;QACpF,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QACvB,8FAA8F;QAC9F,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;KACvB,CAAC;IACF;;;OAGG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACjD,mGAAmG;IACnG,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,SAAS,YAAY,EAAE,CAAC,CAAC;CAC/D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,GACvB,QAAQ,OAAO,KACd,MAAM,IAAI;IAAE,QAAQ,CAAC,qBAAqB,EAAE,qBAAqB,CAAA;CAIhB,CAAC"}

package/dist/src/vite/adapter.js

@@ -0,0 +1,22 @@
+/**
+ * The contract between the Vite plugin and a framework, on Node: the module that reads a story file's component docs
+ * (its props, events and parts), loaded by the docs' worker and by `forgebook-docs`.
+ *
+ * @remarks
+ * Everything else the plugin does is the same for every framework: the story index, the meta's reading
+ * (`storyMeta.ts`), the TypeScript programs (`docsProgram.ts`), the worker, the code and the Markdown. A framework
+ * package (`@forgebook/react`) exports a docs module (`./docs`) with an `extractStoryComponent` of this type, and an
+ * adapter (`./vite`) that names it.
+ *
+ * @module
+ */
+/**
+ * Whether a loaded module is a docs module: it exports an `extractStoryComponent` function.
+ *
+ * @param module - the module, as `import()` gave it.
+ */
+export const isDocsModule = (module) => typeof module === "object" &&
+    module !== null &&
+    "extractStoryComponent" in module &&
+    typeof module.extractStoryComponent === "function";
+//# sourceMappingURL=adapter.js.map

package/dist/src/vite/adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../../../src/vite/adapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAuDH;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,MAAe,EACsD,EAAE,CACvE,OAAO,MAAM,KAAK,QAAQ;IAC1B,MAAM,KAAK,IAAI;IACf,uBAAuB,IAAI,MAAM;IACjC,OAAO,MAAM,CAAC,qBAAqB,KAAK,UAAU,CAAC"}

package/dist/src/vite/autoTitle.d.ts

@@ -0,0 +1,28 @@
+/**
+ * The title a story file's path makes, for a meta that writes none, as Storybook's auto-title makes it: the file's
+ * path from the static start of its pattern, without `.stories.*`.
+ *
+ * @remarks
+ * `src/**\/*.stories.tsx` matching `src/inputs/Select/Select.stories.tsx` gives `inputs/Select`: the folder and a file
+ * of the same name make one segment, and an `index` file takes its folder's name. The plugin, the tests' index and
+ * `forgebook-docs` all give the index the same title, so a story's id is the same everywhere. Pure.
+ *
+ * @module
+ */
+/** A story file's name, by its extension: `.stories.` then a JavaScript or TypeScript extension. */
+export declare const STORY_FILE: RegExp;
+/**
+ * The static start of a pattern: its folders before the first segment with a glob character (`../src` for
+ * `../src/**\/*.stories.tsx`).
+ *
+ * @param pattern - the pattern.
+ */
+export declare const patternBase: (pattern: string) => string;
+/**
+ * The title a story file's path makes, or none when its path gives no segment.
+ *
+ * @param base - the folder the title starts from, as `patternBase` gives it (relative paths, `/`-separated).
+ * @param file - the file, relative to the same folder as `base`.
+ */
+export declare const autoTitle: (base: string, file: string) => string | undefined;
+//# sourceMappingURL=autoTitle.d.ts.map

package/dist/src/vite/autoTitle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"autoTitle.d.ts","sourceRoot":"","sources":["../../../src/vite/autoTitle.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,oGAAoG;AACpG,eAAO,MAAM,UAAU,QAAiC,CAAC;AAKzD;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,SAAS,MAAM,KAAG,MAK7C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,MAAM,EAAE,MAAM,MAAM,KAAG,MAAM,GAAG,SAW/D,CAAC"}

package/dist/src/vite/autoTitle.js

@@ -0,0 +1,44 @@
+/**
+ * The title a story file's path makes, for a meta that writes none, as Storybook's auto-title makes it: the file's
+ * path from the static start of its pattern, without `.stories.*`.
+ *
+ * @remarks
+ * `src/**\/*.stories.tsx` matching `src/inputs/Select/Select.stories.tsx` gives `inputs/Select`: the folder and a file
+ * of the same name make one segment, and an `index` file takes its folder's name. The plugin, the tests' index and
+ * `forgebook-docs` all give the index the same title, so a story's id is the same everywhere. Pure.
+ *
+ * @module
+ */
+/** A story file's name, by its extension: `.stories.` then a JavaScript or TypeScript extension. */
+export const STORY_FILE = /\.stories\.(?:[cm]?[jt]sx?)$/;
+/** Whether a pattern's segment has a glob character, from which point the pattern names no folder. */
+const isGlob = (segment) => /[*?[\]{}!]/.test(segment);
+/**
+ * The static start of a pattern: its folders before the first segment with a glob character (`../src` for
+ * `../src/**\/*.stories.tsx`).
+ *
+ * @param pattern - the pattern.
+ */
+export const patternBase = (pattern) => {
+    const segments = pattern.split("/");
+    const firstGlob = segments.findIndex(isGlob);
+    const folders = firstGlob === -1 ? segments.slice(0, -1) : segments.slice(0, firstGlob);
+    return folders.join("/");
+};
+/**
+ * The title a story file's path makes, or none when its path gives no segment.
+ *
+ * @param base - the folder the title starts from, as `patternBase` gives it (relative paths, `/`-separated).
+ * @param file - the file, relative to the same folder as `base`.
+ */
+export const autoTitle = (base, file) => {
+    const baseSegments = base.split("/").filter((segment) => segment !== "" && segment !== ".");
+    const fileSegments = file.split("/").filter((segment) => segment !== "" && segment !== ".");
+    const isUnderBase = baseSegments.every((segment, index) => fileSegments[index] === segment);
+    const segments = (isUnderBase ? fileSegments.slice(baseSegments.length) : fileSegments).filter((segment) => segment !== "..");
+    const last = segments.pop()?.replace(STORY_FILE, "");
+    if (last !== undefined && last !== "index" && last.toLowerCase() !== segments.at(-1)?.toLowerCase())
+        segments.push(last);
+    return segments.length === 0 ? undefined : segments.join("/");
+};
+//# sourceMappingURL=autoTitle.js.map

package/dist/src/vite/autoTitle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"autoTitle.js","sourceRoot":"","sources":["../../../src/vite/autoTitle.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,oGAAoG;AACpG,MAAM,CAAC,MAAM,UAAU,GAAG,8BAA8B,CAAC;AAEzD,sGAAsG;AACtG,MAAM,MAAM,GAAG,CAAC,OAAe,EAAW,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAExE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,OAAe,EAAU,EAAE;IACrD,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC7C,MAAM,OAAO,GAAG,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;IACxF,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3B,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,IAAY,EAAsB,EAAE;IAC1E,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,EAAE,IAAI,OAAO,KAAK,GAAG,CAAC,CAAC;IAC5F,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,EAAE,IAAI,OAAO,KAAK,GAAG,CAAC,CAAC;IAC5F,MAAM,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC,CAAC;IAC5F,MAAM,QAAQ,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,MAAM,CAC5F,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,IAAI,CAC9B,CAAC;IACF,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IACrD,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,OAAO,IAAI,IAAI,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE;QACjG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtB,OAAO,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAChE,CAAC,CAAC"}

package/dist/src/vite/componentPage.d.ts

@@ -0,0 +1,34 @@
+/** A component's page text, as HTML. */
+export type ComponentPageText = {
+    /** The text. */
+    readonly html: string;
+    /** The documentation file it came from, watched in development. */
+    readonly file: string;
+};
+/**
+ * The documentation file beside a story file: its component's name in kebab case, with `.md`.
+ *
+ * @param storyFile - the story file's absolute path.
+ */
+export declare const pageFileOf: (storyFile: string) => string;
+/**
+ * The page's Markdown: without its first `# ` title and without the sections drawn from the types.
+ *
+ * @param markdown - the documentation file's text.
+ */
+export declare const pageMarkdown: (markdown: string) => string;
+/**
+ * A Markdown file as HTML, its first `#` title left out and its headings one level down: a source's introduction on
+ * the catalogue's home, which sits under the source's own heading, so the file's `##` sections are its parts.
+ *
+ * @param text - the file's text.
+ */
+export declare const markdownHtml: (text: string) => string;
+/**
+ * The page's text, read from the documentation file beside a story file.
+ *
+ * @param storyFile - the story file's absolute path.
+ * @returns the HTML and the file it came from, or none when the component has no documentation file.
+ */
+export declare const componentPage: (storyFile: string) => ComponentPageText | undefined;
+//# sourceMappingURL=componentPage.d.ts.map

package/dist/src/vite/componentPage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"componentPage.d.ts","sourceRoot":"","sources":["../../../src/vite/componentPage.ts"],"names":[],"mappings":"AAkCA,wCAAwC;AACxC,MAAM,MAAM,iBAAiB,GAAG;IAC9B,gBAAgB;IAChB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,mEAAmE;IACnE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,CAAC;AAKF;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,WAAW,MAAM,KAAG,MAI9C,CAAC;AAaF;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,UAAU,MAAM,KAAG,MAQ/C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,MAAM,KAAG,MAMxC,CAAC;AAEL;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,WAAW,MAAM,KAAG,iBAAiB,GAAG,SAIrE,CAAC"}

package/dist/src/vite/componentPage.js

@@ -0,0 +1,94 @@
+/**
+ * A component's page text: its Markdown documentation beside its story file (`Counter.stories.tsx` → `counter.md`),
+ * as HTML for the catalogue's component page.
+ *
+ * @remarks
+ * The title is left out (the page's header shows the name) and so is the `## Props` section: the page draws the props
+ * from the component's types, which a table written by hand would only repeat and drift from. Everything else (the
+ * introduction, the usage, Accessibility, Parts and styling, Test ids) follows the demo, its code blocks coloured
+ * (`highlightCode.ts`). The page's lead is the component's TSDoc summary, not the file's opening: that summary is
+ * written for whoever uses the component, the file's opening often for whoever builds it. The files are the
+ * package's, read at build time, so their HTML is trusted as the stories' code is.
+ *
+ * @module
+ */
+import { existsSync, readFileSync } from "node:fs";
+import { basename, dirname, join } from "node:path";
+import { Marked } from "marked";
+import { highlightCode } from "./highlightCode.js";
+/** Markdown with GitHub's tables, its code blocks coloured. */
+const markdown = new Marked({
+    async: false,
+    gfm: true,
+    renderer: {
+        code: ({ text, lang }) => {
+            const language = lang?.trim().split(/\s+/)[0] || undefined;
+            const languageClass = language === undefined ? "" : ` class="language-${language}"`;
+            return `<pre><code${languageClass}>${highlightCode(text, language)}</code></pre>\n`;
+        }
+    }
+});
+/** The Markdown sections the page draws from the component's types instead. */
+const GENERATED_SECTIONS = ["Props"];
+/**
+ * The documentation file beside a story file: its component's name in kebab case, with `.md`.
+ *
+ * @param storyFile - the story file's absolute path.
+ */
+export const pageFileOf = (storyFile) => {
+    const component = basename(storyFile).replace(/\.stories\.tsx?$/, "");
+    const kebab = component.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase();
+    return join(dirname(storyFile), `${kebab}.md`);
+};
+/**
+ * A Markdown text without its first `# ` title: the catalogue shows the name above it.
+ *
+ * @param markdown - the text.
+ */
+const withoutTitle = (markdown) => {
+    const lines = markdown.split("\n");
+    const title = lines.findIndex((line) => line.startsWith("# "));
+    return (title === -1 ? lines : [...lines.slice(0, title), ...lines.slice(title + 1)]).join("\n").trim();
+};
+/**
+ * The page's Markdown: without its first `# ` title and without the sections drawn from the types.
+ *
+ * @param markdown - the documentation file's text.
+ */
+export const pageMarkdown = (markdown) => {
+    const kept = [];
+    let isSkipping = false;
+    for (const line of withoutTitle(markdown).split("\n")) {
+        if (line.startsWith("## "))
+            isSkipping = GENERATED_SECTIONS.includes(line.slice(3).trim());
+        if (!isSkipping)
+            kept.push(line);
+    }
+    return kept.join("\n").trim();
+};
+/**
+ * A Markdown file as HTML, its first `#` title left out and its headings one level down: a source's introduction on
+ * the catalogue's home, which sits under the source's own heading, so the file's `##` sections are its parts.
+ *
+ * @param text - the file's text.
+ */
+export const markdownHtml = (text) => markdown.parse(withoutTitle(text), {
+    async: false,
+    walkTokens: (token) => {
+        if (token.type === "heading")
+            token.depth = Math.min(token.depth + 1, 6);
+    }
+});
+/**
+ * The page's text, read from the documentation file beside a story file.
+ *
+ * @param storyFile - the story file's absolute path.
+ * @returns the HTML and the file it came from, or none when the component has no documentation file.
+ */
+export const componentPage = (storyFile) => {
+    const file = pageFileOf(storyFile);
+    if (!existsSync(file))
+        return undefined;
+    return { html: markdown.parse(pageMarkdown(readFileSync(file, "utf8")), { async: false }), file };
+};
+//# sourceMappingURL=componentPage.js.map

package/dist/src/vite/componentPage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"componentPage.js","sourceRoot":"","sources":["../../../src/vite/componentPage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEpD,OAAO,EAAE,MAAM,EAA2B,MAAM,QAAQ,CAAC;AAEzD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,+DAA+D;AAC/D,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC;IAC1B,KAAK,EAAE,KAAK;IACZ,GAAG,EAAE,IAAI;IACT,QAAQ,EAAE;QACR,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAe,EAAU,EAAE;YAC5C,MAAM,QAAQ,GAAG,IAAI,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC;YAC3D,MAAM,aAAa,GAAG,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,oBAAoB,QAAQ,GAAG,CAAC;YACpF,OAAO,aAAa,aAAa,IAAI,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,iBAAiB,CAAC;QACtF,CAAC;KACF;CACF,CAAC,CAAC;AAUH,+EAA+E;AAC/E,MAAM,kBAAkB,GAAG,CAAC,OAAO,CAAC,CAAC;AAErC;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,SAAiB,EAAU,EAAE;IACtD,MAAM,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;IACtE,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;IAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,GAAG,KAAK,KAAK,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,YAAY,GAAG,CAAC,QAAgB,EAAU,EAAE;IAChD,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/D,OAAO,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;AAC1G,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,QAAgB,EAAU,EAAE;IACvD,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,KAAK,MAAM,IAAI,IAAI,YAAY,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACtD,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;YAAE,UAAU,GAAG,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QAC3F,IAAI,CAAC,UAAU;YAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IACD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;AAChC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAY,EAAU,EAAE,CACnD,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;IACjC,KAAK,EAAE,KAAK;IACZ,UAAU,EAAE,CAAC,KAAY,EAAQ,EAAE;QACjC,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;YAAE,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3E,CAAC;CACF,CAAC,CAAC;AAEL;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,SAAiB,EAAiC,EAAE;IAChF,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;IACnC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,SAAS,CAAC;IACxC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC;AACpG,CAAC,CAAC"}