@blueking/bk-user-selector 0.0.1-beta.1 → 0.0.2-9.beta.1

package/typings/components/user-tag.vue.d.ts

@@ -0,0 +1,68 @@
+import { createVNode, VNode } from 'vue';
+import { FormattedUser } from '../types';
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * 用户信息
+     */
+    user: FormattedUser;
+    /**
+     * 租户数据映射
+     */
+    tenants: Record<string, string>;
+    /**
+     * 当前租户ID
+     */
+    currentTenantId: string;
+    /**
+     * 是否可拖拽
+     */
+    draggable?: boolean;
+    /**
+     * 是否激活状态
+     */
+    active?: boolean;
+    /**
+     * 是否显示租户信息
+     */
+    showTenant?: boolean;
+    /**
+     * 渲染标签
+     */
+    renderTag?: (h: typeof createVNode, userInfo: FormattedUser) => VNode;
+}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    click: (...args: any[]) => void;
+    close: (...args: any[]) => void;
+}, string, import("vue").PublicProps, Readonly<{
+    /**
+     * 用户信息
+     */
+    user: FormattedUser;
+    /**
+     * 租户数据映射
+     */
+    tenants: Record<string, string>;
+    /**
+     * 当前租户ID
+     */
+    currentTenantId: string;
+    /**
+     * 是否可拖拽
+     */
+    draggable?: boolean;
+    /**
+     * 是否激活状态
+     */
+    active?: boolean;
+    /**
+     * 是否显示租户信息
+     */
+    showTenant?: boolean;
+    /**
+     * 渲染标签
+     */
+    renderTag?: (h: typeof createVNode, userInfo: FormattedUser) => VNode;
+}> & Readonly<{
+    onClick?: ((...args: any[]) => any) | undefined;
+    onClose?: ((...args: any[]) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;

package/typings/hooks/use-jsonp.d.ts

@@ -0,0 +1,29 @@
+import { type MaybeRef, type ShallowRef } from 'vue';
+export interface JSONPOptions {
+    /** 超时时间（毫秒），默认为 2 * 60 * 1000 */
+    timeout?: number;
+    /** 请求参数 */
+    params?: Record<string, string | undefined>;
+}
+export interface JSONPResult<T> {
+    /** 响应数据 */
+    data: ShallowRef<T | null>;
+    /** 加载状态 */
+    loading: ShallowRef<boolean>;
+    /** 错误信息 */
+    error: ShallowRef<Error | null>;
+    /** 手动触发请求的函数 */
+    refetch: () => void;
+}
+/**
+ * JSONP 请求函数
+ */
+export declare const jsonpRequest: <T>(requestUrl: MaybeRef<string>, options?: JSONPOptions) => Promise<T>;
+/**
+ * useJSONP
+ * @param url 请求的 URL，可以是字符串或 ref
+ * @param options JSONP 选项配置
+ * @returns JSONPResult 包含数据、加载状态、错误信息和重新请求函数
+ */
+export declare const useJSONP: <T = unknown>(url: MaybeRef<string>, options?: JSONPOptions) => JSONPResult<T>;
+export default useJSONP;

package/typings/hooks/useTenantData.d.ts

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

package/typings/hooks/useUserSearch.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 用户搜索 Hook
+ * @module hooks/useUserSearch
+ */
+import { type Ref } from 'vue';
+import { type FormattedUser } from '../types';
+/**
+ * 使用用户搜索的Hook
+ * @param apiBaseUrl - API基础URL
+ * @param tenantId - 租户ID
+ * @returns 用户搜索相关状态和方法
+ */
+export declare const useUserSearch: (apiBaseUrl: string, tenantId: string) => {
+    searchResults: Ref<FormattedUser[], FormattedUser[]>;
+    loading: Ref<boolean, boolean>;
+    searchQuery: Ref<string, string>;
+    performSearch: (keyword: string) => Promise<void>;
+    handleSearchInput: (value: string) => void;
+    clearSearch: () => void;
+};

package/typings/types/index.d.ts

@@ -0,0 +1,186 @@
+import { type createVNode } from 'vue';
+import type { VNode } from 'vue';
+/**
+ * 用户对象接口
+ */
+export interface User {
+    /**
+     * 用户名
+     */
+    bk_username: string;
+    /**
+     * 显示名称
+     */
+    display_name: string;
+    /**
+     * 所属租户ID
+     */
+    owner_tenant_id: string;
+    /**
+     * 数据源类型
+     */
+    data_source_type: string;
+    /**
+     * 全名
+     */
+    full_name: string;
+    /**
+     * 登录名, 对应内网企微英文名
+     */
+    login_name: string;
+    /**
+     * 用户名 旧版
+     */
+    username: string;
+}
+/**
+ * 格式化后的用户信息
+ */
+export interface FormattedUser {
+    /**
+     * 用户ID
+     */
+    id: string;
+    /**
+     * 用户名称
+     */
+    name: string;
+    /**
+     * 租户ID
+     */
+    tenantId: string;
+    /**
+     * 是否隐藏
+     */
+    hidden?: boolean;
+    /**
+     * 其他属性
+     */
+    [key: string]: boolean | string | undefined;
+}
+/**
+ * 租户信息
+ */
+export interface Tenant {
+    /**
+     * 租户ID
+     */
+    id: string;
+    /**
+     * 租户名称
+     */
+    name: string;
+}
+/**
+ * 基础选择器属性
+ */
+interface BaseSelectorProps {
+    /**
+     * 接口基础URL
+     */
+    apiBaseUrl: string;
+    /**
+     * 租户ID
+     */
+    tenantId: string;
+    /**
+     * 占位文字
+     */
+    placeholder?: string;
+    /**
+     * 本人ID
+     */
+    currentUserId?: string;
+    /**
+     * 精确查找key
+     */
+    exactSearchKey?: string;
+    /**
+     * 用户组配置
+     */
+    userGroup?: {
+        id: string;
+        name: string;
+        hidden?: boolean;
+    }[];
+    /**
+     * 用户组名称
+     */
+    userGroupName?: string;
+    /**
+     * 无匹配人员时的提示文本
+     */
+    emptyText?: string;
+    /**
+     * 是否禁用
+     */
+    disabled?: boolean;
+    /**
+     * 渲染列表项
+     */
+    renderListItem?: (h: typeof createVNode, userInfo: FormattedUser) => VNode;
+    /**
+     * 渲染标签
+     */
+    renderTag?: (h: typeof createVNode, userInfo: FormattedUser) => VNode;
+    /**
+     * 排除的用户ID列表
+     */
+    excludeUserIds?: string[];
+    /**
+     * 是否启用多租户模式
+     */
+    enableMultiTenantMode?: boolean;
+}
+/**
+ * 用户选择器属性
+ */
+export interface UserSelectorProps extends BaseSelectorProps {
+    /**
+     * 默认选中的用户(单选时为字符串，多选时为数组)
+     */
+    modelValue?: string | string[];
+    /**
+     * 是否支持拖拽排序
+     */
+    draggable?: boolean;
+    /**
+     * 是否多选
+     */
+    multiple?: boolean;
+}
+/**
+ * 单选模式属性
+ */
+export interface SingleSelectorProps extends BaseSelectorProps {
+    /**
+     * 选中的用户ID
+     */
+    modelValue?: string;
+    /**
+     * 租户信息映射
+     */
+    tenants: Record<string, string>;
+}
+/**
+ * 多选模式属性
+ */
+export interface MultipleSelectorProps extends BaseSelectorProps {
+    /**
+     * 选中的用户ID列表
+     */
+    modelValue: string[];
+    /**
+     * 是否支持拖拽排序
+     */
+    draggable?: boolean;
+    /**
+     * 已选用户列表
+     */
+    selectedUsers: FormattedUser[];
+    /**
+     * 租户信息映射
+     */
+    tenants: Record<string, string>;
+}
+export {};

package/typings/utils/common.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 通用工具函数
+ * @module utils/common
+ */
+import { type FormattedUser } from '../types';
+/**
+ * 防抖函数
+ * @param fn - 需要防抖的函数
+ * @param delay - 延迟时间（毫秒）
+ * @returns 防抖后的函数
+ */
+export declare const debounce: <T extends (...args: any[]) => any>(fn: T, delay: number) => (...args: Parameters<T>) => void;
+/**
+ * 计算标签容器可见数量
+ * @param container - 容器元素
+ * @param items - 项目元素列表
+ * @param containerWidth - 容器宽度
+ * @returns 可见项目数量
+ */
+export declare const calculateVisibleTags: (container: HTMLElement, items: HTMLElement[] | NodeListOf<Element>, containerWidth: number) => number;
+/**
+ * 转换用户数组为Map结构，方便快速查找
+ * @param users - 用户列表
+ * @returns 用户Map对象
+ */
+export declare const userArrayToMap: (users: FormattedUser[]) => Map<string, FormattedUser>;
+/**
+ * 判断两个数组是否有值的变化
+ * @param arr1 - 数组1
+ * @param arr2 - 数组2
+ * @returns 是否有变化
+ */
+export declare const hasArrayChanged: (arr1?: any[], arr2?: any[]) => boolean;

package/typings/vue2.d.ts

@@ -1,2 +1,20 @@
-declare const _default: any;
+import BkUserSelector from './components/user-selector.vue';
+declare const _default: {
+    model: {
+        prop: string;
+        event: string;
+    };
+    beforeDestroy(): void;
+    created(): void;
+    data(): {
+        app: null;
+        unWatchStack: never[];
+    };
+    mounted(): void;
+    name: string;
+    props: any;
+    render(createElement: any): any;
+};
 export default _default;
+export { BkUserSelector };
+export * from './types';

package/typings/vue3.d.ts

@@ -1,3 +1,3 @@
-import BkUserSelector from './index.vue';
+import BkUserSelector from './components/user-selector.vue';
 export default BkUserSelector;
 export { BkUserSelector };