@blueking/bk-user-selector 0.0.23-beta.1 → 0.0.24

package/README.md

@@ -1,9 +1,13 @@
-# 蓝鲸用户人员选择器组件
+# 蓝鲸多租户人员选择器组件
 
-蓝鲸用户人员选择器（BkUserSelector）是一个用于在蓝鲸系统中选择用户的组件，支持单选和多选模式，具备搜索、跨租户查询等功能。
+[![npm version](https://badge.fury.io/js/%40blueking%2Fbk-user-selector.svg)](https://badge.fury.io/js/%40blueking%2Fbk-user-selector)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+蓝鲸多租户人员选择器（BkUserSelector）是一个用于在蓝鲸系统中选择用户的组件，支持单选和多选模式，具备搜索、跨租户查询等功能。
 
 ## 特性
 
+- 支持 Vue2 和 Vue3 双版本
 - 支持单选和多选模式
 - 支持用户搜索功能
 - 支持跨租户显示
@@ -22,21 +26,12 @@ npm install @blueking/bk-user-selector
 ### 在 Vue3 中使用
 
 ```javascript
-// 全局注册
-import { createApp } from 'vue';
 import BkUserSelector from '@blueking/bk-user-selector';
 import '@blueking/bk-user-selector/vue3/vue3.css';
 
-const app = createApp(App);
-app.use(BkUserSelector);
-app.mount('#app');
-
-// 或者局部注册
-import { UserSelector } from '@blueking/bk-user-selector';
-
 export default {
   components: {
-    BkUserSelector: UserSelector,
+    BkUserSelector,
   },
 };
 ```
@@ -46,6 +41,12 @@ export default {
 ```javascript
 import BkUserSelector from '@blueking/bk-user-selector/vue2';
 import '@blueking/bk-user-selector/vue2/vue2.css';
+
+export default {
+  components: {
+    BkUserSelector,
+  },
+};
 ```
 
 ### 基本用法
@@ -140,6 +141,7 @@ import '@blueking/bk-user-selector/vue2/vue2.css';
 | emptyText            | 无匹配人员时的提示文本                                                  | String                         | 无匹配人员         |
 | renderTag            | 渲染标签                                                                | Function(h, userInfo) => VNode | -                  |
 | renderListItem       | 渲染列表项                                                              | Function(h, userInfo) => VNode | -                  |
+| excludeUserIds       | 排除的用户ID列表                                                        | Array                          | []                 |
 
 ### 事件
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blueking/bk-user-selector",
-  "version": "0.0.23-beta.1",
+  "version": "0.0.24",
   "description": "蓝鲸用户选择器",
   "license": "MIT",
   "author": "Tencent BlueKing",

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

@@ -1,4 +1,4 @@
-declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+declare const _default: import("vue").DefineComponent<{
     /**
      * 当前用户ID
      */
@@ -13,7 +13,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: BooleanConstructor;
         default: boolean;
     };
-}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     click: (...args: any[]) => void;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     /**
@@ -30,10 +30,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: BooleanConstructor;
         default: boolean;
     };
-}>> & Readonly<{
+}>> & {
     onClick?: ((...args: any[]) => any) | undefined;
-}>, {
+}, {
     currentUserId: string;
     isDisabled: boolean;
-}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+}, {}>;
 export default _default;

package/typings/components/multiple-selector.vue.d.ts

@@ -1,13 +1,41 @@
 import { FormattedUser, MultipleSelectorProps } from '../types';
-declare const _default: import("vue").DefineComponent<MultipleSelectorProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<MultipleSelectorProps>, {
+    modelValue: () => never[];
+    placeholder: string;
+    draggable: boolean;
+    apiBaseUrl: string;
+    tenantId: string;
+    selectedUsers: () => never[];
+    tenants: () => {};
+    currentUserId: string;
+    exactSearchKey: string;
+    userGroup: () => never[];
+    userGroupName: string;
+    emptyText: string;
+    excludeUserIds: () => never[];
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:selectedUsers": (...args: any[]) => void;
     "add-user": (...args: any[]) => void;
     "remove-user": (...args: any[]) => void;
-}, string, import("vue").PublicProps, Readonly<MultipleSelectorProps> & Readonly<{
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<MultipleSelectorProps>, {
+    modelValue: () => never[];
+    placeholder: string;
+    draggable: boolean;
+    apiBaseUrl: string;
+    tenantId: string;
+    selectedUsers: () => never[];
+    tenants: () => {};
+    currentUserId: string;
+    exactSearchKey: string;
+    userGroup: () => never[];
+    userGroupName: string;
+    emptyText: string;
+    excludeUserIds: () => never[];
+}>>> & {
     "onUpdate:selectedUsers"?: ((...args: any[]) => any) | undefined;
     "onAdd-user"?: ((...args: any[]) => any) | undefined;
     "onRemove-user"?: ((...args: any[]) => any) | undefined;
-}>, {
+}, {
     tenantId: string;
     currentUserId: string;
     tenants: Record<string, string>;
@@ -28,5 +56,23 @@ declare const _default: import("vue").DefineComponent<MultipleSelectorProps, {},
     apiBaseUrl: string;
     placeholder: string;
     exactSearchKey: string;
-}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+    excludeUserIds: string[];
+}, {}>;
 export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_PrettifyLocal<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/typings/components/render-tag.d.ts

@@ -0,0 +1,8 @@
+declare const _default: import("vue").DefineComponent<{
+    renderTag: FunctionConstructor;
+    userInfo: ObjectConstructor;
+}, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    renderTag: FunctionConstructor;
+    userInfo: ObjectConstructor;
+}>>, {}, {}>;
+export default _default;

package/typings/components/selection-popover.vue.d.ts

@@ -3,7 +3,7 @@
  */
 import { createVNode, VNode } from 'vue';
 import { FormattedUser } from '../types';
-declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+declare const _default: import("vue").DefineComponent<{
     /**
      * 是否显示下拉菜单
      */
@@ -91,7 +91,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     renderListItem: {
         type: () => (h: typeof createVNode, item: FormattedUser) => VNode;
     };
-}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "select-user": (...args: any[]) => void;
     "click-outside": (...args: any[]) => void;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
@@ -182,10 +182,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     renderListItem: {
         type: () => (h: typeof createVNode, item: FormattedUser) => VNode;
     };
-}>> & Readonly<{
+}>> & {
     "onSelect-user"?: ((...args: any[]) => any) | undefined;
     "onClick-outside"?: ((...args: any[]) => any) | undefined;
-}>, {
+}, {
     tenantId: string;
     tenants: Record<string, string>;
     isShow: boolean;
@@ -201,5 +201,5 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     }[];
     userGroupName: string;
     emptyText: string;
-}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+}, {}>;
 export default _default;

package/typings/components/single-selector.vue.d.ts

@@ -1,11 +1,33 @@
 import { SingleSelectorProps } from '../types';
-declare const _default: import("vue").DefineComponent<SingleSelectorProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<SingleSelectorProps>, {
+    apiBaseUrl: string;
+    tenantId: string;
+    placeholder: string;
+    modelValue: string;
+    currentUserId: string;
+    exactSearchKey: string;
+    userGroup: () => never[];
+    userGroupName: string;
+    emptyText: string;
+    excludeUserIds: () => never[];
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     change: (...args: any[]) => void;
     "update:modelValue": (...args: any[]) => void;
-}, string, import("vue").PublicProps, Readonly<SingleSelectorProps> & Readonly<{
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<SingleSelectorProps>, {
+    apiBaseUrl: string;
+    tenantId: string;
+    placeholder: string;
+    modelValue: string;
+    currentUserId: string;
+    exactSearchKey: string;
+    userGroup: () => never[];
+    userGroupName: string;
+    emptyText: string;
+    excludeUserIds: () => never[];
+}>>> & {
     onChange?: ((...args: any[]) => any) | undefined;
     "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
-}>, {
+}, {
     tenantId: string;
     currentUserId: string;
     userGroup: {
@@ -23,5 +45,23 @@ declare const _default: import("vue").DefineComponent<SingleSelectorProps, {}, {
     apiBaseUrl: string;
     placeholder: string;
     exactSearchKey: string;
-}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+    excludeUserIds: string[];
+}, {}>;
 export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_PrettifyLocal<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/typings/components/user-render.d.ts

@@ -1,5 +1,5 @@
 import type { FormattedUser } from '../types';
-declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+declare const _default: import("vue").DefineComponent<{
     user: {
         type: () => FormattedUser;
         required: true;
@@ -16,7 +16,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: FunctionConstructor;
         required: false;
     };
-}>, () => any, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+}, () => any, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     user: {
         type: () => FormattedUser;
         required: true;
@@ -33,5 +33,5 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: FunctionConstructor;
         required: false;
     };
-}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+}>>, {}, {}>;
 export default _default;

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

@@ -1,11 +1,37 @@
 import { UserSelectorProps } from '../types';
-declare const _default: import("vue").DefineComponent<UserSelectorProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<UserSelectorProps>, {
+    apiBaseUrl: string;
+    tenantId: string;
+    placeholder: string;
+    modelValue: string;
+    draggable: boolean;
+    multiple: boolean;
+    currentUserId: string;
+    exactSearchKey: string;
+    userGroup: () => never[];
+    userGroupName: string;
+    emptyText: string;
+    excludeUserIds: () => never[];
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     change: (...args: any[]) => void;
     "update:modelValue": (...args: any[]) => void;
-}, string, import("vue").PublicProps, Readonly<UserSelectorProps> & Readonly<{
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<UserSelectorProps>, {
+    apiBaseUrl: string;
+    tenantId: string;
+    placeholder: string;
+    modelValue: string;
+    draggable: boolean;
+    multiple: boolean;
+    currentUserId: string;
+    exactSearchKey: string;
+    userGroup: () => never[];
+    userGroupName: string;
+    emptyText: string;
+    excludeUserIds: () => never[];
+}>>> & {
     onChange?: ((...args: any[]) => any) | undefined;
     "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
-}>, {
+}, {
     tenantId: string;
     currentUserId: string;
     userGroup: {
@@ -25,6 +51,24 @@ declare const _default: import("vue").DefineComponent<UserSelectorProps, {}, {},
     apiBaseUrl: string;
     placeholder: string;
     exactSearchKey: string;
+    excludeUserIds: string[];
     multiple: boolean;
-}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+}, {}>;
 export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_PrettifyLocal<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};

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

@@ -1,9 +1,6 @@
 import { createVNode, VNode } from 'vue';
 import { FormattedUser } from '../types';
-/**
- * 组件属性
- */
-type __VLS_Props = {
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToOption<{
     /**
      * 用户信息
      */
@@ -32,12 +29,49 @@ type __VLS_Props = {
      * 渲染标签
      */
     renderTag?: (h: typeof createVNode, userInfo: FormattedUser) => VNode;
-};
-declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     click: (...args: any[]) => void;
     close: (...args: any[]) => void;
-}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToOption<{
+    /**
+     * 用户信息
+     */
+    user: FormattedUser;
+    /**
+     * 租户数据映射
+     */
+    tenants: Record<string, string>;
+    /**
+     * 当前租户ID
+     */
+    currentTenantId: string;
+    /**
+     * 是否可拖拽
+     */
+    draggable?: boolean;
+    /**
+     * 是否激活状态
+     */
+    active?: boolean;
+    /**
+     * 是否显示租户信息
+     */
+    showTenant?: boolean;
+    /**
+     * 渲染标签
+     */
+    renderTag?: (h: typeof createVNode, userInfo: FormattedUser) => VNode;
+}>>> & {
     onClick?: ((...args: any[]) => any) | undefined;
     onClose?: ((...args: any[]) => any) | undefined;
-}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+}, {}, {}>;
 export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/typings/hooks/useTenantData.d.ts

@@ -10,7 +10,7 @@ import { type Ref } from 'vue';
  * @returns 租户数据和加载状态
  */
 export declare const useTenantData: (apiBaseUrl: string, tenantId: string) => {
-    tenants: Ref<Record<string, string>, Record<string, string>>;
-    loading: Ref<boolean, boolean>;
+    tenants: Ref<Record<string, string>>;
+    loading: Ref<boolean>;
     fetchTenants: () => Promise<void>;
 };

package/typings/hooks/useUserSearch.d.ts

@@ -11,9 +11,9 @@ import { type FormattedUser } from '../types';
  * @returns 用户搜索相关状态和方法
  */
 export declare const useUserSearch: (apiBaseUrl: string, tenantId: string) => {
-    searchResults: Ref<FormattedUser[], FormattedUser[]>;
-    loading: Ref<boolean, boolean>;
-    searchQuery: Ref<string, string>;
+    searchResults: Ref<FormattedUser[]>;
+    loading: Ref<boolean>;
+    searchQuery: Ref<string>;
     performSearch: (keyword: string) => Promise<void>;
     handleSearchInput: (value: string) => void;
     clearSearch: () => void;

package/typings/types/index.d.ts

@@ -115,6 +115,10 @@ interface BaseSelectorProps {
      * 渲染标签
      */
     renderTag?: (h: typeof createVNode, userInfo: FormattedUser) => VNode;
+    /**
+     * 排除的用户ID列表
+     */
+    excludeUserIds?: string[];
 }
 /**
  * 用户选择器属性

package/typings/vue2.d.ts

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