@contrail/document-generation 1.0.15 → 1.0.17

package/lib/scripts/test.js

@@ -0,0 +1,270 @@
+"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 = 'converse-prod';
+        yield loginSDK(orgSlug);
+        const assortmentId = 'Z7nTOauGtuuiU9UC';
+        const itemType = yield new sdk_1.Types().getType({ path: 'item' });
+        const projectItemType = yield new sdk_1.Types().getType({ path: 'project-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: itemType.typeProperties.find(p => p.slug === 'category'),
+                    typeRootSlug: 'item',
+                    slug: "category",
+                    includeLabel: true,
+                }, {
+                    propertyDefinition: itemType.typeProperties.find(p => p.slug === 'designTheme'),
+                    typeRootSlug: 'item',
+                    slug: "designTheme",
+                    includeLabel: true,
+                }, {
+                    propertyDefinition: itemType.typeProperties.find(p => p.slug === 'baseStyleNumber'),
+                    typeRootSlug: 'item',
+                    slug: "baseStyleNumber",
+                }]
+        };
+        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',
+                    }
+                }, {
+                    propertyDefinition: itemType.typeProperties.find(p => p.slug === 'segment'),
+                    typeRootSlug: 'item',
+                    slug: "segment",
+                    includeLabel: true,
+                    style: {
+                        font: {
+                            size: 14,
+                        },
+                        color: 'white',
+                    }
+                }, {
+                    propertyDefinition: itemType.typeProperties.find(p => p.slug === 'familyName'),
+                    typeRootSlug: 'item',
+                    slug: "familyName",
+                    includeLabel: true,
+                    style: {
+                        font: {
+                            size: 14,
+                        },
+                        color: 'white',
+                    }
+                }, {
+                    propertyDefinition: itemType.typeProperties.find(p => p.slug === 'ageGroup'),
+                    typeRootSlug: 'item',
+                    slug: "ageGroup",
+                    includeLabel: true,
+                    style: {
+                        font: {
+                            size: 14,
+                        },
+                        color: 'white',
+                    }
+                }, {
+                    propertyDefinition: itemType.typeProperties.find(p => p.slug === 'planningLevel1'),
+                    typeRootSlug: 'item',
+                    slug: "planningLevel1",
+                    includeLabel: true,
+                    style: {
+                        font: {
+                            size: 14,
+                        },
+                        color: 'white',
+                    }
+                }]
+        };
+        const documentTemplateDefinition = {
+            frameOrientation: interfaces_1.Orientation.VERTICAL,
+            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: 4, rows: 2 },
+                componentPadding: 5,
+                componentTemplate: {
+                    propertyTemplate: PROPERTY_COMPONENT_TEMPLATE
+                }
+            }
+        };
+        const groupingProperties = [
+            {
+                property: itemType.typeProperties.find(p => p.slug === 'category'),
+                scope: 'item',
+                sort: sdk_1.SortOrderOptions.ASC,
+                values: null,
+            }, {
+                property: itemType.typeProperties.find(p => p.slug === 'name'),
+                scope: '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,
+        });
+    });
+    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/test-data.d.ts

@@ -0,0 +1,72 @@
+import { DataGroupStructure } from "@contrail/data-grouping";
+import { ComponentGridTemplate, DocumentTemplate } from "./interfaces";
+export declare const TEST_ITEM_MODEL: {
+    item: {
+        id: string;
+        name: string;
+        optionName: string;
+        gender: string;
+        mediumViewableDownloadUrl: string;
+    };
+    projectItem: {
+        id: string;
+        retailPrice: number;
+    };
+    assortmentItem: {
+        id: string;
+        targetVolume: number;
+    };
+};
+export declare const TEST_GROUP: {
+    name: string;
+    data: {
+        item: {
+            id: string;
+            name: string;
+            optionName: string;
+            gender: string;
+            mediumViewableDownloadUrl: string;
+        };
+        projectItem: {
+            id: string;
+            retailPrice: number;
+        };
+        assortmentItem: {
+            id: string;
+            targetVolume: number;
+        };
+    }[];
+    propertyValues: {
+        gender: string;
+    };
+    subGroups: any[];
+};
+export declare const TEST_GROUP_2: {
+    name: string;
+    data: {
+        item: {
+            id: string;
+            name: string;
+            optionName: string;
+            gender: string;
+            mediumViewableDownloadUrl: string;
+        };
+        projectItem: {
+            id: string;
+            retailPrice: number;
+        };
+        assortmentItem: {
+            id: string;
+            targetVolume: number;
+        };
+    }[];
+    propertyValues: {
+        gender: string;
+    };
+    subGroups: any[];
+};
+export declare const TEST_ROOT_GROUP: DataGroupStructure;
+export declare const TEST_TWO_LEVEL_ROOT_GROUP: DataGroupStructure;
+export declare const COMPONENT_GRID_TEMPLATE: ComponentGridTemplate;
+export declare const HORIZONTAL_DOCUMENT_TEMPLATE: DocumentTemplate;
+export declare const VERTICAL_DOCUMENT_TEMPLATE: DocumentTemplate;

package/lib/test-data.js

@@ -0,0 +1,176 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERTICAL_DOCUMENT_TEMPLATE = exports.HORIZONTAL_DOCUMENT_TEMPLATE = exports.COMPONENT_GRID_TEMPLATE = exports.TEST_TWO_LEVEL_ROOT_GROUP = exports.TEST_ROOT_GROUP = exports.TEST_GROUP_2 = exports.TEST_GROUP = exports.TEST_ITEM_MODEL = void 0;
+const types_1 = require("@contrail/types");
+const interfaces_1 = require("./interfaces");
+const sdk_1 = require("@contrail/sdk");
+exports.TEST_ITEM_MODEL = {
+    item: {
+        id: 'item-1001',
+        name: 'Shirt 1',
+        optionName: 'Red',
+        gender: 'mens',
+        mediumViewableDownloadUrl: 'https://api.vibeiq.com/dev/api/files/downloadUrl/-VMrLJrt3clDKPi0%2Fcontent:m3Bd4u-QLci1XiOl%2F2b72d48a-6b19-4ba8-9d54-813745fb8dd4.png',
+    },
+    projectItem: {
+        id: 'projectItem-1001',
+        retailPrice: 45.00
+    },
+    assortmentItem: {
+        id: 'assortmentItem-1001',
+        targetVolume: 1000
+    },
+};
+exports.TEST_GROUP = {
+    name: "Mens",
+    data: [exports.TEST_ITEM_MODEL,
+        exports.TEST_ITEM_MODEL,
+        exports.TEST_ITEM_MODEL,
+        exports.TEST_ITEM_MODEL,
+        exports.TEST_ITEM_MODEL,
+        exports.TEST_ITEM_MODEL,
+        exports.TEST_ITEM_MODEL,
+        exports.TEST_ITEM_MODEL,
+        exports.TEST_ITEM_MODEL,
+        exports.TEST_ITEM_MODEL],
+    propertyValues: {
+        gender: 'mens'
+    },
+    subGroups: [],
+};
+exports.TEST_GROUP_2 = {
+    name: "Womens",
+    data: [exports.TEST_ITEM_MODEL,
+        exports.TEST_ITEM_MODEL,
+        exports.TEST_ITEM_MODEL,
+        exports.TEST_ITEM_MODEL,
+        exports.TEST_ITEM_MODEL,
+        exports.TEST_ITEM_MODEL,
+        exports.TEST_ITEM_MODEL],
+    propertyValues: {
+        gender: 'womens'
+    },
+    subGroups: [],
+};
+exports.TEST_ROOT_GROUP = {
+    depth: 1,
+    groupingProperties: [{
+            property: {
+                slug: 'gender',
+                propertyType: types_1.PropertyType.SingleSelect,
+                label: "Gender",
+            },
+            sort: sdk_1.SortOrderOptions.ASC,
+            scope: 'item',
+            values: null,
+        }],
+    rootGroup: {
+        data: [],
+        subGroups: [exports.TEST_GROUP, exports.TEST_GROUP, exports.TEST_GROUP],
+        name: "Root",
+        propertyValues: {},
+    }
+};
+exports.TEST_TWO_LEVEL_ROOT_GROUP = {
+    depth: 2,
+    groupingProperties: [{
+            property: {
+                slug: 'gender',
+                propertyType: types_1.PropertyType.SingleSelect,
+                label: "Gender",
+            },
+            sort: sdk_1.SortOrderOptions.ASC,
+            scope: 'item',
+            values: null,
+        }],
+    rootGroup: {
+        data: [],
+        subGroups: [{
+                name: 'Mens',
+                subGroups: [exports.TEST_GROUP, exports.TEST_GROUP],
+                propertyValues: {
+                    gender: 'mens'
+                },
+                data: [],
+            }, {
+                name: 'Womens',
+                subGroups: [exports.TEST_GROUP_2, exports.TEST_GROUP_2, exports.TEST_GROUP_2, exports.TEST_GROUP_2],
+                propertyValues: {
+                    gender: 'mens'
+                },
+                data: [],
+            }],
+        name: "Root",
+        propertyValues: {},
+    }
+};
+exports.COMPONENT_GRID_TEMPLATE = {
+    gridDimensions: { cols: 7, rows: 3 },
+    componentTemplate: {
+        propertyTemplate: {
+            properties: [],
+            imageLocation: 'top',
+        }
+    },
+    componentPadding: 20
+};
+exports.HORIZONTAL_DOCUMENT_TEMPLATE = {
+    frameOrientation: interfaces_1.Orientation.HORIZONTAL,
+    frameSize: { width: 1200, height: 675 },
+    framePadding: 30,
+    frameHeaderTemplate: {
+        style: {
+            color: '#000000',
+            font: {
+                size: 20
+            },
+            backgroundColor: '#FFFFFF',
+        },
+        size: {
+            height: 60,
+        }
+    },
+    frameGroupHeaderTemplate: {
+        style: {
+            color: '#ffffff',
+            font: {
+                size: 20
+            },
+            backgroundColor: 'black',
+        },
+        size: {
+            height: 60,
+        }
+    },
+    componentGridTemplate: exports.COMPONENT_GRID_TEMPLATE,
+};
+exports.VERTICAL_DOCUMENT_TEMPLATE = {
+    frameOrientation: interfaces_1.Orientation.VERTICAL,
+    frameSize: { width: 1200, height: 675 },
+    framePadding: 30,
+    frameHeaderTemplate: {
+        style: {
+            color: '#000000',
+            font: {
+                size: 20
+            },
+            backgroundColor: '#FFFFFF',
+        },
+        size: {
+            height: 60,
+        }
+    },
+    frameGroupHeaderTemplate: {
+        style: {
+            color: '#ffffff',
+            font: {
+                size: 20
+            },
+            backgroundColor: 'black',
+        },
+        size: {
+            height: 60,
+        }
+    },
+    componentGridTemplate: exports.COMPONENT_GRID_TEMPLATE,
+};

package/lib/util/document-property-util.d.ts

@@ -0,0 +1,7 @@
+import { DocumentPropertyDefinition } from "../interfaces";
+import { DocumentElement, PositionDefinition } from "@contrail/documents";
+import { PropertyValueFormatter } from "@contrail/types";
+export declare class DocumentPropertyUtil {
+    static generatePropertyTextElements(data: any, properties: Array<DocumentPropertyDefinition>, options: DocumentElement, startingPosition: PositionDefinition, isComponent?: boolean): Array<DocumentElement>;
+    static generatePropertyTextElement(model: any, property: DocumentPropertyDefinition, options: DocumentElement, formatter: PropertyValueFormatter, position: PositionDefinition, isComponent?: boolean): DocumentElement;
+}

package/lib/util/document-property-util.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentPropertyUtil = void 0;
+const util_1 = require("@contrail/util");
+const types_1 = require("@contrail/types");
+const document_text_element_util_1 = require("./document-text-element-util");
+class DocumentPropertyUtil {
+    static generatePropertyTextElements(data, properties, options, startingPosition, isComponent = false) {
+        var _a, _b;
+        let yPosition = startingPosition.y || 0;
+        const xPosition = startingPosition.x || 0;
+        const elements = [];
+        const formatter = new types_1.PropertyValueFormatter();
+        for (let property of properties) {
+            const fontSize = ((_b = (_a = property.style) === null || _a === void 0 ? void 0 : _a.font) === null || _b === void 0 ? void 0 : _b.size) || 12;
+            let height = fontSize + 12;
+            options.size = options.size || {};
+            options.size.height = height;
+            let element = DocumentPropertyUtil.generatePropertyTextElement(data, property, options, formatter, { x: xPosition, y: yPosition }, isComponent);
+            yPosition += height;
+            elements.push(element);
+        }
+        return elements;
+    }
+    static generatePropertyTextElement(model, property, options, formatter, position, isComponent = false) {
+        var _a;
+        const modelKey = `${util_1.StringUtil.convertToCamelCase(property.typeRootSlug)}.${property.propertyDefinition.slug}`;
+        const value = util_1.ObjectUtil.getByPath(model, modelKey);
+        let display = formatter.formatValueForProperty(value, property.propertyDefinition);
+        if (!isComponent && property.includeLabel) {
+            display = property.propertyDefinition.label + ': ' + display;
+        }
+        const mergedOptions = util_1.ObjectUtil.mergeDeep(util_1.ObjectUtil.cloneDeep(options), { style: property.style || {} });
+        mergedOptions.position = position;
+        const useInlineFormatting = isComponent === false;
+        let element = document_text_element_util_1.DocumentTextElementUtil.generateTextElement(display, mergedOptions, useInlineFormatting);
+        if (isComponent && property.includeLabel) {
+            element.label = (_a = property.propertyDefinition) === null || _a === void 0 ? void 0 : _a.label;
+        }
+        element.propertyBindings = { text: modelKey };
+        return element;
+    }
+}
+exports.DocumentPropertyUtil = DocumentPropertyUtil;

package/lib/util/document-text-element-util.d.ts

@@ -0,0 +1,6 @@
+import { DocumentElement, StyleDefinition } from "@contrail/documents";
+export declare class DocumentTextElementUtil {
+    static generateTextElement(textValue: any, options: any, applyInlineFormatting?: boolean): DocumentElement;
+    static applyInLineStyling(text: any, style: StyleDefinition): any;
+    static applyBold(text: any): void;
+}

package/lib/util/document-text-element-util.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentTextElementUtil = void 0;
+const documents_1 = require("@contrail/documents");
+const util_1 = require("@contrail/util");
+class DocumentTextElementUtil {
+    static generateTextElement(textValue, options, applyInlineFormatting = true) {
+        var _a;
+        const defaultStyle = {
+            font: {
+                size: 8,
+            },
+            color: 'rgba(0,0,0,.5)',
+        };
+        let style = util_1.ObjectUtil.mergeDeep(defaultStyle, options.style || {});
+        if ((_a = options === null || options === void 0 ? void 0 : options.style) === null || _a === void 0 ? void 0 : _a.text) {
+            style.text = options.style.text;
+        }
+        let position = options.position || { y: 0, x: 0 };
+        position.x = position.x || 0;
+        position.y = position.y || 0;
+        let size = options.size || { height: 25, width: 125 };
+        size.height = size.height || 25;
+        size.width = size.width || 125;
+        const defaultedOptions = util_1.ObjectUtil.mergeDeep(util_1.ObjectUtil.cloneDeep(options), { position, size, style });
+        let element = documents_1.DocumentElementFactory.createTextElement(textValue);
+        element = Object.assign(element, defaultedOptions);
+        if (applyInlineFormatting) {
+            element.text = this.applyInLineStyling(element.text, element.style);
+        }
+        return element;
+    }
+    static applyInLineStyling(text, style) {
+        var _a, _b;
+        let formattedText = text;
+        if ((style === null || style === void 0 ? void 0 : style.font.weight) === 'bold') {
+            formattedText = `<strong>${formattedText}</strong>`;
+        }
+        if (((_a = style === null || style === void 0 ? void 0 : style.text) === null || _a === void 0 ? void 0 : _a.decoration) === 'underline') {
+            formattedText = `<span style="text-decoration: underline;">${formattedText}</span>`;
+        }
+        if ((_b = style === null || style === void 0 ? void 0 : style.font) === null || _b === void 0 ? void 0 : _b.size) {
+            formattedText = `<span style="font-size: ${style.font.size}pt;">${formattedText}</span>`;
+        }
+        formattedText = `<p>${formattedText}</p>`;
+        return formattedText;
+    }
+    static applyBold(text) {
+        return;
+    }
+}
+exports.DocumentTextElementUtil = DocumentTextElementUtil;

package/lib/util/document-util.d.ts

@@ -0,0 +1,7 @@
+import { PositionDefinition } from "@contrail/documents";
+export declare class DocumentUtil {
+    static getRelativePosition(position1: PositionDefinition, position2: PositionDefinition): {
+        x: number;
+        y: number;
+    };
+}

package/lib/util/document-util.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentUtil = void 0;
+class DocumentUtil {
+    static getRelativePosition(position1, position2) {
+        const relativePosition = {
+            x: position2.x - position1.x,
+            y: position2.y - position1.y,
+        };
+        return relativePosition;
+    }
+}
+exports.DocumentUtil = DocumentUtil;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/document-generation",
-  "version": "1.0.15",
+  "version": "1.0.17",
   "description": "Utilities for automatic generation of documents.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",