@lwrjs/view-registry 0.6.5 → 0.7.0-alpha.10

package/LICENSE

@@ -0,0 +1,10 @@
+MIT LICENSE
+
+Copyright (c) 2020, Salesforce.com, Inc.
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/build/cjs/linkers/legacy_view_bootstrap.cjs

@@ -56,6 +56,7 @@ async function getHtmlResources(view, viewParams, resourceContext) {
   const visitedCache = new Map();
   const imports = {};
   const rootComponents = [];
+  const rootProperties = {};
   const requiredAmdModules = [];
   const preloadAmdModules = [];
   if (isAMD) {
@@ -65,6 +66,11 @@ async function getHtmlResources(view, viewParams, resourceContext) {
       throw Error("Failed to find definition of resource: " + shimBundle);
     }
     requiredResources.push(def);
+    const errorShimDef = await resourceRegistry.getResource({specifier: "lwr-error-shim.js", version}, runtimeEnvironment, runtimeParams);
+    if (!errorShimDef) {
+      throw Error("Failed to find definition of resource: lwr-error-shim.js");
+    }
+    requiredResources.push(errorShimDef);
     if (!bundle) {
       requiredResources.push(await (0, import_utils.getModuleResource)({
         specifier: "lwr/loaderLegacy",
@@ -97,16 +103,20 @@ async function getHtmlResources(view, viewParams, resourceContext) {
       }
     }
   }
+  const isSSR = view.bootstrap?.experimentalSSR;
   const customElementsRecords = [];
-  const flattenedElements = (0, import_utils2.flattenCustomElements)(customElements);
-  await Promise.all(flattenedElements.map(async ({tagName: element}) => {
-    const graph = await (0, import_shared_utils.getModuleGraphs)((0, import_shared_utils.kebabcaseToCamelcase)(element), {includeUris: true, includeLinkedDefinitions: true, depth}, moduleRegistry, bundle ? moduleBundler : moduleRegistry, runtimeEnvironment, runtimeParams ? runtimeParams : {}, visitedCache);
+  const flattenedElements = (0, import_utils2.flattenCustomElements)(customElements, isSSR);
+  await Promise.all(flattenedElements.map(async ({tagName: element, props}) => {
+    const graph = await (0, import_shared_utils.getModuleGraphs)((0, import_shared_utils.kebabCaseToModuleSpecifer)(element), {includeUris: true, includeLinkedDefinitions: true, depth}, moduleRegistry, bundle ? moduleBundler : moduleRegistry, runtimeEnvironment, runtimeParams ? runtimeParams : {}, visitedCache);
     customElementsRecords.push({elementName: element, flatGraph: graph});
     const specifier = graph.graphs[0].specifier;
     const uri2 = graph.uriMap[specifier];
     moduleResources.push((0, import_utils.getModuleResourceByUri)(uri2, runtimeEnvironment, true));
     rootComponents.push(specifier);
     imports[specifier] = uri2;
+    if (isSSR && props) {
+      rootProperties[specifier] = props;
+    }
     if (isAMD) {
       preloadAmdModules.push(specifier);
       for (const staticDep of graph.graphs[0].static) {
@@ -132,6 +142,7 @@ async function getHtmlResources(view, viewParams, resourceContext) {
       default: (0, import_shared_utils.getModuleUriPrefix)(runtimeEnvironment, runtimeParams)
     },
     rootComponents,
+    rootProperties: isSSR ? rootProperties : void 0,
     ...isAMD && {requiredModules: requiredAmdModules},
     ...isAMD && {preloadModules: preloadAmdModules}
   }, runtimeEnvironment, runtimeParams));

package/build/cjs/linkers/link-lwr-resources.cjs

@@ -31,9 +31,9 @@ var import_legacy_view_bootstrap = __toModule(require("./legacy_view_bootstrap.c
 async function linkLwrResources(source, view, viewParams, cxt) {
   const {lwrResourcesId, ...resourceContext} = cxt;
   const {
-    experimental_features: {ENABLE_FINGERPRINTS}
+    featureFlags: {LEGACY_LOADER}
   } = resourceContext.runtimeEnvironment;
-  const {partial, viewRecord} = ENABLE_FINGERPRINTS ? await (0, import_view_bootstrap.getHtmlResources)(view, viewParams, resourceContext) : await (0, import_legacy_view_bootstrap.getHtmlResources)(view, viewParams, resourceContext);
+  const {partial, viewRecord} = LEGACY_LOADER ? await (0, import_legacy_view_bootstrap.getHtmlResources)(view, viewParams, resourceContext) : await (0, import_view_bootstrap.getHtmlResources)(view, viewParams, resourceContext);
   return {
     renderedView: source.replace(lwrResourcesId, partial),
     viewRecord

package/build/cjs/linkers/utils.cjs

@@ -98,16 +98,18 @@ function getViewHmrConfigurationResource(view, viewMetadata) {
     content: configString
   };
 }
-function flattenCustomElements(arr) {
+function flattenCustomElements(arr, isSSR = false) {
   const ret = [];
   const visitedTags = new Set();
   function flatten(arr2) {
     for (const val of arr2) {
-      const {tagName, children} = val;
+      const {tagName, children, props} = val;
       if (!visitedTags.has(tagName)) {
-        ret.push({
-          tagName
-        });
+        if (isSSR) {
+          ret.push({tagName, props});
+        } else {
+          ret.push({tagName});
+        }
         visitedTags.add(tagName);
       }
       if (children) {

package/build/cjs/linkers/view_bootstrap.cjs

@@ -56,6 +56,7 @@ async function getHtmlResources(view, viewParams, resourceContext) {
   const visitedCache = new Map();
   const imports = {};
   const rootComponents = [];
+  const rootProperties = {};
   const requiredAmdModules = [];
   const preloadAmdModules = [];
   if (isAMD) {
@@ -65,6 +66,11 @@ async function getHtmlResources(view, viewParams, resourceContext) {
       throw Error("Failed to find definition of resource: " + shimBundle);
     }
     requiredResources.push(def);
+    const errorShimDef = await resourceRegistry.getResource({specifier: "lwr-error-shim.js", version}, runtimeEnvironment, runtimeParams);
+    if (!errorShimDef) {
+      throw Error("Failed to find definition of resource: lwr-error-shim.js");
+    }
+    requiredResources.push(errorShimDef);
     if (!bundle) {
       requiredResources.push(await (0, import_utils.getModuleResource)({
         specifier: "lwr/loader",
@@ -98,16 +104,20 @@ async function getHtmlResources(view, viewParams, resourceContext) {
     }
   }
   let importMetadata = await (0, import_shared_utils.toImportMetadata)(bootstrapModuleGraph, {imports: {}, index: {}}, moduleRegistry, runtimeEnvironment, runtimeParams);
+  const isSSR = view.bootstrap?.experimentalSSR;
   const customElementsRecords = [];
-  const flattenedElements = (0, import_utils2.flattenCustomElements)(customElements);
-  await Promise.all(flattenedElements.map(async ({tagName: element}) => {
-    const graph = await (0, import_shared_utils.getModuleGraphs)((0, import_shared_utils.kebabcaseToCamelcase)(element), {includeUris: true, includeLinkedDefinitions: true, depth}, moduleRegistry, bundle ? moduleBundler : moduleRegistry, runtimeEnvironment, runtimeParams ? runtimeParams : {}, visitedCache);
+  const flattenedElements = (0, import_utils2.flattenCustomElements)(customElements, isSSR);
+  await Promise.all(flattenedElements.map(async ({tagName: element, props}) => {
+    const graph = await (0, import_shared_utils.getModuleGraphs)((0, import_shared_utils.kebabCaseToModuleSpecifer)(element), {includeUris: true, includeLinkedDefinitions: true, depth}, moduleRegistry, bundle ? moduleBundler : moduleRegistry, runtimeEnvironment, runtimeParams ? runtimeParams : {}, visitedCache);
     customElementsRecords.push({elementName: element, flatGraph: graph});
     const specifier = graph.graphs[0].specifier;
     const uri2 = graph.uriMap[specifier];
     moduleResources.push((0, import_utils.getModuleResourceByUri)(uri2, runtimeEnvironment, true));
     rootComponents.push(specifier);
     imports[specifier] = uri2;
+    if (isSSR && props) {
+      rootProperties[specifier] = props;
+    }
     if (isAMD) {
       preloadAmdModules.push(specifier);
       for (const staticDep of graph.graphs[0].static) {
@@ -132,6 +142,7 @@ async function getHtmlResources(view, viewParams, resourceContext) {
     imports: importMetadata?.imports,
     index: importMetadata?.index,
     rootComponents,
+    rootProperties: isSSR ? rootProperties : void 0,
     ...isAMD && {requiredModules: requiredAmdModules},
     ...isAMD && {preloadModules: preloadAmdModules}
   }, runtimeEnvironment, runtimeParams));

package/build/cjs/utils.cjs

@@ -205,10 +205,12 @@ async function toJsonFormat(viewRequest, viewDefinition, route, runtimeEnvironme
       resources.push({type, src: asset.override?.uri});
     }
   });
+  const importMetadata = !runtimeEnvironment.featureFlags?.LEGACY_LOADER && viewRecord.importMetadata;
   viewRecord.resources?.forEach((resource) => {
     resources.push({type: resource.type, src: resource.src});
   });
   const body = {
+    ...importMetadata,
     modules,
     preloadModules,
     endpoints,

package/build/es/linkers/legacy_view_bootstrap.js

@@ -1,4 +1,4 @@
-import { kebabcaseToCamelcase, getModuleGraphs, GraphDepth, getModuleUriPrefix } from '@lwrjs/shared-utils';
+import { kebabCaseToModuleSpecifer, getModuleGraphs, GraphDepth, getModuleUriPrefix, } from '@lwrjs/shared-utils';
 import { AppResourceEnum, getAppSpecifier } from '@lwrjs/app-service/identity';
 import { generateHtmlTag, getModuleResource, getModuleResourceByUri } from '../utils.js';
 import { flattenCustomElements, getViewBootstrapConfigurationResource, getViewHmrConfigurationResource, } from './utils.js';
@@ -35,13 +35,15 @@ export async function getHtmlResources(view, viewParams, resourceContext) {
     const imports = {};
     // Collection of root view component specifiers
     const rootComponents = [];
+    // Collection of root view component properties, used for SSR hydration
+    const rootProperties = {};
     // Collection of modules specifiers that MUST be loaded in the view
     const requiredAmdModules = [];
     // Collection of modules that will be loaded in the view
     const preloadAmdModules = [];
     // ------ AMD Required module resources
     if (isAMD) {
-        // Keep changes in sync with view_bootstrap.ts
+        // Keep shim format in sync with view_bootstrap.ts
         const shimBundle = !bundle
             ? 'lwr-loader-shim-legacy.js'
             : debug || minify === false
@@ -52,6 +54,13 @@ export async function getHtmlResources(view, viewParams, resourceContext) {
             throw Error('Failed to find definition of resource: ' + shimBundle);
         }
         requiredResources.push(def);
+        // Always inline the error shim script after the shim
+        const errorShimDef = (await resourceRegistry.getResource({ specifier: 'lwr-error-shim.js', version }, runtimeEnvironment, runtimeParams));
+        if (!errorShimDef) {
+            throw Error('Failed to find definition of resource: lwr-error-shim.js');
+        }
+        requiredResources.push(errorShimDef);
+        // Add loader, if not already bundled with the shim
         if (!bundle) {
             // needed because we're resolving against fully-linked modules
             requiredResources.push(await getModuleResource({
@@ -101,10 +110,11 @@ export async function getHtmlResources(view, viewParams, resourceContext) {
         }
     }
     // ------- View related custom element moduleResources
+    const isSSR = view.bootstrap?.experimentalSSR;
     const customElementsRecords = [];
-    const flattenedElements = flattenCustomElements(customElements);
-    await Promise.all(flattenedElements.map(async ({ tagName: element }) => {
-        const graph = await getModuleGraphs(kebabcaseToCamelcase(element), { includeUris: true, includeLinkedDefinitions: true, depth }, moduleRegistry, bundle ? moduleBundler : moduleRegistry, runtimeEnvironment, runtimeParams ? runtimeParams : {}, visitedCache);
+    const flattenedElements = flattenCustomElements(customElements, isSSR);
+    await Promise.all(flattenedElements.map(async ({ tagName: element, props }) => {
+        const graph = await getModuleGraphs(kebabCaseToModuleSpecifer(element), { includeUris: true, includeLinkedDefinitions: true, depth }, moduleRegistry, bundle ? moduleBundler : moduleRegistry, runtimeEnvironment, runtimeParams ? runtimeParams : {}, visitedCache);
         // add to the viewRecord
         customElementsRecords.push({ elementName: element, flatGraph: graph });
         // PRELOAD custom element static deps as link resource
@@ -114,6 +124,10 @@ export async function getHtmlResources(view, viewParams, resourceContext) {
         // ADD register custom elements as a uri addressable rootComponents
         rootComponents.push(specifier);
         imports[specifier] = uri;
+        // ADD properties for each rootComponent if SSR is on
+        if (isSSR && props) {
+            rootProperties[specifier] = props;
+        }
         if (isAMD) {
             preloadAmdModules.push(specifier);
             for (const staticDep of graph.graphs[0].static) {
@@ -142,6 +156,7 @@ export async function getHtmlResources(view, viewParams, resourceContext) {
             default: getModuleUriPrefix(runtimeEnvironment, runtimeParams),
         },
         rootComponents,
+        rootProperties: isSSR ? rootProperties : undefined,
         ...(isAMD && { requiredModules: requiredAmdModules }),
         ...(isAMD && { preloadModules: preloadAmdModules }),
     }, runtimeEnvironment, runtimeParams));

package/build/es/linkers/link-lwr-resources.js

@@ -2,10 +2,10 @@ import { getHtmlResources } from './view_bootstrap.js';
 import { getHtmlResources as getLegacyHtmlResource } from './legacy_view_bootstrap.js';
 export async function linkLwrResources(source, view, viewParams, cxt) {
     const { lwrResourcesId, ...resourceContext } = cxt;
-    const { experimental_features: { ENABLE_FINGERPRINTS }, } = resourceContext.runtimeEnvironment;
-    const { partial, viewRecord } = ENABLE_FINGERPRINTS
-        ? await getHtmlResources(view, viewParams, resourceContext)
-        : await getLegacyHtmlResource(view, viewParams, resourceContext);
+    const { featureFlags: { LEGACY_LOADER }, } = resourceContext.runtimeEnvironment;
+    const { partial, viewRecord } = LEGACY_LOADER
+        ? await getLegacyHtmlResource(view, viewParams, resourceContext)
+        : await getHtmlResources(view, viewParams, resourceContext);
     // Finally replace the token with the real resources
     return {
         renderedView: source.replace(lwrResourcesId, partial),

package/build/es/linkers/utils.d.ts

@@ -2,5 +2,5 @@ import { ClientBootstrapConfig, RuntimeEnvironment, RuntimeParams, ResourceDefin
 import { View, ViewInfo } from '@lwrjs/types';
 export declare function getViewBootstrapConfigurationResource(viewInfo: ViewInfo, config: ClientBootstrapConfig, runtimeEnvironment: RuntimeEnvironment, runtimeParams?: RuntimeParams): ResourceDefinition;
 export declare function getViewHmrConfigurationResource(view: View, viewMetadata: RenderedViewMetadata): ResourceDefinition;
-export declare function flattenCustomElements(arr: CustomElementReference[]): CustomElementReference[];
+export declare function flattenCustomElements(arr: CustomElementReference[], isSSR?: boolean): CustomElementReference[];
 //# sourceMappingURL=utils.d.ts.map

package/build/es/linkers/utils.js

@@ -76,16 +76,19 @@ export function getViewHmrConfigurationResource(view, viewMetadata) {
         content: configString,
     };
 }
-export function flattenCustomElements(arr) {
+export function flattenCustomElements(arr, isSSR = false) {
     const ret = [];
     const visitedTags = new Set();
     function flatten(arr) {
         for (const val of arr) {
-            const { tagName, children } = val;
+            const { tagName, children, props } = val;
             if (!visitedTags.has(tagName)) {
-                ret.push({
-                    tagName,
-                });
+                if (isSSR) {
+                    ret.push({ tagName, props });
+                }
+                else {
+                    ret.push({ tagName });
+                }
                 visitedTags.add(tagName);
             }
             if (children) {

package/build/es/linkers/view_bootstrap.js

@@ -1,4 +1,4 @@
-import { kebabcaseToCamelcase, toImportMetadata, getModuleGraphs, getMappingUriPrefix, GraphDepth, } from '@lwrjs/shared-utils';
+import { kebabCaseToModuleSpecifer, toImportMetadata, getModuleGraphs, getMappingUriPrefix, GraphDepth, } from '@lwrjs/shared-utils';
 import { AppResourceEnum, getAppSpecifier } from '@lwrjs/app-service/identity';
 import { generateHtmlTag, getModuleResource, getModuleResourceByUri } from '../utils.js';
 import { flattenCustomElements, getViewBootstrapConfigurationResource, getViewHmrConfigurationResource, } from './utils.js';
@@ -35,13 +35,15 @@ export async function getHtmlResources(view, viewParams, resourceContext) {
     const imports = {};
     // Collection of root view component specifiers
     const rootComponents = [];
+    // Collection of root view component properties, used for SSR hydration
+    const rootProperties = {};
     // Collection of modules specifiers that MUST be loaded in the view
     const requiredAmdModules = [];
     // Collection of modules that will be loaded in the view
     const preloadAmdModules = [];
     // ------ AMD Required module resources
     if (isAMD) {
-        // Keep changes in sync with legacy_view_bootstrap.ts
+        // Keep shim format in sync with legacy_view_bootstrap.ts
         const shimBundle = !bundle
             ? 'lwr-loader-shim.js'
             : debug || minify === false
@@ -52,6 +54,13 @@ export async function getHtmlResources(view, viewParams, resourceContext) {
             throw Error('Failed to find definition of resource: ' + shimBundle);
         }
         requiredResources.push(def);
+        // Always inline the error shim script after the shim
+        const errorShimDef = (await resourceRegistry.getResource({ specifier: 'lwr-error-shim.js', version }, runtimeEnvironment, runtimeParams));
+        if (!errorShimDef) {
+            throw Error('Failed to find definition of resource: lwr-error-shim.js');
+        }
+        requiredResources.push(errorShimDef);
+        // Add loader, if not already bundled with the shim
         if (!bundle) {
             // needed because we're resolving against fully-linked modules
             requiredResources.push(await getModuleResource({
@@ -101,10 +110,11 @@ export async function getHtmlResources(view, viewParams, resourceContext) {
     }
     let importMetadata = await toImportMetadata(bootstrapModuleGraph, { imports: {}, index: {} }, moduleRegistry, runtimeEnvironment, runtimeParams);
     // ------- View related custom element moduleResources
+    const isSSR = view.bootstrap?.experimentalSSR;
     const customElementsRecords = [];
-    const flattenedElements = flattenCustomElements(customElements);
-    await Promise.all(flattenedElements.map(async ({ tagName: element }) => {
-        const graph = await getModuleGraphs(kebabcaseToCamelcase(element), { includeUris: true, includeLinkedDefinitions: true, depth }, moduleRegistry, bundle ? moduleBundler : moduleRegistry, runtimeEnvironment, runtimeParams ? runtimeParams : {}, visitedCache);
+    const flattenedElements = flattenCustomElements(customElements, isSSR);
+    await Promise.all(flattenedElements.map(async ({ tagName: element, props }) => {
+        const graph = await getModuleGraphs(kebabCaseToModuleSpecifer(element), { includeUris: true, includeLinkedDefinitions: true, depth }, moduleRegistry, bundle ? moduleBundler : moduleRegistry, runtimeEnvironment, runtimeParams ? runtimeParams : {}, visitedCache);
         // add to the viewRecord
         customElementsRecords.push({ elementName: element, flatGraph: graph });
         // PRELOAD custom element static deps as link resource
@@ -114,6 +124,10 @@ export async function getHtmlResources(view, viewParams, resourceContext) {
         // ADD register custom elements as a uri addressable rootComponents
         rootComponents.push(specifier);
         imports[specifier] = uri;
+        // ADD properties for each rootComponent if SSR is on
+        if (isSSR && props) {
+            rootProperties[specifier] = props;
+        }
         if (isAMD) {
             preloadAmdModules.push(specifier);
             for (const staticDep of graph.graphs[0].static) {
@@ -141,6 +155,7 @@ export async function getHtmlResources(view, viewParams, resourceContext) {
         imports: importMetadata?.imports,
         index: importMetadata?.index,
         rootComponents,
+        rootProperties: isSSR ? rootProperties : undefined,
         ...(isAMD && { requiredModules: requiredAmdModules }),
         ...(isAMD && { preloadModules: preloadAmdModules }),
     }, runtimeEnvironment, runtimeParams));

package/build/es/utils.js

@@ -187,10 +187,13 @@ export async function toJsonFormat(viewRequest, viewDefinition, route, runtimeEn
             resources.push({ type, src: asset.override?.uri });
         }
     });
+    // Import Metadata
+    const importMetadata = !runtimeEnvironment.featureFlags?.LEGACY_LOADER && viewRecord.importMetadata;
     viewRecord.resources?.forEach((resource) => {
         resources.push({ type: resource.type, src: resource.src });
     });
     const body = {
+        ...importMetadata,
         modules,
         preloadModules,
         endpoints,

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.6.5",
+    "version": "0.7.0-alpha.10",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -30,14 +30,15 @@
         "build/**/*.d.ts"
     ],
     "dependencies": {
-        "@lwrjs/app-service": "0.6.5",
-        "@lwrjs/diagnostics": "0.6.5",
-        "@lwrjs/shared-utils": "0.6.5"
+        "@lwrjs/app-service": "0.7.0-alpha.10",
+        "@lwrjs/diagnostics": "0.7.0-alpha.10",
+        "@lwrjs/shared-utils": "0.7.0-alpha.10"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.6.5"
+        "@lwrjs/types": "0.7.0-alpha.10"
     },
     "engines": {
         "node": ">=14.15.4 <17"
-    }
+    },
+    "gitHead": "83c1e65e2169094cb55ac2c37e5aef16d3a9aa4a"
 }