@amityco/ts-sdk 1.0.0-8aae813.0 → 6.0.0-beta01

package/dist/commentRepository/api/updateComment.d.ts

@@ -0,0 +1,19 @@
+/**
+ * ```js
+ * import { CommentRepository } from '@amityco/ts-sdk'
+ * const updated = await CommentRepository.updateComment(commentId, {
+ *   data: { text: 'hello world' }
+ * })
+ * ```
+ *
+ * Updates an {@link Amity.Comment}
+ *
+ * @param commentId The ID of the {@link Amity.Comment} to edit
+ * @param patch The patch data to apply
+ * @returns the updated {@link Amity.Comment} object
+ *
+ * @category Comment API
+ * @async
+ */
+export declare const updateComment: (commentId: Amity.Comment['commentId'], patch: Patch<Amity.Comment, 'data' | 'metadata' | 'mentionees'>) => Promise<Amity.Cached<Amity.Comment>>;
+//# sourceMappingURL=updateComment.d.ts.map

package/dist/commentRepository/api/updateComment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateComment.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/api/updateComment.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,cACb,aAAa,CAAC,WAAW,CAAC,SAC9B,MAAM,aAAa,EAAE,MAAM,GAAG,UAAU,GAAG,YAAY,CAAC,KAC9D,QAAQ,MAAM,MAAM,CAAC,aAAa,CAAC,CAmBrC,CAAC"}

package/dist/commentRepository/events/index.d.ts

@@ -0,0 +1,8 @@
+export * from './onCommentCreated';
+export * from './onCommentUpdated';
+export * from './onCommentDeleted';
+export * from './onCommentFlagged';
+export * from './onCommentUnflagged';
+export * from './onCommentReactionAdded';
+export * from './onCommentReactionRemoved';
+//# sourceMappingURL=index.d.ts.map

package/dist/commentRepository/events/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AAErC,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC"}

package/dist/commentRepository/events/onCommentCreated.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onCommentCreated } from '@amityco/ts-sdk'
+ * const dispose = onCommentCreated(comment => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.Comment} has been created
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Comment Events
+ */
+export declare const onCommentCreated: (callback: Amity.Listener<Amity.Comment>) => Amity.Unsubscriber;
+//# sourceMappingURL=onCommentCreated.d.ts.map

package/dist/commentRepository/events/onCommentCreated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onCommentCreated.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/events/onCommentCreated.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,aAAc,MAAM,QAAQ,CAAC,aAAa,CAAC,KAAG,MAAM,YACtB,CAAC"}

package/dist/commentRepository/events/onCommentDeleted.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onCommentDeleted } from '@amityco/ts-sdk'
+ * const dispose = onCommentDeleted(comment => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.Comment} has been deleted
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Comment Events
+ */
+export declare const onCommentDeleted: (callback: Amity.Listener<Amity.Comment>) => Amity.Unsubscriber;
+//# sourceMappingURL=onCommentDeleted.d.ts.map

package/dist/commentRepository/events/onCommentDeleted.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onCommentDeleted.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/events/onCommentDeleted.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,aAAc,MAAM,QAAQ,CAAC,aAAa,CAAC,KAAG,MAAM,YACtB,CAAC"}

package/dist/commentRepository/events/onCommentFlagged.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onCommentFlagged } from '@amityco/ts-sdk'
+ * const dispose = onCommentFlagged(comment => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.Comment} has been flagged
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Comment Events
+ */
+export declare const onCommentFlagged: (callback: Amity.Listener<Amity.Comment>) => Amity.Unsubscriber;
+//# sourceMappingURL=onCommentFlagged.d.ts.map

package/dist/commentRepository/events/onCommentFlagged.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onCommentFlagged.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/events/onCommentFlagged.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,aAAc,MAAM,QAAQ,CAAC,aAAa,CAAC,KAAG,MAAM,YACtB,CAAC"}

package/dist/commentRepository/events/onCommentReactionAdded.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onCommentReactionAdded } from '@amityco/ts-sdk'
+ * const dispose = onCommentReactionAdded(comment => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.Comment} has been reacted
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Comment Events
+ */
+export declare const onCommentReactionAdded: (callback: Amity.Listener<Amity.Comment>) => Amity.Unsubscriber;
+//# sourceMappingURL=onCommentReactionAdded.d.ts.map

package/dist/commentRepository/events/onCommentReactionAdded.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onCommentReactionAdded.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/events/onCommentReactionAdded.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,sBAAsB,aACvB,MAAM,QAAQ,CAAC,aAAa,CAAC,KACtC,MAAM,YAwBR,CAAC"}

package/dist/commentRepository/events/onCommentReactionRemoved.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onCommentReactionRemoved } from '@amityco/ts-sdk'
+ * const dispose = onCommentReactionRemoved(comment => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a reaction has been removed from a {@link Amity.Comment}
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Comment Events
+ */
+export declare const onCommentReactionRemoved: (callback: Amity.Listener<Amity.Comment>) => Amity.Unsubscriber;
+//# sourceMappingURL=onCommentReactionRemoved.d.ts.map

package/dist/commentRepository/events/onCommentReactionRemoved.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onCommentReactionRemoved.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/events/onCommentReactionRemoved.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,wBAAwB,aACzB,MAAM,QAAQ,CAAC,aAAa,CAAC,KACtC,MAAM,YAwBR,CAAC"}

package/dist/commentRepository/events/onCommentUnflagged.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onCommentUnflagged } from '@amityco/ts-sdk'
+ * const dispose = onCommentUnflagged(comment => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a flag has been removed from a {@link Amity.Comment}
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Comment Events
+ */
+export declare const onCommentUnflagged: (callback: Amity.Listener<Amity.Comment>) => Amity.Unsubscriber;
+//# sourceMappingURL=onCommentUnflagged.d.ts.map

package/dist/commentRepository/events/onCommentUnflagged.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onCommentUnflagged.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/events/onCommentUnflagged.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,kBAAkB,aAAc,MAAM,QAAQ,CAAC,aAAa,CAAC,KAAG,MAAM,YACtB,CAAC"}

package/dist/commentRepository/events/onCommentUpdated.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onCommentUpdated } from '@amityco/ts-sdk'
+ * const dispose = onCommentUpdated(comment => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.Comment} has been updated
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Comment Events
+ */
+export declare const onCommentUpdated: (callback: Amity.Listener<Amity.Comment>) => Amity.Unsubscriber;
+//# sourceMappingURL=onCommentUpdated.d.ts.map

package/dist/commentRepository/events/onCommentUpdated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onCommentUpdated.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/events/onCommentUpdated.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,aAAc,MAAM,QAAQ,CAAC,aAAa,CAAC,KAAG,MAAM,YACtB,CAAC"}

package/dist/commentRepository/events/tests/onCommentCreated.test.d.ts

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

package/dist/commentRepository/events/tests/onCommentCreated.test.d.ts.map

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

package/dist/commentRepository/events/tests/onCommentDeleted.test.d.ts

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

package/dist/commentRepository/events/tests/onCommentDeleted.test.d.ts.map

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

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

@@ -0,0 +1,2 @@
+export declare const createCommentEventSubscriber: (event: keyof Amity.MqttCommentEvents, callback: Amity.Listener<Amity.Comment>) => Amity.Unsubscriber;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/events/utils.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,4BAA4B,UAChC,MAAM,MAAM,iBAAiB,YAC1B,MAAM,QAAQ,CAAC,aAAa,CAAC,uBA8BxC,CAAC"}

package/dist/commentRepository/index.d.ts

@@ -0,0 +1,4 @@
+export * from './api';
+export * from './events';
+export * from './observers';
+//# sourceMappingURL=index.d.ts.map

package/dist/commentRepository/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/commentRepository/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC"}

package/dist/commentRepository/observers/getComment.d.ts

@@ -0,0 +1,21 @@
+/**
+ * ```js
+ * import { getComment } from '@amityco/ts-sdk';
+ *
+ * let comment;
+ *
+ * const unsubscribe = getComment(commentId, response => {
+ *   comment = response.data;
+ * });
+ * ```
+ *
+ * Observe all mutation on a given {@link Amity.Comment}
+ *
+ * @param commentId the ID of the comment 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 comment
+ *
+ * @category Comment Live Object
+ */
+export declare const getComment: (commentId: Amity.Comment['commentId'], callback: Amity.LiveObjectCallback<Amity.Comment>) => Amity.Unsubscriber;
+//# sourceMappingURL=getComment.d.ts.map

package/dist/commentRepository/observers/getComment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getComment.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/observers/getComment.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,UAAU,cACV,aAAa,CAAC,WAAW,CAAC,YAC3B,MAAM,kBAAkB,CAAC,aAAa,CAAC,KAChD,MAAM,YASR,CAAC"}

package/dist/commentRepository/observers/getComments.d.ts

@@ -0,0 +1,22 @@
+/**
+ * ```js
+ * import { getComments } from '@amityco/ts-sdk'
+ *
+ * let comments = []
+ * const unsub = getComments({
+ *   referenceType: Amity.Comment['referenceType'];
+ *   referenceId: Amity.Comment['referenceId'];
+ * }, response => merge(comments, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.Comment} for a given target object
+ *
+ * @param referenceType the type of the target
+ * @param referenceId the ID of the target
+ * @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 messages
+ *
+ * @category Comments Live Collection
+ */
+export declare const getComments: (params: Amity.CommentLiveCollection, callback: Amity.LiveCollectionCallback<Amity.Comment>, config?: Amity.LiveCollectionConfig) => Amity.Unsubscriber;
+//# sourceMappingURL=getComments.d.ts.map

package/dist/commentRepository/observers/getComments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getComments.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/observers/getComments.ts"],"names":[],"mappings":"AAkCA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,WAAW,WACd,MAAM,qBAAqB,YACzB,MAAM,sBAAsB,CAAC,aAAa,CAAC,WAC5C,MAAM,oBAAoB,KAClC,MAAM,YAyHR,CAAC"}

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

@@ -0,0 +1,5 @@
+export * from './observeComments';
+export * from './observeComment';
+export * from './getComment';
+export * from './getComments';
+//# sourceMappingURL=index.d.ts.map

package/dist/commentRepository/observers/index.d.ts.map

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

package/dist/commentRepository/observers/observeComment.d.ts

@@ -0,0 +1,18 @@
+/**
+ * ```js
+ * import { observeComment } from '@amityco/ts-sdk'
+ *
+ * let comment = {}
+ * const dispose = observeComment(commentId, ({ data }) => comment = data)
+ * ```
+ *
+ * Observe all mutation on a given {@link Amity.Comment}
+ *
+ * @param commentId the ID of the comment 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 comment
+ *
+ * @category Comment Observer
+ */
+export declare const observeComment: <Events extends ["onFetch", "onUpdate", "onDelete", "onFlagged", "onUnflagged", "onReactionAdded", "onReactionRemoved"]>(commentId: string, callback: Amity.ObjectListener<Amity.Snapshot<Amity.Comment<any> | undefined>, Events>, policy?: Amity.QueryPolicy) => Amity.Unsubscriber;
+//# sourceMappingURL=observeComment.d.ts.map

package/dist/commentRepository/observers/observeComment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"observeComment.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/observers/observeComment.ts"],"names":[],"mappings":"AAeA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,cAAc,sIAWd,MAAM,mGAET,MAAM,WAAW,KACxB,MAAM,YAkDR,CAAC"}

package/dist/commentRepository/observers/observeComments.d.ts

@@ -0,0 +1,26 @@
+/**
+ * ```js
+ * import { observeComments } from '@amityco/ts-sdk'
+ *
+ * let comments = []
+ * const unsub = observeComments(postId, comment => merge(comments, comment))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.Comment} for a given {@link Amity.Post} object
+ *
+ * @param postId the ID of the post where to observe the comments
+ * @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 comments
+ *
+ * @category Comment Observer
+ */
+export declare const observeComments: (postId: Amity.Post['postId'], callback: Amity.ObjectListener<Amity.Comment, [
+    'onCreate',
+    'onUpdate',
+    'onDelete',
+    'onFlagged',
+    'onUnflagged',
+    'onReactionAdded',
+    'onReactionRemoved'
+]>) => Amity.Unsubscriber;
+//# sourceMappingURL=observeComments.d.ts.map

package/dist/commentRepository/observers/observeComments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"observeComments.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/observers/observeComments.ts"],"names":[],"mappings":"AAYA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,eAAe,WAClB,MAAM,IAAI,CAAC,QAAQ,CAAC,YAClB,MAAM,cAAc,CAC5B,aAAa,EACb;IACE,UAAU;IACV,UAAU;IACV,UAAU;IACV,WAAW;IACX,aAAa;IACb,iBAAiB;IACjB,mBAAmB;CACpB,CACF,KACA,MAAM,YA+BR,CAAC"}

package/dist/commentRepository/observers/tests/getComment.test.d.ts

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

package/dist/commentRepository/observers/tests/getComment.test.d.ts.map

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

package/dist/communityRepository/api/createCommunity.d.ts

@@ -0,0 +1,20 @@
+/**
+ * ```js
+ * import { createCommunity } from '@amityco/ts-sdk'
+ * const created = await createCommunity({ communityId: 'foobar', displayName: 'foobar' })
+ * ```
+ *
+ * Creates an {@link Amity.Community}
+ *
+ * @param bundle The data necessary to create a new {@link Amity.Community}
+ * @returns The newly created {@link Amity.Community}
+ *
+ * @category Community API
+ * @async
+ */
+export declare const createCommunity: (bundle: Pick<Amity.Community, 'displayName' | 'avatarFileId' | 'description' | 'isPublic' | 'isOfficial' | 'postSetting' | 'tags' | 'metadata'> & {
+    userIds?: string[];
+    categoryIds?: string[];
+    isUniqueDisplayName?: boolean;
+}) => Promise<Amity.Cached<Amity.Community>>;
+//# sourceMappingURL=createCommunity.d.ts.map

package/dist/communityRepository/api/createCommunity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createCommunity.d.ts","sourceRoot":"","sources":["../../../src/communityRepository/api/createCommunity.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,eAAe,WAClB,KACN,MAAM,SAAS,EACb,aAAa,GACb,cAAc,GACd,aAAa,GACb,UAAU,GACV,YAAY,GACZ,aAAa,GACb,MAAM,GACN,UAAU,CACb,GAAG;IACF,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,KACA,QAAQ,MAAM,MAAM,CAAC,MAAM,SAAS,CAAC,CAqBvC,CAAC"}

package/dist/communityRepository/api/deleteCommunity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteCommunity.d.ts","sourceRoot":"","sources":["../../../src/communityRepository/api/deleteCommunity.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,eAAe,gBACb,MAAM,SAAS,CAAC,aAAa,CAAC,KAC1C,QAAQ,MAAM,SAAS,CAmBzB,CAAC"}

package/dist/communityRepository/api/getCommunities.d.ts

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

package/dist/communityRepository/api/getCommunities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCommunities.d.ts","sourceRoot":"","sources":["../../../src/communityRepository/api/getCommunities.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,cAAc;mBACX,MAAM,SAAS,CAAC,aAAa,CAAC,EAAE,GAC7C,QAAQ,MAAM,MAAM,CAAC,MAAM,SAAS,EAAE,CAAC,CAAC;IAuB3C;;;;;;;;;;;;OAYG;0BAEa,MAAM,SAAS,CAAC,aAAa,CAAC,EAAE,GAC7C,MAAM,MAAM,CAAC,MAAM,SAAS,EAAE,CAAC,GAAG,SAAS;CAjB7C,CAAC"}

package/dist/communityRepository/api/getCommunity.d.ts

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

package/dist/communityRepository/api/getCommunity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCommunity.d.ts","sourceRoot":"","sources":["../../../src/communityRepository/api/getCommunity.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY;kBACV,MAAM,SAAS,CAAC,aAAa,CAAC,GAC1C,QAAQ,MAAM,MAAM,CAAC,MAAM,SAAS,CAAC,CAAC;IAuBzC;;;;;;;;;;;;OAYG;yBAEY,MAAM,SAAS,CAAC,aAAa,CAAC,GAC1C,MAAM,MAAM,CAAC,MAAM,SAAS,CAAC,GAAG,SAAS;CAlB3C,CAAC"}

package/dist/communityRepository/api/getRecommendedCommunities.d.ts

@@ -0,0 +1,32 @@
+/**
+ * ```js
+ * import { getRecommendedCommunities } from '@amityco/ts-sdk'
+ * const communities = await getRecommendedCommunities()
+ * ```
+ *
+ * Gets a list of recommended {@link Amity.Community} objects
+ *
+ * @param query The query parameters
+ * @returns A list of {@link Amity.Community} objects
+ *
+ * @category Community API
+ * @async
+ */
+export declare const getRecommendedCommunities: {
+    (query?: Partial<Amity.PageLimit>): Promise<Amity.Cached<Amity.Community[]>>;
+    /**
+     * ```js
+     * import { getRecommendedCommunities } from '@amityco/ts-sdk'
+     * const communities = getRecommendedCommunities.locally()
+     * ```
+     *
+     * Gets a list of recommended {@link Amity.Community} objects from cache
+     *
+     * @param query The query parameters
+     * @returns communities
+     *
+     * @category Community API
+     */
+    locally(query: Parameters<typeof getRecommendedCommunities>[0]): Amity.Cached<Amity.Community[]> | undefined;
+};
+//# sourceMappingURL=getRecommendedCommunities.d.ts.map

package/dist/communityRepository/api/getRecommendedCommunities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getRecommendedCommunities.d.ts","sourceRoot":"","sources":["../../../src/communityRepository/api/getRecommendedCommunities.ts"],"names":[],"mappings":"AAWA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,yBAAyB;aAC5B,QAAQ,MAAM,SAAS,CAAC,GAC/B,QAAQ,MAAM,MAAM,CAAC,MAAM,SAAS,EAAE,CAAC,CAAC;IA6B3C;;;;;;;;;;;;OAYG;mBAEM,WAAW,gCAAgC,CAAC,CAAC,CAAC,CAAC,GACrD,MAAM,MAAM,CAAC,MAAM,SAAS,EAAE,CAAC,GAAG,SAAS;CAlB7C,CAAC"}

package/dist/communityRepository/api/getTopTrendingCommunities.d.ts

@@ -0,0 +1,32 @@
+/**
+ * ```js
+ * import { getTopTrendingCommunities } from '@amityco/ts-sdk'
+ * const trendingCommunities = await getTopTrendingCommunities()
+ * ```
+ *
+ * Gets a list of top trending {@link Amity.Community} objects
+ *
+ * @param query The query parameters
+ * @returns A list of {@link Amity.Community} objects
+ *
+ * @category Community API
+ * @async
+ */
+export declare const getTopTrendingCommunities: {
+    (query?: Partial<Amity.PageLimit>): Promise<Amity.Cached<Amity.Community[]>>;
+    /**
+     * ```js
+     * import { getTopTrendingCommunities } from '@amityco/ts-sdk'
+     * const communities = getTopTrendingCommunities.locally()
+     * ```
+     *
+     * Gets a list of top trending {@link Amity.Community} objects from cache
+     *
+     * @param query The query parameters
+     * @returns communities
+     *
+     * @category Community API
+     */
+    locally(query: Parameters<typeof getTopTrendingCommunities>[0]): Amity.Cached<Amity.Community[]> | undefined;
+};
+//# sourceMappingURL=getTopTrendingCommunities.d.ts.map

package/dist/communityRepository/api/getTopTrendingCommunities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getTopTrendingCommunities.d.ts","sourceRoot":"","sources":["../../../src/communityRepository/api/getTopTrendingCommunities.ts"],"names":[],"mappings":"AAWA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,yBAAyB;aAC5B,QAAQ,MAAM,SAAS,CAAC,GAC/B,QAAQ,MAAM,MAAM,CAAC,MAAM,SAAS,EAAE,CAAC,CAAC;IA6B3C;;;;;;;;;;;;OAYG;mBAEM,WAAW,gCAAgC,CAAC,CAAC,CAAC,CAAC,GACrD,MAAM,MAAM,CAAC,MAAM,SAAS,EAAE,CAAC,GAAG,SAAS;CAlB7C,CAAC"}

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

@@ -0,0 +1,9 @@
+export { getCommunities as getCommunityByIds } from './getCommunities';
+export * from './createCommunity';
+export * from './updateCommunity';
+export * from './deleteCommunity';
+export * from './joinCommunity';
+export * from './leaveCommunity';
+export * from './getTopTrendingCommunities';
+export * from './getRecommendedCommunities';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/communityRepository/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAEvE,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAElC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC"}

package/dist/communityRepository/api/joinCommunity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"joinCommunity.d.ts","sourceRoot":"","sources":["../../../src/communityRepository/api/joinCommunity.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa,gBACX,MAAM,SAAS,CAAC,aAAa,CAAC,KAC1C,QAAQ,OAAO,CAqBjB,CAAC"}

package/dist/communityRepository/api/leaveCommunity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"leaveCommunity.d.ts","sourceRoot":"","sources":["../../../src/communityRepository/api/leaveCommunity.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,cAAc,gBACZ,MAAM,SAAS,CAAC,aAAa,CAAC,KAC1C,QAAQ,OAAO,CAqBjB,CAAC"}

package/dist/communityRepository/api/queryCommunities.d.ts

@@ -0,0 +1,33 @@
+/**
+ * ```js
+ * import { queryCommunities } from '@amityco/ts-sdk'
+ * const communities = await queryCommunities()
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.Community} objects
+ * Search is performed by displayName such as `.startsWith(search)`
+ *
+ * @param query The query parameters
+ * @returns A page of {@link Amity.Community} objects
+ *
+ * @category Community API
+ * @async
+ */
+export declare const queryCommunities: {
+    (query?: Amity.QueryCommunities): Promise<Amity.Cached<Amity.Paged<Amity.Community>>>;
+    /**
+     * ```js
+     * import { queryCommunities } from '@amityco/ts-sdk'
+     * const communities = queryCommunities.locally()
+     * ```
+     *
+     * Queries a paginable list of {@link Amity.Community} objects from cache
+     *
+     * @param query The query parameters
+     * @returns communities
+     *
+     * @category Community API
+     */
+    locally(query: Parameters<typeof queryCommunities>[0]): void;
+};
+//# sourceMappingURL=queryCommunities.d.ts.map

package/dist/communityRepository/api/queryCommunities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryCommunities.d.ts","sourceRoot":"","sources":["../../../src/communityRepository/api/queryCommunities.ts"],"names":[],"mappings":"AAaA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB;aACnB,MAAM,gBAAgB,GAC7B,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,SAAS,CAAC,CAAC,CAAC;IAkDtD;;;;;;;;;;;;OAYG;mBACgC,WAAW,uBAAuB,CAAC,CAAC,CAAC,CAAC;CAhBxE,CAAC"}

package/dist/communityRepository/api/test/createCommunity.test.d.ts

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

package/dist/communityRepository/api/test/createCommunity.test.d.ts.map

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

package/dist/communityRepository/api/test/deleteCommunity.test.d.ts

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

package/dist/communityRepository/api/test/deleteCommunity.test.d.ts.map

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

package/dist/communityRepository/api/test/getCommunities.test.d.ts

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

package/dist/communityRepository/api/test/getCommunities.test.d.ts.map

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

package/dist/communityRepository/api/test/getCommunity.test.d.ts

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

package/dist/communityRepository/api/test/getCommunity.test.d.ts.map

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