twilio-taskrouter 0.8.4 → 2.0.0

package/CHANGELOG.md

@@ -1,3 +1,26 @@
+2.0.0
+==========
+New Features
+----------
+- Added React Native support
+- Added status links to the readme file
+- Added error handling to axios requests
+
+Maintenance
+----------
+- Updated lodash from 4.17.5 to 4.17.21
+- Fixed types in types.d.ts file
+- Changed default branch to main
+- Updated TaskHoldOptions
+
+0.8.5
+==========
+Maintenance
+----------
+- Added sample app for testing integrations
+- Tested SDK with TaskRouter standalone instance
+- Allow Task's and Worker's attributes to be any object
+
 0.8.4
 ==========
 Bug Fixes

package/README.md

@@ -1,17 +1,16 @@
-[![Build Status](https://travis-ci.org/twilio/twilio-taskrouter.js.svg?branch=master)](https://travis-ci.org/twilio/twilio-taskrouter.js)
+[![build](https://github.com/twilio/twilio-taskrouter.js/actions/workflows/build.yml/badge.svg)](https://github.com/twilio/twilio-taskrouter.js/actions/workflows/build.yml)
+[![Release](https://github.com/twilio/twilio-taskrouter.js/actions/workflows/release.yml/badge.svg)](https://github.com/twilio/twilio-taskrouter.js/actions/workflows/release.yml)
 [![npm version](https://badge.fury.io/js/twilio-taskrouter.svg)](https://badge.fury.io/js/twilio-taskrouter)
 
+# twilio-taskrouter.js
 
-twilio-taskrouter.js
-===============
+[![npm version](https://badge.fury.io/js/twilio-taskrouter.svg)](https://badge.fury.io/js/twilio-taskrouter)
 
 TaskRouter is Twilio's skills based routing system. With this library, you can manage your Workers in the browser or view the state of your Workspace.
 
-**NOTE: This SDK is in a Developer Preview Release**. This version of TaskRouter is intended for Twilio Flex. If you are using it outside of Twilio Flex, you may encounter bugs and instability, and
-the underlying APIs available in this release may change in subsequent releases.
+This version of TaskRouter SDK can be used with Twilio Flex and TaskRouter standalone instances.
 
-Installation
-------------
+## Installation
 
 ### NPM
 
@@ -19,75 +18,91 @@ Installation
 npm install twilio-taskrouter
 ```
 
-Usage
------
+## Usage
 
 The following is a simple example showing a Worker waiting for Reservations.
 For more information, refer to the
 [API Docs](//twilio.github.io/twilio-taskrouter.js/index.html).
 
 ```js
-const TaskRouter = require('twilio-taskrouter');
-const Twilio = require('twilio');
+const TaskRouter = require("twilio-taskrouter");
+const Twilio = require("twilio");
 const AccessToken = Twilio.jwt.AccessToken;
 const TaskRouterGrant = AccessToken.TaskRouterGrant;
 
-const accountSid = '';
-const signingKeySid = '';
-const signingKeySecret = '';
-const workspaceSid = '';
-const workerSid = '';
-
-const token = createAccessToken(accountSid, signingKeySid, signingKeySecret, workspaceSid, workerSid);
+const accountSid = "";
+const signingKeySid = "";
+const signingKeySecret = "";
+const workspaceSid = "";
+const workerSid = "";
+
+const token = createAccessToken(
+  accountSid,
+  signingKeySid,
+  signingKeySecret,
+  workspaceSid,
+  workerSid
+);
 const alice = new TaskRouter.Worker(token);
 
-alice.on('ready', readyAlice => {
-    console.log(`Worker ${readyAlice.sid} is now ready for work`);
+alice.on("ready", (readyAlice) => {
+  console.log(`Worker ${readyAlice.sid} is now ready for work`);
 });
 
-alice.on('reservationCreated', reservation => {
-    console.log(`Reservation ${reservation.sid} has been created for ${alice.sid}`);
-    console.log(`Task attributes are: ${reservation.task.attributes}`);
+alice.on("reservationCreated", (reservation) => {
+  console.log(
+    `Reservation ${reservation.sid} has been created for ${alice.sid}`
+  );
+  console.log(`Task attributes are: ${reservation.task.attributes}`);
 
-    reservation.on('accepted', acceptedReservation => {
-      console.log(`Reservation ${acceptedReservation.sid} was accepted.`);
-    });
+  reservation.on("accepted", (acceptedReservation) => {
+    console.log(`Reservation ${acceptedReservation.sid} was accepted.`);
+  });
 
-    reservation.accept().then(acceptedReservation => {
+  reservation
+    .accept()
+    .then((acceptedReservation) => {
       console.log(`Reservation status is ${acceptedReservation.status}`);
-    }).catch((err) => {
+    })
+    .catch((err) => {
       console.log(`Error: ${err}`);
     });
 });
 
-function createAccessToken(accountSid, signingKeySid, signingKeySecret, workspaceSid, workerSid) {
-    const taskRouterGrant = new TaskRouterGrant({
-        workerSid: workerSid,
-        workspaceSid: workspaceSid,
-        role: 'worker'
-    });
-
-    const accessToken = new AccessToken(accountSid, signingKeySid, signingKeySecret);
-    accessToken.addGrant(taskRouterGrant);
-    accessToken.identity = 'alice';
-
-    return accessToken.toJwt();
+function createAccessToken(
+  accountSid,
+  signingKeySid,
+  signingKeySecret,
+  workspaceSid,
+  workerSid
+) {
+  const taskRouterGrant = new TaskRouterGrant({
+    workerSid: workerSid,
+    workspaceSid: workspaceSid,
+    role: "worker",
+  });
+
+  const accessToken = new AccessToken(
+    accountSid,
+    signingKeySid,
+    signingKeySecret
+  );
+  accessToken.addGrant(taskRouterGrant);
+  accessToken.identity = "alice";
+
+  return accessToken.toJwt();
 }
-
 ```
 
-Changelog
----------
+## Changelog
 
-See [CHANGELOG.md](https://github.com/twilio/twilio-taskrouter.js/blob/master/CHANGELOG.md).
+See [CHANGELOG.md](https://github.com/twilio/twilio-taskrouter.js/blob/main/CHANGELOG.md).
 
-License
--------
+## License
 
-See [LICENSE.md](https://github.com/twilio/twilio-taskrouter.js/blob/master/LICENSE.md).
+See [LICENSE.md](https://github.com/twilio/twilio-taskrouter.js/blob/main/LICENSE.md).
 
-Building
---------
+## Building
 
 Fork and clone the repository. Use npm to install node 8 (other versions may run into problems).
 
@@ -111,15 +126,18 @@ Before commits, be sure to validate by running:
 make lint
 ```
 
-Testing
-------------
+## Testing
+
 - Create a twilio account
 - copy ./test/integration_test_setup/.env.example to ./test/integration_test_setup/.env
 - set ACCOUNT_SID, AUTH_TOKEN, SIGNING_KEY_SID, SIGNING_KEY_SECRET
 - Run ./test/integration_test_setup/RunIntegrationTestLocal.sh this will create everything needed for running E2E tests and run the tests
 
-Contributing
-------------
+## Test with Sample App
+
+- See [README.md](sample-app/README.md)
+
+## Contributing
 
 Bug fixes welcome! If you're not familiar with the GitHub pull
 request/contribution process, [this is a nice tutorial](https://gun.io/blog/how-to-github-fork-branch-and-pull-request/).

package/dist/docs/Activity.html

@@ -1157,7 +1157,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2023-08-01T08:45:21+00:00
+		on 2023-09-28T07:41:55+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/Channel.html

@@ -1732,7 +1732,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2023-08-01T08:45:21+00:00
+		on 2023-09-28T07:41:55+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/IncomingTransfer.html

@@ -641,7 +641,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2023-08-01T08:45:21+00:00
+		on 2023-09-28T07:41:55+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/OutgoingTransfer.html

@@ -1341,7 +1341,7 @@ No more attempts on the <a href="OutgoingTransfer.html">OutgoingTransfer</a> wil
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2023-08-01T08:45:21+00:00
+		on 2023-09-28T07:41:55+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/Reservation.html

@@ -3929,7 +3929,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2023-08-01T08:45:21+00:00
+		on 2023-09-28T07:41:55+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/Supervisor.html

@@ -4291,7 +4291,7 @@ TaskSid of the created Task.</li>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2023-08-01T08:45:21+00:00
+		on 2023-09-28T07:41:55+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/Task.html

@@ -2444,7 +2444,7 @@
             <td class="type">
             
                 
-<span class="param-type"><a href="global.html#HoldOptions">HoldOptions</a></span>
+<span class="param-type"><a href="global.html#TaskHoldOptions">TaskHoldOptions</a></span>
 
 
 
@@ -4553,7 +4553,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2023-08-01T08:45:21+00:00
+		on 2023-09-28T07:41:55+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/TaskQueue.html

@@ -1635,7 +1635,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2023-08-01T08:45:21+00:00
+		on 2023-09-28T07:41:55+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/Transfers.html

@@ -747,7 +747,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2023-08-01T08:45:21+00:00
+		on 2023-09-28T07:41:55+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/Worker.html

@@ -830,6 +830,8 @@
     
         <li><a href="Worker.html#event:reservationCreated">Worker#event:reservationCreated</a></li>
     
+        <li><a href="Worker.html#event:reservationFailed">Worker#event:reservationFailed</a></li>
+    
         <li><a href="Worker.html#event:tokenExpired">Worker#event:tokenExpired</a></li>
     
         <li><a href="Worker.html#event:tokenUpdated">Worker#event:tokenUpdated</a></li>
@@ -4147,7 +4149,7 @@ TaskSid of the created Task.</li>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2023-08-01T08:45:21+00:00
+		on 2023-09-28T07:41:55+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/Workspace.html

@@ -1231,7 +1231,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2023-08-01T08:45:21+00:00
+		on 2023-09-28T07:41:55+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/classes.list.html

@@ -5346,7 +5346,7 @@ No more attempts on the <a href="OutgoingTransfer.html">OutgoingTransfer</a> wil
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2023-08-01T08:45:21+00:00
+		on 2023-09-28T07:41:55+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>