twilio-taskrouter 0.8.2 → 0.8.3

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

@@ -1 +1 @@
-/*! twilio-taskrouter.js 0.8.2 */
+/*! twilio-taskrouter.js 0.8.3 */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "twilio-taskrouter",
   "title": "Twilio TaskRouter",
-  "version": "0.8.2",
+  "version": "0.8.3",
   "description": "Twilio TaskRouter JavaScript library",
   "homepage": "https://www.twilio.com",
   "author": "Wanjun Li <wli@twilio.com>",
@@ -33,12 +33,13 @@
     "test:integration-six-sigma": "mocha --full-trace --check-leaks --require @babel/register -r ./test/mocha/no-unicode-reporter.js -r ./test/mocha/fetch.js ./test/integration/index.js --reporter mochawesome --reporter-options reportDir=reports,reportFilename=e2e-test-report --timeout 40000 --exit -g '@SixSigma'",
     "test:integration:voice": "mocha --full-trace --check-leaks --require @babel/register ./test/voice/index.js --timeout 40000 --exit",
     "test:integration:media": "mocha --full-trace --check-leaks --require @babel/register ./test/media/index.js --timeout 40000 --exit",
-    "test": "npm run test:unit && npm run test:integration",
-    "build:dev": "npm run webpack development",
-    "build:prod": "npm run webpack production",
-    "prebuild": "npm run clean && yarn install",
-    "build": "npm run lint && npm run build:prod",
-    "postbuild": "npm run docs && npm run coverage",
+    "test": "yarn test:unit && yarn test:integration",
+    "build:dev": "yarn webpack development",
+    "build:prod": "yarn webpack production",
+    "build:types": "tsc && node ./scripts/types.js",
+    "prebuild": "yarn clean && yarn install",
+    "build": "yarn lint && yarn build:prod && yarn run build:types",
+    "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"
@@ -74,7 +75,6 @@
     "chai-as-promised": "^7.1.1",
     "chai-datetime": "^1.4.1",
     "cheerio": "^1.0.0-rc.10",
-    "copy-webpack-plugin": "^6.4.1",
     "dotenv": "16.0.1",
     "eslint": "^7.32.0",
     "ink-docstrap": "^1.3.2",
@@ -90,6 +90,7 @@
     "sinon-chai": "^3.5.0",
     "twilio": "^3.71.3",
     "twilio-sync": "^2.0.1",
+    "typescript": "^4.5.5",
     "webpack": "^5.65.0",
     "webpack-cli": "^4.9.1",
     "webpack-node-externals": "^3.0.0"
@@ -100,5 +101,5 @@
   "engines": {
     "node": ">=12"
   },
-  "types": "./dist/types.d.ts"
+  "types": "./dist/declarations"
 }

package/dist/types.d.ts

@@ -1,256 +0,0 @@
-import EventEmitter from "events";
-
-export as namespace TaskRouter;
-export class Worker extends EventEmitter {
-    constructor(token: string, options?: any);
-
-    readonly accountSid: string;
-    readonly activities: Map<string, Activity>;
-    readonly activity: Activity;
-    readonly activitySid: string;
-    readonly available: boolean;
-    readonly attributes: Object;
-    readonly channels: Map<string, Channel>;
-    readonly connectActivitySid: string;
-    readonly dateCreated: Date;
-    readonly dateStatusChanged: Date;
-    readonly dateUpdated: Date;
-    readonly disconnectActivitySid: string;
-    readonly name: string;
-    readonly reservations: Map<string, Reservation>;
-    readonly sid: string;
-    readonly workspaceSid: string;
-    readonly workerSid: string;
-    readonly workerActivitySid: string;
-    readonly dateActivityChanged: Date;
-    readonly friendlyName: string;
-    version: string;
-
-    createTask(to: string, from: string, workflowSid: string, taskQueueSid: string, options: Object): Promise<string>
-    disconnect(): void;
-    setAttributes(attributes: any): Promise<Worker>;
-    updateToken(newToken: string): void;
-    fetchLatestVersion(): Promise<Worker>;
-}
-
-export class Supervisor extends Worker {
-    monitor(taskSid: string, reservationSid: string, extraParams: Object): Promise<void>;
-}
-
-export interface Activity {
-    readonly accountSid: string;
-    readonly available: boolean;
-    readonly dateCreated: Date;
-    readonly dateUpdated: Date;
-    readonly isCurrent: boolean;
-    readonly name: string;
-    readonly sid: string;
-    readonly workspaceSid: string;
-
-    setAsCurrent(): Promise<Activity>;
-}
-
-export interface Channel {
-    readonly accountSid: string;
-    readonly available: boolean;
-    readonly capacity: number;
-    readonly availableCapacityPercentage: number;
-    readonly dateCreated: Date;
-    readonly dateUpdated: Date;
-    readonly sid: string;
-    readonly taskChannelSid: string;
-    readonly taskChannelUniqueName: string;
-    readonly workerSid: string;
-    readonly workspaceSid: string;
-}
-
-export interface Task extends NodeJS.EventEmitter {
-    readonly addOns: Object;
-    readonly age: number;
-    readonly attributes: Object;
-    readonly dateCreated: Date;
-    readonly dateUpdated: Date;
-    readonly priority: number;
-    readonly queueName: string;
-    readonly queueSid: string;
-    readonly reason: string;
-    readonly sid: string;
-    readonly status: "pending" | "reserved" | "assigned" | "canceled" | "completed" | "wrapping";
-    readonly taskChannelSid: string;
-    readonly taskChannelUniqueName: string;
-    readonly timeout: number;
-    readonly workflowName: string;
-    readonly workflowSid: string;
-    readonly routingTarget: string;
-    readonly version: string;
-
-    complete(reason: 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 {
-    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 workerSid: string;
-    readonly workspaceSid: string;
-    readonly task: Task;
-    readonly canceledReasonCode?: number;
-    readonly version: string;
-
-    accept(): Promise<Reservation>;
-    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>;
-    redirect(callSid: string, url: string, options?: RedirectOptions): Promise<Reservation>;
-    reject(options?: RejectOptions): Promise<Reservation>;
-    updateParticipant(options: ReservationParticipantOptions): Promise<Reservation>;
-    fetchLatestVersion(): Promise<Reservation>;
-}
-
-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;
-    dateCreated: Date;
-    dateUpdated: Date;
-}
-
-export class TaskRouterEventHandler {
-    constructor(worker: Worker, options?: Object);
-    getTREventsToHandlerMapping(): {[key: string]: string};
-}
-
-type FetchTaskQueuesParams = {
-    AfterSid?: string;
-    FriendlyName?: string;
-    Ordering?: "DateUpdated:asc" | "DateUpdated:desc"
-}
-
-type FetchWorkersParams = {
-    AfterSid?: string;
-    FriendlyName?: string;
-    ActivitySid?: string;
-    ActivityName?: string;
-    TargetWorkersExpression?: string;
-    Ordering?: "DateStatusChanged:asc" | "DateStatusChanged:desc"
-    maxWorkers?: number;
-};
-
-export class Workspace {
-    constructor(jwt: string, options?: Object, workspaceSid?: string);
-    readonly workspaceSid: string;
-
-    updateToken(newToken: string): void;
-    fetchWorker(workerSid: string): Promise<Worker>;
-    fetchWorkers(params?: FetchWorkersParams): Promise<Map<string, Worker>>;
-    fetchTaskQueue(queueSid: string): Promise<TaskQueue>;
-    fetchTaskQueues(params?: FetchTaskQueuesParams): Promise<Map<string, TaskQueue>>;
-}
-
-export interface CallOptions {
-    readonly statusCallbackUrl?: string;
-    readonly accept?: boolean;
-    readonly record?: boolean;
-    readonly to?: string;
-    readonly timeout?: number;
-
-}
-
-export interface DequeueOptions {
-    from?:string;
-    to?:string;
-    postWorkActivitySid?:string;
-    record?:string;
-    timeout?:number;
-    statusCallbackUrl?:string;
-    statusCallbackEvents?:string;
-}
-
-export interface ConferenceOptions {
-    to?:string;
-    from?:string;
-    timeout?:number;
-    statusCallback?:string;
-    statusCallbackMethod?:string;
-    statusCallbackEvent?:string;
-    record?:string;
-    muted?:boolean;
-    beep?:string | boolean;
-    startConferenceOnEnter?:boolean;
-    endConferenceOnExit?:boolean;
-    endConferenceOnCustomerExit?:boolean;
-    beepOnCustomerEntrance?:boolean;
-    waitUrl?:string;
-    waitMethod?:string;
-    earlyMedia?:boolean;
-    maxParticipants?:number;
-    conferenceStatusCallback?:string;
-    conferenceStatusCallbackMethod?:string;
-    conferenceStatusCallbackEvent?:string;
-    conferenceRecord?:string | boolean;
-    conferenceTrim?:string;
-    recordingChannels?:string;
-    recordingStatusCallback?:string;
-    recordingStatusCallbackMethod?:string;
-    conferenceRecordingStatusCallback?:string;
-    conferenceRecordingStatusCallbackMethod?:string;
-    region?:string;
-    sipAuthUsername?:string;
-    sipAuthPassword?:string;
-}
-export interface RedirectOptions {
-    accept?:boolean;
-}
-
-export interface RejectOptions {
-    activitySid: string;
-}
-
-export interface TransferOptions {
-    attributes: Object;
-    mode: "COLD" | "WARM";
-    priority: number;
-}
-
-export interface HoldOptions {
-    holdUrl: string;
-    holdMethod: "GET"
-}
-
-export interface TaskParticipantOptions extends HoldOptions {
-    hold: boolean;
-}
-
-export interface ReservationParticipantOptions {
-    endConferenceOnExit: boolean;
-    mute: boolean;
-    beepOnExit: boolean;
-}
-
-export interface WrappingOptions {
-    reason: string;
-}