artalk 2.7.2 → 2.7.3

package/dist/main.d.cts

@@ -0,0 +1,1476 @@
+import { marked } from 'marked';
+
+declare type AC = {
+    [K in keyof TC]: InstanceType<TC[K]>;
+};
+
+/**
+ * 通用操作按钮
+ */
+declare class ActionBtn {
+    private opts;
+    $el: HTMLElement;
+    isLoading: boolean;
+    msgRecTimer?: number;
+    msgRecTimerFunc?: Function;
+    get isMessaging(): boolean;
+    isConfirming: boolean;
+    confirmRecTimer?: number;
+    /** 构造函数 */
+    constructor(opts: ActionBtnOptions | string | (() => string));
+    /** 将按钮装载到指定元素 */
+    appendTo(dom: HTMLElement): this;
+    /** 获取按钮文字（动态/静态） */
+    private getText;
+    /** 设置点击事件 */
+    setClick(func: Function): void;
+    /** 文字刷新（动态/静态） */
+    updateText(text?: (() => string) | string): void;
+    /** 设置加载状态 */
+    setLoading(value: boolean, loadingText?: string): void;
+    /** 错误消息 */
+    setError(text: string): void;
+    /** 警告消息 */
+    setWarn(text: string): void;
+    /** 成功消息 */
+    setSuccess(text: string): void;
+    /** 设置消息 */
+    setMsg(text: string, className?: string, duringTime?: number, after?: Function): void;
+    /** 设置消息复原操作定时器 */
+    private setMsgRecTimer;
+    /** 立刻触发器复原定时器 */
+    private fireMsgRecTimer;
+    /** 仅清除 timer */
+    private clearMsgRecTimer;
+}
+
+declare interface ActionBtnOptions {
+    /** 按钮文字 (动态/静态) */
+    text: (() => string) | string;
+    /** 仅管理员可用 */
+    adminOnly?: boolean;
+    /** 确认操作 */
+    confirm?: boolean;
+    /** 确认时提示文字 */
+    confirmText?: string;
+}
+
+/**
+ * 管理员 API
+ */
+declare class AdminApi extends ApiBase {
+    /** 缓存清除 */
+    cacheFlushAll(): Promise<unknown>;
+    /** 缓存预热 */
+    cacheWarmUp(): Promise<unknown>;
+}
+
+declare class Api {
+    constructor(opts: ApiOptions);
+}
+
+declare interface Api extends AC {
+}
+
+declare abstract class ApiBase {
+    protected options: ApiOptions;
+    constructor(options: ApiOptions);
+    protected POST<T>(path: string, data?: {
+        [key: string]: any;
+    }): Promise<T>;
+    protected Fetch(path: string, init: RequestInit, timeout?: number): Promise<any>;
+    /**
+     * Carry user info to request params
+     *
+     * @param params Request params
+     * @returns Request params with user info
+     */
+    protected withUserInfo(params: any): any;
+}
+
+declare const ApiComponents: {
+    comment: typeof CommentApi;
+    page: typeof PageApi;
+    site: typeof SiteApi;
+    user: typeof UserApi;
+    system: typeof SystemApi;
+    captcha: typeof CaptchaApi;
+    admin: typeof AdminApi;
+    upload: typeof UploadApi;
+};
+
+declare interface ApiOptions {
+    baseURL: string;
+    siteName: string;
+    pageKey: string;
+    pageTitle: string;
+    timeout?: number;
+    apiToken?: string;
+    userInfo?: {
+        name: string;
+        email: string;
+    };
+    onNeedCheckCaptcha?: (payload: {
+        recall: () => void;
+        reject: () => void;
+        data: {
+            imgData: string;
+            iframe: string;
+        };
+    }) => void;
+    onNeedCheckAdmin?: (payload: {
+        recall: () => void;
+        reject: () => void;
+    }) => void;
+}
+
+export declare interface ApiVersionData {
+    /** API 程序名 */
+    app: string;
+    /** API 程序版本号 */
+    version: string;
+    /** API 程序 CommitHash */
+    commit_hash: string;
+}
+
+declare interface ApiVersionInfo {
+    app: string;
+    version: string;
+    commit_hash: string;
+}
+
+/**
+ * Artalk
+ *
+ * @see https://artalk.js.org
+ */
+declare class Artalk {
+    ctx: ContextApi;
+    /** Plugins */
+    protected plugins: ArtalkPlugin[];
+    constructor(conf: Partial<ArtalkConfig>);
+    /** Get the config of Artalk */
+    getConf(): ArtalkConfig;
+    /** Get the root element of Artalk */
+    getEl(): HTMLElement;
+    /** Update config of Artalk */
+    update(conf: Partial<ArtalkConfig>): this;
+    /** Reload comment list of Artalk */
+    reload(): void;
+    /** Destroy instance of Artalk */
+    destroy(): void;
+    /** Add an event listener */
+    on<K extends keyof EventPayloadMap>(name: K, handler: EventHandler<EventPayloadMap[K]>): void;
+    /** Remove an event listener */
+    off<K extends keyof EventPayloadMap>(name: K, handler: EventHandler<EventPayloadMap[K]>): void;
+    /** Trigger an event */
+    trigger<K extends keyof EventPayloadMap>(name: K, payload?: EventPayloadMap[K]): void;
+    /** Set dark mode */
+    setDarkMode(darkMode: boolean): void;
+    /** Init Artalk */
+    static init(conf: Partial<ArtalkConfig>): Artalk;
+    /** Use plugin, the plugin will be used when Artalk.init */
+    static use(plugin: ArtalkPlugin): void;
+    /** Load count widget */
+    static loadCountWidget(c: Partial<ArtalkConfig>): void;
+    /** @deprecated Please use `getEl()` instead */
+    get $root(): HTMLElement;
+    /** @description Please use `getConf()` instead */
+    get conf(): ArtalkConfig;
+}
+export default Artalk;
+
+export declare 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;
+    remoteConfModifier?: (conf: Partial<ArtalkConfig>) => void;
+    listUnreadHighlight?: boolean;
+    scrollRelativeTo?: () => HTMLElement;
+    immediateFetch?: boolean;
+}
+
+export declare type ArtalkPlugin = (ctx: ContextApi) => void;
+
+declare namespace ArtalkType {
+    export {
+        I18n,
+        I18nKeys,
+        ArtalkConfig,
+        LocalUser,
+        CommentData,
+        ListData,
+        PageData,
+        SiteData,
+        UserData,
+        UserDataForAdmin,
+        NotifyData,
+        EmoticonGrpData,
+        EmoticonListData,
+        ApiVersionData,
+        ListFetchParams,
+        ListLastFetchData,
+        DataManagerApi,
+        NotifyLevel,
+        ContextApi,
+        EditorState,
+        EditorApi,
+        EventPayloadMap,
+        ArtalkPlugin,
+        SidebarShowPayload
+    }
+}
+export { ArtalkType }
+
+/**
+ * 验证码 API
+ */
+declare class CaptchaApi extends ApiBase {
+    /** 验证码 · 获取 */
+    captchaGet(): Promise<string>;
+    /** 验证码 · 检验 */
+    captchaCheck(value: string): Promise<string>;
+    /** 验证码 · 状态 */
+    captchaStatus(): Promise<{
+        is_pass: boolean;
+    }>;
+}
+
+declare interface Checker {
+    el?: HTMLElement;
+    inputType?: 'password' | 'text';
+    body: (checker: CheckerCtx) => HTMLElement;
+    request: (checker: CheckerCtx, inputVal: string) => Promise<string>;
+    onSuccess?: (checker: CheckerCtx, respData: string, inputVal: string, formEl: HTMLElement) => void;
+    onError?: (checker: CheckerCtx, err: any, inputVal: string, formEl: HTMLElement) => void;
+}
+
+declare interface CheckerCaptchaPayload extends CheckerPayload {
+    imgData?: string;
+    iframe?: string;
+}
+
+declare interface CheckerCtx {
+    get<K extends keyof CheckerStore>(key: K): CheckerStore[K];
+    set<K extends keyof CheckerStore>(key: K, val: CheckerStore[K]): void;
+    getOpts(): CheckerLauncherOptions;
+    getApi(): Api;
+    getUser(): User;
+    hideInteractInput(): void;
+    triggerSuccess(): void;
+    cancel(): void;
+}
+
+/**
+ * Checker 发射台
+ */
+declare class CheckerLauncher {
+    private opts;
+    constructor(opts: CheckerLauncherOptions);
+    checkCaptcha(payload: CheckerCaptchaPayload): void;
+    checkAdmin(payload: CheckerPayload): void;
+    fire(checker: Checker, payload: CheckerPayload, postFire?: (c: CheckerCtx) => void): void;
+    private close;
+}
+
+declare interface CheckerLauncherOptions {
+    getCtx: () => ContextApi;
+    getApi: () => Api;
+    getIframeURLBase: () => string;
+    onReload: () => void;
+}
+
+declare interface CheckerPayload {
+    onSuccess?: (inputVal: string, dialogEl?: HTMLElement) => void;
+    onMount?: (dialogEl: HTMLElement) => void;
+    onCancel?: () => void;
+}
+
+declare interface CheckerStore {
+    val?: string;
+    img_data?: string;
+    iframe?: string;
+}
+
+declare class Comment_2 extends Component {
+    private renderInstance;
+    private actionInstance;
+    private data;
+    private cConf;
+    private parent;
+    private children;
+    private nestCurt;
+    private nestMax;
+    constructor(ctx: ContextApi, data: CommentData, conf: CommentConf);
+    /** 渲染 UI */
+    render(): void;
+    /** 获取评论操作实例对象 */
+    getActions(): CommentActions;
+    /** 获取评论渲染器实例对象 */
+    getRender(): Render;
+    /** 获取评论数据 */
+    getData(): CommentData;
+    /** 设置数据 */
+    setData(data: CommentData): void;
+    /** 获取父评论 */
+    getParent(): Comment_2 | null;
+    /** 获取所有子评论 */
+    getChildren(): Comment_2[];
+    /** 获取当前嵌套层数 */
+    getNestCurt(): number;
+    /** 判断是否为根评论 */
+    getIsRoot(): boolean;
+    /** 获取评论 ID */
+    getID(): number;
+    /** 置入子评论 */
+    putChild(childC: Comment_2, insertMode?: 'append' | 'prepend'): void;
+    /** 获取存放子评论的元素对象 */
+    getChildrenEl(): HTMLElement;
+    /** 获取所有父评论 */
+    getParents(): Comment_2[];
+    /** 获取评论元素对象 */
+    getEl(): HTMLElement;
+    /** 获取 Gravatar 头像 URL */
+    getGravatarURL(): string;
+    /** 获取评论 markdown 解析后的内容 */
+    getContentMarked(): string;
+    /** 获取格式化后的日期 */
+    getDateFormatted(): any;
+    /** 获取用户 UserAgent 信息 */
+    getUserUA(): {
+        browser: string;
+        os: string;
+    };
+    /** 获取配置 */
+    getConf(): CommentConf;
+}
+
+declare class CommentActions {
+    private comment;
+    private get ctx();
+    private get data();
+    private get cConf();
+    constructor(comment: Comment_2);
+    /** 投票操作 */
+    vote(type: 'up' | 'down'): void;
+    /** 管理员 - 评论状态修改 */
+    adminEdit(type: 'collapsed' | 'pending' | 'pinned', btnElem: ActionBtn): void;
+    /** 管理员 - 评论删除 */
+    adminDelete(btnElem: ActionBtn): void;
+    /** 快速跳转到该评论 */
+    goToReplyComment(): void;
+}
+
+/**
+ * 评论 API
+ */
+declare class CommentApi extends ApiBase {
+    /** 评论 · 获取 */
+    get(offset: number, pageSize: number, flatMode?: boolean, paramsEditor?: (params: any) => void): Promise<ListData>;
+    /** 评论 · 创建 */
+    add(comment: {
+        nick: string;
+        email: string;
+        link: string;
+        content: string;
+        rid: number;
+        page_key: string;
+        page_title?: string;
+        site_name?: string;
+    }): Promise<CommentData>;
+    /** 评论 · 修改 */
+    commentEdit(data: Partial<CommentData>): Promise<CommentData>;
+    /** 评论 · 删除 */
+    commentDel(commentID: number, siteName?: string): Promise<unknown>;
+    /** 投票 */
+    vote(targetID: number, type: string): Promise<{
+        up: number;
+        down: number;
+    }>;
+}
+
+declare interface CommentConf {
+    isUnread?: boolean;
+    openURL?: string;
+    isFlatMode: boolean;
+    replyTo?: CommentData;
+    afterRender?: () => void;
+    openEvt?: () => void;
+    onReplyBtnClick?: Function;
+    onDelete?: Function;
+}
+
+export declare 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;
+}
+
+declare type CommentNode = {
+    id: number;
+    comment: CommentData;
+    children: CommentNode[];
+    parent?: CommentNode;
+    level: number;
+};
+
+declare abstract class Component {
+    ctx: ContextApi;
+    $el: HTMLElement;
+    readonly conf: ArtalkConfig;
+    constructor(ctx: ContextApi);
+}
+
+/**
+ * Context 接口
+ *
+ * (面向接口的编程)
+ */
+export declare 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];
+    /** 配置对象 */
+    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;
+    /** 获取配置 */
+    getConf(): ArtalkConfig;
+    /** 获取挂载元素 */
+    getEl(): HTMLElement;
+    /** 更新配置 */
+    updateConf(conf: Partial<ArtalkConfig>): void;
+}
+
+export declare 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;
+}
+
+declare class Editor extends Component implements EditorApi {
+    private ui;
+    private state;
+    getUI(): EditorUI;
+    getPlugs(): PlugManager | undefined;
+    getState(): EditorState;
+    constructor(ctx: ContextApi);
+    getHeaderInputEls(): {
+        nick: HTMLInputElement;
+        email: HTMLInputElement;
+        link: HTMLInputElement;
+    };
+    getContentFinal(): string;
+    getContentRaw(): string;
+    getContentMarked(): string;
+    setContent(val: string): void;
+    insertContent(val: string): void;
+    focus(): void;
+    reset(): void;
+    resetState(): void;
+    setReply(comment: CommentData, $comment: HTMLElement): void;
+    setEditComment(comment: CommentData, $comment: HTMLElement): void;
+    showNotify(msg: string, type: any): void;
+    showLoading(): void;
+    hideLoading(): void;
+    submit(): void;
+}
+
+export declare 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;
+}
+
+declare interface EditorEventPayloadMap {
+    'mounted': undefined;
+    'unmounted': undefined;
+    'header-input': {
+        field: string;
+        $input: HTMLInputElement;
+    };
+    'header-change': {
+        field: string;
+        $input: HTMLInputElement;
+    };
+    'content-updated': string;
+    'panel-show': EditorPlug;
+    'panel-hide': EditorPlug;
+    'panel-close': undefined;
+    'editor-close': undefined;
+    'editor-open': undefined;
+}
+
+/**
+ * Editor 插件
+ */
+declare interface EditorPlug {
+    $btn?: HTMLElement;
+    $panel?: HTMLElement;
+    contentTransformer?(rawContent: string): string;
+    editorStateEffectWhen?: EditorState;
+    editorStateEffect?(comment: CommentData): () => void;
+}
+
+declare class EditorPlug {
+    protected kit: PlugKit;
+    constructor(kit: PlugKit);
+    /** Use plug btn will add a btn on the bottom of editor */
+    useBtn(html?: string): HTMLElement;
+    /** Use plug panel will show the panel when btn is clicked */
+    usePanel(html?: string): HTMLElement;
+    /** Use the content transformer to handle the content of the last submit by the editor */
+    useContentTransformer(func: (raw: string) => string): void;
+    /** Listen the event of panel show */
+    usePanelShow(func: () => void): void;
+    /** Listen the event of panel hide */
+    usePanelHide(func: () => void): void;
+    /** Use editor state modifier */
+    useEditorStateEffect(stateName: EditorState, effectFn: (comment: CommentData) => () => void): void;
+}
+
+export declare type EditorState = 'reply' | 'edit' | 'normal';
+
+declare interface EditorUI extends Record<keyof typeof Sel, HTMLElement> {
+    $el: HTMLElement;
+    $nick: HTMLInputElement;
+    $email: HTMLInputElement;
+    $link: HTMLInputElement;
+    $textarea: HTMLTextAreaElement;
+    $submitBtn: HTMLButtonElement;
+    $sendReply?: HTMLElement;
+    $editCancelBtn?: HTMLElement;
+}
+
+export declare type EmoticonGrpData = {
+    name: string;
+    type: 'emoticon' | 'image' | 'emoji';
+    items: {
+        key: string;
+        val: string;
+    }[];
+};
+
+export declare type EmoticonListData = EmoticonGrpData[];
+
+declare const en: {
+    placeholder: string;
+    noComment: string;
+    send: string;
+    save: string;
+    nick: string;
+    email: string;
+    link: string;
+    emoticon: string;
+    preview: string;
+    image: string;
+    uploadFail: string;
+    commentFail: string;
+    restoredMsg: string;
+    onlyAdminCanReply: string;
+    uploadLoginMsg: string;
+    counter: string;
+    sortLatest: string;
+    sortOldest: string;
+    sortBest: string;
+    sortAuthor: string;
+    openComment: string;
+    closeComment: string;
+    listLoadFailMsg: string;
+    listRetry: string;
+    loadMore: string;
+    admin: string;
+    reply: string;
+    voteUp: string;
+    voteDown: string;
+    voteFail: string;
+    readMore: string;
+    actionConfirm: string;
+    collapse: string;
+    collapsed: string;
+    collapsedMsg: string;
+    expand: string;
+    approved: string;
+    pending: string;
+    pendingMsg: string;
+    edit: string;
+    editCancel: string;
+    delete: string;
+    deleteConfirm: string;
+    pin: string;
+    unpin: string;
+    seconds: string;
+    minutes: string;
+    hours: string;
+    days: string;
+    now: string;
+    adminCheck: string;
+    captchaCheck: string;
+    confirm: string;
+    cancel: string;
+    msgCenter: string;
+    ctrlCenter: string;
+    frontend: string;
+    backend: string;
+    loading: string;
+    loadFail: string;
+    editing: string;
+    editFail: string;
+    deleting: string;
+    deleteFail: string;
+    reqGot: string;
+    reqAborted: string;
+    updateMsg: string;
+    currentVersion: string;
+    ignore: string;
+    open: string;
+};
+
+declare interface ErrorData {
+    msg: string;
+    data?: any;
+}
+
+declare type EventHandler<T> = (payload: T) => void;
+
+declare class EventManager<PayloadMap> implements EventManagerFuncs<PayloadMap> {
+    private events;
+    /**
+     * Add an event listener for a specific event name
+     */
+    on<K extends keyof PayloadMap>(name: K, handler: EventHandler<PayloadMap[K]>, opts?: EventOptions): void;
+    /**
+     * Remove an event listener for a specific event name and handler
+     */
+    off<K extends keyof PayloadMap>(name: K, handler: EventHandler<PayloadMap[K]>): void;
+    /**
+     * Trigger an event with an optional payload
+     */
+    trigger<K extends keyof PayloadMap>(name: K, payload?: PayloadMap[K]): void;
+}
+
+declare interface EventManagerFuncs<PayloadMap> {
+    on<K extends keyof PayloadMap>(name: K, handler: EventHandler<PayloadMap[K]>, opts?: EventOptions): void;
+    off<K extends keyof PayloadMap>(name: K, handler: EventHandler<PayloadMap[K]>): void;
+    trigger<K extends keyof PayloadMap>(name: K, payload?: PayloadMap[K]): void;
+}
+
+declare interface EventOptions {
+    once?: boolean;
+}
+
+/** EventName to EventPayload Type */
+export declare interface EventPayloadMap {
+    'inited': undefined;
+    'destroy': undefined;
+    'conf-fetch': undefined;
+    'list-fetch': Partial<ListFetchParams>;
+    'list-fetched': ListFetchedArgs;
+    'list-load': CommentData[];
+    '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_2;
+    'unreads-updated': NotifyData[];
+    'list-goto': number;
+    'page-loaded': PageData;
+    'editor-submit': undefined;
+    'editor-submitted': undefined;
+    'user-changed': LocalUser;
+    'conf-loaded': ArtalkConfig;
+    'dark-mode-changed': boolean | 'auto';
+    'sidebar-show': undefined;
+    'sidebar-hide': undefined;
+}
+
+export declare type I18n = typeof en;
+
+export declare type I18nKeys = keyof I18n;
+
+export declare const init: typeof Artalk.init;
+
+declare class Layer {
+    private $el;
+    private wrap;
+    private onAfterHide?;
+    constructor(wrap: LayerWrap, name: string, el?: HTMLElement);
+    setOnAfterHide(func: () => void): void;
+    getEl(): HTMLElement;
+    show(): void;
+    hide(): void;
+    destroy(): void;
+}
+
+declare class LayerManager {
+    private wrap;
+    private ctx;
+    constructor(ctx: ContextApi);
+    getEl(): HTMLElement;
+    create(name: string, el?: HTMLElement | undefined): Layer;
+}
+
+declare class LayerWrap {
+    private $wrap;
+    private $mask;
+    private allowMaskClose;
+    private items;
+    constructor();
+    createItem(name: string, el?: HTMLElement): HTMLElement;
+    getWrap(): HTMLElement;
+    getMask(): HTMLElement;
+    setMaskClose(enabled: boolean): void;
+    show(): void;
+    hide(callback?: () => void): void;
+}
+
+declare interface LayoutOptions {
+    $commentsWrap: HTMLElement;
+    nestSortBy: ListNest.SortByType;
+    nestMax: number;
+    flatMode: boolean;
+    createCommentNode(comment: CommentData, ctxComments: CommentData[]): Comment_2;
+    findCommentNode(id: number): Comment_2 | undefined;
+    getCommentDataList(): CommentData[];
+}
+
+declare class List extends Component {
+    /** 列表评论集区域元素 */
+    $commentsWrap: HTMLElement;
+    getCommentsWrapEl(): HTMLElement;
+    protected commentNodes: Comment_2[];
+    getCommentNodes(): Comment_2[];
+    constructor(ctx: ContextApi);
+    getListLayout(): ListLayout;
+    private initCrudEvents;
+}
+
+export declare 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;
+}
+
+declare interface ListFetchedArgs {
+    params: Partial<ListFetchParams>;
+    data?: ListData;
+    error?: ErrorData;
+}
+
+export declare interface ListFetchParams {
+    offset: number;
+    limit: number;
+    flatMode: boolean;
+    paramsModifier?: (p: any) => void;
+    onSuccess?: (data: ListData) => void;
+    onError?: (err: any) => void;
+}
+
+export declare interface ListLastFetchData {
+    params: ListFetchParams;
+    data?: ListData;
+}
+
+declare class ListLayout {
+    private options;
+    constructor(options: LayoutOptions);
+    import(comments: CommentData[]): void;
+    insert(comment: CommentData): void;
+    private importCommentsNestMode;
+    /** 导入评论 · 平铺模式 */
+    private putCommentFlatMode;
+    private insertCommentNest;
+    private insertCommentFlatMode;
+}
+
+declare namespace ListNest {
+    export {
+        makeNestCommentNodeList,
+        CommentNode,
+        SortByType
+    }
+}
+
+export declare const loadCountWidget: typeof Artalk.loadCountWidget;
+
+/**
+ * 本地持久化用户数据
+ * @note 始终保持一层结构，不支持多层结构
+ */
+export declare interface LocalUser {
+    /** 昵称 */
+    nick: string;
+    /** 邮箱 */
+    email: string;
+    /** 链接 */
+    link: string;
+    /** TOKEN */
+    token: string;
+    /** 是否为管理员 */
+    isAdmin: boolean;
+}
+
+declare function makeNestCommentNodeList(srcData: CommentData[], sortBy?: SortByType, nestMax?: number): CommentNode[];
+
+export declare interface NotifyData {
+    /** 通知 ID */
+    id: number;
+    /** 用户 ID */
+    user_id: number;
+    /** 评论 ID */
+    comment_id: number;
+    /** 是否已读 */
+    is_read: boolean;
+    /** 是否已发送邮件通知 */
+    is_emailed: boolean;
+    /** 标为已读地址 */
+    read_link: string;
+}
+
+export declare type NotifyLevel = "i" | "s" | "w" | "e";
+
+/**
+ * 页面 API
+ */
+declare class PageApi extends ApiBase {
+    /** 页面 · 获取 */
+    pageGet(siteName?: string, offset?: number, limit?: number): Promise<{
+        pages: PageData[];
+        total: number;
+    }>;
+    /** 页面 · 修改 */
+    pageEdit(data: PageData): Promise<PageData>;
+    /** 页面 · 删除 */
+    pageDel(pageKey: string, siteName?: string): Promise<unknown>;
+    /** 页面 · 数据更新 */
+    pageFetch(id?: number, siteName?: string, getStatus?: boolean): Promise<any>;
+    /** PV */
+    pv(): Promise<number>;
+    /** 统计 */
+    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): Promise<number | object | CommentData[] | PageData[]>;
+}
+
+export declare interface PageData {
+    /** 页面 ID */
+    id: number;
+    /** 页面唯一标识符 */
+    key: string;
+    /** 页面标题 */
+    title: string;
+    /** 页面 url */
+    url: string;
+    /** 仅管理员可评 */
+    admin_only: boolean;
+    /** 站点名（用于隔离） */
+    site_name: string;
+    /** 赞同数 */
+    vote_up: number;
+    /** 反对数 */
+    vote_down: number;
+}
+
+/**
+ * PlugKit provides a set of methods to help you develop editor plug
+ */
+declare class PlugKit {
+    private plugs;
+    constructor(plugs: PlugManager);
+    /** Use the editor */
+    useEditor(): EditorApi;
+    /**
+     * Use the context of global
+     *
+     * @deprecated The calls to this function should be reduced as much as possible
+     */
+    useGlobalCtx(): ContextApi;
+    /** Use the config of Artalk */
+    useConf(): ArtalkConfig;
+    /** Use the http api client */
+    useApi(): Api;
+    /** Use the user manager */
+    useUser(): User;
+    /** Use the ui of editor */
+    useUI(): EditorUI;
+    /** Use the events in editor scope */
+    useEvents(): EventManager<EditorEventPayloadMap>;
+    /** Listen the event when plug is mounted */
+    useMounted(func: () => void): void;
+    /** Listen the event when plug is unmounted */
+    useUnmounted(func: () => void): void;
+    /** Use the deps of other plug */
+    useDeps<T extends typeof EditorPlug>(plug: T): InstanceType<T> | undefined;
+}
+
+declare class PlugManager {
+    editor: EditorApi;
+    private plugs;
+    private openedPlug;
+    private events;
+    getPlugs(): EditorPlug[];
+    getEvents(): EventManager<EditorEventPayloadMap>;
+    private clear;
+    constructor(editor: EditorApi);
+    private loadPluginUI;
+    /** Load the plug btn and plug panel on editor ui */
+    private loadPluginItem;
+    get<T extends typeof EditorPlug>(plug: T): InstanceType<T> | undefined;
+    /** Open the editor plug panel */
+    openPlugPanel(plug: EditorPlug): void;
+    /** Close the editor plug panel */
+    closePlugPanel(): void;
+    /** Get the content which is transformed by plugs */
+    getTransformedContent(rawContent: string): string;
+}
+
+declare class Render {
+    comment: Comment_2;
+    get ctx(): ContextApi;
+    get data(): CommentData;
+    get conf(): ArtalkConfig;
+    get cConf(): CommentConf;
+    $el: HTMLElement;
+    $main: HTMLElement;
+    $header: HTMLElement;
+    $headerNick: HTMLElement;
+    $headerBadgeWrap: HTMLElement;
+    $body: HTMLElement;
+    $content: HTMLElement;
+    $childrenWrap: HTMLElement | null;
+    $actions: HTMLElement;
+    voteBtnUp?: ActionBtn;
+    voteBtnDown?: ActionBtn;
+    $replyTo?: HTMLElement;
+    $replyAt?: HTMLElement;
+    constructor(comment: Comment_2);
+    render(): HTMLElement;
+    /** 内容限高检测 */
+    checkHeightLimit(): void;
+    /** 子评论区域移除限高 */
+    heightLimitRemoveForChildren(): void;
+    /** 渐出动画 */
+    playFadeAnim(): void;
+    /** 渐出动画 · 评论内容区域 */
+    playFadeAnimForBody(): void;
+    /** 获取子评论 Wrap */
+    getChildrenWrap(): HTMLElement | null;
+    /** 初始化子评论区域 Wrap */
+    renderChildrenWrap(): HTMLElement;
+    /** 恢复原有的子评论区域 Wrap */
+    recoveryChildrenWrap(): void;
+    /** 设置已读 */
+    setUnread(val: boolean): void;
+    /** 设置为可点击的评论 */
+    setOpenable(val: boolean): void;
+    /** 设置点击评论打开置顶 URL */
+    setOpenURL(url: string): void;
+    /** 设置点击评论时的操作 */
+    setOpenAction(action: () => void): void;
+}
+
+declare const Sel: {
+    $header: string;
+    $nick: string;
+    $email: string;
+    $link: string;
+    $textareaWrap: string;
+    $textarea: string;
+    $bottom: string;
+    $submitBtn: string;
+    $notifyWrap: string;
+    $plugBtnWrap: string;
+    $plugPanelWrap: string;
+};
+
+/**
+ * Services
+ *
+ * @description Call these services by `ctx.get('serviceName')` or `ctx.serviceName`
+ */
+declare const services: {
+    i18n(ctx: ContextApi): void;
+    user(ctx: ContextApi): User;
+    layerManager(ctx: ContextApi): LayerManager;
+    checkerLauncher(ctx: ContextApi): CheckerLauncher;
+    editor(ctx: ContextApi): Editor;
+    list(ctx: ContextApi): List;
+    sidebarLayer(ctx: ContextApi): SidebarLayer;
+    editorPlugs(): PlugManager | undefined;
+};
+
+declare class SidebarLayer extends Component {
+    layer?: Layer;
+    $header: HTMLElement;
+    $closeBtn: HTMLElement;
+    $iframeWrap: HTMLElement;
+    $iframe?: HTMLIFrameElement;
+    constructor(ctx: ContextApi);
+    private firstShow;
+    /** 显示 */
+    show(conf?: SidebarShowPayload): Promise<void>;
+    /** 隐藏 */
+    hide(): void;
+    private authCheck;
+    private initLayer;
+    private createIframe;
+    private iframeLoad;
+}
+
+export declare interface SidebarShowPayload {
+    view?: 'comments' | 'sites' | 'pages' | 'transfer';
+}
+
+/**
+ * 站点 API
+ */
+declare class SiteApi extends ApiBase {
+    /** 站点 · 获取 */
+    siteGet(): Promise<SiteData[]>;
+    /** 站点 · 创建 */
+    siteAdd(name: string, urls: string): Promise<SiteData>;
+    /** 站点 · 修改 */
+    siteEdit(data: SiteData): Promise<SiteData>;
+    /** 站点 · 删除 */
+    siteDel(id: number, delContent?: boolean): Promise<unknown>;
+    /** 导出 */
+    export(): Promise<any>;
+}
+
+export declare interface SiteData {
+    /** 站点 ID */
+    id: number;
+    /** 站点名 */
+    name: string;
+    /** 站点 URLs */
+    urls: string[];
+    /** 站点 URLs（原始字符串） */
+    urls_raw: string;
+    /** 站点主 URL */
+    first_url: string;
+}
+
+declare type SortByType = 'DATE_DESC' | 'DATE_ASC' | 'SRC_INDEX' | 'VOTE_UP_DESC';
+
+/**
+ * 系统 API
+ */
+declare class SystemApi extends ApiBase {
+    /** 获取配置 */
+    conf(): Promise<SystemConfResp>;
+    /** 获取配置数据 */
+    getSettings(): Promise<{
+        custom: string;
+        template: string;
+    }>;
+    /** 保存配置数据 */
+    saveSettings(yamlStr: string): Promise<boolean>;
+    /** 获取 API 版本信息 */
+    version(): Promise<{
+        app: string;
+        version: string;
+        commit_hash: string;
+        fe_min_version: string;
+    }>;
+}
+
+declare interface SystemConfResp {
+    frontend_conf: Partial<ArtalkConfig>;
+    version: ApiVersionInfo;
+}
+
+declare type TC = typeof ApiComponents;
+
+declare type TInjectedServices = {
+    [K in keyof TServiceInjectors]: ReturnType<TServiceInjectors[K]>;
+};
+
+declare type TKeysOnlyReturn<T extends TObjectWithFuncs, V> = {
+    [K in keyof T]: ReturnType<T[K]> extends V ? K : never;
+}[keyof T];
+
+declare type TMarked = typeof marked;
+
+declare type TObjectWithFuncs = {
+    [k: string]: (...args: any) => any;
+};
+
+declare type TOmitConditions = TKeysOnlyReturn<TServiceImps, void>;
+
+declare type TServiceImps = typeof services;
+
+declare type TServiceInjectors = Omit<TServiceImps, TOmitConditions>;
+
+/**
+ * 上传 API
+ */
+declare class UploadApi extends ApiBase {
+    /** 图片上传 */
+    imgUpload(file: File): Promise<{
+        img_file: string;
+        img_url: string;
+    }>;
+}
+
+export declare const use: typeof Artalk.use;
+
+declare class User {
+    private opts;
+    private data;
+    constructor(opts: UserOpts);
+    getData(): LocalUser;
+    /** 保存用户到 localStorage 中 */
+    update(obj?: Partial<LocalUser>): void;
+    /**
+     * Logout
+     *
+     * @description Logout will clear login status, but not clear user data (nick, email, link)
+     */
+    logout(): void;
+    /** 是否已填写基本用户信息 */
+    checkHasBasicUserInfo(): boolean;
+}
+
+/**
+ * 用户 API
+ */
+declare class UserApi extends ApiBase {
+    /** 用户 · 登录 */
+    login(name: string, email: string, password: string): Promise<{
+        token: string;
+        user: UserData;
+    }>;
+    /** 用户 · 获取  */
+    userGet(name: string, email: string): {
+        req: Promise<{
+            user: UserData | null;
+            is_login: boolean;
+            unread: NotifyData[];
+            unread_count: any;
+        }>;
+        abort: () => void;
+    };
+    /** 用户 · 登录状态 */
+    loginStatus(): Promise<{
+        is_login: boolean;
+        is_admin: boolean;
+    }>;
+    /** 用户 · 注销 */
+    logout(): Promise<unknown>;
+    /** 已读标记 */
+    markRead(commentID: number, notifyKey: string, readAll?: boolean): Promise<unknown>;
+    /** 用户 · 列表 */
+    userList(offset?: number, limit?: number, type?: 'all' | 'admin' | 'in_conf'): Promise<{
+        users: UserDataForAdmin[];
+        total: number;
+    }>;
+    /** 用户 · 新增 */
+    userAdd(user: Partial<UserDataForAdmin>, password?: string): Promise<UserDataForAdmin>;
+    /** 用户 · 修改 */
+    userEdit(user: Partial<UserDataForAdmin>, password?: string): Promise<UserDataForAdmin>;
+    /** 用户 · 删除 */
+    userDel(userID: number): Promise<unknown>;
+}
+
+export declare 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 declare interface UserDataForAdmin extends UserData {
+    /** 最后一次操作 IP */
+    last_ip: string;
+    /** 最后一次操作 UA */
+    last_ua: string;
+    /** 是否存在于配置文件中 */
+    is_in_conf: boolean;
+    /** 评论数 */
+    comment_count: number;
+    /** 密码 */
+    password: string;
+}
+
+declare interface UserOpts {
+    onUserChanged?: (user: LocalUser) => void;
+}
+
+export { }