@heroku/heroku-cli-util 9.0.0-beta.3 → 9.0.1-beta.0

package/README.md

@@ -19,50 +19,111 @@ npm install @heroku/heroku-cli-util
 
 ## Usage
 
-You can import the utilities you need.
+You can import the utilities you need from the main exports.
 
 ### Output Utilities
 
 ```js
+import { hux } from '@heroku/heroku-cli-util';
+
 // Styled header
-import { styledHeader } from '@heroku/heroku-cli-util/dist/ux/styled-header';
-styledHeader('My CLI Header');
+hux.styledHeader('My CLI Header');
 
 // Styled JSON
-import { styledJSON } from '@heroku/heroku-cli-util/dist/ux/styled-json';
-styledJSON({ foo: 'bar' });
+hux.styledJSON({ foo: 'bar' });
 
 // Styled object
-import { styledObject } from '@heroku/heroku-cli-util/dist/ux/styled-object';
-styledObject({ foo: 'bar' });
-
-// Table
-import { table } from '@heroku/heroku-cli-util/dist/ux/table';
-table([{ name: 'Alice' }, { name: 'Bob' }], { columns: [{ key: 'name' }] });
-
-// Wait
-import { wait } from '@heroku/heroku-cli-util/dist/ux/wait';
-await wait('Processing...');
+hux.styledObject({ foo: 'bar' });
+
+// Table output
+hux.table([
+  {name: 'Alice', age: 30},
+  {name: 'Bob', age: 25},
+], {
+  name: {header: 'Name'},
+  age: {header: 'Age'},
+});
+
+// Wait indicator
+const stop = hux.wait('Processing...');
+// ...do async work...
+stop();
 ```
 
 ### User Interaction
 
 ```js
-import { prompt } from '@heroku/heroku-cli-util/dist/ux/prompt';
-const name = await prompt('What is your name?');
+import { hux } from '@heroku/heroku-cli-util';
 
-import { confirm } from '@heroku/heroku-cli-util/dist/ux/confirm';
-const proceed = await confirm('Continue?');
+const name = await hux.prompt('What is your name?');
+const proceed = await hux.confirm('Continue?');
 ```
 
 ### Test Helpers
 
 ```js
-import { initCliTest } from '@heroku/heroku-cli-util/dist/test-helpers/init';
-initCliTest();
+import { testHelpers } from '@heroku/heroku-cli-util';
+
+testHelpers.initCliTest();
+
+testHelpers.setupStdoutStderr();
+// ...run your CLI code...
+const output = testHelpers.stdout();
+const errorOutput = testHelpers.stderr();
+testHelpers.restoreStdoutStderr();
+
+testHelpers.expectOutput(output, 'expected output');
+
+// Run a command (see docs for details)
+// await testHelpers.runCommand(MyCommand, ['arg1', 'arg2']);
+```
+
+### Types
+
+```js
+import { types } from '@heroku/heroku-cli-util';
+
+// Error types
+try {
+  throw new types.errors.AmbiguousError([{ name: 'foo' }, { name: 'bar' }], 'addon');
+} catch (err) {
+  if (err instanceof types.errors.AmbiguousError) {
+    console.error('Ambiguous:', err.message);
+  }
+}
+
+try {
+  throw new types.errors.NotFound();
+} catch (err) {
+  if (err instanceof types.errors.NotFound) {
+    console.error('Not found:', err.message);
+  }
+}
+
+// PG types (for TypeScript)
+/**
+ * types.pg.AddOnAttachmentWithConfigVarsAndPlan
+ * types.pg.AddOnWithRelatedData
+ * types.pg.ConnectionDetails
+ * types.pg.ConnectionDetailsWithAttachment
+ * types.pg.Link
+ * types.pg.TunnelConfig
+ */
+```
+
+### Database and Utility Helpers
+
+```js
+import { utils } from '@heroku/heroku-cli-util';
+
+// Get Heroku Postgres database connection details (requires APIClient from @heroku-cli/command)
+// const db = await utils.pg.databases(herokuApiClient, 'my-app', 'DATABASE_URL');
+
+// Get Heroku Postgres host
+const host = utils.pg.host();
 
-import { stdout, stderr } from '@heroku/heroku-cli-util/dist/test-helpers/stub-output';
-// Use stdout() and stderr() in your tests to capture CLI output
+// Run a query (requires a ConnectionDetails object)
+// const result = await utils.pg.psql.exec(db, 'SELECT 1');
 ```
 
 ## Development

package/dist/index.d.ts

@@ -10,8 +10,10 @@ import { exec } from './utils/pg/psql';
 import { confirm } from './ux/confirm';
 import { prompt } from './ux/prompt';
 import { styledHeader } from './ux/styled-header';
-import { styledJson } from './ux/styled-json';
+import { styledJSON } from './ux/styled-json';
 import { styledObject } from './ux/styled-object';
+import { table } from './ux/table';
+import { wait } from './ux/wait';
 export declare const testHelpers: {
     expectOutput: (actual: string, expected: string) => Chai.Assertion;
     initCliTest: typeof initCliTest;
@@ -44,10 +46,12 @@ export declare const utils: {
         };
     };
 };
-export declare const ux: {
+export declare const hux: {
     confirm: typeof confirm;
     prompt: typeof prompt;
     styledHeader: typeof styledHeader;
-    styledJson: typeof styledJson;
+    styledJSON: typeof styledJSON;
     styledObject: typeof styledObject;
+    table: typeof table;
+    wait: typeof wait;
 };

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ux = exports.utils = exports.types = exports.testHelpers = void 0;
+exports.hux = exports.utils = exports.types = exports.testHelpers = void 0;
 const expect_output_1 = require("./test-helpers/expect-output");
 const init_1 = require("./test-helpers/init");
 const run_command_1 = require("./test-helpers/run-command");
@@ -15,6 +15,8 @@ const prompt_1 = require("./ux/prompt");
 const styled_header_1 = require("./ux/styled-header");
 const styled_json_1 = require("./ux/styled-json");
 const styled_object_1 = require("./ux/styled-object");
+const table_1 = require("./ux/table");
+const wait_1 = require("./ux/wait");
 exports.testHelpers = {
     expectOutput: expect_output_1.default,
     initCliTest: init_1.initCliTest,
@@ -47,10 +49,12 @@ exports.utils = {
         },
     },
 };
-exports.ux = {
+exports.hux = {
     confirm: confirm_1.confirm,
     prompt: prompt_1.prompt,
     styledHeader: styled_header_1.styledHeader,
-    styledJson: styled_json_1.styledJson,
+    styledJSON: styled_json_1.styledJSON,
     styledObject: styled_object_1.styledObject,
+    table: table_1.table,
+    wait: wait_1.wait,
 };

package/dist/ux/styled-json.d.ts

@@ -1 +1 @@
-export declare function styledJson(obj: unknown): void;
+export declare function styledJSON(obj: unknown): void;

package/dist/ux/styled-json.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.styledJson = styledJson;
+exports.styledJSON = styledJSON;
 const core_1 = require("@oclif/core");
-function styledJson(obj) {
+function styledJSON(obj) {
     return core_1.ux.styledJSON(obj);
 }

package/dist/ux/table.d.ts

@@ -1,2 +1,2 @@
-import { ux } from '@oclif/core';
-export declare function table<T extends Record<string, unknown>>(data: T[], columns: Parameters<typeof ux.table>[1], options?: Parameters<typeof ux.table>[2]): void;
+import { table as cliTable } from '@oclif/core/lib/cli-ux';
+export declare function table<T extends Record<string, unknown>>(data: T[], columns: Parameters<typeof cliTable>[1], options?: Parameters<typeof cliTable>[2]): void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "commonjs",
   "name": "@heroku/heroku-cli-util",
-  "version": "9.0.0-beta.3",
+  "version": "9.0.1-beta.0",
   "description": "Set of helpful CLI utilities",
   "author": "Heroku",
   "license": "ISC",