@ibiz-template/vue3-components 0.7.40-alpha.9 → 0.7.40

package/es/panel-component/auth-captcha/auth-captcha.state.mjs

@@ -11,37 +11,38 @@ class AuthCaptchaState extends PanelItemState {
   constructor() {
     super(...arguments);
     /**
-     * 验证码
-     *
+     * @description 验证码
+     * @exposedoc
+     * @description ''
      * @type {string}
      * @memberof AuthCaptchaState
      */
     __publicField(this, "code", "");
     /**
-     * 验证图片
-     *
+     * @description 验证图片
+     * @exposedoc
      * @type {string}
      * @memberof AuthCaptchaState
      */
     __publicField(this, "image", "");
     /**
-     * 验证UUID码
-     *
+     * @description 验证UUID码
+     * @exposedoc
      * @type {string}
      * @memberof AuthCaptchaState
      */
     __publicField(this, "state", "");
     /**
-     * 加载状态
-     *
+     * @description 加载状态
+     * @exposedoc
      * @type {boolean}
      * @memberof AuthCaptchaState
      */
     __publicField(this, "loading", false);
     /**
-     * 错误信息
-     *
+     * @description 错误信息
      * @type {string}
+     * @exposedoc
      * @memberof AuthCaptchaState
      */
     __publicField(this, "error");

package/es/panel-component/auth-sso/auth-sso.d.ts

@@ -2,11 +2,22 @@ import { PropType } from 'vue';
 import { PanelItemController } from '@ibiz-template/runtime';
 import { IPanelRawItem } from '@ibiz/model-core';
 import './auth-sso.scss';
+/**
+ * 第三方登录
+ * @description 提供了钉钉和企业微信的第三方登录入口。
+ * @primary
+ */
 export declare const AuthSso: import("vue").DefineComponent<{
+    /**
+     * @description 第三方登录控件模型数据
+     */
     modelData: {
         type: PropType<IPanelRawItem>;
         required: true;
     };
+    /**
+     * @description 第三方登录控件控制器
+     */
     controller: {
         type: typeof PanelItemController;
         required: true;
@@ -15,10 +26,16 @@ export declare const AuthSso: import("vue").DefineComponent<{
     ns: import("@ibiz-template/core").Namespace;
     handleThridLogin: (type: string) => void;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * @description 第三方登录控件模型数据
+     */
     modelData: {
         type: PropType<IPanelRawItem>;
         required: true;
     };
+    /**
+     * @description 第三方登录控件控制器
+     */
     controller: {
         type: typeof PanelItemController;
         required: true;

package/es/panel-component/auth-sso/auth-sso.mjs

@@ -1,4 +1,4 @@
-import { defineComponent, createVNode } from 'vue';
+import { createVNode, defineComponent } from 'vue';
 import { PanelItemController } from '@ibiz-template/runtime';
 import { useNamespace } from '@ibiz-template/vue3-util';
 import './auth-sso.css';
@@ -7,10 +7,16 @@ import './auth-sso.css';
 const AuthSso = /* @__PURE__ */ defineComponent({
   name: "IBizAuthSsO",
   props: {
+    /**
+     * @description 第三方登录控件模型数据
+     */
     modelData: {
       type: Object,
       required: true
     },
+    /**
+     * @description 第三方登录控件控制器
+     */
     controller: {
       type: PanelItemController,
       required: true

package/es/panel-component/auth-userinfo/auth-userinfo.d.ts

@@ -2,11 +2,22 @@ import { PropType } from 'vue';
 import './auth-userinfo.scss';
 import { IPanelRawItem } from '@ibiz/model-core';
 import { PanelItemController } from '@ibiz-template/runtime';
+/**
+ * 用户信息
+ * @description 展示用户的基本信息，提供登出功能。
+ * @primary
+ */
 export declare const AuthUserinfo: import("vue").DefineComponent<{
+    /**
+     * @description 用户信息控件模型数据
+     */
     modelData: {
         type: PropType<IPanelRawItem>;
         required: true;
     };
+    /**
+     * @description 用户信息控件控制器
+     */
     controller: {
         type: typeof PanelItemController;
         required: true;
@@ -21,10 +32,16 @@ export declare const AuthUserinfo: import("vue").DefineComponent<{
     menuAlign: import("vue").ComputedRef<string>;
     isCollapse: import("vue").ComputedRef<any>;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * @description 用户信息控件模型数据
+     */
     modelData: {
         type: PropType<IPanelRawItem>;
         required: true;
     };
+    /**
+     * @description 用户信息控件控制器
+     */
     controller: {
         type: typeof PanelItemController;
         required: true;

package/es/panel-component/auth-userinfo/auth-userinfo.mjs

@@ -1,4 +1,4 @@
-import { defineComponent, inject, computed, createVNode, resolveComponent } from 'vue';
+import { inject, computed, resolveComponent, createVNode, defineComponent } from 'vue';
 import { useRouter } from 'vue-router';
 import { useNamespace } from '@ibiz-template/vue3-util';
 import './auth-userinfo.css';
@@ -8,10 +8,16 @@ import { PanelItemController } from '@ibiz-template/runtime';
 const AuthUserinfo = /* @__PURE__ */ defineComponent({
   name: "IBizAuthUserinfo",
   props: {
+    /**
+     * @description 用户信息控件模型数据
+     */
     modelData: {
       type: Object,
       required: true
     },
+    /**
+     * @description 用户信息控件控制器
+     */
     controller: {
       type: PanelItemController,
       required: true

package/es/panel-component/coop-pos/coop-pos.controller.d.ts

@@ -1,6 +1,12 @@
 import { CodeListItem, IAlertParams, PanelItemController } from '@ibiz-template/runtime';
 import { IPanelRawItem } from '@ibiz/model-core';
 import { CoopPosState } from './coop-pos.state';
+/**
+ * @description 消息协同占位控制器
+ * @export
+ * @class CoopPosController
+ * @extends {PanelItemController<IPanelRawItem>}
+ */
 export declare class CoopPosController extends PanelItemController<IPanelRawItem> {
     state: CoopPosState;
     /**
@@ -12,12 +18,14 @@ export declare class CoopPosController extends PanelItemController<IPanelRawItem
     /**
      * @description 自定义补充参数
      * @type {IData}
+     * @exposedoc
      * @memberof CoopPosController
      */
     rawItemParams: IData;
     /**
      * @description 显示模式
      * @type {('avatar' | 'default')}
+     * @exposedoc
      * @memberof CoopPosController
      */
     showMode: 'avatar' | 'default';

package/es/panel-component/coop-pos/coop-pos.controller.mjs

@@ -21,12 +21,14 @@ class CoopPosController extends PanelItemController {
     /**
      * @description 自定义补充参数
      * @type {IData}
+     * @exposedoc
      * @memberof CoopPosController
      */
     __publicField(this, "rawItemParams", {});
     /**
      * @description 显示模式
      * @type {('avatar' | 'default')}
+     * @exposedoc
      * @memberof CoopPosController
      */
     __publicField(this, "showMode", "default");

package/es/panel-component/coop-pos/coop-pos.d.ts

@@ -3,20 +3,29 @@ import { IPanelRawItem } from '@ibiz/model-core';
 import { CoopPosController } from './coop-pos.controller';
 import './coop-pos.scss';
 /**
- * 协同消息占位
- * - 该组件有两种呈现模式，默认是Alert呈现，当视图配置【标记数据打开模式】勾选【显示操作人员】时以用户头像呈现
- * - 该组件会根据【标记数据打开模式】的配置计算需要呈现的用户消息，默认显示当前用户
- *  1. 只勾选了【显示操作人员】时，所有的操作类型的用户都会呈现
- *  2. 勾选其他的【标记数据打开模式】时，会根据勾选项过滤操作用户
- *    勾选【登记打开数据】 -> 显示浏览用户
- *    勾选【登记更新数据】 -> 显示编辑用户
- *    勾选【提示刷新数据】 -> 显示更新用户
+ * 消息协同占位
+ * @primary
+ * @description 该组件有两种呈现模式，默认是Alert呈现，当视图配置【标记数据打开模式】勾选【显示操作人员】时以用户头像呈现
+ *  1. 该组件会根据【标记数据打开模式】的配置计算需要呈现的用户消息，默认显示当前用户
+ *  2. 只勾选了【显示操作人员】时，所有的操作类型的用户都会呈现
+ *  3. 勾选其他的【标记数据打开模式】时，会根据勾选项过滤操作用户:
+ *      - 勾选【登记打开数据】 -> 显示浏览用户
+ *      - 勾选【登记更新数据】 -> 显示编辑用户
+ *      - 勾选【提示刷新数据】 -> 显示更新用户
+ * @panelitemparams {name:showmode,parameterType:avatar|default,defaultvalue:default,description:当值为avatar时会绘制头像}
+ *
  */
 export declare const CoopPos: import("vue").DefineComponent<{
+    /**
+     * @description 协同占位控件模型数据
+     */
     modelData: {
         type: PropType<IPanelRawItem>;
         required: true;
     };
+    /**
+     * @description 协同占位控件控制器
+     */
     controller: {
         type: typeof CoopPosController;
         required: true;
@@ -29,10 +38,16 @@ export declare const CoopPos: import("vue").DefineComponent<{
         [key: string]: any;
     }> | null;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * @description 协同占位控件模型数据
+     */
     modelData: {
         type: PropType<IPanelRawItem>;
         required: true;
     };
+    /**
+     * @description 协同占位控件控制器
+     */
     controller: {
         type: typeof CoopPosController;
         required: true;

package/es/panel-component/coop-pos/coop-pos.mjs

@@ -1,4 +1,4 @@
-import { defineComponent, ref, computed, createVNode, resolveComponent, mergeProps } from 'vue';
+import { ref, computed, createVNode, resolveComponent, mergeProps, defineComponent } from 'vue';
 import { useNamespace } from '@ibiz-template/vue3-util';
 import { CoopPosController } from './coop-pos.controller.mjs';
 import './coop-pos.css';
@@ -7,10 +7,16 @@ import './coop-pos.css';
 const CoopPos = /* @__PURE__ */ defineComponent({
   name: "IBizCoopPos",
   props: {
+    /**
+     * @description 协同占位控件模型数据
+     */
     modelData: {
       type: Object,
       required: true
     },
+    /**
+     * @description 协同占位控件控制器
+     */
     controller: {
       type: CoopPosController,
       required: true

package/es/panel-component/coop-pos/coop-pos.state.d.ts

@@ -1,23 +1,29 @@
 import { IAlertParams, PanelItemState } from '@ibiz-template/runtime';
+/**
+ * @description 协同占位状态
+ * @primary
+ * @export
+ * @class CoopPosState
+ * @extends {PanelItemState}
+ */
 export declare class CoopPosState extends PanelItemState {
     /**
-     * alert标识
-     *
-     * @author zhanghengfeng
-     * @date 2024-04-03 17:04:04
+     * @description alert标识
+     * @exposedoc
      * @type {string}
+     * @memberof CoopPosState
      */
     key: string;
     /**
-     * 消息模式
-     * - 显示操作人员模式下使用
+     * @description 消息模式，显示操作人员模式下使用
+     * @exposedoc
      * @type {string[]}
      * @memberof CoopPosState
      */
     messageModes: string[] | undefined;
     /**
-     * 消息map
-     *
+     * @description 消息map
+     * @exposedoc
      * @type {Map<string, IData>}
      * @memberof CoopPosState
      */

package/es/panel-component/coop-pos/coop-pos.state.mjs

@@ -12,23 +12,22 @@ class CoopPosState extends PanelItemState {
   constructor() {
     super(...arguments);
     /**
-     * alert标识
-     *
-     * @author zhanghengfeng
-     * @date 2024-04-03 17:04:04
+     * @description alert标识
+     * @exposedoc
      * @type {string}
+     * @memberof CoopPosState
      */
     __publicField(this, "key", createUUID());
     /**
-     * 消息模式
-     * - 显示操作人员模式下使用
+     * @description 消息模式，显示操作人员模式下使用
+     * @exposedoc
      * @type {string[]}
      * @memberof CoopPosState
      */
     __publicField(this, "messageModes");
     /**
-     * 消息map
-     *
+     * @description 消息map
+     * @exposedoc
      * @type {Map<string, IData>}
      * @memberof CoopPosState
      */

package/es/panel-component/data-import/data-import-shell.d.ts

@@ -2,11 +2,22 @@ import { PropType } from 'vue';
 import { IPanelRawItem } from '@ibiz/model-core';
 import { PanelItemController } from '@ibiz-template/runtime';
 import './data-import-shell.scss';
+/**
+ * 数据导入
+ * @primary
+ * @description 用于嵌入数据导入组件，会根据配置绘制默认导入数据视图。
+ */
 export declare const DataImportShell: import("vue").DefineComponent<{
+    /**
+     * @description 数据导入壳模型数据
+     */
     modelData: {
         type: PropType<IPanelRawItem>;
         required: true;
     };
+    /**
+     * @description 数据导入壳控制器
+     */
     controller: {
         type: typeof PanelItemController;
         required: true;
@@ -16,10 +27,16 @@ export declare const DataImportShell: import("vue").DefineComponent<{
     c: PanelItemController<import("@ibiz/model-core").IPanelItem>;
     onDismiss: () => void;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * @description 数据导入壳模型数据
+     */
     modelData: {
         type: PropType<IPanelRawItem>;
         required: true;
     };
+    /**
+     * @description 数据导入壳控制器
+     */
     controller: {
         type: typeof PanelItemController;
         required: true;

package/es/panel-component/data-import/data-import-shell.mjs

@@ -1,4 +1,4 @@
-import { defineComponent, h, resolveComponent } from 'vue';
+import { resolveComponent, h, defineComponent } from 'vue';
 import { useNamespace } from '@ibiz-template/vue3-util';
 import { PanelItemController } from '@ibiz-template/runtime';
 import './data-import-shell.css';
@@ -7,10 +7,16 @@ import './data-import-shell.css';
 const DataImportShell = /* @__PURE__ */ defineComponent({
   name: "IBizDataImportShell",
   props: {
+    /**
+     * @description 数据导入壳模型数据
+     */
     modelData: {
       type: Object,
       required: true
     },
+    /**
+     * @description 数据导入壳控制器
+     */
     controller: {
       type: PanelItemController,
       required: true

package/es/panel-component/global-search/global-search.controller.d.ts

@@ -1,37 +1,59 @@
-import { IModalData, PanelItemController } from '@ibiz-template/runtime';
-import { IPanelContainer } from '@ibiz/model-core';
+import { PanelItemController } from '@ibiz-template/runtime';
+import { IPanelRawItem } from '@ibiz/model-core';
+import { IHttpResponse } from '@ibiz-template/core';
 import { GlobalSearchState, ISearchItem } from './global-search.state';
 /**
  * 全局搜索控制器
  *
  * @export
  * @class GlobalSearchController
- * @extends {PanelItemController<IPanelContainer>}
+ * @extends {PanelItemController<IPanelRawItem>}
  */
-export declare class GlobalSearchController extends PanelItemController<IPanelContainer> {
+export declare class GlobalSearchController extends PanelItemController<IPanelRawItem> {
     state: GlobalSearchState;
     /**
-     * 主键属性名称
-     *
+     * @description 主键属性名称
+     * @exposedoc
      * @type {string}
      * @memberof GlobalSearchController
      */
     keyName: string;
     /**
-     * 主文本属性名称
-     *
+     * @description 主文本属性名称
+     * @exposedoc
      * @type {string}
      * @memberof GlobalSearchController
      */
     textName: string;
     /**
-     * 搜索历史缓存标识
-     *
+     * @description 自定义参数
+     * @exposedoc
+     * @protected
+     * @type {IData}
+     * @memberof GlobalSearchController
+     */
+    protected rawItemParams: IData;
+    /**
+     * @description 搜索历史缓存标识
      * @protected
      * @type {string}
      * @memberof GlobalSearchController
      */
-    protected historyCache: string;
+    protected historyCacheKey: string;
+    /**
+     * @description 最大历史记录，默认7条
+     * @protected
+     * @type {number}
+     * @memberof GlobalSearchController
+     */
+    protected maxHistory: number;
+    /**
+     * @description 单次查询最大数量，默认100条
+     * @exposedoc
+     * @type {number}
+     * @memberof GlobalSearchController
+     */
+    size: number;
     /**
      * 创建全局搜索状态对象
      *
@@ -49,65 +71,102 @@ export declare class GlobalSearchController extends PanelItemController<IPanelCo
      */
     protected onInit(): Promise<void>;
     /**
-     * 初始化全局搜索项
+     * 处理直接内容项参数
      *
      * @protected
      * @memberof GlobalSearchController
      */
-    protected initGlobalSearchItem(): Promise<void>;
+    protected handleRawItemParams(): void;
+    /**
+     * 初始化参数
+     *
+     * @protected
+     * @memberof GlobalSearchController
+     */
+    protected initParams(): void;
     /**
      * 初始化历史记录
      *
-     * @private
+     * @protected
+     * @memberof GlobalSearchController
+     */
+    protected initHistory(): void;
+    /**
+     * 初始化全局搜索项
+     *
+     * @protected
      * @memberof GlobalSearchController
      */
-    private initHistory;
+    protected initGlobalSearchItem(): Promise<void>;
     /**
      * 添加历史
-     * - 最多5条记录
-     * @private
+     *
+     * @protected
      * @param {string} query
      * @memberof GlobalSearchController
      */
-    private addToHistory;
+    protected addToHistory(query: string): void;
     /**
-     * 清除历史
+     * 获取查询参数
      *
+     * @protected
+     * @param {ISearchItem} item
+     * @return {*}  {IParams}
      * @memberof GlobalSearchController
      */
-    clearHistory(): void;
+    protected getFetchParams(item: ISearchItem): IParams;
     /**
-     * 搜索
+     * 处理响应头
      *
-     * @param {string} query
-     * @return {*}  {Promise<IData[]>}
+     * @protected
+     * @param {IHttpResponse} response
+     * @return {*}  {{
+     *     page: number;
+     *     total: number;
+     *   }}
      * @memberof GlobalSearchController
      */
-    search(query: string): Promise<IData[]>;
+    protected handleResponseHeader(response: IHttpResponse): {
+        page: number;
+        total: number;
+    };
     /**
      * 通过AC模式加载数据
      *
+     * @protected
      * @param {ISearchItem} item
-     * @param {string} [query]
+     * @return {*}  {Promise<IData[]>}
+     * @memberof GlobalSearchController
+     */
+    protected loadByACMode(item: ISearchItem): Promise<IData[]>;
+    /**
+     * @description 清除历史
+     * @exposedoc
+     * @memberof GlobalSearchController
+     */
+    clearHistory(): void;
+    /**
+     * @description 搜索
+     * @exposedoc
      * @return {*}  {Promise<void>}
      * @memberof GlobalSearchController
      */
-    loadByACMode(item: ISearchItem, query?: string): Promise<IData[]>;
+    search(value: string): Promise<void>;
     /**
      * 打开链接视图
      *
-     * @param {IData} data
-     * @param {ISearchItem} [item]
-     * @return {*}  {(Promise<IModalData | undefined>)}
+     * @param {IData} data 数据
+     * @param {ISearchItem} item 搜索项
+     * @return {*}  {void}
      * @memberof GlobalSearchController
      */
-    openLinkView(data: IData, item?: ISearchItem): Promise<IModalData | undefined>;
+    openLinkView(data: IData, item: ISearchItem): void;
     /**
      * 根据实体获取搜索项
      *
-     * @param {string} appDataEntityId 实体标识
+     * @param {string} [appDataEntityId] 实体标识
      * @return {*}  {(ISearchItem | undefined)}
      * @memberof GlobalSearchController
      */
-    getSearchItemByEntity(appDataEntityId: string): ISearchItem | undefined;
+    getSearchItemByEntity(appDataEntityId?: string): ISearchItem | undefined;
 }