add clipboard apis

Author: azmy60

.github/workflows/publish.yml

@@ -33,7 +33,25 @@ jobs:
       - name: Build packages
         run: yarn build
 
-      - name: Publish package
+      - name: Check if beta version
+        id: check_beta
+        run: |
+          if [[ "$VERSION" == *"beta"* ]]; then
+            echo "IS_BETA=true" >> $GITHUB_ENV
+            echo "Publishing as beta version"
+          else
+            echo "IS_BETA=false" >> $GITHUB_ENV
+            echo "Publishing as stable version"
+          fi
+
+      - name: Publish package (beta)
+        if: env.IS_BETA == 'true'
+        run: yarn publish --access public --non-interactive --tag beta
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Publish package (stable)
+        if: env.IS_BETA == 'false'
         run: yarn publish --access public --non-interactive
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package.json

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

@@ -115,6 +115,26 @@ export async function setEncryptedData<T>(keyOrValue: string | T, value?: T): Pr
   }
 }
 
+/** Clipboard interface. */
+export const clipboard = {
+  /** Write text to the Electron clipboard. */
+  async writeText(text: string): Promise<void> {
+    await request({
+      name: "clipboard.writeText",
+      args: { text },
+    });
+  },
+  /** Read text from the Electron clipboard. */
+  async readText(): Promise<string> {
+    return await request({
+      name: "clipboard.readText",
+      args: void 0,
+    });
+  },
+  // async write() {},
+  // async read() {},
+};
+
 export * from "./commonTypes";
 export * from "./requestTypes";
 export * from "./responseTypes";

src/notificationTypes.ts

@@ -18,6 +18,16 @@ export interface WindowEventNotification {
   };
 }
 
+export interface PluginErrorNotification {
+  name: "pluginError";
+  args: {
+    name?: string;
+    message?: string;
+    stack?: string;
+  };
+}
+
 export type PluginNotificationData =
   | ThemeChangedNotification
-  | WindowEventNotification;
+  | WindowEventNotification
+  | PluginErrorNotification;

src/requestTypes.ts

@@ -99,6 +99,18 @@ export interface SetEncryptedDataRequest<T extends unknown> extends BaseRequest
   };
 }
 
+export interface ClipboardWriteTextRequest extends BaseRequest {
+  name: "clipboard.writeText";
+  args: {
+    text: string;
+  };
+}
+
+export interface ClipboardReadTextRequest extends BaseRequest {
+  name: "clipboard.readText";
+  args: void;
+}
+
 export type PluginRequestData =
   | GetTablesRequest
   | GetColumnsRequest
@@ -113,6 +125,8 @@ export type PluginRequestData =
   | GetDataRequest
   | SetDataRequest<unknown>
   | GetEncryptedDataRequest
-  | SetEncryptedDataRequest<unknown>;
+  | SetEncryptedDataRequest<unknown>
+  | ClipboardWriteTextRequest
+  | ClipboardReadTextRequest;
 
 export type PluginRequestPayload = PluginRequestData;

src/responseTypes.ts

@@ -79,6 +79,14 @@ export interface SetEncryptedDataResponse extends BaseResponse {
   result: void;
 }
 
+export interface ClipboardWriteTextResponse extends BaseResponse {
+  result: void;
+}
+
+export interface ClipboardReadTextResponse extends BaseResponse {
+  result: string;
+}
+
 export type PluginResponseData =
   | GetTablesResponse
   | GetColumnsResponse
@@ -93,7 +101,9 @@ export type PluginResponseData =
   | GetDataResponse<unknown>
   | SetDataResponse
   | GetEncryptedDataResponse<unknown>
-  | SetEncryptedDataResponse;
+  | SetEncryptedDataResponse
+  | ClipboardWriteTextResponse
+  | ClipboardReadTextResponse;
 
 export type PluginResponsePayload = PluginResponseData;