# cjinhuo/text-search-engine architecture

> Architecture diagram of the GitHub repository cjinhuo/text-search-engine, 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/cjinhuo/text-search-engine
- Repository: https://github.com/cjinhuo/text-search-engine

## Overview

##### Component Relationships

- Input text and search target → Core Engine
- Core Engine → Search Results (ranges)
- Search Results → React Components
- Build System → Different Distribution Formats

##### Detailed Component Breakdown

Core Engine:
**┌─ Core Search Engine ─────────────────┐**
- ┌─────────────┐    ┌──────────────┐ │
- Pure Search │ → │ Boundary      │ │
- ┘    └──────────────┘ │
- ┌─────────────┐    ┌──────────────┐ │
- Search API  │ → │ Utils         │ │
- ┘    └──────────────┘ │
- ┘

React Integration:
**┌─ React Components ──────────────────┐**
- ┌─────────────────┐ ┌─────────────┐│
- HighlightWithTarget│ │HighlightWithRanges││
- ┘ └─────────────┘│
- ┘

##### Integration Points

External integration possibilities:
- Chrome Extension usage
- Web Applications
- Node.js Applications

##### Data Flow

- Input text flow
- Search pattern flow
- Result ranges flow
- Rendering flow

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph 文本搜索引擎系统
        subgraph 核心搜索引擎包
            SearchCore["搜索核心算法"]:::core
            BoundaryProcess["边界处理模块"]:::core
            ReactWrapper["React组件封装"]:::react
            TypeDefs["类型定义"]:::util
        end

        subgraph 在线演示应用
            Pages["页面展示层"]:::react
            Components["组件层"]:::react
            Router["路由层"]:::util
            Utils["工具层"]:::util

            subgraph 演示组件
                BaseLayout["基础布局"]:::react
                Header["头部组件"]:::react
                SearchList["搜索列表"]:::react
                HighlightText["高亮文本"]:::react
            end

            subgraph 工具模块
                Hooks["Hook工具"]:::util
                Config["配置模块"]:::util
                SharedUtils["通用工具"]:::util
            end
        end
    end

    %% 组件关系
    SearchCore --> BoundaryProcess
    BoundaryProcess --> ReactWrapper
    ReactWrapper --> Components
    TypeDefs --> SearchCore
    TypeDefs --> ReactWrapper

    Pages --> Components
    Router --> Pages
    Components --> Utils
    Components --> Hooks
    Components --> Config

    %% 演示组件关系
    Components --> BaseLayout
    Components --> Header
    Components --> SearchList
    Components --> HighlightText

    %% 样式定义
    classDef core fill:#2196F3,stroke:#1565C0,color:white
    classDef react fill:#4CAF50,stroke:#2E7D32,color:white
    classDef util fill:#FFC107,stroke:#FFA000,color:black

    %% 点击事件
    click SearchCore "https://github.com/cjinhuo/text-search-engine/blob/master/packages/text-search-engine/src/search.ts"
    click BoundaryProcess "https://github.com/cjinhuo/text-search-engine/blob/master/packages/text-search-engine/src/boundary.ts"
    click ReactWrapper "https://github.com/cjinhuo/text-search-engine/blob/master/packages/text-search-engine/src/react/highlight.tsx"
    click TypeDefs "https://github.com/cjinhuo/text-search-engine/blob/master/packages/text-search-engine/src/types.ts"
    click Pages "https://github.com/cjinhuo/text-search-engine/tree/master/app/online-demo/src/pages"
    click Components "https://github.com/cjinhuo/text-search-engine/tree/master/app/online-demo/src/components"
    click Router "https://github.com/cjinhuo/text-search-engine/blob/master/app/online-demo/src/router/router.tsx"
    click Utils "https://github.com/cjinhuo/text-search-engine/tree/master/app/online-demo/src/shared"
    click BaseLayout "https://github.com/cjinhuo/text-search-engine/tree/master/app/online-demo/src/components/base-layout"
    click Header "https://github.com/cjinhuo/text-search-engine/tree/master/app/online-demo/src/components/header"
    click SearchList "https://github.com/cjinhuo/text-search-engine/tree/master/app/online-demo/src/components/ListSearch"
    click HighlightText "https://github.com/cjinhuo/text-search-engine/tree/master/app/online-demo/src/components/LightedText"
    click Hooks "https://github.com/cjinhuo/text-search-engine/tree/master/app/online-demo/src/hooks"
    click Config "https://github.com/cjinhuo/text-search-engine/tree/master/app/online-demo/src/config"
    click SharedUtils "https://github.com/cjinhuo/text-search-engine/blob/master/app/online-demo/src/shared/utils.ts"
```
