jmap-kit Developer Guide

jmap-kit is a typed JavaScript/TypeScript library for building JMAP (JSON Meta Application Protocol) clients. It handles session management, request building, response dispatching, file operations, and a plugin system for validation and transformation — all with full type safety.

This guide covers every aspect of the library. If you are new, start with Getting Started.

Contents

1. Getting Started — Introduction to JMAP, installation, creating a transport and client, connecting
2. Session — Session data, server capabilities, accounts, staleness detection
3. Capabilities — Capability URIs, built-in capabilities, registration, auto-inclusion
4. Invocations — Creating method calls, type-safe factories, result references
5. Building Requests — Request builder, the using set, ID management, sending
6. Handling Responses — Dispatch handlers, manual iteration, lookup by ID
7. File Operations — Uploading, downloading, URL templates
8. Customisation — Custom transport, logger, and event emitter
9. Plugins — Validation and transformation plugin system
10. Custom Capabilities — Creating your own capability definitions, connection lifecycle
11. Security — Transport security, authentication, handling untrusted server data
12. Troubleshooting — Diagnosing connection, request, and response errors

API Reference

See the API Reference in the sidebar for the full generated TypeDoc documentation.