qlfy-ecological-login 1.0.16 → 1.1.0

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 CHANGED
@@ -67,29 +67,30 @@ app.use(qlfyEcologicalLogin)
67
67
 
68
68
  #### 组件参数
69
69
 
70
- | 属性名 | 说明 | 类型 | 默认值 |
71
- | ----------------------- | ------------------------------------------------------------ | -------------------- | -------------- |
72
- | clientId | 应用id,统一认证平台提供,必填 | string | —— |
73
- | clientSecret | 应用秘钥,统一认证平台提供,必填 | string | —— |
74
- | loginPageBaseAddress | 登陆页面基础地址,必填 | string | —— |
75
- | loginServiceBaseAddress | 登录服务基础地址,必填 | string | —— |
76
- | useRouter | 路由对象,传入vue-Router的useRouter()值 | Router | —— |
77
- | loginMode | 登陆模式,局部模式组件销毁时,会销登陆数据 | 'part' \| 'global' | 'global' |
78
- | token | 自定义token<br />传入该值后,如果token有效,不跳登陆直接使用该token<br />兼容CA的token | stirng | ‘’ |
79
- | isEnabled | 是否启用组件,支持动态控制 | boolean | true |
80
- | listenToken | 实时监听token状态<br />1s检测一次token是否存在,丢失触发重新获取 | boolean | false |
81
- | redirectPath | 统一登陆成功后,跳转的地址;<br />如不设置,默认跳转至触发登陆的页面 | string | ‘’ |
82
- | tokenName | local中保存token值的键名称 | string | 'access_token' |
83
- | tokenValidity | token过期时间,单位秒<br />如该时间内无页面跳转操作则重新触发登陆 | number | 1800 |
84
- | tenantId | 租户id<br />非特殊要求不需传该参数 | number | ‘’ |
85
- | dialogConfig | 密码修改弹窗组件参数配置<br />内部支持属性参考element+ el-dialog组件 | Partial<DialogProps> | {} |
70
+ | 属性名 | 说明 | 类型 | 默认值 |
71
+ | ----------------------- | ------------------------------------------------------------ | ------------------ | -------------- |
72
+ | clientId | 应用id,统一认证平台提供,必填 | string | —— |
73
+ | clientSecret | 应用秘钥,统一认证平台提供,必填 | string | —— |
74
+ | loginPageBaseAddress | 登陆页面基础地址,必填 | string | —— |
75
+ | loginServiceBaseAddress | 登录服务基础地址,必填 | string | —— |
76
+ | useRouter | 路由对象,传入vue-Router的useRouter()值 | Router | —— |
77
+ | loginMode | 登陆模式<br />如果设置为part模式,未登陆状态不跳 | 'part' \| 'global' | 'global' |
78
+ | forceMode | 强制登陆模式 | boolean | true |
79
+ | token | 自定义token<br />传入该值后,如果token有效,不跳登陆直接使用该token<br />兼容CA的token<br /> | stirng | ‘’ |
80
+ | isEnabled | 是否启用组件,支持动态控制 | boolean | true |
81
+ | listenToken | 实时监听token状态<br />1s检测一次token是否存在,丢失触发重新获取 | boolean | false |
82
+ | redirectPath | 统一登陆成功后,跳转的地址;<br />如不设置,默认跳转至触发登陆的页面 | string | ‘’ |
83
+ | tokenName | local中保存token值的键名称 | string | 'access_token' |
84
+ | tokenValidity | token过期时间,单位秒<br />如该时间内无页面跳转操作则重新触发登陆 | number | 1800 |
85
+ | tenantId | 租户id<br />非特殊要求不需传该参数 | number | ‘’ |
86
86
 
87
87
  #### 组件事件
88
88
 
89
- | 事件名 | 说明 | 类型 |
90
- | ------------ | ------------------------------------------ | ------------------------------------------ |
91
- | loginSuccess | 初次加载,用户权限登陆获取成功后触发该事件 | Function:(userPermission:Object ) => void |
92
- | loggingIn | 从统一认证平台返回后触发该事件 | Function:( token:string) => void |
89
+ | 事件名 | 说明 | 类型 |
90
+ | ------------ | ------------------------------------------------------------ | ------------------------------------------ |
91
+ | loginSuccess | 初次加载,用户权限登陆获取成功后触发该事件 | Function:(userPermission:Object ) => void |
92
+ | loggingIn | 从统一认证平台返回后触发该事件 | Function:( token:string) => void |
93
+ | loginFail | token有效但用户信息获取失败时触发,part模式下未登录触发(无token、token失效) | Functon: (errInfo) =>void |
93
94
 
94
95
  #### 组件暴露内容
95
96
 
@@ -109,14 +110,11 @@ app.use(qlfyEcologicalLogin)
109
110
  import {xxx} from 'qlfy-ecological-login'
110
111
  ```
111
112
 
112
- | 方法名 | 说明 | 类型 |
113
- | ------------------------ | ------------------------------- | ---------------------------------------- |
114
- | qlfyEcologicalLogin | 统一登陆组件 | vue组件 |
115
- | qlfyEcologicalLoginProps | 统一登陆插件接口对象 | interface |
116
- | LocalStorageManager | LocalStorage工具类 | 类 |
117
- | logout | 退出登陆 | Function:()=>void |
118
- | getToken | 获取当前使用的token | Function:()=>string |
119
- | getUserPermission | 获取当前用户的权限信息 | Function:()=>Object |
120
- | openChangePassword | 打开密码修改弹窗 | Function:()=>void |
121
- | closeChangePassword | 关闭密码修改弹窗 | Function:()=>void |
122
- | setDialogConfig | 设置密码修改弹窗el-dialog的属性 | Function:(Partial<DialogProps>)=>void |
113
+ | 方法名 | 说明 | 类型 |
114
+ | ------------------------ | ---------------------- | -------------------- |
115
+ | qlfyEcologicalLogin | 统一登陆组件 | vue组件 |
116
+ | qlfyEcologicalLoginProps | 统一登陆插件接口对象 | interface |
117
+ | LocalStorageManager | LocalStorage工具类 | 类 |
118
+ | logout | 退出登陆 | Function:()=>void |
119
+ | getToken | 获取当前使用的token | Function:()=>string |
120
+ | getUserPermission | 获取当前用户的权限信息 | Function:()=>Object |
@@ -13,8 +13,8 @@ export interface Prop {
13
13
  loginServiceBaseAddress: string;
14
14
  /** 路由对象 */
15
15
  useRouter: any;
16
- /** 登陆模式 */
17
- loginMode?: 'part' | 'global';
16
+ /** 强制登陆模式 */
17
+ forceMode?: boolean;
18
18
  /** 传入token则使用外部token */
19
19
  token?: string;
20
20
  /** 是否启用组件,支持动态控制,非必填*/
@@ -1,4 +1,3 @@
1
- import { DialogProps } from 'element-plus';
2
1
  import { Prop } from './data';
3
2
  import { logout, getToken, getUserPermission } from './tools';
4
3
  declare const _default: import('vue').DefineComponent<Prop, {
@@ -18,8 +17,7 @@ declare const _default: import('vue').DefineComponent<Prop, {
18
17
  [x: string]: any;
19
18
  }) => any;
20
19
  }>, {
21
- dialogConfig: Partial<DialogProps>;
22
- loginMode: "part" | "global";
20
+ forceMode: boolean;
23
21
  isEnabled: boolean;
24
22
  listenToken: boolean;
25
23
  redirectPath: string;
@@ -1,11 +1,9 @@
1
- import { DialogProps } from 'element-plus';
2
- export declare const componentState: any;
3
1
  /** 退出登陆方法 */
4
- export declare function logout(goLog?: boolean, success?: () => void, error?: () => void): any;
2
+ export declare function logout(isGoLog?: boolean, success?: (res: any) => void, error?: (err: any) => void): void;
5
3
  /** 获取统一登陆token */
6
4
  export declare function getToken(): any;
7
5
  /** 获取统一登陆token */
8
- export declare function getRefreshToken(): any;
6
+ export declare function getRefreshToken(): string;
9
7
  /** 方法 -- 跳转至登陆页 */
10
8
  export declare function goLogin(): void;
11
9
  /**
@@ -18,17 +16,22 @@ export declare function goLogin(): void;
18
16
  */
19
17
  export declare function getLoginUrl(loginPageBaseAddress: string, clientId: string, clientSecret: string, redirectUrl?: string): string;
20
18
  export declare function generateUUID(): string;
21
- export declare function getComponentState(): void;
22
19
  export declare function getUserPermission(): any;
23
- /** ----------------------- 密码弹窗 ---------------------- */
24
- /** 密码修改弹窗控制 */
25
- export declare const dialogStatus: {
26
- isShow: boolean;
27
- elDialogConfig: {};
28
- };
29
- /** 方法 -- 显示密码弹窗 */
30
- export declare function openChangePassword(): void;
31
- /** 方法 -- 显示密码弹窗 */
32
- export declare function closeChangePassword(): void;
33
- /** 弹窗配置设置方法 */
34
- export declare function setDialogConfig(config: Partial<DialogProps>): void;
20
+ /** ----------------------- 登陆数据操作 ---------------------- */
21
+ interface LoginInfo {
22
+ tenantId: string | number;
23
+ refreshToken?: string;
24
+ userPermission: any;
25
+ props: any;
26
+ }
27
+ /** 登陆数据存储 */
28
+ export declare function setLoginInfo(dataInfo: LoginInfo): void;
29
+ /** 登陆数据删除 */
30
+ export declare function removeLoginInfo(): void;
31
+ /** 登陆数据数据 */
32
+ export declare function getLoginInfo(): LoginInfo;
33
+ /** 清除本组件所有缓存数据 */
34
+ export declare function clearLoginData(): void;
35
+ /** ----------------------- 密码修改 ---------------------- */
36
+ export declare function changePassword(newPassword: string, oldPassword: string): Promise<any>;
37
+ export {};
package/lib/index.d.ts CHANGED
@@ -16,8 +16,7 @@ export declare const qlfyEcologicalLogin: import('vue').DefineComponent<import('
16
16
  [x: string]: any;
17
17
  }) => any;
18
18
  }>, {
19
- dialogConfig: Partial<import('element-plus').DialogProps>;
20
- loginMode: "part" | "global";
19
+ forceMode: boolean;
21
20
  isEnabled: boolean;
22
21
  listenToken: boolean;
23
22
  redirectPath: string;
@@ -28,10 +27,6 @@ export declare const qlfyEcologicalLogin: import('vue').DefineComponent<import('
28
27
  export type { Prop as qlfyEcologicalLoginProps, Emits } from './components/qlfyEcologicalLogin/data';
29
28
  /** 导出工具 */
30
29
  export { logout, getToken, getRefreshToken, getUserPermission } from './components/qlfyEcologicalLogin/tools';
31
- /** 导出密码弹窗操作方法 */
32
- export { openChangePassword, closeChangePassword, setDialogConfig } from './components/qlfyEcologicalLogin/tools';
33
- /** localStorage */
34
- export * as LocalStorageManager from './components/qlfyEcologicalLogin/LocalStorageManager';
35
30
  /** 默认导出install注册方法 */
36
31
  declare const _default: {
37
32
  install(app: any): void;