@sisense/sdk-ui 0.11.3

package/dist/charts/indicator/indicator-legacy-chart-options/override-with-value-color.d.ts

@@ -0,0 +1,35 @@
+import { IndicatorDataOptions, ConditionalDataColorOptions, DataColorOptions, UniformDataColorOptions } from '../../../types';
+import { LegacyIndicatorChartOptions } from '../types';
+import { IndicatorTypeOptions } from './indicator-legacy-chart-options';
+/**
+ * Type that represents allowed color options for an indicator.
+ */
+export type AllowedIndicatorColorOptions = string | UniformDataColorOptions | ConditionalDataColorOptions;
+/**
+ * Type that represents allowed coloring types for an indicator.
+ */
+export type AllowedIndicatorColoringTypes = 'Static' | 'Absolute';
+/**
+ * Returns the color options from the indicator data options.
+ *
+ * @param dataOptions - The indicator data options to extract the color options from.
+ * @returns The color options from the indicator data options.
+ */
+export declare function getValueColorOptions(dataOptions: IndicatorDataOptions): DataColorOptions | undefined;
+/**
+ * Overrides the value color in the legacy indicator chart options with the specified color.
+ *
+ * @param colorOptions - The color options for the indicator.
+ * @param value - The value to determine the color.
+ * @param legacyChartOptions - The legacy indicator chart options to modify.
+ * @param typeOptions - Describe indicator type and subtype.
+ * @returns The modified legacy indicator chart options.
+ */
+export declare function overrideWithValueColor(colorOptions: DataColorOptions, value: number, legacyChartOptions: LegacyIndicatorChartOptions, typeOptions: IndicatorTypeOptions): LegacyIndicatorChartOptions;
+/**
+ * Checks if the color options are allowed for an indicator.
+ *
+ * @param colorOptions - The color options to check.
+ * @returns True if the color options are allowed, false otherwise.
+ */
+export declare function isAllowedIndicatorColorOptions(colorOptions: DataColorOptions): colorOptions is AllowedIndicatorColorOptions;

package/dist/charts/indicator/indicator-legacy-chart-options/utils/override-with-custom-settings.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Overrides the default options with custom settings based on a mapping dictionary.
+ *
+ * @param customSettings - The custom settings to apply.
+ * @param defaultOptionsToCustomSettingsDictionary - The dictionary mapping default options to custom settings keys.
+ * @param defaultOptions - The default options to override.
+ * @returns The overridden options object.
+ * @example
+  const customSettings = { a: { b: { c: 'custom_cc' } } };
+  const defaultOptions = { aa: { bb: { cc: 'cc' } }, cc: 'cc' };
+  const customSettingsToDefaultOptionsDictionary = {
+    'aa.bb.cc': 'a.b.c',
+    cc: 'a.b.c',
+  };
+  const overriddenOptions = overrideWithCustomSettings(
+      customSettings,
+      customSettingsToDefaultOptionsDictionary,
+      defaultOptions,
+    );
+  // overriddenOptions = { aa: { bb: { cc: 'custom_cc' } }, cc: 'custom_cc' };
+ */
+export declare function overrideWithCustomSettings<DefaultOptions extends Record<string, any>>(customSettings: Record<string, any>, defaultOptionsToCustomSettingsDictionary: Record<string, string>, defaultOptions: DefaultOptions): DefaultOptions;

package/dist/charts/indicator/types.d.ts

@@ -0,0 +1,118 @@
+export type LegacyIndicatorChartTypes = 'numericSimple' | 'numericBar' | 'gauge' | 'ticker';
+export type BaseMeasure = {
+    size: keyof FontSizes;
+    value: number;
+    maxWidth?: number;
+    maxHeight?: number;
+};
+export type FitTitleMeasure = {
+    width: number;
+    string: string;
+    key: string;
+};
+export type FitValueMeasure = {
+    width: number;
+    string: string;
+    key: string;
+};
+export type FitSecondaryMeasure = {
+    width: number;
+    titleString: string;
+    valueString: string;
+    key: string;
+};
+type FontSizes = {
+    big: number;
+    medium: number;
+    small: number;
+    micro: number;
+};
+type DataKey = 'title' | 'value' | 'secondaryTitle' | 'secondary';
+type CommonOptions = {
+    fontFamily: string;
+    title: {
+        color: string;
+        fontSizes: FontSizes;
+    };
+    value: {
+        color?: string;
+        fontSizes: FontSizes;
+    };
+    secondaryTitle: {
+        color: string;
+        fontSizes: FontSizes;
+    };
+    secondaryValue: {
+        fontWeight: number;
+        color: string;
+        fontSizes: FontSizes;
+    };
+    textKeys: string[];
+    backgroundColor: string;
+};
+export type NumericSimpleOptions = CommonOptions & {
+    borderColor: string;
+    borderWidth: number;
+    relativeSizes: {
+        key: string;
+        value: number;
+        decimals: number;
+    }[];
+    measureKeys: string[];
+    sizes: {
+        size: keyof FontSizes;
+        value: number;
+    }[];
+    fitMeasures: {
+        key: string;
+        prop: string;
+        dataKey: DataKey;
+    }[];
+};
+export type NumericBarOptions = CommonOptions & {
+    bracketColor: string;
+    bracketThickness: number;
+    relativeSizes: {
+        key: string;
+        value: number;
+        decimals: number;
+    }[];
+    measureKeys: string[];
+    sizes: {
+        size: keyof FontSizes;
+        value: number;
+        maxWidth?: number;
+        maxHeight?: number;
+    }[];
+};
+export type GaugeOptions = CommonOptions & {
+    label: {
+        color: string;
+        fontSizes: FontSizes;
+    };
+    textKeys: string[];
+    tickColor: string;
+    needleColor: string;
+    bracketColor: string;
+    defaultDialColor: string;
+    gaugeOpacity: number;
+    startAngle: number;
+    endAngle: number;
+    overDegrees: number;
+    tickDegreesIncrement: number;
+    bracketThickness: number;
+    relativeSizes: ({
+        key: string;
+        value: number;
+        decimals: number;
+    } | {
+        key: string;
+        dataKey: 'skin';
+        values: Record<'1' | '2', number>;
+        decimals: number;
+    })[];
+    gaugeHeights: BaseMeasure[];
+    measureKeys: string[];
+};
+export type LegacyIndicatorChartOptions = NumericBarOptions | NumericSimpleOptions | GaugeOptions;
+export {};

package/dist/charts/table/data-table-wrapper.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { DataTableWrapperProps } from './types';
+export declare const DataTableWrapper: ({ dataTable, dataOptions, isLoading, height, width, customStyles, themeSettings, onSortUpdate, }: DataTableWrapperProps) => JSX.Element;

package/dist/charts/table/header/field-type-icon.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+type Props = {
+    columnType: string;
+};
+export declare const FieldTypeIcon: ({ columnType }: Props) => JSX.Element;
+export {};

package/dist/charts/table/header/sortable-table-column-header.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { Column } from '../../../chart-data-processor/table-processor';
+export declare const SortableTableColumnHeader: React.FunctionComponent<{
+    column: Column;
+    onClick: (column: Column) => void;
+    isSelected: boolean;
+    children: React.ReactNode;
+    showFieldTypeIcon?: boolean;
+    sortIcon?: 'caret' | 'standard';
+}>;

package/dist/charts/table/helpers/calc-column-widths.d.ts

@@ -0,0 +1,2 @@
+import { DataTable } from '../../../chart-data-processor/table-processor';
+export declare const calcColumnWidths: (dataTable: DataTable, isLoading: boolean, fontFamily?: string) => number[];

package/dist/charts/table/helpers/format-numbers.d.ts

@@ -0,0 +1,3 @@
+import { DataTable } from '../../../chart-data-processor/table-processor';
+import { TableDataOptionsInternal } from '../../../chart-data-options/types';
+export declare const formatNumbers: (table: DataTable, chartDataOptions: TableDataOptionsInternal) => DataTable;

package/dist/charts/table/helpers/get-cell-styles.d.ts

@@ -0,0 +1,13 @@
+import { CompleteThemeSettings } from '../../../types';
+import { TableCustomStyles } from '../types';
+export declare const getCellStyles: ({ colIndex, rowIndex, themeSettings, customStyles, isHeaderCell, }: {
+    colIndex?: number | undefined;
+    rowIndex?: number | undefined;
+    themeSettings: CompleteThemeSettings;
+    customStyles?: TableCustomStyles | undefined;
+    isHeaderCell?: boolean | undefined;
+}) => {
+    color: string;
+    backgroundColor: string;
+    fontFamily: string;
+};

package/dist/charts/table/index.d.ts

@@ -0,0 +1,3 @@
+export * from './pure-table';
+export type { TableProps } from './types';
+export type { TableDesignOptions } from '../../chart-options-processor/translations/design-options';

package/dist/charts/table/pure-table.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { TableProps } from './types';
+/**
+ * PureTable Component. Table without any data fetch or aggregation logic.
+ *
+ * @returns Pure Table component
+ */
+export declare const PureTable: ({ dataTable, dataOptions, designOptions, onSortUpdate, themeSettings, width, height, }: TableProps) => JSX.Element;

package/dist/charts/table/styles/style-constants.d.ts

@@ -0,0 +1,9 @@
+export declare const HEADER_HEIGHT = 26;
+export declare const ROW_HEIGHT = 26;
+export declare const HEADER_PADDING = 60;
+export declare const DATA_PADDING = 24;
+export declare const EXTRA_PIXELS = 8;
+export declare const MAX_WIDTH = 350;
+export declare const MIN_WIDTH = 126;
+export declare const HEADER_ELLIPSIZED_LENGTH = 38;
+export declare const DATA_ELLIPSIZED_LENGTH = 55;

package/dist/charts/table/types.d.ts

@@ -0,0 +1,83 @@
+import { Column, DataTable } from '../../chart-data-processor/table-processor';
+import { TableDesignOptions } from '../../chart-options-processor/translations/design-options';
+import { CompleteThemeSettings } from '../../types';
+import { TableDataOptionsInternal } from '../../chart-data-options/types';
+/**
+ * Properties needed to setup Table
+ *
+ * @internal
+ */
+export type TableProps = {
+    /**
+     * Explicit Data, which is made up of an array of columns and a two-dimensional array of data cells.
+     *
+     */
+    dataTable: DataTable;
+    /**
+     * Configurations for how to interpret and present the data passed to the chart
+     *
+     * @category Chart
+     */
+    dataOptions: TableDataOptionsInternal;
+    /**
+     * Configuration that define functional style of the various chart elements
+     *
+     */
+    designOptions?: TableDesignOptions;
+    themeSettings: CompleteThemeSettings;
+    /**
+     * Callback that calls when sort of column triggered
+     *
+     */
+    onSortUpdate: (column: Column) => void;
+    /**
+     * Define width of table
+     *
+     */
+    width?: number;
+    /**
+     * Define height of table
+     *
+     */
+    height?: number;
+};
+export type DataTableWrapperProps = {
+    dataTable: DataTable;
+    dataOptions: TableDataOptionsInternal;
+    isLoading: boolean;
+    height: number;
+    width: number;
+    customStyles?: TableCustomStyles;
+    themeSettings: CompleteThemeSettings;
+    onSortUpdate: (column: Column) => void;
+};
+export type TableCustomStyles = {
+    showFieldTypeIcon?: boolean;
+    sortIcon?: 'caret' | 'standard';
+    headerHeight?: number;
+    rowHeight?: number;
+    headersColor?: boolean;
+    alternatingRowsColor?: boolean;
+    alternatingColumnsColor?: boolean;
+};
+export type TableReducerState = {
+    sortedDataTable: DataTable;
+    sortedColumn: Column | undefined;
+    sortColumns: Column[];
+};
+export type TableReducerBaseAction = {
+    type: 'sortBy';
+    column: Column;
+};
+export type TableReducerResetAction = {
+    type: 'reset';
+    dataTable: DataTable;
+    defaultSortColumn?: Column;
+};
+export type TableReducerAction = TableReducerBaseAction | TableReducerResetAction;
+export type TableReducerStateWithItems = TableReducerState & {
+    items: readonly any[];
+};
+export type TableReducerActionWithItems = TableReducerBaseAction | (TableReducerResetAction & {
+    items: readonly any[];
+});

package/dist/column-chart.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="react" />
+import { ColumnChartProps } from './props';
+/**
+ * A React component representing categorical data with vertical rectangular bars
+ * whose heights are proportional to the values that they represent.
+ * See [Column Chart](https://docs.sisense.com/main/SisenseLinux/column-chart.htm) for more information.
+ *
+ * @example
+ * An example of using the component to visualize the `Sample ECommerce` data source:
+ * ```tsx
+ * <ColumnChart
+ *   dataSet={DM.DataSource}
+ *   dataOptions={{
+ *     category: [DM.Commerce.AgeRange],
+ *     value: [measures.sum(DM.Commerce.Revenue)],
+ *     breakBy: [DM.Commerce.Gender],
+ *   }}
+ *   filters={[filters.greaterThan(DM.Commerce.Revenue, 1000)]}
+ *   onDataPointClick={(point, nativeEvent) => {
+ *     console.log('clicked', point, nativeEvent);
+ *   }}
+ * />
+ * ```
+ *
+ * <img src="media://column-chart-example-1.png" width="800"/>
+ * @param props - Column chart properties
+ * @returns Column Chart component
+ */
+export declare const ColumnChart: import("react").FunctionComponent<ColumnChartProps>;

package/dist/dashboard-widget/dashboard-widget.d.ts

@@ -0,0 +1,16 @@
+import { type FunctionComponent } from 'react';
+import { DashboardWidgetProps } from '../props';
+/**
+ * The Dashboard Widget component, which is a thin wrapper on the {@link ChartWidget} component,
+ * used to render a widget created in the Sisense instance.
+ *
+ * @example
+ * The example below renders a dashboard widget with the specified widget and dashboard OIDs.
+ * ```tsx
+ * <DashboardWidget
+ *   widgetOid={'64473e07dac1920034bce77f'}
+ *   dashboardOid={'6441e728dac1920034bce737'}
+ * />
+ * ```
+ */
+export declare const DashboardWidget: FunctionComponent<DashboardWidgetProps>;

package/dist/dashboard-widget/fetch-widget.d.ts

@@ -0,0 +1,11 @@
+import { ClientApplication } from '../app/client-application';
+import { WidgetDto } from './types';
+/**
+ * Fetch a dashboard widget from the default Sisense instance using POC
+ * authentication code.
+ *
+ * @param widgetOid - Widget identifier in Sisense instance
+ * @param dashboardOid - Dashboard identifier in Sisense instance
+ * @param app - Client application
+ */
+export declare function fetchWidget(widgetOid: string, dashboardOid: string, app: ClientApplication): Promise<WidgetDto>;

package/dist/dashboard-widget/translate-panel-color-format.d.ts

@@ -0,0 +1,5 @@
+import { DataColorOptions } from '../chart-data/series-data-color-service';
+import { CompleteThemeSettings, ValueToColorMap } from '../types';
+import { PanelColorFormat, PanelMembersFormat } from './types';
+export declare const createValueColorOptions: (format?: PanelColorFormat, themeSettings?: CompleteThemeSettings) => DataColorOptions | undefined;
+export declare const createValueToColorMap: (membersFormat: PanelMembersFormat) => ValueToColorMap;

package/dist/dashboard-widget/translate-widget-data-options.d.ts

@@ -0,0 +1,7 @@
+import { DimensionalBaseMeasure, DimensionalAttribute, DimensionalCalculatedMeasure } from '@sisense/sdk-data';
+import { CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorDataOptions, StyledMeasureColumn, StyledColumn, CompleteThemeSettings } from '../types';
+import { Panel, PanelItem, Jaql, WidgetType } from './types';
+import { TableDataOptions } from '../chart-data-options/types';
+export declare function createDimensionalElementFromJaql(jaql: Jaql, format?: PanelItem['format']): import("@sisense/sdk-data").Filter | DimensionalCalculatedMeasure | DimensionalBaseMeasure | DimensionalAttribute;
+export declare function createDataColumn(item: PanelItem, themeSettings?: CompleteThemeSettings): StyledMeasureColumn | StyledColumn;
+export declare function extractDataOptions(widgetType: WidgetType, panels: Panel[], themeSettings?: CompleteThemeSettings): CategoricalChartDataOptions | ScatterChartDataOptions | IndicatorDataOptions | TableDataOptions;

package/dist/dashboard-widget/translate-widget-drilldown-options.d.ts

@@ -0,0 +1,3 @@
+import { Panel, WidgetType } from './types';
+import { DrilldownOptions } from '../types';
+export declare const extractDrilldownOptions: (widgetType: WidgetType, panels: Panel[]) => DrilldownOptions;

package/dist/dashboard-widget/translate-widget-filters.d.ts

@@ -0,0 +1,16 @@
+import { Filter } from '@sisense/sdk-data';
+import { FilterJaql, Panel } from './types';
+/**
+ * Creates a Filter from a FilterJaql object.
+ *
+ * @param jaql - The filter JAQL object.
+ * @returns - The created Filter object.
+ */
+export declare function createFilterFromJaql(jaql: FilterJaql): Filter;
+/**
+ * Extracts filters from the widget panel.
+ *
+ * @param {Panel[]} panels - The array of panels.
+ * @returns {Filter[]} - The extracted filters.
+ */
+export declare function extractFilters(panels: Panel[]): Filter[];

package/dist/dashboard-widget/translate-widget-style-options.d.ts

@@ -0,0 +1,5 @@
+import { StyleOptions, TableStyleOptions, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, GaugeIndicatorStyleOptions } from '../types';
+import { Panel, WidgetStyle, WidgetSubtype, WidgetType, TableWidgetStyle, IndicatorWidgetStyle } from './types';
+export declare function extractTableChartStyleOptions(widgetStyle: TableWidgetStyle): TableStyleOptions;
+export declare const getIndicatorTypeSpecificOptions: (widgetSubtype: WidgetSubtype, widgetStyle: IndicatorWidgetStyle) => NumericSimpleIndicatorStyleOptions | NumericBarIndicatorStyleOptions | GaugeIndicatorStyleOptions;
+export declare function extractStyleOptions(widgetType: WidgetType, widgetSubtype: WidgetSubtype, style: WidgetStyle, panels: Panel[]): StyleOptions | TableStyleOptions;

package/dist/dashboard-widget/translate-widget.d.ts

@@ -0,0 +1,12 @@
+import { CompleteThemeSettings } from '../types';
+import { WidgetDto } from './types';
+import { ChartWidgetProps, TableWidgetProps } from '../props';
+export type TableWidgetExtractedProps = {
+    type: 'table';
+    props: TableWidgetProps;
+};
+export type ChartWidgetExtractedProps = {
+    type: 'chart';
+    props: ChartWidgetProps;
+};
+export declare function extractWidgetProps(widget: WidgetDto, themeSettings?: CompleteThemeSettings): TableWidgetExtractedProps | ChartWidgetExtractedProps;