foggy-data-viewer 1.0.1-beta.52 → 1.0.1-beta.53
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.
- package/dist/components/DataTableWithSearch.vue.d.ts +12 -1
- package/dist/components/composables/useTableQuery.d.ts +8 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +3192 -3143
- package/dist/index.umd +1 -1
- package/dist/style.css +1 -1
- package/dist/types/index.d.ts +8 -3
- package/docs/custom-query-execution.md +22 -0
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { EnhancedColumnSchema, SliceRequestDef, FilterOption, TableSchema, FetchDataParams, FetchDataResult, OrderRequestDef, QueryHooks, MemberQueryRequest, MemberQueryResponse, CellCopyConfig, QueryMode, ListViewState, ListPresetConfig, TableDensity, SearchHooks, TableDefaultQueryConfig, TableDefaultQueryConfigScope, TableDefaultQueryConfigLoadOptions } from '@/types';
|
|
1
|
+
import type { EnhancedColumnSchema, SliceRequestDef, FilterOption, TableSchema, FetchDataParams, FetchDataResult, OrderRequestDef, QueryHooks, MemberQueryRequest, MemberQueryResponse, CellCopyConfig, QueryMode, ListViewState, ListPresetConfig, TableDensity, QueryExecutionOptions, SearchHooks, TableDefaultQueryConfig, TableDefaultQueryConfigScope, TableDefaultQueryConfigLoadOptions } from '@/types';
|
|
2
2
|
import type { QueryPanelExpose, QuerySchema } from './QueryPanel.vue';
|
|
3
3
|
/**
|
|
4
4
|
* DataTableWithSearch 组件
|
|
@@ -102,6 +102,12 @@ interface DataTableExpose {
|
|
|
102
102
|
clearSelection: (options?: ClearSelectionOptions) => void;
|
|
103
103
|
}
|
|
104
104
|
declare function clearSelectionState(options?: ClearSelectionOptions): void;
|
|
105
|
+
/**
|
|
106
|
+
* Execute the current table query on an isolated parameter snapshot.
|
|
107
|
+
* Search hooks and query hooks still run, but no table/query reactive state is
|
|
108
|
+
* written and the result is returned to the caller instead of being displayed.
|
|
109
|
+
*/
|
|
110
|
+
declare function executeQuery(overrides?: Partial<FetchDataParams>, options?: QueryExecutionOptions): Promise<FetchDataResult | undefined>;
|
|
105
111
|
declare function applyTableDefaultQueryConfig(config: TableDefaultQueryConfig, options?: {
|
|
106
112
|
reload?: boolean;
|
|
107
113
|
}): void;
|
|
@@ -191,6 +197,11 @@ declare const __VLS_component: import("vue").DefineComponent<Props, {
|
|
|
191
197
|
clearSelection: typeof clearSelectionState;
|
|
192
198
|
/** 获取 useTableQuery 实例(高级用法) */
|
|
193
199
|
getQuery: () => import("./composables/useTableQuery").UseTableQueryReturn;
|
|
200
|
+
/**
|
|
201
|
+
* 在不改变页面状态的前提下执行独立查询(适用于 Excel 导出等场景)。
|
|
202
|
+
* 会执行搜索钩子、查询钩子、固定业务条件和必需字段注入。
|
|
203
|
+
*/
|
|
204
|
+
executeQuery: typeof executeQuery;
|
|
194
205
|
/** 获取当前列表视图状态(用于保存自定义列表) */
|
|
195
206
|
getListViewState: typeof getListViewState;
|
|
196
207
|
/** 应用列表视图状态(用于加载自定义列表) */
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ref } from 'vue';
|
|
2
|
-
import type { FetchDataFn, SliceRequestDef, OrderRequestDef, QueryHooks, QueryTrigger, QueryHookName, BeforeQueryHookFn, AfterQueryHookFn, ErrorQueryHookFn } from '@/types';
|
|
2
|
+
import type { FetchDataParams, FetchDataResult, FetchDataFn, SliceRequestDef, OrderRequestDef, QueryHooks, QueryTrigger, QueryHookName, BeforeQueryHookFn, AfterQueryHookFn, ErrorQueryHookFn, QueryExecutionOptions } from '@/types';
|
|
3
3
|
/** 钩子名称到函数类型的映射 */
|
|
4
4
|
type HookFnMap = {
|
|
5
5
|
onBeforeQuery: BeforeQueryHookFn;
|
|
@@ -27,6 +27,8 @@ export interface UseTableQueryReturn {
|
|
|
27
27
|
currentColumns: ReturnType<typeof ref<string[]>>;
|
|
28
28
|
currentTableInstanceId: ReturnType<typeof ref<string | undefined>>;
|
|
29
29
|
loadData: (trigger?: QueryTrigger) => Promise<void>;
|
|
30
|
+
/** Execute an independent query without changing any table state. */
|
|
31
|
+
executeQuery: (params: FetchDataParams, options?: QueryExecutionOptions) => Promise<FetchDataResult | undefined>;
|
|
30
32
|
refresh: () => Promise<void>;
|
|
31
33
|
reload: () => Promise<void>;
|
|
32
34
|
setPage: (page: number, pageSize?: number) => void;
|
|
@@ -47,6 +49,11 @@ export interface UseTableQueryReturn {
|
|
|
47
49
|
* → fetchData
|
|
48
50
|
* instance onAfterQuery → props onAfterQuery → global onAfterQuery
|
|
49
51
|
*
|
|
52
|
+
* executeQuery uses the same query hook order with an isolated params copy.
|
|
53
|
+
* It never updates loading, activeTrigger, data, totals, errors, or outcome;
|
|
54
|
+
* cancellation and handled errors resolve to undefined, while unhandled
|
|
55
|
+
* errors reject.
|
|
56
|
+
*
|
|
50
57
|
* @param fetchData 数据加载函数
|
|
51
58
|
* @param options 配置项
|
|
52
59
|
*/
|
package/dist/index.d.ts
CHANGED
|
@@ -35,4 +35,4 @@ export { prepareCustomQuery, normalizeUserSlice, resolveRelativeDate, resolveRel
|
|
|
35
35
|
export type { RelativeDateRange, RelativeDateValue, CustomQueryExecutionOptions } from './utils/customQuery';
|
|
36
36
|
export { LIST_PRESET_SHARE_SCHEMA_VERSION, buildListPresetSharePackage, serializeListPresetSharePackage, parseListPresetSharePackage, assertListPresetShareCompatible, listPresetShareToViewState } from './utils/listPresetShare';
|
|
37
37
|
export type { ListPresetSharePreset, ListPresetSharePackage, ListPresetShareTargetContext } from './utils/listPresetShare';
|
|
38
|
-
export type { ColumnSchema, MoneyViewerConfig, ViewerConfig, FieldExtData, EnhancedColumnSchema, TableConfig, TableSchema, CellRenderContext, CellRenderFn, GlobalColumnRenderContext, GlobalColumnMatchFn, GlobalColumnRenderFn, GlobalColumnRenderer, GlobalColumnRenderResolution, CellCopyConfig, QueryMode, ColumnCustomization, QueryMetaResponse, ViewerQueryRequest, ViewerDataResponse, SliceRequestDef, OrderRequestDef, FilterOption, FetchDataParams, FetchDataResult, FetchDataFn, DictItem, PaginationState, SortState, QueryHooks, QueryHookContext, QueryTrigger, QueryHookName, BeforeQueryHookFn, AfterQueryHookFn, ErrorQueryHookFn, SearchSource, SearchTrigger, SearchHookContext, SearchHookUpdate, SearchHookName, BeforeSearchHookFn, AfterSearchHookFn, ErrorSearchHookFn, SearchHooks, MaybePromise, PivotAxisField, PivotAxisPage, PivotAxisPageScope, PivotAxisRole, PivotHeaderNode, PivotHeaderRole, PivotMetric, PivotRawAxisMember, PivotRawCell, PivotRawPayload, PivotShape, PivotViewMode, PivotViewModel, ListPresetVisibility, ListPresetPlacement, ListPresetShareContextOptions, ListPresetShareContext, ListPresetConfig, TableDefaultQueryConfig, TableDefaultQueryConfigScope, TableDefaultQueryConfigLoadOptions, TableDefaultQueryConfigSource, ColumnViewSetting, QueryConditionPreset, ListViewState, ListPresetDef, FrontendMeta, FieldMeta, FieldCategory, MemberLookupMeta, UiHintsMeta, DefaultsMeta, CapabilitiesMeta, ParamsMeta, MemberQueryRequest, MemberOption, MemberQueryResponse } from './types';
|
|
38
|
+
export type { ColumnSchema, MoneyViewerConfig, ViewerConfig, FieldExtData, EnhancedColumnSchema, TableConfig, TableSchema, CellRenderContext, CellRenderFn, GlobalColumnRenderContext, GlobalColumnMatchFn, GlobalColumnRenderFn, GlobalColumnRenderer, GlobalColumnRenderResolution, CellCopyConfig, QueryMode, ColumnCustomization, QueryMetaResponse, ViewerQueryRequest, ViewerDataResponse, SliceRequestDef, OrderRequestDef, FilterOption, FetchDataParams, FetchDataResult, QueryExecutionOptions, FetchDataFn, DictItem, PaginationState, SortState, QueryHooks, QueryHookContext, QueryTrigger, QueryHookName, BeforeQueryHookFn, AfterQueryHookFn, ErrorQueryHookFn, SearchSource, SearchTrigger, SearchHookContext, SearchHookUpdate, SearchHookName, BeforeSearchHookFn, AfterSearchHookFn, ErrorSearchHookFn, SearchHooks, MaybePromise, PivotAxisField, PivotAxisPage, PivotAxisPageScope, PivotAxisRole, PivotHeaderNode, PivotHeaderRole, PivotMetric, PivotRawAxisMember, PivotRawCell, PivotRawPayload, PivotShape, PivotViewMode, PivotViewModel, ListPresetVisibility, ListPresetPlacement, ListPresetShareContextOptions, ListPresetShareContext, ListPresetConfig, TableDefaultQueryConfig, TableDefaultQueryConfigScope, TableDefaultQueryConfigLoadOptions, TableDefaultQueryConfigSource, ColumnViewSetting, QueryConditionPreset, ListViewState, ListPresetDef, FrontendMeta, FieldMeta, FieldCategory, MemberLookupMeta, UiHintsMeta, DefaultsMeta, CapabilitiesMeta, ParamsMeta, MemberQueryRequest, MemberOption, MemberQueryResponse } from './types';
|