@interfere/sdk 8.1.6 → 9.0.0

package/docs/models/envelope.md

@@ -0,0 +1,133 @@
+# Envelope
+
+A single event envelope accepted by the collector.
+
+
+## Supported Types
+
+### `models.ErrorEnvelope`
+
+```typescript
+const value: models.ErrorEnvelope = {
+  type: "error",
+  buildId: "<id>",
+  clientTs: 357344,
+  environment: "preview",
+  releaseId: "<id>",
+  runtime: "node",
+  sessionId: "3648039f-3c3a-4b4b-8c19-640ff94fb0c7",
+  uuid: "1d56e773-a120-49f8-a9dd-77decaca93ac",
+  v: 9401.22,
+  payload: {
+    exceptions: [],
+  },
+};
+```
+
+### `models.PageviewEnvelope`
+
+```typescript
+const value: models.PageviewEnvelope = {
+  type: "pageview",
+  buildId: "<id>",
+  clientTs: 423290,
+  environment: "preview",
+  releaseId: "<id>",
+  runtime: "browser",
+  sessionId: "6160c037-fae8-432e-8b8b-21a9a51bf4de",
+  uuid: "6a3ec1bd-4590-4f42-8fd8-68ab0d98b1f7",
+  v: 6873.42,
+  payload: {
+    url: "https://well-to-do-scrap.name/",
+  },
+};
+```
+
+### `models.PageleaveEnvelope`
+
+```typescript
+const value: models.PageleaveEnvelope = {
+  type: "pageleave",
+  buildId: "<id>",
+  clientTs: 614175,
+  environment: "preview",
+  releaseId: "<id>",
+  runtime: "node",
+  sessionId: "c63c303f-cebe-4617-bec0-c2cfba30cea4",
+  uuid: "efe06e21-8fee-4af5-b028-f502f43d7da6",
+  v: 2019.69,
+  payload: {
+    url: "https://growing-decongestant.biz/",
+  },
+};
+```
+
+### `models.UiEventEnvelope`
+
+```typescript
+const value: models.UiEventEnvelope = {
+  type: "ui_event",
+  buildId: "<id>",
+  clientTs: 615985,
+  environment: "production",
+  releaseId: "<id>",
+  runtime: "browser",
+  sessionId: "f662ea43-7ae3-4e28-a92a-19a8e07571d1",
+  uuid: "c7111390-2e43-4f1e-b3f8-3ffcc21e5989",
+  v: 3318.86,
+  payload: {
+    event: {
+      "key": "<value>",
+      "key1": "<value>",
+      "key2": "<value>",
+    },
+  },
+};
+```
+
+### `models.ReplayChunkEnvelope`
+
+```typescript
+const value: models.ReplayChunkEnvelope = {
+  type: "replay_chunk",
+  buildId: "<id>",
+  clientTs: 530580,
+  environment: "production",
+  releaseId: "<id>",
+  runtime: "browser",
+  sessionId: "8a694fac-31c8-4297-8f53-6282d91dab2e",
+  uuid: "5d2ad312-9e88-4161-81f1-eb6fb4d33c69",
+  v: 3168.58,
+  payload: {
+    ts: 9116.83,
+    count: 4767.38,
+    events: [],
+  },
+};
+```
+
+### `models.RageClickEnvelope`
+
+```typescript
+const value: models.RageClickEnvelope = {
+  type: "rage_click",
+  buildId: "<id>",
+  clientTs: 343821,
+  environment: "development",
+  releaseId: "<id>",
+  runtime: "edge",
+  sessionId: "cfc9b586-4b9b-499f-8862-e8b5697e3a28",
+  uuid: "6f9b8879-f75a-405a-ba94-cf3d214e7a2a",
+  v: 9600.86,
+  payload: {
+    count: 7353.82,
+    timeWindow: 2917.06,
+    selector: "<value>",
+    text: "<value>",
+    x: 2495.33,
+    y: 2.51,
+    timestamp: 7192.77,
+  },
+};
+```
+

package/docs/models/environment.md

@@ -0,0 +1,17 @@
+# Environment
+
+Deployment environment the SDK is running in.
+
+## Example Usage
+
+```typescript
+import { Environment } from "@interfere/sdk/models";
+
+let value: Environment = "preview";
+```
+
+## Values
+
+```typescript
+"development" | "preview" | "production"
+```

package/docs/models/error-envelope.md

@@ -0,0 +1,41 @@
+# ErrorEnvelope
+
+## Example Usage
+
+```typescript
+import { ErrorEnvelope } from "@interfere/sdk/models";
+
+let value: ErrorEnvelope = {
+  type: "error",
+  buildId: "<id>",
+  clientTs: 357344,
+  environment: "preview",
+  releaseId: "<id>",
+  runtime: "node",
+  sessionId: "3648039f-3c3a-4b4b-8c19-640ff94fb0c7",
+  uuid: "1d56e773-a120-49f8-a9dd-77decaca93ac",
+  v: 9401.22,
+  payload: {
+    exceptions: [],
+  },
+};
+```
+
+## Fields
+
+| Field                                                    | Type                                                     | Required                                                 | Description                                              |
+| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
+| `type`                                                   | *"error"*                                                | :heavy_check_mark:                                       | N/A                                                      |
+| `buildId`                                                | *string*                                                 | :heavy_check_mark:                                       | N/A                                                      |
+| `clientTs`                                               | *number*                                                 | :heavy_check_mark:                                       | N/A                                                      |
+| `context`                                                | *models.EnvelopeContext*                                 | :heavy_minus_sign:                                       | N/A                                                      |
+| `environment`                                            | [models.Environment](../models/environment.md)           | :heavy_check_mark:                                       | Deployment environment the SDK is running in.            |
+| `producerVersion`                                        | *string*                                                 | :heavy_minus_sign:                                       | N/A                                                      |
+| `releaseId`                                              | *string*                                                 | :heavy_check_mark:                                       | N/A                                                      |
+| `runtime`                                                | [models.RuntimeEnum](../models/runtime-enum.md)          | :heavy_check_mark:                                       | JavaScript runtime the SDK is running in.                |
+| `sdkStack`                                               | *string*[]                                               | :heavy_minus_sign:                                       | N/A                                                      |
+| `sessionId`                                              | *string*                                                 | :heavy_check_mark:                                       | N/A                                                      |
+| `sessionSource`                                          | [models.SessionSource](../models/session-source.md)      | :heavy_minus_sign:                                       | How the server resolved the sessionId for this envelope. |
+| `uuid`                                                   | *string*                                                 | :heavy_check_mark:                                       | N/A                                                      |
+| `v`                                                      | *number*                                                 | :heavy_check_mark:                                       | N/A                                                      |
+| `payload`                                                | [models.ErrorPayload](../models/error-payload.md)        | :heavy_check_mark:                                       | Payload for an error envelope.                           |

package/docs/models/error-mechanism.md

@@ -0,0 +1,22 @@
+# ErrorMechanism
+
+How the exception was captured by the SDK.
+
+## Example Usage
+
+```typescript
+import { ErrorMechanism } from "@interfere/sdk/models";
+
+let value: ErrorMechanism = {
+  type: "<value>",
+  handled: false,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `type`             | *string*           | :heavy_check_mark: | N/A                |
+| `handled`          | *boolean*          | :heavy_check_mark: | N/A                |
+| `synthetic`        | *boolean*          | :heavy_minus_sign: | N/A                |

package/docs/models/error-payload.md

@@ -0,0 +1,27 @@
+# ErrorPayload
+
+Payload for an error envelope.
+
+## Example Usage
+
+```typescript
+import { ErrorPayload } from "@interfere/sdk/models";
+
+let value: ErrorPayload = {
+  exceptions: [
+    {
+      type: "<value>",
+      value: "<value>",
+      frames: [
+        {},
+      ],
+    },
+  ],
+};
+```
+
+## Fields
+
+| Field                                        | Type                                         | Required                                     | Description                                  |
+| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
+| `exceptions`                                 | [models.Exception](../models/exception.md)[] | :heavy_check_mark:                           | N/A                                          |

package/docs/models/errors/errors-problem.md

@@ -0,0 +1,20 @@
+# ErrorsProblem
+
+Standard error envelope for 4XX / 5XX responses.
+
+## Example Usage
+
+```typescript
+import { ErrorsProblem } from "@interfere/sdk/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field                                     | Type                                      | Required                                  | Description                               |
+| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
+| `ok`                                      | *false*                                   | :heavy_minus_sign:                        | N/A                                       |
+| `message`                                 | *string*                                  | :heavy_minus_sign:                        | N/A                                       |
+| `code`                                    | *string*                                  | :heavy_minus_sign:                        | N/A                                       |
+| `details`                                 | [models.Details](../../models/details.md) | :heavy_minus_sign:                        | N/A                                       |

package/docs/models/errors/health-error.md

@@ -0,0 +1,16 @@
+# HealthError
+
+## Example Usage
+
+```typescript
+import { HealthError } from "@interfere/sdk/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `ok`               | *false*            | :heavy_minus_sign: | N/A                |
+| `message`          | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/exception.md

@@ -0,0 +1,24 @@
+# Exception
+
+A single exception in a chained error.
+
+## Example Usage
+
+```typescript
+import { Exception } from "@interfere/sdk/models";
+
+let value: Exception = {
+  type: "<value>",
+  value: "<value>",
+  frames: [],
+};
+```
+
+## Fields
+
+| Field                                                 | Type                                                  | Required                                              | Description                                           |
+| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
+| `type`                                                | *string*                                              | :heavy_check_mark:                                    | N/A                                                   |
+| `value`                                               | *string*                                              | :heavy_check_mark:                                    | N/A                                                   |
+| `mechanism`                                           | [models.ErrorMechanism](../models/error-mechanism.md) | :heavy_minus_sign:                                    | N/A                                                   |
+| `frames`                                              | [models.Frame](../models/frame.md)[]                  | :heavy_check_mark:                                    | N/A                                                   |

package/docs/models/file-t.md

@@ -0,0 +1,16 @@
+# FileT
+
+## Example Usage
+
+```typescript
+import { FileT } from "@interfere/sdk/models";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field                        | Type                         | Required                     | Description                  |
+| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
+| `fileName`                   | *string*                     | :heavy_check_mark:           | N/A                          |
+| `content`                    | *ReadableStream<Uint8Array>* | :heavy_check_mark:           | N/A                          |

package/docs/models/frame.md

@@ -0,0 +1,22 @@
+# Frame
+
+A single stack frame captured from an error.
+
+## Example Usage
+
+```typescript
+import { Frame } from "@interfere/sdk/models";
+
+let value: Frame = {};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `fileName`         | *string*           | :heavy_minus_sign: | N/A                |
+| `functionName`     | *string*           | :heavy_minus_sign: | N/A                |
+| `lineNumber`       | *number*           | :heavy_minus_sign: | N/A                |
+| `columnNumber`     | *number*           | :heavy_minus_sign: | N/A                |
+| `source`           | *string*           | :heavy_minus_sign: | N/A                |
+| `debugId`          | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/github-release-source-provider.md

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

package/docs/models/github-release-source.md

@@ -0,0 +1,25 @@
+# GithubReleaseSource
+
+Release source metadata coming from GitHub.
+
+## Example Usage
+
+```typescript
+import { GithubReleaseSource } from "@interfere/sdk/models";
+
+let value: GithubReleaseSource = {
+  provider: "github",
+  commitMessage: "<value>",
+  branch: "<value>",
+  commitSha: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                             | Type                                                                              | Required                                                                          | Description                                                                       |
+| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
+| `provider`                                                                        | [models.GithubReleaseSourceProvider](../models/github-release-source-provider.md) | :heavy_check_mark:                                                                | N/A                                                                               |
+| `commitMessage`                                                                   | *string*                                                                          | :heavy_check_mark:                                                                | N/A                                                                               |
+| `branch`                                                                          | *string*                                                                          | :heavy_check_mark:                                                                | N/A                                                                               |
+| `commitSha`                                                                       | *string*                                                                          | :heavy_check_mark:                                                                | N/A                                                                               |

package/docs/models/hashes.md

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

package/docs/models/health-ok.md

@@ -0,0 +1,17 @@
+# HealthOk
+
+## Example Usage
+
+```typescript
+import { HealthOk } from "@interfere/sdk/models";
+
+let value: HealthOk = {
+  status: "ok",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `status`           | *"ok"*             | :heavy_check_mark: | N/A                |

package/docs/models/identify-source.md

@@ -0,0 +1,34 @@
+# IdentifySource
+
+Auth provider that surfaced this identification.
+
+
+## Supported Types
+
+### `models.ClerkIdentifySource`
+
+```typescript
+const value: models.ClerkIdentifySource = {
+  name: "Clerk",
+  type: "clerk",
+};
+```
+
+### `models.Auth0IdentifySource`
+
+```typescript
+const value: models.Auth0IdentifySource = {
+  name: "Auth0",
+  type: "auth0",
+};
+```
+
+### `models.CustomIdentifySource`
+
+```typescript
+const value: models.CustomIdentifySource = {
+  name: "<value>",
+  type: "custom",
+};
+```
+

package/docs/models/ingest-response.md

@@ -0,0 +1,19 @@
+# IngestResponse
+
+## Example Usage
+
+```typescript
+import { IngestResponse } from "@interfere/sdk/models";
+
+let value: IngestResponse = {
+  ok: true,
+  received: 3981.01,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `ok`               | *boolean*          | :heavy_check_mark: | N/A                |
+| `received`         | *number*           | :heavy_check_mark: | N/A                |

package/docs/models/nextjs-context.md

@@ -0,0 +1,28 @@
+# NextjsContext
+
+Request context for the Next.js runtime.
+
+## Example Usage
+
+```typescript
+import { NextjsContext } from "@interfere/sdk/models";
+
+let value: NextjsContext = {
+  runtime: "nextjs",
+};
+```
+
+## Fields
+
+| Field                                                     | Type                                                      | Required                                                  | Description                                               |
+| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
+| `errorDigest`                                             | *string*                                                  | :heavy_minus_sign:                                        | N/A                                                       |
+| `renderSource`                                            | [models.RenderSource](../models/render-source.md)         | :heavy_minus_sign:                                        | N/A                                                       |
+| `renderType`                                              | [models.RenderType](../models/render-type.md)             | :heavy_minus_sign:                                        | N/A                                                       |
+| `requestMethod`                                           | *string*                                                  | :heavy_minus_sign:                                        | N/A                                                       |
+| `requestPath`                                             | *string*                                                  | :heavy_minus_sign:                                        | N/A                                                       |
+| `revalidateReason`                                        | [models.RevalidateReason](../models/revalidate-reason.md) | :heavy_minus_sign:                                        | N/A                                                       |
+| `routePath`                                               | *string*                                                  | :heavy_minus_sign:                                        | N/A                                                       |
+| `routeType`                                               | [models.RouteType](../models/route-type.md)               | :heavy_minus_sign:                                        | N/A                                                       |
+| `routerKind`                                              | [models.RouterKind](../models/router-kind.md)             | :heavy_minus_sign:                                        | N/A                                                       |
+| `runtime`                                                 | *"nextjs"*                                                | :heavy_check_mark:                                        | N/A                                                       |

package/docs/models/operations/report-telemetry-request.md

@@ -0,0 +1,27 @@
+# ReportTelemetryRequest
+
+## Example Usage
+
+```typescript
+import { ReportTelemetryRequest } from "@interfere/sdk/models/operations";
+
+let value: ReportTelemetryRequest = {
+  releaseSlug: "<value>",
+  body: {
+    discover: 6639.05,
+    createRelease: 4343.39,
+    upload: 1245.32,
+    cleanup: 5139.13,
+    total: 241.62,
+    fileCount: 6194.53,
+    totalBytes: 1711.4,
+  },
+};
+```
+
+## Fields
+
+| Field                                                                         | Type                                                                          | Required                                                                      | Description                                                                   |
+| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
+| `releaseSlug`                                                                 | *string*                                                                      | :heavy_check_mark:                                                            | N/A                                                                           |
+| `body`                                                                        | [models.ReleasesTelemetryRequest](../../models/releases-telemetry-request.md) | :heavy_check_mark:                                                            | Timings and counters reported after a source-map upload.                      |

package/docs/models/operations/upload-source-maps-multipart-request.md

@@ -0,0 +1,28 @@
+# UploadSourceMapsMultipartRequest
+
+## Example Usage
+
+```typescript
+import { UploadSourceMapsMultipartRequest } from "@interfere/sdk/models/operations";
+import { openAsBlob } from "node:fs";
+
+let value: UploadSourceMapsMultipartRequest = {
+  releaseSlug: "<value>",
+  body: {
+    files: [
+      await openAsBlob("example.file"),
+    ],
+    metadata: {
+      sourceMapToGenerated: {},
+      hashes: {},
+    },
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                           | Type                                                                                            | Required                                                                                        | Description                                                                                     |
+| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
+| `releaseSlug`                                                                                   | *string*                                                                                        | :heavy_check_mark:                                                                              | N/A                                                                                             |
+| `body`                                                                                          | [models.ReleasesUploadSourceMapsRequest2](../../models/releases-upload-source-maps-request2.md) | :heavy_check_mark:                                                                              | Multipart body for uploading source maps for a release.                                         |

package/docs/models/operations/upload-source-maps-request.md

@@ -0,0 +1,29 @@
+# UploadSourceMapsRequest
+
+## Example Usage
+
+```typescript
+import { UploadSourceMapsRequest } from "@interfere/sdk/models/operations";
+
+let value: UploadSourceMapsRequest = {
+  releaseSlug: "<value>",
+  body: {
+    files: [
+      new TextEncoder().encode("0xEc27352C82"),
+      new TextEncoder().encode("0xf33b24fCe0"),
+      new TextEncoder().encode("0xCBe4cfE101"),
+    ],
+    metadata: {
+      sourceMapToGenerated: {},
+      hashes: {},
+    },
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                           | Type                                                                                            | Required                                                                                        | Description                                                                                     |
+| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
+| `releaseSlug`                                                                                   | *string*                                                                                        | :heavy_check_mark:                                                                              | N/A                                                                                             |
+| `body`                                                                                          | [models.ReleasesUploadSourceMapsRequest1](../../models/releases-upload-source-maps-request1.md) | :heavy_check_mark:                                                                              | Multipart body for uploading source maps for a release.                                         |

package/docs/models/org-ref.md

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

package/docs/models/org.md

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