Add signalwire-typescript-web beta docs (WIP)

fern/docs.yml

@@ -67,6 +67,9 @@ products:
     icon: fa-regular fa-browser
     subtitle: Build voice, video and chat applications for the browser
     versions:
+      - display-name: v4
+        path: products/browser-sdk/versions/v4.yml
+        availability: beta
       - display-name: v3
         path: products/browser-sdk/versions/latest.yml
         availability: stable
@@ -174,7 +177,6 @@ css:
   - brand-overrides.css
   - styles.css
 
-
 redirects:
   - source: /docs/agents-sdk
     destination: /docs/server-sdks

fern/fern.config.json

@@ -1,4 +1,4 @@
 {
   "organization": "signalwire",
-  "version": "4.67.1"
+  "version": "4.106.1"
 }

fern/products/browser-sdk/pages/v4/reference/classes/Address.md

@@ -0,0 +1,84 @@
+# Class: Address
+
+Defined in: [core/entities/Address.ts:31](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/core/entities/Address.ts#L31)
+
+Represents a contact or room in the directory.
+
+Provides identity metadata, conversation history, text messaging,
+and activity state for an address entry.
+
+## Extends
+
+- `Destroyable`
+
+## Constructors
+
+### Constructor
+
+> **new Address**(`addressId`, `conversationManager`, `addressProvider`): `Address`
+
+Defined in: [core/entities/Address.ts:67](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/core/entities/Address.ts#L67)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `addressId` | `string` |
+| `conversationManager` | `ConversationsProvider` |
+| `addressProvider` | `AddressProvider`\<`Address`\> |
+
+#### Returns
+
+`Address`
+
+#### Overrides
+
+`Destroyable.constructor`
+
+## Properties
+
+| Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
+| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
+| <a id="_destroyed"></a> `_destroyed$` | `protected` | `Subject`\<`void`\> | `undefined` | - | `Destroyable._destroyed$` | [behaviors/Destroyable.ts:8](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/behaviors/Destroyable.ts#L8) |
+| <a id="history"></a> `history$` | `public` | `Observable`\<`EntityCollectionTransformed`\<`GetConversationMessageResponse`, [`AddressHistory`](../interfaces/AddressHistory.md)\<`Address`\>\> \| `undefined`\> | `undefined` | Observable of call history for this address. Lazily loads conversation data. | - | [core/entities/Address.ts:49](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/core/entities/Address.ts#L49) |
+| <a id="subjects"></a> `subjects` | `protected` | `Subject`\<`unknown`\>[] | `[]` | - | `Destroyable.subjects` | [behaviors/Destroyable.ts:7](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/behaviors/Destroyable.ts#L7) |
+| <a id="subscriptions"></a> `subscriptions` | `protected` | `Subscription`[] | `[]` | - | `Destroyable.subscriptions` | [behaviors/Destroyable.ts:6](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/behaviors/Destroyable.ts#L6) |
+| <a id="textmessages"></a> `textMessages$` | `public` | `Observable`\<`EntityCollectionTransformed`\<`GetConversationMessageResponse`, [`TextMessage`](../interfaces/TextMessage.md)\<`Address`\>\> \| `undefined`\> | `undefined` | Observable of text messages for this address. Lazily loads conversation data. | - | [core/entities/Address.ts:43](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/core/entities/Address.ts#L43) |
+
+## Accessors
+
+- [`activity`](./Address/activity.md)
+- [`activity$`](./Address/activity$.md)
+- [`channels`](./Address/channels.md)
+- [`channels$`](./Address/channels$.md)
+- [`coverUrl`](./Address/coverUrl.md)
+- [`coverUrl$`](./Address/coverUrl$.md)
+- [`createdAt`](./Address/createdAt.md)
+- [`defaultChannel`](./Address/defaultChannel.md)
+- [`destroyed$`](./Address/destroyed$.md)
+- [`displayName`](./Address/displayName.md)
+- [`displayName$`](./Address/displayName$.md)
+- [`history`](./Address/history.md)
+- [`id`](./Address/id.md)
+- [`locked`](./Address/locked.md)
+- [`locked$`](./Address/locked$.md)
+- [`name`](./Address/name.md)
+- [`previewUrl`](./Address/previewUrl.md)
+- [`previewUrl$`](./Address/previewUrl$.md)
+- [`resourceId`](./Address/resourceId.md)
+- [`resourceId$`](./Address/resourceId$.md)
+- [`textMessage`](./Address/textMessage.md)
+- [`type`](./Address/type.md)
+- [`type$`](./Address/type$.md)
+
+## Methods
+
+- [`cachedObservable`](./Address/cachedObservable.md)
+- [`createBehaviorSubject`](./Address/createBehaviorSubject.md)
+- [`createReplaySubject`](./Address/createReplaySubject.md)
+- [`createSubject`](./Address/createSubject.md)
+- [`deferEmission`](./Address/deferEmission.md)
+- [`destroy`](./Address/destroy.md)
+- [`publicCachedObservable`](./Address/publicCachedObservable.md)
+- [`sendText`](./Address/sendText.md)
+- [`subscribeTo`](./Address/subscribeTo.md)

fern/products/browser-sdk/pages/v4/reference/classes/Address/activity$.md

@@ -0,0 +1,17 @@
+# activity$
+
+#### Get Signature
+
+> **get** **activity$**(): `Observable`\<[`CallState`](../../interfaces/CallState.md)[]\>
+
+Defined in: [core/entities/Address.ts:340](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/core/entities/Address.ts#L340)
+
+Observable of active call states for this address.
+
+##### Throws
+
+Requires presence support.
+
+##### Returns
+
+`Observable`\<[`CallState`](../../interfaces/CallState.md)[]\>

fern/products/browser-sdk/pages/v4/reference/classes/Address/activity.md

@@ -0,0 +1,17 @@
+# activity
+
+#### Get Signature
+
+> **get** **activity**(): [`CallState`](../../interfaces/CallState.md)[]
+
+Defined in: [core/entities/Address.ts:346](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/core/entities/Address.ts#L346)
+
+Active call states for this address.
+
+##### Throws
+
+Requires presence support.
+
+##### Returns
+
+[`CallState`](../../interfaces/CallState.md)[]

fern/products/browser-sdk/pages/v4/reference/classes/Address/cachedObservable.md

@@ -0,0 +1,26 @@
+# cachedObservable
+
+> `protected` **cachedObservable**\<`T`\>(`key`, `factory`): `Observable`\<`T`\>
+
+Defined in: [behaviors/Destroyable.ts:19](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/behaviors/Destroyable.ts#L19)
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+| `factory` | () => `Observable`\<`T`\> |
+
+#### Returns
+
+`Observable`\<`T`\>
+
+#### Inherited from
+
+`Destroyable.cachedObservable`

fern/products/browser-sdk/pages/v4/reference/classes/Address/channels$.md

@@ -0,0 +1,13 @@
+# channels$
+
+#### Get Signature
+
+> **get** **channels$**(): `Observable`\<\{ `audio?`: `string`; `messaging?`: `string`; `video?`: `string`; \}\>
+
+Defined in: [core/entities/Address.ts:213](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/core/entities/Address.ts#L213)
+
+Observable of available communication channels (audio, video, messaging).
+
+##### Returns
+
+`Observable`\<\{ `audio?`: `string`; `messaging?`: `string`; `video?`: `string`; \}\>

fern/products/browser-sdk/pages/v4/reference/classes/Address/channels.md

@@ -0,0 +1,25 @@
+# channels
+
+#### Get Signature
+
+> **get** **channels**(): `object`
+
+Defined in: [core/entities/Address.ts:229](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/core/entities/Address.ts#L229)
+
+Available communication channels.
+
+##### Returns
+
+`object`
+
+###### audio?
+
+> `optional` **audio?**: `string`
+
+###### messaging?
+
+> `optional` **messaging?**: `string`
+
+###### video?
+
+> `optional` **video?**: `string`

fern/products/browser-sdk/pages/v4/reference/classes/Address/coverUrl$.md

@@ -0,0 +1,13 @@
+# coverUrl$
+
+#### Get Signature
+
+> **get** **coverUrl$**(): `Observable`\<`string` \| `undefined`\>
+
+Defined in: [core/entities/Address.ts:153](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/core/entities/Address.ts#L153)
+
+Observable of the cover image URL.
+
+##### Returns
+
+`Observable`\<`string` \| `undefined`\>

fern/products/browser-sdk/pages/v4/reference/classes/Address/coverUrl.md

@@ -0,0 +1,13 @@
+# coverUrl
+
+#### Get Signature
+
+> **get** **coverUrl**(): `string` \| `undefined`
+
+Defined in: [core/entities/Address.ts:165](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/core/entities/Address.ts#L165)
+
+Cover image URL.
+
+##### Returns
+
+`string` \| `undefined`

fern/products/browser-sdk/pages/v4/reference/classes/Address/createBehaviorSubject.md

@@ -0,0 +1,25 @@
+# createBehaviorSubject
+
+> `protected` **createBehaviorSubject**\<`T`\>(`initialValue`): `BehaviorSubject`\<`T`\>
+
+Defined in: [behaviors/Destroyable.ts:85](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/behaviors/Destroyable.ts#L85)
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `initialValue` | `T` |
+
+#### Returns
+
+`BehaviorSubject`\<`T`\>
+
+#### Inherited from
+
+`Destroyable.createBehaviorSubject`

fern/products/browser-sdk/pages/v4/reference/classes/Address/createReplaySubject.md

@@ -0,0 +1,26 @@
+# createReplaySubject
+
+> `protected` **createReplaySubject**\<`T`\>(`bufferSize?`, `windowTime?`): `ReplaySubject`\<`T`\>
+
+Defined in: [behaviors/Destroyable.ts:79](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/behaviors/Destroyable.ts#L79)
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `bufferSize?` | `number` |
+| `windowTime?` | `number` |
+
+#### Returns
+
+`ReplaySubject`\<`T`\>
+
+#### Inherited from
+
+`Destroyable.createReplaySubject`

fern/products/browser-sdk/pages/v4/reference/classes/Address/createSubject.md

@@ -0,0 +1,19 @@
+# createSubject
+
+> `protected` **createSubject**\<`T`\>(): `Subject`\<`T`\>
+
+Defined in: [behaviors/Destroyable.ts:73](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/behaviors/Destroyable.ts#L73)
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+#### Returns
+
+`Subject`\<`T`\>
+
+#### Inherited from
+
+`Destroyable.createSubject`

fern/products/browser-sdk/pages/v4/reference/classes/Address/createdAt.md

@@ -0,0 +1,13 @@
+# createdAt
+
+#### Get Signature
+
+> **get** **createdAt**(): `string`
+
+Defined in: [core/entities/Address.ts:102](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/core/entities/Address.ts#L102)
+
+ISO timestamp of when the address was created.
+
+##### Returns
+
+`string`

fern/products/browser-sdk/pages/v4/reference/classes/Address/defaultChannel.md

@@ -0,0 +1,13 @@
+# defaultChannel
+
+#### Get Signature
+
+> **get** **defaultChannel**(): `string` \| `undefined`
+
+Defined in: [core/entities/Address.ts:110](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/core/entities/Address.ts#L110)
+
+Default communication channel URI (video for rooms, audio otherwise).
+
+##### Returns
+
+`string` \| `undefined`

fern/products/browser-sdk/pages/v4/reference/classes/Address/deferEmission.md

@@ -0,0 +1,32 @@
+# deferEmission
+
+> `protected` **deferEmission**\<`T`\>(`observable`): `Observable`\<`T`\>
+
+Defined in: [behaviors/Destroyable.ts:61](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/behaviors/Destroyable.ts#L61)
+
+Wraps an observable so emissions are deferred to the microtask queue.
+
+Use ONLY for public-facing getters that expose a subject via
+`.asObservable()` without going through `cachedObservable`.
+
+Do NOT use for observables consumed internally by the SDK.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `observable` | `Observable`\<`T`\> |
+
+#### Returns
+
+`Observable`\<`T`\>
+
+#### Inherited from
+
+`Destroyable.deferEmission`

fern/products/browser-sdk/pages/v4/reference/classes/Address/destroy.md

@@ -0,0 +1,13 @@
+# destroy
+
+> **destroy**(): `void`
+
+Defined in: [behaviors/Destroyable.ts:11](https://github.com/signalwire/browser-sdk/blob/25e5ff424d770291cfeb3801743816b995511140/packages/main/src/behaviors/Destroyable.ts#L11)
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`Destroyable.destroy`