@quillsql/react 2.16.19 → 2.16.21

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
@@ -469,6 +469,10 @@ interface InternalDashboardDateFilter extends InternalDashboardBaseFilter {
469
469
  label: string;
470
470
  value: string;
471
471
  };
472
+ initialCacheDateRange?: {
473
+ startDate?: Date;
474
+ endDate?: Date;
475
+ };
472
476
  startDate?: Date;
473
477
  endDate?: Date;
474
478
  comparisonRange?: {
@@ -647,6 +651,8 @@ interface QuillReport {
647
651
  columns: Column$1[];
648
652
  /** The type of this chart. */
649
653
  chartType: string;
654
+ /** Whether to show a legend for this chart. */
655
+ showLegend?: boolean;
650
656
  /** The table and field this report uses for date filtering, if any. */
651
657
  dateField?: {
652
658
  table: string;
@@ -1072,6 +1078,10 @@ type DashboardConfig = {
1072
1078
  allTenantFilters?: InternalDashboardTenantFilter[];
1073
1079
  tenantFilters?: InternalDashboardTenantFilter[];
1074
1080
  dateFilter?: InternalDashboardDateFilter;
1081
+ initialCacheDateRange?: {
1082
+ startDate: Date;
1083
+ endDate: Date;
1084
+ };
1075
1085
  customFiltersEnabled?: boolean;
1076
1086
  sections?: {
1077
1087
  [key: string]: QuillReport[];
@@ -1449,8 +1459,10 @@ interface ChartProps {
1449
1459
  dateBucket?: string;
1450
1460
  /** Whether to send updated data in the chart to its owning dashboard */
1451
1461
  propagateChanges?: boolean;
1462
+ /** Whether the chart is rendered in admin mode. */
1463
+ isAdmin?: boolean;
1452
1464
  }
1453
- declare function Chart({ colors, reportId, className, containerStyle, isAnimationActive, hideXAxis, hideYAxis, hideCartesianGrid, hideHorizontalCartesianGrid, hideVerticalCartesianGrid, hideSubsequentXAxisTicks, cartesianGridLineStyle, cartesianGridLineColor, comparisonLineStyle, hideDateRangeFilter, hideFilters, mapColorsToFields, LoadingComponent, SelectComponent, MultiSelectComponent, DateRangePickerComponent, FilterContainerComponent, TableComponent, MetricComponent, filters, onClickChartElement, dateBucket, propagateChanges, }: ChartProps): react_jsx_runtime.JSX.Element;
1465
+ declare function Chart({ colors, reportId, className, containerStyle, isAnimationActive, hideXAxis, hideYAxis, hideCartesianGrid, hideHorizontalCartesianGrid, hideVerticalCartesianGrid, hideSubsequentXAxisTicks, cartesianGridLineStyle, cartesianGridLineColor, comparisonLineStyle, hideDateRangeFilter, hideFilters, mapColorsToFields, LoadingComponent, SelectComponent, MultiSelectComponent, DateRangePickerComponent, FilterContainerComponent, TableComponent, MetricComponent, filters, onClickChartElement, dateBucket, propagateChanges, isAdmin, }: ChartProps): react_jsx_runtime.JSX.Element;
1454
1466
 
1455
1467
  /**
1456
1468
  * Props for the Quill Table component.
@@ -2539,6 +2551,8 @@ declare const useDashboardInternal: (dashboardName: string | null, customFilters
2539
2551
  filters: InternalDashboardFilter[];
2540
2552
  editedFilterLabel?: string;
2541
2553
  refetchReports?: boolean;
2554
+ }, options?: {
2555
+ preserveExistingDateFilter?: boolean;
2542
2556
  }) => Promise<void>;
2543
2557
  setSectionOrder: (sectionOrder: {
2544
2558
  section: string;
@@ -2579,18 +2593,25 @@ declare const useDashboards: () => {
2579
2593
  dashboardOwners: string[];
2580
2594
  dateFilter?: InternalDashboardFilter;
2581
2595
  }) => Promise<void>;
2582
- updateDashboard: (name: string, { newName, filters, tenantFilters, dateFilter, customFilters, tenantKeys, }: {
2596
+ updateDashboard: (name: string, { newName, filters, tenantFilters, dateFilter, customFilters, tenantKeys, initialCacheDateRange, }: {
2583
2597
  newName: string;
2584
2598
  filters: InternalDashboardFilter[];
2585
2599
  tenantFilters?: InternalDashboardTenantFilter[];
2586
2600
  dateFilter?: InternalDashboardFilter;
2587
2601
  customFilters?: InternalFilter[];
2588
2602
  tenantKeys?: string[];
2603
+ initialCacheDateRange?: {
2604
+ startDate: Date;
2605
+ endDate: Date;
2606
+ };
2589
2607
  }) => Promise<void>;
2590
2608
  deleteDashboard: (name: string) => Promise<void>;
2591
2609
  };
2592
2610
  declare const useDashboard: (dashboardName: string, config?: {
2593
2611
  pageSize?: number;
2612
+ cacheEnabled?: boolean;
2613
+ cacheType?: "memory" | "idb";
2614
+ showCacheLogs?: boolean;
2594
2615
  }) => {
2595
2616
  isLoading: boolean;
2596
2617
  sections: Record<string, QuillReport[]> | null;
@@ -2602,6 +2623,8 @@ declare const useDashboard: (dashboardName: string, config?: {
2602
2623
  endDate?: Date;
2603
2624
  };
2604
2625
  } | Filter>) => void;
2626
+ lastUpdated: number;
2627
+ forceCacheRefresh: () => void;
2605
2628
  };
2606
2629
  declare const useDashboardReport: (reportId: string, config?: {
2607
2630
  initialFilters?: Filter[];
package/dist/index.d.ts CHANGED
@@ -469,6 +469,10 @@ interface InternalDashboardDateFilter extends InternalDashboardBaseFilter {
469
469
  label: string;
470
470
  value: string;
471
471
  };
472
+ initialCacheDateRange?: {
473
+ startDate?: Date;
474
+ endDate?: Date;
475
+ };
472
476
  startDate?: Date;
473
477
  endDate?: Date;
474
478
  comparisonRange?: {
@@ -647,6 +651,8 @@ interface QuillReport {
647
651
  columns: Column$1[];
648
652
  /** The type of this chart. */
649
653
  chartType: string;
654
+ /** Whether to show a legend for this chart. */
655
+ showLegend?: boolean;
650
656
  /** The table and field this report uses for date filtering, if any. */
651
657
  dateField?: {
652
658
  table: string;
@@ -1072,6 +1078,10 @@ type DashboardConfig = {
1072
1078
  allTenantFilters?: InternalDashboardTenantFilter[];
1073
1079
  tenantFilters?: InternalDashboardTenantFilter[];
1074
1080
  dateFilter?: InternalDashboardDateFilter;
1081
+ initialCacheDateRange?: {
1082
+ startDate: Date;
1083
+ endDate: Date;
1084
+ };
1075
1085
  customFiltersEnabled?: boolean;
1076
1086
  sections?: {
1077
1087
  [key: string]: QuillReport[];
@@ -1449,8 +1459,10 @@ interface ChartProps {
1449
1459
  dateBucket?: string;
1450
1460
  /** Whether to send updated data in the chart to its owning dashboard */
1451
1461
  propagateChanges?: boolean;
1462
+ /** Whether the chart is rendered in admin mode. */
1463
+ isAdmin?: boolean;
1452
1464
  }
1453
- declare function Chart({ colors, reportId, className, containerStyle, isAnimationActive, hideXAxis, hideYAxis, hideCartesianGrid, hideHorizontalCartesianGrid, hideVerticalCartesianGrid, hideSubsequentXAxisTicks, cartesianGridLineStyle, cartesianGridLineColor, comparisonLineStyle, hideDateRangeFilter, hideFilters, mapColorsToFields, LoadingComponent, SelectComponent, MultiSelectComponent, DateRangePickerComponent, FilterContainerComponent, TableComponent, MetricComponent, filters, onClickChartElement, dateBucket, propagateChanges, }: ChartProps): react_jsx_runtime.JSX.Element;
1465
+ declare function Chart({ colors, reportId, className, containerStyle, isAnimationActive, hideXAxis, hideYAxis, hideCartesianGrid, hideHorizontalCartesianGrid, hideVerticalCartesianGrid, hideSubsequentXAxisTicks, cartesianGridLineStyle, cartesianGridLineColor, comparisonLineStyle, hideDateRangeFilter, hideFilters, mapColorsToFields, LoadingComponent, SelectComponent, MultiSelectComponent, DateRangePickerComponent, FilterContainerComponent, TableComponent, MetricComponent, filters, onClickChartElement, dateBucket, propagateChanges, isAdmin, }: ChartProps): react_jsx_runtime.JSX.Element;
1454
1466
 
1455
1467
  /**
1456
1468
  * Props for the Quill Table component.
@@ -2539,6 +2551,8 @@ declare const useDashboardInternal: (dashboardName: string | null, customFilters
2539
2551
  filters: InternalDashboardFilter[];
2540
2552
  editedFilterLabel?: string;
2541
2553
  refetchReports?: boolean;
2554
+ }, options?: {
2555
+ preserveExistingDateFilter?: boolean;
2542
2556
  }) => Promise<void>;
2543
2557
  setSectionOrder: (sectionOrder: {
2544
2558
  section: string;
@@ -2579,18 +2593,25 @@ declare const useDashboards: () => {
2579
2593
  dashboardOwners: string[];
2580
2594
  dateFilter?: InternalDashboardFilter;
2581
2595
  }) => Promise<void>;
2582
- updateDashboard: (name: string, { newName, filters, tenantFilters, dateFilter, customFilters, tenantKeys, }: {
2596
+ updateDashboard: (name: string, { newName, filters, tenantFilters, dateFilter, customFilters, tenantKeys, initialCacheDateRange, }: {
2583
2597
  newName: string;
2584
2598
  filters: InternalDashboardFilter[];
2585
2599
  tenantFilters?: InternalDashboardTenantFilter[];
2586
2600
  dateFilter?: InternalDashboardFilter;
2587
2601
  customFilters?: InternalFilter[];
2588
2602
  tenantKeys?: string[];
2603
+ initialCacheDateRange?: {
2604
+ startDate: Date;
2605
+ endDate: Date;
2606
+ };
2589
2607
  }) => Promise<void>;
2590
2608
  deleteDashboard: (name: string) => Promise<void>;
2591
2609
  };
2592
2610
  declare const useDashboard: (dashboardName: string, config?: {
2593
2611
  pageSize?: number;
2612
+ cacheEnabled?: boolean;
2613
+ cacheType?: "memory" | "idb";
2614
+ showCacheLogs?: boolean;
2594
2615
  }) => {
2595
2616
  isLoading: boolean;
2596
2617
  sections: Record<string, QuillReport[]> | null;
@@ -2602,6 +2623,8 @@ declare const useDashboard: (dashboardName: string, config?: {
2602
2623
  endDate?: Date;
2603
2624
  };
2604
2625
  } | Filter>) => void;
2626
+ lastUpdated: number;
2627
+ forceCacheRefresh: () => void;
2605
2628
  };
2606
2629
  declare const useDashboardReport: (reportId: string, config?: {
2607
2630
  initialFilters?: Filter[];