@quillsql/react 2.16.1 → 2.16.3

package/dist/index.d.cts

@@ -569,6 +569,49 @@ type PivotData = {
     comparisonPivotQuery?: string;
 };
 
+type SortDirection = 'asc' | 'desc' | 'ASC' | 'DESC';
+type ReportBuilderTable = {
+    name: string;
+    alias?: string;
+    join?: JoinInfo;
+};
+declare enum JoinType {
+    JOIN = "JOIN",
+    INNER = "INNER JOIN",
+    LEFT = "LEFT JOIN",
+    RIGHT = "RIGHT JOIN",
+    FULL = "FULL JOIN"
+}
+type JoinInfo = {
+    type: JoinType;
+    condition: JoinCondition;
+};
+type JoinCondition = {
+    operator: string;
+    left: ReportBuilderColumn;
+    right: ReportBuilderColumn;
+};
+type ReportBuilderColumn = {
+    field: string;
+    table: string;
+    alias?: string;
+};
+type ReportBuilderSort = {
+    field: string;
+    direction: SortDirection;
+};
+type ReportBuilderLimit = {
+    value: number;
+};
+type ReportBuilderState = {
+    tables: ReportBuilderTable[];
+    columns: ReportBuilderColumn[];
+    filterStack: FilterTreeNode[];
+    pivot: Pivot | null;
+    sort: ReportBuilderSort[];
+    limit: ReportBuilderLimit | null;
+};
+
 /**
  * ## QuillReport
  * Represents an individual item on a dashboard.
@@ -708,6 +751,11 @@ interface QuillReportInternal extends QuillReport {
     flags?: {
         [tenantField: string]: string[] | 'QUILL_ALL_TENANTS';
     };
+    /**
+     * ReportBuilderState used for ReportBuilder reports.
+     * When present, backend will generate SQL from this state instead of using queryString.
+     */
+    reportBuilderState?: ReportBuilderState;
 }
 
 /**
@@ -2246,12 +2294,16 @@ interface ChartEditorProps {
      * A callback that is fired when the add to dashboard flow has been completed.
      */
     onAddToDashboardComplete?: (report: QuillReport) => void;
+    /** A callback function that will trigger when a chart is edited */
+    onSubmitEditReport?: (report: QuillReport) => void;
+    /** A callback function that will trigger when changes are discarded */
+    onDiscardChanges?: () => void;
     /** A callback function triggered when a chart element is clicked */
     onClickChartElement?: (element: any) => void;
     /** A callback function triggered when the chart error button is clicked */
     onClickChartError?: (element: any) => void;
     /** A callback that is fired when the item is deleted. */
-    onDelete?: () => boolean | Promise<boolean>;
+    onDelete?: () => void;
     /** A select component. */
     SelectComponent?: (props: {
         value: string | number | null | undefined;
@@ -2404,6 +2456,23 @@ interface ChartEditorProps {
     hideDeleteButton?: boolean;
     /** Whether to hide the submit button. */
     hideSubmitButton?: boolean;
+    /** The section of the dashboard to add items to. */
+    destinationSection?: string;
+    /** Whether to show table format options */
+    showTableFormatOptions?: boolean;
+    /** Whether to show dashboard filter fields */
+    showDashboardFilterFields?: boolean;
+    /**
+     * Options for the chart builder modal.
+     */
+    chartBuilderOptions?: {
+        /** Whether to show table format options. */
+        showTableFormatOptions?: boolean;
+        /** Whether to show dashboard filter fields. */
+        showDashboardFilterFields?: boolean;
+        /** Whether to show the delete button. */
+        showDeleteButton?: boolean;
+    };
 }
 /**
  * ### Quill Chart Editor
@@ -2431,7 +2500,7 @@ interface ChartEditorProps {
  * ### Chart Editor API
  * @see https://docs.quillsql.com/components/chart-editor
  */
-declare function ChartEditor({ isOpen, reportId, isAdmin, chartBuilderTitle, chartBuilderButtonLabel, onAddToDashboardComplete, destinationDashboard, organizationName, isHorizontalView, onDelete, setIsOpen, SelectComponent, TextInputComponent, ButtonComponent, SecondaryButtonComponent, HeaderComponent, SubHeaderComponent, LabelComponent, TextComponent, DeleteButtonComponent, ModalComponent, CardComponent, PopoverComponent, LoadingComponent, TableComponent, ChartBuilderInputRowContainer, ChartBuilderInputColumnContainer, PivotRowContainer, PivotColumnContainer, ErrorMessageComponent, ChartBuilderFormContainer, ErrorComponent, hideDeleteButton, hideSubmitButton, onClickChartElement, onClickChartError, }: ChartEditorProps): react_jsx_runtime.JSX.Element;
+declare function ChartEditor({ isOpen, reportId, isAdmin, chartBuilderTitle, chartBuilderButtonLabel, onAddToDashboardComplete, onSubmitEditReport, onDiscardChanges, destinationDashboard, destinationSection, organizationName, isHorizontalView, onDelete, setIsOpen, SelectComponent, TextInputComponent, ButtonComponent, SecondaryButtonComponent, HeaderComponent, SubHeaderComponent, LabelComponent, TextComponent, DeleteButtonComponent, ModalComponent, CardComponent, PopoverComponent, LoadingComponent, TableComponent, ChartBuilderInputRowContainer, ChartBuilderInputColumnContainer, PivotRowContainer, PivotColumnContainer, ErrorMessageComponent, ChartBuilderFormContainer, ErrorComponent, hideDeleteButton, hideSubmitButton, showTableFormatOptions, showDashboardFilterFields, chartBuilderOptions, onClickChartElement, onClickChartError, }: ChartEditorProps): react_jsx_runtime.JSX.Element;
 
 interface StaticChartProps {
     reportId: string;
@@ -2557,49 +2626,6 @@ interface UniqueValuesByColumn {
     [column: string]: string[];
 }
 
-type SortDirection = 'asc' | 'desc' | 'ASC' | 'DESC';
-type ReportBuilderTable = {
-    name: string;
-    alias?: string;
-    join?: JoinInfo;
-};
-declare enum JoinType {
-    JOIN = "JOIN",
-    INNER = "INNER JOIN",
-    LEFT = "LEFT JOIN",
-    RIGHT = "RIGHT JOIN",
-    FULL = "FULL JOIN"
-}
-type JoinInfo = {
-    type: JoinType;
-    condition: JoinCondition;
-};
-type JoinCondition = {
-    operator: string;
-    left: ReportBuilderColumn;
-    right: ReportBuilderColumn;
-};
-type ReportBuilderColumn = {
-    field: string;
-    table: string;
-    alias?: string;
-};
-type ReportBuilderSort = {
-    field: string;
-    direction: SortDirection;
-};
-type ReportBuilderLimit = {
-    value: number;
-};
-type ReportBuilderState = {
-    tables: ReportBuilderTable[];
-    columns: ReportBuilderColumn[];
-    filterStack: FilterTreeNode[];
-    pivot: Pivot | null;
-    sort: ReportBuilderSort[];
-    limit: ReportBuilderLimit | null;
-};
-
 type ForeignKeyMap = {
     [table: string]: {
         foreignTable: string;
@@ -2615,7 +2641,6 @@ type ReportBuilder = {
     limit: ReportBuilderLimit | null;
     filterStack: FilterTreeNode[];
     state: ReportBuilderState;
-    activeQuery: string;
     tempReport: QuillReportInternal;
     stateStack: ReportBuilderState[];
     poppedStateStack: ReportBuilderState[];
@@ -3285,6 +3310,8 @@ interface SaveReportProps {
     onSubmitEditReport?: (report: QuillReport) => void;
     /** Callback when creating a new report is submitted. */
     onSubmitCreateReport?: (report: QuillReport) => void;
+    /** Callback when changes are discarded. */
+    onDiscardChanges?: () => void;
     /** The destination section for the report. */
     destinationSection?: string;
     /** Whether to show table format options. */
@@ -3430,7 +3457,7 @@ interface SaveReportProps {
     /** The label for the submit button. */
     submitButtonLabel?: string;
 }
-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;
+declare const SaveReport: ({ reportBuilder, isOpen, setIsOpen, isAdminEnabled, chartBuilderTitle, onSubmitEditReport, onSubmitCreateReport, onDiscardChanges, 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;
 
 interface ReportTableProps {
     reportBuilder: ReportBuilder;

package/dist/index.d.ts

@@ -569,6 +569,49 @@ type PivotData = {
     comparisonPivotQuery?: string;
 };
 
+type SortDirection = 'asc' | 'desc' | 'ASC' | 'DESC';
+type ReportBuilderTable = {
+    name: string;
+    alias?: string;
+    join?: JoinInfo;
+};
+declare enum JoinType {
+    JOIN = "JOIN",
+    INNER = "INNER JOIN",
+    LEFT = "LEFT JOIN",
+    RIGHT = "RIGHT JOIN",
+    FULL = "FULL JOIN"
+}
+type JoinInfo = {
+    type: JoinType;
+    condition: JoinCondition;
+};
+type JoinCondition = {
+    operator: string;
+    left: ReportBuilderColumn;
+    right: ReportBuilderColumn;
+};
+type ReportBuilderColumn = {
+    field: string;
+    table: string;
+    alias?: string;
+};
+type ReportBuilderSort = {
+    field: string;
+    direction: SortDirection;
+};
+type ReportBuilderLimit = {
+    value: number;
+};
+type ReportBuilderState = {
+    tables: ReportBuilderTable[];
+    columns: ReportBuilderColumn[];
+    filterStack: FilterTreeNode[];
+    pivot: Pivot | null;
+    sort: ReportBuilderSort[];
+    limit: ReportBuilderLimit | null;
+};
+
 /**
  * ## QuillReport
  * Represents an individual item on a dashboard.
@@ -708,6 +751,11 @@ interface QuillReportInternal extends QuillReport {
     flags?: {
         [tenantField: string]: string[] | 'QUILL_ALL_TENANTS';
     };
+    /**
+     * ReportBuilderState used for ReportBuilder reports.
+     * When present, backend will generate SQL from this state instead of using queryString.
+     */
+    reportBuilderState?: ReportBuilderState;
 }
 
 /**
@@ -2246,12 +2294,16 @@ interface ChartEditorProps {
      * A callback that is fired when the add to dashboard flow has been completed.
      */
     onAddToDashboardComplete?: (report: QuillReport) => void;
+    /** A callback function that will trigger when a chart is edited */
+    onSubmitEditReport?: (report: QuillReport) => void;
+    /** A callback function that will trigger when changes are discarded */
+    onDiscardChanges?: () => void;
     /** A callback function triggered when a chart element is clicked */
     onClickChartElement?: (element: any) => void;
     /** A callback function triggered when the chart error button is clicked */
     onClickChartError?: (element: any) => void;
     /** A callback that is fired when the item is deleted. */
-    onDelete?: () => boolean | Promise<boolean>;
+    onDelete?: () => void;
     /** A select component. */
     SelectComponent?: (props: {
         value: string | number | null | undefined;
@@ -2404,6 +2456,23 @@ interface ChartEditorProps {
     hideDeleteButton?: boolean;
     /** Whether to hide the submit button. */
     hideSubmitButton?: boolean;
+    /** The section of the dashboard to add items to. */
+    destinationSection?: string;
+    /** Whether to show table format options */
+    showTableFormatOptions?: boolean;
+    /** Whether to show dashboard filter fields */
+    showDashboardFilterFields?: boolean;
+    /**
+     * Options for the chart builder modal.
+     */
+    chartBuilderOptions?: {
+        /** Whether to show table format options. */
+        showTableFormatOptions?: boolean;
+        /** Whether to show dashboard filter fields. */
+        showDashboardFilterFields?: boolean;
+        /** Whether to show the delete button. */
+        showDeleteButton?: boolean;
+    };
 }
 /**
  * ### Quill Chart Editor
@@ -2431,7 +2500,7 @@ interface ChartEditorProps {
  * ### Chart Editor API
  * @see https://docs.quillsql.com/components/chart-editor
  */
-declare function ChartEditor({ isOpen, reportId, isAdmin, chartBuilderTitle, chartBuilderButtonLabel, onAddToDashboardComplete, destinationDashboard, organizationName, isHorizontalView, onDelete, setIsOpen, SelectComponent, TextInputComponent, ButtonComponent, SecondaryButtonComponent, HeaderComponent, SubHeaderComponent, LabelComponent, TextComponent, DeleteButtonComponent, ModalComponent, CardComponent, PopoverComponent, LoadingComponent, TableComponent, ChartBuilderInputRowContainer, ChartBuilderInputColumnContainer, PivotRowContainer, PivotColumnContainer, ErrorMessageComponent, ChartBuilderFormContainer, ErrorComponent, hideDeleteButton, hideSubmitButton, onClickChartElement, onClickChartError, }: ChartEditorProps): react_jsx_runtime.JSX.Element;
+declare function ChartEditor({ isOpen, reportId, isAdmin, chartBuilderTitle, chartBuilderButtonLabel, onAddToDashboardComplete, onSubmitEditReport, onDiscardChanges, destinationDashboard, destinationSection, organizationName, isHorizontalView, onDelete, setIsOpen, SelectComponent, TextInputComponent, ButtonComponent, SecondaryButtonComponent, HeaderComponent, SubHeaderComponent, LabelComponent, TextComponent, DeleteButtonComponent, ModalComponent, CardComponent, PopoverComponent, LoadingComponent, TableComponent, ChartBuilderInputRowContainer, ChartBuilderInputColumnContainer, PivotRowContainer, PivotColumnContainer, ErrorMessageComponent, ChartBuilderFormContainer, ErrorComponent, hideDeleteButton, hideSubmitButton, showTableFormatOptions, showDashboardFilterFields, chartBuilderOptions, onClickChartElement, onClickChartError, }: ChartEditorProps): react_jsx_runtime.JSX.Element;
 
 interface StaticChartProps {
     reportId: string;
@@ -2557,49 +2626,6 @@ interface UniqueValuesByColumn {
     [column: string]: string[];
 }
 
-type SortDirection = 'asc' | 'desc' | 'ASC' | 'DESC';
-type ReportBuilderTable = {
-    name: string;
-    alias?: string;
-    join?: JoinInfo;
-};
-declare enum JoinType {
-    JOIN = "JOIN",
-    INNER = "INNER JOIN",
-    LEFT = "LEFT JOIN",
-    RIGHT = "RIGHT JOIN",
-    FULL = "FULL JOIN"
-}
-type JoinInfo = {
-    type: JoinType;
-    condition: JoinCondition;
-};
-type JoinCondition = {
-    operator: string;
-    left: ReportBuilderColumn;
-    right: ReportBuilderColumn;
-};
-type ReportBuilderColumn = {
-    field: string;
-    table: string;
-    alias?: string;
-};
-type ReportBuilderSort = {
-    field: string;
-    direction: SortDirection;
-};
-type ReportBuilderLimit = {
-    value: number;
-};
-type ReportBuilderState = {
-    tables: ReportBuilderTable[];
-    columns: ReportBuilderColumn[];
-    filterStack: FilterTreeNode[];
-    pivot: Pivot | null;
-    sort: ReportBuilderSort[];
-    limit: ReportBuilderLimit | null;
-};
-
 type ForeignKeyMap = {
     [table: string]: {
         foreignTable: string;
@@ -2615,7 +2641,6 @@ type ReportBuilder = {
     limit: ReportBuilderLimit | null;
     filterStack: FilterTreeNode[];
     state: ReportBuilderState;
-    activeQuery: string;
     tempReport: QuillReportInternal;
     stateStack: ReportBuilderState[];
     poppedStateStack: ReportBuilderState[];
@@ -3285,6 +3310,8 @@ interface SaveReportProps {
     onSubmitEditReport?: (report: QuillReport) => void;
     /** Callback when creating a new report is submitted. */
     onSubmitCreateReport?: (report: QuillReport) => void;
+    /** Callback when changes are discarded. */
+    onDiscardChanges?: () => void;
     /** The destination section for the report. */
     destinationSection?: string;
     /** Whether to show table format options. */
@@ -3430,7 +3457,7 @@ interface SaveReportProps {
     /** The label for the submit button. */
     submitButtonLabel?: string;
 }
-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;
+declare const SaveReport: ({ reportBuilder, isOpen, setIsOpen, isAdminEnabled, chartBuilderTitle, onSubmitEditReport, onSubmitCreateReport, onDiscardChanges, 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;
 
 interface ReportTableProps {
     reportBuilder: ReportBuilder;