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

package/src/core/model/identifyModel.ts

@@ -1,24 +1,48 @@
-/** hidden */
-/** @hidden */
-const CRITERIAS: Record<Amity.Domain, string[]>  = {
-  'file': ['fileId', 'attributes'],
-  'user': ['userId', 'avatarFileId'],
-  'role': ['roleId'],
-  'channel': ['channelId', 'rateLimit'],
-  'channelUsers': ['channelId', 'userId', 'membership'],
-  'message': ['messageId'],
-  'community': ['communityId', 'onlyAdminCanPost'],
-  'communityUsers': ['userId', 'communityId', 'communityMembership'],
-  'post': ['postId', 'feedId'],
-  'comment': ['commentId', 'referenceId'],
-  'stream': ['streamId'],
-}
+/**
+ * Manually computed type which links each key with array
+ * of matching keys as values. The type is computed rather
+ * than letting string[] to help identifying mistakes while
+ * adding new models.
+ * @hidden
+ */
+type Criterias<T extends Amity.Domain[] = Amity.Domain[]> = {
+  [K in T[number]]: (keyof Amity.Model[K])[];
+};
+
+/**
+ * Identification criterias
+ *
+ * As key, the name of the identified model ;
+ * As value, the list of properties to consider a given model as of type
+ *
+ * Used as source of truth for {@link identifyModel}
+ *
+ * @hidden
+ */
+const CRITERIAS: Criterias = {
+  file: ['fileId', 'attributes'],
+  user: ['userId', 'avatarFileId'],
+  role: ['roleId'],
+  channel: ['channelId', 'rateLimit'],
+  channelUsers: ['channelId', 'userId', 'membership'],
+  message: ['messageId'],
+  community: ['communityId', 'postSetting'],
+  category: ['categoryId'],
+  communityUsers: ['userId', 'communityId', 'communityMembership'],
+  post: ['postId', 'feedId'],
+  comment: ['commentId', 'referenceId'],
+  poll: ['pollId'],
+  reaction: ['reactionId'],
+  stream: ['streamId'],
+  follow: ['from', 'to'],
+  followCount: ['userId', 'followerCount'],
+};
 
 /** @hidden */
-const hasKeys = (object: { [k: string]: any }, needles: string[]) => {
-  const haystack = Object.keys(object)
-  return needles.every(needle => haystack.includes(needle))
-}
+const hasKeys = (object: Record<string, unknown>, needles: string[]) => {
+  const haystack = Object.keys(object);
+  return needles.every(needle => haystack.includes(needle));
+};
 
 /**
  * Finds the name of the store for a given unknown model
@@ -26,7 +50,28 @@ const hasKeys = (object: { [k: string]: any }, needles: string[]) => {
  * @param model one of the {@link Amity.Model} to identify
  * @returns the name of the corresponding store
  */
-export const identifyModel = (model: Amity.Model[Amity.Domain]) => {
-  const criterias = Object.entries(CRITERIAS) as [Amity.Domain, string[]][]
-  return criterias.find(([_, keys]) => hasKeys(model, keys))?.[0]
-}
+export const identifyModel = (model: Record<string, unknown>) => {
+  // we cannot avoid "as" in here because Object.entries does not
+  // allow anything else than "string" as key in the iterator type
+  const criterias = Object.entries(CRITERIAS) as [Amity.Domain, string[]][];
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  return criterias.find(([_, keys]) => hasKeys(model, keys))?.[0];
+};
+
+/*
+ * Identify the modal key for a model
+ * Used to get args for optimistic updates
+ * Example: createMessage: get messageId on optimistic message creation
+ *
+ * @param model to be recognized
+ * @returns model key array if one if found or undefined
+ */
+export const identifyModelKey = (model: Record<string, unknown>): string | undefined => {
+  const modalKey = identifyModel(model);
+
+  if (!modalKey) {
+    return undefined;
+  }
+
+  return CRITERIAS[modalKey]?.[0];
+};

package/src/core/model/index.ts

@@ -1,3 +1,29 @@
-export * from './identifyModel'
-export * from './idResolvers'
-export * from './toRecord'
+export * from './idResolvers';
+export * from './identifyModel';
+
+/**
+ * A map of v3 response keys to a store name.
+ * @hidden
+ */
+export const PAYLOAD2MODEL: Record<string, Amity.Domain> = {
+  users: 'user',
+  files: 'file',
+  roles: 'role',
+
+  channels: 'channel',
+  channelUsers: 'channelUsers',
+  messages: 'message',
+
+  communities: 'community',
+  categories: 'category',
+  communityUsers: 'communityUsers',
+  posts: 'post',
+  postChildren: 'post',
+  comments: 'comment',
+  polls: 'poll',
+  reactions: 'reaction',
+  videoStreamings: 'stream',
+
+  follows: 'follow',
+  followCounts: 'followCount',
+};

package/src/core/query/filtering.ts

@@ -12,6 +12,14 @@
  *
  * @hidden
  */
-export const filterByPropEquality = <T = {}>(collection: T[], key: keyof T, value: any) => (
-  value !== undefined ? collection.filter(item => item[key] === value) : collection
-)
+export const filterByPropEquality = <T = Record<string, unknown>>(
+  collection: T[],
+  key: keyof T,
+  value: any,
+) => (value !== undefined ? collection.filter(item => item[key] === value) : collection);
+
+export const filterByPropInclusion = <T = Record<string, unknown>>(
+  collection: T[],
+  key: keyof T,
+  value: any[] | undefined,
+) => (value !== undefined ? collection.filter(item => value.includes(item[key])) : collection);

package/src/core/query/index.ts

@@ -1,5 +1,4 @@
-export * from './query'
-export * from './decorate'
-export * from './filtering'
-export * from './sorting'
-export * from './paging'
+export * from './query';
+export * from './filtering';
+export * from './sorting';
+export * from './paging';

package/src/core/query/paging.ts

@@ -1,5 +1,4 @@
-// @ts-ignore
-import { encode, decode } from 'js-base64'
+import { encode, decode } from 'js-base64';
 
 /**
  * Type guard to find if the a given decoded backend token uses "skip/limit" pagination style
@@ -9,9 +8,8 @@ import { encode, decode } from 'js-base64'
  *
  * @hidden
  */
-export const isSkipLimit = (json: Object): json is Amity.SkipLimitPagination => (
-  ['skip', 'limit'].some(prop => prop in json)
-)
+export const isSkipLimit = (json: Record<string, unknown>): json is Amity.SkipLimitPagination =>
+  ['skip', 'limit'].some(prop => prop in json);
 
 /**
  * Type guard to find if the a given decoded backend token uses "after/before" pagination style
@@ -21,25 +19,36 @@ export const isSkipLimit = (json: Object): json is Amity.SkipLimitPagination =>
  *
  * @hidden
  */
-export const isAfterBefore = (json: Object): json is Amity.AfterBeforePagination => (
-  ['after', 'before', 'first', 'last'].some(prop => prop in json)
-)
+export const isAfterBefore = (json: Record<string, unknown>): json is Amity.AfterBeforePagination =>
+  ['after', 'before', 'first', 'last', 'limit'].some(prop => prop in json);
+
+/**
+ * Type guard to find if the a given decoded backend token uses v4 or newer "after/before" pagination style
+ *
+ * @param json any json object as extracted from the backend
+ * @returns success boolean if the token has either "after" or "before" props
+ *
+ * @hidden
+ */
+export const isAfterBeforeRaw = (
+  json: Record<string, unknown>,
+): json is Amity.AfterBeforeRawPagination => 'limit' in json;
 
 /**
  * Type guard to find if the a given object is wrapped around Amity.Paged<>
  *
  * @param payload any object as passed from query functions
- * @returns success boolean if the object is an array shaped as [Record<string, Amity.Syncable>, Amity.Pages]
+ * @returns success boolean if the object is an object shaped as { data: T[] } & Amity.Pages
  *
  * @hidden
  */
-export const isPaged = (payload: any): payload is Amity.Paged<any> => {
+export const isPaged = <T extends unknown>(payload: any): payload is Amity.Paged<T, any> => {
   return (
-     payload?.hasOwnProperty('data')
-  && payload?.hasOwnProperty('nextPage')
-  && payload?.hasOwnProperty('prevPage')
-  )
-}
+    payload?.hasOwnProperty('data') &&
+    payload?.hasOwnProperty('nextPage') &&
+    payload?.hasOwnProperty('prevPage')
+  );
+};
 
 /**
  * Converts a paging object into a b64 string token
@@ -51,49 +60,51 @@ export const isPaged = (payload: any): payload is Amity.Paged<any> => {
  * @hidden
  */
 export const toToken = (
-  paging: Amity.Page | undefined,
-  style: 'skiplimit' | 'afterbefore',
-
+  paging: Amity.Page | Amity.PageRaw | undefined,
+  style: Amity.PaginationStyles,
 ): Amity.Token | undefined => {
-  if (!paging || !Object.keys(paging).length)
-    return
+  if (!paging || !Object.keys(paging).length) return;
 
-  let payload = {}
+  let payload = {};
 
   // TODO: refactor this clean
   if (style === 'skiplimit') {
     payload = {
       skip: paging.after ?? 0,
       limit: paging.limit,
-    }
-  }
-  else if (style === 'afterbefore') {
+    };
+  } else if (style === 'afterbefore' && isAfterBefore(paging)) {
     /*
       Caution: this testing style is only valid because
       our backend expects nothing else than a number as
       "before" or "after" value. if that would change,
       we'd need to move toward a more simple: `!paging.before`
     */
-    if (!isNaN(paging?.before!)) {
+    if (!Number.isNaN(Number(paging?.before!))) {
       payload = {
         before: paging.before,
         last: paging.limit,
-      }
-    } else if (!isNaN(paging?.after!)) {
+      };
+    } else if (!Number.isNaN(Number(paging?.after!))) {
       payload = {
         after: paging.after,
         first: paging.limit,
-      }
+      };
+    } else if (!Number.isNaN(Number(paging?.limit!))) {
+      payload = {
+        last: paging.limit,
+      };
     }
+  } else if (style === 'afterbeforeraw') {
+    payload = paging;
   }
 
   // avoid sending {} as it seems backend flips when we do
-  if (!Object.keys(payload).length)
-    return
+  if (!Object.keys(payload).length) return;
 
   // don't try catch, let it throw
-  return encode(JSON.stringify(payload))
-}
+  return encode(JSON.stringify(payload));
+};
 
 /**
  * Converts a b64 string token into a paging object
@@ -103,64 +114,53 @@ export const toToken = (
  *
  * @hidden
  */
-export const toPage = (token?: Amity.Token): Amity.Page | null => {
-  if (!token) return null
+export const toPage = (token?: Amity.Token): Amity.Page | undefined => {
+  if (!token) return undefined;
 
   // don't try catch, let it throw
-  const json = JSON.parse(decode(token))
+  const json = JSON.parse(decode(token));
 
   if (isSkipLimit(json)) {
     return {
       after: json.skip,
       limit: json.limit!,
-    } as Amity.NextPage
-  } else if (isAfterBefore(json)) {
+    } as Amity.NextPage<number>;
+  }
+  if (isAfterBefore(json)) {
     if ('before' in json) {
       return {
         before: json.before,
         limit: json.last,
-      } as Amity.PrevPage
-    } else if ('after' in json) {
+      } as Amity.PrevPage<number>;
+    }
+    if ('after' in json) {
       return {
         after: json.after,
         limit: json.first,
-      } as Amity.NextPage
+      } as Amity.NextPage<number>;
     }
   }
 
-  return null
-}
+  return undefined;
+};
 
 /**
- * Slices a collection according to its paging
+ * Converts a b64 string token into a paging object
  *
- * @param type the type of collection (for unique id identification with after/before)
- * @param collection the collection to slice
- * @param paging the paging object
- * @returns the sliced collection according to the paging definition
+ * @param token the backend's b64 encoded token
+ * @returns a sdk-friendly paging object
  *
  * @hidden
  */
-export const sliceByPaging = <K extends Amity.Domain, T extends Amity.Model[K]>(
-  type: K, collection: T[], page?: Amity.Page
-) => {
-  console.log('slice by paging', page)
-  if (!page) return collection.slice()
-
-  let start: number | undefined = 0
-  let end: number | undefined = undefined
-
-  // next page behavior
-  if (page.after) {
-    start = page.after
-    end = start + page.limit
-  // prev page behavior
-  } else if (page.before) {
-    end = page.before + 1
-    start = end > page.limit ? end - page.limit : 0
-  }
+export const toPageRaw = (token?: Amity.Token): Amity.PageRaw | undefined => {
+  if (!token) return undefined;
 
-  const paged = collection.slice(start, end)
+  // don't try catch, let it throw
+  const json = JSON.parse(decode(token));
+
+  if (isAfterBeforeRaw(json)) {
+    return json as Amity.PageRaw;
+  }
 
-  return paged.length === page.limit ? paged : undefined
-}
+  return undefined;
+};