@waline/client 2.0.0-alpha.2 → 2.0.0

package/dist/legacy.d.ts

@@ -0,0 +1,505 @@
+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 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 WalineLocale {
+    nick: string;
+    nickError: string;
+    mail: string;
+    mailError: string;
+    link: string;
+    optional: string;
+    placeholder: string;
+    sofa: string;
+    submit: string;
+    reply: string;
+    cancelReply: string;
+    comment: string;
+    refresh: string;
+    more: string;
+    preview: string;
+    emoji: string;
+    uploadImage: string;
+    seconds: string;
+    minutes: string;
+    hours: string;
+    days: string;
+    now: string;
+    uploading: string;
+    login: string;
+    logout: string;
+    admin: string;
+    sticky: string;
+    word: string;
+    wordHint: string;
+    anonymous: string;
+}
+
+interface WalineProps {
+    /**
+     * Waline 的服务端地址
+     *
+     * Waline server address url
+     */
+    serverURL: string;
+    /**
+     * 当前 _文章页_ 路径，用于区分不同的 _文章页_ ，以保证正确读取该 _文章页_ 下的评论列表
+     *
+     * 你可以将其设置为 `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`
+     */
+    path: string;
+    /**
+     * 评论者相关属性
+     *
+     * `Meta` 可选值: `'nick'`, `'mail'`, `'link'`
+     *
+     * Reviewer attributes.
+     *
+     * Optional values for `Meta`: `'nick'`, `'mail'`, `'link'`
+     *
+     * @default ['nick', 'mail', 'link']
+     */
+    meta?: WalineMeta[];
+    /**
+     * 设置**必填项**，默认昵称为匿名
+     *
+     * Set required fields, default anonymous with nickname
+     *
+     * @default []
+     */
+    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];
+    /**
+     * 评论列表分页，每页条数
+     *
+     * number of pages per page
+     *
+     * @default 10
+     */
+    pageSize?: number;
+    /**
+     * Waline 显示语言
+     *
+     * 可选值:
+     *
+     * - `'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'
+     */
+    lang?: string;
+    /**
+     * 自定义 waline 语言显示
+     *
+     * @see [自定义语言](https://waline.js.org/client/i18n.html)
+     *
+     * Custom display language in waline
+     *
+     * @see [I18n](https://waline.js.org/en/client/i18n.html)
+     */
+    locale?: Partial<WalineLocale>;
+    /**
+     * 是否启用暗黑模式适配
+     *
+     * @more 设置 `'auto'` 会根据设备暗黑模式自适应。填入 CSS 选择器会在对应选择器生效时启用夜间模式。
+     *
+     * Whether to enable darkmode support
+     *
+     * @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 | boolean;
+    /**
+     * 设置表情包
+     *
+     * Set Emojis
+     *
+     * @default ['https://cdn.jsdelivr.net/gh/walinejs/emojis/weibo']
+     */
+    emoji?: (string | WalineEmojiInfo)[];
+    /**
+     * 代码高亮
+     *
+     * Code highlighting
+     */
+    highlighter?: WalineHighlighter | false;
+    /**
+     * 自定义图片上传方法，方便更好的存储图片
+     *
+     * 方法执行时会将图片对象传入。
+     *
+     * Custom image upload callback to manage picture by yourself.
+     *
+     * We will pass a picture file object when execute it.
+     */
+    imageUploader?: WalineImageUploader | false;
+    /**
+     * 自定义数学公式处理方法，用于预览。
+     *
+     * Custom math formula parse callback for preview.
+     */
+    texRenderer?: WalineTexRenderer | false;
+    /**
+     *
+     * 登录模式状态，可选值:
+     *
+     * - `'enable'`: 启用登录 (默认)
+     * - `'disable'`: 禁用登录，用户只能填写信息评论
+     * - `'force'`: 强制登录，用户必须注册并登录才可发布评论
+     *
+     * Login mode status, optional values:
+     *
+     * - `'enable'`: enable login (default)
+     * - `'disable'`: Login is disabled, users should fill in infomation to comment
+     * - `'force'`: Forced login, users must login to comment
+     *
+     * @default 'enable'
+     */
+    login?: 'enable' | 'disable' | 'force';
+    /**
+     * 是否在页脚展示版权信息
+     *
+     * 为了支持 Waline，我们强烈建议你开启它
+     *
+     * Whether show copyright in footer
+     *
+     * We strongly recommended you to keep it on to support waline
+     *
+     * @default true
+     */
+    copyright?: boolean;
+}
+
+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;
+}
+
+interface WalineInstance {
+    /**
+     * Waline 被挂载到的元素
+     *
+     * @description 当通过 `el: null` 初始化，值为 `null`
+     *
+     * Element where Waline is mounted
+     *
+     * @description when initialized with `el: null`, it will be `null`
+     */
+    el: HTMLElement | null;
+    /**
+     * 更新 Waline 实例
+     *
+     * @description 只要不设置`path` 选项，更新时它就会被重置为 `windows.location.pathname`
+     *
+     * Update Waline instance
+     *
+     * @description when not setting `path` option, it will be reset to `window.location.pathname`
+     */
+    update: (newOptions: Partial<Omit<WalineInitOptions, 'el'>>) => void;
+    /**
+     * 取消挂载并摧毁 Waline 实例
+     *
+     * Unmount and destroy Waline instance
+     */
+    destroy: () => void;
+}
+
+declare type DeprecatedAvatar = '' | 'mp' | 'identicon' | 'monsterid' | 'wavatar' | 'retro' | 'robohash' | 'hide';
+declare type DeprecatedEmojiMaps = Record<string, string>;
+interface DeprecatedValineOptions {
+    /**
+     * @deprecated Use `locale.placeholder` instead, dropped in V2
+     */
+    placeholder?: string;
+    /**
+     * @deprecated Use `locale` instead, dropped in V2
+     */
+    langMode?: Partial<WalineLocale>;
+    /**
+     * @deprecated Use `requiredMeta` instead, dropped in V2
+     */
+    requiredFields?: WalineMeta[];
+    /**
+     * @deprecated Please use `AVATAR_PROXY` in server, dropped in V2
+     *
+     * [Gravatar](http://cn.gravatar.com/) 头像展示方式
+     *
+     * 可选值:
+     *
+     * - `''`
+     * - `'mp'`
+     * - `'identicon'`
+     * - `'monsterid'`
+     * - `'wavatar'`
+     * - `'retro'`
+     * - `'robohash'`
+     * - `'hide'`
+     *
+     * [Gravatar](http://gravatar.com/) type
+     *
+     * Optional value:
+     *
+     * - `''`
+     * - `'mp'`
+     * - `'identicon'`
+     * - `'monsterid'`
+     * - `'wavatar'`
+     * - `'retro'`
+     * - `'robohash'`
+     * - `'hide'`
+     *
+     * @default 'mp'
+     */
+    avatar?: DeprecatedAvatar;
+    /**
+     * @deprecated no longer needed, dropped in V2
+     *
+     * 每次访问是否**强制**拉取最新的*评论列表头像*
+     *
+     * Whether **force** pulling the latest avatar each time
+     *
+     * @default false
+     */
+    avatarForce?: boolean;
+    /**
+     * @deprecated Use `emojis` instead, 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, 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?: DeprecatedEmojiMaps;
+}
+
+interface DeprecatedWalineOptions {
+    /**
+     * @deprecated Please use mathjax in server, dropped in V2
+     *
+     * 是否注入额外的样式添加对 `<math>` 块的兼容
+     *
+     * Whether injecting additional styles to support math block
+     *
+     * @default false
+     */
+    mathTagSupport?: boolean;
+    /**
+     * @deprecated use `pageview` instead, dropped in V2
+     *
+     * 文章访问量统计
+     *
+     * Article reading statistics
+     *
+     * @default false
+     */
+    visitor?: boolean;
+    /**
+     * @deprecated use `highlighter` instead, dropped in V2
+     *
+     * 代码高亮
+     *
+     * Code highlighting
+     */
+    highlight?: WalineHighlighter | false;
+    /**
+     * @deprecated use `imageUploader` instead, dropped in V2
+     *
+     * 自定义图片上传方法，方便更好的存储图片
+     *
+     * 方法执行时会将图片对象传入。
+     *
+     * Custom image upload callback to manage picture by yourself.
+     *
+     * We will pass a picture file object when execute it.
+     */
+    uploadImage?: WalineImageUploader | false;
+    /**
+     * @deprecated Use `login` instead, 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;
+    /**
+     * @deprecated Please use `AVATAR_PROXY` in server, dropped in V2
+     *
+     * 设置 Gravatar 头像 CDN 地址
+     *
+     * Gravatar CDN baseURL
+     *
+     * @default 'https://www.gravatar.com/avatar'
+     */
+    avatarCDN?: string;
+    /**
+     * @deprecated Use `texRenderer` instead, dropped in V2
+     *
+     * 自定义 Tex 处理方法，用于预览。
+     *
+     * Custom math formula parse callback for preview.
+     */
+    previewMath?: WalineTexRenderer | false;
+    /**
+     * @deprecated use `copyright` instead, dropped in V2
+     *
+     * 是否在页脚展示版权信息
+     *
+     * 为了支持 Waline，我们强烈建议你开启它
+     *
+     * Whether show copyright in footer
+     *
+     * We strongly recommended you to keep it on to support waline
+     *
+     * @default true
+     */
+    copyRight?: boolean;
+}
+
+declare function legacyWaline(options: WalineInitOptions & DeprecatedValineOptions & DeprecatedWalineOptions): WalineInstance | null;
+
+export { WalineInstance, legacyWaline as default };