@quillsql/react 2.16.0 → 2.16.1

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.d.cts CHANGED
@@ -1751,8 +1751,13 @@ interface SQLEditorProps {
1751
1751
  onCloseChartBuilder?: () => void;
1752
1752
  /**
1753
1753
  * A callback that is fired when a report has been added to a dashboard.
1754
+ * @deprecated Use onSubmitCreateReport and onSubmitEditReport instead
1754
1755
  */
1755
1756
  onAddToDashboardComplete?: (report: QuillReport) => void;
1757
+ /** A callback function that will trigger when a new chart is saved */
1758
+ onSubmitCreateReport?: (report: QuillReport) => void;
1759
+ /** A callback function that will trigger when a chart is edited */
1760
+ onSubmitEditReport?: (report: QuillReport) => void;
1756
1761
  onSaveQueryComplete?: (report: QuillReport) => void;
1757
1762
  /** A callback function triggered when a chart element is clicked */
1758
1763
  onClickChartElement?: (event: any) => void;
@@ -1779,9 +1784,14 @@ interface SQLEditorProps {
1779
1784
  */
1780
1785
  isAdminEnabled?: boolean;
1781
1786
  /**
1782
- * Whether to show table format options.
1787
+ * Options for the chart builder modal.
1783
1788
  */
1784
- showTableFormatOptions?: boolean;
1789
+ chartBuilderOptions?: {
1790
+ /** Whether to show table format options. */
1791
+ showTableFormatOptions?: boolean;
1792
+ /** Whether to show dashboard filter fields. */
1793
+ showDashboardFilterFields?: boolean;
1794
+ };
1785
1795
  /**
1786
1796
  * Whether to show date field options.
1787
1797
  */
@@ -1794,6 +1804,10 @@ interface SQLEditorProps {
1794
1804
  * A dashboard item.
1795
1805
  */
1796
1806
  report?: QuillReport;
1807
+ /**
1808
+ * A report id that the SQL Editor will query from and modify.
1809
+ */
1810
+ reportId?: string;
1797
1811
  /**
1798
1812
  * The default query to use as a placeholder.
1799
1813
  */
@@ -1802,6 +1816,10 @@ interface SQLEditorProps {
1802
1816
  * The default dashboard to add the query to.
1803
1817
  */
1804
1818
  destinationDashboard: string;
1819
+ /**
1820
+ * The section of the dashboard to add items to.
1821
+ */
1822
+ destinationSection?: string;
1805
1823
  /**
1806
1824
  * The title of the ChartBuilder dialog.
1807
1825
  */
@@ -1856,7 +1874,7 @@ interface SQLEditorProps {
1856
1874
  * ### SQLEditor API
1857
1875
  * @see https://docs.quillsql.com/components/sql-editor
1858
1876
  */
1859
- 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, onChangeQuery, onChangeData, onChangeColumns, onChangeFields, onDiscardChanges, onSaveChanges, onCloseChartBuilder, isChartBuilderEnabled, isAdminEnabled, chartBuilderTitle, runQueryOnMount, onAddToDashboardComplete, onSaveQueryComplete, addToDashboardButtonLabel, report, organizationName, isChartBuilderHorizontalView, containerStyle, className, onClickChartElement, onRequestAddVirtualTable, }: SQLEditorProps): react_jsx_runtime.JSX.Element;
1877
+ 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;
1860
1878
  declare const SchemaListComponent: ({ schema, theme, loading, LoadingComponent, width, onClick, style, onRequestAddVirtualTable, ButtonComponent, }: {
1861
1879
  schema: any;
1862
1880
  theme: any;
@@ -2126,6 +2144,15 @@ interface ReportBuilderProps {
2126
2144
  isAIEnabled?: boolean;
2127
2145
  /** Whether the PivotModal's AI features are enabled. */
2128
2146
  pivotRecommendationsEnabled?: boolean;
2147
+ /**
2148
+ * Options for the chart builder modal.
2149
+ */
2150
+ chartBuilderOptions?: {
2151
+ /** Whether to show table format options. */
2152
+ showTableFormatOptions?: boolean;
2153
+ /** Whether to show dashboard filter fields. */
2154
+ showDashboardFilterFields?: boolean;
2155
+ };
2129
2156
  /**
2130
2157
  * Applies the following classes to the ReportBuilder.
2131
2158
  *
@@ -2195,7 +2222,7 @@ interface ReportBuilderProps {
2195
2222
  * ### Report Builder API
2196
2223
  * @see https://docs.quillsql.com/components/report-builder
2197
2224
  */
2198
- declare function ReportBuilder$1({ initialTableName, onSubmitEditReport, onSubmitCreateReport, onSubmitSaveQuery, onDiscardChanges, onSaveChanges, onCloseChartBuilder, destinationDashboard, destinationSection, chartBuilderTitle, organizationName, ButtonComponent, SecondaryButtonComponent, DeleteButtonComponent, ModalComponent, TextInputComponent, SelectComponent, MultiSelectComponent, TableComponent, PopoverComponent, TabsComponent, CheckboxComponent, SidebarComponent, ContainerComponent, SelectColumnComponent, DraggableColumnComponent, SidebarHeadingComponent, FilterPopoverComponent, SortPopoverComponent, LimitPopoverComponent, CardComponent, LabelComponent, HeaderComponent, SubHeaderComponent, TextComponent, ErrorMessageComponent, ChartBuilderInputRowContainer, ChartBuilderInputColumnContainer, PivotRowContainer, PivotColumnContainer, LoadingComponent, ColumnSearchEmptyState, ChartBuilderFormContainer, ChartBuilderModalComponent, isAdminEnabled, isAIEnabled, containerStyle, className, pivotRecommendationsEnabled, reportId, hideCopySQL, isChartBuilderHorizontalView, onClickChartElement, onRequestAddVirtualTable, submitButtonLabel, }: ReportBuilderProps): react_jsx_runtime.JSX.Element;
2225
+ declare function ReportBuilder$1({ initialTableName, onSubmitEditReport, onSubmitCreateReport, onSubmitSaveQuery, onDiscardChanges, onSaveChanges, onCloseChartBuilder, destinationDashboard, destinationSection, chartBuilderTitle, organizationName, ButtonComponent, SecondaryButtonComponent, DeleteButtonComponent, ModalComponent, TextInputComponent, SelectComponent, MultiSelectComponent, TableComponent, PopoverComponent, TabsComponent, CheckboxComponent, SidebarComponent, ContainerComponent, SelectColumnComponent, DraggableColumnComponent, SidebarHeadingComponent, FilterPopoverComponent, SortPopoverComponent, LimitPopoverComponent, CardComponent, LabelComponent, HeaderComponent, SubHeaderComponent, TextComponent, ErrorMessageComponent, ChartBuilderInputRowContainer, ChartBuilderInputColumnContainer, PivotRowContainer, PivotColumnContainer, LoadingComponent, ColumnSearchEmptyState, ChartBuilderFormContainer, ChartBuilderModalComponent, isAdminEnabled, isAIEnabled, containerStyle, className, pivotRecommendationsEnabled, chartBuilderOptions, reportId, hideCopySQL, isChartBuilderHorizontalView, onClickChartElement, onRequestAddVirtualTable, submitButtonLabel, }: ReportBuilderProps): react_jsx_runtime.JSX.Element;
2199
2226
 
2200
2227
  /**
2201
2228
  * Props for the Quill ChartEditor component.
@@ -3260,6 +3287,10 @@ interface SaveReportProps {
3260
3287
  onSubmitCreateReport?: (report: QuillReport) => void;
3261
3288
  /** The destination section for the report. */
3262
3289
  destinationSection?: string;
3290
+ /** Whether to show table format options. */
3291
+ showTableFormatOptions?: boolean;
3292
+ /** Whether to show dashboard filter fields. */
3293
+ showDashboardFilterFields?: boolean;
3263
3294
  /** A select component. */
3264
3295
  SelectComponent?: (props: {
3265
3296
  value: string | number | undefined | null;
@@ -3399,7 +3430,7 @@ interface SaveReportProps {
3399
3430
  /** The label for the submit button. */
3400
3431
  submitButtonLabel?: string;
3401
3432
  }
3402
- declare const SaveReport: ({ reportBuilder, isOpen, setIsOpen, isAdminEnabled, chartBuilderTitle, onSubmitEditReport, onSubmitCreateReport, destinationSection, SelectComponent, TextInputComponent, ButtonComponent, SecondaryButtonComponent, HeaderComponent, SubHeaderComponent, LabelComponent, TextComponent, CardComponent, ModalComponent, PopoverComponent, TableComponent, DeleteButtonComponent, LoadingComponent, ChartBuilderInputRowContainer, ChartBuilderInputColumnContainer, PivotRowContainer, PivotColumnContainer, ErrorMessageComponent, CheckboxComponent, ChartBuilderFormContainer, onClickChartElement, SaveTrigger, submitButtonLabel, }: SaveReportProps) => react_jsx_runtime.JSX.Element;
3433
+ declare const SaveReport: ({ reportBuilder, isOpen, setIsOpen, isAdminEnabled, chartBuilderTitle, onSubmitEditReport, onSubmitCreateReport, destinationSection, showTableFormatOptions, showDashboardFilterFields, SelectComponent, TextInputComponent, ButtonComponent, SecondaryButtonComponent, HeaderComponent, SubHeaderComponent, LabelComponent, TextComponent, CardComponent, ModalComponent, PopoverComponent, TableComponent, DeleteButtonComponent, LoadingComponent, ChartBuilderInputRowContainer, ChartBuilderInputColumnContainer, PivotRowContainer, PivotColumnContainer, ErrorMessageComponent, CheckboxComponent, ChartBuilderFormContainer, onClickChartElement, SaveTrigger, submitButtonLabel, }: SaveReportProps) => react_jsx_runtime.JSX.Element;
3403
3434
 
3404
3435
  interface ReportTableProps {
3405
3436
  reportBuilder: ReportBuilder;
package/dist/index.d.ts CHANGED
@@ -1751,8 +1751,13 @@ interface SQLEditorProps {
1751
1751
  onCloseChartBuilder?: () => void;
1752
1752
  /**
1753
1753
  * A callback that is fired when a report has been added to a dashboard.
1754
+ * @deprecated Use onSubmitCreateReport and onSubmitEditReport instead
1754
1755
  */
1755
1756
  onAddToDashboardComplete?: (report: QuillReport) => void;
1757
+ /** A callback function that will trigger when a new chart is saved */
1758
+ onSubmitCreateReport?: (report: QuillReport) => void;
1759
+ /** A callback function that will trigger when a chart is edited */
1760
+ onSubmitEditReport?: (report: QuillReport) => void;
1756
1761
  onSaveQueryComplete?: (report: QuillReport) => void;
1757
1762
  /** A callback function triggered when a chart element is clicked */
1758
1763
  onClickChartElement?: (event: any) => void;
@@ -1779,9 +1784,14 @@ interface SQLEditorProps {
1779
1784
  */
1780
1785
  isAdminEnabled?: boolean;
1781
1786
  /**
1782
- * Whether to show table format options.
1787
+ * Options for the chart builder modal.
1783
1788
  */
1784
- showTableFormatOptions?: boolean;
1789
+ chartBuilderOptions?: {
1790
+ /** Whether to show table format options. */
1791
+ showTableFormatOptions?: boolean;
1792
+ /** Whether to show dashboard filter fields. */
1793
+ showDashboardFilterFields?: boolean;
1794
+ };
1785
1795
  /**
1786
1796
  * Whether to show date field options.
1787
1797
  */
@@ -1794,6 +1804,10 @@ interface SQLEditorProps {
1794
1804
  * A dashboard item.
1795
1805
  */
1796
1806
  report?: QuillReport;
1807
+ /**
1808
+ * A report id that the SQL Editor will query from and modify.
1809
+ */
1810
+ reportId?: string;
1797
1811
  /**
1798
1812
  * The default query to use as a placeholder.
1799
1813
  */
@@ -1802,6 +1816,10 @@ interface SQLEditorProps {
1802
1816
  * The default dashboard to add the query to.
1803
1817
  */
1804
1818
  destinationDashboard: string;
1819
+ /**
1820
+ * The section of the dashboard to add items to.
1821
+ */
1822
+ destinationSection?: string;
1805
1823
  /**
1806
1824
  * The title of the ChartBuilder dialog.
1807
1825
  */
@@ -1856,7 +1874,7 @@ interface SQLEditorProps {
1856
1874
  * ### SQLEditor API
1857
1875
  * @see https://docs.quillsql.com/components/sql-editor
1858
1876
  */
1859
- 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, onChangeQuery, onChangeData, onChangeColumns, onChangeFields, onDiscardChanges, onSaveChanges, onCloseChartBuilder, isChartBuilderEnabled, isAdminEnabled, chartBuilderTitle, runQueryOnMount, onAddToDashboardComplete, onSaveQueryComplete, addToDashboardButtonLabel, report, organizationName, isChartBuilderHorizontalView, containerStyle, className, onClickChartElement, onRequestAddVirtualTable, }: SQLEditorProps): react_jsx_runtime.JSX.Element;
1877
+ 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;
1860
1878
  declare const SchemaListComponent: ({ schema, theme, loading, LoadingComponent, width, onClick, style, onRequestAddVirtualTable, ButtonComponent, }: {
1861
1879
  schema: any;
1862
1880
  theme: any;
@@ -2126,6 +2144,15 @@ interface ReportBuilderProps {
2126
2144
  isAIEnabled?: boolean;
2127
2145
  /** Whether the PivotModal's AI features are enabled. */
2128
2146
  pivotRecommendationsEnabled?: boolean;
2147
+ /**
2148
+ * Options for the chart builder modal.
2149
+ */
2150
+ chartBuilderOptions?: {
2151
+ /** Whether to show table format options. */
2152
+ showTableFormatOptions?: boolean;
2153
+ /** Whether to show dashboard filter fields. */
2154
+ showDashboardFilterFields?: boolean;
2155
+ };
2129
2156
  /**
2130
2157
  * Applies the following classes to the ReportBuilder.
2131
2158
  *
@@ -2195,7 +2222,7 @@ interface ReportBuilderProps {
2195
2222
  * ### Report Builder API
2196
2223
  * @see https://docs.quillsql.com/components/report-builder
2197
2224
  */
2198
- declare function ReportBuilder$1({ initialTableName, onSubmitEditReport, onSubmitCreateReport, onSubmitSaveQuery, onDiscardChanges, onSaveChanges, onCloseChartBuilder, destinationDashboard, destinationSection, chartBuilderTitle, organizationName, ButtonComponent, SecondaryButtonComponent, DeleteButtonComponent, ModalComponent, TextInputComponent, SelectComponent, MultiSelectComponent, TableComponent, PopoverComponent, TabsComponent, CheckboxComponent, SidebarComponent, ContainerComponent, SelectColumnComponent, DraggableColumnComponent, SidebarHeadingComponent, FilterPopoverComponent, SortPopoverComponent, LimitPopoverComponent, CardComponent, LabelComponent, HeaderComponent, SubHeaderComponent, TextComponent, ErrorMessageComponent, ChartBuilderInputRowContainer, ChartBuilderInputColumnContainer, PivotRowContainer, PivotColumnContainer, LoadingComponent, ColumnSearchEmptyState, ChartBuilderFormContainer, ChartBuilderModalComponent, isAdminEnabled, isAIEnabled, containerStyle, className, pivotRecommendationsEnabled, reportId, hideCopySQL, isChartBuilderHorizontalView, onClickChartElement, onRequestAddVirtualTable, submitButtonLabel, }: ReportBuilderProps): react_jsx_runtime.JSX.Element;
2225
+ declare function ReportBuilder$1({ initialTableName, onSubmitEditReport, onSubmitCreateReport, onSubmitSaveQuery, onDiscardChanges, onSaveChanges, onCloseChartBuilder, destinationDashboard, destinationSection, chartBuilderTitle, organizationName, ButtonComponent, SecondaryButtonComponent, DeleteButtonComponent, ModalComponent, TextInputComponent, SelectComponent, MultiSelectComponent, TableComponent, PopoverComponent, TabsComponent, CheckboxComponent, SidebarComponent, ContainerComponent, SelectColumnComponent, DraggableColumnComponent, SidebarHeadingComponent, FilterPopoverComponent, SortPopoverComponent, LimitPopoverComponent, CardComponent, LabelComponent, HeaderComponent, SubHeaderComponent, TextComponent, ErrorMessageComponent, ChartBuilderInputRowContainer, ChartBuilderInputColumnContainer, PivotRowContainer, PivotColumnContainer, LoadingComponent, ColumnSearchEmptyState, ChartBuilderFormContainer, ChartBuilderModalComponent, isAdminEnabled, isAIEnabled, containerStyle, className, pivotRecommendationsEnabled, chartBuilderOptions, reportId, hideCopySQL, isChartBuilderHorizontalView, onClickChartElement, onRequestAddVirtualTable, submitButtonLabel, }: ReportBuilderProps): react_jsx_runtime.JSX.Element;
2199
2226
 
2200
2227
  /**
2201
2228
  * Props for the Quill ChartEditor component.
@@ -3260,6 +3287,10 @@ interface SaveReportProps {
3260
3287
  onSubmitCreateReport?: (report: QuillReport) => void;
3261
3288
  /** The destination section for the report. */
3262
3289
  destinationSection?: string;
3290
+ /** Whether to show table format options. */
3291
+ showTableFormatOptions?: boolean;
3292
+ /** Whether to show dashboard filter fields. */
3293
+ showDashboardFilterFields?: boolean;
3263
3294
  /** A select component. */
3264
3295
  SelectComponent?: (props: {
3265
3296
  value: string | number | undefined | null;
@@ -3399,7 +3430,7 @@ interface SaveReportProps {
3399
3430
  /** The label for the submit button. */
3400
3431
  submitButtonLabel?: string;
3401
3432
  }
3402
- declare const SaveReport: ({ reportBuilder, isOpen, setIsOpen, isAdminEnabled, chartBuilderTitle, onSubmitEditReport, onSubmitCreateReport, destinationSection, SelectComponent, TextInputComponent, ButtonComponent, SecondaryButtonComponent, HeaderComponent, SubHeaderComponent, LabelComponent, TextComponent, CardComponent, ModalComponent, PopoverComponent, TableComponent, DeleteButtonComponent, LoadingComponent, ChartBuilderInputRowContainer, ChartBuilderInputColumnContainer, PivotRowContainer, PivotColumnContainer, ErrorMessageComponent, CheckboxComponent, ChartBuilderFormContainer, onClickChartElement, SaveTrigger, submitButtonLabel, }: SaveReportProps) => react_jsx_runtime.JSX.Element;
3433
+ declare const SaveReport: ({ reportBuilder, isOpen, setIsOpen, isAdminEnabled, chartBuilderTitle, onSubmitEditReport, onSubmitCreateReport, destinationSection, showTableFormatOptions, showDashboardFilterFields, SelectComponent, TextInputComponent, ButtonComponent, SecondaryButtonComponent, HeaderComponent, SubHeaderComponent, LabelComponent, TextComponent, CardComponent, ModalComponent, PopoverComponent, TableComponent, DeleteButtonComponent, LoadingComponent, ChartBuilderInputRowContainer, ChartBuilderInputColumnContainer, PivotRowContainer, PivotColumnContainer, ErrorMessageComponent, CheckboxComponent, ChartBuilderFormContainer, onClickChartElement, SaveTrigger, submitButtonLabel, }: SaveReportProps) => react_jsx_runtime.JSX.Element;
3403
3434
 
3404
3435
  interface ReportTableProps {
3405
3436
  reportBuilder: ReportBuilder;