# meilisearch/meilisearch-js architecture

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

- Interactive diagram: https://gitdiagram.com/meilisearch/meilisearch-js
- Repository: https://github.com/meilisearch/meilisearch-js

## Overview

##### Main Components

a) Client Layer:
- MeiliSearch Client Class (core interface)
- Index Management
- Document Management
- Search Operations
- Settings Management
- Task Management

b) Communication Layer:
- HTTP Client Interface
- Request/Response Handling
- Error Handling

c) Type System:
- TypeScript Definitions
- API Models

##### Key Relationships

**[Client Applications] → [Meilisearch JS SDK] → [Meilisearch Server]**
- ↓
- [Type System & Models] ← [HTTP Layer]

##### Detailed Component Breakdown

a) Core Components:
**MeiliSearch Client**
- Index Management
- CRUD Operations
- Settings Management
- Document Operations
- Add/Update
- Delete
- Search
- Task Management
- Status Tracking
- Batch Operations
- Authentication
- API Key Management

b) HTTP Layer:
**HTTP Client**
- Request Builder
- Response Parser
- Error Handler
- Retry Logic

##### Implementation Details to Highlight

a) Client Features:
- Multiple environment support (Node.js, Browser, Deno)
- TypeScript integration
- Promise-based API
- Batch operations
- Search parameter customization

b) Architecture Patterns:
- Builder pattern for search queries
- Factory pattern for index creation
- Observer pattern for task monitoring
- Strategy pattern for HTTP client customization

##### Integration Points

a) External Systems:
- Meilisearch Server API
- Custom HTTP clients
- Proxy support

b) Client Applications:
- Browser integration
- Node.js applications
- Framework integrations

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client_Applications
        Browser["Browser Apps"]
        Node["Node.js Apps"]
        Deno["Deno Apps"]
    end

    subgraph SDK_Core
        Client["MeiliSearch Client"]:::core
        click Client "https://github.com/meilisearch/meilisearch-js/blob/main/src/meilisearch.ts"
        
        subgraph Index_Operations
            IndexMgmt["Index Management"]:::core
            click IndexMgmt "https://github.com/meilisearch/meilisearch-js/blob/main/src/indexes.ts"
            DocOps["Document Operations"]:::core
            Settings["Settings Management"]:::core
        end

        subgraph Task_System
            TaskMgmt["Task Management"]:::core
            click TaskMgmt "https://github.com/meilisearch/meilisearch-js/blob/main/src/task.ts"
            BatchOps["Batch Operations"]:::core
            click BatchOps "https://github.com/meilisearch/meilisearch-js/blob/main/src/batch.ts"
            EnqueuedTask["Enqueued Task"]:::core
            click EnqueuedTask "https://github.com/meilisearch/meilisearch-js/blob/main/src/enqueued-task.ts"
        end

        subgraph Auth_System
            Auth["Authentication"]:::auth
            click Auth "https://github.com/meilisearch/meilisearch-js/blob/main/src/token.ts"
            ApiKey["API Key Management"]:::auth
        end
    end

    subgraph Communication_Layer
        HTTP["HTTP Client Interface"]:::http
        click HTTP "https://github.com/meilisearch/meilisearch-js/blob/main/src/http-requests.ts"
        ReqBuilder["Request Builder"]:::http
        ResParser["Response Parser"]:::http
        RetryLogic["Retry Logic"]:::http
    end

    subgraph Error_Handling
        ErrorSystem["Error Handler"]:::error
        MeiliError["MeiliSearch Error"]:::error
        click MeiliError "https://github.com/meilisearch/meilisearch-js/blob/main/src/errors/meilisearch-error.ts"
        ApiError["API Error"]:::error
        click ApiError "https://github.com/meilisearch/meilisearch-js/blob/main/src/errors/meilisearch-api-error.ts"
        ReqError["Request Error"]:::error
        click ReqError "https://github.com/meilisearch/meilisearch-js/blob/main/src/errors/meilisearch-request-error.ts"
        TimeoutError["Timeout Error"]:::error
        click TimeoutError "https://github.com/meilisearch/meilisearch-js/blob/main/src/errors/meilisearch-timeout-error.ts"
    end

    subgraph Type_System
        Types["Type Definitions"]:::type
        click Types "https://github.com/meilisearch/meilisearch-js/blob/main/src/types.ts"
        ApiModels["API Models"]:::type
    end

    subgraph Utils
        UtilFuncs["Utility Functions"]:::util
        click UtilFuncs "https://github.com/meilisearch/meilisearch-js/blob/main/src/utils.ts"
        PackageVer["Package Version"]:::util
        click PackageVer "https://github.com/meilisearch/meilisearch-js/blob/main/src/package-version.ts"
    end

    Browser & Node & Deno --> Client
    Client --> IndexMgmt & TaskMgmt & Auth
    IndexMgmt --> DocOps & Settings
    TaskMgmt --> BatchOps & EnqueuedTask
    Auth --> ApiKey
    Client --> HTTP
    HTTP --> ReqBuilder & ResParser & RetryLogic
    HTTP --> ErrorSystem
    ErrorSystem --> MeiliError & ApiError & ReqError & TimeoutError
    HTTP -.-> Types
    Types --> ApiModels
    Client -.-> UtilFuncs
    UtilFuncs --> PackageVer

    classDef core fill:#3498db,stroke:#2980b9,color:white
    classDef http fill:#2ecc71,stroke:#27ae60,color:white
    classDef error fill:#e74c3c,stroke:#c0392b,color:white
    classDef type fill:#f1c40f,stroke:#f39c12,color:black
    classDef auth fill:#9b59b6,stroke:#8e44ad,color:white
    classDef util fill:#95a5a6,stroke:#7f8c8d,color:white

    %% Legend
    subgraph Legend
        L1["Core Components"]:::core
        L2["HTTP Layer"]:::http
        L3["Error Handling"]:::error
        L4["Type System"]:::type
        L5["Authentication"]:::auth
        L6["Utilities"]:::util
    end
```
