@sisense/sdk-ui 1.27.1 → 1.28.0

package/dist/packages/sdk-ui/src/ai/api/chat-rest-api.d.ts

@@ -1,12 +1,13 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
-import type { Chat, ChatRequest, ChatResponse, ChatWithoutHistory, ChatContext, GetNlgQueryResultRequest, GetNlgQueryResultResponse, LlmConfig, QueryRecommendationConfig, QueryRecommendationResponse, SendFeedbackRequest } from './types';
+import type { Chat, ChatRequest, ChatResponse, ChatWithoutHistory, ChatContext, GetNlgInsightsRequest, GetNlgInsightsResponse, LlmConfig, QueryRecommendationConfig, QueryRecommendationResponse, SendFeedbackRequest, GetNlqResultRequest, NlqResult } from './types';
 import { DataSourceField } from '@sisense/sdk-data';
 export declare class ChatRestApi {
     private httpClient;
     constructor(httpClient: HttpClient);
     getChatContexts: () => Promise<ChatContext[]>;
-    private getNlgQueryResult;
+    private getNlgInsights;
     private getQueryRecommendations;
+    private getNlqResult;
     private setLlmConfig;
     private getAllChats;
     private getChatById;
@@ -16,7 +17,8 @@ export declare class ChatRestApi {
     private sendFeedback;
     private getDataSourceFields;
     ai: {
-        getNlgQueryResult: (request: GetNlgQueryResultRequest) => Promise<GetNlgQueryResultResponse | undefined>;
+        getNlgInsights: (request: GetNlgInsightsRequest) => Promise<GetNlgInsightsResponse | undefined>;
+        getNlqResult: (contextTitle: string, request: GetNlqResultRequest) => Promise<NlqResult | undefined>;
         getQueryRecommendations: (contextTitle: string, config: QueryRecommendationConfig) => Promise<QueryRecommendationResponse | undefined>;
         setLlmConfig: (config: LlmConfig) => Promise<unknown>;
         sendFeedback: (request: SendFeedbackRequest) => Promise<unknown>;

package/dist/packages/sdk-ui/src/ai/api/hooks.d.ts

@@ -18,7 +18,7 @@ export declare const useGetAllChats: () => {
  * @internal
  */
 export declare const useMaybeCreateChat: (contextId: string | undefined, shouldCreate: boolean) => import("@tanstack/react-query").UseMutationResult<import("./types").Chat | undefined, unknown, void, unknown>;
-export declare const useSendChatMessage: (chatId: string | undefined) => {
+export declare const useSendChatMessage: (chatId: string | undefined, enableFollowupQuestions?: boolean) => {
     mutate: import("@tanstack/react-query").UseMutateFunction<ChatResponse | undefined, unknown, string, void>;
     isLoading: boolean;
 };

package/dist/packages/sdk-ui/src/ai/api/types.d.ts

@@ -73,17 +73,27 @@ export type ChatResponse = NlqResponse | TextResponse | ErrorResponse;
 export interface QueryRecommendationConfig {
     numOfRecommendations: number;
 }
+export type NlqResult = Omit<NlqResponseData, 'followupQuestions'>;
 export type QueryRecommendation = Omit<NlqResponseData, 'followupQuestions'>;
 export type QueryRecommendationResponse = QueryRecommendation[];
-export interface GetNlgQueryResultRequest {
+export interface GetNlgInsightsRequest {
     jaql: Pick<JaqlQueryPayload, 'datasource' | 'metadata' | 'filterRelations'>;
 }
-export interface GetNlgQueryResultResponse {
+export interface GetNlgInsightsResponse {
     data?: {
         answer: string;
     };
     responseType: 'Text';
 }
+/** @internal */
+export declare const NLQ_RESULT_CHART_TYPES: readonly ["indicator", "column", "line", "table", "pie", "bar"];
+/** NLQ result chart types @expandType */
+export type NlqResultChartType = (typeof NLQ_RESULT_CHART_TYPES)[number];
+export interface GetNlqResultRequest {
+    text: string;
+    timezone?: string;
+    chartTypes: NlqResultChartType[];
+}
 export interface SendFeedbackRequest {
     type: string;
     data: object;

package/dist/packages/sdk-ui/src/ai/chart/chart-insights.d.ts

@@ -1,6 +1,6 @@
-import { GetNlgQueryResultRequest } from '../../ai';
+import { GetNlgInsightsRequest } from '../../ai';
 export interface ChartInsightsProps {
     summary: string;
-    nlgRequest: GetNlgQueryResultRequest;
+    nlgRequest: GetNlgInsightsRequest;
 }
 export declare const ChartInsights: ({ summary, nlgRequest }: ChartInsightsProps) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/ai/{get-nlg-query-result.d.ts → get-nlg-insights.d.ts}

@@ -1,9 +1,9 @@
 /// <reference types="react" />
-import { UseGetNlgQueryResultParams } from './use-get-nlg-query-result';
+import { UseGetNlgInsightsParams } from './use-get-nlg-insights';
 /**
- * Props for {@link GetNlgQueryResult} component.
+ * Props for {@link GetNlgInsights} component.
  */
-export interface GetNlgQueryResultProps extends Omit<UseGetNlgQueryResultParams, 'enabled'> {
+export interface GetNlgInsightsProps extends Omit<UseGetNlgInsightsParams, 'enabled'> {
 }
 /**
  * React component that fetches and displays a collapsible analysis of the provided query using natural language generation (NLG).
@@ -15,16 +15,31 @@ export interface GetNlgQueryResultProps extends Omit<UseGetNlgQueryResultParams,
  *
  * @example
  * ```tsx
- * <GetNlgQueryResult
+ * <GetNlgInsights
  *   dataSource="Sample ECommerce"
  *   dimensions={[DM.Commerce.Date.Years]}
  *   measures={[measureFactory.sum(DM.Commerce.Revenue)]}
  * />
  * ```
- * @param props - {@link GetNlgQueryResultProps}
+ * @param props - {@link GetNlgInsightsProps}
  * @returns Collapsible container wrapping a text summary
  * @group Generative AI
  * @beta
  */
-declare const _default: import("react").FunctionComponent<GetNlgQueryResultProps>;
+declare const _default: import("react").FunctionComponent<GetNlgInsightsProps>;
 export default _default;
+/**
+ * Props for {@link GetNlgQueryResult} component.
+ * @deprecated Use {@link GetNlgInsightsProps} instead
+ * @internal
+ */
+export interface GetNlgQueryResultProps extends GetNlgInsightsProps {
+}
+/**
+ * @param props - {@link GetNlgQueryResultProps}
+ * @returns Collapsible container wrapping a text summary
+ * @group Generative AI
+ * @deprecated Use {@link GetNlgInsights} instead
+ * @internal
+ */
+export declare const GetNlgQueryResult: import("react").FunctionComponent<GetNlgQueryResultProps>;

package/dist/packages/sdk-ui/src/ai/index.d.ts

@@ -1,11 +1,12 @@
 export { default as AiContextProvider, type AiContextProviderProps } from './ai-context-provider';
 export { type ChatConfig } from './chat-config';
-export { useGetNlgQueryResult, type UseGetNlgQueryResultParams, type UseGetNlgQueryResultState, } from './use-get-nlg-query-result';
+export { useGetNlgInsights, type UseGetNlgInsightsParams, type UseGetNlgInsightsState, useGetNlgQueryResult, } from './use-get-nlg-insights';
+export { useGetNlqResult, type UseGetNlqResultParams, type UseGetNlqResultState, } from './use-get-nlq-result';
 export { useGetQueryRecommendations, type UseGetQueryRecommendationsParams, type UseGetQueryRecommendationsState, } from './use-get-query-recommendations';
 export { useChatSession, type UseChatSessionResult } from './use-chat-session';
 export { useLastNlqResponse } from './use-last-nlq-response';
 export { useGetDataSourceFields } from './use-get-data-source-fields';
-export type { GetNlgQueryResultRequest, QueryRecommendationResponse, QueryRecommendation, NlqResponseData, } from './api/types';
+export type { GetNlgInsightsRequest, QueryRecommendationResponse, QueryRecommendation, NlqResponseData, NlqResult, NLQ_RESULT_CHART_TYPES, NlqResultChartType, } from './api/types';
 export { Chatbot, type ChatbotProps } from './chatbot';
-export { default as GetNlgQueryResult, type GetNlgQueryResultProps } from './get-nlg-query-result';
+export { default as GetNlgInsights, type GetNlgInsightsProps, GetNlgQueryResult, type GetNlgQueryResultProps, } from './get-nlg-insights';
 export { NlqChartWidget, type NlqChartWidgetProps } from './chart/nlq-chart-widget';

package/dist/packages/sdk-ui/src/ai/messages/insights-message.d.ts

@@ -1,6 +1,6 @@
-import { GetNlgQueryResultRequest } from '../api/types';
+import { GetNlgInsightsRequest } from '../api/types';
 type InsightsMessageProps = {
-    nlgRequest: GetNlgQueryResultRequest;
+    nlgRequest: GetNlgInsightsRequest;
 };
 export default function InsightsMessage({ nlgRequest }: InsightsMessageProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/packages/sdk-ui/src/ai/{use-get-nlg-query-result.d.ts → use-get-nlg-insights.d.ts}

@@ -1,10 +1,10 @@
 import { Attribute, DataSource, Filter, FilterRelations, Measure } from '@sisense/sdk-data';
-import { GetNlgQueryResultRequest } from './api/types';
-import { GetNlgQueryResultProps } from './get-nlg-query-result';
+import { GetNlgInsightsRequest } from './api/types';
+import { GetNlgInsightsProps } from './get-nlg-insights';
 /**
- * Parameters for {@link useGetNlgQueryResult} hook.
+ * Parameters for {@link useGetNlgInsights} hook.
  */
-export interface UseGetNlgQueryResultParams {
+export interface UseGetNlgInsightsParams {
     /** The data source that the query targets - e.g. `Sample ECommerce` */
     dataSource: DataSource;
     /** Dimensions of the query */
@@ -21,9 +21,9 @@ export interface UseGetNlgQueryResultParams {
     enabled?: boolean;
 }
 /**
- * State for {@link useGetNlgQueryResult} hook.
+ * State for {@link useGetNlgInsights} hook.
  */
-export interface UseGetNlgQueryResultState {
+export interface UseGetNlgInsightsState {
     /** Whether the data fetching is loading */
     isLoading: boolean;
     /** Whether the data fetching has failed */
@@ -39,11 +39,11 @@ export interface UseGetNlgQueryResultState {
 }
 /**
  *
- * @param params - {@link UseGetNlgQueryResultParams}
+ * @param params - {@link UseGetNlgInsightsParams}
  * @param enabled - boolean flag to enable/disable this hook
  * @internal
  */
-export declare const useGetNlgQueryResultInternal: (params: GetNlgQueryResultProps | GetNlgQueryResultRequest, enabled?: boolean) => UseGetNlgQueryResultState;
+export declare const useGetNlgInsightsInternal: (params: GetNlgInsightsProps | GetNlgInsightsRequest, enabled?: boolean) => UseGetNlgInsightsState;
 /**
  * React hook that fetches an analysis of the provided query using natural language generation (NLG).
  * Specifying a query is similar to providing parameters to a {@link useExecuteQuery} hook, using dimensions, measures, and filters.
@@ -54,7 +54,7 @@ export declare const useGetNlgQueryResultInternal: (params: GetNlgQueryResultPro
  *
  * @example
  * ```tsx
- * const { data, isLoading } = useGetNlgQueryResult({
+ * const { data, isLoading } = useGetNlgInsights({
  *   dataSource: 'Sample ECommerce',
  *   dimensions: [DM.Commerce.Date.Years],
  *   measures: [measureFactory.sum(DM.Commerce.Revenue)],
@@ -70,4 +70,11 @@ export declare const useGetNlgQueryResultInternal: (params: GetNlgQueryResultPro
  * @group Generative AI
  * @beta
  */
-export declare const useGetNlgQueryResult: (params: UseGetNlgQueryResultParams) => UseGetNlgQueryResultState;
+export declare const useGetNlgInsights: (params: UseGetNlgInsightsParams) => UseGetNlgInsightsState;
+/**
+ * @returns Response object containing a text summary
+ * @group Generative AI
+ * @deprecated Use {@link useGetNlgInsights} instead
+ * @internal
+ */
+export declare const useGetNlgQueryResult: (params: UseGetNlgInsightsParams) => UseGetNlgInsightsState;

package/dist/packages/sdk-ui/src/ai/use-get-nlq-result.d.ts

@@ -0,0 +1,74 @@
+import { WidgetProps } from '../props';
+import { DataSource } from '@sisense/sdk-data';
+import { HookEnableParam } from '../common/hooks/types';
+import { NlqResultChartType } from './api/types';
+/**
+ * Parameters for {@link useGetNlqResult} hook.
+ */
+export interface UseGetNlqResultParams extends HookEnableParam {
+    /** Data source for queries to run against */
+    dataSource: DataSource;
+    /** Text containing the natural language query */
+    query: string;
+    /** Possible chart types to be used in NLQ results */
+    chartTypes?: NlqResultChartType[];
+    /**
+     * Enable suggested axis titles in generated widget
+     *
+     * If not specified, the default value is `false`
+     * @internal
+     */
+    enableAxisTitlesInWidgetProps?: boolean;
+}
+/**
+ * State for {@link useGetNlqResult} hook.
+ */
+export interface UseGetNlqResultState {
+    /** Whether the data fetching is loading */
+    isLoading: boolean;
+    /** Whether the data fetching has failed */
+    isError: boolean;
+    /** Whether the data fetching has succeeded */
+    isSuccess: boolean;
+    /** The result data */
+    data: WidgetProps | undefined;
+    /** The error if any occurred */
+    error: unknown;
+    /** Callback to trigger a refetch of the data */
+    refetch: () => void;
+}
+/**
+ * @param params - {@link UseGetNlqResultParams}
+ * @internal
+ */
+export declare const useGetNlqResultInternal: (params: UseGetNlqResultParams) => UseGetNlqResultState;
+/**
+ * React hook that enables natural language query (NLQ) against a data model or perspective.
+ *
+ * ::: warning Note
+ * This hook is currently under beta release for our managed cloud customers on version L2024.2 or above. It is subject to changes as we make fixes and improvements.
+ * :::
+ *
+ * @example
+ * ```tsx
+ * const { data, isLoading } = useGetNlqResult({
+ *    dataSource: 'Sample ECommerce',
+ *    query: 'Show me total revenue by age range'
+ * });
+ *
+ * if (isLoading) {
+ *   return <div>Loading...</div>;
+ * }
+ *
+ * return (
+ *   {
+ *      data &&
+ *      <Widget {...data} />
+ *   }
+ * );
+ * ```
+ * @returns NLQ load state that contains the status of the execution, the result (data) as WidgetProps
+ * @group Generative AI
+ * @beta
+ */
+export declare const useGetNlqResult: (params: UseGetNlqResultParams) => UseGetNlqResultState;

package/dist/packages/sdk-ui/src/ai/use-get-query-recommendations.d.ts

@@ -11,6 +11,13 @@ export interface UseGetQueryRecommendationsParams {
      * If not specified, the default value is `4`
      */
     count?: number;
+    /**
+     * Enable suggested axis titles in generated widget
+     *
+     * If not specified, the default value is `false`
+     * @internal
+     */
+    enableAxisTitlesInWidgetProps?: boolean;
 }
 /**
  * State for {@link useGetQueryRecommendations} hook.
@@ -61,7 +68,7 @@ export declare const useGetQueryRecommendationsInternal: (params: UseGetQueryRec
  *   </ul>
  * );
  * ```
- * @returns An array of objects, each containing recommended question text and its corresponding JAQL
+ * @returns An array of objects, each containing recommended question text and its corresponding `widgetProps`, as well as other variants of this information such as JAQL + chartMappings
  * @group Generative AI
  * @beta
  */

package/dist/packages/sdk-ui/src/analytics-composer/common/stringify-props.d.ts

@@ -2,4 +2,4 @@ import { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
 import { ChartDataOptions } from '../../types';
 export declare function stringifyDataOptions(dataOptions: ChartDataOptions): string;
 export declare function stringifyDataSource(dataSource: DataSource | undefined): string;
-export declare function stringifyExtraImports(filters: Filter[] | FilterRelations): string;
+export declare function stringifyExtraImports(filters: Filter[] | FilterRelations, importMeasureFactory?: boolean): string;

package/dist/packages/sdk-ui/src/analytics-composer/common/utils.d.ts

@@ -1,4 +1,6 @@
 import { ExpandedQueryModel, SimpleQueryModel } from '../types.js';
+import { ChartWidgetProps, PivotTableWidgetProps } from '../../props';
+import { ExecuteQueryParams, ExecutePivotQueryParams } from '../../query-execution';
 import { DynamicChartType } from '../../chart-options-processor/translations/types.js';
 export declare function toKebabCase(str: string): string;
 export declare function capitalizeFirstLetter(str: string): string;
@@ -13,3 +15,18 @@ export declare function validateQueryModel(model: any): SimpleQueryModel;
 export declare function isEmptyQueryModel(queryModel: ExpandedQueryModel | undefined | null): boolean;
 export declare function escapeSingleQuotes(str?: string): string | undefined;
 export declare function validateChartType(chartType: DynamicChartType | 'pivot' | 'pivot2'): void;
+export declare function checkIfMeasuresExist(props: ChartWidgetProps | PivotTableWidgetProps | ExecuteQueryParams | ExecutePivotQueryParams): boolean;
+export declare function isNonEmptyArray<T>(array: T[]): boolean;
+/**
+ * Removes the first empty line or string if the next line contains "import *" or "import {".
+ *
+ * The `stringifyExtraImports` function can return an empty string if there are no measures or filters, then
+ * `filterFactory` or `measureFactory` are not required for import.
+ * In our code templates, we use the `{{extraImportsString}}` placeholder, and
+ * if it is replaced with an empty string, our tests may break.
+ * This function ensures that such invalid empty lines before imports are removed to maintain proper formatting.
+ *
+ * @param input - the populated template
+ * @returns The modified string with the first empty line removed if the next line contains "import *" or "import {". If no such condition is met, the input remains unchanged.
+ */
+export declare function removeEmptyLineBeforeImport(input: string): string;

package/dist/packages/sdk-ui/src/analytics-composer/types.d.ts

@@ -1,8 +1,15 @@
-import { WidgetProps } from '../props';
+import { WidgetProps, ChartWidgetProps, PivotTableWidgetProps } from '../props';
 import { ChartDataOptions } from '../types';
 import { ExecuteQueryParams, ExecutePivotQueryParams } from '../query-execution';
 import { MetadataItem } from '@sisense/sdk-data';
 import { DynamicChartType } from '../chart-options-processor/translations/types.js';
+type Stringify<T> = {
+    [K in keyof T as `${K & string}String`]: string;
+};
+type ExtraCodeProps = {
+    componentString: string;
+    extraImportsString: string;
+};
 export type KeysOfUnion<T> = T extends T ? keyof T : never;
 export type AllPossibleChartOptionKeys = KeysOfUnion<ChartDataOptions>;
 export type AxesMappingKey = Exclude<AllPossibleChartOptionKeys, 'seriesToColorMap'>;
@@ -30,6 +37,7 @@ export interface ExpandedQueryModel {
         };
         metadata: MetadataItem[];
     };
+    widgetProps?: WidgetProps | undefined;
     queryTitle: string;
 }
 /**
@@ -164,3 +172,24 @@ export type ExecuteQueryCodeParams = BaseCodeConfig & {
 export type ExecutePivotQueryCodeParams = BaseCodeConfig & {
     pivotQueryParams: ExecutePivotQueryParams;
 };
+/**
+ * @internal
+ */
+export type ExecuteQueryCodeProps = Stringify<ExecuteQueryParams> & {
+    extraImportsString: string;
+};
+/**
+ * @internal
+ */
+export type ExecutePivotQueryCodeProps = Stringify<ExecutePivotQueryParams> & {
+    extraImportsString: string;
+};
+/**
+ * @internal
+ */
+export type ChartWidgetCodeProps = Stringify<ChartWidgetProps> & ExtraCodeProps;
+/**
+ * @internal
+ */
+export type PivotTableWidgetCodeProps = Stringify<PivotTableWidgetProps> & ExtraCodeProps;
+export {};

package/dist/packages/sdk-ui/src/filters/components/cascading-filter-tile/cascading-filter-tile.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { CascadingFilter, DataSource, Filter } from '@sisense/sdk-data';
+import { DataSource, Filter } from '@sisense/sdk-data';
 import { FilterVariant } from '../common/filter-utils.js';
 /**
  * Props for {@link CascadingFilterTile}
@@ -8,7 +8,7 @@ import { FilterVariant } from '../common/filter-utils.js';
  */
 export interface CascadingFilterTileProps {
     /** Cascading filter object to initialize filter type and default values */
-    filter: CascadingFilter;
+    filter: Filter;
     /**
      * Data source the query is run against - e.g. `Sample ECommerce`
      *

package/dist/packages/sdk-ui/src/filters/components/criteria-filter-tile/criteria-filter-tile.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { FilterTileDesignOptions } from '../filter-tile.js';
+import { FilterTileDesignOptions } from '../filter-tile-container.js';
 import { ExcludeFilter, Filter, Measure, NumericFilter, RankingFilter, TextFilter } from '@sisense/sdk-data';
 import { FilterVariant } from '../common/filter-utils.js';
 /**

package/dist/packages/sdk-ui/src/filters/components/custom-filter-tile.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import { Filter } from '@sisense/sdk-data';
-import { FilterTileDesignOptions } from './filter-tile';
+import { FilterTileDesignOptions } from './filter-tile-container';
 /**
  * Props for {@link CustomFilterTile}
  *

package/dist/packages/sdk-ui/src/filters/components/date-filter/date-range-filter-tile/date-range-filter-tile.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import { LevelAttribute, DataSource, Filter } from '@sisense/sdk-data';
-import { FilterTileDesignOptions } from '../../filter-tile';
+import { FilterTileDesignOptions } from '../../filter-tile-container';
 export interface DateRangeFilterTileProps {
     /**
      * Filter tile title

package/dist/packages/sdk-ui/src/filters/components/date-filter/relative-date-filter-tile/relative-date-filter-tile.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { Filter } from '@sisense/sdk-data';
 import { FilterVariant } from '../../common/index.js';
-import { FilterTileDesignOptions } from '../../filter-tile.js';
+import { FilterTileDesignOptions } from '../../filter-tile-container.js';
 /**
  * Props for {@link RelativeDateFilterTile}
  */

package/dist/packages/sdk-ui/src/filters/components/filter-tile-container.d.ts

@@ -0,0 +1,42 @@
+import type { FunctionComponent, ReactNode } from 'react';
+import { FilterVariant } from './common/filter-utils';
+import { DeepRequired } from 'ts-essentials';
+/**
+ * Design options for the filter tile component.
+ *
+ * @internal
+ */
+export interface FilterTileDesignOptions {
+    header?: {
+        shouldBeShown?: boolean;
+        isCollapsible?: boolean;
+        hasBorder?: boolean;
+        hasBackgroundFilterIcon?: boolean;
+    };
+    border?: {
+        shouldBeShown?: boolean;
+    };
+    footer?: {
+        shouldBeShown?: boolean;
+    };
+}
+export type CompleteFilterTileDesignOptions = DeepRequired<FilterTileDesignOptions>;
+interface FilterTileContainerProps {
+    title?: string;
+    renderContent: (collapsed: boolean, tileDisabled: boolean) => ReactNode;
+    arrangement?: FilterVariant;
+    disabled?: boolean;
+    isDependent?: boolean;
+    design?: FilterTileDesignOptions;
+    onToggleDisabled?: () => void;
+    onDelete?: () => void;
+    onEdit?: () => void;
+    locked?: boolean;
+}
+/**
+ * Generic component that owns common functionality of a filter "tile" like
+ * collapsible content and an enable/disable toggle. This is intended to match
+ * the style of filter tiles in the right sidebar on a Sisense dashboard.
+ */
+export declare const FilterTileContainer: FunctionComponent<FilterTileContainerProps>;
+export {};

package/dist/packages/sdk-ui/src/filters/components/filter-tile.d.ts

@@ -1,42 +1,26 @@
-import type { FunctionComponent, ReactNode } from 'react';
-import { FilterVariant } from './common/filter-utils';
-import { DeepRequired } from 'ts-essentials';
+/// <reference types="react" />
+import { DataSource, Filter } from '@sisense/sdk-data';
 /**
- * Design options for the filter tile component.
+ * Props of the {@link FilterTile} component
  *
- * @internal
  */
-export interface FilterTileDesignOptions {
-    header?: {
-        shouldBeShown?: boolean;
-        isCollapsible?: boolean;
-        hasBorder?: boolean;
-        hasBackgroundFilterIcon?: boolean;
-    };
-    border?: {
-        shouldBeShown?: boolean;
-    };
-    footer?: {
-        shouldBeShown?: boolean;
-    };
-}
-export type CompleteFilterTileDesignOptions = DeepRequired<FilterTileDesignOptions>;
-interface Props {
-    title?: string;
-    renderContent: (collapsed: boolean, tileDisabled: boolean) => ReactNode;
-    arrangement?: FilterVariant;
-    disabled?: boolean;
-    isDependent?: boolean;
-    design?: FilterTileDesignOptions;
-    onToggleDisabled?: () => void;
+export type FilterTileProps = {
+    /** Filter to display */
+    filter: Filter;
+    /** Callback to handle filter change */
+    onChange: (filter: Filter | null) => void;
+    /** Filter delete callback */
     onDelete?: () => void;
+    /** Filter edit callback */
     onEdit?: () => void;
-    locked?: boolean;
-}
+    /** Default data source used for filter tiles */
+    defaultDataSource?: DataSource;
+};
 /**
- * Generic component that owns common functionality of a filter "tile" like
- * collapsible content and an enable/disable toggle. This is intended to match
- * the style of filter tiles in the right sidebar on a Sisense dashboard.
+ * Facade component that renders a filter tile based on filter type
+ *
+ * @group Filter Tiles
+ * @shortDescription Facade component rendering a filter tile based on filter type
+ * @beta
  */
-export declare const FilterTile: FunctionComponent<Props>;
-export {};
+export declare const FilterTile: React.FC<FilterTileProps>;

package/dist/packages/sdk-ui/src/filters/components/filters-panel/index.d.ts

@@ -1,2 +1 @@
 export { FiltersPanel, type FiltersPanelProps } from './filters-panel';
-export { FiltersPanelTile } from './filters-panel-tile';

package/dist/packages/sdk-ui/src/filters/components/index.d.ts

@@ -0,0 +1,7 @@
+export * from './member-filter-tile';
+export * from './date-filter';
+export * from './criteria-filter-tile';
+export * from './cascading-filter-tile';
+export * from './filters-panel';
+export * from './custom-filter-tile';
+export * from './filter-tile';

package/dist/packages/sdk-ui/src/filters/components/member-filter-tile/index.d.ts

@@ -1,3 +1,3 @@
 export { MemberFilterTile, type MemberFilterTileProps } from './member-filter-tile';
 export { BasicMemberFilterTile, type BasicMemberFilterTileProps } from './basic-member-filter-tile';
-export type { Member } from './members-reducer';
+export type { Member, SelectedMember } from './members-reducer';

package/dist/packages/sdk-ui/src/filters/components/member-filter-tile/member-filter-tile.d.ts

@@ -1,6 +1,6 @@
 import { Attribute, DataSource, Filter } from '@sisense/sdk-data';
 import { FunctionComponent } from 'react';
-import { FilterTileDesignOptions } from '../filter-tile';
+import { FilterTileDesignOptions } from '../filter-tile-container';
 /**
  * Props for {@link MemberFilterTile}
  */
@@ -17,7 +17,7 @@ export interface MemberFilterTileProps {
     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 */
+    /** Callback indicating when the source members filter should be updated */
     onChange: (filter: Filter | null) => void;
     /** Filter delete callback */
     onDelete?: () => void;

package/dist/packages/sdk-ui/src/filters/components/member-filter-tile/members-reducer.d.ts

@@ -1,8 +1,15 @@
 export interface Member {
+    /** Key of the member */
     key: string;
+    /** Title of the member */
     title: string;
 }
 export interface SelectedMember extends Member {
+    /**
+     * Boolean flag whether the member is inactive
+     *
+     * If not specified, the default value is `false`
+     */
     inactive?: boolean;
 }
 type MembersState = {

package/dist/packages/sdk-ui/src/filters/components/unsupported-filter-tile.d.ts

@@ -1,4 +1,4 @@
-import { FilterTileDesignOptions } from '../../filters/components/filter-tile';
+import { FilterTileDesignOptions } from '../../filters/components/filter-tile-container';
 import { Filter } from '@sisense/sdk-data';
 export type UnsupportedFilterTileProps = {
     filter: Filter;

package/dist/packages/sdk-ui/src/filters/hooks/index.d.ts

@@ -0,0 +1 @@
+export { useGetFilterMembers, type GetFilterMembersParams, type GetFilterMembersResult, type GetFilterMembersSuccess, type GetFilterMembersError, } from './use-get-filter-members';