@zenuml/core 4.8.0 → 4.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zenuml/core",
-  "version": "4.8.0",
+  "version": "4.9.0",
   "private": false,
   "license": "MIT",
   "repository": {

package/types/index.d.ts

@@ -10,12 +10,18 @@ export type SvgTheme =
 export interface RenderOptions {
   /** Theme name. Unknown names fall back to 'theme-default'. */
   theme?: SvgTheme;
+  /** Semantic document colours; supplied slots override the selected theme. */
+  palette?: DiagramPalette;
+  /** Optional opaque colour painted underneath the outer canvas once. */
+  backingColor?: string;
   /** Show sequence references and their badges; defaults to true. */
   enableNumbering?: boolean;
 }
 
 export interface RenderResult {
   svg: string;
+  /** Raw outer-canvas paint, excluding the optional export backing. */
+  surface: RenderSurface;
   /** Inner SVG content (defs + g) for embedding into an existing SVG container */
   innerSvg: string;
   width: number;
@@ -23,6 +29,48 @@ export interface RenderResult {
   viewBox: string;
 }
 
+/** Raw outer-canvas paint; transparent unless the author paints it. */
+export interface RenderSurface {
+  backgroundColor: string;
+}
+
+export interface ExportOptions {
+  /** Opaque colour painted behind the diagram once. Omit to preserve alpha. */
+  backingColor?: string;
+}
+
+/** Optional semantic colour overrides shared by HTML and native SVG. */
+export interface DiagramPalette {
+  canvasBg?: string;
+  frameBg?: string;
+  frameBorder?: string;
+  titleText?: string;
+  participantBg?: string;
+  participantBorder?: string;
+  participantText?: string;
+  messageArrow?: string;
+  messageText?: string;
+  lifeline?: string;
+  occurrenceBg?: string;
+  occurrenceBorder?: string;
+  fragmentBorder?: string;
+  fragmentHeaderBg?: string;
+  fragmentHeaderText?: string;
+  fragmentText?: string;
+  fragmentSeparator?: string;
+  guardOpacity?: string;
+  guardText?: string;
+  commentText?: string;
+  commentOpacity?: string;
+  groupOutline?: string;
+  dividerLine?: string;
+  dividerBg?: string;
+  dividerText?: string;
+  numberText?: string;
+  fragmentNumberText?: string;
+  numberBg?: string;
+}
+
 export declare function renderToSvg(
   code: string,
   options?: RenderOptions,
@@ -85,6 +133,7 @@ export interface ErrorDetail {
 
 export interface Config {
   theme?: string;
+  palette?: DiagramPalette;
   enableScopedTheming?: boolean;
   onThemeChange?: (data: { theme: string; scoped?: boolean }) => void;
   enableMultiTheme?: boolean;
@@ -103,6 +152,7 @@ interface IZenUml {
     code: string | undefined,
     config: Config | undefined,
   ): Promise<IZenUml>;
+  getSurface(): RenderSurface;
 }
 
 declare class ZenUml implements IZenUml {
@@ -110,7 +160,12 @@ declare class ZenUml implements IZenUml {
   static readonly default: typeof ZenUml;
   /** Same as the named export {@link setDiagramFontUrl}. */
   static readonly setDiagramFontUrl: typeof setDiagramFontUrl;
-  constructor(el: HTMLElement | string, naked?: boolean);
+  /** Initial appearance is applied before the first committed frame. */
+  constructor(
+    el: HTMLElement | string,
+    naked?: boolean,
+    initial?: Pick<Config, "theme" | "palette">,
+  );
   get code(): string | undefined;
   get theme(): string | undefined;
   parse(text: string): Promise<ParseResult>;
@@ -118,8 +173,10 @@ declare class ZenUml implements IZenUml {
     code: string | undefined,
     config: Config | undefined,
   ): Promise<IZenUml>;
-  getPng(): Promise<string>;
-  getSvg(): Promise<string>;
+  /** Read the raw canvas paint after render, or again after author CSS changes. */
+  getSurface(): RenderSurface;
+  getPng(options?: ExportOptions): Promise<string>;
+  getSvg(options?: ExportOptions): Promise<string>;
 }
 
 export default ZenUml;