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

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

@@ -8,5 +8,17 @@
  *
  * @hidden
  */
-export declare const filterByPropEquality: <T = {}>(collection: T[], key: keyof T, value: any) => T[];
+export declare const filterByPropEquality: <T = Record<string, unknown>>(collection: T[], key: keyof T, value: any) => T[];
+export declare const filterByPropInclusion: <T = Record<string, unknown>>(collection: T[], key: keyof T, value: any[] | undefined) => T[];
+/**
+ * Filter a channel collection by membership of the userId
+ *
+ * @param collection the channel collection to filter
+ * @param membership the membership to be filtered by
+ * @param userId user id to be filtered by
+ * @returns a filtered collection with items only matching the criteria
+ *
+ * @hidden
+ */
+export declare const filterByChannelMembership: (collection: Amity.Channel[], membership: Amity.ChannelLiveCollection['membership'], userId: Amity.Membership<'channel'>['userId']) => Amity.Channel[];
 //# sourceMappingURL=filtering.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"filtering.d.ts","sourceRoot":"","sources":["../../../src/core/query/filtering.ts"],"names":[],"mappings":"AAIA;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB,iDAAkD,GAAG,QAErF,CAAA"}
+{"version":3,"file":"filtering.d.ts","sourceRoot":"","sources":["../../../src/core/query/filtering.ts"],"names":[],"mappings":"AAMA;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB,sEAGxB,GAAG,QAC4E,CAAC;AAEzF,eAAO,MAAM,qBAAqB,sEAGzB,GAAG,EAAE,GAAG,SAAS,QACoE,CAAC;AAE/F;;;;;;;;;GASG;AACH,eAAO,MAAM,yBAAyB,eACxB,MAAM,OAAO,EAAE,cACf,MAAM,qBAAqB,CAAC,YAAY,CAAC,UAC7C,MAAM,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,KAC5C,MAAM,OAAO,EA+Bf,CAAC"}

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

@@ -1,5 +1,4 @@
 export * from './query';
-export * from './decorate';
 export * from './filtering';
 export * from './sorting';
 export * from './paging';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/query/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/query/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC"}

package/dist/core/query/paging.d.ts

@@ -6,7 +6,7 @@
  *
  * @hidden
  */
-export declare const isSkipLimit: (json: Object) => json is Amity.SkipLimitPagination;
+export declare const isSkipLimit: (json: Record<string, unknown>) => json is Amity.SkipLimitPagination;
 /**
  * Type guard to find if the a given decoded backend token uses "after/before" pagination style
  *
@@ -15,16 +15,25 @@ export declare const isSkipLimit: (json: Object) => json is Amity.SkipLimitPagin
  *
  * @hidden
  */
-export declare const isAfterBefore: (json: Object) => json is Amity.AfterBeforePagination;
+export declare const isAfterBefore: (json: Record<string, unknown>) => json is Amity.AfterBeforePagination;
+/**
+ * Type guard to find if the a given decoded backend token uses v4 or newer "after/before" pagination style
+ *
+ * @param json any json object as extracted from the backend
+ * @returns success boolean if the token has either "after" or "before" props
+ *
+ * @hidden
+ */
+export declare const isAfterBeforeRaw: (json: Record<string, unknown>) => json is Amity.PageRaw;
 /**
  * Type guard to find if the a given object is wrapped around Amity.Paged<>
  *
  * @param payload any object as passed from query functions
- * @returns success boolean if the object is an array shaped as [Record<string, Amity.Syncable>, Amity.Pages]
+ * @returns success boolean if the object is an object shaped as { data: T[] } & Amity.Pages
  *
  * @hidden
  */
-export declare const isPaged: (payload: any) => payload is Amity.Paged<any>;
+export declare const isPaged: <T extends unknown>(payload: any) => payload is Amity.Paged<T, any>;
 /**
  * Converts a paging object into a b64 string token
  *
@@ -34,7 +43,7 @@ export declare const isPaged: (payload: any) => payload is Amity.Paged<any>;
  *
  * @hidden
  */
-export declare const toToken: (paging: Amity.Page | undefined, style: 'skiplimit' | 'afterbefore') => Amity.Token | undefined;
+export declare const toToken: (paging: Amity.Page | Amity.PageRaw | undefined, style: Amity.PaginationStyles) => Amity.Token | undefined;
 /**
  * Converts a b64 string token into a paging object
  *
@@ -43,16 +52,14 @@ export declare const toToken: (paging: Amity.Page | undefined, style: 'skiplimit
  *
  * @hidden
  */
-export declare const toPage: (token?: string | undefined) => Amity.Page | null;
+export declare const toPage: (token?: Amity.Token) => Amity.Page | undefined;
 /**
- * Slices a collection according to its paging
+ * Converts a b64 string token into a paging object
  *
- * @param type the type of collection (for unique id identification with after/before)
- * @param collection the collection to slice
- * @param paging the paging object
- * @returns the sliced collection according to the paging definition
+ * @param token the backend's b64 encoded token
+ * @returns a sdk-friendly paging object
  *
  * @hidden
  */
-export declare const sliceByPaging: <K extends keyof Amity.Model, T extends Amity.Model[K]>(type: K, collection: T[], page?: Amity.Page | undefined) => T[] | undefined;
+export declare const toPageRaw: (token?: Amity.Token) => Amity.PageRaw | undefined;
 //# sourceMappingURL=paging.d.ts.map

package/dist/core/query/paging.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"paging.d.ts","sourceRoot":"","sources":["../../../src/core/query/paging.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,SAAU,MAAM,sCAEvC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,SAAU,MAAM,wCAEzC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,YAAa,GAAG,gCAMnC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,WACV,MAAM,IAAI,GAAG,SAAS,SACvB,WAAW,GAAG,aAAa,KAEjC,MAAM,KAAK,GAAG,SAuChB,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM,kCAA0B,MAAM,IAAI,GAAG,IA0BzD,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,qIAsBzB,CAAA"}
+{"version":3,"file":"paging.d.ts","sourceRoot":"","sources":["../../../src/core/query/paging.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,SAAU,OAAO,MAAM,EAAE,OAAO,CAAC,sCACX,CAAC;AAE/C;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,SAAU,OAAO,MAAM,EAAE,OAAO,CAAC,wCACe,CAAC;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,SACrB,OAAO,MAAM,EAAE,OAAO,CAAC,0BAC6B,CAAC;AAE7D;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,+BAAgC,GAAG,mCAMtD,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,WACV,MAAM,IAAI,GAAG,MAAM,OAAO,GAAG,SAAS,SACvC,MAAM,gBAAgB,KAC5B,MAAM,KAAK,GAAG,SA0ChB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM,WAAY,MAAM,KAAK,KAAG,MAAM,IAAI,GAAG,SA4BzD,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,WAAY,MAAM,KAAK,KAAG,MAAM,OAAO,GAAG,SAW/D,CAAC"}

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

@@ -27,43 +27,33 @@ export declare const isMutator: <Args extends any[], Returned extends unknown>(f
  */
 export declare const isOffline: <Args extends any[], Returned extends unknown>(func: Amity.AsyncFunc<Args, Returned>) => func is Amity.OfflineFunc<Args, Returned>;
 /**
- * Type guard to check and cast that a given object has the "syncedAt" property
+ * Type guard to check and cast that a given object has the "cachedAt" property
  *
  * @param model any object to check on
- * @returns success boolean if the object has property "syncedAt"
+ * @returns success boolean if the object has property "cachedAt"
  *
  * @hidden
  */
-export declare const isSyncable: (model: any) => model is Amity.Syncable;
+export declare const isCachable: (model: any) => model is Amity.Cachable;
 /**
- * Checks if a model is considered local (syncedAt === -1)
+ * Checks if a model is considered local (cachedAt === -1)
  *
- * @param model any syncable object to check
+ * @param model any cachable object to check
  * @returns success boolean if the object is marked as local
  *
  * @hidden
  */
-export declare const isLocal: (model?: any) => model is Amity.Syncable;
+export declare const isLocal: (model?: any) => model is Amity.Local;
 /**
  * Checks if a model is considered fresh
  *
- * @param model any syncable object to check
+ * @param model any cachable object to check
  * @param lifeSpan the supposedly duration for which the object is considered synced
  * @returns success boolean if the object is below the given lifespan
  *
  * @hidden
  */
-export declare const isFresh: (model?: Amity.Syncable | undefined, lifeSpan?: number) => boolean;
-/**
- * Checks if a model is considered synced
- *
- * @param model any syncable object to check
- * @param lifeSpan the supposedly duration for which the object is considered synced
- * @returns success boolean if the object is local or below the given lifespan
- *
- * @hidden
- */
-export declare const isSynced: (model?: any, lifeSpan?: number) => boolean;
+export declare const isFresh: (model?: Amity.Cachable, lifeSpan?: number) => boolean;
 /**
  * ```js
  * import { createQuery, getUser } from '@amityco/ts-sdk'
@@ -74,7 +64,7 @@ export declare const isSynced: (model?: any, lifeSpan?: number) => boolean;
  * This wrapper is necessary to create for optimistically calls
  *
  *
- * @param fn A compatible API function from the ts sdk
+ * @param func A compatible API function from the ts sdk
  * @param args The arguments to pass to the function passed as `fn`
  * @returns A wrapper containing both the function and its future arguments
  *
@@ -115,7 +105,5 @@ export declare const queryOptions: (policy: Amity.QueryPolicy, lifeSpan?: number
  *
  * @category Query
  */
-export declare const runQuery: <Args extends any[], Returned extends unknown>({ func, args }: Amity.Query<Args, Returned>, callback?: ((args: ({
-    data?: undefined;
-} & Amity.QueryMetadata) | Amity.QueryResult<Returned>) => void) | undefined, options?: Amity.QueryOptions) => void;
+export declare const runQuery: <Args extends any[], Returned extends unknown>({ func, args }: Amity.Query<Args, Returned>, callback?: ((args: Amity.Snapshot<Returned>) => void) | undefined, options?: Amity.QueryOptions) => void;
 //# sourceMappingURL=query.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../../src/core/query/query.ts"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,oIAIrB,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,oIAIrB,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,oIAE4D,CAAA;AAElF;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,UAAW,GAAG,4BAEpC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,WAAY,GAAG,4BAElC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,kDAAsC,MAAM,YAE/D,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,WAAY,GAAG,aAAY,MAAM,YAErD,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,WAAW;;;CAGH,CAAA;AAGrB;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,WACf,MAAM,WAAW,aAAY,MAAM,KAC1C,MAAM,YAOR,CAAA;AAoED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,QAAQ;;2DAE2C,IAAI,yBACzD,MAAM,YAAY,SAwD5B,CAAA"}
+{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../../src/core/query/query.ts"],"names":[],"mappings":"AAMA;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,oIAE2C,CAAC;AAElE;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,oIAEkD,CAAC;AAEzE;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,oIAE4D,CAAC;AAEnF;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,UAAW,GAAG,4BACF,CAAC;AAEpC;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,WAAY,GAAG,yBAElC,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,WAAY,MAAM,QAAQ,+BAE7C,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,WAAW;;;CAGH,CAAC;AAEtB;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,WACf,MAAM,WAAW,aACf,MAAM,KACf,MAAM,YAIR,CAAC;AA2BF;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,QAAQ,8IAE4B,IAAI,yBAC1C,MAAM,YAAY,SA0F5B,CAAC"}

package/dist/core/query/sorting.d.ts

@@ -1,4 +1,4 @@
-declare type SortingFunc<T = Object> = (a: T, b: T) => number;
+declare type SortingFunc<T = Record<string, unknown>> = (a: T, b: T) => number;
 /**
  * Alphabetic sorting of objects having a displayName
  */

package/dist/core/query/sorting.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sorting.d.ts","sourceRoot":"","sources":["../../../src/core/query/sorting.ts"],"names":[],"mappings":"AAIA,aAAK,WAAW,CAAC,CAAC,GAAG,MAAM,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,MAAM,CAAA;AAErD;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,WAAW,CAAC;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAKlE,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,WAAW,CAAC;IAAE,cAAc,EAAE,MAAM,CAAA;CAAE,CAE/D,CAAA;AAEV;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,WAAW,CAAC;IAAE,aAAa,EAAE,MAAM,CAAA;CAAE,CAE7D,CAAA;AAEV;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,WAAW,CAAC;IAAE,SAAS,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,CAEhC,CAAA;AAElD;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,WAAW,CAAC;IAAE,SAAS,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,CAE/B,CAAA;AAElD;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,WAAW,CAAC;IAAE,YAAY,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,CAEnC,CAAA"}
+{"version":3,"file":"sorting.d.ts","sourceRoot":"","sources":["../../../src/core/query/sorting.ts"],"names":[],"mappings":"AAIA,aAAK,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,MAAM,CAAC;AAEvE;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,WAAW,CAAC;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAMlE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,WAAW,CAAC;IAAE,cAAc,EAAE,MAAM,CAAA;CAAE,CAG/D,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,WAAW,CAAC;IAAE,aAAa,EAAE,MAAM,CAAA;CAAE,CAG7D,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,WAAW,CAAC;IAAE,SAAS,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,CAGhC,CAAC;AAEnD;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,WAAW,CAAC;IAAE,SAAS,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,CAG/B,CAAC;AAEnD;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,WAAW,CAAC;IAAE,YAAY,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,CAGnC,CAAC"}

package/dist/core/subscription.d.ts

@@ -0,0 +1,18 @@
+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;
+/** @hidden */
+export declare const getNetworkTopic: () => 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;AAkBD,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,MAMtC,CAAC;AAEF,eAAO,MAAM,oBAAoB,QAAO,MAMvC,CAAC;AAEF,cAAc;AACd,eAAO,MAAM,eAAe,QAAO,MAMlC,CAAC;AAKF,wBAAgB,cAAc,CAC5B,KAAK,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC,GACzC,KAAK,CAAC,YAAY,CAapB"}

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/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":"AA4BA;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,aAAc,MAAM,kCA2BnD,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/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/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":"AAOA;;;;;;;;;;;;;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;IAwClD;;;;;;;;;;;;;SAaK;mBAEI,WAAW,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAC3C,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,SAAS;CAlBnD,CAAC"}

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":"AAIA;;;;;;;;;;;;;;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":"AAIA;;;;;;;;;;;;;;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":"AAIA;;;;;;;;;;;;;;;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":"AAIA;;;;;;;;;;;;;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":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,OAAO;6CACV,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAChC,QAAQ,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;IAkBpC;;;;;;;;;;;;OAYG;oBACwB,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,GAAG,SAAS;CAf1F,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/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