artalk 2.7.2 → 2.8.0

package/dist/src/plugins/editor/header-user.d.ts

@@ -1,16 +0,0 @@
-import EditorPlug from './_plug';
-import type PlugKit from './_kit';
-export default class HeaderUser extends EditorPlug {
-    constructor(kit: PlugKit);
-    private query;
-    /**
-     * Fetch user info from server
-     */
-    private fetchUserInfo;
-    /**
-     * Function called when user info fetched
-     *
-     * @param data The response data from server
-     */
-    private onUserInfoFetched;
-}

package/dist/src/plugins/editor/index.d.ts

@@ -1,6 +0,0 @@
-import type { ArtalkConfig } from '../../../types';
-import type EditorPlug from './_plug';
-/** The default enabled plugs */
-export declare const ENABLED_PLUGS: (typeof EditorPlug)[];
-/** Get the name list of disabled plugs */
-export declare function getDisabledPlugByConf(conf: ArtalkConfig): (typeof EditorPlug)[];

package/dist/src/plugins/editor/local-storage.d.ts

@@ -1,6 +0,0 @@
-import type PlugKit from './_kit';
-import EditorPlug from './_plug';
-export default class LocalStorage extends EditorPlug {
-    constructor(kit: PlugKit);
-    save(): void;
-}

package/dist/src/plugins/editor/mover.d.ts

@@ -1,6 +0,0 @@
-import EditorPlug from './_plug';
-export default class Mover extends EditorPlug {
-    private isMoved;
-    move(afterEl: HTMLElement): void;
-    back(): void;
-}

package/dist/src/plugins/editor/preview.d.ts

@@ -1,7 +0,0 @@
-import EditorPlug from './_plug';
-import type PlugKit from './_kit';
-export default class Preview extends EditorPlug {
-    private isPlugPanelShow;
-    constructor(kit: PlugKit);
-    updateContent(): void;
-}

package/dist/src/plugins/editor/state-edit.d.ts

@@ -1,11 +0,0 @@
-import type PlugKit from './_kit';
-import EditorPlug from './_plug';
-export default class StateEdit extends EditorPlug {
-    private comment?;
-    constructor(kit: PlugKit);
-    private edit;
-    private cancelEdit;
-    private originalSubmitBtnText;
-    private updateSubmitBtnText;
-    private restoreSubmitBtnText;
-}

package/dist/src/plugins/editor/state-reply.d.ts

@@ -1,8 +0,0 @@
-import EditorPlug from './_plug';
-import type PlugKit from './_kit';
-export default class StateReply extends EditorPlug {
-    private comment?;
-    constructor(kit: PlugKit);
-    private setReply;
-    private cancelReply;
-}

package/dist/src/plugins/editor/submit-add.d.ts

@@ -1,18 +0,0 @@
-import type { CommentData } from '../../../types';
-import type PlugKit from './_kit';
-export default class SubmitAddPreset {
-    private kit;
-    constructor(kit: PlugKit);
-    reqAdd(): Promise<CommentData>;
-    getSubmitAddParams(): {
-        content: string;
-        nick: string;
-        email: string;
-        link: string;
-        rid: number;
-        page_key: string;
-        page_title: string;
-        site_name: string;
-    };
-    postSubmitAdd(commentNew: CommentData): void;
-}

package/dist/src/plugins/editor/submit-btn.d.ts

@@ -1,5 +0,0 @@
-import EditorPlug from './_plug';
-import type PlugKit from './_kit';
-export default class SubmitBtn extends EditorPlug {
-    constructor(kit: PlugKit);
-}

package/dist/src/plugins/editor/submit.d.ts

@@ -1,17 +0,0 @@
-import type { CommentData } from '../../../types';
-import EditorPlug from './_plug';
-import type PlugKit from './_kit';
-interface CustomSubmit {
-    activeCond: () => void;
-    pre?: () => void;
-    req?: () => Promise<CommentData>;
-    post?: (nComment: CommentData) => void;
-}
-export default class Submit extends EditorPlug {
-    private customs;
-    private defaultPreset;
-    constructor(kit: PlugKit);
-    registerCustom(c: CustomSubmit): void;
-    private do;
-}
-export {};

package/dist/src/plugins/editor/textarea.d.ts

@@ -1,8 +0,0 @@
-import EditorPlug from './_plug';
-import type PlugKit from './_kit';
-export default class Textarea extends EditorPlug {
-    constructor(kit: PlugKit);
-    private onKeydown;
-    private onInput;
-    adaptiveHeightByContent(): void;
-}

package/dist/src/plugins/editor/upload.d.ts

@@ -1,9 +0,0 @@
-import type PlugKit from './_kit';
-import EditorPlug from './_plug';
-export default class Upload extends EditorPlug {
-    private $imgUploadInput?;
-    constructor(kit: PlugKit);
-    private init;
-    private initDragImg;
-    uploadImg(file: File): Promise<void>;
-}

package/dist/src/plugins/editor-kit.d.ts

@@ -1,42 +0,0 @@
-import type { EditorApi, ArtalkPlugin } from '../../types';
-import EventManager from '../lib/event-manager';
-import EditorPlug from './editor/_plug';
-export 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;
-}
-export declare const EditorKit: ArtalkPlugin;
-export 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;
-}

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

@@ -1,2 +0,0 @@
-import type { ArtalkPlugin } from '../../types';
-export declare const DefaultPlugins: ArtalkPlugin[];

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

@@ -1,2 +0,0 @@
-import type { ArtalkPlugin } from '../../../types';
-export declare const Copyright: ArtalkPlugin;

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

@@ -1,2 +0,0 @@
-import type { ArtalkPlugin } from '../../../types';
-export declare const Count: ArtalkPlugin;

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

@@ -1,2 +0,0 @@
-import type { ArtalkPlugin } from '../../../types';
-export declare const Dropdown: ArtalkPlugin;

package/dist/src/plugins/list/error-dialog.d.ts

@@ -1,2 +0,0 @@
-import type { ArtalkPlugin } from '../../../types';
-export declare const ErrorDialog: ArtalkPlugin;

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

@@ -1,2 +0,0 @@
-import type { ArtalkPlugin } from '../../../types';
-export declare const Fetch: ArtalkPlugin;

package/dist/src/plugins/list/goto-first.d.ts

@@ -1,3 +0,0 @@
-import type { ArtalkPlugin } from '../../../types';
-/** List scroll to the first comment */
-export declare const GotoFirst: ArtalkPlugin;

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

@@ -1,2 +0,0 @@
-import type { ArtalkPlugin } from '../../../types';
-export declare const Goto: ArtalkPlugin;

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

@@ -1,3 +0,0 @@
-import type { ArtalkPlugin } from '../../../types';
-declare const ListPlugins: ArtalkPlugin[];
-export { ListPlugins };

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

@@ -1,2 +0,0 @@
-import type { ArtalkPlugin } from '../../../types';
-export declare const Loading: ArtalkPlugin;

package/dist/src/plugins/list/no-comment.d.ts

@@ -1,2 +0,0 @@
-import type { ArtalkPlugin } from '../../../types';
-export declare const NoComment: ArtalkPlugin;

package/dist/src/plugins/list/reach-bottom.d.ts

@@ -1,2 +0,0 @@
-import type { ArtalkPlugin } from '../../../types';
-export declare const ReachBottom: ArtalkPlugin;

package/dist/src/plugins/list/sidebar-btn.d.ts

@@ -1,2 +0,0 @@
-import type { ArtalkPlugin } from '../../../types';
-export declare const SidebarBtn: ArtalkPlugin;

package/dist/src/plugins/list/time-ticking.d.ts

@@ -1,3 +0,0 @@
-import type { ArtalkPlugin } from '../../../types';
-/** 评论时间自动更新 */
-export declare const TimeTicking: ArtalkPlugin;

package/dist/src/plugins/list/unread-badge.d.ts

@@ -1,2 +0,0 @@
-import type { ArtalkPlugin } from '../../../types';
-export declare const UnreadBadge: ArtalkPlugin;

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

@@ -1,2 +0,0 @@
-import type { ArtalkPlugin } from '../../../types';
-export declare const Unread: ArtalkPlugin;

package/dist/src/plugins/list/with-editor.d.ts

@@ -1,2 +0,0 @@
-import type { ArtalkPlugin } from '../../../types';
-export declare const WithEditor: ArtalkPlugin;

package/dist/src/plugins/markdown.d.ts

@@ -1,2 +0,0 @@
-import type { ArtalkPlugin } from '../../types';
-export declare const Markdown: ArtalkPlugin;

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

@@ -1,13 +0,0 @@
-import type { ArtalkPlugin } from '../../types';
-import Api from '../api';
-export interface CountOptions {
-    getApi(): Api;
-    pageKey: string;
-    countEl: string;
-    pvEl: string;
-    /** 是否增加当前页面 PV 数 */
-    pvAdd?: boolean;
-}
-export declare const PvCountWidget: ArtalkPlugin;
-/** 初始化评论数和 PV 数量展示元素 */
-export declare function initCountWidget(opt: CountOptions): Promise<void>;

package/dist/src/plugins/version-check.d.ts

@@ -1,2 +0,0 @@
-import type { ArtalkPlugin } from '../../types';
-export declare const VersionCheck: ArtalkPlugin;

package/dist/src/service.d.ts

@@ -1,36 +0,0 @@
-import type { ContextApi } from '../types';
-import CheckerLauncher from './components/checker';
-import Editor from './editor/editor';
-import SidebarLayer from './layer/sidebar-layer';
-import List from './list/list';
-import { PlugManager } from './plugins/editor-kit';
-import { LayerManager } from './layer/layer-manager';
-import User from './lib/user';
-/**
- * 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;
-};
-export default services;
-type TServiceImps = typeof services;
-type TObjectWithFuncs = {
-    [k: string]: (...args: any) => any;
-};
-type TKeysOnlyReturn<T extends TObjectWithFuncs, V> = {
-    [K in keyof T]: ReturnType<T[K]> extends V ? K : never;
-}[keyof T];
-type TOmitConditions = TKeysOnlyReturn<TServiceImps, void>;
-type TServiceInjectors = Omit<TServiceImps, TOmitConditions>;
-export type TInjectedServices = {
-    [K in keyof TServiceInjectors]: ReturnType<TServiceInjectors[K]>;
-};

package/dist/tests/e2e/comment-add.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/config.d.ts

@@ -1,110 +0,0 @@
-import { I18n } from '../src/i18n';
-import { CommentData } from './data';
-export 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;
-}
-/**
- * 本地持久化用户数据
- * @note 始终保持一层结构，不支持多层结构
- */
-export interface LocalUser {
-    /** 昵称 */
-    nick: string;
-    /** 邮箱 */
-    email: string;
-    /** 链接 */
-    link: string;
-    /** TOKEN */
-    token: string;
-    /** 是否为管理员 */
-    isAdmin: boolean;
-}

package/dist/types/context.d.ts

@@ -1,62 +0,0 @@
-import type { TInjectedServices } from '../src/service';
-import type { CheckerCaptchaPayload, CheckerPayload } from '../src/components/checker';
-import type { EventManagerFuncs } from '../src/lib/event-manager';
-import type { TMarked } from '../src/lib/marked';
-import type { I18n } from '../src/i18n';
-import type Api from '../src/api';
-import type { SidebarShowPayload, EventPayloadMap, ArtalkConfig, CommentData, DataManagerApi, ListFetchParams, NotifyLevel } from '.';
-/**
- * Context 接口
- *
- * (面向接口的编程)
- */
-export 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;
-    /** 更新配置 */
-    updateConf(conf: Partial<ArtalkConfig>): void;
-}