@heroku-cli/plugin-data 3.0.5 → 3.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -20,6 +20,7 @@ You can read more about Heroku Data Enhanced Certificates on the [Dev Center](ht
20
20
  * [Heroku CLI Data Plugin](#heroku-cli-data-plugin)
21
21
  * [Usage](#usage)
22
22
  * [Commands](#commands)
23
+ * [Command Topics](#command-topics)
23
24
  <!-- tocstop -->
24
25
  # Usage
25
26
  ```sh-session
@@ -36,437 +37,8 @@ USAGE
36
37
  <!-- usagestop -->
37
38
  # Commands
38
39
  <!-- commands -->
39
- * [`heroku data:connectors`](#heroku-dataconnectors)
40
- * [`heroku data:connectors:create`](#heroku-dataconnectorscreate)
41
- * [`heroku data:connectors:destroy CONNECTOR`](#heroku-dataconnectorsdestroy-connector)
42
- * [`heroku data:connectors:info CONNECTOR`](#heroku-dataconnectorsinfo-connector)
43
- * [`heroku data:connectors:list`](#heroku-dataconnectorslist)
44
- * [`heroku data:connectors:pause CONNECTOR`](#heroku-dataconnectorspause-connector)
45
- * [`heroku data:connectors:resume CONNECTOR`](#heroku-dataconnectorsresume-connector)
46
- * [`heroku data:connectors:update CONNECTOR`](#heroku-dataconnectorsupdate-connector)
47
- * [`heroku data:connectors:wait CONNECTOR`](#heroku-dataconnectorswait-connector)
48
- * [`heroku data:enhanced-certificates:disable ADDON`](#heroku-dataenhanced-certificatesdisable-addon)
49
- * [`heroku data:enhanced-certificates:enable ADDON`](#heroku-dataenhanced-certificatesenable-addon)
50
- * [`heroku data:enhanced-certificates:status ADDON`](#heroku-dataenhanced-certificatesstatus-addon)
51
- * [`heroku data:labs:disable FEATURE`](#heroku-datalabsdisable-feature)
52
- * [`heroku data:labs:enable FEATURE`](#heroku-datalabsenable-feature)
53
- * [`heroku data:labs:list ADDON`](#heroku-datalabslist-addon)
40
+ # Command Topics
54
41
 
55
- ## `heroku data:connectors`
42
+ * [`heroku data`](docs/data.md) - List all Data Connectors for a particular app or addon
56
43
 
57
- List all Data Connectors for a particular app or addon
58
-
59
- ```
60
- USAGE
61
- $ heroku data:connectors [--prompt] [--addon <value>] [-a <value>] [--json | --table] [-r <value>]
62
-
63
- FLAGS
64
- -a, --app=<value> [env: HEROKU_APP] app to run command against
65
- -r, --remote=<value> git remote of app to use
66
- --addon=<value> The ID or name for the addon your connector is attached to
67
- --json Return the results as JSON
68
- --table Return the results as a table
69
-
70
- GLOBAL FLAGS
71
- --prompt interactively prompt for command arguments and flags
72
-
73
- DESCRIPTION
74
- List all Data Connectors for a particular app or addon
75
- Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
76
-
77
- ALIASES
78
- $ heroku data:connectors:list
79
-
80
- EXAMPLES
81
- $ heroku data:connectors -a your-app
82
-
83
- $ heroku data:connectors --app=your-app --json
84
-
85
- $ heroku data:connectors --addon=your-postgres-addon --table
86
- ```
87
-
88
- _See code: [src/commands/data/connectors/index.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.5/src/commands/data/connectors/index.ts)_
89
-
90
- ## `heroku data:connectors:create`
91
-
92
- create a new Data Connector
93
-
94
- ```
95
- USAGE
96
- $ heroku data:connectors:create --source <value> --store <value> -t <value>... [--prompt] [-a <value>] [--exclude-column
97
- <value>...] [--name <value>]
98
-
99
- FLAGS
100
- -a, --app=<value> [env: HEROKU_APP] app to run command against
101
- -t, --table=<value>... (required) Tables to include
102
- --exclude-column=<value>... Columns to exclude
103
- --name=<value> Name of the connector
104
- --source=<value> (required) The name of the database add-on whose change data you want to store
105
- --store=<value> (required) The name of the database add-on that will store the change data
106
-
107
- GLOBAL FLAGS
108
- --prompt interactively prompt for command arguments and flags
109
-
110
- DESCRIPTION
111
- create a new Data Connector
112
- Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
113
-
114
- EXAMPLES
115
- $ heroku data:connectors:create --store kafka-lovely-12345 --source postgresql-neato-98765 --table public.posts --table public.comments
116
-
117
- $ heroku data:connectors:create --store kafka-lovely-12345 --source postgresql-neato-98765 --table public.users --exclude-column public.users.password
118
- ```
119
-
120
- _See code: [src/commands/data/connectors/create.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.5/src/commands/data/connectors/create.ts)_
121
-
122
- ## `heroku data:connectors:destroy CONNECTOR`
123
-
124
- Destroy a Data Connector
125
-
126
- ```
127
- USAGE
128
- $ heroku data:connectors:destroy CONNECTOR [--prompt] [--confirm <value>]
129
-
130
- ARGUMENTS
131
- CONNECTOR name of the connector
132
-
133
- FLAGS
134
- --confirm=<value> confirms destroying the connector if passed in
135
-
136
- GLOBAL FLAGS
137
- --prompt interactively prompt for command arguments and flags
138
-
139
- DESCRIPTION
140
- Destroy a Data Connector
141
- Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
142
-
143
- EXAMPLES
144
- $ heroku data:connectors:destroy gentle-connector-1234
145
-
146
- $ heroku data:connectors:destroy gentle-connector-1234 --confirm gentle-connector-1234
147
- ```
148
-
149
- _See code: [src/commands/data/connectors/destroy.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.5/src/commands/data/connectors/destroy.ts)_
150
-
151
- ## `heroku data:connectors:info CONNECTOR`
152
-
153
- Get information about a Data Connector
154
-
155
- ```
156
- USAGE
157
- $ heroku data:connectors:info CONNECTOR [--prompt] [--json]
158
-
159
- ARGUMENTS
160
- CONNECTOR name of the connector
161
-
162
- FLAGS
163
- --json Return the results as JSON
164
-
165
- GLOBAL FLAGS
166
- --prompt interactively prompt for command arguments and flags
167
-
168
- DESCRIPTION
169
- Get information about a Data Connector
170
- Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
171
-
172
- EXAMPLES
173
- $ heroku data:connectors:info gentle-connector-1234
174
-
175
- $ heroku data:connectors:info gentle-connector-1234 --json
176
- ```
177
-
178
- _See code: [src/commands/data/connectors/info.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.5/src/commands/data/connectors/info.ts)_
179
-
180
- ## `heroku data:connectors:list`
181
-
182
- List all Data Connectors for a particular app or addon
183
-
184
- ```
185
- USAGE
186
- $ heroku data:connectors:list [--prompt] [--addon <value>] [-a <value>] [--json | --table] [-r <value>]
187
-
188
- FLAGS
189
- -a, --app=<value> [env: HEROKU_APP] app to run command against
190
- -r, --remote=<value> git remote of app to use
191
- --addon=<value> The ID or name for the addon your connector is attached to
192
- --json Return the results as JSON
193
- --table Return the results as a table
194
-
195
- GLOBAL FLAGS
196
- --prompt interactively prompt for command arguments and flags
197
-
198
- DESCRIPTION
199
- List all Data Connectors for a particular app or addon
200
- Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
201
-
202
- ALIASES
203
- $ heroku data:connectors:list
204
-
205
- EXAMPLES
206
- $ heroku data:connectors -a your-app
207
-
208
- $ heroku data:connectors --app=your-app --json
209
-
210
- $ heroku data:connectors --addon=your-postgres-addon --table
211
- ```
212
-
213
- ## `heroku data:connectors:pause CONNECTOR`
214
-
215
- Pause change event creation on a Data Connector
216
-
217
- ```
218
- USAGE
219
- $ heroku data:connectors:pause CONNECTOR [--prompt]
220
-
221
- ARGUMENTS
222
- CONNECTOR name of the connector
223
-
224
- GLOBAL FLAGS
225
- --prompt interactively prompt for command arguments and flags
226
-
227
- DESCRIPTION
228
- Pause change event creation on a Data Connector
229
- Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
230
-
231
- EXAMPLES
232
- $ heroku data:connectors:pause gentle-connector-1234
233
- ```
234
-
235
- _See code: [src/commands/data/connectors/pause.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.5/src/commands/data/connectors/pause.ts)_
236
-
237
- ## `heroku data:connectors:resume CONNECTOR`
238
-
239
- Resume change event creation on a Data Connector
240
-
241
- ```
242
- USAGE
243
- $ heroku data:connectors:resume CONNECTOR [--prompt]
244
-
245
- ARGUMENTS
246
- CONNECTOR name of the connector
247
-
248
- GLOBAL FLAGS
249
- --prompt interactively prompt for command arguments and flags
250
-
251
- DESCRIPTION
252
- Resume change event creation on a Data Connector
253
- Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
254
-
255
- EXAMPLES
256
- $ heroku data:connectors:resume gentle-connector-1234
257
- ```
258
-
259
- _See code: [src/commands/data/connectors/resume.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.5/src/commands/data/connectors/resume.ts)_
260
-
261
- ## `heroku data:connectors:update CONNECTOR`
262
-
263
- Update the settings, tables, and columns to exclude for a Data Connector
264
-
265
- ```
266
- USAGE
267
- $ heroku data:connectors:update CONNECTOR [--prompt] [--setting <value>...] [--add-table <value>...] [--remove-table
268
- <value>...] [--exclude-column <value>...] [--remove-excluded-column <value>...]
269
-
270
- ARGUMENTS
271
- CONNECTOR name of the connector
272
-
273
- FLAGS
274
- --add-table=<value>... Tables to add
275
- --exclude-column=<value>... Columns to exclude
276
- --remove-excluded-column=<value>... Columns to no longer exclude
277
- --remove-table=<value>... Tables to remove
278
- --setting=<value>...
279
-
280
- GLOBAL FLAGS
281
- --prompt interactively prompt for command arguments and flags
282
-
283
- DESCRIPTION
284
- Update the settings, tables, and columns to exclude for a Data Connector
285
- Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors#update-configuration
286
-
287
- EXAMPLES
288
- $ heroku data:connectors:update gentle-connector-1234 --setting key=value --setting otherKey=otherValue --add-table public.posts --add-table public.people --remove-table public.messages --exclude-column public.posts.key --remove-excluded-column public.parcels.key
289
- ```
290
-
291
- _See code: [src/commands/data/connectors/update.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.5/src/commands/data/connectors/update.ts)_
292
-
293
- ## `heroku data:connectors:wait CONNECTOR`
294
-
295
- Wait for your Data Connector to be provisioned
296
-
297
- ```
298
- USAGE
299
- $ heroku data:connectors:wait CONNECTOR [--prompt]
300
-
301
- ARGUMENTS
302
- CONNECTOR name of the connector
303
-
304
- GLOBAL FLAGS
305
- --prompt interactively prompt for command arguments and flags
306
-
307
- DESCRIPTION
308
- Wait for your Data Connector to be provisioned
309
- Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
310
-
311
- EXAMPLES
312
- $ heroku data:connectors:wait gentle-connector-1234
313
- ```
314
-
315
- _See code: [src/commands/data/connectors/wait.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.5/src/commands/data/connectors/wait.ts)_
316
-
317
- ## `heroku data:enhanced-certificates:disable ADDON`
318
-
319
- Disable enhanced certificates on an Addon
320
-
321
- ```
322
- USAGE
323
- $ heroku data:enhanced-certificates:disable ADDON [--prompt] [-a <value>]
324
-
325
- ARGUMENTS
326
- ADDON name of the addon
327
-
328
- FLAGS
329
- -a, --app=<value> [env: HEROKU_APP] app to run command against
330
-
331
- GLOBAL FLAGS
332
- --prompt interactively prompt for command arguments and flags
333
-
334
- DESCRIPTION
335
- Disable enhanced certificates on an Addon
336
- Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificates
337
- ```
338
-
339
- _See code: [src/commands/data/enhanced-certificates/disable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.5/src/commands/data/enhanced-certificates/disable.ts)_
340
-
341
- ## `heroku data:enhanced-certificates:enable ADDON`
342
-
343
- Enable enhanced certificates on an Addon
344
-
345
- ```
346
- USAGE
347
- $ heroku data:enhanced-certificates:enable ADDON [--prompt] [-a <value>]
348
-
349
- ARGUMENTS
350
- ADDON name of the addon
351
-
352
- FLAGS
353
- -a, --app=<value> [env: HEROKU_APP] app to run command against
354
-
355
- GLOBAL FLAGS
356
- --prompt interactively prompt for command arguments and flags
357
-
358
- DESCRIPTION
359
- Enable enhanced certificates on an Addon
360
- Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificates
361
-
362
- EXAMPLES
363
- $ heroku data:enhanced-certificates:enable happy-postgres-1234 -a example-app
364
- ```
365
-
366
- _See code: [src/commands/data/enhanced-certificates/enable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.5/src/commands/data/enhanced-certificates/enable.ts)_
367
-
368
- ## `heroku data:enhanced-certificates:status ADDON`
369
-
370
- Get the status of Enhanced Certificates
371
-
372
- ```
373
- USAGE
374
- $ heroku data:enhanced-certificates:status ADDON [--prompt] [-a <value>] [--json]
375
-
376
- ARGUMENTS
377
- ADDON name of the addon
378
-
379
- FLAGS
380
- -a, --app=<value> [env: HEROKU_APP] app to run command against
381
- --json Return the results as JSON
382
-
383
- GLOBAL FLAGS
384
- --prompt interactively prompt for command arguments and flags
385
-
386
- DESCRIPTION
387
- Get the status of Enhanced Certificates
388
- Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificates
389
- ```
390
-
391
- _See code: [src/commands/data/enhanced-certificates/status.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.5/src/commands/data/enhanced-certificates/status.ts)_
392
-
393
- ## `heroku data:labs:disable FEATURE`
394
-
395
- Disable experimental features on an addon
396
-
397
- ```
398
- USAGE
399
- $ heroku data:labs:disable FEATURE --addon <value> [--prompt] [-a <value>]
400
-
401
- ARGUMENTS
402
- FEATURE name of the feature
403
-
404
- FLAGS
405
- -a, --app=<value> [env: HEROKU_APP] app to run command against
406
- --addon=<value> (required) The addon you want to disable features on
407
-
408
- GLOBAL FLAGS
409
- --prompt interactively prompt for command arguments and flags
410
-
411
- DESCRIPTION
412
- Disable experimental features on an addon
413
-
414
- EXAMPLES
415
- $ heroku data:labs:disable wal-compression --addon=happy-postgres-1234 -a example-app
416
- ```
417
-
418
- _See code: [src/commands/data/labs/disable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.5/src/commands/data/labs/disable.ts)_
419
-
420
- ## `heroku data:labs:enable FEATURE`
421
-
422
- Enable experimental features on an addon
423
-
424
- ```
425
- USAGE
426
- $ heroku data:labs:enable FEATURE --addon <value> [--prompt] [-a <value>]
427
-
428
- ARGUMENTS
429
- FEATURE name of the feature
430
-
431
- FLAGS
432
- -a, --app=<value> [env: HEROKU_APP] app to run command against
433
- --addon=<value> (required) The addon you want to enable features on
434
-
435
- GLOBAL FLAGS
436
- --prompt interactively prompt for command arguments and flags
437
-
438
- DESCRIPTION
439
- Enable experimental features on an addon
440
-
441
- EXAMPLES
442
- $ heroku data:labs:enable wal-compression --addon=happy-postgres-1234 -a example-app
443
- ```
444
-
445
- _See code: [src/commands/data/labs/enable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.5/src/commands/data/labs/enable.ts)_
446
-
447
- ## `heroku data:labs:list ADDON`
448
-
449
- List available experimental features on an addon and their statuses
450
-
451
- ```
452
- USAGE
453
- $ heroku data:labs:list ADDON [--prompt] [-a <value>]
454
-
455
- ARGUMENTS
456
- ADDON name of the addon
457
-
458
- FLAGS
459
- -a, --app=<value> [env: HEROKU_APP] app to run command against
460
-
461
- GLOBAL FLAGS
462
- --prompt interactively prompt for command arguments and flags
463
-
464
- DESCRIPTION
465
- List available experimental features on an addon and their statuses
466
-
467
- EXAMPLES
468
- $ heroku data:labs:list happy-postgres-1234
469
- ```
470
-
471
- _See code: [src/commands/data/labs/list.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.5/src/commands/data/labs/list.ts)_
472
44
  <!-- commandsstop -->
package/dist/lib/base.js CHANGED
@@ -9,6 +9,11 @@ export default class Base extends Command {
9
9
  return this._shogun;
10
10
  const client = new APIClient(this.config, {});
11
11
  client.defaults.host = process.env.HEROKU_DATA_HOST || 'api.data.heroku.com';
12
+ // Cast needed since @types/node 26 widened `ClientRequestArgs.headers` to
13
+ // `OutgoingHttpHeaders | readonly string[] | undefined` (was `OutgoingHttpHeaders | undefined`),
14
+ // which makes the plain object literal below ambiguous against http-call's
15
+ // `headers: OutgoingHttpHeaders` intersection type. We're always building the
16
+ // object form, never the flat-array form, so this narrows without changing behavior.
12
17
  client.defaults.headers = {
13
18
  ...this.heroku.defaults.headers,
14
19
  authorization: `Basic ${Buffer.from(':' + this.heroku.auth).toString('base64')}`,
@@ -751,5 +751,5 @@
751
751
  ]
752
752
  }
753
753
  },
754
- "version": "3.0.5"
754
+ "version": "3.0.7"
755
755
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@heroku-cli/plugin-data",
3
3
  "description": "A Heroku CLI Plugin for managing Heroku Data",
4
- "version": "3.0.5",
4
+ "version": "3.0.7",
5
5
  "author": "Heroku",
6
6
  "bugs": "https://github.com/heroku/heroku-cli-plugin-data/issues",
7
7
  "dependencies": {
@@ -14,18 +14,19 @@
14
14
  "@heroku-cli/schema": "^2.0.1",
15
15
  "@heroku-cli/test-utils": "^1.0.1",
16
16
  "@oclif/plugin-help": "^6.2.49",
17
- "@types/chai": "^4",
17
+ "@types/chai": "^5",
18
18
  "@types/mocha": "^10.0.10",
19
- "@types/node": "20.14.8",
19
+ "@types/node": "26.4.0",
20
20
  "ansis": "^4.3.0",
21
21
  "c8": "^10.1.3",
22
22
  "chai": "^6.2.2",
23
23
  "eslint": "^9.39.4",
24
24
  "eslint-config-oclif": "^6.0.144",
25
25
  "eslint-plugin-mocha": "^11.2.0",
26
- "mocha": "^11.7.5",
26
+ "mocha": "^12.0.3",
27
27
  "nock": "^14.0.15",
28
28
  "oclif": "^4.23.0",
29
+ "rimraf": "^6.1.3",
29
30
  "tsx": "^4.22.3",
30
31
  "typescript": "^5.9.3"
31
32
  },
@@ -43,6 +44,7 @@
43
44
  ],
44
45
  "license": "MIT",
45
46
  "oclif": {
47
+ "repositoryPrefix": "<%- repo %>/blob/plugin-data-v<%- version %>/<%- commandPath %>",
46
48
  "commands": "./dist/commands",
47
49
  "bin": "heroku",
48
50
  "devPlugins": [
@@ -54,17 +56,22 @@
54
56
  "access": "public"
55
57
  },
56
58
  "scripts": {
57
- "build": "rm -rf dist && tsc && oclif manifest && oclif readme",
59
+ "clean": "rimraf dist",
60
+ "build": "npm run clean && tsc",
61
+ "manifest": "oclif manifest",
62
+ "readme": "oclif readme",
58
63
  "lint": "eslint .",
59
- "postpublish": "rm -f oclif.manifest.json",
60
- "posttest": "npm run lint",
61
- "prepare": "npm run build",
62
- "test": "c8 mocha --forbid-only \"test/**/*.test.ts\"",
63
- "version": "oclif readme && git add README.md"
64
+ "lint:fix": "eslint . --fix",
65
+ "test": "mocha --forbid-only \"test/**/*.test.ts\"",
66
+ "test:watch": "mocha --watch \"test/**/*.test.ts\"",
67
+ "test:coverage": "c8 --reporter=text-summary --reporter=lcovonly mocha --forbid-only \"test/**/*.test.ts\"",
68
+ "docs:generate": "npm run build && npm run manifest && oclif readme --output-dir docs --multi",
69
+ "prepare": "npm run build && npm run manifest",
70
+ "postpack": "rimraf oclif.manifest.json"
64
71
  },
65
72
  "//overrides": "mocha (dev-only) transitive deps pinned to patched versions: serialize-javascript for CVE-2024-11831; diff (jsdiff) for GHSA-73rr-hh4g-fpgx, a low-sev DoS in <8.0.3.",
66
73
  "overrides": {
67
- "serialize-javascript": "^7.0.5",
74
+ "serialize-javascript": "^7.1.4",
68
75
  "diff": ">=8.0.3"
69
76
  }
70
77
  }