@quillsql/react 2.16.81 → 2.16.82
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/index.cjs +4742 -3124
- package/dist/index.d.cts +61 -27
- package/dist/index.d.ts +61 -27
- package/dist/index.js +3915 -2285
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -628,6 +628,31 @@ type PivotData = {
|
|
|
628
628
|
comparisonPivotQuery?: string;
|
|
629
629
|
};
|
|
630
630
|
|
|
631
|
+
type QueryBuilderCombinator = 'and' | 'or';
|
|
632
|
+
type QueryBuilderRule = {
|
|
633
|
+
field: string;
|
|
634
|
+
table?: string;
|
|
635
|
+
operator: string;
|
|
636
|
+
value: unknown;
|
|
637
|
+
};
|
|
638
|
+
type QueryBuilderRuleGroupEntry = QueryBuilderRule | QueryBuilderRuleGroup | QueryBuilderCombinator;
|
|
639
|
+
type QueryBuilderRuleGroup = {
|
|
640
|
+
combinator?: QueryBuilderCombinator;
|
|
641
|
+
rules: QueryBuilderRuleGroupEntry[];
|
|
642
|
+
};
|
|
643
|
+
type QueryBuilderFieldType = 'string' | 'number' | 'date' | 'boolean' | 'null';
|
|
644
|
+
type QueryBuilderOperatorOption = {
|
|
645
|
+
name: string;
|
|
646
|
+
value: string;
|
|
647
|
+
label: string;
|
|
648
|
+
arity?: 'unary' | 'binary' | number;
|
|
649
|
+
};
|
|
650
|
+
/**
|
|
651
|
+
* Expand UI `inBucket` leaf rules to `between` for react-querybuilder editors.
|
|
652
|
+
* Custom UIs keep `inBucket` on `useReport().filters`; the draft boundary uses this.
|
|
653
|
+
*/
|
|
654
|
+
declare const queryBuilderFiltersForEditor: (group: QueryBuilderRuleGroup) => QueryBuilderRuleGroup;
|
|
655
|
+
|
|
631
656
|
type SortDirection = 'asc' | 'desc' | 'ASC' | 'DESC';
|
|
632
657
|
type ReportBuilderTable = {
|
|
633
658
|
name: string;
|
|
@@ -665,7 +690,10 @@ type ReportBuilderLimit = {
|
|
|
665
690
|
type ReportBuilderState = {
|
|
666
691
|
tables: ReportBuilderTable[];
|
|
667
692
|
columns: ReportBuilderColumn[];
|
|
668
|
-
|
|
693
|
+
/** Canonical report filter representation. */
|
|
694
|
+
rules: QueryBuilderRuleGroup;
|
|
695
|
+
/** @deprecated Use rules. Retained while legacy report-builder hooks migrate. */
|
|
696
|
+
filterStack?: FilterTreeNode[];
|
|
669
697
|
pivot: Pivot | null;
|
|
670
698
|
sort: ReportBuilderSort[];
|
|
671
699
|
limit: ReportBuilderLimit | null;
|
|
@@ -694,6 +722,12 @@ interface UniqueValuesByColumn {
|
|
|
694
722
|
[column: string]: string[];
|
|
695
723
|
}
|
|
696
724
|
|
|
725
|
+
/** Display-only ordering applied after query and pivot processing. */
|
|
726
|
+
type ChartSort = {
|
|
727
|
+
target: 'rows' | 'series';
|
|
728
|
+
field: string;
|
|
729
|
+
direction: 'ASC' | 'DESC';
|
|
730
|
+
};
|
|
697
731
|
/**
|
|
698
732
|
* ## QuillReport
|
|
699
733
|
* Represents an individual item on a dashboard.
|
|
@@ -722,6 +756,8 @@ interface QuillReport {
|
|
|
722
756
|
chartType: string;
|
|
723
757
|
/** Whether to show a legend for this chart. */
|
|
724
758
|
showLegend?: boolean;
|
|
759
|
+
/** Display-only ordering applied after query and pivot processing. */
|
|
760
|
+
chartSort?: ChartSort;
|
|
725
761
|
/** The table and field this report uses for date filtering, if any. */
|
|
726
762
|
dateField?: {
|
|
727
763
|
table: string;
|
|
@@ -1911,6 +1947,8 @@ interface QuillFetchOptions {
|
|
|
1911
1947
|
credentials?: RequestCredentials;
|
|
1912
1948
|
urlParameters?: string;
|
|
1913
1949
|
adminMode?: boolean;
|
|
1950
|
+
/** Internal opt-in for exact initial-request sharing across mounted hooks. */
|
|
1951
|
+
shareRequest?: boolean;
|
|
1914
1952
|
getToken: () => Promise<string>;
|
|
1915
1953
|
}
|
|
1916
1954
|
interface QuillResults {
|
|
@@ -2952,29 +2990,10 @@ interface ChatProps {
|
|
|
2952
2990
|
type ChatModelId = 'gemini-2-flash' | 'gemini-2.5-flash' | 'gemini-3-flash-preview' | 'gpt-5.1' | 'opus-4.5' | 'kimi-k2.5';
|
|
2953
2991
|
declare function Chat({ selectedDashboard, ChartViewComponent, agentEndpoint, suggestions, }: ChatProps): react_jsx_runtime.JSX.Element;
|
|
2954
2992
|
|
|
2955
|
-
type
|
|
2956
|
-
type QueryBuilderRule = {
|
|
2957
|
-
field: string;
|
|
2958
|
-
operator: string;
|
|
2959
|
-
value: unknown;
|
|
2960
|
-
};
|
|
2961
|
-
type QueryBuilderRuleGroupEntry = QueryBuilderRule | QueryBuilderRuleGroup | QueryBuilderCombinator;
|
|
2962
|
-
type QueryBuilderRuleGroup = {
|
|
2963
|
-
combinator?: QueryBuilderCombinator;
|
|
2964
|
-
rules: QueryBuilderRuleGroupEntry[];
|
|
2965
|
-
};
|
|
2966
|
-
type QueryBuilderFieldType = 'string' | 'number' | 'date' | 'boolean' | 'null';
|
|
2967
|
-
type QueryBuilderOperatorOption = {
|
|
2968
|
-
name: string;
|
|
2969
|
-
value: string;
|
|
2993
|
+
type ChartSortOption = {
|
|
2970
2994
|
label: string;
|
|
2971
|
-
|
|
2995
|
+
value: string;
|
|
2972
2996
|
};
|
|
2973
|
-
/**
|
|
2974
|
-
* Expand UI `inBucket` leaf rules to `between` for react-querybuilder editors.
|
|
2975
|
-
* Custom UIs keep `inBucket` on `useReport().filters`; the draft boundary uses this.
|
|
2976
|
-
*/
|
|
2977
|
-
declare const queryBuilderFiltersForEditor: (group: QueryBuilderRuleGroup) => QueryBuilderRuleGroup;
|
|
2978
2997
|
|
|
2979
2998
|
/**
|
|
2980
2999
|
* Pagination types and pure helpers for `useReport`, mirroring the
|
|
@@ -2990,8 +3009,8 @@ interface PaginationState {
|
|
|
2990
3009
|
type Updater<T> = T | ((old: T) => T);
|
|
2991
3010
|
type OnChangeFn<T> = (updaterOrValue: Updater<T>) => void;
|
|
2992
3011
|
declare const DEFAULT_PAGE_SIZE = 10;
|
|
2993
|
-
/**
|
|
2994
|
-
declare const DEFAULT_USE_REPORT_ROWS_PER_REQUEST
|
|
3012
|
+
/** Default row window for every useReport chart/table request. */
|
|
3013
|
+
declare const DEFAULT_USE_REPORT_ROWS_PER_REQUEST = 10;
|
|
2995
3014
|
|
|
2996
3015
|
type SelectOption = {
|
|
2997
3016
|
label: string;
|
|
@@ -3243,6 +3262,11 @@ interface SetReportBuilderInput {
|
|
|
3243
3262
|
chartType?: ChartType;
|
|
3244
3263
|
/** When set, updates chart legend visibility (same source as `showLegend` from `useReport`). */
|
|
3245
3264
|
showLegend?: boolean;
|
|
3265
|
+
/**
|
|
3266
|
+
* Display-only ordering applied after query and pivot processing.
|
|
3267
|
+
* Use a value from `chartSortOptions`; pass an empty string to clear.
|
|
3268
|
+
*/
|
|
3269
|
+
chartSort?: string;
|
|
3246
3270
|
/** Update the X-axis value returned by `useReport`. */
|
|
3247
3271
|
xAxis?: SetReportChartAxesInput['xAxis'];
|
|
3248
3272
|
/** Replace the Y-axis value returned by `useReport`. */
|
|
@@ -3366,6 +3390,7 @@ declare function useReport(reportIdArg?: string, options?: UseReportOptions): {
|
|
|
3366
3390
|
}[];
|
|
3367
3391
|
chartType: string;
|
|
3368
3392
|
showLegend?: boolean;
|
|
3393
|
+
chartSort?: ChartSort;
|
|
3369
3394
|
dateField?: {
|
|
3370
3395
|
table: string;
|
|
3371
3396
|
field: string;
|
|
@@ -3446,7 +3471,10 @@ declare function useReport(reportIdArg?: string, options?: UseReportOptions): {
|
|
|
3446
3471
|
label: string;
|
|
3447
3472
|
value: string;
|
|
3448
3473
|
}[];
|
|
3449
|
-
|
|
3474
|
+
/** Display-only chart ordering; update with a value from `chartSortOptions`. */
|
|
3475
|
+
chartSort: string;
|
|
3476
|
+
chartSortOptions: ChartSortOption[];
|
|
3477
|
+
chartType: "table" | "column" | "metric" | "gauge" | "stacked" | "stacked bar" | "line" | "radar" | "bar" | "pie" | "US map" | "World map";
|
|
3450
3478
|
chartTypeOptions: ChartTypeOption[];
|
|
3451
3479
|
/** Selected tabular columns in display order. */
|
|
3452
3480
|
columns: ReportColumnValue[];
|
|
@@ -3753,6 +3781,11 @@ declare const useDashboard: (dashboardName: string, config?: {
|
|
|
3753
3781
|
cacheEnabled?: boolean;
|
|
3754
3782
|
cacheType?: "memory" | "idb";
|
|
3755
3783
|
showCacheLogs?: boolean;
|
|
3784
|
+
cacheDateRange?: {
|
|
3785
|
+
startDate: Date;
|
|
3786
|
+
endDate: Date;
|
|
3787
|
+
};
|
|
3788
|
+
reportStaleTimeMs?: number;
|
|
3756
3789
|
}) => {
|
|
3757
3790
|
isLoading: boolean;
|
|
3758
3791
|
sections: Record<string, QuillReport[]> | null;
|
|
@@ -3772,6 +3805,7 @@ declare const useDashboard: (dashboardName: string, config?: {
|
|
|
3772
3805
|
} | Filter>) => void;
|
|
3773
3806
|
lastUpdated: number;
|
|
3774
3807
|
forceCacheRefresh: () => void;
|
|
3808
|
+
primeReportSource: (reportId: string) => Promise<void>;
|
|
3775
3809
|
reload: UseDashboardReload;
|
|
3776
3810
|
};
|
|
3777
3811
|
declare const useDashboardReport: (reportId: string, config?: {
|
|
@@ -4084,7 +4118,7 @@ declare const useVirtualTables: () => {
|
|
|
4084
4118
|
}>;
|
|
4085
4119
|
};
|
|
4086
4120
|
|
|
4087
|
-
declare const quillFetch: ({ client, task, method, metadata, abortSignal, credentials, urlParameters, getToken, }: QuillFetchOptions) => Promise<QuillResults>;
|
|
4121
|
+
declare const quillFetch: ({ client, task, method, metadata, abortSignal, credentials, urlParameters, shareRequest, getToken, }: QuillFetchOptions) => Promise<QuillResults>;
|
|
4088
4122
|
|
|
4089
4123
|
declare const downloadCSV: (data: {
|
|
4090
4124
|
rows: any[];
|
|
@@ -4614,4 +4648,4 @@ interface ReportTableProps {
|
|
|
4614
4648
|
}
|
|
4615
4649
|
declare const ReportTable: ({ reportBuilder, TableComponent, }: ReportTableProps) => react_jsx_runtime.JSX.Element;
|
|
4616
4650
|
|
|
4617
|
-
export { ALL_TENANTS, AddColumns, AddFilters, AddLimit, AddPivot, AddSort, AdditionalSchemaTablesContext, type AxisFormat$1 as AxisFormat, type BarChartInteraction, type ButtonComponentProps, Calculation, type ChangelogEntry, Chart, ChartDisplay, ChartEditor, type ChartEditorProps, type ChartProps, type ChartType, type ChartTypeOption, Chat, type ChatModelId, type ChatProps, type CheckboxComponentProps, type ColorMapType, type Column$1 as Column, type ColumnActions, type ColumnSelectionOption, type ContainerComponentProps, DEFAULT_PAGE_SIZE, DEFAULT_USE_REPORT_ROWS_PER_REQUEST, Dashboard, type DashboardDateFilter, type DashboardFilter, DashboardFilterType, DashboardLegacy, type DashboardLegacyProps, type DashboardMultiFilter, type DashboardProps, type DashboardSectionComponentProps, type DashboardSingleFilter, type DashboardTenantFilter, type DatasourceOption, DateOperator, type DateRange, type DateRangePickerComponentProps, type DateRangePickerOption, type DeleteButtonComponentProps, type DraggableColumnComponentProps, type EventBreadcrumb, type EventContext, type EventError, type EventMetadata, type EventTracking, type EventUser, type Filter, type FilterDraftQueryBuilderProps, type FilterFieldOptions, type FilterPopoverComponentProps, FilterType, type HeaderComponentProps, type HeaderProps, type InternalDashboardDateFilter, type InternalDashboardTenantFilter, type InternalFilter, type LabelComponentProps, type LimitPopoverComponentProps, type ModalComponentProps, NullOperator, NumberOperator, type OnChangeFn, type Option, type PaginationState, type Pivot, type PivotAggregation, type PivotDateBucket, type PivotDimensionFilter, type PopoverComponentProps, type QueryBuilderDisplayGroup, type QueryBuilderDisplayRule, type QuillCustomInterval, type QuillCustomRelativeInterval, type QuillCustomRepeatingInterval, type QuillCustomStaticInterval, type QuillFetchOptions, type QuillPreviousMonthInterval, type QuillPreviousQuarterInterval, QuillProvider, type QuillProviderProps, type QuillReport, type QuillReportProps, type QuillResults, type QuillTheme, type QuillWeekInterval, ReportBuilder$1 as ReportBuilder, type ReportBuilderColumn, type ReportBuilderLimit, type ReportBuilderProps, type ReportBuilderSort, type ReportBuilderState, type ReportColumnInput, type ReportColumnValue, ReportDetail, type ReportDetailProps, type ReportDetailTable, ReportTable, type ReportVirtualQueryReference, type ReportXAxisValue, type ReportYAxisFieldValue, type ReportYAxisValue, SINGLE_TENANT, SQLEditor, type SQLEditorProps, SaveReport, SavedQueriesContext, type SavedQueriesData, type SavedQuerySelectOption, SchemaListComponent, type SelectColumnComponentProps, type SelectComponentProps, type SetFiltersInput, type SetReportBuilderInput, type SetReportChartAxesInput, type SidebarComponentProps, type SidebarHeadingComponentProps, type SortPopoverComponentProps, StaticChart, type StaticChartProps, StringOperator, Table, type TableComponentProps, type TableProps, type TabsComponentProps, type TextComponentProps, type TextInputComponentProps, ThemeContext, type Updater, type UseDashboardReload, type UseFormQueryBuilderField, type UseFormQueryBuilderProps, type UseReportFilterDraft, type UseReportQueryBuilder, type UseReportSaveOverrides, type VirtualQuery, type VirtualQueryColumn, areQueryBuilderFilterDraftsDirty, buildReportVirtualQueries, buildSavedQuerySelectOptions, countFilterRules, defaultFilterRuleValueForOperator, deleteVirtualQuery, downloadCSV, fetchVirtualQueries, findLinkedReportsUsingVirtualQuery, findReportsBlockingVirtualQueryDeletion, quillFormat as format, formatReportsBlockingVirtualQueryDeletion, getVirtualQueryLabel, isQueryBuilderDisplayGroup, isQueryBuilderDisplayRule, normalizeRelativeDateRules, prepareQueryBuilderFiltersForSet, queryBuilderFiltersForEditor, quillFetch, resolveSavedQueryIdFromBaseTables, saveVirtualQuery, stripQueryBuilderTransientFields, tableColumnFormatFromUiSelection, upsertVirtualQueryInCatalog, upsertVirtualQueryTableInSchema, useAllReports, useAskQuill, useChangelogRefresh, useDashboard, useDashboardConfigInternal, useDashboardInternal, useDashboardReport, useDashboardReports, useDashboards, useExport, useMemoizedRows, useQuill, useReport, useReportBuilder, useReportQueryBuilder, useReports, useTenants, useVirtualTables, virtualQueryToTable };
|
|
4651
|
+
export { ALL_TENANTS, AddColumns, AddFilters, AddLimit, AddPivot, AddSort, AdditionalSchemaTablesContext, type AxisFormat$1 as AxisFormat, type BarChartInteraction, type ButtonComponentProps, Calculation, type ChangelogEntry, Chart, ChartDisplay, ChartEditor, type ChartEditorProps, type ChartProps, type ChartSort, type ChartType, type ChartTypeOption, Chat, type ChatModelId, type ChatProps, type CheckboxComponentProps, type ColorMapType, type Column$1 as Column, type ColumnActions, type ColumnSelectionOption, type ContainerComponentProps, DEFAULT_PAGE_SIZE, DEFAULT_USE_REPORT_ROWS_PER_REQUEST, Dashboard, type DashboardDateFilter, type DashboardFilter, DashboardFilterType, DashboardLegacy, type DashboardLegacyProps, type DashboardMultiFilter, type DashboardProps, type DashboardSectionComponentProps, type DashboardSingleFilter, type DashboardTenantFilter, type DatasourceOption, DateOperator, type DateRange, type DateRangePickerComponentProps, type DateRangePickerOption, type DeleteButtonComponentProps, type DraggableColumnComponentProps, type EventBreadcrumb, type EventContext, type EventError, type EventMetadata, type EventTracking, type EventUser, type Filter, type FilterDraftQueryBuilderProps, type FilterFieldOptions, type FilterPopoverComponentProps, FilterType, type HeaderComponentProps, type HeaderProps, type InternalDashboardDateFilter, type InternalDashboardTenantFilter, type InternalFilter, type LabelComponentProps, type LimitPopoverComponentProps, type ModalComponentProps, NullOperator, NumberOperator, type OnChangeFn, type Option, type PaginationState, type Pivot, type PivotAggregation, type PivotDateBucket, type PivotDimensionFilter, type PopoverComponentProps, type QueryBuilderDisplayGroup, type QueryBuilderDisplayRule, type QuillCustomInterval, type QuillCustomRelativeInterval, type QuillCustomRepeatingInterval, type QuillCustomStaticInterval, type QuillFetchOptions, type QuillPreviousMonthInterval, type QuillPreviousQuarterInterval, QuillProvider, type QuillProviderProps, type QuillReport, type QuillReportProps, type QuillResults, type QuillTheme, type QuillWeekInterval, ReportBuilder$1 as ReportBuilder, type ReportBuilderColumn, type ReportBuilderLimit, type ReportBuilderProps, type ReportBuilderSort, type ReportBuilderState, type ReportColumnInput, type ReportColumnValue, ReportDetail, type ReportDetailProps, type ReportDetailTable, ReportTable, type ReportVirtualQueryReference, type ReportXAxisValue, type ReportYAxisFieldValue, type ReportYAxisValue, SINGLE_TENANT, SQLEditor, type SQLEditorProps, SaveReport, SavedQueriesContext, type SavedQueriesData, type SavedQuerySelectOption, SchemaListComponent, type SelectColumnComponentProps, type SelectComponentProps, type SetFiltersInput, type SetReportBuilderInput, type SetReportChartAxesInput, type SidebarComponentProps, type SidebarHeadingComponentProps, type SortPopoverComponentProps, StaticChart, type StaticChartProps, StringOperator, Table, type TableComponentProps, type TableProps, type TabsComponentProps, type TextComponentProps, type TextInputComponentProps, ThemeContext, type Updater, type UseDashboardReload, type UseFormQueryBuilderField, type UseFormQueryBuilderProps, type UseReportFilterDraft, type UseReportQueryBuilder, type UseReportSaveOverrides, type VirtualQuery, type VirtualQueryColumn, areQueryBuilderFilterDraftsDirty, buildReportVirtualQueries, buildSavedQuerySelectOptions, countFilterRules, defaultFilterRuleValueForOperator, deleteVirtualQuery, downloadCSV, fetchVirtualQueries, findLinkedReportsUsingVirtualQuery, findReportsBlockingVirtualQueryDeletion, quillFormat as format, formatReportsBlockingVirtualQueryDeletion, getVirtualQueryLabel, isQueryBuilderDisplayGroup, isQueryBuilderDisplayRule, normalizeRelativeDateRules, prepareQueryBuilderFiltersForSet, queryBuilderFiltersForEditor, quillFetch, resolveSavedQueryIdFromBaseTables, saveVirtualQuery, stripQueryBuilderTransientFields, tableColumnFormatFromUiSelection, upsertVirtualQueryInCatalog, upsertVirtualQueryTableInSchema, useAllReports, useAskQuill, useChangelogRefresh, useDashboard, useDashboardConfigInternal, useDashboardInternal, useDashboardReport, useDashboardReports, useDashboards, useExport, useMemoizedRows, useQuill, useReport, useReportBuilder, useReportQueryBuilder, useReports, useTenants, useVirtualTables, virtualQueryToTable };
|
package/dist/index.d.ts
CHANGED
|
@@ -628,6 +628,31 @@ type PivotData = {
|
|
|
628
628
|
comparisonPivotQuery?: string;
|
|
629
629
|
};
|
|
630
630
|
|
|
631
|
+
type QueryBuilderCombinator = 'and' | 'or';
|
|
632
|
+
type QueryBuilderRule = {
|
|
633
|
+
field: string;
|
|
634
|
+
table?: string;
|
|
635
|
+
operator: string;
|
|
636
|
+
value: unknown;
|
|
637
|
+
};
|
|
638
|
+
type QueryBuilderRuleGroupEntry = QueryBuilderRule | QueryBuilderRuleGroup | QueryBuilderCombinator;
|
|
639
|
+
type QueryBuilderRuleGroup = {
|
|
640
|
+
combinator?: QueryBuilderCombinator;
|
|
641
|
+
rules: QueryBuilderRuleGroupEntry[];
|
|
642
|
+
};
|
|
643
|
+
type QueryBuilderFieldType = 'string' | 'number' | 'date' | 'boolean' | 'null';
|
|
644
|
+
type QueryBuilderOperatorOption = {
|
|
645
|
+
name: string;
|
|
646
|
+
value: string;
|
|
647
|
+
label: string;
|
|
648
|
+
arity?: 'unary' | 'binary' | number;
|
|
649
|
+
};
|
|
650
|
+
/**
|
|
651
|
+
* Expand UI `inBucket` leaf rules to `between` for react-querybuilder editors.
|
|
652
|
+
* Custom UIs keep `inBucket` on `useReport().filters`; the draft boundary uses this.
|
|
653
|
+
*/
|
|
654
|
+
declare const queryBuilderFiltersForEditor: (group: QueryBuilderRuleGroup) => QueryBuilderRuleGroup;
|
|
655
|
+
|
|
631
656
|
type SortDirection = 'asc' | 'desc' | 'ASC' | 'DESC';
|
|
632
657
|
type ReportBuilderTable = {
|
|
633
658
|
name: string;
|
|
@@ -665,7 +690,10 @@ type ReportBuilderLimit = {
|
|
|
665
690
|
type ReportBuilderState = {
|
|
666
691
|
tables: ReportBuilderTable[];
|
|
667
692
|
columns: ReportBuilderColumn[];
|
|
668
|
-
|
|
693
|
+
/** Canonical report filter representation. */
|
|
694
|
+
rules: QueryBuilderRuleGroup;
|
|
695
|
+
/** @deprecated Use rules. Retained while legacy report-builder hooks migrate. */
|
|
696
|
+
filterStack?: FilterTreeNode[];
|
|
669
697
|
pivot: Pivot | null;
|
|
670
698
|
sort: ReportBuilderSort[];
|
|
671
699
|
limit: ReportBuilderLimit | null;
|
|
@@ -694,6 +722,12 @@ interface UniqueValuesByColumn {
|
|
|
694
722
|
[column: string]: string[];
|
|
695
723
|
}
|
|
696
724
|
|
|
725
|
+
/** Display-only ordering applied after query and pivot processing. */
|
|
726
|
+
type ChartSort = {
|
|
727
|
+
target: 'rows' | 'series';
|
|
728
|
+
field: string;
|
|
729
|
+
direction: 'ASC' | 'DESC';
|
|
730
|
+
};
|
|
697
731
|
/**
|
|
698
732
|
* ## QuillReport
|
|
699
733
|
* Represents an individual item on a dashboard.
|
|
@@ -722,6 +756,8 @@ interface QuillReport {
|
|
|
722
756
|
chartType: string;
|
|
723
757
|
/** Whether to show a legend for this chart. */
|
|
724
758
|
showLegend?: boolean;
|
|
759
|
+
/** Display-only ordering applied after query and pivot processing. */
|
|
760
|
+
chartSort?: ChartSort;
|
|
725
761
|
/** The table and field this report uses for date filtering, if any. */
|
|
726
762
|
dateField?: {
|
|
727
763
|
table: string;
|
|
@@ -1911,6 +1947,8 @@ interface QuillFetchOptions {
|
|
|
1911
1947
|
credentials?: RequestCredentials;
|
|
1912
1948
|
urlParameters?: string;
|
|
1913
1949
|
adminMode?: boolean;
|
|
1950
|
+
/** Internal opt-in for exact initial-request sharing across mounted hooks. */
|
|
1951
|
+
shareRequest?: boolean;
|
|
1914
1952
|
getToken: () => Promise<string>;
|
|
1915
1953
|
}
|
|
1916
1954
|
interface QuillResults {
|
|
@@ -2952,29 +2990,10 @@ interface ChatProps {
|
|
|
2952
2990
|
type ChatModelId = 'gemini-2-flash' | 'gemini-2.5-flash' | 'gemini-3-flash-preview' | 'gpt-5.1' | 'opus-4.5' | 'kimi-k2.5';
|
|
2953
2991
|
declare function Chat({ selectedDashboard, ChartViewComponent, agentEndpoint, suggestions, }: ChatProps): react_jsx_runtime.JSX.Element;
|
|
2954
2992
|
|
|
2955
|
-
type
|
|
2956
|
-
type QueryBuilderRule = {
|
|
2957
|
-
field: string;
|
|
2958
|
-
operator: string;
|
|
2959
|
-
value: unknown;
|
|
2960
|
-
};
|
|
2961
|
-
type QueryBuilderRuleGroupEntry = QueryBuilderRule | QueryBuilderRuleGroup | QueryBuilderCombinator;
|
|
2962
|
-
type QueryBuilderRuleGroup = {
|
|
2963
|
-
combinator?: QueryBuilderCombinator;
|
|
2964
|
-
rules: QueryBuilderRuleGroupEntry[];
|
|
2965
|
-
};
|
|
2966
|
-
type QueryBuilderFieldType = 'string' | 'number' | 'date' | 'boolean' | 'null';
|
|
2967
|
-
type QueryBuilderOperatorOption = {
|
|
2968
|
-
name: string;
|
|
2969
|
-
value: string;
|
|
2993
|
+
type ChartSortOption = {
|
|
2970
2994
|
label: string;
|
|
2971
|
-
|
|
2995
|
+
value: string;
|
|
2972
2996
|
};
|
|
2973
|
-
/**
|
|
2974
|
-
* Expand UI `inBucket` leaf rules to `between` for react-querybuilder editors.
|
|
2975
|
-
* Custom UIs keep `inBucket` on `useReport().filters`; the draft boundary uses this.
|
|
2976
|
-
*/
|
|
2977
|
-
declare const queryBuilderFiltersForEditor: (group: QueryBuilderRuleGroup) => QueryBuilderRuleGroup;
|
|
2978
2997
|
|
|
2979
2998
|
/**
|
|
2980
2999
|
* Pagination types and pure helpers for `useReport`, mirroring the
|
|
@@ -2990,8 +3009,8 @@ interface PaginationState {
|
|
|
2990
3009
|
type Updater<T> = T | ((old: T) => T);
|
|
2991
3010
|
type OnChangeFn<T> = (updaterOrValue: Updater<T>) => void;
|
|
2992
3011
|
declare const DEFAULT_PAGE_SIZE = 10;
|
|
2993
|
-
/**
|
|
2994
|
-
declare const DEFAULT_USE_REPORT_ROWS_PER_REQUEST
|
|
3012
|
+
/** Default row window for every useReport chart/table request. */
|
|
3013
|
+
declare const DEFAULT_USE_REPORT_ROWS_PER_REQUEST = 10;
|
|
2995
3014
|
|
|
2996
3015
|
type SelectOption = {
|
|
2997
3016
|
label: string;
|
|
@@ -3243,6 +3262,11 @@ interface SetReportBuilderInput {
|
|
|
3243
3262
|
chartType?: ChartType;
|
|
3244
3263
|
/** When set, updates chart legend visibility (same source as `showLegend` from `useReport`). */
|
|
3245
3264
|
showLegend?: boolean;
|
|
3265
|
+
/**
|
|
3266
|
+
* Display-only ordering applied after query and pivot processing.
|
|
3267
|
+
* Use a value from `chartSortOptions`; pass an empty string to clear.
|
|
3268
|
+
*/
|
|
3269
|
+
chartSort?: string;
|
|
3246
3270
|
/** Update the X-axis value returned by `useReport`. */
|
|
3247
3271
|
xAxis?: SetReportChartAxesInput['xAxis'];
|
|
3248
3272
|
/** Replace the Y-axis value returned by `useReport`. */
|
|
@@ -3366,6 +3390,7 @@ declare function useReport(reportIdArg?: string, options?: UseReportOptions): {
|
|
|
3366
3390
|
}[];
|
|
3367
3391
|
chartType: string;
|
|
3368
3392
|
showLegend?: boolean;
|
|
3393
|
+
chartSort?: ChartSort;
|
|
3369
3394
|
dateField?: {
|
|
3370
3395
|
table: string;
|
|
3371
3396
|
field: string;
|
|
@@ -3446,7 +3471,10 @@ declare function useReport(reportIdArg?: string, options?: UseReportOptions): {
|
|
|
3446
3471
|
label: string;
|
|
3447
3472
|
value: string;
|
|
3448
3473
|
}[];
|
|
3449
|
-
|
|
3474
|
+
/** Display-only chart ordering; update with a value from `chartSortOptions`. */
|
|
3475
|
+
chartSort: string;
|
|
3476
|
+
chartSortOptions: ChartSortOption[];
|
|
3477
|
+
chartType: "table" | "column" | "metric" | "gauge" | "stacked" | "stacked bar" | "line" | "radar" | "bar" | "pie" | "US map" | "World map";
|
|
3450
3478
|
chartTypeOptions: ChartTypeOption[];
|
|
3451
3479
|
/** Selected tabular columns in display order. */
|
|
3452
3480
|
columns: ReportColumnValue[];
|
|
@@ -3753,6 +3781,11 @@ declare const useDashboard: (dashboardName: string, config?: {
|
|
|
3753
3781
|
cacheEnabled?: boolean;
|
|
3754
3782
|
cacheType?: "memory" | "idb";
|
|
3755
3783
|
showCacheLogs?: boolean;
|
|
3784
|
+
cacheDateRange?: {
|
|
3785
|
+
startDate: Date;
|
|
3786
|
+
endDate: Date;
|
|
3787
|
+
};
|
|
3788
|
+
reportStaleTimeMs?: number;
|
|
3756
3789
|
}) => {
|
|
3757
3790
|
isLoading: boolean;
|
|
3758
3791
|
sections: Record<string, QuillReport[]> | null;
|
|
@@ -3772,6 +3805,7 @@ declare const useDashboard: (dashboardName: string, config?: {
|
|
|
3772
3805
|
} | Filter>) => void;
|
|
3773
3806
|
lastUpdated: number;
|
|
3774
3807
|
forceCacheRefresh: () => void;
|
|
3808
|
+
primeReportSource: (reportId: string) => Promise<void>;
|
|
3775
3809
|
reload: UseDashboardReload;
|
|
3776
3810
|
};
|
|
3777
3811
|
declare const useDashboardReport: (reportId: string, config?: {
|
|
@@ -4084,7 +4118,7 @@ declare const useVirtualTables: () => {
|
|
|
4084
4118
|
}>;
|
|
4085
4119
|
};
|
|
4086
4120
|
|
|
4087
|
-
declare const quillFetch: ({ client, task, method, metadata, abortSignal, credentials, urlParameters, getToken, }: QuillFetchOptions) => Promise<QuillResults>;
|
|
4121
|
+
declare const quillFetch: ({ client, task, method, metadata, abortSignal, credentials, urlParameters, shareRequest, getToken, }: QuillFetchOptions) => Promise<QuillResults>;
|
|
4088
4122
|
|
|
4089
4123
|
declare const downloadCSV: (data: {
|
|
4090
4124
|
rows: any[];
|
|
@@ -4614,4 +4648,4 @@ interface ReportTableProps {
|
|
|
4614
4648
|
}
|
|
4615
4649
|
declare const ReportTable: ({ reportBuilder, TableComponent, }: ReportTableProps) => react_jsx_runtime.JSX.Element;
|
|
4616
4650
|
|
|
4617
|
-
export { ALL_TENANTS, AddColumns, AddFilters, AddLimit, AddPivot, AddSort, AdditionalSchemaTablesContext, type AxisFormat$1 as AxisFormat, type BarChartInteraction, type ButtonComponentProps, Calculation, type ChangelogEntry, Chart, ChartDisplay, ChartEditor, type ChartEditorProps, type ChartProps, type ChartType, type ChartTypeOption, Chat, type ChatModelId, type ChatProps, type CheckboxComponentProps, type ColorMapType, type Column$1 as Column, type ColumnActions, type ColumnSelectionOption, type ContainerComponentProps, DEFAULT_PAGE_SIZE, DEFAULT_USE_REPORT_ROWS_PER_REQUEST, Dashboard, type DashboardDateFilter, type DashboardFilter, DashboardFilterType, DashboardLegacy, type DashboardLegacyProps, type DashboardMultiFilter, type DashboardProps, type DashboardSectionComponentProps, type DashboardSingleFilter, type DashboardTenantFilter, type DatasourceOption, DateOperator, type DateRange, type DateRangePickerComponentProps, type DateRangePickerOption, type DeleteButtonComponentProps, type DraggableColumnComponentProps, type EventBreadcrumb, type EventContext, type EventError, type EventMetadata, type EventTracking, type EventUser, type Filter, type FilterDraftQueryBuilderProps, type FilterFieldOptions, type FilterPopoverComponentProps, FilterType, type HeaderComponentProps, type HeaderProps, type InternalDashboardDateFilter, type InternalDashboardTenantFilter, type InternalFilter, type LabelComponentProps, type LimitPopoverComponentProps, type ModalComponentProps, NullOperator, NumberOperator, type OnChangeFn, type Option, type PaginationState, type Pivot, type PivotAggregation, type PivotDateBucket, type PivotDimensionFilter, type PopoverComponentProps, type QueryBuilderDisplayGroup, type QueryBuilderDisplayRule, type QuillCustomInterval, type QuillCustomRelativeInterval, type QuillCustomRepeatingInterval, type QuillCustomStaticInterval, type QuillFetchOptions, type QuillPreviousMonthInterval, type QuillPreviousQuarterInterval, QuillProvider, type QuillProviderProps, type QuillReport, type QuillReportProps, type QuillResults, type QuillTheme, type QuillWeekInterval, ReportBuilder$1 as ReportBuilder, type ReportBuilderColumn, type ReportBuilderLimit, type ReportBuilderProps, type ReportBuilderSort, type ReportBuilderState, type ReportColumnInput, type ReportColumnValue, ReportDetail, type ReportDetailProps, type ReportDetailTable, ReportTable, type ReportVirtualQueryReference, type ReportXAxisValue, type ReportYAxisFieldValue, type ReportYAxisValue, SINGLE_TENANT, SQLEditor, type SQLEditorProps, SaveReport, SavedQueriesContext, type SavedQueriesData, type SavedQuerySelectOption, SchemaListComponent, type SelectColumnComponentProps, type SelectComponentProps, type SetFiltersInput, type SetReportBuilderInput, type SetReportChartAxesInput, type SidebarComponentProps, type SidebarHeadingComponentProps, type SortPopoverComponentProps, StaticChart, type StaticChartProps, StringOperator, Table, type TableComponentProps, type TableProps, type TabsComponentProps, type TextComponentProps, type TextInputComponentProps, ThemeContext, type Updater, type UseDashboardReload, type UseFormQueryBuilderField, type UseFormQueryBuilderProps, type UseReportFilterDraft, type UseReportQueryBuilder, type UseReportSaveOverrides, type VirtualQuery, type VirtualQueryColumn, areQueryBuilderFilterDraftsDirty, buildReportVirtualQueries, buildSavedQuerySelectOptions, countFilterRules, defaultFilterRuleValueForOperator, deleteVirtualQuery, downloadCSV, fetchVirtualQueries, findLinkedReportsUsingVirtualQuery, findReportsBlockingVirtualQueryDeletion, quillFormat as format, formatReportsBlockingVirtualQueryDeletion, getVirtualQueryLabel, isQueryBuilderDisplayGroup, isQueryBuilderDisplayRule, normalizeRelativeDateRules, prepareQueryBuilderFiltersForSet, queryBuilderFiltersForEditor, quillFetch, resolveSavedQueryIdFromBaseTables, saveVirtualQuery, stripQueryBuilderTransientFields, tableColumnFormatFromUiSelection, upsertVirtualQueryInCatalog, upsertVirtualQueryTableInSchema, useAllReports, useAskQuill, useChangelogRefresh, useDashboard, useDashboardConfigInternal, useDashboardInternal, useDashboardReport, useDashboardReports, useDashboards, useExport, useMemoizedRows, useQuill, useReport, useReportBuilder, useReportQueryBuilder, useReports, useTenants, useVirtualTables, virtualQueryToTable };
|
|
4651
|
+
export { ALL_TENANTS, AddColumns, AddFilters, AddLimit, AddPivot, AddSort, AdditionalSchemaTablesContext, type AxisFormat$1 as AxisFormat, type BarChartInteraction, type ButtonComponentProps, Calculation, type ChangelogEntry, Chart, ChartDisplay, ChartEditor, type ChartEditorProps, type ChartProps, type ChartSort, type ChartType, type ChartTypeOption, Chat, type ChatModelId, type ChatProps, type CheckboxComponentProps, type ColorMapType, type Column$1 as Column, type ColumnActions, type ColumnSelectionOption, type ContainerComponentProps, DEFAULT_PAGE_SIZE, DEFAULT_USE_REPORT_ROWS_PER_REQUEST, Dashboard, type DashboardDateFilter, type DashboardFilter, DashboardFilterType, DashboardLegacy, type DashboardLegacyProps, type DashboardMultiFilter, type DashboardProps, type DashboardSectionComponentProps, type DashboardSingleFilter, type DashboardTenantFilter, type DatasourceOption, DateOperator, type DateRange, type DateRangePickerComponentProps, type DateRangePickerOption, type DeleteButtonComponentProps, type DraggableColumnComponentProps, type EventBreadcrumb, type EventContext, type EventError, type EventMetadata, type EventTracking, type EventUser, type Filter, type FilterDraftQueryBuilderProps, type FilterFieldOptions, type FilterPopoverComponentProps, FilterType, type HeaderComponentProps, type HeaderProps, type InternalDashboardDateFilter, type InternalDashboardTenantFilter, type InternalFilter, type LabelComponentProps, type LimitPopoverComponentProps, type ModalComponentProps, NullOperator, NumberOperator, type OnChangeFn, type Option, type PaginationState, type Pivot, type PivotAggregation, type PivotDateBucket, type PivotDimensionFilter, type PopoverComponentProps, type QueryBuilderDisplayGroup, type QueryBuilderDisplayRule, type QuillCustomInterval, type QuillCustomRelativeInterval, type QuillCustomRepeatingInterval, type QuillCustomStaticInterval, type QuillFetchOptions, type QuillPreviousMonthInterval, type QuillPreviousQuarterInterval, QuillProvider, type QuillProviderProps, type QuillReport, type QuillReportProps, type QuillResults, type QuillTheme, type QuillWeekInterval, ReportBuilder$1 as ReportBuilder, type ReportBuilderColumn, type ReportBuilderLimit, type ReportBuilderProps, type ReportBuilderSort, type ReportBuilderState, type ReportColumnInput, type ReportColumnValue, ReportDetail, type ReportDetailProps, type ReportDetailTable, ReportTable, type ReportVirtualQueryReference, type ReportXAxisValue, type ReportYAxisFieldValue, type ReportYAxisValue, SINGLE_TENANT, SQLEditor, type SQLEditorProps, SaveReport, SavedQueriesContext, type SavedQueriesData, type SavedQuerySelectOption, SchemaListComponent, type SelectColumnComponentProps, type SelectComponentProps, type SetFiltersInput, type SetReportBuilderInput, type SetReportChartAxesInput, type SidebarComponentProps, type SidebarHeadingComponentProps, type SortPopoverComponentProps, StaticChart, type StaticChartProps, StringOperator, Table, type TableComponentProps, type TableProps, type TabsComponentProps, type TextComponentProps, type TextInputComponentProps, ThemeContext, type Updater, type UseDashboardReload, type UseFormQueryBuilderField, type UseFormQueryBuilderProps, type UseReportFilterDraft, type UseReportQueryBuilder, type UseReportSaveOverrides, type VirtualQuery, type VirtualQueryColumn, areQueryBuilderFilterDraftsDirty, buildReportVirtualQueries, buildSavedQuerySelectOptions, countFilterRules, defaultFilterRuleValueForOperator, deleteVirtualQuery, downloadCSV, fetchVirtualQueries, findLinkedReportsUsingVirtualQuery, findReportsBlockingVirtualQueryDeletion, quillFormat as format, formatReportsBlockingVirtualQueryDeletion, getVirtualQueryLabel, isQueryBuilderDisplayGroup, isQueryBuilderDisplayRule, normalizeRelativeDateRules, prepareQueryBuilderFiltersForSet, queryBuilderFiltersForEditor, quillFetch, resolveSavedQueryIdFromBaseTables, saveVirtualQuery, stripQueryBuilderTransientFields, tableColumnFormatFromUiSelection, upsertVirtualQueryInCatalog, upsertVirtualQueryTableInSchema, useAllReports, useAskQuill, useChangelogRefresh, useDashboard, useDashboardConfigInternal, useDashboardInternal, useDashboardReport, useDashboardReports, useDashboards, useExport, useMemoizedRows, useQuill, useReport, useReportBuilder, useReportQueryBuilder, useReports, useTenants, useVirtualTables, virtualQueryToTable };
|