qlfy-ecological-login 1.0.0

package/README

@@ -0,0 +1,60 @@
+#### 简介
+
+实现统一认证登陆功能的逻辑插件，无实际渲染标签，内置统一登陆跳转、统一登录token获取、统一登陆token刷新等功能；
+
+当token在指定时间内无更新时，会自动刷新本地token数据；
+
+仅可在全局范围内加载使用（app.vue），全局仅可使用一次，多次使用，仅第一次使用有效；
+
+#### 组件参数
+
+| 属性名              | 说明                                                         | 类型                               | 默认值         |
+| ------------------- | ------------------------------------------------------------ | ---------------------------------- | -------------- |
+| clientId            | 应用id，统一认证平台提供，必填                               |                                    | ——             |
+| clientSecret        | 应用秘钥，统一认证平台提供，必填                             |                                    | ——             |
+| useRouter           | 路由对象，传入vue-Router的useRouter()值                      | Router                             | ——             |
+| loginInfo           | 统一认证的登录信息，如传入该值，则不触发登陆，直接使用传入的用户信息，非必填 | LoginInfo                          | ——             |
+| networkType         | 网络环境类型配置                                             | 'LAN'\|'INT'（内网环境\|外网环境） | 'LAN'          |
+| isEnabled           | 是否启用组件，支持动态控制                                   | boolean                            | true           |
+| listenToken         | 是否实时监听token状态<br />100ms检测一次token是否存在，丢失触发重新获取 | boolean                            | false          |
+| refreshTokenOnRoute | 是否开启路由变动时自动刷新token功能<br />开启后，每次路由变动延时2s自动刷新token | boolean                            | false          |
+| redirectPath        | 统一登陆成功后，跳转的地址；<br />如不设置，默认跳转至触发登陆的页面 | string                             | ‘’             |
+| tokenName           | local中保存token值的键名称                                   | string                             | 'access_token' |
+| refreshInterval     | token自动更新的时间间隔，单位秒                              | number                             | 600            |
+| tokenValidity       | token过期时间，单位秒                                        | number                             | 1800           |
+| getTokenUrl         | 获取token的请求地址<br />默认根据networkType自动获取<br />内网为：http://10.76.91.87:28080<br />外网为：http://10.76.44.44:28080 | string                             | ——             |
+| getCodeUrl          | 获取code的跳转地址<br />默认根据networkType自动获取<br />内网为：http://sd.uts.cma:18010<br />外网为：https://58.59.29.50:13019 | string                             | ——             |
+
+#### 组件事件
+
+| 事件名       | 说明                                        | 类型                                   |
+| ------------ | ------------------------------------------- | -------------------------------------- |
+| loginSuccess | 初次加载，登陆信息成功后触发该事件          | Function：( loginInfo:Object ) => void |
+| tokenChange  | token刷新时，触发该事件<br />首次登陆不触发 | Function：( loginInfo:Object ) => void |
+| loggingIn    | 从统一认证平台返回后触发该事件              | Function：( ) => void                  |
+
+#### 暴露内容
+
+| 方法名          | 说明                        | 类型                 |
+| --------------- | --------------------------- | -------------------- |
+| refreshToken    | 手动刷新登陆状态，更新token | Function：()=>void   |
+| logout          | 退出登陆                    | Function：()=>void   |
+| getUnifiedToken | 获取当前使用的token         | Function：()=>string |
+| getLoginInfo    | 获取当前登录信息            | Function：()=>Object |
+
+#### 组件工具库
+
+可在任意位置导入并使用该工具库内的方法，实现相关操作功能
+
+导入方法 ：
+
+```
+import {xxx} from '***/qlUnifiedLogin/tools.js'
+```
+
+| 方法名          | 说明                                           | 类型                 |
+| --------------- | ---------------------------------------------- | -------------------- |
+| logout          | 退出登陆                                       | Function：()=>void   |
+| getUnifiedToken | 获取当前使用的token                            | Function：()=>string |
+| getLoginInfo    | 获取当前登录信息                               | Function：()=>Object |
+| refreshToken    | 刷新token的方法，刷新成功后触发tokenChange事件 | Function：()=>void   |

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

@@ -0,0 +1,30 @@
+export default class LocalStorageManager {
+    /**
+     * 设置存储项
+     * @param {string} key - 存储键名
+     * @param {*} value - 存储值
+     * @param {number} [seconds] - 有效期（秒）
+     */
+    set(key: string, value: any, seconds?: number | undefined): void;
+    /**
+     * 获取存储项
+     * @param {string} key - 要获取的键名
+     * @returns {*|null} 存储值或null
+     */
+    get(key: string): any;
+    /**
+     * 获取原始存储数据（内部方法）
+     * @param {string} key - 要获取的键名
+     * @returns {Object|null} 包含值和过期时间的对象或null
+     */
+    getRaw(key: string): any;
+    /**
+     * 删除指定存储项
+     * @param {string} key - 要删除的键名
+     */
+    remove(key: string): void;
+    /**
+     * 清空所有存储项
+     */
+    clear(): void;
+}

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

@@ -0,0 +1,53 @@
+import { Router } from 'vue-router';
+/** 响应式数据对象 */
+export declare class Data {
+}
+export interface LoginInfo {
+    [x: string]: any;
+    access_token: string;
+    outLogin?: boolean;
+}
+export interface Prop {
+    /** 应用id，平台提供*/
+    clientId: string;
+    /** 应用秘钥，平台提供*/
+    clientSecret: string;
+    /** 统一登陆页面的ip地址 */
+    loginPageIpAddress: string;
+    /** 登陆服务的ip地址 */
+    loginServiceIpAddress: 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;
+}
+export interface Emits {
+    (e: 'loggingIn', params: {
+        code: string | string[];
+        grant_type: string;
+        state: number;
+    }): void;
+    (e: 'loginSuccess', loginInfo: {
+        [x: string]: any;
+    }): void;
+    (e: 'tokenChange', loginInfo: {
+        [x: string]: any;
+    }): void;
+}

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

@@ -0,0 +1,41 @@
+import { Prop } from './data';
+import { logout, getToken, getLoginInfo, 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;
+    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;
+    onLoginSuccess?: (loginInfo: {
+        [x: string]: any;
+    }) => any;
+    onTokenChange?: (loginInfo: {
+        [x: string]: any;
+    }) => any;
+}>, {
+    isEnabled: boolean;
+    listenToken: boolean;
+    redirectPath: string;
+    tokenName: string;
+    refreshInterval: number;
+    tokenValidity: number;
+    tenantId: number;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

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

@@ -0,0 +1,20 @@
+export declare const componentState: any;
+/** 退出登陆方法 */
+export declare function logout(): any;
+/** 获取统一登陆token */
+export declare function getToken(): any;
+/** 方法 -- 跳转至登陆页 */
+export declare function goLogin(): void;
+/** 获取统一认证登陆返回信息 */
+export declare function getLoginInfo(): any;
+/**
+ * @description 获取跳转至登录页的链接
+ * @param {string} loginPageIpAddress  登录页ip地址
+ * @param {string} clientId 应用id
+ * @param {string} clientSecret 应用密钥
+ * @param {string} redirectUrl 重定向地址
+ * @returns {string}
+ */
+export declare function getLoginUrl(loginPageIpAddress: string, clientId: string, clientSecret: string, redirectUrl?: string): string;
+export declare function generateUUID(): string;
+export declare function getUserPermission(): any;