login-authorization-v2 2.0.0-beta.1 → 2.0.0-beta.11

package/README.md

@@ -1,55 +1,53 @@
-# login-authorization
+# login-authorization-v2
 
-> 登录验证
-## 安装依赖
+## 安装
+```bash
+#npm
+npm install login-authorization-v2
 
-``` bash
-# install dependencies
-npm install login-authorization --save
-# or with yarn
-yarn add login-authorization
+#yarn
+yarn add login-authorization-v2
 ```
-## 方法使用说明
-### 初始化：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中配置的系统组名保持一致。
+## 使用文档
+### 基本使用
+```javascript
+import { make } from 'login-authorization-v2'
 
-```
-<font color=#ff0000 size=24>注意：凡是涉及到统一登录系统的loginUrl后面必须将你的系统名称带上,且参数名称为systemName，如果未涉及则不用。</font>
-### 登录成功时需要设置idToken和refreshToken初始值
-setIdToken(value)
-setRefreshToken(value)
-### 获取idToken：getIdToken()
-```bash
-import { getIdToken } from 'login-authorization';
+const { init, logout } = make({
+  moduleName: 'Portal', // 当前模块名称
+  moduleBaseUrl: 'https://servers-api.gztest.net:8107', // 后端的 module_base 服务地址
+  loginPageUrl: 'http://huangcheng.ddmarketinghub.com:8080', // 如果未登录，跳转的登录页地址
+})
 
-let idToken = getIdToken(); // 'xxxxxx'，如果未登录则为null
-```
-### 获取用户信息：getUserInfo()
-```bash
-import { getUserInfo } from 'login-authorization';
+init({ brand: 1, tenantId: 1 }).then(menus => {
+  // menus 即为当前用户的菜单权限数据
+}).catch(err => {
+  // 任何不能正常登陆的情况都会进入这里
+})
 
-let userInfo = getUserInfo(); //{email: 'xxx', name: 'xxx',...}，如果未登录则为null
-```
-### 登出：logout()
-```bash
-import { logout } from 'login-authorization';
-
-logout().then(res => {
-  if (res) {
-    // true 登出成功,会自动跳转到登录页面
-  } else {
-    // false 登出失败
-  }
+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

@@ -1,15 +1,25 @@
 export * from './src/cookie';
 export * from './src/compatible';
-import { type ModuleName, type Tenant, type Brand } from './src/types';
+export * from './src/utils';
+import { Brand, type ModuleName, Tenant } from './src/types';
 type MakeFnParams = {
-    brand: Brand;
-    tenantId: Tenant;
     moduleName: ModuleName;
     moduleBaseUrl: string;
     loginPageUrl: string;
 };
+type InitFnParams = {
+    brand?: Brand;
+    tenantId: Tenant;
+};
 export declare const make: (config: MakeFnParams) => {
-    init: () => Promise<void>;
+    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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,kBAAkB,CAAA;AAOhC,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,MAAM,EAAE,KAAK,KAAK,EAAiB,MAAM,aAAa,CAAA;AAIrF,KAAK,YAAY,GAAG;IAClB,KAAK,EAAE,KAAK,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,UAAU,CAAA;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,IAAI,GAAI,QAAQ,YAAY;;;CAqIxC,CAAA"}
+{"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"}