@contrail/document-generation 2.1.36 → 2.1.38-alpha-logger-1

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to `@contrail/document-generation` are documented here.
+
+Format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Changed
+
+- Replaced `console.log/warn/error` calls with structured logger from `@contrail/telemetry`. No API changes. On the backend, logs are now captured by the OTel pipeline. In the browser, behavior is unchanged (Pino delegates to native console).
+
+## [2.1.37] - (initial changelog entry)
+
+- Initial changelog. Prior releases did not include a changelog.
+  See git history for changes predating this entry.

package/lib/board-document-generator.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BoardDocumentGenerator = void 0;
+const telemetry_1 = require("@contrail/telemetry");
 const documents_1 = require("@contrail/documents");
 const interfaces_1 = require("./interfaces");
 const util_1 = require("@contrail/util");
@@ -20,7 +21,7 @@ class BoardDocumentGenerator {
         if (frameTemplate) {
             template.frameSize = frameTemplate.document.size;
         }
-        console.log('generateDocumentElements: ', structure.depth, structure.groupingProperties.length);
+        telemetry_1.logger.debug(`generateDocumentElements: ${structure.depth} ${structure.groupingProperties.length}`);
         let position = options.startingCoordinates || { x: 0, y: 0 };
         const group = structure.rootGroup;
         const deepestSubgroups = [];

package/lib/components/component-grid-generator.js

@@ -1,24 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ComponentGridGenerator = void 0;
+const telemetry_1 = require("@contrail/telemetry");
 const util_1 = require("@contrail/util");
 const component_generator_1 = require("./component-generator");
 const component_util_1 = require("./component-util");
 class ComponentGridGenerator {
     static generateComponentGrid(data, startingPosition = { x: 0, y: 0 }, template, idealSize) {
         if (!data) {
-            console.warn('WARN: data null in generateComponentGrid');
+            telemetry_1.logger.warn('WARN: data null in generateComponentGrid');
             return [];
         }
         if (data.length === 0) {
             return [];
         }
         if (!template) {
-            console.warn('WARN: template null in generateComponentGrid');
+            telemetry_1.logger.warn('WARN: template null in generateComponentGrid');
             return [];
         }
         if (!template.componentTemplate) {
-            console.warn('WARN: component template is null in generateComponentGrid');
+            telemetry_1.logger.warn('WARN: component template is null in generateComponentGrid');
             return [];
         }
         const elements = [];

package/lib/frames/frame-generator.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FrameGenerator = void 0;
+const telemetry_1 = require("@contrail/telemetry");
 const documents_1 = require("@contrail/documents");
 const component_grid_generator_1 = require("../components/component-grid-generator");
 const util_1 = require("@contrail/util");
@@ -146,7 +147,7 @@ class FrameGenerator {
                 }
                 catch (e) { }
                 if (oldChildElements.length !== newChildElements.length || oldChildElements.length === 0) {
-                    console.log(`Invalid table element to copy`, documentElement, oldChildElements, newChildElements);
+                    telemetry_1.logger.debug(`Invalid table element to copy ${documentElement} ${oldChildElements} ${newChildElements}`);
                     continue;
                 }
                 documentElement = newTableElement;

package/lib/interfaces.js

@@ -5,4 +5,4 @@ var Orientation;
 (function (Orientation) {
     Orientation["HORIZONTAL"] = "horizontal";
     Orientation["VERTICAL"] = "vertical";
-})(Orientation = exports.Orientation || (exports.Orientation = {}));
+})(Orientation || (exports.Orientation = Orientation = {}));

package/lib/showcase-frame-generator.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShowcaseFrameGenerator = void 0;
+const telemetry_1 = require("@contrail/telemetry");
 const frame_1 = require("./frames/frame");
 const frame_generator_1 = require("./frames/frame-generator");
 class ShowcaseFrameGenerator {
@@ -13,7 +14,7 @@ class ShowcaseFrameGenerator {
         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);
+            telemetry_1.logger.debug(`showcaseFrame: ${showcaseFrame}`);
             frames.push(showcaseFrame);
         }
         return frames;

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

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

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

@@ -163,5 +163,18 @@ class DocumentTextElementUtil {
             return textAlign;
         }
     }
+    static extractPlainText(html) {
+        if (!html)
+            return '';
+        return html
+            .replace(/<[^>]*>/g, '')
+            .replace(/&amp;/g, '&')
+            .replace(/&lt;/g, '<')
+            .replace(/&gt;/g, '>')
+            .replace(/&quot;/g, '"')
+            .replace(/&#39;/g, "'")
+            .replace(/&nbsp;/g, ' ')
+            .trim();
+    }
 }
 exports.DocumentTextElementUtil = DocumentTextElementUtil;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/document-generation",
-  "version": "2.1.36",
+  "version": "2.1.38-alpha-logger-1",
   "description": "Utilities for automatic generation of documents.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -26,7 +26,7 @@
     "ts-jest": "^29.1.1",
     "tslint": "^5.11.0",
     "tslint-config-prettier": "^1.18.0",
-    "typescript": "^4.0.0"
+    "typescript": "^5.0.0"
   },
   "jest": {
     "moduleFileExtensions": [
@@ -46,7 +46,8 @@
     "@contrail/data-grouping": "^1.0.50",
     "@contrail/document-table": "^1.0.5",
     "@contrail/documents": "^1.3.3",
+    "@contrail/telemetry": "^1.1.0-alpha-frontend-logging-2",
     "@contrail/types": "^3.1.3",
-    "@contrail/util": "^1.1.19"
+    "@contrail/util": "^1.2.1-alpha-otel-logs-12"
   }
 }