artalk 2.3.3 → 2.4.0

package/dist/src/lib/stat.d.ts

@@ -0,0 +1,15 @@
+import ContextApi from '../../types/context';
+import ArtalkPlug from '../../types/plug';
+export interface CountConf {
+    ctx: ContextApi;
+    /** 是否增加当前页面 PV 数 */
+    pvAdd?: boolean;
+}
+export declare const PvCountWidget: ArtalkPlug;
+/** 初始化评论数和 PV 数量展示元素 */
+export declare function initCountWidget(p: CountConf): Promise<void>;
+export declare function handleStatCount(p: CountConf, args: {
+    api: 'page_pv' | 'page_comment';
+    countEl: string;
+    curtPageCount?: number;
+}): Promise<void>;

package/dist/src/lib/ui.d.ts

@@ -0,0 +1,23 @@
+/** 显示加载 */
+export declare function showLoading(parentElem: HTMLElement, conf?: {
+    transparentBg?: boolean;
+}): void;
+/** 隐藏加载 */
+export declare function hideLoading(parentElem: HTMLElement): void;
+/** 元素加载动画 */
+export declare function setLoading(val: boolean, parentElem: HTMLElement): void;
+/** 元素是否用户可见 */
+export declare function isVisible(el: HTMLElement, viewport?: HTMLElement): boolean;
+/** 滚动到元素中心 */
+export declare function scrollIntoView(elem: HTMLElement, enableAnim?: boolean): void;
+/** 显示消息 */
+export declare function showNotify(wrapElem: HTMLElement, msg: string, type: 's' | 'e' | 'w' | 'i'): void;
+/** fade 动画 */
+export declare function playFadeAnim(elem: HTMLElement, after?: () => void, type?: 'in' | 'out'): void;
+/** 渐入动画 */
+export declare function playFadeInAnim(elem: HTMLElement, after?: () => void): void;
+/** 渐出动画 */
+export declare function playFadeOutAnim(elem: HTMLElement, after?: () => void): void;
+/** 设置全局错误 */
+export declare function setError(parentElem: HTMLElement, html: string | HTMLElement | null, title?: string): void;
+export declare function getScrollBarWidth(): number;

package/dist/src/lib/user.d.ts

@@ -0,0 +1,13 @@
+import { LocalUser } from '../../types/artalk-config';
+import Context from '../../types/context';
+export default class User {
+    ctx: Context;
+    data: LocalUser;
+    constructor(ctx: Context);
+    /** 保存用户到 localStorage 中 */
+    update(obj?: Partial<LocalUser>): void;
+    /** 注销，清除用户登录状态 */
+    logout(): void;
+    /** 是否已填写基本用户信息 */
+    checkHasBasicUserInfo(): boolean;
+}

package/dist/src/lib/utils.d.ts

@@ -0,0 +1,39 @@
+import Context from '../../types/context';
+export declare function createElement<E extends HTMLElement = HTMLElement>(htmlStr?: string): E;
+export declare function getHeight(el: HTMLElement): number;
+export declare function htmlEncode(str: string): string;
+export declare function htmlDecode(str: string): string;
+export declare function getQueryParam(name: string): string | null;
+export declare function getOffset(el: HTMLElement): {
+    top: number;
+    left: number;
+};
+export declare function padWithZeros(vNumber: number, width: number): string;
+export declare function dateFormat(date: Date): string;
+export declare function timeAgo(date: Date, ctx: Context): string;
+/** 所有图片加载完毕后执行 */
+export declare function onImagesLoaded($container: HTMLElement, event: Function): void;
+export declare function getGravatarURL(ctx: Context, emailMD5: string): string;
+export declare function sleep(ms: number): Promise<unknown>;
+/** 版本号比较（a < b :-1 | 0 | b < a :1） */
+export declare function versionCompare(a: string, b: string): 0 | 1 | -1;
+/** 初始化 marked */
+export declare function initMarked(ctx: Context): void;
+/** 解析 markdown */
+export declare function marked(ctx: Context, src: string): string;
+/** 获取修正后的 UserAgent */
+export declare function getCorrectUserAgent(): Promise<string>;
+/** 是否为完整的 URL */
+export declare function isValidURL(urlRaw: string): boolean;
+/** 获取基于 conf.server 的 URL */
+export declare function getURLBasedOnApi(ctx: Context, path: string): string;
+/** 获取基于某个 baseURL 的 URL */
+export declare function getURLBasedOn(baseURL: string, path: string): string;
+/**
+ * Performs a deep merge of `source` into `target`.
+ * Mutates `target` only but not its objects and arrays.
+ *
+ * @author inspired by [jhildenbiddle](https://stackoverflow.com/a/48218209).
+ * @link https://gist.github.com/ahtcx/0cd94e62691f539160b32ecda18af3d6
+ */
+export declare function mergeDeep(target: any, source: any): any;

package/dist/src/list/index.d.ts

@@ -0,0 +1,2 @@
+import List from './list';
+export default List;

package/dist/src/list/list-lite.d.ts

@@ -0,0 +1,63 @@
+import { ListData, CommentData, NotifyData } from '../../types/artalk-data';
+import Context from '../../types/context';
+import Component from '../lib/component';
+import Comment from '../comment';
+import Pagination from '../components/pagination';
+import ReadMoreBtn from '../components/read-more-btn';
+import * as ListNest from './list-nest';
+export default class ListLite extends Component {
+    protected $commentsWrap: HTMLElement;
+    protected data?: ListData;
+    protected isLoading: boolean;
+    noCommentText: string;
+    /** 平铺模式 */
+    flatMode: boolean;
+    /** 嵌套模式 */
+    nestSortBy: ListNest.SortByType;
+    /** 分页 */
+    pageMode: 'pagination' | 'read-more';
+    pageSize: number;
+    scrollListenerAt?: HTMLElement;
+    repositionAt?: HTMLElement;
+    protected pagination?: Pagination;
+    protected readMoreBtn?: ReadMoreBtn;
+    protected autoLoadScrollEvent?: any;
+    renderComment?: (comment: Comment) => void;
+    paramsEditor?: (params: any) => void;
+    onAfterLoad?: (data: ListData) => void;
+    protected unread: NotifyData[];
+    unreadHighlight?: boolean;
+    constructor(ctx: Context);
+    getData(): ListData | undefined;
+    clearData(): void;
+    getCommentsWrapEl(): HTMLElement;
+    /** 加载动画 */
+    setLoading(val: boolean, isFirstLoad?: boolean): void;
+    /** 评论获取 */
+    fetchComments(offset: number): Promise<void>;
+    protected onLoad(data: ListData, offset: number): void;
+    /** 分页模式 */
+    private refreshPagination;
+    private initPagination;
+    /** 错误处理 */
+    protected onError(msg: any, offset: number, errData?: any): void;
+    /** 刷新界面 */
+    refreshUI(): void;
+    /** 重新加载列表 */
+    reload(): void;
+    /** 创建新评论 */
+    protected createComment(cData: CommentData, ctxData?: CommentData[]): Comment;
+    /** 导入评论 · 通过请求数据 */
+    importComments(srcData: CommentData[]): void;
+    private importCommentsNest;
+    /** 导入评论 · 平铺模式 */
+    private putCommentFlatMode;
+    /** 新增评论 · 首部添加 */
+    insertComment(commentData: CommentData): void;
+    /** 更新评论 */
+    updateComment(commentData: CommentData): void;
+    /** 更新未读数据 */
+    updateUnread(notifies: NotifyData[]): void;
+    /** 版本检测 */
+    versionCheck(name: 'frontend' | 'backend', needVersion: string, curtVersion: string): boolean;
+}

package/dist/src/list/list-nest.d.ts

@@ -0,0 +1,10 @@
+import { CommentData } from '../../types/artalk-data';
+export declare type CommentNode = {
+    id: number;
+    comment: CommentData;
+    children: CommentNode[];
+    parent?: CommentNode;
+    level: number;
+};
+export declare type SortByType = 'DATE_DESC' | 'DATE_ASC' | 'SRC_INDEX' | 'VOTE_UP_DESC';
+export declare function makeNestCommentNodeList(srcData: CommentData[], sortBy?: SortByType, nestMax?: number): CommentNode[];

package/dist/src/list/list.d.ts

@@ -0,0 +1,26 @@
+import { ListData, NotifyData } from '../../types/artalk-data';
+import Context from '../../types/context';
+import ListLite from './list-lite';
+export default class List extends ListLite {
+    private $closeCommentBtn;
+    private $openSidebarBtn;
+    private $unreadBadge;
+    private $commentCount;
+    private $commentCountNum;
+    private $dropdownWrap?;
+    constructor(ctx: Context);
+    private initListActionBtn;
+    /** 刷新界面 */
+    refreshUI(): void;
+    protected onLoad(data: ListData, offset: number): void;
+    private goToCommentFounded;
+    goToCommentDelay: boolean;
+    /** 跳到评论项位置 - 根据 `location.hash` */
+    checkGoToCommentByUrlHash(): void;
+    /** 管理员设置页面信息 */
+    adminPageEditSave(): void;
+    showUnreadBadge(count: number): void;
+    /** 初始化选择下拉层 */
+    protected initDropdown(): void;
+    updateUnread(notifies: NotifyData[]): void;
+}

package/dist/src/main.d.ts

@@ -0,0 +1,4 @@
+import Artalk from './artalk';
+import ListLite from './list/list-lite';
+export default Artalk;
+export { ListLite };

package/dist/types/artalk-config.d.ts

@@ -0,0 +1,132 @@
+import { I18n } from '../src/i18n'
+
+export default 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: {
+    /** 镜像 */
+    mirror: string
+    /** 默认头像（URL or Gravatar Type） */
+    default: string
+  }
+
+  /** 分页配置 */
+  pagination: {
+    /** 每次请求获取数量 */
+    pageSize: number
+    /** 阅读更多模式 */
+    readMore: boolean
+    /** 滚动到底部自动加载 */
+    autoLoad: boolean
+  }
+
+  /** 内容限高 */
+  heightLimit: {
+    /** 评论内容限高 */
+    content: number
+
+    /** 子评论区域限高 */
+    children: number
+  }
+
+  /** 评论投票按钮 */
+  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
+}
+
+/**
+ * 本地持久化用户数据
+ * @note 始终保持一层结构，不支持多层结构
+ */
+export interface LocalUser {
+  /** 昵称 */
+  nick: string
+
+  /** 邮箱 */
+  email: string
+
+  /** 链接 */
+  link: string
+
+  /** TOKEN */
+  token: string
+
+  /** 是否为管理员 */
+  isAdmin: boolean
+}

package/dist/types/artalk-data.d.ts

@@ -0,0 +1,204 @@
+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
+
+  /** 是否允许回复 */
+  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
+}
+
+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
+
+    /** API 程序要求前端最小版本 */
+  fe_min_version: string
+}

package/dist/types/context.d.ts

@@ -0,0 +1,146 @@
+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
+
+  /** 更新评论 */
+  updateComment(commentData: CommentData): void
+
+  /** 评论回复 */
+  replyComment(commentData: CommentData, $comment: HTMLElement, scroll?: boolean): void
+
+  /** 取消回复评论 */
+  cancelReplyComment(): void
+
+  /** 编辑评论 */
+  editComment(commentData: CommentData, $comment: HTMLElement): void
+
+  /** 取消编辑评论 */
+  cancelEditComment(): void
+
+  /** 更新通知数据 */
+  updateNotifies(notifies: NotifyData[]): void
+
+  /** 列表 - 重新加载数据 */
+  listReload(): void
+
+  /** 列表 - 重新加载数据 (别名) */
+  reload(): void
+
+  /** 列表 - UI 更新 */
+  listRefreshUI(): void
+
+  /** 列表 - HashGoto 功能检测 */
+  listHashGotoCheck(): 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
+
+  /** 设置暗黑模式 */
+  setDarkMode(darkMode: boolean): void
+}