@sisense/sdk-ui 1.27.0 → 1.28.0

package/dist/packages/sdk-ui/src/filters/hooks/use-get-filter-members.d.ts

@@ -0,0 +1,77 @@
+import { DataSource, Filter } from '@sisense/sdk-data';
+import { Member, SelectedMember } from '../components/member-filter-tile';
+/**
+ * Params for {@link useGetFilterMembers}
+ */
+export interface GetFilterMembersParams {
+    /** Provided members filter */
+    filter: Filter;
+    /** Default data source to use if filter does not have one */
+    defaultDataSource?: DataSource;
+    /** List of filters this filter is dependent on */
+    parentFilters?: Filter[];
+}
+export interface GetFilterMembersSuccess {
+    /** Whether the data fetching is loading */
+    isLoading: boolean;
+    /** Whether the data fetching has failed */
+    isError: false;
+    /** The error if any occurred */
+    error: undefined;
+    /** The result data */
+    data: {
+        selectedMembers: SelectedMember[];
+        allMembers: Member[];
+        excludeMembers: boolean;
+        enableMultiSelection: boolean;
+        hasBackgroundFilter: boolean;
+    };
+}
+export interface GetFilterMembersError {
+    /** Whether the data fetching is loading */
+    isLoading: false;
+    /** Whether the data fetching has failed */
+    error: Error;
+    /** The error if any occurred */
+    isError: true;
+    /** The result data */
+    data: undefined;
+}
+/**
+ * State for {@link useGetFilterMembers} hook.
+ */
+export type GetFilterMembersResult = GetFilterMembersError | GetFilterMembersSuccess;
+/**
+ * {@link useGetFilterMembers} without tracking to be used inside other hooks or components in Compose SDK.
+ *
+ * @param params - Parameters of the query
+ * @internal
+ */
+export declare const useGetFilterMembersInternal: ({ filter, defaultDataSource, parentFilters, }: GetFilterMembersParams) => GetFilterMembersResult;
+/**
+ * Hook that fetches members of the provided filter
+ *
+ * Those members can be used to display a list of members in a third-party filter component such as Material UI Select.
+ *
+ * * ## Example
+ *
+ * Retrieve selected members from a Filter on Country of the Sample ECommerce data model.
+ *
+ * ```tsx
+ * const {
+ *   isLoading,
+ *   data: { selectedMembers, allMembers, excludeMembers, enableMultiSelection },
+ * } = useGetFilterMembers({ filter: filterFactory.members(DM.Country.Country, ['United States', 'Canada']) });
+ *
+ * if (isLoading) {
+ *   return <div>Loading...</div>;
+ * }
+ * console.log('selectedMembers', selectedMembers);
+ * ```
+ *
+ * @returns Results that contains the status of the filter query execution, the result data, or the error if any occurred
+ * @shortDescription Hook to fetch members of a filter
+ * @group Filter Tiles
+ * @beta
+ */
+export declare const useGetFilterMembers: (args_0: GetFilterMembersParams) => GetFilterMembersResult;

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

@@ -1,8 +1,4 @@
-export * from './components/member-filter-tile';
-export * from './components/date-filter';
-export * from './components/criteria-filter-tile';
-export * from './components/cascading-filter-tile';
-export * from './components/filters-panel';
-export * from './components/custom-filter-tile';
+export * from './components';
+export * from './hooks';
 export * from './helpers';
 export { type FilterVariant } from './components/common/filter-utils';

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

@@ -45,7 +45,7 @@ export { usePlugins } from './plugins-provider/plugins-provider';
 export { extractDimensionsAndMeasures, useExecutePluginQuery, } from './plugins-provider/use-execute-plugin-query';
 export { getThemeSettingsByOid } from './themes/theme-loader';
 export { getDefaultThemeSettings } from './theme-provider/default-theme-settings';
-export { useGetDashboardModel, useGetDashboardModels, useDashboardModel, getDashboardModel, getDashboardModels, useGetWidgetModel, getWidgetModel, translateToDashboardResponse, translateToDashboardsResponse, useGetHierarchyModels, getHierarchyModels, 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, type WidgetsPanelColumnLayout as WidgetsPanelColumnLayout, type WidgetsPanelLayout as WidgetsPanelLayout, type WidgetId, type WidgetsOptions, type CommonFiltersOptions, type CommonFiltersApplyMode, type FiltersIgnoringRules, type HierarchyModel, type Hierarchy, type HierarchyId, type GetHierarchyModelsParams, type HierarchyModelsState, type HierarchyModelsLoadingState, type HierarchyModelsErrorState, type HierarchyModelsSuccessState, UseDashboardModelActionType, } from './models';
+export { useGetDashboardModel, useGetDashboardModels, useDashboardModel, getDashboardModel, getDashboardModels, useGetWidgetModel, getWidgetModel, translateToDashboardResponse, translateToDashboardsResponse, useGetHierarchyModels, getHierarchyModels, 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, type WidgetsPanelColumnLayout, type WidgetsPanelLayout, type WidgetId, type WidgetsOptions, type CommonFiltersOptions, type CommonFiltersApplyMode, type FiltersIgnoringRules, type HierarchyModel, type Hierarchy, type HierarchyId, type GetHierarchyModelsParams, type HierarchyModelsState, type HierarchyModelsLoadingState, type HierarchyModelsErrorState, type HierarchyModelsSuccessState, UseDashboardModelActionType, } from './models';
 /**
  * Utility functions to translate a Fusion widget model from and to other widget data structures
  *

package/dist/packages/sdk-ui/src/models/widget/widget-model-translator.d.ts

@@ -152,6 +152,14 @@ export declare function fromWidgetDto(widgetDto: WidgetDto, themeSettings?: Comp
  * @internal
  */
 export declare function fromChartWidgetProps(chartWidgetProps: ChartWidgetProps): WidgetModel;
+/**
+ * Creates a {@link WidgetModel} from a {@link WidgetProps}.
+ *
+ * @param widgetProps - The WidgetProps to be converted to a widget model
+ * @returns WidgetModel
+ * @internal
+ */
+export declare function fromWidgetProps(widgetProps: WidgetProps): WidgetModel;
 /**
  * Data source as specified in the jaql
  * but with required filelds
@@ -160,7 +168,7 @@ export declare function fromChartWidgetProps(chartWidgetProps: ChartWidgetProps)
  */
 export type JaqlDataSourceForWidgetDto = JaqlDataSource & {
     id: string;
-    address: string;
+    address?: string;
 };
 /**
  * Translates a {@link WidgetModel} to {@link WidgetDto}.

package/dist/packages/sdk-ui/src/query/date-formats/apply-date-format.d.ts

@@ -61,5 +61,5 @@ export declare const defaultDateConfig: DateConfig;
  * @param cfg -
  */
 export declare function applyDateFormat(date: Date, format: DateFormat, locale?: Locale, cfg?: DateConfig): string;
-export declare function getDefaultDateMask(granularity?: string): "HH:mm:ss" | "yyyy" | "MM/yyyy" | "ww yyyy" | "HH:mm" | "shortDate" | "fullDate" | "Q yyyy";
+export declare function getDefaultDateMask(granularity?: string): "HH:mm:ss" | "yyyy" | "MM/yyyy" | "ww yyyy" | "HH:mm" | "Q yyyy" | "shortDate" | "fullDate";
 export {};