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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "0.51.2-beta.15",
+  "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/sdks/navigation.d.ts

@@ -1,4 +1,5 @@
-import { type Routes } from "../types/navigation";
+import { type PageChangeEvent, type Routes } from "../types/navigation";
+import { type ListenerHandle } from "../types/utils";
 /**
  * Utilities to interact with navigation.
  * @category Navigation
@@ -31,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

@@ -23,3 +23,11 @@ export declare const Routes: {
     readonly Settings: "Settings";
 };
 export type Routes = (typeof Routes)[keyof typeof Routes];
+export type PageChangeEvent = {
+    type: "Core";
+    routeId: Routes;
+    path: string;
+} | {
+    type: "Plugin";
+    path: string;
+};