@lwrjs/client-modules - npm Package Compare versions

Comparing version 0.0.2-alpha7 to 0.0.2-alpha8

build/modules/lwr/init/init.js

@@ -16,5 +16,6 @@ /**
  * Import any requested static application dependencies, define the root
- * application component into the CustomElement registry, and inject it.
- * @param rootAppSpecifier - The bare specifier for the component, eg: 'x/appRoot'
- * @param rootApp - A reference to the Constructor (extended from LightningElement)
+ * application component(s) into the CustomElement registry, and inject them.
+ * @param rootModules - An array of arrays, each one holding a pair of
+ *                      bare specifier and corresponding LightningElement constructor
+ * @example - [['x/appRoot', appCtor], ['x/nav', navCtor]]
  */
@@ -21,0 +22,0 @@ // eslint-disable-next-line @typescript-eslint/no-explicit-any

build/modules/lwr/init/README.md

@@ -6,5 +6,5 @@ # Lightning Web Runtime :: Application Initialization
 -   importing static application dependencies
--   defining the _root application component_ into the [`CustomElementRegistry`](https://developer.mozilla.org/en-US/docs/Web/API/CustomElementRegistry)
+-   defining the _root application component(s)_ into the [`CustomElementRegistry`](https://developer.mozilla.org/en-US/docs/Web/API/CustomElementRegistry)
 
-This results in the _root application component_ being renderable by the DOM on first page load.
+This results in the _root application component(s)_ being renderable by the DOM on first page load.
 
@@ -15,3 +15,3 @@ ## Definition
 interface InitAPI {
-    init(rootAppSpecifier: string, rootApp: LightningElement): void;
+    init(rootModules: [string, LightningElement][]): void;
 }
@@ -25,4 +25,8 @@ ```
 import xAppRoot from 'x/appRoot';
+import xNav from 'x/nav';
 
-init('x/appRoot', xAppRoot);
+init([
+    ['x/appRoot', xAppRoot],
+    ['x/nav', xNav],
+]);
 ```
@@ -38,9 +42,11 @@
 // src/modules/example/init/init.js
-export function init(rootAppSpecifier, rootApp) {
-    const elementName = rootAppSpecifier.replace(/\//, '-');
-    customElements.define(elementName, rootApp.CustomElementConstructor);
+export function init(rootModules) {
+    rootModules.forEach(([moduleSpecifier, ctor]) => {
+        const elementName = toKebabCase(moduleSpecifier);
+        customElements.define(elementName, ctor.CustomElementConstructor);
+    });
 }
 ```
 
-2. Configure the module specifier in _lwr.config.json_:
+2. Configure the `init` module specifier in _lwr.config.json_:
 
@@ -47,0 +53,0 @@ ```json

modules/lwr/init/init.ts

@@ -0,1 +1,3 @@
+import type { LightningElement } from 'lwc/types';
+
 /**
@@ -20,8 +22,9 @@ * Convert a module specifier into a valid CustomElement registry name:
  * Import any requested static application dependencies, define the root
- * application component into the CustomElement registry, and inject it.
- * @param rootAppSpecifier - The bare specifier for the component, eg: 'x/appRoot'
- * @param rootApp - A reference to the Constructor (extended from LightningElement)
+ * application component(s) into the CustomElement registry, and inject them.
+ * @param rootModules - An array of arrays, each one holding a pair of
+ *                      bare specifier and corresponding LightningElement constructor
+ * @example - [['x/appRoot', appCtor], ['x/nav', navCtor]]
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export function init(rootModules: any[][]): void {
+export function init(rootModules: [string, LightningElement][]): void {
     if (typeof customElements !== 'undefined' && typeof document !== 'undefined') {
@@ -28,0 +31,0 @@ const uniqueRoot = rootModules.length === 1;

modules/lwr/init/README.md

@@ -6,5 +6,5 @@ # Lightning Web Runtime :: Application Initialization
 -   importing static application dependencies
--   defining the _root application component_ into the [`CustomElementRegistry`](https://developer.mozilla.org/en-US/docs/Web/API/CustomElementRegistry)
+-   defining the _root application component(s)_ into the [`CustomElementRegistry`](https://developer.mozilla.org/en-US/docs/Web/API/CustomElementRegistry)
 
-This results in the _root application component_ being renderable by the DOM on first page load.
+This results in the _root application component(s)_ being renderable by the DOM on first page load.
 
@@ -15,3 +15,3 @@ ## Definition
 interface InitAPI {
-    init(rootAppSpecifier: string, rootApp: LightningElement): void;
+    init(rootModules: [string, LightningElement][]): void;
 }
@@ -25,4 +25,8 @@ ```
 import xAppRoot from 'x/appRoot';
+import xNav from 'x/nav';
 
-init('x/appRoot', xAppRoot);
+init([
+    ['x/appRoot', xAppRoot],
+    ['x/nav', xNav],
+]);
 ```
@@ -38,9 +42,11 @@
 // src/modules/example/init/init.js
-export function init(rootAppSpecifier, rootApp) {
-    const elementName = rootAppSpecifier.replace(/\//, '-');
-    customElements.define(elementName, rootApp.CustomElementConstructor);
+export function init(rootModules) {
+    rootModules.forEach(([moduleSpecifier, ctor]) => {
+        const elementName = toKebabCase(moduleSpecifier);
+        customElements.define(elementName, ctor.CustomElementConstructor);
+    });
 }
 ```
 
-2. Configure the module specifier in _lwr.config.json_:
+2. Configure the `init` module specifier in _lwr.config.json_:
 
@@ -47,0 +53,0 @@ ```json

package.json

@@ -7,3 +7,3 @@ {
     },
-    "version": "0.0.2-alpha7",
+    "version": "0.0.2-alpha8",
     "homepage": "https://lwr.dev/",
@@ -29,2 +29,8 @@ "repository": {
     },
+    "dependencies": {
+        "@lwrjs/shared-utils": "0.0.2-alpha8"
+    },
+    "devDependencies": {
+        "lwc": "1.6.3"
+    },
     "lwc": {
@@ -47,3 +53,3 @@ "modules": [
     },
-    "gitHead": "fc1ad7545232af461fb9e2602a311ee39e0bae82"
+    "gitHead": "c010a3b75892789968c39442644bf333a59529c9"
 }

No alert changes

Improved metrics

Total package byte prevSize

248920

increased by0.21%

Lines of code

6306

increased by0.05%

Number of lines in readme file

58

increased by11.54%

Worsened metrics

Dependency count

1

increased byInfinity%

Dev dependency count

1

increased byInfinity%

Dependency changes

• + Added@lwrjs/shared-utils@0.0.2-alpha8

• + Added@lwrjs/shared-utils@0.0.2-alpha8(transitive)

• + Addedparse5@6.0.1(transitive)

• + Addedparse5-sax-parser@6.0.1(transitive)

• + Addedslugify@1.6.6(transitive)