artalk 2.3.4 → 2.4.1

package/dist/types/event.d.ts

@@ -0,0 +1,28 @@
+import { CommentData } from './artalk-data'
+import { LocalUser } from './artalk-config'
+
+/** EventName to EventPayload Type */
+export interface EventPayloadMap {
+  'list-load': undefined           // 评论加载时
+  'list-loaded': undefined         // 评论装载后
+  'list-inserted': CommentData     // 评论插入后
+  'editor-submit': undefined       // 编辑器提交时
+  'editor-submitted': undefined    // 编辑器提交后
+  'user-changed': LocalUser        // 本地用户数据变更时
+  'conf-updated': undefined        // Artalk 配置变更时
+  'sidebar-show': undefined        // 侧边栏显示
+  'sidebar-hide': undefined        // 侧边栏隐藏
+}
+
+// ============================================
+export interface Handler<P> {
+  (payload: P): void
+}
+
+export type EventScopeType = 'internal'|'external'
+
+export interface Event<K extends keyof EventPayloadMap = keyof EventPayloadMap> {
+  name: keyof EventPayloadMap
+  handler: Handler<EventPayloadMap[K]>
+  scope: EventScopeType
+}

package/dist/types/plug.d.ts

@@ -0,0 +1,4 @@
+import ContextApi from './context'
+
+type ArtalkPlug = (ctx: ContextApi) => void
+export default ArtalkPlug

package/index.html

@@ -31,8 +31,8 @@
     .to-top { right: 25px; }
   </style>
   <!--<link rel="stylesheet"
-      href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/11.5.1/styles/arta.min.css">
-  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/11.5.1/highlight.min.js"></script>-->
+      href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/11.6.0/styles/arta.min.css">
+  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/11.6.0/highlight.min.js"></script>-->
 
   <!-- For mobile testing -->
   <script src="https://unpkg.com/vconsole@latest/dist/vconsole.min.js"></script>
@@ -65,7 +65,7 @@
     import Artalk from './src/main'
     var artalk = new Artalk({
       el: '#comments',
-      pageKey: 'https://artalk.js.org/',
+      pageKey: 'https://artalk.js.org/guide/intro.html',
       pageTitle: 'Artalk Home',
       server: (import.meta.env.DEV) ? 'http://localhost:23366' : 'https://artalk.qwqaq.com',
       site: 'ArtalkDocs',

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "artalk",
-  "version": "2.3.4",
-  "backendMinVersion": "2.1.10",
+  "version": "2.4.1",
+  "backendMinVersion": "2.2.0",
   "license": "LGPL-3.0",
   "description": "A Selfhosted Comment System",
   "keywords": [
@@ -22,14 +22,14 @@
   "unpkg": "./dist/Artalk.iife.js",
   "jsdelivr": "./dist/Artalk.iife.js",
   "module": "./dist/Artalk.es.js",
-  "types": "./types/index.d.ts",
+  "types": "./dist/src/main.d.ts",
   "devDependencies": {
-    "@types/marked": "4.0.3"
+    "@types/marked": "4.0.6"
   },
   "dependencies": {
     "hanabi": "^0.4.0",
     "insane": "^2.6.2",
-    "marked": "^4.0.17",
+    "marked": "^4.0.19",
     "abortcontroller-polyfill": "^1.7.3"
   },
   "scripts": {

package/src/api/admin.ts

@@ -0,0 +1,18 @@
+import ApiBase from './api-base'
+
+/**
+ * 管理员 API
+ */
+export default class AdminApi extends ApiBase {
+  /** 缓存清除 */
+  public cacheFlushAll() {
+    const params: any = { flush_all: true }
+    return this.POST('/admin/cache-flush', params)
+  }
+
+  /** 缓存预热 */
+  public cacheWarmUp() {
+    const params: any = {}
+    return this.POST('/admin/cache-warm', params)
+  }
+}

package/src/api/api-base.ts

@@ -0,0 +1,27 @@
+import Context from '~/types/context'
+import Api from '.'
+import { POST, Fetch } from './request'
+
+abstract class ApiBase {
+  protected api: Api
+  protected ctx: Context
+
+  constructor(api: Api, ctx: Context) {
+    this.api = api
+    this.ctx = ctx
+  }
+
+  protected async POST<T>(path: string, data?: {[key: string]: any}) {
+    return POST<T>(this.ctx, this.api.baseURL+path, data)
+  }
+
+  protected async Fetch(path: string, init: RequestInit, timeout?: number): Promise<any> {
+    return Fetch(this.ctx, this.api.baseURL+path, init, timeout)
+  }
+}
+
+interface ApiBase {
+
+}
+
+export default ApiBase

package/src/api/captcha.ts

@@ -0,0 +1,24 @@
+import ApiBase from './api-base'
+
+/**
+ * 验证码 API
+ */
+export default class CaptchaApi extends ApiBase {
+  /** 验证码 · 获取 */
+  public async captchaGet() {
+    const data = await this.POST<any>('/captcha/refresh')
+    return (data.img_data || '') as string
+  }
+
+  /** 验证码 · 检验 */
+  public async captchaCheck(value: string) {
+    const data = await this.POST<any>('/captcha/check', { value })
+    return (data.img_data || '') as string
+  }
+
+  /** 验证码 · 状态 */
+  public async captchaStatus() {
+    const data = await this.POST<any>('/captcha/status')
+    return (data || { is_pass: false }) as { is_pass: boolean }
+  }
+}

package/src/api/comment.ts

@@ -0,0 +1,84 @@
+import { CommentData, ListData } from '~/types/artalk-data'
+import * as Utils from '../lib/utils'
+import ApiBase from './api-base'
+
+/**
+ * 评论 API
+ */
+export default class CommentApi extends ApiBase {
+  /** 评论 · 获取 */
+  public get(offset: number, pageSize: number, flatMode?: boolean, paramsEditor?: (params: any) => void) {
+    const params: any = {
+      page_key: this.ctx.conf.pageKey,
+      site_name: this.ctx.conf.site || '',
+      limit: pageSize,
+      offset,
+    }
+
+    if (flatMode) params.flat_mode = flatMode // 平铺模式
+    if (this.ctx.user.checkHasBasicUserInfo()) {
+      params.name = this.ctx.user.data.nick
+      params.email = this.ctx.user.data.email
+    }
+
+    if (paramsEditor) paramsEditor(params)
+
+    return this.POST<ListData>('/get', params)
+  }
+
+  /** 评论 · 创建 */
+  public async add(comment: { nick: string, email: string, link: string, content: string, rid: number, page_key: string, page_title?: string, site_name?: string }) {
+    const params: any = {
+      name: comment.nick,
+      email: comment.email,
+      link: comment.link,
+      content: comment.content,
+      rid: comment.rid,
+      page_key: comment.page_key,
+      ua: await Utils.getCorrectUserAgent(), // 需要后端支持，获取修正后的 UA
+    }
+
+    if (comment.page_title) params.page_title = comment.page_title
+    if (comment.site_name) params.site_name = comment.site_name
+
+    const data = await this.POST<any>('/add', params)
+    return (data.comment as CommentData)
+  }
+
+  /** 评论 · 修改 */
+  public async commentEdit(data: Partial<CommentData>) {
+    const params: any = {
+      ...data,
+    }
+
+    const d = await this.POST<any>('/admin/comment-edit', params)
+    return (d.comment as CommentData)
+  }
+
+  /** 评论 · 删除 */
+  public commentDel(commentID: number, siteName?: string) {
+    const params: any = {
+      id: String(commentID),
+      site_name: siteName || '',
+    }
+
+    return this.POST('/admin/comment-del', params)
+  }
+
+  /** 投票 */
+  public async vote(targetID: number, type: string) {
+    const params: any = {
+      site_name: this.ctx.conf.site || '',
+      target_id: targetID,
+      type,
+    }
+
+    if (this.ctx.user.checkHasBasicUserInfo()) {
+      params.name = this.ctx.user.data.nick
+      params.email = this.ctx.user.data.email
+    }
+
+    const data = await this.POST<any>('/vote', params)
+    return (data as {up: number, down: number})
+  }
+}

package/src/api/index.ts

@@ -1,378 +1,37 @@
-import { CommentData, ListData, UserData, PageData, SiteData, NotifyData } from '~/types/artalk-data'
-import ArtalkConfig from '~/types/artalk-config'
 import Context from '~/types/context'
-import { Fetch, ToFormData, POST } from './request'
-import * as Utils from '../lib/utils'
 import 'abortcontroller-polyfill/dist/polyfill-patch-fetch'
 
-export default class Api {
-  private ctx: Context
-  private baseURL: string
+import comment from './comment'
+import page from './page'
+import site from './site'
+import user from './user'
+import system from './system'
+import captcha from './captcha'
+import admin from './admin'
+import upload from './upload'
+
+const ApiComponents = {
+  comment, page, site,
+  user, system, captcha,
+  admin, upload
+}
+
+class Api {
+  protected ctx: Context
+  public baseURL: string
 
   constructor (ctx: Context) {
     this.ctx = ctx
     this.baseURL = `${ctx.conf.server}/api`
-  }
-
-  // ============================
-  //  评论 Comment
-  // ============================
-
-  /** 评论 · 获取 */
-  public get(offset: number, pageSize: number, flatMode?: boolean, paramsEditor?: (params: any) => void) {
-    const params: any = {
-      page_key: this.ctx.conf.pageKey,
-      site_name: this.ctx.conf.site || '',
-      limit: pageSize,
-      offset,
-    }
-
-    if (flatMode) params.flat_mode = flatMode // 平铺模式
-    if (this.ctx.user.checkHasBasicUserInfo()) {
-      params.name = this.ctx.user.data.nick
-      params.email = this.ctx.user.data.email
-    }
-
-    if (paramsEditor) paramsEditor(params)
-
-    return POST<ListData>(this.ctx, `${this.baseURL}/get`, params)
-  }
-
-  /** 评论 · 创建 */
-  public async add(comment: { nick: string, email: string, link: string, content: string, rid: number, page_key: string, page_title?: string, site_name?: string }) {
-    const params: any = {
-      name: comment.nick,
-      email: comment.email,
-      link: comment.link,
-      content: comment.content,
-      rid: comment.rid,
-      page_key: comment.page_key,
-      ua: await Utils.getCorrectUserAgent(), // 需要后端支持，获取修正后的 UA
-    }
-
-    if (comment.page_title) params.page_title = comment.page_title
-    if (comment.site_name) params.site_name = comment.site_name
-
-    const data = await POST<any>(this.ctx, `${this.baseURL}/add`, params)
-    return (data.comment as CommentData)
-  }
-
-  /** 评论 · 修改 */
-  public async commentEdit(data: Partial<CommentData>) {
-    const params: any = {
-      ...data,
-    }
-
-    const d = await POST<any>(this.ctx, `${this.baseURL}/admin/comment-edit`, params)
-    return (d.comment as CommentData)
-  }
-
-  /** 评论 · 删除 */
-  public commentDel(commentID: number, siteName?: string) {
-    const params: any = {
-      id: String(commentID),
-      site_name: siteName || '',
-    }
-
-    return POST(this.ctx, `${this.baseURL}/admin/comment-del`, params)
-  }
-
-  // ============================
-  //  用户 User
-  // ============================
-
-  /** 用户 · 登录 */
-  public async login(name: string, email: string, password: string) {
-    const params: any = {
-      name, email, password
-    }
-
-    if (this.ctx.conf.site) params.site_name = this.ctx.conf.site
-
-    const data = await POST<any>(this.ctx, `${this.baseURL}/login`, params)
-    return (data.token as string)
-  }
 
-  /** 用户 · 获取  */
-  public userGet(name: string, email: string) {
-    const ctrl = new AbortController()
-    const params: any = {
-      name, email, site_name: (this.ctx.conf.site || '')
-    }
-
-    const req = Fetch(this.ctx, `${this.baseURL}/user-get`, {
-      method: 'POST',
-      body: ToFormData(params),
-      signal: ctrl.signal,
-    }).then((json) => ({
-      user: json.data.user as UserData|null,
-      is_login: json.data.is_login as boolean,
-      unread: (json.data.unread || []) as NotifyData[],
-      unread_count: json.data.unread_count || 0,
-    }))
-
-    return {
-      req,
-      abort: () => { ctrl.abort() },
-    }
-  }
-
-  /** 用户 · 登录状态 */
-  public async loginStatus() {
-    const data = await POST<any>(this.ctx, `${this.baseURL}/login-status`, {
-      name: this.ctx.user.data.nick,
-      email: this.ctx.user.data.email
+    Object.entries(ApiComponents).forEach(([key, ApiComponent]) => {
+      this[key] = new ApiComponent(this, this.ctx)
     })
-    return (data || { is_login: false, is_admin: false }) as { is_login: boolean, is_admin: boolean }
-  }
-
-  /** 用户 · 注销 */
-  public async logout() {
-    return POST(this.ctx, `${this.baseURL}/logout`)
-  }
-
-  // ============================
-  //  页面 Page
-  // ============================
-
-  /** 页面 · 获取 */
-  public async pageGet(siteName?: string, offset?: number, limit?: number) {
-    const params: any = {
-      site_name: siteName || '',
-      offset: offset || 0,
-      limit: limit || 15,
-    }
-
-    const d = await POST<any>(this.ctx, `${this.baseURL}/admin/page-get`, params)
-    return (d as { pages: PageData[], total: number })
-  }
-
-  /** 页面 · 修改 */
-  public async pageEdit(data: PageData) {
-    const params: any = {
-      id: data.id,
-      key: data.key,
-      title: data.title,
-      admin_only: data.admin_only,
-      site_name: data.site_name || this.ctx.conf.site,
-    }
-
-    const d = await POST<any>(this.ctx, `${this.baseURL}/admin/page-edit`, params)
-    return (d.page as PageData)
-  }
-
-  /** 页面 · 删除 */
-  public pageDel(pageKey: string, siteName?: string) {
-    const params: any = {
-      key: String(pageKey),
-      site_name: siteName || '',
-    }
-
-    return POST(this.ctx, `${this.baseURL}/admin/page-del`, params)
-  }
-
-  /** 页面 · 数据更新 */
-  public async pageFetch(id?: number, siteName?: string, getStatus?: boolean) {
-    const params: any = {}
-    if (id) params.id = id
-    if (siteName) params.site_name = siteName
-    if (getStatus) params.get_status = getStatus
-
-    const d = await POST<any>(this.ctx, `${this.baseURL}/admin/page-fetch`, params)
-    return (d as any)
-  }
-
-  // ============================
-  //  站点 Site
-  // ============================
-
-  /** 站点 · 获取 */
-  public async siteGet() {
-    const params: any = {}
-
-    const d = await POST<any>(this.ctx, `${this.baseURL}/admin/site-get`, params)
-    return (d.sites as SiteData[])
-  }
-
-  /** 站点 · 创建 */
-  public async siteAdd(name: string, urls: string) {
-    const params: any = {
-      name, urls,
-    }
-
-    const d = await POST<any>(this.ctx, `${this.baseURL}/admin/site-add`, params)
-    return (d.site as SiteData)
-  }
-
-  /** 站点 · 修改 */
-  public async siteEdit(data: SiteData) {
-    const params: any = {
-      id: data.id,
-      name: data.name || '',
-      urls: data.urls || '',
-    }
-
-    const d = await POST<any>(this.ctx, `${this.baseURL}/admin/site-edit`, params)
-    return (d.site as SiteData)
-  }
-
-  /** 站点 · 删除 */
-  public siteDel(id: number, delContent = false) {
-    const params: any = { id, del_content: delContent }
-
-    return POST(this.ctx, `${this.baseURL}/admin/site-del`, params)
-  }
-
-  /** 导出 */
-  public async export() {
-    const d = await Fetch(this.ctx, `${this.baseURL}/admin/export`, { method: 'POST' }, 0)
-    return (d.data?.data || '' as string)
-  }
-
-  // ============================
-  //  杂项
-  // ============================
-
-  /** 投票 */
-  public async vote(targetID: number, type: string) {
-    const params: any = {
-      site_name: this.ctx.conf.site || '',
-      target_id: targetID,
-      type,
-    }
-
-    if (this.ctx.user.checkHasBasicUserInfo()) {
-      params.name = this.ctx.user.data.nick
-      params.email = this.ctx.user.data.email
-    }
-
-    const data = await POST<any>(this.ctx, `${this.baseURL}/vote`, params)
-    return (data as {up: number, down: number})
-  }
-
-  /** 已读标记 */
-  public markRead(notifyKey: string, readAll = false) {
-    const params: any = {
-      site_name: this.ctx.conf.site || '',
-      notify_key: notifyKey,
-    }
-
-    if (readAll) {
-      delete params.notify_key
-      params.read_all = true
-      params.name = this.ctx.user.data.nick
-      params.email = this.ctx.user.data.email
-    }
-
-    return POST(this.ctx, `${this.baseURL}/mark-read`, params)
-  }
-
-  /** PV */
-  public async pv() {
-    const params: any = {
-      site_name: this.ctx.conf.site || '',
-      page_key: this.ctx.conf.pageKey || '',
-      page_title: this.ctx.conf.pageTitle || ''
-    }
-
-    const p = await POST<any>(this.ctx, `${this.baseURL}/pv`, params)
-    return p.pv as number
-  }
-
-  /** 统计 */
-  public async stat(
-    type: 'latest_comments'|'latest_pages'|'pv_most_pages'|'comment_most_pages'|
-          'page_pv'|'site_pv'|'page_comment'|'site_comment',
-    pageKeys?: string|string[],
-    limit?: number
-  ) {
-    const params: any = {
-      type,
-      site_name: this.ctx.conf.site || '',
-    }
-
-    if (pageKeys) params.page_keys = Array.isArray(pageKeys) ? pageKeys.join(',') : pageKeys
-    if (limit) params.limit = limit
-
-    const data = await POST<PageData[]|CommentData[]|object|number>(this.ctx, `${this.baseURL}/stat`, params)
-    return data
-  }
-
-  /** 图片上传 */
-  public async imgUpload(file: File) {
-    const params: any = {
-      name: this.ctx.user.data.nick,
-      email: this.ctx.user.data.email,
-      page_key: this.ctx.conf.pageKey,
-    }
-
-    if (this.ctx.conf.site) params.site_name = this.ctx.conf.site
-
-    const form = ToFormData(params)
-    form.set('file', file)
-
-    const init: RequestInit = {
-      method: 'POST',
-      body: form
-    }
-
-    const json = await Fetch(this.ctx, `${this.baseURL}/img-upload`, init)
-    return ((json.data || {}) as any) as { img_file: string, img_url: string }
-  }
-
-  /** 获取配置 */
-  public async conf() {
-    const data = await POST<any>(this.ctx, `${this.baseURL}/conf`)
-    const conf = (data.frontend_conf || {}) as ArtalkConfig
-
-    // Patch: `emoticons` config string to json
-    if (conf.emoticons && typeof conf.emoticons === "string") {
-      conf.emoticons = conf.emoticons.trim()
-      if (conf.emoticons.startsWith("[") || conf.emoticons.startsWith("{")) {
-        conf.emoticons = JSON.parse(conf.emoticons) // pase json
-      } else if (conf.emoticons === "false") {
-        conf.emoticons = false
-      }
-    }
-
-    return conf
   }
+}
 
-  // ============================
-  //  验证码
-  // ============================
-
-  /** 验证码 · 获取 */
-  public async captchaGet() {
-    const data = await POST<any>(this.ctx, `${this.baseURL}/captcha/refresh`)
-    return (data.img_data || '') as string
-  }
-
-  /** 验证码 · 检验 */
-  public async captchaCheck(value: string) {
-    const data = await POST<any>(this.ctx, `${this.baseURL}/captcha/check`, { value })
-    return (data.img_data || '') as string
-  }
-
-  /** 验证码 · 状态 */
-  public async captchaStatus() {
-    const data = await POST<any>(this.ctx, `${this.baseURL}/captcha/status`)
-    return (data || { is_pass: false }) as { is_pass: boolean }
-  }
-
-  // ============================
-  //  管理员缓存操作
-  // ============================
-
-  /** 缓存清除 */
-  public cacheFlushAll() {
-    const params: any = { flush_all: true }
-    return POST(this.ctx, `${this.baseURL}/admin/cache-flush`, params)
-  }
+type TC = typeof ApiComponents
+type AC = { [K in keyof TC]: InstanceType<TC[K]> }
+interface Api extends AC {}
 
-  /** 缓存预热 */
-  public cacheWarmUp() {
-    const params: any = {}
-    return POST(this.ctx, `${this.baseURL}/admin/cache-warm`, params)
-  }
-}
+export default Api