@contrail/document-generation 2.1.21 → 2.1.23

package/lib/frames/frame-generator.js

@@ -132,7 +132,7 @@ class FrameGenerator {
                 documentElement.text = documentElement.text.replace('{{dataGroup.name}}', dataGroup.name);
             }
             if (document_dynamic_text_element_util_1.DocumentDynamicTextElementUtil.isDynamicText(documentElement)) {
-                document_dynamic_text_element_util_1.DocumentDynamicTextElementUtil.handleDynamicText(documentElement, dataGroup, frameTitle);
+                document_dynamic_text_element_util_1.DocumentDynamicTextElementUtil.handleDynamicText(documentElement, dataGroup, frameTitle, element);
             }
             if (documentElement.elementIds) {
                 documentElement.elementIds = [elementMapping[documentElement.elementIds[0]]];

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

@@ -4,6 +4,6 @@ export declare class DocumentDynamicTextElementUtil {
     static typeMap: any;
     static propertyMapByType: any;
     static isDynamicText(element: any): any;
-    static handleDynamicText(element: DocumentElement, dataGroup: DataGroup, frameTitle?: any): void;
+    static handleDynamicText(element: DocumentElement, dataGroup: DataGroup, frameTitle: any, templateElement: DocumentElement): void;
     static setTypeMap(typeMap: any): void;
 }

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

@@ -8,7 +8,7 @@ class DocumentDynamicTextElementUtil {
     static isDynamicText(element) {
         return element.type === 'text' && element.propertyBindings && element.propertyBindingsMetaData;
     }
-    static handleDynamicText(element, dataGroup, frameTitle = null) {
+    static handleDynamicText(element, dataGroup, frameTitle = null, templateElement) {
         var _a, _b, _c;
         const propertyBindingsText = element.propertyBindings.text;
         let propertyLevel = (_a = element.propertyBindingsMetaData) === null || _a === void 0 ? void 0 : _a.propertyLevel;
@@ -41,8 +41,8 @@ class DocumentDynamicTextElementUtil {
             }
         }
         let text = documents_1.DynamicTextUtil.getDynamicTextValue(element, property, propertyLevel, frame, componentModels);
-        if (((_c = element.text) === null || _c === void 0 ? void 0 : _c.toString().indexOf('</')) > -1) {
-            const styleDefinition = document_text_element_util_1.DocumentTextElementUtil.extractStyleFromInline(element.text);
+        if (((_c = templateElement.text) === null || _c === void 0 ? void 0 : _c.toString().indexOf('</')) > -1) {
+            const styleDefinition = document_text_element_util_1.DocumentTextElementUtil.extractStyleFromInline(templateElement.text);
             text = document_text_element_util_1.DocumentTextElementUtil.applyInLineStyling(text, styleDefinition);
         }
         element.text = text;

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

@@ -9,4 +9,5 @@ export declare class DocumentTextElementUtil {
     static extractFontFromHTML(text: any): any;
     static extractTextStyleItalicFromHTML(text: any): string;
     static extractTextStyleStrikethroughFromHTML(text: any): string;
+    static extractTextAlignFromHTML(text: any): string;
 }

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

@@ -36,7 +36,7 @@ class DocumentTextElementUtil {
         return element;
     }
     static applyInLineStyling(text, style) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f;
         let formattedText = text;
         if ((style === null || style === void 0 ? void 0 : style.font.weight) === 'bold') {
             formattedText = `<strong>${formattedText}</strong>`;
@@ -63,7 +63,12 @@ class DocumentTextElementUtil {
         if ((_e = style === null || style === void 0 ? void 0 : style.font) === null || _e === void 0 ? void 0 : _e.italic) {
             formattedText = `<em>${formattedText}</em>`;
         }
-        formattedText = `<p>${formattedText}</p>`;
+        if ((_f = style === null || style === void 0 ? void 0 : style.text) === null || _f === void 0 ? void 0 : _f.align) {
+            formattedText = `<p style="text-align: ${style.text.align};">${formattedText}</p>`;
+        }
+        else {
+            formattedText = `<p>${formattedText}</p>`;
+        }
         return formattedText;
     }
     static extractStyleFromInline(text) {
@@ -98,6 +103,10 @@ class DocumentTextElementUtil {
         if (font) {
             style.font.family = font;
         }
+        const textAlign = this.extractTextAlignFromHTML(text);
+        if (textAlign && ['left', 'right', 'center'].includes(textAlign)) {
+            style.text.align = textAlign;
+        }
         return style;
     }
     static extractFontSizeFromHTML(text) {
@@ -144,5 +153,14 @@ class DocumentTextElementUtil {
             return 'strikethrough';
         }
     }
+    static extractTextAlignFromHTML(text) {
+        let regex = /text-align:\s*(.*?);/;
+        let match = text.match(regex);
+        if (match === null || match === void 0 ? void 0 : match.length) {
+            let textAlign = match[1];
+            textAlign = textAlign.replace(/['"]+/g, '');
+            return textAlign;
+        }
+    }
 }
 exports.DocumentTextElementUtil = DocumentTextElementUtil;

package/package.json

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

package/lib/mocks/test-type-data.d.ts

@@ -1,142 +0,0 @@
-export declare const typeMap: {
-    item: {
-        pk: number;
-        id: string;
-        createdOn: string;
-        updatedOn: string;
-        createdById: string;
-        updatedById: string;
-        isArchived: boolean;
-        orgId: string;
-        slug: string;
-        label: string;
-        typePath: string;
-        typeRootId: string;
-        parentId: any;
-        typePolicyIds: any[];
-        typePolicies: any[];
-        typeProperties: {
-            pk: number;
-            id: string;
-            createdOn: string;
-            updatedOn: string;
-            createdById: string;
-            updatedById: string;
-            isArchived: boolean;
-            orgId: string;
-            propertyType: string;
-            slug: string;
-            label: string;
-            editable: boolean;
-            core: boolean;
-            typePropertyOptionSetId: any;
-            typePropertyUserListId: any;
-            carryOverBehavior: any;
-            carryOverDefault: any;
-            copyBehavior: any;
-            copyDefault: any;
-            formula: any;
-            numberFormat: {
-                format: any;
-                currency: string;
-            };
-            referencedTypeRootSlug: any;
-            referencedTypeRole: any;
-            referencedTypeFilterProperties: any;
-            referencedTypeId: any;
-            referencedTypePath: any;
-            defaultValue: any;
-            propertyLevel: string;
-            formulaFunction: any;
-            validationFunction: string;
-            description: any;
-            apiDetails: any;
-            notes: any;
-            searchable: boolean;
-            isFederationProperty: boolean;
-            isUniqueProperty: boolean;
-            isUniquePropertyInFamily: boolean;
-            required: boolean;
-            sequenceSeedValue: any;
-            optionsSet: any;
-            inherited: boolean;
-            used: boolean;
-            overriddenPropertySlugs: any[];
-            typePropertyPolicyIds: any[];
-            canRead: boolean;
-            canUpdate: boolean;
-            canDelete: boolean;
-            canCreate: boolean;
-        }[];
-    };
-    projectItem: {
-        pk: number;
-        id: string;
-        createdOn: string;
-        updatedOn: string;
-        createdById: string;
-        updatedById: string;
-        isArchived: boolean;
-        orgId: string;
-        slug: string;
-        label: string;
-        typePath: string;
-        typeRootId: string;
-        parentId: any;
-        typePolicyIds: any[];
-        typePolicies: any[];
-        typeProperties: {
-            id: string;
-            createdOn: string;
-            updatedOn: string;
-            createdById: string;
-            updatedById: string;
-            isArchived: boolean;
-            orgId: string;
-            propertyType: string;
-            slug: string;
-            label: string;
-            editable: boolean;
-            core: boolean;
-            typePropertyOptionSetId: any;
-            typePropertyUserListId: any;
-            carryOverBehavior: any;
-            carryOverDefault: any;
-            copyBehavior: any;
-            copyDefault: any;
-            formula: any;
-            numberFormat: {
-                format: string;
-                currency: string;
-                precision: number;
-            };
-            referencedTypeRootSlug: any;
-            referencedTypeRole: any;
-            referencedTypeFilterProperties: any;
-            referencedTypeId: any;
-            referencedTypePath: any;
-            defaultValue: any;
-            propertyLevel: string;
-            formulaFunction: any;
-            validationFunction: string;
-            description: any;
-            apiDetails: any;
-            notes: any;
-            searchable: boolean;
-            isFederationProperty: boolean;
-            isUniqueProperty: boolean;
-            isUniquePropertyInFamily: boolean;
-            required: boolean;
-            sequenceSeedValue: any;
-            optionsSet: any;
-            inherited: boolean;
-            used: boolean;
-            overriddenPropertySlugs: any[];
-            typePropertyPolicyIds: string[];
-            canRead: boolean;
-            canUpdate: boolean;
-            canDelete: boolean;
-            canCreate: boolean;
-        }[];
-    };
-};

package/lib/mocks/test-type-data.js

@@ -1,149 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.typeMap = void 0;
-exports.typeMap = {
-    item: {
-        pk: 731,
-        id: 'ivE7yP0zkKHIkfU-',
-        createdOn: '2021-07-09T14:01:49.217Z',
-        updatedOn: '2021-07-09T14:01:49.217Z',
-        createdById: 'G5YQopiRBlfmnDn3',
-        updatedById: 'G5YQopiRBlfmnDn3',
-        isArchived: false,
-        orgId: 'Z5KDga-mUfxIXk21',
-        slug: 'item',
-        label: 'Item',
-        typePath: 'item',
-        typeRootId: '3735b33f-52c4-4ff5-a52c-95c0f97f16c3',
-        parentId: null,
-        typePolicyIds: [],
-        typePolicies: [],
-        typeProperties: [
-            {
-                pk: 2370,
-                id: '4hL2d44GPxAzmr1S',
-                createdOn: '2022-05-26T18:30:35.057Z',
-                updatedOn: '2023-05-05T21:17:06.810Z',
-                createdById: 'G5YQopiRBlfmnDn3',
-                updatedById: 'G5YQopiRBlfmnDn3',
-                isArchived: false,
-                orgId: 'Z5KDga-mUfxIXk21',
-                propertyType: 'string',
-                slug: 'overridableProp',
-                label: 'Overridable Prop',
-                editable: true,
-                core: false,
-                typePropertyOptionSetId: null,
-                typePropertyUserListId: null,
-                carryOverBehavior: null,
-                carryOverDefault: null,
-                copyBehavior: null,
-                copyDefault: null,
-                formula: null,
-                numberFormat: {
-                    format: null,
-                    currency: 'USD',
-                },
-                referencedTypeRootSlug: null,
-                referencedTypeRole: null,
-                referencedTypeFilterProperties: null,
-                referencedTypeId: null,
-                referencedTypePath: null,
-                defaultValue: null,
-                propertyLevel: 'overridable',
-                formulaFunction: null,
-                validationFunction: '',
-                description: null,
-                apiDetails: null,
-                notes: null,
-                searchable: false,
-                isFederationProperty: false,
-                isUniqueProperty: false,
-                isUniquePropertyInFamily: false,
-                required: false,
-                sequenceSeedValue: null,
-                optionsSet: null,
-                inherited: false,
-                used: true,
-                overriddenPropertySlugs: [],
-                typePropertyPolicyIds: [],
-                canRead: true,
-                canUpdate: true,
-                canDelete: true,
-                canCreate: true,
-            },
-        ],
-    },
-    projectItem: {
-        pk: 1291,
-        id: 'ina_V3kyFcasfKXE',
-        createdOn: '2022-07-08T18:48:05.530Z',
-        updatedOn: '2022-07-08T18:48:05.530Z',
-        createdById: 'G5YQopiRBlfmnDn3',
-        updatedById: 'G5YQopiRBlfmnDn3',
-        isArchived: false,
-        orgId: 'Z5KDga-mUfxIXk21',
-        slug: 'project-item',
-        label: 'ProjectItem',
-        typePath: 'project-item',
-        typeRootId: 'AX-F0PADgcRGENr3',
-        parentId: null,
-        typePolicyIds: [],
-        typePolicies: [],
-        typeProperties: [
-            {
-                id: 'mkO5HfQAELNJ__Yt',
-                createdOn: '2022-07-16T15:49:03.102Z',
-                updatedOn: '2025-07-28T04:09:25.706Z',
-                createdById: 'G5YQopiRBlfmnDn3',
-                updatedById: 'G5YQopiRBlfmnDn3',
-                isArchived: false,
-                orgId: 'Z5KDga-mUfxIXk21',
-                propertyType: 'currency',
-                slug: 'outletPrice',
-                label: 'Outlet Price',
-                editable: true,
-                core: false,
-                typePropertyOptionSetId: null,
-                typePropertyUserListId: null,
-                carryOverBehavior: null,
-                carryOverDefault: null,
-                copyBehavior: null,
-                copyDefault: null,
-                formula: null,
-                numberFormat: {
-                    format: 'currency',
-                    currency: 'USD',
-                    precision: 2,
-                },
-                referencedTypeRootSlug: null,
-                referencedTypeRole: null,
-                referencedTypeFilterProperties: null,
-                referencedTypeId: null,
-                referencedTypePath: null,
-                defaultValue: null,
-                propertyLevel: 'option',
-                formulaFunction: null,
-                validationFunction: '',
-                description: null,
-                apiDetails: null,
-                notes: null,
-                searchable: false,
-                isFederationProperty: false,
-                isUniqueProperty: false,
-                isUniquePropertyInFamily: false,
-                required: false,
-                sequenceSeedValue: null,
-                optionsSet: null,
-                inherited: false,
-                used: true,
-                overriddenPropertySlugs: [],
-                typePropertyPolicyIds: ['daLwIOoOfKEaAm9F'],
-                canRead: true,
-                canUpdate: true,
-                canDelete: false,
-                canCreate: false,
-            },
-        ],
-    },
-};

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

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

package/lib/scripts/test-board.js

@@ -1,230 +0,0 @@
-"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

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

package/lib/scripts/test-showcase.js

@@ -1,257 +0,0 @@
-"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 interfaces_1 = require("../interfaces");
-const sdk_1 = require("@contrail/sdk");
-const fs = require('fs');
-const data_grouping_1 = require("@contrail/data-grouping");
-const showcase_frame_generator_1 = require("../showcase-frame-generator");
-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',
-                },
-                {
-                    propertyDefinition: projectItemType.typeProperties.find((p) => p.slug === 'colorwayStatus'),
-                    slug: 'colorwayStatus',
-                    typeRootSlug: 'project-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',
-                    },
-                },
-                {
-                    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.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 frames = showcase_frame_generator_1.ShowcaseFrameGenerator.generateFrames(params);
-    });
-}
-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;
-}
-run();

package/lib/test-data.d.ts

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

@@ -1,187 +0,0 @@
-"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.dev.vibeiq.com/dev/api/files/downloadUrl/-VMrLJrt3clDKPi0%2Fcontent:m3Bd4u-QLci1XiOl%2F2b72d48a-6b19-4ba8-9d54-813745fb8dd4.png',
-    },
-    projectItem: {
-        id: 'projectItem-1001',
-        retailPrice: 45.0,
-    },
-    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: [
-        {
-            propertyDefinition: {
-                slug: 'gender',
-                propertyType: types_1.PropertyType.SingleSelect,
-                label: 'Gender',
-            },
-            sort: sdk_1.SortOrderOptions.ASC,
-            typeRootSlug: '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: [
-        {
-            propertyDefinition: {
-                slug: 'gender',
-                propertyType: types_1.PropertyType.SingleSelect,
-                label: 'Gender',
-            },
-            sort: sdk_1.SortOrderOptions.ASC,
-            typeRootSlug: '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,
-};