@redsift/dashboard 11.5.0 → 11.6.0-muiv5-alpha.1

package/index.d.ts

@@ -1,228 +1,15 @@
-import * as crossfilter2 from 'crossfilter2';
-import { Crossfilter, Group as Group$1, NaturallyOrderedValue, Dimension as Dimension$1, ComparableObject, OrderedValueSelector } from 'crossfilter2';
+export { Dimension, DimensionSelector, Group, GroupSelector, JSONArray, JSONObject, JSONValue, TNdx } from './types.js';
 export { ChartSize, ColorTheme } from '@redsift/charts';
-import { Comp, ButtonProps, ValueOf, Theme } from '@redsift/design-system';
-import React, { ComponentProps, RefObject, MutableRefObject, Dispatch } from 'react';
-import { GridFilterItem } from '@redsift/table';
-import { GridApi } from '@mui/x-data-grid-pro';
-
-type JSONValue = string | number | boolean | {
-    [x: string]: JSONValue;
-} | Array<JSONValue> | undefined | null;
-type JSONObject = {
-    [x: string]: JSONValue;
-};
-type JSONArray = Array<JSONObject>;
-type TNdx = Crossfilter<any>;
-type Group = Group$1<any, NaturallyOrderedValue, unknown>;
-type GroupSelector = (group: Group) => Group;
-type Dimension = Dimension$1<any, string | number | boolean | ComparableObject>;
-type DimensionSelector = OrderedValueSelector<any, NaturallyOrderedValue | NaturallyOrderedValue[]>;
-
-declare const COUNT: (d: Dimension) => crossfilter2.Group<any, crossfilter2.NaturallyOrderedValue, unknown>;
-
-declare const groupReduceSum: (field: string) => (d: Dimension) => crossfilter2.Group<any, crossfilter2.NaturallyOrderedValue, unknown>;
-declare const SUM: (field: string) => (d: Dimension) => crossfilter2.Group<any, crossfilter2.NaturallyOrderedValue, unknown>;
-
-/**
- * Component props.
- */
-interface ChartEmptyStateProps extends ComponentProps<'div'> {
-    /** Method to call when the reset button is pressed. Also conditioned whether the button is displayed or not. */
-    onReset?: () => void;
-    /** Reset button label. */
-    resetLabel?: string;
-    /** Subtitle. */
-    subtitle?: string;
-    /** Title. */
-    title?: string;
-}
-
-declare const ChartEmptyState: Comp<ChartEmptyStateProps, HTMLDivElement>;
-
-/**
- * Context props.
- */
-type DashboardContextProps = {
-    dashboardRef?: RefObject<HTMLDivElement>;
-    data: JSONArray;
-    dataGridApiRef?: MutableRefObject<GridApi>;
-    dispatch: Dispatch<DashboardReducerAction>;
-    state: DashboardReducerState;
-    toggleUpdateContext?: () => void;
-};
-/**
- * Reducer props.
- */
-type DashboardReducerState = {
-    tableFilters: GridFilterItem[];
-};
-declare enum DashboardReducerActionType {
-    ResetFilter = "reset-filter",
-    ResetFilters = "reset-filters",
-    FilterTable = "filter-table",
-    FilterTableBatch = "filter-table-batch",
-    AppendFilterTableBatch = "append-filter-table-batch"
-}
-type DashboardReducerAction = {
-    type: DashboardReducerActionType;
-    filter?: GridFilterItem | GridFilterItem[];
-};
-/**
- * Component props.
- */
-interface DashboardProps extends ComponentProps<'div'> {
-    /** Dataset that will be share across every components within the dashboard. */
-    data: JSONArray;
-    /** Datagrid API Ref. */
-    dataGridApiRef?: MutableRefObject<GridApi>;
-}
-
-declare const Dashboard: Comp<DashboardProps, HTMLDivElement>;
-
-declare const initialState: DashboardReducerState;
-declare const DashboardContext: React.Context<DashboardContextProps>;
-
-declare const DashboardReducer: (state: DashboardReducerState, action: DashboardReducerAction) => DashboardReducerState;
-
-interface LocaleText$2 {
-    maxSizeDisclaimer?: string;
-}
-interface PdfExportButtonProps extends ButtonProps {
-    /** Ref to the DOM component to export. By default, will be the ref to the parent Dashboard. */
-    componentRef?: RefObject<HTMLElement>;
-    /** Name of the exported PDF file. */
-    fileName?: string;
-    /** Text to display at the beginning of the PDF. */
-    introduction?: string;
-    /** Labels and texts. */
-    localeText?: LocaleText$2;
-    /** Image to put at the top of the PDF (SVG format not supported). */
-    logo?: string;
-    /** Function to be executed when button is clicked. */
-    onClick?: () => void;
-    /** Color used for the header and footer of the PDF. */
-    primaryColor?: string;
-}
-
-declare const PdfExportButton: Comp<PdfExportButtonProps, HTMLButtonElement>;
-
-type SuccessDangerColorTheme = {
-    success: string;
-    warning: string;
-    danger: string;
-    neutral?: string;
-};
-/**
- * Component size.
- */
-declare const TimeSeriesBarChartSize: {
-    readonly large: "large";
-    readonly medium: "medium";
-    readonly small: "small";
-};
-type TimeSeriesBarChartSize = ValueOf<typeof TimeSeriesBarChartSize>;
-/**
- * Component theme.
- */
-declare const TimeSeriesBarChartTheme: {
-    readonly default: "default";
-    readonly dark: "dark";
-    readonly darker: "darker";
-    readonly darkerer: "darkerer";
-    readonly light: "light";
-    readonly lighter: "lighter";
-    readonly lighterer: "lighterer";
-    readonly monochrome: "monochrome";
-};
-type TimeSeriesBarChartTheme = ValueOf<typeof TimeSeriesBarChartTheme>;
-type datetimeEnum = 'hour' | 'day' | 'week' | 'month' | 'year';
-interface LocaleText$1 {
-    emptyChartTitle?: string;
-    emptyChartSubtitle?: string;
-    emptyChartResetLabel?: string;
-    resetLabel?: string;
-}
-/**
- * Component props.
- */
-interface TimeSeriesBarChartProps extends ComponentProps<'div'> {
-    /** Caption. */
-    caption?: string;
-    /** Whether the x axis labels are rotated or not. */
-    areXLabelsRotated?: boolean;
-    /** Field value of the DataGrid column to filter. */
-    columnToFilter?: string;
-    /** Dataset to use to generate the chart, if no context is provided. */
-    data?: JSONArray;
-    /** Name of the dataset field that contains the datetime value. */
-    dateTimeFieldName: string;
-    /** Format used for the date and time values in the dataset by d3.js. Should follow https://github.com/d3/d3-time-format#locale_format. */
-    dateTimeFormat?: string;
-    /** Datetime unit to used to group values and for x units. */
-    dateTimeGroup?: datetimeEnum;
-    /** Method that will be used by crossfilter to compute the dimensions of the charts. */
-    dimension: DimensionSelector;
-    /** Whether the reset button is hidden or not. */
-    isResetable?: boolean;
-    /** Overriden values for internal labels and texts. */
-    localeText?: LocaleText$1;
-    /** Method to call when a filter occured on the chart. */
-    onFilter?: (filters?: string[], allFiltered?: JSONArray) => void;
-    /** TimeSeriesChart size. */
-    size?: TimeSeriesBarChartSize;
-    /** Color palette to use. You can choose among the list of available color palette or also choose to use the success/warning/danger theme for which you have to specify which key corresponds to which status.  */
-    colorTheme?: TimeSeriesBarChartTheme | SuccessDangerColorTheme;
-    /** Title. */
-    title?: string;
-    /** Dataset key to use to stack values. */
-    stackedCategory?: string;
-    /** X Axis Label. */
-    xAxisLabel?: string;
-    /** Y Axis Label. */
-    yAxisLabel?: string;
-}
-type StyledTimeSeriesBarChartProps = Omit<TimeSeriesBarChartProps, 'dimension' | 'dateTimeFieldName'> & {
-    $theme: Theme;
-};
-
-declare const TimeSeriesBarChart: Comp<TimeSeriesBarChartProps, HTMLDivElement>;
-
-interface LocaleText {
-    emptyChartTitle?: string;
-    emptyChartSubtitle?: string;
-    emptyChartResetLabel?: string;
-    resetLabel?: string;
-}
-type CategoryFilterType = {
-    field: string;
-    operator: 'containsAnyOf' | 'endsWithAnyOf' | 'isAnyOf' | 'startsWithAnyOf';
-};
-type CoordinateFilterType = {
-    field: string;
-    operator: 'isBetween';
-};
-interface WithFiltersProps extends ComponentProps<'div'> {
-    /** In case of a chart based on one dimension (category), which datagrid column the chart is filtering and using which operator. */
-    datagridCategoryDimFilter?: CategoryFilterType;
-    /** In case of a chart based on two dimension coordinates (x, y), which datagrid columns the chart is filtering. */
-    datagridCoordinatesCategoryDimFilter?: [CoordinateFilterType, CoordinateFilterType] | [CoordinateFilterType, CoordinateFilterType, CategoryFilterType];
-    /** Method that will be used by crossfilter to compute the dimensions of the charts. */
-    dimension?: DimensionSelector;
-    /** Method that will be used by crossfilter to compute the groups of the charts. */
-    group?: (d: Dimension) => Group;
-    /** Whether the dimension field is an array or not. */
-    isDimensionArray?: boolean;
-    /** Whether the reset button is hidden or not. */
-    isResetable?: boolean;
-    /** Overriden values for internal labels and texts. */
-    localeText?: LocaleText;
-    /** Method to call when a filter occured on the chart. */
-    onFilter?: (filters?: NaturallyOrderedValue[] | any) => void;
-}
-interface ChartsWithFiltersProps extends Required<Pick<WithFiltersProps, 'dimension'>>, Omit<WithFiltersProps, 'dimension'> {
-}
-
-declare const WithFilters: React.FC<WithFiltersProps>;
-
-export { COUNT, ChartEmptyState, ChartEmptyStateProps, ChartsWithFiltersProps, Dashboard, DashboardContext, DashboardContextProps, DashboardProps, DashboardReducer, DashboardReducerAction, DashboardReducerActionType, DashboardReducerState, Dimension, DimensionSelector, Group, GroupSelector, JSONArray, JSONObject, JSONValue, PdfExportButton, SUM, StyledTimeSeriesBarChartProps, TNdx, TimeSeriesBarChart, TimeSeriesBarChartProps, TimeSeriesBarChartSize, TimeSeriesBarChartTheme, WithFilters, WithFiltersProps, datetimeEnum, groupReduceSum, initialState };
+export { COUNT } from './utils/groupReducers/groupReduceCount.js';
+export { SUM, groupReduceSum } from './utils/groupReducers/groupReduceSum.js';
+export { ChartEmptyState } from './components/ChartEmptyState/ChartEmptyState.js';
+export { ChartEmptyStateProps } from './components/ChartEmptyState/types.js';
+export { Dashboard } from './components/Dashboard/Dashboard.js';
+export { DashboardContext, initialState } from './components/Dashboard/context.js';
+export { DashboardReducer } from './components/Dashboard/reducer.js';
+export { DashboardContextProps, DashboardProps, DashboardReducerAction, DashboardReducerActionType, DashboardReducerState } from './components/Dashboard/types.js';
+export { PdfExportButton } from './components/PdfExportButton/PdfExportButton.js';
+export { TimeSeriesBarChart } from './components/TimeSeriesBarChart/TimeSeriesBarChart.js';
+export { StyledTimeSeriesBarChartProps, TimeSeriesBarChartProps, TimeSeriesBarChartSize, TimeSeriesBarChartTheme, datetimeEnum } from './components/TimeSeriesBarChart/types.js';
+export { WithFilters } from './components/WithFilters/WithFilters.js';
+export { ChartsWithFiltersProps, WithFiltersProps } from './components/WithFilters/types.js';