syshub-rest-module - npm Package Versions

[5.2.1] - 2024-05-15

Fixed

• The type definition of SyshubWorkflowModel.nodeDataArray has been fixed to also include GraphModelCElementObject and GraphModelWorkflowObject as valid items.

[5.2.0] - 2024-05-08

Added

• The module now allows the use of basic authentication without predefined access data. In this case, the login() method must be executed before making the first request to the Rest API (#15).
• It is now possible to use the sysHUB 2024 API keys to communicate with the Rest API (#19).

Modified

• The option of basic authentication without predefined access data means that an Error is no longer raised if the user name and password are both empty ("").
• With basic authentication, the scope is now also checked in the Rest module, even if it is ignored by the sysHUB Rest API (#21).
• Improved scope check (#23)

[5.1.0] - 2024-04-24

Added

• The module has been changed to allow temporary sessions. This means, that if the login() method is called with the third parameter keepLoggedin = false, the token and session information will be stored in the browsers sessionStorage instead of the localStorage. After an user closes the browser window, the sessionStorage is cleared and though the session automatically removed. This closes the issue https://github.com/surcoufx83/syshub-rest-module/issues/2.

Modified

• Methods that are called while the OAuth token is being refreshed are postponed for a short period of time (usually less than half a second) (closes https://github.com/surcoufx83/syshub-rest-module/issues/16).
• The logout() method now revokes the token also in the sysHUB server by calling the webauth/oauth/revoke_token endpoint (closes https://github.com/surcoufx83/syshub-rest-module/issues/3).

[5.0.1] ... [5.0.2] - 2024-04-15

Modified

• Documentation and Changelog have been updated

[5.0.1] ... [5.0.2] - 2024-04-15

Modified

• Documentation and Changelog have been updated

[5.0.0] - 2024-04-15

Modified

• Breaking Change: The Etag mechanism of the sysHUB Rest API has been enabled and added to each get...() method. An internal dictionary keeps track of the GET requests and the returned Etags. For each new request to previously called endpoints, the latest Etag is sent along. If the sysHUB server recognizes that no change has been made, it returns the HTTP status code 304/Not modified. This code is then passed on as the response. The Rest module does not transmit the cached content of the previous request, but only the code 304. It is therefore up to the application to save the data itself. The Etag functionality can be prevented per function call or globally so that the sysHUB server actually delivers the requested data.

[4.0.0] - 2024-02-26

Modified

• Breaking Change: The type definitions for connection settings have been improved. Now, you can configure either basic authentication or OAuth, but not both simultaneously. This change will break existing code, necessitating modifications to settings objects.

Added

• Automated tests have been implemented for classes and services to improve reliability and maintainability. All future changes must pass these tests prior to being included in a new release, ensuring high-quality updates.

[3.3.2] - 2024-02-15

Added

• Allow agent for workflow call or cElement to be null or string

[3.3.1] - 2024-02-14

Added

• Missing readme entry for getWorkflowModel(uuid: string)
• 'JobType' as possible value of SyshubWorkflowReference.type