@amityco/ts-sdk 0.0.1-beta.2 → 0.0.1-c58e50d.0

package/dist/message/api/createMessage.d.ts

@@ -0,0 +1,38 @@
+/**
+ * ```js
+ * import { createMessage } from '@amityco/ts-sdk'
+ * const created = await createMessage({
+ *   channelId: 'foobar',
+ *   data: { text: 'hello world' }
+ * })
+ * ```
+ *
+ * Creates an {@link Amity.Message}
+ *
+ * @param bundle The data necessary to create a new {@link Amity.Message}
+ * @returns The newly created {@link Amity.Message}
+ *
+ * @category Message API
+ * @async
+ */
+export declare const createMessage: {
+    <T extends Amity.MessageContentType>(bundle: Pick<Amity.Message<T>, "type" | "channelId" | "data" | "metadata">): Promise<Amity.Message<any>>;
+    /**
+     * ```js
+     * import { createMessage } from '@amityco/ts-sdk'
+     * const created = createMessage.locally({
+     *   channelId: 'foobar',
+     *   data: { text: 'hello world' }
+     * })
+     * ```
+     *
+     * Creates an {@link Amity.Message} in cache
+     *
+     * @param bundle The data necessary to create a new {@link Amity.Message}
+     * @returns The newly created {@link Amity.Message}
+     *
+     * @category Message API
+     */
+    optimistically(bundle: Pick<Amity.Message, 'channelId' | 'type' | 'data' | 'metadata'>): Amity.Message<any> | undefined;
+};
+//# sourceMappingURL=createMessage.d.ts.map

package/dist/message/api/deleteMessage.d.ts

@@ -0,0 +1,32 @@
+/**
+ * ```js
+ * import { deleteMessage } from '@amityco/ts-sdk'
+ * const success = await deleteMessage('foobar')
+ * ```
+ *
+ * Delete a {@link Amity.Message}
+ *
+ * @param The ID of the {@link Amity.Message} to delete
+ * @return A success boolean if the {@link Amity.Message} was deleted
+ *
+ * @category Message API
+ * @async
+ */
+export declare const deleteMessage: {
+    (messageId: Amity.Message['messageId']): Promise<Amity.Message<any>>;
+    /**
+     * ```js
+     * import { deleteMessage } from '@amityco/ts-sdk'
+     * const success = deleteMessage.locally('foobar')
+     * ```
+     *
+     * Deletes a {@link Amity.Message}
+     *
+     * @param messageId The {@link Amity.Message} ID to delete
+     * @return A success boolean if the {@link Amity.Message} was deleted
+     *
+     * @category Message API
+     */
+    optimistically(messageId: Amity.Message['messageId']): Amity.Message<any> | undefined;
+};
+//# sourceMappingURL=deleteMessage.d.ts.map

package/dist/message/api/getMessage.d.ts

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

package/dist/message/api/getMessages.d.ts

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

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

@@ -0,0 +1,7 @@
+export * from './getMessage';
+export * from './getMessages';
+export * from './queryMessages';
+export * from './createMessage';
+export * from './updateMessage';
+export * from './deleteMessage';
+//# sourceMappingURL=index.d.ts.map

package/dist/message/api/queryMessages.d.ts

@@ -0,0 +1,55 @@
+/**
+ * ```js
+ * import { queryMessages } from '@amityco/ts-sdk'
+ * const messages = await queryMessages({ channelId })
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.Message} objects
+ *
+ * @param query The query parameters
+ * @returns A page of {@link Amity.Message} objects
+ *
+ * @category Message API
+ * @async
+ */
+export declare const queryMessages: {
+    (query: {
+        channelId: Amity.Channel['channelId'];
+        type?: Amity.MessageContentType;
+        parentId?: Amity.Message['parentId'];
+        filterByParentId?: boolean;
+        isDeleted?: boolean;
+        tags?: Amity.Taggable['tags'];
+        excludeTags?: Amity.Taggable['tags'];
+        page?: Amity.Page;
+    }): Promise<{
+        data: Record<string, Amity.Message<any>>;
+        nextPage: Amity.Page | null;
+        prevPage: Amity.Page | null;
+    }>;
+    /**
+     * ```js
+     * import { queryMessages } from '@amityco/ts-sdk'
+     * const messages = queryMessages.locally!({ channelId })
+     * ```
+     *
+     * Queries a paginable list of {@link Amity.Message} objects from cache
+     *
+     * @param query The query parameters
+     * @returns A page of {@link Amity.Message} objects
+     *
+     * @category Message API
+     */
+    locally(query: Parameters<typeof queryMessages>[0]): {
+        data: Record<string, Amity.Message<any>>;
+        nextPage: {
+            after: number;
+            limit: number | undefined;
+        } | undefined;
+        prevPage: {
+            before: number;
+            limit: number | undefined;
+        } | undefined;
+    };
+};
+//# sourceMappingURL=queryMessages.d.ts.map

package/dist/message/api/updateMessage.d.ts

@@ -0,0 +1,38 @@
+/**
+ * ```js
+ * import { updateMessage } from '@amityco/ts-sdk'
+ * const updated = await updateMessage(messageId, {
+ *   data: { text: 'hello world' }
+ * })
+ * ```
+ *
+ * Updates an {@link Amity.Message}
+ *
+ * @param messageId The ID of the {@link Amity.Message} to edit
+ * @param patch The patch data to apply
+ * @returns the updated {@link Amity.Message} object
+ *
+ * @category Message API
+ * @async
+ */
+export declare const updateMessage: {
+    (messageId: Amity.Message['messageId'], patch: Patch<Amity.Message, 'data' | 'metadata'>): Promise<Amity.Message<any>>;
+    /**
+     * ```js
+     * import { updateMessage } from '@amityco/ts-sdk'
+     * const updated = updateMessage.locally('foobar', {
+     *   data: { text: 'hello world' }
+     * })
+     * ```
+     *
+     * Updates an {@link Amity.Message} in cache
+     *
+     * @param messageId The ID of the {@link Amity.Message} to edit
+     * @param patch The patch data to apply
+     * @returns the updated {@link Amity.Message} object
+     *
+     * @category Message API
+     */
+    optimistically(messageId: Amity.Message['messageId'], patch: Patch<Amity.Message, 'data' | 'metadata'>): Amity.Message<any> | undefined;
+};
+//# sourceMappingURL=updateMessage.d.ts.map

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

@@ -0,0 +1,4 @@
+export * from './onMessageCreated';
+export * from './onMessageUpdated';
+export * from './onMessageDeleted';
+//# sourceMappingURL=index.d.ts.map

package/dist/message/events/onMessageCreated.d.ts

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

package/dist/message/events/onMessageDeleted.d.ts

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

package/dist/message/events/onMessageUpdated.d.ts

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

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

@@ -0,0 +1,3 @@
+export { observeMessage } from './observeMessage';
+export { observeMessages } from './observeMessages';
+//# sourceMappingURL=index.d.ts.map

package/dist/message/observers/observeMessage.d.ts

@@ -0,0 +1,22 @@
+/**
+ * ```js
+ * import { observeMessage } from '@amityco/ts-sdk'
+ *
+ * let message = {}
+ * const unsub = observeMessage(messageId, updated => message = updated)
+ * ```
+ *
+ * Observe all mutations on a {@link Amity.Message} given a single messageId
+ *
+ * @param client the client to observe the message with
+ * @param messageId the ID of the message to observe
+ * @param callback the function to call when new data are available
+ * @param policy a query policy option for this observer
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the message
+ *
+ * @category Message Observer
+ */
+export declare const observeMessage: <Events extends ["onFetch", "onUpdate", "onDelete"]>(messageId: Amity.Message['messageId'], callback: Amity.ObjectListener<{
+    data?: Amity.Message<any> | undefined;
+} & Amity.QueryMetadata, Events>, policy?: Amity.QueryPolicy) => Amity.Unsubscriber;
+//# sourceMappingURL=observeMessage.d.ts.map

package/dist/message/observers/observeMessages.d.ts

@@ -0,0 +1,19 @@
+/**
+ * ```js
+ * import { observeMessages } from '@amityco/ts-sdk'
+ *
+ * let messages = []
+ * const unsub = observeMessages(channelId, message => merge(messages, message))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.Message} for a given {@link Amity.Channel} object
+ *
+ * @param client the client to observe the message with
+ * @param channelId the ID of the channel where to observe the messages
+ * @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 Message Observer
+ */
+export declare const observeMessages: (channelId: Amity.Channel['channelId'], callback: Amity.ObjectListener<Amity.Message, ['onCreate', 'onUpdate', 'onDelete']>) => Amity.Unsubscriber;
+//# sourceMappingURL=observeMessages.d.ts.map

package/dist/post/api/createPost.d.ts

@@ -0,0 +1,21 @@
+/**
+ * ```js
+ * import { createPost } from '@amityco/ts-sdk'
+ * const newPost = await createPost(bundle)
+ * ```
+ *
+ * Creates an {@link Amity.Post}
+ *
+ * @param bundle The data necessary to create a new {@link Amity.Post}
+ * @returns The newly created {@link Amity.Post}
+ *
+ * @category Post API
+ * @async
+ */
+export declare const createPost: <T extends string>(bundle: Pick<Amity.Post<any>, "targetType" | "targetId" | "metadata"> & {
+    dataType?: T | undefined;
+    data: {
+        [k: string]: any;
+    };
+}) => Promise<Amity.Post<any>>;
+//# sourceMappingURL=createPost.d.ts.map

package/dist/post/api/deletePost.d.ts

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

package/dist/post/api/getPost.d.ts

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

package/dist/post/api/getPosts.d.ts

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

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

@@ -0,0 +1,7 @@
+export * from './queryPosts';
+export * from './getPosts';
+export * from './getPost';
+export * from './createPost';
+export * from './updatePost';
+export * from './deletePost';
+//# sourceMappingURL=index.d.ts.map

package/dist/post/api/queryPosts.d.ts

@@ -0,0 +1,47 @@
+/**
+ * ```js
+ * import { queryPosts } from '@amityco/ts-sdk'
+ * const posts = await queryPosts({ targetId, targetType })
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.Post} objects
+ *
+ * @param query The query parameters
+ * @returns posts
+ *
+ * @category Post API
+ * @async
+ */
+export declare const queryPosts: {
+    (query: {
+        targetId: string;
+        targetType: Amity.Post['targetType'];
+        sortBy?: 'lastCreated' | 'firstCreated' | 'lastUpdated' | 'firstUpdated';
+        dataType?: string;
+        isDeleted?: Amity.Post['isDeleted'];
+        hasFlag?: boolean;
+        feedType?: 'reviewing' | 'published';
+        tags?: Amity.Taggable['tags'];
+        matchingOnlyParentPost?: boolean;
+        page?: Amity.Page;
+    }): Promise<{
+        data: Record<string, Amity.Post<any>>;
+        nextPage: Amity.Page | null;
+        prevPage: Amity.Page | null;
+    }>;
+    /**
+     * ```js
+     * import { queryPosts } from '@amityco/ts-sdk'
+     * const posts = queryPosts.locally({ targetId, targetType })
+     * ```
+     *
+     * 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 queryPosts>[0]): void;
+};
+//# sourceMappingURL=queryPosts.d.ts.map

package/dist/post/api/queryPosts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryPosts.d.ts","sourceRoot":"","sources":["../../../src/post/api/queryPosts.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU;YACd;QACL,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,IAAI,CAAC,YAAY,CAAC,CAAC;QACrC,MAAM,CAAC,EAAE,aAAa,GAAG,cAAc,GAAG,aAAa,GAAG,cAAc,CAAA;QACxE,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC,WAAW,CAAC,CAAA;QACnC,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,QAAQ,CAAC,EAAE,WAAW,GAAG,WAAW,CAAA;QACpC,IAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC9B,sBAAsB,CAAC,EAAE,OAAO,CAAA;QAChC,IAAI,CAAC,EAAE,MAAM,IAAI,CAAA;KAClB;;;;;IAkCH;;;;;;;;;;;;OAYG;mBAEM,WAAW,iBAAiB,CAAC,CAAC,CAAC,CAAC;CAhBxC,CAAA"}

package/dist/post/api/updatePost.d.ts

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

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

@@ -0,0 +1,4 @@
+export * from './onPostCreated';
+export * from './onPostUpdated';
+export * from './onPostDeleted';
+//# sourceMappingURL=index.d.ts.map

package/dist/post/events/onPostCreated.d.ts

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

package/dist/post/events/onPostDeleted.d.ts

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

package/dist/post/events/onPostUpdated.d.ts

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