@waline/client 2.3.0 → 2.4.0

package/dist/waline.cjs.d.ts

@@ -39,24 +39,61 @@ interface WalineEmojiInfo {
 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 WalineHighlighter = (code: string, lang: string) => string;
 declare type WalineTexRenderer = (blockMode: boolean, tex: string) => string;
 
 interface WalineCommentData {
+    /**
+     * User Nickname
+     */
     nick: string;
+    /**
+     * User email
+     */
     mail: string;
+    /**
+     * User link
+     */
     link?: string;
+    /**
+     * Content of comment
+     */
     comment: string;
+    /**
+     * User Agent
+     */
     ua: string;
+    /**
+     * Parent comment id
+     */
     pid?: string;
+    /**
+     * Root comment id
+     */
     rid?: string;
+    /**
+     * User id being at
+     */
     at?: string;
+    /**
+     * Comment link
+     */
     url: string;
 }
+declare type WalineCommentStatus = 'approved' | 'waiting' | 'spam';
 interface WalineComment extends Exclude<WalineCommentData, 'ua'> {
+    /**
+     * User avatar
+     */
     avatar: string;
-    type?: string;
+    /**
+     * User type
+     */
+    type?: 'administrator' | 'guest' | `verify:${string}`;
     objectId: string;
+    /**
+     * Time ISOString when the comment is created
+     */
     createdAt: string;
     insertedAt: string;
     updatedAt: string;
@@ -67,6 +104,9 @@ interface WalineComment extends Exclude<WalineCommentData, 'ua'> {
     level?: number;
     addr?: string;
     label?: string;
+    user_id?: string | number;
+    status?: WalineCommentStatus;
+    like?: number;
 }
 
 interface WalineDateLocale {
@@ -76,14 +116,7 @@ interface WalineDateLocale {
     days: string;
     now: string;
 }
-interface WalineLevelLocale {
-    level0: string;
-    level1: string;
-    level2: string;
-    level3: string;
-    level4: string;
-    level5: string;
-}
+declare type WalineLevelLocale = Record<`level${number}`, string>;
 interface WalineLocale extends WalineDateLocale, WalineLevelLocale {
     nick: string;
     nickError: string;
@@ -94,6 +127,8 @@ interface WalineLocale extends WalineDateLocale, WalineLevelLocale {
     placeholder: string;
     sofa: string;
     submit: string;
+    like: string;
+    cancelLike: string;
     reply: string;
     cancelReply: string;
     comment: string;
@@ -489,4 +524,4 @@ interface WalineRecentCommentsResult {
 }
 declare const RecentComments: ({ el, serverURL, count, lang, }: WalineRecentCommentsOptions) => Promise<WalineRecentCommentsResult>;
 
-export { RecentComments, WalineAbort, WalineComment, WalineCommentCountOptions, WalineCommentData, WalineDateLocale, WalineEmojiInfo, WalineEmojiMaps, WalineHighlighter, WalineImageUploader, WalineInitOptions, WalineInstance, WalineLevelLocale, WalineLocale, WalineMeta, WalinePageviewCountOptions, WalineProps, WalineRecentCommentsOptions, WalineRecentCommentsResult, 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, WalineRecentCommentsOptions, WalineRecentCommentsResult, WalineTexRenderer, commentCount, defaultLocales, init, pageviewCount, version };