@caido/sdk-frontend 0.48.2-beta.0 → 0.48.2-beta.10

package/src/types/commandPalette.d.ts

@@ -5,6 +5,7 @@
 export type CommandPaletteSDK = {
     /**
      * Register a command.
+     * @deprecated Use `sdk.commandPalette.addToSlot` instead.
      * @param commandId The id of the command to register.
      */
     register: (commandId: string) => void;

package/src/types/index.d.ts

@@ -23,12 +23,14 @@ import type { StorageSDK } from "./storage";
 import type { UISDK } from "./ui";
 import type { WindowSDK } from "./window";
 import type { WorkflowSDK } from "./workflows";
+export type { DialogOptions } from "./window";
 export type { CommandContext } from "./commands";
 export type { MenuItem } from "./menu";
-export type { ReplayTab, ReplaySession, ReplayCollection } from "./replay";
+export { type ReplayTab, type ReplaySession, type ReplayCollection, ReplaySlot, } from "./replay";
 export type { HostedFile } from "./files";
 export type { Filter } from "./filters";
 export type { HTTPQL, ID, JSONValue, JSONCompatible } from "./utils";
+export type { SlotContent, ButtonSlotContent, CustomSlotContent, CommandSlotContent, } from "./slots";
 export type { MatchReplaceRule, MatchReplaceCollection, MatchReplaceSection, MatchReplaceSectionRequestBody, MatchReplaceSectionRequestFirstLine, MatchReplaceSectionRequestHeader, MatchReplaceSectionRequestMethod, MatchReplaceSectionRequestPath, MatchReplaceSectionRequestQuery, MatchReplaceSectionResponseBody, MatchReplaceSectionResponseFirstLine, MatchReplaceSectionResponseHeader, MatchReplaceSectionResponseStatusCode, MatchReplaceOperationStatusCode, MatchReplaceOperationStatusCodeUpdate, MatchReplaceOperationQuery, MatchReplaceOperationQueryRaw, MatchReplaceOperationQueryAdd, MatchReplaceOperationQueryRemove, MatchReplaceOperationQueryUpdate, MatchReplaceOperationPath, MatchReplaceOperationPathRaw, MatchReplaceOperationMethod, MatchReplaceOperationMethodUpdate, MatchReplaceOperationHeader, MatchReplaceOperationHeaderRaw, MatchReplaceOperationHeaderAdd, MatchReplaceOperationHeaderRemove, MatchReplaceOperationHeaderUpdate, MatchReplaceOperationBody, MatchReplaceOperationBodyRaw, MatchReplaceOperationFirstLine, MatchReplaceOperationFirstLineRaw, MatchReplaceReplacer, MatchReplaceReplacerTerm, MatchReplaceReplacerWorkflow, MatchReplaceMatcherName, MatchReplaceMatcherRaw, MatchReplaceMatcherRawFull, MatchReplaceMatcherRawRegex, MatchReplaceMatcherRawValue, } from "./matchReplace";
 export type { Scope } from "./scopes";
 export type { EnvironmentVariable } from "./environment";

package/src/types/replay.d.ts

@@ -1,4 +1,12 @@
+import { type Extension } from "@codemirror/state";
+import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent, type DefineAddToSlotFn } from "./slots";
 import type { ID } from "./utils";
+export declare const ReplaySlot: {
+    readonly SessionToolbarPrimary: "session-toolbar-primary";
+    readonly SessionToolbarSecondary: "session-toolbar-secondary";
+    readonly Topbar: "topbar";
+};
+export type ReplaySlot = (typeof ReplaySlot)[keyof typeof ReplaySlot];
 /**
  * A replay tab.
  * @category Replay
@@ -112,4 +120,41 @@ export type ReplaySDK = {
      * @returns Whether the collection was deleted.
      */
     deleteCollection: (id: ID) => Promise<boolean>;
+    /**
+     * 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
+     * addToSlot(ReplaySlot.SessionToolbarPrimary, {
+     *   kind: "Command",
+     *   commandId: "my-command",
+     *   icon: "my-icon",
+     * });
+     *
+     * addToSlot(ReplaySlot.SessionToolbarSecondary, {
+     *   kind: "Custom",
+     *   component: MyComponent,
+     * });
+     *
+     * addToSlot(ReplaySlot.Topbar, {
+     *   kind: "Button",
+     *   label: "My Button",
+     *   icon: "my-icon",
+     *   onClick: () => {
+     *     console.log("Button clicked");
+     *   },
+     * });
+     * ```
+     */
+    addToSlot: DefineAddToSlotFn<{
+        [ReplaySlot.SessionToolbarPrimary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+        [ReplaySlot.SessionToolbarSecondary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+        [ReplaySlot.Topbar]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+    }>;
+    /**
+     * Add an extension to the request editor.
+     * @param extension The extension to add.
+     */
+    addRequestEditorExtension: (extension: Extension) => void;
 };

package/src/types/slots.d.ts

@@ -0,0 +1,22 @@
+import { type Component } from "vue";
+import { type CommandID } from "./utils";
+type DefineSlotContent<TType extends string, P extends Record<string, unknown>> = {
+    type: TType;
+} & P;
+export type ButtonSlotContent = DefineSlotContent<"Button", {
+    label: string;
+    icon?: string;
+    onClick: () => void;
+}>;
+export type CustomSlotContent<TProps extends Record<string, unknown> = Record<string, unknown>> = DefineSlotContent<"Custom", {
+    component: Component<TProps>;
+}>;
+export type CommandSlotContent = DefineSlotContent<"Command", {
+    commandId: CommandID;
+    icon?: string;
+}>;
+export type SlotContent = ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+export type DefineAddToSlotFn<TMap extends Record<string, DefineSlotContent<string, Record<string, unknown>>>> = {
+    <K extends keyof TMap>(slot: K, spec: TMap[K]): void;
+};
+export {};

package/src/types/window.d.ts

@@ -1,4 +1,5 @@
 import type { Editor } from "./editor";
+import type { CustomSlotContent } from "./slots";
 /**
  * Utilities to interact with the active page.
  * @category Window
@@ -20,4 +21,24 @@ export type WindowSDK = {
         variant?: "success" | "error" | "warning" | "info";
         duration?: number;
     }) => void;
+    /**
+     * Show a dialog component.
+     * @param component The custom slot content to display in the dialog.
+     * @param options Options for the dialog.
+     * @param options.title The title text for the dialog. Defaults to ""
+     * @param options.draggable Whether the dialog is draggable. Defaults to false
+     * @param options.closeOnEscape Whether the dialog closes when pressing Escape. Defaults to true
+     * @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
+     */
+    showDialog: (component: CustomSlotContent, options?: DialogOptions) => void;
+};
+export type DialogOptions = {
+    title?: string;
+    draggable?: boolean;
+    closeOnEscape?: boolean;
+    closable?: boolean;
+    modal?: boolean;
+    position?: "left" | "right" | "top" | "bottom" | "center" | "topleft" | "topright" | "bottomleft" | "bottomright";
 };