@caido/sdk-frontend 0.52.0 → 0.52.1-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "v0.52.0",
+  "version": "0.52.1-beta.0",
   "description": "Typing for the Caido Frontend SDK",
   "author": "Caido Labs Inc. <dev@caido.io>",
   "license": "MIT",

package/src/types/index.d.ts

@@ -2,7 +2,7 @@ export { FooterSlot, type FooterSlotContent } from "./types/footer";
 export type { DialogOptions } from "./types/window";
 export type { CommandContext, CommandContextRequest, CommandContextRequestRow, CommandContextResponse, CommandContextBase, } from "./types/commands";
 export type { MenuItem } from "./types/menu";
-export { type ReplayTab, type ReplaySession, type ReplayCollection, type SendRequestOptions, ReplaySlot, type ReplaySlotContent, type RequestSource, } from "./types/replay";
+export { type ReplayTab, type ReplaySession, type ReplayCollection, type SendRequestOptions, ReplaySlot, type ReplaySlotContent, type RequestSource, type CurrentReplaySessionChangeEvent, } from "./types/replay";
 export type { HostedFile } from "./types/files";
 export type { Filter } from "./types/filter";
 export type { HTTPQL, ID, ComponentDefinition } from "./types/utils";
@@ -15,4 +15,7 @@ export type { EnvironmentVariable } from "./types/environment";
 export type { Workflow, WorkflowKind, OnCreatedWorkflowCallback, OnUpdatedWorkflowCallback, OnDeletedWorkflowCallback, } from "./types/workflows";
 export type { ListenerHandle } from "./types/utils";
 export type { AIProvider } from "./types/ai";
+export type { SelectedProjectChangeEvent } from "./types/projects";
+export type { CommandPaletteView } from "./sdks/commandPalette";
 export type { API } from "./sdks";
+export { Routes } from "./types/navigation";

package/src/types/sdks/commandPalette.d.ts

@@ -1,4 +1,13 @@
 import { type CommandID } from "../types/commands";
+import { type ComponentDefinition } from "../types/utils";
+/**
+ * Command palette view definition for custom UI content.
+ * @category Command Palette
+ */
+export type CommandPaletteView = {
+    type: "Custom";
+    definition: ComponentDefinition;
+};
 /**
  * Utilities to interact with the command palette.
  * @category Command Palette
@@ -9,4 +18,9 @@ export type CommandPaletteSDK = {
      * @param commandId The id of the command to register.
      */
     register: (commandId: CommandID) => void;
+    /**
+     * Push a new view onto the command palette view stack.
+     * @param view The view to push onto the stack.
+     */
+    pushView: (view: CommandPaletteView) => void;
 };

package/src/types/sdks/index.d.ts

@@ -16,6 +16,7 @@ import type { InterceptSDK } from "./intercept";
 import type { MatchReplaceSDK } from "./matchReplace";
 import type { MenuSDK } from "./menu";
 import type { NavigationSDK } from "./navigation";
+import type { ProjectsSDK } from "./projects";
 import type { ReplaySDK } from "./replay";
 import type { RuntimeSDK } from "./runtime";
 import type { ScopesSDK } from "./scopes";
@@ -68,6 +69,10 @@ export type API<T extends BackendEndpoints = Record<string, never>, E extends Ba
      * Utilities to interact with navigation.
      */
     navigation: NavigationSDK;
+    /**
+     * Utilities to interact with projects.
+     */
+    projects: ProjectsSDK;
     /**
      * Utilities to interact with the active page.
      */

package/src/types/sdks/navigation.d.ts

@@ -1,18 +1,24 @@
+import { type PageChangeEvent, type Routes } from "../types/navigation";
+import { type ListenerHandle } from "../types/utils";
 /**
  * Utilities to interact with navigation.
  * @category Navigation
  */
 export type NavigationSDK = {
     /**
-     * Navigate to a path.
-     * @param path The path to navigate to.
+     * Navigate to a route or path.
+     * @param route The route to navigate to. Can be a route ID object or a custom path string.
      *
      * @example
      * ```ts
+     * sdk.navigation.goTo({ id: Routes.Replay });
+     * sdk.navigation.goTo({ id: Routes.Projects });
      * sdk.navigation.goTo("/my-plugin-page");
      * ```
      */
-    goTo: (path: string) => void;
+    goTo: (route: string | {
+        id: Routes;
+    }) => void;
     /**
      * Add a page to the navigation.
      * @param path The path of the page.
@@ -26,4 +32,21 @@ export type NavigationSDK = {
         topbar?: HTMLElement;
         onEnter?: () => void;
     }) => void;
+    /**
+     * Subscribe to page changes.
+     * @param callback The callback to call when the page changes.
+     * @returns An object with a `stop` method that can be called to stop listening to page changes.
+     *
+     * @example
+     * ```ts
+     * const handler = sdk.navigation.onPageChange((event) => {
+     *   console.log('Page changed to:', event.routeId);
+     *   console.log('- path:', event.path);
+     * });
+     *
+     * // Later, stop listening
+     * handler.stop();
+     * ```
+     */
+    onPageChange: (callback: (route: PageChangeEvent) => void) => ListenerHandle;
 };

package/src/types/sdks/projects.d.ts

@@ -0,0 +1,24 @@
+import { type SelectedProjectChangeEvent } from "../types/projects";
+import { type ListenerHandle } from "../types/utils";
+/**
+ * Utilities to interact with projects.
+ * @category Projects
+ */
+export type ProjectsSDK = {
+    /**
+     * Subscribe to selected project changes.
+     * @param callback The callback to call when the selected project changes.
+     * @returns An object with a `stop` method that can be called to stop listening to project changes.
+     *
+     * @example
+     * ```ts
+     * const handler = sdk.projects.onCurrentProjectChange((event) => {
+     *   console.log('Selected project changed to:', event.projectId);
+     * });
+     *
+     * // Later, stop listening
+     * handler.stop();
+     * ```
+     */
+    onCurrentProjectChange: (callback: (event: SelectedProjectChangeEvent) => void) => ListenerHandle;
+};

package/src/types/sdks/replay.d.ts

@@ -1,8 +1,8 @@
 import { type Extension } from "@codemirror/state";
-import { type OpenTabOptions, type ReplayCollection, type ReplaySession, type ReplaySlotContent, type ReplayTab, type RequestSource, type SendRequestOptions } from "../types/replay";
+import { type CurrentReplaySessionChangeEvent, type OpenTabOptions, type ReplayCollection, type ReplaySession, type ReplaySlotContent, type ReplayTab, type RequestSource, type SendRequestOptions } from "../types/replay";
 import type { RequestViewModeOptions } from "../types/request";
 import { type DefineAddToSlotFn } from "../types/slots";
-import type { ID } from "../types/utils";
+import type { ID, ListenerHandle } from "../types/utils";
 /**
  * Utilities to interact with Replay.
  * @category Replay
@@ -134,4 +134,20 @@ export type ReplaySDK = {
      * ```
      */
     sendRequest: (sessionId: ID, options: SendRequestOptions) => Promise<void>;
+    /**
+     * Subscribe to current replay session changes.
+     * @param callback The callback to call when the selected session changes.
+     * @returns An object with a `stop` method that can be called to stop listening to session changes.
+     *
+     * @example
+     * ```ts
+     * const handler = sdk.replay.onCurrentSessionChange((event) => {
+     *   console.log(`Session ${event.sessionId} got selected!`);
+     * });
+     *
+     * // Later, stop listening
+     * handler.stop();
+     * ```
+     */
+    onCurrentSessionChange: (callback: (event: CurrentReplaySessionChangeEvent) => void) => ListenerHandle;
 };

package/src/types/types/navigation.d.ts

@@ -0,0 +1,33 @@
+export declare const Routes: {
+    readonly Sitemap: "Sitemap";
+    readonly Intercept: "Intercept";
+    readonly Search: "Search";
+    readonly HTTPHistory: "HTTPHistory";
+    readonly Websockets: "Websockets";
+    readonly Workflows: "Workflows";
+    readonly Replay: "Replay";
+    readonly Automate: "Automate";
+    readonly Projects: "Projects";
+    readonly Backups: "Backups";
+    readonly MatchReplace: "Tamper";
+    readonly Assistant: "Assistant";
+    readonly Environment: "Environment";
+    readonly Scope: "Scope";
+    readonly Filter: "Filter";
+    readonly Exports: "Exports";
+    readonly Findings: "Findings";
+    readonly Files: "Files";
+    readonly Plugins: "Plugins";
+    readonly Certificate: "Certificate";
+    readonly About: "About";
+    readonly Settings: "Settings";
+};
+export type Routes = (typeof Routes)[keyof typeof Routes];
+export type PageChangeEvent = {
+    type: "Core";
+    routeId: Routes;
+    path: string;
+} | {
+    type: "Plugin";
+    path: string;
+};

package/src/types/types/projects.d.ts

@@ -0,0 +1,8 @@
+import { type ID } from "./utils";
+/**
+ * Event fired when the selected project changes.
+ * @category Projects
+ */
+export type SelectedProjectChangeEvent = {
+    projectId: ID | undefined;
+};

package/src/types/types/replay.d.ts

@@ -166,3 +166,13 @@ export type RequestSource = {
     type: "ID";
     id: string;
 };
+/**
+ * Event fired when the current replay session changes.
+ * @category Replay
+ */
+export type CurrentReplaySessionChangeEvent = {
+    /**
+     * The ID of the newly selected session, or undefined if no session is selected.
+     */
+    sessionId: ID | undefined;
+};

package/src/types/types/slots.d.ts

@@ -1,8 +1,8 @@
 import { type CommandID } from "./commands";
-import { type ComponentDefinition } from "./utils";
-type DefineSlotContent<TType extends string, P extends Record<string, unknown>> = {
+import { type ComponentDefinition, type Prettify } from "./utils";
+type DefineSlotContent<TType extends string, P extends Record<string, unknown>> = Prettify<{
     type: TType;
-} & P;
+} & P>;
 export type ButtonSlotContent = DefineSlotContent<"Button", {
     label: string;
     icon?: string;