@databrainhq/plugin 0.15.26 → 0.15.27

package/dist/types/queryTypes.d.ts

@@ -0,0 +1,341 @@
+import { ClientColumnType, RlsCondition } from './app';
+import { DatasetMetricCreationConfiguration } from './metricCreate';
+export type UseDashboardDataQueryInputType = {
+    token: string;
+    dashboardId?: string;
+};
+export type ClientSubsetData = {
+    companyIntegrationId?: string | null;
+    dbName?: string | null;
+    error?: {
+        message: string;
+    } | null;
+    tableList?: {
+        tableName: string;
+        clientColumn?: string | null;
+        columns?: {
+            datatype: string;
+            name: string;
+            as: string;
+        }[] | null;
+    }[] | null;
+} | null;
+export type UseDashboardDataQueryOutputType = {
+    externalDashboard?: any | null;
+    isAllowedToChangeLayout?: boolean | null;
+    isAllowedToCreateMetrics?: boolean | null;
+    isAllowedToDeleteMetrics?: boolean | null;
+    isAllowedToUpdateMetrics?: boolean | null;
+    isAllowedToEmailReports?: boolean | null;
+    isAllowedManageMetrics?: boolean | null;
+    isShowUnderlyingData?: boolean | null;
+    adminTheme?: any | null;
+    clientId?: string | null;
+    companyId?: string | null;
+    companyTenancyType?: string | null;
+    externalMetrics?: (any | null)[] | null;
+    rlsSettings?: any | null;
+    appFilters?: any | null;
+    dashboardAppFilters?: any | null;
+    workspace?: any | null;
+    sharingSettingsId?: string | null;
+    error?: {
+        message: string;
+    } | null;
+    clientSubsetData?: ClientSubsetData;
+    cType?: ClientColumnType;
+    refreshTime?: number | null;
+    isEnableMetricSummary?: boolean;
+    isAllClient?: boolean;
+    metricCreationMode?: string;
+} | null;
+export type UseMetricQueryQueryInputType = {
+    id?: string;
+    clientId?: string;
+    globalFilters?: Record<string, any>;
+    rlsConditions?: any[];
+    filterValues?: Record<string, any>;
+    tenancyLevel?: string;
+    drillFilters?: any[];
+    limit?: number;
+    offset?: number;
+    isAllClient?: boolean;
+    disableStringify?: boolean;
+    pivotHeaders?: string[];
+    timeseriesSettings?: {
+        format: string;
+        seriesField: string;
+    };
+    chartSeriesField?: string;
+    comparisonCount?: number;
+    dynamicXAxis?: {
+        isEnable: boolean;
+        xaxis: string;
+    };
+};
+export type UseMetricQueryQueryOutputType = {
+    data?: any | null;
+    timeTaken?: number | null;
+    totalRecords?: number | null;
+    metaData?: any | null;
+};
+export type UseMetricColumnMutationInputType = {
+    tableName?: string;
+    columnName?: string;
+    wId?: string;
+    filter?: Record<string, any>;
+    customTable?: {
+        query: string;
+        alias: string;
+    };
+    labelColumnName?: string;
+};
+export type UseMetricUnderlyingDataMutationInputType = {
+    columnName?: string;
+    companyId?: string;
+    query?: string;
+    value?: any;
+    workspaceId?: string;
+    metricId?: string;
+    isCustomSql?: boolean;
+};
+export type UseMetricShareCsvMutationInputType = {
+    configurations?: Record<string, any>;
+    emails?: string[];
+    expireCsvFileAt?: string;
+    expireUrlIn?: number;
+    externalMetricId?: string;
+    integrationId?: string;
+    integrationName?: string;
+    query?: string;
+    sharingSettingsId?: string;
+    subject?: string;
+};
+export type UseSaveDashboardLayoutMutationInputType = {
+    clientId: string;
+    externalDashboardId: string;
+    layout: any[];
+    isLocked?: boolean;
+    dashboardFiltersLayout?: any[];
+    gridMargin?: {
+        verticalMargin?: number;
+        horizontalMargin?: number;
+    } | null;
+};
+export type UseDeleteDashboardScheduleReportMutationInputType = {
+    token: string;
+    id: string;
+};
+export type UseSaveDashboardScheduleReportMutationInputType = {
+    emails?: any;
+    externalDashboardId?: string;
+    guestToken?: string;
+    nextScheduledAt?: string;
+    sharingSettingsId?: string;
+    subject?: string;
+    timeConfigurations?: any;
+    data?: any;
+};
+export type UseMarkArchivedMutationInputType = {
+    id?: string;
+};
+export type UsePublishArchivedMetricsMutationInputType = {
+    externalMetricIds?: string[];
+    archiveMetrics?: string[];
+};
+export type UseExecutePythonMutationInputType = {
+    code: string;
+    clientId?: string;
+    companyId: string;
+    rlsConditions?: RlsCondition[];
+};
+export type ExternalMetricsInsertInput = {
+    chartOptions?: any;
+    clientDeletedMetrics?: any;
+    clientId?: string;
+    companyId?: string;
+    companyIntegrationId?: string;
+    createdAt?: string;
+    createdBy?: string;
+    datasetMetricSettings?: any;
+    description?: string;
+    drillDownSettings?: any;
+    externalDashboardMetrics?: any;
+    externalMetricRawCsvUrl?: any;
+    externalMetricsRlsFilters?: any;
+    groupBy?: any;
+    inputFields?: any;
+    integrationName?: string;
+    isCreatedByClient?: boolean;
+    isEnableGroupBy?: boolean;
+    isLive?: boolean;
+    metricId?: string;
+    metricQuery?: string;
+    name?: string;
+    outputColumns?: string;
+    query?: string;
+    resizeAttributes?: any;
+    scheduleEmailReportCharts?: any;
+    selectedGroupBy?: any;
+    timeGrain?: string;
+    updatedAt?: string;
+    elementSettings?: any;
+    isMetric?: boolean;
+};
+export type UseUpdateAdminMetricMutationInputType = {
+    externalMetricId: string;
+    object: ExternalMetricsInsertInput;
+    clientId: string;
+};
+export type ExternalMetricsSetInput = {
+    chartOptions?: any;
+    description?: string;
+    metricId?: string;
+    name?: string;
+    resizeAttributes?: any;
+    updatedAt?: any;
+};
+export type UseUpdateMetricMutationInputType = {
+    externalMetricId: string;
+    set: ExternalMetricsSetInput;
+};
+export type UsePreviewTableMutationInputType = {
+    tableName?: string;
+    limit?: number;
+    integrationId?: string;
+    integrationName?: string;
+};
+export type UseGenerateMetricDataMutationInputType = {
+    questionString: string;
+};
+export type UseGenerateMetricMutationInputType = {
+    userInputs?: any;
+    integrationName?: string;
+    integrationId?: string;
+};
+export type UseDatatsetMetricMutationInputType = {
+    cId: string;
+    configuration: DatasetMetricCreationConfiguration;
+    id: string;
+};
+export type UseNewDatatsetMetricMutationInputType = {
+    configuration: DatasetMetricCreationConfiguration;
+    id: string;
+};
+export type UseGenerateMetricSummaryMutationInputType = {
+    data: Record<string, any>[];
+    wId?: string;
+};
+export type DbChatMetricCreationType = {
+    wId?: string;
+    question: string;
+    config?: any;
+};
+export type DbChatMetricCreationOutputType = {
+    data: any;
+};
+export type UseCreateMetricMutationInputType = {
+    chartOptions?: any;
+    companyId?: string;
+    companyIntegrationId?: string;
+    description?: string;
+    inputFields?: any;
+    integrationName?: string;
+    metricId?: string;
+    metricQuery?: string;
+    name?: string;
+    outputColumns?: string;
+    query?: string;
+    isLive?: boolean;
+    clientId?: string | null;
+    isCreatedByClient?: boolean;
+    createdBy?: string;
+    timeGrain?: string | null;
+    externalDashboardIds?: any;
+    selectedGroupBy?: any;
+    isEnableGroupBy?: boolean;
+    datasetMetricSettings?: any;
+    groupBy?: any;
+    drillDownSettings?: any;
+};
+export type CompanyIntegrations = {
+    companyId: string;
+    companyWorkspace: any;
+    customSqlColumns: any;
+    externalMetrics: any;
+    id: string;
+    integrationId: string;
+    name: string;
+    workspaceId: string;
+};
+export type ExternalMetrics = {
+    chartOptions: any;
+    clickActions: any;
+    clientDeletedMetrics: any;
+    clientId?: string;
+    companyId: string;
+    companyIntegration: CompanyIntegrations;
+    companyIntegrationId: string;
+    createdAt: string;
+    createdBy?: string;
+    datasetMetricSettings?: any;
+    description: string;
+    drillDownSettings?: any;
+    /** An array relationship */
+    externalDashboardMetrics: any;
+    /** An object relationship */
+    externalMetricRawCsvUrl?: any;
+    /** An array relationship */
+    externalMetricsRlsFilters: any;
+    groupBy: any;
+    id: string;
+    inputFields?: any;
+    integrationName: string;
+    isArchived: boolean;
+    isCreatedByClient: boolean;
+    isEnableGroupBy: boolean;
+    isLive: boolean;
+    isMarkedDeleted: boolean;
+    metricId: string;
+    metricQuery?: string;
+    name: string;
+    outputColumns?: string;
+    query: string;
+    resizeAttributes: any;
+    rlsConditions: any;
+    scheduleEmailReportCharts: any;
+    selectedGroupBy: any;
+    timeGrain?: string;
+    updatedAt: string;
+};
+export type ChatCompletionRequestMessage = {
+    /**
+     * The role of the author of this message.
+     * @type {string}
+     * @memberof ChatCompletionRequestMessage
+     */
+    role: 'system' | 'user' | 'assistant';
+    /**
+     * The contents of the message
+     * @type {string}
+     * @memberof ChatCompletionRequestMessage
+     */
+    content: string;
+    /**
+     * The name of the user in a multi-user chat
+     * @type {string}
+     * @memberof ChatCompletionRequestMessage
+     */
+    name?: string;
+};
+export type UseChatApiResponseType = {
+    messages: ChatCompletionRequestMessage[];
+};
+export type SummarizeMetricMutationType = {
+    metricData: any;
+    summaryPrompt: string;
+    key: string;
+    name: string;
+    description: string;
+    workspaceId: string;
+};

package/dist/utils/arrayToCsvString.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @name objectArrayToCsvString - converts array of objects to csv file downloadable link
+ * @param array - array of objects with key value pairs
+ * @returns uri encoded csv data string
+ */
+export declare const objectArrayToCsvString: (array: Record<string, string>[]) => string;

package/dist/utils/colors.d.ts

@@ -0,0 +1,2 @@
+export declare const colors: string[];
+export declare const colorsArray: string[];

package/dist/utils/fetcher.d.ts

@@ -0,0 +1,13 @@
+type ApiResponse<T> = {
+    data: T;
+};
+type FetcherOptions = {
+    method: 'GET' | 'POST';
+    token?: string;
+    data?: object;
+    isFrontend?: boolean;
+    clientId?: string;
+};
+export declare const getToken: () => string | null;
+declare const fetcher: <T>(url: string, options?: FetcherOptions) => Promise<ApiResponse<T>>;
+export default fetcher;

package/dist/utils/getChartAttributes.d.ts

@@ -0,0 +1,98 @@
+type GetLabelsParams = {
+    data: Record<string, any>[] | undefined;
+    xAxis: string | undefined;
+    isDynamicXaxis: boolean;
+    isGroupXAxis: boolean;
+};
+export declare const getLabels: ({ data, xAxis, isDynamicXaxis, isGroupXAxis, }: GetLabelsParams) => string[] | undefined;
+export type GetDatasetsParams = {
+    data: Record<string, any>[] | undefined;
+    yAxisList: string[] | undefined;
+    xAxis: string | undefined;
+    isDynamicXaxis: boolean;
+    isCumulativeBar: boolean;
+    chartType: string;
+    seriesType: string;
+    isGroupXAxis: boolean;
+};
+export declare const getDatasets: ({ data, yAxisList, xAxis, isDynamicXaxis, isCumulativeBar, chartType, seriesType, isGroupXAxis, }: GetDatasetsParams) => {
+    label: string;
+    data: any[] | undefined;
+    borderColor: string;
+}[] | undefined;
+type GetFunnelDataParams = {
+    data: Record<string, any>[] | undefined;
+    measure: string | undefined;
+    step: string | undefined;
+};
+export declare const getFunnelData: ({ data, measure, step }: GetFunnelDataParams) => {
+    value: any;
+    name: any;
+}[];
+type GetSingleValueDataParams = {
+    data: Record<string, any>[] | undefined;
+    singleValue: string | undefined;
+};
+export declare const getSingleValueData: ({ data, singleValue, }: GetSingleValueDataParams) => any[];
+type GetXaxisDataParams = {
+    isTimeSeries: boolean;
+    xAxis: string | undefined;
+    data: Record<string, any>[] | undefined;
+    selectedFormat: string | undefined;
+    fillXAxis: boolean;
+};
+export declare const getXAxisData: ({ isTimeSeries, xAxis, data, selectedFormat, fillXAxis, }: GetXaxisDataParams) => any[];
+export type GetSeriesDataParams = {
+    data: Record<string, any>[] | undefined;
+    xAxis: string | undefined;
+    yAxisList: string[] | undefined;
+    seriesField: string | undefined;
+    isTimeSeries: boolean;
+    selectedFormat: string | undefined;
+    fillXAxis: boolean;
+    isCumulativeBar: boolean;
+    chartType: string;
+    seriesType: string;
+};
+export declare const getSeriesData: ({ data, seriesField, isTimeSeries, xAxis, selectedFormat, fillXAxis, yAxisList, isCumulativeBar, chartType, seriesType, }: GetSeriesDataParams) => any;
+export type GetChartAttributesParams = {
+    data: Record<string, any>[] | undefined;
+    yAxisList: string[] | undefined;
+    xAxis: string | undefined;
+    measure: string | undefined;
+    step: string | undefined;
+    singleValue: string | undefined;
+    seriesField: string | undefined;
+    isTimeSeries: boolean;
+    selectedFormat: string | undefined;
+    fillXAxis: boolean;
+    isDynamicXaxis: boolean;
+    isCumulativeBar: boolean;
+    chartType: string;
+    seriesType: string;
+    isGroupXAxis: boolean;
+};
+export declare const getChartAttributes: ({ data, measure, singleValue, step, xAxis, yAxisList, seriesField, isTimeSeries, selectedFormat, fillXAxis, isDynamicXaxis, isCumulativeBar, chartType, seriesType, isGroupXAxis, }: GetChartAttributesParams) => {
+    labels: string[];
+    datasets: any;
+    funnelData: {
+        value: any;
+        name: any;
+    }[];
+    singleValueData: any[];
+    xAxisData: any[];
+    seriesData: any;
+};
+export declare const transformDataToSankey: ({ data, source, target, value, sankeyColors, }: {
+    data: Record<string, any>[];
+    source: string;
+    target: string;
+    value: any;
+    sankeyColors: string[] | undefined;
+}) => {
+    nodes: {
+        name: any;
+    }[];
+    links: Record<string, any>[];
+};
+export {};

package/dist/utils/getChartImage.d.ts

@@ -0,0 +1,3 @@
+import EChartsReact from 'echarts-for-react';
+declare const getChartImage: (chartRef: React.RefObject<EChartsReact>) => string;
+export default getChartImage;

package/dist/utils/getChartOptions.d.ts

@@ -0,0 +1,42 @@
+/// <reference types="react" />
+import { ChartAppearanceType, ChartSettingsType } from '@/types';
+export declare const truncateText: (label: string, maxLength: number) => string;
+export declare const addPrefixAndSuffix: (val: any, prefix?: any, suffix?: any) => string;
+export declare const findLegendPosition: (val: string | undefined) => {
+    top: string;
+    left: string;
+    right?: undefined;
+    bottom?: undefined;
+} | {
+    top: string;
+    right: string;
+    left?: undefined;
+    bottom?: undefined;
+} | {
+    bottom: string;
+    left: string;
+    top?: undefined;
+    right?: undefined;
+} | {
+    bottom: string;
+    right: string;
+    top?: undefined;
+    left?: undefined;
+};
+export declare const validateColor: (color: any) => boolean;
+export type GetChartOptionsParams = {
+    chartOptions: ChartSettingsType;
+    data: Record<string, any>[];
+    colors?: string[];
+    geoJsonData?: any;
+    isPythonMode?: boolean;
+    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, metricCardColor, }: GetChartOptionsParams) => Record<string, any>;

package/dist/utils/getFormattedDataType.d.ts

@@ -0,0 +1 @@
+export declare const getFormattedDataType: (datatype: string) => 'text' | 'number' | 'boolean';

package/dist/utils/getNoAxisChartOptions.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="react" />
+import { ChartAppearanceType, ChartSettingsType } from '@/types';
+export type GetNoAxisChartOptionsParams = {
+    chartOptions: ChartSettingsType;
+    data: Record<string, any>[];
+    colors?: string[];
+    datasets?: any;
+    labels?: any;
+    funnelData?: {
+        value: any;
+        name: any;
+    }[];
+    singleValueData?: any;
+    geoJsonData?: any;
+    mapColors?: string[];
+    progressData?: any;
+    barGradient?: any;
+    labelFormatSettings: any;
+    bgColors: string[];
+    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, metricCardColor, }: GetNoAxisChartOptionsParams) => Record<string, any>;

package/dist/utils/getValidJson.d.ts

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

package/dist/utils/index.d.ts

@@ -0,0 +1,9 @@
+export * from './theme';
+export * from './getChartAttributes';
+export * from './colors';
+export * from './getFormattedDataType';
+export * from './arrayToCsvString';
+export * from './popoverPosition';
+export * from './colors';
+export * from './getValidJson';
+export * from './getChartOptions';

package/dist/utils/pivotDataTransform.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @name pivotDataTransform - converts array of objects to pivot csv data
+ * @param chartOptions - includes chart properties, data - array of objects including data for the chart
+ * @returns array containing pivoted data
+ */
+import { ChartSettingsType } from '@/types';
+export declare const pivotDataTransform: (chartOptions: ChartSettingsType | undefined, data: Record<string, string>[]) => any[];

package/dist/utils/popoverPosition.d.ts

@@ -0,0 +1,2 @@
+export declare const getPopoverPosition: (e: any, parentDimension: DOMRect, popupDimension: DOMRect) => [number, number];
+export declare const setPopoverPosition: (popoverDiv: HTMLDivElement, x: number, y: number) => void;

package/dist/utils/theme.d.ts

@@ -0,0 +1,42 @@
+/**
+ * colors - object of customizable colors
+ * typography - object of customizable typography
+ * border - object of customizable border
+ * shadow - object of customizable box shadow
+ * breakpoint - object of customizable breakpoint
+ * metricLayoutCols - object of customizable metric chart layout columns
+ */
+export interface ThemeType {
+    button?: {
+        primary?: string;
+        secondary?: string;
+        primaryText?: string;
+        secondaryText?: string;
+    };
+    checkbox?: {
+        checked?: string;
+        unChecked?: string;
+    };
+    switch?: {
+        enabled?: string;
+        disabled?: string;
+    };
+    datePickerColor?: string;
+    manageMetricsStyle?: Record<string, any>;
+    breakpoint?: {
+        xl?: number;
+        lg?: number;
+        md?: number;
+        sm?: number;
+        xs?: number;
+    };
+    metricLayoutCols?: {
+        xl?: number;
+        lg?: number;
+        md?: number;
+        sm?: number;
+        xs?: number;
+        xxs?: number;
+    };
+}
+export declare const applyTheme: (theme: ThemeType) => void;

package/dist/webcomponents.d.ts

@@ -0,0 +1,16 @@
+import { DashboardProps } from './containers/Dashboard';
+import { Chart, ChartProps } from './components';
+import { MetricProps } from './containers/Metric';
+import { CreateEmbedMetricProps } from './containers/CreateMetric/CreateEmbeddedMetric';
+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;
+        'dbn-dashboard': DashboardProps;
+        'dbn-metric': MetricProps;
+        'dbn-chart': ChartProps;
+        'dbn-create-metric': CreateEmbedMetricProps;
+    }
+}
+export type { DashboardProps, MetricProps, ChartProps, CreateEmbedMetricProps };
+export { Chart };