@salesforce/plugin-templates 56.13.1 → 56.13.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.
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.13.1/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.13.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.13.1/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.13.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.13.1/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.13.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.13.1/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.13.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.13.1/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.13.2/src/commands/template/generate/flexipage/index.ts)_
447
447
 
448
448
  ## `sf template generate lightning app`
449
449
 
@@ -499,7 +499,7 @@ FLAG DESCRIPTIONS
499
499
  Supplied parameter values or default values are filled into a copy of the template.
500
500
  ```
501
501
 
502
- _See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/app.ts)_
502
+ _See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.2/src/commands/template/generate/lightning/app.ts)_
503
503
 
504
504
  ## `sf template generate lightning component`
505
505
 
@@ -569,7 +569,7 @@ FLAG DESCRIPTIONS
569
569
  Supplied parameter values or default values are filled into a copy of the template.
570
570
  ```
571
571
 
572
- _See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/component.ts)_
572
+ _See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.2/src/commands/template/generate/lightning/component.ts)_
573
573
 
574
574
  ## `sf template generate lightning event`
575
575
 
@@ -625,7 +625,7 @@ FLAG DESCRIPTIONS
625
625
  Supplied parameter values or default values are filled into a copy of the template.
626
626
  ```
627
627
 
628
- _See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/event.ts)_
628
+ _See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.2/src/commands/template/generate/lightning/event.ts)_
629
629
 
630
630
  ## `sf template generate lightning interface`
631
631
 
@@ -681,7 +681,7 @@ FLAG DESCRIPTIONS
681
681
  Supplied parameter values or default values are filled into a copy of the template.
682
682
  ```
683
683
 
684
- _See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/interface.ts)_
684
+ _See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.2/src/commands/template/generate/lightning/interface.ts)_
685
685
 
686
686
  ## `sf template generate lightning test`
687
687
 
@@ -737,7 +737,7 @@ FLAG DESCRIPTIONS
737
737
  Supplied parameter values or default values are filled into a copy of the template.
738
738
  ```
739
739
 
740
- _See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/test.ts)_
740
+ _See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.2/src/commands/template/generate/lightning/test.ts)_
741
741
 
742
742
  ## `sf template generate project`
743
743
 
@@ -850,7 +850,7 @@ FLAG DESCRIPTIONS
850
850
  Override the api version used for api requests made by this command
851
851
  ```
852
852
 
853
- _See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/project/index.ts)_
853
+ _See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.2/src/commands/template/generate/project/index.ts)_
854
854
 
855
855
  ## `sf template generate static-resource`
856
856
 
@@ -913,11 +913,11 @@ FLAG DESCRIPTIONS
913
913
  etc.
914
914
  ```
915
915
 
916
- _See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/static-resource/index.ts)_
916
+ _See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.2/src/commands/template/generate/static-resource/index.ts)_
917
917
 
918
918
  ## `sf template generate ui-bundle`
919
919
 
920
- Generate a UI bundle.
920
+ Generate a UI bundle, which contains the code and metadata to build a UI experience that uses non-native Salesforce frameworks, such as React.
921
921
 
922
922
  ```
923
923
  USAGE
@@ -925,10 +925,10 @@ USAGE
925
925
  [--api-version <value>]
926
926
 
927
927
  FLAGS
928
- -d, --output-dir=<value> Directory for saving the created files.
928
+ -d, --output-dir=<value> Directory into which the files are created.
929
929
  -l, --label=<value> Master label for the UI bundle.
930
- -n, --name=<value> (required) Name of the generated UI bundle.
931
- -t, --template=<option> [default: default] Template to use for file creation.
930
+ -n, --name=<value> (required) API name of the generated UI bundle.
931
+ -t, --template=<option> [default: default] Template to use when creating the files for a specific UI framework.
932
932
  <options: default|reactbasic>
933
933
  --api-version=<value> Override the api version used for api requests made by this command
934
934
 
@@ -937,12 +937,20 @@ GLOBAL FLAGS
937
937
  --json Format output as json.
938
938
 
939
939
  DESCRIPTION
940
- Generate a UI bundle.
940
+ Generate a UI bundle, which contains the code and metadata to build a UI experience that uses non-native Salesforce
941
+ frameworks, such as React.
942
+
943
+ Salesforce provides native UI frameworks, such as Lighting Web Components (LWC), to build applications that run on the
944
+ Salesforce Platform. But you can also use non-native JavaScript- or TypeScript-based UI frameworks, such as React, to
945
+ build a UI experience for the Salesforce Platform and that you can launch from the App Launcher.
946
+
947
+ These non-native UI experiences are defined by the "UIBundle" metadata type in your DX project. Use this command to
948
+ generate the required DX project structure and files. For example, when you run this command and specify the name
949
+ MyUiBundle, then the files are generated into a "uiBundles/MyUiBundle" directory. Use the --output-dir flag to specify
950
+ a different directory.
941
951
 
942
- Generates a UI bundle in the specified directory or the current working directory. The UI bundle files are created in
943
- a folder with the designated name. UI bundle files must be contained in a parent directory called "uiBundles" in your
944
- package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to
945
- create one or point to an existing one.
952
+ Use the --template flag for generating the files to get started with a speciic UI framework, such as React. Check out
953
+ the README.md file in the generated "uiBundles/<bundlename>" directory for more information about the template.
946
954
 
947
955
  ALIASES
948
956
  $ sf ui-bundle generate
@@ -956,17 +964,21 @@ EXAMPLES
956
964
 
957
965
  $ sf template generate ui-bundle --name MyReactApp --template reactbasic
958
966
 
959
- Generate the UI bundle in the "force-app/main/default/uiBundles" directory:
967
+ Generate the React-based UI bundle in the "force-app/main/default/uiBundles" directory:
960
968
 
961
- $ sf template generate ui-bundle --name MyUiBundle --output-dir force-app/main/default/uiBundles
969
+ $ sf template generate ui-bundle --name MyUiBundle --template reactbasic --output-dir \
970
+ force-app/main/default/uiBundles
962
971
 
963
972
  FLAG DESCRIPTIONS
964
- -d, --output-dir=<value> Directory for saving the created files.
973
+ -d, --output-dir=<value> Directory into which the files are created.
965
974
 
966
975
  The location can be an absolute path or relative to the current working directory.
967
976
 
968
- **Important:** The generator automatically ensures the output directory ends with "uiBundles". If your specified
969
- path doesn't end with "uiBundles", it's automatically appended. The UI bundle is created at "<output-dir>/<name>".
977
+ If not specified, the command reads your sfdx-project.json and defaults to "uiBundles" directory within your default
978
+ package directory. When running outside a Salesforce DX project, defaults to the current directory.
979
+
980
+ **Important:** This command automatically ensures the output directory ends with "uiBundles". If your specified path
981
+ doesn't end with "uiBundles", it's automatically appended. The UI bundle is created at "<output-dir>/<name>".
970
982
 
971
983
  **Examples:**
972
984
 
@@ -974,24 +986,21 @@ FLAG DESCRIPTIONS
974
986
  - "--output-dir force-app/main/default/uiBundles" → Creates a UI bundle at
975
987
  "force-app/main/default/uiBundles/MyUiBundle/" (no change)
976
988
 
977
- If not specified, the command reads your sfdx-project.json and defaults to "uiBundles" directory within your default
978
- package directory. When running outside a Salesforce DX project, defaults to the current directory.
979
-
980
989
  -l, --label=<value> Master label for the UI bundle.
981
990
 
982
991
  If not specified, the label is derived from the name.
983
992
 
984
- -n, --name=<value> Name of the generated UI bundle.
993
+ -n, --name=<value> API name of the generated UI bundle.
985
994
 
986
995
  This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin
987
996
  with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
988
997
 
989
- -t, --template=default|reactbasic Template to use for file creation.
998
+ -t, --template=default|reactbasic Template to use when creating the files for a specific UI framework.
990
999
 
991
1000
  Supplied parameter values or default values are filled into a copy of the template.
992
1001
  ```
993
1002
 
994
- _See code: [src/commands/template/generate/ui-bundle/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/ui-bundle/index.ts)_
1003
+ _See code: [src/commands/template/generate/ui-bundle/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.2/src/commands/template/generate/ui-bundle/index.ts)_
995
1004
 
996
1005
  ## `sf template generate visualforce component`
997
1006
 
@@ -1048,7 +1057,7 @@ FLAG DESCRIPTIONS
1048
1057
  Supplied parameter values or default values are filled into a copy of the template.
1049
1058
  ```
1050
1059
 
1051
- _See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/visualforce/component.ts)_
1060
+ _See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.2/src/commands/template/generate/visualforce/component.ts)_
1052
1061
 
1053
1062
  ## `sf template generate visualforce page`
1054
1063
 
@@ -1099,6 +1108,6 @@ FLAG DESCRIPTIONS
1099
1108
  The name can be up to 40 characters and must start with a letter.
1100
1109
  ```
1101
1110
 
1102
- _See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/visualforce/page.ts)_
1111
+ _See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.2/src/commands/template/generate/visualforce/page.ts)_
1103
1112
 
1104
1113
  <!-- commandsstop -->
@@ -1,10 +1,14 @@
1
1
  # summary
2
2
 
3
- Generate a UI bundle.
3
+ Generate a UI bundle, which contains the code and metadata to build a UI experience that uses non-native Salesforce frameworks, such as React.
4
4
 
5
5
  # description
6
6
 
7
- Generates a UI bundle in the specified directory or the current working directory. The UI bundle files are created in a folder with the designated name. UI bundle files must be contained in a parent directory called "uiBundles" 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.
7
+ 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.
8
+
9
+ These 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.
10
+
11
+ Use 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.
8
12
 
9
13
  # examples
10
14
 
@@ -16,13 +20,13 @@ Generates a UI bundle in the specified directory or the current working director
16
20
 
17
21
  <%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic
18
22
 
19
- - Generate the UI bundle in the "force-app/main/default/uiBundles" directory:
23
+ - Generate the React-based UI bundle in the "force-app/main/default/uiBundles" directory:
20
24
 
21
- <%= config.bin %> <%= command.id %> --name MyUiBundle --output-dir force-app/main/default/uiBundles
25
+ <%= config.bin %> <%= command.id %> --name MyUiBundle --template reactbasic --output-dir force-app/main/default/uiBundles
22
26
 
23
27
  # flags.name.summary
24
28
 
25
- Name of the generated UI bundle.
29
+ API name of the generated UI bundle.
26
30
 
27
31
  # flags.name.description
28
32
 
@@ -30,7 +34,7 @@ This name can contain only underscores and alphanumeric characters, and must be
30
34
 
31
35
  # flags.template.summary
32
36
 
33
- Template to use for file creation.
37
+ Template to use when creating the files for a specific UI framework.
34
38
 
35
39
  # flags.template.description
36
40
 
@@ -46,17 +50,17 @@ If not specified, the label is derived from the name.
46
50
 
47
51
  # flags.output-dir.summary
48
52
 
49
- Directory for saving the created files.
53
+ Directory into which the files are created.
50
54
 
51
55
  # flags.output-dir.description
52
56
 
53
57
  The location can be an absolute path or relative to the current working directory.
54
58
 
55
- **Important:** The generator 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>".
59
+ If 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.
60
+
61
+ **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>".
56
62
 
57
63
  **Examples:**
58
64
 
59
65
  - "--output-dir force-app/main/default" → Creates a UI bundle at "force-app/main/default/uiBundles/MyUiBundle/"
60
66
  - "--output-dir force-app/main/default/uiBundles" → Creates a UI bundle at "force-app/main/default/uiBundles/MyUiBundle/" (no change)
61
-
62
- If 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.
@@ -503,6 +503,159 @@
503
503
  "site:digital-experience:generate:template"
504
504
  ]
505
505
  },
506
+ "template:generate:analytics:template": {
507
+ "aliases": [
508
+ "force:analytics:template:create",
509
+ "analytics:generate:template"
510
+ ],
511
+ "args": {},
512
+ "deprecateAliases": true,
513
+ "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.",
514
+ "examples": [
515
+ "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"
516
+ ],
517
+ "flags": {
518
+ "json": {
519
+ "description": "Format output as json.",
520
+ "helpGroup": "GLOBAL",
521
+ "name": "json",
522
+ "allowNo": false,
523
+ "type": "boolean"
524
+ },
525
+ "flags-dir": {
526
+ "helpGroup": "GLOBAL",
527
+ "name": "flags-dir",
528
+ "summary": "Import flag values from a directory.",
529
+ "hasDynamicHelp": false,
530
+ "multiple": false,
531
+ "type": "option"
532
+ },
533
+ "output-dir": {
534
+ "aliases": [
535
+ "outputdir"
536
+ ],
537
+ "char": "d",
538
+ "deprecateAliases": true,
539
+ "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
540
+ "name": "output-dir",
541
+ "summary": "Directory for saving the created files.",
542
+ "default": ".",
543
+ "hasDynamicHelp": false,
544
+ "multiple": false,
545
+ "type": "option"
546
+ },
547
+ "api-version": {
548
+ "aliases": [
549
+ "apiversion"
550
+ ],
551
+ "deprecateAliases": true,
552
+ "description": "Override the api version used for api requests made by this command",
553
+ "name": "api-version",
554
+ "hasDynamicHelp": false,
555
+ "multiple": false,
556
+ "type": "option"
557
+ },
558
+ "name": {
559
+ "aliases": [
560
+ "templatename"
561
+ ],
562
+ "char": "n",
563
+ "deprecateAliases": true,
564
+ "name": "name",
565
+ "required": true,
566
+ "summary": "Name of the Analytics template.",
567
+ "hasDynamicHelp": false,
568
+ "multiple": false,
569
+ "type": "option"
570
+ },
571
+ "loglevel": {
572
+ "deprecated": {
573
+ "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."
574
+ },
575
+ "hidden": true,
576
+ "name": "loglevel",
577
+ "hasDynamicHelp": false,
578
+ "multiple": false,
579
+ "type": "option"
580
+ }
581
+ },
582
+ "hasDynamicHelp": false,
583
+ "hiddenAliases": [],
584
+ "id": "template:generate:analytics:template",
585
+ "pluginAlias": "@salesforce/plugin-templates",
586
+ "pluginName": "@salesforce/plugin-templates",
587
+ "pluginType": "core",
588
+ "strict": true,
589
+ "summary": "Generate a simple Analytics template.",
590
+ "enableJsonFlag": true,
591
+ "isESM": true,
592
+ "relativePath": [
593
+ "lib",
594
+ "commands",
595
+ "template",
596
+ "generate",
597
+ "analytics",
598
+ "template.js"
599
+ ],
600
+ "aliasPermutations": [
601
+ "force:analytics:template:create",
602
+ "analytics:force:template:create",
603
+ "analytics:template:force:create",
604
+ "analytics:template:create:force",
605
+ "force:template:analytics:create",
606
+ "template:force:analytics:create",
607
+ "template:analytics:force:create",
608
+ "template:analytics:create:force",
609
+ "force:template:create:analytics",
610
+ "template:force:create:analytics",
611
+ "template:create:force:analytics",
612
+ "template:create:analytics:force",
613
+ "force:analytics:create:template",
614
+ "analytics:force:create:template",
615
+ "analytics:create:force:template",
616
+ "analytics:create:template:force",
617
+ "force:create:analytics:template",
618
+ "create:force:analytics:template",
619
+ "create:analytics:force:template",
620
+ "create:analytics:template:force",
621
+ "force:create:template:analytics",
622
+ "create:force:template:analytics",
623
+ "create:template:force:analytics",
624
+ "create:template:analytics:force",
625
+ "analytics:generate:template",
626
+ "generate:analytics:template",
627
+ "generate:template:analytics",
628
+ "analytics:template:generate",
629
+ "template:analytics:generate",
630
+ "template:generate:analytics"
631
+ ],
632
+ "permutations": [
633
+ "template:generate:analytics:template",
634
+ "generate:template:analytics:template",
635
+ "generate:analytics:template:template",
636
+ "generate:analytics:template:template",
637
+ "template:analytics:generate:template",
638
+ "analytics:template:generate:template",
639
+ "analytics:generate:template:template",
640
+ "analytics:generate:template:template",
641
+ "template:analytics:template:generate",
642
+ "analytics:template:template:generate",
643
+ "analytics:template:template:generate",
644
+ "analytics:template:generate:template",
645
+ "template:generate:template:analytics",
646
+ "generate:template:template:analytics",
647
+ "generate:template:template:analytics",
648
+ "generate:template:analytics:template",
649
+ "template:template:generate:analytics",
650
+ "template:template:generate:analytics",
651
+ "template:generate:template:analytics",
652
+ "template:generate:analytics:template",
653
+ "template:template:analytics:generate",
654
+ "template:template:analytics:generate",
655
+ "template:analytics:template:generate",
656
+ "template:analytics:generate:template"
657
+ ]
658
+ },
506
659
  "template:generate:flexipage": {
507
660
  "aliases": [],
508
661
  "args": {},
@@ -686,159 +839,6 @@
686
839
  "flexipage:generate:template"
687
840
  ]
688
841
  },
689
- "template:generate:analytics:template": {
690
- "aliases": [
691
- "force:analytics:template:create",
692
- "analytics:generate:template"
693
- ],
694
- "args": {},
695
- "deprecateAliases": true,
696
- "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.",
697
- "examples": [
698
- "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"
699
- ],
700
- "flags": {
701
- "json": {
702
- "description": "Format output as json.",
703
- "helpGroup": "GLOBAL",
704
- "name": "json",
705
- "allowNo": false,
706
- "type": "boolean"
707
- },
708
- "flags-dir": {
709
- "helpGroup": "GLOBAL",
710
- "name": "flags-dir",
711
- "summary": "Import flag values from a directory.",
712
- "hasDynamicHelp": false,
713
- "multiple": false,
714
- "type": "option"
715
- },
716
- "output-dir": {
717
- "aliases": [
718
- "outputdir"
719
- ],
720
- "char": "d",
721
- "deprecateAliases": true,
722
- "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
723
- "name": "output-dir",
724
- "summary": "Directory for saving the created files.",
725
- "default": ".",
726
- "hasDynamicHelp": false,
727
- "multiple": false,
728
- "type": "option"
729
- },
730
- "api-version": {
731
- "aliases": [
732
- "apiversion"
733
- ],
734
- "deprecateAliases": true,
735
- "description": "Override the api version used for api requests made by this command",
736
- "name": "api-version",
737
- "hasDynamicHelp": false,
738
- "multiple": false,
739
- "type": "option"
740
- },
741
- "name": {
742
- "aliases": [
743
- "templatename"
744
- ],
745
- "char": "n",
746
- "deprecateAliases": true,
747
- "name": "name",
748
- "required": true,
749
- "summary": "Name of the Analytics template.",
750
- "hasDynamicHelp": false,
751
- "multiple": false,
752
- "type": "option"
753
- },
754
- "loglevel": {
755
- "deprecated": {
756
- "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."
757
- },
758
- "hidden": true,
759
- "name": "loglevel",
760
- "hasDynamicHelp": false,
761
- "multiple": false,
762
- "type": "option"
763
- }
764
- },
765
- "hasDynamicHelp": false,
766
- "hiddenAliases": [],
767
- "id": "template:generate:analytics:template",
768
- "pluginAlias": "@salesforce/plugin-templates",
769
- "pluginName": "@salesforce/plugin-templates",
770
- "pluginType": "core",
771
- "strict": true,
772
- "summary": "Generate a simple Analytics template.",
773
- "enableJsonFlag": true,
774
- "isESM": true,
775
- "relativePath": [
776
- "lib",
777
- "commands",
778
- "template",
779
- "generate",
780
- "analytics",
781
- "template.js"
782
- ],
783
- "aliasPermutations": [
784
- "force:analytics:template:create",
785
- "analytics:force:template:create",
786
- "analytics:template:force:create",
787
- "analytics:template:create:force",
788
- "force:template:analytics:create",
789
- "template:force:analytics:create",
790
- "template:analytics:force:create",
791
- "template:analytics:create:force",
792
- "force:template:create:analytics",
793
- "template:force:create:analytics",
794
- "template:create:force:analytics",
795
- "template:create:analytics:force",
796
- "force:analytics:create:template",
797
- "analytics:force:create:template",
798
- "analytics:create:force:template",
799
- "analytics:create:template:force",
800
- "force:create:analytics:template",
801
- "create:force:analytics:template",
802
- "create:analytics:force:template",
803
- "create:analytics:template:force",
804
- "force:create:template:analytics",
805
- "create:force:template:analytics",
806
- "create:template:force:analytics",
807
- "create:template:analytics:force",
808
- "analytics:generate:template",
809
- "generate:analytics:template",
810
- "generate:template:analytics",
811
- "analytics:template:generate",
812
- "template:analytics:generate",
813
- "template:generate:analytics"
814
- ],
815
- "permutations": [
816
- "template:generate:analytics:template",
817
- "generate:template:analytics:template",
818
- "generate:analytics:template:template",
819
- "generate:analytics:template:template",
820
- "template:analytics:generate:template",
821
- "analytics:template:generate:template",
822
- "analytics:generate:template:template",
823
- "analytics:generate:template:template",
824
- "template:analytics:template:generate",
825
- "analytics:template:template:generate",
826
- "analytics:template:template:generate",
827
- "analytics:template:generate:template",
828
- "template:generate:template:analytics",
829
- "generate:template:template:analytics",
830
- "generate:template:template:analytics",
831
- "generate:template:analytics:template",
832
- "template:template:generate:analytics",
833
- "template:template:generate:analytics",
834
- "template:generate:template:analytics",
835
- "template:generate:analytics:template",
836
- "template:template:analytics:generate",
837
- "template:template:analytics:generate",
838
- "template:analytics:template:generate",
839
- "template:analytics:generate:template"
840
- ]
841
- },
842
842
  "template:generate:lightning:app": {
843
843
  "aliases": [
844
844
  "force:lightning:app:create",
@@ -1913,18 +1913,16 @@
1913
1913
  "project:generate:template"
1914
1914
  ]
1915
1915
  },
1916
- "template:generate:static-resource": {
1916
+ "template:generate:ui-bundle": {
1917
1917
  "aliases": [
1918
- "force:staticresource:create",
1919
- "static-resource:generate"
1918
+ "ui-bundle:generate"
1920
1919
  ],
1921
1920
  "args": {},
1922
- "deprecateAliases": true,
1923
- "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.",
1921
+ "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.",
1924
1922
  "examples": [
1925
- "Generate the metadata file for a static resource called MyResource in the current directory:\n<%= config.bin %> <%= command.id %> --name MyResource",
1926
- "Similar to previous example, but specifies a MIME type of application/json:\n<%= config.bin %> <%= command.id %> --name MyResource --type application/json",
1927
- "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"
1923
+ "Generate a UI bundle called MyUiBundle in the current directory:\n<%= config.bin %> <%= command.id %> --name MyUiBundle",
1924
+ "Generate a React-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic",
1925
+ "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"
1928
1926
  ],
1929
1927
  "flags": {
1930
1928
  "json": {
@@ -1943,76 +1941,63 @@
1943
1941
  "type": "option"
1944
1942
  },
1945
1943
  "name": {
1946
- "aliases": [
1947
- "resourcename"
1948
- ],
1949
1944
  "char": "n",
1950
- "deprecateAliases": true,
1951
1945
  "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.",
1952
1946
  "name": "name",
1953
1947
  "required": true,
1954
- "summary": "Name of the generated static resource.",
1948
+ "summary": "API name of the generated UI bundle.",
1955
1949
  "hasDynamicHelp": false,
1956
1950
  "multiple": false,
1957
1951
  "type": "option"
1958
1952
  },
1959
- "type": {
1960
- "aliases": [
1961
- "contenttype"
1953
+ "template": {
1954
+ "char": "t",
1955
+ "description": "Supplied parameter values or default values are filled into a copy of the template.",
1956
+ "name": "template",
1957
+ "summary": "Template to use when creating the files for a specific UI framework.",
1958
+ "default": "default",
1959
+ "hasDynamicHelp": false,
1960
+ "multiple": false,
1961
+ "options": [
1962
+ "default",
1963
+ "reactbasic"
1962
1964
  ],
1963
- "deprecateAliases": true,
1964
- "description": "Must be a valid MIME type such as application/json, application/javascript, application/zip, text/plain, text/css, etc.",
1965
- "name": "type",
1966
- "summary": "Content type (mime type) of the generated static resource.",
1967
- "default": "application/zip",
1965
+ "type": "option"
1966
+ },
1967
+ "label": {
1968
+ "char": "l",
1969
+ "description": "If not specified, the label is derived from the name.",
1970
+ "name": "label",
1971
+ "summary": "Master label for the UI bundle.",
1968
1972
  "hasDynamicHelp": false,
1969
1973
  "multiple": false,
1970
1974
  "type": "option"
1971
1975
  },
1972
1976
  "output-dir": {
1973
- "aliases": [
1974
- "outputdir"
1975
- ],
1976
1977
  "char": "d",
1977
- "deprecateAliases": true,
1978
- "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
1978
+ "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)",
1979
1979
  "name": "output-dir",
1980
- "summary": "Directory for saving the created files.",
1981
- "default": ".",
1980
+ "summary": "Directory into which the files are created.",
1982
1981
  "hasDynamicHelp": false,
1983
1982
  "multiple": false,
1984
1983
  "type": "option"
1985
1984
  },
1986
1985
  "api-version": {
1987
- "aliases": [
1988
- "apiversion"
1989
- ],
1990
- "deprecateAliases": true,
1991
1986
  "description": "Override the api version used for api requests made by this command",
1992
1987
  "name": "api-version",
1993
1988
  "hasDynamicHelp": false,
1994
1989
  "multiple": false,
1995
1990
  "type": "option"
1996
- },
1997
- "loglevel": {
1998
- "deprecated": {
1999
- "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."
2000
- },
2001
- "hidden": true,
2002
- "name": "loglevel",
2003
- "hasDynamicHelp": false,
2004
- "multiple": false,
2005
- "type": "option"
2006
1991
  }
2007
1992
  },
2008
1993
  "hasDynamicHelp": false,
2009
1994
  "hiddenAliases": [],
2010
- "id": "template:generate:static-resource",
1995
+ "id": "template:generate:ui-bundle",
2011
1996
  "pluginAlias": "@salesforce/plugin-templates",
2012
1997
  "pluginName": "@salesforce/plugin-templates",
2013
1998
  "pluginType": "core",
2014
1999
  "strict": true,
2015
- "summary": "Generate a static resource.",
2000
+ "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.",
2016
2001
  "enableJsonFlag": true,
2017
2002
  "isESM": true,
2018
2003
  "relativePath": [
@@ -2020,38 +2005,34 @@
2020
2005
  "commands",
2021
2006
  "template",
2022
2007
  "generate",
2023
- "static-resource",
2008
+ "ui-bundle",
2024
2009
  "index.js"
2025
2010
  ],
2026
2011
  "aliasPermutations": [
2027
- "force:staticresource:create",
2028
- "staticresource:force:create",
2029
- "staticresource:create:force",
2030
- "force:create:staticresource",
2031
- "create:force:staticresource",
2032
- "create:staticresource:force",
2033
- "static-resource:generate",
2034
- "generate:static-resource"
2012
+ "ui-bundle:generate",
2013
+ "generate:ui-bundle"
2035
2014
  ],
2036
2015
  "permutations": [
2037
- "template:generate:static-resource",
2038
- "generate:template:static-resource",
2039
- "generate:static-resource:template",
2040
- "template:static-resource:generate",
2041
- "static-resource:template:generate",
2042
- "static-resource:generate:template"
2016
+ "template:generate:ui-bundle",
2017
+ "generate:template:ui-bundle",
2018
+ "generate:ui-bundle:template",
2019
+ "template:ui-bundle:generate",
2020
+ "ui-bundle:template:generate",
2021
+ "ui-bundle:generate:template"
2043
2022
  ]
2044
2023
  },
2045
- "template:generate:ui-bundle": {
2024
+ "template:generate:static-resource": {
2046
2025
  "aliases": [
2047
- "ui-bundle:generate"
2026
+ "force:staticresource:create",
2027
+ "static-resource:generate"
2048
2028
  ],
2049
2029
  "args": {},
2050
- "description": "Generates a UI bundle in the specified directory or the current working directory. The UI bundle files are created in a folder with the designated name. UI bundle files must be contained in a parent directory called \"uiBundles\" 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.",
2030
+ "deprecateAliases": true,
2031
+ "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.",
2051
2032
  "examples": [
2052
- "Generate a UI bundle called MyUiBundle in the current directory:\n<%= config.bin %> <%= command.id %> --name MyUiBundle",
2053
- "Generate a React-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic",
2054
- "Generate the UI bundle in the \"force-app/main/default/uiBundles\" directory:\n<%= config.bin %> <%= command.id %> --name MyUiBundle --output-dir force-app/main/default/uiBundles"
2033
+ "Generate the metadata file for a static resource called MyResource in the current directory:\n<%= config.bin %> <%= command.id %> --name MyResource",
2034
+ "Similar to previous example, but specifies a MIME type of application/json:\n<%= config.bin %> <%= command.id %> --name MyResource --type application/json",
2035
+ "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"
2055
2036
  ],
2056
2037
  "flags": {
2057
2038
  "json": {
@@ -2070,63 +2051,76 @@
2070
2051
  "type": "option"
2071
2052
  },
2072
2053
  "name": {
2054
+ "aliases": [
2055
+ "resourcename"
2056
+ ],
2073
2057
  "char": "n",
2058
+ "deprecateAliases": true,
2074
2059
  "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.",
2075
2060
  "name": "name",
2076
2061
  "required": true,
2077
- "summary": "Name of the generated UI bundle.",
2062
+ "summary": "Name of the generated static resource.",
2078
2063
  "hasDynamicHelp": false,
2079
2064
  "multiple": false,
2080
2065
  "type": "option"
2081
2066
  },
2082
- "template": {
2083
- "char": "t",
2084
- "description": "Supplied parameter values or default values are filled into a copy of the template.",
2085
- "name": "template",
2086
- "summary": "Template to use for file creation.",
2087
- "default": "default",
2088
- "hasDynamicHelp": false,
2089
- "multiple": false,
2090
- "options": [
2091
- "default",
2092
- "reactbasic"
2067
+ "type": {
2068
+ "aliases": [
2069
+ "contenttype"
2093
2070
  ],
2094
- "type": "option"
2095
- },
2096
- "label": {
2097
- "char": "l",
2098
- "description": "If not specified, the label is derived from the name.",
2099
- "name": "label",
2100
- "summary": "Master label for the UI bundle.",
2071
+ "deprecateAliases": true,
2072
+ "description": "Must be a valid MIME type such as application/json, application/javascript, application/zip, text/plain, text/css, etc.",
2073
+ "name": "type",
2074
+ "summary": "Content type (mime type) of the generated static resource.",
2075
+ "default": "application/zip",
2101
2076
  "hasDynamicHelp": false,
2102
2077
  "multiple": false,
2103
2078
  "type": "option"
2104
2079
  },
2105
2080
  "output-dir": {
2081
+ "aliases": [
2082
+ "outputdir"
2083
+ ],
2106
2084
  "char": "d",
2107
- "description": "The location can be an absolute path or relative to the current working directory.\n\n**Important:** The generator 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)\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.",
2085
+ "deprecateAliases": true,
2086
+ "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
2108
2087
  "name": "output-dir",
2109
2088
  "summary": "Directory for saving the created files.",
2089
+ "default": ".",
2110
2090
  "hasDynamicHelp": false,
2111
2091
  "multiple": false,
2112
2092
  "type": "option"
2113
2093
  },
2114
2094
  "api-version": {
2095
+ "aliases": [
2096
+ "apiversion"
2097
+ ],
2098
+ "deprecateAliases": true,
2115
2099
  "description": "Override the api version used for api requests made by this command",
2116
2100
  "name": "api-version",
2117
2101
  "hasDynamicHelp": false,
2118
2102
  "multiple": false,
2119
2103
  "type": "option"
2104
+ },
2105
+ "loglevel": {
2106
+ "deprecated": {
2107
+ "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."
2108
+ },
2109
+ "hidden": true,
2110
+ "name": "loglevel",
2111
+ "hasDynamicHelp": false,
2112
+ "multiple": false,
2113
+ "type": "option"
2120
2114
  }
2121
2115
  },
2122
2116
  "hasDynamicHelp": false,
2123
2117
  "hiddenAliases": [],
2124
- "id": "template:generate:ui-bundle",
2118
+ "id": "template:generate:static-resource",
2125
2119
  "pluginAlias": "@salesforce/plugin-templates",
2126
2120
  "pluginName": "@salesforce/plugin-templates",
2127
2121
  "pluginType": "core",
2128
2122
  "strict": true,
2129
- "summary": "Generate a UI bundle.",
2123
+ "summary": "Generate a static resource.",
2130
2124
  "enableJsonFlag": true,
2131
2125
  "isESM": true,
2132
2126
  "relativePath": [
@@ -2134,20 +2128,26 @@
2134
2128
  "commands",
2135
2129
  "template",
2136
2130
  "generate",
2137
- "ui-bundle",
2131
+ "static-resource",
2138
2132
  "index.js"
2139
2133
  ],
2140
2134
  "aliasPermutations": [
2141
- "ui-bundle:generate",
2142
- "generate:ui-bundle"
2135
+ "force:staticresource:create",
2136
+ "staticresource:force:create",
2137
+ "staticresource:create:force",
2138
+ "force:create:staticresource",
2139
+ "create:force:staticresource",
2140
+ "create:staticresource:force",
2141
+ "static-resource:generate",
2142
+ "generate:static-resource"
2143
2143
  ],
2144
2144
  "permutations": [
2145
- "template:generate:ui-bundle",
2146
- "generate:template:ui-bundle",
2147
- "generate:ui-bundle:template",
2148
- "template:ui-bundle:generate",
2149
- "ui-bundle:template:generate",
2150
- "ui-bundle:generate:template"
2145
+ "template:generate:static-resource",
2146
+ "generate:template:static-resource",
2147
+ "generate:static-resource:template",
2148
+ "template:static-resource:generate",
2149
+ "static-resource:template:generate",
2150
+ "static-resource:generate:template"
2151
2151
  ]
2152
2152
  },
2153
2153
  "template:generate:visualforce:component": {
@@ -2506,5 +2506,5 @@
2506
2506
  ]
2507
2507
  }
2508
2508
  },
2509
- "version": "56.13.1"
2509
+ "version": "56.13.2"
2510
2510
  }
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.13.1",
4
+ "version": "56.13.2",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/salesforcecli/plugin-templates/issues",
7
7
  "enableO11y": true,
@@ -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/56.13.1.crt",
256
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.13.1.sig"
255
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.13.2.crt",
256
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.13.2.sig"
257
257
  }
258
258
  }