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

package/dist/channel/observers/liveChannelMembers.d.ts

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

package/dist/channel/observers/liveChannelMembers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"liveChannelMembers.d.ts","sourceRoot":"","sources":["../../../src/channel/observers/liveChannelMembers.ts"],"names":[],"mappings":"AAqBA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,kBAAkB,WACrB,MAAM,4BAA4B,YAChC,MAAM,sBAAsB,CAAC,MAAM,UAAU,CAAC,SAAS,CAAC,CAAC,WAC1D,MAAM,oBAAoB,eAoHpC,CAAC"}

package/dist/channel/observers/liveChannels.d.ts

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

package/dist/channel/observers/liveChannels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"liveChannels.d.ts","sourceRoot":"","sources":["../../../src/channel/observers/liveChannels.ts"],"names":[],"mappings":"AAsBA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,YAAY,WACf,MAAM,qBAAqB,YACzB,MAAM,sBAAsB,CAAC,MAAM,OAAO,CAAC,WAC5C,MAAM,oBAAoB,eAsIpC,CAAC"}

package/dist/channel/observers/observeChannel.d.ts

@@ -14,7 +14,5 @@
  *
  * @category Channel Observer
  */
-export declare const observeChannel: <Events extends ["onFetch", "onUpdate", "onDelete", "onJoin", "onLeft", "onMemberAdded", "onMemberRemoved"]>(channelId: string, callback: Amity.ObjectListener<{
-    data?: Amity.Channel<any> | undefined;
-} & Amity.QueryMetadata, Events>) => Amity.Unsubscriber;
+export declare const observeChannel: <Events extends ["onFetch" | "onUpdate" | "onDelete" | "onJoin" | "onLeft" | "onMemberAdded" | "onMemberRemoved"]>(channelId: string, callback: Amity.ObjectListener<Amity.Snapshot<Amity.Channel<any>>, Events>) => Amity.Unsubscriber;
 //# sourceMappingURL=observeChannel.d.ts.map

package/dist/channel/observers/observeChannel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"observeChannel.d.ts","sourceRoot":"","sources":["../../../src/channel/observers/observeChannel.ts"],"names":[],"mappings":"AAeA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,cAAc,0HAGd,MAAM;;qCAEhB,MAAM,YA2CR,CAAA"}
+{"version":3,"file":"observeChannel.d.ts","sourceRoot":"","sources":["../../../src/channel/observers/observeChannel.ts"],"names":[],"mappings":"AAeA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,cAAc,gIACd,MAAM,iFAEhB,MAAM,YAuCR,CAAC"}

package/dist/channel/observers/observeChannels.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { observeChannels } from '@amityco/ts-sdk'
+ *
+ * let channels = []
+ * const unsub = observeChannels(channel => merge(channels, channel))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.Channel} for a current 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 channels
+ *
+ * @category Channel Observer
+ */
+export declare const observeChannels: (callback: Amity.ObjectListener<Amity.Channel, [Exclude<Amity.ChannelActionType, 'onFetch'>]>) => Amity.Unsubscriber;
+//# sourceMappingURL=observeChannels.d.ts.map

package/dist/channel/observers/observeChannels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"observeChannels.d.ts","sourceRoot":"","sources":["../../../src/channel/observers/observeChannels.ts"],"names":[],"mappings":"AAYA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,eAAe,aAChB,MAAM,cAAc,CAAC,MAAM,OAAO,EAAE,CAAC,QAAQ,MAAM,iBAAiB,EAAE,SAAS,CAAC,CAAC,CAAC,KAC3F,MAAM,YA6BR,CAAC"}

package/dist/channel/observers/tests/liveChannelMembers.test.d.ts

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

package/dist/channel/observers/tests/liveChannelMembers.test.d.ts.map

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

package/dist/channel/observers/tests/liveChannels.test.d.ts

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

package/dist/channel/observers/tests/liveChannels.test.d.ts.map

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

package/dist/channel/tests/utils/prepareChannelPayload.test.d.ts

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

package/dist/channel/tests/utils/prepareChannelPayload.test.d.ts.map

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

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

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

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

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

package/dist/channel/utils/prepareChannelPayload.d.ts

@@ -0,0 +1,3 @@
+/** @hidden */
+export declare const prepareChannelPayload: (payload: Amity.ChannelPayload) => Amity.ChannelPayload<any, Amity.Channel>;
+//# sourceMappingURL=prepareChannelPayload.d.ts.map

package/dist/channel/utils/prepareChannelPayload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prepareChannelPayload.d.ts","sourceRoot":"","sources":["../../../src/channel/utils/prepareChannelPayload.ts"],"names":[],"mappings":"AAEA,cAAc;AACd,eAAO,MAAM,qBAAqB,YACvB,MAAM,cAAc,KAC5B,MAAM,cAAc,CAAC,GAAG,EAAE,MAAM,OAAO,CAyBzC,CAAC"}

package/dist/client/api/activeClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"activeClient.d.ts","sourceRoot":"","sources":["../../../src/client/api/activeClient.ts"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,oBAU3B,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,WAAY,MAAM,MAAM,SAEnD,CAAA"}
+{"version":3,"file":"activeClient.d.ts","sourceRoot":"","sources":["../../../src/client/api/activeClient.ts"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,oBAU3B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,WAAY,MAAM,MAAM,SAEnD,CAAC"}

package/dist/client/api/activeUser.d.ts

@@ -0,0 +1,6 @@
+/**
+ * for internal use
+ */
+export declare const getActiveUser: () => Pick<Amity.User, "_id" | "userId" | "path">;
+export declare const setActiveUser: (user: Amity.User) => void;
+//# sourceMappingURL=activeUser.d.ts.map

package/dist/client/api/activeUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"activeUser.d.ts","sourceRoot":"","sources":["../../../src/client/api/activeUser.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,eAAO,MAAM,aAAa,mDAUzB,CAAC;AAEF,eAAO,MAAM,aAAa,SAAU,MAAM,IAAI,SAM7C,CAAC"}

package/dist/client/api/connectClient.d.ts

@@ -8,19 +8,15 @@
  *
  * Connects an {@link Amity.Client} instance to ASC servers
  *
- * @param userId the user ID for the current session
- * @param displayName the user's displayName for the current session
- * @param deviceId Manual override of the user's device id (for device management)
- * @param authToken The authentication token - necessary when network option is set to secure
+ * @param params the connect parameters
+ * @param params.userId the user ID for the current session
+ * @param params.displayName the user's displayName for the current session
+ * @param params.deviceId Manual override of the user's device id (for device management)
+ * @param params.authToken The authentication token - necessary when network option is set to secure
  * @returns a success boolean if connected
  *
  * @category Client API
  * @async
  */
-export declare const connectClient: (params: {
-    userId: Amity.User['userId'];
-    displayName?: Amity.User['displayName'];
-    authToken?: string;
-    deviceId?: Amity.Device['deviceId'];
-}) => Promise<boolean>;
+export declare const connectClient: (params: Amity.ConnectClientParams, config?: Amity.ConnectClientConfig) => Promise<boolean>;
 //# sourceMappingURL=connectClient.d.ts.map

package/dist/client/api/connectClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"connectClient.d.ts","sourceRoot":"","sources":["../../../src/client/api/connectClient.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,aAAa,WAAkB;IAC1C,MAAM,EAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC;IACxC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;CACrC,KAAG,QAAQ,OAAO,CA+BlB,CAAA"}
+{"version":3,"file":"connectClient.d.ts","sourceRoot":"","sources":["../../../src/client/api/connectClient.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,aAAa,WAChB,MAAM,mBAAmB,WACxB,MAAM,mBAAmB,KACjC,QAAQ,OAAO,CA8CjB,CAAC"}

package/dist/client/api/createClient.d.ts

@@ -1,3 +1,4 @@
+import { API_REGIONS } from '~/client/utils/endpoints';
 /**
  * ```js
  * import { createClient } from '@amityco/ts-sdk'
@@ -7,11 +8,18 @@
  * Creates a new {@link Amity.Client} instance
  *
  * @param apiKey for the {@link Amity.Client} instance
- * @param apiEndpoint endpoint to connect to
+ * @param apiRegion endpoint to connect to
+ * @param apiEndpoint custom endpoint in case you don't want to use a preset endpoint
  * @param debugSession session's identifier for the client's logger instance
  * @returns A {@link Amity.Client} instance
  *
  * @category Client API
- **/
-export declare const createClient: (apiKey: string, apiEndpoint?: string, debugSession?: string) => Amity.Client;
+ * */
+export declare const createClient: (apiKey: string, apiRegion?: (typeof API_REGIONS)[keyof typeof API_REGIONS], { debugSession, apiEndpoint, }?: {
+    debugSession?: string | undefined;
+    apiEndpoint?: {
+        http?: string | undefined;
+        mqtt?: string | undefined;
+    } | undefined;
+}) => Amity.Client;
 //# sourceMappingURL=createClient.d.ts.map

package/dist/client/api/createClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createClient.d.ts","sourceRoot":"","sources":["../../../src/client/api/createClient.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;;IAcI;AACJ,eAAO,MAAM,YAAY,WACf,MAAM,gBACD,MAAM,iBACL,MAAM,KACnB,MAAM,MAsBR,CAAA"}
+{"version":3,"file":"createClient.d.ts","sourceRoot":"","sources":["../../../src/client/api/createClient.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAc,MAAM,0BAA0B,CAAC;AAcnE;;;;;;;;;;;;;;;KAeK;AACL,eAAO,MAAM,YAAY,WACf,MAAM,cACH,CAAA,kBAAkB,EAAC,MAAM,kBAAkB,CAAC;;;;;;MAQtD,MAAM,MAsCR,CAAC"}

package/dist/client/api/disconnectClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"disconnectClient.d.ts","sourceRoot":"","sources":["../../../src/client/api/disconnectClient.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,gBAAgB,QAAa,QAAQ,OAAO,CAcxD,CAAA"}
+{"version":3,"file":"disconnectClient.d.ts","sourceRoot":"","sources":["../../../src/client/api/disconnectClient.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,gBAAgB,QAAa,QAAQ,OAAO,CAkBxD,CAAC"}

package/dist/client/api/getFeedSettings.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ```js
+ * import { getFeedSettings } from '@amityco/ts-sdk'
+ * const feedSettings = await getFeedSettings()
+ * const postFeedSetting = feedSettings.post
+ * ```
+ *
+ * Fetches a {@link Amity.FeedSettings} object
+ *
+ * @returns A Promise of {@link Amity.FeedSettings} object
+ *
+ * @category Client API
+ * @async
+ */
+export declare const getFeedSettings: () => Promise<Amity.FeedSettings>;
+//# sourceMappingURL=getFeedSettings.d.ts.map

package/dist/client/api/getFeedSettings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFeedSettings.d.ts","sourceRoot":"","sources":["../../../src/client/api/getFeedSettings.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,eAAe,QAAa,QAAQ,MAAM,YAAY,CAYlE,CAAC"}

package/dist/client/api/getToken.d.ts

@@ -15,5 +15,5 @@ export declare const getToken: (params: {
     displayName: Amity.User['displayName'];
     authToken?: string;
     deviceId: Amity.Device['deviceId'];
-}) => Promise<Amity.Tokens>;
+}) => Promise<T>;
 //# sourceMappingURL=getToken.d.ts.map

package/dist/client/api/getToken.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getToken.d.ts","sourceRoot":"","sources":["../../../src/client/api/getToken.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,QAAQ,WAAkB;IACrC,MAAM,EAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC7B,WAAW,EAAE,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC;IACvC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;CACpC,0BAaA,CAAA"}
+{"version":3,"file":"getToken.d.ts","sourceRoot":"","sources":["../../../src/client/api/getToken.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,QAAQ,WAAkB;IACrC,MAAM,EAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC7B,WAAW,EAAE,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC;IACvC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;CACpC,eAmBA,CAAC"}

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

@@ -3,6 +3,5 @@ export * from './createClient';
 export * from './connectClient';
 export * from './disconnectClient';
 export * from './isConnected';
-export * from './enableCache';
-export * from './clearCache';
+export * from './getFeedSettings';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA;AAClC,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD,cAAc,gBAAgB,CAAC;AAE/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,eAAe,CAAC;AAE9B,cAAc,mBAAmB,CAAC"}

package/dist/client/api/isConnected.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isConnected.d.ts","sourceRoot":"","sources":["../../../src/client/api/isConnected.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,WAAW,QAAO,OAS9B,CAAA"}
+{"version":3,"file":"isConnected.d.ts","sourceRoot":"","sources":["../../../src/client/api/isConnected.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,WAAW,QAAO,OAS9B,CAAC"}

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

@@ -1,2 +1,4 @@
+export * from './onConnectionError';
 export * from './onClientDisconnected';
+export * from './onClientBanned';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AAEpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC"}

package/dist/client/events/onClientBanned.d.ts

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

package/dist/client/events/onClientBanned.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onClientBanned.d.ts","sourceRoot":"","sources":["../../../src/client/events/onClientBanned.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,cAAc,aAAc,MAAM,QAAQ,CAAC,IAAI,CAAC,KAAG,MAAM,YAIrE,CAAC"}

package/dist/client/events/onClientDisconnected.d.ts

@@ -1,7 +1,7 @@
 /**
  * ```js
  * import { onClientDisconnected } from '@amityco/ts-sdk'
- * const dispose = onClientDisconnected(reason => {
+ * const dispose = onClientDisconnected(() => {
  *   // ...
  * })
  * ```

package/dist/client/events/onClientDisconnected.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"onClientDisconnected.d.ts","sourceRoot":"","sources":["../../../src/client/events/onClientDisconnected.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,oBAAoB,aACrB,MAAM,QAAQ,CAAC,IAAI,CAAC,KAC7B,MAAM,YAOR,CAAA"}
+{"version":3,"file":"onClientDisconnected.d.ts","sourceRoot":"","sources":["../../../src/client/events/onClientDisconnected.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,oBAAoB,aAAc,MAAM,QAAQ,CAAC,IAAI,CAAC,KAAG,MAAM,YAI3E,CAAC"}

package/dist/client/events/onConnectionError.d.ts

@@ -0,0 +1,18 @@
+import { ASCError } from '~/core/errors';
+/**
+ * ```js
+ * import { onConnectionError } from '@amityco/ts-sdk'
+ * const dispose = onClientBanned(() => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when any {@link Amity.Client} have been banned from the platform
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Client Events
+ */
+export declare const onConnectionError: (callback: Amity.Listener<ASCError>) => Amity.Unsubscriber;
+//# sourceMappingURL=onConnectionError.d.ts.map

package/dist/client/events/onConnectionError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onConnectionError.d.ts","sourceRoot":"","sources":["../../../src/client/events/onConnectionError.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAsB,MAAM,eAAe,CAAC;AAU7D;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iBAAiB,aAAc,MAAM,QAAQ,CAAC,QAAQ,CAAC,KAAG,MAAM,YAgB5E,CAAC"}

package/dist/client/utils/endpoints.d.ts

@@ -0,0 +1,12 @@
+export declare const API_REGIONS: {
+    readonly EU: "eu";
+    readonly SG: "sg";
+    readonly US: "us";
+};
+declare const URLS: {
+    readonly http: "https://api.{region}.amity.co";
+    readonly mqtt: "wss://sse.{region}.amity.co:443/mqtt";
+};
+export declare function computeUrl(type: keyof typeof URLS, region: string): string;
+export {};
+//# sourceMappingURL=endpoints.d.ts.map

package/dist/client/utils/endpoints.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoints.d.ts","sourceRoot":"","sources":["../../../src/client/utils/endpoints.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW;;;;CAId,CAAC;AAEX,QAAA,MAAM,IAAI;;;CAGA,CAAC;AAEX,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,OAAO,IAAI,EAAE,MAAM,EAAE,MAAM,UAEjE"}

package/dist/comment/api/createComment.d.ts

@@ -12,5 +12,5 @@
  * @category Comment API
  * @async
  */
-export declare const createComment: <T extends "text">(bundle: Pick<Amity.Comment<T>, "referenceType" | "referenceId" | "parentId" | "data" | "metadata">) => Promise<Amity.Comment<any>>;
+export declare const createComment: <T extends "text">(bundle: Pick<Amity.Comment<T>, "referenceType" | "referenceId" | "parentId" | "data" | "metadata" | "mentionees">) => Promise<Amity.Cached<Amity.Comment>>;
 //# sourceMappingURL=createComment.d.ts.map

package/dist/comment/api/createComment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createComment.d.ts","sourceRoot":"","sources":["../../../src/comment/api/createComment.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa,uJAoBzB,CAAA"}
+{"version":3,"file":"createComment.d.ts","sourceRoot":"","sources":["../../../src/comment/api/createComment.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa,2IAKvB,QAAQ,MAAM,MAAM,CAAC,aAAa,CAAC,CAmBrC,CAAC"}

package/dist/comment/api/deleteComment.d.ts

@@ -12,5 +12,5 @@
  * @category Comment API
  * @async
  */
-export declare const deleteComment: (commentId: Amity.Comment['commentId']) => Promise<Amity.Comment<any>>;
+export declare const deleteComment: (commentId: Amity.Comment['commentId'], permanent?: boolean) => Promise<Amity.Comment>;
 //# sourceMappingURL=deleteComment.d.ts.map

package/dist/comment/api/deleteComment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deleteComment.d.ts","sourceRoot":"","sources":["../../../src/comment/api/deleteComment.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa,cACb,aAAa,CAAC,WAAW,CAAC,gCAiBtC,CAAA"}
+{"version":3,"file":"deleteComment.d.ts","sourceRoot":"","sources":["../../../src/comment/api/deleteComment.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa,cACb,aAAa,CAAC,WAAW,CAAC,0BAEpC,QAAQ,aAAa,CAkCvB,CAAC"}

package/dist/comment/api/getComment.d.ts

@@ -13,7 +13,7 @@
  * @async
  */
 export declare const getComment: {
-    (commentId: Amity.Comment['commentId']): Promise<Amity.Comment<any>>;
+    (commentId: Amity.Comment['commentId']): Promise<Amity.Cached<Amity.Comment>>;
     /**
      * ```js
      * import { getComment } from '@amityco/ts-sdk'
@@ -27,6 +27,6 @@ export declare const getComment: {
      *
      * @category Comment API
      */
-    locally(commentId: Amity.Comment['commentId']): Amity.Comment<any>;
+    locally(commentId: Amity.Comment['commentId']): Amity.Cached<Amity.Comment> | undefined;
 };
 //# sourceMappingURL=getComment.d.ts.map

package/dist/comment/api/getComment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getComment.d.ts","sourceRoot":"","sources":["../../../src/comment/api/getComment.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU;gBACV,aAAa,CAAC,WAAW,CAAC;IAiBvC;;;;;;;;;;;;OAYG;uBAEU,aAAa,CAAC,WAAW,CAAC;CAhBtC,CAAA"}
+{"version":3,"file":"getComment.d.ts","sourceRoot":"","sources":["../../../src/comment/api/getComment.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU;gBACV,aAAa,CAAC,WAAW,CAAC,GACpC,QAAQ,MAAM,MAAM,CAAC,aAAa,CAAC,CAAC;IA+BvC;;;;;;;;;;;;OAYG;uBAEU,aAAa,CAAC,WAAW,CAAC,GACpC,MAAM,MAAM,CAAC,aAAa,CAAC,GAAG,SAAS;CAjBzC,CAAC"}

package/dist/comment/api/getComments.d.ts

@@ -13,7 +13,7 @@
  * @async
  */
 export declare const getComments: {
-    (commentIds: Amity.Comment['commentId'][]): Promise<Record<string, Amity.Comment<any>>>;
+    (commentIds: Amity.Comment['commentId'][]): Promise<Amity.Cached<Amity.Comment[]>>;
     /**
      * ```js
      * import { getComments } from '@amityco/ts-sdk'
@@ -27,6 +27,6 @@ export declare const getComments: {
      *
      * @category Comment API
      */
-    locally(commentIds: Amity.Comment['commentId'][]): Record<string, Amity.Comment<any>> | undefined;
+    locally(commentIds: Amity.Comment['commentId'][]): Amity.Cached<Amity.Comment[]> | undefined;
 };
 //# sourceMappingURL=getComments.d.ts.map

package/dist/comment/api/getComments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getComments.d.ts","sourceRoot":"","sources":["../../../src/comment/api/getComments.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,WAAW;iBACV,aAAa,CAAC,WAAW,CAAC,EAAE;IAkB1C;;;;;;;;;;;;OAYG;wBAEW,aAAa,CAAC,WAAW,CAAC,EAAE;CAhBzC,CAAA"}
+{"version":3,"file":"getComments.d.ts","sourceRoot":"","sources":["../../../src/comment/api/getComments.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,WAAW;iBACV,aAAa,CAAC,WAAW,CAAC,EAAE,GACvC,QAAQ,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC;IAoBzC;;;;;;;;;;;;OAYG;wBAEW,aAAa,CAAC,WAAW,CAAC,EAAE,GACvC,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC,GAAG,SAAS;CAjB3C,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/comment/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAE5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/comment/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAE7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC"}

package/dist/comment/api/queryComments.d.ts

@@ -1,7 +1,7 @@
 /**
  * ```js
  * import { queryComments } from '@amityco/ts-sdk'
- * const comments = await queryComments({ postId })
+ * const comments = await queryComments({ referenceType: 'post', referenceId: 'foo' })
  * ```
  *
  * Queries a paginable list of {@link Amity.Comment} objects
@@ -13,22 +13,11 @@
  * @async
  */
 export declare const queryComments: {
-    (query: {
-        referenceType: Amity.Comment['referenceType'];
-        referenceId: Amity.Comment['referenceId'];
-        parentId?: Amity.Comment['commentId'] | null;
-        hasFlag?: boolean;
-        isDeleted?: Amity.Comment['isDeleted'];
-        page?: Amity.Page;
-    }): Promise<{
-        data: Record<string, Amity.Comment<any>>;
-        prevPage: Amity.Page | null;
-        nextPage: Amity.Page | null;
-    }>;
+    (query: Amity.QueryComments): Promise<Amity.Cached<Amity.Paged<Amity.Comment>>>;
     /**
      * ```js
      * import { queryComments } from '@amityco/ts-sdk'
-     * const comments = queryComments.locally({ postId })
+     * const comments = queryComments.locally({ referenceType: 'post', referenceId: 'foo' })
      * ```
      *
      * Queries a paginable list of {@link Amity.Comment} objects from cache
@@ -38,16 +27,6 @@ export declare const queryComments: {
      *
      * @category Comment API
      */
-    locally(query: Parameters<typeof queryComments>[0]): {
-        data: Record<string, Amity.Comment<any>>;
-        nextPage: {
-            after: number;
-            limit: number;
-        };
-        prevPage: {
-            before: number;
-            limit: number;
-        } | undefined;
-    } | undefined;
+    locally(query: Parameters<typeof queryComments>[0]): Amity.Cached<Amity.Paged<Amity.Comment>> | undefined;
 };
 //# sourceMappingURL=queryComments.d.ts.map

package/dist/comment/api/queryComments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryComments.d.ts","sourceRoot":"","sources":["../../../src/comment/api/queryComments.ts"],"names":[],"mappings":"AAaA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa;YAAiB;QACzC,aAAa,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;QAC9C,WAAW,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;QAC1C,QAAQ,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC,GAAG,IAAI,CAAA;QAC5C,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,SAAS,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC,CAAA;QACtC,IAAI,CAAC,EAAE,MAAM,IAAI,CAAA;KAClB;;;;;IAmCD;;;;;;;;;;;;OAYG;mBAEM,WAAW,oBAAoB,CAAC,CAAC,CAAC,CAAC;;;;;;;;;;;CAhB3C,CAAA"}
+{"version":3,"file":"queryComments.d.ts","sourceRoot":"","sources":["../../../src/comment/api/queryComments.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa;YACjB,MAAM,aAAa,GACzB,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;IAkDpD;;;;;;;;;;;;OAYG;mBAEM,WAAW,oBAAoB,CAAC,CAAC,CAAC,CAAC,GACzC,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,aAAa,CAAC,CAAC,GAAG,SAAS;CAjBtD,CAAC"}

package/dist/comment/api/updateComment.d.ts

@@ -15,5 +15,5 @@
  * @category Comment API
  * @async
  */
-export declare const updateComment: (commentId: Amity.Comment['commentId'], patch: Patch<Amity.Comment, 'data' | 'metadata'>) => Promise<Amity.Comment<any>>;
+export declare const updateComment: (commentId: Amity.Comment['commentId'], patch: Patch<Amity.Comment, 'data' | 'metadata' | 'mentionees'>) => Promise<Amity.Cached<Amity.Comment>>;
 //# sourceMappingURL=updateComment.d.ts.map

package/dist/comment/api/updateComment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"updateComment.d.ts","sourceRoot":"","sources":["../../../src/comment/api/updateComment.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,cACb,aAAa,CAAC,WAAW,CAAC,SAC9B,MAAM,aAAa,EAAE,MAAM,GAAG,UAAU,CAAC,gCAejD,CAAA"}
+{"version":3,"file":"updateComment.d.ts","sourceRoot":"","sources":["../../../src/comment/api/updateComment.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,cACb,aAAa,CAAC,WAAW,CAAC,SAC9B,MAAM,aAAa,EAAE,MAAM,GAAG,UAAU,GAAG,YAAY,CAAC,KAC9D,QAAQ,MAAM,MAAM,CAAC,aAAa,CAAC,CAmBrC,CAAC"}

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

@@ -1,4 +1,8 @@
 export * from './onCommentCreated';
 export * from './onCommentUpdated';
 export * from './onCommentDeleted';
+export * from './onCommentFlagged';
+export * from './onCommentUnflagged';
+export * from './onCommentReactionAdded';
+export * from './onCommentReactionRemoved';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/comment/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/comment/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AAErC,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC"}

package/dist/comment/events/onCommentCreated.d.ts

@@ -6,12 +6,12 @@
  * })
  * ```
  *
- * Fired when an {@link Amity.Comment} has been created
+ * Fired when a {@link Amity.Comment} has been created
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening
  *
  * @category Comment Events
  */
-export declare const onCommentCreated: <T extends "text">(callback: Amity.Listener<Amity.Comment<T>>) => Amity.Unsubscriber;
+export declare const onCommentCreated: (callback: Amity.Listener<Amity.Comment>) => Amity.Unsubscriber;
 //# sourceMappingURL=onCommentCreated.d.ts.map

package/dist/comment/events/onCommentCreated.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"onCommentCreated.d.ts","sourceRoot":"","sources":["../../../src/comment/events/onCommentCreated.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,oEAE1B,MAAM,YAeR,CAAA"}
+{"version":3,"file":"onCommentCreated.d.ts","sourceRoot":"","sources":["../../../src/comment/events/onCommentCreated.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,aAAc,MAAM,QAAQ,CAAC,aAAa,CAAC,KAAG,MAAM,YACtB,CAAC"}

package/dist/comment/events/onCommentDeleted.d.ts

@@ -6,12 +6,12 @@
  * })
  * ```
  *
- * Fired when an {@link Amity.Comment} has been deleted
+ * Fired when a {@link Amity.Comment} has been deleted
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening
  *
  * @category Comment Events
  */
-export declare const onCommentDeleted: <T extends "text">(callback: Amity.Listener<Amity.Comment<T>>) => Amity.Unsubscriber;
+export declare const onCommentDeleted: (callback: Amity.Listener<Amity.Comment>) => Amity.Unsubscriber;
 //# sourceMappingURL=onCommentDeleted.d.ts.map

package/dist/comment/events/onCommentDeleted.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"onCommentDeleted.d.ts","sourceRoot":"","sources":["../../../src/comment/events/onCommentDeleted.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,oEAE1B,MAAM,YAeR,CAAA"}
+{"version":3,"file":"onCommentDeleted.d.ts","sourceRoot":"","sources":["../../../src/comment/events/onCommentDeleted.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,aAAc,MAAM,QAAQ,CAAC,aAAa,CAAC,KAAG,MAAM,YACtB,CAAC"}

package/dist/comment/events/onCommentFlagged.d.ts

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

package/dist/comment/events/onCommentFlagged.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onCommentFlagged.d.ts","sourceRoot":"","sources":["../../../src/comment/events/onCommentFlagged.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,aAAc,MAAM,QAAQ,CAAC,aAAa,CAAC,KAAG,MAAM,YACtB,CAAC"}