Changelog

Status

Release Notes

All notable changes to @qatium/sdk library will be documented here.

This library adheres to Semantic Versioning.

v0.0.63

Added

Added setStatusInBulk method to update the status of multiple assets in a single operation. This method provides better performance when updating multiple assets compared to calling setStatus multiple times, and returns detailed information about which assets were successfully updated and which failed.
Added convenience methods to filter assets by their group:
- getCustomerPoints - Get all junctions with group “customerPoint”
- getHydrants - Get all junctions with group “hydrant”
- getMainPipes - Get all pipes with group “main”
- getLateralPipes - Get all pipes with group “lateral”
- getRegulatingValves - Get all valves with group “regulating”
- getShutOffValves - Get all valves with group “shutOff”
These methods are available both on the network API and on zone objects, and accept an optional filter function to further refine results by other properties such as simulation state or asset ID.

v0.0.62

Removed

BREAKING CHANGE: Removed Python plugin support. Plugins must now be written in JavaScript only. The runtime: "python" option in the manifest is no longer supported.

v0.0.61

Added

Added an example for the plugins manifest’s allowedDomains property in the documentation.

v0.0.61

Internal

Added an experimental internal method for future evaluation purposes.

v0.0.60

Added

Include getEmitterExponent() in network. Retrieves the constant emitter exponent of the network.

v0.0.59

Added

Added Portuguese to supported languages.

v0.0.58

Added

Added headloss simulation results to pumps and valves.

v0.0.57

Fixed

Fix exports of styles.

v0.0.56

Added

Added base styles to SDK under @qatium/sdk/ui/style.css.

v0.0.55

Removed

Removed turnOnVisuals from Q commands as it does not apply anymore.

v0.0.54

Added

New method setTime

v0.0.53

Fixed

Python send_message used Maps instead of Objects

v0.0.52

Changed

Python now uses init instead of register_plugin

v0.0.51

Added

Added Python support.

v0.0.50

Added

Added onElementSelected to plugin events.

v0.0.49

Changed

Improved wording of startDate parameter used for Network Manipulations.

v0.0.48

Changed

Allow any Date value to be used for Network Manipulations.

v0.0.47

Added

Allow Network Manipulations to be applied at a given date.

v0.0.46

Added

Added better descriptions to JSON Schema

v0.0.45

Added

Added JSON Schema to manifest file.

v0.0.44

Added

Added new method has() in Integrations API secrets.

v0.0.43

Added

Added Integrations API.

Changed

Secrets API is now inside integrations API

v0.0.42

Added

Expanded inline @tsdoc documentation.

v0.0.41

Added

Add inline @tsdoc documentation to the SDK.

v0.0.40

Added

Add secrets API methods in Secrets API.

v0.0.39

Added

Add forPeriod in asset.readings.

v0.0.38

Added

Added asset generic to getAsset method.

v0.0.37

Added

Added geolocaiton permissions to manifest.

v0.0.36

Added

Added cached latest readings to readings.

v0.0.35

Added

Add commands.

v0.0.34

Added

Include getPeriodSimulation() in assets.

v0.0.33

Added

Include LEVEL in parameters and its corresponding units in meters.

v0.0.32

Changed

Make addOverlay more flexible by allowing generic data types on the data array.

v0.0.31

Removed

Removed setTime

v0.0.30

Added

New method setTime

v0.0.29

Added

New property iconId for addStyles method
New method registerIcon
New method UpdateIcon
New Icon design guidelines to help plugin creators to ensure a consistent look and behaviour

v0.0.28

Changed

Update internal libraries

v0.0.27

Fixed

Fix SDK export global

v0.0.26

Added

New property elementColor for addStyles method

v0.0.25

Changed

setHighlights return void instead of Success.

v0.0.24

Fixed

package.json was exporting wrongly the index of the project

v0.0.23

Added

getBounds method

v0.0.22

Changed

Internal exports

v0.0.21

Changed

Remove internal dependencies

v0.0.20

Changed

[BREAKING-CHANGE]: Deprecated @qatium/plugin library
- Everything is under @qatium/sdk now.