@3e/sqa-common 6.0.7-test → 6.0.8-1

package/index.d.ts

@@ -783,6 +783,14 @@ declare module '@3e/sqa-common' {
       | 'sensor'
       | 'strings'
       | 'tracker'
+      | 'turbine'
+
+  export type DashboardLevel =
+      | 'site-group'
+      | 'site'
+      | 'ac-node'
+      | 'inverter'
+      | 'turbine'
 
   export type RepresentationValue =
       | 'line'
@@ -871,6 +879,83 @@ declare module '@3e/sqa-common' {
     stops?: [number, string][]
   }
 
+  export type MeasurementsRowExtraInfo = {
+    indicator?: {
+      label: string
+      indicator_label: string
+      reference_label: string
+      unit: string
+      unit_key: string
+      description: string
+      key: string
+      default_graphical_representation: string
+      level: LevelValue
+    }
+    object?: {
+      name: string
+      level: LevelValue
+      ref: string
+    }
+  }
+
+  export type MeasurementsWidgetResult = {
+    meta: {
+      rows: MeasurementsRowExtraInfo[]
+    }
+    header: string[]
+    rows: (string | number | null)[][]
+  }
+
+
+  export type HighChartsSpec = {
+    series: []
+    time: {timezone: string}
+    legend: {enabled: boolean}
+    title: boolean
+    chart: {_SQ_: {type: ViewType}; zoomType: string; animation: boolean}
+    yAxis: []
+    credits: {enabled: boolean}
+    display: 'highcharts'
+    $schema: 'https://highcharts/7.2'
+    xAxis: {
+      type: string
+      min: number
+      max: number
+      tickInterval: null //TODO: better types
+    }
+    tooltip: {
+      borderRadius: number
+      borderColor: string
+      formatter: () => string
+      borderWidth: number
+      valueDecimals: number
+      style: {
+        fontFamily: string
+        fontSize: string
+        lineHeight: string
+      }
+      useHTML: boolean
+      split: boolean
+      shared: boolean
+      shadow: {color: string; offsetY: number; opacity: number; width: number}
+      backgroundColor: string
+      enabled: boolean
+    }
+  }
+
+  export type TableSpec = {
+    display: 'table'
+    header: string[]
+    rows: (number | string)[][]
+  }
+
+  export type MessageSpec = {
+    display: 'message'
+    label: string
+  }
+
+  export type VisualizationSpec = TableSpec | MessageSpec | HighChartsSpec
+
   export interface Visualization {
     data: {
       datasets: []
@@ -884,41 +969,7 @@ declare module '@3e/sqa-common' {
     info: {title: string; type: ViewType; color_scheme: ColorSchemeValue}
     values: {}
     disableIncrementalUpdates: boolean
-    spec: {
-      series: []
-      time: {timezone: string}
-      legend: {enabled: boolean}
-      title: boolean
-      chart: {_SQ_: {type: ViewType}; zoomType: string; animation: boolean}
-      yAxis: []
-      credits: {enabled: boolean}
-      display: 'highcharts'
-      $schema: 'https://highcharts/7.2'
-      xAxis: {
-        type: string
-        min: number
-        max: number
-        tickInterval: null //TODO: better types
-      }
-      tooltip: {
-        borderRadius: number
-        borderColor: string
-        formatter: () => string
-        borderWidth: number
-        valueDecimals: number
-        style: {
-          fontFamily: string
-          fontSize: string
-          lineHeight: string
-        }
-        useHTML: boolean
-        split: boolean
-        shared: boolean
-        shadow: {color: string; offsetY: number; opacity: number; width: number}
-        backgroundColor: string
-        enabled: boolean
-      }
-    }
+    spec: VisualizationSpec
   }
 
   export interface LdType {
@@ -1042,7 +1093,7 @@ declare module '@3e/sqa-common' {
   }
       | {status: 'running'}
 
-  type SaveDataJobResponse = SaveDataJobStatus & {
+  export type SaveDataJobResponse = SaveDataJobStatus & {
     actorSqid: string
     numRetries: number
     sqid: string
@@ -1170,23 +1221,46 @@ declare module '@3e/sqa-common' {
 
     /**
      * Populates a visualization with data, using the default `append-data` to append each page.
-     * @param visualisation - the visualization to be populated
+     * @param visualization - the visualization to be populated
      * @param callback - Callback function called with the populated viz when the operation is done
      *
      * @returns a function to cancel the operation
      */
-    populateVisualisation(
-        visualisation: Visualization,
+    populateVisualization(
+        visualization: Visualization,
         callback: (visualization: Visualization) => void,
     ): () => void
 
     /**
-     * @param visualisation - the visualization to be populated
+     * @param visualization - the visualization to be populated
      *
      * @returns A promise with the populated visualization
      */
-    populateVisualisation(visualisation: Visualization): Promise<Visualization>
+    populateVisualization(visualization: Visualization): Promise<Visualization>
 
+    /**
+     * Creates a table for measurements, for a single selected object
+     *
+     * @param object - the object reference
+     * @param granularity - the granularity for the data fetched
+     * @param period - the period for the data fetched
+     * @param callback - Callback function called with the populated table
+     *
+     * @returns a function to cancel the operation
+     */
+    getMeasurements(
+        object: string,
+        granularity: 'raw' | 'scaled' | 'normalised',
+        period: Period,
+        callback: (result: MeasurementsWidgetResult) => void,
+    ): () => void
+
+    /**
+     * Returns measurable levels contained in a dashboard level
+     * @param dashboardLevel - dashboard level. See type for possible values
+     * @throws Error - If input is not contained in the possible dashboard levels
+     */
+    getMeasurableSubLevels(dashboardLevel: DashboardLevel): Level[]
     /**
      * Returns the granularity for the view
      * @param view

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@3e/sqa-common",
-  "version": "6.0.7-test",
+  "version": "6.0.8-1",
   "description": "SynaptiQ utilities package",
   "main": "sqa_common.js",
   "dependencies": {