@mx-space/api-client 2.0.0 → 2.1.0

package/dist/index.cjs

@@ -509,11 +509,12 @@ var NoteController = class {
 	* @param options 可选参数：password, single, lang
 	*/
 	getNoteByNid(nid, options) {
-		const { password, single, lang } = options || {};
+		const { password, single, lang, prefer } = options || {};
 		return this.proxy.nid(nid.toString()).get({ params: {
 			password,
 			single: single ? "1" : void 0,
-			lang
+			lang,
+			prefer
 		} });
 	}
 	/**
@@ -672,8 +673,8 @@ var PageController = class {
 	* @param slug 路径
 	* @returns
 	*/
-	getBySlug(slug) {
-		return this.proxy.slug(slug).get({});
+	getBySlug(slug, options) {
+		return this.proxy.slug(slug).get({ params: options?.prefer ? { prefer: options.prefer } : void 0 });
 	}
 };
 
@@ -711,7 +712,12 @@ var PostController = class {
 	}
 	getPost(idOrCategoryName, slug, options) {
 		if (arguments.length == 1) return this.proxy(idOrCategoryName).get();
-		else return this.proxy(idOrCategoryName)(slug).get({ params: options?.lang ? { lang: options.lang } : void 0 });
+		else {
+			const params = {};
+			if (options?.lang) params.lang = options.lang;
+			if (options?.prefer) params.prefer = options.prefer;
+			return this.proxy(idOrCategoryName)(slug).get({ params: Object.keys(params).length ? params : void 0 });
+		}
 	}
 	/**
 	* 获取最新的文章

package/dist/index.d.cts

@@ -165,14 +165,23 @@ interface BaseCommentIndexModel extends BaseModel {
   commentsIndex?: number;
   allowComment: boolean;
 }
-interface TextBaseModel extends BaseCommentIndexModel {
+interface TextBaseModelMarkdown extends BaseCommentIndexModel {
   title: string;
   text: string;
+  contentFormat?: 'markdown';
+  content?: undefined;
   images?: Image[];
   modified: string | null;
-  contentFormat?: 'markdown' | 'lexical';
-  content?: string;
 }
+interface TextBaseModelLexical extends BaseCommentIndexModel {
+  title: string;
+  text?: string;
+  contentFormat: 'lexical';
+  content: string;
+  images?: Image[];
+  modified: string | null;
+}
+type TextBaseModel = TextBaseModelMarkdown | TextBaseModelLexical;
 type ModelWithLiked<T> = T & {
   liked: boolean;
 };
@@ -188,13 +197,11 @@ type ModelWithTranslation<T> = T & {
 };
 //#endregion
 //#region models/post.d.ts
-interface PostModel extends TextBaseModel {
+type PostModel = TextBaseModel & {
   summary?: string | null;
   copyright: boolean;
   tags: string[];
   count: Count;
-  text: string;
-  title: string;
   slug: string;
   categoryId: string;
   images: Image[];
@@ -202,7 +209,7 @@ interface PostModel extends TextBaseModel {
   pin?: string | null;
   pinOrder?: number;
   related?: Pick<PostModel, 'id' | 'category' | 'categoryId' | 'created' | 'modified' | 'title' | 'slug' | 'summary'>[];
-}
+};
 //#endregion
 //#region models/category.d.ts
 declare enum CategoryType {
@@ -355,7 +362,7 @@ interface TopicModel extends BaseModel {
 }
 //#endregion
 //#region models/note.d.ts
-interface NoteModel extends TextBaseModel {
+type NoteModel = TextBaseModel & {
   isPublished: boolean;
   count: {
     read: number;
@@ -371,7 +378,7 @@ interface NoteModel extends TextBaseModel {
   coordinates?: Coordinate;
   topic?: TopicModel;
   topicId?: string;
-}
+};
 interface Coordinate {
   latitude: number;
   longitude: number;
@@ -398,14 +405,14 @@ declare enum EnumPageType {
   'html' = "html",
   'frame' = "frame"
 }
-interface PageModel extends TextBaseModel {
+type PageModel = TextBaseModel & {
   created: string;
   slug: string;
   subtitle?: string;
   order?: number;
   type?: EnumPageType;
   options?: object;
-}
+};
 //#endregion
 //#region models/say.d.ts
 interface SayModel extends BaseModel {
@@ -1444,7 +1451,7 @@ declare class CategoryController<ResponseWrapper> implements IController {
         name: string;
         created: string;
         id: string;
-        children: Pick<PostModel, "id" | "slug" | "title" | "modified" | "created">[];
+        children: Pick<PostModel, "id" | "title" | "slug" | "modified" | "created">[];
       } : T_1 : never : never;
     } : ResponseWrapper;
     $request: {
@@ -1496,7 +1503,7 @@ declare class CategoryController<ResponseWrapper> implements IController {
         };
       }) ? T_1 extends unknown ? {
         tag: string;
-        data: Pick<PostModel, "category" | "id" | "slug" | "title" | "created">[];
+        data: Pick<PostModel, "category" | "id" | "title" | "slug" | "created">[];
       } : T_1 : never : never;
     } : ResponseWrapper;
     $request: {
@@ -1686,6 +1693,7 @@ type NoteByNidOptions = {
   password?: string;
   single?: boolean;
   lang?: string;
+  prefer?: 'lexical';
 };
 type NoteMiddleListOptions = {
   lang?: string;
@@ -1999,7 +2007,9 @@ declare class PageController<ResponseWrapper> implements IController {
    * @param slug 路径
    * @returns
    */
-  getBySlug(slug: string): RequestProxyResult<PageModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+  getBySlug(slug: string, options?: {
+    prefer?: 'lexical';
+  }): RequestProxyResult<PageModel, ResponseWrapper, ResponseWrapper extends unknown ? {
     [key: string]: any;
     data: PageModel;
   } : ResponseWrapper extends {
@@ -2057,6 +2067,7 @@ declare class PostController<ResponseWrapper> implements IController {
    */
   getPost(categoryName: string, slug: string, options?: {
     lang?: string;
+    prefer?: 'lexical';
   }): RequestProxyResult<ModelWithLiked<ModelWithTranslation<PostModel>>, ResponseWrapper>;
   /**
    * 根据 ID 查找文章
@@ -2295,11 +2306,11 @@ declare class SearchController<ResponseWrapper> implements IController {
    * @param options
    * @returns
    */
-  searchByAlgolia(keyword: string, options?: SearchOption): RequestProxyResult<RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "slug" | "title" | "modified" | "created"> & {
+  searchByAlgolia(keyword: string, options?: SearchOption): RequestProxyResult<RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "modified" | "created"> & {
     type: "post";
-  }) | (Pick<NoteModel, "id" | "nid" | "title" | "modified" | "created"> & {
+  }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
     type: "note";
-  }) | (Pick<PageModel, "id" | "slug" | "title" | "modified" | "created"> & {
+  }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
     type: "page";
   })> & {
     /**
@@ -2308,11 +2319,11 @@ declare class SearchController<ResponseWrapper> implements IController {
     raw?: any;
   }, ResponseWrapper>, ResponseWrapper, ResponseWrapper extends unknown ? {
     [key: string]: any;
-    data: RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "slug" | "title" | "modified" | "created"> & {
+    data: RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "modified" | "created"> & {
       type: "post";
-    }) | (Pick<NoteModel, "id" | "nid" | "title" | "modified" | "created"> & {
+    }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
       type: "note";
-    }) | (Pick<PageModel, "id" | "slug" | "title" | "modified" | "created"> & {
+    }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
       type: "page";
     })> & {
       /**
@@ -2321,11 +2332,11 @@ declare class SearchController<ResponseWrapper> implements IController {
       raw?: any;
     }, ResponseWrapper>;
   } : ResponseWrapper extends {
-    data: RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "slug" | "title" | "modified" | "created"> & {
+    data: RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "modified" | "created"> & {
       type: "post";
-    }) | (Pick<NoteModel, "id" | "nid" | "title" | "modified" | "created"> & {
+    }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
       type: "note";
-    }) | (Pick<PageModel, "id" | "slug" | "title" | "modified" | "created"> & {
+    }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
       type: "page";
     })> & {
       /**
@@ -2334,11 +2345,11 @@ declare class SearchController<ResponseWrapper> implements IController {
       raw?: any;
     }, ResponseWrapper>;
   } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
-    data: RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "slug" | "title" | "modified" | "created"> & {
+    data: RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "modified" | "created"> & {
       type: "post";
-    }) | (Pick<NoteModel, "id" | "nid" | "title" | "modified" | "created"> & {
+    }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
       type: "note";
-    }) | (Pick<PageModel, "id" | "slug" | "title" | "modified" | "created"> & {
+    }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
       type: "page";
     })> & {
       /**

package/dist/index.d.mts

@@ -165,14 +165,23 @@ interface BaseCommentIndexModel extends BaseModel {
   commentsIndex?: number;
   allowComment: boolean;
 }
-interface TextBaseModel extends BaseCommentIndexModel {
+interface TextBaseModelMarkdown extends BaseCommentIndexModel {
   title: string;
   text: string;
+  contentFormat?: 'markdown';
+  content?: undefined;
   images?: Image[];
   modified: string | null;
-  contentFormat?: 'markdown' | 'lexical';
-  content?: string;
 }
+interface TextBaseModelLexical extends BaseCommentIndexModel {
+  title: string;
+  text?: string;
+  contentFormat: 'lexical';
+  content: string;
+  images?: Image[];
+  modified: string | null;
+}
+type TextBaseModel = TextBaseModelMarkdown | TextBaseModelLexical;
 type ModelWithLiked<T> = T & {
   liked: boolean;
 };
@@ -188,13 +197,11 @@ type ModelWithTranslation<T> = T & {
 };
 //#endregion
 //#region models/post.d.ts
-interface PostModel extends TextBaseModel {
+type PostModel = TextBaseModel & {
   summary?: string | null;
   copyright: boolean;
   tags: string[];
   count: Count;
-  text: string;
-  title: string;
   slug: string;
   categoryId: string;
   images: Image[];
@@ -202,7 +209,7 @@ interface PostModel extends TextBaseModel {
   pin?: string | null;
   pinOrder?: number;
   related?: Pick<PostModel, 'id' | 'category' | 'categoryId' | 'created' | 'modified' | 'title' | 'slug' | 'summary'>[];
-}
+};
 //#endregion
 //#region models/category.d.ts
 declare enum CategoryType {
@@ -355,7 +362,7 @@ interface TopicModel extends BaseModel {
 }
 //#endregion
 //#region models/note.d.ts
-interface NoteModel extends TextBaseModel {
+type NoteModel = TextBaseModel & {
   isPublished: boolean;
   count: {
     read: number;
@@ -371,7 +378,7 @@ interface NoteModel extends TextBaseModel {
   coordinates?: Coordinate;
   topic?: TopicModel;
   topicId?: string;
-}
+};
 interface Coordinate {
   latitude: number;
   longitude: number;
@@ -398,14 +405,14 @@ declare enum EnumPageType {
   'html' = "html",
   'frame' = "frame"
 }
-interface PageModel extends TextBaseModel {
+type PageModel = TextBaseModel & {
   created: string;
   slug: string;
   subtitle?: string;
   order?: number;
   type?: EnumPageType;
   options?: object;
-}
+};
 //#endregion
 //#region models/say.d.ts
 interface SayModel extends BaseModel {
@@ -1444,7 +1451,7 @@ declare class CategoryController<ResponseWrapper> implements IController {
         name: string;
         created: string;
         id: string;
-        children: Pick<PostModel, "id" | "slug" | "title" | "modified" | "created">[];
+        children: Pick<PostModel, "id" | "title" | "slug" | "modified" | "created">[];
       } : T_1 : never : never;
     } : ResponseWrapper;
     $request: {
@@ -1496,7 +1503,7 @@ declare class CategoryController<ResponseWrapper> implements IController {
         };
       }) ? T_1 extends unknown ? {
         tag: string;
-        data: Pick<PostModel, "category" | "id" | "slug" | "title" | "created">[];
+        data: Pick<PostModel, "category" | "id" | "title" | "slug" | "created">[];
       } : T_1 : never : never;
     } : ResponseWrapper;
     $request: {
@@ -1686,6 +1693,7 @@ type NoteByNidOptions = {
   password?: string;
   single?: boolean;
   lang?: string;
+  prefer?: 'lexical';
 };
 type NoteMiddleListOptions = {
   lang?: string;
@@ -1999,7 +2007,9 @@ declare class PageController<ResponseWrapper> implements IController {
    * @param slug 路径
    * @returns
    */
-  getBySlug(slug: string): RequestProxyResult<PageModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+  getBySlug(slug: string, options?: {
+    prefer?: 'lexical';
+  }): RequestProxyResult<PageModel, ResponseWrapper, ResponseWrapper extends unknown ? {
     [key: string]: any;
     data: PageModel;
   } : ResponseWrapper extends {
@@ -2057,6 +2067,7 @@ declare class PostController<ResponseWrapper> implements IController {
    */
   getPost(categoryName: string, slug: string, options?: {
     lang?: string;
+    prefer?: 'lexical';
   }): RequestProxyResult<ModelWithLiked<ModelWithTranslation<PostModel>>, ResponseWrapper>;
   /**
    * 根据 ID 查找文章
@@ -2295,11 +2306,11 @@ declare class SearchController<ResponseWrapper> implements IController {
    * @param options
    * @returns
    */
-  searchByAlgolia(keyword: string, options?: SearchOption): RequestProxyResult<RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "slug" | "title" | "modified" | "created"> & {
+  searchByAlgolia(keyword: string, options?: SearchOption): RequestProxyResult<RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "modified" | "created"> & {
     type: "post";
-  }) | (Pick<NoteModel, "id" | "nid" | "title" | "modified" | "created"> & {
+  }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
     type: "note";
-  }) | (Pick<PageModel, "id" | "slug" | "title" | "modified" | "created"> & {
+  }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
     type: "page";
   })> & {
     /**
@@ -2308,11 +2319,11 @@ declare class SearchController<ResponseWrapper> implements IController {
     raw?: any;
   }, ResponseWrapper>, ResponseWrapper, ResponseWrapper extends unknown ? {
     [key: string]: any;
-    data: RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "slug" | "title" | "modified" | "created"> & {
+    data: RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "modified" | "created"> & {
       type: "post";
-    }) | (Pick<NoteModel, "id" | "nid" | "title" | "modified" | "created"> & {
+    }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
       type: "note";
-    }) | (Pick<PageModel, "id" | "slug" | "title" | "modified" | "created"> & {
+    }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
       type: "page";
     })> & {
       /**
@@ -2321,11 +2332,11 @@ declare class SearchController<ResponseWrapper> implements IController {
       raw?: any;
     }, ResponseWrapper>;
   } : ResponseWrapper extends {
-    data: RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "slug" | "title" | "modified" | "created"> & {
+    data: RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "modified" | "created"> & {
       type: "post";
-    }) | (Pick<NoteModel, "id" | "nid" | "title" | "modified" | "created"> & {
+    }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
       type: "note";
-    }) | (Pick<PageModel, "id" | "slug" | "title" | "modified" | "created"> & {
+    }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
       type: "page";
     })> & {
       /**
@@ -2334,11 +2345,11 @@ declare class SearchController<ResponseWrapper> implements IController {
       raw?: any;
     }, ResponseWrapper>;
   } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
-    data: RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "slug" | "title" | "modified" | "created"> & {
+    data: RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "modified" | "created"> & {
       type: "post";
-    }) | (Pick<NoteModel, "id" | "nid" | "title" | "modified" | "created"> & {
+    }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
       type: "note";
-    }) | (Pick<PageModel, "id" | "slug" | "title" | "modified" | "created"> & {
+    }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
       type: "page";
     })> & {
       /**

package/dist/index.mjs

@@ -507,11 +507,12 @@ var NoteController = class {
 	* @param options 可选参数：password, single, lang
 	*/
 	getNoteByNid(nid, options) {
-		const { password, single, lang } = options || {};
+		const { password, single, lang, prefer } = options || {};
 		return this.proxy.nid(nid.toString()).get({ params: {
 			password,
 			single: single ? "1" : void 0,
-			lang
+			lang,
+			prefer
 		} });
 	}
 	/**
@@ -670,8 +671,8 @@ var PageController = class {
 	* @param slug 路径
 	* @returns
 	*/
-	getBySlug(slug) {
-		return this.proxy.slug(slug).get({});
+	getBySlug(slug, options) {
+		return this.proxy.slug(slug).get({ params: options?.prefer ? { prefer: options.prefer } : void 0 });
 	}
 };
 
@@ -709,7 +710,12 @@ var PostController = class {
 	}
 	getPost(idOrCategoryName, slug, options) {
 		if (arguments.length == 1) return this.proxy(idOrCategoryName).get();
-		else return this.proxy(idOrCategoryName)(slug).get({ params: options?.lang ? { lang: options.lang } : void 0 });
+		else {
+			const params = {};
+			if (options?.lang) params.lang = options.lang;
+			if (options?.prefer) params.prefer = options.prefer;
+			return this.proxy(idOrCategoryName)(slug).get({ params: Object.keys(params).length ? params : void 0 });
+		}
 	}
 	/**
 	* 获取最新的文章

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mx-space/api-client",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A api client for mx-space server@next",
   "type": "module",
   "engines": {