@saptools/cf-debugger 0.1.13 → 0.1.15

package/dist/index.d.ts

@@ -3,11 +3,22 @@ interface SessionKey {
     readonly org: string;
     readonly space: string;
     readonly app: string;
+    readonly process?: string;
+    readonly instance?: number;
+    readonly apiEndpoint?: string;
+    readonly nodePid?: number;
+}
+interface ResolvedSessionKey extends SessionKey {
+    readonly process: string;
+    readonly instance: number;
 }
 type SessionStatus = "starting" | "logging-in" | "targeting" | "ssh-enabling" | "ssh-restarting" | "signaling" | "tunneling" | "ready" | "stopping" | "stopped" | "error";
 interface ActiveSession extends SessionKey {
     readonly sessionId: string;
+    /** Compatibility alias for the currently active controller or tunnel PID. */
     readonly pid: number;
+    readonly controllerPid?: number;
+    readonly tunnelPid?: number;
     readonly hostname: string;
     readonly localPort: number;
     readonly remotePort: number;
@@ -15,14 +26,17 @@ interface ActiveSession extends SessionKey {
     readonly cfHomeDir: string;
     readonly startedAt: string;
     readonly status: SessionStatus;
+    readonly remoteNodePid?: number;
+    readonly stopRequestedAt?: string;
     readonly message?: string;
 }
 interface StartDebuggerOptions extends SessionKey {
     readonly email?: string;
     readonly password?: string;
-    readonly apiEndpoint?: string;
     readonly preferredPort?: number;
     readonly tunnelReadyTimeoutMs?: number;
+    /** Set false when the caller must not enable SSH or restart the deployed app. Defaults to true. */
+    readonly allowSshEnableRestart?: boolean;
     readonly verbose?: boolean;
     readonly onStatus?: (status: SessionStatus, message?: string) => void;
     readonly signal?: AbortSignal;
@@ -44,7 +58,11 @@ interface StopOptions {
     readonly sessionId?: string;
     readonly key?: SessionKey;
 }
-declare function stopDebugger(options: StopOptions): Promise<ActiveSession | undefined>;
+interface StopDebuggerResult extends ActiveSession {
+    readonly stale: boolean;
+    readonly pending: boolean;
+}
+declare function stopDebugger(options: StopOptions): Promise<StopDebuggerResult | undefined>;
 declare function stopAllDebuggers(): Promise<number>;
 declare function listSessions(): Promise<readonly ActiveSession[]>;
 declare function getSession(key: SessionKey): Promise<ActiveSession | undefined>;
@@ -69,4 +87,21 @@ declare function readCurrentCfTarget(options?: CurrentCfTargetReadOptions): Prom
 declare function parseCurrentCfTarget(stdout: string): CurrentCfTarget | undefined;
 declare function requireCurrentCfRegion(target: Pick<CurrentCfTarget, "apiEndpoint" | "region">, instruction?: string): string;
 
-export { type ActiveSession, CfDebuggerError, type CurrentCfTarget, type CurrentCfTargetReadOptions, type DebuggerHandle, type SessionKey, type SessionStatus, type StartDebuggerOptions, getSession, listKnownRegionKeys, listSessions, parseCurrentCfTarget, readCurrentCfTarget, requireCurrentCfRegion, resolveApiEndpoint, sessionKeyString, startDebugger, stopAllDebuggers, stopDebugger };
+interface NodeTargetSelectors {
+    readonly process?: string;
+    readonly instance?: number;
+    readonly nodePid?: number;
+}
+interface ResolvedNodeTarget {
+    readonly process: string;
+    readonly instance: number;
+    readonly nodePid?: number;
+}
+interface NodeProcessSelection {
+    readonly remoteNodePid: number;
+}
+declare function resolveNodeTarget(input: NodeTargetSelectors): ResolvedNodeTarget;
+declare function buildNodeInspectorCommand(nodePid?: number): string;
+declare function parseNodeInspectorMarkers(stdout: string): NodeProcessSelection;
+
+export { type ActiveSession, CfDebuggerError, type CurrentCfTarget, type CurrentCfTargetReadOptions, type DebuggerHandle, type NodeProcessSelection, type NodeTargetSelectors, type ResolvedNodeTarget, type ResolvedSessionKey, type SessionKey, type SessionStatus, type StartDebuggerOptions, buildNodeInspectorCommand, getSession, listKnownRegionKeys, listSessions, parseCurrentCfTarget, parseNodeInspectorMarkers, readCurrentCfTarget, requireCurrentCfRegion, resolveApiEndpoint, resolveNodeTarget, sessionKeyString, startDebugger, stopAllDebuggers, stopDebugger };