@sisense/sdk-ui 1.0.0 → 1.2.0

package/dist/props.d.ts

@@ -1,8 +1,8 @@
 import { Attribute, Filter, Measure, DataSource, Data, QueryResultData, FilterRelation } from '@sisense/sdk-data';
-import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, TableStyleOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, DashboardWidgetStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions } from './types';
+import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, TableStyleOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, DashboardWidgetStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions } from './types';
 import { HighchartsOptions } from './chart-options-processor/chart-options-service';
 import { ComponentType, PropsWithChildren, ReactNode } from 'react';
-import { IndicatorChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, ScatterChartDataOptions, TableDataOptions, ScattermapChartDataOptions } from './chart-data-options/types';
+import { IndicatorChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, ScatterChartDataOptions, TableDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions } from './chart-data-options/types';
 import { DataPointEventHandler, DataPointsEventHandler, ScatterDataPointEventHandler, ScatterDataPointsEventHandler } from './chart-options-processor/apply-event-handlers';
 import { AppConfig } from './app/client-application';
 import { ExecuteQueryParams, QueryByWidgetIdState, QueryState } from './query-execution';
@@ -823,6 +823,23 @@ export interface ScattermapChartProps extends BaseChartProps, ChartEventProps {
      */
     styleOptions?: ScattermapStyleOptions;
 }
+/**
+ * Props of the {@link AreamapChart} component.
+ */
+export interface AreamapChartProps extends BaseChartProps, ChartEventProps {
+    /**
+     * Configurations for how to interpret and present the data passed to the chart
+     *
+     * @category Chart
+     */
+    dataOptions: AreamapChartDataOptions;
+    /**
+     * Configuration that defines functional style of the various chart elements
+     *
+     * @category Chart
+     */
+    styleOptions?: AreamapStyleOptions;
+}
 /**
  * Props for {@link ContextMenu} component.
  */

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

@@ -1,5 +1,5 @@
-import { Attribute, QueryResultData } from '@sisense/sdk-data';
-import type { QueryDescription as InternalQueryDescription, QueryExecutionConfig } from '@sisense/sdk-query-client';
+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';
 /**
  * All the properties that fully describe a query you want to send.
@@ -11,6 +11,19 @@ import { ClientApplication } from '../app/client-application';
 export type QueryDescription = Partial<Omit<InternalQueryDescription, 'attributes'>> & {
     dimensions?: Attribute[];
 };
+/**
+ * All the properties that fully describe a pivot query you want to send.
+ *
+ * We use "dimensions" in public interface because the term is closer to the query and charting
+ * as used in the industry (Sisense included).
+ * internally, "dimensions" are represented by attributes as the latter is closer to the data model.
+ *
+ */
+export type PivotQueryDescription = Partial<Omit<InternalPivotQueryDescription, 'rowsAttributes' | 'columnsAttributes' | 'measures'>> & {
+    rows?: (Attribute | PivotAttribute)[];
+    columns?: (Attribute | PivotAttribute)[];
+    values?: (Measure | PivotMeasure)[];
+};
 /** @internal */
 export declare const QUERY_DEFAULT_LIMIT = 20000;
 /** @internal */
@@ -19,3 +32,5 @@ export declare const QUERY_DEFAULT_OFFSET = 0;
 export declare const 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>;

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

@@ -3,4 +3,5 @@ export { useExecuteQuery } from './use-execute-query';
 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 type { QueryState, QueryLoadingState, QuerySuccessState, QueryErrorState, CsvQueryState, CsvQueryLoadingState, CsvQuerySuccessState, CsvQueryErrorState, ExecuteQueryParams, ExecuteCsvQueryParams, ExecuteCSVQueryConfig, ExecuteQueryByWidgetIdParams, QueryByWidgetIdState, } from './types';
+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';

package/dist/query-execution/pivot-query-state-reducer.d.ts

@@ -0,0 +1,2 @@
+import { PivotQueryAction, PivotQueryState } from './types.js';
+export declare function pivotQueryStateReducer(state: PivotQueryState, action: PivotQueryAction): PivotQueryState;

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

@@ -1,4 +1,4 @@
-import { Attribute, DataSource, Filter, FilterRelation, Measure, QueryResultData } from '@sisense/sdk-data';
+import { Attribute, DataSource, Filter, FilterRelation, Measure, PivotAttribute, PivotGrandTotals, PivotMeasure, PivotQueryResultData, QueryResultData } from '@sisense/sdk-data';
 import { DataLoadAction } from '../common/hooks/data-load-state-reducer';
 import { FiltersMergeStrategy } from '../dashboard-widget/types';
 /**
@@ -190,3 +190,136 @@ export type ExecuteCSVQueryConfig = {
 export interface ExecuteCsvQueryParams extends ExecuteQueryParams {
     config?: ExecuteCSVQueryConfig;
 }
+/**
+ * State of a pivot query execution.
+ */
+export type PivotQueryState = PivotQueryLoadingState | PivotQueryErrorState | PivotQuerySuccessState;
+/**
+ * State of a query execution that is loading.
+ */
+export type PivotQueryLoadingState = {
+    /** Whether the query is loading */
+    isLoading: true;
+    /** Whether the query has failed */
+    isError: false;
+    /** Whether the query has succeeded */
+    isSuccess: false;
+    /** The error if any occurred */
+    error: undefined;
+    /** The result data if the query has succeeded */
+    data: PivotQueryResultData | undefined;
+    /** The status of the query execution */
+    status: 'loading';
+};
+/**
+ * State of a query execution that has failed.
+ */
+export type PivotQueryErrorState = {
+    /** Whether the query is loading */
+    isLoading: false;
+    /** Whether the query has failed */
+    isError: true;
+    /** Whether the query has succeeded */
+    isSuccess: false;
+    /** The error if any occurred */
+    error: Error;
+    /** The result data if the query has succeeded */
+    data: undefined;
+    /** The status of the query execution */
+    status: 'error';
+};
+/**
+ * State of a query execution that has succeeded.
+ */
+export type PivotQuerySuccessState = {
+    /** Whether the query is loading */
+    isLoading: false;
+    /** Whether the query has failed */
+    isError: false;
+    /** Whether the query has succeeded */
+    isSuccess: true;
+    /** The error if any occurred */
+    error: undefined;
+    /** The result data if the query has succeeded */
+    data: PivotQueryResultData;
+    /** The status of the query execution */
+    status: 'success';
+};
+export type PivotQueryAction = DataLoadAction<PivotQueryResultData>;
+/**
+ * Parameters for {@link useExecutePivotQuery} hook.
+ */
+export interface ExecutePivotQueryParams {
+    /**
+     * Data source the query is run against - e.g. `Sample ECommerce`
+     *
+     * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
+     *
+     * @category Data Options
+     */
+    dataSource?: DataSource;
+    /**
+     * Dimensions for the rows of the pivot table
+     *
+     * @category Data Options
+     */
+    rows?: (Attribute | PivotAttribute)[];
+    /**
+     * Dimensions for the columns of the pivot table
+     *
+     * @category Data Options
+     */
+    columns?: (Attribute | PivotAttribute)[];
+    /**
+     * Measures for the values of the pivot table
+     *
+     * @category Data Options
+     */
+    values?: (Measure | PivotMeasure)[];
+    /**
+     * Options for grand totals
+     *
+     * @category Data Options
+     */
+    grandTotals?: PivotGrandTotals;
+    /**
+     * Filters that will slice query results
+     *
+     * @category Filtering
+     */
+    filters?: Filter[] | FilterRelation;
+    /**
+     * Highlight filters that will highlight results that pass filter criteria
+     *
+     * @category Filtering
+     */
+    highlights?: Filter[];
+    /**
+     * {@inheritDoc ExecuteQueryProps.count}
+     *
+     * @category Pagination
+     *
+     * [To be reviewed for pivot table]
+     * @internal
+     */
+    count?: number;
+    /**
+     * {@inheritDoc ExecuteQueryProps.offset}
+     *
+     * @category Pagination
+     *
+     * [To be reviewed for pivot table]
+     * @internal
+     */
+    offset?: number;
+    /**
+     * Boolean flag to control if query is executed
+     *
+     * If not specified, the default value is `true`
+     *
+     * @category Control
+     */
+    enabled?: boolean;
+    /** {@inheritDoc ExecuteQueryProps.onBeforeQuery} */
+    onBeforeQuery?: (jaql: any) => any | Promise<any>;
+}

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

@@ -0,0 +1,54 @@
+import { ExecutePivotQueryParams, PivotQueryState } from './types';
+/**
+ * React hook that executes a data query for a pivot table.
+ * This approach is similar to React Query's `useQuery` hook.
+ *
+ * @example
+ * ```tsx
+ *   const { data, isLoading, isError } = useExecutePivotQuery({
+ *     dataSource: DM.DataSource,
+ *     rows: [
+ *       { attribute: DM.Category.Category, includeSubTotals: true },
+ *       { attribute: DM.Brand.Brand, includeSubTotals: true },
+ *       DM.Commerce.Condition,
+ *     ],
+ *     columns: [DM.Commerce.Gender],
+ *     values: [
+ *       { measure: measures.sum(DM.Commerce.Revenue, 'Total Revenue'), totalsCalculation: 'sum' },
+ *       { measure: measures.sum(DM.Commerce.Quantity, 'Total Quantity'), totalsCalculation: 'min' },
+ *     ],
+ *     grandTotals: {title: 'Grand Totals', rows: true, columns: true},
+ *     filters: [filters.members(DM.Commerce.Gender, ['Female', 'Male'])],
+ *   });
+ *   if (isLoading) {
+ *     return <div>Loading...</div>;
+ *   }
+ *   if (isError) {
+ *     return <div>Error</div>;
+ *   }
+ *   if (data) {
+ *     return <div>[Render pivot table with returned data]</div>;
+ *   }
+ *   return null;
+ *  ```
+ * See also hook {@link useExecuteQuery}, which execute a generic data query.
+ * @param params - Parameters of the query
+ * @returns Query state that contains the status of the query execution, the result data, or the error if any occurred
+ * @alpha
+ */
+export declare const useExecutePivotQuery: (params: ExecutePivotQueryParams) => PivotQueryState;
+/**
+ * {@link useExecutePivotQuery} without tracking to be used inside other hooks or components in Compose SDK.
+ *
+ * @internal
+ */
+export declare function useExecutePivotQueryInternal(params: ExecutePivotQueryParams): PivotQueryState;
+/**
+ * Checks if the query parameters have changed by deep comparison.
+ *
+ * TODO refactor to reuse isQueryParamsChanged
+ *
+ * @param prevParams - Previous query parameters
+ * @param newParams - New query parameters
+ */
+export declare function isPivotQueryParamsChanged(prevParams: ExecutePivotQueryParams | undefined, newParams: ExecutePivotQueryParams): boolean;

package/dist/scattermap-chart.d.ts

@@ -4,8 +4,6 @@ import { ScattermapChartProps } from './props';
  * A React component that allows to visualize geographical data as data points on a map.
  * See [Scattermap Chart](https://docs.sisense.com/main/SisenseLinux/scatter-map.htm) for more information.
  *
- * This component is still in beta.
- *
  * @example
  * An example of using the component to visualize the `Sample ECommerce` data source:
  * ```tsx