@mx-space/api-client 0.3.4 → 0.4.0

package/build/index.d.ts

@@ -1,14 +1,10 @@
-// Generated by dts-bundle-generator v6.1.0
+// Generated by dts-bundle-generator v6.2.0
 
-export declare type Class<T> = new (...args: any[]) => T;
-export declare type SelectFields<T extends string> = `${"+" | "-" | ""}${T}`[];
 export interface IController {
 	base: string;
 	name: string;
 }
-export declare type ClientOptions = {
-	controllers?: Class<IController>[];
-};
+export declare type SortOrder = "asc" | "desc";
 export interface RequestOptions {
 	method?: string;
 	data?: Record<string, any>;
@@ -16,13 +12,17 @@ export interface RequestOptions {
 	headers?: Record<string, string>;
 	[key: string]: any;
 }
-export interface IRequestAdapter {
-	get<P = unknown>(url: string, options?: RequestOptions): Promise<P>;
-	post<P = unknown>(url: string, options?: RequestOptions): Promise<P>;
-	patch<P = unknown>(url: string, options?: RequestOptions): Promise<P>;
-	delete<P = unknown>(url: string, options?: RequestOptions): Promise<P>;
-	put<P = unknown>(url: string, options?: RequestOptions): Promise<P>;
-}
+export declare type RequestResponseType<P> = Promise<Record<string, any> & {
+	data: P;
+}>;
+export declare type IRequestAdapter<T = any> = Readonly<{
+	default: T;
+	get<P = unknown>(url: string, options?: RequestOptions): RequestResponseType<P>;
+	post<P = unknown>(url: string, options?: RequestOptions): RequestResponseType<P>;
+	patch<P = unknown>(url: string, options?: RequestOptions): RequestResponseType<P>;
+	delete<P = unknown>(url: string, options?: RequestOptions): RequestResponseType<P>;
+	put<P = unknown>(url: string, options?: RequestOptions): RequestResponseType<P>;
+}>;
 export declare type NoStringIndex<T> = {
 	[K in keyof T as string extends K ? never : K]: T[K];
 };
@@ -47,7 +47,6 @@ export declare type ResponseProxyExtraRaw<T, R = any> = T & {
 		[k: string]: string;
 	};
 };
-export declare type SortOrder = "asc" | "desc";
 export interface Count {
 	read: number;
 	like: number;
@@ -251,6 +250,56 @@ export interface AggregateStat {
 	uv: number;
 	todayIPAccessCount: number;
 }
+export type Class<T> = new (...args: any[]) => T;
+export type SelectFields<T extends string> = `${"+" | "-" | ""}${T}`[];
+export declare type ClientOptions = {
+	controllers?: Class<IController>[];
+};
+declare class HTTPControllerDefine {
+	aggregate: AggregateController;
+	category: CategoryController;
+	comment: CommentController;
+	link: LinkController;
+	note: NoteController;
+	page: PageController;
+	post: PostController;
+	project: ProjectController;
+	recently: RecentlyController;
+	say: SayController;
+	search: SearchController;
+	snippet: SnippetController;
+	user: UserController;
+	get master(): UserController;
+	get friend(): LinkController;
+	get shorthand(): RecentlyController;
+}
+export declare class HTTPClient<T extends IRequestAdapter = IRequestAdapter> extends HTTPControllerDefine {
+	private _endpoint;
+	private _adaptor;
+	private _proxy;
+	constructor(_endpoint: string, _adaptor: T);
+	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;
+	}): any;
+	get proxy(): IRequestHandler;
+	private resolveFullPath;
+	private buildRoute;
+}
+export declare function createClient<T extends IRequestAdapter>(adapter: T): (endpoint: string, options?: ClientOptions | undefined) => HTTPClient<T>;
+export declare class RequestError extends Error {
+	status: number;
+	path: string;
+	raw: any;
+	constructor(message: string, status: number, path: string, raw: any);
+}
 export declare class AggregateController implements IController {
 	private client;
 	base: string;
@@ -354,29 +403,26 @@ export declare class CommentController implements IController {
 	/**
 	 * 根据 comment id 获取评论, 包括子评论
 	 */
-	getById(id: string): import("~/interfaces/request").RequestProxyResult<CommentModel, {
-		[key: string]: any;
-		data: CommentModel;
-	}>;
+	getById(id: string): RequestProxyResult<CommentModel>;
 	/**
 	 * 获取文章的评论列表
 	 * @param refId 文章 Id
 	 */
-	getByRefId(refId: string, pagination?: PaginationParams): import("~/interfaces/request").RequestProxyResult<PaginateResult<CommentModel>, {
+	getByRefId(refId: string, pagination?: PaginationParams): RequestProxyResult<PaginateResult<CommentModel>, {
 		[key: string]: any;
 		data: PaginateResult<CommentModel>;
 	}>;
 	/**
 	 * 评论
 	 */
-	comment(refId: string, data: CommentDto): import("~/interfaces/request").RequestProxyResult<CommentModel, {
+	comment(refId: string, data: CommentDto): RequestProxyResult<CommentModel, {
 		[key: string]: any;
 		data: CommentModel;
 	}>;
 	/**
 	 * 回复评论
 	 */
-	reply(commentId: string, data: CommentDto): import("~/interfaces/request").RequestProxyResult<CommentModel, {
+	reply(commentId: string, data: CommentDto): RequestProxyResult<CommentModel, {
 		[key: string]: any;
 		data: CommentModel;
 	}>;
@@ -443,30 +489,27 @@ export declare class NoteController implements IController {
 	/**
 	 * 最新日记
 	 */
-	getLatest(): import("~/interfaces/request").RequestProxyResult<NoteWrappedPayload, {
-		[key: string]: any;
-		data: NoteWrappedPayload;
-	}>;
+	getLatest(): RequestProxyResult<NoteWrappedPayload>;
 	/**
 	 * 获取一篇日记
 	 * @param id id | nid
 	 * @param password 访问密码
 	 */
-	getNoteById(id: string | number, password?: string): import("~/interfaces/request").RequestProxyResult<NoteWrappedPayload, {
+	getNoteById(id: string | number, password?: string): RequestProxyResult<NoteWrappedPayload, {
 		[key: string]: any;
 		data: NoteWrappedPayload;
 	}>;
 	/**
 	 * 日记列表分页
 	 */
-	getList(page?: number, perPage?: number, options?: NoteListOptions): import("~/interfaces/request").RequestProxyResult<PaginateResult<NoteModel>, {
+	getList(page?: number, perPage?: number, options?: NoteListOptions): RequestProxyResult<PaginateResult<NoteModel>, {
 		[key: string]: any;
 		data: PaginateResult<NoteModel>;
 	}>;
 	/**
 	 * 获取当前日记的上下各 n / 2 篇日记
 	 */
-	getMiddleList(id: string, size?: number): import("~/interfaces/request").RequestProxyResult<{
+	getMiddleList(id: string, size?: number): RequestProxyResult<{
 		data: Pick<NoteModel, "id" | "title" | "nid" | "created">[];
 		size: number;
 	}, {
@@ -479,7 +522,7 @@ export declare class NoteController implements IController {
 	/**
 	 * 喜欢这篇日记
 	 */
-	likeIt(id: string): import("~/interfaces/request").RequestProxyResult<never, {
+	likeIt(id: string): RequestProxyResult<never, {
 		[key: string]: any;
 		data: never;
 	}>;
@@ -498,14 +541,14 @@ export declare class PageController implements IController {
 	/**
 	 * 页面列表
 	 */
-	getList(page?: number, perPage?: number, options?: PageListOptions): import("~/interfaces/request").RequestProxyResult<PaginateResult<PageModel>, {
+	getList(page?: number, perPage?: number, options?: PageListOptions): RequestProxyResult<PaginateResult<PageModel>, {
 		[key: string]: any;
 		data: PaginateResult<PageModel>;
 	}>;
 	/**
 	 * 页面详情
 	 */
-	getById(id: string): import("~/interfaces/request").RequestProxyResult<PageModel, {
+	getById(id: string): RequestProxyResult<PageModel, {
 		[key: string]: any;
 		data: PageModel;
 	}>;
@@ -514,7 +557,7 @@ export declare class PageController implements IController {
 	 * @param slug 路径
 	 * @returns
 	 */
-	getBySlug(slug: string): import("~/interfaces/request").RequestProxyResult<PageModel, {
+	getBySlug(slug: string): RequestProxyResult<PageModel, {
 		[key: string]: any;
 		data: PageModel;
 	}>;
@@ -598,11 +641,11 @@ export declare class RecentlyController implements IController {
 	/**
 	 * 获取最新一条
 	 */
-	getLatestOne(): import("~/interfaces/request").RequestProxyResult<RecentlyModel, {
+	getLatestOne(): RequestProxyResult<RecentlyModel, {
 		[key: string]: any;
 		data: RecentlyModel;
 	}>;
-	getAll(): import("~/interfaces/request").RequestProxyResult<{
+	getAll(): RequestProxyResult<{
 		data: RecentlyModel[];
 	}, {
 		[key: string]: any;
@@ -610,7 +653,7 @@ export declare class RecentlyController implements IController {
 			data: RecentlyModel[];
 		};
 	}>;
-	getList(before?: string | undefined, after?: string | undefined, size?: number | number): import("~/interfaces/request").RequestProxyResult<{
+	getList(before?: string | undefined, after?: string | undefined, size?: number | number): RequestProxyResult<{
 		data: RecentlyModel[];
 	}, {
 		[key: string]: any;
@@ -628,7 +671,7 @@ export declare class SayController extends BaseCrudController<SayModel> implemen
 	/**
 	 * 获取随机一条
 	 */
-	getRandom(): import("~/interfaces/request").RequestProxyResult<{
+	getRandom(): RequestProxyResult<{
 		data: SayModel | null;
 	}, {
 		[key: string]: any;
@@ -707,11 +750,11 @@ export declare class SnippetController implements IController {
 	name: string;
 	constructor(client: HTTPClient);
 	get proxy(): IRequestHandler;
-	getById(id: string): import("~/interfaces/request").RequestProxyResult<SnippetModel, {
+	getById(id: string): RequestProxyResult<SnippetModel, {
 		[key: string]: any;
 		data: SnippetModel;
 	}>;
-	getByReferenceAndName(reference: string, name: string): import("~/interfaces/request").RequestProxyResult<SnippetModel, {
+	getByReferenceAndName(reference: string, name: string): RequestProxyResult<SnippetModel, {
 		[key: string]: any;
 		data: SnippetModel;
 	}>;
@@ -722,15 +765,15 @@ export declare class UserController implements IController {
 	base: string;
 	name: string;
 	protected get proxy(): IRequestHandler;
-	getMasterInfo(): import("~/interfaces/request").RequestProxyResult<UserModel, {
+	getMasterInfo(): RequestProxyResult<UserModel, {
 		[key: string]: any;
 		data: UserModel;
 	}>;
-	login(username: string, password: string): import("~/interfaces/request").RequestProxyResult<TLogin, {
+	login(username: string, password: string): RequestProxyResult<TLogin, {
 		[key: string]: any;
 		data: TLogin;
 	}>;
-	checkTokenValid(token: string): import("~/interfaces/request").RequestProxyResult<{
+	checkTokenValid(token: string): RequestProxyResult<{
 		ok: number;
 		isGuest: boolean;
 	}, {
@@ -743,50 +786,5 @@ export declare class UserController implements IController {
 }
 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;
-	comment: CommentController;
-	link: LinkController;
-	note: NoteController;
-	page: PageController;
-	post: PostController;
-	project: ProjectController;
-	recently: RecentlyController;
-	say: SayController;
-	search: SearchController;
-	snippet: SnippetController;
-	user: UserController;
-	get master(): UserController;
-	get friend(): LinkController;
-	get shorthand(): RecentlyController;
-}
-export declare class HTTPClient extends HTTPControllerDefine {
-	private _endpoint;
-	private _instance;
-	private _proxy;
-	constructor(_endpoint: string, _instance: IRequestAdapter);
-	private initGetClient;
-	injectControllers(...Controller: Class<IController>[]): void;
-	injectControllers(Controller: Class<IController>[]): void;
-	get endpoint(): string;
-	get instance(): IRequestAdapter;
-	request(options: {
-		url: string;
-		method?: string;
-		data?: any;
-		params?: any;
-	}): any;
-	get proxy(): IRequestHandler;
-	private resolveFullPath;
-	private buildRoute;
-}
-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;
-	raw: any;
-	constructor(message: string, status: number, path: string, raw: any);
-}
 
 export {};