@record-evolution/widget-gauge 1.6.10 → 1.7.1

package/package.json

@@ -3,7 +3,7 @@
     "description": "REWidget widget-gauge",
     "license": "MIT",
     "author": "widget-gauge",
-    "version": "1.6.10",
+    "version": "1.7.1",
     "type": "module",
     "main": "dist/widget-gauge.js",
     "types": "dist/src/widget-gauge.d.ts",
@@ -13,43 +13,37 @@
     ],
     "scripts": {
         "analyze": "cem analyze --litelement",
-        "start": "tsc && concurrently -k -r \"tsc --watch --preserveWatchOutput\" \"wds\"",
+        "start": "concurrently -k -r \"npm run watch\" \"wds\"",
         "build": "rollup -c rollup.config.js",
         "watch": "rollup -w -c rollup.config.js",
-        "link": "npm link && cd ../RESWARM/frontend && npm link @record-evolution/widget-gauge",
+        "link": "npm run build && npm link && cd ../RESWARM/frontend && npm link @record-evolution/widget-gauge",
         "unlink": "npm unlink --global && cd ../RESWARM/frontend && npm unlink @record-evolution/widget-gauge && npm i @record-evolution/widget-gauge",
-        "types": "cat src/definition-schema.json | json2ts > src/definition-schema.d.ts",
+        "types": "cat src/definition-schema.json | json2ts --style.tabWidth=4 > src/definition-schema.d.ts",
         "lint": "eslint --ext .ts,.html . --ignore-path .gitignore && prettier \"**/*.ts\" --check --ignore-path .gitignore",
         "format": "eslint --ext .ts,.html . --fix --ignore-path .gitignore && prettier \"**/*.ts\" --write --ignore-path .gitignore",
-        "release": "npm version patch --tag-version-prefix='' && git push && git push --tag"
+        "release": "npm run build && npm run types && npm version patch --tag-version-prefix='' && git push && git push --tag"
     },
     "dependencies": {
-        "echarts": "^5.5.1",
-        "lit": "^3.2.0"
+        "echarts": "5.6.0",
+        "lit": "^3.3.0"
     },
     "devDependencies": {
-        "@custom-elements-manifest/analyzer": "^0.10.3",
+        "@custom-elements-manifest/analyzer": "^0.10.4",
         "@rollup/plugin-babel": "^6.0.4",
-        "@rollup/plugin-commonjs": "^28.0.0",
-        "@rollup/plugin-node-resolve": "^15.3.0",
-        "@rollup/plugin-replace": "^6.0.1",
-        "@rollup/plugin-typescript": "^12.1.0",
-        "@typescript-eslint/eslint-plugin": "^8.8.0",
-        "@typescript-eslint/parser": "^8.8.0",
+        "@rollup/plugin-commonjs": "^28.0.3",
+        "@rollup/plugin-node-resolve": "^16.0.1",
+        "@rollup/plugin-replace": "^6.0.2",
+        "@rollup/plugin-typescript": "^12.1.2",
+        "@typescript-eslint/eslint-plugin": "^8.34.0",
+        "@typescript-eslint/parser": "^8.34.0",
         "@web/dev-server": "^0.4.6",
-        "concurrently": "^9.0.1",
-        "deepmerge": "^4.3.1",
-        "es-dev-server": "^2.1.0",
-        "eslint": "^9.11.1",
-        "eslint-config-prettier": "^9.1.0",
-        "husky": "^9.1.6",
-        "json-schema-to-typescript": "^15.0.2",
-        "lint-staged": "^15.2.10",
-        "prettier": "^3.3.3",
-        "rimraf": "^6.0.1",
-        "rollup": "^4.24.0",
-        "tslib": "^2.7.0",
-        "typescript": "5.3.2"
+        "concurrently": "^9.1.2",
+        "eslint": "^9.29.0",
+        "eslint-config-prettier": "^10.1.5",
+        "json-schema-to-typescript": "^15.0.4",
+        "prettier": "^3.5.3",
+        "rollup": "^4.43.0",
+        "typescript": "5.8.3"
     },
     "repository": {
         "type": "git",

package/src/default-data.json

@@ -1,10 +1,11 @@
 {
-    "settings": {},
+    "title": "Demo Gauge",
+    "subTitle": "A simple gauge demo",
     "dataseries": [
         {
             "label": "Demo Gauge Temperature",
             "unit": "°C",
-            "valueColor": "black",
+            "precision": 1,
             "data": [
                 {
                     "value": 90
@@ -21,7 +22,6 @@
         {
             "label": "Demo Gauge Pascal",
             "unit": "Pa",
-            "valueColor": "green",
             "data": [
                 {
                     "value": 79

package/src/definition-schema.d.ts

@@ -12,6 +12,10 @@ export type Label = string;
  * The unit of the values. e.g. °C or km/h
  */
 export type Unit = string;
+/**
+ * The number of decimal places to show in the value. If not specified, precision is 0.
+ */
+export type Precision = number;
 /**
  * This should be an ISO String date like 2023-11-04T22:47:52.351152+00:00. Will only be used to detect data age of data.
  */
@@ -22,13 +26,13 @@ export type Value = number;
  */
 export type SplitDataBy = string;
 /**
- * The data used to draw this gauge.
+ * Provide a list of values. Only the latest value is shown in the gauge unless you configure "Advanced Settings" below or use split data.
  */
 export type Data = {
-  tsp?: Timestamp;
-  value?: Value;
-  pivot?: SplitDataBy;
-  [k: string]: unknown;
+    tsp?: Timestamp;
+    value?: Value;
+    pivot?: SplitDataBy;
+    [k: string]: unknown;
 }[];
 /**
  * The limits of the gauge sections. Starting from the min value, ending with the max value.
@@ -38,7 +42,7 @@ export type SectionLimits = number[];
  * Background color for each section. This Array is one shorter than the number of sections.
  */
 export type SectionBackgroundColors = {
-  [k: string]: unknown;
+    [k: string]: unknown;
 }[];
 /**
  * Calculate the average over the given number of newest values. (If you use 'split by', then per each of the split dataseries.) If not specified then the latest value is shown without modification.
@@ -47,33 +51,34 @@ export type AverageLatestValues = number;
 /**
  * If you provide timestamp data, the delivered value is only shown in the gauge when the age of the data is not older than the given maximum Latency in seconds.
  */
-export type MaximumLatency = number;
+export type MaximumLatencyInSeconds = number;
 export type Gauges = {
-  label?: Label;
-  valueColor?: ValueColor;
-  unit?: Unit;
-  data?: Data;
-  sections?: GaugeColorSections;
-  advanced?: AdvancedConfiguration;
-  [k: string]: unknown;
+    label?: Label;
+    valueColor?: ValueColor;
+    unit?: Unit;
+    precision?: Precision;
+    data?: Data;
+    sections?: GaugeColorSections;
+    advanced?: AdvancedConfiguration;
+    [k: string]: unknown;
 }[];
 
 export interface GaugeChartConfiguration {
-  title?: Title;
-  subTitle?: Subtitle;
-  dataseries?: Gauges;
-  [k: string]: unknown;
+    title?: Title;
+    subTitle?: Subtitle;
+    dataseries?: Gauges;
+    [k: string]: unknown;
 }
 export interface ValueColor {
-  [k: string]: unknown;
+    [k: string]: unknown;
 }
 export interface GaugeColorSections {
-  sectionLimits?: SectionLimits;
-  backgroundColors?: SectionBackgroundColors;
-  [k: string]: unknown;
+    sectionLimits?: SectionLimits;
+    backgroundColors?: SectionBackgroundColors;
+    [k: string]: unknown;
 }
 export interface AdvancedConfiguration {
-  averageLatest?: AverageLatestValues;
-  maxLatency?: MaximumLatency;
-  [k: string]: unknown;
+    averageLatest?: AverageLatestValues;
+    maxLatency?: MaximumLatencyInSeconds;
+    [k: string]: unknown;
 }

package/src/definition-schema.json

@@ -38,6 +38,13 @@
                         "dataDrivenDisabled": false,
                         "order": 3
                     },
+                    "precision": {
+                        "title": "Precision",
+                        "description": "The number of decimal places to show in the value. If not specified, precision is 0.",
+                        "type": "number",
+                        "dataDrivenDisabled": false,
+                        "order": 4
+                    },
                     "data": {
                         "title": "Data",
                         "description": "Provide a list of values. Only the latest value is shown in the gauge unless you configure \"Advanced Settings\" below or use split data.",
@@ -111,7 +118,7 @@
                                 "order": 6
                             },
                             "maxLatency": {
-                                "title": "Maximum Latency",
+                                "title": "Maximum Latency in seconds",
                                 "description": "If you provide timestamp data, the delivered value is only shown in the gauge when the age of the data is not older than the given maximum Latency in seconds.",
                                 "type": "number",
                                 "dataDrivenDisabled": true,