@amityco/ts-sdk 0.0.1-e5fb0d2.0 → 0.0.1-e643f6f.0

package/dist/core/subscription.d.ts

@@ -0,0 +1,43 @@
+import { ASCError } from '~/core/errors';
+export declare enum SubscriptionLevels {
+    COMMUNITY = "community",
+    POST = "post",
+    COMMENT = "comment",
+    POST_AND_COMMENT = "post_and_comment",
+    USER = "user"
+}
+export declare const getCommunityTopic: ({ path }: Amity.Subscribable, level?: Exclude<SubscriptionLevels, SubscriptionLevels.USER>) => string;
+export declare const getUserTopic: ({ path }: Amity.Subscribable, level?: Exclude<SubscriptionLevels, SubscriptionLevels.COMMUNITY>) => string;
+export declare const getPostTopic: ({ path }: Amity.Subscribable, level?: SubscriptionLevels.POST | SubscriptionLevels.COMMENT) => string;
+export declare const getCommentTopic: ({ path }: Amity.Subscribable) => string;
+export declare const getMyFollowersTopic: () => string;
+export declare const getMyFollowingsTopic: () => string;
+export declare const getChannelTopic: (channel: Amity.Subscribable) => string;
+export declare const getSubChannelTopic: (subChannel: Amity.Subscribable) => string;
+export declare const getMessageTopic: (message: Amity.Subscribable) => string;
+/**
+ * @hidden
+ *
+ * Create a topic to subscribe to network level events like 'user is deleted from the network'
+ */
+export declare const getNetworkTopic: () => string;
+/**
+ * @hidden
+ *
+ * Create a topic to subscribe to channel events for 'conversation', 'community' channel
+ */
+export declare const getSmartFeedChannelTopic: () => string;
+/**
+ * @hidden
+ *
+ * Create a topic to subscribe to sub channel events for 'conversation', 'community' channel
+ */
+export declare const getSmartFeedSubChannelTopic: () => string;
+/**
+ * @hidden
+ *
+ * Create a topic to subscribe to message events for 'conversation', 'community' channel
+ */
+export declare const getSmartFeedMessageTopic: () => string;
+export declare function subscribeTopic(topic: string, callback?: Amity.Listener<ASCError | void>): Amity.Unsubscriber;
+//# sourceMappingURL=subscription.d.ts.map

package/dist/core/subscription.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription.d.ts","sourceRoot":"","sources":["../../src/core/subscription.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAIzC,oBAAY,kBAAkB;IAC5B,SAAS,cAAc;IACvB,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,gBAAgB,qBAAqB;IACrC,IAAI,SAAS;CACd;AAoBD,eAAO,MAAM,iBAAiB,aAClB,MAAM,YAAY,UACrB,QAAQ,kBAAkB,EAAE,mBAAmB,IAAI,CAAC,KAC1D,MAA4C,CAAC;AAEhD,eAAO,MAAM,YAAY,aACb,MAAM,YAAY,UACrB,QAAQ,kBAAkB,EAAE,mBAAmB,SAAS,CAAC,KAC/D,MAIA,CAAC;AAEJ,eAAO,MAAM,YAAY,aACb,MAAM,YAAY,UACrB,mBAAmB,IAAI,GAAG,mBAAmB,OAAO,KAC1D,MAOF,CAAC;AAEF,eAAO,MAAM,eAAe,aAAc,MAAM,YAAY,KAAG,MAE9D,CAAC;AAEF,eAAO,MAAM,mBAAmB,QAAO,MAItC,CAAC;AAEF,eAAO,MAAM,oBAAoB,QAAO,MAIvC,CAAC;AAEF,eAAO,MAAM,eAAe,YAAa,MAAM,YAAY,KAAG,MAA6B,CAAC;AAE5F,eAAO,MAAM,kBAAkB,eAAgB,MAAM,YAAY,KAAG,MAC5C,CAAC;AAEzB,eAAO,MAAM,eAAe,YAAa,MAAM,YAAY,KAAG,MAAsB,CAAC;AAErF;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAAO,MAElC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,QAAO,MAI3C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,QAAO,MAI9C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,QAAO,MAI3C,CAAC;AAKF,wBAAgB,cAAc,CAC5B,KAAK,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC,GACzC,KAAK,CAAC,YAAY,CAepB"}

package/dist/core/tests/query/filtering.test.d.ts

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

package/dist/core/tests/query/filtering.test.d.ts.map

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

package/dist/core/tests/query/query/runQuery.test.d.ts

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

package/dist/core/tests/query/query/runQuery.test.d.ts.map

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

package/dist/core/tests/query/query.test.d.ts

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

package/dist/core/tests/query/query.test.d.ts.map

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

package/dist/core/tests/subscription.test.d.ts

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

package/dist/core/tests/subscription.test.d.ts.map

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

package/dist/core/transports/http.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Creates a pre-configured axios instance
+ *
+ * @param endpoint The ASC rest api server's URL
+ * @returns A pre-configured axios instance
+ *
+ * @category Transport
+ * @hidden
+ */
+export declare const createHttpTransport: (endpoint: string) => import("axios").AxiosInstance;
+//# sourceMappingURL=http.d.ts.map

package/dist/core/transports/http.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../../src/core/transports/http.ts"],"names":[],"mappings":"AAQA;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,aAAc,MAAM,kCA6EnD,CAAC"}

package/dist/core/transports/index.d.ts

@@ -0,0 +1,4 @@
+export * from './http';
+export * from './ws';
+export * from './mqtt';
+//# sourceMappingURL=index.d.ts.map

package/dist/core/transports/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/transports/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,MAAM,CAAC;AACrB,cAAc,QAAQ,CAAC"}

package/dist/core/transports/mqtt.d.ts

@@ -0,0 +1,17 @@
+import { MqttClient, IClientOptions } from 'mqtt/dist/mqtt';
+export declare function getMqttOptions(params: {
+    username: string;
+    password: string;
+    clientId?: string;
+}): IClientOptions;
+/**
+ * Creates a pre-configured socket.io instance
+ *
+ * @param endpoint The mqtt server's URL
+ * @returns A pre-configured (non-connected) mqtt client instance
+ *
+ * @category Transport
+ * @hidden
+ */
+export declare const createMqttTransport: (endpoint: string) => Amity.MqttClient;
+//# sourceMappingURL=mqtt.d.ts.map

package/dist/core/transports/mqtt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mqtt.d.ts","sourceRoot":"","sources":["../../../src/core/transports/mqtt.ts"],"names":[],"mappings":"AAEA,OAAa,EAAE,UAAU,EAAE,cAAc,EAAsB,MAAM,gBAAgB,CAAC;AActF,wBAAgB,cAAc,CAAC,MAAM,EAAE;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,GAAG,cAAc,CAgBjB;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,aAAc,MAAM,KAAG,gBAgHtD,CAAC"}

package/dist/core/transports/test/http.test.d.ts

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

package/dist/core/transports/test/http.test.d.ts.map

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

package/dist/core/transports/utils.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Unwraps v3 server payload (for error handling and type extraction)
+ *
+ * @param response A typical "v3" response (related to backend's service strategy)
+ *
+ * @returns The data returned by the backend
+ * @throws An error related to backend's rejection
+ *
+ * @category Transport
+ * @hidden
+ */
+export declare const unwrapPayload: <T>(response: Amity.Response<T>) => T;
+//# sourceMappingURL=utils.d.ts.map

package/dist/core/transports/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/core/transports/utils.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,aAAa,uCAYzB,CAAC"}

package/dist/core/transports/ws.d.ts

@@ -0,0 +1,27 @@
+/// <reference types="socket.io-client" />
+/**
+ * Creates a pre-configured socket.io instance
+ *
+ * @param endpoint The socket.io server's URL
+ * @returns A pre-configured (non-connected) socket.io client instance
+ *
+ * @category Transport
+ * @hidden
+ */
+export declare const createWebsocketTransport: (endpoint: string) => SocketIOClient.Socket;
+/**
+ * Promisify a websocket event emission - resulting in a synchronous http-like XHR (ws legacy)
+ *
+ * @param client The current client for which to send the event with
+ * @param event The websocket event name
+ * @param data The event's payload
+ *
+ * @returns The data returned by the backend
+ * @throws An error related to backend's rejection
+ *
+ * @category Transport
+ * @async
+ * @hidden
+ */
+export declare const synchronousWSCall: <T>(client: Amity.Client, event: string, data?: Record<string, unknown>) => Promise<T | undefined>;
+//# sourceMappingURL=ws.d.ts.map

package/dist/core/transports/ws.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws.d.ts","sourceRoot":"","sources":["../../../src/core/transports/ws.ts"],"names":[],"mappings":";AAGA;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB,aAAc,MAAM,0BAaxD,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,iBAAiB,cACpB,MAAM,MAAM,SACb,MAAM,SACN,OAAO,MAAM,EAAE,OAAO,CAAC,2BAe/B,CAAC"}

package/dist/core/uuid.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uuid.d.ts","sourceRoot":"","sources":["../../src/core/uuid.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,IAAI,cAA0C,CAAA"}
+{"version":3,"file":"uuid.d.ts","sourceRoot":"","sources":["../../src/core/uuid.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,IAAI,cAA0C,CAAC"}

package/dist/external/api/createUserToken.d.ts

@@ -0,0 +1,23 @@
+import { API_REGIONS } from '~/client/utils/endpoints';
+/**
+ * Retrieves accessToken info to use in Beta services
+ *
+ * @param apiKey for the Http Client instance
+ * @param apiRegion endpoint to connect to
+ * @param params The token parameters
+ * @param params.userId The userId to use to issue a token
+ * @param params.displayName The user's displayName
+ * @param params.authToken The authentication token - necessary when network option is set to secure
+ * @return An accessToken info object for the given userId
+ *
+ * @category External API
+ * @hidden
+ */
+export declare const createUserToken: (apiKey: string, apiRegion: (typeof API_REGIONS)[keyof typeof API_REGIONS], params: {
+    userId: Amity.User['userId'];
+    displayName?: Amity.User['displayName'];
+    authToken?: string;
+}) => Promise<{
+    accessToken: string;
+}>;
+//# sourceMappingURL=createUserToken.d.ts.map

package/dist/external/api/createUserToken.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createUserToken.d.ts","sourceRoot":"","sources":["../../../src/external/api/createUserToken.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAc,MAAM,0BAA0B,CAAC;AAEnE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,eAAe,WAClB,MAAM,aACH,CAAA,kBAAkB,EAAC,MAAM,kBAAkB,CAAC,UAC/C;IACN,MAAM,EAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC;IACxC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;;EAiBF,CAAC"}

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

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

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

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

package/dist/external/api/tests/createUserToken.test.d.ts

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

package/dist/external/api/tests/createUserToken.test.d.ts.map

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

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/feed/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/feed/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}

package/dist/feed/api/queryGlobalFeed.d.ts

@@ -11,13 +11,27 @@
  *
  * @category Feed API
  * @async
- **/
-export declare const queryGlobalFeed: (query?: {
-    dataTypes?: ("video" | "image" | "file")[] | undefined;
-    page?: Amity.Page | undefined;
-} | undefined) => Promise<{
-    data: Record<string, Amity.Post<any>>;
-    nextPage: Amity.Page | null;
-    prevPage: Amity.Page | null;
-}>;
+ * */
+export declare const queryGlobalFeed: {
+    (query?: {
+        dataTypes?: ('video' | 'image' | 'file' | 'liveStream')[];
+        useCustomRanking?: boolean;
+        page?: Amity.Page;
+    }): Promise<Amity.Cached<Amity.Paged<Amity.Post>>>;
+    /**
+     * ```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
+     * */
+    locally(query?: Parameters<typeof queryGlobalFeed>[0]): Amity.Cached<Amity.Paged<Amity.Post>> | undefined;
+};
 //# sourceMappingURL=queryGlobalFeed.d.ts.map

package/dist/feed/api/queryGlobalFeed.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryGlobalFeed.d.ts","sourceRoot":"","sources":["../../../src/feed/api/queryGlobalFeed.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;IAaI;AACJ,eAAO,MAAM,eAAe;;;;;;;EA6B3B,CAAA"}
+{"version":3,"file":"queryGlobalFeed.d.ts","sourceRoot":"","sources":["../../../src/feed/api/queryGlobalFeed.ts"],"names":[],"mappings":"AAWA;;;;;;;;;;;;;KAaK;AACL,eAAO,MAAM,eAAe;aAAkB;QAC5C,SAAS,CAAC,EAAE,CAAC,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,YAAY,CAAC,EAAE,CAAC;QAC1D,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAC3B,IAAI,CAAC,EAAE,MAAM,IAAI,CAAC;KACnB,GAAG,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;IA4ClD;;;;;;;;;;;;;SAaK;oBAEK,WAAW,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAC5C,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,SAAS;CAnBnD,CAAC"}

package/dist/feed/api/test/queryGlobalFeed.test.d.ts

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

package/dist/feed/api/test/queryGlobalFeed.test.d.ts.map

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

package/dist/file/api/createFile.d.ts

@@ -7,10 +7,11 @@
  * Creates an {@link Amity.File}
  *
  * @param formData The data necessary to create a new {@link Amity.File}
+ * @param onProgress The callback to track the upload progress
  * @returns The newly created {@link Amity.File}
  *
  * @category File API
  * @async
  */
-export declare const createFile: <T extends Amity.FileType = any>(formData: FormData, onProgress?: ((percent: number) => void) | undefined) => Promise<Amity.File<T>>;
+export declare const createFile: <T extends Amity.FileType = any>(formData: FormData, onProgress?: ((percent: number) => void) | undefined) => Promise<Amity.Cached<Amity.File[]>>;
 //# sourceMappingURL=createFile.d.ts.map

package/dist/file/api/createFile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createFile.d.ts","sourceRoot":"","sources":["../../../src/file/api/createFile.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU,6CACX,QAAQ,0BACK,MAAM,KAAK,IAAI,wCA2BvC,CAAA"}
+{"version":3,"file":"createFile.d.ts","sourceRoot":"","sources":["../../../src/file/api/createFile.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU,6CACX,QAAQ,0BACK,MAAM,KAAK,IAAI,kBACrC,QAAQ,MAAM,MAAM,CAAC,UAAU,EAAE,CAAC,CA6BpC,CAAC"}

package/dist/file/api/createImage.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { createImage } from '@amityco/ts-sdk'
+ * const created = await createImage(formData)
+ * ```
+ *
+ * Creates an {@link Amity.File<'image'>}
+ *
+ * @param formData The data necessary to create a new {@link Amity.File<'image'>}
+ * @param onProgress The callback to track the upload progress
+ * @returns The newly created {@link Amity.File<'image'>}
+ *
+ * @category File API
+ * @async
+ */
+export declare const createImage: (formData: FormData, onProgress?: ((percent: number) => void) | undefined) => Promise<Amity.Cached<Amity.File<'image'>[]>>;
+//# sourceMappingURL=createImage.d.ts.map

package/dist/file/api/createImage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createImage.d.ts","sourceRoot":"","sources":["../../../src/file/api/createImage.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,WAAW,aACZ,QAAQ,0BACK,MAAM,KAAK,IAAI,kBACrC,QAAQ,MAAM,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,CAiC7C,CAAC"}

package/dist/file/api/createVideo.d.ts

@@ -0,0 +1,18 @@
+/**
+ * ```js
+ * import { createVideo } from '@amityco/ts-sdk'
+ * const created = await createVideo(formData)
+ * ```
+ *
+ * Creates an {@link Amity.File<'video'>}
+ *
+ * @param formData The data necessary to create a new {@link Amity.File<'video'>}
+ * @param feedType The {@link Amity.File<'video'>} feed type
+ * @param onProgress The callback to track the upload progress
+ * @returns The newly created {@link Amity.File<'video'>}
+ *
+ * @category File API
+ * @async
+ */
+export declare const createVideo: (formData: FormData, feedType?: Amity.ContentFeedType, onProgress?: ((percent: number) => void) | undefined) => Promise<Amity.Cached<Amity.File<'video'>[]>>;
+//# sourceMappingURL=createVideo.d.ts.map

package/dist/file/api/createVideo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createVideo.d.ts","sourceRoot":"","sources":["../../../src/file/api/createVideo.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,WAAW,aACZ,QAAQ,aACP,MAAM,eAAe,0BACT,MAAM,KAAK,IAAI,kBACrC,QAAQ,MAAM,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,CAqC7C,CAAC"}

package/dist/file/api/deleteFile.d.ts

@@ -12,5 +12,7 @@
  * @category File API
  * @async
  */
-export declare const deleteFile: (fileId: Amity.File<any>['fileId']) => Promise<boolean>;
+export declare const deleteFile: (fileId: Amity.File<any>['fileId']) => Promise<{
+    success: boolean;
+}>;
 //# sourceMappingURL=deleteFile.d.ts.map

package/dist/file/api/deleteFile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deleteFile.d.ts","sourceRoot":"","sources":["../../../src/file/api/deleteFile.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU,WACb,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,qBAelC,CAAA"}
+{"version":3,"file":"deleteFile.d.ts","sourceRoot":"","sources":["../../../src/file/api/deleteFile.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU,WACb,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,KAChC,QAAQ;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,CAU9B,CAAC"}

package/dist/file/api/fileUrlWithSize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fileUrlWithSize.d.ts","sourceRoot":"","sources":["../../../src/file/api/fileUrlWithSize.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,YACjB,UAAU,CAAC,SAAS,CAAC,QACxB,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,WAG5C,CAAA"}
+{"version":3,"file":"fileUrlWithSize.d.ts","sourceRoot":"","sources":["../../../src/file/api/fileUrlWithSize.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,YACjB,UAAU,CAAC,SAAS,CAAC,QACxB,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,WAG5C,CAAC"}

package/dist/file/api/getFile.d.ts

@@ -6,14 +6,14 @@
  *
  * Fetches a {@link Amity.File} object
  *
- * @param filelId the ID of the {@link Amity.File} to fetch
+ * @param fileId the ID of the {@link Amity.File} to fetch
  * @returns the associated {@link Amity.File} object
  *
  * @category File API
  * @async
  */
 export declare const getFile: {
-    <T extends Amity.FileType = any>(fileId: Amity.File<any>['fileId']): Promise<Amity.FilePayload<T>>;
+    <T extends Amity.FileType = any>(fileId: Amity.File<any>['fileId']): Promise<Amity.Cached<Amity.File>>;
     /**
      * ```js
      * import { getFile } from '@amityco/ts-sdk'
@@ -27,6 +27,6 @@ export declare const getFile: {
      *
      * @category File API
      */
-    locally(fileId: Amity.File<any>['fileId']): Amity.File<any>;
+    locally(fileId: Amity.File<any>['fileId']): Amity.Cached<Amity.File> | undefined;
 };
 //# sourceMappingURL=getFile.d.ts.map

package/dist/file/api/getFile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getFile.d.ts","sourceRoot":"","sources":["../../../src/file/api/getFile.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,OAAO;6CACV,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;IAkBnC;;;;;;;;;;;;OAYG;oBAEO,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;CAhBlC,CAAA"}
+{"version":3,"file":"getFile.d.ts","sourceRoot":"","sources":["../../../src/file/api/getFile.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,OAAO;6CACV,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAChC,QAAQ,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;IAmBpC;;;;;;;;;;;;OAYG;oBACwB,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,GAAG,SAAS;CAhB1F,CAAC"}

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

@@ -2,4 +2,6 @@ export * from './getFile';
 export * from './createFile';
 export * from './deleteFile';
 export * from './fileUrlWithSize';
+export * from './createVideo';
+export * from './createImage';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/file/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA;AAC5B,cAAc,cAAc,CAAA;AAC5B,cAAc,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/file/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC"}

package/dist/file/api/test/createImage.test.d.ts

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

package/dist/file/api/test/createImage.test.d.ts.map

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

package/dist/file/api/test/createVideo.test.d.ts

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

package/dist/file/api/test/createVideo.test.d.ts.map

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

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

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

package/dist/file/observers/observeFile.d.ts

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

package/dist/file/observers/observeFile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"observeFile.d.ts","sourceRoot":"","sources":["../../../src/file/observers/observeFile.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,WAAW,uCACd,MAAM;;qCAEb,MAAM,YA+BR,CAAA"}
+{"version":3,"file":"observeFile.d.ts","sourceRoot":"","sources":["../../../src/file/observers/observeFile.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,WAAW,uCACd,MAAM,8EAEb,MAAM,YAuBR,CAAC"}

package/dist/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/follow/api/acceptFollower.d.ts.map

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

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

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

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

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

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

@@ -0,0 +1,16 @@
+/**
+ * ```js
+ * import { follow } from '@amityco/ts-sdk'
+ * const status = await follow('foobar')
+ * ```
+ *
+ * Follow the user
+ *
+ * @param userId the ID of the {@link Amity.User}
+ * @returns the status {@link Amity.FollowStatus}
+ *
+ * @category Follow API
+ * @async
+ */
+export declare const follow: (userId: Amity.User['userId']) => Promise<Amity.Cached<Amity.FollowStatus>>;
+//# sourceMappingURL=follow.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"follow.d.ts","sourceRoot":"","sources":["../../../src/follow/api/follow.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,MAAM,WACT,MAAM,IAAI,CAAC,QAAQ,CAAC,KAC3B,QAAQ,MAAM,MAAM,CAAC,MAAM,YAAY,CAAC,CAoB1C,CAAC"}

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

@@ -0,0 +1,32 @@
+/**
+ * ```js
+ * import { getFollowInfo } from '@amityco/ts-sdk'
+ * const { data: followInfo } = await getFollowInfo('foobar')
+ * ```
+ *
+ * Fetches the number of followers, followings, pending requests and the follow status for current user
+ *
+ * @param userId the ID of the {@link Amity.User}
+ * @returns the associated {@link Amity.FollowInfo} object
+ *
+ * @category Follow API
+ * @async
+ */
+export declare const getFollowInfo: {
+    (userId: Amity.User['userId']): Promise<Amity.Cached<Amity.FollowInfo>>;
+    /**
+     * ```js
+     * import { getFollowInfo } from '@amityco/ts-sdk'
+     * const { data: followInfo } = getFollowInfo.locally('foobar')
+     * ```
+     *
+     * Fetches the number of followers, followings, pending requests and the follow status for current user from cache
+     *
+     * @param userId the ID of the {@link Amity.User}
+     * @returns the associated {@link Amity.FollowInfo} object
+     *
+     * @category Follow API
+     */
+    locally(userId: Amity.User['userId']): Amity.Cached<Amity.FollowInfo> | undefined;
+};
+//# sourceMappingURL=getFollowInfo.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getFollowInfo.d.ts","sourceRoot":"","sources":["../../../src/follow/api/getFollowInfo.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa;aAChB,MAAM,IAAI,CAAC,QAAQ,CAAC,GAC3B,QAAQ,MAAM,MAAM,CAAC,MAAM,UAAU,CAAC,CAAC;IA8B1C;;;;;;;;;;;;OAYG;oBAEO,MAAM,IAAI,CAAC,QAAQ,CAAC,GAC3B,MAAM,MAAM,CAAC,MAAM,UAAU,CAAC,GAAG,SAAS;CAlB5C,CAAC"}

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

@@ -0,0 +1,8 @@
+export * from './queryFollowers';
+export * from './queryFollowings';
+export * from './getFollowInfo';
+export * from './follow';
+export * from './unfollow';
+export * from './acceptFollower';
+export * from './declineFollower';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/follow/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAEhC,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC"}

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

@@ -0,0 +1,32 @@
+/**
+ * ```js
+ * import { queryFollowers } from '@amityco/ts-sdk'
+ * const { data: followers, prevPage, nextPage } = await queryFollowers({ userId })
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.FollowStatus}
+ *
+ * @param query The query parameters
+ * @returns followers
+ *
+ * @category Follow API
+ * @async
+ */
+export declare const queryFollowers: {
+    (query: Amity.QueryFollowers): Promise<Amity.Cached<Amity.Paged<Amity.FollowStatus, Amity.PageRaw>>>;
+    /**
+     * ```js
+     * import { queryFollowers } from '@amityco/ts-sdk'
+     * const { data: followers, prevPage, nextPage } = queryFollowers.locally({ userId })
+     * ```
+     *
+     * Queries a paginable list of {@link Amity.FollowStatus} objects from cache
+     *
+     * @param query The query parameters
+     * @returns followers
+     *
+     * @category Post API
+     */
+    locally(query: Parameters<typeof queryFollowers>[0]): Amity.Cached<Amity.Paged<Amity.FollowStatus, Amity.PageRaw>> | undefined;
+};
+//# sourceMappingURL=queryFollowers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"queryFollowers.d.ts","sourceRoot":"","sources":["../../../src/follow/api/queryFollowers.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,cAAc;YAClB,MAAM,cAAc,GAC1B,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,YAAY,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAIxE;;;;;;;;;;;;OAYG;mBAEM,WAAW,qBAAqB,CAAC,CAAC,CAAC,CAAC,GAC1C,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,YAAY,EAAE,MAAM,OAAO,CAAC,CAAC,GAAG,SAAS;CAlBzC,CAAC"}