@caido/sdk-frontend 0.54.2-beta.1 → 0.54.2-beta.3

package/package.json

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

@@ -3,6 +3,8 @@ export type { DialogOptions } from "./types/window";
 export type { CommandContext, CommandContextRequest, CommandContextRequestRow, CommandContextResponse, CommandContextBase, } from "./types/commands";
 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 { AutomateSession, AutomateEntry } from "./types/automate";
+export type { SitemapEntry, SitemapRootEntry, ChildState, } from "./types/sitemap";
 export { SearchSlot, type SearchSlotContent } from "./types/search";
 export type { HostedFile } from "./types/files";
 export { FilterSlot, type Filter, type FilterSlotContent, type CurrentFilterChangeEvent, } from "./types/filter";
@@ -16,7 +18,7 @@ export { ScopeSlot, type CurrentScopeChangeEvent, type Scope, type ScopeSlotCont
 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";
+export type { ListenerHandle, AddIndicatorOptions, Indicator, } from "./types/utils";
 export type { AIProvider, AILanguageModelSettings, AIReasoningSettings, AIUpstreamProvider, AIUpstreamProviderId, AIUpstreamProviderStatus, } from "./types/ai";
 export type { SelectedProjectChangeEvent } from "./types/projects";
 export type { CommandPaletteView } from "./sdks/commandPalette";

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

@@ -1,4 +1,6 @@
 import type { Extension } from "@codemirror/state";
+import type { AutomateEntry, AutomateSession } from "src/types/automate";
+import type { AddIndicatorOptions, ID, Indicator } from "src/types/utils";
 import type { RequestViewModeOptions } from "../types/request";
 /**
  * Utilities to interact with the Automate page.
@@ -15,4 +17,33 @@ export type AutomateSDK = {
      * @param options The view mode options.
      */
     addRequestViewMode: (options: RequestViewModeOptions) => void;
+    /**
+     * Get the list of all automate sessions.
+     * @returns The list of all automate sessions.
+     */
+    getSessions: () => AutomateSession[];
+    /**
+     * Get the list of all automate entries.
+     * @param sessionId The ID of the session to get the entries of.
+     * @returns The list of all automate entries.
+     */
+    getEntries: (sessionId: ID) => AutomateEntry[];
+    /**
+     * Add an indicator to an automate entry.
+     * Indicators are displayed next to the entry name in the collections tree.
+     * @param entryId The ID of the entry to add the indicator to.
+     * @param indicator The indicator configuration.
+     * @returns A handle object with a `remove` method to remove the indicator.
+     * @example
+     *
+     * const indicator = sdk.automate.addEntryIndicator(entryId, {
+     *   icon: "fas fa-exclamation-triangle",
+     *   description: "Security warning",
+     * });
+     *
+     * // Later, remove the indicator
+     * indicator.remove();
+     *
+     */
+    addEntryIndicator: (entryId: ID, indicator: AddIndicatorOptions) => Indicator;
 };

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

@@ -1,6 +1,6 @@
 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, ListenerHandle } from "../types/utils";
+import type { AddIndicatorOptions, HTTPQL, ID, Indicator, ListenerHandle } from "../types/utils";
 /**
  * Utilities to interact with the Match and Replace page.
  * @category Match and Replace
@@ -138,4 +138,22 @@ export type MatchReplaceSDK = {
      * ```
      */
     addToSlot: DefineAddToSlotFn<MatchReplaceSlotContent>;
+    /**
+     * Add an indicator to a rule.
+     * Indicators are displayed next to the session name in the collections tree.
+     * @param ruleId The ID of the rule to add the indicator to.
+     * @param indicator The indicator configuration.
+     * @returns A handle object with a `remove` method to remove the indicator.
+     * @example
+     *
+     * const indicator = sdk.matchReplace.addRuleIndicator(ruleId, {
+     *   icon: "fas fa-exclamation-triangle",
+     *   description: "Security warning",
+     * });
+     *
+     * // Later, remove the indicator
+     * indicator.remove();
+     *
+     */
+    addRuleIndicator: (ruleId: ID, indicator: AddIndicatorOptions) => Indicator;
 };

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

@@ -2,7 +2,7 @@ import { type Extension } from "@codemirror/state";
 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";
+import type { AddIndicatorOptions, ID, Indicator, ListenerHandle } from "../types/utils";
 /**
  * Utilities to interact with Replay.
  * @category Replay
@@ -224,4 +224,22 @@ export type ReplaySDK = {
      * ```
      */
     onCollectionCreate: (callback: (event: ReplayCollectionCreatedEvent) => void) => ListenerHandle;
+    /**
+     * Add an indicator to a replay session.
+     * Indicators are displayed next to the session name in the collections tree.
+     * @param sessionId The ID of the session to add the indicator to.
+     * @param indicator The indicator configuration.
+     * @returns A handle object with a `remove` method to remove the indicator.
+     * @example
+     *
+     * const indicator = sdk.replay.addSessionIndicator(sessionId, {
+     *   icon: "fas fa-exclamation-triangle",
+     *   description: "Security warning",
+     * });
+     *
+     * // Later, remove the indicator
+     * indicator.remove();
+     *
+     */
+    addSessionIndicator: (sessionId: ID, indicator: AddIndicatorOptions) => Indicator;
 };

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

@@ -1,11 +1,38 @@
 import type { Extension } from "@codemirror/state";
 import type { RequestViewModeOptions } from "../types/request";
-import type { ID } from "../types/utils";
+import type { SitemapEntry, SitemapEntryChildStateUpdateEvent, SitemapRootEntry } from "../types/sitemap";
+import type { AddIndicatorOptions, ID, Indicator, ListenerHandle } from "../types/utils";
 /**
  * Utilities to interact with the Sitemap page.
  * @category Sitemap
  */
 export type SitemapSDK = {
+    /**
+     * Listen for child state updates on a sitemap entry.
+     * @param callback The callback function that receives the entry ID and new child state.
+     * @returns A handle object with a `stop` method to stop listening.
+     * @example
+     *
+     * const handle = sdk.sitemap.onEntryChildStateUpdate((entryId, newChildState) => {
+     *   console.log(`Entry ${entryId} child state changed:`, newChildState);
+     * });
+     *
+     * // Later, stop listening
+     * handle.stop();
+     */
+    onEntryChildStateUpdate: (callback: (event: SitemapEntryChildStateUpdateEvent) => void) => ListenerHandle;
+    /**
+     * Get the list of all sitemap entries in tree format.
+     * @returns The list of all sitemap entries.
+     */
+    getTreeEntries: () => SitemapRootEntry[];
+    /**
+     * Load children for a sitemap entry.
+     * This will fetch and load children if they haven't been loaded yet.
+     * @param entryId The ID of the entry to load children for.
+     * @returns Promise that resolves when children are loaded.
+     */
+    getChildren: (entryId: ID) => Promise<SitemapEntry[]>;
     /**
      * Get the current scope ID.
      * @returns The current scope ID.
@@ -26,4 +53,22 @@ export type SitemapSDK = {
      * @param options The view mode options.
      */
     addRequestViewMode: (options: RequestViewModeOptions) => void;
+    /**
+     * Add an indicator to a sitemap session.
+     * Indicators are displayed next to the entry name in the collections tree.
+     * @param entryId The ID of the entry to add the indicator to.
+     * @param indicator The indicator configuration.
+     * @returns A handle object with a `remove` method to remove the indicator.
+     * @example
+     *
+     * const indicator = sdk.sitemap.addEntryIndicator(entryId, {
+     *   icon: "fas fa-exclamation-triangle",
+     *   description: "Security warning",
+     * });
+     *
+     * // Later, remove the indicator
+     * indicator.remove();
+     *
+     */
+    addEntryIndicator: (entryId: ID, indicator: AddIndicatorOptions) => Indicator;
 };

package/src/types/types/automate.d.ts

@@ -0,0 +1,41 @@
+import type { ID } from "./utils";
+/**
+ * A automate session.
+ * @category Automate
+ */
+export type AutomateSession = {
+    /**
+     * The ID of the session.
+     */
+    id: ID;
+    /**
+     * The name of the session.
+     */
+    name: string;
+    /**
+     * The date the session was created.
+     */
+    createdAt: Date;
+    /**
+     * The IDs of all entries in this session.
+     */
+    entryIds: ID[];
+};
+/**
+ * A automate entry.
+ * @category Automate
+ */
+export type AutomateEntry = {
+    /**
+     * The ID of the entry.
+     */
+    id: ID;
+    /**
+     * The name of the entry.
+     */
+    name: string;
+    /**
+     * The date the entry was created.
+     */
+    createdAt: Date;
+};

package/src/types/types/sitemap.d.ts

@@ -0,0 +1,87 @@
+import { type ID } from "./utils";
+/**
+ * An entry in sitemap.
+ * @category Sitemap
+ */
+export type SitemapEntry = {
+    /**
+     * The ID of the entry.
+     */
+    id: ID;
+    /**
+     * The label of the entry.
+     */
+    label: string;
+    /**
+     * The kind of the entry.
+     */
+    kind: SitemapEntryKind;
+    /**
+     * The ID of the parent entry.
+     */
+    parentId?: ID;
+    /**
+     * The child state of the entry.
+     */
+    childState: ChildState;
+};
+export type SitemapRootEntry = {
+    /**
+     * The ID of the entry.
+     */
+    id: ID;
+    /**
+     * The label of the entry.
+     */
+    label: string;
+    /**
+     * The child state of the entry.
+     */
+    childState: ChildState;
+};
+/**
+ * The kind of a sitemap entry.
+ * @category Sitemap
+ */
+export declare const SitemapEntryKind: {
+    readonly Directory: "DIRECTORY";
+    readonly Domain: "DOMAIN";
+    readonly Request: "REQUEST";
+    readonly RequestBody: "REQUEST_BODY";
+    readonly RequestQuery: "REQUEST_QUERY";
+};
+/**
+ * The kind of a sitemap entry.
+ * @category Sitemap
+ * @example
+ * ```ts
+ * const entry = {
+ *   id: "123",
+ *   label: "Example",
+ *   kind: SitemapEntryKind.Request,
+ * };
+ * ```
+ */
+export type SitemapEntryKind = (typeof SitemapEntryKind)[keyof typeof SitemapEntryKind];
+export type ChildState = {
+    kind: "Empty";
+} | {
+    kind: "NotLoaded";
+} | {
+    kind: "Loaded";
+    items: ID[];
+};
+/**
+ * Event fired when the child state of a sitemap entry changes.
+ * @category Sitemap
+ */
+export type SitemapEntryChildStateUpdateEvent = {
+    /**
+     * The ID of the entry that changed.
+     */
+    entryId: ID;
+    /**
+     * The new child state of the entry.
+     */
+    newChildState: ChildState;
+};

package/src/types/types/utils.d.ts

@@ -60,3 +60,19 @@ export type Prettify<T> = {
 export type As<TType extends string> = {
     type: TType;
 };
+/**
+ * Visual indicator displayed next to a item label in a tree component.
+ * Includes an icon and an associated description.
+ * @category Utils
+ */
+export type AddIndicatorOptions = {
+    icon: Icon;
+    description: string;
+};
+/**
+ * Providing operations that can be performed on a item indicator.
+ * @category Utils
+ */
+export type Indicator = {
+    remove: () => void;
+};