@sisense/sdk-ui 0.15.0 → 0.16.0

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

@@ -1,19 +1,20 @@
 import { Jaql, SortDirection } from '@sisense/sdk-data';
-export declare const enum WidgetType {
-    PieChart = "chart/pie",
-    ColumnChart = "chart/column",
-    BarChart = "chart/bar",
-    LineChart = "chart/line",
-    AreaChart = "chart/area",
-    FunnelChart = "chart/funnel",
-    TreemapChart = "treemap",
-    SunburstChart = "sunburst",
-    ScatterChart = "chart/scatter",
-    IndicatorChart = "indicator",
-    PolarChart = "chart/polar",
-    Table = "tablewidget",
-    TableWithAggregation = "tablewidgetagg"
-}
+/**
+ * The type of a widget on a dashboard that is a variant of Cartesian widget.
+ */
+export type CartesianWidgetType = 'chart/line' | 'chart/area' | 'chart/bar' | 'chart/column' | 'chart/polar';
+/**
+ * The type of a widget on a dashboard that is a variant of Categorical widget.
+ */
+export type CategoricalWidgetType = 'chart/pie' | 'chart/funnel' | 'treemap' | 'sunburst';
+/**
+ * The type of a widget on a dashboard that is a variant of tabular widget.
+ */
+export type TabularWidgetType = 'tablewidget' | 'tablewidgetagg';
+/**
+ * The type of a widget on a dashboard.
+ */
+export type WidgetType = CartesianWidgetType | CategoricalWidgetType | 'chart/scatter' | 'indicator' | TabularWidgetType;
 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",
@@ -23,7 +24,9 @@ export type Datasource = {
     title: string;
     id: string;
     fullname?: string;
-    live: boolean;
+    live?: boolean;
+    address?: string;
+    database?: string;
 };
 /**
  * The data transfer object (DTO) containing info of a widget on a dashboard.
@@ -42,7 +45,7 @@ export interface WidgetDto {
     };
     style: WidgetStyle;
     title: string;
-    desc: string;
+    desc: string | null;
     options?: {
         dashboardFiltersMode: `${WidgetDashboardFilterMode}`;
     };

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

@@ -20,7 +20,13 @@ export declare const fetchWidgetDtoModel: ({ widgetOid, dashboardOid, includeDas
     api: RestApi;
 }) => Promise<{
     widget: WidgetDto;
-    dashboard: DashboardDto | undefined;
+    dashboard: ({
+        oid: string;
+        title: string;
+        datasource: import("./types").Datasource;
+        widgets?: WidgetDto[] | undefined;
+        filters?: (import("../api/types/dashboard-dto").Filter | import("../api/types/dashboard-dto").CascadingFilter)[] | undefined;
+    } & import("../utils/utility-types").AnyObject) | undefined;
 }>;
 /**
  * Custom hook for fetching Widget DTO and Dashboard DTO models.

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

@@ -6,7 +6,7 @@ export declare function getChartType(widgetType: WidgetType): ChartType;
 export declare function getChartSubtype(widgetSubtype: WidgetSubtype): ChartSubtype | undefined;
 type WidgetTypeOrString = string | WidgetType;
 export declare function isSupportedWidgetType(widgetType: WidgetTypeOrString): widgetType is WidgetType;
-export declare function isTableWidget(widgetType: WidgetTypeOrString): boolean;
+export declare function isTabularWidget(widgetType: WidgetTypeOrString): boolean;
 export declare function getEnabledPanelItems(panels: Panel[], panelName: string): PanelItem[];
 export declare function getRootPanelItem(item: PanelItem): PanelItem;
 export declare function getSortType(jaqlSort: JaqlSortDirection | undefined): SortDirection;

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

@@ -0,0 +1,8 @@
+import { type FunctionComponent } from 'react';
+import { MenuList } from '@mui/material';
+export type DropdownProps = {
+    elements: JSX.Element[];
+    icon?: JSX.Element;
+    selectedIdx?: number;
+} & React.ComponentProps<typeof MenuList>;
+export declare const Dropdown: FunctionComponent<DropdownProps>;

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

@@ -2,7 +2,8 @@ export { LinkButton, PrimaryButton, SecondaryButton } from './buttons';
 export { Checkbox } from './checkbox';
 export { BasicInput } from './basic-input';
 export { Input } from './input';
-export { Radio } from './radio';
+export { Radio, RadioGroup, type RadioGroupProps } from './radio';
 export { SisenseSwitchButton } from './switch';
 export { TriangleIndicator } from './triangle-indicator';
 export { DateRangeFieldButton } from './date-range-field-button';
+export { Dropdown } from './dropdown';

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

@@ -3,4 +3,11 @@ type RadioProps = {
     label?: string;
 } & InputHTMLAttributes<HTMLInputElement>;
 export declare const Radio: FunctionComponent<RadioProps>;
+export type RadioGroupProps = {
+    items: string[];
+    currentSelection?: string;
+    title?: string;
+    className?: string;
+} & InputHTMLAttributes<HTMLInputElement>;
+export declare const RadioGroup: FunctionComponent<RadioGroupProps>;
 export {};

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

@@ -1,11 +1,11 @@
 import { FunctionComponent } from 'react';
-import { FilterOptionType } from './criteria-filter-operations.js';
+import { FilterOptionType, CriteriaFilterValueType } from './criteria-filter-operations.js';
 /**
  * Props for {@link CriteriaFilterDisplay}
  */
 export interface CriteriaFilterDisplayProps {
     filterType: FilterOptionType;
-    values?: (number | string)[];
+    values?: CriteriaFilterValueType[];
 }
 /**
  * UI component that provides a static, uneditable display of the criteria filter values, to be shown when vertically aligned filter tiles are collapsed.

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

@@ -1,5 +1,6 @@
 import { FunctionComponent } from 'react';
-import { FilterOptionType, FilterVariant } from './criteria-filter-operations';
+import { FilterOptionType, FilterVariant, CriteriaFilterValueType } from './criteria-filter-operations';
+import { Measure } from '@sisense/sdk-data';
 /**
  * Props for {@link CriteriaFilterMenu}
  *
@@ -8,9 +9,10 @@ import { FilterOptionType, FilterVariant } from './criteria-filter-operations';
 export interface CriteriaFilterMenuProps {
     filterType: FilterOptionType;
     arrangement?: FilterVariant;
-    defaultValues?: (number | string)[];
-    onUpdate?: (values: (number | string)[]) => void;
+    defaultValues?: CriteriaFilterValueType[];
+    onUpdate?: (values: CriteriaFilterValueType[]) => void;
     disabled?: boolean;
+    measures?: Measure[];
 }
 /**
  * UI component that provides field(s) for the user to enter values for a numeric filter.

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

@@ -1,3 +1,5 @@
+import { Measure } from '@sisense/sdk-data';
+import { CriteriaFilterType } from './criteria-filter-tile';
 /**
  * Collection of filter options for the {@link CriteriaFilterMenu},
  * to be provided to subcomponents as the `filterType` prop.
@@ -5,6 +7,9 @@
  * @internal
  */
 export declare const FilterOption: {
+    NOT_BETWEEN: string;
+    TOP: string;
+    BOTTOM: string;
     BETWEEN: string;
     EQUALS: string;
     NOT_EQUALS: string;
@@ -24,7 +29,6 @@ export declare const FilterOption: {
 };
 export type FilterOptionType = keyof typeof FilterOption;
 export type FilterVariant = 'vertical' | 'horizontal';
-export type FilterInputType = 'text' | 'number';
 /**
  * Object containing related information for a filter option,
  * including the function to be used for filtering, the number of inputs,
@@ -39,7 +43,7 @@ export type FilterInfo = {
     symbols: string[];
     message: string;
     ranked: boolean;
-    type: FilterInputType;
+    type: string;
 };
 /**
  * Map of {@link FilterOption} to {@link FilterInfo}
@@ -58,5 +62,15 @@ export declare const CRITERIA_FILTER_MAP: {
  * @internal
  */
 export declare const isVertical: (arrangement: FilterVariant) => boolean;
-export declare const operatorsToOption: (operatorA?: string, operatorB?: string) => "BETWEEN" | "EQUALS" | "NOT_EQUALS" | "LESS_THAN" | "LESS_THAN_OR_EQUAL" | "GREATER_THAN" | "GREATER_THAN_OR_EQUAL" | "IS" | "IS_NOT" | "CONTAINS" | "NOT_CONTAIN" | "STARTS_WITH" | "NOT_STARTS_WITH" | "ENDS_WITH" | "NOT_ENDS_WITH" | "LIKE";
+/**
+ * Given an input filter, use the filterType and operators to determine
+ * the corresponding {@link FilterOption} and {@link FilterInfo}.
+ *
+ * @internal
+ */
+export declare const filterToOption: (filter: CriteriaFilterType) => FilterOptionType;
+export type CriteriaFilterValueType = string | number | Measure;
+export declare const filterToDefaultValues: (filter: CriteriaFilterType) => CriteriaFilterValueType[];
+export declare const valuesToDisplayValues: (values: CriteriaFilterValueType[]) => (string | number)[];
 export declare const translatedMsgNoVal: (message: string, t: Function) => any;
+export declare const filterTypeToInputType: (filterType: string) => string;

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

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import { FilterVariant } from './criteria-filter-operations.js';
-import { Filter, NumericFilter, TextFilter } from '@sisense/sdk-data';
+import { ExcludeFilter, Filter, Measure, NumericFilter, RankingFilter, TextFilter } from '@sisense/sdk-data';
 /**
  * Props for {@link CriteriaFilterTile}
  */
@@ -13,14 +13,31 @@ export interface CriteriaFilterTileProps {
     arrangement?: FilterVariant;
     /** Callback returning filter object, or null for failure */
     onUpdate: (filter: Filter | null) => void;
+    /** List of available measures to rank by. Required only for ranking filters. */
+    measures?: Measure[];
 }
-export type CriteriaFilterType = NumericFilter | TextFilter;
+export type CriteriaFilterType = NumericFilter | TextFilter | RankingFilter | ExcludeFilter;
 /**
  * UI component that allows the user to filter numeric or text attributes according to
- * a number of built-in operations defined in the {@link NumericFilter} or {@link TextFilter}.
+ * a number of built-in operations defined in the {@link NumericFilter}, {@link TextFilter}, or {@link RankingFilter}.
  *
  * The arrangement prop determines whether the filter is rendered vertically or horizontally, with the latter intended for toolbar use and omitting title, enable/disable, and collapse/expand functionality.
  *
+ * @example
+ * ```tsx
+ * const initialRevenueFilter = filters.greaterThanOrEqual(DM.Commerce.Revenue, 10000);
+ * const [revenueFilter, setRevenueFilter] = useState<Filter | null>(initialRevenueFilter);
+ *
+ * return (
+ *   <CriteriaFilterTile
+ *     title={'Revenue'}
+ *     filter={revenueFilter}
+ *     onUpdate={setRevenueFilter}
+ *   />
+ * );
+ * ```
+ *
+ * <img src="media://criteria-filter-tile-example-1.png" width="300px" />
  * @param props - Criteria filter tile props
  * @returns Criteria filter tile component
  */

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

@@ -18,6 +18,8 @@ export interface BasicMemberFilterTileProps {
     maxAllowedMembers?: number;
     /** Whether this is a dependent filter */
     isDependent?: boolean;
+    /** Flag to update selected members when caused by an external change */
+    shouldUpdateSelectedMembers?: boolean;
 }
 /**
  * UI component that, given a list of members to select from and a list of

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

@@ -20,6 +20,14 @@ type DeselectMemberAction = {
 type SelectAllMembersAction = {
     type: 'selectAllMembers';
 };
+type UpdatePossibleMembersAction = {
+    type: 'updatePossibleMembers';
+    members: Member[];
+};
+type UpdateMembersAction = {
+    type: 'updateMembers';
+    members: SelectedMember[];
+};
 type ClearAllMembersAction = {
     type: 'clearAllMembers';
 };
@@ -27,6 +35,6 @@ type ToggleSelectedMemberAction = {
     type: 'toggleSelectedMember';
     memberKey: string;
 };
-export type MembersAction = SelectMemberAction | DeselectMemberAction | SelectAllMembersAction | ClearAllMembersAction | ToggleSelectedMemberAction;
+export type MembersAction = SelectMemberAction | DeselectMemberAction | SelectAllMembersAction | UpdatePossibleMembersAction | UpdateMembersAction | ClearAllMembersAction | ToggleSelectedMemberAction;
 export declare function membersReducer(state: MembersState, action: MembersAction): MembersState;
 export {};

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

@@ -1,7 +1,6 @@
 import type { FunctionComponent } from 'react';
 import { SelectedMember } from './members-reducer';
 export interface PillSectionProps {
-    membersSize: number;
     selectedMembers: SelectedMember[];
     onToggleSelectedMember: (key: string) => void;
     disabled: boolean;

package/dist/highcharts-memorized.d.ts

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

package/dist/index.d.ts

@@ -7,6 +7,7 @@ export * from './chart-data-options/types';
 export { Chart } from './chart';
 export { ThemeProvider } from './theme-provider';
 export { DashboardWidget } from './dashboard-widget/dashboard-widget';
+export { type WidgetType, type CartesianWidgetType, type CategoricalWidgetType, type TabularWidgetType, } from './dashboard-widget/types';
 export * from './query-execution';
 export { executeQuery } from './query/execute-query';
 export { SisenseContextProvider } from './sisense-context/sisense-context-provider';
@@ -31,7 +32,7 @@ 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, 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 GetDashboardModelOptions, type GetDashboardModelsOptions, } from './models';
+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 * from './props';
 export * from './types';
 export * from './filters';