@pubinfo-pr/module-auth 0.203.1 → 0.203.3

package/src/index.ts

@@ -1,78 +1,26 @@
-import type { ModuleOptions } from 'pubinfo-pr';
-import type { RouteRecordRaw } from 'vue-router';
-import type { AuthOptions } from './interface';
-import { cleanup } from 'pubinfo-pr';
-import { ctx } from './context';
-import { authenticate, redirect } from './core';
-import { PageAuth } from './pages/auth';
-
-export function auth(options: AuthOptions): ModuleOptions {
-  const {
-    redirectTo = '/',
-    pages = {},
-    baseURL,
-    providers,
-  } = options;
-  const { signIn = '/login' } = pages;
-
-  ctx.set({ baseURL, providers });
-
-  return {
-    name: 'pubinfo-pr:auth',
-    enforce: 'pre',
-    setup(ctx) {
-      const { router } = ctx;
-
-      const ROUTE_AUTH: RouteRecordRaw = {
-        path: '/auth/:type',
-        name: 'Auth',
-        component: PageAuth,
-        meta: {
-          whiteList: true,
-          title: '授权登录',
-        },
-        props: route => ({
-          type: route.params.type,
-          authenticate,
-          redirectTo() {
-            if (typeof redirectTo === 'function') {
-              redirectTo();
-              return;
-            }
-
-            router.push(redirectTo);
-          },
-        }),
-      };
-
-      router.beforeEach((to) => {
-        // 注册静态页面
-        if (!router.hasRoute(ROUTE_AUTH.name!)) {
-          router.addRoute(ROUTE_AUTH);
-          return to.fullPath;
-        }
-
-        // 前往单点登录前，清空登录状态
-        if (to.name === ROUTE_AUTH.name) {
-          cleanup();
-        }
-
-        // 前往登录前，重定向至统一登录页（若有）
-        if (to.path === signIn) {
-          redirect();
-        }
-      });
-    },
-  };
-}
+import { AuthClient } from './auth';
 
+export * from './auth';
 export { LoginWithFourA } from './components/LoginWithFourA';
-
-export {
-  authenticate,
-  redirect,
-  renderQRCode,
-  signIn,
-} from './core';
-
+export { createAuth } from './core';
 export * from './interface';
+
+/**
+ * @deprecated 认证, 请使用 `authClient.authenticate` 方法替代
+ */
+export const authenticate = AuthClient.authenticate;
+
+/**
+ * @deprecated 重定向至统一登录页, 请使用 `authClient.redirect` 方法替代
+ */
+export const redirect = AuthClient.redirect;
+
+/**
+ * @deprecated 生成二维码, 请使用 `authClient.renderQRCode` 方法替代
+ */
+export const renderQRCode = AuthClient.renderQRCode;
+
+/**
+ * @deprecated 前往登录, 请使用 `authClient.signIn` 方法替代
+ */
+export const signIn = AuthClient.signIn;

package/src/interface.ts

@@ -1,10 +1,11 @@
 import type { RouteLocationRaw } from 'vue-router';
+import type { CreateAuthOptions } from './core';
 
 export type Recordable = Record<string, any>;
 export type Fn<T = any, K = any> = (params?: Recordable & T) => Promise<K> | K;
 export type FnApi<T = any, R = any> = (params: Recordable & T, baseURL: string) => Promise<R>;
 
-export interface AuthOptions {
+export interface AuthOptions<Plugins extends PluginOptions[]> {
   /** 登录后默认重定向至 */
   redirectTo?: RouteLocationRaw | Fn
 
@@ -17,14 +18,30 @@ export interface AuthOptions {
   /** 接口的baseURL */
   baseURL: string
 
-  providers?: ProviderOptions[]
+  providers?: CreateAuthOptions<Plugins>['providers']
+  plugins?: CreateAuthOptions<Plugins>['plugins']
 }
 
-export interface InternalContext {
-  /** 接口的baseURL */
-  baseURL: string
+export interface CreateAuthModule {
+  /** 登录后默认重定向至 */
+  redirectTo?: RouteLocationRaw | Fn
+
+  /** 页面配置 */
+  pages?: {
+    /** 默认登录页 */
+    signIn?: RouteLocationRaw
+  }
+}
+
+export interface PluginContext {
+  data: Recordable
+}
+
+export interface PluginOptions<Extend = any> {
+  /** 唯一值 */
+  id: string
 
-  providers?: ProviderOptions[]
+  extend?: (context: PluginContext) => Extend
 }
 
 /** 第三方类型 */

package/src/plugins/index.ts

@@ -0,0 +1 @@
+export * from './two-factor';

package/src/plugins/two-factor.ts

@@ -0,0 +1,69 @@
+import type { RequestInstance } from 'pubinfo-pr';
+import type { Fn, PluginOptions } from '../interface';
+
+interface TwoFactorExtend {
+  twoFactor: {
+    sendOtp: Fn
+    verifyOtp: Fn<{ code: string }>
+  }
+}
+
+interface DefaultOptOptions {
+  request: RequestInstance
+  sendOtp?: TwoFactorExtend['twoFactor']['sendOtp']
+  verifyOtp?: TwoFactorExtend['twoFactor']['verifyOtp']
+}
+
+interface CustomOptOptions {
+  request: never
+  sendOtp: TwoFactorExtend['twoFactor']['sendOtp']
+  verifyOtp: TwoFactorExtend['twoFactor']['verifyOtp']
+}
+
+export type TwoFactorOptions = DefaultOptOptions | CustomOptOptions;
+
+/**
+ * `双因子认证插件`
+ */
+export function twoFactor(options: TwoFactorOptions): PluginOptions<TwoFactorExtend> {
+  const { request, sendOtp, verifyOtp } = options;
+
+  return {
+    id: 'two-factor',
+    extend(context) {
+      const twoFactor: TwoFactorExtend['twoFactor'] = {
+        sendOtp: (payload) => {
+          const login2faCode = context.data?.data?.login2faCode;
+          if (sendOtp) {
+            return sendOtp(payload);
+          }
+
+          return request.Post('/auth/2fa/prepare', {
+            fa2Type: 'sms',
+            login2faCode,
+            ...payload,
+          });
+        },
+
+        verifyOtp: (payload) => {
+          const login2faCode = context.data?.data?.login2faCode;
+          if (verifyOtp) {
+            return verifyOtp(payload);
+          }
+
+          const { code, ...params } = payload ?? {};
+          return request.Post('/auth/2fa/verify', {
+            fa2Type: 'sms',
+            login2faCode,
+            verifyCode: code,
+            ...params,
+          });
+        },
+      };
+
+      return {
+        twoFactor,
+      };
+    },
+  };
+}

package/src/providers/default-credentials.ts

@@ -0,0 +1,29 @@
+import type { ProviderOptions, ProviderUserOptions } from '../interface';
+import { useUserStore } from 'pubinfo-pr';
+
+export interface DefaultCredentialsOptions extends ProviderUserOptions {}
+
+/**
+ * `默认登录`
+ *
+ * 底座自带的用户名密码登录
+ *
+ * 默认优先使用 `/auth/loginNew` 接口，若登录参数不符合则调用 `/auth/login` 接口
+ */
+export default function DefaultCredentials(options?: DefaultCredentialsOptions): ProviderOptions {
+  return {
+    id: 'default-credentials',
+    name: '默认登录',
+    type: 'custom',
+    signIn: async (params) => {
+      const userStore = useUserStore();
+
+      // 兼容 `2.1.x` 之前的版本
+      // 根据 `captchaType` 字段判断是否使用 `/auth/loginNew` 登录接口
+      const signIn = params.captchaType ? userStore.signIn : userStore.login;
+
+      return await signIn(params);
+    },
+    ...options,
+  };
+}

package/src/providers/index.ts

@@ -0,0 +1,5 @@
+export { default as FourA } from './4A';
+export { default as Credentials } from './credentials';
+export { default as DefaultCredentials } from './default-credentials';
+export { default as DingZJ } from './ding-zj';
+export { default as Sso } from './sso';

package/dist/context.d.ts

@@ -1,2 +0,0 @@
-import type { InternalContext } from './interface';
-export declare const ctx: import("unctx").UseContext<InternalContext>;

package/src/context.ts

@@ -1,4 +0,0 @@
-import type { InternalContext } from './interface';
-import { createContext } from 'pubinfo-pr';
-
-export const ctx = createContext<InternalContext>('auth');