@simplysf/simply 6.12.1 → 7.0.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.
- package/README.md +31 -48
- package/oclif.manifest.json +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -2546,7 +2546,7 @@ FLAG DESCRIPTIONS
|
|
|
2546
2546
|
The path to write the generated HTML report to.
|
|
2547
2547
|
```
|
|
2548
2548
|
|
|
2549
|
-
_See code: [@simplysf/simply-permissions](https://github.com/SimplySF/simply-plugins/blob/@simplysf/simply-permissions@
|
|
2549
|
+
_See code: [@simplysf/simply-permissions](https://github.com/SimplySF/simply-plugins/blob/@simplysf/simply-permissions@2.0.0/packages/simply-permissions/lib/commands/simply/permissions/analyze.js)_
|
|
2550
2550
|
|
|
2551
2551
|
## `sf simply permissions assignment delete`
|
|
2552
2552
|
|
|
@@ -2589,7 +2589,7 @@ EXAMPLES
|
|
|
2589
2589
|
$ sf simply permissions assignment delete --permission-set-group-name My_Permission_Set_Group --target-org myOrg
|
|
2590
2590
|
```
|
|
2591
2591
|
|
|
2592
|
-
_See code: [@simplysf/simply-permissions](https://github.com/SimplySF/simply-plugins/blob/@simplysf/simply-permissions@
|
|
2592
|
+
_See code: [@simplysf/simply-permissions](https://github.com/SimplySF/simply-plugins/blob/@simplysf/simply-permissions@2.0.0/packages/simply-permissions/lib/commands/simply/permissions/assignment/delete.js)_
|
|
2593
2593
|
|
|
2594
2594
|
## `sf simply permissions build`
|
|
2595
2595
|
|
|
@@ -2597,14 +2597,13 @@ Generate permission sets from Salesforce source metadata.
|
|
|
2597
2597
|
|
|
2598
2598
|
```
|
|
2599
2599
|
USAGE
|
|
2600
|
-
$ sf simply permissions build [--json] [--flags-dir <value>] [
|
|
2601
|
-
|
|
2600
|
+
$ sf simply permissions build [--json] [--flags-dir <value>] [--type read-only|view-all|modify-all] [-n <value>] [-d
|
|
2601
|
+
<value>] [-c <value>] [--output <value>] [--include-record-types] [--label <value>] [--description <value>]
|
|
2602
2602
|
[--check]
|
|
2603
2603
|
|
|
2604
2604
|
FLAGS
|
|
2605
2605
|
-c, --config=<value> Path to a permission set configuration file
|
|
2606
2606
|
-d, --directory=<value> Path to the Salesforce project directory
|
|
2607
|
-
-f, --file=<value> Path to a permission sets file declaring every permission set to generate
|
|
2608
2607
|
-n, --name=<value> API name for the permission set
|
|
2609
2608
|
--check Check that the generated permission sets are up to date, without writing them
|
|
2610
2609
|
--description=<value> Description for the permission set
|
|
@@ -2626,38 +2625,29 @@ DESCRIPTION
|
|
|
2626
2625
|
override individual object, field, tab, record type, and user permission settings, as well as whether the permission
|
|
2627
2626
|
set requires activation.
|
|
2628
2627
|
|
|
2629
|
-
To regenerate every permission set in a project with one command,
|
|
2630
|
-
|
|
2631
|
-
of this command
|
|
2632
|
-
|
|
2633
|
-
|
|
2634
|
-
file, including referenced override files and source directories, is validated before anything is written, and each
|
|
2635
|
-
source directory is scanned only once. Name the file with the .psbuild.json suffix (for example
|
|
2636
|
-
config/app.psbuild.json): that's how `sf simply cicd build check-permission-sets` finds permission sets files, and
|
|
2637
|
-
this command warns about a file without it.
|
|
2628
|
+
To regenerate every permission set in a project with one command, define each one in its own permission set build
|
|
2629
|
+
file: a JSON file whose name ends in .psbuild.json (for example config/app-admin.psbuild.json), with the same settings
|
|
2630
|
+
as one run of this command. "name", "type", "directory", and "output" are required; "label", "description",
|
|
2631
|
+
"includeRecordTypes", and "config" are optional. "config" is either a path to a --config file or the same overrides
|
|
2632
|
+
inline. Relative paths are resolved against the current directory, as they are for flags.
|
|
2638
2633
|
|
|
2639
|
-
{
|
|
2640
|
-
"defaults": {
|
|
2641
|
-
"directory": "force-app",
|
|
2642
|
-
"output": "force-app/main/default/permissionsets"
|
|
2643
|
-
},
|
|
2644
|
-
"permissionSets": [
|
|
2645
|
-
{ "name": "App_Read_Only", "type": "read-only" },
|
|
2646
2634
|
{
|
|
2647
2635
|
"name": "App_Admin",
|
|
2648
2636
|
"type": "modify-all",
|
|
2649
2637
|
"label": "App Admin",
|
|
2638
|
+
"directory": "force-app",
|
|
2639
|
+
"output": "force-app/main/default/permissionsets",
|
|
2650
2640
|
"includeRecordTypes": true,
|
|
2651
2641
|
"config": "config/app-admin-overrides.json"
|
|
2652
|
-
},
|
|
2653
|
-
{
|
|
2654
|
-
"name": "App_Support",
|
|
2655
|
-
"type": "view-all",
|
|
2656
|
-
"config": { "userPermissions": { "ViewSetup": true } }
|
|
2657
|
-
}
|
|
2658
|
-
]
|
|
2659
2642
|
}
|
|
2660
2643
|
|
|
2644
|
+
Then run the command with none of the flags that describe a single permission set. It builds the permission set
|
|
2645
|
+
defined by every .psbuild.json file under the current directory, skipping node_modules, .git, .sf, and .sfdx. Every
|
|
2646
|
+
file, including referenced override files and source directories, is validated before anything is written, no two
|
|
2647
|
+
files can define the same permission set name, and each source directory is scanned only once. The results table shows
|
|
2648
|
+
which file defined each permission set. If no .psbuild.json files are found, the command prints a warning and exits
|
|
2649
|
+
successfully. `sf simply cicd build check-permission-sets` finds the same files.
|
|
2650
|
+
|
|
2661
2651
|
To check in CI that the committed permission sets still match their source metadata, add --check. It builds each
|
|
2662
2652
|
permission set as usual but writes nothing: it compares each one with the file already at its output path and reports
|
|
2663
2653
|
it as "up-to-date", "drifted", or "missing". If any permission set has drifted or is missing, the command exits with
|
|
@@ -2669,13 +2659,13 @@ EXAMPLES
|
|
|
2669
2659
|
|
|
2670
2660
|
$ sf simply permissions build --type modify-all --name My_Admin_Access --directory force-app --config config/permission-overrides.json --output force-app/main/default/permissionsets --include-record-types
|
|
2671
2661
|
|
|
2672
|
-
Regenerate
|
|
2662
|
+
Regenerate the permission set defined by every .psbuild.json file under the current directory:
|
|
2673
2663
|
|
|
2674
|
-
$ sf simply permissions build
|
|
2664
|
+
$ sf simply permissions build
|
|
2675
2665
|
|
|
2676
|
-
In CI, fail if any permission set
|
|
2666
|
+
In CI, fail if any permission set defined by a .psbuild.json file needs to be regenerated, without writing anything:
|
|
2677
2667
|
|
|
2678
|
-
$ sf simply permissions build --
|
|
2668
|
+
$ sf simply permissions build --check
|
|
2679
2669
|
|
|
2680
2670
|
FLAG DESCRIPTIONS
|
|
2681
2671
|
-c, --config=<value> Path to a permission set configuration file
|
|
@@ -2685,26 +2675,19 @@ FLAG DESCRIPTIONS
|
|
|
2685
2675
|
|
|
2686
2676
|
-d, --directory=<value> Path to the Salesforce project directory
|
|
2687
2677
|
|
|
2688
|
-
The path to the Salesforce source directory to scan for custom objects, fields, tabs, and record types. Required
|
|
2689
|
-
|
|
2690
|
-
|
|
2691
|
-
-f, --file=<value> Path to a permission sets file declaring every permission set to generate
|
|
2692
|
-
|
|
2693
|
-
The path to a JSON file with a "permissionSets" array, each entry describing one permission set to generate ("name",
|
|
2694
|
-
"type", and optionally "label", "description", "directory", "output", "includeRecordTypes", "config"), and an
|
|
2695
|
-
optional "defaults" object. Name it with the .psbuild.json suffix; any other name works but prints a warning. Can't
|
|
2696
|
-
be combined with the flags that describe a single permission set.
|
|
2678
|
+
The path to the Salesforce source directory to scan for custom objects, fields, tabs, and record types. Required to
|
|
2679
|
+
build a single permission set.
|
|
2697
2680
|
|
|
2698
2681
|
-n, --name=<value> API name for the permission set
|
|
2699
2682
|
|
|
2700
|
-
The API name for the generated permission set; also used to derive the output filename. Required
|
|
2701
|
-
|
|
2683
|
+
The API name for the generated permission set; also used to derive the output filename. Required to build a single
|
|
2684
|
+
permission set.
|
|
2702
2685
|
|
|
2703
2686
|
--check Check that the generated permission sets are up to date, without writing them
|
|
2704
2687
|
|
|
2705
2688
|
Instead of writing each permission set, compare what would be generated with the file already at its output path.
|
|
2706
|
-
Exits with code 1 if any permission set has drifted or is missing. Works with
|
|
2707
|
-
|
|
2689
|
+
Exits with code 1 if any permission set has drifted or is missing. Works with the single-permission-set flags, and
|
|
2690
|
+
without them, which checks the permission set defined by every .psbuild.json file under the current directory.
|
|
2708
2691
|
|
|
2709
2692
|
--include-record-types Include record type visibilities
|
|
2710
2693
|
|
|
@@ -2712,16 +2695,16 @@ FLAG DESCRIPTIONS
|
|
|
2712
2695
|
|
|
2713
2696
|
--output=<value> Output directory
|
|
2714
2697
|
|
|
2715
|
-
The directory to write the generated permission set XML file to. Required
|
|
2698
|
+
The directory to write the generated permission set XML file to. Required to build a single permission set.
|
|
2716
2699
|
|
|
2717
2700
|
--type=read-only|view-all|modify-all Baseline permission type
|
|
2718
2701
|
|
|
2719
2702
|
The baseline permission level to generate: 'read-only' grants read access to all discovered objects and fields,
|
|
2720
2703
|
'view-all' additionally grants view-all-records, and 'modify-all' grants full CRUD and modify-all-records access.
|
|
2721
|
-
Required
|
|
2704
|
+
Required to build a single permission set.
|
|
2722
2705
|
```
|
|
2723
2706
|
|
|
2724
|
-
_See code: [@simplysf/simply-permissions](https://github.com/SimplySF/simply-plugins/blob/@simplysf/simply-permissions@
|
|
2707
|
+
_See code: [@simplysf/simply-permissions](https://github.com/SimplySF/simply-plugins/blob/@simplysf/simply-permissions@2.0.0/packages/simply-permissions/lib/commands/simply/permissions/build.js)_
|
|
2725
2708
|
|
|
2726
2709
|
## `sf simply project update api-version`
|
|
2727
2710
|
|
package/oclif.manifest.json
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@simplysf/simply",
|
|
3
3
|
"description": "Salesforce CLI Plugins created by @SimplySF",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "7.0.0",
|
|
5
5
|
"author": "@ClayChipps",
|
|
6
6
|
"homepage": "https://github.com/SimplySF/simply-plugins",
|
|
7
7
|
"bugs": "https://github.com/SimplySF/simply-plugins/issues",
|
|
@@ -83,7 +83,7 @@
|
|
|
83
83
|
"@simplysf/simply-document": "^0.4.13",
|
|
84
84
|
"@simplysf/simply-flow": "^0.4.16",
|
|
85
85
|
"@simplysf/simply-package": "^3.1.7",
|
|
86
|
-
"@simplysf/simply-permissions": "^
|
|
86
|
+
"@simplysf/simply-permissions": "^2.0.0",
|
|
87
87
|
"@simplysf/simply-project": "^1.2.29",
|
|
88
88
|
"@simplysf/simply-schema": "^0.3.34",
|
|
89
89
|
"@simplysf/simply-settings": "^0.3.2",
|
|
@@ -180,5 +180,5 @@
|
|
|
180
180
|
"output": []
|
|
181
181
|
}
|
|
182
182
|
},
|
|
183
|
-
"gitHead": "
|
|
183
|
+
"gitHead": "c6b42eec62005e590b6eb019df0d317c4e200e62"
|
|
184
184
|
}
|