@3e/sqa-common 6.14.0-8 → 6.15.0-2

package/index.d.ts

@@ -999,12 +999,24 @@ declare module '@3e/sqa-common' {
     display: 'message'
     label: string
   }
+  export type KPI = {
+    kpi: string
+    value: string | number
+  }
+
+  export type KPISpec = {
+    display: 'kpis'
+    title: {text: string}
+    object: Object
+    kpis: KPI[]
+  }
+
+  export type VisualizationSpec = TableSpec | MessageSpec | HighChartsSpec | KPISpec
 
-  export type VisualizationSpec = TableSpec | MessageSpec | HighChartsSpec
 
   export interface Visualization {
     data: {
-      datasets: []
+      datasets: Dataset[]
       date_from: ISODateString
       date_to: ISODateString
       period_time_mode: string
@@ -1049,7 +1061,7 @@ declare module '@3e/sqa-common' {
   }
 
   export interface Indicator {
-    default_graphical_representation: string
+    default_graphical_representation: RepresentationValue
     description: string
     key: string
     label: string
@@ -1111,24 +1123,24 @@ declare module '@3e/sqa-common' {
   export type Scaling = Record<string, UnitScale>
 
   export interface Dataset {
-    objects?: any
+    objects?: Object[]
     colorSetting?: ColorSettings
     indicators: Indicator[]
     objectSet: ObjectSet
     stacking: StackingOptionValue
     showNullsAs?: any
     representation: string
-    label?: any
+    label?: unknown
     id: string
     scaling: Scaling
-    stack?: any
-    error?: any
+    stack?: unknown
+    error?: unknown
     idx: number
     objectSetLabel: string
   }
 
   // TODO: Better types for PacoViewParameters
-  type PacoViewParameters = any
+  type PacoViewParameters = unknown
 
   type SaveDataJobStatus =
     | {
@@ -1329,9 +1341,17 @@ declare module '@3e/sqa-common' {
      * 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
+     * @deprecated Use getMeasurableSubLevelsByLdType instead
      */
     getMeasurableSubLevels(dashboardLevel: DashboardLevel): Level[]
 
+    /**
+     * Returns measurable levels contained in a dashboard level for a given ldType
+     * @param ldType - ldType of the dashboard level
+     * @throws Error - If input is not contained in the possible dashboard levels
+     */
+    getMeasurableSubLevelsByLDType(ldType: string): Level[]
+
     /**
      * Returns the granularity for the view
      * @param view

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@3e/sqa-common",
-  "version": "6.14.0-8",
+  "version": "6.15.0-2",
   "description": "SynaptiQ utilities package",
   "main": "sqa_common.js",
   "dependencies": {