@komaci/esm-generator 248.1.2 → 248.1.4

package/build/__tests__/compile-generated-module-fixtures.spec.js

@@ -10,7 +10,8 @@ const sfdc_lwc_compiler_1 = require("@lwc-platform/sfdc-lwc-compiler");
 const compilerConfigs_1 = require("./compilerConfigs");
 const EXPECTED_SRC_FILENAME = 'expected.src';
 describe('fixtures', () => {
-    const fixtures = (0, glob_1.globSync)(path_1.default.resolve(__dirname, '**/expected.src'));
+    //Adding filter on the resolvable modules we try to compile until the compiler has been updated to handle imported gql queries. Will be removed in W-14269523
+    const fixtures = (0, glob_1.globSync)(path_1.default.resolve(__dirname, '**/expected.src')).filter((e) => e != `${__dirname}/fixtures-gql/multipleGqlQueries/expected.src`);
     for (const caseEntry of fixtures) {
         const caseFolder = path_1.default.dirname(caseEntry);
         const caseName = path_1.default.relative(__dirname, caseFolder);

package/build/__tests__/compilerConfigs.d.ts

@@ -20,17 +20,5 @@ export declare const compilerConfigs: ({
         };
         compat?: undefined;
     };
-} | {
-    outputConfig: {
-        minify: boolean;
-        sourcemap: boolean;
-        env: {
-            NODE_ENV: string;
-        };
-        lockerConfig: {
-            sourcemap: string;
-        };
-        compat?: undefined;
-    };
 })[];
 //# sourceMappingURL=compilerConfigs.d.ts.map

package/build/__tests__/compilerConfigs.js

@@ -109,7 +109,7 @@ exports.compilerConfigs = [
             env: {
                 NODE_ENV: 'production',
             },
-            lockerConfig: { sourcemap: 'hidden' },
+            lockerConfig: { sourcemap: false },
         },
     },
     {
@@ -119,7 +119,7 @@ exports.compilerConfigs = [
             env: {
                 NODE_ENV: 'development',
             },
-            lockerConfig: { sourcemap: 'hidden' },
+            lockerConfig: { sourcemap: false },
         },
     },
 ];

package/build/__tests__/fixtures-gql/multipleGqlQueries/c/component/component.d.ts

@@ -0,0 +1,15 @@
+export default class KomaciAction extends LightningElement {
+    recordId: any;
+    temp: string;
+    accountQuery: any;
+    contactQuery: any;
+    get gqlFromGetter(): any;
+    get badGqlFromGetter(): any;
+    get variables(): {
+        id: any;
+    };
+    graphqlRecord: any;
+    graphqlContactRecord: any;
+}
+import { LightningElement } from "lwc";
+//# sourceMappingURL=component.d.ts.map

package/build/__tests__/fixtures-gql/multipleGqlQueries/c/component/component.js

@@ -0,0 +1,104 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lwc_1 = require("lwc");
+//an import to gql will still get hoisted since contactQuery will not be getting swapped out.
+const uiGraphQLApi_1 = require("lightning/uiGraphQLApi");
+class KomaciAction extends lwc_1.LightningElement {
+    constructor() {
+        super(...arguments);
+        this.temp = 'temp';
+        //Valid Query, all on one line.
+        // prettier-ignore
+        this.accountQuery = (0, uiGraphQLApi_1.gql) `query accountById($id: ID) {uiapi {query {Account(where: { Id: { eq: $id } }) @category(name: "recordQuery") {edges {node { Name @category(name: "StringValue") {valuedisplayValue}}}}}}}`;
+        //cannot apply metaschema directives, has expressions
+        this.contactQuery = (0, uiGraphQLApi_1.gql) `
+    query accountById($id: ID) {
+        uiapi {
+            query {
+                Contact(where: { Id: { eq: $id } }) @category(name: ${this.temp}) {
+                    edges {
+                        node {
+                            Name @category(name: "StringValue") {
+                                value
+                                displayValue
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+`;
+    }
+    //Getter with valid gql query, getter needs to return imported gql query.
+    get gqlFromGetter() {
+        return (0, uiGraphQLApi_1.gql) `
+            query accountById($id: ID) {
+                uiapi {
+                    query {
+                        Contact(where: { Id: { eq: $id } })
+                            @category(name: "recordQuery") {
+                            edges {
+                                node {
+                                    Name @category(name: "StringValue") {
+                                        value
+                                        displayValue
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        `;
+    }
+    //cannot apply metaschema directives, has expressions
+    get badGqlFromGetter() {
+        return (0, uiGraphQLApi_1.gql) `
+        query accountById($id: ID) {
+            uiapi {
+                query {
+                    Contact(where: { Id: { eq: $id } }) @category(name: "recordQuery") {
+                        edges {
+                            node {
+                                Name @category(name: ${this.temp}) {
+                                    value
+                                    displayValue
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    `;
+    }
+    get variables() {
+        return {
+            id: this.recordId,
+        };
+    }
+}
+__decorate([
+    lwc_1.api
+], KomaciAction.prototype, "recordId", void 0);
+__decorate([
+    (0, lwc_1.wire)(uiGraphQLApi_1.unstable_graphql, {
+        query: '$accountQuery',
+        variables: '$variables',
+    })
+], KomaciAction.prototype, "graphqlRecord", void 0);
+__decorate([
+    (0, lwc_1.wire)(uiGraphQLApi_1.unstable_graphql, {
+        query: '$contactQuery',
+        variables: '$variables',
+    })
+], KomaciAction.prototype, "graphqlContactRecord", void 0);
+exports.default = KomaciAction;
+//# sourceMappingURL=component.js.map

package/build/__tests__/fixtures-source-code/gqlMockSource.d.ts

@@ -0,0 +1,3 @@
+export declare const mockGqlQueries = "import { api, wire, LightningElement } from 'lwc';\nimport { gql, unstable_graphql } from 'lightning/uiGraphQLApi'; \n \nexport default class KomaciAction extends LightningElement {\n    @api recordId;\n\n    temp = \"temp\"; \n\n    accountQuery = gql`\n        query accountById($id: ID) {\n            uiapi {\n                query {\n                    Account(where: { Id: { eq: $id } }) @category(name: \"recordQuery\") {\n                        edges {\n                            node {\n                                Name @category(name: \"StringValue\") {\n                                    value\n                                    displayValue\n                                }\n                            }\n                        }\n                    }\n                }\n            }\n        }\n    `;\n\n    contactQuery = gql`\n    query accountById($id: ID) {\n        uiapi {\n            query {\n                Contact(where: { Id: { eq: $id } }) @category(name: ${this.temp}) {\n                    edges {\n                        node {\n                            Name @category(name: \"StringValue\") {\n                                value\n                                displayValue\n                            }\n                        }\n                    }\n                }\n            }\n        }\n    }\n`;\n\nget gqlFromGetter(){\n    return gql`\n    query accountById($id: ID) {\n        uiapi {\n            query {\n                Contact(where: { Id: { eq: $id } }) @category(name: \"recordQuery\") {\n                    edges {\n                        node {\n                            Name @category(name: \"StringValue\") {\n                                value\n                                displayValue\n                            }\n                        }\n                    }\n                }\n            }\n        }\n    }\n`;\n}\n\n    get variables() {\n        return {\n            id: this.recordId,\n        };\n    }\n\n    @wire(unstable_graphql, {\n        query: '$accountQuery',\n        variables: '$variables',\n    })\n    graphqlRecord;\n\n    @wire(unstable_graphql, {\n        query: '$contactQuery',\n        variables: '$variables',\n    })\n    graphqlContactRecord;\n} \n";
+export declare const expectedGetterWithGql = "\nfunction g0(props) {\nreturn gql0;\n}\n";
+//# sourceMappingURL=gqlMockSource.d.ts.map

package/build/__tests__/fixtures-source-code/gqlMockSource.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.expectedGetterWithGql = exports.mockGqlQueries = void 0;
+exports.mockGqlQueries = `import { api, wire, LightningElement } from 'lwc';
+import { gql, unstable_graphql } from 'lightning/uiGraphQLApi'; 
+ 
+export default class KomaciAction extends LightningElement {
+    @api recordId;
+
+    temp = "temp"; 
+
+    accountQuery = gql\`
+        query accountById($id: ID) {
+            uiapi {
+                query {
+                    Account(where: { Id: { eq: $id } }) @category(name: "recordQuery") {
+                        edges {
+                            node {
+                                Name @category(name: "StringValue") {
+                                    value
+                                    displayValue
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    \`;
+
+    contactQuery = gql\`
+    query accountById($id: ID) {
+        uiapi {
+            query {
+                Contact(where: { Id: { eq: $id } }) @category(name: \${this.temp}) {
+                    edges {
+                        node {
+                            Name @category(name: "StringValue") {
+                                value
+                                displayValue
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+\`;
+
+get gqlFromGetter(){
+    return gql\`
+    query accountById($id: ID) {
+        uiapi {
+            query {
+                Contact(where: { Id: { eq: $id } }) @category(name: "recordQuery") {
+                    edges {
+                        node {
+                            Name @category(name: "StringValue") {
+                                value
+                                displayValue
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+\`;
+}
+
+    get variables() {
+        return {
+            id: this.recordId,
+        };
+    }
+
+    @wire(unstable_graphql, {
+        query: '$accountQuery',
+        variables: '$variables',
+    })
+    graphqlRecord;
+
+    @wire(unstable_graphql, {
+        query: '$contactQuery',
+        variables: '$variables',
+    })
+    graphqlContactRecord;
+} 
+`;
+exports.expectedGetterWithGql = `
+function g0(props) {
+return gql0;
+}
+`;
+//# sourceMappingURL=gqlMockSource.js.map

package/build/__tests__/functionAstGeneration.spec.js

@@ -36,6 +36,7 @@ const generator_1 = __importDefault(require("@babel/generator"));
 const badImportRef_1 = require("./fixtures-source-code/badImportRef");
 const t = __importStar(require("@babel/types"));
 const generalMockSourceCode_1 = require("./fixtures-source-code/generalMockSourceCode");
+const gqlMockSource_1 = require("./fixtures-source-code/gqlMockSource");
 describe('hoistLocalFunction', () => {
     const baseFilesPath = (0, path_1.join)(__dirname, 'general-komaci-docs/assorted-template-strings');
     const src = (0, fs_1.readFileSync)((0, path_1.join)(baseFilesPath, 'source.js'), {
@@ -76,8 +77,10 @@ describe('hoistLocalFunction', () => {
         usedInPriming: true,
         staticallyAnalyzable: false,
     });
-    const hoistedFirstFunc = (0, functionAstGeneration_1.hoistLocalFunction)(firstTemplateStringFunc, imports);
-    const hoistedSecondFunc = (0, functionAstGeneration_1.hoistLocalFunction)(secondTemplateStringFunc, imports);
+    const moduleMetadata = (0, common_shared_1.initModuleMetadataObject)();
+    moduleMetadata.importsByName = imports;
+    const hoistedFirstFunc = (0, functionAstGeneration_1.hoistLocalFunction)(firstTemplateStringFunc, moduleMetadata);
+    const hoistedSecondFunc = (0, functionAstGeneration_1.hoistLocalFunction)(secondTemplateStringFunc, moduleMetadata);
     it('can compose a template string for a public api prop', () => {
         expect(hoistedFirstFunc).not.toBeUndefined();
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -164,7 +167,7 @@ describe('hoistlocalfunction for render function', () => {
             requiredProperties: ['templateOne'],
             generatedName: `hoistedRenderFunction`,
         };
-        const hoistedRenderFunction = (0, functionAstGeneration_1.hoistLocalFunction)(renderFunctionMetadata, moduleMetadata.importsByName);
+        const hoistedRenderFunction = (0, functionAstGeneration_1.hoistLocalFunction)(renderFunctionMetadata, moduleMetadata);
         expect(hoistedRenderFunction).not.toBeUndefined();
         const hoistedBodyStatements = hoistedRenderFunction?.body.body;
         expect(hoistedBodyStatements).not.toBeUndefined();
@@ -190,7 +193,7 @@ describe('hoistlocalfunction for render function', () => {
             requiredProperties: ['templateOne'],
             generatedName: `hoistedRenderFunction`,
         };
-        const hoistedRenderFunction = (0, functionAstGeneration_1.hoistLocalFunction)(renderFunctionMetadata, moduleMetadata.importsByName);
+        const hoistedRenderFunction = (0, functionAstGeneration_1.hoistLocalFunction)(renderFunctionMetadata, moduleMetadata);
         expect(hoistedRenderFunction).not.toBeUndefined();
         const hoistedBodyStatements = hoistedRenderFunction?.body.body;
         expect(hoistedBodyStatements).not.toBeUndefined();
@@ -214,7 +217,7 @@ describe('hoistlocalfunction for render function', () => {
             requiredProperties: ['templateOne'],
             generatedName: `hoistedRenderFunction`,
         };
-        const hoistedRenderFunction = (0, functionAstGeneration_1.hoistLocalFunction)(renderFunctionMetadata, moduleMetadata.importsByName);
+        const hoistedRenderFunction = (0, functionAstGeneration_1.hoistLocalFunction)(renderFunctionMetadata, moduleMetadata);
         expect(hoistedRenderFunction).not.toBeUndefined();
         const hoistedBodyStatements = hoistedRenderFunction?.body.body;
         expect(hoistedBodyStatements).not.toBeUndefined();
@@ -261,14 +264,14 @@ describe('sanitizeFunction', () => {
         komaciDocImportRef: '1/names/0',
     });
     it('should be able to clean up and hoist a function with valid import references', () => {
-        (0, functionAstGeneration_1.sanitizeFunction)(getters[0], imports);
+        (0, functionAstGeneration_1.sanitizeFunction)(getters[0], imports, new Map());
         const hoisted = (0, types_1.functionDeclaration)((0, types_1.identifier)('g0'), [(0, types_1.identifier)('props')], // make 'props' an input parameter to the hoisted getter
         getters[0].node.body);
         const generatedFunction = (0, generator_1.default)((0, types_1.file)((0, types_1.program)([hoisted])));
         expect(generatedFunction.code).toBe(badImportRef_1.expectedGoodHoist);
     });
     it('should throw an error if we try to reference a bad input', () => {
-        expect(() => (0, functionAstGeneration_1.sanitizeFunction)(getters[1], imports)).toThrowError(new Error(`${common_shared_1.ERROR_PREFIX}: 'bad' does not map to valid import`));
+        expect(() => (0, functionAstGeneration_1.sanitizeFunction)(getters[1], imports, new Map())).toThrowError(new Error(`${common_shared_1.ERROR_PREFIX}: 'bad' does not map to valid import`));
     });
 });
 describe('adgToExpression', () => {
@@ -582,4 +585,83 @@ describe('composeSelfServiceAssignmentExpression', () => {
         expect(right.value).toBeTruthy();
     });
 });
+describe('sanitizeFunction gql usecases', () => {
+    const ast = (0, common_shared_1.generateAstFromSrcCode)(gqlMockSource_1.mockGqlQueries);
+    const { getters, templateStrings } = (0, common_shared_1.getPropertyMetadataFromAst)(ast);
+    const imports = new Map();
+    const gqlMetadata = new Map();
+    //Gql query from getter
+    const gqlMetadata0 = {
+        hash: '123456',
+        hasExpressions: false,
+        location: {
+            startLine: 0,
+            endLine: 0,
+            startColumn: 0,
+            endColumn: 0,
+            start: 1345,
+            end: 1845,
+        },
+        isHoisted: false,
+        valid: true,
+        generatedImportAlias: 'gql0',
+        importPath: 'temp/path',
+    };
+    gqlMetadata.set('loc_1354_1845', gqlMetadata0);
+    //Invalid gql query
+    const gqlMetadata1 = {
+        hash: '123456',
+        hasExpressions: true,
+        location: {
+            startLine: 0,
+            endLine: 0,
+            startColumn: 0,
+            endColumn: 0,
+            start: 826,
+            end: 1316,
+        },
+        isHoisted: false,
+        valid: false,
+        generatedImportAlias: 'gql1',
+        importPath: 'temp/path',
+    };
+    gqlMetadata.set('loc_826_1316', gqlMetadata1);
+    //valid gql query
+    const gqlMetadata2 = {
+        hash: '123456',
+        hasExpressions: false,
+        location: {
+            startLine: 0,
+            endLine: 0,
+            startColumn: 0,
+            endColumn: 0,
+            start: 242,
+            end: 801,
+        },
+        isHoisted: false,
+        valid: true,
+        generatedImportAlias: 'gql2',
+        importPath: 'temp/path',
+    };
+    gqlMetadata.set('loc_242_801', gqlMetadata2);
+    it('should replace getter return with proper import id', () => {
+        (0, functionAstGeneration_1.sanitizeFunction)(getters[0], imports, gqlMetadata);
+        const hoisted = (0, types_1.functionDeclaration)((0, types_1.identifier)('g0'), [(0, types_1.identifier)('props')], // make 'props' an input parameter to the hoisted getter
+        getters[0].node.body);
+        const generatedFunction = (0, generator_1.default)((0, types_1.file)((0, types_1.program)([hoisted])));
+        expect(generatedFunction.code.trim).toBe(gqlMockSource_1.expectedGetterWithGql.trim);
+    });
+    it('swaps out the gql query with the proper generated import alias', () => {
+        (0, functionAstGeneration_1.sanitizeFunction)(templateStrings[0], imports, gqlMetadata);
+        const tmplString = templateStrings[0];
+        expect(tmplString.node.value?.type).toBe('Identifier');
+        const id = tmplString.node.value.name;
+        expect(id).toBe('gql2');
+    });
+    it('does not swap out gql query if has expression or is invalid', () => {
+        (0, functionAstGeneration_1.sanitizeFunction)(templateStrings[1], imports, gqlMetadata);
+        const tmplString = templateStrings[1];
+        expect(tmplString.node.value?.type).toBe('TaggedTemplateExpression');
+    });
+});
 //# sourceMappingURL=functionAstGeneration.spec.js.map

package/build/__tests__/genericAstGeneration.spec.js

@@ -966,4 +966,48 @@ describe('valueReferenceToExpression', () => {
         expect(obj.properties[1].value.value).toBe('reference');
     });
 });
+describe('generateGqlImportStatement', () => {
+    it('generates the import statement properly', () => {
+        const gqlMetadataMap = new Map();
+        const gqlMetadata = {
+            hash: '123456',
+            hasExpressions: false,
+            location: {
+                startLine: 0,
+                endLine: 0,
+                startColumn: 0,
+                endColumn: 0,
+                start: 242,
+                end: 801,
+            },
+            isHoisted: false,
+            valid: true,
+            generatedImportAlias: '_123456',
+            importPath: '@salesforce/lds/c__component',
+        };
+        gqlMetadataMap.set('loc_242_801', gqlMetadata);
+        const gqlMetadata2 = {
+            hash: '123456789',
+            hasExpressions: true,
+            location: {
+                startLine: 0,
+                endLine: 0,
+                startColumn: 0,
+                endColumn: 0,
+                start: 826,
+                end: 1316,
+            },
+            isHoisted: false,
+            valid: false,
+            generatedImportAlias: '_123456789',
+            importPath: 'temp/path',
+        };
+        gqlMetadataMap.set('loc_826_1316', gqlMetadata2);
+        const statements = [];
+        (0, genericAstGeneration_1.generateGqlImportStatements)(gqlMetadataMap, statements);
+        expect(statements).toHaveLength(1);
+        const code = (0, generator_1.default)(statements[0]).code;
+        expect(code).toBe('import { _123456 } from "@salesforce/lds/c__component";');
+    });
+});
 //# sourceMappingURL=genericAstGeneration.spec.js.map

package/build/__tests__/komaci-gql.fixtures.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=komaci-gql.fixtures.spec.d.ts.map

package/build/__tests__/komaci-gql.fixtures.spec.js

@@ -0,0 +1,123 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const glob_1 = require("glob");
+const path_1 = __importDefault(require("path"));
+const index_1 = require("../index");
+const fs_2 = require("fs");
+const path_2 = require("path");
+const metadata_1 = require("@lwc/metadata");
+const FIXTURES_DIR = path_1.default.join(__dirname, 'fixtures-gql');
+const EXPECTED_JS_FILENAME = 'expected.src';
+// eslint-disable-next-line jest/no-disabled-tests
+describe('fixtures', () => {
+    // find all folder paths containing a directory called component. This gives us the flexability to name the parent directory
+    // either lightning for external comps and c for internal comps.
+    const fixturePath = path_1.default.resolve(FIXTURES_DIR, '**/*/component');
+    const fixtures = (0, glob_1.globSync)(fixturePath);
+    for (const caseEntry of fixtures) {
+        const caseFolder = path_1.default.dirname(caseEntry);
+        const relativePath = path_1.default.relative(FIXTURES_DIR, caseFolder);
+        const caseName = relativePath.split('/')[0];
+        const expectedSrcFilePath = () => {
+            return (caseFolder.slice(0, caseFolder.lastIndexOf('/')) +
+                '/' +
+                EXPECTED_JS_FILENAME);
+        };
+        const readFixtureFile = (filePath) => {
+            return fs_1.default.existsSync(filePath) ? fs_1.default.readFileSync(filePath, 'utf-8') : null;
+        };
+        const writeFixtureFile = (filePath, content) => {
+            fs_1.default.writeFileSync(filePath, content, { encoding: 'utf-8' });
+        };
+        it(`${caseName}`, () => {
+            const expectedFilePath = expectedSrcFilePath();
+            const actualModuleSrc = readAndParseBundle(caseEntry, {
+                enableKomaci: true,
+                type: 'internal',
+                enableLuvio: true,
+            }).output.modGenOutput;
+            let expectedModuleSrc = readFixtureFile(expectedFilePath);
+            if (expectedModuleSrc == '') {
+                // write file if doesn't exist (ie new fixture)
+                expectedModuleSrc = actualModuleSrc;
+                writeFixtureFile(expectedFilePath, expectedModuleSrc);
+            }
+            // check that the actual newly generated mod source matches expected
+            expect(actualModuleSrc).toEqual(expectedModuleSrc);
+        });
+    }
+});
+/**
+ * Finds all .js, .mjs, .css, and .html files within the given directory, reads their contents, and combines them into a bundle,
+ * and returning the array of BundleFile containing the file's fileName and source
+ * @param path
+ * @returns An array of BundleFile
+ */
+function readBundle(path) {
+    path = (0, path_2.resolve)(path);
+    if ((0, fs_2.existsSync)(path)) {
+        const contents = (0, fs_2.readdirSync)(path);
+        const LWC_EXT = ['.js', '.mjs', '.css', '.html'];
+        const lwcBundleFiles = contents.filter((filename) => {
+            return LWC_EXT.includes((0, path_2.extname)(filename));
+        });
+        return lwcBundleFiles.map((fileName) => ({
+            fileName,
+            source: (0, fs_2.readFileSync)((0, path_2.resolve)(path, fileName), 'utf-8').toString(),
+        }));
+    }
+    else {
+        throw new Error(`path doesn't exist: ${path}`);
+    }
+}
+/**
+ * Takes the directory path of an LWC module bundle and an optional set of config overrides. Returns the ParsedBundle, inlcuding
+ * the bundle's 1) LWC Metadata and 2) Komaci / Resolvable module.
+ * @param path
+ * @param configOverrides
+ * @returns ParsedBundle that includes the BundleConfig & GeneratorInput inputs, and BundleMetadata and generated module output
+ */
+function readAndParseBundle(path, configOverrides) {
+    const files = readBundle(path);
+    const name = (0, path_2.basename)(path);
+    const namespace = (0, path_2.basename)((0, path_2.dirname)(path));
+    const bundleConfig = {
+        namespace,
+        name,
+        type: 'internal',
+        namespaceMapping: {},
+        files,
+        enableKomaci: true,
+        ...configOverrides,
+    };
+    const metadata = (0, metadata_1.collectBundleMetadata)(bundleConfig);
+    // Create input to module generator.
+    const srcFileMap = files.reduce((map, { fileName, source }) => ({ ...map, [fileName]: source }), {});
+    const inputFiles = Object.fromEntries(metadata.files
+        .map(({ fileName, komaciDoc }) => [fileName, komaciDoc])
+        .filter(([, komaciDoc]) => !!komaciDoc));
+    //Need to come back and clean this up, will be taken care of in a futire WI
+    const luvioMetadata = metadata.files.filter((file) => file.fileType == 'js' &&
+        file.luvioMetadata != undefined &&
+        file.luvioMetadata.gqlTag.length > 0).map((file) => file.luvioMetadata)[0];
+    const generatorInput = {
+        moduleInfo: {
+            name,
+            namespace: bundleConfig.namespace,
+            type: 'bundle',
+            files: inputFiles,
+        },
+        srcFileMap,
+        luvioMetadata: luvioMetadata,
+    };
+    const modGenOutput = (0, index_1.generateKomaciModule)(generatorInput);
+    return {
+        input: { bundleConfig, generatorInput },
+        output: { modGenOutput, metadata },
+    };
+}
+//# sourceMappingURL=komaci-gql.fixtures.spec.js.map

package/build/functionAstGeneration.d.ts

@@ -1,6 +1,6 @@
 import { NodePath } from '@babel/core';
 import * as t from '@babel/types';
-import { AdgMetadata, HoistedFunctionMetadata, IdKeys, ImportMetadata, ModuleMetadata } from '@komaci/common-shared';
+import { AdgMetadata, HoistedFunctionMetadata, IdKeys, ImportMetadata, ModuleMetadata, GqlMetadata } from '@komaci/common-shared';
 import { Composition } from '@komaci/types';
 /**
  * Take a local function (getter, template string, etc) and prepare it for the resolvable module
@@ -13,7 +13,7 @@ import { Composition } from '@komaci/types';
  * @returns a composed module level function or undefined if we don't have the
  *          information for composing the funciton
  */
-export declare function hoistLocalFunction(functionMetadata: HoistedFunctionMetadata, importMetadata: Map<string, ImportMetadata>): t.FunctionDeclaration | undefined;
+export declare function hoistLocalFunction(functionMetadata: HoistedFunctionMetadata, ModuleMetadata: ModuleMetadata): t.FunctionDeclaration | undefined;
 /**
  * Take a function defined on a class and sanitize it's interactions in preparation to be hoisted into resolvable module/
  *
@@ -24,7 +24,7 @@ export declare function hoistLocalFunction(functionMetadata: HoistedFunctionMeta
  * @param nodePath The node to sanitize
  * @param importMetadata Metadata about all the imports we know about
  */
-export declare function sanitizeFunction(nodePath: NodePath<t.ClassProperty | t.ClassMethod>, importMetadata: Map<string, ImportMetadata>): void;
+export declare function sanitizeFunction(nodePath: NodePath<t.ClassProperty | t.ClassMethod>, importMetadata: Map<string, ImportMetadata>, gqlMetadataMap: Map<string, GqlMetadata>): void;
 /**
  * Converts a Komaci ADG into a CallExpression to the ADG factory function
  * call for the Resolver API.

package/build/functionAstGeneration.js

@@ -40,9 +40,9 @@ const types_1 = require("./types");
  * @returns a composed module level function or undefined if we don't have the
  *          information for composing the funciton
  */
-function hoistLocalFunction(functionMetadata, importMetadata) {
+function hoistLocalFunction(functionMetadata, ModuleMetadata) {
     if (functionMetadata.componentAstNode && functionMetadata.generatedName) {
-        sanitizeFunction(functionMetadata.componentAstNode, importMetadata);
+        sanitizeFunction(functionMetadata.componentAstNode, ModuleMetadata.importsByName, ModuleMetadata.gqlMetadata);
         const propsId = t.identifier(common_shared_1.PROPS);
         const functionBody = t.isClassMethod(functionMetadata.componentAstNode.node)
             ? functionMetadata.componentAstNode.node.body
@@ -66,7 +66,7 @@ exports.hoistLocalFunction = hoistLocalFunction;
  * @param nodePath The node to sanitize
  * @param importMetadata Metadata about all the imports we know about
  */
-function sanitizeFunction(nodePath, importMetadata) {
+function sanitizeFunction(nodePath, importMetadata, gqlMetadataMap) {
     const Visitors = {
         Identifier(path) {
             if ((path.parent.type === 'MemberExpression' &&
@@ -106,6 +106,14 @@ function sanitizeFunction(nodePath, importMetadata) {
                 path.replaceWith(t.memberExpression(t.identifier(common_shared_1.PROPS), path.node.property)); // replace this.<var> with props.<var>
             }
         },
+        TaggedTemplateExpression(path) {
+            const taggedTmplExpr = path.node;
+            const taggedTmplLiteral = taggedTmplExpr.quasi;
+            const gqlMetadata = (0, common_shared_1.getGqlMetadataForTaggedTemplate)(taggedTmplLiteral, gqlMetadataMap);
+            if (gqlMetadata && gqlMetadata.valid) {
+                path.replaceWith(t.identifier(gqlMetadata.generatedImportAlias));
+            }
+        },
     };
     nodePath.traverse(Visitors);
 }

package/build/genericAstGeneration.d.ts

@@ -1,4 +1,4 @@
-import { ClassPropertyContext, ErrorFunctionMetadata, FunctionMetadata, ModuleMetadata, WireFunctionMetadata } from '@komaci/common-shared';
+import { ClassPropertyContext, ErrorFunctionMetadata, FunctionMetadata, ModuleMetadata, WireFunctionMetadata, GqlMetadata } from '@komaci/common-shared';
 import * as t from '@babel/types';
 import { GeneratorInput } from './types';
 import { Binding, PrimitiveValue, PropertyReference, Value, KomaciDocument } from '@komaci/types';
@@ -32,6 +32,12 @@ export declare function generateResolvableModule(input: GeneratorInput, scriptKo
 export declare function addImportStatements(moduleMetadata: ModuleMetadata, statements: t.Statement[], options: {
     isComposingFromBundle: boolean;
 }): void;
+/**
+ * Function to generate an import statement for a valid Gql Query
+ * @param gqlMetadata the gql metadata object
+ * @param statements the ast statement array.
+ */
+export declare function generateGqlImportStatements(gqlMetadata: Map<string, GqlMetadata>, statements: t.Statement[]): void;
 /**
  * Make ast statements for the details about an error we received
  * @param adgFunc The error function metadata

package/build/genericAstGeneration.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.collectMetadataForImportedTemplates = exports.exportNamedDeclarationForDynamicImport = exports.addUndefinedDefaultExport = exports.propertyToExpression = exports.functionToExpression = exports.valueReferenceToExpression = exports.bindingToExpression = exports.primitiveToExpression = exports.valueToExpression = exports.processWireFunctionType = exports.processErrorFunction = exports.addImportStatements = exports.generateResolvableModule = void 0;
+exports.collectMetadataForImportedTemplates = exports.exportNamedDeclarationForDynamicImport = exports.addUndefinedDefaultExport = exports.propertyToExpression = exports.functionToExpression = exports.valueReferenceToExpression = exports.bindingToExpression = exports.primitiveToExpression = exports.valueToExpression = exports.processWireFunctionType = exports.processErrorFunction = exports.generateGqlImportStatements = exports.addImportStatements = exports.generateResolvableModule = void 0;
 const common_shared_1 = require("@komaci/common-shared");
 const static_analyzer_1 = require("@komaci/static-analyzer");
 const t = __importStar(require("@babel/types"));
@@ -83,6 +83,10 @@ function generateResolvableModule(input, scriptKomaciDoc, templateKomaciDocMap,
         componentDefaultAdgIndex = scriptKomaciDoc.exports?.default?.value;
         scriptKomaciDoc.adgs?.forEach((_, index) => (0, common_shared_1.initalizeAdgMetadata)(index, scriptKomaciDoc, moduleMetadata, componentDefaultAdgIndex === index && ast !== undefined, isBundle));
         (0, common_shared_1.mapExportNamesToAdgs)(scriptKomaciDoc.exports, moduleMetadata);
+        //we have a gql tag init the map
+        if (input.luvioMetadata && input.luvioMetadata?.gqlTag.length > 0) {
+            (0, common_shared_1.initGqlMetadata)(input.luvioMetadata.gqlTag, moduleMetadata, input.moduleInfo.namespace, input.moduleInfo.name);
+        }
         if (ast && componentDefaultAdgIndex !== undefined) {
             const { getters, templateStrings, renderFunction } = (0, common_shared_1.getPropertyMetadataFromAst)(ast);
             const moduleContext = {
@@ -136,6 +140,10 @@ function generateResolvableModule(input, scriptKomaciDoc, templateKomaciDocMap,
     addImportStatements(moduleMetadata, statements, {
         isComposingFromBundle: isBundle,
     });
+    //we have the potential for valid gql queries that need import statements.
+    if (moduleMetadata.gqlMetadata.size > 0) {
+        generateGqlImportStatements(moduleMetadata.gqlMetadata, statements);
+    }
     // template only resolvable modules are composed completely differently (for now)
     if (!combinedModule && hasTemplateKomaciDoc) {
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -167,14 +175,14 @@ function generateResolvableModule(input, scriptKomaciDoc, templateKomaciDocMap,
             defaultAdg?.functions.forEach((func) => {
                 if (func.type === common_shared_1.FunctionTypes.GETTER_FUNCTION ||
                     func.type === common_shared_1.FunctionTypes.TEMPLATE_STRING) {
-                    const hoistedFunction = (0, functionAstGeneration_1.hoistLocalFunction)(func, moduleMetadata.importsByName);
+                    const hoistedFunction = (0, functionAstGeneration_1.hoistLocalFunction)(func, moduleMetadata);
                     if (hoistedFunction) {
                         statements.push(hoistedFunction);
                     }
                 }
             });
             if (renderFunctionMetadata) {
-                const hoistedRenderFunction = (0, functionAstGeneration_1.hoistLocalFunction)(renderFunctionMetadata, moduleMetadata.importsByName);
+                const hoistedRenderFunction = (0, functionAstGeneration_1.hoistLocalFunction)(renderFunctionMetadata, moduleMetadata);
                 if (hoistedRenderFunction) {
                     statements.push(hoistedRenderFunction);
                 }
@@ -285,6 +293,28 @@ function addImportStatements(moduleMetadata, statements, options) {
     }
 }
 exports.addImportStatements = addImportStatements;
+/**
+ * Function to generate an import statement for a valid Gql Query
+ * @param gqlMetadata the gql metadata object
+ * @param statements the ast statement array.
+ */
+function generateGqlImportStatements(gqlMetadata, statements) {
+    const importsToMake = new Map();
+    gqlMetadata.forEach((value) => {
+        if (value.valid) {
+            let imports = [];
+            if (!importsToMake.has(value.importPath)) {
+                importsToMake.set(value.importPath, imports);
+                const importStatement = t.importDeclaration(imports, t.stringLiteral(value.importPath));
+                statements.push(importStatement);
+            }
+            imports = importsToMake.get(value.importPath);
+            const aliasIdentifier = t.identifier(value.generatedImportAlias);
+            imports.push(t.importSpecifier(aliasIdentifier, aliasIdentifier));
+        }
+    });
+}
+exports.generateGqlImportStatements = generateGqlImportStatements;
 /**
  * Make ast statements for the details about an error we received
  * @param adgFunc The error function metadata

package/build/types.d.ts

@@ -19,7 +19,8 @@ export declare type GeneratorInput = {
     srcFileMap?: {
         [filename: string]: string;
     };
-    luvioMetadata?: Map<string, LuvioMetadata | undefined>;
+    /** This will always be the luvio metadata for the core js file for a component. */
+    luvioMetadata?: LuvioMetadata | undefined;
 };
 declare type ModuleInfo = {
     type: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@komaci/esm-generator",
-    "version": "248.1.2",
+    "version": "248.1.4",
     "description": "Komaci generator for ADG ES modules",
     "homepage": "https://komaci.dev/",
     "repository": {
@@ -29,12 +29,12 @@
         "@babel/core": "^7.9.0",
         "@babel/generator": "^7.9.0",
         "@babel/types": "^7.9.0",
-        "@komaci/common-shared": "248.1.2",
-        "@komaci/static-analyzer": "248.1.2"
+        "@komaci/common-shared": "248.1.4",
+        "@komaci/static-analyzer": "248.1.4"
     },
     "devDependencies": {
-        "@komaci/types": "248.1.2",
-        "@lwc-platform/sfdc-lwc-compiler": "244.17.2-2.40.0",
-        "@lwc/metadata": "2.40.0-0"
+        "@komaci/types": "248.1.4",
+        "@lwc-platform/sfdc-lwc-compiler": "248.3.9-3.5.0",
+        "@lwc/metadata": "3.5.0-0"
     }
 }