@lwc/template-compiler 2.25.1 → 2.26.1

package/dist/commonjs/codegen/formatters/function.js

@@ -0,0 +1,73 @@
+"use strict";
+/*
+ * Copyright (c) 2018, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: MIT
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.format = void 0;
+const t = __importStar(require("../../shared/estree"));
+const constants_1 = require("../../shared/constants");
+const helpers_1 = require("../helpers");
+const optimize_1 = require("../optimize");
+/**
+ * Generate a function body AST from a template ESTree AST. This function can then be instantiated
+ * via `new Function(code, modules)` The generated function retrieves receives the dependent LWC
+ * components as arguments and returns the template function.
+ *
+ * @example
+ * ```js
+ * const {
+ *   // Components names
+ * } = modules;
+ *
+ * function tmpl() {
+ *   // Template generated code
+ * }
+ * // Template metadata
+ *
+ * return tmpl;
+ * ```
+ */
+function format(templateFn, codeGen) {
+    const lookups = Array.from(codeGen.referencedComponents)
+        .sort()
+        .map((name) => {
+        const localIdentifier = (0, helpers_1.identifierFromComponentName)(name);
+        return t.variableDeclaration('const', [
+            t.variableDeclarator(localIdentifier, t.memberExpression(t.identifier(constants_1.TEMPLATE_MODULES_PARAMETER), t.literal(name), {
+                computed: true,
+            })),
+        ]);
+    });
+    const optimizedTemplateDeclarations = (0, optimize_1.optimizeStaticExpressions)(templateFn);
+    const metadata = (0, helpers_1.generateTemplateMetadata)(codeGen);
+    return t.program([
+        ...lookups,
+        ...optimizedTemplateDeclarations,
+        ...metadata,
+        t.returnStatement(t.identifier(constants_1.TEMPLATE_FUNCTION_NAME)),
+    ]);
+}
+exports.format = format;
+//# sourceMappingURL=function.js.map

package/dist/commonjs/codegen/formatters/function.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"function.js","sourceRoot":"","sources":["../../../../src/codegen/formatters/function.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;;;;;;;AAEH,uDAAyC;AACzC,sDAA4F;AAG5F,wCAAmF;AACnF,0CAAwD;AAExD;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,MAAM,CAAC,UAAiC,EAAE,OAAgB;IACtE,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC;SACnD,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACV,MAAM,eAAe,GAAG,IAAA,qCAA2B,EAAC,IAAI,CAAC,CAAC;QAE1D,OAAO,CAAC,CAAC,mBAAmB,CAAC,OAAO,EAAE;YAClC,CAAC,CAAC,kBAAkB,CAChB,eAAe,EACf,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,UAAU,CAAC,sCAA0B,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBAC1E,QAAQ,EAAE,IAAI;aACjB,CAAC,CACL;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEP,MAAM,6BAA6B,GAAG,IAAA,oCAAyB,EAAC,UAAU,CAAC,CAAC;IAE5E,MAAM,QAAQ,GAAG,IAAA,kCAAwB,EAAC,OAAO,CAAC,CAAC;IAEnD,OAAO,CAAC,CAAC,OAAO,CAAC;QACb,GAAG,OAAO;QACV,GAAG,6BAA6B;QAChC,GAAG,QAAQ;QACX,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,UAAU,CAAC,kCAAsB,CAAC,CAAC;KAC1D,CAAC,CAAC;AACP,CAAC;AA1BD,wBA0BC"}

package/dist/commonjs/codegen/scope.js

@@ -0,0 +1,61 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bindExpression = void 0;
+/*
+ * Copyright (c) 2018, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: MIT
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
+ */
+const estree_walker_1 = require("estree-walker");
+const t = __importStar(require("../shared/estree"));
+const constants_1 = require("../shared/constants");
+const ir_1 = require("../shared/ir");
+/**
+ * Bind the passed expression to the component instance. It applies the following transformation to the expression:
+ * - {value} --> {$cmp.value}
+ * - {value[index]} --> {$cmp.value[$cmp.index]}
+ */
+function bindExpression(expression, irNode) {
+    if (t.isIdentifier(expression)) {
+        if (ir_1.isComponentProp(expression, irNode)) {
+            return t.memberExpression(t.identifier(constants_1.TEMPLATE_PARAMS.INSTANCE), expression);
+        }
+        else {
+            return expression;
+        }
+    }
+    estree_walker_1.walk(expression, {
+        leave(node, parent) {
+            if (parent !== null &&
+                t.isIdentifier(node) &&
+                t.isMemberExpression(parent) &&
+                parent.object === node &&
+                ir_1.isComponentProp(node, irNode)) {
+                this.replace(t.memberExpression(t.identifier(constants_1.TEMPLATE_PARAMS.INSTANCE), node));
+            }
+        },
+    });
+    return expression;
+}
+exports.bindExpression = bindExpression;
+//# sourceMappingURL=scope.js.map

package/dist/commonjs/codegen/scope.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scope.js","sourceRoot":"","sources":["../../../src/codegen/scope.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;GAKG;AACH,iDAAqC;AAErC,oDAAsC;AACtC,mDAAsD;AACtD,qCAA+C;AAG/C;;;;GAIG;AACH,SAAgB,cAAc,CAAC,UAA8B,EAAE,MAAc;IACzE,IAAI,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE;QAC5B,IAAI,oBAAe,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE;YACrC,OAAO,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,UAAU,CAAC,2BAAe,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC,CAAC;SACjF;aAAM;YACH,OAAO,UAAU,CAAC;SACrB;KACJ;IAED,oBAAI,CAAC,UAAU,EAAE;QACb,KAAK,CAAC,IAAI,EAAE,MAAM;YACd,IACI,MAAM,KAAK,IAAI;gBACf,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC;gBACpB,CAAC,CAAC,kBAAkB,CAAC,MAAM,CAAC;gBAC5B,MAAM,CAAC,MAAM,KAAK,IAAI;gBACtB,oBAAe,CAAC,IAAI,EAAE,MAAM,CAAC,EAC/B;gBACE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,UAAU,CAAC,2BAAe,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;aAClF;QACL,CAAC;KACJ,CAAC,CAAC;IAEH,OAAO,UAAU,CAAC;AACtB,CAAC;AAxBD,wCAwBC"}

package/dist/commonjs/parser/tag.js

@@ -0,0 +1,15 @@
+"use strict";
+/*
+ * Copyright (c) 2018, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: MIT
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isUnsafeTopLevelSerializableElement = void 0;
+const constants_1 = require("./constants");
+function isUnsafeTopLevelSerializableElement(element) {
+    return constants_1.TAGS_THAT_CANNOT_BE_PARSED_AS_TOP_LEVEL.has(element.name);
+}
+exports.isUnsafeTopLevelSerializableElement = isUnsafeTopLevelSerializableElement;
+//# sourceMappingURL=tag.js.map

package/dist/commonjs/parser/tag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tag.js","sourceRoot":"","sources":["../../../src/parser/tag.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAGH,2CAAsE;AAEtE,SAAgB,mCAAmC,CAAC,OAAoB;IACpE,OAAO,mDAAuC,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AACrE,CAAC;AAFD,kFAEC"}

package/dist/commonjs/shared/ir.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isComponentProp = exports.isSlot = exports.isTemplate = exports.isCustomElement = exports.isCommentNode = exports.isTextNode = exports.isElement = exports.createComment = exports.createText = exports.createElement = void 0;
+function createElement(original, parent) {
+    return {
+        type: 'element',
+        tag: original.tagName,
+        namespace: original.namespaceURI,
+        attrsList: original.attrs,
+        parent,
+        children: [],
+        __original: original,
+    };
+}
+exports.createElement = createElement;
+function createText(original, parent, value) {
+    return {
+        type: 'text',
+        parent,
+        value,
+        __original: original,
+    };
+}
+exports.createText = createText;
+function createComment(original, parent, value) {
+    return {
+        type: 'comment',
+        parent,
+        value,
+        __original: original,
+    };
+}
+exports.createComment = createComment;
+function isElement(node) {
+    return node.type === 'element';
+}
+exports.isElement = isElement;
+function isTextNode(node) {
+    return node.type === 'text';
+}
+exports.isTextNode = isTextNode;
+function isCommentNode(node) {
+    return node.type === 'comment';
+}
+exports.isCommentNode = isCommentNode;
+function isCustomElement(node) {
+    return isElement(node) && node.component !== undefined;
+}
+exports.isCustomElement = isCustomElement;
+function isTemplate(element) {
+    return element.tag === 'template';
+}
+exports.isTemplate = isTemplate;
+function isSlot(element) {
+    return element.tag === 'slot';
+}
+exports.isSlot = isSlot;
+function isComponentProp(identifier, root) {
+    var _a;
+    const { name } = identifier;
+    let current = root;
+    // Walking up the AST and checking for each node to find if the identifer name is identical to
+    // an iteration variable.
+    while (current !== undefined) {
+        if (isElement(current)) {
+            const { forEach, forOf } = current;
+            if ((forEach === null || forEach === void 0 ? void 0 : forEach.item.name) === name ||
+                ((_a = forEach === null || forEach === void 0 ? void 0 : forEach.index) === null || _a === void 0 ? void 0 : _a.name) === name ||
+                (forOf === null || forOf === void 0 ? void 0 : forOf.iterator.name) === name) {
+                return false;
+            }
+        }
+        current = current.parent;
+    }
+    // The identifier is bound to a component property if no match is found after reaching to AST
+    // root.
+    return true;
+}
+exports.isComponentProp = isComponentProp;
+//# sourceMappingURL=ir.js.map

package/dist/commonjs/shared/ir.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ir.js","sourceRoot":"","sources":["../../../src/shared/ir.ts"],"names":[],"mappings":";;;AAkBA,SAAgB,aAAa,CAAC,QAAqB,EAAE,MAAkB;IACnE,OAAO;QACH,IAAI,EAAE,SAAS;QACf,GAAG,EAAE,QAAQ,CAAC,OAAO;QACrB,SAAS,EAAE,QAAQ,CAAC,YAAY;QAChC,SAAS,EAAE,QAAQ,CAAC,KAAK;QACzB,MAAM;QACN,QAAQ,EAAE,EAAE;QACZ,UAAU,EAAE,QAAQ;KACvB,CAAC;AACN,CAAC;AAVD,sCAUC;AAED,SAAgB,UAAU,CACtB,QAAkB,EAClB,MAAiB,EACjB,KAAkC;IAElC,OAAO;QACH,IAAI,EAAE,MAAM;QACZ,MAAM;QACN,KAAK;QACL,UAAU,EAAE,QAAQ;KACvB,CAAC;AACN,CAAC;AAXD,gCAWC;AAED,SAAgB,aAAa,CAAC,QAAqB,EAAE,MAAiB,EAAE,KAAa;IACjF,OAAO;QACH,IAAI,EAAE,SAAS;QACf,MAAM;QACN,KAAK;QACL,UAAU,EAAE,QAAQ;KACvB,CAAC;AACN,CAAC;AAPD,sCAOC;AAED,SAAgB,SAAS,CAAC,IAAY;IAClC,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC;AACnC,CAAC;AAFD,8BAEC;AAED,SAAgB,UAAU,CAAC,IAAY;IACnC,OAAO,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC;AAChC,CAAC;AAFD,gCAEC;AAED,SAAgB,aAAa,CAAC,IAAY;IACtC,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC;AACnC,CAAC;AAFD,sCAEC;AAED,SAAgB,eAAe,CAAC,IAAY;IACxC,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC;AAC3D,CAAC;AAFD,0CAEC;AAED,SAAgB,UAAU,CAAC,OAAkB;IACzC,OAAO,OAAO,CAAC,GAAG,KAAK,UAAU,CAAC;AACtC,CAAC;AAFD,gCAEC;AAED,SAAgB,MAAM,CAAC,OAAkB;IACrC,OAAO,OAAO,CAAC,GAAG,KAAK,MAAM,CAAC;AAClC,CAAC;AAFD,wBAEC;AAED,SAAgB,eAAe,CAAC,UAA8B,EAAE,IAAY;;IACxE,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC5B,IAAI,OAAO,GAAuB,IAAI,CAAC;IAEvC,8FAA8F;IAC9F,yBAAyB;IACzB,OAAO,OAAO,KAAK,SAAS,EAAE;QAC1B,IAAI,SAAS,CAAC,OAAO,CAAC,EAAE;YACpB,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;YAEnC,IACI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,CAAC,IAAI,MAAK,IAAI;gBAC3B,CAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,0CAAE,IAAI,MAAK,IAAI;gBAC7B,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,CAAC,IAAI,MAAK,IAAI,EAC/B;gBACE,OAAO,KAAK,CAAC;aAChB;SACJ;QAED,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;KAC5B;IAED,6FAA6F;IAC7F,QAAQ;IACR,OAAO,IAAI,CAAC;AAChB,CAAC;AAzBD,0CAyBC"}

package/dist/types/codegen/formatters/function.d.ts

@@ -0,0 +1,22 @@
+import * as t from '../../shared/estree';
+import CodeGen from '../codegen';
+/**
+ * Generate a function body AST from a template ESTree AST. This function can then be instantiated
+ * via `new Function(code, modules)` The generated function retrieves receives the dependent LWC
+ * components as arguments and returns the template function.
+ *
+ * @example
+ * ```js
+ * const {
+ *   // Components names
+ * } = modules;
+ *
+ * function tmpl() {
+ *   // Template generated code
+ * }
+ * // Template metadata
+ *
+ * return tmpl;
+ * ```
+ */
+export declare function format(templateFn: t.FunctionDeclaration, codeGen: CodeGen): t.Program;

package/dist/types/codegen/scope.d.ts

@@ -0,0 +1,8 @@
+import * as t from '../shared/estree';
+import { IRNode, TemplateExpression } from '../shared/types';
+/**
+ * Bind the passed expression to the component instance. It applies the following transformation to the expression:
+ * - {value} --> {$cmp.value}
+ * - {value[index]} --> {$cmp.value[$cmp.index]}
+ */
+export declare function bindExpression(expression: TemplateExpression, irNode: IRNode): t.Expression;

package/dist/types/parser/tag.d.ts

@@ -0,0 +1,2 @@
+import { BaseElement } from '../shared/types';
+export declare function isUnsafeTopLevelSerializableElement(element: BaseElement): boolean;

package/dist/types/shared/ir.d.ts

@@ -0,0 +1,11 @@
+import { TemplateIdentifier, TemplateExpression, IRNode, IRText, IRElement, HTMLElement, HTMLText, HTMLComment, IRComment } from './types';
+export declare function createElement(original: HTMLElement, parent?: IRElement): IRElement;
+export declare function createText(original: HTMLText, parent: IRElement, value: string | TemplateExpression): IRText;
+export declare function createComment(original: HTMLComment, parent: IRElement, value: string): IRComment;
+export declare function isElement(node: IRNode): node is IRElement;
+export declare function isTextNode(node: IRNode): node is IRText;
+export declare function isCommentNode(node: IRNode): node is IRComment;
+export declare function isCustomElement(node: IRNode): boolean;
+export declare function isTemplate(element: IRElement): boolean;
+export declare function isSlot(element: IRElement): boolean;
+export declare function isComponentProp(identifier: TemplateIdentifier, root: IRNode): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lwc/template-compiler",
-    "version": "2.25.1",
+    "version": "2.26.1",
     "description": "Template compiler package",
     "homepage": "https://lwc.dev/",
     "repository": {
@@ -25,8 +25,8 @@
     },
     "//": "Currently can't upgrade: estree-walker to v3.0.0 because it dropped CommonJS support: https://git.io/JXguS, parse5 dropped cjs support in v7.0.0 https://github.com/inikulin/parse5/releases/tag/v7.0.0",
     "dependencies": {
-        "@lwc/errors": "2.25.1",
-        "@lwc/shared": "2.25.1",
+        "@lwc/errors": "2.26.1",
+        "@lwc/shared": "2.26.1",
         "acorn": "~8.8.0",
         "astring": "~1.8.3",
         "estree-walker": "~2.0.2",
@@ -48,4 +48,4 @@
             }
         }
     }
-}
+}