agora-appbuilder-core 4.0.0-spl.24 → 4.0.0-spl.25

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agora-appbuilder-core",
-  "version": "4.0.0-spl.24",
+  "version": "4.0.0-spl.25",
   "description": "React Native template for RTE app builder",
   "main": "index.js",
   "files": [

package/template/_package-lock.json

@@ -17,6 +17,7 @@
         "@sentry/react-native": "2.4.3",
         "@sentry/tracing": "6.2.1",
         "@supersami/rn-foreground-service": "^1.1.1",
+        "@types/lodash": "^4.17.6",
         "agora-react-native-rtm": "1.5.1",
         "agora-rtc-sdk-ng": "4.16.1",
         "agora-rtm-sdk": "1.5.1",
@@ -26,6 +27,7 @@
         "exponential-backoff": "3.1.0",
         "fetch-retry": "^5.0.6",
         "graphql": "15.5.0",
+        "lodash": "^4.17.21",
         "nanoevents": "7.0.1",
         "nanoid": "4.0.0",
         "nosleep.js": "0.12.0",
@@ -6110,6 +6112,11 @@
       "integrity": "sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ==",
       "dev": true
     },
+    "node_modules/@types/lodash": {
+      "version": "4.17.6",
+      "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.6.tgz",
+      "integrity": "sha512-OpXEVoCKSS3lQqjx9GGGOapBeuW5eUboYHRlHP9urXPX25IKZ6AnP5ZRxtVf63iieUbsHxLn8NQ5Nlftc6yzAA=="
+    },
     "node_modules/@types/mime": {
       "version": "3.0.1",
       "resolved": "https://registry.npmjs.org/@types/mime/-/mime-3.0.1.tgz",
@@ -34130,6 +34137,11 @@
       "integrity": "sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ==",
       "dev": true
     },
+    "@types/lodash": {
+      "version": "4.17.6",
+      "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.6.tgz",
+      "integrity": "sha512-OpXEVoCKSS3lQqjx9GGGOapBeuW5eUboYHRlHP9urXPX25IKZ6AnP5ZRxtVf63iieUbsHxLn8NQ5Nlftc6yzAA=="
+    },
     "@types/mime": {
       "version": "3.0.1",
       "resolved": "https://registry.npmjs.org/@types/mime/-/mime-3.0.1.tgz",

package/template/package-lock.json

@@ -17,6 +17,7 @@
         "@sentry/react-native": "2.4.3",
         "@sentry/tracing": "6.2.1",
         "@supersami/rn-foreground-service": "^1.1.1",
+        "@types/lodash": "^4.17.6",
         "agora-react-native-rtm": "1.5.1",
         "agora-rtc-sdk-ng": "4.16.1",
         "agora-rtm-sdk": "1.5.1",
@@ -26,6 +27,7 @@
         "exponential-backoff": "3.1.0",
         "fetch-retry": "^5.0.6",
         "graphql": "15.5.0",
+        "lodash": "^4.17.21",
         "nanoevents": "7.0.1",
         "nanoid": "4.0.0",
         "nosleep.js": "0.12.0",
@@ -6110,6 +6112,11 @@
       "integrity": "sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ==",
       "dev": true
     },
+    "node_modules/@types/lodash": {
+      "version": "4.17.6",
+      "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.6.tgz",
+      "integrity": "sha512-OpXEVoCKSS3lQqjx9GGGOapBeuW5eUboYHRlHP9urXPX25IKZ6AnP5ZRxtVf63iieUbsHxLn8NQ5Nlftc6yzAA=="
+    },
     "node_modules/@types/mime": {
       "version": "3.0.1",
       "resolved": "https://registry.npmjs.org/@types/mime/-/mime-3.0.1.tgz",
@@ -34130,6 +34137,11 @@
       "integrity": "sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ==",
       "dev": true
     },
+    "@types/lodash": {
+      "version": "4.17.6",
+      "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.6.tgz",
+      "integrity": "sha512-OpXEVoCKSS3lQqjx9GGGOapBeuW5eUboYHRlHP9urXPX25IKZ6AnP5ZRxtVf63iieUbsHxLn8NQ5Nlftc6yzAA=="
+    },
     "@types/mime": {
       "version": "3.0.1",
       "resolved": "https://registry.npmjs.org/@types/mime/-/mime-3.0.1.tgz",

package/template/package.json

@@ -57,6 +57,7 @@
     "@sentry/react-native": "2.4.3",
     "@sentry/tracing": "6.2.1",
     "@supersami/rn-foreground-service": "^1.1.1",
+    "@types/lodash": "^4.17.6",
     "agora-react-native-rtm": "1.5.1",
     "agora-rtc-sdk-ng": "4.16.1",
     "agora-rtm-sdk": "1.5.1",
@@ -66,6 +67,7 @@
     "exponential-backoff": "3.1.0",
     "fetch-retry": "^5.0.6",
     "graphql": "15.5.0",
+    "lodash": "^4.17.21",
     "nanoevents": "7.0.1",
     "nanoid": "4.0.0",
     "nosleep.js": "0.12.0",

package/template/src/SDKAppWrapper.tsx

@@ -1,4 +1,4 @@
-import React from 'react';
+import React, {useEffect} from 'react';
 import {
   CustomizationApiInterface,
   customize,
@@ -39,6 +39,7 @@ export interface AppBuilderSdkApiInterface {
   createCustomization: (
     customization: CustomizationApiInterface,
   ) => CustomizationApiInterface;
+  clearState: (stateKey: 'join' | 'all') => Promise<void>;
   customEvents: typeof customEvents;
   on: <T extends keyof userEventsMapInterface>(
     userEventName: T,
@@ -81,6 +82,15 @@ export const AppBuilderSdkApi: AppBuilderSdkApiInterface = {
   muteVideo: async (state) => {
     return await SDKMethodEventsManager.emit('muteVideo', state);
   },
+  clearState: async (stateKey) => {
+    switch (stateKey) {
+      case 'all':
+      case 'join':
+        return await SDKMethodEventsManager.emit('clearState', stateKey);
+      default:
+        throw new Error('Invalid identifier');
+    }
+  },
   createCustomization: customize,
   on: (userEventName, cb) => {
     console.log('SDKEvents: Event Registered', userEventName);

package/template/src/components/SdkApiContext.tsx

@@ -8,6 +8,7 @@ import {
 } from './meeting-info/useMeetingInfo';
 import {CustomizationApiInterface} from 'customization-api';
 import {Unsubscribe} from 'nanoevents';
+import {cloneDeep} from 'lodash';
 
 type extractPromises<T extends (...p: any) => any> = {
   res: Parameters<T>[0];
@@ -57,8 +58,8 @@ type SdkApiContextInterface = {
   onMuteAudio: (callback: _InternalSDKMethodEventsMap['muteAudio']) => void;
   onMuteVideo: (callback: _InternalSDKMethodEventsMap['muteVideo']) => void;
   clearState: (
-    key: keyof _InternalSDKMethodEventsMap | 'enterRoom',
-    param?: any,
+    key: keyof _InternalSDKMethodEventsMap | 'enterRoom' | 'all',
+    hard?: boolean,
   ) => void;
 };
 
@@ -80,7 +81,7 @@ const defaultMuteAllParticipantsListener = ((res, _, param) => {
   res();
 }) as _InternalSDKMethodEventsMap['muteAllParticipants'];
 
-const SdkApiInitState: SdkApiContextInterface = {
+const SdkApiDefaultState: SdkApiContextInterface = {
   enterRoom: {
     set: () => {},
   },
@@ -100,6 +101,19 @@ const SdkApiInitState: SdkApiContextInterface = {
   onMuteAudio: (_) => {},
   clearState: () => {},
 };
+const SdkApiInitState: SdkApiContextInterface = cloneDeep(SdkApiDefaultState);
+
+export const clearStateGlobal = (
+  state: keyof SdkApiContextInterface | 'all',
+) => {
+  if (state === 'all') {
+    for (const key in SdkApiInitState)
+      SdkApiInitState[key] = cloneDeep(SdkApiDefaultState[key]);
+  } else {
+    //@ts-expect-error
+    SdkApiInitState[state] = cloneDeep(SdkApiDefaultState[state]);
+  }
+};
 
 export const READ_ONLY_SdkApiInitState = SdkApiInitState;
 
@@ -111,9 +125,10 @@ export const SdkApiContext =
 let moduleEventsUnsub: any[] = [];
 
 type commonEventHandlers = {
-  [K in keyof Omit<_InternalSDKMethodEventsMap, 'muteVideo' | 'muteAudio'>]?: (
-    setter: (p: SdkApiContextInterface[K]) => void,
-  ) => Unsubscribe;
+  [K in keyof Omit<
+    _InternalSDKMethodEventsMap,
+    'muteVideo' | 'muteAudio' | 'flushQueue'
+  >]?: (setter: (p: SdkApiContextInterface[K]) => void) => Unsubscribe;
 };
 
 const commonEventHandlers: commonEventHandlers = {
@@ -209,6 +224,10 @@ const registerListener = () => {
     ),
     SDKMethodEventsManager.on('muteVideo', defaultMuteListener),
     SDKMethodEventsManager.on('muteAudio', defaultMuteListener),
+    SDKMethodEventsManager.on('clearState', (res, _, queue) => {
+      clearStateGlobal(queue);
+      res();
+    }),
   ];
 };
 
@@ -261,26 +280,31 @@ const SdkApiContextProvider: React.FC = (props) => {
     muteAudioListener.current = value;
   };
 
-  const clearState: SdkApiContextInterface['clearState'] = (key) => {
+  const clearState: SdkApiContextInterface['clearState'] = (key, hard) => {
+    let fallthrough = false;
     switch (key) {
+      case 'all':
+        fallthrough = true;
       case 'join':
-        setJoinState(SdkApiInitState.join);
-        break;
+        setJoinState(hard ? SdkApiDefaultState.join : SdkApiInitState.join);
+        if (!fallthrough) break;
       case 'enterRoom':
         setEnterRoom(null);
-        break;
+        if (!fallthrough) break;
       case 'customize':
-        setUserCustomization(SdkApiInitState.customize);
-        break;
+        setUserCustomization(
+          hard ? SdkApiDefaultState.customize : SdkApiInitState.customize,
+        );
+        if (!fallthrough) break;
       case 'microphoneDevice':
         setMicrophoneDeviceState({});
-        break;
+        if (!fallthrough) break;
       case 'speakerDevice':
         setSpeakerDeviceState({});
-        break;
+        if (!fallthrough) break;
       case 'cameraDevice':
         setCameraDeviceState({});
-        break;
+        if (!fallthrough) break;
       case 'muteAllParticipants':
         setMuteAllParticipantsState((current) => {
           return {
@@ -288,12 +312,13 @@ const SdkApiContextProvider: React.FC = (props) => {
             promise: undefined,
           };
         });
+        if (!fallthrough) break;
       case 'muteVideo':
         setMuteVideoListener(defaultMuteListener);
-        break;
+        if (!fallthrough) break;
       case 'muteAudio':
         setMuteVideoListener(defaultMuteListener);
-        break;
+        if (!fallthrough) break;
     }
   };
 
@@ -353,6 +378,11 @@ const SdkApiContextProvider: React.FC = (props) => {
       SDKMethodEventsManager.on('muteAudio', (...args) => {
         muteAudioListener.current(...args);
       }),
+      SDKMethodEventsManager.on('clearState', (res, _, queue) => {
+        clearStateGlobal(queue);
+        clearState(queue, true);
+        res();
+      }),
     ];
 
     return () => {

package/template/src/utils/SdkMethodEvents.ts

@@ -14,9 +14,12 @@ export interface SdkMethodEvents {
   microphoneDevice: (deviceId: deviceId) => void;
   speakerDevice: (deviceId: deviceId) => void;
   cameraDevice: (deviceId: deviceId) => void;
-  muteAllParticipants: (mute: boolean | ((currentMute: boolean) => boolean)) => void;
+  muteAllParticipants: (
+    mute: boolean | ((currentMute: boolean) => boolean),
+  ) => void;
   muteAudio: (mute: boolean | ((currentMute: boolean) => boolean)) => void;
   muteVideo: (mute: boolean | ((currentMute: boolean) => boolean)) => void;
+  clearState: (state: 'join' | 'all') => void;
 }
 
 type EventParameterHelper<T extends keyof SdkMethodEvents> = Parameters<
@@ -61,8 +64,22 @@ class SDKMethodEvents {
     event: T,
     ...params: EventParameterHelper<T>
   ) {
-    if (this.emitCache[event]) {
-      throw new Error(`Event: ${event} already in callstack`);
+    if (event === 'clearState') {
+      const param = params[0];
+      switch (param) {
+        case 'join':
+        case 'clearState':
+          delete this.emitCache[param];
+          delete this.emitCacheDisabled[param];
+          break;
+        case 'all':
+          this.reset();
+        default:
+      }
+    } else {
+      if (this.emitCache[event]) {
+        throw new Error(`Event: ${event} already in callstack`);
+      }
     }
 
     const result = await new Promise<EventReturnTypeHelper<T>>((res, rej) => {
@@ -92,6 +109,11 @@ class SDKMethodEvents {
     this.emitCacheDisabled[event] = true;
     return unsub;
   }
+
+  reset() {
+    this.emitCache = {};
+    this.emitCacheDisabled = {};
+  }
 }
 
 const SDKMethodEventsManager = new SDKMethodEvents();