@caido/sdk-frontend 0.37.0 → 0.39.0

package/src/types/backend.d.ts

@@ -0,0 +1,4 @@
+export type BackendAPI = Record<string, (...args: any[]) => any>;
+export type ToBackendRPC<T extends BackendAPI> = {
+    [K in keyof T]: (...args: Parameters<T[K]>) => ReturnType<T[K]> extends Promise<infer U> ? Promise<U> : Promise<ReturnType<T[K]>>;
+};

package/src/types/commands.d.ts

@@ -21,5 +21,35 @@ type CommandContextRequestRow = {
         isTls: boolean;
     }[];
 };
-export type CommandContext = CommandContextBase | CommandContextRequestRow;
+type CommandContextRequest = {
+    type: "RequestContext";
+    request: {
+        host: string;
+        port: number;
+        path: string;
+        query: string;
+        isTls: boolean;
+        raw: string;
+    };
+    selection: string;
+};
+type CommandContextResponse = {
+    type: "ResponseContext";
+    request: {
+        id: string;
+        host: string;
+        port: number;
+        path: string;
+        query: string;
+        isTls: boolean;
+    };
+    response: {
+        id: string;
+        raw: string;
+        statusCode: number;
+        roundtripTime: number;
+    };
+    selection: string;
+};
+export type CommandContext = CommandContextBase | CommandContextRequestRow | CommandContextRequest | CommandContextResponse;
 export {};

package/src/types/findings.d.ts

@@ -0,0 +1,18 @@
+export type Findings = {
+    createFinding: (requestId: string, options: CreateFindingsOptions) => Promise<Finding | undefined>;
+};
+type Finding = {
+    id: string;
+    title: string;
+    description?: string;
+    reporter: string;
+    host: string;
+    path: string;
+};
+type CreateFindingsOptions = {
+    title: string;
+    description?: string;
+    reporter: string;
+    dedupeKey?: string;
+};
+export {};

package/src/types/index.d.ts

@@ -1,5 +1,7 @@
 import type { Sdk } from "./__generated__/graphql-sdk";
+import type { BackendAPI, ToBackendRPC } from "./backend";
 import type { Commands } from "./commands";
+import type { Findings } from "./findings";
 import type { Menu } from "./menu";
 import type { Navigation } from "./navigation";
 import type { Scopes } from "./scopes";
@@ -7,9 +9,11 @@ import type { Storage } from "./storage";
 import type { UI } from "./ui";
 import type { Window } from "./window";
 export type { CommandContext } from "./commands";
-export type API = {
+export type API<T extends BackendAPI = Record<string, never>> = {
     ui: UI;
+    backend: ToBackendRPC<T>;
     scopes: Scopes;
+    findings: Findings;
     commands: Commands;
     menu: Menu;
     navigation: Navigation;

package/src/types/menu.d.ts

@@ -1,12 +1,22 @@
 export type Menu = {
     registerItem: (item: MenuItem) => void;
 };
-type MenuItem = RequestRowMenuItem | SettingsMenuItem;
+type MenuItem = RequestRowMenuItem | SettingsMenuItem | RequestMenuItem | ResponseMenuItem;
 type RequestRowMenuItem = {
     type: "RequestRow";
     commandId: string;
     leadingIcon?: string;
 };
+type RequestMenuItem = {
+    type: "Request";
+    commandId: string;
+    leadingIcon?: string;
+};
+type ResponseMenuItem = {
+    type: "Response";
+    commandId: string;
+    leadingIcon?: string;
+};
 type SettingsMenuItem = {
     type: "Settings";
     label: string;

package/src/types/storage.d.ts

@@ -1,14 +1,6 @@
-type JSONPrimitive = string | number | boolean | null | undefined;
-type JSONValue = JSONPrimitive | JSONValue[] | {
-    [key: string]: JSONValue;
-};
-type NotAssignableToJson = bigint | symbol | Function;
-type JSONCompatible<T> = unknown extends T ? never : {
-    [P in keyof T]: T[P] extends JSONValue ? T[P] : T[P] extends NotAssignableToJson ? never : JSONCompatible<T[P]>;
-};
+import type { JSONCompatible, JSONValue } from "./utils";
 export type Storage = {
     get: () => JSONValue;
     set: <T>(value: JSONCompatible<T>) => Promise<void>;
     onChange: (callback: (value: JSONValue) => void) => void;
 };
-export {};

package/src/types/utils.d.ts

@@ -0,0 +1,9 @@
+type JSONPrimitive = string | number | boolean | null | undefined;
+export type JSONValue = JSONPrimitive | JSONValue[] | {
+    [key: string]: JSONValue;
+};
+type NotAssignableToJson = bigint | symbol | Function;
+export type JSONCompatible<T> = unknown extends T ? never : {
+    [P in keyof T]: T[P] extends JSONValue ? T[P] : T[P] extends NotAssignableToJson ? never : JSONCompatible<T[P]>;
+};
+export {};

package/src/types/window.d.ts

@@ -1,5 +1,10 @@
 export type Window = {
     getActiveEditor: () => Editor | undefined;
+    showToast: (message: string, options?: ToastOptions) => void;
+};
+type ToastOptions = {
+    variant?: "success" | "error" | "warning" | "info";
+    duration?: number;
 };
 type Editor = {
     getSelectedText: () => string;