v4.4.0

New

• Api search method has now a forth boolean argument. If the argument is true the search request payload will be sent in HTTP POST method, otherwise it sends in GET. Default is false.

Fix

• When searching certain IDs in an Object, passing id = [id1, id2] now works correctly.

Custom Headers

Ability to pass custom headers upon creating a new Api instance.

Example

import {Api} from 'workfront-api'

const api = new Api({
   url: '#YOUR_HOSTNAME#'
   headers: {
      'user-agent': '#YOUR_DESIRED_USER_AGENT_NAME#'
   }
})

Webpack, Fetch, TypeScript, go!

Improvements

1. Switched to webpack instead of browserify. Bundle size is now 5.24Kb minified!
2. Using Fetch API for http calls.
3. Whole code base in now in TypeScript.

Breaking changes

1. ApiFactory is no longer exported.
2. ApiUtil is no longer exported.
3. ApiConstants is no longer exported. Instead workfront-api-constants should be used.
4. upload method has been replaced with uploadFromStream - working under Node and uploadFileContent - working under browser.

workfront-api-constants is now a dependency

ApiConstants enum has been extracted into a separate package: workfront-api-constants and is now a dependency.

That was done to include TypeScript typings alongside constants definition in JS file which can be useful for projects which rely on Workfront API constants but don't want the whole implementation of workfront-api.

This release is fixing issue #16.

File upload support

v1.2.0

1.2.0