@W-23296058 - feat: UI Bundle upload command by william-xie-sf · Pull Request #62 · salesforcecli/plugin-ui-bundle-dev

william-xie-sf · 2026-07-10T20:12:10Z

What does this PR do?

SDD-led implementation of the new sf ui-bundle upload command which is a foundational piece of the new Salesforce Pages feature

What issues does this PR fix or reference?

@W-23296058@

…gin-command

…tract

ankit-patro-sf · 2026-07-13T20:53:51Z

+    try {
+      response = await orgConnection.request<{ jobId: string; status: string; message?: string }>({
+        method: 'POST',
+        url: `${orgConnection.baseUrl()}/connect/ui-bundle/deployments`,


Pin the API version. baseUrl() → v.0, but endpoint is minVersion 262 (v62.0) per section 2.5,
and we never pin apiVersion. On an org defaulting below 62.0 this silently 404s as an opaque
error. Pin v62.0 explicitly + clear 404 message.

This is intended as a failure case since we aren't going to support orgs running < 262 anyway. We should just match the version that corresponds to the target org.

You should add the --api-version flag (https://github.com/salesforcecli/plugin-data/blob/6d78b50ded33d2944c6e253d0d8fd14387d52645/src/commands/data/search.ts#L3
3-L61) and just do a check for >262
If a user tries to use an older api version, throw a meaningful error

ankit-patro-sf · 2026-07-13T20:54:08Z

+        url: `${orgConnection.baseUrl()}/connect/ui-bundle/deployments`,
+        body: form.getBuffer(),
+        headers: form.getHeaders(),
+      });


Multipart POST has no end-to-end coverage. NUT tests this.skip() on an env var never set; unit
tests stub request and only assert the input buffer. Nothing verifies jsforce transmits
form.getBuffer() as raw multipart (the L122 comment's exact worry). A nock/http-level test
capturing outbound bytes would close this.

Once the full Connect API changes are in we can wire a full E2E NUT on a real org rather than a mocked test. For now will keep as-is.

…age over SDR

jshackell-sfdc

See my suggestions and comments!

jshackell-sfdc · 2026-07-14T15:03:28Z

+
+# flags.use-salesforce-pages.summary
+
+Toggle whether this UI Bundle should be uploaded to Salesforce Pages. Currently this is a required flag as only Salesforce Pages uploads are supported.


Suggested change

Toggle whether this UI Bundle should be uploaded to Salesforce Pages. Currently this is a required flag as only Salesforce Pages uploads are supported.

Upload UI Bundle to Salesforce Pages. This is a required flag as only Salesforce Pages uploads are currently supported.

Are you soon going to add more options to where the bundle can be uploaded? It seems odd to add a required flag for something that has no other options, you know?

For example, you could make Salesforce Pages the default upload location, and for now have no flag because it's not needed. Then, when you add new locations, add a flag like --upload-location, and include options such as "salesforce-pages", "other-location", etc. Just a thought. I should have said something like this earlier, but I was looking only at the name of the flag, not how it work, sorry.

Yes it's a little weird right now. The intent down the line is to support both "Pages" and "Non-Pages" upload paths. This flag may change shape as well depending on the second look when that work.

For now we intend to be very specific for the initial Salesforce Pages feature

Side note - applied all your suggestions manually so your existing suggestion comments here are linking to the wrong sections. But I have applied all that you suggested @jshackell-sfdc

iowillhoit · 2026-07-14T16:42:23Z

+  }
+  // An empty directory produces no zip entries; reject rather than POST an empty bundle.
+  if (fileCount === 0) {
+    throw new SfError(messages.getMessage('error.bundle-dir-empty'), 'UiBundleUploadValidationError');


FYI: you can use the messages helper messages.createError() instead

iowillhoit · 2026-07-15T19:12:44Z

+    const apiVersionExplicit = flags['api-version'] !== undefined && !metadata.flags['api-version']?.setFromDefault;
+    if (apiVersionExplicit && parseInt(flags['api-version']!, 10) < MINIMUM_SUPPORTED_API_VERSION) {
+      throw messages.createError('error.uiBundleUploadApiVersionError', [
+        flags['api-version']!,
+        String(MINIMUM_SUPPORTED_API_VERSION),
+      ]);
+    }
+
+    // Step 1: Resolve the org connection.
+    const orgConnection = flags['target-org'].getConnection(flags['api-version']);


Here is an example in plugin-packaging on checking for a minimum version https://github.com/salesforcecli/plugin-packaging/blob/4c6e1686a11066919811f78e637f8e89aaba8289/src/commands/package/install.ts#L131-L136

william-xie-sf and others added 8 commits July 8, 2026 19:39

feat: initial commit of new ui bundle upload command

3d956e5

feat: add preview mode and update pages flag

5328b2f

feat: add compression capability

308b956

fix: nut failure for ERR_INVALID_ARG_TYPE

836e87e

fix: messaging and nuts

99df85f

feat: update connect API shape and output messaging

40eec94

Merge branch 'main' into t/ui-bundles-miyo/w-23296058/sdd-new-cli-plu…

a30028f

…gin-command

fix: remove identifying parts of spec

8d182d2

sgurudu-gh reviewed Jul 13, 2026

View reviewed changes

Comment thread src/commands/ui-bundle/upload.ts Outdated

Comment thread src/commands/ui-bundle/upload.ts Outdated

Comment thread src/commands/ui-bundle/upload.ts Outdated

fix: symlink and dotfile handling; integrate with new Connect API con…

48e582d

…tract

ankit-patro-sf reviewed Jul 13, 2026

View reviewed changes

sgurudu-gh approved these changes Jul 13, 2026

View reviewed changes

refactor: address unused keys and errors; lightweight jszip direct us…

4900177

…age over SDR

william-xie-sf marked this pull request as ready for review July 13, 2026 22:30

william-xie-sf requested a review from a team as a code owner July 13, 2026 22:30

fix: update help message to specificaly call out zip file

640d830

jshackell-sfdc reviewed Jul 14, 2026

View reviewed changes

iowillhoit reviewed Jul 14, 2026

View reviewed changes

william-xie-sf added 2 commits July 14, 2026 13:10

fix: messaging and command API version checking

7d3dcc2

fix: error message prefxies

45bef97

iowillhoit reviewed Jul 15, 2026

View reviewed changes

william-xie-sf and others added 2 commits July 15, 2026 13:04

refactor: change API version check

8303005

fix: revert message update

5914904

iowillhoit approved these changes Jul 15, 2026

View reviewed changes

william-xie-sf merged commit 01253d8 into main Jul 15, 2026
13 checks passed

william-xie-sf deleted the t/ui-bundles-miyo/w-23296058/sdd-new-cli-plugin-command branch July 15, 2026 20:23


		# flags.use-salesforce-pages.summary

		Toggle whether this UI Bundle should be uploaded to Salesforce Pages. Currently this is a required flag as only Salesforce Pages uploads are supported.

	Toggle whether this UI Bundle should be uploaded to Salesforce Pages. Currently this is a required flag as only Salesforce Pages uploads are supported.
	Upload UI Bundle to Salesforce Pages. This is a required flag as only Salesforce Pages uploads are currently supported.

Uh oh!

Conversation

william-xie-sf commented Jul 10, 2026

What does this PR do?

What issues does this PR fix or reference?

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jshackell-sfdc left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants