add getData, setData, getEncryptedData, setEncryptedData[]

Author: azmy60

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beekeeperstudio/plugin",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "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

@@ -7,6 +7,10 @@ import type {
   GetViewStateRequest,
   SetViewStateRequest,
   OpenExternalRequest,
+  GetEncryptedDataRequest,
+  SetEncryptedDataRequest,
+  GetDataRequest,
+  SetDataRequest,
 } from "./requestTypes";
 import type {
   GetTablesResponse,
@@ -19,6 +23,10 @@ import type {
   GetViewStateResponse,
   SetViewStateResponse,
   OpenExternalResponse,
+  GetEncryptedDataResponse,
+  SetEncryptedDataResponse,
+  GetDataResponse,
+  SetDataResponse,
 } from "./responseTypes";
 import { generateUUID } from "./utils";
 
@@ -93,6 +101,10 @@ export async function request(name: "setTabTitle", args: SetTabTitleRequest["arg
 export async function request<T extends unknown>(name: "getViewState", args: GetViewStateRequest["args"]): Promise<GetViewStateResponse<T>>;
 export async function request<T extends unknown>(name: "setViewState", args: SetViewStateRequest<T>["args"]): Promise<SetViewStateResponse>;
 export async function request<T extends unknown>(name: "openExternal", args: OpenExternalRequest["args"]): Promise<OpenExternalResponse>;
+export async function request<T extends unknown>(name: "getData", args: GetDataRequest["args"]): Promise<GetDataResponse<T>>;
+export async function request<T extends unknown>(name: "setData", args: SetDataRequest<T>["args"]): Promise<SetDataResponse>;
+export async function request<T extends unknown>(name: "getEncryptedData", args: GetEncryptedDataRequest["args"]): Promise<GetEncryptedDataResponse<T>>;
+export async function request<T extends unknown>(name: "setEncryptedData", args: SetEncryptedDataRequest<T>["args"]): Promise<SetEncryptedDataResponse>;
 export async function request(name: unknown, args?: unknown): Promise<unknown> {
   if (debugComms) {
     const time = new Date().toLocaleTimeString("en-GB");

src/requestTypes.ts

@@ -69,6 +69,26 @@ export interface OpenExternalRequest extends BaseRequest {
   };
 }
 
+export interface SetDataRequest<T extends unknown> extends BaseRequest {
+  name: "setData";
+  args: T;
+}
+
+export interface GetDataRequest extends BaseRequest {
+  name: "getData";
+  args: void;
+}
+
+export interface GetEncryptedDataRequest extends BaseRequest {
+  name: "getEncryptedData";
+  args: void;
+}
+
+export interface SetEncryptedDataRequest<T extends unknown> extends BaseRequest {
+  name: "setEncryptedData";
+  args: T;
+}
+
 export type PluginRequestData =
   | GetTablesRequest
   | GetColumnsRequest
@@ -79,4 +99,8 @@ export type PluginRequestData =
   | SetTabTitleRequest
   | GetViewStateRequest
   | SetViewStateRequest<unknown>
-  | OpenExternalRequest;
+  | OpenExternalRequest
+  | GetDataRequest
+  | SetDataRequest<unknown>
+  | GetEncryptedDataRequest
+  | SetEncryptedDataRequest<unknown>;

src/responseTypes.ts

@@ -42,6 +42,14 @@ export type SetViewStateResponse = void;
 
 export type OpenExternalResponse = void;
 
+export type GetDataResponse<T extends unknown> = T;
+
+export type SetDataResponse = void;
+
+export type GetEncryptedDataResponse<T extends unknown> = T;
+
+export type SetEncryptedDataResponse = void;
+
 export interface PluginResponseData {
   id: string;
   result:
@@ -54,7 +62,11 @@ export interface PluginResponseData {
     | SetTabTitleResponse
     | GetViewStateResponse<unknown>
     | SetViewStateResponse
-    | OpenExternalResponse;
+    | OpenExternalResponse
+    | GetDataResponse<unknown>
+    | SetDataResponse
+    | GetEncryptedDataResponse<unknown>
+    | SetEncryptedDataResponse;
   error?: Error;
 }