@amityco/ts-sdk 0.0.1-e5fb0d2.0 → 0.0.1-e643f6f.0

package/src/user/api/getUsers.ts

@@ -1,13 +1,16 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache, pullFromCache } from '~/core/cache'
-import { toRecord } from '~/core/model'
+import { pullFromCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
 
+/* begin_public_function
+  id: user.get_by_ids
+*/
 /**
  * ```js
  * import { getUsers } from '@amityco/ts-sdk'
- * const users = await getUsers(['foo', 'bar'])
+ * const { data: users } = await getUsers(['foo', 'bar'])
  * ```
  *
  * Fetches a collection of {@link Amity.User} objects
@@ -20,27 +23,32 @@ import { toRecord } from '~/core/model'
  */
 export const getUsers = async (
   userIds: Amity.User['userId'][],
-) => {
-  const client = getActiveClient()
-  client.log('user/getUsers', userIds)
+): Promise<Amity.Cached<Amity.User[]>> => {
+  const client = getActiveClient();
+  client.log('user/getUsers', userIds);
+
+  const encodedUserIds = userIds.map(userId => encodeURIComponent(userId));
 
   // API-FIX: endpoint should not be /list, parameters should be querystring.
-  const { data } = await client.http.get<Amity.UserPayload>(
-    `/api/v3/users/list`,
-    { params: { userIds } },
-  )
+  const { data } = await client.http.get<Amity.UserPayload>(`/api/v3/users/list`, {
+    params: { userIds: encodedUserIds },
+  });
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
 
-  decoratePayload(data)
-  ingestInCache(data)
+  fireEvent('user.fetched', data);
 
-  const { users } = data
-  return toRecord(users)
-}
+  return {
+    data: data.users,
+    cachedAt,
+  };
+};
 
 /**
  * ```js
  * import { getUsers } from '@amityco/ts-sdk'
- * const users = getUsers.locally!(['foo', 'bar'])
+ * const { data: users } = getUsers.locally!(['foo', 'bar'])
  * ```
  *
  * Fetches a collection of {@link Amity.User} objects from cache
@@ -50,11 +58,23 @@ export const getUsers = async (
  *
  * @category User API
  */
-getUsers.locally = (
-  userIds: Amity.User['userId'][],
-) => {
-  const cached = pullFromCache('user', ...userIds) ?? []
+getUsers.locally = (userIds: Amity.User['userId'][]): Amity.Cached<Amity.User[]> | undefined => {
+  const client = getActiveClient();
+  client.log('user/getUsers.locally', userIds);
+
+  if (!client.cache) return;
+
+  const cached = userIds
+    .map(userId => pullFromCache<Amity.User>(['user', 'get', userId])!)
+    .filter(Boolean);
+
+  const users = cached.map(({ data }) => data);
+  const oldest = cached.sort((a, b) => (a.cachedAt! < b.cachedAt! ? -1 : 1))?.[0];
+
+  if (cached?.length < userIds.length) return;
 
-  if (cached?.length === userIds.length)
-    return toRecord(cached)
-}
+  return {
+    data: users,
+    cachedAt: oldest.cachedAt,
+  };
+};

package/src/user/api/index.ts

@@ -1,5 +1,5 @@
-export { getUser } from './getUser'
-export { getUsers } from './getUsers'
-export { queryUsers } from './queryUsers'
+export { getUser } from './getUser';
+export { getUsers } from './getUsers';
+export { queryUsers } from './queryUsers';
 
-export { updateUser } from './updateUser'
+export { updateUser } from './updateUser';

package/src/user/api/queryUsers.ts

@@ -1,13 +1,19 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { decoratePayload, toPage, toToken } from '~/core/query'
-import { ingestInCache, pullFromCache } from '~/core/cache'
-import { toRecord } from '~/core/model'
+import { toPage, toToken } from '~/core/query';
 
+import { pullFromCache, pushToCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { getResolver } from '~/core/model';
+import { fireEvent } from '~/core/events';
+
+/* begin_public_function
+  id: user.query, user.search
+*/
 /**
  * ```js
  * import { queryUsers } from '@amityco/ts-sdk'
- * const { users, previous, next } = await queryUsers({ keyword: 'foo' })
+ * const { data: users, prevPage, nextPage } = await queryUsers({ displayName: 'foo' })
  * ```
  *
  * Queries a paginable list of {@link Amity.User} objects
@@ -20,54 +26,61 @@ import { toRecord } from '~/core/model'
  * @async
  */
 export const queryUsers = async (
-  query?: {
-    displayName?: Amity.User['displayName']
-    filter?: 'all' | 'flagged'
-    sortBy?: 'displayName' | 'firstCreated' | 'lastCreated'
-    page?: Amity.Page
-  }
-) => {
-  const client = getActiveClient()
-  client.log('user/queryUsers', query)
+  query: Amity.QueryUsers = {},
+): Promise<Amity.Cached<Amity.Paged<Amity.User>>> => {
+  const client = getActiveClient();
+  client.log('user/queryUsers', query);
 
   const {
-    page,
+    page = { limit: 10 },
     displayName,
     filter = 'all',
     sortBy = 'displayName',
     ...params
-  } = query ?? {}
+  } = query;
 
-  // API-FIX: parameters should be querystring.
-  const { data } = await client.http.get<Amity.UserPayload & Amity.Pagination>(
-    `/api/v3/users`, { params: {
+  const { data } = await client.http.get<Amity.UserPayload & Amity.Pagination>(`/api/v3/users`, {
+    params: {
       ...params,
       keyword: displayName,
       filter,
       sortBy,
       options: {
         token: toToken(page, 'skiplimit'),
-      }
-    } }
-  )
+      },
+    },
+  });
 
   // unpacking
-  const { paging, ...response } = data
+  const { paging, ...payload } = data;
+  const { users } = payload;
+
+  const cachedAt = client.cache && Date.now();
+
+  if (client.cache) {
+    ingestInCache(payload as Amity.UserPayload, { cachedAt });
+
+    /*
+     * using query as cache key over params because if the keyword, filter, sort
+     * change the API will NOT cache results, when it should
+     */
+    const cacheKey = ['user', 'query', { ...query, options: { ...page } } as Amity.Serializable];
+    pushToCache(cacheKey, { users: users.map(getResolver('user')), paging });
+  }
 
-  decoratePayload(response as unknown as Record<string, any[]>)
-  ingestInCache(response as unknown as Record<string, any[]>)
+  fireEvent('user.fetched', data);
 
-  const prevPage = toPage(paging.previous)
-  const nextPage = toPage(paging.next)
+  const prevPage = toPage(paging.previous);
+  const nextPage = toPage(paging.next);
 
-  const { users } = response
-  return { data: toRecord(users), prevPage, nextPage }
-}
+  return { data: users, cachedAt, prevPage, nextPage };
+};
+/* end_public_function */
 
 /**
  * ```js
  * import { queryUsers } from '@amityco/ts-sdk'
- * const users = queryUsers.locally({ keyword: 'foo' })
+ * const { data: users } = queryUsers.locally({ keyword: 'foo' })
  * ```
  *
  * Queries a paginable list of {@link Amity.User} objects from cache
@@ -79,10 +92,37 @@ export const queryUsers = async (
  * @category User API
  */
 queryUsers.locally = (
-  query: Parameters<typeof queryUsers>[0],
-) => {
-  const client = getActiveClient()
-  client.log('user/queryUsers.locally', query)
+  query: Parameters<typeof queryUsers>[0] = {},
+): Amity.Cached<Amity.Paged<Amity.User>> | undefined => {
+  const client = getActiveClient();
+  client.log('user/queryUsers.locally', query);
+
+  if (!client.cache) return;
+
+  const { page = { limit: 10 } } = query ?? {};
+
+  const cacheKey = [
+    'user',
+    'query',
+    {
+      ...query,
+      options: { ...page },
+    } as Amity.Serializable,
+  ];
+
+  const { data, cachedAt } =
+    pullFromCache<{ users: Pick<Amity.User, 'userId'>[] } & Amity.Pagination>(cacheKey) ?? {};
+
+  const users: Amity.User[] =
+    data?.users
+      .map(userId => pullFromCache<Amity.User>(['user', 'get', userId])!)
+      .filter(Boolean)
+      .map(({ data }) => data) ?? [];
+
+  const prevPage = toPage(data?.paging.previous);
+  const nextPage = toPage(data?.paging.next);
 
-  // TODO
-}
+  return users.length > 0 && users.length === data?.users?.length
+    ? { data: users, cachedAt, prevPage, nextPage }
+    : undefined;
+};

package/src/user/api/tests/queryUsers.test.ts

@@ -0,0 +1,124 @@
+import { getResolver } from '~/core/model';
+
+import { disableCache, enableCache, pushToCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+import { client, userQueryResponse } from '~/utils/tests';
+
+import { queryUsers } from '../queryUsers';
+
+describe('queryUsers', () => {
+  test('it should return users', async () => {
+    const { users: expected } = userQueryResponse.data;
+    client.http.get = jest.fn().mockResolvedValue(userQueryResponse);
+
+    const { data } = await queryUsers();
+
+    expect(data).toEqual(expected);
+  });
+
+  test('it should throw error', async () => {
+    client.http.get = jest.fn().mockRejectedValueOnce(new Error('error'));
+
+    await expect(queryUsers()).rejects.toThrow('error');
+  });
+
+  test('it should update cache upon fetching data from server', async () => {
+    enableCache();
+
+    client.http.get = jest.fn().mockResolvedValue(userQueryResponse);
+
+    const { data: expected } = await queryUsers();
+    const { data: received } = queryUsers.locally()!;
+
+    expect(received).toBeDefined();
+    expect(received).toEqual(expected);
+
+    disableCache();
+  });
+});
+
+describe('queryUsers.locally', () => {
+  const cacheKey = [
+    'user',
+    'query',
+    { options: { limit: 10, after: undefined } } as Amity.Serializable,
+  ];
+
+  test('it should fetch query locally if present in cache', () => {
+    enableCache();
+
+    const { data } = userQueryResponse;
+    const { users: expected, paging } = data;
+
+    ingestInCache(data as Amity.UserPayload);
+
+    pushToCache(cacheKey, { users: expected.map(getResolver('user')), paging });
+
+    const { data: received } = queryUsers.locally()!;
+
+    expect(received).toBeDefined();
+    expect(received).toEqual(expected);
+
+    disableCache();
+  });
+
+  test('it should return undefined if only partial data in cache', () => {
+    enableCache();
+
+    const { data } = userQueryResponse;
+    const { users, paging } = data;
+
+    // ingest incomplete data
+    ingestInCache({
+      ...data,
+      users: [data.users[0]],
+    } as Amity.UserPayload);
+
+    pushToCache(cacheKey, {
+      users: users.map(getResolver('user')),
+      paging,
+    });
+
+    const received = queryUsers.locally()!;
+
+    expect(received).toBeUndefined();
+
+    disableCache();
+  });
+
+  // added because of comment above cache key in queryUsers
+  test('it should return undefined if params do not match', () => {
+    enableCache();
+
+    const { data } = userQueryResponse;
+    const { users: expected, paging } = data;
+
+    ingestInCache(data as Amity.UserPayload);
+
+    pushToCache(cacheKey, { users: expected.map(getResolver('user')), paging });
+
+    const { data: received } = queryUsers.locally()!;
+    const received2 = queryUsers.locally({ displayName: 'test' })!;
+
+    expect(received).toBeDefined();
+    expect(received).toEqual(expected);
+    expect(received2).toBeUndefined();
+
+    disableCache();
+  });
+
+  test('it should return undefined if data not in cache', () => {
+    enableCache();
+
+    const received = queryUsers.locally();
+
+    expect(received).toBeUndefined();
+
+    disableCache();
+  });
+
+  test('it should return undefined if cache disabled', () => {
+    expect(queryUsers.locally()).toBeUndefined();
+  });
+});

package/src/user/api/tests/updateUser.test.ts

@@ -0,0 +1,60 @@
+import { disableCache, enableCache, pushToCache, pullFromCache } from '~/cache/api';
+
+import { client, userUpdateResponse } from '~/utils/tests';
+
+import { updateUser } from '../updateUser';
+import { onUserUpdated } from '../../events/onUserUpdated';
+
+describe('updateUser', () => {
+  const displayName = 'updated-display-name';
+  const userId = 'test-user';
+  const avatarCustomUrl = 'updated-avatarUrl';
+
+  // integration_test_id: a1a8260f-3314-41ba-9f5f-3a96dd52453d
+  test('it should return updated user on success', async () => {
+    const { users: expected } = userUpdateResponse.data;
+    client.http.put = jest.fn().mockResolvedValue(userUpdateResponse);
+
+    const { data: received } = await updateUser(userId, { displayName, avatarCustomUrl });
+
+    expect(received).toStrictEqual(expected[0]);
+  });
+
+  // integration_test_id: 67cb7ad8-28a9-4950-a86c-35497bb5212c
+  test('it should return 400301 when updating another user', async () => {
+    client.http.put = jest.fn().mockRejectedValueOnce(new Error('400301'));
+
+    await expect(
+      updateUser('different-user', { displayName: 'updated-display-name' }),
+    ).rejects.toThrow('400301');
+  });
+
+  test('it should update cache with updated user', async () => {
+    enableCache();
+
+    const expected = userUpdateResponse.data.users[0];
+    pushToCache(['user', 'get', userId], { ...expected, displayName: 'old-displayName' });
+
+    client.http.put = jest.fn().mockResolvedValue(userUpdateResponse);
+    await updateUser(userId, { displayName, avatarCustomUrl });
+
+    const received = pullFromCache(['user', 'get', userId])?.data;
+
+    expect(received).toStrictEqual(expected);
+    disableCache();
+  });
+
+  test('it should fire event for updated user', async () => {
+    let dispose;
+    const { users: expected } = userUpdateResponse.data;
+    client.http.put = jest.fn().mockResolvedValue(userUpdateResponse);
+
+    const callbackPromise = new Promise(resolve => {
+      dispose = onUserUpdated(resolve);
+    }).finally(dispose);
+
+    await updateUser(userId, { displayName, avatarCustomUrl });
+
+    await expect(callbackPromise).resolves.toEqual(expect.objectContaining(expected[0]));
+  });
+});

package/src/user/api/updateUser.ts

@@ -1,8 +1,11 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { fireEvent } from '~/core/events';
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
+/* begin_public_function
+  id: client.update_user
+*/
 /**
  * ```js
  * import { updateUser } from '@amityco/ts-sdk'
@@ -20,10 +23,13 @@ import { ingestInCache } from '~/core/cache'
  */
 export const updateUser = async (
   userId: Amity.User['userId'],
-  patch: Patch<Amity.User, 'displayName' | 'description' | 'avatarFileId' | 'metadata'>,
-) => {
-  const client = getActiveClient()
-  client.log('user/updateUser', userId, patch)
+  patch: Patch<
+    Amity.User,
+    'displayName' | 'description' | 'avatarFileId' | 'avatarCustomUrl' | 'metadata'
+  >,
+): Promise<Amity.Cached<Amity.User>> => {
+  const client = getActiveClient();
+  client.log('user/updateUser', userId, patch);
 
   // API-FIX: Endpoint is malformed, userId should be a url param.
   /*
@@ -32,13 +38,22 @@ export const updateUser = async (
     )
   */
 
-  const { data } = await client.http.put<Amity.UserPayload>(
-    `/api/v3/users/`, { userId, ...patch, createNewUserWhenNotFound: false },
-  )
+  const { data } = await client.http.put<Amity.UserPayload>(`/api/v3/users/`, {
+    userId,
+    ...patch,
+    createNewUserWhenNotFound: false,
+  });
 
-  decoratePayload(data)
-  ingestInCache(data)
-  // no need for event, fired by server
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
 
-  return data.users.find(user => user.userId === userId)!
-}
+  const { users } = data;
+
+  fireEvent('user.updated', data);
+
+  return {
+    data: users.find(user => user.userId === userId)!,
+    cachedAt,
+  };
+};
+/* end_public_function */

package/src/user/events/index.ts

@@ -1 +1,6 @@
-export * from './onUserUpdated'
+export * from './onUserUpdated';
+export * from './onUserDeleted';
+
+export * from './onUserFlagged';
+export * from './onUserUnflagged';
+export * from './onUserFlagCleared';

package/src/user/events/onUserDeleted.ts

@@ -0,0 +1,19 @@
+import { createUserEventSubscriber } from './utils';
+
+/**
+ * ```js
+ * import { onUserDeleted } from '@amityco/ts-sdk'
+ * const dispose = onUserDeleted(user => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.User} has been deleted
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category User Events
+ */
+export const onUserDeleted = (callback: Amity.Listener<Amity.User>) =>
+  createUserEventSubscriber('user.deleted', callback);

package/src/user/events/onUserFetched.ts

@@ -0,0 +1,19 @@
+import { createUserEventSubscriber } from './utils';
+
+/**
+ * ```js
+ * import { onUserFetched } from '@amityco/ts-sdk'
+ * const dispose = onUserFetched(user => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.User} has been fetched
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category User Events
+ */
+export const onUserFetched = (callback: Amity.Listener<Amity.User>) =>
+  createUserEventSubscriber('user.fetched', callback);

package/src/user/events/onUserFlagCleared.ts

@@ -0,0 +1,19 @@
+import { createUserEventSubscriber } from './utils';
+
+/**
+ * ```js
+ * import { onUserFlagCleared } from '@amityco/ts-sdk'
+ * const dispose = onUserFlagCleared(user => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when flags have been cleared for a {@link Amity.User}
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category User Events
+ */
+export const onUserFlagCleared = (callback: Amity.Listener<Amity.User>) =>
+  createUserEventSubscriber('user.flagCleared', callback);

package/src/user/events/onUserFlagged.ts

@@ -0,0 +1,19 @@
+import { createUserEventSubscriber } from './utils';
+
+/**
+ * ```js
+ * import { onUserFlagged } from '@amityco/ts-sdk'
+ * const dispose = onUserFlagged(user => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.User} has been flagged
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category User Events
+ */
+export const onUserFlagged = (callback: Amity.Listener<Amity.User>) =>
+  createUserEventSubscriber('user.flagged', callback);

package/src/user/events/onUserUnflagged.ts

@@ -0,0 +1,19 @@
+import { createUserEventSubscriber } from './utils';
+
+/**
+ * ```js
+ * import { onUserUnflagged } from '@amityco/ts-sdk'
+ * const dispose = onUserUnflagged(user => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a flag has been removed from a {@link Amity.User}
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category User Events
+ */
+export const onUserUnflagged = (callback: Amity.Listener<Amity.User>) =>
+  createUserEventSubscriber('user.unflagged', callback);

package/src/user/events/onUserUpdated.ts

@@ -1,8 +1,4 @@
-import { getActiveClient } from '~/client/api'
-import { createEventSubscriber } from '~/core/events'
-
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { createUserEventSubscriber } from './utils';
 
 /**
  * ```js
@@ -12,28 +8,12 @@ import { ingestInCache } from '~/core/cache'
  * })
  * ```
  *
- * Fired when any {@link Amity.User} have been updated
+ * Fired when a {@link Amity.User} has been updated
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening
  *
  * @category User Events
  */
-export const onUserUpdated = (
-  callback: Amity.Listener<Amity.User>
-) => {
-  const client = getActiveClient()
-
-  const filter = (payload: Amity.UserPayload) => {
-    decoratePayload(payload)
-    ingestInCache(payload)
-    callback(payload.users[0])
-  }
-
-  return createEventSubscriber(
-    client,
-    'user/onUserUpdate',
-    'v3.user.didUpdate',
-    filter
-  )
-}
+export const onUserUpdated = (callback: Amity.Listener<Amity.User>) =>
+  createUserEventSubscriber('user.updated', callback);