@quillsql/react 2.16.36 → 2.16.38

package/dist/index.d.cts

@@ -1079,8 +1079,9 @@ interface DashboardProps {
     name: string;
     onClickReport: (report: QuillReport) => void;
     containerStyle?: CSSProperties;
+    EmptyDashboardComponent?: () => React.JSX.Element;
 }
-declare function Dashboard({ name, onClickReport, containerStyle, }: DashboardProps & React.HTMLAttributes<HTMLDivElement>): react_jsx_runtime.JSX.Element;
+declare function Dashboard({ name, onClickReport, containerStyle, EmptyDashboardComponent, }: DashboardProps & React.HTMLAttributes<HTMLDivElement>): react_jsx_runtime.JSX.Element;
 
 type DashboardConfig = {
     dashboardId: string;
@@ -1204,6 +1205,16 @@ interface EventTracking {
     addBreadcrumb?: (breadcrumb: EventBreadcrumb) => void;
 }
 
+type ChangelogEntry = {
+    _id?: string;
+    entityId?: string;
+    entityType?: string;
+    changeObject?: unknown;
+};
+declare const useChangelogRefresh: () => {
+    refreshChangelogEntries: (entries: ChangelogEntry[], client: any) => Promise<void>;
+};
+
 interface BaseQuillProviderProps {
     publicKey: string;
     theme?: QuillTheme;
@@ -1213,6 +1224,7 @@ interface BaseQuillProviderProps {
     getAuthorizationToken?: () => Promise<string>;
     eventTracking?: EventTracking | null;
     streamEndpoint?: string;
+    onChangelogs?: (entries: ChangelogEntry[]) => void;
 }
 interface QuillCloudProviderProps extends BaseQuillProviderProps {
     tenants: {
@@ -1301,7 +1313,7 @@ type QuillProviderProps = QuillCloudProviderProps | SelfHostedProviderProps;
  * ### Dashboard API
  * @see https://docs.quillsql.com/components/quill-provider
  */
-declare const QuillProvider: ({ tenants, flags, publicKey, queryEndpoint, streamEndpoint, queryHeaders, children, theme, withCredentials, isAdmin, getAuthorizationToken, eventTracking, }: QuillProviderProps) => react_jsx_runtime.JSX.Element;
+declare const QuillProvider: ({ tenants, flags, publicKey, queryEndpoint, streamEndpoint, queryHeaders, children, theme, withCredentials, isAdmin, getAuthorizationToken, eventTracking, onChangelogs, }: QuillProviderProps) => react_jsx_runtime.JSX.Element;
 
 interface BaseChartProps {
     colors?: string[];
@@ -2732,14 +2744,15 @@ declare const useDashboards: () => {
         }[] | undefined;
     }[] | null;
     isLoading: boolean;
-    createDashboard: ({ name, tenantFilters, filters, dateFilter, dashboardOwners, }: {
+    createDashboard: ({ name, tenantFilters, filters, dateFilter, dashboardOwners, clientId, }: {
         name: string;
         tenantFilters?: InternalDashboardTenantFilter[];
         filters: InternalDashboardFilter[];
         dashboardOwners: string[];
         dateFilter?: InternalDashboardFilter;
+        clientId?: string;
     }) => Promise<void>;
-    updateDashboard: (name: string, { newName, filters, tenantFilters, dateFilter, customFilters, tenantKeys, initialCacheDateRange, }: {
+    updateDashboard: (name: string, { newName, filters, tenantFilters, dateFilter, customFilters, tenantKeys, initialCacheDateRange, clientId, }: {
         newName: string;
         filters: InternalDashboardFilter[];
         tenantFilters?: InternalDashboardTenantFilter[];
@@ -2750,6 +2763,7 @@ declare const useDashboards: () => {
             startDate: Date;
             endDate: Date;
         };
+        clientId?: string;
     }) => Promise<void>;
     deleteDashboard: (name: string) => Promise<void>;
 };
@@ -2797,6 +2811,7 @@ type Table = {
     isSelectStar: boolean;
     displayName: string;
     name: string;
+    description?: string;
     columns: ColumnInternal[];
     viewQuery: string;
     customFieldInfo: any;
@@ -3117,14 +3132,73 @@ declare const useVirtualTables: () => {
     }>;
 };
 
-type ChangelogEntry = {
-    _id?: string;
-    entityId?: string;
-    entityType?: string;
+type ClientFeatures = {
+    cloudCache?: boolean;
+    [key: string]: boolean | undefined;
 };
-declare const useChangelogRefresh: () => {
-    refreshChangelogEntries: (entries: ChangelogEntry[], client: any) => Promise<void>;
+type QuillProviderClient = {
+    name: string;
+    clientId: string;
+    publicKey: string;
+    queryEndpoint: string;
+    streamEndpoint?: string;
+    queryHeaders?: HeadersInit;
+    withCredentials: boolean;
+    databaseType?: string;
+    features?: ClientFeatures;
+    featureFlags?: {
+        [key: string]: boolean;
+    };
+    /** @deprecated Use clerkOrgId instead */
+    domainName?: string;
+    clerkOrgId: string;
+    allTenantTypes?: QuillTenant[];
+    defaultDashboard?: {
+        name: string;
+        owner: string;
+    };
+    schemaNames?: string[];
 };
+type QuillTenant = {
+    name: string;
+    tenantField: string;
+    query?: string;
+    mappings?: {
+        [key: string]: {
+            query: string;
+        };
+    };
+    flags?: string[];
+    tenantIds?: {
+        id: string | number;
+        flag: string;
+        label: string;
+    }[];
+    scope: 'row' | 'schema' | 'database';
+    defaultId?: string | number;
+    fieldType?: 'string' | 'number' | 'none';
+};
+
+interface QuillFetchOptions {
+    client: Pick<QuillProviderClient, 'clientId' | 'queryEndpoint' | 'queryHeaders' | 'withCredentials'>;
+    task: string;
+    method?: string;
+    metadata: any;
+    abortSignal?: AbortSignal;
+    credentials?: RequestCredentials;
+    urlParameters?: string;
+    adminMode?: boolean;
+    getToken: () => Promise<string>;
+}
+interface QuillResults {
+    data?: any;
+    queries?: any;
+    status?: string;
+    error?: string;
+    message?: string;
+}
+
+declare const quillFetch: ({ client, task, method, metadata, abortSignal, credentials, urlParameters, getToken, }: QuillFetchOptions) => Promise<QuillResults>;
 
 declare const downloadCSV: (data: {
     rows: any[];
@@ -3692,4 +3766,4 @@ interface ReportTableProps {
 }
 declare const ReportTable: ({ reportBuilder, TableComponent, }: ReportTableProps) => react_jsx_runtime.JSX.Element;
 
-export { ALL_TENANTS, AddColumns, AddFilters, AddLimit, AddPivot, AddSort, type AxisFormat, type ButtonComponentProps, Calculation, type ChangelogEntry, Chart, ChartDisplay, ChartEditor, type ChartEditorProps, type ChartProps, Chat, type ChatProps, type CheckboxComponentProps, type ColorMapType, type Column$1 as Column, type ContainerComponentProps, Dashboard, type DashboardDateFilter, type DashboardFilter, DashboardFilterType, DashboardLegacy, type DashboardLegacyProps, type DashboardMultiFilter, type DashboardProps, type DashboardSectionComponentProps, type DashboardSingleFilter, type DashboardTenantFilter, 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 FilterPopoverComponentProps, FilterType, type HeaderComponentProps, type HeaderProps, type InternalDashboardDateFilter, type InternalDashboardTenantFilter, type InternalFilter, type LabelComponentProps, type LimitPopoverComponentProps, type ModalComponentProps, NullOperator, NumberOperator, type Option, type Pivot, type PopoverComponentProps, type QuillCustomInterval, type QuillCustomRelativeInterval, type QuillCustomRepeatingInterval, type QuillCustomStaticInterval, type QuillPreviousMonthInterval, type QuillPreviousQuarterInterval, QuillProvider, type QuillProviderProps, type QuillReport, type QuillReportProps, type QuillTheme, type QuillWeekInterval, ReportBuilder$1 as ReportBuilder, type ReportBuilderColumn, type ReportBuilderLimit, type ReportBuilderProps, type ReportBuilderSort, type ReportBuilderState, ReportTable, SINGLE_TENANT, SQLEditor, type SQLEditorProps, SaveReport, SchemaListComponent, type SelectColumnComponentProps, type SelectComponentProps, type SidebarComponentProps, type SidebarHeadingComponentProps, type SortPopoverComponentProps, StaticChart, type StaticChartProps, StringOperator, Table$1 as Table, type TableComponentProps, type TableProps, type TabsComponentProps, type TextComponentProps, type TextInputComponentProps, ThemeContext, downloadCSV, quillFormat as format, useAllReports, useAskQuill, useChangelogRefresh, useDashboard, useDashboardInternal, useDashboardReport, useDashboardReports, useDashboards, useExport, useForm, useMemoizedRows, useQuill, useReportBuilder, useReports, useTenants, useVirtualTables };
+export { ALL_TENANTS, AddColumns, AddFilters, AddLimit, AddPivot, AddSort, type AxisFormat, type ButtonComponentProps, Calculation, type ChangelogEntry, Chart, ChartDisplay, ChartEditor, type ChartEditorProps, type ChartProps, Chat, type ChatProps, type CheckboxComponentProps, type ColorMapType, type Column$1 as Column, type ContainerComponentProps, Dashboard, type DashboardDateFilter, type DashboardFilter, DashboardFilterType, DashboardLegacy, type DashboardLegacyProps, type DashboardMultiFilter, type DashboardProps, type DashboardSectionComponentProps, type DashboardSingleFilter, type DashboardTenantFilter, 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 FilterPopoverComponentProps, FilterType, type HeaderComponentProps, type HeaderProps, type InternalDashboardDateFilter, type InternalDashboardTenantFilter, type InternalFilter, type LabelComponentProps, type LimitPopoverComponentProps, type ModalComponentProps, NullOperator, NumberOperator, type Option, type Pivot, type PopoverComponentProps, 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, ReportTable, SINGLE_TENANT, SQLEditor, type SQLEditorProps, SaveReport, SchemaListComponent, type SelectColumnComponentProps, type SelectComponentProps, type SidebarComponentProps, type SidebarHeadingComponentProps, type SortPopoverComponentProps, StaticChart, type StaticChartProps, StringOperator, Table$1 as Table, type TableComponentProps, type TableProps, type TabsComponentProps, type TextComponentProps, type TextInputComponentProps, ThemeContext, downloadCSV, quillFormat as format, quillFetch, useAllReports, useAskQuill, useChangelogRefresh, useDashboard, useDashboardInternal, useDashboardReport, useDashboardReports, useDashboards, useExport, useForm, useMemoizedRows, useQuill, useReportBuilder, useReports, useTenants, useVirtualTables };

package/dist/index.d.ts

@@ -1079,8 +1079,9 @@ interface DashboardProps {
     name: string;
     onClickReport: (report: QuillReport) => void;
     containerStyle?: CSSProperties;
+    EmptyDashboardComponent?: () => React.JSX.Element;
 }
-declare function Dashboard({ name, onClickReport, containerStyle, }: DashboardProps & React.HTMLAttributes<HTMLDivElement>): react_jsx_runtime.JSX.Element;
+declare function Dashboard({ name, onClickReport, containerStyle, EmptyDashboardComponent, }: DashboardProps & React.HTMLAttributes<HTMLDivElement>): react_jsx_runtime.JSX.Element;
 
 type DashboardConfig = {
     dashboardId: string;
@@ -1204,6 +1205,16 @@ interface EventTracking {
     addBreadcrumb?: (breadcrumb: EventBreadcrumb) => void;
 }
 
+type ChangelogEntry = {
+    _id?: string;
+    entityId?: string;
+    entityType?: string;
+    changeObject?: unknown;
+};
+declare const useChangelogRefresh: () => {
+    refreshChangelogEntries: (entries: ChangelogEntry[], client: any) => Promise<void>;
+};
+
 interface BaseQuillProviderProps {
     publicKey: string;
     theme?: QuillTheme;
@@ -1213,6 +1224,7 @@ interface BaseQuillProviderProps {
     getAuthorizationToken?: () => Promise<string>;
     eventTracking?: EventTracking | null;
     streamEndpoint?: string;
+    onChangelogs?: (entries: ChangelogEntry[]) => void;
 }
 interface QuillCloudProviderProps extends BaseQuillProviderProps {
     tenants: {
@@ -1301,7 +1313,7 @@ type QuillProviderProps = QuillCloudProviderProps | SelfHostedProviderProps;
  * ### Dashboard API
  * @see https://docs.quillsql.com/components/quill-provider
  */
-declare const QuillProvider: ({ tenants, flags, publicKey, queryEndpoint, streamEndpoint, queryHeaders, children, theme, withCredentials, isAdmin, getAuthorizationToken, eventTracking, }: QuillProviderProps) => react_jsx_runtime.JSX.Element;
+declare const QuillProvider: ({ tenants, flags, publicKey, queryEndpoint, streamEndpoint, queryHeaders, children, theme, withCredentials, isAdmin, getAuthorizationToken, eventTracking, onChangelogs, }: QuillProviderProps) => react_jsx_runtime.JSX.Element;
 
 interface BaseChartProps {
     colors?: string[];
@@ -2732,14 +2744,15 @@ declare const useDashboards: () => {
         }[] | undefined;
     }[] | null;
     isLoading: boolean;
-    createDashboard: ({ name, tenantFilters, filters, dateFilter, dashboardOwners, }: {
+    createDashboard: ({ name, tenantFilters, filters, dateFilter, dashboardOwners, clientId, }: {
         name: string;
         tenantFilters?: InternalDashboardTenantFilter[];
         filters: InternalDashboardFilter[];
         dashboardOwners: string[];
         dateFilter?: InternalDashboardFilter;
+        clientId?: string;
     }) => Promise<void>;
-    updateDashboard: (name: string, { newName, filters, tenantFilters, dateFilter, customFilters, tenantKeys, initialCacheDateRange, }: {
+    updateDashboard: (name: string, { newName, filters, tenantFilters, dateFilter, customFilters, tenantKeys, initialCacheDateRange, clientId, }: {
         newName: string;
         filters: InternalDashboardFilter[];
         tenantFilters?: InternalDashboardTenantFilter[];
@@ -2750,6 +2763,7 @@ declare const useDashboards: () => {
             startDate: Date;
             endDate: Date;
         };
+        clientId?: string;
     }) => Promise<void>;
     deleteDashboard: (name: string) => Promise<void>;
 };
@@ -2797,6 +2811,7 @@ type Table = {
     isSelectStar: boolean;
     displayName: string;
     name: string;
+    description?: string;
     columns: ColumnInternal[];
     viewQuery: string;
     customFieldInfo: any;
@@ -3117,14 +3132,73 @@ declare const useVirtualTables: () => {
     }>;
 };
 
-type ChangelogEntry = {
-    _id?: string;
-    entityId?: string;
-    entityType?: string;
+type ClientFeatures = {
+    cloudCache?: boolean;
+    [key: string]: boolean | undefined;
 };
-declare const useChangelogRefresh: () => {
-    refreshChangelogEntries: (entries: ChangelogEntry[], client: any) => Promise<void>;
+type QuillProviderClient = {
+    name: string;
+    clientId: string;
+    publicKey: string;
+    queryEndpoint: string;
+    streamEndpoint?: string;
+    queryHeaders?: HeadersInit;
+    withCredentials: boolean;
+    databaseType?: string;
+    features?: ClientFeatures;
+    featureFlags?: {
+        [key: string]: boolean;
+    };
+    /** @deprecated Use clerkOrgId instead */
+    domainName?: string;
+    clerkOrgId: string;
+    allTenantTypes?: QuillTenant[];
+    defaultDashboard?: {
+        name: string;
+        owner: string;
+    };
+    schemaNames?: string[];
 };
+type QuillTenant = {
+    name: string;
+    tenantField: string;
+    query?: string;
+    mappings?: {
+        [key: string]: {
+            query: string;
+        };
+    };
+    flags?: string[];
+    tenantIds?: {
+        id: string | number;
+        flag: string;
+        label: string;
+    }[];
+    scope: 'row' | 'schema' | 'database';
+    defaultId?: string | number;
+    fieldType?: 'string' | 'number' | 'none';
+};
+
+interface QuillFetchOptions {
+    client: Pick<QuillProviderClient, 'clientId' | 'queryEndpoint' | 'queryHeaders' | 'withCredentials'>;
+    task: string;
+    method?: string;
+    metadata: any;
+    abortSignal?: AbortSignal;
+    credentials?: RequestCredentials;
+    urlParameters?: string;
+    adminMode?: boolean;
+    getToken: () => Promise<string>;
+}
+interface QuillResults {
+    data?: any;
+    queries?: any;
+    status?: string;
+    error?: string;
+    message?: string;
+}
+
+declare const quillFetch: ({ client, task, method, metadata, abortSignal, credentials, urlParameters, getToken, }: QuillFetchOptions) => Promise<QuillResults>;
 
 declare const downloadCSV: (data: {
     rows: any[];
@@ -3692,4 +3766,4 @@ interface ReportTableProps {
 }
 declare const ReportTable: ({ reportBuilder, TableComponent, }: ReportTableProps) => react_jsx_runtime.JSX.Element;
 
-export { ALL_TENANTS, AddColumns, AddFilters, AddLimit, AddPivot, AddSort, type AxisFormat, type ButtonComponentProps, Calculation, type ChangelogEntry, Chart, ChartDisplay, ChartEditor, type ChartEditorProps, type ChartProps, Chat, type ChatProps, type CheckboxComponentProps, type ColorMapType, type Column$1 as Column, type ContainerComponentProps, Dashboard, type DashboardDateFilter, type DashboardFilter, DashboardFilterType, DashboardLegacy, type DashboardLegacyProps, type DashboardMultiFilter, type DashboardProps, type DashboardSectionComponentProps, type DashboardSingleFilter, type DashboardTenantFilter, 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 FilterPopoverComponentProps, FilterType, type HeaderComponentProps, type HeaderProps, type InternalDashboardDateFilter, type InternalDashboardTenantFilter, type InternalFilter, type LabelComponentProps, type LimitPopoverComponentProps, type ModalComponentProps, NullOperator, NumberOperator, type Option, type Pivot, type PopoverComponentProps, type QuillCustomInterval, type QuillCustomRelativeInterval, type QuillCustomRepeatingInterval, type QuillCustomStaticInterval, type QuillPreviousMonthInterval, type QuillPreviousQuarterInterval, QuillProvider, type QuillProviderProps, type QuillReport, type QuillReportProps, type QuillTheme, type QuillWeekInterval, ReportBuilder$1 as ReportBuilder, type ReportBuilderColumn, type ReportBuilderLimit, type ReportBuilderProps, type ReportBuilderSort, type ReportBuilderState, ReportTable, SINGLE_TENANT, SQLEditor, type SQLEditorProps, SaveReport, SchemaListComponent, type SelectColumnComponentProps, type SelectComponentProps, type SidebarComponentProps, type SidebarHeadingComponentProps, type SortPopoverComponentProps, StaticChart, type StaticChartProps, StringOperator, Table$1 as Table, type TableComponentProps, type TableProps, type TabsComponentProps, type TextComponentProps, type TextInputComponentProps, ThemeContext, downloadCSV, quillFormat as format, useAllReports, useAskQuill, useChangelogRefresh, useDashboard, useDashboardInternal, useDashboardReport, useDashboardReports, useDashboards, useExport, useForm, useMemoizedRows, useQuill, useReportBuilder, useReports, useTenants, useVirtualTables };
+export { ALL_TENANTS, AddColumns, AddFilters, AddLimit, AddPivot, AddSort, type AxisFormat, type ButtonComponentProps, Calculation, type ChangelogEntry, Chart, ChartDisplay, ChartEditor, type ChartEditorProps, type ChartProps, Chat, type ChatProps, type CheckboxComponentProps, type ColorMapType, type Column$1 as Column, type ContainerComponentProps, Dashboard, type DashboardDateFilter, type DashboardFilter, DashboardFilterType, DashboardLegacy, type DashboardLegacyProps, type DashboardMultiFilter, type DashboardProps, type DashboardSectionComponentProps, type DashboardSingleFilter, type DashboardTenantFilter, 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 FilterPopoverComponentProps, FilterType, type HeaderComponentProps, type HeaderProps, type InternalDashboardDateFilter, type InternalDashboardTenantFilter, type InternalFilter, type LabelComponentProps, type LimitPopoverComponentProps, type ModalComponentProps, NullOperator, NumberOperator, type Option, type Pivot, type PopoverComponentProps, 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, ReportTable, SINGLE_TENANT, SQLEditor, type SQLEditorProps, SaveReport, SchemaListComponent, type SelectColumnComponentProps, type SelectComponentProps, type SidebarComponentProps, type SidebarHeadingComponentProps, type SortPopoverComponentProps, StaticChart, type StaticChartProps, StringOperator, Table$1 as Table, type TableComponentProps, type TableProps, type TabsComponentProps, type TextComponentProps, type TextInputComponentProps, ThemeContext, downloadCSV, quillFormat as format, quillFetch, useAllReports, useAskQuill, useChangelogRefresh, useDashboard, useDashboardInternal, useDashboardReport, useDashboardReports, useDashboards, useExport, useForm, useMemoizedRows, useQuill, useReportBuilder, useReports, useTenants, useVirtualTables };