@caido/sdk-frontend 0.54.2-beta.9 → 0.55.0

package/src/types/index.d.ts

@@ -18,6 +18,7 @@ export type { CurrentMatchReplaceRuleChangeEvent, MatchReplaceRule, MatchReplace
 export { MatchReplaceSlot, type MatchReplaceSlotContent, } from "./types/matchReplace";
 export { ScopeSlot, type CurrentScopeChangeEvent, type Scope, type ScopeSlotContent, } from "./types/scopes";
 export { HTTPHistorySlot, type HTTPHistorySlotContent, } from "./types/httpHistory";
+export { SettingsSlot, type SettingsSlotContent, type SettingsPluginSlotContent, } from "./types/settings";
 export type { EnvironmentVariable } from "./types/environment";
 export type { Workflow, WorkflowKind, OnCreatedWorkflowCallback, OnUpdatedWorkflowCallback, OnDeletedWorkflowCallback, } from "./types/workflows";
 export type { ListenerHandle, AddIndicatorOptions, Indicator, } from "./types/utils";

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

@@ -23,6 +23,7 @@ import type { ReplaySDK } from "./replay";
 import type { RuntimeSDK } from "./runtime";
 import type { ScopesSDK } from "./scopes";
 import type { SearchSDK } from "./search";
+import type { SettingsSDK } from "./settings";
 import type { ShortcutsSDK } from "./shortcuts";
 import type { SidebarSDK } from "./sidebar";
 import type { SitemapSDK } from "./sitemap";
@@ -155,6 +156,10 @@ export type API<T extends BackendEndpoints = Record<string, never>, E extends Ba
      * Utilities for logging messages to the console.
      */
     log: LogSDK;
+    /**
+     * Utilities to interact with the settings page.
+     */
+    settings: SettingsSDK;
     /**
      * @private
      * Utilities to track analytics events.

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

@@ -1,4 +1,5 @@
 import type { RequestViewModeOptions } from "../types/request";
+import type { ResponseViewModeOptions } from "../types/response";
 import type { ID } from "../types/utils";
 /**
  * Utilities to interact with the Intercept page.
@@ -20,4 +21,9 @@ export type InterceptSDK = {
      * @param options The view mode options.
      */
     addRequestViewMode: (options: RequestViewModeOptions) => void;
+    /**
+     * Add a custom response view mode.
+     * @param options The view mode options.
+     */
+    addResponseViewMode: (options: ResponseViewModeOptions) => void;
 };

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

@@ -1,6 +1,7 @@
 import { type Extension } from "@codemirror/state";
 import { 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 } from "../types/request";
+import type { ResponseViewModeOptions } from "../types/response";
 import { type DefineAddToSlotFn } from "../types/slots";
 import type { AddIndicatorOptions, ID, Indicator, ListenerHandle } from "../types/utils";
 /**
@@ -129,6 +130,11 @@ export type ReplaySDK = {
      * @param options The view mode options.
      */
     addRequestViewMode: (options: RequestViewModeOptions) => void;
+    /**
+     * Add a custom response view mode.
+     * @param options The view mode options.
+     */
+    addResponseViewMode: (options: ResponseViewModeOptions) => void;
     /**
      * Send a request to the Replay backend.
      * @param request The request to send.

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

@@ -0,0 +1,22 @@
+import type { SettingsSlotContent } from "../types/settings";
+import type { DefineAddToSlotFn } from "../types/slots";
+/**
+ * Utilities to interact with the settings page.
+ * @category Settings
+ */
+export type SettingsSDK = {
+    /**
+     * Add a component to a slot.
+     * @param slot The slot to add the component to.
+     * @param content The content to add to the slot.
+     * @example
+     * ```ts
+     * sdk.settings.addToSlot(SettingsSlot.PluginsSection, {
+     *   type: "Custom",
+     *   name: "My Plugin Settings",
+     *   definition: MySettingsComponent,
+     * });
+     * ```
+     */
+    addToSlot: DefineAddToSlotFn<SettingsSlotContent>;
+};

package/src/types/types/ai.d.ts

@@ -1,4 +1,4 @@
-import { type LanguageModelV2, type ProviderV2 } from "@ai-sdk/provider";
+import { type LanguageModelV3, type ProviderV3 } from "@ai-sdk/provider";
 /**
  * Settings for AI reasoning.
  * @category AI
@@ -21,7 +21,7 @@ export type AILanguageModelSettings = {
  * Official AI Provider to be used by the [ai](https://ai-sdk.dev/) library.
  * @category AI
  */
-export type AIProvider = ProviderV2 & ((modelId: string, settings?: AILanguageModelSettings) => LanguageModelV2);
+export type AIProvider = ProviderV3 & ((modelId: string, settings?: AILanguageModelSettings) => LanguageModelV3);
 /**
  * AI upstream provider ID.
  * @category AI

package/src/types/types/request.d.ts

@@ -51,4 +51,8 @@ export type RequestViewModeOptions = {
      * The component to render when the view mode is selected.
      */
     view: ComponentDefinition;
+    /**
+     * A function that determines if the view mode should be shown for a given request.
+     */
+    when?: (request: RequestFull | RequestDraft) => boolean;
 };

package/src/types/types/response.d.ts

@@ -1,3 +1,4 @@
+import type { RequestFull, RequestMeta } from "./request";
 import type { As, ComponentDefinition, ID, Prettify } from "./utils";
 /**
  * A complete response with all metadata and raw content.
@@ -24,4 +25,8 @@ export type ResponseViewModeOptions = {
      * The component to render when the view mode is selected.
      */
     view: ComponentDefinition;
+    /**
+     * A function that determines if the view mode should be shown for a given response.
+     */
+    when?: (response: ResponseFull, request: RequestMeta | RequestFull) => boolean;
 };

package/src/types/types/settings.d.ts

@@ -0,0 +1,25 @@
+import { type CustomSlotContent } from "./slots";
+/**
+ * The slots in the Settings UI.
+ * @category Settings
+ */
+export declare const SettingsSlot: {
+    /**
+     * The plugins section in the settings sidebar.
+     */
+    readonly PluginsSection: "plugins-section";
+};
+export type SettingsSlot = (typeof SettingsSlot)[keyof typeof SettingsSlot];
+/**
+ * Content for a settings plugin slot.
+ * @category Settings
+ */
+export type SettingsPluginSlotContent = CustomSlotContent & {
+    /**
+     * The name of the plugin settings page displayed in the sidebar.
+     */
+    name: string;
+};
+export type SettingsSlotContent = {
+    [SettingsSlot.PluginsSection]: SettingsPluginSlotContent;
+};