@lwrjs/client-modules 0.5.11 → 0.6.0-alpha.12

package/build/bundle/prod/lwr/init/init.js

@@ -1 +1 @@
-import{createElement as e}from"lwc";function o(o,t){return e(o,{is:t})}function t(e){return e.replace(/\/v\/[a-zA-Z0-9-_.]+$/,"").replace("/","-").replace(/([A-Z])/g,(e=>`-${e.toLowerCase()}`))}const n=/-([a-z])/g;function r(e){return e.replace(n,(e=>e[1].toUpperCase()))}function c(e){if("undefined"!=typeof customElements&&"undefined"!=typeof document){const n=document.querySelector("[lwr-root]");e.forEach((([e,c])=>{const l=t(e);let a=document.body.querySelector(l);if(a){document.querySelectorAll(l).forEach((e=>{const t=o(l,c);for(const{name:o,value:n}of e.attributes){t.setAttribute(o,n);const e=r(o);e in t&&(t[e]=n)}for(;e.childNodes.length>0;)t.appendChild(e.childNodes[0]);if(e.parentElement.replaceChild(t,e),globalThis.performance){const e="lwr-bootstrap-on-app-init";globalThis.performance.measure(e)}}))}else a=o(l,c),n?n.appendChild(a):document.body.appendChild(a)}))}}export{r as getPropFromAttrName,c as init,t as toKebabCase};
+import{BOOTSTRAP_END as e}from"lwr/metrics";import{logOperationStart as o}from"lwr/profiler";import{createElement as t}from"lwc";function r(e,o){return t(e,{is:o})}function n(e){return e.replace(/\/v\/[a-zA-Z0-9-_.]+$/,"").replace("/","-").replace(/([A-Z])/g,(e=>`-${e.toLowerCase()}`))}const c=/-([a-z])/g;function l(e){return e.replace(c,(e=>e[1].toUpperCase()))}function i(t){if("undefined"!=typeof customElements&&"undefined"!=typeof document){const e=document.querySelector("[lwr-root]");t.forEach((([o,t])=>{const c=n(o);let i=document.body.querySelector(c);if(i){document.querySelectorAll(c).forEach((e=>{const o=r(c,t);for(const{name:t,value:r}of e.attributes){o.setAttribute(t,r);const e=l(t);e in o&&(o[e]=r)}for(;e.childNodes.length>0;)o.appendChild(e.childNodes[0]);if(e.parentElement.replaceChild(o,e),globalThis.performance){const e="lwr-bootstrap-on-app-init";globalThis.performance.measure(e)}}))}else i=r(c,t),e?e.appendChild(i):document.body.appendChild(i)}))}o({id:e})}export{l as getPropFromAttrName,i as init,n as toKebabCase};

package/build/bundle/prod/lwr/servicesESM/servicesESM.js

@@ -1 +1 @@
-const e=[];let n;const o={addLoaderPlugin:()=>{console.warn("API is not supported in ESM format")},handleStaleModule:function(o){e.push(o),n||(n=new WebSocket(`ws://${location.host}`),n.addEventListener("message",(async({data:n})=>{const o=JSON.parse(n);if("moduleUpdate"===o.eventType){const{oldHash:n,newHash:a,module:{specifier:t}}=o.payload;for(let o=0;o<e.length;o++){if(null!==(0,e[o])({name:t,oldHash:n,newHash:a}))break}}})))}};export{o as services};
+const o=[];let e;const t=globalThis.LWR;globalThis.LWR.define?globalThis.LWR=Object.freeze({define:globalThis.LWR.define}):delete globalThis.LWR;const n={addLoaderPlugin:()=>{console.warn("API is not supported in ESM format")},handleStaleModule:function(t){o.push(t),e||(e=new WebSocket(`ws://${location.host}`),e.addEventListener("message",(async({data:e})=>{const t=JSON.parse(e);if("moduleUpdate"===t.eventType){const{oldHash:e,newHash:n,module:{specifier:a}}=t.payload;for(let t=0;t<o.length;t++){if(null!==(0,o[t])({name:a,oldHash:e,newHash:n}))break}}})))},appMetadata:function(){const{bootstrapModule:o,rootComponent:e,rootComponents:n}=t;return{bootstrapModule:o,rootComponent:e,rootComponents:n}}()};export{n as services};

package/build/modules/lwr/init/init.js

@@ -1,6 +1,8 @@
-// TODO: This is a temporal workaround until https://github.com/salesforce/lwc/pull/2083 is sorted
+import { BOOTSTRAP_END } from 'lwr/metrics';
+import { logOperationStart } from 'lwr/profiler'; // TODO: This is a temporal workaround until https://github.com/salesforce/lwc/pull/2083 is sorted
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
+
 import { createElement } from 'lwc';
 
 function initializeWebComponent(elementName, Ctor) {
@@ -96,4 +98,8 @@ export function init(rootModules) {
       }
     });
   }
+
+  logOperationStart({
+    id: BOOTSTRAP_END
+  });
 }

package/build/modules/lwr/initSsr/initSsr.js

@@ -0,0 +1,40 @@
+// TODO: This is a temporal workaround until https://github.com/salesforce/lwc/pull/2083 is sorted
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+import { hydrateComponent } from 'lwc';
+export function toKebabCase(specifier) {
+  return specifier.replace(/\/v\/[a-zA-Z0-9-_.]+$/, '').replace('/', '-').replace(/([A-Z])/g, c => `-${c.toLowerCase()}`);
+}
+/**
+ * This method maps between attribute names
+ * and the corresponding props name.
+ */
+
+const CAMEL_REGEX = /-([a-z])/g;
+export function getPropFromAttrName(propName) {
+  return propName.replace(CAMEL_REGEX, g => g[1].toUpperCase());
+}
+/**
+ * Hydrate the given components component(s).
+ * @param components - An array of arrays, each one holding a pair of
+ *                      bare specifier and corresponding LightningElement constructor
+ * @example - [['x/appRoot', appCtor], ['x/nav', navCtor]]
+ */
+
+export function init(components) {
+  if (typeof document !== 'undefined') {
+    components.forEach(([moduleSpecifier, ctor]) => {
+      // Kebab-case the specifier
+      const elementName = toKebabCase(moduleSpecifier);
+      const customElements = document.querySelectorAll(elementName);
+      customElements.forEach(customElement => {
+        hydrateComponent(customElement, ctor, {});
+      });
+    });
+
+    if (globalThis.performance) {
+      const metric = 'lwr-bootstrap-on-app-init';
+      globalThis.performance.measure(metric);
+    }
+  }
+}

package/build/modules/lwr/metrics/metrics.js

@@ -0,0 +1,19 @@
+// Bootstrap / shim
+export const BOOTSTRAP_PREFIX = 'lwr.bootstrap.';
+export const BOOTSTRAP_END = `${BOOTSTRAP_PREFIX}end`;
+export const BOOTSTRAP_ERROR = `${BOOTSTRAP_PREFIX}error`;
+export const BOOTSTRAP_DURATION = `${BOOTSTRAP_PREFIX}duration`;
+export const BOOTSTRAP_AVAILABILITY = `${BOOTSTRAP_PREFIX}availability`; // Loader: modules
+
+export const LOADER_PREFIX = 'lwr.loader.';
+export const MODULE_DEFINE = `${LOADER_PREFIX}module.define`;
+export const MODULE_DEFINE_COUNT = `${MODULE_DEFINE}.count`;
+export const MODULE_FETCH = `${LOADER_PREFIX}module.fetch`;
+export const MODULE_FETCH_COUNT = `${MODULE_FETCH}.count`;
+export const MODULE_FETCH_DURATION = `${MODULE_FETCH}.duration`;
+export const MODULE_ERROR = `${LOADER_PREFIX}module.error`; // Loader: mappings
+
+export const MAPPINGS_FETCH = `${LOADER_PREFIX}mappings.fetch`;
+export const MAPPINGS_FETCH_COUNT = `${MAPPINGS_FETCH}.count`;
+export const MAPPINGS_FETCH_DURATION = `${MAPPINGS_FETCH}.duration`;
+export const MAPPINGS_ERROR = `${LOADER_PREFIX}mappings.error`;

package/build/modules/lwr/preInit/preInit.js

@@ -0,0 +1,18 @@
+/**
+ * This module is called in the ABS module (app bootstrap module) to perform neccesary pre initialization steps for an LWR app.
+ * Note: this module should be imported before other dependencies in the ABS
+ */
+const lwrGlobals = globalThis.LWR;
+
+if (globalThis.LWR.define) {
+  // AMD only
+  globalThis.LWR = Object.freeze({
+    define: globalThis.LWR.define
+  });
+} else {
+  delete globalThis.LWR;
+}
+
+export function getClientBootstrapConfig() {
+  return lwrGlobals;
+}

package/build/modules/lwr/profiler/profiler.js

@@ -0,0 +1,57 @@
+var Phase;
+
+(function (Phase) {
+  Phase[Phase["Start"] = 0] = "Start";
+  Phase[Phase["End"] = 1] = "End";
+})(Phase || (Phase = {}));
+
+// Attach a custom dispatcher
+let customDispatcher;
+export function attachDispatcher(dispatcher) {
+  customDispatcher = dispatcher;
+} // Check if the Performance API is available
+// e.g. JSDom (used in Jest) doesn't implement these
+
+const perf = globalThis.performance;
+const isPerfSupported = typeof perf !== 'undefined' && typeof perf.mark === 'function' && typeof perf.clearMarks === 'function' && typeof perf.measure === 'function' && typeof perf.clearMeasures === 'function'; // For marking request metrics
+// Fallback to the Performance API if there is no custom dispatcher
+
+export function logOperationStart({
+  id,
+  specifier
+}) {
+  if (customDispatcher) {
+    customDispatcher({
+      id,
+      phase: Phase.Start,
+      specifier
+    });
+  } else if (isPerfSupported) {
+    perf.mark(id + (specifier ? `.${specifier}` : ''));
+  }
+} // For measuring duration metrics
+// Fallback to the Performance API if there is no custom dispatcher
+
+/* istanbul ignore next */
+
+export function logOperationEnd({
+  id,
+  specifier
+}) {
+  if (customDispatcher) {
+    customDispatcher({
+      id,
+      phase: Phase.End,
+      specifier
+    });
+  } else if (isPerfSupported) {
+    const suffix = specifier ? `.${specifier}` : '';
+    const markName = id + suffix;
+    const measureName = `${id}.duration${suffix}`;
+    perf.measure(measureName, markName); // Clear the created mark and measure to avoid filling the performance entry buffer
+    // Even if they get deleted, existing PerformanceObservers preserve copies of the entries
+
+    perf.clearMarks(markName);
+    perf.clearMeasures(measureName);
+  }
+}

package/build/modules/lwr/servicesESM/servicesESM.js

@@ -1,11 +1,26 @@
 import { registerHandleStaleModuleHook } from './handleStaleModuleESM';
+import { getClientBootstrapConfig } from 'lwr/preInit';
 
 const noop = () => {
   console.warn('API is not supported in ESM format');
 };
 
+function getAppMetadata() {
+  const {
+    bootstrapModule,
+    rootComponent,
+    rootComponents
+  } = getClientBootstrapConfig();
+  return {
+    bootstrapModule,
+    rootComponent,
+    rootComponents
+  };
+}
+
 export const services = {
   // addLoaderPlugin is only supported in AMD
   addLoaderPlugin: noop,
-  handleStaleModule: registerHandleStaleModuleHook
+  handleStaleModule: registerHandleStaleModuleHook,
+  appMetadata: getAppMetadata()
 };

package/package.json

@@ -4,8 +4,8 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.5.11",
-    "homepage": "https://lwr.dev/",
+    "version": "0.6.0-alpha.12",
+    "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
         "url": "https://github.com/salesforce/lwr.git",
@@ -32,7 +32,7 @@
     },
     "dependencies": {
         "@locker/sandbox": "0.14.19",
-        "@lwrjs/shared-utils": "0.5.11"
+        "@lwrjs/shared-utils": "0.6.0-alpha.12"
     },
     "devDependencies": {
         "rollup-plugin-terser": "^7.0.2"
@@ -45,14 +45,18 @@
         ],
         "expose": [
             "lwr/hmr",
+            "lwr/preInit",
             "lwr/init",
+            "lwr/initSsr",
             "lwr/servicesESM",
             "lwr/lockerDefine",
-            "lwr/lockerSandbox"
+            "lwr/lockerSandbox",
+            "lwr/metrics",
+            "lwr/profiler"
         ]
     },
     "engines": {
         "node": ">=14.15.4 <17"
     },
-    "gitHead": "2ee810c0a4f1f36d1e0f8378a1fe00c19b4c5bc1"
+    "gitHead": "876b56ca4f98f3299303f2193c0dec8f46a69b84"
 }