@caido/sdk-frontend 0.41.1-beta.2 → 0.41.1-beta.4

package/src/types/sidebar.d.ts

@@ -1,10 +1,41 @@
+import type { Icon } from "./utils";
+/**
+ * Utilities to interact with the sidebar.
+ * @category Sidebar
+ */
+export type SidebarSDK = {
+    /**
+     * Register a sidebar item.
+     * @param name The name of the sidebar item.
+     * @param path The path that the user will be navigated to when the sidebar item is clicked.
+     * @param options Options for the sidebar item.
+     * @param options.icon The {@link Icon} of the sidebar item.
+     * @param options.group The group the sidebar item belongs to.
+     * @param options.isExternal Whether the path points to an external URL.
+     * @returns The created sidebar item.
+     *
+     * @example
+     * ```ts
+     * sdk.sidebar.registerItem("My Plugin", "/my-plugin-page", {
+     *   icon: "fas fa-rocket",
+     * });
+     * ```
+     */
+    registerItem: (name: string, path: string, options?: {
+        icon?: Icon;
+        group?: string;
+        isExternal?: boolean;
+    }) => SidebarItem;
+};
 /**
  * Represents a sidebar item.
+ * @category Sidebar
  */
-export type SidebarItem = {
+type SidebarItem = {
     /**
      * Set the value of a notification badge next to the sidebar item.
      * @param count - The number to display in the badge. A value of 0 will hide the badge.
      */
     setCount: (count: number) => void;
 };
+export {};

package/src/types/storage.d.ts

@@ -0,0 +1,23 @@
+import type { JSONCompatible, JSONValue } from "./utils";
+/**
+ * Utilities to interact with frontend-plugin storage.
+ * @category Storage
+ */
+export type StorageSDK = {
+    /**
+     * Get the storage.
+     * @returns The storage.
+     */
+    get: () => JSONValue;
+    /**
+     * Set the storage.
+     * @param value The value to set the storage to
+     * @returns A promise that resolves when the storage has been set.
+     */
+    set: <T>(value: JSONCompatible<T>) => Promise<void>;
+    /**
+     * Subscribe to storage changes.
+     * @param callback The callback to call when the storage changes.
+     */
+    onChange: (callback: (value: JSONValue) => void) => void;
+};

package/src/types/ui.d.ts

@@ -0,0 +1,71 @@
+import type { HTTPRequestEditor, HTTPResponseEditor } from "./editor";
+import type { Icon } from "./utils";
+/**
+ * Utilities to create UI components.
+ * @category UI
+ */
+export type UISDK = {
+    /**
+     * Create a button.
+     * @param options Options for the button.
+     * @param options.variant The variant of the button.
+     * @param options.label The label of the button.
+     * @param options.leadingIcon The leading icon of the button.
+     * @param options.trailingIcon The trailing icon of the button.
+     * @param options.size The size of the button.
+     * @returns The button element.
+     *
+     * @example
+     * ```ts
+     * const deleteButton = sdk.ui.button({
+     *   variant: "primary",
+     *   label: "Delete",
+     *   trailingIcon: "fas fa-trash-can",
+     *   size: "small",
+     * });
+     * ```
+     */
+    button: (options?: {
+        variant?: "primary" | "secondary" | "tertiary";
+        label?: string;
+        leadingIcon?: Icon;
+        trailingIcon?: Icon;
+        size?: "small" | "medium" | "large";
+    }) => HTMLElement;
+    /**
+     * Create a card.
+     * @param options Options for the card.
+     * @param options.header The header of the card.
+     * @param options.body The body of the card.
+     * @param options.footer The footer of the card.
+     * @returns The card element.
+     */
+    card: (options?: {
+        header?: HTMLElement;
+        body?: HTMLElement;
+        footer?: HTMLElement;
+    }) => HTMLElement;
+    /**
+     * Create a well.
+     * @param options Options for the well.
+     * @param options.header The header of the well.
+     * @param options.body The body of the well.
+     * @param options.footer The footer of the well.
+     * @returns The well element.
+     */
+    well: (options?: {
+        header?: HTMLElement;
+        body?: HTMLElement;
+        footer?: HTMLElement;
+    }) => HTMLElement;
+    /**
+     * Create an HTTP request editor
+     * @returns The HTTP request editor.
+     */
+    httpRequestEditor: () => HTTPRequestEditor;
+    /**
+     * Create an HTTP response editor
+     * @returns The HTTP response editor.
+     */
+    httpResponseEditor: () => HTTPResponseEditor;
+};

package/src/types/utils.d.ts

@@ -1,4 +1,24 @@
 type JSONPrimitive = string | number | boolean | null | undefined;
+/**
+ * A unique Caido identifier per type.
+ */
+export type ID = string & {
+    __id?: never;
+};
+/**
+ * A unique command identifier.
+ * @example "my-super-command"
+ */
+export type CommandID = string & {
+    __commandId?: never;
+};
+/**
+ * A {@link https://fontawesome.com/icons|FontAwesome} icon class.
+ * @example "fas fa-rocket"
+ */
+export type Icon = string & {
+    __icon?: never;
+};
 export type JSONValue = JSONPrimitive | JSONValue[] | {
     [key: string]: JSONValue;
 };

package/src/types/window.d.ts

@@ -0,0 +1,23 @@
+import type { Editor } from "./editor";
+/**
+ * Utilities to interact with the active page.
+ * @category Window
+ */
+export type WindowSDK = {
+    /**
+     * Get the active editor.
+     * @returns The active editor.
+     */
+    getActiveEditor: () => Editor | undefined;
+    /**
+     * Show a toast message.
+     * @param message The message to show.
+     * @param options Options for the toast message.
+     * @param options.variant The variant of the toast message.
+     * @param options.duration The duration of the toast message in milliseconds.
+     */
+    showToast: (message: string, options?: {
+        variant?: "success" | "error" | "warning" | "info";
+        duration?: number;
+    }) => void;
+};