stream-chat 9.50.3 → 10.0.0-rc.2

package/dist/types/offline-support/types.d.ts

@@ -1,4 +1,4 @@
-import type { AppSettingsAPIResponse, ChannelAPIResponse, ChannelFilters, ChannelMemberResponse, ChannelOptions, ChannelResponse, ChannelSort, DraftResponse, LocalMessage, MessageResponse, PollResponse, ReactionFilters, ReactionResponse, ReactionSort, ReadResponse } from '../types';
+import type { ChannelFilters, ChannelMemberResponse, ChannelOptions, ChannelResponse, ChannelSort, ChannelStateResponseFields, DraftResponse, GetApplicationResponse, LocalMessage, MessageResponse, PollResponse_old, QueryChannelsRequest, ReactionFilters, ReactionResponse, ReactionSort, ReadStateResponse } from '../types';
 import type { Channel } from '../channel';
 import type { StreamChat } from '../client';
 export type PrepareBatchDBQueries = [string] | [string, Array<unknown> | Array<Array<unknown>>];
@@ -6,7 +6,7 @@ export type PrepareBatchDBQueries = [string] | [string, Array<unknown> | Array<A
  * Options to insert a reaction into a message.
  */
 export type DBInsertReactionType = {
-    /** Message to which the reaction is applied. */
+    /** MessageRequest to which the reaction is applied. */
     message: MessageResponse | LocalMessage;
     /** The reaction to insert. */
     reaction: ReactionResponse;
@@ -33,7 +33,7 @@ export type DBUpsertCidsForQueryType = {
  */
 export type DBUpsertChannelsType = {
     /** Array of channel API responses. */
-    channels: ChannelAPIResponse[];
+    channels: ChannelStateResponseFields[];
     /** Whether to immediately execute the operation. */
     execute?: boolean;
     /** If true, marks that the latest messages are already set. */
@@ -44,7 +44,7 @@ export type DBUpsertChannelsType = {
  */
 export type DBUpsertAppSettingsType = {
     /** App settings data. */
-    appSettings: AppSettingsAPIResponse;
+    appSettings: GetApplicationResponse;
     /** ID of the user the settings belong to. */
     userId: string;
     /** Whether to immediately execute the operation. */
@@ -66,7 +66,7 @@ export type DBUpsertUserSyncStatusType = {
  */
 export type DBUpsertPollType = {
     /** Poll data to be stored. */
-    poll: PollResponse;
+    poll: PollResponse_old;
     /** Whether to immediately execute the operation. */
     execute?: boolean;
 };
@@ -86,7 +86,7 @@ export type DBUpsertReadsType = {
     /** Channel ID. */
     cid: string;
     /** Array of read statuses. */
-    reads: ReadResponse[];
+    reads: ReadStateResponse[];
     /** Whether to immediately execute the operation. */
     execute?: boolean;
 };
@@ -114,7 +114,7 @@ export type DBUpsertMembersType = {
  * Options to update a reaction.
  */
 export type DBUpdateReactionType = {
-    /** Message associated with the reaction. */
+    /** MessageRequest associated with the reaction. */
     message: MessageResponse | LocalMessage;
     /** The updated reaction. */
     reaction: ReactionResponse;
@@ -125,7 +125,7 @@ export type DBUpdateReactionType = {
  * Options to update a message.
  */
 export type DBUpdateMessageType = {
-    /** Message to update. */
+    /** MessageRequest to update. */
     message: MessageResponse | LocalMessage;
     /** Whether to immediately execute the operation. */
     execute?: boolean;
@@ -146,14 +146,10 @@ export type DBGetChannelsForQueryType = {
     /** ID of the user. */
     userId: string;
     /** Optional filters for channels. */
-    filters?: ChannelFilters;
-    /** Optional full query options for channels. */
-    options?: ChannelOptions;
-    /** Optional sorting for the channels. */
-    sort?: ChannelSort;
+    options?: QueryChannelsRequest;
 };
 /**
- * Get the last sync timestamp for a user.
+ * Payload for retrieving the last sync timestamp for a user.
  */
 export type DBGetLastSyncedAtType = {
     /** ID of the user. */
@@ -167,7 +163,7 @@ export type DBGetPendingTasksType = {
     messageId?: string;
 };
 /**
- * Get application settings for a user.
+ * Payload for retrieving application settings for a user.
  */
 export type DBGetAppSettingsType = {
     /** ID of the user. */
@@ -180,21 +176,21 @@ export type DBGetReactionsType = {
     /** ID of the message. */
     messageId: string;
     /** Optional filter to apply to reactions. */
-    filters?: Pick<ReactionFilters, 'type'>;
+    filters?: ReactionFilters;
     /** Optional sorting for reactions. */
     sort?: ReactionSort;
     /** Optional maximum number of reactions to return. */
     limit?: number;
 };
 /**
- * Delete a pending task by ID.
+ * Payload for deleting a pending task by ID.
  */
 export type DBDeletePendingTaskType = {
     /** ID of the pending task. */
     id: number;
 };
 /**
- * Update a pending task by ID.
+ * Payload for updating a pending task by ID.
  */
 export type DBUpdatePendingTaskType = {
     /** ID of the pending task. */
@@ -260,12 +256,12 @@ export type DBDeleteMessagesForChannelType = {
     /** Channel ID. */
     cid: string;
     /** Timestamp before which messages are deleted. */
-    truncated_at?: string;
+    truncated_at?: Date;
     /** Whether to immediately execute the operation. */
     execute?: boolean;
 };
 /**
- * Check if a channel exists by ID.
+ * Payload for checking whether a channel exists by ID.
  */
 export type DBChannelExistsType = {
     /** Channel ID. */
@@ -312,11 +308,11 @@ export interface OfflineDBApi {
     updateReaction: (options: DBUpdateReactionType) => Promise<ExecuteBatchDBQueriesType>;
     updateMessage: (options: DBUpdateMessageType) => Promise<ExecuteBatchDBQueriesType>;
     getDraft: (options: DBGetDraftType) => Promise<DraftResponse | null>;
-    getChannels: (options: DBGetChannelsType) => Promise<Omit<ChannelAPIResponse, 'duration'>[] | null>;
-    getChannelsForQuery: (options: DBGetChannelsForQueryType) => Promise<Omit<ChannelAPIResponse, 'duration'>[] | null>;
+    getChannels: (options: DBGetChannelsType) => Promise<Omit<ChannelStateResponseFields, 'duration'>[] | null>;
+    getChannelsForQuery: (options: DBGetChannelsForQueryType) => Promise<Omit<ChannelStateResponseFields, 'duration'>[] | null>;
     getAllChannelCids: () => Promise<string[]>;
     getLastSyncedAt: (options: DBGetLastSyncedAtType) => Promise<string | undefined>;
-    getAppSettings: (options: DBGetAppSettingsType) => Promise<AppSettingsAPIResponse | null>;
+    getAppSettings: (options: DBGetAppSettingsType) => Promise<GetApplicationResponse | null>;
     getReactions: (options: DBGetReactionsType) => Promise<ReactionResponse[] | null>;
     executeSqlBatch: (queries: ExecuteBatchDBQueriesType) => Promise<unknown>;
     addPendingTask: (task: PendingTask) => Promise<() => Promise<void>>;

package/dist/types/offline-support/util.d.ts

@@ -1,7 +1,9 @@
-import type { Attachment, LocalMessage, MessageResponse } from '../types';
+import type { Attachment } from '../types';
 export declare const isLocalUrl: (value: string | undefined) => boolean;
 export declare const isAttachmentReplayable: (attachment: Attachment) => boolean;
-export declare const isMessageUpdateReplayable: (message: LocalMessage | Partial<MessageResponse>) => boolean;
+export declare const isMessageUpdateReplayable: (minimalMessage: {
+    attachments?: Attachment[];
+}) => boolean;
 export declare const getPendingTaskChannelData: (cid?: string) => {
     channelId?: undefined;
     channelType?: undefined;

package/dist/types/pagination/FilterBuilder.d.ts

@@ -21,7 +21,7 @@ export type FilterBuilderGenerators<TFilters, TContext extends Record<string, un
         generate: (context: TContext) => Partial<TFilters> | null;
     };
 };
-export type FilterBuilderOptions<TFilters, TContext extends Record<string, unknown>> = {
+export type FilterBuilderOptions<TFilters, TContext extends Record<string, unknown> = Record<string, unknown>> = {
     initialFilterConfig?: FilterBuilderGenerators<TFilters, TContext>;
     initialContext?: TContext;
 };

package/dist/types/pagination/ItemIndex.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The minimal CRUD surface a paginator relies on from its item index.
+ *
+ * The sole implementation is {@link StoreBackedItemIndex}: backed by a shared, client-global store
+ * it dedupes content across collections and fans changes out to every holder; backed by a private
+ * store (the default, owner-less mode) it behaves as a plain per-instance index. Keeping this as an
+ * interface lets `BasePaginator` stay agnostic to which backing a given paginator uses.
+ *
+ * @template T The domain item type managed by the index.
+ */
+export interface ItemIndexApi<T> {
+    setMany(items: T[]): void;
+    setOne(item: T): void;
+    get(id: string): T | undefined;
+    has(id: string): boolean;
+    remove(id: string): void;
+    clear(): void;
+    entries(): [string, T][];
+    values(): T[];
+    /**
+     * Runs `fn`, coalescing any change notifications it produces into a single flush. A private-store
+     * (owner-less) index has nothing to fan out and simply runs `fn`.
+     */
+    batch<R>(fn: () => R): R;
+}

package/dist/types/pagination/cursorDerivation/createdAtAroundPaginationFlags.d.ts

@@ -0,0 +1,9 @@
+import type { BasePaginator, CursorDeriveContext, PaginationFlags } from '../paginators';
+export declare const deriveCreatedAtAroundPaginationFlags: <T extends {
+    id: string;
+    created_at: Date;
+}, Q extends {
+    created_at_around?: Date | string;
+}, P extends BasePaginator<T, Q>>({ hasMoreHead, hasMoreTail, interval, page, paginator, queryShape, requestedPageSize, }: CursorDeriveContext<T, Q> & {
+    paginator: P;
+}) => PaginationFlags;

package/dist/types/pagination/cursorDerivation/idAroundPaginationFlags.d.ts

@@ -0,0 +1,6 @@
+import type { CursorDeriveContext, PaginationFlags } from '../paginators';
+export declare const deriveIdAroundPaginationFlags: <T extends {
+    id: string;
+}, Q extends {
+    id_around?: string;
+}>({ hasMoreHead, hasMoreTail, interval, page, queryShape, requestedPageSize, }: CursorDeriveContext<T, Q>) => PaginationFlags;

package/dist/types/pagination/cursorDerivation/index.d.ts

@@ -0,0 +1 @@
+export * from './createdAtAroundPaginationFlags';

package/dist/types/pagination/cursorDerivation/linearPaginationFlags.d.ts

@@ -0,0 +1,6 @@
+import type { CursorDeriveContext, PaginationFlags } from '../paginators';
+import type { PaginationOptions } from '../../types';
+export declare const deriveLinearPaginationFlags: <T extends {
+    id: string;
+    created_at: Date;
+}, Q extends PaginationOptions>({ direction, hasMoreHead, hasMoreTail, interval, page, queryShape, requestedPageSize, }: CursorDeriveContext<T, Q>) => PaginationFlags;

package/dist/types/pagination/filterCompiler.d.ts

@@ -0,0 +1,7 @@
+import type { FieldToDataResolver } from './types.normalization';
+import type { QueryFilters } from '../types';
+export type ItemMatchesFilterOptions<DataSource> = {
+    /** Custom resolvers to extract values from an item given a path */
+    resolvers?: ReadonlyArray<FieldToDataResolver<DataSource>>;
+};
+export declare function itemMatchesFilter<T>(item: T, filter: QueryFilters<any>, options: ItemMatchesFilterOptions<T>): boolean;

package/dist/types/pagination/index.d.ts

@@ -1,4 +1,2 @@
-export * from './BasePaginator';
+export * from './paginators';
 export * from './FilterBuilder';
-export * from './ReminderPaginator';
-export * from './UserGroupPaginator';