# neofinancial/config-dug architecture

> Architecture diagram of the GitHub repository neofinancial/config-dug, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/neofinancial/config-dug
- Repository: https://github.com/neofinancial/config-dug

## Overview

##### Main Components

a) Core Library Layer:
- Config Dug Core (packages/config-dug)
- Plugin System Architecture
- Configuration Processing Pipeline

b) Plugin Layer:
- AWS Secrets Manager Plugin
- Extension Points for Future Plugins

c) Configuration Sources:
- Config Files (.js, .cjs, .mjs)
- Environment Variables
- External Services (via plugins)

**┌─────────────────────────────────────────────┐**
- Client Application             │
- ┘
- ↓
**┌─────────────────────────────────────────────┐**
- Config Dug Core                 │
- ┬──────────────┬───────────────┤
- Parser     │ Preprocessor │   Reporter    │
- Origins    │ Redactor     │   Logger      │
- ┴──────────────┴───────────────┘
- ↓
**┌─────────────────────────────────────────────┐**
- Plugin System                  │
- ┬─────────────────────┤
- AWS Secrets Manager│     Other Plugins   │
- ┴─────────────────────┘
- ↓
**┌─────────────────────────────────────────────┐**
- Configuration Sources            │
- ┬──────────────┬──────────────────┤
- Files   │Environment   │External Services │
- (.js/cjs)│  Variables   │   (AWS, etc.)    │
- ┴──────────────┴──────────────────┘

##### Key Interactions to Highlight

a) Configuration Loading Flow:
- How configuration is loaded from different sources
- Processing pipeline (parsing → preprocessing → validation)
- Demonstrate plugin integration points

b) Module Support:
- Support for both ESM and CommonJS
- TypeScript integration

##### Important Details

- Module type detection system
- Environment-specific configuration handling
- Plugin system architecture
- Error handling and reporting flow
- Configuration validation process

##### Implementation Notes

- The modular nature of the system
- The plugin architecture's extensibility
- Support for different module systems (ESM/CJS)
- TypeScript integration
- Environment-specific configuration handling

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef core fill:#b3d1ff,stroke:#4d88ff
    classDef plugin fill:#90EE90,stroke:#32CD32
    classDef source fill:#FFB366,stroke:#FF8C00
    classDef external fill:#D3D3D3,stroke:#808080

    %% Client Application Layer
    Client["Client Application"]

    %% Core Library Layer
    subgraph CoreLayer["Core Library Layer"]
        ConfigDug["Config Dug Core"]
        Parser["Parser Component"]
        Preprocessor["Preprocessor Component"]
        Reporter["Reporter Component"]
        Origins["Origins Handler"]
        Logger["Logger System"]
        Redactor["Redactor Component"]
        ModuleType["Module Type Detection"]
        ErrorHandler["Error Handling"]
        PrettyPrinter["Pretty Printer"]
        Options["Options Handler"]
    end

    %% Plugin System Layer
    subgraph PluginLayer["Plugin System Layer"]
        PluginSystem["Plugin System"]
        AWSPlugin["AWS Secrets Manager Plugin"]
        OtherPlugins["Other Plugins"]
    end

    %% Configuration Sources Layer
    subgraph SourcesLayer["Configuration Sources"]
        ConfigFiles["Configuration Files (.js/.cjs/.mjs)"]
        EnvVars["Environment Variables"]
        ExtServices["External Services"]
    end

    %% Relationships
    Client --> ConfigDug
    ConfigDug --> Parser
    ConfigDug --> Preprocessor
    ConfigDug --> Reporter
    ConfigDug --> Origins
    ConfigDug --> Logger
    ConfigDug --> Redactor
    ConfigDug --> ModuleType
    ConfigDug --> ErrorHandler
    ConfigDug --> PrettyPrinter
    ConfigDug --> Options
    
    ConfigDug --> PluginSystem
    PluginSystem --> AWSPlugin
    PluginSystem --> OtherPlugins
    
    Parser --> ConfigFiles
    Parser --> EnvVars
    AWSPlugin --> ExtServices

    %% Click Events
    click ConfigDug "https://github.com/neofinancial/config-dug/blob/master/packages/config-dug/src/config-dug.ts"
    click PluginSystem "https://github.com/neofinancial/config-dug/blob/master/packages/config-dug/src/lib/plugin.ts"
    click Parser "https://github.com/neofinancial/config-dug/blob/master/packages/config-dug/src/lib/parser.ts"
    click Preprocessor "https://github.com/neofinancial/config-dug/blob/master/packages/config-dug/src/lib/preprocessor.ts"
    click Reporter "https://github.com/neofinancial/config-dug/blob/master/packages/config-dug/src/lib/reporter.ts"
    click AWSPlugin "https://github.com/neofinancial/config-dug/blob/master/packages/plugin-aws-secrets-manager/src/index.ts"
    click ConfigFiles "https://github.com/neofinancial/config-dug/blob/master/packages/config-dug/src/lib/config-file.ts"
    click EnvVars "https://github.com/neofinancial/config-dug/blob/master/packages/config-dug/src/lib/environment.ts"
    click Origins "https://github.com/neofinancial/config-dug/blob/master/packages/config-dug/src/lib/origins.ts"
    click Logger "https://github.com/neofinancial/config-dug/blob/master/packages/config-dug/src/lib/logger.ts"
    click Redactor "https://github.com/neofinancial/config-dug/blob/master/packages/config-dug/src/lib/redactor.ts"
    click ModuleType "https://github.com/neofinancial/config-dug/blob/master/packages/config-dug/src/lib/module-type.ts"
    click ErrorHandler "https://github.com/neofinancial/config-dug/blob/master/packages/config-dug/src/lib/errors.ts"
    click PrettyPrinter "https://github.com/neofinancial/config-dug/blob/master/packages/config-dug/src/lib/pretty-printer.ts"
    click Options "https://github.com/neofinancial/config-dug/blob/master/packages/config-dug/src/lib/options.ts"

    %% Style Applications
    class ConfigDug,Parser,Preprocessor,Reporter,Origins,Logger,Redactor,ModuleType,ErrorHandler,PrettyPrinter,Options core
    class PluginSystem,AWSPlugin,OtherPlugins plugin
    class ConfigFiles,EnvVars,ExtServices source
```
