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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "0.51.2-beta.17",
+  "version": "0.51.2-beta.19",
   "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";
@@ -16,5 +16,6 @@ export type { Workflow, WorkflowKind, OnCreatedWorkflowCallback, OnUpdatedWorkfl
 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/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/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;