bigbluebutton-html-plugin-sdk 0.0.66 → 0.0.68

package/README.md

@@ -22,6 +22,8 @@ For development purposes you can run a plugin locally from source.
 For example if you take the [`sample-action-button-dropdown-plugin`](samples/sample-action-button-dropdown-plugin),
 you do the following:
 
+*Running from source code with local BBB-server*
+
 1. Start the development server:
 
    ```bash
@@ -29,19 +31,59 @@ you do the following:
    npm install
    npm start
    ```
-2. Add reference to it on BigBlueButton's `settings.yml`:
 
-   ```yaml
-   public:
-     plugins:
-       - name: SampleActionButtonDropdownPlugin
-         url: http://127.0.0.1:4701/static/SampleActionButtonDropdownPlugin.js
-   ```
+2. Add reference to it on BigBlueButton's `/create` call or add it on `/usr/share/bbb-web/WEB-INF/classes/bigbluebutton.properties`:
+
+```
+pluginsManifests=[{"url": "http://localhost:4701/manifest.json"}]
+```
+
+*Running from souce code with a remote BBB-server*
+
+If you are running your BBB-server elsewhere, than you can't simply point the manifest URL to a local address, you'll need to either serve the built version into a CDN or serve the dev version using a service to make it public. And for the second option we'd recommend NGROK. Here are the instructions to do that:
+
+1. Create an account on https://ngrok.com/ (Official website of NGROK);
+
+2. Install NGROK in your computer. They have a guide for that right after you created your account;
+
+3. Start the Plugin development server:
+
+```bash
+cd $HOME/src/plugin-pick-random-user-plugin
+npm install
+npm start
+```
+
+4. Start the NGROK server into your machine with the following command:
+
+```bash
+ngrok http http://172.17.0.1:4701
+```
+
+Make sure to point NGROK to the correct local URL (In our case - The samples are made this way, for instance - we used `http://172.17.0.1:4701`)
+
+Right after that, NGROK will create an interface into your terminal and will display the URL which your static files are being served.
+
+Here's an example of URL: `https://<uuid>.ngrok-free.app`
+
+You can already interact with this URL and access both 
 
-_N.B.:_ Be aware that in this case the url is interpreted from the plugin in the browser,
-so the localhost is actually your local development machine.
+`https://<uuid>.ngrok-free.app/manifest.json`
 
-### Building the Plugin
+or
+
+`https://<uuid>.ngrok-free.app/PickRandomUserPlugin.js`
+
+
+5. Add this create parameter into the API-mate of the server you are testing it on:
+
+```
+pluginsManifests=[{"url": "https://<uuid>.ngrok-free.app/manifest.json"}]
+```
+
+And there you go, you can test it freely.
+
+### Building the Plugin (Production)
 
 To build a plugin for production use
 (again, using the example of [`sample-action-button-dropdown-plugin`](samples/sample-action-button-dropdown-plugin)),
@@ -53,26 +95,20 @@ npm install
 npm run build-bundle
 ```
 
-The above command will generate the `dist` folder, containing the bundled JavaScript file named `SampleActionButtonDropdownPlugin.js`.
-This file can be hosted on any HTTPS server.
+The above command will generate the `dist` folder, containing the bundled JavaScript file named `SampleActionButtonDropdownPlugin.js` along with the `manifest.json`.
+These files can be hosted on any HTTPS server.
 
-To use the plugin with BigBlueButton, add the plugin's URL to `settings.yml` as shown below:
+To use the plugin with BigBlueButton, add the plugin's `manifest.json` URL to `bigbluebutton.properties` or you can simply send it via `/create` parameter:
 
-```yaml
-public:
-  app:
-    ... // All app configurations
-  plugins:
-    - name: SampleActionButtonDropdownPlugin
-      url: <<PLUGIN_URL>>
-  ... // All other configurations
+```
+pluginManifests=[{"url":"<your-domain>/path/to/manifest.json"}]
 ```
 
 #### Hosting the Plugin on a BBB Server
 
 While the plugin can be hosted on any Server, it is also possible to host the bundled file directly on
-a BigBlueButton server. For that you copy the `dist/SampleActionButtonDropdownPlugin.js` to the folder `/var/www/bigbluebutton-default/assets/plugins`.
-In this case, the `<<PLUGIN_URL>>` will be `https://<your-host>/plugins/SampleActionButtonDropdownPlugin.js`.
+a BigBlueButton server. For that you copy `dist/SampleActionButtonDropdownPlugin.js` and `dist/manifest.json` to the folder `/var/www/bigbluebutton-default/assets/plugins/sampleActionButtonDropdownPlugin`.
+In this case, the your manifest URL will be `https://<your-host>/plugins/sampleActionButtonDropdownPlugin/manifest.json`.
 
 ## API
 
@@ -251,6 +287,8 @@ One other thing is that the type of the return is precisely the same type requir
   - close: this function will close the presentation area content automatically;
 - conference:
   - setSpeakerLevel: this function will set the speaker volume level(audio output) of the conference to a certain number between 0 and 1;
+- notification:
+  - send: This function will send a notification for the client to render, keep in mind that it's only client-side. Should you want it to be rendered in multiple clients, use this with a data-channel;
 - user-status:
   - setAwayStatus: this function will set the away status of the user to a certain status;
 
@@ -397,7 +435,7 @@ module.exports = {
 ```
 
 **Does the builded plugin need to be in the same BBB server?**
-No, feel free to host it anywhere you want, just make sure to point the URL from `settings.yml`correctly.
+No, feel free to host it anywhere you want, just make sure to point the URL from `manifest.json` correctly (into the create endpoint or `bigbluebutton.properties`).
 
 **I am making my plugin based on a sample inside the SDK, but somehow, the sample is not working properly, what do I do to run it in dev mode and make it work?**
 Well there are several motives to why the sample is not working properly, so I will go through each one of them briefly:

package/dist/cjs/core/api/BbbPluginSdk.js

@@ -23,6 +23,7 @@ var hooks_12 = require("../../data-consumption/domain/meeting/from-core/hooks");
 var commands_2 = require("../../server-commands/commands");
 var hooks_13 = require("../../learning-analytics-dashboard/hooks");
 var utils_1 = require("../../remote-data/utils");
+var hooks_14 = require("../../event-persistence/hooks");
 /**
  * Class responsible for either initialize or get the PluginApi
  *
@@ -71,6 +72,7 @@ var BbbPluginSdk = /** @class */ (function () {
             pluginApi.serverCommands = (0, commands_2.serverCommands)(pluginName);
             pluginApi.sendGenericDataForLearningAnalyticsDashboard = function (data) { return (0, hooks_13.sendGenericDataForLearningAnalyticsDashboard)(data, pluginName); };
             pluginApi.getRemoteData = function (dataSourceName) { return (0, utils_1.getRemoteData)(dataSourceName, pluginName); };
+            pluginApi.persistEvent = function (eventName, payload) { return (0, hooks_14.persistEventFunctionWrapper)(pluginName, eventName, payload); };
         }
         else {
             throw new Error('Plugin name not set');

package/dist/cjs/core/api/BbbPluginSdk.js.map

@@ -1 +1 @@
-{"version":3,"file":"BbbPluginSdk.js","sourceRoot":"","sources":["../../../../src/core/api/BbbPluginSdk.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,+BAAkC;AAOlC,kDAA4D;AAO5D,uDAAwD;AAQxD,kDAAiE;AACjE,gGAEgF;AAChF,wFAEwE;AACxE,oFAA+F;AAC/F,gFAAwF;AACxF,oFAA+F;AAC/F,4DAAoE;AACpE,uDAA0D;AAC1D,mEAA2E;AAE3E,uFAAsG;AACtG,2EAA8F;AAC9F,0EAA4F;AAE5F,2FAAuG;AACvG,oDAAsD;AAEtD,gFAAmF;AACnF,2DAAgE;AAChE,mEAAwG;AAExG,iDAAwD;AAIxD;;;;;;GAMG;AACH;IAAA;IAuHA,CAAC;IAtHC;;;;;;;;;;OAUG;IACW,uBAAU,GAAxB,UAAyB,IAAY;QACnC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,wFAAwF,CAAC,CAAC;QAC1I,IAAM,SAAS,GAAc,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACtD,SAAS,CAAC,qBAAqB,GAAG,CAAC,UACjC,KAAa,EACb,sBAAsD,IACnD,OAAA,IAAA,6BAAqB,EAAC,KAAK,EAAE,sBAAsB,CAAC,EAApD,CAAoD,CAAkC,CAAC;QAC5F,SAAS,CAAC,sBAAsB,GAAG,CACjC,cAAM,OAAA,IAAA,8BAAsB,GAAE,EAAxB,CAAwB,CAAmC,CAAC;QACpE,SAAS,CAAC,iBAAiB,GAAG,CAAC,cAAM,OAAA,IAAA,yBAAiB,GAAE,EAAnB,CAAmB,CAA8B,CAAC;QACvF,SAAS,CAAC,cAAc,GAAG,CAAC,cAAM,OAAA,IAAA,sBAAc,GAAE,EAAhB,CAAgB,CAA2B,CAAC;QAC9E,SAAS,CAAC,UAAU,GAAG,CAAC,cAAM,OAAA,IAAA,mBAAU,GAAE,EAAZ,CAAY,CAAuB,CAAC;QAClE,SAAS,CAAC,iBAAiB,GAAG,CAAC,cAAM,OAAA,IAAA,yBAAiB,GAAE,EAAnB,CAAmB,CAA8B,CAAC;QACvF,SAAS,CAAC,mBAAmB,GAAG,CAAC,cAAM,OAAA,IAAA,4BAAmB,GAAE,EAArB,CAAqB,CAAgC,CAAC;QAC7F,SAAS,CAAC,qBAAqB,GAAG,CAChC,cAAM,OAAA,IAAA,6BAAqB,GAAE,EAAvB,CAAuB,CAAkC,CAAC;QAClE,SAAS,CAAC,yBAAyB,GAAG,UACpC,UAAoB,IACjB,OAAA,IAAA,iCAAyB,EAAC,UAAU,EAAE,IAAI,CAAC,EAA3C,CAA2C,CAAC;QACjD,SAAS,CAAC,wBAAwB,GAAG,UACnC,SAAmB,IAChB,OAAA,IAAA,gCAAwB,EAAC,SAAS,EAAE,IAAI,CAAC,EAAzC,CAAyC,CAAC;QAC/C,SAAS,CAAC,UAAU,GAAG,qBAAU,CAAC;QAClC,SAAS,CAAC,SAAS,GAAG,kBAAS,CAAC;QAChC,IAAM,UAAU,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,UAAU,CAAC;QACzC,IAAI,UAAU,EAAE;YACd,SAAS,CAAC,cAAc,GAAG,CAAC,UAC1B,WAAmB,EACnB,eAA8D,EAC9D,cAAkC;gBADlC,gCAAA,EAAA,kBAAoC,wBAAgB,CAAC,SAAS;gBAC9D,+BAAA,EAAA,0BAAkC;gBAC/B,OAAA,IAAA,6BAAqB,EACxB,WAAW,EACX,cAAc,EACd,UAAU,EACV,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EACxB,eAAe,CAChB;YANI,CAMJ,CAAwC,CAAC;YAC1C,SAAS,CAAC,iBAAiB,GAAG,cAAM,OAAA,IAAA,4BAAiB,EAAC,UAAU,CAAC,EAA7B,CAA6B,CAAC;YAClE,SAAS,CAAC,cAAc,GAAG,IAAA,yBAAc,EAAC,UAAU,CAAC,CAAC;YACtD,SAAS,CAAC,4CAA4C,GAAG,UACvD,IAA8C,IAC3C,OAAA,IAAA,qDAA4C,EAAC,IAAI,EAAE,UAAU,CAAC,EAA9D,CAA8D,CAAC;YACpE,SAAS,CAAC,aAAa,GAAG,UACxB,cAAsB,IACnB,OAAA,IAAA,qBAAa,EAAC,cAAc,EAAE,UAAU,CAAC,EAAzC,CAAyC,CAAC;SAChD;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SACxC;IACH,CAAC;IAEc,+BAAkB,GAAjC;QACE,IAAM,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC;QACzB,IAAI;YACF,OAAO,CAAC,KAAK,GAAG,cAAO,CAAC,CAAC;YACzB,IAAA,iBAAS,EAAC,cAAO,CAAC,EAAE,EAAE,CAAC,CAAC;SACzB;QAAC,WAAM;YACN,OAAO,CAAC,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,CAAC,KAAK,CAAC,8GAA8G,CAAC,CAAC;YAC9H,OAAO,KAAK,CAAC;SACd;QACD,OAAO,CAAC,KAAK,GAAG,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACW,yBAAY,GAA1B,UAA2B,IAAY,EAAE,UAAmB;QAC1D,IAAI,CAAC,MAAM,CAAC,WAAW;YAAE,MAAM,CAAC,WAAW,GAAG,EAAE,CAAC;QACjD,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE;YACxD,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG;gBACzB,wBAAwB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAClC,2BAA2B,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACrC,4BAA4B,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACtC,kBAAkB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAC5B,6BAA6B,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACvC,4BAA4B,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACtC,cAAc,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACxB,yBAAyB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACnC,wBAAwB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAClC,uBAAuB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACjC,8BAA8B,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACxC,0BAA0B,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACpC,oCAAoC,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAC9C,kBAAkB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAC5B,sBAAsB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAChC,uBAAuB,EAAE;oBACvB,EAAE,EAAE,cAAO,CAAC;iBACb;gBACD,eAAe,EAAE,cAAM,OAAA,IAAA,wBAAe,GAAE,EAAjB,CAAiB;gBACxC,UAAU,EAAE,UAAC,MAAM,IAAK,OAAA,IAAA,mBAAU,EAAC,MAAM,CAAC,EAAlB,CAAkB;gBAC1C,UAAU,YAAA;aACX,CAAC;SACH;QAED,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IACH,mBAAC;AAAD,CAAC,AAvHD,IAuHC;AAvHqB,oCAAY"}
+{"version":3,"file":"BbbPluginSdk.js","sourceRoot":"","sources":["../../../../src/core/api/BbbPluginSdk.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,+BAAkC;AAOlC,kDAA4D;AAO5D,uDAAwD;AAQxD,kDAAiE;AACjE,gGAEgF;AAChF,wFAEwE;AACxE,oFAA+F;AAC/F,gFAAwF;AACxF,oFAA+F;AAC/F,4DAAoE;AACpE,uDAA0D;AAC1D,mEAA2E;AAE3E,uFAAsG;AACtG,2EAA8F;AAC9F,0EAA4F;AAE5F,2FAAuG;AACvG,oDAAsD;AAEtD,gFAAmF;AACnF,2DAAgE;AAChE,mEAAwG;AAExG,iDAAwD;AACxD,wDAA4E;AAI5E;;;;;;GAMG;AACH;IAAA;IA+HA,CAAC;IA9HC;;;;;;;;;;OAUG;IACW,uBAAU,GAAxB,UAAyB,IAAY;QACnC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,wFAAwF,CAAC,CAAC;QAC1I,IAAM,SAAS,GAAc,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACtD,SAAS,CAAC,qBAAqB,GAAG,CAAC,UACjC,KAAa,EACb,sBAAsD,IACnD,OAAA,IAAA,6BAAqB,EAAC,KAAK,EAAE,sBAAsB,CAAC,EAApD,CAAoD,CAAkC,CAAC;QAC5F,SAAS,CAAC,sBAAsB,GAAG,CACjC,cAAM,OAAA,IAAA,8BAAsB,GAAE,EAAxB,CAAwB,CAAmC,CAAC;QACpE,SAAS,CAAC,iBAAiB,GAAG,CAAC,cAAM,OAAA,IAAA,yBAAiB,GAAE,EAAnB,CAAmB,CAA8B,CAAC;QACvF,SAAS,CAAC,cAAc,GAAG,CAAC,cAAM,OAAA,IAAA,sBAAc,GAAE,EAAhB,CAAgB,CAA2B,CAAC;QAC9E,SAAS,CAAC,UAAU,GAAG,CAAC,cAAM,OAAA,IAAA,mBAAU,GAAE,EAAZ,CAAY,CAAuB,CAAC;QAClE,SAAS,CAAC,iBAAiB,GAAG,CAAC,cAAM,OAAA,IAAA,yBAAiB,GAAE,EAAnB,CAAmB,CAA8B,CAAC;QACvF,SAAS,CAAC,mBAAmB,GAAG,CAAC,cAAM,OAAA,IAAA,4BAAmB,GAAE,EAArB,CAAqB,CAAgC,CAAC;QAC7F,SAAS,CAAC,qBAAqB,GAAG,CAChC,cAAM,OAAA,IAAA,6BAAqB,GAAE,EAAvB,CAAuB,CAAkC,CAAC;QAClE,SAAS,CAAC,yBAAyB,GAAG,UACpC,UAAoB,IACjB,OAAA,IAAA,iCAAyB,EAAC,UAAU,EAAE,IAAI,CAAC,EAA3C,CAA2C,CAAC;QACjD,SAAS,CAAC,wBAAwB,GAAG,UACnC,SAAmB,IAChB,OAAA,IAAA,gCAAwB,EAAC,SAAS,EAAE,IAAI,CAAC,EAAzC,CAAyC,CAAC;QAC/C,SAAS,CAAC,UAAU,GAAG,qBAAU,CAAC;QAClC,SAAS,CAAC,SAAS,GAAG,kBAAS,CAAC;QAChC,IAAM,UAAU,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,UAAU,CAAC;QACzC,IAAI,UAAU,EAAE;YACd,SAAS,CAAC,cAAc,GAAG,CAAC,UAC1B,WAAmB,EACnB,eAA8D,EAC9D,cAAkC;gBADlC,gCAAA,EAAA,kBAAoC,wBAAgB,CAAC,SAAS;gBAC9D,+BAAA,EAAA,0BAAkC;gBAC/B,OAAA,IAAA,6BAAqB,EACxB,WAAW,EACX,cAAc,EACd,UAAU,EACV,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EACxB,eAAe,CAChB;YANI,CAMJ,CAAwC,CAAC;YAC1C,SAAS,CAAC,iBAAiB,GAAG,cAAM,OAAA,IAAA,4BAAiB,EAAC,UAAU,CAAC,EAA7B,CAA6B,CAAC;YAClE,SAAS,CAAC,cAAc,GAAG,IAAA,yBAAc,EAAC,UAAU,CAAC,CAAC;YACtD,SAAS,CAAC,4CAA4C,GAAG,UACvD,IAA8C,IAC3C,OAAA,IAAA,qDAA4C,EAAC,IAAI,EAAE,UAAU,CAAC,EAA9D,CAA8D,CAAC;YACpE,SAAS,CAAC,aAAa,GAAG,UACxB,cAAsB,IACnB,OAAA,IAAA,qBAAa,EAAC,cAAc,EAAE,UAAU,CAAC,EAAzC,CAAyC,CAAC;YAC/C,SAAS,CAAC,YAAY,GAAG,UACvB,SAAiB,EACjB,OAAU,IACP,OAAA,IAAA,oCAA2B,EAC5B,UAAU,EACV,SAAS,EACT,OAAO,CACR,EAJE,CAIF,CAAC;SACL;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SACxC;IACH,CAAC;IAEc,+BAAkB,GAAjC;QACE,IAAM,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC;QACzB,IAAI;YACF,OAAO,CAAC,KAAK,GAAG,cAAO,CAAC,CAAC;YACzB,IAAA,iBAAS,EAAC,cAAO,CAAC,EAAE,EAAE,CAAC,CAAC;SACzB;QAAC,WAAM;YACN,OAAO,CAAC,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,CAAC,KAAK,CAAC,8GAA8G,CAAC,CAAC;YAC9H,OAAO,KAAK,CAAC;SACd;QACD,OAAO,CAAC,KAAK,GAAG,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACW,yBAAY,GAA1B,UAA2B,IAAY,EAAE,UAAmB;QAC1D,IAAI,CAAC,MAAM,CAAC,WAAW;YAAE,MAAM,CAAC,WAAW,GAAG,EAAE,CAAC;QACjD,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE;YACxD,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG;gBACzB,wBAAwB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAClC,2BAA2B,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACrC,4BAA4B,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACtC,kBAAkB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAC5B,6BAA6B,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACvC,4BAA4B,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACtC,cAAc,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACxB,yBAAyB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACnC,wBAAwB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAClC,uBAAuB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACjC,8BAA8B,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACxC,0BAA0B,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACpC,oCAAoC,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAC9C,kBAAkB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAC5B,sBAAsB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAChC,uBAAuB,EAAE;oBACvB,EAAE,EAAE,cAAO,CAAC;iBACb;gBACD,eAAe,EAAE,cAAM,OAAA,IAAA,wBAAe,GAAE,EAAjB,CAAiB;gBACxC,UAAU,EAAE,UAAC,MAAM,IAAK,OAAA,IAAA,mBAAU,EAAC,MAAM,CAAC,EAAlB,CAAkB;gBAC1C,UAAU,YAAA;aACX,CAAC;SACH;QAED,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IACH,mBAAC;AAAD,CAAC,AA/HD,IA+HC;AA/HqB,oCAAY"}

package/dist/cjs/core/api/types.d.ts

@@ -31,6 +31,7 @@ import { SendGenericDataForLearningAnalyticsDashboard } from '../../learning-ana
 import { UseUserCameraDomElementsFunction } from '../../dom-element-manipulation/user-camera/types';
 import { ScreenshareHelperInterface, UserCameraHelperInterface } from '../../extensible-areas';
 import { GetDataSource } from '../../remote-data/types';
+import { PersistEventFunction } from '../../event-persistence/types';
 export type SetPresentationToolbarItems = (presentationToolbarItem: PresentationToolbarInterface[]) => string[];
 export type SetUserListDropdownItems = (userListDropdownItem: UserListDropdownInterface[]) => string[];
 export type SetActionButtonDropdownItems = (actionButtonDropdownInterface: ActionButtonDropdownInterface[]) => string[];
@@ -199,6 +200,14 @@ export interface PluginApi {
      *
      */
     getRemoteData?: GetDataSource;
+    /**
+     * Persists events to `events.xml` file.
+     *
+     * @param eventName - name of the event to be persisted in `events.xml`
+     * @param payload - payload to be persisted in `events.xml`
+     *
+     */
+    persistEvent?: PersistEventFunction;
 }
 export interface PluginBrowserWindow extends Window {
     bbb_plugins: {

package/dist/cjs/event-persistence/enums.d.ts

@@ -0,0 +1,3 @@
+export declare enum EventPersistenceEvents {
+    EVENT_PERSISTED = "PLUGIN_EVENT_PERSISTED"
+}

package/dist/cjs/event-persistence/enums.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventPersistenceEvents = void 0;
+var EventPersistenceEvents;
+(function (EventPersistenceEvents) {
+    EventPersistenceEvents["EVENT_PERSISTED"] = "PLUGIN_EVENT_PERSISTED";
+})(EventPersistenceEvents || (exports.EventPersistenceEvents = EventPersistenceEvents = {}));
+//# sourceMappingURL=enums.js.map

package/dist/cjs/event-persistence/enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../src/event-persistence/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,sBAEX;AAFD,WAAY,sBAAsB;IAChC,oEAA0C,CAAA;AAC5C,CAAC,EAFW,sBAAsB,sCAAtB,sBAAsB,QAEjC"}

package/dist/cjs/event-persistence/hooks.d.ts

@@ -0,0 +1 @@
+export declare const persistEventFunctionWrapper: <T = object>(pluginName: string, eventName: string, payload: T) => void;

package/dist/cjs/event-persistence/hooks.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.persistEventFunctionWrapper = void 0;
+var enums_1 = require("./enums");
+var persistEventFunctionWrapper = function (pluginName, eventName, payload) {
+    window.dispatchEvent(new CustomEvent(enums_1.EventPersistenceEvents.EVENT_PERSISTED, {
+        detail: {
+            pluginName: pluginName,
+            eventName: eventName,
+            payload: payload,
+        },
+    }));
+};
+exports.persistEventFunctionWrapper = persistEventFunctionWrapper;
+//# sourceMappingURL=hooks.js.map

package/dist/cjs/event-persistence/hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../../src/event-persistence/hooks.ts"],"names":[],"mappings":";;;AAGA,iCAAiD;AAE1C,IAAM,2BAA2B,GAAG,UACzC,UAAkB,EAClB,SAAiB,EACjB,OAAU;IAEV,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CACa,8BAAsB,CAAC,eAAe,EAAE;QAClE,MAAM,EAAE;YACN,UAAU,YAAA;YACV,SAAS,WAAA;YACT,OAAO,SAAA;SACR;KACF,CAAC,CACH,CAAC;AACJ,CAAC,CAAC;AAfW,QAAA,2BAA2B,+BAetC"}

package/dist/cjs/event-persistence/types.d.ts

@@ -0,0 +1,6 @@
+export interface EventPersistenceDetails<T = object> {
+    pluginName: string;
+    eventName: string;
+    payload: T;
+}
+export type PersistEventFunction = <T = object>(eventName: string, payload: T) => void;

package/dist/cjs/event-persistence/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/cjs/event-persistence/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/event-persistence/types.ts"],"names":[],"mappings":""}

package/dist/cjs/index.d.ts

@@ -3,5 +3,6 @@ export * from './data-consumption';
 export * from './data-channel';
 export * from './ui-data-hooks';
 export * from './server-commands';
+export * from './ui-commands';
 export * from './core';
 export * from './utils';

package/dist/cjs/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./data-consumption"), exports);
 __exportStar(require("./data-channel"), exports);
 __exportStar(require("./ui-data-hooks"), exports);
 __exportStar(require("./server-commands"), exports);
+__exportStar(require("./ui-commands"), exports);
 __exportStar(require("./core"), exports);
 __exportStar(require("./utils"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AAEnC,qDAAmC;AAEnC,iDAA+B;AAE/B,kDAAgC;AAEhC,oDAAkC;AAElC,yCAAuB;AAEvB,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AAEnC,qDAAmC;AAEnC,iDAA+B;AAE/B,kDAAgC;AAEhC,oDAAkC;AAElC,gDAA8B;AAE9B,yCAAuB;AAEvB,0CAAwB"}

package/dist/cjs/ui-commands/commands.d.ts

@@ -24,4 +24,7 @@ export declare const uiCommands: {
     conference: {
         setSpeakerLevel: (setSpeakerLevelCommandArguments: import("./conference/types").SetSpeakerLevelCommandArguments) => void;
     };
+    notification: {
+        send: (information: import("./notification/types").SendNotificationCommandArguments) => void;
+    };
 };

package/dist/cjs/ui-commands/commands.js

@@ -7,6 +7,7 @@ var commands_3 = require("./sidekick-options-container/commands");
 var commands_4 = require("./presentation-area/commands");
 var commands_5 = require("./user-status/commands");
 var commands_6 = require("./conference/commands");
+var commands_7 = require("./notification/commands");
 exports.uiCommands = {
     chat: commands_1.chat,
     externalVideo: commands_2.externalVideo,
@@ -14,5 +15,6 @@ exports.uiCommands = {
     presentationArea: commands_4.presentationArea,
     userStatus: commands_5.userStatus,
     conference: commands_6.conference,
+    notification: commands_7.notification,
 };
 //# sourceMappingURL=commands.js.map

package/dist/cjs/ui-commands/commands.js.map

@@ -1 +1 @@
-{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../src/ui-commands/commands.ts"],"names":[],"mappings":";;;AAAA,4CAAuC;AACvC,sDAA0D;AAC1D,kEAAiF;AACjF,yDAAgE;AAChE,mDAAoD;AACpD,kDAAmD;AAEtC,QAAA,UAAU,GAAG;IACxB,IAAI,iBAAA;IACJ,aAAa,0BAAA;IACb,wBAAwB,qCAAA;IACxB,gBAAgB,6BAAA;IAChB,UAAU,uBAAA;IACV,UAAU,uBAAA;CACX,CAAC"}
+{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../src/ui-commands/commands.ts"],"names":[],"mappings":";;;AAAA,4CAAuC;AACvC,sDAA0D;AAC1D,kEAAiF;AACjF,yDAAgE;AAChE,mDAAoD;AACpD,kDAAmD;AACnD,oDAAuD;AAE1C,QAAA,UAAU,GAAG;IACxB,IAAI,iBAAA;IACJ,aAAa,0BAAA;IACb,wBAAwB,qCAAA;IACxB,gBAAgB,6BAAA;IAChB,UAAU,uBAAA;IACV,UAAU,uBAAA;IACV,YAAY,yBAAA;CACb,CAAC"}

package/dist/cjs/ui-commands/index.d.ts

@@ -0,0 +1 @@
+export { NotificationTypeUiCommand } from './notification/enums';

package/dist/cjs/ui-commands/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationTypeUiCommand = void 0;
+var enums_1 = require("./notification/enums");
+Object.defineProperty(exports, "NotificationTypeUiCommand", { enumerable: true, get: function () { return enums_1.NotificationTypeUiCommand; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/ui-commands/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ui-commands/index.ts"],"names":[],"mappings":";;;AAAA,8CAAiE;AAAxD,kHAAA,yBAAyB,OAAA"}

package/dist/cjs/ui-commands/notification/commands.d.ts

@@ -0,0 +1,7 @@
+import { SendNotificationCommandArguments } from './types';
+export declare const notification: {
+    /**
+     * Sends notification to be rendered in the front-end.
+     */
+    send: (information: SendNotificationCommandArguments) => void;
+};

package/dist/cjs/ui-commands/notification/commands.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.notification = void 0;
+var enums_1 = require("./enums");
+exports.notification = {
+    /**
+     * Sends notification to be rendered in the front-end.
+     */
+    send: function (information) {
+        window.dispatchEvent(new CustomEvent(enums_1.NotificationEnum.SEND, {
+            detail: information,
+        }));
+    },
+};
+//# sourceMappingURL=commands.js.map

package/dist/cjs/ui-commands/notification/commands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../src/ui-commands/notification/commands.ts"],"names":[],"mappings":";;;AAAA,iCAA2C;AAG9B,QAAA,YAAY,GAAG;IAC1B;;OAEG;IACH,IAAI,EAAE,UAAC,WAA6C;QAClD,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAEb,wBAAgB,CAAC,IAAI,EAAE;YACvB,MAAM,EAAE,WAAW;SACpB,CAAC,CACH,CAAC;IACJ,CAAC;CACF,CAAC"}

package/dist/cjs/ui-commands/notification/enums.d.ts

@@ -0,0 +1,10 @@
+export declare enum NotificationEnum {
+    SEND = "SEND_NOTIFICATION"
+}
+export declare enum NotificationTypeUiCommand {
+    INFO = "info",
+    DEFAULT = "default",
+    WARNING = "warning",
+    SUCCESS = "success",
+    ERROR = "error"
+}

package/dist/cjs/ui-commands/notification/enums.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationTypeUiCommand = exports.NotificationEnum = void 0;
+var NotificationEnum;
+(function (NotificationEnum) {
+    NotificationEnum["SEND"] = "SEND_NOTIFICATION";
+})(NotificationEnum || (exports.NotificationEnum = NotificationEnum = {}));
+var NotificationTypeUiCommand;
+(function (NotificationTypeUiCommand) {
+    NotificationTypeUiCommand["INFO"] = "info";
+    NotificationTypeUiCommand["DEFAULT"] = "default";
+    NotificationTypeUiCommand["WARNING"] = "warning";
+    NotificationTypeUiCommand["SUCCESS"] = "success";
+    NotificationTypeUiCommand["ERROR"] = "error";
+})(NotificationTypeUiCommand || (exports.NotificationTypeUiCommand = NotificationTypeUiCommand = {}));
+//# sourceMappingURL=enums.js.map

package/dist/cjs/ui-commands/notification/enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../../src/ui-commands/notification/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,gBAEX;AAFD,WAAY,gBAAgB;IAC1B,8CAA0B,CAAA;AAC5B,CAAC,EAFW,gBAAgB,gCAAhB,gBAAgB,QAE3B;AAED,IAAY,yBAMX;AAND,WAAY,yBAAyB;IACnC,0CAAa,CAAA;IACb,gDAAmB,CAAA;IACnB,gDAAmB,CAAA;IACnB,gDAAmB,CAAA;IACnB,4CAAe,CAAA;AACjB,CAAC,EANW,yBAAyB,yCAAzB,yBAAyB,QAMpC"}

package/dist/cjs/ui-commands/notification/types.d.ts

@@ -0,0 +1,17 @@
+import { NotificationTypeUiCommand } from './enums';
+export interface SendNotificationCommandArgumentsOptions {
+    helpLabel?: string;
+    helpLink?: string;
+    autoClose?: number;
+}
+export interface SendNotificationCommandArguments {
+    message: string;
+    icon: string;
+    type: NotificationTypeUiCommand;
+    options?: SendNotificationCommandArgumentsOptions;
+    content?: string;
+    small?: boolean;
+}
+export interface UiCommandsNotificationObject {
+    send: (information: SendNotificationCommandArguments) => void;
+}

package/dist/cjs/ui-commands/notification/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/cjs/ui-commands/notification/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/ui-commands/notification/types.ts"],"names":[],"mappings":""}

package/dist/cjs/ui-commands/types.d.ts

@@ -4,6 +4,7 @@ import { UiCommandsSidekickOptionsContainerObject } from './sidekick-options-con
 import { UiCommandsPresentationAreaObject } from './presentation-area/types';
 import { UiCommandsUserStatusObject } from './user-status/types';
 import { UiCommandsConferenceObject } from './conference/types';
+import { UiCommandsNotificationObject } from './notification/types';
 export interface UiCommands {
     chat: UiCommandsChatObject;
     externalVideo: UiCommandsExternalVideoObject;
@@ -11,4 +12,5 @@ export interface UiCommands {
     presentationArea: UiCommandsPresentationAreaObject;
     userStatus: UiCommandsUserStatusObject;
     conference: UiCommandsConferenceObject;
+    notification: UiCommandsNotificationObject;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bigbluebutton-html-plugin-sdk",
-  "version": "0.0.66",
+  "version": "0.0.68",
   "homepage": "https://github.com/bigbluebutton/bigbluebutton-html-plugin-sdk",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",