Ampersand Platform SDK

Overview

Ampersand is a declarative platform for SaaS builders who are creating product integrations. It allows you to:

• Read data from your customer’s SaaS
• Write data to your customer’s SaaS
• Subscribe to events (creates, deletes, and field changes) in your customer’s SaaS

Summary

Table of Contents

• Ampersand Platform SDK
• Overview
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @amp-labs/sdk-node-platform

PNPM

pnpm add @amp-labs/sdk-node-platform

Bun

bun add @amp-labs/sdk-node-platform

Yarn

yarn add @amp-labs/sdk-node-platform zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server from npm.

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "SDKNodePlatform": {
      "command": "npx",
      "args": [
        "-y", "--package", "@amp-labs/sdk-node-platform",
        "--",
        "mcp", "start",
        "--api-key-header", "..."
      ]
    }
  }
}

Create a .cursor/mcp.json file in your project root with the following content:

{
  "mcpServers": {
    "SDKNodePlatform": {
      "command": "npx",
      "args": [
        "-y", "--package", "@amp-labs/sdk-node-platform",
        "--",
        "mcp", "start",
        "--api-key-header", "..."
      ]
    }
  }
}

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

npx -y --package @amp-labs/sdk-node-platform -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { SDKNodePlatform } from "@amp-labs/sdk-node-platform";

const sdkNodePlatform = new SDKNodePlatform({
  apiKeyHeader: process.env["SDKNODEPLATFORM_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await sdkNodePlatform.oauth.connect({
    providerWorkspaceRef: "salesforce-instance-domain",
    projectId: "my-project",
    groupRef: "group-123",
    groupName: "Organization Name",
    consumerRef: "user_123456",
    consumerName: "John Doe",
    providerAppId: "32356abe-d2fd-49c7-9030-abdcbc6456d4",
    provider: "salesforce",
  });

  // Handle the result
  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | -------------- | ------ | ------- | -------------------------------- | | apiKeyHeader | apiKey | API key | SDKNODEPLATFORM_API_KEY_HEADER |

To authenticate with the API the apiKeyHeader parameter must be set when initializing the SDK client instance. For example:

import { SDKNodePlatform } from "@amp-labs/sdk-node-platform";

const sdkNodePlatform = new SDKNodePlatform({
  apiKeyHeader: process.env["SDKNODEPLATFORM_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await sdkNodePlatform.oauth.connect({
    providerWorkspaceRef: "salesforce-instance-domain",
    projectId: "my-project",
    groupRef: "group-123",
    groupName: "Organization Name",
    consumerRef: "user_123456",
    consumerName: "John Doe",
    providerAppId: "32356abe-d2fd-49c7-9030-abdcbc6456d4",
    provider: "salesforce",
  });

  // Handle the result
  console.log(result);
}

run();

Available Resources and Operations

connections

• list - List connections
• generate - Generate a new connection
• get - Get a connection
• update - Update a connection.
• delete - Delete a connection

consumers

• create - Create a new consumer

destinations

• create - Create a new destination
• list - List destinations
• get - Get a destination
• update - Update a destination
• delete - Delete a destination

groups

• create - Create a new group

installations

• list - List installations
• create - Create a new installation
• get - Get an installation
• delete - Delete an installation
• update - Update an installation

integrations

• list - List integrations
• create - Create a new integration.
• delete - Delete an integration
• batchUpsert - Batch upsert a group of integrations

oauth

• connect - Get URL for OAuth flow
• update - Get URL for updating OAuth connection

objectsAndFields

• getMetadata - Get object metadata for installation
• getObjectMetadataForConnection - Get object metadata for connection

operations

• list - List operations
• get - Get an operation
• listLogs - List logs for an operation

orgBuilders

• list - List builders for an organization

projects

• list - List all projects that the API key or user credential has access to.
• create - Create a new project
• get - Get a project
• delete - Delete a project
• update - Update a project

providerApps

• list - List provider apps
• create - Create a new provider app
• delete - Delete a provider app.
• update - Update a provider app

providers

• list - List providers
• get - Get provider

revisions

• create - Create a new revision.
• hydrate - Hydrate a revision

uploadUrls

• generate - Generate a signed URL to upload a zip file to.

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• connectionsDelete - Delete a connection
• connectionsGenerate - Generate a new connection
• connectionsGet - Get a connection
• connectionsList - List connections
• connectionsUpdate - Update a connection.
• consumersCreate - Create a new consumer
• destinationsCreate - Create a new destination
• destinationsDelete - Delete a destination
• destinationsGet - Get a destination
• destinationsList - List destinations
• destinationsUpdate - Update a destination
• groupsCreate - Create a new group
• installationsCreate - Create a new installation
• installationsDelete - Delete an installation
• installationsGet - Get an installation
• installationsList - List installations
• installationsUpdate - Update an installation
• integrationsBatchUpsert - Batch upsert a group of integrations
• integrationsCreate - Create a new integration.
• integrationsDelete - Delete an integration
• integrationsList - List integrations
• oauthConnect - Get URL for OAuth flow
• oauthUpdate - Get URL for updating OAuth connection
• objectsAndFieldsGetMetadata - Get object metadata for installation
• objectsAndFieldsGetObjectMetadataForConnection - Get object metadata for connection
• operationsGet - Get an operation
• operationsList - List operations
• operationsListLogs - List logs for an operation
• orgBuildersList - List builders for an organization
• projectsCreate - Create a new project
• projectsDelete - Delete a project
• projectsGet - Get a project
• projectsList - List all projects that the API key or user credential has access to.
• projectsUpdate - Update a project
• providerAppsCreate - Create a new provider app
• providerAppsDelete - Delete a provider app.
• providerAppsList - List provider apps
• providerAppsUpdate - Update a provider app
• providersGet - Get provider
• providersList - List providers
• revisionsCreate - Create a new revision.
• revisionsHydrate - Hydrate a revision
• uploadUrlsGenerate - Generate a signed URL to upload a zip file to.

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { SDKNodePlatform } from "@amp-labs/sdk-node-platform";

const sdkNodePlatform = new SDKNodePlatform({
  apiKeyHeader: process.env["SDKNODEPLATFORM_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await sdkNodePlatform.oauth.connect({
    providerWorkspaceRef: "salesforce-instance-domain",
    projectId: "my-project",
    groupRef: "group-123",
    groupName: "Organization Name",
    consumerRef: "user_123456",
    consumerName: "John Doe",
    providerAppId: "32356abe-d2fd-49c7-9030-abdcbc6456d4",
    provider: "salesforce",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  // Handle the result
  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { SDKNodePlatform } from "@amp-labs/sdk-node-platform";

const sdkNodePlatform = new SDKNodePlatform({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKeyHeader: process.env["SDKNODEPLATFORM_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await sdkNodePlatform.oauth.connect({
    providerWorkspaceRef: "salesforce-instance-domain",
    projectId: "my-project",
    groupRef: "group-123",
    groupName: "Organization Name",
    consumerRef: "user_123456",
    consumerName: "John Doe",
    providerAppId: "32356abe-d2fd-49c7-9030-abdcbc6456d4",
    provider: "salesforce",
  });

  // Handle the result
  console.log(result);
}

run();

Error Handling

Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the connect method may throw the following errors:

| Error Type | Status Code | Content Type | | ----------------------------------------- | ----------- | ------------------------ | | errors.OauthConnectInputValidationProblem | 400 | application/problem+json | | errors.APIError | 4XX, 5XX | */* |

If the method throws an error and it is not captured by the known errors, it will default to throwing a APIError.

import { SDKNodePlatform } from "@amp-labs/sdk-node-platform";
import {
  OauthConnectInputValidationProblem,
  SDKValidationError,
} from "@amp-labs/sdk-node-platform/models/errors";

const sdkNodePlatform = new SDKNodePlatform({
  apiKeyHeader: process.env["SDKNODEPLATFORM_API_KEY_HEADER"] ?? "",
});

async function run() {
  let result;
  try {
    result = await sdkNodePlatform.oauth.connect({
      providerWorkspaceRef: "salesforce-instance-domain",
      projectId: "my-project",
      groupRef: "group-123",
      groupName: "Organization Name",
      consumerRef: "user_123456",
      consumerName: "John Doe",
      providerAppId: "32356abe-d2fd-49c7-9030-abdcbc6456d4",
      provider: "salesforce",
    });

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError): {
        // Pretty-print will provide a human-readable multi-line error message
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof OauthConnectInputValidationProblem): {
        // Handle err.data$: OauthConnectInputValidationProblemData
        console.error(err);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:

| HTTP Client Error | Description | | ---------------------------------------------------- | ---------------------------------------------------- | | RequestAbortedError | HTTP request was aborted by the client | | RequestTimeoutError | HTTP request timed out due to an AbortSignal signal | | ConnectionError | HTTP client was unable to make a request to a server | | InvalidRequestError | Any input used to create a request is invalid | | UnexpectedClientError | Unrecognised or unexpected error |

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { SDKNodePlatform } from "@amp-labs/sdk-node-platform";

const sdkNodePlatform = new SDKNodePlatform({
  serverURL: "https://api.withampersand.com/v1",
  apiKeyHeader: process.env["SDKNODEPLATFORM_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await sdkNodePlatform.oauth.connect({
    providerWorkspaceRef: "salesforce-instance-domain",
    projectId: "my-project",
    groupRef: "group-123",
    groupName: "Organization Name",
    consumerRef: "user_123456",
    consumerName: "John Doe",
    providerAppId: "32356abe-d2fd-49c7-9030-abdcbc6456d4",
    provider: "salesforce",
  });

  // Handle the result
  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { SDKNodePlatform } from "@amp-labs/sdk-node-platform";
import { HTTPClient } from "@amp-labs/sdk-node-platform/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new SDKNodePlatform({ httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { SDKNodePlatform } from "@amp-labs/sdk-node-platform";

const sdk = new SDKNodePlatform({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable SDKNODEPLATFORM_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy