@amityco/ts-sdk 0.0.1-bc64ebf.0 → 0.0.1-bd9dae9.0

package/dist/follow/api/queryFollowers.d.ts

@@ -13,11 +13,7 @@
  * @async
  */
 export declare const queryFollowers: {
-    (query: {
-        userId: Amity.User['userId'];
-        status?: Exclude<Amity.FollowStatusType, 'none'>;
-        page?: Amity.PageRaw;
-    }): Promise<Amity.Cached<Amity.Paged<Amity.FollowStatus, Amity.PageRaw>>>;
+    (query: Amity.QueryFollowers): Promise<Amity.Cached<Amity.Paged<Amity.FollowStatus, Amity.PageRaw>>>;
     /**
      * ```js
      * import { queryFollowers } from '@amityco/ts-sdk'

package/dist/follow/api/queryFollowers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryFollowers.d.ts","sourceRoot":"","sources":["../../../src/follow/api/queryFollowers.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,cAAc;YAAiB;QAC1C,MAAM,EAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7B,MAAM,CAAC,EAAE,QAAQ,MAAM,gBAAgB,EAAE,MAAM,CAAC,CAAC;QACjD,IAAI,CAAC,EAAE,MAAM,OAAO,CAAC;KACtB,GAAG,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,YAAY,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAGzE;;;;;;;;;;;;OAYG;mBAEM,WAAW,qBAAqB,CAAC,CAAC,CAAC,CAAC,GAC1C,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,YAAY,EAAE,MAAM,OAAO,CAAC,CAAC,GAAG,SAAS;CAjBzC,CAAC"}
+{"version":3,"file":"queryFollowers.d.ts","sourceRoot":"","sources":["../../../src/follow/api/queryFollowers.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,cAAc;YAClB,MAAM,cAAc,GAC1B,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,YAAY,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAGxE;;;;;;;;;;;;OAYG;mBAEM,WAAW,qBAAqB,CAAC,CAAC,CAAC,CAAC,GAC1C,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,YAAY,EAAE,MAAM,OAAO,CAAC,CAAC,GAAG,SAAS;CAjBzC,CAAC"}

package/dist/follow/api/queryFollowings.d.ts

@@ -13,11 +13,7 @@
  * @async
  */
 export declare const queryFollowings: {
-    (query: {
-        userId: Amity.User['userId'];
-        status?: Exclude<Amity.FollowStatusType, 'none'>;
-        page?: Amity.PageRaw;
-    }): Promise<Amity.Cached<Amity.Paged<Amity.FollowStatus, Amity.PageRaw>>>;
+    (query: Amity.QueryFollowings): Promise<Amity.Cached<Amity.Paged<Amity.FollowStatus, Amity.PageRaw>>>;
     /**
      * ```js
      * import { queryFollowings } from '@amityco/ts-sdk'

package/dist/follow/api/queryFollowings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryFollowings.d.ts","sourceRoot":"","sources":["../../../src/follow/api/queryFollowings.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,eAAe;YAAiB;QAC3C,MAAM,EAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7B,MAAM,CAAC,EAAE,QAAQ,MAAM,gBAAgB,EAAE,MAAM,CAAC,CAAC;QACjD,IAAI,CAAC,EAAE,MAAM,OAAO,CAAC;KACtB,GAAG,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,YAAY,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAGzE;;;;;;;;;;;;OAYG;mBAEM,WAAW,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAC3C,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,YAAY,EAAE,MAAM,OAAO,CAAC,CAAC,GAAG,SAAS;CAjBzC,CAAC"}
+{"version":3,"file":"queryFollowings.d.ts","sourceRoot":"","sources":["../../../src/follow/api/queryFollowings.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,eAAe;YACnB,MAAM,eAAe,GAC3B,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,YAAY,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAGxE;;;;;;;;;;;;OAYG;mBAEM,WAAW,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAC3C,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,YAAY,EAAE,MAAM,OAAO,CAAC,CAAC,GAAG,SAAS;CAjBzC,CAAC"}

package/dist/follow/observers/index.d.ts

@@ -1,4 +1,6 @@
 export * from './observeFollowInfo';
 export * from './observeFollowers';
 export * from './observeFollowings';
+export * from './liveFollowers';
+export * from './liveFollowings';
 //# sourceMappingURL=index.d.ts.map

package/dist/follow/observers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/follow/observers/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/follow/observers/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AAEpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC"}

package/dist/follow/observers/liveFollowers.d.ts

@@ -0,0 +1,20 @@
+/**
+ * ```js
+ * import { liveFollowers } from '@amityco/ts-sdk'
+ *
+ * let followers = []
+ * const unsub = liveFollowers({
+ *   userId: Amity.User['userId'];
+ * }, response => merge(followers, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.FollowStatus} followers for a given userId
+ *
+ * @param userId the 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 Followers Live Collection
+ */
+export declare const liveFollowers: (params: Amity.FollowerLiveCollection, callback: Amity.LiveCollectionCallback<Amity.FollowStatus>, config?: Amity.LiveCollectionConfig) => Amity.Unsubscriber;
+//# sourceMappingURL=liveFollowers.d.ts.map

package/dist/follow/observers/liveFollowers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"liveFollowers.d.ts","sourceRoot":"","sources":["../../../src/follow/observers/liveFollowers.ts"],"names":[],"mappings":"AAsBA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,aAAa,WAChB,MAAM,sBAAsB,YAC1B,MAAM,sBAAsB,CAAC,MAAM,YAAY,CAAC,WACjD,MAAM,oBAAoB,KAClC,MAAM,YAwGR,CAAC"}

package/dist/follow/observers/liveFollowings.d.ts

@@ -0,0 +1,20 @@
+/**
+ * ```js
+ * import { liveFollowings } from '@amityco/ts-sdk'
+ *
+ * let followings = []
+ * const unsub = liveFollowings({
+ *   userId: Amity.User['userId'];
+ * }, response => merge(followings, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.FollowStatus} followings for a given userId
+ *
+ * @param userId the 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 Followings Live Collection
+ */
+export declare const liveFollowings: (params: Amity.FollowingLiveCollection, callback: Amity.LiveCollectionCallback<Amity.FollowStatus>, config?: Amity.LiveCollectionConfig) => Amity.Unsubscriber;
+//# sourceMappingURL=liveFollowings.d.ts.map

package/dist/follow/observers/liveFollowings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"liveFollowings.d.ts","sourceRoot":"","sources":["../../../src/follow/observers/liveFollowings.ts"],"names":[],"mappings":"AAsBA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,cAAc,WACjB,MAAM,uBAAuB,YAC3B,MAAM,sBAAsB,CAAC,MAAM,YAAY,CAAC,WACjD,MAAM,oBAAoB,KAClC,MAAM,YAwGR,CAAC"}

package/dist/follow/tests/observers/liveFollowers.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=liveFollowers.test.d.ts.map

package/dist/follow/tests/observers/liveFollowers.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"liveFollowers.test.d.ts","sourceRoot":"","sources":["../../../../src/follow/tests/observers/liveFollowers.test.ts"],"names":[],"mappings":""}

package/dist/follow/tests/observers/liveFollowings.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=liveFollowings.test.d.ts.map

package/dist/follow/tests/observers/liveFollowings.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"liveFollowings.test.d.ts","sourceRoot":"","sources":["../../../../src/follow/tests/observers/liveFollowings.test.ts"],"names":[],"mappings":""}

package/dist/group/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './withUser';
+//# sourceMappingURL=index.d.ts.map

package/dist/group/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/group/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC"}

package/dist/group/utils/test/withUsers.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=withUsers.test.d.ts.map

package/dist/group/utils/test/withUsers.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withUsers.test.d.ts","sourceRoot":"","sources":["../../../../src/group/utils/test/withUsers.test.ts"],"names":[],"mappings":""}

package/dist/group/utils/withUser.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Attach user object to membership model
+ * - If cache is not enabled, set user to undefined ({..., user: undefined})
+ * - If user object is not found in cache, set user to undefined
+ * ({..., user: undefined})
+ * - If a user is found in the cache, it attaches the user from the cache
+ * ({..., user: { userId, displayName,... }})
+ *
+ * @param member The membership model object
+ * @param userIdProp The user ID prop name of membership object
+ * @param userProp The user prop name of destination object
+ * @returns The membership model object that is already mapped to user
+ * @hidden
+ */
+export declare const withUser: <M extends Record<any, any>, I extends keyof M = "userId", U extends string = "user">(member: M, userIdProp?: I, userProp?: U) => Record<U, Amity.User | undefined> & M;
+/**
+ * Mapping membership model with user object
+ *
+ * @param members The membership model objects
+ * @param userIdProp The user ID prop name of membership object
+ * @param userProp The user prop name of destination object
+ * @returns The membership model objects that is already
+ * mapped to users
+ * @hidden
+ */
+export declare const withUsers: <M extends Record<any, any>[], I extends keyof M[number] = "userId", U extends string = "user">(members: M, userIdProp?: I, userProp?: U) => (Record<U, Amity.User | undefined> & M[number])[];
+/**
+ * Transform members prop in any payload with attached users members
+ *
+ * @param payload The payload contain members prop
+ * @param memberProp A name of members prop
+ * @param userIdProp The user ID prop name of membership object
+ * @param userProp The user prop name of destination object
+ * @returns The transforming payload
+ * @hidden
+ */
+export declare const prepareMembershipPayload: <P extends Record<any, any>, M extends keyof P, I extends keyof P[M][number] = "userId", U extends string = "user">(payload: P, memberProp: M, userIdProp?: I, userProp?: U) => Omit<P, M> & Record<M, (Record<U, Amity.User | undefined> & P[M][number])[]>;
+//# sourceMappingURL=withUser.d.ts.map

package/dist/group/utils/withUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withUser.d.ts","sourceRoot":"","sources":["../../../src/group/utils/withUser.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,QAAQ,yKAuBnB,CAAC;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,SAAS,gMASyC,CAAC;AAEhE;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB,8PAkBpC,CAAC"}