@webex/plugin-meetings 3.0.0-beta.2 → 3.0.0-beta.20

package/dist/transcription/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["Transcription","webSocketUrl","sessionId","members","sessionID","memberCSIs","params","webSocket","WebSocket","token","onopen","send","id","uuidv4","type","data","trackingId","toString","callback","onclose","event","onerror","csis","csi","member","membersCollection","find","participant","status","selfIsSpeaking","includes","speaker","transcription","onmessage","JSON","parse","voiceaPayload","getSpeaker","messageID","transcript_id","personID","timestamp","close"],"sources":["index.js"],"sourcesContent":["import {v4 as uuidv4} from 'uuid';\n\n/**\n * @description Meeting Webex assistance transcription feature.\n * @exports\n * @class Transcription\n */\nexport default class Transcription {\n  /**\n   * @param {string} webSocketUrl\n   * @param {sessionID} sessionId\n   * @param {object} members\n   * @constructor\n   * @memberof Transcription\n   */\n  constructor(webSocketUrl, sessionId, members) {\n    this.webSocketUrl = webSocketUrl;\n    this.sessionID = sessionId;\n    this.members = members;\n    this.memberCSIs = {};\n\n    const params = '?outboundWireFormat=text&bufferStates=true&aliasHttpStatus=true';\n\n    this.webSocket = new WebSocket(`${this.webSocketUrl}${params}`);\n  }\n\n  /**\n   * open the Low Latency Mercury connection\n   * An event parameter will be send to the callback.\n   *\n   * @param {string} token\n   * @param {string} sessionID\n   * @returns {void}\n   */\n  connect(token) {\n    this.webSocket.onopen = () => {\n      this.webSocket.send(JSON.stringify({\n        id: uuidv4(),\n        type: 'authorization',\n        data: {token: `Bearer ${token}`},\n        trackingId: `webex-js-sdk_${this.sessionID}${Date.now.toString()}`\n      }));\n    };\n  }\n\n  /**\n   * Sets callback to invoke when the web socket connection is closed.\n   *\n   * @param {function} callback\n   * @returns {void}\n   */\n  onCloseSocket(callback) {\n    if (callback) {\n      this.webSocket.onclose = (event) => {\n        callback(event);\n      };\n    }\n  }\n\n  /**\n   * Sets callback to invoke when a web socket connection error occurs.\n   * An event parameter will be send to the callback.\n   *\n   * @param {function} callback\n   * @returns {void}\n   */\n  onErrorSocket(callback) {\n    if (callback) {\n      this.webSocket.onerror = (event) => {\n        callback(event);\n      };\n    }\n  }\n\n  /**\n   * Get current speaker from the given csis payload and update the global csis map\n   *\n   * @private\n   * @param {object} csis\n   * @returns {object}\n   */\n  getSpeaker(csis) {\n    for (const csi of csis) {\n      const member = this.memberCSIs[csi];\n\n      if (member) {\n        return member;\n      }\n    }\n\n    return Object.values(this.members.membersCollection.members)\n      .find((member) => {\n        const memberCSIs = member.participant.status.csis;\n        let selfIsSpeaking = false;\n\n        for (const csi of csis) {\n          if (memberCSIs.includes(csi)) {\n            this.memberCSIs[csi] = member;\n            selfIsSpeaking = true;\n            break;\n          }\n        }\n\n        return selfIsSpeaking;\n      });\n  }\n\n  /**\n   * Sends transcription data to given callback as it arrives.\n   *\n   * @param {function} callback\n   * @returns {void}\n   */\n  subscribe(callback) {\n    let data, csis, speaker, transcription;\n\n    this.webSocket.onmessage = (event) => {\n      data = JSON.parse(event.data);\n      csis = data.data?.voiceaPayload?.csis || [];\n      speaker = this.getSpeaker(csis);\n      transcription = data.data?.voiceaPayload?.data || '';\n\n      this.webSocket.send(JSON.stringify({messageID: data.id, type: 'ack'}));\n\n      if (transcription) {\n        callback(\n          {\n            id: data.data?.voiceaPayload?.transcript_id,\n            personID: speaker?.id,\n            transcription,\n            timestamp: data.timestamp,\n            type: data?.data?.voiceaPayload?.type\n          }\n        );\n      }\n    };\n  }\n\n  /**\n   * Close the LLM web socket connection\n   * @returns {void}\n   */\n  closeSocket() {\n    this.webSocket.close();\n  }\n}\n\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;AAEA;AACA;AACA;AACA;AACA;IACqBA,a;EACnB;AACF;AACA;AACA;AACA;AACA;AACA;EACE,uBAAYC,YAAZ,EAA0BC,SAA1B,EAAqCC,OAArC,EAA8C;IAAA;IAC5C,KAAKF,YAAL,GAAoBA,YAApB;IACA,KAAKG,SAAL,GAAiBF,SAAjB;IACA,KAAKC,OAAL,GAAeA,OAAf;IACA,KAAKE,UAAL,GAAkB,EAAlB;IAEA,IAAMC,MAAM,GAAG,iEAAf;IAEA,KAAKC,SAAL,GAAiB,IAAIC,SAAJ,WAAiB,KAAKP,YAAtB,SAAqCK,MAArC,EAAjB;EACD;EAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;;;;;WACE,iBAAQG,KAAR,EAAe;MAAA;;MACb,KAAKF,SAAL,CAAeG,MAAf,GAAwB,YAAM;QAC5B,KAAI,CAACH,SAAL,CAAeI,IAAf,CAAoB,wBAAe;UACjCC,EAAE,EAAE,IAAAC,QAAA,GAD6B;UAEjCC,IAAI,EAAE,eAF2B;UAGjCC,IAAI,EAAE;YAACN,KAAK,mBAAYA,KAAZ;UAAN,CAH2B;UAIjCO,UAAU,yBAAkB,KAAI,CAACZ,SAAvB,SAAmC,aAASa,QAAT,EAAnC;QAJuB,CAAf,CAApB;MAMD,CAPD;IAQD;IAED;AACF;AACA;AACA;AACA;AACA;;;;WACE,uBAAcC,QAAd,EAAwB;MACtB,IAAIA,QAAJ,EAAc;QACZ,KAAKX,SAAL,CAAeY,OAAf,GAAyB,UAACC,KAAD,EAAW;UAClCF,QAAQ,CAACE,KAAD,CAAR;QACD,CAFD;MAGD;IACF;IAED;AACF;AACA;AACA;AACA;AACA;AACA;;;;WACE,uBAAcF,QAAd,EAAwB;MACtB,IAAIA,QAAJ,EAAc;QACZ,KAAKX,SAAL,CAAec,OAAf,GAAyB,UAACD,KAAD,EAAW;UAClCF,QAAQ,CAACE,KAAD,CAAR;QACD,CAFD;MAGD;IACF;IAED;AACF;AACA;AACA;AACA;AACA;AACA;;;;WACE,oBAAWE,IAAX,EAAiB;MAAA;;MAAA,2CACGA,IADH;MAAA;;MAAA;QACf,oDAAwB;UAAA,IAAbC,GAAa;UACtB,IAAMC,MAAM,GAAG,KAAKnB,UAAL,CAAgBkB,GAAhB,CAAf;;UAEA,IAAIC,MAAJ,EAAY;YACV,OAAOA,MAAP;UACD;QACF;MAPc;QAAA;MAAA;QAAA;MAAA;;MASf,OAAO,qBAAc,KAAKrB,OAAL,CAAasB,iBAAb,CAA+BtB,OAA7C,EACJuB,IADI,CACC,UAACF,MAAD,EAAY;QAChB,IAAMnB,UAAU,GAAGmB,MAAM,CAACG,WAAP,CAAmBC,MAAnB,CAA0BN,IAA7C;QACA,IAAIO,cAAc,GAAG,KAArB;;QAFgB,4CAIEP,IAJF;QAAA;;QAAA;UAIhB,uDAAwB;YAAA,IAAbC,GAAa;;YACtB,IAAIlB,UAAU,CAACyB,QAAX,CAAoBP,GAApB,CAAJ,EAA8B;cAC5B,MAAI,CAAClB,UAAL,CAAgBkB,GAAhB,IAAuBC,MAAvB;cACAK,cAAc,GAAG,IAAjB;cACA;YACD;UACF;QAVe;UAAA;QAAA;UAAA;QAAA;;QAYhB,OAAOA,cAAP;MACD,CAdI,CAAP;IAeD;IAED;AACF;AACA;AACA;AACA;AACA;;;;WACE,mBAAUX,QAAV,EAAoB;MAAA;;MAClB,IAAIH,IAAJ,EAAUO,IAAV,EAAgBS,OAAhB,EAAyBC,aAAzB;;MAEA,KAAKzB,SAAL,CAAe0B,SAAf,GAA2B,UAACb,KAAD,EAAW;QAAA;;QACpCL,IAAI,GAAGmB,IAAI,CAACC,KAAL,CAAWf,KAAK,CAACL,IAAjB,CAAP;QACAO,IAAI,GAAG,eAAAP,IAAI,CAACA,IAAL,mFAAWqB,aAAX,gFAA0Bd,IAA1B,KAAkC,EAAzC;QACAS,OAAO,GAAG,MAAI,CAACM,UAAL,CAAgBf,IAAhB,CAAV;QACAU,aAAa,GAAG,gBAAAjB,IAAI,CAACA,IAAL,qFAAWqB,aAAX,gFAA0BrB,IAA1B,KAAkC,EAAlD;;QAEA,MAAI,CAACR,SAAL,CAAeI,IAAf,CAAoB,wBAAe;UAAC2B,SAAS,EAAEvB,IAAI,CAACH,EAAjB;UAAqBE,IAAI,EAAE;QAA3B,CAAf,CAApB;;QAEA,IAAIkB,aAAJ,EAAmB;UAAA;;UACjBd,QAAQ,CACN;YACEN,EAAE,iBAAEG,IAAI,CAACA,IAAP,yEAAE,YAAWqB,aAAb,0DAAE,sBAA0BG,aADhC;YAEEC,QAAQ,cAAET,OAAF,6CAAE,SAASnB,EAFrB;YAGEoB,aAAa,EAAbA,aAHF;YAIES,SAAS,EAAE1B,IAAI,CAAC0B,SAJlB;YAKE3B,IAAI,WAAEC,IAAF,yDAAE,MAAMA,IAAR,yEAAE,YAAYqB,aAAd,0DAAE,sBAA2BtB;UALnC,CADM,CAAR;QASD;MACF,CAnBD;IAoBD;IAED;AACF;AACA;AACA;;;;WACE,uBAAc;MACZ,KAAKP,SAAL,CAAemC,KAAf;IACD"}
+{"version":3,"names":["Transcription","webSocketUrl","sessionId","members","sessionID","memberCSIs","params","webSocket","WebSocket","token","onopen","send","id","uuidv4","type","data","trackingId","toString","callback","onclose","event","onerror","csis","csi","member","membersCollection","find","participant","status","selfIsSpeaking","includes","speaker","transcription","onmessage","JSON","parse","voiceaPayload","getSpeaker","messageID","transcript_id","personID","timestamp","close"],"sources":["index.ts"],"sourcesContent":["import {v4 as uuidv4} from 'uuid';\n\n/**\n * @description Meeting Webex assistance transcription feature.\n * @exports\n * @class Transcription\n */\nexport default class Transcription {\n  webSocketUrl: any;\n  sessionID: any;\n  members: any;\n  memberCSIs: any;\n  webSocket: any;\n\n  /**\n   * @param {string} webSocketUrl\n   * @param {sessionID} sessionId\n   * @param {object} members\n   * @constructor\n   * @memberof Transcription\n   */\n  constructor(webSocketUrl: string, sessionId: any, members: object) {\n    this.webSocketUrl = webSocketUrl;\n    this.sessionID = sessionId;\n    this.members = members;\n    this.memberCSIs = {};\n\n    const params = '?outboundWireFormat=text&bufferStates=true&aliasHttpStatus=true';\n\n    this.webSocket = new WebSocket(`${this.webSocketUrl}${params}`);\n  }\n\n  /**\n   * open the Low Latency Mercury connection\n   * An event parameter will be send to the callback.\n   *\n   * @param {string} token\n   * @param {string} sessionID\n   * @returns {void}\n   */\n  connect(token: string) {\n    this.webSocket.onopen = () => {\n      this.webSocket.send(\n        JSON.stringify({\n          id: uuidv4(),\n          type: 'authorization',\n          data: {token: `Bearer ${token}`},\n          trackingId: `webex-js-sdk_${this.sessionID}${Date.now.toString()}`,\n        })\n      );\n    };\n  }\n\n  /**\n   * Sets callback to invoke when the web socket connection is closed.\n   *\n   * @param {Function} callback\n   * @returns {void}\n   */\n  onCloseSocket(callback: any) {\n    if (callback) {\n      this.webSocket.onclose = (event) => {\n        callback(event);\n      };\n    }\n  }\n\n  /**\n   * Sets callback to invoke when a web socket connection error occurs.\n   * An event parameter will be send to the callback.\n   *\n   * @param {Function} callback\n   * @returns {void}\n   */\n  onErrorSocket(callback: any) {\n    if (callback) {\n      this.webSocket.onerror = (event) => {\n        callback(event);\n      };\n    }\n  }\n\n  /**\n   * Get current speaker from the given csis payload and update the global csis map\n   *\n   * @private\n   * @param {object} csis\n   * @returns {object}\n   */\n  private getSpeaker(csis: any) {\n    for (const csi of csis) {\n      const member = this.memberCSIs[csi];\n\n      if (member) {\n        return member;\n      }\n    }\n\n    return Object.values(this.members.membersCollection.members).find((member: any) => {\n      const memberCSIs = member.participant.status.csis;\n      let selfIsSpeaking = false;\n\n      for (const csi of csis) {\n        if (memberCSIs.includes(csi)) {\n          this.memberCSIs[csi] = member;\n          selfIsSpeaking = true;\n          break;\n        }\n      }\n\n      return selfIsSpeaking;\n    });\n  }\n\n  /**\n   * Sends transcription data to given callback as it arrives.\n   *\n   * @param {Function} callback\n   * @returns {void}\n   */\n  subscribe(callback: any) {\n    let data;\n    let csis;\n    let speaker;\n    let transcription;\n\n    this.webSocket.onmessage = (event) => {\n      data = JSON.parse(event.data);\n      csis = data.data?.voiceaPayload?.csis || [];\n      speaker = this.getSpeaker(csis);\n      transcription = data.data?.voiceaPayload?.data || '';\n\n      this.webSocket.send(JSON.stringify({messageID: data.id, type: 'ack'}));\n\n      if (transcription) {\n        callback({\n          id: data.data?.voiceaPayload?.transcript_id,\n          personID: speaker?.id,\n          transcription,\n          timestamp: data.timestamp,\n          type: data?.data?.voiceaPayload?.type,\n        });\n      }\n    };\n  }\n\n  /**\n   * Close the LLM web socket connection\n   * @returns {void}\n   */\n  closeSocket() {\n    this.webSocket.close();\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAkC;AAAA;AAAA;AAElC;AACA;AACA;AACA;AACA;AAJA,IAKqBA,aAAa;EAOhC;AACF;AACA;AACA;AACA;AACA;AACA;EACE,uBAAYC,YAAoB,EAAEC,SAAc,EAAEC,OAAe,EAAE;IAAA;IAAA;IAAA;IAAA;IAAA;IAAA;IACjE,IAAI,CAACF,YAAY,GAAGA,YAAY;IAChC,IAAI,CAACG,SAAS,GAAGF,SAAS;IAC1B,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACE,UAAU,GAAG,CAAC,CAAC;IAEpB,IAAMC,MAAM,GAAG,iEAAiE;IAEhF,IAAI,CAACC,SAAS,GAAG,IAAIC,SAAS,WAAI,IAAI,CAACP,YAAY,SAAGK,MAAM,EAAG;EACjE;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EAPE;IAAA;IAAA,OAQA,iBAAQG,KAAa,EAAE;MAAA;MACrB,IAAI,CAACF,SAAS,CAACG,MAAM,GAAG,YAAM;QAC5B,KAAI,CAACH,SAAS,CAACI,IAAI,CACjB,wBAAe;UACbC,EAAE,EAAE,IAAAC,QAAM,GAAE;UACZC,IAAI,EAAE,eAAe;UACrBC,IAAI,EAAE;YAACN,KAAK,mBAAYA,KAAK;UAAE,CAAC;UAChCO,UAAU,yBAAkB,KAAI,CAACZ,SAAS,SAAG,aAASa,QAAQ,EAAE;QAClE,CAAC,CAAC,CACH;MACH,CAAC;IACH;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAA;IAAA,OAMA,uBAAcC,QAAa,EAAE;MAC3B,IAAIA,QAAQ,EAAE;QACZ,IAAI,CAACX,SAAS,CAACY,OAAO,GAAG,UAACC,KAAK,EAAK;UAClCF,QAAQ,CAACE,KAAK,CAAC;QACjB,CAAC;MACH;IACF;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAA;IAAA,OAOA,uBAAcF,QAAa,EAAE;MAC3B,IAAIA,QAAQ,EAAE;QACZ,IAAI,CAACX,SAAS,CAACc,OAAO,GAAG,UAACD,KAAK,EAAK;UAClCF,QAAQ,CAACE,KAAK,CAAC;QACjB,CAAC;MACH;IACF;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAA;IAAA,OAOA,oBAAmBE,IAAS,EAAE;MAAA;MAAA,2CACVA,IAAI;QAAA;MAAA;QAAtB,oDAAwB;UAAA,IAAbC,GAAG;UACZ,IAAMC,MAAM,GAAG,IAAI,CAACnB,UAAU,CAACkB,GAAG,CAAC;UAEnC,IAAIC,MAAM,EAAE;YACV,OAAOA,MAAM;UACf;QACF;MAAC;QAAA;MAAA;QAAA;MAAA;MAED,OAAO,qBAAc,IAAI,CAACrB,OAAO,CAACsB,iBAAiB,CAACtB,OAAO,CAAC,CAACuB,IAAI,CAAC,UAACF,MAAW,EAAK;QACjF,IAAMnB,UAAU,GAAGmB,MAAM,CAACG,WAAW,CAACC,MAAM,CAACN,IAAI;QACjD,IAAIO,cAAc,GAAG,KAAK;QAAC,4CAETP,IAAI;UAAA;QAAA;UAAtB,uDAAwB;YAAA,IAAbC,GAAG;YACZ,IAAIlB,UAAU,CAACyB,QAAQ,CAACP,GAAG,CAAC,EAAE;cAC5B,MAAI,CAAClB,UAAU,CAACkB,GAAG,CAAC,GAAGC,MAAM;cAC7BK,cAAc,GAAG,IAAI;cACrB;YACF;UACF;QAAC;UAAA;QAAA;UAAA;QAAA;QAED,OAAOA,cAAc;MACvB,CAAC,CAAC;IACJ;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAA;IAAA,OAMA,mBAAUX,QAAa,EAAE;MAAA;MACvB,IAAIH,IAAI;MACR,IAAIO,IAAI;MACR,IAAIS,OAAO;MACX,IAAIC,aAAa;MAEjB,IAAI,CAACzB,SAAS,CAAC0B,SAAS,GAAG,UAACb,KAAK,EAAK;QAAA;QACpCL,IAAI,GAAGmB,IAAI,CAACC,KAAK,CAACf,KAAK,CAACL,IAAI,CAAC;QAC7BO,IAAI,GAAG,eAAAP,IAAI,CAACA,IAAI,wEAAT,WAAWqB,aAAa,0DAAxB,sBAA0Bd,IAAI,KAAI,EAAE;QAC3CS,OAAO,GAAG,MAAI,CAACM,UAAU,CAACf,IAAI,CAAC;QAC/BU,aAAa,GAAG,gBAAAjB,IAAI,CAACA,IAAI,yEAAT,YAAWqB,aAAa,0DAAxB,sBAA0BrB,IAAI,KAAI,EAAE;QAEpD,MAAI,CAACR,SAAS,CAACI,IAAI,CAAC,wBAAe;UAAC2B,SAAS,EAAEvB,IAAI,CAACH,EAAE;UAAEE,IAAI,EAAE;QAAK,CAAC,CAAC,CAAC;QAEtE,IAAIkB,aAAa,EAAE;UAAA;UACjBd,QAAQ,CAAC;YACPN,EAAE,iBAAEG,IAAI,CAACA,IAAI,yEAAT,YAAWqB,aAAa,0DAAxB,sBAA0BG,aAAa;YAC3CC,QAAQ,cAAET,OAAO,6CAAP,SAASnB,EAAE;YACrBoB,aAAa,EAAbA,aAAa;YACbS,SAAS,EAAE1B,IAAI,CAAC0B,SAAS;YACzB3B,IAAI,WAAEC,IAAI,yDAAJ,MAAMA,IAAI,yEAAV,YAAYqB,aAAa,0DAAzB,sBAA2BtB;UACnC,CAAC,CAAC;QACJ;MACF,CAAC;IACH;;IAEA;AACF;AACA;AACA;EAHE;IAAA;IAAA,OAIA,uBAAc;MACZ,IAAI,CAACP,SAAS,CAACmC,KAAK,EAAE;IACxB;EAAC;EAAA;AAAA;AAAA"}

package/internal-README.md

@@ -48,7 +48,7 @@ Install tooling dependencies.
 npm install
 ```
 
-*Build issues?* See [BUILD-ISSUES.md](https://github.com/webex/webex-js-sdk/blob/master/BUILD-ISSUES.md) for help.
+_Build issues?_ See [BUILD-ISSUES.md](https://github.com/webex/webex-js-sdk/blob/master/BUILD-ISSUES.md) for help.
 
 ## Contribute to the `plugin-meetings` branch
 
@@ -93,12 +93,14 @@ yarn run build
 ```
 
 > Individual packages containing samples can usually be run this way:
+>
 > ```
 > yarn run serve:package --env.package @webex/plugin-meetings
+> ```
 
 > ```
 > However, `webex` does not get compiled properly for `plugin-meetings` using this method, so do the following instead.
-
+> ```
 
 ```bash
 # Run the "sample app" sample.
@@ -107,8 +109,8 @@ yarn run samples:meetings
 ```
 
 - Visit https://localhost:8000/
-- Copy/paste **Your Personal Access Token** from [Cisco Webex for Developers](https://developer.webex.com/docs/api/getting-started) and click *connect*.
-- Use the **Dialer** to *create* a Meeting object, *join* it, and *addMedia*, like video and audio.
+- Copy/paste **Your Personal Access Token** from [Cisco Webex for Developers](https://developer.webex.com/docs/api/getting-started) and click _connect_.
+- Use the **Dialer** to _create_ a Meeting object, _join_ it, and _addMedia_, like video and audio.
 
 > This sample does not join a meeting in one click on purpose. It is meant to demonstrate the different commands available, and their sequence, to developers. Other samples will be created in the future.
 >
@@ -124,7 +126,6 @@ yarn run samples:meetings
 
 Use `yarn run distsrc` to point each package's `main` entry at the raw src and let `babel` compile on the fly.
 
-
 ```bash
 # Point all package.json files to the src directory instead of the dist directory.
 yarn run distsrc
@@ -156,7 +157,7 @@ yarn run srcdist
 
 The SDK enforces relatively strict commit messages to version its packages and keep language similar.
 
-Here is an example committing a new feature. Notice the *package name* in parentheses.
+Here is an example committing a new feature. Notice the _package name_ in parentheses.
 
 ```bash
 git commit -a -m 'feat(plugin-meetings): add ability to join a meeting'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.2",
+  "version": "3.0.0-beta.20",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [
@@ -12,6 +12,7 @@
     "Taymoor Khan <taykhan@cisco.com>"
   ],
   "main": "dist/index.js",
+  "types": "types/index.d.ts",
   "devMain": "src/index.js",
   "repository": {
     "type": "git",
@@ -27,13 +28,16 @@
       "envify"
     ]
   },
+  "scripts": {
+    "build": "yarn run -T tsc --declaration true --declarationDir ./types"
+  },
   "devDependencies": {
-    "@webex/plugin-meetings": "3.0.0-beta.2",
-    "@webex/test-helper-chai": "3.0.0-beta.2",
-    "@webex/test-helper-mocha": "3.0.0-beta.2",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.2",
-    "@webex/test-helper-retry": "3.0.0-beta.2",
-    "@webex/test-helper-test-users": "3.0.0-beta.2",
+    "@webex/plugin-meetings": "3.0.0-beta.20",
+    "@webex/test-helper-chai": "3.0.0-beta.20",
+    "@webex/test-helper-mocha": "3.0.0-beta.20",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.20",
+    "@webex/test-helper-retry": "3.0.0-beta.20",
+    "@webex/test-helper-test-users": "3.0.0-beta.20",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
@@ -41,18 +45,19 @@
     "typed-emitter": "^2.1.0"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.2",
-    "@webex/internal-media-core": "^0.0.16-beta",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.2",
-    "@webex/internal-plugin-device": "3.0.0-beta.2",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.2",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.2",
-    "@webex/internal-plugin-support": "3.0.0-beta.2",
-    "@webex/internal-plugin-user": "3.0.0-beta.2",
-    "@webex/plugin-people": "3.0.0-beta.2",
-    "@webex/plugin-rooms": "3.0.0-beta.2",
-    "@webex/ts-sdp": "^1.0.1",
-    "@webex/webex-core": "3.0.0-beta.2",
+    "@webex/common": "3.0.0-beta.20",
+    "@webex/internal-media-core": "1.33.0",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.20",
+    "@webex/internal-plugin-device": "3.0.0-beta.20",
+    "@webex/internal-plugin-llm": "3.0.0-beta.20",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.20",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.20",
+    "@webex/internal-plugin-support": "3.0.0-beta.20",
+    "@webex/internal-plugin-user": "3.0.0-beta.20",
+    "@webex/plugin-people": "3.0.0-beta.20",
+    "@webex/plugin-rooms": "3.0.0-beta.20",
+    "@webex/webex-core": "3.0.0-beta.20",
+    "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",
     "dotenv": "^4.0.0",
@@ -62,6 +67,6 @@
     "lodash": "^4.17.21",
     "sdp-transform": "^2.12.0",
     "uuid": "^3.3.2",
-    "webrtc-adapter": "^7.7.0"
+    "webrtc-adapter": "^8.1.2"
   }
 }

package/src/breakouts/README.md

@@ -0,0 +1,190 @@
+# Breakout Sessions
+
+Breakout sessions are like meetings within meetings. They have separate roster lists and titles. Participants can move between breakouts and the main session.
+
+### Enabling
+
+To enable breakouts the `breakoutsSupported` parameter must be passed to the meeting join method.
+
+### Structure
+
+The current breakout session is accessible as follows:
+
+```javascript
+breakouts.currentBreakoutSession;
+```
+
+Other breakout sessions are available in the breakouts collection. These are breakouts that you known about. If you are an attendee, you may not know about all the breakout sessions in the meeting.
+
+```javascript
+breakouts.breakouts;
+```
+
+note: The `currentBreakoutSession` is NOT a member of the `breakouts.breakouts` collection.
+
+Some information about the state of breakouts is available on the `meeting.breakouts` object itself
+
+```javascript
+// The number of seconds after ending breakouts before the participants are returned to the main session
+breakouts.delayCloseTime;
+
+// Whether the participant is allowed back to the main session
+breakouts.allowBackToMain;
+```
+
+### Attendee functionality
+
+The normal meeting members are updated when you move in and out of a breakout session.
+
+The following are methods available to attendees of a meeting:
+
+```javascript
+// Join a breakout
+// This can be used when the participant is in the main session or in a different breakout session
+breakout.join();
+
+// Leave a breakout
+// This will cause the participant to return to the main session
+breakouts.currentBreakoutSession.leave();
+
+// Ask for help when in a breakout session. 10 second cooldown.
+breakout.currentBreakoutSession.askForHelp();
+```
+
+#### Members
+
+Each breakout session has members. Members represent other entities within the meeting.
+The current breakout session members are accessed via the meeting object i.e. they will automatically
+be updated when the user moves between sessions.
+
+To see which members are in other sessions, you can access them via the breakout model. The Members
+class is the same as that of the main meeting.
+
+```javascript
+breakout = breakouts.breakouts.models[0];
+breakout.members;
+```
+
+#### breakouts events
+
+```javascript
+// When the breakouts in the breakouts collection changes. This includes updates to session members
+on('meeting:breakouts:update', (breakouts) => {});
+
+// When the breakout sessions end this event will be fired
+on('meeting:breakouts:closing', () => {});
+
+// When the host sends a message to the breakout this event will fire
+on('meeting:breakouts:message', {senderUserId, sentTime, message, sessionId});
+```
+
+When breakouts are started there are several possibilities:
+
+1. The attendee is forced to join a session
+2. The attendee is assigned to a session, but can join when they feel like it
+3. The attendee is not assigned to a session, and can choose which session they want to join
+
+```javascript
+breakout.assigned; // Assigned to a session, but not in it yet
+breakout.assignedCurrent; // Forced to join a session
+breakout.active; // The session exists
+breakout.allowed; // The user is allowed to join the session
+breakout.requested; // The user has been requested to join the session
+```
+
+The above attributes of the breakout sessions, combined with the `meeting:breakouts:update` event allow you to determine which situation you are in.
+
+A host can signal attendees to move to a particular session. In this case the following is available. Using the same event, and the `requested` attribute of the breakout you can determine which session is to be moved to. Requesting return to the main session is the current use case of this.
+
+### Host functionality
+
+The following are methods available to a hosts of a meeting.
+
+note: None of these are currently implemented
+
+```javascript
+
+// Move a participant to breakout
+breakout.move(participant)
+
+// Assign a particpant to a breakout
+// Not sure whether there is any difference from move
+breakout.assign(participant)
+
+// Remove someone from a breakout session
+// This returns them to the main session
+breakout.remove(participant)
+
+// Deletes a breakout session
+// This can only be done when breakouts are inactive
+breakout.delete()
+
+// Create a breakout session
+breakouts.create(sessionName)
+
+// Rename an existing breakout session
+breakout.rename(newSessionName)
+
+// Start breakout sessions
+breakouts.start()
+
+// End breakout sessions
+breakouts.end()
+
+// Enable breakout sessions
+breakouts.enable()
+
+// Disable breakout sessions
+breakouts.disable()
+
+// Send message asking all participants to return to the main session
+breakouts.askAllToReturn()
+
+// Send a message to a breakout session
+// You can determine which participant types receive the message
+breakout.broadcast(message, {participants: boolean, cohosts: boolean, presenters: boolean})
+
+// Send a message to All breakout sessions
+// You can determine which participant types receive the message
+breakouts.broadcast(message, {participants: boolean, cohosts: boolean, presenters: boolean})
+
+// When breakouts are active you can cancel the automatic end of all sessions by calling this
+// method. It cannot be restarted, only manually ending breakouts is possible after calling this
+breakouts.cancelAutomaticEnd()
+
+IBreakoutConfig {
+  /*
+  Number of sessions to count down before returning users to main session. Seconds. Default 60. 0 means off
+  */
+  countdownTimer: Number,
+  /*
+  Whether attendees are allowed to return to the main meeting
+  */
+  allowReturntoMainMeeting: Boolean,
+  /*
+  Whether attendees are allowed to join later
+  */
+  allowJoinLater: Boolean,
+  /*
+  The timeout after which breakouts are automatically ended. Seconds. Default 1800 (30 minutes) Miniumum 5 minutes.
+  */
+  automaticallyEndBreakoutsAfter: Number,
+  /*
+  How participants are assigned to breakouts.
+  auto -> participants are automatically placed in sessions
+  */
+  assignmentMethod: 'auto' | 'manual' | 'choose'
+}
+
+// Configure settings on breakouts
+breakouts.configure(config)
+
+// set whether anyone can join the breakout or whether it is just assigned participants that can join
+breakout.setOpen(isOpen)
+
+// When the members change for a given breakout
+on('meeting:breakout:members:update', ({sessionId, members}) => {
+
+})
+
+```

package/src/breakouts/breakout.ts

@@ -0,0 +1,110 @@
+/*!
+ * Copyright (c) 2015-2023 Cisco Systems, Inc. See LICENSE file.
+ */
+
+import {WebexPlugin} from '@webex/webex-core';
+
+import {HTTP_VERBS, MEETINGS} from '../constants';
+import LocusInfo from '../locus-info';
+import Members from '../members';
+
+/**
+ * @class
+ */
+const Breakout = WebexPlugin.extend({
+  idAttribute: 'sessionId',
+
+  namespace: MEETINGS,
+
+  props: {
+    active: ['boolean', false, false], // this session is active
+    allowed: ['boolean', false, false], // allowed to join this session
+    assigned: ['boolean', false, false], // assigned to this session, but not necessarily joined yet
+    assignedCurrent: ['boolean', false, false], // assigned AND current session
+    requested: ['boolean', false, false], // requested by the host to join this session
+    current: ['boolean', false, false], // the current joined session
+    name: 'string',
+    sessionId: 'string',
+    sessionType: 'string',
+    groupId: 'string',
+    url: 'string', // where to send requests to
+  },
+
+  derived: {
+    isMain: {
+      deps: ['sessionType'],
+      /**
+       * If the breakout has no name, assume it is the main session
+       * @returns {boolean}
+       */
+      fn() {
+        return this.sessionType === 'MAIN';
+      },
+    },
+  },
+
+  initialize() {
+    this.members = new Members({}, {parent: this.webex});
+  },
+
+  /**
+   * Joins the breakout session
+   * @returns {Promise}
+   */
+  join() {
+    return this.request({
+      method: HTTP_VERBS.POST,
+      uri: `${this.url}/move`,
+      body: {
+        groupId: this.groupId,
+        sessionId: this.sessionId,
+      },
+    });
+  },
+
+  /**
+   * Leaves the breakout session to return to the main session
+   * @returns {Promise}
+   * @throws {Error} if an attempt is made to leave the main session or if the main session cannot be found
+   */
+  leave() {
+    if (this.isMain) {
+      throw new Error('Cannot leave the main session');
+    }
+
+    const mainSession = this.parent.breakouts.filter((breakout) => breakout.isMain)[0];
+
+    if (!mainSession) {
+      throw new Error('Cannot leave, no main session found');
+    }
+
+    return mainSession.join();
+  },
+
+  /**
+   * Sends a help request for the current breakout
+   * @returns {Promise}
+   */
+  askForHelp() {
+    return this.request({
+      method: HTTP_VERBS.POST,
+      uri: `${this.url}/help`,
+      body: {
+        groupId: this.groupId,
+        sessionId: this.sessionId,
+      },
+    });
+  },
+
+  /**
+   * Parses the participants from the locus object
+   * @param locus Locus object
+   * @returns {void}
+   */
+
+  parseRoster(locus) {
+    this.members.locusParticipantsUpdate(locus);
+  },
+});
+
+export default Breakout;

package/src/breakouts/collection.ts

@@ -0,0 +1,19 @@
+/*!
+ * Copyright (c) 2015-2023 Cisco Systems, Inc. See LICENSE file.
+ */
+
+import AmpCollection from 'ampersand-collection';
+
+import {MEETINGS} from '../constants';
+
+import Breakout from './breakout';
+
+const BreakoutCollection = AmpCollection.extend({
+  model: Breakout,
+
+  namespace: MEETINGS,
+
+  mainIndex: 'sessionId',
+});
+
+export default BreakoutCollection;