@amityco/ts-sdk-react-native 6.36.0 → 7.0.0

package/src/feedRepository/internalApi/test/queryGlobalFeed.test.ts

@@ -1,130 +0,0 @@
-import { disableCache, enableCache, pullFromCache, pushToCache } from '~/cache/api';
-
-import { client, deepCopy, post11, post12, user11 } from '~/utils/tests';
-
-import { queryGlobalFeed } from '../queryGlobalFeed';
-
-const pagingToken = {
-  previous: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
-  next: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
-};
-
-const postsToQuery = [post11, post12];
-const postIdsToQuery = postsToQuery.map(post => post.postId);
-const pagingCriteria = { limit: 10 };
-const queryCriteriaWithoutPage = {};
-const queryCriteria = { ...queryCriteriaWithoutPage, page: pagingCriteria };
-
-const resolvedQueryFeedValue = {
-  data: {
-    posts: postsToQuery,
-    postChildren: [],
-    categories: [],
-    comments: [],
-    communityUsers: [],
-    feeds: [],
-    files: [],
-    polls: [],
-    users: [user11],
-    paging: pagingToken,
-  },
-};
-
-describe('queryGlobalFeed', () => {
-  test('should return fetched feed with correct paging', async () => {
-    client.http.get = jest.fn().mockResolvedValueOnce(resolvedQueryFeedValue);
-
-    const result = await queryGlobalFeed(queryCriteria);
-    expect(deepCopy(result)).toEqual(
-      expect.objectContaining(
-        deepCopy({
-          data: postsToQuery,
-          prevPage: { before: 55, limit: 10 },
-          nextPage: { before: 55, limit: 10 },
-        }),
-      ),
-    );
-  });
-
-  test('should accept undefined query param', async () => {
-    client.http.get = jest.fn().mockResolvedValueOnce(resolvedQueryFeedValue);
-
-    await expect(queryGlobalFeed()).resolves.not.toThrow();
-  });
-
-  test('should update cache after fetching feed', async () => {
-    enableCache();
-    client.http.get = jest.fn().mockResolvedValue(resolvedQueryFeedValue);
-
-    await queryGlobalFeed(queryCriteria);
-
-    const recieved = pullFromCache([
-      'globalFeed',
-      'query',
-      { ...queryCriteriaWithoutPage, options: pagingCriteria },
-    ])?.data;
-
-    expect(recieved).toEqual({
-      posts: postIdsToQuery,
-      paging: pagingToken,
-    });
-
-    disableCache();
-  });
-
-  test('should throw an error if request fails', async () => {
-    client.http.get = jest.fn().mockRejectedValueOnce(new Error('error'));
-
-    await expect(queryGlobalFeed(queryCriteria)).rejects.toThrow('error');
-  });
-});
-
-describe('queryGlobalFeed.locally', () => {
-  beforeEach(enableCache);
-  afterEach(disableCache);
-
-  test('should return cached feed', () => {
-    postsToQuery.forEach(post => pushToCache(['post', 'get', post.postId], post));
-
-    pushToCache(['globalFeed', 'query', { ...queryCriteriaWithoutPage, options: pagingCriteria }], {
-      posts: postIdsToQuery,
-      paging: pagingToken,
-    });
-    pushToCache(['user', 'get', user11.userId], user11);
-
-    expect(deepCopy(queryGlobalFeed.locally(queryCriteria))).toEqual(
-      expect.objectContaining(
-        deepCopy({
-          data: postsToQuery,
-          prevPage: { before: 55, limit: 10 },
-          nextPage: { before: 55, limit: 10 },
-        }),
-      ),
-    );
-  });
-
-  test('should accept undefined query param', async () => {
-    client.http.get = jest.fn().mockResolvedValueOnce(resolvedQueryFeedValue);
-
-    expect(() => queryGlobalFeed.locally()).not.toThrow();
-  });
-
-  test(`shouldn't return if individual feed cache not exist`, () => {
-    pushToCache(['globalFeed', 'query', { ...queryCriteriaWithoutPage, options: pagingCriteria }], {
-      posts: postIdsToQuery,
-      paging: pagingToken,
-    });
-
-    expect(queryGlobalFeed.locally(queryCriteria)).toBeUndefined();
-  });
-
-  test('it should return undefined if feed not in cache', () => {
-    expect(queryGlobalFeed.locally({})).toBeUndefined();
-  });
-
-  test('it should return undefined if cache disabled', () => {
-    disableCache();
-
-    expect(queryGlobalFeed.locally({})).toBeUndefined();
-  });
-});

package/src/fileRepository/api/createFile.ts

@@ -1,59 +0,0 @@
-import { getActiveClient } from '~/client/api';
-
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import GlobalFileAccessType from '~/client/utils/GlobalFileAccessType';
-
-/**
- * ```js
- * import { FileRepository } from '@amityco/ts-sdk-react-native'
- * const created = await FileRepository.createFile(formData)
- * ```
- *
- * Creates an {@link Amity.File}
- *
- * @param formData The data necessary to create a new {@link Amity.File}
- * @param onProgress The callback to track the upload progress
- * @returns The newly created {@link Amity.File}
- *
- * @category File API
- * @async
- */
-export const createFile = async <T extends Amity.FileType = any>(
-  formData: FormData,
-  onProgress?: (percent: number) => void,
-): Promise<Amity.Cached<Amity.File[]>> => {
-  const client = getActiveClient();
-  client.log('file/createFile', formData);
-
-  const files = formData.getAll('files');
-
-  if (!files.length) throw new Error('The formData object must have a `files` key.');
-
-  const accessType = GlobalFileAccessType.getInstance().getFileAccessType();
-  formData.append('accessType', accessType);
-
-  formData.append('preferredFilename', (files[0] as File).name);
-
-  const headers =
-    'getHeaders' in formData
-      ? (formData as any).getHeaders()
-      : { 'content-type': 'multipart/form-data' };
-
-  const { data } = await client.http.post<Amity.CreateFilePayload<T>>('/api/v4/files', formData, {
-    headers,
-    onUploadProgress({ loaded, total = 100 }) {
-      onProgress && onProgress(Math.round((loaded * 100) / total));
-    },
-  });
-
-  // API-FIX: payload should be serialized properly
-  // const { files } = data
-
-  const cachedAt = client.cache && Date.now();
-  if (client.cache) ingestInCache({ files: data }, { cachedAt });
-
-  return {
-    data,
-    cachedAt,
-  };
-};

package/src/fileRepository/api/createImage.ts

@@ -1,59 +0,0 @@
-import { getActiveClient } from '~/client/api';
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import GlobalFileAccessType from '~/client/utils/GlobalFileAccessType';
-
-/**
- * ```js
- * import { createImage } from '@amityco/ts-sdk-react-native'
- * const created = await createImage(formData)
- * ```
- *
- * Creates an {@link Amity.File<'image'>}
- *
- * @param formData The data necessary to create a new {@link Amity.File<'image'>}
- * @param onProgress The callback to track the upload progress
- * @returns The newly created {@link Amity.File<'image'>}
- *
- * @category File API
- * @async
- */
-export const createImage = async (
-  formData: FormData,
-  onProgress?: (percent: number) => void,
-): Promise<Amity.Cached<Amity.File<'image'>[]>> => {
-  const client = getActiveClient();
-  client.log('file/createImage', formData);
-
-  const files = formData.getAll('files');
-
-  if (!files.length) throw new Error('The formData object must have a `files` key.');
-
-  const accessType = GlobalFileAccessType.getInstance().getFileAccessType();
-  formData.append('accessType', accessType);
-
-  formData.append('preferredFilename', (files[0] as File).name);
-
-  const headers =
-    'getHeaders' in formData
-      ? (formData as any).getHeaders()
-      : { 'content-type': 'multipart/form-data' };
-  const { data } = await client.http.post<Amity.CreateFilePayload<'image'>>(
-    '/api/v4/images',
-    formData,
-    {
-      headers,
-      onUploadProgress({ loaded, total = 100 }) {
-        onProgress && onProgress(Math.round((loaded * 100) / total));
-      },
-    },
-  );
-  // API-FIX: payload should be serialized properly
-  // const { files } = data
-  const cachedAt = client.cache && Date.now();
-  if (client.cache) ingestInCache({ files: data }, { cachedAt });
-  return {
-    data,
-    cachedAt,
-  };
-};
-/* end_public_function */

package/src/fileRepository/api/createVideo.ts

@@ -1,69 +0,0 @@
-import { getActiveClient } from '~/client/api';
-
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import GlobalFileAccessType from '~/client/utils/GlobalFileAccessType';
-
-/**
- * ```js
- * import { FileRepository } from '@amityco/ts-sdk-react-native'
- * const created = await FileRepository.createVideo(formData)
- * ```
- *
- * Creates an {@link Amity.File<'video'>}
- *
- * @param formData The data necessary to create a new {@link Amity.File<'video'>}
- * @param feedType The {@link Amity.File<'video'>} feed type
- * @param onProgress The callback to track the upload progress
- * @returns The newly uploaded {@link Amity.File<'video'>}
- *
- * @category File API
- * @async
- */
-export const createVideo = async (
-  formData: FormData,
-  feedType?: Amity.ContentFeedType,
-  onProgress?: (percent: number) => void,
-): Promise<Amity.Cached<Amity.File<'video'>[]>> => {
-  const client = getActiveClient();
-  client.log('file/createVideo', formData);
-
-  const files = formData.getAll('files');
-
-  if (!files.length) throw new Error('The formData object must have a `files` key.');
-
-  const accessType = GlobalFileAccessType.getInstance().getFileAccessType();
-  formData.append('accessType', accessType);
-
-  formData.append('preferredFilename', (files[0] as File).name);
-
-  if (feedType) {
-    formData.append('feedType', feedType);
-  }
-
-  const headers =
-    'getHeaders' in formData
-      ? (formData as any).getHeaders()
-      : { 'content-type': 'multipart/form-data' };
-
-  const { data } = await client.http.post<Amity.CreateFilePayload<'video'>>(
-    '/api/v4/videos',
-    formData,
-    {
-      headers,
-      onUploadProgress({ loaded, total = 100 }) {
-        onProgress && onProgress(Math.round((loaded * 100) / total));
-      },
-    },
-  );
-
-  // API-FIX: payload should be serialized properly
-  // const { files } = data
-
-  const cachedAt = client.cache && Date.now();
-  if (client.cache) ingestInCache({ files: data }, { cachedAt });
-
-  return {
-    data,
-    cachedAt,
-  };
-};

package/src/fileRepository/observers/index.ts

@@ -1 +0,0 @@
-export * from './observeFile';

package/src/fileRepository/observers/observeFile.ts

@@ -1,49 +0,0 @@
-import { createQuery, runQuery } from '~/core/query/query';
-
-import { getActiveClient } from '~/client/api';
-
-import { getFile } from '../api';
-
-/**
- * ```js
- * import { observeFile } from '@amityco/ts-sdk-react-native'
- *
- * let file = {}
- * const dispose = observeFile(fileId, updated => file = updated)
- * ```
- *
- * Observe all mutation on a given {@link Amity.File}
- *
- * @param fileId the ID of the file to observe
- * @param callback the function to call when new data are available
- * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the file
- *
- * @category File Observer
- */
-export const observeFile = <Events extends ['onFetch']>(
-  fileId: string,
-  callback: Amity.ObjectListener<Amity.Snapshot<Amity.File>, Events>,
-): Amity.Unsubscriber => {
-  const { log } = getActiveClient();
-
-  const timestamp = Date.now();
-  log(`observeFile(tmpid: ${timestamp}) > listen`);
-
-  // wrapper function to make sure
-  const router = (result: Amity.Snapshot<Amity.File>, action: Events[number]) => {
-    // filter function
-    if (result.data?.fileId !== fileId) return;
-
-    if (callback instanceof Function) return callback(result);
-
-    if (action !== 'onFetch') callback.onEvent?.(action, result);
-
-    callback[action]?.(result);
-  };
-
-  runQuery(createQuery(getFile, fileId), result => result.data && router(result, 'onFetch'));
-
-  return () => {
-    log(`observeFile(tmpid: ${timestamp}) > dispose`);
-  };
-};

package/src/messageRepository/api/getMessage.ts

@@ -1,102 +0,0 @@
-import { getActiveClient } from '~/client/api';
-
-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';
-
-import { prepareMessagePayload } from '../utils';
-import { LinkedObject } from '~/utils/linkedObject';
-
-/**
- * ```js
- * import { getMessage } from '@amityco/ts-sdk-react-native'
- * const message = await getMessage('foobar')
- * ```
- *
- * Fetches a {@link Amity.Message} object
- *
- * @param messageId the ID of the {@link Amity.Message} to fetch
- * @returns the associated {@link Amity.Message} object
- *
- * @category Message API
- * @async
- */
-export const getMessage = async (
-  messageId: Amity.Message['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.ProcessedMessagePayload;
-
-  try {
-    // API-FIX: endpoint should not be /list, parameters should be querystring.
-    const { data: payload } = await client.http.get<Amity.MessagePayload>(
-      `/api/v5/messages/${encodeURIComponent(messageId)}`,
-    );
-
-    data = await prepareMessagePayload(payload);
-  } catch (error) {
-    if (checkIfShouldGoesToTombstone((error as Amity.ErrorResponse)?.code)) {
-      pushToTombstone('message', messageId);
-    }
-
-    throw error;
-  }
-
-  const cachedAt = client.cache && Date.now();
-  if (client.cache) ingestInCache(data, { cachedAt });
-
-  const { messages } = data;
-
-  fireEvent('local.message.fetched', { messages });
-
-  return {
-    data: LinkedObject.message(messages.find(message => message.messageId === messageId)!),
-    cachedAt,
-  };
-};
-
-/**
- * ```js
- * import { getMessage } from '@amityco/ts-sdk-react-native'
- * const message = getMessage.locally('foobar')
- * ```
- *
- * Fetches a {@link Amity.Message} object
- *
- * @param messageId the ID of the {@link Amity.Message} to fetch
- * @returns the associated {@link Amity.Message} object
- *
- * @category Message API
- */
-getMessage.locally = (
-  messageId: Amity.Message['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;
-
-  return {
-    data: cached.data,
-    cachedAt: cached.cachedAt,
-  };
-};

package/src/messageRepository/api/getMessages.ts

@@ -1,83 +0,0 @@
-import { getActiveClient } from '~/client/api';
-
-import { fireEvent } from '~/core/events';
-import { pullFromCache } from '~/cache/api';
-import { ingestInCache } from '~/cache/api/ingestInCache';
-
-import { prepareMessagePayload } from '../utils';
-import { LinkedObject } from '~/utils/linkedObject';
-
-/**
- * ```js
- * import { getMessages } from '@amityco/ts-sdk-react-native'
- * const messages = await getMessages(['foo', 'bar'])
- * ```
- *
- * Fetches a collection of {@link Amity.Message} objects
- *
- * @param messageIds the IDs of the {@link Amity.Message} to fetch
- * @returns the associated collection of {@link Amity.Message} objects
- *
- * @category Message API
- * @async
- */
-export const getMessages = async (
-  messageIds: Amity.Message['messageId'][],
-): Promise<Amity.Cached<Amity.Message[]>> => {
-  const client = getActiveClient();
-  client.log('message/getMessages', messageIds);
-
-  const { data: payload } = await client.http.get<Amity.MessagePayload>(`/api/v5/messages/list`, {
-    params: { messageIds: messageIds.map(encodeURIComponent) },
-  });
-
-  const data = await prepareMessagePayload(payload);
-
-  const cachedAt = client.cache && Date.now();
-  if (client.cache) ingestInCache(data, { cachedAt });
-
-  const { messages } = data;
-
-  fireEvent('local.message.fetched', { messages });
-
-  return {
-    data: messages.map(message => LinkedObject.message(message)),
-    cachedAt,
-  };
-};
-
-/**
- * ```js
- * import { getMessages } from '@amityco/ts-sdk-react-native'
- * const messages = getMessages.locally(['foo', 'bar']) ?? []
- * ```
- *
- * Fetches a collection of {@link Amity.Message} objects from cache
- *
- * @param messageIds the IDs of the {@link Amity.Message} to fetch
- * @returns the associated collection of {@link Amity.Message} objects
- *
- * @category Message API
- */
-getMessages.locally = (
-  messageIds: Amity.Message['messageId'][],
-): 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];
-
-  if (cached?.length < messageIds.length) return;
-
-  return {
-    data: messages,
-    cachedAt: oldest.cachedAt,
-  };
-};

package/src/messageRepository/observers/observeMessage.ts

@@ -1,94 +0,0 @@
-import { getActiveClient } from '~/client/api';
-
-import { createQuery, runQuery, queryOptions } from '~/core/query';
-import { onMessageMarked, onMessageMarkerFetched } from '~/marker/events';
-import { convertEventPayload } from '~/utils/event';
-
-import { getMessage } from '../api/getMessage';
-
-import { onMessageUpdated, onMessageDeleted } from '../events';
-import { LinkedObject } from '~/utils/linkedObject';
-
-/**
- * ```js
- * import { observeMessage } from '@amityco/ts-sdk-react-native'
- *
- * let message = {}
- *
- * const unsub = observeMessage(messageId, updated => message = updated)
- * ```
- *
- * Observe all mutations on a {@link Amity.Message} given a single messageId
- *
- * @param client the client to observe the message with
- * @param messageId the ID of the message to observe
- * @param callback the function to call when new data are available
- * @param policy a query policy option for this observer
- * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the message
- *
- * @category Message Observer
- */
-export const observeMessage = <Events extends ['onFetch', 'onUpdate', 'onDelete']>(
-  messageId: Amity.Message['messageId'],
-  callback: Amity.ObjectListener<Amity.Snapshot<Amity.Message>, Events>,
-  policy: Amity.QueryPolicy = 'cache_then_server',
-): Amity.Unsubscriber => {
-  const { log } = getActiveClient();
-
-  const timestamp = Date.now();
-  log(`observeMessage(tmpid: ${timestamp}) > listen`);
-
-  console.log(
-    'observeMessage will be deprecated on 15th November 2022, please use liveMessage instead.',
-  );
-
-  // wrapper function to make sure
-  const router = (result: Amity.Snapshot<Amity.Message>, action: Events[number]) => {
-    // filter function
-    if (result.data?.messageId !== messageId) return;
-
-    if (callback instanceof Function) return callback(result);
-
-    if (action !== 'onFetch') callback.onEvent?.(action, result);
-
-    callback[action]?.(result);
-  };
-
-  const disposers: Amity.Unsubscriber[] = [];
-
-  disposers.push(
-    onMessageUpdated(data =>
-      router({ data: LinkedObject.message(data), loading: false, origin: 'event' }, 'onUpdate'),
-    ),
-    onMessageDeleted(data =>
-      router({ data: LinkedObject.message(data), loading: false, origin: 'event' }, 'onDelete'),
-    ),
-    convertEventPayload(
-      onMessageMarkerFetched,
-      'contentId',
-      'message',
-    )(data =>
-      router({ data: LinkedObject.message(data), loading: false, origin: 'event' }, 'onUpdate'),
-    ),
-    convertEventPayload(
-      onMessageMarked,
-      'contentId',
-      'message',
-    )(data =>
-      router({ data: LinkedObject.message(data), loading: false, origin: 'event' }, 'onUpdate'),
-    ),
-  );
-
-  if (policy !== 'no_fetch') {
-    runQuery(
-      createQuery(getMessage, messageId),
-      result => result.data && router(result, 'onFetch'),
-      queryOptions(policy),
-    );
-  }
-
-  return () => {
-    log(`observeMessages(tmpid: ${timestamp}) > dispose`);
-    disposers.forEach(fn => fn());
-  };
-};