@airpower/web 0.0.24 → 0.0.25

package/dist/airpower.web.js

@@ -17454,6 +17454,11 @@ class WebConfig {
     localStorage.removeItem(CoreConfig.authorizationHeaderKey);
   }
 }
+class WebI18n extends AirI18n {
+  static get() {
+    return AirI18n.get();
+  }
+}
 function bind(fn, thisArg) {
   return function wrap() {
     return fn.apply(thisArg, arguments);
@@ -21589,6 +21594,7 @@ export {
   ToModel,
   WebConfig,
   WebHttp,
+  WebI18n,
   _sfc_main$3 as WebTable,
   getFieldConfig,
   getModelConfig,

package/dist/config/WebI18n.d.ts

@@ -0,0 +1,13 @@
+import { AirI18n } from '@airpower/core';
+export declare abstract class WebI18n extends AirI18n {
+    abstract Detail: string;
+    abstract Edit: string;
+    abstract Add: string;
+    abstract EditSuccess: string;
+    abstract AddSuccess: string;
+    abstract DeleteSuccess: string;
+    abstract SelectPlease: string;
+    abstract DisableSuccess: string;
+    abstract EnableSuccess: string;
+    static get(): WebI18n;
+}

package/dist/config/index.d.ts

@@ -1 +1,2 @@
 export * from './WebConfig';
+export * from './WebI18n';

package/dist/hooks/index.d.ts

@@ -0,0 +1,7 @@
+export * from './interface';
+export * from './useBaseTable';
+export * from './useDetail';
+export * from './useEditor';
+export * from './useSelector';
+export * from './useTable';
+export * from './useTableTree';

package/dist/hooks/interface/ITableHookOption.d.ts

@@ -0,0 +1,42 @@
+import { AirEntity, QueryPageRequest } from '@airpower/core';
+import { Component } from 'vue';
+/**
+ * # 表格相关的根级配置项
+ * @author Hamm.cn
+ */
+export interface ITableHookOption<E extends AirEntity> {
+    /**
+     * ### 不分页
+     * 默认请求分页接口 如配置了 `treeList` 则此项自动失效
+     */
+    unPaginate?: boolean;
+    /**
+     * ### 请求专用的 `treeList` 接口
+     */
+    treeList?: boolean;
+    /**
+     * ### 默认的筛选器
+     */
+    defaultFilter?: E;
+    /**
+     * ### 详情的视图 `Vue` 文件
+     */
+    detailView?: Component;
+    /**
+     * ### 新增和编辑视图的 `Vue` 文件
+     */
+    editView?: Component;
+    /**
+     * ### 请求的URL
+     *
+     * 如不传入，则默认为 `Service` 的 `urlForGetXXX`
+     */
+    apiUrl?: string;
+    /**
+     * ### 搜索前的拦截方法
+     * 参数为发起请求的数据,请处理后返回
+     *
+     * @param requestData 请求对象
+     */
+    beforeSearch?: (requestData: QueryPageRequest<E>) => QueryPageRequest<E> | void;
+}

package/dist/hooks/interface/ITableHookResult.d.ts

@@ -0,0 +1,80 @@
+import { AirEntity, Page, QueryPageRequest, QueryPageResponse, QuerySort } from '@airpower/core';
+import { Ref } from 'vue';
+import { AbstractWebService } from '../../service';
+/**
+ * # `TableHook` 的基础返回结构
+ * @author Hamm.cn
+ */
+export interface ITableHookResult<E extends AirEntity, S extends AbstractWebService<E>> {
+    /**
+     * ### 当前绑定的 `Loading` 状态
+     * 请随意 `v-loading` 到你需要的地方
+     */
+    isLoading: Ref<boolean>;
+    /**
+     * ### 响应数据
+     */
+    response: Ref<QueryPageResponse<E>>;
+    /**
+     * ### 请求数据
+     */
+    request: Ref<QueryPageRequest<E>>;
+    /**
+     * ### 返回的单页数据列表
+     */
+    list: Ref<E[]>;
+    /**
+     * ### 选中的数据列表
+     */
+    selectList: Ref<E[]>;
+    /**
+     * ### 实体的实例
+     */
+    entity: E;
+    /**
+     * ### `Service`的实例
+     */
+    service: S;
+    /**
+     * ### 刷新数据 返回第一页
+     */
+    onReloadData: () => void;
+    /**
+     * ### 搜索事件
+     *
+     * @param request 请求对象
+     */
+    onSearch: (request: QueryPageRequest<E>) => void;
+    /**
+     * ### 分页变更事件
+     *
+     * @param page 分页对象
+     */
+    onPageChanged: (page: Page) => 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/interface/IUseDetailOption.d.ts

@@ -0,0 +1,20 @@
+import { AirEntity } from '@airpower/core';
+/**
+ * # `Detail` 的 `Hook` 可选配置
+ * @author Hamm.cn
+ */
+export interface IUseDetailOption<E extends AirEntity> {
+    /**
+     * ### 查到详情后的事件
+     * 参数为响应的数据,请处理后返回
+     *
+     * @param detailData 实体
+     */
+    afterGetDetail?: (detailData: E) => E | void;
+    /**
+     * ### 请求查询详情的URL
+     *
+     * 如不传入，则默认为 `Service` 的 `urlForGetDetail`
+     */
+    apiUrl?: string;
+}

package/dist/hooks/interface/IUseDetailResult.d.ts

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

package/dist/hooks/interface/IUseEditorOption.d.ts

@@ -0,0 +1,31 @@
+import { AirEntity } from '@airpower/core';
+import { IUseDetailOption } from './IUseDetailOption';
+/**
+ * # `Editor` 的 `Hook` 可选配置
+ * @author Hamm.cn
+ */
+export interface IUseEditorOption<E extends AirEntity> extends IUseDetailOption<E> {
+    /**
+     * ### 编辑成功的提示消息
+     */
+    successMessage?: string;
+    /**
+     * ### 请求前拦截器
+     * 参数为发起请求的数据,请处理后返回
+     *
+     * @param submitData 实体
+     */
+    beforeSubmit?: (submitData: E) => E | null;
+    /**
+     * ### 请求添加的URL
+     *
+     * 如不传入，则默认为 `Service` 的 `urlForAdd`
+     */
+    apiUrlAdd?: string;
+    /**
+     * ### 请求更新的URL
+     *
+     * 如不传入，则默认为 `Service` 的 `urlForUpdate`
+     */
+    apiUrlUpdate?: string;
+}

package/dist/hooks/interface/IUseEditorResult.d.ts

@@ -0,0 +1,14 @@
+import { AirEntity } from '@airpower/core';
+import { AbstractWebService } from '../../service';
+import { IUseDetailResult } from './IUseDetailResult';
+/**
+ * # `Editor` 的 `Hook` 标准返回
+ * @author Hamm.cn
+ */
+export interface IUseEditorResult<E extends AirEntity, S extends AbstractWebService<E>> extends IUseDetailResult<E, S> {
+    /**
+     * ### 表单提交的方法
+     * 你可以使用 `beforeSubmit` 方法来拦截请求的数据
+     */
+    onSubmit: () => void;
+}

package/dist/hooks/interface/IUseSelectorOption.d.ts

@@ -0,0 +1,8 @@
+import { AirEntity } from '@airpower/core';
+import { ITableHookOption } from './ITableHookOption';
+/**
+ * # `Selector` 的 `Hook` 可选配置
+ * @author Hamm.cn
+ */
+export interface IUseSelectorOption<E extends AirEntity> extends ITableHookOption<E> {
+}

package/dist/hooks/interface/IUseSelectorResult.d.ts

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

package/dist/hooks/interface/IUseTableOption.d.ts

@@ -0,0 +1,8 @@
+import { AirEntity } from '@airpower/core';
+import { ITableHookOption } from './ITableHookOption';
+/**
+ * # `TableList` 的 `Hook` 可选配置
+ * @author Hamm.cn
+ */
+export interface IUseTableOption<E extends AirEntity> extends ITableHookOption<E> {
+}

package/dist/hooks/interface/IUseTableResult.d.ts

@@ -0,0 +1,33 @@
+import { AirEntity } from '@airpower/core';
+import { AbstractWebService } from '../../service';
+import { ITableHookResult } from './ITableHookResult';
+/**
+ * # 表格的 `Hook` 标准返回
+ * @author Hamm.cn
+ */
+export interface IUseTableResult<E extends AirEntity, S extends AbstractWebService<E>> extends ITableHookResult<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/interface/IUseTableTreeOption.d.ts

@@ -0,0 +1,16 @@
+import { ITree } from '@airpower/core';
+import { IUseTableOption } from './IUseTableOption';
+/**
+ * # `TableTreeList` 的 `Hook` 可选配置
+ * @author Hamm.cn
+ */
+export interface IUseTableTreeOption<T extends ITree> extends IUseTableOption<T> {
+    /**
+     * ### 添加行的子项的前置拦截方法
+     * 参数为发起请求的数据,请处理后返回 `param`
+     *
+     * @param param 添加的数据
+     * @param row 当前行数据
+     */
+    beforeAddRow?: (param: T, row: T) => T | void;
+}

package/dist/hooks/interface/IUseTableTreeResult.d.ts

@@ -0,0 +1,13 @@
+import { AirEntity } from '@airpower/core';
+import { AbstractWebService } from '../../service';
+import { IUseTableResult } from './IUseTableResult';
+/**
+ * # 树表格的 `Hook` 标准返回
+ * @author Hamm.cn
+ */
+export interface IUseTableTreeResult<E extends AirEntity, S extends AbstractWebService<E>> extends IUseTableResult<E, S> {
+    /**
+     * ### 表格行的添加按钮点击事件
+     */
+    onAddRow: (row: E) => void;
+}

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

@@ -0,0 +1,12 @@
+export * from './ITableHookOption';
+export * from './ITableHookResult';
+export * from './IUseDetailOption';
+export * from './IUseDetailResult';
+export * from './IUseEditorOption';
+export * from './IUseEditorResult';
+export * from './IUseSelectorOption';
+export * from './IUseSelectorResult';
+export * from './IUseTableOption';
+export * from './IUseTableResult';
+export * from './IUseTableTreeOption';
+export * from './IUseTableTreeResult';

package/dist/hooks/useBaseTable.d.ts

@@ -0,0 +1,11 @@
+import { AirEntity, ClassConstructor } from '@airpower/core';
+import { AbstractWebService } from '../service';
+import { ITableHookOption, ITableHookResult } from './interface';
+/**
+ * # 表格基础`Hook`
+ * @param entityClass 实体类
+ * @param serviceClass 表格使用的 `Service` 类
+ * @param option `可选` 更多配置
+ * @author Hamm.cn
+ */
+export declare function useBaseTable<E extends AirEntity, S extends AbstractWebService<E>>(entityClass: ClassConstructor<E>, serviceClass: ClassConstructor<S>, option?: ITableHookOption<E>): ITableHookResult<E, S>;

package/dist/hooks/useDetail.d.ts

@@ -0,0 +1,12 @@
+import { AirEntity, ClassConstructor, IJson } from '@airpower/core';
+import { AbstractWebService } from '../service';
+import { IUseDetailOption, IUseDetailResult } from './interface';
+/**
+ * # 引入详情的`Hook`
+ * @param props `defineProps` 的返回值
+ * @param entityClass 详情使用的实体类
+ * @param serviceClass 详情使用的 `Service`
+ * @param option `可选` 更多的配置
+ * @author Hamm.cn
+ */
+export declare function useDetail<E extends AirEntity, S extends AbstractWebService<E>>(props: IJson, entityClass: ClassConstructor<E>, serviceClass: ClassConstructor<S>, option?: IUseDetailOption<E>): IUseDetailResult<E, S>;

package/dist/hooks/useEditor.d.ts

@@ -0,0 +1,12 @@
+import { AirEntity, ClassConstructor, IJson } from '@airpower/core';
+import { AbstractWebService } from '../service';
+import { IUseEditorOption, IUseEditorResult } from './interface';
+/**
+ * # 引入`Editor`的`Hook`
+ * @param props `defineProps`的返回值
+ * @param entityClass `Editor`使用的实体类
+ * @param serviceClass `Editor`使用的`Service`
+ * @param option `可选` 更多的配置
+ * @author Hamm.cn
+ */
+export declare function useEditor<E extends AirEntity, S extends AbstractWebService<E>>(props: IJson, entityClass: ClassConstructor<E>, serviceClass: ClassConstructor<S>, option?: IUseEditorOption<E>): IUseEditorResult<E, S>;

package/dist/hooks/useSelector.d.ts

@@ -0,0 +1,12 @@
+import { AirEntity, ClassConstructor, IJson } from '@airpower/core';
+import { AbstractWebService } from '../service';
+import { IUseSelectorOption, IUseSelectorResult } from './interface';
+/**
+ * # 引入`Selector`使用的`Hook`
+ * @param props `defineProps`的返回值
+ * @param entityClass 实体类
+ * @param serviceClass `Selector`使用的`Service`类
+ * @param option `可选` 更多配置
+ * @author Hamm.cn
+ */
+export declare function useSelector<E extends AirEntity, S extends AbstractWebService<E>>(props: IJson, entityClass: ClassConstructor<E>, serviceClass: ClassConstructor<S>, option?: IUseSelectorOption<E>): IUseSelectorResult<E, S>;

package/dist/hooks/useTable.d.ts

@@ -0,0 +1,11 @@
+import { AirEntity, ClassConstructor } from '@airpower/core';
+import { AbstractWebService } from '../service';
+import { IUseTableOption, IUseTableResult } from './interface';
+/**
+ * # 引入表格使用的`Hook`
+ * @param entityClass 实体类
+ * @param serviceClass 表格使用的`Service`类
+ * @param option `可选` 更多配置
+ * @author Hamm.cn
+ */
+export declare function useTable<E extends AirEntity, S extends AbstractWebService<E>>(entityClass: ClassConstructor<E>, serviceClass: ClassConstructor<S>, option?: IUseTableOption<E>): IUseTableResult<E, S>;

package/dist/hooks/useTableTree.d.ts

@@ -0,0 +1,11 @@
+import { ClassConstructor, ITree } from '@airpower/core';
+import { AbstractWebService } from '../service';
+import { IUseTableTreeOption, IUseTableTreeResult } from './interface';
+/**
+ * # 引入表格树使用的`Hook`
+ * @param entityClass 实体类
+ * @param serviceClass 表格使用的`Service`类
+ * @param option `可选` 更多配置
+ * @author Hamm.cn
+ */
+export declare function useTableTree<E extends ITree, S extends AbstractWebService<E>>(entityClass: ClassConstructor<E>, serviceClass: ClassConstructor<S>, option?: IUseTableTreeOption<E>): IUseTableTreeResult<E, S>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@airpower/web",
   "type": "module",
-  "version": "0.0.24",
+  "version": "0.0.25",
   "description": "AirPower-Web",
   "author": {
     "name": "Hamm",