artalk 2.6.4 → 2.7.0

package/dist/src/api/{api-base.d.ts → _base.d.ts}

@@ -1,14 +1,10 @@
-import Context from '../../types/context';
-import Api from '.';
+import { ApiOptions } from './_options';
 declare abstract class ApiBase {
-    protected api: Api;
-    protected ctx: Context;
-    constructor(api: Api, ctx: Context);
+    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>;
 }
-interface ApiBase {
-}
 export default ApiBase;

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

@@ -0,0 +1,19 @@
+export interface ApiOptions {
+    baseURL: string;
+    siteName: string;
+    pageKey: string;
+    pageTitle: string;
+    timeout?: number;
+    onNeedCheckCaptcha?: (payload: {
+        recall: () => void;
+        reject: () => void;
+        data: {
+            imgData: string;
+            iframe: string;
+        };
+    }) => void;
+    onNeedCheckAdmin?: (payload: {
+        recall: () => void;
+        reject: () => void;
+    }) => void;
+}

package/dist/src/api/{request.d.ts → _request.d.ts}

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

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

@@ -1,4 +1,4 @@
-import ApiBase from './api-base';
+import ApiBase from './_base';
 /**
  * 管理员 API
  */

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

@@ -1,4 +1,4 @@
-import ApiBase from './api-base';
+import ApiBase from './_base';
 /**
  * 验证码 API
  */

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

@@ -1,5 +1,5 @@
-import { CommentData, ListData } from '../../types/artalk-data';
-import ApiBase from './api-base';
+import type { CommentData, ListData } from '../../types';
+import ApiBase from './_base';
 /**
  * 评论 API
  */

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

@@ -1,4 +1,4 @@
-import Context from '../../types/context';
+import { ApiOptions } from './_options';
 import comment from './comment';
 import page from './page';
 import site from './site';
@@ -18,9 +18,7 @@ declare const ApiComponents: {
     upload: typeof upload;
 };
 declare class Api {
-    protected ctx: Context;
-    get baseURL(): string;
-    constructor(ctx: Context);
+    constructor(opts: ApiOptions);
 }
 type TC = typeof ApiComponents;
 type AC = {

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

@@ -1,5 +1,5 @@
-import { PageData, CommentData } from '../../types/artalk-data';
-import ApiBase from './api-base';
+import type { PageData, CommentData } from '../../types';
+import ApiBase from './_base';
 /**
  * 页面 API
  */
@@ -18,5 +18,5 @@ export default class PageApi extends ApiBase {
     /** 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 | PageData[] | CommentData[]>;
+    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/site.d.ts

@@ -1,5 +1,5 @@
-import { SiteData } from '../../types/artalk-data';
-import ApiBase from './api-base';
+import type { SiteData } from '../../types';
+import ApiBase from './_base';
 /**
  * 站点 API
  */

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

@@ -1,11 +1,20 @@
-import ArtalkConfig from '../../types/artalk-config';
-import ApiBase from './api-base';
+import type { ArtalkConfig } from '../../types';
+import ApiBase from './_base';
+interface ApiVersionInfo {
+    app: string;
+    version: string;
+    commit_hash: string;
+}
+interface SystemConfResp {
+    frontend_conf: Partial<ArtalkConfig>;
+    version: ApiVersionInfo;
+}
 /**
  * 系统 API
  */
 export default class SystemApi extends ApiBase {
     /** 获取配置 */
-    conf(): Promise<Partial<ArtalkConfig>>;
+    conf(): Promise<SystemConfResp>;
     /** 获取配置数据 */
     getSettings(): Promise<{
         custom: string;
@@ -21,3 +30,4 @@ export default class SystemApi extends ApiBase {
         fe_min_version: string;
     }>;
 }
+export {};

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

@@ -1,4 +1,4 @@
-import ApiBase from './api-base';
+import ApiBase from './_base';
 /**
  * 上传 API
  */

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

@@ -1,5 +1,5 @@
-import { UserData, NotifyData, UserDataForAdmin } from '../../types/artalk-data';
-import ApiBase from './api-base';
+import type { UserData, NotifyData, UserDataForAdmin } from '../../types';
+import ApiBase from './_base';
 /**
  * 用户 API
  */

package/dist/src/artalk.d.ts

@@ -1,60 +1,37 @@
-import type ArtalkConfig from '../types/artalk-config';
-import type { EventPayloadMap, Handler } from '../types/event';
-import type ArtalkPlug from '../types/plug';
-import type Context from '../types/context';
-import ListLite from './list/list-lite';
+import type { ArtalkConfig, EventPayloadMap, ArtalkPlugin, ContextApi } from '../types';
+import type { EventHandler } from './lib/event-manager';
 /**
  * Artalk
  *
  * @see https://artalk.js.org
  */
 export default class Artalk {
-    private static instance?;
-    static ListLite: typeof ListLite;
-    static readonly defaults: ArtalkConfig;
     conf: ArtalkConfig;
-    ctx: Context;
+    ctx: ContextApi;
     $root: HTMLElement;
     /** Plugins */
-    protected static plugins: ArtalkPlug[];
-    static DisabledComponents: string[];
+    protected plugins: ArtalkPlugin[];
     constructor(conf: Partial<ArtalkConfig>);
-    /** Init Artalk */
-    static init(conf: Partial<ArtalkConfig>): Artalk;
-    /** Use Plugin (plugin will be called in instance `use` func) */
-    use(plugin: ArtalkPlug): void;
     /** Update config of Artalk */
-    update(conf: Partial<ArtalkConfig>): 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: Handler<EventPayloadMap[K]>): void;
+    on<K extends keyof EventPayloadMap>(name: K, handler: EventHandler<EventPayloadMap[K]>): void;
     /** Remove an event listener */
-    off<K extends keyof EventPayloadMap>(name: K, handler: Handler<EventPayloadMap[K]>): void;
+    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;
-    /** Use Plugin (static method) */
-    static use(plugin: ArtalkPlug): void;
-    /** Update config of Artalk */
-    static update(conf: Partial<ArtalkConfig>): Artalk | undefined;
-    /** Reload comment list of Artalk */
-    static reload(): void;
-    /** Destroy instance of Artalk */
-    static destroy(): void;
-    /** Add an event listener */
-    static on<K extends keyof EventPayloadMap>(name: K, handler: Handler<EventPayloadMap[K]>): void;
-    /** Remove an event listener */
-    static off<K extends keyof EventPayloadMap>(name: K, handler: Handler<EventPayloadMap[K]>): void;
-    /** Trigger an event */
-    static trigger<K extends keyof EventPayloadMap>(name: K, payload?: EventPayloadMap[K]): void;
-    /** Set dark mode */
-    static setDarkMode(darkMode: boolean): void;
+    /** Default Configs */
+    static readonly defaults: ArtalkConfig;
+    /** 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(conf: Partial<ArtalkConfig>): void;
-    /** @deprecated Please use `loadCountWidget` instead */
-    static LoadCountWidget(conf: Partial<ArtalkConfig>): void;
+    static loadCountWidget(c: Partial<ArtalkConfig>): void;
 }

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

@@ -1,4 +1,4 @@
-import Comment from './comment';
+import type Comment from './comment';
 import ActionBtn from '../components/action-btn';
 export default class CommentActions {
     private comment;

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

@@ -1,5 +1,4 @@
-import { CommentData } from '../../types/artalk-data';
-import Context from '../../types/context';
+import type { CommentData, ContextApi } from '../../types';
 import Component from '../lib/component';
 import CommentUI from './render';
 import CommentActions from './actions';
@@ -22,7 +21,7 @@ export default class Comment extends Component {
     private children;
     private nestCurt;
     private nestMax;
-    constructor(ctx: Context, data: CommentData, conf: CommentConf);
+    constructor(ctx: ContextApi, data: CommentData, conf: CommentConf);
     /** 渲染 UI */
     render(): void;
     /** 获取评论操作实例对象 */
@@ -56,7 +55,7 @@ export default class Comment extends Component {
     /** 获取评论 markdown 解析后的内容 */
     getContentMarked(): string;
     /** 获取格式化后的日期 */
-    getDateFormatted(): string;
+    getDateFormatted(): any;
     /** 获取用户 UserAgent 信息 */
     getUserUA(): {
         browser: string;

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

@@ -1,6 +1,24 @@
-import Comment from './comment';
-import RenderCtx from './render-ctx';
-export default class CommentRender extends RenderCtx {
+import type Comment from './comment';
+import ActionBtn from '../components/action-btn';
+export default class Render {
+    comment: Comment;
+    get ctx(): import("../../types").ContextApi;
+    get data(): import("../../types").CommentData;
+    get conf(): import("../../types").ArtalkConfig;
+    get cConf(): import("./comment").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);
     render(): HTMLElement;
     /** 内容限高检测 */

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

@@ -1,5 +1,5 @@
-import RenderCtx from '../render-ctx';
+import type Render from '../render';
 /**
  * 评论操作按钮界面
  */
-export default function renderActions(ctx: RenderCtx): void;
+export default function renderActions(r: Render): void;

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

@@ -1,5 +1,5 @@
-import RenderCtx from '../render-ctx';
+import type Render from '../render';
 /**
  * 评论头像界面
  */
-export default function renderAvatar(ctx: RenderCtx): void;
+export default function renderAvatar(r: Render): void;

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

@@ -1,5 +1,5 @@
-import RenderCtx from '../render-ctx';
+import type Render from '../render';
 /**
  * 评论内容界面
  */
-export default function renderContent(ctx: RenderCtx): void;
+export default function renderContent(r: Render): void;

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

@@ -1,5 +1,5 @@
-import RenderCtx from '../render-ctx';
+import type Render from '../render';
 /**
  * 评论头部界面
  */
-export default function renderHeader(ctx: RenderCtx): void;
+export default function renderHeader(r: Render): void;

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

@@ -1,2 +1,2 @@
-import RenderCtx from '../render-ctx';
-export default function loadRenders(ctx: RenderCtx): void;
+import type Render from '../render';
+export default function loadRenders(r: Render): void;

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

@@ -1,5 +1,5 @@
-import RenderCtx from '../render-ctx';
+import type Render from '../render';
 /**
  * 待审核状态界面
  */
-export default function renderPending(ctx: RenderCtx): void;
+export default function renderPending(r: Render): void;

package/dist/src/comment/renders/reply-at.d.ts

@@ -1,5 +1,5 @@
-import RenderCtx from '../render-ctx';
+import type Render from '../render';
 /**
  * 层级嵌套模式显示 AT 界面
  */
-export default function renderReplyAt(ctx: RenderCtx): void;
+export default function renderReplyAt(r: Render): void;

package/dist/src/comment/renders/reply-to.d.ts

@@ -1,5 +1,5 @@
-import RenderCtx from '../render-ctx';
+import type Render from '../render';
 /**
  * 回复的对象界面
  */
-export default function renderReplyTo(ctx: RenderCtx): void;
+export default function renderReplyTo(r: Render): void;

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

@@ -1,5 +1,4 @@
-import Context from '../../types/context';
-interface ActionBtnConf {
+interface ActionBtnOptions {
     /** 按钮文字 (动态/静态) */
     text: (() => string) | string;
     /** 仅管理员可用 */
@@ -13,8 +12,7 @@ interface ActionBtnConf {
  * 通用操作按钮
  */
 export default class ActionBtn {
-    private ctx;
-    private conf;
+    private opts;
     $el: HTMLElement;
     isLoading: boolean;
     msgRecTimer?: number;
@@ -23,7 +21,7 @@ export default class ActionBtn {
     isConfirming: boolean;
     confirmRecTimer?: number;
     /** 构造函数 */
-    constructor(ctx: Context, conf: ActionBtnConf | string | (() => string));
+    constructor(opts: ActionBtnOptions | string | (() => string));
     /** 将按钮装载到指定元素 */
     appendTo(dom: HTMLElement): this;
     /** 获取按钮文字（动态/静态） */

package/dist/src/{lib → components}/checker/admin.d.ts

@@ -1,3 +1,3 @@
-import { Checker } from '.';
+import type { Checker } from '.';
 declare const AdminChecker: Checker;
 export default AdminChecker;

package/dist/src/{lib → components}/checker/captcha-renders.d.ts

@@ -1,4 +1,4 @@
-import { CheckerCtx } from '.';
+import type { CheckerCtx } from '.';
 /** 图片验证码 */
 export declare function imgBody(checker: CheckerCtx): HTMLElement;
 /** iframe 形式的通用验证服务 */

package/dist/src/{lib → components}/checker/captcha.d.ts

@@ -1,3 +1,3 @@
-import { Checker } from '.';
+import type { Checker } from '.';
 declare const CaptchaChecker: Checker;
 export default CaptchaChecker;

package/dist/src/{lib → components}/checker/index.d.ts

@@ -1,6 +1,5 @@
-import Context from '../../../types/context';
-import Layer from '../../layer';
 import type Api from '../../api';
+import type { ContextApi } from '../../../types';
 export interface CheckerCaptchaPayload extends CheckerPayload {
     imgData?: string;
     iframe?: string;
@@ -10,13 +9,18 @@ export interface CheckerPayload {
     onMount?: (dialogEl: HTMLElement) => void;
     onCancel?: () => void;
 }
+export interface CheckerLauncherOptions {
+    getCtx: () => ContextApi;
+    getApi: () => Api;
+    getIframeURLBase: () => string;
+    onReload: () => void;
+}
 /**
  * Checker 发射台
  */
 export default class CheckerLauncher {
-    ctx: Context;
-    launched: Checker[];
-    constructor(ctx: Context);
+    private opts;
+    constructor(opts: CheckerLauncherOptions);
     checkCaptcha(payload: CheckerCaptchaPayload): void;
     checkAdmin(payload: CheckerPayload): void;
     fire(checker: Checker, payload: CheckerPayload, postFire?: (c: CheckerCtx) => void): void;
@@ -38,9 +42,8 @@ interface CheckerStore {
 export interface CheckerCtx {
     get<K extends keyof CheckerStore>(key: K): CheckerStore[K];
     set<K extends keyof CheckerStore>(key: K, val: CheckerStore[K]): void;
-    getCtx(): Context;
+    getOpts(): CheckerLauncherOptions;
     getApi(): Api;
-    getLayer(): Layer;
     hideInteractInput(): void;
     triggerSuccess(): void;
     cancel(): void;

package/dist/src/components/dark-mode.d.ts

@@ -0,0 +1,2 @@
+export declare function applyDarkMode($els: HTMLElement[], darkMode: boolean | 'auto'): void;
+export declare const DarkModeClassName = "atk-dark-mode";

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

@@ -1,14 +1,12 @@
-import Context from '../../types/context';
 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);
+    constructor(contentEl: HTMLElement);
     /** 按钮 · 确定 */
     setYes(handler: BtnClickHandler): this;
     /** 按钮 · 取消 */

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

@@ -0,0 +1,8 @@
+export interface ErrorDialogOptions {
+    $err: HTMLElement;
+    errMsg: string;
+    errData?: any;
+    retryFn?: () => void;
+    onOpenSidebar?: () => void;
+}
+export declare function showErrorDialog(opts: ErrorDialogOptions): void;

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

@@ -1,11 +1,11 @@
-export interface PaginationConf {
+export interface PaginationOptions {
     /** 每页条数 */
     pageSize: number;
     /** 回调函数 */
     onChange: (offset: number) => void;
 }
 export default class Pagination {
-    private conf;
+    private opts;
     total: number;
     $el: HTMLElement;
     $input: HTMLInputElement;
@@ -16,12 +16,13 @@ export default class Pagination {
     get pageSize(): number;
     get offset(): number;
     get maxPage(): number;
-    constructor(total: number, conf: PaginationConf);
+    constructor(total: number, opts: PaginationOptions);
     update(offset: number, total: number): void;
     setInput(page: number): void;
     input(now?: boolean): void;
     prev(): void;
     next(): void;
+    getHasMore(): boolean;
     change(page: number): void;
     checkDisabled(): void;
     keydown(e: KeyboardEvent): void;

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

@@ -1,4 +1,4 @@
-export interface ReadMoreBtnConf {
+export interface ReadMoreBtnOptions {
     /** 回调函数 */
     onClick: (offset: number) => void;
     pageSize: number;
@@ -8,7 +8,7 @@ export interface ReadMoreBtnConf {
  * 阅读更多按钮
  */
 export default class ReadMoreBtn {
-    conf: ReadMoreBtnConf;
+    opts: ReadMoreBtnOptions;
     $el: HTMLElement;
     private $loading;
     private $text;
@@ -17,7 +17,7 @@ export default class ReadMoreBtn {
     private origText;
     /** 是否有更多内容 */
     get hasMore(): boolean;
-    constructor(conf: ReadMoreBtnConf);
+    constructor(opts: ReadMoreBtnOptions);
     click(): void;
     /** 显示 */
     show(): void;

package/dist/src/config.d.ts

@@ -1,8 +1,24 @@
-import type ArtalkConfig from '../types/artalk-config';
-declare const _default: {
-    handelBaseConf: typeof handelBaseConf;
-};
-export default _default;
-/** 基本配置初始化 */
-export declare function handelBaseConf(customConf: Partial<ArtalkConfig>): ArtalkConfig;
-export declare function handleBackendRefConf(conf: Partial<ArtalkConfig>): Partial<ArtalkConfig>;
+import type { ArtalkConfig, ContextApi } from '../types';
+import type { ApiOptions } from './api/_options';
+/**
+ * Merges the user custom config with the default config
+ *
+ * @param customConf - The custom config object which is provided by the user
+ * @returns The config for Artalk instance creation
+ */
+export declare function handelCustomConf(customConf: Partial<ArtalkConfig>): ArtalkConfig;
+/**
+ * Handle the config which is provided by the server
+ *
+ * @param conf - The Server response config for control the frontend of Artalk remotely
+ * @returns The config for Artalk instance creation
+ */
+export declare function handleConfFormServer(conf: Partial<ArtalkConfig>): Partial<ArtalkConfig>;
+/**
+ * Convert Artalk Config to ApiOptions for Api client
+ *
+ * @param conf - Artalk config
+ * @param ctx - If `ctx` not provided, `checkAdmin` and `checkCaptcha` will be disabled
+ * @returns ApiOptions for Api client instance creation
+ */
+export declare function convertApiOptions(conf: Partial<ArtalkConfig>, ctx?: ContextApi): ApiOptions;