@amityco/ts-sdk 0.0.1-beta.43.1 → 0.0.1-beta.44.0

package/dist/message/api/queryMessages.d.ts

@@ -12,21 +12,5 @@
  * @category Message API
  * @async
  */
-export declare const queryMessages: {
-    (query: Amity.QueryMessages): Promise<Amity.Cached<Amity.Paged<Amity.Message, Amity.Page<string>>>>;
-    /**
-     * ```js
-     * import { queryMessages } from '@amityco/ts-sdk'
-     * const messages = queryMessages.locally!({ channelId })
-     * ```
-     *
-     * Queries a paginable list of {@link Amity.Message} objects from cache
-     *
-     * @param query The query parameters
-     * @returns A page of {@link Amity.Message} objects
-     *
-     * @category Message API
-     */
-    locally(query: Parameters<typeof queryMessages>[0]): Amity.Cached<Amity.Paged<Amity.Message, Amity.Page<string>>> | undefined;
-};
+export declare const queryMessages: (query: Amity.QueryMessages) => Promise<Amity.Cached<Amity.Paged<Amity.Message, Amity.Page<string>>>>;
 //# sourceMappingURL=queryMessages.d.ts.map

package/dist/message/api/queryMessages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryMessages.d.ts","sourceRoot":"","sources":["../../../src/message/api/queryMessages.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa;YACjB,MAAM,aAAa,GACzB,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,OAAO,EAAE,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAuCxE;;;;;;;;;;;;OAYG;mBAEM,WAAW,oBAAoB,CAAC,CAAC,CAAC,CAAC,GACzC,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,OAAO,EAAE,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,SAAS;CAlB1E,CAAC"}
+{"version":3,"file":"queryMessages.d.ts","sourceRoot":"","sources":["../../../src/message/api/queryMessages.ts"],"names":[],"mappings":"AAYA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa,UACjB,MAAM,aAAa,KACzB,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,OAAO,EAAE,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CA0CtE,CAAC"}

package/dist/message/utils/prepareMessagePayload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prepareMessagePayload.d.ts","sourceRoot":"","sources":["../../../src/message/utils/prepareMessagePayload.ts"],"names":[],"mappings":"AA0BA,wBAAgB,cAAc,CAC5B,OAAO,EAAE,KAAK,CAAC,UAAU,EACzB,MAAM,CAAC,EAAE,KAAK,CAAC,aAAa,GAC3B,KAAK,CAAC,OAAO,CA8Df;AAED,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,KAAK,CAAC,OAAO,EACtB,MAAM,CAAC,EAAE,KAAK,CAAC,aAAa,GAC3B,KAAK,CAAC,OAAO,CASf;AAED,eAAO,MAAM,qBAAqB,YACvB,MAAM,cAAc,KAC5B,QAAQ,MAAM,uBAAuB,CAsBvC,CAAC;AAEF,aAAK,gBAAgB,GAAG,IAAI,CAC1B,KAAK,CAAC,aAAa,EAInB,MAAM,GAAG,QAAQ,GAAG,cAAc,GAAG,MAAM,GAAG,gBAAgB,CAC/D,GAAG;IACF,WAAW,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAC1C,SAAS,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACvC,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;IACnD,OAAO,EAAE;QACP,MAAM,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACvC,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,wBAAgB,aAAa,CAAC,EAC5B,YAAY,EACZ,UAAU,EACV,GAAG,IAAI,EACR,EAAE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAE9C;AAED,wBAAgB,kBAAkB,CAAC,EACjC,IAAI,EACJ,MAAM,EACN,YAAY,EACZ,IAAI,EACJ,cAAc,EACd,GAAG,IAAI,EACR,EAAE,KAAK,CAAC,aAAa,GAAG,gBAAgB,CAiBxC"}
+{"version":3,"file":"prepareMessagePayload.d.ts","sourceRoot":"","sources":["../../../src/message/utils/prepareMessagePayload.ts"],"names":[],"mappings":"AA4BA,wBAAgB,cAAc,CAC5B,OAAO,EAAE,KAAK,CAAC,UAAU,EACzB,MAAM,CAAC,EAAE,KAAK,CAAC,aAAa,GAC3B,KAAK,CAAC,OAAO,CA8Df;AAED,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,KAAK,CAAC,OAAO,EACtB,MAAM,CAAC,EAAE,KAAK,CAAC,aAAa,GAC3B,KAAK,CAAC,OAAO,CASf;AAED,eAAO,MAAM,qBAAqB,YACvB,MAAM,cAAc,KAC5B,QAAQ,MAAM,uBAAuB,CAsBvC,CAAC;AAEF,aAAK,gBAAgB,GAAG,IAAI,CAC1B,KAAK,CAAC,aAAa,EAInB,MAAM,GAAG,QAAQ,GAAG,cAAc,GAAG,MAAM,GAAG,gBAAgB,CAC/D,GAAG;IACF,WAAW,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAC1C,SAAS,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACvC,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;IACnD,OAAO,EAAE;QACP,MAAM,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACvC,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,wBAAgB,aAAa,CAAC,EAC5B,YAAY,EACZ,UAAU,EACV,GAAG,IAAI,EACR,EAAE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAE9C;AAED,wBAAgB,kBAAkB,CAAC,EACjC,IAAI,EACJ,MAAM,EACN,YAAY,EACZ,IAAI,EACJ,cAAc,EACd,GAAG,IAAI,EACR,EAAE,KAAK,CAAC,aAAa,GAAG,gBAAgB,CAiBxC"}

package/dist/post/api/queryPosts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryPosts.d.ts","sourceRoot":"","sources":["../../../src/post/api/queryPosts.ts"],"names":[],"mappings":"AAYA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU;YACd,MAAM,UAAU,GACtB,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAmDhE;;;;;;;;;;;;OAYG;mBAEM,WAAW,iBAAiB,CAAC,CAAC,CAAC,CAAC,GACtC,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,GAAG,SAAS;CAlBlE,CAAC"}
+{"version":3,"file":"queryPosts.d.ts","sourceRoot":"","sources":["../../../src/post/api/queryPosts.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU;YACd,MAAM,UAAU,GACtB,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAmDhE;;;;;;;;;;;;OAYG;mBAEM,WAAW,iBAAiB,CAAC,CAAC,CAAC,CAAC,GACtC,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,GAAG,SAAS;CAlBlE,CAAC"}

package/dist/post/observers/livePosts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"livePosts.d.ts","sourceRoot":"","sources":["../../../src/post/observers/livePosts.ts"],"names":[],"mappings":"AAmCA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,SAAS,WACZ,MAAM,kBAAkB,YACtB,MAAM,sBAAsB,CAAC,MAAM,IAAI,CAAC,WACzC,MAAM,oBAAoB,KAClC,MAAM,YAgIR,CAAC"}
+{"version":3,"file":"livePosts.d.ts","sourceRoot":"","sources":["../../../src/post/observers/livePosts.ts"],"names":[],"mappings":"AAoCA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,SAAS,WACZ,MAAM,kBAAkB,YACtB,MAAM,sBAAsB,CAAC,MAAM,IAAI,CAAC,WACzC,MAAM,oBAAoB,KAClC,MAAM,YAoIR,CAAC"}

package/dist/subChannel/api/querySubChannels.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"querySubChannels.d.ts","sourceRoot":"","sources":["../../../src/subChannel/api/querySubChannels.ts"],"names":[],"mappings":"AAWA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,gBAAgB;YACpB,MAAM,gBAAgB,GAC5B,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,UAAU,CAAC,CAAC,CAAC;IA4CvD;;;;;;;;;;;;OAYG;mBAEM,WAAW,uBAAuB,CAAC,CAAC,CAAC,CAAC,GAC5C,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,UAAU,CAAC,CAAC,GAAG,SAAS;CAlBzD,CAAC"}
+{"version":3,"file":"querySubChannels.d.ts","sourceRoot":"","sources":["../../../src/subChannel/api/querySubChannels.ts"],"names":[],"mappings":"AAaA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,gBAAgB;YACpB,MAAM,gBAAgB,GAC5B,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,UAAU,CAAC,CAAC,CAAC;IA4CvD;;;;;;;;;;;;OAYG;mBAEM,WAAW,uBAAuB,CAAC,CAAC,CAAC,CAAC,GAC5C,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,UAAU,CAAC,CAAC,GAAG,SAAS;CAlBzD,CAAC"}

package/dist/utils/inferIsDeleted.d.ts

@@ -0,0 +1,2 @@
+export declare const inferIsDeleted: (includeDeleted?: boolean) => boolean | undefined;
+//# sourceMappingURL=inferIsDeleted.d.ts.map

package/dist/utils/inferIsDeleted.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inferIsDeleted.d.ts","sourceRoot":"","sources":["../../src/utils/inferIsDeleted.ts"],"names":[],"mappings":"AAcA,eAAO,MAAM,cAAc,oBAAqB,OAAO,KAAG,OAAO,GAAG,SACvB,CAAC"}

package/dist/utils/tests/inferIsDeleted.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=inferIsDeleted.test.d.ts.map

package/dist/utils/tests/inferIsDeleted.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inferIsDeleted.test.d.ts","sourceRoot":"","sources":["../../../src/utils/tests/inferIsDeleted.test.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk",
-  "version": "0.0.1-beta.43.1",
+  "version": "0.0.1-beta.44.0",
   "license": "CC-BY-ND-4.0",
   "author": "amity.co <developers@amity.co> (https://amity.co)",
   "description": "Amity Social Cloud Typescript SDK",

package/src/category/api/queryCategories.ts

@@ -6,6 +6,8 @@ import { pullFromCache, pushToCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { getResolver } from '~/core/model';
 
+import { inferIsDeleted } from '~/utils/inferIsDeleted';
+
 /* begin_public_function
   id: community.category.query
 */
@@ -36,7 +38,7 @@ export const queryCategories = async (
     {
       params: {
         ...params,
-        isDeleted: includeDeleted === false ? false : undefined,
+        isDeleted: inferIsDeleted(includeDeleted),
         options: {
           token: toToken(page, 'skiplimit'),
         },

package/src/category/observers/liveCategories.ts

@@ -63,7 +63,7 @@ export const liveCategories = (
         .filter(Boolean)
         .map(({ data }) => data) ?? [];
 
-    if (params.includeDeleted === false) {
+    if (!params.includeDeleted) {
       categories = filterByPropEquality(categories, 'isDeleted', false);
     }
 

package/src/category/observers/tests/liveCategories.test.ts

@@ -22,7 +22,9 @@ const getSnapshot = (params?: Record<string, any>) => {
   };
 };
 
-describe('live Caategories', () => {
+const params = { includeDeleted: true };
+
+describe('live Categories', () => {
   beforeAll(connectClient);
   afterAll(disconnectClient);
 
@@ -37,7 +39,7 @@ describe('live Caategories', () => {
     const callback = jest.fn();
     client.http.get = jest.fn().mockResolvedValue(categoryQueryResponse);
 
-    liveCategories({}, callback);
+    liveCategories(params, callback);
     await pause();
 
     expect(callback).toHaveBeenCalledTimes(2);
@@ -57,9 +59,9 @@ describe('live Caategories', () => {
     const callback = jest.fn();
     client.http.get = jest.fn().mockResolvedValue(categoryQueryResponse);
 
-    liveCategories({}, () => undefined);
+    liveCategories(params, () => undefined);
     await pause();
-    liveCategories({}, callback);
+    liveCategories(params, callback);
     await pause();
 
     expect(callback).toHaveBeenCalledTimes(2);
@@ -116,7 +118,7 @@ describe('live Caategories', () => {
       .mockResolvedValue(categoryQueryResponse)
       .mockResolvedValueOnce(categoryQueryResponsePage2);
 
-    liveCategories({}, callback);
+    liveCategories(params, callback);
     await pause();
 
     expect(callback).toHaveBeenCalled();

package/src/channel/api/tests/removeChannelMembers.test.ts

@@ -91,11 +91,10 @@ describe('removeChannelMembers', () => {
     await pause();
 
     /*
-     * Assertion below is required to check if the event handler is called with the right
-     * params. It's not enough to check if the handler does not throw
+     * Removed assertion for checking what the callback was called with as it's
+     * impossible to guarantee the order in which the events will be fired
      */
-    expect(callback).toHaveBeenNthCalledWith(1, channel1, channelUser);
-    expect(callback).toHaveBeenNthCalledWith(2, channel1, channelUser3);
+    expect(callback).toHaveBeenCalledTimes(2);
 
     unsub();
   });

package/src/channel/observers/tests/liveChannels.test.ts

@@ -9,6 +9,7 @@ import {
   client,
   connectClient,
   convertRawChannelPayload,
+  convertChannelFromRaw,
   disconnectClient,
   generateRawChannel,
   generateRawMessage,
@@ -20,7 +21,6 @@ import {
 } from '~/utils/tests';
 
 import { liveChannels } from '../liveChannels';
-import { convertFromRaw } from '../../utils';
 import * as getChannelMarkers from '../../../marker/api/getChannelMarkers';
 
 const getSnapshot = (params?: Record<string, any>) => {
@@ -99,17 +99,17 @@ describe('liveChannels', () => {
     channelId: 'deleted-channel-id',
     isDeleted: true,
   });
-  const deletedChannel = convertFromRaw(rawDeletedChannel);
+  const deletedChannel = convertChannelFromRaw(rawDeletedChannel);
   const rawTaggedChannel = generateRawChannel({
     channelId: 'tagged-channel-id',
     tags: ['tag1', 'tag2'],
   });
-  const taggedChannel = convertFromRaw(rawTaggedChannel);
+  const taggedChannel = convertChannelFromRaw(rawTaggedChannel);
   const rawTaggedChannel2 = generateRawChannel({
     channelId: 'tagged-channel-id-2',
     tags: ['tag2'],
   });
-  const taggedChannel2 = convertFromRaw(rawTaggedChannel2);
+  const taggedChannel2 = convertChannelFromRaw(rawTaggedChannel2);
 
   const filters: [string, Amity.ChannelLiveCollection, Amity.Channel[]][] = [
     ['deleted', { isDeleted: false }, [channel1, taggedChannel, taggedChannel2]],
@@ -200,13 +200,13 @@ describe('liveChannels', () => {
         'it should add new channel to collection onCreate',
         'channel.created',
         rawNewChannel,
-        [convertFromRaw(rawNewChannel), channel1, channel2],
+        [convertChannelFromRaw(rawNewChannel), channel1, channel2],
       ],
       [
         'it should add new channel to collection onJoin',
         'channel.joined',
         rawNewChannel,
-        [convertFromRaw(rawNewChannel), channel1, channel2],
+        [convertChannelFromRaw(rawNewChannel), channel1, channel2],
       ],
       [
         'it should update channel in collection onUpdate',

package/src/client/api/connectClient.ts

@@ -107,8 +107,8 @@ export const connectClient = async (
      * token expires
      */
     unsubWatcher = client.accessTokenExpiryWatcher(
-      client.token?.issuedAt!,
       client.token?.expiresAt!,
+      client.token?.issuedAt!,
       sessionHandler!,
     );
 

package/src/comment/api/queryComments.ts

@@ -5,6 +5,8 @@ import { pullFromCache, pushToCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { getResolver } from '~/core/model';
 
+import { inferIsDeleted } from '~/utils/inferIsDeleted';
+
 /* begin_public_function
   id: comment.query
 */
@@ -44,7 +46,7 @@ export const queryComments = async (
     {
       params: {
         ...params,
-        isDeleted: includeDeleted === false ? false : undefined,
+        isDeleted: inferIsDeleted(includeDeleted),
         //      filterByParentId, API-FIX: backend does not support this boolean LOL. what the hell seriously.
         options,
       },

package/src/comment/observers/liveComments.ts

@@ -82,7 +82,7 @@ export const liveComments = (
         .filter(Boolean)
         .map(({ data }) => data) ?? [];
 
-    if (params.includeDeleted === false) {
+    if (!params.includeDeleted) {
       comments = filterByPropEquality(comments, 'isDeleted', false);
     }
 

package/src/community/api/queryCommunities.ts

@@ -5,6 +5,7 @@ import { pushToCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { getResolver } from '~/core/model';
 
+import { inferIsDeleted } from '~/utils/inferIsDeleted';
 import { prepareCommunityPayload } from '../utils';
 
 /* begin_public_function
@@ -43,7 +44,7 @@ export const queryCommunities = async (
     {
       params: {
         ...restParams,
-        isDeleted: includeDeleted === false ? false : undefined,
+        isDeleted: inferIsDeleted(includeDeleted),
         keyword: displayName,
         filter: membership,
         options: {

package/src/community/api/test/queryCommunity.test.ts

@@ -89,14 +89,14 @@ describe('queryCommunities', () => {
     expect(mockFn.mock.lastCall[1].params.isDeleted).toBe(false);
   });
 
-  test('it should set isDeleted to undefined if includeDeleted is undefined', async () => {
+  test('it should set isDeleted to false if includeDeleted is undefined', async () => {
     const mockFn = jest.fn();
     client.http.get = mockFn.mockResolvedValue(resolvedGetValue);
 
     await queryCommunities(queryCriteriaWithoutPage);
 
     expect(mockFn.mock.lastCall).toHaveLength(2);
-    expect(mockFn.mock.lastCall[1].params.isDeleted).toBeUndefined();
+    expect(mockFn.mock.lastCall[1].params.isDeleted).toBe(false);
   });
 });
 

package/src/community/observers/liveCommunities.ts

@@ -78,7 +78,7 @@ export const liveCommunities = (
 
     communities = filterByPropEquality(communities, 'displayName', params.displayName);
 
-    if (params.includeDeleted === false) {
+    if (!params.includeDeleted) {
       communities = filterByPropEquality(communities, 'isDeleted', false);
     }
 

package/src/community/observers/tests/liveCommunities.test.ts

@@ -39,7 +39,7 @@ describe('liveCommunities', () => {
     const callback = jest.fn();
     client.http.get = jest.fn().mockResolvedValue(communityQueryResponse);
 
-    liveCommunities({}, callback);
+    liveCommunities({ includeDeleted: true }, callback);
     await pause();
 
     expect(callback).toHaveBeenCalledTimes(2);
@@ -59,9 +59,9 @@ describe('liveCommunities', () => {
     const callback = jest.fn();
     client.http.get = jest.fn().mockResolvedValue(communityQueryResponse);
 
-    liveCommunities({}, () => undefined);
+    liveCommunities({ includeDeleted: true }, () => undefined);
     await pause();
-    liveCommunities({}, callback);
+    liveCommunities({ includeDeleted: true }, callback);
     await pause();
 
     expect(callback).toHaveBeenCalledTimes(2);
@@ -86,9 +86,9 @@ describe('liveCommunities', () => {
 
   const filters: [string, Amity.CommunityLiveCollection, Amity.Community[]][] = [
     ['not deleted', { includeDeleted: false }, [community2]],
-    ['categoryId', { categoryId: 'test-category-id' }, [community1]],
-    ['displayName', { displayName: 'community 1' }, [community1]],
-    ['tagged', { tags: ['test-community-tag'] }, [community1]],
+    ['categoryId', { categoryId: 'test-category-id', includeDeleted: true }, [community1]],
+    ['displayName', { displayName: 'community 1', includeDeleted: true }, [community1]],
+    ['tagged', { tags: ['test-community-tag'], includeDeleted: true }, [community1]],
   ];
 
   test.each(filters)('it should filter by %s communities', async (filter, params, expected) => {
@@ -121,7 +121,7 @@ describe('liveCommunities', () => {
       .mockResolvedValue(communityQueryResponse)
       .mockResolvedValueOnce(communityQueryResponsePage2);
 
-    liveCommunities({}, callback);
+    liveCommunities({ includeDeleted: true }, callback);
     await pause();
 
     expect(callback).toHaveBeenCalled();

package/src/core/query/filtering.ts

@@ -136,3 +136,41 @@ export const filterByCommunityMembership = <T extends Amity.Community>(
     return !communityUser || communityUser.communityMembership !== 'none';
   });
 };
+
+/**
+ * Filter a post collection by dataType
+ *
+ * @param collection the post to filter
+ * @param dataTypes of the post to be filtered by
+ * @returns a filtered collection with items only matching the criteria
+ *
+ * @hidden
+ */
+export const filterByPostDataTypes = <T extends Amity.Post>(
+  collection: T[],
+  dataTypes: Amity.PostLiveCollection['dataTypes'],
+): T[] => {
+  const filteredPosts: T[] = [];
+
+  collection.forEach(c => {
+    /*
+     * A text post with no children is just a text post
+     */
+    if (c.dataType === 'text' && !c.children.length) return;
+
+    if (c.children.length) {
+      const childPost = pullFromCache<Amity.Post>(['post', 'get', c.children[0]])?.data;
+
+      if (childPost && dataTypes?.includes(childPost?.dataType)) {
+        // @ts-ignore
+        filteredPosts.push(childPost);
+      }
+
+      return;
+    }
+
+    if (dataTypes?.includes(c.dataType)) filteredPosts.push(c);
+  });
+
+  return filteredPosts;
+};

package/src/message/api/queryMessages.ts

@@ -2,7 +2,9 @@ import { getActiveClient } from '~/client/api';
 
 import { fireEvent } from '~/core/events';
 import { toPageRaw } from '~/core/query';
-import { pullFromCache } from '~/cache/api';
+import { pushToCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { getResolver } from '~/core/model';
 import { convertQueryParams, prepareMessagePayload } from '../utils';
 
 /* begin_public_function
@@ -47,12 +49,18 @@ export const queryMessages = async (
 
   const cachedAt = client.cache && Date.now();
 
-  // if (client.cache) {
-  //   ingestInCache(data, { cachedAt });
-  //
-  //   const cacheKey = ['message', 'query', params as Amity.Serializable];
-  //   pushToCache(cacheKey, { messages: messages.map(getResolver('message')), paging });
-  // }
+  if (client.cache) {
+    /*
+     * queryMessages.locally is unsupported for messages as message list updates
+     * frequently and leads to bugs when user switches between channels, i.e. when
+     * the public function (live messages) calls unmount. The list fetched on
+     * after from the cache is stale.
+     */
+    ingestInCache(data, { cachedAt });
+
+    const cacheKey = ['message', 'query', params as Amity.Serializable];
+    pushToCache(cacheKey, { messages: messages.map(getResolver('message')), paging });
+  }
 
   fireEvent('local.message.fetched', { messages });
 
@@ -62,46 +70,3 @@ export const queryMessages = async (
   return { data: messages, cachedAt, prevPage, nextPage };
 };
 /* end_public_function */
-
-/**
- * ```js
- * import { queryMessages } from '@amityco/ts-sdk'
- * const messages = queryMessages.locally!({ channelId })
- * ```
- *
- * Queries a paginable list of {@link Amity.Message} objects from cache
- *
- * @param query The query parameters
- * @returns A page of {@link Amity.Message} objects
- *
- * @category Message API
- */
-queryMessages.locally = (
-  query: Parameters<typeof queryMessages>[0],
-): Amity.Cached<Amity.Paged<Amity.Message, Amity.Page<string>>> | undefined => {
-  const client = getActiveClient();
-  client.log('message/queryMessages.locally', query);
-
-  if (!client.cache) return;
-
-  const params = convertQueryParams(query);
-
-  const queryKey = ['message', 'query', params as Amity.Serializable];
-  const { data, cachedAt } =
-    pullFromCache<{ messages: Pick<Amity.Message, 'messageId'>[] } & Amity.Pagination>(queryKey) ??
-    {};
-
-  if (!data?.messages.length) return;
-
-  const messages: Amity.Message[] = data.messages
-    .map(messageId => pullFromCache<Amity.Message>(['message', 'get', messageId])!)
-    .filter(Boolean)
-    .map(({ data }) => data);
-
-  const prevPage = toPageRaw(data?.paging.previous);
-  const nextPage = toPageRaw(data?.paging.next);
-
-  return messages.length === data?.messages?.length
-    ? { data: messages, cachedAt, prevPage, nextPage }
-    : undefined;
-};

package/src/message/api/tests/queryMessages.test.ts

@@ -106,48 +106,13 @@ describe('queryMessages', () => {
     expect(mockFn.mock.lastCall[1].params.isDeleted).toBe(false);
   });
 
-  test('it should set isDeleted to undefined if includeDeleted is undefined', async () => {
+  test('it should set isDeleted to false if includeDeleted is undefined', async () => {
     const mockFn = jest.fn();
     client.http.get = mockFn.mockResolvedValue(getResolvedMessageValue());
 
     await queryMessages(queryCriteriaWithoutPage);
 
     expect(mockFn.mock.lastCall).toHaveLength(2);
-    expect(mockFn.mock.lastCall[1].params.isDeleted).toBeUndefined();
-  });
-});
-
-describe('queryMessages.locally', () => {
-  beforeEach(() => enableCache());
-  afterEach(() => disableCache());
-
-  test('should return cached messages', () => {
-    messagesToQuery.forEach(message => pushToCache(['message', 'get', message.messageId], message));
-
-    pushToCache(['message', 'query', convertQueryParams(queryCriteria)], {
-      messages: messageIds,
-      paging,
-    });
-
-    expect(queryMessages.locally(queryCriteria)).toEqual(
-      expect.objectContaining({
-        data: messagesToQuery,
-        prevPage: undefined,
-        nextPage,
-      }),
-    );
-  });
-
-  test(`shouldn't return if individual message cache not exist`, () => {
-    pushToCache(['message', 'query', convertQueryParams(queryCriteria)], {
-      messages: messageIds,
-      paging,
-    });
-
-    expect(queryMessages.locally(queryCriteria)).toBeUndefined();
-  });
-
-  test('it should return undefined if message not in cache', () => {
-    expect(queryMessages.locally({ subChannelId: 'non-existent' })).toBeUndefined();
+    expect(mockFn.mock.lastCall[1].params.isDeleted).toBe(false);
   });
 });

package/src/message/observers/liveMessages.ts

@@ -76,7 +76,7 @@ export const liveMessages = (
      * for cases when message is deleted via RTE, this flag is used to get
      * items from cache that are !deleted
      */
-    if (params.includeDeleted === false) {
+    if (!params.includeDeleted) {
       messages = filterByPropEquality(messages, 'isDeleted', false);
     }
 
@@ -97,6 +97,7 @@ export const liveMessages = (
     collection.data = [...new Set([message.messageId, ...collection.data])];
 
     pushToCache(cacheKey, collection);
+    disposers.push(() => dropFromCache(cacheKey));
 
     responder(collection);
   };
@@ -152,6 +153,5 @@ export const liveMessages = (
   return () => {
     log(`liveMessages(tmpid: ${timestamp}) > dispose`);
     disposers.forEach(fn => fn());
-    dropFromCache(cacheKey);
   };
 };

package/src/message/tests/observers/liveMessage.test.ts

@@ -58,7 +58,7 @@ describe('liveMessage', () => {
   ];
 
   test.each(events)('%s', async (test, event) => {
-    await disableCache();
+    disableCache();
     const snapshot = getSnapshot();
 
     // mock response of queryMessages and validate

package/src/message/tests/observers/liveMessages.test.ts

@@ -201,7 +201,7 @@ describe('liveMessages', () => {
         },
       });
 
-    liveMessages({ subChannelId }, callback);
+    liveMessages({ subChannelId, includeDeleted: true }, callback);
 
     expect(callback).toHaveBeenCalled();
 

package/src/message/utils/prepareMessagePayload.ts

@@ -4,6 +4,8 @@ import { toToken } from '~/core/query';
 import { getMessageMarkers } from '~/marker/api';
 import { prepareMessagePayloadForCache } from '~/reaction/utils/prepareMessagePayloadForCache';
 
+import { inferIsDeleted } from '~/utils/inferIsDeleted';
+
 const getCachedMarker = (message: Amity.Message | Amity.RawMessage) => {
   const key = {
     creatorId: message.creatorId,
@@ -166,7 +168,7 @@ export function convertQueryParams({
   const out: RawQueryMessages = {
     ...rest,
     messageFeedId: subChannelId,
-    isDeleted: includeDeleted === false ? false : undefined,
+    isDeleted: inferIsDeleted(includeDeleted),
     options: { token: toToken(page || { limit: 10 }, 'afterbeforeraw')! },
   };
 

package/src/post/api/queryPosts.ts

@@ -5,7 +5,9 @@ import { toToken, toPageRaw } from '~/core/query';
 import { pullFromCache, pushToCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { getResolver } from '~/core/model';
+
 import { prepareMembershipPayload } from '~/group/utils';
+import { inferIsDeleted } from '~/utils/inferIsDeleted';
 
 /* begin_public_function
   id: post.query, feed.query.community_feed, feed.query.user_feed
@@ -39,7 +41,7 @@ export const queryPosts = async (
   const { data } = await client.http.get<Amity.PostPayload & Amity.Pagination>(`/api/v4/posts`, {
     params: {
       ...params,
-      isDeleted: includeDeleted === false ? false : undefined,
+      isDeleted: inferIsDeleted(includeDeleted),
       /*
        * when creating post like image, file, video BE will create 2 posts
        * 1. parent post to store text with dataType=text

package/src/post/observers/livePosts.ts

@@ -7,6 +7,7 @@ import {
   createQuery,
   filterByFeedType,
   filterByPropEquality,
+  filterByPostDataTypes,
   queryOptions,
   runQuery,
   sortByFirstCreated,
@@ -89,7 +90,7 @@ export const livePosts = (
     const sortBy = params.sortBy ? params.sortBy : 'lastCreated';
     posts = posts.sort(sortBy === 'lastCreated' ? sortByLastCreated : sortByFirstCreated);
 
-    if (params.includeDeleted === false) {
+    if (!params.includeDeleted) {
       posts = filterByPropEquality(posts, 'isDeleted', false);
     }
 
@@ -101,6 +102,10 @@ export const livePosts = (
       posts = filterByFeedType(posts, params.feedType);
     }
 
+    if (params.dataTypes?.length) {
+      posts = filterByPostDataTypes(posts, params.dataTypes);
+    }
+
     callback({
       onNextPage: onFetch,
       data: posts,
@@ -127,6 +132,7 @@ export const livePosts = (
     }
 
     pushToCache(cacheKey, collection);
+    disposers.push(() => dropFromCache(cacheKey));
 
     responder(collection);
   };
@@ -183,6 +189,5 @@ export const livePosts = (
   return () => {
     log(`livePosts(tmpid: ${timestamp}) > dispose`);
     disposers.forEach(fn => fn());
-    dropFromCache(cacheKey);
   };
 };