bigbluebutton-html-plugin-sdk 0.0.46 → 0.0.48

package/README.md

@@ -23,19 +23,20 @@ For example if you take the [`sample-action-button-dropdown-plugin`](samples/sam
 you do the following:
 
 1. Start the development server:
-    ```bash
-    cd $HOME/src/bigbluebutton-html-plugin-sdk/samples/sample-action-button-dropdown-plugin
-    npm install
-    npm start
-    ```
 
+   ```bash
+   cd $HOME/src/bigbluebutton-html-plugin-sdk/samples/sample-action-button-dropdown-plugin
+   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
-    ```
+
+   ```yaml
+   public:
+     plugins:
+       - name: SampleActionButtonDropdownPlugin
+         url: http://127.0.0.1:4701/static/SampleActionButtonDropdownPlugin.js
+   ```
 
 _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.
@@ -77,53 +78,65 @@ In this case, the `<<PLUGIN_URL>>` will be `https://<your-host>/plugins/SampleAc
 
 ### Extensible UI areas
 
-- Action bar items (button, separator)
+Foreach of the following ui-extensible-area, we have a different setter function accessible via `pluginApi`.
 
-- Action Button Dropdown Items (option, separator)
+Mind that, although each area has its own structure, all the functions follows a certain argument structure, and returns nothing, that would be:
 
-- Audio settings dropdown items (option, separator)
+```ts
+pluginApi.setterFunctionExample([{
+  objectProperty1: 'string',
+  objectProperty2: 123,
+}])
+```
 
-- Camera settings dropdown items (option, separator)
+See, it is basicaly 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.
 
-- Nav bar items (button, info)
+That being said, here are the extensible areas we have so far:
 
+- Action bar items (button, separator)
+- Action Button Dropdown Items (option, separator)
+- Audio settings dropdown items (option, separator)
+- Camera settings dropdown items (option, separator)
+- Nav bar items (button, info)
 - Presentation dropdown items (option, separator)
-
 - Presentation toolbar items (button, separator, spinner)
-
 - User camera settings dropdown items (option, separator)
-
 - User list dropdown items (option, separator)
-
 - User list item additional information (item, label)
-
 - Floating window item (floatingWindow)
-
 - Generic component (genericComponent)
 
+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:
 
 - `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.
 
 ### Realtime data consumption
 
 - `useCurrentPresentation` hook: provides information regarding the current presentation;
-
 - `useLoadedUserList` hook: provides information regarding the loaded user list (displayed in the screen);
-
 - `useCurrentUser` hook: provides information regarding the current user;
-
 - `useUsersBasicInfo` hook: provides information regarding all users (only crucial information: userId, name and role);
-
 - `useLoadedChatMessages` hook: provides information regarding the loaded chat messages;
-
 - `useCustomSubscription` hook: with this hook, the developer can query pretty much anything graphql can provide. Note: Make sure that, on BBB version change, the custom subscriptions you make will work as expected.
-
 - `usePluginSettings` hook: it provides all the specific settings regarding the current plugin it's been loaded from.
-
 - `useTalkingIndicator` hook: it gives you invormation on the user-voice data, that is, who is talking or muted.
+- `useMeeting` hook: it gives you information on the current meeting that the user is on.
+
+So for these types of hooks, the return will follow the same structure:
+
+```ts
+export interface GraphqlResponseWrapper<TData> {
+  loading: boolean;
+  data?: TData;
+  error?: ApolloError;
+}
+```
+
+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.
+
 
 ### Real time data exchange
 
@@ -197,27 +210,128 @@ export type ObjectTo = ToUserId | ToRole;
   - UserListUiDataNames.USER_LIST_IS_OPEN;
 
 Example of usage:
-```typscript
-const currentLocale = pluginApi.useUiData(IntlLocaleUiDataNames.CURRENT_LOCALE, {
+
+```ts
+  const currentLocale = pluginApi.useUiData(IntlLocaleUiDataNames.CURRENT_LOCALE, {
     locale: 'en',
     fallbackLocale: 'en',
   });
+  // 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.
+
+One other thing is that the type of the return is precisely the same type required as the second argument.
+
 ### Ui Commands to automatize tasks in BBB
 
 `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:
-  - 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}
-  - external-video:
-    - volume:
-      - set: this function will set the external video volume to a certain number between 0 and 1 (that is 0% and);
-  - layout:
-    - set: This function set the current layout with its argument (example: LayoutComponentListEnum.GENERIC_COMPONENT)
-    - unset: This function unset the current layout with its argument (example: LayoutComponentListEnum.GENERIC_COMPONENT)
+
+- 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}
+- external-video:
+  - volume:
+    - set: this function will set the external video volume to a certain number between 0 and 1 (that is 0% and);
+
+See usage ahead:
+
+```ts
+  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
 
 ### Dom Element Manipulation
 
 - `useChatMessageDomElements` hook: This hook will return the dom element of a chat message reactively, so one can modify whatever is inside, such as text, css, js, etc.;
+
+
+### Frequently Asked Questions (FAQ)
+
+**How do I remove a certain extensible area that I don't want anymore?**
+It is pretty simple: just set an empty array of elements of that specific extensible area.
+Or simply remove the specific item of the array and set the new array to that extensible area in the next iteration.
+
+See example below:
+
+```ts
+// First iteration:
+  // Define both variables:
+  const dropdownToUserListItem = { ... };
+  const buttonToUserListItem = { ... };
+  pluginApi.setActionsBarItems([dropdownToUserListItem, buttonToUserListItem]);
+
+// Second iteration:
+  // Redefine variable(s):
+  const newButtonToUserListItem = { ... };
+  pluginApi.setActionsBarItems([newButtonToUserListItem]);
+
+// Third iteration:
+  // I don't want any of this extensible-area:
+  pluginApi.setActionsBarItems([]);
+  // All set from this plugin will disappear from the UI;
+```
+
+**How to propperly build a plugin?**
+Just go to your plugin folder, install dependencies and run the build command as follows:
+
+```bash
+cd my-plugin-folder/
+npm i
+npm run build-bundl
+```
+
+At this point, another folder will be created into the plugin directory called "dist/" inside of that folder you will find the plugin itself `MyPlugin.js`. Remember that the name of this file will be the same as defined in the `webpack.config.js`, such as:
+
+```js
+module.exports = {
+  // ... Other configurations
+  output: {
+    filename: 'MyPlugin.js'
+  }
+  // ... Other configurations
+}
+```
+
+**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.
+
+**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:
+
+- The config has not been set properly inside `bbb-html5.yml`, see [this section to configure your plugin](#running-the-plugin-from-source);
+- The plugin is not even running in dev mode, it could be the port already in use, or typescript and/or javascript errors (Make sure to initialize the `pluginApi` as any of the samples inside a react function component);
+- It could be an error with that sample indeed, or that feature the plugin uses broke (it is not usual, but can happen since BBB is constantly changing and enhancing its features with its wonderful community). If that happens, just open an issue in the [SDK's github](https://github.com/bigbluebutton/bigbluebutton-html-plugin-sdk) detailing the error you are facing. And thank you in advance for reporting it back to us so we can improve each time.
+
+**How to troubleshoot the plugins? See if it has loaded in the BBB, for instance.**
+Well, each time a set of plugins are listed in the `bbb-html5.yml`, it will fire some logs based on the amount of plugins that it need to load inside the client. So open the console in the browser by pressing F12 key in your keyboard and search for the following log:
+
+```log
+<ratio of loaded plugins> plugins loaded
+```
+
+If 1 out of 5 plugins loaded, you'll see "1/5 plugins loaded", and so on.
+
+Also, when a plugin loaded, the client will log it's name like:
+
+```log
+Loaded plugin MyPlugin
+```
+
+Sometimes, there could be the case of a plugin to not load properly and an error will log with the following message:
+
+```log
+Error when loading plugin MyPlugin, error:  {"isTrusted":true}
+```
+
+In this case, the URL that leads to the plugin is not available or leads to an error. But it can log something different, so pay attention to what the error message will tell you.
+
+Lastly, there are, of course, other scenarios and different informative logs, but these are the most common and important ones. Please contact us if you feel we left something out!

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

@@ -19,6 +19,7 @@ export declare abstract class BbbPluginSdk {
      *
      */
     static initialize(uuid: string): void;
+    private static isReactEnvironment;
     /**
      * Returns the PluginApi. Use the PluginApi to access the hooks or setters functions for all the
      * extensible areas. For a complete list of those, see README.md

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

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BbbPluginSdk = void 0;
+/* eslint-disable no-console */
+var react_1 = require("react");
 var enums_1 = require("../../data-channel/enums");
 var commands_1 = require("../../ui-commands/commands");
 var hooks_1 = require("../../data-channel/hooks");
@@ -16,6 +18,7 @@ var hooks_7 = require("../../data-consumption/domain/chat/loaded-chat-messages/h
 var hooks_8 = require("../../dom-element-manipulation/chat/message/hooks");
 var hooks_9 = require("../../data-consumption/domain/user-voice/talking-indicator/hooks");
 var hooks_10 = require("../../ui-data-hooks/hooks");
+var hooks_11 = require("../../data-consumption/domain/meeting/from-core/hooks");
 /**
  * Class responsible for either initialize or get the PluginApi
  *
@@ -38,11 +41,14 @@ var BbbPluginSdk = /** @class */ (function () {
      *
      */
     BbbPluginSdk.initialize = function (uuid) {
+        if (!this.isReactEnvironment())
+            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.useCurrentPresentation = (function () { return (0, hooks_2.useCurrentPresentation)(); });
         pluginApi.useLoadedUserList = (function () { return (0, hooks_4.useLoadedUserList)(); });
         pluginApi.useCurrentUser = (function () { return (0, hooks_5.useCurrentUser)(); });
+        pluginApi.useMeeting = (function () { return (0, hooks_11.useMeeting)(); });
         pluginApi.useUsersBasicInfo = (function () { return (0, hooks_6.useUsersBasicInfo)(); });
         pluginApi.useTalkingIndicator = (function () { return (0, hooks_9.useTalkingIndicator)(); });
         pluginApi.useLoadedChatMessages = (function () { return (0, hooks_7.useLoadedChatMessages)(); });
@@ -62,6 +68,20 @@ var BbbPluginSdk = /** @class */ (function () {
             throw new Error('Plugin name not set');
         }
     };
+    BbbPluginSdk.isReactEnvironment = function () {
+        var fn = console.error;
+        try {
+            console.error = function () { };
+            (0, react_1.useEffect)(function () { }, []);
+        }
+        catch (_a) {
+            console.error = fn;
+            console.error('[PLUGIN-ERROR] Error: Initializing pluginApi outside of a react function component. It should be done inside');
+            return false;
+        }
+        console.error = fn;
+        return true;
+    };
     /**
      * Returns the PluginApi. Use the PluginApi to access the hooks or setters functions for all the
      * extensible areas. For a complete list of those, see README.md

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

@@ -1 +1 @@
-{"version":3,"file":"BbbPluginSdk.js","sourceRoot":"","sources":["../../../../src/core/api/BbbPluginSdk.ts"],"names":[],"mappings":";;;AAMA,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;AAE9F,0FAAuG;AACvG,oDAAsD;AAItD;;;;;;GAMG;AACH;IAAA;IA2FA,CAAC;IA1FC;;;;;;;;;;OAUG;IACW,uBAAU,GAAxB,UAAyB,IAAY;QACnC,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,iBAAiB,GAAG,CAAC,cAAM,OAAA,IAAA,yBAAiB,GAAE,EAAnB,CAAmB,CAA8B,CAAC;QACvF,SAAS,CAAC,mBAAmB,GAAG,CAAC,cAAM,OAAA,IAAA,2BAAmB,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,CAAC,EAArC,CAAqC,CAAC;QAC3C,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;SACnE;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SACxC;IACH,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,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,oBAAoB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAC9B,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,AA3FD,IA2FC;AA3FqB,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;AAE9F,0FAAuG;AACvG,oDAAsD;AAEtD,gFAAmF;AAInF;;;;;;GAMG;AACH;IAAA;IA2GA,CAAC;IA1GC;;;;;;;;;;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,2BAAmB,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,CAAC,EAArC,CAAqC,CAAC;QAC3C,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;SACnE;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,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,oBAAoB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAC9B,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,AA3GD,IA2GC;AA3GqB,oCAAY"}

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

@@ -25,6 +25,7 @@ import { UseLoadedChatMessagesFunction } from '../../data-consumption/domain/cha
 import { UseTalkingIndicatorFunction } from '../../data-consumption/domain/user-voice/talking-indicator/types';
 import { GenericComponentInterface } from '../../extensible-areas/generic-component/types';
 import { UseUiDataFunction } from '../../ui-data-hooks/types';
+import { UseMeetingFunction } from '../../data-consumption/domain/meeting/from-core/types';
 export type SetPresentationToolbarItems = (presentationToolbarItem: PresentationToolbarInterface[]) => string[];
 export type SetUserListDropdownItems = (userListDropdownItem: UserListDropdownInterface[]) => string[];
 export type SetActionButtonDropdownItems = (actionButtonDropdownInterface: ActionButtonDropdownInterface[]) => string[];
@@ -79,6 +80,14 @@ export interface PluginApi {
      *
      */
     useCurrentUser?: UseCurrentUserFunction;
+    /**
+     * Returns an object containing the data on the current meeting, i.e. the meeting on which the
+     * plugin is running.
+     *
+     * @returns `GraphqlResponseWrapper` with the CurrentMeeting type.
+     *
+     */
+    useMeeting?: UseMeetingFunction;
     /**
      * Returns an object containing the brief data on every user in te meeting.
      *

package/dist/cjs/data-consumption/domain/meeting/from-core/hooks.d.ts

@@ -0,0 +1,2 @@
+import { Meeting } from './types';
+export declare const useMeeting: () => import("../../../..").GraphqlResponseWrapper<Meeting[]>;

package/dist/cjs/data-consumption/domain/meeting/from-core/hooks.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useMeeting = void 0;
+var enums_1 = require("../../../enums");
+var hookCreator_1 = require("../../../factory/hookCreator");
+var useMeeting = function () { return (0, hookCreator_1.createDataConsumptionHook)(enums_1.DataConsumptionHooks.MEETING); };
+exports.useMeeting = useMeeting;
+//# sourceMappingURL=hooks.js.map

package/dist/cjs/data-consumption/domain/meeting/from-core/hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../../../../../src/data-consumption/domain/meeting/from-core/hooks.ts"],"names":[],"mappings":";;;AAAA,wCAAsD;AACtD,4DAAyE;AAGlE,IAAM,UAAU,GAAG,cAAM,OAAA,IAAA,uCAAyB,EAGvD,4BAAoB,CAAC,OAAO,CAC7B,EAJ+B,CAI/B,CAAC;AAJW,QAAA,UAAU,cAIrB"}

package/dist/cjs/data-consumption/domain/meeting/from-core/types.d.ts

@@ -0,0 +1,7 @@
+import { GraphqlResponseWrapper } from '../../../../core';
+export interface Meeting {
+    name: string;
+    meetingId: string;
+    loginUrl?: string;
+}
+export type UseMeetingFunction = () => GraphqlResponseWrapper<Meeting[]>;

package/dist/cjs/data-consumption/domain/meeting/from-core/types.js

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

package/dist/cjs/data-consumption/domain/meeting/from-core/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../src/data-consumption/domain/meeting/from-core/types.ts"],"names":[],"mappings":""}

package/dist/cjs/data-consumption/domain/meeting/index.d.ts

@@ -0,0 +1 @@
+export { Meeting } from './from-core/types';

package/dist/cjs/data-consumption/domain/meeting/index.js

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

package/dist/cjs/data-consumption/domain/meeting/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/data-consumption/domain/meeting/index.ts"],"names":[],"mappings":""}

package/dist/cjs/data-consumption/enums.d.ts

@@ -3,6 +3,7 @@ export declare enum DataConsumptionHooks {
     LOADED_USER_LIST = "Hooks::UseLoadedUserList",
     CURRENT_USER = "Hooks::UseCurrentUser",
     LOADED_CHAT_MESSAGES = "Hooks::UseLoadedChatMessages",
+    MEETING = "Hooks::UseMeeting",
     TALKING_INDICATOR = "Hooks::UseTalkingIndicator",
     CUSTOM_SUBSCRIPTION = "Hooks::CustomSubscription"
 }

package/dist/cjs/data-consumption/enums.js

@@ -7,6 +7,7 @@ var DataConsumptionHooks;
     DataConsumptionHooks["LOADED_USER_LIST"] = "Hooks::UseLoadedUserList";
     DataConsumptionHooks["CURRENT_USER"] = "Hooks::UseCurrentUser";
     DataConsumptionHooks["LOADED_CHAT_MESSAGES"] = "Hooks::UseLoadedChatMessages";
+    DataConsumptionHooks["MEETING"] = "Hooks::UseMeeting";
     DataConsumptionHooks["TALKING_INDICATOR"] = "Hooks::UseTalkingIndicator";
     DataConsumptionHooks["CUSTOM_SUBSCRIPTION"] = "Hooks::CustomSubscription";
 })(DataConsumptionHooks || (exports.DataConsumptionHooks = DataConsumptionHooks = {}));

package/dist/cjs/data-consumption/enums.js.map

@@ -1 +1 @@
-{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../src/data-consumption/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,oBAOX;AAPD,WAAY,oBAAoB;IAC9B,8EAAsD,CAAA;IACtD,qEAA6C,CAAA;IAC7C,8DAAsC,CAAA;IACtC,6EAAqD,CAAA;IACrD,wEAAgD,CAAA;IAChD,yEAAiD,CAAA;AACnD,CAAC,EAPW,oBAAoB,oCAApB,oBAAoB,QAO/B"}
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../src/data-consumption/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,oBAQX;AARD,WAAY,oBAAoB;IAC9B,8EAAsD,CAAA;IACtD,qEAA6C,CAAA;IAC7C,8DAAsC,CAAA;IACtC,6EAAqD,CAAA;IACrD,qDAA6B,CAAA;IAC7B,wEAAgD,CAAA;IAChD,yEAAiD,CAAA;AACnD,CAAC,EARW,oBAAoB,oCAApB,oBAAoB,QAQ/B"}

package/dist/cjs/data-consumption/index.d.ts

@@ -1,5 +1,6 @@
 export * from './domain/presentations';
 export * from './domain/chat';
+export * from './domain/meeting';
 export * from './domain/users';
 export * from './domain/user-voice';
 export * from './domain/shared';

package/dist/cjs/data-consumption/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./domain/presentations"), exports);
 __exportStar(require("./domain/chat"), exports);
+__exportStar(require("./domain/meeting"), exports);
 __exportStar(require("./domain/users"), exports);
 __exportStar(require("./domain/user-voice"), exports);
 __exportStar(require("./domain/shared"), exports);

package/dist/cjs/data-consumption/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/data-consumption/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC;AACvC,gDAA8B;AAC9B,iDAA+B;AAC/B,sDAAoC;AACpC,kDAAgC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/data-consumption/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC;AACvC,gDAA8B;AAC9B,mDAAiC;AACjC,iDAA+B;AAC/B,sDAAoC;AACpC,kDAAgC"}

package/dist/cjs/index.d.ts

@@ -3,3 +3,4 @@ export * from './data-consumption';
 export * from './data-channel';
 export * from './ui-data-hooks';
 export * from './core';
+export * from './utils';

package/dist/cjs/index.js

@@ -19,4 +19,5 @@ __exportStar(require("./data-consumption"), exports);
 __exportStar(require("./data-channel"), exports);
 __exportStar(require("./ui-data-hooks"), 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,yCAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AAEnC,qDAAmC;AAEnC,iDAA+B;AAE/B,kDAAgC;AAEhC,yCAAuB;AAEvB,0CAAwB"}

package/dist/cjs/utils/index.d.ts

@@ -0,0 +1,2 @@
+import pluginLogger from './logger/logger';
+export { pluginLogger };

package/dist/cjs/utils/index.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pluginLogger = void 0;
+var logger_1 = __importDefault(require("./logger/logger"));
+exports.pluginLogger = logger_1.default;
+//# sourceMappingURL=index.js.map

package/dist/cjs/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":";;;;;;AAAA,2DAA2C;AAElC,uBAFF,gBAAY,CAEE"}

package/dist/cjs/utils/logger/logger.d.ts

@@ -0,0 +1,2 @@
+declare const pluginLogger: import("browser-bunyan").Logger;
+export default pluginLogger;

package/dist/cjs/utils/logger/logger.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var browser_bunyan_1 = require("browser-bunyan");
+var console_formatted_stream_1 = require("@browser-bunyan/console-formatted-stream");
+var pluginLogger = (0, browser_bunyan_1.createLogger)({
+    name: 'PluginLogger',
+    streams: [
+        {
+            level: browser_bunyan_1.INFO,
+            stream: new console_formatted_stream_1.ConsoleFormattedStream(),
+        },
+    ],
+    serializers: browser_bunyan_1.stdSerializers,
+    src: true,
+});
+exports.default = pluginLogger;
+//# sourceMappingURL=logger.js.map

package/dist/cjs/utils/logger/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../../src/utils/logger/logger.ts"],"names":[],"mappings":";;AAAA,iDAAoE;AACpE,qFAAkF;AAElF,IAAM,YAAY,GAAG,IAAA,6BAAY,EAAC;IAChC,IAAI,EAAE,cAAc;IACpB,OAAO,EAAE;QACP;YACE,KAAK,EAAE,qBAAI;YACX,MAAM,EAAE,IAAI,iDAAsB,EAAE;SACrC;KACF;IAED,WAAW,EAAE,+BAAc;IAC3B,GAAG,EAAE,IAAI;CACV,CAAC,CAAC;AAEH,kBAAe,YAAY,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bigbluebutton-html-plugin-sdk",
-  "version": "0.0.46",
+  "version": "0.0.48",
   "homepage": "https://github.com/bigbluebutton/bigbluebutton-html-plugin-sdk",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -59,6 +59,8 @@
     "apollo"
   ],
   "dependencies": {
-    "@apollo/client": "^3.8.7"
+    "@apollo/client": "^3.8.7",
+    "@browser-bunyan/console-formatted-stream": "^1.8.0",
+    "browser-bunyan": "^1.8.0"
   }
 }