bigbluebutton-html-plugin-sdk 0.1.7 → 0.1.9

package/README.md

@@ -41,7 +41,7 @@ _Running from source code with local BBB-server_
 pluginManifests=[{"url": "http://localhost:4701/manifest.json"}]
 ```
 
-*Running from source code with a remote BBB-server*
+_Running from source 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:
 
@@ -69,7 +69,7 @@ Right after that, NGROK will create an interface into your terminal and will dis
 
 Here's an example of URL: `https://<uuid>.ngrok-free.app`
 
-You can already interact with this URL and access both 
+You can already interact with this URL and access both
 
 `https://<uuid>.ngrok-free.app/manifest.json`
 
@@ -77,7 +77,6 @@ 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:
 
 ```
@@ -123,21 +122,21 @@ Here is as complete `manifest.json` example with all possible configurations:
   "name": "MyPlugin",
   "javascriptEntrypointUrl": "MyPlugin.js",
   "localesBaseUrl": "https://cdn.domain.com/my-plugin/", // Optional
-  "dataChannels":[
+  "dataChannels": [
     {
       "name": "public-channel",
-      "pushPermission": ["moderator","presenter"], // "moderator","presenter", "all"
+      "pushPermission": ["moderator", "presenter"], // "moderator","presenter", "all"
       "replaceOrDeletePermission": ["moderator", "creator"] // "moderator", "presenter","all", "creator"
     }
   ], // One can enable more data-channels to better organize client communication
   "eventPersistence": {
-    "isEnabled": true, // By default it is not enabled
+    "isEnabled": true // By default it is not enabled
   },
   "remoteDataSources": [
     {
       "name": "allUsers",
       "url": "${meta_pluginSettingsUserInformation}",
-      "fetchMode": "onMeetingCreate", // Possible values: "onMeetingCreate", "onDemand" 
+      "fetchMode": "onMeetingCreate", // Possible values: "onMeetingCreate", "onDemand"
       "permissions": ["moderator", "viewer"]
     }
   ],
@@ -199,10 +198,12 @@ Foreach of the following ui-extensible-area, we have a different setter function
 Mind that, although each area has its own structure, all the functions follows a certain argument structure, and returns nothing, that would be:
 
 ```ts
-pluginApi.setterFunctionExample([{
-  objectProperty1: 'string',
-  objectProperty2: 123,
-}])
+pluginApi.setterFunctionExample([
+  {
+    objectProperty1: 'string',
+    objectProperty2: 123,
+  },
+]);
 ```
 
 See, it is basically a function that requires an array as an argument, with which the more items you push to that array, the more of that extensible area you will have.
@@ -258,6 +259,54 @@ export interface GraphqlResponseWrapper<TData> {
 
 So we have the `data`, which is different for each hook, that's why it's a generic, the error, that will be set if, and only if, there is an error, otherwise it is undefined, and loading, which tells the developer if the query is still loading (being fetched) or not.
 
+### Realtime Data Creation
+
+**`useCustomMutation` Hook**
+
+The `useCustomMutation` hook enables you to post data to the backend (Postgres) using existing GraphQL mutations, respecting user permissions.
+
+It works similarly to Apollo Client’s `useMutation`, returning a _trigger function_ and a _result object_ with information about the mutation execution. These will be described in more detail below.
+
+One important difference is that the mutation query **must** be provided as a string. This is due to how the SDK communicates with the HTML5 client. As a consequence, you must explicitly define the type of the `variables` argument for the trigger function, as shown in the example below.
+
+```typescript
+interface MutationVariablesType {
+  reactionEmoji: string;
+}
+
+const [trigger, result] = pluginApi.useCustomMutation<MutationVariablesType>(`
+  mutation SetReactionEmoji($reactionEmoji: String!) {
+    userSetReactionEmoji(reactionEmoji: $reactionEmoji)
+  }
+`);
+
+// Later in the code, you can trigger the mutation:
+trigger({
+  variables: {
+    reactionEmoji: '👏',
+  },
+});
+```
+
+Note that the same type (`MutationVariablesType`) passed as the generic parameter to `useCustomMutation` is also the type of the `variables` object in the trigger function.
+
+The `result` object returned by the hook contains the following fields:
+
+```typescript
+const { called, data, error, loading } = result;
+```
+
+which follow this interface:
+
+```typescript
+interface MutationResultObject {
+  called: boolean; // Indicates if the trigger function has been called
+  data?: object; // Response data after the mutation is triggered
+  error?: object; // Error details from the mutation execution
+  loading: boolean; // Whether the mutation is currently loading (triggered or in progress)
+}
+```
+
 ### Real time data exchange
 
 - `useDataChannel` hook: this will allow you to exchange information (Send and receive) amongst different users through the same plugin;
@@ -268,7 +317,7 @@ So for this hook to read the data from the data channel, the developer will be a
 - LATEST_ITEM: Fetches only the latest item pushed to the data-channel within a specific subchannel-name since the beginning of the meeting;
 - NEW_ITEMS: Fetches the new items pushed to the data-channel within a specific subchannel-name since the moment that the `useDataChannel` hook has been called (It will not see entries sent previous to that moment);
 
-An interesting thing about this hook is that it is generic, so, you can use a custom type, and this will be  found not only in the consumer part of the data structure returned, but also in functions in which you need to specify an object to be persisted, meaning it will force the object to be of the type you mentioned previously (that is the case for `pushEntry` and `replaceEntry`). One can find examples of usage of this in the data-channel plugin sample or most of the official ones. The syntax is described below:
+An interesting thing about this hook is that it is generic, so, you can use a custom type, and this will be found not only in the consumer part of the data structure returned, but also in functions in which you need to specify an object to be persisted, meaning it will force the object to be of the type you mentioned previously (that is the case for `pushEntry` and `replaceEntry`). One can find examples of usage of this in the data-channel plugin sample or most of the official ones. The syntax is described below:
 
 ```typescript
 const {
@@ -279,7 +328,7 @@ const {
 } = useDataChannel<CustomType>(
   channelName, // Defined according to what is on manifest.json
   DataChannelTypes.ALL_ITEMS, // | LATEST_ITEM | NEW_ITEMS -> ALL_ITEMS is default
-  subChannelName = 'default', // If no subchannelName is specified, it will be 'default'
+  (subChannelName = 'default') // If no subchannelName is specified, it will be 'default'
 );
 ```
 
@@ -287,22 +336,22 @@ Wiping all data off will delete every item from the specific data-channel within
 
 **Data-channel configuration:**
 
-The data-channel name must be in the `manifest.json` along with all the permissions for writting, reading and deleting, see example below:
+The data-channel name must be in the `manifest.json` along with all the permissions for writing, reading and deleting, see example below:
 
 ```json
 {
   "requiredSdkVersion": "~0.0.59",
   "name": "PluginName",
   "javascriptEntrypointUrl": "PluginName.js",
-  "dataChannels":[
+  "dataChannels": [
     {
       "name": "channel-name",
-      "pushPermission": ["moderator","presenter"],
+      "pushPermission": ["moderator", "presenter"],
       "replaceOrDeletePermission": ["moderator", "sender"]
     }
   ]
 }
-``` 
+```
 
 If no permission is mentioned in that file (writing or deleting), no one will be able proceed with that specific action:
 
@@ -336,14 +385,16 @@ export type ObjectTo = ToUserId | ToRole;
 Example of usage:
 
 ```ts
-  const currentLocale = pluginApi.useUiData(IntlLocaleUiDataNames.CURRENT_LOCALE, {
+const currentLocale = pluginApi.useUiData(
+  IntlLocaleUiDataNames.CURRENT_LOCALE,
+  {
     locale: 'en',
     fallbackLocale: 'en',
-  });
-  // Do something with the currentLocale:
-  currentLocale.locale;
-  currentLocale.fallbackLocale;
-
+  }
+);
+// Do something with the currentLocale:
+currentLocale.locale;
+currentLocale.fallbackLocale;
 ```
 
 Mind that foreach enum we have, a different type of fallback is needed as the second argument. In the example above, we want the `intl`, so the second argument, will follow the structure depicted.
@@ -354,23 +405,42 @@ One other thing is that the type of the return is precisely the same type requir
 
 `uiCommands` object: It basically contains all the possible commands available to the developer to interact with the core BBB UI, see the ones implemented down below:
 
+- actions-bar:
+  - setDisplayActionBar: this function decides whether to display the actions bar
+- camera:
+  - setSelfViewDisableAllDevices: Sets the self-view camera disabled/enabled for all camera devices of a user;
+  - setSelfViewDisable: Sets the self-view camera disabled/enabled for specific camera.
 - chat:
   - form:
     - open: this function will open the sidebar chat panel automatically;
-    - fill: this function will fill the form input field of the chat passed in the argument as {text: string}
+    - fill: this function will fill the form input field of the chat passed in the argument as `{text: string}`
+- conference:
+  - setSpeakerLevel: this function will set the speaker volume level(audio output) of the conference to a certain number between 0 and 1;
 - external-video:
   - volume:
     - set: this function will set the external video volume to a certain number between 0 and 1 (that is 0% and);
-- sidekick-options-container:
-  - open: this function will open the sidekick options panel automatically;
-  - close: this function will close the sidekick options panel automatically (and also the sidebar content if open, to avoid inconsistencies in ui);
+- layout:
+  - changeEnforcedLayout: (deprecated) Changes the enforced layout
+  - setEnforcedLayout: Sets the enforced layout
+- navBar:
+  - setDisplayNavBar: Sets the displayNavBar to true (show it) or false (hide it).
+- 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;
 - presentation-area:
   - open: this function will open the presentation area content automatically;
   - 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;
+- sidekick-area:
+  - options:
+    - renameGenericContentMenu: this function will rename the menu of the generic content in the sidekick-area (must have the ID of the sidekick and the newName);
+    - renameGenericContentSection: this function will rename the section in which the menu with the specified ID is;
+    - setMenuBadge: this will set a badge for a specific generic content in the sidekick area;
+    - removeMenuBadge: this will remove any badges that a specific generic content might have;
+    - panel:
+      - open: this function will open the sidekick options panel automatically;
+      - close: this function will close the sidekick options panel automatically (and also the sidebar content if open, to avoid inconsistencies in ui);
+- sidekick-options-container:
+  - open: this function will open the sidekick options panel automatically;
+  - close: this function will close the sidekick options panel automatically (and also the sidebar content if open, to avoid inconsistencies in ui);
 - user-status:
   - setAwayStatus: this function will set the away status of the user to a certain status;
 - captions:
@@ -379,27 +449,28 @@ One other thing is that the type of the return is precisely the same type requir
 See usage ahead:
 
 ```ts
-  pluginApi.uiCommands.chat.form.open();
-  pluginApi.uiCommands.chat.form.fill({
-    text: 'Just an example message filled by the plugin',
-  });
+pluginApi.uiCommands.chat.form.open();
+pluginApi.uiCommands.chat.form.fill({
+  text: 'Just an example message filled by the plugin',
+});
 ```
 
 So the idea is that we have a `uiCommands` object and at a point, there will be the command to do the intended action, such as open the chat form and/or fill it, as demonstrated above
 
 ### Server Commands
-  
-  `serverCommands` object: It contains all the possible commands available to the developer to interact with the BBB core server, see the ones implemented down below:
-  
-  - chat:
-    - sendPublicMessage: This function sends a message to the public chat on behalf of the currently logged-in user.
 
-    - sendCustomPublicMessage: This function sends a text message to the public chat, optionally including custom metadata.
-      > **Note**: The custom messages sent by plugins are not automatically rendered by the client. To display these messages, a plugin must handle the rendering using `useLoadedChatMessages` and `useChatMessageDomElements`.
+`serverCommands` object: It contains all the possible commands available to the developer to interact with the BBB core server, see the ones implemented down below:
+
+- chat:
+
+  - sendPublicMessage: This function sends a message to the public chat on behalf of the currently logged-in user.
 
-  - caption:
-    - save: this function saves the given text, locale and caption type
-    - addLocale: this function sends a locale to be added to the available options
+  - sendCustomPublicMessage: This function sends a text message to the public chat, optionally including custom metadata.
+    > **Note**: The custom messages sent by plugins are not automatically rendered by the client. To display these messages, a plugin must handle the rendering using `useLoadedChatMessages` and `useChatMessageDomElements`.
+
+- caption:
+  - save: this function saves the given text, locale and caption type
+  - addLocale: this function sends a locale to be added to the available options
 
 ### Dom Element Manipulation
 
@@ -422,10 +493,9 @@ interface GenericDataForLearningAnalyticsDashboard {
 
 So that the data will appear in the following form:
 
-|   User    | Count | `<columnTitle>` |
-|    ---    |  :--  |      --:        |
-| user-name |   1   |   `<value>`     |
-
+| User      | Count | `<columnTitle>` |
+| --------- | :---- | --------------: |
+| user-name | 1     |       `<value>` |
 
 ### External data resources
 
@@ -437,12 +507,12 @@ This is possible by simply configuring the dataResource name in the manifest and
 {
   // ...rest of manifest configuration
   "remoteDataSources": [
-      {
-          "name": "allUsers",
-          "url": "${meta_pluginSettingsUserInformation}",
-          "fetchMode": "onMeetingCreate", // Possible values: "onMeetingCreate", "onDemand" 
-          "permissions": ["moderator", "viewer"] // Possible values: "moderator", "viewer", "presenter"
-      }
+    {
+      "name": "allUsers",
+      "url": "${meta_pluginSettingsUserInformation}",
+      "fetchMode": "onMeetingCreate", // Possible values: "onMeetingCreate", "onDemand"
+      "permissions": ["moderator", "viewer"] // Possible values: "moderator", "viewer", "presenter"
+    }
   ]
 }
 ```
@@ -468,20 +538,29 @@ See that we send the `meta_` parameter, for more information, refer to the [meta
 Lastly, in the plugin, just use the function like:
 
 ```typescript
-pluginApi.getRemoteData('allUsers').then((response: Response) => {
-  if (response.ok) {
-    response.json().then((r: CourseData) => {
-      // Do something with the jsonified data (if it's a json)
-    }).catch((reason) => {
-      pluginLogger.error('Error while processing the json from success response: ', reason);
-    });
-  }
-}).catch((reason) => {
-  pluginLogger.error('Error while fetching external resource: ', reason);
-});
+pluginApi
+  .getRemoteData('allUsers')
+  .then((response: Response) => {
+    if (response.ok) {
+      response
+        .json()
+        .then((r: CourseData) => {
+          // Do something with the jsonified data (if it's a json)
+        })
+        .catch((reason) => {
+          pluginLogger.error(
+            'Error while processing the json from success response: ',
+            reason
+          );
+        });
+    }
+  })
+  .catch((reason) => {
+    pluginLogger.error('Error while fetching external resource: ', reason);
+  });
 ```
 
-### Meta_ parameters
+### 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"`
 
@@ -497,7 +576,7 @@ To use it, one first need to add the following lines to their `manifest.json`:
 {
   // ...rest of manifest configuration
   "eventPersistence": {
-      "isEnabled": true,
+    "isEnabled": true
   }
 }
 ```
@@ -512,16 +591,17 @@ See example in the `sample-use-meeting` plugin here in this repository. It is as
 
 ```ts
 useEffect(() => {
-    setInterval(() => {
-      pluginLogger.info('persisting event');
-      pluginApi.persistEvent('eventFromUseMeetingSample', { foo: 'bar' });
-    }, 5000);
-  }, []);
+  setInterval(() => {
+    pluginLogger.info('persisting event');
+    pluginApi.persistEvent('eventFromUseMeetingSample', { foo: 'bar' });
+  }, 5000);
+}, []);
 ```
 
 After the meeting is ended (considering it has been recorded), one can simply do the following steps to see the events:
 
 In the server terminal run:
+
 ```bash
 sudo updatedb
 vi $(locate events.xml | grep <meeting-id>)
@@ -581,10 +661,10 @@ At this point, another folder will be created into the plugin directory called "
 module.exports = {
   // ... Other configurations
   output: {
-    filename: 'MyPlugin.js'
-  }
+    filename: 'MyPlugin.js',
+  },
   // ... Other configurations
-}
+};
 ```
 
 **Does the builded plugin need to be in the same BBB server?**

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

@@ -30,6 +30,8 @@ var utils_1 = require("../../remote-data/utils");
 var hooks_14 = require("../../event-persistence/hooks");
 var useLocaleMessages_1 = __importDefault(require("../auxiliary/plugin-information/locale-messages/useLocaleMessages"));
 var getters_1 = require("../../ui-data/getters/getters");
+var hooks_15 = require("../../data-consumption/domain/shared/custom-query/hooks");
+var hook_2 = require("../../data-creation/hook");
 /**
  * Class responsible for either initialize or get the PluginApi
  *
@@ -56,6 +58,8 @@ var BbbPluginSdk = /** @class */ (function () {
             throw new Error('Initializing pluginApi outside of a react function component. It should be done inside');
         var pluginApi = window.bbb_plugins[uuid];
         pluginApi.useCustomSubscription = (function (query, variablesObjectWrapper) { return (0, hooks_3.useCustomSubscription)(query, variablesObjectWrapper); });
+        pluginApi.useCustomQuery = (function (query, variablesObjectWrapper) { return (0, hooks_15.useCustomQuery)(query, variablesObjectWrapper); });
+        pluginApi.useCustomMutation = (function (mutation, options) { return (0, hook_2.useCustomMutation)(mutation, options); });
         pluginApi.useCurrentPresentation = (function () { return (0, hooks_2.useCurrentPresentation)(); });
         pluginApi.useLoadedUserList = (function () { return (0, hooks_4.useLoadedUserList)(); });
         pluginApi.useCurrentUser = (function () { return (0, hooks_5.useCurrentUser)(); });
@@ -81,7 +85,8 @@ 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); };
+            pluginApi
+                .persistEvent = function (eventName, payload) { return (0, hooks_14.persistEventFunctionWrapper)(pluginName, eventName, payload); };
             pluginApi.useLocaleMessages = function (fetchConfigs) { return (0, useLocaleMessages_1.default)({ pluginApi: pluginApi, fetchConfigs: fetchConfigs }); };
         }
         else {

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;AAClC,0EAAsE;AAOtE,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;AAC3G,yDAA0D;AAI1D;;;;;;GAMG;AACH;IAAA;IA0IA,CAAC;IAzIC;;;;;;;;;;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,UAAU,GAAG,UAAC,MAAM,IAAK,OAAA,IAAA,mBAAU,EAAC,MAAM,CAAC,EAAlB,CAAkB,CAAC;QACtD,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,SAAS,CAAC,SAAS,GAAG,mBAAS,CAAC;QAChC,IAAM,UAAU,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,UAAU,CAAC;QACzC,SAAS,CAAC,sBAAsB,GAAG,cAAsB,CAAC;QAC1D,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,UACE,IAAY,EACZ,UAAmB,EACnB,cAAuB;QAEvB,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,iBAAiB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAC3B,kBAAkB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAC5B,6BAA6B,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACvC,mBAAmB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAC7B,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,YAAA;gBACV,cAAc,gBAAA;aACf,CAAC;SACH;QAED,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IACH,mBAAC;AAAD,CAAC,AA1ID,IA0IC;AA1IqB,oCAAY"}
+{"version":3,"file":"BbbPluginSdk.js","sourceRoot":"","sources":["../../../../src/core/api/BbbPluginSdk.ts"],"names":[],"mappings":";;;;;;AAAA,+BAA+B;AAC/B,+BAAkC;AAClC,0EAAsE;AAOtE,kDAA4D;AAO5D,uDAAwD;AASxD,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;AAC3G,yDAA0D;AAC1D,kFAAyF;AAEzF,iDAA6D;AAK7D;;;;;;GAMG;AACH;IAAA;IAgJA,CAAC;IA/IC;;;;;;;;;;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,cAAc,GAAG,CAAC,UAC1B,KAAa,EACb,sBAA+C,IAC5C,OAAA,IAAA,uBAAc,EAAC,KAAK,EAAE,sBAAsB,CAAC,EAA7C,CAA6C,CAA2B,CAAC;QAC9E,SAAS,CAAC,iBAAiB,GAAG,CAAC,UAC7B,QAAgB,EAChB,OAAgB,IACb,OAAA,IAAA,wBAAiB,EAAC,QAAQ,EAAE,OAAO,CAAC,EAApC,CAAoC,CAA8B,CAAC;QACxE,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,UAAU,GAAG,UAAC,MAAM,IAAK,OAAA,IAAA,mBAAU,EAAC,MAAM,CAAC,EAAlB,CAAkB,CAAC;QACtD,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,SAAS,CAAC,SAAS,GAAG,mBAAS,CAAC;QAChC,IAAM,UAAU,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,UAAU,CAAC;QACzC,SAAS,CAAC,sBAAsB,GAAG,cAAsB,CAAC;QAC1D,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;iBACN,YAAY,GAAG,UAAa,SAAiB,EAAE,OAAU,IAAK,OAAA,IAAA,oCAA2B,EACxF,UAAU,EACV,SAAS,EACT,OAAO,CACR,EAJ8D,CAI9D,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,cAAQ,CAAC,CAAC;YAC1B,IAAA,iBAAS,EAAC,cAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;SAC1B;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,UACE,IAAY,EACZ,UAAmB,EACnB,cAAuB;QAEvB,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,iBAAiB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAC3B,kBAAkB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAC5B,6BAA6B,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBACvC,mBAAmB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAC7B,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,cAAQ,CAAC;iBACd;gBACD,eAAe,EAAE,cAAM,OAAA,IAAA,wBAAe,GAAE,EAAjB,CAAiB;gBACxC,UAAU,YAAA;gBACV,cAAc,gBAAA;aACf,CAAC;SACH;QAED,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IACH,mBAAC;AAAD,CAAC,AAhJD,IAgJC;AAhJqB,oCAAY"}

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

@@ -35,6 +35,8 @@ import { PersistEventFunction } from '../../event-persistence/types';
 import { UseLocaleMessagesFunction } from '../auxiliary/plugin-information/locale-messages/types';
 import { UseShouldUnmountPluginFunction } from '../auxiliary/plugin-unmount/types';
 import { GetUiDataFunction } from '../../ui-data/getters/types';
+import { UseCustomQueryFunction } from '../../data-consumption/domain/shared/custom-query/types';
+import { UseCustomMutationFunction } from '../../data-creation/types';
 export type SetPresentationToolbarItems = (presentationToolbarItem: PresentationToolbarInterface[]) => string[];
 export type SetUserListDropdownItems = (userListDropdownItem: UserListDropdownInterface[]) => string[];
 export type SetMediaAreaItems = (mediaAreaDropdownInterface: MediaAreaInterface[]) => string[];
@@ -112,11 +114,11 @@ export interface PluginApi {
      */
     useUsersBasicInfo?: UseUsersBasicInfoFunction;
     /**
-    * Returns an object containing brief data on the messages already loaded in the chat.
-    *
-    * @returns `GraphqlResponseWrapper` with the LoadedChatMessages.
-    *
-    */
+     * Returns an object containing brief data on the messages already loaded in the chat.
+     *
+     * @returns `GraphqlResponseWrapper` with the LoadedChatMessages.
+     *
+     */
     useLoadedChatMessages?: UseLoadedChatMessagesFunction;
     /**
      * Returns an object containing the settings for the current plugin (with pluginName
@@ -146,13 +148,29 @@ export interface PluginApi {
      */
     useShouldUnmountPlugin?: UseShouldUnmountPluginFunction;
     /**
-     * Returns an object containing the data on the current presentation being displayed
-     * in the presentation area, and its current page.
+     * Returns an object containing the data related to the custom subscription made.
+     * This hook is reactive - If the resulting data changes, it updates the hook.
      *
      * @returns `GraphqlResponseWrapper` with the data type specified in the generic type.
      *
      */
     useCustomSubscription?: UseCustomSubscriptionFunction;
+    /**
+     * Returns an object containing the data related to the custom subscription made.
+     * This hook is not reactive - Once the data is returned, it doesn't update anymore.
+     *
+     * @returns `GraphqlResponseWrapper` with the data type specified in the generic type.
+     *
+     */
+    useCustomQuery?: UseCustomQueryFunction;
+    /**
+     * Gives developer the ability to manipulate data from bbb using custom mutations.
+     * It can only use mutations that already exist in bbb.
+     *
+     * @returns an array with the trigger function and the result of the mutation.
+     *
+     */
+    useCustomMutation?: UseCustomMutationFunction;
     /**
      * Returns an array with tha data wrapped in the `GraphqlResponseWrapper` in the first
      * position of the array, the push function with which one plugin can inform

package/dist/cjs/core/auxiliary/join-url/getter.js.map

@@ -1 +1 @@
-{"version":3,"file":"getter.js","sourceRoot":"","sources":["../../../../../src/core/auxiliary/join-url/getter.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,kDAA0D;AAI1D,SAAS,qBAAqB,CAAC,UAAmC;IAChE,IAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;SAC3C,GAAG,CAAC,UAAC,EAAY;YAAX,GAAG,QAAA,EAAE,KAAK,QAAA;QAAM,OAAA,UAAG,kBAAkB,CAAC,GAAG,CAAC,cAAI,kBAAkB,CAAC,KAAK,CAAC,CAAE;IAAzD,CAAyD,CAAC;SAChF,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAsB,UAAU,CAAC,UAAmC;;;;;;;oBAC5D,aAAa,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAC;oBAClD,OAAO,GAAG,CAAA,MAAA,MAAM,CAAC,qBAAqB,0CAAE,MAAM,CAAC,GAAG,CAAC,UAAU,KAAI,gBAAgB,CAAC;oBAClF,GAAG,GAAG,UAAG,OAAO,0CAAgC,IAAA,wBAAe,GAAE,cAAI,aAAa,CAAE,CAAC;oBAC1E,qBAAM,KAAK,CAAC,GAAG,EAAE;4BAChC,WAAW,EAAE,SAAS;yBACvB,CAAC,EAAA;;oBAFI,QAAQ,GAAG,SAEf;oBACkB,qBAAM,QAAQ,CAAC,IAAI,EAAE,EAAA;;oBAAnC,WAAW,GAAG,SAAqB;oBACzC,sBAAO,WAAW,CAAC,QAAQ,CAAC,GAAa,EAAC;;;;CAC3C;AATD,gCASC"}
+{"version":3,"file":"getter.js","sourceRoot":"","sources":["../../../../../src/core/auxiliary/join-url/getter.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,kDAA0D;AAI1D,SAAS,qBAAqB,CAAC,UAAqC;IAClE,IAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;SAC3C,GAAG,CAAC,UAAC,EAAY;YAAX,GAAG,QAAA,EAAE,KAAK,QAAA;QAAM,OAAA,UAAG,kBAAkB,CAAC,GAAG,CAAC,cAAI,kBAAkB,CAAC,KAAK,CAAC,CAAE;IAAzD,CAAyD,CAAC;SAChF,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAsB,UAAU,CAAC,UAAqC;;;;;;;oBAC9D,aAAa,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAC;oBAClD,OAAO,GAAG,CAAA,MAAA,MAAM,CAAC,qBAAqB,0CAAE,MAAM,CAAC,GAAG,CAAC,UAAU,KAAI,gBAAgB,CAAC;oBAClF,GAAG,GAAG,UAAG,OAAO,0CAAgC,IAAA,wBAAe,GAAE,cAAI,aAAa,CAAE,CAAC;oBAC1E,qBAAM,KAAK,CAAC,GAAG,EAAE;4BAChC,WAAW,EAAE,SAAS;yBACvB,CAAC,EAAA;;oBAFI,QAAQ,GAAG,SAEf;oBACkB,qBAAM,QAAQ,CAAC,IAAI,EAAE,EAAA;;oBAAnC,WAAW,GAAG,SAAqB;oBACzC,sBAAO,WAAW,CAAC,QAAQ,CAAC,GAAa,EAAC;;;;CAC3C;AATD,gCASC"}

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

@@ -1,17 +1,21 @@
 import { PluginApi } from '../../../api/types';
-interface UseLocaleMessagesProps {
+export interface UseLocaleMessagesProps {
     pluginApi: PluginApi;
     fetchConfigs?: RequestInit;
 }
-interface PluginInformationResult {
+export interface PluginInformationResult {
     javascriptEntrypointIntegrity: string;
     javascriptEntrypointUrl: string;
     localesBaseUrl: string;
 }
-interface IntlMessages {
+export interface IntlMessages {
     loading: boolean;
     messages: Record<string, string>;
     currentLocale: string;
 }
-type UseLocaleMessagesFunction = (fetchConfigs?: RequestInit) => IntlMessages;
-export { UseLocaleMessagesProps, PluginInformationResult, IntlMessages, UseLocaleMessagesFunction, };
+export type UseLocaleMessagesFunction = (fetchConfigs?: RequestInit) => IntlMessages;
+export interface DataWaitingWrapper<T> {
+    data: T;
+    loading: boolean;
+    error?: object;
+}

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

@@ -37,21 +37,18 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var react_1 = require("react");
-var ui_data_1 = require("../../../../ui-data");
 var utils_1 = require("../../../../utils");
 var utils_2 = require("./utils");
 function useLocaleMessagesAuxiliary(_a) {
     var _this = this;
     var pluginApi = _a.pluginApi, fetchConfigs = _a.fetchConfigs;
-    var currentLocale = pluginApi.useUiData(ui_data_1.IntlLocaleUiDataNames.CURRENT_LOCALE, {
-        locale: 'en',
-        fallbackLocale: 'en',
-    });
     var _b = (0, react_1.useState)(true), loading = _b[0], setLoading = _b[1];
     var _c = (0, react_1.useState)({}), messages = _c[0], setMessages = _c[1];
     var _d = (0, react_1.useState)(), fallbackMessages = _d[0], setFallbackMessages = _d[1];
+    var localeDataWrapper = (0, utils_2.useGetNormalizedLocale)({ pluginApi: pluginApi, fetchConfigs: fetchConfigs });
+    var currentLocale = localeDataWrapper.data;
     (0, react_1.useEffect)(function () {
-        if ((pluginApi === null || pluginApi === void 0 ? void 0 : pluginApi.localesBaseUrl) && currentLocale.locale) {
+        if ((pluginApi === null || pluginApi === void 0 ? void 0 : pluginApi.localesBaseUrl) && !localeDataWrapper.loading) {
             var localesBaseUrl = pluginApi.localesBaseUrl;
             var locale = currentLocale.locale, fallbackLocale = currentLocale.fallbackLocale;
             var localeUrl = "".concat(localesBaseUrl, "/").concat(locale, ".json");
@@ -63,7 +60,7 @@ function useLocaleMessagesAuxiliary(_a) {
             if (locale !== fallbackLocale)
                 urlToFetchList.push(localeUrl);
             Promise.all(urlToFetchList.map(function (url) { return __awaiter(_this, void 0, void 0, function () {
-                var a, err_1;
+                var err_1;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0:
@@ -72,26 +69,26 @@ function useLocaleMessagesAuxiliary(_a) {
                         case 1:
                             _a.trys.push([1, 3, , 4]);
                             return [4 /*yield*/, (0, utils_2.fetchLocaleAndStore)(url, fetchConfigs)];
-                        case 2:
-                            a = _a.sent();
-                            return [2 /*return*/, a];
+                        case 2: return [2 /*return*/, _a.sent()];
                         case 3:
                             err_1 = _a.sent();
                             utils_1.pluginLogger.error("[".concat(pluginApi.pluginName, "] - Something went wrong while trying to fetch [").concat(url, "] or parse its result: "), err_1);
                             return [2 /*return*/, Promise.resolve({})];
-                        case 4: return [2 /*return*/, Promise.resolve(fallbackMessages)];
+                        case 4: 
+                        // The first of the list is the fallback
+                        return [2 /*return*/, Promise.resolve(fallbackMessages)];
                     }
                 });
             }); })).then(function (values) {
-                var desiredLocale = values[0], fallbackLocaleMessages = values[1];
-                setMessages((0, utils_2.mergeLocaleMessages)(desiredLocale, fallbackLocaleMessages));
+                var fallbackLocaleMessages = values[0], desiredLocaleMessages = values[1];
+                setMessages((0, utils_2.mergeLocaleMessages)(desiredLocaleMessages, fallbackLocaleMessages));
                 if (!fallbackMessages)
                     setFallbackMessages(fallbackLocaleMessages);
             }).finally(function () {
                 setLoading(false);
             });
         }
-    }, [currentLocale]);
+    }, [localeDataWrapper]);
     return {
         messages: messages,
         loading: loading,

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

@@ -1 +1 @@
-{"version":3,"file":"useLocaleMessages.js","sourceRoot":"","sources":["../../../../../../src/core/auxiliary/plugin-information/locale-messages/useLocaleMessages.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+BAA4C;AAC5C,+CAA4D;AAC5D,2CAAiD;AAEjD,iCAAmE;AAEnE,SAAS,0BAA0B,CACjC,EAAmD;IADrD,iBAmDC;QAlDG,SAAS,eAAA,EAAE,YAAY,kBAAA;IAEzB,IAAM,aAAa,GAAG,SAAS,CAAC,SAAU,CAAC,+BAAqB,CAAC,cAAc,EAAE;QAC/E,MAAM,EAAE,IAAI;QACZ,cAAc,EAAE,IAAI;KACrB,CAAC,CAAC;IAEG,IAAA,KAAwB,IAAA,gBAAQ,EAAC,IAAI,CAAC,EAArC,OAAO,QAAA,EAAE,UAAU,QAAkB,CAAC;IACvC,IAAA,KAA0B,IAAA,gBAAQ,EAAyB,EAAE,CAAC,EAA7D,QAAQ,QAAA,EAAE,WAAW,QAAwC,CAAC;IAC/D,IAAA,KAA0C,IAAA,gBAAQ,GAA0B,EAA3E,gBAAgB,QAAA,EAAE,mBAAmB,QAAsC,CAAC;IAEnF,IAAA,iBAAS,EAAC;QACR,IAAI,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,cAAc,KAAI,aAAa,CAAC,MAAM,EAAE;YAC7C,IAAA,cAAc,GAAK,SAAS,eAAd,CAAe;YAC7B,IAAA,MAAM,GAAqB,aAAa,OAAlC,EAAE,cAAc,GAAK,aAAa,eAAlB,CAAmB;YACjD,IAAM,SAAS,GAAG,UAAG,cAAc,cAAI,MAAM,UAAO,CAAC;YACrD,IAAM,mBAAiB,GAAG,UAAG,cAAc,cAAI,cAAc,UAAO,CAAC;YACrE,oBAAY,CAAC,IAAI,CAAC,2BAAoB,MAAM,6BAAmB,cAAc,2BAAiB,SAAS,CAAC,UAAU,MAAG,CAAC,CAAC;YACvH,IAAM,cAAc,GAAG;gBACrB,mBAAiB;aAClB,CAAC;YACF,IAAI,MAAM,KAAK,cAAc;gBAAE,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC9D,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,UAAO,GAAG;;;;;iCACnC,CAAA,GAAG,KAAK,mBAAiB,IAAI,CAAC,gBAAgB,CAAA,EAA9C,wBAA8C;;;;4BAEpC,qBAAM,IAAA,2BAAmB,EAAC,GAAG,EAAE,YAAY,CAAC,EAAA;;4BAAhD,CAAC,GAAG,SAA4C;4BACtD,sBAAO,CAAC,EAAC;;;4BAET,oBAAY,CAAC,KAAK,CAChB,WAAI,SAAS,CAAC,UAAU,6DAAmD,GAAG,4BAAyB,EACvG,KAAG,CACJ,CAAC;4BACF,sBAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,EAAC;gCAG/B,sBAAO,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAC;;;iBAC1C,CAAC,CAAC,CAAC,IAAI,CAAC,UAAC,MAAM;gBACP,IAAA,aAAa,GAA4B,MAAM,GAAlC,EAAE,sBAAsB,GAAI,MAAM,GAAV,CAAW;gBACvD,WAAW,CAAC,IAAA,2BAAmB,EAAC,aAAa,EAAE,sBAAsB,CAAC,CAAC,CAAC;gBACxE,IAAI,CAAC,gBAAgB;oBAAE,mBAAmB,CAAC,sBAAsB,CAAC,CAAC;YACrE,CAAC,CAAC,CAAC,OAAO,CAAC;gBACT,UAAU,CAAC,KAAK,CAAC,CAAC;YACpB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;IACpB,OAAO;QACL,QAAQ,UAAA;QACR,OAAO,SAAA;QACP,aAAa,EAAE,aAAa,CAAC,MAAM;KACpC,CAAC;AACJ,CAAC;AAED,kBAAe,0BAA0B,CAAC"}
+{"version":3,"file":"useLocaleMessages.js","sourceRoot":"","sources":["../../../../../../src/core/auxiliary/plugin-information/locale-messages/useLocaleMessages.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+BAA4C;AAC5C,2CAAiD;AAEjD,iCAA2F;AAE3F,SAAS,0BAA0B,CACjC,EAAmD;IADrD,iBAiDC;QAhDG,SAAS,eAAA,EAAE,YAAY,kBAAA;IAEnB,IAAA,KAAwB,IAAA,gBAAQ,EAAC,IAAI,CAAC,EAArC,OAAO,QAAA,EAAE,UAAU,QAAkB,CAAC;IACvC,IAAA,KAA0B,IAAA,gBAAQ,EAAyB,EAAE,CAAC,EAA7D,QAAQ,QAAA,EAAE,WAAW,QAAwC,CAAC;IAC/D,IAAA,KAA0C,IAAA,gBAAQ,GAA0B,EAA3E,gBAAgB,QAAA,EAAE,mBAAmB,QAAsC,CAAC;IACnF,IAAM,iBAAiB,GAAG,IAAA,8BAAsB,EAAC,EAAE,SAAS,WAAA,EAAE,YAAY,cAAA,EAAE,CAAC,CAAC;IAEtE,IAAM,aAAa,GAAK,iBAAiB,KAAtB,CAAuB;IAElD,IAAA,iBAAS,EAAC;QACR,IAAI,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,cAAc,KAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE;YACnD,IAAA,cAAc,GAAK,SAAS,eAAd,CAAe;YAC7B,IAAA,MAAM,GAAqB,aAAa,OAAlC,EAAE,cAAc,GAAK,aAAa,eAAlB,CAAmB;YACjD,IAAM,SAAS,GAAG,UAAG,cAAc,cAAI,MAAM,UAAO,CAAC;YACrD,IAAM,mBAAiB,GAAG,UAAG,cAAc,cAAI,cAAc,UAAO,CAAC;YACrE,oBAAY,CAAC,IAAI,CAAC,2BAAoB,MAAM,6BAAmB,cAAc,2BAAiB,SAAS,CAAC,UAAU,MAAG,CAAC,CAAC;YACvH,IAAM,cAAc,GAAG;gBACrB,mBAAiB;aAClB,CAAC;YACF,IAAI,MAAM,KAAK,cAAc;gBAAE,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC9D,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,UAAO,GAAG;;;;;iCACnC,CAAA,GAAG,KAAK,mBAAiB,IAAI,CAAC,gBAAgB,CAAA,EAA9C,wBAA8C;;;;4BAEvC,qBAAM,IAAA,2BAAmB,EAAC,GAAG,EAAE,YAAY,CAAC,EAAA;gCAAnD,sBAAO,SAA4C,EAAC;;;4BAEpD,oBAAY,CAAC,KAAK,CAChB,WAAI,SAAS,CAAC,UAAU,6DAAmD,GAAG,4BAAyB,EACvG,KAAG,CACJ,CAAC;4BACF,sBAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,EAAC;;wBAG/B,wCAAwC;wBACxC,sBAAO,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAC;;;iBAC1C,CAAC,CAAC,CAAC,IAAI,CAAC,UAAC,MAAM;gBACP,IAAA,sBAAsB,GAA2B,MAAM,GAAjC,EAAE,qBAAqB,GAAI,MAAM,GAAV,CAAW;gBAC/D,WAAW,CAAC,IAAA,2BAAmB,EAAC,qBAAqB,EAAE,sBAAsB,CAAC,CAAC,CAAC;gBAChF,IAAI,CAAC,gBAAgB;oBAAE,mBAAmB,CAAC,sBAAsB,CAAC,CAAC;YACrE,CAAC,CAAC,CAAC,OAAO,CAAC;gBACT,UAAU,CAAC,KAAK,CAAC,CAAC;YACpB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACxB,OAAO;QACL,QAAQ,UAAA;QACR,OAAO,SAAA;QACP,aAAa,EAAE,aAAa,CAAC,MAAM;KACpC,CAAC;AACJ,CAAC;AAED,kBAAe,0BAA0B,CAAC"}

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

@@ -1,3 +1,7 @@
+import { DataWaitingWrapper, UseLocaleMessagesProps } from './types';
+import { LocaleObject } from '../../../../ui-data/domain/intl/locale/types';
 declare function fetchLocaleAndStore(localeUrl: string, fetchConfigs?: RequestInit): Promise<Record<string, string>>;
 declare function mergeLocaleMessages(desiredMessages: Record<string, string>, fallbackMessages: Record<string, string>): Record<string, string>;
-export { fetchLocaleAndStore, mergeLocaleMessages };
+declare function useGetLocalesIndex(localeUrl: string | undefined, fetchConfigs?: RequestInit): DataWaitingWrapper<string[]>;
+declare function useGetNormalizedLocale({ pluginApi, fetchConfigs }: UseLocaleMessagesProps): DataWaitingWrapper<LocaleObject>;
+export { fetchLocaleAndStore, mergeLocaleMessages, useGetLocalesIndex, useGetNormalizedLocale, };