@heroku/heroku-cli-util 10.1.0 → 10.1.1

package/dist/types/pg/tunnel.d.ts

@@ -1,5 +1,4 @@
 import { Server } from 'node:net';
-import * as createTunnel from 'tunnel-ssh';
 import type { ExtendedAddonAttachment } from './data-api.js';
 export type ConnectionDetails = {
     _tunnel?: Server;
@@ -14,7 +13,15 @@ export type ConnectionDetails = {
 export type ConnectionDetailsWithAttachment = {
     attachment: ExtendedAddonAttachment;
 } & ConnectionDetails;
-export type TunnelConfig = createTunnel.Config;
+export interface TunnelConfig {
+    dstHost: string;
+    dstPort: number;
+    host?: string;
+    localHost: string;
+    localPort: number;
+    privateKey?: string;
+    username: string;
+}
 export interface BastionConfigResponse {
     host: string;
     private_key: string;

package/dist/utils/pg/bastion.d.ts

@@ -1,6 +1,5 @@
 import type { APIClient } from '@heroku-cli/command';
 import { Server } from 'node:net';
-import * as createTunnel from 'tunnel-ssh';
 import { ExtendedAddonAttachment } from '../../types/pg/data-api.js';
 import { BastionConfig, ConnectionDetailsWithAttachment, TunnelConfig } from '../../types/pg/tunnel.js';
 /**
@@ -46,7 +45,7 @@ export declare const getBastionConfig: (config: Record<string, string>, baseName
  */
 export declare function getPsqlConfigs(connectionDetails: ConnectionDetailsWithAttachment): {
     dbEnv: NodeJS.ProcessEnv;
-    dbTunnelConfig: createTunnel.Config;
+    dbTunnelConfig: TunnelConfig;
 };
 export type PsqlConfigs = ReturnType<typeof getPsqlConfigs>;
 /**
@@ -55,8 +54,18 @@ export type PsqlConfigs = ReturnType<typeof getPsqlConfigs>;
  * @param connectionDetails - The database connection details with attachment information
  * @param dbTunnelConfig - The tunnel configuration object
  * @param timeout - The timeout in milliseconds (default: 10000)
- * @param createSSHTunnel - The function to create the SSH tunnel (default: promisified createTunnel.default)
+ * @param createSSHTunnel - The function to create the SSH tunnel
  * @returns Promise that resolves to the tunnel server or null if no bastion key is provided
  * @throws Error if unable to establish the tunnel
  */
-export declare function sshTunnel(connectionDetails: ConnectionDetailsWithAttachment, dbTunnelConfig: TunnelConfig, timeout?: number, createSSHTunnel?: (arg1: createTunnel.Config | undefined) => Promise<Server>): Promise<Server | void>;
+export declare function sshTunnel(connectionDetails: ConnectionDetailsWithAttachment, dbTunnelConfig: TunnelConfig, timeout?: number, createSSHTunnel?: typeof createSSHTunnelAdapter): Promise<Server | void>;
+/**
+ * Adapter for tunnel-ssh v5 API. Translates our TunnelConfig into the v5
+ * createTunnel(tunnelOptions, serverOptions, sshOptions, forwardOptions) call
+ * and returns the created local Server.
+ *
+ * @param config - The tunnel configuration to translate for v5 API
+ * @returns Promise that resolves to the created local TCP Server
+ */
+declare function createSSHTunnelAdapter(config: TunnelConfig): Promise<Server>;
+export {};

package/dist/utils/pg/bastion.js

@@ -1,7 +1,6 @@
 import debug from 'debug';
 import { EventEmitter } from 'node:events';
-import { promisify } from 'node:util';
-import * as createTunnel from 'tunnel-ssh';
+import * as tunnelSsh from 'tunnel-ssh';
 import host from './host.js';
 const pgDebug = debug('pg');
 /**
@@ -135,11 +134,11 @@ function tunnelConfig(connectionDetails) {
  * @param connectionDetails - The database connection details with attachment information
  * @param dbTunnelConfig - The tunnel configuration object
  * @param timeout - The timeout in milliseconds (default: 10000)
- * @param createSSHTunnel - The function to create the SSH tunnel (default: promisified createTunnel.default)
+ * @param createSSHTunnel - The function to create the SSH tunnel
  * @returns Promise that resolves to the tunnel server or null if no bastion key is provided
  * @throws Error if unable to establish the tunnel
  */
-export async function sshTunnel(connectionDetails, dbTunnelConfig, timeout = 10_000, createSSHTunnel = promisify(createTunnel.default)) {
+export async function sshTunnel(connectionDetails, dbTunnelConfig, timeout = 10_000, createSSHTunnel = createSSHTunnelAdapter) {
     if (!connectionDetails.bastionKey) {
         return;
     }
@@ -203,3 +202,34 @@ class Timeout {
         }
     }
 }
+/**
+ * Adapter for tunnel-ssh v5 API. Translates our TunnelConfig into the v5
+ * createTunnel(tunnelOptions, serverOptions, sshOptions, forwardOptions) call
+ * and returns the created local Server.
+ *
+ * @param config - The tunnel configuration to translate for v5 API
+ * @returns Promise that resolves to the created local TCP Server
+ */
+async function createSSHTunnelAdapter(config) {
+    const tunnelOptions = {
+        autoClose: true,
+        reconnectOnError: false,
+    };
+    const serverOptions = {
+        host: config.localHost,
+        port: config.localPort,
+    };
+    const sshOptions = {
+        host: config.host,
+        privateKey: config.privateKey,
+        username: config.username,
+    };
+    const forwardOptions = {
+        dstAddr: config.dstHost,
+        dstPort: config.dstPort,
+        srcAddr: config.localHost,
+        srcPort: config.localPort,
+    };
+    const [server] = await tunnelSsh.createTunnel(tunnelOptions, serverOptions, sshOptions, forwardOptions);
+    return server;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@heroku/heroku-cli-util",
-  "version": "10.1.0",
+  "version": "10.1.1",
   "description": "Set of helpful CLI utilities",
   "author": "Heroku",
   "license": "ISC",
@@ -49,7 +49,7 @@
     "@oclif/table": "0.4.8",
     "debug": "^4.4.0",
     "inquirer": "^12.6.1",
-    "tunnel-ssh": "4.1.6"
+    "tunnel-ssh": "5.2.0"
   },
   "engines": {
     "node": ">=20"