@beekeeperstudio/plugin 1.0.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Beekeeper Studio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,37 @@
+# @beekeeperstudio/plugin
+
+A TypeScript wrapper library for building Beekeeper Studio plugins that enables communication between your plugin and the main application.
+
+## Installation
+
+```bash
+npm install github:beekeeper-studio/plugin
+# or
+yarn add github:beekeeper-studio/plugin
+```
+
+## Quick Start
+
+```typescript
+import { request, notify } from '@beekeeperstudio/plugin';
+
+// Get all tables in the current database
+const tables = await request('getTables');
+
+// Run a SQL query
+const result = await request('runQuery', { query: 'SELECT * FROM users LIMIT 10' });
+```
+
+## Development
+
+```bash
+# Build the library
+npm run build
+
+# Prepare for publishing
+npm run prepublishOnly
+```
+
+## License
+
+MIT

package/dist/eventForwarder.js

@@ -0,0 +1,139 @@
+const pendingRequests = new Map();
+window.addEventListener("message", (event) => {
+    const { id, name, args, result, error } = event.data || {};
+    if (name) {
+        const handlers = notificationListeners.get(name);
+        if (handlers) {
+            handlers.forEach((handler) => handler(args));
+        }
+    }
+    if (id && pendingRequests.has(id)) {
+        const { resolve, reject, name } = pendingRequests.get(id);
+        pendingRequests.delete(id);
+        if (error) {
+            reject(error);
+        }
+        else {
+            resolve(result);
+        }
+    }
+});
+function notify(name, args) {
+    window.parent.postMessage({ name, args }, "*");
+}
+const notificationListeners = new Map();
+
+/** Any events that need to be forwarded to parent/plugin system
+ * must go here */
+/** FIXME this file must be injected from the plugin system automatically */
+function createEventInit(event) {
+    if (event instanceof MouseEvent) {
+        const eventInitOptions = {
+            clientX: event.clientX,
+            clientY: event.clientY,
+            screenX: event.screenX,
+            screenY: event.screenY,
+            button: event.button,
+            buttons: event.buttons,
+            altKey: event.altKey,
+            ctrlKey: event.ctrlKey,
+            shiftKey: event.shiftKey,
+            metaKey: event.metaKey,
+            movementX: event.movementX,
+            movementY: event.movementY,
+            detail: event.detail,
+        };
+        return {
+            eventClass: "MouseEvent",
+            eventInitOptions,
+        };
+    }
+    if (event instanceof PointerEvent) {
+        const eventInitOptions = {
+            clientX: event.clientX,
+            clientY: event.clientY,
+            screenX: event.screenX,
+            screenY: event.screenY,
+            button: event.button,
+            buttons: event.buttons,
+            altKey: event.altKey,
+            ctrlKey: event.ctrlKey,
+            shiftKey: event.shiftKey,
+            metaKey: event.metaKey,
+            movementX: event.movementX,
+            movementY: event.movementY,
+            detail: event.detail,
+            pointerId: event.pointerId,
+            pointerType: event.pointerType,
+            isPrimary: event.isPrimary,
+        };
+        return {
+            eventClass: "PointerEvent",
+            eventInitOptions,
+        };
+    }
+    if (event instanceof KeyboardEvent) {
+        const isPasswordField = event.target?.type === "password";
+        if (isPasswordField) {
+            // Avoid logging keystrokes from password fields
+            return {
+                eventClass: "KeyboardEvent",
+                eventInitOptions: {},
+            };
+        }
+        const eventInitOptions = {
+            key: event.key,
+            code: event.code,
+            keyCode: event.keyCode,
+            location: event.location,
+            altKey: event.altKey,
+            ctrlKey: event.ctrlKey,
+            shiftKey: event.shiftKey,
+            metaKey: event.metaKey,
+            repeat: event.repeat,
+            isComposing: event.isComposing,
+        };
+        return {
+            eventClass: "KeyboardEvent",
+            eventInitOptions,
+        };
+    }
+    return {
+        eventClass: "Event",
+        eventInitOptions: {},
+    };
+}
+const forwardedEvents = [
+    "contextmenu",
+    "click",
+    "dblclick",
+    "pointercancel",
+    "pointerdown",
+    "pointerenter",
+    "pointerleave",
+    "pointermove",
+    "pointerout",
+    "pointerover",
+    "pointerup",
+    "mousedown",
+    "mouseenter",
+    "mouseleave",
+    "mousemove",
+    "mouseout",
+    "mouseover",
+    "mouseup",
+    "keydown",
+    "keypress",
+    "keyup",
+];
+forwardedEvents.forEach((eventType) => {
+    document.addEventListener(eventType, (event) => {
+        const eventInit = createEventInit(event);
+        notify("windowEvent", {
+            eventType,
+            eventClass: eventInit.eventClass,
+            eventInitOptions: eventInit.eventInitOptions,
+        });
+    });
+});
+//# sourceMappingURL=eventForwarder.js.map

package/dist/eventForwarder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventForwarder.js","sources":["../src/comms.ts","../src/eventForwarder.ts"],"sourcesContent":["import type {\n  GetTablesRequest,\n  GetColumnsRequest,\n  RunQueryRequest,\n  ExpandTableResultRequest,\n  SetTabTitleRequest,\n  GetViewStateRequest,\n  SetViewStateRequest,\n  OpenExternalRequest,\n} from \"./requestTypes\";\nimport type {\n  GetTablesResponse,\n  GetColumnsResponse,\n  GetConnectionInfoResponse,\n  GetAllTabsResponse,\n  RunQueryResponse,\n  ExpandTableResultResponse,\n  SetTabTitleResponse,\n  GetViewStateResponse,\n  SetViewStateResponse,\n  OpenExternalResponse,\n} from \"./responseTypes\";\nimport { generateUUID } from \"./utils\";\n\n// Define a custom import.meta interface for TypeScript\ndeclare global {\n  interface ImportMeta {\n    env: {\n      MODE: string;\n    };\n  }\n}\n\nconst pendingRequests = new Map<\n  string,\n  {\n    name: string;\n    resolve: (value: any) => void;\n    reject: (reason?: any) => void;\n  }\n>();\n\nlet debugComms = false;\n\nexport function setDebugComms(value: boolean) {\n  debugComms = value;\n}\n\nwindow.addEventListener(\"message\", (event) => {\n  const { id, name, args, result, error } = event.data || {};\n\n  if (name) {\n    if (debugComms) {\n      const time = new Date().toLocaleTimeString(\"en-GB\");\n      console.groupCollapsed(`${time} [NOTIFICATION] ${name}`);\n      console.log(\"Args:\", args);\n      console.groupEnd();\n    }\n\n    const handlers = notificationListeners.get(name);\n    if (handlers) {\n      handlers.forEach((handler) => handler(args));\n    }\n  }\n\n  if (id && pendingRequests.has(id)) {\n    const { resolve, reject, name } = pendingRequests.get(id)!;\n    pendingRequests.delete(id);\n\n    if (debugComms) {\n      const time = new Date().toLocaleTimeString(\"en-GB\");\n      console.groupCollapsed(`${time} [RESPONSE] ${name}`);\n      console.log(\"Result:\", result);\n      if (error) console.error(\"Error:\", error);\n      console.groupEnd();\n    }\n\n    if (error) {\n      reject(error);\n    } else {\n      resolve(result);\n    }\n  }\n});\n\nexport async function request(name: \"getTables\", args?: GetTablesRequest[\"args\"]): Promise<GetTablesResponse>;\nexport async function request(name: \"getColumns\", args: GetColumnsRequest[\"args\"]): Promise<GetColumnsResponse>;\nexport async function request(name: \"getConnectionInfo\"): Promise<GetConnectionInfoResponse>;\nexport async function request(name: \"getAllTabs\"): Promise<GetAllTabsResponse>;\nexport async function request(name: \"runQuery\", args: RunQueryRequest[\"args\"]): Promise<RunQueryResponse>;\nexport async function request(name: \"expandTableResult\", args: ExpandTableResultRequest[\"args\"]): Promise<ExpandTableResultResponse>;\nexport async function request(name: \"setTabTitle\", args: SetTabTitleRequest[\"args\"]): Promise<SetTabTitleResponse>;\nexport async function request<T extends unknown>(name: \"getViewState\", args: GetViewStateRequest[\"args\"]): Promise<GetViewStateResponse<T>>;\nexport async function request<T extends unknown>(name: \"setViewState\", args: SetViewStateRequest<T>[\"args\"]): Promise<SetViewStateResponse>;\nexport async function request<T extends unknown>(name: \"openExternal\", args: OpenExternalRequest[\"args\"]): Promise<OpenExternalResponse>;\nexport async function request(name: unknown, args?: unknown): Promise<unknown> {\n  if (debugComms) {\n    const time = new Date().toLocaleTimeString(\"en-GB\");\n    console.groupCollapsed(`${time} [REQUEST] ${name}`);\n    console.log(\"Args:\", args);\n    console.groupEnd();\n  }\n\n  return new Promise<any>((resolve, reject) => {\n    try {\n      const id = generateUUID();\n      const data = { id, name, args };\n      pendingRequests.set(id, { name: name as string, resolve, reject });\n      window.parent.postMessage(data, \"*\");\n    } catch (e) {\n      reject(e);\n    }\n  });\n}\n\nexport function notify(name: string, args: any) {\n  if (debugComms) {\n    const time = new Date().toLocaleTimeString(\"en-GB\");\n    console.groupCollapsed(`${time} [NOTIFICATION] ${name}`);\n    console.log(\"Args:\", args);\n    console.groupEnd();\n  }\n  window.parent.postMessage({ name, args }, \"*\");\n}\n\nconst notificationListeners = new Map<string, ((args: any) => void)[]>();\n\nexport async function addNotificationListener(\n  name: string,\n  handler: (args: any) => void,\n) {\n  if (!notificationListeners.get(name)) {\n    notificationListeners.set(name, []);\n  }\n  notificationListeners.get(name)!.push(handler);\n}\n","/** Any events that need to be forwarded to parent/plugin system\n * must go here */\n\n/** FIXME this file must be injected from the plugin system automatically */\n\nimport { notify } from \"./comms\";\nimport { WindowEventInits, WindowEventClass } from \"./commonTypes\";\n\nfunction createEventInit<T>(event: T): {\n  eventClass: WindowEventClass;\n  eventInitOptions: WindowEventInits;\n} {\n  if (event instanceof MouseEvent) {\n    const eventInitOptions: MouseEventInit = {\n      clientX: event.clientX,\n      clientY: event.clientY,\n      screenX: event.screenX,\n      screenY: event.screenY,\n      button: event.button,\n      buttons: event.buttons,\n      altKey: event.altKey,\n      ctrlKey: event.ctrlKey,\n      shiftKey: event.shiftKey,\n      metaKey: event.metaKey,\n      movementX: event.movementX,\n      movementY: event.movementY,\n      detail: event.detail,\n    };\n    return {\n      eventClass: \"MouseEvent\",\n      eventInitOptions,\n    };\n  }\n\n  if (event instanceof PointerEvent) {\n    const eventInitOptions: PointerEventInit = {\n      clientX: event.clientX,\n      clientY: event.clientY,\n      screenX: event.screenX,\n      screenY: event.screenY,\n      button: event.button,\n      buttons: event.buttons,\n      altKey: event.altKey,\n      ctrlKey: event.ctrlKey,\n      shiftKey: event.shiftKey,\n      metaKey: event.metaKey,\n      movementX: event.movementX,\n      movementY: event.movementY,\n      detail: event.detail,\n      pointerId: event.pointerId,\n      pointerType: event.pointerType,\n      isPrimary: event.isPrimary,\n    };\n    return {\n      eventClass: \"PointerEvent\",\n      eventInitOptions,\n    };\n  }\n\n  if (event instanceof KeyboardEvent) {\n    const isPasswordField =\n      (event.target as HTMLInputElement)?.type === \"password\";\n\n    if (isPasswordField) {\n      // Avoid logging keystrokes from password fields\n      return {\n        eventClass: \"KeyboardEvent\",\n        eventInitOptions: {},\n      };\n    }\n\n    const eventInitOptions: KeyboardEventInit = {\n      key: event.key,\n      code: event.code,\n      keyCode: event.keyCode,\n      location: event.location,\n      altKey: event.altKey,\n      ctrlKey: event.ctrlKey,\n      shiftKey: event.shiftKey,\n      metaKey: event.metaKey,\n      repeat: event.repeat,\n      isComposing: event.isComposing,\n    };\n\n    return {\n      eventClass: \"KeyboardEvent\",\n      eventInitOptions,\n    };\n  }\n\n  return {\n    eventClass: \"Event\",\n    eventInitOptions: {},\n  };\n}\n\nconst forwardedEvents = [\n  \"contextmenu\",\n  \"click\",\n  \"dblclick\",\n  \"pointercancel\",\n  \"pointerdown\",\n  \"pointerenter\",\n  \"pointerleave\",\n  \"pointermove\",\n  \"pointerout\",\n  \"pointerover\",\n  \"pointerup\",\n  \"mousedown\",\n  \"mouseenter\",\n  \"mouseleave\",\n  \"mousemove\",\n  \"mouseout\",\n  \"mouseover\",\n  \"mouseup\",\n  \"keydown\",\n  \"keypress\",\n  \"keyup\",\n] as const;\n\nforwardedEvents.forEach((eventType) => {\n  document.addEventListener(eventType, (event) => {\n    const eventInit = createEventInit(event);\n    notify(\"windowEvent\", {\n      eventType,\n      eventClass: eventInit.eventClass,\n      eventInitOptions: eventInit.eventInitOptions,\n    });\n  });\n});\n"],"names":[],"mappings":"AAiCA,MAAM,eAAe,GAAG,IAAI,GAAG,EAO5B;AAQH,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,KAAI;AAC3C,IAAA,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE;IAE1D,IAAI,IAAI,EAAE;QAQR,MAAM,QAAQ,GAAG,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC;QAChD,IAAI,QAAQ,EAAE;AACZ,YAAA,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;;;IAIhD,IAAI,EAAE,IAAI,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;AACjC,QAAA,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,eAAe,CAAC,GAAG,CAAC,EAAE,CAAE;AAC1D,QAAA,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;QAU1B,IAAI,KAAK,EAAE;YACT,MAAM,CAAC,KAAK,CAAC;;aACR;YACL,OAAO,CAAC,MAAM,CAAC;;;AAGrB,CAAC,CAAC;AAgCc,SAAA,MAAM,CAAC,IAAY,EAAE,IAAS,EAAA;AAO5C,IAAA,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,GAAG,CAAC;AAChD;AAEA,MAAM,qBAAqB,GAAG,IAAI,GAAG,EAAmC;;AC7HxE;AACkB;AAElB;AAKA,SAAS,eAAe,CAAI,KAAQ,EAAA;AAIlC,IAAA,IAAI,KAAK,YAAY,UAAU,EAAE;AAC/B,QAAA,MAAM,gBAAgB,GAAmB;YACvC,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,MAAM,EAAE,KAAK,CAAC,MAAM;SACrB;QACD,OAAO;AACL,YAAA,UAAU,EAAE,YAAY;YACxB,gBAAgB;SACjB;;AAGH,IAAA,IAAI,KAAK,YAAY,YAAY,EAAE;AACjC,QAAA,MAAM,gBAAgB,GAAqB;YACzC,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,SAAS,EAAE,KAAK,CAAC,SAAS;SAC3B;QACD,OAAO;AACL,YAAA,UAAU,EAAE,cAAc;YAC1B,gBAAgB;SACjB;;AAGH,IAAA,IAAI,KAAK,YAAY,aAAa,EAAE;QAClC,MAAM,eAAe,GAClB,KAAK,CAAC,MAA2B,EAAE,IAAI,KAAK,UAAU;QAEzD,IAAI,eAAe,EAAE;;YAEnB,OAAO;AACL,gBAAA,UAAU,EAAE,eAAe;AAC3B,gBAAA,gBAAgB,EAAE,EAAE;aACrB;;AAGH,QAAA,MAAM,gBAAgB,GAAsB;YAC1C,GAAG,EAAE,KAAK,CAAC,GAAG;YACd,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,WAAW,EAAE,KAAK,CAAC,WAAW;SAC/B;QAED,OAAO;AACL,YAAA,UAAU,EAAE,eAAe;YAC3B,gBAAgB;SACjB;;IAGH,OAAO;AACL,QAAA,UAAU,EAAE,OAAO;AACnB,QAAA,gBAAgB,EAAE,EAAE;KACrB;AACH;AAEA,MAAM,eAAe,GAAG;IACtB,aAAa;IACb,OAAO;IACP,UAAU;IACV,eAAe;IACf,aAAa;IACb,cAAc;IACd,cAAc;IACd,aAAa;IACb,YAAY;IACZ,aAAa;IACb,WAAW;IACX,WAAW;IACX,YAAY;IACZ,YAAY;IACZ,WAAW;IACX,UAAU;IACV,WAAW;IACX,SAAS;IACT,SAAS;IACT,UAAU;IACV,OAAO;CACC;AAEV,eAAe,CAAC,OAAO,CAAC,CAAC,SAAS,KAAI;IACpC,QAAQ,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,KAAI;AAC7C,QAAA,MAAM,SAAS,GAAG,eAAe,CAAC,KAAK,CAAC;QACxC,MAAM,CAAC,aAAa,EAAE;YACpB,SAAS;YACT,UAAU,EAAE,SAAS,CAAC,UAAU;YAChC,gBAAgB,EAAE,SAAS,CAAC,gBAAgB;AAC7C,SAAA,CAAC;AACJ,KAAC,CAAC;AACJ,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,170 @@
+type ThemeType = "dark" | "light";
+interface QueryResult {
+    fields: {
+        id: string;
+        name: string;
+        dataType?: string;
+    }[];
+    rows: Record<string, unknown>[];
+}
+type WindowEventClass = "MouseEvent" | "KeyboardEvent" | "PointerEvent" | "Event";
+type WindowEventInits = MouseEventInit | KeyboardEventInit | PointerEventInit;
+
+interface BaseRequest {
+    id: string;
+}
+interface GetTablesRequest extends BaseRequest {
+    name: "getTables";
+    args: {
+        schema?: string;
+    };
+}
+interface GetColumnsRequest extends BaseRequest {
+    name: "getColumns";
+    args: {
+        table: string;
+        schema?: string;
+    };
+}
+interface GetConnectionInfoRequest extends BaseRequest {
+    name: "getConnectionInfo";
+    args: void;
+}
+interface GetAllTabsRequest extends BaseRequest {
+    name: "getAllTabs";
+    args: void;
+}
+interface RunQueryRequest extends BaseRequest {
+    name: "runQuery";
+    args: {
+        query: string;
+    };
+}
+interface ExpandTableResultRequest extends BaseRequest {
+    name: "expandTableResult";
+    args: {
+        results: QueryResult[];
+    };
+}
+interface SetTabTitleRequest extends BaseRequest {
+    name: "setTabTitle";
+    args: {
+        title: string;
+    };
+}
+interface GetViewStateRequest extends BaseRequest {
+    name: "getViewState";
+    args: void;
+}
+interface SetViewStateRequest<T extends unknown> extends BaseRequest {
+    name: "setViewState";
+    args: {
+        state: T;
+    };
+}
+interface OpenExternalRequest extends BaseRequest {
+    name: "openExternal";
+    args: {
+        link: boolean;
+    };
+}
+type PluginRequestData = GetTablesRequest | GetColumnsRequest | GetConnectionInfoRequest | GetAllTabsRequest | RunQueryRequest | ExpandTableResultRequest | SetTabTitleRequest | GetViewStateRequest | SetViewStateRequest<unknown> | OpenExternalRequest;
+
+type TabType = string;
+type TableFilter = any;
+type TableOrView = any;
+
+/** The list of tables */
+type GetTablesResponse = {
+    name: string;
+    schema?: string;
+}[];
+/** The list of columns */
+type GetColumnsResponse = {
+    name: string;
+    type: string;
+}[];
+type GetConnectionInfoResponse = {
+    connectionType: string;
+    databaseName: string;
+    defaultSchema?: string;
+    readOnlyMode: boolean;
+};
+type TabResponse = BaseTabResponse | QueryTabResponse | TableTabResponse;
+type GetAllTabsResponse = TabResponse[];
+type RunQueryResponse = {
+    results: QueryResult[];
+    error?: unknown;
+};
+type ExpandTableResultResponse = void;
+type SetTabTitleResponse = void;
+type GetViewStateResponse<T extends unknown> = T;
+type SetViewStateResponse = void;
+type OpenExternalResponse = void;
+interface PluginResponseData {
+    id: string;
+    result: GetTablesResponse | GetColumnsResponse | GetConnectionInfoResponse | GetAllTabsResponse | RunQueryResponse | ExpandTableResultResponse | SetTabTitleResponse | GetViewStateResponse<unknown> | SetViewStateResponse | OpenExternalResponse;
+    error?: Error;
+}
+interface QueryTabResponse extends BaseTabResponse {
+    type: "query";
+    data: {
+        query: string;
+        result: unknown;
+    };
+}
+interface TableTabResponse extends BaseTabResponse {
+    type: "table";
+    data: {
+        table: TableOrView;
+        filters: TableFilter[] | string;
+        result: unknown;
+    };
+}
+interface BaseTabResponse {
+    type: TabType;
+    id: number;
+    title: string;
+}
+
+interface ThemeChangedNotification {
+    name: "themeChanged";
+    args: {
+        palette: Record<string, string>;
+        cssString: string;
+        type: ThemeType;
+    };
+}
+interface WindowEventNotification {
+    name: "windowEvent";
+    args: {
+        eventType: string;
+        eventClass: WindowEventClass;
+        eventInitOptions: WindowEventInits;
+    };
+}
+type PluginNotificationData = ThemeChangedNotification | WindowEventNotification;
+
+declare global {
+    interface ImportMeta {
+        env: {
+            MODE: string;
+        };
+    }
+}
+declare function setDebugComms(value: boolean): void;
+declare function request(name: "getTables", args?: GetTablesRequest["args"]): Promise<GetTablesResponse>;
+declare function request(name: "getColumns", args: GetColumnsRequest["args"]): Promise<GetColumnsResponse>;
+declare function request(name: "getConnectionInfo"): Promise<GetConnectionInfoResponse>;
+declare function request(name: "getAllTabs"): Promise<GetAllTabsResponse>;
+declare function request(name: "runQuery", args: RunQueryRequest["args"]): Promise<RunQueryResponse>;
+declare function request(name: "expandTableResult", args: ExpandTableResultRequest["args"]): Promise<ExpandTableResultResponse>;
+declare function request(name: "setTabTitle", args: SetTabTitleRequest["args"]): Promise<SetTabTitleResponse>;
+declare function request<T extends unknown>(name: "getViewState", args: GetViewStateRequest["args"]): Promise<GetViewStateResponse<T>>;
+declare function request<T extends unknown>(name: "setViewState", args: SetViewStateRequest<T>["args"]): Promise<SetViewStateResponse>;
+declare function request<T extends unknown>(name: "openExternal", args: OpenExternalRequest["args"]): Promise<OpenExternalResponse>;
+declare function notify(name: string, args: any): void;
+declare function addNotificationListener(name: string, handler: (args: any) => void): Promise<void>;
+
+export { addNotificationListener, notify, request, setDebugComms };
+export type { ExpandTableResultRequest, ExpandTableResultResponse, GetAllTabsRequest, GetAllTabsResponse, GetColumnsRequest, GetColumnsResponse, GetConnectionInfoRequest, GetConnectionInfoResponse, GetTablesRequest, GetTablesResponse, GetViewStateRequest, GetViewStateResponse, OpenExternalRequest, OpenExternalResponse, PluginNotificationData, PluginRequestData, PluginResponseData, QueryResult, RunQueryRequest, RunQueryResponse, SetTabTitleRequest, SetTabTitleResponse, SetViewStateRequest, SetViewStateResponse, TabResponse, ThemeChangedNotification, ThemeType, WindowEventClass, WindowEventInits, WindowEventNotification };

package/dist/index.js

@@ -0,0 +1,91 @@
+function generateUUID() {
+    const buf = new Uint8Array(16);
+    crypto.getRandomValues(buf);
+    buf[6] = (buf[6] & 0x0f) | 0x40; // version 4
+    buf[8] = (buf[8] & 0x3f) | 0x80; // variant
+    const hex = Array.from(buf, (b) => b.toString(16).padStart(2, "0")).join("");
+    return [
+        hex.substring(0, 8),
+        hex.substring(8, 12),
+        hex.substring(12, 16),
+        hex.substring(16, 20),
+        hex.substring(20),
+    ].join("-");
+}
+
+const pendingRequests = new Map();
+let debugComms = false;
+function setDebugComms(value) {
+    debugComms = value;
+}
+window.addEventListener("message", (event) => {
+    const { id, name, args, result, error } = event.data || {};
+    if (name) {
+        if (debugComms) {
+            const time = new Date().toLocaleTimeString("en-GB");
+            console.groupCollapsed(`${time} [NOTIFICATION] ${name}`);
+            console.log("Args:", args);
+            console.groupEnd();
+        }
+        const handlers = notificationListeners.get(name);
+        if (handlers) {
+            handlers.forEach((handler) => handler(args));
+        }
+    }
+    if (id && pendingRequests.has(id)) {
+        const { resolve, reject, name } = pendingRequests.get(id);
+        pendingRequests.delete(id);
+        if (debugComms) {
+            const time = new Date().toLocaleTimeString("en-GB");
+            console.groupCollapsed(`${time} [RESPONSE] ${name}`);
+            console.log("Result:", result);
+            if (error)
+                console.error("Error:", error);
+            console.groupEnd();
+        }
+        if (error) {
+            reject(error);
+        }
+        else {
+            resolve(result);
+        }
+    }
+});
+async function request(name, args) {
+    if (debugComms) {
+        const time = new Date().toLocaleTimeString("en-GB");
+        console.groupCollapsed(`${time} [REQUEST] ${name}`);
+        console.log("Args:", args);
+        console.groupEnd();
+    }
+    return new Promise((resolve, reject) => {
+        try {
+            const id = generateUUID();
+            const data = { id, name, args };
+            pendingRequests.set(id, { name: name, resolve, reject });
+            window.parent.postMessage(data, "*");
+        }
+        catch (e) {
+            reject(e);
+        }
+    });
+}
+function notify(name, args) {
+    if (debugComms) {
+        const time = new Date().toLocaleTimeString("en-GB");
+        console.groupCollapsed(`${time} [NOTIFICATION] ${name}`);
+        console.log("Args:", args);
+        console.groupEnd();
+    }
+    window.parent.postMessage({ name, args }, "*");
+}
+const notificationListeners = new Map();
+async function addNotificationListener(name, handler) {
+    if (!notificationListeners.get(name)) {
+        notificationListeners.set(name, []);
+    }
+    notificationListeners.get(name).push(handler);
+}
+
+export { addNotificationListener, notify, request, setDebugComms };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/utils.ts","../src/comms.ts"],"sourcesContent":["export function generateUUID() {\n  const buf = new Uint8Array(16);\n  crypto.getRandomValues(buf);\n\n  buf[6] = (buf[6] & 0x0f) | 0x40; // version 4\n  buf[8] = (buf[8] & 0x3f) | 0x80; // variant\n\n  const hex = Array.from(buf, (b) => b.toString(16).padStart(2, \"0\")).join(\"\");\n\n  return [\n    hex.substring(0, 8),\n    hex.substring(8, 12),\n    hex.substring(12, 16),\n    hex.substring(16, 20),\n    hex.substring(20),\n  ].join(\"-\");\n}\n","import type {\n  GetTablesRequest,\n  GetColumnsRequest,\n  RunQueryRequest,\n  ExpandTableResultRequest,\n  SetTabTitleRequest,\n  GetViewStateRequest,\n  SetViewStateRequest,\n  OpenExternalRequest,\n} from \"./requestTypes\";\nimport type {\n  GetTablesResponse,\n  GetColumnsResponse,\n  GetConnectionInfoResponse,\n  GetAllTabsResponse,\n  RunQueryResponse,\n  ExpandTableResultResponse,\n  SetTabTitleResponse,\n  GetViewStateResponse,\n  SetViewStateResponse,\n  OpenExternalResponse,\n} from \"./responseTypes\";\nimport { generateUUID } from \"./utils\";\n\n// Define a custom import.meta interface for TypeScript\ndeclare global {\n  interface ImportMeta {\n    env: {\n      MODE: string;\n    };\n  }\n}\n\nconst pendingRequests = new Map<\n  string,\n  {\n    name: string;\n    resolve: (value: any) => void;\n    reject: (reason?: any) => void;\n  }\n>();\n\nlet debugComms = false;\n\nexport function setDebugComms(value: boolean) {\n  debugComms = value;\n}\n\nwindow.addEventListener(\"message\", (event) => {\n  const { id, name, args, result, error } = event.data || {};\n\n  if (name) {\n    if (debugComms) {\n      const time = new Date().toLocaleTimeString(\"en-GB\");\n      console.groupCollapsed(`${time} [NOTIFICATION] ${name}`);\n      console.log(\"Args:\", args);\n      console.groupEnd();\n    }\n\n    const handlers = notificationListeners.get(name);\n    if (handlers) {\n      handlers.forEach((handler) => handler(args));\n    }\n  }\n\n  if (id && pendingRequests.has(id)) {\n    const { resolve, reject, name } = pendingRequests.get(id)!;\n    pendingRequests.delete(id);\n\n    if (debugComms) {\n      const time = new Date().toLocaleTimeString(\"en-GB\");\n      console.groupCollapsed(`${time} [RESPONSE] ${name}`);\n      console.log(\"Result:\", result);\n      if (error) console.error(\"Error:\", error);\n      console.groupEnd();\n    }\n\n    if (error) {\n      reject(error);\n    } else {\n      resolve(result);\n    }\n  }\n});\n\nexport async function request(name: \"getTables\", args?: GetTablesRequest[\"args\"]): Promise<GetTablesResponse>;\nexport async function request(name: \"getColumns\", args: GetColumnsRequest[\"args\"]): Promise<GetColumnsResponse>;\nexport async function request(name: \"getConnectionInfo\"): Promise<GetConnectionInfoResponse>;\nexport async function request(name: \"getAllTabs\"): Promise<GetAllTabsResponse>;\nexport async function request(name: \"runQuery\", args: RunQueryRequest[\"args\"]): Promise<RunQueryResponse>;\nexport async function request(name: \"expandTableResult\", args: ExpandTableResultRequest[\"args\"]): Promise<ExpandTableResultResponse>;\nexport async function request(name: \"setTabTitle\", args: SetTabTitleRequest[\"args\"]): Promise<SetTabTitleResponse>;\nexport async function request<T extends unknown>(name: \"getViewState\", args: GetViewStateRequest[\"args\"]): Promise<GetViewStateResponse<T>>;\nexport async function request<T extends unknown>(name: \"setViewState\", args: SetViewStateRequest<T>[\"args\"]): Promise<SetViewStateResponse>;\nexport async function request<T extends unknown>(name: \"openExternal\", args: OpenExternalRequest[\"args\"]): Promise<OpenExternalResponse>;\nexport async function request(name: unknown, args?: unknown): Promise<unknown> {\n  if (debugComms) {\n    const time = new Date().toLocaleTimeString(\"en-GB\");\n    console.groupCollapsed(`${time} [REQUEST] ${name}`);\n    console.log(\"Args:\", args);\n    console.groupEnd();\n  }\n\n  return new Promise<any>((resolve, reject) => {\n    try {\n      const id = generateUUID();\n      const data = { id, name, args };\n      pendingRequests.set(id, { name: name as string, resolve, reject });\n      window.parent.postMessage(data, \"*\");\n    } catch (e) {\n      reject(e);\n    }\n  });\n}\n\nexport function notify(name: string, args: any) {\n  if (debugComms) {\n    const time = new Date().toLocaleTimeString(\"en-GB\");\n    console.groupCollapsed(`${time} [NOTIFICATION] ${name}`);\n    console.log(\"Args:\", args);\n    console.groupEnd();\n  }\n  window.parent.postMessage({ name, args }, \"*\");\n}\n\nconst notificationListeners = new Map<string, ((args: any) => void)[]>();\n\nexport async function addNotificationListener(\n  name: string,\n  handler: (args: any) => void,\n) {\n  if (!notificationListeners.get(name)) {\n    notificationListeners.set(name, []);\n  }\n  notificationListeners.get(name)!.push(handler);\n}\n"],"names":[],"mappings":"SAAgB,YAAY,GAAA;AAC1B,IAAA,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,EAAE,CAAC;AAC9B,IAAA,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC;AAE3B,IAAA,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,IAAI,CAAC;AAChC,IAAA,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,IAAI,CAAC;AAEhC,IAAA,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;IAE5E,OAAO;AACL,QAAA,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;AACnB,QAAA,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;AACpB,QAAA,GAAG,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC;AACrB,QAAA,GAAG,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC;AACrB,QAAA,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;AAClB,KAAA,CAAC,IAAI,CAAC,GAAG,CAAC;AACb;;ACiBA,MAAM,eAAe,GAAG,IAAI,GAAG,EAO5B;AAEH,IAAI,UAAU,GAAG,KAAK;AAEhB,SAAU,aAAa,CAAC,KAAc,EAAA;IAC1C,UAAU,GAAG,KAAK;AACpB;AAEA,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,KAAI;AAC3C,IAAA,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE;IAE1D,IAAI,IAAI,EAAE;QACR,IAAI,UAAU,EAAE;YACd,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,kBAAkB,CAAC,OAAO,CAAC;YACnD,OAAO,CAAC,cAAc,CAAC,CAAA,EAAG,IAAI,CAAmB,gBAAA,EAAA,IAAI,CAAE,CAAA,CAAC;AACxD,YAAA,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC;YAC1B,OAAO,CAAC,QAAQ,EAAE;;QAGpB,MAAM,QAAQ,GAAG,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC;QAChD,IAAI,QAAQ,EAAE;AACZ,YAAA,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;;;IAIhD,IAAI,EAAE,IAAI,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;AACjC,QAAA,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,eAAe,CAAC,GAAG,CAAC,EAAE,CAAE;AAC1D,QAAA,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;QAE1B,IAAI,UAAU,EAAE;YACd,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,kBAAkB,CAAC,OAAO,CAAC;YACnD,OAAO,CAAC,cAAc,CAAC,CAAA,EAAG,IAAI,CAAe,YAAA,EAAA,IAAI,CAAE,CAAA,CAAC;AACpD,YAAA,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC;AAC9B,YAAA,IAAI,KAAK;AAAE,gBAAA,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC;YACzC,OAAO,CAAC,QAAQ,EAAE;;QAGpB,IAAI,KAAK,EAAE;YACT,MAAM,CAAC,KAAK,CAAC;;aACR;YACL,OAAO,CAAC,MAAM,CAAC;;;AAGrB,CAAC,CAAC;AAYK,eAAe,OAAO,CAAC,IAAa,EAAE,IAAc,EAAA;IACzD,IAAI,UAAU,EAAE;QACd,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,kBAAkB,CAAC,OAAO,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,CAAA,EAAG,IAAI,CAAc,WAAA,EAAA,IAAI,CAAE,CAAA,CAAC;AACnD,QAAA,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC;QAC1B,OAAO,CAAC,QAAQ,EAAE;;IAGpB,OAAO,IAAI,OAAO,CAAM,CAAC,OAAO,EAAE,MAAM,KAAI;AAC1C,QAAA,IAAI;AACF,YAAA,MAAM,EAAE,GAAG,YAAY,EAAE;YACzB,MAAM,IAAI,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;AAC/B,YAAA,eAAe,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAc,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;YAClE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC;;QACpC,OAAO,CAAC,EAAE;YACV,MAAM,CAAC,CAAC,CAAC;;AAEb,KAAC,CAAC;AACJ;AAEgB,SAAA,MAAM,CAAC,IAAY,EAAE,IAAS,EAAA;IAC5C,IAAI,UAAU,EAAE;QACd,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,kBAAkB,CAAC,OAAO,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,CAAA,EAAG,IAAI,CAAmB,gBAAA,EAAA,IAAI,CAAE,CAAA,CAAC;AACxD,QAAA,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC;QAC1B,OAAO,CAAC,QAAQ,EAAE;;AAEpB,IAAA,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,GAAG,CAAC;AAChD;AAEA,MAAM,qBAAqB,GAAG,IAAI,GAAG,EAAmC;AAEjE,eAAe,uBAAuB,CAC3C,IAAY,EACZ,OAA4B,EAAA;IAE5B,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;AACpC,QAAA,qBAAqB,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;;IAErC,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC,IAAI,CAAC,OAAO,CAAC;AAChD;;;;"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@beekeeperstudio/plugin",
+  "version": "1.0.10",
+  "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",
+  "files": [
+    "dist/*.js",
+    "dist/*.d.ts",
+    "dist/*.js.map",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "rollup -c",
+    "prepublishOnly": "yarn run build",
+    "clean": "rm -rf dist"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/beekeeper-studio/plugin.git"
+  },
+  "keywords": [
+    "beekeeper-studio",
+    "plugin",
+    "typescript",
+    "database"
+  ],
+  "license": "MIT",
+  "private": false,
+  "author": {
+    "name": "Beekeeper Studio Team",
+    "email": "support@beekeeperstudio.io",
+    "url": "https://beekeeperstudio.io"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^28.0.3",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "rollup": "^4.41.1",
+    "rollup-plugin-dts": "^6.2.1",
+    "tslib": "^2.8.1",
+    "typescript": "^5.8.3"
+  }
+}