@contrail/document-generation 2.0.38 → 2.0.40

package/lib/test-data.d.ts

@@ -1,72 +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;
+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 +1,187 @@
-"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.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,
-};
+"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.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,
+};

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

@@ -0,0 +1,9 @@
+import { DataGroup } from '@contrail/data-grouping';
+import { DocumentElement } from '@contrail/documents';
+export declare class DocumentDynamicTextElementUtil {
+    static typeMap: any;
+    static isDynamicText(element: any): any;
+    static handleDynamicText(element: DocumentElement, dataGroup: DataGroup): any;
+    private static getPropertyValuesForElements;
+    private static getTextValueFromFrameMembers;
+}

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

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentDynamicTextElementUtil = void 0;
+const types_1 = require("@contrail/types");
+const util_1 = require("@contrail/util");
+const document_text_element_util_1 = require("./document-text-element-util");
+const HARD_CODED_PROPS = {
+    createdBy: 'Created by',
+    updatedBy: 'Updated by',
+    count: 'Count',
+};
+class DocumentDynamicTextElementUtil {
+    static isDynamicText(element) {
+        return element.type === 'text' && element.propertyBindings && element.propertyBindingsMetaData;
+    }
+    static handleDynamicText(element, dataGroup) {
+        var _a;
+        const displayFunction = element.propertyBindingsMetaData.displayFunction;
+        const displayLabel = element.propertyBindingsMetaData.displayLabel;
+        const propertyBindingsText = element.propertyBindings.text;
+        let text;
+        const entityType = propertyBindingsText.split('.')[0];
+        const propertySlug = propertyBindingsText.split('.')[1];
+        let property;
+        let type;
+        if (!['showcase', 'board', 'project'].includes(entityType)) {
+            if (entityType === 'frame') {
+                if (propertySlug === 'count') {
+                    text = dataGroup.data.length;
+                }
+                else {
+                    text = dataGroup.name;
+                }
+            }
+            else {
+                if (dataGroup.data.length === 0) {
+                    return propertyBindingsText;
+                }
+                type = this.typeMap[entityType];
+                property = type.typeProperties.find(p => p.slug === propertySlug);
+                if (displayFunction === "label") {
+                    text = (property === null || property === void 0 ? void 0 : property.label) || HARD_CODED_PROPS[propertySlug] || `${type.label} name`;
+                }
+                else {
+                    let elementValues = this.getPropertyValuesForElements(dataGroup.data, propertyBindingsText);
+                    text = this.getTextValueFromFrameMembers(displayFunction, elementValues, property);
+                }
+            }
+            if (text === undefined || text === null) {
+                text = 'n/a';
+            }
+            if (displayLabel && displayFunction !== "label") {
+                text = `${(property === null || property === void 0 ? void 0 : property.label) || `${type === null || type === void 0 ? void 0 : type.label} name` || HARD_CODED_PROPS[propertySlug]}: ${text}`;
+            }
+        }
+        if (((_a = element.text) === null || _a === void 0 ? void 0 : _a.toString().indexOf('</')) > -1) {
+            const styleDefinition = document_text_element_util_1.DocumentTextElementUtil.extractStyleFromInline(element.text);
+            text = document_text_element_util_1.DocumentTextElementUtil.applyInLineStyling(text, styleDefinition);
+        }
+        element.text = text;
+    }
+    static getPropertyValuesForElements(elements, propertyKey) {
+        const values = [];
+        elements.forEach(el => {
+            const propertyValue = util_1.ObjectUtil.getByPath(el, propertyKey);
+            values.push(propertyValue);
+        });
+        return values;
+    }
+    static getTextValueFromFrameMembers(displayFunction, elementValues, property) {
+        let text;
+        const formatter = new types_1.PropertyValueFormatter();
+        if (displayFunction === "average") {
+            elementValues = elementValues.filter(e => e !== null);
+            text = formatter.formatValue(elementValues.reduce((a, b) => a + b, 0) / elementValues.length, property.propertyType);
+        }
+        else if (displayFunction === "sum") {
+            elementValues = elementValues.filter(e => e !== null);
+            text = formatter.formatValue(elementValues.reduce((a, b) => a + b, 0), property.propertyType);
+        }
+        else if (displayFunction === "uniqueArray") {
+            text = Array.from(new Set(elementValues.filter(e => e !== null))).join(', ');
+        }
+        else if (!displayFunction ||
+            ["first", "value"].includes(displayFunction)) {
+            text = elementValues[0];
+        }
+        else if (displayFunction === "last") {
+            text = elementValues[elementValues.length - 1];
+        }
+        else if (displayFunction === "min") {
+            elementValues = elementValues.filter(e => e !== null);
+            text = formatter.formatValue(Math.min(...elementValues), property.propertyType);
+        }
+        else if (displayFunction === "max") {
+            elementValues = elementValues.filter(e => e !== null);
+            text = formatter.formatValue(Math.max(...elementValues), property.propertyType);
+        }
+        return text;
+    }
+}
+exports.DocumentDynamicTextElementUtil = DocumentDynamicTextElementUtil;

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

@@ -1,9 +1,9 @@
-import { DocumentPropertyDefinition } from '../interfaces';
-import { DocumentElement, PositionDefinition, SizeDefinition } from '@contrail/documents';
-import { PropertyValueFormatter } from '@contrail/types';
-export declare class DocumentPropertyUtil {
-    static generatePropertyElements(data: any, properties: Array<DocumentPropertyDefinition>, options: DocumentElement, startingPosition: PositionDefinition, imageDimension: SizeDefinition, isComponent?: boolean): Array<DocumentElement>;
-    static generatePropertyTextElement(model: any, property: DocumentPropertyDefinition, options: DocumentElement, formatter: PropertyValueFormatter, position: PositionDefinition, isComponent?: boolean): DocumentElement;
-    static generatePropertyAnnotationElement(data: any, property: DocumentPropertyDefinition, size: SizeDefinition, position: PositionDefinition): DocumentElement;
-    static generatePropertyImageElement(data: any, property: DocumentPropertyDefinition, imageDimension: SizeDefinition, position: PositionDefinition): DocumentElement;
-}
+import { DocumentPropertyDefinition } from '../interfaces';
+import { DocumentElement, PositionDefinition, SizeDefinition } from '@contrail/documents';
+import { PropertyValueFormatter } from '@contrail/types';
+export declare class DocumentPropertyUtil {
+    static generatePropertyElements(data: any, properties: Array<DocumentPropertyDefinition>, options: DocumentElement, startingPosition: PositionDefinition, imageDimension: SizeDefinition, isComponent?: boolean): Array<DocumentElement>;
+    static generatePropertyTextElement(model: any, property: DocumentPropertyDefinition, options: DocumentElement, formatter: PropertyValueFormatter, position: PositionDefinition, isComponent?: boolean): DocumentElement;
+    static generatePropertyAnnotationElement(data: any, property: DocumentPropertyDefinition, size: SizeDefinition, position: PositionDefinition): DocumentElement;
+    static generatePropertyImageElement(data: any, property: DocumentPropertyDefinition, imageDimension: SizeDefinition, position: PositionDefinition): DocumentElement;
+}