@salesforce/plugin-templates 57.5.0 → 57.5.2

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 +17 -17
  2. package/oclif.manifest.json +248 -248
  3. package/package.json +8 -8
package/README.md CHANGED
@@ -179,7 +179,7 @@ FLAG DESCRIPTIONS
179
179
  directory.
180
180
  ```
181
181
 
182
- _See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.0/src/commands/template/generate/analytics/template.ts)_
182
+ _See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.2/src/commands/template/generate/analytics/template.ts)_
183
183
 
184
184
  ## `sf template generate apex class`
185
185
 
@@ -241,7 +241,7 @@ FLAG DESCRIPTIONS
241
241
  Supplied parameter values or default values are filled into a copy of the template.
242
242
  ```
243
243
 
244
- _See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.0/src/commands/template/generate/apex/class.ts)_
244
+ _See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.2/src/commands/template/generate/apex/class.ts)_
245
245
 
246
246
  ## `sf template generate apex trigger`
247
247
 
@@ -311,7 +311,7 @@ FLAG DESCRIPTIONS
311
311
  Supplied parameter values or default values are filled into a copy of the template.
312
312
  ```
313
313
 
314
- _See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.0/src/commands/template/generate/apex/trigger.ts)_
314
+ _See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.2/src/commands/template/generate/apex/trigger.ts)_
315
315
 
316
316
  ## `sf template generate digital-experience site`
317
317
 
@@ -365,7 +365,7 @@ FLAG DESCRIPTIONS
365
365
  project, defaults to the current directory.
366
366
  ```
367
367
 
368
- _See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.0/src/commands/template/generate/digital-experience/site.ts)_
368
+ _See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.2/src/commands/template/generate/digital-experience/site.ts)_
369
369
 
370
370
  ## `sf template generate flexipage`
371
371
 
@@ -447,7 +447,7 @@ FLAG DESCRIPTIONS
447
447
  'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.
448
448
  ```
449
449
 
450
- _See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.0/src/commands/template/generate/flexipage/index.ts)_
450
+ _See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.2/src/commands/template/generate/flexipage/index.ts)_
451
451
 
452
452
  ## `sf template generate lightning-out`
453
453
 
@@ -530,7 +530,7 @@ FLAG DESCRIPTIONS
530
530
  site to guest and authenticated users. After you deploy a CLWR app, link it to your site in Setup.
531
531
  ```
532
532
 
533
- _See code: [src/commands/template/generate/lightning-out/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.0/src/commands/template/generate/lightning-out/index.ts)_
533
+ _See code: [src/commands/template/generate/lightning-out/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.2/src/commands/template/generate/lightning-out/index.ts)_
534
534
 
535
535
  ## `sf template generate lightning app`
536
536
 
@@ -588,7 +588,7 @@ FLAG DESCRIPTIONS
588
588
  field in the DX project's "sfdx-project.json" file.
589
589
  ```
590
590
 
591
- _See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.0/src/commands/template/generate/lightning/app.ts)_
591
+ _See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.2/src/commands/template/generate/lightning/app.ts)_
592
592
 
593
593
  ## `sf template generate lightning component`
594
594
 
@@ -665,7 +665,7 @@ FLAG DESCRIPTIONS
665
665
  field in the DX project's "sfdx-project.json" file.
666
666
  ```
667
667
 
668
- _See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.0/src/commands/template/generate/lightning/component.ts)_
668
+ _See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.2/src/commands/template/generate/lightning/component.ts)_
669
669
 
670
670
  ## `sf template generate lightning event`
671
671
 
@@ -723,7 +723,7 @@ FLAG DESCRIPTIONS
723
723
  field in the DX project's "sfdx-project.json" file.
724
724
  ```
725
725
 
726
- _See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.0/src/commands/template/generate/lightning/event.ts)_
726
+ _See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.2/src/commands/template/generate/lightning/event.ts)_
727
727
 
728
728
  ## `sf template generate lightning interface`
729
729
 
@@ -781,7 +781,7 @@ FLAG DESCRIPTIONS
781
781
  field in the DX project's "sfdx-project.json" file.
782
782
  ```
783
783
 
784
- _See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.0/src/commands/template/generate/lightning/interface.ts)_
784
+ _See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.2/src/commands/template/generate/lightning/interface.ts)_
785
785
 
786
786
  ## `sf template generate lightning test`
787
787
 
@@ -839,7 +839,7 @@ FLAG DESCRIPTIONS
839
839
  field in the DX project's "sfdx-project.json" file.
840
840
  ```
841
841
 
842
- _See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.0/src/commands/template/generate/lightning/test.ts)_
842
+ _See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.2/src/commands/template/generate/lightning/test.ts)_
843
843
 
844
844
  ## `sf template generate project`
845
845
 
@@ -971,7 +971,7 @@ FLAG DESCRIPTIONS
971
971
  server-side type stripping.
972
972
  ```
973
973
 
974
- _See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.0/src/commands/template/generate/project/index.ts)_
974
+ _See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.2/src/commands/template/generate/project/index.ts)_
975
975
 
976
976
  ## `sf template generate static-resource`
977
977
 
@@ -1034,7 +1034,7 @@ FLAG DESCRIPTIONS
1034
1034
  etc.
1035
1035
  ```
1036
1036
 
1037
- _See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.0/src/commands/template/generate/static-resource/index.ts)_
1037
+ _See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.2/src/commands/template/generate/static-resource/index.ts)_
1038
1038
 
1039
1039
  ## `sf template generate ui-bundle`
1040
1040
 
@@ -1129,7 +1129,7 @@ FLAG DESCRIPTIONS
1129
1129
  Supplied parameter values or default values are filled into a copy of the template.
1130
1130
  ```
1131
1131
 
1132
- _See code: [src/commands/template/generate/ui-bundle/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.0/src/commands/template/generate/ui-bundle/index.ts)_
1132
+ _See code: [src/commands/template/generate/ui-bundle/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.2/src/commands/template/generate/ui-bundle/index.ts)_
1133
1133
 
1134
1134
  ## `sf template generate ui-embedding`
1135
1135
 
@@ -1208,7 +1208,7 @@ FLAG DESCRIPTIONS
1208
1208
  (announced by screen readers).
1209
1209
  ```
1210
1210
 
1211
- _See code: [src/commands/template/generate/ui-embedding/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.0/src/commands/template/generate/ui-embedding/index.ts)_
1211
+ _See code: [src/commands/template/generate/ui-embedding/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.2/src/commands/template/generate/ui-embedding/index.ts)_
1212
1212
 
1213
1213
  ## `sf template generate visualforce component`
1214
1214
 
@@ -1265,7 +1265,7 @@ FLAG DESCRIPTIONS
1265
1265
  Supplied parameter values or default values are filled into a copy of the template.
1266
1266
  ```
1267
1267
 
1268
- _See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.0/src/commands/template/generate/visualforce/component.ts)_
1268
+ _See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.2/src/commands/template/generate/visualforce/component.ts)_
1269
1269
 
1270
1270
  ## `sf template generate visualforce page`
1271
1271
 
@@ -1316,6 +1316,6 @@ FLAG DESCRIPTIONS
1316
1316
  The name can be up to 40 characters and must start with a letter.
1317
1317
  ```
1318
1318
 
1319
- _See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.0/src/commands/template/generate/visualforce/page.ts)_
1319
+ _See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/57.5.2/src/commands/template/generate/visualforce/page.ts)_
1320
1320
 
1321
1321
  <!-- commandsstop -->
@@ -841,149 +841,6 @@
841
841
  "flexipage:generate:template"
842
842
  ]
843
843
  },
844
- "template:generate:lightning-out": {
845
- "aliases": [],
846
- "args": {},
847
- "description": "Lightning Out 2.0 lets you embed custom Lightning web components (LWCs) into your external, non-Salesforce apps.\n\nThis command gets you started by generating the seven metadata artifact types that a Lightning Out 2.0 app requires into your Salesforce DX project: LightningOutApp, MyDomain and Security settings, one CorsWhitelistOrigin per host domain, and the three External Client Application OAuth components (ExternalClientApplication, ExtlClntAppGlobalOauthSettings, ExtlClntAppOauthSettings). The command only generates files. It doesn't deploy any metadata to an org.\n\nInputs can come from a --definition-file JSON, individual flags, or both. Flag values take precedence over the file on a per-key basis. The command validates the types of definition-file fields; the underlying generator performs the remaining structural validation, such as required fields and formats.",
848
- "examples": [
849
- "Generate a Lightning Out 2.0 app using individual flags to specify the values:\n<%= config.bin %> <%= command.id %> --app-name MyLoApp --runtime LWR_CORE --host-domains https://example.com --eca-name MyLoAppEca --eca-contact-email dev@example.com --eca-callback-url https://example.com/cb",
850
- "Generate an app using the values in a JSON definition file called lo-def.json:\n<%= config.bin %> <%= command.id %> --definition-file lo-def.json",
851
- "Generate the app into a specific directory:\n<%= config.bin %> <%= command.id %> --definition-file lo-def.json --output-dir force-app/main/default",
852
- "Generate a CLWR app for an Experience Cloud site using a definition file:\n<%= config.bin %> <%= command.id %> --runtime CLWR --definition-file lo-def.json",
853
- "Generate the app using most of the values from a definition file, but the --host-domains value overrides its equivalent in the file:\n<%= config.bin %> <%= command.id %> --definition-file lo-def.json --host-domains https://staging.example.com"
854
- ],
855
- "flags": {
856
- "json": {
857
- "description": "Format output as json.",
858
- "helpGroup": "GLOBAL",
859
- "name": "json",
860
- "allowNo": false,
861
- "type": "boolean"
862
- },
863
- "flags-dir": {
864
- "helpGroup": "GLOBAL",
865
- "name": "flags-dir",
866
- "summary": "Import flag values from a directory.",
867
- "hasDynamicHelp": false,
868
- "multiple": false,
869
- "type": "option"
870
- },
871
- "app-name": {
872
- "name": "app-name",
873
- "required": false,
874
- "summary": "Developer name of the new Lightning Out 2.0 app.",
875
- "hasDynamicHelp": false,
876
- "multiple": false,
877
- "type": "option"
878
- },
879
- "eca-name": {
880
- "name": "eca-name",
881
- "required": false,
882
- "summary": "Developer name of the External Client Application associated with the app.",
883
- "hasDynamicHelp": false,
884
- "multiple": false,
885
- "type": "option"
886
- },
887
- "runtime": {
888
- "description": "LWR_CORE serves the app from your Salesforce org to authenticated users. CLWR serves it from an Experience Cloud site to guest and authenticated users. After you deploy a CLWR app, link it to your site in Setup.",
889
- "name": "runtime",
890
- "summary": "Runtime that serves the app.",
891
- "hasDynamicHelp": false,
892
- "multiple": false,
893
- "options": [
894
- "LWR_CORE",
895
- "CLWR"
896
- ],
897
- "type": "option"
898
- },
899
- "host-domains": {
900
- "name": "host-domains",
901
- "summary": "HTTP or HTTPS origin of an external host page that embeds the app. Repeat the flag to specify more than one. Replaces, rather than merges with, any hostDomains in the --definition-file. For CLWR apps, host domains are used only for CORS, which authenticated users need. Set up framing for the site in Experience Builder.",
902
- "hasDynamicHelp": false,
903
- "multiple": true,
904
- "type": "option"
905
- },
906
- "components": {
907
- "name": "components",
908
- "summary": "Name of a Lightning web component exposed by the app. Repeat the flag to specify more than one. Replaces, rather than merges with, any components in the --definition-file.",
909
- "hasDynamicHelp": false,
910
- "multiple": true,
911
- "type": "option"
912
- },
913
- "eca-contact-email": {
914
- "name": "eca-contact-email",
915
- "summary": "Contact email for the External Client Application.",
916
- "hasDynamicHelp": false,
917
- "multiple": false,
918
- "type": "option"
919
- },
920
- "eca-callback-url": {
921
- "name": "eca-callback-url",
922
- "summary": "OAuth callback URL for the External Client Application.",
923
- "hasDynamicHelp": false,
924
- "multiple": false,
925
- "type": "option"
926
- },
927
- "definition-file": {
928
- "name": "definition-file",
929
- "summary": "Path to a JSON file describing the Lightning Out 2.0 app. Individual flags, when supplied, override the corresponding value in this file.",
930
- "hasDynamicHelp": false,
931
- "multiple": false,
932
- "type": "option"
933
- },
934
- "output-dir": {
935
- "aliases": [
936
- "outputdir"
937
- ],
938
- "char": "d",
939
- "deprecateAliases": true,
940
- "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
941
- "name": "output-dir",
942
- "summary": "Directory for saving the created files.",
943
- "default": ".",
944
- "hasDynamicHelp": false,
945
- "multiple": false,
946
- "type": "option"
947
- },
948
- "loglevel": {
949
- "deprecated": {
950
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SF_LOG_LEVEL` environment variable."
951
- },
952
- "hidden": true,
953
- "name": "loglevel",
954
- "hasDynamicHelp": false,
955
- "multiple": false,
956
- "type": "option"
957
- }
958
- },
959
- "hasDynamicHelp": false,
960
- "hiddenAliases": [],
961
- "id": "template:generate:lightning-out",
962
- "pluginAlias": "@salesforce/plugin-templates",
963
- "pluginName": "@salesforce/plugin-templates",
964
- "pluginType": "core",
965
- "strict": true,
966
- "summary": "Generate the required metadata to scaffold a Lightning Out 2.0 app.",
967
- "enableJsonFlag": true,
968
- "isESM": true,
969
- "relativePath": [
970
- "lib",
971
- "commands",
972
- "template",
973
- "generate",
974
- "lightning-out",
975
- "index.js"
976
- ],
977
- "aliasPermutations": [],
978
- "permutations": [
979
- "template:generate:lightning-out",
980
- "generate:template:lightning-out",
981
- "generate:lightning-out:template",
982
- "template:lightning-out:generate",
983
- "lightning-out:template:generate",
984
- "lightning-out:generate:template"
985
- ]
986
- },
987
844
  "template:generate:lightning:app": {
988
845
  "aliases": [
989
846
  "force:lightning:app:create",
@@ -1882,6 +1739,149 @@
1882
1739
  "test:lightning:generate:template"
1883
1740
  ]
1884
1741
  },
1742
+ "template:generate:lightning-out": {
1743
+ "aliases": [],
1744
+ "args": {},
1745
+ "description": "Lightning Out 2.0 lets you embed custom Lightning web components (LWCs) into your external, non-Salesforce apps.\n\nThis command gets you started by generating the seven metadata artifact types that a Lightning Out 2.0 app requires into your Salesforce DX project: LightningOutApp, MyDomain and Security settings, one CorsWhitelistOrigin per host domain, and the three External Client Application OAuth components (ExternalClientApplication, ExtlClntAppGlobalOauthSettings, ExtlClntAppOauthSettings). The command only generates files. It doesn't deploy any metadata to an org.\n\nInputs can come from a --definition-file JSON, individual flags, or both. Flag values take precedence over the file on a per-key basis. The command validates the types of definition-file fields; the underlying generator performs the remaining structural validation, such as required fields and formats.",
1746
+ "examples": [
1747
+ "Generate a Lightning Out 2.0 app using individual flags to specify the values:\n<%= config.bin %> <%= command.id %> --app-name MyLoApp --runtime LWR_CORE --host-domains https://example.com --eca-name MyLoAppEca --eca-contact-email dev@example.com --eca-callback-url https://example.com/cb",
1748
+ "Generate an app using the values in a JSON definition file called lo-def.json:\n<%= config.bin %> <%= command.id %> --definition-file lo-def.json",
1749
+ "Generate the app into a specific directory:\n<%= config.bin %> <%= command.id %> --definition-file lo-def.json --output-dir force-app/main/default",
1750
+ "Generate a CLWR app for an Experience Cloud site using a definition file:\n<%= config.bin %> <%= command.id %> --runtime CLWR --definition-file lo-def.json",
1751
+ "Generate the app using most of the values from a definition file, but the --host-domains value overrides its equivalent in the file:\n<%= config.bin %> <%= command.id %> --definition-file lo-def.json --host-domains https://staging.example.com"
1752
+ ],
1753
+ "flags": {
1754
+ "json": {
1755
+ "description": "Format output as json.",
1756
+ "helpGroup": "GLOBAL",
1757
+ "name": "json",
1758
+ "allowNo": false,
1759
+ "type": "boolean"
1760
+ },
1761
+ "flags-dir": {
1762
+ "helpGroup": "GLOBAL",
1763
+ "name": "flags-dir",
1764
+ "summary": "Import flag values from a directory.",
1765
+ "hasDynamicHelp": false,
1766
+ "multiple": false,
1767
+ "type": "option"
1768
+ },
1769
+ "app-name": {
1770
+ "name": "app-name",
1771
+ "required": false,
1772
+ "summary": "Developer name of the new Lightning Out 2.0 app.",
1773
+ "hasDynamicHelp": false,
1774
+ "multiple": false,
1775
+ "type": "option"
1776
+ },
1777
+ "eca-name": {
1778
+ "name": "eca-name",
1779
+ "required": false,
1780
+ "summary": "Developer name of the External Client Application associated with the app.",
1781
+ "hasDynamicHelp": false,
1782
+ "multiple": false,
1783
+ "type": "option"
1784
+ },
1785
+ "runtime": {
1786
+ "description": "LWR_CORE serves the app from your Salesforce org to authenticated users. CLWR serves it from an Experience Cloud site to guest and authenticated users. After you deploy a CLWR app, link it to your site in Setup.",
1787
+ "name": "runtime",
1788
+ "summary": "Runtime that serves the app.",
1789
+ "hasDynamicHelp": false,
1790
+ "multiple": false,
1791
+ "options": [
1792
+ "LWR_CORE",
1793
+ "CLWR"
1794
+ ],
1795
+ "type": "option"
1796
+ },
1797
+ "host-domains": {
1798
+ "name": "host-domains",
1799
+ "summary": "HTTP or HTTPS origin of an external host page that embeds the app. Repeat the flag to specify more than one. Replaces, rather than merges with, any hostDomains in the --definition-file. For CLWR apps, host domains are used only for CORS, which authenticated users need. Set up framing for the site in Experience Builder.",
1800
+ "hasDynamicHelp": false,
1801
+ "multiple": true,
1802
+ "type": "option"
1803
+ },
1804
+ "components": {
1805
+ "name": "components",
1806
+ "summary": "Name of a Lightning web component exposed by the app. Repeat the flag to specify more than one. Replaces, rather than merges with, any components in the --definition-file.",
1807
+ "hasDynamicHelp": false,
1808
+ "multiple": true,
1809
+ "type": "option"
1810
+ },
1811
+ "eca-contact-email": {
1812
+ "name": "eca-contact-email",
1813
+ "summary": "Contact email for the External Client Application.",
1814
+ "hasDynamicHelp": false,
1815
+ "multiple": false,
1816
+ "type": "option"
1817
+ },
1818
+ "eca-callback-url": {
1819
+ "name": "eca-callback-url",
1820
+ "summary": "OAuth callback URL for the External Client Application.",
1821
+ "hasDynamicHelp": false,
1822
+ "multiple": false,
1823
+ "type": "option"
1824
+ },
1825
+ "definition-file": {
1826
+ "name": "definition-file",
1827
+ "summary": "Path to a JSON file describing the Lightning Out 2.0 app. Individual flags, when supplied, override the corresponding value in this file.",
1828
+ "hasDynamicHelp": false,
1829
+ "multiple": false,
1830
+ "type": "option"
1831
+ },
1832
+ "output-dir": {
1833
+ "aliases": [
1834
+ "outputdir"
1835
+ ],
1836
+ "char": "d",
1837
+ "deprecateAliases": true,
1838
+ "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
1839
+ "name": "output-dir",
1840
+ "summary": "Directory for saving the created files.",
1841
+ "default": ".",
1842
+ "hasDynamicHelp": false,
1843
+ "multiple": false,
1844
+ "type": "option"
1845
+ },
1846
+ "loglevel": {
1847
+ "deprecated": {
1848
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SF_LOG_LEVEL` environment variable."
1849
+ },
1850
+ "hidden": true,
1851
+ "name": "loglevel",
1852
+ "hasDynamicHelp": false,
1853
+ "multiple": false,
1854
+ "type": "option"
1855
+ }
1856
+ },
1857
+ "hasDynamicHelp": false,
1858
+ "hiddenAliases": [],
1859
+ "id": "template:generate:lightning-out",
1860
+ "pluginAlias": "@salesforce/plugin-templates",
1861
+ "pluginName": "@salesforce/plugin-templates",
1862
+ "pluginType": "core",
1863
+ "strict": true,
1864
+ "summary": "Generate the required metadata to scaffold a Lightning Out 2.0 app.",
1865
+ "enableJsonFlag": true,
1866
+ "isESM": true,
1867
+ "relativePath": [
1868
+ "lib",
1869
+ "commands",
1870
+ "template",
1871
+ "generate",
1872
+ "lightning-out",
1873
+ "index.js"
1874
+ ],
1875
+ "aliasPermutations": [],
1876
+ "permutations": [
1877
+ "template:generate:lightning-out",
1878
+ "generate:template:lightning-out",
1879
+ "generate:lightning-out:template",
1880
+ "template:lightning-out:generate",
1881
+ "lightning-out:template:generate",
1882
+ "lightning-out:generate:template"
1883
+ ]
1884
+ },
1885
1885
  "template:generate:project": {
1886
1886
  "aliases": [
1887
1887
  "force:project:create",
@@ -2075,16 +2075,18 @@
2075
2075
  "project:generate:template"
2076
2076
  ]
2077
2077
  },
2078
- "template:generate:ui-bundle": {
2079
- "aliases": [],
2078
+ "template:generate:static-resource": {
2079
+ "aliases": [
2080
+ "force:staticresource:create",
2081
+ "static-resource:generate"
2082
+ ],
2080
2083
  "args": {},
2081
- "description": "Salesforce provides native UI frameworks, such as Lighting Web Components (LWC), to build applications that run on the Salesforce Platform. But you can also use non-native JavaScript- or TypeScript-based UI frameworks, such as React, to build a UI experience for the Salesforce Platform and that you can launch from the App Launcher.\n\nThese non-native UI experiences are defined by the \"UIBundle\" metadata type in your DX project. Use this command to generate the required DX project structure and files. For example, when you run this command and specify the name MyUiBundle, then the files are generated into a \"uiBundles/MyUiBundle\" directory. Use the --output-dir flag to specify a different directory.\n\nUse the --template flag for generating the files to get started with a specific UI framework, such as React or Angular. Check out the README.md file in the generated \"uiBundles/<bundlename>\" directory for more information about the template.",
2084
+ "deprecateAliases": true,
2085
+ "description": "Generates the metadata resource file in the specified directory or the current working directory. Static resource files must be contained in a parent directory called \"staticresources\" in your package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to create one or point to an existing one.",
2082
2086
  "examples": [
2083
- "Generate a UI bundle called MyUiBundle in the current directory:\n<%= config.bin %> <%= command.id %> --name MyUiBundle",
2084
- "Generate a React-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic",
2085
- "Generate an Angular-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyAngularApp --template angularbasic",
2086
- "Generate a Vue-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyVueApp --template vuebasic",
2087
- "Generate the React-based UI bundle in the \"force-app/main/default/uiBundles\" directory:\n<%= config.bin %> <%= command.id %> --name MyUiBundle --template reactbasic --output-dir force-app/main/default/uiBundles"
2087
+ "Generate the metadata file for a static resource called MyResource in the current directory:\n<%= config.bin %> <%= command.id %> --name MyResource",
2088
+ "Similar to previous example, but specifies a MIME type of application/json:\n<%= config.bin %> <%= command.id %> --name MyResource --type application/json",
2089
+ "Generate the resource file in the \"force-app/main/default/staticresources\" directory:\n<%= config.bin %> <%= command.id %> --name MyResource --output-dir force-app/main/default/staticresources"
2088
2090
  ],
2089
2091
  "flags": {
2090
2092
  "json": {
@@ -2103,65 +2105,76 @@
2103
2105
  "type": "option"
2104
2106
  },
2105
2107
  "name": {
2108
+ "aliases": [
2109
+ "resourcename"
2110
+ ],
2106
2111
  "char": "n",
2112
+ "deprecateAliases": true,
2107
2113
  "description": "This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.",
2108
2114
  "name": "name",
2109
2115
  "required": true,
2110
- "summary": "API name of the generated UI bundle.",
2116
+ "summary": "Name of the generated static resource.",
2111
2117
  "hasDynamicHelp": false,
2112
2118
  "multiple": false,
2113
2119
  "type": "option"
2114
2120
  },
2115
- "template": {
2116
- "char": "t",
2117
- "description": "Supplied parameter values or default values are filled into a copy of the template.",
2118
- "name": "template",
2119
- "summary": "Template to use when creating the files for a specific UI framework.",
2120
- "default": "default",
2121
- "hasDynamicHelp": false,
2122
- "multiple": false,
2123
- "options": [
2124
- "default",
2125
- "reactbasic",
2126
- "angularbasic",
2127
- "vuebasic"
2121
+ "type": {
2122
+ "aliases": [
2123
+ "contenttype"
2128
2124
  ],
2129
- "type": "option"
2130
- },
2131
- "label": {
2132
- "char": "l",
2133
- "description": "If not specified, the label is derived from the name.",
2134
- "name": "label",
2135
- "summary": "Master label for the UI bundle.",
2125
+ "deprecateAliases": true,
2126
+ "description": "Must be a valid MIME type such as application/json, application/javascript, application/zip, text/plain, text/css, etc.",
2127
+ "name": "type",
2128
+ "summary": "Content type (mime type) of the generated static resource.",
2129
+ "default": "application/zip",
2136
2130
  "hasDynamicHelp": false,
2137
2131
  "multiple": false,
2138
2132
  "type": "option"
2139
2133
  },
2140
2134
  "output-dir": {
2135
+ "aliases": [
2136
+ "outputdir"
2137
+ ],
2141
2138
  "char": "d",
2142
- "description": "The location can be an absolute path or relative to the current working directory.\n\nIf not specified, the command reads your sfdx-project.json and defaults to \"uiBundles\" directory within your default package directory. When running outside a Salesforce DX project, defaults to the current directory.\n\n**Important:** This command automatically ensures the output directory ends with \"uiBundles\". If your specified path doesn't end with \"uiBundles\", it's automatically appended. The UI bundle is created at \"<output-dir>/<name>\".\n\n**Examples:**\n\n- \"--output-dir force-app/main/default\" → Creates a UI bundle at \"force-app/main/default/uiBundles/MyUiBundle/\"\n- \"--output-dir force-app/main/default/uiBundles\" → Creates a UI bundle at \"force-app/main/default/uiBundles/MyUiBundle/\" (no change)",
2139
+ "deprecateAliases": true,
2140
+ "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
2143
2141
  "name": "output-dir",
2144
- "summary": "Directory into which the files are created.",
2142
+ "summary": "Directory for saving the created files.",
2143
+ "default": ".",
2145
2144
  "hasDynamicHelp": false,
2146
2145
  "multiple": false,
2147
2146
  "type": "option"
2148
2147
  },
2149
2148
  "api-version": {
2149
+ "aliases": [
2150
+ "apiversion"
2151
+ ],
2152
+ "deprecateAliases": true,
2150
2153
  "description": "Override the api version used for api requests made by this command",
2151
2154
  "name": "api-version",
2152
2155
  "hasDynamicHelp": false,
2153
2156
  "multiple": false,
2154
2157
  "type": "option"
2158
+ },
2159
+ "loglevel": {
2160
+ "deprecated": {
2161
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SF_LOG_LEVEL` environment variable."
2162
+ },
2163
+ "hidden": true,
2164
+ "name": "loglevel",
2165
+ "hasDynamicHelp": false,
2166
+ "multiple": false,
2167
+ "type": "option"
2155
2168
  }
2156
2169
  },
2157
2170
  "hasDynamicHelp": false,
2158
2171
  "hiddenAliases": [],
2159
- "id": "template:generate:ui-bundle",
2172
+ "id": "template:generate:static-resource",
2160
2173
  "pluginAlias": "@salesforce/plugin-templates",
2161
2174
  "pluginName": "@salesforce/plugin-templates",
2162
2175
  "pluginType": "core",
2163
2176
  "strict": true,
2164
- "summary": "Generate a UI bundle, which contains the code and metadata to build a UI experience that uses non-native Salesforce frameworks, such as React or Angular.",
2177
+ "summary": "Generate a static resource.",
2165
2178
  "enableJsonFlag": true,
2166
2179
  "isESM": true,
2167
2180
  "relativePath": [
@@ -2169,31 +2182,38 @@
2169
2182
  "commands",
2170
2183
  "template",
2171
2184
  "generate",
2172
- "ui-bundle",
2185
+ "static-resource",
2173
2186
  "index.js"
2174
2187
  ],
2175
- "aliasPermutations": [],
2188
+ "aliasPermutations": [
2189
+ "force:staticresource:create",
2190
+ "staticresource:force:create",
2191
+ "staticresource:create:force",
2192
+ "force:create:staticresource",
2193
+ "create:force:staticresource",
2194
+ "create:staticresource:force",
2195
+ "static-resource:generate",
2196
+ "generate:static-resource"
2197
+ ],
2176
2198
  "permutations": [
2177
- "template:generate:ui-bundle",
2178
- "generate:template:ui-bundle",
2179
- "generate:ui-bundle:template",
2180
- "template:ui-bundle:generate",
2181
- "ui-bundle:template:generate",
2182
- "ui-bundle:generate:template"
2199
+ "template:generate:static-resource",
2200
+ "generate:template:static-resource",
2201
+ "generate:static-resource:template",
2202
+ "template:static-resource:generate",
2203
+ "static-resource:template:generate",
2204
+ "static-resource:generate:template"
2183
2205
  ]
2184
2206
  },
2185
- "template:generate:static-resource": {
2186
- "aliases": [
2187
- "force:staticresource:create",
2188
- "static-resource:generate"
2189
- ],
2207
+ "template:generate:ui-bundle": {
2208
+ "aliases": [],
2190
2209
  "args": {},
2191
- "deprecateAliases": true,
2192
- "description": "Generates the metadata resource file in the specified directory or the current working directory. Static resource files must be contained in a parent directory called \"staticresources\" in your package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to create one or point to an existing one.",
2210
+ "description": "Salesforce provides native UI frameworks, such as Lighting Web Components (LWC), to build applications that run on the Salesforce Platform. But you can also use non-native JavaScript- or TypeScript-based UI frameworks, such as React, to build a UI experience for the Salesforce Platform and that you can launch from the App Launcher.\n\nThese non-native UI experiences are defined by the \"UIBundle\" metadata type in your DX project. Use this command to generate the required DX project structure and files. For example, when you run this command and specify the name MyUiBundle, then the files are generated into a \"uiBundles/MyUiBundle\" directory. Use the --output-dir flag to specify a different directory.\n\nUse the --template flag for generating the files to get started with a specific UI framework, such as React or Angular. Check out the README.md file in the generated \"uiBundles/<bundlename>\" directory for more information about the template.",
2193
2211
  "examples": [
2194
- "Generate the metadata file for a static resource called MyResource in the current directory:\n<%= config.bin %> <%= command.id %> --name MyResource",
2195
- "Similar to previous example, but specifies a MIME type of application/json:\n<%= config.bin %> <%= command.id %> --name MyResource --type application/json",
2196
- "Generate the resource file in the \"force-app/main/default/staticresources\" directory:\n<%= config.bin %> <%= command.id %> --name MyResource --output-dir force-app/main/default/staticresources"
2212
+ "Generate a UI bundle called MyUiBundle in the current directory:\n<%= config.bin %> <%= command.id %> --name MyUiBundle",
2213
+ "Generate a React-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic",
2214
+ "Generate an Angular-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyAngularApp --template angularbasic",
2215
+ "Generate a Vue-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyVueApp --template vuebasic",
2216
+ "Generate the React-based UI bundle in the \"force-app/main/default/uiBundles\" directory:\n<%= config.bin %> <%= command.id %> --name MyUiBundle --template reactbasic --output-dir force-app/main/default/uiBundles"
2197
2217
  ],
2198
2218
  "flags": {
2199
2219
  "json": {
@@ -2212,76 +2232,65 @@
2212
2232
  "type": "option"
2213
2233
  },
2214
2234
  "name": {
2215
- "aliases": [
2216
- "resourcename"
2217
- ],
2218
2235
  "char": "n",
2219
- "deprecateAliases": true,
2220
2236
  "description": "This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.",
2221
2237
  "name": "name",
2222
2238
  "required": true,
2223
- "summary": "Name of the generated static resource.",
2239
+ "summary": "API name of the generated UI bundle.",
2224
2240
  "hasDynamicHelp": false,
2225
2241
  "multiple": false,
2226
2242
  "type": "option"
2227
2243
  },
2228
- "type": {
2229
- "aliases": [
2230
- "contenttype"
2244
+ "template": {
2245
+ "char": "t",
2246
+ "description": "Supplied parameter values or default values are filled into a copy of the template.",
2247
+ "name": "template",
2248
+ "summary": "Template to use when creating the files for a specific UI framework.",
2249
+ "default": "default",
2250
+ "hasDynamicHelp": false,
2251
+ "multiple": false,
2252
+ "options": [
2253
+ "default",
2254
+ "reactbasic",
2255
+ "angularbasic",
2256
+ "vuebasic"
2231
2257
  ],
2232
- "deprecateAliases": true,
2233
- "description": "Must be a valid MIME type such as application/json, application/javascript, application/zip, text/plain, text/css, etc.",
2234
- "name": "type",
2235
- "summary": "Content type (mime type) of the generated static resource.",
2236
- "default": "application/zip",
2258
+ "type": "option"
2259
+ },
2260
+ "label": {
2261
+ "char": "l",
2262
+ "description": "If not specified, the label is derived from the name.",
2263
+ "name": "label",
2264
+ "summary": "Master label for the UI bundle.",
2237
2265
  "hasDynamicHelp": false,
2238
2266
  "multiple": false,
2239
2267
  "type": "option"
2240
2268
  },
2241
2269
  "output-dir": {
2242
- "aliases": [
2243
- "outputdir"
2244
- ],
2245
2270
  "char": "d",
2246
- "deprecateAliases": true,
2247
- "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
2271
+ "description": "The location can be an absolute path or relative to the current working directory.\n\nIf not specified, the command reads your sfdx-project.json and defaults to \"uiBundles\" directory within your default package directory. When running outside a Salesforce DX project, defaults to the current directory.\n\n**Important:** This command automatically ensures the output directory ends with \"uiBundles\". If your specified path doesn't end with \"uiBundles\", it's automatically appended. The UI bundle is created at \"<output-dir>/<name>\".\n\n**Examples:**\n\n- \"--output-dir force-app/main/default\" → Creates a UI bundle at \"force-app/main/default/uiBundles/MyUiBundle/\"\n- \"--output-dir force-app/main/default/uiBundles\" → Creates a UI bundle at \"force-app/main/default/uiBundles/MyUiBundle/\" (no change)",
2248
2272
  "name": "output-dir",
2249
- "summary": "Directory for saving the created files.",
2250
- "default": ".",
2273
+ "summary": "Directory into which the files are created.",
2251
2274
  "hasDynamicHelp": false,
2252
2275
  "multiple": false,
2253
2276
  "type": "option"
2254
2277
  },
2255
2278
  "api-version": {
2256
- "aliases": [
2257
- "apiversion"
2258
- ],
2259
- "deprecateAliases": true,
2260
2279
  "description": "Override the api version used for api requests made by this command",
2261
2280
  "name": "api-version",
2262
2281
  "hasDynamicHelp": false,
2263
2282
  "multiple": false,
2264
2283
  "type": "option"
2265
- },
2266
- "loglevel": {
2267
- "deprecated": {
2268
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SF_LOG_LEVEL` environment variable."
2269
- },
2270
- "hidden": true,
2271
- "name": "loglevel",
2272
- "hasDynamicHelp": false,
2273
- "multiple": false,
2274
- "type": "option"
2275
2284
  }
2276
2285
  },
2277
2286
  "hasDynamicHelp": false,
2278
2287
  "hiddenAliases": [],
2279
- "id": "template:generate:static-resource",
2288
+ "id": "template:generate:ui-bundle",
2280
2289
  "pluginAlias": "@salesforce/plugin-templates",
2281
2290
  "pluginName": "@salesforce/plugin-templates",
2282
2291
  "pluginType": "core",
2283
2292
  "strict": true,
2284
- "summary": "Generate a static resource.",
2293
+ "summary": "Generate a UI bundle, which contains the code and metadata to build a UI experience that uses non-native Salesforce frameworks, such as React or Angular.",
2285
2294
  "enableJsonFlag": true,
2286
2295
  "isESM": true,
2287
2296
  "relativePath": [
@@ -2289,26 +2298,17 @@
2289
2298
  "commands",
2290
2299
  "template",
2291
2300
  "generate",
2292
- "static-resource",
2301
+ "ui-bundle",
2293
2302
  "index.js"
2294
2303
  ],
2295
- "aliasPermutations": [
2296
- "force:staticresource:create",
2297
- "staticresource:force:create",
2298
- "staticresource:create:force",
2299
- "force:create:staticresource",
2300
- "create:force:staticresource",
2301
- "create:staticresource:force",
2302
- "static-resource:generate",
2303
- "generate:static-resource"
2304
- ],
2304
+ "aliasPermutations": [],
2305
2305
  "permutations": [
2306
- "template:generate:static-resource",
2307
- "generate:template:static-resource",
2308
- "generate:static-resource:template",
2309
- "template:static-resource:generate",
2310
- "static-resource:template:generate",
2311
- "static-resource:generate:template"
2306
+ "template:generate:ui-bundle",
2307
+ "generate:template:ui-bundle",
2308
+ "generate:ui-bundle:template",
2309
+ "template:ui-bundle:generate",
2310
+ "ui-bundle:template:generate",
2311
+ "ui-bundle:generate:template"
2312
2312
  ]
2313
2313
  },
2314
2314
  "template:generate:ui-embedding": {
@@ -2815,5 +2815,5 @@
2815
2815
  ]
2816
2816
  }
2817
2817
  },
2818
- "version": "57.5.0"
2818
+ "version": "57.5.2"
2819
2819
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-templates",
3
3
  "description": "Commands to create metadata from a default or custom template",
4
- "version": "57.5.0",
4
+ "version": "57.5.2",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/salesforcecli/plugin-templates/issues",
7
7
  "enableO11y": true,
@@ -9,21 +9,21 @@
9
9
  "dependencies": {
10
10
  "@salesforce/core": "^9.2.0",
11
11
  "@salesforce/sf-plugins-core": "^13.0.7",
12
- "@salesforce/templates": "^66.17.2"
12
+ "@salesforce/templates": "^66.17.4"
13
13
  },
14
14
  "devDependencies": {
15
15
  "@oclif/plugin-command-snapshot": "^6.0.6",
16
- "@salesforce/cli-plugins-testkit": "^5.3.76",
16
+ "@salesforce/cli-plugins-testkit": "^5.3.81",
17
17
  "@salesforce/dev-scripts": "^15.0.0",
18
- "@salesforce/plugin-command-reference": "^3.1.142",
18
+ "@salesforce/plugin-command-reference": "^3.1.147",
19
19
  "@types/chai": "^4.3.17",
20
20
  "@types/mocha": "^10.0.10",
21
21
  "@types/node": "^18",
22
22
  "@types/sinon": "^10.0.20",
23
23
  "@types/yeoman-assert": "^3.1.4",
24
- "eslint": "^10.12.0",
24
+ "eslint": "^10.13.0",
25
25
  "eslint-config-salesforce-typescript": "^7.0.1",
26
- "eslint-plugin-sf-plugin": "^3.0.1",
26
+ "eslint-plugin-sf-plugin": "^3.0.4",
27
27
  "oclif": "^5.0.2",
28
28
  "ts-node": "^10.9.2",
29
29
  "typescript": "^6.0.0",
@@ -259,7 +259,7 @@
259
259
  "exports": "./lib/index.js",
260
260
  "type": "module",
261
261
  "sfdx": {
262
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/57.5.0.crt",
263
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/57.5.0.sig"
262
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/57.5.2.crt",
263
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/57.5.2.sig"
264
264
  }
265
265
  }