# commercetools/commercetools-sdk-typescript architecture

> Architecture diagram of the GitHub repository commercetools/commercetools-sdk-typescript, 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/commercetools/commercetools-sdk-typescript
- Repository: https://github.com/commercetools/commercetools-sdk-typescript

## Overview

##### Main Components Identification

The system consists of several key SDK packages that should be represented as primary components:
- Platform SDK
- Import API SDK
- History SDK
- SDK Client (v2 and v3)
- APM Integration

**┌─────────────────────────────────────────────┐**
- SDK Client Core                │
- ┌─────────────┐  ┌────────────────────┐   │
- Client V2   │  │     Client V3      │   │
- ┘  └────────────────────┘   │
- ┘

**┌─────────────────────────────────────────────┐**
- Middleware Layer               │
- ┌─────────┐ ┌──────┐ ┌──────┐ ┌────────┐ │
- Auth   │ │ HTTP │ │Queue │ │ Logger │ │
- ┘ └──────┘ └──────┘ └────────┘ │
- ┘

**┌─────────────────────────────────────────────┐**
- SDK Implementation               │
- ┌──────────┐ ┌────────┐ ┌───────────────┐  │
- Platform  │ │History │ │   Import API  │  │
- SDK     │ │  SDK   │ │     SDK      │  │
- ┘ └────────┘ └───────────────┘  │
- ┘

**┌─────────────────────────────────────────────┐**
- Integration Layer                │
- ┌─────────────┐    ┌──────────────────┐   │
- APM Support │    │ External Systems │   │
- ┘    └──────────────────┘   │
- ┘

##### Additional Elements

Supporting elements:
- Version badges for each SDK package
- Notes about authentication flows
- Integration points with external systems

##### Implementation Details

**┌─────────────────┐**
- Platform SDK    │
- ┤
- API Clients   │
- Type Defs     │
- Request Build │
- ┘

##### Specific Implementation Notes

- Relationship between different SDK versions
- Middleware chain processing
- Error handling and retry mechanisms
- Authentication flows and security measures

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Core["Core Layer"]
        ClientV2["SDK Client v2"]
        ClientV3["SDK Client v3"]
        Builder["Client Builder"]
    end

    subgraph Middleware["Middleware Layer"]
        Auth["Auth Middleware"]
        HTTP["HTTP Middleware"]
        Queue["Queue Middleware"]
        Logger["Logger Middleware"]
        Error["Error Handler"]
    end

    subgraph SDKs["SDK Implementation Layer"]
        Platform["Platform SDK"]
        History["History SDK"]
        Import["Import API SDK"]
    end

    subgraph Integration["Integration Layer"]
        APM["APM Support"]
        External["External Systems"]
    end

    %% Core Layer Relationships
    ClientV2 --> Auth
    ClientV3 --> Auth
    Builder --> ClientV3

    %% Middleware Chain
    Auth --> HTTP
    HTTP --> Queue
    Queue --> Logger
    Logger --> Error

    %% SDK Implementation Dependencies
    Error --> Platform
    Error --> History
    Error --> Import

    %% Integration Layer Connections
    Platform --> APM
    History --> APM
    Import --> APM
    APM -.-> External

    %% Click Events
    click ClientV2 "https://github.com/commercetools/commercetools-sdk-typescript/blob/master/packages/sdk-client/src/sdk-client/client.ts"
    click ClientV3 "https://github.com/commercetools/commercetools-sdk-typescript/blob/master/packages/sdk-client-v3/src/client/client.ts"
    click Builder "https://github.com/commercetools/commercetools-sdk-typescript/blob/master/packages/sdk-client-v3/src/client/builder.ts"
    click Auth "https://github.com/commercetools/commercetools-sdk-typescript/blob/master/packages/sdk-client-v3/src/middleware/auth-middleware/index.ts"
    click HTTP "https://github.com/commercetools/commercetools-sdk-typescript/blob/master/packages/sdk-client-v3/src/middleware/create-http-middleware.ts"
    click Queue "https://github.com/commercetools/commercetools-sdk-typescript/blob/master/packages/sdk-client-v3/src/middleware/create-queue-middleware.ts"
    click Logger "https://github.com/commercetools/commercetools-sdk-typescript/blob/master/packages/sdk-client-v3/src/middleware/create-logger-middleware.ts"
    click Error "https://github.com/commercetools/commercetools-sdk-typescript/blob/master/packages/sdk-client-v3/src/middleware/create-error-middleware.ts"
    click Platform "https://github.com/commercetools/commercetools-sdk-typescript/blob/master/packages/platform-sdk/src/index.ts"
    click History "https://github.com/commercetools/commercetools-sdk-typescript/blob/master/packages/history-sdk/src/index.ts"
    click Import "https://github.com/commercetools/commercetools-sdk-typescript/blob/master/packages/importapi-sdk/src/index.ts"
    click APM "https://github.com/commercetools/commercetools-sdk-typescript/blob/master/packages/ts-sdk-apm/src/apm.ts"

    %% Styling
    classDef core fill:#2374ab,color:#fff
    classDef middleware fill:#48a9a6,color:#fff
    classDef sdk fill:#e4a0f7,color:#000
    classDef integration fill:#f7b32b,color:#000
    classDef external fill:#d3d3d3,color:#000

    class ClientV2,ClientV3,Builder core
    class Auth,HTTP,Queue,Logger,Error middleware
    class Platform,History,Import sdk
    class APM,External integration
```
