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

package/README.md

@@ -144,15 +144,16 @@ export default {
 | excludeUserIds        | 排除的用户ID列表                                                        | Array                          | []                 |
 | enableMultiTenantMode | 是否启用多租户模式，关闭后则使用原有用户管理接口查询                    | Boolean                        | true               |
 | allowCreate           | 是否允许自定义用户输入，按 Enter 确认                                   | Boolean                        | false              |
+| freePaste             | 是否允许粘贴任意文本                                                    | Boolean                        | false              |
 
 ### 事件
 
-| 事件名称          | 说明             | 回调参数         |
-| ----------------- | ---------------- | ---------------- |
-| update:modelValue | 绑定值变化时触发 | 变化后的值       |
-| change            | 选中值变化时触发 | 变化后的用户信息 |
-| focus            | 输入框获得焦点时触发 | -                |
-| blur             | 输入框失去焦点时触发 | -                |
+| 事件名称          | 说明                 | 回调参数         |
+| ----------------- | -------------------- | ---------------- |
+| update:modelValue | 绑定值变化时触发     | 变化后的值       |
+| change            | 选中值变化时触发     | 变化后的用户信息 |
+| focus             | 输入框获得焦点时触发 | -                |
+| blur              | 输入框失去焦点时触发 | -                |
 
 ## 功能说明
 

package/package.json

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

package/typings/api/user.d.ts

@@ -1,4 +1,4 @@
-import { type User, type Tenant, type FormattedUser } from '../types';
+import type { FormattedUser, Tenant, User } from '../types';
 /**
  * 获取本租户所有数据来源的租户信息
  * @param apiBaseUrl - API基础URL
@@ -15,9 +15,9 @@ export declare const getTenants: (apiBaseUrl: string, tenantId: string) => Promi
  */
 export declare const searchUsers: (params: {
     apiBaseUrl: string;
-    tenantId: string;
-    keyword: string;
     enableMultiTenantMode?: boolean;
+    keyword: string;
+    tenantId: string;
 }) => Promise<User[]>;
 /**
  * 批量精准查找用户
@@ -29,10 +29,10 @@ export declare const searchUsers: (params: {
  */
 export declare const lookupUsers: (params: {
     apiBaseUrl: string;
-    tenantId: string;
+    enableMultiTenantMode?: boolean;
     exactSearchKey: string;
+    tenantId: string;
     usersList: string[];
-    enableMultiTenantMode?: boolean;
 }) => Promise<User[]>;
 /**
  * 将API返回的用户数据格式化为组件所需格式
@@ -47,9 +47,9 @@ export declare const formatUsers: (users: User[], enableMultiTenantMode?: boolea
  * @returns 用户列表
  */
 export declare const getUserList: (url: string, params: {
-    userIds?: string[];
+    appCode?: string;
     keyword?: string;
-    pageSize?: number;
     page?: number;
-    appCode?: string;
+    pageSize?: number;
+    userIds?: string[];
 }) => Promise<User[]>;

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

@@ -22,21 +22,22 @@ declare const _default: import("vue").DefineComponent<MultipleSelectorProps, {},
     currentUserId: string;
     tenants: Record<string, string>;
     userGroup: {
-        id: string;
-        name: string;
         hidden
         /**
          * 多选模式用户选择器组件
          */
         ?: boolean;
+        id: string;
+        name: string;
     }[];
     userGroupName: string;
     emptyText: string;
     draggable: boolean;
+    freePaste: boolean;
     modelValue: string[];
     selectedUsers: FormattedUser[];
-    placeholder: string;
-    excludeUserIds: string[];
     allowCreate: boolean;
+    excludeUserIds: string[];
+    placeholder: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 export default _default;

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

@@ -76,9 +76,9 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
      */
     userGroup: {
         type: () => {
+            hidden?: boolean;
             id: string;
             name: string;
-            hidden?: boolean;
         }[];
         default: () => never[];
     };
@@ -167,9 +167,9 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
      */
     userGroup: {
         type: () => {
+            hidden?: boolean;
             id: string;
             name: string;
-            hidden?: boolean;
         }[];
         default: () => never[];
     };
@@ -206,9 +206,9 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
     options: FormattedUser[];
     searchQuery: string;
     userGroup: {
+        hidden?: boolean;
         id: string;
         name: string;
-        hidden?: boolean;
     }[];
     userGroupName: string;
     emptyText: string;

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

@@ -15,18 +15,18 @@ declare const _default: import("vue").DefineComponent<SingleSelectorProps, {}, {
     exactSearchKey: string;
     currentUserId: string;
     userGroup: {
-        id: string;
-        name: string;
         hidden
         /**
          * 单选模式用户选择器组件
          */
         ?: boolean;
+        id: string;
+        name: string;
     }[];
     userGroupName: string;
     emptyText: string;
     modelValue: string;
-    placeholder: string;
     excludeUserIds: string[];
+    placeholder: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 export default _default;

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

@@ -21,22 +21,23 @@ declare const _default: import("vue").DefineComponent<UserSelectorProps, {}, {},
     currentUserId: string;
     disabled: boolean;
     userGroup: {
-        id: string;
-        name: string;
         hidden
         /**
          * 蓝鲸用户选择器组件
          * @module components/UserSelector
          */
         ?: boolean;
+        id: string;
+        name: string;
     }[];
     userGroupName: string;
     emptyText: string;
     draggable: boolean;
+    freePaste: boolean;
     modelValue: string | string[];
-    placeholder: string;
-    excludeUserIds: string[];
     allowCreate: boolean;
+    excludeUserIds: string[];
+    placeholder: string;
     multiple: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 export default _default;

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

@@ -2,13 +2,9 @@ import { createVNode, VNode } from 'vue';
 import { FormattedUser } from '../types';
 declare const _default: import("vue").DefineComponent<{
     /**
-     * 用户信息
-     */
-    user: FormattedUser;
-    /**
-     * 租户数据映射
+     * 是否激活状态
      */
-    tenants: Record<string, string>;
+    active?: boolean;
     /**
      * 当前租户ID
      */
@@ -18,29 +14,29 @@ declare const _default: import("vue").DefineComponent<{
      */
     draggable?: boolean;
     /**
-     * 是否激活状态
+     * 渲染标签
      */
-    active?: boolean;
+    renderTag?: (h: typeof createVNode, userInfo: FormattedUser) => VNode;
     /**
      * 是否显示租户信息
      */
     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<{
+    tenants: Record<string, string>;
     /**
      * 用户信息
      */
     user: FormattedUser;
+}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    click: (...args: any[]) => void;
+    close: (...args: any[]) => void;
+}, string, import("vue").PublicProps, Readonly<{
     /**
-     * 租户数据映射
+     * 是否激活状态
      */
-    tenants: Record<string, string>;
+    active?: boolean;
     /**
      * 当前租户ID
      */
@@ -50,17 +46,21 @@ declare const _default: import("vue").DefineComponent<{
      */
     draggable?: boolean;
     /**
-     * 是否激活状态
+     * 渲染标签
      */
-    active?: boolean;
+    renderTag?: (h: typeof createVNode, userInfo: FormattedUser) => VNode;
     /**
      * 是否显示租户信息
      */
     showTenant?: boolean;
     /**
-     * 渲染标签
+     * 租户数据映射
      */
-    renderTag?: (h: typeof createVNode, userInfo: FormattedUser) => VNode;
+    tenants: Record<string, string>;
+    /**
+     * 用户信息
+     */
+    user: FormattedUser;
 }> & Readonly<{
     onClick?: ((...args: any[]) => any) | undefined;
     onClose?: ((...args: any[]) => any) | undefined;

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

@@ -1,19 +1,19 @@
 import { type MaybeRef, type ShallowRef } from 'vue';
 export interface JSONPOptions {
-    /** 超时时间（毫秒），默认为 2 * 60 * 1000 */
-    timeout?: number;
     /** 请求参数 */
     params?: Record<string, string | undefined>;
+    /** 超时时间（毫秒），默认为 2 * 60 * 1000 */
+    timeout?: number;
     /** 是否携带凭证（cookie），默认为 true */
     withCredentials?: boolean;
 }
 export interface JSONPResult<T> {
     /** 响应数据 */
-    data: ShallowRef<T | null>;
-    /** 加载状态 */
-    loading: ShallowRef<boolean>;
+    data: ShallowRef<null | T>;
     /** 错误信息 */
     error: ShallowRef<Error | null>;
+    /** 加载状态 */
+    loading: ShallowRef<boolean>;
     /** 手动触发请求的函数 */
     refetch: () => void;
 }

package/typings/hooks/useUserSearch.d.ts

@@ -3,7 +3,7 @@
  * @module hooks/useUserSearch
  */
 import { type Ref } from 'vue';
-import { type FormattedUser } from '../types';
+import type { FormattedUser } from '../types';
 /**
  * 使用用户搜索的Hook
  * @param apiBaseUrl - API基础URL

package/typings/types/index.d.ts

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

package/typings/utils/common.d.ts

@@ -2,7 +2,7 @@
  * 通用工具函数
  * @module utils/common
  */
-import { type FormattedUser } from '../types';
+import type { FormattedUser } from '../types';
 /**
  * 防抖函数
  * @param fn - 需要防抖的函数