@amityco/ts-sdk 0.0.1-beta.3 → 0.0.1-beta.31

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

@@ -16,7 +16,10 @@
  * @async
  */
 export declare const createMessage: {
-    <T extends Amity.MessageContentType>(bundle: Pick<Amity.Message<T>, "type" | "channelId" | "data" | "metadata">): Promise<Amity.Message<any>>;
+    <T extends Amity.MessageContentType>(bundle: Pick<Amity.Message<T>, "type" | "channelId" | "parentId" | "tags" | "metadata" | "mentionees"> & {
+        data?: Amity.ContentData<T> | undefined;
+        fileId?: (T extends "image" | "file" | "video" | "audio" ? string : null) | undefined;
+    }): Promise<Amity.Cached<Amity.Message>>;
     /**
      * ```js
      * import { createMessage } from '@amityco/ts-sdk'
@@ -33,6 +36,6 @@ export declare const createMessage: {
      *
      * @category Message API
      */
-    optimistically(bundle: Pick<Amity.Message, 'channelId' | 'type' | 'data' | 'metadata'>): Amity.Message<any> | undefined;
+    optimistically(bundle: Pick<Amity.Message, 'channelId' | 'parentId' | 'type' | 'data' | 'tags' | 'metadata' | 'mentionees'>): Amity.Cached<Amity.Message> | undefined;
 };
 //# sourceMappingURL=createMessage.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"createMessage.d.ts","sourceRoot":"","sources":["../../../src/message/api/createMessage.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;;IAkB1B;;;;;;;;;;;;;;;OAeG;2BAEO,KAAK,MAAM,OAAO,EAAE,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC;CAnBxE,CAAA"}
+{"version":3,"file":"createMessage.d.ts","sourceRoot":"","sources":["../../../src/message/api/createMessage.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;;;;QAQvB,QAAQ,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,CAAC;IAoBvC;;;;;;;;;;;;;;;OAeG;2BAEO,KACN,MAAM,OAAO,EACb,WAAW,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,YAAY,CAChF,GACA,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,SAAS;CAvBzC,CAAC"}

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

@@ -13,7 +13,7 @@
  * @async
  */
 export declare const deleteMessage: {
-    (messageId: Amity.Message['messageId']): Promise<Amity.Message<any>>;
+    (messageId: Amity.Message['messageId']): Promise<Amity.Message>;
     /**
      * ```js
      * import { deleteMessage } from '@amityco/ts-sdk'
@@ -27,6 +27,6 @@ export declare const deleteMessage: {
      *
      * @category Message API
      */
-    optimistically(messageId: Amity.Message['messageId']): Amity.Message<any> | undefined;
+    optimistically(messageId: Amity.Message['messageId']): Amity.Cached<Amity.Message> | undefined;
 };
 //# sourceMappingURL=deleteMessage.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"deleteMessage.d.ts","sourceRoot":"","sources":["../../../src/message/api/deleteMessage.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa;gBACb,MAAM,OAAO,CAAC,WAAW,CAAC;IAgBvC;;;;;;;;;;;;OAYG;8BAEU,MAAM,OAAO,CAAC,WAAW,CAAC;CAhBtC,CAAA"}
+{"version":3,"file":"deleteMessage.d.ts","sourceRoot":"","sources":["../../../src/message/api/deleteMessage.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa;gBACb,MAAM,OAAO,CAAC,WAAW,CAAC,GACpC,QAAQ,MAAM,OAAO,CAAC;IAgBzB;;;;;;;;;;;;OAYG;8BAEU,MAAM,OAAO,CAAC,WAAW,CAAC,GACpC,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,SAAS;CAjBzC,CAAC"}

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

@@ -13,7 +13,7 @@
  * @async
  */
 export declare const getMessage: {
-    (messageId: Amity.Message['messageId']): Promise<Amity.Message<any>>;
+    (messageId: Amity.Message['messageId'], isLive?: boolean): Promise<Amity.Cached<Amity.Message>>;
     /**
      * ```js
      * import { getMessage } from '@amityco/ts-sdk'
@@ -27,6 +27,6 @@ export declare const getMessage: {
      *
      * @category Message API
      */
-    locally(messageId: Amity.Message['messageId']): Amity.Message<any>;
+    locally(messageId: Amity.Message['messageId']): Amity.Cached<Amity.Message> | undefined;
 };
 //# sourceMappingURL=getMessage.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getMessage.d.ts","sourceRoot":"","sources":["../../../src/message/api/getMessage.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU;gBACV,MAAM,OAAO,CAAC,WAAW,CAAC;IAiBvC;;;;;;;;;;;;OAYG;uBAEU,MAAM,OAAO,CAAC,WAAW,CAAC;CAhBtC,CAAA"}
+{"version":3,"file":"getMessage.d.ts","sourceRoot":"","sources":["../../../src/message/api/getMessage.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU;gBACV,MAAM,OAAO,CAAC,WAAW,CAAC,qBAEpC,QAAQ,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,CAAC;IA0CvC;;;;;;;;;;;;OAYG;uBAEU,MAAM,OAAO,CAAC,WAAW,CAAC,GACpC,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,SAAS;CAjBzC,CAAC"}

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

@@ -13,7 +13,7 @@
  * @async
  */
 export declare const getMessages: {
-    (messageIds: Amity.Message['messageId'][]): Promise<Record<string, Amity.Message<any>>>;
+    (messageIds: Amity.Message['messageId'][]): Promise<Amity.Cached<Amity.Message[]>>;
     /**
      * ```js
      * import { getMessages } from '@amityco/ts-sdk'
@@ -27,6 +27,6 @@ export declare const getMessages: {
      *
      * @category Message API
      */
-    locally(messageIds: Amity.Message['messageId'][]): Record<string, Amity.Message<any>> | undefined;
+    locally(messageIds: Amity.Message['messageId'][]): Amity.Cached<Amity.Message[]> | undefined;
 };
 //# sourceMappingURL=getMessages.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getMessages.d.ts","sourceRoot":"","sources":["../../../src/message/api/getMessages.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,WAAW;iBACV,MAAM,OAAO,CAAC,WAAW,CAAC,EAAE;IAkB1C;;;;;;;;;;;;OAYG;wBAEW,MAAM,OAAO,CAAC,WAAW,CAAC,EAAE;CAhBzC,CAAA"}
+{"version":3,"file":"getMessages.d.ts","sourceRoot":"","sources":["../../../src/message/api/getMessages.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,WAAW;iBACV,MAAM,OAAO,CAAC,WAAW,CAAC,EAAE,GACvC,QAAQ,MAAM,MAAM,CAAC,MAAM,OAAO,EAAE,CAAC,CAAC;IAsBzC;;;;;;;;;;;;OAYG;wBAEW,MAAM,OAAO,CAAC,WAAW,CAAC,EAAE,GACvC,MAAM,MAAM,CAAC,MAAM,OAAO,EAAE,CAAC,GAAG,SAAS;CAjB3C,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/message/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/message/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC"}

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

@@ -13,20 +13,7 @@
  * @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;
-    }>;
+    (query: Amity.QueryMessages): Promise<Amity.Cached<Amity.Paged<Amity.Message>>>;
     /**
      * ```js
      * import { queryMessages } from '@amityco/ts-sdk'
@@ -40,16 +27,6 @@ export declare const queryMessages: {
      *
      * @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;
-    };
+    locally(query: Parameters<typeof queryMessages>[0]): Amity.Cached<Amity.Paged<Amity.Message>> | undefined;
 };
 //# sourceMappingURL=queryMessages.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"queryMessages.d.ts","sourceRoot":"","sources":["../../../src/message/api/queryMessages.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa;YAAiB;QACzC,SAAS,EAAE,MAAM,OAAO,CAAC,WAAW,CAAC,CAAA;QACrC,IAAI,CAAC,EAAE,MAAM,kBAAkB,CAAA;QAC/B,QAAQ,CAAC,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,CAAA;QACpC,gBAAgB,CAAC,EAAE,OAAO,CAAA;QAC1B,SAAS,CAAC,EAAE,OAAO,CAAA;QACnB,IAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAA;QAC7B,WAAW,CAAC,EAAE,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAA;QACpC,IAAI,CAAC,EAAE,MAAM,IAAI,CAAA;KAClB;;;;;IAkCD;;;;;;;;;;;;OAYG;mBAC6B,WAAW,oBAAoB,CAAC,CAAC,CAAC,CAAC;;;;;;;;;;;CAflE,CAAA"}
+{"version":3,"file":"queryMessages.d.ts","sourceRoot":"","sources":["../../../src/message/api/queryMessages.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa;YACjB,MAAM,aAAa,GACzB,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC;IAiDpD;;;;;;;;;;;;OAYG;mBAEM,WAAW,oBAAoB,CAAC,CAAC,CAAC,CAAC,GACzC,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,OAAO,CAAC,CAAC,GAAG,SAAS;CAjBtD,CAAC"}

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

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

package/dist/message/api/tests/createMessage.test.d.ts.map

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

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

@@ -16,7 +16,7 @@
  * @async
  */
 export declare const updateMessage: {
-    (messageId: Amity.Message['messageId'], patch: Patch<Amity.Message, 'data' | 'metadata'>): Promise<Amity.Message<any>>;
+    (messageId: Amity.Message['messageId'], patch: Patch<Amity.Message, 'data' | 'tags' | 'metadata' | 'mentionees'>): Promise<Amity.Cached<Amity.Message>>;
     /**
      * ```js
      * import { updateMessage } from '@amityco/ts-sdk'
@@ -33,6 +33,6 @@ export declare const updateMessage: {
      *
      * @category Message API
      */
-    optimistically(messageId: Amity.Message['messageId'], patch: Patch<Amity.Message, 'data' | 'metadata'>): Amity.Message<any> | undefined;
+    optimistically(messageId: Amity.Message['messageId'], patch: Patch<Amity.Message, 'data' | 'tags' | 'metadata' | 'mentionees'>): Amity.Cached<Amity.Message> | undefined;
 };
 //# sourceMappingURL=updateMessage.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"updateMessage.d.ts","sourceRoot":"","sources":["../../../src/message/api/updateMessage.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;gBACb,MAAM,OAAO,CAAC,WAAW,CAAC,SAC9B,MAAM,MAAM,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC;IAgBlD;;;;;;;;;;;;;;;OAeG;8BAEU,MAAM,OAAO,CAAC,WAAW,CAAC,SAC9B,MAAM,MAAM,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC;CApBjD,CAAA"}
+{"version":3,"file":"updateMessage.d.ts","sourceRoot":"","sources":["../../../src/message/api/updateMessage.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;gBACb,MAAM,OAAO,CAAC,WAAW,CAAC,SAC9B,MAAM,MAAM,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,YAAY,CAAC,GACvE,QAAQ,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,CAAC;IAsBvC;;;;;;;;;;;;;;;OAeG;8BAEU,MAAM,OAAO,CAAC,WAAW,CAAC,SAC9B,MAAM,MAAM,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,YAAY,CAAC,GACvE,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,SAAS;CArBzC,CAAC"}

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/message/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/message/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"onMessageCreated.d.ts","sourceRoot":"","sources":["../../../src/message/events/onMessageCreated.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,aACjB,MAAM,QAAQ,CAAC,MAAM,OAAO,CAAC,KACtC,MAAM,YAeR,CAAA"}
+{"version":3,"file":"onMessageCreated.d.ts","sourceRoot":"","sources":["../../../src/message/events/onMessageCreated.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,aAAc,MAAM,QAAQ,CAAC,MAAM,OAAO,CAAC,KAAG,MAAM,YAShF,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"onMessageDeleted.d.ts","sourceRoot":"","sources":["../../../src/message/events/onMessageDeleted.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,aACjB,MAAM,QAAQ,CAAC,MAAM,OAAO,CAAC,KACtC,MAAM,YAeR,CAAA"}
+{"version":3,"file":"onMessageDeleted.d.ts","sourceRoot":"","sources":["../../../src/message/events/onMessageDeleted.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,aAAc,MAAM,QAAQ,CAAC,MAAM,OAAO,CAAC,KAAG,MAAM,YAShF,CAAC"}

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

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onMessageFetched } from '@amityco/ts-sdk'
+ * const dispose = onMessageFetched(message => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when an {@link Amity.Message} has been fetched
+ *
+ * @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 onMessageFetched: (callback: Amity.Listener<Amity.Message>) => Amity.Unsubscriber;
+//# sourceMappingURL=onMessageFetched.d.ts.map

package/dist/message/events/onMessageFetched.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onMessageFetched.d.ts","sourceRoot":"","sources":["../../../src/message/events/onMessageFetched.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,aAAc,MAAM,QAAQ,CAAC,MAAM,OAAO,CAAC,KAAG,MAAM,YAShF,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"onMessageUpdated.d.ts","sourceRoot":"","sources":["../../../src/message/events/onMessageUpdated.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,aACjB,MAAM,QAAQ,CAAC,MAAM,OAAO,CAAC,KACtC,MAAM,YAeR,CAAA"}
+{"version":3,"file":"onMessageUpdated.d.ts","sourceRoot":"","sources":["../../../src/message/events/onMessageUpdated.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,aAAc,MAAM,QAAQ,CAAC,MAAM,OAAO,CAAC,KAAG,MAAM,YAgBhF,CAAC"}

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/message/observers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/message/observers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC"}

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

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

package/dist/message/observers/liveMessage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"liveMessage.d.ts","sourceRoot":"","sources":["../../../src/message/observers/liveMessage.ts"],"names":[],"mappings":"AAYA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,WAAW,cACX,MAAM,OAAO,CAAC,WAAW,CAAC,YAC3B,MAAM,kBAAkB,CAAC,MAAM,OAAO,CAAC,KAChD,MAAM,YAoER,CAAC"}

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

@@ -0,0 +1,20 @@
+/**
+ * ```js
+ * import { liveMessages } from '@amityco/ts-sdk'
+ *
+ * let messages = []
+ * const unsub = liveMessages({
+ *   channelId: Amity.Channel['channelId'];
+ * }, response => merge(messages, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.Message} for a given target object
+ *
+ * @param params for querying memssages from a channel
+ * @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 Messages Live Collection
+ */
+export declare const liveMessages: (params: Amity.MessagesLiveCollection, callback: Amity.LiveCollectionCallback<Amity.Message>, config?: Amity.LiveCollectionConfig) => Amity.Unsubscriber;
+//# sourceMappingURL=liveMessages.d.ts.map

package/dist/message/observers/liveMessages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"liveMessages.d.ts","sourceRoot":"","sources":["../../../src/message/observers/liveMessages.ts"],"names":[],"mappings":"AAeA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,YAAY,WACf,MAAM,sBAAsB,YAC1B,MAAM,sBAAsB,CAAC,MAAM,OAAO,CAAC,WAC5C,MAAM,oBAAoB,KAClC,MAAM,YAyGR,CAAC"}

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

@@ -16,7 +16,5 @@
  *
  * @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;
+export declare const observeMessage: <Events extends ["onFetch", "onUpdate", "onDelete"]>(messageId: Amity.Message['messageId'], callback: Amity.ObjectListener<Amity.Snapshot<Amity.Message<any>>, Events>, policy?: Amity.QueryPolicy) => Amity.Unsubscriber;
 //# sourceMappingURL=observeMessage.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"observeMessage.d.ts","sourceRoot":"","sources":["../../../src/message/observers/observeMessage.ts"],"names":[],"mappings":"AAWA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,cAAc,kEACd,MAAM,OAAO,CAAC,WAAW,CAAC;;2CAE7B,MAAM,WAAW,KACxB,MAAM,YA0CR,CAAA"}
+{"version":3,"file":"observeMessage.d.ts","sourceRoot":"","sources":["../../../src/message/observers/observeMessage.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,cAAc,kEACd,MAAM,OAAO,CAAC,WAAW,CAAC,uFAE7B,MAAM,WAAW,KACxB,MAAM,YAyCR,CAAC"}

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

@@ -8,12 +8,15 @@
  *
  * 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;
+export declare const observeMessages: (channelId: Amity.Channel['channelId'], callback: Amity.ObjectListener<Amity.Snapshot<Amity.Message>, [
+    'onCreate',
+    'onUpdate',
+    'onDelete'
+]>) => Amity.Unsubscriber;
 //# sourceMappingURL=observeMessages.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"observeMessages.d.ts","sourceRoot":"","sources":["../../../src/message/observers/observeMessages.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,eAAe,cACf,MAAM,OAAO,CAAC,WAAW,CAAC,YAC3B,MAAM,cAAc,CAAC,MAAM,OAAO,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,KAClF,MAAM,YA+BR,CAAA"}
+{"version":3,"file":"observeMessages.d.ts","sourceRoot":"","sources":["../../../src/message/observers/observeMessages.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,eAAe,cACf,MAAM,OAAO,CAAC,WAAW,CAAC,YAC3B,MAAM,cAAc,CAC5B,MAAM,QAAQ,CAAC,MAAM,OAAO,CAAC,EAC7B;IAAC,UAAU;IAAE,UAAU;IAAE,UAAU;CAAC,CACrC,KACA,MAAM,YA8BR,CAAC"}

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

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

package/dist/message/tests/api/getMessage.test.d.ts.map

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

package/dist/message/tests/observers/liveMessage.test.d.ts

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

package/dist/message/tests/observers/liveMessage.test.d.ts.map

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

package/dist/message/tests/observers/liveMessages.test.d.ts

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

package/dist/message/tests/observers/liveMessages.test.d.ts.map

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

package/dist/poll/api/closePoll.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ```js
+ * import { closePoll } from '@amityco/ts-sdk'
+ * const updated = await closePoll(pollId)
+ * ```
+ *
+ * Updates an {@link Amity.Poll}
+ *
+ * @param pollId The ID of the {@link Amity.Poll} to close
+ * @returns the updated {@link Amity.Poll} object
+ *
+ * @category Poll API
+ * @async
+ */
+export declare const closePoll: (pollId: Amity.Poll['pollId']) => Promise<Amity.Cached<Amity.Poll>>;
+//# sourceMappingURL=closePoll.d.ts.map

package/dist/poll/api/closePoll.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"closePoll.d.ts","sourceRoot":"","sources":["../../../src/poll/api/closePoll.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,SAAS,WACZ,MAAM,IAAI,CAAC,QAAQ,CAAC,KAC3B,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,CAoBlC,CAAC"}

package/dist/poll/api/createPoll.d.ts

@@ -0,0 +1,25 @@
+/**
+ * ```js
+ * import { createPoll } from '@amityco/ts-sdk'
+ * const created = await createPoll({
+ *   question: 'question',
+ *   answers: [
+ *      { dataType: 'text', data: 'answer1' },
+ *      { dataType: 'text', data: 'answer2' },
+ *   ],
+ *   closedIn: 1649136484
+ * }))
+ * ```
+ *
+ * Creates an {@link Amity.Poll}
+ *
+ * @param bundle The data necessary to create a new {@link Amity.Poll}
+ * @returns The newly created {@link Amity.Poll}
+ *
+ * @category Poll API
+ * @async
+ */
+export declare const createPoll: (bundle: Pick<Amity.Poll, 'question' | 'answerType' | 'closedIn'> & {
+    answers: Pick<Amity.PollAnswer, 'dataType' | 'data'>[];
+}) => Promise<Amity.Cached<Amity.Poll>>;
+//# sourceMappingURL=createPoll.d.ts.map

package/dist/poll/api/createPoll.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPoll.d.ts","sourceRoot":"","sources":["../../../src/poll/api/createPoll.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,UAAU,WACb,KAAK,MAAM,IAAI,EAAE,UAAU,GAAG,YAAY,GAAG,UAAU,CAAC,GAAG;IACjE,OAAO,EAAE,KAAK,MAAM,UAAU,EAAE,UAAU,GAAG,MAAM,CAAC,EAAE,CAAC;CACxD,KACA,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,CAelC,CAAC"}

package/dist/poll/api/deletePoll.d.ts

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

package/dist/poll/api/deletePoll.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deletePoll.d.ts","sourceRoot":"","sources":["../../../src/poll/api/deletePoll.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU,WAAkB,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAG,QAAQ,OAAO,CAiB9E,CAAC"}

package/dist/poll/api/getPoll.d.ts

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

package/dist/poll/api/getPoll.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPoll.d.ts","sourceRoot":"","sources":["../../../src/poll/api/getPoll.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,OAAO;aAAkB,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC;IAiB9F;;;;;;;;;;;;OAYG;oBACwB,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS;CAfrF,CAAC"}

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

@@ -0,0 +1,6 @@
+export * from './getPoll';
+export * from './createPoll';
+export * from './closePoll';
+export * from './deletePoll';
+export * from './votePoll';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/poll/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAE1B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAE7B,cAAc,YAAY,CAAC"}

package/dist/poll/api/votePoll.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { votePoll } from '@amityco/ts-sdk'
+ * const voted = await votePoll(pollId)
+ * ```
+ *
+ * Votes for an {@link Amity.Poll}
+ *
+ * @param pollId The ID of the {@link Amity.Poll} to vote
+ * @param answerIds The IDs of the {@link Amity.Poll} answers to vote {@link Amity.Poll}
+ * @returns the updated {@link Amity.Poll} object
+ *
+ * @category Poll API
+ * @async
+ */
+export declare const votePoll: (pollId: Amity.Poll['pollId'], answerIds: string[]) => Promise<Amity.Cached<Amity.Poll>>;
+//# sourceMappingURL=votePoll.d.ts.map

package/dist/poll/api/votePoll.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"votePoll.d.ts","sourceRoot":"","sources":["../../../src/poll/api/votePoll.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,QAAQ,WACX,MAAM,IAAI,CAAC,QAAQ,CAAC,aACjB,MAAM,EAAE,KAClB,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,CAoBlC,CAAC"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/poll/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC"}

package/dist/poll/events/onPollDeleted.d.ts

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

package/dist/poll/events/onPollDeleted.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onPollDeleted.d.ts","sourceRoot":"","sources":["../../../src/poll/events/onPollDeleted.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,aAAc,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,KAAG,MAAM,YAU1E,CAAC"}

package/dist/poll/events/onPollUpdated.d.ts

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

package/dist/poll/events/onPollUpdated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onPollUpdated.d.ts","sourceRoot":"","sources":["../../../src/poll/events/onPollUpdated.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,aAAc,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,KAAG,MAAM,YAU1E,CAAC"}

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

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

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

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

package/dist/poll/observers/observePoll.d.ts

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

package/dist/poll/observers/observePoll.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"observePoll.d.ts","sourceRoot":"","sources":["../../../src/poll/observers/observePoll.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,WAAW,+DACd,MAAM,2FAEN,MAAM,WAAW,KACxB,MAAM,YAsCR,CAAC"}

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

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { approvePost } from '@amityco/ts-sdk'
+ *
+ * const { data: post } = await approvePost('postId')
+ * ```
+ *
+ * Approves a {@link Amity.Post}
+ *
+ * @param postId The {@link Amity.Post} ID to be approved
+ * @return A {@link Amity.Post} that was approved
+ *
+ * @category Post API
+ * @async
+ */
+export declare const approvePost: (postId: Amity.Post['postId']) => Promise<Amity.Cached<Amity.Post>>;
+//# sourceMappingURL=approvePost.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"approvePost.d.ts","sourceRoot":"","sources":["../../../src/post/api/approvePost.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,WAAW,WACd,MAAM,IAAI,CAAC,QAAQ,CAAC,KAC3B,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,CAyBlC,CAAC"}