@mx-space/api-client 1.1.0 → 1.2.0

package/dist/index.d.ts

@@ -0,0 +1,1555 @@
+import { R as RequestOptions, I as IRequestAdapter, a as IAdaptorRequestResponseType } from './adapter-be44aa1e.js';
+
+interface IController {
+    base: string;
+    name: string | string[];
+}
+
+type Class<T> = new (...args: any[]) => T;
+type SelectFields<T extends string> = `${'+' | '-' | ''}${T}`[];
+
+interface IClientOptions {
+    controllers: Class<IController>[];
+    getCodeMessageFromException: <T = Error>(error: T) => {
+        message?: string | undefined | null;
+        code?: number | undefined | null;
+    };
+    customThrowResponseError: <T extends Error = Error>(err: any) => T;
+    transformResponse: <T = any>(data: any) => T;
+}
+type ClientOptions = Partial<IClientOptions>;
+
+type NoStringIndex<T> = {
+    [K in keyof T as string extends K ? never : K]: T[K];
+};
+interface IRequestHandler<ResponseWrapper> {
+    (path?: string | number): IRequestHandler<ResponseWrapper>;
+    get<P = unknown>(options?: Omit<NoStringIndex<RequestOptions>, 'data'>): RequestProxyResult<P, ResponseWrapper>;
+    post<P = unknown>(options?: RequestOptions): RequestProxyResult<P, ResponseWrapper>;
+    patch<P = unknown>(options?: RequestOptions): RequestProxyResult<P, ResponseWrapper>;
+    delete<P = unknown>(options?: Omit<NoStringIndex<RequestOptions>, 'data'>): RequestProxyResult<P, ResponseWrapper>;
+    put<P = unknown>(options?: RequestOptions): RequestProxyResult<P, ResponseWrapper>;
+    toString(withBase?: boolean): string;
+    valueOf(withBase?: boolean): string;
+    [key: string]: IRequestHandler<ResponseWrapper>;
+}
+type RequestProxyResult<T, ResponseWrapper, R = ResponseWrapper extends unknown ? {
+    data: T;
+    [key: string]: any;
+} : ResponseWrapper extends {
+    data: T;
+} ? ResponseWrapper : Omit<ResponseWrapper, 'data'> & {
+    data: T;
+}> = Promise<ResponseProxyExtraRaw<T, R, ResponseWrapper>>;
+type CamelToSnake<T extends string, P extends string = ''> = string extends T ? string : T extends `${infer C0}${infer R}` ? CamelToSnake<R, `${P}${C0 extends Lowercase<C0> ? '' : '_'}${Lowercase<C0>}`> : P;
+type CamelKeysToSnake<T> = {
+    [K in keyof T as CamelToSnake<Extract<K, string>>]: T[K];
+};
+type ResponseWrapperType<Response, RawData, T> = {
+    $raw: Response extends {
+        data: infer T;
+    } ? Response : Response extends unknown ? {
+        [i: string]: any;
+        data: RawData extends unknown ? CamelKeysToSnake<T> : RawData;
+    } : Response;
+    $request: {
+        path: string;
+        method: string;
+        [k: string]: string;
+    };
+};
+type ResponseProxyExtraRaw<T, RawData = unknown, Response = unknown> = T extends object ? T & ResponseWrapperType<Response, RawData, T> : T extends unknown ? T & ResponseWrapperType<Response, RawData, T> : unknown;
+
+declare class HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+    private readonly _endpoint;
+    private _adaptor;
+    private options;
+    private readonly _proxy;
+    constructor(_endpoint: string, _adaptor: T, options?: Omit<ClientOptions, 'controllers'>);
+    private initGetClient;
+    injectControllers(...Controller: Class<IController>[]): void;
+    injectControllers(Controller: Class<IController>[]): void;
+    get endpoint(): string;
+    get instance(): T;
+    request(options: {
+        url: string;
+        method?: string;
+        data?: any;
+        params?: any;
+    }): Promise<IAdaptorRequestResponseType<any>>;
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    private buildRoute;
+}
+declare function createClient<T extends IRequestAdapter>(adapter: T): <ResponseWrapper = T extends {
+    responseWrapper: infer Type;
+} ? Type extends undefined ? unknown : Type : unknown>(endpoint: string, options?: ClientOptions) => HTTPClient<T, ResponseWrapper>;
+
+declare class RequestError extends Error {
+    status: number;
+    path: string;
+    raw: any;
+    constructor(message: string, status: number, path: string, raw: any);
+}
+
+type SortOrder = 'asc' | 'desc';
+
+interface Count {
+    read: number;
+    like: number;
+}
+interface Image {
+    height: number;
+    width: number;
+    type: string;
+    accent?: string;
+    src: string;
+}
+interface Pager {
+    total: number;
+    size: number;
+    currentPage: number;
+    totalPage: number;
+    hasPrevPage: boolean;
+    hasNextPage: boolean;
+}
+interface PaginateResult<T> {
+    data: T[];
+    pagination: Pager;
+}
+interface BaseModel {
+    created: string;
+    id: string;
+}
+interface BaseCommentIndexModel extends BaseModel {
+    commentsIndex?: number;
+    allowComment: boolean;
+}
+interface TextBaseModel extends BaseCommentIndexModel {
+    title: string;
+    text: string;
+    images?: Image[];
+    modified: string | null;
+    meta?: Record<string, any>;
+}
+type ModelWithLiked<T> = T & {
+    liked: boolean;
+};
+
+interface PostModel extends TextBaseModel {
+    summary?: string;
+    copyright: boolean;
+    tags: string[];
+    count: Count;
+    text: string;
+    title: string;
+    slug: string;
+    categoryId: string;
+    images: Image[];
+    category: CategoryModel;
+    pin?: string | null;
+    pinOrder?: number;
+    related?: Pick<PostModel, 'id' | 'category' | 'categoryId' | 'created' | 'modified' | 'title' | 'slug' | 'summary'>[];
+}
+
+declare enum CategoryType {
+    Category = 0,
+    Tag = 1
+}
+interface CategoryModel extends BaseModel {
+    type: CategoryType;
+    count: number;
+    slug: string;
+    name: string;
+}
+type CategoryWithChildrenModel = CategoryModel & {
+    children: Pick<PostModel, 'id' | 'title' | 'slug' | 'modified' | 'created'>[];
+};
+type CategoryEntries = {
+    entries: Record<string, CategoryWithChildrenModel>;
+};
+interface TagModel {
+    count: number;
+    name: string;
+}
+
+interface TopicModel extends BaseModel {
+    description?: string;
+    introduce: string;
+    name: string;
+    slug: string;
+    icon?: string;
+}
+
+interface NoteModel extends TextBaseModel {
+    hide: boolean;
+    count: {
+        read: number;
+        like: number;
+    };
+    mood?: string;
+    weather?: string;
+    hasMemory?: boolean;
+    secret?: Date;
+    password?: string | null;
+    nid: number;
+    music?: NoteMusicRecord[];
+    location?: string;
+    coordinates?: Coordinate;
+    topic?: TopicModel;
+    topicId?: string;
+}
+interface NoteMusicRecord {
+    type: string;
+    id: string;
+}
+interface Coordinate {
+    latitude: number;
+    longitude: number;
+}
+interface NoteWrappedPayload {
+    data: NoteModel;
+    next?: Partial<NoteModel>;
+    prev?: Partial<NoteModel>;
+}
+interface NoteWrappedWithLikedPayload {
+    data: ModelWithLiked<NoteModel>;
+    next?: Partial<NoteModel>;
+    prev?: Partial<NoteModel>;
+}
+
+declare enum EnumPageType {
+    'md' = "md",
+    'html' = "html",
+    'frame' = "frame"
+}
+interface PageModel extends TextBaseModel {
+    created: string;
+    slug: string;
+    subtitle?: string;
+    order?: number;
+    type?: EnumPageType;
+    options?: object;
+}
+
+interface SayModel extends BaseModel {
+    text: string;
+    source?: string;
+    author?: string;
+}
+
+declare class SeoOptionModel {
+    title: string;
+    description: string;
+    icon?: string;
+    keywords?: string[];
+}
+declare class UrlOptionModel {
+    webUrl: string;
+    adminUrl: string;
+    serverUrl: string;
+    wsUrl: string;
+}
+declare class MailOptionModel {
+    port: number;
+    host: string;
+}
+declare class MailOptionsModel {
+    enable: boolean;
+    user: string;
+    pass: string;
+    options?: MailOptionModel;
+}
+declare class CommentOptionsModel {
+    antiSpam: boolean;
+    spamKeywords?: string[];
+    blockIps?: string[];
+    disableNoChinese?: boolean;
+}
+declare class BackupOptionsModel {
+    enable: boolean;
+    secretId?: string;
+    secretKey?: string;
+    bucket?: string;
+    region: string;
+}
+declare class BaiduSearchOptionsModel {
+    enable: boolean;
+    token?: string;
+}
+declare class AlgoliaSearchOptionsModel {
+    enable: boolean;
+    apiKey?: string;
+    appId?: string;
+    indexName?: string;
+}
+declare class AdminExtraModel {
+    background?: string;
+    gaodemapKey?: string;
+    title?: string;
+    /**
+     * 是否开启后台反代访问
+     */
+    enableAdminProxy?: boolean;
+}
+interface IConfig {
+    seo: SeoOptionModel;
+    url: UrlOptionModel;
+    mailOptions: MailOptionsModel;
+    commentOptions: CommentOptionsModel;
+    backupOptions: BackupOptionsModel;
+    baiduSearchOptions: BaiduSearchOptionsModel;
+    algoliaSearchOptions: AlgoliaSearchOptionsModel;
+    adminExtra: AdminExtraModel;
+}
+declare type IConfigKeys = keyof IConfig;
+
+interface UserModel extends BaseModel {
+    introduce: string;
+    mail: string;
+    url: string;
+    name: string;
+    socialIds: Record<string, string>;
+    username: string;
+    modified: string;
+    v: number;
+    lastLoginTime: string;
+    lastLoginIp?: string;
+    avatar: string;
+    postID: string;
+}
+type TLogin = {
+    token: string;
+    expiresIn: number;
+    lastLoginTime: null | string;
+    lastLoginIp?: null | string;
+} & Pick<UserModel, 'name' | 'username' | 'created' | 'url' | 'mail' | 'avatar' | 'id'>;
+
+interface AggregateRoot {
+    user: UserModel;
+    seo: SeoOptionModel;
+    url: Url;
+    categories: CategoryModel[];
+    pageMeta: Pick<PageModel, 'title' | 'id' | 'slug' | 'order'>[] | null;
+}
+interface Url {
+    wsUrl: string;
+    serverUrl: string;
+    webUrl: string;
+}
+interface AggregateTop {
+    notes: Pick<NoteModel, 'id' | 'title' | 'created' | 'nid'>[];
+    posts: Pick<PostModel, 'id' | 'slug' | 'created' | 'title' | 'category'>[];
+    says: SayModel[];
+}
+declare enum TimelineType {
+    Post = 0,
+    Note = 1
+}
+interface TimelineData {
+    notes?: Pick<NoteModel, 'id' | 'nid' | 'title' | 'weather' | 'mood' | 'created' | 'modified' | 'hasMemory'>[];
+    posts?: (Pick<PostModel, 'id' | 'title' | 'slug' | 'created' | 'modified' | 'category'> & {
+        url: string;
+    })[];
+}
+interface AggregateStat {
+    allComments: number;
+    categories: number;
+    comments: number;
+    linkApply: number;
+    links: number;
+    notes: number;
+    pages: number;
+    posts: number;
+    says: number;
+    recently: number;
+    unreadComments: number;
+    online: number;
+    todayMaxOnline: string;
+    todayOnlineTotal: string;
+    callTime: number;
+    uv: number;
+    todayIpAccessCount: number;
+}
+
+declare module '@mx-space/api-client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        aggregate: AggregateController<ResponseWrapper>;
+    }
+}
+declare class AggregateController<ResponseWrapper> implements IController {
+    private client;
+    base: string;
+    name: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    /**
+     * 获取聚合数据
+     */
+    getAggregateData(): RequestProxyResult<AggregateRoot, ResponseWrapper>;
+    /**
+     * 获取最新发布的内容
+     */
+    getTop(size?: number): RequestProxyResult<AggregateTop, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: AggregateTop;
+    } : ResponseWrapper extends {
+        data: AggregateTop;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: AggregateTop;
+    }>;
+    getTimeline(options?: {
+        sort?: SortOrder;
+        type?: TimelineType;
+        year?: number;
+    }): RequestProxyResult<{
+        data: TimelineData;
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            data: TimelineData;
+        };
+    } : ResponseWrapper extends {
+        data: {
+            data: TimelineData;
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            data: TimelineData;
+        };
+    }>;
+    /**
+     * 获取聚合数据统计
+     */
+    getStat(): RequestProxyResult<AggregateStat, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: AggregateStat;
+    } : ResponseWrapper extends {
+        data: AggregateStat;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: AggregateStat;
+    }>;
+}
+
+declare module '@mx-space/api-client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        category: CategoryController<ResponseWrapper>;
+    }
+}
+declare class CategoryController<ResponseWrapper> implements IController {
+    private client;
+    name: string;
+    base: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    getAllCategories(): RequestProxyResult<{
+        data: CategoryModel[];
+    }, ResponseWrapper>;
+    getAllTags(): RequestProxyResult<{
+        data: TagModel[];
+    }, ResponseWrapper>;
+    getCategoryDetail(id: string): Promise<ResponseProxyExtraRaw<CategoryWithChildrenModel>>;
+    getCategoryDetail(ids: string[]): Promise<ResponseProxyExtraRaw<Map<string, CategoryWithChildrenModel>>>;
+    getCategoryByIdOrSlug(idOrSlug: string): Promise<CategoryModel & {
+        children: Pick<PostModel, "id" | "created" | "modified" | "title" | "slug">[];
+    } & {
+        $raw: ResponseWrapper extends {
+            data: infer T;
+        } ? ResponseWrapper : ResponseWrapper extends unknown ? {
+            [i: string]: any;
+            data: (ResponseWrapper extends unknown ? {
+                [key: string]: any;
+                data: CategoryWithChildrenModel;
+            } : ResponseWrapper extends {
+                data: CategoryWithChildrenModel;
+            } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+                data: CategoryWithChildrenModel;
+            }) extends infer T_1 ? T_1 extends (ResponseWrapper extends unknown ? {
+                [key: string]: any;
+                data: CategoryWithChildrenModel;
+            } : ResponseWrapper extends {
+                data: CategoryWithChildrenModel;
+            } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+                data: CategoryWithChildrenModel;
+            }) ? T_1 extends unknown ? {
+                type: CategoryType;
+                count: number;
+                slug: string;
+                name: string;
+                created: string;
+                id: string;
+                children: Pick<PostModel, "id" | "created" | "modified" | "title" | "slug">[];
+            } : T_1 : never : never;
+        } : ResponseWrapper;
+        $request: {
+            [k: string]: string;
+            path: string;
+            method: string;
+        };
+    }>;
+    getTagByName(name: string): Promise<{
+        tag: string;
+        data: Pick<PostModel, 'id' | 'title' | 'slug' | 'category' | 'created'>[];
+    } & {
+        $raw: ResponseWrapper extends {
+            data: infer T;
+        } ? ResponseWrapper : ResponseWrapper extends unknown ? {
+            [i: string]: any;
+            data: (ResponseWrapper extends unknown ? {
+                [key: string]: any;
+                data: {
+                    tag: string;
+                    data: Pick<PostModel, 'id' | 'title' | 'slug' | 'category' | 'created'>[];
+                };
+            } : ResponseWrapper extends {
+                data: {
+                    tag: string;
+                    data: Pick<PostModel, 'id' | 'title' | 'slug' | 'category' | 'created'>[];
+                };
+            } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+                data: {
+                    tag: string;
+                    data: Pick<PostModel, 'id' | 'title' | 'slug' | 'category' | 'created'>[];
+                };
+            }) extends infer T_1 ? T_1 extends (ResponseWrapper extends unknown ? {
+                [key: string]: any;
+                data: {
+                    tag: string;
+                    data: Pick<PostModel, 'id' | 'title' | 'slug' | 'category' | 'created'>[];
+                };
+            } : ResponseWrapper extends {
+                data: {
+                    tag: string;
+                    data: Pick<PostModel, 'id' | 'title' | 'slug' | 'category' | 'created'>[];
+                };
+            } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+                data: {
+                    tag: string;
+                    data: Pick<PostModel, 'id' | 'title' | 'slug' | 'category' | 'created'>[];
+                };
+            }) ? T_1 extends unknown ? {
+                tag: string;
+                data: Pick<PostModel, "id" | "category" | "created" | "title" | "slug">[];
+            } : T_1 : never : never;
+        } : ResponseWrapper;
+        $request: {
+            [k: string]: string;
+            path: string;
+            method: string;
+        };
+    }>;
+}
+
+interface PaginationParams {
+    size?: number;
+    page?: number;
+}
+
+declare enum RefType {
+    Page = "Page",
+    Post = "Post",
+    Note = "Note"
+}
+interface CommentModel extends BaseModel {
+    refType: RefType;
+    ref: string;
+    state: number;
+    commentsIndex: number;
+    author: string;
+    text: string;
+    mail?: string;
+    url?: string;
+    ip?: string;
+    agent?: string;
+    key: string;
+    pin?: boolean;
+    avatar: string;
+    parent?: CommentModel | string;
+    children: CommentModel[];
+    isWhispers?: boolean;
+}
+interface CommentRef {
+    id: string;
+    categoryId?: string;
+    slug: string;
+    title: string;
+    category?: CategoryModel;
+}
+declare enum CommentState {
+    Unread = 0,
+    Read = 1,
+    Junk = 2
+}
+
+declare class CommentDto {
+    author: string;
+    text: string;
+    mail: string;
+    url?: string;
+}
+
+declare module '@mx-space/api-client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        comment: CommentController<ResponseWrapper>;
+    }
+}
+declare class CommentController<ResponseWrapper> implements IController {
+    private readonly client;
+    base: string;
+    name: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    /**
+     * 根据 comment id 获取评论, 包括子评论
+     */
+    getById(id: string): RequestProxyResult<CommentModel & {
+        ref: string;
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: CommentModel & {
+            ref: string;
+        };
+    } : ResponseWrapper extends {
+        data: CommentModel & {
+            ref: string;
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: CommentModel & {
+            ref: string;
+        };
+    }>;
+    /**
+     * 获取文章的评论列表
+     * @param refId 文章 Id
+     */
+    getByRefId(refId: string, pagination?: PaginationParams): RequestProxyResult<PaginateResult<CommentModel & {
+        ref: string;
+    }>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PaginateResult<CommentModel & {
+            ref: string;
+        }>;
+    } : ResponseWrapper extends {
+        data: PaginateResult<CommentModel & {
+            ref: string;
+        }>;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PaginateResult<CommentModel & {
+            ref: string;
+        }>;
+    }>;
+    /**
+     * 评论
+     */
+    comment(refId: string, data: CommentDto): RequestProxyResult<CommentModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: CommentModel;
+    } : ResponseWrapper extends {
+        data: CommentModel;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: CommentModel;
+    }>;
+    /**
+     * 回复评论
+     */
+    reply(commentId: string, data: CommentDto): RequestProxyResult<CommentModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: CommentModel;
+    } : ResponseWrapper extends {
+        data: CommentModel;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: CommentModel;
+    }>;
+}
+
+declare enum LinkType {
+    Friend = 0,
+    Collection = 1
+}
+declare enum LinkState {
+    Pass = 0,
+    Audit = 1,
+    Outdate = 2,
+    Banned = 3,
+    Reject = 4
+}
+interface LinkModel extends BaseModel {
+    name: string;
+    url: string;
+    avatar: string;
+    description?: string;
+    type: LinkType;
+    state: LinkState;
+    hide: boolean;
+    email: string;
+}
+
+type SortOptions = {
+    sortBy?: string;
+    sortOrder?: 1 | -1 | 'asc' | 'desc';
+};
+declare abstract class BaseCrudController<T, ResponseWrapper> {
+    protected client: HTTPClient;
+    base: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    getById(id: string): RequestProxyResult<T, ResponseWrapper>;
+    getAll(): RequestProxyResult<{
+        data: T[];
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            data: T[];
+        };
+    } : ResponseWrapper extends {
+        data: {
+            data: T[];
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            data: T[];
+        };
+    }>;
+    /**
+     * 带分页的查询
+     * @param page
+     * @param perPage
+     */
+    getAllPaginated(page?: number, perPage?: number, sortOption?: SortOptions): RequestProxyResult<PaginateResult<T>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PaginateResult<T>;
+    } : ResponseWrapper extends {
+        data: PaginateResult<T>;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PaginateResult<T>;
+    }>;
+}
+
+declare module '@mx-space/api-client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        link: LinkController<ResponseWrapper>;
+        friend: LinkController<ResponseWrapper>;
+    }
+}
+declare class LinkController<ResponseWrapper> extends BaseCrudController<LinkModel, ResponseWrapper> {
+    protected readonly client: HTTPClient;
+    constructor(client: HTTPClient);
+    canApplyLink(): Promise<boolean>;
+    applyLink(data: Pick<LinkModel, 'avatar' | 'name' | 'description' | 'url' | 'email'> & {
+        author: string;
+    }): Promise<never>;
+    name: string[];
+    base: string;
+}
+
+declare module '@mx-space/api-client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        note: NoteController<ResponseWrapper>;
+    }
+}
+type NoteListOptions = {
+    select?: SelectFields<keyof NoteModel>;
+    year?: number;
+    sortBy?: 'weather' | 'mood' | 'title' | 'created' | 'modified';
+    sortOrder?: 1 | -1;
+};
+declare class NoteController<ResponseWrapper> implements IController {
+    private client;
+    base: string;
+    name: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    /**
+     * 最新日记
+     */
+    getLatest(): RequestProxyResult<NoteWrappedWithLikedPayload, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: NoteWrappedWithLikedPayload;
+    } : ResponseWrapper extends {
+        data: NoteWrappedWithLikedPayload; /**
+         * 获取一篇日记，根据 Id 查询需要鉴权
+         * @param id id | nid
+         * @param password 访问密码
+         */
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: NoteWrappedWithLikedPayload;
+    }>;
+    /**
+     * 获取一篇日记，根据 Id 查询需要鉴权
+     * @param id id | nid
+     * @param password 访问密码
+     */
+    getNoteById(id: string): Promise<RequestProxyResult<NoteModel, ResponseWrapper>>;
+    getNoteById(id: number): Promise<NoteWrappedPayload>;
+    getNoteById(id: number, password: string): Promise<NoteWrappedPayload>;
+    getNoteById(id: number, password: undefined, singleResult: true): Promise<RequestProxyResult<NoteModel, ResponseWrapper>>;
+    getNoteById(id: number, password: string, singleResult: true): Promise<RequestProxyResult<NoteModel, ResponseWrapper>>;
+    /**
+     * 日记列表分页
+     */
+    getList(page?: number, perPage?: number, options?: NoteListOptions): RequestProxyResult<PaginateResult<NoteModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PaginateResult<NoteModel>;
+    } : ResponseWrapper extends {
+        data: PaginateResult<NoteModel>; /**
+         * 获取一篇日记，根据 Id 查询需要鉴权
+         * @param id id | nid
+         * @param password 访问密码
+         */
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PaginateResult<NoteModel>;
+    }>;
+    /**
+     * 获取当前日记的上下各 n / 2 篇日记
+     */
+    getMiddleList(id: string, size?: number): RequestProxyResult<{
+        data: Pick<NoteModel, 'id' | 'title' | 'nid' | 'created'>[];
+        size: number;
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            data: Pick<NoteModel, 'id' | 'title' | 'nid' | 'created'>[];
+            size: number;
+        };
+    } : ResponseWrapper extends {
+        data: {
+            data: Pick<NoteModel, 'id' | 'title' | 'nid' | 'created'>[];
+            size: number;
+        }; /**
+         * 获取一篇日记，根据 Id 查询需要鉴权
+         * @param id id | nid
+         * @param password 访问密码
+         */
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            data: Pick<NoteModel, 'id' | 'title' | 'nid' | 'created'>[];
+            size: number;
+        };
+    }>;
+    /**
+     * 喜欢这篇日记
+     */
+    likeIt(id: string | number): RequestProxyResult<never, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: never;
+    } : ResponseWrapper extends {
+        data: never; /**
+         * 获取一篇日记，根据 Id 查询需要鉴权
+         * @param id id | nid
+         * @param password 访问密码
+         */
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: never;
+    }>;
+    /**
+     * 获取专栏内的所有日记
+     */
+    getNoteByTopicId(topicId: string, page?: number, size?: number, sortOptions?: SortOptions): RequestProxyResult<PaginateResult<NoteModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PaginateResult<NoteModel>;
+    } : ResponseWrapper extends {
+        data: PaginateResult<NoteModel>; /**
+         * 获取一篇日记，根据 Id 查询需要鉴权
+         * @param id id | nid
+         * @param password 访问密码
+         */
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PaginateResult<NoteModel>;
+    }>;
+}
+
+declare module '@mx-space/api-client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        page: PageController<ResponseWrapper>;
+    }
+}
+type PageListOptions = {
+    select?: SelectFields<keyof PageModel>;
+    sortBy?: 'order' | 'subtitle' | 'title' | 'created' | 'modified';
+    sortOrder?: 1 | -1;
+};
+declare class PageController<ResponseWrapper> implements IController {
+    private readonly client;
+    constructor(client: HTTPClient);
+    base: string;
+    name: string;
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    /**
+     * 页面列表
+     */
+    getList(page?: number, perPage?: number, options?: PageListOptions): RequestProxyResult<PaginateResult<PageModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PaginateResult<PageModel>;
+    } : ResponseWrapper extends {
+        data: PaginateResult<PageModel>;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PaginateResult<PageModel>;
+    }>;
+    /**
+     * 页面详情
+     */
+    getById(id: string): RequestProxyResult<PageModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PageModel;
+    } : ResponseWrapper extends {
+        data: PageModel;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PageModel;
+    }>;
+    /**
+     * 根据路径获取页面
+     * @param slug 路径
+     * @returns
+     */
+    getBySlug(slug: string): RequestProxyResult<PageModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PageModel;
+    } : ResponseWrapper extends {
+        data: PageModel;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PageModel;
+    }>;
+}
+
+declare module '@mx-space/api-client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        post: PostController<ResponseWrapper>;
+    }
+}
+type PostListOptions = {
+    select?: SelectFields<keyof PostModel>;
+    year?: number;
+    sortBy?: 'categoryId' | 'title' | 'created' | 'modified';
+    sortOrder?: 1 | -1;
+};
+declare class PostController<ResponseWrapper> implements IController {
+    private client;
+    constructor(client: HTTPClient);
+    base: string;
+    name: string;
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    /**
+     * 获取文章列表分页
+     * @param page
+     * @param perPage
+     * @returns
+     */
+    getList(page?: number, perPage?: number, options?: PostListOptions): RequestProxyResult<PaginateResult<PostModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PaginateResult<PostModel>;
+    } : ResponseWrapper extends {
+        data: PaginateResult<PostModel>;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PaginateResult<PostModel>;
+    }>;
+    /**
+     * 根据分类和路径查找文章
+     * @param categoryName
+     * @param slug
+     */
+    getPost(categoryName: string, slug: string): RequestProxyResult<ModelWithLiked<PostModel>, ResponseWrapper>;
+    /**
+     * 根据 ID 查找文章
+     * @param id
+     */
+    getPost(id: string): RequestProxyResult<PostModel, ResponseWrapper>;
+    /**
+     * 获取最新的文章
+     */
+    getLatest(): RequestProxyResult<ModelWithLiked<PostModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: ModelWithLiked<PostModel>;
+    } : ResponseWrapper extends {
+        data: ModelWithLiked<PostModel>;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: ModelWithLiked<PostModel>;
+    }>;
+    /**
+     * 点赞
+     */
+    thumbsUp(id: string): RequestProxyResult<void, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: void;
+    } : ResponseWrapper extends {
+        data: void;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: void;
+    }>;
+}
+
+interface ProjectModel extends BaseModel {
+    name: string;
+    previewUrl?: string;
+    docUrl?: string;
+    projectUrl?: string;
+    images?: string[];
+    description: string;
+    avatar?: string;
+    text: string;
+}
+
+declare module '@mx-space/api-client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        project: ProjectController<ResponseWrapper>;
+    }
+}
+declare class ProjectController<ResponseWrapper> extends BaseCrudController<ProjectModel, ResponseWrapper> {
+    protected readonly client: HTTPClient;
+    constructor(client: HTTPClient);
+    base: string;
+    name: string;
+}
+
+declare enum RecentlyRefTypes {
+    Post = "Post",
+    Note = "Note",
+    Page = "Page"
+}
+type RecentlyRefType = {
+    title: string;
+    url: string;
+};
+interface RecentlyModel extends BaseCommentIndexModel {
+    content: string;
+    ref?: RecentlyRefType & {
+        [key: string]: any;
+    };
+    refId?: string;
+    refType?: RecentlyRefTypes;
+    up: number;
+    down: number;
+}
+
+declare module '@mx-space/api-client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        recently: RecentlyController<ResponseWrapper>;
+        shorthand: RecentlyController<ResponseWrapper>;
+    }
+}
+declare enum RecentlyAttitudeResultEnum {
+    Inc = 1,
+    Dec = -1
+}
+declare enum RecentlyAttitudeEnum {
+    Up = 0,
+    Down = 1
+}
+declare class RecentlyController<ResponseWrapper> implements IController {
+    private readonly client;
+    base: string;
+    name: string[];
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    /**
+     * 获取最新一条
+     */
+    getLatestOne(): RequestProxyResult<RecentlyModel & {
+        comments: number;
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: RecentlyModel & {
+            comments: number;
+        };
+    } : ResponseWrapper extends {
+        data: RecentlyModel & {
+            comments: number;
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: RecentlyModel & {
+            comments: number;
+        };
+    }>;
+    getAll(): RequestProxyResult<{
+        data: RecentlyModel[] & {
+            comments: number;
+        };
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            data: RecentlyModel[] & {
+                comments: number;
+            };
+        };
+    } : ResponseWrapper extends {
+        data: {
+            data: RecentlyModel[] & {
+                comments: number;
+            };
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            data: RecentlyModel[] & {
+                comments: number;
+            };
+        };
+    }>;
+    getList(before?: string | undefined, after?: string | undefined, size?: number | number): RequestProxyResult<{
+        data: RecentlyModel[] & {
+            comments: number;
+        };
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            data: RecentlyModel[] & {
+                comments: number;
+            };
+        };
+    } : ResponseWrapper extends {
+        data: {
+            data: RecentlyModel[] & {
+                comments: number;
+            };
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            data: RecentlyModel[] & {
+                comments: number;
+            };
+        };
+    }>;
+    /**  表态：点赞，点踩 */
+    attitude(id: string, attitude: RecentlyAttitudeEnum): RequestProxyResult<{
+        code: RecentlyAttitudeResultEnum;
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            code: RecentlyAttitudeResultEnum;
+        };
+    } : ResponseWrapper extends {
+        data: {
+            code: RecentlyAttitudeResultEnum;
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            code: RecentlyAttitudeResultEnum;
+        };
+    }>;
+}
+
+declare module '@mx-space/api-client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        say: SayController<ResponseWrapper>;
+    }
+}
+declare class SayController<ResponseWrapper> extends BaseCrudController<SayModel, ResponseWrapper> implements IController {
+    protected client: HTTPClient;
+    base: string;
+    name: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    /**
+     * 获取随机一条
+     */
+    getRandom(): RequestProxyResult<{
+        data: SayModel | null;
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            data: SayModel | null;
+        };
+    } : ResponseWrapper extends {
+        data: {
+            data: SayModel | null;
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            data: SayModel | null;
+        };
+    }>;
+}
+
+declare module '@mx-space/api-client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        search: SearchController<ResponseWrapper>;
+    }
+}
+type SearchOption = {
+    orderBy?: string;
+    order?: number;
+    rawAlgolia?: boolean;
+};
+declare class SearchController<ResponseWrapper> implements IController {
+    private readonly client;
+    base: string;
+    name: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    search(type: 'note', keyword: string, options?: Omit<SearchOption, 'rawAlgolia'>): Promise<RequestProxyResult<PaginateResult<Pick<NoteModel, 'modified' | 'id' | 'title' | 'created' | 'nid'>>, ResponseWrapper>>;
+    search(type: 'post', keyword: string, options?: Omit<SearchOption, 'rawAlgolia'>): Promise<RequestProxyResult<PaginateResult<Pick<PostModel, 'modified' | 'id' | 'title' | 'created' | 'slug' | 'category'>>, ResponseWrapper>>;
+    /**
+     * 从 algolya 搜索
+     * https://www.algolia.com/doc/api-reference/api-methods/search/
+     * @param keyword
+     * @param options
+     * @returns
+     */
+    searchByAlgolia(keyword: string, options?: SearchOption): RequestProxyResult<RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
+        type: 'post';
+    }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
+        type: 'note';
+    }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
+        type: 'page';
+    })> & {
+        /**
+         * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+         */
+        raw?: any;
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
+            type: 'post';
+        }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
+            type: 'note';
+        }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
+            type: 'page';
+        })> & {
+            /**
+             * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+             */
+            raw?: any;
+        };
+    } : ResponseWrapper extends {
+        data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
+            type: 'post';
+        }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
+            type: 'note';
+        }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
+            type: 'page';
+        })> & {
+            /**
+             * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+             */
+            raw?: any;
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
+            type: 'post';
+        }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
+            type: 'note';
+        }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
+            type: 'page';
+        })> & {
+            /**
+             * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+             */
+            raw?: any;
+        };
+    }>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
+            type: 'post';
+        }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
+            type: 'note';
+        }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
+            type: 'page';
+        })> & {
+            /**
+             * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+             */
+            raw?: any;
+        }, ResponseWrapper, ResponseWrapper extends unknown ? {
+            [key: string]: any;
+            data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        } : ResponseWrapper extends {
+            data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+            data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        }>;
+    } : ResponseWrapper extends {
+        data: RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
+            type: 'post';
+        }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
+            type: 'note';
+        }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
+            type: 'page';
+        })> & {
+            /**
+             * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+             */
+            raw?: any;
+        }, ResponseWrapper, ResponseWrapper extends unknown ? {
+            [key: string]: any;
+            data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        } : ResponseWrapper extends {
+            data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+            data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        }>;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
+            type: 'post';
+        }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
+            type: 'note';
+        }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
+            type: 'page';
+        })> & {
+            /**
+             * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+             */
+            raw?: any;
+        }, ResponseWrapper, ResponseWrapper extends unknown ? {
+            [key: string]: any;
+            data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        } : ResponseWrapper extends {
+            data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+            data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        }>;
+    }>;
+}
+
+declare module '@mx-space/api-client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        serverless: ServerlessController<ResponseWrapper>;
+    }
+}
+declare class ServerlessController<ResponseWrapper> implements IController {
+    protected client: HTTPClient;
+    base: string;
+    name: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    getByReferenceAndName<T = unknown>(reference: string, name: string): RequestProxyResult<T, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: T;
+    } : ResponseWrapper extends {
+        data: T;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: T;
+    }>;
+}
+
+declare module '@mx-space/api-client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        snippet: SnippetController<ResponseWrapper>;
+    }
+}
+declare class SnippetController<ResponseWrapper> implements IController {
+    protected client: HTTPClient;
+    base: string;
+    name: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    getByReferenceAndName<T = unknown>(reference: string, name: string): RequestProxyResult<T, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: T;
+    } : ResponseWrapper extends {
+        data: T;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: T;
+    }>;
+}
+
+declare module '@mx-space/api-client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        topic: TopicController<ResponseWrapper>;
+    }
+}
+declare class TopicController<ResponseWrapper> extends BaseCrudController<TopicModel, ResponseWrapper> implements IController {
+    protected client: HTTPClient;
+    base: string;
+    name: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    getTopicBySlug(slug: string): RequestProxyResult<TopicModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: TopicModel;
+    } : ResponseWrapper extends {
+        data: TopicModel;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: TopicModel;
+    }>;
+}
+
+declare module '@mx-space/api-client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        user: UserController<ResponseWrapper>;
+        master: UserController<ResponseWrapper>;
+    }
+}
+declare class UserController<ResponseWrapper> implements IController {
+    private readonly client;
+    constructor(client: HTTPClient);
+    base: string;
+    name: string[];
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    getMasterInfo(): RequestProxyResult<UserModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: UserModel;
+    } : ResponseWrapper extends {
+        data: UserModel;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: UserModel;
+    }>;
+    login(username: string, password: string): RequestProxyResult<TLogin, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: TLogin;
+    } : ResponseWrapper extends {
+        data: TLogin;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: TLogin;
+    }>;
+    loginWithToken(token?: string): RequestProxyResult<{
+        token: string;
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            token: string;
+        };
+    } : ResponseWrapper extends {
+        data: {
+            token: string;
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            token: string;
+        };
+    }>;
+    checkTokenValid(token: string): RequestProxyResult<{
+        ok: number;
+        isGuest: boolean;
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            ok: number;
+            isGuest: boolean;
+        };
+    } : ResponseWrapper extends {
+        data: {
+            ok: number;
+            isGuest: boolean;
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            ok: number;
+            isGuest: boolean;
+        };
+    }>;
+}
+
+declare const allControllers: (typeof AggregateController | typeof CategoryController | typeof CommentController | typeof LinkController | typeof NoteController | typeof PageController | typeof PostController | typeof ProjectController | typeof RecentlyController | typeof SayController | typeof SearchController | typeof ServerlessController | typeof SnippetController | typeof TopicController | typeof UserController)[];
+declare const allContollerNames: readonly ["aggregate", "category", "comment", "link", "note", "page", "post", "project", "topic", "recently", "say", "search", "snippet", "serverless", "user", "friend", "master", "shorthand"];
+
+declare enum SnippetType {
+    JSON = "json",
+    Function = "function",
+    Text = "text",
+    YAML = "yaml"
+}
+interface SnippetModel<T = unknown> extends BaseModel {
+    type: SnippetType;
+    private: boolean;
+    raw: string;
+    name: string;
+    reference: string;
+    comment?: string;
+    metatype?: string;
+    schema?: string;
+    data: T;
+}
+
+/**
+ * A simple camelCase function that only handles strings, but not handling symbol, date, or other complex case.
+ * If you need to handle more complex cases, please use camelcase-keys package.
+ */
+declare const camelcaseKeys: <T = any>(obj: any) => T;
+
+export { AdminExtraModel, AggregateController, AggregateRoot, AggregateStat, AggregateTop, AlgoliaSearchOptionsModel, BackupOptionsModel, BaiduSearchOptionsModel, BaseCommentIndexModel, BaseModel, CategoryController, CategoryEntries, CategoryModel, CategoryType, CategoryWithChildrenModel, CommentController, CommentDto, CommentModel, CommentOptionsModel, CommentRef, CommentState, Coordinate, Count, EnumPageType, HTTPClient, IConfig, IConfigKeys, Image, LinkController, LinkModel, LinkState, LinkType, MailOptionsModel, ModelWithLiked, NoteController, NoteModel, NoteMusicRecord, NoteWrappedPayload, NoteWrappedWithLikedPayload, PageController, PageModel, Pager, PaginateResult, PostController, PostModel, ProjectController, ProjectModel, RecentlyAttitudeEnum, RecentlyAttitudeResultEnum, RecentlyController, RecentlyModel, RecentlyRefType, RecentlyRefTypes, RefType, RequestError, SayController, SayModel, SearchController, SeoOptionModel, ServerlessController, SnippetController, SnippetModel, SnippetType, TLogin, TagModel, TextBaseModel, TimelineData, TimelineType, TopicController, TopicModel, Url, UrlOptionModel, UserController, UserModel, allContollerNames, allControllers, createClient, createClient as default, camelcaseKeys as simpleCamelcaseKeys };