Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 56 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ $ npm install -g @salesforce/cli
$ sf COMMAND
running command...
$ sf (--version|-v)
@salesforce/cli/2.160.1 linux-x64 node-v26.13.1
@salesforce/cli/2.160.2 linux-x64 node-v26.13.1
$ sf --help [COMMAND]
USAGE
$ sf COMMAND
Expand Down Expand Up @@ -11650,7 +11650,7 @@ FLAG DESCRIPTIONS
directory.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/analytics/template.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.7.0/src/commands/template/generate/analytics/template.ts)_

## `sf template generate apex class`

Expand Down Expand Up @@ -11712,7 +11712,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/apex/class.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.7.0/src/commands/template/generate/apex/class.ts)_

## `sf template generate apex trigger`

Expand Down Expand Up @@ -11782,7 +11782,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/apex/trigger.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.7.0/src/commands/template/generate/apex/trigger.ts)_

## `sf template generate digital-experience site`

Expand Down Expand Up @@ -11836,7 +11836,7 @@ FLAG DESCRIPTIONS
project, defaults to the current directory.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/digital-experience/site.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.7.0/src/commands/template/generate/digital-experience/site.ts)_

## `sf template generate flexipage`

Expand Down Expand Up @@ -11918,7 +11918,7 @@ FLAG DESCRIPTIONS
'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/flexipage/index.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.7.0/src/commands/template/generate/flexipage/index.ts)_

## `sf template generate lightning-out`

Expand All @@ -11928,10 +11928,13 @@ Generate the required metadata to scaffold a Lightning Out 2.0 app.
USAGE
$ sf template generate lightning-out [--json] [--flags-dir <value>] [--app-name <value>] [--eca-name <value>] [--runtime
LWR_CORE|CLWR] [--host-domains <value>...] [--components <value>...] [--eca-contact-email <value>]
[--eca-callback-url <value>] [--definition-file <value>] [-d <value>]
[--eca-callback-url <value>] [--site <value>] [--access guest|authenticated] [--definition-file <value>] [-d
<value>]

FLAGS
-d, --output-dir=<value> [default: .] Directory for saving the created files.
--access=<option> Type of Experience Cloud site user who accesses a CLWR app.
<options: guest|authenticated>
--app-name=<value> Developer name of the new Lightning Out 2.0 app.
--components=<value>... Name of a Lightning web component exposed by the app. Repeat the flag to specify more
than one. Replaces, rather than merges with, any components in the --definition-file.
Expand All @@ -11940,12 +11943,10 @@ FLAGS
--eca-callback-url=<value> OAuth callback URL for the External Client Application.
--eca-contact-email=<value> Contact email for the External Client Application.
--eca-name=<value> Developer name of the External Client Application associated with the app.
--host-domains=<value>... HTTP or HTTPS origin of an external host page that embeds the app. Repeat the flag to
specify more than one. Replaces, rather than merges with, any hostDomains in the
--definition-file. For CLWR apps, host domains are used only for CORS, which
authenticated users need. Set up framing for the site in Experience Builder.
--host-domains=<value>... HTTP or HTTPS origin of an external host page that embeds the app.
--runtime=<option> Runtime that serves the app.
<options: LWR_CORE|CLWR>
--site=<value> Name of the Experience Cloud site to link a CLWR app to.

GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
Expand All @@ -11959,8 +11960,11 @@ DESCRIPTION
This command gets you started by generating the seven metadata artifact types that a Lightning Out 2.0 app requires
into your Salesforce DX project: LightningOutApp, MyDomain and Security settings, one CorsWhitelistOrigin per host
domain, and the three External Client Application OAuth components (ExternalClientApplication,
ExtlClntAppGlobalOauthSettings, ExtlClntAppOauthSettings). The command only generates files. It doesn't deploy any
metadata to an org.
ExtlClntAppGlobalOauthSettings, ExtlClntAppOauthSettings). For a CLWR app with --access guest, the command generates
only the LightningOutApp, because guest users don't log in. The command only generates files. It doesn't deploy any
metadata to an org. When you deploy the generated LightningOutApp, its components and host domains replace the app's
existing ones in the org, including any added in Setup. List every component and host domain the app needs, not just
the new ones.

Inputs can come from a --definition-file JSON, individual flags, or both. Flag values take precedence over the file on
a per-key basis. The command validates the types of definition-file fields; the underlying generator performs the
Expand All @@ -11980,9 +11984,15 @@ EXAMPLES

$ sf template generate lightning-out --definition-file lo-def.json --output-dir force-app/main/default

Generate a CLWR app for an Experience Cloud site using a definition file:
Generate a CLWR app for authenticated users (the default) of the Experience Cloud site named "My Site", using a
definition file for the other values:

$ sf template generate lightning-out --runtime CLWR --site "My Site" --definition-file lo-def.json

Generate a CLWR app for guest users of the Experience Cloud site named "My Site":

$ sf template generate lightning-out --runtime CLWR --definition-file lo-def.json
$ sf template generate lightning-out --app-name MyLoApp --runtime CLWR --access guest --site "My Site" \
--components c/myHeader

Generate the app using most of the values from a definition file, but the --host-domains value overrides its
equivalent in the file:
Expand All @@ -11995,13 +12005,31 @@ FLAG DESCRIPTIONS
The location can be an absolute path or relative to the current working directory. The default is the current
directory.

--access=guest|authenticated Type of Experience Cloud site user who accesses a CLWR app.

Valid values are "authenticated" (default) and "guest". With "authenticated", the command generates the app plus the
External Client Application, CORS, and MyDomain and Security settings that site users need to log in. With "guest",
the command generates only the app, because guest users don't log in. Used only with --runtime CLWR.

--host-domains=<value>... HTTP or HTTPS origin of an external host page that embeds the app.

Repeat the flag to specify more than one. Replaces, rather than merges with, any hostDomains in the
--definition-file. Not used for CLWR with --access guest.

--runtime=LWR_CORE|CLWR Runtime that serves the app.

LWR_CORE serves the app from your Salesforce org to authenticated users. CLWR serves it from an Experience Cloud
site to guest and authenticated users. After you deploy a CLWR app, link it to your site in Setup.
site to guest and authenticated users. For CLWR, specify the site with --site and the type of user with --access.

--site=<value> Name of the Experience Cloud site to link a CLWR app to.

Use the site name shown on the All Sites page in Setup, not its URL path prefix. The site must be active and use the
Lightning Out (LWR) or Build Your Own (LWR) template. Used only with --runtime CLWR. To deploy an app that's linked
to a site, use API version 69.0 or later. This flag is required for CLWR unless the project's sourceApiVersion is
below 69.0, because deploying a CLWR app without a site at 69.0 or later removes the app's existing site link.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/lightning-out/index.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.7.0/src/commands/template/generate/lightning-out/index.ts)_

## `sf template generate lightning app`

Expand Down Expand Up @@ -12059,7 +12087,7 @@ FLAG DESCRIPTIONS
field in the DX project's "sfdx-project.json" file.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/lightning/app.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.7.0/src/commands/template/generate/lightning/app.ts)_

## `sf template generate lightning component`

Expand Down Expand Up @@ -12136,7 +12164,7 @@ FLAG DESCRIPTIONS
field in the DX project's "sfdx-project.json" file.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/lightning/component.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.7.0/src/commands/template/generate/lightning/component.ts)_

## `sf template generate lightning event`

Expand Down Expand Up @@ -12194,7 +12222,7 @@ FLAG DESCRIPTIONS
field in the DX project's "sfdx-project.json" file.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/lightning/event.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.7.0/src/commands/template/generate/lightning/event.ts)_

## `sf template generate lightning interface`

Expand Down Expand Up @@ -12252,7 +12280,7 @@ FLAG DESCRIPTIONS
field in the DX project's "sfdx-project.json" file.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/lightning/interface.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.7.0/src/commands/template/generate/lightning/interface.ts)_

## `sf template generate lightning test`

Expand Down Expand Up @@ -12310,7 +12338,7 @@ FLAG DESCRIPTIONS
field in the DX project's "sfdx-project.json" file.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/lightning/test.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.7.0/src/commands/template/generate/lightning/test.ts)_

## `sf template generate project`

Expand Down Expand Up @@ -12444,7 +12472,7 @@ FLAG DESCRIPTIONS
server-side type stripping.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/project/index.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.7.0/src/commands/template/generate/project/index.ts)_

## `sf template generate static-resource`

Expand Down Expand Up @@ -12507,7 +12535,7 @@ FLAG DESCRIPTIONS
etc.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/static-resource/index.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.7.0/src/commands/template/generate/static-resource/index.ts)_

## `sf template generate ui-bundle`

Expand Down Expand Up @@ -12602,7 +12630,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/ui-bundle/index.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.7.0/src/commands/template/generate/ui-bundle/index.ts)_

## `sf template generate ui-embedding`

Expand Down Expand Up @@ -12681,7 +12709,7 @@ FLAG DESCRIPTIONS
(announced by screen readers).
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/ui-embedding/index.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.7.0/src/commands/template/generate/ui-embedding/index.ts)_

## `sf template generate visualforce component`

Expand Down Expand Up @@ -12738,7 +12766,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/visualforce/component.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.7.0/src/commands/template/generate/visualforce/component.ts)_

## `sf template generate visualforce page`

Expand Down Expand Up @@ -12789,7 +12817,7 @@ FLAG DESCRIPTIONS
The name can be up to 40 characters and must start with a letter.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.6.1/src/commands/template/generate/visualforce/page.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.7.0/src/commands/template/generate/visualforce/page.ts)_

## `sf update [CHANNEL]`

Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@salesforce/cli",
"description": "The Salesforce CLI",
"version": "2.160.1",
"version": "2.160.2",
"author": "Salesforce",
"bin": {
"sf": "./bin/run.js",
Expand Down Expand Up @@ -171,8 +171,8 @@
"@salesforce/plugin-schema": "4.0.17",
"@salesforce/plugin-settings": "3.0.28",
"@salesforce/plugin-sobject": "2.0.26",
"@salesforce/plugin-telemetry": "4.2.7",
"@salesforce/plugin-templates": "57.6.1",
"@salesforce/plugin-telemetry": "4.2.9",
"@salesforce/plugin-templates": "57.7.0",
"@salesforce/plugin-trust": "4.1.4",
"@salesforce/plugin-user": "6.0.13",
"@salesforce/sf-plugins-core": "13.0.9",
Expand Down
38 changes: 19 additions & 19 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2478,10 +2478,10 @@
js2xmlparser "^4.0.2"
tinyglobby "^0.2.17"

"@salesforce/plugin-telemetry@4.2.7":
version "4.2.7"
resolved "https://registry.yarnpkg.com/@salesforce/plugin-telemetry/-/plugin-telemetry-4.2.7.tgz#183e5a9bd3fd52ad05e895a7dd51107d1cb37b80"
integrity sha512-d1gXVwt4gEUedaHCu4CTna9iz4U3Yv0oITFQfYwylhl0poKmJfcCGP1Nj2gowAPN18WJtxgGUtElpgX9V4Fbfg==
"@salesforce/plugin-telemetry@4.2.9":
version "4.2.9"
resolved "https://registry.yarnpkg.com/@salesforce/plugin-telemetry/-/plugin-telemetry-4.2.9.tgz#343184267a31b10e2885493939e167b57b113dfe"
integrity sha512-Y4kSuTa4zQrXxsW9ox7hJyQahOn0mu63e+Ri4PcwtnItmosn212v5Bp38Z2A9ZPtazqPIRGcOMCzn4ZpnwtBOA==
dependencies:
"@oclif/core" "^5.0.0"
"@salesforce/core" "^9.0.0"
Expand All @@ -2491,14 +2491,14 @@
"@salesforce/ts-types" "^3.0.1"
debug "^4.4.3"

"@salesforce/plugin-templates@57.6.1":
version "57.6.1"
resolved "https://registry.yarnpkg.com/@salesforce/plugin-templates/-/plugin-templates-57.6.1.tgz#fa02aa1dc6963d63f5118cf88d95192abc0613af"
integrity sha512-44qL3aD5XMP3j/u551uYe79Vbrtq0brRVM41haMKwoNs1i3ig5dnmhxH0F1kINkgZMa3r7eqHxF3A4+D5IL+Yg==
"@salesforce/plugin-templates@57.7.0":
version "57.7.0"
resolved "https://registry.yarnpkg.com/@salesforce/plugin-templates/-/plugin-templates-57.7.0.tgz#d0adfc4a61d66da97a0abf2a3dfd83984712935b"
integrity sha512-hQbKvL6yBwufzpLiUxsjLHT5uujWeHbqt3WFL9utQdah0TDsVO3kGgEO2KCKc4DabQHsRzFTDG8Yi4aEuMTftg==
dependencies:
"@salesforce/core" "^9.2.0"
"@salesforce/sf-plugins-core" "^13.0.8"
"@salesforce/templates" "^66.19.0"
"@salesforce/templates" "^66.20.0"

"@salesforce/plugin-trust@4.1.4", "@salesforce/plugin-trust@^4.0.11":
version "4.1.4"
Expand Down Expand Up @@ -2617,19 +2617,19 @@
o11y_schema "^260.65.0"
proxy-agent "^6.5.0"

"@salesforce/templates@^66.19.0":
version "66.19.0"
resolved "https://registry.yarnpkg.com/@salesforce/templates/-/templates-66.19.0.tgz#4fda083542ec3343daf7de1d3cb091594ae9fff5"
integrity sha512-pvkQT//+NRUuia0e6HHTcUnoVNY00mDFGj2iZN4qGmaflKbgs8gVRIlefFRMsxnm4zookojqkdrwwyqT9Ob6wA==
"@salesforce/templates@^66.20.0":
version "66.20.1"
resolved "https://registry.yarnpkg.com/@salesforce/templates/-/templates-66.20.1.tgz#386f303f9dc7a9ccb000896f6afcfa10c19e6046"
integrity sha512-EyFxObd78EXON0uyk5wP94uO5OrK887Y5ccPqlO+3xI1tPbO6l6GE5HIYl8UgsP25PvJVQAtrDs+XtNEVcFXLA==
dependencies:
"@salesforce/kit" "^4.0.1"
"@salesforce/kit" "^4.0.9"
ejs "^3.1.10"
got "^11.8.6"
hpagent "^1.2.0"
mime-types "^3.0.2"
proxy-from-env "^1.1.0"
tar "^7.5.22"
tslib "^2.8.1"
tslib "^2.9.1"

"@salesforce/ts-sinon@^1.4.39":
version "1.4.39"
Expand Down Expand Up @@ -9962,10 +9962,10 @@ ts-retry-promise@^0.8.1:
resolved "https://registry.yarnpkg.com/ts-retry-promise/-/ts-retry-promise-0.8.1.tgz#ba90eb07cb03677fcbf78fe38e94c9183927e154"
integrity sha512-+AHPUmAhr5bSRRK5CurE9kNH8gZlEHnCgusZ0zy2bjfatUBDX0h6vGQjiT0YrGwSDwRZmU+bapeX6mj55FOPvg==

tslib@^2.0.0, tslib@^2.0.1, tslib@^2.0.3, tslib@^2.4.0, tslib@^2.5.0, tslib@^2.6.2, tslib@^2.7.0, tslib@^2.8.1:
version "2.8.1"
resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.8.1.tgz#612efe4ed235d567e8aba5f2a5fab70280ade83f"
integrity sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==
tslib@^2.0.0, tslib@^2.0.1, tslib@^2.0.3, tslib@^2.4.0, tslib@^2.5.0, tslib@^2.6.2, tslib@^2.7.0, tslib@^2.8.1, tslib@^2.9.1:
version "2.9.1"
resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.9.1.tgz#8986213ba2f17f38ba39a7c43d0e565a9134ff5f"
integrity sha512-a4Ux9VKuIMHsOS7ENbEq6hK2ZGYIT27Rtl0E4eD9KqwxhKiQeMZE/9xb3IdYwWaSOyIBQLExhQgXDTYoiCxnWA==

tuf-js@^4.1.0:
version "4.1.0"
Expand Down
Loading