@caido/sdk-frontend 0.48.2-beta.10 → 0.48.2-beta.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "0.48.2-beta.10",
+  "version": "0.48.2-beta.11",
   "description": "Typing for the Caido Frontend SDK",
   "author": "Caido Labs Inc. <dev@caido.io>",
   "license": "MIT",

package/src/types/footer.d.ts

@@ -0,0 +1,43 @@
+import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent, type DefineAddToSlotFn } from "./slots";
+export declare const FooterSlot: {
+    readonly FooterSlotPrimary: "footer-primary";
+    readonly FooterSlotSecondary: "footer-secondary";
+};
+export type FooterSlot = (typeof FooterSlot)[keyof typeof FooterSlot];
+/**
+ * Utilities to interact with the footer.
+ * @category Footer
+ */
+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.
+     * @example
+     * ```ts
+     * addToSlot(FooterSlot.FooterSlotPrimary, {
+     *   kind: "Command",
+     *   commandId: "my-command",
+     *   icon: "my-icon",
+     * });
+     *
+     * addToSlot(FooterSlot.FooterSlotPrimary, {
+     *   kind: "Button",
+     *   label: "My button",
+     *   icon: "fas fa-rocket",
+     *   onClick: () => {
+     *     console.log("Button clicked");
+     *   },
+     * });
+     *
+     * addToSlot(FooterSlot.FooterSlotSecondary, {
+     *   kind: "Custom",
+     *   component: MyComponent,
+     * });
+     * ```
+     */
+    addToSlot: DefineAddToSlotFn<{
+        [FooterSlot.FooterSlotPrimary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+        [FooterSlot.FooterSlotSecondary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+    }>;
+};

package/src/types/index.d.ts

@@ -7,6 +7,7 @@ import type { EnvironmentSDK } from "./environment";
 import type { FilesSDK } from "./files";
 import type { FiltersSDK } from "./filters";
 import type { FindingsSDK } from "./findings";
+import type { FooterSDK } from "./footer";
 import type { HTTPHistorySDK } from "./httpHistory";
 import type { InterceptSDK } from "./intercept";
 import type { MatchReplaceSDK } from "./matchReplace";
@@ -23,6 +24,7 @@ import type { StorageSDK } from "./storage";
 import type { UISDK } from "./ui";
 import type { WindowSDK } from "./window";
 import type { WorkflowSDK } from "./workflows";
+export { FooterSlot } from "./footer";
 export type { DialogOptions } from "./window";
 export type { CommandContext } from "./commands";
 export type { MenuItem } from "./menu";
@@ -141,4 +143,8 @@ export type API<T extends BackendEndpoints = Record<string, never>, E extends Ba
      * Utilities to interact with workflows.
      */
     workflows: WorkflowSDK;
+    /**
+     * Utilities to interact with the footer.
+     */
+    footer: FooterSDK;
 };