@interfere/sdk 8.1.6 → 9.0.0

package/docs/models/replay-chunk-envelope.md

@@ -0,0 +1,43 @@
+# ReplayChunkEnvelope
+
+## Example Usage
+
+```typescript
+import { ReplayChunkEnvelope } from "@interfere/sdk/models";
+
+let value: 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: [],
+  },
+};
+```
+
+## Fields
+
+| Field                                                          | Type                                                           | Required                                                       | Description                                                    |
+| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
+| `type`                                                         | *"replay_chunk"*                                               | :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.ReplayChunkPayload](../models/replay-chunk-payload.md) | :heavy_check_mark:                                             | Payload for a replay-chunk envelope.                           |

package/docs/models/replay-chunk-payload.md

@@ -0,0 +1,28 @@
+# ReplayChunkPayload
+
+Payload for a replay-chunk envelope.
+
+## Example Usage
+
+```typescript
+import { ReplayChunkPayload } from "@interfere/sdk/models";
+
+let value: ReplayChunkPayload = {
+  ts: 294.31,
+  count: 6752.13,
+  events: [
+    "<value 1>",
+    "<value 2>",
+  ],
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `ts`               | *number*           | :heavy_check_mark: | N/A                |
+| `count`            | *number*           | :heavy_check_mark: | N/A                |
+| `events`           | *string*[]         | :heavy_check_mark: | N/A                |
+| `firstEventTs`     | *number*           | :heavy_minus_sign: | N/A                |
+| `lastEventTs`      | *number*           | :heavy_minus_sign: | N/A                |

package/docs/models/revalidate-reason.md

@@ -0,0 +1,15 @@
+# RevalidateReason
+
+## Example Usage
+
+```typescript
+import { RevalidateReason } from "@interfere/sdk/models";
+
+let value: RevalidateReason = "on-demand";
+```
+
+## Values
+
+```typescript
+"on-demand" | "stale"
+```

package/docs/models/route-type.md

@@ -0,0 +1,15 @@
+# RouteType
+
+## Example Usage
+
+```typescript
+import { RouteType } from "@interfere/sdk/models";
+
+let value: RouteType = "proxy";
+```
+
+## Values
+
+```typescript
+"render" | "route" | "action" | "middleware" | "proxy"
+```

package/docs/models/router-kind.md

@@ -0,0 +1,15 @@
+# RouterKind
+
+## Example Usage
+
+```typescript
+import { RouterKind } from "@interfere/sdk/models";
+
+let value: RouterKind = "Pages Router";
+```
+
+## Values
+
+```typescript
+"Pages Router" | "App Router"
+```

package/docs/models/runtime-enum.md

@@ -0,0 +1,17 @@
+# RuntimeEnum
+
+JavaScript runtime the SDK is running in.
+
+## Example Usage
+
+```typescript
+import { RuntimeEnum } from "@interfere/sdk/models";
+
+let value: RuntimeEnum = "node";
+```
+
+## Values
+
+```typescript
+"browser" | "node" | "edge"
+```

package/docs/models/screen.md

@@ -0,0 +1,20 @@
+# Screen
+
+## Example Usage
+
+```typescript
+import { Screen } from "@interfere/sdk/models";
+
+let value: Screen = {
+  height: 7975.95,
+  width: 513.05,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `height`           | *number*           | :heavy_check_mark: | N/A                |
+| `width`            | *number*           | :heavy_check_mark: | N/A                |
+| `orientation`      | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/sdk-config.md

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

package/docs/models/session-create-request.md

@@ -0,0 +1,22 @@
+# SessionCreateRequest
+
+Request body for creating a session.
+
+## Example Usage
+
+```typescript
+import { SessionCreateRequest } from "@interfere/sdk/models";
+
+let value: SessionCreateRequest = {
+  sessionId: "<id>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `sessionId`        | *string*           | :heavy_check_mark: | N/A                |
+| `deviceId`         | *string*           | :heavy_minus_sign: | N/A                |
+| `fpHash`           | *string*           | :heavy_minus_sign: | N/A                |
+| `visitorId`        | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/session-identify-request.md

@@ -0,0 +1,34 @@
+# SessionIdentifyRequest
+
+Request body for identifying the end user associated with a session.
+
+## Example Usage
+
+```typescript
+import { SessionIdentifyRequest } from "@interfere/sdk/models";
+
+let value: SessionIdentifyRequest = {
+  sessionId: "<id>",
+  identifier: "<value>",
+  source: {
+    name: "Clerk",
+    type: "clerk",
+  },
+};
+```
+
+## Fields
+
+| Field                                            | Type                                             | Required                                         | Description                                      |
+| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
+| `name`                                           | *string*                                         | :heavy_minus_sign:                               | N/A                                              |
+| `sessionId`                                      | *string*                                         | :heavy_check_mark:                               | N/A                                              |
+| `deviceId`                                       | *string*                                         | :heavy_minus_sign:                               | N/A                                              |
+| `fpHash`                                         | *string*                                         | :heavy_minus_sign:                               | N/A                                              |
+| `visitorId`                                      | *string*                                         | :heavy_minus_sign:                               | N/A                                              |
+| `avatar`                                         | *string*                                         | :heavy_minus_sign:                               | N/A                                              |
+| `email`                                          | *string*                                         | :heavy_minus_sign:                               | N/A                                              |
+| `identifier`                                     | *string*                                         | :heavy_check_mark:                               | N/A                                              |
+| `source`                                         | *models.IdentifySource*                          | :heavy_check_mark:                               | Auth provider that surfaced this identification. |
+| `traits`                                         | Record<string, *any*>                            | :heavy_minus_sign:                               | N/A                                              |
+| `country`                                        | *string*                                         | :heavy_minus_sign:                               | N/A                                              |

package/docs/models/session-response.md

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

package/docs/models/session-source.md

@@ -0,0 +1,17 @@
+# SessionSource
+
+How the server resolved the sessionId for this envelope.
+
+## Example Usage
+
+```typescript
+import { SessionSource } from "@interfere/sdk/models";
+
+let value: SessionSource = "client";
+```
+
+## Values
+
+```typescript
+"header" | "async_context" | "fallback" | "client"
+```

package/docs/models/source-map-to-generated.md

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

package/docs/models/source-provider.md

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

package/docs/models/surface-ref.md

@@ -0,0 +1,19 @@
+# SurfaceRef
+
+## Example Usage
+
+```typescript
+import { SurfaceRef } from "@interfere/sdk/models";
+
+let value: SurfaceRef = {
+  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/surface.md

@@ -0,0 +1,27 @@
+# Surface
+
+## Example Usage
+
+```typescript
+import { Surface } from "@interfere/sdk/models";
+
+let value: Surface = {
+  id: "<id>",
+  slug: "<value>",
+  allowDirectIngestion: false,
+  sourceProvider: "github",
+  destinationProvider: "vercel",
+  sdkConfig: {},
+};
+```
+
+## Fields
+
+| Field                                                           | Type                                                            | Required                                                        | Description                                                     |
+| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
+| `id`                                                            | *string*                                                        | :heavy_check_mark:                                              | N/A                                                             |
+| `slug`                                                          | *string*                                                        | :heavy_check_mark:                                              | N/A                                                             |
+| `allowDirectIngestion`                                          | *boolean*                                                       | :heavy_check_mark:                                              | N/A                                                             |
+| `sourceProvider`                                                | [models.SourceProvider](../models/source-provider.md)           | :heavy_check_mark:                                              | N/A                                                             |
+| `destinationProvider`                                           | [models.DestinationProvider](../models/destination-provider.md) | :heavy_check_mark:                                              | N/A                                                             |
+| `sdkConfig`                                                     | [models.SDKConfig](../models/sdk-config.md)                     | :heavy_check_mark:                                              | N/A                                                             |

package/docs/models/ui-event-envelope.md

@@ -0,0 +1,45 @@
+# UiEventEnvelope
+
+## Example Usage
+
+```typescript
+import { UiEventEnvelope } from "@interfere/sdk/models";
+
+let value: 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>",
+    },
+  },
+};
+```
+
+## Fields
+
+| Field                                                    | Type                                                     | Required                                                 | Description                                              |
+| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
+| `type`                                                   | *"ui_event"*                                             | :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.UiEventPayload](../models/ui-event-payload.md)   | :heavy_check_mark:                                       | Payload for a UI event envelope.                         |

package/docs/models/ui-event-payload.md

@@ -0,0 +1,23 @@
+# UiEventPayload
+
+Payload for a UI event envelope.
+
+## Example Usage
+
+```typescript
+import { UiEventPayload } from "@interfere/sdk/models";
+
+let value: UiEventPayload = {
+  event: {
+    "key": "<value>",
+    "key1": "<value>",
+    "key2": "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                 | Type                  | Required              | Description           |
+| --------------------- | --------------------- | --------------------- | --------------------- |
+| `event`               | Record<string, *any*> | :heavy_check_mark:    | N/A                   |

package/docs/models/upload-source-maps-metadata.md

@@ -0,0 +1,23 @@
+# UploadSourceMapsMetadata
+
+Metadata attached alongside uploaded source map files.
+
+## Example Usage
+
+```typescript
+import { UploadSourceMapsMetadata } from "@interfere/sdk/models";
+
+let value: UploadSourceMapsMetadata = {
+  sourceMapToGenerated: {},
+  hashes: {},
+};
+```
+
+## Fields
+
+| Field                                                               | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `sourceMapToGenerated`                                              | [models.SourceMapToGenerated](../models/source-map-to-generated.md) | :heavy_check_mark:                                                  | N/A                                                                 |
+| `hashes`                                                            | [models.Hashes](../models/hashes.md)                                | :heavy_check_mark:                                                  | N/A                                                                 |
+| `debugIds`                                                          | [models.DebugIds](../models/debug-ids.md)                           | :heavy_minus_sign:                                                  | N/A                                                                 |
+| `sourceFileCount`                                                   | *number*                                                            | :heavy_minus_sign:                                                  | N/A                                                                 |

package/docs/models/vercel-release-destination-provider.md

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

package/docs/models/vercel-release-destination.md

@@ -0,0 +1,31 @@
+# VercelReleaseDestination
+
+Release destination metadata for a Vercel deployment.
+
+## Example Usage
+
+```typescript
+import { VercelReleaseDestination } from "@interfere/sdk/models";
+
+let value: VercelReleaseDestination = {
+  provider: "vercel",
+  destinationReleaseId: "<id>",
+  environment: "<value>",
+  deploymentId: "<id>",
+  deploymentUrl: "https://front-kinase.biz",
+  environmentName: null,
+  environmentTarget: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                       | Type                                                                                        | Required                                                                                    | Description                                                                                 |
+| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
+| `provider`                                                                                  | [models.VercelReleaseDestinationProvider](../models/vercel-release-destination-provider.md) | :heavy_check_mark:                                                                          | N/A                                                                                         |
+| `destinationReleaseId`                                                                      | *string*                                                                                    | :heavy_check_mark:                                                                          | N/A                                                                                         |
+| `environment`                                                                               | *string*                                                                                    | :heavy_check_mark:                                                                          | N/A                                                                                         |
+| `deploymentId`                                                                              | *string*                                                                                    | :heavy_check_mark:                                                                          | N/A                                                                                         |
+| `deploymentUrl`                                                                             | *string*                                                                                    | :heavy_check_mark:                                                                          | N/A                                                                                         |
+| `environmentName`                                                                           | *string*                                                                                    | :heavy_check_mark:                                                                          | N/A                                                                                         |
+| `environmentTarget`                                                                         | *string*                                                                                    | :heavy_check_mark:                                                                          | N/A                                                                                         |

package/docs/sdks/config/README.md

@@ -0,0 +1,72 @@
+# Config
+
+## Overview
+
+SDK configuration
+
+### Available Operations
+
+* [get](#get)
+
+## get
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="getConfig" method="get" path="/v1/config/" -->
+```typescript
+import { Interfere } from "@interfere/sdk";
+
+const interfere = new Interfere();
+
+async function run() {
+  const result = await interfere.config.get();
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { InterfereCore } from "@interfere/sdk/core.js";
+import { configGet } from "@interfere/sdk/funcs/config-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 configGet(interfere);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("configGet failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.ConfigResponse](../../models/config-response.md)\>**
+
+### Errors
+
+| Error Type            | Status Code           | Content Type          |
+| --------------------- | --------------------- | --------------------- |
+| errors.ErrorsProblem  | 401                   | application/json      |
+| errors.InterfereError | 4XX, 5XX              | \*/\*                 |