add broadcast and log object

Author: azmy60

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beekeeperstudio/plugin",
-  "version": "1.4.0-beta.4",
+  "version": "1.4.0-beta.5",
   "description": "A simple TypeScript wrapper to send messages from your Beekeeper Studio plugin to the main app.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/comms.ts

@@ -29,8 +29,8 @@ const pendingRequests = new Map<
 
 let debugComms = false;
 
-export function setDebugComms(value: boolean) {
-  debugComms = value;
+export function setDebugComms(enabled: boolean) {
+  debugComms = enabled;
 }
 
 window.addEventListener("message", (event) => {

src/index.ts

@@ -1,4 +1,5 @@
-import { request } from "./comms";
+import { JsonValue } from "./commonTypes";
+import { addNotificationListener, notify, request } from "./comms";
 import type {
   GetTablesRequest,
   GetColumnsRequest,
@@ -213,7 +214,34 @@ export async function openTab(type: OpenTabRequest['args']['type'], args?: Omit<
   return await request({ name: "openTab", args: { type, ...args } });
 }
 
-/** Clipboard interface. */
+/** @since Beekeeper Studio 5.4.0 */
+export const broadcast = {
+  post<T extends JsonValue = JsonValue>(message: T) {
+    return notify("broadcast", { message });
+  },
+  on<T extends JsonValue = JsonValue>(handler: (message: T) => void) {
+    addNotificationListener<T>("broadcast", (params) => {
+      handler(params.message);
+    });
+  },
+}
+
+/** @since Beekeeper Studio 5.3.0 */
+export const log = {
+  error(err: string | Error) {
+    return notify("pluginError", {
+      name: err.name || "Error",
+      message: err.message || err,
+      stack: err.stack,
+    });
+  },
+}
+
+/**
+ * Clipboard interface.
+ *
+ * @since Beekeeper Studio 5.3.0
+ **/
 export const clipboard = {
   /** Write text to the Electron clipboard. */
   async writeText(text: string): Promise<void> {

src/responseTypes.ts

@@ -40,7 +40,7 @@ export interface GetConnectionInfoResponse extends BaseResponse {
   result: {
     /** @deprecated Use `databaseType` instead */
     connectionType: string;
-    databaseType: string;
+    databaseType: 'postgresql' | 'mysql' | 'mariadb' | 'sqlite' | 'sqlserver' | 'oracle' | 'mongodb' | 'cassandra' | 'clickhouse' | 'firebird' | 'bigquery' | 'redshift' | 'duckdb' | 'libsql' | 'redis' | 'surrealdb' | 'trino';
     databaseTypeDisplayName: string;
     databaseName: string;
     defaultSchema?: string;