@amityco/ts-sdk 0.0.1-be4fc2f.0 → 0.0.1-beta.10

package/dist/reaction/events/onReactionRemoved.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"onReactionRemoved.d.ts","sourceRoot":"","sources":["../../../src/reaction/events/onReactionRemoved.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;IAcI;AACJ,eAAO,MAAM,iBAAiB,kBACb,MAAM,QAAQ,CAAC,eAAe,CAAC,eACjC,MAAM,QAAQ,CAAC,aAAa,CAAC,0FAEzC,MAAM,YAgBR,CAAA"}
+{"version":3,"file":"onReactionRemoved.d.ts","sourceRoot":"","sources":["../../../src/reaction/events/onReactionRemoved.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;IAgBI;AACJ,eAAO,MAAM,iBAAiB,kBACb,MAAM,aAAa,eACrB,MAAM,QAAQ,CAAC,aAAa,CAAC,0FAEzC,MAAM,YAkCR,CAAA"}

package/dist/reaction/utils/fetchReference.d.ts

@@ -1,3 +1,3 @@
 /** @hidden */
-export declare const fetchReference: (referenceType: Amity.ReactableType, referenceId: string) => Promise<Amity.Message<any> | Amity.Post<any> | Amity.Comment<any>>;
+export declare const fetchReference: (referenceType: Amity.ReactableType, referenceId: string) => Promise<Amity.Cached<Amity.Message<any> | Amity.Post<any> | Amity.Comment<any>>>;
 //# sourceMappingURL=fetchReference.d.ts.map

package/dist/reaction/utils/fetchReference.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetchReference.d.ts","sourceRoot":"","sources":["../../../src/reaction/utils/fetchReference.ts"],"names":[],"mappings":"AAIA,cAAc;AACd,eAAO,MAAM,cAAc,kBACV,MAAM,aAAa,eACrB,MAAM,uEAUpB,CAAA"}
+{"version":3,"file":"fetchReference.d.ts","sourceRoot":"","sources":["../../../src/reaction/utils/fetchReference.ts"],"names":[],"mappings":"AAIA,cAAc;AACd,eAAO,MAAM,cAAc,kBACV,MAAM,aAAa,eACrB,MAAM,qFAUpB,CAAA"}

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

@@ -1,3 +1,4 @@
 export * from './dispatchReactable';
 export * from './fetchReference';
+export * from './preparePayloadForCache';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/reaction/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,kBAAkB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/reaction/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,kBAAkB,CAAA;AAChC,cAAc,0BAA0B,CAAA"}

package/dist/reaction/utils/preparePayloadForCache.d.ts

@@ -0,0 +1,3 @@
+/** @hidden */
+export declare const preparePayloadForCache: <T extends "post.addReaction" | "post.removeReaction" | "comment.addReaction" | "comment.removeReaction">(event: T, payload: Amity.Events[T]) => void;
+//# sourceMappingURL=preparePayloadForCache.d.ts.map

package/dist/reaction/utils/preparePayloadForCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"preparePayloadForCache.d.ts","sourceRoot":"","sources":["../../../src/reaction/utils/preparePayloadForCache.ts"],"names":[],"mappings":"AAGA,cAAc;AACd,eAAO,MAAM,sBAAsB,uJAwClC,CAAA"}

package/dist/report/api/createReport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createReport.d.ts","sourceRoot":"","sources":["../../../src/report/api/createReport.ts"],"names":[],"mappings":"AAMA,OAAO,eAAe,MAAM,6BAA6B,CAAA;AAEzD;;;;;;;;;;;;IAYI;AACJ,eAAO,MAAM,YAAY,kBACR,MAAM,sBAAsB,eAC9B,MAAM,qBAoBpB,CAAA"}
+{"version":3,"file":"createReport.d.ts","sourceRoot":"","sources":["../../../src/report/api/createReport.ts"],"names":[],"mappings":"AAKA,OAAO,eAAe,MAAM,6BAA6B,CAAA;AAEzD;;;;;;;;;;;;IAYI;AACJ,eAAO,MAAM,YAAY,kBACR,MAAM,sBAAsB,eAC9B,MAAM,KAClB,QAAQ,OAAO,CAmBjB,CAAA"}

package/dist/report/api/deleteReport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deleteReport.d.ts","sourceRoot":"","sources":["../../../src/report/api/deleteReport.ts"],"names":[],"mappings":"AAKA,OAAO,eAAe,MAAM,6BAA6B,CAAA;AAGzD;;;;;;;;;;;;IAYI;AACJ,eAAO,MAAM,YAAY,kBACR,MAAM,sBAAsB,eAC9B,MAAM,qBAoBpB,CAAA"}
+{"version":3,"file":"deleteReport.d.ts","sourceRoot":"","sources":["../../../src/report/api/deleteReport.ts"],"names":[],"mappings":"AAIA,OAAO,eAAe,MAAM,6BAA6B,CAAA;AAGzD;;;;;;;;;;;;IAYI;AACJ,eAAO,MAAM,YAAY,kBACR,MAAM,sBAAsB,eAC9B,MAAM,KAClB,QAAQ,OAAO,CAmBjB,CAAA"}

package/dist/role/api/getRole.d.ts

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

package/dist/role/api/getRole.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getRole.d.ts","sourceRoot":"","sources":["../../../src/role/api/getRole.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,OAAO;aAAkB,MAAM,IAAI,CAAC,QAAQ,CAAC;IAc1D;;;;;;;;;;;;OAYG;oBACwB,MAAM,IAAI,CAAC,QAAQ,CAAC;CAf9C,CAAA"}
+{"version":3,"file":"getRole.d.ts","sourceRoot":"","sources":["../../../src/role/api/getRole.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,OAAO;aACV,MAAM,IAAI,CAAC,QAAQ,CAAC,GAC3B,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC;IAiBpC;;;;;;;;;;;;OAYG;oBAEO,MAAM,IAAI,CAAC,QAAQ,CAAC,GAC3B,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS;CAjBtC,CAAA"}

package/dist/role/api/queryRoles.d.ts

@@ -18,11 +18,7 @@ export declare const queryRoles: {
         displayName?: string | undefined;
         sortBy?: "displayName" | "firstCreated" | "lastCreated" | undefined;
         page?: Amity.Page | undefined;
-    } | undefined): Promise<{
-        data: Record<string, Amity.Role>;
-        prevPage: Amity.Page | null;
-        nextPage: Amity.Page | null;
-    }>;
+    } | undefined): Promise<Amity.Cached<Amity.Paged<Amity.Role>>>;
     /**
      * ```js
      * import { queryRoles } from '@amityco/ts-sdk'

package/dist/role/api/queryRoles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryRoles.d.ts","sourceRoot":"","sources":["../../../src/role/api/queryRoles.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;IAsCvB;;;;;;;;;;;;;OAaG;mBAC0B,WAAW,iBAAiB,CAAC,CAAC,CAAC,CAAC;CAhB5D,CAAA"}
+{"version":3,"file":"queryRoles.d.ts","sourceRoot":"","sources":["../../../src/role/api/queryRoles.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU;;;;;oBAInB,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;IAiClD;;;;;;;;;;;;;OAaG;mBAC0B,WAAW,iBAAiB,CAAC,CAAC,CAAC,CAAC;CAhB5D,CAAA"}

package/dist/stream/api/createStream.d.ts

@@ -14,5 +14,5 @@
  */
 export declare const createStream: (bundle: Pick<Amity.Stream, 'title' | 'thumbnailFileId' | 'description'> & {
     isSecure?: boolean;
-}) => Promise<Amity.Stream>;
+}) => Promise<Amity.Cached<Amity.Stream>>;
 //# sourceMappingURL=createStream.d.ts.map

package/dist/stream/api/createStream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createStream.d.ts","sourceRoot":"","sources":["../../../src/stream/api/createStream.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,WACf,KAAK,MAAM,MAAM,EAAE,OAAO,GAAG,iBAAiB,GAAG,aAAa,CAAC,GAAG;IAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAE,0BAcjG,CAAA"}
+{"version":3,"file":"createStream.d.ts","sourceRoot":"","sources":["../../../src/stream/api/createStream.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,WACf,KAAK,MAAM,MAAM,EAAE,OAAO,GAAG,iBAAiB,GAAG,aAAa,CAAC,GAAG;IAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAE,KAC/F,QAAQ,MAAM,MAAM,CAAC,MAAM,MAAM,CAAC,CAiBpC,CAAA"}

package/dist/stream/api/deleteStream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deleteStream.d.ts","sourceRoot":"","sources":["../../../src/stream/api/deleteStream.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,aACb,MAAM,MAAM,CAAC,UAAU,CAAC,qBAcnC,CAAA"}
+{"version":3,"file":"deleteStream.d.ts","sourceRoot":"","sources":["../../../src/stream/api/deleteStream.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,aACb,MAAM,MAAM,CAAC,UAAU,CAAC,KACjC,QAAQ,OAAO,CAkBjB,CAAA"}

package/dist/stream/api/disposeStream.d.ts

@@ -13,5 +13,5 @@
  * @category Stream API
  * @async
  */
-export declare const disposeStream: (streamId: Amity.Stream['streamId']) => Promise<Amity.Stream>;
+export declare const disposeStream: (streamId: Amity.Stream['streamId']) => Promise<Amity.Cached<Amity.Stream>>;
 //# sourceMappingURL=disposeStream.d.ts.map

package/dist/stream/api/disposeStream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"disposeStream.d.ts","sourceRoot":"","sources":["../../../src/stream/api/disposeStream.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,aACd,MAAM,MAAM,CAAC,UAAU,CAAC,0BAcnC,CAAA"}
+{"version":3,"file":"disposeStream.d.ts","sourceRoot":"","sources":["../../../src/stream/api/disposeStream.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,aACd,MAAM,MAAM,CAAC,UAAU,CAAC,KACjC,QAAQ,MAAM,MAAM,CAAC,MAAM,MAAM,CAAC,CAiBpC,CAAA"}

package/dist/stream/api/getStream.d.ts

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

package/dist/stream/api/getStream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getStream.d.ts","sourceRoot":"","sources":["../../../src/stream/api/getStream.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,SAAS;eACV,MAAM,MAAM,CAAC,UAAU,CAAC;IAgBpC;;;;;;;;;;;;OAYG;sBAES,MAAM,MAAM,CAAC,UAAU,CAAC;CAhBnC,CAAA"}
+{"version":3,"file":"getStream.d.ts","sourceRoot":"","sources":["../../../src/stream/api/getStream.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,SAAS;eACV,MAAM,MAAM,CAAC,UAAU,CAAC,GACjC,QAAQ,MAAM,MAAM,CAAC,MAAM,MAAM,CAAC,CAAC;IAkBtC;;;;;;;;;;;;OAYG;sBAES,MAAM,MAAM,CAAC,UAAU,CAAC,GACjC,MAAM,MAAM,CAAC,MAAM,MAAM,CAAC,GAAG,SAAS;CAjBrC,CAAA"}

package/dist/stream/api/queryStreams.d.ts

@@ -20,11 +20,7 @@ export declare const queryStreams: {
         sortBy?: "lastCreated" | "firstCreated" | undefined;
         isDeleted?: Amity.Stream['isDeleted'];
         page?: Amity.Page | undefined;
-    } | undefined): Promise<{
-        data: Record<string, Amity.Stream>;
-        prevPage: Amity.Page | null;
-        nextPage: Amity.Page | null;
-    }>;
+    } | undefined): Promise<Amity.Cached<Amity.Paged<Amity.Stream>>>;
     /**
      * ```js
      * import { queryStreams } from '@amityco/ts-sdk'

package/dist/stream/api/queryStreams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryStreams.d.ts","sourceRoot":"","sources":["../../../src/stream/api/queryStreams.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY;;;;;;oBAMT,MAAM,MAAM,CAAC,WAAW,CAAC;;;;;;;IAgCzC;;;;;;;;;;;;OAYG;mBAEM,WAAW,mBAAmB,CAAC,CAAC,CAAC,CAAC;CAhB1C,CAAA"}
+{"version":3,"file":"queryStreams.d.ts","sourceRoot":"","sources":["../../../src/stream/api/queryStreams.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY;;;;;;oBAMT,MAAM,MAAM,CAAC,WAAW,CAAC;;oBAGtC,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,MAAM,CAAC,CAAC,CAAC;IA6BnD;;;;;;;;;;;;OAYG;mBAEM,WAAW,mBAAmB,CAAC,CAAC,CAAC,CAAC;CAhB1C,CAAA"}

package/dist/stream/api/updateStream.d.ts

@@ -13,5 +13,5 @@
  * @category Stream API
  * @async
  */
-export declare const updateStream: (streamId: Amity.Stream['streamId'], patch: Patch<Amity.Stream, 'title' | 'thumbnailFileId' | 'description' | 'metadata'>) => Promise<Amity.Stream>;
+export declare const updateStream: (streamId: Amity.Stream['streamId'], patch: Patch<Amity.Stream, 'title' | 'thumbnailFileId' | 'description' | 'metadata'>) => Promise<Amity.Cached<Amity.Stream>>;
 //# sourceMappingURL=updateStream.d.ts.map

package/dist/stream/api/updateStream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"updateStream.d.ts","sourceRoot":"","sources":["../../../src/stream/api/updateStream.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,YAAY,aACb,MAAM,MAAM,CAAC,UAAU,CAAC,SAC3B,MAAM,MAAM,MAAM,EAAE,OAAO,GAAG,iBAAiB,GAAG,aAAa,GAAG,UAAU,CAAC,0BAerF,CAAA"}
+{"version":3,"file":"updateStream.d.ts","sourceRoot":"","sources":["../../../src/stream/api/updateStream.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,YAAY,aACb,MAAM,MAAM,CAAC,UAAU,CAAC,SAC3B,MAAM,MAAM,MAAM,EAAE,OAAO,GAAG,iBAAiB,GAAG,aAAa,GAAG,UAAU,CAAC,KACnF,QAAQ,MAAM,MAAM,CAAC,MAAM,MAAM,CAAC,CAkBpC,CAAA"}

package/dist/stream/events/onStreamRecorded.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"onStreamRecorded.d.ts","sourceRoot":"","sources":["../../../src/stream/events/onStreamRecorded.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,aACjB,MAAM,QAAQ,CAAC,MAAM,MAAM,CAAC,KACrC,MAAM,YAeR,CAAA"}
+{"version":3,"file":"onStreamRecorded.d.ts","sourceRoot":"","sources":["../../../src/stream/events/onStreamRecorded.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,aACjB,MAAM,QAAQ,CAAC,MAAM,MAAM,CAAC,KACrC,MAAM,YAcR,CAAA"}

package/dist/stream/events/onStreamStarted.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"onStreamStarted.d.ts","sourceRoot":"","sources":["../../../src/stream/events/onStreamStarted.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,eAAe,aAChB,MAAM,QAAQ,CAAC,MAAM,MAAM,CAAC,KACrC,MAAM,YAeR,CAAA"}
+{"version":3,"file":"onStreamStarted.d.ts","sourceRoot":"","sources":["../../../src/stream/events/onStreamStarted.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,eAAe,aAChB,MAAM,QAAQ,CAAC,MAAM,MAAM,CAAC,KACrC,MAAM,YAcR,CAAA"}

package/dist/stream/events/onStreamStopped.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"onStreamStopped.d.ts","sourceRoot":"","sources":["../../../src/stream/events/onStreamStopped.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,eAAe,aAChB,MAAM,QAAQ,CAAC,MAAM,MAAM,CAAC,KACrC,MAAM,YAeR,CAAA"}
+{"version":3,"file":"onStreamStopped.d.ts","sourceRoot":"","sources":["../../../src/stream/events/onStreamStopped.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,eAAe,aAChB,MAAM,QAAQ,CAAC,MAAM,MAAM,CAAC,KACrC,MAAM,YAcR,CAAA"}

package/dist/user/api/getUser.d.ts

@@ -1,7 +1,7 @@
 /**
  * ```js
  * import { getUser } from '@amityco/ts-sdk'
- * const user = await getUser('foobar')
+ * const { data: user } = await getUser('foobar')
  * ```
  *
  * Fetches a {@link Amity.User} object
@@ -13,11 +13,11 @@
  * @async
  */
 export declare const getUser: {
-    (userId: Amity.User['userId']): Promise<Amity.User>;
+    (userId: Amity.User['userId']): Promise<Amity.Cached<Amity.User>>;
     /**
      * ```js
      * import { getUser } from '@amityco/ts-sdk'
-     * const user = getUser.locally('foobar')
+     * const { data: user } = getUser.locally('foobar')
      * ```
      *
      * Fetches a {@link Amity.User} object from cache
@@ -27,6 +27,6 @@ export declare const getUser: {
      *
      * @category User API
      */
-    locally(userId: Amity.User['userId']): Amity.User;
+    locally(userId: Amity.User['userId']): Amity.Cached<Amity.User> | undefined;
 };
 //# sourceMappingURL=getUser.d.ts.map

package/dist/user/api/getUser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getUser.d.ts","sourceRoot":"","sources":["../../../src/user/api/getUser.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,OAAO;aACV,MAAM,IAAI,CAAC,QAAQ,CAAC;IAiB9B;;;;;;;;;;;;OAYG;oBAEO,MAAM,IAAI,CAAC,QAAQ,CAAC;CAhB7B,CAAA"}
+{"version":3,"file":"getUser.d.ts","sourceRoot":"","sources":["../../../src/user/api/getUser.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,OAAO;aACV,MAAM,IAAI,CAAC,QAAQ,CAAC,GAC3B,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC;IAoBpC;;;;;;;;;;;;OAYG;oBAEO,MAAM,IAAI,CAAC,QAAQ,CAAC,GAC3B,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS;CAjBtC,CAAA"}

package/dist/user/api/getUsers.d.ts

@@ -1,7 +1,7 @@
 /**
  * ```js
  * import { getUsers } from '@amityco/ts-sdk'
- * const users = await getUsers(['foo', 'bar'])
+ * const { data: users } = await getUsers(['foo', 'bar'])
  * ```
  *
  * Fetches a collection of {@link Amity.User} objects
@@ -13,11 +13,11 @@
  * @async
  */
 export declare const getUsers: {
-    (userIds: Amity.User['userId'][]): Promise<Record<string, Amity.User>>;
+    (userIds: Amity.User['userId'][]): Promise<Amity.Cached<Amity.User[]>>;
     /**
      * ```js
      * import { getUsers } from '@amityco/ts-sdk'
-     * const users = getUsers.locally!(['foo', 'bar'])
+     * const { data: users } = getUsers.locally!(['foo', 'bar'])
      * ```
      *
      * Fetches a collection of {@link Amity.User} objects from cache
@@ -27,6 +27,6 @@ export declare const getUsers: {
      *
      * @category User API
      */
-    locally(userIds: Amity.User['userId'][]): Record<string, Amity.User> | undefined;
+    locally(userIds: Amity.User['userId'][]): Amity.Cached<Amity.User[]> | undefined;
 };
 //# sourceMappingURL=getUsers.d.ts.map

package/dist/user/api/getUsers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getUsers.d.ts","sourceRoot":"","sources":["../../../src/user/api/getUsers.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,QAAQ;cACV,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE;IAkBjC;;;;;;;;;;;;OAYG;qBAEQ,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE;CAhBhC,CAAA"}
+{"version":3,"file":"getUsers.d.ts","sourceRoot":"","sources":["../../../src/user/api/getUsers.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,QAAQ;cACV,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,GAC9B,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;IAmBtC;;;;;;;;;;;;OAYG;qBAEQ,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,GAC9B,MAAM,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,SAAS;CAjBxC,CAAA"}

package/dist/user/api/queryUsers.d.ts

@@ -1,7 +1,7 @@
 /**
  * ```js
  * import { queryUsers } from '@amityco/ts-sdk'
- * const { users, previous, next } = await queryUsers({ keyword: 'foo' })
+ * const { data: users, prevPage, nextPage } = await queryUsers({ displayName: 'foo' })
  * ```
  *
  * Queries a paginable list of {@link Amity.User} objects
@@ -16,18 +16,14 @@
 export declare const queryUsers: {
     (query?: {
         displayName?: Amity.User['displayName'];
-        filter?: "all" | "flagged" | undefined;
-        sortBy?: "displayName" | "firstCreated" | "lastCreated" | undefined;
-        page?: Amity.Page | undefined;
-    } | undefined): Promise<{
-        data: Record<string, Amity.User>;
-        prevPage: Amity.Page | null;
-        nextPage: Amity.Page | null;
-    }>;
+        filter?: 'all' | 'flagged';
+        sortBy?: 'displayName' | 'firstCreated' | 'lastCreated';
+        page?: Amity.Page;
+    }): Promise<Amity.Cached<Amity.Paged<Amity.User>>>;
     /**
      * ```js
      * import { queryUsers } from '@amityco/ts-sdk'
-     * const users = queryUsers.locally({ keyword: 'foo' })
+     * const { data: users } = queryUsers.locally({ keyword: 'foo' })
      * ```
      *
      * Queries a paginable list of {@link Amity.User} objects from cache
@@ -38,6 +34,6 @@ export declare const queryUsers: {
      *
      * @category User API
      */
-    locally(query: Parameters<typeof queryUsers>[0]): void;
+    locally(query?: Parameters<typeof queryUsers>[0]): Amity.Cached<Amity.Paged<Amity.User>> | undefined;
 };
 //# sourceMappingURL=queryUsers.d.ts.map

package/dist/user/api/queryUsers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryUsers.d.ts","sourceRoot":"","sources":["../../../src/user/api/queryUsers.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU;;sBAEL,MAAM,IAAI,CAAC,aAAa,CAAC;;;;;;;;;IA2C3C;;;;;;;;;;;;;OAaG;mBAEM,WAAW,iBAAiB,CAAC,CAAC,CAAC,CAAC;CAjBxC,CAAA"}
+{"version":3,"file":"queryUsers.d.ts","sourceRoot":"","sources":["../../../src/user/api/queryUsers.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU;aACd;QACL,WAAW,CAAC,EAAE,MAAM,IAAI,CAAC,aAAa,CAAC,CAAA;QACvC,MAAM,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;QAC1B,MAAM,CAAC,EAAE,aAAa,GAAG,cAAc,GAAG,aAAa,CAAA;QACvD,IAAI,CAAC,EAAE,MAAM,IAAI,CAAA;KAClB,GACA,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;IA4CjD;;;;;;;;;;;;;OAaG;oBAEM,WAAW,iBAAiB,CAAC,CAAC,CAAC,CAAC,GACtC,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,SAAS;CAlBnD,CAAA"}

package/dist/user/api/updateUser.d.ts

@@ -13,5 +13,5 @@
  * @category User API
  * @async
  */
-export declare const updateUser: (userId: Amity.User['userId'], patch: Patch<Amity.User, 'displayName' | 'description' | 'avatarFileId' | 'metadata'>) => Promise<Amity.User>;
+export declare const updateUser: (userId: Amity.User['userId'], patch: Patch<Amity.User, 'displayName' | 'description' | 'avatarFileId' | 'metadata'>) => Promise<Amity.Cached<Amity.User>>;
 //# sourceMappingURL=updateUser.d.ts.map

package/dist/user/api/updateUser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"updateUser.d.ts","sourceRoot":"","sources":["../../../src/user/api/updateUser.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU,WACb,MAAM,IAAI,CAAC,QAAQ,CAAC,SACrB,MAAM,MAAM,IAAI,EAAE,aAAa,GAAG,aAAa,GAAG,cAAc,GAAG,UAAU,CAAC,wBAqBtF,CAAA"}
+{"version":3,"file":"updateUser.d.ts","sourceRoot":"","sources":["../../../src/user/api/updateUser.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU,WACb,MAAM,IAAI,CAAC,QAAQ,CAAC,SACrB,MAAM,MAAM,IAAI,EAAE,aAAa,GAAG,aAAa,GAAG,cAAc,GAAG,UAAU,CAAC,KACpF,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,CAwBlC,CAAA"}

package/dist/user/events/onUserFlagCleared.d.ts

@@ -6,7 +6,7 @@
  * })
  * ```
  *
- * Fired when any {@link Amity.User} have been updated
+ * Fired when flags have been cleared for a {@link Amity.User}
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening

package/dist/user/events/onUserFlagged.d.ts

@@ -6,7 +6,7 @@
  * })
  * ```
  *
- * Fired when any {@link Amity.User} have been updated
+ * Fired when a {@link Amity.User} has been flagged
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening

package/dist/user/events/onUserUnflagged.d.ts

@@ -6,7 +6,7 @@
  * })
  * ```
  *
- * Fired when any {@link Amity.User} have been updated
+ * Fired when a flag has been removed from a {@link Amity.User}
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening

package/dist/user/events/onUserUpdated.d.ts

@@ -6,7 +6,7 @@
  * })
  * ```
  *
- * Fired when any {@link Amity.User} have been updated
+ * Fired when a {@link Amity.User} has been updated
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening

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

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/user/events/utils.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,yBAAyB,UAC7B,MAAM,MAAM,qBAAqB,YAC9B,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,uBAgBrC,CAAA"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/user/events/utils.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,yBAAyB,UAC7B,MAAM,MAAM,qBAAqB,YAC9B,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,uBAkBrC,CAAA"}

package/dist/user/observers/observeUser.d.ts

@@ -13,7 +13,5 @@
  * Observe all mutation on a given {@link Amity.User}
  * @category User Observer
  */
-export declare const observeUser: <Events extends ["onFetch", "onUpdate", "onFlagged", "onUnflagged", "onFlagCleared"]>(userId: string, callback: Amity.ObjectListener<{
-    data?: Amity.User | undefined;
-} & Amity.QueryMetadata, Events>) => Amity.Unsubscriber;
+export declare const observeUser: <Events extends ["onFetch", "onUpdate", "onFlagged", "onUnflagged", "onFlagCleared"]>(userId: string, callback: Amity.ObjectListener<Amity.Snapshot<Amity.User>, Events>) => Amity.Unsubscriber;
 //# sourceMappingURL=observeUser.d.ts.map

package/dist/user/observers/observeUser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"observeUser.d.ts","sourceRoot":"","sources":["../../../src/user/observers/observeUser.ts"],"names":[],"mappings":"AAYA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,WAAW,gGACd,MAAM;;qCAEb,MAAM,YAyCR,CAAA"}
+{"version":3,"file":"observeUser.d.ts","sourceRoot":"","sources":["../../../src/user/observers/observeUser.ts"],"names":[],"mappings":"AAYA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,WAAW,gGACd,MAAM,yEAEb,MAAM,YAuCR,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk",
-  "version": "0.0.1-be4fc2f.0",
+  "version": "0.0.1-beta.10",
   "license": "CC-BY-ND-4.0",
   "author": "amity.co <developers@amity.co> (https://amity.co)",
   "description": "Amity Social Cloud Typescript SDK",
@@ -36,6 +36,7 @@
     "@rollup/plugin-replace": "^3.0.0",
     "@types/axios": "^0.14.0",
     "@types/debug": "^4.1.5",
+    "@types/lodash.ismatch": "^4.4.6",
     "@types/node": "^14.0.11",
     "@types/socket.io-client": "^1.4.34",
     "chalk": "^4.1.2",
@@ -45,18 +46,18 @@
     "rollup-plugin-terser": "^7.0.2",
     "rollup-plugin-typescript2": "^0.30.0",
     "tslib": "^2.1.0",
-    "typescript": "^4.4.2"
+    "typescript": "^4.4.4"
   },
   "dependencies": {
     "@react-native-async-storage/async-storage": "^1.15.5",
     "agentkeepalive": "^4.1.3",
-    "axios": "^0.21.1",
+    "axios": "0.21.1",
     "debug": "^4.3.1",
     "js-base64": "^3.6.1",
+    "lodash.ismatch": "^4.4.0",
     "mitt": "^3.0.0",
     "mqtt": "^4.2.8",
     "react-native-uuid": "^2.0.1",
-    "socket.io-client": "2.2.0",
-    "typescript": "^4.4.2"
+    "socket.io-client": "2.2.0"
   }
 }

package/src/@types/core/cache.ts

@@ -3,20 +3,67 @@ export {}
 declare global {
   namespace Amity {
     /**
-     * The typing of cache allows to distribute the typings properly for each values
-     * of T, so that there will be a proper auto-completion for K = "user" or K = "file"
+     * Union of acceptable types for a chunk of cache key.
+     * Recursive type which allow 3 primitives + array or object of them.
+     *
      * @hidden
      */
-    type Cache = {
-      lookup: Record<string, string>,
-    } & {
-      [K in keyof Amity.Model]?: Amity.Store<Amity.Model[K]>
+    type Serializable = (
+      string | number | boolean | undefined | Serializable[] | { [key: string]: Serializable }
+    )
+
+    /**
+     * Cache key description. Similarly to react-query,
+     * the key is an array of serializable values.
+     */
+    type CacheKey = Serializable[]
+
+    /**
+     * Cache entry wrapper. It contains the cached content
+     * itself (data: T) and also several other properties
+     * through CacheOptions to allow fine tuned control.
+     */
+    type CacheEntry<T extends unknown = unknown> = {
+      key: CacheKey
+      data: T
+    } & CacheOptions
+
+    /**
+     * Cache options are separated from CacheEntry for further type
+     * manipulations and passing of options in functions.
+     *
+     * The cache options are:
+     *   - cachedAt(number): used to check is the cached content is still
+     *     considered fresh or not.
+     *
+     *   - offline(boolean): used to determine if the entry must be
+     *     saved in persistent storage on top of the regular caching.
+     */
+    type CacheOptions = {
+      cachedAt: number | undefined
+      offline?: boolean
     }
 
+
     /**
-     * Possible stores should be restricted to the one to fit in cache
-     * @hidden
+     * Minimal CacheEntry alias, used mostly
      */
-    type Domain = keyof Amity.Model
+     type Cached<T extends unknown = unknown> = (
+      T extends (Amity.PagedRaw<any> | Amity.Paged<any>)
+        ? T
+        : { data: T }
+     ) & {
+      cachedAt?: CacheOptions['cachedAt']
+    }
+
+    /**
+     * Main interface for the cache data structure. There's no direct
+     * methods there as we want to keep the object easily serializable
+     * (over JSON.stringify/parse) for simple backup/hydration.
+     */
+    type Cache = {
+      data: Record<string, CacheEntry>
+      persistIf?: (key: CacheKey, data?: any) => boolean
+    }
   }
 }

package/src/@types/core/events.ts

@@ -1,4 +1,4 @@
-import { IConnectPacket, IDisconnectPacket, IPublishPacket } from 'mqtt'
+import { IConnectPacket, IDisconnectPacket, IPublishPacket } from 'mqtt/dist/mqtt'
 
 export {}
 
@@ -6,7 +6,7 @@ declare global {
   namespace Amity {
     type Listener<T = any> = (params: T) => void
 
-    type ObjectListener<T, K extends string[]> = Listener<T> | {
+    type ObjectListener<T, K extends string[]> = {
       onEvent?: (event: K[number], params: T) => void
     } & {
       [P in K[number]]?: Listener<T>
@@ -52,10 +52,7 @@ declare global {
       reconnect: undefined,
     }
 
-    type MqttCommunityMessageEvents = {
-      'community.created': Amity.CommunityPayload,
-      'community.updated': Amity.CommunityPayload
-      'community.deleted': Amity.CommunityPayload
+    type MqttCommunityUserMessageEvents = {
       'community.joined': Amity.CommunityPayload
       'community.left': Amity.CommunityPayload
       'community.userAdded': Amity.CommunityPayload
@@ -64,16 +61,22 @@ declare global {
       'community.userUnbanned': Amity.CommunityPayload
     }
 
+    type MqttCommunityMessageEvents = {
+      'community.created': Amity.CommunityPayload,
+      'community.updated': Amity.CommunityPayload
+      'community.deleted': Amity.CommunityPayload
+    } & MqttCommunityUserMessageEvents
+
     type MqttPostMessageEvents = {
       'post.created': Amity.PostPayload
       'post.updated': Amity.PostPayload
-      'post.afterDeleted': Amity.PostPayload
+      'post.deleted': Amity.PostPayload
       'post.approved': Amity.PostPayload
       'post.declined': Amity.PostPayload
       'post.flagged': Amity.PostPayload
       'post.unflagged': Amity.PostPayload
-      'post.addReaction': Amity.PostPayload
-      'post.removeReaction': Amity.PostPayload
+      'post.addReaction': Amity.PostPayload & { reactor: Amity.Reaction }
+      'post.removeReaction': Amity.PostPayload & { reactor: Amity.Reaction }
     }
 
     type MqttCommentMessageEvents = {
@@ -82,8 +85,8 @@ declare global {
       'comment.deleted': Amity.CommentPayload
       'comment.flagged': Amity.CommentPayload
       'comment.unflagged': Amity.CommentPayload
-      'comment.addReaction': Amity.CommentPayload
-      'comment.removeReaction': Amity.CommentPayload
+      'comment.addReaction': Amity.CommentPayload & { reactor: Amity.Reaction }
+      'comment.removeReaction': Amity.CommentPayload & { reactor: Amity.Reaction }
     }
 
     type MqttUserMessageEvents = {

package/src/@types/core/model.ts

@@ -2,6 +2,8 @@ export {}
 
 declare global {
   namespace Amity {
+    type Domain = keyof Model
+
     /**
      * type map of "domain name -> ASC model"
      * @hidden