@simplysf/simply 4.0.0 → 4.1.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.
Files changed (2) hide show
  1. package/README.md +201 -0
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -28,6 +28,10 @@ This package is part of the [`@simplysf/simply`](https://github.com/SimplySF/sim
28
28
  - [`sf simply aep at4dx domain-process-binding list`](#sf-simply-aep-at4dx-domain-process-binding-list)
29
29
  - [`sf simply aep at4dx domain-process-binding set`](#sf-simply-aep-at4dx-domain-process-binding-set)
30
30
  - [`sf simply aep at4dx domain-process-binding validate`](#sf-simply-aep-at4dx-domain-process-binding-validate)
31
+ - [`sf simply aep at4dx field-set-inclusion create`](#sf-simply-aep-at4dx-field-set-inclusion-create)
32
+ - [`sf simply aep at4dx field-set-inclusion list`](#sf-simply-aep-at4dx-field-set-inclusion-list)
33
+ - [`sf simply aep at4dx field-set-inclusion update`](#sf-simply-aep-at4dx-field-set-inclusion-update)
34
+ - [`sf simply aep at4dx field-set-inclusion validate`](#sf-simply-aep-at4dx-field-set-inclusion-validate)
31
35
  - [`sf simply apex execute`](#sf-simply-apex-execute)
32
36
  - [`sf simply apex logs purge`](#sf-simply-apex-logs-purge)
33
37
  - [`sf simply apex trace setup`](#sf-simply-apex-trace-setup)
@@ -568,6 +572,203 @@ EXAMPLES
568
572
 
569
573
  _See code: [@simplysf/simply-aep](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-aep@0.7.0/packages/simply-aep/lib/commands/simply/aep/at4dx/domain-process-binding/validate.js)_
570
574
 
575
+ ## `sf simply aep at4dx field-set-inclusion create`
576
+
577
+ Create a new AT4DX Selector field set inclusion (SelectorConfig_FieldSetInclusion__mdt) in local source and/or a connected org.
578
+
579
+ ```
580
+ USAGE
581
+ $ sf simply aep at4dx field-set-inclusion create -n <value> -s <value> -f <value> [--json] [--flags-dir <value>] [-d <value>] [-o <value>]
582
+ [--api-version <value>] [--wait <value>] [--label <value>] [--sobject-alternate] [--active] [--force]
583
+
584
+ FLAGS
585
+ -d, --source-dir=<value> The package directory to create the field set inclusion's .md-meta.xml under. Created if
586
+ the customMetadata folder doesn't exist yet.
587
+ -f, --fieldset-name=<value> (required) FieldsetName__c — the field set to add to the selector's queried field list.
588
+ Unique org-wide across every SObject, not per-SObject.
589
+ -n, --developer-name=<value> (required) The record's DeveloperName. Must start with a letter, contain only letters,
590
+ numbers, and single underscores, not end with an underscore, and be 40 characters or
591
+ fewer.
592
+ -o, --target-org=<value> Deploy the generated field set inclusion to this org after writing it.
593
+ -s, --sobject=<value> (required) The SObject API name to bind the field set to (BindingSObject__c, or
594
+ BindingSObjectAlternate__c with --sobject-alternate).
595
+ --[no-]active IsActive__c. Defaults to true, matching the Custom Metadata Type's own default. Pass
596
+ --no-active to create it inactive.
597
+ --api-version=<value> Override the api version used for api requests made by this command
598
+ --force Write (and deploy) even if validation finds an error-severity issue. Validation still
599
+ runs and its issues are still printed and returned.
600
+ --label=<value> The record's label. Defaults to --developer-name. Must be 40 characters or fewer.
601
+ --[no-]sobject-alternate Write --sobject to BindingSObjectAlternate__c instead of BindingSObject__c. Use this for
602
+ a SObject that can't be referenced through an EntityDefinition field at all (for example
603
+ ServiceResource and other Setup objects).
604
+ --wait=<value> [default: 33] Deploy poll timeout, in minutes. Only meaningful with --target-org.
605
+
606
+ GLOBAL FLAGS
607
+ --flags-dir=<value> Import flag values from a directory.
608
+ --json Format output as json.
609
+
610
+ DESCRIPTION
611
+ Create a new AT4DX Selector field set inclusion (SelectorConfig_FieldSetInclusion__mdt) in local source and/or a
612
+ connected org.
613
+
614
+ Generates a `SelectorConfig_FieldSetInclusion.<DeveloperName>.md-meta.xml` file from the given flags and writes it
615
+ under --source-dir, deploys it to --target-org, or both. Validates the resulting record — alongside everything else
616
+ already in scope — with the same rules `simply aep at4dx field-set-inclusion validate` uses, and refuses to write if
617
+ that introduces an error-severity issue unless --force is passed. At least one of --source-dir/--target-org is
618
+ required; both may be given at once (write to source and deploy it live in the same run). Given --target-org alone,
619
+ the file is written to a temporary directory, deployed, and discarded — no working-tree footprint.
620
+
621
+ --sobject writes BindingSObject__c by default (pass --sobject-alternate to write BindingSObjectAlternate__c instead,
622
+ for a SObject — such as ServiceResource and other Setup objects — that can't be referenced through an EntityDefinition
623
+ field at all).
624
+
625
+ EXAMPLES
626
+ $ sf simply aep at4dx field-set-inclusion create --source-dir sfdx-source/core --developer-name Account_Contact_Fields --sobject Account --fieldset-name ContactRelatedFields
627
+
628
+ $ sf simply aep at4dx field-set-inclusion create --target-org myOrg --developer-name ServiceResource_Skills --sobject ServiceResource --sobject-alternate --fieldset-name SkillFields
629
+ ```
630
+
631
+ _See code: [@simplysf/simply-aep](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-aep@0.7.0/packages/simply-aep/lib/commands/simply/aep/at4dx/field-set-inclusion/create.js)_
632
+
633
+ ## `sf simply aep at4dx field-set-inclusion list`
634
+
635
+ List the AT4DX Selector field set inclusions configured in an org or local source.
636
+
637
+ ```
638
+ USAGE
639
+ $ sf simply aep at4dx field-set-inclusion list [--json] [--flags-dir <value>] [-o <value>] [--api-version <value>] [-d
640
+ <value>...]
641
+
642
+ FLAGS
643
+ -d, --source-dir=<value>... One or more paths to directories containing Salesforce DX source. Use this for
644
+ local-source discovery.
645
+ -o, --target-org=<value> Username or alias of the org to read field set inclusions from. Use this for live-org
646
+ discovery.
647
+ --api-version=<value> Override the api version used for api requests made by this command
648
+
649
+ GLOBAL FLAGS
650
+ --flags-dir=<value> Import flag values from a directory.
651
+ --json Format output as json.
652
+
653
+ DESCRIPTION
654
+ List the AT4DX Selector field set inclusions configured in an org or local source.
655
+
656
+ Reads `SelectorConfig_FieldSetInclusion__mdt` — either from a live org or from local Salesforce DX source — and lists
657
+ every record found. Unlike `simply aep at4dx binding list`, there's no priority/winner concept: every `IsActive__c:
658
+ true` record for a selector's SObject contributes its field set simultaneously, so this is a flat table, not a
659
+ resolved one. Exactly one of `--target-org` or `--source-dir` must be specified.
660
+
661
+ EXAMPLES
662
+ $ sf simply aep at4dx field-set-inclusion list --target-org myOrg
663
+
664
+ $ sf simply aep at4dx field-set-inclusion list --source-dir sfdx-source/core --source-dir sfdx-source/app
665
+
666
+ $ sf simply aep at4dx field-set-inclusion list --target-org myOrg --json
667
+ ```
668
+
669
+ _See code: [@simplysf/simply-aep](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-aep@0.7.0/packages/simply-aep/lib/commands/simply/aep/at4dx/field-set-inclusion/list.js)_
670
+
671
+ ## `sf simply aep at4dx field-set-inclusion update`
672
+
673
+ Update an existing AT4DX Selector field set inclusion (SelectorConfig_FieldSetInclusion__mdt) in local source and/or a connected org.
674
+
675
+ ```
676
+ USAGE
677
+ $ sf simply aep at4dx field-set-inclusion update -n <value> [--json] [--flags-dir <value>] [-d <value>...] [-o <value>] [--api-version <value>]
678
+ [--wait <value>] [--label <value>] [-s <value>] [--sobject-alternate] [-f <value>] [--active] [--force]
679
+
680
+ FLAGS
681
+ -d, --source-dir=<value>... One or more paths to directories containing Salesforce DX source, searched for the
682
+ record to update.
683
+ -f, --fieldset-name=<value> FieldsetName__c — the field set to add to the selector's queried field list. Changing it
684
+ changes which field set is included. If not given, the existing value is kept.
685
+ -n, --developer-name=<value> (required) The DeveloperName of the record to update.
686
+ -o, --target-org=<value> Locate (when --source-dir isn't given) and/or deploy the record to this org.
687
+ -s, --sobject=<value> The SObject API name to bind the field set to. If not given, the existing value is kept.
688
+ --[no-]active IsActive__c. If not given, the existing value is kept. Pass --no-active to deactivate.
689
+ --api-version=<value> Override the api version used for api requests made by this command
690
+ --force Write (and deploy) even if validation finds an error-severity issue. Validation still
691
+ runs and its issues are still printed and returned.
692
+ --label=<value> The record's label. If not given, the existing label is kept.
693
+ --[no-]sobject-alternate Write --sobject to BindingSObjectAlternate__c instead of BindingSObject__c, for a
694
+ SObject that can't be referenced through an EntityDefinition field at all (for example
695
+ ServiceResource and other Setup objects). If not given, the record keeps whichever field
696
+ it already uses — this flag only needs to be passed to change it.
697
+ --wait=<value> [default: 33] Deploy poll timeout, in minutes. Only meaningful with --target-org.
698
+
699
+ GLOBAL FLAGS
700
+ --flags-dir=<value> Import flag values from a directory.
701
+ --json Format output as json.
702
+
703
+ DESCRIPTION
704
+ Update an existing AT4DX Selector field set inclusion (SelectorConfig_FieldSetInclusion__mdt) in local source and/or a
705
+ connected org.
706
+
707
+ Finds the field set inclusion named --developer-name in local source and/or a connected org, applies only the fields
708
+ given as flags — everything else, including which SObject reference field it uses, is preserved from the found record
709
+ — and rewrites its `.md-meta.xml` file. Validates the resulting record — alongside everything else already in scope —
710
+ with the same rules `simply aep at4dx field-set-inclusion validate` uses, and refuses to write if that introduces an
711
+ error-severity issue unless --force is passed.
712
+
713
+ When --source-dir is given, the record is located there (searched across every directory given, same as
714
+ `list`/`validate`) and that exact file is rewritten; the found file is also deployed if --target-org is given. When
715
+ only --target-org is given, the record is located and updated directly in the org via a temporary file, deployed, then
716
+ discarded — no working-tree footprint.
717
+
718
+ --developer-name identifies the record to update and can't itself be changed by this command.
719
+
720
+ EXAMPLES
721
+ $ sf simply aep at4dx field-set-inclusion update --source-dir sfdx-source/core --source-dir sfdx-source/app --developer-name Account_Contact_Fields --no-active
722
+
723
+ $ sf simply aep at4dx field-set-inclusion update --target-org myOrg --developer-name Account_Contact_Fields --fieldset-name ContactRelatedFieldsV2
724
+ ```
725
+
726
+ _See code: [@simplysf/simply-aep](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-aep@0.7.0/packages/simply-aep/lib/commands/simply/aep/at4dx/field-set-inclusion/update.js)_
727
+
728
+ ## `sf simply aep at4dx field-set-inclusion validate`
729
+
730
+ Validate the AT4DX Selector field set inclusions configured in an org or local source, failing when a wiring problem is found.
731
+
732
+ ```
733
+ USAGE
734
+ $ sf simply aep at4dx field-set-inclusion validate [--json] [--flags-dir <value>] [-o <value>] [--api-version <value>]
735
+ [-d <value>...]
736
+
737
+ FLAGS
738
+ -d, --source-dir=<value>... One or more paths to directories containing Salesforce DX source. Use this for
739
+ local-source discovery.
740
+ -o, --target-org=<value> Username or alias of the org to read field set inclusions from. Use this for live-org
741
+ discovery.
742
+ --api-version=<value> Override the api version used for api requests made by this command
743
+
744
+ GLOBAL FLAGS
745
+ --flags-dir=<value> Import flag values from a directory.
746
+ --json Format output as json.
747
+
748
+ DESCRIPTION
749
+ Validate the AT4DX Selector field set inclusions configured in an org or local source, failing when a wiring problem
750
+ is found.
751
+
752
+ Reads `SelectorConfig_FieldSetInclusion__mdt` — either from a live org or from local Salesforce DX source — and checks
753
+ them for problems `simply aep at4dx field-set-inclusion list` doesn't fail on: a record with no resolvable SObject, an
754
+ ambiguous SObject reference, a SObject reference naming a standard object that can't actually go through an
755
+ EntityDefinition metadata relationship, two records sharing a FieldsetName__c value (unique org-wide, not
756
+ per-SObject), and the same DeveloperName defined more than once. Exactly one of `--target-org` or `--source-dir` must
757
+ be specified.
758
+
759
+ Prints a table of every issue found. Exits non-zero when any issue is an error (a warning alone doesn't fail the
760
+ command) — use this in CI to gate on AT4DX field set inclusion wiring problems before they reach an org.
761
+
762
+ EXAMPLES
763
+ $ sf simply aep at4dx field-set-inclusion validate --target-org myOrg
764
+
765
+ $ sf simply aep at4dx field-set-inclusion validate --source-dir sfdx-source/core --source-dir sfdx-source/app
766
+
767
+ $ sf simply aep at4dx field-set-inclusion validate --target-org myOrg --json
768
+ ```
769
+
770
+ _See code: [@simplysf/simply-aep](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-aep@0.7.0/packages/simply-aep/lib/commands/simply/aep/at4dx/field-set-inclusion/validate.js)_
771
+
571
772
  ## `sf simply apex execute`
572
773
 
573
774
  Execute anonymous Apex code.
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.0.0",
4
+ "version": "4.1.0",
5
5
  "author": "@ClayChipps",
6
6
  "homepage": "https://github.com/SimplySF/simply-node",
7
7
  "bugs": "https://github.com/SimplySF/simply-node/issues",
@@ -75,7 +75,7 @@
75
75
  },
76
76
  "dependencies": {
77
77
  "@oclif/core": "^4.11.2",
78
- "@simplysf/simply-aep": "^0.8.0",
78
+ "@simplysf/simply-aep": "^0.9.0",
79
79
  "@simplysf/simply-apex": "^1.6.6",
80
80
  "@simplysf/simply-community": "^0.6.2",
81
81
  "@simplysf/simply-data": "^2.4.1",
@@ -184,5 +184,5 @@
184
184
  "output": []
185
185
  }
186
186
  },
187
- "gitHead": "4c25233b2880738c9ce91617035ba40ccabad061"
187
+ "gitHead": "b1b42d6f0d817ae31c9c9580bc7914182d9e8361"
188
188
  }