@heroku-cli/plugin-mtls 2.0.4 → 2.0.6

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
@@ -7,6 +7,7 @@
7
7
  * [Heroku CLI MTLS Plugin](#heroku-cli-mtls-plugin)
8
8
  * [Installation](#installation)
9
9
  * [Commands](#commands)
10
+ * [Command Topics](#command-topics)
10
11
  <!-- tocstop -->
11
12
  # Installation
12
13
  ```sh-session
@@ -14,373 +15,8 @@ $ heroku plugins:install @heroku-cli/plugin-mtls
14
15
  ```
15
16
  # Commands
16
17
  <!-- commands -->
17
- * [`heroku data:mtls ADDON`](#heroku-datamtls-addon)
18
- * [`heroku data:mtls:certificates ADDON`](#heroku-datamtlscertificates-addon)
19
- * [`heroku data:mtls:certificates:create ADDON`](#heroku-datamtlscertificatescreate-addon)
20
- * [`heroku data:mtls:certificates:delete ADDON`](#heroku-datamtlscertificatesdelete-addon)
21
- * [`heroku data:mtls:certificates:download ADDON`](#heroku-datamtlscertificatesdownload-addon)
22
- * [`heroku data:mtls:certificates:get ADDON`](#heroku-datamtlscertificatesget-addon)
23
- * [`heroku data:mtls:create ADDON`](#heroku-datamtlscreate-addon)
24
- * [`heroku data:mtls:delete ADDON`](#heroku-datamtlsdelete-addon)
25
- * [`heroku data:mtls:destroy ADDON`](#heroku-datamtlsdestroy-addon)
26
- * [`heroku data:mtls:ip-rules ADDON`](#heroku-datamtlsip-rules-addon)
27
- * [`heroku data:mtls:ip-rules:create ADDON`](#heroku-datamtlsip-rulescreate-addon)
28
- * [`heroku data:mtls:ip-rules:delete ADDON`](#heroku-datamtlsip-rulesdelete-addon)
29
- * [`heroku data:mtls:ip-rules:get ADDON`](#heroku-datamtlsip-rulesget-addon)
18
+ # Command Topics
30
19
 
31
- ## `heroku data:mtls ADDON`
20
+ * [`heroku data`](docs/data.md) - get the status of mTLS for your add-on
32
21
 
33
- get the status of mTLS for your add-on
34
-
35
- ```
36
- USAGE
37
- $ heroku data:mtls ADDON -a <value> [--prompt]
38
-
39
- ARGUMENTS
40
- ADDON addon
41
-
42
- FLAGS
43
- -a, --app=<value> (required) [env: HEROKU_APP] app to run command against
44
-
45
- GLOBAL FLAGS
46
- --prompt interactively prompt for command arguments and flags
47
-
48
- DESCRIPTION
49
- get the status of mTLS for your add-on
50
-
51
- EXAMPLES
52
- $ heroku data:mtls postgresql-sushi-12345 -a example-app
53
- ```
54
-
55
- _See code: [src/commands/data/mtls/index.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v2.0.4/src/commands/data/mtls/index.ts)_
56
-
57
- ## `heroku data:mtls:certificates ADDON`
58
-
59
- get the certificates for your mTLS enabled add-on
60
-
61
- ```
62
- USAGE
63
- $ heroku data:mtls:certificates ADDON -a <value> [--prompt]
64
-
65
- ARGUMENTS
66
- ADDON addon
67
-
68
- FLAGS
69
- -a, --app=<value> (required) [env: HEROKU_APP] app to run command against
70
-
71
- GLOBAL FLAGS
72
- --prompt interactively prompt for command arguments and flags
73
-
74
- DESCRIPTION
75
- get the certificates for your mTLS enabled add-on
76
-
77
- EXAMPLES
78
- $ heroku data:mtls:certificates postgresql-sushi-12345 -a example-app
79
- ```
80
-
81
- _See code: [src/commands/data/mtls/certificates/index.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v2.0.4/src/commands/data/mtls/certificates/index.ts)_
82
-
83
- ## `heroku data:mtls:certificates:create ADDON`
84
-
85
- create a new certificate for your mTLS enabled add-on
86
-
87
- ```
88
- USAGE
89
- $ heroku data:mtls:certificates:create ADDON -a <value> [--prompt]
90
-
91
- ARGUMENTS
92
- ADDON addon
93
-
94
- FLAGS
95
- -a, --app=<value> (required) [env: HEROKU_APP] app to run command against
96
-
97
- GLOBAL FLAGS
98
- --prompt interactively prompt for command arguments and flags
99
-
100
- DESCRIPTION
101
- create a new certificate for your mTLS enabled add-on
102
-
103
- EXAMPLES
104
- $ heroku data:mtls:certificates:create postgresql-sushi-12345 -a example-app
105
- ```
106
-
107
- _See code: [src/commands/data/mtls/certificates/create.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v2.0.4/src/commands/data/mtls/certificates/create.ts)_
108
-
109
- ## `heroku data:mtls:certificates:delete ADDON`
110
-
111
- delete a specific certificate for your mTLS enabled add-on
112
-
113
- ```
114
- USAGE
115
- $ heroku data:mtls:certificates:delete ADDON -a <value> --id <value> [--prompt]
116
-
117
- ARGUMENTS
118
- ADDON addon
119
-
120
- FLAGS
121
- -a, --app=<value> (required) [env: HEROKU_APP] app to run command against
122
- --id=<value> (required) id of certificate
123
-
124
- GLOBAL FLAGS
125
- --prompt interactively prompt for command arguments and flags
126
-
127
- DESCRIPTION
128
- delete a specific certificate for your mTLS enabled add-on
129
-
130
- EXAMPLES
131
- $ heroku data:mtls:certificates:delete postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app
132
- ```
133
-
134
- _See code: [src/commands/data/mtls/certificates/delete.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v2.0.4/src/commands/data/mtls/certificates/delete.ts)_
135
-
136
- ## `heroku data:mtls:certificates:download ADDON`
137
-
138
- download your certificate bundle for your mTLS add-on
139
-
140
- ```
141
- USAGE
142
- $ heroku data:mtls:certificates:download ADDON -a <value> --prefix <value> [--prompt] [--dir <value>] [--id <value>]
143
-
144
- ARGUMENTS
145
- ADDON addon
146
-
147
- FLAGS
148
- -a, --app=<value> (required) [env: HEROKU_APP] app to run command against
149
- --dir=<value> directory to download files to. defaults to HOME:/.postgresql
150
- --id=<value> ID of certificate to download
151
- --prefix=<value> (required) prefix to put in front of downloaded file names
152
-
153
- GLOBAL FLAGS
154
- --prompt interactively prompt for command arguments and flags
155
-
156
- DESCRIPTION
157
- download your certificate bundle for your mTLS add-on
158
-
159
- EXAMPLES
160
- $ heroku data:mtls:certificates:download postgresql-sushi-12345 --id "3559a4df-2c82-4473-86cf-181310a6ef4f" -a example-app
161
-
162
- $ heroku data:mtls:certificates:download postgresql-sushi-12345 --id "3559a4df-2c82-4473-86cf-181310a6ef4f" --dir "./folder" -a example-app
163
-
164
- $ heroku data:mtls:certificates:download postgresql-sushi-12345 --id "3559a4df-2c82-4473-86cf-181310a6ef4f --prefix "prefix_" -a example-app
165
- ```
166
-
167
- _See code: [src/commands/data/mtls/certificates/download.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v2.0.4/src/commands/data/mtls/certificates/download.ts)_
168
-
169
- ## `heroku data:mtls:certificates:get ADDON`
170
-
171
- get a specific certificate for your mTLS enabled add-on
172
-
173
- ```
174
- USAGE
175
- $ heroku data:mtls:certificates:get ADDON -a <value> --id <value> [--prompt]
176
-
177
- ARGUMENTS
178
- ADDON addon
179
-
180
- FLAGS
181
- -a, --app=<value> (required) [env: HEROKU_APP] app to run command against
182
- --id=<value> (required) id of IP Rule
183
-
184
- GLOBAL FLAGS
185
- --prompt interactively prompt for command arguments and flags
186
-
187
- DESCRIPTION
188
- get a specific certificate for your mTLS enabled add-on
189
-
190
- EXAMPLES
191
- $ heroku data:mtls:certificates:get postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app
192
- ```
193
-
194
- _See code: [src/commands/data/mtls/certificates/get.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v2.0.4/src/commands/data/mtls/certificates/get.ts)_
195
-
196
- ## `heroku data:mtls:create ADDON`
197
-
198
- enable MTLS for your addon
199
-
200
- ```
201
- USAGE
202
- $ heroku data:mtls:create ADDON -a <value> [--prompt]
203
-
204
- ARGUMENTS
205
- ADDON addon
206
-
207
- FLAGS
208
- -a, --app=<value> (required) [env: HEROKU_APP] app to run command against
209
-
210
- GLOBAL FLAGS
211
- --prompt interactively prompt for command arguments and flags
212
-
213
- DESCRIPTION
214
- enable MTLS for your addon
215
-
216
- EXAMPLES
217
- $ heroku data:mtls:create postgresql-sushi-12345 -a example-app
218
- ```
219
-
220
- _See code: [src/commands/data/mtls/create.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v2.0.4/src/commands/data/mtls/create.ts)_
221
-
222
- ## `heroku data:mtls:delete ADDON`
223
-
224
- disable mTLS for your add-on
225
-
226
- ```
227
- USAGE
228
- $ heroku data:mtls:delete ADDON -a <value> [--prompt]
229
-
230
- ARGUMENTS
231
- ADDON addon
232
-
233
- FLAGS
234
- -a, --app=<value> (required) [env: HEROKU_APP] app to run command against
235
-
236
- GLOBAL FLAGS
237
- --prompt interactively prompt for command arguments and flags
238
-
239
- DESCRIPTION
240
- disable mTLS for your add-on
241
-
242
- ALIASES
243
- $ heroku data:mtls:delete
244
-
245
- EXAMPLES
246
- $ heroku data:mtls:destroy postgresql-sushi-12345 -a example-app
247
- ```
248
-
249
- ## `heroku data:mtls:destroy ADDON`
250
-
251
- disable mTLS for your add-on
252
-
253
- ```
254
- USAGE
255
- $ heroku data:mtls:destroy ADDON -a <value> [--prompt]
256
-
257
- ARGUMENTS
258
- ADDON addon
259
-
260
- FLAGS
261
- -a, --app=<value> (required) [env: HEROKU_APP] app to run command against
262
-
263
- GLOBAL FLAGS
264
- --prompt interactively prompt for command arguments and flags
265
-
266
- DESCRIPTION
267
- disable mTLS for your add-on
268
-
269
- ALIASES
270
- $ heroku data:mtls:delete
271
-
272
- EXAMPLES
273
- $ heroku data:mtls:destroy postgresql-sushi-12345 -a example-app
274
- ```
275
-
276
- _See code: [src/commands/data/mtls/destroy.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v2.0.4/src/commands/data/mtls/destroy.ts)_
277
-
278
- ## `heroku data:mtls:ip-rules ADDON`
279
-
280
- get the IP Rules for your mTLS enabled add-on
281
-
282
- ```
283
- USAGE
284
- $ heroku data:mtls:ip-rules ADDON -a <value> [--prompt]
285
-
286
- ARGUMENTS
287
- ADDON addon
288
-
289
- FLAGS
290
- -a, --app=<value> (required) [env: HEROKU_APP] app to run command against
291
-
292
- GLOBAL FLAGS
293
- --prompt interactively prompt for command arguments and flags
294
-
295
- DESCRIPTION
296
- get the IP Rules for your mTLS enabled add-on
297
-
298
- EXAMPLES
299
- $ heroku data:mtls:ip-rules postgresql-sushi-12345 -a example-app
300
- ```
301
-
302
- _See code: [src/commands/data/mtls/ip-rules/index.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v2.0.4/src/commands/data/mtls/ip-rules/index.ts)_
303
-
304
- ## `heroku data:mtls:ip-rules:create ADDON`
305
-
306
- create a new IP Rule for your mTLS enabled add-on
307
-
308
- ```
309
- USAGE
310
- $ heroku data:mtls:ip-rules:create ADDON -a <value> --cidr <value> [--prompt] [--description <value>]
311
-
312
- ARGUMENTS
313
- ADDON addon
314
-
315
- FLAGS
316
- -a, --app=<value> (required) [env: HEROKU_APP] app to run command against
317
- --cidr=<value> (required) CIDR block to allow
318
- --description=<value> description of the IP rule
319
-
320
- GLOBAL FLAGS
321
- --prompt interactively prompt for command arguments and flags
322
-
323
- DESCRIPTION
324
- create a new IP Rule for your mTLS enabled add-on
325
-
326
- EXAMPLES
327
- $ heroku data:mtls:ip-rules:create postgresql-sushi-12345 --cidr "1.2.3.4/32" --description "home IP address" -a example-app
328
- ```
329
-
330
- _See code: [src/commands/data/mtls/ip-rules/create.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v2.0.4/src/commands/data/mtls/ip-rules/create.ts)_
331
-
332
- ## `heroku data:mtls:ip-rules:delete ADDON`
333
-
334
- delete a specific IP Rule for your mTLS enabled add-on
335
-
336
- ```
337
- USAGE
338
- $ heroku data:mtls:ip-rules:delete ADDON -a <value> [--prompt] [--cidr <value>] [--id <value>]
339
-
340
- ARGUMENTS
341
- ADDON addon
342
-
343
- FLAGS
344
- -a, --app=<value> (required) [env: HEROKU_APP] app to run command against
345
- --cidr=<value> cidr of IP Rule
346
- --id=<value> id of IP Rule
347
-
348
- GLOBAL FLAGS
349
- --prompt interactively prompt for command arguments and flags
350
-
351
- DESCRIPTION
352
- delete a specific IP Rule for your mTLS enabled add-on
353
-
354
- EXAMPLES
355
- $ heroku data:mtls:ip-rules:delete postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app
356
- ```
357
-
358
- _See code: [src/commands/data/mtls/ip-rules/delete.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v2.0.4/src/commands/data/mtls/ip-rules/delete.ts)_
359
-
360
- ## `heroku data:mtls:ip-rules:get ADDON`
361
-
362
- get the a specific IP Rule for your mTLS enabled add-on
363
-
364
- ```
365
- USAGE
366
- $ heroku data:mtls:ip-rules:get ADDON -a <value> --id <value> [--prompt]
367
-
368
- ARGUMENTS
369
- ADDON addon
370
-
371
- FLAGS
372
- -a, --app=<value> (required) [env: HEROKU_APP] app to run command against
373
- --id=<value> (required) id of IP Rule
374
-
375
- GLOBAL FLAGS
376
- --prompt interactively prompt for command arguments and flags
377
-
378
- DESCRIPTION
379
- get the a specific IP Rule for your mTLS enabled add-on
380
-
381
- EXAMPLES
382
- $ heroku data:mtls:ip-rules:get postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app
383
- ```
384
-
385
- _See code: [src/commands/data/mtls/ip-rules/get.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v2.0.4/src/commands/data/mtls/ip-rules/get.ts)_
386
22
  <!-- commandsstop -->
@@ -668,5 +668,5 @@
668
668
  ]
669
669
  }
670
670
  },
671
- "version": "2.0.4"
671
+ "version": "2.0.6"
672
672
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@heroku-cli/plugin-mtls",
3
3
  "description": "heroku mtls cli",
4
- "version": "2.0.4",
4
+ "version": "2.0.6",
5
5
  "author": "Heroku",
6
6
  "type": "module",
7
7
  "bugs": "https://github.com/heroku/heroku-cli-plugin-mtls/issues",
@@ -14,12 +14,12 @@
14
14
  "tslib": "~2.8.1"
15
15
  },
16
16
  "devDependencies": {
17
- "@heroku-cli/test-utils": "^1.0.1",
18
- "@types/chai": "^4",
17
+ "@heroku-cli/test-utils": "^1.0.3",
18
+ "@types/chai": "^5",
19
19
  "@types/mocha": "^10.0.6",
20
- "@types/node": "^26.5.1",
20
+ "@types/node": "^26.6.3",
21
21
  "@types/sinon": "^17.0.2",
22
- "ansis": "^3.17.0",
22
+ "ansis": "^4.4.0",
23
23
  "c8": "^12.0.0",
24
24
  "chai": "^6.2.2",
25
25
  "conventional-changelog": "^8.1.3",
@@ -27,10 +27,10 @@
27
27
  "eslint": "^9",
28
28
  "mocha": "^11",
29
29
  "nock": "^14.0.1",
30
- "oclif": "^4.22.81",
31
- "shx": "^0.4.0",
30
+ "oclif": "^6.0.2",
31
+ "rimraf": "^6.1.3",
32
32
  "sinon": "^20",
33
- "tsx": "^4.21.0",
33
+ "tsx": "^4.23.15",
34
34
  "typescript": "^5.9.3"
35
35
  },
36
36
  "engines": {
@@ -47,25 +47,39 @@
47
47
  ],
48
48
  "license": "MIT",
49
49
  "oclif": {
50
+ "repositoryPrefix": "<%- repo %>/blob/plugin-mtls-v<%- version %>/<%- commandPath %>",
50
51
  "bin": "heroku",
51
52
  "commands": "./dist/commands"
52
53
  },
53
54
  "repository": "heroku/heroku-cli-plugin-mtls",
54
55
  "scripts": {
55
- "build": "shx rm -rf dist && tsc && oclif manifest && oclif readme",
56
- "changelog": "conventional-changelog -p conventionalcommits -s -i CHANGELOG.md",
56
+ "clean": "rimraf dist",
57
+ "build": "npm run clean && tsc",
58
+ "manifest": "oclif manifest",
59
+ "readme": "oclif readme",
57
60
  "lint": "eslint .",
58
61
  "lint:fix": "eslint . --fix",
59
- "postpublish": "shx 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"
62
+ "test": "mocha --forbid-only \"test/**/*.test.ts\"",
63
+ "test:watch": "mocha --watch \"test/**/*.test.ts\"",
64
+ "test:coverage": "c8 --reporter=text-summary --reporter=lcovonly mocha --forbid-only \"test/**/*.test.ts\"",
65
+ "docs:generate": "npm run build && npm run manifest && oclif readme --output-dir docs --multi",
66
+ "prepare": "npm run build && npm run manifest",
67
+ "postpack": "rimraf oclif.manifest.json",
68
+ "changelog": "conventional-changelog -p conventionalcommits -s -i CHANGELOG.md"
64
69
  },
65
- "//overrides": "serialize-javascript: mocha transitive dep, pinned for CVE-2024-11831; flatted: pinned for advisory; diff: mocha/sinon transitive dep, pinned for GHSA-73rr-hh4g-fpgx",
70
+ "//overrides": "serialize-javascript: mocha transitive dep, pinned for CVE-2024-11831; flatted: pinned for advisory; diff: mocha/sinon transitive dep, pinned for GHSA-73rr-hh4g-fpgx; brace-expansion: scoped overrides for DoS CVEs — @eslint/config-array excluded (minimatch there expects older export shape)",
66
71
  "overrides": {
67
72
  "serialize-javascript": "^7.0.5",
68
73
  "flatted": "^3.4.2",
69
- "diff": "^8.0.3"
74
+ "diff": "^8.0.3",
75
+ "mocha": {
76
+ "brace-expansion": "^5.0.12"
77
+ },
78
+ "glob": {
79
+ "brace-expansion": "^5.0.12"
80
+ },
81
+ "filelist": {
82
+ "brace-expansion": "^5.0.12"
83
+ }
70
84
  }
71
85
  }