@opendesign-plus-test/composables 0.0.1-rc.4 → 0.0.1-rc.6

package/dist/analytics/useAnalytics.d.ts

@@ -0,0 +1,12 @@
+import { InjectionKey, MaybeRef, WatchSource } from 'vue';
+type BubbleData = Record<string | symbol, any>;
+type DataSource<T = any> = MaybeRef<BubbleData> | ((val?: T | Event, old?: T) => Promise<BubbleData> | BubbleData);
+type ConfigOptions = {
+    key?: InjectionKey<any> | string;
+    bubble?: boolean;
+    catchBubble?: boolean;
+};
+export declare function useWatchAnalytics<T = any>(watchSource: WatchSource<T>, dataSource: DataSource<T>, options?: ConfigOptions): void;
+export declare function useElementEventAnalytics<T = any>(el: MaybeRef<HTMLElement>, event: string, dataSource: DataSource<T>, options?: ConfigOptions): void;
+export declare function useAnalytics<DS = any>(dataSource: DataSource<DS>, options: ConfigOptions): void;
+export {};

package/dist/core/useCheckbox.d.ts

@@ -0,0 +1,9 @@
+import { MaybeRefOrGetter } from 'vue';
+export declare const useCheckbox: <T>(datasource: MaybeRefOrGetter<T[]>, cbValueExtractor: (item: T) => string | number) => {
+    checkboxes: import('vue').Ref<(string | number)[], (string | number)[]>;
+    indeterminate: import('vue').Ref<boolean, boolean>;
+    parentCheckbox: import('vue').Ref<(string | number)[], (string | number)[]>;
+    isCheckedAll: import('vue').ComputedRef<boolean>;
+    clearCheckboxes: () => void;
+    checkAll: () => void;
+};

package/dist/core/useLogin.d.ts

@@ -0,0 +1,65 @@
+import { Ref } from 'vue';
+/**
+ * 登录状态枚举
+ */
+export declare enum LOGIN_STATUS {
+    FAILED = -1,// 登录失败
+    NOT = 0,// 未登录
+    DOING = 1,// 登录中
+    DONE = 2
+}
+/**
+ * 设置 CSRF Token 的 Cookie 键名
+ * @param key - Cookie 键名，默认为 '_U_T_'
+ */
+export declare const setLoginKeys: (key: string) => void;
+/**
+ * 获取当前存储的登录凭证
+ * @returns 包含 csrfCookie 的对象
+ */
+export declare const getUserAuth: () => {
+    csrfCookie: string | undefined;
+};
+/**
+ * 清除存储的登录凭证
+ */
+export declare const clearUserAuth: () => void;
+/**
+ * 跳转到登录页面
+ * @param loginUrl - 登录页面的 URL
+ */
+export declare const doLogin: (loginUrl: string) => void;
+/**
+ * 设置登录状态到 store
+ * @param status - 登录状态值
+ */
+export declare const setStatus: (status: LOGIN_STATUS) => void;
+/**
+ * 尝试自动登录并获取用户信息
+ * @param getUserInfo - 获取用户信息的异步函数
+ * @param noPrivacy - 是否跳过隐私检查，默认为 false
+ * @returns 用户信息或 undefined
+ */
+export declare const tryLogin: (getUserInfo: () => Promise<{
+    data?: any;
+}>, noPrivacy?: boolean) => Promise<any>;
+/**
+ * 执行退出登录操作
+ * @param logoutUrl - 退出登录后要跳转的 URL
+ */
+export declare const doLogout: (logoutUrl: string) => void;
+/**
+ * 监听路由变化，自动处理登录状态
+ * @param guardList - 需要登录的路由路径数组
+ * @param getUserInfo - 获取用户信息的异步函数
+ * @param userInfo - 用户信息的响应式引用
+ * @param noPrivacy - 是否跳过隐私检查，默认为 false
+ *
+ * 行为说明：
+ * - 监听立即生效（immediate: true）
+ * - 若目标路由在 guardList 中，等待 tryLogin 完成后再进入
+ * - 其他路由直接进入，同时在后台执行 tryLogin
+ */
+export declare const useLoginWatcher: (guardList: string[], getUserInfo: () => Promise<{
+    data?: any;
+}>, userInfo: Ref<any>, route: any, noPrivacy?: boolean) => void;

package/dist/core/useMdRender.d.ts

@@ -2,7 +2,7 @@ import { MarkdownItAsyncOptions } from 'markdown-it-async';
 import { BundledLanguage, BundledTheme } from 'shiki';
 export type * from 'markdown-it-async';
 export type * from 'shiki';
-export interface UseMdOptions extends MarkdownItAsyncOptions {
+export interface UseMdOptionsT extends MarkdownItAsyncOptions {
     anchor?: boolean;
     anchorType?: 'vitepress' | 'github';
     copy?: boolean;
@@ -17,7 +17,7 @@ export interface UseMdOptions extends MarkdownItAsyncOptions {
  * @param options - 配置选项
  * @returns 返回一个对象可解构出 shiki 实例和 markdown-it 实例
  */
-export declare function useMdRender(options?: UseMdOptions): Promise<{
+export declare function useMdRender(options?: UseMdOptionsT): Promise<{
     shiki: import('shiki').HighlighterGeneric<BundledLanguage, BundledTheme>;
     markdwon: import('markdown-it-async').MarkdownItAsync;
 }>;

package/dist/core/useScrollBottom.d.ts

@@ -0,0 +1,4 @@
+import { OScroller } from '@opensig/opendesign';
+import { Ref } from 'vue';
+declare const useScrollBottom: (scrollerRef: Ref<InstanceType<typeof OScroller>>, callback: () => void) => void;
+export default useScrollBottom;

package/dist/core/useTheme.d.ts

@@ -1,19 +1,37 @@
+import { ComputedRef, Plugin } from 'vue';
 /**
- * 初始化主题，建议在 vue 应用初始化前调用
- * @param storageKey - 用于存储主题偏好设置的键名
- * @param cookieDomain - Cookie 的作用域域名
+ * 创建主题配置项
+ * @param options - 配置项
+ * @param options.cookieKey - cookie 键名
+ * @param options.cookieDomain - cookie 域
+ * @param options.lightValue - 浅色主题值
+ * @param options.darkValue - 深色主题值
+ * @param options.attribute - 属性名
+ * @param options.attributeLightValue - 浅色主题属性值
+ * @param options.attributeDarkValue - 深色主题属性值
+ * @param options.classLightValue - 浅色主题类名
+ * @param options.classDarkValue - 深色主题类名
+ * @returns theme 插件实例
  */
-export declare function initTheme(storageKey: string, cookieDomain: string): void;
+export declare function createTheme<ThemeValue = 'dark | light'>(options?: {
+    cookieKey: string;
+    cookieDomain: string;
+    lightValue?: string;
+    darkValue?: string;
+    attribute?: string;
+    attributeLightValue?: string;
+    attributeDarkValue?: string;
+    classLightValue?: string;
+    classDarkValue?: string;
+}): Plugin;
 /**
  * 主题切换组合式函数
- * @param storageKey - 用于存储主题偏好设置的键名，若调用过 initTheme 可不传
- * @param cookieDomain - Cookie 的作用域域名，若调用过 initTheme 可不传
  * @returns 包含当前主题状态和操作方法的对象
  */
-export declare function useTheme(storageKey?: string, cookieDomain?: string): {
-    theme: import('vue').ComputedRef<"light" | "dark">;
-    isLight: import('vue').ComputedRef<boolean>;
-    isDark: import('vue').ComputedRef<boolean>;
-    setTheme: (newTheme: "light" | "dark") => void;
-    toggleTheme: () => void;
+export declare function useTheme<ThemeValue = 'dark | light'>(): {
+    theme: ComputedRef<ThemeValue> | undefined;
+    isLight: ComputedRef<boolean> | undefined;
+    isDark: ComputedRef<boolean> | undefined;
+    setTheme: ((val: ThemeValue) => void) | undefined;
+    toggleTheme: (() => void) | undefined;
 };

package/dist/index.d.ts

@@ -3,3 +3,5 @@ export * from './core/useScreen';
 export * from './core/useLocale';
 export * from './core/useTheme';
 export * from './core/useClipboard';
+export * from './analytics/useAnalytics';
+export * from './core/useLogin';