@heroku/heroku-cli-util 10.5.0 → 10.6.1

package/dist/errors/not-found.d.ts

@@ -11,10 +11,21 @@
  * ([see here](https://github.com/heroku/cli/blob/b79f2c93d6f21eafd9d93983bcd377e4bc7f8438/packages/cli/src/commands/pg/psql.ts#L32)).
  */
 export declare class NotFound extends Error {
-    readonly body: {
+    readonly resource: string;
+    readonly statusCode = 404;
+    constructor(resource?: string);
+    get body(): {
         id: string;
         message: string;
+        resource: string;
     };
-    readonly message = "Couldn't find that addon.";
-    readonly statusCode = 404;
+    get http(): {
+        body: {
+            id: string;
+            message: string;
+            resource: string;
+        };
+        statusCode: number;
+    };
+    get message(): string;
 }

package/dist/errors/not-found.js

@@ -11,7 +11,19 @@
  * ([see here](https://github.com/heroku/cli/blob/b79f2c93d6f21eafd9d93983bcd377e4bc7f8438/packages/cli/src/commands/pg/psql.ts#L32)).
  */
 export class NotFound extends Error {
-    body = { id: 'not_found', message: 'Couldn\'t find that addon.' };
-    message = 'Couldn\'t find that addon.';
+    resource;
     statusCode = 404;
+    constructor(resource = 'addon') {
+        super();
+        this.resource = resource;
+    }
+    get body() {
+        return { id: 'not_found', message: `Couldn't find that ${this.resource}.`, resource: this.resource };
+    }
+    get http() {
+        return { body: this.body, statusCode: this.statusCode };
+    }
+    get message() {
+        return this.body.message;
+    }
 }

package/dist/utils/addons/addon-resolver.js

@@ -1,4 +1,5 @@
 import { AmbiguousError } from '../../errors/ambiguous.js';
+import { NotFound } from '../../errors/not-found.js';
 export default class AddonResolver {
     heroku;
     addonHeaders = {
@@ -9,15 +10,25 @@ export default class AddonResolver {
         this.heroku = heroku;
     }
     async resolve(addon, app, addonService) {
+        let addons = [];
         const [appPart, addonPart] = addon.match(/^(.+)::(.+)$/)?.slice(1) ?? [app, addon];
-        const { body: addons } = await this.heroku.post('/actions/addons/resolve', {
+        ({ body: addons } = await this.heroku.post('/actions/addons/resolve', {
             body: {
                 addon: addonPart,
-                addon_service: addonService,
+                // We would pass the add-on service slug here for Platform API to filter the add-ons by
+                // add-on service, but the resolvers won't allow alpha add-ons to be found.
+                // addon_service: addonService,
                 app: appPart,
             },
             headers: this.addonHeaders,
-        });
+        }));
+        // We implement the add-on service filtering logic here if the parameter is provided.
+        if (addonService) {
+            addons = addons.filter(addon => addon.addon_service.name === addonService);
+        }
+        if (addons.length === 0) {
+            throw new NotFound();
+        }
         if (addons.length === 1) {
             return addons[0];
         }

package/dist/utils/addons/attachment-resolver.js

@@ -10,12 +10,25 @@ export default class AddonAttachmentResolver {
         this.heroku = heroku;
     }
     async resolve(appId, attachmentId, options = {}) {
-        const { body: attachments } = await this.heroku.post('/actions/addon-attachments/resolve', {
-            // eslint-disable-next-line camelcase
-            body: { addon_attachment: attachmentId, addon_service: options.addonService, app: appId },
+        const { addonService, namespace } = options;
+        let attachments = [];
+        /* eslint-disable camelcase */
+        ({ body: attachments } = await this.heroku.post('/actions/addon-attachments/resolve', {
+            body: {
+                addon_attachment: attachmentId,
+                // We would pass the add-on service slug here for Platform API to filter the attachments by
+                // add-on service, but the resolvers won't allow alpha add-ons to be found.
+                // addon_service: addonService,
+                app: appId,
+            },
             headers: this.attachmentHeaders,
-        });
-        return this.singularize(attachments, options.namespace);
+        }));
+        /* eslint-enable camelcase */
+        // We implement the add-on service filtering logic here if the parameter is provided.
+        if (addonService) {
+            attachments = attachments.filter(attachment => attachment.addon.plan.name.split(':', 2)[0] === addonService);
+        }
+        return this.singularize(attachments, namespace);
     }
     singularize(attachments, namespace) {
         let matches;

package/dist/utils/pg/bastion.js

@@ -12,7 +12,7 @@ const pgDebug = debug('pg');
  * @returns True if the attachment belongs to a non-shield Private Space, false otherwise
  */
 export function bastionKeyPlan(attachment) {
-    return Boolean(/private/.test(attachment.addon.plan.name.split(':', 2)[1]));
+    return Boolean(attachment.addon.plan.name.split(':', 2)[1].startsWith('private'));
 }
 /**
  * Fetches the bastion configuration from the Data API (only relevant for add-ons installed onto a
@@ -98,7 +98,9 @@ function baseEnv(connectionDetails) {
     };
     const baseEnv = {
         PGAPPNAME: 'psql non-interactive',
-        PGSSLMODE: (!connectionDetails.host || connectionDetails.host === 'localhost') ? 'prefer' : 'require',
+        PGSSLMODE: (!connectionDetails.host || connectionDetails.host === 'localhost')
+            ? 'prefer'
+            : 'require',
         ...process.env,
     };
     for (const envVar of Object.keys(mapping)) {
@@ -178,8 +180,6 @@ class Timeout {
     }
     /**
      * Cancels the timeout.
-     *
-     * @returns void
      */
     cancel() {
         this.events.emit('cancelled');

package/dist/ux/colors.js

@@ -1,4 +1,3 @@
-/* eslint-disable import/no-named-as-default-member */
 import ansis from 'ansis';
 /**
  * Color constants for Heroku CLI output

package/dist/ux/styled-object.js

@@ -27,11 +27,18 @@ export function styledObject(obj, keys) {
     if (typeof obj === 'boolean')
         return obj.toString();
     const output = [];
-    const keyLengths = Object.keys(obj).map(key => key.toString().length);
-    const maxKeyLength = Math.max(...keyLengths) + 2;
+    const keysToIterate = keys || Object.keys(obj);
+    // Only calculate max key length for keys that will actually be displayed
+    const displayableKeys = keysToIterate.filter(key => {
+        const value = obj[key];
+        return value !== null && value !== undefined && (!Array.isArray(value) || value.length > 0);
+    });
+    const keyLengths = displayableKeys.map(key => key.toString().length);
+    const maxKeyLength = keyLengths.length > 0 ? Math.max(...keyLengths) + 2 : 0;
     const logKeyValue = (key, value) => `${color.label(key)}:` + ' '.repeat(maxKeyLength - key.length - 1) + prettyPrint(value);
-    for (const [key, value] of Object.entries(obj)) {
-        if (keys && !keys.includes(key))
+    for (const key of keysToIterate) {
+        const value = obj[key];
+        if (value === null || value === undefined)
             continue;
         if (Array.isArray(value)) {
             if (value.length > 0) {
@@ -41,7 +48,7 @@ export function styledObject(obj, keys) {
                 }
             }
         }
-        else if (value !== null && value !== undefined) {
+        else {
             output.push(logKeyValue(key, value));
         }
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@heroku/heroku-cli-util",
-  "version": "10.5.0",
+  "version": "10.6.1",
   "description": "Set of helpful CLI utilities",
   "author": "Heroku",
   "license": "ISC",
@@ -16,7 +16,7 @@
   ],
   "devDependencies": {
     "@heroku-cli/schema": "^2.0.0",
-    "@heroku-cli/test-utils": "0.1.1",
+    "@heroku-cli/test-utils": "^0.1.2",
     "@types/chai": "^4.3.13",
     "@types/chai-as-promised": "^8.0.2",
     "@types/debug": "^4.1.12",
@@ -29,12 +29,10 @@
     "c8": "^7.7.0",
     "chai": "^4.4.1",
     "chai-as-promised": "^8.0.1",
-    "eslint": "^8.57.0",
-    "eslint-config-oclif": "^5.0.0",
-    "eslint-config-oclif-typescript": "^3.1.14",
-    "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-mocha": "^10.4.3",
-    "mocha": "^10.8.2",
+    "eslint": "^9",
+    "eslint-config-oclif": "^6.0.144",
+    "eslint-plugin-mocha": "^11.2.0",
+    "mocha": "^11",
     "mock-stdin": "^1.0.0",
     "nock": "^13.2.9",
     "open": "^11",
@@ -46,7 +44,7 @@
     "typescript": "^5.4.0"
   },
   "dependencies": {
-    "@heroku-cli/command": "^12.0.0",
+    "@heroku-cli/command": "^12.2.0",
     "@heroku/http-call": "^5.5.0",
     "@oclif/core": "^4.3.0",
     "@oclif/table": "0.5.2",
@@ -64,8 +62,13 @@
     "build": "npm run clean && tsc",
     "clean": "rm -rf dist",
     "example": "sh examples/run.sh",
-    "lint": "eslint . --ext .ts --config .eslintrc.cjs",
+    "lint": "eslint .",
+    "posttest": "npm run lint",
+    "prepare": "npm run build",
     "test": "c8 mocha --forbid-only \"test/**/*.test.ts\"",
     "test:local": "c8 mocha \"${npm_config_file:-test/**/*.test.+(ts|tsx)}\""
+  },
+  "overrides": {
+    "serialize-javascript": "^7.0.3"
   }
-}
+}