bigbluebutton-html-plugin-sdk 0.0.54 → 0.0.56

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 (37) hide show
  1. package/README.md +16 -0
  2. package/dist/cjs/core/api/BbbPluginSdk.js +1 -1
  3. package/dist/cjs/core/api/BbbPluginSdk.js.map +1 -1
  4. package/dist/cjs/data-consumption/domain/chat/loaded-chat-messages/types.d.ts +1 -0
  5. package/dist/cjs/server-commands/chat/commands.d.ts +22 -0
  6. package/dist/cjs/server-commands/chat/commands.js +47 -0
  7. package/dist/cjs/server-commands/chat/commands.js.map +1 -0
  8. package/dist/cjs/server-commands/chat/constants.d.ts +1 -0
  9. package/dist/cjs/server-commands/chat/constants.js +5 -0
  10. package/dist/cjs/server-commands/chat/constants.js.map +1 -0
  11. package/dist/cjs/server-commands/chat/enum.d.ts +3 -0
  12. package/dist/cjs/server-commands/chat/enum.js +8 -0
  13. package/dist/cjs/server-commands/chat/enum.js.map +1 -0
  14. package/dist/cjs/server-commands/chat/types.d.ts +13 -0
  15. package/dist/cjs/server-commands/chat/types.js +3 -0
  16. package/dist/cjs/server-commands/chat/types.js.map +1 -0
  17. package/dist/cjs/server-commands/commands.d.ts +5 -1
  18. package/dist/cjs/server-commands/commands.js +5 -2
  19. package/dist/cjs/server-commands/commands.js.map +1 -1
  20. package/dist/cjs/server-commands/index.d.ts +1 -0
  21. package/dist/cjs/server-commands/index.js +3 -1
  22. package/dist/cjs/server-commands/index.js.map +1 -1
  23. package/dist/cjs/server-commands/types.d.ts +2 -0
  24. package/dist/cjs/ui-commands/commands.d.ts +4 -0
  25. package/dist/cjs/ui-commands/commands.js +2 -0
  26. package/dist/cjs/ui-commands/commands.js.map +1 -1
  27. package/dist/cjs/ui-commands/presentation-area/commands.d.ts +10 -0
  28. package/dist/cjs/ui-commands/presentation-area/commands.js +19 -0
  29. package/dist/cjs/ui-commands/presentation-area/commands.js.map +1 -0
  30. package/dist/cjs/ui-commands/presentation-area/enums.d.ts +4 -0
  31. package/dist/cjs/ui-commands/presentation-area/enums.js +9 -0
  32. package/dist/cjs/ui-commands/presentation-area/enums.js.map +1 -0
  33. package/dist/cjs/ui-commands/presentation-area/types.d.ts +4 -0
  34. package/dist/cjs/ui-commands/presentation-area/types.js +3 -0
  35. package/dist/cjs/ui-commands/presentation-area/types.js.map +1 -0
  36. package/dist/cjs/ui-commands/types.d.ts +2 -0
  37. package/package.json +1 -1
package/README.md CHANGED
@@ -211,6 +211,7 @@ export type ObjectTo = ToUserId | ToRole;
211
211
  - ExternalVideoVolumeUiDataNames.CURRENT_VOLUME_VALUE;
212
212
  - ExternalVideoVolumeUiDataNames.IS_VOLUME_MUTED;
213
213
  - UserListUiDataNames.USER_LIST_IS_OPEN;
214
+ - LayoutPresentatioAreaUiDataNames.CURRENT_ELEMENT;
214
215
 
215
216
  Example of usage:
216
217
 
@@ -243,6 +244,9 @@ One other thing is that the type of the return is precisely the same type requir
243
244
  - sidekick-options-container:
244
245
  - open: this function will open the sidekick options panel automatically;
245
246
  - close: this function will close the sidekick options panel automatically (and also the sidebar content if open, to avoid inconsistencies in ui);
247
+ - presentation-area:
248
+ - open: this function will open the presentation area content automatically;
249
+ - close: this function will close the presentation area content automatically;
246
250
 
247
251
  See usage ahead:
248
252
 
@@ -255,6 +259,18 @@ See usage ahead:
255
259
 
256
260
  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
257
261
 
262
+ ### Server Commands
263
+
264
+ `serverCommands` object: It contains all the possible commands available to the developer to interact with the BBB core server, see the ones implemented down below:
265
+
266
+ - chat:
267
+ - sendPublicMessage: this function sends a text message along with an optional custom metadata to the public chat
268
+ > Note: messages sent by plugins are not natively rendered by the client.
269
+ > They have to be custom-rendered by plugins using `useLoadedChatMessages` and `useChatMessageDomElements`.
270
+ - caption:
271
+ - save: this function saves the given text, locale and caption type
272
+ - addLocale: this function sends a locale to be added to the available options
273
+
258
274
  ### Dom Element Manipulation
259
275
 
260
276
  - `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.;
@@ -56,7 +56,6 @@ var BbbPluginSdk = /** @class */ (function () {
56
56
  pluginApi.useLoadedChatMessages = (function () { return (0, hooks_7.useLoadedChatMessages)(); });
57
57
  pluginApi.useChatMessageDomElements = function (messageIds) { return (0, hooks_8.useChatMessageDomElements)(messageIds); };
58
58
  pluginApi.uiCommands = commands_1.uiCommands;
59
- pluginApi.serverCommands = commands_2.serverCommands;
60
59
  pluginApi.useUiData = hooks_10.useUiData;
61
60
  var pluginName = pluginApi === null || pluginApi === void 0 ? void 0 : pluginApi.pluginName;
62
61
  if (pluginName) {
@@ -66,6 +65,7 @@ var BbbPluginSdk = /** @class */ (function () {
66
65
  return (0, hooks_1.useDataChannelGeneral)(channelName, subChannelName, pluginName, window.bbb_plugins[uuid], dataChannelType);
67
66
  });
68
67
  pluginApi.usePluginSettings = function () { return (0, settings_1.usePluginSettings)(pluginName); };
68
+ pluginApi.serverCommands = (0, commands_2.serverCommands)(pluginName);
69
69
  pluginApi.sendGenericDataForLearningAnalyticsDashboard = function (data) { return (0, hooks_12.sendGenericDataForLearningAnalyticsDashboard)(data, pluginName); };
70
70
  }
71
71
  else {
@@ -1 +1 @@
1
- {"version":3,"file":"BbbPluginSdk.js","sourceRoot":"","sources":["../../../../src/core/api/BbbPluginSdk.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,+BAAkC;AAOlC,kDAA4D;AAO5D,uDAAwD;AAQxD,kDAAiE;AACjE,gGAEgF;AAChF,wFAEwE;AACxE,oFAA+F;AAC/F,gFAAwF;AACxF,oFAA+F;AAC/F,4DAAoE;AACpE,uDAA0D;AAC1D,mEAA2E;AAE3E,uFAAsG;AACtG,2EAA8F;AAE9F,0FAAuG;AACvG,oDAAsD;AAEtD,gFAAmF;AACnF,2DAAgE;AAChE,mEAAwG;AAKxG;;;;;;GAMG;AACH;IAAA;IA+GA,CAAC;IA9GC;;;;;;;;;;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,cAAc,GAAG,yBAAc,CAAC;QAC1C,SAAS,CAAC,SAAS,GAAG,kBAAS,CAAC;QAChC,IAAM,UAAU,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,UAAU,CAAC;QACzC,IAAI,UAAU,EAAE;YACd,SAAS,CAAC,cAAc,GAAG,CAAC,UAC1B,WAAmB,EACnB,eAA8D,EAC9D,cAAkC;gBADlC,gCAAA,EAAA,kBAAoC,wBAAgB,CAAC,SAAS;gBAC9D,+BAAA,EAAA,0BAAkC;gBAC/B,OAAA,IAAA,6BAAqB,EACxB,WAAW,EACX,cAAc,EACd,UAAU,EACV,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EACxB,eAAe,CAChB;YANI,CAMJ,CAAwC,CAAC;YAC1C,SAAS,CAAC,iBAAiB,GAAG,cAAM,OAAA,IAAA,4BAAiB,EAAC,UAAU,CAAC,EAA7B,CAA6B,CAAC;YAClE,SAAS,CAAC,4CAA4C,GAAG,UACvD,IAA8C,IAC3C,OAAA,IAAA,qDAA4C,EAAC,IAAI,EAAE,UAAU,CAAC,EAA9D,CAA8D,CAAC;SACrE;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,sBAAsB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAChC,uBAAuB,EAAE;oBACvB,EAAE,EAAE,cAAO,CAAC;iBACb;gBACD,eAAe,EAAE,cAAM,OAAA,IAAA,wBAAe,GAAE,EAAjB,CAAiB;gBACxC,UAAU,EAAE,UAAC,MAAM,IAAK,OAAA,IAAA,mBAAU,EAAC,MAAM,CAAC,EAAlB,CAAkB;gBAC1C,UAAU,YAAA;aACX,CAAC;SACH;QAED,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IACH,mBAAC;AAAD,CAAC,AA/GD,IA+GC;AA/GqB,oCAAY"}
1
+ {"version":3,"file":"BbbPluginSdk.js","sourceRoot":"","sources":["../../../../src/core/api/BbbPluginSdk.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,+BAAkC;AAOlC,kDAA4D;AAO5D,uDAAwD;AAQxD,kDAAiE;AACjE,gGAEgF;AAChF,wFAEwE;AACxE,oFAA+F;AAC/F,gFAAwF;AACxF,oFAA+F;AAC/F,4DAAoE;AACpE,uDAA0D;AAC1D,mEAA2E;AAE3E,uFAAsG;AACtG,2EAA8F;AAE9F,0FAAuG;AACvG,oDAAsD;AAEtD,gFAAmF;AACnF,2DAAgE;AAChE,mEAAwG;AAKxG;;;;;;GAMG;AACH;IAAA;IA+GA,CAAC;IA9GC;;;;;;;;;;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;YAClE,SAAS,CAAC,cAAc,GAAG,IAAA,yBAAc,EAAC,UAAU,CAAC,CAAC;YACtD,SAAS,CAAC,4CAA4C,GAAG,UACvD,IAA8C,IAC3C,OAAA,IAAA,qDAA4C,EAAC,IAAI,EAAE,UAAU,CAAC,EAA9D,CAA8D,CAAC;SACrE;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,sBAAsB,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;gBAChC,uBAAuB,EAAE;oBACvB,EAAE,EAAE,cAAO,CAAC;iBACb;gBACD,eAAe,EAAE,cAAM,OAAA,IAAA,wBAAe,GAAE,EAAjB,CAAiB;gBACxC,UAAU,EAAE,UAAC,MAAM,IAAK,OAAA,IAAA,mBAAU,EAAC,MAAM,CAAC,EAAlB,CAAkB;gBAC1C,UAAU,YAAA;aACX,CAAC;SACH;QAED,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IACH,mBAAC;AAAD,CAAC,AA/GD,IA+GC;AA/GqB,oCAAY"}
@@ -4,5 +4,6 @@ export interface LoadedChatMessage {
4
4
  message: string;
5
5
  messageId: string;
6
6
  senderUserId: string;
7
+ messageMetadata: string;
7
8
  }
8
9
  export type UseLoadedChatMessagesFunction = () => GraphqlResponseWrapper<LoadedChatMessage[]>;
@@ -0,0 +1,22 @@
1
+ import { ChatSendMessageCommandArguments } from './types';
2
+ export declare const chat: (pluginName: string) => {
3
+ /**
4
+ * Sends chat message to the public chat.
5
+ *
6
+ * @param chatSendMessageCommandArguments the text and custom metadata(optional)
7
+ * to be sent in the public chat message.
8
+ * Refer to {@link ChatSendMessageCommandArguments} to understand the argument
9
+ * structure.
10
+ */
11
+ sendPublicChatMessage: (chatSendPublicChatMessageCommandArguments: ChatSendMessageCommandArguments) => void;
12
+ /**
13
+ * Sends custom chat message to the public chat. Custom messages are not rendered by
14
+ * the BBB client and are meant to be rendered in a custom manner by the plugin.
15
+ *
16
+ * @param chatSendMessageCommandArguments the text and custom metadata(optional)
17
+ * to be sent in the public chat message.
18
+ * Refer to {@link ChatSendMessageCommandArguments} to understand the argument
19
+ * structure.
20
+ */
21
+ sendCustomPublicChatMessage: (chatSendCustomPublicChatMessageCommandArguments: ChatSendMessageCommandArguments) => void;
22
+ };
@@ -0,0 +1,47 @@
1
+ "use strict";
2
+ var __assign = (this && this.__assign) || function () {
3
+ __assign = Object.assign || function(t) {
4
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
5
+ s = arguments[i];
6
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
7
+ t[p] = s[p];
8
+ }
9
+ return t;
10
+ };
11
+ return __assign.apply(this, arguments);
12
+ };
13
+ Object.defineProperty(exports, "__esModule", { value: true });
14
+ exports.chat = void 0;
15
+ var constants_1 = require("./constants");
16
+ var enum_1 = require("./enum");
17
+ var chat = function (pluginName) { return ({
18
+ /**
19
+ * Sends chat message to the public chat.
20
+ *
21
+ * @param chatSendMessageCommandArguments the text and custom metadata(optional)
22
+ * to be sent in the public chat message.
23
+ * Refer to {@link ChatSendMessageCommandArguments} to understand the argument
24
+ * structure.
25
+ */
26
+ sendPublicChatMessage: function (chatSendPublicChatMessageCommandArguments) {
27
+ window.dispatchEvent(new CustomEvent(enum_1.ChatCommandsEnum.SEND_MESSAGE, {
28
+ detail: __assign({ chatId: constants_1.PUBLIC_CHAT_ID, pluginName: pluginName, custom: false }, chatSendPublicChatMessageCommandArguments),
29
+ }));
30
+ },
31
+ /**
32
+ * Sends custom chat message to the public chat. Custom messages are not rendered by
33
+ * the BBB client and are meant to be rendered in a custom manner by the plugin.
34
+ *
35
+ * @param chatSendMessageCommandArguments the text and custom metadata(optional)
36
+ * to be sent in the public chat message.
37
+ * Refer to {@link ChatSendMessageCommandArguments} to understand the argument
38
+ * structure.
39
+ */
40
+ sendCustomPublicChatMessage: function (chatSendCustomPublicChatMessageCommandArguments) {
41
+ window.dispatchEvent(new CustomEvent(enum_1.ChatCommandsEnum.SEND_MESSAGE, {
42
+ detail: __assign({ chatId: constants_1.PUBLIC_CHAT_ID, pluginName: pluginName, custom: true }, chatSendCustomPublicChatMessageCommandArguments),
43
+ }));
44
+ },
45
+ }); };
46
+ exports.chat = chat;
47
+ //# sourceMappingURL=commands.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../src/server-commands/chat/commands.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,yCAA6C;AAC7C,+BAA0C;AAMnC,IAAM,IAAI,GAAG,UAAC,UAAkB,IAAK,OAAA,CAAC;IAC3C;;;;;;;OAOG;IACH,qBAAqB,EAAE,UACrB,yCAA0E;QAE1E,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAEb,uBAAgB,CAAC,YAAY,EAAE;YAC/B,MAAM,aACJ,MAAM,EAAE,0BAAc,EACtB,UAAU,YAAA,EACV,MAAM,EAAE,KAAK,IACV,yCAAyC,CAC7C;SACF,CAAC,CACH,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,2BAA2B,EAAE,UAC3B,+CAAgF;QAEhF,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAEb,uBAAgB,CAAC,YAAY,EAAE;YAC/B,MAAM,aACJ,MAAM,EAAE,0BAAc,EACtB,UAAU,YAAA,EACV,MAAM,EAAE,IAAI,IACT,+CAA+C,CACnD;SACF,CAAC,CACH,CAAC;IACJ,CAAC;CACF,CAAC,EAnD0C,CAmD1C,CAAC;AAnDU,QAAA,IAAI,QAmDd"}
@@ -0,0 +1 @@
1
+ export declare const PUBLIC_CHAT_ID = "MAIN-PUBLIC-GROUP-CHAT";
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PUBLIC_CHAT_ID = void 0;
4
+ exports.PUBLIC_CHAT_ID = 'MAIN-PUBLIC-GROUP-CHAT';
5
+ //# sourceMappingURL=constants.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../src/server-commands/chat/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG,wBAAwB,CAAC"}
@@ -0,0 +1,3 @@
1
+ export declare enum ChatCommandsEnum {
2
+ SEND_MESSAGE = "CHAT_SEND_MESSAGE"
3
+ }
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ChatCommandsEnum = void 0;
4
+ var ChatCommandsEnum;
5
+ (function (ChatCommandsEnum) {
6
+ ChatCommandsEnum["SEND_MESSAGE"] = "CHAT_SEND_MESSAGE";
7
+ })(ChatCommandsEnum || (exports.ChatCommandsEnum = ChatCommandsEnum = {}));
8
+ //# sourceMappingURL=enum.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enum.js","sourceRoot":"","sources":["../../../../src/server-commands/chat/enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,gBAEX;AAFD,WAAY,gBAAgB;IAC1B,sDAAkC,CAAA;AACpC,CAAC,EAFW,gBAAgB,gCAAhB,gBAAgB,QAE3B"}
@@ -0,0 +1,13 @@
1
+ export interface ChatSendMessageCommandArguments {
2
+ textMessageInMarkdownFormat: string;
3
+ pluginCustomMetadata?: string;
4
+ }
5
+ export interface ChatSendMessageEventArguments extends ChatSendMessageCommandArguments {
6
+ pluginName: string;
7
+ chatId: string;
8
+ custom: boolean;
9
+ }
10
+ export interface ServerCommandsChatObject {
11
+ sendCustomPublicChatMessage: (chatSendCustomPublicChatMessageCommandArguments: ChatSendMessageCommandArguments) => void;
12
+ sendPublicChatMessage: (chatSendPublicChatMessageCommandArguments: ChatSendMessageCommandArguments) => void;
13
+ }
@@ -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/server-commands/chat/types.ts"],"names":[],"mappings":""}
@@ -1,6 +1,10 @@
1
- export declare const serverCommands: {
1
+ export declare const serverCommands: (pluginName: string) => {
2
2
  caption: {
3
3
  save: (captionSaveCommandArguments: import("./caption/types").CaptionSaveCommandArguments) => void;
4
4
  addLocale: (captionAddLocaleCommandArguments: string) => void;
5
5
  };
6
+ chat: {
7
+ sendPublicChatMessage: (chatSendPublicChatMessageCommandArguments: import("./chat/types").ChatSendMessageCommandArguments) => void;
8
+ sendCustomPublicChatMessage: (chatSendCustomPublicChatMessageCommandArguments: import("./chat/types").ChatSendMessageCommandArguments) => void;
9
+ };
6
10
  };
@@ -2,7 +2,10 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.serverCommands = void 0;
4
4
  var commands_1 = require("./caption/commands");
5
- exports.serverCommands = {
5
+ var commands_2 = require("./chat/commands");
6
+ var serverCommands = function (pluginName) { return ({
6
7
  caption: commands_1.caption,
7
- };
8
+ chat: (0, commands_2.chat)(pluginName),
9
+ }); };
10
+ exports.serverCommands = serverCommands;
8
11
  //# sourceMappingURL=commands.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../src/server-commands/commands.ts"],"names":[],"mappings":";;;AAAA,+CAA6C;AAEhC,QAAA,cAAc,GAAG;IAC5B,OAAO,oBAAA;CACR,CAAC"}
1
+ {"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../src/server-commands/commands.ts"],"names":[],"mappings":";;;AAAA,+CAA6C;AAC7C,4CAAuC;AAEhC,IAAM,cAAc,GAAG,UAAC,UAAkB,IAAK,OAAA,CAAC;IACrD,OAAO,oBAAA;IACP,IAAI,EAAE,IAAA,eAAI,EAAC,UAAU,CAAC;CACvB,CAAC,EAHoD,CAGpD,CAAC;AAHU,QAAA,cAAc,kBAGxB"}
@@ -1 +1,2 @@
1
1
  export { CaptionCommandsEnum, CaptionsTypeEnum } from './caption/enum';
2
+ export { ChatCommandsEnum } from './chat/enum';
@@ -1,7 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.CaptionsTypeEnum = exports.CaptionCommandsEnum = void 0;
3
+ exports.ChatCommandsEnum = exports.CaptionsTypeEnum = exports.CaptionCommandsEnum = void 0;
4
4
  var enum_1 = require("./caption/enum");
5
5
  Object.defineProperty(exports, "CaptionCommandsEnum", { enumerable: true, get: function () { return enum_1.CaptionCommandsEnum; } });
6
6
  Object.defineProperty(exports, "CaptionsTypeEnum", { enumerable: true, get: function () { return enum_1.CaptionsTypeEnum; } });
7
+ var enum_2 = require("./chat/enum");
8
+ Object.defineProperty(exports, "ChatCommandsEnum", { enumerable: true, get: function () { return enum_2.ChatCommandsEnum; } });
7
9
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/server-commands/index.ts"],"names":[],"mappings":";;;AAAA,uCAAuE;AAA9D,2GAAA,mBAAmB,OAAA;AAAE,wGAAA,gBAAgB,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/server-commands/index.ts"],"names":[],"mappings":";;;AAAA,uCAAuE;AAA9D,2GAAA,mBAAmB,OAAA;AAAE,wGAAA,gBAAgB,OAAA;AAC9C,oCAA+C;AAAtC,wGAAA,gBAAgB,OAAA"}
@@ -1,4 +1,6 @@
1
1
  import { ServerCommandsCaptionObject } from './caption/types';
2
+ import { ServerCommandsChatObject } from './chat/types';
2
3
  export interface ServerCommands {
3
4
  caption: ServerCommandsCaptionObject;
5
+ chat: ServerCommandsChatObject;
4
6
  }
@@ -14,4 +14,8 @@ export declare const uiCommands: {
14
14
  open: () => void;
15
15
  close: () => void;
16
16
  };
17
+ presentationArea: {
18
+ open: () => void;
19
+ close: () => void;
20
+ };
17
21
  };
@@ -4,9 +4,11 @@ exports.uiCommands = void 0;
4
4
  var commands_1 = require("./chat/commands");
5
5
  var commands_2 = require("./external-video/commands");
6
6
  var commands_3 = require("./sidekick-options-container/commands");
7
+ var commands_4 = require("./presentation-area/commands");
7
8
  exports.uiCommands = {
8
9
  chat: commands_1.chat,
9
10
  externalVideo: commands_2.externalVideo,
10
11
  sidekickOptionsContainer: commands_3.sidekickOptionsContainer,
12
+ presentationArea: commands_4.presentationArea,
11
13
  };
12
14
  //# 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;AAEpE,QAAA,UAAU,GAAG;IACxB,IAAI,iBAAA;IACJ,aAAa,0BAAA;IACb,wBAAwB,qCAAA;CACzB,CAAC"}
1
+ {"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../src/ui-commands/commands.ts"],"names":[],"mappings":";;;AAAA,4CAAuC;AACvC,sDAA0D;AAC1D,kEAAiF;AACjF,yDAAgE;AAEnD,QAAA,UAAU,GAAG;IACxB,IAAI,iBAAA;IACJ,aAAa,0BAAA;IACb,wBAAwB,qCAAA;IACxB,gBAAgB,6BAAA;CACjB,CAAC"}
@@ -0,0 +1,10 @@
1
+ export declare const presentationArea: {
2
+ /**
3
+ * Opens the presentation area content automatically.
4
+ */
5
+ open: () => void;
6
+ /**
7
+ * Closes the presentation area content automatically.
8
+ */
9
+ close: () => void;
10
+ };
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.presentationArea = void 0;
4
+ var enums_1 = require("./enums");
5
+ exports.presentationArea = {
6
+ /**
7
+ * Opens the presentation area content automatically.
8
+ */
9
+ open: function () {
10
+ window.dispatchEvent(new Event(enums_1.PresentationAreaEnum.OPEN));
11
+ },
12
+ /**
13
+ * Closes the presentation area content automatically.
14
+ */
15
+ close: function () {
16
+ window.dispatchEvent(new Event(enums_1.PresentationAreaEnum.CLOSE));
17
+ },
18
+ };
19
+ //# sourceMappingURL=commands.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../src/ui-commands/presentation-area/commands.ts"],"names":[],"mappings":";;;AAAA,iCAA+C;AAElC,QAAA,gBAAgB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE;QACJ,MAAM,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC,4BAAoB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,KAAK,EAAE;QACL,MAAM,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC,4BAAoB,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9D,CAAC;CACF,CAAC"}
@@ -0,0 +1,4 @@
1
+ export declare enum PresentationAreaEnum {
2
+ OPEN = "OPEN_PRESENTATION_AREA_COMMAND",
3
+ CLOSE = "CLOSE_PRESENTATION_AREA_COMMAND"
4
+ }
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PresentationAreaEnum = void 0;
4
+ var PresentationAreaEnum;
5
+ (function (PresentationAreaEnum) {
6
+ PresentationAreaEnum["OPEN"] = "OPEN_PRESENTATION_AREA_COMMAND";
7
+ PresentationAreaEnum["CLOSE"] = "CLOSE_PRESENTATION_AREA_COMMAND";
8
+ })(PresentationAreaEnum || (exports.PresentationAreaEnum = PresentationAreaEnum = {}));
9
+ //# sourceMappingURL=enums.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../../src/ui-commands/presentation-area/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,oBAGX;AAHD,WAAY,oBAAoB;IAC9B,+DAAuC,CAAA;IACvC,iEAAyC,CAAA;AAC3C,CAAC,EAHW,oBAAoB,oCAApB,oBAAoB,QAG/B"}
@@ -0,0 +1,4 @@
1
+ export interface UiCommandsPresentationAreaObject {
2
+ open: () => void;
3
+ close: () => void;
4
+ }
@@ -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/presentation-area/types.ts"],"names":[],"mappings":""}
@@ -1,8 +1,10 @@
1
1
  import { UiCommandsChatObject } from './chat/types';
2
2
  import { UiCommandsExternalVideoObject } from './external-video/types';
3
3
  import { UiCommandsSidekickOptionsContainerObject } from './sidekick-options-container/types';
4
+ import { UiCommandsPresentationAreaObject } from './presentation-area/types';
4
5
  export interface UiCommands {
5
6
  chat: UiCommandsChatObject;
6
7
  externalVideo: UiCommandsExternalVideoObject;
7
8
  sidekickOptionsContainer: UiCommandsSidekickOptionsContainerObject;
9
+ presentationArea: UiCommandsPresentationAreaObject;
8
10
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bigbluebutton-html-plugin-sdk",
3
- "version": "0.0.54",
3
+ "version": "0.0.56",
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",