@sisense/sdk-ui 0.13.0 → 0.14.0

package/dist/api/types/dashboard-dto.d.ts

@@ -1,13 +1,20 @@
 import { WidgetDto, Datasource, FilterJaql } from '../../dashboard-widget/types';
-type Filter = {
+export type Filter = {
+    isCascading?: false;
     jaql: FilterJaql;
-    isCascading: boolean;
+    instanceid?: string;
+    disabled?: boolean;
+};
+export type CascadingFilter = {
+    isCascading: true;
+    levels: FilterJaql[];
+    instanceid?: string;
+    disabled?: boolean;
 };
 export type DashboardDto = {
     oid: string;
     title: string;
     datasource: Datasource;
     widgets?: WidgetDto[];
-    filters?: Filter[];
+    filters?: Array<Filter | CascadingFilter>;
 };
-export {};

package/dist/chart-data-options/types.d.ts

@@ -1,5 +1,5 @@
 import type { DataColorOptions } from '../chart-data/series-data-color-service';
-import type { NumberFormatConfig, SeriesChartType, SortDirection, ValueToColorMap } from '../types';
+import type { NumberFormatConfig, SeriesChartType, SortDirection, ValueToColorMap, MultiColumnValueToColorMap } from '../types';
 import { Column, MeasureColumn, CalculatedMeasureColumn } from '@sisense/sdk-data';
 /**
  * Styles for a category/column when visualized in a chart
@@ -13,6 +13,9 @@ export interface CategoryStyle {
      * Date format.
      *
      * See [ECMAScript Date Time String Format](https://tc39.es/ecma262/multipage/numbers-and-dates.html#sec-date-time-string-format)
+     *
+     * Note that 'YYYY' and 'DD' have been disabled since they often get confused with 'yyyy' and 'dd'
+     * and can produce unexpected results.
      */
     dateFormat?: string;
     /** Boolean flag to toggle continuous timeline on this date column. */
@@ -100,6 +103,8 @@ export type ValueStyle = {
     enabled?: boolean;
     /** Boolean flag whether null values are treated as zeros in the chart */
     treatNullDataAsZeros?: boolean;
+    /** Boolean flag whether to connect a graph line across null points or render a gap */
+    connectNulls?: boolean;
 };
 /**
  * Wrapped {@link @sisense/sdk-data!MeasureColumn | Measure Column} with styles
@@ -198,8 +203,9 @@ export interface CategoricalChartDataOptions {
     category: (Column | StyledColumn)[];
     /**
      * Optional mapping of each of the series to colors.
+     * ({@link MultiColumnValueToColorMap} used only for {@link SunburstChart})
      */
-    seriesToColorMap?: ValueToColorMap;
+    seriesToColorMap?: ValueToColorMap | MultiColumnValueToColorMap;
 }
 /**
  * Configuration for how to query aggregate data and assign data
@@ -281,13 +287,13 @@ export declare function isMeasureColumn(arg: AnyColumn): arg is MeasureColumn |
  * Configuration for how to query data and assign data to {@link Table}.
  *
  */
-export type TableDataOptions = {
+export interface TableDataOptions {
     /**
      * Columns (or attributes) whose values represent data columns in table
      *
      */
     columns: (Column | StyledColumn | MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn)[];
-};
+}
 /**
  * Configuration for querying aggregate data and assigning data to chart encodings.
  *
@@ -323,7 +329,7 @@ export interface CartesianChartDataOptionsInternal {
 export interface CategoricalChartDataOptionsInternal {
     y: Value[];
     breakBy: Category[];
-    seriesToColorMap?: ValueToColorMap;
+    seriesToColorMap?: ValueToColorMap | MultiColumnValueToColorMap;
 }
 /** @internal */
 export interface ScatterChartDataOptionsInternal {

package/dist/chart-options-processor/translations/axis-section.d.ts

@@ -99,6 +99,7 @@ export type AxisPlotBand = {
     };
 };
 export declare const getCategoricalCompareValue: (value: CategoricalXValues) => number;
+export declare const getDateFormatter: (category: Category, dateFormatter?: ((date: Date, format: string) => string) | undefined) => (time: number) => string;
 export declare const getXAxisDatetimeSettings: (axis: Axis, category: Category, values: number[], dateFormatter?: ((date: Date, format: string) => string) | undefined) => AxisSettings[];
 export declare const getXAxisSettings: (axis: Axis, axis2: Axis | undefined, categories: string[], plotBands: PlotBand[], xAxisOrientation: AxisOrientation, chartDataOptions: ChartDataOptionsInternal, chartType: ChartType) => AxisSettings[];
 export declare const getYAxisSettings: (axis: Axis, axis2: Axis | undefined, axisMinMax: AxisMinMax, axis2MinMax: AxisMinMax, showTotal: boolean, chartDataOptions: ChartDataOptionsInternal) => AxisSettings[];

package/dist/chart-options-processor/translations/scatter-series.d.ts

@@ -18,6 +18,7 @@ export interface AxisComputedProperties {
     maskedBreakByColor?: string;
     maskedSize?: string;
     color?: string;
+    selected?: boolean;
 }
 export declare const handleNumberValue: (cell: ComparableData) => number | null;
 export declare const buildScatterSeries: (data: ScatterDataTable, categoriesMap: ScatterAxisCategoriesMap, dataOptions?: ScatterChartDataOptionsInternal, themeSettings?: CompleteThemeSettings, seriesCapacity?: number) => SeriesWithAlerts<SeriesType[]>;

package/dist/chart-options-processor/translations/sunburst/sunburst-series.d.ts

@@ -10,7 +10,7 @@ export declare function prepareSunburstDataItems(chartData: CategoricalChartData
         levelsCount: number;
     };
 } | {
-    color: string;
+    color: any;
     name?: string | undefined;
     y?: number | null | undefined;
     x?: number | null | undefined;
@@ -22,6 +22,7 @@ export declare function prepareSunburstDataItems(chartData: CategoricalChartData
         lineWidth?: number | undefined;
     } | undefined;
     selected?: boolean | undefined;
+    sliced?: boolean | undefined;
     custom?: {
         [k: string]: unknown;
         number1?: number | undefined;

package/dist/chart-options-processor/translations/translations-to-highcharts.d.ts

@@ -26,6 +26,7 @@ export type SeriesPointStructure = {
         lineWidth?: number;
     };
     selected?: boolean;
+    sliced?: boolean;
     custom?: {
         number1?: number;
         string1?: string;
@@ -61,7 +62,7 @@ export declare const addStackingIfSpecified: (chartType: ChartType, designOption
  * @param index -
  */
 export declare const indexMapWhenOnlyY: (categories: string[], index: number) => (0 | -1)[];
-export declare const formatSeriesContinuousXAxis: (series: CategoricalSeriesValues, indexMap: number[], treatNullDataAsZeros: boolean, interval: number, maxCategories: number) => HighchartsSeriesValues;
+export declare const formatSeriesContinuousXAxis: (series: CategoricalSeriesValues, indexMap: number[], treatNullDataAsZeros: boolean, interval: number, maxCategories: number, dateFormatter: (time: number) => string) => HighchartsSeriesValues;
 export declare const formatSeries: (series: CategoricalSeriesValues, indexMap: number[], treatNullDataAsZeros: boolean, categories?: string[], categoryColors?: string[]) => HighchartsSeriesValues;
 export declare const adjustMinWhenColumnBar: (chartType: ChartType, autoMinMax: AxisMinMax) => {
     min: number;
@@ -71,5 +72,5 @@ export declare const autoCalculateYAxisMinMax: (chartType: ChartType, chartData:
     min: number;
     max: number;
 };
-export declare const determineYAxisOptions: (chartData: ChartData, dataOptions: ChartDataOptionsInternal) => [number[], (HighchartsType | undefined)[], boolean[]];
+export declare const determineYAxisOptions: (chartData: ChartData, dataOptions: ChartDataOptionsInternal) => [number[], (HighchartsType | undefined)[], boolean[], boolean[]];
 export declare const getColorSetting: (dataOptions: CartesianChartDataOptionsInternal | CategoricalChartDataOptionsInternal, key: string) => string | undefined;

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

@@ -0,0 +1,13 @@
+import { DashboardDto } from '../api/types/dashboard-dto';
+import { WidgetDto } from './types';
+/**
+ * Extracts dashboard filters applicable to a widget.
+ *
+ * @param {DashboardDto} dashboard - The dashboard containing the filters.
+ * @param {WidgetDto} widget - The widget to extract filters from.
+ * @returns {Object} An object containing an array of filters and an array of highlights.
+ */
+export declare function extractDashboardFiltersForWidget(dashboard: DashboardDto, widget: WidgetDto): {
+    filters: import("packages/sdk-data/dist").Filter[];
+    highlights: import("packages/sdk-data/dist").Filter[];
+};

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

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

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

@@ -1,5 +1,36 @@
 import { Filter } from '@sisense/sdk-data';
 import { FilterJaql, Panel } from './types';
+/**
+ * Extracts filter model components from a FilterJaql object.
+ *
+ * @param {FilterJaql} jaql - The FilterJaql object.
+ * @returns {object} - An object containing the extracted filter model components, including filter, backgroundFilter, and turnOffMembersFilter.
+ */
+export declare function extractFilterModelFromJaql(jaql: FilterJaql): {
+    filter: {
+        all: true;
+    } | {
+        members: string[];
+    } | {
+        exclude: {
+            members: string[];
+        };
+    };
+    backgroundFilter: import("./types").BackgroundFilter | ({
+        exclude: {
+            members: string[];
+        };
+    } & {
+        turnedOff: boolean;
+    }) | undefined;
+    turnOffMembersFilter: ({
+        exclude: {
+            members: string[];
+        };
+    } & {
+        turnedOff: boolean;
+    }) | undefined;
+};
 /**
  * Creates a Filter from a FilterJaql object.
  *

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

@@ -14,6 +14,10 @@ export declare const enum WidgetType {
     TableWithAggregation = "tablewidgetagg"
 }
 export type WidgetSubtype = 'area/basic' | 'area/stacked' | 'area/stacked100' | 'area/spline' | 'area/stackedspline' | 'area/stackedspline100' | 'bar/classic' | 'bar/stacked' | 'bar/stacked100' | 'column/classic' | 'column/stackedcolumn' | 'column/stackedcolumn100' | 'line/basic' | 'line/spline' | 'pie/classic' | 'pie/donut' | 'pie/ring' | 'column/polar' | 'area/polar' | 'line/polar' | 'indicator/numeric' | 'indicator/gauge' | 'bubble/scatter' | 'treemap' | 'sunburst';
+export declare enum WidgetDashboardFilterMode {
+    FILTER = "filter",
+    SELECT = "select"
+}
 export type Datasource = {
     title: string;
     id: string;
@@ -32,12 +36,21 @@ export interface WidgetDto {
     subtype: WidgetSubtype | string;
     datasource: Datasource;
     metadata: {
+        ignore?: FiltersIgnoringRules;
         panels: Panel[];
     };
     style: WidgetStyle;
     title: string;
     desc: string;
+    options?: {
+        dashboardFiltersMode: `${WidgetDashboardFilterMode}`;
+    };
 }
+export type FiltersIgnoringRules = {
+    dimensions?: string[];
+    ids: string[];
+    all: boolean;
+};
 export declare const enum DataType {
     TEXT = "text",
     NUMERIC = "numeric",
@@ -70,7 +83,7 @@ export type FormulaJaql = {
     formula: string;
     context?: Record<FormulaID, FormulaContext>;
 };
-type IncludeAllFilter = {
+export type IncludeAllFilter = {
     all: true;
 };
 export type IncludeMembersFilter = {
@@ -83,7 +96,9 @@ type ExcludeMembersFilter = {
 };
 export type MembersFilter = IncludeMembersFilter | ExcludeMembersFilter;
 type BaseFilter = IncludeAllFilter | MembersFilter;
-type BackgroundFilter = BaseFilter;
+export type BackgroundFilter = BaseFilter & {
+    level?: 'string';
+};
 type TurnOffMembersFilter = ExcludeMembersFilter & {
     turnedOff: boolean;
 };

package/dist/dashboard-widget/use-fetch-widget-dto-model.d.ts

@@ -0,0 +1,48 @@
+import { RestApi } from '../api/rest-api';
+import { DashboardDto } from '../api/types/dashboard-dto';
+import { WidgetDto } from './types';
+/**
+ * Fetches a Widget DTO model and, optionally, a Dashboard DTO model.
+ *
+ * @internal
+ *
+ * @param {Object} options - The options for fetching the DTO models.
+ * @param {string} options.widgetOid - The OID of the widget to fetch.
+ * @param {string} options.dashboardOid - The OID of the dashboard to which the widget belongs.
+ * @param {boolean} [options.includeDashboard] - (Optional) Whether to include the associated dashboard.
+ * @param {RestApi} options.api - The RestApi instance to use for fetching.
+ * @returns {Promise<{widget: WidgetDto, dashboard?: DashboardDto}>} A promise that resolves to an object containing the Widget DTO and optionally the Dashboard DTO.
+ */
+export declare const fetchWidgetDtoModel: ({ widgetOid, dashboardOid, includeDashboard, api, }: {
+    widgetOid: string;
+    dashboardOid: string;
+    includeDashboard?: boolean | undefined;
+    api: RestApi;
+}) => Promise<{
+    widget: WidgetDto;
+    dashboard: DashboardDto | undefined;
+}>;
+/**
+ * Custom hook for fetching Widget DTO and Dashboard DTO models.
+ *
+ * @internal
+ *
+ * @param {Object} options - The options for fetching the DTO models.
+ * @param {string} options.widgetOid - The OID of the widget to fetch.
+ * @param {string} options.dashboardOid - The OID of the dashboard to which the widget belongs.
+ * @param {boolean} [options.includeDashboard] - (Optional) Whether to include the associated dashboard.
+ * @returns {{
+ *   widget: WidgetDto,
+ *   dashboard?: DashboardDto,
+ *   error: Error
+ * }} An object containing the Widget DTO, optionally the Dashboard DTO, and an error if fetching fails.
+ */
+export declare const useFetchWidgetDtoModel: ({ widgetOid, dashboardOid, includeDashboard, }: {
+    widgetOid: string;
+    dashboardOid: string;
+    includeDashboard?: boolean | undefined;
+}) => {
+    error: Error | undefined;
+    widget?: WidgetDto | undefined;
+    dashboard?: DashboardDto | undefined;
+};

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

@@ -12,7 +12,7 @@ export declare function getRootPanelItem(item: PanelItem): PanelItem;
 export declare function getSortType(jaqlSort: JaqlSortDirection | undefined): SortDirection;
 /**
  * Merges two arrays of filter objects, prioritizing 'targetFilters' over 'sourceFilters',
- * and removes duplicates based on filter attribute expression (dim)
+ * and removes duplicates based on filter compare id
  *
  * @param {Filter[]} [sourceFilters=[]] - The source array of filter objects.
  * @param {Filter[]} [targetFilters=[]] - The target array of filter objects.

package/dist/decorators/{with-tracking → component-decorators/with-tracking}/error-tracker.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
 import { Component, ReactNode } from 'react';
-import { SisenseContextPayload } from '../../sisense-context/sisense-context';
+import { SisenseContextPayload } from '../../../sisense-context/sisense-context';
 type ErrorTrackerProps = {
     children: ReactNode;
     componentName: string;

package/dist/decorators/hook-decorators/index.d.ts

@@ -0,0 +1 @@
+export * from './with-tracking';

package/dist/decorators/hook-decorators/with-tracking.d.ts

@@ -0,0 +1,2 @@
+export type HookDecorator<DecoratorConfig> = (decoratorConfig: DecoratorConfig) => <HookArgs extends any[], HookResult>(hook: (...args: HookArgs) => HookResult) => (...args: HookArgs) => HookResult;
+export declare const withTracking: HookDecorator<string>;

package/dist/filters/components/common/basic-input.d.ts

@@ -0,0 +1,8 @@
+import { type FunctionComponent, type InputHTMLAttributes } from 'react';
+type BasicInputProps = {
+    variant?: 'white' | 'grey';
+    label: string;
+    callback: (value: string) => void;
+} & InputHTMLAttributes<HTMLInputElement>;
+export declare const BasicInput: FunctionComponent<BasicInputProps>;
+export {};

package/dist/filters/components/common/index.d.ts

@@ -1,5 +1,6 @@
 export { LinkButton, PrimaryButton, SecondaryButton } from './buttons';
 export { Checkbox } from './checkbox';
+export { BasicInput } from './basic-input';
 export { Input } from './input';
 export { Radio } from './radio';
 export { SisenseSwitchButton } from './switch';

package/dist/filters/components/date-filter/date-range-filter-tile/date-range-filter-tile.d.ts

@@ -12,7 +12,7 @@ export interface DateRangeFilterTileProps {
     /**
      * Data source the query is run against - e.g. `Sample ECommerce`
      *
-     * If not specified, the query will use the `defaultDataSource` specified in the parent {@link SisenseContextProvider} component.
+     * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
      */
     dataSource?: DataSource;
     /**

package/dist/filters/components/filter-tile.d.ts

@@ -2,8 +2,8 @@ import type { FunctionComponent, ReactNode } from 'react';
 interface Props {
     title: string;
     renderContent: (collapsed: boolean, tileDisabled: boolean) => ReactNode;
-    disabled: boolean;
-    onToggleDisabled: () => void;
+    disabled?: boolean;
+    onToggleDisabled?: () => void;
 }
 /**
  * Generic component that owns common functionality of a filter "tile" like

package/dist/filters/components/member-filter-tile/member-filter-tile.d.ts

@@ -9,7 +9,7 @@ export interface MemberFilterTileProps {
     /**
      * Data source the query is run against - e.g. `Sample ECommerce`
      *
-     * If not specified, the query will use the `defaultDataSource` specified in the parent {@link SisenseContextProvider} component.
+     * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
      */
     dataSource?: DataSource;
     /** Attribute to filter on. A query will be run to fetch all this attribute's members */

package/dist/funnel-chart.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { FunnelChartProps } from './props';
 /**
- * A React component representing data progressively decreasing in size or quantity through a conical shape.
+ * A React component representing data progressively decreasing in size or quantity through a funnel shape.
  * See [Funnel Chart](https://docs.sisense.com/main/SisenseLinux/funnel-chart.htm) for more information.
  *
  * @example

package/dist/highcharts-memorized.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import { HighchartsOptionsInternal } from './chart-options-processor/chart-options-service';
+export declare const HighchartsReactMemoized: import("react").MemoExoticComponent<({ options, immutable, }: {
+    options: HighchartsOptionsInternal;
+    immutable: boolean | null | undefined;
+}) => JSX.Element>;