lgsso-sdk 1.0.3 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -7
- package/package.json +1 -1
- package/src/index.d.ts +14 -3
package/README.md
CHANGED
|
@@ -6,12 +6,14 @@ LG SSO登录工具库,用于处理单点登录流程、token管理和系统间
|
|
|
6
6
|
npm install lgsso-sdk --save
|
|
7
7
|
# 或
|
|
8
8
|
yarn add lgsso-sdk
|
|
9
|
+
|
|
9
10
|
## 引入
|
|
10
11
|
// ES模块引入
|
|
11
12
|
import lgsso from 'lgsso-sdk';
|
|
12
13
|
|
|
13
14
|
// CommonJS引入
|
|
14
15
|
const lgsso = require('lgsso-sdk').default;
|
|
16
|
+
|
|
15
17
|
## 初始化
|
|
16
18
|
// 在应用入口处初始化
|
|
17
19
|
async function setupApp() {
|
|
@@ -40,6 +42,7 @@ async function setupApp() {
|
|
|
40
42
|
|
|
41
43
|
// 启动应用
|
|
42
44
|
setupApp();
|
|
45
|
+
|
|
43
46
|
## 核心方法
|
|
44
47
|
|
|
45
48
|
### 1. 获取当前token
|
|
@@ -49,6 +52,7 @@ if (token) {
|
|
|
49
52
|
} else {
|
|
50
53
|
console.log('未找到token');
|
|
51
54
|
}
|
|
55
|
+
|
|
52
56
|
### 2. 退出登录
|
|
53
57
|
async function handleLogout() {
|
|
54
58
|
const result = await lgsso.logout();
|
|
@@ -56,6 +60,7 @@ async function handleLogout() {
|
|
|
56
60
|
console.error('退出失败:', result.msg);
|
|
57
61
|
}
|
|
58
62
|
}
|
|
63
|
+
|
|
59
64
|
### 3. 跳转到其他系统
|
|
60
65
|
async function goToOtherSystem() {
|
|
61
66
|
const result = await lgsso.toUrl('https://other-system.com');
|
|
@@ -63,23 +68,37 @@ async function goToOtherSystem() {
|
|
|
63
68
|
console.error('跳转失败:', result.msg);
|
|
64
69
|
}
|
|
65
70
|
}
|
|
71
|
+
|
|
66
72
|
### 4. 手动删除token
|
|
67
73
|
// 仅删除本地token,不调用退出接口
|
|
68
74
|
lgsso.removeToken();
|
|
75
|
+
|
|
76
|
+
### 5. 获取accessCode(通过token换取)
|
|
77
|
+
// 用于需要手动处理accessCode的场景(如服务端交互)
|
|
78
|
+
async function fetchAccessCode() {
|
|
79
|
+
const result = await lgsso.getAccessCode();
|
|
80
|
+
if (result.code === 0) {
|
|
81
|
+
console.log('获取accessCode成功:', result.data);
|
|
82
|
+
// 可使用result.data进行后续操作(如拼接URL参数)
|
|
83
|
+
} else {
|
|
84
|
+
console.error('获取失败:', result.msg);
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
|
|
69
88
|
## 错误码说明
|
|
70
89
|
|
|
71
90
|
| 错误码 | 说明 |
|
|
72
91
|
|--------|------|
|
|
73
92
|
| 0 | 成功 |
|
|
74
|
-
| -100 |
|
|
75
|
-
| -101 |
|
|
93
|
+
| -100 | 初始化失败(如配置错误) |
|
|
94
|
+
| -101 | 未初始化(需先调用init) |
|
|
76
95
|
| -102 | 未配置logoutApi |
|
|
77
|
-
| -103 |
|
|
78
|
-
| -104 |
|
|
96
|
+
| -103 | 退出失败(接口请求错误) |
|
|
97
|
+
| -104 | 未提供跳转地址(toUrl方法缺少参数) |
|
|
79
98
|
| -105 | 未配置refreshCodeApi |
|
|
80
99
|
| -106 | 未找到有效token |
|
|
81
|
-
| -107 |
|
|
82
|
-
| -200 |
|
|
100
|
+
| -107 | 跳转失败(接口请求错误) |
|
|
101
|
+
| -200 | 非浏览器环境(调用了依赖window的方法) |
|
|
83
102
|
| -201 | 响应数据格式错误 |
|
|
84
103
|
| -202 | 请求超时 |
|
|
85
104
|
| -203 | 网络请求失败 |
|
|
@@ -96,4 +115,5 @@ npm run build
|
|
|
96
115
|
|
|
97
116
|
# 发布到npm(需先登录)
|
|
98
117
|
npm publish
|
|
99
|
-
|
|
118
|
+
|
|
119
|
+
构建后会在`dist`目录生成`lgsso-sdk.js`文件,可直接引入使用。
|
package/package.json
CHANGED
package/src/index.d.ts
CHANGED
|
@@ -1,3 +1,9 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* @Author: Robin LEI
|
|
3
|
+
* @Date: 2025-08-14 17:52:46
|
|
4
|
+
* @LastEditTime: 2025-08-19 08:55:22
|
|
5
|
+
* @FilePath: \lg-wms-admind:\业务代码\中联钢信\五服一管\complete-lgsso-sdk\src\index.d.ts
|
|
6
|
+
*/
|
|
1
7
|
/**
|
|
2
8
|
* lgsso-sdk 类型定义
|
|
3
9
|
*/
|
|
@@ -30,7 +36,7 @@ declare namespace LgSso {
|
|
|
30
36
|
msg: string;
|
|
31
37
|
/** 是否成功 */
|
|
32
38
|
success: boolean;
|
|
33
|
-
/**
|
|
39
|
+
/** 业务数据(如token、accessCode等) */
|
|
34
40
|
data?: any;
|
|
35
41
|
}
|
|
36
42
|
}
|
|
@@ -67,10 +73,15 @@ interface LgSsoInstance {
|
|
|
67
73
|
* @returns 接口返回结果
|
|
68
74
|
*/
|
|
69
75
|
toUrl: (redirectUrl: string) => Promise<LgSso.ApiResult>;
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* 获取accessCode(通过token换取)
|
|
79
|
+
* @returns 接口返回结果(data为accessCode)
|
|
80
|
+
*/
|
|
81
|
+
getAccessCode: () => Promise<LgSso.ApiResult>;
|
|
70
82
|
}
|
|
71
83
|
|
|
72
84
|
declare const lgsso: LgSsoInstance;
|
|
73
85
|
|
|
74
86
|
export default lgsso;
|
|
75
|
-
export { LgSso };
|
|
76
|
-
|
|
87
|
+
export { LgSso };
|