> [!IMPORTANT]
> This SDK is not yet ready for external use, and only covers a very small subset of our API. We have plans to flesh out a fully built out public SDK in Q3 2026.
## Summary
Interfere Collector API: Public ingestion API for Interfere SDKs
## Table of Contents
* [Interfere SDK](#interfere-sdk)
* [SDK Installation](#sdk-installation)
* [Requirements](#requirements)
* [SDK Example Usage](#sdk-example-usage)
* [Authentication](#authentication)
* [Available Resources and Operations](#available-resources-and-operations)
* [Standalone functions](#standalone-functions)
* [File uploads](#file-uploads)
* [Retries](#retries)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Custom HTTP Client](#custom-http-client)
* [Debugging](#debugging)
* [Development](#development)
* [Maturity](#maturity)
## SDK Installation
> [!TIP]
> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
### NPM
```bash
npm add
```
### PNPM
```bash
pnpm add
```
### Bun
```bash
bun add
```
### Yarn
```bash
yarn add
```
> [!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](RUNTIMES.md).
## SDK Example Usage
### Example
```typescript
import { Interfere } from "@interfere/sdk";
const interfere = new Interfere();
async function run() {
const result = await interfere.health.get();
console.log(result);
}
run();
```
## Authentication
### Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
| ---------------- | ------ | ------- | --------------------------- |
| `publishableKey` | apiKey | API key | `INTERFERE_PUBLISHABLE_KEY` |
To authenticate with the API the `publishableKey` parameter must be set when initializing the SDK client instance. For example:
```typescript
import { Interfere } from "@interfere/sdk";
const interfere = new Interfere({
publishableKey: process.env["INTERFERE_PUBLISHABLE_KEY"] ?? "",
});
async function run() {
const result = await interfere.health.get();
console.log(result);
}
run();
```
### Per-Operation Security Schemes
Some operations in this SDK require the security scheme to be specified at the request level. For example:
```typescript
import { Interfere } from "@interfere/sdk";
const interfere = new Interfere();
async function run() {
const result = await interfere.releases.getConfig({
apiKey: process.env["INTERFERE_API_KEY"] ?? "",
});
console.log(result);
}
run();
```
## Available Resources and Operations
Available methods
### [Config](docs/sdks/config/README.md)
* [get](docs/sdks/config/README.md#get)
### [Drains](docs/sdks/drains/README.md)
* [v1Traces](docs/sdks/drains/README.md#v1traces)
* [v1Logs](docs/sdks/drains/README.md#v1logs)
### [Health](docs/sdks/health/README.md)
* [get](docs/sdks/health/README.md#get)
### [Releases](docs/sdks/releases/README.md)
* [getConfig](docs/sdks/releases/README.md#getconfig)
* [create](docs/sdks/releases/README.md#create)
* [preflight](docs/sdks/releases/README.md#preflight)
### [Replay](docs/sdks/replay/README.md)
* [uploadReplayChunk](docs/sdks/replay/README.md#uploadreplaychunk)
### [Sessions](docs/sdks/sessions/README.md)
* [create](docs/sdks/sessions/README.md#create)
* [identify](docs/sdks/sessions/README.md#identify)
### [SourceMaps](docs/sdks/sourcemaps/README.md)
* [~~upload~~](docs/sdks/sourcemaps/README.md#upload) - :warning: **Deprecated**
* [sign](docs/sdks/sourcemaps/README.md#sign)
* [complete](docs/sdks/sourcemaps/README.md#complete)
### [Telemetry](docs/sdks/telemetry/README.md)
* [report](docs/sdks/telemetry/README.md#report)
## 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](./FUNCTIONS.md).
Available standalone functions
- [`configGet`](docs/sdks/config/README.md#get)
- [`drainsV1Logs`](docs/sdks/drains/README.md#v1logs)
- [`drainsV1Traces`](docs/sdks/drains/README.md#v1traces)
- [`healthGet`](docs/sdks/health/README.md#get)
- [`releasesCreate`](docs/sdks/releases/README.md#create)
- [`releasesGetConfig`](docs/sdks/releases/README.md#getconfig)
- [`releasesPreflight`](docs/sdks/releases/README.md#preflight)
- [`replayUploadReplayChunk`](docs/sdks/replay/README.md#uploadreplaychunk)
- [`sessionsCreate`](docs/sdks/sessions/README.md#create)
- [`sessionsIdentify`](docs/sdks/sessions/README.md#identify)
- [`sourceMapsComplete`](docs/sdks/sourcemaps/README.md#complete)
- [`sourceMapsSign`](docs/sdks/sourcemaps/README.md#sign)
- [`telemetryReport`](docs/sdks/telemetry/README.md#report)
- ~~[`sourceMapsUpload`](docs/sdks/sourcemaps/README.md#upload)~~ - :warning: **Deprecated**
## File uploads
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
> [!TIP]
>
> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
>
> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.
> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `` element.
> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).
```typescript
import { Interfere } from "@interfere/sdk";
const interfere = new Interfere({
publishableKey: process.env["INTERFERE_PUBLISHABLE_KEY"] ?? "",
});
async function run() {
const result = await interfere.replay.uploadReplayChunk({
sessionId: "",
body: bytesToStream(new TextEncoder().encode("[\"\"]")),
});
console.log(result);
}
run();
```
## 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:
```typescript
import { Interfere } from "@interfere/sdk";
const interfere = new Interfere();
async function run() {
const result = await interfere.health.get({
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:
```typescript
import { Interfere } from "@interfere/sdk";
const interfere = new Interfere({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
async function run() {
const result = await interfere.health.get();
console.log(result);
}
run();
```
## Error Handling
[`InterfereHTTPError`](./src/models/errors/interfere-http-error.ts) 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](#error-classes). |
### Example
```typescript
import { Interfere } from "@interfere/sdk";
import * as errors from "@interfere/sdk/models/errors";
const interfere = new Interfere();
async function run() {
try {
const result = await interfere.health.get();
console.log(result);
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.InterfereHTTPError) {
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.HealthError) {
console.log(error.data$.ok); // boolean
console.log(error.data$.message); // string
}
}
}
}
run();
```
### Error Classes
**Primary errors:**
* [`InterfereHTTPError`](./src/models/errors/interfere-http-error.ts): The base class for HTTP error responses.
* [`LibraryBareError`](./src/models/errors/library-bare-error.ts): *
* [`ValidationError`](./src/models/errors/validation-error.ts): *
* [`CollectorBareError`](./src/models/errors/collector-bare-error.ts): *
* [`ReleaseSignTooManyFilesError`](./src/models/errors/release-sign-too-many-files-error.ts): *
* [`ReleaseSignFileTooLargeError`](./src/models/errors/release-sign-file-too-large-error.ts): *
* [`ReleaseSignDuplicatePathError`](./src/models/errors/release-sign-duplicate-path-error.ts): *
Less common errors (7)
**Network errors:**
* [`ConnectionError`](./src/models/errors/http-client-errors.ts): HTTP client was unable to make a request to a server.
* [`RequestTimeoutError`](./src/models/errors/http-client-errors.ts): HTTP request timed out due to an AbortSignal signal.
* [`RequestAbortedError`](./src/models/errors/http-client-errors.ts): HTTP request was aborted by the client.
* [`InvalidRequestError`](./src/models/errors/http-client-errors.ts): Any input used to create a request is invalid.
* [`UnexpectedClientError`](./src/models/errors/http-client-errors.ts): Unrecognised or unexpected error.
**Inherit from [`InterfereHTTPError`](./src/models/errors/interfere-http-error.ts)**:
* [`HealthError`](./src/models/errors/health-error.ts): Response for status 500. Status code `500`. Applicable to 1 of 14 methods.*
* [`ResponseValidationError`](./src/models/errors/response-validation-error.ts): 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](#available-resources-and-operations) to see if the error is applicable.
## 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:
```typescript
import { Interfere } from "@interfere/sdk";
const interfere = new Interfere({
serverURL: "https://in.interfere.com",
});
async function run() {
const result = await interfere.health.get();
console.log(result);
}
run();
```
## Custom HTTP Client
The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/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](https://www.npmjs.com/package/undici)'s ProxyAgent
- use the `"beforeRequest"` hook to add a custom header and a timeout to requests
- use the `"requestError"` hook to log errors
```typescript
import { Interfere } from "@interfere/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@interfere/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 Interfere({ 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.
```typescript
import { Interfere } from "@interfere/sdk";
const sdk = new Interfere({ debugLogger: console });
```
You can also enable a default debug logger by setting an environment variable `INTERFERE_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.