@3e/sqa-common 6.0.8-9 → 6.0.9-10

package/index.d.ts

@@ -744,26 +744,29 @@ declare module '@3e/sqa-common' {
     | '1 year'
 
   export type Period =
-    | 'last-7-days'
-    | 'last-week'
-    | 'since-beginning'
-    | 'last-12-months'
-    | 'year-to-date'
-    | 'today'
-    | 'current-month'
-    | 'last-month'
-    | 'forecast-4-days'
-    | 'tomorrow'
-    | 'last-24-hours'
-    | 'last-30-days'
-    | 'last-7x24-hours'
-    | 'last-3x24-hours'
-    | 'last-15-minutes'
-    | 'last-3-days'
-    | 'last-year'
-    | 'yesterday'
-    | 'forecast-10-days'
-    | 'custom'
+      | 'last-15-minutes'
+      | 'last-30-minutes'
+      | 'last-60-minutes'
+      | 'last-120-minutes'
+      | 'last-24-hours'
+      | 'today'
+      | 'yesterday'
+      | 'tomorrow'
+      | 'last-3-days'
+      | 'last-7-days'
+      | 'last-7x24-hours'
+      | 'last-3x24-hours'
+      | 'forecast-4-days'
+      | 'forecast-10-days'
+      | 'last-week'
+      | 'current-month'
+      | 'last-month'
+      | 'last-30-days'
+      | 'year-to-date'
+      | 'last-12-months'
+      | 'last-year'
+      | 'since-beginning'
+      | 'custom'
 
   export type LevelValue =
     | 'site-group'
@@ -898,6 +901,34 @@ declare module '@3e/sqa-common' {
     }
   }
 
+  /**
+   * Since in a table row the data is represented as: `[object-name, indicator1-value, indicator2-value, ...]`
+   * while the indicators in the meta are: `[indicator1, indicator2, ...]`
+   * In order to access the correct indicator in the meta, be sure to go for the `columnIndex - 1` indicator in the `indicators` array from the meta.
+   *
+   *
+   * For objects, the correct object index is the index of the full row
+   */
+  export type ObjectsTableRowInfo = {
+    indicators: {
+      label: string
+      indicator_label: string
+      reference_label: string
+      unit?: string
+      unit_key: string
+      description: string
+      key: string
+      default_graphical_representation: string
+      level: LevelValue
+    }[]
+    objects: {
+      name: string
+      level: LevelValue
+      ref: string
+      label: string
+    }
+  }
+
   export type MeasurementsTable = {
     meta: {
       rows: MeasurementsRowExtraInfo[]
@@ -945,6 +976,8 @@ declare module '@3e/sqa-common' {
 
   export type TableSpec = {
     display: 'table'
+    meta?: {rows: ObjectsTableRowInfo}
+    title?: string
     header: string[]
     rows: (number | string)[][]
   }
@@ -1104,12 +1137,12 @@ declare module '@3e/sqa-common' {
      * for the `createSaveDataJob` function
      */
     arguments: {
-      object: string[]
       toDate: ISODateString
       filename: string
       replyTz: string
       fromDate: string
-      indicator: string[]
+      objectIndicatorSets: {object: string[]
+                            indicator: string[]}[]
       granularity: Granularity[] // must be a single value
     }
     /**
@@ -1122,7 +1155,7 @@ declare module '@3e/sqa-common' {
     /**
      * currently can be just save_data
      */
-    typeSqid: number
+    typeSqid: string
   }
 
   type Parameter = {
@@ -1602,6 +1635,19 @@ declare module '@3e/sqa-common' {
      * @param view
      */
     getViewParameters(view: SQView): Parameter[]
+
+    /**
+     * Generate a new password for the user
+     *
+     * Password will
+     *  - be between 12 and 100 characters
+     *  - contain at least one lower-case character
+     *  - contain at least one upper-case character
+     *  - contain at least one digit
+     *  - contain at least one special character ("!%&@#$^*?_~-")
+     *
+     */
+    generatePassword(): string
   }
 
   export const sqa: {

package/package.json

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