@contrail/document-generation 2.1.20 → 2.1.22

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

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentPropertyUtil = void 0;
+const util_1 = require("@contrail/util");
+const documents_1 = require("@contrail/documents");
+const types_1 = require("@contrail/types");
+const document_text_element_util_1 = require("./document-text-element-util");
+const text_util_1 = require("./text-util");
+class DocumentPropertyUtil {
+    static generatePropertyElements(data, properties, options, startingPosition, imageDimension, isComponent = false) {
+        var _a, _b;
+        let yPosition = startingPosition.y || 0;
+        const xPosition = startingPosition.x || 0;
+        const elements = [];
+        const formatter = new types_1.PropertyValueFormatter();
+        let index = 0;
+        for (let property of properties) {
+            let element;
+            if (index === 0 && property.slug === 'annotation') {
+                yPosition = -15;
+            }
+            if (property.propertyDefinition) {
+                const fontSize = ((_b = (_a = property.style) === null || _a === void 0 ? void 0 : _a.font) === null || _b === void 0 ? void 0 : _b.size) || 12;
+                const PT_TO_PX = 1.3;
+                const LINE_HEIGHT = 1.4;
+                const PADDING = 1.6;
+                let height = fontSize * PT_TO_PX * LINE_HEIGHT * PADDING;
+                options.size = options.size || {};
+                options.size.height = height;
+                element = DocumentPropertyUtil.generatePropertyTextElement(data, property, options, formatter, { x: xPosition, y: yPosition }, isComponent);
+                yPosition += element.size.height - 10;
+            }
+            else if (property.slug === 'annotation') {
+                element = DocumentPropertyUtil.generatePropertyAnnotationElement(data, property, property.size, {
+                    x: xPosition,
+                    y: yPosition,
+                });
+                yPosition += element.size.height - 10;
+            }
+            else if (property.slug === 'thumbnail') {
+                const imageHeight = imageDimension.height || imageDimension.width || 125;
+                const imageWidth = imageDimension.width || 125;
+                element = DocumentPropertyUtil.generatePropertyImageElement(data, property, { width: imageWidth, height: imageHeight }, { x: xPosition, y: yPosition });
+                yPosition += imageHeight;
+            }
+            if (element)
+                elements.push(element);
+            index++;
+        }
+        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) {
+            const height = text_util_1.TextUtil.getHeightByTextWidth(display, property, options.size.width);
+            options.size.height = height;
+        }
+        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, !isComponent);
+        if (property.includeLabel) {
+            element.label = (_a = property.propertyDefinition) === null || _a === void 0 ? void 0 : _a.label;
+        }
+        element.propertyBindings = { text: modelKey };
+        return element;
+    }
+    static generatePropertyAnnotationElement(data, property, size, position) {
+        const element = {
+            type: 'annotation',
+            size: size,
+            propertyBindings: { annotation: 'annotation' },
+            position,
+        };
+        if (property.isHidden) {
+            element.isHidden = property.isHidden;
+        }
+        return element;
+    }
+    static generatePropertyImageElement(data, property, imageDimension, position) {
+        var _a;
+        const imageUrl = (_a = data === null || data === void 0 ? void 0 : data.viewable) === null || _a === void 0 ? void 0 : _a.mediumViewableDownloadUrl;
+        const element = {
+            type: 'image',
+            size: imageDimension,
+            propertyBindings: { url: 'viewable.mediumViewableDownloadUrl' },
+            url: imageUrl,
+            position,
+        };
+        if (property.isHidden) {
+            element.isHidden = property.isHidden;
+        }
+        documents_1.DocumentElementPropertyBindingHandler.bindPropertiesToElement(element, data);
+        return element;
+    }
+}
+exports.DocumentPropertyUtil = DocumentPropertyUtil;

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

@@ -0,0 +1,12 @@
+import { DocumentElement, StyleDefinition } from '@contrail/documents';
+export declare class DocumentTextElementUtil {
+    static generateTextElement(textValue: any, options: any, applyInlineFormatting?: boolean, sanitizeHTML?: boolean): DocumentElement;
+    static applyInLineStyling(text: any, style: StyleDefinition): any;
+    static extractStyleFromInline(text: string): StyleDefinition;
+    static extractFontSizeFromHTML(text: any): number;
+    static extractColorFromHTML(text: any): string;
+    static extractTextDecorationFromHTML(text: any): string;
+    static extractFontFromHTML(text: any): any;
+    static extractTextStyleItalicFromHTML(text: any): string;
+    static extractTextStyleStrikethroughFromHTML(text: any): string;
+}

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

@@ -0,0 +1,148 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentTextElementUtil = void 0;
+const documents_1 = require("@contrail/documents");
+const util_1 = require("@contrail/util");
+const document_util_1 = require("./document-util");
+class DocumentTextElementUtil {
+    static generateTextElement(textValue, options, applyInlineFormatting = true, sanitizeHTML = 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 textVal = sanitizeHTML ? document_util_1.DocumentUtil.sanitizeHTML(textValue) : textValue;
+        if (textVal === undefined || textVal === null) {
+            textVal = '';
+        }
+        let element = documents_1.DocumentElementFactory.createTextElement(textVal);
+        element = Object.assign(element, defaultedOptions);
+        if (applyInlineFormatting) {
+            element.text = this.applyInLineStyling(element.text, element.style);
+        }
+        return element;
+    }
+    static applyInLineStyling(text, style) {
+        var _a, _b, _c, _d, _e;
+        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>`;
+        }
+        let fontStyles = '';
+        if ((_b = style === null || style === void 0 ? void 0 : style.font) === null || _b === void 0 ? void 0 : _b.size) {
+            fontStyles += `font-size: ${style.font.size}pt; `;
+        }
+        if (style === null || style === void 0 ? void 0 : style.color) {
+            fontStyles += `color: ${style.color}; `;
+        }
+        if ((_c = style === null || style === void 0 ? void 0 : style.font) === null || _c === void 0 ? void 0 : _c.family) {
+            fontStyles += `font-family: '${style.font.family}'; `;
+        }
+        if (fontStyles.length) {
+            formattedText = `<span style="${fontStyles}">${formattedText}</span>`;
+        }
+        if ((_d = style === null || style === void 0 ? void 0 : style.font) === null || _d === void 0 ? void 0 : _d.strikethrough) {
+            formattedText = `<s>${formattedText}</s>`;
+        }
+        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>`;
+        return formattedText;
+    }
+    static extractStyleFromInline(text) {
+        if (!text) {
+            return null;
+        }
+        const style = { font: {}, text: {} };
+        if (text.indexOf('<strong>') > -1 || text.indexOf('bold') > -1) {
+            style.font.weight = 'bold';
+        }
+        const fontSize = this.extractFontSizeFromHTML(text);
+        if (fontSize) {
+            style.font.size = fontSize;
+        }
+        const color = this.extractColorFromHTML(text);
+        if (color) {
+            style.color = color;
+        }
+        const decoration = this.extractTextDecorationFromHTML(text);
+        if (decoration) {
+            style.text.decoration = decoration;
+        }
+        const italic = this.extractTextStyleItalicFromHTML(text);
+        if (italic) {
+            style.font.italic = true;
+        }
+        const strikethrough = this.extractTextStyleStrikethroughFromHTML(text);
+        if (strikethrough) {
+            style.font.strikethrough = true;
+        }
+        const font = this.extractFontFromHTML(text);
+        if (font) {
+            style.font.family = font;
+        }
+        return style;
+    }
+    static extractFontSizeFromHTML(text) {
+        let regex = /font-size: (.*?)pt;/;
+        let match = text.match(regex);
+        if ((match === null || match === void 0 ? void 0 : match.length) && !isNaN(parseInt(match[1]))) {
+            return parseInt(match[1]);
+        }
+    }
+    static extractColorFromHTML(text) {
+        let regex = /color: (.*?);/;
+        let match = text.match(regex);
+        if (match === null || match === void 0 ? void 0 : match.length) {
+            let color = match[1];
+            color = color.replace(/['"]+/g, '');
+            return color;
+        }
+    }
+    static extractTextDecorationFromHTML(text) {
+        let regex = /text-decoration: (.*?);/;
+        let match = text.match(regex);
+        if (match === null || match === void 0 ? void 0 : match.length) {
+            let decoration = match[1];
+            decoration = decoration.replace(/['"]+/g, '');
+            return decoration;
+        }
+    }
+    static extractFontFromHTML(text) {
+        let regex = /font-family: (.*?);/;
+        let match = text.match(regex);
+        if (match === null || match === void 0 ? void 0 : match.length) {
+            let font = match[1];
+            font = font.replace(/['"]+/g, '');
+            return font;
+        }
+    }
+    static extractTextStyleItalicFromHTML(text) {
+        if (text.indexOf('<em>') > -1 || text.indexOf('<i>') > -1) {
+            return 'italic';
+        }
+    }
+    static extractTextStyleStrikethroughFromHTML(text) {
+        if (text.indexOf('<s>') > -1 || text.indexOf('<strike>') > -1) {
+            return 'strikethrough';
+        }
+    }
+}
+exports.DocumentTextElementUtil = DocumentTextElementUtil;

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

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

package/lib/util/document-util.js

@@ -0,0 +1,22 @@
+"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;
+    }
+    static sanitizeHTML(text) {
+        if (text === undefined || text === null) {
+            return '';
+        }
+        if (typeof text !== 'string') {
+            return text;
+        }
+        return text.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
+    }
+}
+exports.DocumentUtil = DocumentUtil;

package/lib/util/index.d.ts

@@ -0,0 +1,2 @@
+export * from './document-text-element-util';
+export * from './document-property-util';

package/lib/util/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./document-text-element-util"), exports);
+__exportStar(require("./document-property-util"), exports);

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

@@ -0,0 +1,4 @@
+import { DocumentPropertyDefinition } from '../interfaces';
+export declare class TextUtil {
+    static getHeightByTextWidth(text: string, property: DocumentPropertyDefinition, width: number): number;
+}

package/lib/util/text-util.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextUtil = void 0;
+class TextUtil {
+    static getHeightByTextWidth(text, property, width) {
+        var _a, _b, _c, _d, _e;
+        let height = 0;
+        let div = document.createElement('DIV');
+        div.id = '__textMeasure';
+        div.innerHTML = (property.includeLabel ? ((_a = property.propertyDefinition) === null || _a === void 0 ? void 0 : _a.label) + ': ' : '') + text;
+        div.style.position = 'absolute';
+        div.style.top = '-500px';
+        div.style.left = '0';
+        div.style.width = width + 'px';
+        div.style.lineHeight = 'normal';
+        div.style.overflowWrap = 'break-word';
+        div.style.fontFamily = ((_c = (_b = property.style) === null || _b === void 0 ? void 0 : _b.font) === null || _c === void 0 ? void 0 : _c.family) || 'Roboto';
+        div.style.fontWeight = property.style.font.weight ? 'bold' : 'normal';
+        div.style.fontSize = (((_e = (_d = property.style) === null || _d === void 0 ? void 0 : _d.font) === null || _e === void 0 ? void 0 : _e.size) || 12) + 'pt';
+        div.style.padding = '11px';
+        document.body.appendChild(div);
+        height = div.offsetHeight;
+        document.body.removeChild(div);
+        div = null;
+        return height;
+    }
+}
+exports.TextUtil = TextUtil;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/document-generation",
-  "version": "2.1.20",
+  "version": "2.1.22",
   "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,
-            },
-        ],
-    },
-};