@sw-tsdk/plugin-connector 3.12.0-next.fbd3f73 → 3.12.0

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.
Files changed (69) hide show
  1. package/README.md +39 -443
  2. package/lib/commands/action/add.js +4 -4
  3. package/lib/commands/action/add.js.map +1 -1
  4. package/lib/commands/component/create.d.ts +1 -0
  5. package/lib/commands/component/create.js +1 -0
  6. package/lib/commands/component/create.js.map +1 -1
  7. package/lib/commands/component/image.d.ts +1 -0
  8. package/lib/commands/component/image.js +1 -0
  9. package/lib/commands/component/image.js.map +1 -1
  10. package/lib/commands/component/ssp.d.ts +1 -0
  11. package/lib/commands/component/ssp.js +1 -0
  12. package/lib/commands/component/ssp.js.map +1 -1
  13. package/lib/commands/connector/build.js +1 -1
  14. package/lib/commands/connector/build.js.map +1 -1
  15. package/lib/commands/connector/create.d.ts +2 -2
  16. package/lib/commands/connector/create.js +17 -12
  17. package/lib/commands/connector/create.js.map +1 -1
  18. package/lib/commands/connector/logo.d.ts +1 -1
  19. package/lib/commands/connector/logo.js +18 -4
  20. package/lib/commands/connector/logo.js.map +1 -1
  21. package/lib/commands/description/action.d.ts +1 -0
  22. package/lib/commands/description/action.js +1 -0
  23. package/lib/commands/description/action.js.map +1 -1
  24. package/lib/commands/description/actions.d.ts +1 -0
  25. package/lib/commands/description/actions.js +1 -0
  26. package/lib/commands/description/actions.js.map +1 -1
  27. package/lib/commands/description/component.d.ts +1 -0
  28. package/lib/commands/description/component.js +1 -0
  29. package/lib/commands/description/component.js.map +1 -1
  30. package/lib/commands/description/connector.d.ts +1 -0
  31. package/lib/commands/description/connector.js +1 -0
  32. package/lib/commands/description/connector.js.map +1 -1
  33. package/lib/commands/migrator/convert.js +1 -1
  34. package/lib/commands/migrator/convert.js.map +1 -1
  35. package/lib/commands/migrator/export.js +1 -1
  36. package/lib/commands/migrator/export.js.map +1 -1
  37. package/lib/commands/playbook/create.d.ts +1 -0
  38. package/lib/commands/playbook/create.js +1 -0
  39. package/lib/commands/playbook/create.js.map +1 -1
  40. package/lib/commands/playbook/image.d.ts +1 -0
  41. package/lib/commands/playbook/image.js +1 -0
  42. package/lib/commands/playbook/image.js.map +1 -1
  43. package/lib/commands/playbook/ssp.d.ts +1 -0
  44. package/lib/commands/playbook/ssp.js +1 -0
  45. package/lib/commands/playbook/ssp.js.map +1 -1
  46. package/lib/commands/solution/create.d.ts +1 -0
  47. package/lib/commands/solution/create.js +6 -5
  48. package/lib/commands/solution/create.js.map +1 -1
  49. package/lib/commands/solution/image.d.ts +1 -0
  50. package/lib/commands/solution/image.js +1 -0
  51. package/lib/commands/solution/image.js.map +1 -1
  52. package/lib/commands/solution/ssp.d.ts +1 -0
  53. package/lib/commands/solution/ssp.js +1 -0
  54. package/lib/commands/solution/ssp.js.map +1 -1
  55. package/lib/commands/widget/create.d.ts +1 -0
  56. package/lib/commands/widget/create.js +1 -0
  57. package/lib/commands/widget/create.js.map +1 -1
  58. package/lib/commands/widget/image.d.ts +1 -0
  59. package/lib/commands/widget/image.js +1 -0
  60. package/lib/commands/widget/image.js.map +1 -1
  61. package/lib/commands/widget/ssp.d.ts +1 -0
  62. package/lib/commands/widget/ssp.js +1 -0
  63. package/lib/commands/widget/ssp.js.map +1 -1
  64. package/lib/types/connector-types.d.ts +3 -3
  65. package/lib/types/migrator-types.d.ts +1 -0
  66. package/lib/types/migrator-types.js +1 -0
  67. package/lib/types/migrator-types.js.map +1 -1
  68. package/oclif.manifest.json +28 -11
  69. package/package.json +8 -7
package/README.md CHANGED
@@ -16,7 +16,7 @@ $ npm install -g @sw-tsdk/plugin-connector
16
16
  $ sw-tsdk-connector COMMAND
17
17
  running command...
18
18
  $ sw-tsdk-connector (--version)
19
- @sw-tsdk/plugin-connector/3.12.0-next.fbd3f73 linux-x64 node-v20.19.0
19
+ @sw-tsdk/plugin-connector/3.12.0 linux-x64 node-v20.19.0
20
20
  $ sw-tsdk-connector --help [COMMAND]
21
21
  USAGE
22
22
  $ sw-tsdk-connector COMMAND
@@ -31,9 +31,6 @@ USAGE
31
31
  * [`sw-tsdk-connector action:generate:output`](#sw-tsdk-connector-actiongenerateoutput)
32
32
  * [`sw-tsdk-connector action:run:local`](#sw-tsdk-connector-actionrunlocal)
33
33
  * [`sw-tsdk-connector asset:add`](#sw-tsdk-connector-assetadd)
34
- * [`sw-tsdk-connector component:create`](#sw-tsdk-connector-componentcreate)
35
- * [`sw-tsdk-connector component:image`](#sw-tsdk-connector-componentimage)
36
- * [`sw-tsdk-connector component:ssp`](#sw-tsdk-connector-componentssp)
37
34
  * [`sw-tsdk-connector connector:build`](#sw-tsdk-connector-connectorbuild)
38
35
  * [`sw-tsdk-connector connector:create`](#sw-tsdk-connector-connectorcreate)
39
36
  * [`sw-tsdk-connector connector:create:openapi`](#sw-tsdk-connector-connectorcreateopenapi)
@@ -43,21 +40,8 @@ USAGE
43
40
  * [`sw-tsdk-connector connector:sign`](#sw-tsdk-connector-connectorsign)
44
41
  * [`sw-tsdk-connector connector:update`](#sw-tsdk-connector-connectorupdate)
45
42
  * [`sw-tsdk-connector connector:validate`](#sw-tsdk-connector-connectorvalidate)
46
- * [`sw-tsdk-connector description:action`](#sw-tsdk-connector-descriptionaction)
47
- * [`sw-tsdk-connector description:actions`](#sw-tsdk-connector-descriptionactions)
48
- * [`sw-tsdk-connector description:component`](#sw-tsdk-connector-descriptioncomponent)
49
- * [`sw-tsdk-connector description:connector`](#sw-tsdk-connector-descriptionconnector)
50
43
  * [`sw-tsdk-connector migrator:convert`](#sw-tsdk-connector-migratorconvert)
51
44
  * [`sw-tsdk-connector migrator:export`](#sw-tsdk-connector-migratorexport)
52
- * [`sw-tsdk-connector playbook:create`](#sw-tsdk-connector-playbookcreate)
53
- * [`sw-tsdk-connector playbook:image`](#sw-tsdk-connector-playbookimage)
54
- * [`sw-tsdk-connector playbook:ssp`](#sw-tsdk-connector-playbookssp)
55
- * [`sw-tsdk-connector solution:create`](#sw-tsdk-connector-solutioncreate)
56
- * [`sw-tsdk-connector solution:image`](#sw-tsdk-connector-solutionimage)
57
- * [`sw-tsdk-connector solution:ssp`](#sw-tsdk-connector-solutionssp)
58
- * [`sw-tsdk-connector widget:create`](#sw-tsdk-connector-widgetcreate)
59
- * [`sw-tsdk-connector widget:image`](#sw-tsdk-connector-widgetimage)
60
- * [`sw-tsdk-connector widget:ssp`](#sw-tsdk-connector-widgetssp)
61
45
 
62
46
  ## `sw-tsdk-connector action:add`
63
47
 
@@ -77,7 +61,7 @@ DESCRIPTION
77
61
  Update a connector action.
78
62
  ```
79
63
 
80
- _See code: [lib/commands/action/add.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/action/add.js)_
64
+ _See code: [lib/commands/action/add.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0/lib/commands/action/add.js)_
81
65
 
82
66
  ## `sw-tsdk-connector action:generate:data`
83
67
 
@@ -102,7 +86,7 @@ DESCRIPTION
102
86
  Use to test a task in an integration
103
87
  ```
104
88
 
105
- _See code: [lib/commands/action/generate/data.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/action/generate/data.js)_
89
+ _See code: [lib/commands/action/generate/data.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0/lib/commands/action/generate/data.js)_
106
90
 
107
91
  ## `sw-tsdk-connector action:generate:input`
108
92
 
@@ -127,7 +111,7 @@ DESCRIPTION
127
111
  Update action input schema.
128
112
  ```
129
113
 
130
- _See code: [lib/commands/action/generate/input.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/action/generate/input.js)_
114
+ _See code: [lib/commands/action/generate/input.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0/lib/commands/action/generate/input.js)_
131
115
 
132
116
  ## `sw-tsdk-connector action:generate:output`
133
117
 
@@ -151,7 +135,7 @@ DESCRIPTION
151
135
  Update a connector action.
152
136
  ```
153
137
 
154
- _See code: [lib/commands/action/generate/output.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/action/generate/output.js)_
138
+ _See code: [lib/commands/action/generate/output.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0/lib/commands/action/generate/output.js)_
155
139
 
156
140
  ## `sw-tsdk-connector action:run:local`
157
141
 
@@ -180,7 +164,7 @@ DESCRIPTION
180
164
  Runs a connector action. (Defaults to current image version in local repository).
181
165
  ```
182
166
 
183
- _See code: [lib/commands/action/run/local.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/action/run/local.js)_
167
+ _See code: [lib/commands/action/run/local.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0/lib/commands/action/run/local.js)_
184
168
 
185
169
  ## `sw-tsdk-connector asset:add`
186
170
 
@@ -201,89 +185,7 @@ DESCRIPTION
201
185
  Update a connector action.
202
186
  ```
203
187
 
204
- _See code: [lib/commands/asset/add.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/asset/add.js)_
205
-
206
- ## `sw-tsdk-connector component:create`
207
-
208
- Scaffold a new Component
209
-
210
- ```
211
- USAGE
212
- $ sw-tsdk-connector component:create [-d <value>] [--componentUseCaseType <value>] [--componentFamily <value>]
213
- [--vendor <value>] [--componentName <value>] [--keywords <value>] [--description <value>] [--logoPath <value>]
214
- [--overviewImagePath <value>] [--sspPath <value>] [--author <value>] [--authorEmail <value>] [--homepage <value>]
215
- [--readmePath <value>] [--externalReadmePath <value>] [--documentationReadmePath <value>] [--externalymlPath
216
- <value>] [-h]
217
-
218
- FLAGS
219
- -d, --directory=<value> [default: ./] root directory for where to store Component.
220
- -h, --help Show CLI help.
221
- --author=<value> Component Author
222
- --authorEmail=<value> Component Author Email
223
- --componentFamily=<value> Component Family (e.g. classic | canvas)
224
- --componentName=<value> Component Name (e.g. Alert Ingestion)
225
- --componentUseCaseType=<value> Component Use Case Type (e.g. ingestion| enrichment | remidiation)
226
- --description=<value> Description (e.g. CrowdStrike Alert Ingestion Component)
227
- --documentationReadmePath=<value> Absolute path to documentation.README.md file
228
- --externalReadmePath=<value> Absolute path to EXTERNAL_README.md file
229
- --externalymlPath=<value> Absolute path to external.yml file
230
- --homepage=<value> Component Author Support URL
231
- --keywords=<value> Enter keywords
232
- --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min
233
- resolution 200x200
234
- --overviewImagePath=<value> URL or absolute path to overview image file. Min resolution 1100x660
235
- --readmePath=<value> Absolute path to README.md file
236
- --sspPath=<value> Absolute path to .ssp file
237
- --vendor=<value> Vendor (e.g. CrowdStrike)
238
-
239
- DESCRIPTION
240
- Scaffold a new Component
241
- ```
242
-
243
- _See code: [lib/commands/component/create.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/component/create.js)_
244
-
245
- ## `sw-tsdk-connector component:image`
246
-
247
- Update a Component image.
248
-
249
- ```
250
- USAGE
251
- $ sw-tsdk-connector component:image [-d <value>] [-t <value>] [-n <value>] [-i <value>] [-p <value>] [-h]
252
-
253
- FLAGS
254
- -d, --directory=<value> [default: ./] root directory of the component folder.
255
- -h, --help Show CLI help.
256
- -i, --imageType=<value> Image Type (e.g. logo/overview)
257
- -n, --componentName=<value> Component Name (e.g. google_alert_ingestion)
258
- -p, --imagePath=<value> path or URL to product image in PNG format.
259
- -t, --componentType=<value> Component Type (e.g. classic)
260
-
261
- DESCRIPTION
262
- Update a Component image.
263
- ```
264
-
265
- _See code: [lib/commands/component/image.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/component/image.js)_
266
-
267
- ## `sw-tsdk-connector component:ssp`
268
-
269
- Update an SSP.
270
-
271
- ```
272
- USAGE
273
- $ sw-tsdk-connector component:ssp [-d <value>] [-t <value>] [-n <value>] [-p <value>] [-h]
274
-
275
- FLAGS
276
- -d, --directory=<value> [default: ./] root directory of the component folder.
277
- -h, --help Show CLI help.
278
- -n, --componentName=<value> Component Name (e.g. google_alert_ingestion)
279
- -p, --sspPath=<value> Absolute path to .SSP file
280
- -t, --componentType=<value> Component Type (e.g. classic)
281
-
282
- DESCRIPTION
283
- Update an SSP.
284
- ```
285
-
286
- _See code: [lib/commands/component/ssp.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/component/ssp.js)_
188
+ _See code: [lib/commands/asset/add.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0/lib/commands/asset/add.js)_
287
189
 
288
190
  ## `sw-tsdk-connector connector:build`
289
191
 
@@ -293,8 +195,8 @@ Builds a local docker image of the connector.
293
195
  USAGE
294
196
  $ sw-tsdk-connector connector:build [--template
295
197
  python_37_swimlane|node_18|node_20|python_39_definition|python_39_turbine|python_310_definition|python_311_definitio
296
- n] [-d <value>] [--save] [-f] [--signing-password <value>] [--key-name <value>] [--registry <value>] [-o <value>]
297
- [-h]
198
+ n|python_312_definition] [-d <value>] [--save] [-f] [--signing-password <value>] [--key-name <value>] [--registry
199
+ <value>] [-o <value>] [-h]
298
200
 
299
201
  FLAGS
300
202
  -d, --directory=<value> [default: ./] root directory of the repository.
@@ -307,13 +209,13 @@ FLAGS
307
209
  --signing-password=<value> password used for the private key (ENV: TURBINE_SIGNING_PASSWORD)
308
210
  --template=<option> connector language
309
211
  <options: python_37_swimlane|node_18|node_20|python_39_definition|python_39_turbine|python
310
- _310_definition|python_311_definition>
212
+ _310_definition|python_311_definition|python_312_definition>
311
213
 
312
214
  DESCRIPTION
313
215
  Builds a local docker image of the connector.
314
216
  ```
315
217
 
316
- _See code: [lib/commands/connector/build.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/connector/build.js)_
218
+ _See code: [lib/commands/connector/build.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0/lib/commands/connector/build.js)_
317
219
 
318
220
  ## `sw-tsdk-connector connector:create`
319
221
 
@@ -323,30 +225,30 @@ Scaffold a new connector
323
225
  USAGE
324
226
  $ sw-tsdk-connector connector:create [-d <value>] [-t python_310_definition|python_311_definition|python_3]
325
227
  [--vendor <value>] [--product <value>] [--keywords <value>] [--description <value>] [--logoPath <value>] [--author
326
- <value>] [--authorEmail <value>] [--homepage <value>] [-h] [--createSrcFolder <value>]
228
+ <value>] [--authorEmail <value>] [--homepage <value>] [-h] [--createSrcFolder]
327
229
 
328
230
  FLAGS
329
- -d, --directory=<value> [default: ./] root directory for where to store connectors, the connector directory will be
330
- generated.
331
- -h, --help Show CLI help.
332
- -t, --template=<option> [default: python_311_definition] connector template to scaffold
333
- <options: python_310_definition|python_311_definition|python_3>
334
- --author=<value> Connector Author
335
- --authorEmail=<value> Connector Author Email
336
- --createSrcFolder=<value> Create Connector src folder? (e.g. false, true)
337
- --description=<value> Description (e.g. CrowdStrike Host Query API)
338
- --homepage=<value> Connector Author Support URL
339
- --keywords=<value> Enter keywords (Comma-Separated)
340
- --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min resolution
341
- 200x200
342
- --product=<value> Product (e.g. Falcon)
343
- --vendor=<value> Vendor (e.g. CrowdStrike)
231
+ -d, --directory=<value> [default: ./] root directory for where to store connectors, the connector directory will be
232
+ generated.
233
+ -h, --help Show CLI help.
234
+ -t, --template=<option> [default: python_311_definition] connector template to scaffold
235
+ <options: python_310_definition|python_311_definition|python_3>
236
+ --author=<value> Connector Author
237
+ --authorEmail=<value> Connector Author Email
238
+ --createSrcFolder Create Connector src folder?
239
+ --description=<value> Description (e.g. CrowdStrike Host Query API)
240
+ --homepage=<value> Connector Author Support URL
241
+ --keywords=<value> Enter keywords (Comma-Separated)
242
+ --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min resolution
243
+ 200x200
244
+ --product=<value> Product (e.g. Falcon)
245
+ --vendor=<value> Vendor (e.g. CrowdStrike)
344
246
 
345
247
  DESCRIPTION
346
248
  Scaffold a new connector
347
249
  ```
348
250
 
349
- _See code: [lib/commands/connector/create.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/connector/create.js)_
251
+ _See code: [lib/commands/connector/create.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0/lib/commands/connector/create.js)_
350
252
 
351
253
  ## `sw-tsdk-connector connector:create:openapi`
352
254
 
@@ -375,7 +277,7 @@ DESCRIPTION
375
277
  Scaffold a new connector
376
278
  ```
377
279
 
378
- _See code: [lib/commands/connector/create/openapi.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/connector/create/openapi.js)_
280
+ _See code: [lib/commands/connector/create/openapi.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0/lib/commands/connector/create/openapi.js)_
379
281
 
380
282
  ## `sw-tsdk-connector connector:create:source`
381
283
 
@@ -393,7 +295,7 @@ DESCRIPTION
393
295
  Generates 11x source from 10x
394
296
  ```
395
297
 
396
- _See code: [lib/commands/connector/create/source.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/connector/create/source.js)_
298
+ _See code: [lib/commands/connector/create/source.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0/lib/commands/connector/create/source.js)_
397
299
 
398
300
  ## `sw-tsdk-connector connector:lint`
399
301
 
@@ -416,7 +318,7 @@ DESCRIPTION
416
318
  Use to lint the connector
417
319
  ```
418
320
 
419
- _See code: [lib/commands/connector/lint.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/connector/lint.js)_
321
+ _See code: [lib/commands/connector/lint.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0/lib/commands/connector/lint.js)_
420
322
 
421
323
  ## `sw-tsdk-connector connector:logo`
422
324
 
@@ -424,18 +326,18 @@ Update a connector.
424
326
 
425
327
  ```
426
328
  USAGE
427
- $ sw-tsdk-connector connector:logo -p <value> [-d <value>] [-h]
329
+ $ sw-tsdk-connector connector:logo [-d <value>] [-p <value>] [-h]
428
330
 
429
331
  FLAGS
430
332
  -d, --directory=<value> [default: .] root directory of the connector folder.
431
333
  -h, --help Show CLI help.
432
- -p, --path=<value> (required) path or URL to product logo in PNG format.
334
+ -p, --path=<value> path or URL to product logo in PNG format.
433
335
 
434
336
  DESCRIPTION
435
337
  Update a connector.
436
338
  ```
437
339
 
438
- _See code: [lib/commands/connector/logo.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/connector/logo.js)_
340
+ _See code: [lib/commands/connector/logo.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0/lib/commands/connector/logo.js)_
439
341
 
440
342
  ## `sw-tsdk-connector connector:sign`
441
343
 
@@ -460,7 +362,7 @@ DESCRIPTION
460
362
  Builds a local docker image of the connector.
461
363
  ```
462
364
 
463
- _See code: [lib/commands/connector/sign.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/connector/sign.js)_
365
+ _See code: [lib/commands/connector/sign.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0/lib/commands/connector/sign.js)_
464
366
 
465
367
  ## `sw-tsdk-connector connector:update`
466
368
 
@@ -480,7 +382,7 @@ DESCRIPTION
480
382
  Update a connector.
481
383
  ```
482
384
 
483
- _See code: [lib/commands/connector/update.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/connector/update.js)_
385
+ _See code: [lib/commands/connector/update.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0/lib/commands/connector/update.js)_
484
386
 
485
387
  ## `sw-tsdk-connector connector:validate`
486
388
 
@@ -503,91 +405,7 @@ DESCRIPTION
503
405
  Use to validate an integration
504
406
  ```
505
407
 
506
- _See code: [lib/commands/connector/validate.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/connector/validate.js)_
507
-
508
- ## `sw-tsdk-connector description:action`
509
-
510
- Use to generate action description
511
-
512
- ```
513
- USAGE
514
- $ sw-tsdk-connector description:action [-h] [-i <value>] [-s] [-d <value>] [-a <value>]
515
-
516
- FLAGS
517
- -a, --action=<value> Generate description for specific action
518
- -d, --directory=<value> [default: ./] current directory to mount
519
- -h, --help Show CLI help.
520
- -i, --image=<value> image to use
521
- -s, --skip-pull skips pulling the image
522
-
523
- DESCRIPTION
524
- Use to generate action description
525
- ```
526
-
527
- _See code: [lib/commands/description/action.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/description/action.js)_
528
-
529
- ## `sw-tsdk-connector description:actions`
530
-
531
- Use to generate description for all actions
532
-
533
- ```
534
- USAGE
535
- $ sw-tsdk-connector description:actions [-h] [-i <value>] [-s] [-d <value>]
536
-
537
- FLAGS
538
- -d, --directory=<value> [default: ./] current directory to mount
539
- -h, --help Show CLI help.
540
- -i, --image=<value> image to use
541
- -s, --skip-pull skips pulling the image
542
-
543
- DESCRIPTION
544
- Use to generate description for all actions
545
- ```
546
-
547
- _See code: [lib/commands/description/actions.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/description/actions.js)_
548
-
549
- ## `sw-tsdk-connector description:component`
550
-
551
- Use to generate component descriptions
552
-
553
- ```
554
- USAGE
555
- $ sw-tsdk-connector description:component [-h] [-i <value>] [-s] [-d <value>] [-c <value>] [-v <value>] [-p <value>]
556
-
557
- FLAGS
558
- -c, --componentName=<value> component name
559
- -d, --directory=<value> [default: ./] current directory to mount
560
- -h, --help Show CLI help.
561
- -i, --image=<value> image to use
562
- -p, --connectorLocalPath=<value> local path to connector
563
- -s, --skip-pull skips pulling the image
564
- -v, --componentFamily=<value> [default: classic] classic | canvas
565
-
566
- DESCRIPTION
567
- Use to generate component descriptions
568
- ```
569
-
570
- _See code: [lib/commands/description/component.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/description/component.js)_
571
-
572
- ## `sw-tsdk-connector description:connector`
573
-
574
- Use to generate connector descriptions
575
-
576
- ```
577
- USAGE
578
- $ sw-tsdk-connector description:connector [-h] [-i <value>] [-s] [-d <value>]
579
-
580
- FLAGS
581
- -d, --directory=<value> [default: ./] current directory to mount
582
- -h, --help Show CLI help.
583
- -i, --image=<value> image to use
584
- -s, --skip-pull skips pulling the image
585
-
586
- DESCRIPTION
587
- Use to generate connector descriptions
588
- ```
589
-
590
- _See code: [lib/commands/description/connector.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/description/connector.js)_
408
+ _See code: [lib/commands/connector/validate.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0/lib/commands/connector/validate.js)_
591
409
 
592
410
  ## `sw-tsdk-connector migrator:convert`
593
411
 
@@ -613,7 +431,7 @@ DESCRIPTION
613
431
  Convert scripts and forked plugins from Swimlane V10x to connectors.
614
432
  ```
615
433
 
616
- _See code: [lib/commands/migrator/convert.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/migrator/convert.js)_
434
+ _See code: [lib/commands/migrator/convert.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0/lib/commands/migrator/convert.js)_
617
435
 
618
436
  ## `sw-tsdk-connector migrator:export`
619
437
 
@@ -634,227 +452,5 @@ DESCRIPTION
634
452
  Use to export python scripts from a Swimlane instance
635
453
  ```
636
454
 
637
- _See code: [lib/commands/migrator/export.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/migrator/export.js)_
638
-
639
- ## `sw-tsdk-connector playbook:create`
640
-
641
- Scaffold a new playbook
642
-
643
- ```
644
- USAGE
645
- $ sw-tsdk-connector playbook:create [-d <value>] [--playbookFamily <value>] [--playbookName <value>] [--keywords
646
- <value>] [--description <value>] [--logoPath <value>] [--overviewImagePath <value>] [--sspPath <value>] [--author
647
- <value>] [--authorEmail <value>] [--homepage <value>] [--readmePath <value>] [--externalReadmePath <value>]
648
- [--documentationReadmePath <value>] [--externalymlPath <value>] [-h]
649
-
650
- FLAGS
651
- -d, --directory=<value> [default: ./] root directory for where to store Playbook.
652
- -h, --help Show CLI help.
653
- --author=<value> Playbook Author
654
- --authorEmail=<value> Playbook Author Email
655
- --description=<value> Description (e.g. Text Aggregator Description)
656
- --documentationReadmePath=<value> Absolute path to documentation.README.md file
657
- --externalReadmePath=<value> Absolute path to EXTERNAL_README.md file
658
- --externalymlPath=<value> Absolute path to external.yml file
659
- --homepage=<value> Playbook Author Support URL
660
- --keywords=<value> Enter keywords
661
- --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min
662
- resolution 200x200
663
- --overviewImagePath=<value> URL or absolute path to overview image file. Min resolution 1100x660
664
- --playbookFamily=<value> Playbook Family (e.g. classic | canvas)
665
- --playbookName=<value> Playbook Name (e.g. Text Aggregator)
666
- --readmePath=<value> Absolute path to README.md file
667
- --sspPath=<value> Absolute path to .ssp file
668
-
669
- DESCRIPTION
670
- Scaffold a new playbook
671
- ```
672
-
673
- _See code: [lib/commands/playbook/create.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/playbook/create.js)_
674
-
675
- ## `sw-tsdk-connector playbook:image`
676
-
677
- Update a Playbook image.
678
-
679
- ```
680
- USAGE
681
- $ sw-tsdk-connector playbook:image [-d <value>] [-t <value>] [-n <value>] [-i <value>] [-p <value>] [-h]
682
-
683
- FLAGS
684
- -d, --directory=<value> [default: ./] root directory of the playbook folder.
685
- -h, --help Show CLI help.
686
- -i, --imageType=<value> Image Type (e.g. logo/overview)
687
- -n, --componentName=<value> Playbook Name (e.g. google_alert_ingestion)
688
- -p, --imagePath=<value> path or URL to product image in PNG format.
689
- -t, --componentType=<value> Playbook Type (e.g. classic)
690
-
691
- DESCRIPTION
692
- Update a Playbook image.
693
- ```
694
-
695
- _See code: [lib/commands/playbook/image.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/playbook/image.js)_
696
-
697
- ## `sw-tsdk-connector playbook:ssp`
698
-
699
- Update an SSP
700
-
701
- ```
702
- USAGE
703
- $ sw-tsdk-connector playbook:ssp [-d <value>] [-n <value>] [-p <value>] [-h]
704
-
705
- FLAGS
706
- -d, --directory=<value> [default: ./] root directory of the playbook folder.
707
- -h, --help Show CLI help.
708
- -n, --playbookName=<value> Playbook Name (e.g. text_aggregator)
709
- -p, --sspPath=<value> Absolute path to .SSP file
710
-
711
- DESCRIPTION
712
- Update an SSP
713
- ```
714
-
715
- _See code: [lib/commands/playbook/ssp.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/playbook/ssp.js)_
716
-
717
- ## `sw-tsdk-connector solution:create`
718
-
719
- Scaffold a new Solution
720
-
721
- ```
722
- USAGE
723
- $ sw-tsdk-connector solution:create [-d <value>] [--solutionFamily <value>] [--solutionName <value>] [--description
724
- <value>] [--logoPath <value>] [--overviewImagePath <value>] [--sspPath <value>] [--author <value>] [--authorEmail
725
- <value>] [--homepage <value>] [-h]
726
-
727
- FLAGS
728
- -d, --directory=<value> [default: ./] root directory for where to store Solution.
729
- -h, --help Show CLI help.
730
- --author=<value> Solution Author
731
- --authorEmail=<value> Solution Author Email
732
- --description=<value> Description (e.g. SOC Solution Description)
733
- --homepage=<value> Solution Author Support URL
734
- --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min resolution
735
- 200x200
736
- --overviewImagePath=<value> URL or absolute path to overview image file. Min resolution 1100x660
737
- --solutionFamily=<value> Solution Family (e.g. classic | canvas)
738
- --solutionName=<value> Solution Name (e.g. SOC Solution)
739
- --sspPath=<value> absolute path to .ssp file
740
-
741
- DESCRIPTION
742
- Scaffold a new Solution
743
- ```
744
-
745
- _See code: [lib/commands/solution/create.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/solution/create.js)_
746
-
747
- ## `sw-tsdk-connector solution:image`
748
-
749
- Update a Solution image.
750
-
751
- ```
752
- USAGE
753
- $ sw-tsdk-connector solution:image [-d <value>] [-t <value>] [-n <value>] [-i <value>] [-p <value>] [-h]
754
-
755
- FLAGS
756
- -d, --directory=<value> [default: ./] root directory of the solution folder.
757
- -h, --help Show CLI help.
758
- -i, --imageType=<value> Image Type (e.g. logo/overview)
759
- -n, --solutionName=<value> Solution Name (e.g. google_alert_ingestion)
760
- -p, --imagePath=<value> path or URL to product image in PNG format.
761
- -t, --solutionType=<value> Solution Type (e.g. classic)
762
-
763
- DESCRIPTION
764
- Update a Solution image.
765
- ```
766
-
767
- _See code: [lib/commands/solution/image.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/solution/image.js)_
768
-
769
- ## `sw-tsdk-connector solution:ssp`
770
-
771
- Update an SSP.
772
-
773
- ```
774
- USAGE
775
- $ sw-tsdk-connector solution:ssp [-d <value>] [-t <value>] [-n <value>] [-p <value>] [-h]
776
-
777
- FLAGS
778
- -d, --directory=<value> [default: ./] root directory of the solution folder.
779
- -h, --help Show CLI help.
780
- -n, --solutionName=<value> Solution Name (e.g. soc_solution)
781
- -p, --sspPath=<value> Absolute path to .SSP file
782
- -t, --solutionType=<value> Solution Type (e.g. classic)
783
-
784
- DESCRIPTION
785
- Update an SSP.
786
- ```
787
-
788
- _See code: [lib/commands/solution/ssp.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/solution/ssp.js)_
789
-
790
- ## `sw-tsdk-connector widget:create`
791
-
792
- Scaffold a new widget
793
-
794
- ```
795
- USAGE
796
- $ sw-tsdk-connector widget:create [-d <value>] [--widgetName <value>] [--keywords <value>] [--description
797
- <value>] [--logoPath <value>] [--overviewImagePath <value>] [--sspPath <value>] [--author <value>] [--authorEmail
798
- <value>] [--homepage <value>] [-h]
799
-
800
- FLAGS
801
- -d, --directory=<value> [default: ./] root directory for where to store Widget.
802
- -h, --help Show CLI help.
803
- --author=<value> Widget Author
804
- --authorEmail=<value> Widget Author Email
805
- --description=<value> Description (e.g. Action Buttons Description)
806
- --homepage=<value> Widget Author Support URL
807
- --keywords=<value> Enter keywords
808
- --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min resolution
809
- 200x200
810
- --overviewImagePath=<value> URL or absolute path to overview image file. Min resolution 1100x660
811
- --sspPath=<value> absolute path to .ssp file
812
- --widgetName=<value> Widget Name (e.g. Action Buttons)
813
-
814
- DESCRIPTION
815
- Scaffold a new widget
816
- ```
817
-
818
- _See code: [lib/commands/widget/create.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/widget/create.js)_
819
-
820
- ## `sw-tsdk-connector widget:image`
821
-
822
- Update a Widget image.
823
-
824
- ```
825
- USAGE
826
- $ sw-tsdk-connector widget:image [-d <value>] [-n <value>] [-i <value>] [-p <value>] [-h]
827
-
828
- FLAGS
829
- -d, --directory=<value> [default: ./] root directory of the widget folder.
830
- -h, --help Show CLI help.
831
- -i, --imageType=<value> Image Type (e.g. logo/overview)
832
- -n, --componentName=<value> Widget Name (e.g. action_buttons)
833
- -p, --imagePath=<value> path or URL to product image in PNG format.
834
-
835
- DESCRIPTION
836
- Update a Widget image.
837
- ```
838
-
839
- _See code: [lib/commands/widget/image.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/widget/image.js)_
840
-
841
- ## `sw-tsdk-connector widget:ssp`
842
-
843
- Update an SSP
844
-
845
- ```
846
- USAGE
847
- $ sw-tsdk-connector widget:ssp [-d <value>] [-n <value>] [-p <value>] [-h]
848
-
849
- FLAGS
850
- -d, --directory=<value> [default: ./] root directory of the widget folder.
851
- -h, --help Show CLI help.
852
- -n, --widgetName=<value> Widget Name (e.g. action_buttons)
853
- -p, --sspPath=<value> Absolute path to .SSP file
854
-
855
- DESCRIPTION
856
- Update an SSP
857
- ```
858
-
859
- _See code: [lib/commands/widget/ssp.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0-next.fbd3f73/lib/commands/widget/ssp.js)_
455
+ _See code: [lib/commands/migrator/export.js](https://github.com/swimlane/turbine-sdk/blob/v3.12.0/lib/commands/migrator/export.js)_
860
456
  <!-- commandsstop -->
@@ -43,10 +43,10 @@ class Add extends core_2.Base {
43
43
  default: 'GET',
44
44
  },
45
45
  {
46
- type: 'input',
46
+ type: 'confirm',
47
47
  name: 'createSrcFile',
48
- message: 'Create Custom Source file? (e.g. false, true)',
49
- default: 'false',
48
+ message: 'Create Custom Source file?',
49
+ default: false,
50
50
  },
51
51
  {
52
52
  type: 'input',
@@ -114,7 +114,7 @@ class Add extends core_2.Base {
114
114
  await (0, fs_extra_1.writeFile)(actionDataInputPath, JSON.stringify(actionSampleDataInput, null, 2));
115
115
  const actionDataOutputPath = (0, node_path_1.join)(directory, 'data', `${action.name}_output.json`);
116
116
  await (0, fs_extra_1.writeFile)(actionDataOutputPath, JSON.stringify(actionSampleDataOutput, null, 2));
117
- if (answers.createSrcFile === 'true') {
117
+ if (answers.createSrcFile) {
118
118
  const runnerOverridePath = (0, node_path_1.join)(directory, 'connector', 'src', 'runner_override.py');
119
119
  const runnerOverrideExists = fs.existsSync(runnerOverridePath);
120
120
  const templatePath = runnerOverrideExists ?