new methods

Author: azmy60

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beekeeperstudio/plugin",
-  "version": "1.3.1",
+  "version": "1.4.0-beta.1",
   "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/index.ts

@@ -9,6 +9,10 @@ import type {
   OpenExternalRequest,
   SetDataRequest,
   SetEncryptedDataRequest,
+  OpenTabRequest,
+  OpenQueryTabRequest,
+  OpenTableTableTabRequest,
+  OpenTableStructureTabRequest,
 } from "./requestTypes";
 import type {
   GetTablesResponse,
@@ -25,6 +29,7 @@ import type {
   SetDataResponse,
   GetEncryptedDataResponse,
   SetEncryptedDataResponse,
+  OpenTabResponse,
 } from "./responseTypes";
 
 export async function getTables(schema?: string): Promise<GetTablesResponse['result']> {
@@ -115,6 +120,13 @@ export async function setEncryptedData<T>(keyOrValue: string | T, value?: T): Pr
   }
 }
 
+export async function openTab(type: "query", args: Omit<OpenQueryTabRequest['args'], 'type'>): Promise<OpenTabResponse>;
+export async function openTab(type: "tableTable", args: Omit<OpenTableTableTabRequest['args'], 'type'>): Promise<OpenTabResponse>;
+export async function openTab(type: "tableStructure", args: Omit<OpenTableStructureTabRequest['args'], 'type'>): Promise<OpenTabResponse>;
+export async function openTab(type: OpenTabRequest['args']['type'], args: Omit<OpenTabRequest['args'], 'type'>): Promise<OpenTabResponse> {
+  return await request({ name: "openTab", args: { type, ...args } });
+}
+
 /** Clipboard interface. */
 export const clipboard = {
   /** Write text to the Electron clipboard. */

src/requestTypes.ts

@@ -111,6 +111,37 @@ export interface ClipboardReadTextRequest extends BaseRequest {
   args: void;
 }
 
+export type OpenQueryTabRequest = BaseRequest & {
+  name: "openTab";
+  args: {
+    type: "query";
+    query: string;
+  };
+}
+
+export type OpenTableTableTabRequest = BaseRequest & {
+  name: "openTab";
+  args: {
+    type: "tableTable";
+    table: string;
+    schema?: string;
+  };
+}
+
+export type OpenTableStructureTabRequest = BaseRequest & {
+  name: "openTab";
+  args: {
+    type: "tableStructure";
+    table: string;
+    schema?: string;
+  };
+}
+
+export type OpenTabRequest =
+  | OpenQueryTabRequest
+  | OpenTableTableTabRequest
+  | OpenTableStructureTabRequest;
+
 export type PluginRequestData =
   | GetTablesRequest
   | GetColumnsRequest
@@ -127,6 +158,9 @@ export type PluginRequestData =
   | GetEncryptedDataRequest
   | SetEncryptedDataRequest<unknown>
   | ClipboardWriteTextRequest
-  | ClipboardReadTextRequest;
+  | ClipboardReadTextRequest
+  | OpenQueryTabRequest
+  | OpenTableTableTabRequest
+  | OpenTableStructureTabRequest;
 
 export type PluginRequestPayload = PluginRequestData;

src/responseTypes.ts

@@ -87,6 +87,10 @@ export interface ClipboardReadTextResponse extends BaseResponse {
   result: string;
 }
 
+export interface OpenTabResponse extends BaseResponse {
+  result: void;
+}
+
 export type PluginResponseData =
   | GetTablesResponse
   | GetColumnsResponse
@@ -103,7 +107,8 @@ export type PluginResponseData =
   | GetEncryptedDataResponse<unknown>
   | SetEncryptedDataResponse
   | ClipboardWriteTextResponse
-  | ClipboardReadTextResponse;
+  | ClipboardReadTextResponse
+  | OpenTabResponse;
 
 export type PluginResponsePayload = PluginResponseData;