@contrail/document-generation 2.0.33 → 2.0.35

package/lib/frames/frame.d.ts

@@ -1,16 +1,16 @@
-import { DocumentElement, PositionDefinition, SizeDefinition, StyleDefinition } from '@contrail/documents';
-export declare abstract class DocumentFrame {
-    frameContentElements: Array<DocumentElement>;
-    constructor();
-    addDocumentElements(elements: Array<DocumentElement>): void;
-    toDocumentElements(): Array<DocumentElement>;
-}
-export declare class ShowcaseFrame extends DocumentFrame {
-    documentGenerationConfigId?: string;
-}
-export declare class BoardFrame extends DocumentFrame {
-    private frameElement;
-    name: string;
-    constructor(name: string, position: PositionDefinition, size: SizeDefinition, style: StyleDefinition, clipContent?: boolean);
-    toDocumentElements(): Array<DocumentElement>;
-}
+import { DocumentElement, PositionDefinition, SizeDefinition, StyleDefinition } from '@contrail/documents';
+export declare abstract class DocumentFrame {
+    frameContentElements: Array<DocumentElement>;
+    constructor();
+    addDocumentElements(elements: Array<DocumentElement>): void;
+    toDocumentElements(): Array<DocumentElement>;
+}
+export declare class ShowcaseFrame extends DocumentFrame {
+    documentGenerationConfigId?: string;
+}
+export declare class BoardFrame extends DocumentFrame {
+    private frameElement;
+    name: string;
+    constructor(name: string, position: PositionDefinition, size: SizeDefinition, style: StyleDefinition, clipContent?: boolean);
+    toDocumentElements(): Array<DocumentElement>;
+}

package/lib/frames/frame.js

@@ -1,67 +1,67 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BoardFrame = exports.ShowcaseFrame = exports.DocumentFrame = void 0;
-const documents_1 = require("@contrail/documents");
-const util_1 = require("@contrail/util");
-class DocumentFrame {
-    constructor() {
-        this.frameContentElements = [];
-    }
-    addDocumentElements(elements) {
-        this.frameContentElements.push(...elements);
-    }
-    toDocumentElements() {
-        const elements = [];
-        elements.push(...this.frameContentElements);
-        return elements;
-    }
-}
-exports.DocumentFrame = DocumentFrame;
-class ShowcaseFrame extends DocumentFrame {
-}
-exports.ShowcaseFrame = ShowcaseFrame;
-class BoardFrame extends DocumentFrame {
-    constructor(name, position, size, style, clipContent = false) {
-        super();
-        if (!position) {
-            position = { x: 0, y: 0 };
-        }
-        if (!size) {
-            size = { width: 1200, height: 675 };
-        }
-        if (!style) {
-            style = {};
-        }
-        this.frameElement = documents_1.DocumentElementFactory.createFrameElement({ size, position, style, clipContent });
-        this.frameElement.name = name;
-    }
-    toDocumentElements() {
-        const elements = [];
-        elements.push(this.frameElement);
-        const repositionedElements = [];
-        for (let element of util_1.ObjectUtil.cloneDeep(this.frameContentElements)) {
-            if (this.frameElement.position.x !== 0) {
-                if (element.type === 'line') {
-                    element.lineDefinition.x1 += this.frameElement.position.x;
-                    element.lineDefinition.x2 += this.frameElement.position.x;
-                }
-                else {
-                    element.position.x += this.frameElement.position.x;
-                }
-            }
-            if (this.frameElement.position.y !== 0) {
-                if (element.type === 'line') {
-                    element.lineDefinition.y1 += this.frameElement.position.y;
-                    element.lineDefinition.y2 += this.frameElement.position.y;
-                }
-                else {
-                    element.position.y += this.frameElement.position.y;
-                }
-            }
-            repositionedElements.push(element);
-        }
-        elements.push(...repositionedElements);
-        return elements;
-    }
-}
-exports.BoardFrame = BoardFrame;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BoardFrame = exports.ShowcaseFrame = exports.DocumentFrame = void 0;
+const documents_1 = require("@contrail/documents");
+const util_1 = require("@contrail/util");
+class DocumentFrame {
+    constructor() {
+        this.frameContentElements = [];
+    }
+    addDocumentElements(elements) {
+        this.frameContentElements.push(...elements);
+    }
+    toDocumentElements() {
+        const elements = [];
+        elements.push(...this.frameContentElements);
+        return elements;
+    }
+}
+exports.DocumentFrame = DocumentFrame;
+class ShowcaseFrame extends DocumentFrame {
+}
+exports.ShowcaseFrame = ShowcaseFrame;
+class BoardFrame extends DocumentFrame {
+    constructor(name, position, size, style, clipContent = false) {
+        super();
+        if (!position) {
+            position = { x: 0, y: 0 };
+        }
+        if (!size) {
+            size = { width: 1200, height: 675 };
+        }
+        if (!style) {
+            style = {};
+        }
+        this.frameElement = documents_1.DocumentElementFactory.createFrameElement({ size, position, style, clipContent });
+        this.frameElement.name = name;
+    }
+    toDocumentElements() {
+        const elements = [];
+        elements.push(this.frameElement);
+        const repositionedElements = [];
+        for (let element of util_1.ObjectUtil.cloneDeep(this.frameContentElements)) {
+            if (this.frameElement.position.x !== 0) {
+                if (element.type === 'line') {
+                    element.lineDefinition.x1 += this.frameElement.position.x;
+                    element.lineDefinition.x2 += this.frameElement.position.x;
+                }
+                else {
+                    element.position.x += this.frameElement.position.x;
+                }
+            }
+            if (this.frameElement.position.y !== 0) {
+                if (element.type === 'line') {
+                    element.lineDefinition.y1 += this.frameElement.position.y;
+                    element.lineDefinition.y2 += this.frameElement.position.y;
+                }
+                else {
+                    element.position.y += this.frameElement.position.y;
+                }
+            }
+            repositionedElements.push(element);
+        }
+        elements.push(...repositionedElements);
+        return elements;
+    }
+}
+exports.BoardFrame = BoardFrame;

package/lib/frames/index.d.ts

@@ -1,2 +1,2 @@
-export * from './frame';
-export * from './frame-generator';
+export * from './frame';
+export * from './frame-generator';

package/lib/frames/index.js

@@ -1,18 +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("./frame"), exports);
-__exportStar(require("./frame-generator"), exports);
+"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("./frame"), exports);
+__exportStar(require("./frame-generator"), exports);

package/lib/index.d.ts

@@ -1,6 +1,6 @@
-export * from './document-generator';
-export * from './board-document-generator';
-export * from './showcase-frame-generator';
-export * from './interfaces';
-export * from './frames';
-export * from './util';
+export * from './document-generator';
+export * from './board-document-generator';
+export * from './showcase-frame-generator';
+export * from './interfaces';
+export * from './frames';
+export * from './util';

package/lib/index.js

@@ -1,22 +1,22 @@
-"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("./board-document-generator"), exports);
-__exportStar(require("./showcase-frame-generator"), exports);
-__exportStar(require("./interfaces"), exports);
-__exportStar(require("./frames"), exports);
-__exportStar(require("./util"), exports);
+"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("./board-document-generator"), exports);
+__exportStar(require("./showcase-frame-generator"), exports);
+__exportStar(require("./interfaces"), exports);
+__exportStar(require("./frames"), exports);
+__exportStar(require("./util"), exports);

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

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

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

@@ -1,52 +1,52 @@
-"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 generatedModelBindings(data) {
-        const model = {};
-        if (data.item) {
-            model.item = `item:${data.item.id}`;
-        }
-        if (data.projectItem) {
-            model.projectItem = `project-item:${data.projectItem.id}`;
-        }
-        if (data.assortmentItem) {
-            model.assortmentItem = `assortment-item:${data.assortmentItem.id}`;
-        }
-        if (data.assortment) {
-            model.assortment = `assortment:${data.assortment.id}`;
-        }
-        return model;
-    }
-    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 modelBindings = this.generatedModelBindings(data);
-        const textOptions = {
-            style: {
-                text: {
-                    align: template.propertyTemplate.textHorizontalAlignment,
-                },
-            },
-            size: {
-                width: panelSize.width - 10,
-            },
-            modelBindings,
-        };
-        const textElements = document_property_util_1.DocumentPropertyUtil.generatePropertyElements(data, template.propertyTemplate.properties, textOptions, { x: panel.position.x, y: panel.position.y }, {}, false);
-        elements.push(...textElements);
-        return elements;
-    }
-}
-exports.InfoPanelGenerator = InfoPanelGenerator;
+"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 generatedModelBindings(data) {
+        const model = {};
+        if (data.item) {
+            model.item = `item:${data.item.id}`;
+        }
+        if (data.projectItem) {
+            model.projectItem = `project-item:${data.projectItem.id}`;
+        }
+        if (data.assortmentItem) {
+            model.assortmentItem = `assortment-item:${data.assortmentItem.id}`;
+        }
+        if (data.assortment) {
+            model.assortment = `assortment:${data.assortment.id}`;
+        }
+        return model;
+    }
+    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 modelBindings = this.generatedModelBindings(data);
+        const textOptions = {
+            style: {
+                text: {
+                    align: template.propertyTemplate.textHorizontalAlignment,
+                },
+            },
+            size: {
+                width: panelSize.width - 10,
+            },
+            modelBindings,
+        };
+        const textElements = document_property_util_1.DocumentPropertyUtil.generatePropertyElements(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

@@ -1,72 +1,72 @@
-import { DataGroupStructure } from '@contrail/data-grouping';
-import { PositionDefinition, SizeDefinition, Document, 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;
-    frameTemplate?: FrameDocumentTemplate;
-}
-export interface DocumentTemplate {
-    frameOrientation: Orientation;
-    frameSize: SizeDefinition;
-    framePadding?: number;
-    frameGroupHeaderTemplate: DocumentElement;
-    secondaryFrameGroupHeaderTemplate?: DocumentElement;
-    frameHeaderTemplate?: DocumentElement;
-    frameInfoPanelTemplate?: FrameInfoPanelTemplate;
-    componentGridTemplate: ComponentGridTemplate;
-}
-export interface GridSpaceDefinition {
-    size: SizeDefinition;
-    position: PositionDefinition;
-}
-export interface FrameDocumentTemplate {
-    id: string;
-    templateType: 'FRAME' | 'BOARD';
-    document: Document;
-    gridSpaceDefinition: GridSpaceDefinition;
-    name: string;
-    clipContent: boolean;
-}
-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;
-    isHidden?: boolean;
-    size?: SizeDefinition;
-}
+import { DataGroupStructure } from '@contrail/data-grouping';
+import { PositionDefinition, SizeDefinition, Document, 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;
+    frameTemplate?: FrameDocumentTemplate;
+}
+export interface DocumentTemplate {
+    frameOrientation: Orientation;
+    frameSize: SizeDefinition;
+    framePadding?: number;
+    frameGroupHeaderTemplate: DocumentElement;
+    secondaryFrameGroupHeaderTemplate?: DocumentElement;
+    frameHeaderTemplate?: DocumentElement;
+    frameInfoPanelTemplate?: FrameInfoPanelTemplate;
+    componentGridTemplate: ComponentGridTemplate;
+}
+export interface GridSpaceDefinition {
+    size: SizeDefinition;
+    position: PositionDefinition;
+}
+export interface FrameDocumentTemplate {
+    id: string;
+    templateType: 'FRAME' | 'BOARD';
+    document: Document;
+    gridSpaceDefinition: GridSpaceDefinition;
+    name: string;
+    clipContent: boolean;
+}
+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;
+    isHidden?: boolean;
+    size?: SizeDefinition;
+}

package/lib/interfaces.js

@@ -1,8 +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 = {}));
+"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-board.d.ts

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