@caido/sdk-frontend 0.48.2-beta.0 → 0.48.2-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "0.48.2-beta.0",
+  "version": "0.48.2-beta.1",
   "description": "Typing for the Caido Frontend SDK",
   "author": "Caido Labs Inc. <dev@caido.io>",
   "license": "MIT",
@@ -12,7 +12,8 @@
   ],
   "peerDependencies": {
     "@codemirror/view": "^6.0.0",
-    "@codemirror/state": "^6.0.0"
+    "@codemirror/state": "^6.0.0",
+    "vue": "^3.0.0"
   },
   "peerDependenciesMeta": {},
   "scripts": {

package/src/types/commandPalette.d.ts

@@ -5,6 +5,7 @@
 export type CommandPaletteSDK = {
     /**
      * Register a command.
+     * @deprecated Use `sdk.commandPalette.addToSlot` instead.
      * @param commandId The id of the command to register.
      */
     register: (commandId: string) => void;

package/src/types/index.d.ts

@@ -25,10 +25,11 @@ import type { WindowSDK } from "./window";
 import type { WorkflowSDK } from "./workflows";
 export type { CommandContext } from "./commands";
 export type { MenuItem } from "./menu";
-export type { ReplayTab, ReplaySession, ReplayCollection } from "./replay";
+export { type ReplayTab, type ReplaySession, type ReplayCollection, ReplaySlot, } from "./replay";
 export type { HostedFile } from "./files";
 export type { Filter } from "./filters";
 export type { HTTPQL, ID, JSONValue, JSONCompatible } from "./utils";
+export type { SlotContent, ButtonSlotContent, CustomSlotContent, CommandSlotContent, } from "./slots";
 export type { MatchReplaceRule, MatchReplaceCollection, MatchReplaceSection, MatchReplaceSectionRequestBody, MatchReplaceSectionRequestFirstLine, MatchReplaceSectionRequestHeader, MatchReplaceSectionRequestMethod, MatchReplaceSectionRequestPath, MatchReplaceSectionRequestQuery, MatchReplaceSectionResponseBody, MatchReplaceSectionResponseFirstLine, MatchReplaceSectionResponseHeader, MatchReplaceSectionResponseStatusCode, MatchReplaceOperationStatusCode, MatchReplaceOperationStatusCodeUpdate, MatchReplaceOperationQuery, MatchReplaceOperationQueryRaw, MatchReplaceOperationQueryAdd, MatchReplaceOperationQueryRemove, MatchReplaceOperationQueryUpdate, MatchReplaceOperationPath, MatchReplaceOperationPathRaw, MatchReplaceOperationMethod, MatchReplaceOperationMethodUpdate, MatchReplaceOperationHeader, MatchReplaceOperationHeaderRaw, MatchReplaceOperationHeaderAdd, MatchReplaceOperationHeaderRemove, MatchReplaceOperationHeaderUpdate, MatchReplaceOperationBody, MatchReplaceOperationBodyRaw, MatchReplaceOperationFirstLine, MatchReplaceOperationFirstLineRaw, MatchReplaceReplacer, MatchReplaceReplacerTerm, MatchReplaceReplacerWorkflow, MatchReplaceMatcherName, MatchReplaceMatcherRaw, MatchReplaceMatcherRawFull, MatchReplaceMatcherRawRegex, MatchReplaceMatcherRawValue, } from "./matchReplace";
 export type { Scope } from "./scopes";
 export type { EnvironmentVariable } from "./environment";

package/src/types/replay.d.ts

@@ -1,4 +1,9 @@
+import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent, type DefineAddToSlotFn } from "./slots";
 import type { ID } from "./utils";
+export declare const ReplaySlot: {
+    readonly SessionToolbar: "session-toolbar";
+};
+export type ReplaySlot = (typeof ReplaySlot)[keyof typeof ReplaySlot];
 /**
  * A replay tab.
  * @category Replay
@@ -112,4 +117,12 @@ export type ReplaySDK = {
      * @returns Whether the collection was deleted.
      */
     deleteCollection: (id: ID) => Promise<boolean>;
+    /**
+     * Add a component to a slot.
+     * @param slot The slot to add the component to.
+     * @param content The content to add to the slot.
+     */
+    addToSlot: DefineAddToSlotFn<{
+        [ReplaySlot.SessionToolbar]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+    }>;
 };

package/src/types/slots.d.ts

@@ -0,0 +1,22 @@
+import { type Component } from "vue";
+import { type CommandID } from "./utils";
+type DefineSlotContent<TType extends string, P extends Record<string, unknown>> = {
+    type: TType;
+} & P;
+export type ButtonSlotContent = DefineSlotContent<"Button", {
+    label: string;
+    icon?: string;
+    onClick: () => void;
+}>;
+export type CustomSlotContent<TProps extends Record<string, unknown> = Record<string, unknown>> = DefineSlotContent<"Custom", {
+    component: Component<TProps>;
+}>;
+export type CommandSlotContent = DefineSlotContent<"Command", {
+    commandId: CommandID;
+    icon?: string;
+}>;
+export type SlotContent = ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+export type DefineAddToSlotFn<TMap extends Record<string, DefineSlotContent<string, Record<string, unknown>>>> = {
+    <K extends keyof TMap>(slot: K, spec: TMap[K]): void;
+};
+export {};