@satorijs/adapter-discord 4.1.2 → 4.1.4

package/src/message.ts

@@ -0,0 +1,446 @@
+import { Context, Dict, h, Logger, MessageEncoder, Quester, Schema, Universal } from '@satorijs/satori'
+import FormData from 'form-data'
+import { DiscordBot } from './bot'
+import { ActionRow, Button, ButtonStyles, Channel, ComponentType, Message } from './types'
+import { decodeMessage, sanitize } from './utils'
+
+type RenderMode = 'default' | 'figure'
+
+const logger = new Logger('discord')
+
+class State {
+  author: Partial<Universal.User> = {}
+  quote: Partial<Universal.Message> = {}
+  channel: Partial<Channel> = {}
+  fakeMessageMap: Record<string, Universal.Message[]> = {} // [userInput] = discord messages
+  threadCreated = false // forward: send the first message and create a thread
+
+  constructor(public type: 'message' | 'forward') { }
+}
+
+export class DiscordMessageEncoder<C extends Context = Context> extends MessageEncoder<C, DiscordBot<C>> {
+  private stack: State[] = [new State('message')]
+  private buffer: string = ''
+  private addition: Dict = {}
+  private figure: h = null
+  private mode: RenderMode = 'default'
+  private listType: 'ol' | 'ul' = null
+  private rows: ActionRow[] = []
+  private async getUrl() {
+    const input = this.options?.session?.discord
+    if (input?.t === 'INTERACTION_CREATE') {
+      // 消息交互
+      return `/webhooks/${input.d.application_id}/${input.d.token}`
+    } else if (this.stack[0].type === 'forward' && this.stack[0].channel?.id) {
+      // 发送到子区
+      if (this.stack[1].author.name || this.stack[1].author.avatar) {
+        const webhook = await this.ensureWebhook()
+        return `/webhooks/${webhook.id}/${webhook.token}?wait=true&thread_id=${this.stack[0].channel?.id}`
+      } else {
+        return `/channels/${this.stack[0].channel.id}/messages`
+      }
+    } else {
+      if (this.stack[0].author.name || this.stack[0].author.avatar || (this.stack[0].type === 'forward' && !this.stack[0].threadCreated)) {
+        const webhook = await this.ensureWebhook()
+        return `/webhooks/${webhook.id}/${webhook.token}?wait=true`
+      } else {
+        return `/channels/${this.channelId}/messages`
+      }
+    }
+  }
+
+  async post(data?: any, headers?: any) {
+    try {
+      const url = await this.getUrl()
+      const result = await this.bot.http.post<Message>(url, data, { headers })
+      const session = this.bot.session()
+      const message = await decodeMessage(this.bot, result, session.event.message = {}, session.event)
+      session.app.emit(session, 'send', session)
+      this.results.push(session.event.message)
+      Object.defineProperty(session.event.message, 'channel', {
+        configurable: true,
+        get: () => session.event.channel,
+      })
+
+      if (this.stack[0].type === 'forward' && !this.stack[0].threadCreated) {
+        this.stack[0].threadCreated = true
+        const thread = await this.bot.internal.startThreadFromMessage(this.channelId, result.id, {
+          name: 'Forward',
+          auto_archive_duration: 60,
+        })
+        this.stack[0].channel = thread
+      }
+
+      return message
+    } catch (e) {
+      if (Quester.isAxiosError(e) && e.response) {
+        if (e.response.data?.code === 10015) {
+          logger.debug('webhook has been deleted, recreating..., %o', e.response.data)
+          if (!this.bot.webhookLock[this.channelId]) this.bot.webhooks[this.channelId] = null
+          await this.ensureWebhook()
+          return this.post(data, headers)
+        } else {
+          e = new Error(`[${e.response.status}] ${JSON.stringify(e.response.data)}`)
+        }
+      }
+      this.errors.push(e)
+    }
+  }
+
+  async sendEmbed(attrs: Dict, payload: Dict) {
+    const { filename, data, mime } = await this.bot.ctx.http.file(attrs.url, attrs)
+    const form = new FormData()
+    // https://github.com/form-data/form-data/issues/468
+    const value = process.env.KOISHI_ENV === 'browser'
+      ? new Blob([data], { type: mime })
+      : Buffer.from(data)
+    form.append('file', value, attrs.file || filename)
+    form.append('payload_json', JSON.stringify(payload))
+    return this.post(form, form.getHeaders())
+  }
+
+  async sendAsset(type: string, attrs: Dict<string>, addition: Dict) {
+    const { handleMixedContent, handleExternalAsset } = this.bot.config as DiscordMessageEncoder.Config
+
+    if (handleMixedContent === 'separate' && addition.content) {
+      await this.post(addition)
+      addition.content = ''
+    }
+
+    const sendDirect = async () => {
+      if (addition.content) {
+        await this.post(addition)
+      }
+      return this.post({ ...addition, content: attrs.url })
+    }
+
+    if (await this.bot.http.isPrivate(attrs.url)) {
+      return await this.sendEmbed(attrs, addition)
+    }
+
+    const mode = attrs.mode as DiscordMessageEncoder.HandleExternalAsset || handleExternalAsset
+    if (mode === 'download' || handleMixedContent === 'attach' && addition.content || type === 'file') {
+      return this.sendEmbed(attrs, addition)
+    } else if (mode === 'direct') {
+      return sendDirect()
+    }
+
+    // auto mode
+    if (await this.checkMediaType(attrs.url, type)) {
+      return sendDirect()
+    } else {
+      return this.sendEmbed(attrs, addition)
+    }
+  }
+
+  checkMediaType(url: string, type: string) {
+    if (url.startsWith('https://cdn.discordapp.com/')) return true
+    return this.bot.ctx.http.head(url, {
+      headers: { accept: type + '/*' },
+      timeout: 1000,
+    }).then(
+      (headers) => headers['content-type'].startsWith(type),
+      () => false,
+    )
+  }
+
+  async ensureWebhook() {
+    return this.bot.ensureWebhook(this.channelId)
+  }
+
+  async flush() {
+    const content = this.buffer.trim()
+    this.trimButtons()
+    if (!content && !this.rows.length) return
+    this.addition.components = this.rows
+    await this.post({ ...this.addition, content })
+    this.buffer = ''
+    this.addition = {}
+    this.rows = []
+  }
+
+  decodeButton(attrs: Dict, label: string): Button {
+    let style = ButtonStyles.PRIMARY
+    if (attrs.class === 'secondary') style = ButtonStyles.SECONDARY
+    if (attrs.class === 'danger') style = ButtonStyles.DANGER
+    if (attrs.class === 'success') style = ButtonStyles.SUCCESS
+    if (attrs.type === 'link') {
+      return {
+        type: ComponentType.BUTTON,
+        url: attrs.href,
+        label,
+        style: ButtonStyles.LINK,
+      }
+    } else if (attrs.type === 'input') {
+      return {
+        type: ComponentType.BUTTON,
+        custom_id: `input${attrs.id}:${attrs.text}`,
+        label,
+        style,
+      }
+    } else {
+      return {
+        type: ComponentType.BUTTON,
+        custom_id: attrs.id,
+        label,
+        style,
+      }
+    }
+  }
+
+  lastRow() {
+    if (!this.rows.length) {
+      this.rows.push({
+        type: ComponentType.ACTION_ROW,
+        components: [],
+      })
+    }
+    let last = this.rows[this.rows.length - 1]
+    if (last.components.length >= 5) {
+      this.rows.push({
+        type: ComponentType.ACTION_ROW,
+        components: [],
+      })
+      last = this.rows[this.rows.length - 1]
+    }
+    return last
+  }
+
+  trimButtons() {
+    if (this.rows.length && this.rows[this.rows.length - 1].components.length === 0) this.rows.pop()
+  }
+
+  async visit(element: h) {
+    const { type, attrs, children } = element
+    if (type === 'text') {
+      this.buffer += sanitize(attrs.content)
+    } else if (type === 'b' || type === 'strong') {
+      this.buffer += '**'
+      await this.render(children)
+      this.buffer += '**'
+    } else if (type === 'i' || type === 'em') {
+      this.buffer += '*'
+      await this.render(children)
+      this.buffer += '*'
+    } else if (type === 'u' || type === 'ins') {
+      this.buffer += '__'
+      await this.render(children)
+      this.buffer += '__'
+    } else if (type === 's' || type === 'del') {
+      this.buffer += '~~'
+      await this.render(children)
+      this.buffer += '~~'
+    } else if (type === 'spl') {
+      this.buffer += '||'
+      await this.render(children)
+      this.buffer += '||'
+    } else if (type === 'code') {
+      this.buffer += '`'
+      await this.render(children)
+      this.buffer += '`'
+    } else if (type === 'a') {
+      await this.render(children)
+      if (this.options.linkPreview) {
+        this.buffer += ` (${attrs.href}) `
+      } else {
+        this.buffer += ` (<${attrs.href}>) `
+      }
+    } else if (type === 'br') {
+      this.buffer += '\n'
+    } else if (type === 'p') {
+      if (!this.buffer.endsWith('\n')) this.buffer += '\n'
+      await this.render(children)
+      if (!this.buffer.endsWith('\n')) this.buffer += '\n'
+    } else if (type === 'blockquote') {
+      if (!this.buffer.endsWith('\n')) this.buffer += '\n'
+      this.buffer += '> '
+      await this.render(children)
+      this.buffer += '\n'
+    } else if (type === 'ul' || type === 'ol') {
+      this.listType = type
+      await this.render(children)
+      this.listType = null
+    } else if (type === 'li') {
+      if (!this.buffer.endsWith('\n')) this.buffer += '\n'
+      if (this.listType === 'ol') {
+        this.buffer += '0. '
+      } else if (this.listType === 'ul') {
+        this.buffer += '- '
+      }
+      this.render(children)
+      this.buffer += '\n'
+    } else if (type === 'at') {
+      if (attrs.id) {
+        this.buffer += `<@${attrs.id}>`
+      } else if (attrs.type === 'all') {
+        this.buffer += `@everyone`
+      } else if (attrs.type === 'here') {
+        this.buffer += `@here`
+      }
+    } else if (type === 'sharp' && attrs.id) {
+      this.buffer += `<#${attrs.id}>`
+    } else if (type === 'face') {
+      if (attrs.platform && attrs.platform !== this.bot.platform) {
+        return this.render(children)
+      } else {
+        this.buffer += `<${attrs.animated ? 'a' : ''}:${attrs.name}:${attrs.id}>`
+      }
+    } else if ((type === 'image' || type === 'video') && attrs.url) {
+      if (this.mode === 'figure') {
+        this.figure = element
+      } else {
+        await this.sendAsset(type, attrs, {
+          ...this.addition,
+          content: this.buffer.trim(),
+        })
+        this.buffer = ''
+      }
+    } else if (type === 'share') {
+      await this.flush()
+      await this.post({
+        ...this.addition,
+        embeds: [{ ...attrs }],
+      })
+    } else if (type === 'audio') {
+      await this.sendAsset('file', attrs, {
+        ...this.addition,
+        content: this.buffer.trim(),
+      })
+      this.buffer = ''
+    } else if (type === 'author') {
+      const { avatar, nickname } = attrs
+      if (avatar) this.addition.avatar_url = avatar
+      if (nickname) this.addition.username = nickname
+      if (this.stack[0].type === 'message') {
+        this.stack[0].author = attrs
+      }
+      if (this.stack[0].type === 'forward') {
+        this.stack[1].author = attrs
+      }
+    } else if (type === 'quote') {
+      await this.flush()
+      const parse = (val: string) => val.replace(/\\([\\*_`~|()\[\]])/g, '$1')
+
+      const message = this.stack[this.stack[0].type === 'forward' ? 1 : 0]
+      if (!message.author.avatar && !message.author.name && this.stack[0].type !== 'forward') {
+        // no quote and author, send by bot
+        await this.flush()
+        this.addition.message_reference = {
+          message_id: attrs.id,
+        }
+      } else {
+        // quote
+        let replyId = attrs.id, channelId = this.channelId
+        if (this.stack[0].type === 'forward' && this.stack[0].fakeMessageMap[attrs.id]?.length >= 1) {
+          // quote to fake message, eg. 1st message has id (in channel or thread), later message quote to it
+          replyId = this.stack[0].fakeMessageMap[attrs.id][0].id
+          channelId = this.stack[0].fakeMessageMap[attrs.id][0].channel.id
+        }
+        const quote = await this.bot.getMessage(channelId, replyId)
+        this.addition.embeds = [{
+          description: [
+            sanitize(parse(quote.elements.filter(v => v.type === 'text').join('')).slice(0, 30)),
+            `<t:${Math.ceil(quote.timestamp / 1000)}:R> [[ ↑ ]](https://discord.com/channels/${this.guildId}/${channelId}/${replyId})`,
+          ].join('\n\n'),
+          author: {
+            name: quote.user.name,
+            icon_url: quote.user.avatar,
+          },
+        }]
+      }
+    } else if (type === 'figure') {
+      await this.flush()
+      this.mode = 'figure'
+      await this.render(children)
+      await this.sendAsset(this.figure.type, this.figure.attrs, {
+        ...this.addition,
+        content: this.buffer.trim(),
+      })
+      this.buffer = ''
+      this.mode = 'default'
+    } else if (type === 'message' && !attrs.forward) {
+      if (this.mode === 'figure') {
+        await this.render(children)
+        this.buffer += '\n'
+      } else {
+        const resultLength = +this.results.length
+        await this.flush()
+
+        await this.render(children)
+        await this.flush()
+        const newLength = +this.results.length
+        const sentMessages = this.results.slice(resultLength, newLength)
+        if (this.stack[0].type === 'forward' && attrs.id) {
+          this.stack[0].fakeMessageMap[attrs.id] = sentMessages
+        }
+        if (this.stack[0].type === 'message') {
+          this.stack[0].author = {}
+        }
+        if (this.stack[0].type === 'forward') {
+          this.stack[1].author = {}
+        }
+      }
+    } else if (type === 'button') {
+      const last = this.lastRow()
+      last.components.push(this.decodeButton(
+        attrs, children.join(''),
+      ))
+    } else if (type === 'button-group') {
+      this.rows.push({
+        type: ComponentType.ACTION_ROW,
+        components: [],
+      })
+      await this.render(children)
+      this.rows.push({
+        type: ComponentType.ACTION_ROW,
+        components: [],
+      })
+    } else if (type === 'message' && attrs.forward) {
+      this.stack.unshift(new State('forward'))
+      await this.render(children)
+      await this.flush()
+      await this.bot.internal.modifyChannel(this.stack[0].channel.id, {
+        archived: true,
+        locked: true,
+      })
+      this.stack.shift()
+    } else {
+      await this.render(children)
+    }
+  }
+}
+
+export namespace DiscordMessageEncoder {
+  export type HandleExternalAsset = 'auto' | 'download' | 'direct'
+  export type HandleMixedContent = 'auto' | 'separate' | 'attach'
+
+  export interface Config {
+    /**
+     * 发送外链资源时采用的方式
+     * - download：先下载后发送
+     * - direct：直接发送链接
+     * - auto：发送一个 HEAD 请求，如果返回的 Content-Type 正确，则直接发送链接，否则先下载后发送（默认）
+     */
+    handleExternalAsset?: HandleExternalAsset
+    /**
+     * 发送图文等混合内容时采用的方式
+     * - separate：将每个不同形式的内容分开发送
+     * - attach：图片前如果有文本内容，则将文本作为图片的附带信息进行发送
+     * - auto：如果图片本身采用直接发送则与前面的文本分开，否则将文本作为图片的附带信息发送（默认）
+     */
+    handleMixedContent?: HandleMixedContent
+  }
+
+  export const Config: Schema<DiscordMessageEncoder.Config> = Schema.object({
+    handleExternalAsset: Schema.union([
+      Schema.const('download').description('先下载后发送'),
+      Schema.const('direct').description('直接发送链接'),
+      Schema.const('auto').description('发送一个 HEAD 请求，根据返回的 Content-Type 决定发送方式'),
+    ]).role('radio').description('发送外链资源时采用的方式。').default('auto'),
+    handleMixedContent: Schema.union([
+      Schema.const('separate').description('将每个不同形式的内容分开发送'),
+      Schema.const('attach').description('图片前如果有文本内容，则将文本作为图片的附带信息进行发送'),
+      Schema.const('auto').description('如果图片本身采用直接发送则与前面的文本分开，否则将文本作为图片的附带信息发送'),
+    ]).role('radio').description('发送图文等混合内容时采用的方式。').default('auto'),
+  }).description('发送设置')
+}

package/src/types/.eslintrc.yml

@@ -0,0 +1,2 @@
+rules:
+  max-len: off

package/src/types/application-role-connection.ts

@@ -0,0 +1,61 @@
+import { Internal, Locale } from '.'
+
+export namespace ApplicationRoleConnection {
+  /** https://discord.com/developers/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object-application-role-connection-metadata-structure */
+  export interface Metadata {
+    /** type of metadata value */
+    type: MetadataType
+    /** dictionary key for the metadata field (must be a-z, 0-9, or _ characters; 1-50 characters) */
+    key: string
+    /** name of the metadata field (1-100 characters) */
+    name: string
+    /** translations of the name */
+    name_localizations?: Record<Locale, string>
+    /** description of the metadata field (1-200 characters) */
+    description: string
+    /** translations of the description */
+    description_localizations?: Record<Locale, string>
+  }
+
+  /** https://discord.com/developers/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object-application-role-connection-metadata-type */
+  export enum MetadataType {
+    /** the metadata value (integer) is less than or equal to the guild's configured value (integer) */
+    INTEGER_LESS_THAN_OR_EQUAL = 1,
+    /** the metadata value (integer) is greater than or equal to the guild's configured value (integer) */
+    INTEGER_GREATER_THAN_OR_EQUAL = 2,
+    /** the metadata value (integer) is equal to the guild's configured value (integer) */
+    INTEGER_EQUAL = 3,
+    /** the metadata value (integer) is not equal to the guild's configured value (integer) */
+    INTEGER_NOT_EQUAL = 4,
+    /** the metadata value (ISO8601 string) is less than or equal to the guild's configured value (integer; days before current date) */
+    DATETIME_LESS_THAN_OR_EQUAL = 5,
+    /** the metadata value (ISO8601 string) is greater than or equal to the guild's configured value (integer; days before current date) */
+    DATETIME_GREATER_THAN_OR_EQUAL = 6,
+    /** the metadata value (integer) is equal to the guild's configured value (integer; 1) */
+    BOOLEAN_EQUAL = 7,
+    /** the metadata value (integer) is not equal to the guild's configured value (integer; 1) */
+    BOOLEAN_NOT_EQUAL = 8,
+  }
+}
+
+declare module './internal' {
+  interface Internal {
+    /**
+     * Returns a list of application role connection metadata objects for the given application.
+     * @see https://discord.com/developers/docs/resources/application-role-connection-metadata#get-application-role-connection-metadata-records
+     */
+    getApplicationRoleConnectionMetadataRecords(): Promise<ApplicationRoleConnection.Metadata[]>
+    /**
+     * Updates and returns a list of application role connection metadata objects for the given application.
+     * @see https://discord.com/developers/docs/resources/application-role-connection-metadata#update-application-role-connection-metadata-records
+     */
+    updateApplicationRoleConnectionMetadataRecords(): Promise<ApplicationRoleConnection.Metadata[]>
+  }
+}
+
+Internal.define({
+  '/applications/{application.id}/role-connections/metadata': {
+    GET: 'getApplicationRoleConnectionMetadataRecords',
+    PUT: 'updateApplicationRoleConnectionMetadataRecords',
+  },
+})

package/src/types/application.ts

@@ -0,0 +1,120 @@
+import { Guild, integer, Internal, snowflake, Team, User } from '.'
+
+/** https://discord.com/developers/docs/resources/application#application-object-application-structure */
+export interface Application {
+  /** the id of the app */
+  id: snowflake
+  /** the name of the app */
+  name: string
+  /** the icon hash of the app */
+  icon?: string
+  /** the description of the app */
+  description: string
+  /** an array of rpc origin urls, if rpc is enabled */
+  rpc_origins?: string[]
+  /** when false only app owner can join the app's bot to guilds */
+  bot_public: boolean
+  /** when true the app's bot will only join upon completion of the full oauth2 code grant flow */
+  bot_require_code_grant: boolean
+  /** the url of the app's terms of service */
+  terms_of_service_url?: string
+  /** the url of the app's privacy policy */
+  privacy_policy_url?: string
+  /** partial user object containing info on the owner of the application */
+  owner?: Partial<User>
+  /** deprecated, if this application is a game sold on Discord, this field will be the summary field for the store page of its primary sku */
+  summary: string
+  /** the hex encoded key for verification in interactions and the GameSDK's GetTicket */
+  verify_key: string
+  /** if the application belongs to a team, this will be a list of the members of that team */
+  team?: Team
+  /** if this application is a game sold on Discord, this field will be the guild to which it has been linked */
+  guild_id?: snowflake
+  /** if this application is a game sold on Discord, this field will be the id of the "Game SKU" that is created, if exists */
+  primary_sku_id?: snowflake
+  /** if this application is a game sold on Discord, this field will be the URL slug that links to the store page */
+  slug?: string
+  /** the application's default rich presence invite cover image hash */
+  cover_image?: string
+  /** the application's public flags */
+  flags?: integer
+  /** up to 5 tags describing the content and functionality of the application */
+  tags?: [string, string?, string?, string?, string?]
+  /** settings for the application's default in-app authorization link, if enabled */
+  install_params?: InstallParams
+  /** the application's default custom authorization link, if enabled */
+  custom_install_url?: string
+  /** the application's role connection verification entry point, which when configured will render the app as a verification method in the guild role verification configuration */
+  role_connections_verification_url?: string
+}
+
+export interface InstallParams {
+  /** the scopes to add the application to the server with */
+  scopes: string[]
+  /** the permissions to request for the bot role */
+  permissions: string
+}
+
+/** https://discord.com/developers/docs/resources/application#application-object-application-flags */
+export enum ApplicationFlag {
+  GATEWAY_PRESENCE = 1 << 12,
+  GATEWAY_PRESENCE_LIMITED = 1 << 13,
+  GATEWAY_GUILD_MEMBERS = 1 << 14,
+  GATEWAY_GUILD_MEMBERS_LIMITED = 1 << 15,
+  VERIFICATION_PENDING_GUILD_LIMIT = 1 << 16,
+  EMBEDDED = 1 << 17,
+  GATEWAY_MESSAGE_CONTENT = 1 << 18,
+  GATEWAY_MESSAGE_CONTENT_LIMITED = 1 << 19,
+  APPLICATION_COMMAND_BADGE = 1 << 23,
+}
+
+/** https://discord.com/developers/docs/topics/gateway-events#ready-ready-event-fields */
+export interface ReadyEvent {
+  /** gateway version */
+  v: integer
+  /** information about the user including email */
+  user: User
+  /** the guilds the user is in */
+  guilds: Partial<Guild>[]
+  /** used for resuming connections */
+  session_id: string
+  /** gateway URL for resuming connections */
+  resume_gateway_url: string
+  /** the shard information associated with this session, if sent when identifying */
+  shard?: [shard_id: integer, num_shards: integer]
+  /** contains id and flags */
+  application: Partial<Application>
+}
+
+declare module './gateway' {
+  interface GatewayEvents {
+    /** contains the initial state information */
+    READY: ReadyEvent
+    /** response to Resume */
+    RESUMED: {}
+  }
+}
+
+declare module './internal' {
+  interface Internal {
+    /**
+     * Returns the bot's application object.
+     * @see https://discord.com/developers/docs/topics/oauth2#get-current-bot-application-information
+     */
+    getCurrentBotApplicationInformation(): Promise<Application>
+    /**
+     * Returns info about the current authorization. Requires authentication with a bearer token.
+     * @see https://discord.com/developers/docs/topics/oauth2#get-current-authorization-information
+     */
+    getCurrentAuthorizationInformation(): Promise<any>
+  }
+}
+
+Internal.define({
+  '/oauth2/applications/@me': {
+    GET: 'getCurrentBotApplicationInformation',
+  },
+  '/oauth2/@me': {
+    GET: 'getCurrentAuthorizationInformation',
+  },
+})