@pubinfo/module-auth 2.0.0-beta.32 → 2.0.0-rc.1

package/dist/index.d.ts

@@ -1,38 +1,34 @@
-import { AuthConfig, AuthOptions, Authorization, Fn, FnApi, ProviderConfig, ProviderUserConfig, Recordable, ThirdParty } from "./interface-CSPrYibH.js";
+import { AuthOptions, Authorization, Fn, FnApi, InternalContext, ProviderConfig, ProviderUserConfig, Recordable, ThirdParty } from "./interface-CqwWb8Fb.js";
 import { ModuleOptions } from "pubinfo";
 
 //#region src/core.d.ts
+
+/**
+ * 前往登录
+ * @param id 唯一值
+ * @param options 登录时需要传递的参数
+ */
+declare function signIn(id: ThirdParty, options?: Recordable): Promise<any>;
+/**
+ * 生成二维码
+ * @param id 第三方的唯一值
+ * @param options 生成二维码需要传递的参数
+ * @param options.id `getElementById`中指定的`id`
+ */
+declare function renderQRCode(id: ThirdParty, options: {
+  id: string;
+} & Recordable): void;
+/**
+ * 认证
+ * @param id 第三方的唯一值
+ */
+declare function authentication(id: ThirdParty): Promise<any>;
 /**
- * 初始化
+ * 重定向至统一登录页
  */
-declare function createAuth(config?: AuthConfig): {
-  /**
-   * 前往登录
-   * @param id 唯一值
-   * @param options 登录时需要传递的参数
-   */
-  signIn(id: ThirdParty, options?: Recordable): Promise<any>;
-  /**
-   * 生成二维码
-   * @param id 第三方的唯一值
-   * @param options 生成二维码需要传递的参数
-   * @param options.id `getElementById`中指定的`id`
-   */
-  renderQRCode(id: ThirdParty, options: {
-    id: string;
-  } & Recordable): void;
-  /**
-   * 认证
-   * @param id 第三方的唯一值
-   */
-  authentication(id: ThirdParty): Promise<any>;
-  /**
-   * 重定向至统一登录页
-   */
-  redirect(): void;
-};
+declare function redirect(): void;
 //#endregion
 //#region src/index.d.ts
-declare function withModule(auth: ReturnType<typeof createAuth>, options?: AuthOptions): ModuleOptions;
+declare function auth(options: AuthOptions): ModuleOptions;
 //#endregion
-export { AuthConfig, AuthOptions, Authorization, Fn, FnApi, ProviderConfig, ProviderUserConfig, Recordable, ThirdParty, createAuth, withModule };
+export { AuthOptions, Authorization, Fn, FnApi, InternalContext, ProviderConfig, ProviderUserConfig, Recordable, ThirdParty, auth, authentication, redirect, renderQRCode, signIn };

package/dist/index.js

@@ -1,6 +1,94 @@
-import { cleanup, useUserStore } from "pubinfo";
+import { cleanup, createContext, useUserStore } from "pubinfo";
 import { defineComponent, h, onMounted, ref } from "vue";
 
+//#region src/context.ts
+const g = globalThis;
+g.__PUBINFO__ = g.__PUBINFO__ || {};
+if (!g.__PUBINFO__.authCtx) g.__PUBINFO__.authCtx = createContext();
+const ctx = g.__PUBINFO__.authCtx;
+if (g.__PUBINFO__.authState) try {
+	ctx.set(g.__PUBINFO__.authState);
+} catch {}
+
+//#endregion
+//#region src/core.ts
+/**
+* 获取指定的 `Provider`
+* @param id
+*/
+function getProvider(id) {
+	const { providers } = ctx.use();
+	const provider = id ? providers?.find((provider$1) => provider$1.id === id) : providers?.[0];
+	if (!provider) throw new Error(`Provider '${id}' is not found.`);
+	return provider;
+}
+/**
+* 构建第三方授权登录地址
+* @param provider
+*/
+function createUrl(provider) {
+	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()}`;
+}
+/**
+* 前往登录
+* @param id 唯一值
+* @param options 登录时需要传递的参数
+*/
+async function signIn(id, options) {
+	const provider = getProvider(id);
+	const { type, authorization } = provider;
+	if (typeof authorization === "function") return await authorization(options);
+	if (type === "oauth" || type === "custom") {
+		const url = createUrl(provider);
+		window.location.replace(url);
+	}
+}
+/**
+* 生成二维码
+* @param id 第三方的唯一值
+* @param options 生成二维码需要传递的参数
+* @param options.id `getElementById`中指定的`id`
+*/
+function renderQRCode(id, options) {
+	const provider = getProvider(id);
+	const { type, initQRCode } = provider;
+	if (type === "oauth" || type === "custom") {
+		const url = createUrl(provider);
+		initQRCode?.(url, options);
+	}
+}
+/**
+* 认证
+* @param id 第三方的唯一值
+*/
+async function authentication(id) {
+	const provider = getProvider(id);
+	const { baseURL } = ctx.use();
+	const { type, callbackUrl } = provider;
+	const qs = window.location.href.split("?")?.[1] ?? "";
+	const params = new URLSearchParams(qs);
+	if (typeof callbackUrl === "function") return await callbackUrl(Object.fromEntries(params.entries()), baseURL);
+	if (type === "oauth" || type === "cas" || type === "custom") {
+		const response = await fetch(`${baseURL}${callbackUrl}?${params.toString()}`);
+		return await response.json();
+	}
+}
+/**
+* 重定向至统一登录页
+*/
+function redirect() {
+	const { providers } = ctx.use();
+	const provider = providers?.find((provider$1) => provider$1.type === "cas");
+	if (!provider) return;
+	const url = createUrl(provider);
+	window.location.replace(url);
+}
+
+//#endregion
 //#region src/pages/auth.ts
 const PageAuth = defineComponent({
 	props: {
@@ -30,82 +118,24 @@ const PageAuth = defineComponent({
 	}
 });
 
-//#endregion
-//#region src/core.ts
-/**
-* 初始化
-*/
-function createAuth(config = {}) {
-	const { baseURL = "", providers = [] } = config;
-	/**
-	* 获取指定的 `Provider`
-	* @param id
-	*/
-	function getProvider(id) {
-		const provider = id ? providers.find((provider$1) => provider$1.id === id) : providers[0];
-		if (!provider) throw new Error(`Provider '${id}' is not found.`);
-		return provider;
-	}
-	return {
-		async signIn(id, options) {
-			const provider = getProvider(id);
-			const { type, authorization } = provider;
-			if (typeof authorization === "function") return await authorization(options);
-			if (type === "oauth" || type === "custom") {
-				const url = createUrl(provider);
-				window.location.replace(url);
-			}
-		},
-		renderQRCode(id, options) {
-			const provider = getProvider(id);
-			const { type, initQRCode } = provider;
-			if (type === "oauth" || type === "custom") {
-				const url = createUrl(provider);
-				initQRCode?.(url, options);
-			}
-		},
-		async authentication(id) {
-			const provider = getProvider(id);
-			const { type, callbackUrl } = provider;
-			const qs = window.location.href.split("?")?.[1] ?? "";
-			const params = new URLSearchParams(qs);
-			if (typeof callbackUrl === "function") return await callbackUrl(Object.fromEntries(params.entries()), baseURL);
-			if (type === "oauth" || type === "cas" || type === "custom") {
-				const response = await fetch(`${baseURL}${callbackUrl}?${params.toString()}`);
-				return await response.json();
-			}
-		},
-		redirect() {
-			const provider = providers.find((provider$1) => provider$1.type === "cas");
-			if (!provider) return;
-			const url = createUrl(provider);
-			window.location.replace(url);
-		}
-	};
-}
-/**
-* 构建第三方授权登录地址
-* @param provider
-*/
-function createUrl(provider) {
-	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()}`;
-}
-
 //#endregion
 //#region src/index.ts
-function withModule(auth, options = {}) {
-	const { authentication, redirect } = auth;
-	const { redirectTo = "/", pages = {} } = options;
-	const { signIn = "/login" } = pages;
+function auth(options) {
+	const { redirectTo = "/", pages = {}, baseURL, providers } = options;
+	const { signIn: signIn$1 = "/login" } = pages;
+	ctx.set({
+		baseURL,
+		providers
+	});
+	globalThis.__PUBINFO__.authState = {
+		baseURL,
+		providers
+	};
 	return {
 		name: "pubinfo:auth",
 		enforce: "pre",
-		setup(ctx) {
-			const { router } = ctx;
+		setup(ctx$1) {
+			const { router } = ctx$1;
 			const ROUTE_AUTH = {
 				path: "/auth/:type",
 				name: "Auth",
@@ -128,11 +158,11 @@ function withModule(auth, options = {}) {
 					return to.fullPath;
 				}
 				if (to.name === ROUTE_AUTH.name) cleanup();
-				if (to.path === signIn) redirect();
+				if (to.path === signIn$1) redirect();
 			});
 		}
 	};
 }
 
 //#endregion
-export { createAuth, withModule };
+export { auth, authentication, redirect, renderQRCode, signIn };

package/dist/{interface-CSPrYibH.d.ts → interface-CqwWb8Fb.d.ts}

@@ -12,10 +12,13 @@ interface AuthOptions {
     /** 默认登录页 */
     signIn?: RouteLocationRaw;
   };
+  /** 接口的baseURL */
+  baseURL: string;
+  providers?: ProviderConfig[];
 }
-interface AuthConfig {
+interface InternalContext {
   /** 接口的baseURL */
-  baseURL?: string;
+  baseURL: string;
   providers?: ProviderConfig[];
 }
 /** 第三方类型 */
@@ -53,4 +56,4 @@ interface Authorization {
   params?: Recordable;
 }
 //#endregion
-export { AuthConfig, AuthOptions, Authorization, Fn, FnApi, ProviderConfig, ProviderUserConfig, Recordable, ThirdParty };
+export { AuthOptions, Authorization, Fn, FnApi, InternalContext, ProviderConfig, ProviderUserConfig, Recordable, ThirdParty };

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

@@ -1,4 +1,4 @@
-import { ProviderConfig, ProviderUserConfig } from "../interface-CSPrYibH.js";
+import { ProviderConfig, ProviderUserConfig } from "../interface-CqwWb8Fb.js";
 
 //#region src/providers/4A.d.ts
 

package/dist/providers/credentials.d.ts

@@ -1,4 +1,4 @@
-import { Fn, ProviderConfig } from "../interface-CSPrYibH.js";
+import { Fn, ProviderConfig } from "../interface-CqwWb8Fb.js";
 
 //#region src/providers/credentials.d.ts
 interface CredentialsConfig {

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

@@ -1,4 +1,4 @@
-import { ProviderConfig, ProviderUserConfig } from "../interface-CSPrYibH.js";
+import { ProviderConfig, ProviderUserConfig } from "../interface-CqwWb8Fb.js";
 
 //#region src/providers/ding-zj.d.ts
 interface DingZJConfig extends ProviderUserConfig {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pubinfo/module-auth",
   "type": "module",
-  "version": "2.0.0-beta.32",
+  "version": "2.0.0-rc.1",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -20,10 +20,10 @@
     "src"
   ],
   "peerDependencies": {
-    "pubinfo": "2.0.0-beta.32"
+    "pubinfo": "2.0.0-rc.1"
   },
   "devDependencies": {
-    "pubinfo": "2.0.0-beta.32"
+    "pubinfo": "2.0.0-rc.1"
   },
   "scripts": {
     "dev": "tsdown --watch src",

package/src/context.ts

@@ -0,0 +1,20 @@
+import type { InternalContext } from './interface';
+import { createContext } from 'pubinfo';
+
+// 持久化 auth 模块上下文，避免 HMR 后丢失 baseURL/providers
+const g = globalThis as any;
+g.__PUBINFO__ = g.__PUBINFO__ || {};
+if (!g.__PUBINFO__.authCtx) {
+  g.__PUBINFO__.authCtx = createContext<InternalContext>();
+}
+export const ctx = g.__PUBINFO__.authCtx as ReturnType<typeof createContext<InternalContext>>;
+
+// HMR 恢复
+if (g.__PUBINFO__.authState) {
+  try {
+    ctx.set(g.__PUBINFO__.authState);
+  }
+  catch {
+    // ignore
+  }
+}

package/src/core.ts

@@ -1,98 +1,17 @@
-import type { AuthConfig, ProviderUserConfig, Recordable, ThirdParty } from './interface';
+import type { ProviderUserConfig, Recordable, ThirdParty } from './interface';
+import { ctx } from './context';
 
 /**
- * 初始化
+ * 获取指定的 `Provider`
+ * @param id
  */
-export function createAuth(config: AuthConfig = {}) {
-  const {
-    baseURL = '',
-    providers = [],
-  } = config;
-
-  /**
-   * 获取指定的 `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;
+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 {
-    /**
-     * 前往登录
-     * @param id 唯一值
-     * @param options 登录时需要传递的参数
-     */
-    async signIn(id: ThirdParty, options?: Recordable) {
-      const provider = getProvider(id);
-      const { type, authorization } = provider;
-
-      if (typeof authorization === 'function') {
-        return await authorization(options);
-      }
-
-      if (type === 'oauth' || type === 'custom') {
-        const url = createUrl(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);
-      const { type, initQRCode } = provider;
-
-      if (type === 'oauth' || type === 'custom') {
-        const url = createUrl(provider);
-        initQRCode?.(url, options);
-      }
-    },
-
-    /**
-     * 认证
-     * @param id 第三方的唯一值
-     */
-    async authentication(id: ThirdParty) {
-      const provider = getProvider(id);
-      const { type, callbackUrl } = provider;
-
-      // TODO 处理hash路由中的#
-      // 获取URL上的参数
-      const qs = window.location.href.split('?')?.[1] ?? '';
-      const params = new URLSearchParams(qs);
-
-      if (typeof callbackUrl === 'function') {
-        return await callbackUrl(Object.fromEntries(params.entries()), baseURL);
-      }
-
-      if (type === 'oauth' || type === 'cas' || type === 'custom') {
-        const response = await fetch(`${baseURL}${callbackUrl}?${params.toString()}`);
-        return await response.json();
-      }
-    },
-
-    /**
-     * 重定向至统一登录页
-     */
-    redirect() {
-      const provider = providers.find(provider => provider.type === 'cas');
-      if (!provider) {
-        return;
-      }
-
-      const url = createUrl(provider);
-      window.location.replace(url);
-    },
-  };
+  return provider;
 }
 
 /**
@@ -111,3 +30,76 @@ function createUrl(provider: ProviderUserConfig) {
 
   return `${url.toString()}?${params.toString()}`;
 }
+
+/**
+ * 前往登录
+ * @param id 唯一值
+ * @param options 登录时需要传递的参数
+ */
+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 (type === 'oauth' || type === 'custom') {
+    const url = createUrl(provider);
+    window.location.replace(url);
+  }
+}
+
+/**
+ * 生成二维码
+ * @param id 第三方的唯一值
+ * @param options 生成二维码需要传递的参数
+ * @param options.id `getElementById`中指定的`id`
+ */
+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);
+  }
+}
+
+/**
+ * 认证
+ * @param id 第三方的唯一值
+ */
+export async function authentication(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);
+
+  if (typeof callbackUrl === 'function') {
+    return await callbackUrl(Object.fromEntries(params.entries()), baseURL);
+  }
+
+  if (type === 'oauth' || type === 'cas' || type === 'custom') {
+    const response = await fetch(`${baseURL}${callbackUrl}?${params.toString()}`);
+    return await response.json();
+  }
+}
+
+/**
+ * 重定向至统一登录页
+ */
+export function redirect() {
+  const { providers } = ctx.use();
+  const provider = providers?.find(provider => provider.type === 'cas');
+  if (!provider) {
+    return;
+  }
+
+  const url = createUrl(provider);
+  window.location.replace(url);
+}

package/src/index.ts

@@ -1,19 +1,23 @@
 import type { ModuleOptions } from 'pubinfo';
 import type { RouteRecordRaw } from 'vue-router';
-import type { createAuth } from './core';
 import type { AuthOptions } from './interface';
 import { cleanup } from 'pubinfo';
+import { ctx } from './context';
+import { authentication, redirect } from './core';
 import { PageAuth } from './pages/auth';
 
-export function withModule(auth: ReturnType<typeof createAuth>, options: AuthOptions = {}): ModuleOptions {
-  const { authentication, redirect } = auth;
+export function auth(options: AuthOptions): ModuleOptions {
   const {
     redirectTo = '/',
     pages = {},
+    baseURL,
+    providers,
   } = options;
-  const {
-    signIn = '/login',
-  } = pages;
+  const { signIn = '/login' } = pages;
+
+  ctx.set({ baseURL, providers });
+  // 缓存以便 HMR 恢复
+  (globalThis as any).__PUBINFO__.authState = { baseURL, providers };
 
   return {
     name: 'pubinfo:auth',

package/src/interface.ts

@@ -13,11 +13,16 @@ export interface AuthOptions {
     /** 默认登录页 */
     signIn?: RouteLocationRaw
   }
+
+  /** 接口的baseURL */
+  baseURL: string
+
+  providers?: ProviderConfig[]
 }
 
-export interface AuthConfig {
+export interface InternalContext {
   /** 接口的baseURL */
-  baseURL?: string
+  baseURL: string
 
   providers?: ProviderConfig[]
 }