artalk 2.8.5 → 2.8.7

package/dist/main.d.ts

@@ -1,5 +1,3 @@
-import { marked } from 'marked';
-
 /**
  * 通用操作按钮
  */
@@ -8,7 +6,7 @@ declare class ActionBtn {
     $el: HTMLElement;
     isLoading: boolean;
     msgRecTimer?: number;
-    msgRecTimerFunc?: Function;
+    msgRecTimerFunc?: () => void;
     get isMessaging(): boolean;
     isConfirming: boolean;
     confirmRecTimer?: number;
@@ -19,7 +17,7 @@ declare class ActionBtn {
     /** 获取按钮文字（动态/静态） */
     private getText;
     /** 设置点击事件 */
-    setClick(func: Function): void;
+    setClick(func: () => void): void;
     /** 文字刷新（动态/静态） */
     updateText(text?: (() => string) | string): void;
     /** 设置加载状态 */
@@ -31,7 +29,7 @@ declare class ActionBtn {
     /** 成功消息 */
     setSuccess(text: string): void;
     /** 设置消息 */
-    setMsg(text: string, className?: string, duringTime?: number, after?: Function): void;
+    setMsg(text: string, className?: string, duringTime?: number, after?: () => void): void;
     /** 设置消息复原操作定时器 */
     private setMsgRecTimer;
     /** 立刻触发器复原定时器 */
@@ -75,6 +73,115 @@ declare class Api extends Api_2<void> {
  * Artalk is a modern comment system based on Golang.
  */
 declare class Api_2<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
+    auth: {
+        /**
+         * @description Login by email with verify code (Need send email verify code first) or password
+         *
+         * @tags Auth
+         * @name LoginByEmail
+         * @summary Login by email
+         * @request POST:/auth/email/login
+         * @response `200` `HandlerResponseUserLogin` OK
+         * @response `400` `(HandlerMap & {
+         msg?: string,
+
+         })` Bad Request
+         * @response `500` `(HandlerMap & {
+         msg?: string,
+
+         })` Internal Server Error
+         */
+        loginByEmail: (data: HandlerRequestAuthEmailLogin, params?: RequestParams) => Promise<HttpResponse<HandlerResponseUserLogin, HandlerMap & {
+            msg?: string | undefined;
+        }>>;
+        /**
+         * @description Register by email and verify code (if user exists, will update user, like forget password. Need send email verify code first)
+         *
+         * @tags Auth
+         * @name RegisterByEmail
+         * @summary Register by email
+         * @request POST:/auth/email/register
+         * @response `200` `HandlerResponseUserLogin` OK
+         * @response `400` `(HandlerMap & {
+         msg?: string,
+
+         })` Bad Request
+         * @response `500` `(HandlerMap & {
+         msg?: string,
+
+         })` Internal Server Error
+         */
+        registerByEmail: (data: HandlerRequestAuthEmailRegister, params?: RequestParams) => Promise<HttpResponse<HandlerResponseUserLogin, HandlerMap & {
+            msg?: string | undefined;
+        }>>;
+        /**
+         * @description Send email including verify code to user
+         *
+         * @tags Auth
+         * @name SendVerifyEmail
+         * @summary Send verify email
+         * @request POST:/auth/email/send
+         * @response `200` `(HandlerMap & {
+         msg?: string,
+
+         })` OK
+         * @response `400` `(HandlerMap & {
+         msg?: string,
+
+         })` Bad Request
+         * @response `500` `(HandlerMap & {
+         msg?: string,
+
+         })` Internal Server Error
+         */
+        sendVerifyEmail: (data: HandlerRequestAuthEmailSend, params?: RequestParams) => Promise<HttpResponse<HandlerMap & {
+            msg?: string | undefined;
+        }, HandlerMap & {
+            msg?: string | undefined;
+        }>>;
+        /**
+         * @description Get all users with same email, if there are more than one user with same email, need merge
+         *
+         * @tags Auth
+         * @name CheckDataMerge
+         * @summary Check data merge
+         * @request GET:/auth/merge
+         * @secure
+         * @response `200` `HandlerResponseAuthDataMergeCheck` OK
+         * @response `400` `(HandlerMap & {
+         msg?: string,
+
+         })` Bad Request
+         * @response `500` `(HandlerMap & {
+         msg?: string,
+
+         })` Internal Server Error
+         */
+        checkDataMerge: (params?: RequestParams) => Promise<HttpResponse<HandlerResponseAuthDataMergeCheck, HandlerMap & {
+            msg?: string | undefined;
+        }>>;
+        /**
+         * @description This function is to solve the problem of multiple users with the same email address, should be called after user login and then check, and perform data merge.
+         *
+         * @tags Auth
+         * @name ApplyDataMerge
+         * @summary Apply data merge
+         * @request POST:/auth/merge
+         * @secure
+         * @response `200` `HandlerResponseAuthDataMergeApply` OK
+         * @response `400` `(HandlerMap & {
+         msg?: string,
+
+         })` Bad Request
+         * @response `500` `(HandlerMap & {
+         msg?: string,
+
+         })` Internal Server Error
+         */
+        applyDataMerge: (data: HandlerRequestAuthDataMergeApply, params?: RequestParams) => Promise<HttpResponse<HandlerResponseAuthDataMergeApply, HandlerMap & {
+            msg?: string | undefined;
+        }>>;
+    };
     cache: {
         /**
          * @description Flush all cache on the server
@@ -323,6 +430,22 @@ declare class Api_2<SecurityDataType extends unknown> extends HttpClient<Securit
          * @response `200` `CommonConfData` OK
          */
         conf: (params?: RequestParams) => Promise<HttpResponse<CommonConfData, any>>;
+        /**
+         * @description Get social login providers
+         *
+         * @tags System
+         * @name GetSocialLoginProviders
+         * @summary Get Social Login Providers
+         * @request GET:/conf/auth/providers
+         * @response `200` `HandlerResponseConfAuthProviders` OK
+         * @response `404` `(HandlerMap & {
+         msg?: string,
+
+         })` Not Found
+         */
+        getSocialLoginProviders: (params?: RequestParams) => Promise<HttpResponse<HandlerResponseConfAuthProviders, HandlerMap & {
+            msg?: string | undefined;
+        }>>;
         /**
          * @description Get Domain Info
          *
@@ -1078,8 +1201,8 @@ declare interface ApiHandlerPayload {
         img_data?: string;
         iframe?: string;
     };
-    need_login: {};
-    need_auth_login: {};
+    need_login: object;
+    need_auth_login: object;
 }
 
 declare interface ApiHandlers {
@@ -1207,6 +1330,8 @@ export declare interface ArtalkConfig {
     countEl: string;
     /** PV 数绑定元素 Selector */
     pvEl: string;
+    /** 统计组件 PageKey 属性名 */
+    statPageKeyAttr: string;
     /** 夜间模式 */
     darkMode: boolean | 'auto';
     /** 请求超时（单位：秒） */
@@ -1225,6 +1350,8 @@ export declare interface ArtalkConfig {
     imgUpload: boolean;
     /** 图片上传器 */
     imgUploader?: (file: File) => Promise<string>;
+    /** Image lazy load */
+    imgLazyLoad?: 'native' | 'data-src';
     /** 版本检测 */
     versionCheck: boolean;
     /** 引用后端配置 */
@@ -1237,6 +1364,8 @@ export declare interface ArtalkConfig {
     pluginURLs?: string[];
     /** Replacer for marked */
     markedReplacers?: ((raw: string) => string)[];
+    /** Marked options */
+    markedOptions?: any;
     /** 列表请求参数修改器 */
     listFetchParamsModifier?: (params: any) => void;
     remoteConfModifier?: (conf: Partial<ArtalkConfig>) => void;
@@ -1282,6 +1411,13 @@ declare namespace ArtalkType {
 }
 export { ArtalkType }
 
+declare interface AuthAuthProviderInfo {
+    icon: string;
+    label: string;
+    name: string;
+    path?: string;
+}
+
 declare type CancelToken = Symbol | string | number;
 
 declare interface Checker<T = any> {
@@ -1483,7 +1619,7 @@ declare type CommentNode_2 = {
 
 declare interface CommentOptions {
     onAfterRender?: () => void;
-    onDelete?: Function;
+    onDelete?: (c: CommentNode) => void;
     /** The comment being replied to (linked comment) */
     replyTo?: CommentData;
     flatMode: boolean;
@@ -1548,7 +1684,7 @@ export declare interface ContextApi extends EventManagerFuncs<EventPayloadMap> {
     /** 配置对象 */
     conf: ArtalkConfig;
     /** marked 依赖对象 */
-    getMarked(): TMarked | undefined;
+    getMarked(): any | undefined;
     /** 获取 API 以供 HTTP 请求 */
     getApi(): Api;
     /** Get API handlers */
@@ -1805,6 +1941,8 @@ declare const en: {
     placeholder: string;
     noComment: string;
     send: string;
+    signIn: string;
+    signUp: string;
     save: string;
     nick: string;
     email: string;
@@ -1858,7 +1996,25 @@ declare const en: {
     cancel: string;
     msgCenter: string;
     ctrlCenter: string;
+    noAccountPrompt: string;
+    haveAccountPrompt: string;
+    forgetPassword: string;
+    resetPassword: string;
+    verificationCode: string;
+    verifySend: string;
+    verifyResend: string;
+    waitSeconds: string;
     emailVerified: string;
+    password: string;
+    username: string;
+    nextStep: string;
+    skipNotVerify: string;
+    logoutConfirm: string;
+    accountMergeNotice: string;
+    accountMergeSelectOne: string;
+    accountMergeConfirm: string;
+    dismiss: string;
+    merge: string;
     frontend: string;
     backend: string;
     loading: string;
@@ -1914,6 +2070,7 @@ declare interface EntityCookedNotify {
 
 declare interface EntityCookedPage {
     admin_only: boolean;
+    date: string;
     id: number;
     key: string;
     pv: number;
@@ -2154,7 +2311,7 @@ declare interface HandlerParamsSiteUpdate {
 }
 
 declare interface HandlerParamsTransferImport {
-    /** Automatically answer yes for all questions. */
+    /** Automatically answer yes for all questions */
     assumeyes?: boolean;
     /** The JSON data */
     json_data?: string;
@@ -2164,6 +2321,8 @@ declare interface HandlerParamsTransferImport {
     target_site_name?: string;
     /** The target site url */
     target_site_url?: string;
+    /** Keep domain */
+    url_keep_domain?: boolean;
     /** Enable URL resolver */
     url_resolver?: boolean;
 }
@@ -2222,11 +2381,47 @@ declare interface HandlerParamsVote {
     name?: string;
 }
 
+declare interface HandlerRequestAuthDataMergeApply {
+    user_name: string;
+}
+
+declare interface HandlerRequestAuthEmailLogin {
+    code?: string;
+    email: string;
+    password?: string;
+}
+
+declare interface HandlerRequestAuthEmailRegister {
+    code: string;
+    email: string;
+    link?: string;
+    name?: string;
+    password: string;
+}
+
+declare interface HandlerRequestAuthEmailSend {
+    email: string;
+}
+
 declare interface HandlerResponseAdminUserList {
     count: number;
     users: EntityCookedUserForAdmin[];
 }
 
+declare interface HandlerResponseAuthDataMergeApply {
+    deleted_user_count: number;
+    update_comments_count: number;
+    update_notifies_count: number;
+    update_votes_count: number;
+    /** Empty if login user is target user no need to re-login */
+    user_token: string;
+}
+
+declare interface HandlerResponseAuthDataMergeCheck {
+    need_merge: boolean;
+    user_names: string[];
+}
+
 declare interface HandlerResponseCaptchaGet {
     img_data: string;
 }
@@ -2303,6 +2498,11 @@ declare interface HandlerResponseCommentUpdate {
     vote_up: number;
 }
 
+declare interface HandlerResponseConfAuthProviders {
+    anonymous: boolean;
+    providers: AuthAuthProviderInfo[];
+}
+
 declare interface HandlerResponseConfDomain {
     /** Is the domain trusted */
     is_trusted: boolean;
@@ -2317,6 +2517,7 @@ declare interface HandlerResponseNotifyList {
 
 declare interface HandlerResponsePageFetch {
     admin_only: boolean;
+    date: string;
     id: number;
     key: string;
     pv: number;
@@ -2349,6 +2550,7 @@ declare interface HandlerResponsePagePV {
 
 declare interface HandlerResponsePageUpdate {
     admin_only: boolean;
+    date: string;
     id: number;
     key: string;
     pv: number;
@@ -2808,6 +3010,7 @@ declare class SidebarLayer extends Component {
     private authCheck;
     private initLayer;
     private createIframe;
+    private getDarkMode;
     private iframeLoad;
 }
 
@@ -2838,8 +3041,6 @@ declare type TKeysOnlyReturn<T extends TObjectWithFuncs, V> = {
     [K in keyof T]: ReturnType<T[K]> extends V ? K : never;
 }[keyof T];
 
-declare type TMarked = typeof marked;
-
 declare type TObjectWithFuncs = {
     [k: string]: (...args: any) => any;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "artalk",
-  "version": "2.8.5",
+  "version": "2.8.7",
   "description": "A self-hosted comment system",
   "keywords": [
     "comment-system",
@@ -105,22 +105,20 @@
     "abortcontroller-polyfill": "^1.7.5",
     "hanabi": "^0.4.0",
     "insane": "^2.6.2",
-    "marked": "^12.0.1"
+    "marked": "^12.0.2"
   },
   "scripts": {
-    "build": "vite build && pnpm build:lite && pnpm build:i18n",
+    "dev": "vite",
+    "build": "pnpm build:main && pnpm build:lite && pnpm build:i18n",
+    "build:main": "tsc --noEmit && vite build",
     "build:lite": "cross-env ARTALK_LITE=1 vite build",
     "build:i18n": "tsx scripts/build-i18n.ts",
-    "copy:deploy": "cp -r dist deploy && cp CNAME deploy",
-    "predeploy": "pnpm build && pnpm build:demo && pnpm copy:deploy",
-    "deploy": "gh-pages -d deploy",
-    "dev": "vite",
+    "preview": "vite preview",
     "test": "vitest",
     "coverage": "vitest run --coverage",
-    "lint": "eslint './src/**/*.{js,ts}'",
-    "attw": "pnpx @arethetypeswrong/cli --pack .",
-    "serve": "vite preview",
     "test:e2e": "playwright test",
-    "test:report": "playwright show-report"
+    "test:e2e-report": "playwright show-report",
+    "test:attw": "pnpx @arethetypeswrong/cli --pack .",
+    "lint": "eslint ."
   }
 }