bigbluebutton-html-plugin-sdk 0.0.21 → 0.0.23

package/README.md

@@ -6,21 +6,34 @@ SDK for developing BigBlueButton plugins, examples of implementations can be fou
 
 ## API
 ### Extensible UI areas
-- Presentation toolbar items (button, separator, spinner)
-
-- User list dropdown items (option, separator)
-
 - 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) 
 
-- Nav bar (button, info) 
+- 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)
 
 ### Realtime data consumption
-- `useCurrentPresentation` hook: provides information regarding the current presentation.
+- `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);
 
-- `useLoadedUserList` hook: provides information regarding the loaded user list (displayed in the screen)
+### Real time data exchange
+- `useDataChannel` hook: this will allow you to exchange information (Send and receive) amongst different users through the same plugin;

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

@@ -0,0 +1,36 @@
+import { PluginApi } from './types';
+/**
+ * Class responsible for either initialize or get the PluginApi
+ *
+ * This PluginApi, is the object with which the developer can control
+ * things in the plugin, such as the extensible areas or the hooks
+ *
+ */
+export declare abstract class BbbPluginSdk {
+    /**
+     * Method responsible for initializing the hooks use it from the plugin-side if you are using
+     * one of the hooks, see complete list in the README.md
+     *
+     * @remarks
+     * This method is part of the BbbPluginSdk abstract class.
+     *
+     * @param uuid - The UUID generated by the html5 in which the developer can get with
+     * `document.currentScript?.getAttribute('uuid')` see any sample
+     *
+     */
+    static initialize(uuid: string): void;
+    /**
+     * 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
+     *
+     * @param uuid - The UUID generated by the html5 in which the developer can get with
+     * `document.currentScript?.getAttribute('uuid')` see any sample.
+     *
+     * @param pluginName - The PluginName given by the html5 in which the developer can get with
+     * `document.currentScript?.getAttribute('pluginName')` see any sample.
+     *
+     * @returns The PluginApi object
+     *
+     */
+    static getPluginApi(uuid: string, pluginName?: string): PluginApi;
+}

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

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BbbPluginSdk = void 0;
+var hooks_1 = require("../../data-channel/hooks");
+var hooks_2 = require("../../data-consumption/domain/presentations/current-presentation/hooks");
+var hooks_3 = require("../../data-consumption/domain/shared/custom-subscription/hooks");
+var hooks_4 = require("../../data-consumption/domain/users/loaded-user-list/hooks");
+var hooks_5 = require("../../data-consumption/domain/users/current-user/hooks");
+var hooks_6 = require("../../data-consumption/domain/users/users-basic-info/hooks");
+/**
+ * Class responsible for either initialize or get the PluginApi
+ *
+ * This PluginApi, is the object with which the developer can control
+ * things in the plugin, such as the extensible areas or the hooks
+ *
+ */
+var BbbPluginSdk = /** @class */ (function () {
+    function BbbPluginSdk() {
+    }
+    /**
+     * Method responsible for initializing the hooks use it from the plugin-side if you are using
+     * one of the hooks, see complete list in the README.md
+     *
+     * @remarks
+     * This method is part of the BbbPluginSdk abstract class.
+     *
+     * @param uuid - The UUID generated by the html5 in which the developer can get with
+     * `document.currentScript?.getAttribute('uuid')` see any sample
+     *
+     */
+    BbbPluginSdk.initialize = function (uuid) {
+        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.useUsersBasicInfo = (function () { return (0, hooks_6.useUsersBasicInfo)(); });
+        var pluginName = pluginApi === null || pluginApi === void 0 ? void 0 : pluginApi.pluginName;
+        if (pluginName) {
+            pluginApi.useDataChannel = (function (channelName) { return (0, hooks_1.useDataChannel)(channelName, pluginName, window.bbb_plugins[uuid]); });
+        }
+        else {
+            throw new Error('Plugin name not set');
+        }
+    };
+    /**
+     * 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
+     *
+     * @param uuid - The UUID generated by the html5 in which the developer can get with
+     * `document.currentScript?.getAttribute('uuid')` see any sample.
+     *
+     * @param pluginName - The PluginName given by the html5 in which the developer can get with
+     * `document.currentScript?.getAttribute('pluginName')` see any sample.
+     *
+     * @returns The PluginApi object
+     *
+     */
+    BbbPluginSdk.getPluginApi = function (uuid, pluginName) {
+        if (!window.bbb_plugins)
+            window.bbb_plugins = {};
+        if (Object.keys(window.bbb_plugins).indexOf(uuid) === -1) {
+            window.bbb_plugins[uuid] = {
+                setUserListDropdownItems: function () { },
+                setPresentationToolbarItems: function () { },
+                setActionButtonDropdownItems: function () { },
+                setActionsBarItems: function () { },
+                setAudioSettingsDropdownItems: function () { },
+                setPresentationDropdownItems: function () { },
+                setNavBarItems: function () { },
+                setOptionsDropdownItems: function () { },
+                setCameraSettingsDropdownItems: function () { },
+                setUserCameraDropdownItems: function () { },
+                setUserListItemAdditionalInformation: function () { },
+                mapOfDispatchers: {
+                    '': function () { },
+                },
+                pluginName: pluginName,
+            };
+        }
+        return window.bbb_plugins[uuid];
+    };
+    return BbbPluginSdk;
+}());
+exports.BbbPluginSdk = BbbPluginSdk;
+//# sourceMappingURL=BbbPluginSdk.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BbbPluginSdk.js","sourceRoot":"","sources":["../../../../src/core/api/BbbPluginSdk.ts"],"names":[],"mappings":";;;AAoBA,kDAA0D;AAC1D,gGAEgF;AAChF,wFAEwE;AACxE,oFAA+F;AAC/F,gFAAwF;AACxF,oFAA+F;AAI/F;;;;;;GAMG;AACH;IAAA;IAuEA,CAAC;IAtEC;;;;;;;;;;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,IAAM,UAAU,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,UAAU,CAAC;QACzC,IAAI,UAAU,EAAE;YACd,SAAS,CAAC,cAAc,GAAG,CAAC,UAC1B,WAAmB,IAChB,OAAA,IAAA,sBAAc,EAAC,WAAW,EAAE,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,EAAjE,CAAiE,CAChC,CAAC;SACxC;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,cAAO,CAAC;gBAClC,2BAA2B,EAAE,cAAO,CAAC;gBACrC,4BAA4B,EAAE,cAAO,CAAC;gBACtC,kBAAkB,EAAE,cAAO,CAAC;gBAC5B,6BAA6B,EAAE,cAAO,CAAC;gBACvC,4BAA4B,EAAE,cAAO,CAAC;gBACtC,cAAc,EAAE,cAAO,CAAC;gBACxB,uBAAuB,EAAE,cAAO,CAAC;gBACjC,8BAA8B,EAAE,cAAO,CAAC;gBACxC,0BAA0B,EAAE,cAAO,CAAC;gBACpC,oCAAoC,EAAE,cAAO,CAAC;gBAC9C,gBAAgB,EAAE;oBAChB,EAAE,EAAE,cAAO,CAAC;iBACb;gBACD,UAAU,YAAA;aACX,CAAC;SACH;QAED,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IACH,mBAAC;AAAD,CAAC,AAvED,IAuEC;AAvEqB,oCAAY"}

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

@@ -0,0 +1,102 @@
+import { ActionButtonDropdownItem } from '../../extensible-areas/action-button-dropdown-item/types';
+import { ActionsBarItem } from '../../extensible-areas/actions-bar-item/types';
+import { AudioSettingsDropdownItem } from '../../extensible-areas/audio-settings-dropdown-item/types';
+import { CameraSettingsDropdownItem } from '../../extensible-areas/camera-settings-dropdown-item/types';
+import { NavBarItem } from '../../extensible-areas/nav-bar-item/types';
+import { OptionsDropdownItem } from '../../extensible-areas/options-dropdown-item/types';
+import { PresentationDropdownItem } from '../../extensible-areas/presentation-dropdown-item/types';
+import { UserCameraDropdownItem } from '../../extensible-areas/user-camera-dropdown-item/types';
+import { UserListDropdownItem } from '../../extensible-areas/user-list-dropdown-item/types';
+import { UserListItemAdditionalInformation } from '../../extensible-areas/user-list-item-additional-information/types';
+import { PresentationToolbarItem } from '../../extensible-areas/presentation-toolbar-item/types';
+import { UseCurrentPresentationFunction } from '../../data-consumption/domain/presentations/current-presentation/types';
+import { UseLoadedUserListFunction } from '../../data-consumption/domain/users/loaded-user-list/types';
+import { UseCurrentUserFunction } from '../../data-consumption/domain/users/current-user/types';
+import { UseUsersBasicInfoFunction } from '../../data-consumption/domain/users/users-basic-info/types';
+import { UseCustomSubscriptionFunction } from '../../data-consumption/domain/shared/custom-subscription/types';
+import { MapOfDispatchers, UseDataChannelFunctionFromPluginApi } from '../../data-channel/types';
+export type SetPresentationToolbarItems = (presentationToolbarItem: PresentationToolbarItem[]) => void;
+export type SetUserListDropdownItems = (userListDropdownItem: UserListDropdownItem[]) => void;
+export type SetActionButtonDropdownItems = (actionButtonDropdownItem: ActionButtonDropdownItem[]) => void;
+export type SetActionsBarItems = (actionsBarItems: ActionsBarItem[]) => void;
+export type SetAudioSettingsDropdownItems = (audioSettingsDropdownItem: AudioSettingsDropdownItem[]) => void;
+export type SetPresentationDropdownItems = (userListDropdownItem: PresentationDropdownItem[]) => void;
+export type SetNavBarItems = (userListDropdownItem: NavBarItem[]) => void;
+export type SetOptionsDropdownItems = (optionsDropdownItem: OptionsDropdownItem[]) => void;
+export type SetCameraSettingsDropdownItems = (cameraSettingsDropdownItem: CameraSettingsDropdownItem[]) => void;
+export type SetUserCameraDropdownItems = (userCameraDropdownItem: UserCameraDropdownItem[]) => void;
+export type SetUserListItemAdditionalInformation = (userListItemAdditionalInformation: UserListItemAdditionalInformation[]) => void;
+/**
+ * Object that makes plugin hooks and extensible area setters available for developers to use.
+ */
+export interface PluginApi {
+    pluginName?: string;
+    setPresentationToolbarItems: SetPresentationToolbarItems;
+    setUserListDropdownItems: SetUserListDropdownItems;
+    setActionButtonDropdownItems: SetActionButtonDropdownItems;
+    setActionsBarItems: SetActionsBarItems;
+    setAudioSettingsDropdownItems: SetAudioSettingsDropdownItems;
+    setPresentationDropdownItems: SetPresentationDropdownItems;
+    setNavBarItems: SetNavBarItems;
+    setOptionsDropdownItems: SetOptionsDropdownItems;
+    setCameraSettingsDropdownItems: SetCameraSettingsDropdownItems;
+    setUserCameraDropdownItems: SetUserCameraDropdownItems;
+    setUserListItemAdditionalInformation: SetUserListItemAdditionalInformation;
+    /**
+     * Returns an object containing the data on the current presentation being displayed
+     * in the presentation area, and its current page.
+     *
+     * @returns `GraphqlResponseWrapper` with the CurrentPresentation in the `data` field
+     *
+     */
+    useCurrentPresentation?: UseCurrentPresentationFunction;
+    /**
+     * Returns an object containing the data on the currently loaded user list (
+     * the one being displayed in that moment).
+     *
+     * @returns `GraphqlResponseWrapper` with the LoadedUserList type.
+     *
+     */
+    useLoadedUserList?: UseLoadedUserListFunction;
+    /**
+     * Returns an object containing the data on the current user, i.e. the user on which the
+     * plugin is running.
+     *
+     * @returns `GraphqlResponseWrapper` with the CurrentUser type.
+     *
+     */
+    useCurrentUser?: UseCurrentUserFunction;
+    /**
+     * Returns an object containing the brief data on every user in te meeting.
+     *
+     * @returns `GraphqlResponseWrapper` with the UserBasicInfo type.
+     *
+     */
+    useUsersBasicInfo?: UseUsersBasicInfoFunction;
+    /**
+     * Returns an object containing the data on the current presentation being displayed
+     * in the presentation area, and its current page.
+     *
+     * @returns `GraphqlResponseWrapper` with the data type specified in the generic type.
+     *
+     */
+    useCustomSubscription?: UseCustomSubscriptionFunction;
+    /**
+     * Returns an array with tha data wrapped in the `GraphqlResponseWrapper` in the first
+     * position of the array and the dispatcher function in which one plugin can inform
+     * the others.
+     *
+     * This is used for the different plugins in the meeting to communicate.
+     *
+     * @param channelName - the channel name in which you want to communicate
+     * @returns The array of data wrapped in the `GraphqlResponseWrapper` and the dispatcher function
+     *
+     */
+    useDataChannel?: UseDataChannelFunctionFromPluginApi;
+    mapOfDispatchers: MapOfDispatchers;
+}
+export interface PluginBrowserWindow extends Window {
+    bbb_plugins: {
+        [key: string]: PluginApi;
+    };
+}

package/dist/cjs/{data-consumption/types/presentation.js → core/api/types.js}

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

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

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

package/dist/cjs/core/enum.d.ts

@@ -0,0 +1,12 @@
+export declare enum HookEvents {
+    UPDATED = "HOOK_DATA_UPDATED",
+    SUBSCRIBED = "PLUGIN_SUBSCRIBED_TO_HOOK",
+    UNSUBSCRIBED = "PLUGIN_UNSUBSCRIBED_FROM_HOOK"
+}
+export declare enum Hooks {
+    CURRENT_PRESENTATION = "Hooks::UseCurrentPresentation",
+    LOADED_USER_LIST = "Hooks::UseLoadedUserList",
+    CURRENT_USER = "Hooks::UseCurrentUser",
+    CUSTOM_SUBSCRIPTION = "Hooks::CustomSubscription",
+    DATA_CHANNEL = "Hooks::DataChannel"
+}

package/dist/cjs/core/enum.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Hooks = exports.HookEvents = void 0;
+var HookEvents;
+(function (HookEvents) {
+    HookEvents["UPDATED"] = "HOOK_DATA_UPDATED";
+    HookEvents["SUBSCRIBED"] = "PLUGIN_SUBSCRIBED_TO_HOOK";
+    HookEvents["UNSUBSCRIBED"] = "PLUGIN_UNSUBSCRIBED_FROM_HOOK";
+})(HookEvents || (exports.HookEvents = HookEvents = {}));
+var Hooks;
+(function (Hooks) {
+    Hooks["CURRENT_PRESENTATION"] = "Hooks::UseCurrentPresentation";
+    Hooks["LOADED_USER_LIST"] = "Hooks::UseLoadedUserList";
+    Hooks["CURRENT_USER"] = "Hooks::UseCurrentUser";
+    Hooks["CUSTOM_SUBSCRIPTION"] = "Hooks::CustomSubscription";
+    Hooks["DATA_CHANNEL"] = "Hooks::DataChannel";
+})(Hooks || (exports.Hooks = Hooks = {}));
+//# sourceMappingURL=enum.js.map

package/dist/cjs/core/enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../../src/core/enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,2CAA6B,CAAA;IAC7B,sDAAwC,CAAA;IACxC,4DAA8C,CAAA;AAChD,CAAC,EAJW,UAAU,0BAAV,UAAU,QAIrB;AAED,IAAY,KAMX;AAND,WAAY,KAAK;IACf,+DAAsD,CAAA;IACtD,sDAA6C,CAAA;IAC7C,+CAAsC,CAAA;IACtC,0DAAiD,CAAA;IACjD,4CAAmC,CAAA;AACrC,CAAC,EANW,KAAK,qBAAL,KAAK,QAMhB"}

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

@@ -1 +1,3 @@
-export * from './getPluginApi';
+export { BbbPluginSdk } from './api/BbbPluginSdk';
+export { PluginApi } from './api/types';
+export { GraphqlResponseWrapper } from './types';

package/dist/cjs/core/index.js

@@ -1,18 +1,6 @@
 "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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./getPluginApi"), exports);
+exports.BbbPluginSdk = void 0;
+var BbbPluginSdk_1 = require("./api/BbbPluginSdk");
+Object.defineProperty(exports, "BbbPluginSdk", { enumerable: true, get: function () { return BbbPluginSdk_1.BbbPluginSdk; } });
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/core/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/core/index.ts"],"names":[],"mappings":";;;AAAA,mDAAkD;AAAzC,4GAAA,YAAY,OAAA"}

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

@@ -0,0 +1,33 @@
+import { ApolloError } from '@apollo/client';
+import { CustomSubscriptionArguments } from '../data-consumption/domain/shared/custom-subscription/types';
+import { Hooks } from './enum';
+import { DataChannelArguments } from '../data-channel/types';
+/**
+ * Wrapper for the data that comes from the core. With this more complex object
+ * it is also possible to know whether the data is still loading, of even if something
+ * wrong happened.
+ *
+ * @typeParam TData - Data that the developer will be expecting from the core.
+ */
+export interface GraphqlResponseWrapper<TData> {
+    loading: boolean;
+    data?: TData;
+    error?: ApolloError;
+}
+export type HookArguments = CustomSubscriptionArguments | DataChannelArguments;
+export interface UpdatedEventDetails<T> {
+    hook: Hooks;
+    hookArguments?: HookArguments;
+    data: T;
+}
+export interface SubscribedEventDetails {
+    hook: Hooks;
+    hookArguments?: HookArguments;
+}
+export interface UnsubscribedEventDetails {
+    hook: Hooks;
+    hookArguments?: HookArguments;
+}
+export interface HookEventWrapper<T> extends Event {
+    detail: UpdatedEventDetails<T> | SubscribedEventDetails | UnsubscribedEventDetails;
+}

package/dist/cjs/core/types.js

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

package/dist/cjs/core/types.js.map

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

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

@@ -0,0 +1,10 @@
+/**
+ * Enum for each role in possible for a user to assume in the meeting
+ * The developer can specify them when dispatching data with the dispatcher function
+ * returned from the `pluginApi.useChannel`.
+ */
+export declare enum DataChannelDispatcherUserRole {
+    PRESENTER = "PRESENTER",
+    MODERATOR = "MODERATOR",
+    VIEWER = "VIEWER"
+}

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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataChannelDispatcherUserRole = void 0;
+// Role
+/**
+ * Enum for each role in possible for a user to assume in the meeting
+ * The developer can specify them when dispatching data with the dispatcher function
+ * returned from the `pluginApi.useChannel`.
+ */
+var DataChannelDispatcherUserRole;
+(function (DataChannelDispatcherUserRole) {
+    DataChannelDispatcherUserRole["PRESENTER"] = "PRESENTER";
+    DataChannelDispatcherUserRole["MODERATOR"] = "MODERATOR";
+    DataChannelDispatcherUserRole["VIEWER"] = "VIEWER";
+})(DataChannelDispatcherUserRole || (exports.DataChannelDispatcherUserRole = DataChannelDispatcherUserRole = {}));
+//# sourceMappingURL=enums.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../src/data-channel/enums.ts"],"names":[],"mappings":";;;AAAA,OAAO;AACP;;;;GAIG;AACH,IAAY,6BAIX;AAJD,WAAY,6BAA6B;IACvC,wDAAuB,CAAA;IACvB,wDAAuB,CAAA;IACvB,kDAAiB,CAAA;AACnB,CAAC,EAJW,6BAA6B,6CAA7B,6BAA6B,QAIxC"}

package/dist/cjs/data-channel/hooks.d.ts

@@ -0,0 +1,3 @@
+import { UseDataChannelStaticFunction } from './types';
+export declare const createChannelIdentifier: (channelName: string, pluginName: string) => string;
+export declare const useDataChannel: UseDataChannelStaticFunction;

package/dist/cjs/data-channel/{useDatachannel.js → hooks.js}

@@ -2,15 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useDataChannel = exports.createChannelIdentifier = void 0;
 var react_1 = require("react");
-var index_1 = require("../index");
+var enum_1 = require("../core/enum");
 var createChannelIdentifier = function (channelName, pluginName) { return "".concat(channelName, "::").concat(pluginName); };
 exports.createChannelIdentifier = createChannelIdentifier;
-var useDataChannel = (function (channelName, pluginName, pluginApi) {
-    var _a = (0, react_1.useState)(), data = _a[0], setData = _a[1];
+exports.useDataChannel = (function (channelName, pluginName, pluginApi) {
+    var _a = (0, react_1.useState)({ loading: true }), data = _a[0], setData = _a[1];
     var _b = (0, react_1.useState)(), dispatcherFunction = _b[0], setDispatcherFunction = _b[1];
-    var channelIdentifier = createChannelIdentifier(channelName, pluginName);
+    var channelIdentifier = (0, exports.createChannelIdentifier)(channelName, pluginName);
     var handleDataChange = (function (customEvent) {
-        setData(customEvent.detail.data);
+        var eventDetail = customEvent.detail;
+        setData(eventDetail.data);
     });
     var handleListenToChangeDisPatcherFunction = (function () {
         setDispatcherFunction(function () { return pluginApi.mapOfDispatchers[channelIdentifier]; });
@@ -19,17 +20,17 @@ var useDataChannel = (function (channelName, pluginName, pluginApi) {
     (0, react_1.useEffect)(function () {
         window.addEventListener(channelIdentifier, handleDataChange);
         window.addEventListener("".concat(channelIdentifier, "::dispatcherFunction"), handleListenToChangeDisPatcherFunction);
-        window.dispatchEvent(new CustomEvent(index_1.Internal.BbbHookEvents.Subscribe, {
+        window.dispatchEvent(new CustomEvent(enum_1.HookEvents.SUBSCRIBED, {
             detail: {
-                hook: index_1.Internal.BbbDataChannel.UseDataChannel,
-                parameters: { channelName: channelName, pluginName: pluginName },
+                hook: enum_1.Hooks.DATA_CHANNEL,
+                hookArguments: { channelName: channelName, pluginName: pluginName },
             },
         }));
         return function () {
-            window.dispatchEvent(new CustomEvent(index_1.Internal.BbbHookEvents.Unsubscribe, {
+            window.dispatchEvent(new CustomEvent(enum_1.HookEvents.UNSUBSCRIBED, {
                 detail: {
-                    hook: index_1.Internal.BbbDataChannel.UseDataChannel,
-                    parameters: { channelName: channelName, pluginName: pluginName },
+                    hook: enum_1.Hooks.DATA_CHANNEL,
+                    hookArguments: { channelName: channelName, pluginName: pluginName },
                 },
             }));
             window.removeEventListener(channelIdentifier, handleDataChange);
@@ -37,5 +38,4 @@ var useDataChannel = (function (channelName, pluginName, pluginApi) {
     }, []);
     return [data, dispatcherFunction];
 });
-exports.useDataChannel = useDataChannel;
-//# sourceMappingURL=useDatachannel.js.map
+//# sourceMappingURL=hooks.js.map

package/dist/cjs/data-channel/hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../../src/data-channel/hooks.ts"],"names":[],"mappings":";;;AAAA,+BAA4C;AAQ5C,qCAEsB;AAMf,IAAM,uBAAuB,GAAG,UAAC,WAAmB,EAAE,UAAkB,IAAK,OAAA,UAAG,WAAW,eAAK,UAAU,CAAE,EAA/B,CAA+B,CAAC;AAAvG,QAAA,uBAAuB,2BAAgF;AAEvG,QAAA,cAAc,GAAG,CAAC,UAAI,WAAmB,EACpD,UAAkB,EAAE,SAAoB;IAElC,IAAA,KAAkB,IAAA,gBAAQ,EAA4B,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAvE,IAAI,QAAA,EAAE,OAAO,QAA0D,CAAC;IACzE,IAAA,KAA8C,IAAA,gBAAQ,GAAsB,EAA3E,kBAAkB,QAAA,EAAE,qBAAqB,QAAkC,CAAC;IAEnF,IAAM,iBAAiB,GAAG,IAAA,+BAAuB,EAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IAE3E,IAAM,gBAAgB,GAAkB,CAAC,UACvC,WAAwD;QAExD,IAAM,WAAW,GAAG,WAAW,CAAC,MAAwD,CAAC;QACzF,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC,CAAkB,CAAC;IAEpB,IAAM,sCAAsC,GAAkB,CAC5D;QACE,qBAAqB,CAAC,cAAM,OAAA,SAAS,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,EAA7C,CAA6C,CAAC,CAAC;QAC3E,MAAM,CAAC,mBAAmB,CACxB,UAAG,iBAAiB,yBAAsB,EAC1C,sCAAsC,CACvC,CAAC;IACJ,CAAC,CAAkB,CAAC;IACtB,IAAA,iBAAS,EAAC;QACR,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAC;QAC7D,MAAM,CAAC,gBAAgB,CACrB,UAAG,iBAAiB,yBAAsB,EAC1C,sCAAsC,CACvC,CAAC;QAEF,MAAM,CAAC,aAAa,CAAC,IAAI,WAAW,CAAyB,iBAAU,CAAC,UAAU,EAAE;YAClF,MAAM,EAAE;gBACN,IAAI,EAAE,YAAK,CAAC,YAAY;gBACxB,aAAa,EAAE,EAAE,WAAW,aAAA,EAAE,UAAU,YAAA,EAAE;aAC3C;SACF,CAAC,CAAC,CAAC;QACJ,OAAO;YACL,MAAM,CAAC,aAAa,CAAC,IAAI,WAAW,CAA2B,iBAAU,CAAC,YAAY,EAAE;gBACtF,MAAM,EAAE;oBACN,IAAI,EAAE,YAAK,CAAC,YAAY;oBACxB,aAAa,EAAE,EAAE,WAAW,aAAA,EAAE,UAAU,YAAA,EAAE;iBAC3C;aACF,CAAC,CAAC,CAAC;YACJ,MAAM,CAAC,mBAAmB,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAC;QAClE,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,OAAO,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;AACpC,CAAC,CAAiC,CAAC"}

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

@@ -1,2 +1,2 @@
-export * from './types';
-export * from './useDatachannel';
+export { DataChannelDispatcherUserRole } from './enums';
+export { ToUserId, ToRole } from './types';

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

@@ -1,19 +1,6 @@
 "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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
-__exportStar(require("./useDatachannel"), exports);
+exports.DataChannelDispatcherUserRole = void 0;
+var enums_1 = require("./enums");
+Object.defineProperty(exports, "DataChannelDispatcherUserRole", { enumerable: true, get: function () { return enums_1.DataChannelDispatcherUserRole; } });
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/data-channel/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,mDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/data-channel/index.ts"],"names":[],"mappings":";;;AAAA,iCAAwD;AAA/C,sHAAA,6BAA6B,OAAA"}

package/dist/cjs/data-channel/types.d.ts

@@ -1,15 +1,25 @@
-import { PluginApi, Role } from '..';
+import { GraphqlResponseWrapper, PluginApi } from '..';
+import { DataChannelDispatcherUserRole } from './enums';
+export interface DataChannelArguments {
+    pluginName: string;
+    channelName: string;
+}
+/**
+ * Type to specify the useId that will be able to receive the data sent in the dispatcher function.
+ */
 export interface ToUserId {
     userId: string;
 }
+/**
+ * Type to specify the role that will be able to receive the data sent in the dispatcher function.
+ */
 export interface ToRole {
-    role: Role;
+    role: DataChannelDispatcherUserRole;
 }
 export type ObjectTo = ToUserId | ToRole;
 export type DispatcherFunction = <T>(objectToDispatch: T, objectsTo?: ObjectTo[]) => void;
 export interface MapOfDispatchers {
     [key: string]: DispatcherFunction;
 }
-export type UseDataChannel = <T>(channelName: string) => [T, DispatcherFunction];
-export type UseDataChannelAuxiliary = <T>(channelName: string, pluginName: string, pluginApi: PluginApi) => [T, DispatcherFunction?];
-export type UseDataChannelAPi = <T>(channelName: string) => [T, DispatcherFunction?];
+export type UseDataChannelFunctionFromPluginApi = <T>(channelName: string) => [GraphqlResponseWrapper<T>, DispatcherFunction];
+export type UseDataChannelStaticFunction = <T>(channelName: string, pluginName: string, pluginApi: PluginApi) => [GraphqlResponseWrapper<T>, DispatcherFunction?];

package/dist/cjs/data-consumption/domain/presentations/current-presentation/hooks.d.ts

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

package/dist/cjs/data-consumption/domain/presentations/current-presentation/hooks.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useCurrentPresentation = void 0;
+var enum_1 = require("../../../../core/enum");
+var hookCreator_1 = require("../../../factory/hookCreator");
+var useCurrentPresentation = function () { return (0, hookCreator_1.createDataConsumptionHook)(enum_1.Hooks.CURRENT_PRESENTATION); };
+exports.useCurrentPresentation = useCurrentPresentation;
+//# sourceMappingURL=hooks.js.map

package/dist/cjs/data-consumption/domain/presentations/current-presentation/hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../../../../../src/data-consumption/domain/presentations/current-presentation/hooks.ts"],"names":[],"mappings":";;;AAAA,8CAE+B;AAI/B,4DAAyE;AAElE,IAAM,sBAAsB,GAAG,cAAM,OAAA,IAAA,uCAAyB,EACnE,YAAK,CAAC,oBAAoB,CAC3B,EAF2C,CAE3C,CAAC;AAFW,QAAA,sBAAsB,0BAEjC"}

package/dist/cjs/data-consumption/{types/presentation.d.ts → domain/presentations/current-presentation/types.d.ts}

@@ -1,3 +1,4 @@
+import { GraphqlResponseWrapper } from '../../../../core';
 export interface CurrentPresentationPageUrls {
     thumbnail: string;
     png: string;
@@ -7,9 +8,10 @@ export interface CurrentPresentationPageUrls {
 export interface CurrentPresentationPage {
     id: string;
     num: number;
-    urls: CurrentPresentationPageUrls;
+    urlsJson: CurrentPresentationPageUrls;
 }
 export interface CurrentPresentation {
     presentationId: string;
     currentPage: CurrentPresentationPage;
 }
+export type UseCurrentPresentationFunction = () => GraphqlResponseWrapper<CurrentPresentation>;

package/dist/cjs/data-consumption/domain/presentations/current-presentation/types.js

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

package/dist/cjs/data-consumption/domain/presentations/current-presentation/types.js.map

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

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

@@ -0,0 +1 @@
+export { CurrentPresentation } from './current-presentation/types';

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

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

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

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

package/dist/cjs/data-consumption/domain/shared/custom-subscription/hooks.d.ts

@@ -0,0 +1,2 @@
+import { UseCustomSubscriptionFunction } from './types';
+export declare const useCustomSubscription: UseCustomSubscriptionFunction;