@messagepipe/sdk

Developer-friendly & type-safe Typescript SDK specifically catered to leverage @messagepipe/sdk API.

Summary

MessagePipe Send API: Public high-throughput send API (spec §C.7). Accepts email / SMS / chat / push sends (single and bulk), returns 202 with a queued send; delivery is async. Authenticated with a workspace API key as a Bearer token (mp_live_...).

Table of Contents

• @messagepipe/sdk
  • 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 install @messagepipe/sdk

PNPM

pnpm add @messagepipe/sdk

Bun

bun add @messagepipe/sdk

Yarn

yarn add @messagepipe/sdk

[!NOTE] This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import() to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { MessagePipe } from "@messagepipe/sdk";

const messagePipe = new MessagePipe({
  apiKey: process.env["MESSAGEPIPE_API_KEY"] ?? "",
});

async function run() {
  const result = await messagePipe.email.send({
    body: {
      to: "[email protected]",
      attachments: [
        {
          filename: "invoice-1234.pdf",
          contentType: "application/pdf",
          content: "<value>",
        },
      ],
    },
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | -------- | ---- | ----------- | --------------------- | | apiKey | http | HTTP Bearer | MESSAGEPIPE_API_KEY |

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

import { MessagePipe } from "@messagepipe/sdk";

const messagePipe = new MessagePipe({
  apiKey: process.env["MESSAGEPIPE_API_KEY"] ?? "",
});

async function run() {
  const result = await messagePipe.email.send({
    body: {
      to: "[email protected]",
      attachments: [
        {
          filename: "invoice-1234.pdf",
          contentType: "application/pdf",
          content: "<value>",
        },
      ],
    },
  });

  console.log(result);
}

run();

Available Resources and Operations

Chat

• send - Send a single chat message
• sendBulk - Send up to 1,000 chat messages in one request

Device

• register - Register (or refresh) a device token for a user
• remove - Remove a registered device token

Email

• send - Send a single email
• sendBulk - Send up to 1,000 emails in one request

Push

• send - Send a single push notification
• sendBulk - Send up to 1,000 push notifications in one request
• register - Register (or refresh) a device token for a user
• remove - Remove a registered device token

Sends

• list - List recent sends (filterable, cursor-paginated)
• get - Get a send and its event history
• retry - Retry a failed send (creates a new send with the same content)

Sms

• send - Send a single SMS
• sendBulk - Send up to 1,000 SMS in one request

Templates

• list - List templates (optionally filtered by channel)
• get - Get a template by id

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.

• chatSend - Send a single chat message
• chatSendBulk - Send up to 1,000 chat messages in one request
• emailSend - Send a single email
• emailSendBulk - Send up to 1,000 emails in one request
• pushRegister - Register (or refresh) a device token for a user
• pushRegister - Register (or refresh) a device token for a user
• pushRemove - Remove a registered device token
• pushRemove - Remove a registered device token
• pushSend - Send a single push notification
• pushSendBulk - Send up to 1,000 push notifications in one request
• sendsGet - Get a send and its event history
• sendsList - List recent sends (filterable, cursor-paginated)
• sendsRetry - Retry a failed send (creates a new send with the same content)
• smsSend - Send a single SMS
• smsSendBulk - Send up to 1,000 SMS in one request
• templatesGet - Get a template by id
• templatesList - List templates (optionally filtered by channel)

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 { MessagePipe } from "@messagepipe/sdk";

const messagePipe = new MessagePipe({
  apiKey: process.env["MESSAGEPIPE_API_KEY"] ?? "",
});

async function run() {
  const result = await messagePipe.email.send({
    body: {
      to: "[email protected]",
      attachments: [
        {
          filename: "invoice-1234.pdf",
          contentType: "application/pdf",
          content: "<value>",
        },
      ],
    },
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  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 { MessagePipe } from "@messagepipe/sdk";

const messagePipe = new MessagePipe({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKey: process.env["MESSAGEPIPE_API_KEY"] ?? "",
});

async function run() {
  const result = await messagePipe.email.send({
    body: {
      to: "[email protected]",
      attachments: [
        {
          filename: "invoice-1234.pdf",
          contentType: "application/pdf",
          content: "<value>",
        },
      ],
    },
  });

  console.log(result);
}

run();

Error Handling

MessagePipeError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { MessagePipe } from "@messagepipe/sdk";
import * as errors from "@messagepipe/sdk/models/errors";

const messagePipe = new MessagePipe({
  apiKey: process.env["MESSAGEPIPE_API_KEY"] ?? "",
});

async function run() {
  try {
    const result = await messagePipe.email.send({
      body: {
        to: "[email protected]",
        attachments: [
          {
            filename: "invoice-1234.pdf",
            contentType: "application/pdf",
            content: "<value>",
          },
        ],
      },
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.MessagePipeError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorT) {
        console.log(error.data$.error); // models.ErrorError
      }
    }
  }
}

run();

Error Classes

Primary error:

• MessagePipeError: The base class for HTTP error responses.

Network errors:

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

Inherit from MessagePipeError:

• ErrorT: validation_failed / invalid_json / template_not_found. Applicable to 12 of 17 methods.*
• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

| # | Server | Description | | --- | --------------------------------- | ----------- | | 0 | https://api.dev.messagepipe.dev | Development | | 1 | http://localhost:8080 | Local |

Example

import { MessagePipe } from "@messagepipe/sdk";

const messagePipe = new MessagePipe({
  serverIdx: 0,
  apiKey: process.env["MESSAGEPIPE_API_KEY"] ?? "",
});

async function run() {
  const result = await messagePipe.email.send({
    body: {
      to: "[email protected]",
      attachments: [
        {
          filename: "invoice-1234.pdf",
          contentType: "application/pdf",
          content: "<value>",
        },
      ],
    },
  });

  console.log(result);
}

run();

Override Server URL Per-Client

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

import { MessagePipe } from "@messagepipe/sdk";

const messagePipe = new MessagePipe({
  serverURL: "http://localhost:8080",
  apiKey: process.env["MESSAGEPIPE_API_KEY"] ?? "",
});

async function run() {
  const result = await messagePipe.email.send({
    body: {
      to: "[email protected]",
      attachments: [
        {
          filename: "invoice-1234.pdf",
          contentType: "application/pdf",
          content: "<value>",
        },
      ],
    },
  });

  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:

• route requests through a proxy server using undici's ProxyAgent
• use the "beforeRequest" hook to add a custom header and a timeout to requests
• use the "requestError" hook to log errors

import { MessagePipe } from "@messagepipe/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@messagepipe/sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

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 MessagePipe({ httpClient: 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 { MessagePipe } from "@messagepipe/sdk";

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

You can also enable a default debug logger by setting an environment variable MESSAGEPIPE_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