bigbluebutton-html-plugin-sdk 0.0.51 → 0.0.53

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 (35) hide show
  1. package/README.md +13 -14
  2. package/dist/cjs/core/api/BbbPluginSdk.js +2 -0
  3. package/dist/cjs/core/api/BbbPluginSdk.js.map +1 -1
  4. package/dist/cjs/core/api/types.d.ts +2 -0
  5. package/dist/cjs/data-channel/hooks.js +6 -6
  6. package/dist/cjs/data-channel/hooks.js.map +1 -1
  7. package/dist/cjs/data-channel/index.d.ts +1 -1
  8. package/dist/cjs/data-channel/index.js.map +1 -1
  9. package/dist/cjs/data-channel/types.d.ts +8 -12
  10. package/dist/cjs/extensible-areas/generic-content-item/component.d.ts +3 -1
  11. package/dist/cjs/extensible-areas/generic-content-item/component.js +4 -1
  12. package/dist/cjs/extensible-areas/generic-content-item/component.js.map +1 -1
  13. package/dist/cjs/extensible-areas/generic-content-item/types.d.ts +1 -0
  14. package/dist/cjs/index.d.ts +1 -0
  15. package/dist/cjs/index.js +1 -0
  16. package/dist/cjs/index.js.map +1 -1
  17. package/dist/cjs/server-commands/caption/commands.d.ts +11 -0
  18. package/dist/cjs/server-commands/caption/commands.js +23 -0
  19. package/dist/cjs/server-commands/caption/commands.js.map +1 -0
  20. package/dist/cjs/server-commands/caption/enum.d.ts +8 -0
  21. package/dist/cjs/server-commands/caption/enum.js +14 -0
  22. package/dist/cjs/server-commands/caption/enum.js.map +1 -0
  23. package/dist/cjs/server-commands/caption/types.d.ts +9 -0
  24. package/dist/cjs/server-commands/caption/types.js +3 -0
  25. package/dist/cjs/server-commands/caption/types.js.map +1 -0
  26. package/dist/cjs/server-commands/commands.d.ts +6 -0
  27. package/dist/cjs/server-commands/commands.js +8 -0
  28. package/dist/cjs/server-commands/commands.js.map +1 -0
  29. package/dist/cjs/server-commands/index.d.ts +1 -0
  30. package/dist/cjs/server-commands/index.js +7 -0
  31. package/dist/cjs/server-commands/index.js.map +1 -0
  32. package/dist/cjs/server-commands/types.d.ts +4 -0
  33. package/dist/cjs/server-commands/types.js +3 -0
  34. package/dist/cjs/server-commands/types.js.map +1 -0
  35. package/package.json +1 -1
package/README.md CHANGED
@@ -138,7 +138,6 @@ export interface GraphqlResponseWrapper<TData> {
138
138
 
139
139
  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.
140
140
 
141
-
142
141
  ### Real time data exchange
143
142
 
144
143
  - `useDataChannel` hook: this will allow you to exchange information (Send and receive) amongst different users through the same plugin;
@@ -149,14 +148,15 @@ So for this hook to read the data from the data channel, the developer will be a
149
148
  - LATEST_ITEM: Fetches only the latest item pushed to the data-channel within a specific subchannel-name since the begining of the meeting;
150
149
  - NEW_ITEMS: Fetches the new items pushed to the data-channel within a specific subchannel-name since the moment that the `useDataChannel` hook has been called (It will not see entries sent previous to that moment);
151
150
 
152
- One can find examples of usage any of the plugin samples or official ones. The syntax is described ahead:
151
+ An interesting thing about this hook is that it is generic, so, you can use a custom type, and this will be found not only in the consumer part of the data structure returned, but also in functions in which you need to specify an object to be persisted, meaning it will force the object to be of the type you mentioned previously (that is the case for `pushEntry` and `replaceEntry`). One can find examples of usage of this in the data-channel plugin sample or most of the official ones. The syntax is described below:
153
152
 
154
153
  ```typescript
155
- const [
156
- response, // Data that will be returned
157
- pushEntryFunction, // Function to push another item to the data-channel
158
- deleteEntryFunction, // Function to delete specific item or wipe all
159
- ] = useDataChannel(
154
+ const {
155
+ data: response, // Data that will be returned
156
+ pushEntry: pushEntryFunction, // Function to push another item to the data-channel
157
+ deleteEntry: deleteEntryFunction, // Function to delete specific item or wipe all
158
+ replaceEntry: replaceEntryFunction, // Function replace a specifi item
159
+ } = useDataChannel<CustomType>(
160
160
  channelName, // Defined according to what is on settings.yml from bbb-htlm5
161
161
  DataChannelTypes.All_ITEMS, // | LATEST_ITEM | NEW_ITEMS -> ALL_ITEMS is default
162
162
  subChannelName = 'default', // If no subchannelName is specified, it will be 'default'
@@ -167,7 +167,7 @@ Wiping all data off will delete every item from the specific data-channel within
167
167
 
168
168
  The data-channel name must be written in the settings.yml.
169
169
 
170
- All the permission for writing and deleting must be in the yaml too just like the example below:
170
+ All the permission for writing and deleting must be in the yaml too just like the example ahead:
171
171
 
172
172
  ```yaml
173
173
  public:
@@ -176,10 +176,10 @@ public:
176
176
  url: http://<your-hosted-plugin>/PluginName.js
177
177
  dataChannels:
178
178
  - name: channel-name
179
- # writePermission options: moderator, presenter, all
180
- writePermission: ['moderator','presenter']
181
- # deletePermission options: moderator, sender, presenter, all
182
- deletePermission:
179
+ # pushPermission options: moderator, presenter, all
180
+ pushPermission: ['moderator','presenter']
181
+ # replaceOrDeletePermission options: moderator, presenter, creator, all
182
+ replaceOrdeletePermission:
183
183
  - moderator
184
184
  - sender
185
185
  ```
@@ -257,7 +257,6 @@ So the idea is that we have a `uiCommands` object and at a point, there will be
257
257
 
258
258
  - `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.;
259
259
 
260
-
261
260
  ### Frequently Asked Questions (FAQ)
262
261
 
263
262
  **How do I remove a certain extensible area that I don't want anymore?**
@@ -313,7 +312,7 @@ Well there are several motives to why the sample is not working properly, so I w
313
312
 
314
313
  - The config has not been set properly inside `bbb-html5.yml`, see [this section to configure your plugin](#running-the-plugin-from-source);
315
314
  - 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);
316
- - 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.
315
+ - 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.
317
316
 
318
317
  **How to troubleshoot the plugins? See if it has loaded in the BBB, for instance.**
319
318
  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:
@@ -19,6 +19,7 @@ var hooks_8 = require("../../dom-element-manipulation/chat/message/hooks");
19
19
  var hooks_9 = require("../../data-consumption/domain/user-voice/talking-indicator/hooks");
20
20
  var hooks_10 = require("../../ui-data-hooks/hooks");
21
21
  var hooks_11 = require("../../data-consumption/domain/meeting/from-core/hooks");
22
+ var commands_2 = require("../../server-commands/commands");
22
23
  /**
23
24
  * Class responsible for either initialize or get the PluginApi
24
25
  *
@@ -54,6 +55,7 @@ var BbbPluginSdk = /** @class */ (function () {
54
55
  pluginApi.useLoadedChatMessages = (function () { return (0, hooks_7.useLoadedChatMessages)(); });
55
56
  pluginApi.useChatMessageDomElements = function (messageIds) { return (0, hooks_8.useChatMessageDomElements)(messageIds); };
56
57
  pluginApi.uiCommands = commands_1.uiCommands;
58
+ pluginApi.serverCommands = commands_2.serverCommands;
57
59
  pluginApi.useUiData = hooks_10.useUiData;
58
60
  var pluginName = pluginApi === null || pluginApi === void 0 ? void 0 : pluginApi.pluginName;
59
61
  if (pluginName) {
@@ -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;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,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,AA3GD,IA2GC;AA3GqB,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;AAIhE;;;;;;GAMG;AACH;IAAA;IA4GA,CAAC;IA3GC;;;;;;;;;;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;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,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,AA5GD,IA4GC;AA5GqB,oCAAY"}
@@ -26,6 +26,7 @@ import { UseTalkingIndicatorFunction } from '../../data-consumption/domain/user-
26
26
  import { GenericContentInterface } from '../../extensible-areas/generic-content-item/types';
27
27
  import { UseUiDataFunction } from '../../ui-data-hooks/types';
28
28
  import { UseMeetingFunction } from '../../data-consumption/domain/meeting/from-core/types';
29
+ import { ServerCommands } from '../../server-commands/types';
29
30
  export type SetPresentationToolbarItems = (presentationToolbarItem: PresentationToolbarInterface[]) => string[];
30
31
  export type SetUserListDropdownItems = (userListDropdownItem: UserListDropdownInterface[]) => string[];
31
32
  export type SetActionButtonDropdownItems = (actionButtonDropdownInterface: ActionButtonDropdownInterface[]) => string[];
@@ -144,6 +145,7 @@ export interface PluginApi {
144
145
  useDataChannel?: UseDataChannelFunctionFromPluginApi;
145
146
  mapOfPushEntryFunctions: MapOfPushEntryFunctions;
146
147
  uiCommands?: UiCommands;
148
+ serverCommands?: ServerCommands;
147
149
  /**
148
150
  * Function that returns the ui data the developer wants from.
149
151
  *
@@ -51,11 +51,11 @@ exports.useDataChannelGeneral = (function (channelName, subChannelName, pluginNa
51
51
  window.removeEventListener(channelIdentifier, handleDataChange);
52
52
  };
53
53
  }, []);
54
- return [
55
- data,
56
- pushEntryFunction,
57
- deleteEntryFunction,
58
- replaceEntryFunction,
59
- ];
54
+ return {
55
+ data: data,
56
+ pushEntry: pushEntryFunction,
57
+ deleteEntry: deleteEntryFunction,
58
+ replaceEntry: replaceEntryFunction,
59
+ };
60
60
  });
61
61
  //# sourceMappingURL=hooks.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../../src/data-channel/hooks.ts"],"names":[],"mappings":";;;AAAA,+BAA4C;AAa5C,qCAEsB;AAKtB,iCAA6D;AAC7D,iCAAqG;AAExF,QAAA,qBAAqB,GAAG,CAAC,UACpC,WAAmB,EAAE,cAAsB,EAC3C,UAAkB,EAAE,SAAoB,EACxC,eAAiC;IAE3B,IAAA,KAAkB,IAAA,gBAAQ,EAC9B,EAAE,OAAO,EAAE,IAAI,EAAE,CAClB,EAFM,IAAI,QAAA,EAAE,OAAO,QAEnB,CAAC;IACI,IAAA,KAA4C,IAAA,gBAAQ,GAAwB,EAA3E,iBAAiB,QAAA,EAAE,oBAAoB,QAAoC,CAAC;IAEnF,IAAM,mBAAmB,GAAwB,UAC/C,cAAgC,IAC7B,OAAA,IAAA,+BAAuB,EAAC,cAAc,EAAE,WAAW,EAAE,cAAc,EAAE,UAAU,CAAC,EAAhF,CAAgF,CAAC;IAEtF,IAAM,oBAAoB,GAAyB,UACjD,OAAO,EACP,WAAW,IACR,OAAA,IAAA,gCAAwB,EAAC,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,CAAC,EAAvF,CAAuF,CAAC;IAE7F,IAAM,iBAAiB,GAAG,IAAA,+BAAuB,EAAC,WAAW,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;IAE3F,IAAM,gBAAgB,GAAkB,CAAC,UACvC,WAAwF;QAExF,IAAM,WAAW,GAAG,WAAW,CAAC,MAE/B,CAAC;QACF,IAAM,aAAa,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,aAAqC,CAAC;QACzE,IAAI,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,eAAe,MAAK,eAAe,EAAE;YACtD,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;SAC3B;IACH,CAAC,CAAkB,CAAC;IAEpB,IAAM,qCAAqC,GAAkB,CAC3D;QACE,oBAAoB,CAAC,cAAM,OAAA,SAAS,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,EAApD,CAAoD,CAAC,CAAC;QACjF,MAAM,CAAC,mBAAmB,CACxB,UAAG,iBAAiB,wBAAqB,EACzC,qCAAqC,CACtC,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,wBAAqB,EACzC,qCAAqC,CACtC,CAAC;QAEF,MAAM,CAAC,aAAa,CAAC,IAAI,WAAW,CAAyB,iBAAU,CAAC,UAAU,EAAE;YAClF,MAAM,EAAE;gBACN,IAAI,EAAE,wBAAgB,CAAC,oBAAoB;gBAC3C,aAAa,EAAE;oBACb,WAAW,aAAA;oBAAE,UAAU,YAAA;oBAAE,eAAe,iBAAA;oBAAE,cAAc,gBAAA;iBACzD;aACF;SACF,CAAC,CAAC,CAAC;QACJ,OAAO;YACL,MAAM,CAAC,aAAa,CAAC,IAAI,WAAW,CAA2B,iBAAU,CAAC,YAAY,EAAE;gBACtF,MAAM,EAAE;oBACN,IAAI,EAAE,wBAAgB,CAAC,oBAAoB;oBAC3C,aAAa,EAAE;wBACb,WAAW,aAAA;wBAAE,UAAU,YAAA;wBAAE,eAAe,iBAAA;wBAAE,cAAc,gBAAA;qBACzD;iBACF;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;QACL,IAAI;QACJ,iBAAiB;QACjB,mBAAmB;QACnB,oBAAoB;KACrB,CAAC;AACJ,CAAC,CAAiC,CAAC"}
1
+ {"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../../src/data-channel/hooks.ts"],"names":[],"mappings":";;;AAAA,+BAA4C;AAa5C,qCAEsB;AAKtB,iCAA6D;AAC7D,iCAAqG;AAExF,QAAA,qBAAqB,GAAG,CAAC,UACpC,WAAmB,EAAE,cAAsB,EAC3C,UAAkB,EAAE,SAAoB,EACxC,eAAiC;IAE3B,IAAA,KAAkB,IAAA,gBAAQ,EAC9B,EAAE,OAAO,EAAE,IAAI,EAAE,CAClB,EAFM,IAAI,QAAA,EAAE,OAAO,QAEnB,CAAC;IACI,IAAA,KAA4C,IAAA,gBAAQ,GAAwB,EAA3E,iBAAiB,QAAA,EAAE,oBAAoB,QAAoC,CAAC;IAEnF,IAAM,mBAAmB,GAAwB,UAC/C,cAAgC,IAC7B,OAAA,IAAA,+BAAuB,EAAC,cAAc,EAAE,WAAW,EAAE,cAAc,EAAE,UAAU,CAAC,EAAhF,CAAgF,CAAC;IAEtF,IAAM,oBAAoB,GAAyB,UACjD,OAAO,EACP,WAAW,IACR,OAAA,IAAA,gCAAwB,EAAC,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,CAAC,EAAvF,CAAuF,CAAC;IAE7F,IAAM,iBAAiB,GAAG,IAAA,+BAAuB,EAAC,WAAW,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;IAE3F,IAAM,gBAAgB,GAAkB,CAAC,UACvC,WAAwF;QAExF,IAAM,WAAW,GAAG,WAAW,CAAC,MAE/B,CAAC;QACF,IAAM,aAAa,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,aAAqC,CAAC;QACzE,IAAI,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,eAAe,MAAK,eAAe,EAAE;YACtD,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;SAC3B;IACH,CAAC,CAAkB,CAAC;IAEpB,IAAM,qCAAqC,GAAkB,CAC3D;QACE,oBAAoB,CAAC,cAAM,OAAA,SAAS,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,EAApD,CAAoD,CAAC,CAAC;QACjF,MAAM,CAAC,mBAAmB,CACxB,UAAG,iBAAiB,wBAAqB,EACzC,qCAAqC,CACtC,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,wBAAqB,EACzC,qCAAqC,CACtC,CAAC;QAEF,MAAM,CAAC,aAAa,CAAC,IAAI,WAAW,CAAyB,iBAAU,CAAC,UAAU,EAAE;YAClF,MAAM,EAAE;gBACN,IAAI,EAAE,wBAAgB,CAAC,oBAAoB;gBAC3C,aAAa,EAAE;oBACb,WAAW,aAAA;oBAAE,UAAU,YAAA;oBAAE,eAAe,iBAAA;oBAAE,cAAc,gBAAA;iBACzD;aACF;SACF,CAAC,CAAC,CAAC;QACJ,OAAO;YACL,MAAM,CAAC,aAAa,CAAC,IAAI,WAAW,CAA2B,iBAAU,CAAC,YAAY,EAAE;gBACtF,MAAM,EAAE;oBACN,IAAI,EAAE,wBAAgB,CAAC,oBAAoB;oBAC3C,aAAa,EAAE;wBACb,WAAW,aAAA;wBAAE,UAAU,YAAA;wBAAE,eAAe,iBAAA;wBAAE,cAAc,gBAAA;qBACzD;iBACF;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;QACL,IAAI,MAAA;QACJ,SAAS,EAAE,iBAAiB;QAC5B,WAAW,EAAE,mBAAmB;QAChC,YAAY,EAAE,oBAAoB;KACnC,CAAC;AACJ,CAAC,CAAiC,CAAC"}
@@ -1,3 +1,3 @@
1
1
  export { DataChannelPushEntryFunctionUserRole, DataChannelTypes } from './enums';
2
- export { ToUserId, ToRole, DeleteEntryFunction, PushEntryFunction, } from './types';
2
+ export { ToUserId, ToRole, DeleteEntryFunction, PushEntryFunction, DataChannelEntryResponseType, } from './types';
3
3
  export { RESET_DATA_CHANNEL } from './constants';
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/data-channel/index.ts"],"names":[],"mappings":";;;AAAA,iCAAiF;AAAxE,6HAAA,oCAAoC,OAAA;AAAE,yGAAA,gBAAgB,OAAA;AAO/D,yCAAiD;AAAxC,+GAAA,kBAAkB,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/data-channel/index.ts"],"names":[],"mappings":";;;AAAA,iCAAiF;AAAxE,6HAAA,oCAAoC,OAAA;AAAE,yGAAA,gBAAgB,OAAA;AAQ/D,yCAAiD;AAAxC,+GAAA,kBAAkB,OAAA"}
@@ -41,15 +41,11 @@ export interface DataChannelEntryResponseType<T> {
41
41
  pluginName: string;
42
42
  toRoles: string[];
43
43
  }
44
- export type UseDataChannelFunctionFromPluginApi = <T>(channelName: string, dataChannelType?: DataChannelTypes, subChannelName?: string) => [
45
- GraphqlResponseWrapper<DataChannelEntryResponseType<T>[]>,
46
- PushEntryFunction<T>,
47
- DeleteEntryFunction,
48
- ReplaceEntryFunction<T>
49
- ];
50
- export type UseDataChannelStaticFunction = <T>(channelName: string, subChannelName: string, pluginName: string, pluginApi: PluginApi, dataChannelType: DataChannelTypes) => [
51
- GraphqlResponseWrapper<DataChannelEntryResponseType<T>[]>,
52
- PushEntryFunction<T>?,
53
- DeleteEntryFunction?,
54
- ReplaceEntryFunction<T>?
55
- ];
44
+ export interface UseDataChannelReturnType<T> {
45
+ data: GraphqlResponseWrapper<DataChannelEntryResponseType<T>[]>;
46
+ pushEntry: PushEntryFunction<T>;
47
+ deleteEntry: DeleteEntryFunction;
48
+ replaceEntry: ReplaceEntryFunction<T>;
49
+ }
50
+ export type UseDataChannelFunctionFromPluginApi = <T>(channelName: string, dataChannelType?: DataChannelTypes, subChannelName?: string) => UseDataChannelReturnType<T>;
51
+ export type UseDataChannelStaticFunction = <T>(channelName: string, subChannelName: string, pluginName: string, pluginApi: PluginApi, dataChannelType: DataChannelTypes) => UseDataChannelReturnType<T>;
@@ -22,6 +22,7 @@ export declare class GenericContentSidekickArea implements GenericContentInterfa
22
22
  name: string;
23
23
  section: string;
24
24
  buttonIcon: string;
25
+ open: boolean;
25
26
  contentFunction: (element: HTMLElement) => void;
26
27
  /**
27
28
  * Returns an object that when used in the setter as a generic content will be rendered
@@ -35,9 +36,10 @@ export declare class GenericContentSidekickArea implements GenericContentInterfa
35
36
  * @param section - section name under which the associated sidebar navigation button will be
36
37
  * displayed
37
38
  * @param buttonIcon - the icon of the associated sidebar navigation button
39
+ * @param open - boolean value to decide wether to start open
38
40
  *
39
41
  * @returns Object that will be interpreted by the core of Bigbluebutton (HTML5).
40
42
  */
41
- constructor({ contentFunction, name, section, buttonIcon, }: GenericContentSidekickAreaProps);
43
+ constructor({ contentFunction, name, section, buttonIcon, open, }: GenericContentSidekickAreaProps);
42
44
  setItemId: (id: string) => void;
43
45
  }
@@ -39,16 +39,18 @@ var GenericContentSidekickArea = /** @class */ (function () {
39
39
  * @param section - section name under which the associated sidebar navigation button will be
40
40
  * displayed
41
41
  * @param buttonIcon - the icon of the associated sidebar navigation button
42
+ * @param open - boolean value to decide wether to start open
42
43
  *
43
44
  * @returns Object that will be interpreted by the core of Bigbluebutton (HTML5).
44
45
  */
45
46
  function GenericContentSidekickArea(_a) {
46
- var contentFunction = _a.contentFunction, name = _a.name, section = _a.section, buttonIcon = _a.buttonIcon;
47
+ var contentFunction = _a.contentFunction, name = _a.name, section = _a.section, buttonIcon = _a.buttonIcon, open = _a.open;
47
48
  var _this = this;
48
49
  this.id = '';
49
50
  this.name = '';
50
51
  this.section = '';
51
52
  this.buttonIcon = '';
53
+ this.open = false;
52
54
  this.setItemId = function (id) {
53
55
  _this.id = id;
54
56
  };
@@ -57,6 +59,7 @@ var GenericContentSidekickArea = /** @class */ (function () {
57
59
  this.section = section;
58
60
  this.buttonIcon = buttonIcon;
59
61
  this.type = enums_1.GenericContentType.SIDEKICK_AREA;
62
+ this.open = open;
60
63
  }
61
64
  return GenericContentSidekickArea;
62
65
  }());
@@ -1 +1 @@
1
- {"version":3,"file":"component.js","sourceRoot":"","sources":["../../../../src/extensible-areas/generic-content-item/component.ts"],"names":[],"mappings":";;;AAAA,iCAA6C;AAG7C,iCAAiC;AAEjC;IAOE;;;;;;;;OAQG;IACH,gCAAY,EAEkB;YAD5B,eAAe,qBAAA;QADjB,iBAKC;QApBD,OAAE,GAAW,EAAE,CAAC;QAsBhB,cAAS,GAAyB,UAAC,EAAU;YAC3C,KAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACf,CAAC,CAAC;QANA,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,0BAAkB,CAAC,SAAS,CAAC;IAC3C,CAAC;IAKH,6BAAC;AAAD,CAAC,AA1BD,IA0BC;AA1BY,wDAAsB;AA4BnC;IAaE;;;;;;;;;;;;;;OAcG;IACH,oCAAY,EAEsB;YADhC,eAAe,qBAAA,EAAE,IAAI,UAAA,EAAE,OAAO,aAAA,EAAE,UAAU,gBAAA;QAD5C,iBAQC;QAnCD,OAAE,GAAW,EAAE,CAAC;QAIhB,SAAI,GAAW,EAAE,CAAC;QAElB,YAAO,GAAW,EAAE,CAAC;QAErB,eAAU,GAAW,EAAE,CAAC;QA6BxB,cAAS,GAAyB,UAAC,EAAU;YAC3C,KAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACf,CAAC,CAAC;QATA,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,0BAAkB,CAAC,aAAa,CAAC;IAC/C,CAAC;IAKH,iCAAC;AAAD,CAAC,AAzCD,IAyCC;AAzCY,gEAA0B"}
1
+ {"version":3,"file":"component.js","sourceRoot":"","sources":["../../../../src/extensible-areas/generic-content-item/component.ts"],"names":[],"mappings":";;;AAAA,iCAA6C;AAG7C,iCAAiC;AAEjC;IAOE;;;;;;;;OAQG;IACH,gCAAY,EAEkB;YAD5B,eAAe,qBAAA;QADjB,iBAKC;QApBD,OAAE,GAAW,EAAE,CAAC;QAsBhB,cAAS,GAAyB,UAAC,EAAU;YAC3C,KAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACf,CAAC,CAAC;QANA,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,0BAAkB,CAAC,SAAS,CAAC;IAC3C,CAAC;IAKH,6BAAC;AAAD,CAAC,AA1BD,IA0BC;AA1BY,wDAAsB;AA4BnC;IAeE;;;;;;;;;;;;;;;OAeG;IACH,oCAAY,EAEsB;YADhC,eAAe,qBAAA,EAAE,IAAI,UAAA,EAAE,OAAO,aAAA,EAAE,UAAU,gBAAA,EAAE,IAAI,UAAA;QADlD,iBASC;QAvCD,OAAE,GAAW,EAAE,CAAC;QAIhB,SAAI,GAAW,EAAE,CAAC;QAElB,YAAO,GAAW,EAAE,CAAC;QAErB,eAAU,GAAW,EAAE,CAAC;QAExB,SAAI,GAAY,KAAK,CAAC;QA+BtB,cAAS,GAAyB,UAAC,EAAU;YAC3C,KAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACf,CAAC,CAAC;QAVA,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,0BAAkB,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAKH,iCAAC;AAAD,CAAC,AA7CD,IA6CC;AA7CY,gEAA0B"}
@@ -9,4 +9,5 @@ export interface GenericContentSidekickAreaProps {
9
9
  name: string;
10
10
  section: string;
11
11
  buttonIcon: string;
12
+ open: boolean;
12
13
  }
@@ -2,5 +2,6 @@ export * from './extensible-areas';
2
2
  export * from './data-consumption';
3
3
  export * from './data-channel';
4
4
  export * from './ui-data-hooks';
5
+ export * from './server-commands';
5
6
  export * from './core';
6
7
  export * from './utils';
package/dist/cjs/index.js CHANGED
@@ -18,6 +18,7 @@ __exportStar(require("./extensible-areas"), exports);
18
18
  __exportStar(require("./data-consumption"), exports);
19
19
  __exportStar(require("./data-channel"), exports);
20
20
  __exportStar(require("./ui-data-hooks"), exports);
21
+ __exportStar(require("./server-commands"), exports);
21
22
  __exportStar(require("./core"), exports);
22
23
  __exportStar(require("./utils"), exports);
23
24
  //# 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,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,yCAAuB;AAEvB,0CAAwB"}
@@ -0,0 +1,11 @@
1
+ import { CaptionSaveCommandArguments } from './types';
2
+ export declare const caption: {
3
+ /**
4
+ * Saves caption texts into the Caption graphql collection.
5
+ *
6
+ * @param captionSaveCommandArguments the text with which the method will save the caption.
7
+ * Refer to {@link CaptionSaveCommandArguments} to understand the argument structure.
8
+ */
9
+ save: (captionSaveCommandArguments: CaptionSaveCommandArguments) => void;
10
+ addLocale: (captionAddLocaleCommandArguments: string) => void;
11
+ };
@@ -0,0 +1,23 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.caption = void 0;
4
+ var enum_1 = require("./enum");
5
+ exports.caption = {
6
+ /**
7
+ * Saves caption texts into the Caption graphql collection.
8
+ *
9
+ * @param captionSaveCommandArguments the text with which the method will save the caption.
10
+ * Refer to {@link CaptionSaveCommandArguments} to understand the argument structure.
11
+ */
12
+ save: function (captionSaveCommandArguments) {
13
+ window.dispatchEvent(new CustomEvent(enum_1.CaptionCommandsEnum.SAVE, {
14
+ detail: captionSaveCommandArguments,
15
+ }));
16
+ },
17
+ addLocale: function (captionAddLocaleCommandArguments) {
18
+ window.dispatchEvent(new CustomEvent(enum_1.CaptionCommandsEnum.ADD_LOCALE, {
19
+ detail: captionAddLocaleCommandArguments,
20
+ }));
21
+ },
22
+ };
23
+ //# sourceMappingURL=commands.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../src/server-commands/caption/commands.ts"],"names":[],"mappings":";;;AAAA,+BAA6C;AAGhC,QAAA,OAAO,GAAG;IACrB;;;;;OAKG;IACH,IAAI,EAAE,UAAC,2BAAwD;QAC7D,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAEb,0BAAmB,CAAC,IAAI,EAAE;YAC1B,MAAM,EAAE,2BAA2B;SACpC,CAAC,CACH,CAAC;IACJ,CAAC;IACD,SAAS,EAAE,UAAC,gCAAwC;QAClD,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAEb,0BAAmB,CAAC,UAAU,EAAE;YAChC,MAAM,EAAE,gCAAgC;SACzC,CAAC,CACH,CAAC;IACJ,CAAC;CACF,CAAC"}
@@ -0,0 +1,8 @@
1
+ export declare enum CaptionCommandsEnum {
2
+ SAVE = "CAPTION_SAVE_COMMAND",
3
+ ADD_LOCALE = "CAPTION_ADD_LOCALE_COMMAND"
4
+ }
5
+ export declare enum CaptionsTypeEnum {
6
+ AUDIO_TRANSCRIPTION = "AUDIO_TRANSCRIPTION",
7
+ TYPED = "TYPED"
8
+ }
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CaptionsTypeEnum = exports.CaptionCommandsEnum = void 0;
4
+ var CaptionCommandsEnum;
5
+ (function (CaptionCommandsEnum) {
6
+ CaptionCommandsEnum["SAVE"] = "CAPTION_SAVE_COMMAND";
7
+ CaptionCommandsEnum["ADD_LOCALE"] = "CAPTION_ADD_LOCALE_COMMAND";
8
+ })(CaptionCommandsEnum || (exports.CaptionCommandsEnum = CaptionCommandsEnum = {}));
9
+ var CaptionsTypeEnum;
10
+ (function (CaptionsTypeEnum) {
11
+ CaptionsTypeEnum["AUDIO_TRANSCRIPTION"] = "AUDIO_TRANSCRIPTION";
12
+ CaptionsTypeEnum["TYPED"] = "TYPED";
13
+ })(CaptionsTypeEnum || (exports.CaptionsTypeEnum = CaptionsTypeEnum = {}));
14
+ //# sourceMappingURL=enum.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enum.js","sourceRoot":"","sources":["../../../../src/server-commands/caption/enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC7B,oDAA6B,CAAA;IAC7B,gEAAyC,CAAA;AAC3C,CAAC,EAHW,mBAAmB,mCAAnB,mBAAmB,QAG9B;AAED,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,+DAA2C,CAAA;IAC3C,mCAAe,CAAA;AACjB,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B"}
@@ -0,0 +1,9 @@
1
+ export interface CaptionSaveCommandArguments {
2
+ text: string;
3
+ locale: string;
4
+ captionType: string;
5
+ }
6
+ export interface ServerCommandsCaptionObject {
7
+ save: (captionSaveCommandArguments: CaptionSaveCommandArguments) => void;
8
+ addLocale: (captionAddLocaleCommandArguments: string) => void;
9
+ }
@@ -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/caption/types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,6 @@
1
+ export declare const serverCommands: {
2
+ caption: {
3
+ save: (captionSaveCommandArguments: import("./caption/types").CaptionSaveCommandArguments) => void;
4
+ addLocale: (captionAddLocaleCommandArguments: string) => void;
5
+ };
6
+ };
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.serverCommands = void 0;
4
+ var commands_1 = require("./caption/commands");
5
+ exports.serverCommands = {
6
+ caption: commands_1.caption,
7
+ };
8
+ //# sourceMappingURL=commands.js.map
@@ -0,0 +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"}
@@ -0,0 +1 @@
1
+ export { CaptionCommandsEnum, CaptionsTypeEnum } from './caption/enum';
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CaptionsTypeEnum = exports.CaptionCommandsEnum = void 0;
4
+ var enum_1 = require("./caption/enum");
5
+ Object.defineProperty(exports, "CaptionCommandsEnum", { enumerable: true, get: function () { return enum_1.CaptionCommandsEnum; } });
6
+ Object.defineProperty(exports, "CaptionsTypeEnum", { enumerable: true, get: function () { return enum_1.CaptionsTypeEnum; } });
7
+ //# sourceMappingURL=index.js.map
@@ -0,0 +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"}
@@ -0,0 +1,4 @@
1
+ import { ServerCommandsCaptionObject } from './caption/types';
2
+ export interface ServerCommands {
3
+ caption: ServerCommandsCaptionObject;
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/server-commands/types.ts"],"names":[],"mappings":""}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bigbluebutton-html-plugin-sdk",
3
- "version": "0.0.51",
3
+ "version": "0.0.53",
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",