@caido/sdk-frontend 0.53.2-beta.8 → 0.53.2-beta.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "0.53.2-beta.8",
+  "version": "0.53.2-beta.9",
   "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

@@ -5,14 +5,14 @@ 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 { SearchSlot, type SearchSlotContent } from "./types/search";
 export type { HostedFile } from "./types/files";
-export { FilterSlot, type Filter, type FilterSlotContent, } from "./types/filter";
+export { FilterSlot, type Filter, type FilterSlotContent, CurrentFilterChangeEvent, } 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 { CurrentMatchReplaceRuleChangeEvent, 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 { MatchReplaceSlot, type MatchReplaceSlotContent, } from "./types/matchReplace";
-export { ScopeSlot, type Scope, type ScopeSlotContent } from "./types/scopes";
+export { ScopeSlot, type CurrentScopeChangeEvent, 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";

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

@@ -1,6 +1,6 @@
-import { type Filter, type FilterSlotContent } from "../types/filter";
+import { type CurrentFilterChangeEvent, type Filter, type FilterSlotContent } from "../types/filter";
 import { type DefineAddToSlotFn } from "../types/slots";
-import type { HTTPQL, ID } from "../types/utils";
+import type { HTTPQL, ID, ListenerHandle } from "../types/utils";
 /**
  * SDK for interacting with the Filters page.
  * @category Filters
@@ -46,6 +46,27 @@ export type FiltersSDK = {
      * @param id The ID of the filter to delete.
      */
     delete: (id: ID) => Promise<void>;
+    /**
+     * Get the currently selected filter.
+     * @returns The currently selected filter, or undefined if no filter is selected.
+     */
+    getCurrentFilter: () => Filter | undefined;
+    /**
+     * Subscribe to current filter changes.
+     * @param callback The callback to call when the selected filter changes.
+     * @returns An object with a `stop` method that can be called to stop listening to filter changes.
+     *
+     * @example
+     * ```ts
+     * const handler = sdk.filters.onCurrentFilterChange((event) => {
+     *   console.log(`Filter ${event.filterId} got selected!`);
+     * });
+     *
+     * // Later, stop listening
+     * handler.stop();
+     * ```
+     */
+    onCurrentFilterChange: (callback: (event: CurrentFilterChangeEvent) => void) => ListenerHandle;
     /**
      * Add a component to a slot.
      * @param slot The slot to add the component to.

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

@@ -1,6 +1,6 @@
-import { type MatchReplaceCollection, type MatchReplaceRule, type MatchReplaceSection, type MatchReplaceSlotContent, type Source } from "../types/matchReplace";
+import { type CurrentMatchReplaceRuleChangeEvent, 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";
+import type { HTTPQL, ID, ListenerHandle } from "../types/utils";
 /**
  * Utilities to interact with the Match and Replace page.
  * @category Match and Replace
@@ -48,6 +48,27 @@ export type MatchReplaceSDK = {
      * @param id - The ID of the rule, or undefined to clear the selection.
      */
     selectRule: (id: ID | undefined) => void;
+    /**
+     * Get the currently selected rule.
+     * @returns The currently selected rule, or undefined if no rule is selected.
+     */
+    getCurrentRule: () => MatchReplaceRule | undefined;
+    /**
+     * Subscribe to current rule changes.
+     * @param callback The callback to call when the selected rule changes.
+     * @returns An object with a `stop` method that can be called to stop listening to rule changes.
+     *
+     * @example
+     * ```ts
+     * const handler = sdk.matchReplace.onCurrentRuleChange((event) => {
+     *   console.log(`Rule ${event.ruleId} got selected!`);
+     * });
+     *
+     * // Later, stop listening
+     * handler.stop();
+     * ```
+     */
+    onCurrentRuleChange: (callback: (event: CurrentMatchReplaceRuleChangeEvent) => void) => ListenerHandle;
     /**
      * Create a rule.
      * @param options - The options for the rule.

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

@@ -1,6 +1,6 @@
-import { type Scope, type ScopeSlotContent } from "../types/scopes";
+import { type CurrentScopeChangeEvent, type Scope, type ScopeSlotContent } from "../types/scopes";
 import { type DefineAddToSlotFn } from "../types/slots";
-import type { ID } from "../types/utils";
+import type { ID, ListenerHandle } from "../types/utils";
 /**
  * Utilities to interact with scopes
  * @category Scopes
@@ -53,6 +53,27 @@ export type ScopesSDK = {
      * @returns Whether the scope was deleted.
      */
     deleteScope: (id: ID) => Promise<boolean>;
+    /**
+     * Get the currently selected scope.
+     * @returns The currently selected scope, or undefined if no scope is selected.
+     */
+    getCurrentScope: () => Scope | undefined;
+    /**
+     * Subscribe to current scope changes.
+     * @param callback The callback to call when the selected scope changes.
+     * @returns An object with a `stop` method that can be called to stop listening to scope changes.
+     *
+     * @example
+     * ```ts
+     * const handler = sdk.scopes.onCurrentScopeChange((event) => {
+     *   console.log(`Scope ${event.scopeId} got selected!`);
+     * });
+     *
+     * // Later, stop listening
+     * handler.stop();
+     * ```
+     */
+    onCurrentScopeChange: (callback: (event: CurrentScopeChangeEvent) => void) => ListenerHandle;
     /**
      * Add a component to a slot.
      * @param slot The slot to add the component to.

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

@@ -46,3 +46,13 @@ export type FilterSlotContent = {
     [FilterSlot.UpdateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
     [FilterSlot.CreateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
 };
+/**
+ * Event fired when the current filter changes.
+ * @category Filters
+ */
+export type CurrentFilterChangeEvent = {
+    /**
+     * The ID of the newly selected filter, or undefined if no filter is selected.
+     */
+    filterId: ID | undefined;
+};

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

@@ -422,4 +422,14 @@ export type MatchReplaceSlotContent = {
     [MatchReplaceSlot.UpdateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
     [MatchReplaceSlot.CreateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
 };
+/**
+ * Event fired when the current match and replace rule changes.
+ * @category Match and Replace
+ */
+export type CurrentMatchReplaceRuleChangeEvent = {
+    /**
+     * The ID of the newly selected rule, or undefined if no rule is selected.
+     */
+    ruleId: ID | undefined;
+};
 export {};

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

@@ -41,3 +41,13 @@ export type ScopeSlotContent = {
     [ScopeSlot.UpdateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
     [ScopeSlot.CreateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
 };
+/**
+ * Event fired when the current scope changes.
+ * @category Scopes
+ */
+export type CurrentScopeChangeEvent = {
+    /**
+     * The ID of the newly selected scope, or undefined if no scope is selected.
+     */
+    scopeId: ID | undefined;
+};