@amityco/ts-sdk 0.0.1-beta.2 → 0.0.1-beta.22

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;AACH,aAAK,SAAS,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,IAAI;KACzD,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM;CACtD,CAAC;AA0BF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,+EAAyD,CAAC"}

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":"AA8CA;;;;;GAKG;AACH,eAAO,MAAM,aAAa,UAAW,OAAO,MAAM,EAAE,OAAO,CAAC,kCAM3D,CAAC"}

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,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAEhC;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAqBtD,CAAC"}

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 = Record<string, unknown>>(collection: T[], key: keyof T, value: any) => T[];
+//# sourceMappingURL=filtering.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"filtering.d.ts","sourceRoot":"","sources":["../../../src/core/query/filtering.ts"],"names":[],"mappings":"AAIA;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB,sEAGxB,GAAG,QAC4E,CAAC"}

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,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC"}

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

@@ -0,0 +1,65 @@
+/**
+ * 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: Record<string, unknown>) => 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: 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 object shaped as { data: T[] } & Amity.Pages
+ *
+ * @hidden
+ */
+export declare const isPaged: <T extends unknown>(payload: any) => payload is Amity.Paged<T, any>;
+/**
+ * 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 | Amity.PageRaw | undefined, style: Amity.PaginationStyles) => 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 | 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 toPageRaw: (token?: string | undefined) => Amity.PageRaw | 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":"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,kCAA0B,MAAM,IAAI,GAAG,SA4BzD,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,kCAA0B,MAAM,OAAO,GAAG,SAW/D,CAAC"}

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>) => 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":"AAGA;;;;;;;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,oEAEnB,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,WAAW;;;CAGH,CAAC;AAEtB;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,WACf,MAAM,WAAW,aACf,MAAM,KACf,MAAM,YAKR,CAAC;AA4BF;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,QAAQ,8IAE4B,IAAI,yBAC1C,MAAM,YAAY,SA0D5B,CAAC"}

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

@@ -0,0 +1,39 @@
+declare type SortingFunc<T = Record<string, unknown>> = (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,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/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> | 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,0BAaxD,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,iBAAiB,cACpB,MAAM,MAAM,SACb,MAAM,uEAgBd,CAAC"}

package/dist/core/uuid.d.ts

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

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

@@ -0,0 +1 @@
+{"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,kBAAkB,CAAC,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

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

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

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

@@ -0,0 +1,37 @@
+/**
+ * ```js
+ * import { queryGlobalFeed } from '@amityco/ts-sdk'
+ * const posts = await queryGlobalFeed()
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.Post} objects
+ *
+ * @param query The query parameters
+ * @returns A page of {@link Amity.Post} objects
+ *
+ * @category Feed API
+ * @async
+ * */
+export declare const queryGlobalFeed: {
+    (query?: {
+        dataTypes?: ("video" | "image" | "file" | "liveStream")[] | undefined;
+        useCustomRanking?: boolean | undefined;
+        page?: Amity.Page | undefined;
+    } | undefined): 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

@@ -0,0 +1 @@
+{"version":3,"file":"queryGlobalFeed.d.ts","sourceRoot":"","sources":["../../../src/feed/api/queryGlobalFeed.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;KAaK;AACL,eAAO,MAAM,eAAe;;;;;oBAIxB,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

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { createFile } from '@amityco/ts-sdk'
+ * const created = await createFile(formData)
+ * ```
+ *
+ * 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.Cached<Amity.File[]>>;
+//# sourceMappingURL=createFile.d.ts.map

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

@@ -0,0 +1 @@
+{"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,17 @@
+/**
+ * ```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 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, 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;;;;;;;;;;;;;;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/deleteFile.d.ts

@@ -0,0 +1,18 @@
+/**
+ * ```js
+ * import { deleteFile } from '@amityco/ts-sdk'
+ * const success = await deleteFile('foo')
+ * ```
+ *
+ * Deletes a {@link Amity.File}
+ *
+ * @param fileId The {@link Amity.File} ID to delete
+ * @return A success boolean if the {@link Amity.File} was deleted
+ *
+ * @category File API
+ * @async
+ */
+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

@@ -0,0 +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,KAChC,QAAQ;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,CAU9B,CAAC"}

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

@@ -0,0 +1,9 @@
+/**
+ * Allow to query a file url with a selected size
+ *
+ * @param fileUrl the file Url to decorate
+ * @param size one of the selected sizes
+ * @returns the computed url for the selected size
+ */
+export declare const fileUrlWithSize: (fileUrl: Amity.File['fileUrl'], size: 'small' | 'medium' | 'large' | 'full') => string;
+//# sourceMappingURL=fileUrlWithSize.d.ts.map

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

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