@caido/sdk-frontend 0.49.1-beta.5 → 0.49.1-beta.7

package/package.json

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

package/src/types/index.d.ts

@@ -2,7 +2,7 @@ export { FooterSlot, type FooterSlotContent } from "./types/footer";
 export type { DialogOptions } from "./types/window";
 export type { CommandContext } from "./types/commands";
 export type { MenuItem } from "./types/menu";
-export { type ReplayTab, type ReplaySession, type ReplayCollection, ReplaySlot, type ReplaySlotContent, } from "./types/replay";
+export { type ReplayTab, type ReplaySession, type ReplayCollection, type SendRequestOptions, ReplaySlot, type ReplaySlotContent, } from "./types/replay";
 export type { HostedFile } from "./types/files";
 export type { Filter } from "./types/filter";
 export type { HTTPQL, ID, ComponentDefinition } from "./types/utils";

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, type SendRequestOptions } 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.
@@ -102,4 +103,22 @@ export type ReplaySDK = {
      * @param extension The extension to add.
      */
     addRequestEditorExtension: (extension: Extension) => void;
+    /**
+     * Send a request to the Replay backend.
+     * @param request The request to send.
+     * @param options The options for sending the request.
+     * @example
+     * ```ts
+     * sendRequest(sessionId, {
+     *   connectionInfo: {
+     *     SNI: "example.com",
+     *     host: "example.com",
+     *     isTLS: true,
+     *     port: 443,
+     *   },
+     *   raw: "GET / HTTP/1.1\r\nHost: example.com\r\n\r\n",
+     *   updateContentLength: false,
+     * });
+     */
+    sendRequest: (sessionId: ID, options: SendRequestOptions) => Promise<void>;
 };

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

@@ -7,7 +7,7 @@ export type ShortcutsSDK = {
     /**
      * Register a shortcut.
      * @param commandId The id of the command to run when the shortcut is triggered.
-     * @param keys The keys of the shortcut. Check out {@link https://github.com/jaywcjlove/hotkeys-js?tab=readme-ov-file#supported-keys hotkeys-js} for the list of supported keys.
+     * @param keys The keys of the shortcut. Check out {@link https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_key_values KeyboardEvent.key} for the list of supported keys.
      */
     register: (commandId: CommandID, keys: string[]) => void;
 };

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

@@ -1,8 +1,21 @@
 import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent } from "./slots";
 import { type ID } from "./utils";
+/**
+ * The slots in the Replay UI.
+ * @category Replay
+ */
 export declare const ReplaySlot: {
+    /**
+     * The left side of the session toolbar.
+     */
     readonly SessionToolbarPrimary: "session-toolbar-primary";
+    /**
+     * The right side of the session toolbar.
+     */
     readonly SessionToolbarSecondary: "session-toolbar-secondary";
+    /**
+     * The left side of the topbar.
+     */
     readonly Topbar: "topbar";
 };
 export type ReplaySlot = (typeof ReplaySlot)[keyof typeof ReplaySlot];
@@ -11,6 +24,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
@@ -57,3 +81,40 @@ export type ReplayCollection = {
      */
     sessionIds: ID[];
 };
+/**
+ * Options for sending a request.
+ * @category Replay
+ */
+export type SendRequestOptions = {
+    /**
+     * The connection information to use for the request.
+     */
+    connectionInfo: {
+        /**
+         * The host to use for the request.
+         */
+        host: string;
+        /**
+         * The port to use for the request.
+         */
+        port: number;
+        /**
+         * Whether the request is TLS.
+         */
+        isTLS: boolean;
+        /**
+         * The SNI to use for the request.
+         * If not provided, the SNI will be inferred from the host.
+         */
+        SNI?: string;
+    };
+    /**
+     * The raw request to send.
+     */
+    raw: string;
+    /**
+     * Whether to update the content length automatically to match the body.
+     * Defaults to true.
+     */
+    updateContentLength?: boolean;
+};