@waline/client 2.13.0 → 2.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waline/client",
-  "version": "2.13.0",
+  "version": "2.14.0",
   "description": "client for waline comment system",
   "keywords": [
     "valine",
@@ -93,17 +93,6 @@
     "dist",
     "src"
   ],
-  "scripts": {
-    "build": "pnpm rollup && pnpm style",
-    "clean": "rimraf ./dist",
-    "dev": "vite -c config/vite.config.js",
-    "lint": "eslint --ext .ts,.vue .",
-    "prepublishOnly": "pnpm clean && pnpm build",
-    "rollup": "rollup -c ./config/rollup.config.js",
-    "style": "pnpm style:main && pnpm style:meta",
-    "style:main": "sass ./src/styles/index.scss ./dist/waline.css --style=compressed",
-    "style:meta": "sass ./src/styles/meta.scss ./dist/waline-meta.css --style=compressed"
-  },
   "browserslist": {
     "production": [
       ">0.5%",
@@ -119,33 +108,43 @@
     ]
   },
   "dependencies": {
-    "@vueuse/core": "^9.3.0",
+    "@vueuse/core": "^9.5.0",
     "autosize": "^5.0.1",
-    "marked": "^4.1.1",
-    "vue": "^3.2.40"
+    "marked": "^4.2.2",
+    "vue": "^3.2.45"
   },
   "devDependencies": {
-    "@babel/core": "7.19.3",
-    "@babel/preset-env": "7.19.3",
+    "@babel/core": "7.20.2",
+    "@babel/preset-env": "7.20.2",
     "@giphy/js-types": "4.2.1",
-    "@rollup/plugin-babel": "5.3.1",
-    "@rollup/plugin-commonjs": "22.0.2",
-    "@rollup/plugin-node-resolve": "14.1.0",
-    "@rollup/plugin-replace": "4.0.0",
+    "@rollup/plugin-babel": "6.0.2",
+    "@rollup/plugin-commonjs": "23.0.2",
+    "@rollup/plugin-node-resolve": "15.0.1",
+    "@rollup/plugin-replace": "5.0.1",
+    "@rollup/plugin-terser": "0.1.0",
     "@types/autosize": "4.0.1",
     "@types/marked": "4.0.7",
-    "@types/node": "18.8.2",
-    "@vitejs/plugin-vue": "3.1.2",
+    "@types/node": "18.11.9",
+    "@vitejs/plugin-vue": "3.2.0",
     "recaptcha-v3": "1.10.0",
     "rimraf": "3.0.2",
-    "rollup": "2.79.1",
-    "rollup-plugin-dts": "4.2.2",
-    "rollup-plugin-terser": "7.0.2",
+    "rollup": "3.3.0",
+    "rollup-plugin-dts": "5.0.0",
     "rollup-plugin-ts": "3.0.2",
-    "typescript": "4.8.4",
-    "vite": "3.1.4"
+    "typescript": "4.9.3",
+    "vite": "3.2.4"
   },
   "engines": {
     "node": ">=14"
+  },
+  "scripts": {
+    "build": "pnpm rollup && pnpm style",
+    "clean": "rimraf ./dist",
+    "dev": "vite -c config/vite.config.js",
+    "lint": "eslint --ext .ts,.vue .",
+    "rollup": "rollup -c ./config/rollup.config.mjs",
+    "style": "pnpm style:main && pnpm style:meta",
+    "style:main": "sass ./src/styles/index.scss ./dist/waline.css --style=compressed",
+    "style:meta": "sass ./src/styles/meta.scss ./dist/waline-meta.css --style=compressed"
   }
-}
+}

package/src/api/articleCounter.ts

@@ -1,39 +1,71 @@
-import { JSON_HEADERS, errorCheck } from './utils';
+import { JSON_HEADERS } from './utils';
+import type { BaseAPIOptions } from './utils';
 
-export interface FetchArticleCounterOptions {
-  serverURL: string;
-  lang: string;
+export interface GetArticleCounterOptions extends BaseAPIOptions {
+  /**
+   * 待获取计数器的 path
+   *
+   * Path of counters
+   */
   paths: string[];
-  signal: AbortSignal;
+
+  /**
+   * 待获取计数器的类型
+   *
+   * Counter type to be fetched
+   */
   type: string[];
+
+  /**
+   * 取消请求的信号
+   *
+   * AbortSignal to cancel request
+   */
+  signal?: AbortSignal;
 }
 
-export const fetchArticleCounter = ({
+export type GetArticleCounterResponse =
+  | Record<string, number>[]
+  | Record<string, number>
+  | number[]
+  | number;
+
+export const getArticleCounter = ({
   serverURL,
   lang,
   paths,
   type,
   signal,
-}: FetchArticleCounterOptions): Promise<
-  Record<string, number>[] | Record<string, number> | number[] | number
-> =>
+}: GetArticleCounterOptions): Promise<GetArticleCounterResponse> =>
   fetch(
     `${serverURL}/article?path=${encodeURIComponent(
       paths.join(',')
     )}&type=${encodeURIComponent(type.join(','))}&lang=${lang}`,
     { signal }
-  )
-    .then(
-      (resp) =>
-        resp.json() as Promise<Record<string, number>[] | number[] | number>
-    )
-    .then((data) => errorCheck(data, 'article count'));
-
-export interface UpdateArticleCounterOptions {
-  serverURL: string;
-  lang: string;
+  ).then((resp) => <Promise<GetArticleCounterResponse>>resp.json());
+
+export interface UpdateArticleCounterOptions extends BaseAPIOptions {
+  /**
+   * 待更新计数器的 path
+   *
+   * Path of counter to be updated
+   */
   path: string;
+
+  /**
+   * 待更新计数器的类型
+   *
+   * Counter type to be updated
+   */
   type: string;
+
+  /**
+   * 更新操作
+   *
+   * Update operation
+   *
+   * @default 'inc'
+   */
   action?: 'inc' | 'desc';
 }
 
@@ -48,6 +80,4 @@ export const updateArticleCounter = ({
     method: 'POST',
     headers: JSON_HEADERS,
     body: JSON.stringify({ path, type, action }),
-  })
-    .then((resp) => resp.json() as Promise<number>)
-    .then((data) => errorCheck(data, 'article count'));
+  }).then((resp) => <Promise<number>>resp.json());

package/src/api/comment.ts

@@ -1,24 +1,89 @@
 import { JSON_HEADERS, errorCheck } from './utils';
+import type { BaseAPIOptions, ErrorStatusResponse } from './utils';
 import type { WalineComment, WalineCommentData } from '../typings';
 
-export interface FetchCommentOptions {
-  serverURL: string;
+export interface GetCommentOptions extends BaseAPIOptions {
+  /**
+   * 待获取评论列表的 path
+   *
+   * Path of comment list
+   */
   path: string;
+
+  /**
+   * 评论分页数
+   *
+   * Comment pagination number
+   */
   page: number;
+
+  /**
+   * 每页评论个数
+   *
+   * Comment number per page
+   */
   pageSize: number;
+
+  /**
+   * 排序方式
+   *
+   * Sort method
+   */
   sortBy: string;
-  signal: AbortSignal;
+
+  /**
+   * 用户令牌
+   *
+   * User token
+   */
   token?: string;
-  lang: string;
+
+  /**
+   * 取消请求的信号
+   *
+   * AbortSignal to cancel request
+   */
+  signal?: AbortSignal;
 }
 
-export interface CommentData {
+export interface GetCommentResponse extends ErrorStatusResponse {
+  /**
+   * 评论数量
+   *
+   * Comment number
+   */
   count: number;
+
+  /**
+   * 评论分页数
+   *
+   * Comment pagination number
+   */
+  page: number;
+
+  /**
+   * 每页评论个数
+   *
+   * Comment number per page
+   */
+  pageSize: number;
+
+  /**
+   * 评论数据
+   *
+   * Comment Data
+   */
   data: WalineComment[];
+
+  /**
+   * 页面总数
+   *
+   * Page number
+   */
   totalPages: number;
 }
 
-export const fetchComment = ({
+export const getComment = ({
   serverURL,
   lang,
   path,
@@ -27,7 +92,7 @@ export const fetchComment = ({
   sortBy,
   signal,
   token,
-}: FetchCommentOptions): Promise<CommentData> => {
+}: GetCommentOptions): Promise<GetCommentResponse> => {
   const headers: Record<string, string> = {};
 
   if (token) headers.Authorization = `Bearer ${token}`;
@@ -38,28 +103,41 @@ export const fetchComment = ({
     )}&pageSize=${pageSize}&page=${page}&lang=${lang}&sortBy=${sortBy}`,
     { signal, headers }
   )
-    .then((resp) => resp.json() as Promise<CommentData>)
-    .then((data) => errorCheck(data, 'comment data'));
+    .then((resp) => <Promise<GetCommentResponse>>resp.json())
+    .then((data) => errorCheck(data, 'Get comment data'));
 };
 
-export interface PostCommentOptions {
-  serverURL: string;
-  lang: string;
+export interface AddCommentOptions extends BaseAPIOptions {
+  /**
+   * 用户令牌
+   *
+   * User token
+   */
   token?: string;
+
+  /**
+   * 用户待提交的评论数据
+   *
+   * Comment data being submitted by user
+   */
   comment: WalineCommentData;
 }
 
-export interface PostCommentResponse {
+export interface AddCommentResponse extends ErrorStatusResponse {
+  /**
+   * 渲染好的评论数据
+   *
+   * Comment data rendered
+   */
   data?: WalineComment;
-  errmsg?: string;
 }
 
-export const postComment = ({
+export const addComment = ({
   serverURL,
   lang,
   token,
   comment,
-}: PostCommentOptions): Promise<PostCommentResponse> => {
+}: AddCommentOptions): Promise<AddCommentResponse> => {
   const headers: Record<string, string> = {
     // eslint-disable-next-line @typescript-eslint/naming-convention
     'Content-Type': 'application/json',
@@ -67,67 +145,90 @@ export const postComment = ({
 
   if (token) headers.Authorization = `Bearer ${token}`;
 
-  if (comment.eid) {
-    return fetch(`${serverURL}/comment/${comment.eid}?lang=${lang}`, {
-      method: 'PUT',
-      headers,
-      body: JSON.stringify(comment),
-    }).then((resp) => resp.json() as Promise<PostCommentResponse>);
-  }
-
   return fetch(`${serverURL}/comment?lang=${lang}`, {
     method: 'POST',
     headers,
     body: JSON.stringify(comment),
-  }).then((resp) => resp.json() as Promise<PostCommentResponse>);
+  }).then((resp) => <Promise<AddCommentResponse>>resp.json());
 };
 
-export interface DeleteCommentOptions {
-  serverURL: string;
-  lang: string;
+export interface DeleteCommentOptions extends BaseAPIOptions {
   token: string;
   objectId: string | number;
 }
 
+export interface DeleteCommentResponse extends ErrorStatusResponse {
+  data: '';
+}
+
 export const deleteComment = ({
   serverURL,
   lang,
   token,
   objectId,
-}: DeleteCommentOptions): Promise<void> =>
+}: DeleteCommentOptions): Promise<DeleteCommentResponse> =>
   fetch(`${serverURL}/comment/${objectId}?lang=${lang}`, {
     method: 'DELETE',
     headers: {
       Authorization: `Bearer ${token}`,
     },
-  }).then((resp) => resp.json() as Promise<void>);
+  })
+    .then((resp) => <Promise<DeleteCommentResponse>>resp.json())
+    .then((resp) => errorCheck(resp, 'Delete comment'));
+
+export interface UpdateCommentOptions extends BaseAPIOptions {
+  /**
+   * 用户令牌
+   *
+   * User token
+   */
+  token: string;
 
-export interface LikeCommentOptions {
-  serverURL: string;
-  lang: string;
+  /**
+   * 评论的 ID
+   *
+   * Comment ID
+   */
   objectId: number | string;
-  like: boolean;
-}
-
-export const likeComment = ({
-  serverURL,
-  lang,
-  objectId,
-  like,
-}: LikeCommentOptions): Promise<void> =>
-  fetch(`${serverURL}/comment/${objectId}?lang=${lang}`, {
-    method: 'PUT',
-    headers: JSON_HEADERS,
-    body: JSON.stringify({ like }),
-  }).then((resp) => resp.json() as Promise<void>);
 
-export interface UpdateCommentOptions {
-  serverURL: string;
-  lang: string;
-  token: string;
-  objectId: number | string;
+  /**
+   * 评论数据
+   *
+   * Comment data
+   */
+  comment?: WalineCommentData;
+
+  /**
+   * 点赞还是取消点赞
+   *
+   * Like or dislike
+   */
+  like?: boolean;
+
+  /**
+   * 评论的状态
+   *
+   * Comment status
+   */
   status?: 'approved' | 'waiting' | 'spam';
-  sticky?: number;
+
+  /**
+   * 评论指定状态
+   *
+   * Comment sticky status
+   *
+   * @description 0 means not sticky and 1 means sticky
+   */
+  sticky?: 0 | 1;
+}
+
+export interface UpdateCommentResponse extends ErrorStatusResponse {
+  /**
+   * 更新后的评论数据
+   *
+   * Comment data rendered
+   */
+  data: WalineComment;
 }
 
 export const updateComment = ({
@@ -136,7 +237,7 @@ export const updateComment = ({
   token,
   objectId,
   ...data
-}: UpdateCommentOptions): Promise<void> =>
+}: UpdateCommentOptions): Promise<UpdateCommentResponse> =>
   fetch(`${serverURL}/comment/${objectId}?lang=${lang}`, {
     method: 'PUT',
     headers: {
@@ -144,4 +245,6 @@ export const updateComment = ({
       Authorization: `Bearer ${token}`,
     },
     body: JSON.stringify(data),
-  }).then((resp) => resp.json() as Promise<void>);
+  })
+    .then((resp) => <Promise<UpdateCommentResponse>>resp.json())
+    .then((resp) => errorCheck(resp, 'Update comment'));

package/src/api/commentCount.ts

@@ -1,10 +1,19 @@
-import { errorCheck } from './utils';
+import type { BaseAPIOptions } from './utils';
 
-export interface FetchCommentCountOptions {
-  serverURL: string;
-  lang: string;
+export interface GetCommentCountOptions extends BaseAPIOptions {
+  /**
+   * 待获取评论数的 path
+   *
+   * Path of pages to be fetched
+   */
   paths: string[];
-  signal: AbortSignal;
+
+  /**
+   * 取消请求的信号
+   *
+   * AbortSignal to cancel request
+   */
+  signal?: AbortSignal;
 }
 
 export const fetchCommentCount = ({
@@ -12,19 +21,13 @@ export const fetchCommentCount = ({
   lang,
   paths,
   signal,
-}: FetchCommentCountOptions): Promise<number[]> => {
-  const headers: Record<string, string> = {};
-
-  return (
-    fetch(
-      `${serverURL}/comment?type=count&url=${encodeURIComponent(
-        paths.join(',')
-      )}&lang=${lang}`,
-      { signal, headers }
-    )
-      .then((resp) => resp.json() as Promise<number | number[]>)
-      .then((data) => errorCheck(data, 'comment count'))
-      // TODO: Improve this API
-      .then((counts) => (Array.isArray(counts) ? counts : [counts]))
-  );
-};
+}: GetCommentCountOptions): Promise<number[]> =>
+  fetch(
+    `${serverURL}/comment?type=count&url=${encodeURIComponent(
+      paths.join(',')
+    )}&lang=${lang}`,
+    { signal }
+  )
+    .then((resp) => <Promise<number | number[]>>resp.json())
+    // TODO: Improve this API
+    .then((counts) => (Array.isArray(counts) ? counts : [counts]));

package/src/api/login.ts

@@ -1,26 +1,69 @@
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
-
-export interface LoginOptions {
-  lang: string;
-  serverURL: string;
-}
+import type { BaseAPIOptions } from './utils';
 
 export interface UserInfo {
+  /**
+   * 显示姓名
+   *
+   * User name displayed
+   */
   // eslint-disable-next-line @typescript-eslint/naming-convention
   display_name: string;
+
+  /**
+   * 用户电子邮件地址
+   *
+   * User email
+   */
   email: string;
+
+  /**
+   * 用户网站地址
+   *
+   * User website
+   */
   url: string;
+
+  /**
+   * 用户令牌
+   *
+   * User token
+   */
   token: string;
+
+  /**
+   * 用户头像
+   *
+   * User avatar
+   */
   avatar: string;
+
+  /**
+   * 用户邮箱 MD5
+   *
+   * MD5 of User email
+   */
   mailMd5: string;
+
+  /**
+   * 用户对象 ID
+   *
+   * User object ID
+   */
   objectId: string | number;
+
+  /**
+   * 用户身份
+   *
+   * User role
+   */
   type: 'administrator' | 'guest';
 }
 
 export const login = ({
   lang,
   serverURL,
-}: LoginOptions): Promise<UserInfo & { remember: boolean }> => {
+}: BaseAPIOptions): Promise<UserInfo & { remember: boolean }> => {
   const width = 450;
   const height = 450;
   const left = (window.innerWidth - width) / 2;

package/src/api/pageview.ts

@@ -1,19 +1,29 @@
-import { fetchArticleCounter, updateArticleCounter } from './articleCounter';
+import { getArticleCounter, updateArticleCounter } from './articleCounter';
+import type { BaseAPIOptions } from './utils';
 
-interface FetchPageviewOptions {
-  serverURL: string;
-  lang: string;
+interface GetPageviewOptions extends BaseAPIOptions {
+  /**
+   * 待获取页面的 path
+   *
+   * Path of pages
+   */
   paths: string[];
-  signal: AbortSignal;
+
+  /**
+   * 取消请求的信号
+   *
+   * AbortSignal to cancel request
+   */
+  signal?: AbortSignal;
 }
 
-export const fetchPageviews = ({
+export const getPageview = ({
   serverURL,
   lang,
   paths,
   signal,
-}: FetchPageviewOptions): Promise<number[]> =>
-  fetchArticleCounter({
+}: GetPageviewOptions): Promise<number[]> =>
+  getArticleCounter({
     serverURL,
     lang,
     paths,
@@ -25,17 +35,20 @@ export const fetchPageviews = ({
     number[]
   >;
 
-export interface UpdatePageviewOptions {
-  serverURL: string;
-  lang: string;
+export interface UpdatePageviewOptions extends BaseAPIOptions {
+  /**
+   * 待更新页面的 path
+   *
+   * Path of pages
+   */
   path: string;
-  action?: 'inc' | 'desc';
 }
 
-export const updatePageviews = (
+export const updatePageview = (
   options: UpdatePageviewOptions
 ): Promise<number> =>
   updateArticleCounter({
     ...options,
     type: 'time',
+    action: 'inc',
   });