@sisense/sdk-ui 1.6.0 → 1.7.0

package/dist/alert-box/alert-box.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 interface Props {
-    alerts: string[];
+    alerts?: string[];
 }
 export declare const AlertBox: ({ alerts }: Props) => JSX.Element;
 export default AlertBox;

package/dist/app/client-application.d.ts

@@ -28,6 +28,24 @@ export type AppConfig = {
      * Loading Indicator Configurations
      */
     loadingIndicatorConfig?: LoadingIndicatorConfig;
+    /**
+     * Query Cache Configurations
+     *
+     * This feature is in alpha.
+     */
+    queryCacheConfig?: {
+        /**
+         * Whether to enable query caching
+         *
+         * If not specified, the default value is `false`
+         */
+        enabled?: boolean;
+    };
+    /**
+     * Query limit (max rows count that will be fetched in query)
+     * @default 20000
+     */
+    queryLimit?: number;
 };
 /**
  * Stands for a Sisense Client Application which connects to a Sisense Environment
@@ -55,6 +73,15 @@ export declare class ClientApplication {
      * Gets the application settings
      */
     settings: AppSettings;
+    /**
+     * Gets the module to control query cache
+     */
+    queryCache: {
+        /**
+         * Clears the query cache
+         */
+        clear: () => void;
+    };
     /**
      * Construct new Sisense Client Application
      *

package/dist/app/settings/settings.d.ts

@@ -21,5 +21,5 @@ type ServerSettings = {
  * @param isWat - Whether the application is running with WAT authentication
  * @returns - Application settings
  */
-export declare function getSettings(customConfig: ConfigurableAppSettings, httpClient: Pick<HttpClient, 'get'>, useDefaultPalette: boolean): Promise<AppSettings>;
+export declare function getSettings(customConfig: ConfigurableAppSettings, httpClient: Pick<HttpClient, 'get'>, useDefaultPalette?: boolean): Promise<AppSettings>;
 export {};

package/dist/boxplot-utils.d.ts

@@ -1,5 +1,6 @@
 import { Attribute, Measure, Filter, QueryResultData, DataSource } from '@sisense/sdk-data';
 import { ClientApplication } from './app/client-application.js';
+import { executeQuery as executeQueryFunction } from './query/execute-query.js';
 import { BoxplotChartCustomDataOptions, BoxplotChartDataOptionsInternal } from './chart-data-options/types.js';
 /**
  * Processes box whisker data and outliers data to combine them into a single data set.
@@ -28,4 +29,4 @@ export declare const executeBoxplotQuery: ({ app, chartDataOptions, dataSource,
     measures: Measure[];
     filters?: Filter[] | undefined;
     highlights?: Filter[] | undefined;
-}) => Promise<QueryResultData>;
+}, executeQuery: typeof executeQueryFunction) => Promise<QueryResultData>;

package/dist/chart-options-processor/translations/base-design-options.d.ts

@@ -1,6 +1,7 @@
 import { DesignOptions } from './types';
 import { Merge } from '../../utils/utility-types';
 export declare const SERIES_CAPACITY = 50;
+export declare const PIE_SERIES_CAPACITY = 1000;
 export declare const SCATTER_CATEGORIES_CAPACITY = 500;
 export declare const CATEGORIES_CAPACITY = 100000;
 export declare const BaseDesignOptions: Merge<DesignOptions>;

package/dist/charts/indicator/indicator-legacy-chart-options/legacy-chart-options-to-theme-settings-dictionary.d.ts

@@ -9,4 +9,6 @@ export declare const legacyOptionsToThemeSettingsDictionary: {
     backgroundColor: string;
     'label.color': string;
     'secondaryTitle.color': string;
+    'secondaryValue.color': string;
+    'value.color': string;
 };

package/dist/charts/indicator/indicator-legacy-chart-options/override-with-value-color.d.ts

@@ -1,6 +1,5 @@
 import { IndicatorChartDataOptions, ConditionalDataColorOptions, DataColorOptions, UniformDataColorOptions } from '../../../types';
 import { LegacyIndicatorChartOptions } from '../types';
-import { IndicatorTypeOptions } from './indicator-legacy-chart-options';
 /**
  * Type that represents allowed color options for an indicator.
  */
@@ -25,7 +24,7 @@ export declare function getValueColorOptions(dataOptions: IndicatorChartDataOpti
  * @param typeOptions - Describe indicator type and subtype.
  * @returns The modified legacy indicator chart options.
  */
-export declare function overrideWithValueColor(colorOptions: DataColorOptions, value: number, legacyChartOptions: LegacyIndicatorChartOptions, typeOptions: IndicatorTypeOptions): LegacyIndicatorChartOptions;
+export declare function overrideWithValueColor(colorOptions: DataColorOptions, value: number, legacyChartOptions: LegacyIndicatorChartOptions): LegacyIndicatorChartOptions;
 /**
  * Checks if the color options are allowed for an indicator.
  *

package/dist/common/hooks/use-fetch.d.ts

@@ -0,0 +1,42 @@
+import { type UseQueryResult as TanstackUseQueryResult } from '@tanstack/react-query';
+/**
+ * Additional request configuration options for the `useFetch` hook.
+ */
+export type RequestConfig = {
+    /**
+     * Indicates that the request body is not a JSON object.
+     */
+    nonJSONBody?: boolean;
+    /**
+     * Indicates that the response should be treated as a Blob.
+     */
+    returnBlob?: boolean;
+};
+/**
+ * The result of the `useFetch` hook.
+ * Return value of the `useQuery` hook from `@tanstack/react-query`.
+ * @link https://tanstack.com/query/v4/docs/framework/react/reference/useQuery
+ *
+ * @template TData - The type of the data returned by the fetch request
+ * @template TError - The type of the error returned by the fetch request
+ */
+export type UseQueryResult<TData, TError> = TanstackUseQueryResult<TData, TError>;
+/**
+ * React hook that allows to make authorized fetch request to any Sisense API.
+ *
+ * @example
+ ```tsx
+  const { data, isLoading, error } = useFetch<unknown, Error>('api/v1/elasticubes/getElasticubes', {
+    method: 'POST',
+  });
+ ```
+ * @param path - The endpoint path to fetch data from. This should be a relative path like '/api/v1/endpoint'.
+ * @param init - The request init object
+ * @param options - The additional request options
+ * @returns Query state that contains the status of the query execution, the result data, or the error if any occurred
+ * @group Fusion Embed
+ */
+export declare const useFetch: <TData = unknown, TError = unknown>(path: string, init?: RequestInit | undefined, options?: {
+    requestConfig?: RequestConfig | undefined;
+    enabled?: boolean | undefined;
+} | undefined) => UseQueryResult<TData, TError>;

package/dist/const.d.ts

@@ -0,0 +1 @@
+export declare const QUERY_DEFAULT_LIMIT = 20000;

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

@@ -15,6 +15,7 @@ import { DashboardWidgetProps } from '../props';
  *   dashboardOid={'6441e728dac1920034bce737'}
  * />
  * ```
- * @group Fusion Assets
+ * @group Fusion Embed
+ * @fusionEmbed
  */
 export declare const DashboardWidget: FunctionComponent<DashboardWidgetProps>;

package/dist/dynamic-size-container/dynamic-size-container.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-type ContainerSize = {
+export type ContainerSize = {
     width: number;
     height: number;
 };
@@ -7,6 +7,8 @@ export type DynamicSizeContainerProps = {
     children: React.ReactNode | ((size: ContainerSize) => React.ReactNode);
     defaultSize: ContainerSize;
     size?: Partial<ContainerSize>;
+    rerenderOnResize?: boolean;
+    onSizeChange?: (size: ContainerSize) => void;
 };
 /**
  * A container component that adjusts its content size according to provided sizes
@@ -18,5 +20,4 @@ export type DynamicSizeContainerProps = {
  * @param {DynamicSizeContainerProps} props - DynamicSizeContainer properties.
  * @returns {JSX.Element} The DynamicSizeContainer component.
  */
-export declare const DynamicSizeContainer: ({ children, defaultSize, size, }: DynamicSizeContainerProps) => JSX.Element;
-export {};
+export declare const DynamicSizeContainer: ({ children, defaultSize, size, rerenderOnResize, onSizeChange, }: DynamicSizeContainerProps) => JSX.Element;

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

@@ -86,7 +86,8 @@ export type SharedFormulaSuccessState = {
  * @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
- * @group Fusion Assets
+ * @group Fusion Embed
+ * @fusionEmbed
  */
 export declare const useGetSharedFormula: (params: UseGetSharedFormulaParams) => SharedFormulaState;
 /**

package/dist/index.d.ts

@@ -46,3 +46,4 @@ export { createDataOptionsFromPanels } from './dashboard-widget/translate-widget
 export { createFilterFromJaql } from './dashboard-widget/translate-widget-filters';
 export { useThemeContext } from './theme-provider/theme-provider';
 export { LoadingIndicator } from './common/components/loading-indicator';
+export { useFetch, type RequestConfig, type UseQueryResult } from './common/hooks/use-fetch';