bigbluebutton-html-plugin-sdk 0.0.93 → 0.0.95

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.
@@ -1,4 +1,4 @@
1
- import { PluginApi } from '../../../../core/api/types';
1
+ import { PluginApi } from '../../../api/types';
2
2
  export interface UseLocaleMessagesProps {
3
3
  pluginApi: PluginApi;
4
4
  fetchConfigs?: RequestInit;
@@ -36,9 +36,10 @@ export interface MapOfPushEntryFunctions {
36
36
  }
37
37
  export interface DataChannelEntryResponseType<T> {
38
38
  createdAt: string;
39
+ updatedAt: string;
39
40
  channelName: string;
40
41
  subChannelName: string;
41
- fromUserId: string;
42
+ createdBy: string;
42
43
  entryId: string;
43
44
  payloadJson: T;
44
45
  pluginName: string;
@@ -1,5 +1,14 @@
1
- import { ChatSendMessageCommandArguments } from './types';
1
+ import { ChatSendMessageCommandArguments, SendChatMessageArguments, CreatePrivateChatCommandArguments } from './types';
2
2
  export declare const chat: (pluginName: string) => {
3
+ /**
4
+ * Sends chat message to specific chat.
5
+ *
6
+ * @param SendChatMessageArguments the text, custom metadata(optional), optional flag
7
+ * to tell whether or not the message will be custom, and the chatId;
8
+ * Refer to {@link SendChatMessageArguments} to understand the argument
9
+ * structure.
10
+ */
11
+ sendChatMessage: (chatMessageArguments: SendChatMessageArguments) => void;
3
12
  /**
4
13
  * Sends chat message to the public chat.
5
14
  *
@@ -19,4 +28,12 @@ export declare const chat: (pluginName: string) => {
19
28
  * structure.
20
29
  */
21
30
  sendCustomPublicChatMessage: (chatSendCustomPublicChatMessageCommandArguments: ChatSendMessageCommandArguments) => void;
31
+ /**
32
+ * Creates a private chat with a specific user.
33
+ *
34
+ * @param createPrivateChatCommandArguments the userId of the user to create a private chat with.
35
+ * Refer to {@link CreatePrivateChatCommandArguments} to understand the argument
36
+ * structure.
37
+ */
38
+ createPrivateChat: (createPrivateChatCommandArguments: CreatePrivateChatCommandArguments) => void;
22
39
  };
@@ -15,6 +15,19 @@ exports.chat = void 0;
15
15
  var constants_1 = require("./constants");
16
16
  var enum_1 = require("./enum");
17
17
  var chat = function (pluginName) { return ({
18
+ /**
19
+ * Sends chat message to specific chat.
20
+ *
21
+ * @param SendChatMessageArguments the text, custom metadata(optional), optional flag
22
+ * to tell whether or not the message will be custom, and the chatId;
23
+ * Refer to {@link SendChatMessageArguments} to understand the argument
24
+ * structure.
25
+ */
26
+ sendChatMessage: function (chatMessageArguments) {
27
+ window.dispatchEvent(new CustomEvent(enum_1.ChatCommandsEnum.SEND_MESSAGE, {
28
+ detail: __assign(__assign({ pluginName: pluginName }, chatMessageArguments), { custom: (chatMessageArguments === null || chatMessageArguments === void 0 ? void 0 : chatMessageArguments.custom) || false }),
29
+ }));
30
+ },
18
31
  /**
19
32
  * Sends chat message to the public chat.
20
33
  *
@@ -42,6 +55,18 @@ var chat = function (pluginName) { return ({
42
55
  detail: __assign({ chatId: constants_1.PUBLIC_CHAT_ID, pluginName: pluginName, custom: true }, chatSendCustomPublicChatMessageCommandArguments),
43
56
  }));
44
57
  },
58
+ /**
59
+ * Creates a private chat with a specific user.
60
+ *
61
+ * @param createPrivateChatCommandArguments the userId of the user to create a private chat with.
62
+ * Refer to {@link CreatePrivateChatCommandArguments} to understand the argument
63
+ * structure.
64
+ */
65
+ createPrivateChat: function (createPrivateChatCommandArguments) {
66
+ window.dispatchEvent(new CustomEvent(enum_1.ChatCommandsEnum.CREATE_PRIVATE_CHAT, {
67
+ detail: __assign({}, createPrivateChatCommandArguments),
68
+ }));
69
+ },
45
70
  }); };
46
71
  exports.chat = chat;
47
72
  //# sourceMappingURL=commands.js.map
@@ -1 +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"}
1
+ {"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../src/server-commands/chat/commands.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,yCAA6C;AAC7C,+BAA0C;AAQnC,IAAM,IAAI,GAAG,UAAC,UAAkB,IAAK,OAAA,CAAC;IAC3C;;;;;;;OAOG;IACH,eAAe,EAAE,UACf,oBAA8C;QAE9C,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAEb,uBAAgB,CAAC,YAAY,EAAE;YAC/B,MAAM,sBACJ,UAAU,YAAA,IACP,oBAAoB,KACvB,MAAM,EAAE,CAAA,oBAAoB,aAApB,oBAAoB,uBAApB,oBAAoB,CAAE,MAAM,KAAI,KAAK,GAC9C;SACF,CAAC,CACH,CAAC;IACJ,CAAC;IAED;;;;;;;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;IAED;;;;;;OAMG;IACH,iBAAiB,EAAE,UACjB,iCAAoE;QAEpE,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAEb,uBAAgB,CAAC,mBAAmB,EAAE;YACtC,MAAM,eACD,iCAAiC,CACrC;SACF,CAAC,CACH,CAAC;IACJ,CAAC;CACF,CAAC,EAhG0C,CAgG1C,CAAC;AAhGU,QAAA,IAAI,QAgGd"}
@@ -1,3 +1,4 @@
1
1
  export declare enum ChatCommandsEnum {
2
- SEND_MESSAGE = "CHAT_SEND_MESSAGE"
2
+ SEND_MESSAGE = "CHAT_SEND_MESSAGE",
3
+ CREATE_PRIVATE_CHAT = "CHAT_CREATE_PRIVATE_CHAT"
3
4
  }
@@ -4,5 +4,6 @@ exports.ChatCommandsEnum = void 0;
4
4
  var ChatCommandsEnum;
5
5
  (function (ChatCommandsEnum) {
6
6
  ChatCommandsEnum["SEND_MESSAGE"] = "CHAT_SEND_MESSAGE";
7
+ ChatCommandsEnum["CREATE_PRIVATE_CHAT"] = "CHAT_CREATE_PRIVATE_CHAT";
7
8
  })(ChatCommandsEnum || (exports.ChatCommandsEnum = ChatCommandsEnum = {}));
8
9
  //# sourceMappingURL=enum.js.map
@@ -1 +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"}
1
+ {"version":3,"file":"enum.js","sourceRoot":"","sources":["../../../../src/server-commands/chat/enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,sDAAkC,CAAA;IAClC,oEAAgD,CAAA;AAClD,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B"}
@@ -7,7 +7,18 @@ export interface ChatSendMessageEventArguments extends ChatSendMessageCommandArg
7
7
  chatId: string;
8
8
  custom: boolean;
9
9
  }
10
+ export interface SendChatMessageArguments {
11
+ textMessageInMarkdownFormat: string;
12
+ chatId: string;
13
+ custom?: boolean;
14
+ pluginCustomMetadata?: string;
15
+ }
16
+ export interface CreatePrivateChatCommandArguments {
17
+ userId: string;
18
+ }
10
19
  export interface ServerCommandsChatObject {
20
+ sendChatMessage: (chatMessageArguments: SendChatMessageArguments) => void;
11
21
  sendCustomPublicChatMessage: (chatSendCustomPublicChatMessageCommandArguments: ChatSendMessageCommandArguments) => void;
12
22
  sendPublicChatMessage: (chatSendPublicChatMessageCommandArguments: ChatSendMessageCommandArguments) => void;
23
+ createPrivateChat: (createPrivateChatCommandArguments: CreatePrivateChatCommandArguments) => void;
13
24
  }
@@ -4,7 +4,9 @@ export declare const serverCommands: (pluginName: string) => {
4
4
  addLocale: (captionAddLocaleCommandArguments: string) => void;
5
5
  };
6
6
  chat: {
7
+ sendChatMessage: (chatMessageArguments: import("./chat/types").SendChatMessageArguments) => void;
7
8
  sendPublicChatMessage: (chatSendPublicChatMessageCommandArguments: import("./chat/types").ChatSendMessageCommandArguments) => void;
8
9
  sendCustomPublicChatMessage: (chatSendCustomPublicChatMessageCommandArguments: import("./chat/types").ChatSendMessageCommandArguments) => void;
10
+ createPrivateChat: (createPrivateChatCommandArguments: import("./chat/types").CreatePrivateChatCommandArguments) => void;
9
11
  };
10
12
  };
@@ -1,6 +1,6 @@
1
1
  export declare const chat: {
2
2
  form: {
3
- open: () => void;
3
+ open: (openChatCommandArgument?: import("./form/types").OpenChatFormCommandArguments | undefined) => void;
4
4
  fill: (fillChatFormCommandArguments: import("./form/types").FillChatFormCommandArguments) => void;
5
5
  };
6
6
  };
@@ -0,0 +1,3 @@
1
+ export declare enum ChatUiCommandsEnum {
2
+ OPEN_PRIVATE_CHAT = "OPEN_PRIVATE_CHAT_COMMAND"
3
+ }
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ChatUiCommandsEnum = void 0;
4
+ var ChatUiCommandsEnum;
5
+ (function (ChatUiCommandsEnum) {
6
+ ChatUiCommandsEnum["OPEN_PRIVATE_CHAT"] = "OPEN_PRIVATE_CHAT_COMMAND";
7
+ })(ChatUiCommandsEnum || (exports.ChatUiCommandsEnum = ChatUiCommandsEnum = {}));
8
+ //# sourceMappingURL=enums.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../../src/ui-commands/chat/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,kBAEX;AAFD,WAAY,kBAAkB;IAC5B,qEAA+C,CAAA;AACjD,CAAC,EAFW,kBAAkB,kCAAlB,kBAAkB,QAE7B"}
@@ -1,9 +1,12 @@
1
- import { FillChatFormCommandArguments } from './types';
1
+ import { FillChatFormCommandArguments, OpenChatFormCommandArguments } from './types';
2
2
  export declare const form: {
3
3
  /**
4
- * Opens the public chat panel automatically.
4
+ * Opens the chat panel automatically. If chatId is provided, opens that specific chat.
5
+ *
6
+ * @param openChatCommandArgument Optional chatId to open a specific chat panel.
7
+ * Refer to {@link OpenChatFormCommandArguments} to understand the argument structure.
5
8
  */
6
- open: () => void;
9
+ open: (openChatCommandArgument?: OpenChatFormCommandArguments) => void;
7
10
  /**
8
11
  * Fills in the chat input when called.
9
12
  *
@@ -4,10 +4,20 @@ exports.form = void 0;
4
4
  var enums_1 = require("./enums");
5
5
  exports.form = {
6
6
  /**
7
- * Opens the public chat panel automatically.
7
+ * Opens the chat panel automatically. If chatId is provided, opens that specific chat.
8
+ *
9
+ * @param openChatCommandArgument Optional chatId to open a specific chat panel.
10
+ * Refer to {@link OpenChatFormCommandArguments} to understand the argument structure.
8
11
  */
9
- open: function () {
10
- window.dispatchEvent(new Event(enums_1.ChatFormCommandsEnum.OPEN));
12
+ open: function (openChatCommandArgument) {
13
+ if (openChatCommandArgument) {
14
+ window.dispatchEvent(new CustomEvent(enums_1.ChatFormCommandsEnum.OPEN, {
15
+ detail: openChatCommandArgument,
16
+ }));
17
+ }
18
+ else {
19
+ window.dispatchEvent(new Event(enums_1.ChatFormCommandsEnum.OPEN));
20
+ }
11
21
  },
12
22
  /**
13
23
  * Fills in the chat input when called.
@@ -1 +1 @@
1
- {"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../../src/ui-commands/chat/form/commands.ts"],"names":[],"mappings":";;;AAAA,iCAA+C;AAGlC,QAAA,IAAI,GAAG;IAClB;;OAEG;IACH,IAAI,EAAE;QACJ,MAAM,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC,4BAAoB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACH,IAAI,EAAE,UAAC,4BAA0D;QAC/D,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAEb,4BAAoB,CAAC,IAAI,EAAE;YAC3B,MAAM,EAAE,4BAA4B;SACrC,CAAC,CACH,CAAC;IACJ,CAAC;CACF,CAAC"}
1
+ {"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../../src/ui-commands/chat/form/commands.ts"],"names":[],"mappings":";;;AAAA,iCAA+C;AAMlC,QAAA,IAAI,GAAG;IAClB;;;;;OAKG;IACH,IAAI,EAAE,UAAC,uBAAsD;QAC3D,IAAI,uBAAuB,EAAE;YAC3B,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAA+B,4BAAoB,CAAC,IAAI,EAAE;gBACvE,MAAM,EAAE,uBAAuB;aAChC,CAAC,CACH,CAAC;SACH;aAAM;YACL,MAAM,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC,4BAAoB,CAAC,IAAI,CAAC,CAAC,CAAC;SAC5D;IACH,CAAC;IAED;;;;;OAKG;IACH,IAAI,EAAE,UAAC,4BAA0D;QAC/D,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAEb,4BAAoB,CAAC,IAAI,EAAE;YAC3B,MAAM,EAAE,4BAA4B;SACrC,CAAC,CACH,CAAC;IACJ,CAAC;CACF,CAAC"}
@@ -1,7 +1,10 @@
1
1
  export interface FillChatFormCommandArguments {
2
2
  text: string;
3
3
  }
4
+ export interface OpenChatFormCommandArguments {
5
+ chatId: string;
6
+ }
4
7
  export interface UiCommandsChatFormObject {
5
- open: () => void;
8
+ open: (openChatCommandArgument?: OpenChatFormCommandArguments) => void;
6
9
  fill: (FillChatFormCommandArguments: FillChatFormCommandArguments) => void;
7
10
  }
@@ -1,2 +1,3 @@
1
1
  export { NotificationTypeUiCommand } from './notification/enums';
2
2
  export { ChangeEnforcedLayoutTypeEnum, EnforcedLayoutTypeEnum } from './layout/enums';
3
+ export { ChatUiCommandsEnum } from './chat/enums';
@@ -1,9 +1,11 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.EnforcedLayoutTypeEnum = exports.ChangeEnforcedLayoutTypeEnum = exports.NotificationTypeUiCommand = void 0;
3
+ exports.ChatUiCommandsEnum = exports.EnforcedLayoutTypeEnum = exports.ChangeEnforcedLayoutTypeEnum = exports.NotificationTypeUiCommand = void 0;
4
4
  var enums_1 = require("./notification/enums");
5
5
  Object.defineProperty(exports, "NotificationTypeUiCommand", { enumerable: true, get: function () { return enums_1.NotificationTypeUiCommand; } });
6
6
  var enums_2 = require("./layout/enums");
7
7
  Object.defineProperty(exports, "ChangeEnforcedLayoutTypeEnum", { enumerable: true, get: function () { return enums_2.ChangeEnforcedLayoutTypeEnum; } });
8
8
  Object.defineProperty(exports, "EnforcedLayoutTypeEnum", { enumerable: true, get: function () { return enums_2.EnforcedLayoutTypeEnum; } });
9
+ var enums_3 = require("./chat/enums");
10
+ Object.defineProperty(exports, "ChatUiCommandsEnum", { enumerable: true, get: function () { return enums_3.ChatUiCommandsEnum; } });
9
11
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ui-commands/index.ts"],"names":[],"mappings":";;;AAAA,8CAAiE;AAAxD,kHAAA,yBAAyB,OAAA;AAClC,wCAAsF;AAA7E,qHAAA,4BAA4B,OAAA;AAAE,+GAAA,sBAAsB,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ui-commands/index.ts"],"names":[],"mappings":";;;AAAA,8CAAiE;AAAxD,kHAAA,yBAAyB,OAAA;AAClC,wCAAsF;AAA7E,qHAAA,4BAA4B,OAAA;AAAE,+GAAA,sBAAsB,OAAA;AAC7D,sCAAkD;AAAzC,2GAAA,kBAAkB,OAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bigbluebutton-html-plugin-sdk",
3
- "version": "0.0.93",
3
+ "version": "0.0.95",
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",