# scriptscat/scriptcat architecture

> Architecture diagram of the GitHub repository scriptscat/scriptcat, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/scriptscat/scriptcat
- Repository: https://github.com/scriptscat/scriptcat

## Overview

##### Main Components

a) Browser Extension Components:
- Background Service
- Content Scripts
- Popup UI
- Options Page
- Sandbox Environment

b) Core Services:
- Script Manager
- Permission System
- Resource Manager
- Synchronization Service
- Storage System
- Message Center
- Logger System

**┌─ Browser Extension UI Layer ─────────────────────┐**
- Popup Interface                                │
- Options Page                                   │
- Installation UI                                │
- Configuration Panels                           │
- ┬───────────────────────────┘

**┌─ Communication Layer ┴───────────────────────────┐**
- Message Center                                 │
- Internal Communication Channels                │
- External API Interface                         │
- ┬───────────────────────────┘

**┌─ Core Services Layer ┴───────────────────────────┐**
- Script Execution Engine                        │
- Permission Controller                          │
- Resource Manager                               │
- Synchronization Service                        │
- Value Storage Manager                          │
- ┬───────────────────────────┘

**┌─ Storage Layer ──────┴───────────────────────────┐**
- Script Repository                              │
- Configuration Storage                          │
- Cache System                                   │
- Cloud Storage Integration                      │
- ┘

##### Key Relationships to Highlight

- Bidirectional communication between Content Scripts and Background Service
- Sandbox isolation mechanism for script execution
- Cloud synchronization flow with external services
- Permission verification flow
- Demonstrate script execution lifecycle

##### Implementation Details

- The message-passing architecture between components
- The script execution sandbox for security
- The cloud synchronization mechanism
- The permission management system
- The resource handling system

##### Technical Stack Indicators

Technology badges for:
- TypeScript
- React (for UI components)
- WebExtension APIs
- IndexedDB/Chrome Storage
- Cloud Storage Services

##### Flow Directions

- Script installation flow
- Permission verification flow
- Data synchronization flow
- Message passing between components
- Resource loading paths

Remember to include notes about the extension's special features like background script support, scheduled tasks, and enhanced API capabilities that distinguish it from traditional userscript managers.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles and Classes
    classDef ui fill:#2196F3,color:white
    classDef core fill:#4CAF50,color:white
    classDef comm fill:#9C27B0,color:white
    classDef storage fill:#607D8B,color:white
    classDef security fill:#FF9800,color:white

    %% UI Layer
    subgraph UI
        PopupUI["Popup Interface"]
        OptionsPage["Options Page"]
        InstallUI["Installation UI"]
        ConfigPanel["Configuration Panels"]
    end

    %% Communication Layer
    subgraph Communication
        MsgCenter["Message Center"]
        IntComm["Internal Communication"]
        ExtAPI["External API Interface"]
    end

    %% Core Services Layer
    subgraph CoreServices
        ScriptEngine["Script Execution Engine"]
        PermSystem["Permission System"]
        ResManager["Resource Manager"]
        SyncService["Synchronization Service"]
        ValueStorage["Value Storage Manager"]
    end

    %% Storage Layer
    subgraph Storage
        ScriptRepo["Script Repository"]
        ConfigStore["Configuration Storage"]
        CacheSystem["Cache System"]
        CloudStorage["Cloud Storage Integration"]
    end

    %% Extension Components
    subgraph ExtensionCore
        BGService["Background Service"]
        ContentScripts["Content Scripts"]
        SandboxEnv["Sandbox Environment"]
        Logger["Logger System"]
    end

    %% Relationships
    UI --> MsgCenter
    MsgCenter --> CoreServices
    CoreServices --> Storage
    MsgCenter --> ExtensionCore
    ExtensionCore --> Storage
    SandboxEnv --> ScriptEngine
    BGService --> PermSystem
    ContentScripts --> ScriptEngine
    SyncService --> CloudStorage
    ValueStorage --> ConfigStore
    Logger --> ExtensionCore

    %% Click Events
    click PopupUI "https://github.com/scriptscat/scriptcat/tree/main/src/pages/popup/"
    click OptionsPage "https://github.com/scriptscat/scriptcat/tree/main/src/pages/options/"
    click InstallUI "https://github.com/scriptscat/scriptcat/tree/main/src/pages/install/"
    click MsgCenter "https://github.com/scriptscat/scriptcat/blob/main/src/app/message/center.ts"
    click IntComm "https://github.com/scriptscat/scriptcat/blob/main/src/app/message/internal.ts"
    click ScriptEngine "https://github.com/scriptscat/scriptcat/blob/main/src/runtime/content/exec_script.ts"
    click PermSystem "https://github.com/scriptscat/scriptcat/blob/main/src/app/service/permission/controller.ts"
    click ResManager "https://github.com/scriptscat/scriptcat/blob/main/src/app/service/resource/controller.ts"
    click SyncService "https://github.com/scriptscat/scriptcat/blob/main/src/app/service/synchronize/controller.ts"
    click ValueStorage "https://github.com/scriptscat/scriptcat/blob/main/src/app/service/value/controller.ts"
    click ScriptRepo "https://github.com/scriptscat/scriptcat/blob/main/src/app/repo/scripts.ts"
    click ConfigStore "https://github.com/scriptscat/scriptcat/blob/main/src/app/repo/dao.ts"
    click Logger "https://github.com/scriptscat/scriptcat/blob/main/src/app/logger/core.ts"
    click SandboxEnv "https://github.com/scriptscat/scriptcat/blob/main/src/runtime/content/sandbox.ts"
    click BGService "https://github.com/scriptscat/scriptcat/blob/main/src/background.ts"
    click ContentScripts "https://github.com/scriptscat/scriptcat/blob/main/src/content.ts"

    %% Style Applications
    class PopupUI,OptionsPage,InstallUI,ConfigPanel ui
    class MsgCenter,IntComm,ExtAPI comm
    class ScriptEngine,ResManager,SyncService,ValueStorage core
    class ScriptRepo,ConfigStore,CacheSystem,CloudStorage storage
    class PermSystem,SandboxEnv security
```
