react-semaphor 0.0.146 → 0.0.147

package/dist/types/dashboard.d.ts

@@ -0,0 +1,314 @@
+import { FontSpec } from 'chart.js';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+
+export declare type AggregateCalc = 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'COUNT' | 'COUNT_DISTINCT';
+
+export declare type AuthToken = {
+    accessToken: string;
+    refreshToken: string;
+};
+
+declare type BaseCustomCard = {
+    cardId: string;
+    replaceDefault?: boolean;
+};
+
+declare type BaseFilter = {
+    filterId: TFilter['id'];
+    expression?: string;
+    name: string;
+    valueType: 'string' | 'number' | 'date' | 'boolean';
+    connectionType?: 'database' | 'api';
+};
+
+export declare type Bookmark = {
+    name: string;
+    default: boolean;
+    template: TDashboard;
+    filterValues?: TFilterValue[];
+};
+
+export declare type Breakpoint = 'lg' | 'md' | 'sm' | 'xs' | 'xxs';
+
+declare type CardWithContent = BaseCustomCard & {
+    content: React.FC<{
+        card: TCard;
+    }>;
+    footer?: React.FC<{
+        card: TCard;
+    }>;
+};
+
+declare type CardWithFooter = BaseCustomCard & {
+    content?: React.FC<{
+        card: TCard;
+    }>;
+    footer: React.FC<{
+        card: TCard;
+    }>;
+};
+
+export declare type ConnectionPolicy = {
+    connectionId?: string;
+    name: string;
+    params: Params;
+};
+
+export declare type CustomCard = CardWithContent | CardWithFooter;
+
+export declare function Dashboard(props: DashboardProps): JSX_2.Element;
+
+export declare type DashboardProps = {
+    id: string;
+    authToken: AuthToken | undefined;
+    style?: TStyle;
+    currentTheme?: Theme;
+    version?: string;
+    customCards?: CustomCard[];
+    onChartElementClicked?: (card: TCard, fieldValues: any) => void;
+    onEvent?: (event: TEvent) => void;
+    onSave?: (dashboard: TDashboard) => void;
+    LoadingComponent?: (props: LoadingProps) => React.ReactNode;
+    ErrorComponent?: (props: ErrorProps) => React.ReactNode;
+};
+
+export declare type ErrorProps = {
+    message?: string;
+};
+
+declare type FilterForBetween = BaseFilter & {
+    operation: 'between' | 'not between';
+    values: [number, number];
+};
+
+declare type FilterForCompare = BaseFilter & {
+    operation: '>' | '<' | '>=' | '<=';
+    values: [number];
+};
+
+declare type FilterForDate = BaseFilter & {
+    operation: 'between' | 'not between';
+    values: [Date, Date];
+};
+
+declare type FilterForEqual = BaseFilter & {
+    operation: '=' | '!=' | 'is null' | 'is not null';
+    values: [string | number];
+};
+
+declare type FilterForIn = BaseFilter & {
+    operation: 'in' | 'not in';
+    values: (string | number)[];
+};
+
+declare type FilterForString = BaseFilter & {
+    operation: 'like' | 'not like';
+    values: [string];
+};
+
+declare type FilterOnClick = {
+    expression?: string;
+    columnIndex: number;
+};
+
+export declare type KPICardProps = {
+    card: TCard;
+    isLoading: boolean;
+};
+
+export declare type LoadingProps = {
+    message?: string;
+};
+
+declare type Operation = '=' | '>' | '<' | '>=' | '<=' | '!=' | 'in' | 'not in' | 'like' | 'not like' | 'between' | 'not between' | 'is null' | 'is not null';
+
+declare type Params = {
+    [key: string]: string | number | string[] | number[];
+};
+
+export declare type SqlGen = {
+    measures?: {
+        name: string;
+        calc: AggregateCalc;
+    }[];
+    dimensions?: string[];
+};
+
+/**
+ * Style propeerites for the dashboard
+ */
+export declare type StyleProps = {
+    /** css class for `dashboard-panel` */
+    dashboardPanel?: string;
+    /** css class for `dashboard-tabs-container` */
+    dashboardTabsContainer?: string;
+    /** css class for `dashboard-card` */
+    /** css class for `dashboard-card-container` */
+    dashboardCardContainer?: string;
+    dashboardCard?: string;
+    /** grid-layout config */
+    gridLayout?: {
+        /** css class for `react-grid-layout` */
+        className?: string;
+        margin?: [number, number];
+    };
+    /** chart config */
+    chart?: {
+        /** chart font config */
+        font?: Partial<FontSpec>;
+        dataset?: any;
+        /** chart options */
+        options?: any;
+    };
+};
+
+export declare type TBaseQuery = {
+    id: string;
+    name: string;
+    sql: string;
+    description?: string;
+};
+
+export declare type TCard = {
+    id: string;
+    title: string;
+    description?: string;
+    info?: string;
+    connectionId?: string;
+    type: TChartType;
+    sql?: string;
+    python?: string;
+    data?: any[];
+    cfg?: any;
+    customCfg?: any;
+    preferences?: TCardPreferences;
+    lastSelectedDatabase?: string;
+    lastSelectedSchema?: string;
+    lastSelectedTable?: string;
+    refreshInterval?: string;
+};
+
+export declare type TCardContext = {
+    id: string;
+    name: string;
+    description: string;
+    sql: string;
+};
+
+export declare type TCardPreferences = {
+    onClickFilter?: FilterOnClick[];
+    filterOnClick?: boolean;
+    filterOnClickField?: string;
+    filterOnClickColumnIndex?: number;
+    formatNumber?: {
+        format?: string;
+        currency?: string;
+        locale?: string;
+        suffix?: string;
+        enabled?: boolean | string;
+    };
+    datasetOptions?: TDatasetOptions[];
+    chartOptions?: TChartOptions;
+};
+
+export declare type TChartOptions = {
+    type?: TChartType;
+    scales?: {
+        y?: {
+            type: 'linear' | 'logarithmic';
+            min: number;
+            max: number;
+            ticks: {
+                stepSize: number;
+            };
+        };
+        x?: {
+            type: 'linear' | 'logarithmic';
+            min: number;
+            max: number;
+            ticks: {
+                stepSize: number;
+            };
+        };
+    };
+    indexAxis?: 'x' | 'y' | undefined;
+};
+
+declare type TChartType = 'bar' | 'horizontalBar' | 'line' | 'pie' | 'doughnut' | 'radar' | 'polarArea' | 'bubble' | 'scatter' | 'stackedBar' | 'table' | 'kpi' | 'custom';
+
+export declare type TDashboard = {
+    id: string;
+    title?: string;
+    description?: string;
+    sheets?: TSheet[];
+    style?: TStyle;
+    filters?: TFilter[];
+    customCards?: CustomCard[];
+    baseQueries?: TBaseQuery[];
+};
+
+export declare type TDataColumn = {
+    column_name: string;
+    data_type: string;
+    is_nullable?: string;
+};
+
+export declare type TDatasetOptions = {
+    idx: number;
+    type?: 'bar' | 'line';
+    fill?: string | number;
+    datalabels?: {
+        display?: boolean;
+        align?: string;
+        anchor?: string;
+        clamp?: boolean;
+        color?: string;
+    };
+};
+
+export declare type TEvent = {
+    type: 'success' | 'error' | 'info' | 'warning';
+    message: any;
+};
+
+declare type TFilter = {
+    id: string;
+    connectionId: string;
+    title: string;
+    column: string;
+    dataType: string;
+    table: string;
+    database: string;
+    sql: string;
+    operation: Operation;
+};
+
+declare type TFilterValue = FilterForString | FilterForEqual | FilterForCompare | FilterForBetween | FilterForIn | FilterForDate;
+
+export declare type TFrame = {
+    id: string;
+    cards: TCard[];
+    activeCardId: string;
+};
+
+export declare type Theme = 'dark' | 'light' | 'system';
+
+export declare type TSheet = {
+    id: string;
+    title?: string;
+    description?: string;
+    layout?: ReactGridLayout.Layout[];
+    layouts?: ReactGridLayout.Layouts;
+    cards?: TCard[];
+    frames?: TFrame[];
+};
+
+/**
+ * Style for the dashboard
+ */
+export declare type TStyle = {
+    default: StyleProps;
+    dark?: StyleProps;
+};
+
+export { }

package/dist/types/index.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/types/index.js

@@ -0,0 +1 @@
+

package/dist/{index.d.ts → types/main.d.ts}

@@ -184,8 +184,6 @@ declare type DashboardCardProps = {
     fetchCardData?: boolean;
 } & React_2.HTMLAttributes<HTMLDivElement>;
 
-export declare function DashboardPlus({ showControls, showFooter, ...rest }: DashboardPlusProps): JSX_2.Element;
-
 declare type DashboardPlusProps = {
     showControls?: boolean;
     showFooter?: boolean;
@@ -231,8 +229,6 @@ export declare type DashboardStore = {
     actions: Actions;
 };
 
-export declare const DashboardWC: CustomElementConstructor;
-
 export declare const DATE_DATA_TYPES: string[];
 
 declare type EditorStore = {
@@ -414,6 +410,8 @@ export declare type StyleProps = {
     };
 };
 
+export declare function Surfboard({ showControls, showFooter, ...rest }: DashboardPlusProps): JSX_2.Element;
+
 export declare type TBaseQuery = {
     id: string;
     name: string;
@@ -578,24 +576,8 @@ export declare function useCard(cardId: string): {
     cfg: TChartConfiguration | undefined;
 };
 
-export declare function useDashboard({ id, version, authToken, customStyle, currentTheme, onSave, onEvent, }: UseDashboardProps): {
-    isLoading: boolean;
-    isError: boolean;
-};
-
 export declare const useDashboardActions: () => Actions;
 
-declare type UseDashboardProps = {
-    id: string;
-    version?: string;
-    authToken: AuthToken | undefined;
-    customStyle?: TStyle;
-    currentTheme?: 'light' | 'dark' | 'system';
-    onSave?: (dashboard: TDashboard) => void;
-    onEvent?: (event: TEvent) => void;
-    customCards?: CustomCard[];
-};
-
 export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardStore>, "setState"> & {
     setState(nextStateOrUpdater: DashboardStore | Partial<DashboardStore> | ((state: {
         authToken?: {

package/dist/types/surfboard.d.ts

@@ -0,0 +1,319 @@
+import { FontSpec } from 'chart.js';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+
+export declare type AggregateCalc = 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'COUNT' | 'COUNT_DISTINCT';
+
+export declare type AuthToken = {
+    accessToken: string;
+    refreshToken: string;
+};
+
+declare type BaseCustomCard = {
+    cardId: string;
+    replaceDefault?: boolean;
+};
+
+declare type BaseFilter = {
+    filterId: TFilter['id'];
+    expression?: string;
+    name: string;
+    valueType: 'string' | 'number' | 'date' | 'boolean';
+    connectionType?: 'database' | 'api';
+};
+
+export declare type Bookmark = {
+    name: string;
+    default: boolean;
+    template: TDashboard;
+    filterValues?: TFilterValue[];
+};
+
+export declare type Breakpoint = 'lg' | 'md' | 'sm' | 'xs' | 'xxs';
+
+declare type CardWithContent = BaseCustomCard & {
+    content: React.FC<{
+        card: TCard;
+    }>;
+    footer?: React.FC<{
+        card: TCard;
+    }>;
+};
+
+declare type CardWithFooter = BaseCustomCard & {
+    content?: React.FC<{
+        card: TCard;
+    }>;
+    footer: React.FC<{
+        card: TCard;
+    }>;
+};
+
+export declare type ConnectionPolicy = {
+    connectionId?: string;
+    name: string;
+    params: Params;
+};
+
+export declare type CustomCard = CardWithContent | CardWithFooter;
+
+declare type DashboardPlusProps = {
+    showControls?: boolean;
+    showFooter?: boolean;
+} & DashboardProps;
+
+export declare type DashboardProps = {
+    id: string;
+    authToken: AuthToken | undefined;
+    style?: TStyle;
+    currentTheme?: Theme;
+    version?: string;
+    customCards?: CustomCard[];
+    onChartElementClicked?: (card: TCard, fieldValues: any) => void;
+    onEvent?: (event: TEvent) => void;
+    onSave?: (dashboard: TDashboard) => void;
+    LoadingComponent?: (props: LoadingProps) => React.ReactNode;
+    ErrorComponent?: (props: ErrorProps) => React.ReactNode;
+};
+
+export declare type ErrorProps = {
+    message?: string;
+};
+
+declare type FilterForBetween = BaseFilter & {
+    operation: 'between' | 'not between';
+    values: [number, number];
+};
+
+declare type FilterForCompare = BaseFilter & {
+    operation: '>' | '<' | '>=' | '<=';
+    values: [number];
+};
+
+declare type FilterForDate = BaseFilter & {
+    operation: 'between' | 'not between';
+    values: [Date, Date];
+};
+
+declare type FilterForEqual = BaseFilter & {
+    operation: '=' | '!=' | 'is null' | 'is not null';
+    values: [string | number];
+};
+
+declare type FilterForIn = BaseFilter & {
+    operation: 'in' | 'not in';
+    values: (string | number)[];
+};
+
+declare type FilterForString = BaseFilter & {
+    operation: 'like' | 'not like';
+    values: [string];
+};
+
+declare type FilterOnClick = {
+    expression?: string;
+    columnIndex: number;
+};
+
+export declare type KPICardProps = {
+    card: TCard;
+    isLoading: boolean;
+};
+
+export declare type LoadingProps = {
+    message?: string;
+};
+
+declare type Operation = '=' | '>' | '<' | '>=' | '<=' | '!=' | 'in' | 'not in' | 'like' | 'not like' | 'between' | 'not between' | 'is null' | 'is not null';
+
+declare type Params = {
+    [key: string]: string | number | string[] | number[];
+};
+
+export declare type SqlGen = {
+    measures?: {
+        name: string;
+        calc: AggregateCalc;
+    }[];
+    dimensions?: string[];
+};
+
+/**
+ * Style propeerites for the dashboard
+ */
+export declare type StyleProps = {
+    /** css class for `dashboard-panel` */
+    dashboardPanel?: string;
+    /** css class for `dashboard-tabs-container` */
+    dashboardTabsContainer?: string;
+    /** css class for `dashboard-card` */
+    /** css class for `dashboard-card-container` */
+    dashboardCardContainer?: string;
+    dashboardCard?: string;
+    /** grid-layout config */
+    gridLayout?: {
+        /** css class for `react-grid-layout` */
+        className?: string;
+        margin?: [number, number];
+    };
+    /** chart config */
+    chart?: {
+        /** chart font config */
+        font?: Partial<FontSpec>;
+        dataset?: any;
+        /** chart options */
+        options?: any;
+    };
+};
+
+export declare function Surfboard({ showControls, showFooter, ...rest }: DashboardPlusProps): JSX_2.Element;
+
+export declare type TBaseQuery = {
+    id: string;
+    name: string;
+    sql: string;
+    description?: string;
+};
+
+export declare type TCard = {
+    id: string;
+    title: string;
+    description?: string;
+    info?: string;
+    connectionId?: string;
+    type: TChartType;
+    sql?: string;
+    python?: string;
+    data?: any[];
+    cfg?: any;
+    customCfg?: any;
+    preferences?: TCardPreferences;
+    lastSelectedDatabase?: string;
+    lastSelectedSchema?: string;
+    lastSelectedTable?: string;
+    refreshInterval?: string;
+};
+
+export declare type TCardContext = {
+    id: string;
+    name: string;
+    description: string;
+    sql: string;
+};
+
+export declare type TCardPreferences = {
+    onClickFilter?: FilterOnClick[];
+    filterOnClick?: boolean;
+    filterOnClickField?: string;
+    filterOnClickColumnIndex?: number;
+    formatNumber?: {
+        format?: string;
+        currency?: string;
+        locale?: string;
+        suffix?: string;
+        enabled?: boolean | string;
+    };
+    datasetOptions?: TDatasetOptions[];
+    chartOptions?: TChartOptions;
+};
+
+export declare type TChartOptions = {
+    type?: TChartType;
+    scales?: {
+        y?: {
+            type: 'linear' | 'logarithmic';
+            min: number;
+            max: number;
+            ticks: {
+                stepSize: number;
+            };
+        };
+        x?: {
+            type: 'linear' | 'logarithmic';
+            min: number;
+            max: number;
+            ticks: {
+                stepSize: number;
+            };
+        };
+    };
+    indexAxis?: 'x' | 'y' | undefined;
+};
+
+declare type TChartType = 'bar' | 'horizontalBar' | 'line' | 'pie' | 'doughnut' | 'radar' | 'polarArea' | 'bubble' | 'scatter' | 'stackedBar' | 'table' | 'kpi' | 'custom';
+
+export declare type TDashboard = {
+    id: string;
+    title?: string;
+    description?: string;
+    sheets?: TSheet[];
+    style?: TStyle;
+    filters?: TFilter[];
+    customCards?: CustomCard[];
+    baseQueries?: TBaseQuery[];
+};
+
+export declare type TDataColumn = {
+    column_name: string;
+    data_type: string;
+    is_nullable?: string;
+};
+
+export declare type TDatasetOptions = {
+    idx: number;
+    type?: 'bar' | 'line';
+    fill?: string | number;
+    datalabels?: {
+        display?: boolean;
+        align?: string;
+        anchor?: string;
+        clamp?: boolean;
+        color?: string;
+    };
+};
+
+export declare type TEvent = {
+    type: 'success' | 'error' | 'info' | 'warning';
+    message: any;
+};
+
+declare type TFilter = {
+    id: string;
+    connectionId: string;
+    title: string;
+    column: string;
+    dataType: string;
+    table: string;
+    database: string;
+    sql: string;
+    operation: Operation;
+};
+
+declare type TFilterValue = FilterForString | FilterForEqual | FilterForCompare | FilterForBetween | FilterForIn | FilterForDate;
+
+export declare type TFrame = {
+    id: string;
+    cards: TCard[];
+    activeCardId: string;
+};
+
+export declare type Theme = 'dark' | 'light' | 'system';
+
+export declare type TSheet = {
+    id: string;
+    title?: string;
+    description?: string;
+    layout?: ReactGridLayout.Layout[];
+    layouts?: ReactGridLayout.Layouts;
+    cards?: TCard[];
+    frames?: TFrame[];
+};
+
+/**
+ * Style for the dashboard
+ */
+export declare type TStyle = {
+    default: StyleProps;
+    dark?: StyleProps;
+};
+
+export { }