@contrail/document-generation 2.1.37 → 2.2.0-alpha-otel-logs-1

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# 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]
+
+## [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

@@ -7,6 +7,7 @@ const util_1 = require("@contrail/util");
 const frame_generator_1 = require("./frames/frame-generator");
 const document_util_1 = require("./util/document-util");
 const document_dynamic_text_element_util_1 = require("./util/document-dynamic-text-element-util");
+const telemetry_1 = require("@contrail/telemetry");
 class BoardDocumentGenerator {
     constructor() { }
     static generateDocumentElements(options, typeMap) {
@@ -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({ depth: structure.depth, groupingPropertiesLength: structure.groupingProperties.length }, 'generateDocumentElements');
         let position = options.startingCoordinates || { x: 0, y: 0 };
         const group = structure.rootGroup;
         const deepestSubgroups = [];

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

@@ -4,21 +4,22 @@ exports.ComponentGridGenerator = void 0;
 const util_1 = require("@contrail/util");
 const component_generator_1 = require("./component-generator");
 const component_util_1 = require("./component-util");
+const telemetry_1 = require("@contrail/telemetry");
 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('data null in generateComponentGrid');
             return [];
         }
         if (data.length === 0) {
             return [];
         }
         if (!template) {
-            console.warn('WARN: template null in generateComponentGrid');
+            telemetry_1.logger.warn('template null in generateComponentGrid');
             return [];
         }
         if (!template.componentTemplate) {
-            console.warn('WARN: component template is null in generateComponentGrid');
+            telemetry_1.logger.warn('component template is null in generateComponentGrid');
             return [];
         }
         const elements = [];

package/lib/frames/frame-generator.js

@@ -9,6 +9,7 @@ const info_panel_generator_1 = require("../info-panel/info-panel-generator");
 const frame_1 = require("./frame");
 const document_dynamic_text_element_util_1 = require("../util/document-dynamic-text-element-util");
 const document_table_1 = require("@contrail/document-table");
+const telemetry_1 = require("@contrail/telemetry");
 class FrameGenerator {
     static generateBoardFrameForDataGroup(dataGroup, framePosition, template, frameTemplate, frameTitle) {
         let style = { backgroundColor: '#fff', border: { width: 1, color: '#616161' } };
@@ -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.warn({ documentElement, oldChildElementCount: oldChildElements.length, newChildElementCount: newChildElements.length }, 'Invalid table element to copy');
                     continue;
                 }
                 documentElement = newTableElement;

package/lib/index.d.ts

@@ -4,3 +4,4 @@ export * from './showcase-frame-generator';
 export * from './interfaces';
 export * from './frames';
 export * from './util';
+export { logSomething } from './log-something';

package/lib/index.js

@@ -14,9 +14,12 @@ 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 });
+exports.logSomething = void 0;
 __exportStar(require("./document-generator"), exports);
 __exportStar(require("./board-document-generator"), exports);
 __exportStar(require("./showcase-frame-generator"), exports);
 __exportStar(require("./interfaces"), exports);
 __exportStar(require("./frames"), exports);
 __exportStar(require("./util"), exports);
+var log_something_1 = require("./log-something");
+Object.defineProperty(exports, "logSomething", { enumerable: true, get: function () { return log_something_1.logSomething; } });

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/log-something.d.ts

@@ -0,0 +1 @@
+export declare function logSomething(): void;

package/lib/log-something.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logSomething = logSomething;
+const telemetry_1 = require("@contrail/telemetry");
+function logSomething() {
+    telemetry_1.logger.info({ lib: '@contrail/document-generation' }, 'logSomething called from @contrail/document-generation');
+}

package/lib/showcase-frame-generator.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShowcaseFrameGenerator = void 0;
 const frame_1 = require("./frames/frame");
 const frame_generator_1 = require("./frames/frame-generator");
+const telemetry_1 = require("@contrail/telemetry");
 class ShowcaseFrameGenerator {
     constructor() { }
     static generateFrames(options) {
@@ -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 generated');
             frames.push(showcaseFrame);
         }
         return frames;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/document-generation",
-  "version": "2.1.37",
+  "version": "2.2.0-alpha-otel-logs-1",
   "description": "Utilities for automatic generation of documents.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -8,7 +8,7 @@
     "build": "tsc",
     "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
     "lint": "tslint -p tsconfig.json",
-    "test": "jest"
+    "test": "LOG_LEVEL=silent jest"
   },
   "keywords": [],
   "author": "",
@@ -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,6 +46,7 @@
     "@contrail/data-grouping": "^1.0.50",
     "@contrail/document-table": "^1.0.5",
     "@contrail/documents": "^1.3.3",
+    "@contrail/telemetry": "^1.0.2",
     "@contrail/types": "^3.1.3",
     "@contrail/util": "^1.1.19"
   }