@caido/sdk-frontend 0.56.3-beta.2 → 0.57.1-beta.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "0.56.3-beta.2",
+  "version": "0.57.1-beta.3",
   "description": "Typing for the Caido Frontend SDK",
   "author": "Caido Labs Inc. <dev@caido.io>",
   "repository": "https://github.com/caido/sdk-js/",
@@ -13,8 +13,8 @@
   ],
   "peerDependencies": {
     "@ai-sdk/provider": "^3.0.1",
-    "@codemirror/view": "^6.0.0",
     "@codemirror/state": "^6.0.0",
+    "@codemirror/view": "^6.0.0",
     "vue": "^3.0.0"
   },
   "peerDependenciesMeta": {},

package/src/types/index.d.ts

@@ -4,7 +4,7 @@ export type { _AnalyticsSDK } from "./private/analytics";
 export type { MessageViewModeOptions, StreamWsMessageMeta, MessageViewModePropsInternal, MessageViewModeProps, } from "./types/websocket";
 export type { CommandContext, CommandContextRequest, CommandContextRequestRow, CommandContextResponse, CommandContextBase, } from "./types/commands";
 export type { MenuItem } from "./types/menu";
-export { type AddSessionIndicatorOptions, type ReplayTab, type ReplaySession, type ReplayEntry, type ReplayCollection, type SendRequestOptions, ReplaySlot, type ReplaySlotContent, type RequestSource, type CurrentReplaySessionChangeEvent, } from "./types/replay";
+export { type AddCollectionIndicatorOptions, type AddSessionIndicatorOptions, type ReplayTab, type ReplaySession, type ReplayEntry, type ReplayCollection, type SendRequestOptions, ReplaySlot, type ReplaySlotContent, type RequestSource, type CurrentReplaySessionChangeEvent, } from "./types/replay";
 export type { AutomateSession, AutomateEntry } from "./types/automate";
 export type { SitemapEntry, SitemapRootEntry, ChildState, } from "./types/sitemap";
 export { SearchSlot, type SearchSlotContent } from "./types/search";

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

@@ -1,5 +1,5 @@
-import { type ListenerHandle } from "src/types/utils";
 import { type HostedFile } from "../types/files";
+import { type ListenerHandle } from "../types/utils";
 /**
  * SDK for interacting with the Files page.
  * @category Files

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

@@ -1,5 +1,5 @@
 import { type Extension } from "@codemirror/state";
-import { type AddSessionIndicatorOptions, type CurrentReplaySessionChangeEvent, type OpenTabOptions, type ReplayCollection, type ReplayCollectionCreatedEvent, type ReplayEntry, type ReplaySession, type ReplaySessionCreatedEvent, type ReplaySlotContent, type ReplayTab, type RequestSource, type SendRequestOptions } from "../types/replay";
+import { type AddCollectionIndicatorOptions, type AddSessionIndicatorOptions, type CurrentReplaySessionChangeEvent, type OpenTabOptions, type ReplayCollection, type ReplayCollectionCreatedEvent, type ReplayEntry, type ReplaySession, type ReplaySessionCreatedEvent, type ReplaySlotContent, type ReplayTab, type RequestSource, type SendRequestOptions } from "../types/replay";
 import type { RequestViewModeOptions, RequestWritableViewModeProps } from "../types/request";
 import type { ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import { type DefineAddToSlotFn } from "../types/slots";
@@ -44,6 +44,20 @@ export type ReplaySDK = {
      * ```
      */
     getCurrentSession: () => ReplaySession | undefined;
+    /**
+     * Get the entry currently displayed in the active replay session.
+     * @returns The active entry, or undefined if no entry is currently loaded.
+     * @example
+     * ```ts
+     * const currentEntry = sdk.replay.getCurrentEntry();
+     * if (currentEntry) {
+     *   console.log(`Currently viewing entry ${currentEntry.id}`);
+     * } else {
+     *   console.log("No entry is currently displayed");
+     * }
+     * ```
+     */
+    getCurrentEntry: () => ReplayEntry | undefined;
     /**
      * Rename a session.
      * @param id The ID of the session to rename.
@@ -243,4 +257,22 @@ export type ReplaySDK = {
      *
      */
     addSessionIndicator: (sessionId: ID, indicator: AddSessionIndicatorOptions) => Indicator;
+    /**
+     * Add an indicator to a replay collection.
+     * Indicators are displayed next to the collection name in the collections tree.
+     * @param collectionId The ID of the collection to add the indicator to.
+     * @param indicator The indicator configuration.
+     * @returns A handle object with a `remove` method to remove the indicator.
+     * @example
+     *
+     * const indicator = sdk.replay.addCollectionIndicator(collectionId, {
+     *   icon: "fas fa-folder-open",
+     *   description: "Has unresolved findings",
+     * });
+     *
+     * // Later, remove the indicator
+     * indicator.remove();
+     *
+     */
+    addCollectionIndicator: (collectionId: ID, indicator: AddCollectionIndicatorOptions) => Indicator;
 };

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

@@ -219,6 +219,11 @@ export type AddSessionIndicatorOptions = AddIndicatorOptions & {
      */
     showTabIcon?: boolean;
 };
+/**
+ * Options for adding an indicator to a replay collection.
+ * @category Replay
+ */
+export type AddCollectionIndicatorOptions = AddIndicatorOptions;
 /**
  * A unique replay session identifier.
  * @category Replay