# prooflinedev/sdk-typescript architecture

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

- Interactive diagram: https://gitdiagram.com/prooflinedev/sdk-typescript
- Repository: https://github.com/prooflinedev/sdk-typescript

## Overview

Proofline SDK is a typed Node.js client for review, coverage, export, and MCP knowledge/fix APIs. A caller configures `ProoflineClient`, invokes typed operations, and receives decoded results or typed errors; review iteration and waiting add client-side workflow behavior. The graph distinguishes the REST and MCP paths and their shared transport. Coverage, export decoding, and specialized MCP helpers are included; sampled excerpts establish the main wiring, while unsampled implementation details are not inferred.

Main entry points: [`src/index.ts`](https://github.com/prooflinedev/sdk-typescript/blob/main/src/index.ts) (ProoflineClient), [`src/transport.ts`](https://github.com/prooflinedev/sdk-typescript/blob/main/src/transport.ts) (HTTP transport), [`src/operations.ts`](https://github.com/prooflinedev/sdk-typescript/blob/main/src/operations.ts) (REST operations), [`src/mcp.ts`](https://github.com/prooflinedev/sdk-typescript/blob/main/src/mcp.ts) (MCP protocol)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Client workflows"]
  node_client["ProoflineClient<br/>[index.ts]"]
  node_review_flow["Review workflows<br/>[index.ts]"]
end

subgraph group_rest["REST API"]
  node_operations["REST operations<br/>[operations.ts]"]
  node_transport["HTTP transport<br/>[transport.ts]"]
  node_schema["API schema types<br/>[schema.d.ts]"]
end

subgraph group_mcp["MCP tools"]
  node_mcp_tools["MCP protocol<br/>[mcp.ts]"]
  node_knowledge["Knowledge tools<br/>[knowledge.ts]"]
  node_fixes["Fix tools<br/>[fixes.ts]"]
end

subgraph group_helpers["Data helpers"]
  node_coverage["Coverage files<br/>[coverage.ts]"]
  node_exports["Export decoder<br/>[exports.ts]"]
end

node_caller(("SDK caller"))
node_rest_api(("Proofline REST API"))
node_mcp_service(("Proofline MCP service"))

node_caller -->|"configures and calls"| node_client
node_client -->|"extends"| node_operations
node_client -->|"constructs and invokes"| node_transport
node_client -->|"provides"| node_review_flow
node_review_flow -->|"requests review data"| node_operations
node_operations -->|"invokes requests"| node_transport
node_transport -->|"sends HTTP"| node_rest_api
node_client -->|"reads upload files"| node_coverage
node_client -->|"decodes export response"| node_exports
node_knowledge -->|"calls tools"| node_mcp_tools
node_fixes -->|"calls tools"| node_mcp_tools
node_client -->|"exposes"| node_knowledge
node_client -->|"exposes"| node_fixes
node_mcp_tools -->|"sends MCP requests"| node_transport
node_mcp_tools -->|"calls tools"| node_mcp_service
node_operations -->|"uses request and response types"| node_schema
node_transport -->|"uses response types"| node_schema

click node_client "https://github.com/prooflinedev/sdk-typescript/blob/main/src/index.ts"
click node_review_flow "https://github.com/prooflinedev/sdk-typescript/blob/main/src/index.ts"
click node_operations "https://github.com/prooflinedev/sdk-typescript/blob/main/src/operations.ts"
click node_transport "https://github.com/prooflinedev/sdk-typescript/blob/main/src/transport.ts"
click node_mcp_tools "https://github.com/prooflinedev/sdk-typescript/blob/main/src/mcp.ts"
click node_knowledge "https://github.com/prooflinedev/sdk-typescript/blob/main/src/knowledge.ts"
click node_fixes "https://github.com/prooflinedev/sdk-typescript/blob/main/src/fixes.ts"
click node_coverage "https://github.com/prooflinedev/sdk-typescript/blob/main/src/coverage.ts"
click node_exports "https://github.com/prooflinedev/sdk-typescript/blob/main/src/exports.ts"
click node_schema "https://github.com/prooflinedev/sdk-typescript/blob/main/src/schema.d.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_client,node_review_flow toneBlue
class node_operations,node_transport,node_schema toneAmber
class node_mcp_tools,node_knowledge,node_fixes,node_rest_api toneMint
class node_coverage,node_exports toneRose
class node_caller,node_mcp_service toneIndigo
```

## Components

### Client workflows

- [ProoflineClient](https://github.com/prooflinedev/sdk-typescript/blob/main/src/index.ts): `src/index.ts`
- [Review workflows](https://github.com/prooflinedev/sdk-typescript/blob/main/src/index.ts): `src/index.ts`

### REST API

- [REST operations](https://github.com/prooflinedev/sdk-typescript/blob/main/src/operations.ts): `src/operations.ts`
- [HTTP transport](https://github.com/prooflinedev/sdk-typescript/blob/main/src/transport.ts): `src/transport.ts`
- [API schema types](https://github.com/prooflinedev/sdk-typescript/blob/main/src/schema.d.ts): `src/schema.d.ts`

### MCP tools

- [MCP protocol](https://github.com/prooflinedev/sdk-typescript/blob/main/src/mcp.ts): `src/mcp.ts`
- [Knowledge tools](https://github.com/prooflinedev/sdk-typescript/blob/main/src/knowledge.ts): `src/knowledge.ts`
- [Fix tools](https://github.com/prooflinedev/sdk-typescript/blob/main/src/fixes.ts): `src/fixes.ts`

### Data helpers

- [Coverage files](https://github.com/prooflinedev/sdk-typescript/blob/main/src/coverage.ts): `src/coverage.ts`
- [Export decoder](https://github.com/prooflinedev/sdk-typescript/blob/main/src/exports.ts): `src/exports.ts`

### Other components

- **SDK caller**
- **Proofline REST API**
- **Proofline MCP service**

## Connections

- SDK caller → ProoflineClient: configures and calls (evidence: `README.md`)
- ProoflineClient → REST operations: extends (evidence: `src/index.ts`)
- ProoflineClient → HTTP transport: constructs and invokes (evidence: `src/index.ts`)
- ProoflineClient → Review workflows: provides (evidence: `README.md`)
- Review workflows → REST operations: requests review data (evidence: `src/index.ts`)
- REST operations → HTTP transport: invokes requests (evidence: `src/operations.ts`)
- HTTP transport → Proofline REST API: sends HTTP (evidence: `README.md`)
- ProoflineClient → Coverage files: reads upload files (evidence: `src/index.ts`)
- ProoflineClient → Export decoder: decodes export response (evidence: `src/index.ts`)
- Knowledge tools → MCP protocol: calls tools (evidence: `src/knowledge.ts`)
- Fix tools → MCP protocol: calls tools (evidence: `src/fixes.ts`)
- ProoflineClient → Knowledge tools: exposes (evidence: `src/index.ts`)
- ProoflineClient → Fix tools: exposes (evidence: `src/index.ts`)
- MCP protocol → HTTP transport: sends MCP requests (evidence: `src/mcp.ts`)
- MCP protocol → Proofline MCP service: calls tools (evidence: `README.md`)
- REST operations → API schema types: uses request and response types (evidence: `src/operations.ts`)
- HTTP transport → API schema types: uses response types (evidence: `src/transport.ts`)
