twilio-taskrouter 0.8.4 → 2.0.0

package/dist/index.window.js.LICENSE.txt

@@ -1 +1 @@
-/*! twilio-taskrouter.js 0.8.4 */
+/*! twilio-taskrouter.js 2.0.0 */

package/dist/types.d.ts

@@ -1,15 +1,16 @@
-import EventEmitter from "events";
+import { EventEmitter } from 'events';
+import TypedEmitter from 'typed-emitter';
 
 export as namespace TaskRouter;
-export class Worker extends EventEmitter {
-    constructor(token: string, options?: any);
+export class Worker extends (EventEmitter as new () => TypedEmitter<WorkerEvents>) {
+    constructor(token: string, options?: WorkerOptions);
 
     readonly accountSid: string;
     readonly activities: Map<string, Activity>;
     readonly activity: Activity;
     readonly activitySid: string;
     readonly available: boolean;
-    readonly attributes: Object;
+    readonly attributes: Record<string, any>;
     readonly channels: Map<string, Channel>;
     readonly connectActivitySid: string;
     readonly dateCreated: Date;
@@ -26,7 +27,7 @@ export class Worker extends EventEmitter {
     readonly friendlyName: string;
     version: string;
 
-    createTask(to: string, from: string, workflowSid: string, taskQueueSid: string, options: Object): Promise<string>
+    createTask(to: string, from: string, workflowSid: string, taskQueueSid: string, options?: TaskOptions): Promise<string>;
     disconnect(): void;
     setAttributes(attributes: any): Promise<Worker>;
     updateToken(newToken: string): void;
@@ -37,6 +38,18 @@ export class Supervisor extends Worker {
     monitor(taskSid: string, reservationSid: string, extraParams: Object): Promise<void>;
 }
 
+interface WorkerEvents {
+    activityUpdated: (worker: Worker) => void;
+    attributesUpdated: (worker: Worker) => void;
+    disconnected: (worker: Worker) => void;
+    error: (error: Error) => void;
+    ready: (worker: Worker) => void;
+    reservationCreated: (reservation: Reservation) => void;
+    reservationFailed: (reservation: Reservation) => void;
+    tokenExpired: () => void;
+    tokenUpdated: () => void;
+}
+
 export interface Activity {
     readonly accountSid: string;
     readonly available: boolean;
@@ -47,14 +60,16 @@ export interface Activity {
     readonly sid: string;
     readonly workspaceSid: string;
 
-    setAsCurrent(): Promise<Activity>;
+    setAsCurrent(options?: ActivityOptions): Promise<Activity>;
 }
 
-export interface Channel {
+export class Channel extends (EventEmitter as new () => TypedEmitter<ChannelEvents>) {
     readonly accountSid: string;
+    readonly assignedTasks: number;
     readonly available: boolean;
-    readonly capacity: number;
     readonly availableCapacityPercentage: number;
+    readonly capacity: number;
+    readonly lastReservedTime: Date;
     readonly dateCreated: Date;
     readonly dateUpdated: Date;
     readonly sid: string;
@@ -64,10 +79,15 @@ export interface Channel {
     readonly workspaceSid: string;
 }
 
-export interface Task extends NodeJS.EventEmitter {
+interface ChannelEvents {
+    availabilityUpdated: (channel: Channel) => void;
+    capacityUpdated: (channel: Channel) => void;
+}
+
+export class Task extends (EventEmitter as new () => TypedEmitter<TaskEvents>) {
     readonly addOns: Object;
     readonly age: number;
-    readonly attributes: Object;
+    readonly attributes: Record<string, any>;
     readonly dateCreated: Date;
     readonly dateUpdated: Date;
     readonly priority: number;
@@ -79,33 +99,40 @@ export interface Task extends NodeJS.EventEmitter {
     readonly taskChannelSid: string;
     readonly taskChannelUniqueName: string;
     readonly timeout: number;
+    readonly transfers: Transfers;
     readonly workflowName: string;
     readonly workflowSid: string;
     readonly routingTarget: string;
     readonly version: string;
 
     complete(reason: string): Promise<Task>;
+    hold(targetWorkerSid: string, onHold: boolean, options?: TaskHoldOptions): Promise<Task>;
+    kick(workerSid: string): Promise<Task>;
     setAttributes(attributes: Object): Promise<Task>;
     transfer(to: string, options: TransferOptions): Promise<Task>;
     wrapUp(options: WrappingOptions): Promise<Task>;
     updateParticipant(options: TaskParticipantOptions): Promise<Task>;
-    kick(workerSid: string): Promise<Task>;
-    hold(targetWorkerSid: string, onHold: boolean, options: HoldOptions): Promise<Task>;
     fetchLatestVersion(): Promise<Task>;
 }
 
-export interface Reservation extends NodeJS.EventEmitter {
+interface TaskEvents {
+    canceled: (task: Task) => void;
+    completed: (task: Task) => void;
+    transferInitiated: (outgoingTransfer: OutgoingTransfer) => void;
+    updated: (task: Task) => void;
+    wrapup: (task: Task) => void;
+}
+
+export class Reservation extends (EventEmitter as new () => TypedEmitter<ReservationEvents>) {
     readonly accountSid: string;
     readonly dateCreated: Date;
     readonly dateUpdated: Date;
     readonly sid: string;
-    readonly status: "pending" | "accepted" | "rejected" | "timeout" | "canceled" | "rescinded";
-    readonly taskChannelSid: string;
-    readonly taskChannelUniqueName: string;
-    readonly taskSid: string;
+    readonly status: "pending" | "accepted" | "rejected" | "timeout" | "canceled" | "rescinded" | "wrapping" | "completed";
+    readonly task: Task;
+    readonly timeout: number;
     readonly workerSid: string;
     readonly workspaceSid: string;
-    readonly task: Task;
     readonly canceledReasonCode?: number;
     readonly version: string;
 
@@ -113,28 +140,38 @@ export interface Reservation extends NodeJS.EventEmitter {
     complete(): Promise<Reservation>;
     wrap(): Promise<Reservation>;
     call(from: string, url: string, options?: CallOptions): Promise<Reservation>;
-    dequeue(options?: DequeueOptions): Promise<Reservation>;
     conference(options?: ConferenceOptions): Promise<Reservation>;
+    dequeue(options?: DequeueOptions): Promise<Reservation>;
     redirect(callSid: string, url: string, options?: RedirectOptions): Promise<Reservation>;
     reject(options?: RejectOptions): Promise<Reservation>;
     updateParticipant(options: ReservationParticipantOptions): Promise<Reservation>;
     fetchLatestVersion(): Promise<Reservation>;
 }
 
+interface ReservationEvents {
+    accepted: (reservation: Reservation) => void;
+    canceled: (reservation: Reservation) => void;
+    completed: (reservation: Reservation) => void;
+    rejected: (reservation: Reservation) => void;
+    rescinded: (reservation: Reservation) => void;
+    timeout: (reservation: Reservation) => void;
+    wrapup: (reservation: Reservation) => void;
+}
+
 export interface TaskQueue {
-    sid: string;
-    queueSid: string;
-    accountSid: string;
-    workspaceSid: string;
-    name: string;
-    queueName: string;
-    assignmentActivityName: string;
-    reservationActivityName: string;
-    assignmentActivitySid: string;
-    reservationActivitySid: string;
-    targetWorkers: string;
-    maxReservedWorkers: number;
-    taskOrder: string;
+    readonly sid: string;
+    readonly queueSid: string;
+    readonly queueName: string;
+    readonly accountSid: string;
+    readonly workplaceSid: string;
+    readonly name: string;
+    readonly assignmentActivityName: string;
+    readonly reservationActivityName: string;
+    readonly assignmentActivitySid: string;
+    readonly reservationActivitySid: string;
+    readonly targetWorkers: string;
+    readonly maxReservedWorkers: number;
+    readonly taskOrder: string;
     dateCreated: Date;
     dateUpdated: Date;
 }
@@ -157,7 +194,7 @@ type FetchWorkersParams = {
     ActivityName?: string;
     TargetWorkersExpression?: string;
     Ordering?: "DateStatusChanged:asc" | "DateStatusChanged:desc"
-    maxWorkers?: number;
+    MaxWorkers?: number;
 };
 
 export class Workspace {
@@ -171,13 +208,44 @@ export class Workspace {
     fetchTaskQueues(params?: FetchTaskQueuesParams): Promise<Map<string, TaskQueue>>;
 }
 
+export interface Transfers {
+    readonly incoming: IncomingTransfer;
+    readonly outgoing: OutgoingTransfer;
+}
+
+export interface IncomingTransfer {
+    readonly dateCreated: Date;
+    readonly dateUpdated: Date;
+    readonly mode: "WARM" | "COLD";
+    readonly reservationSid: string;
+    readonly sid: string;
+    readonly status: "INITIATED" | "FAILED" | "COMPLETE" | "CANCELED";
+    readonly to: string;
+    readonly type: "QUEUE" | "WORKER";
+    readonly workerSid: string;
+}
+
+export interface OutgoingTransfer extends EventEmitter {
+    readonly dateCreated: Date;
+    readonly dateUpdated: Date;
+    readonly mode: "WARM" | "COLD";
+    readonly reservationSid: string;
+    readonly sid: string;
+    readonly status: "INITIATED" | "FAILED" | "COMPLETED" | "CANCELED";
+    readonly to: string;
+    readonly transferFailedReason: string;
+    readonly type: "QUEUE" | "WORKER";
+    readonly workerSid: string;
+
+    cancel(): Promise<OutgoingTransfer>;
+}
+
 export interface CallOptions {
-    readonly statusCallbackUrl?: string;
     readonly accept?: boolean;
     readonly record?: boolean;
+    readonly statusCallbackUrl?: string;
     readonly to?: string;
     readonly timeout?: number;
-
 }
 
 export interface DequeueOptions {
@@ -231,26 +299,52 @@ export interface RejectOptions {
 }
 
 export interface TransferOptions {
-    attributes: Object;
-    mode: "COLD" | "WARM";
-    priority: number;
+    attributes?: Object;
+    mode?: "COLD" | "WARM";
+    priority?: number;
 }
 
-export interface HoldOptions {
-    holdUrl: string;
-    holdMethod: "GET"
+export interface TaskParticipantOptions extends TaskHoldOptions {
+    hold: boolean;
 }
 
-export interface TaskParticipantOptions extends HoldOptions {
-    hold: boolean;
+export interface WrappingOptions {
+    reason: string;
 }
 
 export interface ReservationParticipantOptions {
-    endConferenceOnExit: boolean;
-    mute: boolean;
-    beepOnExit: boolean;
+    endConferenceOnExit?: boolean;
+    mute?: boolean;
+    beepOnExit?: boolean;
 }
 
-export interface WrappingOptions {
-    reason: string;
+export interface WorkerOptions {
+    connectActivitySid?: string;
+    closeExistingSessions?: boolean;
+    logLevel?: "error" | "warn" | "info" | "debug" | "trace" | "silent";
+    ebServer?: string;
+    wsServer?: string;
+    eventHandlerClass?: string;
+    region?: string;
+}
+
+export interface TaskOptions {
+    attributes?: any;
+    taskChannelUniqueName?: string;
+    taskChannelSid?: string;
+}
+
+export interface ActivityOptions {
+    rejectPendingReservations?: boolean;
+}
+
+export interface TaskHoldOptions {
+    holdUrl?: string;
+    holdMethod?: string;
+}
+
+export interface TaskTransferOptions {
+    attributes?: any;
+    mode?: "WARM" | "COLD";
+    priority?: string;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "twilio-taskrouter",
   "title": "Twilio TaskRouter",
-  "version": "0.8.4",
+  "version": "2.0.0",
   "description": "Twilio TaskRouter JavaScript library",
   "homepage": "https://www.twilio.com",
   "author": "Wanjun Li <wli@twilio.com>",
@@ -42,20 +42,28 @@
     "postbuild": "yarn docs && yarn coverage",
     "docs": "node ./scripts/docs.js ./dist/docs",
     "coverage": "nyc --report-dir coverage --reporter lcov --reporter text-summary yarn test:unit",
-    "test:setup": "node test/integration_test_setup/IntegrationTestSetup.js"
+    "test:setup": "node test/integration_test_setup/IntegrationTestSetup.js",
+    "sample-app:install": "yarn --cwd sample-app install",
+    "sample-app:build": "yarn --cwd sample-app build",
+    "sample-app:start": "yarn --cwd sample-app start",
+    "sample-app:dev": "yarn --cwd sample-app dev",
+    "sample-app:lint": "yarn --cwd sample-app lint",
+    "sample-app:format": "yarn --cwd sample-app format"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/twilio/twilio-taskrouter.js.git"
   },
   "dependencies": {
+    "axios": "^0.21.2",
+    "events": "3.3.0",
     "jwt-decode": "^3.1.2",
-    "lodash": "^4.17.5",
+    "lodash": "^4.17.21",
     "loglevel": "^1.4.1",
     "path-browserify": "^1.0.1",
+    "typed-emitter": "^2.1.0",
     "util": "^0.12.4",
-    "ws": "^7.4.6",
-    "xmlhttprequest": "^1.8.0"
+    "ws": "^7.4.6"
   },
   "devDependencies": {
     "@babel/core": "^7.16.0",
@@ -68,7 +76,6 @@
     "@types/express": "^4.17.7",
     "@types/qs": "^6.9.4",
     "async-test-tools": "^1.0.7",
-    "axios": "^0.21.2",
     "babel-eslint": "^10.1.0",
     "babel-loader": "^8.2.3",
     "chai": "^4.1.2",