@sendmux/core

Shared runtime helpers and public types for the Sendmux TypeScript SDK packages.

Documentation

• Sendmux docs: sendmux.ai/docs
• Source repository: Sendmux/sendmux-sdk

Requirements

• A JavaScript runtime with the standard Fetch API.
• A surface package such as @sendmux/sending, @sendmux/mailbox, or @sendmux/management for API operations.

Installation

npm install @sendmux/core

Usage

Validate a key prefix and prepare request headers before calling a surface package.

import {
  assertApiKeyKind,
  conditionalHeaders,
  idempotencyHeaders,
} from "@sendmux/core";

assertApiKeyKind(process.env.SENDMUX_MAILBOX_API_KEY!, "mailbox");

const headers = {
  ...idempotencyHeaders("idem_123"),
  ...conditionalHeaders({ ifNoneMatch: 'W/"etag"' }),
};

Helpers

• assertApiKeyKind validates smx_root_* prefixes for root clients, send-capable smx_mbx_* prefixes or owner-approved Sending-resource smx_agent_* tokens for Sending clients, and mailbox-compatible smx_mbx_* or smx_agent_* prefixes for Mailbox clients.
• paginate iterates cursor-paginated Sendmux list responses.
• idempotencyHeaders, conditionalHeaders, and responseEtag cover idempotency and conditional requests.
• createRetryingFetch retries safe requests and idempotent POST requests with replayable bodies. It honours retryable: false and server retry delays; when a delay exceeds the configured deadline or runtime limit, it returns the response instead of retrying early.
• SendmuxApiError, mapApiError, and createErrorInterceptor normalise API errors.

Support

Open an issue in Sendmux/sendmux-sdk with the package name and version.

Licence

MIT. See the licence file.