@saptools/cf-hana 0.4.1 → 0.5.0

package/dist/index.d.ts

@@ -53,6 +53,12 @@ interface ConnectOptions {
     readonly password?: string;
     /** Connection pool tuning, or `false` for a single dedicated connection. */
     readonly pool?: PoolOptions | false;
+    /** Skip the direct connection attempt and connect via an SSH tunnel immediately. */
+    readonly tunnel?: boolean;
+    /** Bypass a cached/live tunnel and force a fresh establishment attempt. */
+    readonly refreshTunnel?: boolean;
+    /** CLI-only stderr visibility hook for tunnel-fallback progress; unset stays silent. */
+    readonly onTunnelStatus?: (message: string) => void;
 }
 interface QueryOptions {
     readonly timeoutMs?: number;
@@ -134,10 +140,9 @@ interface SqlBackupRecord {
 declare function cfHanaBackupRoot(saptoolsRoot?: string): string;
 declare function writeSqlBackup(input: SqlBackupWriteInput, options?: SqlBackupWriteOptions): Promise<SqlBackupRecord>;
 
-interface CatalogObjectInfo {
-    readonly schema: string;
-    readonly name: string;
-    readonly type: "TABLE" | "VIEW";
+interface SapCredentials {
+    readonly email: string;
+    readonly password: string;
 }
 
 interface DriverExecResult {
@@ -154,6 +159,12 @@ interface DriverConnectParams {
     readonly schema: string;
     readonly certificate: string;
     readonly connectTimeoutMs: number;
+    /**
+     * TLS certificate-hostname override. Set only when `host` is a tunnel
+     * endpoint (e.g. `127.0.0.1`) so certificate verification still targets
+     * the real HANA hostname. Unset on the direct path.
+     */
+    readonly servername?: string;
 }
 /** A live, single HANA connection. Implementations wrap a concrete driver. */
 interface DriverConnection {
@@ -182,6 +193,20 @@ interface ConnectionConfig {
     readonly readOnly: boolean;
     readonly allowDestructive: boolean;
     readonly autoLimit: number | false;
+    /** The resolved Cloud Foundry app/org/space/API this connection targets. */
+    readonly appName: string;
+    readonly orgName: string;
+    readonly spaceName: string;
+    readonly apiEndpoint: string;
+    readonly selectorSource: SelectorSource;
+    /** SAP BTP identity used to resolve bindings, reused for tunnel-fallback CF sessions. */
+    readonly sapCredentials?: SapCredentials;
+    /** `"always"` skips the direct attempt and connects via a tunnel immediately. */
+    readonly tunnelMode: "auto" | "always";
+    /** Bypasses a cached/live tunnel and forces a fresh establishment attempt. */
+    readonly refreshTunnel: boolean;
+    /** CLI-only stderr visibility hook; left unset, the library stays silent. */
+    readonly onTunnelStatus?: (message: string) => void;
 }
 /** A single HANA connection: applies the safety guard, auto-limit, and timeouts. */
 declare class Connection {
@@ -203,6 +228,12 @@ declare class Connection {
     private evaluateSafety;
 }
 
+interface CatalogObjectInfo {
+    readonly schema: string;
+    readonly name: string;
+    readonly type: "TABLE" | "VIEW";
+}
+
 /**
  * A process-local, in-memory pool of HANA connections. It holds no shared disk
  * state, so multiple pools (in this or other processes) are fully independent.