@databrainhq/plugin 0.12.12 → 0.12.14

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

@@ -14,6 +14,8 @@ type Props = {
     };
     isDateReset?: boolean;
     variant?: 'floatingLabel';
+    minDate?: Date;
+    maxDate?: Date;
 };
 export declare const DateRangePicker: React.FC<Props>;
 export default DateRangePicker;

package/dist/components/MetricList/MetricList.d.ts

@@ -25,5 +25,7 @@ export type ExternalMetricListProps = {
     sharingSettingsId?: string;
     isHideChartSettings?: boolean;
     isHideTablePreview?: boolean;
+    enableDownloadCsv?: boolean;
+    enableEmailCsv?: boolean;
 };
 export declare const ExternalMetricList: React.FC<ExternalMetricListProps>;

package/dist/components/MetricList/components/FullScreenView/index.d.ts

@@ -1,5 +1,6 @@
 import React from 'react';
 import { ExternalMetrics } from '@/types/queryTypes';
+import { MetricFilterOptionsType } from '@/types';
 export type FullScreenViewProps = {
     metric: ExternalMetrics;
     colors?: string[];
@@ -8,6 +9,7 @@ export type FullScreenViewProps = {
         filterValues: Record<string, string>;
     };
     appFilters?: any;
+    metricFilterOptions?: MetricFilterOptionsType;
     onMinimize: () => void;
     clientId: string;
     tenancyLevel: string;
@@ -21,4 +23,4 @@ export type FullScreenViewProps = {
     isHideChartSettings?: boolean;
     isHideTablePreview?: boolean;
 };
-export declare const FullScreenView: ({ metric, colors, rlsFilters, onMinimize, clientId, tenancyLevel, companyId, externalDashboardId, userProvidedDashboardId, isAllowedToUpdateMetrics, sharingSettingsId, appFilters, isInternalApp, isShowChartConfigTab, isHideChartSettings, isHideTablePreview, }: FullScreenViewProps) => React.JSX.Element;
+export declare const FullScreenView: ({ metric, colors, rlsFilters, metricFilterOptions, onMinimize, clientId, tenancyLevel, companyId, externalDashboardId, userProvidedDashboardId, isAllowedToUpdateMetrics, sharingSettingsId, appFilters, isInternalApp, isShowChartConfigTab, isHideChartSettings, isHideTablePreview, }: FullScreenViewProps) => React.JSX.Element;

package/dist/components/MetricList/components/MetricCards/MetricCard.d.ts

@@ -2,7 +2,7 @@ import React from 'react';
 import { ExternalMetrics } from '@/types/queryTypes';
 import { ClientType } from '@/types/app';
 import { FilterFieldType } from '@/components/FilterField';
-import { RlsCondition } from '@/types';
+import { MetricFilterOptionsType, RlsCondition } from '@/types';
 export type MetricCardProps = {
     globalFilters?: {
         tableName: string;
@@ -26,5 +26,8 @@ export type MetricCardProps = {
     isInternalApp?: boolean;
     setCrossDashboardFilters?: React.Dispatch<React.SetStateAction<RlsCondition[]>>;
     crossDashboardFilters?: RlsCondition[];
+    metricFilterOptions?: MetricFilterOptionsType;
+    onDownloadRawCsv?: (filterValues?: Record<string, any>) => void;
+    enableDownloadCsv?: boolean;
 };
-export declare const MetricCard: ({ globalFilters, metricItem, onMaximize, client, colors, param, companyTenancyType, renderHeaderName, isDisableCardClick, onArchive, chartRendererType, isDisableMorePopup, appFilters, isInternalApp, setCrossDashboardFilters, crossDashboardFilters, }: MetricCardProps) => React.JSX.Element;
+export declare const MetricCard: ({ globalFilters, metricItem, onMaximize, client, colors, param, companyTenancyType, renderHeaderName, isDisableCardClick, onArchive, chartRendererType, isDisableMorePopup, appFilters, isInternalApp, setCrossDashboardFilters, crossDashboardFilters, metricFilterOptions, onDownloadRawCsv, enableDownloadCsv, }: MetricCardProps) => React.JSX.Element;

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

@@ -20,7 +20,9 @@ type Props = {
         totalRecords: number;
     };
     setChartSettings?: (value: React.SetStateAction<ChartSettingsType>) => void;
-    isFullScreen?: boolean;
+    isInfiniteScroll?: boolean;
+    onLoadMore?: () => void;
+    hasMoreData?: boolean;
 };
-export declare const Table: ({ data, isLoading, error, tableSettings, tableName, className, onColumnSizingChange, onChartReady, onChangePage, isExternalChart, isEnableNextBtn, isEnablePrevBtn, paginationInfo, setChartSettings, isFullScreen, }: Props) => React.JSX.Element;
+export declare const Table: ({ data, isLoading, error, tableSettings, tableName, className, onColumnSizingChange, onChartReady, onChangePage, isExternalChart, isEnableNextBtn, isEnablePrevBtn, paginationInfo, setChartSettings, isInfiniteScroll, onLoadMore, hasMoreData, }: Props) => React.JSX.Element;
 export {};

package/dist/consts/app.d.ts

@@ -21,6 +21,7 @@ export declare const CHART_TYPES: {
     table: string;
     timeSeries: string;
     pivot: string;
+    rose: string;
 };
 export declare const timeStamp: {
     month: string;

package/dist/containers/Dashboard/Dashboard.d.ts

@@ -26,6 +26,8 @@ export interface DashboardProps extends HTMLAttributes<HTMLElement> {
     theme?: ThemeType;
     isHideChartSettings?: boolean;
     isHideTablePreview?: boolean;
+    enableDownloadCsv?: boolean;
+    enableEmailCsv?: boolean;
 }
 /**
  * @name Dashboard - A react component to display the dashboard.
@@ -33,7 +35,9 @@ export interface DashboardProps extends HTMLAttributes<HTMLElement> {
  * @prop {string} dashboardId (optional) - A dashboard id (one which you have provided at the time of creating it) of the dashboard you want to see.
  * @prop {object} options (optional) - Additional options like access permissions e.g. metric creation, updation, archiving and layout customization.
  * @prop {boolean} isHideChartSettings (optional) - Whether to hide chart settings in full screen view.
- * @prop {boolean} isHideTablePreview (optional) - Whether to hide table preview in full screen view.
+ * @prop {boolean} isHideChartSettings (optional) - Whether to hide chart settings in full screen view.
+ * @prop {boolean} enableDownloadCsv (optional) - Whether to show download csv option in metric card.
+ * @prop {boolean} enableEmailCsv (optional) - Whether to show email csv option in metric card.
  * @prop {object} theme (optional) - A theme object to customize the theme.
  */
-export declare const Dashboard: ({ token, options, theme, dashboardId, isHideChartSettings, isHideTablePreview, }: DashboardProps) => React.JSX.Element;
+export declare const Dashboard: ({ token, options, theme, dashboardId, isHideChartSettings, isHideTablePreview, enableDownloadCsv, enableEmailCsv, }: DashboardProps) => React.JSX.Element;

package/dist/containers/Dashboard/EmbededDashboard.d.ts

@@ -9,6 +9,8 @@ export interface EmbeddedDashboardProps {
         chartColors?: string[];
         isHideChartSettings?: boolean;
         isHideTablePreview?: boolean;
+        enableDownloadCsv?: boolean;
+        enableEmailCsv?: boolean;
     };
     theme?: ThemeType;
 }

package/dist/containers/Metric/EmbeddedMetric.d.ts

@@ -1,4 +1,5 @@
 import React from 'react';
+import { MetricFilterOptionsType } from '@/types';
 export interface EmbeddedMetricProps {
     token: string;
     chartColors?: string[];
@@ -8,5 +9,8 @@ export interface EmbeddedMetricProps {
     onMinimize?: () => void;
     isHideChartSettings?: boolean;
     isHideTablePreview?: boolean;
+    enableDownloadCsv?: boolean;
+    enableEmailCsv?: boolean;
+    metricFilterOptions?: MetricFilterOptionsType;
 }
-export declare const EmbeddedMetric: React.MemoExoticComponent<({ token, chartColors, metricId, chartRendererType, variant, onMinimize, isHideChartSettings, isHideTablePreview, }: EmbeddedMetricProps) => React.JSX.Element>;
+export declare const EmbeddedMetric: React.MemoExoticComponent<({ token, chartColors, metricId, chartRendererType, variant, onMinimize, isHideChartSettings, isHideTablePreview, enableDownloadCsv, enableEmailCsv, metricFilterOptions, }: EmbeddedMetricProps) => React.JSX.Element>;

package/dist/containers/Metric/index.d.ts

@@ -1,5 +1,6 @@
 import React, { HTMLAttributes } from 'react';
-import { ThemeType } from '@/utils/theme';
+import { ThemeType } from '@/utils';
+import { MetricFilterOptionsType } from '@/types';
 /**
  * token - The client based guest token (required).
  * metricId - The id of the dashboard you want to see.
@@ -19,6 +20,8 @@ export interface MetricProps extends HTMLAttributes<HTMLElement> {
     variant?: 'card' | 'fullscreen';
     isHideChartSettings?: boolean;
     isHideTablePreview?: boolean;
+    enableDownloadCsv?: boolean;
+    enableEmailCsv?: boolean;
     onMinimize?: () => void;
     chartRendererType?: 'svg' | 'canvas';
     theme?: ThemeType;
@@ -26,6 +29,7 @@ export interface MetricProps extends HTMLAttributes<HTMLElement> {
     height?: number;
     className?: string;
     style?: React.CSSProperties;
+    metricFilterOptions?: MetricFilterOptionsType;
 }
 /**
  * @name Metric - A react component to display a single metric card.
@@ -33,7 +37,10 @@ export interface MetricProps extends HTMLAttributes<HTMLElement> {
  * @prop {string} metricId - A metric id (one which you have provided at the time of it's creation) of the metric you want to display.
  * @prop {boolean} isHideChartSettings - Whether to hide the chart settings in full screen view.
  * @prop {boolean} isHideTablePreview - Whether to hide the table preview in full screen view.
+ * @prop {boolean} enableDownloadCsv (optional) - Whether to show download csv option in metric card.
+ * @prop {boolean} enableEmailCsv (optional) - Whether to show email csv option in metric card.
  * @prop {string} variant (optional) - The variant to render the metric it can be card (fullscreen included) or fullscreen.
+ * @prop {object} metricFilterOptions (optional) - An optional metric filter options to be displayed in the metric filters.
  * @prop {function} onMinimize (optional) - An optional callback when minimize button is clicked.
  * @prop {array} chartColors (optional) - An array of colors to be used to visualize the chart.
  * @prop {string} chartRendererType (optional) - Whether to display chart as svg or canvas. In case of low end devices or in general svg is better and in case of frequent data changes or high size data visualization canvas is better. Defaults to canvas.
@@ -43,4 +50,4 @@ export interface MetricProps extends HTMLAttributes<HTMLElement> {
  * @prop {object} style (optional) - The usual css style prop to provide inline styles.
  * @prop {object} theme (optional) - Theme config object to apply to the UI.
  */
-export declare const Metric: React.MemoExoticComponent<({ theme, width, height, style, className, ...metricProps }: MetricProps) => React.JSX.Element>;
+export declare const Metric: React.MemoExoticComponent<({ theme, width, height, style, className, metricFilterOptions, ...metricProps }: MetricProps) => React.JSX.Element>;

package/dist/helpers/getValidRlsConditionOptions.d.ts

@@ -0,0 +1,13 @@
+import { MetricFilterOptionsType, RlsCondition } from '@/types';
+/**
+ * @name getValidRlsConditionOptions - Filters out invalid options and return valid options and value;
+ * @param {RlsCondition} rlsCondition (required) - A metric filter object.
+ * @param {MetricFilterOptionsType} filterOptions (required) - Metric filter options prop object.
+ * @returns value - A valid value or undefined.
+ * @returns options - A valid options or undefined.
+ * @returns 'undefined' - If not a valid props or options or value.
+ */
+export declare const getValidRlsConditionOptions: (rlsCondition: RlsCondition, filterOptions: MetricFilterOptionsType) => {
+    value: string;
+    options: string[] | number[] | import("@/types").DateTypeOptionType[];
+} | undefined;

package/dist/helpers/index.d.ts

@@ -2,3 +2,4 @@ export * from './getModifiedQuery';
 export * from './getTimeFilterValue';
 export * from './groupArray';
 export * from './groupBy';
+export * from './getValidRlsConditionOptions';

package/dist/hooks/useMetricCard.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { ChartSettingsType, FloatingDropDownOption, RlsCondition, DatasetSettings } from '@/types';
+import { ChartSettingsType, FloatingDropDownOption, RlsCondition, DatasetSettings, MetricFilterOptionsType } from '@/types';
 import { MetricCardProps } from '@/components';
 type UseMetricCardProps = {
     metric: Record<string, any>;
@@ -18,8 +18,9 @@ type UseMetricCardProps = {
     isInternalApp?: boolean;
     setCrossDashboardFilters?: React.Dispatch<React.SetStateAction<RlsCondition[]>>;
     crossDashboardFilters?: RlsCondition[];
+    metricFilterOptions?: MetricFilterOptionsType;
 };
-export declare const useMetricCard: ({ metric, globalFilters, rlsFilters, clientId, chartSettings, setChartSettings, tenancyLevel, isInternalApp, appFilters, setCrossDashboardFilters, crossDashboardFilters, }: UseMetricCardProps) => {
+export declare const useMetricCard: ({ metric, globalFilters, rlsFilters, clientId, chartSettings, setChartSettings, tenancyLevel, isInternalApp, appFilters, setCrossDashboardFilters, crossDashboardFilters, metricFilterOptions, }: UseMetricCardProps) => {
     onDrillDown: (params: any) => void;
     handleChartClick: (params: any) => void;
     dataDb: Record<string, any>[];

package/dist/types/app.d.ts

@@ -85,6 +85,33 @@ export type CustomSettings = {
         zoomAxis?: 'x' | 'y' | 'xy' | 'none';
         zoomOnMouseWheel?: boolean;
     };
+    showDynamicBehaviour?: boolean;
+    roseType?: string;
+    selectedMode?: string;
+    selectedOffset?: number;
+    gradients?: {
+        startColor: string;
+        endColor: string;
+        offset1: number;
+        offset2: number;
+        direction: string;
+    }[];
+    isShowBarGradient?: boolean;
+    barGradient?: {
+        startColor?: string;
+        endColor?: string;
+        offset1?: number;
+        offset2?: number;
+        direction?: string;
+    };
+    enableBackgroundGradient?: boolean;
+    backgroundGradient?: {
+        startColor?: string;
+        endColor?: string;
+        offset1?: number;
+        offset2?: number;
+        direction?: string;
+    };
 };
 export type TableSettings = {
     contentAlignment?: string;
@@ -128,6 +155,19 @@ export type LabelSettings = {
     position?: string;
     truncateLabel?: boolean;
     truncateLabelValue?: number;
+    showLabelLine?: boolean;
+    XAxisStyle?: {
+        size?: number;
+        family?: string;
+        weight?: number;
+        color?: string;
+    };
+    YAxisStyle?: {
+        size?: number;
+        family?: string;
+        weight?: number;
+        color?: string;
+    };
 };
 export type AxisSettings = {
     axis?: string;
@@ -261,6 +301,8 @@ export type DateOptionType = {
     count: number;
     endDate?: Date;
     startDate?: Date;
+    minDate?: Date;
+    maxDate?: Date;
 };
 export type RlsCondition = {
     name: string;
@@ -306,3 +348,15 @@ export type ConditionalFormattingParam = {
         styles: any;
     }[];
 };
+export type DateTypeOptionType = {
+    range: 'Last' | 'This' | 'Custom';
+    time?: 'Day' | 'Week' | 'Month' | 'Quarter' | 'Year';
+    name: string;
+    count?: number;
+    minDate?: Date;
+    maxDate?: Date;
+};
+export type MetricFilterOptionsType = Record<string, {
+    options: string[] | number[] | DateTypeOptionType[];
+    defaultOption?: string | number;
+}>;

package/dist/utils/getValidJson.d.ts

@@ -0,0 +1 @@
+export declare const getValidJson: (json: string) => any;

package/dist/utils/index.d.ts

@@ -4,3 +4,4 @@ export * from './colors';
 export * from './getFormattedDataType';
 export * from './arrayToCsvString';
 export * from './popoverPosition';
+export * from './getValidJson';

package/dist/webcomponents.d.ts

@@ -1,7 +1,7 @@
 import { DashboardProps } from './containers/Dashboard';
 import { Chart, ChartProps } from './components';
 import { MetricProps } from './containers/Metric';
-export type { CustomSettings, TableSettings, MarginSettings, AxisSettings, LegendSettings, LabelSettings, BackgroundSettings, PivotSettingsType, GaugeSettingsType, ChartSettingsType, TimeSeriesSettingsType, } from '@/types';
+export type { CustomSettings, TableSettings, MarginSettings, AxisSettings, LegendSettings, LabelSettings, BackgroundSettings, PivotSettingsType, GaugeSettingsType, ChartSettingsType, TimeSeriesSettingsType, MetricFilterOptionsType, DateTypeOptionType, } from '@/types';
 export declare namespace JSX {
     interface IntrinsicElements {
         Tag: any;