@waline/client 2.15.8 → 3.0.0-alpha.2

package/src/api/articleCounter.ts

@@ -1,82 +0,0 @@
-import { type BaseAPIOptions, JSON_HEADERS } from './utils.js';
-
-export interface GetArticleCounterOptions extends BaseAPIOptions {
-  /**
-   * 待获取计数器的 path
-   *
-   * Path of counters
-   */
-  paths: string[];
-
-  /**
-   * 待获取计数器的类型
-   *
-   * Counter type to be fetched
-   */
-  type: string[];
-
-  /**
-   * 取消请求的信号
-   *
-   * AbortSignal to cancel request
-   */
-  signal?: AbortSignal;
-}
-
-export type GetArticleCounterResponse =
-  | Record<string, number>[]
-  | Record<string, number>
-  | number[]
-  | number;
-
-export const getArticleCounter = ({
-  serverURL,
-  lang,
-  paths,
-  type,
-  signal,
-}: GetArticleCounterOptions): Promise<GetArticleCounterResponse> =>
-  fetch(
-    `${serverURL}/article?path=${encodeURIComponent(
-      paths.join(','),
-    )}&type=${encodeURIComponent(type.join(','))}&lang=${lang}`,
-    { signal },
-  ).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';
-}
-
-export const updateArticleCounter = ({
-  serverURL,
-  lang,
-  path,
-  type,
-  action,
-}: UpdateArticleCounterOptions): Promise<number> =>
-  fetch(`${serverURL}/article?lang=${lang}`, {
-    method: 'POST',
-    headers: JSON_HEADERS,
-    body: JSON.stringify({ path, type, action }),
-  }).then((resp) => <Promise<number>>resp.json());

package/src/api/comment.ts

@@ -1,258 +0,0 @@
-import {
-  type BaseAPIOptions,
-  type ErrorStatusResponse,
-  JSON_HEADERS,
-  errorCheck,
-} from './utils.js';
-import {
-  type WalineComment,
-  type WalineCommentData,
-} from '../typings/index.js';
-
-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;
-
-  /**
-   * 用户令牌
-   *
-   * User token
-   */
-  token?: string;
-
-  /**
-   * 取消请求的信号
-   *
-   * AbortSignal to cancel request
-   */
-  signal?: AbortSignal;
-}
-
-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 getComment = ({
-  serverURL,
-  lang,
-  path,
-  page,
-  pageSize,
-  sortBy,
-  signal,
-  token,
-}: GetCommentOptions): Promise<GetCommentResponse> => {
-  const headers: Record<string, string> = {};
-
-  if (token) headers.Authorization = `Bearer ${token}`;
-
-  return fetch(
-    `${serverURL}/comment?path=${encodeURIComponent(
-      path,
-    )}&pageSize=${pageSize}&page=${page}&lang=${lang}&sortBy=${sortBy}`,
-    { signal, headers },
-  )
-    .then((resp) => <Promise<GetCommentResponse>>resp.json())
-    .then((data) => errorCheck(data, 'Get comment data'));
-};
-
-export interface AddCommentOptions extends BaseAPIOptions {
-  /**
-   * 用户令牌
-   *
-   * User token
-   */
-  token?: string;
-
-  /**
-   * 用户待提交的评论数据
-   *
-   * Comment data being submitted by user
-   */
-  comment: WalineCommentData;
-}
-
-export interface AddCommentResponse extends ErrorStatusResponse {
-  /**
-   * 渲染好的评论数据
-   *
-   * Comment data rendered
-   */
-  data?: WalineComment;
-}
-
-export const addComment = ({
-  serverURL,
-  lang,
-  token,
-  comment,
-}: AddCommentOptions): Promise<AddCommentResponse> => {
-  const headers: Record<string, string> = {
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    'Content-Type': 'application/json',
-  };
-
-  if (token) headers.Authorization = `Bearer ${token}`;
-
-  return fetch(`${serverURL}/comment?lang=${lang}`, {
-    method: 'POST',
-    headers,
-    body: JSON.stringify(comment),
-  }).then((resp) => <Promise<AddCommentResponse>>resp.json());
-};
-
-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<DeleteCommentResponse> =>
-  fetch(`${serverURL}/comment/${objectId}?lang=${lang}`, {
-    method: 'DELETE',
-    headers: {
-      Authorization: `Bearer ${token}`,
-    },
-  })
-    .then((resp) => <Promise<DeleteCommentResponse>>resp.json())
-    .then((resp) => errorCheck(resp, 'Delete comment'));
-
-interface UpdateWalineCommentData extends Partial<WalineCommentData> {
-  /**
-   * 点赞还是取消点赞
-   *
-   * Like or dislike
-   */
-  like?: boolean;
-
-  /**
-   * 评论的状态
-   *
-   * Comment status
-   */
-  status?: 'approved' | 'waiting' | 'spam';
-
-  /**
-   * 评论指定状态
-   *
-   * Comment sticky status
-   *
-   * @description 0 means not sticky and 1 means sticky
-   */
-  sticky?: 0 | 1;
-}
-export interface UpdateCommentOptions extends BaseAPIOptions {
-  /**
-   * 用户令牌
-   *
-   * User token
-   */
-  token: string;
-
-  /**
-   * 评论的 ID
-   *
-   * Comment ID
-   */
-  objectId: number | string;
-
-  /**
-   * 评论数据
-   *
-   * Comment data
-   */
-  comment?: UpdateWalineCommentData;
-}
-
-export interface UpdateCommentResponse extends ErrorStatusResponse {
-  /**
-   * 更新后的评论数据
-   *
-   * Comment data rendered
-   */
-  data: WalineComment;
-}
-
-export const updateComment = ({
-  serverURL,
-  lang,
-  token,
-  objectId,
-  comment,
-}: UpdateCommentOptions): Promise<UpdateCommentResponse> =>
-  fetch(`${serverURL}/comment/${objectId}?lang=${lang}`, {
-    method: 'PUT',
-    headers: {
-      ...JSON_HEADERS,
-      Authorization: `Bearer ${token}`,
-    },
-    body: JSON.stringify(comment),
-  })
-    .then((resp) => <Promise<UpdateCommentResponse>>resp.json())
-    .then((resp) => errorCheck(resp, 'Update comment'));

package/src/api/commentCount.ts

@@ -1,33 +0,0 @@
-import { type BaseAPIOptions } from './utils.js';
-
-export interface GetCommentCountOptions extends BaseAPIOptions {
-  /**
-   * 待获取评论数的 path
-   *
-   * Path of pages to be fetched
-   */
-  paths: string[];
-
-  /**
-   * 取消请求的信号
-   *
-   * AbortSignal to cancel request
-   */
-  signal?: AbortSignal;
-}
-
-export const fetchCommentCount = ({
-  serverURL,
-  lang,
-  paths,
-  signal,
-}: 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/index.ts

@@ -1,7 +0,0 @@
-export * from './articleCounter';
-export * from './comment';
-export * from './commentCount';
-export * from './login';
-export * from './pageview';
-export * from './recentComment';
-export * from './user';

package/src/api/login.ts

@@ -1,96 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-import { type BaseAPIOptions } from './utils.js';
-
-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,
-}: BaseAPIOptions): Promise<UserInfo & { remember: boolean }> => {
-  const width = 450;
-  const height = 450;
-  const left = (window.innerWidth - width) / 2;
-  const top = (window.innerHeight - height) / 2;
-
-  const handler = window.open(
-    `${serverURL}/ui/login?lng=${encodeURIComponent(lang)}`,
-    '_blank',
-    `width=${width},height=${height},left=${left},top=${top},scrollbars=no,resizable=no,status=no,location=no,toolbar=no,menubar=no`,
-  );
-
-  handler?.postMessage({ type: 'TOKEN', data: null }, '*');
-
-  return new Promise((resolve) => {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const receiver = ({ data }: any): void => {
-      if (!data || typeof data !== 'object' || data.type !== 'userInfo') return;
-
-      if (data.data.token) {
-        handler?.close();
-
-        window.removeEventListener('message', receiver);
-
-        resolve(data.data as UserInfo & { remember: boolean });
-      }
-    };
-
-    window.addEventListener('message', receiver);
-  });
-};

package/src/api/pageview.ts

@@ -1,54 +0,0 @@
-import { getArticleCounter, updateArticleCounter } from './articleCounter.js';
-import { type BaseAPIOptions } from './utils.js';
-
-interface GetPageviewOptions extends BaseAPIOptions {
-  /**
-   * 待获取页面的 path
-   *
-   * Path of pages
-   */
-  paths: string[];
-
-  /**
-   * 取消请求的信号
-   *
-   * AbortSignal to cancel request
-   */
-  signal?: AbortSignal;
-}
-
-export const getPageview = ({
-  serverURL,
-  lang,
-  paths,
-  signal,
-}: GetPageviewOptions): Promise<number[]> =>
-  getArticleCounter({
-    serverURL,
-    lang,
-    paths,
-    type: ['time'],
-    signal,
-  })
-    // TODO: Improve this API
-    .then((counts) => (Array.isArray(counts) ? counts : [counts])) as Promise<
-    number[]
-  >;
-
-export interface UpdatePageviewOptions extends BaseAPIOptions {
-  /**
-   * 待更新页面的 path
-   *
-   * Path of pages
-   */
-  path: string;
-}
-
-export const updatePageview = (
-  options: UpdatePageviewOptions,
-): Promise<number> =>
-  updateArticleCounter({
-    ...options,
-    type: 'time',
-    action: 'inc',
-  });

package/src/api/recentComment.ts

@@ -1,42 +0,0 @@
-import { type BaseAPIOptions } from './utils.js';
-import { type WalineComment } from '../typings/index.js';
-
-export interface GetRecentCommentOptions extends BaseAPIOptions {
-  /**
-   * 获取评论的数量
-   *
-   * Comment number to be fetched
-   */
-  count: number;
-
-  /**
-   * 取消请求的信号
-   *
-   * AbortSignal to cancel request
-   */
-  signal?: AbortSignal;
-
-  /**
-   * 用户令牌
-   *
-   * User token
-   */
-  token?: string;
-}
-
-export const getRecentComment = ({
-  serverURL,
-  lang,
-  count,
-  signal,
-  token,
-}: GetRecentCommentOptions): Promise<WalineComment[]> => {
-  const headers: Record<string, string> = {};
-
-  if (token) headers.Authorization = `Bearer ${token}`;
-
-  return fetch(`${serverURL}/comment?type=recent&count=${count}&lang=${lang}`, {
-    signal,
-    headers,
-  }).then((resp) => <Promise<WalineComment[]>>resp.json());
-};

package/src/api/user.ts

@@ -1,44 +0,0 @@
-import {
-  type BaseAPIOptions,
-  errorCheck,
-  ErrorStatusResponse,
-} from './utils.js';
-import { type WalineComment } from '../typings/index.js';
-
-export interface GetUserListOptions extends BaseAPIOptions {
-  /**
-   * 每页个数
-   *
-   * Number per page
-   */
-  pageSize: number;
-
-  /**
-   * 取消请求的信号
-   *
-   * AbortSignal to cancel request
-   */
-  signal?: AbortSignal;
-}
-
-export interface WalineUser
-  extends Pick<WalineComment, 'nick' | 'link' | 'avatar' | 'label' | 'level'> {
-  count: number;
-}
-
-export interface GetUserListResponse extends ErrorStatusResponse {
-  data: WalineUser[];
-}
-
-export const getUserList = ({
-  serverURL,
-  signal,
-  pageSize,
-  lang,
-}: GetUserListOptions): Promise<WalineUser[]> =>
-  fetch(`${serverURL}/user?pageSize=${pageSize}&lang=${lang}`, {
-    signal,
-  })
-    .then((resp) => <Promise<GetUserListResponse>>resp.json())
-    .then((resp) => errorCheck(resp, 'user list'))
-    .then((resp) => resp.data);

package/src/api/utils.ts

@@ -1,46 +0,0 @@
-export interface BaseAPIOptions {
-  /**
-   * Waline 服务端地址
-   *
-   * Waline serverURL
-   */
-  serverURL: string;
-
-  /**
-   * 错误信息所使用的语言
-   *
-   * Language used in error text
-   */
-  lang: string;
-}
-
-export interface ErrorStatusResponse {
-  /**
-   * 错误代码
-   *
-   * Error number
-   */
-  errno: number;
-
-  /**
-   * 错误消息
-   *
-   * Error msg
-   */
-  errmsg: string;
-}
-
-export const JSON_HEADERS: Record<string, string> = {
-  // eslint-disable-next-line @typescript-eslint/naming-convention
-  'Content-Type': 'application/json',
-};
-
-export const errorCheck = <T extends ErrorStatusResponse>(
-  data: T,
-  name = '',
-): T => {
-  if (typeof data === 'object' && data.errno)
-    throw new TypeError(`${name} failed with ${data.errno}: ${data.errmsg}`);
-
-  return data;
-};