bigbluebutton-html-plugin-sdk 0.0.67 → 0.0.69

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/README.md +27 -25
  2. package/dist/cjs/index.d.ts +1 -0
  3. package/dist/cjs/index.js +1 -0
  4. package/dist/cjs/index.js.map +1 -1
  5. package/dist/cjs/ui-commands/actions-bar/commands.d.ts +11 -0
  6. package/dist/cjs/ui-commands/actions-bar/commands.js +22 -0
  7. package/dist/cjs/ui-commands/actions-bar/commands.js.map +1 -0
  8. package/dist/cjs/ui-commands/actions-bar/enums.d.ts +3 -0
  9. package/dist/cjs/ui-commands/actions-bar/enums.js +8 -0
  10. package/dist/cjs/ui-commands/actions-bar/enums.js.map +1 -0
  11. package/dist/cjs/ui-commands/actions-bar/types.d.ts +6 -0
  12. package/dist/cjs/ui-commands/actions-bar/types.js +3 -0
  13. package/dist/cjs/ui-commands/actions-bar/types.js.map +1 -0
  14. package/dist/cjs/ui-commands/commands.d.ts +12 -0
  15. package/dist/cjs/ui-commands/commands.js +8 -0
  16. package/dist/cjs/ui-commands/commands.js.map +1 -1
  17. package/dist/cjs/ui-commands/index.d.ts +2 -0
  18. package/dist/cjs/ui-commands/index.js +8 -0
  19. package/dist/cjs/ui-commands/index.js.map +1 -0
  20. package/dist/cjs/ui-commands/layout/commands.d.ts +9 -0
  21. package/dist/cjs/ui-commands/layout/commands.js +19 -0
  22. package/dist/cjs/ui-commands/layout/commands.js.map +1 -0
  23. package/dist/cjs/ui-commands/layout/enums.d.ts +13 -0
  24. package/dist/cjs/ui-commands/layout/enums.js +19 -0
  25. package/dist/cjs/ui-commands/layout/enums.js.map +1 -0
  26. package/dist/cjs/ui-commands/layout/types.d.ts +8 -0
  27. package/dist/cjs/ui-commands/layout/types.js +3 -0
  28. package/dist/cjs/ui-commands/layout/types.js.map +1 -0
  29. package/dist/cjs/ui-commands/nav-bar/commands.d.ts +10 -0
  30. package/dist/cjs/ui-commands/nav-bar/commands.js +21 -0
  31. package/dist/cjs/ui-commands/nav-bar/commands.js.map +1 -0
  32. package/dist/cjs/ui-commands/nav-bar/enums.d.ts +3 -0
  33. package/dist/cjs/ui-commands/nav-bar/enums.js +8 -0
  34. package/dist/cjs/ui-commands/nav-bar/enums.js.map +1 -0
  35. package/dist/cjs/ui-commands/nav-bar/types.d.ts +6 -0
  36. package/dist/cjs/ui-commands/nav-bar/types.js +3 -0
  37. package/dist/cjs/ui-commands/nav-bar/types.js.map +1 -0
  38. package/dist/cjs/ui-commands/notification/commands.d.ts +7 -0
  39. package/dist/cjs/ui-commands/notification/commands.js +15 -0
  40. package/dist/cjs/ui-commands/notification/commands.js.map +1 -0
  41. package/dist/cjs/ui-commands/notification/enums.d.ts +10 -0
  42. package/dist/cjs/ui-commands/notification/enums.js +16 -0
  43. package/dist/cjs/ui-commands/notification/enums.js.map +1 -0
  44. package/dist/cjs/ui-commands/notification/types.d.ts +17 -0
  45. package/dist/cjs/ui-commands/notification/types.js +3 -0
  46. package/dist/cjs/ui-commands/notification/types.js.map +1 -0
  47. package/dist/cjs/ui-commands/types.d.ts +8 -0
  48. package/package.json +1 -1
package/README.md CHANGED
@@ -35,7 +35,7 @@ you do the following:
35
35
  2. Add reference to it on BigBlueButton's `/create` call or add it on `/usr/share/bbb-web/WEB-INF/classes/bigbluebutton.properties`:
36
36
 
37
37
  ```
38
- pluginsManifests=[{"url": "http://localhost:4701/manifest.json"}]
38
+ pluginManifests=[{"url": "http://localhost:4701/manifest.json"}]
39
39
  ```
40
40
 
41
41
  *Running from souce code with a remote BBB-server*
@@ -78,7 +78,7 @@ or
78
78
  5. Add this create parameter into the API-mate of the server you are testing it on:
79
79
 
80
80
  ```
81
- pluginsManifests=[{"url": "https://<uuid>.ngrok-free.app/manifest.json"}]
81
+ pluginManifests=[{"url": "https://<uuid>.ngrok-free.app/manifest.json"}]
82
82
  ```
83
83
 
84
84
  And there you go, you can test it freely.
@@ -195,7 +195,7 @@ const {
195
195
  deleteEntry: deleteEntryFunction, // Function to delete specific item or wipe all
196
196
  replaceEntry: replaceEntryFunction, // Function replace a specifi item
197
197
  } = useDataChannel<CustomType>(
198
- channelName, // Defined according to what is on settings.yml from bbb-htlm5
198
+ channelName, // Defined according to what is on manifest.json
199
199
  DataChannelTypes.All_ITEMS, // | LATEST_ITEM | NEW_ITEMS -> ALL_ITEMS is default
200
200
  subChannelName = 'default', // If no subchannelName is specified, it will be 'default'
201
201
  );
@@ -203,26 +203,26 @@ const {
203
203
 
204
204
  Wiping all data off will delete every item from the specific data-channel within the specific subchannel-name.
205
205
 
206
- The data-channel name must be written in the settings.yml.
207
-
208
- All the permission for writing and deleting must be in the yaml too just like the example ahead:
209
-
210
- ```yaml
211
- public:
212
- plugins:
213
- - name: PluginName
214
- url: http://<your-hosted-plugin>/PluginName.js
215
- dataChannels:
216
- - name: channel-name
217
- # pushPermission options: moderator, presenter, all
218
- pushPermission: ['moderator','presenter']
219
- # replaceOrDeletePermission options: moderator, presenter, creator, all
220
- replaceOrdeletePermission:
221
- - moderator
222
- - sender
223
- ```
206
+ **Data-channel configuration:**
207
+
208
+ The data-channel name must be in the `manifest.json` along with all the permissions for writting, reading and deleting, see example below:
209
+
210
+ ```json
211
+ {
212
+ "requiredSdkVersion": "~0.0.59",
213
+ "name": "PluginName",
214
+ "javascriptEntrypointUrl": "PluginName.js",
215
+ "dataChannels":[
216
+ {
217
+ "name": "channel-name",
218
+ "pushPermission": ["moderator","presenter"],
219
+ "replaceOrDeletePermission": ["moderator", "sender"]
220
+ }
221
+ ]
222
+ }
223
+ ```
224
224
 
225
- If no permission is mentioned in the yaml (writing or deleting), no one will be able proceed with that specific action:
225
+ If no permission is mentioned in that file (writing or deleting), no one will be able proceed with that specific action:
226
226
 
227
227
  The `pushEntryFunction` has a minor detail to pay attention to, it is possible to specify the users who you want to send the item to, if none is specified, all will receive the item, such as done ahead:
228
228
 
@@ -287,6 +287,8 @@ One other thing is that the type of the return is precisely the same type requir
287
287
  - close: this function will close the presentation area content automatically;
288
288
  - conference:
289
289
  - setSpeakerLevel: this function will set the speaker volume level(audio output) of the conference to a certain number between 0 and 1;
290
+ - notification:
291
+ - 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;
290
292
  - user-status:
291
293
  - setAwayStatus: this function will set the away status of the user to a certain status;
292
294
 
@@ -365,7 +367,7 @@ Then when creating the meeting send the following parameters along, adjusting to
365
367
 
366
368
  ```
367
369
  meta_pluginSettingsUserInformation=https://<your-external-source-with-your-authentication>/api/users
368
- pluginsManifests=[{"url": "http://<domain-of-your-manifest>/your-plugin/manifest.json"}]
370
+ pluginManifests=[{"url": "http://<domain-of-your-manifest>/your-plugin/manifest.json"}]
369
371
  ```
370
372
 
371
373
  In the plugin, just use the function like:
@@ -438,12 +440,12 @@ No, feel free to host it anywhere you want, just make sure to point the URL from
438
440
  **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?**
439
441
  Well there are several motives to why the sample is not working properly, so I will go through each one of them briefly:
440
442
 
441
- - The config has not been set properly inside `bbb-html5.yml`, see [this section to configure your plugin](#running-the-plugin-from-source);
443
+ - The config has not been set properly in `manifest.json`, see [this section to configure your plugin](#running-the-plugin-from-source);
442
444
  - 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);
443
445
  - 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&#39;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.
444
446
 
445
447
  **How to troubleshoot the plugins? See if it has loaded in the BBB, for instance.**
446
- 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:
448
+ Well, each time a set of plugins listed to be run into a specific meeting start, 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:
447
449
 
448
450
  ```log
449
451
  <ratio of loaded plugins> plugins loaded
@@ -3,5 +3,6 @@ export * from './data-consumption';
3
3
  export * from './data-channel';
4
4
  export * from './ui-data-hooks';
5
5
  export * from './server-commands';
6
+ export * from './ui-commands';
6
7
  export * from './core';
7
8
  export * from './utils';
package/dist/cjs/index.js CHANGED
@@ -19,6 +19,7 @@ __exportStar(require("./data-consumption"), exports);
19
19
  __exportStar(require("./data-channel"), exports);
20
20
  __exportStar(require("./ui-data-hooks"), exports);
21
21
  __exportStar(require("./server-commands"), exports);
22
+ __exportStar(require("./ui-commands"), exports);
22
23
  __exportStar(require("./core"), exports);
23
24
  __exportStar(require("./utils"), exports);
24
25
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AAEnC,qDAAmC;AAEnC,iDAA+B;AAE/B,kDAAgC;AAEhC,oDAAkC;AAElC,yCAAuB;AAEvB,0CAAwB"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AAEnC,qDAAmC;AAEnC,iDAA+B;AAE/B,kDAAgC;AAEhC,oDAAkC;AAElC,gDAA8B;AAE9B,yCAAuB;AAEvB,0CAAwB"}
@@ -0,0 +1,11 @@
1
+ import { SetDisplayActionBarCommandArguments } from './types';
2
+ export declare const actionsBar: {
3
+ /**
4
+ * Decides whether to display the actions bar
5
+ *
6
+ * @param setSpeakerLevelCommandArgumentsthe volume to which the core will set the speaker
7
+ * level.
8
+ * Refer to {@link SetDisplayActionBarCommandArguments} to understand the argument structure.
9
+ */
10
+ setDisplayActionBar: (arg: SetDisplayActionBarCommandArguments) => void;
11
+ };
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.actionsBar = void 0;
4
+ var enums_1 = require("./enums");
5
+ exports.actionsBar = {
6
+ /**
7
+ * Decides whether to display the actions bar
8
+ *
9
+ * @param setSpeakerLevelCommandArgumentsthe volume to which the core will set the speaker
10
+ * level.
11
+ * Refer to {@link SetDisplayActionBarCommandArguments} to understand the argument structure.
12
+ */
13
+ setDisplayActionBar: function (arg) {
14
+ var displayActionBar = arg.displayActionBar;
15
+ window.dispatchEvent(new CustomEvent(enums_1.ActionsBarEnum.SET_DISPLAY_ACTIONS_BAR, {
16
+ detail: {
17
+ displayActionBar: displayActionBar,
18
+ },
19
+ }));
20
+ },
21
+ };
22
+ //# sourceMappingURL=commands.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../src/ui-commands/actions-bar/commands.ts"],"names":[],"mappings":";;;AAAA,iCAAyC;AAG5B,QAAA,UAAU,GAAG;IACxB;;;;;;OAMG;IACH,mBAAmB,EAAE,UAAC,GAAwC;QACpD,IAAA,gBAAgB,GAAK,GAAG,iBAAR,CAAS;QACjC,MAAM,CAAC,aAAa,CAAC,IAAI,WAAW,CAElC,sBAAc,CAAC,uBAAuB,EAAE;YACxC,MAAM,EAAE;gBACN,gBAAgB,kBAAA;aACjB;SACF,CAAC,CAAC,CAAC;IACN,CAAC;CACF,CAAC"}
@@ -0,0 +1,3 @@
1
+ export declare enum ActionsBarEnum {
2
+ SET_DISPLAY_ACTIONS_BAR = "SET_DISPLAY_ACTIONS_BAR_COMMAND"
3
+ }
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ActionsBarEnum = void 0;
4
+ var ActionsBarEnum;
5
+ (function (ActionsBarEnum) {
6
+ ActionsBarEnum["SET_DISPLAY_ACTIONS_BAR"] = "SET_DISPLAY_ACTIONS_BAR_COMMAND";
7
+ })(ActionsBarEnum || (exports.ActionsBarEnum = ActionsBarEnum = {}));
8
+ //# sourceMappingURL=enums.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../../src/ui-commands/actions-bar/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,cAEX;AAFD,WAAY,cAAc;IACxB,6EAA2D,CAAA;AAC7D,CAAC,EAFW,cAAc,8BAAd,cAAc,QAEzB"}
@@ -0,0 +1,6 @@
1
+ export interface SetDisplayActionBarCommandArguments {
2
+ displayActionBar: boolean;
3
+ }
4
+ export interface UiCommandsActionsBarObject {
5
+ setDisplayActionBar: (arg: SetDisplayActionBarCommandArguments) => void;
6
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/ui-commands/actions-bar/types.ts"],"names":[],"mappings":""}
@@ -1,4 +1,7 @@
1
1
  export declare const uiCommands: {
2
+ actionsBar: {
3
+ setDisplayActionBar: (arg: import("./actions-bar/types").SetDisplayActionBarCommandArguments) => void;
4
+ };
2
5
  chat: {
3
6
  form: {
4
7
  open: () => void;
@@ -14,6 +17,9 @@ export declare const uiCommands: {
14
17
  open: () => void;
15
18
  close: () => void;
16
19
  };
20
+ navBar: {
21
+ setDisplayNavBar: (setDisplayNavBarCommandArguments: import("./nav-bar/types").SetDisplayNavBarCommandArguments) => void;
22
+ };
17
23
  presentationArea: {
18
24
  open: () => void;
19
25
  close: () => void;
@@ -24,4 +30,10 @@ export declare const uiCommands: {
24
30
  conference: {
25
31
  setSpeakerLevel: (setSpeakerLevelCommandArguments: import("./conference/types").SetSpeakerLevelCommandArguments) => void;
26
32
  };
33
+ notification: {
34
+ send: (information: import("./notification/types").SendNotificationCommandArguments) => void;
35
+ };
36
+ layout: {
37
+ changeEnforcedLayout: import("./layout/types").ChangeEnforcedLayout;
38
+ };
27
39
  };
@@ -7,12 +7,20 @@ var commands_3 = require("./sidekick-options-container/commands");
7
7
  var commands_4 = require("./presentation-area/commands");
8
8
  var commands_5 = require("./user-status/commands");
9
9
  var commands_6 = require("./conference/commands");
10
+ var commands_7 = require("./notification/commands");
11
+ var commands_8 = require("./actions-bar/commands");
12
+ var commands_9 = require("./layout/commands");
13
+ var commands_10 = require("./nav-bar/commands");
10
14
  exports.uiCommands = {
15
+ actionsBar: commands_8.actionsBar,
11
16
  chat: commands_1.chat,
12
17
  externalVideo: commands_2.externalVideo,
13
18
  sidekickOptionsContainer: commands_3.sidekickOptionsContainer,
19
+ navBar: commands_10.navBar,
14
20
  presentationArea: commands_4.presentationArea,
15
21
  userStatus: commands_5.userStatus,
16
22
  conference: commands_6.conference,
23
+ notification: commands_7.notification,
24
+ layout: commands_9.layout,
17
25
  };
18
26
  //# sourceMappingURL=commands.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../src/ui-commands/commands.ts"],"names":[],"mappings":";;;AAAA,4CAAuC;AACvC,sDAA0D;AAC1D,kEAAiF;AACjF,yDAAgE;AAChE,mDAAoD;AACpD,kDAAmD;AAEtC,QAAA,UAAU,GAAG;IACxB,IAAI,iBAAA;IACJ,aAAa,0BAAA;IACb,wBAAwB,qCAAA;IACxB,gBAAgB,6BAAA;IAChB,UAAU,uBAAA;IACV,UAAU,uBAAA;CACX,CAAC"}
1
+ {"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../src/ui-commands/commands.ts"],"names":[],"mappings":";;;AAAA,4CAAuC;AACvC,sDAA0D;AAC1D,kEAAiF;AACjF,yDAAgE;AAChE,mDAAoD;AACpD,kDAAmD;AACnD,oDAAuD;AACvD,mDAAoD;AACpD,8CAA2C;AAC3C,gDAA4C;AAE/B,QAAA,UAAU,GAAG;IACxB,UAAU,uBAAA;IACV,IAAI,iBAAA;IACJ,aAAa,0BAAA;IACb,wBAAwB,qCAAA;IACxB,MAAM,oBAAA;IACN,gBAAgB,6BAAA;IAChB,UAAU,uBAAA;IACV,UAAU,uBAAA;IACV,YAAY,yBAAA;IACZ,MAAM,mBAAA;CACP,CAAC"}
@@ -0,0 +1,2 @@
1
+ export { NotificationTypeUiCommand } from './notification/enums';
2
+ export { ChangeEnforcedLayoutTypeEnum } from './layout/enums';
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ChangeEnforcedLayoutTypeEnum = exports.NotificationTypeUiCommand = void 0;
4
+ var enums_1 = require("./notification/enums");
5
+ Object.defineProperty(exports, "NotificationTypeUiCommand", { enumerable: true, get: function () { return enums_1.NotificationTypeUiCommand; } });
6
+ var enums_2 = require("./layout/enums");
7
+ Object.defineProperty(exports, "ChangeEnforcedLayoutTypeEnum", { enumerable: true, get: function () { return enums_2.ChangeEnforcedLayoutTypeEnum; } });
8
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ui-commands/index.ts"],"names":[],"mappings":";;;AAAA,8CAAiE;AAAxD,kHAAA,yBAAyB,OAAA;AAClC,wCAA8D;AAArD,qHAAA,4BAA4B,OAAA"}
@@ -0,0 +1,9 @@
1
+ import { ChangeEnforcedLayout } from './types';
2
+ export declare const layout: {
3
+ /**
4
+ * <description>
5
+ *
6
+ * @param
7
+ */
8
+ changeEnforcedLayout: ChangeEnforcedLayout;
9
+ };
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.layout = void 0;
4
+ var enums_1 = require("./enums");
5
+ exports.layout = {
6
+ /**
7
+ * <description>
8
+ *
9
+ * @param
10
+ */
11
+ changeEnforcedLayout: (function (layoutType) {
12
+ window.dispatchEvent(new CustomEvent(enums_1.LayoutEnum.CHANGE_ENFORCED_LAYOUT, {
13
+ detail: {
14
+ layoutType: layoutType,
15
+ },
16
+ }));
17
+ }),
18
+ };
19
+ //# sourceMappingURL=commands.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../src/ui-commands/layout/commands.ts"],"names":[],"mappings":";;;AAAA,iCAAmE;AAGtD,QAAA,MAAM,GAAG;IACpB;;;;OAIG;IACH,oBAAoB,EAAE,CAAC,UAAC,UAAwC;QAC9D,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAEb,kBAAU,CAAC,sBAAsB,EAAE;YACnC,MAAM,EAAE;gBACN,UAAU,YAAA;aACX;SACF,CAAC,CACH,CAAC;IACJ,CAAC,CAAyB;CAC3B,CAAC"}
@@ -0,0 +1,13 @@
1
+ export declare enum LayoutEnum {
2
+ CHANGE_ENFORCED_LAYOUT = "CHANGE_ENFORCED_LAYOUT"
3
+ }
4
+ export declare enum ChangeEnforcedLayoutTypeEnum {
5
+ CUSTOM_LAYOUT = "CUSTOM_LAYOUT",
6
+ SMART_LAYOUT = "SMART_LAYOUT",
7
+ PRESENTATION_FOCUS = "PRESENTATION_FOCUS",
8
+ VIDEO_FOCUS = "VIDEO_FOCUS",
9
+ CAMERAS_ONLY = "CAMERAS_ONLY",
10
+ PRESENTATION_ONLY = "PRESENTATION_ONLY",
11
+ PARTICIPANTS_AND_CHAT_ONLY = "PARTICIPANTS_AND_CHAT_ONLY",
12
+ MEDIA_ONLY = "MEDIA_ONLY"
13
+ }
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ChangeEnforcedLayoutTypeEnum = exports.LayoutEnum = void 0;
4
+ var LayoutEnum;
5
+ (function (LayoutEnum) {
6
+ LayoutEnum["CHANGE_ENFORCED_LAYOUT"] = "CHANGE_ENFORCED_LAYOUT";
7
+ })(LayoutEnum || (exports.LayoutEnum = LayoutEnum = {}));
8
+ var ChangeEnforcedLayoutTypeEnum;
9
+ (function (ChangeEnforcedLayoutTypeEnum) {
10
+ ChangeEnforcedLayoutTypeEnum["CUSTOM_LAYOUT"] = "CUSTOM_LAYOUT";
11
+ ChangeEnforcedLayoutTypeEnum["SMART_LAYOUT"] = "SMART_LAYOUT";
12
+ ChangeEnforcedLayoutTypeEnum["PRESENTATION_FOCUS"] = "PRESENTATION_FOCUS";
13
+ ChangeEnforcedLayoutTypeEnum["VIDEO_FOCUS"] = "VIDEO_FOCUS";
14
+ ChangeEnforcedLayoutTypeEnum["CAMERAS_ONLY"] = "CAMERAS_ONLY";
15
+ ChangeEnforcedLayoutTypeEnum["PRESENTATION_ONLY"] = "PRESENTATION_ONLY";
16
+ ChangeEnforcedLayoutTypeEnum["PARTICIPANTS_AND_CHAT_ONLY"] = "PARTICIPANTS_AND_CHAT_ONLY";
17
+ ChangeEnforcedLayoutTypeEnum["MEDIA_ONLY"] = "MEDIA_ONLY";
18
+ })(ChangeEnforcedLayoutTypeEnum || (exports.ChangeEnforcedLayoutTypeEnum = ChangeEnforcedLayoutTypeEnum = {}));
19
+ //# sourceMappingURL=enums.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../../src/ui-commands/layout/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,UAEX;AAFD,WAAY,UAAU;IACpB,+DAAiD,CAAA;AACnD,CAAC,EAFW,UAAU,0BAAV,UAAU,QAErB;AAED,IAAY,4BASX;AATD,WAAY,4BAA4B;IACtC,+DAA+B,CAAA;IAC/B,6DAA6B,CAAA;IAC7B,yEAAyC,CAAA;IACzC,2DAA2B,CAAA;IAC3B,6DAA6B,CAAA;IAC7B,uEAAuC,CAAA;IACvC,yFAAyD,CAAA;IACzD,yDAAyB,CAAA;AAC3B,CAAC,EATW,4BAA4B,4CAA5B,4BAA4B,QASvC"}
@@ -0,0 +1,8 @@
1
+ import { ChangeEnforcedLayoutTypeEnum } from './enums';
2
+ export interface ChangeEnforcedLayoutCommandArguments {
3
+ layoutType: ChangeEnforcedLayoutTypeEnum;
4
+ }
5
+ export type ChangeEnforcedLayout = (layoutType: ChangeEnforcedLayoutTypeEnum) => void;
6
+ export interface UiCommandsLayoutObject {
7
+ changeEnforcedLayout: ChangeEnforcedLayout;
8
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/ui-commands/layout/types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,10 @@
1
+ import { SetDisplayNavBarCommandArguments } from './types';
2
+ export declare const navBar: {
3
+ /**
4
+ * Sets the displayNavBar to true (show it) or false (hide it).
5
+ *
6
+ * @param setDisplayNavBarCommandArguments: object with a boolean that tells whether to display
7
+ * the navbar
8
+ */
9
+ setDisplayNavBar: (setDisplayNavBarCommandArguments: SetDisplayNavBarCommandArguments) => void;
10
+ };
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.navBar = void 0;
4
+ var enums_1 = require("./enums");
5
+ exports.navBar = {
6
+ /**
7
+ * Sets the displayNavBar to true (show it) or false (hide it).
8
+ *
9
+ * @param setDisplayNavBarCommandArguments: object with a boolean that tells whether to display
10
+ * the navbar
11
+ */
12
+ setDisplayNavBar: function (setDisplayNavBarCommandArguments) {
13
+ var displayNavBar = setDisplayNavBarCommandArguments.displayNavBar;
14
+ window.dispatchEvent(new CustomEvent(enums_1.NavBarEnum.SET_DISPLAY_NAV_BAR, {
15
+ detail: {
16
+ displayNavBar: displayNavBar,
17
+ },
18
+ }));
19
+ },
20
+ };
21
+ //# sourceMappingURL=commands.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../src/ui-commands/nav-bar/commands.ts"],"names":[],"mappings":";;;AAAA,iCAAqC;AAGxB,QAAA,MAAM,GAAG;IACpB;;;;;OAKG;IACH,gBAAgB,EAAE,UAAC,gCAAkE;QAC3E,IAAA,aAAa,GAAK,gCAAgC,cAArC,CAAsC;QAC3D,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAEb,kBAAU,CAAC,mBAAmB,EAAE;YAChC,MAAM,EAAE;gBACN,aAAa,eAAA;aACd;SACF,CAAC,CACH,CAAC;IACJ,CAAC;CACF,CAAC"}
@@ -0,0 +1,3 @@
1
+ export declare enum NavBarEnum {
2
+ SET_DISPLAY_NAV_BAR = "SET_DISPLAY_NAV_BAR_COMMAND"
3
+ }
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.NavBarEnum = void 0;
4
+ var NavBarEnum;
5
+ (function (NavBarEnum) {
6
+ NavBarEnum["SET_DISPLAY_NAV_BAR"] = "SET_DISPLAY_NAV_BAR_COMMAND";
7
+ })(NavBarEnum || (exports.NavBarEnum = NavBarEnum = {}));
8
+ //# sourceMappingURL=enums.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../../src/ui-commands/nav-bar/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,UAEX;AAFD,WAAY,UAAU;IACpB,iEAAmD,CAAA;AACrD,CAAC,EAFW,UAAU,0BAAV,UAAU,QAErB"}
@@ -0,0 +1,6 @@
1
+ export interface SetDisplayNavBarCommandArguments {
2
+ displayNavBar: boolean;
3
+ }
4
+ export interface UiCommandsNavBarObject {
5
+ setDisplayNavBar: (setDisplayNavBarCommandArguments: SetDisplayNavBarCommandArguments) => void;
6
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/ui-commands/nav-bar/types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,7 @@
1
+ import { SendNotificationCommandArguments } from './types';
2
+ export declare const notification: {
3
+ /**
4
+ * Sends notification to be rendered in the front-end.
5
+ */
6
+ send: (information: SendNotificationCommandArguments) => void;
7
+ };
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.notification = void 0;
4
+ var enums_1 = require("./enums");
5
+ exports.notification = {
6
+ /**
7
+ * Sends notification to be rendered in the front-end.
8
+ */
9
+ send: function (information) {
10
+ window.dispatchEvent(new CustomEvent(enums_1.NotificationEnum.SEND, {
11
+ detail: information,
12
+ }));
13
+ },
14
+ };
15
+ //# sourceMappingURL=commands.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../src/ui-commands/notification/commands.ts"],"names":[],"mappings":";;;AAAA,iCAA2C;AAG9B,QAAA,YAAY,GAAG;IAC1B;;OAEG;IACH,IAAI,EAAE,UAAC,WAA6C;QAClD,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAEb,wBAAgB,CAAC,IAAI,EAAE;YACvB,MAAM,EAAE,WAAW;SACpB,CAAC,CACH,CAAC;IACJ,CAAC;CACF,CAAC"}
@@ -0,0 +1,10 @@
1
+ export declare enum NotificationEnum {
2
+ SEND = "SEND_NOTIFICATION"
3
+ }
4
+ export declare enum NotificationTypeUiCommand {
5
+ INFO = "info",
6
+ DEFAULT = "default",
7
+ WARNING = "warning",
8
+ SUCCESS = "success",
9
+ ERROR = "error"
10
+ }
@@ -0,0 +1,16 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.NotificationTypeUiCommand = exports.NotificationEnum = void 0;
4
+ var NotificationEnum;
5
+ (function (NotificationEnum) {
6
+ NotificationEnum["SEND"] = "SEND_NOTIFICATION";
7
+ })(NotificationEnum || (exports.NotificationEnum = NotificationEnum = {}));
8
+ var NotificationTypeUiCommand;
9
+ (function (NotificationTypeUiCommand) {
10
+ NotificationTypeUiCommand["INFO"] = "info";
11
+ NotificationTypeUiCommand["DEFAULT"] = "default";
12
+ NotificationTypeUiCommand["WARNING"] = "warning";
13
+ NotificationTypeUiCommand["SUCCESS"] = "success";
14
+ NotificationTypeUiCommand["ERROR"] = "error";
15
+ })(NotificationTypeUiCommand || (exports.NotificationTypeUiCommand = NotificationTypeUiCommand = {}));
16
+ //# sourceMappingURL=enums.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../../src/ui-commands/notification/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,gBAEX;AAFD,WAAY,gBAAgB;IAC1B,8CAA0B,CAAA;AAC5B,CAAC,EAFW,gBAAgB,gCAAhB,gBAAgB,QAE3B;AAED,IAAY,yBAMX;AAND,WAAY,yBAAyB;IACnC,0CAAa,CAAA;IACb,gDAAmB,CAAA;IACnB,gDAAmB,CAAA;IACnB,gDAAmB,CAAA;IACnB,4CAAe,CAAA;AACjB,CAAC,EANW,yBAAyB,yCAAzB,yBAAyB,QAMpC"}
@@ -0,0 +1,17 @@
1
+ import { NotificationTypeUiCommand } from './enums';
2
+ export interface SendNotificationCommandArgumentsOptions {
3
+ helpLabel?: string;
4
+ helpLink?: string;
5
+ autoClose?: number;
6
+ }
7
+ export interface SendNotificationCommandArguments {
8
+ message: string;
9
+ icon: string;
10
+ type: NotificationTypeUiCommand;
11
+ options?: SendNotificationCommandArgumentsOptions;
12
+ content?: string;
13
+ small?: boolean;
14
+ }
15
+ export interface UiCommandsNotificationObject {
16
+ send: (information: SendNotificationCommandArguments) => void;
17
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/ui-commands/notification/types.ts"],"names":[],"mappings":""}
@@ -4,11 +4,19 @@ import { UiCommandsSidekickOptionsContainerObject } from './sidekick-options-con
4
4
  import { UiCommandsPresentationAreaObject } from './presentation-area/types';
5
5
  import { UiCommandsUserStatusObject } from './user-status/types';
6
6
  import { UiCommandsConferenceObject } from './conference/types';
7
+ import { UiCommandsNotificationObject } from './notification/types';
8
+ import { UiCommandsActionsBarObject } from './actions-bar/types';
9
+ import { UiCommandsLayoutObject } from './layout/types';
10
+ import { UiCommandsNavBarObject } from './nav-bar/types';
7
11
  export interface UiCommands {
12
+ layout: UiCommandsLayoutObject;
13
+ actionsBar: UiCommandsActionsBarObject;
8
14
  chat: UiCommandsChatObject;
9
15
  externalVideo: UiCommandsExternalVideoObject;
10
16
  sidekickOptionsContainer: UiCommandsSidekickOptionsContainerObject;
17
+ navBar: UiCommandsNavBarObject;
11
18
  presentationArea: UiCommandsPresentationAreaObject;
12
19
  userStatus: UiCommandsUserStatusObject;
13
20
  conference: UiCommandsConferenceObject;
21
+ notification: UiCommandsNotificationObject;
14
22
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bigbluebutton-html-plugin-sdk",
3
- "version": "0.0.67",
3
+ "version": "0.0.69",
4
4
  "homepage": "https://github.com/bigbluebutton/bigbluebutton-html-plugin-sdk",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",