@airpower/web 0.1.2 → 0.2.0

package/dist/decorator/@Table/ITableColumn.d.ts

@@ -0,0 +1,63 @@
+import { DateTimeFormatter, DesensitizeType } from '@airpower/util';
+import { IBaseField } from '../common';
+import { IElementTableColumn } from './IElementTableColumn';
+/**
+ * # 表格的字段配置接口
+ *
+ * @author Hamm.cn
+ */
+export interface ITableColumn extends IBaseField, IElementTableColumn {
+    /**
+     * ### 是否是金额
+     */
+    money?: boolean;
+    /**
+     * ### 列排序
+     * 越大越靠前
+     */
+    order?: number;
+    /**
+     * ### 是否隐藏
+     */
+    hide?: boolean;
+    /**
+     * ### 是否强制显示
+     */
+    force?: boolean;
+    /**
+     * ### 是否强制不换行
+     */
+    nowrap?: boolean;
+    /**
+     * ### 删除列
+     */
+    removed?: boolean;
+    /**
+     * ### 空值显示
+     */
+    emptyValue?: string;
+    /**
+     * ### 后缀文本
+     */
+    suffixText?: string;
+    /**
+     * ### 是否可复制
+     */
+    copy?: boolean;
+    /**
+     * ### 前缀文本
+     */
+    prefixText?: string;
+    /**
+     * ### 是否显示颜色状态灯
+     */
+    color?: boolean;
+    /**
+     * ### 脱敏类型
+     */
+    desensitize?: DesensitizeType;
+    /**
+     * ### 是否是日期时间
+     */
+    datetime?: boolean | DateTimeFormatter;
+}

package/dist/decorator/{@table → @Table}/Table.d.ts

@@ -1,16 +1,16 @@
-import { DecoratorTarget } from '@airpower/core';
-import { ITableFieldConfig } from './ITableFieldConfig';
+import { DecoratorTarget } from '@airpower/transformer';
+import { ITableColumn } from './ITableColumn';
 /**
  * ### 为属性标记是表格字段
  * @param config 表格列的配置
  */
-export declare function Table(config?: ITableFieldConfig): (target: DecoratorTarget, key: string) => void;
+export declare function Table(config?: ITableColumn): (target: DecoratorTarget, key: string) => void;
 /**
  * ### 获取对象的属性表格的配置
  * @param target 目标对象
  * @param key 属性名
  */
-export declare function getTableConfig(target: DecoratorTarget, key: string): ITableFieldConfig | null;
+export declare function getTableConfig(target: DecoratorTarget, key: string): ITableColumn;
 /**
  * ### 获取标记了表格配置的字段列表
  * @param target 目标对象
@@ -21,4 +21,4 @@ export declare function getTableFieldList(target: DecoratorTarget): string[];
  * @param target 目标实体类
  * @param keyList 字段列表
  */
-export declare function getTableConfigList(target: DecoratorTarget, keyList: string[]): ITableFieldConfig[];
+export declare function getTableConfigList(target: DecoratorTarget, keyList?: string[]): Array<ITableColumn>;

package/dist/decorator/{@table → @Table}/index.d.ts

@@ -1,4 +1,4 @@
 export * from './IElementTableColumn';
-export * from './ITableFieldConfig';
+export * from './ITableColumn';
 export * from './Table';
 export * from './TableType';

package/dist/decorator/common/IBaseField.d.ts

@@ -0,0 +1,12 @@
+/**
+ * ### 字段基础配置
+ *
+ * @author Hamm.cn
+ */
+export interface IBaseField {
+    /**
+     * ### 字段标题
+     * 此字段无需传入, 将自动从被标记类的属性上读取
+     */
+    key?: string;
+}

package/dist/decorator/common/index.d.ts

@@ -0,0 +1 @@
+export * from './IBaseField';

package/dist/decorator/index.d.ts

@@ -1 +1,6 @@
-export * from './@table';
+export * from './@Field';
+export * from './@Form';
+export * from './@Model';
+export * from './@Search';
+export * from './@Table';
+export * from './common';

package/dist/enum/DisableEnum.d.ts

@@ -0,0 +1,10 @@
+import { WebEnum } from './WebEnum';
+/**
+ * ### 禁用状态枚举
+ *
+ * @author Hamm.cn
+ */
+export declare class DisableEnum extends WebEnum {
+    static ENABLE: DisableEnum;
+    static DISABLED: DisableEnum;
+}

package/dist/enum/IWebEnum.d.ts

@@ -0,0 +1,13 @@
+import { IEnum } from '@airpower/enum';
+import { EnumKey } from '@airpower/enum/dist/enum/type';
+import { WebColorString } from './type';
+export interface IWebEnum<K extends EnumKey = number> extends IEnum<K> {
+    /**
+     * ### 颜色
+     */
+    color?: WebColorString;
+    /**
+     * ### 是否禁用
+     */
+    disabled?: boolean;
+}

package/dist/enum/WebColor.d.ts

@@ -0,0 +1,23 @@
+/**
+ * # 标准颜色值
+ *
+ * @author Hamm.cn
+ */
+export declare enum WebColor {
+    /**
+     * ### 绿色正常状态
+     */
+    SUCCESS = "#67C23A",
+    /**
+     * ### 橙色警告状态
+     */
+    WARNING = "#E6A23C",
+    /**
+     * ### 红色错误状态
+     */
+    DANGER = "#F56C6C",
+    /**
+     * ### 灰色未知状态
+     */
+    NORMAL = "#909399"
+}

package/dist/enum/WebEnum.d.ts

@@ -0,0 +1,20 @@
+import { EnumKey, Enum } from '@airpower/enum';
+import { IWebEnum } from './IWebEnum';
+import { WebColorString } from './type';
+/**
+ * ### 网页枚举封装
+ *
+ * @author Hamm.cn
+ */
+export declare class WebEnum<K extends EnumKey = number> extends Enum<K> implements IWebEnum<K> {
+    color?: WebColorString;
+    disabled?: boolean;
+    /**
+     * ### 设置颜色
+     */
+    setColor(color: WebColorString): this;
+    /**
+     * ### 设置禁用
+     */
+    setDisabled(disabled?: boolean): this;
+}

package/dist/enum/index.d.ts

@@ -0,0 +1,5 @@
+export * from './DisableEnum';
+export * from './IWebEnum';
+export * from './type';
+export * from './WebColor';
+export * from './WebEnum';

package/dist/enum/type.d.ts

@@ -0,0 +1,8 @@
+import { EnumConstructor, EnumKey } from '@airpower/enum';
+import { WebColor } from './WebColor';
+import { WebEnum } from './WebEnum';
+/**
+ * ### 颜色值
+ */
+export type WebColorString = WebColor | string;
+export type WebEnumConstructor<K extends EnumKey = EnumKey, E extends WebEnum<K> = WebEnum<K>> = typeof WebEnum<K> & EnumConstructor<K, E>;

package/dist/{controller/interface/IDetailControllerOption.d.ts → hooks/detail/IDetailOption.d.ts}

@@ -1,10 +1,9 @@
-import { Entity } from '@airpower/core';
+import { RootEntity } from '../../base';
 /**
- * # 详情控制器配置项
- *
+ * # `Detail` 的 `Hook` 可选配置
  * @author Hamm.cn
  */
-export interface IDetailControllerOption<E extends Entity> {
+export interface IDetailOption<E extends RootEntity> {
     /**
      * ### 查到详情后的事件
      * 参数为响应的数据,请处理后返回

package/dist/hooks/detail/IDetailResult.d.ts

@@ -0,0 +1,30 @@
+import { Ref } from 'vue';
+import { RootEntity } from '../../base';
+import { AbstractCurdService } from '../../curd';
+/**
+ * # 详情的 `Hook` 标准返回
+ * @author Hamm.cn
+ */
+export interface IDetailResult<E extends RootEntity, S extends AbstractCurdService<E>> {
+    /**
+     * ### 对话框显示的标题
+     */
+    title: Ref<string>;
+    /**
+     * ### 表单或详情数据
+     */
+    formData: Ref<E>;
+    /**
+     * ### 当前绑定的 `Loading` 状态
+     * 请随意 `v-loading` 到你需要的地方
+     */
+    isLoading: Ref<boolean>;
+    /**
+     * ### 当前 `Hook` 使用的 `Service` 实例
+     */
+    service: S;
+    /**
+     * ### 查询详情
+     */
+    getDetail: () => void;
+}

package/dist/hooks/detail/index.d.ts

@@ -0,0 +1,3 @@
+export * from './IDetailOption';
+export * from './IDetailResult';
+export * from './useDetail';

package/dist/hooks/detail/useDetail.d.ts

@@ -0,0 +1,13 @@
+import { IJson } from '@airpower/transformer';
+import { RootEntity } from '../../base';
+import { AbstractCurdService, CurdServiceConstructor } from '../../curd';
+import { IDetailOption } from './IDetailOption';
+import { IDetailResult } from './IDetailResult';
+/**
+ * # 引入详情的`Hook`
+ * @param props `defineProps` 的返回值
+ * @param serviceClass 详情使用的 `Service`
+ * @param option `可选` 更多的配置
+ * @author Hamm.cn
+ */
+export declare function useDetail<E extends RootEntity, S extends AbstractCurdService<E>>(props: IJson, serviceClass: CurdServiceConstructor<E, S>, option?: IDetailOption<E>): IDetailResult<E, S>;

package/dist/{controller/interface/IUseEditorOption.d.ts → hooks/editor/IEditorOption.d.ts}

@@ -1,11 +1,15 @@
-import { Entity } from '@airpower/core';
-import { IDetailControllerOption } from './IDetailControllerOption';
+import { RootEntity } from '../../base';
+import { WebValidateRule } from '../../util';
+import { IDetailOption } from '../detail';
 /**
- * # 编辑控制器的可选配置
- *
+ * # `Editor` 的 `Hook` 可选配置
  * @author Hamm.cn
  */
-export interface IUseEditorOption<E extends Entity> extends IDetailControllerOption<E> {
+export interface IEditorOption<E extends RootEntity> extends IDetailOption<E> {
+    /**
+     * ### 自定义验证
+     */
+    customRules?: WebValidateRule<E>;
     /**
      * ### 编辑成功的提示消息
      */
@@ -17,6 +21,10 @@ export interface IUseEditorOption<E extends Entity> extends IDetailControllerOpt
      * @param submitData 实体
      */
     beforeSubmit?: (submitData: E) => E | null;
+    /**
+     * ### 请求要求继续操作
+     */
+    successAndContinue?: (data: E) => void;
     /**
      * ### 请求添加的URL
      *

package/dist/hooks/editor/IEditorResult.d.ts

@@ -0,0 +1,29 @@
+import { FormInstance } from 'element-plus';
+import { Ref } from 'vue';
+import { RootEntity } from '../../base';
+import { AbstractCurdService } from '../../curd';
+import { WebValidateRule } from '../../util';
+import { IDetailResult } from '../detail';
+/**
+ * # `Editor` 的 `Hook` 标准返回
+ * @author Hamm.cn
+ */
+export interface IEditorResult<E extends RootEntity, S extends AbstractCurdService<E>> extends IDetailResult<E, S> {
+    /**
+     * ### 表单的 `Ref` 对象
+     * 你可以绑定到组件中, 它将自动为你验证
+     * - `ADialog` 的 `:form-ref`
+     * - `el-form` 的 `ref`
+     */
+    formRef: Ref<FormInstance>;
+    /**
+     * ### 表单的验证规则
+     * 你可以绑定到 `el-form` 的 `:rules` 上
+     */
+    rules: WebValidateRule<E>;
+    /**
+     * ### 表单提交的方法
+     * 你可以使用 `beforeSubmit` 方法来拦截请求的数据
+     */
+    onSubmit: () => void;
+}

package/dist/hooks/editor/index.d.ts

@@ -0,0 +1,3 @@
+export * from './IEditorOption';
+export * from './IEditorResult';
+export * from './useEditor';

package/dist/hooks/editor/useEditor.d.ts

@@ -0,0 +1,13 @@
+import { IJson } from '@airpower/transformer';
+import { RootEntity } from '../../base';
+import { AbstractCurdService, CurdServiceConstructor } from '../../curd';
+import { IEditorOption } from './IEditorOption';
+import { IEditorResult } from './IEditorResult';
+/**
+ * # 引入`Editor`的`Hook`
+ * @param props `defineProps`的返回值
+ * @param serviceClass `Editor`使用的`Service`
+ * @param option `可选` 更多的配置
+ * @author Hamm.cn
+ */
+export declare function useEditor<E extends RootEntity, S extends AbstractCurdService<E>>(props: IJson, serviceClass: CurdServiceConstructor<E, S>, option?: IEditorOption<E>): IEditorResult<E, S>;

package/dist/hooks/index.d.ts

@@ -0,0 +1,3 @@
+export * from './detail';
+export * from './editor';
+export * from './table';

package/dist/{controller/interface/ITableControllerOption.d.ts → hooks/table/base/IBaseTableOption.d.ts}

@@ -1,11 +1,11 @@
-import { Entity, QueryPageRequest } from '@airpower/core';
 import { Component } from 'vue';
+import { RootEntity } from '../../../base';
+import { QueryRequestPage } from '../../../model';
 /**
- * # 表格控制器配置项
- *
+ * # 表格相关的根级配置项
  * @author Hamm.cn
  */
-export interface ITableControllerOption<E extends Entity> {
+export interface IBaseTableOption<E extends RootEntity> {
     /**
      * ### 不分页
      * 默认请求分页接口 如配置了 `treeList` 则此项自动失效
@@ -39,5 +39,5 @@ export interface ITableControllerOption<E extends Entity> {
      *
      * @param requestData 请求对象
      */
-    beforeSearch?: (requestData: QueryPageRequest<E>) => QueryPageRequest<E> | void;
+    beforeSearch?: (requestData: QueryRequestPage<E>) => QueryRequestPage<E> | void;
 }

package/dist/hooks/table/base/IBaseTableResult.d.ts

@@ -0,0 +1,81 @@
+import { Ref } from 'vue';
+import { RootEntity } from '../../../base';
+import { AbstractCurdService } from '../../../curd';
+import { QueryPage, QueryRequestPage, QueryResponsePage, QuerySort } from '../../../model';
+/**
+ * # `TableHook` 的基础返回结构
+ * @author Hamm.cn
+ */
+export interface IBaseTableResult<E extends RootEntity, S extends AbstractCurdService<E>> {
+    /**
+     * ### 当前绑定的 `Loading` 状态
+     * 请随意 `v-loading` 到你需要的地方
+     */
+    isLoading: Ref<boolean>;
+    /**
+     * ### 响应数据
+     */
+    response: Ref<QueryResponsePage<E>>;
+    /**
+     * ### 请求数据
+     */
+    request: Ref<QueryRequestPage<E>>;
+    /**
+     * ### 返回的单页数据列表
+     */
+    list: Ref<E[]>;
+    /**
+     * ### 选中的数据列表
+     */
+    selectList: Ref<E[]>;
+    /**
+     * ### 实体的实例
+     */
+    entity: E;
+    /**
+     * ### `Service`的实例
+     */
+    service: S;
+    /**
+     * ### 刷新数据 返回第一页
+     */
+    onReloadData: () => void;
+    /**
+     * ### 搜索事件
+     *
+     * @param request 请求对象
+     */
+    onSearch: (request: QueryRequestPage<E>) => void;
+    /**
+     * ### 分页变更事件
+     *
+     * @param page 分页对象
+     */
+    onPageChanged: (page: QueryPage) => void;
+    /**
+     * ### 详情事件
+     *
+     * @param row 选择的行
+     */
+    onDetail: (row: E) => void;
+    /**
+     * ### 添加事件
+     */
+    onAdd: () => void;
+    /**
+     * ### 排序变更事件
+     *
+     * @param sort 排序对象
+     */
+    onSortChanged: (sort?: QuerySort) => void | Promise<void>;
+    /**
+     * ### 多选事件
+     *
+     * @param list 选择的行列表
+     */
+    onSelected: (list: E[]) => void;
+    /**
+     * ### 刷新数据 保持留在当页
+     */
+    onGetList: () => void;
+}

package/dist/hooks/table/base/index.d.ts

@@ -0,0 +1,3 @@
+export * from './IBaseTableOption';
+export * from './IBaseTableResult';
+export * from './useBaseTable';

package/dist/hooks/table/base/useBaseTable.d.ts

@@ -0,0 +1,11 @@
+import { RootEntity } from '../../../base';
+import { AbstractCurdService, CurdServiceConstructor } from '../../../curd';
+import { IBaseTableOption } from './IBaseTableOption';
+import { IBaseTableResult } from './IBaseTableResult';
+/**
+ * # 表格基础`Hook`
+ * @param serviceClass 表格使用的 `Service` 类
+ * @param option `可选` 更多配置
+ * @author Hamm.cn
+ */
+export declare function useBaseTable<E extends RootEntity, S extends AbstractCurdService<E>>(serviceClass: CurdServiceConstructor<E, S>, option?: IBaseTableOption<E>): IBaseTableResult<E, S>;

package/dist/hooks/table/index.d.ts

@@ -0,0 +1,4 @@
+export * from './base';
+export * from './list';
+export * from './selector';
+export * from './tree';

package/dist/hooks/table/list/ITableOption.d.ts

@@ -0,0 +1,8 @@
+import { RootEntity } from '../../../base';
+import { IBaseTableOption } from '../base/IBaseTableOption';
+/**
+ * # `TableList` 的 `Hook` 可选配置
+ * @author Hamm.cn
+ */
+export interface ITableOption<E extends RootEntity> extends IBaseTableOption<E> {
+}

package/dist/hooks/table/list/ITableResult.d.ts

@@ -0,0 +1,33 @@
+import { RootEntity } from '../../../base';
+import { AbstractCurdService } from '../../../curd';
+import { IBaseTableResult } from '../base';
+/**
+ * # 表格的 `Hook` 标准返回
+ * @author Hamm.cn
+ */
+export interface ITableResult<E extends RootEntity, S extends AbstractCurdService<E>> extends IBaseTableResult<E, S> {
+    /**
+     * ### 编辑事件
+     *
+     * @param row 选择的行
+     */
+    onEdit: (row: E) => void;
+    /**
+     * ### 删除事件
+     *
+     * @param row 选择的行
+     */
+    onDelete: (row: E) => void;
+    /**
+     * ### 禁用事件
+     *
+     * @param row 选择的行
+     */
+    onDisable: (row: E) => void;
+    /**
+     * ### 启用事件
+     *
+     * @param row 选择的行
+     */
+    onEnable: (row: E) => void;
+}

package/dist/hooks/table/list/index.d.ts

@@ -0,0 +1,3 @@
+export * from './ITableOption';
+export * from './ITableResult';
+export * from './useTable';

package/dist/hooks/table/list/useTable.d.ts

@@ -0,0 +1,11 @@
+import { RootEntity } from '../../../base';
+import { AbstractCurdService, CurdServiceConstructor } from '../../../curd';
+import { ITableOption } from './ITableOption';
+import { ITableResult } from './ITableResult';
+/**
+ * # 引入表格使用的`Hook`
+ * @param serviceClass 表格使用的`Service`类
+ * @param option `可选` 更多配置
+ * @author Hamm.cn
+ */
+export declare function useTable<E extends RootEntity, S extends AbstractCurdService<E>>(serviceClass: CurdServiceConstructor<E, S>, option?: ITableOption<E>): ITableResult<E, S>;

package/dist/hooks/table/selector/ISelectorOption.d.ts

@@ -0,0 +1,8 @@
+import { RootEntity } from '../../../base';
+import { IBaseTableOption } from '../base';
+/**
+ * # `Selector` 的 `Hook` 可选配置
+ * @author Hamm.cn
+ */
+export interface ISelectorOption<E extends RootEntity> extends IBaseTableOption<E> {
+}

package/dist/hooks/table/selector/ISelectorResult.d.ts

@@ -0,0 +1,19 @@
+import { Ref } from 'vue';
+import { RootEntity } from '../../../base';
+import { AbstractCurdService } from '../../../curd';
+import { IBaseTableResult } from '../base';
+/**
+ * # 选择器 `Hook` 的标准返回
+ * @author Hamm.cn
+ */
+export interface ISelectorResult<E extends RootEntity, S extends AbstractCurdService<E>> extends IBaseTableResult<E, S> {
+    /**
+     * ### `Selector` 的标题
+     */
+    title: Ref<string>;
+    /**
+     * ### 是否禁用确认按钮
+     * 多选时当没有选择任何数据时将禁用确认按钮
+     */
+    disableConfirm: Ref<boolean>;
+}

package/dist/hooks/table/selector/index.d.ts

@@ -0,0 +1,3 @@
+export * from './ISelectorOption';
+export * from './ISelectorResult';
+export * from './useSelector';

package/dist/hooks/table/selector/useSelector.d.ts

@@ -0,0 +1,13 @@
+import { IJson } from '@airpower/transformer';
+import { RootEntity } from '../../../base';
+import { AbstractCurdService, CurdServiceConstructor } from '../../../curd';
+import { ISelectorOption } from './ISelectorOption';
+import { ISelectorResult } from './ISelectorResult';
+/**
+ * # 引入`Selector`使用的`Hook`
+ * @param props `defineProps`的返回值
+ * @param serviceClass `Selector`使用的`Service`类
+ * @param option `可选` 更多配置
+ * @author Hamm.cn
+ */
+export declare function useSelector<E extends RootEntity, S extends AbstractCurdService<E>>(props: IJson, serviceClass: CurdServiceConstructor<E, S>, option?: ISelectorOption<E>): ISelectorResult<E, S>;

package/dist/{controller/interface/ITableTreeControllerOption.d.ts → hooks/table/tree/ITableTreeOption.d.ts}

@@ -1,11 +1,11 @@
-import { Entity, ITree } from '@airpower/core';
-import { ITableControllerOption } from './ITableControllerOption';
+import { RootEntity } from '../../../base';
+import { ITree } from '../../../model';
+import { ITableOption } from '../list';
 /**
- * # 表格树控制器配置项
- *
+ * # `TableTreeList` 的 `Hook` 可选配置
  * @author Hamm.cn
  */
-export interface ITableTreeControllerOption<T extends ITree & Entity> extends ITableControllerOption<T> {
+export interface ITableTreeOption<T extends ITree & RootEntity> extends ITableOption<T> {
     /**
      * ### 添加行的子项的前置拦截方法
      * 参数为发起请求的数据,请处理后返回 `param`

package/dist/hooks/table/tree/ITableTreeResult.d.ts

@@ -0,0 +1,13 @@
+import { RootEntity } from '../../../base';
+import { AbstractCurdService } from '../../../curd';
+import { ITableResult } from '../list';
+/**
+ * # 树表格的 `Hook` 标准返回
+ * @author Hamm.cn
+ */
+export interface ITableTreeResult<E extends RootEntity, S extends AbstractCurdService<E>> extends ITableResult<E, S> {
+    /**
+     * ### 表格行的添加按钮点击事件
+     */
+    onAddRow: (row: E) => void;
+}

package/dist/hooks/table/tree/index.d.ts

@@ -0,0 +1,3 @@
+export * from './ITableTreeOption';
+export * from './ITableTreeResult';
+export * from './useTableTree';

package/dist/hooks/table/tree/useTableTree.d.ts

@@ -0,0 +1,12 @@
+import { RootEntity } from '../../../base';
+import { AbstractCurdService, CurdServiceConstructor } from '../../../curd';
+import { ITree } from '../../../model';
+import { ITableTreeOption } from './ITableTreeOption';
+import { ITableTreeResult } from './ITableTreeResult';
+/**
+ * # 引入表格树使用的`Hook`
+ * @param serviceClass 表格使用的`Service`类
+ * @param option `可选` 更多配置
+ * @author Hamm.cn
+ */
+export declare function useTableTree<E extends ITree & RootEntity, S extends AbstractCurdService<E>>(serviceClass: CurdServiceConstructor<E, S>, option?: ITableTreeOption<E>): ITableTreeResult<E, S>;