# xryul/obsidian-image-converter architecture

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

- Interactive diagram: https://gitdiagram.com/xryul/obsidian-image-converter
- Repository: https://github.com/xryul/obsidian-image-converter

## Overview

##### Project type and purpose
- This is an ObsidianMD plugin (“Image Converter for ObsidianMD”) written in TypeScript/JavaScript, running entirely in the user’s local Vault.
- Purpose: intercept image paste/drop events or context-menu actions in Obsidian, then convert, resize, compress, crop, annotate, rotate, flip, rename, and re-link images in Markdown notes—fully offline with no external binaries.

##### File structure
- Top-level:
- manifest.json, main.js, styles.css – the plugin’s public interface for Obsidian
- src/ – TypeScript sources, organized by feature (e.g., AsyncLock.ts, ImageProcessor.ts, Crop.ts, many “Modal” classes, settings classes)
- Examples/, README.md, LICENSE, package.json, esbuild.config.mjs – docs, sample usage, build config
- src/ contains:
- UI & Interaction: ContextMenu.ts, PresetSelectionModal.ts, ProcessAllVaultModal.ts, ProcessCurrentNote.ts, ProcessFolderModal.ts, ProcessSingleImageModal.ts
- Core Processing: BatchImageProcessor.ts, ImageProcessor.ts, ImageResizer.ts, ImageConverterSettings.ts, FolderAndFilenameManagement.ts, LinkFormatter & LinkFormatSettings, VariableProcessor.ts
- Image Features: Crop.ts, ImageAlignmentManager.ts, ImageAnnotation.ts, …
- Utilities: AsyncLock.ts, SupportedImageFormats.ts, UTIF.js/d.ts, heic-to.d.ts

##### README for additional insights
- Confirms features: convert/compress/resize/align/annotate/crop/rotate/flip/rename/batch, all offline.
- Lists technology: Pure JS, FabricJS for annotation, UTIF for TIF support.
- No backend or external services—everything runs via Obsidian’s plugin API and local file I/O.

##### Detailed capturing of essential elements
- Don’t fragment too much: group related TS classes under “Image Processing” or “UI Modals” as appropriate
- Asynchronous locking, batch vs single-image flows
- Settings flow: Settings → passed into UI & Processing stages

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "User / Obsidian Layer"
        User["User"]:::external
        ObsidianAPI["Obsidian Plugin API"]:::external
    end

    subgraph "Plugin Entry"
        PluginEntry["Plugin Entry (main.ts)"]:::core
    end

    subgraph "UI Layer"
        ContextMenu["ContextMenu"]:::ui
        PresetModal["PresetSelectionModal"]:::ui
        ProcessAllVaultModal["ProcessAllVaultModal"]:::ui
        ProcessCurrentNote["ProcessCurrentNote"]:::ui
        ProcessFolderModal["ProcessFolderModal"]:::ui
        ProcessSingleImageModal["ProcessSingleImageModal"]:::ui
    end

    subgraph "Settings Manager"
        ImageConverterSettings["ImageConverterSettings"]:::core
        LinkFormatSettings["LinkFormatSettings"]:::core
        NonDestructiveResizeSettings["NonDestructiveResizeSettings"]:::core
    end

    subgraph "Core Processing"
        BatchImageProcessor["BatchImageProcessor"]:::core
        ImageProcessor["ImageProcessor"]:::core
        ImageResizer["ImageResizer"]:::core
        Crop["Crop"]:::core
        ImageAnnotation["ImageAnnotation"]:::core
        ImageAlignmentManager["ImageAlignmentManager"]:::core
        FolderAndFilenameManagement["FolderAndFilenameManagement"]:::core
        VariableProcessor["VariableProcessor"]:::core
        LinkFormatter["LinkFormatter"]:::core
        AsyncLock["AsyncLock"]:::core
        SupportedImageFormats["SupportedImageFormats"]:::core
    end

    subgraph "External Libraries"
        FabricJS["FabricJS"]:::ext
        UTIF["UTIF.js"]:::ext
        HEIC["heic-to.d.ts"]:::ext
    end

    subgraph "Storage / Vault"
        VaultFS["Vault File System"]:::storage
    end

    User --> ObsidianAPI
    ObsidianAPI --> PluginEntry

    PluginEntry --> ImageConverterSettings
    PluginEntry --> LinkFormatSettings
    PluginEntry --> NonDestructiveResizeSettings
    PluginEntry --> ContextMenu
    PluginEntry --> PresetModal
    PluginEntry --> ProcessAllVaultModal
    PluginEntry --> ProcessCurrentNote
    PluginEntry --> ProcessFolderModal
    PluginEntry --> ProcessSingleImageModal

    ContextMenu --> BatchImageProcessor
    PresetModal --> BatchImageProcessor
    ProcessAllVaultModal --> BatchImageProcessor
    ProcessCurrentNote --> BatchImageProcessor
    ProcessFolderModal --> BatchImageProcessor
    ProcessSingleImageModal --> ImageProcessor

    BatchImageProcessor --> AsyncLock
    ImageProcessor --> AsyncLock
    BatchImageProcessor --> ImageProcessor

    ImageProcessor --> ImageResizer
    ImageProcessor --> Crop
    ImageProcessor --> ImageAnnotation
    ImageProcessor --> ImageAlignmentManager
    ImageProcessor --> SupportedImageFormats

    Crop --> UTIF
    ImageAnnotation --> FabricJS
    SupportedImageFormats --> HEIC

    ImageProcessor --> FolderAndFilenameManagement
    BatchImageProcessor --> FolderAndFilenameManagement
    FolderAndFilenameManagement --> VariableProcessor
    VariableProcessor --> LinkFormatter

    LinkFormatter --> VaultFS
    BatchImageProcessor --> VaultFS
    ImageProcessor --> VaultFS

    VaultFS --> ObsidianAPI

    click PluginEntry "https://github.com/xryul/obsidian-image-converter/blob/master/src/main.ts"
    click ImageConverterSettings "https://github.com/xryul/obsidian-image-converter/blob/master/src/ImageConverterSettings.ts"
    click LinkFormatSettings "https://github.com/xryul/obsidian-image-converter/blob/master/src/LinkFormatSettings.ts"
    click NonDestructiveResizeSettings "https://github.com/xryul/obsidian-image-converter/blob/master/src/NonDestructiveResizeSettings.ts"
    click ContextMenu "https://github.com/xryul/obsidian-image-converter/blob/master/src/ContextMenu.ts"
    click PresetModal "https://github.com/xryul/obsidian-image-converter/blob/master/src/PresetSelectionModal.ts"
    click ProcessAllVaultModal "https://github.com/xryul/obsidian-image-converter/blob/master/src/ProcessAllVaultModal.ts"
    click ProcessCurrentNote "https://github.com/xryul/obsidian-image-converter/blob/master/src/ProcessCurrentNote.ts"
    click ProcessFolderModal "https://github.com/xryul/obsidian-image-converter/blob/master/src/ProcessFolderModal.ts"
    click ProcessSingleImageModal "https://github.com/xryul/obsidian-image-converter/blob/master/src/ProcessSingleImageModal.ts"
    click BatchImageProcessor "https://github.com/xryul/obsidian-image-converter/blob/master/src/BatchImageProcessor.ts"
    click ImageProcessor "https://github.com/xryul/obsidian-image-converter/blob/master/src/ImageProcessor.ts"
    click ImageResizer "https://github.com/xryul/obsidian-image-converter/blob/master/src/ImageResizer.ts"
    click Crop "https://github.com/xryul/obsidian-image-converter/blob/master/src/Crop.ts"
    click ImageAnnotation "https://github.com/xryul/obsidian-image-converter/blob/master/src/ImageAnnotation.ts"
    click ImageAlignmentManager "https://github.com/xryul/obsidian-image-converter/blob/master/src/ImageAlignmentManager.ts"
    click FolderAndFilenameManagement "https://github.com/xryul/obsidian-image-converter/blob/master/src/FolderAndFilenameManagement.ts"
    click VariableProcessor "https://github.com/xryul/obsidian-image-converter/blob/master/src/VariableProcessor.ts"
    click LinkFormatter "https://github.com/xryul/obsidian-image-converter/blob/master/src/LinkFormatter.ts"
    click AsyncLock "https://github.com/xryul/obsidian-image-converter/blob/master/src/AsyncLock.ts"
    click SupportedImageFormats "https://github.com/xryul/obsidian-image-converter/blob/master/src/SupportedImageFormats.ts"
    click UTIF "https://github.com/xryul/obsidian-image-converter/blob/master/src/UTIF.js"
    click HEIC "https://github.com/xryul/obsidian-image-converter/blob/master/src/heic-to.d.ts"

    classDef ui fill:#D6EAF8,stroke:#21618C
    classDef core fill:#FDEBD0,stroke:#B9770E
    classDef ext fill:#D5F5E3,stroke:#239B56
    classDef storage fill:#E5E7E9,stroke:#566573
    classDef external fill:#F4ECF7,stroke:#7D3C98
```
