@sisense/sdk-ui 0.13.0 → 0.15.0

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;
     /**
@@ -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;
     /**
@@ -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,9 +1,12 @@
 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;
-    disabled: boolean;
-    onToggleDisabled: () => void;
+    arrangement?: FilterVariant;
+    disabled?: boolean;
+    isDependent?: boolean;
+    onToggleDisabled?: () => void;
 }
 /**
  * Generic component that owns common functionality of a filter "tile" like

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

@@ -9,15 +9,17 @@ 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 */
+    /** 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';

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

@@ -0,0 +1,95 @@
+import { CalculatedMeasure } from '@sisense/sdk-data';
+import { UseGetSharedFormulaParams } from '../props.js';
+import { HookEnableParam } from '../common/hooks/types.js';
+/**
+ * Parameters for {@link useGetSharedFormula} hook.
+ */
+export interface GetSharedFormulaParams extends UseGetSharedFormulaParams, HookEnableParam {
+    /**
+     * Dashboard identifier
+     */
+    dashboardOid: string;
+}
+/**
+ * States of a shared formula load.
+ */
+export type SharedFormulaState = SharedFormulaLoadingState | SharedFormulaErrorState | SharedFormulaSuccessState;
+/**
+ * State of a shared formula loading.
+ */
+export type SharedFormulaLoadingState = {
+    /** Whether the shared formula is loading */
+    isLoading: true;
+    /** Whether the shared formula load has failed */
+    isError: false;
+    /** Whether the shared formula load has succeeded */
+    isSuccess: false;
+    /** The error if any occurred */
+    error: undefined;
+    /** The result shared formula if the load has succeeded */
+    formula: CalculatedMeasure | null;
+    /** The status of the shared formula load */
+    status: 'loading';
+};
+/**
+ * State of a shared formula load that has failed.
+ */
+export type SharedFormulaErrorState = {
+    /** Whether the shared formula is loading */
+    isLoading: false;
+    /** Whether the shared formula load has failed */
+    isError: true;
+    /** Whether the shared formula load has succeeded */
+    isSuccess: false;
+    /** The error if any occurred */
+    error: Error;
+    /** The result shared formula if the load has succeeded */
+    formula: undefined;
+    /** The status of the shared formula load */
+    status: 'error';
+};
+/**
+ * State of a shared formula load that has succeeded.
+ */
+export type SharedFormulaSuccessState = {
+    /** Whether the shared formula is loading */
+    isLoading: false;
+    /** Whether the shared formula load has failed */
+    isError: false;
+    /** Whether the shared formula load has succeeded */
+    isSuccess: true;
+    /** The error if any occurred */
+    error: undefined;
+    /** The result shared formula if the load has succeeded */
+    formula: CalculatedMeasure | null;
+    /** The status of the shared formula load */
+    status: 'success';
+};
+/**
+ * Fetch a [shared formula](https://docs.sisense.com/main/SisenseLinux/shared-formulas.htm) from the Sisense instance
+ *
+ * Formula can be identified either by `oid` or by name and data source pair
+ *
+ * When the retrieval is successful but the shared formula is not found, the result is altered from being `undefined` to `null`
+ *
+ * @example
+ * An example of retrieving a shared formula by oid:
+    ```tsx
+    const { formula, isLoading, isError } = useGetSharedFormula({ oid: 'd61c337b-fabc-4e9e-b4cc-a30116857153' })
+    ```
+ * @example
+ * An example of retrieving a shared formula by name and data source:
+    ```tsx
+    const { formula, isLoading, isError } = useGetSharedFormula({ name: 'My Shared Formula', datasource: DM.DataSource })
+    ```
+ * @param params - {@link UseGetSharedFormulaParams}
+ * @param dataSource - Data source in Sisense instance
+ * @returns Formula load state that contains the status of the execution, the result formula, or the error if any
+ */
+export declare const useGetSharedFormula: (params: UseGetSharedFormulaParams) => SharedFormulaState;
+/**
+ * {@link useGetSharedFormula} without tracking to be used inside other hooks or components in Compose SDK.
+ *
+ * @internal
+ */
+export declare function useGetSharedFormulaInternal(params: UseGetSharedFormulaParams): SharedFormulaState;

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>;

package/dist/index.d.ts

@@ -31,7 +31,8 @@ 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, } from './models';
+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 * from './props';
 export * from './types';
 export * from './filters';
+export * from './formulas';