@mx-space/api-client 0.3.1 → 0.3.5

package/build/index.d.ts

@@ -1,9 +1,14 @@
-// Generated by dts-bundle-generator v5.9.0
+// Generated by dts-bundle-generator v6.1.0
 
+export type Class<T> = new (...args: any[]) => T;
+export type SelectFields<T extends string> = `${"+" | "-" | ""}${T}`[];
 export interface IController {
 	base: string;
 	name: string;
 }
+export declare type ClientOptions = {
+	controllers?: Class<IController>[];
+};
 export interface RequestOptions {
 	method?: string;
 	data?: Record<string, any>;
@@ -43,6 +48,70 @@ export declare type ResponseProxyExtraRaw<T, R = any> = T & {
 	};
 };
 export declare type SortOrder = "asc" | "desc";
+export interface Count {
+	read: number;
+	like: number;
+}
+export interface Image {
+	height: number;
+	width: number;
+	type: string;
+	accent?: string;
+	src: string;
+}
+export interface Pager {
+	total: number;
+	size: number;
+	currentPage: number;
+	totalPage: number;
+	hasPrevPage: boolean;
+	hasNextPage: boolean;
+}
+export interface PaginateResult<T> {
+	data: T[];
+	pagination: Pager;
+}
+declare class BaseModel {
+	created?: Date;
+	id?: string;
+}
+export interface PostModel {
+	commentsIndex: number;
+	allowComment: boolean;
+	hide: boolean;
+	copyright: boolean;
+	tags: string[];
+	count: Count;
+	id: string;
+	text: string;
+	title: string;
+	slug: string;
+	categoryId: string;
+	images: Image[];
+	modified: string;
+	created: string;
+	category: CategoryModel;
+}
+declare enum CategoryType {
+	Category = 0,
+	Tag = 1
+}
+export interface CategoryModel {
+	type: CategoryType;
+	count: number;
+	id: string;
+	created: string;
+	slug: string;
+	name: string;
+	modified: string;
+}
+export declare type CategoryWithChildrenModel = CategoryModel & {
+	children: Pick<PostModel, "id" | "title" | "slug" | "modified" | "created">[];
+};
+export interface TagModel {
+	count: number;
+	name: string;
+}
 export interface NoteModel {
 	id: string;
 	hide: boolean;
@@ -101,59 +170,6 @@ export interface PageModel {
 	/** Other Options */
 	options?: object;
 }
-export interface Count {
-	read: number;
-	like: number;
-}
-export interface Image {
-	height: number;
-	width: number;
-	type: string;
-	accent?: string;
-	src: string;
-}
-export interface Pager {
-	total: number;
-	size: number;
-	currentPage: number;
-	totalPage: number;
-	hasPrevPage: boolean;
-	hasNextPage: boolean;
-}
-export interface PaginateResult<T> {
-	data: T[];
-	pagination: Pager;
-}
-declare class BaseModel {
-	created?: Date;
-	id?: string;
-}
-export interface PostModel {
-	commentsIndex: number;
-	allowComment: boolean;
-	hide: boolean;
-	copyright: boolean;
-	tags: string[];
-	count: Count;
-	id: string;
-	text: string;
-	title: string;
-	slug: string;
-	categoryId: string;
-	images: Image[];
-	modified: string;
-	created: string;
-	category: CategoryModel;
-}
-export interface CategoryModel {
-	type: number;
-	count: number;
-	id: string;
-	name: string;
-	slug: string;
-	created: Date;
-	categoryId: string;
-}
 export interface SayModel {
 	id?: string;
 	text: string;
@@ -235,7 +251,7 @@ export interface AggregateStat {
 	uv: number;
 	todayIPAccessCount: number;
 }
-declare class AggregateController implements IController {
+export declare class AggregateController implements IController {
 	private client;
 	base: string;
 	name: string;
@@ -244,62 +260,45 @@ declare class AggregateController implements IController {
 	/**
 	 * 获取聚合数据
 	 */
-	getAggregateData(): RequestProxyResult;
+	getAggregateData(): RequestProxyResult<AggregateRoot>;
 	/**
 	 * 获取最新发布的内容
 	 */
-	getTop(size?: number): RequestProxyResult;
+	getTop(size?: number): RequestProxyResult<AggregateTop, {
+		[key: string]: any;
+		data: AggregateTop;
+	}>;
 	getTimeline(options?: {
 		sort?: SortOrder;
 		type?: TimelineType;
 		year?: number;
-	}): RequestProxyResult;
+	}): RequestProxyResult<{
+		data: TimelineData;
+	}, {
+		[key: string]: any;
+		data: {
+			data: TimelineData;
+		};
+	}>;
 	/**
 	 * 获取聚合数据统计
 	 */
-	getStat(): RequestProxyResult;
-}
-declare enum CategoryType {
-	Category = 0,
-	Tag = 1
-}
-export interface CategoryModel {
-	type: CategoryType;
-	count: number;
-	id: string;
-	created: string;
-	slug: string;
-	name: string;
-	modified: string;
-}
-export declare type CategoryWithChildrenModel = CategoryModel & {
-	children: Pick<PostModel, "id" | "title" | "slug" | "modified" | "created">[];
-};
-export interface TagModel {
-	count: number;
-	name: string;
+	getStat(): RequestProxyResult<AggregateStat, {
+		[key: string]: any;
+		data: AggregateStat;
+	}>;
 }
-declare class CategoryController implements IController {
+export declare class CategoryController implements IController {
 	private client;
 	name: string;
 	base: string;
 	constructor(client: HTTPClient);
 	private get proxy();
-	getAllCategories(): import("~/interfaces/request").RequestProxyResult<{
+	getAllCategories(): RequestProxyResult<{
 		data: CategoryModel[];
-	}, {
-		[key: string]: any;
-		data: {
-			data: CategoryModel[];
-		};
 	}>;
-	getAllTags(): import("~/interfaces/request").RequestProxyResult<{
+	getAllTags(): RequestProxyResult<{
 		data: TagModel[];
-	}, {
-		[key: string]: any;
-		data: {
-			data: TagModel[];
-		};
 	}>;
 	getCategoryDetail(id: string): Promise<ResponseProxyExtraRaw<CategoryWithChildrenModel>>;
 	getCategoryDetail(ids: string[]): Promise<ResponseProxyExtraRaw<Map<string, CategoryWithChildrenModel>>>;
@@ -346,7 +345,7 @@ declare class CommentDto {
 	mail: string;
 	url?: string;
 }
-declare class CommentController implements IController {
+export declare class CommentController implements IController {
 	private readonly client;
 	base: string;
 	name: string;
@@ -355,20 +354,29 @@ declare class CommentController implements IController {
 	/**
 	 * 根据 comment id 获取评论, 包括子评论
 	 */
-	getById(id: string): RequestProxyResult;
+	getById(id: string): RequestProxyResult<CommentModel>;
 	/**
 	 * 获取文章的评论列表
 	 * @param refId 文章 Id
 	 */
-	getByRefId(refId: string, pagination?: PaginationParams): RequestProxyResult;
+	getByRefId(refId: string, pagination?: PaginationParams): RequestProxyResult<PaginateResult<CommentModel>, {
+		[key: string]: any;
+		data: PaginateResult<CommentModel>;
+	}>;
 	/**
 	 * 评论
 	 */
-	comment(refId: string, data: CommentDto): RequestProxyResult;
+	comment(refId: string, data: CommentDto): RequestProxyResult<CommentModel, {
+		[key: string]: any;
+		data: CommentModel;
+	}>;
 	/**
 	 * 回复评论
 	 */
-	reply(commentId: string, data: CommentDto): RequestProxyResult;
+	reply(commentId: string, data: CommentDto): RequestProxyResult<CommentModel, {
+		[key: string]: any;
+		data: CommentModel;
+	}>;
 }
 declare enum LinkType {
 	Friend = 0,
@@ -392,22 +400,38 @@ declare abstract class BaseCrudController<T> {
 	base: string;
 	constructor(client: HTTPClient);
 	protected get proxy(): IRequestHandler;
-	getById(id: string): RequestProxyResult;
-	getAll(): RequestProxyResult;
+	getById(id: string): RequestProxyResult<T>;
+	getAll(): RequestProxyResult<{
+		data: T[];
+	}, {
+		[key: string]: any;
+		data: {
+			data: T[];
+		};
+	}>;
 	/**
 	 * 带分页的查询
 	 * @param page
 	 * @param perPage
 	 */
-	getAllPaginated(page?: number, perPage?: number): RequestProxyResult;
+	getAllPaginated(page?: number, perPage?: number): RequestProxyResult<PaginateResult<T>, {
+		[key: string]: any;
+		data: PaginateResult<T>;
+	}>;
 }
-declare class LinkController extends BaseCrudController<LinkModel> {
+export declare class LinkController extends BaseCrudController<LinkModel> {
 	protected readonly client: HTTPClient;
 	constructor(client: HTTPClient);
 	name: string;
 	base: string;
 }
-declare class NoteController implements IController {
+export declare type NoteListOptions = {
+	select?: SelectFields<keyof NoteModel>;
+	year?: number;
+	sortBy?: "weather" | "mood" | "title" | "created" | "modified";
+	sortOrder?: 1 | -1;
+};
+export declare class NoteController implements IController {
 	private client;
 	base: string;
 	name: string;
@@ -416,27 +440,50 @@ declare class NoteController implements IController {
 	/**
 	 * 最新日记
 	 */
-	getLatest(): RequestProxyResult;
+	getLatest(): RequestProxyResult<NoteWrappedPayload>;
 	/**
 	 * 获取一篇日记
 	 * @param id id | nid
 	 * @param password 访问密码
 	 */
-	getNoteById(id: string | number, password?: string): RequestProxyResult;
+	getNoteById(id: string | number, password?: string): RequestProxyResult<NoteWrappedPayload, {
+		[key: string]: any;
+		data: NoteWrappedPayload;
+	}>;
 	/**
 	 * 日记列表分页
 	 */
-	getList(page?: number, perPage?: number): RequestProxyResult;
+	getList(page?: number, perPage?: number, options?: NoteListOptions): RequestProxyResult<PaginateResult<NoteModel>, {
+		[key: string]: any;
+		data: PaginateResult<NoteModel>;
+	}>;
 	/**
 	 * 获取当前日记的上下各 n / 2 篇日记
 	 */
-	getMiddleList(id: string, size?: number): RequestProxyResult;
+	getMiddleList(id: string, size?: number): RequestProxyResult<{
+		data: Pick<NoteModel, "id" | "title" | "nid" | "created">[];
+		size: number;
+	}, {
+		[key: string]: any;
+		data: {
+			data: Pick<NoteModel, "id" | "title" | "nid" | "created">[];
+			size: number;
+		};
+	}>;
 	/**
 	 * 喜欢这篇日记
 	 */
-	likeIt(id: string): RequestProxyResult;
+	likeIt(id: string): RequestProxyResult<never, {
+		[key: string]: any;
+		data: never;
+	}>;
 }
-declare class PageController implements IController {
+export declare type PageListOptions = {
+	select?: SelectFields<keyof PageModel>;
+	sortBy?: "order" | "subtitle" | "title" | "created" | "modified";
+	sortOrder?: 1 | -1;
+};
+export declare class PageController implements IController {
 	private readonly client;
 	constructor(client: HTTPClient);
 	base: string;
@@ -445,19 +492,34 @@ declare class PageController implements IController {
 	/**
 	 * 页面列表
 	 */
-	getList(page?: number, perPage?: number): RequestProxyResult;
+	getList(page?: number, perPage?: number, options?: PageListOptions): RequestProxyResult<PaginateResult<PageModel>, {
+		[key: string]: any;
+		data: PaginateResult<PageModel>;
+	}>;
 	/**
 	 * 页面详情
 	 */
-	getById(id: string): RequestProxyResult;
+	getById(id: string): RequestProxyResult<PageModel, {
+		[key: string]: any;
+		data: PageModel;
+	}>;
 	/**
 	 * 根据路径获取页面
 	 * @param slug 路径
 	 * @returns
 	 */
-	getBySlug(slug: string): RequestProxyResult;
+	getBySlug(slug: string): RequestProxyResult<PageModel, {
+		[key: string]: any;
+		data: PageModel;
+	}>;
 }
-declare class PostController implements IController {
+export declare type PostListOptions = {
+	select?: SelectFields<keyof PostModel>;
+	year?: number;
+	sortBy?: "categoryId" | "title" | "created" | "modified";
+	sortOrder?: 1 | -1;
+};
+export declare class PostController implements IController {
 	private client;
 	constructor(client: HTTPClient);
 	base: string;
@@ -469,7 +531,7 @@ declare class PostController implements IController {
 	 * @param perPage
 	 * @returns
 	 */
-	getList(page?: number, perPage?: number): RequestProxyResult<PaginateResult<PostModel>, {
+	getList(page?: number, perPage?: number, options?: PostListOptions): RequestProxyResult<PaginateResult<PostModel>, {
 		[key: string]: any;
 		data: PaginateResult<PostModel>;
 	}>;
@@ -510,7 +572,7 @@ export interface ProjectModel {
 	avatar?: string;
 	text: string;
 }
-declare class ProjectController extends BaseCrudController<ProjectModel> {
+export declare class ProjectController extends BaseCrudController<ProjectModel> {
 	protected readonly client: HTTPClient;
 	constructor(client: HTTPClient);
 	base: string;
@@ -521,7 +583,7 @@ export interface RecentlyModel {
 	created: string;
 	id: string;
 }
-declare class RecentlyController implements IController {
+export declare class RecentlyController implements IController {
 	private readonly client;
 	base: string;
 	name: string;
@@ -530,11 +592,28 @@ declare class RecentlyController implements IController {
 	/**
 	 * 获取最新一条
 	 */
-	getLatestOne(): RequestProxyResult;
-	getAll(): RequestProxyResult;
-	getList(before?: string | undefined, after?: string | undefined, size?: number | number): RequestProxyResult;
+	getLatestOne(): RequestProxyResult<RecentlyModel, {
+		[key: string]: any;
+		data: RecentlyModel;
+	}>;
+	getAll(): RequestProxyResult<{
+		data: RecentlyModel[];
+	}, {
+		[key: string]: any;
+		data: {
+			data: RecentlyModel[];
+		};
+	}>;
+	getList(before?: string | undefined, after?: string | undefined, size?: number | number): RequestProxyResult<{
+		data: RecentlyModel[];
+	}, {
+		[key: string]: any;
+		data: {
+			data: RecentlyModel[];
+		};
+	}>;
 }
-declare class SayController extends BaseCrudController<SayModel> implements IController {
+export declare class SayController extends BaseCrudController<SayModel> implements IController {
 	protected client: HTTPClient;
 	base: string;
 	name: string;
@@ -543,19 +622,26 @@ declare class SayController extends BaseCrudController<SayModel> implements ICon
 	/**
 	 * 获取随机一条
 	 */
-	getRandom(): RequestProxyResult;
+	getRandom(): RequestProxyResult<{
+		data: SayModel | null;
+	}, {
+		[key: string]: any;
+		data: {
+			data: SayModel | null;
+		};
+	}>;
 }
 export declare type SearchOption = {
 	orderBy?: string;
 	order?: number;
 	rawAlgolia?: boolean;
 };
-declare class SearchController implements IController {
+export declare class SearchController implements IController {
 	private readonly client;
 	base: string;
 	name: string;
 	constructor(client: HTTPClient);
-	get proxy(): import("~/interfaces/request").IRequestHandler;
+	get proxy(): IRequestHandler;
 	search(type: "note", keyword: string, options?: Omit<SearchOption, "rawAlgolia">): Promise<RequestProxyResult<PaginateResult<Pick<NoteModel, "modified" | "id" | "title" | "created" | "nid">>>>;
 	search(type: "post", keyword: string, options?: Omit<SearchOption, "rawAlgolia">): Promise<RequestProxyResult<PaginateResult<Pick<PostModel, "modified" | "id" | "title" | "created" | "slug" | "category">>>>;
 	/**
@@ -565,14 +651,14 @@ declare class SearchController implements IController {
 	 * @param options
 	 * @returns
 	 */
-	searchByAlgolia(keyword: string, options?: SearchOption): RequestProxyResult<RequestProxyResult<PaginateResult<Pick<PostModel, "created" | "id" | "modified" | "title" | "slug" | "category">> & {
+	searchByAlgolia(keyword: string, options?: SearchOption): RequestProxyResult<RequestProxyResult<PaginateResult<Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category">> & {
 		/**
 		 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
 		 */
 		raw?: any;
 	}, {
 		[key: string]: any;
-		data: PaginateResult<Pick<PostModel, "created" | "id" | "modified" | "title" | "slug" | "category">> & {
+		data: PaginateResult<Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category">> & {
 			/**
 			 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
 			 */
@@ -580,14 +666,14 @@ declare class SearchController implements IController {
 		};
 	}>, {
 		[key: string]: any;
-		data: RequestProxyResult<PaginateResult<Pick<PostModel, "created" | "id" | "modified" | "title" | "slug" | "category">> & {
+		data: RequestProxyResult<PaginateResult<Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category">> & {
 			/**
 			 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
 			 */
 			raw?: any;
 		}, {
 			[key: string]: any;
-			data: PaginateResult<Pick<PostModel, "created" | "id" | "modified" | "title" | "slug" | "category">> & {
+			data: PaginateResult<Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category">> & {
 				/**
 				 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
 				 */
@@ -609,27 +695,48 @@ export interface SnippetModel extends BaseModel {
 	comment?: string;
 	metatype?: string;
 }
-declare class SnippetController implements IController {
+export declare class SnippetController implements IController {
 	protected client: HTTPClient;
 	base: string;
 	name: string;
 	constructor(client: HTTPClient);
 	get proxy(): IRequestHandler;
-	getById(id: string): RequestProxyResult;
-	getByReferenceAndName(reference: string, name: string): RequestProxyResult;
+	getById(id: string): RequestProxyResult<SnippetModel, {
+		[key: string]: any;
+		data: SnippetModel;
+	}>;
+	getByReferenceAndName(reference: string, name: string): RequestProxyResult<SnippetModel, {
+		[key: string]: any;
+		data: SnippetModel;
+	}>;
 }
-declare class UserController implements IController {
+export declare class UserController implements IController {
 	private readonly client;
 	constructor(client: HTTPClient);
 	base: string;
 	name: string;
 	protected get proxy(): IRequestHandler;
-	getMasterInfo(): RequestProxyResult;
-	login(username: string, password: string): RequestProxyResult;
-	checkTokenValid(token: string): RequestProxyResult;
+	getMasterInfo(): RequestProxyResult<UserModel, {
+		[key: string]: any;
+		data: UserModel;
+	}>;
+	login(username: string, password: string): RequestProxyResult<TLogin, {
+		[key: string]: any;
+		data: TLogin;
+	}>;
+	checkTokenValid(token: string): RequestProxyResult<{
+		ok: number;
+		isGuest: boolean;
+	}, {
+		[key: string]: any;
+		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 SnippetController | typeof UserController)[];
-declare const allContollerNames: string[];
+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 SnippetController | typeof UserController)[];
+export declare const allContollerNames: string[];
 declare class HTTPControllerDefine {
 	aggregate: AggregateController;
 	category: CategoryController;
@@ -654,12 +761,8 @@ export declare class HTTPClient extends HTTPControllerDefine {
 	private _proxy;
 	constructor(_endpoint: string, _instance: IRequestAdapter);
 	private initGetClient;
-	injectControllers<T extends {
-		new (client: HTTPClient): IController;
-	}>(...Controller: T[]): void;
-	injectControllers<T extends {
-		new (client: HTTPClient): IController;
-	}>(Controller: T[]): void;
+	injectControllers(...Controller: Class<IController>[]): void;
+	injectControllers(Controller: Class<IController>[]): void;
 	get endpoint(): string;
 	get instance(): IRequestAdapter;
 	request(options: {
@@ -672,7 +775,7 @@ export declare class HTTPClient extends HTTPControllerDefine {
 	private resolveFullPath;
 	private buildRoute;
 }
-export declare function createClient<T extends IRequestAdapter>(adapter: T): (endpoint: string) => HTTPClient;
+export declare function createClient<T extends IRequestAdapter>(adapter: T): (endpoint: string, options?: ClientOptions | undefined) => HTTPClient;
 export declare class RequestError extends Error {
 	status: number;
 	path: string;
@@ -680,11 +783,4 @@ export declare class RequestError extends Error {
 	constructor(message: string, status: number, path: string, raw: any);
 }
 
-export {
-	NoteController as NoteClient,
-	PostController as PostClient,
-	allContollerNames as allClientName,
-	allControllers as allClients,
-};
-
 export {};