@lwc/metadata 2.19.0

package/dist/style-metadata/index.d.ts

@@ -0,0 +1,6 @@
+import { NamespaceMapping } from '../shared/config';
+import { CSSFile } from '../schema/typescript-types/style-metadata-types';
+export declare function collectCssMetadataFromSource(fileName: string, source: string, config: {
+    namespaceMapping: NamespaceMapping;
+}): CSSFile;
+/** End internal API **/

package/dist/style-metadata/index.js

@@ -0,0 +1,70 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var postcss = require('postcss');
+var errors = require('@lwc/errors');
+var errors$1 = require('../errors/errors.js');
+var utils = require('../shared/utils.js');
+var imports = require('./imports.js');
+var customProperties = require('./custom-properties.js');
+var componentReferences = require('./component-references.js');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var postcss__default = /*#__PURE__*/_interopDefaultLegacy(postcss);
+
+// Copyright (c) 2022, Salesforce, Inc.,
+function generateEmptyResult(fileName) {
+    return {
+        fileType: 'css',
+        fileName,
+        imports: [],
+        componentReferences: [],
+        customProperties: [],
+        diagnostics: [],
+    };
+}
+function collectCssMetadataFromSource(fileName, source, config) {
+    let root;
+    try {
+        root = postcss__default["default"].parse(source, {
+            from: fileName,
+        });
+    }
+    catch (error) {
+        const result = generateEmptyResult(fileName);
+        let location;
+        if (!utils.isUndefined(error.line) && !utils.isUndefined(error.column)) {
+            location = {
+                line: error.line,
+                column: error.column,
+            };
+        }
+        return {
+            ...result,
+            diagnostics: [
+                errors.generateCompilerDiagnostic(errors$1.Errors.SYNTAX_ERROR, {
+                    messageArgs: [fileName, error.message],
+                    origin: {
+                        filename: fileName,
+                        location,
+                    },
+                }),
+            ],
+        };
+    }
+    return collectCssMetadata(fileName, root, config.namespaceMapping);
+}
+/** Internal API, optimization to reuse existing ast from compilation process **/
+function collectCssMetadata(fileName, root, namespaceMapping) {
+    const result = generateEmptyResult(fileName);
+    imports.collectImports(result, root, namespaceMapping);
+    customProperties.collectCustomProperties(result, root);
+    componentReferences.collectComponentReferences(result, root, namespaceMapping);
+    return result;
+}
+/** End internal API **/
+
+exports.collectCssMetadataFromSource = collectCssMetadataFromSource;
+//# sourceMappingURL=index.js.map

package/dist/style-metadata/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/style-metadata/index.ts"],"sourcesContent":[null],"names":["postcss","isUndefined","generateCompilerDiagnostic","Errors","collectImports","collectCustomProperties","collectComponentReferences"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAkBA,SAAS,mBAAmB,CAAC,QAAgB,EAAA;IACzC,OAAO;AACH,QAAA,QAAQ,EAAE,KAAK;QACf,QAAQ;AACR,QAAA,OAAO,EAAE,EAAE;AACX,QAAA,mBAAmB,EAAE,EAAE;AACvB,QAAA,gBAAgB,EAAE,EAAE;AACpB,QAAA,WAAW,EAAE,EAAE;KAClB,CAAC;AACN,CAAC;SAEe,4BAA4B,CACxC,QAAgB,EAChB,MAAc,EACd,MAEC,EAAA;AAED,IAAA,IAAI,IAAU,CAAC;IAEf,IAAI;AACA,QAAA,IAAI,GAAGA,2BAAO,CAAC,KAAK,CAAC,MAAM,EAAE;AACzB,YAAA,IAAI,EAAE,QAAQ;AACjB,SAAA,CAAC,CAAC;AACN,KAAA;AAAC,IAAA,OAAO,KAAU,EAAE;AACjB,QAAA,MAAM,MAAM,GAAG,mBAAmB,CAAC,QAAQ,CAAC,CAAC;AAE7C,QAAA,IAAI,QAA8B,CAAC;AACnC,QAAA,IAAI,CAACC,iBAAW,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAACA,iBAAW,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;AACxD,YAAA,QAAQ,GAAG;gBACP,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,MAAM,EAAE,KAAK,CAAC,MAAM;aACvB,CAAC;AACL,SAAA;QAED,OAAO;AACH,YAAA,GAAG,MAAM;AACT,YAAA,WAAW,EAAE;AACT,gBAAAC,iCAA0B,CAACC,eAAM,CAAC,YAAY,EAAE;AAC5C,oBAAA,WAAW,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC;AACtC,oBAAA,MAAM,EAAE;AACJ,wBAAA,QAAQ,EAAE,QAAQ;wBAClB,QAAQ;AACX,qBAAA;iBACJ,CAAC;AACL,aAAA;SACJ,CAAC;AACL,KAAA;IAED,OAAO,kBAAkB,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;AACvE,CAAC;AAED;AACA,SAAS,kBAAkB,CACvB,QAAgB,EAChB,IAAU,EACV,gBAAkC,EAAA;AAElC,IAAA,MAAM,MAAM,GAAG,mBAAmB,CAAC,QAAQ,CAAC,CAAC;AAE7C,IAAAC,sBAAc,CAAC,MAAM,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC;AAC/C,IAAAC,wCAAuB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AACtC,IAAAC,8CAA0B,CAAC,MAAM,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC;AAE3D,IAAA,OAAO,MAAM,CAAC;AAClB,CAAC;AACD;;;;"}

package/dist/template-metadata/__tests__/component-reference.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/template-metadata/index.d.ts

@@ -0,0 +1,6 @@
+import { HTMLTemplateFile } from '../schema/typescript-types/template-metadata-types';
+import { NamespaceMapping } from '../shared/config';
+export declare function collectTemplateMetadataFromSource(fileName: string, source: string, config: {
+    namespaceMapping: NamespaceMapping;
+    enableKomaci?: boolean;
+}): HTMLTemplateFile;

package/dist/template-metadata/index.js

@@ -0,0 +1,136 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var sfdcCompilerUtils = require('@lwc/sfdc-compiler-utils');
+var templateCompiler = require('@lwc/template-compiler');
+var errors = require('@lwc/errors');
+var errors$1 = require('../errors/errors.js');
+var utils = require('../shared/utils.js');
+require('@babel/types');
+var analyzeTemplateFile = require('../dependency-analyzer/analyzeTemplateFile.js');
+
+// Copyright (c) 2022, Salesforce, Inc.,
+const PARSE_DEFAULT_CONFIG = {
+    experimentalDynamicDirective: true,
+};
+function generateEmptyResult(fileName) {
+    return {
+        fileType: 'html',
+        fileName,
+        componentReferences: [],
+        diagnostics: [],
+    };
+}
+function collectTemplateMetadataFromSource(fileName, source, config) {
+    let parseResult;
+    const emptyResult = generateEmptyResult(fileName);
+    let parseWarnings;
+    try {
+        parseResult = templateCompiler.parse(source, PARSE_DEFAULT_CONFIG);
+        // Diagnostic from @lwc/template-compiler parse() does not have a filename
+        parseWarnings = parseResult.warnings.map((warning) => {
+            warning.filename = fileName;
+            return warning;
+        });
+        // Produce empty result with diagnostics only if there are fatals and errors
+        const hasParseErrors = parseWarnings.some((warning) => warning.level === errors.DiagnosticLevel.Fatal || warning.level === errors.DiagnosticLevel.Error);
+        if (utils.isUndefined(parseResult.root) || hasParseErrors) {
+            emptyResult.diagnostics = parseWarnings;
+            return emptyResult;
+        }
+    }
+    catch (e) {
+        emptyResult.diagnostics.push(errors.generateCompilerDiagnostic(errors$1.Errors.SYNTAX_ERROR, {
+            messageArgs: [fileName, e.message],
+            origin: {
+                filename: fileName,
+            },
+        }));
+        return emptyResult;
+    }
+    const collectionResult = collectTemplateMetadataFromAST(fileName, parseResult.root, config.namespaceMapping);
+    collectionResult.diagnostics.push(...parseWarnings);
+    if (config.enableKomaci) {
+        collectionResult.komaciDoc = analyzeTemplateFile.generateKomaciDocFromTemplate(collectionResult);
+    }
+    return collectionResult;
+}
+function collectTemplateMetadataFromAST(fileName, root, namespaceMapping) {
+    const result = generateEmptyResult(fileName);
+    const uniqueReferences = new Map();
+    // Iterate over all the component references and deduplicate them. Add missing references to the
+    // map. If the reference is already present in the map, append the location to the existing
+    // entry.
+    for (const reference of collectComponentReferences(root, namespaceMapping)) {
+        const existingReference = uniqueReferences.get(reference.name);
+        if (existingReference) {
+            existingReference.locations.push(...reference.locations);
+        }
+        else {
+            uniqueReferences.set(reference.name, reference);
+        }
+    }
+    result.ast = root;
+    result.componentReferences = Array.from(uniqueReferences.values());
+    return result;
+}
+function* collectComponentReferences(node, namespaceMapping) {
+    if (node.type === 'Component') {
+        const ref = getComponentReference(node, namespaceMapping);
+        if (ref) {
+            yield ref;
+        }
+    }
+    for (const child of node.children) {
+        if (child.type !== 'Comment' && child.type !== 'Text') {
+            yield* collectComponentReferences(child, namespaceMapping);
+        }
+    }
+}
+function getComponentReference(node, namespaceMapping) {
+    const { name: tagName, directives, location: { startTag, endTag }, } = node;
+    // Ignore dynamic components.
+    if (directives.find((directive) => directive.name === 'Dynamic')) {
+        return;
+    }
+    const name = utils.tagNameToComponentName(tagName);
+    // The component reference location refers to the actual tag name string location in the
+    // source and not the entire opening an closing tag location. In the opening tag location, we
+    // need to add `1` account for the `<` and `2` for the `</` in the closing tag.
+    //
+    // Note: The compiler ensures that a component are not void elements, so such an element will
+    // always have an `endTag`.
+    const locations = [
+        {
+            start: startTag.start + 1,
+            startLine: startTag.startLine,
+            startColumn: startTag.startColumn + 1,
+            end: startTag.end - 1,
+            endLine: startTag.startLine,
+            endColumn: startTag.startColumn + 1 + tagName.length,
+        },
+        {
+            start: endTag.start + 2,
+            startLine: endTag.startLine,
+            startColumn: endTag.startColumn + 2,
+            end: endTag.end - 1,
+            endLine: endTag.startLine,
+            endColumn: endTag.startColumn + 2 + tagName.length,
+        },
+    ];
+    const ref = {
+        type: 'external',
+        name,
+        tagName,
+        locations,
+    };
+    const namespacedName = sfdcCompilerUtils.getNamespacedIdForResource(name, namespaceMapping);
+    if (namespacedName) {
+        ref.namespacedName = namespacedName;
+    }
+    return ref;
+}
+
+exports.collectTemplateMetadataFromSource = collectTemplateMetadataFromSource;
+//# sourceMappingURL=index.js.map

package/dist/template-metadata/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/template-metadata/index.ts"],"sourcesContent":[null],"names":["parse","DiagnosticLevel","isUndefined","generateCompilerDiagnostic","Errors","generateKomaciDocFromTemplate","tagNameToComponentName","getNamespacedIdForResource"],"mappings":";;;;;;;;;;;;AAAA;AAkBA,MAAM,oBAAoB,GAAG;AACzB,IAAA,4BAA4B,EAAE,IAAI;CACrC,CAAC;AAEF,SAAS,mBAAmB,CAAC,QAAgB,EAAA;IACzC,OAAO;AACH,QAAA,QAAQ,EAAE,MAAM;QAChB,QAAQ;AACR,QAAA,mBAAmB,EAAE,EAAE;AACvB,QAAA,WAAW,EAAE,EAAE;KAClB,CAAC;AACN,CAAC;SAEe,iCAAiC,CAC7C,QAAgB,EAChB,MAAc,EACd,MAGC,EAAA;AAED,IAAA,IAAI,WAAW,CAAC;AAChB,IAAA,MAAM,WAAW,GAAG,mBAAmB,CAAC,QAAQ,CAAC,CAAC;AAClD,IAAA,IAAI,aAAmC,CAAC;IACxC,IAAI;AACA,QAAA,WAAW,GAAGA,sBAAK,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;;QAGlD,aAAa,GAAG,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,KAAI;AACjD,YAAA,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC5B,YAAA,OAAO,OAAO,CAAC;AACnB,SAAC,CAAC,CAAC;;QAEH,MAAM,cAAc,GAAG,aAAa,CAAC,IAAI,CACrC,CAAC,OAAO,KACJ,OAAO,CAAC,KAAK,KAAKC,sBAAe,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,KAAKA,sBAAe,CAAC,KAAK,CACzF,CAAC;QAEF,IAAIC,iBAAW,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,cAAc,EAAE;AACjD,YAAA,WAAW,CAAC,WAAW,GAAG,aAAa,CAAC;AAExC,YAAA,OAAO,WAAW,CAAC;AACtB,SAAA;AACJ,KAAA;AAAC,IAAA,OAAO,CAAM,EAAE;QACb,WAAW,CAAC,WAAW,CAAC,IAAI,CACxBC,iCAA0B,CAACC,eAAM,CAAC,YAAY,EAAE;AAC5C,YAAA,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC;AAClC,YAAA,MAAM,EAAE;AACJ,gBAAA,QAAQ,EAAE,QAAQ;AACrB,aAAA;AACJ,SAAA,CAAC,CACL,CAAC;AAEF,QAAA,OAAO,WAAW,CAAC;AACtB,KAAA;AAED,IAAA,MAAM,gBAAgB,GAAG,8BAA8B,CACnD,QAAQ,EACR,WAAW,CAAC,IAAI,EAChB,MAAM,CAAC,gBAAgB,CAC1B,CAAC;IAEF,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC;IAEpD,IAAI,MAAM,CAAC,YAAY,EAAE;AACrB,QAAA,gBAAgB,CAAC,SAAS,GAAGC,iDAA6B,CAAC,gBAAgB,CAAC,CAAC;AAChF,KAAA;AAED,IAAA,OAAO,gBAAgB,CAAC;AAC5B,CAAC;AAED,SAAS,8BAA8B,CACnC,QAAgB,EAChB,IAAU,EACV,gBAAkC,EAAA;AAElC,IAAA,MAAM,MAAM,GAAG,mBAAmB,CAAC,QAAQ,CAAC,CAAC;AAC7C,IAAA,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAA8B,CAAC;;;;IAK/D,KAAK,MAAM,SAAS,IAAI,0BAA0B,CAAC,IAAI,EAAE,gBAAgB,CAAC,EAAE;QACxE,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAE/D,QAAA,IAAI,iBAAiB,EAAE;YACnB,iBAAiB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;AAC5D,SAAA;AAAM,aAAA;YACH,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;AACnD,SAAA;AACJ,KAAA;AAED,IAAA,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC;AAClB,IAAA,MAAM,CAAC,mBAAmB,GAAG,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC,CAAC;AAEnE,IAAA,OAAO,MAAM,CAAC;AAClB,CAAC;AACD,UAAU,0BAA0B,CAChC,IAAgB,EAChB,gBAAkC,EAAA;AAElC,IAAA,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE;QAC3B,MAAM,GAAG,GAAG,qBAAqB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;AAE1D,QAAA,IAAI,GAAG,EAAE;AACL,YAAA,MAAM,GAAG,CAAC;AACb,SAAA;AACJ,KAAA;AAED,IAAA,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE;QAC/B,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE;YACnD,OAAO,0BAA0B,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;AAC9D,SAAA;AACJ,KAAA;AACL,CAAC;AAED,SAAS,qBAAqB,CAC1B,IAAe,EACf,gBAAkC,EAAA;AAElC,IAAA,MAAM,EACF,IAAI,EAAE,OAAO,EACb,UAAU,EACV,QAAQ,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,GACjC,GAAG,IAAI,CAAC;;AAGT,IAAA,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,KAAK,SAAS,CAAC,EAAE;QAC9D,OAAO;AACV,KAAA;AAED,IAAA,MAAM,IAAI,GAAGC,4BAAsB,CAAC,OAAO,CAAC,CAAC;;;;;;;AAQ7C,IAAA,MAAM,SAAS,GAAqB;AAChC,QAAA;AACI,YAAA,KAAK,EAAE,QAAQ,CAAC,KAAK,GAAG,CAAC;YACzB,SAAS,EAAE,QAAQ,CAAC,SAAS;AAC7B,YAAA,WAAW,EAAE,QAAQ,CAAC,WAAW,GAAG,CAAC;AACrC,YAAA,GAAG,EAAE,QAAQ,CAAC,GAAG,GAAG,CAAC;YACrB,OAAO,EAAE,QAAQ,CAAC,SAAS;YAC3B,SAAS,EAAE,QAAQ,CAAC,WAAW,GAAG,CAAC,GAAG,OAAO,CAAC,MAAM;AACvD,SAAA;AACD,QAAA;AACI,YAAA,KAAK,EAAE,MAAO,CAAC,KAAK,GAAG,CAAC;YACxB,SAAS,EAAE,MAAO,CAAC,SAAS;AAC5B,YAAA,WAAW,EAAE,MAAO,CAAC,WAAW,GAAG,CAAC;AACpC,YAAA,GAAG,EAAE,MAAO,CAAC,GAAG,GAAG,CAAC;YACpB,OAAO,EAAE,MAAO,CAAC,SAAS;YAC1B,SAAS,EAAE,MAAO,CAAC,WAAW,GAAG,CAAC,GAAG,OAAO,CAAC,MAAM;AACtD,SAAA;KACJ,CAAC;AAEF,IAAA,MAAM,GAAG,GAAuB;AAC5B,QAAA,IAAI,EAAE,UAAU;QAChB,IAAI;QACJ,OAAO;QACP,SAAS;KACZ,CAAC;IAEF,MAAM,cAAc,GAAGC,4CAA0B,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;AAC1E,IAAA,IAAI,cAAc,EAAE;AAChB,QAAA,GAAG,CAAC,cAAc,GAAG,cAAc,CAAC;AACvC,KAAA;AAED,IAAA,OAAO,GAAG,CAAC;AACf;;;;"}

package/package.json

@@ -0,0 +1,35 @@
+{
+    "name": "@lwc/metadata",
+    "version": "2.19.0",
+    "description": "Extract metadata about Lightning Web Components modules. This software is provided as-is with no support provided.",
+    "main": "dist/index.js",
+    "typings": "dist/index.d.ts",
+    "files": [
+        "dist/",
+        "LICENSE.txt"
+    ],
+    "license": "SEE LICENSE IN LICENSE.txt",
+    "scripts": {
+        "clean": "rimraf dist/",
+        "build": "rollup --config scripts/rollup.config.js"
+    },
+    "dependencies": {
+        "@babel/parser": "~7.17.10",
+        "@babel/traverse": "~7.17.10",
+        "@babel/types": "~7.17.10",
+        "@lwc/sfdc-compiler-utils": "2.19.0",
+        "@lwc/errors": "2.19.0",
+        "@lwc/template-compiler": "2.19.0",
+        "postcss": "~8.4.13",
+        "postcss-selector-parser": "~6.0.10",
+        "postcss-value-parser": "~4.2.0"
+    },
+    "devDependencies": {
+        "@types/babel__core": "^7.1.19",
+        "@types/babel__traverse": "^7.17.1",
+        "@types/glob": "^7.2.0"
+    },
+    "engines": {
+        "node": ">=14"
+    }
+}