@salesforce/vite-plugin-webapp-experimental 0.2.0

package/README.md

@@ -0,0 +1,3 @@
+# @salesforce/vite-plugin-webapp-experimental
+
+Vite plugin for Salesforce Web Applications

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import type { Plugin } from "vite";
+export interface PluginOptions {
+    /** Salesforce org alias */
+    orgAlias?: string;
+    /** Enable verbose logging */
+    debug?: boolean;
+}
+export default function webappsPlugin(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":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAiB,MAAM,MAAM,CAAC;AAUlD,MAAM,WAAW,aAAa;IAC7B,2BAA2B;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,KAAK,CAAC,EAAE,OAAO,CAAC;CAChB;AAID,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,OAAO,GAAE,aAAkB,GAAG,MAAM,CAoIzE"}

package/dist/index.js

@@ -0,0 +1,109 @@
+import { loadManifest, getOrgInfo } from "@salesforce/webapp-experimental/app";
+import { createProxyHandler } from "@salesforce/webapp-experimental/proxy";
+import { getBasePath, getCodeBuilderBasePath, getPort, getDevServerTarget, DEFAULT_API_VERSION, DEFAULT_PORT, } from "./utils.js";
+const codeBuilderProxyUrl = process.env.CODE_BUILDER_FRAMEWORK_PROXY_URI;
+export default function webappsPlugin(options = {}) {
+    const proxyOptions = {
+        debug: options.debug ?? false,
+    };
+    let orgInfo;
+    let manifest;
+    let proxyHandler;
+    const getBasePathBound = (mode) => getBasePath(mode, codeBuilderProxyUrl, getPort());
+    return {
+        name: "@salesforce/vite-plugin-webapp-experimental",
+        async config(_config, env) {
+            // Note: At this stage we may not have the correct manifest path yet,
+            // so we only load the org info to get the API version
+            // Development server configuration
+            let version;
+            try {
+                orgInfo = await getOrgInfo(options.orgAlias);
+                version = orgInfo?.apiVersion || DEFAULT_API_VERSION;
+                if (options.debug) {
+                    console.log(`[webapps-plugin] Using Salesforce API version: ${version}`);
+                }
+            }
+            catch {
+                version = DEFAULT_API_VERSION;
+            }
+            const isCodeBuilder = !!codeBuilderProxyUrl;
+            const define = {
+                __SF_API_VERSION__: JSON.stringify(version),
+                __SF_SERVER_BASE_PATH__: JSON.stringify(""),
+            };
+            if (isCodeBuilder && env.mode !== "production") {
+                const basePath = getCodeBuilderBasePath(codeBuilderProxyUrl, getPort());
+                define["__SF_SERVER_BASE_PATH__"] = JSON.stringify(basePath);
+            }
+            return {
+                define,
+                base: getBasePath(env.mode, codeBuilderProxyUrl, getPort()),
+                server: {
+                    port: getPort(),
+                    // Code Builder specific configuration
+                    ...(isCodeBuilder && {
+                        // Allow any host to connect to the dev server
+                        allowedHosts: true,
+                        strictPort: true, // Fail if port is already occupied
+                    }),
+                },
+            };
+        },
+        async configResolved(config) {
+            try {
+                manifest = await loadManifest(`${config.root ?? process.cwd()}/webapp.json`);
+                const target = getDevServerTarget(codeBuilderProxyUrl, config.server.port ?? DEFAULT_PORT);
+                proxyHandler = createProxyHandler(manifest, orgInfo, target, getBasePathBound(config.mode), proxyOptions);
+            }
+            catch (error) {
+                console.error(`[webapps-plugin] Initialization failed:`, error);
+            }
+        },
+        configureServer(server) {
+            // Add middleware to handle all requests (API, rewrites, redirects, and dev server forwarding)
+            // Must run BEFORE Vite's internal middlewares (hence not returning a post-hook function)
+            server.middlewares.use(async (req, res, next) => {
+                // Let proxy handler handle all requests
+                if (proxyHandler) {
+                    try {
+                        await proxyHandler(req, res, next);
+                    }
+                    catch (error) {
+                        console.error("[webapps-plugin] Proxy handler error:", error);
+                        next();
+                    }
+                }
+                else {
+                    // Only return 503 for Salesforce API requests when handler not initialized
+                    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 }) {
+            // Watch for manifest changes and reload
+            if (file.endsWith("webapp.json")) {
+                const updatedManifest = await loadManifest(file);
+                if (updatedManifest) {
+                    // Update context with new manifest
+                    manifest = updatedManifest;
+                    // Recreate proxy handler with updated appContext
+                    const target = getDevServerTarget(codeBuilderProxyUrl, server.config.server.port ?? DEFAULT_PORT);
+                    proxyHandler = createProxyHandler(manifest, orgInfo, target, getBasePathBound(server.config.mode), proxyOptions);
+                    server.ws.send({
+                        type: "full-reload",
+                        path: "*",
+                    });
+                }
+            }
+        },
+    };
+}

package/dist/utils.d.ts

@@ -0,0 +1,13 @@
+export declare const DEFAULT_PORT = 5173;
+export declare const DEFAULT_API_VERSION = "65.0";
+/**
+ * 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 getBasePath(mode: string, codeBuilderProxyUrl: string | undefined, 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,eAAO,MAAM,YAAY,OAAO,CAAC;AACjC,eAAO,MAAM,mBAAmB,SAAS,CAAC;AAE1C;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAQ7E;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,UAY9F;AAED,wBAAgB,kBAAkB,CAAC,mBAAmB,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,UAMvF;AAED,wBAAgB,OAAO,WAEtB"}

package/dist/utils.js

@@ -0,0 +1,38 @@
+export const DEFAULT_PORT = 5173;
+export const DEFAULT_API_VERSION = "65.0";
+/**
+ * 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 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}`; // Default code builder proxy path
+    }
+}
+export function getBasePath(mode, codeBuilderProxyUrl, port) {
+    const isProd = mode === "production";
+    if (isProd) {
+        return "/lwr/application/ai/vibe-static";
+    }
+    if (!codeBuilderProxyUrl) {
+        return "";
+    }
+    // Code Builder: extract path from proxy URI and include port
+    return getCodeBuilderBasePath(codeBuilderProxyUrl, port);
+}
+export function getDevServerTarget(codeBuilderProxyUrl, port) {
+    if (codeBuilderProxyUrl) {
+        return getCodeBuilderBasePath(codeBuilderProxyUrl, port);
+    }
+    return `http://localhost:${port}`;
+}
+export function getPort() {
+    return parseInt(process.env.SF_WEBAPP_PORT || DEFAULT_PORT.toString(), 10);
+}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@salesforce/vite-plugin-webapp-experimental",
+  "version": "0.2.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo",
+    "dev": "tsc --build --watch"
+  },
+  "dependencies": {
+    "@salesforce/webapp-experimental": "^0.2.0"
+  },
+  "devDependencies": {
+    "vite": "^7.0.0",
+    "vitest": "^4.0.6"
+  },
+  "peerDependencies": {
+    "vite": "^7.0.0"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "gitHead": "a806910fe9c132ad3cc0ca63302072b0076699b9"
+}