@caido/sdk-frontend 0.56.1-beta.5 → 0.56.1

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

@@ -1,5 +1,4 @@
-import { type EditorView } from "@codemirror/view";
-import { type As, type ComponentDefinition, type ComponentPropsWithSdk, type ID, type Prettify } from "./utils";
+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
@@ -39,43 +38,11 @@ export type RequestFull = Prettify<As<"RequestFull"> & {
     streamId: ID | undefined;
     raw: string;
 }>;
-/**
- * The internal props for the request read-only view mode.
- * @category Request
- */
-export type RequestReadableViewModePropsInternal = {
-    request: RequestFull;
-    view: EditorView;
-};
-/**
- * The internal props for the request writable view mode.
- * @category Request
- */
-export type RequestWritableViewModePropsInternal = {
-    request: RequestFull | undefined;
-    draft: RequestDraft;
-    view: EditorView;
-};
-/**
- * The props for the request writable view mode.
- * @category Request
- */
-export type RequestWritableViewModeProps = ComponentPropsWithSdk<RequestWritableViewModePropsInternal>;
-/**
- * The props for the request read-only view mode.
- * @category Request
- */
-export type RequestReadableViewModeProps = ComponentPropsWithSdk<RequestReadableViewModePropsInternal>;
-/**
- * The props group for the request view mode.
- * @category Request
- */
-export type RequestViewModeProps = RequestReadableViewModeProps | RequestWritableViewModeProps | RequestReadableViewModePropsInternal | RequestWritableViewModePropsInternal;
 /**
  * Options for defining a custom request view mode.
  * @category Request
  */
-export type RequestViewModeOptions<TProps extends RequestViewModeProps> = {
+export type RequestViewModeOptions = {
     /**
      * The label of the view mode.
      */
@@ -83,7 +50,7 @@ export type RequestViewModeOptions<TProps extends RequestViewModeProps> = {
     /**
      * The component to render when the view mode is selected.
      */
-    view: ComponentDefinition<TProps>;
+    view: ComponentDefinition;
     /**
      * A function that determines if the view mode should be shown for a given request.
      */

package/src/types/types/response.d.ts

@@ -1,6 +1,5 @@
-import { type EditorView } from "@codemirror/view";
 import type { RequestFull, RequestMeta } from "./request";
-import type { As, ComponentDefinition, ComponentPropsWithSdk, ID, Prettify } from "./utils";
+import type { As, ComponentDefinition, ID, Prettify } from "./utils";
 /**
  * A complete response with all metadata and raw content.
  * @category Response
@@ -13,24 +12,11 @@ export type ResponseFull = Prettify<As<"ResponseFull"> & {
     length: number;
     createdAt: Date;
 }>;
-/**
- * The internal props for the response view mode.
- * @category Response
- */
-export type ResponseViewModePropsInternal = {
-    response: ResponseFull;
-    view: EditorView;
-};
-/**
- * The props for the response view mode.
- * @category Response
- */
-export type ResponseViewModeProps = ComponentPropsWithSdk<ResponseViewModePropsInternal>;
 /**
  * Options for defining a custom response view mode.
  * @category Response
  */
-export type ResponseViewModeOptions<TProps extends ResponseViewModeProps | ResponseViewModePropsInternal> = {
+export type ResponseViewModeOptions = {
     /**
      * The label of the view mode.
      */
@@ -38,7 +24,7 @@ export type ResponseViewModeOptions<TProps extends ResponseViewModeProps | Respo
     /**
      * The component to render when the view mode is selected.
      */
-    view: ComponentDefinition<TProps>;
+    view: ComponentDefinition;
     /**
      * A function that determines if the view mode should be shown for a given response.
      */

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

@@ -1,4 +1,4 @@
-import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent, type SlotContentProps, type SlotContentPropsGroup } from "./slots";
+import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent } from "./slots";
 import { type ID, type Selection } from "./utils";
 /**
  * Represents a scope.
@@ -37,12 +37,9 @@ export declare const ScopeSlot: {
     readonly CreateHeader: "create-header";
 };
 export type ScopeSlot = (typeof ScopeSlot)[keyof typeof ScopeSlot];
-/**
- * Content that can be added to scope slots.
- * @category Scopes
- */
-export type ScopeSlotContent<TProps extends SlotContentPropsGroup = SlotContentProps> = {
-    [K in ScopeSlot]: ButtonSlotContent | CustomSlotContent<TProps> | CommandSlotContent;
+export type ScopeSlotContent = {
+    [ScopeSlot.UpdateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+    [ScopeSlot.CreateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
 };
 /**
  * Event fired when the current scope changes.

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

@@ -1,4 +1,4 @@
-import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent, type SlotContentProps, type SlotContentPropsGroup } from "./slots";
+import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent } from "./slots";
 /**
  * The slots in the Search UI.
  * @category Search
@@ -10,12 +10,8 @@ export declare const SearchSlot: {
     readonly ToolbarPrimary: "search-toolbar-primary";
 };
 export type SearchSlot = (typeof SearchSlot)[keyof typeof SearchSlot];
-/**
- * Content that can be added to search slots.
- * @category Search
- */
-export type SearchSlotContent<TProps extends SlotContentPropsGroup = SlotContentProps> = {
-    [K in SearchSlot]: ButtonSlotContent | CustomSlotContent<TProps> | CommandSlotContent;
+export type SearchSlotContent = {
+    [SearchSlot.ToolbarPrimary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
 };
 /**
  * Search page context.

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

@@ -1,23 +1,8 @@
 import { type CommandID } from "./commands";
-import { type ComponentDefinition, type ComponentPropsWithSdk, type Prettify } from "./utils";
+import { type ComponentDefinition, type Prettify } from "./utils";
 type DefineSlotContent<TType extends string, P extends Record<string, unknown>> = Prettify<{
     type: TType;
 } & P>;
-/**
- * The internal props for a slot content.
- * @category Slots
- */
-export type SlotContentPropsInternal = {};
-/**
- * The props for a slot content.
- * @category Slots
- */
-export type SlotContentProps = ComponentPropsWithSdk<SlotContentPropsInternal>;
-/**
- * The props group for a slot content.
- * @category Slots
- */
-export type SlotContentPropsGroup = SlotContentProps | SlotContentPropsInternal;
 /**
  * Content for a button slot.
  * @category Slots
@@ -31,8 +16,8 @@ export type ButtonSlotContent = DefineSlotContent<"Button", {
  * Content for a custom component slot.
  * @category Slots
  */
-export type CustomSlotContent<TProps extends SlotContentPropsGroup = SlotContentProps> = DefineSlotContent<"Custom", {
-    definition: ComponentDefinition<TProps>;
+export type CustomSlotContent = DefineSlotContent<"Custom", {
+    definition: ComponentDefinition;
 }>;
 /**
  * Content for a command slot.
@@ -46,7 +31,7 @@ export type CommandSlotContent = DefineSlotContent<"Command", {
  * Union type of all possible slot content types.
  * @category Slots
  */
-export type SlotContent<TProps extends SlotContentPropsGroup = SlotContentProps> = ButtonSlotContent | CustomSlotContent<TProps> | CommandSlotContent;
+export type SlotContent = ButtonSlotContent | CustomSlotContent | CommandSlotContent;
 /**
  * A function type for adding content to slots.
  * @category Slots

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

@@ -1,5 +1,4 @@
 import { type Component as VueComponent } from "vue";
-import { type API } from "../index";
 /**
  * A unique Caido identifier per type.
  * @category Utils
@@ -15,21 +14,6 @@ export type ID = string & {
 export type HTTPQL = string & {
     __httpql?: never;
 };
-/**
- * A STREAMQL expression.
- * @example `ws.raw.cont:"hello"`
- * @category Utils
- */
-export type StreamQL = string & {
-    __streamql?: never;
-};
-/**
- * A query input.
- * @example `"req.method.eq:'POST'"`
- * @example `"ws.raw.cont:'hello'"`
- * @category Utils
- */
-export type QueryInput = HTTPQL | StreamQL;
 /**
  * A {@link https://fontawesome.com/icons|FontAwesome} icon class.
  * @example "fas fa-rocket"
@@ -38,25 +22,13 @@ export type QueryInput = HTTPQL | StreamQL;
 export type Icon = string & {
     __icon?: never;
 };
-/**
- * A set of properties that can be passed to a component.
- * @category Utils
- */
-export type ComponentProps = Record<string, unknown>;
-/**
- * A set of properties that can be passed to a component definition with the SDK.
- * @category Utils
- */
-export type ComponentPropsWithSdk<TProps extends ComponentProps> = TProps & {
-    sdk: API;
-};
 /**
  * A custom component that will be rendered in the UI.
  * @category Utils
  */
-export type ComponentDefinition<TProps = ComponentProps> = {
-    component: VueComponent<TProps>;
-    props?: TProps;
+export type ComponentDefinition = {
+    component: VueComponent;
+    props?: Record<string, unknown>;
     events?: Record<string, (...args: unknown[]) => void>;
 };
 /**

package/src/types/types/websocket.d.ts

@@ -1,5 +1,3 @@
-import { type EditorView } from "@codemirror/view";
-import type { As, ComponentDefinition, ComponentPropsWithSdk, ID, Prettify } from "./utils";
 /**
  * Certificate page context.
  * @category Websockets
@@ -7,49 +5,3 @@ import type { As, ComponentDefinition, ComponentPropsWithSdk, ID, Prettify } fro
 export type WebsocketPageContext = {
     kind: "Websocket";
 };
-/**
- * A complete message with all metadata and raw content.
- * @category Websockets
- */
-export type StreamWsMessageMeta = Prettify<As<"StreamWsMessageMeta"> & {
-    id: ID;
-    streamId: ID;
-    head: {
-        id: ID;
-        length: number;
-        direction: "CLIENT" | "SERVER";
-        format: "BINARY" | "CLOSE" | "PING" | "PONG" | "TEXT";
-        createdAt: Date;
-    };
-}>;
-/**
- * The internal props for the message view mode.
- * @category Websockets
- */
-export type MessageViewModePropsInternal = {
-    message: StreamWsMessageMeta;
-    view: EditorView;
-};
-/**
- * The props for the message view mode.
- * @category Websockets
- */
-export type MessageViewModeProps = ComponentPropsWithSdk<MessageViewModePropsInternal>;
-/**
- * Options for defining a custom message view mode.
- * @category Websockets
- */
-export type MessageViewModeOptions<TProps extends MessageViewModeProps | MessageViewModePropsInternal> = {
-    /**
-     * The label of the view mode.
-     */
-    label: string;
-    /**
-     * The component to render when the view mode is selected.
-     */
-    view: ComponentDefinition<TProps>;
-    /**
-     * A function that determines if the view mode should be shown for a given message.
-     */
-    when?: (message: StreamWsMessageMeta) => boolean;
-};

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

@@ -15,7 +15,6 @@ import type { ReplayPageContext } from "./replay";
 import type { ScopePageContext } from "./scopes";
 import type { SearchPageContext } from "./search";
 import type { SitemapPageContext } from "./sitemap";
-import type { ComponentDefinition, ComponentProps, ComponentPropsWithSdk } from "./utils";
 import { type WebsocketPageContext } from "./websocket";
 import type { WorkflowsPageContext } from "./workflows";
 /**
@@ -30,11 +29,6 @@ export type DialogOptions = {
     modal?: boolean;
     position?: "left" | "right" | "top" | "bottom" | "center" | "topleft" | "topright" | "bottomleft" | "bottomright";
 };
-/**
- * The component definition for a dialog.
- * @category Window
- */
-export type DialogComponent = ComponentDefinition<ComponentPropsWithSdk<ComponentProps>>;
 /**
  * A dialog instance that can be closed programmatically.
  * @category Window

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

@@ -1,12 +0,0 @@
-import type { MessageViewModeOptions, MessageViewModeProps } from "../types/websocket";
-/**
- * Utilities to interact with websockets
- * @category Websockets
- */
-export type WebsocketSDK = {
-    /**
-     * Add a custom message view mode.
-     * @param options The view mode options.
-     */
-    addMessageViewMode: (options: MessageViewModeOptions<MessageViewModeProps>) => void;
-};

package/src/types/types/commandPalette.d.ts

@@ -1,20 +0,0 @@
-import { type ComponentPropsWithSdk } from "./utils";
-/**
- * The internal props for the command palette view.
- * @category Command Palette
- */
-export type CommandPaletteViewPropsInternal = {
-    /**
-     * The function to call when the command palette is closed.
-     */
-    onClose: () => void;
-    /**
-     * The function to call when the command palette is backed.
-     */
-    onBack: () => void;
-};
-/**
- * The props for the command palette view.
- * @category Command Palette
- */
-export type CommandPaletteViewProps = ComponentPropsWithSdk<CommandPaletteViewPropsInternal>;