twilio-chat - npm Package Compare versions

Comparing version 3.3.2 to 3.3.3-rc1

lib/channel.d.ts

@@ -122,14 +122,14 @@ /// <reference types="node" />
     constructor(services: ChannelServices, descriptor: ChannelDescriptor, sid: string);
-    readonly status: Channel.Status;
-    readonly type: Channel.Type;
-    readonly uniqueName: string;
-    readonly isPrivate: boolean;
-    readonly friendlyName: string;
-    readonly dateUpdated: any;
-    readonly dateCreated: any;
-    readonly createdBy: string;
-    readonly attributes: Object;
-    readonly lastConsumedMessageIndex: number;
-    readonly lastMessage: Channel.LastMessage;
-    readonly notificationLevel: Channel.NotificationLevel;
+    get status(): Channel.Status;
+    get type(): Channel.Type;
+    get uniqueName(): string;
+    get isPrivate(): boolean;
+    get friendlyName(): string;
+    get dateUpdated(): any;
+    get dateCreated(): any;
+    get createdBy(): string;
+    get attributes(): Object;
+    get lastConsumedMessageIndex(): number;
+    get lastMessage(): Channel.LastMessage;
+    get notificationLevel(): Channel.NotificationLevel;
     /**
@@ -230,2 +230,9 @@ * The Channel's last message's information.
      * Get channel members count.
+     * <br/>
+     * This method is semi-realtime. This means that this data will be eventually correct,
+     * but will also possibly be incorrect for a few seconds. The Chat system does not
+     * provide real time events for counter values changes.
+     * <br/>
+     * So this is quite useful for any UI badges, but is not recommended
+     * to build any core application logic based on these counters being accurate in real time.
      * @returns {Promise<number|Error>}
@@ -248,2 +255,9 @@ */
      * Get total message count in a channel.
+     * <br/>
+     * This method is semi-realtime. This means that this data will be eventually correct,
+     * but will also possibly be incorrect for a few seconds. The Chat system does not
+     * provide real time events for counter values changes.
+     * <br/>
+     * So this is quite useful for any UI badges, but is not recommended
+     * to build any core application logic based on these counters being accurate in real time.
      * @returns {Promise<number|Error>}
@@ -255,2 +269,9 @@ */
      * Rejects if User is not Member of Channel.
+     * <br/>
+     * This method is semi-realtime. This means that this data will be eventually correct,
+     * but will also possibly be incorrect for a few seconds. The Chat system does not
+     * provide real time events for counter values changes.
+     * <br/>
+     * So this is quite useful for any “unread messages count” badges, but is not recommended
+     * to build any core application logic based on these counters being accurate in real time.
      * @returns {Promise<number|Error>}
@@ -257,0 +278,0 @@ */

lib/channel.js

@@ -482,2 +482,9 @@ "use strict";
      * Get channel members count.
+     * <br/>
+     * This method is semi-realtime. This means that this data will be eventually correct,
+     * but will also possibly be incorrect for a few seconds. The Chat system does not
+     * provide real time events for counter values changes.
+     * <br/>
+     * So this is quite useful for any UI badges, but is not recommended
+     * to build any core application logic based on these counters being accurate in real time.
      * @returns {Promise<number|Error>}
@@ -515,2 +522,9 @@ */
      * Get total message count in a channel.
+     * <br/>
+     * This method is semi-realtime. This means that this data will be eventually correct,
+     * but will also possibly be incorrect for a few seconds. The Chat system does not
+     * provide real time events for counter values changes.
+     * <br/>
+     * So this is quite useful for any UI badges, but is not recommended
+     * to build any core application logic based on these counters being accurate in real time.
      * @returns {Promise<number|Error>}
@@ -527,2 +541,9 @@ */
      * Rejects if User is not Member of Channel.
+     * <br/>
+     * This method is semi-realtime. This means that this data will be eventually correct,
+     * but will also possibly be incorrect for a few seconds. The Chat system does not
+     * provide real time events for counter values changes.
+     * <br/>
+     * So this is quite useful for any “unread messages count” badges, but is not recommended
+     * to build any core application logic based on these counters being accurate in real time.
      * @returns {Promise<number|Error>}
@@ -529,0 +550,0 @@ */

lib/client.d.ts

@@ -130,5 +130,5 @@ /// <reference types="node" />
     static create(token: string, options?: Client.Options): Promise<Client>;
-    readonly user: User;
-    readonly reachabilityEnabled: boolean;
-    readonly token: string;
+    get user(): User;
+    get reachabilityEnabled(): boolean;
+    get token(): string;
     private subscribeToPushNotifications;
@@ -135,0 +135,0 @@ private unsubscribeFromPushNotifications;

lib/configuration.d.ts

@@ -13,9 +13,9 @@ declare class Configuration {
     constructor(options: any);
-    readonly typingIndicatorTimeoutDefault: number;
-    readonly httpCacheIntervalDefault: string;
-    readonly consumptionReportIntervalDefault: string;
-    readonly userInfosToSubscribeDefault: number;
-    readonly retryWhenThrottledDefault: boolean;
-    readonly backoffConfigDefault: any;
+    get typingIndicatorTimeoutDefault(): number;
+    get httpCacheIntervalDefault(): string;
+    get consumptionReportIntervalDefault(): string;
+    get userInfosToSubscribeDefault(): number;
+    get retryWhenThrottledDefault(): boolean;
+    get backoffConfigDefault(): any;
 }
 export { Configuration };

lib/media.d.ts

@@ -23,6 +23,6 @@ import { McsClient } from 'twilio-mcs-client';
     constructor(data: MediaState, services: MediaServices);
-    readonly sid: string;
-    readonly filename: string;
-    readonly contentType: string;
-    readonly size: number;
+    get sid(): string;
+    get filename(): string;
+    get contentType(): string;
+    get size(): number;
     /**
@@ -29,0 +29,0 @@ * Returns direct content URL for the media.

lib/member.d.ts

@@ -53,12 +53,12 @@ /// <reference types="node" />
     readonly channel: any;
-    readonly sid: string;
-    readonly attributes: Object;
-    readonly dateCreated: Date;
-    readonly dateUpdated: Date;
-    readonly identity: string;
-    readonly isTyping: boolean;
-    readonly lastConsumedMessageIndex: number;
-    readonly lastConsumptionTimestamp: Date;
-    readonly roleSid: string;
-    readonly type: Member.Type;
+    get sid(): string;
+    get attributes(): Object;
+    get dateCreated(): Date;
+    get dateUpdated(): Date;
+    get identity(): string;
+    get isTyping(): boolean;
+    get lastConsumedMessageIndex(): number;
+    get lastConsumptionTimestamp(): Date;
+    get roleSid(): string;
+    get type(): Member.Type;
     /**
@@ -65,0 +65,0 @@ * The update reason for <code>updated</code> event emitted on Member

lib/message.d.ts

@@ -48,13 +48,13 @@ /// <reference types="node" />
     constructor(channel: Channel, services: MessageServices, index: number, data: any);
-    readonly sid: string;
-    readonly author: string;
-    readonly body: string;
-    readonly dateUpdated: Date;
-    readonly index: number;
-    readonly lastUpdatedBy: string;
-    readonly timestamp: Date;
-    readonly attributes: Object;
-    readonly type: Message.Type;
-    readonly media: Media;
-    readonly memberSid: string;
+    get sid(): string;
+    get author(): string;
+    get body(): string;
+    get dateUpdated(): Date;
+    get index(): number;
+    get lastUpdatedBy(): string;
+    get timestamp(): Date;
+    get attributes(): Object;
+    get type(): Message.Type;
+    get media(): Media;
+    get memberSid(): string;
     _update(data: any): void;
@@ -61,0 +61,0 @@ /**

lib/restpaginator.d.ts

@@ -12,5 +12,5 @@ import { Paginator } from './interfaces/paginator';
     private state;
-    readonly hasNextPage: boolean;
-    readonly hasPrevPage: boolean;
-    readonly items: Array<T>;
+    get hasNextPage(): boolean;
+    get hasPrevPage(): boolean;
+    get items(): Array<T>;
     constructor(items: any, source: any, prevToken: any, nextToken: any);
@@ -17,0 +17,0 @@ nextPage(): Promise<RestPaginator<T>>;

lib/services/typingindicator.d.ts

@@ -21,3 +21,3 @@ import { Notifications } from 'twilio-notifications';
     constructor(config: Configuration, services: TypingIndicatorServices, getChannel: any);
-    readonly typingTimeout: number;
+    get typingTimeout(): number;
     /**
@@ -24,0 +24,0 @@ * Initialize TypingIndicator controller

lib/session.d.ts

@@ -30,4 +30,4 @@ import { Configuration } from './configuration';
     constructor(services: SessionServices, config: Configuration);
-    readonly identity: string;
-    readonly reachabilityEnabled: boolean;
+    get identity(): string;
+    get reachabilityEnabled(): boolean;
     private handleContextUpdate;
@@ -34,0 +34,0 @@ initialize(): Promise<Session>;

lib/syncpaginator.d.ts

@@ -13,3 +13,3 @@ import { Paginator } from './interfaces/paginator';
     hasPrevPage: boolean;
-    readonly items: Array<T>;
+    get items(): Array<T>;
     /**
@@ -16,0 +16,0 @@ * @param {Array} items Array of element for current page

lib/user.d.ts

@@ -50,9 +50,10 @@ /// <reference types="node" />
     constructor(identity: string, entityName: string, services: UserServices);
-    identity: string;
-    entityName: string;
-    readonly attributes: Object;
-    readonly friendlyName: string;
-    readonly online: boolean;
-    readonly notifiable: boolean;
-    readonly isSubscribed: boolean;
+    get identity(): string;
+    set identity(identity: string);
+    set entityName(name: string);
+    get attributes(): Object;
+    get friendlyName(): string;
+    get online(): boolean;
+    get notifiable(): boolean;
+    get isSubscribed(): boolean;
     _update(key: string, value: any): void;
@@ -59,0 +60,0 @@ _updateReachabilityInfo(map: any, update: any): any;

lib/util/deferred.d.ts

@@ -7,3 +7,3 @@ declare class Deferred<T> {
     constructor();
-    readonly promise: Promise<T>;
+    get promise(): Promise<T>;
     update(value: T): void;
@@ -10,0 +10,0 @@ set(value: T): void;

package.json

 {
   "name": "twilio-chat",
-  "version": "3.3.2",
+  "version": "3.3.3-rc1",
   "description": "Twilio Chat service client library",
@@ -13,6 +13,6 @@ "main": "lib/index.js",
     "twilio-notifications": "^0.5.8",
-    "twilio-sync": "^0.11.4",
+    "twilio-sync": "^0.11.5",
     "twilsock": "^0.5.11",
     "iso8601-duration": "^1.2.0",
-    "loglevel": "^1.6.3",
+    "loglevel": "^1.6.6",
     "operation-retrier": "^3.0.0",
@@ -24,3 +24,3 @@ "platform": "^1.3.5",
   "devDependencies": {
-    "@types/chai": "^4.1.7",
+    "@types/chai": "^4.2.5",
     "@types/chai-as-promised": "^7.1.2",
@@ -30,4 +30,4 @@ "@types/chai-string": "^1.4.1",
     "@types/mocha": "^5.2.7",
-    "@types/node": "^12.7.5",
-    "@types/sinon": "^7.0.12",
+    "@types/node": "^12.12.12",
+    "@types/sinon": "^7.5.1",
     "@types/sinon-chai": "^3.2.2",
@@ -45,2 +45,3 @@ "async": "^3.0.1",
     "browserify-replace": "^1.0.0",
+    "browserslist": "^4.7.3",
     "chai": "^4.2.0",
@@ -69,13 +70,13 @@ "chai-as-promised": "^7.1.1",
     "jsdoc-strip-async-await": "^0.1.0",
-    "mocha": "^6.1.4",
+    "mocha": "^6.2.2",
     "mocha.parallel": "^0.15.6",
     "nyc": "^14.1.1",
     "path": "^0.12.7",
-    "sinon": "^7.3.2",
+    "sinon": "^7.5.0",
     "sinon-chai": "^3.3.0",
-    "source-map-explorer": "^2.0.1",
-    "ts-node": "^8.2.0",
-    "tslint": "^5.17.0",
-    "twilio": "^3.31.1",
-    "typescript": "^3.6.3",
+    "source-map-explorer": "^2.1.1",
+    "ts-node": "^8.5.2",
+    "tslint": "^5.20.1",
+    "twilio": "^3.37.1",
+    "typescript": "^3.7.2",
     "uglify-save-license": "^0.4.1",
@@ -87,3 +88,15 @@ "vinyl-buffer": "^1.0.1",
     "node": ">=6"
-  }
+  },
+  "browserslist": [
+    "IE 11",
+    "last 3 Chrome versions",
+    "last 3 Firefox versions",
+    "last 3 Safari versions",
+    "last 3 Edge versions",
+    "last 2 iOS version",
+    "last 2 ChromeAndroid version",
+    "last 2 FirefoxAndroid version",
+    "last 2 Samsung versions",
+    "last 2 UCAndroid versions"
+  ]
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6102348

increased by0.13%

Lines of code

170402

increased by0.05%

Worsened metrics

Dev dependency count

57

increased by1.79%

Number of low quality alerts

4

increased by33.33%

Dependency changes

• Updatedloglevel@^1.6.6

• Updatedtwilio-sync@^0.11.5