@yuntower/yuntower-account-electron-sdk 0.0.2 → 0.0.3

package/README.md

@@ -1,113 +1,113 @@
-# YunTowerAccount-ElectronSDK
-
-云塔账号通行证 Electron 桌面端 SDK，支持在桌面应用中拉起浏览器完成授权，并通过自定义 URL 方案回到应用、获取 token 与用户信息。
-
-- 官网：[https://account.yuntower.com](https://account.yuntower.com)
-- 文档：[https://docs.yuntower.com/account/open.html](https://docs.yuntower.com/account/open.html)
-- NPM：[https://www.npmjs.com/package/@yuntower/yuntower-account-electron-sdk](https://www.npmjs.com/package/@yuntower/yuntower-account-electron-sdk)
-
-```bash
-npm install @yuntower/yuntower-account-electron-sdk
-```
-
-依赖：`electron >= 20`（peerDependency）
-
----
-
-## 快速开始
-
-接入前请在云塔账号通行证**应用详情页**为该应用配置并加入白名单的**重定向地址**（如 `myapp://callback`）。授权完成后浏览器会重定向到该地址；Electron 侧使用的**方案名**（`protocol`）与**重定向 URL**（`redirectUrl`）须与后台一致。下例中的 `myapp` 请替换为本应用已注册的方案名与地址。
-
-在主进程中：① 在 **app.ready 之前** 创建 SDK 并调用 `install(app)`，将当前应用注册为该 URL 方案的默认处理程序；② 在需要登录时调用 `launchAuthorization()`，会打开系统浏览器，用户完成授权后通过重定向回到应用，Promise 返回 `{ token, user }`。  
-开发环境（如 `electron .`）须对 `install(app)` 传入第二、第三参数（见下方示例）；生产环境直接 `sdk.install(app)`。使用 electron-builder 打包时，若需在安装时注册 URL 方案，可在 `package.json` 的 `build.protocols` 中配置 `schemes`（与 SDK 的 `protocol` 一致）。
-
----
-
-### 完整示例：主进程入口 `main.js`
-
-单实例锁保证通过 URL 方案唤起时由已运行实例处理回调；渲染进程通过 IPC 发送 `start-oauth` 触发登录，主进程将结果通过 `oauth-success` / `oauth-error` 回传。
-
-```js
-const { app, BrowserWindow, ipcMain } = require('electron');
-const path = require('path');
-const YunTowerAccountElectronSDK = require('@yuntower/yuntower-account-electron-sdk').default;
-
-// 替换为你在后台配置的 appid、appsecret 及已加入白名单的 URL 方案与重定向地址
-const APP_ID = 'YOUR_APP_ID';
-const APP_SECRET = 'YOUR_APP_SECRET';
-const REDIRECT_URL = 'myapp://callback';
-const PROTOCOL = 'myapp';
-
-const sdk = new YunTowerAccountElectronSDK(APP_ID, APP_SECRET, {
-  redirectUrl: REDIRECT_URL,
-  protocol: PROTOCOL,
-  scope: 'user:profile,user:email',
-});
-
-// 必须在 app.ready 之前注册 URL 方案
-if (process.defaultApp && process.argv.length >= 2) {
-  sdk.install(app, process.execPath, [path.resolve(process.argv[1])]);
-} else {
-  sdk.install(app);
-}
-
-const gotTheLock = app.requestSingleInstanceLock();
-if (!gotTheLock) {
-  app.quit();
-  process.exit(0);
-}
-
-let mainWindow = null;
-
-app.whenReady().then(() => {
-  mainWindow = new BrowserWindow({
-    width: 800,
-    height: 600,
-    webPreferences: { nodeIntegration: true, contextIsolation: false },
-  });
-  mainWindow.loadFile('index.html');
-  mainWindow.on('closed', () => { mainWindow = null; });
-});
-
-app.on('window-all-closed', () => {
-  if (process.platform !== 'darwin') app.quit();
-});
-
-// 渲染进程点击「登录」时发送 'start-oauth'，此处发起授权并将结果回传
-ipcMain.on('start-oauth', async () => {
-  if (mainWindow) mainWindow.webContents.send('oauth-started');
-  try {
-    const { token, user } = await sdk.launchAuthorization({
-      scope: 'user:profile,user:email',
-      fetchUser: true,
-    });
-    if (mainWindow) mainWindow.webContents.send('oauth-success', { token, user });
-  } catch (err) {
-    if (mainWindow) mainWindow.webContents.send('oauth-error', { message: err.message });
-  }
-});
-```
-
-### 渲染进程示例：`index.html` 中触发登录并接收结果
-
-```html
-<button id="loginBtn">使用云塔账号登录</button>
-<pre id="result"></pre>
-<script>
-  const { ipcRenderer } = require('electron');
-  const btn = document.getElementById('loginBtn');
-  const result = document.getElementById('result');
-
-  btn.onclick = () => ipcRenderer.send('start-oauth');
-
-  ipcRenderer.on('oauth-started', () => {
-    result.textContent = '已打开浏览器，请在浏览器中完成授权…';
-  });
-  ipcRenderer.on('oauth-success', (event, { token, user }) => {
-    result.textContent = JSON.stringify({ token: { ...token, access_token: token.access_token?.slice(0, 20) + '…' }, user }, null, 2);
-  });
-  ipcRenderer.on('oauth-error', (event, err) => {
-    result.textContent = '授权失败: ' + (err.message || err);
-  });
-</script>
+# YunTowerAccount-ElectronSDK
+
+云塔账号通行证 Electron 桌面端 SDK，支持在桌面应用中拉起浏览器完成授权，并通过自定义 URL 方案回到应用、获取 token 与用户信息。
+
+- 官网：[https://account.yuntower.com](https://account.yuntower.com)
+- 文档：[https://docs.yuntower.com/account/open.html](https://docs.yuntower.com/account/open.html)
+- NPM：[https://www.npmjs.com/package/@yuntower/yuntower-account-electron-sdk](https://www.npmjs.com/package/@yuntower/yuntower-account-electron-sdk)
+
+```bash
+npm install @yuntower/yuntower-account-electron-sdk
+```
+
+依赖：`electron >= 20`（peerDependency）
+
+---
+
+## 快速开始
+
+接入前请在云塔账号通行证**应用详情页**为该应用配置并加入白名单的**重定向地址**（如 `myapp://callback`）。授权完成后浏览器会重定向到该地址；Electron 侧使用的**方案名**（`protocol`）与**重定向 URL**（`redirectUrl`）须与后台一致。下例中的 `myapp` 请替换为本应用已注册的方案名与地址。
+
+在主进程中：① 在 **app.ready 之前** 创建 SDK 并调用 `install(app)`，将当前应用注册为该 URL 方案的默认处理程序；② 在需要登录时调用 `launchAuthorization()`，会打开系统浏览器，用户完成授权后通过重定向回到应用，Promise 返回 `{ token, user }`。  
+开发环境（如 `electron .`）须对 `install(app)` 传入第二、第三参数（见下方示例）；生产环境直接 `sdk.install(app)`。使用 electron-builder 打包时，若需在安装时注册 URL 方案，可在 `package.json` 的 `build.protocols` 中配置 `schemes`（与 SDK 的 `protocol` 一致）。
+
+---
+
+### 完整示例：主进程入口 `main.js`
+
+单实例锁保证通过 URL 方案唤起时由已运行实例处理回调；渲染进程通过 IPC 发送 `start-oauth` 触发登录，主进程将结果通过 `oauth-success` / `oauth-error` 回传。
+
+```js
+const { app, BrowserWindow, ipcMain } = require('electron');
+const path = require('path');
+const YunTowerAccountElectronSDK = require('@yuntower/yuntower-account-electron-sdk').default;
+
+// 替换为你在后台配置的 appid、appsecret 及已加入白名单的 URL 方案与重定向地址
+const APP_ID = 'YOUR_APP_ID';
+const APP_SECRET = 'YOUR_APP_SECRET';
+const REDIRECT_URL = 'myapp://callback';
+const PROTOCOL = 'myapp';
+
+const sdk = new YunTowerAccountElectronSDK(APP_ID, APP_SECRET, {
+  redirectUrl: REDIRECT_URL,
+  protocol: PROTOCOL,
+  scope: 'user:profile,user:email',
+});
+
+// 必须在 app.ready 之前注册 URL 方案
+if (process.defaultApp && process.argv.length >= 2) {
+  sdk.install(app, process.execPath, [path.resolve(process.argv[1])]);
+} else {
+  sdk.install(app);
+}
+
+const gotTheLock = app.requestSingleInstanceLock();
+if (!gotTheLock) {
+  app.quit();
+  process.exit(0);
+}
+
+let mainWindow = null;
+
+app.whenReady().then(() => {
+  mainWindow = new BrowserWindow({
+    width: 800,
+    height: 600,
+    webPreferences: { nodeIntegration: true, contextIsolation: false },
+  });
+  mainWindow.loadFile('index.html');
+  mainWindow.on('closed', () => { mainWindow = null; });
+});
+
+app.on('window-all-closed', () => {
+  if (process.platform !== 'darwin') app.quit();
+});
+
+// 渲染进程点击「登录」时发送 'start-oauth'，此处发起授权并将结果回传
+ipcMain.on('start-oauth', async () => {
+  if (mainWindow) mainWindow.webContents.send('oauth-started');
+  try {
+    const { token, user } = await sdk.launchAuthorization({
+      scope: 'user:profile,user:email',
+      fetchUser: true,
+    });
+    if (mainWindow) mainWindow.webContents.send('oauth-success', { token, user });
+  } catch (err) {
+    if (mainWindow) mainWindow.webContents.send('oauth-error', { message: err.message });
+  }
+});
+```
+
+### 渲染进程示例：`index.html` 中触发登录并接收结果
+
+```html
+<button id="loginBtn">使用云塔账号登录</button>
+<pre id="result"></pre>
+<script>
+  const { ipcRenderer } = require('electron');
+  const btn = document.getElementById('loginBtn');
+  const result = document.getElementById('result');
+
+  btn.onclick = () => ipcRenderer.send('start-oauth');
+
+  ipcRenderer.on('oauth-started', () => {
+    result.textContent = '已打开浏览器，请在浏览器中完成授权…';
+  });
+  ipcRenderer.on('oauth-success', (event, { token, user }) => {
+    result.textContent = JSON.stringify({ token: { ...token, access_token: token.access_token?.slice(0, 20) + '…' }, user }, null, 2);
+  });
+  ipcRenderer.on('oauth-error', (event, err) => {
+    result.textContent = '授权失败: ' + (err.message || err);
+  });
+</script>
 ```

package/dist/index.d.ts

@@ -1,6 +1,19 @@
 /**
  * YunTower Account Electron SDK
  */
+export interface ApiResponseBody {
+    code?: number;
+    msg?: string;
+    data?: unknown;
+}
+export declare class YunTowerAccountSDKError extends Error {
+    readonly status: number;
+    readonly responseBody: ApiResponseBody | string | null;
+    readonly apiCode?: number;
+    readonly apiMsg?: string;
+    constructor(message: string, status: number, responseBody: ApiResponseBody | string | null);
+    static format(err: unknown): string;
+}
 declare const ALLOWED_SCOPES: readonly ["user:profile", "user:email", "connect:codemao_uid", "connect:pgaot_uid", "connect:dao3_uid"];
 export type AllowedScope = (typeof ALLOWED_SCOPES)[number];
 export interface ElectronSDKOptions {
@@ -90,7 +103,7 @@ export declare class YunTowerAccountElectronSDK {
     private _exchangeCodeForToken;
     /** 校验自定义 token 有效期不超过 12 天 / 24 天，否则抛错 */
     private _validateTokenExpiry;
-    /** 发起 JSON POST/GET 请求并返回解析后的 JSON */
+    /** 统一请求 */
     private _fetch;
     /**
      * 用授权码换取 access_token 与 refresh_token

package/dist/index.js

@@ -36,7 +36,68 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.YunTowerAccountElectronSDK = void 0;
+exports.YunTowerAccountElectronSDK = exports.YunTowerAccountSDKError = void 0;
+class YunTowerAccountSDKError extends Error {
+    constructor(message, status, responseBody) {
+        super(message);
+        this.name = "YunTowerAccountSDKError";
+        this.status = status;
+        this.responseBody = responseBody;
+        if (responseBody &&
+            typeof responseBody === "object" &&
+            "code" in responseBody) {
+            this.apiCode = responseBody.code;
+        }
+        if (responseBody &&
+            typeof responseBody === "object" &&
+            "msg" in responseBody) {
+            this.apiMsg = responseBody.msg;
+        }
+        Object.setPrototypeOf(this, YunTowerAccountSDKError.prototype);
+    }
+    static format(err) {
+        if (err instanceof YunTowerAccountSDKError) {
+            const parts = [
+                `[YunTowerAccountSDKError] ${err.message}`,
+                `HTTP Status: ${err.status}`,
+            ];
+            if (err.apiMsg != null)
+                parts.push(`API Msg: ${err.apiMsg}`);
+            if (err.apiCode != null)
+                parts.push(`API Code: ${err.apiCode}`);
+            if (err.responseBody != null) {
+                parts.push("Response: " +
+                    (typeof err.responseBody === "string"
+                        ? err.responseBody
+                        : JSON.stringify(err.responseBody, null, 2)));
+            }
+            return parts.join("\n");
+        }
+        if (err instanceof Error)
+            return err.message;
+        return String(err);
+    }
+}
+exports.YunTowerAccountSDKError = YunTowerAccountSDKError;
+function parseResponseBody(raw) {
+    if (!raw.trim())
+        return null;
+    try {
+        return JSON.parse(raw);
+    }
+    catch {
+        return raw;
+    }
+}
+function createApiError(status, rawBody) {
+    const responseBody = parseResponseBody(rawBody);
+    const msg = responseBody &&
+        typeof responseBody === "object" &&
+        responseBody.msg
+        ? responseBody.msg
+        : `HTTP error! Status: ${status}`;
+    return new YunTowerAccountSDKError(msg, status, responseBody);
+}
 const ACCESS_TOKEN_MAX_EXPIRE = 12 * 24 * 3600;
 const REFRESH_TOKEN_MAX_EXPIRE = 24 * 24 * 3600;
 const AVATAR_MAX_SIZE = 15 * 1024 * 1024;
@@ -220,10 +281,11 @@ class YunTowerAccountElectronSDK {
         const res = await this._fetch(`${this.config.api}/user/token/get`, "POST", body);
         const result = res;
         if (result.code !== 0) {
-            throw new Error(result.msg || "换取 token 失败");
+            throw new YunTowerAccountSDKError(result.msg ?? "换取 token 失败", 200, result);
+        }
+        if (!result.data) {
+            throw new YunTowerAccountSDKError("换取 token 失败", 200, result);
         }
-        if (!result.data)
-            throw new Error("换取 token 失败");
         return result.data;
     }
     /** 校验自定义 token 有效期不超过 12 天 / 24 天，否则抛错 */
@@ -235,7 +297,7 @@ class YunTowerAccountElectronSDK {
             throw new Error(`refresh_token 有效期不能超过 ${REFRESH_TOKEN_MAX_EXPIRE} 秒（24 天）`);
         }
     }
-    /** 发起 JSON POST/GET 请求并返回解析后的 JSON */
+    /** 统一请求 */
     async _fetch(url, method, data = {}, headers = {}) {
         const opt = {
             method,
@@ -244,9 +306,11 @@ class YunTowerAccountElectronSDK {
         if (method === "POST")
             opt.body = JSON.stringify(data);
         const response = await fetch(url, opt);
-        if (!response.ok)
-            throw new Error(`HTTP error! Status: ${response.status}`);
-        return response.json();
+        const rawBody = await response.text();
+        if (!response.ok) {
+            throw createApiError(response.status, rawBody);
+        }
+        return rawBody ? parseResponseBody(rawBody) : null;
     }
     /**
      * 用授权码换取 access_token 与 refresh_token
@@ -380,9 +444,11 @@ class YunTowerAccountElectronSDK {
             method: "POST",
             body: form,
         });
-        if (!response.ok)
-            throw new Error(`HTTP error! Status: ${response.status}`);
-        return response.json();
+        const rawBody = await response.text();
+        if (!response.ok) {
+            throw createApiError(response.status, rawBody);
+        }
+        return parseResponseBody(rawBody) ?? null;
     }
 }
 exports.YunTowerAccountElectronSDK = YunTowerAccountElectronSDK;

package/package.json

@@ -1,36 +1,36 @@
-{
-  "name": "@yuntower/yuntower-account-electron-sdk",
-  "description": "YunTower Account Electron SDK",
-  "version": "0.0.2",
-  "private": false,
-  "author": "yuntower",
-  "license": "Apache-2.0",
-  "main": "dist/index.js",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "require": "./dist/index.js",
-      "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "peerDependencies": {
-    "electron": ">=20.0.0"
-  },
-  "scripts": {
-    "build": "tsc",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "devDependencies": {
-    "@types/node": "^20.0.0",
-    "electron": "^28.0.0",
-    "typescript": "^5.9.3"
-  }
-}
+{
+  "name": "@yuntower/yuntower-account-electron-sdk",
+  "description": "YunTower Account Electron SDK",
+  "version": "0.0.3",
+  "private": false,
+  "author": "yuntower",
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "electron": ">=20.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "electron": "^28.0.0",
+    "typescript": "^5.9.3"
+  }
+}