@interfere/sdk 8.1.6 → 9.0.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @interfere/sdk
 
+## 9.0.2
+
+### Patch Changes
+
+- [#1704](https://github.com/interfere-inc/interfere/pull/1704) [`3279b68`](https://github.com/interfere-inc/interfere/commit/3279b6880d32a0be71773c92e54cd6de79262614) Thanks [@skve](https://github.com/skve)! - Now confirms release completion explicitly and non-complete releases are excluded from evidence
+
 ## 8.1.6
 
 ### Patch Changes

package/CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing to This Repository
+
+Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
+
+## How to Report Issues
+
+If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
+
+- A clear and descriptive title
+- Steps to reproduce the issue
+- Expected and actual behavior
+- Any relevant logs, screenshots, or error messages
+- Information about your environment (e.g., operating system, software versions)
+    - For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
+
+## Issue Triage and Upstream Fixes
+
+We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
+
+## Contact
+
+If you have any questions or need further assistance, please feel free to reach out by opening an issue.
+
+Thank you for your understanding and cooperation!
+
+The Maintainers

package/README.md

@@ -173,6 +173,7 @@ run();
 
 * [getConfig](docs/sdks/releases/README.md#getconfig)
 * [create](docs/sdks/releases/README.md#create)
+* [preflight](docs/sdks/releases/README.md#preflight)
 
 ### [Sessions](docs/sdks/sessions/README.md)
 
@@ -211,6 +212,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`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)
 - [`sessionsCreate`](docs/sdks/sessions/README.md#create)
 - [`sessionsIdentify`](docs/sdks/sessions/README.md#identify)
 - [`sourceMapsUpload`](docs/sdks/sourcemaps/README.md#upload)
@@ -384,7 +386,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 10 methods.*
+* [`HealthError`](./src/models/errors/health-error.ts): Response for status 500. Status code `500`. Applicable to 1 of 11 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

@@ -0,0 +1,71 @@
+<!-- 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/",
+      },
+    },
+  ]);
+
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End SDK Example Usage [usage] -->

package/docs/lib/utils/retryconfig.md

@@ -0,0 +1,24 @@
+# RetryConfig
+
+Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.
+
+## Fields
+
+| 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.                  |             |
+| `retryConnectionErrors`   | `*boolean*`                         | When strategy is "backoff", this determines whether or not to retry on connection errors.  | `true`      |
+
+## BackoffStrategy
+
+The backoff strategy allows retrying a request with an exponential backoff between each retry.
+
+### Fields
+
+| Name               | Type         | Description                               | Example  |
+| ------------------ | ------------ | ----------------------------------------- | -------- |
+| `initialInterval`  | `*number*`   | The initial interval in milliseconds.     | `500`    |
+| `maxInterval`      | `*number*`   | The maximum interval in milliseconds.     | `60000`  |
+| `exponent`         | `*number*`   | The exponent to use for the backoff.      | `1.5`    |
+| `maxElapsedTime`   | `*number*`   | The maximum elapsed time in milliseconds. | `300000` |

package/docs/models/auth0-identify-source-name.md

@@ -0,0 +1,15 @@
+# Auth0IdentifySourceName
+
+## Example Usage
+
+```typescript
+import { Auth0IdentifySourceName } from "@interfere/sdk/models";
+
+let value: Auth0IdentifySourceName = "Auth0";
+```
+
+## Values
+
+```typescript
+"Auth0"
+```

package/docs/models/auth0-identify-source.md

@@ -0,0 +1,19 @@
+# Auth0IdentifySource
+
+## Example Usage
+
+```typescript
+import { Auth0IdentifySource } from "@interfere/sdk/models";
+
+let value: Auth0IdentifySource = {
+  name: "Auth0",
+  type: "auth0",
+};
+```
+
+## Fields
+
+| Field                                                                     | Type                                                                      | Required                                                                  | Description                                                               |
+| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `name`                                                                    | [models.Auth0IdentifySourceName](../models/auth0-identify-source-name.md) | :heavy_check_mark:                                                        | N/A                                                                       |
+| `type`                                                                    | *"auth0"*                                                                 | :heavy_check_mark:                                                        | N/A                                                                       |

package/docs/models/browser-context.md

@@ -0,0 +1,37 @@
+# BrowserContext
+
+Request context for the browser runtime.
+
+## Example Usage
+
+```typescript
+import { BrowserContext } from "@interfere/sdk/models";
+
+let value: BrowserContext = {
+  runtime: "browser",
+  browser: {
+    display: {
+      screen: {
+        height: 7531.67,
+        width: 591.54,
+      },
+    },
+  },
+  device: {
+    browser: {},
+    cpu: {},
+    device: {},
+    engine: {},
+    os: {},
+    ua: "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                                                   | Type                                                    | Required                                                | Description                                             |
+| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
+| `runtime`                                               | *"browser"*                                             | :heavy_check_mark:                                      | N/A                                                     |
+| `browser`                                               | [models.BrowserMetadata](../models/browser-metadata.md) | :heavy_check_mark:                                      | N/A                                                     |
+| `device`                                                | [models.DeviceMetadata](../models/device-metadata.md)   | :heavy_check_mark:                                      | N/A                                                     |

package/docs/models/browser-metadata.md

@@ -0,0 +1,26 @@
+# BrowserMetadata
+
+Browser locale and display metadata.
+
+## Example Usage
+
+```typescript
+import { BrowserMetadata } from "@interfere/sdk/models";
+
+let value: BrowserMetadata = {
+  display: {
+    screen: {
+      height: 7531.67,
+      width: 591.54,
+    },
+  },
+};
+```
+
+## Fields
+
+| Field                                  | Type                                   | Required                               | Description                            |
+| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
+| `language`                             | *string*                               | :heavy_minus_sign:                     | N/A                                    |
+| `timezone`                             | *string*                               | :heavy_minus_sign:                     | N/A                                    |
+| `display`                              | [models.Display](../models/display.md) | :heavy_check_mark:                     | N/A                                    |

package/docs/models/clerk-identify-source-name.md

@@ -0,0 +1,15 @@
+# ClerkIdentifySourceName
+
+## Example Usage
+
+```typescript
+import { ClerkIdentifySourceName } from "@interfere/sdk/models";
+
+let value: ClerkIdentifySourceName = "Clerk";
+```
+
+## Values
+
+```typescript
+"Clerk"
+```

package/docs/models/clerk-identify-source.md

@@ -0,0 +1,19 @@
+# ClerkIdentifySource
+
+## Example Usage
+
+```typescript
+import { ClerkIdentifySource } from "@interfere/sdk/models";
+
+let value: ClerkIdentifySource = {
+  name: "Clerk",
+  type: "clerk",
+};
+```
+
+## Fields
+
+| Field                                                                     | Type                                                                      | Required                                                                  | Description                                                               |
+| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `name`                                                                    | [models.ClerkIdentifySourceName](../models/clerk-identify-source-name.md) | :heavy_check_mark:                                                        | N/A                                                                       |
+| `type`                                                                    | *"clerk"*                                                                 | :heavy_check_mark:                                                        | N/A                                                                       |

package/docs/models/config-response-plugins.md

@@ -0,0 +1,14 @@
+# ConfigResponsePlugins
+
+## Example Usage
+
+```typescript
+import { ConfigResponsePlugins } from "@interfere/sdk/models";
+
+let value: ConfigResponsePlugins = {};
+```
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |

package/docs/models/config-response.md

@@ -0,0 +1,17 @@
+# ConfigResponse
+
+## Example Usage
+
+```typescript
+import { ConfigResponse } from "@interfere/sdk/models";
+
+let value: ConfigResponse = {
+  plugins: {},
+};
+```
+
+## Fields
+
+| Field                                                                | Type                                                                 | Required                                                             | Description                                                          |
+| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| `plugins`                                                            | [models.ConfigResponsePlugins](../models/config-response-plugins.md) | :heavy_check_mark:                                                   | N/A                                                                  |

package/docs/models/custom-identify-source.md

@@ -0,0 +1,19 @@
+# CustomIdentifySource
+
+## Example Usage
+
+```typescript
+import { CustomIdentifySource } from "@interfere/sdk/models";
+
+let value: CustomIdentifySource = {
+  name: "<value>",
+  type: "custom",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `name`             | *string*           | :heavy_check_mark: | N/A                |
+| `type`             | *"custom"*         | :heavy_check_mark: | N/A                |

package/docs/models/debug-ids.md

@@ -0,0 +1,14 @@
+# DebugIds
+
+## Example Usage
+
+```typescript
+import { DebugIds } from "@interfere/sdk/models";
+
+let value: DebugIds = {};
+```
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |

package/docs/models/destination-provider.md

@@ -0,0 +1,15 @@
+# DestinationProvider
+
+## Example Usage
+
+```typescript
+import { DestinationProvider } from "@interfere/sdk/models";
+
+let value: DestinationProvider = "vercel";
+```
+
+## Values
+
+```typescript
+"vercel"
+```

package/docs/models/details.md

@@ -0,0 +1,14 @@
+# Details
+
+## Example Usage
+
+```typescript
+import { Details } from "@interfere/sdk/models";
+
+let value: Details = {};
+```
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |

package/docs/models/device-browser.md

@@ -0,0 +1,18 @@
+# DeviceBrowser
+
+## Example Usage
+
+```typescript
+import { DeviceBrowser } from "@interfere/sdk/models";
+
+let value: DeviceBrowser = {};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `name`             | *string*           | :heavy_minus_sign: | N/A                |
+| `type`             | *string*           | :heavy_minus_sign: | N/A                |
+| `major`            | *string*           | :heavy_minus_sign: | N/A                |
+| `version`          | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/device-cpu.md

@@ -0,0 +1,15 @@
+# DeviceCpu
+
+## Example Usage
+
+```typescript
+import { DeviceCpu } from "@interfere/sdk/models";
+
+let value: DeviceCpu = {};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `architecture`     | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/device-engine.md

@@ -0,0 +1,16 @@
+# DeviceEngine
+
+## Example Usage
+
+```typescript
+import { DeviceEngine } from "@interfere/sdk/models";
+
+let value: DeviceEngine = {};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `version`          | *string*           | :heavy_minus_sign: | N/A                |
+| `name`             | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/device-info.md

@@ -0,0 +1,17 @@
+# DeviceInfo
+
+## Example Usage
+
+```typescript
+import { DeviceInfo } from "@interfere/sdk/models";
+
+let value: DeviceInfo = {};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `type`             | *string*           | :heavy_minus_sign: | N/A                |
+| `model`            | *string*           | :heavy_minus_sign: | N/A                |
+| `vendor`           | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/device-metadata.md

@@ -0,0 +1,29 @@
+# DeviceMetadata
+
+Device/browser metadata extracted from the user agent.
+
+## Example Usage
+
+```typescript
+import { DeviceMetadata } from "@interfere/sdk/models";
+
+let value: DeviceMetadata = {
+  browser: {},
+  cpu: {},
+  device: {},
+  engine: {},
+  os: {},
+  ua: "<value>",
+};
+```
+
+## Fields
+
+| Field                                               | Type                                                | Required                                            | Description                                         |
+| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
+| `browser`                                           | [models.DeviceBrowser](../models/device-browser.md) | :heavy_check_mark:                                  | N/A                                                 |
+| `cpu`                                               | [models.DeviceCpu](../models/device-cpu.md)         | :heavy_check_mark:                                  | N/A                                                 |
+| `device`                                            | [models.DeviceInfo](../models/device-info.md)       | :heavy_check_mark:                                  | N/A                                                 |
+| `engine`                                            | [models.DeviceEngine](../models/device-engine.md)   | :heavy_check_mark:                                  | N/A                                                 |
+| `os`                                                | [models.DeviceOs](../models/device-os.md)           | :heavy_check_mark:                                  | N/A                                                 |
+| `ua`                                                | *string*                                            | :heavy_check_mark:                                  | N/A                                                 |

package/docs/models/device-os.md

@@ -0,0 +1,16 @@
+# DeviceOs
+
+## Example Usage
+
+```typescript
+import { DeviceOs } from "@interfere/sdk/models";
+
+let value: DeviceOs = {};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `version`          | *string*           | :heavy_minus_sign: | N/A                |
+| `name`             | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/display.md

@@ -0,0 +1,20 @@
+# Display
+
+## Example Usage
+
+```typescript
+import { Display } from "@interfere/sdk/models";
+
+let value: Display = {
+  screen: {
+    height: 7531.67,
+    width: 591.54,
+  },
+};
+```
+
+## Fields
+
+| Field                                | Type                                 | Required                             | Description                          |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
+| `screen`                             | [models.Screen](../models/screen.md) | :heavy_check_mark:                   | N/A                                  |

package/docs/models/edge-context.md

@@ -0,0 +1,19 @@
+# EdgeContext
+
+Request context for the Edge runtime.
+
+## Example Usage
+
+```typescript
+import { EdgeContext } from "@interfere/sdk/models";
+
+let value: EdgeContext = {
+  runtime: "edge",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `runtime`          | *"edge"*           | :heavy_check_mark: | N/A                |

package/docs/models/envelope-context.md

@@ -0,0 +1,47 @@
+# EnvelopeContext
+
+Runtime-specific request context attached to every envelope.
+
+
+## Supported Types
+
+### `models.BrowserContext`
+
+```typescript
+const value: models.BrowserContext = {
+  runtime: "browser",
+  browser: {
+    display: {
+      screen: {
+        height: 7531.67,
+        width: 591.54,
+      },
+    },
+  },
+  device: {
+    browser: {},
+    cpu: {},
+    device: {},
+    engine: {},
+    os: {},
+    ua: "<value>",
+  },
+};
+```
+
+### `models.NextjsContext`
+
+```typescript
+const value: models.NextjsContext = {
+  runtime: "nextjs",
+};
+```
+
+### `models.EdgeContext`
+
+```typescript
+const value: models.EdgeContext = {
+  runtime: "edge",
+};
+```
+