@sisense/sdk-ui 0.14.0 → 0.15.0

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

@@ -1,4 +1,5 @@
-import { WidgetDto, Datasource, FilterJaql } from '../../dashboard-widget/types';
+import { WidgetDto, Datasource } from '../../dashboard-widget/types';
+import { FilterJaql } from '@sisense/sdk-data';
 export type Filter = {
     isCascading?: false;
     jaql: FilterJaql;

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

@@ -35,5 +35,5 @@ export declare class Indicator {
      * @param {object} options
      * @param {string} size
      */
-    setTextOptions(options: LegacyIndicatorChartOptions, size: string): void;
+    setTextOptions(options: LegacyIndicatorChartOptions, size?: string): void;
 }

package/dist/charts/indicator/chart/ticker.d.ts

@@ -1,5 +1,5 @@
 import { IndicatorLegacyChartDataOptions } from '../indicator-legacy-chart-data-options';
-import { LegacyIndicatorChartOptions } from '../types';
+import { LegacyIndicatorChartOptions, TickerOptions } from '../types';
 export declare class Ticker {
     /**
      * Renders indicator ticker widget.
@@ -9,7 +9,7 @@ export declare class Ticker {
      * @param {object} options
      * @param {HTMLElement} container
      */
-    render(canvas: HTMLCanvasElement, data: IndicatorLegacyChartDataOptions, options: LegacyIndicatorChartOptions | any, container: HTMLElement): void;
+    render(canvas: HTMLCanvasElement, data: IndicatorLegacyChartDataOptions, options: TickerOptions, container: HTMLElement): void;
     /**
      * Draws indicator ticker widget.
      *

package/dist/charts/indicator/indicator-legacy-chart-options/default-options.d.ts

@@ -1,4 +1,5 @@
-import { NumericSimpleOptions, NumericBarOptions, GaugeOptions } from '../types';
+import { NumericSimpleOptions, NumericBarOptions, GaugeOptions, TickerOptions } from '../types';
 export declare const defaultNumericSimpleOptions: NumericSimpleOptions;
 export declare const defaultNumericBarOptions: NumericBarOptions;
 export declare const defaultGaugeOptions: GaugeOptions;
+export declare const defaultTickerOptions: TickerOptions;

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

@@ -32,20 +32,21 @@ type CommonOptions = {
     fontFamily: string;
     title: {
         color: string;
-        fontSizes: FontSizes;
+        fontSizes?: FontSizes;
     };
     value: {
         color?: string;
-        fontSizes: FontSizes;
+        fontSizes?: FontSizes;
+        fontWeight?: number;
     };
     secondaryTitle: {
         color: string;
-        fontSizes: FontSizes;
+        fontSizes?: FontSizes;
     };
     secondaryValue: {
-        fontWeight: number;
+        fontWeight?: number;
         color: string;
-        fontSizes: FontSizes;
+        fontSizes?: FontSizes;
     };
     textKeys: string[];
     backgroundColor: string;
@@ -114,5 +115,45 @@ export type GaugeOptions = CommonOptions & {
     gaugeHeights: BaseMeasure[];
     measureKeys: string[];
 };
-export type LegacyIndicatorChartOptions = NumericBarOptions | NumericSimpleOptions | GaugeOptions;
+export type TickerOptions = CommonOptions & {
+    fontSize: number;
+    dividerColor: string;
+    barHandleColor: string;
+    height: number;
+    horizontalMargin: number;
+    barWidth: number;
+    barHeight: number;
+    barOpacity: number;
+    tickerBarWidth: number;
+    tickerBarHeight: number;
+    horizontalPadding: number;
+    textPadding: number;
+    sectionMinWidth: number;
+    dividerWidth: number;
+    dividerHeight: number;
+    valueFont?: string;
+    titleFont?: string;
+    secondaryValueFont?: string;
+    secondaryTitleFont?: string;
+    offsetX?: number;
+    showTickerBar?: boolean;
+    fitValueMeasure?: {
+        string: string;
+        width: number;
+    };
+    fitSecValueMeasure?: {
+        string: string;
+        width: number;
+    };
+    fitSecTitleMeasure?: {
+        string: string;
+        width: number;
+    };
+    fitTitleMeasure?: {
+        string: string;
+        width: number;
+    };
+    width?: number;
+};
+export type LegacyIndicatorChartOptions = NumericBarOptions | NumericSimpleOptions | GaugeOptions | TickerOptions;
 export {};

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

@@ -0,0 +1,33 @@
+/// <reference types="react" />
+import { CompleteThemeSettings } from '../../types';
+/**
+ * Component that displays a loading indicator.
+ *
+ * @param onCancel - Function to call when cancel is clicked.
+ * @returns A loading indicator with optional cancel.
+ */
+export declare const LoadingIndicator: ({ themeSettings, onCancel, }: {
+    themeSettings?: {
+        chart: {
+            textColor: string;
+            secondaryTextColor: string;
+            backgroundColor: string;
+            panelBackgroundColor: string;
+        };
+        palette: {
+            variantColors: import("../../types").Color[];
+        };
+        typography: {
+            fontFamily: string;
+            primaryTextColor: string;
+            secondaryTextColor: string;
+        };
+        general: {
+            brandColor: string;
+            backgroundColor: string;
+            primaryButtonTextColor: string;
+            primaryButtonHoverColor: string;
+        };
+    } | undefined;
+    onCancel?: (() => void) | undefined;
+}) => JSX.Element;

package/dist/common/icons/loading-icon.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+type LoadingIconProps = {
+    spin?: boolean;
+};
+export default function LoadingIcon({ spin }: LoadingIconProps): JSX.Element;
+export {};

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

@@ -8,6 +8,6 @@ import { WidgetDto } from './types';
  * @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[];
+    filters: import("@sisense/sdk-data").Filter[];
+    highlights: import("@sisense/sdk-data").Filter[];
 };

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

@@ -1,6 +1,6 @@
-import { DimensionalBaseMeasure, DimensionalAttribute, DimensionalCalculatedMeasure } from '@sisense/sdk-data';
+import { DimensionalBaseMeasure, DimensionalAttribute, DimensionalCalculatedMeasure, Jaql } from '@sisense/sdk-data';
 import { CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorDataOptions, StyledMeasureColumn, StyledColumn, CompleteThemeSettings } from '../types';
-import { Panel, PanelItem, Jaql, WidgetType } from './types';
+import { Panel, PanelItem, 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;

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

@@ -1,5 +1,5 @@
-import { Filter } from '@sisense/sdk-data';
-import { FilterJaql, Panel } from './types';
+import { Filter, FilterJaql } from '@sisense/sdk-data';
+import { Panel } from './types';
 /**
  * Extracts filter model components from a FilterJaql object.
  *
@@ -16,20 +16,8 @@ export declare function extractFilterModelFromJaql(jaql: FilterJaql): {
             members: string[];
         };
     };
-    backgroundFilter: import("./types").BackgroundFilter | ({
-        exclude: {
-            members: string[];
-        };
-    } & {
-        turnedOff: boolean;
-    }) | undefined;
-    turnOffMembersFilter: ({
-        exclude: {
-            members: string[];
-        };
-    } & {
-        turnedOff: boolean;
-    }) | undefined;
+    backgroundFilter: import("@sisense/sdk-data").BackgroundFilter | import("@sisense/sdk-data").TurnOffMembersFilter | undefined;
+    turnOffMembersFilter: import("@sisense/sdk-data").TurnOffMembersFilter | undefined;
 };
 /**
  * Creates a Filter from a FilterJaql object.

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

@@ -1,3 +1,4 @@
+import { Jaql, SortDirection } from '@sisense/sdk-data';
 export declare const enum WidgetType {
     PieChart = "chart/pie",
     ColumnChart = "chart/column",
@@ -51,64 +52,10 @@ export type FiltersIgnoringRules = {
     ids: string[];
     all: boolean;
 };
-export declare const enum DataType {
-    TEXT = "text",
-    NUMERIC = "numeric",
-    DATETIME = "datetime"
-}
 export type Panel = {
     name: string;
     items: PanelItem[];
 };
-export declare enum SortDirection {
-    ASC = "asc",
-    DESC = "desc"
-}
-export type BaseJaql = {
-    agg?: string;
-    datatype: DataType;
-    dim: string;
-    table: string;
-    column: string;
-    title: string;
-    level?: 'years' | 'quarters' | 'months' | 'weeks' | 'minutes' | 'days';
-    sort?: SortDirection;
-};
-type FormulaID = string;
-type FormulaContext = BaseJaql | FilterJaql;
-export type FormulaJaql = {
-    type?: 'measure';
-    sort?: SortDirection;
-    title: string;
-    formula: string;
-    context?: Record<FormulaID, FormulaContext>;
-};
-export type IncludeAllFilter = {
-    all: true;
-};
-export type IncludeMembersFilter = {
-    members: string[];
-};
-type ExcludeMembersFilter = {
-    exclude: {
-        members: string[];
-    };
-};
-export type MembersFilter = IncludeMembersFilter | ExcludeMembersFilter;
-type BaseFilter = IncludeAllFilter | MembersFilter;
-export type BackgroundFilter = BaseFilter & {
-    level?: 'string';
-};
-type TurnOffMembersFilter = ExcludeMembersFilter & {
-    turnedOff: boolean;
-};
-type Filter = BaseFilter & {
-    filter?: BackgroundFilter | TurnOffMembersFilter;
-};
-export type FilterJaql = BaseJaql & {
-    filter: Filter;
-};
-export type Jaql = BaseJaql | FormulaJaql | FilterJaql;
 type SeriesType = 'auto' | 'line' | 'spline' | 'areaspline' | 'bar' | 'area' | 'column';
 interface DecimalAbbreviations {
     k: boolean;

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

@@ -1,7 +1,7 @@
-import { type Filter } from '@sisense/sdk-data';
+import { type Filter, SortDirection as JaqlSortDirection } from '@sisense/sdk-data';
 import { ChartSubtype } from '../chart-options-processor/subtype-to-design-options';
 import { ChartType, SortDirection } from '../types';
-import { FiltersMergeStrategy, Panel, PanelItem, SortDirection as JaqlSortDirection, WidgetSubtype, WidgetType } from './types';
+import { FiltersMergeStrategy, Panel, PanelItem, WidgetSubtype, WidgetType } from './types';
 export declare function getChartType(widgetType: WidgetType): ChartType;
 export declare function getChartSubtype(widgetSubtype: WidgetSubtype): ChartSubtype | undefined;
 type WidgetTypeOrString = string | WidgetType;

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

@@ -4,3 +4,5 @@ export { BasicInput } from './basic-input';
 export { Input } from './input';
 export { Radio } from './radio';
 export { SisenseSwitchButton } from './switch';
+export { TriangleIndicator } from './triangle-indicator';
+export { DateRangeFieldButton } from './date-range-field-button';

package/dist/filters/components/common/triangle-indicator.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const TriangleIndicator: () => JSX.Element;

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

@@ -0,0 +1,25 @@
+import { FunctionComponent } from 'react';
+import { FilterOptionType } from './criteria-filter-operations.js';
+/**
+ * Props for {@link CriteriaFilterDisplay}
+ */
+export interface CriteriaFilterDisplayProps {
+    filterType: FilterOptionType;
+    values?: (number | string)[];
+}
+/**
+ * UI component that provides a static, uneditable display of the criteria filter values, to be shown when vertically aligned filter tiles are collapsed.
+ *
+ * @example
+ * ```tsx
+ * return (
+ *  <CriteriaFilterDisplay
+ *   filterType={FilterOption.BETWEEN}
+ *   values={[0, 100]}
+ *   />
+ * );
+ * ```
+ * @param props - Criteria filter menu props
+ * @returns Criteria filter menu component
+ */
+export declare const CriteriaFilterDisplay: FunctionComponent<CriteriaFilterDisplayProps>;

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

@@ -0,0 +1,20 @@
+import { FunctionComponent } from 'react';
+import { FilterOptionType, FilterVariant } from './criteria-filter-operations';
+/**
+ * Props for {@link CriteriaFilterMenu}
+ *
+ * @internal
+ */
+export interface CriteriaFilterMenuProps {
+    filterType: FilterOptionType;
+    arrangement?: FilterVariant;
+    defaultValues?: (number | string)[];
+    onUpdate?: (values: (number | string)[]) => void;
+    disabled?: boolean;
+}
+/**
+ * UI component that provides field(s) for the user to enter values for a numeric filter.
+ *
+ * @internal
+ */
+export declare const CriteriaFilterMenu: FunctionComponent<CriteriaFilterMenuProps>;

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

@@ -0,0 +1,62 @@
+/**
+ * Collection of filter options for the {@link CriteriaFilterMenu},
+ * to be provided to subcomponents as the `filterType` prop.
+ *
+ * @internal
+ */
+export declare const FilterOption: {
+    BETWEEN: string;
+    EQUALS: string;
+    NOT_EQUALS: string;
+    LESS_THAN: string;
+    LESS_THAN_OR_EQUAL: string;
+    GREATER_THAN: string;
+    GREATER_THAN_OR_EQUAL: string;
+    IS: string;
+    IS_NOT: string;
+    CONTAINS: string;
+    NOT_CONTAIN: string;
+    STARTS_WITH: string;
+    NOT_STARTS_WITH: string;
+    ENDS_WITH: string;
+    NOT_ENDS_WITH: string;
+    LIKE: string;
+};
+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,
+ * and the symbols to be displayed in the UI as field labels.
+ * Ranked indicates whether the filter is ranked (e.g. Top 10).
+ *
+ * @internal
+ */
+export type FilterInfo = {
+    fn: Function;
+    inputCount: number;
+    symbols: string[];
+    message: string;
+    ranked: boolean;
+    type: FilterInputType;
+};
+/**
+ * Map of {@link FilterOption} to {@link FilterInfo}
+ * for each type of filter available.
+ *
+ * @internal
+ */
+export declare const CRITERIA_FILTER_MAP: {
+    [key: string]: FilterInfo;
+};
+/**
+ * Determines whether the arrangement of the filter menu is vertical.
+ *
+ * @param arrangement - Arrangement of the filter menu
+ * @returns True if the arrangement is vertical, false otherwise
+ * @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";
+export declare const translatedMsgNoVal: (message: string, t: Function) => any;

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

@@ -0,0 +1,27 @@
+/// <reference types="react" />
+import { FilterVariant } from './criteria-filter-operations.js';
+import { Filter, NumericFilter, TextFilter } from '@sisense/sdk-data';
+/**
+ * Props for {@link CriteriaFilterTile}
+ */
+export interface CriteriaFilterTileProps {
+    /** Title for the filter tile, which is rendered into the header */
+    title: string;
+    /** Text or numeric filter object to initialize filter type and default values */
+    filter: CriteriaFilterType;
+    /** Arrangement of the filter inputs. Use vertical for standard filter tiles and horizontal for toolbars */
+    arrangement?: FilterVariant;
+    /** Callback returning filter object, or null for failure */
+    onUpdate: (filter: Filter | null) => void;
+}
+export type CriteriaFilterType = NumericFilter | TextFilter;
+/**
+ * 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}.
+ *
+ * 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.
+ *
+ * @param props - Criteria filter tile props
+ * @returns Criteria filter tile component
+ */
+export declare const CriteriaFilterTile: import("react").FunctionComponent<CriteriaFilterTileProps>;

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

@@ -0,0 +1,2 @@
+export { CriteriaFilterTile, type CriteriaFilterTileProps, type CriteriaFilterType, } from './criteria-filter-tile';
+export { type FilterVariant } from './criteria-filter-operations';

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

@@ -24,6 +24,10 @@ export type DateRangeFilterProps = {
         maxDate: string;
         minDate: string;
     };
+    /**
+     * Whether this is a dependent filter.
+     */
+    isDependent?: boolean;
 };
 /**
  * Date Filter component for filtering data by date range.

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

@@ -2,7 +2,7 @@
 import { LevelAttribute, DataSource, Filter } from '@sisense/sdk-data';
 export interface DateRangeFilterTileProps {
     /**
-     * Title of the filter tile
+     * Filter tile title
      */
     title: string;
     /**
@@ -20,11 +20,15 @@ export interface DateRangeFilterTileProps {
      */
     filter: Filter;
     /**
-     * Earliest valid date in date range select. If not specified a query will run.
+     * Earliest allowed date for selection.
+     *
+     * If not specified, the earliest date of the target date-level attribute will be used.
      */
     earliestDate?: string;
     /**
-     * Last valid date in date range select. If not specified a query will run.
+     * Latest allowed date for selection.
+     *
+     * If not specified, the latest date of the target date-level attribute will be used.
      */
     lastDate?: string;
     /**
@@ -33,6 +37,10 @@ export interface DateRangeFilterTileProps {
      * @param filter - Date range filter
      */
     onChange: (filter: Filter) => void;
+    /**
+     * List of filters this filter is dependent on.
+     */
+    parentFilters?: Filter[];
 }
 /**
  * Date Range Filter Tile component for filtering data by date range.

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

@@ -1,7 +1,7 @@
-import { DataSource, LevelAttribute } from '@sisense/sdk-data';
+import { DataSource, Filter, LevelAttribute } from '@sisense/sdk-data';
 type DateLimits = {
     minDate?: string;
     maxDate?: string;
 };
-export declare const useDateLimits: (userLimits: DateLimits, attribute: LevelAttribute, dataSource?: DataSource) => Required<DateLimits> | null;
+export declare const useDateLimits: (userLimits: DateLimits, attribute: LevelAttribute, dataSource?: DataSource, parentFilters?: Filter[]) => Required<DateLimits> | null;
 export {};

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

@@ -1,8 +1,11 @@
 import type { FunctionComponent, ReactNode } from 'react';
+import { FilterVariant } from './criteria-filter-tile/criteria-filter-operations';
 interface Props {
     title: string;
     renderContent: (collapsed: boolean, tileDisabled: boolean) => ReactNode;
+    arrangement?: FilterVariant;
     disabled?: boolean;
+    isDependent?: boolean;
     onToggleDisabled?: () => void;
 }
 /**

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

@@ -16,6 +16,8 @@ export interface BasicMemberFilterTileProps {
     onUpdateSelectedMembers?: (members: string[]) => void;
     /** Configurable limit on size of allowedMembers */
     maxAllowedMembers?: number;
+    /** Whether this is a dependent filter */
+    isDependent?: boolean;
 }
 /**
  * UI component that, given a list of members to select from and a list of

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

@@ -12,12 +12,14 @@ export interface MemberFilterTileProps {
      * 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 */
+    /** Attribute to filter on. A query will run to fetch all this attribute's members */
     attribute: Attribute;
     /** Source filter object. Caller is responsible for keeping track of filter state */
     filter: Filter | null;
     /** Callback indicating when the source member filter object should be updated */
     onChange: (filter: Filter | null) => void;
+    /** List of filters this filter is dependent on */
+    parentFilters?: Filter[];
 }
 /**
  * UI component that allows the user to select members to include/exclude in a

package/dist/filters/index.d.ts

@@ -1,2 +1,3 @@
 export * from './components/member-filter-tile';
 export * from './components/date-filter';
+export * from './components/criteria-filter-tile';

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

@@ -0,0 +1,16 @@
+import { ClientApplication } from '../app/client-application.js';
+import { DimensionalCalculatedMeasure } from '@sisense/sdk-data';
+/**
+ * Fetch a formula by oid from the default Sisense instance
+ *
+ * @param oid - Formula identifier in Sisense instance
+ * @param app - Client application
+ */
+export declare function fetchFormulaByOid(oid: string, app: ClientApplication): Promise<DimensionalCalculatedMeasure | null>;
+/**
+ * Fetch a shared formula by name and data source from the Sisense instance
+ *
+ * @param name - Formula name/title in Sisense instance
+ * @param dataSource - Data source in Sisense instance
+ */
+export declare function fetchFormula(name: string, dataSource: string, app: ClientApplication): Promise<DimensionalCalculatedMeasure | null>;

package/dist/formulas/index.d.ts

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