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

package/src/cache/api/backupCache.ts

@@ -0,0 +1,53 @@
+import AsyncStorage from '@react-native-async-storage/async-storage'
+
+import { getActiveClient } from '~/client/api/activeClient'
+
+/**
+ * ```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 const backupCache = async (
+  storageKey: string = 'amitySdk',
+  persistIf = (entry: Amity.CacheEntry) => entry.offline,
+) => {
+  const { log, cache, userId } = getActiveClient()
+
+  if (!cache) return false
+  log('cache/api/backupCache', { storageKey })
+
+  // prepare a subset of the cache where only
+  // objects to backup are there
+  const offlineEntries = Object.fromEntries(
+    Object.entries(cache.data)
+      .filter(([_, entry]) => persistIf(entry))
+  )
+
+  // nothing to backup, abort
+  if (!Object.keys(offlineEntries).length)
+    return false
+
+  await AsyncStorage.setItem(
+    `${storageKey}#${userId}`,
+    JSON.stringify(offlineEntries),
+  )
+
+  return true
+}

package/src/cache/api/disableCache.ts

@@ -0,0 +1,23 @@
+import { getActiveClient } from '~/client/api/activeClient'
+
+/**
+ * ```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 const disableCache = () => {
+  const client = getActiveClient()
+
+  if (!client.cache) return
+  client.log('cache/api/disableCache')
+
+  // we do this so that testing if cache is enabled
+  // is only `if (client.cache)
+  delete client.cache
+}

package/src/cache/api/dropFromCache.ts

@@ -0,0 +1,44 @@
+import { getActiveClient } from '~/client/api/activeClient'
+import { decodeKey, encodeKey, partialMatch } from '../utils'
+
+/**
+ * ```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 const dropFromCache = (
+  key: Amity.CacheKey,
+  exact: boolean = false,
+): boolean => {
+  const { log, cache } = getActiveClient()
+
+  if (!cache) return false
+  log('cache/api/dropFromCache', { key, exact })
+
+  if (!exact) {
+    return (Object.keys(cache.data))
+      .map(stringKey => decodeKey(stringKey))
+      .filter(candidate => partialMatch(key, candidate))
+      .map<boolean>(filteredKey => dropFromCache(filteredKey, true))
+      .every(returned => returned)
+  }
+
+  const encodedKey = encodeKey(key)
+
+  if (encodedKey in cache.data) {
+    delete cache.data[encodedKey]
+    return true
+  }
+
+  return false
+}

package/src/cache/api/enableCache.ts

@@ -0,0 +1,29 @@
+import { getActiveClient } from '~/client/api/activeClient'
+
+/**
+ * ```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 const enableCache = (
+  prevState: Amity.Cache['data'] = {},
+  persistIf?: Amity.Cache['persistIf'],
+) => {
+  const client = getActiveClient()
+
+  if (client.cache) return
+  client.log('cache/api/enableCache')
+
+  client.cache = { data: prevState, persistIf }
+}

package/src/cache/api/index.ts

@@ -0,0 +1,23 @@
+// on/off
+export * from './enableCache'
+export * from './disableCache'
+
+// persistency
+export * from './restoreCache'
+export * from './backupCache'
+export * from './wipeCache'
+
+// fetch
+export * from './queryCache'
+export * from './pullFromCache'
+
+// mutate
+export * from './pushToCache'
+export * from './mergeInCache'
+export * from './upsertInCache'
+export * from './dropFromCache'
+
+/*
+ * ingestInCache and syncInCache are not exported ;
+ * we don't want it as part of the sdk's public api.
+ */

package/src/cache/api/ingestInCache.ts

@@ -0,0 +1,33 @@
+import { PAYLOAD2MODEL, getResolver } from '~/core/model'
+
+import { upsertInCache } from './upsertInCache';
+
+/**
+ * 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 const ingestInCache = (
+  payload: Record<string, Record<string, unknown>[]> = {},
+  options?: Amity.CacheOptions,
+) => {
+  Object.entries(payload)
+    .forEach(([key, models]) => {
+      const type = PAYLOAD2MODEL[key];
+      if (!type) return
+
+      const resolver = getResolver(type);
+      models.forEach(model => {
+        upsertInCache(
+          // eslint-disable @typescript-eslint no-explicit-any
+          [type, 'get', resolver(model as any)], // this 'any' cannot be avoided, sorry.
+          model,
+          options,
+        );
+      })
+    })
+}

package/src/cache/api/mergeInCache.ts

@@ -0,0 +1,45 @@
+import { getActiveClient } from '~/client/api/activeClient'
+
+import { pullFromCache } from './pullFromCache'
+import { pushToCache } from './pushToCache'
+
+/**
+ * ```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 const mergeInCache = <T extends {}>(
+  key: Amity.CacheKey,
+  mutation: Partial<T> | ((oldVal: T) => T),
+  options?: Amity.CacheOptions,
+): boolean => {
+  const { log, cache } = getActiveClient()
+
+  if (!cache) return false
+  log('cache/api/mergeInCache', { key, mutation })
+
+  const oldVal = pullFromCache<T>(key);
+
+  if (!oldVal)
+    return false;
+
+  const newVal = typeof mutation === 'function'
+    ? mutation(oldVal.data)
+    : { ...oldVal.data, ...mutation };
+
+  pushToCache(key, newVal, options);
+  return true;
+};

package/src/cache/api/pullFromCache.ts

@@ -0,0 +1,33 @@
+import { getActiveClient } from '~/client/api/activeClient'
+
+import { encodeKey } from '../utils'
+
+/**
+ * ```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 const pullFromCache = <T extends unknown>(
+  key: Amity.CacheKey
+): Amity.CacheEntry<T> | undefined => {
+  const { log, cache } = getActiveClient()
+
+  if (!cache) return
+  log('cache/api/pullFromCache', key)
+
+  const str = encodeKey(key)
+
+  return !!cache.data[str]
+    ? cache.data[str] as Amity.CacheEntry<T>
+    : undefined
+};

package/src/cache/api/pushToCache.ts

@@ -0,0 +1,40 @@
+import { getActiveClient } from '~/client/api/activeClient'
+
+import { encodeKey } from '../utils'
+
+/**
+ * ```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 const pushToCache = (
+  key: Amity.CacheKey,
+  data: unknown,
+  options: Amity.CacheOptions = { cachedAt: Date.now() },
+): boolean => {
+  const { log, cache } = getActiveClient()
+
+  if (!cache) return false
+  log('cache/api/pushToCache', { key, data, options })
+
+  // if consumer did not pass offline but a offline policy is
+  // defined, use the fn to determine if the object needs to
+  // be saved in persistent storage or not.
+  if (!options?.hasOwnProperty('offline') && cache.persistIf)
+    options.offline = cache.persistIf(key, data)
+
+  const encodedKey = encodeKey(key)
+  cache.data[encodedKey] = { key, data, ...options }
+
+  return true
+}

package/src/cache/api/queryCache.ts

@@ -0,0 +1,35 @@
+import { getActiveClient } from '~/client/api/activeClient'
+
+import { decodeKey, partialMatch } from '../utils'
+
+/**
+ * ```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 const queryCache = <T extends unknown>(
+  key: Amity.CacheKey
+): Amity.CacheEntry<T>[] | undefined => {
+  const { log, cache } = getActiveClient()
+
+  if (!cache) return
+  log('cache/api/queryCache', { key })
+
+  return Object
+    .keys(cache.data)
+    .filter(stringKey => {
+      const decodedKey = decodeKey(stringKey)
+      return partialMatch(key, decodedKey)
+    })
+    .map(stringKey => cache.data[stringKey]) as Amity.CacheEntry<T>[]
+};

package/src/cache/api/restoreCache.ts

@@ -0,0 +1,43 @@
+import AsyncStorage from '@react-native-async-storage/async-storage'
+
+import { getActiveClient } from '~/client/api/activeClient'
+
+/**
+ * ```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 const restoreCache = async (
+  storageKey: string = 'amitySdk'
+) => {
+  const client = getActiveClient()
+
+  if (!client.cache) return false
+  client.log('cache/api/restoreCache', { storageKey })
+
+  const serializedData = (await AsyncStorage.getItem(`${storageKey}#${client.userId}`)) ?? '{}'
+
+  let cache: Amity.Cache['data'] = {}
+
+  try { cache = JSON.parse(serializedData) }
+  catch (err) {}
+
+  // current cache should override. in case there's something fresher.
+  client.cache.data = { ...cache, ...client.cache.data }
+  return true
+}

package/src/cache/api/snipeIdFromCollection.ts

@@ -0,0 +1,53 @@
+import { getActiveClient } from '~/client/api/activeClient'
+
+import { queryCache, mergeInCache, dropFromCache } from '.';
+
+import { decodeKey, partialMatch } from '../utils'
+
+/**
+ * ```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 const snipeIdFromCollections = (
+  domain: Amity.Domain,
+  id: string,
+) => {
+  const { log, cache } = getActiveClient()
+
+  if (!cache) return false
+  log('cache/api/snipeFromCollections', { domain, id })
+
+  const entries = (queryCache<unknown[]>([domain, 'query']) ?? [])
+    .filter(entry => entry?.data.includes(id))
+
+  if (!entries.length)
+    return false
+
+  const toBeDeleted: Amity.CacheKey[] = []
+
+  entries.forEach(({ key }) => {
+    mergeInCache<unknown[]>(key, (oldVal) => {
+      const newVal = oldVal.filter(itemId => itemId !== id)
+
+      if (!newVal.length)
+        toBeDeleted.push(key)
+
+      return newVal
+    })
+  })
+
+  toBeDeleted.forEach(key => dropFromCache(key, true))
+  return true
+};

package/src/cache/api/upsertInCache.ts

@@ -0,0 +1,39 @@
+import { getActiveClient } from '~/client/api/activeClient'
+
+import { pullFromCache } from './pullFromCache'
+import { pushToCache } from './pushToCache'
+import { mergeInCache } from './mergeInCache'
+
+/**
+ * ```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 const upsertInCache = <T extends {}>(
+  key: Amity.CacheKey,
+  data: T,
+  options: Amity.CacheOptions = { cachedAt: Date.now() },
+): boolean => {
+  const { log, cache } = getActiveClient()
+
+  if (!cache) return false
+  log('cache/api/upsertInCache', { key, data, options })
+
+  const cached = pullFromCache<T>(key)
+
+  return cached
+    ? mergeInCache<T>(key, data, options)
+    : pushToCache(key, data, options)
+}

package/src/cache/api/wipeCache.ts

@@ -0,0 +1,36 @@
+import AsyncStorage from '@react-native-async-storage/async-storage'
+
+import { getActiveClient } from '~/client/api/activeClient'
+
+/**
+ * ```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 const wipeCache = async (
+  storageKey: string = 'amitySdk'
+) => {
+  const { log, cache, userId } = getActiveClient()
+
+  if (!cache) return false
+  log('cache/api/wipeCache', { storageKey })
+
+  cache.data = {}
+  await AsyncStorage.setItem(`${storageKey}#${userId}`, '{}')
+
+  return true
+}

package/src/cache/utils/index.ts

@@ -0,0 +1,84 @@
+/**
+ * Shallow-clones an object and sort its keys
+ *
+ * @param source a plain object to clone
+ * @returns a clone of source, with keys sorted with default javascript sorting
+ *
+ * @category Cache
+ * @hidden
+ */
+const normalize = (
+  source: Record<string, Amity.Serializable>
+): Record<string, Amity.Serializable> => (
+  Object.keys(source)
+    .sort()
+    .reduce((acc, key) => ({ ...acc, [key]: source[key] }), {})
+)
+
+/**
+ * Encodes a given {@link Amity.CacheKey} to a plain string
+ *
+ * @param key the key to encode
+ * @returns an encoded string
+ *
+ * @category Cache
+ * @hidden
+ */
+export const encodeKey = (key: Amity.CacheKey): string => (
+ JSON.stringify(key, (_, val) =>
+   typeof val === "object" ? normalize(val) : val
+ )
+);
+
+/**
+ * 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 const decodeKey = (key: string): Amity.CacheKey => JSON.parse(key);
+
+
+/**
+ * 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 const partialMatch = (predicate: any, candidate: any): boolean => {
+  if (predicate === candidate) return true;
+
+  // if one or the other is nullish, there can't be equality
+  else if (!predicate || !candidate) return false;
+
+ // we only perform recursive check on objects
+ else if (typeof predicate !== "object") {
+   return false;
+ }
+
+ // recursively call for partial match based on the predicate
+ return Object.keys(predicate).every((key) =>
+   partialMatch(predicate[key], candidate[key])
+ );
+}
+
+/**
+ * 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 const isCached = <T extends unknown>(
+  obj?: any
+): obj is Amity.Cached<T> => (
+  ['data', 'cachedAt'].every(prop => obj?.hasOwnProperty(prop))
+)

package/src/category/api/getCategory.ts

@@ -0,0 +1,34 @@
+import { getActiveClient } from '~/client/api/activeClient'
+
+// import { ingestInCache } from '~/cache/api/ingestInCache'
+
+/**
+ * ```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 const getCategory = async (
+  categoryId: Amity.Category['categoryId']
+) => {
+  const client = getActiveClient()
+  client.log('category/getCategory', categoryId)
+
+  const { data } = await client.http.get<Amity.CategoryPayload>(
+    `/api/v3/community-categories/${categoryId}`
+  )
+
+  // decoratePayload(data)
+  // ingestInCache(data)
+
+  const { categories } = data
+  return categories[0]
+}

package/src/category/api/index.ts

@@ -0,0 +1,2 @@
+export * from './queryCategories'
+export * from './getCategory'