Releases: muxinc/mux-node-sdk
Typo fix in master access docs
v2.8.1 2.8.1
v3.0.0 beta (Typescript 🎉)
- Drop Node 8 support (this is no longer LTS and it is not recommended to use Node 8 in production)
- Added types for Typescript support
- Remove previously deprecated remove method (use del instead)
- Remove erroneous requirement to pass in
viewer_id
param when getting a list of views - Change API response format for all
Mux.Data
responses (return the full response)
Breaking Changes
-
Drop Node 8 support
-
Resuts for the
Data
class will no longer return the nesteddata
key. They will return the full responseconst Mux = require('@mux/mux-node'); const { Data } = new Mux(accessToken, secret); // version 2.x const dimensions = await Data.RealTime.dimensions() // version 3.x const { data: dimensions, timeframe, total_row_count } = await Data.RealTime.dimensions()
Note this change only affects Data
. If you are using Video
the response format is unchanged.
If you are already using Node 10+, and you are not using Data
then there are no breaking changes.
Asset mp4 and master access APIs
Mux Data Real Time API endpoints
- Add real time api endpoints (view docs for usage)
Asset text track endpoints
- Add Asset text track endpoints (view docs for usage)
Simulcast Targets & Delivery Usage APIs
- Add Simulcast Targets and Delivery Usage apis (view docs for usage)
- Update dependencies
- Add
yarn format
commands and add formatting check to CI
Support Webhook signature verification
- Added the ability to validate webhook signatures, to ensure the validity of each webhook.
Mux Incidents Added
The Incidents feature was added in #22
Official docs: https://api-docs.mux.com/#incident
Add signed URL helpers
Add helpers for generating signed URLs Mux.JWT.sign
(see README for details)
v2.0.0
Breaking Changes
-
Nested resource modules are now PascalCase. For example:
// version 1.x Video.assets.create(); // version 2.x Video.Assets.create();
-
All requests now return the nested
data
key directly.// version 1.x const { data: { data: assets } } = await Video.assets.list(); // version 2.x const assets = await Video.Assets.list();
If you'd like access to the full request object for any reason, you can do so via listening for the
response
event:muxClient.on('response', res => { // Response will include everything returned from the API, such as status codes/text, headers, etc });
Soft Deprecations
-
remove
is deprecated in favor ofdel
.remove
will no longer be available in the next major release (3.x).// 👎 const Video.Assets.remove('your-asset-id'); // 👍 const Video.Assets.del('your-asset-id');
Improvements
-
Added support for the new direct uploads endpoints.
-
The library will default to using the
MUX_TOKEN_ID
andMUX_TOKEN_SECRET
environment variables if a client is initialized without the token id/secret params./* Assuming process.env.MUX_TOKEN_ID and process.env.MUX_TOKEN_SECRET exist and are valid, this works */ const { Video, Data } = new Mux();