@blueking/bk-user-selector 0.0.39-beta.3 → 0.1.1-beta.1

package/typings/hooks/use-tenant-data.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 租户数据处理 Hook
+ * @module hooks/useTenantData
+ */
+import { type Ref } from 'vue';
+/**
+ * 使用租户数据的Hook
+ * @param apiBaseUrl - API基础URL
+ * @param tenantId - 租户ID
+ * @param enableMultiTenantMode - 是否启用多租户模式
+ * @returns 租户数据和加载状态
+ */
+export declare const useTenantData: (apiBaseUrl: string, tenantId: string, enableMultiTenantMode?: boolean) => {
+    tenants: Ref<Record<string, string>, Record<string, string>>;
+    loading: Ref<boolean, boolean>;
+    fetchTenants: () => Promise<void>;
+};

package/typings/hooks/use-user-search.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 用户搜索 Hook
+ * @module hooks/useUserSearch
+ */
+import { type Ref } from 'vue';
+import type { FormattedUser } from '../types';
+export interface UseUserSearchOptions {
+    /** API 基础 URL */
+    apiBaseUrl: string;
+    /** 防抖延迟时间（毫秒） */
+    debounceDelay?: number;
+    /** 是否启用多租户模式 */
+    enableMultiTenantMode?: boolean;
+    /** 租户 ID */
+    tenantId: string;
+}
+export interface UseUserSearchReturn {
+    /** 加载状态 */
+    loading: Ref<boolean>;
+    /** 搜索关键词 */
+    searchQuery: Ref<string>;
+    /** 搜索结果 */
+    searchResults: Ref<FormattedUser[]>;
+    /** 清空搜索 */
+    clearSearch: () => void;
+    /** 处理输入变化（带防抖） */
+    handleSearchInput: (value: string) => void;
+    /** 执行搜索 */
+    performSearch: (keyword: string) => Promise<void>;
+}
+/**
+ * 使用用户搜索的Hook
+ * @param apiBaseUrl - API基础URL
+ * @param tenantId - 租户ID
+ * @param enableMultiTenantMode - 是否启用多租户模式
+ * @returns 用户搜索相关状态和方法
+ */
+export declare const useUserSearch: (apiBaseUrl: string, tenantId: string, enableMultiTenantMode?: boolean) => UseUserSearchReturn;

package/typings/hooks/use-user-selection.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 用户选择公共逻辑 Hook
+ * @module hooks/useUserSelection
+ */
+import { type ComputedRef, type Ref } from 'vue';
+import type { FormattedUser, UserGroupConfig } from '../types';
+export interface UseUserSelectionOptions {
+    /** 排除的用户ID列表 */
+    excludeUserIds?: Ref<string[]>;
+    /** 搜索关键词 */
+    searchQuery: Ref<string>;
+    /** 已选用户ID列表（用于过滤） */
+    selectedUserIds: Ref<string[]>;
+    /** 用户群组配置 */
+    userGroup?: Ref<UserGroupConfig[]>;
+}
+export interface UseUserSelectionReturn {
+    /** 过滤后的用户群组（带搜索过滤） */
+    filteredUserGroup: ComputedRef<UserGroupConfig[]>;
+    /** 创建自定义用户 */
+    createCustomUser: (loginName: string) => FormattedUser;
+    /** 过滤选项（排除已选和排除列表） */
+    filterOptions: (options: FormattedUser[]) => FormattedUser[];
+    /** 检查用户是否已选中 */
+    isUserSelected: (userId: string) => boolean;
+}
+/**
+ * 用户选择公共逻辑 Hook
+ * @param options - 配置选项
+ * @returns 用户选择相关方法
+ */
+export declare const useUserSelection: (options: UseUserSelectionOptions) => UseUserSelectionReturn;

package/typings/hooks/use-visible-tags.d.ts

@@ -0,0 +1,51 @@
+import { type Ref } from 'vue';
+import type { FormattedUser } from '../types';
+export interface UseVisibleTagsOptions {
+    /**
+     * 折叠容器引用
+     */
+    collapsedContainerRef: Ref<HTMLDivElement | null>;
+    /**
+     * 是否聚焦状态
+     */
+    isFocused: Ref<boolean>;
+    /**
+     * 已选用户列表
+     */
+    selectedUsers: Ref<FormattedUser[]>;
+}
+/**
+ * 可见标签计算 hook
+ */
+export declare function useVisibleTags(options: UseVisibleTagsOptions): {
+    visibleUsers: Ref<{
+        bk_username?: string | undefined;
+        data_source_type?: string | undefined;
+        display_name?: string | undefined;
+        full_name?: string | undefined;
+        hidden?: boolean | undefined;
+        id: string;
+        login_name?: string | undefined;
+        name: string;
+        owner_tenant_id?: string | undefined;
+        tenantId: string;
+        type?: import("../types").UserType | undefined;
+        username?: string | undefined;
+    }[], FormattedUser[] | {
+        bk_username?: string | undefined;
+        data_source_type?: string | undefined;
+        display_name?: string | undefined;
+        full_name?: string | undefined;
+        hidden?: boolean | undefined;
+        id: string;
+        login_name?: string | undefined;
+        name: string;
+        owner_tenant_id?: string | undefined;
+        tenantId: string;
+        type?: import("../types").UserType | undefined;
+        username?: string | undefined;
+    }[]>;
+    hiddenCount: Ref<number, number>;
+    calculateVisibleUsers: () => void;
+    scheduleVisibleUsersCalculation: () => void;
+};

package/typings/types/index.d.ts

@@ -1,68 +1,138 @@
 import type { createVNode } from 'vue';
 import type { VNode } from 'vue';
+import type { USER_TYPE } from '../constants';
 /**
- * 格式化后的用户信息
+ * 基础选择器属性
  */
-export interface FormattedUser {
+export interface BaseSelectorProps {
     /**
-     * 其他属性
+     * 是否允许创建用户
      */
-    [key: string]: boolean | string | undefined;
+    allowCreate?: boolean;
     /**
-     * 是否隐藏
+     * 接口基础URL
      */
-    hidden?: boolean;
+    apiBaseUrl: string;
     /**
-     * 用户ID
+     * 头像基础URL
+     * @default ''
      */
-    id: string;
+    avatarBaseUrl?: string;
     /**
-     * 用户名称
+     * 本人ID
      */
-    name: string;
+    currentUserId?: string;
     /**
-     * 租户ID
+     * 是否禁用
      */
-    tenantId: string;
-}
-/**
- * 多选模式属性
- */
-export interface MultipleSelectorProps extends BaseSelectorProps {
+    disabled?: boolean;
     /**
-     * 是否支持拖拽排序
+     * 无匹配人员时的提示文本
      */
-    draggable?: boolean;
+    emptyText?: string;
+    /**
+     * 是否启用多租户模式
+     */
+    enableMultiTenantMode?: boolean;
+    /**
+     * 精确查找key
+     */
+    exactSearchKey?: string;
+    /**
+     * 排除的用户ID列表
+     */
+    excludeUserIds?: string[];
     /**
      * 是否允许粘贴任意文本
      */
     freePaste?: boolean;
     /**
-     * 选中的用户ID列表
+     * 是否显示头像
+     * @default false
      */
-    modelValue: string[];
+    hasAvatar?: boolean;
     /**
-     * 已选用户列表
+     * 占位文字
      */
-    selectedUsers: FormattedUser[];
+    placeholder?: string;
     /**
-     * 租户信息映射
+     * 渲染列表项
      */
-    tenants: Record<string, string>;
+    renderListItem?: RenderFunction;
+    /**
+     * 渲染标签
+     */
+    renderTag?: RenderFunction;
+    /**
+     * 租户ID
+     */
+    tenantId: string;
+    /**
+     * 用户组配置
+     */
+    userGroup?: UserGroupConfig[];
+    /**
+     * 用户组名称
+     */
+    userGroupName?: string;
 }
 /**
- * 单选模式属性
+ * 格式化后的用户信息
  */
-export interface SingleSelectorProps extends BaseSelectorProps {
+export interface FormattedUser {
+    /**
+     * 用户名
+     */
+    bk_username?: string;
+    /**
+     * 数据源类型
+     */
+    data_source_type?: string;
+    /**
+     * 显示名称
+     */
+    display_name?: string;
+    /**
+     * 全名
+     */
+    full_name?: string;
+    /**
+     * 是否隐藏
+     */
+    hidden?: boolean;
+    /**
+     * 用户ID
+     */
+    id: string;
+    /**
+     * 登录名
+     */
+    login_name?: string;
+    /**
+     * 用户名称
+     */
+    name: string;
     /**
-     * 选中的用户ID
+     * 所属租户ID
+     */
+    owner_tenant_id?: string;
+    /**
+     * 租户ID
      */
-    modelValue?: string;
+    tenantId: string;
     /**
-     * 租户信息映射
+     * 用户类型
      */
-    tenants: Record<string, string>;
+    type?: UserType;
+    /**
+     * 旧版用户名
+     */
+    username?: string;
 }
+/**
+ * 自定义渲染函数类型
+ */
+export type RenderFunction = (h: typeof createVNode, userInfo: FormattedUser) => VNode;
 /**
  * 租户信息
  */
@@ -76,6 +146,10 @@ export interface Tenant {
      */
     name: string;
 }
+/**
+ * 租户信息映射
+ */
+export type TenantMap = Record<string, string>;
 /**
  * 用户对象接口
  */
@@ -110,89 +184,44 @@ export interface User {
     username: string;
 }
 /**
- * 用户选择器属性
+ * 用户群组配置
  */
-export interface UserSelectorProps extends BaseSelectorProps {
+export interface UserGroupConfig {
     /**
-     * 是否支持拖拽排序
+     * 是否隐藏
      */
-    draggable?: boolean;
+    hidden?: boolean;
     /**
-     * 默认选中的用户(单选时为字符串，多选时为数组)
+     * 群组ID
      */
-    modelValue?: string | string[];
+    id: string;
     /**
-     * 是否多选
+     * 群组名称
      */
-    multiple?: boolean;
+    name: string;
 }
 /**
- * 基础选择器属性
+ * 用户选择器属性
  */
-interface BaseSelectorProps {
-    /**
-     * 是否允许创建用户
-     */
-    allowCreate?: boolean;
-    /**
-     * 接口基础URL
-     */
-    apiBaseUrl: string;
-    /**
-     * 本人ID
-     */
-    currentUserId?: string;
-    /**
-     * 是否禁用
-     */
-    disabled?: boolean;
-    /**
-     * 无匹配人员时的提示文本
-     */
-    emptyText?: string;
-    /**
-     * 是否启用多租户模式
-     */
-    enableMultiTenantMode?: boolean;
-    /**
-     * 精确查找key
-     */
-    exactSearchKey?: string;
-    /**
-     * 排除的用户ID列表
-     */
-    excludeUserIds?: string[];
-    /**
-     * 是否允许粘贴任意文本
-     */
-    freePaste?: boolean;
-    /**
-     * 占位文字
-     */
-    placeholder?: string;
-    /**
-     * 租户ID
-     */
-    tenantId: string;
+export interface UserSelectorProps extends BaseSelectorProps {
     /**
-     * 用户组名称
+     * 是否支持拖拽排序
      */
-    userGroupName?: string;
+    draggable?: boolean;
     /**
-     * 渲染列表项
+     * 最大可选数量（0 表示不限制）
      */
-    renderListItem?: (h: typeof createVNode, userInfo: FormattedUser) => VNode;
+    maxCount?: number;
     /**
-     * 渲染标签
+     * 默认选中的用户(单选时为字符串，多选时为数组)
      */
-    renderTag?: (h: typeof createVNode, userInfo: FormattedUser) => VNode;
+    modelValue?: string | string[];
     /**
-     * 用户组配置
+     * 是否多选
      */
-    userGroup?: {
-        hidden?: boolean;
-        id: string;
-        name: string;
-    }[];
+    multiple?: boolean;
 }
-export {};
+/**
+ * 用户类型
+ */
+export type UserType = (typeof USER_TYPE)[keyof typeof USER_TYPE];

package/typings/utils/logger.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 日志级别
+ */
+export type LogLevel = 'debug' | 'error' | 'info' | 'warn';
+/**
+ * 日志配置
+ */
+interface LoggerConfig {
+    /** 是否启用日志 */
+    enabled: boolean;
+    /** 最小日志级别 */
+    level: LogLevel;
+}
+/**
+ * 配置日志
+ */
+export declare const configureLogger: (options: Partial<LoggerConfig>) => void;
+/**
+ * 日志工具
+ */
+export declare const logger: {
+    /**
+     * 调试日志
+     */
+    debug: (message: string, ...args: unknown[]) => void;
+    /**
+     * 信息日志
+     */
+    info: (message: string, ...args: unknown[]) => void;
+    /**
+     * 警告日志
+     */
+    warn: (message: string, ...args: unknown[]) => void;
+    /**
+     * 错误日志
+     */
+    error: (message: string, error?: unknown) => void;
+};
+/**
+ * API 错误处理
+ */
+export declare const handleApiError: (operation: string, error: unknown) => void;
+/**
+ * 参数校验警告
+ */
+export declare const warnMissingParams: (operation: string, params: string[]) => void;
+export {};