@pubinfo-pr/module-auth 0.203.1 → 0.203.2

package/dist/interface.d.ts

@@ -1,8 +1,9 @@
 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;
     /** 页面配置 */
@@ -12,12 +13,22 @@ export interface AuthOptions {
     };
     /** 接口的baseURL */
     baseURL: string;
-    providers?: ProviderOptions[];
+    providers?: CreateAuthOptions<Plugins>['providers'];
+    plugins?: CreateAuthOptions<Plugins>['plugins'];
 }
-export interface InternalContext {
-    /** 接口的baseURL */
-    baseURL: string;
-    providers?: ProviderOptions[];
+export interface CreateAuthModule {
+    /** 登录后默认重定向至 */
+    redirectTo?: RouteLocationRaw | Fn;
+    /** 页面配置 */
+    pages?: {
+        /** 默认登录页 */
+        signIn?: RouteLocationRaw;
+    };
+}
+export interface PluginOptions<Extend = any> {
+    /** 唯一值 */
+    id: string;
+    extend?: (context: any) => Extend;
 }
 /** 第三方类型 */
 export type ThirdParty = string;

package/dist/plugins/index.d.ts

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

package/dist/plugins/two-factor.d.ts

@@ -0,0 +1,16 @@
+import type { RequestInstance } from 'pubinfo-pr';
+import type { Fn, PluginOptions } from '../interface';
+interface TwoFactorExtend {
+    twoFactor: {
+        sendOtp: Fn;
+        verifyOtp: Fn<{
+            code: string;
+        }>;
+    };
+}
+export interface TwoFactorOptions {
+    /** 请求实例 */
+    request: RequestInstance;
+}
+export declare function twoFactor(options: TwoFactorOptions): PluginOptions<TwoFactorExtend>;
+export {};

package/dist/plugins.js

@@ -0,0 +1,27 @@
+function twoFactor(e) {
+	let { request: t } = e;
+	return {
+		id: "two-factor",
+		extend() {
+			return { twoFactor: {
+				sendOtp(e) {
+					return t.Post("/auth/2fa/prepare", {
+						fa2Type: "sms",
+						login2faCode: void 0,
+						...e
+					});
+				},
+				verifyOtp(e) {
+					let { code: n, ...r } = e ?? {};
+					return t.Post("/auth/2fa/verify", {
+						fa2Type: "sms",
+						login2faCode: void 0,
+						verifyCode: n,
+						...r
+					});
+				}
+			} };
+		}
+	};
+}
+export { twoFactor };

package/dist/providers/default-credentials.d.ts

@@ -0,0 +1,11 @@
+import type { ProviderOptions, ProviderUserOptions } from '../interface';
+export interface DefaultCredentialsOptions extends ProviderUserOptions {
+}
+/**
+ * `默认登录`
+ *
+ * 底座自带的用户名密码登录
+ *
+ * 默认优先使用 `/auth/loginNew` 接口，若登录参数不符合则调用 `/auth/login` 接口
+ */
+export default function DefaultCredentials(options?: DefaultCredentialsOptions): ProviderOptions;

package/dist/providers/default-credentials.js

@@ -0,0 +1,14 @@
+import { useUserStore } from "pubinfo-pr";
+function DefaultCredentials(e) {
+	return {
+		id: "default-credentials",
+		name: "默认登录",
+		type: "custom",
+		signIn: async (e) => {
+			let t = useUserStore();
+			return await (e.captchaType ? t.signIn : t.login)(e);
+		},
+		...e
+	};
+}
+export { DefaultCredentials as default };

package/dist/providers/index.d.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/providers/index.js

@@ -0,0 +1,7 @@
+import FourA from "./4A.js";
+import Credentials from "./credentials.js";
+import DefaultCredentials from "./default-credentials.js";
+import DingZJ from "./ding-zj.js";
+import Sso from "./sso.js";
+import "../providers.js";
+export { Credentials, DefaultCredentials, DingZJ, FourA, Sso };

package/dist/providers.js

@@ -0,0 +1,6 @@
+import FourA from "./providers/4A.js";
+import Credentials from "./providers/credentials.js";
+import DefaultCredentials from "./providers/default-credentials.js";
+import DingZJ from "./providers/ding-zj.js";
+import Sso from "./providers/sso.js";
+export { Credentials, DefaultCredentials, DingZJ, FourA, Sso };

package/package.json

@@ -1,12 +1,20 @@
 {
   "name": "@pubinfo-pr/module-auth",
   "type": "module",
-  "version": "0.203.1",
+  "version": "0.203.2",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
+    "./providers": {
+      "types": "./dist/providers/index.d.ts",
+      "default": "./dist/providers/index.js"
+    },
+    "./plugins": {
+      "types": "./dist/plugins/index.d.ts",
+      "default": "./dist/plugins.js"
+    },
     "./providers/*": {
       "types": "./dist/providers/*.d.ts",
       "default": "./dist/providers/*.js"
@@ -23,10 +31,10 @@
     "node": "^20.19.0 || >=22.12.0"
   },
   "peerDependencies": {
-    "pubinfo-pr": "0.203.1"
+    "pubinfo-pr": "0.203.2"
   },
   "devDependencies": {
-    "pubinfo-pr": "0.203.1"
+    "pubinfo-pr": "0.203.2"
   },
   "scripts": {
     "dev": "pubinfo build --watch",

package/src/auth.ts

@@ -0,0 +1,141 @@
+import type { ModuleOptions } from 'pubinfo-pr';
+import type { RouteRecordRaw } from 'vue-router';
+import type { AuthClient as AuthClientInstance } from './core';
+import type { AuthOptions, CreateAuthModule, PluginOptions } from './interface';
+import { cleanup } from 'pubinfo-pr';
+import { createAuth } from './core';
+import { PageAuth } from './pages/auth';
+
+let authClient!: AuthClientInstance;
+
+export const AuthClient: AuthClientInstance = {
+  signIn: (...args) => authClient.signIn(...args),
+  authenticate: (...args) => authClient.authenticate(...args),
+  renderQRCode: (...args) => authClient.renderQRCode(...args),
+  redirect: (...args) => authClient.redirect(...args),
+  getProvider: (...args) => authClient.getProvider(...args),
+};
+
+/**
+ * @deprecated 请使用 `createAuthModule` 和 `createAuth` 替换
+ */
+export function auth<Plugins extends PluginOptions[]>(options: AuthOptions<Plugins>): ModuleOptions {
+  const {
+    redirectTo = '/',
+    pages = {},
+    baseURL,
+    providers,
+    plugins,
+  } = options;
+  const { signIn = '/login' } = pages;
+
+  authClient = createAuth<Plugins>({
+    baseURL,
+    providers,
+    plugins,
+  });
+
+  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: authClient.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) {
+          authClient.redirect();
+        }
+      });
+    },
+  };
+}
+
+export function createAuthModule(authClient: AuthClientInstance, options: CreateAuthModule = {}): ModuleOptions {
+  const {
+    redirectTo = '/',
+    pages = {},
+  } = options;
+  const { signIn = '/login' } = pages;
+
+  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: authClient.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) {
+          authClient.redirect();
+        }
+      });
+    },
+  };
+}

package/src/components/RedirectLogin/index.ts

@@ -1,6 +1,5 @@
 import { defineComponent, h } from 'vue';
-import { signIn } from '@/core';
-import { getProvider } from '@/helper';
+import { AuthClient } from '@/auth';
 
 export const RedirectLogin = defineComponent({
   name: 'RedirectLogin',
@@ -10,7 +9,7 @@ export const RedirectLogin = defineComponent({
     color: String,
   },
   setup(props) {
-    const provider = getProvider(props.id);
+    const provider = AuthClient.getProvider(props.id);
     return () => {
       return h('div', [
         h(
@@ -33,7 +32,7 @@ export const RedirectLogin = defineComponent({
               letterSpacing: '0.1em',
               backgroundColor: props.color,
             },
-            onClick: () => signIn(provider.id),
+            onClick: () => AuthClient.signIn(provider.id),
           },
           `前往${provider.name}`,
         ),

package/src/core.ts

@@ -1,75 +1,154 @@
-import type { Recordable, ThirdParty } from './interface';
-import { ctx } from './context';
-import { createUrl, createUrlByProvider, getProvider } from './helper';
-
-/**
- * 前往登录
- * @param id 唯一值
- * @param options 登录时需要传递的参数
- */
-export async function signIn(id: ThirdParty, options?: Recordable) {
-  const provider = getProvider(id);
-
-  if (typeof provider.signIn === 'function') {
-    return await provider.signIn(options);
-  }
+import type { PluginOptions, ProviderOptions, Recordable, ThirdParty } from './interface';
+import { createUrl, createUrlByProvider } from './helper';
 
-  if (['oauth', 'custom'].includes(provider.type)) {
-    const url = createUrlByProvider(provider);
-    window.location.replace(url);
-  }
+export interface CreateAuthOptions<Plugins extends PluginOptions[]> {
+  baseURL: string
+  providers?: ProviderOptions[]
+  plugins?: Plugins
 }
 
-/**
- * 生成二维码
- * @param id 第三方的唯一值
- * @param options 生成二维码需要传递的参数
- * @param options.id `getElementById`中指定的`id`
- */
-export function renderQRCode(id: ThirdParty, options: { id: string } & Recordable) {
-  const provider = getProvider(id);
-
-  if (['oauth', 'custom'].includes(provider.type)) {
-    const url = createUrlByProvider(provider);
-    provider.initQRCode?.(url, options);
-  }
+export interface AuthClient {
+  /**
+   * 前往登录
+   * @param id 唯一值
+   * @param options 登录时需要传递的参数
+   */
+  signIn: (id: ThirdParty, options?: Recordable) => Promise<any> | any
+
+  /**
+   * 生成二维码
+   * @param id 第三方的唯一值
+   * @param options 生成二维码需要传递的参数
+   * @param options.id `getElementById`中指定的`id`
+   */
+  renderQRCode: (id: ThirdParty, options: { id: string } & Recordable) => void
+
+  /**
+   * 认证
+   * @param id 第三方的唯一值
+   */
+  authenticate: (id: ThirdParty) => Promise<any>
+
+  /**
+   * 重定向至统一登录页
+   */
+  redirect: () => void
+
+  /**
+   * 获取指定的 `Provider`
+   * @param id
+   */
+  getProvider: (id?: ThirdParty) => ProviderOptions
 }
 
-/**
- * 认证
- * @param id 第三方的唯一值
- */
-export async function authenticate(id: ThirdParty) {
-  const provider = getProvider(id);
-  const { baseURL } = ctx.use();
-
-  // TODO 处理hash路由中的#
-  // 获取URL上的参数
-  const qs = window.location.href.split('?')?.[1] ?? '';
-  const params = new URLSearchParams(qs);
-  const paramsObject = Object.fromEntries(params.entries());
-
-  if (typeof provider.authenticate === 'function') {
-    return await provider.authenticate(paramsObject, baseURL);
-  }
+type UnionToIntersection<U>
+  = (U extends any ? (x: U) => any : never) extends (x: infer I) => any
+    ? I
+    : never;
+
+type PluginExtend<P extends PluginOptions[]>
+  = UnionToIntersection<
+    {
+      [K in keyof P]: P[K] extends PluginOptions<infer E> ? E : never
+    }[number]
+  >;
 
-  if (['oauth', 'cas', 'custom'].includes(provider.type)) {
-    const url = createUrl(`${baseURL}${provider.authenticate}`, paramsObject);
-    const response = await fetch(url);
-    return await response.json();
+export function createAuth<Plugins extends PluginOptions[]>(options: CreateAuthOptions<Plugins>): AuthClient & PluginExtend<Plugins> {
+  const { baseURL, providers = [], plugins = [] } = options;
+
+  /**
+   * 获取指定的 `Provider`
+   * @param id
+   */
+  function getProvider(id?: ThirdParty) {
+    const provider = id ? providers?.find(provider => provider.id === id) : providers?.[0];
+    if (!provider) {
+      throw new Error(`Provider '${id}' is not found.`);
+    }
+    return provider;
   }
-}
 
-/**
- * 重定向至统一登录页
- */
-export function redirect() {
-  const { providers } = ctx.use();
-  const provider = providers?.find(provider => provider.type === 'cas');
-  if (!provider) {
-    return;
+  const authClient = {
+    /**
+     * 前往登录
+     * @param id 唯一值
+     * @param options 登录时需要传递的参数
+     */
+    async signIn(id: ThirdParty, options?: Recordable) {
+      const provider = getProvider(id);
+
+      if (typeof provider.signIn === 'function') {
+        return await provider.signIn(options);
+      }
+
+      if (['oauth', 'custom'].includes(provider.type)) {
+        const url = createUrlByProvider(provider);
+        window.location.replace(url);
+      }
+    },
+
+    /**
+     * 生成二维码
+     * @param id 第三方的唯一值
+     * @param options 生成二维码需要传递的参数
+     * @param options.id `getElementById`中指定的`id`
+     */
+    renderQRCode(id: ThirdParty, options: { id: string } & Recordable) {
+      const provider = getProvider(id);
+
+      if (['oauth', 'custom'].includes(provider.type)) {
+        const url = createUrlByProvider(provider);
+        provider.initQRCode?.(url, options);
+      }
+    },
+
+    /**
+     * 认证
+     * @param id 第三方的唯一值
+     */
+    async authenticate(id: ThirdParty) {
+      const provider = getProvider(id);
+
+      // TODO 处理hash路由中的#
+      // 获取URL上的参数
+      const qs = window.location.href.split('?')?.[1] ?? '';
+      const params = new URLSearchParams(qs);
+      const paramsObject = Object.fromEntries(params.entries());
+
+      if (typeof provider.authenticate === 'function') {
+        return await provider.authenticate(paramsObject, baseURL);
+      }
+
+      if (['oauth', 'cas', 'custom'].includes(provider.type)) {
+        const url = createUrl(`${baseURL}${provider.authenticate}`, paramsObject);
+        const response = await fetch(url);
+        return await response.json();
+      }
+    },
+
+    /**
+     * 重定向至统一登录页
+     */
+    redirect() {
+      const provider = providers?.find(provider => provider.type === 'cas');
+      if (!provider) {
+        return;
+      }
+
+      const url = createUrlByProvider(provider);
+      window.location.replace(url);
+    },
+
+    /**
+     * 获取指定的 `Provider`
+     * @param id
+     */
+    getProvider,
+  };
+
+  for (const plugin of plugins) {
+    Object.assign(authClient, plugin.extend?.({}));
   }
 
-  const url = createUrlByProvider(provider);
-  window.location.replace(url);
+  return authClient as AuthClient & PluginExtend<Plugins>;
 }

package/src/helper.ts

@@ -1,18 +1,4 @@
-import type { ProviderUserOptions, Recordable, ThirdParty } from './interface';
-import { ctx } from './context';
-
-/**
- * 获取指定的 `Provider`
- * @param id
- */
-export function getProvider(id?: ThirdParty) {
-  const { providers } = ctx.use();
-  const provider = id ? providers?.find(provider => provider.id === id) : providers?.[0];
-  if (!provider) {
-    throw new Error(`Provider '${id}' is not found.`);
-  }
-  return provider;
-}
+import type { ProviderUserOptions, Recordable } from './interface';
 
 /**
  * 构建第三方授权登录地址

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;