@mx-space/api-client 0.0.5 → 0.3.1

package/build/index.d.ts

@@ -33,32 +33,16 @@ export interface IRequestHandler {
 export declare type RequestProxyResult<T, R = {
 	data: T;
 	[key: string]: any;
-}> = Promise<T & {
-	raw: R;
-}>;
-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;
-}
+}> = Promise<ResponseProxyExtraRaw<T, R>>;
+export declare type ResponseProxyExtraRaw<T, R = any> = T & {
+	$raw: R;
+	$request: {
+		path: string;
+		method: string;
+		[k: string]: string;
+	};
+};
+export declare type SortOrder = "asc" | "desc";
 export interface NoteModel {
 	id: string;
 	hide: boolean;
@@ -93,34 +77,56 @@ export interface NoteWrappedPayload {
 	next?: Partial<NoteModel>;
 	prev?: Partial<NoteModel>;
 }
-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 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;
+	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;
@@ -148,47 +154,169 @@ export interface CategoryModel {
 	created: Date;
 	categoryId: string;
 }
-declare class PostController implements IController {
+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 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;
-	constructor(client: HTTPClient);
 	base: string;
 	name: string;
+	constructor(client: HTTPClient);
 	private get proxy();
 	/**
-	 * 获取文章列表分页
-	 * @param page
-	 * @param perPage
-	 * @returns
-	 */
-	getList(page?: number, perPage?: number): RequestProxyResult<PaginateResult<PostModel>, {
-		[key: string]: any;
-		data: PaginateResult<PostModel>;
-	}>;
-	/**
-	 * 根据分类和路径查找文章
-	 * @param categoryName
-	 * @param slug
+	 * 获取聚合数据
 	 */
-	getPost(categoryName: string, slug: string): RequestProxyResult<PostModel>;
+	getAggregateData(): RequestProxyResult;
 	/**
-	 * 根据 ID 查找文章
-	 * @param id
+	 * 获取最新发布的内容
 	 */
-	getPost(id: string): RequestProxyResult<PostModel>;
+	getTop(size?: number): RequestProxyResult;
+	getTimeline(options?: {
+		sort?: SortOrder;
+		type?: TimelineType;
+		year?: number;
+	}): RequestProxyResult;
 	/**
-	 * 获取最新的文章
+	 * 获取聚合数据统计
 	 */
-	getLatest(): RequestProxyResult<PostModel, {
+	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: PostModel;
+		data: {
+			data: CategoryModel[];
+		};
 	}>;
-	/**
-	 * 点赞
-	 */
-	thumbsUp(id: string): RequestProxyResult<void, {
+	getAllTags(): import("~/interfaces/request").RequestProxyResult<{
+		data: TagModel[];
+	}, {
 		[key: string]: any;
-		data: void;
+		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;
@@ -242,29 +370,71 @@ declare class CommentController implements IController {
 	 */
 	reply(commentId: string, data: CommentDto): RequestProxyResult;
 }
-declare enum EnumPageType {
-	"md" = "md",
-	"html" = "html",
-	"frame" = "frame"
+declare enum LinkType {
+	Friend = 0,
+	Collection = 1
 }
-export interface PageModel {
-	created: string;
-	modified: string;
+declare enum LinkState {
+	Pass = 0,
+	Audit = 1
+}
+export interface LinkModel {
 	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;
+	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;
@@ -287,16 +457,201 @@ declare class PageController implements IController {
 	 */
 	getBySlug(slug: string): RequestProxyResult;
 }
-declare const allControllers: (typeof NoteController | typeof PostController | typeof CommentController | typeof PageController)[];
+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: 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 ProjectModel {
+	id?: string;
+	name: string;
+	previewUrl?: string;
+	docUrl?: string;
+	projectUrl?: string;
+	images?: string[];
+	description: string;
+	avatar?: string;
+	text: string;
+}
+declare class ProjectController extends BaseCrudController<ProjectModel> {
+	protected readonly client: HTTPClient;
+	constructor(client: HTTPClient);
+	base: string;
+	name: string;
+}
+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;
+}
+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 enum SnippetType {
+	JSON = "json",
+	Text = "text"
+}
+export interface SnippetModel extends BaseModel {
+	type: SnippetType;
+	private: boolean;
+	raw: string;
+	name: string;
+	reference: string;
+	comment?: string;
+	metatype?: string;
+}
+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;
+}
+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 ProjectController | typeof RecentlyController | typeof SayController | typeof SearchController | typeof SnippetController | typeof UserController)[];
 declare const allContollerNames: string[];
-export declare class HTTPClient {
+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;
-	post: PostController;
-	note: NoteController;
-	page: PageController;
-	comment: CommentController;
 	constructor(_endpoint: string, _instance: IRequestAdapter);
 	private initGetClient;
 	injectControllers<T extends {