heroku 9.3.3-beta.0 → 9.4.0

package/lib/commands/pg/settings/log-lock-waits.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@oclif/core");
 const tsheredoc_1 = require("tsheredoc");
 const setter_1 = require("../../../lib/pg/setter");
+const nls_1 = require("../../../nls");
 class LogLockWaits extends setter_1.PGSettingsCommand {
     constructor() {
         super(...arguments);
@@ -26,6 +27,6 @@ LogLockWaits.description = (0, tsheredoc_1.default)(`
     Applications and their query patterns should try to avoid changes to many different tables within the same transaction.
   `);
 LogLockWaits.args = {
-    database: core_1.Args.string(),
-    value: core_1.Args.string(),
+    database: core_1.Args.string({ description: `${(0, nls_1.nls)('pg:database:arg:description')} ${(0, nls_1.nls)('pg:database:arg:description:default:suffix')}` }),
+    value: core_1.Args.string({ description: 'boolean indicating if a message gets logged when a session waits longer than the deadlock_timeout to acquire a lock' }),
 };

package/lib/commands/pg/settings/log-min-duration-statement.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@oclif/core");
 const tsheredoc_1 = require("tsheredoc");
 const setter_1 = require("../../../lib/pg/setter");
+const nls_1 = require("../../../nls");
 class LogMinDurationStatement extends setter_1.PGSettingsCommand {
     constructor() {
         super(...arguments);
@@ -28,6 +29,6 @@ LogMinDurationStatement.description = (0, tsheredoc_1.default)(`
     Setting log_min_duration_statement to zero prints all statement durations and -1 will disable logging statement durations.
   `);
 LogMinDurationStatement.args = {
-    database: core_1.Args.string(),
-    value: core_1.Args.string(),
+    database: core_1.Args.string({ description: `${(0, nls_1.nls)('pg:database:arg:description')} ${(0, nls_1.nls)('pg:database:arg:description:default:suffix')}` }),
+    value: core_1.Args.string({ description: 'milliseconds to wait for a statement to complete before logging it' }),
 };

package/lib/commands/pg/settings/log-min-error-statement.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@oclif/core");
 const tsheredoc_1 = require("tsheredoc");
 const setter_1 = require("../../../lib/pg/setter");
+const nls_1 = require("../../../nls");
 class LogMinErrorStatement extends setter_1.PGSettingsCommand {
     constructor() {
         super(...arguments);
@@ -22,6 +23,6 @@ LogMinErrorStatement.description = (0, tsheredoc_1.default)(`
     Use this setting to prevent logging SQL queries that contain sensitive information. Default is "error".
   `);
 LogMinErrorStatement.args = {
-    database: core_1.Args.string(),
+    database: core_1.Args.string({ description: `${(0, nls_1.nls)('pg:database:arg:description')} ${(0, nls_1.nls)('pg:database:arg:description:default:suffix')}` }),
     value: core_1.Args.string({ options: ['error', 'log', 'fatal', 'panic'] }),
 };

package/lib/commands/pg/settings/log-statement.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@oclif/core");
 const tsheredoc_1 = require("tsheredoc");
 const setter_1 = require("../../../lib/pg/setter");
+const nls_1 = require("../../../nls");
 class LogStatement extends setter_1.PGSettingsCommand {
     constructor() {
         super(...arguments);
@@ -25,6 +26,6 @@ LogStatement.description = (0, tsheredoc_1.default)(`
     all  - All statements are logged
   `);
 LogStatement.args = {
-    database: core_1.Args.string(),
-    value: core_1.Args.string({ options: ['none', 'ddl', 'mod', 'all'] }),
+    database: core_1.Args.string({ description: `${(0, nls_1.nls)('pg:database:arg:description')} ${(0, nls_1.nls)('pg:database:arg:description:default:suffix')}` }),
+    value: core_1.Args.string({ options: ['none', 'ddl', 'mod', 'all'], description: 'type of SQL statements to log\n<options: none|ddl|mod|all>' }),
 };

package/lib/commands/pg/settings/track-functions.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@oclif/core");
 const tsheredoc_1 = require("tsheredoc");
 const setter_1 = require("../../../lib/pg/setter");
+const nls_1 = require("../../../nls");
 // ref: https://www.postgresql.org/docs/current/runtime-config-statistics.html#GUC-TRACK-FUNCTIONS
 class TrackFunctions extends setter_1.PGSettingsCommand {
     constructor() {
@@ -24,6 +25,6 @@ TrackFunctions.description = (0, tsheredoc_1.default)(`
     pl   - Only procedural language functions are tracked
     all  - All functions, including SQL and C language functions, are tracked. Simple SQL-language that are inlined are not tracked`);
 TrackFunctions.args = {
-    database: core_1.Args.string(),
-    value: core_1.Args.string({ options: ['none', 'pl', 'all'] }),
+    database: core_1.Args.string({ description: `${(0, nls_1.nls)('pg:database:arg:description')} ${(0, nls_1.nls)('pg:database:arg:description:default:suffix')}` }),
+    value: core_1.Args.string({ options: ['none', 'pl', 'all'], description: 'function type to track\n<options: none|pl|all>' }),
 };

package/lib/commands/pg/unfollow.js

@@ -8,6 +8,7 @@ const host_1 = require("../../lib/pg/host");
 const util_1 = require("../../lib/pg/util");
 const confirmCommand_1 = require("../../lib/confirmCommand");
 const tsheredoc_1 = require("tsheredoc");
+const nls_1 = require("../../nls");
 class Unfollow extends command_1.Command {
     async run() {
         const { flags, args } = await this.parse(Unfollow);
@@ -36,5 +37,5 @@ Unfollow.flags = {
     remote: command_1.flags.remote(),
 };
 Unfollow.args = {
-    database: core_1.Args.string({ required: true }),
+    database: core_1.Args.string({ required: true, description: (0, nls_1.nls)('pg:database:arg:description') }),
 };

package/lib/commands/pg/upgrade.js

@@ -8,6 +8,7 @@ const fetcher_1 = require("../../lib/pg/fetcher");
 const host_1 = require("../../lib/pg/host");
 const util_1 = require("../../lib/pg/util");
 const confirmCommand_1 = require("../../lib/confirmCommand");
+const nls_1 = require("../../nls");
 class Upgrade extends command_1.Command {
     async run() {
         const { flags, args } = await this.parse(Upgrade);
@@ -54,5 +55,5 @@ Upgrade.flags = {
     remote: command_1.flags.remote(),
 };
 Upgrade.args = {
-    database: core_1.Args.string(),
+    database: core_1.Args.string({ description: `${(0, nls_1.nls)('pg:database:arg:description')} ${(0, nls_1.nls)('pg:database:arg:description:default:suffix')}` }),
 };

package/lib/commands/pg/vacuum-stats.js

@@ -5,6 +5,7 @@ const core_1 = require("@oclif/core");
 const fetcher_1 = require("../../lib/pg/fetcher");
 const psql_1 = require("../../lib/pg/psql");
 const tsheredoc_1 = require("tsheredoc");
+const nls_1 = require("../../nls");
 class VacuumStats extends command_1.Command {
     async run() {
         const { flags, args } = await this.parse(VacuumStats);
@@ -61,5 +62,5 @@ VacuumStats.flags = {
     remote: command_1.flags.remote(),
 };
 VacuumStats.args = {
-    database: core_1.Args.string(),
+    database: core_1.Args.string({ description: `${(0, nls_1.nls)('pg:database:arg:description')} ${(0, nls_1.nls)('pg:database:arg:description:default:suffix')}` }),
 };

package/lib/commands/pg/wait.js

@@ -7,6 +7,7 @@ const debug_1 = require("debug");
 const fetcher_1 = require("../../lib/pg/fetcher");
 const host_1 = require("../../lib/pg/host");
 const notify_1 = require("../../lib/notify");
+const nls_1 = require("../../nls");
 const wait = (ms) => new Promise(resolve => {
     setTimeout(resolve, ms);
 });
@@ -75,5 +76,5 @@ Wait.flags = {
     remote: command_1.flags.remote(),
 };
 Wait.args = {
-    database: core_1.Args.string(),
+    database: core_1.Args.string({ description: `${(0, nls_1.nls)('pg:database:arg:description')} ${(0, nls_1.nls)('pg:database:arg:description:all-dbs:suffix')}` }),
 };

package/lib/commands/ps/restart.js

@@ -30,7 +30,7 @@ Restart.examples = [
 ];
 Restart.help = 'if DYNO is not specified, restarts all dynos on app';
 Restart.args = {
-    dyno: core_1.Args.string({ required: false }),
+    dyno: core_1.Args.string({ required: false, description: 'ID of the dyno' }),
 };
 Restart.flags = {
     app: command_1.flags.app({ required: true }),

package/lib/commands/ps/stop.js

@@ -25,7 +25,7 @@ Stop.examples = [
 ];
 Stop.help = 'stop app dyno or dyno type';
 Stop.args = {
-    dyno: core_1.Args.string({ required: true }),
+    dyno: core_1.Args.string({ required: true, description: 'ID of the dyno' }),
 };
 Stop.flags = {
     app: command_1.flags.app({ required: true }),

package/lib/commands/redis/cli.js

@@ -187,7 +187,7 @@ Cli.flags = {
     remote: command_1.flags.remote(),
 };
 Cli.args = {
-    database: core_1.Args.string(),
+    database: core_1.Args.string({ description: 'name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.' }),
 };
 Cli.examples = [
     '$ heroku redis:cli --app=my-app my-database',

package/lib/commands/redis/credentials.js

@@ -28,5 +28,5 @@ Credentials.flags = {
     reset: command_1.flags.boolean({ description: 'reset credentials' }),
 };
 Credentials.args = {
-    database: core_1.Args.string({ required: false }),
+    database: core_1.Args.string({ required: false, description: 'name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.' }),
 };

package/lib/commands/redis/info.js

@@ -21,5 +21,5 @@ Info.flags = {
     json: command_1.flags.boolean({ char: 'j', description: 'output in json format' }),
 };
 Info.args = {
-    database: core_1.Args.string(),
+    database: core_1.Args.string({ description: 'name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.' }),
 };

package/lib/commands/redis/keyspace-notifications.js

@@ -43,5 +43,5 @@ KeyspaceNotifications.flags = {
     config: command_1.flags.string({ char: 'c', description: 'set keyspace notifications configuration', hasValue: true, required: true }),
 };
 KeyspaceNotifications.args = {
-    database: core_1.Args.string(),
+    database: core_1.Args.string({ description: 'name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.' }),
 };

package/lib/commands/redis/maintenance.js

@@ -59,5 +59,5 @@ Maintenance.flags = {
     }),
 };
 Maintenance.args = {
-    database: core_1.Args.string({ required: false }),
+    database: core_1.Args.string({ required: false, description: 'name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.' }),
 };

package/lib/commands/redis/maxmemory.js

@@ -36,5 +36,5 @@ MaxMemory.flags = {
     remote: command_1.flags.remote(),
 };
 MaxMemory.args = {
-    database: core_1.Args.string(),
+    database: core_1.Args.string({ description: 'name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.' }),
 };

package/lib/commands/redis/promote.js

@@ -35,5 +35,5 @@ Promote.flags = {
     remote: command_1.flags.remote(),
 };
 Promote.args = {
-    database: core_1.Args.string({ required: false }),
+    database: core_1.Args.string({ required: false, description: 'name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.' }),
 };

package/lib/commands/redis/stats-reset.js

@@ -32,5 +32,5 @@ StatsReset.flags = {
     confirm: command_1.flags.string({ char: 'c' }),
 };
 StatsReset.args = {
-    database: core_1.Args.string(),
+    database: core_1.Args.string({ description: 'name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.' }),
 };

package/lib/commands/redis/timeout.js

@@ -31,5 +31,5 @@ Timeout.flags = {
     seconds: command_1.flags.integer({ char: 's', description: 'set timeout value', required: true }),
 };
 Timeout.args = {
-    database: core_1.Args.string(),
+    database: core_1.Args.string({ description: 'name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.' }),
 };

package/lib/commands/redis/upgrade.js

@@ -33,5 +33,5 @@ Upgrade.flags = {
     confirm: command_1.flags.string({ char: 'c' }),
 };
 Upgrade.args = {
-    database: core_1.Args.string(),
+    database: core_1.Args.string({ description: 'name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.' }),
 };

package/lib/commands/redis/wait.js

@@ -56,5 +56,5 @@ Wait.flags = {
     remote: command_1.flags.remote(),
 };
 Wait.args = {
-    database: core_1.Args.string({ required: false }),
+    database: core_1.Args.string({ required: false, description: 'name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.' }),
 };

package/lib/commands/releases/info.js

@@ -52,5 +52,5 @@ Info.flags = {
     app: command_1.flags.app({ required: true }),
 };
 Info.args = {
-    release: core_1.Args.string(),
+    release: core_1.Args.string({ description: 'ID of the release. If omitted, we use the last release ID.' }),
 };

package/lib/commands/releases/output.js

@@ -33,5 +33,5 @@ Output.flags = {
     app: command_1.flags.app({ required: true }),
 };
 Output.args = {
-    release: core_1.Args.string(),
+    release: core_1.Args.string({ description: 'ID of the release. If omitted, we use the last release ID.' }),
 };

package/lib/commands/releases/rollback.js

@@ -44,5 +44,5 @@ Rollback.flags = {
     app: command_1.flags.app({ required: true }),
 };
 Rollback.args = {
-    release: core_1.Args.string(),
+    release: core_1.Args.string({ description: 'ID of the release. If omitted, we use the last release ID.' }),
 };

package/lib/commands/sessions/destroy.js

@@ -14,5 +14,5 @@ class SessionsDestroy extends command_1.Command {
 exports.default = SessionsDestroy;
 SessionsDestroy.description = 'delete (logout) OAuth session by ID';
 SessionsDestroy.args = {
-    id: core_1.Args.string({ required: true }),
+    id: core_1.Args.string({ required: true, description: 'ID of the OAuth session' }),
 };

package/lib/commands/spaces/drains/set.js

@@ -25,5 +25,5 @@ Set.flags = {
     space: command_1.flags.string({ char: 's', description: 'space for which to set log drain', required: true }),
 };
 Set.args = {
-    url: core_1.Args.string({ required: true }),
+    url: core_1.Args.string({ required: true, description: 'URL to replace the log drain with' }),
 };

package/lib/commands/spaces/trusted-ips/add.js

@@ -39,5 +39,5 @@ Add.flags = {
     confirm: command_1.flags.string({ description: 'set to space name to bypass confirm prompt' }),
 };
 Add.args = {
-    source: core_1.Args.string({ required: true }),
+    source: core_1.Args.string({ required: true, description: 'IP address in CIDR notation' }),
 };

package/lib/commands/spaces/trusted-ips/remove.js

@@ -40,5 +40,5 @@ Remove.flags = {
     confirm: command_1.flags.string({ description: 'set to space name to bypass confirm prompt' }),
 };
 Remove.args = {
-    source: core_1.Args.string({ required: true }),
+    source: core_1.Args.string({ required: true, description: 'IP address in CIDR notation' }),
 };

package/lib/commands/webhooks/deliveries/info.js

@@ -38,5 +38,5 @@ DeliveriesInfo.flags = {
     pipeline: command_1.flags.pipeline({ char: 'p', description: 'pipeline on which to list', hidden: true }),
 };
 DeliveriesInfo.args = {
-    id: core_1.Args.string({ required: true }),
+    id: core_1.Args.string({ required: true, description: 'ID of the webhook event' }),
 };

package/lib/commands/webhooks/events/info.js

@@ -27,5 +27,5 @@ Info.flags = {
     pipeline: command_1.flags.pipeline({ char: 'p', description: 'pipeline on which to list', hidden: true }),
 };
 Info.args = {
-    id: core_1.Args.string({ required: true }),
+    id: core_1.Args.string({ required: true, description: 'ID of the webhook event' }),
 };

package/lib/commands/webhooks/info.js

@@ -27,5 +27,5 @@ WebhooksInfo.flags = {
     pipeline: command_1.flags.pipeline({ char: 'p', description: 'pipeline on which to list', hidden: true }),
 };
 WebhooksInfo.args = {
-    id: core_1.Args.string({ required: true }),
+    id: core_1.Args.string({ required: true, description: 'ID of the webhook' }),
 };

package/lib/commands/webhooks/update.js

@@ -37,5 +37,5 @@ WebhooksUpdate.flags = {
     url: command_1.flags.string({ char: 'u', description: 'URL for receiver', required: true }),
 };
 WebhooksUpdate.args = {
-    id: core_1.Args.string({ required: true }),
+    id: core_1.Args.string({ required: true, description: 'ID of the webhook' }),
 };

package/lib/nls.d.ts

@@ -0,0 +1,8 @@
+import * as nlsValues from './package.nls.json';
+/**
+ * Non-localized strings util.
+ *
+ * @param key The key of the non-localized string to retrieve.
+ * @return string
+ */
+export declare function nls<T extends keyof typeof nlsValues>(key: T): typeof nlsValues[T];

package/lib/nls.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nls = void 0;
+const nlsValues = require("./package.nls.json");
+/**
+ * Non-localized strings util.
+ *
+ * @param key The key of the non-localized string to retrieve.
+ * @return string
+ */
+function nls(key) {
+    return nlsValues[key];
+}
+exports.nls = nls;

package/lib/package.nls.json

@@ -0,0 +1,6 @@
+{
+    "pg:database:arg:description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::`",
+    "pg:database:arg:description:default:suffix": ". If omitted, we use DATABASE_URL.",
+    "pg:database:arg:description:arbitrary:suffix": ". If omitted, we use a random database attached to the app.",
+    "pg:database:arg:description:all-dbs:suffix": ". If omitted, we use all databases."
+}