@databrainhq/plugin 0.8.13 → 0.8.15

package/README.md

@@ -1,26 +1,26 @@
-# @databrainhq/plugin
-
-> Databrain app ui plugin.
-
-[![NPM](https://img.shields.io/npm/v/@databrainhq/plugin.svg)](https://www.npmjs.com/package/@databrainhq/plugin) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
-
-## Install
-
-```bash
-npm install @databrainhq/plugin
-```
-
-## Usage
-
-```tsx
-import { Dashboard } from '@databrainhq/plugin';
-import '@databrainhq/plugin/dist/style.css';
-
-const Example = () => {
-  return <Dashboard token={/* Your Guest Token */} />;
-};
-```
-
-## License
-
-MIT © [databrainhq](https://github.com/databrainhq)
+# @databrainhq/plugin
+
+> Databrain app ui plugin.
+
+[![NPM](https://img.shields.io/npm/v/@databrainhq/plugin.svg)](https://www.npmjs.com/package/@databrainhq/plugin) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+
+## Install
+
+```bash
+npm install @databrainhq/plugin
+```
+
+## Usage
+
+```tsx
+import { Dashboard } from '@databrainhq/plugin';
+import '@databrainhq/plugin/dist/style.css';
+
+const Example = () => {
+  return <Dashboard token={/* Your Guest Token */} />;
+};
+```
+
+## License
+
+MIT © [databrainhq](https://github.com/databrainhq)

package/dist/components/ChartPopup/index.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { GetUnderlyingData } from '@/types';
+import { ClickActionsConfig, GetUnderlyingData } from '@/types';
 export declare type ChartPopupProps = React.PropsWithChildren & {
     getUnderlyingData: GetUnderlyingData;
     value: any;
@@ -7,8 +7,11 @@ export declare type ChartPopupProps = React.PropsWithChildren & {
     menuClass?: string;
     menuContainerClass?: string;
     isOpen: boolean;
+    drilldown?: () => void;
+    clickBehaviourConfigs: ClickActionsConfig['chart'];
     setOpen: React.Dispatch<React.SetStateAction<boolean>>;
     position?: 'left' | 'right' | 'top' | 'bottom' | 'left-bottom-end' | 'right-bottom-end' | 'left-top-end' | 'right-top-end' | 'bottom-left' | 'bottom-right' | 'top-left' | 'top-right' | 'left-bottom' | 'left-top' | 'right-bottom' | 'right-top' | 'center';
 };
-declare const _default: React.MemoExoticComponent<({ position, menuContainerClass, menuClass, isOpen, setOpen, value, columnName, getUnderlyingData, }: ChartPopupProps) => JSX.Element>;
+export declare const ChartPopup: ({ position, menuContainerClass, menuClass, isOpen, setOpen, value, columnName, getUnderlyingData, drilldown, clickBehaviourConfigs, }: ChartPopupProps) => JSX.Element;
+declare const _default: React.MemoExoticComponent<({ position, menuContainerClass, menuClass, isOpen, setOpen, value, columnName, getUnderlyingData, drilldown, clickBehaviourConfigs, }: ChartPopupProps) => JSX.Element>;
 export default _default;

package/dist/components/Charts/AreaChart.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
-declare const AreaChart: ({ data, margins, legendSettings, labelSettings, axisSettings, colors, updateGroup, isEnableGroupBy, backGroundColor, customSettings, chartClickConfig, chartRef, handleChartRightClick, }: any) => JSX.Element;
+declare const AreaChart: ({ data, margins, legendSettings, labelSettings, axisSettings, colors, backGroundColor, customSettings, chartRef, handleChartRightClick, }: any) => JSX.Element;
 export default AreaChart;

package/dist/components/Charts/BarChart.d.ts

@@ -1,6 +1,5 @@
 import EChartsReact from 'echarts-for-react';
 import React from 'react';
-import { ClickActionsConfig } from '@/types';
 declare type Props = {
     data: {
         labels: string[] | undefined;
@@ -11,17 +10,14 @@ declare type Props = {
         }[] | undefined;
     };
     colors?: string[];
-    updateGroup?: (value: string) => void;
-    isEnableGroupBy?: boolean;
     backGroundColor: any;
     legendSettings: any;
     labelSettings: any;
     axisSettings: any;
     margins: any;
     customSettings: any;
-    chartClickConfig: ClickActionsConfig['chart'];
     chartRef: React.RefObject<EChartsReact>;
-    handleChartRightClick: (params: any) => void;
+    handleChartRightClick?: (params: any) => void;
 };
-declare const BarChart: ({ data, colors, updateGroup, isEnableGroupBy, backGroundColor, legendSettings, labelSettings, axisSettings, margins, customSettings, chartClickConfig, chartRef, handleChartRightClick, }: Props) => JSX.Element;
+declare const BarChart: ({ data, colors, backGroundColor, legendSettings, labelSettings, axisSettings, margins, customSettings, chartRef, handleChartRightClick, }: Props) => JSX.Element;
 export default BarChart;

package/dist/components/Charts/BoxPlot.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
-declare const BoxPlot: ({ data, margins, legendSettings, axisSettings, colors, customSettings, chartClickConfig, chartRef, handleChartRightClick, }: any) => JSX.Element;
+declare const BoxPlot: ({ data, margins, legendSettings, axisSettings, colors, customSettings, chartRef, handleChartRightClick, }: any) => JSX.Element;
 export default BoxPlot;

package/dist/components/Charts/BubbleChart.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
-declare const BubbleChart: ({ data, margins, legendSettings, labelSettings, axisSettings, colors, updateGroup, isEnableGroupBy, customSettings, chartClickConfig, chartRef, handleChartRightClick, }: any) => JSX.Element;
+declare const BubbleChart: ({ data, margins, legendSettings, labelSettings, axisSettings, colors, customSettings, chartRef, handleChartRightClick, }: any) => JSX.Element;
 export default BubbleChart;

package/dist/components/Charts/ComboChart.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
-declare const ComboChart: ({ data, margins, legendSettings, labelSettings, colors, updateGroup, isEnableGroupBy, backGroundColor, customSettings, chartClickConfig, chartRef, handleChartRightClick, }: any) => JSX.Element;
+declare const ComboChart: ({ data, margins, legendSettings, labelSettings, colors, backGroundColor, customSettings, chartRef, handleChartRightClick, }: any) => JSX.Element;
 export default ComboChart;

package/dist/components/Charts/DoughnutChart.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
-declare const DoughnutChart: ({ data, margins, legendSettings, labelSettings, colors, updateGroup, isEnableGroupBy, chartClickConfig, chartRef, handleChartRightClick, }: any) => JSX.Element;
+declare const DoughnutChart: ({ data, margins, legendSettings, labelSettings, colors, chartRef, handleChartRightClick, }: any) => JSX.Element;
 export default DoughnutChart;

package/dist/components/Charts/FunnelChart.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
-declare const FunnelChart: ({ funnelData, margins, legendSettings, labelSettings, colors, chartClickConfig, chartRef, handleChartRightClick, customSettings, }: any) => JSX.Element;
+declare const FunnelChart: ({ funnelData, margins, legendSettings, labelSettings, colors, chartRef, handleChartRightClick, customSettings, }: any) => JSX.Element;
 export default FunnelChart;

package/dist/components/Charts/GaugeChart.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
-declare const GaugeChart: ({ gaugeData, margins, legendSettings, colors, chartClickConfig, chartRef, handleChartRightClick, }: any) => JSX.Element;
+declare const GaugeChart: ({ gaugeData, margins, legendSettings, colors, chartRef, handleChartRightClick, }: any) => JSX.Element;
 export default GaugeChart;

package/dist/components/Charts/Histogram.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
-declare const Histogram: ({ data, margins, legendSettings, labelSettings, axisSettings, chartRef, colors, updateGroup, isEnableGroupBy, backGroundColor, customSettings, chartClickConfig, handleChartRightClick, }: any) => JSX.Element;
+declare const Histogram: ({ data, margins, legendSettings, labelSettings, axisSettings, chartRef, colors, backGroundColor, customSettings, handleChartRightClick, }: any) => JSX.Element;
 export default Histogram;

package/dist/components/Charts/LineChart.d.ts

@@ -1,7 +1,6 @@
 import EChartsReact from 'echarts-for-react';
 import React from 'react';
 import { AxisSettings, CustomSettings, LabelSettings, LegendSettings } from '@/types/app';
-import { ClickActionsConfig } from '@/types';
 declare type Props = {
     data: {
         labels: string[] | undefined;
@@ -16,12 +15,9 @@ declare type Props = {
     labelSettings: LabelSettings;
     axisSettings: AxisSettings;
     colors?: string[];
-    updateGroup?: (value: string) => void;
-    isEnableGroupBy?: boolean;
     customSettings: CustomSettings;
-    chartClickConfig: ClickActionsConfig['chart'];
     chartRef: React.RefObject<EChartsReact>;
-    handleChartRightClick: (params: any) => void;
+    handleChartRightClick?: (params: any) => void;
 };
-declare const LineChart: ({ data, margins, legendSettings, labelSettings, axisSettings, colors, updateGroup, isEnableGroupBy, customSettings, chartClickConfig, chartRef, handleChartRightClick, }: Props) => JSX.Element;
+declare const LineChart: ({ data, margins, legendSettings, labelSettings, axisSettings, colors, customSettings, chartRef, handleChartRightClick, }: Props) => JSX.Element;
 export default LineChart;

package/dist/components/Charts/PieChart.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
-declare const PieChart: ({ data, margins, legendSettings, labelSettings, chartRef, colors, updateGroup, isEnableGroupBy, chartClickConfig, handleChartRightClick, }: any) => JSX.Element;
+declare const PieChart: ({ data, margins, legendSettings, labelSettings, chartRef, colors, handleChartRightClick, }: any) => JSX.Element;
 export default PieChart;

package/dist/components/Charts/RowChart.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
-declare const RowChart: ({ data, margins, legendSettings, labelSettings, chartRef, colors, updateGroup, isEnableGroupBy, backGroundColor, customSettings, chartClickConfig, handleChartRightClick, }: any) => JSX.Element;
+declare const RowChart: ({ data, margins, legendSettings, labelSettings, chartRef, colors, backGroundColor, customSettings, handleChartRightClick, }: any) => JSX.Element;
 export default RowChart;

package/dist/components/Charts/SankeyChart.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
-declare const SankeyChart: ({ data, margins, chartRef, colors, backGroundColor, chartClickConfig, handleChartRightClick, }: any) => JSX.Element;
+declare const SankeyChart: ({ data, margins, chartRef, colors, backGroundColor, handleChartRightClick, }: any) => JSX.Element;
 export default SankeyChart;

package/dist/components/Charts/ScatterChart.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
-declare const ScatterChart: ({ data, margins, legendSettings, labelSettings, axisSettings, chartRef, colors, updateGroup, isEnableGroupBy, backGroundColor, customSettings, chartClickConfig, handleChartRightClick, }: any) => JSX.Element;
+declare const ScatterChart: ({ data, margins, legendSettings, labelSettings, axisSettings, chartRef, colors, isEnableGroupBy, backGroundColor, customSettings, handleChartRightClick, }: any) => JSX.Element;
 export default ScatterChart;

package/dist/components/Charts/StackedBarChart.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
-declare const StackedBarChart: ({ data, margins, legendSettings, labelSettings, axisSettings, chartRef, colors, updateGroup, isEnableGroupBy, backGroundColor, customSettings, chartClickConfig, handleChartRightClick, }: any) => JSX.Element;
+declare const StackedBarChart: ({ data, margins, legendSettings, labelSettings, axisSettings, chartRef, colors, backGroundColor, customSettings, handleChartRightClick, }: any) => JSX.Element;
 export default StackedBarChart;

package/dist/components/Charts/SteppedAreaChart.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
-declare const SteppedAreaChart: ({ data, margins, legendSettings, labelSettings, axisSettings, chartRef, colors, updateGroup, isEnableGroupBy, backGroundColor, customSettings, chartClickConfig, handleChartRightClick, }: any) => JSX.Element;
+declare const SteppedAreaChart: ({ data, margins, legendSettings, labelSettings, axisSettings, chartRef, colors, backGroundColor, customSettings, handleChartRightClick, }: any) => JSX.Element;
 export default SteppedAreaChart;

package/dist/components/Charts/WaterfallChart.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
-declare const WaterFallChart: ({ data, margins, labelSettings, axisSettings, chartRef, colors, updateGroup, isEnableGroupBy, backGroundColor, customSettings, chartClickConfig, handleChartRightClick, }: any) => JSX.Element;
+declare const WaterFallChart: ({ data, margins, labelSettings, axisSettings, chartRef, colors, backGroundColor, customSettings, handleChartRightClick, }: any) => JSX.Element;
 export default WaterFallChart;

package/dist/components/DrillBreadCrumb/index.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+export declare const DrillBreadCrumb: ({ dimensions, drilledLevel, }: {
+    dimensions: string[];
+    drilledLevel: number;
+}) => JSX.Element;
+export default DrillBreadCrumb;

package/dist/components/MetricChart/MetricChart.d.ts

@@ -29,13 +29,11 @@ export declare type MetricChartProps = {
     customSettings: CustomSettings;
     enableSaveAs: boolean;
     colors?: string[];
-    updateGroup?: (value: string) => void;
-    isEnableGroupBy?: boolean;
     backGroundColor: BackgroundSettings;
     chartClickConfig: ClickActionsConfig['chart'];
     tableSettings: TableSettings;
     chartRef: React.RefObject<EChartsReact>;
     tableName?: string;
-    handleChartRightClick: (params: any) => void;
+    handleChartRightClick?: (params: any) => void;
 };
-export declare const MetricChart: ({ labels, data, chartType, funnelData, sankeyData, singleValueData, margins, legendSettings, labelSettings, axisSettings, customSettings, enableSaveAs, colors, updateGroup, isEnableGroupBy, backGroundColor, chartClickConfig, tableSettings, chartRef, tableName, handleChartRightClick, }: MetricChartProps) => JSX.Element;
+export declare const MetricChart: ({ labels, data, chartType, funnelData, sankeyData, singleValueData, margins, legendSettings, labelSettings, axisSettings, customSettings, enableSaveAs, colors, backGroundColor, chartClickConfig, tableSettings, chartRef, tableName, handleChartRightClick, }: MetricChartProps) => JSX.Element;

package/dist/components/MetricCreation/components/ConstructMetric/ConstructMetric.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
 import { ConstructMetricProps } from '@/types/metricCreate';
-export declare const ConstructMetric: ({ dateTimeColumnList, columnList, database, companyId, tableName, setData, setError, setLoading, setQuery, isEnableGroupBy, setEnableGroupBy, setSelectedGroupBy, clientId, clientColumn, }: ConstructMetricProps) => JSX.Element;
+export declare const ConstructMetric: ({ dateTimeColumnList, columnList, database, companyId, tableName, setData, setError, setLoading, setQuery, clientId, clientColumn, }: ConstructMetricProps) => JSX.Element;

package/dist/components/MetricCreation/components/ConstructMetric/components/MetricForm/index.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
 import { ConstructMetricProps } from '@/types/metricCreate';
-export declare const MetricForm: ({ dateTimeColumnList, columnList, database, companyId, tableName, setData, setError, setLoading, setQuery, isEnableGroupBy, setSelectedGroupBy, clientId, clientColumn, }: ConstructMetricProps) => JSX.Element;
+export declare const MetricForm: ({ dateTimeColumnList, columnList, database, companyId, tableName, setData, setError, setLoading, setQuery, clientId, clientColumn, }: ConstructMetricProps) => JSX.Element;

package/dist/components/MetricCreation/components/MetricOutput/MetricOutput.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
 import { MetricOutputProps } from '@/types/metricCreate';
-export declare const MetricOutput: ({ data, error, isLoading, labels, funnelData, chartType, datasets, setChartType, setXAxis, setYAxisList, yAxisList, xAxis, setMeasure, setStep, step, measure, setSankeyValues, sankeyData, previewTableDataList, singleValue, setSingleValue, singleValueData, setMargins, margins, legendSettings, setLegendSettings, labelSettings, setLabelSettings, axisSettings, setAxisSettings, customSettings, setCustomSettings, tableSettings, setTableSettings, updateGroup, isEnableGroupBy, backGroundColor, setBackGroundColor, moreTabs, chartColors, isUpdateMetric, }: MetricOutputProps) => JSX.Element;
+export declare const MetricOutput: ({ data, error, isLoading, labels, funnelData, chartType, datasets, setChartType, setXAxis, setYAxisList, yAxisList, xAxis, setMeasure, setStep, step, measure, setSankeyValues, sankeyData, previewTableDataList, singleValue, setSingleValue, singleValueData, setMargins, margins, legendSettings, setLegendSettings, labelSettings, setLabelSettings, axisSettings, setAxisSettings, customSettings, setCustomSettings, tableSettings, setTableSettings, backGroundColor, setBackGroundColor, moreTabs, chartColors, isUpdateMetric, }: MetricOutputProps) => JSX.Element;

package/dist/components/MetricCreation/components/MetricOutput/components/ChartTab/index.d.ts

@@ -1,5 +1,6 @@
 import React from 'react';
 import { AxisSettings, LabelSettings, LegendSettings, BackgroundSettings, CustomSettings, TableSettings } from '@/types/app';
+import { ClickActionsConfig } from '@/types';
 declare type Props = {
     data: any[] | undefined;
     labels: string[] | undefined;
@@ -40,16 +41,17 @@ declare type Props = {
     setAxisSettings: React.Dispatch<React.SetStateAction<AxisSettings>>;
     customSettings: CustomSettings;
     setCustomSettings: React.Dispatch<React.SetStateAction<CustomSettings>>;
-    updateGroup?: (value: string) => void;
-    isEnableGroupBy?: boolean;
     isLoading: boolean;
     backGroundColor: BackgroundSettings;
     setBackGroundColor: React.Dispatch<React.SetStateAction<BackgroundSettings>>;
     headerChild?: JSX.Element;
+    chartPopupChild?: JSX.Element;
     tableSettings: TableSettings;
     setTableSettings: React.Dispatch<React.SetStateAction<TableSettings>>;
     tableName?: string;
     chartColors?: string[];
+    handleChartRightClick?: (params: any) => void;
+    chartClickConfig?: ClickActionsConfig['chart'];
 };
-export declare const ChartTab: ({ labels, datasets, funnelData, chartType, setChartType, data, setXAxis, setYAxisList, yAxisList, xAxis, setMeasure, setStep, step, measure, setSankeyValues, sankeyData, singleValue, setSingleValue, singleValueData, setMargins, margins, legendSettings, setLegendSettings, labelSettings, setLabelSettings, customSettings, setCustomSettings, axisSettings, setAxisSettings, updateGroup, isLoading, isEnableGroupBy, backGroundColor, setBackGroundColor, headerChild, tableSettings, setTableSettings, tableName, chartColors, }: Props) => JSX.Element;
+export declare const ChartTab: ({ labels, datasets, funnelData, chartType, setChartType, data, setXAxis, setYAxisList, yAxisList, xAxis, setMeasure, setStep, step, measure, setSankeyValues, sankeyData, singleValue, setSingleValue, singleValueData, setMargins, margins, legendSettings, setLegendSettings, labelSettings, setLabelSettings, customSettings, setCustomSettings, axisSettings, setAxisSettings, isLoading, backGroundColor, setBackGroundColor, headerChild, tableSettings, setTableSettings, tableName, chartColors, handleChartRightClick, chartClickConfig, chartPopupChild, }: Props) => JSX.Element;
 export {};

package/dist/components/index.d.ts

@@ -26,3 +26,5 @@ export * from './TextAreaField';
 export * from './TimeGrainField';
 export * from './ToggleButton';
 export * from './Icons';
+export * from './ChartPopup';
+export * from './DrillBreadCrumb';

package/dist/helpers/groupBy.d.ts

@@ -1,6 +1,10 @@
+import { DrillDownSetting } from '@/types';
 export declare const groupByMultipleKeys: (rawData: any[] | undefined, keys: string[], measureKey: string) => any;
+export declare const groupMeasures: (rawData: any[] | undefined, dimensionKey: string, measureKeys: string[]) => any;
 export declare const updateGroupData: (data: any[] | undefined, keys: string[], selectedGroupBy: string[], setGroupedData: (value: React.SetStateAction<Record<string, any>[]>) => void) => void;
+export declare const updateDrilledData: (data: any[] | undefined, setGroupedData: (value: React.SetStateAction<Record<string, any>[]>) => void, measureKeys: string[], dimenstionKey: string) => void;
 export declare const findKeys: (obj: Record<string, any>) => {
     numberKeys: string[];
     stringKeys: string[];
 };
+export declare const drilldown: (columnName: string | undefined, chartParams: any, drillDownSettings: DrillDownSetting | undefined, data: any[] | undefined, setDrilledLevel: React.Dispatch<React.SetStateAction<number>>, drilledLevel: number, setShowChartPopup: React.Dispatch<React.SetStateAction<boolean>>, setGroupedData: React.Dispatch<React.SetStateAction<Record<string, any>[]>>) => void;

package/dist/hooks/index.d.ts

@@ -5,3 +5,4 @@ export * from './useGenerateEmbeddedMetric';
 export * from './useOutsideAlerter';
 export * from './useApplyAdminTheme';
 export * from './useClientDashboardLayout';
+export * from './useUnderlyingData';

package/dist/hooks/useEmbeddedDashboard.d.ts

@@ -35,6 +35,7 @@ export declare const useEmbeddedDashboard: (token: string) => {
                 groupBy: any;
                 rlsConditions: any;
                 clickActions: any;
+                drillDownSettings?: any;
                 companyIntegration: {
                     __typename?: "companyIntegrations" | undefined;
                     name: string;

package/dist/hooks/useUnderlyingData.d.ts

@@ -1,4 +1,4 @@
-declare const useUnderlyingData: ({ clientName, tenancyType, values, query, companyId, }: {
+export declare const useUnderlyingData: ({ clientName, tenancyType, values, query, companyId, }: {
     clientName?: string | undefined;
     tenancyType?: string | undefined;
     values?: Record<string, string> | undefined;