@caido/sdk-frontend 0.48.2-beta.1 → 0.48.2-beta.11

package/src/types/footer.d.ts

@@ -0,0 +1,43 @@
+import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent, type DefineAddToSlotFn } from "./slots";
+export declare const FooterSlot: {
+    readonly FooterSlotPrimary: "footer-primary";
+    readonly FooterSlotSecondary: "footer-secondary";
+};
+export type FooterSlot = (typeof FooterSlot)[keyof typeof FooterSlot];
+/**
+ * Utilities to interact with the footer.
+ * @category Footer
+ */
+export type FooterSDK = {
+    /**
+     * 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(FooterSlot.FooterSlotPrimary, {
+     *   kind: "Command",
+     *   commandId: "my-command",
+     *   icon: "my-icon",
+     * });
+     *
+     * addToSlot(FooterSlot.FooterSlotPrimary, {
+     *   kind: "Button",
+     *   label: "My button",
+     *   icon: "fas fa-rocket",
+     *   onClick: () => {
+     *     console.log("Button clicked");
+     *   },
+     * });
+     *
+     * addToSlot(FooterSlot.FooterSlotSecondary, {
+     *   kind: "Custom",
+     *   component: MyComponent,
+     * });
+     * ```
+     */
+    addToSlot: DefineAddToSlotFn<{
+        [FooterSlot.FooterSlotPrimary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+        [FooterSlot.FooterSlotSecondary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+    }>;
+};

package/src/types/index.d.ts

@@ -7,6 +7,7 @@ import type { EnvironmentSDK } from "./environment";
 import type { FilesSDK } from "./files";
 import type { FiltersSDK } from "./filters";
 import type { FindingsSDK } from "./findings";
+import type { FooterSDK } from "./footer";
 import type { HTTPHistorySDK } from "./httpHistory";
 import type { InterceptSDK } from "./intercept";
 import type { MatchReplaceSDK } from "./matchReplace";
@@ -23,6 +24,8 @@ import type { StorageSDK } from "./storage";
 import type { UISDK } from "./ui";
 import type { WindowSDK } from "./window";
 import type { WorkflowSDK } from "./workflows";
+export { FooterSlot } from "./footer";
+export type { DialogOptions } from "./window";
 export type { CommandContext } from "./commands";
 export type { MenuItem } from "./menu";
 export { type ReplayTab, type ReplaySession, type ReplayCollection, ReplaySlot, } from "./replay";
@@ -140,4 +143,8 @@ export type API<T extends BackendEndpoints = Record<string, never>, E extends Ba
      * Utilities to interact with workflows.
      */
     workflows: WorkflowSDK;
+    /**
+     * Utilities to interact with the footer.
+     */
+    footer: FooterSDK;
 };

package/src/types/replay.d.ts

@@ -1,7 +1,10 @@
+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 SessionToolbar: "session-toolbar";
+    readonly SessionToolbarPrimary: "session-toolbar-primary";
+    readonly SessionToolbarSecondary: "session-toolbar-secondary";
+    readonly Topbar: "topbar";
 };
 export type ReplaySlot = (typeof ReplaySlot)[keyof typeof ReplaySlot];
 /**
@@ -121,8 +124,37 @@ export type ReplaySDK = {
      * 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.SessionToolbar]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+        [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/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";
 };