feat: customPaginator is removed from ChannelService

BREAKING CHANGE: `channelService.customPaginator` is removed, provide a custom query if you want to control pagination logic

Author: szuperaz

projects/stream-chat-angular/src/lib/channel.service.spec.ts

@@ -248,37 +248,6 @@ describe('ChannelService', () => {
     /* eslint-enable  @typescript-eslint/no-unsafe-member-access */
   });
 
-  it('should set pagination options correctly if #customPaginator is provided', async () => {
-    service.customPaginator = (
-      channelQueryResult: Channel<DefaultStreamChatGenerics>[],
-    ) => {
-      const lastChannel = channelQueryResult[channelQueryResult.length - 1];
-      if (!lastChannel) {
-        return {
-          type: 'filter',
-          paginationFilter: {},
-        };
-      } else {
-        return {
-          type: 'filter',
-          paginationFilter: {
-            cid: { $gte: lastChannel.cid },
-          },
-        };
-      }
-    };
-
-    await init();
-
-    // @ts-expect-error we know channelQuery exists, TS doesn't
-    expect(service['channelQuery']?.['nextPageConfiguration']).toEqual({
-      type: 'filter',
-      paginationFilter: {
-        cid: { $gte: jasmine.any(String) },
-      },
-    });
-  });
-
   it('should not set active channel if #shouldSetActiveChannel is false', async () => {
     const activeChannelSpy = jasmine.createSpy();
     service.activeChannel$.subscribe(activeChannelSpy);

projects/stream-chat-angular/src/lib/channel.service.ts

@@ -38,7 +38,6 @@ import {
   DefaultStreamChatGenerics,
   MessageInput,
   MessageReactionType,
-  NextPageConfiguration,
   StreamMessage,
 } from './types';
 import { ChannelQuery } from './channel-query';
@@ -360,9 +359,6 @@ export class ChannelService<
   private channelQuery?:
     | ChannelQuery<T>
     | ((queryType: ChannelQueryType) => Promise<ChannelQueryResult<T>>);
-  private _customPaginator:
-    | ((channelQueryResult: Channel<T>[]) => NextPageConfiguration)
-    | undefined;
 
   private channelListSetter = (
     channels: Channel<T>[],
@@ -533,24 +529,6 @@ export class ChannelService<
     this._shouldMarkActiveChannelAsRead = shouldMarkActiveChannelAsRead;
   }
 
-  /**
-   * By default the SDK uses an offset based pagination, you can change/extend this by providing your own custom paginator method.
-   *
-   * The method will be called with the result of the latest channel query.
-   *
-   * You can return either an offset, or a filter using the [`$lte`/`$gte` operator](/chat/docs/javascript/query_syntax_operators/). If you return a filter, it will be merged with the filter provided for the `init` method.
-   */
-  set customPaginator(
-    paginator:
-      | ((channelQueryResult: Channel<T>[]) => NextPageConfiguration)
-      | undefined,
-  ) {
-    this._customPaginator = paginator;
-    if (this.channelQuery && 'customPaginator' in this.channelQuery) {
-      this.channelQuery.customPaginator = this._customPaginator;
-    }
-  }
-
   /**
    * Sets the given `channel` as active and marks it as read.
    * If the channel wasn't previously part of the channel, it will be added to the beginning of the list.
@@ -745,7 +723,6 @@ export class ChannelService<
         ...options,
       },
     );
-    this.channelQuery.customPaginator = this._customPaginator;
 
     return this._init({
       shouldSetActiveChannel,