@webex/plugin-meetings 3.11.0-next.21 → 3.11.0-next.22

package/dist/locus-info/types.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import {HtMeta} from '../hashTree/types';\n\nexport type LocusFullState = {\n  active: boolean;\n  count: number;\n  lastActive: string;\n  locked: boolean;\n  sessionId: string;\n  seessionIds: string[];\n  startTime: number;\n  state: string;\n  type: string;\n};\n\nexport type Links = {\n  services: Record<'breakout' | 'record', {url: string}>; // there exist also other services, but these are the ones we currently use\n  resources: Record<'webcastInstance' | 'visibleDataSets', {url: string}>; // there exist also other resources, but these are the ones we currently use\n};\n\nexport type LocusDTO = {\n  controls?: any;\n  fullState?: LocusFullState;\n  host?: {\n    id: string;\n    incomingCallProtocols: any[];\n    isExternal: boolean;\n    name: string;\n    orgId: string;\n  };\n  htMeta?: HtMeta;\n  info?: any;\n  jsSdkMeta?: {\n    removedParticipantIds: string[]; // list of ids of participants that are removed in the last update\n  };\n  links?: Links;\n  mediaShares?: any[];\n  meetings?: any[];\n  participants: any[];\n  replaces?: any[];\n  self?: any;\n  sequence?: {\n    dirtyParticipants: number;\n    entries: number[];\n    rangeEnd: number;\n    rangeStart: number;\n    sequenceHash: number;\n    sessionToken: string;\n    since: string;\n    totalParticipants: number;\n  };\n  syncUrl?: string;\n  url?: string;\n};\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import {HtMeta} from '../hashTree/types';\n\nexport type LocusFullState = {\n  active: boolean;\n  count: number;\n  lastActive: string;\n  locked: boolean;\n  sessionId: string;\n  seessionIds: string[];\n  startTime: number;\n  state: string;\n  type: string;\n};\n\nexport type Links = {\n  services: Record<'breakout' | 'record', {url: string}>; // there exist also other services, but these are the ones we currently use\n  resources: Record<'webcastInstance' | 'visibleDataSets', {url: string}>; // there exist also other resources, but these are the ones we currently use\n};\n\nexport type LocusDTO = {\n  controls?: any;\n  embeddedApps?: any[];\n  fullState?: LocusFullState;\n  host?: {\n    id: string;\n    incomingCallProtocols: any[];\n    isExternal: boolean;\n    name: string;\n    orgId: string;\n  };\n  htMeta?: HtMeta;\n  info?: any;\n  jsSdkMeta?: {\n    removedParticipantIds: string[]; // list of ids of participants that are removed in the last update\n  };\n  links?: Links;\n  mediaShares?: any[];\n  meetings?: any[];\n  participants: any[];\n  replaces?: any[];\n  self?: any;\n  sequence?: {\n    dirtyParticipants: number;\n    entries: number[];\n    rangeEnd: number;\n    rangeStart: number;\n    sequenceHash: number;\n    sessionToken: string;\n    since: string;\n    totalParticipants: number;\n  };\n  syncUrl?: string;\n  url?: string;\n};\n"],"mappings":"","ignoreList":[]}

package/dist/types/hashTree/types.d.ts

@@ -9,6 +9,7 @@ export declare const ObjectType: {
     readonly links: "links";
     readonly control: "controlentry";
     readonly metadata: "metadata";
+    readonly embeddedApp: "embeddedapp";
 };
 export type ObjectType = Enum<typeof ObjectType>;
 export declare const ObjectTypeToLocusKeyMap: {
@@ -19,6 +20,7 @@ export declare const ObjectTypeToLocusKeyMap: {
     participant: string;
     mediashare: string;
     controlentry: string;
+    embeddedapp: string;
 };
 export interface HtMeta {
     elementId: {

package/dist/types/locus-info/types.d.ts

@@ -20,6 +20,7 @@ export type Links = {
 };
 export type LocusDTO = {
     controls?: any;
+    embeddedApps?: any[];
     fullState?: LocusFullState;
     host?: {
         id: string;

package/dist/webinar/index.js

@@ -506,7 +506,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
       }, _callee8);
     }))();
   },
-  version: "3.11.0-next.21"
+  version: "3.11.0-next.22"
 });
 var _default = exports.default = Webinar;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -93,5 +93,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.11.0-next.21"
+  "version": "3.11.0-next.22"
 }

package/src/hashTree/types.ts

@@ -11,6 +11,7 @@ export const ObjectType = {
   links: 'links',
   control: 'controlentry',
   metadata: 'metadata',
+  embeddedApp: 'embeddedapp',
 } as const;
 
 export type ObjectType = Enum<typeof ObjectType>;
@@ -24,7 +25,9 @@ export const ObjectTypeToLocusKeyMap = {
   [ObjectType.participant]: 'participants', // note: each object is a single participant in participants array
   [ObjectType.mediaShare]: 'mediaShares', // note: each object is a single mediaShare in mediaShares array
   [ObjectType.control]: 'controls', // note: each object is a single control entry in controls object
+  [ObjectType.embeddedApp]: 'embeddedApps', // note: each object is a single embedded app in embeddedApps array
 };
+
 export interface HtMeta {
   elementId: {
     type: ObjectType;

package/src/locus-info/index.ts

@@ -53,6 +53,7 @@ export type LocusLLMEvent = {
 const LocusDtoTopLevelKeys = [
   'controls',
   'fullState',
+  'embeddedApps',
   'host',
   'info',
   'links',
@@ -582,6 +583,31 @@ export default class LocusInfo extends EventsScope {
           );
         }
         break;
+      case ObjectType.embeddedApp:
+        if (object.data) {
+          LoggerProxy.logger.info(
+            `Locus-info:index#updateLocusFromHashTreeObject --> embeddedApp id=${object.htMeta.elementId.id} url='${object.data.url}' updated version=${object.htMeta.elementId.version}:`,
+            object.data
+          );
+          const existingEmbeddedApp = locus.embeddedApps?.find(
+            (ms) => ms.htMeta.elementId.id === object.htMeta.elementId.id
+          );
+
+          if (existingEmbeddedApp) {
+            Object.assign(existingEmbeddedApp, object.data);
+          } else {
+            locus.embeddedApps = locus.embeddedApps || [];
+            locus.embeddedApps.push(object.data);
+          }
+        } else {
+          LoggerProxy.logger.info(
+            `Locus-info:index#updateLocusFromHashTreeObject --> embeddedApp id=${object.htMeta.elementId.id} removed, version=${object.htMeta.elementId.version}`
+          );
+          locus.embeddedApps = locus.embeddedApps?.filter(
+            (ms) => ms.htMeta.elementId.id !== object.htMeta.elementId.id
+          );
+        }
+        break;
       case ObjectType.participant:
         LoggerProxy.logger.info(
           `Locus-info:index#updateLocusFromHashTreeObject --> participant id=${

package/src/locus-info/types.ts

@@ -19,6 +19,7 @@ export type Links = {
 
 export type LocusDTO = {
   controls?: any;
+  embeddedApps?: any[];
   fullState?: LocusFullState;
   host?: {
     id: string;

package/test/unit/spec/locus-info/index.js

@@ -329,6 +329,16 @@ describe('plugin-meetings', () => {
               htMeta: {elementId: {type: 'mediashare', id: 'fake-ht-mediaShare-2', version: 1}},
             },
           ];
+          locusInfo.embeddedApps = [
+            {
+              id: 'fake-embedded-app-1',
+              htMeta: {elementId: {type: 'embeddedapp', id: 'fake-ht-embeddedApp-1', version: 1}},
+            },
+            {
+              id: 'fake-embedded-app-2',
+              htMeta: {elementId: {type: 'embeddedapp', id: 'fake-ht-embeddedApp-2', version: 1}},
+            },
+          ];
           locusInfo.meetings = {id: 'fake-meetings'};
           locusInfo.participants = [
             {id: 'fake-participant-1', name: 'Participant One'},
@@ -364,6 +374,16 @@ describe('plugin-meetings', () => {
                 htMeta: {elementId: {type: 'mediashare', id: 'fake-ht-mediaShare-2', version: 1}},
               },
             ],
+            embeddedApps: [
+              {
+                id: 'fake-embedded-app-1',
+                htMeta: {elementId: {type: 'embeddedapp', id: 'fake-ht-embeddedApp-1', version: 1}},
+              },
+              {
+                id: 'fake-embedded-app-2',
+                htMeta: {elementId: {type: 'embeddedapp', id: 'fake-ht-embeddedApp-2', version: 1}},
+              },
+            ],
             meetings: {id: 'fake-meetings'},
             jsSdkMeta: {removedParticipantIds: []},
             participants: [], // empty means there were no participant updates
@@ -540,6 +560,7 @@ describe('plugin-meetings', () => {
             self: {id: 'fake-self'},
             links: {id: 'fake-links'},
             mediaShares: expectedLocusInfo.mediaShares,
+            embeddedApps: expectedLocusInfo.embeddedApps,
             // and now the new fields
             ...newLocus,
             htMeta: newLocusHtMeta,
@@ -572,6 +593,7 @@ describe('plugin-meetings', () => {
                   self: 'new-self',
                   participants: 'new-participants',
                   mediaShares: 'new-mediaShares',
+                  embeddedApps: 'new-embeddedApps',
                 },
               },
             ],
@@ -587,6 +609,7 @@ describe('plugin-meetings', () => {
             self: {id: 'fake-self'},
             links: {id: 'fake-links'},
             mediaShares: expectedLocusInfo.mediaShares,
+            embeddedApps: expectedLocusInfo.embeddedApps,
             participants: [], // empty means there were no participant updates
             jsSdkMeta: {removedParticipantIds: []}, // no participants were removed
             ...newLocus,
@@ -622,6 +645,7 @@ describe('plugin-meetings', () => {
             self: {id: 'fake-self'},
             links: {id: 'fake-links'},
             mediaShares: expectedLocusInfo.mediaShares,
+            embeddedApps: expectedLocusInfo.embeddedApps,
             // and now the new fields
             ...newLocus,
             htMeta: newLocusHtMeta,
@@ -761,6 +785,39 @@ describe('plugin-meetings', () => {
           });
         });
 
+        it('should process locus update correctly when called with updated EMBEDDEDAPP objects', () => {
+          const newEmbeddedApp = {
+            id: 'new-embedded-app-3',
+            htMeta: {elementId: {type: 'embeddedapp', id: 'fake-ht-embeddedApp-3', version: 100}},
+          };
+          const updatedEmbeddedApp2 = {
+            id: 'fake-embedded-app-2',
+            someNewProp: 'newValue',
+            htMeta: {elementId: {type: 'embeddedapp', id: 'fake-ht-embeddedApp-2', version: 100}},
+          };
+          // simulate an update from the HashTreeParser (normally this would be triggered by incoming locus messages)
+          // with 1 embedded app added, 1 updated, and 1 removed
+          locusInfoUpdateCallback(OBJECTS_UPDATED, {
+            updatedObjects: [
+              {htMeta: {elementId: {type: 'embeddedapp', id: 'fake-ht-embeddedApp-1'}}, data: null},
+              {
+                htMeta: {elementId: {type: 'embeddedapp', id: 'fake-ht-embeddedApp-2'}},
+                data: updatedEmbeddedApp2,
+              },
+              {
+                htMeta: {elementId: {type: 'embeddedapp', id: 'fake-ht-embeddedApp-3'}},
+                data: newEmbeddedApp,
+              },
+            ],
+          });
+
+          // check onDeltaLocus() was called with correctly updated locus info
+          assert.calledOnceWithExactly(onDeltaLocusStub, {
+            ...expectedLocusInfo,
+            embeddedApps: [updatedEmbeddedApp2, newEmbeddedApp],
+          });
+        });
+
         it('should process locus update correctly when called with a combination of various updated objects', () => {
           const newSelf = {
             id: 'new-self',
@@ -2958,28 +3015,28 @@ describe('plugin-meetings', () => {
         assert.isFunction(locusParser.onDeltaAction);
       });
 
-      it("#updateLocusInfo invokes updateLocusUrl before updateMeetingInfo", () => {
+      it('#updateLocusInfo invokes updateLocusUrl before updateMeetingInfo', () => {
         const callOrder = [];
-        sinon.stub(locusInfo, "updateControls");
-        sinon.stub(locusInfo, "updateConversationUrl");
-        sinon.stub(locusInfo, "updateCreated");
-        sinon.stub(locusInfo, "updateFullState");
-        sinon.stub(locusInfo, "updateHostInfo");
-        sinon.stub(locusInfo, "updateMeetingInfo").callsFake(() => {
-          callOrder.push("updateMeetingInfo");
+        sinon.stub(locusInfo, 'updateControls');
+        sinon.stub(locusInfo, 'updateConversationUrl');
+        sinon.stub(locusInfo, 'updateCreated');
+        sinon.stub(locusInfo, 'updateFullState');
+        sinon.stub(locusInfo, 'updateHostInfo');
+        sinon.stub(locusInfo, 'updateMeetingInfo').callsFake(() => {
+          callOrder.push('updateMeetingInfo');
         });
-        sinon.stub(locusInfo, "updateMediaShares");
-        sinon.stub(locusInfo, "updateReplaces");
-        sinon.stub(locusInfo, "updateSelf");
-        sinon.stub(locusInfo, "updateLocusUrl").callsFake(() => {
-          callOrder.push("updateLocusUrl");
+        sinon.stub(locusInfo, 'updateMediaShares');
+        sinon.stub(locusInfo, 'updateReplaces');
+        sinon.stub(locusInfo, 'updateSelf');
+        sinon.stub(locusInfo, 'updateLocusUrl').callsFake(() => {
+          callOrder.push('updateLocusUrl');
         });
-        sinon.stub(locusInfo, "updateAclUrl");
-        sinon.stub(locusInfo, "updateBasequence");
-        sinon.stub(locusInfo, "updateSequence");
-        sinon.stub(locusInfo, "updateEmbeddedApps");
-        sinon.stub(locusInfo, "updateLinks");
-        sinon.stub(locusInfo, "compareAndUpdate");
+        sinon.stub(locusInfo, 'updateAclUrl');
+        sinon.stub(locusInfo, 'updateBasequence');
+        sinon.stub(locusInfo, 'updateSequence');
+        sinon.stub(locusInfo, 'updateEmbeddedApps');
+        sinon.stub(locusInfo, 'updateLinks');
+        sinon.stub(locusInfo, 'compareAndUpdate');
 
         locusInfo.updateLocusInfo(locus);
 
@@ -3035,7 +3092,7 @@ describe('plugin-meetings', () => {
       it('#updateLocusInfo puts the Locus DTO top level properties at the right place in LocusInfo class', () => {
         // this test verifies that the top-level properties of Locus DTO are copied
         // into LocusInfo class and set as top level properties too
-        // this is important, because the code handling Locus hass trees relies on it, see updateFromHashTree()
+        // this is important, because the code handling Locus hash trees relies on it, see updateFromHashTree()
         const info = {id: 'info id'};
         const fullState = {id: 'fullState id'};
         const links = {services: {id: 'service links'}, resources: {id: 'resource links'}};
@@ -3903,7 +3960,7 @@ describe('plugin-meetings', () => {
 
     describe('#updateLocusUrl', () => {
       it('trigger LOCUS_INFO_UPDATE_URL event with isMainLocus is true as default', () => {
-        const fakeUrl = "https://fake.com/locus";
+        const fakeUrl = 'https://fake.com/locus';
         locusInfo.emitScoped = sinon.stub();
         locusInfo.updateLocusUrl(fakeUrl);
 
@@ -3916,12 +3973,12 @@ describe('plugin-meetings', () => {
           EVENTS.LOCUS_INFO_UPDATE_URL,
           {
             url: fakeUrl,
-            isMainLocus: true
-          },
+            isMainLocus: true,
+          }
         );
       });
       it('trigger LOCUS_INFO_UPDATE_URL event with isMainLocus is false', () => {
-        const fakeUrl = "https://fake.com/locus";
+        const fakeUrl = 'https://fake.com/locus';
         locusInfo.emitScoped = sinon.stub();
         locusInfo.updateLocusUrl(fakeUrl, false);
 
@@ -3934,8 +3991,8 @@ describe('plugin-meetings', () => {
           EVENTS.LOCUS_INFO_UPDATE_URL,
           {
             url: fakeUrl,
-            isMainLocus: false
-          },
+            isMainLocus: false,
+          }
         );
       });
     });
@@ -3987,8 +4044,8 @@ describe('plugin-meetings', () => {
 
         sinon.stub(locusInfo, 'updateParticipants');
         sinon.stub(locusInfo, 'isMeetingActive');
-          sinon.stub(locusInfo, 'handleOneOnOneEvent');
-          (updateLocusInfoStub = sinon.stub(locusInfo, 'updateLocusInfo'));
+        sinon.stub(locusInfo, 'handleOneOnOneEvent');
+        updateLocusInfoStub = sinon.stub(locusInfo, 'updateLocusInfo');
         syncRequestStub = sinon.stub().resolves({body: {}});
 
         mockMeeting.locusInfo = locusInfo;