@komaci/esm-generator 260.38.0 → 260.40.0

package/build/__tests__/adgAstGeneration.spec.js

@@ -363,7 +363,7 @@ export default class Component extends LightningElement {
         // Test that bundles with .ts files are processed correctly
         expect(() => {
             const bundleConfig = {
-                namespace: 'c',
+                namespace: 'lightning',
                 name: 'tsComponent',
                 type: 'internal',
                 namespaceMapping: {},

package/build/__tests__/index.spec.js

@@ -25,6 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const __1 = require("..");
 const modgen = __importStar(require("../genericAstGeneration"));
+const metadata_1 = require("@lwc/metadata");
 describe('Handling errors that throw inside a call to generateKomaciModule', () => {
     it('should return error adg when an error is produced', () => {
         const input = {
@@ -290,4 +291,203 @@ describe('normalizeSrcFileKeys', () => {
         expect(input.srcFileMap['templates/test2.html']).not.toBeUndefined();
     });
 });
+describe('Bundle processing', () => {
+    it('when both .js and .ts files exist with for the component name', () => {
+        const bundleSrcFileMap = {
+            'test.js': {},
+            'test.ts': {},
+            'test.html': {},
+        };
+        const input = {
+            moduleInfo: {
+                name: 'test',
+                namespace: 'lightning',
+                type: 'bundle',
+                files: bundleSrcFileMap,
+            },
+            srcFileMap: {
+                'test.js': 'export default class Test {}',
+                'test.ts': 'export default class Test {}',
+                'test.html': '<template><div>Test</div></template>',
+                'test.css': 'p { text-align: center; }',
+            },
+        };
+        const res = (0, __1.generateKomaciModule)(input);
+        expect(res).toContain('ErrorFunction');
+        expect(res).toContain('[komaci esm-generator] multiple component script files with the same name found in bundle: test');
+    });
+    it('can handle multiple script files with the same name in different directories', () => {
+        const bundleSrcFileMap = {
+            'test.js': {},
+            'subdir/test.js': {},
+            'test.html': {},
+        };
+        const input = {
+            moduleInfo: {
+                name: 'test',
+                namespace: 'c',
+                type: 'bundle',
+                files: bundleSrcFileMap,
+            },
+            srcFileMap: {
+                'test.js': 'export default class Test {}',
+                'subdir/test.js': 'export default class Test {}',
+                'test.html': '<template><div>Test</div></template>',
+                'test.css': 'p { text-align: center; }',
+            },
+        };
+        const res = (0, __1.generateKomaciModule)(input);
+        expect(res).not.toContain('ErrorFunction');
+        expect(res).toContain('registerAdgFunction');
+    });
+    it('can handle multiple script files with different names in same directory', () => {
+        const testJsSource = `export default class Test extends LightningElement {
+            get testProp() {
+                return 'test';
+            }
+        }`;
+        const fooJsSource = `export default class Foo {
+            get fooProp() {
+                return 'foo';
+            }
+        }`;
+        const bundleConfig = {
+            namespace: 'c',
+            name: 'test',
+            type: 'internal',
+            files: [
+                { fileName: 'test.js', source: testJsSource },
+                { fileName: 'foo.js', source: fooJsSource },
+                { fileName: 'test.html', source: '<template><div>Test</div></template>' },
+                { fileName: 'test.css', source: 'p { text-align: center; }' },
+            ],
+            enableKomaci: true,
+            namespaceMapping: {},
+            npmModuleMapping: {},
+        };
+        const metadata = (0, metadata_1.collectBundleMetadata)(bundleConfig);
+        const inputFiles = Object.fromEntries(metadata.files
+            .map(({ fileName, komaciDoc }) => [fileName, komaciDoc])
+            .filter(([, komaciDoc]) => !!komaciDoc));
+        const input = {
+            moduleInfo: {
+                name: 'test',
+                namespace: 'c',
+                type: 'bundle',
+                files: inputFiles,
+            },
+            srcFileMap: {
+                'test.js': testJsSource,
+                'foo.js': fooJsSource,
+                'test.html': '<template><div>Test</div></template>',
+                'test.css': 'p { text-align: center; }',
+            },
+        };
+        const res = (0, __1.generateKomaciModule)(input);
+        expect(res).not.toContain('ErrorFunction');
+        expect(res).toContain('registerAdgFunction');
+        expect(res).toContain('testProp');
+        expect(res).not.toContain('fooProp');
+    });
+    it('can process typescript files in the lightning namespace', () => {
+        const testTsSource = `import { LightningElement } from 'lwc';
+
+        export default class TestComponent extends LightningElement {
+            private count: number = 0;
+
+            get doubleCount(): number {
+                return this.count * 2;
+            }
+
+            increment(): void {
+                this.count++;
+            }
+        }`;
+        const bundleConfig = {
+            namespace: 'lightning',
+            name: 'testComponent',
+            type: 'internal',
+            files: [
+                { fileName: 'testComponent.ts', source: testTsSource },
+                {
+                    fileName: 'testComponent.html',
+                    source: '<template><div>Test</div></template>',
+                },
+            ],
+            enableKomaci: true,
+            namespaceMapping: {},
+            npmModuleMapping: {},
+        };
+        const metadata = (0, metadata_1.collectBundleMetadata)(bundleConfig);
+        const inputFiles = Object.fromEntries(metadata.files
+            .map(({ fileName, komaciDoc }) => [fileName, komaciDoc])
+            .filter(([, komaciDoc]) => !!komaciDoc));
+        const input = {
+            moduleInfo: {
+                name: 'testComponent',
+                namespace: 'lightning',
+                type: 'bundle',
+                files: inputFiles,
+            },
+            srcFileMap: {
+                'testComponent.ts': testTsSource,
+                'testComponent.html': '<template><div>Test</div></template>',
+            },
+        };
+        const res = (0, __1.generateKomaciModule)(input);
+        expect(res).not.toContain('ErrorFunction');
+        expect(res).toContain('registerAdgFunction');
+        expect(res).toContain('doubleCount');
+    });
+    it('throws error for typescript files in non-lightning namespace', () => {
+        const testTsSource = `import { LightningElement } from 'lwc';
+
+        export default class TestComponent extends LightningElement {
+            private count: number = 0;
+
+            get doubleCount(): number {
+                return this.count * 2;
+            }
+
+            increment(): void {
+                this.count++;
+            }
+        }`;
+        const bundleConfig = {
+            namespace: 'c',
+            name: 'testComponent',
+            type: 'internal',
+            files: [
+                { fileName: 'testComponent.ts', source: testTsSource },
+                {
+                    fileName: 'testComponent.html',
+                    source: '<template><div>Test</div></template>',
+                },
+            ],
+            enableKomaci: true,
+            namespaceMapping: {},
+            npmModuleMapping: {},
+        };
+        const metadata = (0, metadata_1.collectBundleMetadata)(bundleConfig);
+        const inputFiles = Object.fromEntries(metadata.files
+            .map(({ fileName, komaciDoc }) => [fileName, komaciDoc])
+            .filter(([, komaciDoc]) => !!komaciDoc));
+        const input = {
+            moduleInfo: {
+                name: 'testComponent',
+                namespace: 'c',
+                type: 'bundle',
+                files: inputFiles,
+            },
+            srcFileMap: {
+                'testComponent.ts': testTsSource,
+                'testComponent.html': '<template><div>Test</div></template>',
+            },
+        };
+        const res = (0, __1.generateKomaciModule)(input);
+        // TypeScript files in non-lightning namespaces should now throw an error
+        expect(res).toContain('ErrorFunction');
+        expect(res).toContain('unsupported file extension: ts');
+    });
+});
 //# sourceMappingURL=index.spec.js.map

package/build/componentAstProcessing.d.ts

@@ -5,11 +5,12 @@ import { ModuleContext, ModuleMetadata, HoistedFunctionMetadata } from '@komaci/
 /**
  * Retrieve the file path for the js of a component
  * @param generatorState GeneratorState containg the GeneratorInput, which in turn contains the JS raw source file
+ * @param allowTypeScript Optional parameter to control whether TypeScript files should be considered. Defaults to true for backward compatibility.
  * @returns Returns raw source code as string for the js of a component if it exists in the srcFileMap
  *          Returns undefined if no JS source file (whose filename also matches the LWC module name) was included in the
  *          GeneratorState.GeneratorInput by lwc-platform, other calling code.
  */
-export declare function getComponentSrcJs(generatorInput: GeneratorInput): string | undefined;
+export declare function getComponentSrcJs(generatorInput: GeneratorInput, allowTypeScript?: boolean): string | undefined;
 /**
  * AST is traversed to see if they contain getter functions that are not valid. For each getter that is valid, we will
  * update contextual information about the class and pass back info about the valid getters.

package/build/componentAstProcessing.js

@@ -7,15 +7,17 @@ const common_shared_1 = require("@komaci/common-shared");
 /**
  * Retrieve the file path for the js of a component
  * @param generatorState GeneratorState containg the GeneratorInput, which in turn contains the JS raw source file
+ * @param allowTypeScript Optional parameter to control whether TypeScript files should be considered. Defaults to true for backward compatibility.
  * @returns Returns raw source code as string for the js of a component if it exists in the srcFileMap
  *          Returns undefined if no JS source file (whose filename also matches the LWC module name) was included in the
  *          GeneratorState.GeneratorInput by lwc-platform, other calling code.
  */
-function getComponentSrcJs(generatorInput) {
+function getComponentSrcJs(generatorInput, allowTypeScript = true) {
     let sourceCode;
     const moduleName = generatorInput.moduleInfo.name;
     if (generatorInput.srcFileMap) {
-        const filename = Object.keys(generatorInput.srcFileMap).find((filename) => (filename.endsWith('.js') || filename.endsWith('.ts')) &&
+        const filename = Object.keys(generatorInput.srcFileMap).find((filename) => (filename.endsWith('.js') ||
+            (filename.endsWith('.ts') && allowTypeScript)) &&
             filename.startsWith(moduleName));
         if (filename) {
             sourceCode = generatorInput.srcFileMap[filename];

package/build/index.js

@@ -86,6 +86,15 @@ function normalizeSrcFileKeys(input) {
     }
 }
 exports.normalizeSrcFileKeys = normalizeSrcFileKeys;
+/**
+ * Determines if TypeScript files should be processed for the given namespace.
+ * TypeScript files are only processed for lightning and lightning/interop namespaces.
+ * @param namespace the module namespace
+ * @returns true if TypeScript files should be processed
+ */
+function shouldProcessTypeScriptForNamespace(namespace) {
+    return namespace === 'lightning' || namespace.startsWith('lightning/interop');
+}
 /**
  * Helper function to process and build the resolvable module based off the generator input and inital generator state.
  * @param input the Generator input
@@ -97,14 +106,16 @@ function processGeneratorInputAndState(input) {
         // Determine file type based on extension in file name.
         const segments = (0, common_shared_1.getFilepathSegments)(input.moduleInfo.fileName);
         const fileExt = segments[segments.length - 1];
+        const namespace = input.moduleInfo.namespace;
+        const isTypeScriptAllowed = shouldProcessTypeScriptForNamespace(namespace);
         let sourceFile;
-        const source = (0, componentAstProcessing_1.getComponentSrcJs)(input);
+        const source = (0, componentAstProcessing_1.getComponentSrcJs)(input, isTypeScriptAllowed);
         if (fileExt === 'html') {
             const templateMap = {};
             templateMap[input.moduleInfo.name] = input.moduleInfo.komaciDoc;
             sourceFile = (0, genericAstGeneration_1.generateResolvableModule)(input, undefined, templateMap, source);
         }
-        else if (fileExt === 'js' || fileExt === 'ts') {
+        else if (fileExt === 'js' || (fileExt === 'ts' && isTypeScriptAllowed)) {
             sourceFile = (0, genericAstGeneration_1.generateResolvableModule)(input, input.moduleInfo.komaciDoc, undefined, source);
         }
         else {
@@ -116,38 +127,38 @@ function processGeneratorInputAndState(input) {
     else if (input.moduleInfo.type === 'bundle') {
         // code to process a bundle
         let filename = '', fileExt;
-        const docMap = input.moduleInfo.files; // {'test.html' : KomaciDoc1, 'test.js' : KomaciDoc2}
-        const filesMap = {}; // {'html' : {'test.html' : KomaciDoc1}, 'js' : {'test.js' : KomaciDoc2 }}
+        const namespace = input.moduleInfo.namespace;
+        const isTypeScriptAllowed = shouldProcessTypeScriptForNamespace(namespace);
+        const scriptDocs = {}; // {'test.js' : { filename: 'test', komaciDoc: KomaciDoc1 }}
+        const htmlDocs = {};
         let sourceFile;
-        for (const [fullFilename, komaciDoc] of Object.entries(docMap)) {
+        for (const [filePath, komaciDoc] of Object.entries(input.moduleInfo.files)) {
             // Determine file type based on extension in file name.
-            const segments = (0, common_shared_1.getFilepathSegments)(fullFilename);
+            const segments = (0, common_shared_1.getFilepathSegments)(filePath);
             filename = segments[0]; // the filename, up to but not including, the file separator character
             fileExt = segments[segments.length - 1]; // filename extension, not including the separator
-            let filesObj = {};
-            // check for existing map entry in order to append to it
-            // to support multiple files per filetype in the future
-            if (filesMap[fileExt]) {
-                filesObj = filesMap[fileExt];
-            }
-            filesObj[filename] = komaciDoc;
             if (fileExt == 'html') {
-                filesMap['html'] = filesObj;
+                htmlDocs[filename] = komaciDoc;
             }
-            else if (fileExt === 'js' || fileExt === 'ts') {
-                filesMap['js'] = filesObj;
+            else if (fileExt === 'js' || (fileExt === 'ts' && isTypeScriptAllowed)) {
+                scriptDocs[filePath] = { filename, komaciDoc };
             }
             else {
                 throw new Error(types_1.ERROR_PREFIX + 'unsupported file extension: ' + fileExt);
             }
         }
-        const source = (0, componentAstProcessing_1.getComponentSrcJs)(input);
-        const komaciJSDoc = filesMap && filesMap['js'] && filesMap['js'][input.moduleInfo.name]
-            ? filesMap['js'][input.moduleInfo.name]
-            : {};
-        const komaciHtmlDocMap = filesMap && filesMap['html'] ? filesMap['html'] : {};
+        const source = (0, componentAstProcessing_1.getComponentSrcJs)(input, isTypeScriptAllowed);
+        // Find the main component script file(s)
+        const mainComponentScriptFiles = Object.values(scriptDocs).filter(({ filename }) => filename === input.moduleInfo.name);
+        // For now we only support one main component script file.
+        if (mainComponentScriptFiles.length > 1) {
+            throw new Error(types_1.ERROR_PREFIX +
+                'multiple component script files with the same name found in bundle: ' +
+                input.moduleInfo.name);
+        }
+        const uniqueMainComponentScriptDoc = mainComponentScriptFiles[0]?.komaciDoc ?? {};
         // eslint-disable-next-line prefer-const
-        sourceFile = (0, genericAstGeneration_1.generateResolvableModule)(input, komaciJSDoc, komaciHtmlDocMap, source);
+        sourceFile = (0, genericAstGeneration_1.generateResolvableModule)(input, uniqueMainComponentScriptDoc, htmlDocs, source);
         // Generate source from constructed AST.
         const babelOutput = (0, generator_1.default)(sourceFile);
         return babelOutput.code;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@komaci/esm-generator",
-    "version": "260.38.0",
+    "version": "260.40.0",
     "description": "Komaci generator for ADG ES modules",
     "homepage": "https://komaci.dev/",
     "repository": {