@amityco/ts-sdk 0.0.1-beta.3 → 0.0.1-beta.31

package/src/message/api/createMessage.ts

@@ -1,10 +1,9 @@
-import { uuid } from '~/core/uuid'
-
-import { getActiveClient } from '~/client/api'
-
-import { decoratePayload } from '~/core/query'
-import { ingestInCache, pullFromCache, pushToCache } from '~/core/cache'
-import { fireEvent } from '~/core/events'
+import { uuid } from '~/core/uuid';
+import { fireEvent } from '~/core/events';
+import { getActiveClient } from '~/client/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { UNSYNCED_OBJECT_CACHED_AT_VALUE } from '~/utils/constants';
+import { upsertInCache, pullFromCache, pushToCache } from '~/cache/api';
 
 /**
  * ```js
@@ -24,22 +23,32 @@ import { fireEvent } from '~/core/events'
  * @async
  */
 export const createMessage = async <T extends Amity.MessageContentType>(
-  bundle: Pick<Amity.Message<T>, 'channelId' | 'type' | 'data' | 'metadata'>
-) => {
-  const client = getActiveClient()
-  client.log('user/createMessage', bundle)
+  bundle: Pick<
+    Amity.Message<T>,
+    'channelId' | 'parentId' | 'type' | 'tags' | 'metadata' | 'mentionees'
+  > & {
+    data?: Amity.Message<T>['data'];
+    fileId?: Amity.Message<T>['fileId'];
+  },
+): Promise<Amity.Cached<Amity.Message>> => {
+  const client = getActiveClient();
+
+  client.log('user/createMessage', bundle);
+
+  const { data } = await client.http.post<Amity.MessagePayload>('/api/v3/messages', bundle);
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
 
-  const { data } = await client.http.post<Amity.MessagePayload>(
-    '/api/v3/messages', bundle,
-  )
+  const { messages } = data;
 
-  decoratePayload(data)
-  ingestInCache(data)
-  // no need for event, fired by server
+  fireEvent('v3.message.didCreate', { messages });
 
-  const { messages } = data
-  return messages[0]
-}
+  return {
+    data: messages[0],
+    cachedAt,
+  };
+};
 
 /**
  * ```js
@@ -58,33 +67,52 @@ export const createMessage = async <T extends Amity.MessageContentType>(
  * @category Message API
  */
 createMessage.optimistically = (
-  bundle: Pick<Amity.Message, 'channelId' | 'type' | 'data' | 'metadata'>
-) => {
-  const client = getActiveClient()
-  client.log('user/createMessage.locally', bundle)
+  bundle: Pick<
+    Amity.Message,
+    'channelId' | 'parentId' | 'type' | 'data' | 'tags' | 'metadata' | 'mentionees'
+  >,
+): Amity.Cached<Amity.Message> | undefined => {
+  const client = getActiveClient();
 
-  // should we do this?
-  if (!client.cache) return
+  if (!client.cache) return;
 
-  const [channel] = pullFromCache('channel', bundle.channelId) ?? []
+  /*
+   * when creating messages optimistically a messageId needs to be added by the
+   * client, created a new variable so as to allow backward compatibility of API
+   *
+   * Updated to handle client requirement to add messageId while uploading
+   * message with image. Temporary!
+   */
+  const bundleWithMessageId = { messageId: uuid(), ...bundle };
 
-  pushToCache('channel', {
-    ...channel,
-    messageCount: (channel.messageCount ?? 0) + 1,
-  })
+  // only log if cache is enabled
+  client.log('user/createMessage.locally', bundleWithMessageId);
+
+  const channel = pullFromCache<Amity.Channel>(['channel', 'get', bundleWithMessageId.channelId]);
+
+  upsertInCache(['channel', 'get', bundleWithMessageId.channelId], {
+    ...channel?.data,
+    messageCount: (channel?.data.messageCount ?? 0) + 1,
+  });
+
+  // as reused to update created and updated time, which should be the same
+  const createdTime = new Date().toISOString();
 
   const message = {
-    localId: uuid(),
-    messageId: Math.random().toString(16),
     userId: client.userId,
-    channelSegment: (channel?.messageCount ?? 0) + 1,
-    createdAt: new Date().toISOString(),
-    ...bundle,
-    syncedAt: -1,
-  } as Amity.Message
+    channelSegment: (channel?.data.messageCount ?? 0) + 1,
+    createdAt: createdTime,
+    updatedAt: createdTime,
+    ...bundleWithMessageId,
+  } as Amity.Message;
+
+  const cachedAt = UNSYNCED_OBJECT_CACHED_AT_VALUE;
 
-  pushToCache('message', message)
-  fireEvent('v3.message.didCreate', { messages: [message] })
+  pushToCache(['message', 'get', message.messageId], message, { cachedAt });
+  fireEvent('v3.message.didCreate', { messages: [message] });
 
-  return message
-}
+  return {
+    cachedAt,
+    data: message,
+  };
+};

package/src/message/api/deleteMessage.ts

@@ -1,12 +1,9 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { getMessage } from './getMessage'
+import { getMessage } from './getMessage';
 
-import {
-  pullFromCache,
-  pushToCache,
-} from '~/core/cache'
-import { fireEvent } from '~/core/events'
+import { pullFromCache, upsertInCache } from '~/cache/api';
+import { fireEvent } from '~/core/events';
 
 /**
  * ```js
@@ -24,20 +21,21 @@ import { fireEvent } from '~/core/events'
  */
 export const deleteMessage = async (
   messageId: Amity.Message['messageId'],
-) => {
-  const client = getActiveClient()
-  client.log('message/deleteMessage', messageId)
+): Promise<Amity.Message> => {
+  const client = getActiveClient();
+  client.log('message/deleteMessage', messageId);
 
   // API-FIX: This endpoint has not been implemented yet.
   await client.http.delete<{ success: boolean }>(
-    `/api/v3/messages/${messageId}`
-  )
+    `/api/v3/messages/${encodeURIComponent(messageId)}`,
+  );
 
-  const deleted = await getMessage(messageId)
-  // no need for event, fired by server
+  const deleted = await getMessage(messageId);
 
-  return deleted
-}
+  fireEvent('v3.message.didDelete', { messages: [deleted.data] });
+
+  return deleted.data;
+};
 
 /**
  * ```js
@@ -54,22 +52,26 @@ export const deleteMessage = async (
  */
 deleteMessage.optimistically = (
   messageId: Amity.Message['messageId'],
-) => {
-  const client = getActiveClient()
-  client.log('message/deleteMessage', messageId)
+): Amity.Cached<Amity.Message> | undefined => {
+  const client = getActiveClient();
+  client.log('message/deleteMessage', messageId);
 
-  const [message] = pullFromCache('message', messageId) ?? []
+  const message = pullFromCache<Amity.Message>(['message', 'get', messageId]);
 
-  if (!message) return
+  if (!message) return;
 
+  const cachedAt = -1;
   const deleted: Amity.Message = {
-    ...message,
+    ...message.data,
     isDeleted: true,
     updatedAt: new Date().toISOString(),
-  }
+  };
 
-  pushToCache('message', deleted)
-  fireEvent('v3.message.didDelete', { messages: [deleted] })
+  upsertInCache(['message', 'get', messageId], deleted, { cachedAt });
+  fireEvent('v3.message.didDelete', { messages: [deleted] });
 
-  return deleted
-}
+  return {
+    data: deleted,
+    cachedAt,
+  };
+};

package/src/message/api/getMessage.ts

@@ -1,8 +1,12 @@
-import { getActiveClient } from '~/client/api'
-import { ingestInCache, pullFromCache } from '~/core/cache'
-import { decoratePayload } from '~/core/query'
+import { getActiveClient } from '~/client/api';
 
-import { getMessages } from './getMessages'
+import { fireEvent } from '~/core/events';
+import { pullFromCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+import { isInTombstone } from '~/cache/api/isInTombstone';
+import { checkIfShouldGoesToTombstone } from '~/cache/utils';
+import { pushToTombstone } from '~/cache/api/pushToTombstone';
 
 /**
  * ```js
@@ -20,21 +24,48 @@ import { getMessages } from './getMessages'
  */
 export const getMessage = async (
   messageId: Amity.Message['messageId'],
-) => {
-  const client = getActiveClient()
-  client.log('message/getMessage', messageId)
+  isLive = false,
+): Promise<Amity.Cached<Amity.Message>> => {
+  const client = getActiveClient();
+  client.log('message/getMessage', messageId);
+
+  if (!isLive) {
+    console.log(
+      'getMessage will be deprecated on 15th November 2022, please use liveMessage instead.',
+    );
+  }
+
+  isInTombstone('message', messageId);
+
+  let data: Amity.MessagePayload;
+
+  try {
+    // API-FIX: endpoint should not be /list, parameters should be querystring.
+    const response = await client.http.get<Amity.MessagePayload>(
+      `/api/v3/messages/${encodeURIComponent(messageId)}`,
+    );
+
+    data = response.data;
+  } catch (error) {
+    if (checkIfShouldGoesToTombstone((error as Amity.ErrorResponse)?.code)) {
+      pushToTombstone('message', messageId);
+    }
 
-  // API-FIX: endpoint should not be /list, parameters should be querystring.
-  const { data } = await client.http.get<Amity.MessagePayload>(
-    `/api/v3/messages/${messageId}`,
-  )
+    throw error;
+  }
 
-  decoratePayload(data)
-  ingestInCache(data)
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
 
-  const { messages } = data
-  return messages.find(message => message.messageId === messageId)!
-}
+  const { messages } = data;
+
+  fireEvent('v3.message.didFetch', { messages });
+
+  return {
+    data: messages.find(message => message.messageId === messageId)!,
+    cachedAt,
+  };
+};
 
 /**
  * ```js
@@ -51,10 +82,18 @@ export const getMessage = async (
  */
 getMessage.locally = (
   messageId: Amity.Message['messageId'],
-) => {
-  const client = getActiveClient()
-  client.log('message/getMessage.locally', messageId)
+): Amity.Cached<Amity.Message> | undefined => {
+  const client = getActiveClient();
+  client.log('message/getMessage.locally', messageId);
+
+  if (!client.cache) return;
+
+  const cached = pullFromCache<Amity.Message>(['message', 'get', messageId]);
+
+  if (!cached) return;
 
-  const [message] = pullFromCache('message', messageId) ?? []
-  return message
-}
+  return {
+    data: cached.data,
+    cachedAt: cached.cachedAt,
+  };
+};

package/src/message/api/getMessages.ts

@@ -1,8 +1,8 @@
-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 { fireEvent } from '~/core/events';
+import { pullFromCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 /**
  * ```js
@@ -20,22 +20,27 @@ import { toRecord } from '~/core/model'
  */
 export const getMessages = async (
   messageIds: Amity.Message['messageId'][],
-) => {
-  const client = getActiveClient()
-  client.log('message/getMessages', messageIds)
+): Promise<Amity.Cached<Amity.Message[]>> => {
+  const client = getActiveClient();
+  client.log('message/getMessages', messageIds);
 
   // API-FIX: endpoint should not be /list, parameters should be querystring.
-  const { data } = await client.http.get<Amity.MessagePayload>(
-    `/api/v3/messages/list`,
-    { params: { messageIds } },
-  )
+  const { data } = await client.http.get<Amity.MessagePayload>(`/api/v3/messages/list`, {
+    params: { messageIds },
+  });
 
-  decoratePayload(data)
-  ingestInCache(data)
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
 
-  const { messages } = data
-  return toRecord(messages)
-}
+  const { messages } = data;
+
+  fireEvent('v3.message.didFetch', { messages });
+
+  return {
+    data: messages,
+    cachedAt,
+  };
+};
 
 /**
  * ```js
@@ -52,12 +57,23 @@ export const getMessages = async (
  */
 getMessages.locally = (
   messageIds: Amity.Message['messageId'][],
-) => {
-  const client = getActiveClient()
-  client.log('message/getMessages.locally', messageIds)
+): Amity.Cached<Amity.Message[]> | undefined => {
+  const client = getActiveClient();
+  client.log('message/getMessages.locally', messageIds);
+
+  if (!client.cache) return;
+
+  const cached = messageIds
+    .map(messageId => pullFromCache<Amity.Message>(['message', 'get', messageId])!)
+    .filter(Boolean);
+
+  const messages = cached.map(({ data }) => data);
+  const oldest = cached.sort((a, b) => (a.cachedAt! < b.cachedAt! ? -1 : 1))?.[0];
 
-  const cached = pullFromCache('message', ...messageIds) ?? []
+  if (cached?.length < messageIds.length) return;
 
-  if (cached?.length === messageIds.length)
-    return toRecord(cached)
-}
+  return {
+    data: messages,
+    cachedAt: oldest.cachedAt,
+  };
+};

package/src/message/api/index.ts

@@ -1,6 +1,6 @@
-export * from './getMessage'
-export * from './getMessages'
-export * from './queryMessages'
-export * from './createMessage'
-export * from './updateMessage'
-export * from './deleteMessage'
+export * from './getMessage';
+export * from './getMessages';
+export * from './queryMessages';
+export * from './createMessage';
+export * from './updateMessage';
+export * from './deleteMessage';

package/src/message/api/queryMessages.ts

@@ -1,16 +1,10 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import {
-  decoratePayload,
-  toPage,
-  toToken,
-  filterByPropEquality,
-  sortByChannelSegment,
-} from '~/core/query'
-
-import { ingestInCache, pullFromCache } from '~/core/cache'
-
-import { toRecord } from '~/core/model'
+import { fireEvent } from '~/core/events';
+import { toPage, toToken } from '~/core/query';
+import { pullFromCache, pushToCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { getResolver } from '~/core/model';
 
 /**
  * ```js
@@ -26,48 +20,56 @@ import { toRecord } from '~/core/model'
  * @category Message API
  * @async
  */
-export const queryMessages = async (query: {
-  channelId: Amity.Channel['channelId']
-  type?: Amity.MessageContentType
-  parentId?: Amity.Message['parentId']
-  filterByParentId?: boolean
-  isDeleted?: boolean
-  tags?: Amity.Taggable['tags']
-  excludeTags?: Amity.Taggable['tags']
-  page?: Amity.Page
-}) => {
-  const client = getActiveClient()
-  client.log('message/queryMessages', query)
-
-  const { page, ...params } = query ?? {}
+export const queryMessages = async (
+  query: Amity.QueryMessages,
+): Promise<Amity.Cached<Amity.Paged<Amity.Message>>> => {
+  const client = getActiveClient();
+  client.log('message/queryMessages', query);
+
+  const { page = { limit: 10 }, ...params } = query;
 
   // API-FIX: parameters should be querystring. (1)
   // API-FIX: backend should answer Amity.Response (2)
   // API-FIX: pagination should not be indexed on channelSegment (3)
   // const { data } = await client.http.get<Amity.Response<Amity.Paged<Amity.MessagePayload>>>(
   const { data } = await client.http.get<Amity.MessagePayload & Amity.Pagination>(
-    `/api/v3/messages`, { params: {
-      ...params,
-      options: {
-        token: toToken(page, 'afterbefore'),
+    `/api/v3/messages`,
+    {
+      params: {
+        ...params,
+        options: {
+          token: toToken(page, 'afterbefore'),
+        },
       },
-    },}
-  )
+    },
+  );
 
   // API-FIX: backend should answer Amity.Response (2)
   // const { paging, messages } = unwrapPayload(data)
-  const { paging, ...response } = data
 
-  decoratePayload(response as unknown as Record<string, any[]>)
-  ingestInCache(response as unknown as Record<string, any[]>)
+  const { paging, ...payload } = data;
+  const { messages } = payload;
 
-  const { messages } = response
+  const cachedAt = client.cache && Date.now();
 
-  const nextPage = toPage(paging.next)
-  const prevPage = toPage(paging.previous)
+  if (client.cache) {
+    ingestInCache(payload as Amity.MessagePayload, { cachedAt });
+
+    const cacheKey = [
+      'message',
+      'query',
+      { ...params, options: { ...page } } as Amity.Serializable,
+    ];
+    pushToCache(cacheKey, { messages: messages.map(getResolver('message')), paging });
+  }
 
-  return { data: toRecord(messages), nextPage, prevPage }
-}
+  fireEvent('v3.message.didFetch', { messages });
+
+  const nextPage = toPage(paging.next);
+  const prevPage = toPage(paging.previous);
+
+  return { data: messages, cachedAt, prevPage, nextPage };
+};
 
 /**
  * ```js
@@ -82,64 +84,32 @@ export const queryMessages = async (query: {
  *
  * @category Message API
  */
-queryMessages.locally = (query: Parameters<typeof queryMessages>[0]) => {
-  const client = getActiveClient()
-  client.log('message/queryMessages.locally', query)
-
-  const { channelId, page } = query
-
-  const [channel] = pullFromCache('channel', channelId) ?? []
+queryMessages.locally = (
+  query: Parameters<typeof queryMessages>[0],
+): Amity.Cached<Amity.Paged<Amity.Message>> | undefined => {
+  const client = getActiveClient();
+  client.log('message/queryMessages.locally', query);
 
-  let messages: Amity.Message<any>[] = pullFromCache('message') ?? []
+  if (!client.cache) return;
 
-  // filter
-  messages = filterByPropEquality(messages, 'channelId', channelId)
+  const { page = { limit: 10 }, ...params } = query;
 
-  // API-FIX filter by isDeleted doesn't work in backend... srsly wtf... how do they test things???
-  // messages = filterByPropEquality(messages, 'isDeleted', query?.isDeleted)
+  const queryKey = ['message', 'query', { ...params, options: { ...page } } as Amity.Serializable];
+  const { data, cachedAt } =
+    pullFromCache<{ messages: Pick<Amity.Message, 'messageId'>[] } & Amity.Pagination>(queryKey) ??
+    {};
 
-  // sort
-  messages = messages.sort(sortByChannelSegment)
-
-  // paging
-  if (page) {
-    // slice
-    // API-FIX we can't reuse proper page because the message page is done
-    // by channelSegment which is sadly unique to the entire platform.
-    // this part is copied and adapted from sliceByPaging function
-
-    let start: number | undefined = 0
-    let end: number | undefined = undefined
-
-    // next page behavior
-    if ('after' in page) {
-      start = page.after !== 0
-        ? messages.findIndex(message => message.channelSegment === page?.after) + 1
-        : 0
-
-      end = start + page.limit
-
-    // prev page behavior
-    } else if ('before' in page) {
-      end = page.before !== 0
-        ? messages.findIndex(message => message.channelSegment === page?.before) + 1
-        : messages.length - 1
-
-      start = end > page.limit ? end - page.limit : 0
-    }
-
-    const paged = messages.slice(start, end)
-
-    messages = paged.length === page.limit ? paged : []
-  }
+  if (!data?.messages.length) return;
 
-  const prevPage = messages[0]?.channelSegment > 0
-    ? { before: messages[0].channelSegment, limit: page?.limit }
-    : undefined
+  const messages: Amity.Message[] = data.messages
+    .map(messageId => pullFromCache<Amity.Message>(['message', 'get', messageId])!)
+    .filter(Boolean)
+    .map(({ data }) => data);
 
-  const nextPage = messages[messages.length - 1]?.channelSegment < (channel?.messageCount ?? 0)
-    ? { after: messages[messages.length - 1].channelSegment, limit: page?.limit }
-    : undefined
+  const prevPage = toPage(data?.paging.previous);
+  const nextPage = toPage(data?.paging.next);
 
-  return { data: toRecord(messages), nextPage, prevPage }
-}
+  return messages.length === data?.messages?.length
+    ? { data: messages, cachedAt, prevPage, nextPage }
+    : undefined;
+};