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

package/package.json

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

package/src/types/index.d.ts

@@ -15,5 +15,6 @@ 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 { API } from "./sdks";
 export { Routes } from "./types/navigation";

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