artalk 2.3.4 → 2.4.1

package/dist/src/api/admin.d.ts

@@ -0,0 +1,10 @@
+import ApiBase from './api-base';
+/**
+ * 管理员 API
+ */
+export default class AdminApi extends ApiBase {
+    /** 缓存清除 */
+    cacheFlushAll(): Promise<unknown>;
+    /** 缓存预热 */
+    cacheWarmUp(): Promise<unknown>;
+}

package/dist/src/api/api-base.d.ts

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

package/dist/src/api/captcha.d.ts

@@ -0,0 +1,14 @@
+import ApiBase from './api-base';
+/**
+ * 验证码 API
+ */
+export default class CaptchaApi extends ApiBase {
+    /** 验证码 · 获取 */
+    captchaGet(): Promise<string>;
+    /** 验证码 · 检验 */
+    captchaCheck(value: string): Promise<string>;
+    /** 验证码 · 状态 */
+    captchaStatus(): Promise<{
+        is_pass: boolean;
+    }>;
+}

package/dist/src/api/comment.d.ts

@@ -0,0 +1,29 @@
+import { CommentData, ListData } from '../../types/artalk-data';
+import ApiBase from './api-base';
+/**
+ * 评论 API
+ */
+export default 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;
+    }>;
+}

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

@@ -0,0 +1,31 @@
+import Context from '../../types/context';
+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';
+declare const ApiComponents: {
+    comment: typeof comment;
+    page: typeof page;
+    site: typeof site;
+    user: typeof user;
+    system: typeof system;
+    captcha: typeof captcha;
+    admin: typeof admin;
+    upload: typeof upload;
+};
+declare class Api {
+    protected ctx: Context;
+    baseURL: string;
+    constructor(ctx: Context);
+}
+declare type TC = typeof ApiComponents;
+declare type AC = {
+    [K in keyof TC]: InstanceType<TC[K]>;
+};
+interface Api extends AC {
+}
+export default Api;

package/dist/src/api/page.d.ts

@@ -0,0 +1,22 @@
+import { PageData, CommentData } from '../../types/artalk-data';
+import ApiBase from './api-base';
+/**
+ * 页面 API
+ */
+export default 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[]>;
+}

package/dist/src/api/request.d.ts

@@ -0,0 +1,12 @@
+import Context from '../../types/context';
+/** 公共请求函数 */
+export declare function Fetch(ctx: Context, input: RequestInfo, init: RequestInit, timeout?: number): Promise<any>;
+/** 公共 POST 请求 */
+export declare function POST<T>(ctx: Context, url: string, data?: {
+    [key: string]: any;
+}): Promise<T>;
+/** 公共 GET 请求 (无 GET 方式 API) */
+/** 对象转 FormData */
+export declare function ToFormData(object: {
+    [key: string]: any;
+}): FormData;

package/dist/src/api/site.d.ts

@@ -0,0 +1,17 @@
+import { SiteData } from '../../types/artalk-data';
+import ApiBase from './api-base';
+/**
+ * 站点 API
+ */
+export default 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>;
+}

package/dist/src/api/system.d.ts

@@ -0,0 +1,13 @@
+import ArtalkConfig from '../../types/artalk-config';
+import ApiBase from './api-base';
+/**
+ * 系统 API
+ */
+export default class SystemApi extends ApiBase {
+    /** 获取配置 */
+    conf(): Promise<ArtalkConfig>;
+    /** 获取配置数据 */
+    getSettings(): Promise<string>;
+    /** 保存配置数据 */
+    saveSettings(yamlStr: string): Promise<boolean>;
+}

package/dist/src/api/upload.d.ts

@@ -0,0 +1,11 @@
+import ApiBase from './api-base';
+/**
+ * 上传 API
+ */
+export default class UploadApi extends ApiBase {
+    /** 图片上传 */
+    imgUpload(file: File): Promise<{
+        img_file: string;
+        img_url: string;
+    }>;
+}

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

@@ -0,0 +1,28 @@
+import { UserData, NotifyData } from '../../types/artalk-data';
+import ApiBase from './api-base';
+/**
+ * 用户 API
+ */
+export default class UserApi extends ApiBase {
+    /** 用户 · 登录 */
+    login(name: string, email: string, password: string): Promise<string>;
+    /** 用户 · 获取  */
+    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(notifyKey: string, readAll?: boolean): Promise<unknown>;
+}

package/dist/src/artalk.d.ts

@@ -0,0 +1,58 @@
+import ArtalkConfig from '../types/artalk-config';
+import { EventPayloadMap, Handler } from '../types/event';
+import ArtalkPlug from '../types/plug';
+import Context from '../types/context';
+import ListLite from './list/list-lite';
+/**
+ * Artalk
+ *
+ * @website https://artalk.js.org
+ */
+export default class Artalk {
+    static ListLite: typeof ListLite;
+    static readonly defaults: ArtalkConfig;
+    conf: ArtalkConfig;
+    ctx: Context;
+    $root: HTMLElement;
+    /** Plugins (in global scope)  */
+    protected static Plugins: ArtalkPlug[];
+    /** Plugins (in a instance scope) */
+    protected instancePlugins: ArtalkPlug[];
+    /** 禁用的组件 */
+    static DisabledComponents: string[];
+    constructor(customConf: Partial<ArtalkConfig>);
+    /** 组件初始化 */
+    private initComponents;
+    /** 基本配置初始化 */
+    static HandelBaseConf(customConf: Partial<ArtalkConfig>): ArtalkConfig;
+    /** 初始化组件根据远程加载的配置 */
+    private loadConfRemoteAndInitComponents;
+    /** 远程加载配置 */
+    private loadConfRemote;
+    /** 事件绑定初始化 */
+    private initEventBind;
+    /** 语言初始化 */
+    private initLocale;
+    /** Layer 初始化 */
+    private initLayer;
+    /** 暗黑模式初始化 */
+    private initDarkMode;
+    /** 监听事件 */
+    on<K extends keyof EventPayloadMap>(name: K, handler: Handler<EventPayloadMap[K]>): void;
+    /** 解除监听事件 */
+    off<K extends keyof EventPayloadMap>(name: K, handler: Handler<EventPayloadMap[K]>): void;
+    /** 触发事件 */
+    trigger<K extends keyof EventPayloadMap>(name: K, payload?: EventPayloadMap[K]): void;
+    /** 重新加载 */
+    reload(): void;
+    /** 设置暗黑模式 */
+    setDarkMode(darkMode: boolean): void;
+    /** Use Plugin (specific instance) */
+    use(plugin: ArtalkPlug): void;
+    /** Use Plugin (static method for global scope) */
+    static use(plugin: ArtalkPlug): void;
+    /** @deprecated Please replace it with lowercase function name `use(...)`. */
+    static Use(plugin: ArtalkPlug): void;
+    /** 装载数量统计元素 */
+    static LoadCountWidget(customConf: Partial<ArtalkConfig>): void;
+}

package/dist/src/comment/actions.d.ts

@@ -0,0 +1,17 @@
+import Comment from './comment';
+import ActionBtn from '../components/action-btn';
+export default class CommentActions {
+    private comment;
+    private get ctx();
+    private get data();
+    private get cConf();
+    constructor(comment: Comment);
+    /** 投票操作 */
+    vote(type: 'up' | 'down'): void;
+    /** 管理员 - 评论状态修改 */
+    adminEdit(type: 'collapsed' | 'pending' | 'pinned', btnElem: ActionBtn): void;
+    /** 管理员 - 评论删除 */
+    adminDelete(btnElem: ActionBtn): void;
+    /** 快速跳转到该评论 */
+    goToReplyComment(): void;
+}

package/dist/src/comment/comment.d.ts

@@ -0,0 +1,67 @@
+import { CommentData } from '../../types/artalk-data';
+import Context from '../../types/context';
+import Component from '../lib/component';
+import CommentRender from './render';
+import CommentActions from './actions';
+export interface CommentConf {
+    isUnread?: boolean;
+    openURL?: string;
+    isFlatMode: boolean;
+    replyTo?: CommentData;
+    afterRender?: () => void;
+    openEvt?: () => void;
+    onReplyBtnClick?: Function;
+    onDelete?: Function;
+}
+export default class Comment extends Component {
+    private renderInstance;
+    private actionInstance;
+    private data;
+    private cConf;
+    private parent;
+    private children;
+    private nestCurt;
+    private nestMax;
+    constructor(ctx: Context, data: CommentData, conf: CommentConf);
+    /** 渲染 UI */
+    render(): void;
+    /** 获取评论操作实例对象 */
+    getActions(): CommentActions;
+    /** 获取评论渲染器实例对象 */
+    getRender(): CommentRender;
+    /** 获取评论数据 */
+    getData(): CommentData;
+    /** 设置数据 */
+    setData(data: CommentData): void;
+    /** 获取父评论 */
+    getParent(): Comment | null;
+    /** 获取所有子评论 */
+    getChildren(): Comment[];
+    /** 获取当前嵌套层数 */
+    getNestCurt(): number;
+    /** 判断是否为根评论 */
+    getIsRoot(): boolean;
+    /** 获取评论 ID */
+    getID(): number;
+    /** 置入子评论 */
+    putChild(childC: Comment, insertMode?: 'append' | 'prepend'): void;
+    /** 获取存放子评论的元素对象 */
+    getChildrenEl(): HTMLElement;
+    /** 获取所有父评论 */
+    getParents(): Comment[];
+    /** 获取评论元素对象 */
+    getEl(): HTMLElement;
+    /** 获取 Gravatar 头像 URL */
+    getGravatarURL(): string;
+    /** 获取评论 markdown 解析后的内容 */
+    getContentMarked(): string;
+    /** 获取格式化后的日期 */
+    getDateFormatted(): string;
+    /** 获取用户 UserAgent 信息 */
+    getUserUA(): {
+        browser: string;
+        os: string;
+    };
+    /** 获取配置 */
+    getConf(): CommentConf;
+}

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

@@ -0,0 +1,2 @@
+import Comment from './comment';
+export default Comment;

package/dist/src/comment/render.d.ts

@@ -0,0 +1,76 @@
+import ActionBtn from '../components/action-btn';
+import Comment from './comment';
+export default class CommentRender {
+    private comment;
+    private get ctx();
+    private get data();
+    private get cConf();
+    $el: HTMLElement;
+    $main: HTMLElement;
+    $header: HTMLElement;
+    $headerNick: HTMLElement;
+    $headerBadgeWrap: HTMLElement;
+    $body: HTMLElement;
+    $content: HTMLElement;
+    private $childrenWrap;
+    $actions: HTMLElement;
+    voteBtnUp?: ActionBtn;
+    voteBtnDown?: ActionBtn;
+    $replyTo?: HTMLElement;
+    $replyAt?: HTMLElement;
+    constructor(comment: Comment);
+    render(): HTMLElement;
+    /** 初始化 - 评论头像 */
+    private renderAvatar;
+    /** 初始化 - 评论信息 */
+    private renderHeader;
+    private renderHeader_Nick;
+    private renderHeader_VerifyBadge;
+    private renderHeader_Date;
+    private renderHeader_UABadge;
+    /** 初始化 - 评论内容 */
+    private renderContent;
+    /** 初始化 - 层级嵌套模式显示 At */
+    private renderReplyAt;
+    /** 初始化 - 回复的对象 */
+    private renderReplyTo;
+    /** 初始化 - 待审核状态 */
+    private renderPending;
+    /** 初始化 - 评论操作按钮 */
+    private renderActions;
+    private renderActions_Vote;
+    private renderActions_Reply;
+    private renderActions_Collapse;
+    private renderActions_Moderator;
+    private renderActions_Pin;
+    private renderActions_Edit;
+    private renderActions_Del;
+    /** 内容限高检测 */
+    checkHeightLimit(): void;
+    /** 目标内容限高检测 */
+    checkHeightLimitArea(area: 'children' | 'content'): void;
+    /** 移除限高 */
+    private heightLimitRemove;
+    /** 子评论区域移除限高 */
+    heightLimitRemoveForChildren(): void;
+    /** 内容限高区域新增 */
+    private heightLimitAdd;
+    /** 渐出动画 */
+    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;
+}

package/dist/src/components/action-btn.d.ts

@@ -0,0 +1,52 @@
+import Context from '../../types/context';
+interface ActionBtnConf {
+    /** 按钮文字 (动态/静态) */
+    text: (() => string) | string;
+    /** 仅管理员可用 */
+    adminOnly?: boolean;
+    /** 确认操作 */
+    confirm?: boolean;
+    /** 确认时提示文字 */
+    confirmText?: string;
+}
+/**
+ * 通用操作按钮
+ */
+export default class ActionBtn {
+    private ctx;
+    private conf;
+    $el: HTMLElement;
+    isLoading: boolean;
+    msgRecTimer?: number;
+    msgRecTimerFunc?: Function;
+    get isMessaging(): boolean;
+    isConfirming: boolean;
+    confirmRecTimer?: number;
+    /** 构造函数 */
+    constructor(ctx: Context, conf: ActionBtnConf | 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;
+}
+export {};

package/dist/src/components/dialog.d.ts

@@ -0,0 +1,18 @@
+import Context from '../../types/context';
+declare type BtnClickHandler = (btnEl: HTMLElement, dialog: Dialog) => boolean | void;
+/**
+ * 对话框
+ */
+export default class Dialog {
+    ctx: Context;
+    $el: HTMLElement;
+    $content: HTMLElement;
+    $actions: HTMLElement;
+    constructor(ctx: Context, contentEl: HTMLElement);
+    /** 按钮 · 确定 */
+    setYes(handler: BtnClickHandler): this;
+    /** 按钮 · 取消 */
+    setNo(handler: BtnClickHandler): this;
+    private onBtnClick;
+}
+export {};

package/dist/src/components/pagination.d.ts

@@ -0,0 +1,30 @@
+export interface PaginationConf {
+    /** 每页条数 */
+    pageSize: number;
+    /** 回调函数 */
+    onChange: (offset: number) => void;
+}
+export default class Pagination {
+    private conf;
+    total: number;
+    $el: HTMLElement;
+    $input: HTMLInputElement;
+    inputTimer?: number;
+    $prevBtn: HTMLElement;
+    $nextBtn: HTMLElement;
+    page: number;
+    get pageSize(): number;
+    get offset(): number;
+    get maxPage(): number;
+    constructor(total: number, conf: PaginationConf);
+    update(offset: number, total: number): void;
+    setInput(page: number): void;
+    input(now?: boolean): void;
+    prev(): void;
+    next(): void;
+    change(page: number): void;
+    checkDisabled(): void;
+    keydown(e: KeyboardEvent): void;
+    /** 加载 */
+    setLoading(isLoading: boolean): void;
+}

package/dist/src/components/read-more-btn.d.ts

@@ -0,0 +1,33 @@
+export interface ReadMoreBtnConf {
+    /** 回调函数 */
+    onClick: (offset: number) => void;
+    pageSize: number;
+    text?: string;
+}
+/**
+ * 阅读更多按钮
+ */
+export default class ReadMoreBtn {
+    conf: ReadMoreBtnConf;
+    $el: HTMLElement;
+    private $loading;
+    private $text;
+    private offset;
+    private total;
+    private origText;
+    /** 是否有更多内容 */
+    get hasMore(): boolean;
+    constructor(conf: ReadMoreBtnConf);
+    click(): void;
+    /** 显示 */
+    show(): void;
+    /** 隐藏 */
+    hide(): void;
+    /** 加载 */
+    setLoading(isLoading: boolean): void;
+    /** 错误提示 */
+    showErr(errMsg: string): void;
+    /** 更新数据 */
+    update(offset: number, total: number): void;
+    checkDisabled(): void;
+}

package/dist/src/context.d.ts

@@ -0,0 +1,72 @@
+import { marked as libMarked } from 'marked';
+import ArtalkConfig from '../types/artalk-config';
+import { CommentData, NotifyData } from '../types/artalk-data';
+import { I18n } from './i18n';
+import User from './lib/user';
+import ContextApi from '../types/context';
+import Editor from './editor';
+import Comment from './comment';
+import ListLite from './list/list-lite';
+import SidebarLayer, { SidebarShowPayload } from './layer/sidebar-layer';
+import CheckerLauncher, { CheckerCaptchaPayload, CheckerPayload } from './lib/checker';
+import Api from './api';
+/**
+ * Artalk Context
+ */
+export default class Context implements ContextApi {
+    private api;
+    private editor;
+    private list?;
+    private sidebarLayer;
+    private checkerLauncher;
+    cid: number;
+    conf: ArtalkConfig;
+    user: User;
+    $root: HTMLElement;
+    markedInstance?: typeof libMarked;
+    markedReplacers: ((raw: string) => string)[];
+    private commentList;
+    private eventList;
+    constructor(conf: ArtalkConfig, $root?: HTMLElement);
+    setApi(api: Api): void;
+    setEditor(editor: Editor): void;
+    setList(list: ListLite): void;
+    setSidebarLayer(sidebarLayer: SidebarLayer): void;
+    setCheckerLauncher(checkerLauncher: CheckerLauncher): void;
+    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;
+    listRefreshUI(): void;
+    listHashGotoCheck(): void;
+    editorOpen(): void;
+    editorClose(): void;
+    editorShowLoading(): void;
+    editorHideLoading(): void;
+    editorShowNotify(msg: any, type: any): void;
+    editorTravel($el: HTMLElement): void;
+    editorTravelBack(): void;
+    showSidebar(payload?: SidebarShowPayload): void;
+    hideSidebar(): void;
+    checkAdmin(payload: CheckerPayload): void;
+    checkCaptcha(payload: CheckerCaptchaPayload): void;
+    checkAdminShowEl(): void;
+    on(name: any, handler: any, scope?: any): void;
+    off(name: any, handler: any, scope?: any): void;
+    trigger(name: any, payload?: any, scope?: any): void;
+    $t(key: keyof I18n, args?: {
+        [key: string]: string;
+    }): string;
+    setDarkMode(darkMode: boolean): void;
+}

package/dist/src/defaults.d.ts

@@ -0,0 +1,3 @@
+import ArtalkConfig from '../types/artalk-config';
+declare const defaults: ArtalkConfig;
+export default defaults;