@saptools/cf-inspector 0.4.12 → 0.5.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { DebuggerHandle, SessionStatus } from '@saptools/cf-debugger';
 
-type CfInspectorErrorCode = "INVALID_ARGUMENT" | "INVALID_BREAKPOINT" | "INVALID_REMOTE_ROOT" | "INVALID_EXPRESSION" | "SETUP_EVAL_FAILED" | "INVALID_HIT_COUNT" | "INVALID_PAUSE_TYPE" | "BREAKPOINT_DID_NOT_BIND" | "INSPECTOR_DISCOVERY_FAILED" | "INSPECTOR_CONNECTION_FAILED" | "CDP_REQUEST_FAILED" | "BREAKPOINT_NOT_HIT" | "UNRELATED_PAUSE" | "UNRELATED_PAUSE_TIMEOUT" | "EVALUATION_FAILED" | "MISSING_TARGET" | "ABORTED";
+type CfInspectorErrorCode = "INVALID_ARGUMENT" | "INVALID_BREAKPOINT" | "INVALID_REMOTE_ROOT" | "INVALID_EXPRESSION" | "MUTATION_NOT_ALLOWED" | "SETUP_EVAL_FAILED" | "INVALID_HIT_COUNT" | "INVALID_PAUSE_TYPE" | "BREAKPOINT_DID_NOT_BIND" | "INSPECTOR_DISCOVERY_FAILED" | "INSPECTOR_CONNECTION_FAILED" | "CDP_REQUEST_FAILED" | "BREAKPOINT_NOT_HIT" | "UNRELATED_PAUSE" | "UNRELATED_PAUSE_TIMEOUT" | "EVALUATION_FAILED" | "MISSING_TARGET" | "ABORTED";
 declare class CfInspectorError extends Error {
     readonly code: CfInspectorErrorCode;
     readonly detail?: string;
@@ -61,10 +61,15 @@ interface VariableSnapshot {
     readonly value: string;
     readonly type?: string;
     readonly children?: readonly VariableSnapshot[];
+    readonly truncated?: true;
+    readonly originalLength?: number;
+    readonly omittedCount?: number;
 }
 interface ScopeSnapshot {
     readonly type: string;
     readonly variables: readonly VariableSnapshot[];
+    readonly truncated?: true;
+    readonly omittedCount?: number;
 }
 interface FrameSnapshot {
     readonly functionName: string;
@@ -73,18 +78,30 @@ interface FrameSnapshot {
     readonly column: number;
     readonly scopes?: readonly ScopeSnapshot[];
     readonly captures?: readonly CapturedExpression[];
+    readonly truncated?: true;
+    readonly omittedCount?: number;
 }
 interface CapturedExpression {
     readonly expression: string;
     readonly value?: string;
     readonly type?: string;
     readonly error?: string;
+    readonly mutationRisk?: boolean;
+    readonly blocked?: true;
+    readonly truncated?: true;
+    readonly originalLength?: number;
+    readonly omittedCount?: number;
 }
 interface ExceptionSnapshot {
     readonly value?: string;
     readonly type?: string;
     readonly description?: string;
     readonly error?: string;
+    readonly truncated?: true;
+    readonly originalLength?: number;
+    readonly valueOriginalLength?: number;
+    readonly descriptionOriginalLength?: number;
+    readonly omittedCount?: number;
 }
 interface SnapshotCaptureResult {
     readonly reason: string;
@@ -118,6 +135,7 @@ interface InspectorConnectOptions {
     readonly host?: string;
     readonly connectTimeoutMs?: number;
     readonly targetIndex?: number;
+    readonly workerIndex?: number;
 }
 
 declare function parseBreakpointSpec(input: string): BreakpointLocation;
@@ -216,11 +234,25 @@ interface InspectorSession {
     readonly pauseBuffer: PauseEvent[];
     readonly pauseWaitGate: PauseWaitGate;
     readonly debuggerState: DebuggerState;
+    readonly targetIndex?: number;
+    readonly targetCount?: number;
+    readonly workerIndex?: number;
+    readonly workerTargets?: readonly InspectorWorkerTarget[];
+    readonly workerDiscoverySupported?: boolean;
     dispose(): Promise<void>;
 }
+interface InspectorWorkerTarget {
+    readonly sessionId: string;
+    readonly workerId: string;
+    readonly type: string;
+    readonly title: string;
+    readonly url: string;
+}
 interface CdpEvalResult {
     result?: {
         type?: unknown;
+        subtype?: unknown;
+        className?: unknown;
         value?: unknown;
         description?: unknown;
         objectId?: unknown;
@@ -228,6 +260,7 @@ interface CdpEvalResult {
     exceptionDetails?: {
         text?: unknown;
         exception?: {
+            className?: unknown;
             description?: unknown;
         };
     };
@@ -261,9 +294,12 @@ declare function removeBreakpoint(session: InspectorSession, breakpointId: strin
 declare function waitForPause(session: InspectorSession, options: WaitForPauseOptions): Promise<PauseEvent>;
 
 type PauseOnExceptionsState = "none" | "uncaught" | "caught" | "all";
+interface EvaluateOnFrameOptions {
+    readonly throwOnSideEffect?: boolean;
+}
 declare function resume(session: InspectorSession): Promise<void>;
 declare function setPauseOnExceptions(session: InspectorSession, state: PauseOnExceptionsState): Promise<void>;
-declare function evaluateOnFrame(session: InspectorSession, callFrameId: string, expression: string): Promise<CdpEvalResult>;
+declare function evaluateOnFrame(session: InspectorSession, callFrameId: string, expression: string, options?: EvaluateOnFrameOptions): Promise<CdpEvalResult>;
 declare function evaluateGlobal(session: InspectorSession, expression: string): Promise<CdpEvalResult>;
 declare function runSetupEvals(session: InspectorSession, expressions: readonly string[]): Promise<void>;
 declare function listScripts(session: InspectorSession): readonly ScriptInfo[];
@@ -278,6 +314,7 @@ interface CaptureSnapshotOptions {
     readonly maxValueLength?: number;
     readonly stackDepth?: number;
     readonly stackCaptures?: readonly string[];
+    readonly throwOnSideEffect?: boolean;
 }
 declare function captureSnapshot(session: InspectorSession, pause: PauseEvent, options?: CaptureSnapshotOptions): Promise<SnapshotCaptureResult>;
 
@@ -287,6 +324,7 @@ interface WalkStackOptions {
     readonly stackDepth: number;
     readonly stackCaptures: readonly string[];
     readonly maxValueLength: number;
+    readonly throwOnSideEffect?: boolean;
 }
 declare function walkStack(session: InspectorSession, callFrames: readonly CallFrameInfo[], options: WalkStackOptions): Promise<readonly FrameSnapshot[]>;
 
@@ -303,6 +341,8 @@ interface LogpointEvent {
     readonly value?: string;
     readonly error?: string;
     readonly raw?: string;
+    readonly truncated?: true;
+    readonly originalLength?: number;
 }
 
 type LogpointStopReason = "duration" | "signal" | "transport-closed" | "max-events";
@@ -314,6 +354,7 @@ interface LogpointStreamOptions {
     readonly maxEvents?: number;
     readonly hitCount?: number;
     readonly condition?: string;
+    readonly maxValueLength?: number;
     readonly signal?: AbortSignal;
     readonly onEvent: (event: LogpointEvent) => void;
     readonly onBreakpointSet?: (handle: BreakpointHandle) => void;
@@ -345,4 +386,4 @@ interface OpenedTunnel {
 }
 declare function openCfTunnel(target: TunnelTarget): Promise<OpenedTunnel>;
 
-export { type BreakpointHandle, type BreakpointLocation, type CallFrameInfo, type CaptureSnapshotOptions, type CapturedExpression, CfInspectorError, type CfInspectorErrorCode, type DebuggerState, type ExceptionSnapshot, type FrameSnapshot, type InspectorConnectOptions, type InspectorSession, type InspectorTarget, type LogpointConditionOptions, type LogpointEvent, type LogpointStopReason, type LogpointStreamOptions, type LogpointStreamResult, type OpenedTunnel, type PauseEvent, type PauseOnExceptionsState, type RemoteRootSetting, type ResolvedLocation, type ScopeInfo, type ScopeSnapshot, type ScriptInfo, type SetBreakpointInput, type SnapshotCaptureResult, type SnapshotResult, type TunnelTarget, type VariableSnapshot, type WaitForPauseOptions, type WalkStackOptions, type WatchEvent, buildBreakpointUrlRegex, buildHitCountedCondition, buildLogpointCondition, captureException, captureSnapshot, connectInspector, discoverInspectorTargets, evaluateGlobal, evaluateOnFrame, fetchInspectorVersion, getProperties, listScripts, openCfTunnel, parseBreakpointSpec, parseRemoteRoot, removeBreakpoint, resume, runSetupEvals, setBreakpoint, setPauseOnExceptions, streamLogpoint, validateExpression, waitForPause, walkStack };
+export { type BreakpointHandle, type BreakpointLocation, type CallFrameInfo, type CaptureSnapshotOptions, type CapturedExpression, CfInspectorError, type CfInspectorErrorCode, type DebuggerState, type EvaluateOnFrameOptions, type ExceptionSnapshot, type FrameSnapshot, type InspectorConnectOptions, type InspectorSession, type InspectorTarget, type InspectorWorkerTarget, type LogpointConditionOptions, type LogpointEvent, type LogpointStopReason, type LogpointStreamOptions, type LogpointStreamResult, type OpenedTunnel, type PauseEvent, type PauseOnExceptionsState, type RemoteRootSetting, type ResolvedLocation, type ScopeInfo, type ScopeSnapshot, type ScriptInfo, type SetBreakpointInput, type SnapshotCaptureResult, type SnapshotResult, type TunnelTarget, type VariableSnapshot, type WaitForPauseOptions, type WalkStackOptions, type WatchEvent, buildBreakpointUrlRegex, buildHitCountedCondition, buildLogpointCondition, captureException, captureSnapshot, connectInspector, discoverInspectorTargets, evaluateGlobal, evaluateOnFrame, fetchInspectorVersion, getProperties, listScripts, openCfTunnel, parseBreakpointSpec, parseRemoteRoot, removeBreakpoint, resume, runSetupEvals, setBreakpoint, setPauseOnExceptions, streamLogpoint, validateExpression, waitForPause, walkStack };