@syncmatters/connector-sdk

TypeScript type definitions and the connector authoring guide for the SyncMatters Connector SDK.

This is a types-only package: it provides IntelliSense and type checking when developing SyncMatters connectors locally (for example in VS Code or Cursor). Connector code executes on the SyncMatters platform, which provides the runtime implementation of this SDK.

Authoring guide (humans and AI assistants)

The complete guide to building SyncMatters connectors ships inside this package, version-locked to the types:

• docs/connector-authoring.md — start here (cheat sheet + index); focused topic files sit alongside it.

If you are an AI assistant working in a connector workspace: read that file before writing connector code. Workspaces created by the sm CLI also contain an AGENTS.md pointing here.

Usage

import SDK from "@syncmatters/connector-sdk";

export default class MyConnector {
  /** @param {SDK.InitArgs} args @returns {Promise<void>} */
  async init(args) {
    SDK.verifyType(this);
    // ...
  }

  /** @returns {Promise<SDK.TestResult>} */
  async test() {
    // ...
  }
}

Add "checkJs": true to your jsconfig.json to activate the JSDoc type annotations used in connector .mjs files.

Support

• https://syncmatters.com
• [email protected]