@sisense/sdk-ui 1.12.0 → 1.14.0

package/dist/api/rest-api.d.ts

@@ -12,31 +12,31 @@ type GetDashboardOptions = {
 };
 export declare class RestApi {
     private httpClient;
-    constructor(httpClient: HttpClient);
+    constructor(httpClient: HttpClient | undefined);
     /**
      * Get all dashboards
      */
-    getDashboards: (options?: GetDashboardsOptions) => Promise<DashboardDto[]>;
+    getDashboards: (options?: GetDashboardsOptions) => Promise<DashboardDto[] | undefined>;
     /**
      * Get a specific dashboard
      */
-    getDashboard: (dashboardOid: string, options?: GetDashboardOptions) => Promise<DashboardDto>;
+    getDashboard: (dashboardOid: string, options?: GetDashboardOptions) => Promise<DashboardDto | undefined>;
     /**
      * Get all widgets of a specific dashboard
      */
-    getDashboardWidgets: (dashboardOid: string) => Promise<WidgetDto[]>;
+    getDashboardWidgets: (dashboardOid: string) => Promise<WidgetDto[] | undefined>;
     /**
      * Get a specific widget from a dashboard
      */
-    getWidget: (widgetOid: string, dashboardOid: string) => Promise<WidgetDto>;
+    getWidget: (widgetOid: string, dashboardOid: string) => Promise<WidgetDto | undefined>;
     /**
      * Get a GeoJSON data for all countries
      */
-    getCountriesGeoJson: () => Promise<GeoJsonFeatureCollection>;
+    getCountriesGeoJson: () => Promise<GeoJsonFeatureCollection<import("geojson").Geometry, import("geojson").GeoJsonProperties> | undefined>;
     /**
      * Get a GeoJSON data for all USA states
      */
-    getUsaStatesGeoJson: () => Promise<GeoJsonFeatureCollection>;
+    getUsaStatesGeoJson: () => Promise<GeoJsonFeatureCollection<import("geojson").Geometry, import("geojson").GeoJsonProperties> | undefined>;
 }
 export declare const useGetApi: () => RestApi;
 export {};

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

@@ -21,12 +21,14 @@ export type FilterDto = {
     jaql: FilterJaql & AnyObject;
     instanceid?: string;
     disabled?: boolean;
+    locked?: boolean;
 };
 export type CascadingFilterDto = {
     isCascading: true;
     levels: FilterJaql[];
     instanceid?: string;
     disabled?: boolean;
+    locked?: boolean;
 };
 export declare const isCascadingFilterDto: (filter: FilterDto | CascadingFilterDto) => filter is CascadingFilterDto;
 export type DashboardDto = {

package/dist/chart/helpers/use-synced-data.d.ts

@@ -4,5 +4,5 @@ import { ChartDataOptionsInternal } from '../../chart-data-options/types';
 import { ChartType } from '../../types';
 import { DataColumnNamesMapping } from '../../chart-data-options/validate-data-options';
 type DataSet = DataSource | Data | undefined;
-export declare const useSyncedData: (dataSet: DataSet, chartDataOptions: ChartDataOptionsInternal, chartType: ChartType, attributes: Attribute[], measures: Measure[], dataColumnNamesMapping: DataColumnNamesMapping, filters?: Filter[] | FilterRelations, highlights?: Filter[], refreshCounter?: number, setIsLoading?: Dispatch<SetStateAction<boolean>>) => Data | undefined;
+export declare const useSyncedData: (dataSet: DataSet, chartDataOptions: ChartDataOptionsInternal, chartType: ChartType, attributes: Attribute[], measures: Measure[], dataColumnNamesMapping: DataColumnNamesMapping, filters?: Filter[] | FilterRelations, highlights?: Filter[], refreshCounter?: number, setIsLoading?: Dispatch<SetStateAction<boolean>>) => [Data, ChartDataOptionsInternal];
 export {};

package/dist/chart-options-processor/chart-options-service.d.ts

@@ -112,6 +112,7 @@ export type PlotOptions = {
     sunburst?: ChartPlotOptions;
     boxplot?: ChartPlotOptions;
     scatter?: ChartPlotOptions;
+    arearange?: ChartPlotOptions;
 };
 /**
  * Highcharts options internal
@@ -154,6 +155,9 @@ export type HighchartsOptionsInternal = {
     plotOptions?: PlotOptions;
     navigator?: Navigator | {
         enabled: boolean;
+        series?: {
+            type: ChartType;
+        };
     };
     tooltip?: TooltipSettings;
     boost?: {

package/dist/chart-options-processor/subtype-to-design-options.d.ts

@@ -29,6 +29,18 @@ export type LineSubtype = 'line/spline' | 'line/basic';
  *
  */
 export type AreaSubtype = 'area/basic' | 'area/stacked' | 'area/stacked100' | 'area/spline' | 'area/stackedspline' | 'area/stackedspline100';
+/**
+ * Property of {@link AreaRangeStyleOptions}
+ *
+ * Subtype of AreaRangeChart
+ *
+ * **Values**
+ *
+ * - `arearange/spline` - curved line from point to point.
+ * - `arearange/basic` - straight line from point to point.
+ *
+ */
+export type AreaRangeSubtype = 'arearange/spline' | 'arearange/basic';
 /**
  * Property of {@link StackableSubtype}
  *
@@ -92,7 +104,7 @@ export type SunburstSubtype = 'sunburst';
 export type BoxplotSubtype = 'boxplot/full' | 'boxplot/hollow';
 export type ScattermapSubtype = 'scattermap';
 export type AreamapSubtype = 'areamap/world' | 'areamap/usa';
-export type ChartSubtype = LineSubtype | AreaSubtype | StackableSubtype | PieSubtype | PolarSubtype | IndicatorSubtype | TreemapSubtype | SunburstSubtype | BoxplotSubtype | ScattermapSubtype | AreamapSubtype;
+export type ChartSubtype = LineSubtype | AreaSubtype | StackableSubtype | PieSubtype | PolarSubtype | IndicatorSubtype | TreemapSubtype | SunburstSubtype | BoxplotSubtype | ScattermapSubtype | AreamapSubtype | AreaRangeSubtype;
 export declare const chartSubtypeToDesignOptions: Readonly<Record<ChartSubtype, {
     lineType?: LineType | undefined;
     stackType?: StackType | undefined;

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

@@ -101,6 +101,7 @@ export type AxisPlotBand = {
     };
 };
 export declare const getCategoricalCompareValue: (value: CategoricalXValues) => number;
+export declare const getDefaultDateFormat: (granularity?: string) => "HH:mm:ss" | "yyyy" | "yyyy Q" | "MM/yyyy" | "ww yyyy" | "M/d/yy" | "HH" | "M/d/yy HH" | "HH:mm" | undefined;
 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[];

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

@@ -35,4 +35,6 @@ export declare function prepareSunburstDataItems(chartData: CategoricalChartData
     id?: string | undefined;
     drilldown?: string | undefined;
     parent?: string | undefined;
+    low?: number | null | undefined;
+    high?: number | null | undefined;
 })[];

package/dist/chart-options-processor/translations/tooltip-utils.d.ts

@@ -43,6 +43,8 @@ export type InternalSeries = {
             xDisplayValue?: string;
             xValue?: (number | string)[];
         };
+        upperPointName?: string;
+        lowerPointName?: string;
     };
     percentage?: number;
 };

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

@@ -39,6 +39,8 @@ export type SeriesPointStructure = {
     id?: string;
     drilldown?: string;
     parent?: string;
+    low?: number | null;
+    high?: number | null;
 };
 export type AxisClipped = {
     minClipped: boolean;

package/dist/common/components/loading-overlay.d.ts

@@ -6,6 +6,7 @@ import { CompleteThemeSettings } from '../../types';
  *
  * @param isVisible - visibility of the overlay.
  * @returns Child component wrapped in dynamic overlay.
+ * @internal
  */
 export declare const LoadingOverlay: ({ isVisible, themeSettings, children, }: {
     isVisible: boolean;

package/dist/common-filters/common-filters-connector.d.ts

@@ -0,0 +1,9 @@
+import { type Filter } from '@sisense/sdk-data';
+import { ChartDataOptions, ChartWidgetProps, PivotTableDataOptions, RenderToolbarHandler } from '../index.js';
+import { CommonFiltersOptions } from './types.js';
+import { WidgetTypeInternal } from '../models/widget/types';
+type CommonFiltersToWidgetConnectProps = Pick<ChartWidgetProps, 'filters' | 'highlights' | 'onDataPointClick' | 'onDataPointsSelected'> & {
+    renderToolbar: RenderToolbarHandler;
+};
+export declare function prepareCommonFiltersToWidgetConnectProps(filters: Filter[], setFilters: (filters: Filter[]) => void, widgetType: WidgetTypeInternal, dataOptions: ChartDataOptions | PivotTableDataOptions, options: CommonFiltersOptions): CommonFiltersToWidgetConnectProps;
+export {};

package/dist/common-filters/selection-utils.d.ts

@@ -0,0 +1,11 @@
+import { Attribute, Filter } from '@sisense/sdk-data';
+import { AreamapDataPoint, ChartDataOptions, DataPoint, PivotTableDataOptions, ScatterDataPoint, ScattermapDataPoint } from '../index.js';
+import { WidgetTypeInternal } from '../models/widget/types.js';
+type WidgetSelection = {
+    attribute: Attribute;
+    values: (string | number)[];
+};
+export declare function getWidgetSelections(widgetType: WidgetTypeInternal, dataOptions: ChartDataOptions | PivotTableDataOptions, points: Array<DataPoint | ScatterDataPoint | ScattermapDataPoint | AreamapDataPoint>, nativeEvent: MouseEvent | PointerEvent): WidgetSelection[];
+export declare function getSelectableWidgetAttributes(widgetType: WidgetTypeInternal, dataOptions: ChartDataOptions | PivotTableDataOptions): Attribute[];
+export declare function createCommonFiltersOverSelections(selections: WidgetSelection[], filters: Filter[]): Filter[];
+export {};

package/dist/common-filters/types.d.ts

@@ -0,0 +1,18 @@
+import { DeepRequired } from 'ts-essentials';
+/** @internal */
+export declare enum CommonFiltersApplyMode {
+    HIGHLIGHT = "highlight",
+    FILTER = "filter"
+}
+/** @internal */
+export type CommonFiltersOptions = {
+    applyMode?: `${CommonFiltersApplyMode}`;
+    shouldAffectFilters?: boolean;
+    ignoreFilters?: {
+        all?: boolean;
+        ids?: string[];
+    };
+    forceApplyBackgroundFilters?: boolean;
+};
+/** @internal */
+export type CompleteCommonFiltersOptions = DeepRequired<CommonFiltersOptions>;

package/dist/common-filters/use-common-filters.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="react" />
+import { type Filter } from '@sisense/sdk-data';
+import { WidgetModel } from '../index.js';
+import { CommonFiltersOptions } from './types.js';
+/** @internal */
+export declare const useCommonFilters: ({ initialFilters, }?: {
+    initialFilters?: Filter[] | undefined;
+}) => {
+    filters: Filter[];
+    setFilters: import("react").Dispatch<import("react").SetStateAction<Filter[]>>;
+    addFilter: (newFilter: Filter) => void;
+    connectToWidgetModel: (widget: WidgetModel, options?: CommonFiltersOptions) => WidgetModel;
+};

package/dist/common-filters/utils.d.ts

@@ -0,0 +1,9 @@
+import { Filter, Attribute } from '@sisense/sdk-data';
+import { CommonFiltersOptions } from './types.js';
+export declare function getAllowedFilters(filters: Filter[], ignoreFiltersOptions?: CommonFiltersOptions['ignoreFilters']): Filter[];
+export declare function isSameAttribute(attributeA: Attribute, attributeB: Attribute): boolean;
+export declare function getFilterByAttribute(filters: Filter[], attribute: Attribute): Filter | undefined;
+export declare function createCommonFilter(attribute: Attribute, members: (string | number)[], existingCommonFilters: Filter[]): Filter;
+export declare function isEqualMembersFilters(filterA: Filter, filterB: Filter): boolean;
+export declare function isIncludeAllFilter(filter: Filter): boolean;
+export declare function clearCommonFilter(filter: Filter): Filter;

package/dist/common-filters/widget-header-clear-selection-button.d.ts

@@ -0,0 +1,3 @@
+export declare const WidgetHeaderClearSelectionButton: ({ onClick }: {
+    onClick: () => void;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/dashboard/components/dashboard-container.d.ts

@@ -1,2 +1,2 @@
 import { DashboardLayoutProps } from '../../dashboard/types';
-export declare const DashboardContainer: ({ title, layout, widgets, filters, onFiltersChange, }: DashboardLayoutProps) => import("react/jsx-runtime").JSX.Element;
+export declare const DashboardContainer: ({ title, layout, widgets, filters, onFiltersChange, defaultDataSource, }: DashboardLayoutProps) => import("react/jsx-runtime").JSX.Element;

package/dist/dashboard/dashboard.d.ts

@@ -5,4 +5,4 @@ import { DashboardProps } from '../dashboard/types';
  *
  * @internal
  */
-export declare const Dashboard: ({ title, layout, widgets, filters }: DashboardProps) => import("react/jsx-runtime").JSX.Element;
+export declare const Dashboard: ({ title, layout, widgets, filters, defaultDataSource, widgetFilterOptions, }: DashboardProps) => import("react/jsx-runtime").JSX.Element;

package/dist/dashboard/index.d.ts

@@ -0,0 +1,3 @@
+export { DashboardById } from './dashboard-by-id';
+export { Dashboard } from './dashboard';
+export { type DashboardByIdProps, type DashboardProps } from './types';

package/dist/dashboard/types.d.ts

@@ -1,5 +1,5 @@
-import { Layout, WidgetModel } from '../models';
-import { Filter } from '@sisense/sdk-data';
+import { Layout, WidgetFilterOptions, WidgetModel } from '../models';
+import { DataSource, Filter } from '@sisense/sdk-data';
 /**
  * Props for the DashboardById component
  *
@@ -19,6 +19,7 @@ export interface DashboardLayoutProps {
     widgets: WidgetModel[];
     filters: Filter[];
     onFiltersChange: (filters: Filter[]) => void;
+    defaultDataSource?: DataSource;
 }
 /**
  * Props for the Dashboard component
@@ -30,6 +31,8 @@ export interface DashboardProps {
     layout: Layout;
     widgets: WidgetModel[];
     filters: Filter[];
+    defaultDataSource?: DataSource;
+    widgetFilterOptions?: WidgetFilterOptions;
 }
 /**
  * Props for the Dashboard Header component

package/dist/dashboard/utils.d.ts

@@ -1,5 +1,2 @@
-import { Filter } from '@sisense/sdk-data';
-import { WidgetModel } from '../models';
 export declare function isSupportedWidgetTypeByDashboard(widgetType: string): boolean;
-export declare function addFiltersToWidget(widget: WidgetModel, filters: Filter[]): WidgetModel;
 export declare const getDividerStyle: (color: string, width: number) => string;