getstream - npm Package Compare versions

Comparing version 7.2.3 to 7.2.4

CHANGELOG.md

@@ -8,9 +8,15 @@ # CHANGELOG
 
-## [7.2.3](https://github.com/GetStream/stream-js/releases/tag/v7.2.1) - 2021-02-16
+## [7.2.4](https://github.com/GetStream/stream-js/releases/tag/v7.2.4) - 2021-02-19
 
 ### Fix
 
+- Fix Realtime callback type [#437](https://github.com/GetStream/stream-js/pull/437)
+
+## [7.2.3](https://github.com/GetStream/stream-js/releases/tag/v7.2.3) - 2021-02-16
+
+### Fix
+
 - EnrichedUser type [#435](https://github.com/GetStream/stream-js/pull/435)
 
-## [7.2.2](https://github.com/GetStream/stream-js/releases/tag/v7.2.1) - 2021-02-15
+## [7.2.2](https://github.com/GetStream/stream-js/releases/tag/v7.2.2) - 2021-02-15
 
@@ -17,0 +23,0 @@ ### Fix

lib/feed.d.ts

@@ -33,3 +33,2 @@ /// <reference path="../types/modules.d.ts" />
 };
-export declare type GetFeedOptions = FeedPaginationOptions & EnrichOptions & RankedFeedOptions;
 export declare type NotificationFeedOptions = {
@@ -39,2 +38,3 @@ mark_read?: boolean | 'current' | string[];
 };
+export declare type GetFeedOptions = FeedPaginationOptions & EnrichOptions & RankedFeedOptions & NotificationFeedOptions;
 export declare type GetFollowOptions = {
@@ -281,3 +281,3 @@ filter?: string[];
      * @memberof StreamFeed.prototype
-     * @param {GetFeedOptions & NotificationFeedOptions}   options  Additional options
+     * @param {GetFeedOptions} options  Additional options
      * @return {Promise<FeedAPIResponse>}
@@ -287,3 +287,3 @@ * @example feed.get({limit: 10, id_lte: 'activity-id'})
      */
-    get(options?: GetFeedOptions & NotificationFeedOptions): Promise<FeedAPIResponse<UserType, ActivityType, CollectionType, ReactionType, ChildReactionType>>;
+    get(options?: GetFeedOptions): Promise<FeedAPIResponse<UserType, ActivityType, CollectionType, ReactionType, ChildReactionType>>;
     /**
@@ -323,3 +323,3 @@ * Retrieves one activity from a feed and adds enrichment
      */
-    subscribe(callback: Faye.Callback<RealTimeMessage<UserType, ActivityType>>): Promise<Faye.Subscription>;
+    subscribe(callback: Faye.SubscribeCallback<RealTimeMessage<UserType, ActivityType>>): Promise<Faye.Subscription>;
     /**
@@ -326,0 +326,0 @@ * Cancel updates created via feed.subscribe()

lib/feed.js

@@ -301,3 +301,3 @@ "use strict";
      * @memberof StreamFeed.prototype
-     * @param {GetFeedOptions & NotificationFeedOptions}   options  Additional options
+     * @param {GetFeedOptions} options  Additional options
      * @return {Promise<FeedAPIResponse>}
@@ -304,0 +304,0 @@ * @example feed.get({limit: 10, id_lte: 'activity-id'})

lib/reaction.d.ts

@@ -91,3 +91,3 @@ import { StreamClient, APIResponse, UR } from './client';
         id: string;
-    }, data: ReactionType, { id, targetFeeds, userId, targetFeedsExtraData }?: ReactionAddOptions): Promise<ReactionAPIResponse<ReactionType>>;
+    }, data?: ReactionType, { id, targetFeeds, userId, targetFeedsExtraData }?: ReactionAddOptions): Promise<ReactionAPIResponse<ReactionType>>;
     /**
@@ -111,3 +111,3 @@ * add child reaction
         id: string;
-    }, data: ChildReactionType, { targetFeeds, userId, targetFeedsExtraData }?: ReactionAddChildOptions): Promise<ReactionAPIResponse<ChildReactionType>>;
+    }, data?: ChildReactionType, { targetFeeds, userId, targetFeedsExtraData }?: ReactionAddChildOptions): Promise<ReactionAPIResponse<ChildReactionType>>;
     /**
@@ -153,3 +153,3 @@ * get reaction
      */
-    update(id: string, data: ReactionType | ChildReactionType, { targetFeeds, targetFeedsExtraData }?: ReactionUpdateOptions): Promise<ReactionAPIResponse<ReactionType | ChildReactionType>>;
+    update(id: string, data?: ReactionType | ChildReactionType, { targetFeeds, targetFeedsExtraData }?: ReactionUpdateOptions): Promise<ReactionAPIResponse<ReactionType | ChildReactionType>>;
     /**
@@ -156,0 +156,0 @@ * delete reaction

package.json

@@ -14,3 +14,3 @@ {
   "license": "BSD-3-Clause",
-  "version": "7.2.3",
+  "version": "7.2.4",
   "scripts": {
@@ -17,0 +17,0 @@ "transpile": "babel src --out-dir lib --extensions '.ts'",

src/feed.ts

@@ -41,4 +41,2 @@ /// <reference path="../types/modules.d.ts" />
 
-export type GetFeedOptions = FeedPaginationOptions & EnrichOptions & RankedFeedOptions;
-
 export type NotificationFeedOptions = {
@@ -49,2 +47,4 @@ mark_read?: boolean | 'current' | string[];
 
+export type GetFeedOptions = FeedPaginationOptions & EnrichOptions & RankedFeedOptions & NotificationFeedOptions;
+
 export type GetFollowOptions = {
@@ -481,3 +481,3 @@ filter?: string[];
    * @memberof StreamFeed.prototype
-   * @param {GetFeedOptions & NotificationFeedOptions}   options  Additional options
+   * @param {GetFeedOptions} options  Additional options
    * @return {Promise<FeedAPIResponse>}
@@ -487,3 +487,3 @@ * @example feed.get({limit: 10, id_lte: 'activity-id'})
    */
-  get(options: GetFeedOptions & NotificationFeedOptions = {}) {
+  get(options: GetFeedOptions = {}) {
     const extraOptions: { mark_read?: boolean | string; mark_seen?: boolean | string } = {};
@@ -555,3 +555,3 @@
    */
-  subscribe(callback: Faye.Callback<RealTimeMessage<UserType, ActivityType>>) {
+  subscribe(callback: Faye.SubscribeCallback<RealTimeMessage<UserType, ActivityType>>) {
     if (!this.client.appId) {
@@ -558,0 +558,0 @@ throw new SiteError(

src/reaction.ts

@@ -151,3 +151,3 @@ import { StreamClient, APIResponse, UR } from './client';
     activity: string | { id: string },
-    data: ReactionType,
+    data?: ReactionType,
     { id, targetFeeds = [], userId, targetFeedsExtraData }: ReactionAddOptions = {},
@@ -192,3 +192,3 @@ ) {
     reaction: string | { id: string },
-    data: ChildReactionType,
+    data?: ChildReactionType,
     { targetFeeds = [], userId, targetFeedsExtraData }: ReactionAddChildOptions = {},
@@ -284,3 +284,3 @@ ) {
     id: string,
-    data: ReactionType | ChildReactionType,
+    data?: ReactionType | ChildReactionType,
     { targetFeeds = [], targetFeedsExtraData }: ReactionUpdateOptions = {},
@@ -287,0 +287,0 @@ ) {

types/modules.d.ts

@@ -17,2 +17,3 @@ declare module 'faye' {
   type Callback<T extends UR = UR> = (message: Message<T>) => unknown;
+  type SubscribeCallback<T extends UR = UR> = (data: T) => unknown;
 
@@ -27,6 +28,5 @@ type Middleware<T extends UR = UR> = {
     addExtension(extension: Middleware<T>): void;
-    subscribe(channel: string, callback: Callback<T>): Promise<Subscription>;
-
+    subscribe(channel: string, callback: SubscribeCallback<T>): Promise<Subscription>;
     disconnect(): void;
   }
 }

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

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

794900

increased by0.02%

Lines of code

15424

increased by0.01%

No dependency changes