@caido/sdk-frontend 0.57.1-beta.1 → 0.57.1-beta.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "0.57.1-beta.1",
+  "version": "0.57.1-beta.4",
   "description": "Typing for the Caido Frontend SDK",
   "author": "Caido Labs Inc. <dev@caido.io>",
   "repository": "https://github.com/caido/sdk-js/",
@@ -13,8 +13,8 @@
   ],
   "peerDependencies": {
     "@ai-sdk/provider": "^3.0.1",
-    "@codemirror/view": "^6.0.0",
     "@codemirror/state": "^6.0.0",
+    "@codemirror/view": "^6.0.0",
     "vue": "^3.0.0"
   },
   "peerDependenciesMeta": {},

package/src/types/__generated__/graphql-sdk.d.ts

@@ -853,11 +853,9 @@ export type CreateReplaySessionPayload = {
     session?: Maybe<ReplaySession>;
 };
 export type CreateRequestInput = {
-    alteration: Alteration;
     host: Scalars["String"]["input"];
     isTls: Scalars["Boolean"]["input"];
     method: Scalars["String"]["input"];
-    parentId?: InputMaybe<Scalars["ID"]["input"]>;
     path: Scalars["String"]["input"];
     port: Scalars["Int"]["input"];
     query: Scalars["String"]["input"];
@@ -871,11 +869,8 @@ export type CreateRequestPayload = {
     responseId?: Maybe<Scalars["ID"]["output"]>;
 };
 export type CreateResponseInput = {
-    alteration: Alteration;
-    parentId?: InputMaybe<Scalars["ID"]["input"]>;
     raw: Scalars["Blob"]["input"];
     roundtripTime: Scalars["Int"]["input"];
-    source: Source;
     statusCode: Scalars["Int"]["input"];
 };
 export type CreateScopeError = InvalidGlobTermsUserError | OtherUserError;
@@ -1974,6 +1969,7 @@ export type MutationRoot = {
     setGlobalConfigProject: SetConfigProjectPayload;
     setInstanceSettings: SetInstanceSettingsPayload;
     setInterceptOptions: SetInterceptOptionsPayload;
+    setPassthroughOptions: SetPassthroughOptionsPayload;
     setPluginData: SetPluginDataPayload;
     setProjectConfigStream: SetProjectConfigStreamPayload;
     startAuthenticationFlow: StartAuthenticationFlowPayload;
@@ -2353,6 +2349,9 @@ export type MutationRootSetInstanceSettingsArgs = {
 export type MutationRootSetInterceptOptionsArgs = {
     input: InterceptOptionsInput;
 };
+export type MutationRootSetPassthroughOptionsArgs = {
+    input: PassthroughOptionsInput;
+};
 export type MutationRootSetPluginDataArgs = {
     data: Scalars["JSON"]["input"];
     id: Scalars["ID"]["input"];
@@ -2532,6 +2531,22 @@ export type PageInfo = {
     /** When paginating backwards, the cursor to continue. */
     startCursor?: Maybe<Scalars["String"]["output"]>;
 };
+export type PassthroughOptions = {
+    passthroughOptions?: Maybe<PassthroughOptionsObject>;
+};
+export type PassthroughOptionsInput = {
+    outofscope: Scalars["Boolean"]["input"];
+    targets: PassthroughTargets;
+};
+export type PassthroughOptionsObject = {
+    allowlist?: Maybe<Array<Scalars["String"]["output"]>>;
+    denylist?: Maybe<Array<Scalars["String"]["output"]>>;
+    outOfScope: Scalars["Boolean"]["output"];
+};
+export type PassthroughTargets = {
+    allowlist?: InputMaybe<Array<Scalars["String"]["input"]>>;
+    denylist?: InputMaybe<Array<Scalars["String"]["input"]>>;
+};
 export type PauseAutomateTaskError = OtherUserError | UnknownIdUserError;
 export type PauseAutomateTaskPayload = {
     automateTask?: Maybe<AutomateTask>;
@@ -2735,6 +2750,7 @@ export type QueryRoot = {
     interceptMessages: InterceptMessageConnection;
     interceptOptions: InterceptOptions;
     interceptStatus: InterceptStatus;
+    passthroughOptions: PassthroughOptions;
     pluginPackages: Array<PluginPackage>;
     projects: Array<Project>;
     replayEntry?: Maybe<ReplayEntry>;
@@ -3587,6 +3603,9 @@ export type SetInstanceSettingsPayload = {
 export type SetInterceptOptionsPayload = {
     options: InterceptOptions;
 };
+export type SetPassthroughOptionsPayload = {
+    options: PassthroughOptions;
+};
 export type SetPluginDataError = OtherUserError | PluginUserError | UnknownIdUserError;
 export type SetPluginDataPayload = {
     error?: Maybe<SetPluginDataError>;
@@ -3975,6 +3994,7 @@ export type SubscriptionRoot = {
     updatedInterceptEntry: UpdatedInterceptEntryPayload;
     updatedInterceptOptions: UpdatedInterceptOptionsPayload;
     updatedInterceptStatus: UpdatedInterceptStatusPayload;
+    updatedPassthroughOptions: UpdatedPassthroughOptionsPayload;
     updatedPlugin: UpdatedPluginPayload;
     updatedPluginPackage: UpdatedPluginPackagePayload;
     updatedProject: UpdatedProjectPayload;
@@ -5046,6 +5066,9 @@ export type UpdatedInterceptOptionsPayload = {
 export type UpdatedInterceptStatusPayload = {
     status: InterceptStatus;
 };
+export type UpdatedPassthroughOptionsPayload = {
+    options: PassthroughOptions;
+};
 export type UpdatedPluginPackagePayload = {
     package: PluginPackage;
 };
@@ -9086,6 +9109,11 @@ export type UpdatedEnvironmentSubscription = {
             id: string;
             name: string;
             version: number;
+            variables: Array<{
+                name: string;
+                value: string;
+                kind: EnvironmentVariableKind;
+            }>;
         };
     };
 };
@@ -54544,7 +54572,7 @@ export declare const UpdateEnvironmentDocument = "\n    mutation updateEnvironme
 export declare const DeleteEnvironmentDocument = "\n    mutation deleteEnvironment($id: ID!) {\n  deleteEnvironment(id: $id) {\n    deletedId\n    error {\n      ... on UnknownIdUserError {\n        ...unknownIdUserErrorFull\n      }\n      ... on OtherUserError {\n        ...otherUserErrorFull\n      }\n    }\n  }\n}\n    \n    fragment unknownIdUserErrorFull on UnknownIdUserError {\n  ...userErrorFull\n  id\n}\n    \n\n    fragment userErrorFull on UserError {\n  __typename\n  code\n}\n    \n\n    fragment otherUserErrorFull on OtherUserError {\n  ...userErrorFull\n}\n    ";
 export declare const SelectEnvironmentDocument = "\n    mutation selectEnvironment($id: ID) {\n  selectEnvironment(id: $id) {\n    environment {\n      ...environmentFull\n    }\n    error {\n      ... on UnknownIdUserError {\n        ...unknownIdUserErrorFull\n      }\n      ... on OtherUserError {\n        ...otherUserErrorFull\n      }\n    }\n  }\n}\n    \n    fragment environmentFull on Environment {\n  ...environmentMeta\n  variables {\n    ...environmentVariableFull\n  }\n}\n    \n\n    fragment environmentMeta on Environment {\n  __typename\n  id\n  name\n  version\n}\n    \n\n    fragment environmentVariableFull on EnvironmentVariable {\n  name\n  value\n  kind\n}\n    \n\n    fragment unknownIdUserErrorFull on UnknownIdUserError {\n  ...userErrorFull\n  id\n}\n    \n\n    fragment userErrorFull on UserError {\n  __typename\n  code\n}\n    \n\n    fragment otherUserErrorFull on OtherUserError {\n  ...userErrorFull\n}\n    ";
 export declare const CreatedEnvironmentDocument = "\n    subscription createdEnvironment {\n  createdEnvironment {\n    environment {\n      ...environmentMeta\n    }\n    snapshot\n  }\n}\n    \n    fragment environmentMeta on Environment {\n  __typename\n  id\n  name\n  version\n}\n    ";
-export declare const UpdatedEnvironmentDocument = "\n    subscription updatedEnvironment {\n  updatedEnvironment {\n    environment {\n      ...environmentMeta\n    }\n    snapshot\n  }\n}\n    \n    fragment environmentMeta on Environment {\n  __typename\n  id\n  name\n  version\n}\n    ";
+export declare const UpdatedEnvironmentDocument = "\n    subscription updatedEnvironment {\n  updatedEnvironment {\n    environment {\n      ...environmentFull\n    }\n    snapshot\n  }\n}\n    \n    fragment environmentFull on Environment {\n  ...environmentMeta\n  variables {\n    ...environmentVariableFull\n  }\n}\n    \n\n    fragment environmentMeta on Environment {\n  __typename\n  id\n  name\n  version\n}\n    \n\n    fragment environmentVariableFull on EnvironmentVariable {\n  name\n  value\n  kind\n}\n    ";
 export declare const DeletedEnvironmentDocument = "\n    subscription deletedEnvironment {\n  deletedEnvironment {\n    deletedEnvironmentId\n    snapshot\n  }\n}\n    ";
 export declare const UpdatedEnvironmentContextDocument = "\n    subscription updatedEnvironmentContext {\n  updatedEnvironmentContext {\n    environmentContext {\n      ...environmentContextFull\n    }\n  }\n}\n    \n    fragment environmentContextFull on EnvironmentContext {\n  global {\n    ...environmentFull\n  }\n  selected {\n    ...environmentFull\n  }\n}\n    \n\n    fragment environmentFull on Environment {\n  ...environmentMeta\n  variables {\n    ...environmentVariableFull\n  }\n}\n    \n\n    fragment environmentMeta on Environment {\n  __typename\n  id\n  name\n  version\n}\n    \n\n    fragment environmentVariableFull on EnvironmentVariable {\n  name\n  value\n  kind\n}\n    ";
 export declare const RenameDataExportDocument = "\n    mutation renameDataExport($id: ID!, $name: String!) {\n  renameDataExport(id: $id, name: $name) {\n    export {\n      __typename\n      ... on DataExportStored {\n        ...dataExportStoredFullFields\n      }\n    }\n  }\n}\n    \n    fragment dataExportStoredFullFields on DataExportStored {\n  ...dataExportStoredMeta\n  fileDownloadUrl: downloadUri\n}\n    \n\n    fragment dataExportStoredMeta on DataExportStored {\n  ...dataExportStoredMetaFields\n}\n    \n\n    fragment dataExportStoredMetaFields on DataExportStored {\n  __typename\n  id\n  name\n  path\n  size\n  status\n  format\n  error\n  createdAt\n}\n    ";

package/src/types/index.d.ts

@@ -4,7 +4,7 @@ export type { _AnalyticsSDK } from "./private/analytics";
 export type { MessageViewModeOptions, StreamWsMessageMeta, MessageViewModePropsInternal, MessageViewModeProps, } from "./types/websocket";
 export type { CommandContext, CommandContextRequest, CommandContextRequestRow, CommandContextResponse, CommandContextBase, } from "./types/commands";
 export type { MenuItem } from "./types/menu";
-export { type AddSessionIndicatorOptions, type ReplayTab, type ReplaySession, type ReplayEntry, type ReplayCollection, type SendRequestOptions, ReplaySlot, type ReplaySlotContent, type RequestSource, type CurrentReplaySessionChangeEvent, } from "./types/replay";
+export { type AddCollectionIndicatorOptions, type AddSessionIndicatorOptions, type ReplayTab, type ReplaySession, type ReplayEntry, type ReplayCollection, type SendRequestOptions, ReplaySlot, type ReplaySlotContent, type RequestSource, type CurrentReplaySessionChangeEvent, } from "./types/replay";
 export type { AutomateSession, AutomateEntry } from "./types/automate";
 export type { SitemapEntry, SitemapRootEntry, ChildState, } from "./types/sitemap";
 export { SearchSlot, type SearchSlotContent } from "./types/search";

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

@@ -1,5 +1,5 @@
 import { type Extension } from "@codemirror/state";
-import { type AddSessionIndicatorOptions, type CurrentReplaySessionChangeEvent, type OpenTabOptions, type ReplayCollection, type ReplayCollectionCreatedEvent, type ReplayEntry, type ReplaySession, type ReplaySessionCreatedEvent, type ReplaySlotContent, type ReplayTab, type RequestSource, type SendRequestOptions } from "../types/replay";
+import { type AddCollectionIndicatorOptions, type AddSessionIndicatorOptions, type CurrentReplaySessionChangeEvent, type OpenTabOptions, type ReplayCollection, type ReplayCollectionCreatedEvent, type ReplayEntry, type ReplaySession, type ReplaySessionCreatedEvent, type ReplaySlotContent, type ReplayTab, type RequestSource, type SendRequestOptions } from "../types/replay";
 import type { RequestViewModeOptions, RequestWritableViewModeProps } from "../types/request";
 import type { ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import { type DefineAddToSlotFn } from "../types/slots";
@@ -44,6 +44,20 @@ export type ReplaySDK = {
      * ```
      */
     getCurrentSession: () => ReplaySession | undefined;
+    /**
+     * Get the entry currently displayed in the active replay session.
+     * @returns The active entry, or undefined if no entry is currently loaded.
+     * @example
+     * ```ts
+     * const currentEntry = sdk.replay.getCurrentEntry();
+     * if (currentEntry) {
+     *   console.log(`Currently viewing entry ${currentEntry.id}`);
+     * } else {
+     *   console.log("No entry is currently displayed");
+     * }
+     * ```
+     */
+    getCurrentEntry: () => ReplayEntry | undefined;
     /**
      * Rename a session.
      * @param id The ID of the session to rename.
@@ -243,4 +257,22 @@ export type ReplaySDK = {
      *
      */
     addSessionIndicator: (sessionId: ID, indicator: AddSessionIndicatorOptions) => Indicator;
+    /**
+     * Add an indicator to a replay collection.
+     * Indicators are displayed next to the collection name in the collections tree.
+     * @param collectionId The ID of the collection to add the indicator to.
+     * @param indicator The indicator configuration.
+     * @returns A handle object with a `remove` method to remove the indicator.
+     * @example
+     *
+     * const indicator = sdk.replay.addCollectionIndicator(collectionId, {
+     *   icon: "fas fa-folder-open",
+     *   description: "Has unresolved findings",
+     * });
+     *
+     * // Later, remove the indicator
+     * indicator.remove();
+     *
+     */
+    addCollectionIndicator: (collectionId: ID, indicator: AddCollectionIndicatorOptions) => Indicator;
 };

package/src/types/types/replay.d.ts

@@ -219,6 +219,11 @@ export type AddSessionIndicatorOptions = AddIndicatorOptions & {
      */
     showTabIcon?: boolean;
 };
+/**
+ * Options for adding an indicator to a replay collection.
+ * @category Replay
+ */
+export type AddCollectionIndicatorOptions = AddIndicatorOptions;
 /**
  * A unique replay session identifier.
  * @category Replay