@komaci/esm-generator 244.1.0 → 244.1.3

package/build/__tests__/adgAstGeneration.spec.js

@@ -34,7 +34,7 @@ describe('composeAdgStaticMetadata', () => {
         const moduleMetadata = (0, common_shared_1.initModuleMetadataObject)();
         const adg = (0, common_shared_1.initAdgMetadataObject)('adg0');
         adg.exportName = 'default';
-        moduleMetadata.defaultComponentId = 'c-test-comp';
+        moduleMetadata.staticMetadataId = 'c-test-comp';
         const res = (0, functionAstGeneration_1.composeAdgStaticMetadata)(adg, moduleMetadata);
         expect(res.type).toBe('VariableDeclaration');
         const varDeclarator = res.declarations[0];
@@ -47,7 +47,7 @@ describe('composeAdgStaticMetadata', () => {
         const moduleMetadata = (0, common_shared_1.initModuleMetadataObject)();
         const adg = (0, common_shared_1.initAdgMetadataObject)('adg1');
         adg.exportName = 'base';
-        moduleMetadata.defaultComponentId = 'c-test-comp';
+        moduleMetadata.staticMetadataId = 'c-test-comp';
         const res = (0, functionAstGeneration_1.composeAdgStaticMetadata)(adg, moduleMetadata);
         expect(res.type).toBe('VariableDeclaration');
         const varDeclarator = res.declarations[0];
@@ -60,7 +60,7 @@ describe('composeAdgStaticMetadata', () => {
         const moduleMetadata = (0, common_shared_1.initModuleMetadataObject)();
         const adg = (0, common_shared_1.initAdgMetadataObject)('adg0');
         adg.exportName = 'default';
-        moduleMetadata.defaultComponentId = 'c-test-comp';
+        moduleMetadata.staticMetadataId = 'c-test-comp';
         adg.compositionRootIndex = 0;
         adg.compositions = [
             {
@@ -123,7 +123,7 @@ describe('composeAdgStaticMetadata', () => {
         const moduleMetadata = (0, common_shared_1.initModuleMetadataObject)();
         const adg = (0, common_shared_1.initAdgMetadataObject)('adg0');
         adg.exportName = 'default';
-        moduleMetadata.defaultComponentId = 'c-test-comp';
+        moduleMetadata.staticMetadataId = 'c-test-comp';
         adg.compositionRootIndex = 0;
         const primingFunction = {
             requiredProperties: [],
@@ -144,7 +144,7 @@ describe('composeAdgStaticMetadata', () => {
         const moduleMetadata = (0, common_shared_1.initModuleMetadataObject)();
         const adg = (0, common_shared_1.initAdgMetadataObject)('adg0');
         adg.exportName = 'default';
-        moduleMetadata.defaultComponentId = 'c-test-comp';
+        moduleMetadata.staticMetadataId = 'c-test-comp';
         adg.compositionRootIndex = 0;
         const primingFunction = {
             requiredProperties: [],
@@ -165,7 +165,7 @@ describe('composeAdgStaticMetadata', () => {
         const moduleMetadata = (0, common_shared_1.initModuleMetadataObject)();
         const adg = (0, common_shared_1.initAdgMetadataObject)('adg0');
         adg.exportName = 'default';
-        moduleMetadata.defaultComponentId = 'c-test-comp';
+        moduleMetadata.staticMetadataId = 'c-test-comp';
         adg.compositionRootIndex = 0;
         const primingFunction = {
             requiredProperties: [],
@@ -181,5 +181,24 @@ describe('composeAdgStaticMetadata', () => {
         expect(properties[0].value.value).toBe('c-test-comp');
         expect(properties[2].value.value).toBeFalsy();
     });
+    it('Correct id for non exported class', () => {
+        const moduleMetadata = (0, common_shared_1.initModuleMetadataObject)();
+        const adg = (0, common_shared_1.initAdgMetadataObject)('adg0');
+        moduleMetadata.staticMetadataId = 'c-test-comp';
+        adg.compositionRootIndex = 0;
+        const primingFunction = {
+            requiredProperties: [],
+            type: common_shared_1.FunctionTypes.GETTER_FUNCTION,
+        };
+        adg.functions.push(primingFunction);
+        const res = (0, functionAstGeneration_1.composeAdgStaticMetadata)(adg, moduleMetadata);
+        expect(res.type).toBe('VariableDeclaration');
+        const varDeclarator = res.declarations[0];
+        expect(varDeclarator.id.name).toBe('adg0Meta');
+        const properties = varDeclarator.init.properties;
+        expect(properties).toHaveLength(4);
+        expect(properties[0].value.value).toBe('c-test-comp__$nonExportedClass$');
+        expect(properties[2].value.value).toBeFalsy();
+    });
 });
 //# sourceMappingURL=adgAstGeneration.spec.js.map

package/build/__tests__/compositionAstGeneration.spec.js

@@ -419,5 +419,40 @@ describe('getCompositionConfig', () => {
         const code = (0, generator_1.default)(res).code;
         expect(code).toBe('{}');
     });
+    it('can handle a prop name having special characters', () => {
+        const res = (0, compositionAstGeneration_1.getCompositionConfig)({
+            type: 'ComposedAdg',
+            input: {
+                type: 'ImportReference',
+                value: '0/names/0',
+            },
+            properties: {
+                'foo:baz': {
+                    type: 'PrimitiveValue',
+                    value: 'bar',
+                },
+                'baz:foo': {
+                    type: 'Binding',
+                    value: 'bar',
+                },
+                baz: {
+                    type: 'Binding',
+                    value: 'bar',
+                },
+                foo: {
+                    type: 'PrimitiveValue',
+                    value: 'bar',
+                },
+            },
+        });
+        expect(res.properties[0].value
+            .properties[0].key.type).toBe('Identifier');
+        expect(res.properties[0].value
+            .properties[1].key.type).toBe('StringLiteral');
+        expect(res.properties[0].value
+            .properties[2].key.type).toBe('Identifier');
+        expect(res.properties[0].value
+            .properties[3].key.type).toBe('StringLiteral');
+    });
 });
 //# sourceMappingURL=compositionAstGeneration.spec.js.map

package/build/__tests__/functionAstGeneration.spec.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -11,6 +34,7 @@ const types_1 = require("@babel/types");
 const functionAstGeneration_1 = require("../functionAstGeneration");
 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");
 describe('hoistLocalFunction', () => {
     const baseFilesPath = (0, path_1.join)(__dirname, 'general-komaci-docs/assorted-template-strings');
@@ -535,4 +559,16 @@ export default registerAdgFunction(adg0);`;
         expect((0, generator_1.default)((0, types_1.file)(res)).code).toBe(expected);
     });
 });
+describe('composeStaticMetadataAssignmentExpression', () => {
+    it('returns proper expression statement', () => {
+        const metaVarDeclarator = t.variableDeclarator(t.identifier(`Adg0Meta`), t.objectExpression([]));
+        const staticMetadataObject = t.variableDeclaration('const', [metaVarDeclarator]);
+        const expr = (0, functionAstGeneration_1.composeStaticMetadataAssignmentExpression)('adg0', staticMetadataObject).expression;
+        const left = expr.left;
+        expect(left.object.name).toBe('adg0');
+        expect(left.property.name).toBe('meta');
+        const right = expr.right;
+        expect(right.name).toBe('Adg0Meta');
+    });
+});
 //# sourceMappingURL=functionAstGeneration.spec.js.map

package/build/__tests__/genericAstGeneration.spec.js

@@ -494,6 +494,7 @@ describe('addImportStatements', () => {
     (0, common_shared_1.composeImportMetadata)('adg', '@salesforce/komaci/c__foo__foo.js', true, '4/names/0', moduleMetadata);
     moduleMetadata.importsByNamespace.set('lightning/uiTestingApi', {
         names: new Set(['default', 'regularImport']),
+        originalNames: new Set(['default', 'regularImport']),
         isDefaultSpecifier: true,
         isSupported: true,
         isNamespaceSpecifier: false,
@@ -501,6 +502,7 @@ describe('addImportStatements', () => {
     });
     moduleMetadata.importsByNamespace.set('badImport', {
         names: new Set(['tes1', 'tes2']),
+        originalNames: new Set(['tes1', 'tes2']),
         isDefaultSpecifier: false,
         isSupported: false,
         isNamespaceSpecifier: false,
@@ -508,6 +510,7 @@ describe('addImportStatements', () => {
     });
     moduleMetadata.importsByNamespace.set('@salesforce/labels', {
         names: new Set(['*']),
+        originalNames: new Set(['*']),
         isDefaultSpecifier: false,
         isSupported: true,
         isNamespaceSpecifier: true,
@@ -515,6 +518,7 @@ describe('addImportStatements', () => {
     });
     moduleMetadata.importsByNamespace.set('lightning/uiRecordApi', {
         names: new Set(['tes3', 'tes4', 'tes5']),
+        originalNames: new Set(['tes3', 'tes4', 'tes5']),
         isDefaultSpecifier: false,
         isSupported: true,
         isNamespaceSpecifier: false,
@@ -522,6 +526,7 @@ describe('addImportStatements', () => {
     });
     moduleMetadata.importsByNamespace.set('@salesforce/komaci/c__foo__foo.js', {
         names: new Set(['adg']),
+        originalNames: new Set(['adg']),
         isDefaultSpecifier: false,
         isSupported: true,
         isNamespaceSpecifier: false,

package/build/compositionAstGeneration.js

@@ -28,6 +28,7 @@ const common_shared_1 = require("@komaci/common-shared");
 const t = __importStar(require("@babel/types"));
 const genericAstGeneration_1 = require("./genericAstGeneration");
 const types_1 = require("./types");
+const hasSpecialCharacters = /^([0-9]+|(.*[^A-Za-z0-9]+.*))$/;
 /**
  * Convert an array of Komaci Compositions into a babel array of expressions.
  * This is used for both the top-level compositions in the Komaci Doc, as well
@@ -285,10 +286,14 @@ function getCompositionConfig(composition, componentId, iterationContext) {
             for (const propName of sortedCompositions) {
                 const prop = composition.properties[propName];
                 if (prop.type === 'Binding') {
-                    props.push(t.objectProperty(t.identifier(propName), (0, genericAstGeneration_1.bindingToExpression)(prop, iterationContext)));
+                    props.push(t.objectProperty(hasSpecialCharacters.test(propName)
+                        ? t.stringLiteral(propName)
+                        : t.identifier(propName), (0, genericAstGeneration_1.bindingToExpression)(prop, iterationContext)));
                 }
                 else if (prop.type === 'PrimitiveValue') {
-                    props.push(t.objectProperty(t.identifier(propName), (0, genericAstGeneration_1.primitiveToExpression)(prop)));
+                    props.push(t.objectProperty(hasSpecialCharacters.test(propName)
+                        ? t.stringLiteral(propName)
+                        : t.identifier(propName), (0, genericAstGeneration_1.primitiveToExpression)(prop)));
                 }
             }
             config.push(t.objectProperty(types_1.ID.PROPS, t.objectExpression(props)));

package/build/functionAstGeneration.d.ts

@@ -85,4 +85,11 @@ export declare function getInlineFunctionFromTemplateCompositions(moduleMetadata
  * @returns A default export representing the error state for this resolvable module
  */
 export declare function produceErrorAdgFunction(moduleMetadata: ModuleMetadata, error: Error): t.Program;
+/**
+ * Helper function to return the static metadata assignemnt expression statement.
+ * @param adgName the name of the adg function to associate the adgMeta object with.
+ * @param staticMetadataObject the staticMetadatObject to get the assicated adgMeta object name.
+ * @returns an expression statement, eg: adg0.meta = adg0meta
+ */
+export declare function composeStaticMetadataAssignmentExpression(adgName: string, staticMetadataObject: t.VariableDeclaration): t.ExpressionStatement;
 //# sourceMappingURL=functionAstGeneration.d.ts.map

package/build/functionAstGeneration.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.produceErrorAdgFunction = exports.getInlineFunctionFromTemplateCompositions = exports.getAdgFunctionBody = exports.addExportStatement = exports.composeAdgStaticMetadata = exports.composeAdgFunction = exports.getFactoryFuncDeclaration = exports.adgToExpression = exports.sanitizeFunction = exports.hoistLocalFunction = void 0;
+exports.composeStaticMetadataAssignmentExpression = exports.produceErrorAdgFunction = exports.getInlineFunctionFromTemplateCompositions = exports.getAdgFunctionBody = exports.addExportStatement = exports.composeAdgStaticMetadata = exports.composeAdgFunction = exports.getFactoryFuncDeclaration = exports.adgToExpression = exports.sanitizeFunction = exports.hoistLocalFunction = void 0;
 const t = __importStar(require("@babel/types"));
 const common_shared_1 = require("@komaci/common-shared");
 const compositionAstGeneration_1 = require("./compositionAstGeneration");
@@ -242,13 +242,35 @@ exports.composeAdgFunction = composeAdgFunction;
  * @returns a babel representation of a static metadata object.
  */
 function composeAdgStaticMetadata(adg, moduleMetadata) {
-    const compId = adg.exportName == 'default'
-        ? moduleMetadata.defaultComponentId
-        : `${moduleMetadata.defaultComponentId}__${adg.exportName}`;
+    const Id = adg.exportName == 'default' ||
+        moduleMetadata.moduleType == common_shared_1.ModuleTypes.TEMPLATE_ONLY
+        ? moduleMetadata.staticMetadataId
+        : adg.exportName
+            ? `${moduleMetadata.staticMetadataId}__${adg.exportName}`
+            : `${moduleMetadata.staticMetadataId}__$nonExportedClass$`;
     const metaDataProps = [];
     //creating id: "comp-id";
-    const idProp = t.objectProperty(t.identifier('id'), t.stringLiteral(compId));
+    const idProp = t.objectProperty(t.identifier('id'), t.stringLiteral(Id));
     metaDataProps.push(idProp);
+    if (adg.parentReference != undefined) {
+        if (adg.parentReference.type == 'ImportReference') {
+            const importName = moduleMetadata.importIndexReference.get(adg.parentReference.value);
+            if (importName) {
+                const importId = moduleMetadata.importsByName.get(importName)?.generatorAlias;
+                if (importId) {
+                    const parentProp = t.objectProperty(t.identifier('p'), t.identifier(importId));
+                    metaDataProps.push(parentProp);
+                }
+            }
+        }
+        else if (adg.parentReference.type == 'AdgReference') {
+            const parentAdgName = moduleMetadata.adgs.get(adg.parentReference.value)?.defaultGeneratedName;
+            if (parentAdgName) {
+                const parentProp = t.objectProperty(t.identifier('p'), t.identifier(parentAdgName));
+                metaDataProps.push(parentProp);
+            }
+        }
+    }
     const tPropBody = [];
     let hasImg = false;
     if (adg.compositions && adg.compositionRootIndex != undefined) {
@@ -267,7 +289,7 @@ function composeAdgStaticMetadata(adg, moduleMetadata) {
     //creating pf: false as the default.
     const pfProp = t.objectProperty(t.identifier('pf'), t.booleanLiteral(hasPrimableFunction));
     //creating img: prop based on if we found an img in the children traversal
-    const imgProp = t.objectProperty(t.identifier('pf'), t.booleanLiteral(hasImg));
+    const imgProp = t.objectProperty(t.identifier('img'), t.booleanLiteral(hasImg));
     metaDataProps.push(pfProp);
     metaDataProps.push(imgProp);
     //eg: adg0Meta: {...metadataProps}
@@ -480,4 +502,15 @@ function produceErrorAdgFunction(moduleMetadata, error) {
     ]);
 }
 exports.produceErrorAdgFunction = produceErrorAdgFunction;
+/**
+ * Helper function to return the static metadata assignemnt expression statement.
+ * @param adgName the name of the adg function to associate the adgMeta object with.
+ * @param staticMetadataObject the staticMetadatObject to get the assicated adgMeta object name.
+ * @returns an expression statement, eg: adg0.meta = adg0meta
+ */
+function composeStaticMetadataAssignmentExpression(adgName, staticMetadataObject) {
+    return t.expressionStatement(t.assignmentExpression('=', t.memberExpression(t.identifier(adgName), t.identifier('meta')), t.identifier(staticMetadataObject.declarations[0]
+        .id.name)));
+}
+exports.composeStaticMetadataAssignmentExpression = composeStaticMetadataAssignmentExpression;
 //# sourceMappingURL=functionAstGeneration.js.map

package/build/genericAstGeneration.js

@@ -61,12 +61,16 @@ function generateResolvableModule(input, scriptKomaciDoc, templateKomaciDocMap,
         : undefined;
     const hasScriptKomaciDoc = scriptKomaciDoc && Object.keys(scriptKomaciDoc).length !== 0;
     const hasTemplateKomaciDoc = defaultTemplateKomaciDoc && Object.keys(defaultTemplateKomaciDoc).length !== 0;
-    if (hasTemplateKomaciDoc) {
-        //generates the component name eg. komaciAction.js/html -> c-komaci-action
-        moduleMetadata.defaultComponentId = (0, common_shared_1.getComponentId)(input.moduleInfo.namespace, input.moduleInfo.name);
-    }
+    //generates the component name eg. komaciAction.js/html -> c-komaci-action
+    moduleMetadata.staticMetadataId = (0, common_shared_1.getComponentId)(input.moduleInfo.namespace, input.moduleInfo.name);
     const combinedModule = scriptKomaciDoc !== undefined && defaultTemplateKomaciDoc !== undefined;
     const isBundle = input.moduleInfo.type === 'bundle';
+    moduleMetadata.moduleType =
+        hasTemplateKomaciDoc && hasScriptKomaciDoc
+            ? common_shared_1.ModuleTypes.BUNDLE_MODULE
+            : hasScriptKomaciDoc
+                ? common_shared_1.ModuleTypes.SCRIPT_ONLY
+                : common_shared_1.ModuleTypes.TEMPLATE_ONLY;
     let renderFunctionMetadata = undefined;
     // start of metadata collection
     if (scriptKomaciDoc) {
@@ -179,7 +183,15 @@ function generateResolvableModule(input, scriptKomaciDoc, templateKomaciDocMap,
             statements.push(addUndefinedDefaultExport());
         }
         for (const adg of moduleMetadata.adgs.values()) {
-            statements.push((0, functionAstGeneration_1.composeAdgFunction)(adg, moduleMetadata));
+            //eg: const adgoMeta = {...}
+            const staticMetadataObject = (0, functionAstGeneration_1.composeAdgStaticMetadata)(adg, moduleMetadata);
+            //eg: function adg0(fct, ctx) {...}
+            const adgFunctionDefinition = (0, functionAstGeneration_1.composeAdgFunction)(adg, moduleMetadata);
+            //eg: adg0.meta = adg0Meta;
+            const staticMetadataAssignmentExpression = (0, functionAstGeneration_1.composeStaticMetadataAssignmentExpression)(adg.defaultGeneratedName, staticMetadataObject);
+            statements.push(staticMetadataObject);
+            statements.push(adgFunctionDefinition);
+            statements.push(staticMetadataAssignmentExpression);
         }
         for (const [exportName, adg] of Object.entries(moduleMetadata.exports)) {
             statements.push((0, functionAstGeneration_1.addExportStatement)(adg.defaultGeneratedName, exportName));
@@ -203,6 +215,7 @@ exports.generateResolvableModule = generateResolvableModule;
  */
 function addImportStatements(moduleMetadata, statements, options) {
     if (moduleMetadata.importsByName.size > 0) {
+        const seenImports = new Set();
         const imports = Array.from(moduleMetadata.importsByName.values())
             .sort((a, b) => {
             if (a.resourceName < b.resourceName) {
@@ -215,7 +228,16 @@ function addImportStatements(moduleMetadata, statements, options) {
                 return 0;
             }
         })
-            .filter((value) => value.isFromInternalNamespace && value.usedInPriming);
+            .filter((value) => {
+            // sometimes we can have multiple import names mapped to the same import. so we want to dedup those before running them through composition
+            const isComposable = !seenImports.has(value.generatorAlias) &&
+                value.isFromInternalNamespace &&
+                value.usedInPriming;
+            if (isComposable) {
+                seenImports.add(value.generatorAlias);
+            }
+            return isComposable;
+        });
         let i = 0;
         while (i < imports.length) {
             const specifiers = [];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@komaci/esm-generator",
-    "version": "244.1.0",
+    "version": "244.1.3",
     "description": "Komaci generator for ADG ES modules",
     "homepage": "https://komaci.dev/",
     "repository": {
@@ -29,11 +29,11 @@
         "@babel/core": "^7.9.0",
         "@babel/generator": "^7.9.0",
         "@babel/types": "^7.9.0",
-        "@komaci/common-shared": "244.1.0",
-        "@komaci/static-analyzer": "244.1.0"
+        "@komaci/common-shared": "244.1.3",
+        "@komaci/static-analyzer": "244.1.3"
     },
     "devDependencies": {
-        "@komaci/types": "244.1.0",
+        "@komaci/types": "244.1.3",
         "@lwc-platform/sfdc-lwc-compiler": "242.15.1-2.28.0",
         "@lwc/metadata": "^2.28.0-0"
     }