@waline/client 1.6.0 → 2.0.0-alpha.2

package/dist/{Waline.min.d.ts → shim.d.ts}

@@ -1,4 +1,48 @@
-interface CommentData {
+interface WalineEmojiInfo {
+    /**
+     * 选项卡上的 Emoji 名称
+     *
+     * Emoji name show on tab
+     */
+    name: string;
+    /**
+     * 所在文件夹链接
+     *
+     * Current folder link
+     */
+    folder: string;
+    /**
+     * Emoji 通用路径前缀
+     *
+     * Common prefix of Emoji icons
+     */
+    prefix?: string;
+    /**
+     * Emoji 图片的类型，会作为文件扩展名使用
+     *
+     * Type of Emoji icons, will be regarded as file extension
+     */
+    type?: string;
+    /**
+     * 选项卡显示的 Emoji 图标
+     *
+     * Emoji icon show on tab
+     */
+    icon: string;
+    /**
+     * Emoji 图片列表
+     *
+     * Emoji image list
+     */
+    items: string[];
+}
+declare type WalineEmojiMaps = Record<string, string>;
+declare type WalineMeta = 'nick' | 'mail' | 'link';
+declare type WalineImageUploader = (image: File) => Promise<string>;
+declare type WalineHighlighter = ((code: string, lang: string) => string) | ((code: string, lang: string, callback?: (error: unknown | undefined, code?: string) => void) => void);
+declare type WalineTexRenderer = (blockMode: boolean, tex: string) => string;
+
+interface WalineCommentData {
     nick: string;
     mail: string;
     link?: string;
@@ -9,29 +53,20 @@ interface CommentData {
     at?: string;
     url: string;
 }
-interface Comment extends Exclude<CommentData, 'ua'> {
-    avatar?: string;
+interface WalineComment extends Exclude<WalineCommentData, 'ua'> {
+    avatar: string;
+    type?: string;
     objectId: string;
     createdAt: string;
     insertedAt: string;
     updatedAt: string;
-    children: Comment[];
+    children: WalineComment[];
     sticky?: boolean;
     browser?: string;
     os?: string;
 }
 
-interface RecentCommentsOptions {
-    serverURL: string;
-    count: number;
-    el?: string | HTMLElement;
-}
-interface RecentCommentsResult {
-    comments: Comment[];
-    destroy: () => void;
-}
-
-interface Locale {
+interface WalineLocale {
     nick: string;
     nickError: string;
     mail: string;
@@ -64,233 +99,23 @@ interface Locale {
     anonymous: string;
 }
 
-declare type Avatar = '' | 'mp' | 'identicon' | 'monsterid' | 'wavatar' | 'retro' | 'robohash' | 'hide';
-interface EmojiInfo {
-    /**
-     * 选项卡上的 Emoji 名称
-     *
-     * Emoji name show on tab
-     */
-    name: string;
-    /**
-     * 所在文件夹链接
-     *
-     * Current folder link
-     */
-    folder: string;
-    /**
-     * Emoji 通用路径前缀
-     *
-     * Common prefix of Emoji icons
-     */
-    prefix?: string;
-    /**
-     * Emoji 图片的类型，会作为文件扩展名使用
-     *
-     * Type of Emoji icons, will be regarded as file extension
-     */
-    type?: string;
-    /**
-     * 选项卡显示的 Emoji 图标
-     *
-     * Emoji icon show on tab
-     */
-    icon: string;
-    /**
-     * Emoji 图片列表
-     *
-     * Emoji image list
-     */
-    items: string[];
-}
-declare type EmojiMaps = Record<string, string>;
-declare type Meta = 'nick' | 'mail' | 'link';
-declare type UploadImage = (image: File) => Promise<string>;
-declare type Highlighter = ((code: string, lang: string) => string) | ((code: string, lang: string, callback?: (error: unknown | undefined, code?: string) => void) => void);
-declare type TexRenderer = (blockMode: boolean, tex: string) => string;
-interface DeprecatedValineOptions {
-    /**
-     * @deprecated Use `locale.placeholder` instead, will be dropped in V2
-     */
-    placeholder?: string;
-    /**
-     * @deprecated Use `locale` instead, will be dropped in V2
-     */
-    langMode?: Locale;
-    /**
-     * @deprecated Use `requiredMeta` instead, will be dropped in V2
-     */
-    requiredFields?: Meta[];
-    /**
-     * @deprecated Please use `AVATAR_PROXY` in server, will be dropped in V2
-     *
-     * [Gravatar](http://cn.gravatar.com/) 头像展示方式
-     *
-     * 可选值:
-     *
-     * - `''`
-     * - `'mp'`
-     * - `'identicon'`
-     * - `'monsterid'`
-     * - `'wavatar'`
-     * - `'retro'`
-     * - `'robohash'`
-     * - `'hide'`
-     *
-     * @see https://waline.js.org/client/avatar.html
-     *
-     * [Gravatar](http://gravatar.com/) type
-     *
-     * Optional value:
-     *
-     * - `''`
-     * - `'mp'`
-     * - `'identicon'`
-     * - `'monsterid'`
-     * - `'wavatar'`
-     * - `'retro'`
-     * - `'robohash'`
-     * - `'hide'`
-     *
-     * @see https://waline.js.org/en/client/avatar.html
-     *
-     * @default 'mp'
-     */
-    avatar?: Avatar;
-    /**
-     * @deprecated Please use `AVATAR_PROXY` in server, will be dropped in V2
-     *
-     * 设置 Gravatar 头像 CDN 地址
-     *
-     * Gravatar CDN baseURL
-     *
-     * @default 'https://seccdn.libavatar.org/avatar/'
-     */
-    avatarCDN?: string;
-    /**
-     * @deprecated This option is no longer needed with latest server, will be dropped in V2
-     *
-     * 每次访问是否**强制**拉取最新的*评论列表头像*
-     *
-     * Whether **force** pulling the latest avatar each time
-     *
-     * @default false
-     */
-    avatarForce?: boolean;
-    /**
-     * @deprecated Please use mathjax in server, will be dropped in V2
-     *
-     * 是否注入额外的样式添加对 `<math>` 块的兼容
-     *
-     * Whether injecting additional styles to support math block
-     *
-     * @default false
-     */
-    mathTagSupport?: boolean;
-    /**
-     * @deprecated Use `emojis` instead, will be dropped in V2
-     *
-     * 设置**表情包 CDN**
-     *
-     * @see [自定义表情包](https://waline.js.org/client/emoji.html)
-     *
-     * Set **Emoji Pack CDN**
-     *
-     * @see [Custom Emoji](https://waline.js.org/en/client/emoji.html)
-     *
-     * @default 'https://img.t.sinajs.cn/t4/appstyle/expression/ext/normal/'
-     */
-    emojiCDN?: string;
-    /**
-     * @deprecated Use `emojis` instead, will be dropped in V2
-     *
-     * 设置**表情包映射**
-     *
-     * @see [自定义表情](https://waline.js.org/client/emoji.html)
-     *
-     * Set **emoji maps**
-     *
-     * @see [Custom Emoji](https://waline.js.org/en/client/emoji.html)
-     *
-     * @default 微博表情包
-     */
-    emojiMaps?: EmojiMaps;
-    /**
-     * @deprecated Use `tex` instead
-     *
-     * 自定义 Tex 处理方法，用于预览。
-     *
-     * Custom math formula parse callback for preview.
-     */
-    previewMath?: TexRenderer | false;
-    /**
-     * @deprecated Use `login` instead, will be dropped in V2
-     *
-     * 是否允许登录评论
-     *
-     * 默认情况是两者都支持，设置为 `true` 表示仅支持匿名评论，`false` 表示仅支持登录评论。
-     *
-     * Whether to allow login comments.
-     *
-     * Both supported by default, set to `true` means only support anonymous comments, `false` means only support login comments.
-     *
-     * @default undefined
-     */
-    anonymous?: boolean;
-}
-interface WalineOptions extends DeprecatedValineOptions {
-    /**
-     * Waline 的初始化挂载器。必须是一个有效的 **CSS 选择器**
-     *
-     * The DOM element to be mounted on initialization. It must be a valid **CSS selector string**.
-     */
-    el?: string | HTMLElement;
+interface WalineProps {
     /**
      * Waline 的服务端地址
      *
      * Waline server address url
      */
     serverURL: string;
-    /**
-     * 评论字数限制。填入单个数字时为最大字数限制
-     *
-     * @more 设置为 `0` 时无限制
-     *
-     * Comment word s limit. When a single number is filled in, it 's the maximum number of comment words.
-     *
-     * @more No limit when set to `0`.
-     *
-     * @default 0
-     */
-    wordLimit?: number | [number, number];
     /**
      * 当前 _文章页_ 路径，用于区分不同的 _文章页_ ，以保证正确读取该 _文章页_ 下的评论列表
      *
-     * 可选值:
-     *
-     * - `window.location.pathname` (默认值，推荐)
-     * - `window.location.href`
-     * - 自定义
-     *
-     * > I. 请保证每个 _文章页_ 路径的唯一性，否则可能会出现不同 _文章页_ 下加载相同评论列表的情况。
-     * >
-     * > II. 如果值为 `window.location.href`，可能会出现随便加 _不同参数_ 进入该页面，而被判断成新页面的情况。
+     * 你可以将其设置为 `window.location.pathname`
      *
      * Article path id. Used to distinguish different _article pages_ to ensure loading the correct comment list under the _article page_.
      *
-     * Optional value:
-     *
-     * - `window.location.pathname` (default, recommended)
-     * - `window.location.href`
-     * - customize
-     *
-     * > I. Please ensure the uniqueness of each _article page_ path, otherwise the same comment list may be loaded under different _article pages_.
-     * >
-     * > II. If the value is `window.location.href`, it may appear that adding _different parameters_ to enter the page, and it will be judged as a new page.
-     *
-     * @default window.location.pathname
+     * You can set it to `window.location.pathname`
      */
-    path?: string;
+    path: string;
     /**
      * 评论者相关属性
      *
@@ -302,7 +127,7 @@ interface WalineOptions extends DeprecatedValineOptions {
      *
      * @default ['nick', 'mail', 'link']
      */
-    meta?: Meta[];
+    meta?: WalineMeta[];
     /**
      * 设置**必填项**，默认昵称为匿名
      *
@@ -310,7 +135,19 @@ interface WalineOptions extends DeprecatedValineOptions {
      *
      * @default []
      */
-    requiredMeta?: Meta[];
+    requiredMeta?: WalineMeta[];
+    /**
+     * 评论字数限制。填入单个数字时为最大字数限制
+     *
+     * @more 设置为 `0` 时无限制
+     *
+     * Comment word s limit. When a single number is filled in, it 's the maximum number of comment words.
+     *
+     * @more No limit when set to `0`.
+     *
+     * @default 0
+     */
+    wordLimit?: number | [number, number];
     /**
      * 评论列表分页，每页条数
      *
@@ -325,24 +162,42 @@ interface WalineOptions extends DeprecatedValineOptions {
      * 可选值:
      *
      * - `'zh'`
+     * - `'zh-cn'`
      * - `'zh-CN'`
+     * - `'zh-tw'`
      * - `'zh-TW'`
      * - `'en'`
      * - `'en-US'`
+     * - `'en-us'`
      * - `'jp'`
+     * - `'jp-jp'`
      * - `'jp-JP'`
+     * - `'pt-br'`
+     * - `'pt-BR'`
+     * - `'ru'`
+     * - `'ru-ru'`
+     * - `'ru-RU'`
      *
      * Display language for waline
      *
      * Optional value:
      *
      * - `'zh'`
+     * - `'zh-cn'`
      * - `'zh-CN'`
+     * - `'zh-tw'`
      * - `'zh-TW'`
      * - `'en'`
      * - `'en-US'`
+     * - `'en-us'`
      * - `'jp'`
+     * - `'jp-jp'`
      * - `'jp-JP'`
+     * - `'pt-br'`
+     * - `'pt-BR'`
+     * - `'ru'`
+     * - `'ru-ru'`
+     * - `'ru-RU'`
      *
      * @default 'zh-CN'
      */
@@ -356,15 +211,7 @@ interface WalineOptions extends DeprecatedValineOptions {
      *
      * @see [I18n](https://waline.js.org/en/client/i18n.html)
      */
-    locale?: Partial<Locale>;
-    /**
-     * 文章访问量统计
-     *
-     * Article reading statistics
-     *
-     * @default false
-     */
-    visitor?: boolean;
+    locale?: Partial<WalineLocale>;
     /**
      * 是否启用暗黑模式适配
      *
@@ -374,13 +221,7 @@ interface WalineOptions extends DeprecatedValineOptions {
      *
      * @more Setting `'auto'` will display darkmode due to device settings. Filling in CSS selector will enable darkmode only when the selector match waline ancestor nodes.
      */
-    dark?: string;
-    /**
-     * 代码高亮
-     *
-     * Code highlighting
-     */
-    highlight?: Highlighter | false;
+    dark?: string | boolean;
     /**
      * 设置表情包
      *
@@ -388,7 +229,13 @@ interface WalineOptions extends DeprecatedValineOptions {
      *
      * @default ['https://cdn.jsdelivr.net/gh/walinejs/emojis/weibo']
      */
-    emoji?: (string | EmojiInfo)[];
+    emoji?: (string | WalineEmojiInfo)[];
+    /**
+     * 代码高亮
+     *
+     * Code highlighting
+     */
+    highlighter?: WalineHighlighter | false;
     /**
      * 自定义图片上传方法，方便更好的存储图片
      *
@@ -398,13 +245,13 @@ interface WalineOptions extends DeprecatedValineOptions {
      *
      * We will pass a picture file object when execute it.
      */
-    uploadImage?: UploadImage | false;
+    imageUploader?: WalineImageUploader | false;
     /**
      * 自定义数学公式处理方法，用于预览。
      *
      * Custom math formula parse callback for preview.
      */
-    tex?: TexRenderer | false;
+    texRenderer?: WalineTexRenderer | false;
     /**
      *
      * 登录模式状态，可选值:
@@ -436,22 +283,106 @@ interface WalineOptions extends DeprecatedValineOptions {
     copyright?: boolean;
 }
 
-declare type Update = (options: Partial<Omit<WalineOptions, 'el' | 'dark'>>) => void;
+interface WalineInitOptions extends Omit<WalineProps, 'path'> {
+    /**
+     * Waline 的初始化挂载器。必须是一个**有效的** CSS 选择器 或 HTML 元素
+     *
+     * The DOM element to be mounted on initialization. It must be a **valid** CSS selector string or HTML Element.
+     */
+    el?: string | HTMLElement | null;
+    /**
+     * 评论数统计
+     *
+     * Comment number support
+     *
+     * @default false
+     */
+    comment?: string | boolean;
+    /**
+     * 页面访问量统计
+     *
+     * Pageview number support
+     *
+     * @default false
+     */
+    pageview?: string | boolean;
+    /**
+     * 当前 _文章页_ 路径，用于区分不同的 _文章页_ ，以保证正确读取该 _文章页_ 下的评论列表
+     *
+     * 你可以将其设置为 `window.location.pathname`
+     *
+     * Article path id. Used to distinguish different _article pages_ to ensure loading the correct comment list under the _article page_.
+     *
+     * You can set it to `window.location.pathname`
+     *
+     * @default window.location.pathname
+     */
+    path?: string;
+}
+
+declare const getMeta: (meta: WalineMeta[]) => WalineMeta[];
+declare const defaultLang = "zh-CN";
+declare const defaultUploadImage: (file: File) => Promise<string>;
+declare const defaultTexRenderer: (blockMode: boolean) => string;
 
-interface WalineErrorInstance {
-    errMsg: string;
+declare type Locales = Record<string, WalineLocale>;
+declare const locales: Locales;
+
+interface CommentCountOptions {
+    serverURL: string;
+    selector?: string;
+    path?: string;
 }
+declare const commentCount: ({ serverURL, path, selector, }: CommentCountOptions) => (reason?: unknown) => void;
+
 interface WalineInstance {
     el: HTMLElement | null;
-    update: Update;
+    update: (newOptions: Partial<WalineProps>) => void;
     destroy: () => void;
 }
-declare function waline(options: WalineOptions): WalineInstance | WalineErrorInstance;
-declare namespace waline {
-    var Widget: {
-        RecentComments: ({ el, serverURL, count, }: RecentCommentsOptions) => Promise<RecentCommentsResult>;
-    };
-    var version: string;
+declare const init: ({ el, path, comment, pageview, ...initProps }: WalineInitOptions) => WalineInstance | null;
+
+interface VisitorCountOptions {
+    /**
+     * Waline server url
+     *
+     * Waline 服务端地址
+     */
+    serverURL: string;
+    /**
+     * Path to be fetched and updated
+     *
+     * 需要更新和获取的路径
+     *
+     * @default window.location.pathname
+     */
+    path?: string;
+    /**
+     * @default '.waline-pageview-count'
+     */
+    selector?: string;
+    /**
+     * Whether update pageviews when fetching path result
+     *
+     * 是否在查询时更新 path 的浏览量
+     *
+     * @default true
+     */
+    update?: boolean;
+}
+declare const pageviewCount: ({ serverURL, path, selector, update, }: VisitorCountOptions) => (reason?: unknown) => void;
+
+declare const version: string;
+
+interface RecentCommentsOptions {
+    serverURL: string;
+    count: number;
+    el?: string | HTMLElement;
+}
+interface RecentCommentsResult {
+    comments: WalineComment[];
+    destroy: () => void;
 }
+declare const RecentComments: ({ el, serverURL, count, }: RecentCommentsOptions) => Promise<RecentCommentsResult>;
 
-export { Comment as WalineComment, WalineErrorInstance, WalineInstance, Locale as WalineLocale, WalineOptions, Update as WalineUpdate, waline as default };
+export { CommentCountOptions, Locales, RecentComments, RecentCommentsOptions, RecentCommentsResult, VisitorCountOptions, WalineComment, WalineCommentData, WalineEmojiInfo, WalineEmojiMaps, WalineHighlighter, WalineImageUploader, WalineInitOptions, WalineInstance, WalineLocale, WalineMeta, WalineProps, WalineTexRenderer, commentCount, defaultLang, defaultTexRenderer, defaultUploadImage, getMeta, init, locales, pageviewCount, version };