@lwrjs/lwc-ssr 0.10.2 → 0.11.0-alpha.1

package/build/cjs/identity.cjs

@@ -10,12 +10,10 @@ __markAsModule(exports);
 __export(exports, {
   LWC_SSR_PREFIX: () => LWC_SSR_PREFIX,
   SSR_PROPS_ATTR: () => SSR_PROPS_ATTR,
-  SSR_PROPS_KEY: () => SSR_PROPS_KEY,
   getPropsId: () => getPropsId
 });
 var LWC_SSR_PREFIX = "@lwrjs/lwc-ssr/";
 var SSR_PROPS_ATTR = "data-lwr-props-id";
-var SSR_PROPS_KEY = "ssrProps";
 function getPropsId() {
   return `lwcprops${Math.floor(Math.random() * 65536).toString(16)}`;
 }

package/build/cjs/viewTransformer/amd-utils.cjs

@@ -89,20 +89,23 @@ async function getCode(runtimeEnvironment, lwrVersion, bundleSpecifier, included
     lwcSpecifier ? aliasLwcEngine(lwcSpecifier, LWC_SPECIFIERS) : ""
   ];
 }
-async function getBundle(specifier, moduleBundler, runtimeEnvironment) {
+async function getBundle(specifier, moduleBundler, runtimeEnvironment, runtimeParams) {
   if ((0, import_shared_utils.getFeatureFlags)().SSR_STATIC_BUNDLES) {
-    return buildBundle(specifier, moduleBundler, runtimeEnvironment);
+    return buildBundle(specifier, moduleBundler, runtimeEnvironment, runtimeParams);
   }
-  return bundle(specifier, moduleBundler, runtimeEnvironment, {appendExcludes: false, exclude: ["lwc"]});
+  return bundle(specifier, moduleBundler, runtimeEnvironment, runtimeParams, {
+    appendExcludes: false,
+    exclude: ["lwc"]
+  });
 }
-async function bundle(specifier, moduleBundler, runtimeEnvironment, bundleConfigOverrides) {
-  return await moduleBundler.getModuleBundle({specifier}, runtimeEnvironment, void 0, bundleConfigOverrides);
+async function bundle(specifier, moduleBundler, runtimeEnvironment, runtimeParams, bundleConfigOverrides) {
+  return await moduleBundler.getModuleBundle({specifier}, runtimeEnvironment, runtimeParams, bundleConfigOverrides);
 }
-async function bundleImports(bundleCode, imports = [], visited, moduleBundler, runtimeEnvironment) {
+async function bundleImports(bundleCode, imports = [], visited, moduleBundler, runtimeEnvironment, runtimeParams) {
   for (const {specifier} of imports) {
     if (!visited.has(specifier)) {
       visited.add(specifier);
-      const {code, bundleRecord, version} = await bundle(specifier, moduleBundler, runtimeEnvironment);
+      const {code, bundleRecord, version} = await bundle(specifier, moduleBundler, runtimeEnvironment, runtimeParams);
       let bundledCode;
       if (runtimeEnvironment.featureFlags?.EXPERIMENTAL_UNVERSIONED_ALIASES) {
         const versionedSpecifier = (0, import_shared_utils.getSpecifier)({specifier, version});
@@ -111,15 +114,15 @@ async function bundleImports(bundleCode, imports = [], visited, moduleBundler, r
       } else {
         bundledCode = code;
       }
-      bundleCode = await bundleImports(bundledCode, bundleRecord.imports, visited, moduleBundler, runtimeEnvironment) + bundleCode;
+      bundleCode = await bundleImports(bundledCode, bundleRecord.imports, visited, moduleBundler, runtimeEnvironment, runtimeParams) + bundleCode;
     }
   }
   return bundleCode;
 }
-async function buildBundle(ssrSpecifier, moduleBundler, runtimeEnvironment) {
+async function buildBundle(ssrSpecifier, moduleBundler, runtimeEnvironment, runtimeParams) {
   const rootSpecifier = ssrSpecifier.replace(import_identity.LWC_SSR_PREFIX, "");
-  const {code: _rootCode, bundleRecord: rootBundleRecord} = await bundle(rootSpecifier, moduleBundler, runtimeEnvironment);
-  let rootCode = await bundleImports(_rootCode, rootBundleRecord.imports, new Set(["lwc", rootSpecifier]), moduleBundler, runtimeEnvironment);
+  const {code: _rootCode, bundleRecord: rootBundleRecord} = await bundle(rootSpecifier, moduleBundler, runtimeEnvironment, runtimeParams);
+  let rootCode = await bundleImports(_rootCode, rootBundleRecord.imports, new Set(["lwc", rootSpecifier]), moduleBundler, runtimeEnvironment, runtimeParams);
   if (runtimeEnvironment.featureFlags?.EXPERIMENTAL_UNVERSIONED_ALIASES) {
     const aliasSpecifier = (0, import_shared_utils.getSpecifier)({
       specifier: rootSpecifier,
@@ -128,12 +131,12 @@ async function buildBundle(ssrSpecifier, moduleBundler, runtimeEnvironment) {
     const aliasCode = (0, import_shared_utils.createAmdAlias)(aliasSpecifier, rootSpecifier);
     rootCode = [aliasCode, rootCode].join("");
   }
-  const {code: lwcEngineCode, version: lwcVersion} = await bundle(LWC_SPECIFIERS.ssr, moduleBundler, runtimeEnvironment);
+  const {code: lwcEngineCode, version: lwcVersion} = await bundle(LWC_SPECIFIERS.ssr, moduleBundler, runtimeEnvironment, runtimeParams);
   const {
     bundleRecord,
     code: ssrCode,
     version: lwrVersion
-  } = await bundle(ssrSpecifier, moduleBundler, runtimeEnvironment, {
+  } = await bundle(ssrSpecifier, moduleBundler, runtimeEnvironment, runtimeParams, {
     appendExcludes: true,
     exclude: [LWC_SPECIFIERS.ssr, rootSpecifier]
   });

package/build/cjs/viewTransformer/index.cjs

@@ -32,12 +32,16 @@ var import_ssr_element = __toModule(require("./ssr-element.cjs"));
 function lwcSsrViewTransformer(options, {moduleBundler, resourceRegistry}) {
   return {
     name: "ssr-lwc-transformer",
-    async link(stringBuilder, viewContext, {customElements}) {
+    async link(stringBuilder, viewContext, metadata) {
       if (!viewContext.view.bootstrap?.ssr) {
         return {};
       }
       import_shared_utils.logger.debug("[lwcSsrViewTransformer] link");
       import_shared_utils.logger.verbose("[lwcSsrViewTransformer] link input", stringBuilder);
+      if (!metadata.ssrProps) {
+        metadata.ssrProps = {};
+      }
+      const {customElements, ssrProps} = metadata;
       const ssrModules = [];
       for (const [index, {tagName, location, props}] of customElements.entries()) {
         const isCsr = (0, import_shared_utils.isCsrIsland)(props);
@@ -58,7 +62,6 @@ function lwcSsrViewTransformer(options, {moduleBundler, resourceRegistry}) {
           });
         }
       }
-      const ssrProps = {};
       let ssrLinks = "";
       let pageTtl;
       await Promise.all(ssrModules.map(({index, specifier, tagName, props: rawProps = {}, startOffset, endOffset}) => {
@@ -93,9 +96,6 @@ function lwcSsrViewTransformer(options, {moduleBundler, resourceRegistry}) {
           import_shared_utils.logger.warn(`Server-side rendering for "${specifier}" failed. Falling back to client-side rendering. Reason: `, err.stack);
         });
       }));
-      if (Object.keys(ssrProps).length) {
-        stringBuilder.prependLeft(ssrModules[0].startOffset, `<script type="application/javascript">globalThis.LWR = globalThis.LWR || {};globalThis.LWR.${import_identity.SSR_PROPS_KEY} = ${JSON.stringify(ssrProps)};</script>`);
-      }
       if (ssrLinks) {
         const headIndex = stringBuilder.original.indexOf("</head>");
         if (headIndex >= 0) {

package/build/cjs/viewTransformer/ssr-element.cjs

@@ -39,12 +39,12 @@ async function ssrElement({specifier, props: templateProps}, moduleBundler, reso
     code,
     specifier: bundleSpecifier,
     version
-  } = format === "esm" ? await moduleBundler.getModuleBundle({specifier}, {...runtimeEnvironment, bundle: false}, void 0, {
+  } = format === "esm" ? await moduleBundler.getModuleBundle({specifier}, {...runtimeEnvironment, bundle: false}, runtimeParams, {
     exclude: [],
     alias: {
       lwc: "@lwc/engine-server"
     }
-  }) : await (0, import_amd_utils.getBundle)(specifier, moduleBundler, runtimeEnvironment);
+  }) : await (0, import_amd_utils.getBundle)(specifier, moduleBundler, runtimeEnvironment, runtimeParams);
   const context = {
     props: templateProps,
     params: runtimeParams.params || {},

package/build/es/identity.d.ts

@@ -1,5 +1,4 @@
 export declare const LWC_SSR_PREFIX = "@lwrjs/lwc-ssr/";
 export declare const SSR_PROPS_ATTR = "data-lwr-props-id";
-export declare const SSR_PROPS_KEY = "ssrProps";
 export declare function getPropsId(): string;
 //# sourceMappingURL=identity.d.ts.map

package/build/es/identity.js

@@ -1,6 +1,5 @@
 export const LWC_SSR_PREFIX = '@lwrjs/lwc-ssr/';
 export const SSR_PROPS_ATTR = 'data-lwr-props-id';
-export const SSR_PROPS_KEY = 'ssrProps';
 export function getPropsId() {
     return `lwcprops${Math.floor(Math.random() * 0x10000).toString(16)}`;
 }

package/build/es/viewTransformer/amd-utils.d.ts

@@ -1,7 +1,7 @@
-import type { BundleDefinition, PublicModuleBundler, PublicResourceRegistry, RuntimeEnvironment } from '@lwrjs/types';
+import type { BundleDefinition, PublicModuleBundler, PublicResourceRegistry, RuntimeEnvironment, RuntimeParams } from '@lwrjs/types';
 export declare function getCode(runtimeEnvironment: RuntimeEnvironment, lwrVersion: string, bundleSpecifier: string, includedModules: string[], resourceRegistry: PublicResourceRegistry): Promise<string[]>;
 type PartialBundleDefinition = Pick<BundleDefinition, 'bundleRecord' | 'code' | 'specifier' | 'version'>;
 export declare function getBundle(specifier: string, // e.g. "@lwrjs/lwc-ssr/root/component"
-moduleBundler: PublicModuleBundler, runtimeEnvironment: RuntimeEnvironment): Promise<PartialBundleDefinition>;
+moduleBundler: PublicModuleBundler, runtimeEnvironment: RuntimeEnvironment, runtimeParams: RuntimeParams): Promise<PartialBundleDefinition>;
 export {};
 //# sourceMappingURL=amd-utils.d.ts.map

package/build/es/viewTransformer/amd-utils.js

@@ -73,25 +73,28 @@ export async function getCode(runtimeEnvironment, lwrVersion, bundleSpecifier, i
     ];
 }
 export async function getBundle(specifier, // e.g. "@lwrjs/lwc-ssr/root/component"
-moduleBundler, runtimeEnvironment) {
+moduleBundler, runtimeEnvironment, runtimeParams) {
     if (getFeatureFlags().SSR_STATIC_BUNDLES) {
         // concatenate existing bundles SSGed at build time
-        return buildBundle(specifier, moduleBundler, runtimeEnvironment);
+        return buildBundle(specifier, moduleBundler, runtimeEnvironment, runtimeParams);
     }
     // create a new SSR bundle
     // "lwc" is aliased as "@lwc/engine-server" in the AMD worker code
-    return bundle(specifier, moduleBundler, runtimeEnvironment, { appendExcludes: false, exclude: ['lwc'] });
+    return bundle(specifier, moduleBundler, runtimeEnvironment, runtimeParams, {
+        appendExcludes: false,
+        exclude: ['lwc'],
+    });
 }
-async function bundle(specifier, moduleBundler, runtimeEnvironment, bundleConfigOverrides) {
-    return await moduleBundler.getModuleBundle({ specifier }, runtimeEnvironment, undefined, bundleConfigOverrides);
+async function bundle(specifier, moduleBundler, runtimeEnvironment, runtimeParams, bundleConfigOverrides) {
+    return await moduleBundler.getModuleBundle({ specifier }, runtimeEnvironment, runtimeParams, bundleConfigOverrides);
 }
 // Recursively bundle the static imports of a root bundle into a single bundle
-async function bundleImports(bundleCode, imports = [], visited, moduleBundler, runtimeEnvironment) {
+async function bundleImports(bundleCode, imports = [], visited, moduleBundler, runtimeEnvironment, runtimeParams) {
     for (const { specifier } of imports) {
         if (!visited.has(specifier)) {
             visited.add(specifier);
             // eslint-disable-next-line no-await-in-loop
-            const { code, bundleRecord, version } = await bundle(specifier, moduleBundler, runtimeEnvironment);
+            const { code, bundleRecord, version } = await bundle(specifier, moduleBundler, runtimeEnvironment, runtimeParams);
             let bundledCode;
             if (runtimeEnvironment.featureFlags?.EXPERIMENTAL_UNVERSIONED_ALIASES) {
                 const versionedSpecifier = getSpecifier({ specifier, version });
@@ -103,7 +106,7 @@ async function bundleImports(bundleCode, imports = [], visited, moduleBundler, r
             }
             bundleCode =
                 // eslint-disable-next-line no-await-in-loop
-                (await bundleImports(bundledCode, bundleRecord.imports, visited, moduleBundler, runtimeEnvironment)) + bundleCode;
+                (await bundleImports(bundledCode, bundleRecord.imports, visited, moduleBundler, runtimeEnvironment, runtimeParams)) + bundleCode;
         }
     }
     return bundleCode;
@@ -112,15 +115,15 @@ async function bundleImports(bundleCode, imports = [], visited, moduleBundler, r
 // - the root component bundle and static imports
 // - @lwc/engine-server
 // - the SSR bundle for the root specifier
-async function buildBundle(ssrSpecifier, moduleBundler, runtimeEnvironment) {
+async function buildBundle(ssrSpecifier, moduleBundler, runtimeEnvironment, runtimeParams) {
     // 1. Get the bundle for the root component, including all static dependencies
     const rootSpecifier = ssrSpecifier.replace(LWC_SSR_PREFIX, '');
-    const { code: _rootCode, bundleRecord: rootBundleRecord } = await bundle(rootSpecifier, moduleBundler, runtimeEnvironment);
+    const { code: _rootCode, bundleRecord: rootBundleRecord } = await bundle(rootSpecifier, moduleBundler, runtimeEnvironment, runtimeParams);
     let rootCode = await bundleImports(_rootCode, rootBundleRecord.imports, new Set(['lwc', rootSpecifier]), // visited (lwc is excluded)
-    moduleBundler, runtimeEnvironment);
+    moduleBundler, runtimeEnvironment, runtimeParams);
     // TODO: remove pending TD-0148452
     if (runtimeEnvironment.featureFlags?.EXPERIMENTAL_UNVERSIONED_ALIASES) {
-        // Create an AMD alias to the unversioned root module
+        // Create an AMD alias to the un-versioned root module
         // if the bundle-metadata for the module doesn't have a version, it will have /v/version-not-provided`
         const aliasSpecifier = getSpecifier({
             specifier: rootSpecifier,
@@ -130,10 +133,10 @@ async function buildBundle(ssrSpecifier, moduleBundler, runtimeEnvironment) {
         rootCode = [aliasCode, rootCode].join('');
     }
     // 2. Get the bundle for the LWC engine
-    const { code: lwcEngineCode, version: lwcVersion } = await bundle(LWC_SPECIFIERS.ssr, moduleBundler, runtimeEnvironment);
+    const { code: lwcEngineCode, version: lwcVersion } = await bundle(LWC_SPECIFIERS.ssr, moduleBundler, runtimeEnvironment, runtimeParams);
     // 3. Get the bundle for the SSR root component
     // Exclude the LWC engine and root component from this bundle. Use the pre-built bundles fetched above instead.
-    const { bundleRecord, code: ssrCode, version: lwrVersion, } = await bundle(ssrSpecifier, moduleBundler, runtimeEnvironment, {
+    const { bundleRecord, code: ssrCode, version: lwrVersion, } = await bundle(ssrSpecifier, moduleBundler, runtimeEnvironment, runtimeParams, {
         appendExcludes: true,
         exclude: [LWC_SPECIFIERS.ssr, rootSpecifier],
     });

package/build/es/viewTransformer/index.js

@@ -1,5 +1,5 @@
 import { HYDRATE_CLIENT_VALUE, HYDRATE_DIRECTIVE, isCsrIsland, isHydrateOnLoad, kebabCaseToModuleSpecifier, logger, shortestTtl, } from '@lwrjs/shared-utils';
-import { LWC_SSR_PREFIX, SSR_PROPS_ATTR, SSR_PROPS_KEY, getPropsId } from '../identity.js';
+import { LWC_SSR_PREFIX, SSR_PROPS_ATTR, getPropsId } from '../identity.js';
 import { ssrElement } from './ssr-element.js';
 /**
  * This is a view transformer run by the view registry during linking of a page document/route (configured in lwr.config.json[routes]).
@@ -22,12 +22,16 @@ import { ssrElement } from './ssr-element.js';
 export default function lwcSsrViewTransformer(options, { moduleBundler, resourceRegistry }) {
     return {
         name: 'ssr-lwc-transformer',
-        async link(stringBuilder, viewContext, { customElements }) {
+        async link(stringBuilder, viewContext, metadata) {
             if (!viewContext.view.bootstrap?.ssr) {
                 return {}; // no SSR
             }
             logger.debug('[lwcSsrViewTransformer] link');
             logger.verbose('[lwcSsrViewTransformer] link input', stringBuilder);
+            if (!metadata.ssrProps) {
+                metadata.ssrProps = {};
+            }
+            const { customElements, ssrProps } = metadata;
             // Gather all the SSRable custom elements (ie: root components) into 1 list
             const ssrModules = [];
             for (const [index, { tagName, location, props }] of customElements.entries()) {
@@ -51,7 +55,6 @@ export default function lwcSsrViewTransformer(options, { moduleBundler, resource
                 }
             }
             // SSR and gather the properties and links for each eligible custom element, in parallel
-            const ssrProps = {};
             let ssrLinks = '';
             let pageTtl;
             await Promise.all(ssrModules.map(({ index, specifier, tagName, props: rawProps = {}, startOffset, endOffset }) => {
@@ -96,11 +99,6 @@ export default function lwcSsrViewTransformer(options, { moduleBundler, resource
                     logger.warn(`Server-side rendering for "${specifier}" failed. Falling back to client-side rendering. Reason: `, err.stack);
                 });
             }));
-            if (Object.keys(ssrProps).length) {
-                // Serialize all root component properties into a single script for the page
-                // Append the script before the custom elements; it MUST appear before the AMD shim to avoid timing issues
-                stringBuilder.prependLeft(ssrModules[0].startOffset, `<script type="application/javascript">globalThis.LWR = globalThis.LWR || {};globalThis.LWR.${SSR_PROPS_KEY} = ${JSON.stringify(ssrProps)};</script>`);
-            }
             if (ssrLinks) {
                 // Add all the links to the <head> section of the base document
                 const headIndex = stringBuilder.original.indexOf('</head>');

package/build/es/viewTransformer/ssr-element.js

@@ -19,14 +19,14 @@ export async function ssrElement({ specifier, props: templateProps }, moduleBund
         // Ensure the bundle flag is always off in ESM,
         // otherwise TOO much gets bundled in the module registry
         // in ESM, resulting lwc clashes/duplication
-        { ...runtimeEnvironment, bundle: false }, undefined, {
+        { ...runtimeEnvironment, bundle: false }, runtimeParams, {
             exclude: [],
             alias: {
                 // override the default "@lwc/engine-dom" package
                 lwc: '@lwc/engine-server',
             },
         })
-        : await getBundle(specifier, moduleBundler, runtimeEnvironment);
+        : await getBundle(specifier, moduleBundler, runtimeEnvironment, runtimeParams);
     // Gather context to send into the SSR sandbox
     const context = {
         props: templateProps,

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.10.2",
+    "version": "0.11.0-alpha.1",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -27,6 +27,11 @@
             "require": "./build/cjs/viewTransformer/index.cjs"
         }
     },
+    "scripts": {
+        "build": "tsc -b",
+        "clean": "rm -rf build node_modules",
+        "test": "jest"
+    },
     "files": [
         "build/**/*.js",
         "build/**/*.cjs",
@@ -34,16 +39,21 @@
     ],
     "dependencies": {
         "@locker/near-membrane-node": "^0.12.15",
-        "@lwrjs/diagnostics": "0.10.2",
-        "@lwrjs/instrumentation": "0.10.2",
-        "@lwrjs/shared-utils": "0.10.2",
+        "@lwrjs/diagnostics": "0.11.0-alpha.1",
+        "@lwrjs/instrumentation": "0.11.0-alpha.1",
+        "@lwrjs/shared-utils": "0.11.0-alpha.1",
         "node-fetch": "^2.6.8"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.10.2"
+        "@lwrjs/types": "0.11.0-alpha.1",
+        "jest": "^26.6.3",
+        "ts-jest": "^26.5.6"
     },
     "engines": {
         "node": ">=16.0.0"
     },
-    "gitHead": "40988dfc093a3b9dea859f1bf61a49bca1edb0c5"
+    "volta": {
+        "extends": "../../../package.json"
+    },
+    "gitHead": "6a840d4694fac9f0be5c3a21707015379cbadad7"
 }