@mx-space/api-client 0.0.4 → 0.3.0

package/build/index.d.ts

@@ -1,13 +1,14 @@
 // Generated by dts-bundle-generator v5.9.0
 
-export interface IClient {
+export interface IController {
 	base: string;
 	name: string;
 }
 export interface RequestOptions {
 	method?: string;
-	data?: string;
-	params?: Record<string, any>;
+	data?: Record<string, any>;
+	params?: Record<string, any> | URLSearchParams;
+	headers?: Record<string, string>;
 	[key: string]: any;
 }
 export interface IRequestAdapter {
@@ -17,24 +18,88 @@ export interface IRequestAdapter {
 	delete<P = unknown>(url: string, options?: RequestOptions): Promise<P>;
 	put<P = unknown>(url: string, options?: RequestOptions): Promise<P>;
 }
-export interface IRequestHandler<T = RequestOptions> {
+export declare type NoStringIndex<T> = {
+	[K in keyof T as string extends K ? never : K]: T[K];
+};
+export interface IRequestHandler {
 	(id?: string): IRequestHandler;
-	get<P = unknown>(options?: T): RequestProxyResult<P>;
-	post<P = unknown>(options?: T): RequestProxyResult<P>;
-	patch<P = unknown>(options?: T): RequestProxyResult<P>;
-	delete<P = unknown>(options?: T): RequestProxyResult<P>;
-	put<P = unknown>(options?: T): RequestProxyResult<P>;
+	get<P = unknown>(options?: Omit<NoStringIndex<RequestOptions>, "data">): RequestProxyResult<P>;
+	post<P = unknown>(options?: RequestOptions): RequestProxyResult<P>;
+	patch<P = unknown>(options?: RequestOptions): RequestProxyResult<P>;
+	delete<P = unknown>(options?: Omit<NoStringIndex<RequestOptions>, "data">): RequestProxyResult<P>;
+	put<P = unknown>(options?: RequestOptions): RequestProxyResult<P>;
 	[key: string]: IRequestHandler;
 }
 export declare type RequestProxyResult<T, R = {
 	data: T;
 	[key: string]: any;
-}> = Promise<T & {
+}> = Promise<ResponseProxyExtraRaw<T, R>>;
+export declare type ResponseProxyExtraRaw<T, R = any> = T & {
 	raw: R;
-}>;
-export declare class NoteClient implements IClient {
-	base: string;
-	name: string;
+	request: {
+		path: string;
+		method: string;
+		[k: string]: string;
+	};
+};
+export declare type SortOrder = "asc" | "desc";
+export interface NoteModel {
+	id: string;
+	hide: boolean;
+	count: {
+		read: number;
+		like: number;
+	};
+	title: string;
+	text: string;
+	mood?: string;
+	weather?: string;
+	hasMemory?: boolean;
+	created: string;
+	modified: string;
+	secret?: Date;
+	password?: string | null;
+	nid: number;
+	music?: NoteMusicRecord[];
+	location?: string;
+	coordinates?: Coordinate;
+}
+export interface NoteMusicRecord {
+	type: string;
+	id: string;
+}
+export interface Coordinate {
+	latitude: number;
+	longitude: number;
+}
+export interface NoteWrappedPayload {
+	data: NoteModel;
+	next?: Partial<NoteModel>;
+	prev?: Partial<NoteModel>;
+}
+declare enum EnumPageType {
+	"md" = "md",
+	"html" = "html",
+	"frame" = "frame"
+}
+export interface PageModel {
+	created: string;
+	modified: string;
+	id: string;
+	/** Slug */
+	slug: string;
+	/** Title */
+	title: string;
+	/** SubTitle */
+	subtitle?: string;
+	/** Order */
+	order?: number;
+	/** Text */
+	text: string;
+	/** Type (MD | html | frame) */
+	type?: EnumPageType;
+	/** Other Options */
+	options?: object;
 }
 export interface Count {
 	read: number;
@@ -55,8 +120,8 @@ export interface Pager {
 	hasPrevPage: boolean;
 	hasNextPage: boolean;
 }
-export interface PostResponse {
-	data: PostModel[];
+export interface PaginateResult<T> {
+	data: T[];
 	pagination: Pager;
 }
 export interface PostModel {
@@ -75,7 +140,6 @@ export interface PostModel {
 	modified: string;
 	created: string;
 	category: CategoryModel;
-	datumID: string;
 }
 export interface CategoryModel {
 	type: number;
@@ -84,36 +148,473 @@ export interface CategoryModel {
 	name: string;
 	slug: string;
 	created: Date;
-	categoryID: string;
+	categoryId: string;
+}
+export interface SayModel {
+	id?: string;
+	text: string;
+	source?: string;
+	author?: string;
+}
+declare class SeoOptionModel {
+	title: string;
+	description: string;
+	icon?: string;
+	keywords?: string[];
+}
+export interface UserModel {
+	ok: number;
+	id: string;
+	introduce: string;
+	mail: string;
+	url: string;
+	name: string;
+	socialIDS: SocialIDS & Record<string, string>;
+	username: string;
+	created: Date;
+	modified: Date;
+	v: number;
+	lastLoginTime: string;
+	lastLoginIp?: string;
+	avatar: string;
+	postID: string;
+}
+export interface SocialIDS {
+	biliID: number;
+	neteaseID: number;
+	github: string;
+}
+export declare type TLogin = {
+	token: string;
+	expiresIn: number;
+	lastLoginTime: null | string;
+	lastLoginIp?: null | string;
+} & Pick<UserModel, "name" | "username" | "created" | "url" | "mail" | "avatar" | "id">;
+export interface AggregateRoot {
+	user: UserModel;
+	seo: SeoOptionModel;
+	categories: CategoryModel[];
+	pageMeta: Pick<PageModel, "title" | "id" | "slug" | "order">[] | null;
+	lastestNoteNid: number | null;
 }
-export declare class PostClient implements IClient {
+export 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
+}
+export interface TimelineData {
+	notes?: Pick<NoteModel, "id" | "nid" | "title" | "weather" | "mood" | "created" | "modified" | "hasMemory">[];
+	posts?: (Pick<PostModel, "id" | "title" | "slug" | "created" | "modified" | "category"> & {
+		url: string;
+	})[];
+}
+export 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 class AggregateController implements IController {
 	private client;
+	base: string;
+	name: string;
+	constructor(client: HTTPClient);
+	private get proxy();
+	/**
+	 * 获取聚合数据
+	 */
+	getAggregateData(): RequestProxyResult;
+	/**
+	 * 获取最新发布的内容
+	 */
+	getTop(size?: number): RequestProxyResult;
+	getTimeline(options?: {
+		sort?: SortOrder;
+		type?: TimelineType;
+		year?: number;
+	}): RequestProxyResult;
+	/**
+	 * 获取聚合数据统计
+	 */
+	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;
+}
+declare class CategoryController implements IController {
+	private client;
+	name: string;
+	base: string;
+	constructor(client: HTTPClient);
+	private get proxy();
+	getAllCategories(): import("~/interfaces/request").RequestProxyResult<{
+		data: CategoryModel[];
+	}, {
+		[key: string]: any;
+		data: {
+			data: CategoryModel[];
+		};
+	}>;
+	getAllTags(): import("~/interfaces/request").RequestProxyResult<{
+		data: TagModel[];
+	}, {
+		[key: string]: any;
+		data: {
+			data: TagModel[];
+		};
+	}>;
+	getCategoryDetail(id: string): Promise<ResponseProxyExtraRaw<CategoryWithChildrenModel>>;
+	getCategoryDetail(ids: string[]): Promise<ResponseProxyExtraRaw<Map<string, CategoryWithChildrenModel>>>;
+	getCategoryByIdOrSlug(idOrSlug: string): Promise<ResponseProxyExtraRaw<CategoryWithChildrenModel, {
+		[key: string]: any;
+		data: CategoryWithChildrenModel;
+	}>>;
+	getTagByName(name: string): Promise<ResponseProxyExtraRaw<{
+		tag: string;
+		data: Pick<PostModel, "id" | "title" | "slug" | "category" | "created">[];
+	}, {
+		[key: string]: any;
+		data: {
+			tag: string;
+			data: Pick<PostModel, "id" | "title" | "slug" | "category" | "created">[];
+		};
+	}>>;
+}
+export interface PaginationParams {
+	size?: number;
+	page?: number;
+}
+export interface CommentModel {
+	refType: string;
+	state: number;
+	children: CommentModel[];
+	commentsIndex: number;
+	id: string;
+	author: string;
+	text: string;
+	mail: string;
+	url: string;
+	ip: string;
+	agent: string;
+	key: string;
+	pid: string;
+	created: string;
+	modified: string;
+	avatar: string;
+}
+declare class CommentDto {
+	author: string;
+	text: string;
+	mail: string;
+	url?: string;
+}
+declare class CommentController implements IController {
+	private readonly client;
+	base: string;
+	name: string;
+	constructor(client: HTTPClient);
+	get proxy(): IRequestHandler;
+	/**
+	 * 根据 comment id 获取评论, 包括子评论
+	 */
+	getById(id: string): RequestProxyResult;
+	/**
+	 * 获取文章的评论列表
+	 * @param refId 文章 Id
+	 */
+	getByRefId(refId: string, pagination?: PaginationParams): RequestProxyResult;
+	/**
+	 * 评论
+	 */
+	comment(refId: string, data: CommentDto): RequestProxyResult;
+	/**
+	 * 回复评论
+	 */
+	reply(commentId: string, data: CommentDto): RequestProxyResult;
+}
+declare enum LinkType {
+	Friend = 0,
+	Collection = 1
+}
+declare enum LinkState {
+	Pass = 0,
+	Audit = 1
+}
+export interface LinkModel {
+	id: string;
+	name: string;
+	url: string;
+	avatar: string;
+	description?: string;
+	type: LinkType;
+	state: LinkState;
+}
+declare abstract class BaseCrudController<T> {
+	protected client: HTTPClient;
+	base: string;
+	constructor(client: HTTPClient);
+	protected get proxy(): IRequestHandler;
+	getById(id: string): RequestProxyResult;
+	getAll(): RequestProxyResult;
+	/**
+	 * 带分页的查询
+	 * @param page
+	 * @param perPage
+	 */
+	getAllPaginated(page?: number, perPage?: number): RequestProxyResult;
+}
+declare class LinkController extends BaseCrudController<LinkModel> {
+	protected readonly client: HTTPClient;
+	constructor(client: HTTPClient);
+	name: string;
+	base: string;
+}
+declare class NoteController implements IController {
+	private client;
+	base: string;
+	name: string;
+	constructor(client: HTTPClient);
+	get proxy(): IRequestHandler;
+	/**
+	 * 最新日记
+	 */
+	getLatest(): RequestProxyResult;
+	/**
+	 * 获取一篇日记
+	 * @param id id | nid
+	 * @param password 访问密码
+	 */
+	getNoteById(id: string | number, password?: string): RequestProxyResult;
+	/**
+	 * 日记列表分页
+	 */
+	getList(page?: number, perPage?: number): RequestProxyResult;
+	/**
+	 * 获取当前日记的上下各 n / 2 篇日记
+	 */
+	getMiddleList(id: string, size?: number): RequestProxyResult;
+	/**
+	 * 喜欢这篇日记
+	 */
+	likeIt(id: string): RequestProxyResult;
+}
+declare class PageController implements IController {
+	private readonly client;
 	constructor(client: HTTPClient);
 	base: string;
 	name: string;
-	getPosts(page?: number, perPage?: number): RequestProxyResult<PostResponse, {
+	get proxy(): IRequestHandler;
+	/**
+	 * 页面列表
+	 */
+	getList(page?: number, perPage?: number): RequestProxyResult;
+	/**
+	 * 页面详情
+	 */
+	getById(id: string): RequestProxyResult;
+	/**
+	 * 根据路径获取页面
+	 * @param slug 路径
+	 * @returns
+	 */
+	getBySlug(slug: string): RequestProxyResult;
+}
+declare class PostController implements IController {
+	private client;
+	constructor(client: HTTPClient);
+	base: string;
+	name: string;
+	private get proxy();
+	/**
+	 * 获取文章列表分页
+	 * @param page
+	 * @param perPage
+	 * @returns
+	 */
+	getList(page?: number, perPage?: number): RequestProxyResult<PaginateResult<PostModel>, {
 		[key: string]: any;
-		data: PostResponse;
+		data: PaginateResult<PostModel>;
 	}>;
+	/**
+	 * 根据分类和路径查找文章
+	 * @param categoryName
+	 * @param slug
+	 */
 	getPost(categoryName: string, slug: string): RequestProxyResult<PostModel>;
+	/**
+	 * 根据 ID 查找文章
+	 * @param id
+	 */
 	getPost(id: string): RequestProxyResult<PostModel>;
+	/**
+	 * 获取最新的文章
+	 */
+	getLatest(): RequestProxyResult<PostModel, {
+		[key: string]: any;
+		data: PostModel;
+	}>;
+	/**
+	 * 点赞
+	 */
+	thumbsUp(id: string): RequestProxyResult<void, {
+		[key: string]: any;
+		data: void;
+	}>;
+}
+export interface RecentlyModel {
+	content: string;
+	created: string;
+	id: string;
+}
+declare class RecentlyController implements IController {
+	private readonly client;
+	base: string;
+	name: string;
+	constructor(client: HTTPClient);
+	get proxy(): IRequestHandler;
+	/**
+	 * 获取最新一条
+	 */
+	getLatestOne(): RequestProxyResult;
+	getAll(): RequestProxyResult;
+	getList(before?: string | undefined, after?: string | undefined, size?: number | number): RequestProxyResult;
 }
-export declare const allClients: (typeof NoteClient | typeof PostClient)[];
-export declare const allClientName: string[];
-export declare class HTTPClient {
+declare class SayController extends BaseCrudController<SayModel> implements IController {
+	protected client: HTTPClient;
+	base: string;
+	name: string;
+	constructor(client: HTTPClient);
+	protected get proxy(): IRequestHandler;
+	/**
+	 * 获取随机一条
+	 */
+	getRandom(): RequestProxyResult;
+}
+export declare type SearchOption = {
+	orderBy?: string;
+	order?: number;
+	rawAlgolia?: boolean;
+};
+declare class SearchController implements IController {
+	private readonly client;
+	base: string;
+	name: string;
+	constructor(client: HTTPClient);
+	get proxy(): import("~/interfaces/request").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">>>>;
+	/**
+	 * 从 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, "created" | "id" | "modified" | "title" | "slug" | "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">> & {
+			/**
+			 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+			 */
+			raw?: any;
+		};
+	}>, {
+		[key: string]: any;
+		data: RequestProxyResult<PaginateResult<Pick<PostModel, "created" | "id" | "modified" | "title" | "slug" | "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">> & {
+				/**
+				 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+				 */
+				raw?: any;
+			};
+		}>;
+	}>;
+}
+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;
+}
+declare const allControllers: (typeof AggregateController | typeof CategoryController | typeof CommentController | typeof LinkController | typeof NoteController | typeof PageController | typeof PostController | typeof RecentlyController | typeof SayController | typeof SearchController | typeof UserController)[];
+declare const allContollerNames: string[];
+declare class HTTPControllerDefine {
+	aggregate: AggregateController;
+	category: CategoryController;
+	comment: CommentController;
+	link: LinkController;
+	note: NoteController;
+	page: PageController;
+	post: PostController;
+	recently: RecentlyController;
+	say: SayController;
+	search: SearchController;
+	user: UserController;
+	get master(): UserController;
+	get friend(): LinkController;
+	get shorthand(): RecentlyController;
+}
+export declare class HTTPClient extends HTTPControllerDefine {
 	private _endpoint;
 	private _instance;
 	private _proxy;
-	post: PostClient;
-	note: NoteClient;
 	constructor(_endpoint: string, _instance: IRequestAdapter);
 	private initGetClient;
-	injectClients<T extends {
-		new (client: HTTPClient): IClient;
-	}>(...Clients: T[]): void;
-	injectClients<T extends {
-		new (client: HTTPClient): IClient;
-	}>(Clients: T[]): void;
+	injectControllers<T extends {
+		new (client: HTTPClient): IController;
+	}>(...Controller: T[]): void;
+	injectControllers<T extends {
+		new (client: HTTPClient): IController;
+	}>(Controller: T[]): void;
 	get endpoint(): string;
 	get instance(): IRequestAdapter;
 	request(options: {
@@ -122,8 +623,8 @@ export declare class HTTPClient {
 		data?: any;
 		params?: any;
 	}): any;
-	get proxy(): IRequestHandler<RequestOptions>;
-	resolveFullPath(path: string): string;
+	get proxy(): IRequestHandler;
+	private resolveFullPath;
 	private buildRoute;
 }
 export declare function createClient<T extends IRequestAdapter>(adapter: T): (endpoint: string) => HTTPClient;
@@ -134,4 +635,11 @@ 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 {};