@airpower/web 0.1.3 → 0.2.1

package/dist/curd/AbstractCurdService.d.ts

@@ -0,0 +1,138 @@
+import { ITransformerConstructor } from '@airpower/transformer';
+import { RootEntity, AbstractService } from '../base';
+import { QueryRequest, QueryResponsePage } from '../model';
+import { WebValidateRule } from '../util';
+/**
+ * # 实体 `API` 服务超类
+ * 包含了常用的增删改查等方法
+ *
+ * @param E 泛型实体类
+ * @author Hamm.cn
+ */
+export declare abstract class AbstractCurdService<E extends RootEntity> extends AbstractService {
+    /**
+     * ### 为基类提供当前的实体类
+     * 请求时会通过这个类进行数据转换
+     */
+    abstract entityClass: ITransformerConstructor<E>;
+    /**
+     * ### 分页查询默认 `URL`
+     */
+    protected urlGetPage: string;
+    /**
+     * ### 不分页查询默认 `URL`
+     */
+    protected urlGetList: string;
+    /**
+     * ### 不分页树查询默认 `URL`
+     */
+    protected urlGetTreeList: string;
+    /**
+     * ### 查询详情默认 `URL`
+     */
+    protected urlGetDetail: string;
+    /**
+     * ### 添加默认 `URL`
+     */
+    protected urlAdd: string;
+    /**
+     * ### 启用默认 `URL`
+     */
+    protected urlEnable: string;
+    /**
+     * ### 禁用默认 `URL`
+     */
+    protected urlDisable: string;
+    /**
+     * ### 修改默认 `URL`
+     */
+    protected urlUpdate: string;
+    /**
+     * ### 删除默认 `URL`
+     */
+    protected urlDelete: string;
+    /**
+     * ### 创建验证器
+     * @param form 表单对象
+     * @param moreRule `可选` 更多的验证规则
+     */
+    static createValidator<E extends RootEntity>(form: E, moreRule?: WebValidateRule<E>): WebValidateRule<E>;
+    /**
+     * ### 查询分页数据列表
+     * @param request 请求对象
+     * @param apiUrl `可选` 自定义请求URL
+     */
+    getPage(request: QueryRequest<E>, apiUrl?: string): Promise<QueryResponsePage<E>>;
+    /**
+     * ### 查询不分页数据列表
+     * @param request 请求对象
+     * @param apiUrl `可选` 自定义请求URL
+     */
+    getList(request: QueryRequest<E>, apiUrl?: string): Promise<E[]>;
+    /**
+     * ### 查询树结构数据数组
+     * @param request 请求对象
+     * @param apiUrl `可选` 自定义请求URL
+     */
+    getTreeList(request: QueryRequest<E>, apiUrl?: string): Promise<E[]>;
+    /**
+     * ### 根据 `ID` 获取详情对象
+     * @param id ID
+     * @param apiUrl `可选` 自定义请求URL
+     */
+    getDetail(id: number, apiUrl?: string): Promise<E>;
+    /**
+     * ### 添加一条新的数据
+     * @param data 保存的数据
+     * @param message `可选` 添加成功的消息提示内容
+     * @param apiUrl `可选` 自定义请求URL
+     */
+    add(data: E, message?: string, apiUrl?: string): Promise<number>;
+    /**
+     * ### 修改一条数据
+     * @param data 修改的数据实体
+     * @param message `可选` 修改成功的消息提示内容
+     * @param apiUrl `可选` 自定义请求URL
+     */
+    update(data: E, message?: string, apiUrl?: string): Promise<void>;
+    /**
+     * ### 保存一条数据并返回主键 `ID`
+     *
+     * 如包含 `ID` 则更新 如不包含 则创建
+     * @param data 保存的数据实体
+     * @param message `可选` 保存成功的消息提示内容
+     */
+    save(data: E, message?: string): Promise<number>;
+    /**
+     * ### 根据 `ID` 删除一条数据
+     * @param id 删除的数据 `ID`
+     * @param message `可选` 删除成功的消息提示内容
+     * @param apiUrl `可选` 自定义请求URL
+     */
+    delete(id: number, message?: string, apiUrl?: string): Promise<void>;
+    /**
+     * ### 根据 `ID` 禁用一条数据
+     * @param id 禁用的数据 `ID`
+     * @param message `可选` 禁用成功的消息提示内容
+     * @param apiUrl `可选` 自定义请求URL
+     */
+    disable(id: number, message?: string, apiUrl?: string): Promise<void>;
+    /**
+     * ### 根据 `ID` 启用一条数据
+     * @param id 启用的数据 `ID`
+     * @param message `可选` 启用成功的消息提示内容
+     * @param apiUrl `可选` 自定义请求URL
+     */
+    enable(id: number, message?: string, apiUrl?: string): Promise<void>;
+    /**
+     * ### 创建验证器
+     * @param form 表单对象
+     * @param moreRule `可选` 更多的验证规则
+     */
+    createValidator<E extends RootEntity>(form: E, moreRule?: WebValidateRule<E>): WebValidateRule<E>;
+    /**
+     * ### 创建一个实体的实例
+     * @param id `可选` `ID`
+     */
+    protected newEntityInstance(id?: number): E;
+}

package/dist/curd/index.d.ts

@@ -0,0 +1,2 @@
+export * from './AbstractCurdService';
+export * from './type';

package/dist/curd/type.d.ts

@@ -0,0 +1,8 @@
+import { RootEntity } from '../base';
+import { AbstractCurdService } from './AbstractCurdService';
+/**
+ * ### 服务构造器类型
+ */
+export type CurdServiceConstructor<E extends RootEntity, S extends AbstractCurdService<E>> = new () => S & {
+    entityClass: (new () => E);
+};

package/dist/decorator/@Field/Field.d.ts

@@ -0,0 +1,28 @@
+import { EnumKey } from '@airpower/enum/dist/enum/type';
+import { DecoratorTarget } from '@airpower/transformer';
+import { WebEnum, WebEnumConstructor } from '../../enum';
+import { IFieldConfig } from './IFieldConfig';
+/**
+ * ### 为属性标记配置
+ * @param config 配置项
+ */
+export declare function Field<K extends EnumKey = EnumKey, E extends WebEnum<K> = WebEnum<K>>(config?: IFieldConfig<K, E>): (target: DecoratorTarget, key: string) => void;
+/**
+ * ### 获取属性的配置
+ * @returns 配置对象
+ * @param target 目标类
+ * @param key 属性名
+ */
+export declare function getFieldConfig<K extends EnumKey = EnumKey, E extends WebEnum<K> = WebEnum<K>>(target: DecoratorTarget, key: string): IFieldConfig<K, E>;
+/**
+ * ### 获取属性的枚举字典
+ * @param target 目标类
+ * @param key 属性名
+ */
+export declare function getDictionary<K extends EnumKey = EnumKey, E extends WebEnum<K> = WebEnum<K>>(target: DecoratorTarget, key: string): WebEnumConstructor<K, E> | undefined;
+/**
+ * ### 获取属性的标题
+ * @param target 目标类
+ * @param key string 属性名
+ */
+export declare function getFieldLabel(target: DecoratorTarget, key: string): string;

package/dist/decorator/@Field/IFieldConfig.d.ts

@@ -0,0 +1,18 @@
+import { EnumKey } from '@airpower/enum/dist/enum/type';
+import { WebEnum, WebEnumConstructor } from '../../enum';
+import { IBaseField } from '../common';
+/**
+ * # 字段配置
+ *
+ * @author Hamm.cn
+ */
+export interface IFieldConfig<K extends EnumKey = EnumKey, E extends WebEnum<K> = WebEnum<K>> extends IBaseField {
+    /**
+     * ### 字段标题
+     */
+    label?: string;
+    /**
+     * ### 配置字典
+     */
+    dictionary?: WebEnumConstructor<K, E>;
+}

package/dist/decorator/@Field/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Field';
+export * from './IFieldConfig';

package/dist/decorator/@Form/Form.d.ts

@@ -0,0 +1,24 @@
+import { DecoratorTarget } from '@airpower/transformer';
+import { IFormField } from './IFormField';
+/**
+ * ### 标记该字段可用于表单配置
+ * @param config 配置项
+ */
+export declare function Form(config?: IFormField): (target: DecoratorTarget, key: string) => void;
+/**
+ * ### 获取对象某个字段标记的表单配置项
+ * @param target 目标类或对象
+ * @param key 属性名
+ */
+export declare function getFormConfig(target: DecoratorTarget, key: string): IFormField;
+/**
+ * ### 获取标记了表单配置的字段列表
+ * @param target 目标对象
+ */
+export declare function getFormFieldList(target: DecoratorTarget): string[];
+/**
+ * ### 获取指定类的表单字段配置项列表
+ * @param target 目标类或对象
+ * @param keyList 选择字段列表
+ */
+export declare function getFormConfigList(target: DecoratorTarget, keyList?: string[]): IFormField[];

package/dist/decorator/@Form/FormTrim.d.ts

@@ -0,0 +1,19 @@
+/**
+ * # 表单字段自动去除空格
+ *
+ * @author Hamm.cn
+ */
+export declare enum FormTrim {
+    /**
+     * ### 全部空格
+     */
+    ALL = 0,
+    /**
+     * ### 结尾空格
+     */
+    END = 1,
+    /**
+     * ### 开头空格
+     */
+    START = 2
+}

package/dist/decorator/@Form/IFormField.d.ts

@@ -0,0 +1,224 @@
+import { DateTimeFormatter } from '@airpower/util';
+import { DateTimeType } from '../../components/input/DateTimeType';
+import { IBaseField } from '../common';
+import { FormTrim } from './FormTrim';
+/**
+ * # 表单的字段配置接口
+ * @author Hamm.cn
+ */
+export interface IFormField extends IBaseField {
+    /**
+     * ### 输入提示
+     */
+    placeholder?: string;
+    /**
+     * ### 默认值
+     */
+    defaultValue?: string | number | boolean;
+    /**
+     * ### 去除空格
+     */
+    trim?: FormTrim;
+    /**
+     * ### 小数精度位数
+     */
+    precision?: number;
+    /**
+     * ### 前置图标名称
+     * 只支持 [Element Plus内置的图标](https://url.hamm.cn/5yc2d)
+     */
+    prefixIcon?: string;
+    /**
+     * ### 后置图标名称
+     * 只支持 [Element Plus内置的图标](https://url.hamm.cn/5yc2d)
+     */
+    suffixIcon?: string;
+    /**
+     * ### 最大数字
+     * 默认配置 `WebConfig.maxNumber` 仅在 `number` 时有效
+     */
+    max?: number;
+    /**
+     * ### 最小数字
+     */
+    min?: number;
+    /**
+     * ### 最大允许输入的长度
+     * 手动指定后, `WebConfig.maxTextAreaLength` 和 `WebConfig.maxTextLength` 将失效
+     */
+    maxLength?: number;
+    /**
+     * ### 最小长度
+     */
+    minLength?: number;
+    /**
+     * ### 排序 越大越靠上
+     */
+    order?: number;
+    /**
+     * ### 数字输入
+     */
+    number?: boolean;
+    /**
+     * ### 是否是密码
+     */
+    password?: boolean;
+    /**
+     * ### 是否是文本域
+     */
+    textarea?: boolean;
+    /**
+     * ### 是否显示字数限制
+     */
+    showLimit?: boolean;
+    /**
+     * ### 是否是纯中文
+     * 支持传入 `boolean` 和 `string`
+     * - 如传入 `有效字符串` 则认为需要校验, 内容即是校验失败的报错信息
+     * - 如传入 `true` 则认为需要校验且自动生成校验失败的报错信息
+     */
+    chinese?: boolean | string;
+    /**
+     * ### 是否是手机号
+     * 支持传入 `boolean` 和 `string`
+     * - 如传入 `有效字符串` 则认为需要校验, 内容即是校验失败的报错信息
+     * - 如传入 `true` 则认为需要校验且自动生成校验失败的报错信息
+     */
+    mobilePhone?: boolean | string;
+    /**
+     * ### 是否是座机电话
+     * 支持传入 `boolean` 和 `string`
+     * - 如传入 `有效字符串` 则认为需要校验, 内容即是校验失败的报错信息
+     * - 如传入 `true` 则认为需要校验且自动生成校验失败的报错信息
+     */
+    telPhone?: boolean | string;
+    /**
+     * ### 是否是电子邮箱
+     * 支持传入 `boolean` 和 `string`
+     * - 如传入 `有效字符串` 则认为需要校验, 内容即是校验失败的报错信息
+     * - 如传入 `true` 则认为需要校验且自动生成校验失败的报错信息
+     */
+    email?: boolean | string;
+    /**
+     * ### 是否是座机电话或手机
+     * 支持传入 `boolean` 和 `string`
+     * - 如传入 `有效字符串` 则认为需要校验, 内容即是校验失败的报错信息
+     * - 如传入 `true` 则认为需要校验且自动生成校验失败的报错信息
+     */
+    phone?: boolean | string;
+    /**
+     * ### 是否必填(字符串类型)
+     * 支持传入 `boolean` 和 `string`
+     * - 如传入 `有效字符串` 则认为需要校验, 内容即是校验失败的报错信息
+     * - 如传入 `true` 则认为需要校验且自动生成校验失败的报错信息
+     */
+    requiredString?: boolean | string;
+    /**
+     * ### 是否必填(数字类型)
+     * 支持传入 `boolean` 和 `string`
+     * - 如传入 `有效字符串` 则认为需要校验, 内容即是校验失败的报错信息
+     * - 如传入 `true` 则认为需要校验且自动生成校验失败的报错信息
+     */
+    requiredNumber?: boolean | string;
+    /**
+     * ### 是否必填(挂载对象)
+     * 支持传入 `boolean` 和 `string`
+     * - 如传入 `有效字符串` 则认为需要校验, 内容即是校验失败的报错信息
+     * - 如传入 `true` 则认为需要校验且自动生成校验失败的报错信息
+     */
+    requiredPayload?: boolean | string;
+    /**
+     * ### 正则表达式对象
+     */
+    regExp?: RegExp;
+    /**
+     * ### 是否隐藏表单字段
+     * 如配置`true` 则`getFormFieldConfigList`将无法拿到这个属性
+     */
+    hide?: boolean;
+    /**
+     * ### 日期类型
+     */
+    dateType?: DateTimeType;
+    /**
+     * ### 日期显示格式化
+     */
+    dateShowFormatter?: DateTimeFormatter;
+    /**
+     * ### 日期格式化
+     */
+    dateFormatter?: DateTimeFormatter;
+    /**
+     * ### 是否可清除
+     */
+    clearable?: boolean;
+    /**
+     * ### 后置文字
+     * 优先级低于 `AInput` 的 `append` 插槽
+     */
+    suffixText?: string;
+    /**
+     * ### 可多选
+     */
+    multiple?: boolean;
+    /**
+     * ### 收起多选标签
+     */
+    collapseTags?: boolean;
+    /**
+     * ### 可筛选
+     * 如同时为 `AInput` 传入了 `onSearch` 回调方法, 则进行自定义的筛选
+     */
+    filterable?: boolean;
+    /**
+     * ### 限制最多选择多少个
+     * 配置 0 不限制, 默认不限制
+     */
+    multipleLimit?: number;
+    /**
+     * ### 父子关联
+     */
+    checkStrictly?: boolean;
+    /**
+     * ### 是否显示枚举字典的颜色灯
+     * 如果显示 请确保传入的 `dictionary` 配置了 `color`
+     */
+    color?: boolean;
+    /**
+     * ### 返回全路径的值
+     */
+    emitPath?: boolean;
+    /**
+     * ### 显示全路径
+     */
+    showAllLevels?: boolean;
+    /**
+     * ### TextArea是否自适应
+     * `AInput`如配置了 `textarea:true` 此项生效, 默认为`true`
+     * 如配置为 `false`, 可手动配置 `minRow` `maxRow` 等参数
+     */
+    autoSize?: boolean;
+    /**
+     * ### 最小行数
+     * 如配置了 `autoSize`, 则此项配置无效
+     */
+    minRows?: number;
+    /**
+     * ### 最大行数
+     * 如配置了 `autoSize`, 则此项配置无效
+     */
+    maxRows?: number;
+    /**
+     * ### 使用 `Switch` 控件
+     */
+    switch?: boolean;
+    /**
+     * ### 使用 `Radio` 控件
+     */
+    radio?: boolean;
+    /**
+     * ### 使用 `Radio` 控件时用按钮的样式
+     * `@Form` 的 `radio` 配置为 `true` 时生效
+     */
+    radioButton?: boolean;
+}

package/dist/decorator/@Form/index.d.ts

@@ -0,0 +1,3 @@
+export * from './Form';
+export * from './FormTrim';
+export * from './IFormField';

package/dist/decorator/@Model/IModelConfig.d.ts

@@ -0,0 +1,69 @@
+/**
+ * # 模型配置
+ * @author Hamm.cn
+ */
+export interface IModelConfig {
+    /**
+     * ### 模型名称
+     */
+    label?: string;
+    /**
+     * ### 是否显示搜索框
+     * 优先级: 组件传入 > `Model` 配置
+     */
+    showSearch?: boolean;
+    /**
+     * ### 添加按钮的标题
+     * 优先级: 组件传入 > 自动生成
+     */
+    addTitle?: string;
+    /**
+     * ### 添加权限标识
+     */
+    addPermission?: string;
+    /**
+     * ### 导出权限标识
+     */
+    exportPermission?: string;
+    /**
+     * ### 导入权限标识
+     */
+    importPermission?: string;
+    /**
+     * ### 表格的没有数据时的提示文本
+     */
+    tableEmptyText?: string;
+    /**
+     * ### 编辑权限标识
+     */
+    editPermission?: string;
+    /**
+     * ### 详情权限标识
+     */
+    detailPermission?: string;
+    /**
+     * ### 删除权限标识
+     */
+    deletePermission?: string;
+    /**
+     * ### 添加子项目权限标识
+     */
+    addChildPermission?: string;
+    /**
+     * ### 禁用权限标识
+     */
+    disablePermission?: string;
+    /**
+     * ### 启用权限标识
+     */
+    enablePermission?: string;
+    /**
+     * ### 权限标识前缀
+     */
+    permissionPrefix?: string;
+    /**
+     * ### 全局隐藏字段列选择器
+     * 如设置 `true`, 则 `ATable` 传入的 `hideFieldSelector` 失效
+     */
+    hideFieldSelector?: boolean;
+}

package/dist/decorator/@Model/Model.d.ts

@@ -0,0 +1,12 @@
+import { DecoratorTarget } from '@airpower/transformer';
+import { IModelConfig } from './IModelConfig';
+/**
+ * ### 为模型类标记配置项
+ * @param config 配置项
+ */
+export declare function Model<T extends IModelConfig = IModelConfig>(config?: T): (target: DecoratorTarget) => void;
+/**
+ * ### 获取模型类配置项
+ * @param target 目标类
+ */
+export declare function getModelConfig<T extends IModelConfig = IModelConfig>(target: DecoratorTarget): T;

package/dist/decorator/@Model/index.d.ts

@@ -0,0 +1,2 @@
+export * from './IModelConfig';
+export * from './Model';

package/dist/decorator/@Search/ISearchField.d.ts

@@ -0,0 +1,29 @@
+import { IBaseField } from '../common';
+/**
+ * # 表单的字段配置接口
+ * @author Hamm.cn
+ */
+export interface ISearchField extends IBaseField {
+    /**
+     * ### 隐藏搜索
+     */
+    hide?: boolean;
+    /**
+     * ### 排序
+     * `越大越靠左边`
+     */
+    order?: number;
+    /**
+     * ### 可筛选
+     * 仅枚举字典下拉选择时有效
+     */
+    filterable?: boolean;
+    /**
+     * ### 可清除
+     */
+    clearable?: boolean;
+    /**
+     * ### 宽度
+     */
+    width?: number;
+}

package/dist/decorator/@Search/Search.d.ts

@@ -0,0 +1,24 @@
+import { DecoratorTarget } from '@airpower/transformer';
+import { ISearchField } from './ISearchField';
+/**
+ * ### 标记该字段可用于表单配置
+ * @param config 配置项
+ */
+export declare function Search(config?: ISearchField): (target: DecoratorTarget, key: string) => void;
+/**
+ * ### 获取对象某个字段标记的搜索配置项
+ * @param target 目标类或对象
+ * @param key 属性名
+ */
+export declare function getSearchConfig(target: DecoratorTarget, key: string): ISearchField;
+/**
+ * ### 获取标记了搜索配置的字段列表
+ * @param target 目标对象
+ */
+export declare function getSearchFieldList(target: DecoratorTarget): string[];
+/**
+ * ### 获取指定类的搜索字段配置项列表
+ * @param target 目标类或对象
+ * @param keyList 选择字段列表
+ */
+export declare function getSearchConfigList(target: DecoratorTarget, keyList?: string[]): ISearchField[];

package/dist/decorator/@Search/index.d.ts

@@ -0,0 +1,2 @@
+export * from './ISearchField';
+export * from './Search';

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

@@ -21,7 +21,7 @@ export interface IElementTableColumn {
     /**
      * ### 列宽度
      */
-    width?: string;
+    width?: string | number;
     /**
      * ### 最小宽度
      */