Skip to content

Connector SDK

A connector is a capability-driven, bidirectional bridge between a provider (inbox, cloud drive, object store) and the Sweep engine. Connectors publish an honest capability matrix, enumerate objects, fetch and write payloads, trash and restore, and report quota. The engine owns the state machine, Shadow Sweep plans, authorization, receipts, and metering.

Start with the package: npm install @trustysweep/connector-sdk (source: sweep-platform/connector-sdk). The reference connector is the S3-compatible adapter in connectors/s3.