@stream-io/feeds-client 0.1.11 → 0.2.1

package/dist/src/test-utils/response-generators.d.ts

@@ -1,4 +1,5 @@
-import { FeedResponse, FollowResponse, OwnUser, OwnUserResponse, UserResponse } from '../gen/models';
+import { ActivityPinResponse, ActivityResponse, BookmarkFolderResponse, BookmarkResponse, FeedResponse, FeedsReactionResponse, FollowResponse, OwnUser, OwnUserResponse, UserResponse } from '../gen/models';
+import { EventPayload } from '../types-internal';
 export declare const getHumanId: () => string;
 export declare const generateUserResponse: (overrides?: Partial<UserResponse>) => UserResponse;
 export declare const generateOwnUserResponse: (overrides?: Partial<OwnUserResponse>) => OwnUserResponse;
@@ -7,3 +8,47 @@ export declare const generateFeedResponse: (overrides?: Omit<Partial<FeedRespons
     created_by?: Partial<UserResponse>;
 }) => FeedResponse;
 export declare const generateFollowResponse: (overrides?: Partial<FollowResponse>) => FollowResponse;
+export declare const generateActivityResponse: (overrides?: Omit<Partial<ActivityResponse>, "user"> & {
+    user?: Partial<UserResponse>;
+}) => ActivityResponse;
+export declare const generateFeedReactionResponse: (overrides?: Omit<Partial<FeedsReactionResponse>, "user"> & {
+    user?: Partial<UserResponse>;
+}) => FeedsReactionResponse;
+export declare const generateActivityPinResponse: (overrides?: Omit<Partial<ActivityPinResponse>, "activity" | "user"> & {
+    activity?: Partial<ActivityResponse>;
+    user?: Partial<UserResponse>;
+}) => ActivityPinResponse;
+export declare const generateBookmarkFolderResponse: (overrides?: Partial<BookmarkFolderResponse>) => BookmarkFolderResponse;
+export declare const generateBookmarkResponse: (overrides?: Omit<Partial<BookmarkResponse>, "activity" | "user"> & {
+    activity?: Partial<ActivityResponse>;
+    user?: Partial<UserResponse>;
+}) => BookmarkResponse;
+export declare function generateActivityReactionAddedEvent(overrides?: Omit<Partial<EventPayload<'feeds.activity.reaction.added'>>, 'activity' | 'type' | 'reaction' | 'user'> & {
+    activity?: Parameters<typeof generateActivityResponse>[0];
+    reaction?: Parameters<typeof generateFeedReactionResponse>[0];
+    user?: Parameters<typeof generateUserResponse>[0];
+}): EventPayload<'feeds.activity.reaction.added'>;
+export declare function generateActivityReactionDeletedEvent(overrides?: Omit<Partial<EventPayload<'feeds.activity.reaction.deleted'>>, 'user' | 'activity' | 'reaction'> & {
+    activity?: Parameters<typeof generateActivityResponse>[0];
+    reaction?: Parameters<typeof generateFeedReactionResponse>[0];
+    user?: Parameters<typeof generateUserResponse>[0];
+}): EventPayload<'feeds.activity.reaction.deleted'>;
+export declare function generateActivityUpdatedEvent(overrides?: Omit<Partial<EventPayload<'feeds.activity.updated'>>, 'activity' | 'type'> & {
+    activity?: Parameters<typeof generateActivityResponse>[0];
+}): EventPayload<'feeds.activity.updated'>;
+export declare function generateBookmarkAddedEvent(overrides?: Omit<Partial<EventPayload<'feeds.bookmark.added'>>, 'bookmark' | 'user'> & {
+    bookmark?: Parameters<typeof generateBookmarkResponse>[0];
+    user?: Parameters<typeof generateUserResponse>[0];
+}): EventPayload<'feeds.bookmark.added'>;
+export declare function generateBookmarkDeletedEvent(overrides?: Omit<Partial<EventPayload<'feeds.bookmark.deleted'>>, 'bookmark' | 'user'> & {
+    bookmark?: Parameters<typeof generateBookmarkResponse>[0];
+    user?: Parameters<typeof generateUserResponse>[0];
+}): EventPayload<'feeds.bookmark.deleted'>;
+export declare function generateBookmarkUpdatedEvent(overrides?: Omit<Partial<EventPayload<'feeds.bookmark.updated'>>, 'bookmark' | 'user'> & {
+    bookmark?: Parameters<typeof generateBookmarkResponse>[0];
+    user?: Parameters<typeof generateUserResponse>[0];
+}): EventPayload<'feeds.bookmark.updated'>;
+export declare function generateActivityPinnedEvent(overrides?: Omit<Partial<EventPayload<'feeds.activity.pinned'>>, 'pinned_activity' | 'user'> & {
+    pinned_activity?: Parameters<typeof generateActivityPinResponse>[0];
+    user?: Parameters<typeof generateUserResponse>[0];
+}): EventPayload<'feeds.activity.pinned'>;

package/dist/src/utils/index.d.ts

@@ -3,3 +3,4 @@ export * from './unique-array-merge';
 export * from './constants';
 export * from './type-assertions';
 export * from './state-update-queue';
+export * from './update-entity-in-array';

package/dist/src/utils/update-entity-in-array.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Utility function through which you can update an entity in an array;
+ *
+ * - if the entity is not found, it returns the original array unchanged
+ * - if the entity is found and updated, it returns a new array with the updated entity
+ * - if the entity is found but not updated (updater returns `matchedEntity`), it returns the original array unchanged
+ *
+ * - `changed: boolean` indicates whether the array has changed or not - this is QOL enhancement, you
+ * can compare returned array to the original one
+ *
+ */
+export declare function updateEntityInArray<T>(_: {
+    matcher: (entity: T) => boolean;
+    entities: T[];
+    updater: (currentEntity: T) => T;
+}): {
+    changed: boolean;
+    entities: T[];
+};
+export declare function updateEntityInArray<T>(_: {
+    matcher: (entity: T) => boolean;
+    entities: T[] | undefined;
+    updater: (currentEntity: T) => T;
+}): {
+    changed: boolean;
+    entities: T[] | undefined;
+};