@databrainhq/plugin 0.11.38 → 0.11.39

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/ExternalMetricForm/index.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 import { FieldValues } from 'react-hook-form';
-import { DashboardType } from '@/types/app';
+import { DashboardType, FloatingDropDownOption } from '@/types/app';
 type ExternalMetricProps = {
     onSubmit: (values: FieldValues) => void;
     defaultValues?: FieldValues;
@@ -8,7 +8,7 @@ type ExternalMetricProps = {
     isEmbedded?: boolean;
     dashboardIds: DashboardType['id'][];
     onDashboardChange: (selected: DashboardType['id'][]) => void;
-    companyId: string;
+    options: FloatingDropDownOption[];
     error?: string;
 };
 export declare const ExternalMetricForm: React.FC<ExternalMetricProps>;

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

@@ -1,3 +1,3 @@
 import React from 'react';
 import { EmbeddedMetricCreationProps } from '@/types/metricCreate';
-export declare const EmbeddedMetricCreation: ({ clientId, companyId, isLiveMode, externalDashboardId, userProvidedDashboardId, chartColors, isShowMetricCreateModal, setShowMetricCreateModal, metric, metricData, workspaceId, }: EmbeddedMetricCreationProps) => React.JSX.Element;
+export declare const EmbeddedMetricCreation: ({ clientId, companyId, isLiveMode, externalDashboardId, userProvidedDashboardId, chartColors, isShowMetricCreateModal, setShowMetricCreateModal, metric, metricData, }: EmbeddedMetricCreationProps) => React.JSX.Element;

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

@@ -3,7 +3,6 @@ import { Layout } from 'react-grid-layout';
 import { MetricCardProps } from './components';
 import { ClientType } from '@/types/app';
 import { ThemeType } from '@/utils/theme';
-import { EmbeddedDashboardMetricsQuery } from '@/utils/generated/graphql';
 export declare const GridLayout: React.ComponentClass<import("react-grid-layout").ResponsiveProps & import("react-grid-layout").WidthProviderProps, any>;
 export type ExternalMetricListProps = {
     chartColors?: string[];
@@ -17,7 +16,7 @@ export type ExternalMetricListProps = {
     breakpoint: ThemeType['breakpoint'];
     layoutCols: ThemeType['metricLayoutCols'];
     adminLayout: Layout[];
-    externalDashboardMetrics?: EmbeddedDashboardMetricsQuery['externalDashboardMetrics'];
+    externalDashboardMetrics?: any;
     params?: any;
     appFilters?: any;
     companyTenancyType: string;

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

@@ -1,5 +1,5 @@
 import React from 'react';
-import { ExternalMetrics } from '@/utils/generated/graphql';
+import { ExternalMetrics } from '@/types/queryTypes';
 type Props = {
     onCloseModal: (value: boolean) => void;
     isShowRawCsvModal: boolean;

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

@@ -1,5 +1,5 @@
 import React from 'react';
-import { ExternalMetrics } from '@/utils/generated/graphql';
+import { ExternalMetrics } from '@/types/queryTypes';
 export type FullScreenViewProps = {
     metric: ExternalMetrics;
     colors?: string[];

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

@@ -1,5 +1,5 @@
 import React from 'react';
-import { ExternalMetrics } from '@/utils/generated/graphql';
+import { ExternalMetrics } from '@/types/queryTypes';
 import { ClientType } from '@/types/app';
 import { FilterFieldType } from '@/components/FilterField';
 export type MetricCardProps = {

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

@@ -3,6 +3,5 @@ export * from './DownloadRawCsvModal';
 export * from './LayoutAlert';
 export * from './TableViewModal';
 export * from './MetricCards/MetricCard';
-export * from './MetricCards/SingleValueCard';
 export * from './MetricCards/NoDataLoading';
 export * from './FullScreenView';

package/dist/consts/api.d.ts

@@ -0,0 +1,37 @@
+export declare const DASHBOARD_PATH = "/dashboard";
+export declare const METRIC_PATH = "/metric";
+export declare const DASHBOARD_DATA_QUERY = "dashboardData";
+export declare const DASHBOARD_EMBEDDED_METRIC_PATH: string;
+export declare const DASHBOARD_EMBEDDED_METRIC_QUERY = "embeddedMetric";
+export declare const DASHBOARD_LAYOUT_PATH: string;
+export declare const DASHBOARD_LAYOUT_QUERY = "dashboardLayout";
+export declare const DASHBOARD_SCHEDULED_REPORT_PATH: string;
+export declare const DASHBOARD_SCHEDULED_REPORT_QUERY = "dashboardScheduledReport";
+export declare const DASHBOARD_SAVE_LAYOUT_PATH: string;
+export declare const DASHBOARD_SAVE_LAYOUT_MUTATION = "saveLayout";
+export declare const DASHBOARD_SAVE_SCHEDULED_REPORT_PATH: string;
+export declare const DASHBOARD_SAVE_SCHEDULED_REPORT_MUTATION = "saveScheduleReport";
+export declare const DASHBOARD_DELETE_SCHEDULED_REPORT_PATH: string;
+export declare const DASHBOARD_DELETE_SCHEDULED_REPORT_MUTATION = "deleteScheduleReport";
+export declare const DASHBOARD_CREATE_METRIC_PATH: string;
+export declare const DASHBOARD_CREATE_METRIC_MUTATION = "createMetric";
+export declare const DASHBOARD_UPDATE_METRIC_PATH: string;
+export declare const DASHBOARD_UPDATE_METRIC_MUTATION = "updateMetric";
+export declare const DASHBOARD_UPDATE_ADMIN_METRIC_PATH: string;
+export declare const DASHBOARD_UPDATE_ADMIN_METRIC_MUTATION = "updateAdminMetric";
+export declare const DASHBOARD_GENERATE_METRIC_PATH: string;
+export declare const DASHBOARD_GENERATE_METRIC_MUTATION = "generateMetric";
+export declare const DASHBOARD_PREVIEW_TABLE_PATH: string;
+export declare const DASHBOARD_PREVIEW_TABLE_MUTATION = "previewTable";
+export declare const METRIC_QUERY_PATH: string;
+export declare const METRIC_QUERY_QUERY = "query";
+export declare const METRIC_RAW_DOWNLOAD_SETTINGS_PATH: string;
+export declare const METRIC_RAW_DOWNLOAD_SETTINGS_QUERY = "rawDownloadSettings";
+export declare const METRIC_COLUMN_PATH: string;
+export declare const METRIC_COLUMN_MUTATION = "column";
+export declare const METRIC_UNDERLYING_DATA_PATH: string;
+export declare const METRIC_UNDERLYING_DATA_MUTATION = "underlyingData";
+export declare const METRIC_SHARE_CSV_PATH: string;
+export declare const METRIC_SHARE_CSV_MUTATION = "invokeShareCsv";
+export declare const METRIC_MARK_ARCHIVED_PATH: string;
+export declare const METRIC_MARK_ARCHIVED_MUTATION = "markArchived";

package/dist/hooks/index.d.ts

@@ -1,7 +1,5 @@
-export * from './useEmbeddedDashboard';
 export * from './useExternalMetric';
 export * from './useGenerateDatasetMetrics';
-export * from './useGenerateEmbeddedMetric';
 export * from './useOutsideAlerter';
 export * from './useApplyAdminTheme';
 export * from './useClientDashboardLayout';

package/dist/hooks/useApplyAdminTheme.d.ts

@@ -1,2 +1 @@
-import { Themes } from '@/utils/generated/graphql';
-export declare const useApplyAdminTheme: (adminTheme?: Themes) => void;
+export declare const useApplyAdminTheme: (adminTheme?: any) => void;

package/dist/hooks/useDashboardContext.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="react" />
-import { ExternalDashboardMetrics, ExternalDashboards, Themes } from '@/utils/generated/graphql';
 interface DashboardContextType {
     isLoading: boolean | undefined;
     token: string | undefined;
@@ -8,8 +7,8 @@ interface DashboardContextType {
         companyId: string;
         sharingSettingsId: string | undefined;
         clientId: string | undefined;
-        externalDashboardMetrics: ExternalDashboardMetrics[];
-        externalDashboard: ExternalDashboards;
+        externalDashboardMetrics: any[];
+        externalDashboard: any;
         rlsSettings: any | undefined;
         appFilters: any | undefined;
         companyTenancyType: any;
@@ -18,7 +17,8 @@ interface DashboardContextType {
         isAllowedToUpdateMetrics: boolean | undefined;
         isAllowedToChangeLayout: boolean | undefined;
         workspace: any;
-        adminTheme: Themes;
+        adminTheme: any;
+        clientSubsetData?: any | undefined;
     } | undefined;
 }
 export declare const DashboardContext: import("react").Context<DashboardContextType>;