@interfere/sdk 8.1.2 → 9.0.0

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",
+};
+```
+

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                |