@matfsw/docusaurus-plantuml-plugin 1.2.0 → 1.3.1

package/dist/theme/PlantUmlDiagram/index.js

@@ -7,6 +7,7 @@ import { PlantUmlError } from '../../runtime/errors.js';
 import { renderGraphvizDiagram } from '../../runtime/graphvizRenderer.js';
 import { renderDiagram } from '../../runtime/renderer.js';
 import { usePlantUmlConfig } from '../usePlantUmlConfig.js';
+import { CloseIcon, MaximizeIcon, ResetZoomIcon, SourceIcon, ZoomInIcon, ZoomOutIcon, } from './icons.js';
 import { useZoomPan } from './useZoomPan.js';
 import styles from './styles.module.css';
 /**
@@ -170,7 +171,7 @@ export default function PlantUmlDiagram({ source, title, language, engine = 'pla
                 transparentBackground: options.graphviz.transparentBackground,
                 maxSourceBytes: options.graphviz.maxSourceBytes,
             })
-            : renderDiagram({ ...shared, dark: renderDark });
+            : renderDiagram({ ...shared, dark: renderDark, stdlib: config.stdlib });
         void pending
             .then((svg) => commit({ status: 'ready', svg, error: null }))
             .catch((error) => {
@@ -190,6 +191,7 @@ export default function PlantUmlDiagram({ source, title, language, engine = 'pla
         config,
         config?.assetsBaseUrl,
         config?.coreVersion,
+        config?.stdlib,
         config?.options.sanitizeSvg,
         config?.options.renderTimeoutMs,
         config?.options.cache,
@@ -205,7 +207,7 @@ export default function PlantUmlDiagram({ source, title, language, engine = 'pla
         // Sanitized above unless `sanitizeSvg: false` was explicitly opted into.
         dangerouslySetInnerHTML: { __html: state.svg } }));
     const copyControl = sourceAvailable && sourceOpen && state.status === 'ready' && (_jsx("button", { type: "button", className: `${styles.toolbarButton} ${styles.toolbarTextButton}`, "aria-label": `Copy ${engineName} source to clipboard`, onClick: copySource, children: "Copy" }));
-    const sourceToggle = sourceAvailable && (_jsx("button", { type: "button", className: styles.toolbarButton, "aria-label": sourceOpen ? 'Hide diagram source' : 'Show diagram source', "aria-expanded": sourceOpen, "aria-controls": sourcePanelId, onClick: () => setSourceOpen((open) => !open), children: _jsx("span", { "aria-hidden": "true", children: '</>' }) }));
+    const sourceToggle = sourceAvailable && (_jsx("button", { type: "button", className: styles.toolbarButton, "aria-label": sourceOpen ? 'Hide diagram source' : 'Show diagram source', "aria-expanded": sourceOpen, "aria-controls": sourcePanelId, onClick: () => setSourceOpen((open) => !open), children: _jsx(SourceIcon, {}) }));
     /**
      * The source *replaces the diagram in its own frame* rather than appearing beneath it.
      *
@@ -223,7 +225,7 @@ export default function PlantUmlDiagram({ source, title, language, engine = 'pla
         [DATA_ATTR.theme]: dark ? 'dark' : 'light',
         ...(interactive ? { [DATA_ATTR.interactive]: 'true' } : {}),
         ...(zoom.maximized ? { [DATA_ATTR.maximized]: 'true' } : {}),
-        ...(sourceOpen ? { [DATA_ATTR.sourceOpen]: 'true' } : {}), children: [state.status === 'ready' && state.svg !== null && !interactive && canvas, state.status === 'ready' && state.svg !== null && !interactive && sourceView, state.status === 'ready' && state.svg !== null && !interactive && sourceAvailable && (_jsxs("div", { className: styles.plainToolbar, role: "group", "aria-label": `${label} source controls`, children: [sourceToggle, copyControl] })), state.status === 'ready' && state.svg !== null && interactive && (_jsxs("div", { ref: zoom.stageRef, className: zoom.maximized ? `${styles.stage} ${styles.maximized}` : styles.stage, children: [_jsxs("div", { className: styles.stageBody, children: [_jsx("div", { ref: zoom.viewportRef, className: sourceOpen ? `${styles.viewport} ${styles.invisibleView}` : styles.viewport, tabIndex: sourceOpen ? -1 : 0, "aria-describedby": hintId, "aria-keyshortcuts": "Plus Minus 0 ArrowUp ArrowDown ArrowLeft ArrowRight", onKeyDown: zoom.onKeyDown, [DATA_ATTR.zoom]: '1', children: _jsx("div", { ref: zoom.layerRef, className: styles.layer, children: canvas }) }), sourceView] }), _jsxs("div", { className: styles.toolbar, role: "group", "aria-label": `${label} zoom controls`, children: [!sourceOpen && (_jsx("button", { type: "button", className: styles.toolbarButton, "aria-label": "Zoom out", onClick: zoom.zoomOut, children: _jsx("span", { "aria-hidden": "true", children: "\u2212" }) })), !sourceOpen && (_jsx("button", { type: "button", className: styles.toolbarButton, "aria-label": "Zoom in", onClick: zoom.zoomIn, children: _jsx("span", { "aria-hidden": "true", children: "+" }) })), !sourceOpen && (_jsx("button", { type: "button", className: styles.toolbarButton, "aria-label": "Reset zoom", onClick: zoom.reset, children: _jsx("span", { "aria-hidden": "true", children: "\u27F2" }) })), _jsx("button", { type: "button", className: styles.toolbarButton, "aria-label": "Maximize diagram", "aria-pressed": zoom.maximized, onClick: zoom.toggleMaximize, children: _jsx("span", { "aria-hidden": "true", children: zoom.maximized ? '✕' : '⛶' }) }), sourceToggle, copyControl, _jsx("span", { ref: zoom.readoutRef, className: sourceOpen ? `${styles.readout} ${styles.hiddenView}` : styles.readout, "aria-hidden": "true", children: "100%" })] })] })), state.status === 'ready' && state.svg !== null && interactive && (_jsx("p", { id: hintId, className: styles.visuallyHidden, children: "Zoomable diagram. Use the zoom controls, or press plus and minus to zoom, the arrow keys to pan, and zero to reset." })), state.status !== 'ready' && state.status !== 'error' && (
+        ...(sourceOpen ? { [DATA_ATTR.sourceOpen]: 'true' } : {}), children: [state.status === 'ready' && state.svg !== null && !interactive && canvas, state.status === 'ready' && state.svg !== null && !interactive && sourceView, state.status === 'ready' && state.svg !== null && !interactive && sourceAvailable && (_jsxs("div", { className: styles.plainToolbar, role: "group", "aria-label": `${label} source controls`, children: [sourceToggle, copyControl] })), state.status === 'ready' && state.svg !== null && interactive && (_jsxs("div", { ref: zoom.stageRef, className: zoom.maximized ? `${styles.stage} ${styles.maximized}` : styles.stage, children: [_jsxs("div", { className: styles.stageBody, children: [_jsx("div", { ref: zoom.viewportRef, className: sourceOpen ? `${styles.viewport} ${styles.invisibleView}` : styles.viewport, tabIndex: sourceOpen ? -1 : 0, "aria-describedby": hintId, "aria-keyshortcuts": "Plus Minus 0 ArrowUp ArrowDown ArrowLeft ArrowRight", onKeyDown: zoom.onKeyDown, [DATA_ATTR.zoom]: '1', children: _jsx("div", { ref: zoom.layerRef, className: styles.layer, children: canvas }) }), sourceView] }), _jsxs("div", { className: styles.toolbar, role: "group", "aria-label": `${label} zoom controls`, children: [!sourceOpen && (_jsx("button", { type: "button", className: styles.toolbarButton, "aria-label": "Zoom out", onClick: zoom.zoomOut, children: _jsx(ZoomOutIcon, {}) })), !sourceOpen && (_jsx("button", { type: "button", className: styles.toolbarButton, "aria-label": "Zoom in", onClick: zoom.zoomIn, children: _jsx(ZoomInIcon, {}) })), !sourceOpen && (_jsx("button", { type: "button", className: styles.toolbarButton, "aria-label": "Reset zoom", onClick: zoom.reset, children: _jsx(ResetZoomIcon, {}) })), _jsx("button", { type: "button", className: styles.toolbarButton, "aria-label": "Maximize diagram", "aria-pressed": zoom.maximized, onClick: zoom.toggleMaximize, children: zoom.maximized ? _jsx(CloseIcon, {}) : _jsx(MaximizeIcon, {}) }), sourceToggle, copyControl, _jsx("span", { ref: zoom.readoutRef, className: sourceOpen ? `${styles.readout} ${styles.hiddenView}` : styles.readout, "aria-hidden": "true", children: "100%" })] })] })), state.status === 'ready' && state.svg !== null && interactive && (_jsx("p", { id: hintId, className: styles.visuallyHidden, children: "Zoomable diagram. Use the zoom controls, or press plus and minus to zoom, the arrow keys to pan, and zero to reset." })), state.status !== 'ready' && state.status !== 'error' && (
             // `aria-busy` on the figure already conveys progress; announcing every phase change
             // would make a page with several diagrams unusable with a screen reader.
             _jsxs("div", { className: styles.placeholder, children: [_jsx("span", { className: styles.spinner, "aria-hidden": "true" }), _jsxs("span", { children: [state.status === 'loading' ? `Loading ${engineName} runtime…` : null, state.status === 'rendering' ? `Rendering ${label}…` : null, state.status === 'idle' ? `${label} (waiting to render)` : null] })] })), state.status === 'error' && (_jsxs("div", { className: styles.error, role: "alert", children: [_jsxs("p", { className: styles.errorHeading, children: [_jsx("span", { className: styles.errorIcon, "aria-hidden": "true", children: "\u26A0" }), _jsxs("span", { children: ["Error: ", engineName, " diagram could not be rendered"] })] }), _jsx("pre", { className: styles.errorMessage, children: state.error }), config?.options.showSourceOnError !== false && (_jsxs("details", { className: styles.errorDetails, children: [_jsx("summary", { children: "Show diagram source" }), _jsx("pre", { className: styles.source, children: source })] }))] })), title !== undefined && _jsx("figcaption", { className: styles.caption, children: title }), _jsx("noscript", { dangerouslySetInnerHTML: {

package/dist/theme/usePlantUmlConfig.d.ts

@@ -1,9 +1,17 @@
 import { type ResolvedPlantUmlOptions } from '../options.js';
+import type { StdlibRuntimeManifest } from '../stdlibShared.js';
+/** The standard library as the browser sees it: a URL to fetch bundles from, and an index. */
+export interface StdlibRuntimeConfig {
+    baseUrl: string;
+    manifest: StdlibRuntimeManifest;
+}
 export interface PlantUmlRuntimeConfig {
     options: ResolvedPlantUmlOptions;
     /** Absolute, `baseUrl`-prefixed URL of the directory holding the runtime assets. */
     assetsBaseUrl: string;
     coreVersion: string;
+    /** `null` when the standard library is switched off for this site. */
+    stdlib: StdlibRuntimeConfig | null;
 }
 /**
  * Reads the plugin's configuration from Docusaurus global data.

package/dist/theme/usePlantUmlConfig.js

@@ -2,7 +2,7 @@ import { useMemo } from 'react';
 import useBaseUrl from '@docusaurus/useBaseUrl';
 import { useAllPluginInstancesData } from '@docusaurus/useGlobalData';
 import { PLUGIN_NAME } from '../constants.js';
-import { DEFAULT_GRAPHVIZ_OPTIONS } from '../options.js';
+import { DEFAULT_GRAPHVIZ_OPTIONS, DEFAULT_STDLIB_OPTIONS, } from '../options.js';
 function isGlobalData(value) {
     if (typeof value !== 'object' || value === null)
         return false;
@@ -23,26 +23,32 @@ export function usePlantUmlConfig() {
     const first = instances ? Object.values(instances).find(isGlobalData) : undefined;
     // `useBaseUrl` must be called unconditionally; the placeholder path is discarded below.
     const assetsBaseUrl = useBaseUrl(first ? first.assetsDir : '/');
+    const stdlibBaseUrl = useBaseUrl(first?.stdlib ? first.stdlib.dir : '/');
     // Memoized because consumers use this object as an effect dependency. Returning a fresh
     // object on every render would restart the render effect on every state update, which
     // re-enters rendering forever.
     return useMemo(() => first
         ? {
-            options: withGraphvizDefaults(first.options),
+            options: withDefaults(first.options),
             assetsBaseUrl,
             coreVersion: first.coreVersion,
+            stdlib: first.stdlib ? { baseUrl: stdlibBaseUrl, manifest: first.stdlib.manifest } : null,
         }
-        : null, [first, assetsBaseUrl]);
+        : null, [first, assetsBaseUrl, stdlibBaseUrl]);
 }
 /**
- * Fills in the `graphviz` group when it is missing from global data.
+ * Fills in the nested option groups when they are missing from global data.
  *
- * `resolveOptions` always produces it, so this only matters for data written by an older
+ * `resolveOptions` always produces them, so this only matters for data written by an older
  * version of the plugin — a stale `.docusaurus` cache surviving an upgrade, most plausibly.
  * Substituting the defaults keeps such a site rendering instead of failing on a missing key.
  */
-function withGraphvizDefaults(options) {
-    if (options.graphviz)
+function withDefaults(options) {
+    if (options.graphviz && options.stdlib)
         return options;
-    return { ...options, graphviz: DEFAULT_GRAPHVIZ_OPTIONS };
+    return {
+        ...options,
+        graphviz: options.graphviz ?? DEFAULT_GRAPHVIZ_OPTIONS,
+        stdlib: options.stdlib ?? DEFAULT_STDLIB_OPTIONS,
+    };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@matfsw/docusaurus-plantuml-plugin",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "Render PlantUML diagrams in Docusaurus 3 entirely in the browser - no Java, no PlantUML server, no CDN.",
   "keywords": [
     "docusaurus",
@@ -35,6 +35,7 @@
     "./package.json": "./package.json"
   },
   "files": [
+    "assets",
     "dist",
     "README.md",
     "LICENSE",
@@ -62,6 +63,7 @@
     "verify:tag": "node scripts/verify-tag-version.mjs",
     "sync:meta": "node scripts/sync-project-metadata.mjs",
     "sync:check": "node scripts/sync-project-metadata.mjs --check",
+    "stdlib:update": "node scripts/update-stdlib.mjs",
     "example:install": "npm --prefix examples/docusaurus install",
     "example:build": "npm --prefix examples/docusaurus run build",
     "example:serve": "npm --prefix examples/docusaurus run serve",