@quillsql/react 2.16.80 → 2.16.81
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 +2500 -3265
- package/dist/index.d.cts +222 -116
- package/dist/index.d.ts +222 -116
- package/dist/index.js +2558 -3351
- 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;
|
|
@@ -692,12 +694,6 @@ interface UniqueValuesByColumn {
|
|
|
692
694
|
[column: string]: string[];
|
|
693
695
|
}
|
|
694
696
|
|
|
695
|
-
/** Display-only ordering applied after query and pivot processing. */
|
|
696
|
-
type ChartSort = {
|
|
697
|
-
target: 'rows' | 'series';
|
|
698
|
-
field: string;
|
|
699
|
-
direction: 'ASC' | 'DESC';
|
|
700
|
-
};
|
|
701
697
|
/**
|
|
702
698
|
* ## QuillReport
|
|
703
699
|
* Represents an individual item on a dashboard.
|
|
@@ -726,8 +722,6 @@ interface QuillReport {
|
|
|
726
722
|
chartType: string;
|
|
727
723
|
/** Whether to show a legend for this chart. */
|
|
728
724
|
showLegend?: boolean;
|
|
729
|
-
/** Display-only ordering applied after query and pivot processing. */
|
|
730
|
-
chartSort?: ChartSort;
|
|
731
725
|
/** The table and field this report uses for date filtering, if any. */
|
|
732
726
|
dateField?: {
|
|
733
727
|
table: string;
|
|
@@ -780,6 +774,8 @@ interface QuillReport {
|
|
|
780
774
|
};
|
|
781
775
|
rowCount: number;
|
|
782
776
|
queryString: string;
|
|
777
|
+
/** Saved virtual queries used as this report's datasources. */
|
|
778
|
+
virtualQueries?: string[];
|
|
783
779
|
filterMap?: {
|
|
784
780
|
[key: string]: {
|
|
785
781
|
table: string;
|
|
@@ -1859,6 +1855,161 @@ interface TableProps {
|
|
|
1859
1855
|
*/
|
|
1860
1856
|
declare const Table: ({ TableComponent, ...props }: TableProps) => react_jsx_runtime.JSX.Element | null;
|
|
1861
1857
|
|
|
1858
|
+
type ClientFeatures = {
|
|
1859
|
+
cloudCache?: boolean;
|
|
1860
|
+
[key: string]: boolean | undefined;
|
|
1861
|
+
};
|
|
1862
|
+
type QuillProviderClient = {
|
|
1863
|
+
name: string;
|
|
1864
|
+
id?: string;
|
|
1865
|
+
clientId?: string;
|
|
1866
|
+
queryEndpoint: string;
|
|
1867
|
+
streamEndpoint?: string;
|
|
1868
|
+
queryHeaders?: HeadersInit;
|
|
1869
|
+
withCredentials: boolean;
|
|
1870
|
+
databaseType?: string;
|
|
1871
|
+
features?: ClientFeatures;
|
|
1872
|
+
featureFlags?: {
|
|
1873
|
+
[key: string]: boolean;
|
|
1874
|
+
};
|
|
1875
|
+
/** @deprecated Use clerkOrgId instead */
|
|
1876
|
+
domainName?: string;
|
|
1877
|
+
clerkOrgId: string;
|
|
1878
|
+
allTenantTypes?: QuillTenant[];
|
|
1879
|
+
defaultDashboard?: {
|
|
1880
|
+
name: string;
|
|
1881
|
+
owner: string;
|
|
1882
|
+
};
|
|
1883
|
+
schemaNames?: string[];
|
|
1884
|
+
};
|
|
1885
|
+
type QuillTenant = {
|
|
1886
|
+
name: string;
|
|
1887
|
+
tenantField: string;
|
|
1888
|
+
query?: string;
|
|
1889
|
+
mappings?: {
|
|
1890
|
+
[key: string]: {
|
|
1891
|
+
query: string;
|
|
1892
|
+
};
|
|
1893
|
+
};
|
|
1894
|
+
flags?: string[];
|
|
1895
|
+
tenantIds?: {
|
|
1896
|
+
id: string | number;
|
|
1897
|
+
flag: string;
|
|
1898
|
+
label: string;
|
|
1899
|
+
}[];
|
|
1900
|
+
scope: 'row' | 'schema' | 'database';
|
|
1901
|
+
defaultId?: string | number;
|
|
1902
|
+
fieldType?: 'string' | 'number' | 'none';
|
|
1903
|
+
};
|
|
1904
|
+
|
|
1905
|
+
interface QuillFetchOptions {
|
|
1906
|
+
client: Pick<QuillProviderClient, 'id' | 'clientId' | 'queryEndpoint' | 'queryHeaders' | 'withCredentials'>;
|
|
1907
|
+
task: string;
|
|
1908
|
+
method?: string;
|
|
1909
|
+
metadata: any;
|
|
1910
|
+
abortSignal?: AbortSignal;
|
|
1911
|
+
credentials?: RequestCredentials;
|
|
1912
|
+
urlParameters?: string;
|
|
1913
|
+
adminMode?: boolean;
|
|
1914
|
+
getToken: () => Promise<string>;
|
|
1915
|
+
}
|
|
1916
|
+
interface QuillResults {
|
|
1917
|
+
data?: any;
|
|
1918
|
+
queries?: any;
|
|
1919
|
+
status?: string;
|
|
1920
|
+
error?: string;
|
|
1921
|
+
message?: string;
|
|
1922
|
+
}
|
|
1923
|
+
|
|
1924
|
+
type VirtualQueryColumn = {
|
|
1925
|
+
name: string;
|
|
1926
|
+
displayName?: string;
|
|
1927
|
+
fieldType: string;
|
|
1928
|
+
isVisible?: boolean;
|
|
1929
|
+
_id?: string;
|
|
1930
|
+
};
|
|
1931
|
+
type VirtualQuery = {
|
|
1932
|
+
id: string;
|
|
1933
|
+
name: string;
|
|
1934
|
+
displayName?: string;
|
|
1935
|
+
queryString: string;
|
|
1936
|
+
columns: VirtualQueryColumn[];
|
|
1937
|
+
clientId: string;
|
|
1938
|
+
shared: boolean;
|
|
1939
|
+
};
|
|
1940
|
+
type SavedQuerySelectOption = {
|
|
1941
|
+
id: string;
|
|
1942
|
+
label: string;
|
|
1943
|
+
};
|
|
1944
|
+
type ReportVirtualQueryReference = {
|
|
1945
|
+
id: string;
|
|
1946
|
+
name: string;
|
|
1947
|
+
dashboardName?: string;
|
|
1948
|
+
};
|
|
1949
|
+
type VirtualQueryFetchFn = (options: Omit<QuillFetchOptions, 'getToken'>) => Promise<QuillResults>;
|
|
1950
|
+
declare function getVirtualQueryLabel(query: VirtualQuery): string;
|
|
1951
|
+
/** Minimal column shape for persist — only `field` / `fieldType` are read. */
|
|
1952
|
+
type SaveVirtualQueryColumnInput = {
|
|
1953
|
+
field?: string;
|
|
1954
|
+
fieldType?: string;
|
|
1955
|
+
};
|
|
1956
|
+
declare function fetchVirtualQueries(args: {
|
|
1957
|
+
quillFetchWithToken: VirtualQueryFetchFn;
|
|
1958
|
+
queryEndpoint: string;
|
|
1959
|
+
clientId: string;
|
|
1960
|
+
queryHeaders?: HeadersInit;
|
|
1961
|
+
withCredentials?: boolean;
|
|
1962
|
+
}): Promise<{
|
|
1963
|
+
queries: VirtualQuery[];
|
|
1964
|
+
error?: string;
|
|
1965
|
+
}>;
|
|
1966
|
+
declare function saveVirtualQuery(args: {
|
|
1967
|
+
quillFetchWithToken: VirtualQueryFetchFn;
|
|
1968
|
+
client: QuillFetchOptions['client'];
|
|
1969
|
+
queryString: string;
|
|
1970
|
+
columns: SaveVirtualQueryColumnInput[];
|
|
1971
|
+
existingVirtualQuery?: VirtualQuery | null;
|
|
1972
|
+
displayName: string;
|
|
1973
|
+
shared: boolean;
|
|
1974
|
+
adminMode?: boolean;
|
|
1975
|
+
}): Promise<{
|
|
1976
|
+
virtualQuery?: VirtualQuery;
|
|
1977
|
+
error?: string;
|
|
1978
|
+
}>;
|
|
1979
|
+
declare function deleteVirtualQuery(args: {
|
|
1980
|
+
quillFetchWithToken: VirtualQueryFetchFn;
|
|
1981
|
+
queryEndpoint: string;
|
|
1982
|
+
clientId: string;
|
|
1983
|
+
id: string;
|
|
1984
|
+
queryHeaders?: HeadersInit;
|
|
1985
|
+
withCredentials?: boolean;
|
|
1986
|
+
}): Promise<{
|
|
1987
|
+
success: boolean;
|
|
1988
|
+
error?: string;
|
|
1989
|
+
}>;
|
|
1990
|
+
declare function virtualQueryToTable(query: VirtualQuery): Table$1;
|
|
1991
|
+
declare function resolveSavedQueryIdFromBaseTables(tableNames: string[], catalog: VirtualQuery[]): string | undefined;
|
|
1992
|
+
declare function buildSavedQuerySelectOptions(queries: VirtualQuery[], options?: {
|
|
1993
|
+
sharedOnly?: boolean;
|
|
1994
|
+
alwaysIncludeId?: string;
|
|
1995
|
+
}): SavedQuerySelectOption[];
|
|
1996
|
+
declare function buildReportVirtualQueries(savedQueryId?: string | null): string[];
|
|
1997
|
+
declare function upsertVirtualQueryTableInSchema(tables: Table$1[], query: VirtualQuery): Table$1[];
|
|
1998
|
+
declare function upsertVirtualQueryInCatalog(queries: VirtualQuery[], query: VirtualQuery): VirtualQuery[];
|
|
1999
|
+
declare function findLinkedReportsUsingVirtualQuery(reports: Iterable<{
|
|
2000
|
+
id?: string;
|
|
2001
|
+
name?: string;
|
|
2002
|
+
dashboardName?: string;
|
|
2003
|
+
virtualQueries?: string[] | null;
|
|
2004
|
+
}>, virtualQueryId: string): ReportVirtualQueryReference[];
|
|
2005
|
+
declare function findReportsBlockingVirtualQueryDeletion(reports: Iterable<{
|
|
2006
|
+
id?: string;
|
|
2007
|
+
name?: string;
|
|
2008
|
+
dashboardName?: string;
|
|
2009
|
+
virtualQueries?: string[] | null;
|
|
2010
|
+
}>, virtualQueryId: string): ReportVirtualQueryReference[];
|
|
2011
|
+
declare function formatReportsBlockingVirtualQueryDeletion(reports: ReportVirtualQueryReference[]): string;
|
|
2012
|
+
|
|
1862
2013
|
/**
|
|
1863
2014
|
* Props for the Quill SQLEditor component.
|
|
1864
2015
|
*/
|
|
@@ -1901,6 +2052,8 @@ interface SQLEditorProps {
|
|
|
1901
2052
|
}[];
|
|
1902
2053
|
onChange: (event: React$1.ChangeEvent<HTMLSelectElement>) => void;
|
|
1903
2054
|
width: number;
|
|
2055
|
+
disabled?: boolean;
|
|
2056
|
+
hideEmptyOption?: boolean;
|
|
1904
2057
|
}) => React$1.JSX.Element;
|
|
1905
2058
|
/**
|
|
1906
2059
|
* A table component to show the results of the SQL query.
|
|
@@ -2044,7 +2197,9 @@ interface SQLEditorProps {
|
|
|
2044
2197
|
onSubmitCreateReport?: (report: QuillReport) => void;
|
|
2045
2198
|
/** A callback function that will trigger when a chart is edited */
|
|
2046
2199
|
onSubmitEditReport?: (report: QuillReport) => void;
|
|
2047
|
-
onSaveQueryComplete?: (
|
|
2200
|
+
onSaveQueryComplete?: (virtualQuery: VirtualQuery) => void;
|
|
2201
|
+
/** Opens a report that uses the active saved query. */
|
|
2202
|
+
onOpenLinkedReport?: (report: ReportVirtualQueryReference) => void;
|
|
2048
2203
|
/** A callback function triggered when a chart element is clicked */
|
|
2049
2204
|
onClickChartElement?: (event: any) => void;
|
|
2050
2205
|
/** A callback function triggered when a user wants to add a virtual table */
|
|
@@ -2061,6 +2216,10 @@ interface SQLEditorProps {
|
|
|
2061
2216
|
* Whether SQL queries will be able to open a report creation flow.
|
|
2062
2217
|
*/
|
|
2063
2218
|
isChartBuilderEnabled?: boolean;
|
|
2219
|
+
/** Opens an external report builder instead of the legacy chart builder. */
|
|
2220
|
+
onOpenReportBuilder?: (input: {
|
|
2221
|
+
virtualQueryId?: string;
|
|
2222
|
+
}) => void;
|
|
2064
2223
|
/**
|
|
2065
2224
|
* Whether the "new query" button is enabled.
|
|
2066
2225
|
*/
|
|
@@ -2094,10 +2253,21 @@ interface SQLEditorProps {
|
|
|
2094
2253
|
* A report id that the SQL Editor will query from and modify.
|
|
2095
2254
|
*/
|
|
2096
2255
|
reportId?: string;
|
|
2256
|
+
/** The saved query being edited, if this editor was opened from one. */
|
|
2257
|
+
existingVirtualQuery?: VirtualQuery | null;
|
|
2258
|
+
/**
|
|
2259
|
+
* Default Query Type when creating a new query (no existingVirtualQuery).
|
|
2260
|
+
* `true` = Shared, `false` = Report Query. Defaults to Shared.
|
|
2261
|
+
*/
|
|
2262
|
+
initialShared?: boolean;
|
|
2097
2263
|
/**
|
|
2098
2264
|
* The default query to use as a placeholder.
|
|
2099
2265
|
*/
|
|
2100
2266
|
defaultQuery?: string;
|
|
2267
|
+
/**
|
|
2268
|
+
* Default display name when creating a new saved query (no existingVirtualQuery).
|
|
2269
|
+
*/
|
|
2270
|
+
defaultDisplayName?: string;
|
|
2101
2271
|
/**
|
|
2102
2272
|
* The default dashboard to add the query to.
|
|
2103
2273
|
*/
|
|
@@ -2117,7 +2287,7 @@ interface SQLEditorProps {
|
|
|
2117
2287
|
/**
|
|
2118
2288
|
* The label of the button to add the current query to a dashboard.
|
|
2119
2289
|
*
|
|
2120
|
-
* @default "
|
|
2290
|
+
* @default "Link to report"
|
|
2121
2291
|
*/
|
|
2122
2292
|
addToDashboardButtonLabel?: string;
|
|
2123
2293
|
/**
|
|
@@ -2160,7 +2330,7 @@ interface SQLEditorProps {
|
|
|
2160
2330
|
* ### SQLEditor API
|
|
2161
2331
|
* @see https://docs.quillsql.com/components/sql-editor
|
|
2162
2332
|
*/
|
|
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;
|
|
2333
|
+
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
2334
|
declare const SchemaListComponent: ({ schema, theme, loading, LoadingComponent, width, onClick, style, onRequestAddVirtualTable, ButtonComponent, }: {
|
|
2165
2335
|
schema: any;
|
|
2166
2336
|
theme: any;
|
|
@@ -2176,6 +2346,23 @@ declare const SchemaListComponent: ({ schema, theme, loading, LoadingComponent,
|
|
|
2176
2346
|
}) => React$1.JSX.Element;
|
|
2177
2347
|
}) => react_jsx_runtime.JSX.Element;
|
|
2178
2348
|
|
|
2349
|
+
type SavedQueriesData = {
|
|
2350
|
+
queries: VirtualQuery[];
|
|
2351
|
+
isSavedQueriesLoading: boolean;
|
|
2352
|
+
};
|
|
2353
|
+
type CustomField = {
|
|
2354
|
+
viewName: string;
|
|
2355
|
+
refTable: string;
|
|
2356
|
+
field: string;
|
|
2357
|
+
refColumn?: string;
|
|
2358
|
+
type?: string;
|
|
2359
|
+
refField?: string;
|
|
2360
|
+
};
|
|
2361
|
+
|
|
2362
|
+
declare const AdditionalSchemaTablesContext: React$1.Context<[Table$1[], (value: React$1.SetStateAction<Table$1[]>) => void]>;
|
|
2363
|
+
declare const SavedQueriesContext: React$1.Context<[SavedQueriesData, (value: React$1.SetStateAction<SavedQueriesData>) => void]>;
|
|
2364
|
+
declare const ThemeContext: React$1.Context<[QuillTheme | null, (value: React$1.SetStateAction<QuillTheme | null>) => void]>;
|
|
2365
|
+
|
|
2179
2366
|
/**
|
|
2180
2367
|
* Props for the Quill ReportBuilder component.
|
|
2181
2368
|
*/
|
|
@@ -2765,11 +2952,6 @@ interface ChatProps {
|
|
|
2765
2952
|
type ChatModelId = 'gemini-2-flash' | 'gemini-2.5-flash' | 'gemini-3-flash-preview' | 'gpt-5.1' | 'opus-4.5' | 'kimi-k2.5';
|
|
2766
2953
|
declare function Chat({ selectedDashboard, ChartViewComponent, agentEndpoint, suggestions, }: ChatProps): react_jsx_runtime.JSX.Element;
|
|
2767
2954
|
|
|
2768
|
-
type ChartSortOption = {
|
|
2769
|
-
label: string;
|
|
2770
|
-
value: string;
|
|
2771
|
-
};
|
|
2772
|
-
|
|
2773
2955
|
type QueryBuilderCombinator = 'and' | 'or';
|
|
2774
2956
|
type QueryBuilderRule = {
|
|
2775
2957
|
field: string;
|
|
@@ -2808,8 +2990,8 @@ interface PaginationState {
|
|
|
2808
2990
|
type Updater<T> = T | ((old: T) => T);
|
|
2809
2991
|
type OnChangeFn<T> = (updaterOrValue: Updater<T>) => void;
|
|
2810
2992
|
declare const DEFAULT_PAGE_SIZE = 10;
|
|
2811
|
-
/**
|
|
2812
|
-
declare const DEFAULT_USE_REPORT_ROWS_PER_REQUEST
|
|
2993
|
+
/** Base row window fetched before per-page server requests kick in. */
|
|
2994
|
+
declare const DEFAULT_USE_REPORT_ROWS_PER_REQUEST: number;
|
|
2813
2995
|
|
|
2814
2996
|
type SelectOption = {
|
|
2815
2997
|
label: string;
|
|
@@ -3061,11 +3243,6 @@ interface SetReportBuilderInput {
|
|
|
3061
3243
|
chartType?: ChartType;
|
|
3062
3244
|
/** When set, updates chart legend visibility (same source as `showLegend` from `useReport`). */
|
|
3063
3245
|
showLegend?: boolean;
|
|
3064
|
-
/**
|
|
3065
|
-
* Display-only ordering applied after query and pivot processing.
|
|
3066
|
-
* Use a value from `chartSortOptions`; pass an empty string to clear.
|
|
3067
|
-
*/
|
|
3068
|
-
chartSort?: string;
|
|
3069
3246
|
/** Update the X-axis value returned by `useReport`. */
|
|
3070
3247
|
xAxis?: SetReportChartAxesInput['xAxis'];
|
|
3071
3248
|
/** Replace the Y-axis value returned by `useReport`. */
|
|
@@ -3137,7 +3314,14 @@ interface UseReportOptions {
|
|
|
3137
3314
|
* before navigation or feedback. Resolves to `undefined` when persist is skipped
|
|
3138
3315
|
* (e.g. missing client, dashboard name, or report state).
|
|
3139
3316
|
*/
|
|
3140
|
-
type
|
|
3317
|
+
type UseReportSaveOverrides = {
|
|
3318
|
+
name?: string;
|
|
3319
|
+
section?: string;
|
|
3320
|
+
filterMap?: QuillReportInternal['filterMap'];
|
|
3321
|
+
dateField?: QuillReportInternal['dateField'];
|
|
3322
|
+
reportFlags?: QuillReportInternal['flags'] | null;
|
|
3323
|
+
};
|
|
3324
|
+
type UseReportSaveChangesFn = (overrides?: UseReportSaveOverrides) => Promise<unknown>;
|
|
3141
3325
|
/**
|
|
3142
3326
|
* @param reportIdArg When omitted, the hook can bootstrap a report via `saveReport`
|
|
3143
3327
|
* (`create-report`) on the first `setReport({ datasources })`, after schema is available.
|
|
@@ -3182,7 +3366,6 @@ declare function useReport(reportIdArg?: string, options?: UseReportOptions): {
|
|
|
3182
3366
|
}[];
|
|
3183
3367
|
chartType: string;
|
|
3184
3368
|
showLegend?: boolean;
|
|
3185
|
-
chartSort?: ChartSort;
|
|
3186
3369
|
dateField?: {
|
|
3187
3370
|
table: string;
|
|
3188
3371
|
field: string;
|
|
@@ -3201,6 +3384,7 @@ declare function useReport(reportIdArg?: string, options?: UseReportOptions): {
|
|
|
3201
3384
|
};
|
|
3202
3385
|
rowCount: number;
|
|
3203
3386
|
queryString: string;
|
|
3387
|
+
virtualQueries?: string[];
|
|
3204
3388
|
filterMap?: {
|
|
3205
3389
|
[key: string]: {
|
|
3206
3390
|
table: string;
|
|
@@ -3229,6 +3413,11 @@ declare function useReport(reportIdArg?: string, options?: UseReportOptions): {
|
|
|
3229
3413
|
table: UseFormTable;
|
|
3230
3414
|
tableLoading: boolean;
|
|
3231
3415
|
loading: boolean;
|
|
3416
|
+
/**
|
|
3417
|
+
* Initial report-task / load execution error. Preserved after schema rebuild
|
|
3418
|
+
* recovery so Report Builder can show why state was reset.
|
|
3419
|
+
*/
|
|
3420
|
+
error: string;
|
|
3232
3421
|
/** Report title: form override, then `sourceReport.name`, else `report-name` task. */
|
|
3233
3422
|
name: string;
|
|
3234
3423
|
/**
|
|
@@ -3257,10 +3446,7 @@ declare function useReport(reportIdArg?: string, options?: UseReportOptions): {
|
|
|
3257
3446
|
label: string;
|
|
3258
3447
|
value: string;
|
|
3259
3448
|
}[];
|
|
3260
|
-
|
|
3261
|
-
chartSort: string;
|
|
3262
|
-
chartSortOptions: ChartSortOption[];
|
|
3263
|
-
chartType: "table" | "column" | "metric" | "gauge" | "stacked" | "stacked bar" | "line" | "radar" | "bar" | "pie" | "US map" | "World map";
|
|
3449
|
+
chartType: "table" | "column" | "metric" | "gauge" | "stacked" | "stacked bar" | "line" | "bar" | "pie" | "radar" | "US map" | "World map";
|
|
3264
3450
|
chartTypeOptions: ChartTypeOption[];
|
|
3265
3451
|
/** Selected tabular columns in display order. */
|
|
3266
3452
|
columns: ReportColumnValue[];
|
|
@@ -3490,6 +3676,11 @@ type UseDashboardReload = (overrideDashboardName?: string, fetchFromServer?: boo
|
|
|
3490
3676
|
}, options?: {
|
|
3491
3677
|
preserveExistingDateFilter?: boolean;
|
|
3492
3678
|
}) => Promise<void>;
|
|
3679
|
+
/** Read cached dashboard configuration without loading reports or filter values. */
|
|
3680
|
+
declare const useDashboardConfigInternal: (dashboardName: string | null) => {
|
|
3681
|
+
data: DashboardConfig | null;
|
|
3682
|
+
isLoading: boolean;
|
|
3683
|
+
};
|
|
3493
3684
|
declare const useDashboardInternal: (dashboardName: string | null, customFilters?: InternalFilter[]) => {
|
|
3494
3685
|
data: DashboardConfig | null;
|
|
3495
3686
|
dashboardFilters: InternalDashboardFilter[] | null;
|
|
@@ -3562,11 +3753,6 @@ declare const useDashboard: (dashboardName: string, config?: {
|
|
|
3562
3753
|
cacheEnabled?: boolean;
|
|
3563
3754
|
cacheType?: "memory" | "idb";
|
|
3564
3755
|
showCacheLogs?: boolean;
|
|
3565
|
-
cacheDateRange?: {
|
|
3566
|
-
startDate: Date;
|
|
3567
|
-
endDate: Date;
|
|
3568
|
-
};
|
|
3569
|
-
reportStaleTimeMs?: number;
|
|
3570
3756
|
}) => {
|
|
3571
3757
|
isLoading: boolean;
|
|
3572
3758
|
sections: Record<string, QuillReport[]> | null;
|
|
@@ -3586,7 +3772,6 @@ declare const useDashboard: (dashboardName: string, config?: {
|
|
|
3586
3772
|
} | Filter>) => void;
|
|
3587
3773
|
lastUpdated: number;
|
|
3588
3774
|
forceCacheRefresh: () => void;
|
|
3589
|
-
primeReportSource: (reportId: string) => Promise<void>;
|
|
3590
3775
|
reload: UseDashboardReload;
|
|
3591
3776
|
};
|
|
3592
3777
|
declare const useDashboardReport: (reportId: string, config?: {
|
|
@@ -3870,15 +4055,6 @@ declare const useAskQuill: (dashboardName: string) => {
|
|
|
3870
4055
|
onChangeFilterTree: (filterTree: FilterTreeNode) => void;
|
|
3871
4056
|
};
|
|
3872
4057
|
|
|
3873
|
-
type CustomField = {
|
|
3874
|
-
viewName: string;
|
|
3875
|
-
refTable: string;
|
|
3876
|
-
field: string;
|
|
3877
|
-
refColumn?: string;
|
|
3878
|
-
type?: string;
|
|
3879
|
-
refField?: string;
|
|
3880
|
-
};
|
|
3881
|
-
|
|
3882
4058
|
declare const useVirtualTables: () => {
|
|
3883
4059
|
data: Table$1[];
|
|
3884
4060
|
isLoading: boolean;
|
|
@@ -3908,75 +4084,7 @@ declare const useVirtualTables: () => {
|
|
|
3908
4084
|
}>;
|
|
3909
4085
|
};
|
|
3910
4086
|
|
|
3911
|
-
|
|
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
|
-
declare const quillFetch: ({ client, task, method, metadata, abortSignal, credentials, urlParameters, shareRequest, getToken, }: QuillFetchOptions) => Promise<QuillResults>;
|
|
4087
|
+
declare const quillFetch: ({ client, task, method, metadata, abortSignal, credentials, urlParameters, getToken, }: QuillFetchOptions) => Promise<QuillResults>;
|
|
3980
4088
|
|
|
3981
4089
|
declare const downloadCSV: (data: {
|
|
3982
4090
|
rows: any[];
|
|
@@ -3984,8 +4092,6 @@ declare const downloadCSV: (data: {
|
|
|
3984
4092
|
name?: string;
|
|
3985
4093
|
}) => void;
|
|
3986
4094
|
|
|
3987
|
-
declare const ThemeContext: React$1.Context<[QuillTheme | null, (value: React$1.SetStateAction<QuillTheme | null>) => void]>;
|
|
3988
|
-
|
|
3989
4095
|
interface SidebarHeadingComponentProps {
|
|
3990
4096
|
label: string;
|
|
3991
4097
|
}
|
|
@@ -4508,4 +4614,4 @@ interface ReportTableProps {
|
|
|
4508
4614
|
}
|
|
4509
4615
|
declare const ReportTable: ({ reportBuilder, TableComponent, }: ReportTableProps) => react_jsx_runtime.JSX.Element;
|
|
4510
4616
|
|
|
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
|
|
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 };
|