@amityco/ts-sdk 0.0.1-beta.15 → 0.0.1-beta.16

package/src/follow/observers/observeFollowers.ts

@@ -0,0 +1,78 @@
+import { getActiveClient } from '~/client/api'
+
+import {
+  onFollowerRequested,
+  onFollowRequestAccepted,
+  onFollowRequestDeclined,
+  onFollowRequestCanceled,
+  onUserFollowed,
+  onUserUnfollowed,
+  onFollowerDeleted
+} from '../events'
+
+/**
+ * ```js
+ * import { observeFollowers } from '@amityco/ts-sdk'
+ *
+ * let followers = []
+ * const unsub = observeFollowers('userId', follower => merge(followers, follower))
+ * ```
+ *
+ * Observe all mutations on a list of followers {@link Amity.FollowStatus} for a given user
+ *
+ * @param userId the ID of the {@link Amity.User}
+ * @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 messages
+ *
+ * @category Follow Observer
+ */
+export const observeFollowers = <Events extends [
+  'onRequested',
+  'onAccepted',
+  'onDeclined',
+  'onCanceled',
+  'onFollowed',
+  'onUnfollowed',
+  'onDeleted',
+]>(
+  userId: Amity.User['userId'],
+  callback: Amity.ObjectListener<Amity.FollowStatus, Events>
+): Amity.Unsubscriber => {
+  const { log } = getActiveClient()
+
+  const timestamp = Date.now()
+  log(`observeFollowers(tmpid: ${timestamp}) > listen`)
+
+  const disposers: Amity.Unsubscriber[] = []
+
+  const router = (
+    status: Amity.FollowStatus,
+    action: Events[number],
+  ) => {
+    if (status.from !== userId) {
+      return;
+    }
+
+    if (callback instanceof Function) {
+      return callback(status)
+    }
+
+    callback.onEvent?.(action, status)
+    callback[action]?.(status)
+  }
+
+  disposers.push(
+    onFollowerRequested(x => router(x, 'onRequested')),
+    onFollowRequestAccepted(x => router(x, 'onAccepted')),
+    onFollowRequestDeclined(x => router(x, 'onDeclined')),
+    onFollowRequestCanceled(x => router(x, 'onCanceled')),
+    onUserFollowed(x => router(x, 'onFollowed')),
+    onUserUnfollowed(x => router(x, 'onUnfollowed')),
+    onFollowerDeleted(x => router(x, 'onDeleted')),
+  )
+
+  return () => {
+    log(`observeFollowers(tmpid: ${timestamp}) > dispose`)
+    disposers.forEach(fn => fn())
+  }
+}

package/src/follow/observers/observeFollowings.ts

@@ -0,0 +1,78 @@
+import { getActiveClient } from '~/client/api'
+
+import {
+  onFollowerRequested,
+  onFollowRequestAccepted,
+  onFollowRequestDeclined,
+  onFollowRequestCanceled,
+  onUserFollowed,
+  onUserUnfollowed,
+  onFollowerDeleted
+} from '../events'
+
+/**
+ * ```js
+ * import { observeFollowings } from '@amityco/ts-sdk'
+ *
+ * let followings = []
+ * const unsub = observeFollowers('userId', follower => merge(followings, following))
+ * ```
+ *
+ * Observe all mutations on a list of followings {@link Amity.FollowStatus} for a given user
+ *
+ * @param userId the ID of the {@link Amity.User}
+ * @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 messages
+ *
+ * @category Follow Observer
+ */
+export const observeFollowings = <Events extends [
+  'onRequested',
+  'onAccepted',
+  'onDeclined',
+  'onCanceled',
+  'onFollowed',
+  'onUnfollowed',
+  'onDeleted',
+]>(
+  userId: Amity.User['userId'],
+  callback: Amity.ObjectListener<Amity.FollowStatus, Events>
+): Amity.Unsubscriber => {
+  const { log } = getActiveClient()
+
+  const timestamp = Date.now()
+  log(`observeFollowings(tmpid: ${timestamp}) > listen`)
+
+  const disposers: Amity.Unsubscriber[] = []
+
+  const router = (
+    status: Amity.FollowStatus,
+    action: Events[number],
+  ) => {
+    if (status.to !== userId) {
+      return;
+    }
+
+    if (callback instanceof Function) {
+      return callback(status)
+    }
+
+    callback.onEvent?.(action, status)
+    callback[action]?.(status)
+  }
+
+  disposers.push(
+    onFollowerRequested(x => router(x, 'onRequested')),
+    onFollowRequestAccepted(x => router(x, 'onAccepted')),
+    onFollowRequestDeclined(x => router(x, 'onDeclined')),
+    onFollowRequestCanceled(x => router(x, 'onCanceled')),
+    onUserFollowed(x => router(x, 'onFollowed')),
+    onUserUnfollowed(x => router(x, 'onUnfollowed')),
+    onFollowerDeleted(x => router(x, 'onDeleted')),
+  )
+
+  return () => {
+    log(`observeFollowings(tmpid: ${timestamp}) > dispose`)
+    disposers.forEach(fn => fn())
+  }
+}

package/src/index.ts

@@ -44,6 +44,10 @@ export * from './community/observers'
 
 export * from './feed/api'
 
+export * from './follow/api'
+export * from './follow/events'
+export * from './follow/observers'
+
 export * from './post/api'
 export * from './post/events'
 export * from './post/observers'

package/src/post/api/queryPosts.ts

@@ -33,7 +33,7 @@ export const queryPosts = async (
     matchingOnlyParentPost?: boolean
     page?: Amity.PageRaw
   }
-): Promise<Amity.Cached<Amity.Paged<Amity.Post>>> => {
+): Promise<Amity.Cached<Amity.Paged<Amity.Post, Amity.PageRaw>>> => {
   const client = getActiveClient()
   client.log('post/queryPosts', query)
 
@@ -87,7 +87,7 @@ export const queryPosts = async (
  */
 queryPosts.locally = (
   query: Parameters<typeof queryPosts>[0],
-): Amity.Cached<Amity.Paged<Amity.Post>> | undefined => {
+): Amity.Cached<Amity.Paged<Amity.Post, Amity.PageRaw>> | undefined => {
   const client = getActiveClient()
   client.log('post/queryPosts.locally', query)