add getViewContext, remove viewLoaded notification

Author: azmy60

package.json

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

@@ -35,12 +35,29 @@ export type WindowEventInits =
 
 export type TableFilter = {
   field: string;
-  type: "=" | "!=" | "like" | "not like" | "<" | "<=" | ">" | ">=" | "in" | "is" | "is not";
+  type:
+    | "="
+    | "!="
+    | "like"
+    | "not like"
+    | "<"
+    | "<="
+    | ">"
+    | ">="
+    | "in"
+    | "is"
+    | "is not";
   value?: string | string[];
-  op?: 'AND' | 'OR';
-}
+  op?: "AND" | "OR";
+};
 
-export type JsonValue = string | number | boolean | null | JsonValue[] | { [key: string]: JsonValue };
+export type JsonValue =
+  | string
+  | number
+  | boolean
+  | null
+  | JsonValue[]
+  | { [key: string]: JsonValue };
 
 export type ActiveRange = {
   rows: number[];
@@ -93,4 +110,13 @@ export type CornerMenuParams = {
   activeRange: ActiveRange;
 };
 
-export type LoadViewParams = CornerMenuParams | RowMenuParams | ColumnMenuParams | CellMenuParams;
+export type LoadViewParams =
+  | CornerMenuParams
+  | RowMenuParams
+  | ColumnMenuParams
+  | CellMenuParams;
+
+export type PluginViewContext = {
+  command: string;
+  params?: CellMenuParams | ColumnMenuParams | RowMenuParams | CornerMenuParams;
+};

src/comms.ts

@@ -3,7 +3,6 @@ import {
   BroadcastNotification,
   PluginErrorNotification,
   ThemeChangedNotification,
-  ViewLoadedNotification,
   WindowEventNotification,
 } from "./notificationTypes";
 import type { PluginRequestPayload } from "./requestTypes";
@@ -123,10 +122,6 @@ export function addNotificationListener<Message extends JsonValue = JsonValue>(
   name: BroadcastNotification["name"],
   handler: (args: BroadcastNotification<Message>["args"]) => void,
 ): void;
-export function addNotificationListener(
-  name: ViewLoadedNotification["name"],
-  handler: (args: ViewLoadedNotification["args"]) => void,
-): void;
 export function addNotificationListener(
   name: ThemeChangedNotification["name"],
   handler: (args: ThemeChangedNotification["args"]) => void,

src/index.ts

@@ -33,6 +33,7 @@ import type {
   GetTableKeysResponse,
   GetAppInfoResponse,
   CheckForUpdateResponse,
+  GetViewContextResponse,
 } from "./responseTypes";
 
 /**
@@ -111,6 +112,20 @@ export async function setTabTitle(title: string): Promise<SetTabTitleResponse['r
   return await request({ name: "setTabTitle", args: { title } as SetTabTitleRequest['args'] });
 }
 
+/**
+ * Get the current view context.
+ *
+ * A view context describes how this plugin view was opened and what data is
+ * available for it. It always includes the static `command` from your
+ * `manifest.json`, and may also include dynamic `params` depending on where
+ * the menu was invoked.
+ *
+ * @since Beekeeper Studio 5.4.0
+ **/
+export async function getViewContext(): Promise<GetViewContextResponse['result']> {
+  return await request({ name: "getViewContext", args: void 0 });
+}
+
 /**
  * Get the current state of your view instance.
  *

src/notificationTypes.ts

@@ -3,10 +3,6 @@ import {
   WindowEventInits,
   WindowEventClass,
   JsonValue,
-  CellMenuParams,
-  CornerMenuParams,
-  RowMenuParams,
-  ColumnMenuParams,
 } from "./commonTypes";
 
 export type AppTheme = {
@@ -45,21 +41,8 @@ export type BroadcastNotification<Message extends JsonValue = JsonValue> = {
   };
 };
 
-export type ViewLoadedNotification = {
-  name: "viewLoaded";
-  args: {
-    command: string;
-    params?:
-      | CellMenuParams
-      | ColumnMenuParams
-      | RowMenuParams
-      | CornerMenuParams;
-  };
-};
-
 export type PluginNotificationData =
   | ThemeChangedNotification
   | WindowEventNotification
   | PluginErrorNotification
-  | ViewLoadedNotification
   | BroadcastNotification;

src/requestTypes.ts

@@ -58,6 +58,11 @@ export interface SetTabTitleRequest extends BaseRequest {
   };
 }
 
+export type GetViewContextRequest = BaseRequest & {
+  name: "getViewContext";
+  args: void;
+};
+
 export interface GetViewStateRequest extends BaseRequest {
   name: "getViewState";
   args: void;
@@ -167,6 +172,7 @@ export type PluginRequestData =
   | RunQueryRequest
   | ExpandTableResultRequest
   | SetTabTitleRequest
+  | GetViewContextRequest
   | GetViewStateRequest
   | SetViewStateRequest<unknown>
   | OpenExternalRequest

src/responseTypes.ts

@@ -1,4 +1,12 @@
-import { QueryResult, TableKey } from "./commonTypes";
+import {
+  QueryResult,
+  TableKey,
+  CellMenuParams,
+  CornerMenuParams,
+  RowMenuParams,
+  ColumnMenuParams,
+  PluginViewContext,
+} from "./commonTypes";
 import { AppTheme } from "./notificationTypes";
 
 type TabType = string;
@@ -45,7 +53,7 @@ export type GetAppInfoResponse = BaseResponse & {
     version: string;
     theme: AppTheme;
   };
-}
+};
 
 export interface RunQueryResponse extends BaseResponse {
   result: {
@@ -62,6 +70,10 @@ export interface SetTabTitleResponse extends BaseResponse {
   result: void;
 }
 
+export type GetViewContextResponse = BaseResponse & {
+  result: PluginViewContext;
+};
+
 export interface GetViewStateResponse<T extends unknown> extends BaseResponse {
   result: T;
 }
@@ -82,7 +94,8 @@ export interface SetDataResponse extends BaseResponse {
   result: void;
 }
 
-export interface GetEncryptedDataResponse<T extends unknown> extends BaseResponse {
+export interface GetEncryptedDataResponse<T extends unknown>
+  extends BaseResponse {
   result: T;
 }
 
@@ -114,6 +127,7 @@ export type PluginResponseData =
   | RunQueryResponse
   | ExpandTableResultResponse
   | SetTabTitleResponse
+  | GetViewContextResponse
   | GetViewStateResponse<unknown>
   | SetViewStateResponse
   | OpenExternalResponse