Releases: bioinformatics-ua/dicoogle-client-js
v3.4.0
v3.3.2
3.3.0 - Indexer Settings + Typings
- Added methods for getting and setting indexer settings:
getIndexerSettings
andsetIndexerSettings
- Added typings for use in TypeScript applications.
3.1.1 - Outsourced HTTP client
The Dicoogle client is now using superagent
, a lightweight and portable HTTP client library. This has removed the burden of maintaining two versions of the HTTP client (one for Node.js and another one for the browser), without crippling the library's bundle size (roughly only 1KB more when minified).
The dicoogle-query
executable is also now working again.
Version 3.1.0
- Added support for DIM-formatted search output (
dim
option) - Added optional
provider
parameter todump
- New methods:
closeTask
andstopTask
- Added a configuration file for the JSDoc generator (experimental). Useful for looking up the documentation on a nice web page instead of the source code.
- Added a few more tests.
3.0.0 - Role-based Access Control and Test Integration
This major version implements all authentication and authorization mechanisms used in Dicoogle 2.3. Users are automatically logged in when credentials are provided:
const dicoogleClient = require('dicoogle-client');
const Dicoogle = dicoogleClient('http://mydicoogle.somewhere.net', {username: 'dicoogle', password: 'secret'});
Alternatively, log in manually (required for knowing when the user is really authenticated
function login(username:string, password:password, callback: (error, data: {token, user, roles}) => void)
At the end of all operations (e.g. when leaving the web application), log out:
function logout(callback: function(error) => void)
Additional changes:
- Methods
search
anddump
now return the full outcome ({results, elapsedTime}
) instead of just the search results. - Getter methods for the user name, roles and session token.
- JSDoc comments were properly validated.
- Tests were included of the module. The test task (
npm test
) is run automatically by Travis CI.
2.2.0
New features:
- added
index
, 'unindex' and 'remove' functions - added generic
request
function for using REST services provided by Dicoogle (and its plugins) - additional calls to the module will provide the access object with the previously defined base URL
Fixes and other changes:
- Fix wrong variable name pname in service_request: a query string option with the
null
value should now be included in the request without an explicit value.
Breaking changes:
- Responses may now also include the result content even if an error occurred.
- If the server responds with plain text, the result parameter of the callback will be a string instead of an object.
Others:
- moved building process to gulp
- reorganized the repository: "src/" is for the original source code, "lib/" for the babel-processed, ready-for-use code, CLI tools were moved to "bin/" and the HTML example was moved to "example/".
Version 2.0.0
- A CLI and binary application for querying Dicoogle (
dicoogle-query
) - Enhanced building process to work well with browserify
- Bug fixes
Version 1.0.0
add gitignore