@mx-space/api-client 3.7.0 → 3.8.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/index.cjs

@@ -491,6 +491,21 @@ var CommentController = class {
 	readerReply(commentId, data) {
 		return this.proxy.reader.reply(commentId).post({ data });
 	}
+	/**
+	* 取评论图片上传之公开配置（启用状态、限额、MIME 白名单等）
+	*/
+	getUploadConfig() {
+		return this.proxy.uploads.config.get();
+	}
+	/**
+	* 已登录读者上传评论图片
+	* @param file - 浏览器 File / Blob 或 node 之 Buffer 包装
+	*/
+	uploadImage(file) {
+		const form = new FormData();
+		form.append("file", file);
+		return this.proxy.uploads.post({ data: form });
+	}
 };
 //#endregion
 //#region controllers/base.ts

package/dist/index.d.cts

@@ -1789,6 +1789,20 @@ interface ReaderCommentDto {
   isWhispers?: boolean;
 }
 type CommentDto = AnonymousCommentDto | ReaderCommentDto;
+interface CommentUploadConfigDto {
+  enable: boolean;
+  singleFileSizeMB: number;
+  commentImageMaxCount: number;
+  mimeWhitelist: string[];
+  pendingTtlMinutes: number;
+}
+interface CommentUploadResultDto {
+  url: string;
+  fileName: string;
+  byteSize: number;
+  mimeType: string;
+  expireAt: string;
+}
 //#endregion
 //#region controllers/comment.d.ts
 declare module '@mx-space/api-client' {
@@ -1900,6 +1914,29 @@ declare class CommentController<ResponseWrapper> implements IController {
   } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
     data: CommentModel;
   }>;
+  /**
+   * 取评论图片上传之公开配置（启用状态、限额、MIME 白名单等）
+   */
+  getUploadConfig(): RequestProxyResult<CommentUploadConfigDto, ResponseWrapper, ResponseWrapper extends unknown ? {
+    [key: string]: any;
+    data: CommentUploadConfigDto;
+  } : ResponseWrapper extends {
+    data: CommentUploadConfigDto;
+  } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+    data: CommentUploadConfigDto;
+  }>;
+  /**
+   * 已登录读者上传评论图片
+   * @param file - 浏览器 File / Blob 或 node 之 Buffer 包装
+   */
+  uploadImage(file: File | Blob): RequestProxyResult<CommentUploadResultDto, ResponseWrapper, ResponseWrapper extends unknown ? {
+    [key: string]: any;
+    data: CommentUploadResultDto;
+  } : ResponseWrapper extends {
+    data: CommentUploadResultDto;
+  } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+    data: CommentUploadResultDto;
+  }>;
 }
 //#endregion
 //#region controllers/base.d.ts
@@ -2787,4 +2824,4 @@ declare const allControllerNames: readonly ["ai", "ack", "activity", "aggregate"
  */
 declare const camelcaseKeys: <T = any>(obj: any) => T;
 //#endregion
-export { AIController, AIDeepReadingModel, AIInsightsModel, AIInsightsStreamEvent, AISummaryModel, AISummaryStreamEvent, AITranslationModel, AITranslationStreamEvent, AcademicMetadata, AckController, ActivityController, ActivityPresence, AdminExtraModel, AggregateAIConfig, AggregateController, AggregateRoot, AggregateRootWithTheme, AggregateSiteInfo, AggregateStat, AggregateTop, AggregateTopNote, AggregateTopPost, AnonymousCommentDto, AuthUser, BackupOptionsModel, BaiduSearchOptionsModel, BaseCommentIndexModel, BaseModel, BetterAuthSession, BetterAuthSessionResult, BetterAuthSignInResult, BetterAuthUser, BetterAuthUserRole, BingSearchOptionsModel, BookMetadata, CategoryChildPost, CategoryController, CategoryEntries, CategoryModel$1 as CategoryModel, CategoryType, CategoryWithChildrenModel, CheckLoggedResult, CodeMetadata, CollectionRefTypes, CommentController, CommentDto, CommentModel, CommentOptionsModel, CommentRef, CommentReplyWindow, CommentState, CommentThreadItem, CommentThreadReplies, Coordinate, Count, EnumPageType, GithubMetadata, type HTTPClient, IConfig, IConfigKeys, type IRequestAdapter, Image, LastYearPublication, LatestCombinedItem, LatestData, LatestNoteItem, LatestPostItem, LinkController, LinkMetadata, LinkModel, LinkState, LinkType, MailOptionsModel, MediaMetadata, ModelWithLiked, ModelWithTranslation, MusicMetadata, NoteController, type NoteMiddleListOptions, NoteModel, type NoteTimelineItem, type NoteTopicListItem, type NoteTopicListOptions, NoteWrappedPayload, NoteWrappedWithLikedAndTranslationPayload, NoteWrappedWithLikedPayload, OwnerAllowLoginResult, OwnerSessionResult, PageController, PageModel, Pager, PaginateResult, PostController, type PostListItem, type PostListOptions, PostModel, ProjectController, ProjectModel, ReaderCommentDto, ReaderModel, RecentActivities, RecentComment, RecentLike, RecentNote, RecentPost, RecentRecent, RecentlyAttitudeEnum, RecentlyAttitudeResultEnum, RecentlyController, RecentlyMetadata, RecentlyModel, RecentlyRefType, RecentlyRefTypes, RecentlyTypeEnum, RequestError, RoomOmittedNote, RoomOmittedPage, RoomOmittedPost, RoomsData, SayController, SayModel, SearchController, SeoOptionModel, ServerlessController, SnippetController, SnippetModel, SnippetType, SubscribeAllBit, SubscribeController, SubscribeNoteCreateBit, SubscribePostCreateBit, SubscribeRecentCreateBit, SubscribeSayCreateBit, SubscribeType, SubscribeTypeToBitMap, TLogin, TagDetailPost, TagModel, TextBaseModel, TextBaseModelLexical, TextBaseModelMarkdown, ThirdPartyServiceIntegrationModel, TimelineData, TimelineType, TopicController, TopicModel, TranslationMeta, Url, UrlOptionModel, UserController, UserModel, allControllerNames, allControllers, createClient, createClient as default, camelcaseKeys as simpleCamelcaseKeys };
+export { AIController, AIDeepReadingModel, AIInsightsModel, AIInsightsStreamEvent, AISummaryModel, AISummaryStreamEvent, AITranslationModel, AITranslationStreamEvent, AcademicMetadata, AckController, ActivityController, ActivityPresence, AdminExtraModel, AggregateAIConfig, AggregateController, AggregateRoot, AggregateRootWithTheme, AggregateSiteInfo, AggregateStat, AggregateTop, AggregateTopNote, AggregateTopPost, AnonymousCommentDto, AuthUser, BackupOptionsModel, BaiduSearchOptionsModel, BaseCommentIndexModel, BaseModel, BetterAuthSession, BetterAuthSessionResult, BetterAuthSignInResult, BetterAuthUser, BetterAuthUserRole, BingSearchOptionsModel, BookMetadata, CategoryChildPost, CategoryController, CategoryEntries, CategoryModel$1 as CategoryModel, CategoryType, CategoryWithChildrenModel, CheckLoggedResult, CodeMetadata, CollectionRefTypes, CommentController, CommentDto, CommentModel, CommentOptionsModel, CommentRef, CommentReplyWindow, CommentState, CommentThreadItem, CommentThreadReplies, CommentUploadConfigDto, CommentUploadResultDto, Coordinate, Count, EnumPageType, GithubMetadata, type HTTPClient, IConfig, IConfigKeys, type IRequestAdapter, Image, LastYearPublication, LatestCombinedItem, LatestData, LatestNoteItem, LatestPostItem, LinkController, LinkMetadata, LinkModel, LinkState, LinkType, MailOptionsModel, MediaMetadata, ModelWithLiked, ModelWithTranslation, MusicMetadata, NoteController, type NoteMiddleListOptions, NoteModel, type NoteTimelineItem, type NoteTopicListItem, type NoteTopicListOptions, NoteWrappedPayload, NoteWrappedWithLikedAndTranslationPayload, NoteWrappedWithLikedPayload, OwnerAllowLoginResult, OwnerSessionResult, PageController, PageModel, Pager, PaginateResult, PostController, type PostListItem, type PostListOptions, PostModel, ProjectController, ProjectModel, ReaderCommentDto, ReaderModel, RecentActivities, RecentComment, RecentLike, RecentNote, RecentPost, RecentRecent, RecentlyAttitudeEnum, RecentlyAttitudeResultEnum, RecentlyController, RecentlyMetadata, RecentlyModel, RecentlyRefType, RecentlyRefTypes, RecentlyTypeEnum, RequestError, RoomOmittedNote, RoomOmittedPage, RoomOmittedPost, RoomsData, SayController, SayModel, SearchController, SeoOptionModel, ServerlessController, SnippetController, SnippetModel, SnippetType, SubscribeAllBit, SubscribeController, SubscribeNoteCreateBit, SubscribePostCreateBit, SubscribeRecentCreateBit, SubscribeSayCreateBit, SubscribeType, SubscribeTypeToBitMap, TLogin, TagDetailPost, TagModel, TextBaseModel, TextBaseModelLexical, TextBaseModelMarkdown, ThirdPartyServiceIntegrationModel, TimelineData, TimelineType, TopicController, TopicModel, TranslationMeta, Url, UrlOptionModel, UserController, UserModel, allControllerNames, allControllers, createClient, createClient as default, camelcaseKeys as simpleCamelcaseKeys };

package/dist/index.d.mts

@@ -1789,6 +1789,20 @@ interface ReaderCommentDto {
   isWhispers?: boolean;
 }
 type CommentDto = AnonymousCommentDto | ReaderCommentDto;
+interface CommentUploadConfigDto {
+  enable: boolean;
+  singleFileSizeMB: number;
+  commentImageMaxCount: number;
+  mimeWhitelist: string[];
+  pendingTtlMinutes: number;
+}
+interface CommentUploadResultDto {
+  url: string;
+  fileName: string;
+  byteSize: number;
+  mimeType: string;
+  expireAt: string;
+}
 //#endregion
 //#region controllers/comment.d.ts
 declare module '@mx-space/api-client' {
@@ -1900,6 +1914,29 @@ declare class CommentController<ResponseWrapper> implements IController {
   } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
     data: CommentModel;
   }>;
+  /**
+   * 取评论图片上传之公开配置（启用状态、限额、MIME 白名单等）
+   */
+  getUploadConfig(): RequestProxyResult<CommentUploadConfigDto, ResponseWrapper, ResponseWrapper extends unknown ? {
+    [key: string]: any;
+    data: CommentUploadConfigDto;
+  } : ResponseWrapper extends {
+    data: CommentUploadConfigDto;
+  } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+    data: CommentUploadConfigDto;
+  }>;
+  /**
+   * 已登录读者上传评论图片
+   * @param file - 浏览器 File / Blob 或 node 之 Buffer 包装
+   */
+  uploadImage(file: File | Blob): RequestProxyResult<CommentUploadResultDto, ResponseWrapper, ResponseWrapper extends unknown ? {
+    [key: string]: any;
+    data: CommentUploadResultDto;
+  } : ResponseWrapper extends {
+    data: CommentUploadResultDto;
+  } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+    data: CommentUploadResultDto;
+  }>;
 }
 //#endregion
 //#region controllers/base.d.ts
@@ -2787,4 +2824,4 @@ declare const allControllerNames: readonly ["ai", "ack", "activity", "aggregate"
  */
 declare const camelcaseKeys: <T = any>(obj: any) => T;
 //#endregion
-export { AIController, AIDeepReadingModel, AIInsightsModel, AIInsightsStreamEvent, AISummaryModel, AISummaryStreamEvent, AITranslationModel, AITranslationStreamEvent, AcademicMetadata, AckController, ActivityController, ActivityPresence, AdminExtraModel, AggregateAIConfig, AggregateController, AggregateRoot, AggregateRootWithTheme, AggregateSiteInfo, AggregateStat, AggregateTop, AggregateTopNote, AggregateTopPost, AnonymousCommentDto, AuthUser, BackupOptionsModel, BaiduSearchOptionsModel, BaseCommentIndexModel, BaseModel, BetterAuthSession, BetterAuthSessionResult, BetterAuthSignInResult, BetterAuthUser, BetterAuthUserRole, BingSearchOptionsModel, BookMetadata, CategoryChildPost, CategoryController, CategoryEntries, CategoryModel$1 as CategoryModel, CategoryType, CategoryWithChildrenModel, CheckLoggedResult, CodeMetadata, CollectionRefTypes, CommentController, CommentDto, CommentModel, CommentOptionsModel, CommentRef, CommentReplyWindow, CommentState, CommentThreadItem, CommentThreadReplies, Coordinate, Count, EnumPageType, GithubMetadata, type HTTPClient, IConfig, IConfigKeys, type IRequestAdapter, Image, LastYearPublication, LatestCombinedItem, LatestData, LatestNoteItem, LatestPostItem, LinkController, LinkMetadata, LinkModel, LinkState, LinkType, MailOptionsModel, MediaMetadata, ModelWithLiked, ModelWithTranslation, MusicMetadata, NoteController, type NoteMiddleListOptions, NoteModel, type NoteTimelineItem, type NoteTopicListItem, type NoteTopicListOptions, NoteWrappedPayload, NoteWrappedWithLikedAndTranslationPayload, NoteWrappedWithLikedPayload, OwnerAllowLoginResult, OwnerSessionResult, PageController, PageModel, Pager, PaginateResult, PostController, type PostListItem, type PostListOptions, PostModel, ProjectController, ProjectModel, ReaderCommentDto, ReaderModel, RecentActivities, RecentComment, RecentLike, RecentNote, RecentPost, RecentRecent, RecentlyAttitudeEnum, RecentlyAttitudeResultEnum, RecentlyController, RecentlyMetadata, RecentlyModel, RecentlyRefType, RecentlyRefTypes, RecentlyTypeEnum, RequestError, RoomOmittedNote, RoomOmittedPage, RoomOmittedPost, RoomsData, SayController, SayModel, SearchController, SeoOptionModel, ServerlessController, SnippetController, SnippetModel, SnippetType, SubscribeAllBit, SubscribeController, SubscribeNoteCreateBit, SubscribePostCreateBit, SubscribeRecentCreateBit, SubscribeSayCreateBit, SubscribeType, SubscribeTypeToBitMap, TLogin, TagDetailPost, TagModel, TextBaseModel, TextBaseModelLexical, TextBaseModelMarkdown, ThirdPartyServiceIntegrationModel, TimelineData, TimelineType, TopicController, TopicModel, TranslationMeta, Url, UrlOptionModel, UserController, UserModel, allControllerNames, allControllers, createClient, createClient as default, camelcaseKeys as simpleCamelcaseKeys };
+export { AIController, AIDeepReadingModel, AIInsightsModel, AIInsightsStreamEvent, AISummaryModel, AISummaryStreamEvent, AITranslationModel, AITranslationStreamEvent, AcademicMetadata, AckController, ActivityController, ActivityPresence, AdminExtraModel, AggregateAIConfig, AggregateController, AggregateRoot, AggregateRootWithTheme, AggregateSiteInfo, AggregateStat, AggregateTop, AggregateTopNote, AggregateTopPost, AnonymousCommentDto, AuthUser, BackupOptionsModel, BaiduSearchOptionsModel, BaseCommentIndexModel, BaseModel, BetterAuthSession, BetterAuthSessionResult, BetterAuthSignInResult, BetterAuthUser, BetterAuthUserRole, BingSearchOptionsModel, BookMetadata, CategoryChildPost, CategoryController, CategoryEntries, CategoryModel$1 as CategoryModel, CategoryType, CategoryWithChildrenModel, CheckLoggedResult, CodeMetadata, CollectionRefTypes, CommentController, CommentDto, CommentModel, CommentOptionsModel, CommentRef, CommentReplyWindow, CommentState, CommentThreadItem, CommentThreadReplies, CommentUploadConfigDto, CommentUploadResultDto, Coordinate, Count, EnumPageType, GithubMetadata, type HTTPClient, IConfig, IConfigKeys, type IRequestAdapter, Image, LastYearPublication, LatestCombinedItem, LatestData, LatestNoteItem, LatestPostItem, LinkController, LinkMetadata, LinkModel, LinkState, LinkType, MailOptionsModel, MediaMetadata, ModelWithLiked, ModelWithTranslation, MusicMetadata, NoteController, type NoteMiddleListOptions, NoteModel, type NoteTimelineItem, type NoteTopicListItem, type NoteTopicListOptions, NoteWrappedPayload, NoteWrappedWithLikedAndTranslationPayload, NoteWrappedWithLikedPayload, OwnerAllowLoginResult, OwnerSessionResult, PageController, PageModel, Pager, PaginateResult, PostController, type PostListItem, type PostListOptions, PostModel, ProjectController, ProjectModel, ReaderCommentDto, ReaderModel, RecentActivities, RecentComment, RecentLike, RecentNote, RecentPost, RecentRecent, RecentlyAttitudeEnum, RecentlyAttitudeResultEnum, RecentlyController, RecentlyMetadata, RecentlyModel, RecentlyRefType, RecentlyRefTypes, RecentlyTypeEnum, RequestError, RoomOmittedNote, RoomOmittedPage, RoomOmittedPost, RoomsData, SayController, SayModel, SearchController, SeoOptionModel, ServerlessController, SnippetController, SnippetModel, SnippetType, SubscribeAllBit, SubscribeController, SubscribeNoteCreateBit, SubscribePostCreateBit, SubscribeRecentCreateBit, SubscribeSayCreateBit, SubscribeType, SubscribeTypeToBitMap, TLogin, TagDetailPost, TagModel, TextBaseModel, TextBaseModelLexical, TextBaseModelMarkdown, ThirdPartyServiceIntegrationModel, TimelineData, TimelineType, TopicController, TopicModel, TranslationMeta, Url, UrlOptionModel, UserController, UserModel, allControllerNames, allControllers, createClient, createClient as default, camelcaseKeys as simpleCamelcaseKeys };

package/dist/index.mjs

@@ -487,6 +487,21 @@ var CommentController = class {
 	readerReply(commentId, data) {
 		return this.proxy.reader.reply(commentId).post({ data });
 	}
+	/**
+	* 取评论图片上传之公开配置（启用状态、限额、MIME 白名单等）
+	*/
+	getUploadConfig() {
+		return this.proxy.uploads.config.get();
+	}
+	/**
+	* 已登录读者上传评论图片
+	* @param file - 浏览器 File / Blob 或 node 之 Buffer 包装
+	*/
+	uploadImage(file) {
+		const form = new FormData();
+		form.append("file", file);
+		return this.proxy.uploads.post({ data: form });
+	}
 };
 //#endregion
 //#region controllers/base.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mx-space/api-client",
-  "version": "3.7.0",
+  "version": "3.8.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",
-    "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": "^8.0.10",
     "vitest": "4.1.5"
+  },
+  "scripts": {
+    "package": "rm -rf dist && tsdown",
+    "build": "npm run package",
+    "prepackage": "rm -rf dist",
+    "test": "vitest",
+    "dev": "vitest"
   }
-}
+}