@mx-space/api-client 0.7.0 → 0.7.3

package/types/controllers/category.d.ts

@@ -0,0 +1,114 @@
+import { IRequestAdapter } from '../interfaces/adapter';
+import { IController } from '../interfaces/controller';
+import { IRequestHandler, RequestProxyResult, ResponseProxyExtraRaw } from '../interfaces/request';
+import { HTTPClient } from '../core/client';
+import { CategoryModel, CategoryType, CategoryWithChildrenModel, TagModel } from '../models/category';
+import { PostModel } from '../models/post';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        category: CategoryController<ResponseWrapper>;
+    }
+}
+export 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" | "title" | "slug" | "modified" | "created">[];
+    } & {
+        $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 unknown ? {
+                type: CategoryType;
+                count: number;
+                slug: string;
+                name: string;
+                created: string;
+                id: string;
+                children: Pick<PostModel, "id" | "title" | "slug" | "modified" | "created">[];
+            } : ResponseWrapper extends unknown ? {
+                [key: string]: any;
+                data: CategoryWithChildrenModel;
+            } : ResponseWrapper extends {
+                data: CategoryWithChildrenModel;
+            } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+                data: CategoryWithChildrenModel;
+            };
+        } : 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 unknown ? {
+                tag: string;
+                data: Pick<PostModel, "id" | "title" | "slug" | "created" | "category">[];
+            } : 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'>[];
+                };
+            };
+        } : ResponseWrapper;
+        $request: {
+            [k: string]: string;
+            path: string;
+            method: string;
+        };
+    }>;
+}

package/types/controllers/comment.d.ts

@@ -0,0 +1,81 @@
+import { IRequestAdapter } from '../interfaces/adapter';
+import { IController } from '../interfaces/controller';
+import { PaginationParams } from '../interfaces/params';
+import { IRequestHandler } from '../interfaces/request';
+import { PaginateResult } from '../models/base';
+import { CommentModel } from '../models/comment';
+import { HTTPClient } from '../core';
+import { CommentDto } from '../dtos/comment';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        comment: CommentController<ResponseWrapper>;
+    }
+}
+export 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): import("../interfaces/request").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): import("../interfaces/request").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): import("../interfaces/request").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): import("../interfaces/request").RequestProxyResult<CommentModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: CommentModel;
+    } : ResponseWrapper extends {
+        data: CommentModel;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: CommentModel;
+    }>;
+}

package/types/controllers/index.d.ts

@@ -0,0 +1,17 @@
+import { AggregateController } from './aggregate';
+import { CategoryController } from './category';
+import { CommentController } from './comment';
+import { LinkController } from './link';
+import { NoteController } from './note';
+import { PageController } from './page';
+import { PostController } from './post';
+import { ProjectController } from './project';
+import { RecentlyController } from './recently';
+import { SayController } from './say';
+import { SearchController } from './search';
+import { ServerlessController } from './severless';
+import { SnippetController } from './snippet';
+import { UserController } from './user';
+export 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 UserController)[];
+export declare const allContollerNames: readonly ["aggregate", "category", "comment", "link", "note", "page", "post", "project", "recently", "say", "search", "snippet", "serverless", "user", "friend", "master", "shorthand"];
+export { AggregateController, CategoryController, CommentController, LinkController, NoteController, PageController, PostController, ProjectController, RecentlyController, SayController, SearchController, SnippetController, ServerlessController, UserController, };

package/types/controllers/link.d.ts

@@ -0,0 +1,16 @@
+import { IRequestAdapter } from '../interfaces/adapter';
+import { LinkModel } from '../models/link';
+import { HTTPClient } from '../core';
+import { BaseCrudController } from './base';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        link: LinkController<ResponseWrapper>;
+        friend: LinkController<ResponseWrapper>;
+    }
+}
+export declare class LinkController<ResponseWrapper> extends BaseCrudController<LinkModel, ResponseWrapper> {
+    protected readonly client: HTTPClient;
+    constructor(client: HTTPClient);
+    name: string[];
+    base: string;
+}

package/types/controllers/note.d.ts

@@ -0,0 +1,94 @@
+import { IRequestAdapter } from '../interfaces/adapter';
+import { IController } from '../interfaces/controller';
+import { IRequestHandler } from '../interfaces/request';
+import { SelectFields } from '../interfaces/types';
+import { PaginateResult } from '../models/base';
+import { NoteModel, NoteWrappedPayload } from '../models/note';
+import { HTTPClient } from '../core/client';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        note: NoteController<ResponseWrapper>;
+    }
+}
+export declare type NoteListOptions = {
+    select?: SelectFields<keyof NoteModel>;
+    year?: number;
+    sortBy?: 'weather' | 'mood' | 'title' | 'created' | 'modified';
+    sortOrder?: 1 | -1;
+};
+export declare class NoteController<ResponseWrapper> implements IController {
+    private client;
+    base: string;
+    name: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    /**
+     * 最新日记
+     */
+    getLatest(): import("../interfaces/request").RequestProxyResult<NoteWrappedPayload, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: NoteWrappedPayload;
+    } : ResponseWrapper extends {
+        data: NoteWrappedPayload;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: NoteWrappedPayload;
+    }>;
+    /**
+     * 获取一篇日记
+     * @param id id | nid
+     * @param password 访问密码
+     */
+    getNoteById(id: string | number, password?: string): import("../interfaces/request").RequestProxyResult<NoteWrappedPayload, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: NoteWrappedPayload;
+    } : ResponseWrapper extends {
+        data: NoteWrappedPayload;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: NoteWrappedPayload;
+    }>;
+    /**
+     * 日记列表分页
+     */
+    getList(page?: number, perPage?: number, options?: NoteListOptions): import("../interfaces/request").RequestProxyResult<PaginateResult<NoteModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PaginateResult<NoteModel>;
+    } : ResponseWrapper extends {
+        data: PaginateResult<NoteModel>;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PaginateResult<NoteModel>;
+    }>;
+    /**
+     * 获取当前日记的上下各 n / 2 篇日记
+     */
+    getMiddleList(id: string, size?: number): import("../interfaces/request").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;
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            data: Pick<NoteModel, 'id' | 'title' | 'nid' | 'created'>[];
+            size: number;
+        };
+    }>;
+    /**
+     * 喜欢这篇日记
+     */
+    likeIt(id: string | number): import("../interfaces/request").RequestProxyResult<never, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: never;
+    } : ResponseWrapper extends {
+        data: never;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: never;
+    }>;
+}

package/types/controllers/page.d.ts

@@ -0,0 +1,59 @@
+import { IRequestAdapter } from '../interfaces/adapter';
+import { IController } from '../interfaces/controller';
+import { IRequestHandler } from '../interfaces/request';
+import { SelectFields } from '../interfaces/types';
+import { PaginateResult } from '../models/base';
+import { PageModel } from '../models/page';
+import { HTTPClient } from '../core';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        page: PageController<ResponseWrapper>;
+    }
+}
+export declare type PageListOptions = {
+    select?: SelectFields<keyof PageModel>;
+    sortBy?: 'order' | 'subtitle' | 'title' | 'created' | 'modified';
+    sortOrder?: 1 | -1;
+};
+export 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): import("../interfaces/request").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): import("../interfaces/request").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): import("../interfaces/request").RequestProxyResult<PageModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PageModel;
+    } : ResponseWrapper extends {
+        data: PageModel;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PageModel;
+    }>;
+}

package/types/controllers/post.d.ts

@@ -0,0 +1,72 @@
+import { IRequestAdapter } from '../interfaces/adapter';
+import { IController } from '../interfaces/controller';
+import { IRequestHandler, RequestProxyResult } from '../interfaces/request';
+import { SelectFields } from '../interfaces/types';
+import { PaginateResult } from '../models/base';
+import { PostModel } from '../models/post';
+import { HTTPClient } from '../core/client';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        post: PostController<ResponseWrapper>;
+    }
+}
+export declare type PostListOptions = {
+    select?: SelectFields<keyof PostModel>;
+    year?: number;
+    sortBy?: 'categoryId' | 'title' | 'created' | 'modified';
+    sortOrder?: 1 | -1;
+};
+export 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<PostModel, ResponseWrapper>;
+    /**
+     * 根据 ID 查找文章
+     * @param id
+     */
+    getPost(id: string): RequestProxyResult<PostModel, ResponseWrapper>;
+    /**
+     * 获取最新的文章
+     */
+    getLatest(): RequestProxyResult<PostModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PostModel;
+    } : ResponseWrapper extends {
+        data: PostModel;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: 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;
+    }>;
+}

package/types/controllers/project.d.ts

@@ -0,0 +1,15 @@
+import { IRequestAdapter } from '../interfaces/adapter';
+import { ProjectModel } from '../models/project';
+import { HTTPClient } from '../core';
+import { BaseCrudController } from './base';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        project: ProjectController<ResponseWrapper>;
+    }
+}
+export declare class ProjectController<ResponseWrapper> extends BaseCrudController<ProjectModel, ResponseWrapper> {
+    protected readonly client: HTTPClient;
+    constructor(client: HTTPClient);
+    base: string;
+    name: string;
+}

package/types/controllers/recently.d.ts

@@ -0,0 +1,61 @@
+import { IRequestAdapter } from '../interfaces/adapter';
+import { IController } from '../interfaces/controller';
+import { IRequestHandler } from '../interfaces/request';
+import { RecentlyModel } from '../models/recently';
+import { HTTPClient } from '../core';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        recently: RecentlyController<ResponseWrapper>;
+        shorthand: RecentlyController<ResponseWrapper>;
+    }
+}
+export declare class RecentlyController<ResponseWrapper> implements IController {
+    private readonly client;
+    base: string;
+    name: string[];
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    /**
+     * 获取最新一条
+     */
+    getLatestOne(): import("../interfaces/request").RequestProxyResult<RecentlyModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: RecentlyModel;
+    } : ResponseWrapper extends {
+        data: RecentlyModel;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: RecentlyModel;
+    }>;
+    getAll(): import("../interfaces/request").RequestProxyResult<{
+        data: RecentlyModel[];
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            data: RecentlyModel[];
+        };
+    } : ResponseWrapper extends {
+        data: {
+            data: RecentlyModel[];
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            data: RecentlyModel[];
+        };
+    }>;
+    getList(before?: string | undefined, after?: string | undefined, size?: number | number): import("../interfaces/request").RequestProxyResult<{
+        data: RecentlyModel[];
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            data: RecentlyModel[];
+        };
+    } : ResponseWrapper extends {
+        data: {
+            data: RecentlyModel[];
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            data: RecentlyModel[];
+        };
+    }>;
+}

package/types/controllers/say.d.ts

@@ -0,0 +1,37 @@
+import { IRequestAdapter } from '../interfaces/adapter';
+import { IController } from '../interfaces/controller';
+import { IRequestHandler } from '../interfaces/request';
+import { SayModel } from '../models/say';
+import { HTTPClient } from '../core';
+import { BaseCrudController } from './base';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        say: SayController<ResponseWrapper>;
+    }
+}
+export 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(): import("../interfaces/request").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;
+        };
+    }>;
+}