@mx-space/api-client 1.20.0 → 1.21.0

package/LICENSE

@@ -0,0 +1,33 @@
+** Mix Space Open Source License**
+
+This project is dual-licensed under different terms for different parts of the project. It is important for users and contributors to understand the licensing terms applicable to each part of the project.
+
+### For the `apps/` Directory
+
+**License:** GNU Affero General Public License v3.0 (AGPLv3) with Additional Terms (ADDITIONAL_TERMS).
+
+**Scope:** This license applies exclusively to all files within the `apps/` directory of this project.
+
+**Summary:**
+- The AGPLv3 is a free, copyleft license suitable for software that will be distributed over a network. It allows users to use, modify, and distribute the software and any modifications under the same terms.
+- The "Additional Terms" (ADDITIONAL_TERMS) are specific conditions that are added to the AGPLv3 license. These terms must be reviewed in the accompanying LICENSE file or documentation to understand any additional restrictions or permissions that apply to the software.
+
+### For Other Parts of the Project
+
+**License:** MIT License.
+
+**Scope:** This license applies to all parts of the project that are not included within the `apps/` directory.
+
+**Summary:**
+- The MIT License is a permissive open-source license that allows users considerable freedom. It permits use, copying, modification, merging, publishing, distribution, sublicensing, and/or selling copies of the software.
+- It also protects the authors by including a limitation of liability and a disclaimer of warranty.
+
+**General Conditions:**
+- Redistribution and use in source and binary forms, with or without modification, are permitted provided that the above license notices and this permission notice appear in all copies of the software.
+- The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and noninfringement.
+
+**Contribution:**
+- Contributions to this project are accepted under the terms of the same license as the part of the project to which the contribution is made.
+
+**Notice:**
+- This summary is not the license itself and is not a substitute for reading the licenses in their entirety. All users and contributors are encouraged to read the full text of the licenses for a comprehensive understanding.

package/dist/adaptors/axios.cjs

@@ -1,5 +1,5 @@
-Object.defineProperty(exports, '__esModule', { value: true });
-//#region rolldown:runtime
+Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
+//#region \0rolldown/runtime.js
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;

package/dist/adaptors/fetch.cjs

@@ -1,3 +1,4 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
 //#region adaptors/fetch.ts
 const jsonDataAttachResponse = async (response) => {

package/dist/adaptors/umi-request.cjs

@@ -1,4 +1,4 @@
-Object.defineProperty(exports, '__esModule', { value: true });
+Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
 const require_adaptors_axios = require('./axios.cjs');
 let umi_request = require("umi-request");
 

package/dist/index.cjs

@@ -1,4 +1,4 @@
-Object.defineProperty(exports, '__esModule', { value: true });
+Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
 
 //#region utils/index.ts
 const isPlainObject = (obj) => isObject(obj) && Object.prototype.toString.call(obj) === "[object Object]" && Object.getPrototypeOf(obj) === Object.prototype;
@@ -528,10 +528,11 @@ var PostController = class {
 	* 获取文章列表分页
 	* @param page
 	* @param perPage
-	* @returns
+	* @param options 可选参数，包含 lang 用于获取翻译版本
+	* @returns 当传入 lang 时，返回的文章可能包含 isTranslated 和 translationMeta 字段
 	*/
 	getList(page = 1, perPage = 10, options = {}) {
-		const { select, sortBy, sortOrder, year, truncate } = options;
+		const { select, sortBy, sortOrder, year, truncate, lang } = options;
 		return this.proxy.get({ params: {
 			page,
 			size: perPage,
@@ -539,7 +540,8 @@ var PostController = class {
 			sortBy,
 			sortOrder,
 			year,
-			truncate
+			truncate,
+			lang
 		} });
 	}
 	getPost(idOrCategoryName, slug, options) {

package/dist/index.d.cts

@@ -182,6 +182,7 @@ interface TranslationMeta {
 type ModelWithTranslation<T> = T & {
   isTranslated: boolean;
   translationMeta?: TranslationMeta;
+  availableTranslations?: string[];
 };
 //#endregion
 //#region models/post.d.ts
@@ -1521,7 +1522,13 @@ type PostListOptions = {
   year?: number;
   sortBy?: 'categoryId' | 'title' | 'created' | 'modified';
   sortOrder?: 1 | -1;
-  truncate?: number;
+  truncate?: number; /** 语言代码，用于获取翻译版本 */
+  lang?: string;
+};
+/** 文章列表项，可能包含翻译信息 */
+type PostListItem = PostModel & {
+  isTranslated?: boolean;
+  translationMeta?: TranslationMeta;
 };
 declare class PostController<ResponseWrapper> implements IController {
   private client;
@@ -1533,15 +1540,16 @@ declare class PostController<ResponseWrapper> implements IController {
    * 获取文章列表分页
    * @param page
    * @param perPage
-   * @returns
+   * @param options 可选参数，包含 lang 用于获取翻译版本
+   * @returns 当传入 lang 时，返回的文章可能包含 isTranslated 和 translationMeta 字段
    */
-  getList(page?: number, perPage?: number, options?: PostListOptions): RequestProxyResult<PaginateResult<PostModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
+  getList(page?: number, perPage?: number, options?: PostListOptions): RequestProxyResult<PaginateResult<PostListItem>, ResponseWrapper, ResponseWrapper extends unknown ? {
     [key: string]: any;
-    data: PaginateResult<PostModel>;
+    data: PaginateResult<PostListItem>;
   } : ResponseWrapper extends {
-    data: PaginateResult<PostModel>;
+    data: PaginateResult<PostListItem>;
   } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
-    data: PaginateResult<PostModel>;
+    data: PaginateResult<PostListItem>;
   }>;
   /**
    * 根据分类和路径查找文章
@@ -2048,4 +2056,4 @@ declare const allControllerNames: readonly ["ai", "ack", "activity", "aggregate"
  */
 declare const camelcaseKeys: <T = any>(obj: any) => T;
 //#endregion
-export { AIController, AIDeepReadingModel, AISummaryModel, AckController, ActivityController, ActivityPresence, AdminExtraModel, AggregateAIConfig, AggregateController, AggregateRoot, AggregateRootWithTheme, AggregateStat, AggregateTop, AggregateTopNote, AggregateTopPost, AlgoliaSearchOptionsModel, AuthUser, BackupOptionsModel, BaiduSearchOptionsModel, BaseCommentIndexModel, BaseModel, BingSearchOptionsModel, CategoryController, CategoryEntries, CategoryModel, CategoryType, CategoryWithChildrenModel, CollectionRefTypes, CommentController, CommentDto, CommentModel, CommentOptionsModel, CommentRef, CommentState, Coordinate, Count, EnumPageType, type HTTPClient, IConfig, IConfigKeys, type IRequestAdapter, Image, LastYearPublication, LinkController, LinkModel, LinkState, LinkType, MailOptionsModel, ModelWithLiked, ModelWithTranslation, NoteController, NoteModel, NoteWrappedPayload, NoteWrappedWithLikedAndTranslationPayload, NoteWrappedWithLikedPayload, PageController, PageModel, Pager, PaginateResult, PostController, PostModel, ProjectController, ProjectModel, ReaderModel, RecentActivities, RecentComment, RecentLike, RecentNote, RecentPost, RecentRecent, RecentlyAttitudeEnum, RecentlyAttitudeResultEnum, RecentlyController, RecentlyModel, RecentlyRefType, RecentlyRefTypes, RequestError, RoomOmittedNote, RoomOmittedPage, RoomOmittedPost, RoomsData, SayController, SayModel, SearchController, SeoOptionModel, ServerlessController, SnippetController, SnippetModel, SnippetType, SubscribeAllBit, SubscribeController, SubscribeNoteCreateBit, SubscribePostCreateBit, SubscribeRecentCreateBit, SubscribeSayCreateBit, SubscribeType, SubscribeTypeToBitMap, TLogin, TagModel, TextBaseModel, TimelineData, TimelineType, TopicController, TopicModel, TranslationMeta, Url, UrlOptionModel, UserController, UserModel, allControllerNames, allControllers, createClient, createClient as default, camelcaseKeys as simpleCamelcaseKeys };
+export { AIController, AIDeepReadingModel, AISummaryModel, AckController, ActivityController, ActivityPresence, AdminExtraModel, AggregateAIConfig, AggregateController, AggregateRoot, AggregateRootWithTheme, AggregateStat, AggregateTop, AggregateTopNote, AggregateTopPost, AlgoliaSearchOptionsModel, AuthUser, BackupOptionsModel, BaiduSearchOptionsModel, BaseCommentIndexModel, BaseModel, BingSearchOptionsModel, CategoryController, CategoryEntries, CategoryModel, CategoryType, CategoryWithChildrenModel, CollectionRefTypes, CommentController, CommentDto, CommentModel, CommentOptionsModel, CommentRef, CommentState, Coordinate, Count, EnumPageType, type HTTPClient, IConfig, IConfigKeys, type IRequestAdapter, Image, LastYearPublication, LinkController, LinkModel, LinkState, LinkType, MailOptionsModel, ModelWithLiked, ModelWithTranslation, NoteController, NoteModel, NoteWrappedPayload, NoteWrappedWithLikedAndTranslationPayload, NoteWrappedWithLikedPayload, PageController, PageModel, Pager, PaginateResult, PostController, type PostListItem, type PostListOptions, PostModel, ProjectController, ProjectModel, ReaderModel, RecentActivities, RecentComment, RecentLike, RecentNote, RecentPost, RecentRecent, RecentlyAttitudeEnum, RecentlyAttitudeResultEnum, RecentlyController, RecentlyModel, RecentlyRefType, RecentlyRefTypes, RequestError, RoomOmittedNote, RoomOmittedPage, RoomOmittedPost, RoomsData, SayController, SayModel, SearchController, SeoOptionModel, ServerlessController, SnippetController, SnippetModel, SnippetType, SubscribeAllBit, SubscribeController, SubscribeNoteCreateBit, SubscribePostCreateBit, SubscribeRecentCreateBit, SubscribeSayCreateBit, SubscribeType, SubscribeTypeToBitMap, TLogin, TagModel, TextBaseModel, TimelineData, TimelineType, TopicController, TopicModel, TranslationMeta, Url, UrlOptionModel, UserController, UserModel, allControllerNames, allControllers, createClient, createClient as default, camelcaseKeys as simpleCamelcaseKeys };

package/dist/index.d.mts

@@ -182,6 +182,7 @@ interface TranslationMeta {
 type ModelWithTranslation<T> = T & {
   isTranslated: boolean;
   translationMeta?: TranslationMeta;
+  availableTranslations?: string[];
 };
 //#endregion
 //#region models/post.d.ts
@@ -1521,7 +1522,13 @@ type PostListOptions = {
   year?: number;
   sortBy?: 'categoryId' | 'title' | 'created' | 'modified';
   sortOrder?: 1 | -1;
-  truncate?: number;
+  truncate?: number; /** 语言代码，用于获取翻译版本 */
+  lang?: string;
+};
+/** 文章列表项，可能包含翻译信息 */
+type PostListItem = PostModel & {
+  isTranslated?: boolean;
+  translationMeta?: TranslationMeta;
 };
 declare class PostController<ResponseWrapper> implements IController {
   private client;
@@ -1533,15 +1540,16 @@ declare class PostController<ResponseWrapper> implements IController {
    * 获取文章列表分页
    * @param page
    * @param perPage
-   * @returns
+   * @param options 可选参数，包含 lang 用于获取翻译版本
+   * @returns 当传入 lang 时，返回的文章可能包含 isTranslated 和 translationMeta 字段
    */
-  getList(page?: number, perPage?: number, options?: PostListOptions): RequestProxyResult<PaginateResult<PostModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
+  getList(page?: number, perPage?: number, options?: PostListOptions): RequestProxyResult<PaginateResult<PostListItem>, ResponseWrapper, ResponseWrapper extends unknown ? {
     [key: string]: any;
-    data: PaginateResult<PostModel>;
+    data: PaginateResult<PostListItem>;
   } : ResponseWrapper extends {
-    data: PaginateResult<PostModel>;
+    data: PaginateResult<PostListItem>;
   } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
-    data: PaginateResult<PostModel>;
+    data: PaginateResult<PostListItem>;
   }>;
   /**
    * 根据分类和路径查找文章
@@ -2048,4 +2056,4 @@ declare const allControllerNames: readonly ["ai", "ack", "activity", "aggregate"
  */
 declare const camelcaseKeys: <T = any>(obj: any) => T;
 //#endregion
-export { AIController, AIDeepReadingModel, AISummaryModel, AckController, ActivityController, ActivityPresence, AdminExtraModel, AggregateAIConfig, AggregateController, AggregateRoot, AggregateRootWithTheme, AggregateStat, AggregateTop, AggregateTopNote, AggregateTopPost, AlgoliaSearchOptionsModel, AuthUser, BackupOptionsModel, BaiduSearchOptionsModel, BaseCommentIndexModel, BaseModel, BingSearchOptionsModel, CategoryController, CategoryEntries, CategoryModel, CategoryType, CategoryWithChildrenModel, CollectionRefTypes, CommentController, CommentDto, CommentModel, CommentOptionsModel, CommentRef, CommentState, Coordinate, Count, EnumPageType, type HTTPClient, IConfig, IConfigKeys, type IRequestAdapter, Image, LastYearPublication, LinkController, LinkModel, LinkState, LinkType, MailOptionsModel, ModelWithLiked, ModelWithTranslation, NoteController, NoteModel, NoteWrappedPayload, NoteWrappedWithLikedAndTranslationPayload, NoteWrappedWithLikedPayload, PageController, PageModel, Pager, PaginateResult, PostController, PostModel, ProjectController, ProjectModel, ReaderModel, RecentActivities, RecentComment, RecentLike, RecentNote, RecentPost, RecentRecent, RecentlyAttitudeEnum, RecentlyAttitudeResultEnum, RecentlyController, RecentlyModel, RecentlyRefType, RecentlyRefTypes, RequestError, RoomOmittedNote, RoomOmittedPage, RoomOmittedPost, RoomsData, SayController, SayModel, SearchController, SeoOptionModel, ServerlessController, SnippetController, SnippetModel, SnippetType, SubscribeAllBit, SubscribeController, SubscribeNoteCreateBit, SubscribePostCreateBit, SubscribeRecentCreateBit, SubscribeSayCreateBit, SubscribeType, SubscribeTypeToBitMap, TLogin, TagModel, TextBaseModel, TimelineData, TimelineType, TopicController, TopicModel, TranslationMeta, Url, UrlOptionModel, UserController, UserModel, allControllerNames, allControllers, createClient, createClient as default, camelcaseKeys as simpleCamelcaseKeys };
+export { AIController, AIDeepReadingModel, AISummaryModel, AckController, ActivityController, ActivityPresence, AdminExtraModel, AggregateAIConfig, AggregateController, AggregateRoot, AggregateRootWithTheme, AggregateStat, AggregateTop, AggregateTopNote, AggregateTopPost, AlgoliaSearchOptionsModel, AuthUser, BackupOptionsModel, BaiduSearchOptionsModel, BaseCommentIndexModel, BaseModel, BingSearchOptionsModel, CategoryController, CategoryEntries, CategoryModel, CategoryType, CategoryWithChildrenModel, CollectionRefTypes, CommentController, CommentDto, CommentModel, CommentOptionsModel, CommentRef, CommentState, Coordinate, Count, EnumPageType, type HTTPClient, IConfig, IConfigKeys, type IRequestAdapter, Image, LastYearPublication, LinkController, LinkModel, LinkState, LinkType, MailOptionsModel, ModelWithLiked, ModelWithTranslation, NoteController, NoteModel, NoteWrappedPayload, NoteWrappedWithLikedAndTranslationPayload, NoteWrappedWithLikedPayload, PageController, PageModel, Pager, PaginateResult, PostController, type PostListItem, type PostListOptions, PostModel, ProjectController, ProjectModel, ReaderModel, RecentActivities, RecentComment, RecentLike, RecentNote, RecentPost, RecentRecent, RecentlyAttitudeEnum, RecentlyAttitudeResultEnum, RecentlyController, RecentlyModel, RecentlyRefType, RecentlyRefTypes, RequestError, RoomOmittedNote, RoomOmittedPage, RoomOmittedPost, RoomsData, SayController, SayModel, SearchController, SeoOptionModel, ServerlessController, SnippetController, SnippetModel, SnippetType, SubscribeAllBit, SubscribeController, SubscribeNoteCreateBit, SubscribePostCreateBit, SubscribeRecentCreateBit, SubscribeSayCreateBit, SubscribeType, SubscribeTypeToBitMap, TLogin, TagModel, TextBaseModel, TimelineData, TimelineType, TopicController, TopicModel, TranslationMeta, Url, UrlOptionModel, UserController, UserModel, allControllerNames, allControllers, createClient, createClient as default, camelcaseKeys as simpleCamelcaseKeys };

package/dist/index.mjs

@@ -526,10 +526,11 @@ var PostController = class {
 	* 获取文章列表分页
 	* @param page
 	* @param perPage
-	* @returns
+	* @param options 可选参数，包含 lang 用于获取翻译版本
+	* @returns 当传入 lang 时，返回的文章可能包含 isTranslated 和 translationMeta 字段
 	*/
 	getList(page = 1, perPage = 10, options = {}) {
-		const { select, sortBy, sortOrder, year, truncate } = options;
+		const { select, sortBy, sortOrder, year, truncate, lang } = options;
 		return this.proxy.get({ params: {
 			page,
 			size: perPage,
@@ -537,7 +538,8 @@ var PostController = class {
 			sortBy,
 			sortOrder,
 			year,
-			truncate
+			truncate,
+			lang
 		} });
 	}
 	getPost(idOrCategoryName, slug, options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mx-space/api-client",
-  "version": "1.20.0",
+  "version": "1.21.0",
   "description": "A api client for mx-space server@next",
   "type": "module",
   "engines": {
@@ -42,13 +42,6 @@
     "tag": false,
     "commit_message": "chore(release): bump @mx-space/api-client to v${NEW_VERSION}"
   },
-  "scripts": {
-    "package": "rm -rf dist && tsdown && node mod-dts.mjs",
-    "build": "npm run package",
-    "prepackage": "rm -rf dist",
-    "test": "vitest",
-    "dev": "vitest"
-  },
   "devDependencies": {
     "@types/cors": "2.8.19",
     "@types/express": "5.0.6",
@@ -63,5 +56,12 @@
     "umi-request": "1.4.0",
     "vite": "^7.3.1",
     "vitest": "4.0.18"
+  },
+  "scripts": {
+    "package": "rm -rf dist && tsdown && node mod-dts.mjs",
+    "build": "npm run package",
+    "prepackage": "rm -rf dist",
+    "test": "vitest",
+    "dev": "vitest"
   }
-}
+}