@amityco/ts-sdk 0.0.1-beta.1 → 0.0.1-beta.13

package/dist/@types/domains/partials.d.ts

@@ -0,0 +1,55 @@
+export {};
+declare global {
+    namespace Amity {
+        type timestamp = string;
+        type CreatedAt = {
+            createdAt: timestamp;
+        };
+        type UpdatedAt = {
+            updatedAt?: timestamp;
+        };
+        type DeletedAt = {
+            deletedAt?: timestamp;
+        };
+        type Timestamps = CreatedAt & UpdatedAt;
+        type SoftDelete = DeletedAt & {
+            isDeleted?: boolean;
+        };
+        type Metadata = {
+            metadata?: Record<string, any>;
+        };
+        type Relationship<T extends string> = {
+            referenceId: string;
+            referenceType: T;
+        };
+        type Flaggable = {
+            flagCount: number;
+            hashFlag: {
+                bits: number;
+                hashes: number;
+                hash: string;
+            } | null;
+        };
+        type Taggable = {
+            tags?: string[];
+        };
+        type Accredited = {
+            roles: Amity.Role['displayName'][];
+            permissions: Amity.Permission[];
+        };
+        type Subscribable = {
+            path: string;
+        };
+        type MentionTypes = {
+            user: {
+                userIds: Amity.User['userId'][];
+            };
+        };
+        type Mentionable<T extends keyof MentionTypes> = {
+            mentionees?: {
+                type: T & MentionTypes;
+            }[];
+        };
+    }
+}
+//# sourceMappingURL=partials.d.ts.map

package/dist/@types/domains/partials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"partials.d.ts","sourceRoot":"","sources":["../../../src/@types/domains/partials.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAA;AAET,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,KAAK,SAAS,GAAG,MAAM,CAAA;QAEvB,KAAK,SAAS,GAAG;YACf,SAAS,EAAE,SAAS,CAAA;SACrB,CAAA;QAED,KAAK,SAAS,GAAG;YACf,SAAS,CAAC,EAAE,SAAS,CAAA;SACtB,CAAA;QAED,KAAK,SAAS,GAAG;YACf,SAAS,CAAC,EAAE,SAAS,CAAA;SACtB,CAAA;QAED,KAAK,UAAU,GAAG,SAAS,GAAG,SAAS,CAAA;QAEvC,KAAK,UAAU,GAAG,SAAS,GAAG;YAC5B,SAAS,CAAC,EAAE,OAAO,CAAA;SACpB,CAAA;QAED,KAAK,QAAQ,GAAG;YACd,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;SAC/B,CAAA;QAED,KAAK,YAAY,CAAC,CAAC,SAAS,MAAM,IAAI;YACpC,WAAW,EAAE,MAAM,CAAA;YACnB,aAAa,EAAE,CAAC,CAAA;SACjB,CAAA;QAED,KAAK,SAAS,GAAG;YACf,SAAS,EAAE,MAAM,CAAA;YACjB,QAAQ,EAAE;gBACR,IAAI,EAAE,MAAM,CAAA;gBACZ,MAAM,EAAE,MAAM,CAAA;gBACd,IAAI,EAAE,MAAM,CAAA;aACb,GAAG,IAAI,CAAA;SACT,CAAA;QAED,KAAK,QAAQ,GAAG;YACd,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;SAChB,CAAA;QAED,KAAK,UAAU,GAAG;YACd,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAA;YAClC,WAAW,EAAE,KAAK,CAAC,UAAU,EAAE,CAAA;SAClC,CAAA;QAED,KAAK,YAAY,GAAG;YAClB,IAAI,EAAE,MAAM,CAAA;SACb,CAAA;QAED,KAAK,YAAY,GAAG;YAClB,IAAI,EAAE;gBAAE,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAA;aAAE,CAAA;SAC1C,CAAA;QAED,KAAK,WAAW,CAAC,CAAC,SAAS,MAAM,YAAY,IAAI;YAC/C,UAAU,CAAC,EAAE;gBAAC,IAAI,EAAE,CAAC,GAAG,YAAY,CAAA;aAAC,EAAE,CAAA;SACxC,CAAA;KACF;CACF"}

package/dist/@types/domains/post.d.ts

@@ -0,0 +1,23 @@
+export {};
+declare global {
+    namespace Amity {
+        type PostTargetType = Amity.FeedType | 'content';
+        type PostContentType = ('text' | 'image' | 'file' | 'video');
+        type PostMentionType = keyof MentionTypes;
+        type Post<T extends PostContentType = any> = {
+            postId: string;
+            postedUserId: User['userId'];
+            parentId: Post['postId'];
+            targetType: PostTargetType;
+            targetId: string;
+            feedId: Feed['feedId'];
+            children: Amity.Post['postId'][];
+            comments: Amity.Comment['commentId'][];
+            commentsCount: number;
+            hasFlaggedChildren: false;
+            hasFlaggedComment: false;
+            editedAt: timestamp;
+        } & Amity.Content<T, 'dataType'> & Amity.Metadata & Amity.Flaggable & Amity.Reactable & Amity.Timestamps & Amity.SoftDelete & Amity.Subscribable & Amity.Mentionable<PostMentionType>;
+    }
+}
+//# sourceMappingURL=post.d.ts.map

package/dist/@types/domains/post.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"post.d.ts","sourceRoot":"","sources":["../../../src/@types/domains/post.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAA;AAET,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QAEd,KAAK,cAAc,GAAG,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAA;QAEhD,KAAK,eAAe,GAAG,CAAC,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;QAE5D,KAAK,eAAe,GAAG,MAAM,YAAY,CAAA;QAEzC,KAAK,IAAI,CAAC,CAAC,SAAS,eAAe,GAAG,GAAG,IAAI;YAC3C,MAAM,EAAE,MAAM,CAAA;YACd,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC5B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;YACxB,UAAU,EAAE,cAAc,CAAA;YAC1B,QAAQ,EAAE,MAAM,CAAA;YAChB,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;YACtB,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAA;YAChC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAA;YACtC,aAAa,EAAE,MAAM,CAAA;YACrB,kBAAkB,EAAE,KAAK,CAAA;YACzB,iBAAiB,EAAE,KAAK,CAAA;YACxB,QAAQ,EAAE,SAAS,CAAC;SACrB,GACC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,UAAU,CAAC,GAC5B,KAAK,CAAC,QAAQ,GACd,KAAK,CAAC,SAAS,GACf,KAAK,CAAC,SAAS,GACf,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,YAAY,GAClB,KAAK,CAAC,WAAW,CAAC,eAAe,CAAC,CAAA;KACrC;CACF"}

package/dist/@types/domains/reaction.d.ts

@@ -0,0 +1,24 @@
+export {};
+declare global {
+    namespace Amity {
+        type ReactableType = ('message' | 'post' | 'comment');
+        type Reaction = {
+            reactionId: string;
+            userId: string;
+            reactionName: string;
+        } & Amity.CreatedAt & Amity.Relationship<ReactableType>;
+        type Reactions = {
+            reactions: Record<string, number>;
+            count: number;
+        };
+        type Reactable = {
+            reactionsCount: number;
+            reactions: Record<string, number>;
+            myReactions?: string[];
+            latestReaction?: Amity.Reaction & {
+                eventName: ('added' | 'removed');
+            };
+        };
+    }
+}
+//# sourceMappingURL=reaction.d.ts.map

package/dist/@types/domains/stream.d.ts

@@ -0,0 +1,57 @@
+export {};
+declare global {
+    namespace Amity {
+        const enum StreamStatus {
+            IDLE = "idle",
+            LIVE = "live",
+            ENDED = "ended",
+            RECORDED = "recorded"
+        }
+        const enum StreamResolution {
+            SD = "SD",
+            HD = "HD",
+            FHD = "FHD"
+        }
+        type MultiFormat<T> = {
+            flv?: T;
+            mp4?: T;
+            m3u8?: T;
+        };
+        type StreamPlatform = {
+            name: string;
+            version: string;
+        };
+        type StreamEndpoint = {
+            url: string;
+            components: {
+                origin: string;
+                appName: string;
+                streamName: string;
+                query: string;
+            };
+        };
+        type StreamRecording = {
+            url: string;
+            duration: number;
+            startTime: number;
+            stopTime: number;
+        };
+        type Stream = {
+            streamId: string;
+            title: string;
+            thumbnailFileId?: Amity.File<'image'>['fileId'];
+            description?: string;
+            status: StreamStatus;
+            platform: StreamPlatform;
+            isLive?: boolean;
+            endedAt: timestamp;
+            startedAt: timestamp;
+            userId: User['userId'];
+            resolution: StreamResolution;
+            streamerUrl: StreamEndpoint;
+            watcherUrl: MultiFormat<StreamEndpoint>;
+            recordings: MultiFormat<StreamRecording>[];
+        } & Amity.Metadata & Amity.Timestamps & Amity.SoftDelete;
+    }
+}
+//# sourceMappingURL=stream.d.ts.map

package/dist/@types/domains/stream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../../../src/@types/domains/stream.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAA;AAET,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,WAAW,YAAY;YACrB,IAAI,SAAS;YACb,IAAI,SAAS;YACb,KAAK,UAAU;YACf,QAAQ,aAAa;SACtB;QAED,WAAW,gBAAgB;YACzB,EAAE,OAAO;YACT,EAAE,OAAO;YACT,GAAG,QAAQ;SACZ;QAED,KAAK,WAAW,CAAC,CAAC,IAAI;YACpB,GAAG,CAAC,EAAE,CAAC,CAAA;YACP,GAAG,CAAC,EAAE,CAAC,CAAA;YACP,IAAI,CAAC,EAAE,CAAC,CAAA;SACT,CAAA;QAED,KAAK,cAAc,GAAG;YACpB,IAAI,EAAE,MAAM,CAAA;YACZ,OAAO,EAAE,MAAM,CAAA;SAChB,CAAA;QAED,KAAK,cAAc,GAAG;YACpB,GAAG,EAAE,MAAM,CAAA;YACX,UAAU,EAAE;gBACV,MAAM,EAAE,MAAM,CAAA;gBACd,OAAO,EAAE,MAAM,CAAA;gBACf,UAAU,EAAE,MAAM,CAAA;gBAClB,KAAK,EAAE,MAAM,CAAA;aACd,CAAA;SACF,CAAA;QAED,KAAK,eAAe,GAAG;YACrB,GAAG,EAAE,MAAM,CAAA;YACX,QAAQ,EAAE,MAAM,CAAA;YAChB,SAAS,EAAE,MAAM,CAAA;YACjB,QAAQ,EAAE,MAAM,CAAA;SACjB,CAAA;QAED,KAAK,MAAM,GAAG;YACZ,QAAQ,EAAE,MAAM,CAAA;YAChB,KAAK,EAAE,MAAM,CAAA;YACb,eAAe,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAA;YAC/C,WAAW,CAAC,EAAE,MAAM,CAAA;YACpB,MAAM,EAAE,YAAY,CAAA;YACpB,QAAQ,EAAE,cAAc,CAAA;YAExB,MAAM,CAAC,EAAE,OAAO,CAAA;YAChB,OAAO,EAAE,SAAS,CAAA;YAClB,SAAS,EAAE,SAAS,CAAA;YACpB,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;YACtB,UAAU,EAAE,gBAAgB,CAAA;YAE5B,WAAW,EAAE,cAAc,CAAA;YAC3B,UAAU,EAAE,WAAW,CAAC,cAAc,CAAC,CAAA;YACvC,UAAU,EAAE,WAAW,CAAC,eAAe,CAAC,EAAE,CAAA;SAC3C,GACC,KAAK,CAAC,QAAQ,GACd,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,UAAU,CAAA;KACnB;CACF"}

package/dist/@types/domains/user.d.ts

@@ -0,0 +1,13 @@
+export {};
+declare global {
+    namespace Amity {
+        type User = {
+            _id: string;
+            userId: string;
+            displayName?: string;
+            avatarFileId?: Amity.File<'image'>['fileId'];
+            description?: string;
+        } & Amity.Metadata & Amity.Taggable & Amity.Flaggable & Amity.Accredited & Amity.Timestamps & Amity.Subscribable;
+    }
+}
+//# sourceMappingURL=user.d.ts.map

package/dist/@types/domains/user.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../../src/@types/domains/user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAA;AAET,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,KAAK,IAAI,GAAG;YACV,GAAG,EAAE,MAAM,CAAA;YACX,MAAM,EAAE,MAAM,CAAA;YACd,WAAW,CAAC,EAAE,MAAM,CAAA;YACpB,YAAY,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAA;YAC5C,WAAW,CAAC,EAAE,MAAM,CAAA;SACrB,GACC,KAAK,CAAC,QAAQ,GACd,KAAK,CAAC,QAAQ,GACd,KAAK,CAAC,SAAS,GACf,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,YAAY,CAAA;KACrB;CACF"}

package/dist/@types/global.d.ts

@@ -0,0 +1,13 @@
+export {};
+declare global {
+    type Writeable<T> = {
+        -readonly [P in keyof T]: T[P];
+    };
+    type Patch<T, K extends keyof T> = Partial<Pick<T, K>>;
+    type Unwrap<T> = (T extends Promise<infer U> ? U : T extends (...args: any) => Promise<infer U> ? U : T extends (...args: any) => infer U ? U : T);
+    interface ObjectConstructor {
+        keys<T>(o: T): ObjectKeys<T>;
+    }
+    type ObjectKeys<T> = (T extends object ? (keyof T)[] : T extends number ? [] : T extends Array<any> | string ? string[] : never);
+}
+//# sourceMappingURL=global.d.ts.map

package/dist/@types/index.d.ts

@@ -0,0 +1,23 @@
+import './global';
+import './core/errors';
+import './core/permissions';
+import './core/payload';
+import './core/events';
+import './core/paging';
+import './core/query';
+import './core/cache';
+import './domains/client';
+import './domains/user';
+import './domains/file';
+import './domains/partials';
+import './domains/content';
+import './domains/reaction';
+import './domains/group';
+import './domains/channel';
+import './domains/message';
+import './domains/community';
+import './domains/category';
+import './domains/post';
+import './domains/comment';
+import './domains/stream';
+//# sourceMappingURL=index.d.ts.map

package/dist/@types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/@types/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,CAAA;AAEjB,OAAO,eAAe,CAAA;AACtB,OAAO,oBAAoB,CAAA;AAE3B,OAAO,gBAAgB,CAAA;AACvB,OAAO,eAAe,CAAA;AACtB,OAAO,eAAe,CAAA;AACtB,OAAO,cAAc,CAAA;AACrB,OAAO,cAAc,CAAA;AAGrB,OAAO,kBAAkB,CAAA;AAEzB,OAAO,gBAAgB,CAAA;AACvB,OAAO,gBAAgB,CAAA;AAEvB,OAAO,oBAAoB,CAAA;AAC3B,OAAO,mBAAmB,CAAA;AAC1B,OAAO,oBAAoB,CAAA;AAE3B,OAAO,iBAAiB,CAAA;AACxB,OAAO,mBAAmB,CAAA;AAC1B,OAAO,mBAAmB,CAAA;AAE1B,OAAO,qBAAqB,CAAA;AAC5B,OAAO,oBAAoB,CAAA;AAC3B,OAAO,gBAAgB,CAAA;AACvB,OAAO,mBAAmB,CAAA;AAE1B,OAAO,kBAAkB,CAAA"}

package/dist/cache/api/backupCache.d.ts

@@ -0,0 +1,24 @@
+/**
+ * ```js
+ * import { backupCache } from '@amityco/ts-sdk'
+ * const success = await backupCache()
+ * ```
+ *
+ * Writes the {@link Amity.Cache} to a persistent storage.
+ *
+ * The strategy for persistent storage will depend on the runtime,
+ * which is supported by @react-native-async-storage/async-storage.
+ *
+ * The current userId will be appended to the given storageKey to avoid
+ * collision between multiple client instances over time.
+ *
+ * @param storageKey the name of the persistent storage
+ * @param persistIf a custom function to define the persistence policy. Default
+ * will check the value of {@link Amity.CacheEntry["offline"]}, which can be
+ * defined globally when customizing {@link Amity.Cache["persistIf"]}
+ * @returns a success boolean if the cache was dumped to persistent storage
+ *
+ * @category Cache API
+ */
+export declare const backupCache: (storageKey?: string, persistIf?: (entry: Amity.CacheEntry) => boolean | undefined) => Promise<boolean>;
+//# sourceMappingURL=backupCache.d.ts.map

package/dist/cache/api/backupCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"backupCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/backupCache.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,WAAW,gBACV,MAAM,sBACE,MAAM,UAAU,6CAwBrC,CAAA"}

package/dist/cache/api/disableCache.d.ts

@@ -0,0 +1,13 @@
+/**
+ * ```js
+ * import { disableCache } from '@amityco/ts-sdk'
+ * disableCache()
+ * ```
+ *
+ * Wipes the existing {@link Amity.Cache} object attached to
+ * an {@link Amity.Client} instance
+ *
+ * @category Cache API
+ */
+export declare const disableCache: () => void;
+//# sourceMappingURL=disableCache.d.ts.map

package/dist/cache/api/disableCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"disableCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/disableCache.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,YASxB,CAAA"}

package/dist/cache/api/dropFromCache.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { dropFromCache } from '@amityco/ts-sdk'
+ * const success = dropFromCache(['user', 'foobar'])
+ * ```
+ *
+ * Removes an existing {@link Amity.CacheEntry} from the {@link Amity.Client}'s
+ * {@link Amity.Cache} from a given {@link Amity.CacheKey}
+ *
+ * @param key The key of the object to delete
+ * @param exact If false, the function will delete all keys satisfying the given key
+ * @returns A success boolean if the object was deleted
+ *
+ * @category Cache API
+ */
+export declare const dropFromCache: (key: Amity.CacheKey, exact?: boolean) => boolean;
+//# sourceMappingURL=dropFromCache.d.ts.map

package/dist/cache/api/dropFromCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dropFromCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/dropFromCache.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,gCAEjB,OAAO,KACb,OAsBF,CAAA"}

package/dist/cache/api/enableCache.d.ts

@@ -0,0 +1,18 @@
+/**
+ * ```js
+ * import { enableCache } from '@amityco/ts-sdk'
+ * enableCache()
+ * ```
+ *
+ * Adds a new {@link Amity.Cache} object to
+ * an {@link Amity.Client} instance
+ *
+ * @param prevState a previous state of cache instance (useful for SSR)
+ * @param persistIf a function to determine if an entry inserted in cache
+ * is destined to be also saved in the persistent storage when
+ * calling {@link backupCache}
+ *
+ * @category Cache API
+ */
+export declare const enableCache: (prevState?: Amity.Cache['data'], persistIf?: Amity.Cache['persistIf']) => void;
+//# sourceMappingURL=enableCache.d.ts.map

package/dist/cache/api/enableCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enableCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/enableCache.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,WAAW,eACX,WAAW,CAAC,MAAM,CAAC,cAClB,WAAW,CAAC,WAAW,CAAC,SAQrC,CAAA"}

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

@@ -0,0 +1,12 @@
+export * from './enableCache';
+export * from './disableCache';
+export * from './restoreCache';
+export * from './backupCache';
+export * from './wipeCache';
+export * from './queryCache';
+export * from './pullFromCache';
+export * from './pushToCache';
+export * from './mergeInCache';
+export * from './upsertInCache';
+export * from './dropFromCache';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/cache/api/index.ts"],"names":[],"mappings":"AACA,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAG9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAG3B,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAG/B,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA"}

package/dist/cache/api/ingestInCache.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Ingest a payload (v3) into the cache
+ *
+ * @param payload a "backend v3" payload object
+ * @param order the order of the keys to process (in case of need)
+ *
+ * @category Cache
+ * @hidden
+ */
+export declare const ingestInCache: (payload?: Record<string, Record<string, unknown>[]>, options?: Amity.CacheOptions | undefined) => void;
+//# sourceMappingURL=ingestInCache.d.ts.map

package/dist/cache/api/ingestInCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ingestInCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/ingestInCache.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,aACf,OAAO,MAAM,EAAE,OAAO,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,mDAkBnD,CAAA"}

package/dist/cache/api/mergeInCache.d.ts

@@ -0,0 +1,20 @@
+/**
+ * ```js
+ * import { mergeInCache } from '@amityco/ts-sdk'
+ *
+ * mergeInCache(
+ *   ["foo", "bar"],
+ *   (oldVal) => ({ ...oldVal, ...newVal }).
+ * )
+ * ```
+ *
+ * Merges a new {@link Amity.Cache} object to an {@link Amity.Client} instance
+ *
+ * @param key the key matching the object to retrieve from cache
+ * @param mutation either a plain object to shallow merge, or a function.
+ * @returns a success boolean if the object was updated
+ *
+ * @category Cache API
+ */
+export declare const mergeInCache: <T extends {}>(key: Amity.CacheKey, mutation: Partial<T> | ((oldVal: T) => T), options?: Amity.CacheOptions | undefined) => boolean;
+//# sourceMappingURL=mergeInCache.d.ts.map

package/dist/cache/api/mergeInCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergeInCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/mergeInCache.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;GAiBG;AACF,eAAO,MAAM,YAAY,8HAIvB,OAiBF,CAAC"}

package/dist/cache/api/pullFromCache.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { pullFromCache } from '@amityco/ts-sdk'
+ * const user = pullFromCache<Amity.User>(["user", "foobar"])
+ * ```
+ *
+ * Retrieves a {@link Amity.CacheEntry} object matching a given
+ * {@link Amity.CacheKey}. The cache entry is not typed, so the
+ * expected returned type must be passed manually.
+ *
+ * @param key the key matching the object to retrieve from cache
+ * @returns the matching cache entry, or undefined.
+ *
+ * @category Cache API
+ */
+export declare const pullFromCache: <T extends unknown>(key: Amity.CacheKey) => Amity.CacheEntry<T> | undefined;
+//# sourceMappingURL=pullFromCache.d.ts.map

package/dist/cache/api/pullFromCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pullFromCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/pullFromCache.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;GAcG;AACF,eAAO,MAAM,aAAa,6EAa1B,CAAC"}

package/dist/cache/api/pushToCache.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { pushToCache } from '@amityco/ts-sdk'
+ * pushToCache<Amity.User>(["user", "foobar"], user)
+ * ```
+ *
+ * Saves any provided value as {@link Amity.CacheEntry} for the matching {@link Amity.CacheKey}
+ *
+ * @param key the key to save the object to
+ * @param data the object to save
+ * @param options customisation object around cache behavior (default gives a 2mn lifespan)
+ * @returns a success boolean if the object was saved in cache
+ *
+ * @category Cache API
+ */
+export declare const pushToCache: (key: Amity.CacheKey, data: unknown, options?: Amity.CacheOptions) => boolean;
+//# sourceMappingURL=pushToCache.d.ts.map

package/dist/cache/api/pushToCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pushToCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/pushToCache.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;GAcG;AACF,eAAO,MAAM,WAAW,8BAEjB,OAAO,YACJ,MAAM,YAAY,KAC1B,OAgBF,CAAA"}

package/dist/cache/api/queryCache.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { queryCache } from '@amityco/ts-sdk'
+ * const entries = queryCache(["user"])
+ * ```
+ *
+ * Retrieves a list of {@link Amity.CacheEntry} objects matching a
+ * partial {@link Amity.CacheKey}. The cache entries can't be typed,
+ * but the expected returned type can be passed manually.
+ *
+ * @param partialKey the partial key matching the objects to retrieve from cache
+ * @returns the matching cache entries, or empty array.
+ *
+ * @category Cache API
+ */
+export declare const queryCache: <T extends unknown>(key: Amity.CacheKey) => Amity.CacheEntry<T>[] | undefined;
+//# sourceMappingURL=queryCache.d.ts.map

package/dist/cache/api/queryCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/queryCache.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;GAcG;AACF,eAAO,MAAM,UAAU,+EAevB,CAAC"}

package/dist/cache/api/restoreCache.d.ts

@@ -0,0 +1,22 @@
+/**
+ * ```js
+ * import { restoreCache } from '@amityco/ts-sdk'
+ * const success = await restoreCache()
+ * ```
+ *
+ * Reads a previously saved {@link Amity.Cache} from a persistent storage,
+ * and inserts it into the current {@link Amity.Cache} instance.
+ *
+ * The strategy for persistent storage will depend on the runtime,
+ * which is supported by @react-native-async-storage/async-storage.
+ *
+ * The current userId will be appended to the given storageKey to ensures
+ * the cached data concerns only the current user.
+ *
+ * @param storageKey the name of the persistent storage
+ * @returns a success boolean if the cache was dumped to persistent storage
+ *
+ * @category Cache API
+ */
+export declare const restoreCache: (storageKey?: string) => Promise<boolean>;
+//# sourceMappingURL=restoreCache.d.ts.map

package/dist/cache/api/restoreCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"restoreCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/restoreCache.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,YAAY,gBACX,MAAM,qBAiBnB,CAAA"}

package/dist/cache/api/snipeIdFromCollection.d.ts

@@ -0,0 +1,18 @@
+/**
+ * ```js
+ * import { snipeFromCollection } from '@amityco/ts-sdk'
+ * const user = snipeFromCollection("user", "foobar")
+ * ```
+ *
+ * Removes a {@link Amity.Model} object from  matching a given
+ * {@link Amity.CacheKey}. The cache entry is not typed, so the
+ * expected returned type must be passed manually.
+ *
+ * @param domain the key matching the object to retrieve from cache
+ * @param id the key matching the object to retrieve from cache
+ * @returns a success boolean if the id was removed from all matching collections
+ *
+ * @category Cache API
+ */
+export declare const snipeIdFromCollections: (domain: Amity.Domain, id: string) => boolean;
+//# sourceMappingURL=snipeIdFromCollection.d.ts.map

package/dist/cache/api/snipeIdFromCollection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snipeIdFromCollection.d.ts","sourceRoot":"","sources":["../../../src/cache/api/snipeIdFromCollection.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;GAeG;AACF,eAAO,MAAM,sBAAsB,WAC1B,MAAM,MAAM,MAChB,MAAM,YA4BX,CAAC"}

package/dist/cache/api/upsertInCache.d.ts

@@ -0,0 +1,19 @@
+/**
+ * ```js
+ * import { upsertInCache } from '@amityco/ts-sdk'
+ * upsertInCache<Amity.User>(["user", "foobar"], user)
+ * ```
+ *
+ * Insert or update any provided value as {@link Amity.CacheEntry} for
+ * the matching {@link Amity.CacheKey}
+ *
+ * @param key the key to save the object to
+ * @param data the object to save
+ * @param options customisation object around cache behavior (default gives a 2mn lifespan)
+ * @returns a success boolean if the object was saved in cache
+ *
+ * @category Cache API
+ * @hidden
+ */
+export declare const upsertInCache: <T extends {}>(key: Amity.CacheKey, data: T, options?: Amity.CacheOptions) => boolean;
+//# sourceMappingURL=upsertInCache.d.ts.map

package/dist/cache/api/upsertInCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upsertInCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/upsertInCache.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;GAgBG;AACF,eAAO,MAAM,aAAa,yDAGhB,MAAM,YAAY,KAC1B,OAWF,CAAA"}

package/dist/cache/api/wipeCache.d.ts

@@ -0,0 +1,21 @@
+/**
+ * ```js
+ * import { wipeCache } from '@amityco/ts-sdk'
+ * const success = await wipeCache()
+ * ```
+ *
+ * Wipes a persistent storage for the current {@link Amity.Cache} instance.
+ *
+ * The strategy for persistent storage will depend on the runtime,
+ * which is supported by @react-native-async-storage/async-storage.
+ *
+ * The current userId will be appended to the given storageKey to avoid
+ * collision between multiple client instances over time.
+ *
+ * @param storageKey the name of the persistent storage
+ * @returns a success boolean if the persistent cache was wiped.
+ *
+ * @category Cache API
+ */
+export declare const wipeCache: (storageKey?: string) => Promise<boolean>;
+//# sourceMappingURL=wipeCache.d.ts.map

package/dist/cache/api/wipeCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wipeCache.d.ts","sourceRoot":"","sources":["../../../src/cache/api/wipeCache.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,SAAS,gBACR,MAAM,qBAWnB,CAAA"}

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

@@ -0,0 +1,41 @@
+/**
+ * Encodes a given {@link Amity.CacheKey} to a plain string
+ *
+ * @param key the key to encode
+ * @returns an encoded string
+ *
+ * @category Cache
+ * @hidden
+ */
+export declare const encodeKey: (key: Amity.CacheKey) => string;
+/**
+ * Decodes a string back into a {@link Amity.CacheKey}
+
+ *
+ * @param key the string key to decode
+ * @returns a plain Amity.CacheKey object.
+ *
+ * @category Cache
+ * @hidden
+ */
+export declare const decodeKey: (key: string) => Amity.CacheKey;
+/**
+ * Performs a recursive partial deep equal check on two objects.
+ *
+ * @param predicate the reference object containing the partial information
+ * @param candidate the object to check against
+ * @returns true if the candidate contains all the values of the predicate
+ *
+ * @category Cache
+ */
+export declare const partialMatch: (predicate: any, candidate: any) => boolean;
+/**
+ * Type guard to check and cast that a given predicate matched {@link Amity.Cached} shape
+ *
+ * @param obj any {@link Amity.Cached}-like object
+ * @returns success boolean if the given object is of {@link Amity.Cached} shape
+ *
+ * @category Cache
+ */
+export declare const isCached: <T extends unknown>(obj?: any) => obj is Amity.Cached<T>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/cache/utils/index.ts"],"names":[],"mappings":"AAiBA;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,2BAA0B,MAI/C,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,SAAS,QAAS,MAAM,mBAAoC,CAAC;AAG1E;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,cAAe,GAAG,aAAa,GAAG,KAAG,OAe7D,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,4BACb,GAAG,2BAGV,CAAA"}

package/dist/category/api/getCategory.d.ts

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

package/dist/category/api/getCategory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCategory.d.ts","sourceRoot":"","sources":["../../../src/category/api/getCategory.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,WAAW,eACV,MAAM,QAAQ,CAAC,YAAY,CAAC,4BAczC,CAAA"}

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

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