@kengic/vue 0.28.3-beta.0 → 0.28.3-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/README.md +7 -0
  2. package/dist/kengic-vue.js +1293 -1258
  3. package/dist/src/component/KgTable/KgTable.event.d.ts +17 -3
  4. package/dist/src/component/KgTable/KgTable.hooks.d.ts +18 -5
  5. package/dist/src/util/kg-auth.util.d.ts +1 -1
  6. package/dist/src/util/kg.util.d.ts +1 -0
  7. package/package.json +1 -1
package/dist/src/component/KgTable/KgTable.event.d.ts CHANGED
@@ -1,11 +1,12 @@
1
1
  import { IKgEventListener } from '@kengic/core.core';
2
+ import { AxiosResponse } from 'axios';
2
3
  import { Ref } from 'vue';
3
4
  import { IPage } from '../../api/WMS/models';
4
5
  import { IKgTableRow } from './KgTable.vm';
5
6
  /**
6
7
  * 事件类型.
7
8
  */
8
- export declare type IKgTableEvent = 'onReady' | 'onRowDoubleClick' | 'onBeforeParseRequestParameter' | 'onBeforeRequest' | 'onBeforeTransformDatas' | 'onBeforeSetDatas' | 'onAfterRequest';
9
+ export declare type IKgTableEvent = 'onReady' | 'onRowDoubleClick' | 'onBeforeParseRequestParameter' | 'onBeforeRequest' | 'onBeforeTransformDatas' | 'onBeforeSetDatas' | 'onAfterRequest' | 'onRequestError';
9
10
  export declare type IKgTableOnReadyEventListenerParameter = {};
10
11
  export declare type IKgTableOnReadyEventListener = ((param: IKgTableOnReadyEventListenerParameter) => Promise<boolean>) & IKgEventListener;
11
12
  export declare type IKgTableOnRowDoubleClickEventListenerParameter = {
@@ -58,8 +59,20 @@ export declare type IKgTableOnAfterRequestEventListenerParameter = {
58
59
  response: IPage<IKgTableRow> | null | undefined;
59
60
  };
60
61
  export declare type IKgTableOnAfterRequestEventListener = ((param: IKgTableOnAfterRequestEventListenerParameter) => Promise<boolean>) & IKgEventListener;
61
- export declare type IKgTableEventListenerParameter = IKgTableOnReadyEventListenerParameter | IKgTableOnRowDoubleClickEventListenerParameter | IKgTableOnBeforeParseRequestParameterEventListenerParameter | IKgTableOnBeforeRequestEventListenerParameter | IKgTableOnBeforeTransformDatasEventListenerParameter | IKgTableOnBeforeSetDatasEventListenerParameter | IKgTableOnAfterRequestEventListenerParameter;
62
- export declare type IKgTableEventListener = IKgTableOnReadyEventListener | IKgTableOnRowDoubleClickEventListener | IKgTableOnBeforeParseRequestParameterEventListener | IKgTableOnBeforeRequestEventListener | IKgTableOnBeforeTransformDatasEventListener | IKgTableOnBeforeSetDatasEventListener | IKgTableOnAfterRequestEventListener;
62
+ export declare type IKgTableOnRequestErrorEventListenerParameter = {
63
+ /**
64
+ * <p>请求返回对象.</p>
65
+ * <p>可以手动修改该对象中的数据.</p>
66
+ */
67
+ axiosResponse: AxiosResponse<any>;
68
+ /**
69
+ * 错误对象.
70
+ */
71
+ e: Error;
72
+ };
73
+ export declare type IKgTableOnRequestErrorEventListener = ((param: IKgTableOnRequestErrorEventListenerParameter) => Promise<boolean>) & IKgEventListener;
74
+ export declare type IKgTableEventListenerParameter = IKgTableOnReadyEventListenerParameter | IKgTableOnRowDoubleClickEventListenerParameter | IKgTableOnBeforeParseRequestParameterEventListenerParameter | IKgTableOnBeforeRequestEventListenerParameter | IKgTableOnBeforeTransformDatasEventListenerParameter | IKgTableOnBeforeSetDatasEventListenerParameter | IKgTableOnRequestErrorEventListenerParameter | IKgTableOnAfterRequestEventListenerParameter;
75
+ export declare type IKgTableEventListener = IKgTableOnReadyEventListener | IKgTableOnRowDoubleClickEventListener | IKgTableOnBeforeParseRequestParameterEventListener | IKgTableOnBeforeRequestEventListener | IKgTableOnBeforeTransformDatasEventListener | IKgTableOnBeforeSetDatasEventListener | IKgTableOnRequestErrorEventListener | IKgTableOnAfterRequestEventListener;
63
76
  export declare const eventListeners: Record<string, {
64
77
  onAfterRequest: Array<IKgTableOnAfterRequestEventListener>;
65
78
  onBeforeParseRequestParameter: Array<IKgTableOnBeforeParseRequestParameterEventListener>;
@@ -67,6 +80,7 @@ export declare const eventListeners: Record<string, {
67
80
  onBeforeSetDatas: Array<IKgTableOnBeforeSetDatasEventListener>;
68
81
  onBeforeTransformDatas: Array<IKgTableOnBeforeTransformDatasEventListener>;
69
82
  onReady: Array<IKgTableOnReadyEventListener>;
83
+ onRequestError: Array<IKgTableOnRequestErrorEventListener>;
70
84
  onRowDoubleClick: Array<IKgTableOnRowDoubleClickEventListener>;
71
85
  }>;
72
86
  /**
package/dist/src/component/KgTable/KgTable.hooks.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { IRemoveEventListener } from '@kengic/core.core';
2
2
  import { ComputedRef } from 'vue';
3
- import { eventListeners, IKgTableOnAfterRequestEventListener, IKgTableOnBeforeParseRequestParameterEventListener, IKgTableOnBeforeRequestEventListener, IKgTableOnBeforeSetDatasEventListener, IKgTableOnBeforeTransformDatasEventListener, IKgTableOnReadyEventListener, IKgTableOnRowDoubleClickEventListener } from './KgTable.event';
3
+ import { eventListeners, IKgTableOnAfterRequestEventListener, IKgTableOnBeforeParseRequestParameterEventListener, IKgTableOnBeforeRequestEventListener, IKgTableOnBeforeSetDatasEventListener, IKgTableOnBeforeTransformDatasEventListener, IKgTableOnReadyEventListener, IKgTableOnRequestErrorEventListener, IKgTableOnRowDoubleClickEventListener } from './KgTable.event';
4
4
  import { IKgTableStore } from './KgTable.store';
5
5
  import { IKgTableRow } from './KgTable.vm';
6
6
  export interface IUseKgTable {
@@ -48,15 +48,16 @@ export interface IUseKgTable {
48
48
  kgSearchFormID: ComputedRef<string>;
49
49
  /**
50
50
  * 监听事件: 查询请求成功, 表格数据已经赋值, 表格状态已经更新.
51
+ *
51
52
  * @param listener 事件监听函数.
52
53
  * @param isOnce 是否只会触发一次. 默认为 undefined.
53
54
  */
54
55
  onAfterRequest(listener: IKgTableOnAfterRequestEventListener, isOnce?: boolean): IRemoveEventListener;
55
- /** @deprecated 已废弃, 请使用 onAfterRequest() 方法. */
56
+ /** @deprecated 已废弃, 请使用 {@link IUseKgTable.onAfterRequest()}. */
56
57
  onAfterSearch(listener: IKgTableOnAfterRequestEventListener, isOnce?: boolean): IRemoveEventListener;
57
58
  /**
58
59
  * <p>监听事件: 即将解析请求参数.</p>
59
- * <p>在该事件中, 可以修改解析前的参数.</p>
60
+ * <p>可以修改解析前的参数.</p>
60
61
  *
61
62
  * @param listener 事件监听函数.
62
63
  * @param isOnce 是否只会触发一次. 默认为 undefined.
@@ -74,26 +75,38 @@ export interface IUseKgTable {
74
75
  onBeforeSearch(listener: IKgTableOnBeforeRequestEventListener, isOnce?: boolean): IRemoveEventListener;
75
76
  /**
76
77
  * 监听事件: 查询请求成功, 表格数据尚未赋值. 此处可以对查询接口返回的列表数据作处理.
78
+ *
77
79
  * @param listener 事件监听函数.
78
80
  * @param isOnce 是否只会触发一次. 默认为 undefined.
79
81
  */
80
82
  onBeforeSetDatas(listener: IKgTableOnBeforeSetDatasEventListener, isOnce?: boolean): IRemoveEventListener;
81
83
  /**
82
84
  * 监听事件: 查询请求成功, 表格数据尚未赋值. 准备对请求返回的数据进行处理.
85
+ *
83
86
  * @param listener 事件监听函数.
84
87
  * @param isOnce 是否只会触发一次. 默认为 undefined.
85
88
  */
86
89
  onBeforeTransformDatas(listener: IKgTableOnBeforeTransformDatasEventListener, isOnce?: boolean): IRemoveEventListener;
87
90
  /**
88
- * 监听事件: ready, 配置初始完成, 组件渲染完成.
91
+ * 监听事件: 配置初始完成, 组件渲染完成.
92
+ *
89
93
  * @param listener 事件监听函数.
90
94
  * @param isOnce 是否只会触发一次. 默认为 undefined.
91
95
  */
92
96
  onReady(listener: IKgTableOnReadyEventListener, isOnce?: boolean): IRemoveEventListener;
93
- /** @deprecated 已废弃, 请使用 onAfterRequest() 方法. */
97
+ /**
98
+ * <p>监听事件: 查询请求报错.</p>
99
+ * <p>可以修改参数 {@link IKgTableOnRequestErrorEventListenerParameter.axiosResponse} 中的数据, 实现在请求报错时手动提供返回数据.</p>
100
+ *
101
+ * @param listener 事件监听函数.
102
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
103
+ */
104
+ onRequestError(listener: IKgTableOnRequestErrorEventListener, isOnce?: boolean): IRemoveEventListener;
105
+ /** @deprecated 已废弃, 请使用 {@link IUseKgTable.onAfterRequest} 方法. */
94
106
  onRetrieve(listener: IKgTableOnAfterRequestEventListener, isOnce?: boolean): IRemoveEventListener;
95
107
  /**
96
108
  * 监听事件: 双击某行.
109
+ *
97
110
  * @param listener 事件监听函数.
98
111
  * @param isOnce 是否只会触发一次. 默认为 undefined.
99
112
  */
package/dist/src/util/kg-auth.util.d.ts CHANGED
@@ -4,7 +4,7 @@ export declare class KgAuthUtil {
4
4
  static isAdminUser(): boolean;
5
5
  /** @deprecated 已弃用, 请使用 KgUtil 中的同名方法. */
6
6
  static isAppAuthenticated(app: KG_APP | null | undefined): boolean;
7
- /** @deprecated 已弃用, 请使用 KgUtil 中的同名方法. */
7
+ /** @deprecated 已弃用, 请使用 {@link KgUtil.isPathAuthenticated()}. */
8
8
  static isPathAuthenticated(path: string | null | undefined): boolean;
9
9
  /** @deprecated 已弃用, 请使用 KgUtil 中的同名方法. */
10
10
  static getPermissionType(permissionCode: string | null | undefined): number | null;
package/dist/src/util/kg.util.d.ts CHANGED
@@ -133,6 +133,7 @@ export declare class KgUtil {
133
133
  static isAppAuthenticated(app: KG_APP | null | undefined): boolean;
134
134
  /**
135
135
  * 判断某个地址是否具有访问权限.
136
+ *
136
137
  * @param path 地址.
137
138
  * @return {} 如果地址具有访问权限则返回 true, 否则返回 false.
138
139
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kengic/vue",
3
- "version": "0.28.3-beta.0",
3
+ "version": "0.28.3-beta.2",
4
4
  "scripts": {
5
5
  "build": "npm run use-node && rimraf dist && vue-tsc && vite build",
6
6
  "build:dev": "npm run use-node && rimraf dist && vue-tsc && vite build --mode development",