@mx-space/api-client 0.3.7 → 0.4.3

package/build/index.d.ts

@@ -1,14 +1,10 @@
 // Generated by dts-bundle-generator v6.2.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 declare type SortOrder = "asc" | "desc";
 export interface RequestOptions {
 	method?: string;
 	data?: Record<string, any>;
@@ -19,14 +15,14 @@ export interface RequestOptions {
 export declare type RequestResponseType<P> = Promise<Record<string, any> & {
 	data: P;
 }>;
-export interface IRequestAdapter<T = any> {
+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];
 };
@@ -51,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;
@@ -79,7 +74,13 @@ declare class BaseModel {
 	created?: Date;
 	id?: string;
 }
-export interface PostModel {
+export interface TextBaseModel {
+	title: string;
+	text: string;
+	images?: Image[];
+	modified: string | null;
+}
+export interface PostModel extends TextBaseModel {
 	commentsIndex: number;
 	allowComment: boolean;
 	hide: boolean;
@@ -92,7 +93,6 @@ export interface PostModel {
 	slug: string;
 	categoryId: string;
 	images: Image[];
-	modified: string;
 	created: string;
 	category: CategoryModel;
 }
@@ -116,7 +116,7 @@ export interface TagModel {
 	count: number;
 	name: string;
 }
-export interface NoteModel {
+export interface NoteModel extends TextBaseModel {
 	id: string;
 	hide: boolean;
 	count: {
@@ -129,7 +129,6 @@ export interface NoteModel {
 	weather?: string;
 	hasMemory?: boolean;
 	created: string;
-	modified: string;
 	secret?: Date;
 	password?: string | null;
 	nid: number;
@@ -155,20 +154,15 @@ declare enum EnumPageType {
 	"html" = "html",
 	"frame" = "frame"
 }
-export interface PageModel {
+export interface PageModel extends TextBaseModel {
 	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 */
@@ -255,6 +249,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;
@@ -688,9 +732,10 @@ export declare class SearchController implements IController {
 }
 declare enum SnippetType {
 	JSON = "json",
-	Text = "text"
+	Text = "text",
+	YAML = "yaml"
 }
-export interface SnippetModel extends BaseModel {
+export interface SnippetModel<T = unknown> extends BaseModel {
 	type: SnippetType;
 	private: boolean;
 	raw: string;
@@ -698,6 +743,7 @@ export interface SnippetModel extends BaseModel {
 	reference: string;
 	comment?: string;
 	metatype?: string;
+	data: T;
 }
 export declare class SnippetController implements IController {
 	protected client: HTTPClient;
@@ -705,13 +751,13 @@ export declare class SnippetController implements IController {
 	name: string;
 	constructor(client: HTTPClient);
 	get proxy(): IRequestHandler;
-	getById(id: string): RequestProxyResult<SnippetModel, {
+	getById<T>(id: string): RequestProxyResult<SnippetModel<T>, {
 		[key: string]: any;
-		data: SnippetModel;
+		data: SnippetModel<T>;
 	}>;
-	getByReferenceAndName(reference: string, name: string): RequestProxyResult<SnippetModel, {
+	getByReferenceAndName<T>(reference: string, name: string): RequestProxyResult<SnippetModel<T>, {
 		[key: string]: any;
-		data: SnippetModel;
+		data: SnippetModel<T>;
 	}>;
 }
 export declare class UserController implements IController {
@@ -741,50 +787,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<any>;
-	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 {};