@sisense/sdk-ui 1.2.0 → 1.4.0

package/dist/charts/map-charts/areamap/areamap-map.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { FeatureCollection as GeoJsonFeatureCollection } from 'geojson';
+import type { FeatureCollection as GeoJsonFeatureCollection } from 'geojson';
 import { GeoDataElement } from '../../../chart-data/types.js';
 import { AreamapType } from '../../../types.js';
 export type AreamapProps = {
@@ -7,6 +7,7 @@ export type AreamapProps = {
     geoData: GeoDataElement[];
     dataOptions: {
         originalValueTitle: string;
+        onAreaClick?: (geoDataElement: GeoDataElement, clickEvent: MouseEvent) => void;
     };
     mapType: AreamapType;
 };

package/dist/charts/map-charts/areamap/areamap.d.ts

@@ -2,15 +2,17 @@
 import { AreamapChartDataOptionsInternal, ChartDataOptionsInternal } from '../../../chart-data-options/types.js';
 import { AreamapData, ChartData } from '../../../chart-data/types.js';
 import { AreamapChartDesignOptions } from '../../../chart-options-processor/translations/design-options.js';
-import { ChartDesignOptions } from '../../../chart-options-processor/translations/types.js';
+import { DesignOptions } from '../../../chart-options-processor/translations/types.js';
 import { ThemeSettings } from '../../../types.js';
-export type AreamapChartProps = {
+import { AreamapDataPointEventHandler } from '../../../props';
+export type AreamapProps = {
     chartData: AreamapData;
     dataOptions: AreamapChartDataOptionsInternal;
     designOptions: AreamapChartDesignOptions;
     themeSettings: ThemeSettings;
+    onDataPointClick?: AreamapDataPointEventHandler;
 };
-export declare const Areamap: React.FC<AreamapChartProps>;
+export declare const Areamap: React.FC<AreamapProps>;
 export declare const isAreamapData: (chartData: ChartData) => chartData is AreamapData;
 export declare const isAreamapDataOptions: (dataOptions: ChartDataOptionsInternal) => dataOptions is AreamapChartDataOptionsInternal;
-export declare const isAreamapChartDesignOptions: (designOptions: ChartDesignOptions) => designOptions is AreamapChartDesignOptions;
+export declare const isAreamapChartDesignOptions: (designOptions: DesignOptions) => designOptions is AreamapChartDesignOptions;

package/dist/charts/map-charts/areamap/use-geo-json.d.ts

@@ -1,5 +1,5 @@
 import { FeatureCollection as GeoJsonFeatureCollection } from 'geojson';
-import { AreamapType } from '../../../types.js';
+import { AreamapType } from '../../../types';
 /**
  * Hook to get geoJson from API or cache (LocalStorage)
  */

package/dist/charts/map-charts/scattermap/scattermap.d.ts

@@ -1,13 +1,19 @@
 /// <reference types="react" />
-import { ScattermapChartData } from '../../../chart-data/types.js';
-import { ScattermapChartDataOptionsInternal } from '../../../chart-data-options/types.js';
+import { ChartData, ScattermapChartData } from '../../../chart-data/types.js';
+import { ScattermapDataPointEventHandler } from '../../../props.js';
+import { ChartDataOptionsInternal, ScattermapChartDataOptionsInternal } from '../../../chart-data-options/types.js';
 import { ScattermapChartDesignOptions } from '../../../chart-options-processor/translations/design-options.js';
-import { DataSource, Filter, FilterRelation } from '@sisense/sdk-data';
+import { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
+import { DesignOptions } from '../../../chart-options-processor/translations/types.js';
 export type ScattermapProps = {
     chartData: ScattermapChartData;
     dataOptions: ScattermapChartDataOptionsInternal;
     designOptions: ScattermapChartDesignOptions;
     dataSource: DataSource | null;
-    filters?: Filter[] | FilterRelation;
+    filters?: Filter[] | FilterRelations;
+    onMarkerClick?: ScattermapDataPointEventHandler;
 };
-export declare const Scattermap: ({ chartData, dataOptions, dataSource, filters, designOptions, }: ScattermapProps) => JSX.Element;
+export declare const Scattermap: ({ chartData, dataOptions, dataSource, filters, designOptions, onMarkerClick, }: ScattermapProps) => JSX.Element;
+export declare const isScattermapData: (chartData: ChartData) => chartData is ScattermapChartData;
+export declare const isScattermapDataOptions: (dataOptions: ChartDataOptionsInternal) => dataOptions is ScattermapChartDataOptionsInternal;
+export declare const isScattermapChartDesignOptions: (designOptions: DesignOptions) => designOptions is ScattermapChartDesignOptions;

package/dist/charts/map-charts/scattermap/utils/location.d.ts

@@ -1,5 +1,8 @@
 import { ScattermapLocationLevel } from '../../../../chart-data-options/types';
+import { ScattermapDataPoint } from '../../../../types';
+import { ScattermapChartLocation } from '../../../../chart-data/types';
 export declare const LOCATION_DELIMITER = ",";
 export declare function combineLocationNames(names: string[]): string;
 export declare function splitLocationName(combinedLocation: string): string[];
 export declare function getLocationGeoLevel(level: ScattermapLocationLevel): "country" | "city" | "adm" | undefined;
+export declare function locationToScattermapDataPoint(location: ScattermapChartLocation): ScattermapDataPoint;

package/dist/charts/map-charts/scattermap/utils/markers.d.ts

@@ -1,28 +1,18 @@
 import leaflet from 'leaflet';
 import { ScattermapMarkers } from '../../../../types';
-type PrepareMarkerOptionsProps = {
+type MarkerStyle = {
     color: string;
     size: number;
     fill: Required<ScattermapMarkers>['fill'];
     blur: boolean;
 };
-type CreateMarkerProps = {
+export type MarkerConfig = {
     coordinates: {
         lat: number;
         lng: number;
     };
-    style: PrepareMarkerOptionsProps;
+    style: MarkerStyle;
 };
-export declare function prepareMarkerOptions(style: PrepareMarkerOptionsProps): {
-    radius: number;
-    fillOpacity: number;
-    opacity: number;
-    fillColor: string;
-    color: string;
-    stroke: boolean;
-    weight: number;
-    customStyle: PrepareMarkerOptionsProps;
-};
-export declare function createMarker({ coordinates, style }: CreateMarkerProps): leaflet.CircleMarker<any>;
+export declare function createMarker({ coordinates, style }: MarkerConfig): leaflet.CircleMarker;
 export declare function removeMarkers(markers: leaflet.CircleMarker[]): void;
 export {};

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

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

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

@@ -0,0 +1,14 @@
+import { ReactNode } from 'react';
+import { CompleteThemeSettings } from '../../types';
+/**
+ * Component that displays a loading overlay.
+ * Overlay is active when query is executed within a chart.
+ *
+ * @param isVisible - visibility of the overlay.
+ * @returns Child component wrapped in dynamic overlay.
+ */
+export declare const LoadingOverlay: ({ isVisible, themeSettings, children, }: {
+    isVisible: boolean;
+    themeSettings: CompleteThemeSettings;
+    children: ReactNode;
+}) => JSX.Element;

package/dist/common/hooks/data-load-state-reducer.d.ts

@@ -1,8 +1,10 @@
 /**
+ * @internal
  * States of a data load.
  */
 export type DataState<Data> = DataLoadingState<Data> | DataErrorState | DataSuccessState<Data>;
 /**
+ * @internal
  * State of data loading.
  */
 export type DataLoadingState<Data> = {
@@ -20,6 +22,7 @@ export type DataLoadingState<Data> = {
     status: 'loading';
 };
 /**
+ * @internal
  * State of a data load that has failed.
  */
 export type DataErrorState = {
@@ -37,6 +40,7 @@ export type DataErrorState = {
     status: 'error';
 };
 /**
+ * @internal
  * State of a data load that has succeeded.
  */
 export type DataSuccessState<Data> = {
@@ -53,6 +57,9 @@ export type DataSuccessState<Data> = {
     /** The status of the data load */
     status: 'success';
 };
+/**
+ * @internal
+ */
 export type DataLoadAction<Data> = {
     type: 'loading';
 } | {
@@ -62,4 +69,7 @@ export type DataLoadAction<Data> = {
     type: 'error';
     error: Error;
 };
+/**
+ * @internal
+ */
 export declare function dataLoadStateReducer<Data>(state: DataState<Data>, action: DataLoadAction<Data>): DataState<Data>;

package/dist/common/hooks/use-hover.d.ts

@@ -0,0 +1,8 @@
+import { Ref } from 'react';
+/**
+ * Track whether an element is being hovered over.
+ *
+ * @privateRemarks Derived from https://github.com/uidotdev/usehooks/blob/dfa6623fcc2dcad3b466def4e0495b3f38af962b/index.js#L426.
+ * @internal
+ */
+export declare const useHover: <T extends HTMLElement>() => [Ref<T>, boolean];

package/dist/common/icons/yellow-exclamation-mark-icon.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export default function YellowExclamationMarkIcon(): JSX.Element;

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

@@ -3,6 +3,6 @@ import { StyledMeasureColumn, StyledColumn, Color } from '../types';
 import { Panel, PanelItem, WidgetType, WidgetStyle, BoxplotWidgetStyle } from './types';
 import { WidgetDataOptions } from '../models';
 export declare function createDimensionalElementFromJaql(jaql: Jaql, format?: PanelItem['format']): import("@sisense/sdk-data").Filter | DimensionalCalculatedMeasure | DimensionalBaseMeasure | DimensionalAttribute;
-export declare function createDataColumn(item: PanelItem, customPaletteColors?: Color[]): StyledColumn | StyledMeasureColumn;
+export declare function createDataColumn(item: PanelItem, customPaletteColors?: Color[]): StyledMeasureColumn | StyledColumn;
 export declare function extractBoxplotBoxType(style: BoxplotWidgetStyle): "iqr" | "extremums" | "standardDeviation";
 export declare function extractDataOptions(widgetType: WidgetType, panels: Panel[], style: WidgetStyle, customPaletteColors?: Color[]): WidgetDataOptions;

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

@@ -25,7 +25,7 @@ export declare function extractFilterModelFromJaql(jaql: FilterJaql): {
  * @param jaql - The filter JAQL object.
  * @returns - The created Filter object.
  */
-export declare function createFilterFromJaql(jaql: FilterJaql): Filter;
+export declare function createFilterFromJaql(jaql: FilterJaql, instanceid?: string): Filter;
 /**
  * Extracts filters from the widget panel.
  *

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

@@ -97,6 +97,7 @@ export type DatetimeMask = {
     dateAndTime?: string;
 };
 export type PanelItem = {
+    instanceid?: string;
     format?: {
         color?: PanelColorFormat;
         mask?: DatetimeMask | NumericMask;

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

@@ -25,6 +25,9 @@ export declare const fetchWidgetDtoModel: ({ widgetOid, dashboardOid, includeDas
         datasource: import("./types").Datasource;
         widgets?: WidgetDto[] | undefined;
         filters?: (import("../api/types/dashboard-dto").Filter | import("../api/types/dashboard-dto").CascadingFilter)[] | undefined;
+        filterRelations?: {
+            filterRelations: import("@sisense/sdk-data").FilterRelationsModel;
+        }[] | undefined;
     } & import("../utils/utility-types").AnyObject) | undefined;
 }>;
 /**

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

@@ -1,4 +1,4 @@
-import { type Filter, SortDirection as JaqlSortDirection } from '@sisense/sdk-data';
+import { type Filter, SortDirection as JaqlSortDirection, FilterRelations, FilterRelationsModel, FilterRelationsJaql } from '@sisense/sdk-data';
 import { ChartSubtype } from '../chart-options-processor/subtype-to-design-options';
 import { ChartType, SortDirection } from '../types';
 import { FiltersMergeStrategy, Panel, PanelItem, WidgetSubtype, WidgetType } from './types';
@@ -28,4 +28,29 @@ export declare function mergeFilters(sourceFilters?: Filter[], targetFilters?: F
  * @returns {Filter[]} The merged filters based on the selected strategy.
  */
 export declare function mergeFiltersByStrategy(widgetFilters?: Filter[], codeFilters?: Filter[], mergeStrategy?: FiltersMergeStrategy): Filter[];
+/**
+ * Replaces nodes of filter reations tree with fetched filters by instance id.
+ *
+ * @param filters - The filters from the dashboard.
+ * @param filterRelations - Fetched filter relations.
+ * @returns {FilterRelations} Filter relations with filters in nodes.
+ */
+export declare function getFilterRelationsFromJaql(filters: Filter[], filterRelations: FilterRelationsJaql | undefined): FilterRelations | Filter[];
+/**
+ * Converts filter relations model to filter relations jaql.
+ *
+ * @param filterRelations - Filter relations model.
+ * @returns {FilterRelationsJaql} Filter relations jaql.
+ */
+export declare function convertFilterRelationsModelToJaql(filterRelations: FilterRelationsModel | undefined): FilterRelationsJaql | undefined;
+/**
+ * Replaces filters for same dimensions in filter relations jaql.
+ * Widget filters have higher priority than dashboard filters.
+ *
+ * @param widgetFilters - The filters from the widget.
+ * @param dashboardFilters -  The filters from the dashboard.
+ * @param relations - The filter relations before replacement.
+ * @returns {FilterRelationsJaql} The filter relations after replacement.
+ */
+export declare function applyWidgetFiltersToRelations(widgetFilters: Filter[], dashboardFilters: Filter[], relations: FilterRelationsJaql | undefined): FilterRelationsJaql | undefined;
 export {};

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

@@ -1,2 +1,13 @@
+import { ClientApplication } from '../../app/client-application';
 export type HookDecorator<DecoratorConfig> = (decoratorConfig: DecoratorConfig) => <HookArgs extends any[], HookResult>(hook: (...args: HookArgs) => HookResult) => (...args: HookArgs) => HookResult;
+/**
+ * @internal
+ * @description This is a function that tracks the hook event and sends it to the server.
+ * @param hookName - The name of the hook
+ * @param packageName - The name of the package
+ * @param app - The client application
+ * @param onFinally - The function to call after the tracking is done
+ * @returns Promise<void>
+ */
+export declare const trackHook: (hookName: string, packageName: string, app: ClientApplication, onFinally: () => void) => Promise<void>;
 export declare const withTracking: HookDecorator<string>;

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

@@ -1,6 +1,7 @@
 import type { FunctionComponent, InputHTMLAttributes } from 'react';
 type CheckboxProps = {
     label?: string;
+    isLabelInactive?: boolean;
     wrapperClassName?: string;
 } & InputHTMLAttributes<HTMLInputElement>;
 export declare const Checkbox: FunctionComponent<CheckboxProps>;

package/dist/formulas/fetch-formula.d.ts

@@ -3,6 +3,7 @@ import { DimensionalCalculatedMeasure } from '@sisense/sdk-data';
 /**
  * Fetch a formula by oid from the default Sisense instance
  *
+ * @internal
  * @param oid - Formula identifier in Sisense instance
  * @param app - Client application
  */
@@ -10,6 +11,7 @@ export declare function fetchFormulaByOid(oid: string, app: ClientApplication):
 /**
  * Fetch a shared formula by name and data source from the Sisense instance
  *
+ * @internal
  * @param name - Formula name/title in Sisense instance
  * @param dataSource - Data source in Sisense instance
  */

package/dist/formulas/index.d.ts

@@ -1 +1,2 @@
+export * from './fetch-formula';
 export * from './use-get-shared-formula';

package/dist/formulas/use-get-shared-formula.d.ts

@@ -1,6 +1,7 @@
 import { CalculatedMeasure } from '@sisense/sdk-data';
 import { UseGetSharedFormulaParams } from '../props.js';
 import { HookEnableParam } from '../common/hooks/types.js';
+import { DataState } from '../common/hooks/data-load-state-reducer.js';
 /**
  * Parameters for {@link useGetSharedFormula} hook.
  */
@@ -93,3 +94,7 @@ export declare const useGetSharedFormula: (params: UseGetSharedFormulaParams) =>
  * @internal
  */
 export declare function useGetSharedFormulaInternal(params: UseGetSharedFormulaParams): SharedFormulaState;
+/**
+ * @internal
+ */
+export declare function translateToFormulaResponse(dataState: DataState<CalculatedMeasure | null>): SharedFormulaState;

package/dist/index.d.ts

@@ -1,6 +1,3 @@
-/**
- * @packageDocumentation
- */
 export { ClientApplication, createClientApplication } from './app/client-application';
 export * from './chart-data-options/types';
 export { Chart } from './chart';
@@ -26,6 +23,7 @@ export * from './polar-chart';
 export * from './scatter-chart';
 export * from './indicator-chart';
 export * from './table';
+export * from './pivot-table';
 export * from './treemap-chart';
 export * from './sunburst-chart';
 export * from './boxplot-chart';
@@ -35,9 +33,12 @@ export * from './sisense-context/custom-sisense-context-provider';
 export * from './theme-provider/custom-theme-provider';
 export { getThemeSettingsByOid } from './themes/theme-loader';
 export { getDefaultThemeSettings } from './chart-options-processor/theme-option-service';
-export { useGetDashboardModel, useGetDashboardModels, getDashboardModel, getDashboardModels, useGetWidgetModel, getWidgetModel, type DashboardModel, type GetDashboardModelParams, type GetDashboardModelsParams, type DashboardModelState, type DashboardModelLoadingState, type DashboardModelSuccessState, type DashboardModelErrorState, type DashboardModelsState, type DashboardModelsLoadingState, type DashboardModelsSuccessState, type DashboardModelsErrorState, type WidgetModel, type WidgetDataOptions, type WidgetModelState, type WidgetModelLoadingState, type WidgetModelErrorState, type WidgetModelSuccessState, type GetWidgetModelParams, type GetDashboardModelOptions, type GetDashboardModelsOptions, } from './models';
+export { useGetDashboardModel, useGetDashboardModels, getDashboardModel, getDashboardModels, useGetWidgetModel, getWidgetModel, translateToDashboardResponse, translateToDashboardsResponse, type DashboardModel, type GetDashboardModelParams, type GetDashboardModelsParams, type DashboardModelState, type DashboardModelLoadingState, type DashboardModelSuccessState, type DashboardModelErrorState, type DashboardModelsState, type DashboardModelsLoadingState, type DashboardModelsSuccessState, type DashboardModelsErrorState, type WidgetModel, type WidgetDataOptions, type WidgetModelState, type WidgetModelLoadingState, type WidgetModelErrorState, type WidgetModelSuccessState, type GetWidgetModelParams, type GetDashboardModelOptions, type GetDashboardModelsOptions, } from './models';
 export { boxWhiskerProcessResult } from './boxplot-utils';
+export { queryStateReducer } from './query-execution/query-state-reducer';
 export * from './props';
 export * from './types';
 export * from './filters';
 export * from './formulas';
+export { trackHook } from './decorators/hook-decorators';
+export * from './common/hooks/data-load-state-reducer';