bigbluebutton-html-plugin-sdk 0.0.67 → 0.0.68

package/README.md

@@ -287,6 +287,8 @@ One other thing is that the type of the return is precisely the same type requir
   - close: this function will close the presentation area content automatically;
 - conference:
   - setSpeakerLevel: this function will set the speaker volume level(audio output) of the conference to a certain number between 0 and 1;
+- notification:
+  - send: This function will send a notification for the client to render, keep in mind that it's only client-side. Should you want it to be rendered in multiple clients, use this with a data-channel;
 - user-status:
   - setAwayStatus: this function will set the away status of the user to a certain status;
 

package/dist/cjs/index.d.ts

@@ -3,5 +3,6 @@ export * from './data-consumption';
 export * from './data-channel';
 export * from './ui-data-hooks';
 export * from './server-commands';
+export * from './ui-commands';
 export * from './core';
 export * from './utils';

package/dist/cjs/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./data-consumption"), exports);
 __exportStar(require("./data-channel"), exports);
 __exportStar(require("./ui-data-hooks"), exports);
 __exportStar(require("./server-commands"), exports);
+__exportStar(require("./ui-commands"), exports);
 __exportStar(require("./core"), exports);
 __exportStar(require("./utils"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AAEnC,qDAAmC;AAEnC,iDAA+B;AAE/B,kDAAgC;AAEhC,oDAAkC;AAElC,yCAAuB;AAEvB,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AAEnC,qDAAmC;AAEnC,iDAA+B;AAE/B,kDAAgC;AAEhC,oDAAkC;AAElC,gDAA8B;AAE9B,yCAAuB;AAEvB,0CAAwB"}

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

@@ -24,4 +24,7 @@ export declare const uiCommands: {
     conference: {
         setSpeakerLevel: (setSpeakerLevelCommandArguments: import("./conference/types").SetSpeakerLevelCommandArguments) => void;
     };
+    notification: {
+        send: (information: import("./notification/types").SendNotificationCommandArguments) => void;
+    };
 };

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

@@ -7,6 +7,7 @@ var commands_3 = require("./sidekick-options-container/commands");
 var commands_4 = require("./presentation-area/commands");
 var commands_5 = require("./user-status/commands");
 var commands_6 = require("./conference/commands");
+var commands_7 = require("./notification/commands");
 exports.uiCommands = {
     chat: commands_1.chat,
     externalVideo: commands_2.externalVideo,
@@ -14,5 +15,6 @@ exports.uiCommands = {
     presentationArea: commands_4.presentationArea,
     userStatus: commands_5.userStatus,
     conference: commands_6.conference,
+    notification: commands_7.notification,
 };
 //# sourceMappingURL=commands.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../src/ui-commands/commands.ts"],"names":[],"mappings":";;;AAAA,4CAAuC;AACvC,sDAA0D;AAC1D,kEAAiF;AACjF,yDAAgE;AAChE,mDAAoD;AACpD,kDAAmD;AAEtC,QAAA,UAAU,GAAG;IACxB,IAAI,iBAAA;IACJ,aAAa,0BAAA;IACb,wBAAwB,qCAAA;IACxB,gBAAgB,6BAAA;IAChB,UAAU,uBAAA;IACV,UAAU,uBAAA;CACX,CAAC"}
+{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../src/ui-commands/commands.ts"],"names":[],"mappings":";;;AAAA,4CAAuC;AACvC,sDAA0D;AAC1D,kEAAiF;AACjF,yDAAgE;AAChE,mDAAoD;AACpD,kDAAmD;AACnD,oDAAuD;AAE1C,QAAA,UAAU,GAAG;IACxB,IAAI,iBAAA;IACJ,aAAa,0BAAA;IACb,wBAAwB,qCAAA;IACxB,gBAAgB,6BAAA;IAChB,UAAU,uBAAA;IACV,UAAU,uBAAA;IACV,YAAY,yBAAA;CACb,CAAC"}

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

@@ -0,0 +1 @@
+export { NotificationTypeUiCommand } from './notification/enums';

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

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationTypeUiCommand = void 0;
+var enums_1 = require("./notification/enums");
+Object.defineProperty(exports, "NotificationTypeUiCommand", { enumerable: true, get: function () { return enums_1.NotificationTypeUiCommand; } });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ui-commands/index.ts"],"names":[],"mappings":";;;AAAA,8CAAiE;AAAxD,kHAAA,yBAAyB,OAAA"}

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

@@ -0,0 +1,7 @@
+import { SendNotificationCommandArguments } from './types';
+export declare const notification: {
+    /**
+     * Sends notification to be rendered in the front-end.
+     */
+    send: (information: SendNotificationCommandArguments) => void;
+};

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.notification = void 0;
+var enums_1 = require("./enums");
+exports.notification = {
+    /**
+     * Sends notification to be rendered in the front-end.
+     */
+    send: function (information) {
+        window.dispatchEvent(new CustomEvent(enums_1.NotificationEnum.SEND, {
+            detail: information,
+        }));
+    },
+};
+//# sourceMappingURL=commands.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../src/ui-commands/notification/commands.ts"],"names":[],"mappings":";;;AAAA,iCAA2C;AAG9B,QAAA,YAAY,GAAG;IAC1B;;OAEG;IACH,IAAI,EAAE,UAAC,WAA6C;QAClD,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAEb,wBAAgB,CAAC,IAAI,EAAE;YACvB,MAAM,EAAE,WAAW;SACpB,CAAC,CACH,CAAC;IACJ,CAAC;CACF,CAAC"}

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

@@ -0,0 +1,10 @@
+export declare enum NotificationEnum {
+    SEND = "SEND_NOTIFICATION"
+}
+export declare enum NotificationTypeUiCommand {
+    INFO = "info",
+    DEFAULT = "default",
+    WARNING = "warning",
+    SUCCESS = "success",
+    ERROR = "error"
+}

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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationTypeUiCommand = exports.NotificationEnum = void 0;
+var NotificationEnum;
+(function (NotificationEnum) {
+    NotificationEnum["SEND"] = "SEND_NOTIFICATION";
+})(NotificationEnum || (exports.NotificationEnum = NotificationEnum = {}));
+var NotificationTypeUiCommand;
+(function (NotificationTypeUiCommand) {
+    NotificationTypeUiCommand["INFO"] = "info";
+    NotificationTypeUiCommand["DEFAULT"] = "default";
+    NotificationTypeUiCommand["WARNING"] = "warning";
+    NotificationTypeUiCommand["SUCCESS"] = "success";
+    NotificationTypeUiCommand["ERROR"] = "error";
+})(NotificationTypeUiCommand || (exports.NotificationTypeUiCommand = NotificationTypeUiCommand = {}));
+//# sourceMappingURL=enums.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../../src/ui-commands/notification/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,gBAEX;AAFD,WAAY,gBAAgB;IAC1B,8CAA0B,CAAA;AAC5B,CAAC,EAFW,gBAAgB,gCAAhB,gBAAgB,QAE3B;AAED,IAAY,yBAMX;AAND,WAAY,yBAAyB;IACnC,0CAAa,CAAA;IACb,gDAAmB,CAAA;IACnB,gDAAmB,CAAA;IACnB,gDAAmB,CAAA;IACnB,4CAAe,CAAA;AACjB,CAAC,EANW,yBAAyB,yCAAzB,yBAAyB,QAMpC"}

package/dist/cjs/ui-commands/notification/types.d.ts

@@ -0,0 +1,17 @@
+import { NotificationTypeUiCommand } from './enums';
+export interface SendNotificationCommandArgumentsOptions {
+    helpLabel?: string;
+    helpLink?: string;
+    autoClose?: number;
+}
+export interface SendNotificationCommandArguments {
+    message: string;
+    icon: string;
+    type: NotificationTypeUiCommand;
+    options?: SendNotificationCommandArgumentsOptions;
+    content?: string;
+    small?: boolean;
+}
+export interface UiCommandsNotificationObject {
+    send: (information: SendNotificationCommandArguments) => void;
+}

package/dist/cjs/ui-commands/notification/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/cjs/ui-commands/notification/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/ui-commands/notification/types.ts"],"names":[],"mappings":""}

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

@@ -4,6 +4,7 @@ import { UiCommandsSidekickOptionsContainerObject } from './sidekick-options-con
 import { UiCommandsPresentationAreaObject } from './presentation-area/types';
 import { UiCommandsUserStatusObject } from './user-status/types';
 import { UiCommandsConferenceObject } from './conference/types';
+import { UiCommandsNotificationObject } from './notification/types';
 export interface UiCommands {
     chat: UiCommandsChatObject;
     externalVideo: UiCommandsExternalVideoObject;
@@ -11,4 +12,5 @@ export interface UiCommands {
     presentationArea: UiCommandsPresentationAreaObject;
     userStatus: UiCommandsUserStatusObject;
     conference: UiCommandsConferenceObject;
+    notification: UiCommandsNotificationObject;
 }

package/package.json

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