@amityco/ts-sdk 0.0.1-beta.2 → 0.0.1-beta.22

package/src/@types/domains/message.ts

@@ -0,0 +1,36 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type MessageContentType = 'text' | 'file' | 'image' | 'video' | 'audio' | 'custom';
+
+    type MessageContent<T extends Amity.MessageContentType = any> = T extends
+      | 'file'
+      | 'image'
+      | 'video'
+      | 'audio'
+      ? { fileId: string }
+      : unknown;
+
+    type Message<T extends Amity.MessageContentType = any> = {
+      messageId: string;
+
+      channelId: Amity.Channel['channelId'];
+      userId: Amity.User['userId'];
+
+      parentId?: Message['messageId'];
+      childrenNumber: number;
+
+      channelSegment: number;
+
+      editedAt: Amity.timestamp;
+    } & Amity.Content<T, 'type'> &
+      Amity.MessageContent<T> &
+      Amity.Metadata &
+      Amity.Timestamps &
+      Amity.SoftDelete &
+      Amity.Taggable &
+      Amity.Reactable &
+      Amity.Mentionable<'user' | 'channel'>;
+  }
+}

package/src/@types/domains/partials.ts

@@ -0,0 +1,56 @@
+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;
+    };
+  }
+}

package/src/@types/domains/poll.ts

@@ -0,0 +1,32 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type PollDataType = 'text';
+
+    type PollAnswerType = 'single' | 'multiple';
+
+    type PollAnswer = {
+      id: string;
+      dataType: PollDataType;
+      data: string;
+      voteCount: number;
+      isVotedByUser: boolean;
+    };
+
+    type PollStatus = 'closed' | 'open';
+
+    type Poll = {
+      pollId: string;
+      question: string;
+      answers: PollAnswer[];
+      answerType: PollAnswerType;
+      closedAt?: Amity.timestamp;
+      closedIn?: number;
+      isVoted?: boolean;
+      status: PollStatus;
+      userId: Amity.User['userId'];
+    } & Amity.Timestamps &
+      Amity.SoftDelete;
+  }
+}

package/src/@types/domains/post.ts

@@ -0,0 +1,33 @@
+export {};
+
+declare global {
+  namespace Amity {
+    // bad hack until we get proper feed objects in backend
+    type PostTargetType = Amity.FeedType | 'content';
+
+    type PostContentType = 'text' | 'image' | 'file' | 'video' | 'liveStream' | 'poll';
+
+    type Post<T extends PostContentType = any> = {
+      postId: string;
+      postedUserId: Amity.User['userId']; // API-FIX: it should be "userId"
+      parentId: Post['postId'];
+      targetType: PostTargetType;
+      targetId: string;
+      feedId: Amity.Feed['feedId'];
+      children: Amity.Post['postId'][];
+      comments: Amity.Comment['commentId'][];
+      commentsCount: number; // API-FIX: backend doesnt follow its own convention
+      hasFlaggedChildren: false;
+      hasFlaggedComment: false;
+      editedAt: Amity.timestamp;
+    } & Amity.Content<T, 'dataType'> &
+      Amity.Metadata &
+      Amity.Flaggable &
+      Amity.Reactable &
+      Amity.Taggable &
+      Amity.Timestamps &
+      Amity.SoftDelete &
+      Amity.Subscribable &
+      Amity.Mentionable<'user'>;
+  }
+}

package/src/@types/domains/reaction.ts

@@ -0,0 +1,29 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type ReactableType = 'message' | 'post' | 'comment';
+
+    type Reactor = {
+      reactionId: string;
+      reactionName: string;
+      userId: Amity.User['userId'];
+    } & Amity.CreatedAt;
+
+    type Reaction = Amity.Reactor & Amity.Relationship<ReactableType>;
+
+    type Reactable = {
+      reactionsCount: number;
+      reactions: Record<string, number>;
+      myReactions?: string[];
+
+      latestReaction?: Amity.Reaction & {
+        eventName: 'added' | 'removed';
+      };
+    };
+
+    type ReactionQuery = {
+      reactors: Reactor[];
+    } & Amity.Relationship<ReactableType>;
+  }
+}

package/src/@types/domains/stream.ts

@@ -0,0 +1,67 @@
+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;
+  }
+}

package/src/@types/domains/user.ts

@@ -0,0 +1,20 @@
+export {};
+
+declare global {
+  namespace Amity {
+    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;
+  }
+}

package/src/@types/global.ts

@@ -0,0 +1,28 @@
+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;
+
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  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>;
+  }
+}

package/src/@types/index.ts

@@ -0,0 +1,36 @@
+import './global'; // global types (system)
+
+import './core/errors'; // global errors
+import './core/permissions'; // permissions enum
+
+import './core/payload'; // backend payload definition
+import './core/events'; // sdk events definitions
+import './core/paging'; // createQuery, runQuery
+import './core/query'; // createQuery, runQuery
+import './core/cache'; // cache.pull('user', ...)
+
+// domains
+import './domains/client'; // client definition
+
+import './domains/user';
+import './domains/follow';
+import './domains/file';
+
+import './domains/partials'; // small model partials (CreatedAt, etc...)
+import './domains/content'; // content partial
+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';
+
+import './domains/mention';
+
+import './domains/poll';

package/src/@types/mqtt.d.ts

@@ -0,0 +1,3 @@
+declare module 'mqtt/dist/mqtt' {
+  export * from 'mqtt';
+}

package/src/cache/api/backupCache.ts

@@ -0,0 +1,49 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+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 = 'amitySdk',
+  persistIf = (entry: Amity.CacheEntry) => entry.offline,
+): Promise<boolean> => {
+  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,41 @@
+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 = 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,32 @@
+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,43 @@
+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 Record<string, unknown>>(
+  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,31 @@
+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,42 @@
+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) {
+    // eslint-disable-next-line no-param-reassign
+    options.offline = cache.persistIf(key, data);
+  }
+
+  const encodedKey = encodeKey(key);
+  cache.data[encodedKey] = { key, data, ...options };
+
+  return true;
+};