@mx-space/api-client 1.21.2 → 2.1.0

package/dist/index.mjs

@@ -244,6 +244,83 @@ var AIController = class {
 	async getDeepReading(articleId) {
 		return this.proxy("deep-readings").article(articleId).get();
 	}
+	/**
+	* Get translation for an article
+	* @support core >= 9.4.0
+	*/
+	async getTranslation({ articleId, lang }) {
+		return this.proxy.translations.article(articleId).get({ params: { lang } });
+	}
+	/**
+	* Get available translation languages for an article
+	* @support core >= 9.4.0
+	*/
+	async getAvailableLanguages(articleId) {
+		return this.proxy.translations.article(articleId).languages.get();
+	}
+	/**
+	* Get URL for streaming summary generation (SSE)
+	*
+	* @see AISummaryStreamEvent for event types
+	* @support core >= 9.4.0
+	*/
+	getSummaryGenerateUrl({ articleId, lang }) {
+		const baseUrl = this.client.endpoint;
+		const params = new URLSearchParams();
+		if (lang) params.set("lang", lang);
+		const query = params.toString();
+		return `${baseUrl}/${this.base}/summaries/article/${articleId}/generate${query ? `?${query}` : ""}`;
+	}
+	/**
+	* Stream summary generation using fetch
+	*
+	* @see AISummaryStreamEvent for event types
+	* @support core >= 9.4.0
+	*/
+	async streamSummaryGenerate({ articleId, lang }, fetchOptions) {
+		const url = this.getSummaryGenerateUrl({
+			articleId,
+			lang
+		});
+		return fetch(url, {
+			...fetchOptions,
+			headers: {
+				Accept: "text/event-stream",
+				...fetchOptions?.headers
+			}
+		});
+	}
+	/**
+	* Get URL for streaming translation generation (SSE)
+	*
+	* @see AITranslationStreamEvent for event types
+	* @support core >= 9.4.0
+	*/
+	getTranslationGenerateUrl({ articleId, lang }) {
+		const baseUrl = this.client.endpoint;
+		const params = new URLSearchParams();
+		params.set("lang", lang);
+		return `${baseUrl}/${this.base}/translations/article/${articleId}/generate?${params.toString()}`;
+	}
+	/**
+	* Stream translation generation using fetch
+	*
+	* @see AITranslationStreamEvent for event types
+	* @support core >= 9.4.0
+	*/
+	async streamTranslationGenerate({ articleId, lang }, fetchOptions) {
+		const url = this.getTranslationGenerateUrl({
+			articleId,
+			lang
+		});
+		return fetch(url, {
+			...fetchOptions,
+			headers: {
+				Accept: "text/event-stream",
+				...fetchOptions?.headers
+			}
+		});
+	}
 };
 
 //#endregion
@@ -430,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
 		} });
 	}
 	/**
@@ -482,6 +560,81 @@ var NoteController = class {
 	}
 };
 
+//#endregion
+//#region controllers/owner.ts
+var UserController = class {
+	constructor(client) {
+		this.client = client;
+		this.base = "owner";
+		this.name = ["owner"];
+		autoBind(this);
+	}
+	get proxy() {
+		return this.client.proxy(this.base);
+	}
+	get authProxy() {
+		return this.client.proxy("auth");
+	}
+	normalizeToken(token) {
+		const normalized = token?.trim();
+		if (!normalized) return;
+		return normalized.replace(/^bearer\s+/i, "");
+	}
+	/**
+	* @deprecated Use `getOwnerInfo()` instead.
+	*/
+	getMasterInfo() {
+		return this.getOwnerInfo();
+	}
+	getOwnerInfo() {
+		return this.proxy.get();
+	}
+	login(username, password, options) {
+		return this.authProxy("sign-in").username.post({ data: {
+			username,
+			password,
+			...options
+		} });
+	}
+	logout() {
+		return this.authProxy("sign-out").post();
+	}
+	/**
+	* Better Auth raw session (`/auth/get-session`).
+	*/
+	getAuthSession(options) {
+		return this.authProxy("get-session").get({ params: options });
+	}
+	/**
+	* Core session summary (`/auth/session`).
+	*/
+	getSession() {
+		return this.authProxy.session.get();
+	}
+	getProviders() {
+		return this.authProxy.providers.get();
+	}
+	getAllowLoginMethods() {
+		return this.proxy("allow-login").get();
+	}
+	listSessions() {
+		return this.authProxy("list-sessions").get();
+	}
+	revokeSession(token) {
+		return this.authProxy("revoke-session").post({ data: { token } });
+	}
+	revokeSessions() {
+		return this.authProxy("revoke-sessions").post();
+	}
+	revokeOtherSessions() {
+		return this.authProxy("revoke-other-sessions").post();
+	}
+	checkTokenValid(token) {
+		const normalized = this.normalizeToken(token);
+		return this.proxy.check_logged.get({ params: normalized ? { token: normalized } : void 0 });
+	}
+};
+
 //#endregion
 //#region controllers/page.ts
 var PageController = class {
@@ -518,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 });
 	}
 };
 
@@ -557,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 });
+		}
 	}
 	/**
 	* 获取最新的文章
@@ -767,35 +925,6 @@ var TopicController = class extends BaseCrudController {
 	}
 };
 
-//#endregion
-//#region controllers/user.ts
-var UserController = class {
-	constructor(client) {
-		this.client = client;
-		this.base = "master";
-		this.name = ["user", "master"];
-		autoBind(this);
-	}
-	get proxy() {
-		return this.client.proxy(this.base);
-	}
-	getMasterInfo() {
-		return this.proxy.get();
-	}
-	login(username, password) {
-		return this.proxy.login.post({ data: {
-			username,
-			password
-		} });
-	}
-	loginWithToken(token) {
-		return this.proxy.login.put({ params: token ? { token: `bearer ${token.replace(/^bearer\s/i, "")}` } : void 0 });
-	}
-	checkTokenValid(token) {
-		return this.proxy.check_logged.get({ params: { token: `bearer ${token.replace(/^bearer\s/i, "")}` } });
-	}
-};
-
 //#endregion
 //#region controllers/index.ts
 const allControllers = [
@@ -838,9 +967,8 @@ const allControllerNames = [
 	"snippet",
 	"serverless",
 	"subscribe",
-	"user",
+	"owner",
 	"friend",
-	"master",
 	"shorthand"
 ];
 
@@ -1041,9 +1169,9 @@ let TimelineType = /* @__PURE__ */ function(TimelineType) {
 
 //#endregion
 //#region ../../apps/core/src/constants/db.constant.ts
-const POST_COLLECTION_NAME = "posts";
 const NOTE_COLLECTION_NAME = "notes";
 const PAGE_COLLECTION_NAME = "pages";
+const POST_COLLECTION_NAME = "posts";
 const RECENTLY_COLLECTION_NAME = "recentlies";
 let CollectionRefTypes = /* @__PURE__ */ function(CollectionRefTypes) {
 	CollectionRefTypes[CollectionRefTypes["Post"] = POST_COLLECTION_NAME] = "Post";
@@ -1108,7 +1236,7 @@ let SnippetType = /* @__PURE__ */ function(SnippetType) {
 
 //#endregion
 //#region ../../apps/core/src/modules/subscribe/subscribe.constant.ts
-const SubscribePostCreateBit = Math.trunc(1);
+const SubscribePostCreateBit = 1;
 const SubscribeNoteCreateBit = 2;
 const SubscribeSayCreateBit = 4;
 const SubscribeRecentCreateBit = 8;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mx-space/api-client",
-  "version": "1.21.2",
+  "version": "2.1.0",
   "description": "A api client for mx-space server@next",
   "type": "module",
   "engines": {
@@ -42,6 +42,13 @@
     "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",
@@ -56,12 +63,5 @@
     "umi-request": "1.4.0",
     "vite": "^7.3.1",
     "vitest": "4.0.18"
-  },
-  "scripts": {
-    "package": "rm -rf dist && tsdown",
-    "build": "npm run package",
-    "prepackage": "rm -rf dist",
-    "test": "vitest",
-    "dev": "vitest"
   }
-}
+}

package/readme.md

@@ -2,6 +2,75 @@
 
 这是一个适用于 MServer v3 的 JS SDK，封装了常用接口请求方法以及返回类型的声明，以快速开发前端应用。
 
+## 版本兼容性
+
+| api-client 版本 | 支持的 Server 版本 | 说明                          |
+| --------------- | ------------------ | ----------------------------- |
+| v2.x            | >= 10              | 基于 Better Auth 的新认证系统 |
+| v1.x            | <= 9               | 旧版认证系统                  |
+
+**注意**: v2 版本与 v1 版本存在 Breaking Changes，升级时请参考下方迁移指南。
+
+## 迁移到 v2
+
+### Breaking Changes
+
+#### 1. 控制器重命名
+
+`user` 控制器已重命名为 `owner`，`master` 别名已被移除：
+
+```diff
+- client.user.getMasterInfo()
++ client.owner.getOwnerInfo()
+
+- client.master.getMasterInfo()
++ client.owner.getOwnerInfo()
+```
+
+#### 2. 登录接口变更
+
+登录接口从 `POST /master/login` 变更为 `POST /auth/sign-in`：
+
+```diff
+- client.user.login(username, password)
++ client.owner.login(username, password, { rememberMe: boolean })
+```
+
+v2 版本的 `login` 方法返回的数据结构也发生了变化，现在返回 `{ token, user }` 格式。
+
+#### 3. 新增 Better Auth 相关接口
+
+v2 版本新增了 Better Auth 认证相关的接口：
+
+```ts
+// 获取当前会话
+client.owner.getSession()
+
+// 获取 Better Auth 原生会话
+client.owner.getAuthSession()
+
+// 登出
+client.owner.logout()
+
+// 获取支持的登录方式
+client.owner.getAllowLoginMethods()
+
+// 获取 OAuth 提供商列表
+client.owner.getProviders()
+
+// 列出所有会话
+client.owner.listSessions()
+
+// 撤销指定会话
+client.owner.revokeSession(token)
+
+// 撤销所有会话
+client.owner.revokeSessions()
+
+// 撤销其他会话
+client.owner.revokeOtherSessions()
+```
+
 ## 迁移到 v1
 
 不再提供 camelcase-keys 的 re-export，此库不再依赖 camelcase-keys 库，如有需要可自行安装。
@@ -44,7 +113,7 @@ $axios.interceptors.request.use(
   (config) => {
     const token = getToken()
     if (token) {
-      config.headers!.Authorization = `bearer ${  getToken()}`
+      config.headers!.Authorization = `bearer ${getToken()}`
     }
 
     return config

package/LICENSE

@@ -1,33 +0,0 @@
-** 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.