artalk 2.8.4 → 2.8.6

package/dist/main.d.cts

@@ -1,4 +1,5 @@
 import { marked } from 'marked';
+import { MarkedOptions } from 'marked';
 
 /**
  * 通用操作按钮
@@ -75,6 +76,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 +433,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
          *
@@ -1074,12 +1200,12 @@ declare interface ApiHandler<T extends PayloadKey = PayloadKey> {
 }
 
 declare interface ApiHandlerPayload {
-    'need_captcha': {
+    need_captcha: {
         img_data?: string;
         iframe?: string;
     };
-    'need_login': {};
-    'need_auth_login': {};
+    need_login: {};
+    need_auth_login: {};
 }
 
 declare interface ApiHandlers {
@@ -1225,6 +1351,8 @@ export declare interface ArtalkConfig {
     imgUpload: boolean;
     /** 图片上传器 */
     imgUploader?: (file: File) => Promise<string>;
+    /** Image lazy load */
+    imgLazyLoad?: 'native' | 'data-src';
     /** 版本检测 */
     versionCheck: boolean;
     /** 引用后端配置 */
@@ -1237,6 +1365,8 @@ export declare interface ArtalkConfig {
     pluginURLs?: string[];
     /** Replacer for marked */
     markedReplacers?: ((raw: string) => string)[];
+    /** Marked options */
+    markedOptions?: MarkedOptions;
     /** 列表请求参数修改器 */
     listFetchParamsModifier?: (params: any) => void;
     remoteConfModifier?: (conf: Partial<ArtalkConfig>) => void;
@@ -1282,6 +1412,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> {
@@ -1315,8 +1452,8 @@ declare interface CheckerCtx {
 declare class CheckerLauncher {
     private opts;
     constructor(opts: CheckerLauncherOptions);
-    checkCaptcha: ((payload: CheckerCaptchaPayload) => Promise<void>);
-    checkAdmin: ((payload: CheckerPayload) => Promise<void>);
+    checkCaptcha: (payload: CheckerCaptchaPayload) => Promise<void>;
+    checkAdmin: (payload: CheckerPayload) => Promise<void>;
     fire(checker: Checker, payload: CheckerPayload, postFire?: (c: CheckerCtx) => void): void;
 }
 
@@ -1731,8 +1868,8 @@ export declare interface EditorApi extends Component {
 }
 
 declare interface EditorEventPayloadMap {
-    'mounted': undefined;
-    'unmounted': undefined;
+    mounted: undefined;
+    unmounted: undefined;
     'header-input': {
         field: string;
         $input: HTMLInputElement;
@@ -1805,6 +1942,8 @@ declare const en: {
     placeholder: string;
     noComment: string;
     send: string;
+    signIn: string;
+    signUp: string;
     save: string;
     nick: string;
     email: string;
@@ -1858,7 +1997,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;
@@ -1988,10 +2145,10 @@ declare interface EventOptions {
 
 /** EventName to EventPayload Type */
 export declare interface EventPayloadMap {
-    'created': undefined;
-    'mounted': undefined;
-    'updated': ArtalkConfig;
-    'unmounted': undefined;
+    created: undefined;
+    mounted: undefined;
+    updated: ArtalkConfig;
+    unmounted: undefined;
     'list-fetch': Partial<ListFetchParams>;
     'list-fetched': ListFetchedArgs;
     'list-load': CommentData[];
@@ -2222,11 +2379,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 +2496,11 @@ declare interface HandlerResponseCommentUpdate {
     vote_up: number;
 }
 
+declare interface HandlerResponseConfAuthProviders {
+    anonymous: boolean;
+    providers: AuthAuthProviderInfo[];
+}
+
 declare interface HandlerResponseConfDomain {
     /** Is the domain trusted */
     is_trusted: boolean;
@@ -2626,7 +2824,7 @@ export declare interface NotifyData {
     read_link: string;
 }
 
-export declare type NotifyLevel = "i" | "s" | "w" | "e";
+export declare type NotifyLevel = 'i' | 's' | 'w' | 'e';
 
 export declare interface PageData {
     /** 页面 ID */
@@ -2808,6 +3006,7 @@ declare class SidebarLayer extends Component {
     private authCheck;
     private initLayer;
     private createIframe;
+    private getDarkMode;
     private iframeLoad;
 }
 

package/dist/main.d.ts

@@ -1,4 +1,5 @@
 import { marked } from 'marked';
+import { MarkedOptions } from 'marked';
 
 /**
  * 通用操作按钮
@@ -75,6 +76,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 +433,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
          *
@@ -1074,12 +1200,12 @@ declare interface ApiHandler<T extends PayloadKey = PayloadKey> {
 }
 
 declare interface ApiHandlerPayload {
-    'need_captcha': {
+    need_captcha: {
         img_data?: string;
         iframe?: string;
     };
-    'need_login': {};
-    'need_auth_login': {};
+    need_login: {};
+    need_auth_login: {};
 }
 
 declare interface ApiHandlers {
@@ -1225,6 +1351,8 @@ export declare interface ArtalkConfig {
     imgUpload: boolean;
     /** 图片上传器 */
     imgUploader?: (file: File) => Promise<string>;
+    /** Image lazy load */
+    imgLazyLoad?: 'native' | 'data-src';
     /** 版本检测 */
     versionCheck: boolean;
     /** 引用后端配置 */
@@ -1237,6 +1365,8 @@ export declare interface ArtalkConfig {
     pluginURLs?: string[];
     /** Replacer for marked */
     markedReplacers?: ((raw: string) => string)[];
+    /** Marked options */
+    markedOptions?: MarkedOptions;
     /** 列表请求参数修改器 */
     listFetchParamsModifier?: (params: any) => void;
     remoteConfModifier?: (conf: Partial<ArtalkConfig>) => void;
@@ -1282,6 +1412,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> {
@@ -1315,8 +1452,8 @@ declare interface CheckerCtx {
 declare class CheckerLauncher {
     private opts;
     constructor(opts: CheckerLauncherOptions);
-    checkCaptcha: ((payload: CheckerCaptchaPayload) => Promise<void>);
-    checkAdmin: ((payload: CheckerPayload) => Promise<void>);
+    checkCaptcha: (payload: CheckerCaptchaPayload) => Promise<void>;
+    checkAdmin: (payload: CheckerPayload) => Promise<void>;
     fire(checker: Checker, payload: CheckerPayload, postFire?: (c: CheckerCtx) => void): void;
 }
 
@@ -1731,8 +1868,8 @@ export declare interface EditorApi extends Component {
 }
 
 declare interface EditorEventPayloadMap {
-    'mounted': undefined;
-    'unmounted': undefined;
+    mounted: undefined;
+    unmounted: undefined;
     'header-input': {
         field: string;
         $input: HTMLInputElement;
@@ -1805,6 +1942,8 @@ declare const en: {
     placeholder: string;
     noComment: string;
     send: string;
+    signIn: string;
+    signUp: string;
     save: string;
     nick: string;
     email: string;
@@ -1858,7 +1997,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;
@@ -1988,10 +2145,10 @@ declare interface EventOptions {
 
 /** EventName to EventPayload Type */
 export declare interface EventPayloadMap {
-    'created': undefined;
-    'mounted': undefined;
-    'updated': ArtalkConfig;
-    'unmounted': undefined;
+    created: undefined;
+    mounted: undefined;
+    updated: ArtalkConfig;
+    unmounted: undefined;
     'list-fetch': Partial<ListFetchParams>;
     'list-fetched': ListFetchedArgs;
     'list-load': CommentData[];
@@ -2222,11 +2379,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 +2496,11 @@ declare interface HandlerResponseCommentUpdate {
     vote_up: number;
 }
 
+declare interface HandlerResponseConfAuthProviders {
+    anonymous: boolean;
+    providers: AuthAuthProviderInfo[];
+}
+
 declare interface HandlerResponseConfDomain {
     /** Is the domain trusted */
     is_trusted: boolean;
@@ -2626,7 +2824,7 @@ export declare interface NotifyData {
     read_link: string;
 }
 
-export declare type NotifyLevel = "i" | "s" | "w" | "e";
+export declare type NotifyLevel = 'i' | 's' | 'w' | 'e';
 
 export declare interface PageData {
     /** 页面 ID */
@@ -2808,6 +3006,7 @@ declare class SidebarLayer extends Component {
     private authCheck;
     private initLayer;
     private createIframe;
+    private getDarkMode;
     private iframeLoad;
 }