@datarailsshared/dr_renderer 1.3.59 → 1.4.5

package/.github/workflows/release.yml

@@ -0,0 +1,44 @@
+name: Build and Publish
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - 'master'
+      - 'main'
+  push:
+    branches:
+      - 'master'
+      - 'main'
+      - 'migration-to-github'
+
+concurrency:
+  group: '${{ github.ref }}-${{ github.workflow }}'
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  publish-npm:
+    name: Build, Test and Publish to NPM
+    uses: datarails/dr_github_reusable/.github/workflows/npm-build-publish.yml@main
+    with:
+      node_version: '14.16.1'
+      access_level: 'public'
+      branch_postfix: false
+      main_branch: 'master'
+      version_prefix: '1.4'
+    secrets:
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+  publish-gh-packages:
+    name: Publish to GitHub Packages
+    needs: publish-npm
+    uses: datarails/dr_github_reusable/.github/workflows/npm-publish-gh-packages.yml@main
+    with:
+      node_version: '14.16.1'
+      package_scope: '@datarails'
+      version: ${{ needs.publish-npm.outputs.version }}
+    secrets: inherit

package/.whitesource

@@ -0,0 +1,3 @@
+{
+  "settingsInheritedFrom": "Datarails/whitesource-config@main"
+} 

package/README.md

@@ -14,10 +14,52 @@ This project was generated by amazing Datarails R&D team
     let hr = dr_renderer.getInitHighchartsRenderer($, document, default_colors, Highcharts);
 
 ## Development
+
 ### Types
-To be able to compile types with `npm run build:types` you need to install typescript globally:
 
-```npm i -g typescript```
+To compile types for the project use: `npm run build:types`
 
 ## Publish to npm
-Just merge to prod branch
+
+Just merge to master branch
+
+## Error Handling
+
+The renderer includes a comprehensive error handling system with specific error types for different scenarios:
+
+### Error Codes
+
+The following error codes are available via `RendererErrorCodes`:
+
+- `NoDataError` (1) - No data is available for rendering
+- `TooMuchDataError` (3) - Dataset exceeds capacity 
+- `DataConflictError` (5) - Conflicts detected in data being processed
+- `GaugeConfigurationError` (6) - Gauge chart missing required data
+- `GenericRenderingError` (7) - Generic rendering failure in PivotTable components
+- `GenericComputationalError` (8) - Generic computational failure in PivotTable components
+
+### Error Classes
+
+All errors extend the `BaseRendererError` class which includes:
+- `code` - Unique error code for identification
+- `title` - Human-readable error message
+- `options` - Additional context or configuration
+
+### Usage Example
+
+```javascript
+const { RendererErrorCodes, NoDataError, TooMuchDataError } = require('@datarailsshared/dr_renderer');
+
+try {
+    // Your rendering code here
+} catch (error) {
+    if (error instanceof NoDataError) {
+        console.log('No data available:', error.title);
+    } else if (error.code === RendererErrorCodes.TooMuchDataError) {
+        console.log('Too much data:', error.title);
+    }
+}
+```
+
+###
+##

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datarailsshared/dr_renderer",
-  "version": "1.3.59",
+  "version": "1.4.5",
   "description": "DataRails charts and tables renderer",
   "keywords": [
     "datarails",
@@ -11,7 +11,7 @@
   "scripts": {
     "login": "npm login",
     "test": "jest --coverage",
-    "build:types": "tsc --build --verbose"
+    "build:types": "npx tsc --build --verbose"
   },
   "author": "Sergey Spivakov",
   "repository": {
@@ -32,11 +32,10 @@
     "babel-jest": "^25.5.1",
     "jest": "^25.3.0",
     "moment": "^2.29.1",
-    "serve": "^11.3.0"
-  },
-  "bugs": {
-    "url": ""
+    "serve": "^11.3.0",
+    "typescript": "^5.0.0"
   },
+  "types": "src/index.d.ts",
   "homepage": "https://bitbucket.org/datarails/dr_renderer/src/master/",
   "whitelistedNonPeerDependencies": [],
   "main": "src/index.js",

package/src/charts/dr_donut_chart.js

@@ -110,7 +110,7 @@ function DrDonutChart(highchartsRenderer, pivotData, opts, drilldownFunc, disabl
 				x="0"
 				style="font-size: ${series.center[2] / 16}px; fill: #6D6E6F;">
 				${(additionOptions.total_value_label && additionOptions.total_value_label.total_value_label_text) || 'Total'}
-			 </tspan>`,
+			 </tspan>`
             )
             .css({
                 textAnchor: 'middle',
@@ -123,7 +123,7 @@ function DrDonutChart(highchartsRenderer, pivotData, opts, drilldownFunc, disabl
         const x = series.center[0] + chart.plotLeft;
         const y = chart.plotTop + series.center[1] - rect.height / 2;
 
-        totalLabel.attr({ x, y });
+        totalLabel.attr({ x: x, y: y });
     };
 
     this.setDrilldownConfig = function (chartConfig) {
@@ -134,7 +134,7 @@ function DrDonutChart(highchartsRenderer, pivotData, opts, drilldownFunc, disabl
                 pivotData,
                 chartConfig,
                 additionOptions,
-                opts,
+                opts
             );
         } else {
             chartConfig.drilldown = highchartsRenderer.getDataLabelsStylesForDrillDown(additionOptions);

package/src/charts/dr_gauge_categories_summary_chart.js

@@ -61,12 +61,12 @@ function DrGaugeCategoriesSummaryChart(pivotData, opts) {
 
     this.createPlotBands = function (options) {
         const {
-            segments,
+            segments: segments,
             goal: { value: goalValue },
-            gauge: { thickness },
+            gauge: { thickness: thickness },
         } = options;
 
-        let bands = segments.map((item, index) => {
+        let bands = _.map(segments, (item, index) => {
             return {
                 from: item.from,
                 to: item.to,
@@ -120,7 +120,7 @@ function DrGaugeCategoriesSummaryChart(pivotData, opts) {
                 }
             );
         }
-        segmentsOutput = segmentsOutput.filter(
+        segmentsOutput = _.filter(segmentsOutput,
             (segment) => {
                 return segment.from !== segment.to;
             }
@@ -133,8 +133,9 @@ function DrGaugeCategoriesSummaryChart(pivotData, opts) {
     }
 
     this.getCompletionPercentage = function (options) {
-        const countOfCompletedItems = options.segments.find(segment => !!segment.isCompletionParameter)?.count || 0;
-        const totalCount = options.segments.reduce((acc, segment) => acc + segment.count, 0);
+        const completedSegment = _.find(options.segments, segment => !!segment.isCompletionParameter);
+        const countOfCompletedItems = completedSegment ? completedSegment.count : 0;
+        const totalCount = _.reduce(options.segments, (acc, segment) => acc + segment.count, 0);
         if (totalCount === 0) {
             return 0;
         }
@@ -179,8 +180,7 @@ function DrGaugeCategoriesSummaryChart(pivotData, opts) {
 
 
     this.getPaneDimensions = function (chart, options) {
-        const {renderer} = chart;
-        const {offset} = options.gauge;
+        const offset = options.gauge.offset;
 
         const offsetBottom = options.gauge.valueOffset[0] + options.gauge.valueOffset[2] + offset[2];
 
@@ -199,7 +199,7 @@ function DrGaugeCategoriesSummaryChart(pivotData, opts) {
         const {radius, center} = this.getPaneDimensions(chart, options);
         chart.pane[0].options.size = 2 * radius;
         chart.pane[0].options.center = center;
-        chart.yAxis[0].options.plotBands.forEach((band) => {
+        _.forEach(chart.yAxis[0].options.plotBands, (band) => {
             band.outerRadius = radius - (options.gauge.tickLength - options.gauge.thickness) / 2;
         });
     };
@@ -241,16 +241,16 @@ function DrGaugeCategoriesSummaryChart(pivotData, opts) {
                 plotBorderWidth: 0,
                 plotShadow: false,
                 events: {
-                    render: ({target: chart}) => {
-                        this.moveCustomElementsToFront(chart);
+                    render: (event) => {
+                        this.moveCustomElementsToFront(event.target);
                     },
-                    beforeRedraw: ({target: chart}) => {
-                        this.setPane(chart, this.options);
-                        this.updateCustomElements(chart, this.options);
+                    beforeRedraw: (event) => {
+                        this.setPane(event.target, this.options);
+                        this.updateCustomElements(event.target, this.options);
                     },
-                    beforeRender: ({target: chart}) => {
-                        this.setPane(chart, this.options);
-                        this.setCustomElements(chart, this.options);
+                    beforeRender: (event) => {
+                        this.setPane(event.target, this.options);
+                        this.setCustomElements(event.target, this.options);
                     }
                 },
                 margin: [0, 0, 0, 0],