@simplysf/simply 6.13.0 → 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 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@1.7.0/packages/simply-permissions/lib/commands/simply/permissions/analyze.js)_
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@1.7.0/packages/simply-permissions/lib/commands/simply/permissions/assignment/delete.js)_
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>] [-f <value> | --type read-only|view-all|modify-all | -n <value>
2601
- | -d <value> | --output <value> | -c <value> | --include-record-types | --label <value> | --description <value>]
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,44 +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, declare them all in a JSON file and pass it with
2630
- --file instead of the other flags. Each entry in the file's "permissionSets" array takes the same settings as one run
2631
- of this command; a top-level "defaults" object supplies the "directory", "output", and "includeRecordTypes" values
2632
- shared by every entry, and any entry can override them. An entry's "config" is either a path to a --config file or the
2633
- same overrides inline. Relative paths are resolved against the current directory, as they are for flags. The whole
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.
2638
-
2639
- Run the command with neither --file nor any of the flags that describe a single permission set to build every
2640
- permission sets file under the current directory: every file whose name ends in .psbuild.json, skipping node_modules,
2641
- .git, .sf, and .sfdx. Every file is validated before anything is written, and the results table shows which file
2642
- declared each permission set. If no permission sets files are found, the command prints a warning and exits
2643
- successfully.
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.
2644
2633
 
2645
- {
2646
- "defaults": {
2647
- "directory": "force-app",
2648
- "output": "force-app/main/default/permissionsets"
2649
- },
2650
- "permissionSets": [
2651
- { "name": "App_Read_Only", "type": "read-only" },
2652
2634
  {
2653
2635
  "name": "App_Admin",
2654
2636
  "type": "modify-all",
2655
2637
  "label": "App Admin",
2638
+ "directory": "force-app",
2639
+ "output": "force-app/main/default/permissionsets",
2656
2640
  "includeRecordTypes": true,
2657
2641
  "config": "config/app-admin-overrides.json"
2658
- },
2659
- {
2660
- "name": "App_Support",
2661
- "type": "view-all",
2662
- "config": { "userPermissions": { "ViewSetup": true } }
2663
- }
2664
- ]
2665
2642
  }
2666
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
+
2667
2651
  To check in CI that the committed permission sets still match their source metadata, add --check. It builds each
2668
2652
  permission set as usual but writes nothing: it compares each one with the file already at its output path and reports
2669
2653
  it as "up-to-date", "drifted", or "missing". If any permission set has drifted or is missing, the command exits with
@@ -2675,19 +2659,11 @@ EXAMPLES
2675
2659
 
2676
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
2677
2661
 
2678
- Regenerate every permission set declared in a permission sets file:
2679
-
2680
- $ sf simply permissions build --file config/app.psbuild.json
2681
-
2682
- In CI, fail if any permission set declared in a permission sets file needs to be regenerated:
2683
-
2684
- $ sf simply permissions build --file config/app.psbuild.json --check
2685
-
2686
- Regenerate every permission set declared in any .psbuild.json file under the current directory:
2662
+ Regenerate the permission set defined by every .psbuild.json file under the current directory:
2687
2663
 
2688
2664
  $ sf simply permissions build
2689
2665
 
2690
- Check every permission set declared in any .psbuild.json file under the current directory, without writing anything:
2666
+ In CI, fail if any permission set defined by a .psbuild.json file needs to be regenerated, without writing anything:
2691
2667
 
2692
2668
  $ sf simply permissions build --check
2693
2669
 
@@ -2702,14 +2678,6 @@ FLAG DESCRIPTIONS
2702
2678
  The path to the Salesforce source directory to scan for custom objects, fields, tabs, and record types. Required to
2703
2679
  build a single permission set.
2704
2680
 
2705
- -f, --file=<value> Path to a permission sets file declaring every permission set to generate
2706
-
2707
- The path to a JSON file with a "permissionSets" array, each entry describing one permission set to generate ("name",
2708
- "type", and optionally "label", "description", "directory", "output", "includeRecordTypes", "config"), and an
2709
- optional "defaults" object. Name it with the .psbuild.json suffix; any other name works but prints a warning. Can't
2710
- be combined with the flags that describe a single permission set. If you omit --file and those flags, every
2711
- .psbuild.json file under the current directory is built.
2712
-
2713
2681
  -n, --name=<value> API name for the permission set
2714
2682
 
2715
2683
  The API name for the generated permission set; also used to derive the output filename. Required to build a single
@@ -2718,8 +2686,8 @@ FLAG DESCRIPTIONS
2718
2686
  --check Check that the generated permission sets are up to date, without writing them
2719
2687
 
2720
2688
  Instead of writing each permission set, compare what would be generated with the file already at its output path.
2721
- Exits with code 1 if any permission set has drifted or is missing. Works with --file, with the single-permission-set
2722
- flags, and with neither, which checks every .psbuild.json file under the current directory.
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.
2723
2691
 
2724
2692
  --include-record-types Include record type visibilities
2725
2693
 
@@ -2736,7 +2704,7 @@ FLAG DESCRIPTIONS
2736
2704
  Required to build a single permission set.
2737
2705
  ```
2738
2706
 
2739
- _See code: [@simplysf/simply-permissions](https://github.com/SimplySF/simply-plugins/blob/@simplysf/simply-permissions@1.7.0/packages/simply-permissions/lib/commands/simply/permissions/build.js)_
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)_
2740
2708
 
2741
2709
  ## `sf simply project update api-version`
2742
2710
 
@@ -1,4 +1,4 @@
1
1
  {
2
2
  "commands": {},
3
- "version": "6.13.0"
3
+ "version": "7.0.0"
4
4
  }
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": "6.13.0",
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": "^1.7.0",
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": "970835763c6ff199a1a853eec344807f35e3315c"
183
+ "gitHead": "c6b42eec62005e590b6eb019df0d317c4e200e62"
184
184
  }