# luiisca/obsidian-periodic-notes-calendar architecture

> Architecture diagram of the GitHub repository luiisca/obsidian-periodic-notes-calendar, 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/luiisca/obsidian-periodic-notes-calendar
- Repository: https://github.com/luiisca/obsidian-periodic-notes-calendar

## Overview

##### Main Components Organization

a) Core Plugin Infrastructure:
- Entry point (main.ts)
- Plugin initialization and lifecycle management
- Settings management system

b) User Interface Layer:
- Calendar View Components
- Modal Systems
- Popover Components
- Notice System

c) Data Management Layer:
- Store Management (Svelte stores)
- File I/O Operations
- Management

##### Key Relationships to Highlight

**[Obsidian API] <---> [Plugin Core] <---> [UI Layer]**
- ↕               ↕
- [Store Layer] <---> [I/O Layer]

##### Detailed Component Breakdown

a) UI Components (src/ui/):
- Calendar View
- Timeline View
- Modal System
- Popover System
- Notice System

b) Settings Management (src/settings/):
- Plugin Settings
- UI Configuration
- Format Management

c) I/O Operations (src/io/):
- Creation/Management
- Vault Interactions
- File System Operations

##### Component Interaction Flows

Following key flows:
**User Input -> UI Layer -> Store Updates -> File Operations -> Obsidian Vault**

##### Technical Stack Indicators

Technology badges for:
- Svelte (UI Framework)
- TypeScript
- Obsidian API
- Moment.js (Date handling)
- Chrono (Natural language parsing)

##### Architectural Patterns to Highlight

- Store-based state management
- Component-based UI architecture
- Event-driven interactions
- Plugin-host application pattern

##### Use consistent symbols
- Rectangles: Components
- Hexagons: External interfaces

Keep the abstraction level appropriate by:
- Focusing on component interaction rather than implementation details
- Highlighting the plugin's integration points with Obsidian
- Showing the data flow between different layers
- Emphasizing the event-driven nature of the plugin

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Core["Core Plugin Infrastructure"]
        Entry["Entry Point"]
        Settings["Plugin Settings"]
        SettingsStore["Settings Store"]
    end

    subgraph UI["User Interface Layer"]
        Calendar["Calendar Components"]
        Modal["Modal System"]
        Popover["Popover System"]
        Notice["Notice System"]
        Timeline["Timeline View"]
        ViewMgr["View Management"]
        DateNav["Date Navigation"]
        Sticker["Sticker System"]
        NLDate["Natural Language Datepicker"]
        CoreUI["Core UI Components"]
    end

    subgraph Data["Data Management Layer"]
        StoreMgr["Store Management"]
        CalStore["Calendar Store"]
        NotesStore["Notes Store"]
        FileIO["File I/O Operations"]
        NoteCreate["Note Creation"]
        VaultOps["Vault Operations"]
    end

    subgraph SettingsMgmt["Settings Management"]
        SettingsUI["Settings UI"]
        PluginTab["Plugin Tab"]
        FormatVal["Format Validation"]
        PeriodSet["Period Settings"]
        CalSet["Calendar Settings"]
    end

    subgraph Local["Localization"]
        LocaleMgr["Locale Management"]
        LocaleStore["Locale Store"]
        LocalePicker["Locales Picker"]
    end

    ObsidianAPI["Obsidian API"]:::external

    %% Relationships
    ObsidianAPI <--> Core
    Core <--> UI
    Core <--> Data
    UI <--> Data
    Data <--> SettingsMgmt
    UI <--> Local
    Core <--> Local

    %% Styling
    classDef external fill:#9370DB
    classDef core fill:#4169E1
    classDef ui fill:#3CB371
    classDef data fill:#FFD700
    classDef settings fill:#FFA500
    classDef local fill:#20B2AA

    class Core core
    class UI ui
    class Data data
    class SettingsMgmt settings
    class Local local

    %% Click events
    click Entry "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/main.ts"
    click Settings "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/settings/index.ts"
    click SettingsStore "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/settings/store.ts"
    click Calendar "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/ui/components/Calendar.svelte"
    click Modal "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/ui/modals/modals-manager.ts"
    click Popover "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/ui/popovers/index.ts"
    click Notice "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/ui/notice/index.ts"
    click Timeline "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/ui/components/timeline/Timeline.svelte"
    click ViewMgr "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/ui/components/view/manager.ts"
    click StoreMgr "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/stores/index.ts"
    click CalStore "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/stores/calendar.ts"
    click NotesStore "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/stores/notes.ts"
    click FileIO "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/io/index.ts"
    click NoteCreate "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/io/CreateNote.svelte"
    click VaultOps "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/io/vault.ts"
    click SettingsUI "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/settings/ui/Index.svelte"
    click PluginTab "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/settings/plugin-tab.ts"
    click FormatVal "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/io/validation/format.ts"
    click PeriodSet "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/settings/ui/tabs/periods/Index.svelte"
    click CalSet "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/settings/ui/tabs/calendar/Index.svelte"
    click DateNav "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/ui/components/DateNavigator.svelte"
    click Sticker "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/ui/components/Sticker.svelte"
    click NLDate "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/ui/components/Nldatepicker.svelte"
    click CoreUI "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/ui/components/core/index.ts"
    click LocaleMgr "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/localization.ts"
    click LocaleStore "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/stores/locale.ts"
    click LocalePicker "https://github.com/luiisca/obsidian-periodic-notes-calendar/blob/main/src/ui/components/LocalesPicker.svelte"
```
