@3e/sqa-common 6.17.0-9 → 6.18.0-2

package/index.d.ts

@@ -1,5 +1,40 @@
-import * as Highcharts from 'highcharts'
-
+import {
+  ApiFn,
+  ColorScheme,
+  ColorSettings,
+  ColorSchemeValue,
+  DashboardLevel,
+  EmptyViewOptions,
+  Granularity,
+  InitialisationConfig,
+  Level,
+  MeasurementsTable,
+  Period,
+  SQView,
+  Timezone,
+  TimezoneValue,
+  TokenThunk,
+  ViewType,
+  VisualisationOptions,
+  Visualization,
+  StackingOption,
+  TimezoneMode,
+  Representation,
+  LdTypeOption,
+  LevelValue,
+  Container,
+  ContainerValue,
+  Template,
+  ISODateString,
+  PeriodTimeMode,
+  Dataset,
+  SaveDataJobResponse,
+  LdTypeValue,
+  DatasetOptions,
+  DatasetTemplateSpec,
+  PacoViewParameters,
+  Parameter,
+} from './types'
 /**
  * Type declarations for the @3e/sqa-common module
  */
@@ -733,17 +768,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'
@@ -770,6 +810,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'
@@ -1430,7 +1536,7 @@ declare module '@3e/sqa-common' {
      * Gets the container logical devices types to populate
      * @param level - level means container
      */
-    getContainersLdTypes(level: LevelValue): Promise<LDType[]>
+    getContainersLdTypes(level: LevelValue): Promise<LdTypeOption[]>
 
     /**
      * Based on the selected level and the Selected Logical Device type, returns
@@ -1645,7 +1751,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
@@ -1683,7 +1789,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
@@ -1695,7 +1801,7 @@ 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@3e/sqa-common",
-  "version": "6.17.0-9",
+  "version": "6.18.0-2",
   "description": "SynaptiQ utilities package",
   "main": "sqa_common.js",
   "dependencies": {
@@ -14,7 +14,11 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "files": ["sqa_common.js","index.d.ts"],
+  "files": [
+    "sqa_common.js",
+    "index.d.ts",
+    "types.ts"
+  ],
   "author": "",
   "license": "ISC"
 }