Items marked as [Beta] are currently untested and may not work as expected.
Added
- Vastly improved error handling. Errors are handled where appropriate and useful error messages are thrown where possible.
- Logging. By providing a logging object to the `Carter` constructor, you can now log all interactions with the API. This is useful for debugging and for monitoring. Logging will be improved in future releases.
- Support for the new /opener endpoint with `carter.opener(playerId)`.
- Support for the new /personalise endpoint with `carter.personalise(text)`.
- Added new types for opener and personalise interactions. These are identical to the `CarterInteraction` type, but don't include forced behaviours.
Changed
- [Beta] The `Carter` object now takes an extra property `userLogger` which can be used to activate debug logging. More details in the documentation.
- `carter.say` no longer accepts a `CarterPayloadOptions` object as its second argument. Instead, it accepts a playerId string. `carter-js` will still generate a uuid if this is not provided.
- Changed `query` property in carter to `text
- Time taken property of interactions is now calculated by `carter-js` rather than the API. This is measured from function call to just before the interaction is returned.
- interactions now contain an id property which is a uuid generated by `carter-js`, this is used to identify interactions when logging and in the history array.
- Skill actions no longer accept metadata or entity parameters.
- The carter.history array can now contain `CarterInteraction` objects OR `CarterOpenerInteraction` objects. Personalise interactions are not included as they are not considered part of the conversation.
Deprecated
- `carter.downvote()` has been removed. This is because the API no longer supports downvoting.
- `carter.audioLink` has been removed. This is because the API no longer supports audio links.