@waline/client 2.14.8 → 2.15.0

package/dist/legacy.umd.d.ts

@@ -371,6 +371,10 @@ interface WalineProps {
      * recaptcha v3 client key
      */
     recaptchaV3Key?: string;
+    /**
+     * turnstile client key
+     */
+    turnstileKey?: string;
     /**
      * reaction
      */
@@ -414,33 +418,93 @@ interface WalineInitOptions extends Omit<WalineProps, 'path'> {
     path?: string;
 }
 
-interface WalineInstance {
+interface DeprecatedWalineOptions {
     /**
-     * Waline 被挂载到的元素
+     * @deprecated Please use mathjax in server, dropped in V2
      *
-     * @description 当通过 `el: null` 初始化，值为 `null`
+     * 是否注入额外的样式添加对 `<math>` 块的兼容
      *
-     * Element where Waline is mounted
+     * Whether injecting additional styles to support math block
      *
-     * @description when initialized with `el: null`, it will be `null`
+     * @default false
      */
-    el: HTMLElement | null;
+    mathTagSupport?: boolean;
     /**
-     * 更新 Waline 实例
+     * @deprecated use `pageview` instead, dropped in V2
      *
-     * @description 只要不设置`path` 选项，更新时它就会被重置为 `windows.location.pathname`
+     * 文章访问量统计
      *
-     * Update Waline instance
+     * Article reading statistics
      *
-     * @description when not setting `path` option, it will be reset to `window.location.pathname`
+     * @default false
      */
-    update: (newOptions?: Partial<Omit<WalineInitOptions, 'el'>>) => void;
+    visitor?: boolean;
     /**
-     * 取消挂载并摧毁 Waline 实例
+     * @deprecated use `highlighter` instead, dropped in V2
      *
-     * Unmount and destroy Waline instance
+     * 代码高亮
+     *
+     * Code highlighting
      */
-    destroy: () => void;
+    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;
 }
 
 type DeprecatedAvatar = '' | 'mp' | 'identicon' | 'monsterid' | 'wavatar' | 'retro' | 'robohash' | 'hide';
@@ -530,93 +594,33 @@ interface DeprecatedValineOptions {
     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;
+interface WalineInstance {
     /**
-     * @deprecated Use `login` instead, dropped in V2
-     *
-     * 是否允许登录评论
-     *
-     * 默认情况是两者都支持，设置为 `true` 表示仅支持匿名评论，`false` 表示仅支持登录评论。
+     * Waline 被挂载到的元素
      *
-     * Whether to allow login comments.
+     * @description 当通过 `el: null` 初始化，值为 `null`
      *
-     * Both supported by default, set to `true` means only support anonymous comments, `false` means only support login comments.
+     * Element where Waline is mounted
      *
-     * @default undefined
+     * @description when initialized with `el: null`, it will be `null`
      */
-    anonymous?: boolean;
+    el: HTMLElement | null;
     /**
-     * @deprecated Please use `AVATAR_PROXY` in server, dropped in V2
-     *
-     * 设置 Gravatar 头像 CDN 地址
-     *
-     * Gravatar CDN baseURL
+     * 更新 Waline 实例
      *
-     * @default 'https://www.gravatar.com/avatar'
-     */
-    avatarCDN?: string;
-    /**
-     * @deprecated Use `texRenderer` instead, dropped in V2
+     * @description 只要不设置`path` 选项，更新时它就会被重置为 `windows.location.pathname`
      *
-     * 自定义 Tex 处理方法，用于预览。
+     * Update Waline instance
      *
-     * Custom math formula parse callback for preview.
+     * @description when not setting `path` option, it will be reset to `window.location.pathname`
      */
-    previewMath?: WalineTexRenderer | false;
+    update: (newOptions?: Partial<Omit<WalineInitOptions, 'el'>>) => void;
     /**
-     * @deprecated use `copyright` instead, dropped in V2
-     *
-     * 是否在页脚展示版权信息
-     *
-     * 为了支持 Waline，我们强烈建议你开启它
-     *
-     * Whether show copyright in footer
-     *
-     * We strongly recommended you to keep it on to support waline
+     * 取消挂载并摧毁 Waline 实例
      *
-     * @default true
+     * Unmount and destroy Waline instance
      */
-    copyRight?: boolean;
+    destroy: () => void;
 }
 
 declare function legacyWaline(options: WalineInitOptions & DeprecatedValineOptions & DeprecatedWalineOptions): WalineInstance | null;