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

package/src/core/query/query.ts

@@ -1,6 +1,8 @@
-import { syncInCache } from '../cache'
+/* eslint-disable no-use-before-define */
+import { isPaged } from './paging';
+import { identifyModelKey } from '~/core/model';
 
-import { isPaged } from './paging'
+import { CACHE_LIFESPAN } from '~/cache/utils';
 
 /**
  * Type guard to check and cast that a given async function is has the ".locally" property
@@ -11,10 +13,8 @@ import { isPaged } from './paging'
  * @hidden
  */
 export const isFetcher = <Args extends any[], Returned extends any>(
-  func: Amity.AsyncFunc<Args, Returned>
-): func is Amity.FetcherFunc<Args, Returned> => (
-  'locally' in func
-)
+  func: Amity.AsyncFunc<Args, Returned>,
+): func is Amity.FetcherFunc<Args, Returned> => 'locally' in func;
 
 /**
  * Type guard to check and cast that a given async function is has the ".optimistically" property
@@ -25,10 +25,8 @@ export const isFetcher = <Args extends any[], Returned extends any>(
  * @hidden
  */
 export const isMutator = <Args extends any[], Returned extends any>(
-  func: Amity.AsyncFunc<Args, Returned>
-): func is Amity.MutatorFunc<Args, Returned> => (
-  'optimistically' in func
-)
+  func: Amity.AsyncFunc<Args, Returned>,
+): func is Amity.MutatorFunc<Args, Returned> => 'optimistically' in func;
 
 /**
  * Type guard to check and cast that a given async function is has
@@ -40,58 +38,44 @@ export const isMutator = <Args extends any[], Returned extends any>(
  * @hidden
  */
 export const isOffline = <Args extends any[], Returned extends any>(
-  func: Amity.AsyncFunc<Args, Returned>
-): func is Amity.OfflineFunc<Args, Returned> => isFetcher(func) || isMutator(func)
+  func: Amity.AsyncFunc<Args, Returned>,
+): func is Amity.OfflineFunc<Args, Returned> => isFetcher(func) || isMutator(func);
 
 /**
- * Type guard to check and cast that a given object has the "syncedAt" property
+ * Type guard to check and cast that a given object has the "cachedAt" property
  *
  * @param model any object to check on
- * @returns success boolean if the object has property "syncedAt"
+ * @returns success boolean if the object has property "cachedAt"
  *
  * @hidden
  */
-export const isSyncable = (model: any): model is Amity.Syncable => (
-  model?.hasOwnProperty('syncedAt')
-)
+export const isCachable = (model: any): model is Amity.Cachable =>
+  model?.hasOwnProperty('cachedAt');
 
 /**
- * Checks if a model is considered local (syncedAt === -1)
+ * Checks if a model is considered local (cachedAt === -1)
  *
- * @param model any syncable object to check
+ * @param model any cachable object to check
  * @returns success boolean if the object is marked as local
  *
  * @hidden
  */
-export const isLocal = (model?: any): model is Amity.Syncable => {
-  return isSyncable(model) && model?.syncedAt === -1
-}
+export const isLocal = (model?: any): model is Amity.Local => {
+  return isCachable(model) && model?.cachedAt === -1;
+};
 
 /**
  * Checks if a model is considered fresh
  *
- * @param model any syncable object to check
+ * @param model any cachable object to check
  * @param lifeSpan the supposedly duration for which the object is considered synced
  * @returns success boolean if the object is below the given lifespan
  *
  * @hidden
  */
-export const isFresh = (model?: Amity.Syncable, lifeSpan: number = 0) => {
-  return Date.now() - (model?.syncedAt ?? 0) <= lifeSpan
-}
-
-/**
- * Checks if a model is considered synced
- *
- * @param model any syncable object to check
- * @param lifeSpan the supposedly duration for which the object is considered synced
- * @returns success boolean if the object is local or below the given lifespan
- *
- * @hidden
- */
-export const isSynced = (model?: any, lifeSpan: number = 0) => {
-  return isLocal(model) || isFresh(model, lifeSpan)
-}
+export const isFresh = (model?: Amity.Cachable, lifeSpan = CACHE_LIFESPAN) => {
+  return Date.now() - (model?.cachedAt ?? 0) <= lifeSpan;
+};
 
 /**
  * ```js
@@ -103,7 +87,7 @@ export const isSynced = (model?: any, lifeSpan: number = 0) => {
  * This wrapper is necessary to create for optimistically calls
  *
  *
- * @param fn A compatible API function from the ts sdk
+ * @param func A compatible API function from the ts sdk
  * @param args The arguments to pass to the function passed as `fn`
  * @returns A wrapper containing both the function and its future arguments
  *
@@ -112,8 +96,7 @@ export const isSynced = (model?: any, lifeSpan: number = 0) => {
 export const createQuery = <Args extends any[], Returned extends any>(
   func: Amity.AsyncFunc<Args, Returned> | Amity.OfflineFunc<Args, Returned>,
   ...args: Args
-) => ({ func, args })
-
+) => ({ func, args });
 
 /**
  * ```js
@@ -129,15 +112,13 @@ export const createQuery = <Args extends any[], Returned extends any>(
  * @category Query
  */
 export const queryOptions = (
-  policy: Amity.QueryPolicy, lifeSpan: number = 2 * 60 * 1000, // 2mn
+  policy: Amity.QueryPolicy,
+  lifeSpan: number = CACHE_LIFESPAN, // 1mn
 ): Amity.QueryOptions => {
-  if (policy === 'cache_only')
-    return { lifeSpan: Infinity }
-  else if (policy === 'server_only')
-    return { lifeSpan: 0 }
+  if (policy === 'cache_only') return { lifeSpan: Infinity };
 
-  return { lifeSpan }
-}
+  return { lifeSpan: lifeSpan < CACHE_LIFESPAN ? CACHE_LIFESPAN : lifeSpan };
+};
 
 /**
  * Checks if an unknown shaped payload is considered empty or not.
@@ -149,61 +130,20 @@ export const queryOptions = (
  *
  * @hidden
  */
-const isEmpty = (local: any) => {
+const isEmpty = (local: unknown) => {
   // if it's supposed to be a single object, it'd be undefined
-  if (!local)
-    return true
+  if (!local) return true;
 
   // it's a paged query, the 1st cell of the array would be empty
-  else if (isPaged(local) && isEmpty(local.data)) {
-    return true
+  if (isPaged(local) && isEmpty(local.data)) {
+    return true;
   }
 
   // if it's a item collection, it'd have no keys
-  else if (!Object.keys(local).length)
-    return true
+  if (typeof local === 'object' && !Object.keys(local).length) return true;
 
-  return false
-}
-
-/**
- * Checks if an unknown shaped payload is considered synced or not.
- * The object will first be identified by 3 types of shapes:
- *
- * 1. Amity.Paged<Amity.Syncable>
- * 2. Amity.Syncable
- * 3. Record<string, Amity.Syncable>
- *
- * then the "Syncable" component will be extracted and evaluated against
- * the query options' lifeSpan value.
- *
- * @param local the unknown object to check for freshness
- * @param options query options (for lifeSpan checking)
- * @returns true if the mixed-shape "local" content is considered fresh
- *
- * @hidden
- */
-const shouldAbort = (local: any, options: Amity.QueryOptions) => {
-  // it's a paged query
-  if (isPaged(local) && shouldAbort(local.data, options)) {
-    return true
-  }
-
-  // if it's object let's try to see if it's Amity.Syncable first
-  else if (isSynced(local, options.lifeSpan)) {
-    return true
-  }
-
-  // otherwise consider as Record<string, Amity.Syncable>
-  else if (
-    Object.values(local).length > 0 &&
-    Object.values(local).every(item => isSynced(item, options.lifeSpan))
-  ) {
-    return true
-  }
-
-  return false
-}
+  return false;
+};
 
 /**
  * ```js
@@ -224,77 +164,112 @@ const shouldAbort = (local: any, options: Amity.QueryOptions) => {
  */
 export const runQuery = <Args extends any[], Returned extends any>(
   { func, args }: Amity.Query<Args, Returned>,
-  callback?: (args: Amity.QueryResult<Returned | undefined>) => void,
-  options: Amity.QueryOptions = queryOptions('cache_then_server')
+  callback?: (args: Amity.Snapshot<Returned>) => void,
+  options: Amity.QueryOptions = queryOptions('cache_then_server'),
 ) => {
-  if (!isOffline(func) || options.lifeSpan === 0) {
-    callback?.(wrap(undefined, {
-      origin: 'server',
-      loading: true
-    }))
+  let local: Returned | undefined;
 
-    func(...args)
-      .then(fresh => {
-        callback?.(wrap(fresh, {
-          origin: 'server',
+  const { lifeSpan } = queryOptions('cache_then_server', options.lifeSpan);
+
+  // offline first
+  if (isOffline(func)) {
+    try {
+      local = isMutator(func) ? func.optimistically(...args) : func.locally(...args);
+    } catch (error) {
+      callback?.(
+        createSnapshot<Returned>(undefined, {
+          origin: 'local',
           loading: false,
-        }))
-      })
-      .catch(error => {
-        callback?.(wrap(undefined, {
           error,
-          loading: false,
-        }))
-      })
+        }),
+      );
+    }
 
-    return
-  }
+    const shouldAbort = isCachable(local) && isFresh(local, lifeSpan);
 
-  const local = isMutator(func)
-    ? func.optimistically(...args)
-    : func.locally(...args)
+    callback?.(
+      createSnapshot<Returned>(local, {
+        origin: 'local',
+        loading: !(isFetcher(func) && shouldAbort),
+      }),
+    );
 
-  if (!isEmpty(local)) {
-    callback?.(wrap(local, { origin: 'local' }))
+    if (shouldAbort) return;
+  } else {
+    callback?.(
+      createSnapshot<Returned>(undefined, {
+        origin: 'local',
+        loading: true,
+      }),
+    );
   }
 
-  if (local && isFetcher(func) && shouldAbort(local, options)) return
-
-  callback?.(wrap(local, {
-    origin: 'local',
-    loading: true,
-  }))
+  let optimisticArgs = args;
+  /* get args for optimistic method calls
+   *
+   * On optimistic updates, the modal key for the update needs to be passed to
+   * the server so as to avoid duplicate modal creation
+   *
+   * ex: on creating a new message pass the modalKey is messageId, pass this
+   * id onto the server so that a duplicate with seperate messageId is not
+   * created.
+   */
+  if (isMutator(func)) {
+    // @ts-ignore
+    const modelKey = local && local.data && identifyModelKey(local.data);
+    if (modelKey) {
+      /*
+       * modal key is only required for create as update and delete queries pass
+       * the modal key in the param itself
+       * For update & delete the first argument is always an id which is of type
+       * string, whereas for create the first and only argument is the param object
+       *
+       * When creating an AmityObject optimistically we need to pass the modal key
+       * on to the server. ex: for create message modal key will be 'messageId`
+       */
+      if (typeof args[0] !== 'string') {
+        // @ts-ignore
+        optimisticArgs = [{ ...args[0], [modelKey]: local.data[modelKey] }];
+      }
+    }
+  }
 
-  func(...args)
+  func(...optimisticArgs)
     .then(fresh => {
       // @ts-ignore i know.
-      isLocal(local) && syncInCache(local, fresh)
+      // isLocal(local) && syncInCache(local, fresh)
 
-      callback?.(wrap(fresh, {
-        origin: 'server',
-        loading: false
-      }))
+      callback?.(
+        createSnapshot<Returned>(fresh, {
+          origin: 'server',
+          loading: false,
+        }),
+      );
     })
     .catch(error => {
-      callback?.(wrap(local, {
-        error,
-        loading: false,
-      }))
-    })
-}
+      callback?.(
+        createSnapshot<Returned>(undefined, {
+          origin: 'server',
+          loading: false,
+          error,
+        }),
+      );
+    });
+};
 
 /**
+ * This is a TS hack around types
  *
  * @param data
- * @param meta
- * @returns
+ * @param options
+ *
+ * @category Query API
+ * @hidden
  */
-const wrap = <T extends any>(data: T, meta: Amity.QueryMetadata = {}) => {
-  if (isPaged(data))
-    return {
-      ...meta,
-      ...data as Amity.Paged<T>,
-    } as Amity.QueryResult<T>
+function createSnapshot<T>(data: T | undefined, options?: Amity.SnapshotOptions): Amity.Snapshot<T>;
+// eslint-disable-next-line no-redeclare
+function createSnapshot(data: unknown, options?: Amity.SnapshotOptions): unknown {
+  if (isPaged(data) || isCachable(data)) return { ...options, ...data };
 
-  return { ...meta, data } as Amity.QueryResult<T>
+  return { ...options, data };
 }

package/src/core/query/sorting.ts

@@ -2,49 +2,55 @@
 // this file should contain a suite of sorting utilities to help the
 // local version of the query functions.
 
-type SortingFunc<T = Object> = (a: T, b: T) => number
+type SortingFunc<T = Record<string, unknown>> = (a: T, b: T) => number;
 
 /**
  * Alphabetic sorting of objects having a displayName
  */
 export const sortByDisplayName: SortingFunc<{ displayName: string }> = (
-  { displayName: a }, { displayName: b }
+  { displayName: a },
+  { displayName: b },
 ) => {
-  if (a === b) return 0
-  return a < b ? -1 : 1
-}
+  if (a === b) return 0;
+  return a < b ? -1 : 1;
+};
 
 /**
  * Sorting a collection by their apparition order (oldest first)
  */
 export const sortByChannelSegment: SortingFunc<{ channelSegment: number }> = (
-  { channelSegment: a }, { channelSegment: b }
-) => a - b
+  { channelSegment: a },
+  { channelSegment: b },
+) => a - b;
 
 /**
  * Sorting a collection by their apparition order (oldest first)
  */
 export const sortBySegmentNumber: SortingFunc<{ segmentNumber: number }> = (
-  { segmentNumber: a }, { segmentNumber: b }
-) => a - b
+  { segmentNumber: a },
+  { segmentNumber: b },
+) => a - b;
 
 /**
  * Sorting a collection by its oldest items
  */
 export const sortByFirstCreated: SortingFunc<{ createdAt: Date | number | string }> = (
-  { createdAt: a }, { createdAt: b }
-) => new Date(a).valueOf() - new Date(b).valueOf()
+  { createdAt: a },
+  { createdAt: b },
+) => new Date(a).valueOf() - new Date(b).valueOf();
 
 /**
  * Sorting a collection by its newest items
  */
 export const sortByLastCreated: SortingFunc<{ createdAt: Date | number | string }> = (
-  { createdAt: a }, { createdAt: b }
-) => new Date(b).valueOf() - new Date(a).valueOf()
+  { createdAt: a },
+  { createdAt: b },
+) => new Date(b).valueOf() - new Date(a).valueOf();
 
 /**
  * Sorting a collection by the items with most recent activity
  */
 export const sortByLastActivity: SortingFunc<{ lastActivity: Date | number | string }> = (
-  { lastActivity: a }, { lastActivity: b }
-) => new Date(b).valueOf() - new Date(a).valueOf()
+  { lastActivity: a },
+  { lastActivity: b },
+) => new Date(b).valueOf() - new Date(a).valueOf();

package/src/core/subscription.ts

@@ -0,0 +1,104 @@
+import { getActiveClient } from '~/client/api/activeClient';
+import { ASCError } from '~/core/errors';
+import { proxyMqttEvents } from '~/core/events';
+import { getActiveUser } from '~/client/api/activeUser';
+
+export enum SubscriptionLevels {
+  COMMUNITY = 'community',
+  POST = 'post',
+  COMMENT = 'comment',
+  POST_AND_COMMENT = 'post_and_comment',
+  USER = 'user',
+}
+
+const getCommunityUserTopic = (
+  path: Amity.Subscribable['path'],
+  level?: SubscriptionLevels,
+): string => {
+  switch (level) {
+    case 'post':
+      return `${path}/post/+`;
+    case 'comment':
+      return `${path}/post/+/comment/+`;
+    case 'post_and_comment':
+      return `${path}/post/#`;
+    default:
+      return path;
+  }
+};
+
+export const getCommunityTopic = (
+  { path }: Amity.Subscribable,
+  level: Exclude<SubscriptionLevels, SubscriptionLevels.USER> = SubscriptionLevels.COMMUNITY,
+): string => getCommunityUserTopic(path, level);
+
+export const getUserTopic = (
+  { path }: Amity.Subscribable,
+  level: Exclude<SubscriptionLevels, SubscriptionLevels.COMMUNITY> = SubscriptionLevels.USER,
+): string =>
+  getCommunityUserTopic(
+    level === SubscriptionLevels.USER ? path : path.replace(/^(\w*)/, '$1/social'),
+    level,
+  );
+
+export const getPostTopic = (
+  { path }: Amity.Subscribable,
+  level: SubscriptionLevels.POST | SubscriptionLevels.COMMENT = SubscriptionLevels.POST,
+): string => {
+  switch (level) {
+    case 'comment':
+      return `${path}/comment/+`;
+    default:
+      return path;
+  }
+};
+
+export const getCommentTopic = ({ path }: Amity.Subscribable): string => {
+  return path;
+};
+
+export const getMyFollowersTopic = (): string => {
+  const user = getActiveUser();
+
+  const [networkId] = user.path.split('/user/');
+
+  return `${networkId}/membership/${user._id}/+/+`;
+};
+
+export const getMyFollowingsTopic = (): string => {
+  const user = getActiveUser();
+
+  const [networkId] = user.path.split('/user/');
+
+  return `${networkId}/membership/+/${user._id}/+`;
+};
+
+/** @hidden */
+export const getNetworkTopic = (): string => {
+  const user = getActiveUser();
+
+  const [networkId] = user.path.split('/user/');
+
+  return networkId;
+};
+
+let mqttAccessToken: string;
+let mqttUserId: string;
+
+export function subscribeTopic(
+  topic: string,
+  callback?: Amity.Listener<ASCError | void>,
+): Amity.Unsubscriber {
+  const { mqtt, emitter, accessToken } = getActiveClient();
+  const user = getActiveUser();
+
+  if (mqttAccessToken !== accessToken || mqttUserId !== user._id) {
+    mqttAccessToken = accessToken!;
+    mqttUserId = user._id!;
+
+    mqtt.connect({ accessToken: mqttAccessToken, userId: mqttUserId });
+    proxyMqttEvents(mqtt, emitter);
+  }
+
+  return mqtt.subscribe(topic, callback);
+}

package/src/core/tests/query/filtering.test.ts

@@ -0,0 +1,11 @@
+import { filterByPropEquality } from '~/core/query';
+
+describe('Core/Query/Filtering', () => {
+  test('check filterByPropEquality', () => {
+    const prop = 'prop';
+    const collection = [{ [prop]: 'value' }];
+
+    expect(filterByPropEquality(collection, prop, 'value')).toStrictEqual(collection);
+    expect(filterByPropEquality(collection, prop, 'otherValue')).toStrictEqual([]);
+  });
+});