bigbluebutton-html-plugin-sdk 0.0.71 → 0.0.73

package/README.md

@@ -94,7 +94,7 @@ follow these steps:
 
 ```bash
 cd $HOME/src/bigbluebutton-html-plugin-sdk/samples/sample-action-button-dropdown-plugin
-npm install
+npm ci
 npm run build-bundle
 ```
 
@@ -142,7 +142,7 @@ Here is as complete `manifet.json` example with all possible configurations:
     {
       "name": "allUsers",
       "url": "${meta_pluginSettingsUserInformation}",
-      "fetchMode": "onMeetingCreate",
+      "fetchMode": "onMeetingCreate", // Possible values: "onMeetingCreate", "onDemand" 
       "permissions": ["moderator", "viewer"]
     }
   ]
@@ -188,10 +188,11 @@ That being said, here are the extensible areas we have so far:
 
 Mind that no plugin will interfere into another's extensible area. So feel free to set whatever you need into a certain plugin with no worries.
 
-### Getters available through the API:
+### Auxiliar functions:
 
 - `getSessionToken`: returns the user session token located on the user's URL.
 - `getJoinUrl`: returns the join url associated with the parameters passed as an argument. Since it fetches the BigBlueButton API, this getter method is asynchronous.
+- `useLocaleMessages`: returns the messages to be used in internationalization functions (recommend to use `react-intl`, as example, refer to official plugins)
 
 ### Realtime data consumption
 
@@ -397,21 +398,32 @@ This is possible by simply configuring the dataResource name in the manifest and
       {
           "name": "allUsers",
           "url": "${meta_pluginSettingsUserInformation}",
-          "fetchMode": "onMeetingCreate",
-          "permissions": ["moderator", "viewer"]
+          "fetchMode": "onMeetingCreate", // Possible values: "onMeetingCreate", "onDemand" 
+          "permissions": ["moderator", "viewer"] // Possible values: "moderator", "viewer", "presenter"
       }
   ]
 }
 ```
 
-Then when creating the meeting send the following parameters along, adjusting to your needs and resources:
+Going through each parameter to better understand it's structure:
+
+- `name`: It is the name of the remote data source, that is the name you'll use later on in the plugin when developing it;
+- `url`: The Url to which the data will be fetched (it can be hard-coded in the `manifest.json`, but we recommend passing it as a `meta_` parameter);
+- `fetchMode`: It tells the plugin-server if it should fetch the data only when creating the meeting, or everytime the function is called in the plugin portion;
+  - If one chooses `onMeetingCreate`, the data will be fetched when the create endpoint of the meeting is called, then it's cached in the plugin-server so that everytime the plugin wants that data, the plugin-server will respond with the cached data;
+  - On the other hand, if `onDemand` is selected, everytime the plugin calls this method, the plugin-server will fetch the data and then proxy it to the plugin;
+- `permissions`: This tells the back-end which role of the meeting can access this remote data;
+
+Here is the `/create` parameters you would have to pass to make this remote-data-source api work:
 
 ```
 meta_pluginSettingsUserInformation=https://<your-external-source-with-your-authentication>/api/users
 pluginManifests=[{"url": "http://<domain-of-your-manifest>/your-plugin/manifest.json"}]
 ```
 
-In the plugin, just use the function like:
+See that we send the `meta_` parameter, for more information, refer to the [meta parameters section](#meta_-parameters)
+
+Lastly, in the plugin, just use the function like:
 
 ```typescript
 pluginApi.getRemoteData('allUsers').then((response: Response) => {
@@ -427,6 +439,12 @@ pluginApi.getRemoteData('allUsers').then((response: Response) => {
 });
 ```
 
+### Meta_ parameters
+
+This is not part of the API, but it's a way of passing information to the manifest. Any value can be passed like this, one just needs to put something like `${meta_nameOfParameter}` in a specific config of the manifest, and in the `/create` call, set this meta-parameter to whatever is preferred, like `meta_nameOfParameter="Sample message"`
+
+This feature is mainly used for security purposes, see [external data section](#external-data-resources). But can be used for customization reasons as well.
+
 ### Event persistence
 
 This feature will allow the developer to save an information (which is basically an event) in the `event.xml` file of the meeting if it's being recorded.

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

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BbbPluginSdk = void 0;
 /* eslint-disable no-console */
@@ -24,7 +27,7 @@ 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");
-var hook_1 = require("../../asset-persistence/hook");
+var useLocaleMessages_1 = __importDefault(require("../auxiliary/plugin-information/locale-messages/useLocaleMessages"));
 /**
  * Class responsible for either initialize or get the PluginApi
  *
@@ -74,7 +77,7 @@ var BbbPluginSdk = /** @class */ (function () {
             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); };
-            pluginApi.persistAsset = function (assetUrl, typeOfAsset, assetName) { return (0, hook_1.persistAssetFunctionWrapper)(pluginName, assetUrl, typeOfAsset, assetName); };
+            pluginApi.useLocaleMessages = function (fetchConfigs) { return (0, useLocaleMessages_1.default)({ pluginApi: pluginApi, fetchConfigs: fetchConfigs }); };
         }
         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;AACxD,wDAA4E;AAC5E,qDAA2E;AAK3E;;;;;;GAMG;AACH;IAAA;IAyIA,CAAC;IAxIC;;;;;;;;;;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;YACJ,SAAS,CAAC,YAAY,GAAG,UACvB,QAAgB,EAChB,WAAsB,EACtB,SAAkB,IACf,OAAA,IAAA,kCAA2B,EAC9B,UAAU,EACV,QAAQ,EACR,WAAW,EACX,SAAS,CACV,EALI,CAKJ,CAAC;SACH;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,AAzID,IAyIC;AAzIqB,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;AAC5E,wHAA2G;AAI3G;;;;;;GAMG;AACH;IAAA;IAkIA,CAAC;IAjIC;;;;;;;;;;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;YACJ,SAAS,CAAC,iBAAiB,GAAG,UAC5B,YAA0B,IACvB,OAAA,IAAA,2BAA0B,EAAC,EAAE,SAAS,WAAA,EAAE,YAAY,cAAA,EAAE,CAAC,EAAvD,CAAuD,CAAC;SAC9D;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,AAlID,IAkIC;AAlIqB,oCAAY"}

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

@@ -32,7 +32,7 @@ import { UseUserCameraDomElementsFunction } from '../../dom-element-manipulation
 import { ScreenshareHelperInterface, UserCameraHelperInterface } from '../../extensible-areas';
 import { GetDataSource } from '../../remote-data/types';
 import { PersistEventFunction } from '../../event-persistence/types';
-import { PersistAssetFunction } from '../../asset-persistence/types';
+import { UseLocaleMessagesFunction } from '../auxiliary/plugin-information/locale-messages/types';
 export type SetPresentationToolbarItems = (presentationToolbarItem: PresentationToolbarInterface[]) => string[];
 export type SetUserListDropdownItems = (userListDropdownItem: UserListDropdownInterface[]) => string[];
 export type SetActionButtonDropdownItems = (actionButtonDropdownInterface: ActionButtonDropdownInterface[]) => string[];
@@ -187,6 +187,13 @@ export interface PluginApi {
     useUserCameraDomElements?: UseUserCameraDomElementsFunction;
     getSessionToken?: GetSessionTokenFunction;
     getJoinUrl?: GetJoinUrlFunction;
+    /**
+     * Return messages to be used in the internacionalization functions (react-intl is recommended)
+     *
+     * @param fetchConfigs - fetch configuration object for the locale files (otional,
+     * usefull in dev environments).
+     */
+    useLocaleMessages?: UseLocaleMessagesFunction;
     /**
      * Send data to the Learning analytics dashboard
      *
@@ -209,13 +216,6 @@ export interface PluginApi {
      *
      */
     persistEvent?: PersistEventFunction;
-    /**
-     * Persists assets to the current meeting, e.g.: presentation.
-     *
-     * @param payload - payload to be persisted in `events.xml`
-     *
-     */
-    persistAsset?: PersistAssetFunction;
 }
 export interface PluginBrowserWindow extends Window {
     bbb_plugins: {

package/dist/cjs/core/auxiliary/plugin-information/locale-messages/subscriptions.d.ts

@@ -0,0 +1,2 @@
+declare const GET_PLUGIN_INFORMATION = "\nsubscription GetPluginInformation {\n  plugin {\n    javascriptEntrypointIntegrity\n    javascriptEntrypointUrl\n    localesBaseUrl\n    name\n  }\n}\n";
+export { GET_PLUGIN_INFORMATION };

package/dist/cjs/core/auxiliary/plugin-information/locale-messages/subscriptions.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GET_PLUGIN_INFORMATION = void 0;
+var GET_PLUGIN_INFORMATION = "\nsubscription GetPluginInformation {\n  plugin {\n    javascriptEntrypointIntegrity\n    javascriptEntrypointUrl\n    localesBaseUrl\n    name\n  }\n}\n";
+exports.GET_PLUGIN_INFORMATION = GET_PLUGIN_INFORMATION;
+//# sourceMappingURL=subscriptions.js.map

package/dist/cjs/core/auxiliary/plugin-information/locale-messages/subscriptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../../../../../../src/core/auxiliary/plugin-information/locale-messages/subscriptions.ts"],"names":[],"mappings":";;;AAAA,IAAM,sBAAsB,GAAG,2JAS9B,CAAC;AAEO,wDAAsB"}

package/dist/cjs/core/auxiliary/plugin-information/locale-messages/types.d.ts

@@ -0,0 +1,20 @@
+import { PluginApi } from 'src/core/api/types';
+interface UseLocaleMessagesProps {
+    pluginApi: PluginApi;
+    fetchConfigs?: RequestInit;
+}
+interface PluginInformationResult {
+    javascriptEntrypointIntegrity: string;
+    javascriptEntrypointUrl: string;
+    localesBaseUrl: string;
+}
+interface GraphqlResponseWrapper {
+    plugin: PluginInformationResult[];
+}
+interface IntlMessages {
+    loading: boolean;
+    messages: Record<string, string>;
+    currentLocale: string;
+}
+type UseLocaleMessagesFunction = (fetchConfigs?: RequestInit) => IntlMessages;
+export { UseLocaleMessagesProps, PluginInformationResult, GraphqlResponseWrapper, IntlMessages, UseLocaleMessagesFunction, };

package/dist/cjs/core/auxiliary/plugin-information/locale-messages/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../src/core/auxiliary/plugin-information/locale-messages/types.ts"],"names":[],"mappings":""}

package/dist/cjs/core/auxiliary/plugin-information/locale-messages/useLocaleMessages.d.ts

@@ -0,0 +1,3 @@
+import { IntlMessages, UseLocaleMessagesProps } from './types';
+declare function useLocaleMessagesAuxiliary({ pluginApi, fetchConfigs }: UseLocaleMessagesProps): IntlMessages;
+export default useLocaleMessagesAuxiliary;

package/dist/cjs/core/auxiliary/plugin-information/locale-messages/useLocaleMessages.js

@@ -0,0 +1,60 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var React = __importStar(require("react"));
+var ui_data_hooks_1 = require("../../../../ui-data-hooks");
+var utils_1 = require("../../../../utils");
+var subscriptions_1 = require("./subscriptions");
+function useLocaleMessagesAuxiliary(_a) {
+    var pluginApi = _a.pluginApi, fetchConfigs = _a.fetchConfigs;
+    var currentLocale = pluginApi.useUiData(ui_data_hooks_1.IntlLocaleUiDataNames.CURRENT_LOCALE, {
+        locale: 'en',
+        fallbackLocale: 'en',
+    });
+    var _b = React.useState(true), loading = _b[0], setLoading = _b[1];
+    var _c = React.useState({}), messages = _c[0], setMessages = _c[1];
+    var pluginInformation = pluginApi.useCustomSubscription(subscriptions_1.GET_PLUGIN_INFORMATION).data;
+    React.useEffect(function () {
+        if (pluginInformation && pluginInformation.plugin && currentLocale.locale) {
+            var localesBaseUrl = pluginInformation.plugin[0].localesBaseUrl;
+            var locale = currentLocale.locale;
+            var localeUrl_1 = "".concat(localesBaseUrl, "/").concat(locale, ".json");
+            fetch(localeUrl_1, fetchConfigs).then(function (result) { return result.json(); }).then(function (localeMessages) {
+                setLoading(false);
+                setMessages(localeMessages);
+            }).catch(function (err) {
+                setLoading(false);
+                utils_1.pluginLogger.error("Something went wrong while trying to fetch ".concat(localeUrl_1, ": "), err);
+            });
+        }
+    }, [pluginInformation, currentLocale]);
+    return {
+        messages: messages,
+        loading: loading,
+        currentLocale: currentLocale.locale,
+    };
+}
+exports.default = useLocaleMessagesAuxiliary;
+//# sourceMappingURL=useLocaleMessages.js.map

package/dist/cjs/core/auxiliary/plugin-information/locale-messages/useLocaleMessages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLocaleMessages.js","sourceRoot":"","sources":["../../../../../../src/core/auxiliary/plugin-information/locale-messages/useLocaleMessages.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA+B;AAC/B,2DAAkE;AAClE,2CAAiD;AAEjD,iDAAyD;AAEzD,SAAS,0BAA0B,CACjC,EAAmD;QAAjD,SAAS,eAAA,EAAE,YAAY,kBAAA;IAEzB,IAAM,aAAa,GAAG,SAAS,CAAC,SAAU,CAAC,qCAAqB,CAAC,cAAc,EAAE;QAC/E,MAAM,EAAE,IAAI;QACZ,cAAc,EAAE,IAAI;KACrB,CAAC,CAAC;IAEG,IAAA,KAAwB,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAA3C,OAAO,QAAA,EAAE,UAAU,QAAwB,CAAC;IAC7C,IAAA,KAA0B,KAAK,CAAC,QAAQ,CAAyB,EAAE,CAAC,EAAnE,QAAQ,QAAA,EAAE,WAAW,QAA8C,CAAC;IAEnE,IAAM,iBAAiB,GAAK,SAAS,CAAC,qBAAsB,CAClE,sCAAsB,CACvB,KAF8B,CAE7B;IAEF,KAAK,CAAC,SAAS,CAAC;QACd,IAAI,iBAAiB,IAAI,iBAAiB,CAAC,MAAM,IAAI,aAAa,CAAC,MAAM,EAAE;YACjE,IAAA,cAAc,GAAK,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,eAAhC,CAAiC;YAC/C,IAAA,MAAM,GAAK,aAAa,OAAlB,CAAmB;YACjC,IAAM,WAAS,GAAG,UAAG,cAAc,cAAI,MAAM,UAAO,CAAC;YACrD,KAAK,CAAC,WAAS,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,UAAC,MAAM,IAAK,OAAA,MAAM,CAAC,IAAI,EAAE,EAAb,CAAa,CAAC,CAAC,IAAI,CAAC,UAAC,cAAc;gBACjF,UAAU,CAAC,KAAK,CAAC,CAAC;gBAClB,WAAW,CAAC,cAAc,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC,KAAK,CAAC,UAAC,GAAG;gBACX,UAAU,CAAC,KAAK,CAAC,CAAC;gBAClB,oBAAY,CAAC,KAAK,CAAC,qDAA8C,WAAS,OAAI,EAAE,GAAG,CAAC,CAAC;YACvF,CAAC,CAAC,CAAC;SACJ;IACH,CAAC,EAAE,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC,CAAC;IACvC,OAAO;QACL,QAAQ,UAAA;QACR,OAAO,SAAA;QACP,aAAa,EAAE,aAAa,CAAC,MAAM;KACpC,CAAC;AACJ,CAAC;AAED,kBAAe,0BAA0B,CAAC"}

package/dist/cjs/data-consumption/domain/settings/plugin-settings/utils.js

@@ -13,9 +13,9 @@ var __assign = (this && this.__assign) || function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.filterPluginSpecificSettings = void 0;
 var filterPluginSpecificSettings = function (completeSettings) {
-    var _a;
-    var pluginSettings = (_a = completeSettings
-        .data) === null || _a === void 0 ? void 0 : _a.meeting_clientPluginSettings[0].settings;
+    var _a, _b;
+    var pluginSettings = (_b = (_a = completeSettings
+        .data) === null || _a === void 0 ? void 0 : _a.meeting_clientPluginSettings[0]) === null || _b === void 0 ? void 0 : _b.settings;
     return __assign(__assign({}, completeSettings), { data: pluginSettings });
 };
 exports.filterPluginSpecificSettings = filterPluginSpecificSettings;

package/dist/cjs/data-consumption/domain/settings/plugin-settings/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../../src/data-consumption/domain/settings/plugin-settings/utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAGO,IAAM,4BAA4B,GAAG,UAC1C,gBAAkF;;IAElF,IAAM,cAAc,GAAG,MAAA,gBAAgB;SACpC,IAAI,0CAAE,4BAA4B,CAAC,CAAC,EAAE,QAAQ,CAAC;IAClD,6BACK,gBAAgB,KACnB,IAAI,EAAE,cAAc,IACpB;AACJ,CAAC,CAAC;AATW,QAAA,4BAA4B,gCASvC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../../src/data-consumption/domain/settings/plugin-settings/utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAGO,IAAM,4BAA4B,GAAG,UAC1C,gBAAkF;;IAElF,IAAM,cAAc,GAAG,MAAA,MAAA,gBAAgB;SACpC,IAAI,0CAAE,4BAA4B,CAAC,CAAC,CAAC,0CAAE,QAAQ,CAAC;IACnD,6BACK,gBAAgB,KACnB,IAAI,EAAE,cAAc,IACpB;AACJ,CAAC,CAAC;AATW,QAAA,4BAA4B,gCASvC"}

package/package.json

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

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

@@ -1,6 +0,0 @@
-export declare enum AssetPersistenceEvents {
-    ASSET_PERSISTED = "PLUGIN_ASSET_PERSISTED"
-}
-export declare enum AssetType {
-    PRESENTATION = "PLUGIN_ASSET_PERSISTENCE_TYPE_PRESENTATION"
-}

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

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AssetType = exports.AssetPersistenceEvents = void 0;
-var AssetPersistenceEvents;
-(function (AssetPersistenceEvents) {
-    AssetPersistenceEvents["ASSET_PERSISTED"] = "PLUGIN_ASSET_PERSISTED";
-})(AssetPersistenceEvents || (exports.AssetPersistenceEvents = AssetPersistenceEvents = {}));
-var AssetType;
-(function (AssetType) {
-    AssetType["PRESENTATION"] = "PLUGIN_ASSET_PERSISTENCE_TYPE_PRESENTATION";
-})(AssetType || (exports.AssetType = AssetType = {}));
-//# sourceMappingURL=enums.js.map

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

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

package/dist/cjs/asset-persistence/hook.d.ts

@@ -1,2 +0,0 @@
-import { AssetType } from './enums';
-export declare const persistAssetFunctionWrapper: (pluginName: string, assetUrl: string, typeOfAsset: AssetType, assetName?: string) => void;

package/dist/cjs/asset-persistence/hook.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.persistAssetFunctionWrapper = void 0;
-var enums_1 = require("./enums");
-var persistAssetFunctionWrapper = function (pluginName, assetUrl, typeOfAsset, assetName) {
-    window.dispatchEvent(new CustomEvent(enums_1.AssetPersistenceEvents.ASSET_PERSISTED, {
-        detail: {
-            pluginName: pluginName,
-            assetUrl: assetUrl,
-            typeOfAsset: typeOfAsset,
-            assetName: assetName,
-        },
-    }));
-};
-exports.persistAssetFunctionWrapper = persistAssetFunctionWrapper;
-//# sourceMappingURL=hook.js.map

package/dist/cjs/asset-persistence/hook.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"hook.js","sourceRoot":"","sources":["../../../src/asset-persistence/hook.ts"],"names":[],"mappings":";;;AAGA,iCAA4D;AAErD,IAAM,2BAA2B,GAAG,UACzC,UAAkB,EAClB,QAAgB,EAChB,WAAsB,EACtB,SAAkB;IAElB,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CACU,8BAAsB,CAAC,eAAe,EAAE;QAC/D,MAAM,EAAE;YACN,UAAU,YAAA;YACV,QAAQ,UAAA;YACR,WAAW,aAAA;YACX,SAAS,WAAA;SACV;KACF,CAAC,CACH,CAAC;AACJ,CAAC,CAAC;AAjBW,QAAA,2BAA2B,+BAiBtC"}

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

@@ -1,8 +0,0 @@
-import { AssetType } from './enums';
-export interface AssetPersistenceDetails {
-    pluginName: string;
-    assetUrl: string;
-    typeOfAsset: AssetType;
-    assetName?: string;
-}
-export type PersistAssetFunction = (assetUrl: string, typeOfAsset: AssetType, assetName?: string) => void;

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

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