# mermaid-chart/confluence-mermaid-chart-plugin-v2 architecture

> Architecture diagram of the GitHub repository mermaid-chart/confluence-mermaid-chart-plugin-v2, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mermaid-chart/confluence-mermaid-chart-plugin-v2
- Repository: https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2

## Overview

##### File structure
- Top‐level files:
- atlassian-connect.json (plugin descriptor)
- Procfile, vercel.json (deployment targets: Heroku, Vercel)
- config.json + credentials.json.sample (app config & Atlassian creds)
- Directories:
- routes/ (page routes: editor, settings, auth callback)
- views/ (Handlebars templates following MVC)
- public/ (static assets: CSS, plugin.js + editor client JS under public/js/editor)
- utils/ (MermaidChart renderer, redis helper)
- scripts/ (server startup, serverless-redis entrypoint)

##### README for additional insights
- Uses environment variables for OAuth client ID and MC_BASE_URL
- Instructions for embedding plugin.js in Confluence, then using window.CP.* functions to save, cancel or get data
- Development flow: atlassian-connect-express handles JWT auth, ngrok for tunneling

##### Elements
– Blue = Atlassian components (Confluence, JWT)
– Green = Plugin server internals (routes, APIs, utils)
– Orange = Data stores (Redis, external MC_BASE_URL)
– Gray = Client assets (plugin.js, editor scripts)
- Legends or labels for OAuth/JWT, “iframe boundary,” and API endpoints (/api, /editor)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Top-level user and Atlassian
    Browser["User Browser"]:::external
    Confluence["Confluence (Atlassian Cloud)"]:::atlassian

    Browser -->|"Loads Confluence page\nplugin.js injected"| Confluence
    Confluence -->|"Opens iframe\n/edit diagram"| Browser

    %% Plugin Server
    subgraph "Plugin Server (Node.js/Express)" 
        direction TB
        Descriptor["Atlassian Connect Descriptor\n(atlassian-connect.json)"]:::plugin
        ConfigGroup["Config"]:::plugin
        RoutesAPI["Routes & API"]:::plugin
        Views["Handlebars Views"]:::plugin
        StaticAssets["Static Assets"]:::static
        Utils["Utilities"]:::plugin
        Deployment["Deployment Config"]:::plugin
        Scripts["Scripts & Entrypoints"]:::plugin

        Descriptor
        ConfigGroup
        RoutesAPI
        Views
        StaticAssets
        Utils
        Deployment
        Scripts
    end

    Confluence -->|"/editor, /settings, /auth callbacks"| PluginServer["Plugin Server (Express)"]

    Browser -->|HTTPS JWT-signed requests| PluginServer

    PluginServer -->|"Reads/Writes metadata"| Redis["Redis Cache"]:::datastore
    PluginServer -->|"Fetch/Host diagrams"| ExternalMC["External MermaidChart Service (MC_BASE_URL)"]:::external

    %% Config Group
    subgraph "Config Files"
        direction TB
        ConfigJSON["config.json"]:::plugin
        CredTemp["credentials.json.sample"]:::plugin
    end
    ConfigGroup --> ConfigJSON
    ConfigGroup --> CredTemp

    %% Routes & API
    subgraph "Express Layers"
        direction TB
        API["API Layer (api/index.js)"]:::plugin
        Routes["Routes (routes/index.js)"]:::plugin
    end
    RoutesAPI --> API
    RoutesAPI --> Routes

    %% Views
    subgraph "Views (views)"
        direction TB
        Layout["layout.hbs"]:::plugin
        EditorView["editor.hbs"]:::plugin
        SettingsView["settings.hbs"]:::plugin
        AuthCBView["authCallback.hbs"]:::plugin
        UnauthorizedView["unauthorized.hbs"]:::plugin
        ErrorView["error.hbs"]:::plugin
        ViewerView["viewer.hbs"]:::plugin
    end
    Views --> Layout
    Views --> EditorView
    Views --> SettingsView
    Views --> AuthCBView
    Views --> UnauthorizedView
    Views --> ErrorView
    Views --> ViewerView

    %% Static Assets
    subgraph "Public Assets (public)"
        direction TB
        CSSGroup["CSS"]:::static
        JSGroup["JS"]:::static
        EditorScripts["Editor Client Scripts"]:::static
    end

    subgraph "CSS Files"
        direction TB
        EditorCSS["editor.css"]:::static
        GeneralCSS["general.css"]:::static
    end
    CSSGroup --> EditorCSS
    CSSGroup --> GeneralCSS

    subgraph "JS Files"
        direction TB
        PluginJS["plugin.js"]:::static
        ConstantsJS["constatnts.js"]:::static
    end
    JSGroup --> PluginJS
    JSGroup --> ConstantsJS

    subgraph "Editor Scripts"
        direction TB
        DiagramJS["diagram.js"]:::static
        EditorJS["editor.js"]:::static
        FormJS["form.js"]:::static
        HeaderJS["header.js"]:::static
        LoginJS["login.js"]:::static
    end
    EditorScripts --> DiagramJS
    EditorScripts --> EditorJS
    EditorScripts --> FormJS
    EditorScripts --> HeaderJS
    EditorScripts --> LoginJS

    StaticAssets --> CSSGroup
    StaticAssets --> JSGroup
    StaticAssets --> EditorScripts

    %% Utils
    subgraph "Utility Modules"
        direction TB
        MermaidUtil["MermaidChart.js"]:::plugin
        Helpers["index.js"]:::plugin
    end
    Utils --> MermaidUtil
    Utils --> Helpers

    %% Deployment Config
    subgraph "Deployment"
        direction TB
        Heroku["Procfile"]:::plugin
        Vercel["vercel.json"]:::plugin
    end
    Deployment --> Heroku
    Deployment --> Vercel
    Deployment --> Descriptor

    %% Scripts & Entrypoints
    subgraph "Scripts"
        direction TB
        ServerStart["server.js"]:::plugin
        RedisEntry["serverless-redis.js"]:::plugin
        DemoPage["example/index.html"]:::plugin
        PackageMeta["package.json\npackage-lock.json"]:::plugin
    end
    Scripts --> ServerStart
    Scripts --> RedisEntry
    Scripts --> DemoPage
    Scripts --> PackageMeta

    %% Click events
    click Descriptor "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/atlassian-connect.json"
    click Heroku "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/tree/main/Procfile"
    click Vercel "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/vercel.json"
    click ConfigJSON "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/config.json"
    click CredTemp "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/credentials.json.sample"
    click API "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/api/index.js"
    click Routes "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/routes/index.js"
    click Layout "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/views/layout.hbs"
    click EditorView "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/views/editor.hbs"
    click SettingsView "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/views/settings.hbs"
    click AuthCBView "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/views/authCallback.hbs"
    click UnauthorizedView "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/views/unauthorized.hbs"
    click ErrorView "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/views/error.hbs"
    click ViewerView "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/views/viewer.hbs"
    click EditorCSS "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/public/css/editor.css"
    click GeneralCSS "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/public/css/general.css"
    click PluginJS "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/public/js/plugin.js"
    click ConstantsJS "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/public/js/constatnts.js"
    click DiagramJS "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/public/js/editor/diagram.js"
    click EditorJS "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/public/js/editor/editor.js"
    click FormJS "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/public/js/editor/form.js"
    click HeaderJS "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/public/js/editor/header.js"
    click LoginJS "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/public/js/editor/login.js"
    click MermaidUtil "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/utils/MermaidChart.js"
    click Helpers "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/utils/index.js"
    click RedisEntry "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/serverless-redis.js"
    click ServerStart "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/scripts/server.js"
    click DemoPage "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/example/index.html"
    click PackageMeta "https://github.com/mermaid-chart/confluence-mermaid-chart-plugin-v2/blob/main/package.json"
    classDef atlassian fill:#cce5ff,stroke:#004085,color:#004085
    classDef plugin fill:#d4edda,stroke:#155724,color:#155724
    classDef datastore fill:#f8d7da,stroke:#721c24,color:#721c24
    classDef static fill:#e2e3e5,stroke:#6c757d,color:#6c757d
    classDef external fill:#fff3cd,stroke:#856404,color:#856404
```
