@3e/sqa-common 6.23.0-4 → 6.23.0-5

package/index.d.ts

@@ -59,8 +59,8 @@ declare module '@3e/sqa-common' {
      * @param getToken - function with no arguments that returns the JWT token
      */
     wrapRefresh(
-        apiFn: ApiFn,
-        getToken: TokenThunk,
+      apiFn: ApiFn,
+      getToken: TokenThunk,
     ): {apiFn: ApiFn; resetFn: () => void}
 
     /**
@@ -132,8 +132,8 @@ declare module '@3e/sqa-common' {
      * @param options - creation options
      */
     getVisualization(
-        view: SQView,
-        options: VisualisationOptions,
+      view: SQView,
+      options: VisualisationOptions,
     ): Promise<Visualization>
 
     /**
@@ -144,8 +144,8 @@ declare module '@3e/sqa-common' {
      * @returns a function to cancel the operation
      */
     populateVisualization(
-        visualization: Visualization,
-        callback: (visualization: Visualization) => void,
+      visualization: Visualization,
+      callback: (visualization: Visualization) => void,
     ): () => void
 
     /**
@@ -166,12 +166,9 @@ declare module '@3e/sqa-common' {
     populateVisualization(
       visualization: Visualization,
       callback: (visualization: Visualization) => void,
-      cancelPromise: Promise<{"cancelled?": boolean}>
+      cancelPromise: Promise<{'cancelled?': boolean}>,
     ): Promise<Visualization>
 
-
-
-
     /**
      * Creates a table for measurements, for a single selected object
      *
@@ -183,14 +180,14 @@ declare module '@3e/sqa-common' {
      * @returns a function to cancel the operation
      */
     getMeasurements(
-        object: string,
-        granularity:
-            | 'raw'
-            | 'scaled'
-            | 'normalised'
-            | {start: number; end: number},
-        period: Period,
-        callback: (result: MeasurementsTable) => void,
+      object: string,
+      granularity:
+        | 'raw'
+        | 'scaled'
+        | 'normalised'
+        | {start: number; end: number},
+      period: Period,
+      callback: (result: MeasurementsTable) => void,
     ): () => void
 
     /**
@@ -207,10 +204,10 @@ declare module '@3e/sqa-common' {
      * @returns a function to cancel the operation
      */
     getLatestMeasurements(
-        object: string,
-        granularity: 'raw' | 'scaled' | 'normalised',
-        period: Period | null,
-        callback: (result: MeasurementsTable) => void,
+      object: string,
+      granularity: 'raw' | 'scaled' | 'normalised',
+      period: Period | null,
+      callback: (result: MeasurementsTable) => void,
     ): () => void
 
     /**
@@ -249,17 +246,17 @@ declare module '@3e/sqa-common' {
      * @param view
      */
     getObjectParameters(view: SQView):
-        | [
-      {
-        id: string
-        label: string
-        ldType: ShortLDTypeValue
-        level: ShortLDTypeValue
-        container: string | null
-        value: string
-      },
-    ]
-        | []
+      | [
+          {
+            id: string
+            label: string
+            ldType: ShortLDTypeValue
+            level: ShortLDTypeValue
+            container: string | null
+            value: string
+          },
+        ]
+      | []
 
     /**
      * Sets the object parameter with the given id. Used to set the dynamic object of the view
@@ -311,12 +308,12 @@ declare module '@3e/sqa-common' {
     getColorSettings(viewType: ViewType): ColorSettings[]
 
     getColorSettingsCssStyle(colorSetting: ColorSettings):
-        | {
-      backgroundColor: string
-    }
-        | {
-      backgroundImage: string
-    }
+      | {
+          backgroundColor: string
+        }
+      | {
+          backgroundImage: string
+        }
 
     /**
      * Sets the colorscheme of a view
@@ -350,8 +347,8 @@ declare module '@3e/sqa-common' {
      * @param selectedContainerLdType
      */
     getContainers(
-        selectedLevel: LevelValue,
-        selectedContainerLdType?: string,
+      selectedLevel: LevelValue,
+      selectedContainerLdType?: string,
     ): Promise<Container[]>
 
     /**
@@ -360,11 +357,11 @@ declare module '@3e/sqa-common' {
      * @param specification
      */
     getTemplates(
-        view: SQView,
-        specification: {
-          selectedLevel: LevelValue
-          selectedContainer?: ContainerValue
-        },
+      view: SQView,
+      specification: {
+        selectedLevel: LevelValue
+        selectedContainer?: ContainerValue
+      },
     ): Promise<Template[]>
 
     /**
@@ -375,9 +372,9 @@ declare module '@3e/sqa-common' {
      * @param unitScaling
      */
     setUnitScaling(
-        view: SQView,
-        unitKey: string,
-        unitScaling: {min?: number; max?: number},
+      view: SQView,
+      unitKey: string,
+      unitScaling: {min?: number; max?: number},
     ): SQView
 
     /**
@@ -386,8 +383,8 @@ declare module '@3e/sqa-common' {
      * @param unitKey - the
      */
     getUnitScaling(
-        view: SQView,
-        unitKey: string,
+      view: SQView,
+      unitKey: string,
     ): {
       min: number
       max: number
@@ -461,17 +458,17 @@ declare module '@3e/sqa-common' {
      * @param options
      */
     addEnumDataset(
-        view: SQView,
-        objects: string[],
-        indicators: [string],
-        options: DatasetOptions,
+      view: SQView,
+      objects: string[],
+      indicators: [string],
+      options: DatasetOptions,
     ): SQView
 
     addTemplateDataset(
-        view: SQView,
-        spec: DatasetTemplateSpec,
-        indicators: [string],
-        opts: DatasetOptions,
+      view: SQView,
+      spec: DatasetTemplateSpec,
+      indicators: [string],
+      opts: DatasetOptions,
     ): SQView
 
     /**
@@ -532,8 +529,8 @@ declare module '@3e/sqa-common' {
      * request inside a `try-catch` block
      */
     createSaveDataJob(
-        visualization: Visualization,
-        filename: string,
+      visualization: Visualization,
+      filename: string,
     ): Promise<string>
 
     /**
@@ -575,7 +572,11 @@ declare module '@3e/sqa-common' {
      *
      * @param view - The view to be computed
      */
-    getNumberOfDataPoints(view: SQView): Promise<number>
+    getNumberOfDataPoints(view: SQView): Promise<{
+      intervals: number
+      dataPoints: number
+      datasets: number
+    }>
 
     /**
      * Convert a Ref Category to a Logical Device Type.

package/package.json

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