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

package/dist/cache/api/mergeInCache.d.ts

@@ -0,0 +1,20 @@
+/**
+ * ```js
+ * import { mergeInCache } from '@amityco/ts-sdk'
+ *
+ * mergeInCache(
+ *   ["foo", "bar"],
+ *   (oldVal) => ({ ...oldVal, ...newVal }).
+ * )
+ * ```
+ *
+ * Merges a new {@link Amity.Cache} object to an {@link Amity.Client} instance
+ *
+ * @param key the key matching the object to retrieve from cache
+ * @param mutation either a plain object to shallow merge, or a function.
+ * @returns a success boolean if the object was updated
+ *
+ * @category Cache API
+ */
+export declare const mergeInCache: <T extends Record<string, unknown>>(key: Amity.CacheKey, mutation: Partial<T> | ((oldVal: T) => T), options?: Amity.CacheOptions | undefined) => boolean;
+//# sourceMappingURL=mergeInCache.d.ts.map

package/dist/cache/api/mergeInCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergeInCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/mergeInCache.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,YAAY,mJAItB,OAeF,CAAC"}

package/dist/cache/api/pullFromCache.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { pullFromCache } from '@amityco/ts-sdk'
+ * const user = pullFromCache<Amity.User>(["user", "foobar"])
+ * ```
+ *
+ * Retrieves a {@link Amity.CacheEntry} object matching a given
+ * {@link Amity.CacheKey}. The cache entry is not typed, so the
+ * expected returned type must be passed manually.
+ *
+ * @param key the key matching the object to retrieve from cache
+ * @returns the matching cache entry, or undefined.
+ *
+ * @category Cache API
+ */
+export declare const pullFromCache: <T extends unknown>(key: Amity.CacheKey) => Amity.CacheEntry<T> | undefined;
+//# sourceMappingURL=pullFromCache.d.ts.map

package/dist/cache/api/pullFromCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pullFromCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/pullFromCache.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,6EAWzB,CAAC"}

package/dist/cache/api/pushToCache.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { pushToCache } from '@amityco/ts-sdk'
+ * pushToCache<Amity.User>(["user", "foobar"], user)
+ * ```
+ *
+ * Saves any provided value as {@link Amity.CacheEntry} for the matching {@link Amity.CacheKey}
+ *
+ * @param key the key to save the object to
+ * @param data the object to save
+ * @param options customisation object around cache behavior (default gives a 2mn lifespan)
+ * @returns a success boolean if the object was saved in cache
+ *
+ * @category Cache API
+ */
+export declare const pushToCache: (key: Amity.CacheKey, data: unknown, options?: Amity.CacheOptions) => boolean;
+//# sourceMappingURL=pushToCache.d.ts.map

package/dist/cache/api/pushToCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pushToCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/pushToCache.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,WAAW,8BAEhB,OAAO,YACJ,MAAM,YAAY,KAC1B,OAkBF,CAAC"}

package/dist/cache/api/queryCache.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { queryCache } from '@amityco/ts-sdk'
+ * const entries = queryCache(["user"])
+ * ```
+ *
+ * Retrieves a list of {@link Amity.CacheEntry} objects matching a
+ * partial {@link Amity.CacheKey}. The cache entries can't be typed,
+ * but the expected returned type can be passed manually.
+ *
+ * @param partialKey the partial key matching the objects to retrieve from cache
+ * @returns the matching cache entries, or empty array.
+ *
+ * @category Cache API
+ */
+export declare const queryCache: <T extends unknown>(key: Amity.CacheKey) => Amity.CacheEntry<T>[] | undefined;
+//# sourceMappingURL=queryCache.d.ts.map

package/dist/cache/api/queryCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/queryCache.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU,+EActB,CAAC"}

package/dist/cache/api/restoreCache.d.ts

@@ -0,0 +1,22 @@
+/**
+ * ```js
+ * import { restoreCache } from '@amityco/ts-sdk'
+ * const success = await restoreCache()
+ * ```
+ *
+ * Reads a previously saved {@link Amity.Cache} from a persistent storage,
+ * and inserts it into the current {@link Amity.Cache} instance.
+ *
+ * The strategy for persistent storage will depend on the runtime,
+ * which is supported by @react-native-async-storage/async-storage.
+ *
+ * The current userId will be appended to the given storageKey to ensures
+ * the cached data concerns only the current user.
+ *
+ * @param storageKey the name of the persistent storage
+ * @returns a success boolean if the cache was dumped to persistent storage
+ *
+ * @category Cache API
+ */
+export declare const restoreCache: (storageKey?: string) => Promise<boolean>;
+//# sourceMappingURL=restoreCache.d.ts.map

package/dist/cache/api/restoreCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"restoreCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/restoreCache.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,YAAY,2CAmBxB,CAAC"}

package/dist/cache/api/snipeIdFromCollection.d.ts

@@ -0,0 +1,18 @@
+/**
+ * ```js
+ * import { snipeFromCollection } from '@amityco/ts-sdk'
+ * const user = snipeFromCollection("user", "foobar")
+ * ```
+ *
+ * Removes a {@link Amity.Model} object from  matching a given
+ * {@link Amity.CacheKey}. The cache entry is not typed, so the
+ * expected returned type must be passed manually.
+ *
+ * @param domain the key matching the object to retrieve from cache
+ * @param id the key matching the object to retrieve from cache
+ * @returns a success boolean if the id was removed from all matching collections
+ *
+ * @category Cache API
+ */
+export declare const snipeIdFromCollections: (domain: Amity.Domain, id: string) => boolean;
+//# sourceMappingURL=snipeIdFromCollection.d.ts.map

package/dist/cache/api/snipeIdFromCollection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snipeIdFromCollection.d.ts","sourceRoot":"","sources":["../../../src/cache/api/snipeIdFromCollection.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,sBAAsB,WAAY,MAAM,MAAM,MAAM,MAAM,YA2BtE,CAAC"}

package/dist/cache/api/upsertInCache.d.ts

@@ -0,0 +1,19 @@
+/**
+ * ```js
+ * import { upsertInCache } from '@amityco/ts-sdk'
+ * upsertInCache<Amity.User>(["user", "foobar"], user)
+ * ```
+ *
+ * Insert or update any provided value as {@link Amity.CacheEntry} for
+ * the matching {@link Amity.CacheKey}
+ *
+ * @param key the key to save the object to
+ * @param data the object to save
+ * @param options customisation object around cache behavior (default gives a 2mn lifespan)
+ * @returns a success boolean if the object was saved in cache
+ *
+ * @category Cache API
+ * @hidden
+ */
+export declare const upsertInCache: <T extends Record<string, unknown>>(key: Amity.CacheKey, data: T, options?: Amity.CacheOptions) => boolean;
+//# sourceMappingURL=upsertInCache.d.ts.map

package/dist/cache/api/upsertInCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upsertInCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/upsertInCache.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,8EAGf,MAAM,YAAY,KAC1B,OASF,CAAC"}

package/dist/cache/api/wipeCache.d.ts

@@ -0,0 +1,21 @@
+/**
+ * ```js
+ * import { wipeCache } from '@amityco/ts-sdk'
+ * const success = await wipeCache()
+ * ```
+ *
+ * Wipes a persistent storage for the current {@link Amity.Cache} instance.
+ *
+ * The strategy for persistent storage will depend on the runtime,
+ * which is supported by @react-native-async-storage/async-storage.
+ *
+ * The current userId will be appended to the given storageKey to avoid
+ * collision between multiple client instances over time.
+ *
+ * @param storageKey the name of the persistent storage
+ * @returns a success boolean if the persistent cache was wiped.
+ *
+ * @category Cache API
+ */
+export declare const wipeCache: (storageKey?: string) => Promise<boolean>;
+//# sourceMappingURL=wipeCache.d.ts.map

package/dist/cache/api/wipeCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wipeCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/wipeCache.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,SAAS,2CAUrB,CAAC"}

package/dist/cache/utils/index.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Encodes a given {@link Amity.CacheKey} to a plain string
+ *
+ * @param key the key to encode
+ * @returns an encoded string
+ *
+ * @category Cache
+ * @hidden
+ */
+export declare const encodeKey: (key: Amity.CacheKey) => string;
+/**
+ * Decodes a string back into a {@link Amity.CacheKey}
+
+ *
+ * @param key the string key to decode
+ * @returns a plain Amity.CacheKey object.
+ *
+ * @category Cache
+ * @hidden
+ */
+export declare const decodeKey: (key: string) => Amity.CacheKey;
+/**
+ * Performs a recursive partial deep equal check on two objects.
+ *
+ * @param predicate the reference object containing the partial information
+ * @param candidate the object to check against
+ * @returns true if the candidate contains all the values of the predicate
+ *
+ * @category Cache
+ */
+export declare const partialMatch: (predicate: any, candidate: any) => boolean;
+/**
+ * Type guard to check and cast that a given predicate matched {@link Amity.Cached} shape
+ *
+ * @param obj any {@link Amity.Cached}-like object
+ * @returns success boolean if the given object is of {@link Amity.Cached} shape
+ *
+ * @category Cache
+ */
+export declare const isCached: <T extends unknown>(obj?: any) => obj is Amity.Cached<T>;
+//# sourceMappingURL=index.d.ts.map

package/dist/cache/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/cache/utils/index.ts"],"names":[],"mappings":"AAgBA;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,2BAA0B,MACmC,CAAC;AAEpF;;;;;;;;;GASG;AACH,eAAO,MAAM,SAAS,QAAS,MAAM,mBAAoC,CAAC;AAE1E;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,cAAe,GAAG,aAAa,GAAG,KAAG,OAa7D,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,4BAA6B,GAAG,2BACU,CAAC"}

package/dist/category/api/getCategory.d.ts

@@ -0,0 +1,32 @@
+/**
+ * ```js
+ * import { getCategory } from '@amityco/ts-sdk'
+ * const { data: category } = await getCategory('foo')
+ * ```
+ *
+ * Fetches a {@link Amity.Category} object
+ *
+ * @param categoryId the ID of the {@link Amity.Category} to fetch
+ * @returns the associated {@link Amity.Category} object
+ *
+ * @category Category API
+ * @async
+ */
+export declare const getCategory: {
+    (categoryId: Amity.Category['categoryId']): Promise<Amity.Cached<Amity.Category>>;
+    /**
+     * ```js
+     * import { getCategory } from '@amityco/ts-sdk'
+     * const { data: category } = getCategory.locally('foobar')
+     * ```
+     *
+     * Fetches a {@link Amity.Category} object from cache
+     *
+     * @param categoryId the ID of the {@link Amity.Category} to fetch
+     * @returns the associated {@link Amity.Category} object
+     *
+     * @category Category API
+     */
+    locally(categoryId: Amity.Category['categoryId']): Amity.Cached<Amity.Category> | undefined;
+};
+//# sourceMappingURL=getCategory.d.ts.map

package/dist/category/api/getCategory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCategory.d.ts","sourceRoot":"","sources":["../../../src/category/api/getCategory.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,WAAW;iBACV,MAAM,QAAQ,CAAC,YAAY,CAAC,GACvC,QAAQ,MAAM,MAAM,CAAC,MAAM,QAAQ,CAAC,CAAC;IAmBxC;;;;;;;;;;;;OAYG;wBAEW,MAAM,QAAQ,CAAC,YAAY,CAAC,GACvC,MAAM,MAAM,CAAC,MAAM,QAAQ,CAAC,GAAG,SAAS;CAjB1C,CAAC"}

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

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

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

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

package/dist/category/api/queryCategories.d.ts

@@ -0,0 +1,36 @@
+/**
+ * ```js
+ * import { queryCategories } from '@amityco/ts-sdk'
+ * const { data: categories, prevPage, nextPage } = await queryCategories()
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.Category} objects
+ *
+ * @param query The query parameters
+ * @returns A page of {@link Amity.Category} objects
+ *
+ * @category Category API
+ * @async
+ * */
+export declare const queryCategories: {
+    (query?: {
+        sortBy?: "lastCreated" | "firstCreated" | "name" | undefined;
+        isDeleted?: Amity.Category['isDeleted'];
+        page?: Amity.Page | undefined;
+    } | undefined): Promise<Amity.Cached<Amity.Paged<Amity.Category, Amity.Page>>>;
+    /**
+     * ```js
+     * import { queryCategories } from '@amityco/ts-sdk'
+     * const { data: categories, prevPage, nextPage } = queryCategories.locally()
+     * ```
+     *
+     * Queries a paginable list of {@link Amity.Category} objects from cache
+     *
+     * @param query The query parameters
+     * @returns categories
+     *
+     * @category category API
+     */
+    locally(query: Parameters<typeof queryCategories>[0]): Amity.Cached<Amity.Paged<Amity.Category, Amity.Page>> | undefined;
+};
+//# sourceMappingURL=queryCategories.d.ts.map

package/dist/category/api/queryCategories.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryCategories.d.ts","sourceRoot":"","sources":["../../../src/category/api/queryCategories.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;KAaK;AACL,eAAO,MAAM,eAAe;;;oBAEd,MAAM,QAAQ,CAAC,WAAW,CAAC;;oBAErC,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,QAAQ,EAAE,MAAM,IAAI,CAAC,CAAC,CAAC;IAwClE;;;;;;;;;;;;OAYG;mBAEM,WAAW,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAC3C,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,QAAQ,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,SAAS;CAjBnE,CAAC"}

package/dist/channel/api/addChannelMembers.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { addChannelMembers } from '@amityco/ts-sdk'
+ * const updated = await addChannelMembers(channelId, ['foo', 'bar'])
+ * ```
+ *
+ * Adds a list of {@link Amity.User} to a {@link Amity.Channel}
+ *
+ * @param channelId The ID of the {@link Amity.Channel} to perform
+ * @param userIds The list of IDs {@link Amity.User} to add
+ * @returns A success boolean if the {@link Amity.User} were added to the {@link Amity.Channel}
+ *
+ * @category Channel API
+ * @async
+ */
+export declare const addChannelMembers: (channelId: Amity.Channel['channelId'], userIds: Amity.User['userId'][]) => Promise<boolean>;
+//# sourceMappingURL=addChannelMembers.d.ts.map

package/dist/channel/api/addChannelMembers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addChannelMembers.d.ts","sourceRoot":"","sources":["../../../src/channel/api/addChannelMembers.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iBAAiB,cACjB,MAAM,OAAO,CAAC,WAAW,CAAC,WAC5B,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,KAC9B,QAAQ,OAAO,CAoBjB,CAAC"}

package/dist/channel/api/addChannelMembersRole.d.ts

@@ -0,0 +1,18 @@
+/**
+ * ```js
+ * import { addChannelMembersRole } from '@amityco/ts-sdk'
+ * const updated = await addChannelMembersRole(channelId, 'foo', ['bar'])
+ * ```
+ *
+ * Adds an {@link Amity.Role} to a list of {@link Amity.User} on a {@link Amity.Channel}
+ *
+ * @param channelId The ID of the {@link Amity.Channel} to perform
+ * @param roleId The ID of the {@link Amity.Role} to apply
+ * @param userId Array of IDs of the {@link Amity.User} to perform
+ * @returns A success boolean if the {@link Amity.Role} were added to list of {@link Amity.User} in the {@link Amity.Channel}
+ *
+ * @category Channel API
+ * @async
+ */
+export declare const addChannelMembersRole: (channelId: Amity.Channel['channelId'], roleId: Amity.Role['roleId'], userIds: Amity.User['userId'][]) => Promise<boolean>;
+//# sourceMappingURL=addChannelMembersRole.d.ts.map

package/dist/channel/api/addChannelMembersRole.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addChannelMembersRole.d.ts","sourceRoot":"","sources":["../../../src/channel/api/addChannelMembersRole.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,qBAAqB,cACrB,MAAM,OAAO,CAAC,WAAW,CAAC,UAC7B,MAAM,IAAI,CAAC,QAAQ,CAAC,WACnB,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,KAC9B,QAAQ,OAAO,CAejB,CAAC"}

package/dist/channel/api/createChannel.d.ts

@@ -0,0 +1,19 @@
+/**
+ * ```js
+ * import { createChannel } from '@amityco/ts-sdk'
+ * const created = await createChannel({ channelId: 'foobar', displayName: 'foobar' })
+ * ```
+ *
+ * Creates an {@link Amity.Channel}
+ *
+ * @param bundle The data necessary to create a new {@link Amity.Channel}
+ * @returns The newly created {@link Amity.Channel}
+ *
+ * @category Channel API
+ * @async
+ */
+export declare const createChannel: <T extends Amity.ChannelType>(bundle: {
+    type: T;
+    userIds?: string[] | undefined;
+} & Pick<Amity.Channel<T>, "displayName" | "avatarFileId" | "tags" | "metadata">) => Promise<Amity.Cached<Amity.Channel>>;
+//# sourceMappingURL=createChannel.d.ts.map

package/dist/channel/api/createChannel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createChannel.d.ts","sourceRoot":"","sources":["../../../src/channel/api/createChannel.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa;;;qFAKvB,QAAQ,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,CAuBrC,CAAC"}

package/dist/channel/api/deleteChannel.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ```js
+ * import { deleteChannel } from '@amityco/ts-sdk'
+ * const success = await deleteChannel('foobar')
+ * ```
+ *
+ * Deletes a {@link Amity.Channel}
+ *
+ * @param channelId The {@link Amity.Channel} ID to delete
+ * @return A success boolean if the {@link Amity.Channel} was deleted
+ *
+ * @category Channel API
+ * @async
+ */
+export declare const deleteChannel: (channelId: Amity.Channel['channelId']) => Promise<Amity.Channel>;
+//# sourceMappingURL=deleteChannel.d.ts.map

package/dist/channel/api/deleteChannel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteChannel.d.ts","sourceRoot":"","sources":["../../../src/channel/api/deleteChannel.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa,cACb,MAAM,OAAO,CAAC,WAAW,CAAC,KACpC,QAAQ,MAAM,OAAO,CAYvB,CAAC"}

package/dist/channel/api/getChannel.d.ts

@@ -0,0 +1,32 @@
+/**
+ * ```js
+ * import { getChannel } from '@amityco/ts-sdk'
+ * const channel = await getChannel('foobar')
+ * ```
+ *
+ * Fetches a {@link Amity.Channel} object
+ *
+ * @param channelId the ID of the {@link Amity.Channel} to fetch
+ * @returns the associated {@link Amity.Channel} object
+ *
+ * @category Channel API
+ * @async
+ */
+export declare const getChannel: {
+    (channelId: Amity.Channel['channelId']): Promise<Amity.Cached<Amity.Channel>>;
+    /**
+     * ```js
+     * import { getChannel } from '@amityco/ts-sdk'
+     * const channel = getChannel.locally('foobar')
+     * ```
+     *
+     * Fetches a {@link Amity.Channel} object from cache
+     *
+     * @param channelId the ID of the {@link Amity.Channel} to fetch
+     * @returns the associated {@link Amity.Channel} object
+     *
+     * @category Channel API
+     */
+    locally(channelId: Amity.Channel['channelId']): Amity.Cached<Amity.Channel> | undefined;
+};
+//# sourceMappingURL=getChannel.d.ts.map

package/dist/channel/api/getChannel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getChannel.d.ts","sourceRoot":"","sources":["../../../src/channel/api/getChannel.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU;gBACV,MAAM,OAAO,CAAC,WAAW,CAAC,GACpC,QAAQ,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,CAAC;IAoBvC;;;;;;;;;;;;OAYG;uBAEU,MAAM,OAAO,CAAC,WAAW,CAAC,GACpC,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,SAAS;CAjBzC,CAAC"}

package/dist/channel/api/getChannels.d.ts

@@ -0,0 +1,32 @@
+/**
+ * ```js
+ * import { getChannels } from '@amityco/ts-sdk'
+ * const channels = await getChannels(['foo', 'bar'])
+ * ```
+ *
+ * Fetches a collection of {@link Amity.Channel} objects
+ *
+ * @param channelIds the IDs of the {@link Amity.Channel} to fetch
+ * @returns the associated collection of {@link Amity.Channel} objects
+ *
+ * @category Channel API
+ * @async
+ */
+export declare const getChannels: {
+    (channelIds: Amity.Channel['channelId'][]): Promise<Amity.Cached<Amity.Channel[]>>;
+    /**
+     * ```js
+     * import { getChannels } from '@amityco/ts-sdk'
+     * const channels = getChannels.locally(['foo', 'bar']) ?? []
+     * ```
+     *
+     * Fetches a collection of {@link Amity.Channel} objects from cache
+     *
+     * @param channelIds the IDs of the {@link Amity.Channel} to fetch
+     * @returns the associated collection of {@link Amity.Channel} objects
+     *
+     * @category Channel API
+     */
+    locally(channelIds: Amity.Channel['channelId'][]): Amity.Cached<Amity.Channel[]> | undefined;
+};
+//# sourceMappingURL=getChannels.d.ts.map

package/dist/channel/api/getChannels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getChannels.d.ts","sourceRoot":"","sources":["../../../src/channel/api/getChannels.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,WAAW;iBACV,MAAM,OAAO,CAAC,WAAW,CAAC,EAAE,GACvC,QAAQ,MAAM,MAAM,CAAC,MAAM,OAAO,EAAE,CAAC,CAAC;IAoBzC;;;;;;;;;;;;OAYG;wBAEW,MAAM,OAAO,CAAC,WAAW,CAAC,EAAE,GACvC,MAAM,MAAM,CAAC,MAAM,OAAO,EAAE,CAAC,GAAG,SAAS;CAjB3C,CAAC"}

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

@@ -0,0 +1,14 @@
+export * from './queryChannels';
+export * from './getChannels';
+export * from './getChannel';
+export * from './createChannel';
+export * from './updateChannel';
+export * from './deleteChannel';
+export * from './joinChannel';
+export * from './leaveChannel';
+export * from './queryChannelMembers';
+export * from './addChannelMembers';
+export * from './removeChannelMembers';
+export * from './addChannelMembersRole';
+export * from './removeChannelMembersRole';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/channel/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAE7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAEhC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAE/B,cAAc,uBAAuB,CAAC;AAEtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AAEvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,4BAA4B,CAAC"}

package/dist/channel/api/joinChannel.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ```js
+ * import { joinChannel } from '@amityco/ts-sdk'
+ * const isJoined = await joinChannel('foobar')
+ * ```
+ *
+ * Joins a {@link Amity.Channel} object
+ *
+ * @param channelId the {@link Amity.Channel} to join
+ * @returns A success boolean if the {@link Amity.Channel} was joined
+ *
+ * @category Channel API
+ * @async
+ */
+export declare const joinChannel: (channelId: Amity.Channel['channelId']) => Promise<boolean>;
+//# sourceMappingURL=joinChannel.d.ts.map

package/dist/channel/api/joinChannel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"joinChannel.d.ts","sourceRoot":"","sources":["../../../src/channel/api/joinChannel.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,WAAW,cAAqB,MAAM,OAAO,CAAC,WAAW,CAAC,KAAG,QAAQ,OAAO,CAexF,CAAC"}

package/dist/channel/api/leaveChannel.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ```js
+ * import { leaveChannel } from '@amityco/ts-sdk'
+ * const isLeft = await leaveChannel('foobar')
+ * ```
+ *
+ * Leave a {@link Amity.Channel} object
+ *
+ * @param channelId the {@link Amity.Channel} to leave
+ * @returns A success boolean if the {@link Amity.Channel} was left
+ *
+ * @category Channel API
+ * @async
+ */
+export declare const leaveChannel: (channelId: Amity.Channel['channelId']) => Promise<boolean>;
+//# sourceMappingURL=leaveChannel.d.ts.map

package/dist/channel/api/leaveChannel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"leaveChannel.d.ts","sourceRoot":"","sources":["../../../src/channel/api/leaveChannel.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,cAAqB,MAAM,OAAO,CAAC,WAAW,CAAC,KAAG,QAAQ,OAAO,CAezF,CAAC"}

package/dist/channel/api/queryChannelMembers.d.ts

@@ -0,0 +1,38 @@
+/**
+ * ```js
+ * import { queryChannelMembers } from '@amityco/ts-sdk'
+ * const channelMembers = await queryChannelMembers({ channelId: 'foo' })
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.ChannelUser} objects
+ *
+ * @param query The query parameters
+ * @returns A page of {@link Amity.ChannelUser} objects
+ *
+ * @category Channel API
+ * @async
+ * */
+export declare const queryChannelMembers: {
+    (query: {
+        channelId: string;
+        membership?: 'all' | 'muted' | 'banned' | 'member&banned';
+        roles?: string[];
+        sortBy?: 'firstCreated' | 'lastCreated';
+        page?: Amity.Page;
+    }): Promise<Amity.Cached<Amity.Paged<Amity.Membership<'channel'>>>>;
+    /**
+     * ```js
+     * import { queryChannelMembers } from '@amityco/ts-sdk'
+     * const channelMembers = await queryChannelMembers(query)
+     * ```
+     *
+     * Queries a paginable list of {@link Amity.Post} objects from cache
+     *
+     * @param query The query parameters
+     * @returns posts
+     *
+     * @category Post API
+     */
+    locally(query: Parameters<typeof queryChannelMembers>[0]): void;
+};
+//# sourceMappingURL=queryChannelMembers.d.ts.map

package/dist/channel/api/queryChannelMembers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryChannelMembers.d.ts","sourceRoot":"","sources":["../../../src/channel/api/queryChannelMembers.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;KAaK;AACL,eAAO,MAAM,mBAAmB;YAAiB;QAC/C,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,eAAe,CAAC;QAC1D,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QACjB,MAAM,CAAC,EAAE,cAAc,GAAG,aAAa,CAAC;QACxC,IAAI,CAAC,EAAE,MAAM,IAAI,CAAC;KACnB,GAAG,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAiCnE;;;;;;;;;;;;OAYG;mBACmC,WAAW,0BAA0B,CAAC,CAAC,CAAC,CAAC;CAf9E,CAAC"}

package/dist/channel/api/queryChannels.d.ts

@@ -0,0 +1,42 @@
+/**
+ * ```js
+ * import { queryChannels } from '@amityco/ts-sdk'
+ * const channels = await queryChannels()
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.Channel} objects
+ * Search is performed by displayName such as `.startsWith(search)`
+ *
+ * @param query The query parameters
+ * @returns A page of {@link Amity.Channel} objects
+ *
+ * @category Channel API
+ * @async
+ */
+export declare const queryChannels: {
+    (query?: {
+        displayName?: string | undefined;
+        membership?: "all" | "member" | "notMember" | undefined;
+        sortBy?: "displayName" | "firstCreated" | "lastCreated" | undefined;
+        types?: Amity.ChannelType | undefined;
+        isDeleted?: Amity.Channel['isDeleted'];
+        tags?: Amity.Taggable['tags'];
+        excludeTags?: Amity.Taggable['tags'];
+        page?: Amity.Page | undefined;
+    } | undefined): Promise<Amity.Cached<Amity.Paged<Amity.Channel>>>;
+    /**
+     * ```js
+     * import { queryChannels } from '@amityco/ts-sdk'
+     * const channels = queryChannels.locally()
+     * ```
+     *
+     * Queries a paginable list of {@link Amity.Channel} objects from cache
+     *
+     * @param query The query parameters
+     * @returns channels
+     *
+     * @category Channel API
+     */
+    locally(query: Parameters<typeof queryChannels>[0]): void;
+};
+//# sourceMappingURL=queryChannels.d.ts.map

package/dist/channel/api/queryChannels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryChannels.d.ts","sourceRoot":"","sources":["../../../src/channel/api/queryChannels.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa;;;;;;oBAKZ,MAAM,OAAO,CAAC,WAAW,CAAC;eAC/B,MAAM,QAAQ,CAAC,MAAM,CAAC;sBACf,MAAM,QAAQ,CAAC,MAAM,CAAC;;oBAElC,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC;IA8CrD;;;;;;;;;;;;OAYG;mBAC6B,WAAW,oBAAoB,CAAC,CAAC,CAAC,CAAC;CAflE,CAAC"}