@caido/sdk-frontend 0.51.2-beta.14 → 0.51.2-beta.16

package/package.json

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

package/src/types/index.d.ts

@@ -16,3 +16,4 @@ export type { Workflow, WorkflowKind, OnCreatedWorkflowCallback, OnUpdatedWorkfl
 export type { ListenerHandle } from "./types/utils";
 export type { AIProvider } from "./types/ai";
 export type { API } from "./sdks";
+export { Routes } from "./types/navigation";

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/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;
+};