@amityco/ts-sdk 0.0.1-02f0fa3.0

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

@@ -0,0 +1,57 @@
+export {}
+
+declare global {
+  namespace Amity {
+    const enum StreamStatus {
+      IDLE = 'idle',
+      LIVE = 'live',
+      ENDED = 'ended',
+      RECORDED = 'recorded',
+    }
+
+    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
+
+      streamerUrl: StreamEndpoint
+      watcherUrl: MultiFormat<StreamEndpoint>
+      recordings: MultiFormat<StreamRecording>[]
+    }
+    & Amity.Metadata
+    & Amity.Timestamps
+    & Amity.SoftDelete
+    & Amity.Syncable
+  }
+}

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

@@ -0,0 +1,18 @@
+export {}
+
+declare global {
+  namespace Amity {
+    type User = {
+      userId: string
+      displayName?: string
+      avatarFileId?: Amity.File<'image'>['fileId']
+      description?: string
+    }
+    & Amity.Metadata
+    & Amity.Taggable
+    & Amity.Flaggable
+    & Amity.Accredited
+    & Amity.Timestamps
+    & Amity.Syncable
+  }
+}

package/src/@types/global.ts

@@ -0,0 +1,25 @@
+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
+  )
+}

package/src/@types/index.ts

@@ -0,0 +1,31 @@
+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/query' // createQuery, runQuery
+import './core/store' // store definition
+import './core/cache' // cache.pull('user', ...)
+
+// domains
+import './domains/client' // client definition
+
+import './domains/user'
+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'

package/src/category/api/getCategory.ts

@@ -0,0 +1,35 @@
+import { getActiveClient } from '~/client/api/activeClient'
+
+import { decoratePayload } from '~/core/query'
+import { ingestInCache } from '~/core/cache'
+
+/**
+ * ```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'

package/src/category/api/queryCategories.ts

@@ -0,0 +1,49 @@
+import { getActiveClient } from '~/client/api/activeClient'
+
+import { decoratePayload, toPage, toToken } from '~/core/query'
+import { ingestInCache } from '~/core/cache'
+import { toRecord } from '~/core/model'
+
+/**
+ * ```js
+ * import { queryCategories } from '@amityco/ts-sdk'
+ * const categories = await queryCategories()
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.Category} objects
+ *
+ * @param query The query parameters
+ * @returns A page of {@link Amity.Category} objects
+ *
+ * @category Community API
+ * @async
+ **/
+export const queryCategories = async (query?: {
+  sortBy?: 'lastCreated' | 'firstCreated' | 'name'
+  isDeleted?: Amity.Category['isDeleted']
+  page?: Amity.Page
+}) => {
+  const client = getActiveClient()
+  client.log('category/queryCategories', query)
+
+  const { page, ...params } = query ?? {}
+
+  const { data } = await client.http.get<Amity.CategoryPayload & Amity.Pagination>(
+    `/api/v3/community-categories`, { params : {
+      ...params,
+      options: {
+        token: toToken(page, 'skiplimit')
+      }
+    } })
+
+  const { paging, ...response } = data
+
+  decoratePayload(response as unknown as Record<string, any[]>)
+  ingestInCache(response as unknown as Record<string, any[]>)
+
+  const prevPage = toPage(paging?.previous)
+  const nextPage = toPage(paging?.next)
+
+  const { categories } = response
+  return [toRecord(categories), { prevPage, nextPage }] as const
+}

package/src/channel/api/addChannelMembers.ts

@@ -0,0 +1,45 @@
+import { getActiveClient } from '~/client/api'
+
+import { decoratePayload } from '~/core/query'
+import { ingestInCache } from '~/core/cache'
+import { fireEvent } from '~/core/events'
+
+/**
+ * ```js
+ * import { addChannelMembers } from '@amityco/ts-sdk'
+ * const updated = await addChannelMembers(channelId, ['foo', 'bar'])
+ * ```
+ *
+ * Adds a list of {@link Amity.User} to a {@link Amity.Channel}
+ *
+ * @param channelId The ID of the {@link Amity.Channel} to perform
+ * @param userIds The list of IDs {@link Amity.User} to add
+ * @returns A success boolean if the {@link Amity.User} were added to the {@link Amity.Channel}
+ *
+ * @category Channel API
+ * @async
+ */
+export const addChannelMembers = async (
+  channelId: Amity.Channel['channelId'],
+  userIds: Amity.User['userId'][]
+) => {
+  const client = getActiveClient()
+  client.log('channel/addChannelMembers', channelId, userIds)
+
+  const { data } = await client.http.post<Amity.ChannelMembershipPayload>(
+    `/api/v3/channels/${channelId}/users`,
+    { channelId, userIds }
+  )
+
+  decoratePayload(data)
+  ingestInCache(data)
+  fireEvent('v3.channel.didAddUsers', {
+    channels: data.channels!,
+  })
+
+  const { channelUsers } = data
+  return !!channelUsers.find(
+    channelUser =>
+      channelUser.channelId === channelId && channelUser.membership === 'member'
+  )
+}

package/src/channel/api/addChannelMembersRole.ts

@@ -0,0 +1,43 @@
+import { getActiveClient } from '~/client/api'
+
+import { decoratePayload } from '~/core/query'
+import { ingestInCache } from '~/core/cache'
+
+/**
+ * ```js
+ * import { addChannelMembersRole } from '@amityco/ts-sdk'
+ * const updated = await addChannelMembersRole(channelId, 'foo', ['bar'])
+ * ```
+ *
+ * Adds an {@link Amity.Role} to a list of {@link Amity.User} on a {@link Amity.Channel}
+ *
+ * @param channelId The ID of the {@link Amity.Channel} to perform
+ * @param roleId The ID of the {@link Amity.Role} to apply
+ * @param userId Array of IDs of the {@link Amity.User} to perform
+ * @returns A success boolean if the {@link Amity.Role} were added to list of {@link Amity.User} in the {@link Amity.Channel}
+ *
+ * @category Channel API
+ * @async
+ */
+export const addChannelMembersRole = async (
+  channelId: Amity.Channel['channelId'],
+  roleId: Amity.Role['roleId'],
+  userIds: Amity.User['userId'][]
+) => {
+  const client = getActiveClient()
+  client.log('channel/addChannelMembersRole', channelId, roleId, userIds)
+
+  const { data } = await client.http.post<Amity.ChannelMembershipPayload>(
+    `/api/v3/channels/${channelId}/users/roles`,
+    { channelId, role: roleId, userIds }
+  )
+
+  decoratePayload(data)
+  ingestInCache(data)
+
+  const { channelUsers } = data
+  return !!channelUsers.find(
+    channelUser =>
+      channelUser.channelId === channelId && channelUser.roles.includes(roleId)
+  )
+}

package/src/channel/api/createChannel.ts

@@ -0,0 +1,37 @@
+import { getActiveClient } from '~/client/api'
+
+import { decoratePayload } from '~/core/query'
+import { ingestInCache } from '~/core/cache'
+
+/**
+ * ```js
+ * import { createChannel } from '@amityco/ts-sdk'
+ * const created = await createChannel({ channelId: 'foobar', displayName: 'foobar' })
+ * ```
+ *
+ * Creates an {@link Amity.Channel}
+ *
+ * @param bundle The data necessary to create a new {@link Amity.Channel}
+ * @returns The newly created {@link Amity.Channel}
+ *
+ * @category Channel API
+ * @async
+ */
+export const createChannel = async <T extends Amity.ChannelType>(
+  bundle: { type: T, userIds?: Amity.User['userId'] }
+  & Pick<Amity.Channel<T>, 'displayName' | 'avatarFileId' | 'tags' | 'metadata'>
+) => {
+  const client = getActiveClient()
+  client.log('user/createChannel', bundle)
+
+  const { data } = await client.http.post<Amity.ChannelPayload>(
+    '/api/v3/channels', bundle,
+  )
+
+  decoratePayload(data)
+  ingestInCache(data)
+  // no need for event, fired by server
+
+  const { channels } = data
+  return channels[0]
+}

package/src/channel/api/deleteChannel.ts

@@ -0,0 +1,34 @@
+import { getActiveClient } from '~/client/api'
+
+import { getChannel } from './getChannel'
+
+/**
+ * ```js
+ * import { deleteChannel } from '@amityco/ts-sdk'
+ * const success = await deleteChannel('foobar')
+ * ```
+ *
+ * Deletes a {@link Amity.Channel}
+ *
+ * @param channelId The {@link Amity.Channel} ID to delete
+ * @return A success boolean if the {@link Amity.Channel} was deleted
+ *
+ * @category Channel API
+ * @async
+ */
+export const deleteChannel = async (
+  channelId: Amity.Channel['channelId'],
+) => {
+  const client = getActiveClient()
+  client.log('channel/deleteChannel', channelId)
+
+  // API-FIX: This endpoint has not been implemented yet.
+  await client.http.delete<{ success: boolean }>(
+    `/api/v3/channels/${channelId}`
+  )
+
+  const deleted = await getChannel(channelId)
+  // no need for event, fired by server
+
+  return deleted
+}

package/src/channel/api/getChannel.ts

@@ -0,0 +1,59 @@
+import { getActiveClient } from '~/client/api'
+
+import { ingestInCache, pullFromCache } from '~/core/cache'
+import { decoratePayload } from '~/core/query'
+
+/**
+ * ```js
+ * import { getChannel } from '@amityco/ts-sdk'
+ * const channel = await getChannel('foobar')
+ * ```
+ *
+ * Fetches a {@link Amity.Channel} object
+ *
+ * @param channelId the ID of the {@link Amity.Channel} to fetch
+ * @returns the associated {@link Amity.Channel} object
+ *
+ * @category Channel API
+ * @async
+ */
+export const getChannel = async (
+  channelId: Amity.Channel['channelId'],
+) => {
+  const client = getActiveClient()
+  client.log('channel/getChannel', channelId)
+
+  // API-FIX: endpoint should not be /list, parameters should be querystring.
+  const { data } = await client.http.get<Amity.ChannelPayload>(
+    `/api/v3/channels/${channelId}`,
+  )
+
+  decoratePayload(data)
+  ingestInCache(data)
+
+  const { channels } = data
+  return channels.find(channel => channel.channelId === channelId)!
+}
+
+/**
+ * ```js
+ * import { getChannel } from '@amityco/ts-sdk'
+ * const channel = getChannel.locally('foobar')
+ * ```
+ *
+ * Fetches a {@link Amity.Channel} object from cache
+ *
+ * @param channelId the ID of the {@link Amity.Channel} to fetch
+ * @returns the associated {@link Amity.Channel} object
+ *
+ * @category Channel API
+ */
+getChannel.locally = (
+  channelId: Amity.Channel['channelId'],
+) => {
+  const client = getActiveClient()
+  client.log('channel/getChannel.locally', channelId)
+
+  const [channel] = pullFromCache('channel', channelId) ?? []
+  return channel
+}

package/src/channel/api/getChannels.ts

@@ -0,0 +1,63 @@
+import { getActiveClient } from '~/client/api'
+
+import { decoratePayload } from '~/core/query'
+import { ingestInCache, pullFromCache } from '~/core/cache'
+import { toRecord } from '~/core/model'
+
+/**
+ * ```js
+ * import { getChannels } from '@amityco/ts-sdk'
+ * const channels = await getChannels(['foo', 'bar'])
+ * ```
+ *
+ * Fetches a collection of {@link Amity.Channel} objects
+ *
+ * @param channelIds the IDs of the {@link Amity.Channel} to fetch
+ * @returns the associated collection of {@link Amity.Channel} objects
+ *
+ * @category Channel API
+ * @async
+ */
+export const getChannels = async (
+  channelIds: Amity.Channel['channelId'][],
+) => {
+  const client = getActiveClient()
+  client.log('channel/getChannels', channelIds)
+
+  // API-FIX: endpoint should not be /list, parameters should be querystring.
+  const { data } = await client.http.get<Amity.ChannelPayload>(
+    `/api/v3/channels/list`,
+    { params: { channelIds } },
+  )
+
+  decoratePayload(data)
+  ingestInCache(data)
+
+  const { channels } = data
+  return toRecord(channels)
+}
+
+/**
+ * ```js
+ * import { getChannels } from '@amityco/ts-sdk'
+ * const channels = getChannels.locally(['foo', 'bar']) ?? []
+ * ```
+ *
+ * Fetches a collection of {@link Amity.Channel} objects from cache
+ *
+ * @param channelIds the IDs of the {@link Amity.Channel} to fetch
+ * @returns the associated collection of {@link Amity.Channel} objects
+ *
+ * @category Channel API
+ */
+getChannels.locally = (
+  channelIds: Amity.Channel['channelId'][],
+) => {
+  const client = getActiveClient()
+  client.log('channel/getChannels.locally', channelIds)
+
+  const cached = pullFromCache('channel', ...channelIds) ?? []
+
+  if (cached?.length === channelIds.length)
+    return toRecord(cached!)
+}

package/src/channel/api/index.ts

@@ -0,0 +1,18 @@
+export * from './queryChannels'
+export * from './getChannels'
+export * from './getChannel'
+
+export * from './createChannel'
+export * from './updateChannel'
+export * from './deleteChannel'
+
+export * from './joinChannel'
+export * from './leaveChannel'
+
+export * from './queryChannelMembers'
+
+export * from './addChannelMembers'
+export * from './removeChannelMembers'
+
+export * from './addChannelMembersRole'
+export * from './removeChannelMembersRole'

package/src/channel/api/joinChannel.ts

@@ -0,0 +1,38 @@
+import { getActiveClient } from '~/client/api'
+
+import { decoratePayload } from '~/core/query'
+import { ingestInCache } from '~/core/cache'
+
+/**
+ * ```js
+ * import { joinChannel } from '@amityco/ts-sdk'
+ * const isJoined = await joinChannel('foobar')
+ * ```
+ *
+ * Joins a {@link Amity.Channel} object
+ *
+ * @param channelId the {@link Amity.Channel} to join
+ * @returns A success boolean if the {@link Amity.Channel} was joined
+ *
+ * @category Channel API
+ * @async
+ */
+export const joinChannel = async (channelId: Amity.Channel['channelId']) => {
+  const client = getActiveClient()
+  client.log('channel/joinChannel', channelId)
+
+  const { data } = await client.http.post<Amity.ChannelMembershipPayload>(
+    `/api/v3/channels/${channelId}/join`,
+  )
+
+  decoratePayload(data)
+  ingestInCache(data)
+  // no need for event, fired by server
+
+  const { channelUsers } = data
+
+  return !!channelUsers.find(channelUser => (
+    channelUser.channelId === channelId
+    && channelUser.membership === 'member'
+  ))
+}

package/src/channel/api/leaveChannel.ts

@@ -0,0 +1,38 @@
+import { getActiveClient } from '~/client/api'
+
+import { decoratePayload } from '~/core/query'
+import { ingestInCache } from '~/core/cache'
+
+/**
+ * ```js
+ * import { leaveChannel } from '@amityco/ts-sdk'
+ * const isLeft = await leaveChannel('foobar')
+ * ```
+ *
+ * Leave a {@link Amity.Channel} object
+ *
+ * @param channelId the {@link Amity.Channel} to leave
+ * @returns A success boolean if the {@link Amity.Channel} was left
+ *
+ * @category Channel API
+ * @async
+ */
+export const leaveChannel = async (channelId: Amity.Channel['channelId']) => {
+  const client = getActiveClient()
+  client.log('channel/leaveChannel', channelId)
+
+  const { data } = await client.http.delete<Amity.ChannelMembershipPayload>(
+    `/api/v3/channels/${channelId}/leave`,
+  )
+
+  decoratePayload(data)
+  ingestInCache(data)
+  // no need for event, fired by server
+
+  const { channelUsers } = data
+
+  return !!channelUsers.find(channelUser => (
+    channelUser.channelId === channelId
+    && channelUser.membership !== 'member'
+  ))
+}

package/src/channel/api/queryChannelMembers.ts

@@ -0,0 +1,79 @@
+import { getActiveClient } from '~/client/api'
+
+import { decoratePayload, toPage, toToken } from '~/core/query'
+import { ingestInCache } from '~/core/cache'
+
+import { toRecord } from '~/core/model'
+
+/**
+ * ```js
+ * import { queryChannelMembers } from '@amityco/ts-sdk'
+ * const channelMembers = await queryChannelMembers({ channelId: 'foo' })
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.ChannelUser} objects
+ *
+ * @param query The query parameters
+ * @returns A page of {@link Amity.ChannelUser} objects
+ *
+ * @category Channel API
+ * @async
+ **/
+export const queryChannelMembers = async (query: {
+  channelId: string
+  membership?: 'all' | 'muted' | 'banned' | 'member&banned'
+  roles?: string[]
+  sortBy?: 'firstCreated' | 'lastCreated'
+  page?: Amity.Page
+}) => {
+  const client = getActiveClient()
+  client.log('channel/queryChannelMembers', query)
+
+  const { page, channelId, membership, ...params } = query ?? {}
+
+  const { data } = await client.http.get<
+    Amity.ChannelMembershipPayload & Amity.Pagination
+  >(`/api/v3/channels/${channelId}/users`, {
+    params: {
+      ...params,
+      filter: membership,
+      options: {
+        token: toToken(page, 'skiplimit'),
+      },
+    },
+  })
+
+  const { paging, ...response } = data
+
+  decoratePayload(response as unknown as Record<string, Object[]>)
+  ingestInCache(response as unknown as Record<string, Object[]>)
+
+  const { channelUsers } = response
+
+  const nextPage = toPage(paging.next)
+  const prevPage = toPage(paging.previous)
+
+  return { data: toRecord(channelUsers), nextPage, prevPage }
+}
+
+/**
+ * ```js
+ * import { queryChannelMembers } from '@amityco/ts-sdk'
+ * const channelMembers = await queryChannelMembers(query)
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.Post} objects from cache
+ *
+ * @param query The query parameters
+ * @returns posts
+ *
+ * @category Post API
+ */
+queryChannelMembers.locally = (
+  query: Parameters<typeof queryChannelMembers>[0]
+) => {
+  const client = getActiveClient()
+  client.log('channel/queryChannelMembers', query)
+
+  // TODO
+}