@3e/sqa-common 6.16.0-9 → 6.17.0-11

package/index.d.ts

@@ -1,3 +1,5 @@
+import * as Highcharts from 'highcharts'
+
 /**
  * Type declarations for the @3e/sqa-common module
  */
@@ -731,17 +733,22 @@ declare module '@3e/sqa-common' {
     | 'kpis'
 
   export type Granularity =
-    | '1 minute'
-    | '5 minutes'
-    | '10 minutes'
-    | '15 minutes'
-    | '30 minutes'
-    | '1 hour'
-    | '1 day'
-    | '1 week'
-    | '1 month'
-    | '3 months'
-    | '1 year'
+      | '1-days'
+      | '1-hours'
+      | '1-minutes'
+      | '1-months'
+      | '1-weeks'
+      | '1-years'
+      | '10-minutes'
+      | '15-minutes'
+      | '3-months'
+      | '30-minutes'
+      | '5-minutes'
+      | 'change'
+      | 'normalized'
+      | 'raw'
+      | 'scaled'
+      | 'statelog'
 
   export type Period =
       | 'last-15-minutes'
@@ -768,6 +775,72 @@ declare module '@3e/sqa-common' {
       | 'since-beginning'
       | 'custom'
 
+  export type ShortLDTypeValue =
+      | 'ac-input'
+      | 'ac-node'
+      | 'ac-phase'
+      | 'account'
+      | 'battery'
+      | 'bearing'
+      | 'blade'
+      | 'connection'
+      | 'dc-input'
+      | 'dc-node'
+      | 'generator'
+      | 'inverter'
+      | 'inverter-device'
+      | 'logger'
+      | 'module-group'
+      | 'mppt'
+      | 'nacelle'
+      | 'portfolio'
+      | 'power-unit'
+      | 'rotor'
+      | 'sensor'
+      | 'site'
+      | 'site-group'
+      | 'spv'
+      | 'strings'
+      | 'tower'
+      | 'tracker'
+      | 'transmission'
+      | 'turbine'
+      | 'yaw'
+
+  export type LongLDTypeValue =
+      | 'sq/ld_type/ac_input'
+      | 'sq/ld_type/ac_node'
+      | 'sq/ld_type/ac_phase'
+      | 'sq/ld_type/account'
+      | 'sq/ld_type/battery'
+      | 'sq/ld_type/bearing'
+      | 'sq/ld_type/blade'
+      | 'sq/ld_type/connection'
+      | 'sq/ld_type/dc_input'
+      | 'sq/ld_type/dc_node'
+      | 'sq/ld_type/generator'
+      | 'sq/ld_type/inverter'
+      | 'sq/ld_type/inverter_device'
+      | 'sq/ld_type/logger'
+      | 'sq/ld_type/module_group'
+      | 'sq/ld_type/mppt'
+      | 'sq/ld_type/nacelle'
+      | 'sq/ld_type/portfolio'
+      | 'sq/ld_type/power_unit'
+      | 'sq/ld_type/rotor'
+      | 'sq/ld_type/sensor'
+      | 'sq/ld_type/site'
+      | 'sq/ld_type/site_group'
+      | 'sq/ld_type/spv'
+      | 'sq/ld_type/strings'
+      | 'sq/ld_type/tower'
+      | 'sq/ld_type/tracker'
+      | 'sq/ld_type/transmission'
+      | 'sq/ld_type/turbine'
+      | 'sq/ld_type/yaw'
+
+  export type LdTypeValue = ShortLDTypeValue | LongLDTypeValue
+
   export type LevelValue =
     | 'site-group'
     | 'site'
@@ -946,58 +1019,28 @@ declare module '@3e/sqa-common' {
   }
 
   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
+    chart: {_SQ_: {type: ViewType}; zoomType: string; animation: boolean}
+  } & Highcharts.Options
+
+  export type TableSpec = {
+      display: 'table'
+      meta?: {
+          type: 'time_table'
+          rows: TimeTableMetaRowInfo
+      } | {
+          type: 'object_table'
+          rows: ObjectsTableMetaRowInfo
       }
-      useHTML: boolean
-      split: boolean
-      shared: boolean
-      shadow: {color: string; offsetY: number; opacity: number; width: number}
-      backgroundColor: string
-      enabled: boolean
-    }
+      title?: string
+      header: string[]
+      rows: (number | string)[][]
   }
 
-    export type TableSpec = {
-        display: 'table'
-        meta?: {
-            type: 'time_table'
-            rows: TimeTableMetaRowInfo
-        } | {
-            type: 'object_table'
-            rows: ObjectsTableMetaRowInfo
-        }
-        title?: string
-        header: string[]
-        rows: (number | string)[][]
-    }
-
   export type MessageSpec = {
     display: 'message'
     label: string
+    value: string
   }
   export type KPI = {
     kpi: string
@@ -1023,6 +1066,7 @@ declare module '@3e/sqa-common' {
       clock_or_calendar_mode: string
       granularity: Granularity
     }
+    error?: boolean
     options: VisualisationOptions
     info: {title: string; type: ViewType; color_scheme: ColorSchemeValue}
     values: {}
@@ -1672,7 +1716,7 @@ declare module '@3e/sqa-common' {
     /**
      * Generate a new password for the user
      *
-     * Password will
+     * The Password will:
      *  - be between 12 and 100 characters
      *  - contain at least one lower-case character
      *  - contain at least one upper-case character
@@ -1710,7 +1754,7 @@ declare module '@3e/sqa-common' {
      * @param ldType - The Logical Device Type to convert. Accepts both short
      *                 form (e.g. 'inverter') or full SQID (e.g. '/sq/ld_type/inverter')
      */
-    convertLDTypeToRefCategory(ldType: string): string | null
+    convertLDTypeToRefCategory(ldType: LdTypeValue): string | null
 
     /**
      * Make a Ref from an LD Type and a SQID
@@ -1722,7 +1766,13 @@ declare module '@3e/sqa-common' {
      *                 form (e.g. 'inverter') or full SQID (e.g. '/sq/ld_type/inverter')
      * @param sqid - The SQID of the object
      */
-    refFromLDTypeAndSQID(ldType: string, sqid: string): string | null
+    refFromLDTypeAndSQID(ldType: LdTypeValue, sqid: string): string | null
+
+    /**
+     * Returns the refresh period for the view in milliseconds, or null if the view should not be refreshed
+     * @param view - the view for which to receive the refresh period
+     */
+    refreshPeriod(view: SQView): number | null
   }
 
   export const sqa: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@3e/sqa-common",
-  "version": "6.16.0-9",
+  "version": "6.17.0-11",
   "description": "SynaptiQ utilities package",
   "main": "sqa_common.js",
   "dependencies": {
@@ -8,6 +8,9 @@
     "@js-joda/timezone": "^2.5.0",
     "decimal.js-light": "2.5.1"
   },
+  "peerDependencies": {
+    "highcharts": "^11.1.0"
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },