@amityco/ts-sdk-react-native 6.22.1-cbca8f1.0 → 6.23.1-d8b4c4c.0

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

@@ -0,0 +1,72 @@
+/**
+ * Type guard to find if the a given decoded backend token uses "skip" 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 isSkip: (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 {
+    data: T[];
+} & Amity.Pages<any> & {
+    paging?: {
+        previous?: string | undefined;
+        next?: string | undefined;
+    } | undefined;
+};
+/**
+ * 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?: Amity.Token) => 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?: Amity.Token) => 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,MAAM,SAAU,OAAO,MAAM,EAAE,OAAO,CAAC,sCACf,CAAC;AAEtC;;;;;;;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,+BACT,GAAG;;;;;;;CAOb,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,WACV,MAAM,IAAI,GAAG,MAAM,OAAO,GAAG,SAAS,SACvC,MAAM,gBAAgB,KAC5B,MAAM,KAAK,GAAG,SA6ChB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM,WAAY,MAAM,KAAK,KAAG,MAAM,IAAI,GAAG,SA6BzD,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,WAAY,MAAM,KAAK,KAAG,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, lifeSpan?: number) => boolean;
+/**
+ * ```js
+ * import { createQuery, getUser } from '@amityco/ts-sdk-react-native'
+ * 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 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
+ *
+ * @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-react-native'
+ * 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-react-native'
+ * 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":"AAIA;;;;;;;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,SAyD5B,CAAC"}

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

@@ -0,0 +1,65 @@
+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;
+}>;
+/**
+ * Alphabetic sorting of objects having a name
+ */
+export declare const sortByName: SortingFunc<{
+    name?: 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 story-collection by its localSortingDate
+ */
+export declare const sortByLocalSortingDate: SortingFunc<{
+    localSortingDate: Date | number | string;
+}>;
+/**
+ * Sorting a collection by its newest items
+ */
+export declare const sortByLastCreated: SortingFunc<{
+    createdAt: Date | number | string;
+}>;
+/**
+ * Sorting a collection by its oldest items
+ * -- Due to Amity.UpdatedAt is an optional type, we need to define a default value to 0 to prevent error
+ */
+export declare const sortByFirstUpdated: SortingFunc<{
+    updatedAt?: Date | number | string;
+}>;
+/**
+ * Sorting a collection by its newest items
+ * -- Due to Amity.UpdatedAt is an optional type, we need to define a default value to 0 to prevent error
+ */
+export declare const sortByLastUpdated: SortingFunc<{
+    updatedAt?: 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,CAAC,EAAE,MAAM,CAAA;CAAE,CAMnE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,EAAE,WAAW,CAAC;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAGrD,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,sBAAsB,EAAE,WAAW,CAAC;IAC/C,gBAAgB,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAC;CAC1C,CAC8C,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,WAAW,CAAC;IAAE,SAAS,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,CAG/B,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,WAAW,CAAC;IAAE,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,CAGjC,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,WAAW,CAAC;IAAE,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,CAGhC,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/query/tests/filtering.test.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/dist/core/subscription.d.ts

@@ -0,0 +1,47 @@
+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 getStoryTopic: ({ targetId, targetType, storyId, }: Pick<Amity.Story, 'targetId' | 'targetType' | 'storyId'>) => string;
+export declare const getCommunityStoriesTopic: ({ targetId, targetType, }: Pick<Amity.Story, 'targetId' | 'targetType'>) => string;
+export declare const getMyFollowersTopic: () => string;
+export declare const getMyFollowingsTopic: () => string;
+export declare const getChannelTopic: (channel: Amity.Subscribable) => string;
+export declare const getSubChannelTopic: (subChannel: Amity.Subscribable) => string;
+export declare const getMessageTopic: (message: Amity.Subscribable) => string;
+export declare const getMarkedMessageTopic: ({ channelId, subChannelId, }: Pick<Amity.SubChannel, 'channelId' | 'subChannelId'>) => string;
+export declare const getMarkerUserFeedTopic: () => string;
+/**
+ * @hidden
+ *
+ * Create a topic to subscribe to network level events like 'user is deleted from the network'
+ */
+export declare const getNetworkTopic: () => string;
+/**
+ * @hidden
+ *
+ * Create a topic to subscribe to channel events for 'conversation', 'community' channel
+ */
+export declare const getSmartFeedChannelTopic: () => string;
+/**
+ * @hidden
+ *
+ * Create a topic to subscribe to sub channel events for 'conversation', 'community' channel
+ */
+export declare const getSmartFeedSubChannelTopic: () => string;
+/**
+ * @hidden
+ *
+ * Create a topic to subscribe to message events for 'conversation', 'community' channel
+ */
+export declare const getSmartFeedMessageTopic: () => string;
+export declare function subscribeTopic(topic: string, callback?: Amity.Listener<ASCError | void>): Amity.Unsubscriber;
+//# sourceMappingURL=subscription.d.ts.map

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

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

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

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

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

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

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

@@ -0,0 +1,16 @@
+export declare enum RequestCancelation {
+    UserDeleted = "User Deleted",
+    UserGlobalBanned = "User Global Banned",
+    TokenExpired = "Token Expired"
+}
+/**
+ * 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":"AAcA,oBAAY,kBAAkB;IAC5B,WAAW,iBAAiB;IAC5B,gBAAgB,uBAAuB;IACvC,YAAY,kBAAkB;CAC/B;AAmDD;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,aAAc,MAAM,kCAqFnD,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 { IClientOptions, MqttClient } 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,cAAc,EAAsB,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAgBtF,wBAAgB,cAAc,CAAC,MAAM,EAAE;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,GAAG,cAAc,CAiBjB;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,aAAc,MAAM,KAAG,gBAiHtD,CAAC"}

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

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

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

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

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

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

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

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

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

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

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

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

package/dist/core/uuid.d.ts

@@ -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.InternalUser['userId'];
+    displayName?: Amity.InternalUser['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,YAAY,CAAC,QAAQ,CAAC,CAAC;IACrC,WAAW,CAAC,EAAE,MAAM,YAAY,CAAC,aAAa,CAAC,CAAC;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;;EAiBF,CAAC"}

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

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

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

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

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

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

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

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

package/dist/feedRepository/api/getCustomRankingGlobalFeed.d.ts

@@ -0,0 +1,70 @@
+/**
+ * ```js
+ * import { FeedRepository } from '@amityco/ts-sdk-react-native'
+ * const posts = await FeedRepository.getCustomRankingGlobalFeed()
+ * ```
+ *
+ * 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 getCustomRankingGlobalFeed: {
+    (query?: {
+        dataTypes?: ('video' | 'image' | 'file' | 'liveStream')[];
+        /**
+         * @deprecated please use queryToken to query next pages or previous pages
+         * The first page result includes previous token and next token in paging field
+         * use this token as the queryToken to query next pages or previous pages
+         *
+         */
+        page?: Amity.Page;
+        limit?: number;
+        queryToken?: string;
+    }): Promise<Omit<{
+        data: Amity.Post<any>[];
+    } & Amity.Pages<Amity.Page<number>> & {
+        cachedAt: number | undefined;
+    } & Amity.Pagination, "nextPage" | "prevPage"> & {
+        /**
+         * @deprecated use `paging.next` value as queryToken instead
+         */
+        nextPage?: Amity.Page<number> | undefined;
+        /**
+         * @deprecated use `paging.previous` value as queryToken instead
+         */
+        prevPage?: Amity.Page<number> | undefined;
+    }>;
+    /**
+     * ```js
+     * import { FeedRepository } from '@amityco/ts-sdk-react-native'
+     * const posts = await FeedRepository.getCustomRankingGlobalFeed.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 getCustomRankingGlobalFeed>[0]): (Omit<{
+        data: Amity.Post<any>[];
+    } & Amity.Pages<Amity.Page<number>> & {
+        cachedAt: number | undefined;
+    } & Amity.Pagination, "nextPage" | "prevPage"> & {
+        /**
+         * @deprecated use `paging.next` value as queryToken instead
+         */
+        nextPage?: Amity.Page<number> | undefined;
+        /**
+         * @deprecated use `paging.previous` value as queryToken instead
+         */
+        prevPage?: Amity.Page<number> | undefined;
+    }) | undefined;
+};
+//# sourceMappingURL=getCustomRankingGlobalFeed.d.ts.map

package/dist/feedRepository/api/getCustomRankingGlobalFeed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCustomRankingGlobalFeed.d.ts","sourceRoot":"","sources":["../../../src/feedRepository/api/getCustomRankingGlobalFeed.ts"],"names":[],"mappings":"AAYA;;;;;;;;;;;;;KAaK;AACL,eAAO,MAAM,0BAA0B;aAAkB;QACvD,SAAS,CAAC,EAAE,CAAC,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,YAAY,CAAC,EAAE,CAAC;QAC1D;;;;;WAKG;QACH,IAAI,CAAC,EAAE,MAAM,IAAI,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;;;;;QAEG;;WAEG;;QAEH;;WAEG;;;IAyDP;;;;;;;;;;;;;SAaK;oBAEK,WAAW,iCAAiC,CAAC,CAAC,CAAC,CAAC;;;;;QAGpD;;WAEG;;QAEH;;WAEG;;;CA3BR,CAAC"}

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

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

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

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