@contrail/document-generation 2.0.37 → 2.0.39

package/lib/frames/frame.js

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

package/lib/frames/index.d.ts

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

package/lib/frames/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("./frame"), exports);
+__exportStar(require("./frame-generator"), exports);

package/lib/index.d.ts

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

package/lib/index.js

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

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

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

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

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

package/lib/interfaces.d.ts

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

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-board.d.ts

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

package/lib/scripts/test-board.js

@@ -0,0 +1,230 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const document_generator_1 = require("../document-generator");
+const interfaces_1 = require("../interfaces");
+const sdk_1 = require("@contrail/sdk");
+const fs = require('fs');
+const nanoid_1 = require("nanoid");
+const data_grouping_1 = require("@contrail/data-grouping");
+function run() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const orgSlug = 'nb-legacy-prod';
+        yield loginSDK(orgSlug);
+        const assortmentId = 'ejNEwWTgDPAtPoSY';
+        const itemType = yield new sdk_1.Types().getType({ path: 'item' });
+        const projectItemType = yield new sdk_1.Types().getType({ path: 'project-item' });
+        const assortmentItemType = yield new sdk_1.Types().getType({ path: 'assortment-item' });
+        const PROPERTY_COMPONENT_TEMPLATE = {
+            imageDimension: { width: 600 },
+            imageLocation: 'top',
+            textHorizontalAlignment: 'center',
+            properties: [
+                {
+                    propertyDefinition: itemType.typeProperties.find((p) => p.slug === 'name'),
+                    typeRootSlug: 'item',
+                    slug: 'name',
+                    style: {
+                        font: {
+                            size: 14,
+                            weight: 'bold',
+                        },
+                        color: 'rgba(0,0,0,.5)',
+                    },
+                },
+                {
+                    propertyDefinition: itemType.typeProperties.find((p) => p.slug === 'optionName'),
+                    typeRootSlug: 'item',
+                    slug: 'optionName',
+                    style: {
+                        font: {
+                            size: 10,
+                            weight: 'bold',
+                        },
+                        color: 'green',
+                    },
+                },
+                {
+                    propertyDefinition: assortmentItemType.typeProperties.find((p) => p.slug === 'targetVolume'),
+                    slug: 'targetVolume',
+                    typeRootSlug: 'assortment-item',
+                    includeLabel: true,
+                },
+            ],
+        };
+        const PANEL_PROPERTY_TEMPLATE = {
+            properties: [
+                {
+                    propertyDefinition: itemType.typeProperties.find((p) => p.slug === 'name'),
+                    typeRootSlug: 'item',
+                    slug: 'name',
+                    includeLabel: false,
+                    style: {
+                        font: {
+                            size: 25,
+                            weight: 'bold',
+                        },
+                        color: 'white',
+                    },
+                },
+            ],
+        };
+        const documentTemplateDefinition = {
+            frameOrientation: interfaces_1.Orientation.HORIZONTAL,
+            frameSize: { width: 1200, height: 675 },
+            framePadding: 30,
+            frameGroupHeaderTemplate: {
+                style: {
+                    color: '#ffffff',
+                    font: {
+                        size: 20,
+                    },
+                    backgroundColor: 'rgba(0, 0, 0, 0.8)',
+                },
+                size: {
+                    height: 60,
+                },
+            },
+            frameInfoPanelTemplate: {
+                panelDocumentTemplate: {
+                    style: {
+                        color: '#ffffff',
+                        font: {
+                            size: 20,
+                        },
+                        backgroundColor: 'rgba(0, 0, 0, 0.8)',
+                        border: {
+                            radius: 4,
+                        },
+                    },
+                    size: {
+                        width: 250,
+                        height: 400,
+                    },
+                },
+                propertyTemplate: PANEL_PROPERTY_TEMPLATE,
+            },
+            componentGridTemplate: {
+                gridDimensions: { cols: 3, rows: 1 },
+                componentPadding: 5,
+                componentTemplate: {
+                    propertyTemplate: PROPERTY_COMPONENT_TEMPLATE,
+                },
+            },
+        };
+        const groupingProperties = [
+            {
+                propertyDefinition: itemType.typeProperties.find((p) => p.slug === 'category'),
+                typeRootSlug: 'item',
+                sort: sdk_1.SortOrderOptions.ASC,
+                values: null,
+            },
+            {
+                propertyDefinition: itemType.typeProperties.find((p) => p.slug === 'name'),
+                typeRootSlug: 'item',
+                sort: sdk_1.SortOrderOptions.ASC,
+                values: null,
+            },
+        ];
+        documentTemplateDefinition.componentGridTemplate.componentTemplate.propertyTemplate = PROPERTY_COMPONENT_TEMPLATE;
+        const dataGroup = yield getDataGroupStructure(assortmentId, groupingProperties, documentTemplateDefinition);
+        const params = {
+            startingCoordinates: { x: 500, y: 500 },
+            data: {
+                dataGroup,
+            },
+            documentTemplateDefinition,
+        };
+        const elements = document_generator_1.DocumentGenerator.generateDocumentElements(params, {});
+        const documentId = (0, nanoid_1.nanoid)(16);
+        elements.forEach((el) => {
+            el.id = (0, nanoid_1.nanoid)(16);
+        });
+        const document = {
+            size: { width: 1600, height: 900 },
+            elements,
+            id: documentId,
+        };
+        yield uploadAndOpen(orgSlug, document);
+    });
+}
+function loginSDK(orgSlug) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const config = {
+            email: 'brian@vibeiq.com',
+            password: process.env.CONTRAIL_PW,
+            orgSlug: orgSlug,
+        };
+        yield (0, sdk_1.login)(config);
+    });
+}
+function getAssortmentItems(assortmentId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const assortment = yield new sdk_1.Entities().get({
+            entityName: 'assortment',
+            id: assortmentId,
+            relations: ['assortmentItems', 'assortmentItems.item', 'assortmentItems.projectItem'],
+        });
+        let assortmentItems = assortment.assortmentItems;
+        if (assortment.itemsDownloadURL) {
+            const response = yield fetch(assortment.itemsDownloadURL);
+            assortmentItems = yield response.json();
+        }
+        return assortmentItems;
+    });
+}
+function getDataGroupStructure(assortmentId, groupingProperties, template) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const assortmentItems = yield getAssortmentItems(assortmentId);
+        const data = fromAssortmentModelToItemModel(assortmentItems);
+        const leafNodeDataCount = template.componentGridTemplate.gridDimensions.cols * template.componentGridTemplate.gridDimensions.rows;
+        return data_grouping_1.DataGroupGenerator.buildDataGroupStructure(data, groupingProperties, leafNodeDataCount);
+    });
+}
+function fromAssortmentModelToItemModel(data) {
+    const results = [];
+    data.forEach((ai) => {
+        results.push({
+            item: ai.item,
+            projectItem: ai.projectItem,
+            viewable: ai.item,
+            assortmentItem: ai,
+            assortment: { id: ai.assortmentId },
+        });
+    });
+    return results;
+}
+function uploadAndOpen(orgSlug, document) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let config = (0, sdk_1.getConfig)();
+        var writeStream = fs.createWriteStream('testdocument.json');
+        writeStream.write(JSON.stringify(document));
+        writeStream.end();
+        const file = fs.createReadStream('testdocument.json');
+        const fileEntity = yield new sdk_1.Files().createAndUploadFileFromBuffer(file, 'application/json', 'testdocument.json', null, 300);
+        const domain = 'http://preview.vibeiq.com';
+        const authToken = config.apiUserToken;
+        const documentType = 'board';
+        let url = domain +
+            '?url=' +
+            encodeURIComponent(fileEntity.downloadUrl) +
+            '&orgSlug=' +
+            encodeURIComponent(orgSlug) +
+            '&apiToken=' +
+            encodeURIComponent(authToken) +
+            '&documentType=' +
+            encodeURIComponent(documentType);
+        var start = process.platform == 'darwin' ? 'open' : process.platform == 'win32' ? 'start' : 'xdg-open';
+        const encodedUrl = url.replace(/&/g, '^&');
+        require('child_process').exec(start + ' ' + encodedUrl);
+    });
+}
+run();

package/lib/scripts/test-showcase.d.ts

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