@amityco/ts-sdk 6.3.1 → 6.3.2-de32ca2.0

package/dist/userRepository/observers/index.d.ts

@@ -2,4 +2,5 @@ export { getUser } from './getUser';
 export { getUsers } from './getUsers';
 export { observeUser } from './observeUser';
 export { getBlockedUsers } from './getBlockedUsers';
+export { searchUserByDisplayName } from './searchUserByDisplayName';
 //# sourceMappingURL=index.d.ts.map

package/dist/userRepository/observers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/userRepository/observers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/userRepository/observers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC"}

package/dist/userRepository/observers/searchUserByDisplayName.d.ts

@@ -0,0 +1,19 @@
+/**
+ * ```js
+ * import { UserRepository } from '@amityco/ts-sdk'
+ *
+ * let users = []
+ * const unsub = UserRepository.searchUserByDisplayName({}, response => merge(users, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.User}s
+ *
+ * @param params for searching users
+ * @param callback the function to call when new data are available
+ * @param config the configuration for the live collection
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the users
+ *
+ * @category Category Live Collection
+ */
+export declare const searchUserByDisplayName: (params: Amity.UserSearchLiveCollection, callback: Amity.LiveCollectionCallback<Amity.User>, config?: Amity.LiveCollectionConfig) => () => void;
+//# sourceMappingURL=searchUserByDisplayName.d.ts.map

package/dist/userRepository/observers/searchUserByDisplayName.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchUserByDisplayName.d.ts","sourceRoot":"","sources":["../../../src/userRepository/observers/searchUserByDisplayName.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,uBAAuB,WAC1B,MAAM,wBAAwB,YAC5B,MAAM,sBAAsB,CAAC,MAAM,IAAI,CAAC,WACzC,MAAM,oBAAoB,eAGpC,CAAC"}

package/dist/userRepository/observers/tests/searchUserByDisplayName.test.d.ts

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

package/dist/userRepository/observers/tests/searchUserByDisplayName.test.d.ts.map

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

package/package.json

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

package/src/@types/domains/user.ts

@@ -34,6 +34,8 @@ declare global {
 
     type UserLiveCollection = Amity.LiveCollectionParams<Omit<QueryUsers, 'page'>>;
 
+    type UserSearchLiveCollection = Amity.LiveCollectionParams<Omit<QueryUsers, 'sortBy'>>;
+
     type UserLiveCollectionCache = Amity.LiveCollectionCache<
       Amity.User['userId'],
       Pick<QueryUsers, 'page'>

package/src/userRepository/observers/getUsers.ts

@@ -29,7 +29,7 @@ import {
 } from '../events';
 
 /* begin_public_function
-  id: user.query, user.search
+  id: user.query
 */
 /**
  * ```js

package/src/userRepository/observers/index.ts

@@ -2,3 +2,4 @@ export { getUser } from './getUser';
 export { getUsers } from './getUsers';
 export { observeUser } from './observeUser';
 export { getBlockedUsers } from './getBlockedUsers';
+export { searchUserByDisplayName } from './searchUserByDisplayName';

package/src/userRepository/observers/searchUserByDisplayName.ts

@@ -0,0 +1,30 @@
+import { getUsers } from './getUsers';
+
+/* begin_public_function
+  id: user.search
+*/
+/**
+ * ```js
+ * import { UserRepository } from '@amityco/ts-sdk'
+ *
+ * let users = []
+ * const unsub = UserRepository.searchUserByDisplayName({}, response => merge(users, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.User}s
+ *
+ * @param params for searching users
+ * @param callback the function to call when new data are available
+ * @param config the configuration for the live collection
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the users
+ *
+ * @category Category Live Collection
+ */
+export const searchUserByDisplayName = (
+  params: Amity.UserSearchLiveCollection,
+  callback: Amity.LiveCollectionCallback<Amity.User>,
+  config?: Amity.LiveCollectionConfig,
+) => {
+  return getUsers({ ...params, filter: 'all' }, callback, config);
+};
+/* end_public_function */

package/src/userRepository/observers/tests/searchUserByDisplayName.test.ts

@@ -0,0 +1,113 @@
+import { disableCache, enableCache } from '~/cache/api';
+import {
+  client,
+  connectClient,
+  disconnectClient,
+  pause,
+  user21,
+  userQueryResponse,
+  userQueryResponsePage2,
+} from '~/utils/tests';
+
+import { searchUserByDisplayName } from '../searchUserByDisplayName';
+
+const getSnapshot = (params?: Record<string, any>) => {
+  return {
+    data: [] as Amity.User[],
+    loading: true,
+    error: undefined as any,
+    ...params,
+  };
+};
+
+const { paging, ...payload } = userQueryResponse.data;
+const { paging: paging2, ...payload2 } = userQueryResponsePage2.data;
+
+describe('searchUserByDisplayName', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  beforeEach(enableCache);
+
+  afterEach(disableCache);
+
+  const params = { displayName: user21.displayName } as Amity.UserLiveCollection;
+
+  // integration_test_id: c7cb9776-5c72-4abe-9b3c-572d74d534fe
+  test('it should return users collection', async () => {
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockResolvedValue(userQueryResponse);
+
+    searchUserByDisplayName(params, callback);
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(2);
+    expect(callback).toHaveBeenNthCalledWith(1, expect.objectContaining(getSnapshot()));
+    expect(callback).toHaveBeenNthCalledWith(
+      2,
+      expect.objectContaining(
+        getSnapshot({
+          data: payload.users,
+          loading: false,
+        }),
+      ),
+    );
+  });
+
+  test('it should return data from cache', async () => {
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockResolvedValue(userQueryResponse);
+
+    searchUserByDisplayName(params, () => undefined);
+    await pause();
+    searchUserByDisplayName(params, callback);
+    await pause();
+
+    // The second `searchUserByDisplayName` call fetches data from the cache,
+    // so there is no loading state and the callback only fires once.
+    expect(callback).toHaveBeenCalledTimes(1);
+    expect(callback).toHaveBeenNthCalledWith(
+      1,
+      expect.objectContaining(
+        getSnapshot({
+          data: payload.users,
+          loading: false,
+        }),
+      ),
+    );
+  });
+
+  test('it should return method to fetch next page', async () => {
+    const callback = jest.fn();
+    client.http.get = jest
+      .fn()
+      .mockResolvedValue(userQueryResponse)
+      .mockResolvedValueOnce(userQueryResponsePage2);
+
+    searchUserByDisplayName(params, callback);
+    await pause();
+
+    expect(callback).toHaveBeenCalled();
+    expect(callback.mock.lastCall).toHaveLength(1);
+
+    const { onNextPage, hasNextPage } = callback.mock.lastCall[0];
+
+    expect(hasNextPage).toBe(true);
+    expect(onNextPage).toBeTruthy();
+
+    onNextPage();
+    await pause();
+
+    // 4 -> because 1 local & server call each per call (2)
+    expect(callback).toHaveBeenCalledTimes(4);
+    expect(callback).toHaveBeenNthCalledWith(
+      4,
+      expect.objectContaining(
+        getSnapshot({
+          loading: false,
+          data: [...payload2.users, ...payload.users],
+        }),
+      ),
+    );
+  });
+});