@amityco/ts-sdk 0.0.1-beta.13 → 0.0.1-beta.14

package/dist/message/api/createMessage.d.ts

@@ -16,7 +16,7 @@
  * @async
  */
 export declare const createMessage: {
-    <T extends Amity.MessageContentType>(bundle: Pick<Amity.Message<T>, "type" | "channelId" | "data" | "metadata">): Promise<Amity.Cached<Amity.Message>>;
+    <T extends Amity.MessageContentType>(bundle: Pick<Amity.Message<T>, "type" | "channelId" | "data" | "metadata" | "mentionees">): Promise<Amity.Cached<Amity.Message>>;
     /**
      * ```js
      * import { createMessage } from '@amityco/ts-sdk'
@@ -33,6 +33,6 @@ export declare const createMessage: {
      *
      * @category Message API
      */
-    optimistically(bundle: Pick<Amity.Message, 'channelId' | 'type' | 'data' | 'metadata'>): Amity.Cached<Amity.Message> | undefined;
+    optimistically(bundle: Pick<Amity.Message, 'channelId' | 'type' | 'data' | 'metadata' | 'mentionees'>): Amity.Cached<Amity.Message> | undefined;
 };
 //# sourceMappingURL=createMessage.d.ts.map

package/dist/message/api/createMessage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createMessage.d.ts","sourceRoot":"","sources":["../../../src/message/api/createMessage.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;sHAEvB,QAAQ,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,CAAC;IAoBvC;;;;;;;;;;;;;;;OAeG;2BAEO,KAAK,MAAM,OAAO,EAAE,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,GACtE,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,SAAS;CApBzC,CAAA"}
+{"version":3,"file":"createMessage.d.ts","sourceRoot":"","sources":["../../../src/message/api/createMessage.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;qIAEvB,QAAQ,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,CAAC;IAoBvC;;;;;;;;;;;;;;;OAeG;2BAEO,KAAK,MAAM,OAAO,EAAE,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,YAAY,CAAC,GACrF,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,SAAS;CApBzC,CAAA"}

package/dist/message/api/updateMessage.d.ts

@@ -16,7 +16,7 @@
  * @async
  */
 export declare const updateMessage: {
-    (messageId: Amity.Message['messageId'], patch: Patch<Amity.Message, 'data' | 'metadata'>): Promise<Amity.Cached<Amity.Message>>;
+    (messageId: Amity.Message['messageId'], patch: Patch<Amity.Message, 'data' | 'metadata' | 'mentionees'>): Promise<Amity.Cached<Amity.Message>>;
     /**
      * ```js
      * import { updateMessage } from '@amityco/ts-sdk'
@@ -33,6 +33,6 @@ export declare const updateMessage: {
      *
      * @category Message API
      */
-    optimistically(messageId: Amity.Message['messageId'], patch: Patch<Amity.Message, 'data' | 'metadata'>): Amity.Cached<Amity.Message> | undefined;
+    optimistically(messageId: Amity.Message['messageId'], patch: Patch<Amity.Message, 'data' | 'metadata' | 'mentionees'>): Amity.Cached<Amity.Message> | undefined;
 };
 //# sourceMappingURL=updateMessage.d.ts.map

package/dist/message/api/updateMessage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"updateMessage.d.ts","sourceRoot":"","sources":["../../../src/message/api/updateMessage.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;gBACb,MAAM,OAAO,CAAC,WAAW,CAAC,SAC9B,MAAM,MAAM,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC,GAC/C,QAAQ,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,CAAC;IAmBvC;;;;;;;;;;;;;;;OAeG;8BAEU,MAAM,OAAO,CAAC,WAAW,CAAC,SAC9B,MAAM,MAAM,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC,GAC/C,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,SAAS;CArBzC,CAAA"}
+{"version":3,"file":"updateMessage.d.ts","sourceRoot":"","sources":["../../../src/message/api/updateMessage.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;gBACb,MAAM,OAAO,CAAC,WAAW,CAAC,SAC9B,MAAM,MAAM,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,YAAY,CAAC,GAC9D,QAAQ,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,CAAC;IAmBvC;;;;;;;;;;;;;;;OAeG;8BAEU,MAAM,OAAO,CAAC,WAAW,CAAC,SAC9B,MAAM,MAAM,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,YAAY,CAAC,GAC9D,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,SAAS;CArBzC,CAAA"}

package/dist/post/api/queryPosts.d.ts

@@ -23,8 +23,8 @@ export declare const queryPosts: {
         feedType?: 'reviewing' | 'published';
         tags?: Amity.Taggable['tags'];
         matchingOnlyParentPost?: boolean;
-        page?: Amity.Page;
-    }): Promise<Amity.Cached<Amity.PagedRaw<Amity.Post>>>;
+        page?: Amity.PageRaw;
+    }): Promise<Amity.Cached<Amity.Paged<Amity.Post>>>;
     /**
      * ```js
      * import { queryPosts } from '@amityco/ts-sdk'
@@ -38,6 +38,6 @@ export declare const queryPosts: {
      *
      * @category Post API
      */
-    locally(query: Parameters<typeof queryPosts>[0]): Amity.Cached<Amity.PagedRaw<Amity.Post>> | undefined;
+    locally(query: Parameters<typeof queryPosts>[0]): Amity.Cached<Amity.Paged<Amity.Post>> | undefined;
 };
 //# sourceMappingURL=queryPosts.d.ts.map

package/dist/post/api/queryPosts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryPosts.d.ts","sourceRoot":"","sources":["../../../src/post/api/queryPosts.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU;YACd;QACL,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,IAAI,CAAC,YAAY,CAAC,CAAC;QACrC,MAAM,CAAC,EAAE,aAAa,GAAG,cAAc,GAAG,aAAa,GAAG,cAAc,CAAA;QACxE,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC,WAAW,CAAC,CAAA;QACnC,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,QAAQ,CAAC,EAAE,WAAW,GAAG,WAAW,CAAA;QACpC,IAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC9B,sBAAsB,CAAC,EAAE,OAAO,CAAA;QAChC,IAAI,CAAC,EAAE,MAAM,IAAI,CAAA;KAClB,GACA,QAAQ,MAAM,MAAM,CAAC,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;IAuCpD;;;;;;;;;;;;OAYG;mBAEM,WAAW,iBAAiB,CAAC,CAAC,CAAC,CAAC,GACtC,MAAM,MAAM,CAAC,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,SAAS;CAjBtD,CAAA"}
+{"version":3,"file":"queryPosts.d.ts","sourceRoot":"","sources":["../../../src/post/api/queryPosts.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU;YACd;QACL,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,IAAI,CAAC,YAAY,CAAC,CAAC;QACrC,MAAM,CAAC,EAAE,aAAa,GAAG,cAAc,GAAG,aAAa,GAAG,cAAc,CAAA;QACxE,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC,WAAW,CAAC,CAAA;QACnC,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,QAAQ,CAAC,EAAE,WAAW,GAAG,WAAW,CAAA;QACpC,IAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC9B,sBAAsB,CAAC,EAAE,OAAO,CAAA;QAChC,IAAI,CAAC,EAAE,MAAM,OAAO,CAAA;KACrB,GACA,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;IAuCjD;;;;;;;;;;;;OAYG;mBAEM,WAAW,iBAAiB,CAAC,CAAC,CAAC,CAAC,GACtC,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,SAAS;CAjBnD,CAAA"}

package/dist/role/api/queryRoles.d.ts

@@ -17,7 +17,7 @@ export declare const queryRoles: {
     (query?: {
         displayName?: string | undefined;
         sortBy?: "displayName" | "firstCreated" | "lastCreated" | undefined;
-        page?: Amity.Page | undefined;
+        page?: Amity.Page<number> | undefined;
     } | undefined): Promise<Amity.Cached<Amity.Paged<Amity.Role>>>;
     /**
      * ```js

package/dist/stream/api/queryStreams.d.ts

@@ -19,7 +19,7 @@ export declare const queryStreams: {
         userPublicIds?: string[] | undefined;
         sortBy?: "lastCreated" | "firstCreated" | undefined;
         isDeleted?: Amity.Stream['isDeleted'];
-        page?: Amity.Page | undefined;
+        page?: Amity.Page<number> | undefined;
     } | undefined): Promise<Amity.Cached<Amity.Paged<Amity.Stream>>>;
     /**
      * ```js

package/dist/utils/env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="node" />
+export declare const safeProcess: Partial<NodeJS.Process>;
+export declare function getEnv(): NodeJS.ProcessEnv;
+export declare const isProduction: boolean;
+//# sourceMappingURL=env.d.ts.map

package/dist/utils/env.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"env.d.ts","sourceRoot":"","sources":["../../src/utils/env.ts"],"names":[],"mappings":";AAEA,eAAO,MAAiB,WAAW,yBAAyD,CAAA;AAE5F,wBAAgB,MAAM,sBAAmC;AAEzD,eAAO,MAAM,YAAY,SAA6C,CAAA"}

package/dist/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,OAAO,QAAmC,CAAA"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,OAAO,QAAwC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk",
-  "version": "0.0.1-beta.13",
+  "version": "0.0.1-beta.14",
   "license": "CC-BY-ND-4.0",
   "author": "amity.co <developers@amity.co> (https://amity.co)",
   "description": "Amity Social Cloud Typescript SDK",

package/src/@types/core/cache.ts

@@ -49,11 +49,11 @@ declare global {
      * Minimal CacheEntry alias, used mostly
      */
      type Cached<T extends unknown = unknown> = (
-      T extends (Amity.PagedRaw<any> | Amity.Paged<any>)
+      T extends Amity.Paged<any>
         ? T
         : { data: T }
      ) & {
-      cachedAt?: CacheOptions['cachedAt']
+      cachedAt: CacheOptions['cachedAt']
     }
 
     /**

package/src/@types/core/paging.ts

@@ -2,6 +2,32 @@ export {}
 
 declare global {
   namespace Amity {
+    type PaginationStyles = 'skiplimit' | 'afterbefore' | 'afterbeforeraw'
+
+    type Paging = {
+      limit: number
+    }
+
+    type PrevPage<T extends number | string = number> = Paging & {
+      after?: never
+      before?: T
+    }
+
+    type NextPage<T extends number | string = number> = Paging & {
+      after?: T
+      before?: never
+    }
+
+    type Page<T extends number | string = number> = (PrevPage<T> | NextPage<T>)
+
+    /*
+      updatedAt is here because if you need sort by updatedAt you
+      need to include this data in query also
+    */
+    type PageRaw = Page<string> & {
+      updatedAt?: string
+    }
+
     type SkipLimitPagination = {
       skip?: number
       limit?: number
@@ -22,54 +48,13 @@ declare global {
       last?: number
     }
 
-    type PrevPage = {
-      after?: never
-      before?: number
-      limit: number
-    }
-
-    type NextPage = {
-      after?: number
-      before?: never
-      limit: number
-    }
-
-    type Page = (PrevPage | NextPage)
+    type AfterBeforeRawPagination = PageRaw
 
     type Pages = {
-      nextPage?: Page | null
-      prevPage?: Page | null
+      nextPage?: (Page | PageRaw) | null
+      prevPage?: (Page | PageRaw) | null
     }
 
     type Paged<T> = { data: T[] } & Pages
-
-    type AfterBeforeRawPagination = {
-      before?: string
-      after?: string
-      updatedAt?: string
-    }
-
-    type PrevPageRaw = {
-      after?: never
-      before?: string
-      limit: number
-      updatedAt?: string
-    }
-
-    type NextPageRaw = {
-      after?: string
-      before?: never
-      limit: number
-      updatedAt?: string
-    }
-
-    type PageRaw = (PrevPageRaw | NextPageRaw)
-
-    type PagesRaw = {
-      nextPage?: PageRaw | null
-      prevPage?: PageRaw | null
-    }
-
-    type PagedRaw<T> = { data: T[] } & PagesRaw
   }
 }

package/src/@types/core/query.ts

@@ -46,9 +46,13 @@ declare global {
     }
 
     type Snapshot<T> = (
-      T extends Amity.Cached<infer K> ? { data: K } :
-      T extends (Amity.PagedRaw<any> | Amity.Paged<any>) ? T :
-      { data: T }
+      T extends Amity.Cached<infer T2>
+        ? T2 extends Amity.Paged<infer T3>
+          ? { data: T3[] | undefined } & Pages & { cachedAt?: CacheOptions['cachedAt'] }
+          : { data: T2 }  & { cachedAt?: CacheOptions['cachedAt'] }
+        : T extends Amity.Paged<infer T3>
+          ? { data: T3[] | undefined } & Pages
+          : { data: T | undefined }
     ) & SnapshotOptions
   }
 }

package/src/@types/domains/comment.ts

@@ -5,8 +5,6 @@ declare global {
     type CommentContentType = ('text')
     type CommentReferenceType = ('content' | 'post')
 
-    type CommentMentionType = keyof MentionTypes
-
     type Comment<T extends CommentContentType = any> = {
       commentId: string
       userId: string
@@ -24,6 +22,6 @@ declare global {
     & Amity.Timestamps
     & Amity.SoftDelete
     & Amity.Subscribable
-    & Amity.Mentionable<CommentMentionType>
+    & Amity.Mentionable<'user'>
   }
 }

package/src/@types/domains/mention.ts

@@ -0,0 +1,26 @@
+export {}
+
+declare global {
+  namespace Amity {
+    type Mention = {
+      type: "user" | "channel"
+    }
+
+    type ChannelMention = Mention & {
+      type: "channel"
+    }
+
+    type UserMention = Mention & {
+      type: "user", userIds: string[]
+    }
+
+    type MentionType = {
+      "channel": ChannelMention
+      "user": UserMention
+    }
+
+    type Mentionable<T extends keyof MentionType = 'channel' | 'user'> = {
+      mentionees?: (MentionType[T])[]
+    }
+  }
+}

package/src/@types/domains/message.ts

@@ -22,5 +22,6 @@ declare global {
     & Amity.Timestamps
     & Amity.SoftDelete
     & Amity.Reactable
+    & Amity.Mentionable<'user' | 'channel'>
   }
 }

package/src/@types/domains/partials.ts

@@ -52,13 +52,5 @@ declare global {
     type Subscribable = {
       path: string
     }
-
-    type MentionTypes = {
-      user: { userIds: Amity.User['userId'][] }
-    }
-
-    type Mentionable<T extends keyof MentionTypes> = {
-      mentionees?: {type: T & MentionTypes}[]
-    }
   }
 }

package/src/@types/domains/post.ts

@@ -7,8 +7,6 @@ declare global {
 
     type PostContentType = ('text' | 'image' | 'file' | 'video')
 
-    type PostMentionType = keyof MentionTypes
-
     type Post<T extends PostContentType = any> = {
       postId: string
       postedUserId: User['userId'] // API-FIX: it should be "userId"
@@ -30,6 +28,6 @@ declare global {
     & Amity.Timestamps
     & Amity.SoftDelete
     & Amity.Subscribable
-    & Amity.Mentionable<PostMentionType>
+    & Amity.Mentionable<'user'>
   }
 }

package/src/@types/index.ts

@@ -29,3 +29,5 @@ import './domains/post'
 import './domains/comment'
 
 import './domains/stream'
+
+import './domains/mention'

package/src/channel/api/queryChannelMembers.ts

@@ -44,6 +44,7 @@ export const queryChannelMembers = async (query: {
   const { paging, ...payload } = data
   const { channelUsers } = payload
 
+  const cachedAt = client.cache && Date.now()
   if (client.cache) {
     ingestInCache(payload as Amity.ChannelMembershipPayload)
   }
@@ -51,7 +52,7 @@ export const queryChannelMembers = async (query: {
   const nextPage = toPage(paging.next)
   const prevPage = toPage(paging.previous)
 
-  return { data: channelUsers, nextPage, prevPage }
+  return { data: channelUsers, cachedAt, nextPage, prevPage }
 }
 
 /**

package/src/community/api/queryCommunityMembers.ts

@@ -51,7 +51,7 @@ export const queryCommunityMembers = async (query: {
   const nextPage = toPage(paging.next)
   const prevPage = toPage(paging.previous)
 
-  return { data: communityUsers, nextPage, prevPage }
+  return { data: communityUsers, cachedAt, nextPage, prevPage }
 }
 
 /**

package/src/core/debug.ts

@@ -1,5 +1,7 @@
 import debug from 'debug'
 
+import { isProduction } from '~/utils/env'
+
 /**
  * Creates a pre-configured logger instance
  *
@@ -12,7 +14,7 @@ import debug from 'debug'
 export const createLogger = (session?: string) => {
   const active = (
       `${session?.trim()}`.length > 0
-    && process?.env?.NODE_ENV !== 'production'
+    && !isProduction
   )
 
   const logger = debug(session!)

package/src/core/device.ts

@@ -1,5 +1,6 @@
 // TODO: find a way to uniquely identify the device
 // import { getStorage } from './storage'
+import { safeProcess } from '~/utils/env'
 
 /** @hidden */
 const VERSION = '11.0.0'
@@ -16,8 +17,8 @@ export const getDeviceId = () => {
 
 /** @hidden */
 export const getDeviceModel = () => {
-  if (process?.versions?.node)
-    return process.versions.node
+  if (safeProcess.versions?.node)
+    return safeProcess.versions.node
 
   if (navigator)
     return `${navigator.product.toLowerCase()}#${navigator.userAgent ?? 'unknown_agent'}`

package/src/core/events.ts

@@ -2,6 +2,8 @@ import mitt from 'mitt'
 
 import { getActiveClient } from '~/client/api/activeClient'
 
+import { scheduleTask } from './microtasks'
+
 // need to sync up the list
 const WS_EVENTS = [
   'disconnected',
@@ -134,5 +136,5 @@ export const fireEvent = <T extends keyof Amity.Events>(
   payload: Amity.Events[T],
 ) => {
   const { emitter } = getActiveClient()
-  setTimeout(() => { emitter.emit(event, payload) }, 0)
+  scheduleTask(() => { emitter.emit(event, payload) })
 }

package/src/core/microtasks.ts

@@ -0,0 +1,27 @@
+let tasks: Function[] = []
+let timer: NodeJS.Timeout
+
+/**
+ * Add a function to run just before the next tick
+ *
+ * @param task function to schedule for later execution
+ */
+export const scheduleTask = (task: Function) => {
+  clearTimeout(timer)
+  tasks.push(task)
+
+  timer = setTimeout(() => {
+    tasks.forEach(fn => fn())
+    tasks = []
+  }, 0)
+}
+
+/**
+ * Cancel the scheduling operation
+ *
+ * @param task function to be removed from later execution
+ */
+export const cancelTask = (task: Function) => {
+  tasks = tasks.filter(fn => fn !== task)
+  if (!tasks.length) clearTimeout(timer)
+}

package/src/core/query/paging.ts

@@ -1,4 +1,3 @@
-// @ts-ignore
 import { encode, decode } from 'js-base64'
 
 /**
@@ -22,7 +21,7 @@ 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)
+  ['after', 'before', 'first', 'last', 'limit'].some(prop => prop in json)
 )
 
 /**
@@ -34,7 +33,7 @@ export const isAfterBefore = (json: Object): json is Amity.AfterBeforePagination
  * @hidden
  */
 export const isAfterBeforeRaw = (json: Object): json is Amity.AfterBeforeRawPagination => (
-  ['after', 'before'].some(prop => prop in json)
+  'limit' in json
 )
 
 /**
@@ -63,9 +62,8 @@ export const isPaged = <T extends unknown>(payload: any): payload is Amity.Paged
  * @hidden
  */
 export const toToken = (
-  paging: Amity.Page | undefined,
-  style: 'skiplimit' | 'afterbefore' | 'afterbeforeraw',
-
+  paging: Amity.Page | Amity.PageRaw | undefined,
+  style: Amity.PaginationStyles,
 ): Amity.Token | undefined => {
   if (!paging || !Object.keys(paging).length)
     return
@@ -79,7 +77,7 @@ export const toToken = (
       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
@@ -114,6 +112,7 @@ export const toToken = (
   return encode(JSON.stringify(payload))
 }
 
+
 /**
  * Converts a b64 string token into a paging object
  *
@@ -170,37 +169,3 @@ export const toPageRaw = (token?: Amity.Token): Amity.PageRaw | null => {
 
   return null
 }
-
-/**
- * Slices a collection according to its paging
- *
- * @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
- *
- * @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
-  }
-
-  const paged = collection.slice(start, end)
-
-  return paged.length === page.limit ? paged : undefined
-}

package/src/core/query/query.ts

@@ -170,7 +170,7 @@ const isEmpty = (local: any) => {
  */
 export const runQuery = <Args extends any[], Returned extends any>(
   { func, args }: Amity.Query<Args, Returned>,
-  callback?: (args: Amity.Snapshot<Returned | undefined>) => void,
+  callback?: (args: Amity.Snapshot<Returned>) => void,
   options: Amity.QueryOptions = queryOptions('cache_then_server')
 ) => {
   let local: Returned | undefined
@@ -193,7 +193,7 @@ export const runQuery = <Args extends any[], Returned extends any>(
 
     const shouldAbort = isCachable(local) && isFresh(local, options.lifeSpan)
 
-    callback?.(createSnapshot(local , {
+    callback?.(createSnapshot<Returned>(local , {
       origin: 'local',
       loading: !(isFetcher(func) && shouldAbort)
     }))
@@ -201,7 +201,7 @@ export const runQuery = <Args extends any[], Returned extends any>(
     if (shouldAbort)
       return
   } else {
-    callback?.(createSnapshot(undefined, {
+    callback?.(createSnapshot<Returned>(undefined, {
       origin: 'local',
       loading: true
     }))
@@ -213,7 +213,7 @@ export const runQuery = <Args extends any[], Returned extends any>(
 //      isLocal(local) && syncInCache(local, fresh)
 
       callback?.(
-        createSnapshot(fresh, {
+        createSnapshot<Returned>(fresh, {
           origin: 'server',
           loading: false,
         })
@@ -221,7 +221,7 @@ export const runQuery = <Args extends any[], Returned extends any>(
     })
     .catch(error => {
       callback?.(
-        createSnapshot(undefined, {
+        createSnapshot<Returned>(undefined, {
           origin: 'server',
           loading: false,
           error,

package/src/feed/api/queryGlobalFeed.ts

@@ -2,6 +2,8 @@ import { getActiveClient } from '~/client/api/activeClient'
 
 import { toPage, toToken } from '~/core/query'
 import { ingestInCache } from '~/cache/api/ingestInCache'
+import { pullFromCache, pushToCache } from '~/cache/api'
+import { getResolver } from '~/core/model'
 
 /**
  * ```js
@@ -19,15 +21,16 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
  **/
 export const queryGlobalFeed = async (query?: {
   dataTypes?: ('video' | 'image' | 'file' | 'liveStream')[]
+  useCustomRanking?: boolean
   page?: Amity.Page
-}): Promise<Amity.Paged<Amity.Post>> => {
+}): Promise<Amity.Cached<Amity.Paged<Amity.Post>>> => {
   const client = getActiveClient()
   client.log('feed/queryGlobalFeed', query)
 
-  const { page, ...params } = query ?? {}
+  const { useCustomRanking, page, ...params } = query ?? {}
 
   const { data } = await client.http.get<Amity.PostPayload & Amity.Pagination>(
-    `/api/v4/me/global-feeds`, { params: {
+    useCustomRanking ? `/api/v5/me/global-feeds` : `/api/v4/me/global-feeds`, { params: {
       ...params,
       options: {
         token: toToken(page, 'skiplimit')
@@ -38,10 +41,60 @@ export const queryGlobalFeed = async (query?: {
   const { paging, ...payload } = data
   const { posts } = payload
 
-  if (client.cache) ingestInCache(payload as Amity.PostPayload)
+  const cachedAt = client.cache && Date.now()
+
+  if (client.cache) {
+    ingestInCache(payload as Amity.PostPayload)
+
+    const cacheKey = ['globalFeed', 'query', { ...params, useCustomRanking, options: { ...page } } as Amity.Serializable]
+    pushToCache(cacheKey, { posts: posts.map(getResolver('post')), paging })
+  }
 
   const nextPage = toPage(paging.next)
   const prevPage = toPage(paging.previous)
 
-  return { data: posts, prevPage, nextPage }
+  return { data: posts, cachedAt, prevPage, nextPage }
+}
+
+/**
+ * ```js
+ * import { queryGlobalFeed } from '@amityco/ts-sdk'
+ * const posts = await queryGlobalFeed.locally()
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.Post} objects from cache
+ *
+ * @param query The query parameters
+ * @returns A page of {@link Amity.Post} objects
+ *
+ * @category Feed API
+ * @async
+ **/
+queryGlobalFeed.locally = (
+  query: Parameters<typeof queryGlobalFeed>[0],
+): Amity.Cached<Amity.Paged<Amity.Post>> | undefined => {
+  const client = getActiveClient()
+  client.log('post/queryGlobalFeed.locally', query)
+
+  if (!client.cache) return
+
+  const { useCustomRanking, page, ...params } = query ?? {}
+
+  const queryKey = ['globalFeed', 'query', { ...params, useCustomRanking, options: { ...page }} as Amity.Serializable];
+  const { data, cachedAt } = pullFromCache<{ posts: string[] } & Amity.Pagination>(queryKey) ?? {}
+
+  if (!data?.posts.length)
+    return
+
+  const posts: Amity.Post[] = data.posts
+    .map(postId => pullFromCache<Amity.Post>(['post', 'get', postId])!)
+    .filter(Boolean)
+    .map(({ data }) => data)
+
+  const prevPage = toPage(data?.paging.previous)
+  const nextPage = toPage(data?.paging.next)
+
+  return posts.length === data?.posts?.length
+    ? { data: posts, cachedAt, prevPage, nextPage }
+    : undefined
 }