artalk 2.7.1 → 2.7.3

package/types/config.ts

@@ -1,153 +0,0 @@
-import { I18n } from '~/src/i18n'
-import { CommentData } from './data'
-
-export interface ArtalkConfig {
-  /** 装载元素 */
-  el: string|HTMLElement
-
-  /** 页面唯一标识（完整 URL） */
-  pageKey: string
-
-  /** 页面标题 */
-  pageTitle: string
-
-  /** 服务器地址 */
-  server: string
-
-  /** 站点名 */
-  site: string
-
-  /** 评论框占位字符 */
-  placeholder: string
-
-  /** 评论为空时显示字符 */
-  noComment: string
-
-  /** 发送按钮文字 */
-  sendBtn: string
-
-  /** 评论框穿梭（显示在待回复评论后面） */
-  editorTravel: boolean
-
-  /** 表情包 */
-  emoticons: object|any[]|string|false
-
-  /** Gravatar 头像 */
-  gravatar: {
-    /** API 地址 */
-    mirror: string
-    /** API 参数 */
-    params: string
-  }
-
-  /** 头像链接生成器 */
-  avatarURLBuilder?: (comment: CommentData) => string,
-
-  /** 分页配置 */
-  pagination: {
-    /** 每次请求获取数量 */
-    pageSize: number
-    /** 阅读更多模式 */
-    readMore: boolean
-    /** 滚动到底部自动加载 */
-    autoLoad: boolean
-  }
-
-  /** 内容限高 */
-  heightLimit: {
-    /** 评论内容限高 */
-    content: number
-
-    /** 子评论区域限高 */
-    children: number
-
-    /** 滚动限高 */
-    scrollable: boolean
-  }
-
-  /** 评论投票按钮 */
-  vote: boolean
-
-  /** 评论投票反对按钮 */
-  voteDown: boolean
-
-  /** 评论预览功能 */
-  preview: boolean
-
-  /** 评论数绑定元素 Selector */
-  countEl: string
-
-  /** PV 数绑定元素 Selector */
-  pvEl: string
-
-  /** 夜间模式 */
-  darkMode: boolean|'auto'
-
-  /** 请求超时（单位：秒） */
-  reqTimeout: number
-
-  /** 平铺模式 */
-  flatMode: boolean|'auto'
-
-  /** 嵌套模式 · 最大层数 */
-  nestMax: number
-
-  /** 嵌套模式 · 排序方式 */
-  nestSort: 'DATE_ASC'|'DATE_DESC'
-
-  /** 显示 UA 徽标 */
-  uaBadge: boolean
-
-  /** 评论列表排序功能 (显示 Dropdown) */
-  listSort: boolean
-
-  /** 图片上传功能 */
-  imgUpload: boolean
-
-  /** 图片上传器 */
-  imgUploader?: (file: File) => Promise<string>
-
-  /** 版本检测 */
-  versionCheck: boolean
-
-  /** 引用后端配置 */
-  useBackendConf: boolean
-
-  /** 语言本地化 */
-  locale: I18n|string
-
-  /** 后端版本 (系统数据，用户不允许更改) */
-  apiVersion?: string
-
-  /** Replacer for marked */
-  markedReplacers?: ((raw: string) => string)[]
-
-  /** 列表请求参数修改器 */
-  listFetchParamsModifier?: (params: any) => void
-
-  // TODO consider merge list related config into one object, or flatten all to keep simple (keep consistency)
-  remoteConfModifier?: (conf: Partial<ArtalkConfig>) => void
-  listUnreadHighlight?: boolean
-  scrollRelativeTo?: () => HTMLElement
-}
-
-/**
- * 本地持久化用户数据
- * @note 始终保持一层结构，不支持多层结构
- */
-export interface LocalUser {
-  /** 昵称 */
-  nick: string
-
-  /** 邮箱 */
-  email: string
-
-  /** 链接 */
-  link: string
-
-  /** TOKEN */
-  token: string
-
-  /** 是否为管理员 */
-  isAdmin: boolean
-}

package/types/context.ts

@@ -1,84 +0,0 @@
-import type { TInjectedServices } from '@/service'
-import type { CheckerCaptchaPayload, CheckerPayload } from '@/components/checker'
-import type { EventManagerFuncs } from '@/lib/event-manager'
-import type { TMarked } from '@/lib/marked'
-import type { I18n } from '@/i18n'
-import type Api from '@/api'
-import type { SidebarShowPayload, EventPayloadMap, ArtalkConfig, CommentData, DataManagerApi, ListFetchParams, NotifyLevel } from '.'
-
-/**
- * Context 接口
- *
- * (面向接口的编程)
- */
-export interface ContextApi extends EventManagerFuncs<EventPayloadMap> {
-  /** Artalk 根元素对象 */
-  $root: HTMLElement
-
-  /** 依赖注入函数 */
-  inject<K extends keyof TInjectedServices>(depName: K, obj: TInjectedServices[K]): void
-
-  /** 获取依赖对象 */
-  get<K extends keyof TInjectedServices>(depName: K): TInjectedServices[K]
-
-  /** 配置对象 */
-  // TODO 修改为 getConf() 和 setConf() 并且返回拷贝而不是引用
-  conf: ArtalkConfig
-
-  /** marked 依赖对象 */
-  getMarked(): TMarked | undefined
-
-  /** 获取 API 以供 HTTP 请求 */
-  getApi(): Api
-
-  /** 获取数据管理器对象 */
-  getData(): DataManagerApi
-
-  /** 评论回复 */
-  replyComment(commentData: CommentData, $comment: HTMLElement): void
-
-  /** 编辑评论 */
-  editComment(commentData: CommentData, $comment: HTMLElement): void
-
-  /** 获取评论数据 */
-  fetch(params: Partial<ListFetchParams>): void
-
-  /** 重载评论数据 */
-  reload(): void
-
-  /** 列表滚动到第一个评论的位置 */
-  listGotoFirst(): void
-
-  /** 显示侧边栏 */
-  showSidebar(payload?: SidebarShowPayload): void
-
-  /** 隐藏侧边栏 */
-  hideSidebar(): void
-
-  /** 编辑器 - 显示加载 */
-  editorShowLoading(): void
-
-  /** 编辑器 - 隐藏加载 */
-  editorHideLoading(): void
-
-  /** 编辑器 - 显示提示消息 */
-  editorShowNotify(msg: string, type: NotifyLevel): void
-
-  /** 评论框 - 复原状态 */
-  editorResetState(): void
-
-  /** 验证码检测 */
-  checkCaptcha(payload: CheckerCaptchaPayload): void
-
-  /** 管理员检测 */
-  checkAdmin(payload: CheckerPayload): void
-
-  /** i18n 翻译 */
-  $t(key: keyof I18n, args?: {[key: string]: string}): string
-
-  /** 设置夜间模式 */
-  setDarkMode(darkMode: boolean|'auto'): void
-
-  /** 更新配置 */
-  updateConf(conf: Partial<ArtalkConfig>): void
-}

package/types/data.ts

@@ -1,271 +0,0 @@
-export interface CommentData {
-  /** 评论 ID */
-  id: number
-
-  /** 评论正文 */
-  content: string
-
-  /** 用户昵称 */
-  nick: string
-
-  /** 用户邮箱 (该字段仅管理员可见) */
-  email?: string
-
-  /** 用户邮箱（已加密） */
-  email_encrypted: string
-
-  /** 用户链接 */
-  link: string
-
-  /** 回复目标评论 ID */
-  rid: number
-
-  /** User Agent */
-  ua: string
-
-  /** 评论日期 */
-  date: string
-
-  /** 是否折叠 */
-  is_collapsed?: boolean
-
-  /** 是否待审 */
-  is_pending?: boolean
-
-  /** 是否置顶 */
-  is_pinned?: boolean
-
-  /** 是否为管理员 */
-  is_admin?: boolean
-
-  /** 徽章文字 */
-  badge_name?: string
-
-  /** 徽章颜色 */
-  badge_color?: string
-
-  /** IP 归属地 */
-  ip_region?: string
-
-  /** 是否允许回复 */
-  is_allow_reply?: boolean
-
-  /** 评论页面 key */
-  page_key: string
-
-  /** 评论页面 url */
-  page_url?: string
-
-  /** 是否可见 */
-  visible: boolean
-
-  /** 站点名（用于隔离） */
-  site_name: string
-
-  /** 赞同数 */
-  vote_up: number
-
-  /** 反对数 */
-  vote_down: number
-}
-
-export interface ListData {
-  /** 评论数据 */
-  comments: CommentData[]
-
-  /** 根评论总数 */
-  total_roots: number
-
-  /** 评论总数（包括所有子评论） */
-  total: number
-
-  /** 页面信息 */
-  page: PageData
-
-  /** 站点信息 */
-  site: SiteData
-
-  /** 未读的 Notifies */
-  unread: NotifyData[]
-
-  /** 未读计数 */
-  unread_count: number
-
-  /** API 版本 */
-  api_version: ApiVersionData
-
-  /** 后端配置 */
-  conf: any // TODO
-}
-
-export interface PageData {
-  /** 页面 ID */
-  id: number
-
-  /** 页面唯一标识符 */
-  key: string
-
-  /** 页面标题 */
-  title: string
-
-  /** 页面 url */
-  url: string
-
-  /** 仅管理员可评 */
-  admin_only: boolean
-
-  /** 站点名（用于隔离） */
-  site_name: string
-
-  /** 赞同数 */
-  vote_up: number
-
-  /** 反对数 */
-  vote_down: number
-}
-
-export interface SiteData {
-  /** 站点 ID */
-  id: number
-
-  /** 站点名 */
-  name: string
-
-  /** 站点 URLs */
-  urls: string[]
-
-  /** 站点 URLs（原始字符串） */
-  urls_raw: string
-
-  /** 站点主 URL */
-  first_url: string
-}
-
-export interface UserData {
-  /** 用户 ID */
-  id: number
-
-  /** 用户名 */
-  name: string
-
-  /** 邮箱 */
-  email: string
-
-  /** 链接 */
-  link: string
-
-  /** 徽章名称 */
-  badge_name: string
-
-  /** 徽章颜色 */
-  badge_color: string
-
-  /** 是否属于管理员 */
-  is_admin: boolean
-
-  /** 所属站点名 */
-  site_names: string[]
-
-  /** 所属站点名 (字符串) */
-  site_names_raw: string,
-
-  /** 是否允许接收邮件通知 */
-  receive_email: boolean
-}
-
-export interface UserDataForAdmin extends UserData {
-  /** 最后一次操作 IP */
-  last_ip: string
-
-  /** 最后一次操作 UA */
-  last_ua: string
-
-  /** 是否存在于配置文件中 */
-  is_in_conf: boolean
-
-  /** 评论数 */
-  comment_count: number
-
-  /** 密码 */
-  password: string
-}
-
-export interface NotifyData {
-  /** 通知 ID */
-  id: number
-
-  /** 用户 ID */
-  user_id: number
-
-  /** 评论 ID */
-  comment_id: number
-
-  /** 是否已读 */
-  is_read: boolean
-
-  /** 是否已发送邮件通知 */
-  is_emailed: boolean
-
-  /** 标为已读地址 */
-  read_link: string
-}
-
-export type EmoticonGrpData = {
-  name: string,
-  type: 'emoticon'|'image'|'emoji'
-  items: {key: string, val: string}[]
-}
-
-export type EmoticonListData = EmoticonGrpData[]
-
-export interface ApiVersionData {
-  /** API 程序名 */
-  app: string
-
-  /** API 程序版本号 */
-  version: string
-
-  /** API 程序 CommitHash */
-  commit_hash: string
-}
-
-export interface ListFetchParams {
-  offset: number
-  limit: number
-  flatMode: boolean
-  paramsModifier?: (p: any) => void
-  onSuccess?: (data: ListData) => void
-  onError?: (err: any) => void
-}
-
-export interface ListLastFetchData {
-  params: ListFetchParams
-  data?: ListData
-}
-
-export interface DataManagerApi {
-  getLoading(): boolean
-  setLoading(val: boolean): void
-
-  getListLastFetch(): ListLastFetchData|undefined
-  setListLastFetch(val: ListLastFetchData): void
-
-  getComments(): CommentData[]
-  findComment(id: number): CommentData|undefined
-
-  fetchComments(params: Partial<ListFetchParams>): void
-  loadComments(comments: CommentData[]): void
-  clearComments(): void
-
-  insertComment(comment: CommentData): void
-  updateComment(comment: CommentData): void
-  deleteComment(id: number): void
-
-  getUnreads(): NotifyData[]
-  updateUnreads(unreads: NotifyData[]): void
-
-  getPage(): PageData|undefined
-  updatePage(pageData: PageData): void
-}
-
-export type NotifyLevel = "i" | "s" | "w" | "e"

package/types/editor.ts

@@ -1,95 +0,0 @@
-import type { CommentData, NotifyLevel } from '.'
-import type Component from '../src/lib/component'
-import type { EditorUI } from '../src/editor/ui'
-
-export type EditorState = 'reply' | 'edit' | 'normal'
-
-export interface EditorApi extends Component {
-  getUI(): EditorUI
-
-  /**
-   * Get the header input elements
-   */
-  getHeaderInputEls(): Record<string, HTMLInputElement>
-
-  /**
-   * Set content
-   */
-  setContent(val: string): void
-
-  /**
-   * Insert content
-   */
-  insertContent(val: string): void
-
-  /**
-   * Get the final content
-   *
-   * This function returns the raw content or the content transformed through a plugin hook.
-   */
-  getContentFinal(): string
-
-  /**
-   * Get the raw content which is inputed by user
-   */
-  getContentRaw(): string
-
-  /**
-   * Get the HTML format content which is rendered by marked (a markdown parser)
-   */
-  getContentMarked(): string
-
-  /**
-   * Get editor current state
-   */
-  getState(): EditorState
-
-  /**
-   * Focus editor
-   */
-  focus(): void
-
-  /**
-   * Reset editor
-   */
-  reset(): void
-
-  /**
-   * Reset editor UI
-   *
-   * call it will move editor to the initial position
-   */
-  resetState(): void
-
-  /**
-   * Submit comment
-   */
-  submit(): void
-
-  /**
-   * Show notification message
-   */
-  showNotify(msg: string, type: NotifyLevel): void
-
-  /**
-   * Show loading on editor
-   */
-  showLoading(): void
-
-  /**
-   * Hide loading on editor
-   */
-  hideLoading(): void
-
-  /**
-   * Start replaying a comment
-   */
-  setReply(commentData: CommentData, $comment: HTMLElement, scroll?: boolean): void
-
-  /**
-   * Start editing a comment
-   */
-  setEditComment(commentData: CommentData, $comment: HTMLElement): void
-}
-
-export default EditorApi

package/types/event.ts

@@ -1,40 +0,0 @@
-import type Comment from '~/src/comment'
-import { CommentData, ListData, ListFetchParams, NotifyData, PageData } from './data'
-import { ArtalkConfig, LocalUser } from './config'
-
-interface ErrorData { msg: string, data?: any }
-interface ListFetchedArgs { params: Partial<ListFetchParams>, data?: ListData, error?: ErrorData }
-
-/** EventName to EventPayload Type */
-export interface EventPayloadMap {
-  'inited': undefined              // Artalk 初始化后
-  'destroy': undefined             // Artalk 销毁时
-  'list-fetch': Partial<ListFetchParams>    // 评论列表请求时
-  'list-fetched': ListFetchedArgs           // 评论列表请求后
-  'list-load': CommentData[]     // 评论装载前
-
-  // TODO merge 'list-loaded' and 'list-error', for purpose of `once` 'list-loaded' and simplify
-  // example need bind 'list-loaded' and 'list-error' to same handler
-  // consider name it to 'list-fetched': { data: CommentData[], error?: { msg: string, data?: any } }
-  // and remove `list-load`
-  'list-loaded': CommentData[]     // 评论装载后
-  'list-error': ErrorData          // 评论加载错误时
-
-  'list-goto-first': undefined    // 评论列表归位时
-  'list-reach-bottom': undefined  // 评论列表滚动到底部时
-
-  'comment-inserted': CommentData  // 评论插入后
-  'comment-updated': CommentData   // 评论更新后
-  'comment-deleted': CommentData   // 评论删除后
-  'comment-rendered': Comment      // 评论节点渲染后
-  'unreads-updated': NotifyData[]  // 未读消息变更时
-  'list-goto': number              // 评论跳转时
-  'page-loaded': PageData          // 页面数据更新后
-  'editor-submit': undefined       // 编辑器提交时
-  'editor-submitted': undefined    // 编辑器提交后
-  'user-changed': LocalUser        // 本地用户数据变更时
-  'conf-loaded': ArtalkConfig      // Artalk 配置变更时
-  'dark-mode-changed': boolean     // 深色模式变更时
-  'sidebar-show': undefined        // 侧边栏显示
-  'sidebar-hide': undefined        // 侧边栏隐藏
-}

package/types/global.d.ts

@@ -1 +0,0 @@
-declare const ARTALK_LITE: boolean

package/types/index.ts

@@ -1,7 +0,0 @@
-export * from './config'
-export * from './data'
-export * from './context'
-export * from './editor'
-export * from './event'
-export * from './plugin'
-export * from './sidebar'

package/types/plugin.ts

@@ -1,3 +0,0 @@
-import { ContextApi } from './context'
-
-export type ArtalkPlugin = (ctx: ContextApi) => void

package/types/sidebar.ts

@@ -1,3 +0,0 @@
-export interface SidebarShowPayload {
-  view?: 'comments'|'sites'|'pages'|'transfer'
-}