@salesforce/plugin-templates 56.18.0 → 56.18.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 (4) hide show
  1. package/README.md +15 -15
  2. package/messages/messages.md +1 -1
  3. package/oclif.manifest.json +254 -254
  4. package/package.json +7 -7
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/56.18.0/src/commands/template/generate/analytics/template.ts)_
180
+ _See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.2/src/commands/template/generate/analytics/template.ts)_
181
181
 
182
182
  ## `sf template generate apex class`
183
183
 
@@ -237,7 +237,7 @@ FLAG DESCRIPTIONS
237
237
  Supplied parameter values or default values are filled into a copy of the template.
238
238
  ```
239
239
 
240
- _See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/apex/class.ts)_
240
+ _See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.2/src/commands/template/generate/apex/class.ts)_
241
241
 
242
242
  ## `sf template generate apex trigger`
243
243
 
@@ -307,7 +307,7 @@ FLAG DESCRIPTIONS
307
307
  Supplied parameter values or default values are filled into a copy of the template.
308
308
  ```
309
309
 
310
- _See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/apex/trigger.ts)_
310
+ _See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.2/src/commands/template/generate/apex/trigger.ts)_
311
311
 
312
312
  ## `sf template generate digital-experience site`
313
313
 
@@ -361,7 +361,7 @@ FLAG DESCRIPTIONS
361
361
  project, defaults to the current directory.
362
362
  ```
363
363
 
364
- _See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/digital-experience/site.ts)_
364
+ _See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.2/src/commands/template/generate/digital-experience/site.ts)_
365
365
 
366
366
  ## `sf template generate flexipage`
367
367
 
@@ -443,7 +443,7 @@ FLAG DESCRIPTIONS
443
443
  'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.
444
444
  ```
445
445
 
446
- _See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/flexipage/index.ts)_
446
+ _See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.2/src/commands/template/generate/flexipage/index.ts)_
447
447
 
448
448
  ## `sf template generate lightning app`
449
449
 
@@ -501,7 +501,7 @@ FLAG DESCRIPTIONS
501
501
  field in the DX project's "sfdx-project.json" file.
502
502
  ```
503
503
 
504
- _See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/lightning/app.ts)_
504
+ _See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.2/src/commands/template/generate/lightning/app.ts)_
505
505
 
506
506
  ## `sf template generate lightning component`
507
507
 
@@ -578,7 +578,7 @@ FLAG DESCRIPTIONS
578
578
  field in the DX project's "sfdx-project.json" file.
579
579
  ```
580
580
 
581
- _See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/lightning/component.ts)_
581
+ _See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.2/src/commands/template/generate/lightning/component.ts)_
582
582
 
583
583
  ## `sf template generate lightning event`
584
584
 
@@ -636,7 +636,7 @@ FLAG DESCRIPTIONS
636
636
  field in the DX project's "sfdx-project.json" file.
637
637
  ```
638
638
 
639
- _See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/lightning/event.ts)_
639
+ _See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.2/src/commands/template/generate/lightning/event.ts)_
640
640
 
641
641
  ## `sf template generate lightning interface`
642
642
 
@@ -694,7 +694,7 @@ FLAG DESCRIPTIONS
694
694
  field in the DX project's "sfdx-project.json" file.
695
695
  ```
696
696
 
697
- _See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/lightning/interface.ts)_
697
+ _See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.2/src/commands/template/generate/lightning/interface.ts)_
698
698
 
699
699
  ## `sf template generate lightning test`
700
700
 
@@ -752,7 +752,7 @@ FLAG DESCRIPTIONS
752
752
  field in the DX project's "sfdx-project.json" file.
753
753
  ```
754
754
 
755
- _See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/lightning/test.ts)_
755
+ _See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.2/src/commands/template/generate/lightning/test.ts)_
756
756
 
757
757
  ## `sf template generate project`
758
758
 
@@ -878,7 +878,7 @@ FLAG DESCRIPTIONS
878
878
  server-side type stripping.
879
879
  ```
880
880
 
881
- _See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/project/index.ts)_
881
+ _See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.2/src/commands/template/generate/project/index.ts)_
882
882
 
883
883
  ## `sf template generate static-resource`
884
884
 
@@ -941,7 +941,7 @@ FLAG DESCRIPTIONS
941
941
  etc.
942
942
  ```
943
943
 
944
- _See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/static-resource/index.ts)_
944
+ _See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.2/src/commands/template/generate/static-resource/index.ts)_
945
945
 
946
946
  ## `sf template generate ui-bundle`
947
947
 
@@ -1025,7 +1025,7 @@ FLAG DESCRIPTIONS
1025
1025
  Supplied parameter values or default values are filled into a copy of the template.
1026
1026
  ```
1027
1027
 
1028
- _See code: [src/commands/template/generate/ui-bundle/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/ui-bundle/index.ts)_
1028
+ _See code: [src/commands/template/generate/ui-bundle/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.2/src/commands/template/generate/ui-bundle/index.ts)_
1029
1029
 
1030
1030
  ## `sf template generate visualforce component`
1031
1031
 
@@ -1082,7 +1082,7 @@ FLAG DESCRIPTIONS
1082
1082
  Supplied parameter values or default values are filled into a copy of the template.
1083
1083
  ```
1084
1084
 
1085
- _See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/visualforce/component.ts)_
1085
+ _See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.2/src/commands/template/generate/visualforce/component.ts)_
1086
1086
 
1087
1087
  ## `sf template generate visualforce page`
1088
1088
 
@@ -1133,6 +1133,6 @@ FLAG DESCRIPTIONS
1133
1133
  The name can be up to 40 characters and must start with a letter.
1134
1134
  ```
1135
1135
 
1136
- _See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/visualforce/page.ts)_
1136
+ _See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/56.18.2/src/commands/template/generate/visualforce/page.ts)_
1137
1137
 
1138
1138
  <!-- commandsstop -->
package/messages/messages.md CHANGED
@@ -40,4 +40,4 @@ Expected --template=foo to be one of:
40
40
 
41
41
  # StandardReadMe
42
42
 
43
- Now that you’ve created a Salesforce DX project, what’s next?
43
+ Salesforce DX is a development approach that brings source-driven development, team collaboration, and continuous integration to the Salesforce Platform. Instead of working directly in an org through a web browser, you work with metadata as source files in a local DX project, track changes in version control, and deploy through automated processes.
package/oclif.manifest.json CHANGED
@@ -1,158 +1,5 @@
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 `SFDX_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
- },
156
3
  "template:generate:apex:class": {
157
4
  "aliases": [
158
5
  "force:apex:class:create",
@@ -528,6 +375,159 @@
528
375
  "trigger:apex:generate:template"
529
376
  ]
530
377
  },
378
+ "template:generate:analytics:template": {
379
+ "aliases": [
380
+ "force:analytics:template:create",
381
+ "analytics:generate:template"
382
+ ],
383
+ "args": {},
384
+ "deprecateAliases": true,
385
+ "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.",
386
+ "examples": [
387
+ "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"
388
+ ],
389
+ "flags": {
390
+ "json": {
391
+ "description": "Format output as json.",
392
+ "helpGroup": "GLOBAL",
393
+ "name": "json",
394
+ "allowNo": false,
395
+ "type": "boolean"
396
+ },
397
+ "flags-dir": {
398
+ "helpGroup": "GLOBAL",
399
+ "name": "flags-dir",
400
+ "summary": "Import flag values from a directory.",
401
+ "hasDynamicHelp": false,
402
+ "multiple": false,
403
+ "type": "option"
404
+ },
405
+ "output-dir": {
406
+ "aliases": [
407
+ "outputdir"
408
+ ],
409
+ "char": "d",
410
+ "deprecateAliases": true,
411
+ "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
412
+ "name": "output-dir",
413
+ "summary": "Directory for saving the created files.",
414
+ "default": ".",
415
+ "hasDynamicHelp": false,
416
+ "multiple": false,
417
+ "type": "option"
418
+ },
419
+ "api-version": {
420
+ "aliases": [
421
+ "apiversion"
422
+ ],
423
+ "deprecateAliases": true,
424
+ "description": "Override the api version used for api requests made by this command",
425
+ "name": "api-version",
426
+ "hasDynamicHelp": false,
427
+ "multiple": false,
428
+ "type": "option"
429
+ },
430
+ "name": {
431
+ "aliases": [
432
+ "templatename"
433
+ ],
434
+ "char": "n",
435
+ "deprecateAliases": true,
436
+ "name": "name",
437
+ "required": true,
438
+ "summary": "Name of the Analytics template.",
439
+ "hasDynamicHelp": false,
440
+ "multiple": false,
441
+ "type": "option"
442
+ },
443
+ "loglevel": {
444
+ "deprecated": {
445
+ "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 `SFDX_LOG_LEVEL` environment variable."
446
+ },
447
+ "hidden": true,
448
+ "name": "loglevel",
449
+ "hasDynamicHelp": false,
450
+ "multiple": false,
451
+ "type": "option"
452
+ }
453
+ },
454
+ "hasDynamicHelp": false,
455
+ "hiddenAliases": [],
456
+ "id": "template:generate:analytics:template",
457
+ "pluginAlias": "@salesforce/plugin-templates",
458
+ "pluginName": "@salesforce/plugin-templates",
459
+ "pluginType": "core",
460
+ "strict": true,
461
+ "summary": "Generate a simple Analytics template.",
462
+ "enableJsonFlag": true,
463
+ "isESM": true,
464
+ "relativePath": [
465
+ "lib",
466
+ "commands",
467
+ "template",
468
+ "generate",
469
+ "analytics",
470
+ "template.js"
471
+ ],
472
+ "aliasPermutations": [
473
+ "force:analytics:template:create",
474
+ "analytics:force:template:create",
475
+ "analytics:template:force:create",
476
+ "analytics:template:create:force",
477
+ "force:template:analytics:create",
478
+ "template:force:analytics:create",
479
+ "template:analytics:force:create",
480
+ "template:analytics:create:force",
481
+ "force:template:create:analytics",
482
+ "template:force:create:analytics",
483
+ "template:create:force:analytics",
484
+ "template:create:analytics:force",
485
+ "force:analytics:create:template",
486
+ "analytics:force:create:template",
487
+ "analytics:create:force:template",
488
+ "analytics:create:template:force",
489
+ "force:create:analytics:template",
490
+ "create:force:analytics:template",
491
+ "create:analytics:force:template",
492
+ "create:analytics:template:force",
493
+ "force:create:template:analytics",
494
+ "create:force:template:analytics",
495
+ "create:template:force:analytics",
496
+ "create:template:analytics:force",
497
+ "analytics:generate:template",
498
+ "generate:analytics:template",
499
+ "generate:template:analytics",
500
+ "analytics:template:generate",
501
+ "template:analytics:generate",
502
+ "template:generate:analytics"
503
+ ],
504
+ "permutations": [
505
+ "template:generate:analytics:template",
506
+ "generate:template:analytics:template",
507
+ "generate:analytics:template:template",
508
+ "generate:analytics:template:template",
509
+ "template:analytics:generate:template",
510
+ "analytics:template:generate:template",
511
+ "analytics:generate:template:template",
512
+ "analytics:generate:template:template",
513
+ "template:analytics:template:generate",
514
+ "analytics:template:template:generate",
515
+ "analytics:template:template:generate",
516
+ "analytics:template:generate:template",
517
+ "template:generate:template:analytics",
518
+ "generate:template:template:analytics",
519
+ "generate:template:template:analytics",
520
+ "generate:template:analytics:template",
521
+ "template:template:generate:analytics",
522
+ "template:template:generate:analytics",
523
+ "template:generate:template:analytics",
524
+ "template:generate:analytics:template",
525
+ "template:template:analytics:generate",
526
+ "template:template:analytics:generate",
527
+ "template:analytics:template:generate",
528
+ "template:analytics:generate:template"
529
+ ]
530
+ },
531
531
  "template:generate:digital-experience:site": {
532
532
  "aliases": [],
533
533
  "args": {},
@@ -2096,14 +2096,18 @@
2096
2096
  "project:generate:template"
2097
2097
  ]
2098
2098
  },
2099
- "template:generate:ui-bundle": {
2100
- "aliases": [],
2099
+ "template:generate:static-resource": {
2100
+ "aliases": [
2101
+ "force:staticresource:create",
2102
+ "static-resource:generate"
2103
+ ],
2101
2104
  "args": {},
2102
- "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 speciic UI framework, such as React. Check out the README.md file in the generated \"uiBundles/<bundlename>\" directory for more information about the template.",
2105
+ "deprecateAliases": true,
2106
+ "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.",
2103
2107
  "examples": [
2104
- "Generate a UI bundle called MyUiBundle in the current directory:\n<%= config.bin %> <%= command.id %> --name MyUiBundle",
2105
- "Generate a React-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic",
2106
- "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"
2108
+ "Generate the metadata file for a static resource called MyResource in the current directory:\n<%= config.bin %> <%= command.id %> --name MyResource",
2109
+ "Similar to previous example, but specifies a MIME type of application/json:\n<%= config.bin %> <%= command.id %> --name MyResource --type application/json",
2110
+ "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"
2107
2111
  ],
2108
2112
  "flags": {
2109
2113
  "json": {
@@ -2122,63 +2126,76 @@
2122
2126
  "type": "option"
2123
2127
  },
2124
2128
  "name": {
2129
+ "aliases": [
2130
+ "resourcename"
2131
+ ],
2125
2132
  "char": "n",
2133
+ "deprecateAliases": true,
2126
2134
  "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.",
2127
2135
  "name": "name",
2128
2136
  "required": true,
2129
- "summary": "API name of the generated UI bundle.",
2137
+ "summary": "Name of the generated static resource.",
2130
2138
  "hasDynamicHelp": false,
2131
2139
  "multiple": false,
2132
2140
  "type": "option"
2133
2141
  },
2134
- "template": {
2135
- "char": "t",
2136
- "description": "Supplied parameter values or default values are filled into a copy of the template.",
2137
- "name": "template",
2138
- "summary": "Template to use when creating the files for a specific UI framework.",
2139
- "default": "default",
2140
- "hasDynamicHelp": false,
2141
- "multiple": false,
2142
- "options": [
2143
- "default",
2144
- "reactbasic"
2142
+ "type": {
2143
+ "aliases": [
2144
+ "contenttype"
2145
2145
  ],
2146
- "type": "option"
2147
- },
2148
- "label": {
2149
- "char": "l",
2150
- "description": "If not specified, the label is derived from the name.",
2151
- "name": "label",
2152
- "summary": "Master label for the UI bundle.",
2146
+ "deprecateAliases": true,
2147
+ "description": "Must be a valid MIME type such as application/json, application/javascript, application/zip, text/plain, text/css, etc.",
2148
+ "name": "type",
2149
+ "summary": "Content type (mime type) of the generated static resource.",
2150
+ "default": "application/zip",
2153
2151
  "hasDynamicHelp": false,
2154
2152
  "multiple": false,
2155
2153
  "type": "option"
2156
2154
  },
2157
2155
  "output-dir": {
2156
+ "aliases": [
2157
+ "outputdir"
2158
+ ],
2158
2159
  "char": "d",
2159
- "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)",
2160
+ "deprecateAliases": true,
2161
+ "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
2160
2162
  "name": "output-dir",
2161
- "summary": "Directory into which the files are created.",
2163
+ "summary": "Directory for saving the created files.",
2164
+ "default": ".",
2162
2165
  "hasDynamicHelp": false,
2163
2166
  "multiple": false,
2164
2167
  "type": "option"
2165
2168
  },
2166
2169
  "api-version": {
2170
+ "aliases": [
2171
+ "apiversion"
2172
+ ],
2173
+ "deprecateAliases": true,
2167
2174
  "description": "Override the api version used for api requests made by this command",
2168
2175
  "name": "api-version",
2169
2176
  "hasDynamicHelp": false,
2170
2177
  "multiple": false,
2171
2178
  "type": "option"
2179
+ },
2180
+ "loglevel": {
2181
+ "deprecated": {
2182
+ "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 `SFDX_LOG_LEVEL` environment variable."
2183
+ },
2184
+ "hidden": true,
2185
+ "name": "loglevel",
2186
+ "hasDynamicHelp": false,
2187
+ "multiple": false,
2188
+ "type": "option"
2172
2189
  }
2173
2190
  },
2174
2191
  "hasDynamicHelp": false,
2175
2192
  "hiddenAliases": [],
2176
- "id": "template:generate:ui-bundle",
2193
+ "id": "template:generate:static-resource",
2177
2194
  "pluginAlias": "@salesforce/plugin-templates",
2178
2195
  "pluginName": "@salesforce/plugin-templates",
2179
2196
  "pluginType": "core",
2180
2197
  "strict": true,
2181
- "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.",
2198
+ "summary": "Generate a static resource.",
2182
2199
  "enableJsonFlag": true,
2183
2200
  "isESM": true,
2184
2201
  "relativePath": [
@@ -2186,31 +2203,36 @@
2186
2203
  "commands",
2187
2204
  "template",
2188
2205
  "generate",
2189
- "ui-bundle",
2206
+ "static-resource",
2190
2207
  "index.js"
2191
2208
  ],
2192
- "aliasPermutations": [],
2209
+ "aliasPermutations": [
2210
+ "force:staticresource:create",
2211
+ "staticresource:force:create",
2212
+ "staticresource:create:force",
2213
+ "force:create:staticresource",
2214
+ "create:force:staticresource",
2215
+ "create:staticresource:force",
2216
+ "static-resource:generate",
2217
+ "generate:static-resource"
2218
+ ],
2193
2219
  "permutations": [
2194
- "template:generate:ui-bundle",
2195
- "generate:template:ui-bundle",
2196
- "generate:ui-bundle:template",
2197
- "template:ui-bundle:generate",
2198
- "ui-bundle:template:generate",
2199
- "ui-bundle:generate:template"
2220
+ "template:generate:static-resource",
2221
+ "generate:template:static-resource",
2222
+ "generate:static-resource:template",
2223
+ "template:static-resource:generate",
2224
+ "static-resource:template:generate",
2225
+ "static-resource:generate:template"
2200
2226
  ]
2201
2227
  },
2202
- "template:generate:static-resource": {
2203
- "aliases": [
2204
- "force:staticresource:create",
2205
- "static-resource:generate"
2206
- ],
2228
+ "template:generate:ui-bundle": {
2229
+ "aliases": [],
2207
2230
  "args": {},
2208
- "deprecateAliases": true,
2209
- "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.",
2231
+ "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 speciic UI framework, such as React. Check out the README.md file in the generated \"uiBundles/<bundlename>\" directory for more information about the template.",
2210
2232
  "examples": [
2211
- "Generate the metadata file for a static resource called MyResource in the current directory:\n<%= config.bin %> <%= command.id %> --name MyResource",
2212
- "Similar to previous example, but specifies a MIME type of application/json:\n<%= config.bin %> <%= command.id %> --name MyResource --type application/json",
2213
- "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"
2233
+ "Generate a UI bundle called MyUiBundle in the current directory:\n<%= config.bin %> <%= command.id %> --name MyUiBundle",
2234
+ "Generate a React-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic",
2235
+ "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"
2214
2236
  ],
2215
2237
  "flags": {
2216
2238
  "json": {
@@ -2229,76 +2251,63 @@
2229
2251
  "type": "option"
2230
2252
  },
2231
2253
  "name": {
2232
- "aliases": [
2233
- "resourcename"
2234
- ],
2235
2254
  "char": "n",
2236
- "deprecateAliases": true,
2237
2255
  "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.",
2238
2256
  "name": "name",
2239
2257
  "required": true,
2240
- "summary": "Name of the generated static resource.",
2258
+ "summary": "API name of the generated UI bundle.",
2241
2259
  "hasDynamicHelp": false,
2242
2260
  "multiple": false,
2243
2261
  "type": "option"
2244
2262
  },
2245
- "type": {
2246
- "aliases": [
2247
- "contenttype"
2263
+ "template": {
2264
+ "char": "t",
2265
+ "description": "Supplied parameter values or default values are filled into a copy of the template.",
2266
+ "name": "template",
2267
+ "summary": "Template to use when creating the files for a specific UI framework.",
2268
+ "default": "default",
2269
+ "hasDynamicHelp": false,
2270
+ "multiple": false,
2271
+ "options": [
2272
+ "default",
2273
+ "reactbasic"
2248
2274
  ],
2249
- "deprecateAliases": true,
2250
- "description": "Must be a valid MIME type such as application/json, application/javascript, application/zip, text/plain, text/css, etc.",
2251
- "name": "type",
2252
- "summary": "Content type (mime type) of the generated static resource.",
2253
- "default": "application/zip",
2275
+ "type": "option"
2276
+ },
2277
+ "label": {
2278
+ "char": "l",
2279
+ "description": "If not specified, the label is derived from the name.",
2280
+ "name": "label",
2281
+ "summary": "Master label for the UI bundle.",
2254
2282
  "hasDynamicHelp": false,
2255
2283
  "multiple": false,
2256
2284
  "type": "option"
2257
2285
  },
2258
2286
  "output-dir": {
2259
- "aliases": [
2260
- "outputdir"
2261
- ],
2262
2287
  "char": "d",
2263
- "deprecateAliases": true,
2264
- "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
2288
+ "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)",
2265
2289
  "name": "output-dir",
2266
- "summary": "Directory for saving the created files.",
2267
- "default": ".",
2290
+ "summary": "Directory into which the files are created.",
2268
2291
  "hasDynamicHelp": false,
2269
2292
  "multiple": false,
2270
2293
  "type": "option"
2271
2294
  },
2272
2295
  "api-version": {
2273
- "aliases": [
2274
- "apiversion"
2275
- ],
2276
- "deprecateAliases": true,
2277
2296
  "description": "Override the api version used for api requests made by this command",
2278
2297
  "name": "api-version",
2279
2298
  "hasDynamicHelp": false,
2280
2299
  "multiple": false,
2281
2300
  "type": "option"
2282
- },
2283
- "loglevel": {
2284
- "deprecated": {
2285
- "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 `SFDX_LOG_LEVEL` environment variable."
2286
- },
2287
- "hidden": true,
2288
- "name": "loglevel",
2289
- "hasDynamicHelp": false,
2290
- "multiple": false,
2291
- "type": "option"
2292
2301
  }
2293
2302
  },
2294
2303
  "hasDynamicHelp": false,
2295
2304
  "hiddenAliases": [],
2296
- "id": "template:generate:static-resource",
2305
+ "id": "template:generate:ui-bundle",
2297
2306
  "pluginAlias": "@salesforce/plugin-templates",
2298
2307
  "pluginName": "@salesforce/plugin-templates",
2299
2308
  "pluginType": "core",
2300
2309
  "strict": true,
2301
- "summary": "Generate a static resource.",
2310
+ "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.",
2302
2311
  "enableJsonFlag": true,
2303
2312
  "isESM": true,
2304
2313
  "relativePath": [
@@ -2306,26 +2315,17 @@
2306
2315
  "commands",
2307
2316
  "template",
2308
2317
  "generate",
2309
- "static-resource",
2318
+ "ui-bundle",
2310
2319
  "index.js"
2311
2320
  ],
2312
- "aliasPermutations": [
2313
- "force:staticresource:create",
2314
- "staticresource:force:create",
2315
- "staticresource:create:force",
2316
- "force:create:staticresource",
2317
- "create:force:staticresource",
2318
- "create:staticresource:force",
2319
- "static-resource:generate",
2320
- "generate:static-resource"
2321
- ],
2321
+ "aliasPermutations": [],
2322
2322
  "permutations": [
2323
- "template:generate:static-resource",
2324
- "generate:template:static-resource",
2325
- "generate:static-resource:template",
2326
- "template:static-resource:generate",
2327
- "static-resource:template:generate",
2328
- "static-resource:generate:template"
2323
+ "template:generate:ui-bundle",
2324
+ "generate:template:ui-bundle",
2325
+ "generate:ui-bundle:template",
2326
+ "template:ui-bundle:generate",
2327
+ "ui-bundle:template:generate",
2328
+ "ui-bundle:generate:template"
2329
2329
  ]
2330
2330
  },
2331
2331
  "template:generate:visualforce:component": {
@@ -2684,5 +2684,5 @@
2684
2684
  ]
2685
2685
  }
2686
2686
  },
2687
- "version": "56.18.0"
2687
+ "version": "56.18.2"
2688
2688
  }
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": "56.18.0",
4
+ "version": "56.18.2",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/salesforcecli/plugin-templates/issues",
7
7
  "enableO11y": true,
@@ -9,16 +9,16 @@
9
9
  "dependencies": {
10
10
  "@salesforce/core": "^8.31.0",
11
11
  "@salesforce/sf-plugins-core": "^12",
12
- "@salesforce/templates": "^66.9.1"
12
+ "@salesforce/templates": "^66.9.3"
13
13
  },
14
14
  "devDependencies": {
15
- "@oclif/plugin-command-snapshot": "^5.3.22",
15
+ "@oclif/plugin-command-snapshot": "^5.3.24",
16
16
  "@salesforce/cli-plugins-testkit": "^5.3.58",
17
17
  "@salesforce/dev-scripts": "^11.0.4",
18
- "@salesforce/plugin-command-reference": "^3.1.106",
18
+ "@salesforce/plugin-command-reference": "^3.1.109",
19
19
  "@types/yeoman-assert": "^3.1.4",
20
20
  "eslint-plugin-sf-plugin": "^1.20.33",
21
- "oclif": "^4.23.8",
21
+ "oclif": "^4.23.10",
22
22
  "ts-node": "^10.9.2",
23
23
  "typescript": "^5.9.3",
24
24
  "yeoman-assert": "^3.1.1"
@@ -249,7 +249,7 @@
249
249
  "exports": "./lib/index.js",
250
250
  "type": "module",
251
251
  "sfdx": {
252
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.18.0.crt",
253
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.18.0.sig"
252
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.18.2.crt",
253
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.18.2.sig"
254
254
  }
255
255
  }