@salesforce/plugin-packaging 2.14.0 → 2.15.1

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
@@ -37,6 +37,10 @@ See [DEVELOPING.md](DEVELOPING.md)
37
37
  - [`sf package install report`](#sf-package-install-report)
38
38
  - [`sf package installed list`](#sf-package-installed-list)
39
39
  - [`sf package list`](#sf-package-list)
40
+ - [`sf package push-upgrade abort`](#sf-package-push-upgrade-abort)
41
+ - [`sf package push-upgrade list`](#sf-package-push-upgrade-list)
42
+ - [`sf package push-upgrade report`](#sf-package-push-upgrade-report)
43
+ - [`sf package push-upgrade schedule`](#sf-package-push-upgrade-schedule)
40
44
  - [`sf package uninstall`](#sf-package-uninstall)
41
45
  - [`sf package uninstall report`](#sf-package-uninstall-report)
42
46
  - [`sf package update`](#sf-package-update)
@@ -139,7 +143,7 @@ FLAG DESCRIPTIONS
139
143
  --installation-key-bypass flag is required.
140
144
  ```
141
145
 
142
- _See code: [src/commands/package/convert.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/convert.ts)_
146
+ _See code: [src/commands/package/convert.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/convert.ts)_
143
147
 
144
148
  ## `sf package create`
145
149
 
@@ -218,7 +222,7 @@ FLAG DESCRIPTIONS
218
222
  Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
219
223
  ```
220
224
 
221
- _See code: [src/commands/package/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/create.ts)_
225
+ _See code: [src/commands/package/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/create.ts)_
222
226
 
223
227
  ## `sf package delete`
224
228
 
@@ -260,7 +264,7 @@ EXAMPLES
260
264
  $ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
261
265
  ```
262
266
 
263
- _See code: [src/commands/package/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/delete.ts)_
267
+ _See code: [src/commands/package/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/delete.ts)_
264
268
 
265
269
  ## `sf package install`
266
270
 
@@ -359,7 +363,7 @@ FLAG DESCRIPTIONS
359
363
  - Delete: Delete all removed components that can be safely deleted, and deprecate the other components.
360
364
  ```
361
365
 
362
- _See code: [src/commands/package/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/install.ts)_
366
+ _See code: [src/commands/package/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/install.ts)_
363
367
 
364
368
  ## `sf package install report`
365
369
 
@@ -392,7 +396,7 @@ EXAMPLES
392
396
  $ sf package install report --request-id 0Hf... --target-org me@example.com
393
397
  ```
394
398
 
395
- _See code: [src/commands/package/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/install/report.ts)_
399
+ _See code: [src/commands/package/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/install/report.ts)_
396
400
 
397
401
  ## `sf package installed list`
398
402
 
@@ -424,7 +428,7 @@ EXAMPLES
424
428
  $ sf package installed list --target-org me@example.com
425
429
  ```
426
430
 
427
- _See code: [src/commands/package/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/installed/list.ts)_
431
+ _See code: [src/commands/package/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/installed/list.ts)_
428
432
 
429
433
  ## `sf package list`
430
434
 
@@ -462,7 +466,230 @@ EXAMPLES
462
466
  $ sf package list --target-dev-hub devhub@example.com --verbose
463
467
  ```
464
468
 
465
- _See code: [src/commands/package/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/list.ts)_
469
+ _See code: [src/commands/package/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/list.ts)_
470
+
471
+ ## `sf package push-upgrade abort`
472
+
473
+ Abort a package push upgrade that has been scheduled. Only push upgrade requests with a status of Created or Pending can be aborted.
474
+
475
+ ```
476
+ USAGE
477
+ $ sf package push-upgrade abort -v <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
478
+
479
+ FLAGS
480
+ -i, --push-request-id=<value> (required) ID of the package push request (starts with 0DV). This ID is returned after
481
+ the package push-upgrade schedule command completes successfully.
482
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
483
+ configuration variable is already set.
484
+ --api-version=<value> Override the api version used for api requests made by this command
485
+
486
+ GLOBAL FLAGS
487
+ --flags-dir=<value> Import flag values from a directory.
488
+ --json Format output as json.
489
+
490
+ DESCRIPTION
491
+ Abort a package push upgrade that has been scheduled. Only push upgrade requests with a status of Created or Pending
492
+ can be aborted.
493
+
494
+ Specify the request ID for which you want abort the request. If applicable, the command displays errors related to the
495
+ request.
496
+
497
+ To show all requests in the org, run "sf package pushupgrade list --package 033...".
498
+
499
+ EXAMPLES
500
+ Cancel the specified package push upgrade request with the specified ID; uses your default Dev Hub org:
501
+
502
+ $ sf package push-upgrade abort --push-request-id 0DV...
503
+
504
+ Cancel the specified package push upgrade request in the Dev Hub org with username devhub@example.com:
505
+
506
+ $ sf package push-upgrade abort --push-request-id 0DV... --target-dev-hub devhub@example.com
507
+ ```
508
+
509
+ _See code: [src/commands/package/push-upgrade/abort.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/push-upgrade/abort.ts)_
510
+
511
+ ## `sf package push-upgrade list`
512
+
513
+ Lists the status of push upgrade requests for a given package.
514
+
515
+ ```
516
+ USAGE
517
+ $ sf package push-upgrade list -v <value> -p <value> [--json] [--flags-dir <value>] [--api-version <value>] [-l <value>] [-s
518
+ Created|Cancelled|Pending|In Progress|Failed|Succeeded] [--show-push-migrations-only]
519
+
520
+ FLAGS
521
+ -l, --scheduled-last-days=<value> Number of days in the past for which to display the list of push upgrade requests
522
+ that were scheduled. Used to filter the list output to only recently scheduled push
523
+ upgrades.
524
+ -p, --package=<value> (required) Package ID (starts with 033) of the package that you want push upgrade
525
+ information for.
526
+ -s, --status=<option> Status used to filter the list output Valid values are: Created, Canceled, Pending,
527
+ In Progress, Failed, or Succeeded
528
+ <options: Created|Cancelled|Pending|In Progress|Failed|Succeeded>
529
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the
530
+ `target-dev-hub` configuration variable is already set.
531
+ --api-version=<value> Override the api version used for api requests made by this command
532
+ --show-push-migrations-only Display only push upgrade requests for package migrations.
533
+
534
+ GLOBAL FLAGS
535
+ --flags-dir=<value> Import flag values from a directory.
536
+ --json Format output as json.
537
+
538
+ DESCRIPTION
539
+ Lists the status of push upgrade requests for a given package.
540
+
541
+ Shows the details of each request to create a push upgrade in the Dev Hub org.
542
+
543
+ All filter parameters are applied using the AND logical operator (not OR).
544
+
545
+ To get information about a specific request, run "sf package pushupgrade report" and supply the request ID.
546
+
547
+ ALIASES
548
+ $ sf force package push-upgrade list
549
+
550
+ EXAMPLES
551
+ List all package push upgrade requests in the specified Dev Hub org:
552
+
553
+ $ sf package push-upgrade list --package 033xyz --target-dev-hub myHub
554
+
555
+ List all package push upgrade requests in the specified Dev Hub org scheduled in the last 30 days:
556
+
557
+ $ sf package push-upgrade list --package 033xyz --scheduled-last-days 30 --target-dev-hub myHub
558
+
559
+ List all package push upgrade with a status Succeeded:
560
+
561
+ $ sf package push-upgrade list --package 033xyz –-status Succeeded
562
+
563
+ List all package push upgrade with a status Failed:
564
+
565
+ $ sf package push-upgrade list --package 033xyz –-status Failed
566
+ ```
567
+
568
+ _See code: [src/commands/package/push-upgrade/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/push-upgrade/list.ts)_
569
+
570
+ ## `sf package push-upgrade report`
571
+
572
+ Retrieve the status of a package push upgrade.
573
+
574
+ ```
575
+ USAGE
576
+ $ sf package push-upgrade report -v <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
577
+
578
+ FLAGS
579
+ -i, --push-request-id=<value> (required) ID of the package push request (starts with 0DV). This ID is returned after
580
+ the package push-upgrade schedule command completes successfully.
581
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
582
+ configuration variable is already set.
583
+ --api-version=<value> Override the api version used for api requests made by this command
584
+
585
+ GLOBAL FLAGS
586
+ --flags-dir=<value> Import flag values from a directory.
587
+ --json Format output as json.
588
+
589
+ DESCRIPTION
590
+ Retrieve the status of a package push upgrade.
591
+
592
+ Specify the request ID for which you want to view details. If applicable, the command displays errors related to the
593
+ request.
594
+
595
+ To show all requests in the org, run "sf package pushupgrade list".
596
+
597
+ ALIASES
598
+ $ sf force package push-upgrade report
599
+
600
+ EXAMPLES
601
+ Retrieve details about the package push upgrade with the specified ID; uses your default Dev Hub org:
602
+
603
+ $ sf package push-upgrade report --push-request-id 0DV...
604
+
605
+ Retrieve details about the specified package push request in the Dev Hub org with username devhub@example.com:
606
+
607
+ $ sf package push-upgrade report --push-request-id 0DV... --target-dev-hub devhub@example.com
608
+ ```
609
+
610
+ _See code: [src/commands/package/push-upgrade/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/push-upgrade/report.ts)_
611
+
612
+ ## `sf package push-upgrade schedule`
613
+
614
+ Schedule a package push upgrade.
615
+
616
+ ```
617
+ USAGE
618
+ $ sf package push-upgrade schedule -v <value> -p <value> [--json] [--flags-dir <value>] [--api-version <value>] [-t <value>] [-l
619
+ <value> | -f <value>] [--migrate-to-2gp]
620
+
621
+ FLAGS
622
+ -f, --org-file=<value> Filename of the CSV file that contains the list of orgs that need the package upgrade.
623
+ -l, --org-list=<value> Comma-separated list of subscriber org IDs that need the package upgrade.
624
+ -p, --package=<value> (required) ID (starts with 04t) of the package version that the package is being
625
+ upgraded to. The package version must be an active, non-beta package version.
626
+ -t, --start-time=<value> Date and time (UTC) when the push upgrade is processed. Set to the earliest time that
627
+ you want Salesforce to attempt to start the upgrade.
628
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
629
+ --api-version=<value> Override the api version used for api requests made by this command
630
+ --migrate-to-2gp Upgrade from a first-generation managed package (1GP) to a second-generation managed
631
+ package (2GP). Required when you’re pushing a 2GP package to orgs with the 1GP version
632
+ installed.
633
+
634
+ GLOBAL FLAGS
635
+ --flags-dir=<value> Import flag values from a directory.
636
+ --json Format output as json.
637
+
638
+ DESCRIPTION
639
+ Schedule a package push upgrade.
640
+
641
+ Represents a push upgrade request for upgrading a package in one or many orgs from one version to another version.
642
+ To initiate a push upgrade for an unlocked or second-generation managed package, the Create and Update
643
+ Second-Generation Packages user permission is required.
644
+ For second-generation managed packages, the push upgrade feature is available only for packages that have passed
645
+ AppExchange security review. To enable push upgrades for your managed package, log a support case in the Salesforce
646
+ Partner Community.
647
+ For unlocked packages, push upgrades are enabled by default.
648
+
649
+ Use the -–migrate-to-2GP flag to indicate you’re installing a converted second-generation managed package into an org
650
+ that has the first-generation managed package version of that package installed.
651
+
652
+ EXAMPLES
653
+ Schedule a push upgrade that initiates at a specified time:
654
+
655
+ $ sf package push-upgrade schedule --package 04txyz --start-time "2024-12-06T21:00:00" --org-file \
656
+ upgrade-orgs.csv
657
+
658
+ Schedule a push upgrade that initiates as soon as possible:
659
+
660
+ $ sf package push-upgrade schedule --package 04txyz --org-file upgrade-orgs.csv
661
+
662
+ Schedule a push migration from a 1GP package to a 2GP package:
663
+
664
+ $ sf package push-upgrade schedule --migrate-to-2gp --package 04txyz --start-time "2024-12-06T21:00:00" \
665
+ --org-file upgrade-orgs.csv --target-dev-hub myHub
666
+
667
+ FLAG DESCRIPTIONS
668
+ -f, --org-file=<value> Filename of the CSV file that contains the list of orgs that need the package upgrade.
669
+
670
+ The file must contain one org per line. The org ID must be the only value in each row.
671
+ All listed orgs must have a package version installed in their org that is lower than the package version you
672
+ specified for the --package-version flag.
673
+
674
+ -t, --start-time=<value>
675
+
676
+ Date and time (UTC) when the push upgrade is processed. Set to the earliest time that you want Salesforce to attempt
677
+ to start the upgrade.
678
+
679
+ Scheduled push upgrades begin as soon as resources are available on the Salesforce instance, which is either at or
680
+ after the start time you specify. In certain scenarios, the push upgrade starts a few hours after the scheduled
681
+ start time.
682
+
683
+ As a best practice, schedule push upgrades at off-peak hours like 1:00 AM Saturday.
684
+ If you don't specify this flag, the push upgrade is scheduled to run as soon as resources are available on the
685
+ Salesforce instance.
686
+
687
+ -v, --target-dev-hub=<value> Username or alias of the Dev Hub org.
688
+
689
+ Overrides the value of the target-dev-hub configuration variable, if set.
690
+ ```
691
+
692
+ _See code: [src/commands/package/push-upgrade/schedule.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/push-upgrade/schedule.ts)_
466
693
 
467
694
  ## `sf package uninstall`
468
695
 
@@ -510,7 +737,7 @@ EXAMPLES
510
737
  $ sf package uninstall --package "Undesirable Package Alias"
511
738
  ```
512
739
 
513
- _See code: [src/commands/package/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/uninstall.ts)_
740
+ _See code: [src/commands/package/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/uninstall.ts)_
514
741
 
515
742
  ## `sf package uninstall report`
516
743
 
@@ -543,7 +770,7 @@ EXAMPLES
543
770
  $ sf package uninstall report --request-id 06y... --target-org me@example.com
544
771
  ```
545
772
 
546
- _See code: [src/commands/package/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/uninstall/report.ts)_
773
+ _See code: [src/commands/package/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/uninstall/report.ts)_
547
774
 
548
775
  ## `sf package update`
549
776
 
@@ -598,7 +825,7 @@ FLAG DESCRIPTIONS
598
825
  associated with your package.
599
826
  ```
600
827
 
601
- _See code: [src/commands/package/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/update.ts)_
828
+ _See code: [src/commands/package/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/update.ts)_
602
829
 
603
830
  ## `sf package version create`
604
831
 
@@ -773,7 +1000,7 @@ FLAG DESCRIPTIONS
773
1000
  periods of no output from commands.
774
1001
  ```
775
1002
 
776
- _See code: [src/commands/package/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/create.ts)_
1003
+ _See code: [src/commands/package/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/version/create.ts)_
777
1004
 
778
1005
  ## `sf package version create list`
779
1006
 
@@ -834,7 +1061,7 @@ EXAMPLES
834
1061
  $ sf package version create list --created-last-days 0 --status Success
835
1062
  ```
836
1063
 
837
- _See code: [src/commands/package/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/create/list.ts)_
1064
+ _See code: [src/commands/package/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/version/create/list.ts)_
838
1065
 
839
1066
  ## `sf package version create report`
840
1067
 
@@ -877,7 +1104,7 @@ EXAMPLES
877
1104
  $ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
878
1105
  ```
879
1106
 
880
- _See code: [src/commands/package/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/create/report.ts)_
1107
+ _See code: [src/commands/package/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/version/create/report.ts)_
881
1108
 
882
1109
  ## `sf package version delete`
883
1110
 
@@ -918,7 +1145,7 @@ EXAMPLES
918
1145
  $ sf package version delete --package 04t... --target-org devhub@example.com
919
1146
  ```
920
1147
 
921
- _See code: [src/commands/package/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/delete.ts)_
1148
+ _See code: [src/commands/package/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/version/delete.ts)_
922
1149
 
923
1150
  ## `sf package version displayancestry`
924
1151
 
@@ -978,7 +1205,7 @@ FLAG DESCRIPTIONS
978
1205
  You can use the DOT code output in graph visualization software to create tree visualizations.
979
1206
  ```
980
1207
 
981
- _See code: [src/commands/package/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/displayancestry.ts)_
1208
+ _See code: [src/commands/package/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/version/displayancestry.ts)_
982
1209
 
983
1210
  ## `sf package version list`
984
1211
 
@@ -1054,7 +1281,7 @@ EXAMPLES
1054
1281
  $ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
1055
1282
  ```
1056
1283
 
1057
- _See code: [src/commands/package/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/list.ts)_
1284
+ _See code: [src/commands/package/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/version/list.ts)_
1058
1285
 
1059
1286
  ## `sf package version promote`
1060
1287
 
@@ -1098,7 +1325,7 @@ EXAMPLES
1098
1325
  $ sf package version promote --package "Awesome Package Alias"
1099
1326
  ```
1100
1327
 
1101
- _See code: [src/commands/package/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/promote.ts)_
1328
+ _See code: [src/commands/package/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/version/promote.ts)_
1102
1329
 
1103
1330
  ## `sf package version report`
1104
1331
 
@@ -1138,7 +1365,7 @@ EXAMPLES
1138
1365
  $ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
1139
1366
  ```
1140
1367
 
1141
- _See code: [src/commands/package/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/report.ts)_
1368
+ _See code: [src/commands/package/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/version/report.ts)_
1142
1369
 
1143
1370
  ## `sf package version update`
1144
1371
 
@@ -1191,7 +1418,7 @@ EXAMPLES
1191
1418
  $ sf package version update --package 04t... --version-description "New Package Version Description"
1192
1419
  ```
1193
1420
 
1194
- _See code: [src/commands/package/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/update.ts)_
1421
+ _See code: [src/commands/package/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package/version/update.ts)_
1195
1422
 
1196
1423
  ## `sf package1 version create`
1197
1424
 
@@ -1258,7 +1485,7 @@ FLAG DESCRIPTIONS
1258
1485
  subscribers.
1259
1486
  ```
1260
1487
 
1261
- _See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package1/version/create.ts)_
1488
+ _See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package1/version/create.ts)_
1262
1489
 
1263
1490
  ## `sf package1 version create get`
1264
1491
 
@@ -1291,7 +1518,7 @@ EXAMPLES
1291
1518
  $ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
1292
1519
  ```
1293
1520
 
1294
- _See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package1/version/create/get.ts)_
1521
+ _See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package1/version/create/get.ts)_
1295
1522
 
1296
1523
  ## `sf package1 version display`
1297
1524
 
@@ -1325,7 +1552,7 @@ EXAMPLES
1325
1552
  $ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
1326
1553
  ```
1327
1554
 
1328
- _See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package1/version/display.ts)_
1555
+ _See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package1/version/display.ts)_
1329
1556
 
1330
1557
  ## `sf package1 version list`
1331
1558
 
@@ -1363,6 +1590,6 @@ FLAG DESCRIPTIONS
1363
1590
  If not specified, shows all versions for all packages (managed and unmanaged) in the org.
1364
1591
  ```
1365
1592
 
1366
- _See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package1/version/list.ts)_
1593
+ _See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.15.1/src/commands/package1/version/list.ts)_
1367
1594
 
1368
1595
  <!-- commandsstop -->
@@ -0,0 +1,15 @@
1
+ import { SfCommand } from '@salesforce/sf-plugins-core';
2
+ export type PackagePushUpgradeAbortResult = {
3
+ success: boolean;
4
+ };
5
+ export declare class PackagePushUpgradeAbortCommand extends SfCommand<PackagePushUpgradeAbortResult> {
6
+ static readonly summary: string;
7
+ static readonly description: string;
8
+ static readonly examples: string[];
9
+ static readonly flags: {
10
+ 'target-dev-hub': import("@oclif/core/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/interfaces").CustomOptions>;
11
+ 'api-version': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
12
+ 'push-request-id': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
13
+ };
14
+ run(): Promise<PackagePushUpgradeAbortResult>;
15
+ }
@@ -0,0 +1,38 @@
1
+ /*
2
+ * Copyright (c) 2024, salesforce.com, inc.
3
+ * All rights reserved.
4
+ * Licensed under the BSD 3-Clause license.
5
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
6
+ */
7
+ import { Flags, SfCommand } from '@salesforce/sf-plugins-core';
8
+ import { Messages } from '@salesforce/core';
9
+ import { PackagePushUpgrade } from '@salesforce/packaging';
10
+ Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
11
+ const messages = Messages.loadMessages('@salesforce/plugin-packaging', 'package_pushupgrade_abort');
12
+ export class PackagePushUpgradeAbortCommand extends SfCommand {
13
+ static summary = messages.getMessage('summary');
14
+ static description = messages.getMessage('description');
15
+ static examples = messages.getMessages('examples');
16
+ static flags = {
17
+ 'target-dev-hub': Flags.requiredHub(),
18
+ 'api-version': Flags.orgApiVersion(),
19
+ 'push-request-id': Flags.salesforceId({
20
+ length: 'both',
21
+ char: 'i',
22
+ summary: messages.getMessage('flags.push-request-id.summary'),
23
+ required: true,
24
+ startsWith: '0DV',
25
+ }),
26
+ };
27
+ async run() {
28
+ const { flags } = await this.parse(PackagePushUpgradeAbortCommand);
29
+ const connection = flags['target-dev-hub'].getConnection(flags['api-version']);
30
+ const packagePushRequestOptions = { packagePushRequestId: flags['push-request-id'] };
31
+ const result = await PackagePushUpgrade.abort(connection, packagePushRequestOptions);
32
+ if (result) {
33
+ this.log(messages.getMessage('output', [flags['push-request-id']]));
34
+ }
35
+ return { success: result };
36
+ }
37
+ }
38
+ //# sourceMappingURL=abort.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"abort.js","sourceRoot":"","sources":["../../../../src/commands/package/push-upgrade/abort.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE3D,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,8BAA8B,EAAE,2BAA2B,CAAC,CAAC;AAMpG,MAAM,OAAO,8BAA+B,SAAQ,SAAwC;IACnF,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAC5D,MAAM,CAAU,KAAK,GAAG;QAC7B,gBAAgB,EAAE,KAAK,CAAC,WAAW,EAAE;QACrC,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;QACpC,iBAAiB,EAAE,KAAK,CAAC,YAAY,CAAC;YACpC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,+BAA+B,CAAC;YAC7D,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE,KAAK;SAClB,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;QAE/E,MAAM,yBAAyB,GAAG,EAAE,oBAAoB,EAAE,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC;QAErF,MAAM,MAAM,GAAY,MAAM,kBAAkB,CAAC,KAAK,CAAC,UAAU,EAAE,yBAAyB,CAAC,CAAC;QAE9F,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;QACtE,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAC7B,CAAC"}
@@ -0,0 +1,18 @@
1
+ import { SfCommand } from '@salesforce/sf-plugins-core';
2
+ import { PackagePushRequestListResult } from '@salesforce/packaging';
3
+ export type PackagePushRequestListResultArr = PackagePushRequestListResult[];
4
+ export declare class PackagePushRequestListCommand extends SfCommand<PackagePushRequestListResultArr> {
5
+ static readonly summary: string;
6
+ static readonly description: string;
7
+ static readonly examples: string[];
8
+ static readonly aliases: string[];
9
+ static readonly flags: {
10
+ 'target-dev-hub': import("@oclif/core/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/interfaces").CustomOptions>;
11
+ 'api-version': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
12
+ package: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
13
+ 'scheduled-last-days': import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
14
+ status: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
15
+ 'show-push-migrations-only': import("@oclif/core/interfaces").BooleanFlag<boolean>;
16
+ };
17
+ run(): Promise<PackagePushRequestListResultArr>;
18
+ }
@@ -0,0 +1,91 @@
1
+ /*
2
+ * Copyright (c) 2024, salesforce.com, inc.
3
+ * All rights reserved.
4
+ * Licensed under the BSD 3-Clause license.
5
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
6
+ */
7
+ import { Flags, orgApiVersionFlagWithDeprecations, SfCommand } from '@salesforce/sf-plugins-core';
8
+ import { Messages, Logger } from '@salesforce/core';
9
+ import { PackagePushUpgrade } from '@salesforce/packaging';
10
+ import { requiredHubFlag } from '../../../utils/hubFlag.js';
11
+ Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
12
+ const messages = Messages.loadMessages('@salesforce/plugin-packaging', 'package_pushupgrade_list');
13
+ export class PackagePushRequestListCommand extends SfCommand {
14
+ static summary = messages.getMessage('summary');
15
+ static description = messages.getMessage('description');
16
+ static examples = messages.getMessages('examples');
17
+ static aliases = ['force:package:push-upgrade:list'];
18
+ static flags = {
19
+ 'target-dev-hub': requiredHubFlag,
20
+ 'api-version': orgApiVersionFlagWithDeprecations,
21
+ package: Flags.string({
22
+ char: 'p',
23
+ summary: messages.getMessage('flags.package.summary'),
24
+ required: true,
25
+ }),
26
+ 'scheduled-last-days': Flags.integer({
27
+ char: 'l',
28
+ deprecateAliases: true,
29
+ aliases: ['scheduledlastdays'],
30
+ summary: messages.getMessage('flags.scheduled-last-days.summary'),
31
+ }),
32
+ status: Flags.custom({
33
+ options: ['Created', 'Cancelled', 'Pending', 'In Progress', 'Failed', 'Succeeded'],
34
+ })({
35
+ char: 's',
36
+ summary: messages.getMessage('flags.status.summary'),
37
+ }),
38
+ 'show-push-migrations-only': Flags.boolean({
39
+ summary: messages.getMessage('flags.show-push-migrations-only.summary'),
40
+ }),
41
+ };
42
+ async run() {
43
+ const { flags } = await this.parse(PackagePushRequestListCommand);
44
+ const logger = await Logger.child(this.constructor.name);
45
+ const hubOrg = flags['target-dev-hub'];
46
+ const connection = hubOrg.getConnection(flags['api-version']);
47
+ const scheduledLastDays = flags['scheduled-last-days'];
48
+ if (scheduledLastDays !== undefined) {
49
+ if (isNaN(scheduledLastDays) || scheduledLastDays <= 0) {
50
+ throw new Error('Invalid value for --scheduled-last-days. It must be a positive integer.');
51
+ }
52
+ }
53
+ logger.debug(`Querying PackagePushRequest records from org ${hubOrg.getOrgId()}`);
54
+ const results = await PackagePushUpgrade.list(connection, {
55
+ packageId: flags.package,
56
+ status: flags.status,
57
+ scheduledLastDays,
58
+ isMigration: flags['show-push-migrations-only'],
59
+ });
60
+ if (results.length === 0) {
61
+ this.warn('No results found');
62
+ }
63
+ else {
64
+ const data = await Promise.all(results.map(async (record) => {
65
+ const packagePushRequestId = record?.Id;
66
+ const packagePushRequestOptions = { packagePushRequestId };
67
+ const totalNumOrgs = await PackagePushUpgrade.getTotalJobs(connection, packagePushRequestOptions);
68
+ const numOrgsUpgradedFail = await PackagePushUpgrade.getFailedJobs(connection, packagePushRequestOptions);
69
+ const numOrgsUpgradedSuccess = await PackagePushUpgrade.getSucceededJobs(connection, packagePushRequestOptions);
70
+ const pv = record?.PackageVersion;
71
+ const packageVersionNumber = pv?.MajorVersion != null && pv?.MinorVersion != null ? `${pv.MajorVersion}.${pv.MinorVersion}` : undefined;
72
+ return {
73
+ Id: record?.Id,
74
+ PackageVersionId: record?.PackageVersionId,
75
+ PackageVersionName: pv?.Name,
76
+ PackageVersionNumber: packageVersionNumber,
77
+ Status: record?.Status,
78
+ ScheduledStartTime: record?.ScheduledStartTime,
79
+ StartTime: record?.StartTime,
80
+ EndTime: record?.EndTime,
81
+ NumOrgsScheduled: totalNumOrgs,
82
+ NumOrgsUpgradedFail: numOrgsUpgradedFail,
83
+ NumOrgsUpgradedSuccess: numOrgsUpgradedSuccess,
84
+ };
85
+ }));
86
+ this.table({ data });
87
+ }
88
+ return results;
89
+ }
90
+ }
91
+ //# sourceMappingURL=list.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"list.js","sourceRoot":"","sources":["../../../../src/commands/package/push-upgrade/list.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,KAAK,EAAE,iCAAiC,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAClG,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAgC,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AACzF,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,8BAA8B,EAAE,0BAA0B,CAAC,CAAC;AAKnG,MAAM,OAAO,6BAA8B,SAAQ,SAA0C;IACpF,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAC5D,MAAM,CAAU,OAAO,GAAG,CAAC,iCAAiC,CAAC,CAAC;IAC9D,MAAM,CAAU,KAAK,GAAG;QAC7B,gBAAgB,EAAE,eAAe;QACjC,aAAa,EAAE,iCAAiC;QAChD,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC;YACpB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC;YACrD,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,qBAAqB,EAAE,KAAK,CAAC,OAAO,CAAC;YACnC,IAAI,EAAE,GAAG;YACT,gBAAgB,EAAE,IAAI;YACtB,OAAO,EAAE,CAAC,mBAAmB,CAAC;YAC9B,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,mCAAmC,CAAC;SAClE,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAS;YAC3B,OAAO,EAAE,CAAC,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,aAAa,EAAE,QAAQ,EAAE,WAAW,CAAC;SACnF,CAAC,CAAC;YACD,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,sBAAsB,CAAC;SACrD,CAAC;QACF,2BAA2B,EAAE,KAAK,CAAC,OAAO,CAAC;YACzC,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,yCAAyC,CAAC;SACxE,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;QAClE,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACvC,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;QAC9D,MAAM,iBAAiB,GAAG,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAEvD,IAAI,iBAAiB,KAAK,SAAS,EAAE,CAAC;YACpC,IAAI,KAAK,CAAC,iBAAiB,CAAC,IAAI,iBAAiB,IAAI,CAAC,EAAE,CAAC;gBACvD,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAC;YAC7F,CAAC;QACH,CAAC;QAED,MAAM,CAAC,KAAK,CAAC,gDAAgD,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAElF,MAAM,OAAO,GAAoC,MAAM,kBAAkB,CAAC,IAAI,CAAC,UAAU,EAAE;YACzF,SAAS,EAAE,KAAK,CAAC,OAAO;YACxB,MAAM,EAAE,KAAK,CAAC,MAAuC;YACrD,iBAAiB;YACjB,WAAW,EAAE,KAAK,CAAC,2BAA2B,CAAC;SAChD,CAAC,CAAC;QAEH,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAChC,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,CAC5B,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,MAAoC,EAAE,EAAE;gBACzD,MAAM,oBAAoB,GAAG,MAAM,EAAE,EAAE,CAAC;gBAExC,MAAM,yBAAyB,GAAG,EAAE,oBAAoB,EAAE,CAAC;gBAE3D,MAAM,YAAY,GAAG,MAAM,kBAAkB,CAAC,YAAY,CAAC,UAAU,EAAE,yBAAyB,CAAC,CAAC;gBAElG,MAAM,mBAAmB,GAAG,MAAM,kBAAkB,CAAC,aAAa,CAAC,UAAU,EAAE,yBAAyB,CAAC,CAAC;gBAE1G,MAAM,sBAAsB,GAAG,MAAM,kBAAkB,CAAC,gBAAgB,CACtE,UAAU,EACV,yBAAyB,CAC1B,CAAC;gBAEF,MAAM,EAAE,GAAG,MAAM,EAAE,cAAc,CAAC;gBAClC,MAAM,oBAAoB,GACxB,EAAE,EAAE,YAAY,IAAI,IAAI,IAAI,EAAE,EAAE,YAAY,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,YAAY,IAAI,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;gBAE7G,OAAO;oBACL,EAAE,EAAE,MAAM,EAAE,EAAE;oBACd,gBAAgB,EAAE,MAAM,EAAE,gBAAgB;oBAC1C,kBAAkB,EAAE,EAAE,EAAE,IAAI;oBAC5B,oBAAoB,EAAE,oBAAoB;oBAE1C,MAAM,EAAE,MAAM,EAAE,MAAM;oBAEtB,kBAAkB,EAAE,MAAM,EAAE,kBAAkB;oBAE9C,SAAS,EAAE,MAAM,EAAE,SAAS;oBAE5B,OAAO,EAAE,MAAM,EAAE,OAAO;oBAExB,gBAAgB,EAAE,YAAY;oBAE9B,mBAAmB,EAAE,mBAAmB;oBAExC,sBAAsB,EAAE,sBAAsB;iBAC/C,CAAC;YACJ,CAAC,CAAC,CACH,CAAC;YAEF,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC"}
@@ -0,0 +1,18 @@
1
+ import { SfCommand } from '@salesforce/sf-plugins-core';
2
+ import { PackagePushRequestReportResult } from '@salesforce/packaging';
3
+ export type ReportCommandResult = PackagePushRequestReportResult | null;
4
+ export declare class PackagePushUpgradeReportCommand extends SfCommand<ReportCommandResult> {
5
+ static readonly summary: string;
6
+ static readonly description: string;
7
+ static readonly examples: string[];
8
+ static readonly deprecateAliases = true;
9
+ static readonly aliases: string[];
10
+ static readonly flags: {
11
+ loglevel: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
12
+ 'target-dev-hub': import("@oclif/core/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/interfaces").CustomOptions>;
13
+ 'api-version': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
14
+ 'push-request-id': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
15
+ };
16
+ run(): Promise<ReportCommandResult>;
17
+ private display;
18
+ }