@heroku/heroku-cli-util 10.1.2 → 10.1.3

package/dist/index.d.ts

@@ -3,8 +3,11 @@ import { AmbiguousError } from './errors/ambiguous.js';
 import { NotFound } from './errors/not-found.js';
 import { AddOnWithRelatedData, ExtendedAddonAttachment, Link } from './types/pg/data-api.js';
 import { ConnectionDetails, ConnectionDetailsWithAttachment, TunnelConfig } from './types/pg/tunnel.js';
+import { getPsqlConfigs, sshTunnel } from './utils/pg/bastion.js';
+import { getConfigVarNameFromAttachment } from './utils/pg/config-vars.js';
 import DatabaseResolver from './utils/pg/databases.js';
 import getHost from './utils/pg/host.js';
+import PsqlService from './utils/pg/psql.js';
 import { prompt } from './ux/prompt.js';
 import { styledHeader } from './ux/styled-header.js';
 import { styledJSON } from './ux/styled-json.js';
@@ -28,12 +31,16 @@ export declare const utils: {
     };
     pg: {
         DatabaseResolver: typeof DatabaseResolver;
+        PsqlService: typeof PsqlService;
         fetcher: {
             database(heroku: APIClient, appId: string, attachmentId?: string, namespace?: string): Promise<ConnectionDetailsWithAttachment>;
         };
         host: typeof getHost;
         psql: {
             exec(connectionDetails: ConnectionDetailsWithAttachment, query: string, psqlCmdArgs?: string[]): Promise<string>;
+            getConfigVarNameFromAttachment: typeof getConfigVarNameFromAttachment;
+            getPsqlConfigs: typeof getPsqlConfigs;
+            sshTunnel: typeof sshTunnel;
         };
     };
 };

package/dist/index.js

@@ -1,5 +1,7 @@
 import { AmbiguousError } from './errors/ambiguous.js';
 import { NotFound } from './errors/not-found.js';
+import { getPsqlConfigs, sshTunnel } from './utils/pg/bastion.js';
+import { getConfigVarNameFromAttachment } from './utils/pg/config-vars.js';
 import DatabaseResolver from './utils/pg/databases.js';
 import getHost from './utils/pg/host.js';
 import PsqlService from './utils/pg/psql.js';
@@ -27,6 +29,7 @@ export const utils = {
     },
     pg: {
         DatabaseResolver,
+        PsqlService,
         fetcher: {
             database(heroku, appId, attachmentId, namespace) {
                 const databaseResolver = new DatabaseResolver(heroku);
@@ -39,6 +42,9 @@ export const utils = {
                 const psqlService = new PsqlService(connectionDetails);
                 return psqlService.execQuery(query, psqlCmdArgs);
             },
+            getConfigVarNameFromAttachment,
+            getPsqlConfigs,
+            sshTunnel,
         },
     },
 };

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

@@ -1,7 +1,7 @@
 import type { APIClient } from '@heroku-cli/command';
 import { Server } from 'node:net';
 import { ExtendedAddonAttachment } from '../../types/pg/data-api.js';
-import { BastionConfig, ConnectionDetailsWithAttachment, TunnelConfig } from '../../types/pg/tunnel.js';
+import { BastionConfig, ConnectionDetails, TunnelConfig } from '../../types/pg/tunnel.js';
 /**
  * Determines whether the attachment belongs to an add-on installed onto a non-shield Private Space.
  * If true, the bastion information needs to be fetched from the Data API.
@@ -43,7 +43,7 @@ export declare const getBastionConfig: (config: Record<string, string>, baseName
  * @param connectionDetails - The database connection details with attachment information
  * @returns Object containing database environment variables and tunnel configuration
  */
-export declare function getPsqlConfigs(connectionDetails: ConnectionDetailsWithAttachment): {
+export declare function getPsqlConfigs(connectionDetails: ConnectionDetails): {
     dbEnv: NodeJS.ProcessEnv;
     dbTunnelConfig: TunnelConfig;
 };
@@ -58,7 +58,7 @@ export type PsqlConfigs = ReturnType<typeof getPsqlConfigs>;
  * @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?: typeof createSSHTunnelAdapter): Promise<Server | void>;
+export declare function sshTunnel(connectionDetails: ConnectionDetails, 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

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

@@ -38,7 +38,7 @@ export default class DatabaseResolver {
      * @param connStringOrDbName - PostgreSQL connection string or local database name
      * @returns Connection details object with parsed connection information
      */
-    parsePostgresConnectionString(connStringOrDbName: string): ConnectionDetails;
+    static parsePostgresConnectionString(connStringOrDbName: string): ConnectionDetails;
     /**
      * Fetches all Heroku PostgreSQL add-on attachments for a given app.
      *
@@ -57,7 +57,7 @@ export default class DatabaseResolver {
      * @param config - The record of app config vars with their values
      * @returns Connection details with attachment information
      */
-    private getConnectionDetails;
+    getConnectionDetails(attachment: ExtendedAddonAttachment, config?: Record<string, string>): ConnectionDetailsWithAttachment;
     /**
      * Helper function that attempts to find a single addon attachment matching the given database identifier
      * (attachment name, id, or config var name).

package/dist/utils/pg/databases.js

@@ -92,7 +92,8 @@ export default class DatabaseResolver {
      * @param connStringOrDbName - PostgreSQL connection string or local database name
      * @returns Connection details object with parsed connection information
      */
-    parsePostgresConnectionString(connStringOrDbName) {
+    // eslint-disable-next-line perfectionist/sort-classes
+    static parsePostgresConnectionString(connStringOrDbName) {
         const dbPath = /:\/\//.test(connStringOrDbName) ? connStringOrDbName : `postgres:///${connStringOrDbName}`;
         const url = new URL(dbPath);
         const { hostname, password, pathname, port, username } = url;
@@ -130,11 +131,12 @@ export default class DatabaseResolver {
      * @param config - The record of app config vars with their values
      * @returns Connection details with attachment information
      */
+    // eslint-disable-next-line perfectionist/sort-classes
     getConnectionDetails(attachment, config = {}) {
         const connStringVar = getConfigVarNameFromAttachment(attachment, config);
         // build the default payload for non-bastion dbs
         pgDebug(`Using "${connStringVar}" to connect to your database…`);
-        const conn = this.parsePostgresConnectionString(config[connStringVar]);
+        const conn = DatabaseResolver.parsePostgresConnectionString(config[connStringVar]);
         const payload = {
             attachment,
             database: conn.database,

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

@@ -1,6 +1,6 @@
 import { spawn } from 'node:child_process';
 import { Server } from 'node:net';
-import { ConnectionDetailsWithAttachment, TunnelConfig } from '../../types/pg/tunnel.js';
+import { ConnectionDetails, TunnelConfig } from '../../types/pg/tunnel.js';
 import { getPsqlConfigs, sshTunnel } from './bastion.js';
 /**
  * A small wrapper around tunnel-ssh so that other code doesn't have to worry about whether there is or is not a tunnel.
@@ -22,7 +22,7 @@ export declare class Tunnel {
      * @param tunnelFn - The function to create the SSH tunnel (default: sshTunnel)
      * @returns Promise that resolves to a new Tunnel instance
      */
-    static connect(connectionDetails: ConnectionDetailsWithAttachment, tunnelConfig: TunnelConfig, tunnelFn: typeof sshTunnel): Promise<Tunnel>;
+    static connect(connectionDetails: ConnectionDetails, tunnelConfig: TunnelConfig, tunnelFn: typeof sshTunnel): Promise<Tunnel>;
     /**
      * Closes the tunnel if it exists, or emits a fake close event if no tunnel is needed.
      *
@@ -42,7 +42,7 @@ export default class PsqlService {
     private readonly getPsqlConfigsFn;
     private readonly spawnFn;
     private readonly tunnelFn;
-    constructor(connectionDetails: ConnectionDetailsWithAttachment, getPsqlConfigsFn?: typeof getPsqlConfigs, spawnFn?: typeof spawn, tunnelFn?: typeof sshTunnel);
+    constructor(connectionDetails: ConnectionDetails, getPsqlConfigsFn?: typeof getPsqlConfigs, spawnFn?: typeof spawn, tunnelFn?: typeof sshTunnel);
     /**
      * Executes a PostgreSQL query using the instance's database connection details.
      * It uses the `getPsqlConfigs` function to get the configuration for the database and the tunnel,
@@ -87,7 +87,7 @@ export default class PsqlService {
      * @param options - The options for spawning the psql process
      * @returns Promise that resolves to the query result as a string
      */
-    private runWithTunnel;
+    runWithTunnel(tunnelConfig: TunnelConfig, options: Parameters<typeof this.spawnPsql>[0]): Promise<string>;
     /**
      * Spawns the psql process with the given options.
      *

package/dist/utils/pg/psql.js

@@ -164,6 +164,7 @@ export default class PsqlService {
      * @param options - The options for spawning the psql process
      * @returns Promise that resolves to the query result as a string
      */
+    // eslint-disable-next-line perfectionist/sort-classes
     async runWithTunnel(tunnelConfig, options) {
         const tunnel = await Tunnel.connect(this.connectionDetails, tunnelConfig, this.tunnelFn);
         pgDebug('after create tunnel');

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@heroku/heroku-cli-util",
-  "version": "10.1.2",
+  "version": "10.1.3",
   "description": "Set of helpful CLI utilities",
   "author": "Heroku",
   "license": "ISC",
@@ -44,9 +44,9 @@
   "dependencies": {
     "@heroku-cli/color": "^2.0.4",
     "@heroku-cli/command": "^12.0.0",
-    "@heroku/http-call": "^5.4.0",
+    "@heroku/http-call": "^5.5.0",
     "@oclif/core": "^4.3.0",
-    "@oclif/table": "0.4.8",
+    "@oclif/table": "0.4.14",
     "debug": "^4.4.0",
     "inquirer": "^12.6.1",
     "tunnel-ssh": "5.2.0"