@caido/sdk-frontend 0.49.1-beta.4 → 0.49.1-beta.6

package/package.json

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

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

@@ -1,5 +1,5 @@
 import { type Extension } from "@codemirror/state";
-import { type ReplayCollection, type ReplaySession, type ReplaySlotContent, type ReplayTab } from "../types/replay";
+import { type OpenTabOptions, type ReplayCollection, type ReplaySession, type ReplaySlotContent, type ReplayTab } from "../types/replay";
 import { type DefineAddToSlotFn } from "../types/slots";
 import type { ID } from "../types/utils";
 /**
@@ -10,8 +10,9 @@ export type ReplaySDK = {
     /**
      * Open a replay tab for the given session.
      * @param sessionId The ID of the session to open.
+     * @param options The options for opening the tab.
      */
-    openTab: (sessionId: ID) => void;
+    openTab: (sessionId: ID, options?: OpenTabOptions) => void;
     /**
      * Close a replay tab for the given session.
      * @param sessionId The ID of the session to close.

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

@@ -1,6 +1,6 @@
 import type { Editor } from "../types/editor";
 import type { ComponentDefinition } from "../types/utils";
-import { type DialogOptions } from "../types/window";
+import { type Dialog, type DialogOptions } from "../types/window";
 /**
  * Utilities to interact with the active page.
  * @category Window
@@ -32,6 +32,7 @@ export type WindowSDK = {
      * @param options.modal Whether the dialog is modal. Defaults to true
      * @param options.position The position of the dialog on the screen. Defaults to center
      * @param options.closable Whether the close icon is hidden . Defaults to false
+     * @returns A dialog object that can be used to close the dialog.
      */
-    showDialog: (component: ComponentDefinition, options?: DialogOptions) => void;
+    showDialog: (component: ComponentDefinition, options?: DialogOptions) => Dialog;
 };

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

@@ -11,6 +11,17 @@ export type ReplaySlotContent = {
     [ReplaySlot.SessionToolbarSecondary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
     [ReplaySlot.Topbar]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
 };
+/**
+ * Options for opening a tab.
+ * @category Replay
+ */
+export type OpenTabOptions = {
+    /**
+     * Whether to select the tab after opening it.
+     * Defaults to true.
+     */
+    select?: boolean;
+};
 /**
  * A replay tab.
  * @category Replay

package/src/types/types/window.d.ts

@@ -6,3 +6,6 @@ export type DialogOptions = {
     modal?: boolean;
     position?: "left" | "right" | "top" | "bottom" | "center" | "topleft" | "topright" | "bottomleft" | "bottomright";
 };
+export type Dialog = {
+    close: () => void;
+};