@komaci/esm-generator 242.0.0 → 242.1.0

package/build/__tests__/adgAstGeneration.spec.d.ts

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

package/build/__tests__/adgAstGeneration.spec.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const common_shared_1 = require("@komaci/common-shared");
+const functionAstGeneration_1 = require("../functionAstGeneration");
+describe('getAdgFunctionBody', () => {
+    const moduleMetadata = (0, common_shared_1.initModuleMetadataObject)();
+    it('includes a statement for factory functions if needed', () => {
+        const adg = (0, common_shared_1.initAdgMetadataObject)('adg0');
+        adg.requiredAdgFactoryFunctions.add(common_shared_1.IdKeys.ADG_FUNC);
+        const res = (0, functionAstGeneration_1.getAdgFunctionBody)(adg, moduleMetadata);
+        expect(res.body).toHaveLength(2);
+        expect(res.body[0].type).toBe('VariableDeclaration');
+        expect(res.body[1].type).toBe('ReturnStatement');
+    });
+    it('only contains a return statement if no factory functions are needed', () => {
+        const adg = (0, common_shared_1.initAdgMetadataObject)('adg0');
+        const res = (0, functionAstGeneration_1.getAdgFunctionBody)(adg, moduleMetadata);
+        expect(res.body).toHaveLength(1);
+        expect(res.body[0].type).toBe('ReturnStatement');
+    });
+});
+describe('composeAdgFunction', () => {
+    const moduleMetadata = (0, common_shared_1.initModuleMetadataObject)();
+    it('can return a function declaration for a non exported function', () => {
+        const adg = (0, common_shared_1.initAdgMetadataObject)('adg0');
+        const res = (0, functionAstGeneration_1.composeAdgFunction)(adg, moduleMetadata);
+        expect(res.type).toBe('FunctionDeclaration');
+        expect(res.id.name).toBe('adg0');
+    });
+});
+//# sourceMappingURL=adgAstGeneration.spec.js.map

package/build/__tests__/compositionAstGeneration.spec.d.ts

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

package/build/__tests__/compositionAstGeneration.spec.js

@@ -0,0 +1,394 @@
+"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 };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const compositionAstGeneration_1 = require("../compositionAstGeneration");
+const types_1 = require("@babel/types");
+const types_2 = require("../types");
+const fs = __importStar(require("fs"));
+const path_1 = require("path");
+const common_shared_1 = require("@komaci/common-shared");
+const generator_1 = __importDefault(require("@babel/generator"));
+const complexDoc = JSON.parse(fs.readFileSync((0, path_1.join)(__dirname, './general-komaci-docs/complexTemplateDoc/template.json'), 'utf-8'));
+describe('imageToExpression', () => {
+    it('should return an expression for a KomaciDocument Image node', () => {
+        const komaciDocImagePrimitive = {
+            type: 'Image',
+            src: {
+                type: 'PrimitiveValue',
+                value: 'testPrimitive.jpg', // this is string literal of a relative URL
+            },
+        };
+        let expression = (0, compositionAstGeneration_1.imageToExpression)(komaciDocImagePrimitive);
+        expect(expression.type).toBe('CallExpression');
+        let callExpression = expression;
+        expect(callExpression).not.toBeUndefined();
+        expect(callExpression.callee).toBe(types_2.ID.IMG_FUNC);
+        expect(callExpression.arguments).not.toBeUndefined();
+        expect(callExpression.arguments).toHaveLength(1);
+        expect(callExpression.arguments[0]).not.toBeUndefined();
+        expect(callExpression.arguments[0].type).toBe('ObjectExpression');
+        let objExpression = callExpression
+            .arguments[0];
+        expect(objExpression.properties).not.toBeUndefined();
+        expect(objExpression.properties).toHaveLength(1);
+        expect(objExpression.properties[0].type).toBe('ObjectProperty');
+        let objProperty = objExpression.properties[0];
+        expect(objProperty.key).toBe(types_2.ID.IMG_SRC);
+        expect(objProperty.value).toEqual((0, types_1.stringLiteral)('testPrimitive.jpg')); // img({src: "testPrimitive.jpg"})
+        const komaciDocImageBinding = {
+            type: 'Image',
+            src: {
+                type: 'Binding',
+                value: 'testBinding', // this is a string literal, but represents a variable name
+            },
+        };
+        expression = (0, compositionAstGeneration_1.imageToExpression)(komaciDocImageBinding);
+        expect(expression.type).toBe('CallExpression');
+        callExpression = expression;
+        expect(callExpression).not.toBeUndefined();
+        expect(callExpression.callee).toBe(types_2.ID.IMG_FUNC);
+        expect(callExpression.arguments).not.toBeUndefined();
+        expect(callExpression.arguments).toHaveLength(1);
+        expect(callExpression.arguments[0]).not.toBeUndefined();
+        expect(callExpression.arguments[0].type).toBe('ObjectExpression');
+        objExpression = callExpression.arguments[0];
+        expect(objExpression).not.toBeUndefined();
+        expect(objExpression.properties).not.toBeUndefined();
+        expect(objExpression.properties).toHaveLength(1);
+        expect(objExpression.properties[0].type).toBe('ObjectProperty');
+        objProperty = objExpression.properties[0];
+        expect(objProperty.key).toBe(types_2.ID.IMG_SRC);
+        let segments = ['ctx', 'props', 'testBinding'];
+        let expr = (0, types_1.identifier)(segments[0]);
+        for (let i = 1; i < segments.length; i++) {
+            expr = (0, types_1.optionalMemberExpression)(expr, (0, types_1.identifier)(segments[i]), false, false);
+        }
+        expect(objProperty.value).toEqual(expr); // img({src: ctx.props.testBinding})
+        const komaciDocImageNestedBinding = {
+            type: 'Image',
+            src: {
+                type: 'Binding',
+                value: 'imageObject/nested/imageName', // this is a string literal, represents nested-scoped variable names
+            },
+        };
+        expression = (0, compositionAstGeneration_1.imageToExpression)(komaciDocImageNestedBinding);
+        expect(expression.type).toBe('CallExpression');
+        callExpression = expression;
+        expect(callExpression).not.toBeUndefined();
+        expect(callExpression.callee).toBe(types_2.ID.IMG_FUNC);
+        expect(callExpression.arguments).not.toBeUndefined();
+        expect(callExpression.arguments).toHaveLength(1);
+        expect(callExpression.arguments[0]).not.toBeUndefined();
+        expect(callExpression.arguments[0].type).toBe('ObjectExpression');
+        objExpression = callExpression.arguments[0];
+        expect(objExpression).not.toBeUndefined();
+        expect(objExpression.properties).not.toBeUndefined();
+        expect(objExpression.properties).toHaveLength(1);
+        expect(objExpression.properties[0].type).toBe('ObjectProperty');
+        objProperty = objExpression.properties[0];
+        expect(objProperty.key).toBe(types_2.ID.IMG_SRC);
+        segments = ['ctx', 'props', 'imageObject', 'nested', 'imageName'];
+        expr = (0, types_1.identifier)(segments[0]);
+        const chainingStartIdx = 2;
+        for (let i = 1; i < segments.length; i++) {
+            expr = (0, types_1.optionalMemberExpression)(expr, (0, types_1.identifier)(segments[i]), false, i > chainingStartIdx);
+        }
+        expect(objProperty.value).toEqual(expr); // img({src: ctx.props.imageObject?.nested?.imageName})
+    });
+    it('should not return an expression for invalid KomaciDocument Image nodes due to invalid src.value type (boolean)', () => {
+        const komaciDocImagePrimitive = {
+            type: 'Image',
+            src: {
+                type: 'PrimitiveValue',
+                value: false, // not a supported type (boolean)
+            },
+        };
+        const expression = (0, compositionAstGeneration_1.imageToExpression)(komaciDocImagePrimitive);
+        expect(expression.type).toBe('CallExpression');
+        const callExpression = expression;
+        expect(callExpression).not.toBeUndefined();
+        expect(callExpression.callee).not.toBeUndefined();
+        expect(callExpression.callee).toBe(types_2.ID.IMG_FUNC);
+        expect(callExpression.arguments).not.toBeUndefined();
+        expect(callExpression.arguments).toHaveLength(1);
+        expect(callExpression.arguments[0].type).toBe('ObjectExpression');
+        const objExpression = callExpression
+            .arguments[0];
+        expect(objExpression.properties).not.toBeUndefined();
+        expect(objExpression.properties).toHaveLength(0); // no img() populated with a valid src attribute
+    });
+    it('should not return an expression for invalid KomaciDocument Image nodes due to blank src.value', () => {
+        const komaciDocImagePrimitiveBlank = {
+            type: 'Image',
+            src: {
+                type: 'PrimitiveValue',
+                value: '', // blanks not supported
+            },
+        };
+        let expression = (0, compositionAstGeneration_1.imageToExpression)(komaciDocImagePrimitiveBlank);
+        expression = (0, compositionAstGeneration_1.imageToExpression)(komaciDocImagePrimitiveBlank);
+        expect(expression.type).toBe('CallExpression');
+        const callExpression = expression;
+        expect(callExpression).not.toBeUndefined();
+        expect(callExpression.callee).not.toBeUndefined();
+        expect(callExpression.callee).toBe(types_2.ID.IMG_FUNC);
+        expect(callExpression.arguments).not.toBeUndefined();
+        expect(callExpression.arguments).toHaveLength(1);
+        expect(callExpression.arguments[0].type).toBe('ObjectExpression');
+        const objExpression = callExpression
+            .arguments[0];
+        expect(objExpression.properties).not.toBeUndefined();
+        expect(objExpression.properties).toHaveLength(0); // no img() populated with a valid src attribute
+    });
+    it('should not return an expression for invalid KomaciDocument Image nodes with src.type that is neither Binding nor PrimitiveType', () => {
+        const komaciDocImageInvalidSrcValType = {
+            type: 'Image',
+            src: {
+                type: 'PrimitiveValue',
+                value: 'some random string',
+            },
+        };
+        // change the src.value type to something invalid, a number
+        komaciDocImageInvalidSrcValType.src.value = 12345;
+        let expression = (0, compositionAstGeneration_1.imageToExpression)(komaciDocImageInvalidSrcValType);
+        expression = (0, compositionAstGeneration_1.imageToExpression)(komaciDocImageInvalidSrcValType);
+        expect(expression.type).toBe('CallExpression');
+        const callExpression = expression;
+        expect(callExpression).not.toBeUndefined();
+        expect(callExpression.callee).not.toBeUndefined();
+        expect(callExpression.callee).toBe(types_2.ID.IMG_FUNC);
+        expect(callExpression.arguments).not.toBeUndefined();
+        expect(callExpression.arguments).toHaveLength(1);
+        expect(callExpression.arguments[0].type).toBe('ObjectExpression');
+        const objExpression = callExpression
+            .arguments[0];
+        expect(objExpression.properties).not.toBeUndefined();
+        expect(objExpression.properties).toHaveLength(0);
+    });
+});
+describe('compositionToArrayExpression', () => {
+    const moduleMetadata = (0, common_shared_1.initModuleMetadataObject)();
+    (0, common_shared_1.initializeImportMetdataFromKomaciDocument)(complexDoc, moduleMetadata, true);
+    it('could handle a single composition', () => {
+        const res = (0, compositionAstGeneration_1.compositionsToArrayExpression)(moduleMetadata, [
+            complexDoc.compositions[0].compositions[2].compositions[0],
+        ]);
+        expect(res?.elements).toHaveLength(1);
+    });
+    it('can handle multiple compositions being passed in', () => {
+        const res = (0, compositionAstGeneration_1.compositionsToArrayExpression)(moduleMetadata, complexDoc.compositions[0].compositions);
+        expect(res?.elements).toHaveLength(3);
+    });
+    it('returns an empty array when given an empty array element of compositions', () => {
+        const res = (0, compositionAstGeneration_1.compositionsToArrayExpression)(moduleMetadata, []);
+        expect(res?.elements).toHaveLength(0);
+    });
+    it('returns undefined if we are given no compositions', () => {
+        const res = (0, compositionAstGeneration_1.compositionsToArrayExpression)(moduleMetadata, undefined);
+        expect(res).toBeUndefined();
+    });
+});
+describe('compositionToExpression', () => {
+    const moduleMetadata = (0, common_shared_1.initModuleMetadataObject)();
+    (0, common_shared_1.initializeImportMetdataFromKomaciDocument)(complexDoc, moduleMetadata, true);
+    it('effectiely builds a conditional expression for a component with isActive', () => {
+        const res = (0, compositionAstGeneration_1.compositionToExpression)(moduleMetadata, complexDoc.compositions[0].compositions[2].compositions[1]);
+        expect(res.type).toBe('ConditionalExpression');
+        const code = (0, generator_1.default)(res).code;
+        expect(code).toBe('u(ctx.props.apexResult) || ctx.props.apexResult ? [i(ctx.props.apexResult?.data?.names, ctx, user_var_test => {\n  return [e({}, ctx, []), cg(i4, {\n    componentId: "c-name-detail",\n    props: {\n      name: user_var_test.value?.name\n    }\n  }, ctx)];\n}), u(ctx.props.apexResult) || ctx.props.apexResult?.data ? i(ctx.props.apexResult?.data, ctx, user_var_contactName => {\n  return [e({}, ctx, [])];\n}) : undefined, u(ctx.props.apexResult) || ctx.props.apexResult?.error ? [] : undefined] : undefined');
+    });
+    it('effectiely builds a conditional expression for a component with negated isActive', () => {
+        const res = (0, compositionAstGeneration_1.compositionToExpression)(moduleMetadata, complexDoc.compositions[0].compositions[2].compositions[2]);
+        expect(res.type).toBe('ConditionalExpression');
+        const code = (0, generator_1.default)(res).code;
+        expect(code).toBe('u(ctx.props.apexResult) || !ctx.props.apexResult ? [] : undefined');
+    });
+    it('returns a basic reference when isActive is not set', () => {
+        const res = (0, compositionAstGeneration_1.compositionToExpression)(moduleMetadata, complexDoc.compositions[0].compositions[2].compositions[0]);
+        expect(res.type).toBe('CallExpression');
+        const code = (0, generator_1.default)(res).code;
+        expect(code).toBe('cg(i1, {\n  slot: "title",\n  componentId: "c-title",\n  props: {\n    size: "medium",\n    icon: "standard:apex"\n  }\n}, ctx)');
+    });
+});
+describe('containerToExpression', () => {
+    const moduleMetadata = (0, common_shared_1.initModuleMetadataObject)();
+    (0, common_shared_1.initializeImportMetdataFromKomaciDocument)(complexDoc, moduleMetadata, true);
+    it('uses the element function when container has a key', () => {
+        const container = Object.assign({}, complexDoc.compositions[0].compositions[2].compositions[0]);
+        container.key = { type: 'Binding', value: 'test' };
+        const res = (0, compositionAstGeneration_1.containerToExpression)(moduleMetadata, container);
+        expect(res.type).toBe('CallExpression');
+        expect(res.callee.name).toBe('e');
+    });
+    it('uses the element function when container has a slot ref', () => {
+        const container = Object.assign({}, complexDoc.compositions[0].compositions[2].compositions[0]);
+        container.slot = 'test';
+        const res = (0, compositionAstGeneration_1.containerToExpression)(moduleMetadata, container);
+        expect(res.type).toBe('CallExpression');
+        expect(res.callee.name).toBe('e');
+    });
+    it('returns first element when theres one child', () => {
+        const res = (0, compositionAstGeneration_1.containerToExpression)(moduleMetadata, complexDoc.compositions[0].compositions[1].compositions[1]);
+        expect(res.type).toBe('CallExpression');
+        expect(res.callee.name).not.toBe('e');
+    });
+    it('returns an array element when there are multiple children', () => {
+        const res = (0, compositionAstGeneration_1.containerToExpression)(moduleMetadata, complexDoc.compositions[0].compositions[2].compositions[1]);
+        expect(res.type).toBe('ArrayExpression');
+    });
+});
+describe('composedAdgToExpression', () => {
+    const moduleMetadata = (0, common_shared_1.initModuleMetadataObject)();
+    (0, common_shared_1.initializeImportMetdataFromKomaciDocument)(complexDoc, moduleMetadata, true);
+    it('properly composed composedAdg with no children', () => {
+        const res = (0, compositionAstGeneration_1.composedAdgToExpression)(moduleMetadata, complexDoc.compositions[0].compositions[1].compositions[1]
+            .compositions[0]);
+        expect(res.type).toBe('CallExpression');
+        expect(res.callee.name).toBe('cg');
+        const code = (0, generator_1.default)(res).code;
+        expect(code).toBe('cg(i3, {\n  componentId: "c-lookup-field-row",\n  props: {\n    recordId: ctx.props.record?.data?.fields?.CreatedById?.value,\n    label: "CreatedBy User Info",\n    objectApiName: "User"\n  }\n}, ctx)');
+    });
+    it('properly composed composedAdg with children', () => {
+        const res = (0, compositionAstGeneration_1.composedAdgToExpression)(moduleMetadata, complexDoc.compositions[0].compositions[0]);
+        expect(res.type).toBe('CallExpression');
+        expect(res.callee.name).toBe('cg');
+        const code = (0, generator_1.default)(res).code;
+        expect(code).toBe('cg(i0, {\n  componentId: "lightning-card",\n  props: {}\n}, ctx, [cg(i1, {\n  slot: "title",\n  componentId: "c-title",\n  props: {\n    size: "large",\n    icon: "standard:account"\n  }\n}, ctx), u(ctx.props.record) || ctx.props.record?.data ? [cg(i2, {\n  componentId: "c-fieldrow",\n  props: {\n    label: "Object Type",\n    value: ctx.props.objectApiName\n  }\n}, ctx), cg(i2, {\n  componentId: "c-fieldrow",\n  props: {\n    label: "Account Id",\n    value: ctx.props.record?.data?.fields?.Id?.value\n  }\n}, ctx), cg(i2, {\n  componentId: "c-fieldrow",\n  props: {\n    label: "Account Name",\n    value: ctx.props.record?.data?.fields?.Name?.value\n  }\n}, ctx), u(ctx.props.ownerRecord) || ctx.props.ownerRecord?.data ? cg(i2, {\n  componentId: "c-fieldrow",\n  props: {\n    label: "Account Owner",\n    value: ctx.props.ownerRecord?.data?.fields?.Name?.value\n  }\n}, ctx) : undefined, u(ctx.props.createdByRecord) || ctx.props.createdByRecord?.data ? cg(i2, {\n  componentId: "c-fieldrow",\n  props: {\n    label: "Created By",\n    value: ctx.props.createdByRecord?.data?.fields?.Name?.value\n  }\n}, ctx) : undefined] : undefined])');
+    });
+});
+describe('iterationToExpression', () => {
+    const moduleMetadata = (0, common_shared_1.initModuleMetadataObject)();
+    (0, common_shared_1.initializeImportMetdataFromKomaciDocument)(complexDoc, moduleMetadata, true);
+    it('can compose an iteration factory call from a iterator composition', () => {
+        const res = (0, compositionAstGeneration_1.iterationToExpression)(moduleMetadata, {
+            type: 'Iteration',
+            input: {
+                type: 'Binding',
+                value: 'contacts',
+            },
+            iterator: 'contact',
+            compositions: [
+                {
+                    type: 'ComposedAdg',
+                    input: {
+                        type: 'ImportReference',
+                        value: '0/names/0',
+                    },
+                    properties: {
+                        label: {
+                            type: 'Binding',
+                            value: 'contact/value/Name',
+                        },
+                        myIndex: {
+                            type: 'Binding',
+                            value: 'contact/index',
+                        },
+                    },
+                    key: {
+                        type: 'Binding',
+                        value: 'contact/value/Id',
+                    },
+                },
+            ],
+        });
+        expect(res.type).toBe('CallExpression');
+        expect(res.callee.name).toBe('i');
+        const code = (0, generator_1.default)(res).code;
+        expect(code).toBe('i(ctx.props.contacts, ctx, user_var_contact => {\n  return [cg(i0, {\n    componentId: "lightning-card",\n    props: {\n      label: user_var_contact.value?.Name,\n      myIndex: user_var_contact.index\n    }\n  }, ctx)];\n})');
+    });
+});
+describe('slotToExpression', () => {
+    const moduleMetadata = (0, common_shared_1.initModuleMetadataObject)();
+    (0, common_shared_1.initializeImportMetdataFromKomaciDocument)(complexDoc, moduleMetadata);
+    it('can compose a slot factory call from a iterator composition', () => {
+        const res = (0, compositionAstGeneration_1.slotToExpression)(moduleMetadata, {
+            type: 'Slot',
+            name: 'full-name',
+            compositions: [
+                {
+                    type: 'Slot',
+                    name: 'first-name',
+                },
+                {
+                    type: 'Slot',
+                    name: 'last-name',
+                },
+            ],
+        });
+        expect(res.type).toBe('CallExpression');
+        expect(res.callee.name).toBe('s');
+        const code = (0, generator_1.default)(res).code;
+        expect(code).toBe('s("full-name", {}, ctx, [s("first-name", {}, ctx), s("last-name", {}, ctx)])');
+    });
+});
+describe('getCompositionConfig', () => {
+    it('collects composition config for a container', () => {
+        const res = (0, compositionAstGeneration_1.getCompositionConfig)({
+            type: 'Container',
+            isActive: {
+                input: {
+                    type: 'Binding',
+                    value: 'fukuoka',
+                },
+                negate: false,
+            },
+            compositions: [
+                {
+                    type: 'Slot',
+                    name: '',
+                },
+            ],
+        });
+        const code = (0, generator_1.default)(res).code;
+        expect(code).toBe('{}');
+    });
+    it('collects composition config for a composedAdg', () => {
+        const res = (0, compositionAstGeneration_1.getCompositionConfig)(complexDoc.compositions[0].compositions[2].compositions[0]);
+        const code = (0, generator_1.default)(res).code;
+        expect(code).toBe('{\n  slot: "title",\n  props: {\n    size: "medium",\n    icon: "standard:apex"\n  }\n}');
+    });
+    it('collects composition config for a slot', () => {
+        const res = (0, compositionAstGeneration_1.getCompositionConfig)({
+            type: 'Slot',
+            name: 'full-name',
+            compositions: [
+                {
+                    type: 'Slot',
+                    name: 'first-name',
+                },
+                {
+                    type: 'Slot',
+                    name: 'last-name',
+                },
+            ],
+        });
+        const code = (0, generator_1.default)(res).code;
+        expect(code).toBe('{}');
+    });
+});
+//# sourceMappingURL=compositionAstGeneration.spec.js.map

package/build/__tests__/functionAstGeneration.spec.d.ts

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