@amityco/ts-sdk 0.0.1-beta.1 → 0.0.1-beta.13

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

@@ -0,0 +1,3 @@
+export declare const createCommunityEventSubscriber: (event: keyof Amity.MqttCommunityMessageEvents, callback: Amity.Listener<Amity.Community>) => Amity.Unsubscriber;
+export declare const createCommunityMemberEventSubscriber: (event: keyof Amity.MqttCommunityUserMessageEvents, callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void) => Amity.Unsubscriber;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/community/events/utils.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,8BAA8B,UAClC,MAAM,MAAM,0BAA0B,YACnC,MAAM,QAAQ,CAAC,MAAM,SAAS,CAAC,uBAuB1C,CAAA;AAsCD,eAAO,MAAM,oCAAoC,UACxC,MAAM,MAAM,8BAA8B,wBAC3B,MAAM,SAAS,UAAU,MAAM,UAAU,CAAC,WAAW,CAAC,KAAK,IAAI,uBA4BtF,CAAA"}

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

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

package/dist/community/observers/observeCommunity.d.ts

@@ -0,0 +1,18 @@
+/**
+ * ```js
+ * import { observeCommunity } from '@amityco/ts-sdk'
+ *
+ * let community = {}
+ * const dispose = observeCommunity(communityId, updated => community = updated)
+ * ```
+ *
+ * Observe all mutation on a given {@link Amity.Community}
+ *
+ * @param communityId the ID of the community to observe
+ * @param callback the function to call when new data are available
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the community
+ *
+ * @category Community Observer
+ */
+export declare const observeCommunity: <Events extends ["onFetch", "onUpdate", "onDelete", "onJoin", "onLeft", "onUserAdded", "onUserRemoved", "onUserBanned", "onUserUnbanned"]>(communityId: string, callback: Amity.ObjectListener<Amity.Snapshot<Amity.Community | undefined>, Events>) => Amity.Unsubscriber;
+//# sourceMappingURL=observeCommunity.d.ts.map

package/dist/community/observers/observeCommunity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"observeCommunity.d.ts","sourceRoot":"","sources":["../../../src/community/observers/observeCommunity.ts"],"names":[],"mappings":"AAiBA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,gBAAgB,0JACd,MAAM,0FAElB,MAAM,YAiDR,CAAA"}

package/dist/core/debug.d.ts

@@ -0,0 +1,15 @@
+import debug from 'debug';
+/**
+ * Creates a pre-configured logger instance
+ *
+ * @param session The name of the debug session
+ * @returns A pre-configured logger function
+ *
+ * @category Debug
+ * @hidden
+ */
+export declare const createLogger: (session?: string | undefined) => {
+    (topic: string, ...args: any[]): void;
+    __instance__: debug.Debugger;
+};
+//# sourceMappingURL=debug.d.ts.map

package/dist/core/device.d.ts

@@ -0,0 +1,7 @@
+/** @hidden */
+export declare const getDeviceId: () => string;
+/** @hidden */
+export declare const getDeviceModel: () => string;
+/** @hidden */
+export declare const getDeviceInfo: () => Amity.Device['deviceInfo'];
+//# sourceMappingURL=device.d.ts.map

package/dist/core/errors.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Generic ASC error
+ * @category Errors
+ */
+export declare class ASCError extends Error {
+    readonly code: Amity.ErrorCode;
+    readonly level: Amity.ErrorLevel;
+    readonly type: string;
+    readonly timestamp: number;
+    /**
+     * @param message A custom error message
+     * @param code A normalized error code
+     * @param level A normalized failure level descriptor
+     */
+    constructor(message: string, code: Amity.ErrorCode, level: Amity.ErrorLevel);
+}
+/**
+ * API level error
+ * @category Errors
+ */
+export declare class ASCApiError extends ASCError {
+    /**
+     * @param code A normalized error code
+     * @param level A normalized failure level descriptor
+     */
+    constructor(message: string, code: Amity.ErrorCode, level: Amity.ErrorLevel);
+}
+/**
+ * Unexpected error
+ * @category Errors
+ */
+export declare class ASCUnknownError extends ASCError {
+    /**
+     * @param code A normalized error code
+     * @param level A normalized failure level descriptor
+     */
+    constructor(code?: Amity.ErrorCode, level?: Amity.ErrorLevel);
+}
+/**
+ * Network related error
+ * @category Errors
+ */
+export declare class ASCConnectionError extends ASCError {
+    readonly event: string;
+    /**
+     * @param message A custom error message
+     */
+    constructor(event: string, message?: string);
+}
+/**
+ * Input sanitization related error
+ * @category Errors
+ */
+export declare class ASCInvalidParameterError extends ASCError {
+    /**
+     * @param message A custom error message
+     */
+    constructor(message: string);
+}
+//# sourceMappingURL=errors.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/core/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,qBAAa,QAAS,SAAQ,KAAK;aAWf,IAAI,EAAE,KAAK,CAAC,SAAS;aACrB,KAAK,EAAE,KAAK,CAAC,UAAU;IAXzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAQ;IAC7B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAa;IAEvC;;;;OAIG;gBAED,OAAO,EAAE,MAAM,EACC,IAAI,EAAE,KAAK,CAAC,SAAS,EACrB,KAAK,EAAE,KAAK,CAAC,UAAU;CAO1C;AAED;;;GAGG;AACH,qBAAa,WAAY,SAAQ,QAAQ;IACvC;;;OAGG;gBAED,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,KAAK,CAAC,SAAS,EACrB,KAAK,EAAE,KAAK,CAAC,UAAU;CAI1B;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;IAC3C;;;OAGG;gBAED,IAAI,GAAE,KAAK,CAAC,SAA2C,EACvD,KAAK,GAAE,KAAK,CAAC,UAAmC;CAInD;AAED;;;GAGG;AACH,qBAAa,kBAAmB,SAAQ,QAAQ;aAK5B,KAAK,EAAE,MAAM;IAJ/B;;OAEG;gBAEe,KAAK,EAAE,MAAM,EAC7B,OAAO,GAAE,MAAiD;CAQ7D;AAED;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,QAAQ;IACpD;;OAEG;gBACS,OAAO,EAAE,MAAM;CAG5B"}

package/dist/core/events.d.ts

@@ -0,0 +1,35 @@
+/** @hidden */
+export declare const createEventEmitter: () => import("mitt").Emitter<Amity.Events>;
+/**
+ * Wraps the websocket events into the client's event emitter for
+ * abstraction of transport.
+ *
+ * @param ws A websocket connection to listen from
+ * @param emitter An event emitter to wire the events to
+ *
+ * @category Transport
+ * @hidden
+ */
+export declare const proxyWebsocketEvents: (ws: Amity.Client['ws'], emitter: Amity.Client['emitter']) => void;
+export declare const proxyMqttEvents: (mqttClient: Amity.Client['mqtt'], emitter: Amity.Client['emitter']) => void;
+/**
+ * Standardize the subscription of SSE through web sockets
+ *
+ * @param client The current client for which to subscribe the event to
+ * @param namespace A unique name for the logger
+ * @param event The websocket event name
+ * @param fn A wrapper for the callback.
+ * @returns A dispose function to unsubscribe to the event
+ *
+ * @category Transport
+ * @hidden
+ */
+export declare const createEventSubscriber: <T extends "disconnected" | "error" | "connect_error" | "reconnect_error" | "reconnect_failed" | "v3.channel.didUpdate" | "v3.channel.didJoin" | "v3.channel.didLeave" | "v3.channel.didAddUsers" | "v3.channel.didRemoveUsers" | "v3.channel.didBan" | "v3.channel.didUnban" | "v3.message.didCreate" | "v3.message.didUpdate" | "v3.message.didDelete" | "connect" | "message" | "disconnect" | "close" | "end" | "reconnect" | "v3.channel.didCreate" | "v3.channel.didDelete" | "video-streaming.didRecord" | "video-streaming.didStart" | "video-streaming.didStop" | "community.created" | "community.updated" | "community.deleted" | "community.joined" | "community.left" | "community.userAdded" | "community.userRemoved" | "community.userBanned" | "community.userUnbanned" | "post.created" | "post.updated" | "post.deleted" | "post.approved" | "post.declined" | "post.flagged" | "post.unflagged" | "post.addReaction" | "post.removeReaction" | "comment.created" | "comment.updated" | "comment.deleted" | "comment.flagged" | "comment.unflagged" | "comment.addReaction" | "comment.removeReaction" | "user.updated" | "user.flagged" | "user.unflagged" | "user.flagCleared">(client: Amity.Client, namespace: string, event: T, fn: Amity.Listener<Amity.Events[T]>) => Amity.Unsubscriber;
+export declare const createMqttMessageSubscriber: <T extends "disconnected" | "error" | "connect_error" | "reconnect_error" | "reconnect_failed" | "v3.channel.didUpdate" | "v3.channel.didJoin" | "v3.channel.didLeave" | "v3.channel.didAddUsers" | "v3.channel.didRemoveUsers" | "v3.channel.didBan" | "v3.channel.didUnban" | "v3.message.didCreate" | "v3.message.didUpdate" | "v3.message.didDelete" | "connect" | "message" | "disconnect" | "close" | "end" | "reconnect" | "v3.channel.didCreate" | "v3.channel.didDelete" | "video-streaming.didRecord" | "video-streaming.didStart" | "video-streaming.didStop" | "community.created" | "community.updated" | "community.deleted" | "community.joined" | "community.left" | "community.userAdded" | "community.userRemoved" | "community.userBanned" | "community.userUnbanned" | "post.created" | "post.updated" | "post.deleted" | "post.approved" | "post.declined" | "post.flagged" | "post.unflagged" | "post.addReaction" | "post.removeReaction" | "comment.created" | "comment.updated" | "comment.deleted" | "comment.flagged" | "comment.unflagged" | "comment.addReaction" | "comment.removeReaction" | "user.updated" | "user.flagged" | "user.unflagged" | "user.flagCleared">(client: Amity.Client, namespace: string, event: string, fn: (params: Object) => void) => Amity.Unsubscriber;
+/**
+ * Wrapper around dispatch event
+ *
+ * @hidden
+ */
+export declare const fireEvent: <T extends "disconnected" | "error" | "connect_error" | "reconnect_error" | "reconnect_failed" | "v3.channel.didUpdate" | "v3.channel.didJoin" | "v3.channel.didLeave" | "v3.channel.didAddUsers" | "v3.channel.didRemoveUsers" | "v3.channel.didBan" | "v3.channel.didUnban" | "v3.message.didCreate" | "v3.message.didUpdate" | "v3.message.didDelete" | "connect" | "message" | "disconnect" | "close" | "end" | "reconnect" | "v3.channel.didCreate" | "v3.channel.didDelete" | "video-streaming.didRecord" | "video-streaming.didStart" | "video-streaming.didStop" | "community.created" | "community.updated" | "community.deleted" | "community.joined" | "community.left" | "community.userAdded" | "community.userRemoved" | "community.userBanned" | "community.userUnbanned" | "post.created" | "post.updated" | "post.deleted" | "post.approved" | "post.declined" | "post.flagged" | "post.unflagged" | "post.addReaction" | "post.removeReaction" | "comment.created" | "comment.updated" | "comment.deleted" | "comment.flagged" | "comment.unflagged" | "comment.addReaction" | "comment.removeReaction" | "user.updated" | "user.flagged" | "user.unflagged" | "user.flagCleared">(event: T, payload: Amity.Events[T]) => void;
+//# sourceMappingURL=events.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/core/events.ts"],"names":[],"mappings":"AAoCA,cAAc;AACd,eAAO,MAAM,kBAAkB,4CAE9B,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB,OAAQ,MAAM,MAAM,CAAC,IAAI,CAAC,WAAW,MAAM,MAAM,CAAC,SAAS,CAAC,SAI5F,CAAA;AAED,eAAO,MAAM,eAAe,eAAgB,MAAM,MAAM,CAAC,MAAM,CAAC,WAAW,MAAM,MAAM,CAAC,SAAS,CAAC,SAWjG,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,qBAAqB,+oCACxB,MAAM,MAAM,aACT,MAAM,oDAGhB,MAAM,YAiBR,CAAA;AAED,eAAO,MAAM,2BAA2B,+oCAC9B,MAAM,MAAM,aACT,MAAM,SACV,MAAM,eACA,MAAM,KAAK,IAAI,KAC3B,MAAM,YAaR,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,SAAS,krCAMrB,CAAA"}

package/dist/core/model/idResolvers.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Manually computed type which links each key with a function
+ * used to return the object's unique id. The type is computed
+ * to avoid using any and give some typing security at the
+ * resolver's level.
+ */
+declare type Resolvers<T extends Amity.Domain[] = Amity.Domain[]> = {
+    [K in T[number]]: (model: Amity.Minimal[K]) => string;
+};
+/**
+ * Retrieve the id resolver matching a domain name
+ *
+ * @param name the domain name for the resolve
+ * @returns an idResolver function for the given domain name
+ */
+export declare const getResolver: <T extends keyof Amity.Model>(name: T) => Resolvers<(keyof Amity.Model)[]>[T];
+export {};
+//# sourceMappingURL=idResolvers.d.ts.map

package/dist/core/model/idResolvers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"idResolvers.d.ts","sourceRoot":"","sources":["../../../src/core/model/idResolvers.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACF,aAAK,SAAS,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,IAAI;KAC1D,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM;CACtD,CAAA;AAoBD;;;;;GAKG;AACF,eAAO,MAAM,WAAW,+EAExB,CAAA"}

package/dist/core/model/identifyModel.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Finds the name of the store for a given unknown model
+ *
+ * @param model one of the {@link Amity.Model} to identify
+ * @returns the name of the corresponding store
+ */
+export declare const identifyModel: (model: Record<string, unknown>) => keyof Amity.Model | undefined;
+//# sourceMappingURL=identifyModel.d.ts.map

package/dist/core/model/identifyModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identifyModel.d.ts","sourceRoot":"","sources":["../../../src/core/model/identifyModel.ts"],"names":[],"mappings":"AAyCA;;;;;GAKG;AACH,eAAO,MAAM,aAAa,UAAW,OAAO,MAAM,EAAE,OAAO,CAAC,kCAK3D,CAAA"}

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

@@ -0,0 +1,8 @@
+export * from './idResolvers';
+export * from './identifyModel';
+/**
+ * A map of v3 response keys to a store name.
+ * @hidden
+ */
+export declare const PAYLOAD2MODEL: Record<string, Amity.Domain>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/model/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAE/B;;;GAGG;AACF,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAevD,CAAA"}

package/dist/core/network.d.ts

@@ -0,0 +1,11 @@
+export declare const API_ENDPOINT: {
+    readonly EU: "eu";
+    readonly SG: "sg";
+    readonly US: "us";
+};
+export declare enum UrlTemplate {
+    HTTP = "https://api.{region}.amity.co",
+    MQTT = "wss://sse.{region}.amity.co:443/mqtt"
+}
+export declare const getUrlFromTemplate: (template: UrlTemplate, region: string) => string;
+//# sourceMappingURL=network.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"network.d.ts","sourceRoot":"","sources":["../../src/core/network.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY;;;;CAIf,CAAA;AAEV,oBAAY,WAAW;IACrB,IAAI,kCAAkC;IACtC,IAAI,yCAAyC;CAC9C;AAED,eAAO,MAAM,kBAAkB,aAAe,WAAW,UAAU,MAAM,WAExE,CAAA"}

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

@@ -0,0 +1,12 @@
+/**
+ * Filter a given collection with strict equality against a param
+ *
+ * @param collection the collection to filter
+ * @param key the key of the collection's items to challenge
+ * @param value the expected value
+ * @returns a filtered collection with items only matching the criteria
+ *
+ * @hidden
+ */
+export declare const filterByPropEquality: <T = {}>(collection: T[], key: keyof T, value: any) => T[];
+//# sourceMappingURL=filtering.d.ts.map

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

@@ -0,0 +1,5 @@
+export * from './query';
+export * from './filtering';
+export * from './sorting';
+export * from './paging';
+//# sourceMappingURL=index.d.ts.map

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

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

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

@@ -0,0 +1,76 @@
+/**
+ * Type guard to find if the a given decoded backend token uses "skip/limit" pagination style
+ *
+ * @param json any json object as extracted from the backend
+ * @returns success boolean if the token has either "skip" or "limit" props
+ *
+ * @hidden
+ */
+export declare const isSkipLimit: (json: Object) => json is Amity.SkipLimitPagination;
+/**
+ * Type guard to find if the a given decoded backend token uses "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 isAfterBefore: (json: Object) => 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: Object) => json is Amity.AfterBeforeRawPagination;
+/**
+ * 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 object shaped as { data: T[] } & Amity.Pages
+ *
+ * @hidden
+ */
+export declare const isPaged: <T extends unknown>(payload: any) => payload is Amity.Paged<T>;
+/**
+ * Converts a paging object into a b64 string token
+ *
+ * @param paging the sdk-friendly paging object
+ * @param style the style of token to produce
+ * @returns a backend's b64 encoded token
+ *
+ * @hidden
+ */
+export declare const toToken: (paging: Amity.Page | undefined, style: 'skiplimit' | 'afterbefore' | 'afterbeforeraw') => Amity.Token | undefined;
+/**
+ * Converts a b64 string token into a paging object
+ *
+ * @param token the backend's b64 encoded token
+ * @returns a sdk-friendly paging object
+ *
+ * @hidden
+ */
+export declare const toPage: (token?: string | undefined) => Amity.Page | null;
+/**
+ * Converts a b64 string token into a paging object
+ *
+ * @param token the backend's b64 encoded token
+ * @returns a sdk-friendly paging object
+ *
+ * @hidden
+ */
+export declare const toPageRaw: (token?: string | undefined) => Amity.PageRaw | null;
+/**
+ * Slices a collection according to its paging
+ *
+ * @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
+ *
+ * @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;
+//# sourceMappingURL=paging.d.ts.map

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

@@ -0,0 +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,gBAAgB,SAAU,MAAM,2CAE5C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,+BAAgC,GAAG,8BAMtD,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,WACV,MAAM,IAAI,GAAG,SAAS,SACvB,WAAW,GAAG,aAAa,GAAG,gBAAgB,KAEpD,MAAM,KAAK,GAAG,SA8ChB,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM,kCAA0B,MAAM,IAAI,GAAG,IA0BzD,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,kCAA0B,MAAM,OAAO,GAAG,IAW/D,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,qIAsBzB,CAAA"}

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

@@ -0,0 +1,109 @@
+/**
+ * Type guard to check and cast that a given async function is has the ".locally" property
+ *
+ * @param func any SDK APi function
+ * @returns success boolean if the function has a 'locally' twin
+ *
+ * @hidden
+ */
+export declare const isFetcher: <Args extends any[], Returned extends unknown>(func: Amity.AsyncFunc<Args, Returned>) => func is Amity.FetcherFunc<Args, Returned>;
+/**
+ * Type guard to check and cast that a given async function is has the ".optimistically" property
+ *
+ * @param func any SDK APi function
+ * @returns success boolean if the function has an 'optimistically' twin
+ *
+ * @hidden
+ */
+export declare const isMutator: <Args extends any[], Returned extends unknown>(func: Amity.AsyncFunc<Args, Returned>) => func is Amity.MutatorFunc<Args, Returned>;
+/**
+ * Type guard to check and cast that a given async function is has
+ * the ".locally" or ".optimistically" property
+ *
+ * @param func any SDK APi function
+ * @returns success boolean if the function has an offline twin
+ *
+ * @hidden
+ */
+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 "cachedAt" property
+ *
+ * @param model any object to check on
+ * @returns success boolean if the object has property "cachedAt"
+ *
+ * @hidden
+ */
+export declare const isCachable: (model: any) => model is Amity.Cachable;
+/**
+ * Checks if a model is considered local (cachedAt === -1)
+ *
+ * @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.Local;
+/**
+ * Checks if a model is considered fresh
+ *
+ * @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.Cachable | undefined, lifeSpan?: number) => boolean;
+/**
+ * ```js
+ * import { createQuery, getUser } from '@amityco/ts-sdk'
+ * const query = createQuery(getUser, 'foobar')
+ * ```
+ *
+ * Creates a wrapper for the API call you wish to call.
+ * This wrapper is necessary to create for optimistically calls
+ *
+ *
+ * @param fn 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
+ *
+ * @category Query
+ */
+export declare const createQuery: <Args extends any[], Returned extends unknown>(func: Amity.AsyncFunc<Args, Returned> | Amity.OfflineFunc<Args, Returned>, ...args: Args) => {
+    func: Amity.AsyncFunc<Args, Returned> | Amity.OfflineFunc<Args, Returned>;
+    args: Args;
+};
+/**
+ * ```js
+ * import { queryOptions } from '@amityco/ts-sdk'
+ * const options = queryOptions('no_fetch', lifeSpan)
+ * ```
+ *
+ * Creates a query options object based on the query policy passed
+ *
+ * @param policy The policy to apply to a query
+ * @returns A properly set query options object
+ *
+ * @category Query
+ */
+export declare const queryOptions: (policy: Amity.QueryPolicy, lifeSpan?: number) => Amity.QueryOptions;
+/**
+ * ```js
+ * import { createQuery, getUser, runQuery } from '@amityco/ts-sdk'
+ * const query = createQuery(getUser, client, 'foobar')
+ * runQuery(query,  user => console.log(user))
+ * ```
+ *
+ * Calls an API function wrapped around a Amity.Query, and executes the callback whenever
+ * a value is available. The value can be picked either from the local cache and/or
+ * from the server afterwards depending on the query options passed
+ *
+ * @param query A query object wrapping the call to be made
+ * @param callback A function to execute when a value is available
+ * @param options the query options
+ *
+ * @category Query
+ */
+export declare const runQuery: <Args extends any[], Returned extends unknown>({ func, args }: Amity.Query<Args, Returned>, callback?: ((args: Amity.Snapshot<Returned | undefined>) => void) | undefined, options?: Amity.QueryOptions) => void;
+//# sourceMappingURL=query.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../../src/core/query/query.ts"],"names":[],"mappings":"AAEA;;;;;;;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,yBAElC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,kDAAsC,MAAM,YAE/D,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,WAAW;;;CAGH,CAAA;AAGrB;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,WACf,MAAM,WAAW,aAAY,MAAM,KAC1C,MAAM,YAOR,CAAA;AA6BD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,QAAQ,0JAEwC,IAAI,yBACtD,MAAM,YAAY,SAyD5B,CAAA"}

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

@@ -0,0 +1,39 @@
+declare type SortingFunc<T = Object> = (a: T, b: T) => number;
+/**
+ * Alphabetic sorting of objects having a displayName
+ */
+export declare const sortByDisplayName: SortingFunc<{
+    displayName: string;
+}>;
+/**
+ * Sorting a collection by their apparition order (oldest first)
+ */
+export declare const sortByChannelSegment: SortingFunc<{
+    channelSegment: number;
+}>;
+/**
+ * Sorting a collection by their apparition order (oldest first)
+ */
+export declare const sortBySegmentNumber: SortingFunc<{
+    segmentNumber: number;
+}>;
+/**
+ * Sorting a collection by its oldest items
+ */
+export declare const sortByFirstCreated: SortingFunc<{
+    createdAt: Date | number | string;
+}>;
+/**
+ * Sorting a collection by its newest items
+ */
+export declare const sortByLastCreated: SortingFunc<{
+    createdAt: Date | number | string;
+}>;
+/**
+ * Sorting a collection by the items with most recent activity
+ */
+export declare const sortByLastActivity: SortingFunc<{
+    lastActivity: Date | number | string;
+}>;
+export {};
+//# sourceMappingURL=sorting.d.ts.map

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

@@ -0,0 +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"}

package/dist/core/subscription.d.ts

@@ -0,0 +1,14 @@
+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 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,CAAA;AAGxC,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,MACqC,CAAA;AAExC,eAAO,MAAM,YAAY,aACb,MAAM,YAAY,UACrB,QAAQ,kBAAkB,EAAE,mBAAmB,SAAS,CAAC,KAC/D,MACqC,CAAA;AAExC,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;AAKF,wBAAgB,cAAc,CAC5B,KAAK,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC,GACzC,KAAK,CAAC,YAAY,CAYpB"}

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":"AA0BA;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,aAAc,MAAM,kCA2BnD,CAAA"}

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":"AAAA,OAAa,EAAE,UAAU,EAAE,cAAc,EAAsB,MAAM,gBAAgB,CAAA;AAcrF,wBAAgB,cAAc,CAAC,MAAM,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,cAAc,CAgBhH;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,aAAc,MAAM,KAAG,gBAmGtD,CAAA"}

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,uCAWzB,CAAA"}

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?: Object | undefined) => 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,0BAcxD,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,iBAAiB,cACpB,MAAM,MAAM,SACb,MAAM,sDAgBd,CAAA"}

package/dist/core/uuid.d.ts

@@ -0,0 +1,2 @@
+export declare const uuid: () => string;
+//# sourceMappingURL=uuid.d.ts.map