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

package/package.json

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

package/src/types/index.d.ts

@@ -1,6 +1,6 @@
 export { FooterSlot, type FooterSlotContent } from "./types/footer";
 export type { DialogOptions } from "./types/window";
-export type { CommandContext } from "./types/commands";
+export type { CommandContext, CommandContextRequest, CommandContextRequestRow, CommandContextResponse, CommandContextBase, } from "./types/commands";
 export type { MenuItem } from "./types/menu";
 export { type ReplayTab, type ReplaySession, type ReplayCollection, type SendRequestOptions, ReplaySlot, type ReplaySlotContent, type RequestSource, } from "./types/replay";
 export type { HostedFile } from "./types/files";
@@ -8,7 +8,7 @@ export type { Filter } from "./types/filter";
 export type { HTTPQL, ID, ComponentDefinition } from "./types/utils";
 export type { JSONValue, JSONCompatible } from "./types/json";
 export type { SlotContent, ButtonSlotContent, CustomSlotContent, CommandSlotContent, } from "./types/slots";
-export type { RequestViewModeOptions } from "./types/request";
+export type { RequestViewModeOptions, RequestFull, RequestDraft, RequestMeta, } from "./types/request";
 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 "./types/matchReplace";
 export type { Scope } from "./types/scopes";
 export type { EnvironmentVariable } from "./types/environment";

package/src/types/types/commands.d.ts

@@ -1,3 +1,4 @@
+import { type RequestDraft, type RequestFull, type RequestMeta } from "./request";
 import { type ID } from "./utils";
 /**
  * A unique command identifier.
@@ -16,48 +17,31 @@ export type CommandContext = CommandContextBase | CommandContextRequestRow | Com
  * This context is used for commands that are not executed in a specific context, such as via shortcuts and the command palette.
  * @category Commands
  */
-type CommandContextBase = {
+export type CommandContextBase = {
     type: "BaseContext";
 };
 /**
  * The context for a command that is executed on a row in the request table.
  * @category Commands
  */
-type CommandContextRequestRow = {
+export type CommandContextRequestRow = {
     type: "RequestRowContext";
     /**
      * The requests that are selected in the request table.
      */
-    requests: {
-        id: ID;
-        host: string;
-        port: number;
-        path: string;
-        query: string;
-        isTls: boolean;
-        streamId?: ID;
-    }[];
+    requests: RequestMeta[];
 };
 /**
  * The context for a command that is executed on a request pane.
  * @category Commands
  */
-type CommandContextRequest = {
+export type CommandContextRequest = {
     type: "RequestContext";
     /**
      * The request that is currently open in the request pane.
      * If the request has not yet been saved in the database, the id will be undefined.
      */
-    request: {
-        id: ID | undefined;
-        host: string;
-        port: number;
-        path: string;
-        query: string;
-        isTls: boolean;
-        raw: string;
-        streamId?: ID;
-    };
+    request: RequestDraft | RequestFull;
     /**
      * The currently selected text in the request pane.
      */
@@ -67,20 +51,12 @@ type CommandContextRequest = {
  * The context for a command that is executed on a response pane.
  * @category Commands
  */
-type CommandContextResponse = {
+export type CommandContextResponse = {
     type: "ResponseContext";
     /**
      * The request that is associated with the response.
      */
-    request: {
-        id: ID;
-        host: string;
-        port: number;
-        path: string;
-        query: string;
-        isTls: boolean;
-        streamId?: ID;
-    };
+    request: RequestMeta;
     /**
      * The response that is currently open in the response pane.
      */
@@ -95,4 +71,3 @@ type CommandContextResponse = {
      */
     selection: string;
 };
-export {};

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

@@ -1,4 +1,31 @@
-import { type ComponentDefinition } from "./utils";
+import { type As, type ComponentDefinition, type ID, type Prettify } from "./utils";
+export type RequestDraft = Prettify<As<"RequestDraft"> & {
+    host: string;
+    port: number;
+    path: string;
+    query: string;
+    isTls: boolean;
+    raw: string;
+}>;
+export type RequestMeta = Prettify<As<"RequestMeta"> & {
+    id: ID;
+    host: string;
+    port: number;
+    path: string;
+    query: string;
+    isTls: boolean;
+    streamId: ID | undefined;
+}>;
+export type RequestFull = Prettify<As<"RequestFull"> & {
+    id: ID;
+    host: string;
+    port: number;
+    path: string;
+    query: string;
+    isTls: boolean;
+    streamId: ID | undefined;
+    raw: string;
+}>;
 export type RequestViewModeOptions = {
     /**
      * The label of the view mode.

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

@@ -38,3 +38,9 @@ export type ListenerHandle = {
      */
     stop: () => void;
 };
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+export type As<TType extends string> = {
+    type: TType;
+};