@caido/sdk-frontend 0.34.1 → 0.35.0

package/src/types/commands.d.ts

@@ -15,14 +15,14 @@ type CommandContextBase = {
 
 type CommandContextRequestRow = {
   type: "RequestRowContext";
-  request: {
+  requests: {
     id: string;
     host: string;
     port: number;
     path: string;
     query: string;
     isTls: boolean;
-  };
+  }[];
 };
 
 export type CommandContext = CommandContextBase | CommandContextRequestRow;

package/src/types/index.d.ts

@@ -1,7 +1,10 @@
+import type { Sdk } from "./__generated__/graphql";
 import type { Commands } from "./commands";
 import type { Menu } from "./menu";
+import type { Navigation } from "./navigation";
 import type { Scopes } from "./scopes";
 import type { UI } from "./ui";
+import type { Window } from "./window";
 
 export type { CommandContext } from "./commands";
 
@@ -10,11 +13,8 @@ export type API = {
   scopes: Scopes;
   commands: Commands;
   menu: Menu;
-
-  navigation: {
-    goTo: (path: string) => void;
-    addPage: (path: string, options: PageOptions) => void;
-  };
+  navigation: Navigation;
+  window: Window;
 
   shortcuts: {
     register: (commandId: string, keys: string[]) => void;
@@ -31,11 +31,8 @@ export type API = {
       options?: SidebarItemOptions,
     ) => SidebarItem;
   };
-};
 
-type PageOptions = {
-  body: HTMLElement;
-  topbar?: HTMLElement;
+  graphql: Sdk;
 };
 
 type SidebarItemOptions = {

package/src/types/menu.d.ts

@@ -1,13 +1,18 @@
-type MenuId = "RequestRow";
-
 export type Menu = {
-  registerItem: (
-    menuId: MenuId,
-    commandId: string,
-    options?: MenuOptions,
-  ) => void;
+  registerItem: (item: MenuItem) => void;
+};
+
+type MenuItem = RequestRowMenuItem | SettingsMenuItem;
+
+type RequestRowMenuItem = {
+  type: "RequestRow";
+  commandId: string;
+  leadingIcon?: string;
 };
 
-type MenuOptions = {
+type SettingsMenuItem = {
+  type: "Settings";
+  label: string;
+  path: string;
   leadingIcon?: string;
 };

package/src/types/navigation.d.ts

@@ -0,0 +1,16 @@
+import type { Commands } from "./commands";
+import type { Menu } from "./menu";
+import type { Scopes } from "./scopes";
+import type { UI } from "./ui";
+
+export type { CommandContext } from "./commands";
+
+export type Navigation = {
+  goTo: (path: string) => void;
+  addPage: (path: string, options: PageOptions) => void;
+};
+
+type PageOptions = {
+  body: HTMLElement;
+  topbar?: HTMLElement;
+};

package/src/types/window.d.ts

@@ -0,0 +1,9 @@
+export type Window = {
+  getActiveEditor: () => Editor | undefined;
+};
+
+type Editor = {
+  getSelectedText: () => string;
+  replaceSelectedText: (text: string) => void;
+  isReadOnly: () => boolean;
+};