@caido/sdk-frontend 0.34.1 → 0.36.0

package/src/types/commands.d.ts

@@ -1,28 +1,25 @@
 export type Commands = {
-  register: (id: string, options: CommandOptions) => void;
+    register: (id: string, options: CommandOptions) => void;
 };
-
 type CommandOptions = {
-  name: string;
-  run: (context: CommandContext) => void;
-  group?: string;
-  when?: (context: CommandContext) => boolean;
+    name: string;
+    run: (context: CommandContext) => void;
+    group?: string;
+    when?: (context: CommandContext) => boolean;
 };
-
 type CommandContextBase = {
-  type: "BaseContext";
+    type: "BaseContext";
 };
-
 type CommandContextRequestRow = {
-  type: "RequestRowContext";
-  request: {
-    id: string;
-    host: string;
-    port: number;
-    path: string;
-    query: string;
-    isTls: boolean;
-  };
+    type: "RequestRowContext";
+    requests: {
+        id: string;
+        host: string;
+        port: number;
+        path: string;
+        query: string;
+        isTls: boolean;
+    }[];
 };
-
 export type CommandContext = CommandContextBase | CommandContextRequestRow;
+export {};

package/src/types/index.d.ts

@@ -1,49 +1,34 @@
+import type { Sdk } from "./__generated__/graphql-sdk";
 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";
-
 export type API = {
-  ui: UI;
-  scopes: Scopes;
-  commands: Commands;
-  menu: Menu;
-
-  navigation: {
-    goTo: (path: string) => void;
-    addPage: (path: string, options: PageOptions) => void;
-  };
-
-  shortcuts: {
-    register: (commandId: string, keys: string[]) => void;
-  };
-
-  commandPalette: {
-    register: (commandId: string) => void;
-  };
-
-  sidebar: {
-    registerItem: (
-      name: string,
-      path: string,
-      options?: SidebarItemOptions,
-    ) => SidebarItem;
-  };
+    ui: UI;
+    scopes: Scopes;
+    commands: Commands;
+    menu: Menu;
+    navigation: Navigation;
+    window: Window;
+    shortcuts: {
+        register: (commandId: string, keys: string[]) => void;
+    };
+    commandPalette: {
+        register: (commandId: string) => void;
+    };
+    sidebar: {
+        registerItem: (name: string, path: string, options?: SidebarItemOptions) => SidebarItem;
+    };
+    graphql: Sdk;
 };
-
-type PageOptions = {
-  body: HTMLElement;
-  topbar?: HTMLElement;
-};
-
 type SidebarItemOptions = {
-  icon?: string;
-  group?: string;
-  isExternal?: boolean;
+    icon?: string;
+    group?: string;
+    isExternal?: boolean;
 };
-
 type SidebarItem = {
-  setCount: (count: number) => void;
+    setCount: (count: number) => void;
 };

package/src/types/menu.d.ts

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

package/src/types/navigation.d.ts

@@ -0,0 +1,9 @@
+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/scopes.d.ts

@@ -1,28 +1,23 @@
 export type Scopes = {
-  getScopes: () => Scope[];
-  createScope: (options: CreateScopeOptions) => Promise<Scope | undefined>;
-  updateScope: (
-    id: string,
-    options: UpdateScopeOptions,
-  ) => Promise<Scope | undefined>;
-  deleteScope: (id: string) => Promise<boolean>;
+    getScopes: () => Scope[];
+    createScope: (options: CreateScopeOptions) => Promise<Scope | undefined>;
+    updateScope: (id: string, options: UpdateScopeOptions) => Promise<Scope | undefined>;
+    deleteScope: (id: string) => Promise<boolean>;
 };
-
 type Scope = {
-  id: string;
-  name: string;
-  allowlist: string[];
-  denylist: string[];
+    id: string;
+    name: string;
+    allowlist: string[];
+    denylist: string[];
 };
-
 type CreateScopeOptions = {
-  name: string;
-  allowlist: string[];
-  denylist: string[];
+    name: string;
+    allowlist: string[];
+    denylist: string[];
 };
-
 type UpdateScopeOptions = {
-  name?: string;
-  allowlist?: string[];
-  denylist?: string[];
+    name?: string;
+    allowlist?: string[];
+    denylist?: string[];
 };
+export {};

package/src/types/ui.d.ts

@@ -1,25 +1,23 @@
 export type UI = {
-  button: (options?: ButtonOptions) => HTMLElement;
-  card: (options?: CardOptions) => HTMLElement;
-  well: (options?: WellOptions) => HTMLElement;
+    button: (options?: ButtonOptions) => HTMLElement;
+    card: (options?: CardOptions) => HTMLElement;
+    well: (options?: WellOptions) => HTMLElement;
 };
-
 type ButtonOptions = {
-  variant?: "primary" | "secondary" | "tertiary";
-  label?: string;
-  leadingIcon?: string;
-  trailingIcon?: string;
-  size?: "small" | "medium" | "large";
+    variant?: "primary" | "secondary" | "tertiary";
+    label?: string;
+    leadingIcon?: string;
+    trailingIcon?: string;
+    size?: "small" | "medium" | "large";
 };
-
 type CardOptions = {
-  header?: HTMLElement;
-  body?: HTMLElement;
-  footer?: HTMLElement;
+    header?: HTMLElement;
+    body?: HTMLElement;
+    footer?: HTMLElement;
 };
-
 type WellOptions = {
-  header?: HTMLElement;
-  body?: HTMLElement;
-  footer?: HTMLElement;
+    header?: HTMLElement;
+    body?: HTMLElement;
+    footer?: HTMLElement;
 };
+export {};

package/src/types/window.d.ts

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