jssm 5.122.4 → 5.124.0

package/dist/deno/jssm_viz.d.ts

@@ -85,6 +85,24 @@ declare function image_for_state<T>(u_jssm: jssm.Machine<T>, state: string): str
  *  @internal
  */
 declare function style_for_state<T>(u_jssm: jssm.Machine<T>, state: string): string;
+/**
+ *  Options for the dot/SVG render entry points.
+ *
+ *  - `hide_state_labels` (default `false`) — when `true`, the rendered dot
+ *    output omits the `label=` attribute on every state's node line.
+ *    Graphviz then draws the box without any text inside.  Useful for
+ *    diagrams where shape, color, or layout alone carry the meaning
+ *    (icon-only diagrams, tutorial graphics, presentation slides).
+ *  - `footer` — verbatim dot source inserted just before the closing `}`
+ *    of the generated dot source (e.g. `labelloc="b"; label="caption";`).
+ *  - `engine` — graphviz layout engine for the SVG render path (e.g.
+ *    `dot`, `neato`, `circo`); honored by `fsl_to_svg_string`.
+ */
+declare type VizRenderOpts = {
+    hide_state_labels?: boolean;
+    footer?: string;
+    engine?: string;
+};
 /**
  *  Render a {@link jssm.Machine} as a graphviz dot string.
  *
@@ -100,18 +118,18 @@ declare function style_for_state<T>(u_jssm: jssm.Machine<T>, state: string): str
  *  const dot = machine_to_dot(sm`a -> b;`);
  *  // 'digraph G { ... }'
  *
+ *  // suppress state-name labels (boxes only, no text inside)
+ *  const dot2 = machine_to_dot(sm`a -> b;`, { hide_state_labels: true });
+ *
  *  const dot_with_footer = machine_to_dot(sm`a -> b;`, { footer: 'labelloc="b"; label="caption";' });
  *  // 'digraph G { ... labelloc="b"; label="caption"; }'
  *  ```
  *
  *  @param u_jssm The machine to render.
- *  @param opts Optional rendering options.
- *  @param opts.footer Optional verbatim dot source inserted just before the closing `}`.
+ *  @param opts Optional render flags.  See {@link VizRenderOpts}.
  *  @returns A complete graphviz dot source string.
  */
-declare function machine_to_dot<T>(u_jssm: jssm.Machine<T>, opts?: {
-    footer?: string;
-}): string;
+declare function machine_to_dot<T>(u_jssm: jssm.Machine<T>, opts?: VizRenderOpts): string;
 /**
  *  Render an FSL string directly to graphviz dot source.
  *
@@ -119,18 +137,18 @@ declare function machine_to_dot<T>(u_jssm: jssm.Machine<T>, opts?: {
  *  import { fsl_to_dot } from 'jssm/viz';
  *  const dot = fsl_to_dot('a -> b;');
  *
+ *  // suppress state-name labels
+ *  const dot2 = fsl_to_dot('a -> b;', { hide_state_labels: true });
+ *
  *  const dot_with_footer = fsl_to_dot('a -> b;', { footer: 'label="caption";' });
  *  // 'digraph G { ... label="caption"; }'
  *  ```
  *
  *  @param fsl The FSL source.
- *  @param opts Optional rendering options.
- *  @param opts.footer Optional verbatim dot source inserted just before the closing `}`.
+ *  @param opts Optional render flags.  See {@link VizRenderOpts}.
  *  @returns A complete graphviz dot source string.
  */
-declare function fsl_to_dot(fsl: string, opts?: {
-    footer?: string;
-}): string;
+declare function fsl_to_dot(fsl: string, opts?: VizRenderOpts): string;
 /**
  *  Render a graphviz dot source string to SVG using `@viz-js/viz`.  The
  *  underlying viz instance is lazy-initialized on first call and cached for
@@ -160,51 +178,36 @@ declare function dot_to_svg(dot: string, options?: {
  *  ```
  *
  *  @param fsl The FSL source.
- *  @param opts Optional rendering options.
- *  @param opts.footer Optional verbatim dot source inserted just before the closing `}` of the intermediate dot source.
- *  @param opts.engine Graphviz layout engine to use (e.g. `'dot'`, `'neato'`, `'circo'`).
- *  Unrecognized engine names cause `@viz-js/viz` to throw at render time.
+ *  @param opts Optional render flags.  See {@link VizRenderOpts}.
  *  @returns A promise resolving to an SVG XML string.
  */
-declare function fsl_to_svg_string(fsl: string, opts?: {
-    footer?: string;
-    engine?: string;
-}): Promise<string>;
+declare function fsl_to_svg_string(fsl: string, opts?: VizRenderOpts): Promise<string>;
 /**
  *  Render a {@link jssm.Machine} to SVG.
  *
  *  @param u_jssm The machine to render.
- *  @param opts Optional rendering options.
- *  @param opts.footer Optional verbatim dot source inserted just before the closing `}` of the intermediate dot source.
+ *  @param opts Optional render flags.  See {@link VizRenderOpts}.
  *  @returns A promise resolving to an SVG XML string.
  */
-declare function machine_to_svg_string<T>(u_jssm: jssm.Machine<T>, opts?: {
-    footer?: string;
-}): Promise<string>;
+declare function machine_to_svg_string<T>(u_jssm: jssm.Machine<T>, opts?: VizRenderOpts): Promise<string>;
 /**
  *  Render an FSL string directly to a parsed `SVGSVGElement`.
  *
  *  @param fsl The FSL source.
- *  @param opts Optional rendering options.
- *  @param opts.footer Optional verbatim dot source inserted just before the closing `}` of the intermediate dot source.
+ *  @param opts Optional render flags.  See {@link VizRenderOpts}.
  *  @returns A promise resolving to a parsed `SVGSVGElement`.
  *  @throws {JssmError} if no `DOMParser` is available (Node without `configure`).
  */
-declare function fsl_to_svg_element(fsl: string, opts?: {
-    footer?: string;
-}): Promise<SVGSVGElement>;
+declare function fsl_to_svg_element(fsl: string, opts?: VizRenderOpts): Promise<SVGSVGElement>;
 /**
  *  Render a {@link jssm.Machine} to a parsed `SVGSVGElement`.
  *
  *  @param u_jssm The machine to render.
- *  @param opts Optional rendering options.
- *  @param opts.footer Optional verbatim dot source inserted just before the closing `}` of the intermediate dot source.
+ *  @param opts Optional render flags.  See {@link VizRenderOpts}.
  *  @returns A promise resolving to a parsed `SVGSVGElement`.
  *  @throws {JssmError} if no `DOMParser` is available (Node without `configure`).
  */
-declare function machine_to_svg_element<T>(u_jssm: jssm.Machine<T>, opts?: {
-    footer?: string;
-}): Promise<SVGSVGElement>;
+declare function machine_to_svg_element<T>(u_jssm: jssm.Machine<T>, opts?: VizRenderOpts): Promise<SVGSVGElement>;
 /**
  *  Compatibility wrapper for {@link machine_to_dot}, retained from
  *  jssm-viz.  Will be removed in the next major.
@@ -213,6 +216,7 @@ declare function machine_to_svg_element<T>(u_jssm: jssm.Machine<T>, opts?: {
  */
 declare function dot<T>(machine: jssm.Machine<T>): string;
 export { configure, dot, dot_to_svg, fsl_to_dot, fsl_to_svg_string, fsl_to_svg_element, machine_to_dot, machine_to_svg_string, machine_to_svg_element, version, build_time };
+export type { VizRenderOpts };
 /** @internal — test-only access to private helpers. */
 export declare const _test: {
     color8to6: typeof color8to6;