@signalwire/js 3.8.0 → 3.9.0

package/src/RoomSession.docs.ts

@@ -1,14 +1,15 @@
-import type { Rooms } from '@signalwire/core'
+import type { AssertSameType, VideoPositions, Rooms } from '@signalwire/core'
 import { BaseRoomSession } from './BaseRoomSession'
 import { RoomSessionDevice } from './RoomSessionDevice'
 import { RoomSessionScreenShare } from './RoomSessionScreenShare'
+import { StartScreenShareOptions } from './utils/interfaces'
 
 export interface RoomSessionDocs<T>
   extends RoomMemberMethodsInterfaceDocs,
     RoomControlMethodsInterfaceDocs,
     RoomLayoutMethodsInterface,
     RoomSessionConstructorDocs<T>,
-    Pick<BaseRoomSession<T>, 'on' | 'off' | 'once'> {
+    Pick<BaseRoomSession<T>, 'on' | 'off' | 'once' | 'removeAllListeners'> {
   /** @internal */
   stopOutboundAudio(): void
   /** @internal */
@@ -116,17 +117,26 @@ export interface RoomSessionDocs<T>
    *
    * @example Sharing the screen together with the associated audio:
    * ```typescript
-   * await roomSession.startScreenShare({audio: true, video: true})
+   * await roomSession.startScreenShare({ audio: true, video: true })
    * ```
    */
-  startScreenShare(opts: {
-    /** Whether the screen share object should automatically join the room */
-    autoJoin?: boolean
-    /** Audio constraints to use when joining the room. Default: `true`. */
-    audio?: MediaStreamConstraints['audio']
-    /** Video constraints to use when joining the room. Default: `true`. */
-    video?: MediaStreamConstraints['video']
-  }): Promise<RoomSessionScreenShare>
+  startScreenShare(
+    opts: AssertSameType<
+      StartScreenShareOptions,
+      {
+        /** Whether the screen share object should automatically join the room. Default: `true`. */
+        autoJoin?: boolean
+        /** Audio constraints to use when joining the room. Default: `false`. */
+        audio?: MediaStreamConstraints['audio']
+        /** Video constraints to use when joining the room. Default: `true`. */
+        video?: MediaStreamConstraints['video']
+        /** Layout to use to use when joining the room. */
+        layout?: string
+        /** Automatically set positions when screen share joins the room. */
+        positions?: VideoPositions
+      }
+    >
+  ): Promise<RoomSessionScreenShare>
 
   /**
    * Adds a camera device to the room. Using this method, a user can stream
@@ -839,6 +849,10 @@ interface RoomControlMethodsInterfaceDocs {
   play(params: {
     url: string
     volume?: number
+    // positions?: Record<
+    //   string,
+    //   'self' | 'standard' | `standard-${number}` | 'off-canvas'
+    // >
   }): Promise<Rooms.RoomSessionPlayback>
 }
 
@@ -887,7 +901,32 @@ interface RoomLayoutMethodsInterface {
    * await room.setLayout({name: "6x6"})
    * ```
    */
-  setLayout(params: { name: string }): Rooms.SetLayout
+  setLayout(params: {
+    name: string
+    // positions?: Record<
+    //   string,
+    //   'self' | 'standard' | `standard-${number}` | 'off-canvas'
+    // >
+  }): Rooms.SetLayout
+
+  // setPositions(params: {
+  //   positions: Record<
+  //     string,
+  //     | 'self'
+  //     | 'standard'
+  //     | `standard-${number}`
+  //     | 'off-canvas'
+  //   >
+  // }): Promise<void>
+
+  // setMemberPosition(params: {
+  //   memberId?: string
+  //   position:
+  //     | 'self'
+  //     | 'standard'
+  //     | `standard-${number}`
+  //     | 'off-canvas'
+  // }): Promise<void>
 }
 
 /**
@@ -1098,7 +1137,7 @@ export interface RoomSessionEvents {
    * The set of members or one or more properties of a member have changed. The
    * event handler receives an object `e` with the updated, full list of members in
    * the room as `e.members`.
-   * 
+   *
    * @event
    */
   'memberList.updated': undefined

package/src/RoomSession.ts

@@ -31,6 +31,8 @@ export const UNSAFE_PROP_ACCESS = [
   'setInputSensitivity',
   'setInputVolume',
   'setLayout',
+  'setPositions',
+  'setMemberPosition',
   'setOutputVolume',
   'showVideoMuted',
   'startRecording',

package/src/chat/Client.docs.ts

@@ -110,7 +110,7 @@ export interface ClientDocs
    * ```js
    * await chatClient.publish({
    *   channel: 'my-channel',
-   *   message: 'Hello, world.'
+   *   content: 'Hello, world.'
    * })
    * ```
    *
@@ -118,7 +118,7 @@ export interface ClientDocs
    * ```js
    * await chatClient.publish({
    *   channel: 'my-channel',
-   *   message: {
+   *   content: {
    *     field_one: 'value_one',
    *     field_two: 'value_two',
    *   }

package/src/chat/Client.ts

@@ -5,15 +5,12 @@ import type {
   UserOptions,
   Chat as ChatNamespace,
 } from '@signalwire/core'
-import { getLogger } from '@signalwire/core'
 import { createClient } from '../createClient'
-import {
-  ClientApiEventsDocs,
-  ClientDocs,
-} from './Client.docs'
+import { ClientApiEventsDocs, ClientDocs } from './Client.docs'
 
 interface ClientApiEventsMain extends ChatNamespace.BaseChatApiEvents {}
-export interface ClientApiEvents extends AssertSameType<ClientApiEventsMain, ClientApiEventsDocs> {}
+export interface ClientApiEvents
+  extends AssertSameType<ClientApiEventsMain, ClientApiEventsDocs> {}
 
 /** @ignore */
 export interface ClientFullState extends Client {}
@@ -43,7 +40,7 @@ interface ClientMain
  *
  * await chatClient.publish({
  *   channel: 'mychannel1',
- *   message: 'hello world'
+ *   content: 'hello world'
  * })
  * ```
  *
@@ -58,12 +55,6 @@ export interface Client extends AssertSameType<ClientMain, ClientDocs> {}
 export interface ClientOptions extends UserOptions {}
 
 export const Client = function (chatOptions: ClientOptions) {
-  if ('production' === process.env.NODE_ENV) {
-    getLogger().warn(
-      '`Chat` is still under development and may change in the future without prior notice.'
-    )
-  }
-
   const client = createClient<Client>(chatOptions)
   const subscribe: Client['subscribe'] = async (channels) => {
     await client.connect()

package/src/index.ts

@@ -2,18 +2,19 @@
  * Welcome to the technical documentation for the JavaScript SDK.
  *
  * At the outer level, when you import the SignalWire JS library you get access
- * to two different namespaces:
+ * to three different namespaces:
  *
  *  - {@link Video}
+ *  - {@link Chat}
  *  - {@link WebRTC}
  *
- * {@link Video} gives you access to the classes and methods that let you
- * interface with the backend Video APIs. {@link WebRTC} contains several
- * functions that are useful for interacting with the hardware of the user's
- * device.
+ * Video gives you access to the classes and methods that let you
+ * interface with the backend Video APIs. Chat gives you access to the classes and functions that you need to create a real-time chat application. WebRTC  
+ * contains several functions that are useful for interacting with the hardware of the user's device.
+ * 
  *
- * You don't know where to start? Create an instance of
- * {@link Video.RoomSession} to join a room, or take a look at [Getting Started
+ * Don't know where to start? Create an instance of
+ * {@link Video.RoomSession} to join a room, use the {@link Chat.Client} constructor to start a chat application, or take a look at [Getting Started
  * with the SignalWire Video
  * API](https://developer.signalwire.com/apis/docs/getting-started-with-the-signalwire-video-api-1).
  *

package/src/utils/interfaces.ts

@@ -22,6 +22,7 @@ import type {
   OnlyFunctionProperties,
   AssertSameType,
   MemberListUpdated,
+  VideoPositions,
 } from '@signalwire/core'
 import { INTERNAL_MEMBER_UPDATABLE_PROPS } from '@signalwire/core'
 import type { RoomSession } from '../RoomSession'
@@ -102,6 +103,8 @@ export type StartScreenShareOptions = {
   autoJoin?: boolean
   audio?: MediaStreamConstraints['audio']
   video?: MediaStreamConstraints['video']
+  layout?: string
+  positions?: VideoPositions
 }
 
 /**

package/src/video.ts

@@ -2,7 +2,7 @@ import { createRoomObject, Room } from './createRoomObject'
 import { createClient } from './createClient'
 import { joinRoom } from './joinRoom'
 import { MakeRoomOptions } from './Client'
-import { RoomSession } from './RoomSession'
+import { RoomSession, RoomSessionOptions } from './RoomSession'
 import { RoomSessionDevice, RoomDevice } from './RoomSessionDevice'
 import {
   RoomSessionScreenShare,
@@ -23,7 +23,7 @@ export {
 }
 
 /** @ignore */
-export type { MakeRoomOptions }
+export type { MakeRoomOptions, RoomSessionOptions }
 
 /** @ignore */
 export type {
@@ -33,6 +33,7 @@ export type {
   DeprecatedMemberUpdatableProps,
   DeprecatedVideoMemberHandlerParams,
   VideoMemberHandlerParams,
+  VideoMemberListUpdatedParams,
 } from './utils/interfaces'
 
 export type { CreateRoomObjectOptions } from './createRoomObject'

package/src/webrtc.ts

@@ -27,4 +27,5 @@ export {
   setMediaElementSinkId,
   stopStream,
   stopTrack,
+  createMicrophoneAnalyzer,
 } from '@signalwire/webrtc'