bigbluebutton-html-plugin-sdk 0.1.11 → 0.1.13

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

@@ -36,9 +36,10 @@ export interface MapOfPushEntryFunctions {
 }
 export interface DataChannelEntryResponseType<T> {
     createdAt: string;
+    updatedAt: string;
     channelName: string;
     subChannelName: string;
-    fromUserId: string;
+    createdBy: string;
     entryId: string;
     payloadJson: T;
     pluginName: string;

package/dist/cjs/server-commands/chat/commands.d.ts

@@ -1,5 +1,14 @@
-import { ChatSendMessageCommandArguments } from './types';
+import { ChatSendMessageCommandArguments, SendChatMessageArguments, CreatePrivateChatCommandArguments } from './types';
 export declare const chat: (pluginName: string) => {
+    /**
+     * Sends chat message to specific chat.
+     *
+     * @param SendChatMessageArguments the text, custom metadata(optional), optional flag
+     *  to tell whether or not the message will be custom, and the chatId;
+     * Refer to {@link SendChatMessageArguments} to understand the argument
+     *  structure.
+     */
+    sendChatMessage: (chatMessageArguments: SendChatMessageArguments) => void;
     /**
      * Sends chat message to the public chat.
      *
@@ -19,4 +28,12 @@ export declare const chat: (pluginName: string) => {
      *  structure.
      */
     sendCustomPublicChatMessage: (chatSendCustomPublicChatMessageCommandArguments: ChatSendMessageCommandArguments) => void;
+    /**
+     * Creates a private chat with a specific user.
+     *
+     * @param createPrivateChatCommandArguments the userId of the user to create a private chat with.
+     * Refer to {@link CreatePrivateChatCommandArguments} to understand the argument
+     *  structure.
+     */
+    createPrivateChat: (createPrivateChatCommandArguments: CreatePrivateChatCommandArguments) => void;
 };

package/dist/cjs/server-commands/chat/commands.js

@@ -15,6 +15,19 @@ exports.chat = void 0;
 var constants_1 = require("./constants");
 var enum_1 = require("./enum");
 var chat = function (pluginName) { return ({
+    /**
+     * Sends chat message to specific chat.
+     *
+     * @param SendChatMessageArguments the text, custom metadata(optional), optional flag
+     *  to tell whether or not the message will be custom, and the chatId;
+     * Refer to {@link SendChatMessageArguments} to understand the argument
+     *  structure.
+     */
+    sendChatMessage: function (chatMessageArguments) {
+        window.dispatchEvent(new CustomEvent(enum_1.ChatCommandsEnum.SEND_MESSAGE, {
+            detail: __assign(__assign({ pluginName: pluginName }, chatMessageArguments), { custom: (chatMessageArguments === null || chatMessageArguments === void 0 ? void 0 : chatMessageArguments.custom) || false }),
+        }));
+    },
     /**
      * Sends chat message to the public chat.
      *
@@ -42,6 +55,18 @@ var chat = function (pluginName) { return ({
             detail: __assign({ chatId: constants_1.PUBLIC_CHAT_ID, pluginName: pluginName, custom: true }, chatSendCustomPublicChatMessageCommandArguments),
         }));
     },
+    /**
+     * Creates a private chat with a specific user.
+     *
+     * @param createPrivateChatCommandArguments the userId of the user to create a private chat with.
+     * Refer to {@link CreatePrivateChatCommandArguments} to understand the argument
+     *  structure.
+     */
+    createPrivateChat: function (createPrivateChatCommandArguments) {
+        window.dispatchEvent(new CustomEvent(enum_1.ChatCommandsEnum.CREATE_PRIVATE_CHAT, {
+            detail: __assign({}, createPrivateChatCommandArguments),
+        }));
+    },
 }); };
 exports.chat = chat;
 //# sourceMappingURL=commands.js.map

package/dist/cjs/server-commands/chat/commands.js.map

@@ -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"}
+{"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"}

package/dist/cjs/server-commands/chat/enum.d.ts

@@ -1,3 +1,4 @@
 export declare enum ChatCommandsEnum {
-    SEND_MESSAGE = "CHAT_SEND_MESSAGE"
+    SEND_MESSAGE = "CHAT_SEND_MESSAGE",
+    CREATE_PRIVATE_CHAT = "CHAT_CREATE_PRIVATE_CHAT"
 }

package/dist/cjs/server-commands/chat/enum.js

@@ -4,5 +4,6 @@ exports.ChatCommandsEnum = void 0;
 var ChatCommandsEnum;
 (function (ChatCommandsEnum) {
     ChatCommandsEnum["SEND_MESSAGE"] = "CHAT_SEND_MESSAGE";
+    ChatCommandsEnum["CREATE_PRIVATE_CHAT"] = "CHAT_CREATE_PRIVATE_CHAT";
 })(ChatCommandsEnum || (exports.ChatCommandsEnum = ChatCommandsEnum = {}));
 //# sourceMappingURL=enum.js.map

package/dist/cjs/server-commands/chat/enum.js.map

@@ -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"}
+{"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"}

package/dist/cjs/server-commands/chat/types.d.ts

@@ -7,7 +7,18 @@ export interface ChatSendMessageEventArguments extends ChatSendMessageCommandArg
     chatId: string;
     custom: boolean;
 }
+export interface SendChatMessageArguments {
+    textMessageInMarkdownFormat: string;
+    chatId: string;
+    custom?: boolean;
+    pluginCustomMetadata?: string;
+}
+export interface CreatePrivateChatCommandArguments {
+    userId: string;
+}
 export interface ServerCommandsChatObject {
+    sendChatMessage: (chatMessageArguments: SendChatMessageArguments) => void;
     sendCustomPublicChatMessage: (chatSendCustomPublicChatMessageCommandArguments: ChatSendMessageCommandArguments) => void;
     sendPublicChatMessage: (chatSendPublicChatMessageCommandArguments: ChatSendMessageCommandArguments) => void;
+    createPrivateChat: (createPrivateChatCommandArguments: CreatePrivateChatCommandArguments) => void;
 }

package/dist/cjs/server-commands/commands.d.ts

@@ -4,7 +4,9 @@ export declare const serverCommands: (pluginName: string) => {
         addLocale: (captionAddLocaleCommandArguments: string) => void;
     };
     chat: {
+        sendChatMessage: (chatMessageArguments: import("./chat/types").SendChatMessageArguments) => void;
         sendPublicChatMessage: (chatSendPublicChatMessageCommandArguments: import("./chat/types").ChatSendMessageCommandArguments) => void;
         sendCustomPublicChatMessage: (chatSendCustomPublicChatMessageCommandArguments: import("./chat/types").ChatSendMessageCommandArguments) => void;
+        createPrivateChat: (createPrivateChatCommandArguments: import("./chat/types").CreatePrivateChatCommandArguments) => void;
     };
 };

package/dist/cjs/ui-commands/chat/commands.d.ts

@@ -1,6 +1,6 @@
 export declare const chat: {
     form: {
-        open: () => void;
+        open: (openChatCommandArgument?: import("./form/types").OpenChatFormCommandArguments | undefined) => void;
         fill: (fillChatFormCommandArguments: import("./form/types").FillChatFormCommandArguments) => void;
     };
 };

package/dist/cjs/ui-commands/chat/enums.d.ts

@@ -0,0 +1,3 @@
+export declare enum ChatUiCommandsEnum {
+    OPEN_PRIVATE_CHAT = "OPEN_PRIVATE_CHAT_COMMAND"
+}

package/dist/cjs/ui-commands/chat/enums.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatUiCommandsEnum = void 0;
+var ChatUiCommandsEnum;
+(function (ChatUiCommandsEnum) {
+    ChatUiCommandsEnum["OPEN_PRIVATE_CHAT"] = "OPEN_PRIVATE_CHAT_COMMAND";
+})(ChatUiCommandsEnum || (exports.ChatUiCommandsEnum = ChatUiCommandsEnum = {}));
+//# sourceMappingURL=enums.js.map

package/dist/cjs/ui-commands/chat/enums.js.map

@@ -0,0 +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"}

package/dist/cjs/ui-commands/chat/form/commands.d.ts

@@ -1,9 +1,12 @@
-import { FillChatFormCommandArguments } from './types';
+import { FillChatFormCommandArguments, OpenChatFormCommandArguments } from './types';
 export declare const form: {
     /**
-     * Opens the public chat panel automatically.
+     * Opens the chat panel automatically. If chatId is provided, opens that specific chat.
+     *
+     * @param openChatCommandArgument Optional chatId to open a specific chat panel.
+     * Refer to {@link OpenChatFormCommandArguments} to understand the argument structure.
      */
-    open: () => void;
+    open: (openChatCommandArgument?: OpenChatFormCommandArguments) => void;
     /**
      * Fills in the chat input when called.
      *

package/dist/cjs/ui-commands/chat/form/commands.js

@@ -4,10 +4,20 @@ exports.form = void 0;
 var enums_1 = require("./enums");
 exports.form = {
     /**
-     * Opens the public chat panel automatically.
+     * Opens the chat panel automatically. If chatId is provided, opens that specific chat.
+     *
+     * @param openChatCommandArgument Optional chatId to open a specific chat panel.
+     * Refer to {@link OpenChatFormCommandArguments} to understand the argument structure.
      */
-    open: function () {
-        window.dispatchEvent(new Event(enums_1.ChatFormCommandsEnum.OPEN));
+    open: function (openChatCommandArgument) {
+        if (openChatCommandArgument) {
+            window.dispatchEvent(new CustomEvent(enums_1.ChatFormCommandsEnum.OPEN, {
+                detail: openChatCommandArgument,
+            }));
+        }
+        else {
+            window.dispatchEvent(new Event(enums_1.ChatFormCommandsEnum.OPEN));
+        }
     },
     /**
      * Fills in the chat input when called.

package/dist/cjs/ui-commands/chat/form/commands.js.map

@@ -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"}
+{"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"}

package/dist/cjs/ui-commands/chat/form/types.d.ts

@@ -1,7 +1,10 @@
 export interface FillChatFormCommandArguments {
     text: string;
 }
+export interface OpenChatFormCommandArguments {
+    chatId: string;
+}
 export interface UiCommandsChatFormObject {
-    open: () => void;
+    open: (openChatCommandArgument?: OpenChatFormCommandArguments) => void;
     fill: (FillChatFormCommandArguments: FillChatFormCommandArguments) => void;
 }

package/dist/cjs/ui-commands/index.d.ts

@@ -1,3 +1,4 @@
 export { NotificationTypeUiCommand } from './notification/enums';
 export { ChangeEnforcedLayoutTypeEnum, EnforcedLayoutTypeEnum } from './layout/enums';
 export { CaptionsLanguageEnum } from './captions/enums';
+export { ChatUiCommandsEnum } from './chat/enums';

package/dist/cjs/ui-commands/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CaptionsLanguageEnum = exports.EnforcedLayoutTypeEnum = exports.ChangeEnforcedLayoutTypeEnum = exports.NotificationTypeUiCommand = void 0;
+exports.ChatUiCommandsEnum = exports.CaptionsLanguageEnum = exports.EnforcedLayoutTypeEnum = exports.ChangeEnforcedLayoutTypeEnum = exports.NotificationTypeUiCommand = void 0;
 var enums_1 = require("./notification/enums");
 Object.defineProperty(exports, "NotificationTypeUiCommand", { enumerable: true, get: function () { return enums_1.NotificationTypeUiCommand; } });
 var enums_2 = require("./layout/enums");
@@ -8,4 +8,6 @@ Object.defineProperty(exports, "ChangeEnforcedLayoutTypeEnum", { enumerable: tru
 Object.defineProperty(exports, "EnforcedLayoutTypeEnum", { enumerable: true, get: function () { return enums_2.EnforcedLayoutTypeEnum; } });
 var enums_3 = require("./captions/enums");
 Object.defineProperty(exports, "CaptionsLanguageEnum", { enumerable: true, get: function () { return enums_3.CaptionsLanguageEnum; } });
+var enums_4 = require("./chat/enums");
+Object.defineProperty(exports, "ChatUiCommandsEnum", { enumerable: true, get: function () { return enums_4.ChatUiCommandsEnum; } });
 //# sourceMappingURL=index.js.map

package/dist/cjs/ui-commands/index.js.map

@@ -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;AAC7D,0CAAwD;AAA/C,6GAAA,oBAAoB,OAAA"}
+{"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,0CAAwD;AAA/C,6GAAA,oBAAoB,OAAA;AAC7B,sCAAkD;AAAzC,2GAAA,kBAAkB,OAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bigbluebutton-html-plugin-sdk",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "homepage": "https://github.com/bigbluebutton/bigbluebutton-html-plugin-sdk",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",