@lwc/template-compiler 2.15.0 → 2.16.0

package/dist/types/shared/renderer-hooks.d.ts

@@ -0,0 +1,43 @@
+import State from '../state';
+import { BaseElement, ElementDirective } from './types';
+/**
+ * Config representing criteria for an element match.
+ * All conditions specified must be satisfied to be considered a match.
+ */
+export interface CustomRendererElementConfig {
+    /**
+     * Tag name to use to match an element.
+     */
+    tagName: string;
+    /**
+     * Optional namespace to match an element.
+     */
+    namespace?: string;
+    /**
+     * Specify attributes that need to be matched.
+     * This field is optional.
+     * If undefined or empty, attribute matching is skipped.
+     */
+    attributes?: string[];
+}
+/**
+ * Config to specify which elements and directives require a customizable renderer.
+ * An element is qualified if it matches the CustomRendererElementConfig OR the directives.
+ */
+export interface CustomRendererConfig {
+    /**
+     * Element matching criteria. Element much satisfy all conditions of the CustomRendererElementConfig
+     */
+    elements: CustomRendererElementConfig[];
+    /**
+     * List of lwc directives that qualify an element. An element must use at least 1
+     * directive to be considered a match.
+     * If empty, elements matching is not done based on directives.
+     */
+    directives: string[];
+}
+/**
+ * Mapping of Directive.name to string literals used in template
+ */
+export declare const LWC_DIRECTIVES: Record<ElementDirective['name'], string>;
+export declare function isCustomRendererHookRequired(element: BaseElement, state: State): boolean;

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

@@ -1 +1,7 @@
 export declare function toPropertyName(attr: string): string;
+/**
+ * Test if given tag name is a custom element.
+ * @param tagName element tag name to test
+ * @returns true if given tag name represents a custom element, false otherwise.
+ */
+export declare function isCustomElementTag(tagName: string): boolean;

package/dist/types/state.d.ts

@@ -1,5 +1,23 @@
 import { NormalizedConfig } from './config';
+import { BaseElement } from './shared/types';
 export default class State {
     config: NormalizedConfig;
+    /**
+     * Look up custom renderer config by tag name.
+     */
+    crElmToConfigMap: {
+        [tagName: string]: {
+            namespace: string | undefined;
+            attributes: Set<string>;
+        };
+    };
+    /**
+     * Look up for directives that require custom renderer
+     */
+    crDirectives: Set<string>;
+    /**
+     * Cache the result of elements that have already been checked if they require custom renderer
+     */
+    crCheckedElements: Map<BaseElement, boolean>;
     constructor(config: NormalizedConfig);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lwc/template-compiler",
-    "version": "2.15.0",
+    "version": "2.16.0",
     "description": "Template compiler package",
     "homepage": "https://lwc.dev/",
     "repository": {
@@ -26,8 +26,8 @@
     },
     "//": "Currently can't upgrade estree-walker to v3.0.0 because it dropped CommonJS support: https://git.io/JXguS",
     "dependencies": {
-        "@lwc/errors": "2.15.0",
-        "@lwc/shared": "2.15.0",
+        "@lwc/errors": "2.16.0",
+        "@lwc/shared": "2.16.0",
         "acorn": "~8.7.1",
         "astring": "~1.8.3",
         "estree-walker": "~2.0.2",