@saptools/cf-inspector 0.3.19 → 0.4.1

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { DebuggerHandle } from '@saptools/cf-debugger';
 
-type CfInspectorErrorCode = "INVALID_ARGUMENT" | "INVALID_BREAKPOINT" | "INVALID_REMOTE_ROOT" | "INVALID_EXPRESSION" | "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" | "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;
@@ -55,6 +55,7 @@ interface PauseEvent {
     readonly hitBreakpoints: readonly string[];
     readonly callFrames: readonly CallFrameInfo[];
     readonly receivedAtMs?: number;
+    readonly data?: unknown;
 }
 interface VariableSnapshot {
     readonly name: string;
@@ -72,6 +73,7 @@ interface FrameSnapshot {
     readonly line: number;
     readonly column: number;
     readonly scopes?: readonly ScopeSnapshot[];
+    readonly captures?: readonly CapturedExpression[];
 }
 interface CapturedExpression {
     readonly expression: string;
@@ -79,16 +81,35 @@ interface CapturedExpression {
     readonly type?: string;
     readonly error?: string;
 }
+interface ExceptionSnapshot {
+    readonly value?: string;
+    readonly type?: string;
+    readonly description?: string;
+    readonly error?: string;
+}
 interface SnapshotCaptureResult {
     readonly reason: string;
     readonly hitBreakpoints: readonly string[];
     readonly capturedAt: string;
     readonly topFrame?: FrameSnapshot;
     readonly captures: readonly CapturedExpression[];
+    readonly stack?: readonly FrameSnapshot[];
+    readonly exception?: ExceptionSnapshot;
 }
 interface SnapshotResult extends SnapshotCaptureResult {
     readonly pausedDurationMs: number | null;
 }
+interface WatchEvent {
+    readonly ts: string;
+    readonly at: string;
+    readonly hit: number;
+    readonly reason: string;
+    readonly hitBreakpoints: readonly string[];
+    readonly topFrame?: FrameSnapshot;
+    readonly captures: readonly CapturedExpression[];
+    readonly stack?: readonly FrameSnapshot[];
+    readonly exception?: ExceptionSnapshot;
+}
 interface ScriptInfo {
     readonly scriptId: string;
     readonly url: string;
@@ -119,11 +140,15 @@ interface CdpTransport {
     on<E extends keyof CdpTransportEventMap>(event: E, listener: CdpTransportEventMap[E]): void;
     off<E extends keyof CdpTransportEventMap>(event: E, listener: CdpTransportEventMap[E]): void;
 }
-type CdpTransportFactory = (url: string) => Promise<CdpTransport>;
+interface CdpTransportFactoryOptions {
+    readonly connectTimeoutMs?: number;
+}
+type CdpTransportFactory = (url: string, options?: CdpTransportFactoryOptions) => Promise<CdpTransport>;
 interface CdpClientOptions {
     readonly url: string;
     readonly transportFactory?: CdpTransportFactory;
     readonly requestTimeoutMs?: number;
+    readonly connectTimeoutMs?: number;
 }
 declare class CdpClient {
     private readonly transport;
@@ -134,6 +159,7 @@ declare class CdpClient {
     private closed;
     private closeReason;
     private readonly handleMessage;
+    private safeEmit;
     private readonly handleClose;
     private readonly handleError;
     private constructor();
@@ -218,20 +244,25 @@ interface CdpProperty {
 interface SetBreakpointInput extends BreakpointLocation {
     readonly remoteRoot?: RemoteRootSetting;
     readonly condition?: string;
+    readonly hitCount?: number;
 }
 interface WaitForPauseOptions {
     readonly timeoutMs: number;
     readonly breakpointIds?: readonly string[];
+    readonly pauseReasons?: readonly string[];
     readonly unmatchedPausePolicy?: "wait-for-resume" | "fail";
     readonly onUnmatchedPause?: (pause: PauseEvent) => void;
 }
 
+declare function buildHitCountedCondition(hitCount: number, counterKey: string, userCondition: string | undefined): string;
 declare function setBreakpoint(session: InspectorSession, input: SetBreakpointInput): Promise<BreakpointHandle>;
 declare function removeBreakpoint(session: InspectorSession, breakpointId: string): Promise<void>;
 
 declare function waitForPause(session: InspectorSession, options: WaitForPauseOptions): Promise<PauseEvent>;
 
+type PauseOnExceptionsState = "none" | "uncaught" | "caught" | "all";
 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 evaluateGlobal(session: InspectorSession, expression: string): Promise<CdpEvalResult>;
 declare function listScripts(session: InspectorSession): readonly ScriptInfo[];
@@ -244,10 +275,26 @@ interface CaptureSnapshotOptions {
     readonly captures?: readonly string[];
     readonly includeScopes?: boolean;
     readonly maxValueLength?: number;
+    readonly stackDepth?: number;
+    readonly stackCaptures?: readonly string[];
 }
 declare function captureSnapshot(session: InspectorSession, pause: PauseEvent, options?: CaptureSnapshotOptions): Promise<SnapshotCaptureResult>;
 
-declare function buildLogpointCondition(sentinel: string, expression: string): string;
+declare function captureException(session: InspectorSession, pause: PauseEvent, maxValueLength: number): Promise<ExceptionSnapshot | undefined>;
+
+interface WalkStackOptions {
+    readonly stackDepth: number;
+    readonly stackCaptures: readonly string[];
+    readonly maxValueLength: number;
+}
+declare function walkStack(session: InspectorSession, callFrames: readonly CallFrameInfo[], options: WalkStackOptions): Promise<readonly FrameSnapshot[]>;
+
+interface LogpointConditionOptions {
+    readonly predicate?: string;
+    readonly hitCount?: number;
+    readonly counterKey?: string;
+}
+declare function buildLogpointCondition(sentinel: string, expression: string, options?: LogpointConditionOptions): string;
 
 interface LogpointEvent {
     readonly ts: string;
@@ -257,11 +304,15 @@ interface LogpointEvent {
     readonly raw?: string;
 }
 
+type LogpointStopReason = "duration" | "signal" | "transport-closed" | "max-events";
 interface LogpointStreamOptions {
     readonly location: BreakpointLocation;
     readonly expression: string;
     readonly remoteRoot?: RemoteRootSetting;
     readonly durationMs?: number;
+    readonly maxEvents?: number;
+    readonly hitCount?: number;
+    readonly condition?: string;
     readonly signal?: AbortSignal;
     readonly onEvent: (event: LogpointEvent) => void;
     readonly onBreakpointSet?: (handle: BreakpointHandle) => void;
@@ -270,7 +321,7 @@ interface LogpointStreamResult {
     readonly handle: BreakpointHandle;
     readonly sentinel: string;
     readonly emitted: number;
-    readonly stoppedReason: "duration" | "signal" | "transport-closed";
+    readonly stoppedReason: LogpointStopReason;
 }
 declare function streamLogpoint(session: InspectorSession, options: LogpointStreamOptions): Promise<LogpointStreamResult>;
 
@@ -291,4 +342,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 FrameSnapshot, type InspectorConnectOptions, type InspectorSession, type InspectorTarget, type LogpointEvent, type LogpointStreamOptions, type LogpointStreamResult, type OpenedTunnel, type PauseEvent, type RemoteRootSetting, type ResolvedLocation, type ScopeInfo, type ScopeSnapshot, type ScriptInfo, type SetBreakpointInput, type SnapshotCaptureResult, type SnapshotResult, type TunnelTarget, type VariableSnapshot, type WaitForPauseOptions, buildBreakpointUrlRegex, buildLogpointCondition, captureSnapshot, connectInspector, discoverInspectorTargets, evaluateGlobal, evaluateOnFrame, fetchInspectorVersion, getProperties, listScripts, openCfTunnel, parseBreakpointSpec, parseRemoteRoot, removeBreakpoint, resume, setBreakpoint, streamLogpoint, validateExpression, waitForPause };
+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, setBreakpoint, setPauseOnExceptions, streamLogpoint, validateExpression, waitForPause, walkStack };