@waline/client/dist/api.d.ts

interface BaseAPIOptions {
    /**
     * Waline 服务端地址
     *
     * Waline serverURL
     */
    serverURL: string;
    /**
     * 错误信息所使用的语言
     *
     * Language used in error text
     */
    lang: string;
}
interface ErrorStatusResponse {
    /**
     * 错误代码
     *
     * Error number
     */
    errno: number;
    /**
     * 错误消息
     *
     * Error msg
     */
    errmsg: string;
}

interface GetArticleCounterOptions extends BaseAPIOptions {
    /**
     * 待获取计数器的 path
     *
     * Path of counters
     */
    paths: string[];
    /**
     * 待获取计数器的类型
     *
     * Counter type to be fetched
     */
    type: string[];
    /**
     * 取消请求的信号
     *
     * AbortSignal to cancel request
     */
    signal?: AbortSignal;
}
type GetArticleCounterResponse = Record<string, number>[] | Record<string, number> | number[] | number;
declare const getArticleCounter: ({ serverURL, lang, paths, type, signal, }: GetArticleCounterOptions) => Promise<GetArticleCounterResponse>;
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';
}
declare const updateArticleCounter: ({ serverURL, lang, path, type, action, }: UpdateArticleCounterOptions) => Promise<number>;

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;
    /**
     * Recaptcha Token
     */
    recaptchaV3?: string;
}
type WalineCommentStatus = 'approved' | 'waiting' | 'spam';
interface WalineComment extends Exclude<WalineCommentData, 'ua'> {
    /**
     * User avatar
     */
    avatar: string;
    /**
     * User type
     */
    type?: 'administrator' | 'guest' | `verify:${string}`;
    objectId: string;
    /**
     * Time ISOString when the comment is created
     */
    createdAt: string;
    insertedAt: string;
    updatedAt: string;
    children: WalineComment[];
    sticky?: boolean;
    browser?: string;
    os?: string;
    level?: number;
    addr?: string;
    label?: string;
    user_id?: string | number;
    status?: WalineCommentStatus;
    like?: number;
    orig?: string;
}

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;
}
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;
}
declare const getComment: ({ serverURL, lang, path, page, pageSize, sortBy, signal, token, }: GetCommentOptions) => Promise<GetCommentResponse>;
interface AddCommentOptions extends BaseAPIOptions {
    /**
     * 用户令牌
     *
     * User token
     */
    token?: string;
    /**
     * 用户待提交的评论数据
     *
     * Comment data being submitted by user
     */
    comment: WalineCommentData;
}
interface AddCommentResponse extends ErrorStatusResponse {
    /**
     * 渲染好的评论数据
     *
     * Comment data rendered
     */
    data?: WalineComment;
}
declare const addComment: ({ serverURL, lang, token, comment, }: AddCommentOptions) => Promise<AddCommentResponse>;
interface DeleteCommentOptions extends BaseAPIOptions {
    token: string;
    objectId: string | number;
}
interface DeleteCommentResponse extends ErrorStatusResponse {
    data: '';
}
declare const deleteComment: ({ serverURL, lang, token, objectId, }: DeleteCommentOptions) => Promise<DeleteCommentResponse>;
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;
}
interface UpdateCommentOptions extends BaseAPIOptions {
    /**
     * 用户令牌
     *
     * User token
     */
    token: string;
    /**
     * 评论的 ID
     *
     * Comment ID
     */
    objectId: number | string;
    /**
     * 评论数据
     *
     * Comment data
     */
    comment?: UpdateWalineCommentData;
}
interface UpdateCommentResponse extends ErrorStatusResponse {
    /**
     * 更新后的评论数据
     *
     * Comment data rendered
     */
    data: WalineComment;
}
declare const updateComment: ({ serverURL, lang, token, objectId, comment, }: UpdateCommentOptions) => Promise<UpdateCommentResponse>;

interface GetCommentCountOptions extends BaseAPIOptions {
    /**
     * 待获取评论数的 path
     *
     * Path of pages to be fetched
     */
    paths: string[];
    /**
     * 取消请求的信号
     *
     * AbortSignal to cancel request
     */
    signal?: AbortSignal;
}
declare const fetchCommentCount: ({ serverURL, lang, paths, signal, }: GetCommentCountOptions) => Promise<number[]>;

interface UserInfo {
    /**
     * 显示姓名
     *
     * User name displayed
     */
    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';
}
declare const login: ({ lang, serverURL, }: BaseAPIOptions) => Promise<UserInfo & {
    remember: boolean;
}>;

interface GetPageviewOptions extends BaseAPIOptions {
    /**
     * 待获取页面的 path
     *
     * Path of pages
     */
    paths: string[];
    /**
     * 取消请求的信号
     *
     * AbortSignal to cancel request
     */
    signal?: AbortSignal;
}
declare const getPageview: ({ serverURL, lang, paths, signal, }: GetPageviewOptions) => Promise<number[]>;
interface UpdatePageviewOptions extends BaseAPIOptions {
    /**
     * 待更新页面的 path
     *
     * Path of pages
     */
    path: string;
}
declare const updatePageview: (options: UpdatePageviewOptions) => Promise<number>;

interface GetRecentCommentOptions extends BaseAPIOptions {
    /**
     * 获取评论的数量
     *
     * Comment number to be fetched
     */
    count: number;
    /**
     * 取消请求的信号
     *
     * AbortSignal to cancel request
     */
    signal?: AbortSignal;
    /**
     * 用户令牌
     *
     * User token
     */
    token?: string;
}
declare const getRecentComment: ({ serverURL, lang, count, signal, token, }: GetRecentCommentOptions) => Promise<WalineComment[]>;

interface GetUserListOptions extends BaseAPIOptions {
    /**
     * 每页个数
     *
     * Number per page
     */
    pageSize: number;
    /**
     * 取消请求的信号
     *
     * AbortSignal to cancel request
     */
    signal?: AbortSignal;
}
interface WalineUser extends Pick<WalineComment, 'nick' | 'link' | 'avatar' | 'label' | 'level'> {
    count: number;
}
interface GetUserListResponse extends ErrorStatusResponse {
    data: WalineUser[];
}
declare const getUserList: ({ serverURL, signal, pageSize, lang, }: GetUserListOptions) => Promise<WalineUser[]>;

export { AddCommentOptions, AddCommentResponse, DeleteCommentOptions, DeleteCommentResponse, GetArticleCounterOptions, GetArticleCounterResponse, GetCommentCountOptions, GetCommentOptions, GetCommentResponse, GetRecentCommentOptions, GetUserListOptions, GetUserListResponse, UpdateArticleCounterOptions, UpdateCommentOptions, UpdateCommentResponse, UpdatePageviewOptions, UserInfo, WalineUser, addComment, deleteComment, fetchCommentCount, getArticleCounter, getComment, getPageview, getRecentComment, getUserList, login, updateArticleCounter, updateComment, updatePageview };