@caido/sdk-frontend 0.58.3-beta.3 → 0.58.3-beta.4

package/package.json

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

@@ -16,7 +16,7 @@ export { FilterSlot, type Filter, type FilterSlotContent, type CurrentFilterChan
 export type { HTTPQL, StreamQL, ID, ComponentDefinition, Selection, QueryInput, } from "./types/utils";
 export type { JSONValue, JSONCompatible } from "./types/json";
 export type { KVValue, KVEvents } from "./types/kv";
-export type { SlotContent, ButtonSlotContent, CustomSlotContent, CommandSlotContent, SlotContentPropsInternal, SlotContentProps, } from "./types/slots";
+export type { SlotContent, ButtonSlotContent, CustomSlotContent, CommandSlotContent, SlotContentPropsInternal, SlotContentProps, SlotHandle, } from "./types/slots";
 export type { RequestViewModeOptions, RequestWritableViewModeProps, RequestReadableViewModeProps, RequestReadableViewModePropsInternal, RequestWritableViewModePropsInternal, RequestViewModeProps, RequestFull, RequestDraft, RequestMeta, } from "./types/request";
 export type { ResponseViewModePropsInternal, ResponseViewModeOptions, ResponseViewModeProps, ResponseFull, } from "./types/response";
 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, MatchReplaceSectionResponseWebsocket, MatchReplaceSectionRequestWebsocket, MatchReplaceOperationWebsocket, MatchReplaceOperationWebsocketRaw, } from "./types/matchReplace";

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

@@ -71,6 +71,7 @@ export type FiltersSDK = {
      * Add a component to a slot.
      * @param slot The slot to add the component to.
      * @param content The content to add to the slot.
+     * @returns A handle object with a `remove` method to remove the content from the slot.
      * @example
      * ```ts
      * sdk.filters.addToSlot(FilterSlot.UpdateHeader, {

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

@@ -9,6 +9,7 @@ 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.
+     * @returns A handle object with a `remove` method to remove the content from the slot.
      * @example
      * ```ts
      * addToSlot(FooterSlot.FooterSlotPrimary, {

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

@@ -68,6 +68,7 @@ export type HTTPHistorySDK = {
      * Add a component to a slot.
      * @param slot The slot to add the component to.
      * @param content The content to add to the slot.
+     * @returns A handle object with a `remove` method to remove the content from the slot.
      * @example
      * ```ts
      * sdk.httpHistory.addToSlot(HTTPHistorySlot.ToolbarPrimary, {

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

@@ -114,6 +114,7 @@ export type MatchReplaceSDK = {
      * Add a component to a slot.
      * @param slot The slot to add the component to.
      * @param content The content to add to the slot.
+     * @returns A handle object with a `remove` method to remove the content from the slot.
      * @example
      * ```ts
      * sdk.matchReplace.addToSlot(MatchReplaceSlot.UpdateHeader, {

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

@@ -142,27 +142,29 @@ 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.
+     * @returns A handle object with a `remove` method to remove the content from the slot.
      * @example
      * ```ts
-     * addToSlot(ReplaySlot.SessionToolbarPrimary, {
-     *   kind: "Command",
+     * const command = sdk.replay.addToSlot(ReplaySlot.SessionToolbarPrimary, {
+     *   type: "Command",
      *   commandId: "my-command",
      *   icon: "my-icon",
      * });
      *
-     * addToSlot(ReplaySlot.SessionToolbarSecondary, {
-     *   kind: "Custom",
-     *   component: MyComponent,
+     * const custom = sdk.replay.addToSlot(ReplaySlot.SessionToolbarSecondary, {
+     *   type: "Custom",
+     *   definition: MyComponent,
      * });
      *
-     * addToSlot(ReplaySlot.Topbar, {
-     *   kind: "Button",
-     *   label: "My Button",
-     *   icon: "my-icon",
-     *   onClick: () => {
-     *     console.log("Button clicked");
-     *   },
+     * const button = sdk.replay.addToSlot(ReplaySlot.Topbar, {
+     *   type: "Button",
+     *   label: "Hello",
+     *   icon: "fas fa-user",
+     *   onClick: () => {},
      * });
+     *
+     * // Later, remove the content
+     * button.remove();
      * ```
      */
     addToSlot: DefineAddToSlotFn<ReplaySlotContent>;

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

@@ -78,6 +78,7 @@ export type ScopesSDK = {
      * Add a component to a slot.
      * @param slot The slot to add the component to.
      * @param content The content to add to the slot.
+     * @returns A handle object with a `remove` method to remove the content from the slot.
      * @example
      * ```ts
      * sdk.scopes.addToSlot(ScopeSlot.UpdateHeader, {

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

@@ -2,6 +2,7 @@ import type { Extension } from "@codemirror/state";
 import type { RequestFull, RequestReadableViewModeProps, RequestViewModeOptions } from "../types/request";
 import type { ResponseFull, ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import type { SearchSlot, SearchSlotContent } from "../types/search";
+import type { SlotHandle } from "../types/slots";
 import type { HTTPQL, ID } from "../types/utils";
 /**
  * Utilities to interact with the Search page.
@@ -62,6 +63,7 @@ export type SearchSDK = {
      * Add content to a slot in the Search UI.
      * @param slot The slot to add content to.
      * @param content The content to add.
+     * @returns A handle object with a `remove` method to remove the content from the slot.
      */
-    addToSlot: <T extends SearchSlot>(slot: T, content: SearchSlotContent[T]) => void;
+    addToSlot: <T extends SearchSlot>(slot: T, content: SearchSlotContent[T]) => SlotHandle;
 };

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

@@ -9,6 +9,7 @@ export type SettingsSDK = {
      * Add a component to a slot.
      * @param slot The slot to add the component to.
      * @param content The content to add to the slot.
+     * @returns A handle object with a `remove` method to remove the content from the slot.
      * @example
      * ```ts
      * sdk.settings.addToSlot(SettingsSlot.PluginsSection, {

package/src/types/types/slots.d.ts

@@ -50,11 +50,21 @@ export type CommandSlotContent = DefineSlotContent<"Command", {
  * @category Slots
  */
 export type SlotContent<TProps extends SlotContentPropsGroup = SlotContentProps> = ButtonSlotContent | CustomSlotContent<TProps> | CommandSlotContent;
+/**
+ * A handle for slot content added through the SDK.
+ * @category Slots
+ */
+export type SlotHandle = {
+    /**
+     * Remove the content from the slot.
+     */
+    remove: () => void;
+};
 /**
  * A function type for adding content to slots.
  * @category Slots
  */
 export type DefineAddToSlotFn<TMap extends Record<string, DefineSlotContent<string, Record<string, unknown>>>> = {
-    <K extends keyof TMap>(slot: K, spec: TMap[K]): void;
+    <K extends keyof TMap>(slot: K, spec: TMap[K]): SlotHandle;
 };
 export {};