@videosdk.live/react-sdk 0.1.100 → 0.1.102

package/dist/types/character.d.ts

@@ -2,10 +2,10 @@ import { Participant } from './participant';
 import { Stream } from './stream';
 
 export enum CharacterMode {
-  TEXT = "text",
-  CO_PILOT = "co_pilot",
-  AUTO_PILOT = "auto_pilot",
-  VISION_PILOT = "vision_pilot"
+  TEXT = 'text',
+  CO_PILOT = 'co_pilot',
+  AUTO_PILOT = 'auto_pilot',
+  VISION_PILOT = 'vision_pilot'
 }
 
 export enum CharacterState {
@@ -35,6 +35,11 @@ export class Character extends Participant {
    */
   knowledgeBases: string[];
 
+  /**
+   * @description This represents language of interaction
+   */
+  language: string;
+
   /**
    * @description This represents communication mode of character participant
    */
@@ -61,8 +66,8 @@ export class Character extends Participant {
   sendMessage(text: string): Promise<void>;
 
   /**
- * @description This method can be used to interrupt a character participant
- */
+   * @description This method can be used to interrupt a character participant
+   */
   interrupt(): Promise<void>;
 
   /**
@@ -79,7 +84,9 @@ export class Character extends Participant {
       | 'character-state-changed'
       | 'character-message'
       | 'character-joined'
-      | 'character-left',
+      | 'character-left'
+      | 'user-message'
+      | 'data',
     listener: (data: any) => void
   ): void;
   /**
@@ -96,7 +103,9 @@ export class Character extends Participant {
       | 'character-state-changed'
       | 'character-message'
       | 'character-joined'
-      | 'character-left',
+      | 'character-left'
+      | 'user-message'
+      | 'data',
     listener: (data: any) => void
   ): void;
 }

package/dist/types/index.d.ts

@@ -1010,6 +1010,39 @@ export function useFile(): {
   }) => Promise<string | null>;
 };
 
+/**
+ * @returns - This will return `startWhiteboard()`, `stopWhiteboard()` and `whiteboardUrl`.
+ * ---
+ * **useWhiteboard example**
+ * ```javascript
+ * const { startWhiteboard, stopWhiteboard, whiteboardUrl } = useWhiteboard();
+ *
+ * async function handleStartWhiteboard() {
+ *    await startWhiteboard();
+ * }
+ *
+ * async function handleStopWhiteboard() {
+ *    await stopWhiteboard();
+ * }
+ * ```
+ */
+export function useWhiteboard(): {
+  /**
+   * @description Starts the whiteboard for the meeting.
+   */
+  startWhiteboard: () => Promise<void>;
+
+  /**
+   * @description Stops the whiteboard session for the meeting.
+   */
+  stopWhiteboard: () => Promise<void>;
+
+  /**
+   * @description The URL of the active whiteboard, or `null` if the whiteboard is not currently active.
+   */
+  whiteboardUrl: string | null;
+};
+
 /**
  * @param onTranscriptionStateChanged - This will triggered when a realtime transcription state is changed.
  * ---
@@ -1082,6 +1115,10 @@ export function useTranscription({
  * ---
  * @param onCharacterMessage - This will triggered when a character response/message is published.
  * ---
+ * @param onUserMessage - This will triggered when a user/participant message is published.
+ * ---
+ * @param onData - This will triggered when a character worker notify payload.
+ * ---
  * @param onStreamEnabled - It's a callback which gets triggered whenever a character's video, audio or screen share stream is enabled.
  * ---
  * @param onStreamEnabled - It's a callback which gets triggered whenever a character's video, audio or screen share stream is disabled.
@@ -1105,6 +1142,14 @@ export function useTranscription({
  *    console.log('character message Payload:', data);
  *  }
  *
+ *  function onUserMessage(data) {
+ *    console.log('user message Payload:', data);
+ *  }
+ *
+ *  function onData(topic, data) {
+ *    console.log('character data available:', topic, data);
+ *  }
+ *
  *  const { join, leave, sendMessage, interrupt } = useCharacter({
  *   interactionId,
  *   // OR
@@ -1113,10 +1158,13 @@ export function useTranscription({
  *    characterRole,
  *    characterMode,
  *    knowledgeBases,
+ *    language,
  *    },
  *    {
  *    onCharacterStateChanged,
  *    onCharacterMessage,
+ *    onUserMessage,
+ *    onData,
  *    onCharacterJoined,
  *    onCharacterLeft,
  *
@@ -1143,7 +1191,8 @@ export function useCharacter(
     displayName,
     characterRole,
     characterMode,
-    knowledgeBases
+    knowledgeBases,
+    language
   }: {
     interactionId: string;
     // OR
@@ -1152,11 +1201,13 @@ export function useCharacter(
     characterRole: string;
     characterMode: 'text' | 'co_pilot' | 'auto_pilot' | 'vision_pilot';
     knowledgeBases: string[];
+    language: string;
   },
   {
     onCharacterStateChanged,
     onCharacterMessage,
-
+    onUserMessage,
+    onData,
     onStreamEnabled,
     onStreamDisabled,
     onMediaStatusChanged,
@@ -1166,12 +1217,20 @@ export function useCharacter(
       id: string;
       status: CharacterState;
     }) => void;
-    onCharacterMessage?: (data: {
+    onUserMessage?: (data: {
       participantId: string;
       participantName: string;
       text: string;
       timestamp: number;
     }) => void;
+    onCharacterMessage?: (data: {
+      characterId: string;
+      characterName: string;
+      text: string;
+      timestamp: number;
+    }) => void;
+
+    onData?: (topic: string, data: any) => void;
     onCharacterJoined?: () => void;
     onCharacterLeft?: () => void;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@videosdk.live/react-sdk",
-  "version": "0.1.100",
+  "version": "0.1.102",
   "license": "ISC",
   "main": "dist/index.js",
   "module": "dist/index.modern.js",
@@ -27,6 +27,7 @@
   "author": "videosdk.live",
   "homepage": "https://docs.videosdk.live/docs/realtime-communication/sdk-reference/react-sdk/setup",
   "devDependencies": {
+    "@types/react": "^18.3.5",
     "babel-eslint": "^10.0.1",
     "eslint": "^5.16.0",
     "husky": "^2.3.0",
@@ -73,7 +74,7 @@
     }
   },
   "dependencies": {
-    "@videosdk.live/js-sdk": "0.0.96",
+    "@videosdk.live/js-sdk": "0.0.98",
     "events": "^3.3.0"
   }
 }