@quillsql/react 2.12.37 → 2.12.39

package/dist/esm/SQLEditor.d.ts

@@ -0,0 +1,272 @@
+import React, { ReactNode } from 'react';
+import { QuillReport } from './models/Report';
+/**
+ * Props for the Quill SQLEditor component.
+ */
+export interface SQLEditorProps {
+    /**
+     * A primary button component.
+     */
+    ButtonComponent?: (props: {
+        onClick: () => void;
+        label: string;
+        disabled?: boolean;
+        icon?: ReactNode;
+    }) => JSX.Element;
+    /**
+     * A secondary button component.
+     */
+    SecondaryButtonComponent?: (props: {
+        onClick: () => void;
+        label: string;
+        disabled?: boolean;
+        icon?: ReactNode;
+    }) => JSX.Element;
+    /** A small delete button used to click out of things. Usually an "X" icon. */
+    DeleteButtonComponent?: (props: {
+        onClick: () => void;
+    }) => JSX.Element;
+    /**
+     * A input element for getting text from the user.
+     */
+    TextInputComponent?: (props: {
+        id: string;
+        width: number;
+        value: string;
+        label?: string;
+        placeholder?: string;
+        onChange: (event: React.ChangeEvent<HTMLInputElement>) => void;
+    }) => JSX.Element;
+    /** A select component. */
+    SelectComponent?: (props: {
+        value: string;
+        label?: string;
+        options: {
+            value: string;
+            label: string;
+        }[];
+        onChange: (event: React.ChangeEvent<HTMLSelectElement>) => void;
+        width: number;
+    }) => JSX.Element;
+    /**
+     * A table component to show the results of the SQL query.
+     */
+    TableComponent?: (props: {
+        rows: {
+            [key: string]: any;
+        }[];
+        columns: {
+            field: string;
+            label: string;
+        }[];
+        isLoading?: boolean;
+        rowCount?: number;
+        onPageChange?: (page: number) => void;
+        onSortChange?: (sort: {
+            field: string;
+            direction: string;
+        }) => void;
+    }) => JSX.Element;
+    /**
+     * A component to show while the query results are loading.
+     */
+    LoadingComponent?: () => JSX.Element;
+    /** A card component used as a dismissable container of pivot information. */
+    CardComponent?: (props: {
+        children: ReactNode;
+        onClick?: () => void;
+        onDelete?: () => void;
+    }) => JSX.Element;
+    /**
+     * A modal component to use to open the add to dashboard dialog.
+     */
+    ModalComponent?: (props: {
+        isOpen: boolean;
+        setIsOpen: (isOpen: boolean) => void;
+        title?: string;
+        children: ReactNode;
+        width?: number;
+        height?: number;
+    }) => JSX.Element;
+    /** A popover component. */
+    PopoverComponent?: (props: {
+        isOpen: boolean;
+        setIsOpen: (isOpen: boolean) => void;
+        triggerLabel?: string;
+        popoverTitle?: string;
+        popoverChildren: ReactNode;
+    }) => JSX.Element;
+    /** A label component. */
+    LabelComponent?: (props: {
+        label: string;
+    }) => JSX.Element;
+    /** A header component. */
+    HeaderComponent?: (props: {
+        label: string;
+    }) => JSX.Element;
+    /** A sub-header component describes a group of inputs. */
+    SubHeaderComponent?: (props: {
+        label: string;
+    }) => JSX.Element;
+    /** A simple text component. */
+    TextComponent?: (props: {
+        label: string;
+    }) => JSX.Element;
+    /**
+     * A container for each row of inputs for the ChartBuilder form.
+     */
+    ChartBuilderInputRowContainer?: (props: {
+        children: ReactNode;
+    }) => JSX.Element;
+    /**
+     * A container for vertically-stacked rows of inputs for the ChartBuilder form.
+     */
+    ChartBuilderInputColumnContainer?: (props: {
+        children: ReactNode;
+    }) => JSX.Element;
+    /**
+     * A container for each row of inputs for the pivot form.
+     */
+    PivotRowContainer?: (props: {
+        children: ReactNode;
+    }) => JSX.Element;
+    /**
+     * A container for vertically-stacked rows of inputs for the pivot form.
+     */
+    PivotColumnContainer?: (props: {
+        children: ReactNode;
+    }) => JSX.Element;
+    /**
+     * A container for vertically-stacked sections of the chart builder form.
+     */
+    ChartBuilderFormContainer?: (props: {
+        children: ReactNode;
+    }) => JSX.Element;
+    /**
+     * A component that displays error messages.
+     */
+    ErrorMessageComponent?: (props: {
+        errorMessage: string;
+    }) => JSX.Element;
+    /**
+     * A callback that is fired when the query changes.
+     */
+    onChangeQuery?: (query: string) => void;
+    /**
+     * A callback that is fired when the data changes.
+     */
+    onChangeData?: (data: object[]) => void;
+    /**
+     * A callback that is fired when the data fields change.
+     */
+    onChangeFields?: (fields: object[]) => void;
+    /**
+     * A callback that is fired when the data columns change.
+     */
+    onChangeColumns?: (columns: object[]) => void;
+    /**
+     * A callback that is fired when a report has been added to a dashboard.
+     */
+    onAddToDashboardComplete?: (report: QuillReport) => void;
+    /** A callback function triggered when a chart element is clicked */
+    onClickChartElement?: (event: any) => void;
+    /**
+     * Whether the chart builder is in horizontal view mode.
+     *
+     * Horizontal view mode is where the chart and table are displayed on the left
+     * and the editing form is displayed on the right, rather than being stacked
+     * vertically.
+     */
+    isChartBuilderHorizontalView?: boolean;
+    /**
+     * A callback that is fired when the data columns change.
+     */
+    isChartBuilderEnabled?: boolean;
+    /**
+     * Whether the "new query" button is enabled.
+     */
+    isNewQueryEnabled?: boolean;
+    /**
+     * Whether to show table format options.
+     */
+    showTableFormatOptions?: boolean;
+    /**
+     * Whether to show date field options.
+     */
+    showDateFieldOptions?: boolean;
+    /**
+     * Whether to show access control options.
+     */
+    showAccessControlOptions?: boolean;
+    /**
+     * A dashboard item.
+     */
+    report?: QuillReport;
+    /**
+     * The default query to use as a placeholder.
+     */
+    defaultQuery?: string;
+    /**
+     * The default dashboard to dashboard items to.
+     */
+    destinationDashboard?: string;
+    /**
+     * The title of the ChartBuilder dialog.
+     */
+    chartBuilderTitle?: string;
+    /**
+     * The label of the button to add the current query to a dashboard.
+     *
+     * @default "Add to dashboard"
+     */
+    addToDashboardButtonLabel?: string;
+    /**
+     * The name of the current organization.
+     */
+    organizationName?: string;
+    /**
+     * Styles the top-level container of the SQLEditor.
+     *
+     * This can be useful for TailwindCSS-style classname strings.
+     */
+    className?: string;
+    /**
+     * Styles the top-level container of the SQLEditor.
+     */
+    containerStyle?: React.CSSProperties;
+}
+/**
+ * ### Quill SQLEditor
+ *
+ * Allows your users to build and write custom SQL queries and then add those
+ * queries into their dashboard as a metric, chart, or table.
+ *
+ * @example
+ * ```js
+ * // Usage without custom components
+ * <SQLEditor />
+ * ```
+ *
+ * @example
+ * ```js
+ * // You can also pass your own components and default values.
+ * <SQLEditor
+ *   defaultQuery="SELECT SUM(amount) FROM TRANSACTIONS"
+ *   ButtonComponen={MyButton}
+ *   SecondaryButtonComponen={MySecondaryButton}
+ * />
+ * ```
+ *
+ * ### SQLEditor API
+ * @see https://docs.quillsql.com/components/sql-editor
+ */
+export default function SQLEditor({ ButtonComponent, SecondaryButtonComponent, DeleteButtonComponent, TextInputComponent, SelectComponent, TableComponent, isNewQueryEnabled, LoadingComponent, ModalComponent, PopoverComponent, CardComponent, LabelComponent, HeaderComponent, SubHeaderComponent, TextComponent, ErrorMessageComponent, ChartBuilderInputRowContainer, ChartBuilderInputColumnContainer, PivotRowContainer, PivotColumnContainer, ChartBuilderFormContainer, defaultQuery, onChangeQuery, onChangeData, onChangeColumns, onChangeFields, isChartBuilderEnabled, showTableFormatOptions, showDateFieldOptions, showAccessControlOptions, destinationDashboard, chartBuilderTitle, onAddToDashboardComplete, addToDashboardButtonLabel, report, organizationName, isChartBuilderHorizontalView, containerStyle, className, onClickChartElement, }: SQLEditorProps): import("react/jsx-runtime").JSX.Element;
+export declare const SchemaListComponent: ({ schema, theme, loading, LoadingComponent, width, onClick, }: {
+    schema: any;
+    theme: any;
+    loading: boolean;
+    LoadingComponent?: any;
+    width?: any;
+    onClick: (event: React.MouseEvent<HTMLDivElement>) => void;
+}) => import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=SQLEditor.d.ts.map

package/dist/esm/SQLEditor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SQLEditor.d.ts","sourceRoot":"","sources":["../../src/SQLEditor.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,EAMZ,SAAS,EACV,MAAM,OAAO,CAAC;AAiCf,OAAO,EAAE,WAAW,EAAuB,MAAM,iBAAiB,CAAC;AAoGnE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE;QACxB,OAAO,EAAE,MAAM,IAAI,CAAC;QACpB,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB,KAAK,GAAG,CAAC,OAAO,CAAC;IAElB;;OAEG;IACH,wBAAwB,CAAC,EAAE,CAAC,KAAK,EAAE;QACjC,OAAO,EAAE,MAAM,IAAI,CAAC;QACpB,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB,KAAK,GAAG,CAAC,OAAO,CAAC;IAElB,8EAA8E;IAC9E,qBAAqB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,IAAI,CAAA;KAAE,KAAK,GAAG,CAAC,OAAO,CAAC;IAExE;;OAEG;IACH,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE;QAC3B,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,KAAK,IAAI,CAAC;KAChE,KAAK,GAAG,CAAC,OAAO,CAAC;IAElB,0BAA0B;IAC1B,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE;QACxB,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,EAAE;YACP,KAAK,EAAE,MAAM,CAAC;YACd,KAAK,EAAE,MAAM,CAAC;SACf,EAAE,CAAC;QACJ,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAC;QAChE,KAAK,EAAE,MAAM,CAAC;KACf,KAAK,GAAG,CAAC,OAAO,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE;QACvB,IAAI,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;SAAE,EAAE,CAAC;QAC/B,OAAO,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;QAC5C,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;QACtC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,MAAM,CAAA;SAAE,KAAK,IAAI,CAAC;KACrE,KAAK,GAAG,CAAC,OAAO,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,CAAC,OAAO,CAAC;IAErC,6EAA6E;IAC7E,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE;QACtB,QAAQ,EAAE,SAAS,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;KACvB,KAAK,GAAG,CAAC,OAAO,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE;QACvB,MAAM,EAAE,OAAO,CAAC;QAChB,SAAS,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;QACrC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,SAAS,CAAC;QACpB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,KAAK,GAAG,CAAC,OAAO,CAAC;IAElB,2BAA2B;IAC3B,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE;QACzB,MAAM,EAAE,OAAO,CAAC;QAChB,SAAS,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;QACrC,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,eAAe,EAAE,SAAS,CAAC;KAC5B,KAAK,GAAG,CAAC,OAAO,CAAC;IAElB,yBAAyB;IACzB,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,KAAK,GAAG,CAAC,OAAO,CAAC;IAE3D,0BAA0B;IAC1B,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,KAAK,GAAG,CAAC,OAAO,CAAC;IAE5D,0DAA0D;IAC1D,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,KAAK,GAAG,CAAC,OAAO,CAAC;IAE/D,+BAA+B;IAC/B,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,KAAK,GAAG,CAAC,OAAO,CAAC;IAE1D;;OAEG;IACH,6BAA6B,CAAC,EAAE,CAAC,KAAK,EAAE;QACtC,QAAQ,EAAE,SAAS,CAAC;KACrB,KAAK,GAAG,CAAC,OAAO,CAAC;IAElB;;OAEG;IACH,gCAAgC,CAAC,EAAE,CAAC,KAAK,EAAE;QACzC,QAAQ,EAAE,SAAS,CAAC;KACrB,KAAK,GAAG,CAAC,OAAO,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,QAAQ,EAAE,SAAS,CAAA;KAAE,KAAK,GAAG,CAAC,OAAO,CAAC;IAEpE;;OAEG;IACH,oBAAoB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,QAAQ,EAAE,SAAS,CAAA;KAAE,KAAK,GAAG,CAAC,OAAO,CAAC;IAEvE;;OAEG;IACH,yBAAyB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,QAAQ,EAAE,SAAS,CAAA;KAAE,KAAK,GAAG,CAAC,OAAO,CAAC;IAE5E;;OAEG;IACH,qBAAqB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,KAAK,GAAG,CAAC,OAAO,CAAC;IAEzE;;OAEG;IACH,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAExC;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;IAExC;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;IAE9C;;OAEG;IACH,wBAAwB,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;IAEzD,oEAAoE;IACpE,mBAAmB,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;IAE3C;;;;;;OAMG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAEvC;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;CACtC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,EAChC,eAAgC,EAChC,wBAAkD,EAClD,qBAA4C,EAC5C,kBAAmC,EACnC,eAAsC,EACtC,cAA6C,EAC7C,iBAAyB,EACzB,gBAAwC,EACxC,cAA8B,EAC9B,gBAAkC,EAClC,aAAyB,EACzB,cAA8B,EAC9B,eAAgC,EAChC,kBAAsC,EACtC,aAA4B,EAC5B,qBAAkD,EAClD,6BAAkE,EAClE,gCAAwE,EACxE,iBAA0C,EAC1C,oBAAgD,EAChD,yBAA0D,EAC1D,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,eAAe,EACf,cAAc,EACd,qBAA6B,EAC7B,sBAA8B,EAC9B,oBAA4B,EAC5B,wBAAgC,EAChC,oBAAoB,EACpB,iBAAiB,EACjB,wBAAwB,EACxB,yBAA8C,EAC9C,MAAkB,EAClB,gBAA4B,EAC5B,4BAAmC,EACnC,cAAoC,EACpC,SAAS,EACT,mBAAmB,GACpB,EAAE,cAAc,2CA0ahB;AAoJD,eAAO,MAAM,mBAAmB;YAQtB,GAAG;WACJ,GAAG;aACD,OAAO;uBACG,GAAG;YACd,GAAG;qBACM,gBAAgB,CAAC,cAAc,CAAC,KAAK,IAAI;6CA+F3D,CAAC"}