@interfere/sdk 9.0.2 → 10.0.1-canary.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @interfere/sdk
 
+## 10.0.1-canary.0
+
+## 9.0.3
+
+### Patch Changes
+
+- [#1796](https://github.com/interfere-inc/interfere/pull/1796) [`7b3ccf6`](https://github.com/interfere-inc/interfere/commit/7b3ccf636f3121de4205c0e8b2ddcaea5e3bd6a9) Thanks [@skve](https://github.com/skve)! - Fixes an issue with source map uploading failing on larger projects
+
 ## 9.0.2
 
 ### Patch Changes

package/FUNCTIONS.md

@@ -1,11 +1,11 @@
 # Standalone Functions
 
 > [!NOTE]
-> This section is useful if you are using a bundler and targetting browsers and
+> This section is useful if you are using a bundler and targeting browsers and
 > runtimes where the size of an application affects performance and load times. 
 
 Every method in this SDK is also available as a standalone function. This
-alternative API is suitable when targetting the browser or serverless runtimes
+alternative API is suitable when targeting the browser or serverless runtimes
 and using a bundler to build your application since all unused functionality
 will be tree-shaken away. This includes code for unused methods, Zod schemas,
 encoding helpers and response handlers. The result is dramatically smaller
@@ -20,70 +20,19 @@ specific category of applications.
 
 ```typescript
 import { InterfereCore } from "@interfere/sdk/core.js";
-import { ingestPost } from "@interfere/sdk/funcs/ingest-post.js";
+import { healthGet } from "@interfere/sdk/funcs/health-get.js";
 
 // Use `InterfereCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const interfere = new InterfereCore();
 
 async function run() {
-  const res = await ingestPost(interfere, [
-    {
-      type: "replay_chunk",
-      buildId: "<id>",
-      clientTs: 870104,
-      environment: "development",
-      releaseId: "<id>",
-      runtime: "edge",
-      sessionId: "a2ba99cd-cfa7-4180-8531-8cf43498cb93",
-      uuid: "c6184cb5-7ebf-4da5-8951-879d34f73aaf",
-      v: 0,
-      payload: {
-        ts: 4133.68,
-        count: 5545.75,
-        events: [],
-      },
-    },
-    {
-      type: "error",
-      buildId: "<id>",
-      clientTs: 706130,
-      environment: "preview",
-      releaseId: "<id>",
-      runtime: "node",
-      sessionId: "eb8dc940-e4b3-4f0b-9d81-9d9129ee39d7",
-      uuid: "9c5d368e-bd79-4dcb-8e41-900825ef821a",
-      v: 0,
-      payload: {
-        exceptions: [
-          {
-            type: "<value>",
-            value: "<value>",
-            frames: [],
-          },
-        ],
-      },
-    },
-    {
-      type: "pageview",
-      buildId: "<id>",
-      clientTs: 505979,
-      environment: "preview",
-      releaseId: "<id>",
-      runtime: "edge",
-      sessionId: "4cc5eb79-5187-4fe2-9d83-d5da5974c1d6",
-      uuid: "cb48001e-3621-433b-af3c-476f1ec7ffe8",
-      v: 0,
-      payload: {
-        url: "https://same-statue.org/",
-      },
-    },
-  ]);
+  const res = await healthGet(interfere);
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("ingestPost failed:", res.error);
+    console.log("healthGet failed:", res.error);
   }
 }
 

package/README.md

@@ -22,7 +22,6 @@ Interfere Collector API: Public ingestion API for Interfere SDKs
   * [SDK Example Usage](#sdk-example-usage)
   * [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)
@@ -80,9 +79,7 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 <!-- Start SDK Example Usage [usage] -->
 ## SDK Example Usage
 
-### Ingest a batch of events
-
-Send a batch of event envelopes (errors, pageviews, rage clicks, ...) to the collector.
+### Example
 
 ```typescript
 import { Interfere } from "@interfere/sdk";
@@ -90,58 +87,7 @@ import { Interfere } from "@interfere/sdk";
 const interfere = new Interfere();
 
 async function run() {
-  const result = await interfere.ingest.post([
-    {
-      type: "replay_chunk",
-      buildId: "<id>",
-      clientTs: 870104,
-      environment: "development",
-      releaseId: "<id>",
-      runtime: "edge",
-      sessionId: "a2ba99cd-cfa7-4180-8531-8cf43498cb93",
-      uuid: "c6184cb5-7ebf-4da5-8951-879d34f73aaf",
-      v: 0,
-      payload: {
-        ts: 4133.68,
-        count: 5545.75,
-        events: [],
-      },
-    },
-    {
-      type: "error",
-      buildId: "<id>",
-      clientTs: 706130,
-      environment: "preview",
-      releaseId: "<id>",
-      runtime: "node",
-      sessionId: "eb8dc940-e4b3-4f0b-9d81-9d9129ee39d7",
-      uuid: "9c5d368e-bd79-4dcb-8e41-900825ef821a",
-      v: 0,
-      payload: {
-        exceptions: [
-          {
-            type: "<value>",
-            value: "<value>",
-            frames: [],
-          },
-        ],
-      },
-    },
-    {
-      type: "pageview",
-      buildId: "<id>",
-      clientTs: 505979,
-      environment: "preview",
-      releaseId: "<id>",
-      runtime: "edge",
-      sessionId: "4cc5eb79-5187-4fe2-9d83-d5da5974c1d6",
-      uuid: "cb48001e-3621-433b-af3c-476f1ec7ffe8",
-      v: 0,
-      payload: {
-        url: "https://same-statue.org/",
-      },
-    },
-  ]);
+  const result = await interfere.health.get();
 
   console.log(result);
 }
@@ -165,16 +111,16 @@ run();
 
 * [get](docs/sdks/health/README.md#get)
 
-### [Ingest](docs/sdks/ingest/README.md)
-
-* [post](docs/sdks/ingest/README.md#post)
-
 ### [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)
@@ -182,13 +128,18 @@ run();
 
 ### [SourceMaps](docs/sdks/sourcemaps/README.md)
 
-* [upload](docs/sdks/sourcemaps/README.md#upload)
-* [uploadMultipart](docs/sdks/sourcemaps/README.md#uploadmultipart)
+* [~~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)
 
+### [V2](docs/sdks/v2/README.md)
+
+* [v2Sink](docs/sdks/v2/README.md#v2sink)
+
 </details>
 <!-- End Available Resources and Operations [operations] -->
 
@@ -209,58 +160,21 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 - [`configGet`](docs/sdks/config/README.md#get)
 - [`healthGet`](docs/sdks/health/README.md#get)
-- [`ingestPost`](docs/sdks/ingest/README.md#post)
 - [`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)
-- [`sourceMapsUpload`](docs/sdks/sourcemaps/README.md#upload)
-- [`sourceMapsUploadMultipart`](docs/sdks/sourcemaps/README.md#uploadmultipart)
+- [`sourceMapsComplete`](docs/sdks/sourcemaps/README.md#complete)
+- [`sourceMapsSign`](docs/sdks/sourcemaps/README.md#sign)
 - [`telemetryReport`](docs/sdks/telemetry/README.md#report)
+- [`v2V2Sink`](docs/sdks/v2/README.md#v2sink)
+- ~~[`sourceMapsUpload`](docs/sdks/sourcemaps/README.md#upload)~~ - :warning: **Deprecated**
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
 
-<!-- Start File uploads [file-upload] -->
-## 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 `<input type="file">` 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();
-
-async function run() {
-  const result = await interfere.sourceMaps.uploadMultipart({
-    releaseSlug: "<value>",
-    body: {
-      files: [],
-      metadata: {
-        sourceMapToGenerated: {},
-        hashes: {},
-      },
-    },
-  });
-
-  console.log(result);
-}
-
-run();
-
-```
-<!-- End File uploads [file-upload] -->
-
 <!-- Start Retries [retries] -->
 ## Retries
 
@@ -371,7 +285,12 @@ run();
 ### Error Classes
 **Primary errors:**
 * [`InterfereHTTPError`](./src/models/errors/interfere-http-error.ts): The base class for HTTP error responses.
-  * [`ErrorsProblem`](./src/models/errors/errors-problem.ts): Standard error envelope for 4XX / 5XX 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): *
 
 <details><summary>Less common errors (7)</summary>
 
@@ -386,7 +305,7 @@ run();
 
 
 **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 11 methods.*
+* [`HealthError`](./src/models/errors/health-error.ts): Response for status 500. Status code `500`. Applicable to 1 of 13 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.
 
 </details>

package/USAGE.md

@@ -1,66 +1,11 @@
 <!-- Start SDK Example Usage [usage] -->
-### Ingest a batch of events
-
-Send a batch of event envelopes (errors, pageviews, rage clicks, ...) to the collector.
-
 ```typescript
 import { Interfere } from "@interfere/sdk";
 
 const interfere = new Interfere();
 
 async function run() {
-  const result = await interfere.ingest.post([
-    {
-      type: "replay_chunk",
-      buildId: "<id>",
-      clientTs: 870104,
-      environment: "development",
-      releaseId: "<id>",
-      runtime: "edge",
-      sessionId: "a2ba99cd-cfa7-4180-8531-8cf43498cb93",
-      uuid: "c6184cb5-7ebf-4da5-8951-879d34f73aaf",
-      v: 0,
-      payload: {
-        ts: 4133.68,
-        count: 5545.75,
-        events: [],
-      },
-    },
-    {
-      type: "error",
-      buildId: "<id>",
-      clientTs: 706130,
-      environment: "preview",
-      releaseId: "<id>",
-      runtime: "node",
-      sessionId: "eb8dc940-e4b3-4f0b-9d81-9d9129ee39d7",
-      uuid: "9c5d368e-bd79-4dcb-8e41-900825ef821a",
-      v: 0,
-      payload: {
-        exceptions: [
-          {
-            type: "<value>",
-            value: "<value>",
-            frames: [],
-          },
-        ],
-      },
-    },
-    {
-      type: "pageview",
-      buildId: "<id>",
-      clientTs: 505979,
-      environment: "preview",
-      releaseId: "<id>",
-      runtime: "edge",
-      sessionId: "4cc5eb79-5187-4fe2-9d83-d5da5974c1d6",
-      uuid: "cb48001e-3621-433b-af3c-476f1ec7ffe8",
-      v: 0,
-      payload: {
-        url: "https://same-statue.org/",
-      },
-    },
-  ]);
+  const result = await interfere.health.get();
 
   console.log(result);
 }

package/docs/lib/utils/retryconfig.md

@@ -7,7 +7,7 @@ Allows customizing the default retry configuration. It is only permitted in meth
 | Name                      | Type                                | Description                                                                                | Example     |
 | ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
 | `strategy`                | `"backoff" | "none"`                | The retry strategy to use.                                                                 | `"backoff"` |
-| `backoff`                 | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters.                  |             |
+| `backoff`                 | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configures the backoff parameters.                        |             |
 | `retryConnectionErrors`   | `*boolean*`                         | When strategy is "backoff", this determines whether or not to retry on connection errors.  | `true`      |
 
 ## BackoffStrategy

package/docs/models/collector-bare-error-code.md

@@ -0,0 +1,17 @@
+# CollectorBareErrorCode
+
+## Example Usage
+
+```typescript
+import { CollectorBareErrorCode } from "@interfere/sdk/models";
+
+let value: CollectorBareErrorCode = "COLLECTOR_REPLAY_UPLOAD_REJECTED";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"COLLECTOR_AUTH_MISSING" | "COLLECTOR_AUTH_API_KEY_REQUIRED" | "COLLECTOR_AUTH_API_KEY_INVALID" | "COLLECTOR_AUTH_PUB_TOKEN_INVALID" | "COLLECTOR_AUTH_PUB_TOKEN_NOT_ALLOWED" | "COLLECTOR_AUTH_API_KEY_NOT_ALLOWED" | "COLLECTOR_RELEASE_NOT_FOUND" | "COLLECTOR_RELEASE_MISSING_BUILD_ID" | "COLLECTOR_RELEASE_SIGN_EMPTY" | "COLLECTOR_RELEASE_PREFLIGHT_UNCONFIRMED" | "COLLECTOR_INGEST_BACKPRESSURE" | "COLLECTOR_INGEST_INFRA_UNAVAILABLE" | "COLLECTOR_OTLP_PRODUCER_REJECTED" | "COLLECTOR_OTLP_INVALID_SEMCONV" | "COLLECTOR_OTLP_MALFORMED_PAYLOAD" | "COLLECTOR_OTLP_UNSUPPORTED_CONTENT_TYPE" | "COLLECTOR_REPLAY_UPLOAD_REJECTED" | "COLLECTOR_SDK_TOO_OLD" | Unrecognized<string>
+```

package/docs/models/complete-source-map-file.md

@@ -0,0 +1,23 @@
+# CompleteSourceMapFile
+
+## Example Usage
+
+```typescript
+import { CompleteSourceMapFile } from "@interfere/sdk/models";
+
+let value: CompleteSourceMapFile = {
+  path: "/usr/ports",
+  hash: "<value>",
+  debugId: "<id>",
+  chunkUrl: "https://right-lava.org/",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `path`             | *string*           | :heavy_check_mark: | N/A                |
+| `hash`             | *string*           | :heavy_check_mark: | N/A                |
+| `debugId`          | *string*           | :heavy_check_mark: | N/A                |
+| `chunkUrl`         | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/config-response.md

@@ -6,12 +6,19 @@
 import { ConfigResponse } from "@interfere/sdk/models";
 
 let value: ConfigResponse = {
-  plugins: {},
+  plugins: {
+    errors: false,
+    device: true,
+    pageEvents: true,
+    rageClick: true,
+    replay: true,
+    logs: false,
+  },
 };
 ```
 
 ## Fields
 
-| Field                                                                | Type                                                                 | Required                                                             | Description                                                          |
-| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
-| `plugins`                                                            | [models.ConfigResponsePlugins](../models/config-response-plugins.md) | :heavy_check_mark:                                                   | N/A                                                                  |
+| Field                                                          | Type                                                           | Required                                                       | Description                                                    |
+| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
+| `plugins`                                                      | [models.RemotePluginConfig](../models/remote-plugin-config.md) | :heavy_check_mark:                                             | N/A                                                            |

package/docs/models/errors/collector-bare-error.md

@@ -0,0 +1,17 @@
+# CollectorBareError
+
+## Example Usage
+
+```typescript
+import { CollectorBareError } from "@interfere/sdk/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field                                                                      | Type                                                                       | Required                                                                   | Description                                                                |
+| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
+| `code`                                                                     | [models.CollectorBareErrorCode](../../models/collector-bare-error-code.md) | :heavy_check_mark:                                                         | N/A                                                                        |
+| `ok`                                                                       | *false*                                                                    | :heavy_minus_sign:                                                         | N/A                                                                        |
+| `message`                                                                  | *string*                                                                   | :heavy_minus_sign:                                                         | N/A                                                                        |