@quillsql/react 2.16.80 → 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 +3130 -2277
- package/dist/index.d.cts +249 -109
- package/dist/index.d.ts +249 -109
- package/dist/index.js +2915 -2078
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -16,6 +16,8 @@ interface PopoverComponentProps {
|
|
|
16
16
|
ignoredRefs?: React$1.RefObject<any>[];
|
|
17
17
|
horizontalPadding?: number;
|
|
18
18
|
titlePaddingLeft?: number;
|
|
19
|
+
viewportPadding?: number;
|
|
20
|
+
popoverOffset?: number;
|
|
19
21
|
}
|
|
20
22
|
interface ButtonComponentProps {
|
|
21
23
|
onClick: () => void;
|
|
@@ -626,6 +628,31 @@ type PivotData = {
|
|
|
626
628
|
comparisonPivotQuery?: string;
|
|
627
629
|
};
|
|
628
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
|
+
|
|
629
656
|
type SortDirection = 'asc' | 'desc' | 'ASC' | 'DESC';
|
|
630
657
|
type ReportBuilderTable = {
|
|
631
658
|
name: string;
|
|
@@ -663,7 +690,10 @@ type ReportBuilderLimit = {
|
|
|
663
690
|
type ReportBuilderState = {
|
|
664
691
|
tables: ReportBuilderTable[];
|
|
665
692
|
columns: ReportBuilderColumn[];
|
|
666
|
-
|
|
693
|
+
/** Canonical report filter representation. */
|
|
694
|
+
rules: QueryBuilderRuleGroup;
|
|
695
|
+
/** @deprecated Use rules. Retained while legacy report-builder hooks migrate. */
|
|
696
|
+
filterStack?: FilterTreeNode[];
|
|
667
697
|
pivot: Pivot | null;
|
|
668
698
|
sort: ReportBuilderSort[];
|
|
669
699
|
limit: ReportBuilderLimit | null;
|
|
@@ -780,6 +810,8 @@ interface QuillReport {
|
|
|
780
810
|
};
|
|
781
811
|
rowCount: number;
|
|
782
812
|
queryString: string;
|
|
813
|
+
/** Saved virtual queries used as this report's datasources. */
|
|
814
|
+
virtualQueries?: string[];
|
|
783
815
|
filterMap?: {
|
|
784
816
|
[key: string]: {
|
|
785
817
|
table: string;
|
|
@@ -1859,6 +1891,163 @@ interface TableProps {
|
|
|
1859
1891
|
*/
|
|
1860
1892
|
declare const Table: ({ TableComponent, ...props }: TableProps) => react_jsx_runtime.JSX.Element | null;
|
|
1861
1893
|
|
|
1894
|
+
type ClientFeatures = {
|
|
1895
|
+
cloudCache?: boolean;
|
|
1896
|
+
[key: string]: boolean | undefined;
|
|
1897
|
+
};
|
|
1898
|
+
type QuillProviderClient = {
|
|
1899
|
+
name: string;
|
|
1900
|
+
id?: string;
|
|
1901
|
+
clientId?: string;
|
|
1902
|
+
queryEndpoint: string;
|
|
1903
|
+
streamEndpoint?: string;
|
|
1904
|
+
queryHeaders?: HeadersInit;
|
|
1905
|
+
withCredentials: boolean;
|
|
1906
|
+
databaseType?: string;
|
|
1907
|
+
features?: ClientFeatures;
|
|
1908
|
+
featureFlags?: {
|
|
1909
|
+
[key: string]: boolean;
|
|
1910
|
+
};
|
|
1911
|
+
/** @deprecated Use clerkOrgId instead */
|
|
1912
|
+
domainName?: string;
|
|
1913
|
+
clerkOrgId: string;
|
|
1914
|
+
allTenantTypes?: QuillTenant[];
|
|
1915
|
+
defaultDashboard?: {
|
|
1916
|
+
name: string;
|
|
1917
|
+
owner: string;
|
|
1918
|
+
};
|
|
1919
|
+
schemaNames?: string[];
|
|
1920
|
+
};
|
|
1921
|
+
type QuillTenant = {
|
|
1922
|
+
name: string;
|
|
1923
|
+
tenantField: string;
|
|
1924
|
+
query?: string;
|
|
1925
|
+
mappings?: {
|
|
1926
|
+
[key: string]: {
|
|
1927
|
+
query: string;
|
|
1928
|
+
};
|
|
1929
|
+
};
|
|
1930
|
+
flags?: string[];
|
|
1931
|
+
tenantIds?: {
|
|
1932
|
+
id: string | number;
|
|
1933
|
+
flag: string;
|
|
1934
|
+
label: string;
|
|
1935
|
+
}[];
|
|
1936
|
+
scope: 'row' | 'schema' | 'database';
|
|
1937
|
+
defaultId?: string | number;
|
|
1938
|
+
fieldType?: 'string' | 'number' | 'none';
|
|
1939
|
+
};
|
|
1940
|
+
|
|
1941
|
+
interface QuillFetchOptions {
|
|
1942
|
+
client: Pick<QuillProviderClient, 'id' | 'clientId' | 'queryEndpoint' | 'queryHeaders' | 'withCredentials'>;
|
|
1943
|
+
task: string;
|
|
1944
|
+
method?: string;
|
|
1945
|
+
metadata: any;
|
|
1946
|
+
abortSignal?: AbortSignal;
|
|
1947
|
+
credentials?: RequestCredentials;
|
|
1948
|
+
urlParameters?: string;
|
|
1949
|
+
adminMode?: boolean;
|
|
1950
|
+
/** Internal opt-in for exact initial-request sharing across mounted hooks. */
|
|
1951
|
+
shareRequest?: boolean;
|
|
1952
|
+
getToken: () => Promise<string>;
|
|
1953
|
+
}
|
|
1954
|
+
interface QuillResults {
|
|
1955
|
+
data?: any;
|
|
1956
|
+
queries?: any;
|
|
1957
|
+
status?: string;
|
|
1958
|
+
error?: string;
|
|
1959
|
+
message?: string;
|
|
1960
|
+
}
|
|
1961
|
+
|
|
1962
|
+
type VirtualQueryColumn = {
|
|
1963
|
+
name: string;
|
|
1964
|
+
displayName?: string;
|
|
1965
|
+
fieldType: string;
|
|
1966
|
+
isVisible?: boolean;
|
|
1967
|
+
_id?: string;
|
|
1968
|
+
};
|
|
1969
|
+
type VirtualQuery = {
|
|
1970
|
+
id: string;
|
|
1971
|
+
name: string;
|
|
1972
|
+
displayName?: string;
|
|
1973
|
+
queryString: string;
|
|
1974
|
+
columns: VirtualQueryColumn[];
|
|
1975
|
+
clientId: string;
|
|
1976
|
+
shared: boolean;
|
|
1977
|
+
};
|
|
1978
|
+
type SavedQuerySelectOption = {
|
|
1979
|
+
id: string;
|
|
1980
|
+
label: string;
|
|
1981
|
+
};
|
|
1982
|
+
type ReportVirtualQueryReference = {
|
|
1983
|
+
id: string;
|
|
1984
|
+
name: string;
|
|
1985
|
+
dashboardName?: string;
|
|
1986
|
+
};
|
|
1987
|
+
type VirtualQueryFetchFn = (options: Omit<QuillFetchOptions, 'getToken'>) => Promise<QuillResults>;
|
|
1988
|
+
declare function getVirtualQueryLabel(query: VirtualQuery): string;
|
|
1989
|
+
/** Minimal column shape for persist — only `field` / `fieldType` are read. */
|
|
1990
|
+
type SaveVirtualQueryColumnInput = {
|
|
1991
|
+
field?: string;
|
|
1992
|
+
fieldType?: string;
|
|
1993
|
+
};
|
|
1994
|
+
declare function fetchVirtualQueries(args: {
|
|
1995
|
+
quillFetchWithToken: VirtualQueryFetchFn;
|
|
1996
|
+
queryEndpoint: string;
|
|
1997
|
+
clientId: string;
|
|
1998
|
+
queryHeaders?: HeadersInit;
|
|
1999
|
+
withCredentials?: boolean;
|
|
2000
|
+
}): Promise<{
|
|
2001
|
+
queries: VirtualQuery[];
|
|
2002
|
+
error?: string;
|
|
2003
|
+
}>;
|
|
2004
|
+
declare function saveVirtualQuery(args: {
|
|
2005
|
+
quillFetchWithToken: VirtualQueryFetchFn;
|
|
2006
|
+
client: QuillFetchOptions['client'];
|
|
2007
|
+
queryString: string;
|
|
2008
|
+
columns: SaveVirtualQueryColumnInput[];
|
|
2009
|
+
existingVirtualQuery?: VirtualQuery | null;
|
|
2010
|
+
displayName: string;
|
|
2011
|
+
shared: boolean;
|
|
2012
|
+
adminMode?: boolean;
|
|
2013
|
+
}): Promise<{
|
|
2014
|
+
virtualQuery?: VirtualQuery;
|
|
2015
|
+
error?: string;
|
|
2016
|
+
}>;
|
|
2017
|
+
declare function deleteVirtualQuery(args: {
|
|
2018
|
+
quillFetchWithToken: VirtualQueryFetchFn;
|
|
2019
|
+
queryEndpoint: string;
|
|
2020
|
+
clientId: string;
|
|
2021
|
+
id: string;
|
|
2022
|
+
queryHeaders?: HeadersInit;
|
|
2023
|
+
withCredentials?: boolean;
|
|
2024
|
+
}): Promise<{
|
|
2025
|
+
success: boolean;
|
|
2026
|
+
error?: string;
|
|
2027
|
+
}>;
|
|
2028
|
+
declare function virtualQueryToTable(query: VirtualQuery): Table$1;
|
|
2029
|
+
declare function resolveSavedQueryIdFromBaseTables(tableNames: string[], catalog: VirtualQuery[]): string | undefined;
|
|
2030
|
+
declare function buildSavedQuerySelectOptions(queries: VirtualQuery[], options?: {
|
|
2031
|
+
sharedOnly?: boolean;
|
|
2032
|
+
alwaysIncludeId?: string;
|
|
2033
|
+
}): SavedQuerySelectOption[];
|
|
2034
|
+
declare function buildReportVirtualQueries(savedQueryId?: string | null): string[];
|
|
2035
|
+
declare function upsertVirtualQueryTableInSchema(tables: Table$1[], query: VirtualQuery): Table$1[];
|
|
2036
|
+
declare function upsertVirtualQueryInCatalog(queries: VirtualQuery[], query: VirtualQuery): VirtualQuery[];
|
|
2037
|
+
declare function findLinkedReportsUsingVirtualQuery(reports: Iterable<{
|
|
2038
|
+
id?: string;
|
|
2039
|
+
name?: string;
|
|
2040
|
+
dashboardName?: string;
|
|
2041
|
+
virtualQueries?: string[] | null;
|
|
2042
|
+
}>, virtualQueryId: string): ReportVirtualQueryReference[];
|
|
2043
|
+
declare function findReportsBlockingVirtualQueryDeletion(reports: Iterable<{
|
|
2044
|
+
id?: string;
|
|
2045
|
+
name?: string;
|
|
2046
|
+
dashboardName?: string;
|
|
2047
|
+
virtualQueries?: string[] | null;
|
|
2048
|
+
}>, virtualQueryId: string): ReportVirtualQueryReference[];
|
|
2049
|
+
declare function formatReportsBlockingVirtualQueryDeletion(reports: ReportVirtualQueryReference[]): string;
|
|
2050
|
+
|
|
1862
2051
|
/**
|
|
1863
2052
|
* Props for the Quill SQLEditor component.
|
|
1864
2053
|
*/
|
|
@@ -1901,6 +2090,8 @@ interface SQLEditorProps {
|
|
|
1901
2090
|
}[];
|
|
1902
2091
|
onChange: (event: React$1.ChangeEvent<HTMLSelectElement>) => void;
|
|
1903
2092
|
width: number;
|
|
2093
|
+
disabled?: boolean;
|
|
2094
|
+
hideEmptyOption?: boolean;
|
|
1904
2095
|
}) => React$1.JSX.Element;
|
|
1905
2096
|
/**
|
|
1906
2097
|
* A table component to show the results of the SQL query.
|
|
@@ -2044,7 +2235,9 @@ interface SQLEditorProps {
|
|
|
2044
2235
|
onSubmitCreateReport?: (report: QuillReport) => void;
|
|
2045
2236
|
/** A callback function that will trigger when a chart is edited */
|
|
2046
2237
|
onSubmitEditReport?: (report: QuillReport) => void;
|
|
2047
|
-
onSaveQueryComplete?: (
|
|
2238
|
+
onSaveQueryComplete?: (virtualQuery: VirtualQuery) => void;
|
|
2239
|
+
/** Opens a report that uses the active saved query. */
|
|
2240
|
+
onOpenLinkedReport?: (report: ReportVirtualQueryReference) => void;
|
|
2048
2241
|
/** A callback function triggered when a chart element is clicked */
|
|
2049
2242
|
onClickChartElement?: (event: any) => void;
|
|
2050
2243
|
/** A callback function triggered when a user wants to add a virtual table */
|
|
@@ -2061,6 +2254,10 @@ interface SQLEditorProps {
|
|
|
2061
2254
|
* Whether SQL queries will be able to open a report creation flow.
|
|
2062
2255
|
*/
|
|
2063
2256
|
isChartBuilderEnabled?: boolean;
|
|
2257
|
+
/** Opens an external report builder instead of the legacy chart builder. */
|
|
2258
|
+
onOpenReportBuilder?: (input: {
|
|
2259
|
+
virtualQueryId?: string;
|
|
2260
|
+
}) => void;
|
|
2064
2261
|
/**
|
|
2065
2262
|
* Whether the "new query" button is enabled.
|
|
2066
2263
|
*/
|
|
@@ -2094,10 +2291,21 @@ interface SQLEditorProps {
|
|
|
2094
2291
|
* A report id that the SQL Editor will query from and modify.
|
|
2095
2292
|
*/
|
|
2096
2293
|
reportId?: string;
|
|
2294
|
+
/** The saved query being edited, if this editor was opened from one. */
|
|
2295
|
+
existingVirtualQuery?: VirtualQuery | null;
|
|
2296
|
+
/**
|
|
2297
|
+
* Default Query Type when creating a new query (no existingVirtualQuery).
|
|
2298
|
+
* `true` = Shared, `false` = Report Query. Defaults to Shared.
|
|
2299
|
+
*/
|
|
2300
|
+
initialShared?: boolean;
|
|
2097
2301
|
/**
|
|
2098
2302
|
* The default query to use as a placeholder.
|
|
2099
2303
|
*/
|
|
2100
2304
|
defaultQuery?: string;
|
|
2305
|
+
/**
|
|
2306
|
+
* Default display name when creating a new saved query (no existingVirtualQuery).
|
|
2307
|
+
*/
|
|
2308
|
+
defaultDisplayName?: string;
|
|
2101
2309
|
/**
|
|
2102
2310
|
* The default dashboard to add the query to.
|
|
2103
2311
|
*/
|
|
@@ -2117,7 +2325,7 @@ interface SQLEditorProps {
|
|
|
2117
2325
|
/**
|
|
2118
2326
|
* The label of the button to add the current query to a dashboard.
|
|
2119
2327
|
*
|
|
2120
|
-
* @default "
|
|
2328
|
+
* @default "Link to report"
|
|
2121
2329
|
*/
|
|
2122
2330
|
addToDashboardButtonLabel?: string;
|
|
2123
2331
|
/**
|
|
@@ -2160,7 +2368,7 @@ interface SQLEditorProps {
|
|
|
2160
2368
|
* ### SQLEditor API
|
|
2161
2369
|
* @see https://docs.quillsql.com/components/sql-editor
|
|
2162
2370
|
*/
|
|
2163
|
-
declare function SQLEditor({ ButtonComponent, SecondaryButtonComponent, DeleteButtonComponent, TextInputComponent, SelectComponent, TableComponent, isNewQueryEnabled, LoadingComponent, ModalComponent, PopoverComponent, CardComponent, LabelComponent, HeaderComponent, SubHeaderComponent, TextComponent, ErrorMessageComponent, ChartBuilderInputRowContainer, ChartBuilderInputColumnContainer, PivotRowContainer, PivotColumnContainer, ChartBuilderFormContainer, CheckboxComponent, defaultQuery, destinationDashboard, destinationSection, onChangeQuery, onChangeData, onChangeColumns, onChangeFields, onDiscardChanges, onSaveChanges, onCloseChartBuilder, isChartBuilderEnabled, isAdminEnabled, chartBuilderOptions, chartBuilderTitle, runQueryOnMount, onAddToDashboardComplete, onSubmitCreateReport, onSubmitEditReport, onSaveQueryComplete, addToDashboardButtonLabel, report, reportId, organizationName, isChartBuilderHorizontalView, containerStyle, className, onClickChartElement, onRequestAddVirtualTable, }: SQLEditorProps): react_jsx_runtime.JSX.Element;
|
|
2371
|
+
declare function SQLEditor({ ButtonComponent, SecondaryButtonComponent, DeleteButtonComponent, TextInputComponent, SelectComponent, TableComponent, isNewQueryEnabled, LoadingComponent, ModalComponent, PopoverComponent, CardComponent, LabelComponent, HeaderComponent, SubHeaderComponent, TextComponent, ErrorMessageComponent, ChartBuilderInputRowContainer, ChartBuilderInputColumnContainer, PivotRowContainer, PivotColumnContainer, ChartBuilderFormContainer, CheckboxComponent, defaultQuery, defaultDisplayName, destinationDashboard, destinationSection, onChangeQuery, onChangeData, onChangeColumns, onChangeFields, onDiscardChanges, onSaveChanges, onCloseChartBuilder, onOpenReportBuilder, isChartBuilderEnabled, isAdminEnabled, chartBuilderOptions, chartBuilderTitle, runQueryOnMount, onAddToDashboardComplete, onSubmitCreateReport, onSubmitEditReport, onSaveQueryComplete, onOpenLinkedReport, addToDashboardButtonLabel, report, reportId, existingVirtualQuery, initialShared, organizationName, isChartBuilderHorizontalView, containerStyle, className, onClickChartElement, onRequestAddVirtualTable, }: SQLEditorProps): react_jsx_runtime.JSX.Element;
|
|
2164
2372
|
declare const SchemaListComponent: ({ schema, theme, loading, LoadingComponent, width, onClick, style, onRequestAddVirtualTable, ButtonComponent, }: {
|
|
2165
2373
|
schema: any;
|
|
2166
2374
|
theme: any;
|
|
@@ -2176,6 +2384,23 @@ declare const SchemaListComponent: ({ schema, theme, loading, LoadingComponent,
|
|
|
2176
2384
|
}) => React$1.JSX.Element;
|
|
2177
2385
|
}) => react_jsx_runtime.JSX.Element;
|
|
2178
2386
|
|
|
2387
|
+
type SavedQueriesData = {
|
|
2388
|
+
queries: VirtualQuery[];
|
|
2389
|
+
isSavedQueriesLoading: boolean;
|
|
2390
|
+
};
|
|
2391
|
+
type CustomField = {
|
|
2392
|
+
viewName: string;
|
|
2393
|
+
refTable: string;
|
|
2394
|
+
field: string;
|
|
2395
|
+
refColumn?: string;
|
|
2396
|
+
type?: string;
|
|
2397
|
+
refField?: string;
|
|
2398
|
+
};
|
|
2399
|
+
|
|
2400
|
+
declare const AdditionalSchemaTablesContext: React$1.Context<[Table$1[], (value: React$1.SetStateAction<Table$1[]>) => void]>;
|
|
2401
|
+
declare const SavedQueriesContext: React$1.Context<[SavedQueriesData, (value: React$1.SetStateAction<SavedQueriesData>) => void]>;
|
|
2402
|
+
declare const ThemeContext: React$1.Context<[QuillTheme | null, (value: React$1.SetStateAction<QuillTheme | null>) => void]>;
|
|
2403
|
+
|
|
2179
2404
|
/**
|
|
2180
2405
|
* Props for the Quill ReportBuilder component.
|
|
2181
2406
|
*/
|
|
@@ -2770,30 +2995,6 @@ type ChartSortOption = {
|
|
|
2770
2995
|
value: string;
|
|
2771
2996
|
};
|
|
2772
2997
|
|
|
2773
|
-
type QueryBuilderCombinator = 'and' | 'or';
|
|
2774
|
-
type QueryBuilderRule = {
|
|
2775
|
-
field: string;
|
|
2776
|
-
operator: string;
|
|
2777
|
-
value: unknown;
|
|
2778
|
-
};
|
|
2779
|
-
type QueryBuilderRuleGroupEntry = QueryBuilderRule | QueryBuilderRuleGroup | QueryBuilderCombinator;
|
|
2780
|
-
type QueryBuilderRuleGroup = {
|
|
2781
|
-
combinator?: QueryBuilderCombinator;
|
|
2782
|
-
rules: QueryBuilderRuleGroupEntry[];
|
|
2783
|
-
};
|
|
2784
|
-
type QueryBuilderFieldType = 'string' | 'number' | 'date' | 'boolean' | 'null';
|
|
2785
|
-
type QueryBuilderOperatorOption = {
|
|
2786
|
-
name: string;
|
|
2787
|
-
value: string;
|
|
2788
|
-
label: string;
|
|
2789
|
-
arity?: 'unary' | 'binary' | number;
|
|
2790
|
-
};
|
|
2791
|
-
/**
|
|
2792
|
-
* Expand UI `inBucket` leaf rules to `between` for react-querybuilder editors.
|
|
2793
|
-
* Custom UIs keep `inBucket` on `useReport().filters`; the draft boundary uses this.
|
|
2794
|
-
*/
|
|
2795
|
-
declare const queryBuilderFiltersForEditor: (group: QueryBuilderRuleGroup) => QueryBuilderRuleGroup;
|
|
2796
|
-
|
|
2797
2998
|
/**
|
|
2798
2999
|
* Pagination types and pure helpers for `useReport`, mirroring the
|
|
2799
3000
|
* TanStack Table v8 pagination API (`@tanstack/table-core` RowPagination)
|
|
@@ -3137,7 +3338,14 @@ interface UseReportOptions {
|
|
|
3137
3338
|
* before navigation or feedback. Resolves to `undefined` when persist is skipped
|
|
3138
3339
|
* (e.g. missing client, dashboard name, or report state).
|
|
3139
3340
|
*/
|
|
3140
|
-
type
|
|
3341
|
+
type UseReportSaveOverrides = {
|
|
3342
|
+
name?: string;
|
|
3343
|
+
section?: string;
|
|
3344
|
+
filterMap?: QuillReportInternal['filterMap'];
|
|
3345
|
+
dateField?: QuillReportInternal['dateField'];
|
|
3346
|
+
reportFlags?: QuillReportInternal['flags'] | null;
|
|
3347
|
+
};
|
|
3348
|
+
type UseReportSaveChangesFn = (overrides?: UseReportSaveOverrides) => Promise<unknown>;
|
|
3141
3349
|
/**
|
|
3142
3350
|
* @param reportIdArg When omitted, the hook can bootstrap a report via `saveReport`
|
|
3143
3351
|
* (`create-report`) on the first `setReport({ datasources })`, after schema is available.
|
|
@@ -3201,6 +3409,7 @@ declare function useReport(reportIdArg?: string, options?: UseReportOptions): {
|
|
|
3201
3409
|
};
|
|
3202
3410
|
rowCount: number;
|
|
3203
3411
|
queryString: string;
|
|
3412
|
+
virtualQueries?: string[];
|
|
3204
3413
|
filterMap?: {
|
|
3205
3414
|
[key: string]: {
|
|
3206
3415
|
table: string;
|
|
@@ -3229,6 +3438,11 @@ declare function useReport(reportIdArg?: string, options?: UseReportOptions): {
|
|
|
3229
3438
|
table: UseFormTable;
|
|
3230
3439
|
tableLoading: boolean;
|
|
3231
3440
|
loading: boolean;
|
|
3441
|
+
/**
|
|
3442
|
+
* Initial report-task / load execution error. Preserved after schema rebuild
|
|
3443
|
+
* recovery so Report Builder can show why state was reset.
|
|
3444
|
+
*/
|
|
3445
|
+
error: string;
|
|
3232
3446
|
/** Report title: form override, then `sourceReport.name`, else `report-name` task. */
|
|
3233
3447
|
name: string;
|
|
3234
3448
|
/**
|
|
@@ -3490,6 +3704,11 @@ type UseDashboardReload = (overrideDashboardName?: string, fetchFromServer?: boo
|
|
|
3490
3704
|
}, options?: {
|
|
3491
3705
|
preserveExistingDateFilter?: boolean;
|
|
3492
3706
|
}) => Promise<void>;
|
|
3707
|
+
/** Read cached dashboard configuration without loading reports or filter values. */
|
|
3708
|
+
declare const useDashboardConfigInternal: (dashboardName: string | null) => {
|
|
3709
|
+
data: DashboardConfig | null;
|
|
3710
|
+
isLoading: boolean;
|
|
3711
|
+
};
|
|
3493
3712
|
declare const useDashboardInternal: (dashboardName: string | null, customFilters?: InternalFilter[]) => {
|
|
3494
3713
|
data: DashboardConfig | null;
|
|
3495
3714
|
dashboardFilters: InternalDashboardFilter[] | null;
|
|
@@ -3870,15 +4089,6 @@ declare const useAskQuill: (dashboardName: string) => {
|
|
|
3870
4089
|
onChangeFilterTree: (filterTree: FilterTreeNode) => void;
|
|
3871
4090
|
};
|
|
3872
4091
|
|
|
3873
|
-
type CustomField = {
|
|
3874
|
-
viewName: string;
|
|
3875
|
-
refTable: string;
|
|
3876
|
-
field: string;
|
|
3877
|
-
refColumn?: string;
|
|
3878
|
-
type?: string;
|
|
3879
|
-
refField?: string;
|
|
3880
|
-
};
|
|
3881
|
-
|
|
3882
4092
|
declare const useVirtualTables: () => {
|
|
3883
4093
|
data: Table$1[];
|
|
3884
4094
|
isLoading: boolean;
|
|
@@ -3908,74 +4118,6 @@ declare const useVirtualTables: () => {
|
|
|
3908
4118
|
}>;
|
|
3909
4119
|
};
|
|
3910
4120
|
|
|
3911
|
-
type ClientFeatures = {
|
|
3912
|
-
cloudCache?: boolean;
|
|
3913
|
-
[key: string]: boolean | undefined;
|
|
3914
|
-
};
|
|
3915
|
-
type QuillProviderClient = {
|
|
3916
|
-
name: string;
|
|
3917
|
-
id?: string;
|
|
3918
|
-
clientId?: string;
|
|
3919
|
-
queryEndpoint: string;
|
|
3920
|
-
streamEndpoint?: string;
|
|
3921
|
-
queryHeaders?: HeadersInit;
|
|
3922
|
-
withCredentials: boolean;
|
|
3923
|
-
databaseType?: string;
|
|
3924
|
-
features?: ClientFeatures;
|
|
3925
|
-
featureFlags?: {
|
|
3926
|
-
[key: string]: boolean;
|
|
3927
|
-
};
|
|
3928
|
-
/** @deprecated Use clerkOrgId instead */
|
|
3929
|
-
domainName?: string;
|
|
3930
|
-
clerkOrgId: string;
|
|
3931
|
-
allTenantTypes?: QuillTenant[];
|
|
3932
|
-
defaultDashboard?: {
|
|
3933
|
-
name: string;
|
|
3934
|
-
owner: string;
|
|
3935
|
-
};
|
|
3936
|
-
schemaNames?: string[];
|
|
3937
|
-
};
|
|
3938
|
-
type QuillTenant = {
|
|
3939
|
-
name: string;
|
|
3940
|
-
tenantField: string;
|
|
3941
|
-
query?: string;
|
|
3942
|
-
mappings?: {
|
|
3943
|
-
[key: string]: {
|
|
3944
|
-
query: string;
|
|
3945
|
-
};
|
|
3946
|
-
};
|
|
3947
|
-
flags?: string[];
|
|
3948
|
-
tenantIds?: {
|
|
3949
|
-
id: string | number;
|
|
3950
|
-
flag: string;
|
|
3951
|
-
label: string;
|
|
3952
|
-
}[];
|
|
3953
|
-
scope: 'row' | 'schema' | 'database';
|
|
3954
|
-
defaultId?: string | number;
|
|
3955
|
-
fieldType?: 'string' | 'number' | 'none';
|
|
3956
|
-
};
|
|
3957
|
-
|
|
3958
|
-
interface QuillFetchOptions {
|
|
3959
|
-
client: Pick<QuillProviderClient, 'id' | 'clientId' | 'queryEndpoint' | 'queryHeaders' | 'withCredentials'>;
|
|
3960
|
-
task: string;
|
|
3961
|
-
method?: string;
|
|
3962
|
-
metadata: any;
|
|
3963
|
-
abortSignal?: AbortSignal;
|
|
3964
|
-
credentials?: RequestCredentials;
|
|
3965
|
-
urlParameters?: string;
|
|
3966
|
-
adminMode?: boolean;
|
|
3967
|
-
/** Internal opt-in for exact initial-request sharing across mounted hooks. */
|
|
3968
|
-
shareRequest?: boolean;
|
|
3969
|
-
getToken: () => Promise<string>;
|
|
3970
|
-
}
|
|
3971
|
-
interface QuillResults {
|
|
3972
|
-
data?: any;
|
|
3973
|
-
queries?: any;
|
|
3974
|
-
status?: string;
|
|
3975
|
-
error?: string;
|
|
3976
|
-
message?: string;
|
|
3977
|
-
}
|
|
3978
|
-
|
|
3979
4121
|
declare const quillFetch: ({ client, task, method, metadata, abortSignal, credentials, urlParameters, shareRequest, getToken, }: QuillFetchOptions) => Promise<QuillResults>;
|
|
3980
4122
|
|
|
3981
4123
|
declare const downloadCSV: (data: {
|
|
@@ -3984,8 +4126,6 @@ declare const downloadCSV: (data: {
|
|
|
3984
4126
|
name?: string;
|
|
3985
4127
|
}) => void;
|
|
3986
4128
|
|
|
3987
|
-
declare const ThemeContext: React$1.Context<[QuillTheme | null, (value: React$1.SetStateAction<QuillTheme | null>) => void]>;
|
|
3988
|
-
|
|
3989
4129
|
interface SidebarHeadingComponentProps {
|
|
3990
4130
|
label: string;
|
|
3991
4131
|
}
|
|
@@ -4508,4 +4648,4 @@ interface ReportTableProps {
|
|
|
4508
4648
|
}
|
|
4509
4649
|
declare const ReportTable: ({ reportBuilder, TableComponent, }: ReportTableProps) => react_jsx_runtime.JSX.Element;
|
|
4510
4650
|
|
|
4511
|
-
export { ALL_TENANTS, AddColumns, AddFilters, AddLimit, AddPivot, AddSort, 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 ReportXAxisValue, type ReportYAxisFieldValue, type ReportYAxisValue, SINGLE_TENANT, SQLEditor, type SQLEditorProps, SaveReport, 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, areQueryBuilderFilterDraftsDirty, countFilterRules, defaultFilterRuleValueForOperator, downloadCSV, quillFormat as format, isQueryBuilderDisplayGroup, isQueryBuilderDisplayRule, normalizeRelativeDateRules, prepareQueryBuilderFiltersForSet, queryBuilderFiltersForEditor, quillFetch, stripQueryBuilderTransientFields, tableColumnFormatFromUiSelection, useAllReports, useAskQuill, useChangelogRefresh, useDashboard, useDashboardInternal, useDashboardReport, useDashboardReports, useDashboards, useExport, useMemoizedRows, useQuill, useReport, useReportBuilder, useReportQueryBuilder, useReports, useTenants, useVirtualTables };
|
|
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 };
|