@3e/sqa-common 6.0.6-9 → 6.0.7-10

package/index.d.ts

@@ -672,6 +672,24 @@ declare module '@3e/sqa-common' {
     body: Section[]
   }
 
+  export type Parameters = {
+    class: string
+    id: string
+  }
+
+  export type ViewData = SQView & {
+    artifact: {
+      type: string
+      version: string
+    }
+    body: {
+      body: Parameters[]
+      class: string
+      id: string
+    }[]
+    version: string
+  }
+
   export type ParameterOption = {
     options: {value: string; label: string}[]
     id: string
@@ -853,6 +871,34 @@ 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 interface Visualization {
     data: {
       datasets: []
@@ -1015,6 +1061,53 @@ declare module '@3e/sqa-common' {
   // TODO: Better types for PacoViewParameters
   type PacoViewParameters = any
 
+  type SaveDataJobStatus =
+      | {
+    status: 'terminated'
+    respResult: {downloadUrl: string}
+    completedTime: ISODateString
+    respStatus: number
+  }
+      | {status: 'running'}
+
+  type SaveDataJobResponse = SaveDataJobStatus & {
+    actorSqid: string
+    numRetries: number
+    sqid: string
+    maxRetries: number
+
+    /**
+     * The arguments derived from the visualization given as argument
+     * for the `createSaveDataJob` function
+     */
+    arguments: {
+      object: string[]
+      toDate: ISODateString
+      filename: string
+      replyTz: string
+      fromDate: string
+      indicator: string[]
+      granularity: Granularity[] // must be a single value
+    }
+    /**
+     * The place in the queue
+     */
+    priority: number
+
+    timeout: number
+
+    /**
+     * currently can be just save_data
+     */
+    typeSqid: number
+  }
+
+  type Parameter = {
+    id: string
+    class: 'Parameter'
+    parameter: {class: string; label: string; initial: unknown; value: unknown}
+  }
+
   /**
    * Type definitions for all the API
    */
@@ -1122,6 +1215,23 @@ declare module '@3e/sqa-common' {
      */
     populateVisualisation(visualisation: 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 the granularity for the view
      * @param view
@@ -1153,7 +1263,7 @@ declare module '@3e/sqa-common' {
      * @param id - The ID of the parameter //TODO: Get list of possible parameters
      * @param value - Value of the parameter
      */
-    setObjectParameters(view: SQView, id: string, value: string): SQView
+    setObjectParameter(view: SQView, id: string, value: string): SQView
 
     DataTimezoneModes: [
       {value: 'user'; label: 'Display data in my own timezone'},
@@ -1237,7 +1347,7 @@ declare module '@3e/sqa-common' {
      */
     getContainers(
         selectedLevel: LevelValue,
-        selectedContainerLdType: string,
+        selectedContainerLdType?: string,
     ): Promise<Container[]>
 
     /**
@@ -1405,6 +1515,40 @@ declare module '@3e/sqa-common' {
      * @param visualization
      */
     updateVisualization(visualization: Visualization): Visualization
+
+    /**
+     * Create a SAVE_DATA job request for a visualization. After a job is
+     * successfully created, a *JobUrl* is returned to be polled for a status
+     * on the job
+     *
+     * @param visualization - The visualization to be saved in a .csv format
+     * @param filename - the name of the csv.zip file to be downloaded
+     *
+     * @throws An error in case the provided parameters were incorrect. Wrap the
+     * request inside a `try-catch` block
+     */
+    createSaveDataJob(
+        visualization: Visualization,
+        filename: string,
+    ): Promise<string>
+
+    /**
+     * Used for polling the SQA API for the job status.
+     *
+     * Use the jobUrl returned from `createSaveDataJob` and poll until `status` is `terminated`
+     * @param jobUrl
+     *
+     * @throws An error in case something goes wrong with the request or the job does not
+     * exist. Wrap the call inside a `try-catch` block
+     */
+    checkJobStatus(jobUrl: string): Promise<SaveDataJobResponse>
+
+    /**
+     * Returns the parameters of a view
+     * @param view
+     */
+    getViewParameters(view: SQView): Parameter[]
+
   }
 
   export const sqa: {

package/package.json

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