@salesforce/plugin-templates 57.0.2 → 57.0.4

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 +15 -15
  2. package/oclif.manifest.json +347 -347
  3. package/package.json +6 -6
package/README.md CHANGED
@@ -177,7 +177,7 @@ FLAG DESCRIPTIONS
177
177
  directory.
178
178
  ```
179
179
 
180
- _See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.2/src/commands/template/generate/analytics/template.ts)_
180
+ _See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.4/src/commands/template/generate/analytics/template.ts)_
181
181
 
182
182
  ## `sf template generate apex class`
183
183
 
@@ -239,7 +239,7 @@ FLAG DESCRIPTIONS
239
239
  Supplied parameter values or default values are filled into a copy of the template.
240
240
  ```
241
241
 
242
- _See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.2/src/commands/template/generate/apex/class.ts)_
242
+ _See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.4/src/commands/template/generate/apex/class.ts)_
243
243
 
244
244
  ## `sf template generate apex trigger`
245
245
 
@@ -309,7 +309,7 @@ FLAG DESCRIPTIONS
309
309
  Supplied parameter values or default values are filled into a copy of the template.
310
310
  ```
311
311
 
312
- _See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.2/src/commands/template/generate/apex/trigger.ts)_
312
+ _See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.4/src/commands/template/generate/apex/trigger.ts)_
313
313
 
314
314
  ## `sf template generate digital-experience site`
315
315
 
@@ -363,7 +363,7 @@ FLAG DESCRIPTIONS
363
363
  project, defaults to the current directory.
364
364
  ```
365
365
 
366
- _See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.2/src/commands/template/generate/digital-experience/site.ts)_
366
+ _See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.4/src/commands/template/generate/digital-experience/site.ts)_
367
367
 
368
368
  ## `sf template generate flexipage`
369
369
 
@@ -445,7 +445,7 @@ FLAG DESCRIPTIONS
445
445
  'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.
446
446
  ```
447
447
 
448
- _See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.2/src/commands/template/generate/flexipage/index.ts)_
448
+ _See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.4/src/commands/template/generate/flexipage/index.ts)_
449
449
 
450
450
  ## `sf template generate lightning app`
451
451
 
@@ -503,7 +503,7 @@ FLAG DESCRIPTIONS
503
503
  field in the DX project's "sfdx-project.json" file.
504
504
  ```
505
505
 
506
- _See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.2/src/commands/template/generate/lightning/app.ts)_
506
+ _See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.4/src/commands/template/generate/lightning/app.ts)_
507
507
 
508
508
  ## `sf template generate lightning component`
509
509
 
@@ -580,7 +580,7 @@ FLAG DESCRIPTIONS
580
580
  field in the DX project's "sfdx-project.json" file.
581
581
  ```
582
582
 
583
- _See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.2/src/commands/template/generate/lightning/component.ts)_
583
+ _See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.4/src/commands/template/generate/lightning/component.ts)_
584
584
 
585
585
  ## `sf template generate lightning event`
586
586
 
@@ -638,7 +638,7 @@ FLAG DESCRIPTIONS
638
638
  field in the DX project's "sfdx-project.json" file.
639
639
  ```
640
640
 
641
- _See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.2/src/commands/template/generate/lightning/event.ts)_
641
+ _See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.4/src/commands/template/generate/lightning/event.ts)_
642
642
 
643
643
  ## `sf template generate lightning interface`
644
644
 
@@ -696,7 +696,7 @@ FLAG DESCRIPTIONS
696
696
  field in the DX project's "sfdx-project.json" file.
697
697
  ```
698
698
 
699
- _See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.2/src/commands/template/generate/lightning/interface.ts)_
699
+ _See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.4/src/commands/template/generate/lightning/interface.ts)_
700
700
 
701
701
  ## `sf template generate lightning test`
702
702
 
@@ -754,7 +754,7 @@ FLAG DESCRIPTIONS
754
754
  field in the DX project's "sfdx-project.json" file.
755
755
  ```
756
756
 
757
- _See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.2/src/commands/template/generate/lightning/test.ts)_
757
+ _See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.4/src/commands/template/generate/lightning/test.ts)_
758
758
 
759
759
  ## `sf template generate project`
760
760
 
@@ -886,7 +886,7 @@ FLAG DESCRIPTIONS
886
886
  server-side type stripping.
887
887
  ```
888
888
 
889
- _See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.2/src/commands/template/generate/project/index.ts)_
889
+ _See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.4/src/commands/template/generate/project/index.ts)_
890
890
 
891
891
  ## `sf template generate static-resource`
892
892
 
@@ -949,7 +949,7 @@ FLAG DESCRIPTIONS
949
949
  etc.
950
950
  ```
951
951
 
952
- _See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.2/src/commands/template/generate/static-resource/index.ts)_
952
+ _See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.4/src/commands/template/generate/static-resource/index.ts)_
953
953
 
954
954
  ## `sf template generate ui-bundle`
955
955
 
@@ -1038,7 +1038,7 @@ FLAG DESCRIPTIONS
1038
1038
  Supplied parameter values or default values are filled into a copy of the template.
1039
1039
  ```
1040
1040
 
1041
- _See code: [src/commands/template/generate/ui-bundle/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.2/src/commands/template/generate/ui-bundle/index.ts)_
1041
+ _See code: [src/commands/template/generate/ui-bundle/index.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.4/src/commands/template/generate/ui-bundle/index.ts)_
1042
1042
 
1043
1043
  ## `sf template generate visualforce component`
1044
1044
 
@@ -1095,7 +1095,7 @@ FLAG DESCRIPTIONS
1095
1095
  Supplied parameter values or default values are filled into a copy of the template.
1096
1096
  ```
1097
1097
 
1098
- _See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.2/src/commands/template/generate/visualforce/component.ts)_
1098
+ _See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.4/src/commands/template/generate/visualforce/component.ts)_
1099
1099
 
1100
1100
  ## `sf template generate visualforce page`
1101
1101
 
@@ -1146,6 +1146,6 @@ FLAG DESCRIPTIONS
1146
1146
  The name can be up to 40 characters and must start with a letter.
1147
1147
  ```
1148
1148
 
1149
- _See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.2/src/commands/template/generate/visualforce/page.ts)_
1149
+ _See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/57.0.4/src/commands/template/generate/visualforce/page.ts)_
1150
1150
 
1151
1151
  <!-- commandsstop -->
@@ -1,5 +1,158 @@
1
1
  {
2
2
  "commands": {
3
+ "template:generate:analytics:template": {
4
+ "aliases": [
5
+ "force:analytics:template:create",
6
+ "analytics:generate:template"
7
+ ],
8
+ "args": {},
9
+ "deprecateAliases": true,
10
+ "description": "The metadata files associated with the Analytics template must be contained in a parent directory called \"waveTemplates\" in your package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to generate one or point to an existing one.",
11
+ "examples": [
12
+ "Generate the metadata files for a simple Analytics template file called myTemplate in the force-app/main/default/waveTemplates directory:\n<%= config.bin %> <%= command.id %> --name myTemplate --output-dir force-app/main/default/waveTemplates"
13
+ ],
14
+ "flags": {
15
+ "json": {
16
+ "description": "Format output as json.",
17
+ "helpGroup": "GLOBAL",
18
+ "name": "json",
19
+ "allowNo": false,
20
+ "type": "boolean"
21
+ },
22
+ "flags-dir": {
23
+ "helpGroup": "GLOBAL",
24
+ "name": "flags-dir",
25
+ "summary": "Import flag values from a directory.",
26
+ "hasDynamicHelp": false,
27
+ "multiple": false,
28
+ "type": "option"
29
+ },
30
+ "output-dir": {
31
+ "aliases": [
32
+ "outputdir"
33
+ ],
34
+ "char": "d",
35
+ "deprecateAliases": true,
36
+ "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
37
+ "name": "output-dir",
38
+ "summary": "Directory for saving the created files.",
39
+ "default": ".",
40
+ "hasDynamicHelp": false,
41
+ "multiple": false,
42
+ "type": "option"
43
+ },
44
+ "api-version": {
45
+ "aliases": [
46
+ "apiversion"
47
+ ],
48
+ "deprecateAliases": true,
49
+ "description": "Override the api version used for api requests made by this command",
50
+ "name": "api-version",
51
+ "hasDynamicHelp": false,
52
+ "multiple": false,
53
+ "type": "option"
54
+ },
55
+ "name": {
56
+ "aliases": [
57
+ "templatename"
58
+ ],
59
+ "char": "n",
60
+ "deprecateAliases": true,
61
+ "name": "name",
62
+ "required": true,
63
+ "summary": "Name of the Analytics template.",
64
+ "hasDynamicHelp": false,
65
+ "multiple": false,
66
+ "type": "option"
67
+ },
68
+ "loglevel": {
69
+ "deprecated": {
70
+ "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."
71
+ },
72
+ "hidden": true,
73
+ "name": "loglevel",
74
+ "hasDynamicHelp": false,
75
+ "multiple": false,
76
+ "type": "option"
77
+ }
78
+ },
79
+ "hasDynamicHelp": false,
80
+ "hiddenAliases": [],
81
+ "id": "template:generate:analytics:template",
82
+ "pluginAlias": "@salesforce/plugin-templates",
83
+ "pluginName": "@salesforce/plugin-templates",
84
+ "pluginType": "core",
85
+ "strict": true,
86
+ "summary": "Generate a simple Analytics template.",
87
+ "enableJsonFlag": true,
88
+ "isESM": true,
89
+ "relativePath": [
90
+ "lib",
91
+ "commands",
92
+ "template",
93
+ "generate",
94
+ "analytics",
95
+ "template.js"
96
+ ],
97
+ "aliasPermutations": [
98
+ "force:analytics:template:create",
99
+ "analytics:force:template:create",
100
+ "analytics:template:force:create",
101
+ "analytics:template:create:force",
102
+ "force:template:analytics:create",
103
+ "template:force:analytics:create",
104
+ "template:analytics:force:create",
105
+ "template:analytics:create:force",
106
+ "force:template:create:analytics",
107
+ "template:force:create:analytics",
108
+ "template:create:force:analytics",
109
+ "template:create:analytics:force",
110
+ "force:analytics:create:template",
111
+ "analytics:force:create:template",
112
+ "analytics:create:force:template",
113
+ "analytics:create:template:force",
114
+ "force:create:analytics:template",
115
+ "create:force:analytics:template",
116
+ "create:analytics:force:template",
117
+ "create:analytics:template:force",
118
+ "force:create:template:analytics",
119
+ "create:force:template:analytics",
120
+ "create:template:force:analytics",
121
+ "create:template:analytics:force",
122
+ "analytics:generate:template",
123
+ "generate:analytics:template",
124
+ "generate:template:analytics",
125
+ "analytics:template:generate",
126
+ "template:analytics:generate",
127
+ "template:generate:analytics"
128
+ ],
129
+ "permutations": [
130
+ "template:generate:analytics:template",
131
+ "generate:template:analytics:template",
132
+ "generate:analytics:template:template",
133
+ "generate:analytics:template:template",
134
+ "template:analytics:generate:template",
135
+ "analytics:template:generate:template",
136
+ "analytics:generate:template:template",
137
+ "analytics:generate:template:template",
138
+ "template:analytics:template:generate",
139
+ "analytics:template:template:generate",
140
+ "analytics:template:template:generate",
141
+ "analytics:template:generate:template",
142
+ "template:generate:template:analytics",
143
+ "generate:template:template:analytics",
144
+ "generate:template:template:analytics",
145
+ "generate:template:analytics:template",
146
+ "template:template:generate:analytics",
147
+ "template:template:generate:analytics",
148
+ "template:generate:template:analytics",
149
+ "template:generate:analytics:template",
150
+ "template:template:analytics:generate",
151
+ "template:template:analytics:generate",
152
+ "template:analytics:template:generate",
153
+ "template:analytics:generate:template"
154
+ ]
155
+ },
3
156
  "template:generate:apex:class": {
4
157
  "aliases": [
5
158
  "force:apex:class:create",
@@ -377,16 +530,13 @@
377
530
  "trigger:apex:generate:template"
378
531
  ]
379
532
  },
380
- "template:generate:analytics:template": {
381
- "aliases": [
382
- "force:analytics:template:create",
383
- "analytics:generate:template"
384
- ],
533
+ "template:generate:digital-experience:site": {
534
+ "aliases": [],
385
535
  "args": {},
386
- "deprecateAliases": true,
387
- "description": "The metadata files associated with the Analytics template must be contained in a parent directory called \"waveTemplates\" in your package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to generate one or point to an existing one.",
536
+ "description": "Creates the metadata of an Experience Cloud site with the specified template, name, and URL path prefix. The output includes all the necessary metadata files, including DigitalExperienceConfig, DigitalExperienceBundle, Network, and CustomSite.\nUnlike `sf community create`, which builds the site directly in the org, this command generates only the local metadata.",
388
537
  "examples": [
389
- "Generate the metadata files for a simple Analytics template file called myTemplate in the force-app/main/default/waveTemplates directory:\n<%= config.bin %> <%= command.id %> --name myTemplate --output-dir force-app/main/default/waveTemplates"
538
+ "Generate an Experience Cloud site using the Build Your Own (LWR) template. The site is called \"mysite\" and has the URL path prefix \"mysite\":\n<%= config.bin %> <%= command.id %> --template-name \"Build Your Own (LWR)\" --name mysite --url-path-prefix mysite",
539
+ "Generate an Experience Cloud site like the last example, but generate the files into the specified output directory:\n<%= config.bin %> <%= command.id %> --template-name \"Build Your Own (LWR)\" --name mysite --url-path-prefix mysite --output-dir force-app/main/default"
390
540
  ],
391
541
  "flags": {
392
542
  "json": {
@@ -404,63 +554,72 @@
404
554
  "multiple": false,
405
555
  "type": "option"
406
556
  },
407
- "output-dir": {
408
- "aliases": [
409
- "outputdir"
410
- ],
411
- "char": "d",
412
- "deprecateAliases": true,
413
- "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
414
- "name": "output-dir",
415
- "summary": "Directory for saving the created files.",
416
- "default": ".",
557
+ "target-org": {
558
+ "char": "o",
559
+ "name": "target-org",
560
+ "noCacheDefault": true,
561
+ "summary": "Username or alias of the target org.",
562
+ "hasDynamicHelp": true,
563
+ "multiple": false,
564
+ "type": "option"
565
+ },
566
+ "name": {
567
+ "char": "n",
568
+ "name": "name",
569
+ "required": true,
570
+ "summary": "Name of the Experience Cloud site to generate.",
417
571
  "hasDynamicHelp": false,
418
572
  "multiple": false,
419
573
  "type": "option"
420
574
  },
421
- "api-version": {
422
- "aliases": [
423
- "apiversion"
575
+ "template-name": {
576
+ "char": "t",
577
+ "name": "template-name",
578
+ "required": true,
579
+ "summary": "Template to use when generating the site.",
580
+ "hasDynamicHelp": false,
581
+ "multiple": false,
582
+ "options": [
583
+ "Build Your Own (LWR)"
424
584
  ],
425
- "deprecateAliases": true,
426
- "description": "Override the api version used for api requests made by this command",
427
- "name": "api-version",
585
+ "type": "option"
586
+ },
587
+ "url-path-prefix": {
588
+ "char": "p",
589
+ "name": "url-path-prefix",
590
+ "summary": "URL path prefix for the site; must contain only alphanumeric characters.",
591
+ "default": "",
428
592
  "hasDynamicHelp": false,
429
593
  "multiple": false,
430
594
  "type": "option"
431
595
  },
432
- "name": {
433
- "aliases": [
434
- "templatename"
435
- ],
436
- "char": "n",
437
- "deprecateAliases": true,
438
- "name": "name",
439
- "required": true,
440
- "summary": "Name of the Analytics template.",
596
+ "admin-email": {
597
+ "char": "e",
598
+ "name": "admin-email",
599
+ "summary": "Email address for the site administrator. Defaults to the username of the currently authenticated user.",
441
600
  "hasDynamicHelp": false,
442
601
  "multiple": false,
443
602
  "type": "option"
444
603
  },
445
- "loglevel": {
446
- "deprecated": {
447
- "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."
448
- },
449
- "hidden": true,
450
- "name": "loglevel",
604
+ "output-dir": {
605
+ "char": "d",
606
+ "description": "The location can be an absolute path or relative to the current working directory. If not specified, the command reads your sfdx-project.json file and uses the default package directory. When running outside a Salesforce DX project, defaults to the current directory.",
607
+ "name": "output-dir",
608
+ "summary": "Directory to generate the site files in.",
451
609
  "hasDynamicHelp": false,
452
610
  "multiple": false,
453
611
  "type": "option"
454
612
  }
455
613
  },
456
- "hasDynamicHelp": false,
614
+ "hasDynamicHelp": true,
457
615
  "hiddenAliases": [],
458
- "id": "template:generate:analytics:template",
616
+ "id": "template:generate:digital-experience:site",
459
617
  "pluginAlias": "@salesforce/plugin-templates",
460
618
  "pluginName": "@salesforce/plugin-templates",
461
619
  "pluginType": "core",
620
+ "state": "preview",
462
621
  "strict": true,
463
- "summary": "Generate a simple Analytics template.",
622
+ "summary": "Generate an Experience Cloud site.",
464
623
  "enableJsonFlag": true,
465
624
  "isESM": true,
466
625
  "relativePath": [
@@ -468,75 +627,46 @@
468
627
  "commands",
469
628
  "template",
470
629
  "generate",
471
- "analytics",
472
- "template.js"
473
- ],
474
- "aliasPermutations": [
475
- "force:analytics:template:create",
476
- "analytics:force:template:create",
477
- "analytics:template:force:create",
478
- "analytics:template:create:force",
479
- "force:template:analytics:create",
480
- "template:force:analytics:create",
481
- "template:analytics:force:create",
482
- "template:analytics:create:force",
483
- "force:template:create:analytics",
484
- "template:force:create:analytics",
485
- "template:create:force:analytics",
486
- "template:create:analytics:force",
487
- "force:analytics:create:template",
488
- "analytics:force:create:template",
489
- "analytics:create:force:template",
490
- "analytics:create:template:force",
491
- "force:create:analytics:template",
492
- "create:force:analytics:template",
493
- "create:analytics:force:template",
494
- "create:analytics:template:force",
495
- "force:create:template:analytics",
496
- "create:force:template:analytics",
497
- "create:template:force:analytics",
498
- "create:template:analytics:force",
499
- "analytics:generate:template",
500
- "generate:analytics:template",
501
- "generate:template:analytics",
502
- "analytics:template:generate",
503
- "template:analytics:generate",
504
- "template:generate:analytics"
630
+ "digital-experience",
631
+ "site.js"
505
632
  ],
633
+ "aliasPermutations": [],
506
634
  "permutations": [
507
- "template:generate:analytics:template",
508
- "generate:template:analytics:template",
509
- "generate:analytics:template:template",
510
- "generate:analytics:template:template",
511
- "template:analytics:generate:template",
512
- "analytics:template:generate:template",
513
- "analytics:generate:template:template",
514
- "analytics:generate:template:template",
515
- "template:analytics:template:generate",
516
- "analytics:template:template:generate",
517
- "analytics:template:template:generate",
518
- "analytics:template:generate:template",
519
- "template:generate:template:analytics",
520
- "generate:template:template:analytics",
521
- "generate:template:template:analytics",
522
- "generate:template:analytics:template",
523
- "template:template:generate:analytics",
524
- "template:template:generate:analytics",
525
- "template:generate:template:analytics",
526
- "template:generate:analytics:template",
527
- "template:template:analytics:generate",
528
- "template:template:analytics:generate",
529
- "template:analytics:template:generate",
530
- "template:analytics:generate:template"
635
+ "template:generate:digital-experience:site",
636
+ "generate:template:digital-experience:site",
637
+ "generate:digital-experience:template:site",
638
+ "generate:digital-experience:site:template",
639
+ "template:digital-experience:generate:site",
640
+ "digital-experience:template:generate:site",
641
+ "digital-experience:generate:template:site",
642
+ "digital-experience:generate:site:template",
643
+ "template:digital-experience:site:generate",
644
+ "digital-experience:template:site:generate",
645
+ "digital-experience:site:template:generate",
646
+ "digital-experience:site:generate:template",
647
+ "template:generate:site:digital-experience",
648
+ "generate:template:site:digital-experience",
649
+ "generate:site:template:digital-experience",
650
+ "generate:site:digital-experience:template",
651
+ "template:site:generate:digital-experience",
652
+ "site:template:generate:digital-experience",
653
+ "site:generate:template:digital-experience",
654
+ "site:generate:digital-experience:template",
655
+ "template:site:digital-experience:generate",
656
+ "site:template:digital-experience:generate",
657
+ "site:digital-experience:template:generate",
658
+ "site:digital-experience:generate:template"
531
659
  ]
532
660
  },
533
- "template:generate:digital-experience:site": {
661
+ "template:generate:flexipage": {
534
662
  "aliases": [],
535
663
  "args": {},
536
- "description": "Creates the metadata of an Experience Cloud site with the specified template, name, and URL path prefix. The output includes all the necessary metadata files, including DigitalExperienceConfig, DigitalExperienceBundle, Network, and CustomSite.\nUnlike `sf community create`, which builds the site directly in the org, this command generates only the local metadata.",
664
+ "description": "FlexiPages are the metadata types associated with a Lightning page. A Lightning page represents a customizable screen made up of regions containing Lightning components.\n\nYou can use this command to generate these types of FlexiPages; specify the type with the --template flag:\n\n- AppPage: A Lightning page used as the home page for a custom app or a standalone application page.\n- HomePage: A Lightning page used to override the Home page in Lightning Experience.\n- RecordPage: A Lightning page used to override an object record page in Lightning Experience. Requires that you specify the object name with the --sobject flag.",
537
665
  "examples": [
538
- "Generate an Experience Cloud site using the Build Your Own (LWR) template. The site is called \"mysite\" and has the URL path prefix \"mysite\":\n<%= config.bin %> <%= command.id %> --template-name \"Build Your Own (LWR)\" --name mysite --url-path-prefix mysite",
539
- "Generate an Experience Cloud site like the last example, but generate the files into the specified output directory:\n<%= config.bin %> <%= command.id %> --template-name \"Build Your Own (LWR)\" --name mysite --url-path-prefix mysite --output-dir force-app/main/default"
666
+ "Generate a RecordPage FlexiPage for the Account object in the current directory:\n<%= config.bin %> <%= command.id %> --name Account_Record_Page --template RecordPage --sobject Account",
667
+ "Generate an AppPage FlexiPage in the \"force-app/main/default/flexipages\" directory:\n<%= config.bin %> <%= command.id %> --name Sales_Dashboard --template AppPage --output-dir force-app/main/default/flexipages",
668
+ "Generate a HomePage FlexiPage with a custom label:\n<%= config.bin %> <%= command.id %> --name Custom_Home --template HomePage --label \"Sales Home Page\"",
669
+ "Generate a RecordPage with dynamic highlights and detail fields:\n<%= config.bin %> <%= command.id %> --name Property_Page --template RecordPage --sobject Rental_Property__c --primary-field Name --secondary-fields Property_Address__c,City__c --detail-fields Name,Property_Address__c,City__c,Monthly_Rent__c,Bedrooms__c"
540
670
  ],
541
671
  "flags": {
542
672
  "json": {
@@ -554,108 +684,161 @@
554
684
  "multiple": false,
555
685
  "type": "option"
556
686
  },
557
- "target-org": {
558
- "char": "o",
559
- "name": "target-org",
560
- "noCacheDefault": true,
561
- "summary": "Username or alias of the target org.",
562
- "hasDynamicHelp": true,
563
- "multiple": false,
564
- "type": "option"
565
- },
566
687
  "name": {
688
+ "aliases": [
689
+ "flexipagename"
690
+ ],
567
691
  "char": "n",
692
+ "deprecateAliases": true,
693
+ "description": "The name can contain only alphanumeric characters, must start with a letter, and can't end with an underscore or contain two consecutive underscores.",
568
694
  "name": "name",
569
695
  "required": true,
570
- "summary": "Name of the Experience Cloud site to generate.",
696
+ "summary": "Name of the FlexiPage.",
571
697
  "hasDynamicHelp": false,
572
698
  "multiple": false,
573
699
  "type": "option"
574
700
  },
575
- "template-name": {
701
+ "template": {
576
702
  "char": "t",
577
- "name": "template-name",
703
+ "name": "template",
578
704
  "required": true,
579
- "summary": "Template to use when generating the site.",
705
+ "summary": "Template type for the FlexiPage.",
580
706
  "hasDynamicHelp": false,
581
707
  "multiple": false,
582
708
  "options": [
583
- "Build Your Own (LWR)"
709
+ "RecordPage",
710
+ "AppPage",
711
+ "HomePage"
584
712
  ],
585
713
  "type": "option"
586
714
  },
587
- "url-path-prefix": {
588
- "char": "p",
589
- "name": "url-path-prefix",
590
- "summary": "URL path prefix for the site; must contain only alphanumeric characters.",
591
- "default": "",
715
+ "output-dir": {
716
+ "aliases": [
717
+ "outputdir"
718
+ ],
719
+ "char": "d",
720
+ "deprecateAliases": true,
721
+ "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
722
+ "name": "output-dir",
723
+ "summary": "Directory for saving the created files.",
724
+ "default": ".",
592
725
  "hasDynamicHelp": false,
593
726
  "multiple": false,
594
727
  "type": "option"
595
728
  },
596
- "admin-email": {
597
- "char": "e",
598
- "name": "admin-email",
599
- "summary": "Email address for the site administrator. Defaults to the username of the currently authenticated user.",
729
+ "api-version": {
730
+ "aliases": [
731
+ "apiversion"
732
+ ],
733
+ "deprecateAliases": true,
734
+ "description": "Override the api version used for api requests made by this command",
735
+ "name": "api-version",
736
+ "hasDynamicHelp": false,
737
+ "multiple": false,
738
+ "type": "option"
739
+ },
740
+ "label": {
741
+ "aliases": [
742
+ "masterlabel"
743
+ ],
744
+ "deprecateAliases": true,
745
+ "name": "label",
746
+ "summary": "Label of this FlexiPage; if not specified, uses the FlexiPage name as the label.",
747
+ "hasDynamicHelp": false,
748
+ "multiple": false,
749
+ "type": "option"
750
+ },
751
+ "description": {
752
+ "name": "description",
753
+ "summary": "Description for the FlexiPage, which provides context about its purpose.",
754
+ "hasDynamicHelp": false,
755
+ "multiple": false,
756
+ "type": "option"
757
+ },
758
+ "sobject": {
759
+ "aliases": [
760
+ "entity-name",
761
+ "entity"
762
+ ],
763
+ "char": "s",
764
+ "deprecateAliases": true,
765
+ "description": "For RecordPage FlexiPages, you must specify the associated object API name, such as 'Account', 'Opportunity', or 'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.",
766
+ "name": "sobject",
767
+ "summary": "API name of the Salesforce object; required when creating a RecordPage.",
768
+ "hasDynamicHelp": false,
769
+ "multiple": false,
770
+ "type": "option"
771
+ },
772
+ "primary-field": {
773
+ "name": "primary-field",
774
+ "summary": "Primary field for the dynamic highlights header; typically 'Name'. Used only with RecordPage.",
775
+ "hasDynamicHelp": false,
776
+ "multiple": false,
777
+ "type": "option"
778
+ },
779
+ "secondary-fields": {
780
+ "name": "secondary-fields",
781
+ "summary": "Secondary fields shown in the dynamic highlights header. Specify multiple fields separated by commas. Maximum of 11 fields. Used only with RecordPage.",
782
+ "delimiter": ",",
783
+ "hasDynamicHelp": false,
784
+ "multiple": true,
785
+ "type": "option"
786
+ },
787
+ "detail-fields": {
788
+ "name": "detail-fields",
789
+ "summary": "Fields to display in the Details tab. Specify multiple fields separated by commas. Fields are split into two columns. Used only with RecordPage.",
790
+ "delimiter": ",",
600
791
  "hasDynamicHelp": false,
601
- "multiple": false,
792
+ "multiple": true,
602
793
  "type": "option"
603
794
  },
604
- "output-dir": {
605
- "char": "d",
606
- "description": "The location can be an absolute path or relative to the current working directory. If not specified, the command reads your sfdx-project.json file and uses the default package directory. When running outside a Salesforce DX project, defaults to the current directory.",
607
- "name": "output-dir",
608
- "summary": "Directory to generate the site files in.",
795
+ "internal": {
796
+ "char": "i",
797
+ "hidden": true,
798
+ "name": "internal",
799
+ "summary": "Generate lightning bundles without creating a -meta.xml file.",
800
+ "allowNo": false,
801
+ "type": "boolean"
802
+ },
803
+ "loglevel": {
804
+ "deprecated": {
805
+ "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."
806
+ },
807
+ "hidden": true,
808
+ "name": "loglevel",
609
809
  "hasDynamicHelp": false,
610
810
  "multiple": false,
611
811
  "type": "option"
612
812
  }
613
813
  },
614
- "hasDynamicHelp": true,
814
+ "hasDynamicHelp": false,
615
815
  "hiddenAliases": [],
616
- "id": "template:generate:digital-experience:site",
816
+ "id": "template:generate:flexipage",
617
817
  "pluginAlias": "@salesforce/plugin-templates",
618
818
  "pluginName": "@salesforce/plugin-templates",
619
819
  "pluginType": "core",
620
- "state": "preview",
820
+ "state": "beta",
621
821
  "strict": true,
622
- "summary": "Generate an Experience Cloud site.",
822
+ "summary": "Generate a FlexiPage, also known as a Lightning page.",
623
823
  "enableJsonFlag": true,
824
+ "MAX_SECONDARY_FIELDS": 11,
624
825
  "isESM": true,
625
826
  "relativePath": [
626
827
  "lib",
627
828
  "commands",
628
829
  "template",
629
830
  "generate",
630
- "digital-experience",
631
- "site.js"
831
+ "flexipage",
832
+ "index.js"
632
833
  ],
633
834
  "aliasPermutations": [],
634
835
  "permutations": [
635
- "template:generate:digital-experience:site",
636
- "generate:template:digital-experience:site",
637
- "generate:digital-experience:template:site",
638
- "generate:digital-experience:site:template",
639
- "template:digital-experience:generate:site",
640
- "digital-experience:template:generate:site",
641
- "digital-experience:generate:template:site",
642
- "digital-experience:generate:site:template",
643
- "template:digital-experience:site:generate",
644
- "digital-experience:template:site:generate",
645
- "digital-experience:site:template:generate",
646
- "digital-experience:site:generate:template",
647
- "template:generate:site:digital-experience",
648
- "generate:template:site:digital-experience",
649
- "generate:site:template:digital-experience",
650
- "generate:site:digital-experience:template",
651
- "template:site:generate:digital-experience",
652
- "site:template:generate:digital-experience",
653
- "site:generate:template:digital-experience",
654
- "site:generate:digital-experience:template",
655
- "template:site:digital-experience:generate",
656
- "site:template:digital-experience:generate",
657
- "site:digital-experience:template:generate",
658
- "site:digital-experience:generate:template"
836
+ "template:generate:flexipage",
837
+ "generate:template:flexipage",
838
+ "generate:flexipage:template",
839
+ "template:flexipage:generate",
840
+ "flexipage:template:generate",
841
+ "flexipage:generate:template"
659
842
  ]
660
843
  },
661
844
  "template:generate:lightning:app": {
@@ -1556,189 +1739,6 @@
1556
1739
  "test:lightning:generate:template"
1557
1740
  ]
1558
1741
  },
1559
- "template:generate:flexipage": {
1560
- "aliases": [],
1561
- "args": {},
1562
- "description": "FlexiPages are the metadata types associated with a Lightning page. A Lightning page represents a customizable screen made up of regions containing Lightning components.\n\nYou can use this command to generate these types of FlexiPages; specify the type with the --template flag:\n\n- AppPage: A Lightning page used as the home page for a custom app or a standalone application page.\n- HomePage: A Lightning page used to override the Home page in Lightning Experience.\n- RecordPage: A Lightning page used to override an object record page in Lightning Experience. Requires that you specify the object name with the --sobject flag.",
1563
- "examples": [
1564
- "Generate a RecordPage FlexiPage for the Account object in the current directory:\n<%= config.bin %> <%= command.id %> --name Account_Record_Page --template RecordPage --sobject Account",
1565
- "Generate an AppPage FlexiPage in the \"force-app/main/default/flexipages\" directory:\n<%= config.bin %> <%= command.id %> --name Sales_Dashboard --template AppPage --output-dir force-app/main/default/flexipages",
1566
- "Generate a HomePage FlexiPage with a custom label:\n<%= config.bin %> <%= command.id %> --name Custom_Home --template HomePage --label \"Sales Home Page\"",
1567
- "Generate a RecordPage with dynamic highlights and detail fields:\n<%= config.bin %> <%= command.id %> --name Property_Page --template RecordPage --sobject Rental_Property__c --primary-field Name --secondary-fields Property_Address__c,City__c --detail-fields Name,Property_Address__c,City__c,Monthly_Rent__c,Bedrooms__c"
1568
- ],
1569
- "flags": {
1570
- "json": {
1571
- "description": "Format output as json.",
1572
- "helpGroup": "GLOBAL",
1573
- "name": "json",
1574
- "allowNo": false,
1575
- "type": "boolean"
1576
- },
1577
- "flags-dir": {
1578
- "helpGroup": "GLOBAL",
1579
- "name": "flags-dir",
1580
- "summary": "Import flag values from a directory.",
1581
- "hasDynamicHelp": false,
1582
- "multiple": false,
1583
- "type": "option"
1584
- },
1585
- "name": {
1586
- "aliases": [
1587
- "flexipagename"
1588
- ],
1589
- "char": "n",
1590
- "deprecateAliases": true,
1591
- "description": "The name can contain only alphanumeric characters, must start with a letter, and can't end with an underscore or contain two consecutive underscores.",
1592
- "name": "name",
1593
- "required": true,
1594
- "summary": "Name of the FlexiPage.",
1595
- "hasDynamicHelp": false,
1596
- "multiple": false,
1597
- "type": "option"
1598
- },
1599
- "template": {
1600
- "char": "t",
1601
- "name": "template",
1602
- "required": true,
1603
- "summary": "Template type for the FlexiPage.",
1604
- "hasDynamicHelp": false,
1605
- "multiple": false,
1606
- "options": [
1607
- "RecordPage",
1608
- "AppPage",
1609
- "HomePage"
1610
- ],
1611
- "type": "option"
1612
- },
1613
- "output-dir": {
1614
- "aliases": [
1615
- "outputdir"
1616
- ],
1617
- "char": "d",
1618
- "deprecateAliases": true,
1619
- "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
1620
- "name": "output-dir",
1621
- "summary": "Directory for saving the created files.",
1622
- "default": ".",
1623
- "hasDynamicHelp": false,
1624
- "multiple": false,
1625
- "type": "option"
1626
- },
1627
- "api-version": {
1628
- "aliases": [
1629
- "apiversion"
1630
- ],
1631
- "deprecateAliases": true,
1632
- "description": "Override the api version used for api requests made by this command",
1633
- "name": "api-version",
1634
- "hasDynamicHelp": false,
1635
- "multiple": false,
1636
- "type": "option"
1637
- },
1638
- "label": {
1639
- "aliases": [
1640
- "masterlabel"
1641
- ],
1642
- "deprecateAliases": true,
1643
- "name": "label",
1644
- "summary": "Label of this FlexiPage; if not specified, uses the FlexiPage name as the label.",
1645
- "hasDynamicHelp": false,
1646
- "multiple": false,
1647
- "type": "option"
1648
- },
1649
- "description": {
1650
- "name": "description",
1651
- "summary": "Description for the FlexiPage, which provides context about its purpose.",
1652
- "hasDynamicHelp": false,
1653
- "multiple": false,
1654
- "type": "option"
1655
- },
1656
- "sobject": {
1657
- "aliases": [
1658
- "entity-name",
1659
- "entity"
1660
- ],
1661
- "char": "s",
1662
- "deprecateAliases": true,
1663
- "description": "For RecordPage FlexiPages, you must specify the associated object API name, such as 'Account', 'Opportunity', or 'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.",
1664
- "name": "sobject",
1665
- "summary": "API name of the Salesforce object; required when creating a RecordPage.",
1666
- "hasDynamicHelp": false,
1667
- "multiple": false,
1668
- "type": "option"
1669
- },
1670
- "primary-field": {
1671
- "name": "primary-field",
1672
- "summary": "Primary field for the dynamic highlights header; typically 'Name'. Used only with RecordPage.",
1673
- "hasDynamicHelp": false,
1674
- "multiple": false,
1675
- "type": "option"
1676
- },
1677
- "secondary-fields": {
1678
- "name": "secondary-fields",
1679
- "summary": "Secondary fields shown in the dynamic highlights header. Specify multiple fields separated by commas. Maximum of 11 fields. Used only with RecordPage.",
1680
- "delimiter": ",",
1681
- "hasDynamicHelp": false,
1682
- "multiple": true,
1683
- "type": "option"
1684
- },
1685
- "detail-fields": {
1686
- "name": "detail-fields",
1687
- "summary": "Fields to display in the Details tab. Specify multiple fields separated by commas. Fields are split into two columns. Used only with RecordPage.",
1688
- "delimiter": ",",
1689
- "hasDynamicHelp": false,
1690
- "multiple": true,
1691
- "type": "option"
1692
- },
1693
- "internal": {
1694
- "char": "i",
1695
- "hidden": true,
1696
- "name": "internal",
1697
- "summary": "Generate lightning bundles without creating a -meta.xml file.",
1698
- "allowNo": false,
1699
- "type": "boolean"
1700
- },
1701
- "loglevel": {
1702
- "deprecated": {
1703
- "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."
1704
- },
1705
- "hidden": true,
1706
- "name": "loglevel",
1707
- "hasDynamicHelp": false,
1708
- "multiple": false,
1709
- "type": "option"
1710
- }
1711
- },
1712
- "hasDynamicHelp": false,
1713
- "hiddenAliases": [],
1714
- "id": "template:generate:flexipage",
1715
- "pluginAlias": "@salesforce/plugin-templates",
1716
- "pluginName": "@salesforce/plugin-templates",
1717
- "pluginType": "core",
1718
- "state": "beta",
1719
- "strict": true,
1720
- "summary": "Generate a FlexiPage, also known as a Lightning page.",
1721
- "enableJsonFlag": true,
1722
- "MAX_SECONDARY_FIELDS": 11,
1723
- "isESM": true,
1724
- "relativePath": [
1725
- "lib",
1726
- "commands",
1727
- "template",
1728
- "generate",
1729
- "flexipage",
1730
- "index.js"
1731
- ],
1732
- "aliasPermutations": [],
1733
- "permutations": [
1734
- "template:generate:flexipage",
1735
- "generate:template:flexipage",
1736
- "generate:flexipage:template",
1737
- "template:flexipage:generate",
1738
- "flexipage:template:generate",
1739
- "flexipage:generate:template"
1740
- ]
1741
- },
1742
1742
  "template:generate:project": {
1743
1743
  "aliases": [
1744
1744
  "force:project:create",
@@ -2672,5 +2672,5 @@
2672
2672
  ]
2673
2673
  }
2674
2674
  },
2675
- "version": "57.0.2"
2675
+ "version": "57.0.4"
2676
2676
  }
package/package.json CHANGED
@@ -1,21 +1,21 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-templates",
3
3
  "description": "Commands to create metadata from a default or custom template",
4
- "version": "57.0.2",
4
+ "version": "57.0.4",
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
- "@salesforce/core": "^9.0.0",
10
+ "@salesforce/core": "^9.1.0",
11
11
  "@salesforce/sf-plugins-core": "^13.0.0",
12
12
  "@salesforce/templates": "^66.13.4"
13
13
  },
14
14
  "devDependencies": {
15
- "@oclif/plugin-command-snapshot": "^5.3.33",
15
+ "@oclif/plugin-command-snapshot": "^5.3.34",
16
16
  "@salesforce/cli-plugins-testkit": "^5.3.64",
17
17
  "@salesforce/dev-scripts": "^11.0.4",
18
- "@salesforce/plugin-command-reference": "^3.1.128",
18
+ "@salesforce/plugin-command-reference": "^3.1.131",
19
19
  "@types/yeoman-assert": "^3.1.4",
20
20
  "eslint-plugin-sf-plugin": "^1.20.33",
21
21
  "oclif": "^4.23.29",
@@ -252,7 +252,7 @@
252
252
  "exports": "./lib/index.js",
253
253
  "type": "module",
254
254
  "sfdx": {
255
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/57.0.2.crt",
256
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/57.0.2.sig"
255
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/57.0.4.crt",
256
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/57.0.4.sig"
257
257
  }
258
258
  }