@swimlane/turbine-sdk 3.12.0-next.efbbbee → 3.12.0-next.f662ddc

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
@@ -66,7 +66,7 @@ $ npm install -g @swimlane/turbine-sdk
66
66
  $ tsdk COMMAND
67
67
  running command...
68
68
  $ tsdk (--version|-v)
69
- @swimlane/turbine-sdk/3.12.0-next.efbbbee linux-x64 node-v20.19.0
69
+ @swimlane/turbine-sdk/3.12.0-next.f662ddc linux-x64 node-v20.19.0
70
70
  $ tsdk --help [COMMAND]
71
71
  USAGE
72
72
  $ tsdk COMMAND
@@ -83,9 +83,6 @@ USAGE
83
83
  * [`tsdk asset add`](#tsdk-asset-add)
84
84
  * [`tsdk autocomplete [SHELL]`](#tsdk-autocomplete-shell)
85
85
  * [`tsdk commands`](#tsdk-commands)
86
- * [`tsdk component create`](#tsdk-component-create)
87
- * [`tsdk component image`](#tsdk-component-image)
88
- * [`tsdk component ssp`](#tsdk-component-ssp)
89
86
  * [`tsdk connector build`](#tsdk-connector-build)
90
87
  * [`tsdk connector create`](#tsdk-connector-create)
91
88
  * [`tsdk connector create openapi`](#tsdk-connector-create-openapi)
@@ -95,16 +92,9 @@ USAGE
95
92
  * [`tsdk connector sign`](#tsdk-connector-sign)
96
93
  * [`tsdk connector update`](#tsdk-connector-update)
97
94
  * [`tsdk connector validate`](#tsdk-connector-validate)
98
- * [`tsdk description action`](#tsdk-description-action)
99
- * [`tsdk description actions`](#tsdk-description-actions)
100
- * [`tsdk description component`](#tsdk-description-component)
101
- * [`tsdk description connector`](#tsdk-description-connector)
102
95
  * [`tsdk help [COMMANDS]`](#tsdk-help-commands)
103
96
  * [`tsdk migrator convert`](#tsdk-migrator-convert)
104
97
  * [`tsdk migrator export`](#tsdk-migrator-export)
105
- * [`tsdk playbook create`](#tsdk-playbook-create)
106
- * [`tsdk playbook image`](#tsdk-playbook-image)
107
- * [`tsdk playbook ssp`](#tsdk-playbook-ssp)
108
98
  * [`tsdk plugins`](#tsdk-plugins)
109
99
  * [`tsdk plugins:install PLUGIN...`](#tsdk-pluginsinstall-plugin)
110
100
  * [`tsdk plugins:inspect PLUGIN...`](#tsdk-pluginsinspect-plugin)
@@ -114,9 +104,6 @@ USAGE
114
104
  * [`tsdk plugins:uninstall PLUGIN...`](#tsdk-pluginsuninstall-plugin-1)
115
105
  * [`tsdk plugins:uninstall PLUGIN...`](#tsdk-pluginsuninstall-plugin-2)
116
106
  * [`tsdk plugins update`](#tsdk-plugins-update)
117
- * [`tsdk solution create`](#tsdk-solution-create)
118
- * [`tsdk solution image`](#tsdk-solution-image)
119
- * [`tsdk solution ssp`](#tsdk-solution-ssp)
120
107
  * [`tsdk turbine config list`](#tsdk-turbine-config-list)
121
108
  * [`tsdk turbine config remove URL`](#tsdk-turbine-config-remove-url)
122
109
  * [`tsdk turbine config set URL`](#tsdk-turbine-config-set-url)
@@ -128,9 +115,6 @@ USAGE
128
115
  * [`tsdk turbine connector push FILE URL`](#tsdk-turbine-connector-push-file-url)
129
116
  * [`tsdk version`](#tsdk-version)
130
117
  * [`tsdk which`](#tsdk-which)
131
- * [`tsdk widget create`](#tsdk-widget-create)
132
- * [`tsdk widget image`](#tsdk-widget-image)
133
- * [`tsdk widget ssp`](#tsdk-widget-ssp)
134
118
 
135
119
  ## `tsdk action add`
136
120
 
@@ -326,81 +310,6 @@ DESCRIPTION
326
310
 
327
311
  _See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/v2.2.15/src/commands/commands.ts)_
328
312
 
329
- ## `tsdk component create`
330
-
331
- Scaffold a new Component
332
-
333
- ```
334
- USAGE
335
- $ tsdk component create [-d <value>] [--componentUseCaseType <value>] [--componentFamily <value>] [--vendor <value>]
336
- [--componentName <value>] [--keywords <value>] [--description <value>] [--logoPath <value>] [--overviewImagePath
337
- <value>] [--sspPath <value>] [--author <value>] [--authorEmail <value>] [--homepage <value>] [--readmePath <value>]
338
- [--externalReadmePath <value>] [--documentationReadmePath <value>] [--externalymlPath <value>] [-h]
339
-
340
- FLAGS
341
- -d, --directory=<value> [default: ./] root directory for where to store Component.
342
- -h, --help Show CLI help.
343
- --author=<value> Component Author
344
- --authorEmail=<value> Component Author Email
345
- --componentFamily=<value> Component Family (e.g. classic | canvas)
346
- --componentName=<value> Component Name (e.g. Alert Ingestion)
347
- --componentUseCaseType=<value> Component Use Case Type (e.g. ingestion| enrichment | remidiation)
348
- --description=<value> Description (e.g. CrowdStrike Alert Ingestion Component)
349
- --documentationReadmePath=<value> Absolute path to documentation.README.md file
350
- --externalReadmePath=<value> Absolute path to EXTERNAL_README.md file
351
- --externalymlPath=<value> Absolute path to external.yml file
352
- --homepage=<value> Component Author Support URL
353
- --keywords=<value> Enter keywords
354
- --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min
355
- resolution 200x200
356
- --overviewImagePath=<value> URL or absolute path to overview image file. Min resolution 1100x660
357
- --readmePath=<value> Absolute path to README.md file
358
- --sspPath=<value> Absolute path to .ssp file
359
- --vendor=<value> Vendor (e.g. CrowdStrike)
360
-
361
- DESCRIPTION
362
- Scaffold a new Component
363
- ```
364
-
365
- ## `tsdk component image`
366
-
367
- Update a Component image.
368
-
369
- ```
370
- USAGE
371
- $ tsdk component image [-d <value>] [-t <value>] [-n <value>] [-i <value>] [-p <value>] [-h]
372
-
373
- FLAGS
374
- -d, --directory=<value> [default: ./] root directory of the component folder.
375
- -h, --help Show CLI help.
376
- -i, --imageType=<value> Image Type (e.g. logo/overview)
377
- -n, --componentName=<value> Component Name (e.g. google_alert_ingestion)
378
- -p, --imagePath=<value> path or URL to product image in PNG format.
379
- -t, --componentType=<value> Component Type (e.g. classic)
380
-
381
- DESCRIPTION
382
- Update a Component image.
383
- ```
384
-
385
- ## `tsdk component ssp`
386
-
387
- Update an SSP.
388
-
389
- ```
390
- USAGE
391
- $ tsdk component ssp [-d <value>] [-t <value>] [-n <value>] [-p <value>] [-h]
392
-
393
- FLAGS
394
- -d, --directory=<value> [default: ./] root directory of the component folder.
395
- -h, --help Show CLI help.
396
- -n, --componentName=<value> Component Name (e.g. google_alert_ingestion)
397
- -p, --sspPath=<value> Absolute path to .SSP file
398
- -t, --componentType=<value> Component Type (e.g. classic)
399
-
400
- DESCRIPTION
401
- Update an SSP.
402
- ```
403
-
404
313
  ## `tsdk connector build`
405
314
 
406
315
  Builds a local docker image of the connector.
@@ -409,8 +318,8 @@ Builds a local docker image of the connector.
409
318
  USAGE
410
319
  $ tsdk connector build [--template
411
320
  python_37_swimlane|node_18|node_20|python_39_definition|python_39_turbine|python_310_definition|python_311_definitio
412
- n] [-d <value>] [--save] [-f] [--signing-password <value>] [--key-name <value>] [--registry <value>] [-o <value>]
413
- [-h]
321
+ n|python_312_definition] [-d <value>] [--save] [-f] [--signing-password <value>] [--key-name <value>] [--registry
322
+ <value>] [-o <value>] [-h]
414
323
 
415
324
  FLAGS
416
325
  -d, --directory=<value> [default: ./] root directory of the repository.
@@ -423,7 +332,7 @@ FLAGS
423
332
  --signing-password=<value> password used for the private key (ENV: TURBINE_SIGNING_PASSWORD)
424
333
  --template=<option> connector language
425
334
  <options: python_37_swimlane|node_18|node_20|python_39_definition|python_39_turbine|python
426
- _310_definition|python_311_definition>
335
+ _310_definition|python_311_definition|python_312_definition>
427
336
 
428
337
  DESCRIPTION
429
338
  Builds a local docker image of the connector.
@@ -530,12 +439,12 @@ Update a connector.
530
439
 
531
440
  ```
532
441
  USAGE
533
- $ tsdk connector logo -p <value> [-d <value>] [-h]
442
+ $ tsdk connector logo [-d <value>] [-p <value>] [-h]
534
443
 
535
444
  FLAGS
536
445
  -d, --directory=<value> [default: .] root directory of the connector folder.
537
446
  -h, --help Show CLI help.
538
- -p, --path=<value> (required) path or URL to product logo in PNG format.
447
+ -p, --path=<value> path or URL to product logo in PNG format.
539
448
 
540
449
  DESCRIPTION
541
450
  Update a connector.
@@ -603,82 +512,6 @@ DESCRIPTION
603
512
  Use to validate an integration
604
513
  ```
605
514
 
606
- ## `tsdk description action`
607
-
608
- Use to generate action description
609
-
610
- ```
611
- USAGE
612
- $ tsdk description action [-h] [-i <value>] [-s] [-d <value>] [-a <value>]
613
-
614
- FLAGS
615
- -a, --action=<value> Generate description for specific action
616
- -d, --directory=<value> [default: ./] current directory to mount
617
- -h, --help Show CLI help.
618
- -i, --image=<value> image to use
619
- -s, --skip-pull skips pulling the image
620
-
621
- DESCRIPTION
622
- Use to generate action description
623
- ```
624
-
625
- ## `tsdk description actions`
626
-
627
- Use to generate description for all actions
628
-
629
- ```
630
- USAGE
631
- $ tsdk description actions [-h] [-i <value>] [-s] [-d <value>]
632
-
633
- FLAGS
634
- -d, --directory=<value> [default: ./] current directory to mount
635
- -h, --help Show CLI help.
636
- -i, --image=<value> image to use
637
- -s, --skip-pull skips pulling the image
638
-
639
- DESCRIPTION
640
- Use to generate description for all actions
641
- ```
642
-
643
- ## `tsdk description component`
644
-
645
- Use to generate component descriptions
646
-
647
- ```
648
- USAGE
649
- $ tsdk description component [-h] [-i <value>] [-s] [-d <value>] [-c <value>] [-v <value>] [-p <value>]
650
-
651
- FLAGS
652
- -c, --componentName=<value> component name
653
- -d, --directory=<value> [default: ./] current directory to mount
654
- -h, --help Show CLI help.
655
- -i, --image=<value> image to use
656
- -p, --connectorLocalPath=<value> local path to connector
657
- -s, --skip-pull skips pulling the image
658
- -v, --componentFamily=<value> [default: classic] classic | canvas
659
-
660
- DESCRIPTION
661
- Use to generate component descriptions
662
- ```
663
-
664
- ## `tsdk description connector`
665
-
666
- Use to generate connector descriptions
667
-
668
- ```
669
- USAGE
670
- $ tsdk description connector [-h] [-i <value>] [-s] [-d <value>]
671
-
672
- FLAGS
673
- -d, --directory=<value> [default: ./] current directory to mount
674
- -h, --help Show CLI help.
675
- -i, --image=<value> image to use
676
- -s, --skip-pull skips pulling the image
677
-
678
- DESCRIPTION
679
- Use to generate connector descriptions
680
- ```
681
-
682
515
  ## `tsdk help [COMMANDS]`
683
516
 
684
517
  Display help for tsdk.
@@ -742,78 +575,6 @@ DESCRIPTION
742
575
  Use to export python scripts from a Swimlane instance
743
576
  ```
744
577
 
745
- ## `tsdk playbook create`
746
-
747
- Scaffold a new playbook
748
-
749
- ```
750
- USAGE
751
- $ tsdk playbook create [-d <value>] [--playbookFamily <value>] [--playbookName <value>] [--keywords <value>]
752
- [--description <value>] [--logoPath <value>] [--overviewImagePath <value>] [--sspPath <value>] [--author <value>]
753
- [--authorEmail <value>] [--homepage <value>] [--readmePath <value>] [--externalReadmePath <value>]
754
- [--documentationReadmePath <value>] [--externalymlPath <value>] [-h]
755
-
756
- FLAGS
757
- -d, --directory=<value> [default: ./] root directory for where to store Playbook.
758
- -h, --help Show CLI help.
759
- --author=<value> Playbook Author
760
- --authorEmail=<value> Playbook Author Email
761
- --description=<value> Description (e.g. Text Aggregator Description)
762
- --documentationReadmePath=<value> Absolute path to documentation.README.md file
763
- --externalReadmePath=<value> Absolute path to EXTERNAL_README.md file
764
- --externalymlPath=<value> Absolute path to external.yml file
765
- --homepage=<value> Playbook Author Support URL
766
- --keywords=<value> Enter keywords
767
- --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min
768
- resolution 200x200
769
- --overviewImagePath=<value> URL or absolute path to overview image file. Min resolution 1100x660
770
- --playbookFamily=<value> Playbook Family (e.g. classic | canvas)
771
- --playbookName=<value> Playbook Name (e.g. Text Aggregator)
772
- --readmePath=<value> Absolute path to README.md file
773
- --sspPath=<value> Absolute path to .ssp file
774
-
775
- DESCRIPTION
776
- Scaffold a new playbook
777
- ```
778
-
779
- ## `tsdk playbook image`
780
-
781
- Update a Playbook image.
782
-
783
- ```
784
- USAGE
785
- $ tsdk playbook image [-d <value>] [-t <value>] [-n <value>] [-i <value>] [-p <value>] [-h]
786
-
787
- FLAGS
788
- -d, --directory=<value> [default: ./] root directory of the playbook folder.
789
- -h, --help Show CLI help.
790
- -i, --imageType=<value> Image Type (e.g. logo/overview)
791
- -n, --componentName=<value> Playbook Name (e.g. google_alert_ingestion)
792
- -p, --imagePath=<value> path or URL to product image in PNG format.
793
- -t, --componentType=<value> Playbook Type (e.g. classic)
794
-
795
- DESCRIPTION
796
- Update a Playbook image.
797
- ```
798
-
799
- ## `tsdk playbook ssp`
800
-
801
- Update an SSP
802
-
803
- ```
804
- USAGE
805
- $ tsdk playbook ssp [-d <value>] [-n <value>] [-p <value>] [-h]
806
-
807
- FLAGS
808
- -d, --directory=<value> [default: ./] root directory of the playbook folder.
809
- -h, --help Show CLI help.
810
- -n, --playbookName=<value> Playbook Name (e.g. text_aggregator)
811
- -p, --sspPath=<value> Absolute path to .SSP file
812
-
813
- DESCRIPTION
814
- Update an SSP
815
- ```
816
-
817
578
  ## `tsdk plugins`
818
579
 
819
580
  List installed plugins.
@@ -1050,73 +811,6 @@ DESCRIPTION
1050
811
  Update installed plugins.
1051
812
  ```
1052
813
 
1053
- ## `tsdk solution create`
1054
-
1055
- Scaffold a new Solution
1056
-
1057
- ```
1058
- USAGE
1059
- $ tsdk solution create [-d <value>] [--solutionFamily <value>] [--solutionName <value>] [--description <value>]
1060
- [--logoPath <value>] [--overviewImagePath <value>] [--sspPath <value>] [--author <value>] [--authorEmail <value>]
1061
- [--homepage <value>] [-h]
1062
-
1063
- FLAGS
1064
- -d, --directory=<value> [default: ./] root directory for where to store Solution.
1065
- -h, --help Show CLI help.
1066
- --author=<value> Solution Author
1067
- --authorEmail=<value> Solution Author Email
1068
- --description=<value> Description (e.g. SOC Solution description)
1069
- --homepage=<value> Solution Author Support URL
1070
- --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min resolution
1071
- 200x200
1072
- --overviewImagePath=<value> URL or absolute path to overview image file. Min resolution 1100x660
1073
- --solutionFamily=<value> Solution Family (e.g. classic | canvas)
1074
- --solutionName=<value> Solution Name (e.g. SOC Solution)
1075
- --sspPath=<value> Absolute path to .ssp file
1076
-
1077
- DESCRIPTION
1078
- Scaffold a new Solution
1079
- ```
1080
-
1081
- ## `tsdk solution image`
1082
-
1083
- Update a Solution image.
1084
-
1085
- ```
1086
- USAGE
1087
- $ tsdk solution image [-d <value>] [-t <value>] [-n <value>] [-i <value>] [-p <value>] [-h]
1088
-
1089
- FLAGS
1090
- -d, --directory=<value> [default: ./] root directory of the solution folder.
1091
- -h, --help Show CLI help.
1092
- -i, --imageType=<value> Image Type (e.g. logo/overview)
1093
- -n, --solutionName=<value> Solution Name (e.g. google_alert_ingestion)
1094
- -p, --imagePath=<value> path or URL to product image in PNG format.
1095
- -t, --solutionType=<value> Solution Type (e.g. classic)
1096
-
1097
- DESCRIPTION
1098
- Update a Solution image.
1099
- ```
1100
-
1101
- ## `tsdk solution ssp`
1102
-
1103
- Update an SSP.
1104
-
1105
- ```
1106
- USAGE
1107
- $ tsdk solution ssp [-d <value>] [-t <value>] [-n <value>] [-p <value>] [-h]
1108
-
1109
- FLAGS
1110
- -d, --directory=<value> [default: ./] root directory of the solution folder.
1111
- -h, --help Show CLI help.
1112
- -n, --solutionName=<value> Solution Name (e.g. soc_solution)
1113
- -p, --sspPath=<value> Absolute path to .SSP file
1114
- -t, --solutionType=<value> Solution Type (e.g. classic)
1115
-
1116
- DESCRIPTION
1117
- Update an SSP.
1118
- ```
1119
-
1120
814
  ## `tsdk turbine config list`
1121
815
 
1122
816
  Use to login to Turbine
@@ -1355,69 +1049,4 @@ EXAMPLES
1355
1049
  ```
1356
1050
 
1357
1051
  _See code: [@oclif/plugin-which](https://github.com/oclif/plugin-which/blob/v2.2.21/src/commands/which.ts)_
1358
-
1359
- ## `tsdk widget create`
1360
-
1361
- Scaffold a new widget
1362
-
1363
- ```
1364
- USAGE
1365
- $ tsdk widget create [-d <value>] [--widgetName <value>] [--keywords <value>] [--description <value>] [--logoPath
1366
- <value>] [--overviewImagePath <value>] [--sspPath <value>] [--author <value>] [--authorEmail <value>] [--homepage
1367
- <value>] [-h]
1368
-
1369
- FLAGS
1370
- -d, --directory=<value> [default: ./] root directory for where to store Widget.
1371
- -h, --help Show CLI help.
1372
- --author=<value> Widget Author
1373
- --authorEmail=<value> Widget Author Email
1374
- --description=<value> Description (e.g. Action Buttons Description)
1375
- --homepage=<value> Widget Author Support URL
1376
- --keywords=<value> Enter keywords
1377
- --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min resolution
1378
- 200x200
1379
- --overviewImagePath=<value> URL or absolute path to overview image file. Min resolution 1100x660
1380
- --sspPath=<value> absolute path to .ssp file
1381
- --widgetName=<value> Widget Name (e.g. Action Buttons)
1382
-
1383
- DESCRIPTION
1384
- Scaffold a new widget
1385
- ```
1386
-
1387
- ## `tsdk widget image`
1388
-
1389
- Update a Widget image.
1390
-
1391
- ```
1392
- USAGE
1393
- $ tsdk widget image [-d <value>] [-n <value>] [-i <value>] [-p <value>] [-h]
1394
-
1395
- FLAGS
1396
- -d, --directory=<value> [default: ./] root directory of the widget folder.
1397
- -h, --help Show CLI help.
1398
- -i, --imageType=<value> Image Type (e.g. logo/overview)
1399
- -n, --componentName=<value> Widget Name (e.g. action_buttons)
1400
- -p, --imagePath=<value> path or URL to product image in PNG format.
1401
-
1402
- DESCRIPTION
1403
- Update a Widget image.
1404
- ```
1405
-
1406
- ## `tsdk widget ssp`
1407
-
1408
- Update an SSP
1409
-
1410
- ```
1411
- USAGE
1412
- $ tsdk widget ssp [-d <value>] [-n <value>] [-p <value>] [-h]
1413
-
1414
- FLAGS
1415
- -d, --directory=<value> [default: ./] root directory of the widget folder.
1416
- -h, --help Show CLI help.
1417
- -n, --widgetName=<value> Widget Name (e.g. action_buttons)
1418
- -p, --sspPath=<value> Absolute path to .SSP file
1419
-
1420
- DESCRIPTION
1421
- Update an SSP
1422
- ```
1423
1052
  <!-- commandsstop -->
@@ -1,4 +1,4 @@
1
1
  {
2
- "version": "3.12.0-next.efbbbee",
2
+ "version": "3.12.0-next.f662ddc",
3
3
  "commands": {}
4
4
  }
package/package.json CHANGED
@@ -16,9 +16,9 @@
16
16
  "@oclif/plugin-version": "1.3.4",
17
17
  "@oclif/plugin-warn-if-update-available": "2.0.37",
18
18
  "@oclif/plugin-which": "2.2.21",
19
- "@sw-tsdk/core": "3.12.0-next.efbbbee",
20
- "@sw-tsdk/plugin-connector": "3.12.0-next.efbbbee",
21
- "@sw-tsdk/plugin-turbine": "3.12.0-next.efbbbee",
19
+ "@sw-tsdk/core": "3.12.0-next.f662ddc",
20
+ "@sw-tsdk/plugin-connector": "3.12.0-next.f662ddc",
21
+ "@sw-tsdk/plugin-turbine": "3.12.0-next.f662ddc",
22
22
  "fs-extra": "11.1.1",
23
23
  "inquirer": "8.2.2",
24
24
  "npmlog": "7.0.1",
@@ -106,10 +106,10 @@
106
106
  "dev:setup": "yarn link --force"
107
107
  },
108
108
  "types": "lib/index.d.ts",
109
- "version": "3.12.0-next.efbbbee",
109
+ "version": "3.12.0-next.f662ddc",
110
110
  "volta": {
111
111
  "node": "20.19.0",
112
112
  "yarn": "1.22.22"
113
113
  },
114
- "gitHead": "efbbbee375bbf157511a6028f356aa45b188701f"
114
+ "gitHead": "f662ddc09d78af52f15cf8c246c0fe379081ca5c"
115
115
  }