@contrail/document-generation 1.0.15 → 1.0.17

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

@@ -0,0 +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;
+}

package/lib/components/component-generator.js

@@ -0,0 +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;

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

@@ -0,0 +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;
+}

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

@@ -0,0 +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;
+        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);
+        if (componentSize.width < 120) {
+            componentSize.width = 120;
+        }
+        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 requiredSize = {
+            width: componentSize.width * template.gridDimensions.cols + ((template.gridDimensions.cols * 2) * template.componentPadding || 20),
+            height: componentSize.height * template.gridDimensions.rows + ((template.gridDimensions.rows * 2) * template.componentPadding || 20)
+        };
+        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

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

package/lib/components/component-util.js

@@ -0,0 +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;

package/lib/document-generator.d.ts

@@ -0,0 +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[];
+}

package/lib/document-generator.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentGenerator = void 0;
+const documents_1 = require("@contrail/documents");
+const interfaces_1 = require("./interfaces");
+const util_1 = require("@contrail/util");
+const frame_generator_1 = require("./frame-generator");
+class DocumentGenerator {
+    constructor() {
+    }
+    static generateDocumentElements(options) {
+        const elements = [];
+        const structure = options.data.dataGroup;
+        const template = options.documentTemplateDefinition;
+        console.log("generateDocumentElements: ", structure.depth, structure.groupingProperties.length);
+        let position = options.startingCoordinates || { x: 0, y: 0 };
+        const group = structure.rootGroup;
+        elements.push(...this.generateGroup(group, template, position, structure.depth, 0));
+        return elements;
+    }
+    static generateGroup(group, template, startingPosition, totalDepth, currentDepth) {
+        const elements = [];
+        let position = util_1.ObjectUtil.cloneDeep(startingPosition);
+        if (currentDepth > 0) {
+            let groupHeaderPosition = { x: position.x + template.framePadding, y: position.y + template.framePadding };
+            let span = this.getGroupSpan(group, totalDepth, currentDepth);
+            elements.push(...this.generateGroupHeading(group, template, groupHeaderPosition, span));
+            let groupHeaderDimensions = { width: template.frameSize.width, height: template.frameGroupHeaderTemplate.size.height };
+            if (template.frameOrientation === interfaces_1.Orientation.HORIZONTAL) {
+                position = { x: position.x + groupHeaderDimensions.height + template.framePadding, y: position.y };
+            }
+            else {
+                position = { x: position.x, y: position.y + groupHeaderDimensions.height + template.framePadding };
+            }
+        }
+        if (currentDepth === totalDepth) {
+            elements.push(...this.generateFrameGroup(group, template, position));
+        }
+        if (currentDepth < totalDepth) {
+            for (let subGroup of group.subGroups) {
+                elements.push(...this.generateGroup(subGroup, template, position, totalDepth, currentDepth + 1));
+                let frameSetMultiple = this.getGroupSpan(subGroup, totalDepth, currentDepth + 1);
+                let paddingMultiple = 1;
+                if (currentDepth < totalDepth) {
+                    paddingMultiple = frameSetMultiple;
+                }
+                if (template.frameOrientation === interfaces_1.Orientation.HORIZONTAL) {
+                    position = { x: position.x, y: position.y + (template.frameSize.height * frameSetMultiple) + (template.framePadding * paddingMultiple) };
+                }
+                else {
+                    position = { x: position.x + (template.frameSize.width * frameSetMultiple) + (template.framePadding * paddingMultiple), y: position.y };
+                }
+            }
+        }
+        return elements;
+    }
+    static getGroupSpan(group, totalDepth, currentDepth) {
+        let span = 1;
+        if (currentDepth !== totalDepth) {
+            span = group.subGroups.length;
+        }
+        return span;
+    }
+    static generateFrameGroup(dataGroup, template, position) {
+        const elements = [];
+        let framePosition = { x: position.x + template.framePadding, y: position.y + template.framePadding };
+        for (let group of dataGroup.subGroups) {
+            elements.push(...frame_generator_1.FrameGenerator.generateFrameForDataGroup(group, framePosition, template));
+            if (template.frameOrientation === interfaces_1.Orientation.HORIZONTAL) {
+                framePosition.x = framePosition.x + template.frameSize.width + template.framePadding || 10;
+            }
+            else {
+                framePosition.y = framePosition.y + template.frameSize.height + template.framePadding || 10;
+            }
+        }
+        return elements;
+    }
+    static generateGroupHeading(dataGroup, template, position, span) {
+        const elements = [];
+        const heading = documents_1.DocumentElementFactory.createTextElement("Placeholder", {});
+        heading.style = { border: { width: 1, color: "rgba(0,0,0,0)" }, color: "#000000", backgroundColor: template.frameGroupHeaderTemplate.style.backgroundColor || 'black' };
+        heading.text = `<p><span style=\"font-size: ${template.frameGroupHeaderTemplate.style.font.size}pt;\"><strong><span style=\"color: ${template.frameGroupHeaderTemplate.style.color};\">${dataGroup.name}</span></strong></span></p>`;
+        heading.position = position;
+        if (template.frameOrientation === interfaces_1.Orientation.HORIZONTAL) {
+            let sizeDim = template.frameSize.height * span;
+            if (span > 1) {
+                sizeDim += (span - 1) * template.framePadding;
+            }
+            heading.size = { width: sizeDim, height: template.frameGroupHeaderTemplate.size.height };
+            heading.rotate = { angle: 270 };
+            heading.position.x = heading.position.x - (heading.size.width / 2) + (heading.size.height / 2);
+            heading.position.y = heading.position.y + (heading.size.width / 2) - (heading.size.height / 2);
+        }
+        else {
+            let sizeDim = template.frameSize.width * span;
+            if (span > 1) {
+                sizeDim += (span - 1) * template.framePadding;
+            }
+            heading.rotate = { angle: 0 };
+            heading.size = { width: sizeDim, height: template.frameGroupHeaderTemplate.size.height };
+        }
+        elements.push(heading);
+        return elements;
+    }
+}
+exports.DocumentGenerator = DocumentGenerator;

package/lib/frame-generator.d.ts

@@ -0,0 +1,9 @@
+import { DocumentElement, PositionDefinition, SizeDefinition } from "@contrail/documents";
+import { DataGroup } from "@contrail/data-grouping";
+import { DocumentTemplate } from "./interfaces";
+export declare class FrameGenerator {
+    static generateFrameForDataGroup(dataGroup: DataGroup, framePosition: PositionDefinition, template: DocumentTemplate): any[];
+    static generateFrameHeaderForDataGroup(dataGroup: DataGroup, position: PositionDefinition, template: DocumentTemplate, headerSize: SizeDefinition): DocumentElement[];
+    static generateFrameInfoPanelForDataGroup(dataGroup: DataGroup, position: PositionDefinition, template: DocumentTemplate, panelSize: SizeDefinition): DocumentElement[];
+    static generateFrame(options: DocumentElement): DocumentElement;
+}

package/lib/frame-generator.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FrameGenerator = void 0;
+const documents_1 = require("@contrail/documents");
+const component_grid_generator_1 = require("./components/component-grid-generator");
+const util_1 = require("@contrail/util");
+const document_util_1 = require("./util/document-util");
+const info_panel_generator_1 = require("./info-panel/info-panel-generator");
+class FrameGenerator {
+    static generateFrameForDataGroup(dataGroup, framePosition, template) {
+        var _a, _b;
+        const elements = [];
+        const frame = this.generateFrame({
+            position: util_1.ObjectUtil.cloneDeep(framePosition),
+            size: template.frameSize,
+            style: { backgroundColor: "#fff", border: { width: 1, color: "#616161" } }
+        });
+        frame.name = dataGroup.name;
+        const FRAME_PADDING = 20;
+        const headerPosition = util_1.ObjectUtil.cloneDeep(framePosition);
+        headerPosition.y = headerPosition.y + FRAME_PADDING;
+        headerPosition.x = headerPosition.x + FRAME_PADDING;
+        const panelPosition = util_1.ObjectUtil.cloneDeep(framePosition);
+        panelPosition.y = panelPosition.y + FRAME_PADDING;
+        panelPosition.x = panelPosition.x + FRAME_PADDING;
+        let frameHeaderDimensions = { height: 0, width: 0 };
+        let framePanelDimensions = { height: 0, width: 0 };
+        let hasPanel = false;
+        let hasHeader = false;
+        elements.push(util_1.ObjectUtil.cloneDeep(frame));
+        if (template.frameHeaderTemplate) {
+            hasHeader = true;
+            frameHeaderDimensions = { height: 50, width: template.frameSize.width - 50 };
+            elements.push(...this.generateFrameHeaderForDataGroup(dataGroup, headerPosition, template, frameHeaderDimensions));
+        }
+        if (template.frameInfoPanelTemplate) {
+            hasPanel = true;
+            framePanelDimensions = { width: ((_b = (_a = template.frameInfoPanelTemplate.panelDocumentTemplate) === null || _a === void 0 ? void 0 : _a.size) === null || _b === void 0 ? void 0 : _b.width) || 300 };
+            framePanelDimensions.height = template.frameSize.height - (2 * FRAME_PADDING);
+            elements.push(...this.generateFrameInfoPanelForDataGroup(dataGroup, panelPosition, template, framePanelDimensions));
+        }
+        const GRID_MARGIN = 20;
+        let gridPosition = util_1.ObjectUtil.cloneDeep(framePosition);
+        if (hasHeader) {
+            gridPosition = util_1.ObjectUtil.cloneDeep(headerPosition);
+            gridPosition.y = gridPosition.y + frameHeaderDimensions.height + GRID_MARGIN;
+        }
+        if (hasPanel) {
+            gridPosition = util_1.ObjectUtil.cloneDeep(panelPosition);
+            gridPosition.x = gridPosition.x + framePanelDimensions.width + GRID_MARGIN;
+        }
+        const relativeGridPosition = document_util_1.DocumentUtil.getRelativePosition(framePosition, gridPosition);
+        const frameSize = template.frameSize;
+        const idealGridSize = {
+            width: frameSize.width - relativeGridPosition.x - FRAME_PADDING,
+            height: frameSize.height - relativeGridPosition.y - FRAME_PADDING
+        };
+        elements.push(...component_grid_generator_1.ComponentGridGenerator.generateComponentGrid(dataGroup.data, gridPosition, template.componentGridTemplate, idealGridSize));
+        return elements;
+    }
+    static generateFrameHeaderForDataGroup(dataGroup, position, template, headerSize) {
+        const heading = documents_1.DocumentElementFactory.createTextElement(dataGroup.name, template.frameHeaderTemplate);
+        heading.style = { border: { width: 1, color: "rgba(0,0,0,0)" }, color: "#000000", backgroundColor: template.frameHeaderTemplate.style.backgroundColor || 'black' };
+        heading.text = `<p><span style=\"font-size: ${template.frameHeaderTemplate.style.font.size}pt;\"><strong><span style=\"color: ${template.frameHeaderTemplate.style.color};\">${dataGroup.name}</span></strong></span></p>`;
+        heading.size = util_1.ObjectUtil.cloneDeep(headerSize);
+        heading.position = util_1.ObjectUtil.cloneDeep(position);
+        return [heading];
+    }
+    static generateFrameInfoPanelForDataGroup(dataGroup, position, template, panelSize) {
+        return info_panel_generator_1.InfoPanelGenerator.generatePanelFromTemplate(dataGroup.propertyValues, template.frameInfoPanelTemplate, position, panelSize);
+    }
+    static generateFrame(options) {
+        const frame = documents_1.DocumentElementFactory.createFrameElement(options);
+        return frame;
+    }
+}
+exports.FrameGenerator = FrameGenerator;

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './document-generator';
+export * from './interfaces';

package/lib/index.js

@@ -0,0 +1,18 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./document-generator"), exports);
+__exportStar(require("./interfaces"), exports);

package/lib/info-panel/info-panel-generator.d.ts

@@ -0,0 +1,5 @@
+import { DocumentElement, PositionDefinition, SizeDefinition } from "@contrail/documents";
+import { FrameInfoPanelTemplate } from "../interfaces";
+export declare class InfoPanelGenerator {
+    static generatePanelFromTemplate(data: any, template: FrameInfoPanelTemplate, position: PositionDefinition, panelSize: SizeDefinition): Array<DocumentElement>;
+}

package/lib/info-panel/info-panel-generator.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InfoPanelGenerator = void 0;
+const documents_1 = require("@contrail/documents");
+const util_1 = require("@contrail/util");
+const document_property_util_1 = require("../util/document-property-util");
+class InfoPanelGenerator {
+    static generatePanelFromTemplate(data, template, position, panelSize) {
+        var _a;
+        if (!template.propertyTemplate) {
+            throw Error("No panel property template defined");
+        }
+        const elements = [];
+        const panel = documents_1.DocumentElementFactory.createShapeElement('rectangle', {});
+        panel.style = ((_a = template.panelDocumentTemplate) === null || _a === void 0 ? void 0 : _a.style) || {};
+        panel.size = util_1.ObjectUtil.cloneDeep(panelSize) || {};
+        panel.position = util_1.ObjectUtil.cloneDeep(position);
+        elements.push(panel);
+        const textOptions = {
+            style: {
+                text: {
+                    align: template.propertyTemplate.textHorizontalAlignment
+                }
+            },
+            size: {
+                width: panelSize.width - 10
+            }
+        };
+        const textElements = document_property_util_1.DocumentPropertyUtil.generatePropertyTextElements(data, template.propertyTemplate.properties, textOptions, { x: panel.position.x, y: panel.position.y }, false);
+        elements.push(...textElements);
+        return elements;
+    }
+}
+exports.InfoPanelGenerator = InfoPanelGenerator;

package/lib/interfaces.d.ts

@@ -0,0 +1,56 @@
+import { DataGroupStructure } from "@contrail/data-grouping";
+import { PositionDefinition, SizeDefinition, DocumentElement, StyleDefinition } from "@contrail/documents";
+import { TypeProperty } from "@contrail/types";
+export declare enum Orientation {
+    HORIZONTAL = "horizontal",
+    VERTICAL = "vertical"
+}
+export interface DocumentGenerationDataDefinition {
+    dataGroup: DataGroupStructure;
+}
+export interface DocumentGenerationOptions {
+    startingCoordinates: PositionDefinition;
+    data: DocumentGenerationDataDefinition;
+    documentTemplateDefinition: DocumentTemplate;
+}
+export interface DocumentTemplate {
+    frameOrientation: Orientation;
+    frameSize: SizeDefinition;
+    framePadding?: number;
+    frameGroupHeaderTemplate: DocumentElement;
+    frameHeaderTemplate?: DocumentElement;
+    frameInfoPanelTemplate?: FrameInfoPanelTemplate;
+    componentGridTemplate: ComponentGridTemplate;
+}
+export interface FrameInfoPanelTemplate {
+    panelDocumentTemplate: DocumentElement;
+    propertyTemplate: PanelPropertyTemplate;
+}
+export interface PanelPropertyTemplate {
+    textHorizontalAlignment?: 'center' | 'right' | 'left';
+    properties: Array<DocumentPropertyDefinition>;
+}
+export interface ComponentGridTemplate {
+    componentTemplate: ComponentTemplate;
+    componentPadding?: number;
+    gridDimensions: {
+        rows: number;
+        cols: number;
+    };
+}
+export interface ComponentTemplate {
+    propertyTemplate?: ComponentPropertyTemplate;
+}
+export interface ComponentPropertyTemplate {
+    imageDimension?: SizeDefinition;
+    imageLocation?: 'top' | 'right' | 'left' | 'bottom';
+    textHorizontalAlignment?: 'center' | 'right' | 'left';
+    properties: Array<DocumentPropertyDefinition>;
+}
+export interface DocumentPropertyDefinition {
+    style?: StyleDefinition;
+    propertyDefinition: TypeProperty;
+    slug: string;
+    typeRootSlug: string;
+    includeLabel?: boolean;
+}

package/lib/interfaces.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Orientation = void 0;
+var Orientation;
+(function (Orientation) {
+    Orientation["HORIZONTAL"] = "horizontal";
+    Orientation["VERTICAL"] = "vertical";
+})(Orientation = exports.Orientation || (exports.Orientation = {}));

package/lib/scripts/test.d.ts

@@ -0,0 +1 @@
+export {};