@salesforce/plugin-org 4.2.2 → 4.2.4

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 (3) hide show
  1. package/README.md +14 -14
  2. package/oclif.manifest.json +129 -129
  3. package/package.json +12 -12
package/README.md CHANGED
@@ -229,7 +229,7 @@ FLAG DESCRIPTIONS
229
229
  sandbox.
230
230
  ```
231
231
 
232
- _See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.2/src/commands/org/create/sandbox.ts)_
232
+ _See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.4/src/commands/org/create/sandbox.ts)_
233
233
 
234
234
  ## `sf org create scratch`
235
235
 
@@ -383,7 +383,7 @@ FLAG DESCRIPTIONS
383
383
  Omit this flag to have Salesforce generate a unique username for your org.
384
384
  ```
385
385
 
386
- _See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.2/src/commands/org/create/scratch.ts)_
386
+ _See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.4/src/commands/org/create/scratch.ts)_
387
387
 
388
388
  ## `sf org delete sandbox`
389
389
 
@@ -429,7 +429,7 @@ EXAMPLES
429
429
  $ sf org delete sandbox --target-org my-sandbox --no-prompt
430
430
  ```
431
431
 
432
- _See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.2/src/commands/org/delete/sandbox.ts)_
432
+ _See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.4/src/commands/org/delete/sandbox.ts)_
433
433
 
434
434
  ## `sf org delete scratch`
435
435
 
@@ -473,7 +473,7 @@ EXAMPLES
473
473
  $ sf org delete scratch --target-org my-scratch-org --no-prompt
474
474
  ```
475
475
 
476
- _See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.2/src/commands/org/delete/scratch.ts)_
476
+ _See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.4/src/commands/org/delete/scratch.ts)_
477
477
 
478
478
  ## `sf org disable tracking`
479
479
 
@@ -512,7 +512,7 @@ EXAMPLES
512
512
  $ sf org disable tracking
513
513
  ```
514
514
 
515
- _See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.2/src/commands/org/disable/tracking.ts)_
515
+ _See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.4/src/commands/org/disable/tracking.ts)_
516
516
 
517
517
  ## `sf org display`
518
518
 
@@ -557,7 +557,7 @@ EXAMPLES
557
557
  $ sf org display --target-org TestOrg1 --verbose
558
558
  ```
559
559
 
560
- _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.2/src/commands/org/display.ts)_
560
+ _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.4/src/commands/org/display.ts)_
561
561
 
562
562
  ## `sf org enable tracking`
563
563
 
@@ -599,7 +599,7 @@ EXAMPLES
599
599
  $ sf org enable tracking
600
600
  ```
601
601
 
602
- _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.2/src/commands/org/enable/tracking.ts)_
602
+ _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.4/src/commands/org/enable/tracking.ts)_
603
603
 
604
604
  ## `sf org list`
605
605
 
@@ -638,7 +638,7 @@ EXAMPLES
638
638
  $ sf org list --clean
639
639
  ```
640
640
 
641
- _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.2/src/commands/org/list.ts)_
641
+ _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.4/src/commands/org/list.ts)_
642
642
 
643
643
  ## `sf org list metadata`
644
644
 
@@ -705,7 +705,7 @@ FLAG DESCRIPTIONS
705
705
  Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
706
706
  ```
707
707
 
708
- _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.2/src/commands/org/list/metadata.ts)_
708
+ _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.4/src/commands/org/list/metadata.ts)_
709
709
 
710
710
  ## `sf org list metadata-types`
711
711
 
@@ -760,7 +760,7 @@ FLAG DESCRIPTIONS
760
760
  Override the api version used for api requests made by this command
761
761
  ```
762
762
 
763
- _See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.2/src/commands/org/list/metadata-types.ts)_
763
+ _See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.4/src/commands/org/list/metadata-types.ts)_
764
764
 
765
765
  ## `sf org open`
766
766
 
@@ -832,7 +832,7 @@ EXAMPLES
832
832
  $ sf org open --source-file force-app/main/default/flows/Hello.flow-meta.xml
833
833
  ```
834
834
 
835
- _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.2/src/commands/org/open.ts)_
835
+ _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.4/src/commands/org/open.ts)_
836
836
 
837
837
  ## `sf org refresh sandbox`
838
838
 
@@ -911,7 +911,7 @@ FLAG DESCRIPTIONS
911
911
  By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.
912
912
  ```
913
913
 
914
- _See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.2/src/commands/org/refresh/sandbox.ts)_
914
+ _See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.4/src/commands/org/refresh/sandbox.ts)_
915
915
 
916
916
  ## `sf org resume sandbox`
917
917
 
@@ -974,7 +974,7 @@ FLAG DESCRIPTIONS
974
974
  returns the job ID. To resume checking the sandbox creation, rerun this command.
975
975
  ```
976
976
 
977
- _See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.2/src/commands/org/resume/sandbox.ts)_
977
+ _See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.4/src/commands/org/resume/sandbox.ts)_
978
978
 
979
979
  ## `sf org resume scratch`
980
980
 
@@ -1021,6 +1021,6 @@ FLAG DESCRIPTIONS
1021
1021
  The job ID is valid for 24 hours after you start the scratch org creation.
1022
1022
  ```
1023
1023
 
1024
- _See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.2/src/commands/org/resume/scratch.ts)_
1024
+ _See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/4.2.4/src/commands/org/resume/scratch.ts)_
1025
1025
 
1026
1026
  <!-- commandsstop -->
@@ -1403,134 +1403,6 @@
1403
1403
  "tracking:enable:org"
1404
1404
  ]
1405
1405
  },
1406
- "org:refresh:sandbox": {
1407
- "aliases": [],
1408
- "args": {},
1409
- "description": "Refreshing a sandbox copies the metadata, and optionally data, from your source org to the refreshed sandbox org. You can optionally specify a definition file if you want to change the configuration of the refreshed sandbox, such as its license type or template ID.\n\nYou're not allowed to change the sandbox name when you refresh it with this command. If you want to change the sandbox name, first delete it with the \"org delete sandbox\" command. And then recreate it with the \"org create sandbox\" command and give it a new name.",
1410
- "examples": [
1411
- "Refresh the sandbox named \"devSbx1\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --name devSbx1 --target-org prodOrg",
1412
- "Refresh the sandbox named \"devSbx2\", and override the configuration of the refreshed sandbox with the properties in the specified defintion file. The default target org is the production org, so you don't need to specify the `--target-org` flag in this case.\n<%= config.bin %> <%= command.id %> --name devSbx2 --definition-file devSbx2-config.json",
1413
- "Refresh the sandbox using the name defined in the definition file. The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --definition-file devSbx3-config.json --target-org prodOrg"
1414
- ],
1415
- "flags": {
1416
- "json": {
1417
- "description": "Format output as json.",
1418
- "helpGroup": "GLOBAL",
1419
- "name": "json",
1420
- "allowNo": false,
1421
- "type": "boolean"
1422
- },
1423
- "flags-dir": {
1424
- "helpGroup": "GLOBAL",
1425
- "name": "flags-dir",
1426
- "summary": "Import flag values from a directory.",
1427
- "hasDynamicHelp": false,
1428
- "multiple": false,
1429
- "type": "option"
1430
- },
1431
- "no-auto-activate": {
1432
- "description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
1433
- "name": "no-auto-activate",
1434
- "summary": "Disable auto-activation of the sandbox after a successful refresh.",
1435
- "allowNo": false,
1436
- "type": "boolean"
1437
- },
1438
- "wait": {
1439
- "char": "w",
1440
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command for you run to check the status of the refresh. The displayed command includes the job ID for the running sandbox refresh.",
1441
- "exclusive": [
1442
- "async"
1443
- ],
1444
- "name": "wait",
1445
- "summary": "Number of minutes to poll for sandbox refresh status.",
1446
- "hasDynamicHelp": true,
1447
- "helpValue": "<minutes>",
1448
- "multiple": false,
1449
- "type": "option"
1450
- },
1451
- "poll-interval": {
1452
- "char": "i",
1453
- "exclusive": [
1454
- "async"
1455
- ],
1456
- "name": "poll-interval",
1457
- "summary": "Number of seconds to wait between status polling requests.",
1458
- "hasDynamicHelp": true,
1459
- "helpValue": "<seconds>",
1460
- "multiple": false,
1461
- "type": "option"
1462
- },
1463
- "async": {
1464
- "description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox refresh, run \"<%= config.bin %> org resume sandbox\".",
1465
- "exclusive": [
1466
- "wait",
1467
- "poll-interval"
1468
- ],
1469
- "name": "async",
1470
- "summary": "Request the sandbox refresh, but don't wait for it to complete.",
1471
- "allowNo": false,
1472
- "type": "boolean"
1473
- },
1474
- "name": {
1475
- "char": "n",
1476
- "name": "name",
1477
- "summary": "Name of the existing sandbox org in your production org that you want to refresh.",
1478
- "hasDynamicHelp": false,
1479
- "multiple": false,
1480
- "type": "option"
1481
- },
1482
- "definition-file": {
1483
- "char": "f",
1484
- "description": "The sandbox definition file is a blueprint for the sandbox; use the file to change the sandbox configuration during a refresh. If you don't want to change the sandbox configuration when you refresh it, then simply use the --name flag to specify the sandbox and don't use this flag. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.",
1485
- "name": "definition-file",
1486
- "summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
1487
- "hasDynamicHelp": false,
1488
- "multiple": false,
1489
- "type": "option"
1490
- },
1491
- "target-org": {
1492
- "char": "o",
1493
- "name": "target-org",
1494
- "noCacheDefault": true,
1495
- "required": true,
1496
- "summary": "Username or alias of the production org that contains the sandbox license.",
1497
- "hasDynamicHelp": true,
1498
- "multiple": false,
1499
- "type": "option"
1500
- },
1501
- "no-prompt": {
1502
- "name": "no-prompt",
1503
- "summary": "Don't prompt for confirmation about the sandbox refresh.",
1504
- "allowNo": false,
1505
- "type": "boolean"
1506
- }
1507
- },
1508
- "hasDynamicHelp": true,
1509
- "hiddenAliases": [],
1510
- "id": "org:refresh:sandbox",
1511
- "pluginAlias": "@salesforce/plugin-org",
1512
- "pluginName": "@salesforce/plugin-org",
1513
- "pluginType": "core",
1514
- "strict": true,
1515
- "summary": "Refresh a sandbox org using the sandbox name.",
1516
- "isESM": true,
1517
- "relativePath": [
1518
- "lib",
1519
- "commands",
1520
- "org",
1521
- "refresh",
1522
- "sandbox.js"
1523
- ],
1524
- "aliasPermutations": [],
1525
- "permutations": [
1526
- "org:refresh:sandbox",
1527
- "refresh:org:sandbox",
1528
- "refresh:sandbox:org",
1529
- "org:sandbox:refresh",
1530
- "sandbox:org:refresh",
1531
- "sandbox:refresh:org"
1532
- ]
1533
- },
1534
1406
  "org:list:metadata-types": {
1535
1407
  "aliases": [
1536
1408
  "force:mdapi:describemetadata"
@@ -1790,6 +1662,134 @@
1790
1662
  "metadata:list:org"
1791
1663
  ]
1792
1664
  },
1665
+ "org:refresh:sandbox": {
1666
+ "aliases": [],
1667
+ "args": {},
1668
+ "description": "Refreshing a sandbox copies the metadata, and optionally data, from your source org to the refreshed sandbox org. You can optionally specify a definition file if you want to change the configuration of the refreshed sandbox, such as its license type or template ID.\n\nYou're not allowed to change the sandbox name when you refresh it with this command. If you want to change the sandbox name, first delete it with the \"org delete sandbox\" command. And then recreate it with the \"org create sandbox\" command and give it a new name.",
1669
+ "examples": [
1670
+ "Refresh the sandbox named \"devSbx1\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --name devSbx1 --target-org prodOrg",
1671
+ "Refresh the sandbox named \"devSbx2\", and override the configuration of the refreshed sandbox with the properties in the specified defintion file. The default target org is the production org, so you don't need to specify the `--target-org` flag in this case.\n<%= config.bin %> <%= command.id %> --name devSbx2 --definition-file devSbx2-config.json",
1672
+ "Refresh the sandbox using the name defined in the definition file. The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --definition-file devSbx3-config.json --target-org prodOrg"
1673
+ ],
1674
+ "flags": {
1675
+ "json": {
1676
+ "description": "Format output as json.",
1677
+ "helpGroup": "GLOBAL",
1678
+ "name": "json",
1679
+ "allowNo": false,
1680
+ "type": "boolean"
1681
+ },
1682
+ "flags-dir": {
1683
+ "helpGroup": "GLOBAL",
1684
+ "name": "flags-dir",
1685
+ "summary": "Import flag values from a directory.",
1686
+ "hasDynamicHelp": false,
1687
+ "multiple": false,
1688
+ "type": "option"
1689
+ },
1690
+ "no-auto-activate": {
1691
+ "description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
1692
+ "name": "no-auto-activate",
1693
+ "summary": "Disable auto-activation of the sandbox after a successful refresh.",
1694
+ "allowNo": false,
1695
+ "type": "boolean"
1696
+ },
1697
+ "wait": {
1698
+ "char": "w",
1699
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command for you run to check the status of the refresh. The displayed command includes the job ID for the running sandbox refresh.",
1700
+ "exclusive": [
1701
+ "async"
1702
+ ],
1703
+ "name": "wait",
1704
+ "summary": "Number of minutes to poll for sandbox refresh status.",
1705
+ "hasDynamicHelp": true,
1706
+ "helpValue": "<minutes>",
1707
+ "multiple": false,
1708
+ "type": "option"
1709
+ },
1710
+ "poll-interval": {
1711
+ "char": "i",
1712
+ "exclusive": [
1713
+ "async"
1714
+ ],
1715
+ "name": "poll-interval",
1716
+ "summary": "Number of seconds to wait between status polling requests.",
1717
+ "hasDynamicHelp": true,
1718
+ "helpValue": "<seconds>",
1719
+ "multiple": false,
1720
+ "type": "option"
1721
+ },
1722
+ "async": {
1723
+ "description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox refresh, run \"<%= config.bin %> org resume sandbox\".",
1724
+ "exclusive": [
1725
+ "wait",
1726
+ "poll-interval"
1727
+ ],
1728
+ "name": "async",
1729
+ "summary": "Request the sandbox refresh, but don't wait for it to complete.",
1730
+ "allowNo": false,
1731
+ "type": "boolean"
1732
+ },
1733
+ "name": {
1734
+ "char": "n",
1735
+ "name": "name",
1736
+ "summary": "Name of the existing sandbox org in your production org that you want to refresh.",
1737
+ "hasDynamicHelp": false,
1738
+ "multiple": false,
1739
+ "type": "option"
1740
+ },
1741
+ "definition-file": {
1742
+ "char": "f",
1743
+ "description": "The sandbox definition file is a blueprint for the sandbox; use the file to change the sandbox configuration during a refresh. If you don't want to change the sandbox configuration when you refresh it, then simply use the --name flag to specify the sandbox and don't use this flag. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.",
1744
+ "name": "definition-file",
1745
+ "summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
1746
+ "hasDynamicHelp": false,
1747
+ "multiple": false,
1748
+ "type": "option"
1749
+ },
1750
+ "target-org": {
1751
+ "char": "o",
1752
+ "name": "target-org",
1753
+ "noCacheDefault": true,
1754
+ "required": true,
1755
+ "summary": "Username or alias of the production org that contains the sandbox license.",
1756
+ "hasDynamicHelp": true,
1757
+ "multiple": false,
1758
+ "type": "option"
1759
+ },
1760
+ "no-prompt": {
1761
+ "name": "no-prompt",
1762
+ "summary": "Don't prompt for confirmation about the sandbox refresh.",
1763
+ "allowNo": false,
1764
+ "type": "boolean"
1765
+ }
1766
+ },
1767
+ "hasDynamicHelp": true,
1768
+ "hiddenAliases": [],
1769
+ "id": "org:refresh:sandbox",
1770
+ "pluginAlias": "@salesforce/plugin-org",
1771
+ "pluginName": "@salesforce/plugin-org",
1772
+ "pluginType": "core",
1773
+ "strict": true,
1774
+ "summary": "Refresh a sandbox org using the sandbox name.",
1775
+ "isESM": true,
1776
+ "relativePath": [
1777
+ "lib",
1778
+ "commands",
1779
+ "org",
1780
+ "refresh",
1781
+ "sandbox.js"
1782
+ ],
1783
+ "aliasPermutations": [],
1784
+ "permutations": [
1785
+ "org:refresh:sandbox",
1786
+ "refresh:org:sandbox",
1787
+ "refresh:sandbox:org",
1788
+ "org:sandbox:refresh",
1789
+ "sandbox:org:refresh",
1790
+ "sandbox:refresh:org"
1791
+ ]
1792
+ },
1793
1793
  "org:resume:sandbox": {
1794
1794
  "aliases": [
1795
1795
  "env:resume:sandbox"
@@ -1982,5 +1982,5 @@
1982
1982
  ]
1983
1983
  }
1984
1984
  },
1985
- "version": "4.2.2"
1985
+ "version": "4.2.4"
1986
1986
  }
package/package.json CHANGED
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-org",
3
3
  "description": "Commands to interact with Salesforce orgs",
4
- "version": "4.2.2",
4
+ "version": "4.2.4",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
8
- "@oclif/core": "^4.0.3",
9
- "@salesforce/core": "^7.3.10",
10
- "@salesforce/kit": "^3.1.1",
11
- "@salesforce/sf-plugins-core": "^10.0.0",
12
- "@salesforce/source-deploy-retrieve": "^11.6.5",
8
+ "@oclif/core": "^4.0.6",
9
+ "@salesforce/core": "^7.4.1",
10
+ "@salesforce/kit": "^3.1.5",
11
+ "@salesforce/sf-plugins-core": "^11.0.1",
12
+ "@salesforce/source-deploy-retrieve": "^11.6.7",
13
13
  "ansis": "^3.2.0",
14
14
  "change-case": "^5.4.4",
15
15
  "is-wsl": "^3.1.0",
@@ -17,13 +17,13 @@
17
17
  },
18
18
  "devDependencies": {
19
19
  "@oclif/plugin-command-snapshot": "^5.2.1",
20
- "@salesforce/cli-plugins-testkit": "^5.3.10",
20
+ "@salesforce/cli-plugins-testkit": "^5.3.12",
21
21
  "@salesforce/dev-scripts": "^10.1.0",
22
- "@salesforce/plugin-command-reference": "^3.1.1",
22
+ "@salesforce/plugin-command-reference": "^3.1.3",
23
23
  "@salesforce/ts-sinon": "1.4.19",
24
- "eslint-plugin-sf-plugin": "^1.18.5",
24
+ "eslint-plugin-sf-plugin": "^1.18.7",
25
25
  "moment": "^2.30.1",
26
- "oclif": "^4.13.1",
26
+ "oclif": "^4.13.6",
27
27
  "ts-node": "^10.9.2",
28
28
  "typescript": "^5.4.5"
29
29
  },
@@ -233,7 +233,7 @@
233
233
  "exports": "./lib/index.js",
234
234
  "type": "module",
235
235
  "sfdx": {
236
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/4.2.2.crt",
237
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/4.2.2.sig"
236
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/4.2.4.crt",
237
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/4.2.4.sig"
238
238
  }
239
239
  }