73 lines
2.1 KiB
JavaScript
73 lines
2.1 KiB
JavaScript
const express = require("express");
|
|
const { CommandManager } = require("knub-command-manager");
|
|
const { Client } = require("eris");
|
|
const Knex = require("knex");
|
|
const threads = require("./data/threads");
|
|
const displayRoles = require("./data/displayRoles");
|
|
|
|
/**
|
|
* @typedef {object} PluginAPI
|
|
* @property {Client} bot
|
|
* @property {Knex} knex
|
|
* @property {ModmailConfig} config
|
|
* @property {PluginCommandsAPI} commands
|
|
* @property {PluginAttachmentsAPI} attachments
|
|
* @property {PluginLogsAPI} logs
|
|
* @property {PluginHooksAPI} hooks
|
|
* @property {PluginFormattersAPI} formats
|
|
* @property {PluginWebServerAPI} webserver
|
|
* @property {PluginThreadsAPI} threads
|
|
* @property {PluginDisplayRolesAPI} displayRoles
|
|
*/
|
|
|
|
/**
|
|
* @typedef {object} PluginCommandsAPI
|
|
* @property {CommandManager} manager
|
|
* @property {AddGlobalCommandFn} addGlobalCommand
|
|
* @property {AddInboxServerCommandFn} addInboxServerCommand
|
|
* @property {AddInboxThreadCommandFn} addInboxThreadCommand
|
|
* @property {AddAliasFn} addAlias
|
|
*/
|
|
|
|
/**
|
|
* @typedef {object} PluginAttachmentsAPI
|
|
* @property {AddAttachmentStorageTypeFn} addStorageType
|
|
* @property {DownloadAttachmentFn} downloadAttachment
|
|
* @property {SaveAttachmentFn} saveAttachment
|
|
*/
|
|
|
|
/**
|
|
* @typedef {object} PluginLogsAPI
|
|
* @property {AddLogStorageTypeFn} addStorageType
|
|
* @property {SaveLogToStorageFn} saveLogToStorage
|
|
* @property {GetLogUrlFn} getLogUrl
|
|
* @property {GetLogFileFn} getLogFile
|
|
* @property {GetLogCustomResponseFn} getLogCustomResponse
|
|
*/
|
|
|
|
/**
|
|
* @typedef {object} PluginHooksAPI
|
|
* @property {AddBeforeNewThreadHookFn} beforeNewThread
|
|
* @property {AddAfterThreadCloseHookFn} afterThreadClose
|
|
*/
|
|
|
|
/**
|
|
* @typedef {displayRoles} PluginDisplayRolesAPI
|
|
* @see https://github.com/Dragory/modmailbot/blob/master/src/data/displayRoles.js
|
|
*/
|
|
|
|
/**
|
|
* @typedef {threads} PluginThreadsAPI
|
|
* @see https://github.com/Dragory/modmailbot/blob/master/src/data/threads.js
|
|
*/
|
|
|
|
/**
|
|
* @typedef {express.Application} PluginWebServerAPI
|
|
* @see https://expressjs.com/en/api.html#app
|
|
*/
|
|
|
|
/**
|
|
* @typedef {FormattersExport} PluginFormattersAPI
|
|
* @see https://github.com/Dragory/modmailbot/blob/master/src/formatters.js
|
|
*/
|