@salesforce/vite-plugin-ui-bundle 1.117.2

package/LICENSE.txt

@@ -0,0 +1,82 @@
+Terms of Use
+
+Copyright 2026 Salesforce, Inc. All rights reserved.
+
+These Terms of Use govern the download, installation, and/or use of this
+software provided by Salesforce, Inc. ("Salesforce") (the "Software"), were
+last updated on April 15, 2025, and constitute a legally binding
+agreement between you and Salesforce. If you do not agree to these Terms of
+Use, do not install or use the Software.
+
+Salesforce grants you a worldwide, non-exclusive, no-charge, royalty-free
+copyright license to reproduce, prepare derivative works of, publicly
+display, publicly perform, sublicense, and distribute the Software and
+derivative works subject to these Terms. These Terms shall be included in
+all copies or substantial portions of the Software.
+
+Subject to the limited rights expressly granted hereunder, Salesforce
+reserves all rights, title, and interest in and to all intellectual
+property subsisting in the Software. No rights are granted to you hereunder
+other than as expressly set forth herein. Users residing in countries on
+the United States Office of Foreign Assets Control sanction list, or which
+are otherwise subject to a US export embargo, may not use the Software.
+
+Implementation of the Software may require development work, for which you
+are responsible. The Software may contain bugs, errors and
+incompatibilities and is made available on an AS IS basis without support,
+updates, or service level commitments.
+
+Salesforce reserves the right at any time to modify, suspend, or
+discontinue, the Software (or any part thereof) with or without notice. You
+agree that Salesforce shall not be liable to you or to any third party for
+any modification, suspension, or discontinuance.
+
+You agree to defend Salesforce against any claim, demand, suit or
+proceeding made or brought against Salesforce by a third party arising out
+of or accruing from (a) your use of the Software, and (b) any application
+you develop with the Software that infringes any copyright, trademark,
+trade secret, trade dress, patent, or other intellectual property right of
+any person or defames any person or violates their rights of publicity or
+privacy (each a "Claim Against Salesforce"), and will indemnify Salesforce
+from any damages, attorney fees, and costs finally awarded against
+Salesforce as a result of, or for any amounts paid by Salesforce under a
+settlement approved by you in writing of, a Claim Against Salesforce,
+provided Salesforce (x) promptly gives you written notice of the Claim
+Against Salesforce, (y) gives you sole control of the defense and
+settlement of the Claim Against Salesforce (except that you may not settle
+any Claim Against Salesforce unless it unconditionally releases Salesforce
+of all liability), and (z) gives you all reasonable assistance, at your
+expense.
+
+WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE SOFTWARE IS NOT
+SUPPORTED AND IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED. IN NO EVENT SHALL SALESFORCE HAVE ANY LIABILITY FOR ANY DAMAGES,
+INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL, INCIDENTAL,
+PUNITIVE, OR CONSEQUENTIAL DAMAGES, OR DAMAGES BASED ON LOST PROFITS, DATA,
+OR USE, IN CONNECTION WITH THE SOFTWARE, HOWEVER CAUSED AND WHETHER IN
+CONTRACT, TORT, OR UNDER ANY OTHER THEORY OF LIABILITY, WHETHER OR NOT YOU
+HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+These Terms of Use shall be governed exclusively by the internal laws of
+the State of California, without regard to its conflicts of laws
+rules. Each party hereby consents to the exclusive jurisdiction of the
+state and federal courts located in San Francisco County, California to
+adjudicate any dispute arising out of or relating to these Terms of Use and
+the download, installation, and/or use of the Software. Except as expressly
+stated herein, these Terms of Use constitute the entire agreement between
+the parties, and supersede all prior and contemporaneous agreements,
+proposals, or representations, written or oral, concerning their subject
+matter. No modification, amendment, or waiver of any provision of these
+Terms of Use shall be effective unless it is by an update to these Terms of
+Use that Salesforce makes available, or is in writing and signed by the
+party against whom the modification, amendment, or waiver is to be
+asserted.
+
+Data Privacy: Salesforce may collect, process, and store device,
+system, and other information related to your use of the Software. This
+information includes, but is not limited to, IP address, user metrics, and
+other data ("Usage Data"). Salesforce may use Usage Data for analytics,
+product development, and marketing purposes. You acknowledge that files
+generated in conjunction with the Software may contain sensitive or
+confidential data, and you are solely responsible for anonymizing and
+protecting such data.

package/README.md

@@ -0,0 +1,3 @@
+# @salesforce/vite-plugin-ui-bundle
+
+Vite plugin for Salesforce UI Bundles

package/dist/babel/reactDesignTimeLocatorBabelPlugin.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) 2026, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+declare const reactDesignTimeLocatorBabelPlugin: (api: object, options: Record<string, any> | null | undefined, dirname: string) => {
+    name: string;
+    visitor: {
+        JSXElement(this: import('@babel/core').PluginPass, path: any, state: any): void;
+    };
+};
+export default reactDesignTimeLocatorBabelPlugin;
+//# sourceMappingURL=reactDesignTimeLocatorBabelPlugin.d.ts.map

package/dist/babel/reactDesignTimeLocatorBabelPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reactDesignTimeLocatorBabelPlugin.d.ts","sourceRoot":"","sources":["../../src/babel/reactDesignTimeLocatorBabelPlugin.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AA4CH,QAAA,MAAM,iCAAiC;;;iEAiCnB,GAAG,SAAS,GAAG;;CA0EjC,CAAC;AAEH,eAAe,iCAAiC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import { Plugin } from 'vite';
+export interface PluginOptions {
+    /** Salesforce org alias */
+    orgAlias?: string;
+    /** Enable verbose logging */
+    debug?: boolean;
+    /**
+     * Enable design-time features (inject `data-source-file`, serve & inject design interactions script).
+     *
+     * Defaults to:
+     * - enabled when Vite `mode` is `"design"` (e.g. `vite --mode design`)
+     */
+    designMode?: boolean;
+    /**
+     * File path segments to exclude from design-time `data-source-file` injection.
+     * Files whose path contains any of these strings will be skipped entirely.
+     *
+     * @default ["/components/ui/"]
+     */
+    designModeExcludePaths?: string[];
+}
+export default function uiBundlePlugin(options?: PluginOptions): Plugin[];
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAQH,OAAO,KAAK,EAAqB,MAAM,EAAiB,MAAM,MAAM,CAAC;AAUrE,MAAM,WAAW,aAAa;IAC7B,2BAA2B;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;OAKG;IACH,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;CAClC;AAID,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,OAAO,GAAE,aAAkB,GAAG,MAAM,EAAE,CAyQ5E"}

package/dist/index.js

@@ -0,0 +1,334 @@
+import fs from "node:fs";
+import { loadManifest, getOrgInfo } from "@salesforce/ui-bundle/app";
+import { getDesignModeScriptContent } from "@salesforce/ui-bundle/design";
+import { createProxyHandler, injectLivePreviewScript } from "@salesforce/ui-bundle/proxy";
+import { declare } from "@babel/helper-plugin-utils";
+function resolveColumn(loc, babelCode, originalSource) {
+  if (!originalSource || !babelCode) return loc.column;
+  const babelLine = babelCode.split("\n")[loc.line - 1];
+  const originalLine = originalSource.split("\n")[loc.line - 1];
+  if (!babelLine || !originalLine) return loc.column;
+  const contentFromColumn = babelLine.slice(loc.column);
+  if (contentFromColumn) {
+    const idx = originalLine.indexOf(contentFromColumn);
+    if (idx >= 0) return idx;
+  }
+  const babelIndent = babelLine.length - babelLine.trimStart().length;
+  const originalIndent = originalLine.length - originalLine.trimStart().length;
+  const offset = babelIndent - originalIndent;
+  return Math.max(0, loc.column - offset);
+}
+const reactDesignTimeLocatorBabelPlugin = declare((api) => {
+  api.assertVersion(7);
+  const t = api.types;
+  function isReactFragmentName(nameNode) {
+    if (t.isJSXIdentifier(nameNode) && nameNode.name === "Fragment") return true;
+    if (t.isJSXMemberExpression(nameNode) && t.isJSXIdentifier(nameNode.object, { name: "React" }) && t.isJSXIdentifier(nameNode.property, { name: "Fragment" })) {
+      return true;
+    }
+    return false;
+  }
+  function hasAttr(openingElement, name) {
+    return openingElement.attributes.some((attr) => {
+      return t.isJSXAttribute(attr) && t.isJSXIdentifier(attr.name) && attr.name.name === name;
+    });
+  }
+  function addAttr(openingElement, name, value) {
+    if (hasAttr(openingElement, name)) return;
+    openingElement.attributes.push(
+      t.jsxAttribute(t.jsxIdentifier(name), t.stringLiteral(String(value)))
+    );
+  }
+  return {
+    name: "babel-plugin-react-design-time-locator",
+    visitor: {
+      JSXElement(path, state) {
+        const openingElement = path.node.openingElement;
+        if (isReactFragmentName(openingElement.name)) return;
+        if (!t.isJSXIdentifier(openingElement.name) && !t.isJSXMemberExpression(openingElement.name)) {
+          return;
+        }
+        let tagHead = "";
+        if (t.isJSXIdentifier(openingElement.name)) {
+          tagHead = openingElement.name.name;
+        } else if (t.isJSXMemberExpression(openingElement.name)) {
+          tagHead = openingElement.name.property?.name ?? "";
+        }
+        if (!tagHead) return;
+        const filename = state?.file?.opts?.filename;
+        if (!filename || filename.includes("node_modules")) return;
+        const excludePaths = state.opts?.excludePaths ?? [];
+        if (excludePaths.some((p) => filename.includes(p))) return;
+        const children = path.node.children ?? [];
+        const relevantChildren = children.filter((child) => {
+          return !(t.isJSXText(child) && child.value.trim() === "");
+        });
+        let textType = "none";
+        if (relevantChildren.length === 1) {
+          const child = relevantChildren[0];
+          if (t.isJSXText(child)) {
+            textType = "static";
+          } else if (t.isJSXExpressionContainer(child)) {
+            textType = "dynamic";
+          } else {
+            textType = "element";
+          }
+        } else if (relevantChildren.length > 1) {
+          textType = "mixed";
+        }
+        const loc = path.node.loc;
+        if (loc?.start) {
+          const originalSource = state.opts?.originalSource;
+          const column = resolveColumn(loc.start, state.file?.code, originalSource);
+          const source = `${filename}:${loc.start.line}:${column}`;
+          addAttr(openingElement, "data-source-file", source);
+        }
+        addAttr(openingElement, "data-text-type", textType);
+      }
+    }
+  };
+});
+const DEFAULT_PORT = 5173;
+const DEFAULT_API_VERSION = "65.0";
+function getCodeBuilderBasePath(proxyUri, port) {
+  try {
+    const url = new URL(proxyUri.replace("{{port}}", port.toString()));
+    return url.pathname;
+  } catch (error) {
+    console.error("Failed to parse CODE_BUILDER_FRAMEWORK_PROXY_URI:", error);
+    return `/absproxy/${port}`;
+  }
+}
+function getDevServerTarget(codeBuilderProxyUrl2, port) {
+  if (codeBuilderProxyUrl2) {
+    return getCodeBuilderBasePath(codeBuilderProxyUrl2, port);
+  }
+  return `http://localhost:${port}`;
+}
+function getPort() {
+  return parseInt(process.env.SF_UIBUNDLE_PORT || DEFAULT_PORT.toString(), 10);
+}
+const codeBuilderProxyUrl = process.env.CODE_BUILDER_FRAMEWORK_PROXY_URI;
+function uiBundlePlugin(options = {}) {
+  const proxyOptions = {
+    debug: options.debug ?? false
+  };
+  let orgInfo;
+  let manifest;
+  let environment;
+  let proxyHandler;
+  let designModeEnabled = options.designMode ?? false;
+  const corePlugin = {
+    name: "@salesforce/vite-plugin-ui-bundle:core",
+    enforce: "pre",
+    async config(_config, env) {
+      let version;
+      try {
+        orgInfo = await getOrgInfo(options.orgAlias);
+        version = orgInfo?.apiVersion || DEFAULT_API_VERSION;
+        if (options.debug) {
+          console.log(`[ui-bundle-plugin] Using Salesforce API version: ${version}`);
+        }
+      } catch {
+        version = DEFAULT_API_VERSION;
+      }
+      const isCodeBuilder = !!codeBuilderProxyUrl;
+      const define = {
+        __SF_API_VERSION__: JSON.stringify(version)
+      };
+      if (env.mode !== "production") {
+        const basePath = isCodeBuilder ? getCodeBuilderBasePath(codeBuilderProxyUrl, getPort()) : "/";
+        environment = { basePath, apiPath: basePath };
+      }
+      return {
+        define,
+        base: "./",
+        server: {
+          port: getPort(),
+          // Code Builder specific configuration
+          ...isCodeBuilder && {
+            allowedHosts: true,
+            strictPort: true
+          }
+        }
+      };
+    },
+    async configResolved(config) {
+      try {
+        const rootPath = config.root ?? process.cwd();
+        manifest = await loadManifest(`${rootPath}/ui-bundle.json`);
+        const target = getDevServerTarget(codeBuilderProxyUrl, config.server.port ?? DEFAULT_PORT);
+        proxyHandler = createProxyHandler(
+          manifest,
+          orgInfo,
+          target,
+          environment?.basePath,
+          proxyOptions
+        );
+      } catch (error) {
+        console.error(`[ui-bundle-plugin] Initialization failed:`, error);
+      }
+    },
+    configureServer(server) {
+      server.middlewares.use(async (req, res, next) => {
+        if (proxyHandler) {
+          try {
+            await proxyHandler(req, res, next);
+          } catch (error) {
+            console.error("[ui-bundle-plugin] Proxy handler error:", error);
+            next();
+          }
+        } else {
+          if (req.url?.startsWith("/services")) {
+            res.writeHead(503, { "Content-Type": "application/json" });
+            res.end(
+              JSON.stringify({
+                error: "SERVICE_UNAVAILABLE",
+                message: "Proxy not initialized."
+              })
+            );
+            return;
+          }
+          next();
+        }
+      });
+    },
+    async handleHotUpdate({ file, server }) {
+      if (file.endsWith("ui-bundle.json")) {
+        const updatedManifest = await loadManifest(file);
+        if (updatedManifest) {
+          manifest = updatedManifest;
+          const target = getDevServerTarget(
+            codeBuilderProxyUrl,
+            server.config.server.port ?? DEFAULT_PORT
+          );
+          proxyHandler = createProxyHandler(
+            manifest,
+            orgInfo,
+            target,
+            environment?.basePath,
+            proxyOptions
+          );
+          server.ws.send({
+            type: "full-reload",
+            path: "*"
+          });
+        }
+      }
+    },
+    transformIndexHtml: {
+      order: "pre",
+      handler(html) {
+        if (environment) {
+          html = injectLivePreviewScript(html);
+        }
+        const tags = [];
+        if (environment) {
+          const baseHref = environment.basePath.endsWith("/") ? environment.basePath : `${environment.basePath}/`;
+          tags.push({
+            tag: "base",
+            attrs: { href: baseHref },
+            injectTo: "head-prepend"
+          });
+          tags.push({
+            tag: "script",
+            children: `(function() { globalThis.SFDC_ENV = { basePath: "${environment.basePath}", apiPath: "${environment.apiPath}" }; })();`,
+            injectTo: "body"
+          });
+        }
+        return { html, tags };
+      }
+    }
+  };
+  const designPlugin = {
+    name: "@salesforce/vite-plugin-ui-bundle:design",
+    enforce: "pre",
+    config(_config, env) {
+      designModeEnabled = options.designMode ?? env.mode === "design";
+    },
+    configureServer(server) {
+      server.middlewares.use(async (req, res, next) => {
+        if (!designModeEnabled) {
+          next();
+          return;
+        }
+        const urlPath = stripUrlQuery(req.url);
+        if (urlPath === "/_sfdc/design-mode-interactions.js") {
+          try {
+            const script = getDesignModeScriptContent();
+            if (script !== null) {
+              res.setHeader("Content-Type", "application/javascript");
+              res.setHeader("Cache-Control", "no-cache");
+              res.end(script);
+              return;
+            }
+            console.error(
+              `[ui-bundle-plugin] Design mode script not found. Run 'npm run build:design' in @salesforce/ui-bundle.`
+            );
+            res.writeHead(404);
+            res.end("Design mode script not found");
+            return;
+          } catch (error) {
+            console.error("[ui-bundle-plugin] Error serving design mode script:", error);
+            res.writeHead(500);
+            res.end("Error loading design mode script");
+            return;
+          }
+        }
+        next();
+      });
+    },
+    async transform(code, id) {
+      if (!designModeEnabled) return null;
+      const filepath = id.split("?", 1)[0] ?? id;
+      const isTsx = filepath.endsWith(".tsx");
+      const isJsx = filepath.endsWith(".jsx");
+      if (!isTsx && !isJsx) return null;
+      if (filepath.includes("node_modules")) return null;
+      const excludePaths = options.designModeExcludePaths ?? ["/components/ui/"];
+      if (excludePaths.some((p) => filepath.includes(p))) return null;
+      let originalSource;
+      try {
+        originalSource = fs.readFileSync(filepath, "utf-8");
+      } catch {
+      }
+      const { transformAsync } = await import("@babel/core");
+      const result = await transformAsync(code, {
+        filename: filepath,
+        babelrc: false,
+        configFile: false,
+        sourceMaps: true,
+        parserOpts: {
+          sourceType: "module",
+          plugins: isTsx ? ["jsx", "typescript"] : ["jsx"]
+        },
+        plugins: [[reactDesignTimeLocatorBabelPlugin, { excludePaths, originalSource }]]
+      });
+      if (!result?.code) return null;
+      return { code: result.code, map: result.map };
+    },
+    transformIndexHtml: {
+      order: "pre",
+      handler(html) {
+        const tags = [];
+        if (designModeEnabled) {
+          tags.push({
+            tag: "script",
+            attrs: { src: "/_sfdc/design-mode-interactions.js" },
+            injectTo: "body"
+          });
+        }
+        return { html, tags };
+      }
+    }
+  };
+  return [designPlugin, corePlugin];
+}
+function stripUrlQuery(url) {
+  if (!url) return "";
+  const queryIndex = url.indexOf("?");
+  return queryIndex === -1 ? url : url.slice(0, queryIndex);
+}
+export {
+  uiBundlePlugin as default
+};

package/dist/utils.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Copyright (c) 2026, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+export declare const DEFAULT_PORT = 5173;
+export declare const DEFAULT_API_VERSION = "65.0";
+export declare const DEFAULT_NAMESPACE = "c";
+/**
+ * Get the app name from a *.uibundle-meta.xml file in the root path.
+ * Falls back to the directory name if no matching file is found.
+ *
+ * @param rootPath - The root directory to search for the uibundle-meta.xml file
+ * @returns The app name
+ */
+export declare function getAppName(rootPath: string): string;
+/**
+ * Get the namespace for the app.
+ * Currently returns the default namespace ("c") since rootPath points to the
+ * UI Bundle directory (where vite.config lives), not the sfdx project root.
+ *
+ * @returns The namespace (currently always "c")
+ */
+export declare function getNamespace(): string;
+/**
+ * Calculate the code builder base path from the proxy URI (CODE_BUILDER_FRAMEWORK_PROXY_URI) and dev server port
+ * @param proxyUri - The full proxy URI (e.g., https://name.iad.001.sf.code-builder.platform.salesforce.com/absproxy/{{port}})
+ * @param port - The port number to replace {{port}} with (e.g., "5173")
+ * @returns The parsed path with port (e.g., /absproxy/5173/)
+ */
+export declare function getCodeBuilderBasePath(proxyUri: string, port: number): string;
+export declare function getDevServerTarget(codeBuilderProxyUrl: string | undefined, port: number): string;
+export declare function getPort(): number;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,eAAO,MAAM,YAAY,OAAO,CAAC;AACjC,eAAO,MAAM,mBAAmB,SAAS,CAAC;AAC1C,eAAO,MAAM,iBAAiB,MAAM,CAAC;AAErC;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAYnD;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAGrC;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAQ7E;AAED,wBAAgB,kBAAkB,CAAC,mBAAmB,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,UAMvF;AAED,wBAAgB,OAAO,WAEtB"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@salesforce/vite-plugin-ui-bundle",
+  "description": "Vite plugin for Salesforce UI Bundles",
+  "version": "1.117.2",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "vite build",
+    "clean": "rm -rf dist",
+    "dev": "vite build --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  },
+  "dependencies": {
+    "@babel/core": "^7.28.4",
+    "@babel/helper-plugin-utils": "^7.28.3",
+    "@salesforce/ui-bundle": "^1.117.2"
+  },
+  "devDependencies": {
+    "@types/babel__core": "^7.20.5",
+    "@types/babel__helper-plugin-utils": "^7.10.3",
+    "vite": "^7.0.0",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^4.0.6"
+  },
+  "peerDependencies": {
+    "vite": "^7.0.0"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}