Member Junction
    Preparing search index...

    Class CreateMermaidDiagramAction

    Action that generates SVG diagrams from Mermaid text syntax. Supports flowcharts, sequence diagrams, ER diagrams, class diagrams, state machines, Gantt charts, and more.

    Mermaid is a text-based diagram generation tool that converts markdown-like syntax into rich visual diagrams. This action renders diagrams server-side as static SVG (no script), suitable for embedding in reports, artifacts, and AI-generated content.

    Rendering runs in headless Chromium via MermaidRenderer, because Mermaid measures rendered text to lay diagrams out and cannot run in plain Node. Hosts that use this action need a Chromium build for the playwright dependency (npx playwright install chromium); without one the action fails with BROWSER_UNAVAILABLE rather than producing a broken diagram.

    // Flowchart
    await runAction({
      ActionName: 'Create Mermaid Diagram',
      Params: [
        { Name: 'Code', Value: `flowchart TD
          A[Start] --> B[Process]
          B --> C{Decision}
          C -->|Yes| D[End]
          C -->|No| A` },
        { Name: 'Theme', Value: 'default' }
      ]
    });

    // Sequence Diagram
    await runAction({
      ActionName: 'Create Mermaid Diagram',
      Params: [
        { Name: 'Code', Value: `sequenceDiagram
          Client->>Server: Request
          Server->>Database: Query
          Database-->>Server: Results
          Server-->>Client: Response` },
        { Name: 'Theme', Value: 'dark' }
      ]
    });

    // ER Diagram
    await runAction({
      ActionName: 'Create Mermaid Diagram',
      Params: [
        { Name: 'Code', Value: `erDiagram
          USER ||--o{ ORDER : places
          ORDER ||--|{ LINE-ITEM : contains` },
        { Name: 'Theme', Value: 'forest' }
      ]
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    AuthorizesCaller

    Accessors

    SupportsAudience

    Methods

    InternalRunAction Run

    Constructors

    Properties

    AuthorizesCaller: boolean

    True when the action authorizes its caller itself, so a public entry point such as the RunAction mutation may run it for an authenticated user without an MJ: Action Authorizations link. Set it only on an action that either checks an authorization the caller must hold, or reads and writes only with the caller's own permissions. Leave it false for an action that acts with more authority than its caller, or that reaches data or sends messages the caller chooses but could not otherwise reach.

    The engine reads the marker only from the class that runs, never from its parent classes. A subclass that overrides a marked action must declare the marker again.

    Accessors

    • get SupportsAudience(): boolean

      Whether this action can bound what it returns to an audience (RunActionParams.Audience): everyone besides the caller who will see its output, such as the other participants of a shared conversation.

      false by default, and the engine enforces it: when a run's audience adds a reader beyond the caller, ActionEngineServer.RunAction refuses the action with result code AUDIENCE_UNSUPPORTED, without running it. Override to return true only when the action honours the audience in full — every record, snippet and count it returns is something every reader may see (pass the audience to the search engine, check each reader's entitlement to anything it scopes by, and leave out aggregates computed before that filtering).

      Returns boolean

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods