@amityco/ts-sdk 0.0.1 → 6.0.0

package/dist/subChannel/utils/markReadEngine.d.ts

@@ -0,0 +1,33 @@
+/**
+ * ```js
+ * import { startReading } from '@amityco/ts-sdk'
+ * const success = await startReading('foo')
+ * ```
+ *
+ * Set local reading state of channel to `true` and then call mark all
+ * messages as read API.
+ *
+ * @param subChannelId - The sub channel ID to start reading.
+ * @return A success boolean if reading of the sub channel had begun.
+ *
+ * @category Channel API
+ * @async
+ */
+export declare const startReading: (subChannelId: Amity.SubChannel['subChannelId']) => Promise<boolean>;
+/**
+ * ```js
+ * import { stopReading } from '@amityco/ts-sdk'
+ * const success = await stopReading('foo')
+ * ```
+ *
+ * Set local reading state of channel to `false` and then call mark all
+ * messages as unread API.
+ *
+ * @param subChannelId - The sub channel ID to stop reading.
+ * @return A success boolean if reading of the sub channel had begun.
+ *
+ * @category Channel API
+ * @async
+ */
+export declare const stopReading: (subChannelId: Amity.SubChannel['subChannelId']) => Promise<boolean>;
+//# sourceMappingURL=markReadEngine.d.ts.map

package/dist/subChannel/utils/markReadEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markReadEngine.d.ts","sourceRoot":"","sources":["../../../src/subChannel/utils/markReadEngine.ts"],"names":[],"mappings":"AAkEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,YAAY,iBAAkB,MAAM,UAAU,CAAC,cAAc,CAAC,qBAQ1E,CAAC;AAOF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,WAAW,iBAAkB,MAAM,UAAU,CAAC,cAAc,CAAC,qBAIzE,CAAC"}

package/dist/subChannel/utils/prepareSubChannelPayload.d.ts

@@ -0,0 +1,15 @@
+export declare const MARKER_INCLUDED_SUB_CHANNEL_TYPE: string[];
+/**
+ * Filter sub channel by type. Only conversation, community and broadcast type are included.
+ */
+export declare const isUnreadCountSupport: ({ channelType }: Pick<Amity.RawSubChannel, 'channelType'>) => boolean;
+export declare function getUnreadCount(channelId: string, subChannelId: string, marker?: Amity.SubChannelMarker): number;
+export declare function convertFromRaw({ channelId, channelPublicId, channelType, childCount, creatorId, creatorPublicId, lastMessageId, lastMessageTimestamp, messageFeedId, name, ...rest }: Amity.RawSubChannel, marker?: Amity.SubChannelMarker): Amity.SubChannel;
+export declare function updateSubChannelMarker(subChannel: Amity.SubChannel, marker?: Amity.SubChannelMarker): Amity.SubChannel;
+export declare const prepareSubChannelPayload: (rawPayload: Amity.SubChannelPayload) => Promise<Amity.ProcessedSubChannelPayload>;
+declare type RawQuerySubChannels = Omit<Amity.QuerySubChannels, 'excludeDefaultSubChannel'> & {
+    excludeDefaultMessageFeed?: Amity.QuerySubChannels['excludeDefaultSubChannel'];
+};
+export declare function convertQueryParams({ excludeDefaultSubChannel, ...rest }: Amity.QuerySubChannels): RawQuerySubChannels;
+export {};
+//# sourceMappingURL=prepareSubChannelPayload.d.ts.map

package/dist/subChannel/utils/prepareSubChannelPayload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prepareSubChannelPayload.d.ts","sourceRoot":"","sources":["../../../src/subChannel/utils/prepareSubChannelPayload.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,gCAAgC,UAA6C,CAAC;AAE3F;;GAEG;AACH,eAAO,MAAM,oBAAoB,oBAAqB,KAAK,MAAM,aAAa,EAAE,aAAa,CAAC,YACtC,CAAC;AAEzD,wBAAgB,cAAc,CAC5B,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,MAAM,CAAC,EAAE,KAAK,CAAC,gBAAgB,UA0BhC;AAED,wBAAgB,cAAc,CAC5B,EACE,SAAS,EACT,eAAe,EACf,WAAW,EACX,UAAU,EACV,SAAS,EACT,eAAe,EACf,aAAa,EACb,oBAAoB,EACpB,aAAa,EACb,IAAI,EACJ,GAAG,IAAI,EACR,EAAE,KAAK,CAAC,aAAa,EACtB,MAAM,CAAC,EAAE,KAAK,CAAC,gBAAgB,GAC9B,KAAK,CAAC,UAAU,CAalB;AAED,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,KAAK,CAAC,UAAU,EAC5B,MAAM,CAAC,EAAE,KAAK,CAAC,gBAAgB,GAC9B,KAAK,CAAC,UAAU,CAMlB;AAED,eAAO,MAAM,wBAAwB,eACvB,MAAM,iBAAiB,KAClC,QAAQ,MAAM,0BAA0B,CA2B1C,CAAC;AAEF,aAAK,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,0BAA0B,CAAC,GAAG;IACpF,yBAAyB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,0BAA0B,CAAC,CAAC;CAChF,CAAC;AAEF,wBAAgB,kBAAkB,CAAC,EACjC,wBAAwB,EACxB,GAAG,IAAI,EACR,EAAE,KAAK,CAAC,gBAAgB,GAAG,mBAAmB,CAQ9C"}

package/dist/user/api/getUser.d.ts

@@ -1,7 +1,7 @@
 /**
  * ```js
- * import { getUser } from '@amityco/ts-sdk'
- * const user = await getUser('foobar')
+ * import { getUser } from '~/user/api'
+ * const { data: user } = await getUser('foobar')
  * ```
  *
  * Fetches a {@link Amity.User} object
@@ -9,15 +9,15 @@
  * @param userId the ID of the {@link Amity.User} to fetch
  * @returns the associated {@link Amity.User} object
  *
- * @category User API
+ * @category Private
  * @async
  */
 export declare const getUser: {
-    (userId: Amity.User['userId']): Promise<Amity.User>;
+    (userId: Amity.User['userId']): Promise<Amity.Cached<Amity.User>>;
     /**
      * ```js
      * import { getUser } from '@amityco/ts-sdk'
-     * const user = getUser.locally('foobar')
+     * const { data: user } = getUser.locally('foobar')
      * ```
      *
      * Fetches a {@link Amity.User} object from cache
@@ -27,6 +27,6 @@ export declare const getUser: {
      *
      * @category User API
      */
-    locally(userId: Amity.User['userId']): Amity.User;
+    locally(userId: Amity.User['userId']): Amity.Cached<Amity.User> | undefined;
 };
 //# sourceMappingURL=getUser.d.ts.map

package/dist/user/api/getUser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getUser.d.ts","sourceRoot":"","sources":["../../../src/user/api/getUser.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,OAAO;aACV,MAAM,IAAI,CAAC,QAAQ,CAAC;IAiB9B;;;;;;;;;;;;OAYG;oBAEO,MAAM,IAAI,CAAC,QAAQ,CAAC;CAhB7B,CAAA"}
+{"version":3,"file":"getUser.d.ts","sourceRoot":"","sources":["../../../src/user/api/getUser.ts"],"names":[],"mappings":"AAaA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,OAAO;aAAkB,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC;IAoC9F;;;;;;;;;;;;OAYG;oBACwB,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS;CAhBrF,CAAC"}

package/dist/user/api/{getUsers.d.ts → getUserByIds.d.ts}

@@ -1,7 +1,7 @@
 /**
  * ```js
  * import { getUsers } from '@amityco/ts-sdk'
- * const users = await getUsers(['foo', 'bar'])
+ * const { data: users } = await getUsers(['foo', 'bar'])
  * ```
  *
  * Fetches a collection of {@link Amity.User} objects
@@ -12,12 +12,12 @@
  * @category User API
  * @async
  */
-export declare const getUsers: {
-    (userIds: Amity.User['userId'][]): Promise<Record<string, Amity.User>>;
+export declare const getUserByIds: {
+    (userIds: Amity.User['userId'][]): Promise<Amity.Cached<Amity.User[]>>;
     /**
      * ```js
      * import { getUsers } from '@amityco/ts-sdk'
-     * const users = getUsers.locally!(['foo', 'bar'])
+     * const { data: users } = getUsers.locally!(['foo', 'bar'])
      * ```
      *
      * Fetches a collection of {@link Amity.User} objects from cache
@@ -27,6 +27,6 @@ export declare const getUsers: {
      *
      * @category User API
      */
-    locally(userIds: Amity.User['userId'][]): Record<string, Amity.User> | undefined;
+    locally(userIds: Amity.User['userId'][]): Amity.Cached<Amity.User[]> | undefined;
 };
-//# sourceMappingURL=getUsers.d.ts.map
+//# sourceMappingURL=getUserByIds.d.ts.map

package/dist/user/api/getUserByIds.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getUserByIds.d.ts","sourceRoot":"","sources":["../../../src/user/api/getUserByIds.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY;cACd,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,GAC9B,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;IAsBtC;;;;;;;;;;;;OAYG;qBAEQ,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,GAC9B,MAAM,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,SAAS;CAjBxC,CAAC"}

package/dist/user/api/index.d.ts

@@ -1,5 +1,3 @@
-export { getUser } from './getUser';
-export { getUsers } from './getUsers';
-export { queryUsers } from './queryUsers';
+export { getUserByIds } from './getUserByIds';
 export { updateUser } from './updateUser';
 //# sourceMappingURL=index.d.ts.map

package/dist/user/api/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/user/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/user/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC"}

package/dist/user/api/queryUsers.d.ts

@@ -1,7 +1,7 @@
 /**
  * ```js
  * import { queryUsers } from '@amityco/ts-sdk'
- * const { users, previous, next } = await queryUsers({ keyword: 'foo' })
+ * const { data: users, prevPage, nextPage } = await queryUsers({ displayName: 'foo' })
  * ```
  *
  * Queries a paginable list of {@link Amity.User} objects
@@ -14,20 +14,11 @@
  * @async
  */
 export declare const queryUsers: {
-    (query?: {
-        displayName?: Amity.User['displayName'];
-        filter?: "all" | "flagged" | undefined;
-        sortBy?: "displayName" | "firstCreated" | "lastCreated" | undefined;
-        page?: Amity.Page | undefined;
-    } | undefined): Promise<{
-        data: Record<string, Amity.User>;
-        prevPage: Amity.Page | null;
-        nextPage: Amity.Page | null;
-    }>;
+    (query?: Amity.QueryUsers): Promise<Amity.Cached<Amity.Paged<Amity.User>>>;
     /**
      * ```js
      * import { queryUsers } from '@amityco/ts-sdk'
-     * const users = queryUsers.locally({ keyword: 'foo' })
+     * const { data: users } = queryUsers.locally({ keyword: 'foo' })
      * ```
      *
      * Queries a paginable list of {@link Amity.User} objects from cache
@@ -38,6 +29,6 @@ export declare const queryUsers: {
      *
      * @category User API
      */
-    locally(query: Parameters<typeof queryUsers>[0]): void;
+    locally(query?: Parameters<typeof queryUsers>[0]): Amity.Cached<Amity.Paged<Amity.User>> | undefined;
 };
 //# sourceMappingURL=queryUsers.d.ts.map

package/dist/user/api/queryUsers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryUsers.d.ts","sourceRoot":"","sources":["../../../src/user/api/queryUsers.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU;;sBAEL,MAAM,IAAI,CAAC,aAAa,CAAC;;;;;;;;;IA2C3C;;;;;;;;;;;;;OAaG;mBAEM,WAAW,iBAAiB,CAAC,CAAC,CAAC,CAAC;CAjBxC,CAAA"}
+{"version":3,"file":"queryUsers.d.ts","sourceRoot":"","sources":["../../../src/user/api/queryUsers.ts"],"names":[],"mappings":"AAYA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU;aACd,MAAM,UAAU,GACtB,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;IAkDjD;;;;;;;;;;;;;OAaG;oBAEM,WAAW,iBAAiB,CAAC,CAAC,CAAC,CAAC,GACtC,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,SAAS;CAnBnD,CAAC"}

package/dist/user/api/tests/getUser.test.d.ts

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

package/dist/user/api/tests/getUser.test.d.ts.map

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

package/dist/user/api/tests/queryUsers.test.d.ts

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

package/dist/user/api/tests/queryUsers.test.d.ts.map

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

package/dist/user/api/tests/updateUser.test.d.ts

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

package/dist/user/api/tests/updateUser.test.d.ts.map

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

package/dist/user/api/updateUser.d.ts

@@ -13,5 +13,5 @@
  * @category User API
  * @async
  */
-export declare const updateUser: (userId: Amity.User['userId'], patch: Patch<Amity.User, 'displayName' | 'description' | 'avatarFileId' | 'metadata'>) => Promise<Amity.User>;
+export declare const updateUser: (userId: Amity.User['userId'], patch: Patch<Amity.User, 'displayName' | 'description' | 'avatarFileId' | 'avatarCustomUrl' | 'metadata'>) => Promise<Amity.Cached<Amity.User>>;
 //# sourceMappingURL=updateUser.d.ts.map

package/dist/user/api/updateUser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"updateUser.d.ts","sourceRoot":"","sources":["../../../src/user/api/updateUser.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU,WACb,MAAM,IAAI,CAAC,QAAQ,CAAC,SACrB,MAAM,MAAM,IAAI,EAAE,aAAa,GAAG,aAAa,GAAG,cAAc,GAAG,UAAU,CAAC,wBAqBtF,CAAA"}
+{"version":3,"file":"updateUser.d.ts","sourceRoot":"","sources":["../../../src/user/api/updateUser.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU,WACb,MAAM,IAAI,CAAC,QAAQ,CAAC,SACrB,MACL,MAAM,IAAI,EACV,aAAa,GAAG,aAAa,GAAG,cAAc,GAAG,iBAAiB,GAAG,UAAU,CAChF,KACA,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,CA4BlC,CAAC"}

package/dist/user/events/index.d.ts

@@ -1,2 +1,6 @@
 export * from './onUserUpdated';
+export * from './onUserDeleted';
+export * from './onUserFlagged';
+export * from './onUserUnflagged';
+export * from './onUserFlagCleared';
 //# sourceMappingURL=index.d.ts.map

package/dist/user/events/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/user/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/user/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAEhC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC"}

package/dist/user/events/onUserDeleted.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onUserDeleted } from '@amityco/ts-sdk'
+ * const dispose = onUserDeleted(user => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.User} has been deleted
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category User Events
+ */
+export declare const onUserDeleted: (callback: Amity.Listener<Amity.User>) => Amity.Unsubscriber;
+//# sourceMappingURL=onUserDeleted.d.ts.map

package/dist/user/events/onUserDeleted.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onUserDeleted.d.ts","sourceRoot":"","sources":["../../../src/user/events/onUserDeleted.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,aAAc,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,uBACb,CAAC"}

package/dist/user/events/onUserFetched.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onUserFetched } from '@amityco/ts-sdk'
+ * const dispose = onUserFetched(user => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.User} has been fetched
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category User Events
+ */
+export declare const onUserFetched: (callback: Amity.Listener<Amity.User>) => Amity.Unsubscriber;
+//# sourceMappingURL=onUserFetched.d.ts.map

package/dist/user/events/onUserFetched.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onUserFetched.d.ts","sourceRoot":"","sources":["../../../src/user/events/onUserFetched.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,aAAc,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,uBACb,CAAC"}

package/dist/user/events/onUserFlagCleared.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onUserFlagCleared } from '@amityco/ts-sdk'
+ * const dispose = onUserFlagCleared(user => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when flags have been cleared for a {@link Amity.User}
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category User Events
+ */
+export declare const onUserFlagCleared: (callback: Amity.Listener<Amity.User>) => Amity.Unsubscriber;
+//# sourceMappingURL=onUserFlagCleared.d.ts.map

package/dist/user/events/onUserFlagCleared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onUserFlagCleared.d.ts","sourceRoot":"","sources":["../../../src/user/events/onUserFlagCleared.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iBAAiB,aAAc,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,uBACb,CAAC"}

package/dist/user/events/onUserFlagged.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onUserFlagged } from '@amityco/ts-sdk'
+ * const dispose = onUserFlagged(user => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.User} has been flagged
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category User Events
+ */
+export declare const onUserFlagged: (callback: Amity.Listener<Amity.User>) => Amity.Unsubscriber;
+//# sourceMappingURL=onUserFlagged.d.ts.map

package/dist/user/events/onUserFlagged.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onUserFlagged.d.ts","sourceRoot":"","sources":["../../../src/user/events/onUserFlagged.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,aAAc,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,uBACb,CAAC"}

package/dist/user/events/onUserUnflagged.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onUserUnflagged } from '@amityco/ts-sdk'
+ * const dispose = onUserUnflagged(user => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a flag has been removed from a {@link Amity.User}
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category User Events
+ */
+export declare const onUserUnflagged: (callback: Amity.Listener<Amity.User>) => Amity.Unsubscriber;
+//# sourceMappingURL=onUserUnflagged.d.ts.map

package/dist/user/events/onUserUnflagged.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onUserUnflagged.d.ts","sourceRoot":"","sources":["../../../src/user/events/onUserUnflagged.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,eAAe,aAAc,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,uBACb,CAAC"}

package/dist/user/events/onUserUpdated.d.ts

@@ -6,7 +6,7 @@
  * })
  * ```
  *
- * Fired when any {@link Amity.User} have been updated
+ * Fired when a {@link Amity.User} has been updated
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening

package/dist/user/events/onUserUpdated.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"onUserUpdated.d.ts","sourceRoot":"","sources":["../../../src/user/events/onUserUpdated.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,aACd,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,uBAgBrC,CAAA"}
+{"version":3,"file":"onUserUpdated.d.ts","sourceRoot":"","sources":["../../../src/user/events/onUserUpdated.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,aAAc,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,uBACb,CAAC"}

package/dist/user/events/utils.d.ts

@@ -0,0 +1,2 @@
+export declare const createUserEventSubscriber: (event: keyof Amity.MqttUserEvents, callback: Amity.Listener<Amity.User>) => Amity.Unsubscriber;
+//# sourceMappingURL=utils.d.ts.map

package/dist/user/events/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/user/events/utils.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,yBAAyB,UAC7B,MAAM,MAAM,cAAc,YACvB,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,uBAarC,CAAC"}

package/dist/user/index.d.ts

@@ -0,0 +1,5 @@
+export * as Relationship from './relationship';
+export * from './api';
+export * from './events';
+export * from './observers';
+//# sourceMappingURL=index.d.ts.map

package/dist/user/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/user/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,gBAAgB,CAAC;AAE/C,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC"}

package/dist/user/observers/getUser.d.ts

@@ -0,0 +1,21 @@
+/**
+ * ```js
+ * import { liveUser } from '@amityco/ts-sdk';
+ *
+ * let user;
+ *
+ * const unsubscribe = liveUser(userId, response => {
+ *   user = response.data;
+ * });
+ * ```
+ *
+ * Observe all mutation on a given {@link Amity.User}
+ *
+ * @param userId the ID of the user to observe
+ * @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 user
+ *
+ * @category Message Live Object
+ */
+export declare const getUser: (userId: Amity.User['userId'], callback: Amity.LiveObjectCallback<Amity.User>) => Amity.Unsubscriber;
+//# sourceMappingURL=getUser.d.ts.map

package/dist/user/observers/getUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getUser.d.ts","sourceRoot":"","sources":["../../../src/user/observers/getUser.ts"],"names":[],"mappings":"AAWA;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,OAAO,WACV,MAAM,IAAI,CAAC,QAAQ,CAAC,YAClB,MAAM,kBAAkB,CAAC,MAAM,IAAI,CAAC,KAC7C,MAAM,YASR,CAAC"}

package/dist/user/observers/getUsers.d.ts

@@ -0,0 +1,18 @@
+/**
+ * ```js
+ * import { liveUsers } from '@amityco/ts-sdk'
+ *
+ * let users = []
+ * const unsub = liveUsers({}, response => merge(users, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.User}s
+ *
+ * @param params for querying users
+ * @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 users
+ *
+ * @category Category Live Collection
+ */
+export declare const getUsers: (params: Amity.UserLiveCollection, callback: Amity.LiveCollectionCallback<Amity.User>, config?: Amity.LiveCollectionConfig) => () => void;
+//# sourceMappingURL=getUsers.d.ts.map

package/dist/user/observers/getUsers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getUsers.d.ts","sourceRoot":"","sources":["../../../src/user/observers/getUsers.ts"],"names":[],"mappings":"AA8BA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,QAAQ,WACX,MAAM,kBAAkB,YACtB,MAAM,sBAAsB,CAAC,MAAM,IAAI,CAAC,WACzC,MAAM,oBAAoB,eAgHpC,CAAC"}

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

@@ -1,2 +1,4 @@
+export { getUser } from './getUser';
+export { getUsers } from './getUsers';
 export { observeUser } from './observeUser';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/user/observers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/user/observers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC"}

package/dist/user/observers/observeUser.d.ts

@@ -13,7 +13,5 @@
  * Observe all mutation on a given {@link Amity.User}
  * @category User Observer
  */
-export declare const observeUser: <Events extends ["onFetch", "onUpdate"]>(userId: string, callback: Amity.ObjectListener<{
-    data?: Amity.User | undefined;
-} & Amity.QueryMetadata, Events>) => Amity.Unsubscriber;
+export declare const observeUser: <Events extends ["onFetch", "onUpdate", "onDelete", "onFlagged", "onUnflagged", "onFlagCleared"]>(userId: string, callback: Amity.ObjectListener<Amity.Snapshot<Amity.User>, Events>) => Amity.Unsubscriber;
 //# sourceMappingURL=observeUser.d.ts.map

package/dist/user/observers/observeUser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"observeUser.d.ts","sourceRoot":"","sources":["../../../src/user/observers/observeUser.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,WAAW,mDACd,MAAM;;qCAEb,MAAM,YAsCR,CAAA"}
+{"version":3,"file":"observeUser.d.ts","sourceRoot":"","sources":["../../../src/user/observers/observeUser.ts"],"names":[],"mappings":"AAaA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,WAAW,4GAGd,MAAM,yEAEb,MAAM,YAkCR,CAAC"}

package/dist/user/observers/tests/getUser.test.d.ts

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

package/dist/user/observers/tests/getUser.test.d.ts.map

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

package/dist/user/observers/tests/getUsers.test.d.ts

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

package/dist/user/observers/tests/getUsers.test.d.ts.map

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

package/dist/user/relationship/block/api/blockUser.d.ts

@@ -0,0 +1,2 @@
+export declare const blockUser: (userId: Amity.User['userId']) => Promise<Amity.BlockedPayload>;
+//# sourceMappingURL=blockUser.d.ts.map

package/dist/user/relationship/block/api/blockUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blockUser.d.ts","sourceRoot":"","sources":["../../../../../src/user/relationship/block/api/blockUser.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,SAAS,WAAkB,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAG,QAAQ,MAAM,cAAc,CAoB1F,CAAC"}

package/dist/user/relationship/block/api/index.d.ts

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

package/dist/user/relationship/block/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/user/relationship/block/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC"}

package/dist/user/relationship/block/api/queryBlockedUsers.d.ts

@@ -0,0 +1,39 @@
+/**
+ * ```js
+ * import { queryBlockedUsers } from '@amityco/ts-sdk'
+ * const { data: users, prevPage, nextPage, total } = await queryBlockedUsers({ page: Amity.PageRaw, limit: number })
+ * ```
+ *
+ * @param query The query parameters
+ * @returns A page of {@link Amity.User} objects
+ *
+ * @category Block API
+ * @async
+ */
+export declare const queryBlockedUsers: {
+    (query?: Amity.QueryBlockedUser): Promise<{
+        data: Amity.User[];
+    } & Amity.Pages<Amity.PageRaw> & {
+        cachedAt: number | undefined;
+    } & {
+        total: number;
+    }>;
+    /**
+     * ```js
+     * import { queryBlockedUsers } from '@amityco/ts-sdk'
+     * const { data: users } = queryBlockedUsers.locally({ page: 'page_token' })
+     * ```
+     *
+     * Queries a paginable list of {@link Amity.User} objects from cache
+     * Search is performed by displayName such as `.startsWith(search)`
+     *
+     * @param query The query parameters
+     * @returns A page of {@link Amity.User} objects
+     *
+     * @category Block API
+     */
+    locally(query?: Parameters<typeof queryBlockedUsers>[0]): (Amity.Cached<Amity.Paged<Amity.User, Amity.PageRaw>> & {
+        total: number;
+    }) | undefined;
+};
+//# sourceMappingURL=queryBlockedUsers.d.ts.map

package/dist/user/relationship/block/api/queryBlockedUsers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryBlockedUsers.d.ts","sourceRoot":"","sources":["../../../../../src/user/relationship/block/api/queryBlockedUsers.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,iBAAiB;aACpB,MAAM,gBAAgB;;;;;eAGrB,MAAM;;IAuCjB;;;;;;;;;;;;;OAaG;oBAEM,WAAW,wBAAwB,CAAC,CAAC,CAAC,CAAC,GAE5C,CAAC,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,GAAG;QACtD,KAAK,EAAE,MAAM,CAAC;KACf,CAAC,GACF,SAAS;CAtBZ,CAAC"}

package/dist/user/relationship/block/api/unBlockUser.d.ts

@@ -0,0 +1,2 @@
+export declare const unBlockUser: (userId: Amity.User['userId']) => Promise<Amity.BlockedPayload>;
+//# sourceMappingURL=unBlockUser.d.ts.map

package/dist/user/relationship/block/api/unBlockUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unBlockUser.d.ts","sourceRoot":"","sources":["../../../../../src/user/relationship/block/api/unBlockUser.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,WAAW,WAAkB,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAG,QAAQ,MAAM,cAAc,CAsB5F,CAAC"}

package/dist/user/relationship/block/index.d.ts

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

package/dist/user/relationship/block/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/user/relationship/block/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC"}

package/dist/user/relationship/block/observers/getBlockedUsers.d.ts

@@ -0,0 +1,2 @@
+export declare const getBlockedUsers: (params: Amity.BlockedUsersLiveCollection, callback: Amity.LiveCollectionCallback<Amity.User>, config?: Amity.LiveCollectionConfig) => () => void;
+//# sourceMappingURL=getBlockedUsers.d.ts.map

package/dist/user/relationship/block/observers/getBlockedUsers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBlockedUsers.d.ts","sourceRoot":"","sources":["../../../../../src/user/relationship/block/observers/getBlockedUsers.ts"],"names":[],"mappings":"AAaA,eAAO,MAAM,eAAe,WAClB,MAAM,0BAA0B,YAC9B,MAAM,sBAAsB,CAAC,MAAM,IAAI,CAAC,WACzC,MAAM,oBAAoB,eAuFpC,CAAC"}

package/dist/user/relationship/block/observers/index.d.ts

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

package/dist/user/relationship/block/observers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/user/relationship/block/observers/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}

package/dist/user/relationship/follow/api/acceptFollower.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ```js
+ * import { acceptFollower } from '@amityco/ts-sdk'
+ * await acceptFollower('foobar')
+ * ```
+ *
+ * Accept the follow request
+ *
+ * @param userId the ID of the {@link Amity.User} follower
+ * @returns A success boolean if the follow request was accepted
+ *
+ * @category Follow API
+ * @async
+ */
+export declare const acceptFollower: (userId: Amity.User['userId']) => Promise<boolean>;
+//# sourceMappingURL=acceptFollower.d.ts.map

package/dist/user/relationship/follow/api/acceptFollower.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"acceptFollower.d.ts","sourceRoot":"","sources":["../../../../../src/user/relationship/follow/api/acceptFollower.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,cAAc,WAAkB,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAG,QAAQ,OAAO,CAelF,CAAC"}