@saptools/cf-inspector 0.4.12 → 0.6.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;
@@ -30,24 +30,80 @@ interface BreakpointHandle {
     readonly urlRegex: string;
     readonly resolvedLocations: readonly ResolvedLocation[];
 }
-interface ResolvedLocation {
+interface ScriptLocation {
     readonly scriptId: string;
-    readonly url?: string;
     readonly lineNumber: number;
     readonly columnNumber?: number;
 }
+interface BreakLocation extends ScriptLocation {
+    readonly type?: string;
+}
+interface ResolvedLocation extends ScriptLocation {
+    readonly url?: string;
+}
+interface GetPossibleBreakpointsOptions {
+    readonly start: ScriptLocation;
+    readonly end?: ScriptLocation;
+    readonly restrictToFunction?: boolean;
+}
+interface SetBreakpointAtLocationInput {
+    readonly location: ScriptLocation;
+    readonly condition?: string;
+}
+interface ExactBreakpointHandle {
+    readonly breakpointId: string;
+    readonly requestedLocation: ScriptLocation;
+    readonly actualLocation: ScriptLocation;
+}
+interface RemoteObjectInfo {
+    readonly type: string;
+    readonly subtype?: string;
+    readonly className?: string;
+    readonly completeness?: "truncated" | "unavailable";
+    readonly value?: unknown;
+    readonly unserializableValue?: string;
+    readonly description?: string;
+    readonly deepSerializedValue?: unknown;
+    readonly objectId?: string;
+    readonly preview?: unknown;
+    readonly customPreview?: unknown;
+}
+interface StackTraceIdInfo {
+    readonly id: string;
+    readonly debuggerId?: string;
+}
+interface StackTraceFrameInfo {
+    readonly functionName: string;
+    readonly scriptId: string;
+    readonly url: string;
+    readonly lineNumber: number;
+    readonly columnNumber: number;
+}
+interface StackTraceInfo {
+    readonly description?: string;
+    readonly callFrames: readonly StackTraceFrameInfo[];
+    readonly parent?: StackTraceInfo;
+    readonly parentId?: StackTraceIdInfo;
+}
 interface CallFrameInfo {
     readonly callFrameId: string;
     readonly functionName: string;
+    readonly scriptId?: string;
+    readonly functionLocation?: ScriptLocation;
     readonly url?: string;
     readonly lineNumber: number;
     readonly columnNumber: number;
     readonly scopeChain: readonly ScopeInfo[];
+    readonly thisObject?: RemoteObjectInfo;
+    readonly returnValue?: RemoteObjectInfo;
 }
 interface ScopeInfo {
     readonly type: string;
     readonly objectId?: string;
+    readonly object?: RemoteObjectInfo;
     readonly name?: string;
+    readonly startLocation?: ScriptLocation;
+    readonly endLocation?: ScriptLocation;
 }
 interface PauseEvent {
     readonly reason: string;
@@ -55,16 +111,24 @@ interface PauseEvent {
     readonly callFrames: readonly CallFrameInfo[];
     readonly receivedAtMs?: number;
     readonly data?: unknown;
+    readonly asyncStackTrace?: StackTraceInfo;
+    readonly asyncStackTraceId?: StackTraceIdInfo;
+    readonly asyncCallStackTraceId?: StackTraceIdInfo;
 }
 interface VariableSnapshot {
     readonly name: string;
     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 +137,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;
@@ -112,12 +188,26 @@ interface WatchEvent {
 interface ScriptInfo {
     readonly scriptId: string;
     readonly url: string;
+    readonly startLine?: number;
+    readonly startColumn?: number;
+    readonly endLine?: number;
+    readonly endColumn?: number;
+    readonly executionContextId?: number;
+    readonly hash?: string;
+    readonly buildId?: string;
+    readonly executionContextAuxData?: unknown;
+    readonly sourceMapURL?: string;
+    readonly hasSourceURL?: boolean;
+    readonly isModule?: boolean;
+    readonly length?: number;
+    readonly stackTrace?: StackTraceInfo;
 }
 interface InspectorConnectOptions {
     readonly port: number;
     readonly host?: string;
     readonly connectTimeoutMs?: number;
     readonly targetIndex?: number;
+    readonly workerIndex?: number;
 }
 
 declare function parseBreakpointSpec(input: string): BreakpointLocation;
@@ -150,6 +240,11 @@ interface CdpClientOptions {
     readonly requestTimeoutMs?: number;
     readonly connectTimeoutMs?: number;
 }
+interface CdpWaitOptions<T> {
+    readonly timeoutMs: number;
+    readonly predicate?: (params: T) => boolean;
+    readonly signal?: AbortSignal;
+}
 declare class CdpClient {
     private readonly transport;
     private readonly requestTimeoutMs;
@@ -166,16 +261,16 @@ declare class CdpClient {
     static connect(options: CdpClientOptions): Promise<CdpClient>;
     send<TResult = unknown>(method: string, params?: Record<string, unknown>): Promise<TResult>;
     on(method: string, listener: (params: unknown) => void): () => void;
-    waitFor<T = unknown>(method: string, options?: {
-        readonly timeoutMs: number;
-        readonly predicate?: (params: T) => boolean;
-    }): Promise<T>;
+    waitFor<T = unknown>(method: string, options?: CdpWaitOptions<T>): Promise<T>;
+    private createEventWait;
+    private eventMatches;
     onClose(listener: (err: Error) => void): () => void;
     dispose(): void;
     get isClosed(): boolean;
     private handleResponse;
     private createRequestTimer;
     private createWaitTimeoutError;
+    private createWaitAbortError;
     private sendPayload;
     private markClosed;
 }
@@ -216,11 +311,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 +337,7 @@ interface CdpEvalResult {
     exceptionDetails?: {
         text?: unknown;
         exception?: {
+            className?: unknown;
             description?: unknown;
         };
     };
@@ -252,23 +362,39 @@ interface WaitForPauseOptions {
     readonly pauseReasons?: readonly string[];
     readonly unmatchedPausePolicy?: "wait-for-resume" | "fail";
     readonly onUnmatchedPause?: (pause: PauseEvent) => void;
+    readonly signal?: AbortSignal;
 }
 
 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 getPossibleBreakpoints(session: InspectorSession, options: GetPossibleBreakpointsOptions): Promise<readonly BreakLocation[]>;
+declare function setBreakpointAtLocation(session: InspectorSession, input: SetBreakpointAtLocationInput): Promise<ExactBreakpointHandle>;
 
 declare function waitForPause(session: InspectorSession, options: WaitForPauseOptions): Promise<PauseEvent>;
 
 type PauseOnExceptionsState = "none" | "uncaught" | "caught" | "all";
+interface EvaluateOnFrameOptions {
+    readonly throwOnSideEffect?: boolean;
+    readonly objectGroup?: string;
+}
+interface StepIntoOptions {
+    readonly breakOnAsyncCall?: 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[];
 declare function validateExpression(session: InspectorSession, expression: string): Promise<void>;
 declare function getProperties(session: InspectorSession, objectId: string): Promise<readonly CdpProperty[]>;
+declare function getScriptSource(session: InspectorSession, scriptId: string): Promise<string>;
+declare function stepInto(session: InspectorSession, options?: StepIntoOptions): Promise<void>;
+declare function stepOver(session: InspectorSession): Promise<void>;
+declare function stepOut(session: InspectorSession): Promise<void>;
+declare function releaseObject(session: InspectorSession, objectId: string): Promise<void>;
+declare function releaseObjectGroup(session: InspectorSession, objectGroup: string): Promise<void>;
 
 declare function connectInspector(options: InspectorConnectOptions): Promise<InspectorSession>;
 
@@ -278,6 +404,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 +414,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 +431,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 +444,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;
@@ -332,6 +463,10 @@ interface TunnelTarget {
     readonly org: string;
     readonly space: string;
     readonly app: string;
+    readonly process?: string;
+    readonly instance?: number;
+    readonly nodePid?: number;
+    readonly allowSshEnableRestart?: boolean;
     readonly tunnelReadyTimeoutMs?: number;
     readonly preferredPort?: number;
     readonly verbose?: boolean;
@@ -343,6 +478,7 @@ interface OpenedTunnel {
     readonly handle?: DebuggerHandle;
     dispose(): Promise<void>;
 }
+declare function openOwnedCfTunnel(target: TunnelTarget): Promise<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 BreakLocation, type BreakpointHandle, type BreakpointLocation, type CallFrameInfo, type CaptureSnapshotOptions, type CapturedExpression, CfInspectorError, type CfInspectorErrorCode, type DebuggerState, type EvaluateOnFrameOptions, type ExactBreakpointHandle, type ExceptionSnapshot, type FrameSnapshot, type GetPossibleBreakpointsOptions, 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 RemoteObjectInfo, type RemoteRootSetting, type ResolvedLocation, type ScopeInfo, type ScopeSnapshot, type ScriptInfo, type ScriptLocation, type SetBreakpointAtLocationInput, type SetBreakpointInput, type SnapshotCaptureResult, type SnapshotResult, type StackTraceFrameInfo, type StackTraceIdInfo, type StackTraceInfo, type StepIntoOptions, type TunnelTarget, type VariableSnapshot, type WaitForPauseOptions, type WalkStackOptions, type WatchEvent, buildBreakpointUrlRegex, buildHitCountedCondition, buildLogpointCondition, captureException, captureSnapshot, connectInspector, discoverInspectorTargets, evaluateGlobal, evaluateOnFrame, fetchInspectorVersion, getPossibleBreakpoints, getProperties, getScriptSource, listScripts, openCfTunnel, openOwnedCfTunnel, parseBreakpointSpec, parseRemoteRoot, releaseObject, releaseObjectGroup, removeBreakpoint, resume, runSetupEvals, setBreakpoint, setBreakpointAtLocation, setPauseOnExceptions, stepInto, stepOut, stepOver, streamLogpoint, validateExpression, waitForPause, walkStack };