@databrainhq/plugin 0.15.15 → 0.15.17-uat

package/README.md

@@ -1,233 +1,233 @@
-# @databrainhq/plugin
-
-> Databrain app ui web component 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
-
-React/Solidjs
-
-Import in main/index/App
-```tsx
-import '@databrainhq/plugin/web';
-```
-Then use it anywhere in your app
-
-Integrating Dashboard
-
-```tsx
-const Example = () => {
-  return (
-    <dbn-dashboard
-      token="Your Guest Token"
-      dashboardId="Your Dashboard Id"
-      options={{
-        disableMetricCreation: false,
-        disableMetricUpdation: false,
-        disableMetricDeletion: false,
-        disableLayoutCustomization: false,
-        chartColors: [
-          'violet',
-          'indigo',
-          'blue',
-          'green',
-          'yellow',
-          'orange',
-          'red',
-          'pink',
-          'gray',
-        ],
-      }}
-      theme={YOUR_THEME}
-    />
-  );
-};
-```
-
-Integrating Metric
-
-```tsx
-const Example = () => {
-  return (
-    <Metric
-      token="Your Guest Token"
-      metricId="Your Metric Id"
-      width="500px"
-      height="300px"
-      chartRendererType="canvas"
-      chartColors={[
-        'violet',
-        'indigo',
-        'blue',
-        'green',
-        'yellow',
-        'orange',
-        'red',
-        'pink',
-        'gray',
-      ]}
-      theme={YOUR_THEME}
-    />
-  );
-};
-```
-
-Vue
-
-Import in main/index/App
-```vue
-<script setup lang="ts">
-import '@databrainhq/plugin/web';
-</script>
-```
-Then use it anywhere in your app
-
-Integrating Dashboard
-
-```vue
-<script setup lang="ts">
-  // your component logic
-</script>
-<template>
-  <dbn-dashboard
-    :token="/*YOUR GUEST TOKEN*/"
-    :options="/*YOUR ACCESS PERMISSION OPTIONS*/"
-    :theme="/*YOUR THEME*/"
-    :dashboardId="/*YOUR DASHBORD ID*/"
-  ></dbn-dashboard>
-</template>
-```
-
-Integrating Metric
-
-```vue
-<script setup lang="ts">
-  // your component logic
-</script>
-<template>
-  <dbn-metric
-    :token="/*YOUR GUEST TOKEN*/"
-    chartRendererType="canvas"
-    :theme="/*YOUR THEME*/"
-    :dashboardId="/*YOUR DASHBORD ID*/"
-    width="500"
-    height="400"
-    :style="/* YOUR STYLEs */"
-    className="YOUR CLASS"
-  ></dbn-metric>
-</template>
-```
-
-Svelte
-
-Import in main/index/App
-
-```svelte
-<script lang="ts">
-import '@databrainhq/plugin/web';
-</script>
-```
-
-Then use it anywhere in your app
-
-Integrating Dashboard
-
-```svelte
-<script lang="ts">
-  // your component logic
-</script>
-<main>
-  <dbn-dashboard
-    token={/*YOUR GUEST TOKEN*/}
-    options={/*YOUR ACCESS PERMISSION OPTIONS*/}
-    theme={/*YOUR THEME*/}
-    dashboardId={/*YOUR DASHBORD ID*/}
-  ></dbn-dashboard>
-</main>
-```
-
-Integrating Metric
-
-```svelte
-<script lang="ts">
-// your component logic
-</script>
-<main>
-  <dbn-metric
-    token={/*YOUR GUEST TOKEN*/}
-    chartRendererType="canvas"
-    theme={/*YOUR THEME*/}
-    dashboardId="/*YOUR DASHBORD ID*/"
-    width="500"
-    height="400"
-    style={/* YOUR STYLEs */}
-    className="YOUR CLASS"
-  ></dbn-metric>
-</main>
-```
-
-Angular
-
-Add suport for custom elements/web components in app.module.ts
-
-```ts
-// app.module.ts
-import { NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
-import { BrowserModule } from '@angular/platform-browser';
-
-import { AppComponent } from './app.component';
-
-@NgModule({
-  declarations: [AppComponent],
-  imports: [BrowserModule],
-  providers: [],
-  bootstrap: [AppComponent],
-  schemas: [CUSTOM_ELEMENTS_SCHEMA],
-})
-
-export class AppModule {}
-```
-Import in app.component.ts
-
-```ts
-import '@databrainhq/plugin/web';
-```
-
-Then use it anywhere in your app
-
-Integrating Dashboard
-
-```html
-<dbn-dashboard
-  token="YOUR GUEST TOKEN"
-  options="YOUR ACCESS PERMISSION OPTIONS"
-  theme="YOUR THEME"
-  dashboardId="YOUR DASHBORD ID"
-></dbn-dashboard>
-```
-
-Integrating Metric
-
-```html
-<dbn-metric
-  token="YOUR GUEST TOKEN"
-  chartRendererType="canvas"
-  theme="YOUR THEME"
-  dashboardId="YOUR DASHBORD ID"
-  width="500"
-  height="400"
-  style="YOUR STYLE"
-  className="YOUR CLASS"
-></dbn-metric>
-```
-
-## License
-
-MIT © [databrainhq](https://github.com/databrainhq)
+# @databrainhq/plugin
+
+> Databrain app ui web component 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
+
+React/Solidjs
+
+Import in main/index/App
+```tsx
+import '@databrainhq/plugin/web';
+```
+Then use it anywhere in your app
+
+Integrating Dashboard
+
+```tsx
+const Example = () => {
+  return (
+    <dbn-dashboard
+      token="Your Guest Token"
+      dashboardId="Your Dashboard Id"
+      options={{
+        disableMetricCreation: false,
+        disableMetricUpdation: false,
+        disableMetricDeletion: false,
+        disableLayoutCustomization: false,
+        chartColors: [
+          'violet',
+          'indigo',
+          'blue',
+          'green',
+          'yellow',
+          'orange',
+          'red',
+          'pink',
+          'gray',
+        ],
+      }}
+      theme={YOUR_THEME}
+    />
+  );
+};
+```
+
+Integrating Metric
+
+```tsx
+const Example = () => {
+  return (
+    <Metric
+      token="Your Guest Token"
+      metricId="Your Metric Id"
+      width="500px"
+      height="300px"
+      chartRendererType="canvas"
+      chartColors={[
+        'violet',
+        'indigo',
+        'blue',
+        'green',
+        'yellow',
+        'orange',
+        'red',
+        'pink',
+        'gray',
+      ]}
+      theme={YOUR_THEME}
+    />
+  );
+};
+```
+
+Vue
+
+Import in main/index/App
+```vue
+<script setup lang="ts">
+import '@databrainhq/plugin/web';
+</script>
+```
+Then use it anywhere in your app
+
+Integrating Dashboard
+
+```vue
+<script setup lang="ts">
+  // your component logic
+</script>
+<template>
+  <dbn-dashboard
+    :token="/*YOUR GUEST TOKEN*/"
+    :options="/*YOUR ACCESS PERMISSION OPTIONS*/"
+    :theme="/*YOUR THEME*/"
+    :dashboardId="/*YOUR DASHBORD ID*/"
+  ></dbn-dashboard>
+</template>
+```
+
+Integrating Metric
+
+```vue
+<script setup lang="ts">
+  // your component logic
+</script>
+<template>
+  <dbn-metric
+    :token="/*YOUR GUEST TOKEN*/"
+    chartRendererType="canvas"
+    :theme="/*YOUR THEME*/"
+    :dashboardId="/*YOUR DASHBORD ID*/"
+    width="500"
+    height="400"
+    :style="/* YOUR STYLEs */"
+    className="YOUR CLASS"
+  ></dbn-metric>
+</template>
+```
+
+Svelte
+
+Import in main/index/App
+
+```svelte
+<script lang="ts">
+import '@databrainhq/plugin/web';
+</script>
+```
+
+Then use it anywhere in your app
+
+Integrating Dashboard
+
+```svelte
+<script lang="ts">
+  // your component logic
+</script>
+<main>
+  <dbn-dashboard
+    token={/*YOUR GUEST TOKEN*/}
+    options={/*YOUR ACCESS PERMISSION OPTIONS*/}
+    theme={/*YOUR THEME*/}
+    dashboardId={/*YOUR DASHBORD ID*/}
+  ></dbn-dashboard>
+</main>
+```
+
+Integrating Metric
+
+```svelte
+<script lang="ts">
+// your component logic
+</script>
+<main>
+  <dbn-metric
+    token={/*YOUR GUEST TOKEN*/}
+    chartRendererType="canvas"
+    theme={/*YOUR THEME*/}
+    dashboardId="/*YOUR DASHBORD ID*/"
+    width="500"
+    height="400"
+    style={/* YOUR STYLEs */}
+    className="YOUR CLASS"
+  ></dbn-metric>
+</main>
+```
+
+Angular
+
+Add suport for custom elements/web components in app.module.ts
+
+```ts
+// app.module.ts
+import { NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
+import { BrowserModule } from '@angular/platform-browser';
+
+import { AppComponent } from './app.component';
+
+@NgModule({
+  declarations: [AppComponent],
+  imports: [BrowserModule],
+  providers: [],
+  bootstrap: [AppComponent],
+  schemas: [CUSTOM_ELEMENTS_SCHEMA],
+})
+
+export class AppModule {}
+```
+Import in app.component.ts
+
+```ts
+import '@databrainhq/plugin/web';
+```
+
+Then use it anywhere in your app
+
+Integrating Dashboard
+
+```html
+<dbn-dashboard
+  token="YOUR GUEST TOKEN"
+  options="YOUR ACCESS PERMISSION OPTIONS"
+  theme="YOUR THEME"
+  dashboardId="YOUR DASHBORD ID"
+></dbn-dashboard>
+```
+
+Integrating Metric
+
+```html
+<dbn-metric
+  token="YOUR GUEST TOKEN"
+  chartRendererType="canvas"
+  theme="YOUR THEME"
+  dashboardId="YOUR DASHBORD ID"
+  width="500"
+  height="400"
+  style="YOUR STYLE"
+  className="YOUR CLASS"
+></dbn-metric>
+```
+
+## License
+
+MIT © [databrainhq](https://github.com/databrainhq)

package/dist/components/Chart/SingleValueChart.d.ts

@@ -22,6 +22,7 @@ export type SingleValueChartProps = {
         truncateValue?: number;
         upVariant?: string;
         downVariant?: string;
+        metricCardColor?: string;
     };
     value: string | number;
     hideBorder?: boolean;

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

@@ -19,6 +19,7 @@ export type ChartProps = {
     isSortReversed?: boolean;
     chartHeight?: number;
     chartAppearance?: ChartAppearanceType;
+    metricCardColor?: string;
 };
 /**
  * @name Chart - The metric visualization component.
@@ -30,4 +31,4 @@ export type ChartProps = {
  * @prop colors (optional) - the admin provided chart color palettes.
  * @returns JSX - chart visaulization content.
  */
-export declare const Chart: React.MemoExoticComponent<({ chartOptions, data, events, colors, config, className, isShowFullScreen, isShowFullScreenEnabled, sortOrder, onMaximize, onDrillPivotTable, pivotDrillState, isPythonMode, seriesName, isSortReversed, chartHeight, chartAppearance, }: ChartProps) => React.JSX.Element>;
+export declare const Chart: React.MemoExoticComponent<({ chartOptions, data, events, colors, config, className, isShowFullScreen, isShowFullScreenEnabled, sortOrder, onMaximize, onDrillPivotTable, pivotDrillState, isPythonMode, seriesName, isSortReversed, chartHeight, chartAppearance, metricCardColor, }: ChartProps) => React.JSX.Element>;

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

@@ -58,5 +58,6 @@ export type ExternalMetricListProps = {
     };
     isShadowDisableOnHover?: boolean;
     noDataImg?: string;
+    metricCardColor?: string;
 };
 export declare const ExternalMetricList: React.FC<ExternalMetricListProps>;

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

@@ -75,5 +75,6 @@ export type MetricCardProps = {
     isShadowDisableOnHover?: boolean;
     isAllowedToSeeUnderlyingData?: boolean;
     noDataImg?: string;
+    metricCardColor?: string;
 };
-export declare const MetricCard: ({ globalFilters: globalFilterList, metricItem, onMaximize, client, colors, param, companyTenancyType, renderHeaderName, isDisableCardClick, onArchive, chartRendererType, isDisableMorePopup, appFilters, isInternalApp, setCrossDashboardFilters, crossDashboardFilters, metricFilterOptions, onDownloadRawCsv, enableDownloadCsv, enableMultiMetricFilters, disableActions, metricFilterPosition, isAllClient, dropdownTheme, optionsIcon, downloadMetrics, onDownload, appearanceOptions, isFrontendApp, guestToken, encryptedClient, workspaceId, clientColumnType, isDisableCardTitle, chartHeight, isEditLayoutEnabled, isTourActive, hideDatePickerOptions, chartAppearance, isDisableMetricLoader, isShadowDisableOnHover, isAllowedToSeeUnderlyingData, noDataImg, }: MetricCardProps) => React.JSX.Element;
+export declare const MetricCard: ({ globalFilters: globalFilterList, metricItem, onMaximize, client, colors, param, companyTenancyType, renderHeaderName, isDisableCardClick, onArchive, chartRendererType, isDisableMorePopup, appFilters, isInternalApp, setCrossDashboardFilters, crossDashboardFilters, metricFilterOptions, onDownloadRawCsv, enableDownloadCsv, enableMultiMetricFilters, disableActions, metricFilterPosition, isAllClient, dropdownTheme, optionsIcon, downloadMetrics, onDownload, appearanceOptions, isFrontendApp, guestToken, encryptedClient, workspaceId, clientColumnType, isDisableCardTitle, chartHeight, isEditLayoutEnabled, isTourActive, hideDatePickerOptions, chartAppearance, isDisableMetricLoader, isShadowDisableOnHover, isAllowedToSeeUnderlyingData, noDataImg, metricCardColor, }: MetricCardProps) => React.JSX.Element;

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

@@ -36,4 +36,4 @@ export type MultiSelectDropdownProps = Omit<MultiSelectAccordianDropdownProps, '
     isSelectAllOn?: boolean;
 };
 export declare const MultiSelectAccordianDropdown: ({ label, labelVariant, selectedOption, onChange, button, options, isDisabled, icon, buttonWidth, menuWidth, isSearchEnabled, searchIcon, closeControl, searchPlaceholder, radius, }: MultiSelectAccordianDropdownProps) => React.JSX.Element;
-export declare const MultiSelectDropdown: ({ id, label, labelVariant, selectedOption: selectedOption_temp, onChange, button, options, isDisabled, icon, buttonWidth, menuWidth, isSearchEnabled, searchIcon, closeControl, searchPlaceholder, isShowSelectedOptions, radius, isFilter, dataTestTitle, isAutoSelectOption, isLoadingData, error, menuZIndex, isSelectAllEnabled, isSelectAllOn, }: MultiSelectDropdownProps) => React.JSX.Element;
+export declare const MultiSelectDropdown: ({ id, label, labelVariant, selectedOption, onChange, button, options, isDisabled, icon, buttonWidth, menuWidth, isSearchEnabled, searchIcon, closeControl, searchPlaceholder, isShowSelectedOptions, radius, isFilter, dataTestTitle, isAutoSelectOption, isLoadingData, error, menuZIndex, isSelectAllEnabled, isSelectAllOn, }: MultiSelectDropdownProps) => React.JSX.Element;

package/dist/consts/metricOptions.d.ts

@@ -202,3 +202,4 @@ export declare const keywordToIgnoreRegExp: RegExp;
 export declare const DEFAULT_SEARCH_STATE: SearchState;
 export declare const DEFAULT_SEARCH_CHAT: SearchStateChatType;
 export declare const decimalTypes: string[];
+export declare const switchAxisCharts: string[];

package/dist/helpers/createMetric.d.ts

@@ -16,3 +16,4 @@ export declare const setChartFields: ({ chartType, chartDimensions, chartMetrics
 export declare const getDatabaseName: (name: string) => "bigquery" | "mysql" | "postgresql";
 export declare const getWordCount: (text: string) => number;
 export declare const generateRandomId: (length?: number) => string;
+export declare const enableSaveToDashboardButton: (chartType: ChartSettingsType['chartType'], dimensions: SelectedColumn[], metrics: SelectedColumn[]) => number;

package/dist/types/app.d.ts

@@ -110,6 +110,7 @@ export type CustomSettings = {
     customUppperLimit?: number;
     customLowerLimit?: number;
     isEnableInterchange?: boolean;
+    isEnableDashedLine?: boolean;
     comparisonBadgeColor?: {
         up?: string;
         down?: string;
@@ -443,6 +444,11 @@ export type ChartSettingsType = {
     comboBarList: string[];
     isGroupXAxis?: boolean;
     isEnableComparisonFilter?: boolean;
+    enduserMeasureAndDimensions?: {
+        isEnabled?: boolean;
+        measures?: FloatingDropDownOption[];
+        dimensions?: FloatingDropDownOption[];
+    };
 };
 export type SelectedColumns = {
     column: string;
@@ -749,6 +755,7 @@ export type AdminThemeOptionsType = {
         selectBoxVariant?: 'floating' | 'static';
         selectBoxBorderRadius?: string;
         selectBoxTextColor?: string;
+        metricCardColor?: string;
     };
     cardDescription: {
         fontSize?: string;

package/dist/types/queryTypes.d.ts

@@ -68,6 +68,10 @@ export type UseMetricQueryQueryInputType = {
     };
     chartSeriesField?: string;
     comparisonCount?: number;
+    dynamicXAxis?: {
+        isEnable: boolean;
+        xaxis: string;
+    };
 };
 export type UseMetricQueryQueryOutputType = {
     data?: any | null;

package/dist/utils/getChartOptions.d.ts

@@ -33,9 +33,10 @@ export type GetChartOptionsParams = {
     chartHeight?: number;
     chartAppearance?: ChartAppearanceType;
     chartRef?: React.MutableRefObject<any>;
+    metricCardColor?: string;
 };
 export declare const getLegendData: ({ chartOptions, data, }: {
     chartOptions: ChartSettingsType;
     data: Record<string, any>[];
 }) => any;
-export declare const getChartOptions: ({ chartOptions, data, colors, isPythonMode, geoJsonData, chartHeight, chartAppearance, chartRef, }: GetChartOptionsParams) => Record<string, any>;
+export declare const getChartOptions: ({ chartOptions, data, colors, isPythonMode, geoJsonData, chartHeight, chartAppearance, chartRef, metricCardColor, }: GetChartOptionsParams) => Record<string, any>;

package/dist/utils/getNoAxisChartOptions.d.ts

@@ -20,5 +20,6 @@ export type GetNoAxisChartOptionsParams = {
     chartHeight?: number;
     chartAppearance?: ChartAppearanceType;
     chartRef?: React.MutableRefObject<any>;
+    metricCardColor?: string;
 };
-export declare const getNoAxisChartOptions: ({ chartOptions, data, colors, datasets, funnelData, labels, singleValueData, geoJsonData, mapColors, progressData, barGradient, labelFormatSettings, bgColors, chartHeight, chartAppearance, chartRef, }: GetNoAxisChartOptionsParams) => Record<string, any>;
+export declare const getNoAxisChartOptions: ({ chartOptions, data, colors, datasets, funnelData, labels, singleValueData, geoJsonData, mapColors, progressData, barGradient, labelFormatSettings, bgColors, chartHeight, chartAppearance, chartRef, metricCardColor, }: GetNoAxisChartOptionsParams) => Record<string, any>;