# ocyss/boos-helper architecture

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

- Interactive diagram: https://gitdiagram.com/ocyss/boos-helper
- Repository: https://github.com/ocyss/boos-helper

## Overview

##### Project-Type & Purpose
- The project is a browser extension designed to assist with resume submissions on the Boos直聘 platform. The README explains that it aims to reduce manual resume submissions and improve efficiency.
- It leverages modern frontend technologies including Vite, Vue3, and element-plus. Initially an oil monkey script, it has now been restructured as a browser extension.
- Key functionalities include job application enhancements (bulk submissions, GPT-powered filtering, and auto-reply chat features) along with user configuration and logging, as seen in the directory and component names.

##### File Structure Analysis
- The top-level directories (src, docs, .github) indicate that the bulk of the application’s logic is in src, with documentation assets provided under docs.
- src contains typical Vue application files (App.vue, main.ts, main.scss) and is organized into:
- Hooks: which encapsulate reusable business logic for chat, model interactions, configuration forms, websockets (including MQTT and protobuf integration), and other common utilities.
- Pages: representing different sections (for example, job-related pages under src/pages/geek/job) which together form the UI views.
- Types and Utils: clearly separating business data contracts and utility functions, which indicates a layered design focusing on clarity and maintainability.
- There are configuration files and scripts (like vite.config.ts, package.json, tsconfig files) that indicate the modern build and deployment process.

## Diagram (Mermaid)

```mermaid
graph TD
    subgraph "Browser Extension Shell"
        Vite["Vite Config"]:::build
        Pkg["Package.json"]:::build
        TS["TSConfig"]:::build
    end

    subgraph "UI Layer"
        subgraph "Vue Components"
            Chat["UI – Chat Component"]:::ui
            LogConf["UI – Log Configuration"]:::ui
            StoreConf["UI – Store Configuration"]:::ui
            UserConf["UI – User Configuration"]:::ui
            FormItem["UI – Form Item"]:::ui
            FormSelect["UI – Form Select"]:::ui
            FormSwitch["UI – Form Switch"]:::ui
            InfoIcon["UI – Info Icon"]:::ui
            SettingsIcon["UI – Settings Icon"]:::ui
            LLMConf["UI – LLM Configuration"]:::ui
            LLMCreation["UI – LLM Creation"]:::ui
            LLMForm["UI – LLM Form"]:::ui
            LLMFormItem["UI – LLM Form Item"]:::ui
            LLMSelect["UI – LLM Select"]:::ui
            LoggerDisplay["UI – Logger Display"]:::ui
        end
        subgraph "Pages"
            AboutPage["Page – About"]:::page
            AIPage["Page – AI"]:::page
            CardPage["Page – Card"]:::page
            ConfigPage["Page – Config"]:::page
            LogsPage["Page – Logs"]:::page
            StatsPage["Page – Statistics"]:::page
            UIGeneric["Page – UI"]:::page
        end
    end

    subgraph "Business Logic Layer"
        Applying["Logic – useApplying"]:::logic
        ChatHook["Logic – useChat"]:::logic
        ModelHook["Logic – useModel"]:::logic
        OpenAI["Logic – OpenAI"]:::logic
        Moonshot["Logic – Moonshot"]:::logic
        Coze["Logic – Coze"]:::logic
        UserLLM["Logic – User LLM"]:::logic
        WebSocket["Logic – useWebSocket"]:::logic
        Additional["Logic – Additional Hooks"]:::logic
    end

    subgraph "Data & Utility Layer"
        DataTypes["Data – Types"]:::data
        Utilities["Data – Utilities"]:::data
        Protobuf["Data – Protobuf"]:::data
    end

    subgraph "Integration Layer"
        External["Integration – External APIs"]:::external
    end

    %% Connections from Browser Extension Shell to UI Layer (build process)
    Vite -->|"builds"| Chat
    Pkg -->|"builds"| AboutPage
    TS -->|"builds"| ConfigPage

    %% UI Layer interactions triggering Business Logic
    Chat -->|"triggers"| Applying
    LogConf -->|"updates"| Additional
    StoreConf -->|"updates"| Additional
    UserConf -->|"updates"| Additional
    FormItem -->|"input"| Additional
    FormSelect -->|"input"| Additional
    FormSwitch -->|"toggle"| Additional
    InfoIcon -->|"info"| Additional
    SettingsIcon -->|"settings"| Additional
    LLMConf -->|"configures"| ModelHook
    LLMCreation -->|"creates"| ModelHook
    LLMForm -->|"submits"| ModelHook
    LLMFormItem -->|"submits"| ModelHook
    LLMSelect -->|"selects"| ModelHook
    LoggerDisplay -->|"logs"| Additional

    AboutPage -->|"navigates"| ChatHook
    AIPage -->|"interacts"| ChatHook
    CardPage -->|"applies"| Applying
    ConfigPage -->|"configures"| Additional
    LogsPage -->|"views"| Additional
    StatsPage -->|"analyzes"| Additional
    UIGeneric -->|"serves"| Additional

    %% Business Logic Layer using Data & Utility Layer
    Applying -->|"uses"| Utilities
    ChatHook -->|"uses"| Utilities
    ModelHook -->|"uses"| Utilities
    WebSocket -->|"uses"| Utilities
    Additional -->|"uses"| Utilities

    Applying -->|"typed by"| DataTypes
    ChatHook -->|"typed by"| DataTypes
    ModelHook -->|"typed by"| DataTypes
    WebSocket -->|"typed by"| DataTypes
    Additional -->|"typed by"| DataTypes

    %% Business Logic Layer communicating with External APIs
    ModelHook -->|"calls"| External
    OpenAI -->|"calls"| External
    Moonshot -->|"calls"| External
    Coze -->|"calls"| External
    UserLLM -->|"calls"| External
    WebSocket -->|"calls"| External
    ChatHook -->|"calls"| External
    Applying -->|"calls"| External

    %% Data & Utility Layer supporting WebSocket with Protobuf
    Protobuf -->|"defines"| WebSocket

    %% Internal interactions among logic components
    Additional -->|"coordinates"| ChatHook
    Additional -->|"co-ordinates"| ModelHook

    %% Click Events for Browser Extension Shell
    click Vite "https://github.com/ocyss/boos-helper/blob/master/vite.config.ts"
    click Pkg "https://github.com/ocyss/boos-helper/blob/master/package.json"
    click TS "https://github.com/ocyss/boos-helper/blob/master/tsconfig.json"

    %% Click Events for UI – Vue Components
    click Chat "https://github.com/ocyss/boos-helper/blob/master/src/components/chat/chat.vue"
    click LogConf "https://github.com/ocyss/boos-helper/blob/master/src/components/conf/log.vue"
    click StoreConf "https://github.com/ocyss/boos-helper/blob/master/src/components/conf/store.vue"
    click UserConf "https://github.com/ocyss/boos-helper/blob/master/src/components/conf/user.vue"
    click FormItem "https://github.com/ocyss/boos-helper/blob/master/src/components/form/formItem.vue"
    click FormSelect "https://github.com/ocyss/boos-helper/blob/master/src/components/form/formSelect.vue"
    click FormSwitch "https://github.com/ocyss/boos-helper/blob/master/src/components/form/formSwitch.vue"
    click InfoIcon "https://github.com/ocyss/boos-helper/blob/master/src/components/icon/info.vue"
    click SettingsIcon "https://github.com/ocyss/boos-helper/blob/master/src/components/icon/settings.vue"
    click LLMConf "https://github.com/ocyss/boos-helper/blob/master/src/components/llms/configLLM.vue"
    click LLMCreation "https://github.com/ocyss/boos-helper/blob/master/src/components/llms/createLLM.vue"
    click LLMForm "https://github.com/ocyss/boos-helper/blob/master/src/components/llms/lForm.vue"
    click LLMFormItem "https://github.com/ocyss/boos-helper/blob/master/src/components/llms/lFormItem.vue"
    click LLMSelect "https://github.com/ocyss/boos-helper/blob/master/src/components/llms/selectLLM.vue"
    click LoggerDisplay "https://github.com/ocyss/boos-helper/blob/master/src/components/logger.vue"

    %% Click Events for UI – Pages
    click AboutPage "https://github.com/ocyss/boos-helper/blob/master/src/pages/geek/job/about.vue"
    click AIPage "https://github.com/ocyss/boos-helper/blob/master/src/pages/geek/job/ai.vue"
    click CardPage "https://github.com/ocyss/boos-helper/blob/master/src/pages/geek/job/card.vue"
    click ConfigPage "https://github.com/ocyss/boos-helper/blob/master/src/pages/geek/job/config.vue"
    click LogsPage "https://github.com/ocyss/boos-helper/blob/master/src/pages/geek/job/logs.vue"
    click StatsPage "https://github.com/ocyss/boos-helper/blob/master/src/pages/geek/job/statistics.vue"
    click UIGeneric "https://github.com/ocyss/boos-helper/blob/master/src/pages/geek/job/ui.vue"

    %% Click Events for Business Logic (Hooks)
    click Applying "https://github.com/ocyss/boos-helper/tree/master/src/hooks/useApplying"
    click ChatHook "https://github.com/ocyss/boos-helper/tree/master/src/hooks/useChat"
    click ModelHook "https://github.com/ocyss/boos-helper/tree/master/src/hooks/useModel"
    click OpenAI "https://github.com/ocyss/boos-helper/blob/master/src/hooks/useModel/llms/openai.ts"
    click Moonshot "https://github.com/ocyss/boos-helper/blob/master/src/hooks/useModel/llms/moonshot.ts"
    click Coze "https://github.com/ocyss/boos-helper/blob/master/src/hooks/useModel/llms/coze.ts"
    click UserLLM "https://github.com/ocyss/boos-helper/blob/master/src/hooks/useModel/llms/user.ts"
    click WebSocket "https://github.com/ocyss/boos-helper/tree/master/src/hooks/useWebSocket"
    click Additional "https://github.com/ocyss/boos-helper/blob/master/src/hooks/useCommon.ts"

    %% Click Events for Data & Utility Layer
    click DataTypes "https://github.com/ocyss/boos-helper/blob/master/src/types/boosData.d.ts"
    click Utilities "https://github.com/ocyss/boos-helper/tree/master/src/utils"
    click Protobuf "https://github.com/ocyss/boos-helper/blob/master/src/assets/chat.proto"

    %% Styles
    classDef build fill:#f9f,stroke:#333,stroke-width:2px;
    classDef ui fill:#bbf,stroke:#333,stroke-width:2px;
    classDef page fill:#ddf,stroke:#333,stroke-width:2px;
    classDef logic fill:#fbf,stroke:#333,stroke-width:2px;
    classDef data fill:#dfd,stroke:#333,stroke-width:2px;
    classDef external fill:#ffd,stroke:#333,stroke-width:2px;

    class Vite,Pkg,TS build;
    class Chat,LogConf,StoreConf,UserConf,FormItem,FormSelect,FormSwitch,InfoIcon,SettingsIcon,LLMConf,LLMCreation,LLMForm,LLMFormItem,LLMSelect,LoggerDisplay ui;
    class AboutPage,AIPage,CardPage,ConfigPage,LogsPage,StatsPage,UIGeneric page;
    class Applying,ChatHook,ModelHook,OpenAI,Moonshot,Coze,UserLLM,WebSocket,Additional logic;
    class DataTypes,Utilities,Protobuf data;
    class External external;
```
