@amityco/ts-sdk 0.0.1-beta → 0.0.1-beta-35

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: Amity.timestamp;
+            startedAt: Amity.timestamp;
+            userId: Amity.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,CAAC;AAEV,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,CAAC;YACR,GAAG,CAAC,EAAE,CAAC,CAAC;YACR,IAAI,CAAC,EAAE,CAAC,CAAC;SACV,CAAC;QAEF,KAAK,cAAc,GAAG;YACpB,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;QAEF,KAAK,cAAc,GAAG;YACpB,GAAG,EAAE,MAAM,CAAC;YACZ,UAAU,EAAE;gBACV,MAAM,EAAE,MAAM,CAAC;gBACf,OAAO,EAAE,MAAM,CAAC;gBAChB,UAAU,EAAE,MAAM,CAAC;gBACnB,KAAK,EAAE,MAAM,CAAC;aACf,CAAC;SACH,CAAC;QAEF,KAAK,eAAe,GAAG;YACrB,GAAG,EAAE,MAAM,CAAC;YACZ,QAAQ,EAAE,MAAM,CAAC;YACjB,SAAS,EAAE,MAAM,CAAC;YAClB,QAAQ,EAAE,MAAM,CAAC;SAClB,CAAC;QAEF,KAAK,MAAM,GAAG;YACZ,QAAQ,EAAE,MAAM,CAAC;YACjB,KAAK,EAAE,MAAM,CAAC;YACd,eAAe,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC;YAChD,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,MAAM,EAAE,YAAY,CAAC;YACrB,QAAQ,EAAE,cAAc,CAAC;YAEzB,MAAM,CAAC,EAAE,OAAO,CAAC;YACjB,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC;YACzB,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;YAC3B,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC7B,UAAU,EAAE,gBAAgB,CAAC;YAE7B,WAAW,EAAE,cAAc,CAAC;YAC5B,UAAU,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC;YACxC,UAAU,EAAE,WAAW,CAAC,eAAe,CAAC,EAAE,CAAC;SAC5C,GAAG,KAAK,CAAC,QAAQ,GAChB,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,UAAU,CAAC;KACpB;CACF"}

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

@@ -0,0 +1,15 @@
+export {};
+declare global {
+    namespace Amity {
+        type UserActionType = 'onFetch' | 'onUpdate' | 'onDelete' | 'onFlagged' | 'onUnflagged' | 'onFlagCleared';
+        type User = {
+            _id: string;
+            userId: string;
+            displayName?: string;
+            avatarFileId?: Amity.File<'image'>['fileId'];
+            avatarCustomUrl?: string;
+            description?: string;
+        } & Amity.Metadata & Amity.Taggable & Amity.Flaggable & Amity.Accredited & Amity.Timestamps & Amity.SoftDelete & 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,CAAC;AAEV,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,KAAK,cAAc,GACf,SAAS,GACT,UAAU,GACV,UAAU,GACV,WAAW,GACX,aAAa,GACb,eAAe,CAAC;QAEpB,KAAK,IAAI,GAAG;YACV,GAAG,EAAE,MAAM,CAAC;YACZ,MAAM,EAAE,MAAM,CAAC;YACf,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,YAAY,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC;YAC7C,eAAe,CAAC,EAAE,MAAM,CAAC;YACzB,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB,GAAG,KAAK,CAAC,QAAQ,GAChB,KAAK,CAAC,QAAQ,GACd,KAAK,CAAC,SAAS,GACf,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,YAAY,CAAC;KACtB;CACF"}

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

@@ -0,0 +1,14 @@
+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;
+    type ObjectKeys<T> = T extends object ? (keyof T)[] : T extends number ? [] : T extends Array<any> | string ? string[] : never;
+    interface ObjectConstructor {
+        keys<T>(o: T): ObjectKeys<T>;
+    }
+    type ValueOf<T extends Record<any, any>> = T[keyof T];
+}
+//# sourceMappingURL=global.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"global.d.ts","sourceRoot":"","sources":["../../src/@types/global.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC;AAEV,OAAO,CAAC,MAAM,CAAC;IACb,KAAK,SAAS,CAAC,CAAC,IAAI;QAAE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KAAE,CAAC;IAEvD,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEvD,KAAK,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,CAAC,GACvC,CAAC,GACD,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,GAC5C,CAAC,GACD,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,MAAM,CAAC,GACnC,CAAC,GACD,CAAC,CAAC;IAGN,KAAK,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GACjC,CAAC,MAAM,CAAC,CAAC,EAAE,GACX,CAAC,SAAS,MAAM,GAChB,EAAE,GACF,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,GAC7B,MAAM,EAAE,GACR,KAAK,CAAC;IAEV,UAAU,iBAAiB;QACzB,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;KAC9B;IAED,KAAK,OAAO,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;CACvD"}

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

@@ -0,0 +1,27 @@
+import './global';
+import './core/errors';
+import './core/permissions';
+import './core/payload';
+import './core/events';
+import './core/paging';
+import './core/query';
+import './core/cache';
+import './core/live';
+import './domains/client';
+import './domains/user';
+import './domains/follow';
+import './domains/partials';
+import './domains/reaction';
+import './domains/group';
+import './domains/channel';
+import './domains/category';
+import './domains/comment';
+import './domains/stream';
+import './domains/mention';
+import './domains/poll';
+export * from './domains/community';
+export * from './domains/content';
+export * from './domains/file';
+export * from './domains/message';
+export * from './domains/post';
+//# 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,CAAC;AAElB,OAAO,eAAe,CAAC;AACvB,OAAO,oBAAoB,CAAC;AAE5B,OAAO,gBAAgB,CAAC;AACxB,OAAO,eAAe,CAAC;AACvB,OAAO,eAAe,CAAC;AACvB,OAAO,cAAc,CAAC;AACtB,OAAO,cAAc,CAAC;AACtB,OAAO,aAAa,CAAC;AAGrB,OAAO,kBAAkB,CAAC;AAE1B,OAAO,gBAAgB,CAAC;AACxB,OAAO,kBAAkB,CAAC;AAE1B,OAAO,oBAAoB,CAAC;AAC5B,OAAO,oBAAoB,CAAC;AAE5B,OAAO,iBAAiB,CAAC;AACzB,OAAO,mBAAmB,CAAC;AAE3B,OAAO,oBAAoB,CAAC;AAC5B,OAAO,mBAAmB,CAAC;AAE3B,OAAO,kBAAkB,CAAC;AAE1B,OAAO,mBAAmB,CAAC;AAE3B,OAAO,gBAAgB,CAAC;AAExB,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC"}

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,4CAEF,MAAM,UAAU,6BACnC,QAAQ,OAAO,CAkBjB,CAAC"}

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,CAAC"}

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,4CAAyC,OAsBlE,CAAC"}

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,CAAC"}

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,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAG/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAG5B,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAGhC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC"}

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 options caching options like cachedAt or offline
+ *
+ * @category Cache
+ * @hidden
+ */
+export declare const ingestInCache: (payload?: Record<string, Record<string, unknown>[]>, options?: Amity.CacheOptions) => 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,YACxC,MAAM,YAAY,SAgB7B,CAAC"}

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

@@ -0,0 +1,18 @@
+/**
+ * ```js
+ * import { isInTombstone } from '@amityco/ts-sdk'
+ * const user = isInTombstone(["message", "messageId"])
+ * ```
+ *
+ * Checks if the {@link Amity.TombstoneCacheOptions} exists
+ * in cache and it's not expired means it's in tombstone
+ * and we throw an Error
+ *
+ * @param model the model to check
+ * @param modelId the object id to check
+ * @returns the matching cache entry, or undefined.
+ *
+ * @category Cache API
+ */
+export declare const isInTombstone: (model: Amity.Domain, modelId: string) => void;
+//# sourceMappingURL=isInTombstone.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isInTombstone.d.ts","sourceRoot":"","sources":["../../../src/cache/api/isInTombstone.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,aAAa,UAAW,MAAM,MAAM,WAAW,MAAM,SAiBjE,CAAC"}

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 Record<string, unknown>>(key: Amity.CacheKey, mutation: Partial<T> | ((oldVal: T) => T), options?: Amity.CacheOptions) => 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;AACH,eAAO,MAAM,YAAY,gHAGb,MAAM,YAAY,KAC3B,OAeF,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;AACH,eAAO,MAAM,aAAa,6EAWzB,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;AACH,eAAO,MAAM,WAAW,8BAEhB,OAAO,YACJ,MAAM,YAAY,KAC1B,OAkBF,CAAC"}

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

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { pushToTombstone } from '@amityco/ts-sdk'
+ * pushToTombstone(["message", "messageId"], { cachedAt: Date.now() })
+ * ```
+ *
+ * Removes an existing {@link Amity.CacheEntry} from the {@link Amity.Client}'s
+ * {@link Amity.Cache} from a given {@link Amity.CacheKey}
+ *
+ * @param model the model to remove and push to Tombstone
+ * @param modelId the related model id
+ *
+ * @category Cache API
+ * @hidden
+ */
+export declare const pushToTombstone: (model: Amity.Domain, modelId: string) => void;
+//# sourceMappingURL=pushToTombstone.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pushToTombstone.d.ts","sourceRoot":"","sources":["../../../src/cache/api/pushToTombstone.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,eAAe,UAAW,MAAM,MAAM,WAAW,MAAM,SAWnE,CAAC"}

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;AACH,eAAO,MAAM,UAAU,+EActB,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,2CAmBxB,CAAC"}

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":"AAIA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,sBAAsB,WAAY,MAAM,MAAM,MAAM,MAAM,YA2BtE,CAAC"}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 Record<string, unknown>>(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;AACH,eAAO,MAAM,aAAa,8EAGf,MAAM,YAAY,KAC1B,OASF,CAAC"}

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,2CAUrB,CAAC"}

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

@@ -0,0 +1,58 @@
+export declare const CACHE_KEY_GET = "get";
+export declare const CACHE_KEY_QUERY = "query";
+export declare const CACHE_KEY_TOMBSTONE = "dead";
+export declare const CACHE_KEY_COLLECTION = "collection";
+export declare const CACHE_LIFESPAN: number;
+export declare const CACHE_LIFESPAN_TOMBSTONE: number;
+/**
+ * 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>;
+/**
+ * checks if passed error code is included in
+ * Tombstone errors list
+ *
+ * @param errorCode as {@link Amity.ServerError}
+ * @returns success boolean if the given errorCode
+ * is included in Tombstone errors list
+ *
+ * @category Cache
+ */
+export declare const checkIfShouldGoesToTombstone: (errorCode: Amity.ServerError) => boolean;
+//# 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":"AACA,eAAO,MAAM,aAAa,QAAQ,CAAC;AACnC,eAAO,MAAM,eAAe,UAAU,CAAC;AACvC,eAAO,MAAM,mBAAmB,SAAS,CAAC;AAC1C,eAAO,MAAM,oBAAoB,eAAe,CAAC;AAEjD,eAAO,MAAM,cAAc,QAAgB,CAAC;AAC5C,eAAO,MAAM,wBAAwB,QAAgB,CAAC;AAkBtD;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,2BAA0B,MACmC,CAAC;AAEpF;;;;;;;;;GASG;AACH,eAAO,MAAM,SAAS,QAAS,MAAM,mBAAoC,CAAC;AAE1E;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,cAAe,GAAG,aAAa,GAAG,KAAG,OAa7D,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,4BAA6B,GAAG,2BACU,CAAC;AAEhE;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B,cAAe,MAAM,WAAW,KAAG,OACS,CAAC"}

package/dist/cache/utils/tests/encodeKey.test.d.ts

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

package/dist/cache/utils/tests/encodeKey.test.d.ts.map

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

package/dist/cache/utils/tests/partialMatch.test.d.ts

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

package/dist/cache/utils/tests/partialMatch.test.d.ts.map

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