@3e/sqa-common 7.4.0-2 → 7.4.0-4

package/index.d.ts

@@ -1,646 +1,15 @@
-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,
-  ShortLDTypeValue,
-  SaveDataArguments,
-  ViewExportFormat
-} from './types'
-
 /**
  * Type declarations for the @3e/sqa-common module
  */
 declare module '@3e/sqa-common' {
   /**
-   * Type definitions for all the API
+   * Type definitions exist in the SQP project packages/types
    */
-  interface CommonLib {
-    /**
-     * Initialise the SQA Common library with a `apiFn` function.
-     * Make sure to call `wrapRefresh` before calling this function
-     * @param config
-     */
-    init(config: InitialisationConfig): Promise<void>
-
-    /**
-     * Wraps the `apiFn` with retry capabilities and refreshes token that was
-     * received with the `getToken` thunk
-     * @param apiFn - The function to call the SQA endpoints
-     * @param getToken - function with no arguments that returns the JWT token
-     */
-    wrapRefresh(
-      apiFn: ApiFn,
-      getToken: TokenThunk,
-    ): {apiFn: ApiFn; resetFn: () => void}
-
-    /**
-     *
-     */
-    logout(): void
-
-    /**
-     * Returns configuration for a new empty view
-     * @param viewOptions - parameters for the view
-     */
-    newEmptyView(viewOptions: EmptyViewOptions): SQView
-
-    /**
-     * Returns the type for the given view
-     * @param view SQView
-     */
-    getViewType(view: SQView): ViewType
-
-    /**
-    * Sets a new type for the view
-    @param view - view on which to change type
-    @param viewType - new view type
-    */
-    setViewType(view: SQView, viewType: ViewType): SQView
-
-    /**
-     * Get title of the view
-     * @param view - the SQView
-     */
-    getTitle(view: SQView): string
-
-    /**
-     * Set title of the view. Returns updated SQView
-     * @param view - the SQView
-     * @param value - the new title
-     */
-    setTitle(view: SQView, value: string): SQView
-
-    /**
-     * Get description of the view
-     * @param view - the SQView
-     */
-    getDescription(view: SQView): string
-
-    /**
-     * Set description of a view. Returns updated SQView
-     * @param view - the SQView
-     * @param description - the new description
-     */
-    setDescription(view: SQView, description: string): SQView
-
-    /**
-     * Get colorScheme of the view
-     * @param view - the SQView
-     */
-    getColorScheme(view: SQView): string
-
-    /**
-     * Set colorScheme of a view. Returns updated SQView
-     * @param view - the SQView
-     * @param colorScheme - the new description
-     */
-    setColorScheme(view: SQView, colorScheme: ColorSchemeValue): SQView
-
-    /**
-     * Constructs an initial visualization for the view. Returns a promise
-     * @param view - the SQView
-     * @param options - creation options
-     */
-    getVisualization(
-      view: SQView,
-      options: VisualisationOptions,
-    ): Promise<Visualization>
-
-    /**
-     * Populates a visualization with data, using the default `append-data` to append each page.
-     * @param visualization - the visualization to be populated
-     * @param callback - Callback function called with the populated viz when the operation is done
-     *
-     * @returns a function to cancel the operation
-     */
-    populateVisualization(
-      visualization: Visualization,
-      callback: (visualization: Visualization) => void,
-    ): () => void
-
-    /**
-     * @param visualization - the visualization to be populated
-     *
-     * @returns A promise with the populated visualization
-     */
-    populateVisualization(visualization: Visualization): Promise<Visualization>
-
-    /**
-     * @param visualization - the visualization to be populated
-     * @param callback - Callback function called with the populated viz when the operation is done
-     * @param cancelPromise - A promise that resolves to an object with a `cancelled?` key
-     *                        if this promise resolves before the operation is done, the operation is cancelled
-     *
-     * @returns A promise with the populated visualization
-     */
-    populateVisualization(
-      visualization: Visualization,
-      callback: (visualization: Visualization) => void,
-      cancelPromise: Promise<{'cancelled?': boolean}>,
-    ): 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'
-        | {start: number; end: number},
-      period: Period,
-      callback: (result: MeasurementsTable) => void,
-    ): () => void
-
-    /**
-     * Creates a table for latest measurements, for a single selected object.
-     * Only returns the latest measurements for the given object.
-     * Currently, the period is hardcoded to 120 minutes
-     *
-     * @param object - the object reference
-     * @param granularity - the granularity for the data fetched
-     * @param period - the period for the data fetched (currently hardcoded to 120 minutes)
-     *                 pass null to use the default period
-     * @param callback - Callback function called with the populated table
-     *
-     * @returns a function to cancel the operation
-     */
-    getLatestMeasurements(
-      object: string,
-      granularity: 'raw' | 'scaled' | 'normalised',
-      period: Period | null,
-      callback: (result: MeasurementsTable) => void,
-    ): () => void
-
-    /**
-     * 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
-     */
-    getGranularityParameter(view: SQView): Granularity
-
-    /**
-     * Returns the granularity for the view
-     * @param view - the view to modify
-     * @param granularity - the new granularity
-     */
-    setGranularityParameter(view: SQView, granularity: Granularity): SQView
-
-    /**
-     * Returns the object parameters for a view. This is the dynamic object of the view
-     * If the view only has hardcoded objects, this will return an empty array
-     *
-     * Use this to find if the view has a dynamic object
-     * @param view
-     */
-    getObjectParameters(view: SQView):
-      | [
-          {
-            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
-     * @param view - SQView
-     * @param id - The ID of the parameter
-     * @param value - Value of the parameter
-     */
-    setObjectParameter(view: SQView, id: string, value: string): SQView
-
-    DataTimezoneModes: [
-      {value: 'user'; label: 'Display data in my own timezone'},
-      {value: 'plant'; label: 'Display data in the timezone of the plant'},
-    ]
-
-    ShowNullsAsOptions: [
-      {value: 'no'; label: 'No'},
-      {value: 'normal'; label: 'Normal'},
-      {value: 'percent'; label: 'Percent'},
-    ]
-
-    ViewTypes: {label: string; value: ViewType}[]
-
-    /**
-     * A collection of all timezones in the format {label, value}
-     */
-    Timezones: Timezone[]
-
-    /**
-     * Sets the user timezone
-     * @param timezone - The value for the new timezone
-     */
-    setUserTimezone(timezone: TimezoneValue): void
-
-    /**
-     * Sets the data timezone mode to either user or plant
-     * @param mode - the timezone mode ('user' | 'data')
-     */
-    setDataTimezoneMode(mode: TimezoneMode): void
-
-    /**
-     * Returns current available colorSchemes
-     */
-    getColorSchemes(): ColorScheme[]
-
-    /**
-     * Returns the possible color settings for a certain view type
-     * @param viewType
-     */
-    getColorSettings(viewType: ViewType): ColorSettings[]
-
-    getColorSettingsCssStyle(colorSetting: ColorSettings):
-      | {
-          backgroundColor: string
-        }
-      | {
-          backgroundImage: string
-        }
-
-    /**
-     * Sets the colorscheme of a view
-     * @param view the view to be modified
-     * @param colorScheme - the new colorscheme
-     */
-    setViewColorScheme(view: SQView, colorScheme: string): SQView
-
-    /**
-     * Array with available levels
-     *
-     * !! Only usable after `init` has been called
-     */
-    getLevels(): Level[]
-
-    StackingOptions: StackingOption[]
+  interface SqaCommonLib {}
 
-    Representations: Representation[]
-
-    /**
-     *
-     * Gets the container logical devices types to populate
-     * @param level - level means container
-     */
-    getContainersLdTypes(level: LevelValue): Promise<LdTypeOption[]>
-
-    /**
-     * Based on the selected level and the Selected Logical Device type, returns
-     * available Plants
-     * @param selectedLevel
-     * @param selectedContainerLdType
-     */
-    getContainers(
-      selectedLevel: LevelValue,
-      selectedContainerLdType?: string,
-    ): Promise<Container[]>
-
-    /**
-     * Get all available templates for the current selection
-     * @param view
-     * @param specification
-     */
-    getTemplates(
-      view: SQView,
-      specification: {
-        selectedLevel: LevelValue
-        selectedContainer?: ContainerValue
-      },
-    ): Promise<Template[]>
-
-    /**
-     * Sets the unit scaling for a view.
-     * All indicators with that unit will be modified. Returns the updated view
-     * @param view - The SQView
-     * @param unitKey - the
-     * @param unitScaling
-     */
-    setUnitScaling(
-      view: SQView,
-      unitKey: string,
-      unitScaling: {min?: number; max?: number},
-    ): SQView
-
-    /**
-     * Gets the unit axis scaling for the given unit
-     * @param view - The SQView
-     * @param unitKey - the
-     */
-    getUnitScaling(
-      view: SQView,
-      unitKey: string,
-    ): {
-      min: number
-      max: number
-    }
-
-    /**
-     * Sets the start date of the period
-     * @param view - SQView
-     * @param value - ISODateString(YYYY-MM-DDTHH:mm:ss.SSS).
-     */
-    setPeriodStart(view: SQView, value: ISODateString): SQView
-
-    /**
-     * Sets the end date of the period
-     * @param view - SQView
-     * @param value - ISODateString(YYYY-MM-DDTHH:mm:ss.SSS).
-     */
-    setPeriodEnd(view: SQView, value: ISODateString): SQView
-
-    /**
-     *  Sets the period of the view to the next period. This will automatically make it a `custom` period
-     *  @param view - The View
-     */
-    setNextPeriod(view: SQView): SQView
-
-    /**
-     *  Sets the period of the view to the previous period. This will automatically make it a `custom` period type
-     *  @param view - The View
-     */
-    setPreviousPeriod(view: SQView): SQView
-
-    /**
-     * Set the period type for the view
-     * @param view - SQView
-     * @param value - the new period
-     */
-    setPeriodParameter(view: SQView, value: Period): SQView
-
-    /**
-     * Get the period for the view
-     * @param view - SQView
-     */
-    getPeriodParameter(view: SQView): Period
-
-    /**
-     * Sets the time mode for the period (absolute/local)
-     * @param view
-     * @param periodTimeMode
-     */
-    setPeriodTimeMode(view: SQView, periodTimeMode: PeriodTimeMode): SQView
-
-    /**
-     * Returns the period for the view with all related data
-     * @param view
-     */
-    getPeriodParameterWithRange(view: SQView): {
-      period: Period
-      start: ISODateString
-      end: ISODateString
-      periodTimeMode: PeriodTimeMode
-    }
-    
-    /**
-     * Gets the datasets (e.g. for a legend).
-     *  - resolve-parameters (set to true to expand the templates to all objects)
-     *  - on-error (set to inline to get errors, inline, or throw to throw)
-     * @param view
-     * @param opts
-     */
-    getDatasets(view: SQView, opts: getDatasetsOptions): Promise<Dataset[]>
-
-    /**
-     * Adds a dataset to the view using a fixed set of objects.
-     * Removes any duplicate object indicator pairs
-     * @param view - The SQView
-     * @param objects - Selected Logical Device(s)
-     * @param indicators - Selected indicators
-     * @param options
-     */
-    addEnumDataset(
-      view: SQView,
-      objects: string[],
-      indicators: [string],
-      options: DatasetOptions,
-    ): SQView
-
-    addTemplateDataset(
-      view: SQView,
-      spec: DatasetTemplateSpec,
-      indicators: [string],
-      opts: DatasetOptions,
-    ): SQView
-
-    /**
-     * Remove a dataset from the view
-     * @param view the view to be modified
-     * @param id the id of the dataset
-     */
-    removeDataset(view: SQView, id: string): SQView
-
-    /**
-     * Set particular options on a dataset for a view
-     * @param view - the view to be updated
-     * @param id  - the id of the dataset in the view body
-     * @param options - the new options
-     *
-     * @returns The updated view
-     */
-    setDatasetOptions(view: SQView, id: string, options: DatasetOptions): SQView
-
-    /**
-     * Returns the type of picker needed for the granularity
-     * @param granularity
-     */
-    getClockOrCalendarMode(granularity: Granularity): 'clock' | 'calendar'
-
-    /**
-     * Returns the type of picker needed for the granularity
-     * @param granularity
-     */
-    getTimeMode(granularity: Granularity): 'clock' | 'calendar'
-
-    /**
-     * Adds the statistics alongside the objects in the dataset
-     * @param datasets - datasets to be updated
-     * @param visualization - Visualization to be added to datasets
-     */
-    withStatistics(datasets: Dataset[], visualization: Visualization): Dataset[]
-
-    levelToLdTypeAndModel(level: LevelValue): {ldType: string; model: string}
-
-    viewVariablesRefCategories(viewParameters: PacoViewParameters): any
-
-    /**
-     * Update a visualization
-     * @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
-     * @param format - the format of the file to be downloaded. Default is *text/csv*
-     * @param compression - the compression used for export. Default is "zip"
-     *
-     * @throws An error in case the provided parameters were incorrect. Wrap the
-     * request inside a `try-catch` block
-     */
-    createSaveDataJob(
-      visualization: Visualization,
-      filename: string,
-      format?: ViewExportFormat,
-      compression?: "none" | "zip"): Promise<string>
-
-    /**
-     * Extract arguments to create a `save_data` job for a view
-     * @param view - the view to save data for
-     * @param filename - the name of the export file. Defaults to the view title
-     */
-    viewToSaveDataArguments(view: SQView): Promise<SaveDataArguments>
-    viewToSaveDataArguments(view: SQView, filename: string): Promise<SaveDataArguments>
-
-    /**
-     * 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[]
-
-    /**
-     * Generate a new password for the user
-     *
-     * The 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
-
-    /**
-     * Compute the total number of data-points for a view.
-     * Used to determine if a view is too large to be rendered
-     * and should be saved as a CSV instead
-     *
-     * ** Returns a promise **
-     *
-     * @param view - The view to be computed
-     */
-    getNumberOfDataPoints(view: SQView): Promise<{
-      intervals: number
-      dataPoints: number
-      datasets: number
-    }>
-
-    /**
-     * Convert a Ref Category to a Logical Device Type.
-     *
-     * Returns null if no such conversion is possible.
-     *
-     * @param refCategory - The Ref Category to convert (e.g. nacelles)
-     */
-    convertRefCategoryToLDType(refCategory: string): string | null
-
-    /**
-     * Convert a Logical Device Type to a Ref Category.
-     *
-     * Returns null if no such conversion is possible.
-     *
-     * @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: LdTypeValue): string | null
-
-    /**
-     * Make a Ref from an LD Type and a SQID
-     *
-     * Returns null if it is not possible to create a Ref from the
-     * provided data (e.g. when the ldType does not correspond to a Ref Category).
-     *
-     * @param ldType - The Logical Device Type of the object. Accepts both short
-     *                 form (e.g. 'inverter') or full SQID (e.g. '/sq/ld_type/inverter')
-     * @param sqid - The SQID of the object
-     */
-    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
-     * @param view - the view for which to receive the refresh period
-     */
-    refreshPeriod(view: SQView): number | null
-  }
-
-  export const sqa: {
-    common: CommonLib
+  type SQA = {
+    common: SqaCommonLib
   }
 
-  export * from './types'
-
-  export default sqa
+  export const sqa: SQA
 }

package/package.json

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

package/sqa_common.js

@@ -1297,7 +1297,7 @@ function(){return new FI(new X(null,1,5,Y,[n+1],null),null,null,null)})}switch(w
 function HY(a,b){function c(){return ts.g(Kj.h(d,function(e){e=T(e);var f=y(e,vw),g=y(e,ts),h=y(e,pB);return ic(g)?kg.l(e,zF,!1,I([ts,mH.h(uH(null),function(){return mH.h(uH(f.m?f.m():f.call(null)),function(k){return mH.h(uH(Kj.l(d,kg,zF,!0,I([pB,function(){var l=sy.g(iE.g(aX(k)));return v(l)?l:h}()]))),function(){return uH(k)})})})])):e}))}var d=Ij(new u(null,1,[vw,b],null));return new u(null,2,[fy,GY(function(e,f){return mH.h(uH(null),function(){return mH.h(uH(c()),function(g){var h=uH;var k=sy.g(iE.g(aX(g)));
 v(k)&&(g=tk.O(aX(f),Bx,kg,"Authorization",["Bearer ",x.g(k)].join("")),g=yn.g?yn.g(g):yn.call(null,g),g=a.h?a.h(e,g):a.call(null,e,g));return h(g)})})},function(){return Kj.h(d,function(e){e=T(e);var f=y(e,ts),g=y(e,zF),h=y(e,pB);if(!(null!=f?q===f.vi||(f.Fc?0:qc(hH,f)):qc(hH,f)))throw Error("Assert failed: (p/promise? promise)");ic(g)||(ic(h)?e=og.l(e,ts,I([zF])):(f=kg.l,h=new u(null,3,[Ts,QC,iE,new u(null,1,[sy,h],null),Bx,new u(null,1,["Content-Type","application/json"],null)],null),h=yn.g?yn.g(h):
 yn.call(null,h),h=a.h?a.h("/token/refresh",h):a.call(null,"/token/refresh",h),e=f.call(kg,e,zF,!1,I([ts,h]))));return e})}),Bp,function(){return Jj(d,new u(null,1,[vw,b],null))}],null)}if("undefined"===typeof WI||"undefined"===typeof XI||"undefined"===typeof RW||"undefined"===typeof IY)var IY=null;
-function JY(a,b){b=T(b);var c=mf(b,Ts,"GET"),d=y(b,GB),e=y(b,iE);b=y(b,Bx);var f=fm.l(I([b,new u(null,1,["X-SQA-Common-Version","7.04.0-2"],null)])),g=new KH,h=IY;v(h)?xI.h(function(){if(v(d)){var k=x.g(a);var l=x,n=l.g,p=yn(d),r=[],w;for(w in p)Ja(w,p[w],r);k=[k,"?",n.call(l,r.join("\x26"))].join("")}else k=a;l={method:c,headers:yn(f),body:yn(e)};return h.h?h.h(k,l):h.call(null,k,l)}(),function(k){return DI(g,Dn(k,I([En,!0])))}):xH(g,po("Api fn not set",Qi));return g}
+function JY(a,b){b=T(b);var c=mf(b,Ts,"GET"),d=y(b,GB),e=y(b,iE);b=y(b,Bx);var f=fm.l(I([b,new u(null,1,["X-SQA-Common-Version","7.04.0-4"],null)])),g=new KH,h=IY;v(h)?xI.h(function(){if(v(d)){var k=x.g(a);var l=x,n=l.g,p=yn(d),r=[],w;for(w in p)Ja(w,p[w],r);k=[k,"?",n.call(l,r.join("\x26"))].join("")}else k=a;l={method:c,headers:yn(f),body:yn(e)};return h.h?h.h(k,l):h.call(null,k,l)}(),function(k){return DI(g,Dn(k,I([En,!0])))}):xH(g,po("Api fn not set",Qi));return g}
 var KY=Fn(JY),LY=function LY(a){switch(arguments.length){case 2:return LY.h(arguments[0],arguments[1]);case 3:return LY.j(arguments[0],arguments[1],arguments[2]);default:throw Error(["Invalid arity: ",x.g(arguments.length)].join(""));}};LY.h=function(a,b){return LY.j(a,b,null)};
 LY.j=function(a,b,c){c=T(c);var d=y(c,BE),e=y(c,Oq),f=rk(b,new X(null,2,5,Y,[GB,$p],null),!0),g=function(){function h(k,l){v(e)?(k=new X(null,2,5,Y,[e,JY(k,l)],null),k=Bc(lj.h(uH,k)),k=eI(k)):k=JY(k,l);return k}return xh.g?xh.g(h):xh.call(null,h)}();return wI(function(h,k){var l=function w(p,r){return BI(function(A,C){return null!=C?k.g?k.g(C):k.call(null,C):A instanceof FI?(zH(function(){return Ji(w,rt.g(A))}),null):h.g?h.g(A):h.call(null,A)},mH.h(uH(null),function(){return mH.h(uH(p),function(A){return mH.h(uH(r),
 function(C){var F=uH;var O=T(C);C=y(O,on);var U=y(O,iE);O=y(O,WF);if(v(O))throw po("API call cancelled",new u(null,1,[wr,Ms],null));if(pf.h(C,200))O=T(U),C=y(O,VG),U=y(O,Ez),O=y(O,Tx),O=pk(O,new X(null,2,5,Y,[as,tz],null)),v(d)&&(d.g?d.g(C):d.call(null,C)),v(U)?(U=Y,C=lk.h(A,C),O=rk(f,new X(null,2,5,Y,[GB,tz],null),O),O=g.h?g.h(a,O):g.call(null,a,O),C=new FI(new X(null,2,5,U,[C,O],null),null,null,null)):C=lk.h(A,C);else throw po(["Non 200 status code returned in paged api call for ",x.g(a)].join(""),