Introduction

@sonar/sdk is the official TypeScript SDK for the Sonar Document Migration API. It provides a type-safe, ergonomic interface for managing documents and permissions.

What You Can Do

• Documents — List, upload, download, delete (single & batch), export as ZIP, and generate presigned download URLs
• Signature Chains — Track the full signing history of documents
• Scopes & Permissions — Query API key permissions and available scopes

Key Features

• Full TypeScript support with complete type definitions
• ESM and CommonJS module formats
• Automatic authentication, error handling, and response unwrapping
• Client-side validation before network requests
• Support for Buffer, Blob, and ReadableStream file uploads

Requirements

• Node.js >= 18.0.0
• Package: @sonar/sdk (v0.1.0)
• License: MIT

API Base URL

https://session.sonar.de/{instanceName}/api/sdk/v1/

Next Steps

• Getting Started — Install the SDK and make your first API call
• Configuration — Learn about all configuration options
• Documents — Full document operations reference