@pubinfo/core 2.1.0 → 2.1.2

package/src/built-in/pinia-plugin/plugins/persistedstate/types.ts

@@ -0,0 +1,162 @@
+import type { PiniaPluginContext, StateTree } from 'pinia';
+
+/**
+ * 存储区域类型：本地存储或会话存储
+ */
+export type StorageArea = 'local' | 'session';
+
+/**
+ * 类似 Storage 的接口，用于抽象存储操作
+ */
+export interface StorageLike {
+  /** 获取指定键的值 */
+  getItem: (key: string) => string | null
+  /** 设置指定键的值 */
+  setItem: (key: string, value: string) => void
+}
+
+/**
+ * 序列化器接口，用于状态的序列化和反序列化
+ */
+export interface Serializer {
+  /** 将状态对象序列化为字符串 */
+  serialize: (data: StateTree) => string
+  /** 将字符串反序列化为状态对象 */
+  deserialize: (data: string) => StateTree
+}
+
+/**
+ * 持久化配置接口
+ */
+export interface Persistence<State extends StateTree = StateTree> {
+  /** 存储键名 */
+  key: string
+  /** 是否开启调试模式 */
+  debug: boolean
+  /** 存储实例 */
+  storage: StorageLike
+  /** 序列化器 */
+  serializer: Serializer
+  /** 恢复数据前的钩子 */
+  beforeHydrate?: (context: PiniaPluginContext) => void
+  /** 恢复数据后的钩子 */
+  afterHydrate?: (context: PiniaPluginContext) => void
+  /** 要持久化的状态字段（白名单） */
+  pick?: string[]
+  /** 不需要持久化的状态字段（黑名单） */
+  omit?: string[]
+}
+
+/**
+ * 插件基础配置选项
+ */
+export interface BasePluginOptions {
+  /** 存储实例 */
+  storage?: StorageLike
+  /** 序列化器 */
+  serializer?: Serializer
+  /** 是否开启调试模式 */
+  debug?: boolean
+  /** 存储键名生成函数 */
+  key?: (storeKey: string) => string
+  /** 是否自动为所有 store 启用持久化 */
+  auto?: boolean
+}
+
+/**
+ * 持久化选项类型（提供给 store 使用）
+ */
+export type PersistenceOptions<State extends StateTree = StateTree> = Partial<Omit<Persistence<State>, 'key'>> & {
+  /** 自定义存储键名 */
+  key?: string
+};
+
+/**
+ * 扩展的持久化选项，包含存储区域配置
+ */
+export type ExtendedPersistenceOptions<State extends StateTree = StateTree> = PersistenceOptions<State> & {
+  /** 存储区域类型 */
+  storageArea?: StorageArea
+};
+
+/**
+ * 自定义存储事件详情
+ */
+export interface CustomStorageEventDetail {
+  /** 变化的键名，null 表示清空操作 */
+  key: string | null
+  /** 新值 */
+  newValue: string | null
+  /** 旧值 */
+  oldValue: string | null
+  /** 存储区域 */
+  storageArea: StorageArea
+}
+
+/**
+ * 标准化后的全局配置选项
+ */
+export interface NormalizedGlobalOptions {
+  /** 键名生成函数 */
+  key: (storeKey: string) => string
+  /** 序列化器 */
+  serializer: Serializer
+  /** 存储实例 */
+  storage?: StorageLike
+  /** 存储区域 */
+  storageArea?: StorageArea
+  /** 是否开启调试 */
+  debug: boolean
+  /** 是否自动持久化 */
+  auto: boolean
+}
+
+/**
+ * 持久化条目，包含完整的配置信息
+ */
+export interface PersistenceEntry<State extends StateTree = StateTree> {
+  /** 存储键名 */
+  key: string
+  /** 存储实例 */
+  storage: StorageLike
+  /** 序列化器 */
+  serializer: Serializer
+  /** 存储区域 */
+  storageArea?: StorageArea
+  /** 完整的存储键名（用于同步监听） */
+  fullKey?: string
+  /** 是否开启调试 */
+  debug: boolean
+  /** 恢复前钩子 */
+  beforeHydrate?: (context: PiniaPluginContext) => void
+  /** 恢复后钩子 */
+  afterHydrate?: (context: PiniaPluginContext) => void
+  /** 白名单字段 */
+  pick?: PersistenceOptions<State>['pick']
+  /** 黑名单字段 */
+  omit?: PersistenceOptions<State>['omit']
+}
+
+/**
+ * 存储绑定，关联 store 和持久化配置
+ */
+export interface StorageBinding<State extends StateTree = StateTree> {
+  /** Pinia 插件上下文 */
+  context: PiniaPluginContext
+  /** 持久化条目 */
+  entry: PersistenceEntry<State>
+  /** 跳过持久化次数（用于避免循环） */
+  skipPersist: number
+  /** 停止订阅的函数 */
+  stopSubscription: () => void
+  /** 初始状态快照 */
+  initialState: StateTree
+}
+
+/**
+ * 同步持久化状态插件的配置选项
+ */
+export interface SyncedPersistedStateOptions extends BasePluginOptions {
+  /** 存储区域 */
+  storageArea?: StorageArea
+}

package/src/built-in/pinia-plugin/plugins/persistedstate/utils.ts

@@ -0,0 +1,46 @@
+import type { CustomStorageEventDetail, StorageArea } from './types';
+
+/** 自定义事件名称，用于跨标签页通信 */
+export const CUSTOM_EVENT = 'pubinfo:persistedstate:local';
+
+/**
+ * 调度微任务，优先使用原生 queueMicrotask
+ */
+export const scheduleMicrotask = typeof queueMicrotask === 'function'
+  ? queueMicrotask
+  : (fn: () => void) => {
+      Promise.resolve().then(fn);
+    };
+
+/**
+ * 解析存储区域类型
+ * @param storage - Storage 实例
+ * @returns 存储区域类型或 undefined
+ */
+export function resolveStorageArea(storage: Storage | null | undefined): StorageArea | undefined {
+  if (!storage || typeof window === 'undefined') {
+    return undefined;
+  }
+  try {
+    if (storage === window.localStorage) {
+      return 'local';
+    }
+    if (storage === window.sessionStorage) {
+      return 'session';
+    }
+  }
+  catch {
+    return undefined;
+  }
+  return undefined;
+}
+
+/**
+ * 分发本地 storage 变更事件
+ */
+export function dispatchLocalMutation(detail: CustomStorageEventDetail) {
+  if (typeof window === 'undefined' || typeof window.CustomEvent !== 'function' || typeof window.dispatchEvent !== 'function') {
+    return;
+  }
+  window.dispatchEvent(new CustomEvent<CustomStorageEventDetail>(CUSTOM_EVENT, { detail }));
+}

package/src/core/ctx.ts

@@ -1,5 +1,5 @@
 import { createHooks } from 'hookable';
-import { getPubinfoNamespace } from '../utils/global';
+import { getPubinfoNamespace } from './utils';
 
 const HOOKS_KEY = '__pubinfo_core_hooks__';
 type HookStore = ReturnType<typeof createHooks>;
@@ -21,3 +21,26 @@ export async function callHookAsync<T>(hookname: string, data: T) {
     data,
   );
 }
+
+export function callHookSync<T>(hookname: string, data: T) {
+  return hooks.callHookWith(
+    (hookFns, args) => {
+      let res = args[0] as T;
+      if (!hookFns.length) {
+        return res;
+      }
+      for (const fn of hookFns) {
+        const output = fn(res);
+        if (output && typeof (output as PromiseLike<unknown>).then === 'function') {
+          throw new Error(`[hooks] "${hookname}" 当前仅支持同步回调`);
+        }
+        if (typeof output !== 'undefined') {
+          res = output as T;
+        }
+      }
+      return res;
+    },
+    hookname,
+    data,
+  );
+}

package/src/core/interface.ts

@@ -1,7 +1,7 @@
 import type { AdapterCreateOptions, AlovaAxiosRequestConfig } from '@alova/adapter-axios';
 import type { Alova, AlovaGenerics, AlovaOptions, Method, ResponseCompleteHandler, ResponseErrorHandler } from 'alova';
 import type { AxiosResponse, AxiosResponseHeaders } from 'axios';
-import type { Pinia } from 'pinia';
+import type { Pinia, StateTree } from 'pinia';
 import type { App, Component } from 'vue';
 import type { Router, RouterOptions as VueRouterOptions } from 'vue-router';
 import type { MenuData, RouteData } from '@/features';
@@ -100,6 +100,12 @@ export interface Hooks {
 
   /** 路由数据转换 */
   'route:transform': (routeData: RouteData[]) => RouteData[] | Promise<RouteData[]>
+
+  /** Pinia 持久化写入前处理（需同步返回） */
+  'pinia:persist:write': (payload: PiniaPersistWriteHookPayload) => PiniaPersistWriteHookPayload
+
+  /** Pinia 持久化读取前处理（需同步返回） */
+  'pinia:persist:read': (payload: PiniaPersistReadHookPayload) => PiniaPersistReadHookPayload
 }
 
 // overwrite alova
@@ -110,3 +116,27 @@ export interface RespondedHandlerRecord<AG extends AlovaGenerics> {
   onError?: ResponseErrorHandler<AG>
   onComplete?: ResponseCompleteHandler<AG>
 }
+
+export interface PiniaPersistHookBasePayload {
+  storeId: string
+  /** 实际存储键 */
+  key: string
+  /** local 或 session */
+  storageArea?: 'local' | 'session'
+  /** 仅在 localStorage 同步时可用 */
+  fullKey?: string
+}
+
+export interface PiniaPersistWriteHookPayload extends PiniaPersistHookBasePayload {
+  /** 序列化后的字符串 */
+  value: string
+  /** 过滤后的状态对象 */
+  state: StateTree
+}
+
+export interface PiniaPersistReadHookPayload extends PiniaPersistHookBasePayload {
+  /** 从存储读取的原始字符串 */
+  value: string
+  /** 实际读取数据的键 */
+  sourceKey?: string
+}

package/src/core/resolver/icon.ts

@@ -1,5 +1,5 @@
 import type { ModuleRecord } from './resolver';
-import { getPubinfoNamespace } from '../../utils/global';
+import { getPubinfoNamespace } from '../utils';
 import { loadProjectModules, readProjectModules } from './resolver';
 
 // 持久化图标模块，支持 HMR 后恢复

package/src/core/utils/index.ts

@@ -0,0 +1,2 @@
+export * from './global';
+export * from './utils';

package/src/features/composables/index.ts

@@ -1,4 +1,5 @@
 export * from './auth';
 export * from './log';
+export * from './partyLogin';
 export * from './theme';
 export * from './watchDiff';

package/src/features/composables/partyLogin.ts

@@ -1,28 +1,36 @@
+import type { Pinia } from 'pinia';
 import type { PartyLoginConfig, PartyLoginParamItem } from '../components/PartyLogin/type';
+import { getActivePinia } from 'pinia';
 import { ref } from 'vue';
-import {
-  useFavoritesStore,
-  useIframeStore,
-  useKeepAliveStore,
-  useMenuStore,
-  useRouteStore,
-  useSettingsStore,
-  useTabbarStore,
-  useUserStore,
-} from '@/features/stores';
-
-// Store 名称映射表
-const STORE_MAP: Record<string, () => any> = {
-  user: useUserStore,
-  settings: useSettingsStore,
-  menu: useMenuStore,
-  route: useRouteStore,
-  tabbar: useTabbarStore,
-  iframe: useIframeStore,
-  keepAlive: useKeepAliveStore,
-  favorites: useFavoritesStore,
+
+export {
+  PartyLoginConfig,
 };
 
+const SUPPORTED_STORE_IDS = new Set([
+  'user',
+  'settings',
+  'menu',
+  'route',
+  'tabbar',
+  'iframe',
+  'keepAlive',
+  'favorites',
+]);
+
+const missingPiniaWarnings = new Set<string>();
+
+function warnMissingPinia(storeName: string) {
+  if (missingPiniaWarnings.has(storeName)) {
+    return;
+  }
+  missingPiniaWarnings.add(storeName);
+  console.warn(
+    `[usePartyLogin] Pinia instance is not ready when trying to access the "${storeName}" store. `
+    + 'Provide a Pinia instance via usePartyLogin(..., { pinia }) or ensure Pinia is registered before calling this hook.',
+  );
+}
+
 /**
  * 根据路径获取对象的嵌套值
  * @param obj 目标对象
@@ -48,6 +56,11 @@ function getNestedValue(obj: any, path: string): any {
   return result ?? '';
 }
 
+function getStoreFromPinia(pinia: Pinia | undefined, storeName: string) {
+  const storeMap = (pinia as any)?._s as Map<string, any> | undefined;
+  return storeMap?.get(storeName);
+}
+
 /**
  * 解析参数值
  *
@@ -95,6 +108,7 @@ function getNestedValue(obj: any, path: string): any {
 function resolveParamValue(
   item: PartyLoginParamItem,
   previousResponse?: Record<string, any>,
+  pinia?: Pinia,
 ): string | number | boolean {
   switch (item.type) {
     case 'string':
@@ -116,13 +130,23 @@ function resolveParamValue(
       }
 
       try {
-        const useStore = STORE_MAP[storeName];
-        if (!useStore) {
-          console.warn(`Store "${storeName}" not found in STORE_MAP`);
+        if (!SUPPORTED_STORE_IDS.has(storeName)) {
+          console.warn(`Store "${storeName}" is not supported in usePartyLogin.`);
+          return '';
+        }
+
+        const activePinia = pinia ?? getActivePinia();
+        if (!activePinia) {
+          warnMissingPinia(storeName);
+          return '';
+        }
+
+        const store = getStoreFromPinia(activePinia, storeName);
+        if (!store) {
+          warnMissingStore(storeName);
           return '';
         }
 
-        const store = useStore();
         return getNestedValue(store, fieldPath);
       }
       catch (error) {
@@ -151,12 +175,13 @@ function resolveParamValue(
 function buildParams(
   params: PartyLoginParamItem[],
   previousResponse?: Record<string, any>,
+  pinia?: Pinia,
 ): Record<string, any> {
   const result: Record<string, any> = {};
 
   params.forEach((item) => {
     if (item.key) {
-      result[item.key] = resolveParamValue(item, previousResponse);
+      result[item.key] = resolveParamValue(item, previousResponse, pinia);
     }
   });
 
@@ -173,16 +198,112 @@ function buildOAuthUrl(
   baseUrl: string,
   params: PartyLoginParamItem[],
   previousResponse?: Record<string, any>,
+  pinia?: Pinia,
 ): string {
-  const queryParams = buildParams(params, previousResponse);
+  const queryParams = buildParams(params, previousResponse, pinia);
+  const entries = Object.entries(queryParams);
+
+  if (entries.length === 0) {
+    return safeDecodeUrl(baseUrl);
+  }
 
-  const url = new URL(baseUrl);
-  Object.entries(queryParams).forEach(([key, value]) => {
-    url.searchParams.append(key, String(value));
+  const searchParams = new URLSearchParams();
+  entries.forEach(([key, value]) => {
+    searchParams.append(key, String(value));
   });
+  const serializedParams = searchParams.toString();
+
+  const hashIndex = baseUrl.indexOf('#');
+  const hasHash = hashIndex >= 0;
+  const basePart = hasHash ? baseUrl.slice(0, hashIndex) : baseUrl;
+  const hashContent = hasHash ? baseUrl.slice(hashIndex + 1) : '';
+
+  if (hasHash && shouldAppendParamsToHash(hashContent)) {
+    const hashWithQuery = appendParamsToHash(hashContent, serializedParams);
+    const finalUrl = `${basePart}#${hashWithQuery}`;
+    return safeDecodeUrl(finalUrl);
+  }
+
+  const baseWithQuery = appendParamsToBaseUrl(basePart, searchParams, serializedParams);
+  const finalUrl = hasHash ? `${baseWithQuery}#${hashContent}` : baseWithQuery;
 
   // 解码 URL,将编码的中文转换为可读形式
-  return decodeURIComponent(url.toString());
+  return safeDecodeUrl(finalUrl);
+}
+
+function shouldAppendParamsToHash(hashContent: string): boolean {
+  if (!hashContent) {
+    return false;
+  }
+
+  const trimmed = hashContent.trim();
+  if (!trimmed) {
+    return false;
+  }
+
+  return trimmed.startsWith('/')
+    || trimmed.startsWith('!/')
+    || trimmed.startsWith('?');
+}
+
+function appendParamsToHash(hashContent: string, serializedParams: string): string {
+  if (!serializedParams) {
+    return hashContent;
+  }
+
+  if (!hashContent) {
+    return `?${serializedParams}`;
+  }
+
+  const separator = resolveQuerySeparator(hashContent);
+  return `${hashContent}${separator}${serializedParams}`;
+}
+
+function appendParamsToBaseUrl(
+  baseUrl: string,
+  params: URLSearchParams,
+  serializedParams: string,
+): string {
+  if (!serializedParams) {
+    return baseUrl;
+  }
+
+  if (!baseUrl) {
+    return `?${serializedParams}`;
+  }
+
+  try {
+    const url = new URL(baseUrl);
+    params.forEach((value, key) => {
+      url.searchParams.append(key, value);
+    });
+    return url.toString();
+  }
+  catch {
+    const separator = resolveQuerySeparator(baseUrl);
+    return `${baseUrl}${separator}${serializedParams}`;
+  }
+}
+
+function resolveQuerySeparator(baseUrl: string): string {
+  if (!baseUrl) {
+    return '?';
+  }
+
+  if (!baseUrl.includes('?')) {
+    return '?';
+  }
+
+  return /[?&]$/.test(baseUrl) ? '' : '&';
+}
+
+function safeDecodeUrl(value: string): string {
+  try {
+    return decodeURIComponent(value);
+  }
+  catch {
+    return value;
+  }
 }
 
 /**
@@ -278,13 +399,27 @@ function deepParseJSON(obj: any): any {
   return obj;
 }
 
+export interface UsePartyLoginOptions {
+  execute?: boolean
+  pinia?: Pinia
+}
+
 /**
  * Party Login Hook
  * 处理第三方登录的多步骤流程
  * @param config Party Login 配置
  * @param targetUrl 目标跳转 URL (来自 meta.link 或 meta.iframe)
  */
-export async function usePartyLogin(config: PartyLoginConfig, targetUrl: string) {
+export async function usePartyLogin(
+  config: PartyLoginConfig,
+  targetUrl: string,
+  options: UsePartyLoginOptions = {},
+) {
+  const {
+    execute: shouldAutoExecute = true,
+    pinia: injectedPinia,
+  } = options;
+
   const url = ref<string>('');
   const loading = ref(false);
   const error = ref<Error | null>(null);
@@ -319,12 +454,13 @@ export async function usePartyLogin(config: PartyLoginConfig, targetUrl: string)
     }
 
     const { url: requestUrl, method, params } = step1.request;
+    const activePinia = injectedPinia ?? getActivePinia();
 
     // 构建第一步请求的各类参数（此时还没有 previousResponse，所以传 undefined）
-    const queryParams = params.query ? buildParams(params.query) : {};
-    const bodyParams = params.body ? buildParams(params.body) : {};
-    const headerParams = params.header ? buildParams(params.header) : {};
-    const cookieParams = params.cookie ? buildParams(params.cookie) : {};
+    const queryParams = params.query ? buildParams(params.query, undefined, activePinia) : {};
+    const bodyParams = params.body ? buildParams(params.body, undefined, activePinia) : {};
+    const headerParams = params.header ? buildParams(params.header, undefined, activePinia) : {};
+    const cookieParams = params.cookie ? buildParams(params.cookie, undefined, activePinia) : {};
 
     // 构建请求头
     const headers: Record<string, string> = {};
@@ -397,6 +533,7 @@ export async function usePartyLogin(config: PartyLoginConfig, targetUrl: string)
         targetUrl,
         step2.oauth.params,
         responseData,
+        activePinia,
       );
 
       url.value = oauthUrl;
@@ -411,8 +548,10 @@ export async function usePartyLogin(config: PartyLoginConfig, targetUrl: string)
     }
   }
 
-  // 自动执行
-  await execute();
+  if (shouldAutoExecute) {
+    // 自动执行
+    await execute();
+  }
 
   return {
     url,
@@ -421,3 +560,6 @@ export async function usePartyLogin(config: PartyLoginConfig, targetUrl: string)
     execute,
   };
 }
+function warnMissingStore(storeName: string) {
+  console.warn(`[usePartyLogin] Store "${storeName}" is not registered in Pinia.`);
+}

package/src/features/context/index.ts

@@ -1,7 +1,7 @@
 import type { Router } from 'vue-router';
 import type { RequestInstance } from '@/core';
 
-import { createContext } from '@/utils';
+import { createContext } from '../../core/utils';
 
 interface InternalContext {
   router: Router

package/src/index.ts

@@ -107,19 +107,21 @@ export {
   readProjectModules,
 } from './core';
 export * from './core/interface';
+export {
+  clearPersistedState,
+  createContext,
+  getPersistedState,
+  getPubinfoNamespace,
+  setPersistedState,
+} from './core/utils';
 
 export * from './features';
 
 export {
   cleanup,
   cleanupWithoutUser,
-  clearPersistedState,
-  createContext,
   createRawContext,
-  getPersistedState,
-  getPubinfoNamespace,
   publicKeyEncryption,
-  setPersistedState,
   storage,
   wrapProxy,
 } from './utils';

package/src/utils/index.ts

@@ -1,5 +1,4 @@
 export * from './cleanup';
-export * from './global';
 export * from './path';
 export * from './proxy';
 export * from './publicKey';

package/src/utils/proxy.ts

@@ -1,4 +1,4 @@
-import { getPersistedState } from './global';
+import { getPersistedState } from '../core/utils';
 
 export function wrapProxy<T extends Record<K, any>, K extends keyof T>(
   fn: () => T,

package/types/index.d.ts

@@ -2,6 +2,7 @@ import './favorites.d.ts';
 import './iframe.d.ts';
 import './menu.d.ts';
 import './module.d.ts';
+import './pinia.d.ts';
 import './settings.d.ts';
 import './tabbar.d.ts';
 import './user.d.ts';