@amityco/ts-sdk 0.0.1-db940b9.0 → 0.0.1-e26de88.0

package/.eslintrc.json

@@ -0,0 +1,51 @@
+{
+  "overrides": [
+    {
+      "files": [ "**/*.ts?(x)" ],
+      "extends": [
+        "plugin:@typescript-eslint/recommended",
+        "eko"
+      ],
+      "plugins": ["prettier", "import"],
+      "parser": "@typescript-eslint/parser",
+      "parserOptions": {
+        "project": "./tsconfig.json",
+        "ecmaFeatures": {
+          "jsx": true,
+          "ts": true,
+          "tsx": true
+        }
+      },
+      "rules": {
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-non-null-assertion": "off",
+        "@typescript-eslint/no-non-null-asserted-optional-chain": "off",
+        "@typescript-eslint/no-namespace": ["error", { "allowDeclarations": true }],
+        "no-unused-vars": "off",
+        "no-shadow": "off",
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "default-param-last": "off",
+        "@typescript-eslint/ban-ts-comment": "off",
+        "import/no-unresolved": "off",
+        "import/extensions": "off",
+        "@typescript-eslint/no-unsafe-call": "off",
+        "@typescript-eslint/no-unused-vars": "off",
+        "@typescript-eslint/no-unnecessary-type-constraint": "off"
+      },
+      "settings": {
+        "import/resolver": {
+          "node": {
+            "extensions": [".js", ".jsx", ".ts", ".tsx"]
+          },
+          "typescript": {}
+        }
+      },
+      "globals": {
+        "Amity": true,
+        "SocketIOClient": true,
+        "Patch": true,
+        "NodeJS": true
+      }
+    }
+  ]
+}

package/README.md

@@ -26,12 +26,12 @@ import {
 } from '@amityco/ts-sdk'
 
 (async () => {
-  const client = createClient(API_KEY, API_ENDPOINT)
+  const client = createClient(API_KEY, API_REGION)
   let isConnected = await connectClient({ userId: USER_ID })
 })()
 ```
 
-The `API_KEY` and `API_ENDPOINT` are given at the time you create an application in the [Amity Portal](http://portal.amity.co/).
+The `API_KEY` and `API_REGION` are given at the time you create an application in the [Amity Portal](http://portal.amity.co/).
 
 You can listen to disconnection by using the `onClientDisconnected` function:
 
@@ -61,7 +61,7 @@ import {
 } from '@amityco/ts-sdk'
 
 (async () => {
-  const client = createClient(API_KEY, API_ENDPOINT)
+  const client = createClient(API_KEY, API_REGION)
   enableCache()
 
   let isConnected = await connectClient({ userId: USER_ID })
@@ -90,7 +90,7 @@ import { getUser } from '@amityco/ts-sdk'
 
 To query things _"offline-first"_, you'll have to wrap the function into a `Amity.Query` object. The query can then be passed into the `runQuery` function which will control the flow of your query, working around with the cache to pull data the fastest possible.
 
-The `runQuery` function will call your callback as soon as a value is available, and the returned result will be wrapped in a `Amity.QueryResult<T>`, containing additional `error?: Error` and `loading?: boolean` properties which you can use to control the state of your application.
+The `runQuery` function will call your callback as soon as a value is available, and the returned result will be wrapped in a `Amity.Snapshot<T>`, containing additional `error?: Error` and `loading?: boolean` properties which you can use to control the state of your application.
 
 ```ts
 import {
@@ -125,7 +125,7 @@ For an _'all-in-one'_ approach, we expose _observer_ functions, which allow to f
 import { observeUser } from '@amityco/ts-sdk'
 
 const Component = ({ userId }: { userId: string }) => {
-  const [{ data: user }, setData] = useState<Amity.QueryResult<Amity.User>>({})
+  const [{ data: user }, setData] = useState<Amity.Snapshot<Amity.User>>({})
   useEffect(() => observeUser(userId, setData), [userId])
 
   return <div>{JSON.stringify(user, null, 2)}

package/dist/@types/core/cache.d.ts

@@ -2,20 +2,60 @@ 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;
         };
         /**
-         * Possible stores should be restricted to the one to fit in cache
-         * @hidden
+         * Cache key description. Similarly to react-query,
+         * the key is an array of serializable values.
+         */
+        type CacheKey = Serializable[];
+        /**
+         * 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;
+        };
+        /**
+         * Cache entry wrapper. It contains the cached content
+         * itself (data: T) and also several other properties
+         * through CacheOptions to allow fine tuned control.
          */
-        type Domain = keyof Amity.Model;
+        type CacheEntry<T extends unknown = unknown> = {
+            key: CacheKey;
+            data: T;
+        } & CacheOptions;
+        /**
+         * Minimal CacheEntry alias, used mostly
+         */
+        type Cached<T extends unknown = unknown> = (T extends Amity.Paged<any, infer K> ? 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;
+        };
     }
 }
 //# sourceMappingURL=cache.d.ts.map

package/dist/@types/core/cache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../../src/@types/core/cache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAA;AAET,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd;;;;WAIG;QACH,KAAK,KAAK,GAAG;YACX,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SAChC,GAAG;aACD,CAAC,IAAI,MAAM,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SACvD,CAAA;QAED;;;WAGG;QACH,KAAK,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAAA;KAChC;CACF"}
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../../src/@types/core/cache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC;AAEV,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd;;;;;WAKG;QACH,KAAK,YAAY,GACb,MAAM,GACN,MAAM,GACN,OAAO,GACP,SAAS,GACT,YAAY,EAAE,GACd;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;SAAE,CAAC;QAEpC;;;WAGG;QACH,KAAK,QAAQ,GAAG,YAAY,EAAE,CAAC;QAE/B;;;;;;;;;;WAUG;QACH,KAAK,YAAY,GAAG;YAClB,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;YAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;SACnB,CAAC;QAEF;;;;WAIG;QACH,KAAK,UAAU,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI;YAC7C,GAAG,EAAE,QAAQ,CAAC;YACd,IAAI,EAAE,CAAC,CAAC;SACT,GAAG,YAAY,CAAC;QAEjB;;WAEG;QACH,KAAK,MAAM,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,CAAC,SAAS,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,GAC3E,CAAC,GACD;YAAE,IAAI,EAAE,CAAC,CAAA;SAAE,CAAC,GAAG;YACjB,QAAQ,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC;SACpC,CAAC;QAEF;;;;WAIG;QACH,KAAK,KAAK,GAAG;YACX,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YACjC,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC;SACpD,CAAC;KACH;CACF"}

package/dist/@types/core/errors.d.ts

@@ -5,7 +5,6 @@ declare global {
             ERROR = "error",
             FATAL = "fatal"
         }
-        type ErrorCode = ServerError | ClientError;
         const enum ServerError {
             BAD_REQUEST = 400000,
             UNAUTHORIZED = 400100,
@@ -30,6 +29,7 @@ declare global {
             CONNECTION_ERROR = 800210,
             DISCONNECTED = 800211
         }
+        type ErrorCode = ServerError | ClientError;
     }
 }
 //# sourceMappingURL=errors.d.ts.map

package/dist/@types/core/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/@types/core/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAA;AAET,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,WAAW,UAAU;YACnB,KAAK,UAAU;YACf,KAAK,UAAU;SAChB;QAED,KAAK,SAAS,GAAG,WAAW,GAAG,WAAW,CAAA;QAE1C,WAAW,WAAW;YACpB,WAAW,SAAS;YACpB,YAAY,SAAS;YACrB,iBAAiB,SAAS;YAC1B,cAAc,SAAS;YACvB,QAAQ,SAAS;YACjB,SAAS,SAAS;YAClB,aAAa,SAAS;YACtB,gBAAgB,SAAS;YACzB,WAAW,SAAS;YACpB,UAAU,SAAS;YACnB,0BAA0B,SAAS;YACnC,uBAAuB,SAAS;YAChC,cAAc,SAAS;YACvB,gBAAgB,SAAS;YACzB,cAAc,SAAS;SACxB;QAED,WAAW,WAAW;YACpB,aAAa,SAAS;YACtB,kBAAkB,SAAS;YAC3B,iBAAiB,SAAS;YAC1B,gBAAgB,SAAS;YACzB,YAAY,SAAS;SACtB;KACF;CACF"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/@types/core/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC;AAEV,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,WAAW,UAAU;YACnB,KAAK,UAAU;YACf,KAAK,UAAU;SAChB;QAED,WAAW,WAAW;YACpB,WAAW,SAAS;YACpB,YAAY,SAAS;YACrB,iBAAiB,SAAS;YAC1B,cAAc,SAAS;YACvB,QAAQ,SAAS;YACjB,SAAS,SAAS;YAClB,aAAa,SAAS;YACtB,gBAAgB,SAAS;YACzB,WAAW,SAAS;YACpB,UAAU,SAAS;YACnB,0BAA0B,SAAS;YACnC,uBAAuB,SAAS;YAChC,cAAc,SAAS;YACvB,gBAAgB,SAAS;YACzB,cAAc,SAAS;SACxB;QAED,WAAW,WAAW;YACpB,aAAa,SAAS;YACtB,kBAAkB,SAAS;YAC3B,iBAAiB,SAAS;YAC1B,gBAAgB,SAAS;YACzB,YAAY,SAAS;SACtB;QAED,KAAK,SAAS,GAAG,WAAW,GAAG,WAAW,CAAC;KAC5C;CACF"}

package/dist/@types/core/events.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+import { IConnectPacket, IDisconnectPacket, IPublishPacket } from 'mqtt/dist/mqtt';
 export {};
 declare global {
     namespace Amity {
@@ -9,13 +11,12 @@ declare global {
         });
         type Unsubscriber = () => void;
         type Subscriber<T = any> = (fn: Amity.Listener<T>) => Unsubscriber;
-        type Events = {
+        type WsEvents = {
             disconnected: Amity.ErrorResponse | undefined;
             error: Amity.ErrorResponse | undefined;
             connect_error: Amity.ErrorResponse | undefined;
             reconnect_error: Amity.ErrorResponse | undefined;
             reconnect_failed: Amity.ErrorResponse | undefined;
-            'v3.user.didUpdate': Amity.UserPayload;
             'v3.channel.didCreate': Amity.ChannelPayload;
             'v3.channel.didUpdate': Amity.ChannelPayload;
             'v3.channel.didDelete': Amity.ChannelPayload;
@@ -31,20 +32,74 @@ declare global {
             'video-streaming.didRecord': Amity.StreamPayload;
             'video-streaming.didStart': Amity.StreamPayload;
             'video-streaming.didStop': Amity.StreamPayload;
-            'v3.community.didCreate': Amity.CommunityPayload;
-            'v3.community.didUpdate': Amity.CommunityPayload;
-            'v3.community.didDelete': Amity.CommunityPayload;
-            'v3.community.didJoin': Amity.CommunityPayload;
-            'v3.community.didLeave': Amity.CommunityPayload;
-            'v3.community.didAddUsers': Amity.CommunityPayload;
-            'v3.community.didRemoveUsers': Amity.CommunityPayload;
-            'v3.post.didCreate': Amity.PostPayload;
-            'v3.post.didUpdate': Amity.PostPayload;
-            'v3.post.didDelete': Amity.PostPayload;
-            'v3.comment.didCreate': Amity.CommentPayload;
-            'v3.comment.didUpdate': Amity.CommentPayload;
-            'v3.comment.didDelete': Amity.CommentPayload;
         };
+        type MqttEvents = {
+            connect: IConnectPacket;
+            message: [topic: string, payload: Buffer, packet: IPublishPacket];
+            disconnect: IDisconnectPacket;
+            error: Error;
+            close: Error;
+            end: undefined;
+            reconnect: undefined;
+        };
+        type MqttCommunityUserMessageEvents = {
+            'community.joined': Amity.CommunityMembershipPayload;
+            'community.left': Amity.CommunityMembershipPayload;
+            'community.userAdded': Amity.CommunityMembershipPayload;
+            'community.userRemoved': Amity.CommunityMembershipPayload;
+            'community.userBanned': Amity.CommunityMembershipPayload;
+            'community.userUnbanned': Amity.CommunityMembershipPayload;
+        };
+        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.deleted': Amity.PostPayload;
+            'post.approved': Amity.PostPayload;
+            'post.declined': Amity.PostPayload;
+            'post.flagged': Amity.PostPayload;
+            'post.unflagged': Amity.PostPayload;
+            'post.addReaction': Amity.PostPayload & {
+                reactor: Amity.Reaction;
+            };
+            'post.removeReaction': Amity.PostPayload & {
+                reactor: Amity.Reaction;
+            };
+        };
+        type MqttCommentMessageEvents = {
+            'comment.created': Amity.CommentPayload;
+            'comment.updated': Amity.CommentPayload;
+            'comment.deleted': Amity.CommentPayload;
+            'comment.flagged': Amity.CommentPayload;
+            'comment.unflagged': Amity.CommentPayload;
+            'comment.addReaction': Amity.CommentPayload & {
+                reactor: Amity.Reaction;
+            };
+            'comment.removeReaction': Amity.CommentPayload & {
+                reactor: Amity.Reaction;
+            };
+        };
+        type MqttUserMessageEvents = {
+            'user.updated': Amity.UserPayload;
+            'user.flagged': Amity.UserPayload;
+            'user.unflagged': Amity.UserPayload;
+            'user.flagCleared': Amity.UserPayload;
+        };
+        type MqttFollowMessageEvents = {
+            'follow.created': Amity.FollowStatus;
+            'follow.requested': Amity.FollowStatus;
+            'follow.accepted': Amity.FollowStatus;
+            'follow.unfollowed': Amity.FollowStatus;
+            'follow.requestCanceled': Amity.FollowStatus;
+            'follow.requestDeclined': Amity.FollowStatus;
+            'follow.followerDeleted': Amity.FollowStatus;
+        };
+        type MqttMessageEvents = MqttCommunityMessageEvents & MqttPostMessageEvents & MqttCommentMessageEvents & MqttUserMessageEvents & MqttFollowMessageEvents;
+        type Events = WsEvents & MqttEvents & MqttMessageEvents;
     }
 }
 //# sourceMappingURL=events.d.ts.map

package/dist/@types/core/events.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../src/@types/core/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAA;AAET,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,KAAK,QAAQ,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI,CAAA;QAE5C,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,EAAE,IAAI,QAAQ,CAAC,CAAC,CAAC,IAAG;YACzD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,IAAI,CAAA;SAChD,GAAG;aACD,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;SAC/B,CAAA,CAAA;QAED,KAAK,YAAY,GAAG,MAAM,IAAI,CAAA;QAE9B,KAAK,UAAU,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,YAAY,CAAA;QAElE,KAAK,MAAM,GAAG;YACZ,YAAY,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAA;YAC7C,KAAK,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YACvC,aAAa,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YAC/C,eAAe,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YACjD,gBAAgB,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YAElD,mBAAmB,EAAE,KAAK,CAAC,WAAW,CAAA;YAEtC,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC5C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC5C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC5C,oBAAoB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC1C,qBAAqB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC3C,wBAAwB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC9C,2BAA2B,EAAE,KAAK,CAAC,cAAc,CAAA;YACjD,mBAAmB,EAAE,KAAK,CAAC,cAAc,CAAA;YACzC,qBAAqB,EAAE,KAAK,CAAC,cAAc,CAAA;YAE3C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC5C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC5C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAE5C,2BAA2B,EAAE,KAAK,CAAC,aAAa,CAAA;YAChD,0BAA0B,EAAE,KAAK,CAAC,aAAa,CAAA;YAC/C,yBAAyB,EAAE,KAAK,CAAC,aAAa,CAAA;YAM9C,wBAAwB,EAAE,KAAK,CAAC,gBAAgB,CAAA;YAChD,wBAAwB,EAAE,KAAK,CAAC,gBAAgB,CAAA;YAChD,wBAAwB,EAAE,KAAK,CAAC,gBAAgB,CAAA;YAChD,sBAAsB,EAAE,KAAK,CAAC,gBAAgB,CAAA;YAC9C,uBAAuB,EAAE,KAAK,CAAC,gBAAgB,CAAA;YAC/C,0BAA0B,EAAE,KAAK,CAAC,gBAAgB,CAAA;YAClD,6BAA6B,EAAE,KAAK,CAAC,gBAAgB,CAAA;YAErD,mBAAmB,EAAE,KAAK,CAAC,WAAW,CAAA;YACtC,mBAAmB,EAAE,KAAK,CAAC,WAAW,CAAA;YACtC,mBAAmB,EAAE,KAAK,CAAC,WAAW,CAAA;YAEtC,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC5C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC5C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;SAC7C,CAAA;KACF;CACF"}
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../src/@types/core/events.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEnF,OAAO,EAAE,CAAC;AAEV,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,KAAK,QAAQ,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI,CAAC;QAE7C,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,EAAE,IACrC,QAAQ,CAAC,CAAC,CAAC,GACX,CAAC;YACC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,IAAI,CAAC;SACjD,GAAG;aACD,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;SAC/B,CAAC,CAAC;QAEP,KAAK,YAAY,GAAG,MAAM,IAAI,CAAC;QAE/B,KAAK,UAAU,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,YAAY,CAAC;QAEnE,KAAK,QAAQ,GAAG;YACd,YAAY,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YAC9C,KAAK,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YACvC,aAAa,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YAC/C,eAAe,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YACjD,gBAAgB,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YAElD,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAC;YAC7C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAC;YAC7C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAC;YAC7C,oBAAoB,EAAE,KAAK,CAAC,cAAc,CAAC;YAC3C,qBAAqB,EAAE,KAAK,CAAC,cAAc,CAAC;YAC5C,wBAAwB,EAAE,KAAK,CAAC,cAAc,CAAC;YAC/C,2BAA2B,EAAE,KAAK,CAAC,cAAc,CAAC;YAClD,mBAAmB,EAAE,KAAK,CAAC,cAAc,CAAC;YAC1C,qBAAqB,EAAE,KAAK,CAAC,cAAc,CAAC;YAE5C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAC;YAC7C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAC;YAC7C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAC;YAE7C,2BAA2B,EAAE,KAAK,CAAC,aAAa,CAAC;YACjD,0BAA0B,EAAE,KAAK,CAAC,aAAa,CAAC;YAChD,yBAAyB,EAAE,KAAK,CAAC,aAAa,CAAC;SAChD,CAAC;QAEF,KAAK,UAAU,GAAG;YAChB,OAAO,EAAE,cAAc,CAAC;YACxB,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;YAClE,UAAU,EAAE,iBAAiB,CAAC;YAC9B,KAAK,EAAE,KAAK,CAAC;YACb,KAAK,EAAE,KAAK,CAAC;YACb,GAAG,EAAE,SAAS,CAAC;YACf,SAAS,EAAE,SAAS,CAAC;SACtB,CAAC;QAEF,KAAK,8BAA8B,GAAG;YACpC,kBAAkB,EAAE,KAAK,CAAC,0BAA0B,CAAC;YACrD,gBAAgB,EAAE,KAAK,CAAC,0BAA0B,CAAC;YACnD,qBAAqB,EAAE,KAAK,CAAC,0BAA0B,CAAC;YACxD,uBAAuB,EAAE,KAAK,CAAC,0BAA0B,CAAC;YAC1D,sBAAsB,EAAE,KAAK,CAAC,0BAA0B,CAAC;YACzD,wBAAwB,EAAE,KAAK,CAAC,0BAA0B,CAAC;SAC5D,CAAC;QAEF,KAAK,0BAA0B,GAAG;YAChC,mBAAmB,EAAE,KAAK,CAAC,gBAAgB,CAAC;YAC5C,mBAAmB,EAAE,KAAK,CAAC,gBAAgB,CAAC;YAC5C,mBAAmB,EAAE,KAAK,CAAC,gBAAgB,CAAC;SAC7C,GAAG,8BAA8B,CAAC;QAEnC,KAAK,qBAAqB,GAAG;YAC3B,cAAc,EAAE,KAAK,CAAC,WAAW,CAAC;YAClC,cAAc,EAAE,KAAK,CAAC,WAAW,CAAC;YAClC,cAAc,EAAE,KAAK,CAAC,WAAW,CAAC;YAClC,eAAe,EAAE,KAAK,CAAC,WAAW,CAAC;YACnC,eAAe,EAAE,KAAK,CAAC,WAAW,CAAC;YACnC,cAAc,EAAE,KAAK,CAAC,WAAW,CAAC;YAClC,gBAAgB,EAAE,KAAK,CAAC,WAAW,CAAC;YACpC,kBAAkB,EAAE,KAAK,CAAC,WAAW,GAAG;gBAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAA;aAAE,CAAC;YACpE,qBAAqB,EAAE,KAAK,CAAC,WAAW,GAAG;gBAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAA;aAAE,CAAC;SACxE,CAAC;QAEF,KAAK,wBAAwB,GAAG;YAC9B,iBAAiB,EAAE,KAAK,CAAC,cAAc,CAAC;YACxC,iBAAiB,EAAE,KAAK,CAAC,cAAc,CAAC;YACxC,iBAAiB,EAAE,KAAK,CAAC,cAAc,CAAC;YACxC,iBAAiB,EAAE,KAAK,CAAC,cAAc,CAAC;YACxC,mBAAmB,EAAE,KAAK,CAAC,cAAc,CAAC;YAC1C,qBAAqB,EAAE,KAAK,CAAC,cAAc,GAAG;gBAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAA;aAAE,CAAC;YAC1E,wBAAwB,EAAE,KAAK,CAAC,cAAc,GAAG;gBAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAA;aAAE,CAAC;SAC9E,CAAC;QAEF,KAAK,qBAAqB,GAAG;YAC3B,cAAc,EAAE,KAAK,CAAC,WAAW,CAAC;YAClC,cAAc,EAAE,KAAK,CAAC,WAAW,CAAC;YAClC,gBAAgB,EAAE,KAAK,CAAC,WAAW,CAAC;YACpC,kBAAkB,EAAE,KAAK,CAAC,WAAW,CAAC;SACvC,CAAC;QAEF,KAAK,uBAAuB,GAAG;YAC7B,gBAAgB,EAAE,KAAK,CAAC,YAAY,CAAC;YACrC,kBAAkB,EAAE,KAAK,CAAC,YAAY,CAAC;YACvC,iBAAiB,EAAE,KAAK,CAAC,YAAY,CAAC;YACtC,mBAAmB,EAAE,KAAK,CAAC,YAAY,CAAC;YACxC,wBAAwB,EAAE,KAAK,CAAC,YAAY,CAAC;YAC7C,wBAAwB,EAAE,KAAK,CAAC,YAAY,CAAC;YAC7C,wBAAwB,EAAE,KAAK,CAAC,YAAY,CAAC;SAC9C,CAAC;QAEF,KAAK,iBAAiB,GAAG,0BAA0B,GACjD,qBAAqB,GACrB,wBAAwB,GACxB,qBAAqB,GACrB,uBAAuB,CAAC;QAE1B,KAAK,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,iBAAiB,CAAC;KACzD;CACF"}

package/dist/@types/core/model.d.ts

@@ -6,35 +6,40 @@ declare global {
          * @hidden
          */
         type Model = {
-            'user': Amity.User;
-            'file': Amity.File;
-            'role': Amity.Role;
-            'channel': Amity.Channel;
-            'channelUsers': Amity.Membership<'channel'>;
-            'message': Amity.Message;
-            'community': Amity.Community;
-            'communityUsers': Amity.Membership<'community'>;
-            'post': Amity.Post;
-            'comment': Amity.Comment;
-            'stream': Amity.Stream;
+            user: Amity.User;
+            file: Amity.File;
+            role: Amity.Role;
+            channel: Amity.Channel;
+            channelUsers: Amity.Membership<'channel'>;
+            message: Amity.Message;
+            community: Amity.Community;
+            communityUsers: Amity.Membership<'community'>;
+            post: Amity.Post;
+            comment: Amity.Comment;
+            stream: Amity.Stream;
+            follow: Amity.FollowStatus;
+            followCount: Amity.FollowCount;
         };
+        type Domain = keyof Model;
         /**
          * Definition of the minimal set of properties necessary to identify
          * successfully a model.
          * @hidden
          */
         type Minimal = {
-            'user': Pick<Amity.User, 'userId'>;
-            'file': Pick<Amity.File, 'fileId'>;
-            'role': Pick<Amity.Role, 'roleId'>;
-            'channel': Pick<Amity.Channel, 'channelId'>;
-            'channelUsers': Pick<Amity.Membership<'channel'>, 'channelId' | 'userId'>;
-            'message': Pick<Amity.Message, 'messageId'>;
-            'community': Pick<Amity.Community, 'communityId'>;
-            'communityUsers': Pick<Amity.Membership<'community'>, 'communityId' | 'userId'>;
-            'post': Pick<Amity.Post, 'postId'>;
-            'comment': Pick<Amity.Comment, 'commentId'>;
-            'stream': Pick<Amity.Stream, 'streamId'>;
+            user: Pick<Amity.User, 'userId'>;
+            file: Pick<Amity.File, 'fileId'>;
+            role: Pick<Amity.Role, 'roleId'>;
+            channel: Pick<Amity.Channel, 'channelId'>;
+            channelUsers: Pick<Amity.Membership<'channel'>, 'channelId' | 'userId'>;
+            message: Pick<Amity.Message, 'messageId'>;
+            community: Pick<Amity.Community, 'communityId'>;
+            communityUsers: Pick<Amity.Membership<'community'>, 'communityId' | 'userId'>;
+            post: Pick<Amity.Post, 'postId'>;
+            comment: Pick<Amity.Comment, 'commentId'>;
+            stream: Pick<Amity.Stream, 'streamId'>;
+            follow: Pick<Amity.FollowStatus, 'from' | 'to'>;
+            followCount: Pick<Amity.FollowCount, 'userId'>;
         };
     }
 }

package/dist/@types/core/model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../../src/@types/core/model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAA;AAET,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd;;;WAGG;QACH,KAAK,KAAK,GAAG;YACX,MAAM,EAAE,KAAK,CAAC,IAAI,CAAA;YAClB,MAAM,EAAE,KAAK,CAAC,IAAI,CAAA;YAClB,MAAM,EAAE,KAAK,CAAC,IAAI,CAAA;YAElB,SAAS,EAAE,KAAK,CAAC,OAAO,CAAA;YACxB,cAAc,EAAE,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,CAAA;YAC3C,SAAS,EAAE,KAAK,CAAC,OAAO,CAAA;YAExB,WAAW,EAAE,KAAK,CAAC,SAAS,CAAA;YAC5B,gBAAgB,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAA;YAC/C,MAAM,EAAE,KAAK,CAAC,IAAI,CAAA;YAClB,SAAS,EAAE,KAAK,CAAC,OAAO,CAAA;YAExB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAA;SACvB,CAAA;QAED;;;;WAIG;QACH,KAAK,OAAO,GAAG;YACb,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;YAClC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;YAClC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;YAElC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAC3C,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC,CAAA;YACzE,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAE3C,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,aAAa,CAAC,CAAA;YACjD,gBAAgB,EAAE,IAAI,CACpB,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,EAC7B,aAAa,GAAG,QAAQ,CACzB,CAAA;YACD,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;YAClC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAE3C,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;SACzC,CAAA;KACF;CACF"}
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../../src/@types/core/model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC;AAEV,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd;;;WAGG;QACH,KAAK,KAAK,GAAG;YACX,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;YACjB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;YACjB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;YAEjB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;YACvB,YAAY,EAAE,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YAC1C,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;YAEvB,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;YAC3B,cAAc,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YAC9C,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;YACjB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;YAEvB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YAErB,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC;YAC3B,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;SAChC,CAAC;QAEF,KAAK,MAAM,GAAG,MAAM,KAAK,CAAC;QAE1B;;;;WAIG;QACH,KAAK,OAAO,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACjC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACjC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAEjC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YAC1C,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC,CAAC;YACxE,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YAE1C,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YAChD,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC,CAAC;YAC9E,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACjC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YAE1C,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YAEvC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;YAChD,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;SAChD,CAAC;KACH;CACF"}

package/dist/@types/core/paging.d.ts

@@ -0,0 +1,40 @@
+export {};
+declare global {
+    namespace Amity {
+        type PaginationStyles = 'skiplimit' | 'afterbefore' | 'afterbeforeraw';
+        type PageLimit = {
+            limit: number;
+        };
+        type PrevPage<T extends number | string> = PageLimit & {
+            after?: never;
+            before?: T;
+        };
+        type NextPage<T extends number | string> = PageLimit & {
+            after?: T;
+            before?: never;
+        };
+        type Page = PrevPage<number> | NextPage<number>;
+        type PageRaw = (PrevPage<string> | NextPage<string>) & {
+            updatedAt?: string;
+        };
+        type SkipLimitPagination = {
+            skip?: number;
+            limit?: number;
+        };
+        type AfterBeforePagination = {
+            before?: number;
+            after?: number;
+            first?: number;
+            last?: number;
+        };
+        type AfterBeforeRawPagination = PageRaw;
+        type Pages<T extends Page | PageRaw> = {
+            nextPage?: T;
+            prevPage?: T;
+        };
+        type Paged<T, K extends Page | PageRaw = Page> = {
+            data: T[];
+        } & Pages<K>;
+    }
+}
+//# sourceMappingURL=paging.d.ts.map

package/dist/@types/core/paging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paging.d.ts","sourceRoot":"","sources":["../../../src/@types/core/paging.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC;AAEV,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,KAAK,gBAAgB,GAAG,WAAW,GAAG,aAAa,GAAG,gBAAgB,CAAC;QAEvE,KAAK,SAAS,GAAG;YACf,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;QAEF,KAAK,QAAQ,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,SAAS,GAAG;YACrD,KAAK,CAAC,EAAE,KAAK,CAAC;YACd,MAAM,CAAC,EAAE,CAAC,CAAC;SACZ,CAAC;QAEF,KAAK,QAAQ,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,SAAS,GAAG;YACrD,KAAK,CAAC,EAAE,CAAC,CAAC;YACV,MAAM,CAAC,EAAE,KAAK,CAAC;SAChB,CAAC;QAEF,KAAK,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;QAMhD,KAAK,OAAO,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG;YACrD,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB,CAAC;QAEF,KAAK,mBAAmB,GAAG;YACzB,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QAUF,KAAK,qBAAqB,GAAG;YAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,IAAI,CAAC,EAAE,MAAM,CAAC;SACf,CAAC;QAEF,KAAK,wBAAwB,GAAG,OAAO,CAAC;QAExC,KAAK,KAAK,CAAC,CAAC,SAAS,IAAI,GAAG,OAAO,IAAI;YACrC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACb,QAAQ,CAAC,EAAE,CAAC,CAAC;SACd,CAAC;QAEF,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC,SAAS,IAAI,GAAG,OAAO,GAAG,IAAI,IAAI;YAAE,IAAI,EAAE,CAAC,EAAE,CAAA;SAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;KAC3E;CACF"}

package/dist/@types/core/payload.d.ts

@@ -58,11 +58,11 @@ declare global {
             files: Amity.File[];
         };
         type CommunityMembershipPayload = {
-            communities?: Amity.Community[];
+            communities: Amity.Community[];
             communityUsers: Amity.Membership<'community'>[];
             categories?: Amity.Category[];
             feeds?: Amity.Feed[];
-            users?: Amity.User[];
+            users: Amity.User[];
             files?: Amity.File[];
         };
         type PostPayload<T extends Amity.PostContentType = any> = {
@@ -83,6 +83,16 @@ declare global {
             files?: Amity.File[];
         };
         type GlobalFeedPayload = Amity.PostPayload;
+        type FollowersPayload = {
+            follows: Amity.FollowStatus[];
+        } & UserPayload;
+        type FollowStatusPayload = {
+            follows: Amity.FollowStatus[];
+        };
+        type FollowInfoPayload = {
+            follows: Amity.FollowStatus[];
+            followCounts: Amity.FollowCount[];
+        };
     }
 }
 //# sourceMappingURL=payload.d.ts.map

package/dist/@types/core/payload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../src/@types/core/payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAA;AAET,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,KAAK,QAAQ,GAAG;YACd,IAAI,EAAE,KAAK,CAAC,WAAW,CAAA;YACvB,IAAI,EAAE,KAAK,CAAC,WAAW,CAAA;YACvB,IAAI,EAAE,KAAK,CAAC,WAAW,CAAA;YACvB,OAAO,EAAE,KAAK,CAAC,cAAc,CAAA;YAC7B,WAAW,EAAE,KAAK,CAAC,wBAAwB,CAAA;YAC3C,OAAO,EAAE,KAAK,CAAC,cAAc,CAAA;YAC7B,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAA;YACjC,aAAa,EAAE,KAAK,CAAC,0BAA0B,CAAA;YAC/C,IAAI,EAAE,KAAK,CAAC,WAAW,CAAA;YACvB,OAAO,EAAE,KAAK,CAAC,cAAc,CAAA;YAC7B,MAAM,EAAE,KAAK,CAAC,aAAa,CAAA;SAC5B,CAAA;QAED,KAAK,WAAW,GAAG;YACjB,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;YACnB,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAA;SAC7B,CAAA;QAGD,KAAK,iBAAiB,CAAC,CAAC,SAAS,KAAK,CAAC,QAAQ,GAAG,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;QACxE,KAAK,WAAW,CAAC,CAAC,SAAS,KAAK,CAAC,QAAQ,GAAG,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAEhE,KAAK,WAAW,GAAG;YACjB,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;SACpB,CAAA;QAED,KAAK,cAAc,CAAC,CAAC,SAAS,KAAK,CAAC,WAAW,GAAG,GAAG,IAAI;YACvD,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAA;YAC5B,YAAY,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAA;YAC5C,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;YACpB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;SACrB,CAAA;QAED,KAAK,wBAAwB,GAAG;YAC9B,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,EAAE,CAAA;YAC1B,YAAY,EAAE,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAA;YAC3C,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;YACpB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;SACrB,CAAA;QAED,KAAK,cAAc,CAAC,CAAC,SAAS,KAAK,CAAC,kBAAkB,GAAG,GAAG,IAAI;YAC9D,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAA;YAC5B,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;YACpB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;SACrB,CAAA;QAED,KAAK,aAAa,GAAG;YACnB,eAAe,EAAE,KAAK,CAAC,MAAM,EAAE,CAAA;YAC/B,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;YACpB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAA;SAC9B,CAAA;QAED,KAAK,gBAAgB,GAAG;YACtB,WAAW,EAAE,KAAK,CAAC,SAAS,EAAE,CAAA;YAC9B,cAAc,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAA;YAChD,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAA;YAC7B,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;YACpB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;YACpB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;SACrB,CAAA;QAED,KAAK,eAAe,GAAG;YACrB,UAAU,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAA;YAC5B,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;SACpB,CAAA;QAED,KAAK,0BAA0B,GAAG;YAChC,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,EAAE,CAAA;YAC/B,cAAc,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAA;YAC/C,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAA;YAC7B,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;YACpB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;YACpB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;SACrB,CAAA;QAED,KAAK,WAAW,CAAC,CAAC,SAAS,KAAK,CAAC,eAAe,GAAG,GAAG,IAAI;YACxD,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;YACtB,YAAY,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;YAC3B,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,EAAE,CAAA;YAC/B,cAAc,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAA;YAChD,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAA;YAC7B,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,EAAE,CAAA;YAC1B,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;YACpB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;YACpB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;SACrB,CAAA;QAED,KAAK,cAAc,CAAC,CAAC,SAAS,KAAK,CAAC,kBAAkB,GAAG,GAAG,IAAI;YAC9D,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAA;YAC5B,eAAe,CAAC,EAAE,KAAK,CAAC,OAAO,EAAE,CAAA;YACjC,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;YACpB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;SACrB,CAAA;QAED,KAAK,iBAAiB,GAAG,KAAK,CAAC,WAAW,CAAA;KAC3C;CACF"}
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../src/@types/core/payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC;AAEV,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,KAAK,QAAQ,GAAG;YACd,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC;YACxB,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC;YACxB,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC;YACxB,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC;YAC9B,WAAW,EAAE,KAAK,CAAC,wBAAwB,CAAC;YAC5C,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC;YAC9B,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC;YAClC,aAAa,EAAE,KAAK,CAAC,0BAA0B,CAAC;YAChD,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC;YACxB,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC;YAC9B,MAAM,EAAE,KAAK,CAAC,aAAa,CAAC;SAC7B,CAAC;QAEF,KAAK,WAAW,GAAG;YACjB,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YACpB,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;SAC9B,CAAC;QAGF,KAAK,iBAAiB,CAAC,CAAC,SAAS,KAAK,CAAC,QAAQ,GAAG,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACzE,KAAK,WAAW,CAAC,CAAC,SAAS,KAAK,CAAC,QAAQ,GAAG,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEjE,KAAK,WAAW,GAAG;YACjB,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;SACrB,CAAC;QAEF,KAAK,cAAc,CAAC,CAAC,SAAS,KAAK,CAAC,WAAW,GAAG,GAAG,IAAI;YACvD,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7B,YAAY,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7C,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;SACtB,CAAC;QAEF,KAAK,wBAAwB,GAAG;YAC9B,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;YAC3B,YAAY,EAAE,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5C,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;SACtB,CAAC;QAEF,KAAK,cAAc,CAAC,CAAC,SAAS,KAAK,CAAC,kBAAkB,GAAG,GAAG,IAAI;YAC9D,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7B,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;SACtB,CAAC;QAEF,KAAK,aAAa,GAAG;YACnB,eAAe,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;YAChC,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;SAC/B,CAAC;QAEF,KAAK,gBAAgB,GAAG;YACtB,WAAW,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC;YAC/B,cAAc,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YACjD,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC;YAC9B,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;SACtB,CAAC;QAEF,KAAK,eAAe,GAAG;YACrB,UAAU,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC;YAC7B,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;SACrB,CAAC;QAEF,KAAK,0BAA0B,GAAG;YAChC,WAAW,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC;YAC/B,cAAc,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAChD,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC;YAC9B,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YACpB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;SACtB,CAAC;QAEF,KAAK,WAAW,CAAC,CAAC,SAAS,KAAK,CAAC,eAAe,GAAG,GAAG,IAAI;YACxD,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YACvB,YAAY,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YAC5B,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC;YAChC,cAAc,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YACjD,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC;YAC9B,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;YAC3B,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;SACtB,CAAC;QAEF,KAAK,cAAc,CAAC,CAAC,SAAS,KAAK,CAAC,kBAAkB,GAAG,GAAG,IAAI;YAC9D,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7B,eAAe,CAAC,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;YAClC,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;SACtB,CAAC;QAEF,KAAK,iBAAiB,GAAG,KAAK,CAAC,WAAW,CAAC;QAE3C,KAAK,gBAAgB,GAAG;YACtB,OAAO,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC;SAC/B,GAAG,WAAW,CAAC;QAEhB,KAAK,mBAAmB,GAAG;YACzB,OAAO,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC;SAC/B,CAAC;QAEF,KAAK,iBAAiB,GAAG;YACvB,OAAO,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC;YAC9B,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC;SACnC,CAAC;KACH;CACF"}

package/dist/@types/core/permissions.d.ts

@@ -65,7 +65,7 @@ declare global {
             roleId: string;
             displayName: string;
             permissions: Permission[];
-        } & Amity.Timestamps & Amity.SoftDelete & Amity.Syncable;
+        } & Amity.Timestamps & Amity.SoftDelete;
     }
 }
 //# sourceMappingURL=permissions.d.ts.map

package/dist/@types/core/permissions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../../../src/@types/core/permissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAA;AAET,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,WAAW,UAAU;YACnB,kBAAkB,cAAc;YAChC,iBAAiB,aAAa;YAC9B,oBAAoB,gBAAgB;YACpC,kBAAkB,cAAc;YAChC,oBAAoB,gBAAgB;YACpC,oBAAoB,qBAAqB;YACzC,qBAAqB,iBAAiB;YACtC,8BAA8B,2BAA2B;YACzD,qBAAqB,iBAAiB;YACtC,sBAAsB,kBAAkB;YACxC,wBAAwB,qBAAqB;YAC7C,yBAAyB,sBAAsB;YAC/C,2BAA2B,wBAAwB;YACnD,yBAAyB,sBAAsB;YAC/C,wBAAwB,qBAAqB;YAC7C,qBAAqB,iBAAiB;YACtC,uBAAuB,mBAAmB;YAC1C,uBAAuB,mBAAmB;YAC1C,yBAAyB,qBAAqB;YAC9C,6BAA6B,uBAAuB;YACpD,8BAA8B,wBAAwB;YACtD,gCAAgC,0BAA0B;YAC1D,8BAA8B,wBAAwB;YACtD,6BAA6B,uBAAuB;YACpD,0BAA0B,wBAAwB;YAClD,4BAA4B,0BAA0B;YACtD,6BAA6B,2BAA2B;YACxD,+BAA+B,6BAA6B;YAC5D,+BAA+B,6BAA6B;YAC5D,iCAAiC,+BAA+B;YAChE,kCAAkC,gCAAgC;YAClE,oCAAoC,kCAAkC;YACtE,iCAAiC,8BAA8B;YAC/D,+BAA+B,4BAA4B;YAC3D,iCAAiC,8BAA8B;SAChE;QAED,WAAW,gBAAgB;YACzB,mBAAmB,cAAc;YACjC,wBAAwB,oBAAoB;YAC5C,qBAAqB,iBAAiB;YACtC,uBAAuB,oBAAoB;YAC3C,wBAAwB,qBAAqB;YAC7C,2BAA2B,wBAAwB;YACnD,6BAA6B,0BAA0B;YACvD,gCAAgC,6BAA6B;YAC7D,8BAA8B,2BAA2B;YACzD,2BAA2B,wBAAwB;YACnD,4BAA4B,yBAAyB;YACrD,iCAAiC,2BAA2B;YAC5D,oCAAoC,8BAA8B;YAClE,8BAA8B,wBAAwB;YACtD,6BAA6B,sBAAsB;YACnD,mCAAmC,4BAA4B;YAC/D,mCAAmC,4BAA4B;YAC/D,yCAAyC,kCAAkC;YAC3E,2BAA2B,qBAAqB;YAChD,8BAA8B,wBAAwB;YACtD,iCAAiC,gCAAgC;SAClE;QAED,KAAK,IAAI,GAAG;YACV,MAAM,EAAE,MAAM,CAAA;YACd,WAAW,EAAE,MAAM,CAAA;YACnB,WAAW,EAAE,UAAU,EAAE,CAAA;SAC1B,GACC,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,QAAQ,CAAA;KACjB;CACF"}
+{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../../../src/@types/core/permissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC;AAEV,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,WAAW,UAAU;YACnB,kBAAkB,cAAc;YAChC,iBAAiB,aAAa;YAC9B,oBAAoB,gBAAgB;YACpC,kBAAkB,cAAc;YAChC,oBAAoB,gBAAgB;YACpC,oBAAoB,qBAAqB;YACzC,qBAAqB,iBAAiB;YACtC,8BAA8B,2BAA2B;YACzD,qBAAqB,iBAAiB;YACtC,sBAAsB,kBAAkB;YACxC,wBAAwB,qBAAqB;YAC7C,yBAAyB,sBAAsB;YAC/C,2BAA2B,wBAAwB;YACnD,yBAAyB,sBAAsB;YAC/C,wBAAwB,qBAAqB;YAC7C,qBAAqB,iBAAiB;YACtC,uBAAuB,mBAAmB;YAC1C,uBAAuB,mBAAmB;YAC1C,yBAAyB,qBAAqB;YAC9C,6BAA6B,uBAAuB;YACpD,8BAA8B,wBAAwB;YACtD,gCAAgC,0BAA0B;YAC1D,8BAA8B,wBAAwB;YACtD,6BAA6B,uBAAuB;YACpD,0BAA0B,wBAAwB;YAClD,4BAA4B,0BAA0B;YACtD,6BAA6B,2BAA2B;YACxD,+BAA+B,6BAA6B;YAC5D,+BAA+B,6BAA6B;YAC5D,iCAAiC,+BAA+B;YAChE,kCAAkC,gCAAgC;YAClE,oCAAoC,kCAAkC;YACtE,iCAAiC,8BAA8B;YAC/D,+BAA+B,4BAA4B;YAC3D,iCAAiC,8BAA8B;SAChE;QAED,WAAW,gBAAgB;YACzB,mBAAmB,cAAc;YACjC,wBAAwB,oBAAoB;YAC5C,qBAAqB,iBAAiB;YACtC,uBAAuB,oBAAoB;YAC3C,wBAAwB,qBAAqB;YAC7C,2BAA2B,wBAAwB;YACnD,6BAA6B,0BAA0B;YACvD,gCAAgC,6BAA6B;YAC7D,8BAA8B,2BAA2B;YACzD,2BAA2B,wBAAwB;YACnD,4BAA4B,yBAAyB;YACrD,iCAAiC,2BAA2B;YAC5D,oCAAoC,8BAA8B;YAClE,8BAA8B,wBAAwB;YACtD,6BAA6B,sBAAsB;YACnD,mCAAmC,4BAA4B;YAC/D,mCAAmC,4BAA4B;YAC/D,yCAAyC,kCAAkC;YAC3E,2BAA2B,qBAAqB;YAChD,8BAA8B,wBAAwB;YACtD,iCAAiC,gCAAgC;SAClE;QAED,KAAK,IAAI,GAAG;YACV,MAAM,EAAE,MAAM,CAAC;YACf,WAAW,EAAE,MAAM,CAAC;YACpB,WAAW,EAAE,UAAU,EAAE,CAAC;SAC3B,GAAG,KAAK,CAAC,UAAU,GAClB,KAAK,CAAC,UAAU,CAAC;KACpB;CACF"}

package/dist/@types/core/query.d.ts

@@ -1,26 +1,24 @@
 export {};
 declare global {
     namespace Amity {
-        type Syncable = {
-            localId: string;
-            syncedAt: number;
+        type Cachable = {
+            cachedAt: number;
         };
         type Local = {
-            localId: string;
-            syncedAt: -1;
+            cachedAt: -1;
         };
         type AsyncFunc<Args extends any[], Returned extends any> = {
             (...args: Args): Promise<Returned>;
         };
         type FetcherFunc<Args extends any[], Returned extends any> = {
             (...args: Args): Promise<Returned>;
-            locally: (...args: Args) => Returned;
+            locally: (...args: Args) => Returned | undefined;
         };
         type MutatorFunc<Args extends any[], Returned extends any> = {
             (...args: Args): Promise<Returned>;
-            optimistically: (...args: Args) => Returned;
+            optimistically: (...args: Args) => Returned | undefined;
         };
-        type OfflineFunc<Args extends any[], Returned extends any> = (FetcherFunc<Args, Returned> | MutatorFunc<Args, Returned>);
+        type OfflineFunc<Args extends any[], Returned extends any> = FetcherFunc<Args, Returned> | MutatorFunc<Args, Returned>;
         type Query<Args extends any[], Returned extends any> = {
             func: AsyncFunc<Args, Returned> | OfflineFunc<Args, Returned>;
             args: Args;
@@ -29,44 +27,25 @@ declare global {
         type QueryOptions = {
             lifeSpan: number;
         };
-        type QueryMetadata = {
-            origin?: 'local' | 'server';
-            loading?: boolean;
-            error?: Error;
-        };
-        type QueryResult<T> = T extends Amity.Paged<infer U> ? {
-            data?: U;
-        } & Amity.Pages & QueryMetadata : {
-            data?: T;
-        } & QueryMetadata;
-        type SkipLimitPagination = {
-            skip?: number;
-            limit?: number;
-        };
-        type AfterBeforePagination = {
-            before?: number;
-            after?: number;
-            first?: number;
-            last?: number;
-        };
-        type PrevPage = {
-            after?: never;
-            before?: number;
-            limit: number;
-        };
-        type NextPage = {
-            after?: number;
-            before?: never;
-            limit: number;
-        };
-        type Page = (PrevPage | NextPage);
-        type Pages = {
-            nextPage: Page | null;
-            prevPage: Page | null;
-        };
-        type Paged<T> = {
-            data: T;
-        } & Pages;
+        type SnapshotOptions = {
+            origin: 'local' | 'server' | 'event';
+            loading: boolean;
+            error?: any;
+        };
+        type Snapshot<T> = (T extends Amity.Cached<infer T2> ? T2 extends Amity.Paged<infer T3, infer T4> ? {
+            data: T3[] | undefined;
+        } & Amity.Pages<T4> & {
+            cachedAt?: Amity.CacheOptions['cachedAt'];
+        } : {
+            data: T2;
+        } & {
+            cachedAt?: Amity.CacheOptions['cachedAt'];
+        } : T extends Amity.Paged<infer T3, infer T4> ? {
+            data: T3[] | undefined;
+        } & Amity.Pages<T4> : {
+            data: T | undefined;
+        }) & SnapshotOptions;
+        type RunQueryOptions<T> = T extends Amity.AsyncFunc<infer Args, infer Returned> ? Omit<Amity.Snapshot<Returned>, 'data'> : never;
     }
 }
 //# sourceMappingURL=query.d.ts.map