@contrail/document-generation 1.0.31 → 1.0.32

package/README.md

@@ -1,2 +1,2 @@
-Library for use with @contrail/documents that allows for the quick/automation generation of 
+Library for use with @contrail/documents that allows for the quick/automation generation of 
 documents based on templates and layout options.

package/lib/components/component-generator.d.ts

@@ -1,11 +1,11 @@
-import { DocumentElement } from "@contrail/documents";
-import { ComponentPropertyTemplate, ComponentTemplate } from "../interfaces";
-export declare class ComponentGenerator {
-    static generateComponent(data: any, options: DocumentElement, template: ComponentTemplate): any;
-    static generatedModelBindings(data: any): {
-        item: string;
-        projectItem: string;
-        viewable: string;
-    };
-    static generateComponentFromPropertyTemplate(data: any, options: DocumentElement, template: ComponentPropertyTemplate): DocumentElement;
-}
+import { DocumentElement } from "@contrail/documents";
+import { ComponentPropertyTemplate, ComponentTemplate } from "../interfaces";
+export declare class ComponentGenerator {
+    static generateComponent(data: any, options: DocumentElement, template: ComponentTemplate): any;
+    static generatedModelBindings(data: any): {
+        item: string;
+        projectItem: string;
+        viewable: string;
+    };
+    static generateComponentFromPropertyTemplate(data: any, options: DocumentElement, template: ComponentPropertyTemplate): DocumentElement;
+}

package/lib/components/component-generator.js

@@ -1,67 +1,67 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ComponentGenerator = void 0;
-const documents_1 = require("@contrail/documents");
-const nanoid_1 = require("nanoid");
-const util_1 = require("@contrail/util");
-const document_property_util_1 = require("../util/document-property-util");
-class ComponentGenerator {
-    static generateComponent(data, options, template) {
-        let component;
-        if (template.propertyTemplate) {
-            component = this.generateComponentFromPropertyTemplate(data, options, template.propertyTemplate);
-        }
-        else {
-            throw Error("No component property template defined");
-        }
-        return component;
-    }
-    static generatedModelBindings(data) {
-        return {
-            item: `item:${data.item.id}`,
-            projectItem: `project-item:${data.projectItem.id}`,
-            viewable: `item:${data.item.id}`,
-        };
-    }
-    static generateComponentFromPropertyTemplate(data, options, template) {
-        var _a;
-        let componentElement = documents_1.DocumentElementFactory.initNewElement('component');
-        if (options) {
-            componentElement = Object.assign(componentElement, options);
-        }
-        let yPosition = 0;
-        const imageDimension = template.imageDimension || {};
-        const imageHeight = imageDimension.height || imageDimension.width || 125;
-        const imageWidth = imageDimension.width || 125;
-        const imageUrl = util_1.ObjectUtil.getByPath(data, `viewable.mediumViewableDownloadUrl`);
-        const elements = [{
-                type: "image",
-                size: { width: imageWidth, height: imageHeight },
-                propertyBindings: { url: 'viewable.mediumViewableDownloadUrl' },
-                url: imageUrl,
-            }];
-        yPosition += imageHeight;
-        const textOptions = {
-            style: {
-                text: {
-                    align: template.textHorizontalAlignment
-                }
-            },
-            size: {
-                width: imageWidth
-            }
-        };
-        elements.push(...document_property_util_1.DocumentPropertyUtil.generatePropertyTextElements(data, template.properties, textOptions, { y: yPosition }, true));
-        const modelBindings = this.generatedModelBindings(data);
-        componentElement.elements = elements;
-        componentElement.modelBindings = modelBindings;
-        if (((_a = componentElement === null || componentElement === void 0 ? void 0 : componentElement.elements) === null || _a === void 0 ? void 0 : _a.length) > 0) {
-            componentElement.elements = componentElement.elements.map((e) => {
-                e.id = (0, nanoid_1.nanoid)(16);
-                return e;
-            });
-        }
-        return componentElement;
-    }
-}
-exports.ComponentGenerator = ComponentGenerator;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComponentGenerator = void 0;
+const documents_1 = require("@contrail/documents");
+const nanoid_1 = require("nanoid");
+const util_1 = require("@contrail/util");
+const document_property_util_1 = require("../util/document-property-util");
+class ComponentGenerator {
+    static generateComponent(data, options, template) {
+        let component;
+        if (template.propertyTemplate) {
+            component = this.generateComponentFromPropertyTemplate(data, options, template.propertyTemplate);
+        }
+        else {
+            throw Error("No component property template defined");
+        }
+        return component;
+    }
+    static generatedModelBindings(data) {
+        return {
+            item: `item:${data.item.id}`,
+            projectItem: `project-item:${data.projectItem.id}`,
+            viewable: `item:${data.item.id}`,
+        };
+    }
+    static generateComponentFromPropertyTemplate(data, options, template) {
+        var _a;
+        let componentElement = documents_1.DocumentElementFactory.initNewElement('component');
+        if (options) {
+            componentElement = Object.assign(componentElement, options);
+        }
+        let yPosition = 0;
+        const imageDimension = template.imageDimension || {};
+        const imageHeight = imageDimension.height || imageDimension.width || 125;
+        const imageWidth = imageDimension.width || 125;
+        const imageUrl = util_1.ObjectUtil.getByPath(data, `viewable.mediumViewableDownloadUrl`);
+        const elements = [{
+                type: "image",
+                size: { width: imageWidth, height: imageHeight },
+                propertyBindings: { url: 'viewable.mediumViewableDownloadUrl' },
+                url: imageUrl,
+            }];
+        yPosition += imageHeight;
+        const textOptions = {
+            style: {
+                text: {
+                    align: template.textHorizontalAlignment
+                }
+            },
+            size: {
+                width: imageWidth
+            }
+        };
+        elements.push(...document_property_util_1.DocumentPropertyUtil.generatePropertyTextElements(data, template.properties, textOptions, { y: yPosition }, true));
+        const modelBindings = this.generatedModelBindings(data);
+        componentElement.elements = elements;
+        componentElement.modelBindings = modelBindings;
+        if (((_a = componentElement === null || componentElement === void 0 ? void 0 : componentElement.elements) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+            componentElement.elements = componentElement.elements.map((e) => {
+                e.id = (0, nanoid_1.nanoid)(16);
+                return e;
+            });
+        }
+        return componentElement;
+    }
+}
+exports.ComponentGenerator = ComponentGenerator;

package/lib/components/component-grid-generator.d.ts

@@ -1,7 +1,7 @@
-import { DocumentElement, PositionDefinition, SizeDefinition } from "@contrail/documents";
-import { ComponentGridTemplate } from "../interfaces";
-export declare class ComponentGridGenerator {
-    static generateComponentGrid(data: any, startingPosition: PositionDefinition, template: ComponentGridTemplate, idealSize: SizeDefinition): Array<DocumentElement>;
-    private static getComponentSize;
-    private static adjustComponentTemplate;
-}
+import { DocumentElement, PositionDefinition, SizeDefinition } from "@contrail/documents";
+import { ComponentGridTemplate } from "../interfaces";
+export declare class ComponentGridGenerator {
+    static generateComponentGrid(data: any, startingPosition: PositionDefinition, template: ComponentGridTemplate, idealSize: SizeDefinition): Array<DocumentElement>;
+    private static getComponentSize;
+    private static adjustComponentTemplate;
+}

package/lib/components/component-grid-generator.js

@@ -1,81 +1,81 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ComponentGridGenerator = void 0;
-const util_1 = require("@contrail/util");
-const component_generator_1 = require("./component-generator");
-const component_util_1 = require("./component-util");
-class ComponentGridGenerator {
-    static generateComponentGrid(data, startingPosition = { x: 0, y: 0 }, template, idealSize) {
-        if (!data) {
-            console.warn("WARN: data null in generateComponentGrid");
-            return [];
-        }
-        if (!template) {
-            console.warn("WARN: template null in generateComponentGrid");
-            return [];
-        }
-        if (!template.componentTemplate) {
-            console.warn("WARN: component template is null generateComponentGrid");
-            return [];
-        }
-        const elements = [];
-        let dataIndex = 0;
-        console.log("generateComponentGrid: idealSize: ", idealSize);
-        let gridTemplate = template;
-        const optimizeTemplate = true;
-        if (optimizeTemplate) {
-            gridTemplate = this.adjustComponentTemplate(data, idealSize, template);
-        }
-        const componentTemplate = gridTemplate.componentTemplate;
-        const componentPosition = util_1.ObjectUtil.cloneDeep(startingPosition);
-        const componentSize = this.getComponentSize(data, gridTemplate);
-        const componentPadding = gridTemplate.componentPadding || 20;
-        componentPosition.x += componentPadding;
-        componentPosition.y += componentPadding;
-        for (let row = 0; row < gridTemplate.gridDimensions.rows; row++) {
-            for (let col = 0; col < gridTemplate.gridDimensions.cols; col++) {
-                if (dataIndex >= data.length) {
-                    continue;
-                }
-                let dataObj = data[dataIndex];
-                dataObj.viewable = dataObj.item;
-                const position = util_1.ObjectUtil.cloneDeep(componentPosition);
-                let component = component_generator_1.ComponentGenerator.generateComponent(dataObj, { position }, componentTemplate);
-                elements.push(component);
-                dataIndex++;
-                componentPosition.x += componentSize.width + (componentPadding * 2);
-            }
-            componentPosition.y += componentSize.height + (componentPadding * 2);
-            componentPosition.x = startingPosition.x + componentPadding;
-        }
-        return elements;
-    }
-    static getComponentSize(data, template) {
-        if (!(data === null || data === void 0 ? void 0 : data.length)) {
-            return null;
-        }
-        const firstData = data[0];
-        const element = component_generator_1.ComponentGenerator.generateComponent(firstData, {}, template.componentTemplate);
-        return component_util_1.ComponentUtil.getComponentSize(element);
-    }
-    static adjustComponentTemplate(data, idealSize, template) {
-        const componentSize = this.getComponentSize(data, template);
-        const adjustedTemplate = util_1.ObjectUtil.cloneDeep(template);
-        const horizontalPadding = ((template.gridDimensions.cols * 2) * template.componentPadding || 20);
-        const verticalPadding = ((template.gridDimensions.rows * 2) * template.componentPadding || 20);
-        const requiredSize = {
-            width: componentSize.width * template.gridDimensions.cols + horizontalPadding,
-            height: componentSize.height * template.gridDimensions.rows + verticalPadding,
-        };
-        const requiredHeightAdjustment = (idealSize.height - requiredSize.height) / template.gridDimensions.rows;
-        const requiredWidthAdjustment = (idealSize.width - requiredSize.width) / template.gridDimensions.cols;
-        if (requiredHeightAdjustment < 0 && requiredHeightAdjustment < requiredWidthAdjustment) {
-            adjustedTemplate.componentTemplate.propertyTemplate.imageDimension.width += requiredHeightAdjustment;
-        }
-        if (requiredWidthAdjustment < 0 && requiredWidthAdjustment < requiredHeightAdjustment) {
-            adjustedTemplate.componentTemplate.propertyTemplate.imageDimension.width += requiredWidthAdjustment;
-        }
-        return adjustedTemplate;
-    }
-}
-exports.ComponentGridGenerator = ComponentGridGenerator;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComponentGridGenerator = void 0;
+const util_1 = require("@contrail/util");
+const component_generator_1 = require("./component-generator");
+const component_util_1 = require("./component-util");
+class ComponentGridGenerator {
+    static generateComponentGrid(data, startingPosition = { x: 0, y: 0 }, template, idealSize) {
+        if (!data) {
+            console.warn("WARN: data null in generateComponentGrid");
+            return [];
+        }
+        if (!template) {
+            console.warn("WARN: template null in generateComponentGrid");
+            return [];
+        }
+        if (!template.componentTemplate) {
+            console.warn("WARN: component template is null generateComponentGrid");
+            return [];
+        }
+        const elements = [];
+        let dataIndex = 0;
+        console.log("generateComponentGrid: idealSize: ", idealSize);
+        let gridTemplate = template;
+        const optimizeTemplate = true;
+        if (optimizeTemplate) {
+            gridTemplate = this.adjustComponentTemplate(data, idealSize, template);
+        }
+        const componentTemplate = gridTemplate.componentTemplate;
+        const componentPosition = util_1.ObjectUtil.cloneDeep(startingPosition);
+        const componentSize = this.getComponentSize(data, gridTemplate);
+        const componentPadding = gridTemplate.componentPadding || 20;
+        componentPosition.x += componentPadding;
+        componentPosition.y += componentPadding;
+        for (let row = 0; row < gridTemplate.gridDimensions.rows; row++) {
+            for (let col = 0; col < gridTemplate.gridDimensions.cols; col++) {
+                if (dataIndex >= data.length) {
+                    continue;
+                }
+                let dataObj = data[dataIndex];
+                dataObj.viewable = dataObj.item;
+                const position = util_1.ObjectUtil.cloneDeep(componentPosition);
+                let component = component_generator_1.ComponentGenerator.generateComponent(dataObj, { position }, componentTemplate);
+                elements.push(component);
+                dataIndex++;
+                componentPosition.x += componentSize.width + (componentPadding * 2);
+            }
+            componentPosition.y += componentSize.height + (componentPadding * 2);
+            componentPosition.x = startingPosition.x + componentPadding;
+        }
+        return elements;
+    }
+    static getComponentSize(data, template) {
+        if (!(data === null || data === void 0 ? void 0 : data.length)) {
+            return null;
+        }
+        const firstData = data[0];
+        const element = component_generator_1.ComponentGenerator.generateComponent(firstData, {}, template.componentTemplate);
+        return component_util_1.ComponentUtil.getComponentSize(element);
+    }
+    static adjustComponentTemplate(data, idealSize, template) {
+        const componentSize = this.getComponentSize(data, template);
+        const adjustedTemplate = util_1.ObjectUtil.cloneDeep(template);
+        const horizontalPadding = ((template.gridDimensions.cols * 2) * template.componentPadding || 20);
+        const verticalPadding = ((template.gridDimensions.rows * 2) * template.componentPadding || 20);
+        const requiredSize = {
+            width: componentSize.width * template.gridDimensions.cols + horizontalPadding,
+            height: componentSize.height * template.gridDimensions.rows + verticalPadding,
+        };
+        const requiredHeightAdjustment = (idealSize.height - requiredSize.height) / template.gridDimensions.rows;
+        const requiredWidthAdjustment = (idealSize.width - requiredSize.width) / template.gridDimensions.cols;
+        if (requiredHeightAdjustment < 0 && requiredHeightAdjustment < requiredWidthAdjustment) {
+            adjustedTemplate.componentTemplate.propertyTemplate.imageDimension.width += requiredHeightAdjustment;
+        }
+        if (requiredWidthAdjustment < 0 && requiredWidthAdjustment < requiredHeightAdjustment) {
+            adjustedTemplate.componentTemplate.propertyTemplate.imageDimension.width += requiredWidthAdjustment;
+        }
+        return adjustedTemplate;
+    }
+}
+exports.ComponentGridGenerator = ComponentGridGenerator;

package/lib/components/component-util.d.ts

@@ -1,4 +1,4 @@
-import { DocumentElement, SizeDefinition } from "@contrail/documents";
-export declare class ComponentUtil {
-    static getComponentSize(element: DocumentElement): SizeDefinition;
-}
+import { DocumentElement, SizeDefinition } from "@contrail/documents";
+export declare class ComponentUtil {
+    static getComponentSize(element: DocumentElement): SizeDefinition;
+}

package/lib/components/component-util.js

@@ -1,26 +1,26 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ComponentUtil = void 0;
-class ComponentUtil {
-    static getComponentSize(element) {
-        var _a, _b, _c, _d, _e;
-        const sizeDefinition = {
-            width: 0,
-            height: 0,
-        };
-        const imageElement = ((_a = element.elements) === null || _a === void 0 ? void 0 : _a.find(el => el.type === 'image')) || {};
-        sizeDefinition.width = (_b = imageElement.size) === null || _b === void 0 ? void 0 : _b.width;
-        const LINE_PADDING = 8;
-        const textElements = (_c = element.elements) === null || _c === void 0 ? void 0 : _c.filter(el => el.type === 'text');
-        let textHeight = 0;
-        textElements.forEach(el => {
-            var _a, _b;
-            let fontSize = ((_b = (_a = el.style) === null || _a === void 0 ? void 0 : _a.font) === null || _b === void 0 ? void 0 : _b.size) || 12;
-            textHeight += fontSize + LINE_PADDING;
-        });
-        const imageHeight = (((_d = imageElement.size) === null || _d === void 0 ? void 0 : _d.height) || ((_e = imageElement.size) === null || _e === void 0 ? void 0 : _e.width) || 150);
-        sizeDefinition.height = imageHeight + textHeight;
-        return sizeDefinition;
-    }
-}
-exports.ComponentUtil = ComponentUtil;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComponentUtil = void 0;
+class ComponentUtil {
+    static getComponentSize(element) {
+        var _a, _b, _c, _d, _e;
+        const sizeDefinition = {
+            width: 0,
+            height: 0,
+        };
+        const imageElement = ((_a = element.elements) === null || _a === void 0 ? void 0 : _a.find(el => el.type === 'image')) || {};
+        sizeDefinition.width = (_b = imageElement.size) === null || _b === void 0 ? void 0 : _b.width;
+        const LINE_PADDING = 8;
+        const textElements = (_c = element.elements) === null || _c === void 0 ? void 0 : _c.filter(el => el.type === 'text');
+        let textHeight = 0;
+        textElements.forEach(el => {
+            var _a, _b;
+            let fontSize = ((_b = (_a = el.style) === null || _a === void 0 ? void 0 : _a.font) === null || _b === void 0 ? void 0 : _b.size) || 12;
+            textHeight += fontSize + LINE_PADDING;
+        });
+        const imageHeight = (((_d = imageElement.size) === null || _d === void 0 ? void 0 : _d.height) || ((_e = imageElement.size) === null || _e === void 0 ? void 0 : _e.width) || 150);
+        sizeDefinition.height = imageHeight + textHeight;
+        return sizeDefinition;
+    }
+}
+exports.ComponentUtil = ComponentUtil;

package/lib/document-generator.d.ts

@@ -1,11 +1,11 @@
-import { DocumentElement, PositionDefinition } from "@contrail/documents";
-import { DocumentGenerationOptions, DocumentTemplate } from "./interfaces";
-import { DataGroup } from "@contrail/data-grouping";
-export declare class DocumentGenerator {
-    constructor();
-    static generateDocumentElements(options: DocumentGenerationOptions): Array<DocumentElement>;
-    static generateGroup(group: DataGroup, template: any, startingPosition: any, totalDepth: any, currentDepth: any): any[];
-    static getGroupSpan(group: DataGroup, totalDepth: any, currentDepth: any): number;
-    static generateFrameGroup(dataGroup: DataGroup, template: DocumentTemplate, position: PositionDefinition): Array<DocumentElement>;
-    static generateGroupHeading(dataGroup: DataGroup, template: DocumentTemplate, position: PositionDefinition, span: any): any[];
-}
+import { DocumentElement, PositionDefinition } from "@contrail/documents";
+import { DocumentGenerationOptions, DocumentTemplate } from "./interfaces";
+import { DataGroup } from "@contrail/data-grouping";
+export declare class DocumentGenerator {
+    constructor();
+    static generateDocumentElements(options: DocumentGenerationOptions): Array<DocumentElement>;
+    static generateGroup(group: DataGroup, template: any, startingPosition: any, totalDepth: any, currentDepth: any): any[];
+    static getGroupSpan(group: DataGroup, totalDepth: any, currentDepth: any): number;
+    static generateFrameGroup(dataGroup: DataGroup, template: DocumentTemplate, position: PositionDefinition): Array<DocumentElement>;
+    static generateGroupHeading(dataGroup: DataGroup, template: DocumentTemplate, position: PositionDefinition, span: any): any[];
+}