qlfy-ecological-login 1.0.1 → 1.0.3

package/README.md

@@ -0,0 +1,123 @@
+#### 简介
+
+生态工程项目群统一认证登陆功能的逻辑插件，主体功能无实际渲染标签，内置统一登陆跳转、统一登录token获取、token效验、用户数据配置获取、密码修改登功能；
+
+仅可在全局范围内加载使用（app.vue），全局仅可使用一次，多次使用，仅初次加载处使用有效；
+
+#### 下载
+
+```
+npm i qlfy-ecological-login
+```
+
+#### 使用一、局部注册（推荐）
+
+例：app.vue
+
+```vue
+<template>
+  <div class="system-content" v-loading="loading" style="width: 100vw; height: 100vh">
+    <qlfyEcologicalLogin
+      client-id="xxxx"
+      client-secret="xxxx"
+      login-page-base-address="http://10.76.34.53:8200/auth"
+      login-service-base-address="http://10.76.34.53:48081"
+      :use-router="useRouter()"
+      @loggingIn="loggingIn"
+      @login-success="loginSuccess"
+      :token="$counterStore.token"
+    ></qlfyEcologicalLogin>
+  </div>
+</template>
+
+<script setup lang="ts">
+import { ref } from 'vue'
+import { qlfyEcologicalLogin } from 'qlfy-ecological-login'
+import { openChangePassword, closeChangePassword, setDialogConfig } from 'qlfy-ecological-login'
+import { useRoute, useRouter } from 'vue-router'
+import { useCounterStore } from '@/stores/counter'
+// pinia管理对象
+const $counterStore = useCounterStore()
+// 系统loading
+const loading = ref(true)
+// 登陆中
+function loggingIn() {
+  loading.value = true
+}
+// 登陆成功
+function loginSuccess() {
+  loading.value = false
+}
+</script>
+
+<style scoped></style>
+
+```
+
+#### 使用二、全局注册
+
+main.ts
+
+```ts
+// 导入
+import qlfyEcologicalLogin from 'qlfy-ecological-login'
+// 注册
+app.use(qlfyEcologicalLogin)
+```
+
+
+
+#### 组件参数
+
+| 属性名                  | 说明                                                         | 类型                 | 默认值         |
+| ----------------------- | ------------------------------------------------------------ | -------------------- | -------------- |
+| clientId                | 应用id，统一认证平台提供，必填                               | string               | ——             |
+| clientSecret            | 应用秘钥，统一认证平台提供，必填                             | string               | ——             |
+| loginPageBaseAddress    | 登陆页面基础地址，必填                                       | string               | ——             |
+| loginServiceBaseAddress | 登录服务基础地址，必填                                       | string               | ——             |
+| useRouter               | 路由对象，传入vue-Router的useRouter()值                      | Router               | ——             |
+| token                   | 自定义token<br />传入该值后，如果token有效，不跳登陆直接使用该token | stirng               | ‘’             |
+| isEnabled               | 是否启用组件，支持动态控制                                   | boolean              | true           |
+| listenToken             | 实时监听token状态<br />1s检测一次token是否存在，丢失触发重新获取 | boolean              | false          |
+| redirectPath            | 统一登陆成功后，跳转的地址；<br />如不设置，默认跳转至触发登陆的页面 | string               | ‘’             |
+| tokenName               | local中保存token值的键名称                                   | string               | 'access_token' |
+| tokenValidity           | token过期时间，单位秒<br />如该时间内无页面跳转操作则重新触发登陆 | number               | 1800           |
+| tenantId                | 租户id<br />非特殊要求不需传该参数                           | number               | ‘’             |
+| dialogConfig            | 密码修改弹窗组件参数配置<br />内部支持属性参考element+ el-dialog组件 | Partial<DialogProps> | {}             |
+
+#### 组件事件
+
+| 事件名       | 说明                                       | 类型                                       |
+| ------------ | ------------------------------------------ | ------------------------------------------ |
+| loginSuccess | 初次加载，用户权限登陆获取成功后触发该事件 | Function：(userPermission:Object ) => void |
+| loggingIn    | 从统一认证平台返回后触发该事件             | Function：( token:string) => void          |
+
+#### 组件暴露内容
+
+| 方法名            | 说明                   | 类型                 |
+| ----------------- | ---------------------- | -------------------- |
+| logout            | 退出登陆               | Function：()=>void   |
+| getToken          | 获取当前使用的token    | Function：()=>string |
+| getUserPermission | 获取当前用户的权限信息 | Function：()=>Object |
+
+#### 插件导出
+
+可在任意位置导入并使用该插件提供的工具方法、对象，实现相关操作功能
+
+导入方法 ：
+
+```
+import {xxx} from 'qlfy-ecological-login'
+```
+
+| 方法名                   | 说明                            | 类型                                     |
+| ------------------------ | ------------------------------- | ---------------------------------------- |
+| qlfyEcologicalLogin      | 统一登陆组件                    | vue组件                                  |
+| qlfyEcologicalLoginProps | 统一登陆插件接口对象            | interface                                |
+| LocalStorageManager      | LocalStorage工具类              | 类                                       |
+| logout                   | 退出登陆                        | Function：()=>void                       |
+| getToken                 | 获取当前使用的token             | Function：()=>string                     |
+| getUserPermission        | 获取当前用户的权限信息          | Function：()=>Object                     |
+| openChangePassword       | 打开密码修改弹窗                | Function：（）=>void                     |
+| closeChangePassword      | 关闭密码修改弹窗                | Function：（）=>void                     |
+| setDialogConfig          | 设置密码修改弹窗el-dialog的属性 | Function：（Partial<DialogProps>）=>void |

package/lib/components/qlfyEcologicalLogin/EditForm.vue.d.ts

@@ -0,0 +1,11 @@
+import { DialogProps } from 'element-plus';
+/** 组件参数管理对象 */
+type __VLS_Props = {
+    dialogConfig: Partial<DialogProps>;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    dialogConfig: Partial<DialogProps>;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    formRef: unknown;
+}, any>;
+export default _default;

package/lib/components/qlfyEcologicalLogin/data.d.ts

@@ -1,4 +1,5 @@
 import { Router } from 'vue-router';
+import { DialogProps } from 'element-plus';
 /** 响应式数据对象 */
 export declare class Data {
 }
@@ -13,41 +14,31 @@ export interface Prop {
     /** 应用秘钥，平台提供*/
     clientSecret: string;
     /** 统一登陆页面的ip地址 */
-    loginPageIpAddress: string;
+    loginPageBaseAddress: string;
     /** 登陆服务的ip地址 */
-    loginServiceIpAddress: string;
+    loginServiceBaseAddress: string;
     /** 路由对象 */
     useRouter: Router;
-    /** 统一认证的登录信息，如传入该值，则不触发登陆，直接使用传入的用户信息，非必填*/
-    loginInfo?: LoginInfo;
     /** 传入token则使用外部token */
     token?: string;
     /** 是否启用组件，支持动态控制，非必填*/
     isEnabled?: boolean;
-    /** 是否开启路由变动时自动刷新token功能*/
     /** 是否实时监听token状态，非必填*/
     listenToken?: boolean;
     /** 认证成功后的，非必填*/
     redirectPath?: string;
     /** local中保存token值的键名称，非必填*/
     tokenName?: string;
-    /** token自动更新的时间间隔，单位秒，非必填*/
-    refreshInterval?: number;
     /** token有效期，单位秒，非必填*/
     tokenValidity?: number;
     /** 租户id */
     tenantId?: number;
+    /** 修改密码弹窗自定义设置 */
+    dialogConfig?: Partial<DialogProps>;
 }
 export interface Emits {
-    (e: 'loggingIn', params: {
-        code: string | string[];
-        grant_type: string;
-        state: number;
-    }): void;
+    (e: 'loggingIn', token: string): void;
     (e: 'loginSuccess', loginInfo: {
         [x: string]: any;
     }): void;
-    (e: 'tokenChange', loginInfo: {
-        [x: string]: any;
-    }): void;
 }

package/lib/components/qlfyEcologicalLogin/index.vue.d.ts

@@ -1,40 +1,26 @@
+import { DialogProps } from 'element-plus';
 import { Prop } from './data';
-import { logout, getToken, getLoginInfo, getUserPermission } from './tools';
+import { logout, getToken, getUserPermission } from './tools';
 declare const _default: import('vue').DefineComponent<Prop, {
     logout: typeof logout;
     getToken: typeof getToken;
-    getLoginInfo: typeof getLoginInfo;
     getUserPermission: typeof getUserPermission;
 }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
-    loggingIn: (params: {
-        code: string | string[];
-        grant_type: string;
-        state: number;
-    }) => any;
+    loggingIn: (token: string) => any;
     loginSuccess: (loginInfo: {
         [x: string]: any;
     }) => any;
-    tokenChange: (loginInfo: {
-        [x: string]: any;
-    }) => any;
 }, string, import('vue').PublicProps, Readonly<Prop> & Readonly<{
-    onLoggingIn?: (params: {
-        code: string | string[];
-        grant_type: string;
-        state: number;
-    }) => any;
+    onLoggingIn?: (token: string) => any;
     onLoginSuccess?: (loginInfo: {
         [x: string]: any;
     }) => any;
-    onTokenChange?: (loginInfo: {
-        [x: string]: any;
-    }) => any;
 }>, {
+    dialogConfig: Partial<DialogProps>;
     isEnabled: boolean;
     listenToken: boolean;
     redirectPath: string;
     tokenName: string;
-    refreshInterval: number;
     tokenValidity: number;
     tenantId: number;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;

package/lib/components/qlfyEcologicalLogin/tools.d.ts

@@ -1,3 +1,4 @@
+import { DialogProps } from 'element-plus';
 export declare const componentState: any;
 /** 退出登陆方法 */
 export declare function logout(): any;
@@ -5,16 +6,26 @@ export declare function logout(): any;
 export declare function getToken(): any;
 /** 方法 -- 跳转至登陆页 */
 export declare function goLogin(): void;
-/** 获取统一认证登陆返回信息 */
-export declare function getLoginInfo(): any;
 /**
  * @description 获取跳转至登录页的链接
- * @param {string} loginPageIpAddress  登录页ip地址
+ * @param {string} loginPageBaseAddress  登录页ip地址
  * @param {string} clientId 应用id
  * @param {string} clientSecret 应用密钥
  * @param {string} redirectUrl 重定向地址
  * @returns {string}
  */
-export declare function getLoginUrl(loginPageIpAddress: string, clientId: string, clientSecret: string, tenantId: string, redirectUrl?: string): string;
+export declare function getLoginUrl(loginPageBaseAddress: string, clientId: string, clientSecret: string, tenantId: string, redirectUrl?: string): string;
 export declare function generateUUID(): string;
 export declare function getUserPermission(): any;
+/** ----------------------- 密码弹窗 ---------------------- */
+/** 密码修改弹窗控制 */
+export declare let dialogStatus: {
+    isShow: boolean;
+    elDialogConfig: {};
+};
+/** 方法 -- 显示密码弹窗 */
+export declare function openChangePassword(): void;
+/** 方法 -- 显示密码弹窗 */
+export declare function closeChangePassword(): void;
+/** 弹窗配置设置方法 */
+export declare function setDialogConfig(config: Partial<DialogProps>): void;

package/lib/index.d.ts

@@ -2,38 +2,23 @@
 export declare const qlfyEcologicalLogin: import('vue').DefineComponent<import('.').qlfyEcologicalLoginProps, {
     logout: typeof import('.').logout;
     getToken: typeof import('.').getToken;
-    getLoginInfo: typeof import('./components/qlfyEcologicalLogin/tools').getLoginInfo;
     getUserPermission: typeof import('.').getUserPermission;
 }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
-    loggingIn: (params: {
-        code: string | string[];
-        grant_type: string;
-        state: number;
-    }) => any;
+    loggingIn: (token: string) => any;
     loginSuccess: (loginInfo: {
         [x: string]: any;
     }) => any;
-    tokenChange: (loginInfo: {
-        [x: string]: any;
-    }) => any;
 }, string, import('vue').PublicProps, Readonly<import('.').qlfyEcologicalLoginProps> & Readonly<{
-    onLoggingIn?: (params: {
-        code: string | string[];
-        grant_type: string;
-        state: number;
-    }) => any;
+    onLoggingIn?: (token: string) => any;
     onLoginSuccess?: (loginInfo: {
         [x: string]: any;
     }) => any;
-    onTokenChange?: (loginInfo: {
-        [x: string]: any;
-    }) => any;
 }>, {
+    dialogConfig: Partial<import('element-plus').DialogProps>;
     isEnabled: boolean;
     listenToken: boolean;
     redirectPath: string;
     tokenName: string;
-    refreshInterval: number;
     tokenValidity: number;
     tenantId: number;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
@@ -41,6 +26,8 @@ export declare const qlfyEcologicalLogin: import('vue').DefineComponent<import('
 export type { Prop as qlfyEcologicalLoginProps, Emits } from './components/qlfyEcologicalLogin/data';
 /** 导出工具 */
 export { logout, getToken, getUserPermission } from './components/qlfyEcologicalLogin/tools';
+/** 导出密码弹窗操作方法 */
+export { openChangePassword, closeChangePassword, setDialogConfig } from './components/qlfyEcologicalLogin/tools';
 /** localStorage */
 export * as LocalStorageManager from './components/qlfyEcologicalLogin/LocalStorageManager';
 /** 默认导出install注册方法 */