@waline/client 2.11.2 → 2.12.0

package/dist/shim.d.cts

@@ -37,39 +37,64 @@ interface WalineEmojiInfo {
     items: string[];
 }
 declare type WalineEmojiMaps = Record<string, string>;
-interface WalineSearchResult extends Record<string, unknown> {
+interface WalineSearchImageData extends Record<string, unknown> {
     /**
+     * 图片链接
+     *
      * Image link
      */
     src: string;
     /**
-     * Image title, optional
+     * 图片标题
+     *
+     * @description 用于图片的 alt 属性
+     *
+     * Image title
+     *
+     * @description Used for alt attribute of image
      */
     title?: string;
     /**
-     * Image preview link, optional
+     * 图片缩略图
+     *
+     * @description 为了更好的加载性能，我们会优先在列表中使用此缩略图
+     *
+     * Image preview link
+     *
+     * @description For better loading performance, we will use this thumbnail first in the list
      *
      * @default src
      */
     preview?: string;
 }
+declare type WalineSearchResult = WalineSearchImageData[];
 interface WalineSearchOptions {
     /**
+     * 搜索操作
+     *
      * Search action
      */
-    search: (word: string) => Promise<WalineSearchResult[]>;
+    search: (word: string) => Promise<WalineSearchResult>;
     /**
-     * Default search action
+     * 打开列表时展示的默认结果
+     *
+     * Default result when opening list
      *
      * @default () => search('')
      */
-    default?: () => Promise<WalineSearchResult[]>;
+    default?: () => Promise<WalineSearchResult>;
     /**
+     * 获取更多的操作
+     *
+     * @description 会在列表滚动到底部时触发，如果你的搜索服务支持分页功能，你应该设置此项实现无限滚动
+     *
      * Fetch more action
      *
+     * @description It will be triggered when the list scrolls to the bottom. If your search service supports paging, you should set this to achieve infinite scrolling
+     *
      * @default (word) => search(word)
      */
-    more?: (word: string, currectCount: number) => Promise<WalineSearchResult[]>;
+    more?: (word: string, currectCount: number) => Promise<WalineSearchResult>;
 }
 declare type WalineMeta = 'nick' | 'mail' | 'link';
 declare type WalineImageUploader = (image: File) => Promise<string>;
@@ -160,37 +185,37 @@ interface WalineDateLocale {
     now: string;
 }
 declare type WalineLevelLocale = Record<`level${number}`, string>;
-interface WalineLocale extends WalineDateLocale, WalineLevelLocale {
+interface WalineReactionLocale {
+    reactionTitle: string;
+    reaction0: string;
+    reaction1: string;
+    reaction2: string;
+    reaction3: string;
+    reaction4: string;
+    reaction5: string;
+    reaction6: string;
+    reaction7: string;
+    reaction8: string;
+}
+interface WalineLocale extends WalineDateLocale, WalineLevelLocale, WalineReactionLocale {
     nick: string;
-    nickError: string;
     mail: string;
-    mailError: string;
     link: string;
     optional: string;
     placeholder: string;
     sofa: string;
     submit: string;
-    like: string;
-    cancelLike: string;
-    reply: string;
-    cancelReply: string;
     comment: string;
     refresh: string;
     more: string;
-    preview: string;
-    emoji: string;
-    uploadImage: string;
     uploading: string;
     login: string;
-    logout: string;
     admin: string;
     sticky: string;
     word: string;
-    wordHint: string;
     anonymous: string;
     gif: string;
     gifSearchPlaceholder: string;
-    profile: string;
     approved: string;
     waiting: string;
     spam: string;
@@ -198,16 +223,18 @@ interface WalineLocale extends WalineDateLocale, WalineLevelLocale {
     oldest: string;
     latest: string;
     hottest: string;
-    reactionTitle: string;
-    reaction0: string;
-    reaction1: string;
-    reaction2: string;
-    reaction3: string;
-    reaction4: string;
-    reaction5: string;
-    reaction6: string;
-    reaction7: string;
-    reaction8: string;
+    nickError: string;
+    mailError: string;
+    wordHint: string;
+    like: string;
+    cancelLike: string;
+    reply: string;
+    cancelReply: string;
+    preview: string;
+    emoji: string;
+    uploadImage: string;
+    profile: string;
+    logout: string;
 }
 
 interface WalineProps {
@@ -601,4 +628,4 @@ interface WalineRecentCommentsResult {
 }
 declare const RecentComments: ({ el, serverURL, count, lang, }: WalineRecentCommentsOptions) => Promise<WalineRecentCommentsResult>;
 
-export { RecentComments, WalineAbort, WalineComment, WalineCommentCountOptions, WalineCommentData, WalineCommentStatus, WalineDateLocale, WalineEmojiInfo, WalineEmojiMaps, WalineHighlighter, WalineImageUploader, WalineInitOptions, WalineInstance, WalineLevelLocale, WalineLocale, WalineMeta, WalinePageviewCountOptions, WalineProps, WalineRecentCommentsOptions, WalineRecentCommentsResult, WalineSearchOptions, WalineSearchResult, WalineTexRenderer, commentCount, defaultLocales, init, pageviewCount, version };
+export { RecentComments, WalineAbort, WalineComment, WalineCommentCountOptions, WalineCommentData, WalineCommentStatus, WalineDateLocale, WalineEmojiInfo, WalineEmojiMaps, WalineHighlighter, WalineImageUploader, WalineInitOptions, WalineInstance, WalineLevelLocale, WalineLocale, WalineMeta, WalinePageviewCountOptions, WalineProps, WalineReactionLocale, WalineRecentCommentsOptions, WalineRecentCommentsResult, WalineSearchImageData, WalineSearchOptions, WalineSearchResult, WalineTexRenderer, commentCount, defaultLocales, init, pageviewCount, version };

package/dist/shim.d.mts

@@ -37,39 +37,64 @@ interface WalineEmojiInfo {
     items: string[];
 }
 declare type WalineEmojiMaps = Record<string, string>;
-interface WalineSearchResult extends Record<string, unknown> {
+interface WalineSearchImageData extends Record<string, unknown> {
     /**
+     * 图片链接
+     *
      * Image link
      */
     src: string;
     /**
-     * Image title, optional
+     * 图片标题
+     *
+     * @description 用于图片的 alt 属性
+     *
+     * Image title
+     *
+     * @description Used for alt attribute of image
      */
     title?: string;
     /**
-     * Image preview link, optional
+     * 图片缩略图
+     *
+     * @description 为了更好的加载性能，我们会优先在列表中使用此缩略图
+     *
+     * Image preview link
+     *
+     * @description For better loading performance, we will use this thumbnail first in the list
      *
      * @default src
      */
     preview?: string;
 }
+declare type WalineSearchResult = WalineSearchImageData[];
 interface WalineSearchOptions {
     /**
+     * 搜索操作
+     *
      * Search action
      */
-    search: (word: string) => Promise<WalineSearchResult[]>;
+    search: (word: string) => Promise<WalineSearchResult>;
     /**
-     * Default search action
+     * 打开列表时展示的默认结果
+     *
+     * Default result when opening list
      *
      * @default () => search('')
      */
-    default?: () => Promise<WalineSearchResult[]>;
+    default?: () => Promise<WalineSearchResult>;
     /**
+     * 获取更多的操作
+     *
+     * @description 会在列表滚动到底部时触发，如果你的搜索服务支持分页功能，你应该设置此项实现无限滚动
+     *
      * Fetch more action
      *
+     * @description It will be triggered when the list scrolls to the bottom. If your search service supports paging, you should set this to achieve infinite scrolling
+     *
      * @default (word) => search(word)
      */
-    more?: (word: string, currectCount: number) => Promise<WalineSearchResult[]>;
+    more?: (word: string, currectCount: number) => Promise<WalineSearchResult>;
 }
 declare type WalineMeta = 'nick' | 'mail' | 'link';
 declare type WalineImageUploader = (image: File) => Promise<string>;
@@ -160,37 +185,37 @@ interface WalineDateLocale {
     now: string;
 }
 declare type WalineLevelLocale = Record<`level${number}`, string>;
-interface WalineLocale extends WalineDateLocale, WalineLevelLocale {
+interface WalineReactionLocale {
+    reactionTitle: string;
+    reaction0: string;
+    reaction1: string;
+    reaction2: string;
+    reaction3: string;
+    reaction4: string;
+    reaction5: string;
+    reaction6: string;
+    reaction7: string;
+    reaction8: string;
+}
+interface WalineLocale extends WalineDateLocale, WalineLevelLocale, WalineReactionLocale {
     nick: string;
-    nickError: string;
     mail: string;
-    mailError: string;
     link: string;
     optional: string;
     placeholder: string;
     sofa: string;
     submit: string;
-    like: string;
-    cancelLike: string;
-    reply: string;
-    cancelReply: string;
     comment: string;
     refresh: string;
     more: string;
-    preview: string;
-    emoji: string;
-    uploadImage: string;
     uploading: string;
     login: string;
-    logout: string;
     admin: string;
     sticky: string;
     word: string;
-    wordHint: string;
     anonymous: string;
     gif: string;
     gifSearchPlaceholder: string;
-    profile: string;
     approved: string;
     waiting: string;
     spam: string;
@@ -198,16 +223,18 @@ interface WalineLocale extends WalineDateLocale, WalineLevelLocale {
     oldest: string;
     latest: string;
     hottest: string;
-    reactionTitle: string;
-    reaction0: string;
-    reaction1: string;
-    reaction2: string;
-    reaction3: string;
-    reaction4: string;
-    reaction5: string;
-    reaction6: string;
-    reaction7: string;
-    reaction8: string;
+    nickError: string;
+    mailError: string;
+    wordHint: string;
+    like: string;
+    cancelLike: string;
+    reply: string;
+    cancelReply: string;
+    preview: string;
+    emoji: string;
+    uploadImage: string;
+    profile: string;
+    logout: string;
 }
 
 interface WalineProps {
@@ -601,4 +628,4 @@ interface WalineRecentCommentsResult {
 }
 declare const RecentComments: ({ el, serverURL, count, lang, }: WalineRecentCommentsOptions) => Promise<WalineRecentCommentsResult>;
 
-export { RecentComments, WalineAbort, WalineComment, WalineCommentCountOptions, WalineCommentData, WalineCommentStatus, WalineDateLocale, WalineEmojiInfo, WalineEmojiMaps, WalineHighlighter, WalineImageUploader, WalineInitOptions, WalineInstance, WalineLevelLocale, WalineLocale, WalineMeta, WalinePageviewCountOptions, WalineProps, WalineRecentCommentsOptions, WalineRecentCommentsResult, WalineSearchOptions, WalineSearchResult, WalineTexRenderer, commentCount, defaultLocales, init, pageviewCount, version };
+export { RecentComments, WalineAbort, WalineComment, WalineCommentCountOptions, WalineCommentData, WalineCommentStatus, WalineDateLocale, WalineEmojiInfo, WalineEmojiMaps, WalineHighlighter, WalineImageUploader, WalineInitOptions, WalineInstance, WalineLevelLocale, WalineLocale, WalineMeta, WalinePageviewCountOptions, WalineProps, WalineReactionLocale, WalineRecentCommentsOptions, WalineRecentCommentsResult, WalineSearchImageData, WalineSearchOptions, WalineSearchResult, WalineTexRenderer, commentCount, defaultLocales, init, pageviewCount, version };