lgsso-sdk 1.0.94 → 1.0.96

package/README.md

@@ -1,163 +1,306 @@
 # lg-ssosdk
 
-LG-SSO SDK 是一个用于实现单点登录(SSO)功能的JavaScript库，提供了token管理、登录状态维护、注销、跨应用跳转等功能，方便在Web应用中快速集成SSO认证机制。
+LG-SSO SDK 是一个无框架依赖的单点登录（SSO）JavaScript 库，提供 token 管理、登录状态维护、注销、跨应用跳转等功能，可帮助 Web 应用快速集成 SSO 认证机制。
 
 ## 安装
-# 使用 npm 安装
+
+
+
+```
+\# 使用 npm 安装
+
 npm install lg-ssosdk
 
-# 使用 yarn 安装
+\# 使用 yarn 安装
+
 yarn add lg-ssosdk
+```
+
 ## 引入方式
+
+
+
+```
 // 引入默认实例
+
 import lgsso from 'lg-ssosdk';
 
 // 或创建自定义实例
+
 import { createSSO } from 'lg-ssosdk';
+
 const customSSO = createSSO();
+```
+
 ## 初始化配置
 
-使用SDK前必须先调用`init`方法进行初始化配置：
+使用 SDK 前必须先调用 `init` 方法进行初始化配置：
+
+
+
+```
 lgsso.init({
-  accessCodeKey: 'accessCode',  // accessCode在URL中的参数名
-  tokenKey: 'scm_token',        // token在存储中的键名
-  timeout: 5000,                // 请求超时时间(毫秒)
+
+  accessCodeKey: 'accessCode',  // accessCode 在 URL 中的参数名
+
+  tokenKey: 'scm\_token',        // token 在存储中的键名
+
+  timeout: 5000,                // 请求超时时间（毫秒）
+
   headers: {},                  // 自定义请求头
-  tokenApi: '/api/token',       // 通过accessCode获取token的API地址
-  refreshCodeApi: '/api/refresh', // 刷新accessCode的API地址
-  logoutApi: '/api/logout',     // 注销API地址
-  logOutUrl: '/login',          // 登录页面URL
-  storage: localStorage,        // 存储方式(localStorage/sessionStorage)
+
+  tokenApi: '/api/token',       // 通过 accessCode 获取 token 的 API 地址（必填）
+
+  refreshCodeApi: '/api/refresh', // 刷新 accessCode 的 API 地址
+
+  logoutApi: '/api/logout',     // 注销 API 地址
+
+  logOutUrl: '/login',          // 登录页面 URL
+
+  storage: localStorage,        // 存储方式（localStorage/sessionStorage）
+
 })
+
 .then(result => {
+
   console.log('初始化结果:', result);
+
 });
+```
+
 ### 配置参数说明
 
-| 参数名 | 类型 | 默认值 | 说明 |
-|--------|------|--------|------|
-| accessCodeKey | String | 'accessCode' | accessCode在URL中的参数名 |
-| tokenKey | String | 'scm_token' | token在storage中的存储键名 |
-| timeout | Number | 5000 | 请求超时时间(ms) |
-| headers | Object | {} | 自定义请求头 |
-| tokenApi | String | '' | 通过accessCode获取token的API地址(必填) |
-| refreshCodeApi | String | '' | 刷新accessCode的API地址 |
-| logoutApi | String | '' | 注销API地址 |
-| logOutUrl | String | '' | 登录页面URL |
-| storage | Object | localStorage | 存储方式，需实现setItem和getItem方法 |
+
+
+| 参数名            | 类型     | 默认值          | 说明                                  |
+| -------------- | ------ | ------------ | ----------------------------------- |
+| accessCodeKey  | String | 'accessCode' | accessCode 在 URL 中的参数名              |
+| tokenKey       | String | 'scm\_token' | token 在 storage 中的存储键名              |
+| timeout        | Number | 5000         | 请求超时时间（ms）                          |
+| headers        | Object | {}           | 自定义请求头                              |
+| tokenApi       | String | ''           | 通过 accessCode 获取 token 的 API 地址（必填） |
+| refreshCodeApi | String | ''           | 刷新 accessCode 的 API 地址              |
+| logoutApi      | String | ''           | 注销 API 地址                           |
+| logOutUrl      | String | ''           | 登录页面 URL                            |
+| storage        | Object | localStorage | 存储方式，需实现 setItem 和 getItem 方法       |
 
 ## 核心方法
 
 ### init(options)
 
-初始化SDK，合并配置并验证有效性。如果URL中存在accessCode，会自动获取token；如果没有token，会跳转到登录页。
+初始化 SDK，合并配置并验证有效性。如果 URL 中存在 accessCode，会自动获取 token；如果没有 token，会跳转到登录页。
 
 **参数**：
-- `options`：配置选项，详见初始化配置部分
+
+
+
+*   `options`：配置选项，详见初始化配置部分
 
 **返回**：`Promise<Object>` - 初始化结果
 
 ### getToken()
 
-获取存储的token值。
+获取存储的 token 值。
 
-**返回**：`String|null` - token值或null
+**返回**：`String|null` - token 值或 null
+
+
+
+```
 const token = lgsso.getToken();
+
 console.log('当前token:', token);
+```
+
 ### removeToken()
 
-删除存储的token。
+删除存储的 token。
+
+
+
+```
 lgsso.removeToken();
+```
+
 ### logout()
 
-退出登录，调用logoutApi并清除token，然后跳转到登录页。
+退出登录，调用 logoutApi 并清除 token，然后跳转到登录页。
 
 **返回**：`Promise<Object>` - 退出结果
+
+
+
+```
 lgsso.logout()
+
 .then(result => {
+
   console.log('退出结果:', result);
+
 });
-### toUrl(redirectUrl)
+```
+
+### toUrl(redirectUrl, target)
 
-使用当前token换取新的accessCode，并跳转到指定URL（自动在URL后添加accessCode参数）。
+使用当前 token 换取新的 accessCode，并跳转到指定 URL（自动在 URL 后添加 accessCode 参数）。
 
 **参数**：
-- `redirectUrl`：目标跳转地址
+
+
+
+*   `redirectUrl`：目标跳转地址
+
+*   `target`：跳转方式，支持 `'_self'`（当前页面，默认）和 `'_blank'`（新页面）
 
 **返回**：`Promise<Object>` - 操作结果
-lgsso.toUrl('https://example.com/target')
+
+
+
+```
+// 在当前页面打开（默认）
+
+lgsso.toUrl('https://example.com/target', '\_self')
+
 .then(result => {
+
   console.log('跳转准备结果:', result);
+
 });
+
+// 在新页面打开
+
+lgsso.toUrl('https://example.com/target', '\_blank');
+```
+
 ### getAccessCode()
 
-使用当前token换取新的accessCode。
+使用当前 token 换取新的 accessCode。
+
+**返回**：`Promise<Object>` - 包含 accessCode 的结果（在 data 字段中）
 
-**返回**：`Promise<Object>` - 包含accessCode的结果（在data字段中）
+
+
+```
 lgsso.getAccessCode()
+
 .then(result => {
+
   if (result.code === 0) {
+
     console.log('新的accessCode:', result.data);
+
   }
-});
-### getConfig()
 
-获取当前配置的副本。
+});
+```
 
-**返回**：`Object|null` - 当前配置
-const config = lgsso.getConfig();
-console.log('当前配置:', config);
 ## 错误码说明
 
-| 错误码 | 说明 |
-|--------|------|
-| -100 | 初始化相关错误（如缺少配置、配置无效等） |
-| -101 | 未初始化（需先调用init方法） |
-| -102 | 未配置logoutApi |
-| -103 | 退出登录失败 |
-| -104 | 跳转地址为空 |
-| -105 | 未配置refreshCodeApi |
-| -106 | 未找到有效token |
-| -107 | 跳转失败 |
-| -200 | 非浏览器环境使用request方法 |
-| -201 | 响应数据不是有效的JSON格式 |
-| -202 | 请求超时 |
-| -203 | 网络请求失败 |
+
+
+| 错误码  | 说明                                    |
+| ---- | ------------------------------------- |
+| -100 | 初始化相关错误（如缺少配置、配置无效等）                  |
+| -101 | 未初始化（需先调用 init 方法）                    |
+| -102 | 未配置 logoutApi                         |
+| -103 | 退出登录失败                                |
+| -104 | 跳转地址为空                                |
+| -105 | 未配置 refreshCodeApi                    |
+| -106 | 未找到有效 token                           |
+| -107 | 跳转失败                                  |
+| -108 | target 参数无效（必须是 '\_self' 或 '\_blank'） |
+| -200 | 非浏览器环境使用 request 方法                   |
+| -201 | 响应数据不是有效的 JSON 格式                     |
+| -202 | 请求超时                                  |
+| -203 | 网络请求失败                                |
 
 ## 使用示例
+
+
+
+```
 // 初始化SDK
+
 lgsso.init({
+
   tokenApi: '/api/getToken',
+
   refreshCodeApi: '/api/refreshCode',
+
   logoutApi: '/api/logout',
+
   logOutUrl: '/login'
+
 })
+
 .then(initResult => {
+
   console.log('初始化结果:', initResult);
+
   
+
   // 获取token
+
   const token = lgsso.getToken();
+
   console.log('当前token:', token);
+
+  
+
+  // 跳转到其他应用（当前页面）
+
+  document.getElementById('gotoCurrent').addEventListener('click', () => {
+
+    lgsso.toUrl('https://other-app.example.com', '\_self')
+
+      .catch(err => console.error('跳转失败:', err));
+
+  });
+
   
-  // 跳转到其他应用
-  document.getElementById('gotoOtherApp').addEventListener('click', () => {
-    lgsso.toUrl('https://other-app.example.com')
+
+  // 跳转到其他应用（新页面）
+
+  document.getElementById('gotoNew').addEventListener('click', () => {
+
+    lgsso.toUrl('https://other-app.example.com', '\_blank')
+
       .catch(err => console.error('跳转失败:', err));
+
   });
+
   
+
   // 退出登录
+
   document.getElementById('logoutBtn').addEventListener('click', () => {
+
     lgsso.logout()
+
       .catch(err => console.error('退出失败:', err));
+
   });
+
 })
+
 .catch(err => {
+
   console.error('初始化失败:', err);
+
 });
+```
+
 ## 注意事项
 
-1. 必须先调用`init`方法初始化后才能使用其他方法
-2. `tokenApi`是必填配置项，用于通过accessCode获取token
-3. 在非浏览器环境下使用时，部分依赖浏览器API的功能将不可用
-4. 建议在应用入口处进行初始化，确保整个应用生命周期中都能使用SSO功能
-    
+
+
+1.  必须先调用 `init` 方法初始化后才能使用其他方法
+
+2.  `tokenApi` 是必填配置项，用于通过 accessCode 获取 token
+
+3.  在非浏览器环境下使用时，部分依赖浏览器 API 的功能将不可用
+
+4.  建议在应用入口处进行初始化，确保整个应用生命周期中都能使用 SSO 功能
+
+5.  使用 `toUrl` 方法时，`target` 参数仅支持 `'_self'` 和 `'_blank'` 两个值，默认使用 `'_self'`
+

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lgsso-sdk",
-    "version": "1.0.94",
+    "version": "1.0.96",
     "type": "module",
     "description": "无框架依赖的单点登录SDK",
     "main": "dist/lgsso-sdk.cjs",

package/src/sso.js

@@ -150,9 +150,10 @@ export function createSSO() {
         /**
          * 用token换取新accessCode并跳转到指定URL
          * @param {string} redirectUrl - 目标跳转地址
+         * @param {string} target - 当前页面：_self、新页面打开：_blank，默认当前页_self
          * @returns {Promise<Object>} 接口返回结果
          */
-        async toUrl(redirectUrl) {
+        async toUrl(redirectUrl, target = '_self') {  // 新增target参数，默认当前页面
             if (!config) {
                 return { code: -101, msg: '请先调用init方法初始化', success: false };
             }
@@ -161,6 +162,11 @@ export function createSSO() {
                 return { code: -104, msg: '请提供跳转地址', success: false };
             }
 
+            // 验证target参数有效性
+            if (!['_self', '_blank'].includes(target)) {
+                return { code: -108, msg: 'target参数必须是"_self"或"_blank"', success: false };
+            }
+
             if (!config.refreshCodeApi) {
                 return { code: -105, msg: '未配置refreshCodeApi', success: false };
             }
@@ -168,8 +174,14 @@ export function createSSO() {
             const token = this.getToken();
             if (!token) {
                 if (isBrowser() && config.logOutUrl) {
-                    // 修改：使用参数传入的redirectUrl作为重定向地址
-                    window.location.href = `${config.logOutUrl}?redirect_uri=${encodeURIComponent(redirectUrl)}`;
+                    const loginUrl = `${config.logOutUrl}?redirect_uri=${encodeURIComponent(redirectUrl)}`;
+
+                    // 根据target决定打开方式
+                    if (target === '_blank') {
+                        window.open(loginUrl, '_blank');
+                    } else {
+                        window.location.href = loginUrl;
+                    }
                 }
                 return { code: -106, msg: '未找到有效token', success: false };
             }
@@ -187,7 +199,14 @@ export function createSSO() {
                 if (result.code === 0 && result.data && isBrowser()) {
                     const url = new URL(redirectUrl);
                     url.searchParams.set(config.accessCodeKey, result.data);
-                    window.location.href = url.toString();
+                    const targetUrl = url.toString();
+
+                    // 根据target参数决定跳转方式
+                    if (target === '_blank') {
+                        window.open(targetUrl, '_blank');
+                    } else {
+                        window.location.href = targetUrl;
+                    }
                 }
 
                 return result;
@@ -195,7 +214,6 @@ export function createSSO() {
                 return { code: -107, msg: `跳转失败: ${error.message}`, success: false };
             }
         },
-
         /**
          * 获取accessCode（通过token换取）
          * @returns {Promise<Object>} 接口返回结果（data为accessCode）