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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "0.53.2-beta.7",
+  "version": "0.53.2-beta.8",
   "description": "Typing for the Caido Frontend SDK",
   "author": "Caido Labs Inc. <dev@caido.io>",
   "repository": "https://github.com/caido/sdk-js/",
@@ -19,6 +19,6 @@
   },
   "peerDependenciesMeta": {},
   "scripts": {
-    "documentation": "typedoc"
+    "generate:doc": "typedoc"
   }
 }

package/src/types/types/ai.d.ts

@@ -1,7 +1,15 @@
 import { type LanguageModelV2, type ProviderV2 } from "@ai-sdk/provider";
+/**
+ * Settings for AI reasoning.
+ * @category AI
+ */
 export type AIReasoningSettings = {
     effort: "low" | "medium" | "high";
 };
+/**
+ * Settings for AI language model.
+ * @category AI
+ */
 export type AILanguageModelSettings = {
     reasoning?: AIReasoningSettings;
 };

package/src/types/types/editor.d.ts

@@ -1,6 +1,7 @@
 import type { EditorView } from "@codemirror/view";
 /**
  * Generic editor interface.
+ * @category Editor
  */
 export type Editor = {
     /**
@@ -27,6 +28,10 @@ export type Editor = {
      */
     getEditorView: () => EditorView;
 };
+/**
+ * An HTTP request editor interface.
+ * @category Editor
+ */
 export type HTTPRequestEditor = {
     /**
      * Get the editor element.
@@ -40,6 +45,10 @@ export type HTTPRequestEditor = {
      */
     getEditorView: () => EditorView;
 };
+/**
+ * An HTTP response editor interface.
+ * @category Editor
+ */
 export type HTTPResponseEditor = {
     /**
      * Get the editor element.

package/src/types/types/environment.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Represents an environment variable.
+ * @category Environment
+ */
 export type EnvironmentVariable = {
     /**
      * The name of the environment variable.

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

@@ -38,6 +38,10 @@ export declare const FilterSlot: {
     readonly CreateHeader: "create-header";
 };
 export type FilterSlot = (typeof FilterSlot)[keyof typeof FilterSlot];
+/**
+ * Content that can be added to filter slots.
+ * @category Filter
+ */
 export type FilterSlotContent = {
     [FilterSlot.UpdateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
     [FilterSlot.CreateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;

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

@@ -1,9 +1,17 @@
 import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent } from "./slots";
+/**
+ * The slots in the Footer UI.
+ * @category Footer
+ */
 export declare const FooterSlot: {
     readonly FooterSlotPrimary: "footer-primary";
     readonly FooterSlotSecondary: "footer-secondary";
 };
 export type FooterSlot = (typeof FooterSlot)[keyof typeof FooterSlot];
+/**
+ * Content that can be added to footer slots.
+ * @category Footer
+ */
 export type FooterSlotContent = {
     [FooterSlot.FooterSlotPrimary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
     [FooterSlot.FooterSlotSecondary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;

package/src/types/types/json.d.ts

@@ -1,8 +1,16 @@
 type JSONPrimitive = string | number | boolean | null | undefined;
+/**
+ * A JSON-serializable value.
+ * @category JSON
+ */
 export type JSONValue = JSONPrimitive | JSONValue[] | {
     [key: string]: JSONValue;
 };
 type NotAssignableToJson = bigint | symbol | Function;
+/**
+ * A type that ensures all properties of T are JSON-compatible.
+ * @category JSON
+ */
 export type JSONCompatible<T> = unknown extends T ? never : {
     [P in keyof T]: T[P] extends JSONValue ? T[P] : T[P] extends NotAssignableToJson ? never : JSONCompatible<T[P]>;
 };

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

@@ -31,6 +31,10 @@ export type MatchReplaceRule = {
      */
     collectionId: ID;
 };
+/**
+ * The source of a match and replace rule.
+ * @category Match and Replace
+ */
 export declare const Source: {
     readonly Automate: "AUTOMATE";
     readonly Intercept: "INTERCEPT";
@@ -40,77 +44,165 @@ export declare const Source: {
     readonly Workflow: "WORKFLOW";
 };
 export type Source = (typeof Source)[keyof typeof Source];
+/**
+ * A discriminated union of all possible match and replace sections.
+ * @category Match and Replace
+ */
 export type MatchReplaceSection = MatchReplaceSectionRequestAll | MatchReplaceSectionRequestBody | MatchReplaceSectionRequestFirstLine | MatchReplaceSectionRequestHeader | MatchReplaceSectionRequestMethod | MatchReplaceSectionRequestPath | MatchReplaceSectionRequestQuery | MatchReplaceSectionRequestSNI | MatchReplaceSectionResponseAll | MatchReplaceSectionResponseBody | MatchReplaceSectionResponseFirstLine | MatchReplaceSectionResponseHeader | MatchReplaceSectionResponseStatusCode;
+/**
+ * A section for the entire request.
+ * @category Match and Replace
+ */
 export type MatchReplaceSectionRequestAll = {
     kind: "SectionRequestAll";
     operation: MatchReplaceOperationAll;
 };
+/**
+ * A section for the entire response.
+ * @category Match and Replace
+ */
 export type MatchReplaceSectionResponseAll = {
     kind: "SectionResponseAll";
     operation: MatchReplaceOperationAll;
 };
+/**
+ * An operation for the entire request/response section.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationAll = KeepOperation<MatchReplaceOperationAllRaw>;
+/**
+ * A raw operation for the entire request/response section.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationAllRaw = {
     kind: "OperationAllRaw";
     matcher: MatchReplaceMatcherRaw;
     replacer: MatchReplaceReplacer;
 };
+/**
+ * A section for the response status code.
+ * @category Match and Replace
+ */
 export type MatchReplaceSectionResponseStatusCode = {
     kind: "SectionResponseStatusCode";
     operation: MatchReplaceOperationStatusCode;
 };
+/**
+ * An operation for the response status code section.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationStatusCode = KeepOperation<MatchReplaceOperationStatusCodeUpdate>;
+/**
+ * An operation to update the response status code.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationStatusCodeUpdate = {
     kind: "OperationStatusCodeUpdate";
     replacer: MatchReplaceReplacer;
 };
+/**
+ * A section for the request query string.
+ * @category Match and Replace
+ */
 export type MatchReplaceSectionRequestQuery = {
     kind: "SectionRequestQuery";
     operation: MatchReplaceOperationQuery;
 };
+/**
+ * An operation for the request query section.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationQuery = MatchReplaceOperationQueryRaw | MatchReplaceOperationQueryAdd | MatchReplaceOperationQueryRemove | MatchReplaceOperationQueryUpdate;
+/**
+ * A raw operation for the request query section.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationQueryRaw = {
     kind: "OperationQueryRaw";
     matcher: MatchReplaceMatcherRaw;
     replacer: MatchReplaceReplacer;
 };
+/**
+ * An operation to add a query parameter.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationQueryAdd = {
     kind: "OperationQueryAdd";
     matcher: MatchReplaceMatcherName;
     replacer: MatchReplaceReplacer;
 };
+/**
+ * An operation to remove a query parameter.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationQueryRemove = {
     kind: "OperationQueryRemove";
     matcher: MatchReplaceMatcherName;
 };
+/**
+ * An operation to update a query parameter.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationQueryUpdate = {
     kind: "OperationQueryUpdate";
     matcher: MatchReplaceMatcherName;
     replacer: MatchReplaceReplacer;
 };
+/**
+ * A section for the request path.
+ * @category Match and Replace
+ */
 export type MatchReplaceSectionRequestPath = {
     kind: "SectionRequestPath";
     operation: MatchReplaceOperationPath;
 };
+/**
+ * An operation for the request path section.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationPath = KeepOperation<MatchReplaceOperationPathRaw>;
+/**
+ * A raw operation for the request path section.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationPathRaw = {
     kind: "OperationPathRaw";
     matcher: MatchReplaceMatcherRaw;
     replacer: MatchReplaceReplacer;
 };
+/**
+ * A section for the request method.
+ * @category Match and Replace
+ */
 export type MatchReplaceSectionRequestMethod = {
     kind: "SectionRequestMethod";
     operation: MatchReplaceOperationMethod;
 };
+/**
+ * An operation for the request method section.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationMethod = KeepOperation<MatchReplaceOperationMethodUpdate>;
+/**
+ * An operation to update the request method.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationMethodUpdate = {
     kind: "OperationMethodUpdate";
     replacer: MatchReplaceReplacer;
 };
+/**
+ * A section for the request headers.
+ * @category Match and Replace
+ */
 export type MatchReplaceSectionRequestHeader = {
     kind: "SectionRequestHeader";
     operation: MatchReplaceOperationHeader;
 };
+/**
+ * A section for the response headers.
+ * @category Match and Replace
+ */
 export type MatchReplaceSectionResponseHeader = {
     kind: "SectionResponseHeader";
     operation: MatchReplaceOperationHeader;
@@ -120,29 +212,53 @@ export type MatchReplaceSectionResponseHeader = {
  * @category Match and Replace
  */
 export type MatchReplaceOperationHeader = MatchReplaceOperationHeaderRaw | MatchReplaceOperationHeaderAdd | MatchReplaceOperationHeaderRemove | MatchReplaceOperationHeaderUpdate;
+/**
+ * A raw operation for the header section.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationHeaderRaw = {
     kind: "OperationHeaderRaw";
     matcher: MatchReplaceMatcherRaw;
     replacer: MatchReplaceReplacer;
 };
+/**
+ * An operation to add a header.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationHeaderAdd = {
     kind: "OperationHeaderAdd";
     matcher: MatchReplaceMatcherName;
     replacer: MatchReplaceReplacer;
 };
+/**
+ * An operation to remove a header.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationHeaderRemove = {
     kind: "OperationHeaderRemove";
     matcher: MatchReplaceMatcherName;
 };
+/**
+ * An operation to update a header.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationHeaderUpdate = {
     kind: "OperationHeaderUpdate";
     matcher: MatchReplaceMatcherName;
     replacer: MatchReplaceReplacer;
 };
+/**
+ * A section for the request body.
+ * @category Match and Replace
+ */
 export type MatchReplaceSectionRequestBody = {
     kind: "SectionRequestBody";
     operation: MatchReplaceOperationBody;
 };
+/**
+ * A section for the response body.
+ * @category Match and Replace
+ */
 export type MatchReplaceSectionResponseBody = {
     kind: "SectionResponseBody";
     operation: MatchReplaceOperationBody;
@@ -177,6 +293,10 @@ export type MatchReplaceSectionRequestSNI = {
     kind: "SectionRequestSNI";
     operation: MatchReplaceOperationSNI;
 };
+/**
+ * An operation for the request SNI section.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationSNI = KeepOperation<MatchReplaceOperationSNIRaw>;
 /**
  * A raw operation for the request SNI.
@@ -194,6 +314,10 @@ export type MatchReplaceSectionResponseFirstLine = {
     kind: "SectionResponseFirstLine";
     operation: MatchReplaceOperationFirstLine;
 };
+/**
+ * An operation for the first line section.
+ * @category Match and Replace
+ */
 export type MatchReplaceOperationFirstLine = KeepOperation<MatchReplaceOperationFirstLineRaw>;
 /**
  * A raw operation for the request first line.
@@ -204,6 +328,10 @@ export type MatchReplaceOperationFirstLineRaw = {
     matcher: MatchReplaceMatcherRaw;
     replacer: MatchReplaceReplacer;
 };
+/**
+ * A matcher that matches by name (for headers, query parameters, etc.).
+ * @category Match and Replace
+ */
 export type MatchReplaceMatcherName = {
     kind: "MatcherName";
     name: string;
@@ -286,6 +414,10 @@ export declare const MatchReplaceSlot: {
     readonly CreateHeader: "create-header";
 };
 export type MatchReplaceSlot = (typeof MatchReplaceSlot)[keyof typeof MatchReplaceSlot];
+/**
+ * Content that can be added to match and replace slots.
+ * @category Match and Replace
+ */
 export type MatchReplaceSlotContent = {
     [MatchReplaceSlot.UpdateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
     [MatchReplaceSlot.CreateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;

package/src/types/types/navigation.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Available route identifiers in Caido.
+ * @category Navigation
+ */
 export declare const Routes: {
     readonly Sitemap: "Sitemap";
     readonly Intercept: "Intercept";
@@ -23,6 +27,10 @@ export declare const Routes: {
     readonly Settings: "Settings";
 };
 export type Routes = (typeof Routes)[keyof typeof Routes];
+/**
+ * Event fired when the page changes.
+ * @category Navigation
+ */
 export type PageChangeEvent = {
     type: "Core";
     routeId: Routes;

package/src/types/types/request.d.ts

@@ -1,4 +1,8 @@
 import { type As, type ComponentDefinition, type ID, type Prettify } from "./utils";
+/**
+ * A draft request that has not yet been saved to the database.
+ * @category Request
+ */
 export type RequestDraft = Prettify<As<"RequestDraft"> & {
     host: string;
     port: number;
@@ -7,6 +11,10 @@ export type RequestDraft = Prettify<As<"RequestDraft"> & {
     isTls: boolean;
     raw: string;
 }>;
+/**
+ * Metadata about a request without the raw content.
+ * @category Request
+ */
 export type RequestMeta = Prettify<As<"RequestMeta"> & {
     id: ID;
     host: string;
@@ -16,6 +24,10 @@ export type RequestMeta = Prettify<As<"RequestMeta"> & {
     isTls: boolean;
     streamId: ID | undefined;
 }>;
+/**
+ * A complete request with all metadata and raw content.
+ * @category Request
+ */
 export type RequestFull = Prettify<As<"RequestFull"> & {
     id: ID;
     host: string;
@@ -26,6 +38,10 @@ export type RequestFull = Prettify<As<"RequestFull"> & {
     streamId: ID | undefined;
     raw: string;
 }>;
+/**
+ * Options for defining a custom request view mode.
+ * @category Request
+ */
 export type RequestViewModeOptions = {
     /**
      * The label of the view mode.

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

@@ -3,19 +3,39 @@ import { type ComponentDefinition, type Prettify } from "./utils";
 type DefineSlotContent<TType extends string, P extends Record<string, unknown>> = Prettify<{
     type: TType;
 } & P>;
+/**
+ * Content for a button slot.
+ * @category Slots
+ */
 export type ButtonSlotContent = DefineSlotContent<"Button", {
     label: string;
     icon?: string;
     onClick: () => void;
 }>;
+/**
+ * Content for a custom component slot.
+ * @category Slots
+ */
 export type CustomSlotContent = DefineSlotContent<"Custom", {
     definition: ComponentDefinition;
 }>;
+/**
+ * Content for a command slot.
+ * @category Slots
+ */
 export type CommandSlotContent = DefineSlotContent<"Command", {
     commandId: CommandID;
     icon?: string;
 }>;
+/**
+ * Union type of all possible slot content types.
+ * @category Slots
+ */
 export type SlotContent = ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+/**
+ * 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;
 };

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

@@ -1,6 +1,7 @@
 import { type Component as VueComponent } from "vue";
 /**
  * A unique Caido identifier per type.
+ * @category Utils
  */
 export type ID = string & {
     __id?: never;
@@ -8,6 +9,7 @@ export type ID = string & {
 /**
  * An HTTPQL expression.
  * @example `req.method.eq:"POST"`
+ * @category Utils
  */
 export type HTTPQL = string & {
     __httpql?: never;
@@ -15,22 +17,28 @@ export type HTTPQL = string & {
 /**
  * A {@link https://fontawesome.com/icons|FontAwesome} icon class.
  * @example "fas fa-rocket"
+ * @category Utils
  */
 export type Icon = string & {
     __icon?: never;
 };
 /**
  * A custom component that will be rendered in the UI.
- *
+ * @category Utils
  */
 export type ComponentDefinition = {
     component: VueComponent;
     props?: Record<string, unknown>;
     events?: Record<string, (...args: unknown[]) => void>;
 };
+/**
+ * Utility type for converting endpoint return types to promises.
+ * @category Utils
+ */
 export type PromisifiedReturnType<T extends (...args: unknown[]) => unknown> = ReturnType<T> extends Promise<infer U> ? Promise<U> : Promise<ReturnType<T>>;
 /**
  * A handle for a listener.
+ * @category Utils
  */
 export type ListenerHandle = {
     /**
@@ -38,9 +46,17 @@ export type ListenerHandle = {
      */
     stop: () => void;
 };
+/**
+ * Utility type that prettifies complex types for better IDE display.
+ * @category Utils
+ */
 export type Prettify<T> = {
     [K in keyof T]: T[K];
 } & {};
+/**
+ * Utility type that adds a type discriminator to a type.
+ * @category Utils
+ */
 export type As<TType extends string> = {
     type: TType;
 };

package/src/types/types/window.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Options for configuring a dialog.
+ * @category Window
+ */
 export type DialogOptions = {
     title?: string;
     draggable?: boolean;
@@ -6,6 +10,10 @@ export type DialogOptions = {
     modal?: boolean;
     position?: "left" | "right" | "top" | "bottom" | "center" | "topleft" | "topright" | "bottomleft" | "bottomright";
 };
+/**
+ * A dialog instance that can be closed programmatically.
+ * @category Window
+ */
 export type Dialog = {
     close: () => void;
 };

package/src/types/types/workflows.d.ts

@@ -14,12 +14,24 @@ export type Workflow = {
  * @category Workflows
  */
 export type WorkflowKind = "Convert" | "Active" | "Passive";
+/**
+ * Callback function called when a workflow is created.
+ * @category Workflows
+ */
 export type OnCreatedWorkflowCallback = (event: {
     workflow: Workflow;
 }) => void;
+/**
+ * Callback function called when a workflow is updated.
+ * @category Workflows
+ */
 export type OnUpdatedWorkflowCallback = (event: {
     workflow: Workflow;
 }) => void;
+/**
+ * Callback function called when a workflow is deleted.
+ * @category Workflows
+ */
 export type OnDeletedWorkflowCallback = (event: {
     id: ID;
 }) => void;