@salesforce/plugin-templates 57.6.0 → 57.6.1
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 +29 -41
- package/oclif.manifest.json +144 -144
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -7,15 +7,15 @@ This repository provides a series of commands, templates, and generators for var
|
|
|
7
7
|
|
|
8
8
|
# Getting Started
|
|
9
9
|
|
|
10
|
-
To use, install the [Salesforce CLI](https://developer.salesforce.com/tools/
|
|
10
|
+
To use, install the [Salesforce CLI](https://developer.salesforce.com/tools/salesforcecli) and run the following commands.
|
|
11
11
|
|
|
12
12
|
```
|
|
13
13
|
Verify the CLI is installed
|
|
14
|
-
$
|
|
14
|
+
$ sf (-v | --version)
|
|
15
15
|
Install the @salesforce/plugin-templates plugin
|
|
16
|
-
$
|
|
16
|
+
$ sf plugins install @salesforce/plugin-templates
|
|
17
17
|
To run a command
|
|
18
|
-
$
|
|
18
|
+
$ sf [command]
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
## Install
|
|
@@ -29,8 +29,7 @@ git clone git@github.com:salesforcecli/plugin-templates.git
|
|
|
29
29
|
2. Ensure you have [Yarn](https://yarnpkg.com/) installed and run the following to build:
|
|
30
30
|
|
|
31
31
|
```
|
|
32
|
-
yarn
|
|
33
|
-
yarn build
|
|
32
|
+
yarn && yarn build
|
|
34
33
|
```
|
|
35
34
|
|
|
36
35
|
## Issues
|
|
@@ -39,18 +38,7 @@ Please report any issues to https://github.com/salesforcecli/plugin-templates/is
|
|
|
39
38
|
|
|
40
39
|
## Contributing
|
|
41
40
|
|
|
42
|
-
|
|
43
|
-
- If you're adding a new template generator, see the [Development Guide](./DEVELOPMENT.md) for detailed instructions.
|
|
44
|
-
1. Create a new issue before starting your project so that we can keep track of
|
|
45
|
-
what you're trying to add/fix. That way, we can also offer suggestions or
|
|
46
|
-
let you know if there is already an effort in progress.
|
|
47
|
-
1. Fork this repository.
|
|
48
|
-
1. The [build](#build) section has details on how to set up your environment.
|
|
49
|
-
1. Create a _topic_ branch in your fork based on the correct branch (usually the **main** branch). Note: this step is recommended but technically not required if contributing using a fork.
|
|
50
|
-
1. Edit the code in your fork.
|
|
51
|
-
1. Sign CLA (see [CLA](#cla)).
|
|
52
|
-
1. Send us a pull request when you're done. We'll review your code, suggest any
|
|
53
|
-
needed changes, and merge it in.
|
|
41
|
+
If you're interested in contributing, take a look at the [CONTRIBUTING](CONTRIBUTING.md) guide.
|
|
54
42
|
|
|
55
43
|
## Pull Requests
|
|
56
44
|
|
|
@@ -69,22 +57,22 @@ Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.
|
|
|
69
57
|
|
|
70
58
|
## Developing Plugin
|
|
71
59
|
|
|
72
|
-
To test plugin locally, use `bin/dev` in place of `
|
|
60
|
+
To test plugin locally, use `bin/dev.js` in place of `sf`. For example:
|
|
73
61
|
|
|
74
62
|
```sh
|
|
75
|
-
./bin/dev force:apex:class:create --classname 'TestClass' --template 'DefaultApexClass' --outputdir ./testsoutput/myApex/
|
|
63
|
+
./bin/dev.js force:apex:class:create --classname 'TestClass' --template 'DefaultApexClass' --outputdir ./testsoutput/myApex/
|
|
76
64
|
```
|
|
77
65
|
|
|
78
66
|
Link your plugin to Salesforce CLI:
|
|
79
67
|
|
|
80
68
|
```sh
|
|
81
|
-
|
|
69
|
+
sf plugins link .
|
|
82
70
|
```
|
|
83
71
|
|
|
84
72
|
Verify plugin is linked:
|
|
85
73
|
|
|
86
74
|
```sh
|
|
87
|
-
|
|
75
|
+
sf plugins
|
|
88
76
|
```
|
|
89
77
|
|
|
90
78
|
To test plugin locally with Salesforce CLI, add `"@salesforce/plugin-templates": "file://path/to/plugin-templates"` to the plugin's `package.json`.
|
|
@@ -98,13 +86,13 @@ To debug the `hello:org` command:
|
|
|
98
86
|
1. If you linked your plugin to the Salesforce CLI, call your command with the `dev-suspend` switch:
|
|
99
87
|
|
|
100
88
|
```sh-session
|
|
101
|
-
$
|
|
89
|
+
$ sf hello:org -u myOrg@example.com --dev-suspend
|
|
102
90
|
```
|
|
103
91
|
|
|
104
92
|
Alternatively, to call your command using the `bin/dev` script, set the `NODE_OPTIONS` environment variable to `--inspect-brk` when starting the debugger:
|
|
105
93
|
|
|
106
94
|
```sh-session
|
|
107
|
-
$ NODE_OPTIONS=--inspect-brk ./bin/dev force:apex:class:create --classname 'TestClass' --template 'DefaultApexClass' --outputdir ./testsoutput/myApex/
|
|
95
|
+
$ NODE_OPTIONS=--inspect-brk ./bin/dev.js force:apex:class:create --classname 'TestClass' --template 'DefaultApexClass' --outputdir ./testsoutput/myApex/
|
|
108
96
|
```
|
|
109
97
|
|
|
110
98
|
2. Set some breakpoints in your command code.
|
|
@@ -179,7 +167,7 @@ FLAG DESCRIPTIONS
|
|
|
179
167
|
directory.
|
|
180
168
|
```
|
|
181
169
|
|
|
182
|
-
_See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.
|
|
170
|
+
_See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/analytics/template.ts)_
|
|
183
171
|
|
|
184
172
|
## `sf template generate apex class`
|
|
185
173
|
|
|
@@ -241,7 +229,7 @@ FLAG DESCRIPTIONS
|
|
|
241
229
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
242
230
|
```
|
|
243
231
|
|
|
244
|
-
_See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.
|
|
232
|
+
_See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/apex/class.ts)_
|
|
245
233
|
|
|
246
234
|
## `sf template generate apex trigger`
|
|
247
235
|
|
|
@@ -311,7 +299,7 @@ FLAG DESCRIPTIONS
|
|
|
311
299
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
312
300
|
```
|
|
313
301
|
|
|
314
|
-
_See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.
|
|
302
|
+
_See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/apex/trigger.ts)_
|
|
315
303
|
|
|
316
304
|
## `sf template generate digital-experience site`
|
|
317
305
|
|
|
@@ -365,7 +353,7 @@ FLAG DESCRIPTIONS
|
|
|
365
353
|
project, defaults to the current directory.
|
|
366
354
|
```
|
|
367
355
|
|
|
368
|
-
_See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.
|
|
356
|
+
_See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/digital-experience/site.ts)_
|
|
369
357
|
|
|
370
358
|
## `sf template generate flexipage`
|
|
371
359
|
|
|
@@ -447,7 +435,7 @@ FLAG DESCRIPTIONS
|
|
|
447
435
|
'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.
|
|
448
436
|
```
|
|
449
437
|
|
|
450
|
-
_See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.
|
|
438
|
+
_See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/flexipage/index.ts)_
|
|
451
439
|
|
|
452
440
|
## `sf template generate lightning-out`
|
|
453
441
|
|
|
@@ -530,7 +518,7 @@ FLAG DESCRIPTIONS
|
|
|
530
518
|
site to guest and authenticated users. After you deploy a CLWR app, link it to your site in Setup.
|
|
531
519
|
```
|
|
532
520
|
|
|
533
|
-
_See code: [src/commands/template/generate/lightning-out/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.
|
|
521
|
+
_See code: [src/commands/template/generate/lightning-out/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/lightning-out/index.ts)_
|
|
534
522
|
|
|
535
523
|
## `sf template generate lightning app`
|
|
536
524
|
|
|
@@ -588,7 +576,7 @@ FLAG DESCRIPTIONS
|
|
|
588
576
|
field in the DX project's "sfdx-project.json" file.
|
|
589
577
|
```
|
|
590
578
|
|
|
591
|
-
_See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.
|
|
579
|
+
_See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/lightning/app.ts)_
|
|
592
580
|
|
|
593
581
|
## `sf template generate lightning component`
|
|
594
582
|
|
|
@@ -665,7 +653,7 @@ FLAG DESCRIPTIONS
|
|
|
665
653
|
field in the DX project's "sfdx-project.json" file.
|
|
666
654
|
```
|
|
667
655
|
|
|
668
|
-
_See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.
|
|
656
|
+
_See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/lightning/component.ts)_
|
|
669
657
|
|
|
670
658
|
## `sf template generate lightning event`
|
|
671
659
|
|
|
@@ -723,7 +711,7 @@ FLAG DESCRIPTIONS
|
|
|
723
711
|
field in the DX project's "sfdx-project.json" file.
|
|
724
712
|
```
|
|
725
713
|
|
|
726
|
-
_See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.
|
|
714
|
+
_See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/lightning/event.ts)_
|
|
727
715
|
|
|
728
716
|
## `sf template generate lightning interface`
|
|
729
717
|
|
|
@@ -781,7 +769,7 @@ FLAG DESCRIPTIONS
|
|
|
781
769
|
field in the DX project's "sfdx-project.json" file.
|
|
782
770
|
```
|
|
783
771
|
|
|
784
|
-
_See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.
|
|
772
|
+
_See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/lightning/interface.ts)_
|
|
785
773
|
|
|
786
774
|
## `sf template generate lightning test`
|
|
787
775
|
|
|
@@ -839,7 +827,7 @@ FLAG DESCRIPTIONS
|
|
|
839
827
|
field in the DX project's "sfdx-project.json" file.
|
|
840
828
|
```
|
|
841
829
|
|
|
842
|
-
_See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.
|
|
830
|
+
_See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/lightning/test.ts)_
|
|
843
831
|
|
|
844
832
|
## `sf template generate project`
|
|
845
833
|
|
|
@@ -973,7 +961,7 @@ FLAG DESCRIPTIONS
|
|
|
973
961
|
server-side type stripping.
|
|
974
962
|
```
|
|
975
963
|
|
|
976
|
-
_See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.
|
|
964
|
+
_See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/project/index.ts)_
|
|
977
965
|
|
|
978
966
|
## `sf template generate static-resource`
|
|
979
967
|
|
|
@@ -1036,7 +1024,7 @@ FLAG DESCRIPTIONS
|
|
|
1036
1024
|
etc.
|
|
1037
1025
|
```
|
|
1038
1026
|
|
|
1039
|
-
_See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.
|
|
1027
|
+
_See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/static-resource/index.ts)_
|
|
1040
1028
|
|
|
1041
1029
|
## `sf template generate ui-bundle`
|
|
1042
1030
|
|
|
@@ -1131,7 +1119,7 @@ FLAG DESCRIPTIONS
|
|
|
1131
1119
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
1132
1120
|
```
|
|
1133
1121
|
|
|
1134
|
-
_See code: [src/commands/template/generate/ui-bundle/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.
|
|
1122
|
+
_See code: [src/commands/template/generate/ui-bundle/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/ui-bundle/index.ts)_
|
|
1135
1123
|
|
|
1136
1124
|
## `sf template generate ui-embedding`
|
|
1137
1125
|
|
|
@@ -1210,7 +1198,7 @@ FLAG DESCRIPTIONS
|
|
|
1210
1198
|
(announced by screen readers).
|
|
1211
1199
|
```
|
|
1212
1200
|
|
|
1213
|
-
_See code: [src/commands/template/generate/ui-embedding/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.
|
|
1201
|
+
_See code: [src/commands/template/generate/ui-embedding/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/ui-embedding/index.ts)_
|
|
1214
1202
|
|
|
1215
1203
|
## `sf template generate visualforce component`
|
|
1216
1204
|
|
|
@@ -1267,7 +1255,7 @@ FLAG DESCRIPTIONS
|
|
|
1267
1255
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
1268
1256
|
```
|
|
1269
1257
|
|
|
1270
|
-
_See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.
|
|
1258
|
+
_See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/visualforce/component.ts)_
|
|
1271
1259
|
|
|
1272
1260
|
## `sf template generate visualforce page`
|
|
1273
1261
|
|
|
@@ -1318,6 +1306,6 @@ FLAG DESCRIPTIONS
|
|
|
1318
1306
|
The name can be up to 40 characters and must start with a letter.
|
|
1319
1307
|
```
|
|
1320
1308
|
|
|
1321
|
-
_See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.
|
|
1309
|
+
_See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/visualforce/page.ts)_
|
|
1322
1310
|
|
|
1323
1311
|
<!-- commandsstop -->
|
package/oclif.manifest.json
CHANGED
|
@@ -841,6 +841,149 @@
|
|
|
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
|
+
},
|
|
844
987
|
"template:generate:lightning:app": {
|
|
845
988
|
"aliases": [
|
|
846
989
|
"force:lightning:app:create",
|
|
@@ -1739,149 +1882,6 @@
|
|
|
1739
1882
|
"test:lightning:generate:template"
|
|
1740
1883
|
]
|
|
1741
1884
|
},
|
|
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",
|
|
@@ -2816,5 +2816,5 @@
|
|
|
2816
2816
|
]
|
|
2817
2817
|
}
|
|
2818
2818
|
},
|
|
2819
|
-
"version": "57.6.
|
|
2819
|
+
"version": "57.6.1"
|
|
2820
2820
|
}
|
package/package.json
CHANGED
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-templates",
|
|
3
3
|
"description": "Commands to create metadata from a default or custom template",
|
|
4
|
-
"version": "57.6.
|
|
4
|
+
"version": "57.6.1",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/salesforcecli/plugin-templates/issues",
|
|
7
7
|
"enableO11y": true,
|
|
8
8
|
"o11yUploadEndpoint": "https://794testsite.my.site.com/byolwr/webruntime/log/metrics",
|
|
9
9
|
"dependencies": {
|
|
10
10
|
"@salesforce/core": "^9.2.0",
|
|
11
|
-
"@salesforce/sf-plugins-core": "^13.0.
|
|
11
|
+
"@salesforce/sf-plugins-core": "^13.0.8",
|
|
12
12
|
"@salesforce/templates": "^66.19.0"
|
|
13
13
|
},
|
|
14
14
|
"devDependencies": {
|
|
15
|
-
"@oclif/plugin-command-snapshot": "^6.0.
|
|
16
|
-
"@salesforce/cli-plugins-testkit": "^5.3.
|
|
15
|
+
"@oclif/plugin-command-snapshot": "^6.0.7",
|
|
16
|
+
"@salesforce/cli-plugins-testkit": "^5.3.90",
|
|
17
17
|
"@salesforce/dev-scripts": "^15.0.0",
|
|
18
18
|
"@salesforce/plugin-command-reference": "^3.1.147",
|
|
19
19
|
"@types/chai": "^4.3.17",
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"@types/sinon": "^10.0.20",
|
|
23
23
|
"@types/yeoman-assert": "^3.1.4",
|
|
24
24
|
"eslint": "^10.13.0",
|
|
25
|
-
"eslint-config-salesforce-typescript": "^7.0.
|
|
25
|
+
"eslint-config-salesforce-typescript": "^7.0.6",
|
|
26
26
|
"eslint-plugin-sf-plugin": "^3.0.4",
|
|
27
27
|
"oclif": "^5.0.2",
|
|
28
28
|
"ts-node": "^10.9.2",
|
|
@@ -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.6.
|
|
263
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/57.6.
|
|
262
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/57.6.1.crt",
|
|
263
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/57.6.1.sig"
|
|
264
264
|
}
|
|
265
265
|
}
|