@contrail/document-generation 2.1.17 → 2.1.18

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/showcase-frame-generator.d.ts

@@ -1,8 +0,0 @@
-import { DocumentGenerationOptions } from './interfaces';
-import { DocumentFrame } from './frames/frame';
-export declare class ShowcaseFrameGenerator {
-    constructor();
-    static generateFrames(options: DocumentGenerationOptions): Array<DocumentFrame>;
-    private static getFrameGroups;
-    private static getLeafGroupsFromGroups;
-}

package/lib/showcase-frame-generator.js

@@ -1,44 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ShowcaseFrameGenerator = void 0;
-const frame_1 = require("./frames/frame");
-const frame_generator_1 = require("./frames/frame-generator");
-class ShowcaseFrameGenerator {
-    constructor() { }
-    static generateFrames(options) {
-        const frames = [];
-        const structure = options.data.dataGroup;
-        const template = options.documentTemplateDefinition;
-        const frameTemplate = options.frameTemplate;
-        const groups = this.getFrameGroups(structure);
-        for (let group of groups) {
-            const showcaseFrame = frame_generator_1.FrameGenerator.generateFrameContentForGroup(new frame_1.ShowcaseFrame((group === null || group === void 0 ? void 0 : group.name) || ''), group, template, frameTemplate);
-            console.log('showcaseFrame: ', showcaseFrame);
-            frames.push(showcaseFrame);
-        }
-        return frames;
-    }
-    static getFrameGroups(groupStructure) {
-        return this.getLeafGroupsFromGroups(groupStructure.rootGroup.subGroups, groupStructure.depth, 0);
-    }
-    static getLeafGroupsFromGroups(groups, totalDepth, currentDepth, groupName = null) {
-        const currentGroupName = groupName;
-        const leafGroups = [];
-        for (let group of groups) {
-            if (currentDepth === 0) {
-                groupName = null;
-            }
-            if (currentDepth === totalDepth) {
-                group.name = !groupName ? group.name : groupName + ' / ' + group.name;
-                leafGroups.push(group);
-            }
-            else {
-                if (currentDepth < totalDepth - 1)
-                    groupName = !currentGroupName ? group.name : currentGroupName + ' / ' + group.name;
-                leafGroups.push(...this.getLeafGroupsFromGroups(group.subGroups, totalDepth, currentDepth + 1, groupName));
-            }
-        }
-        return leafGroups;
-    }
-}
-exports.ShowcaseFrameGenerator = ShowcaseFrameGenerator;

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;