@sisense/sdk-ui 1.6.0 → 1.7.1

package/dist/models/dashboard/use-get-dashboard-model.d.ts

@@ -96,7 +96,8 @@ export type DashboardModelSuccessState = {
  ```
  * @param params - Parameters of the dashboard to be retrieved
  * @returns Dashboard load state that contains the status of the execution, the result dashboard model, or the error if any
- * @group Fusion Assets
+ * @group Fusion Embed
+ * @fusionEmbed
  */
 export declare const useGetDashboardModel: (params: GetDashboardModelParams) => DashboardModelState;
 /**

package/dist/models/dashboard/use-get-dashboard-models.d.ts

@@ -81,7 +81,8 @@ export type DashboardModelsSuccessState = {
  ```
  * @param params - Parameters of the dashboards to be retrieved
  * @returns Load state that contains the status of the execution, the result dashboards, or the error if any
- * @group Fusion Assets
+ * @group Fusion Embed
+ * @fusionEmbed
  */
 export declare const useGetDashboardModels: (params?: GetDashboardModelsParams | undefined) => DashboardModelsState;
 /**

package/dist/models/widget/use-get-widget-model.d.ts

@@ -93,7 +93,8 @@ export type WidgetModelSuccessState = {
  ```
  * @param params - Parameters of the widget to be retrieved
  * @returns Widget load state that contains the status of the execution, the result widget model, or the error if one has occurred
- * @group Fusion Assets
+ * @group Fusion Embed
+ * @fusionEmbed
  */
 export declare const useGetWidgetModel: (params: GetWidgetModelParams) => WidgetModelState;
 /**

package/dist/models/widget/widget-model.d.ts

@@ -11,7 +11,8 @@ export type WidgetDataOptions = ChartDataOptions | TableDataOptions;
 /**
  * Model of Sisense widget defined in the abstractions of Compose SDK.
  *
- * @group Fusion Assets
+ * @group Fusion Embed
+ * @fusionEmbed
  */
 export declare class WidgetModel {
     /**

package/dist/pivot-table/formatters/data-cell-formatters/data-cell-value-formatter.d.ts

@@ -0,0 +1,3 @@
+import { type PivotTableDataOptions } from '../../../chart-data-options/types.js';
+import { type DataCellFormatter } from '../types.js';
+export declare const createDataCellValueFormatter: (dataOptions: PivotTableDataOptions) => DataCellFormatter;

package/dist/pivot-table/formatters/data-cell-formatters/index.d.ts

@@ -0,0 +1 @@
+export { createDataCellValueFormatter } from './data-cell-value-formatter.js';

package/dist/pivot-table/formatters/header-cell-formatters/header-cell-value-formatter.d.ts

@@ -0,0 +1,3 @@
+import type { PivotTableDataOptions } from '../../../chart-data-options/types.js';
+import type { DateFormatter, HeaderCellFormatter } from '../types.js';
+export declare const createHeaderCellValueFormatter: (dataOptions: PivotTableDataOptions, dateFormatter: DateFormatter) => HeaderCellFormatter;

package/dist/pivot-table/formatters/header-cell-formatters/index.d.ts

@@ -0,0 +1 @@
+export { createHeaderCellValueFormatter } from './header-cell-value-formatter.js';

package/dist/pivot-table/formatters/index.d.ts

@@ -0,0 +1,2 @@
+export * from './data-cell-formatters';
+export * from './header-cell-formatters';

package/dist/pivot-table/formatters/types.d.ts

@@ -0,0 +1,4 @@
+import type { JaqlPanel, PivotDataNode, PivotTreeNode } from '@sisense/sdk-pivot-client';
+export type DataCellFormatter = (cell: PivotDataNode, rowItem: PivotTreeNode, columnItem: PivotTreeNode, jaqlPanelItem: JaqlPanel) => void;
+export type HeaderCellFormatter = (cell: PivotTreeNode, jaqlPanelItem: JaqlPanel) => void;
+export type DateFormatter = (date: Date, format: string) => string;

package/dist/pivot-table/formatters/utils.d.ts

@@ -0,0 +1,5 @@
+import { type Column } from '@sisense/sdk-data';
+import { type PivotTableDataOptions, type StyledColumn, type AnyColumn } from '../../chart-data-options/types';
+export declare const getPivotDataOptionByJaqlIndex: (dataOptions: PivotTableDataOptions, dataOptionIndex?: number) => AnyColumn | undefined;
+export declare const getNumberFormatConfig: (dataOption?: AnyColumn) => Required<import("../..").NumberFormatConfig>;
+export declare const getDateFormatConfig: (dataOption: Column | StyledColumn) => string;

package/dist/pivot-table/sorting-utils.d.ts

@@ -0,0 +1,56 @@
+/**
+ * This file contain sorting functionality ported from the existing Analytics.
+ * It directly works with pivot JAQL to apply sorting.
+ *
+ * It will be fully refactored soon by using a different approach of applying sorting on Pivot internal data options.
+ */
+import { JaqlRequest, type SortingSettingsChangePayload } from '@sisense/sdk-pivot-client';
+export declare function normalizeJaqlSorting(jaql: JaqlRequest): {
+    metadata: (import("@sisense/sdk-pivot-client").JaqlPanel | {
+        jaql: {
+            sortDetails: {
+                initialized: boolean;
+                field: any;
+                dir: any;
+                measurePath: null;
+                sortingLastDimension: any;
+            };
+            title: string;
+            dim: string;
+            datatype: string;
+            sort?: string | null | undefined;
+            type?: string | undefined;
+            table?: string | undefined;
+            column?: string | undefined;
+        };
+        panel: string;
+        field?: {
+            id?: string | undefined;
+            index?: number | undefined;
+        } | undefined;
+        disabled?: boolean | undefined;
+        hierarchies?: string[] | undefined;
+        format?: {
+            subtotal?: boolean | undefined;
+            width?: number | undefined;
+            databars?: boolean | undefined;
+            color?: {
+                type: string;
+                color?: string | undefined;
+                conditions?: {
+                    color: string;
+                    operator: string;
+                    expression: string | Record<string, any>;
+                }[] | undefined;
+            } | undefined;
+        } | undefined;
+    })[];
+    datasource?: import("@sisense/sdk-pivot-client/dist/data-load/types").JaqlDatasource | undefined;
+    queryGuid?: string | undefined;
+    grandTotals?: {
+        title: string;
+        columns?: boolean | undefined;
+        rows?: boolean | undefined;
+    } | null | undefined;
+};
+export declare function prepareSortedJaql(jaql: JaqlRequest, { type, settings, sortDetails, isSingleRowTree }: SortingSettingsChangePayload): JaqlRequest;

package/dist/pivot-table/use-apply-pivot-table-formatting.d.ts

@@ -0,0 +1,11 @@
+import { type DataService } from '@sisense/sdk-pivot-client';
+import { type PivotTableDataOptions } from '../chart-data-options/types';
+/**
+ * A hook that applies formatting over pivot table cells.
+ *
+ * @internal
+ */
+export declare const useApplyPivotTableFormatting: ({ dataService, dataOptions, }: {
+    dataService: DataService;
+    dataOptions: PivotTableDataOptions;
+}) => void;

package/dist/pivot-table/use-get-pivot-table-query.d.ts

@@ -1,5 +1,5 @@
 import { PivotTableProps } from '../props';
-import { JaqlRequest } from '@sisense/sdk-pivot-client';
+import { type JaqlRequest } from '@sisense/sdk-pivot-client';
 /**
  * A hook that returns the JAQL request object from pivot table props.
  *

package/dist/props.d.ts

@@ -4,9 +4,10 @@ import { HighchartsOptions } from './chart-options-processor/chart-options-servi
 import { ComponentType, PropsWithChildren, ReactNode } from 'react';
 import { IndicatorChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, ScatterChartDataOptions, TableDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, PivotTableDataOptions } from './chart-data-options/types';
 import { AppConfig } from './app/client-application';
-import { ExecuteQueryParams, QueryByWidgetIdState, QueryState } from './query-execution';
+import { ExecuteQueryParams, QueryByWidgetIdState } from './query-execution';
 import { FiltersMergeStrategy } from './dashboard-widget/types';
 import { HookEnableParam } from './common/hooks/types';
+import { ExecuteQueryResult } from './query-execution/types';
 export type { MenuItemSection, HighchartsOptions };
 /**
  * Configurations for Sisense Context
@@ -99,7 +100,7 @@ export interface ExecuteQueryProps {
     /** {@inheritDoc ExecuteQueryParams.offset} */
     offset?: number;
     /** Function as child component that is called to render the query results */
-    children?: (queryState: QueryState) => ReactNode;
+    children?: (queryResult: ExecuteQueryResult) => ReactNode;
     /** Callback function that is evaluated when query results are ready */
     onDataChanged?: (data: QueryResultData) => void;
     /** {@inheritDoc ExecuteQueryParams.onBeforeQuery} */

package/dist/query/execute-query.d.ts

@@ -1,3 +1,4 @@
+import { CreateCacheKeyFn } from '../utils/create-cache';
 import { Attribute, Measure, PivotAttribute, PivotMeasure, PivotQueryResultData, QueryResultData } from '@sisense/sdk-data';
 import type { QueryDescription as InternalQueryDescription, PivotQueryDescription as InternalPivotQueryDescription, QueryExecutionConfig } from '@sisense/sdk-query-client';
 import { ClientApplication } from '../app/client-application';
@@ -25,12 +26,11 @@ export type PivotQueryDescription = Partial<Omit<InternalPivotQueryDescription,
     values?: (Measure | PivotMeasure)[];
 };
 /** @internal */
-export declare const QUERY_DEFAULT_LIMIT = 20000;
-/** @internal */
-export declare const QUERY_DEFAULT_OFFSET = 0;
-/** @internal */
-export declare const executeQuery: (queryDescription: QueryDescription, app: ClientApplication, executionConfig?: QueryExecutionConfig) => Promise<QueryResultData>;
+export declare function executeQuery(queryDescription: QueryDescription, app: ClientApplication, executionConfig?: QueryExecutionConfig): Promise<QueryResultData>;
 /** @internal */
 export declare const executeCsvQuery: (queryDescription: QueryDescription, app: ClientApplication, executionConfig?: QueryExecutionConfig) => Promise<Blob>;
 /** @internal */
 export declare const executePivotQuery: (queryDescription: PivotQueryDescription, app: ClientApplication, executionConfig?: QueryExecutionConfig) => Promise<PivotQueryResultData>;
+export declare const createExecuteQueryCacheKey: CreateCacheKeyFn<typeof executeQuery>;
+export declare const executeQueryWithCache: typeof executeQuery;
+export declare const clearExecuteQueryCache: (specificKey?: string | undefined) => void;

package/dist/query-execution/execute-query-by-widget-id.d.ts

@@ -33,6 +33,7 @@ import { ExecuteQueryByWidgetIdProps } from '../props';
  * ```
  * @param props - ExecuteQueryByWidgetId properties
  * @returns ExecuteQueryByWidgetId component
- * @group Fusion Assets
+ * @group Fusion Embed
+ * @fusionEmbed
  */
 export declare const ExecuteQueryByWidgetId: FunctionComponent<ExecuteQueryByWidgetIdProps>;

package/dist/query-execution/index.d.ts

@@ -4,4 +4,5 @@ export { useExecuteCsvQuery } from './use-execute-csv-query';
 export { ExecuteQueryByWidgetId } from './execute-query-by-widget-id';
 export { useExecuteQueryByWidgetId, executeQueryByWidgetId, } from './use-execute-query-by-widget-id';
 export { useExecutePivotQuery } from './use-execute-pivot-query';
-export type { QueryState, QueryLoadingState, QuerySuccessState, QueryErrorState, CsvQueryState, CsvQueryLoadingState, CsvQuerySuccessState, CsvQueryErrorState, PivotQueryState, PivotQueryLoadingState, PivotQuerySuccessState, PivotQueryErrorState, ExecuteQueryParams, ExecuteCsvQueryParams, ExecuteCSVQueryConfig, ExecuteQueryByWidgetIdParams, QueryByWidgetIdState, ExecutePivotQueryParams, } from './types';
+export { useQueryCache } from './use-query-cache';
+export type { QueryState, QueryLoadingState, QuerySuccessState, QueryErrorState, CsvQueryState, CsvQueryLoadingState, CsvQuerySuccessState, CsvQueryErrorState, PivotQueryState, PivotQueryLoadingState, PivotQuerySuccessState, PivotQueryErrorState, ExecuteQueryParams, ExecuteQueryResult, ExecuteCsvQueryParams, ExecuteCSVQueryConfig, ExecuteQueryByWidgetIdParams, QueryByWidgetIdState, ExecutePivotQueryParams, } from './types';

package/dist/query-execution/query-params-comparator.d.ts

@@ -0,0 +1,8 @@
+import { ExecuteQueryParams } from '../index.js';
+/**
+ * Checks if the query parameters have changed by deep comparison.
+ *
+ * @param prevParams - Previous query parameters
+ * @param newParams - New query parameters
+ */
+export declare function isQueryParamsChanged(prevParams: ExecuteQueryParams | undefined, newParams: ExecuteQueryParams): boolean;

package/dist/query-execution/types.d.ts

@@ -207,6 +207,13 @@ export interface ExecuteQueryParams {
      */
     onBeforeQuery?: (jaql: any) => any | Promise<any>;
 }
+/**
+ * Result of a query execution.
+ */
+export type ExecuteQueryResult = QueryState & {
+    /** Function to refetch the query */
+    refetch: () => void;
+};
 /** Configuration for {@link useExecuteCsvQuery} hook. */
 export type ExecuteCSVQueryConfig = {
     /**

package/dist/query-execution/use-execute-query-by-widget-id.d.ts

@@ -28,7 +28,8 @@ import { ExecuteQueryByWidgetIdParams, QueryByWidgetIdState } from './types';
  * See also hook {@link useExecuteQuery}, which execute a query specified in code.
  * @param params - Parameters to identify the target widget
  * @returns Query state that contains the status of the query execution, the result data, the constructed query parameters, or the error if any occurred
- * @group Fusion Assets
+ * @group Fusion Embed
+ * @fusionEmbed
  */
 export declare const useExecuteQueryByWidgetId: (params: ExecuteQueryByWidgetIdParams) => QueryByWidgetIdState;
 /**

package/dist/query-execution/use-execute-query.d.ts

@@ -1,4 +1,4 @@
-import { ExecuteQueryParams, QueryState } from './types';
+import { ExecuteQueryParams, ExecuteQueryResult } from './types';
 /**
  * React hook that executes a data query.
  * This approach, which offers an alternative to {@link ExecuteQuery} component, is similar to React Query's `useQuery` hook.
@@ -31,17 +31,10 @@ import { ExecuteQueryParams, QueryState } from './types';
  * @returns Query state that contains the status of the query execution, the result data, or the error if any occurred
  * @group Queries
  */
-export declare const useExecuteQuery: (params: ExecuteQueryParams) => QueryState;
+export declare const useExecuteQuery: (params: ExecuteQueryParams) => ExecuteQueryResult;
 /**
  * {@link useExecuteQuery} without tracking to be used inside other hooks or components in Compose SDK.
  *
  * @internal
  */
-export declare function useExecuteQueryInternal(params: ExecuteQueryParams): QueryState;
-/**
- * Checks if the query parameters have changed by deep comparison.
- *
- * @param prevParams - Previous query parameters
- * @param newParams - New query parameters
- */
-export declare function isQueryParamsChanged(prevParams: ExecuteQueryParams | undefined, newParams: ExecuteQueryParams): boolean;
+export declare function useExecuteQueryInternal(params: ExecuteQueryParams): ExecuteQueryResult;

package/dist/query-execution/use-query-cache.d.ts

@@ -0,0 +1,10 @@
+/**
+ * React hook that returns the instance to manage query cache.
+ *
+ * @returns Query cache
+ * @group Queries
+ * @alpha
+ */
+export declare function useQueryCache(): {
+    clear: () => void;
+} | undefined;

package/dist/sisense-context/sisense-query-client-provider.d.ts

@@ -0,0 +1,2 @@
+import { PropsWithChildren, type FunctionComponent } from 'react';
+export declare const SisenseQueryClientProvider: FunctionComponent<PropsWithChildren>;