@zenuml/core 4.4.1 → 4.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zenuml/core",
-  "version": "4.4.1",
+  "version": "4.6.0",
   "private": false,
   "license": "MIT",
   "repository": {
@@ -82,7 +82,8 @@
         "types": "./types/parser/index.d.ts",
         "default": "./dist/parser/index.cjs"
       }
-    }
+    },
+    "./fonts/*": "./dist/fonts/*"
   },
   "engines": {
     "node": ">=20"

package/types/index.d.ts

@@ -26,6 +26,50 @@ export declare function renderToSvg(
   options?: RenderOptions,
 ): RenderResult;
 
+/**
+ * Make the diagram typefaces available to text measurement and rendering in a
+ * browser. `ZenUml.render()` awaits it; call it yourself before
+ * `renderToSvg()`. Never rejects: a refused font falls back to the font stack.
+ */
+export declare function ensureDiagramFontsLoaded(): Promise<void>;
+
+/**
+ * Load the participant icons `code` uses that `renderToSvg()` does not build
+ * in (e.g. `@VPC`, `@RDS` and the other cloud icons), so the next
+ * `renderToSvg(code)` draws them. Await it before `renderToSvg()`. Never
+ * rejects: an unknown or failing icon falls back to the text label.
+ */
+export declare function ensureDiagramIconsLoaded(code: string): Promise<void>;
+
+/** Font families whose file URL can be set with {@link setDiagramFontUrl}. */
+export type DiagramFontFamily = "IBM Plex Sans" | "MS Sans Serif";
+
+/**
+ * Set the URL the browser renderer loads a diagram font from, instead of its
+ * default. Call before rendering. Use it when the page's Content-Security-Policy
+ * refuses `data:` fonts, with the font file this package ships at
+ * `@zenuml/core/fonts/IBMPlexSans-Regular-Latin1.woff2`, served from an origin
+ * the policy allows.
+ *
+ * `family` defaults to "IBM Plex Sans", which otherwise loads from an embedded
+ * `data:` URI. "MS Sans Serif" (theme-neon, `@zenuml/core/fonts/MS-Sans-Serif.ttf`)
+ * is only loaded when set. `null` restores the default. Changing the URL makes
+ * the next render load the font again.
+ */
+export declare function setDiagramFontUrl(
+  url: string | null,
+  family?: DiagramFontFamily,
+): void;
+
+/**
+ * The IBM Plex Sans `@font-face` rule with the font embedded as a `data:` URI,
+ * for rasterising the rendered DOM — e.g. html-to-image's `fontEmbedCSS`
+ * option. SVG-as-image can only use embedded fonts, and html-to-image does not
+ * see faces registered with the FontFace API. Works on pages whose
+ * Content-Security-Policy refuses data: fonts for the document itself.
+ */
+export declare function getDiagramFontFaceCss(): Promise<string | undefined>;
+
 export interface ParseResult {
   pass: boolean;
   errorDetails: ErrorDetail[];
@@ -62,6 +106,8 @@ interface IZenUml {
 declare class ZenUml implements IZenUml {
   static readonly version: string;
   static readonly default: typeof ZenUml;
+  /** Same as the named export {@link setDiagramFontUrl}. */
+  static readonly setDiagramFontUrl: typeof setDiagramFontUrl;
   constructor(el: HTMLElement | string, naked?: boolean);
   get code(): string | undefined;
   get theme(): string | undefined;