stream-chat - npm Package Compare versions

Comparing version 6.5.1 to 6.6.0

dist/types/client.d.ts

@@ -9,3 +9,3 @@ /// <reference types="node" />
 import { WSConnectionFallback } from './connection_fallback';
-import { APIResponse, AppSettings, AppSettingsAPIResponse, BaseDeviceFields, BannedUsersFilters, BannedUsersPaginationOptions, BannedUsersResponse, BannedUsersSort, BanUserOptions, BlockList, BlockListResponse, ChannelAPIResponse, ChannelData, ChannelFilters, ChannelMute, ChannelOptions, ChannelSort, ChannelStateOptions, CheckPushResponse, CheckSQSResponse, Configs, ConnectAPIResponse, CreateChannelOptions, CreateChannelResponse, CreateCommandOptions, CreateCommandResponse, CustomPermissionOptions, DeleteCommandResponse, Device, EndpointName, Event, EventHandler, ExportChannelOptions, ExportChannelRequest, ExportChannelResponse, ExportChannelStatusResponse, MessageFlagsFilters, MessageFlagsPaginationOptions, MessageFlagsResponse, FlagMessageResponse, FlagUserResponse, GetChannelTypeResponse, GetCommandResponse, GetRateLimitsResponse, ListChannelResponse, ListCommandsResponse, Logger, MarkChannelsReadOptions, MessageFilters, MessageResponse, Mute, MuteUserOptions, MuteUserResponse, OwnUserResponse, PartialMessageUpdate, PartialUserUpdate, PermissionAPIResponse, PermissionsAPIResponse, PushProvider, PushProviderID, PushProviderConfig, PushProviderUpsertResponse, PushProviderListResponse, ReactionResponse, SearchOptions, SearchAPIResponse, SendFileAPIResponse, StreamChatOptions, TestPushDataInput, TestSQSDataInput, TokenOrProvider, UnBanUserOptions, UpdateChannelOptions, UpdateChannelResponse, UpdateCommandOptions, UpdateCommandResponse, UpdatedMessage, UpdateMessageAPIResponse, UserCustomEvent, UserFilters, UserOptions, UserResponse, UserSort, SegmentData, Segment, Campaign, CampaignData, OGAttachment, TaskStatus, DeleteUserOptions, TaskResponse, ExtendableGenerics, DefaultGenerics, ReviewFlagReportResponse, FlagReportsFilters, FlagReportsResponse, ReviewFlagReportOptions, FlagReportsPaginationOptions, ExportUsersRequest, ExportUsersResponse, CreateImportResponse, CreateImportOptions, CreateImportURLResponse, GetImportResponse, ListImportsResponse, ListImportsPaginationOptions, FlagsFilters, FlagsPaginationOptions, FlagsResponse } from './types';
+import { APIResponse, AppSettings, AppSettingsAPIResponse, BaseDeviceFields, BannedUsersFilters, BannedUsersPaginationOptions, BannedUsersResponse, BannedUsersSort, BanUserOptions, BlockList, BlockListResponse, ChannelAPIResponse, ChannelData, ChannelFilters, ChannelMute, ChannelOptions, ChannelSort, ChannelStateOptions, CheckPushResponse, CheckSQSResponse, Configs, ConnectAPIResponse, CreateChannelOptions, CreateChannelResponse, CreateCommandOptions, CreateCommandResponse, CustomPermissionOptions, DeleteCommandResponse, Device, EndpointName, Event, EventHandler, ExportChannelOptions, ExportChannelRequest, ExportChannelResponse, ExportChannelStatusResponse, MessageFlagsFilters, MessageFlagsPaginationOptions, MessageFlagsResponse, FlagMessageResponse, FlagUserResponse, GetChannelTypeResponse, GetCommandResponse, GetRateLimitsResponse, ListChannelResponse, ListCommandsResponse, Logger, MarkChannelsReadOptions, MessageFilters, MessageResponse, Mute, MuteUserOptions, MuteUserResponse, OwnUserResponse, PartialMessageUpdate, PartialUserUpdate, PermissionAPIResponse, PermissionsAPIResponse, PushProvider, PushProviderID, PushProviderConfig, PushProviderUpsertResponse, PushProviderListResponse, ReactionResponse, SearchOptions, SearchAPIResponse, SendFileAPIResponse, StreamChatOptions, TestPushDataInput, TestSQSDataInput, TokenOrProvider, UnBanUserOptions, UpdateChannelOptions, UpdateChannelResponse, UpdateCommandOptions, UpdateCommandResponse, UpdatedMessage, UpdateMessageAPIResponse, UserCustomEvent, UserFilters, UserOptions, UserResponse, UserSort, SegmentData, Segment, Campaign, CampaignData, OGAttachment, TaskStatus, DeleteUserOptions, TaskResponse, ExtendableGenerics, DefaultGenerics, ReviewFlagReportResponse, FlagReportsFilters, FlagReportsResponse, ReviewFlagReportOptions, FlagReportsPaginationOptions, ExportUsersRequest, ExportUsersResponse, CreateImportResponse, CreateImportOptions, CreateImportURLResponse, GetImportResponse, ListImportsResponse, ListImportsPaginationOptions, FlagsFilters, FlagsPaginationOptions, FlagsResponse, TestCampaignResponse, APIErrorResponse, ErrorFromResponse } from './types';
 import { InsightMetrics } from './insights';
@@ -172,3 +172,3 @@ export declare class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> {
           'development': true
-              },
+        },
         'firebase_config': {
@@ -318,10 +318,3 @@ 'server_key': 'server key from fcm',
     sendFile(url: string, uri: string | NodeJS.ReadableStream | Buffer | File, name?: string, contentType?: string, user?: UserResponse<StreamChatGenerics>): Promise<SendFileAPIResponse>;
-    errorFromResponse<T>(response: AxiosResponse<T & {
-        code?: number;
-        message?: string;
-    }>): Error & {
-        code?: number | undefined;
-        response?: AxiosResponse<T> | undefined;
-        status?: number | undefined;
-    };
+    errorFromResponse(response: AxiosResponse<APIErrorResponse>): ErrorFromResponse<APIErrorResponse>;
     handleResponse<T>(response: AxiosResponse<T>): T;
@@ -633,2 +626,4 @@ dispatchEvent: (event: Event<StreamChatGenerics>) => void;
         user: UserResponse<StreamChatGenerics>;
+    } & {
+        task_id?: string | undefined;
     }>;
@@ -1140,3 +1135,3 @@ reactivateUser(userID: string, options?: {
      * @param {string} id Campaign ID
-     * @param {{sendAt: number}} params Schedule params
+     * @param {{scheduledFor: number}} params Schedule params
      *
@@ -1146,3 +1141,3 @@ * @return {Campaign} Scheduled Campaign
     scheduleCampaign(id: string, params: {
-        sendAt: number;
+        scheduledFor: number;
     }): Promise<Campaign>;
@@ -1170,7 +1165,8 @@ /**
      * @param {{users: string[]}} params Test params
-     * @return {Campaign} Test Campaign
+     *
+     * @return {TestCampaignResponse} Test campaign response
      */
     testCampaign(id: string, params: {
         users: string[];
-    }): Promise<Campaign>;
+    }): Promise<APIResponse & TestCampaignResponse>;
     /**
@@ -1202,3 +1198,9 @@ * enrichURL - Get OpenGraph data of the given link
     }): Promise<APIResponse & {
-        result: Record<string, string>;
+        result: Record<string, string>; /**
+         * upsertUsers - Batch upsert the list of users
+         *
+         * @param {UserResponse<StreamChatGenerics>[]} users list of users
+         *
+         * @return {Promise<{ users: { [key: string]: UserResponse<StreamChatGenerics> } }>}
+         */
     } & Partial<TaskResponse>>;
@@ -1205,0 +1207,0 @@ /**

dist/types/errors.d.ts

@@ -0,1 +1,3 @@
+import { AxiosResponse } from 'axios';
+import { APIErrorResponse } from './types';
 export declare const APIErrorCodes: Record<string, {
@@ -13,3 +15,4 @@ name: string;
 export declare function isWSFailure(err: APIError): boolean;
+export declare function isErrorResponse(res: AxiosResponse<unknown>): res is AxiosResponse<APIErrorResponse>;
 export {};
 //# sourceMappingURL=errors.d.ts.map

dist/types/events.d.ts

@@ -39,2 +39,3 @@ export declare const EVENT_MAP: {
     'user.unbanned': boolean;
+    'user.unread_message_reminder': boolean;
     'user.updated': boolean;
@@ -41,0 +42,0 @@ 'user.watching.start': boolean;

package.json

 {
   "name": "stream-chat",
-  "version": "6.5.1",
+  "version": "6.6.0",
   "description": "JS SDK for the Stream Chat API",
@@ -5,0 +5,0 @@ "author": "GetStream",

src/errors.ts

@@ -0,1 +1,4 @@
+import { AxiosResponse } from 'axios';
+import { APIErrorResponse } from './types';
+
 export const APIErrorCodes: Record<string, { name: string; retryable: boolean }> = {
@@ -59,1 +62,5 @@ '-1': { name: 'InternalSystemError', retryable: true },
 }
+
+export function isErrorResponse(res: AxiosResponse<unknown>): res is AxiosResponse<APIErrorResponse> {
+  return !res.status || res.status < 200 || 300 <= res.status;
+}

src/events.ts

@@ -39,2 +39,3 @@ export const EVENT_MAP = {
   'user.unbanned': true,
+  'user.unread_message_reminder': true,
   'user.updated': true,
@@ -41,0 +42,0 @@ 'user.watching.start': true,

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

4736667

increased by8.56%

Lines of code

49994

increased by0.67%

No dependency changes