artalk 2.2.12 → 2.3.2

package/types/context.d.ts

@@ -0,0 +1,128 @@
+import { marked as libMarked } from 'marked'
+import ArtalkConfig from './artalk-config'
+import { CommentData, NotifyData } from './artalk-data'
+import { EventPayloadMap, Event, EventScopeType, Handler } from './event'
+import { internal as internalLocales, I18n } from '../src/i18n'
+import Api from '../src/api'
+import User from '../src/lib/user'
+import Editor from '../src/editor'
+import Comment from '../src/comment'
+import ListLite from '../src/list/list-lite'
+import SidebarLayer, { SidebarShowPayload } from '../src/layer/sidebar-layer'
+import CheckerLauncher, { CheckerCaptchaPayload, CheckerPayload } from '../src/lib/checker'
+
+/**
+ * Context 接口
+ *
+ * (面向接口的编程)
+ */
+export default interface ContextApi {
+  /** Context 唯一标识 */
+  cid: number
+
+  /** Artalk 根元素对象 */
+  $root: HTMLElement
+
+  /** 配置对象 */
+  conf: ArtalkConfig
+
+  /** 用户对象 */
+  user: User
+
+  /** marked 依赖对象 */
+  markedInstance?: typeof libMarked
+
+  /** marked 内容替换器 */
+  markedReplacers: ((raw: string) => string)[]
+
+  /* 设置持有的同事类 (中介者模式) */
+  setApi(api: Api): void
+  setEditor(editor: Editor): void
+  setList(list: ListLite): void
+  setSidebarLayer(list: SidebarLayer): void
+  setCheckerLauncher(checkerLauncher: CheckerLauncher): void
+
+  /** 获取 API 以供 HTTP 请求 */
+  getApi(): Api
+
+  /** 获取评论实例对象列表 */
+  getCommentList(): Comment[]
+
+  /** 获取评论数据列表 */
+  getCommentDataList(): CommentData[]
+
+  /** 查找评论 */
+  findComment(id: number): Comment|undefined
+
+  /** 删除评论 */
+  deleteComment(comment: number|Comment): void
+
+  /** 清空评论 */
+  clearAllComments(): void
+
+  /** 插入评论 */
+  insertComment(commentData: CommentData): void
+
+  /** 评论回复 */
+  replyComment(commentData: CommentData, $comment: HTMLElement, scroll?: boolean): void
+
+  /** 取消回复评论 */
+  cancelReplyComment(): void
+
+  /** 更新通知数据 */
+  updateNotifies(notifies: NotifyData[]): void
+
+  /** 列表 - 重新加载数据 */
+  listReload(): void
+
+  /** 列表 - UI 更新 */
+  listRefreshUI(): void
+
+  /** 显示侧边栏 */
+  showSidebar(payload?: SidebarShowPayload): void
+
+  /** 隐藏侧边栏 */
+  hideSidebar(): void
+
+  /** 编辑器 - 关闭评论 */
+  editorClose(): void
+
+  /** 编辑器 - 打开评论 */
+  editorOpen(): void
+
+  /** 编辑器 - 显示加载 */
+  editorShowLoading(): void
+
+  /** 编辑器 - 隐藏加载 */
+  editorHideLoading(): void
+
+  /** 编辑器 - 显示提示消息 */
+  editorShowNotify(msg: string, type: "i" | "s" | "w" | "e"): void
+
+  /** 评论框 - 位置移动 */
+  editorTravel($el: HTMLElement): void
+
+  /** 评论框 - 位置回归 */
+  editorTravelBack(): void
+
+  /** 验证码检测 */
+  checkCaptcha(payload: CheckerCaptchaPayload): void
+
+  /** 管理员检测 */
+  checkAdmin(payload: CheckerPayload): void
+
+  /** 管理员显示元素可见性更新 */
+  checkAdminShowEl(): void
+
+  /** 订阅注册 */
+  on<K extends keyof EventPayloadMap>(name: K, handler: Handler<EventPayloadMap[K]>, scope?: EventScopeType): void
+
+  /** 订阅取消 */
+  off<K extends keyof EventPayloadMap>(name: K, handler?: Handler<EventPayloadMap[K]>, scope?: EventScopeType): void
+
+  /** 订阅发布 */
+  trigger<K extends keyof EventPayloadMap>(name: K, payload?: EventPayloadMap[K], scope?: EventScopeType): void
+
+  /** i18n 翻译 */
+  $t(key: keyof I18n, args?: {[key: string]: string}): string
+}

package/types/event.d.ts

@@ -1,77 +1,17 @@
-import { ListData, CommentData, NotifyData } from './artalk-data'
+import { CommentData } from './artalk-data'
 import { LocalUser } from './artalk-config'
 
 /** EventName to EventPayload Type */
 export interface EventPayloadMap {
-  'comments-load': undefined       // 评论加载时
-  'comments-loaded': undefined     // 评论装载后
+  'list-load': undefined           // 评论加载时
+  'list-loaded': undefined         // 评论装载后
+  'list-inserted': CommentData     // 评论插入后
   'editor-submit': undefined       // 编辑器提交时
   'editor-submitted': undefined    // 编辑器提交后
   'user-changed': LocalUser        // 本地用户数据变更时
   'conf-updated': undefined        // Artalk 配置变更时
-
-  // List 操作（外部：不建议 listen，仅 trigger）
-  'list-reload': undefined         // 重新加载 List
-  'list-import': CommentData[]     // 评论导入
-  'list-insert': CommentData       // 评论添加
-  'list-delete': CommentData       // 评论删除
-  'list-update': ListUpdatePayload // 更新评论数据
-  'list-refresh-ui': undefined     // 刷新 List UI
-
-  // Sidebar
-  'sidebar-show': SidebarShowPayload  // 侧边栏显示
-  'sidebar-hide': undefined           // 侧边栏隐藏
-
-  // Editor
-  'editor-open': undefined            // 打开评论
-  'editor-close': undefined           // 关闭评论
-  'editor-show-loading': undefined    // 加载显示
-  'editor-hide-loading': undefined    // 加载隐藏
-  'editor-notify': NotifyConf         // 显示提示
-  'editor-reply': EditorReplyPayload  // 设置回复
-  'editor-reply-cancel': undefined    // 取消回复
-  'editor-travel': HTMLElement
-  'editor-travel-back': undefined
-
-  // Notify
-  'unread-update': UnreadUpdatePayload // 未读数据更新
-
-  // Checker
-  'checker-admin': CheckerPayload           // 检查管理员
-  'checker-captcha': CheckerCaptchaPayload  // 检查验证码
-  'check-admin-show-el': undefined          // 检查并更新仅管理员显示的元素
-}
-
-export interface CheckerPayload {
-  onSuccess?: (inputVal: string, dialogEl?: HTMLElement) => void
-  onMount?: (dialogEl: HTMLElement) => void
-  onCancel?: () => void
-}
-
-export interface NotifyConf {
-  msg: string
-  type: any
-}
-
-export interface CheckerCaptchaPayload extends CheckerPayload {
-  imgData?: string
-  iframe?: string
-}
-
-export interface UnreadUpdatePayload {
-  notifies: NotifyData[]
-}
-
-export type ListUpdatePayload = (data: ListData | undefined) => void
-
-export interface EditorReplyPayload {
-  data: CommentData
-  $el: HTMLElement
-  scroll?: boolean
-}
-
-export interface SidebarShowPayload {
-  view?: 'comments'|'sites'|'pages'|'transfer'|string
+  'sidebar-show': undefined        // 侧边栏显示
+  'sidebar-hide': undefined        // 侧边栏隐藏
 }
 
 // ============================================

package/types/global.d.ts

@@ -1 +1,2 @@
 declare const ARTALK_VERSION: string
+declare const ARTALK_LITE: boolean

package/types/plug.d.ts

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

package/{vite-common.config.ts → vite-base.config.ts}

@@ -1,9 +1,10 @@
-import { UserConfigExport } from 'vite'
+import { defineConfig } from 'vite'
+import tsconfigPaths from 'vite-tsconfig-paths'
 import { version } from './package.json'
 
-export default {
+export default defineConfig({
   define: {
-    ARTALK_VERSION: JSON.stringify(version)
+    ARTALK_VERSION: JSON.stringify(version),
   },
   css: {
     preprocessorOptions: {
@@ -12,4 +13,5 @@ export default {
      },
     },
   },
-} as UserConfigExport
+  plugins: [tsconfigPaths()],
+})

package/vite-demo.config.ts

@@ -1,7 +1,6 @@
 import { defineConfig } from 'vite'
 import { resolve } from 'path'
-import commonConf from './vite-common.config'
-import tsconfigPaths from 'vite-tsconfig-paths'
+import baseConf from './vite-base.config'
 
 export default defineConfig({
   build: {
@@ -9,6 +8,5 @@ export default defineConfig({
     outDir: resolve(__dirname, "deploy"),
     rollupOptions: {}
   },
-  plugins: [tsconfigPaths()],
-  ...commonConf
+  ...baseConf
 })

package/vite-lite.config.ts

@@ -0,0 +1,22 @@
+import fullVersionConf from './vite.config'
+import * as Utils from './src/lib/utils'
+
+export default Utils.mergeDeep(fullVersionConf, {
+  build: {
+    lib: {
+      fileName: (format) => ((format == "umd") ? 'ArtalkLite.js' : `ArtalkLite.${format}.js`),
+    },
+    rollupOptions: {
+      external: ['marked'],
+      output: {
+        globals: {
+          marked: 'marked',
+        },
+        assetFileNames: (assetInfo) => (/\.css$/.test(assetInfo.name) ? "ArtalkLite.css" : "[name].[ext]")
+      }
+   }
+  },
+  define: {
+    ARTALK_LITE: true,
+  },
+})

package/vite.config.ts

@@ -1,13 +1,14 @@
 import { defineConfig } from 'vite'
 import { resolve } from 'path'
-import commonConf from './vite-common.config'
-import tsconfigPaths from 'vite-tsconfig-paths'
+import baseConf from './vite-base.config'
+import * as Utils from './src/lib/utils'
 
-export default defineConfig({
+export default Utils.mergeDeep(baseConf, defineConfig({
   build: {
     target: 'es2015',
     outDir: resolve(__dirname, "dist"),
     minify: 'terser',
+    emptyOutDir: false,
     lib: {
       entry: resolve(__dirname, 'src/main.ts'),
       name: 'Artalk',
@@ -16,15 +17,11 @@ export default defineConfig({
     },
     rollupOptions: {
       output: {
-        assetFileNames: assetInfo => {
-          if (/\.css$/.test(assetInfo.name)) {
-            return 'Artalk.css'
-          }
-          return "[name].[ext]"
-        }
+        assetFileNames: (assetInfo) => (/\.css$/.test(assetInfo.name) ? "Artalk.css" : "[name].[ext]")
       }
     }
   },
-  plugins: [tsconfigPaths()],
-  ...commonConf
-})
+  define: {
+    ARTALK_LITE: false,
+  },
+}))

package/src/components/_component.ts.txt

@@ -1,10 +0,0 @@
-import Context from '@/context'
-import Component from '@/lib/component'
-import * as Utils from '@/lib/utils'
-import * as Ui from '@/lib/ui'
-
-export default class Example extends Component {
-  constructor(ctx: Context) {
-    super(ctx)
-  }
-}