@caido/sdk-frontend 0.53.2-beta.3 → 0.53.2-beta.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "0.53.2-beta.3",
+  "version": "0.53.2-beta.5",
   "description": "Typing for the Caido Frontend SDK",
   "author": "Caido Labs Inc. <dev@caido.io>",
   "repository": "https://github.com/caido/sdk-js/",

package/src/types/index.d.ts

@@ -4,13 +4,15 @@ export type { CommandContext, CommandContextRequest, CommandContextRequestRow, C
 export type { MenuItem } from "./types/menu";
 export { type ReplayTab, type ReplaySession, type ReplayEntry, type ReplayCollection, type SendRequestOptions, ReplaySlot, type ReplaySlotContent, type RequestSource, type CurrentReplaySessionChangeEvent, } from "./types/replay";
 export type { HostedFile } from "./types/files";
-export type { Filter } from "./types/filter";
+export { FilterSlot, type Filter, type FilterSlotContent, } from "./types/filter";
 export type { HTTPQL, ID, ComponentDefinition } from "./types/utils";
 export type { JSONValue, JSONCompatible } from "./types/json";
 export type { SlotContent, ButtonSlotContent, CustomSlotContent, CommandSlotContent, } from "./types/slots";
 export type { RequestViewModeOptions, RequestFull, RequestDraft, RequestMeta, } from "./types/request";
 export type { MatchReplaceRule, MatchReplaceCollection, MatchReplaceSection, MatchReplaceSectionRequestAll, MatchReplaceSectionRequestBody, MatchReplaceSectionRequestFirstLine, MatchReplaceSectionRequestHeader, MatchReplaceSectionRequestMethod, MatchReplaceSectionRequestPath, MatchReplaceSectionRequestQuery, MatchReplaceSectionRequestSNI, MatchReplaceSectionResponseAll, MatchReplaceSectionResponseBody, MatchReplaceSectionResponseFirstLine, MatchReplaceSectionResponseHeader, MatchReplaceSectionResponseStatusCode, MatchReplaceOperationStatusCode, MatchReplaceOperationStatusCodeUpdate, MatchReplaceOperationQuery, MatchReplaceOperationQueryRaw, MatchReplaceOperationQueryAdd, MatchReplaceOperationQueryRemove, MatchReplaceOperationQueryUpdate, MatchReplaceOperationPath, MatchReplaceOperationPathRaw, MatchReplaceOperationAll, MatchReplaceOperationAllRaw, MatchReplaceOperationMethod, MatchReplaceOperationMethodUpdate, MatchReplaceOperationHeader, MatchReplaceOperationHeaderRaw, MatchReplaceOperationHeaderAdd, MatchReplaceOperationHeaderRemove, MatchReplaceOperationHeaderUpdate, MatchReplaceOperationBody, MatchReplaceOperationBodyRaw, MatchReplaceOperationFirstLine, MatchReplaceOperationFirstLineRaw, MatchReplaceOperationSNI, MatchReplaceOperationSNIRaw, MatchReplaceReplacer, MatchReplaceReplacerTerm, MatchReplaceReplacerWorkflow, MatchReplaceMatcherName, MatchReplaceMatcherRaw, MatchReplaceMatcherRawFull, MatchReplaceMatcherRawRegex, MatchReplaceMatcherRawValue, } from "./types/matchReplace";
-export type { Scope } from "./types/scopes";
+export { MatchReplaceSlot, type MatchReplaceSlotContent, } from "./types/matchReplace";
+export { ScopeSlot, type Scope, type ScopeSlotContent } from "./types/scopes";
+export { HTTPHistorySlot, type HTTPHistorySlotContent, } from "./types/httpHistory";
 export type { EnvironmentVariable } from "./types/environment";
 export type { Workflow, WorkflowKind, OnCreatedWorkflowCallback, OnUpdatedWorkflowCallback, OnDeletedWorkflowCallback, } from "./types/workflows";
 export type { ListenerHandle } from "./types/utils";

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

@@ -1,4 +1,5 @@
-import { type Filter } from "../types/filter";
+import { type Filter, type FilterSlotContent } from "../types/filter";
+import { type DefineAddToSlotFn } from "../types/slots";
 import type { HTTPQL, ID } from "../types/utils";
 /**
  * SDK for interacting with the Filters page.
@@ -45,4 +46,32 @@ export type FiltersSDK = {
      * @param id The ID of the filter to delete.
      */
     delete: (id: ID) => Promise<void>;
+    /**
+     * 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.filters.addToSlot(FilterSlot.UpdateHeader, {
+     *   type: "Button",
+     *   label: "My Button",
+     *   icon: "my-icon",
+     *   onClick: () => {
+     *     console.log("Button clicked");
+     *   },
+     * });
+     *
+     * sdk.filters.addToSlot(FilterSlot.CreateHeader, {
+     *   type: "Custom",
+     *   definition: MyComponent,
+     * });
+     *
+     * sdk.filters.addToSlot(FilterSlot.UpdateHeader, {
+     *   type: "Command",
+     *   commandId: "my-command",
+     *   icon: "my-icon",
+     * });
+     * ```
+     */
+    addToSlot: DefineAddToSlotFn<FilterSlotContent>;
 };

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

@@ -1,5 +1,7 @@
 import type { Extension } from "@codemirror/state";
+import type { HTTPHistorySlotContent } from "../types/httpHistory";
 import type { RequestViewModeOptions } from "../types/request";
+import { type DefineAddToSlotFn } from "../types/slots";
 import type { HTTPQL, ID } from "../types/utils";
 /**
  * Utilities to interact with the HTTP History page.
@@ -46,4 +48,32 @@ export type HTTPHistorySDK = {
      * @param id The ID of the entry to scroll to.
      */
     scrollTo: (id: ID) => void;
+    /**
+     * 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.httpHistory.addToSlot(HTTPHistorySlot.ToolbarPrimary, {
+     *   type: "Button",
+     *   label: "My Button",
+     *   icon: "my-icon",
+     *   onClick: () => {
+     *     console.log("Button clicked");
+     *   },
+     * });
+     *
+     * sdk.httpHistory.addToSlot(HTTPHistorySlot.ToolbarPrimary, {
+     *   type: "Custom",
+     *   definition: MyComponent,
+     * });
+     *
+     * sdk.httpHistory.addToSlot(HTTPHistorySlot.ToolbarPrimary, {
+     *   type: "Command",
+     *   commandId: "my-command",
+     *   icon: "my-icon",
+     * });
+     * ```
+     */
+    addToSlot: DefineAddToSlotFn<HTTPHistorySlotContent>;
 };

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

@@ -1,4 +1,5 @@
-import { type MatchReplaceCollection, type MatchReplaceRule, type MatchReplaceSection, type Source } from "../types/matchReplace";
+import { type MatchReplaceCollection, type MatchReplaceRule, type MatchReplaceSection, type MatchReplaceSlotContent, type Source } from "../types/matchReplace";
+import { type DefineAddToSlotFn } from "../types/slots";
 import type { HTTPQL, ID } from "../types/utils";
 /**
  * Utilities to interact with the Match and Replace page.
@@ -88,4 +89,32 @@ export type MatchReplaceSDK = {
      * @param id - The ID of the rule.
      */
     deleteRule: (id: ID) => Promise<void>;
+    /**
+     * 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.matchReplace.addToSlot(MatchReplaceSlot.UpdateHeader, {
+     *   type: "Button",
+     *   label: "My Button",
+     *   icon: "my-icon",
+     *   onClick: () => {
+     *     console.log("Button clicked");
+     *   },
+     * });
+     *
+     * sdk.matchReplace.addToSlot(MatchReplaceSlot.CreateHeader, {
+     *   type: "Custom",
+     *   definition: MyComponent,
+     * });
+     *
+     * sdk.matchReplace.addToSlot(MatchReplaceSlot.UpdateHeader, {
+     *   type: "Command",
+     *   commandId: "my-command",
+     *   icon: "my-icon",
+     * });
+     * ```
+     */
+    addToSlot: DefineAddToSlotFn<MatchReplaceSlotContent>;
 };

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

@@ -1,5 +1,5 @@
 import { type Extension } from "@codemirror/state";
-import { type CurrentReplaySessionChangeEvent, type OpenTabOptions, type ReplayCollection, type ReplayEntry, type ReplaySession, type ReplaySlotContent, type ReplayTab, type RequestSource, type SendRequestOptions } from "../types/replay";
+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 DefineAddToSlotFn } from "../types/slots";
 import type { ID, ListenerHandle } from "../types/utils";
@@ -192,4 +192,36 @@ export type ReplaySDK = {
      * ```
      */
     onCurrentSessionChange: (callback: (event: CurrentReplaySessionChangeEvent) => void) => ListenerHandle;
+    /**
+     * Subscribe to replay session creation events.
+     * @param callback The callback to call when a session is created.
+     * @returns An object with a `stop` method that can be called to stop listening to session creation events.
+     *
+     * @example
+     * ```ts
+     * const handler = sdk.replay.onSessionCreate((event) => {
+     *   console.log(`Session ${event.session.id} was created!`);
+     * });
+     *
+     * // Later, stop listening
+     * handler.stop();
+     * ```
+     */
+    onSessionCreate: (callback: (event: ReplaySessionCreatedEvent) => void) => ListenerHandle;
+    /**
+     * Subscribe to replay collection creation events.
+     * @param callback The callback to call when a collection is created.
+     * @returns An object with a `stop` method that can be called to stop listening to collection creation events.
+     *
+     * @example
+     * ```ts
+     * const handler = sdk.replay.onCollectionCreate((event) => {
+     *   console.log(`Collection ${event.collection.id} was created!`);
+     * });
+     *
+     * // Later, stop listening
+     * handler.stop();
+     * ```
+     */
+    onCollectionCreate: (callback: (event: ReplayCollectionCreatedEvent) => void) => ListenerHandle;
 };

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

@@ -1,4 +1,5 @@
-import { type Scope } from "../types/scopes";
+import { type Scope, type ScopeSlotContent } from "../types/scopes";
+import { type DefineAddToSlotFn } from "../types/slots";
 import type { ID } from "../types/utils";
 /**
  * Utilities to interact with scopes
@@ -52,4 +53,32 @@ export type ScopesSDK = {
      * @returns Whether the scope was deleted.
      */
     deleteScope: (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
+     * sdk.scopes.addToSlot(ScopeSlot.UpdateHeader, {
+     *   type: "Button",
+     *   label: "My Button",
+     *   icon: "my-icon",
+     *   onClick: () => {
+     *     console.log("Button clicked");
+     *   },
+     * });
+     *
+     * sdk.scopes.addToSlot(ScopeSlot.CreateHeader, {
+     *   type: "Custom",
+     *   definition: MyComponent,
+     * });
+     *
+     * sdk.scopes.addToSlot(ScopeSlot.UpdateHeader, {
+     *   type: "Command",
+     *   commandId: "my-command",
+     *   icon: "my-icon",
+     * });
+     * ```
+     */
+    addToSlot: DefineAddToSlotFn<ScopeSlotContent>;
 };

package/src/types/types/filter.d.ts

@@ -1,3 +1,4 @@
+import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent } from "./slots";
 import { type HTTPQL, type ID } from "./utils";
 /**
  * Represents a filter.
@@ -22,3 +23,22 @@ export type Filter = {
      */
     query: HTTPQL;
 };
+/**
+ * The slots in the Filters UI.
+ * @category Filters
+ */
+export declare const FilterSlot: {
+    /**
+     * The header area of the preset form update component.
+     */
+    readonly UpdateHeader: "update-header";
+    /**
+     * The header area of the preset form create component.
+     */
+    readonly CreateHeader: "create-header";
+};
+export type FilterSlot = (typeof FilterSlot)[keyof typeof FilterSlot];
+export type FilterSlotContent = {
+    [FilterSlot.UpdateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+    [FilterSlot.CreateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+};

package/src/types/types/httpHistory.d.ts

@@ -0,0 +1,15 @@
+import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent } from "./slots";
+/**
+ * The slots in the HTTP History UI.
+ * @category HTTP History
+ */
+export declare const HTTPHistorySlot: {
+    /**
+     * The toolbar.
+     */
+    readonly ToolbarPrimary: "toolbar-primary";
+};
+export type HTTPHistorySlot = (typeof HTTPHistorySlot)[keyof typeof HTTPHistorySlot];
+export type HTTPHistorySlotContent = {
+    [HTTPHistorySlot.ToolbarPrimary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+};

package/src/types/types/matchReplace.d.ts

@@ -1,3 +1,4 @@
+import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent } from "./slots";
 import { type HTTPQL, type ID } from "./utils";
 /**
  * A rule in Match and Replace.
@@ -270,4 +271,23 @@ export type MatchReplaceCollection = {
 type KeepOperation<T> = T & {
     __operation?: never;
 };
+/**
+ * The slots in the Match and Replace UI.
+ * @category Match and Replace
+ */
+export declare const MatchReplaceSlot: {
+    /**
+     * The header area of the rule form update component.
+     */
+    readonly UpdateHeader: "update-header";
+    /**
+     * The header area of the rule form create component.
+     */
+    readonly CreateHeader: "create-header";
+};
+export type MatchReplaceSlot = (typeof MatchReplaceSlot)[keyof typeof MatchReplaceSlot];
+export type MatchReplaceSlotContent = {
+    [MatchReplaceSlot.UpdateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+    [MatchReplaceSlot.CreateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+};
 export {};

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

@@ -198,3 +198,23 @@ export type CurrentReplaySessionChangeEvent = {
      */
     sessionId: ID | undefined;
 };
+/**
+ * Event fired when a replay session is created.
+ * @category Replay
+ */
+export type ReplaySessionCreatedEvent = {
+    /**
+     * The newly created replay session.
+     */
+    session: ReplaySession;
+};
+/**
+ * Event fired when a replay collection is created.
+ * @category Replay
+ */
+export type ReplayCollectionCreatedEvent = {
+    /**
+     * The newly created replay collection.
+     */
+    collection: ReplayCollection;
+};

package/src/types/types/scopes.d.ts

@@ -1,3 +1,4 @@
+import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent } from "./slots";
 import { type ID } from "./utils";
 /**
  * Represents a scope.
@@ -21,3 +22,22 @@ export type Scope = {
      */
     denylist: string[];
 };
+/**
+ * The slots in the Scopes UI.
+ * @category Scopes
+ */
+export declare const ScopeSlot: {
+    /**
+     * The header area of the preset form update component, to the left of the ScopeTooltip.
+     */
+    readonly UpdateHeader: "update-header";
+    /**
+     * The header area of the preset form create component, to the left of the ScopeTooltip.
+     */
+    readonly CreateHeader: "create-header";
+};
+export type ScopeSlot = (typeof ScopeSlot)[keyof typeof ScopeSlot];
+export type ScopeSlotContent = {
+    [ScopeSlot.UpdateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+    [ScopeSlot.CreateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+};