login-authorization-v2 1.1.5 → 2.0.0-beta.10

package/README.md

@@ -1,55 +1,53 @@
-# login-authorization
-
-> 登录验证
-## 安装依赖
-
-``` bash
-# install dependencies
-npm install login-authorization --save
-# or with yarn
-yarn add login-authorization
-```
-## 方法使用说明
-### 初始化：init(requestUrl, loginUrl, systemName) 此方法必须在入口文件中调用
-```bash
-import { init } from 'login-authorization';
-
-init('http://127.0.0.1','http://127.0.0.1/#/login?systemName=Finance', 'Finance').then(res => {
-  if (res) {
-    // true 已登录
-  } else {
-    // false 未登录
-  }
-})
-
-注意：systemName必须和Cognito中配置的系统组名保持一致。
-
-```
-<font color=#ff0000 size=24>注意：凡是涉及到统一登录系统的loginUrl后面必须将你的系统名称带上,且参数名称为systemName，如果未涉及则不用。</font>
-### 登录成功时需要设置idToken和refreshToken初始值
-setIdToken(value)
-setRefreshToken(value)
-### 获取idToken：getIdToken()
-```bash
-import { getIdToken } from 'login-authorization';
-
-let idToken = getIdToken(); // 'xxxxxx'，如果未登录则为null
-```
-### 获取用户信息：getUserInfo()
-```bash
-import { getUserInfo } from 'login-authorization';
-
-let userInfo = getUserInfo(); //{email: 'xxx', name: 'xxx',...}，如果未登录则为null
-```
-### 登出：logout()
-```bash
-import { logout } from 'login-authorization';
-
-logout().then(res => {
-  if (res) {
-    // true 登出成功,会自动跳转到登录页面
-  } else {
-    // false 登出失败
-  }
-})
-```
+# login-authorization-v2
+
+## 安装
+```bash
+#npm
+npm install login-authorization-v2
+
+#yarn
+yarn add login-authorization-v2
+```
+
+## 使用文档
+### 基本使用
+```javascript
+import { make } from 'login-authorization-v2'
+
+const { init, logout } = make({
+  moduleName: 'Portal', // 当前模块名称
+  moduleBaseUrl: 'https://servers-api.gztest.net:8107', // 后端的 module_base 服务地址
+  loginPageUrl: 'http://huangcheng.ddmarketinghub.com:8080', // 如果未登录，跳转的登录页地址
+})
+
+init({ brand: 1, tenantId: 1 }).then(menus => {
+  // menus 即为当前用户的菜单权限数据
+}).catch(err => {
+  // 任何不能正常登陆的情况都会进入这里
+})
+
+logout().then(() => {
+  // 退出登陆成功
+}).catch(() => {
+  // 可以不用管
+})
+```
+> tenantId、brand、moduleName 枚举值可以在 login-authorization-v2 包内的 `./dist/src/types.d.ts` 文件中查看
+
+### 新增方法
+#### main
+1. make(options: MakeFnParams): { init, logout }
+2. init(params: InitParams): Promise<MenuItem[]>
+3. logout(): Promise<void>
+
+#### cookie 相关方法
+1. setAccessToken(string | null): void
+2. getAccessToken(): string | undefined
+3. setRefreshToken(string | null): void
+4. getRefreshToken(): string | undefined
+5. setSystemType(string | null): void
+6. getSystemType(): string | undefined
+
+#### 工具函数
+1. isMobile(): boolean // 判断当前环境是否为移动端
+2. getUserInfo(): Promise<UserInfo | null> // 获取当前用户信息

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+export * from './src/cookie';
+export * from './src/compatible';
+export * from './src/utils';
+import { Brand, type ModuleName, Tenant } from './src/types';
+type MakeFnParams = {
+    moduleName: ModuleName;
+    moduleBaseUrl: string;
+    loginPageUrl: string;
+};
+type InitFnParams = {
+    brand?: Brand;
+    tenantId: Tenant;
+};
+export declare const make: (config: MakeFnParams) => {
+    init: (initConfig: InitFnParams) => Promise<{
+        groupName: ModuleName;
+        icon: string;
+        id: number;
+        label: string;
+        staffEndpoint: boolean;
+        url: string;
+    }[]>;
+    logout: () => Promise<import("axios").AxiosResponse<any, any>>;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,kBAAkB,CAAA;AAChC,cAAc,aAAa,CAAA;AAO3B,OAAO,EAAE,KAAK,EAAE,KAAK,UAAU,EAAc,MAAM,EAAiB,MAAM,aAAa,CAAA;AAGvF,KAAK,YAAY,GAAG;IAClB,UAAU,EAAE,UAAU,CAAA;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,KAAK,YAAY,GAAG;IAClB,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,eAAO,MAAM,IAAI,GAAI,QAAQ,YAAY;uBAUb,YAAY;;;;;;;;;CAmIvC,CAAA"}

package/dist/index.esm.js

@@ -0,0 +1,406 @@
+import Cookie from 'js-cookie';
+import { Base64 } from 'js-base64';
+import axios from 'axios';
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
+
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+const NO_ACCESS_TOKEN = 'Access token not found';
+const INVALID_ACCESS_TOKEN = 'Invalid access token';
+const INVALID_REFRESH_TOKEN = 'Invalid refresh token';
+const NO_REFRESH_TOKEN = 'Refresh token not found';
+const NO_MODULE_BASE_URL = 'Module base URL is required';
+const INVALID_TENANT_ID = 'Invalid tenant ID';
+const INVALID_BRAND = 'Invalid brand';
+
+const makeSetCookieFn = (key, options) => {
+    const index = window.location.hostname.indexOf('.');
+    const domain = index === -1
+        ? window.location.hostname
+        : window.location.hostname.slice(index);
+    return (value) => {
+        if (value === null) {
+            return Cookie.remove(key, Object.assign({ domain }, options));
+        }
+        Cookie.set(key, value, Object.assign({ domain, expires: 30 }, options));
+    };
+};
+const setIdTokenFront = makeSetCookieFn('idTokenFront');
+const setIdTokenBack = makeSetCookieFn('idTokenBack');
+const setRefreshTokenFront = makeSetCookieFn('refreshTokenFront');
+const setRefreshTokenBack = makeSetCookieFn('refreshTokenBack');
+const setRefreshToken = (token) => {
+    if (!token) {
+        setIdTokenBack(null);
+        setIdTokenFront(null);
+        makeSetCookieFn('refresh_token')(null);
+        return;
+    }
+    const splits = token.split('.');
+    if (splits.length < 5)
+        throw new Error(INVALID_REFRESH_TOKEN);
+    const refreshTokenFront = splits[0] + '.' + splits[1];
+    const refreshTokenBack = splits[2] + '.' + splits[3] + '.' + splits[4];
+    setRefreshTokenFront(refreshTokenFront);
+    setRefreshTokenBack(refreshTokenBack);
+    makeSetCookieFn('refresh_token')(token);
+};
+const setAccessToken = (token) => {
+    if (!token) {
+        setIdTokenBack(null);
+        setIdTokenFront(null);
+        makeSetCookieFn('access_token')(null);
+        return;
+    }
+    const splits = token.split('.');
+    if (splits.length < 3)
+        throw new Error(INVALID_ACCESS_TOKEN);
+    const idTokenFront = splits[0] + '.' + splits[1];
+    const idTokenBack = splits[2] || '';
+    setIdTokenFront(idTokenFront);
+    setIdTokenBack(idTokenBack);
+    makeSetCookieFn('access_token')(token);
+};
+const getAccessToken = () => Cookie.get('access_token');
+const getRefreshToken = () => Cookie.get('refresh_token');
+const setSystemType = makeSetCookieFn('currentSystemType');
+const getSystemType = () => Cookie.get('currentSystemType');
+
+/**
+ *  这个文件是写一些兼容的方法，避免各个项目做出大量调整
+ */
+const setIdToken = setAccessToken;
+const getIdToken = getAccessToken;
+const setCookie = (name, value, domain, path = '/', time = 30 * 24 * 60 * 60 * 1000) => {
+    if (value === null || value === undefined) {
+        return Cookie.remove(name);
+    }
+    Cookie.set(name, value, {
+        domain,
+        path,
+        expires: time / (24 * 60 * 60 * 1000)
+    });
+};
+const clearLoginCookie = () => {
+    setAccessToken(null);
+    setRefreshToken(null);
+};
+const getCookie = (c_name) => {
+    if (!c_name)
+        return null;
+    const reg = new RegExp('(?:^|; )' + encodeURIComponent(c_name) + '=([^;]*)');
+    const result = reg.exec(document.cookie);
+    return result ? decodeURIComponent(result[1] || '') : null;
+};
+const getUrlParam = (key, href) => {
+    const search = '?' + ((href || window.location.href).split('?')[1] || '');
+    const searchParams = new URLSearchParams(search);
+    return searchParams.get(key);
+};
+
+const isMobile = () => {
+    const ua = navigator.userAgent;
+    return /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(ua);
+};
+const getUserInfo = () => {
+    return new Promise((resolve, reject) => {
+        const token = getAccessToken();
+        if (!token)
+            return reject(new Error(NO_ACCESS_TOKEN));
+        const splits = token.split('.');
+        if (splits.length < 3)
+            return reject(new Error(NO_ACCESS_TOKEN));
+        resolve(JSON.parse(Base64.decode(splits[1])));
+    });
+};
+
+var Brand;
+(function (Brand) {
+    Brand[Brand["ZERO"] = 1] = "ZERO";
+    Brand[Brand["HEDGEHOOD"] = 2] = "HEDGEHOOD";
+    Brand[Brand["NISE"] = 3] = "NISE";
+})(Brand || (Brand = {}));
+var Tenant;
+(function (Tenant) {
+    Tenant[Tenant["ZERO_INT"] = 1] = "ZERO_INT";
+    Tenant[Tenant["HEDGEHOOD"] = 2] = "HEDGEHOOD";
+    Tenant[Tenant["ZERO_NZ"] = 3] = "ZERO_NZ";
+    Tenant[Tenant["ZERO_LA"] = 4] = "ZERO_LA";
+    Tenant[Tenant["ZERO_BR"] = 4] = "ZERO_BR";
+    Tenant[Tenant["NISE_EU"] = 5] = "NISE_EU";
+})(Tenant || (Tenant = {}));
+var SystemType;
+(function (SystemType) {
+    SystemType["Staff"] = "staff";
+    SystemType["Client"] = "client";
+})(SystemType || (SystemType = {}));
+
+let tenantId;
+let brand;
+let moduleBaseUrl = '';
+let loginPageUrl = '';
+const setTenantId = (id) => {
+    if (!Object.values(Tenant).includes(id)) {
+        throw new Error(INVALID_TENANT_ID);
+    }
+    tenantId = id;
+};
+const setBrand = (id) => {
+    if (!Object.values(Brand).includes(id)) {
+        throw new Error(INVALID_BRAND);
+    }
+    brand = id;
+};
+const setModuleBaseUrl = (url) => {
+    moduleBaseUrl = url;
+};
+const setLoginPageUrl = (url) => {
+    loginPageUrl = url;
+};
+
+const createPcDialog = () => {
+    return `<div id="confirm-container" style="box-sizing:border-box;position:fixed;width:615px;height:145px;box-shadow: 0 0 2px 2px #eeeeee;border-radius: 5px;z-index: 10000000;display: block;left: 35%;padding:20px 20px;top:10px;font-size: 16px;">
+    <div id="href" style="color: rgb(32,33,36);"></div>
+    <div style="margin: 10px 0 20px 0;color: rgb(32,33,36);font-size: 14px;">You do not have access to the system.</div>
+    <div style="display: flex;justify-content: flex-end;">
+      <button id="cancel" style="padding: 8px 15px;background: #ffffff;color:rgb(26,115,232);border:1px solid #ccc;border-radius:5px;cursor: pointer;font-size:14px;">Cancel</button>
+      <button id="confirm" style="padding: 8px 15px;background: rgb(26,115,232);color:#ffffff;border:none;border-radius:5px;margin-left: 10px;cursor: pointer;font-size:14px;">Sign in to another ZERO account</button>
+    </div>
+  </div>`;
+};
+const createMobileDialog = () => {
+    return `<div id="confirm-container" style="box-sizing:border-box;position:fixed;width:97.6vw;height:145px;box-shadow: 0 0 2px 2px #eeeeee;border-radius: 5px;z-index: 10000000;display: block;left:0px;padding:20px 20px;top:4px;margin:0 4px;font-size: 16px;">
+    <div id="href" style="color: rgb(32,33,36);"></div>
+    <div style="margin: 10px 0 20px 0;color: rgb(32,33,36);font-size: 14px;">You do not have access to the system.</div>
+    <div style="display: flex;justify-content: flex-end;">
+    <div style="display: flex;justify-content: flex-end;">
+      <button id="cancel" style="padding: 8px 15px;background: #ffffff;color:rgb(26,115,232);border:1px solid #ccc;border-radius:5px;cursor: pointer;font-size:14px;">Cancel</button>
+      <button id="confirm" style="padding: 8px 15px;background: rgb(26,115,232);color:#ffffff;border:none;border-radius:5px;margin-left: 10px;cursor: pointer;font-size:14px;">Sign in to another ZERO account</button>
+    </div>
+    </div>
+  </div>`;
+};
+const onConfirmHandler = (evt) => {
+    closeDialog();
+    window.location.href = loginPageUrl;
+};
+const onCancelHandler = () => {
+    closeDialog();
+    window.location.href = 'about:blank';
+};
+const closeDialog = () => {
+    const container = document.getElementById('confirm-container');
+    if (!container || !container.parentNode)
+        return;
+    document.body.removeChild(container.parentNode);
+};
+const openDialog = () => {
+    const container = document.createElement('div');
+    isMobile()
+        ? container.innerHTML = createMobileDialog()
+        : container.innerHTML = createPcDialog();
+    const confirmButton = container.querySelector('#confirm');
+    const cancelButton = container.querySelector('#cancel');
+    confirmButton === null || confirmButton === void 0 ? void 0 : confirmButton.addEventListener('click', onConfirmHandler);
+    cancelButton === null || cancelButton === void 0 ? void 0 : cancelButton.addEventListener('click', onCancelHandler);
+    document.body.appendChild(container);
+};
+
+let instance;
+/**
+ *  没找到更好的方式，只能这样做了
+ */
+const initInstance = () => __awaiter(void 0, void 0, void 0, function* () {
+    let userInfo = null;
+    try {
+        userInfo = yield getUserInfo();
+    }
+    catch (error) {
+        console.warn('initInstance getUserInfo error:', error);
+    }
+    instance = axios.create({
+        baseURL: moduleBaseUrl,
+        timeout: 1.5e4,
+    });
+    instance.interceptors.request.use((config) => {
+        config.headers = Object.assign(Object.assign({}, config.headers), { 'X-tenant-id': userInfo ? userInfo['custom:tenant_id'].toString() : tenantId.toString(), 'X-brand': brand.toString(), 'Authorization': `Bearer ${getAccessToken()}` });
+        return config;
+    }, (error) => {
+        return Promise.reject(error);
+    });
+    instance.interceptors.response.use((response) => {
+        if (response.data.code !== 200) {
+            return Promise.reject(response.data.msg);
+        }
+        return response;
+    }, (error) => {
+        return Promise.reject(error);
+    });
+});
+const fetchRefreshTokenHTTP = (refreshToken) => {
+    return instance({
+        method: 'post',
+        url: '/user-profile/refresh-token/refresh',
+        data: {
+            refreshToken
+        }
+    });
+};
+const fetchLogoutHTTP = () => {
+    return instance({
+        method: 'get',
+        url: '/user-profile/logout'
+    });
+};
+const fetchServerListHTTP = () => {
+    return instance({
+        method: 'get',
+        url: '/session/current/servers'
+    });
+};
+
+const make = (config) => {
+    if (!config.moduleBaseUrl) {
+        throw new Error(NO_MODULE_BASE_URL);
+    }
+    let timer = undefined;
+    setModuleBaseUrl(config.moduleBaseUrl);
+    setLoginPageUrl(config.loginPageUrl);
+    initInstance();
+    const init = (initConfig) => {
+        setTenantId(initConfig.tenantId);
+        setBrand(initConfig.brand || Brand.ZERO);
+        const token = getAccessToken();
+        const refreshToken = getRefreshToken();
+        if (!token) {
+            setAccessToken(null);
+            setRefreshToken(null);
+            return Promise.reject(new Error(NO_ACCESS_TOKEN));
+        }
+        if (!refreshToken) {
+            setAccessToken(null);
+            setRefreshToken(null);
+            return Promise.reject(new Error(NO_REFRESH_TOKEN));
+        }
+        return getUserInfo()
+            .then((userInfo) => __awaiter(void 0, void 0, void 0, function* () {
+            const valid = detectUserInfoGroupAuth(userInfo);
+            if (!valid) {
+                return Promise.reject();
+            }
+            return fetchServerListHTTP();
+        }))
+            .then(resp => {
+            const menus = resp.data.content || [];
+            const group = menus.find(menu => menu.groupName === config.moduleName);
+            if (menus.length <= 0) {
+                openDialog();
+                return Promise.reject();
+            }
+            if (config.moduleName === 'commonLogin') {
+                setupRefreshTokenTimer();
+                return Promise.resolve(menus);
+            }
+            if (!group) {
+                openDialog();
+                return Promise.reject();
+            }
+            setSystemType(group.staffEndpoint ? SystemType.Staff : SystemType.Client);
+            setupRefreshTokenTimer();
+            return Promise.resolve(menus);
+        })
+            .catch((error) => __awaiter(void 0, void 0, void 0, function* () {
+            clearRefreshTokenTimer();
+            setAccessToken(null);
+            setRefreshToken(null);
+            yield logout();
+            throw error;
+        }));
+    };
+    const detectUserInfoGroupAuth = (userInfo) => {
+        const groups = userInfo['cognito:groups'] || [];
+        if (!groups.includes(config.moduleName)
+            && config.moduleName !== 'commonLogin'
+            && config.moduleName !== 'App') {
+            return false;
+        }
+        return true;
+    };
+    const setupRefreshTokenTimer = () => {
+        const refreshToken = getRefreshToken();
+        if (!refreshToken)
+            return;
+        if (timer) {
+            clearInterval(timer);
+        }
+        timer = setInterval(() => {
+            fetchRefreshTokenHTTP(refreshToken)
+                .then(resp => {
+                const { content: { idToken } } = resp.data;
+                setAccessToken(idToken);
+                return getUserInfo();
+            })
+                .then(userInfo => {
+                const valid = detectUserInfoGroupAuth(userInfo);
+                if (!valid) {
+                    clearRefreshTokenTimer();
+                    openDialog();
+                    return logout();
+                }
+            })
+                .catch(error => {
+                clearRefreshTokenTimer();
+                throw error;
+            });
+        }, 1e3 * 60 * 3); // 3 minutes
+    };
+    const logout = () => {
+        return fetchLogoutHTTP()
+            .finally(() => {
+            clearRefreshTokenTimer();
+            setAccessToken(null);
+            setRefreshToken(null);
+        });
+    };
+    const clearRefreshTokenTimer = () => {
+        if (!timer)
+            return;
+        clearInterval(timer);
+        timer = null;
+    };
+    return {
+        init,
+        logout
+    };
+};
+
+export { clearLoginCookie, getAccessToken, getCookie, getIdToken, getRefreshToken, getSystemType, getUrlParam, getUserInfo, isMobile, make, setAccessToken, setCookie, setIdToken, setRefreshToken, setSystemType };