@pubinfo/module-auth 2.0.13 → 2.0.14

package/dist/interface.d.ts

@@ -3,7 +3,7 @@ export type Recordable = Record<string, any>;
 export type Fn<T = any, K = any> = (params?: Recordable & T) => Promise<K> | K;
 export type FnApi<T = any> = (params: Recordable & T, baseURL: string) => Promise<any>;
 export interface AuthOptions {
-    /** 登录后重定向至 */
+    /** 登录后默认重定向至 */
     redirectTo?: RouteLocationRaw | Fn;
     /** 页面配置 */
     pages?: {
@@ -12,17 +12,17 @@ export interface AuthOptions {
     };
     /** 接口的baseURL */
     baseURL: string;
-    providers?: ProviderConfig[];
+    providers?: ProviderOptions[];
 }
 export interface InternalContext {
     /** 接口的baseURL */
     baseURL: string;
-    providers?: ProviderConfig[];
+    providers?: ProviderOptions[];
 }
 /** 第三方类型 */
 export type ThirdParty = string;
-export type ProviderUserConfig = Partial<ProviderConfig>;
-export interface ProviderConfig {
+export type ProviderUserOptions = Partial<ProviderOptions>;
+export interface ProviderOptions {
     /** 唯一值 */
     id: string;
     /** 名称 */
@@ -35,13 +35,9 @@ export interface ProviderConfig {
      */
     type: 'oauth' | 'cas' | 'custom';
     /** 授权登录地址 */
-    authorization?: Authorization | Fn;
-    /** `client_id` */
-    clientId?: string;
-    /** `redirect_uri` */
-    redirectUri?: string;
+    signIn?: Authorization | Fn;
     /** 授权登录接口 */
-    callbackUrl?: string | FnApi;
+    authenticate?: string | FnApi;
     /** 初始化二维码 */
     initQRCode?: (url: string, params: {
         id: string;

package/dist/pages/auth.d.ts

@@ -1,11 +1,11 @@
 export declare const PageAuth: import('../../../../node_modules/.pnpm/vue@3.5.17_typescript@5.8.3/node_modules/vue').DefineComponent<import('../../../../node_modules/.pnpm/vue@3.5.17_typescript@5.8.3/node_modules/vue').ExtractPropTypes<{
     type: StringConstructor;
     redirectTo: FunctionConstructor;
-    authentication: FunctionConstructor;
+    authenticate: FunctionConstructor;
 }>, () => import('../../../../node_modules/.pnpm/vue@3.5.17_typescript@5.8.3/node_modules/vue').VNode<import('../../../../node_modules/.pnpm/vue@3.5.17_typescript@5.8.3/node_modules/vue').RendererNode, import('../../../../node_modules/.pnpm/vue@3.5.17_typescript@5.8.3/node_modules/vue').RendererElement, {
     [key: string]: any;
 }>, {}, {}, {}, import('../../../../node_modules/.pnpm/vue@3.5.17_typescript@5.8.3/node_modules/vue').ComponentOptionsMixin, import('../../../../node_modules/.pnpm/vue@3.5.17_typescript@5.8.3/node_modules/vue').ComponentOptionsMixin, {}, string, import('../../../../node_modules/.pnpm/vue@3.5.17_typescript@5.8.3/node_modules/vue').PublicProps, Readonly<import('../../../../node_modules/.pnpm/vue@3.5.17_typescript@5.8.3/node_modules/vue').ExtractPropTypes<{
     type: StringConstructor;
     redirectTo: FunctionConstructor;
-    authentication: FunctionConstructor;
+    authenticate: FunctionConstructor;
 }>> & Readonly<{}>, {}, {}, {}, {}, string, import('../../../../node_modules/.pnpm/vue@3.5.17_typescript@5.8.3/node_modules/vue').ComponentProvideOptions, true, {}, any>;

package/dist/providers/4A.d.ts

@@ -1,5 +1,15 @@
-import { ProviderConfig, ProviderUserConfig } from '../interface';
+import { ProviderOptions, ProviderUserOptions } from '../interface';
+export interface FourAOptions extends ProviderUserOptions {
+    /** `client_id` */
+    clientId?: string;
+    /** `redirect_uri` */
+    redirectUri?: string;
+}
 /**
- * 4A登录
+ * `4A 统一认证`
+ *
+ * - 携带 `client_id` 和 `redirect_uri`，前往 [4A认证中心](http://134.108.76.137:7001/index) 进行登录；
+ * - 成功登录后，4A认证中心会回调 `redirect_uri` 并携带参数；
+ * - 当前 `provider` 将获取参数值并调用 `/bs/loginBy4a` 完成登录认证。
  */
-export default function FourA(options: ProviderUserConfig): ProviderConfig;
+export default function FourA(options: FourAOptions): ProviderOptions;

package/dist/providers/4A.js

@@ -1,18 +1,18 @@
 function i(e) {
-  const { clientId: r, redirectUri: t } = e;
+  const { clientId: t, redirectUri: r } = e;
   return {
     id: "4A",
     name: "4A登录",
     type: "oauth",
-    authorization: {
+    signIn: {
       url: "http://134.108.76.137:7001/index",
       params: {
         response_type: "code",
-        client_id: r,
-        redirect_uri: t
+        client_id: t,
+        redirect_uri: r
       }
     },
-    callbackUrl: "/bs/loginBy4a",
+    authenticate: "/bs/loginBy4a",
     ...e
   };
 }

package/dist/providers/credentials.d.ts

@@ -1,9 +1,7 @@
-import { Fn, ProviderConfig } from '../interface';
-interface CredentialsConfig {
-    authorize: Fn<any>;
+import { ProviderOptions, ProviderUserOptions } from '../interface';
+export interface CredentialsOptions extends ProviderUserOptions {
 }
 /**
  * 凭证登录
  */
-export default function Credentials(options: CredentialsConfig): ProviderConfig;
-export {};
+export default function Credentials(options?: CredentialsOptions): ProviderOptions;

package/dist/providers/credentials.js

@@ -1,12 +1,11 @@
-function a(t) {
-  const { authorize: e } = t;
+function t(e) {
   return {
     id: "credentials",
     name: "凭证登录",
     type: "custom",
-    authorization: e
+    ...e
   };
 }
 export {
-  a as default
+  t as default
 };

package/dist/providers/ding-zj.d.ts

@@ -1,14 +1,17 @@
-import { ProviderConfig, ProviderUserConfig } from '../interface';
-interface DingZJConfig extends ProviderUserConfig {
+import { ProviderOptions, ProviderUserOptions } from '../interface';
+export interface DingZJOptions extends ProviderUserOptions {
     /**
      * 登录方式
      * - `redirect` 跳转浙政钉的扫码页面
      * - `embed` 内嵌浙政钉的登录二维码
      */
     mode: 'redirect' | 'embed';
+    /** `client_id` */
+    clientId?: string;
+    /** `redirect_uri` */
+    redirectUri?: string;
 }
 /**
  * 浙政钉扫码登录
  */
-export default function DingZJ(options: DingZJConfig): ProviderConfig;
-export {};
+export default function DingZJ(options: DingZJOptions): ProviderOptions;

package/dist/providers/ding-zj.js

@@ -1,4 +1,4 @@
-function m(e) {
+function g(e) {
   const { clientId: i, redirectUri: n } = e, a = {
     /** 跳转外部页面 */
     redirect: {
@@ -27,10 +27,10 @@ function m(e) {
     if (!document.getElementById(t.id))
       throw new Error(`未找到id为${t.id}的DOM元素`);
     const r = document.createElement("iframe");
-    r.src = c, r.width = "200", r.height = "200", document.appendChild(r), window.addEventListener("message", (u) => {
+    r.src = c, r.width = "200", r.height = "200", document.appendChild(r), window.addEventListener("message", (s) => {
       if (t.redirectUri) {
         const d = new URL(t.redirectUri);
-        d.search = new URLSearchParams(u.data).toString(), window.location.href = d.toString();
+        d.search = new URLSearchParams(s.data).toString(), window.location.href = d.toString();
       }
     });
   };
@@ -38,12 +38,12 @@ function m(e) {
     id: "ding-zj",
     name: "浙政钉登录",
     type: "oauth",
-    authorization: a[e.mode],
-    callbackUrl: "/bs/loginByDingZJ",
+    signIn: a[e.mode],
+    authenticate: "/bs/loginByDingZJ",
     initQRCode: e.mode === "embed" ? o : void 0,
     ...e
   };
 }
 export {
-  m as default
+  g as default
 };

package/dist/providers/sso.d.ts

@@ -0,0 +1,19 @@
+import { ProviderOptions, ProviderUserOptions } from '../interface';
+export interface SsoOptions extends ProviderUserOptions {
+    /**
+     * 登录类型，根据调用 `/app/oauth/generateCode` 接口时传递的 `grantType` 参数值判断：
+     *
+     * - `OAUTH2` -> `defaultOauth2`
+     * - `SIMPLE_ENCRYPT` -> `encrypt`
+     *
+     * @default `defaultOauth2`
+     */
+    loginType?: 'defaultOauth2' | 'encrypt';
+}
+/**
+ * `SSO 统一账号登录`
+ *
+ * - 主系统调用 `/app/oauth/generateCode?appKey=xxx` 获取 `code`，并作为参数跳转至子系统；
+ * - 当前 `provider` 将获取 `code` 并调用 `/auth/ssoLogin` 完成登录认证。
+ */
+export default function Sso(options?: SsoOptions): ProviderOptions;

package/dist/providers/sso.js

@@ -0,0 +1,23 @@
+function o(t = {}) {
+  const { loginType: e = "defaultOauth2" } = t;
+  return {
+    id: "sso",
+    name: "SSO统一账号登录",
+    type: "custom",
+    authenticate: async (a, n) => await (await fetch(
+      `${n}/auth/ssoLogin`,
+      {
+        headers: { "Content-Type": "application/json" },
+        method: "POST",
+        body: JSON.stringify({
+          ...a,
+          loginType: e
+        })
+      }
+    )).json(),
+    ...t
+  };
+}
+export {
+  o as default
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pubinfo/module-auth",
   "type": "module",
-  "version": "2.0.13",
+  "version": "2.0.14",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -23,10 +23,10 @@
     "node": "^20.19.0 || >=22.12.0"
   },
   "peerDependencies": {
-    "pubinfo": "2.0.13"
+    "pubinfo": "2.0.14"
   },
   "devDependencies": {
-    "pubinfo": "2.0.13"
+    "pubinfo": "2.0.14"
   },
   "scripts": {
     "dev": "pubinfo build --watch",

package/src/components/LoginWithFourA/index.ts

@@ -1,5 +1,5 @@
 import { defineComponent, h } from 'vue';
-import _4APNG from '@/assets/images/4A.png';
+import FourAPNG from '@/assets/images/4A.png';
 import { RedirectLogin } from '../RedirectLogin';
 
 export const LoginWithFourA = defineComponent({
@@ -11,6 +11,6 @@ export const LoginWithFourA = defineComponent({
     },
   },
   setup(props) {
-    return () => h(RedirectLogin, { id: '4A', src: _4APNG, color: props.color });
+    return () => h(RedirectLogin, { id: '4A', src: FourAPNG, color: props.color });
   },
 });

package/src/components/RedirectLogin/index.ts

@@ -1,5 +1,6 @@
 import { defineComponent, h } from 'vue';
-import { getProvider, signIn } from '@/core';
+import { signIn } from '@/core';
+import { getProvider } from '@/helper';
 
 export const RedirectLogin = defineComponent({
   name: 'RedirectLogin',

package/src/core.ts

@@ -1,35 +1,6 @@
-import type { ProviderUserConfig, Recordable, ThirdParty } from './interface';
+import type { 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;
-}
-
-/**
- * 构建第三方授权登录地址
- * @param provider
- */
-function createUrl(provider: ProviderUserConfig) {
-  const { authorization } = provider;
-
-  if (typeof authorization === 'function') {
-    return '';
-  }
-
-  const url = new URL(authorization?.url ?? '');
-  const params = new URLSearchParams(authorization?.params ?? {});
-
-  return `${url.toString()}?${params.toString()}`;
-}
+import { createUrl, createUrlByProvider, getProvider } from './helper';
 
 /**
  * 前往登录
@@ -38,14 +9,13 @@ function createUrl(provider: ProviderUserConfig) {
  */
 export async function signIn(id: ThirdParty, options?: Recordable) {
   const provider = getProvider(id);
-  const { type, authorization } = provider;
 
-  if (typeof authorization === 'function') {
-    return await authorization(options);
+  if (typeof provider.signIn === 'function') {
+    return await provider.signIn(options);
   }
 
-  if (type === 'oauth' || type === 'custom') {
-    const url = createUrl(provider);
+  if (['oauth', 'custom'].includes(provider.type)) {
+    const url = createUrlByProvider(provider);
     window.location.replace(url);
   }
 }
@@ -58,11 +28,10 @@ export async function signIn(id: ThirdParty, options?: Recordable) {
  */
 export function renderQRCode(id: ThirdParty, options: { id: string } & Recordable) {
   const provider = getProvider(id);
-  const { type, initQRCode } = provider;
 
-  if (type === 'oauth' || type === 'custom') {
-    const url = createUrl(provider);
-    initQRCode?.(url, options);
+  if (['oauth', 'custom'].includes(provider.type)) {
+    const url = createUrlByProvider(provider);
+    provider.initQRCode?.(url, options);
   }
 }
 
@@ -70,22 +39,23 @@ export function renderQRCode(id: ThirdParty, options: { id: string } & Recordabl
  * 认证
  * @param id 第三方的唯一值
  */
-export async function authentication(id: ThirdParty) {
+export async function authenticate(id: ThirdParty) {
   const provider = getProvider(id);
   const { baseURL } = ctx.use();
-  const { type, callbackUrl } = provider;
 
   // TODO 处理hash路由中的#
   // 获取URL上的参数
   const qs = window.location.href.split('?')?.[1] ?? '';
   const params = new URLSearchParams(qs);
+  const paramsObject = Object.fromEntries(params.entries());
 
-  if (typeof callbackUrl === 'function') {
-    return await callbackUrl(Object.fromEntries(params.entries()), baseURL);
+  if (typeof provider.authenticate === 'function') {
+    return await provider.authenticate(paramsObject, baseURL);
   }
 
-  if (type === 'oauth' || type === 'cas' || type === 'custom') {
-    const response = await fetch(`${baseURL}${callbackUrl}?${params.toString()}`);
+  if (['oauth', 'cas', 'custom'].includes(provider.type)) {
+    const url = createUrl(`${baseURL}${provider.authenticate}`, paramsObject);
+    const response = await fetch(url);
     return await response.json();
   }
 }
@@ -100,6 +70,6 @@ export function redirect() {
     return;
   }
 
-  const url = createUrl(provider);
+  const url = createUrlByProvider(provider);
   window.location.replace(url);
 }

package/src/helper.ts

@@ -0,0 +1,77 @@
+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;
+}
+
+/**
+ * 构建第三方授权登录地址
+ * @param provider
+ */
+export function createUrlByProvider(provider: ProviderUserOptions) {
+  const { signIn } = provider;
+
+  if (typeof signIn === 'function') {
+    return '';
+  }
+
+  return createUrl(signIn?.url, signIn?.params);
+}
+
+/**
+ * 构建携带 `params` 的 URL
+ * @param url
+ * @param params
+ */
+export function createUrl(url: string = '', params: Recordable = {}) {
+  const _url = new URL(url);
+  const _params = new URLSearchParams(_url.search);
+
+  // 合并参数
+  for (const [key, value] of Object.entries(params)) {
+    _params.set(key, value);
+  }
+
+  _url.search = _params.toString();
+
+  return _url.toString();
+}
+
+/**
+ * 读取 `URL` 上的 `params` 参数
+ * @param url
+ */
+export function readUrlParams(url?: string): URLSearchParams {
+  const { href, search, hash } = url ? new URL(url) : window.location;
+
+  // 1.优先从 search（history 模式）拿
+  if (search) {
+    return new URLSearchParams(search);
+  };
+
+  // 2.再尝试从 hash（hash 模式）里拿
+  // 可能是 /#/callback?code=xxx
+  const hashIndex = hash.indexOf('?');
+  if (hashIndex !== -1) {
+    return new URLSearchParams(hash.slice(hashIndex));
+  }
+
+  // 3.fallback：尝试整个 URL
+  const qsIndex = href.indexOf('?');
+  if (qsIndex !== -1) {
+    return new URLSearchParams(href.slice(qsIndex));
+  }
+
+  // 4.否则返回空
+  return new URLSearchParams();
+}

package/src/index.ts

@@ -3,7 +3,7 @@ import type { RouteRecordRaw } from 'vue-router';
 import type { AuthOptions } from './interface';
 import { cleanup } from 'pubinfo';
 import { ctx } from './context';
-import { authentication, redirect } from './core';
+import { authenticate, redirect } from './core';
 import { PageAuth } from './pages/auth';
 
 export function auth(options: AuthOptions): ModuleOptions {
@@ -33,7 +33,7 @@ export function auth(options: AuthOptions): ModuleOptions {
         },
         props: route => ({
           type: route.params.type,
-          authentication,
+          authenticate,
           redirectTo() {
             if (typeof redirectTo === 'function') {
               redirectTo();
@@ -69,7 +69,7 @@ export function auth(options: AuthOptions): ModuleOptions {
 export { LoginWithFourA } from './components/LoginWithFourA';
 
 export {
-  authentication,
+  authenticate,
   redirect,
   renderQRCode,
   signIn,

package/src/interface.ts

@@ -5,7 +5,7 @@ export type Fn<T = any, K = any> = (params?: Recordable & T) => Promise<K> | K;
 export type FnApi<T = any> = (params: Recordable & T, baseURL: string) => Promise<any>;
 
 export interface AuthOptions {
-  /** 登录后重定向至 */
+  /** 登录后默认重定向至 */
   redirectTo?: RouteLocationRaw | Fn
 
   /** 页面配置 */
@@ -17,21 +17,21 @@ export interface AuthOptions {
   /** 接口的baseURL */
   baseURL: string
 
-  providers?: ProviderConfig[]
+  providers?: ProviderOptions[]
 }
 
 export interface InternalContext {
   /** 接口的baseURL */
   baseURL: string
 
-  providers?: ProviderConfig[]
+  providers?: ProviderOptions[]
 }
 
 /** 第三方类型 */
 export type ThirdParty = string;
-export type ProviderUserConfig = Partial<ProviderConfig>;
+export type ProviderUserOptions = Partial<ProviderOptions>;
 
-export interface ProviderConfig {
+export interface ProviderOptions {
   /** 唯一值 */
   id: string
 
@@ -47,16 +47,10 @@ export interface ProviderConfig {
   type: 'oauth' | 'cas' | 'custom'
 
   /** 授权登录地址 */
-  authorization?: Authorization | Fn
-
-  /** `client_id` */
-  clientId?: string
-
-  /** `redirect_uri` */
-  redirectUri?: string
+  signIn?: Authorization | Fn
 
   /** 授权登录接口 */
-  callbackUrl?: string | FnApi
+  authenticate?: string | FnApi
 
   /** 初始化二维码 */
   initQRCode?: (url: string, params: { id: string } & Recordable) => Promise<void> | void

package/src/pages/auth.ts

@@ -5,17 +5,28 @@ export const PageAuth = defineComponent({
   props: {
     type: String,
     redirectTo: Function,
-    authentication: Function,
+    authenticate: Function,
   },
   setup(props) {
     const userStore = useUserStore();
+    const route = useRoute();
+    const router = useRouter();
 
     const message = ref('授权登录中...');
 
     onMounted(async () => {
-      const res = await props.authentication?.(props.type);
+      const res = await props.authenticate?.(props.type);
       if (res?.success) {
         userStore.setToken(res?.data?.accessToken, res?.data?.refreshToken);
+
+        // 读取路由上的 redirect 参数
+        const redirect = route.query.redirect?.toString();
+        if (redirect) {
+          router.push(redirect);
+          return;
+        }
+
+        // 默认的重定向地址
         props?.redirectTo?.();
       }
       else {

package/src/providers/4A.ts

@@ -1,16 +1,28 @@
-import type { ProviderConfig, ProviderUserConfig } from '../interface';
+import type { ProviderOptions, ProviderUserOptions } from '../interface';
+
+export interface FourAOptions extends ProviderUserOptions {
+  /** `client_id` */
+  clientId?: string
+
+  /** `redirect_uri` */
+  redirectUri?: string
+}
 
 /**
- * 4A登录
+ * `4A 统一认证`
+ *
+ * - 携带 `client_id` 和 `redirect_uri`，前往 [4A认证中心](http://134.108.76.137:7001/index) 进行登录；
+ * - 成功登录后，4A认证中心会回调 `redirect_uri` 并携带参数；
+ * - 当前 `provider` 将获取参数值并调用 `/bs/loginBy4a` 完成登录认证。
  */
-export default function FourA(options: ProviderUserConfig): ProviderConfig {
+export default function FourA(options: FourAOptions): ProviderOptions {
   const { clientId, redirectUri } = options;
 
   return {
     id: '4A',
     name: '4A登录',
     type: 'oauth',
-    authorization: {
+    signIn: {
       url: 'http://134.108.76.137:7001/index',
       params: {
         response_type: 'code',
@@ -18,7 +30,7 @@ export default function FourA(options: ProviderUserConfig): ProviderConfig {
         redirect_uri: redirectUri,
       },
     },
-    callbackUrl: '/bs/loginBy4a',
+    authenticate: '/bs/loginBy4a',
     ...options,
   };
 }

package/src/providers/credentials.ts

@@ -1,19 +1,15 @@
-import type { Fn, ProviderConfig } from '../interface';
+import type { ProviderOptions, ProviderUserOptions } from '../interface';
 
-interface CredentialsConfig {
-  authorize: Fn<any>
-}
+export interface CredentialsOptions extends ProviderUserOptions {}
 
 /**
  * 凭证登录
  */
-export default function Credentials(options: CredentialsConfig): ProviderConfig {
-  const { authorize } = options;
-
+export default function Credentials(options?: CredentialsOptions): ProviderOptions {
   return {
     id: 'credentials',
     name: '凭证登录',
     type: 'custom',
-    authorization: authorize,
+    ...options,
   };
 }