@sisense/sdk-ui 1.7.2 → 1.9.0

package/dist/widgets/common/drilldown.d.ts

@@ -14,26 +14,7 @@ export declare const useDrilldown: (dataOptions: ChartDataOptions, drilldownOpti
     drilldownFilters: MembersFilter[];
     drilldownFiltersDisplayValues: string[][];
     drilldownDimension: Attribute;
-    dataOptionsWithDrilldown: {
-        category: (import("@sisense/sdk-data").Column | import("../../types").StyledColumn | undefined)[];
-        value: (import("@sisense/sdk-data").MeasureColumn | import("@sisense/sdk-data").CalculatedMeasureColumn | import("../../types").StyledMeasureColumn)[];
-        breakBy: (import("@sisense/sdk-data").Column | import("../../types").StyledColumn)[];
-        seriesToColorMap?: import("../../types").ValueToColorMap | undefined;
-    } | {
-        category: (import("@sisense/sdk-data").Column | import("../../types").StyledColumn | undefined)[];
-        value: (import("@sisense/sdk-data").MeasureColumn | import("@sisense/sdk-data").CalculatedMeasureColumn | import("../../types").StyledMeasureColumn)[];
-        seriesToColorMap?: import("../../types").ValueToColorMap | import("../../types").MultiColumnValueToColorMap | undefined;
-    } | {
-        category: (import("@sisense/sdk-data").Column | import("../../types").StyledColumn | undefined)[];
-        value: [import("@sisense/sdk-data").Column | import("../../types").StyledColumn];
-        boxType: import("../..").BoxWhiskerType;
-        outliersEnabled?: boolean | undefined;
-    } | {
-        category: (import("@sisense/sdk-data").Column | import("../../types").StyledColumn | undefined)[];
-        value: (import("@sisense/sdk-data").Column | import("@sisense/sdk-data").MeasureColumn | import("@sisense/sdk-data").CalculatedMeasureColumn | import("../../types").StyledMeasureColumn | import("../../types").StyledColumn)[];
-        outliers?: [import("@sisense/sdk-data").Column | import("../../types").StyledColumn] | undefined;
-        valueTitle: string;
-    };
+    dataOptionsWithDrilldown: ChartDataOptions;
     selectDrilldown: (points: DataPoint[], nextDimension: Attribute) => void;
     sliceDrilldownSelections: (i: number) => void;
     clearDrilldownSelections: () => void;

package/dist/widgets/common/widget-container.d.ts

@@ -0,0 +1,15 @@
+import { type ReactNode } from 'react';
+import { WidgetStyleOptions } from '../../types';
+interface WidgetContainerProps {
+    dataSetName?: string;
+    styleOptions?: WidgetStyleOptions;
+    title?: string;
+    description?: string;
+    topSlot?: ReactNode;
+    bottomSlot?: ReactNode;
+    children: ReactNode;
+    onRefresh?: () => void;
+}
+/** @internal */
+export declare const WidgetContainer: React.FC<WidgetContainerProps>;
+export {};

package/dist/widgets/drilldown-widget.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="react" />
 import { DrilldownWidgetProps } from '../props';
 /**
- * React component designed to add drilldown functionality to any type of chart
+ * React component designed to add drilldown functionality to any type of chart.
  *
- * It acts as a wrapper around a given chart component, enhancing it with drilldown capabilities
+ * This component acts as a wrapper around a given chart component, enhancing it with drilldown capabilities.
  *
  * The widget offers several features including:
  * - A context menu for initiating drilldown actions (can be provided as a custom component)
@@ -12,37 +12,25 @@ import { DrilldownWidgetProps } from '../props';
  * - Filters specifically created for drilldown operation
  * - An option to navigate to the next drilldown dimension
  *
- * When an `initialDimension` is specified, the `drilldownDimension` will automatically inherit its value,
- * even before any points on the chart are selected.
- * This allows for complete control over the chart's dimensions to be handed over to the DrilldownWidget
- *
- * @example
- * Example of using the `DrilldownWidget` component to
- * plot a custom React component that uses the `ExecuteQuery` component to
- * query the `Sample ECommerce` data source hosted in a Sisense instance.
- * ```tsx
- * <DrilldownWidget
- *   drilldownDimensions={[DM.Commerce.AgeRange, DM.Commerce.Gender, DM.Commerce.Condition]}
- *   initialDimension={DM.Category.Category}
- * >
- *   {({ drilldownFilters, drilldownDimension, onDataPointsSelected, onContextMenu }) => (
- *     <ExecuteQuery
- *       dataSource={DM.DataSource}
- *       dimensions={[drilldownDimension]}
- *       measures={measureFactory.sum(DM.Commerce.Revenue)}
- *       filters={drilldownFilters}
- *     >
- *       {({data}) => (
- *         <MyCustomChart
- *           rawData={data}
- *           onContextMenu={onContextMenu}
- *           onDataPointsSelected={onDataPointsSelected}
- *         />
- *       )}
- *     </ExecuteQuery>
- *   )}
- * </DrilldownWidget>
- * ```
+ * When an `initialDimension` is specified, the `drilldownDimension` will automatically inherit its
+ * value, even before any points on the chart are selected.
+ * This allows for complete control over the chart's dimensions to be handed over to the `DrilldownWidget`.
+ *
+ * ## Example
+ *
+ * A column chart displaying total revenue by category from the Sample ECommerce data model. The chart can be drilled down by age range, gender, and condition.
+ *
+ * <iframe
+ *  src='https://csdk-playground.sisense.com/?example=use-cases%2Fdrilldown&mode=docs'
+ *  width=800
+ *  height=870
+ *  style='border:none;'
+ * />
+ *
+ * Additional drilldown examples:
+ *
+ * - [Detached Breadcrumbs](https://www.sisense.com/platform/compose-sdk/playground/?example=use-cases%2Fdrilldown-detached-breadcrumbs)
+ *
  * @param props - DrilldownWidget properties
  * @returns DrilldownWidget wrapper component
  * @group Drilldown

package/dist/widgets/pivot-table-widget.d.ts

@@ -0,0 +1,22 @@
+import { type FunctionComponent } from 'react';
+import { PivotTableWidgetProps } from '../props';
+/**
+ * The PivotTableWidget component extending the PivotTable component to support widget style options.
+ *
+ * @example
+ * Example of using the `PivotTableWidget` component to
+ * plot a pivot table over the `Sample ECommerce` data source hosted in a Sisense instance.
+ * ```tsx
+ * <PivotTableWidget
+ *   dataSource={DM.DataSource}
+ *   dataOptions={{
+ *     rows: [DM.Category.Category],
+ *     values: [measureFactory.sum(DM.Commerce.Cost, 'Total Cost')]
+ *   }}
+ * />
+ * ```
+ * @param props - Pivot Table Widget properties
+ * @returns Widget component representing a pivot table
+ * @internal
+ */
+export declare const PivotTableWidget: FunctionComponent<PivotTableWidgetProps>;

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.7.2",
+  "version": "1.9.0",
   "type": "module",
   "exports": {
     ".": {
@@ -39,13 +39,14 @@
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
     "@mui/material": "^5.11.6",
-    "@sisense/sdk-common": "^1.7.2",
-    "@sisense/sdk-data": "^1.7.2",
-    "@sisense/sdk-pivot-client": "^1.7.2",
-    "@sisense/sdk-query-client": "^1.7.2",
-    "@sisense/sdk-rest-client": "^1.7.2",
-    "@sisense/sdk-tracking": "^1.7.2",
-    "@sisense/sisense-charts": "5.1.0-alpha-831b13b4.0",
+    "@mui/system": "^5.15.15",
+    "@sisense/sdk-common": "^1.9.0",
+    "@sisense/sdk-data": "^1.9.0",
+    "@sisense/sdk-pivot-client": "^1.9.0",
+    "@sisense/sdk-query-client": "^1.9.0",
+    "@sisense/sdk-rest-client": "^1.9.0",
+    "@sisense/sdk-tracking": "^1.9.0",
+    "@sisense/sisense-charts": "5.1.0-alpha-e8a83de6.0",
     "@tanstack/react-query": "4.36.1",
     "classnames": "^2.3.2",
     "colorjs.io": "^0.4.3",
@@ -138,7 +139,7 @@
     "storybook": "7.0.24",
     "tailwindcss": "^3.3.1",
     "typescript": "4.8.4",
-    "vite": "4.1.4",
+    "vite": "5.2.10",
     "vite-plugin-checker": "^0.6.1",
     "vite-plugin-css-injected-by-js": "3.0.1",
     "vite-plugin-dts": "^2.3.0",

package/dist/ai/chat-style-provider.d.ts

@@ -1,22 +0,0 @@
-import { ReactNode } from 'react';
-export interface ChatStyle {
-    backgroundColor?: string;
-    primaryTextColor?: string;
-    secondaryTextColor?: string;
-    messageBackgroundColor?: string;
-    inputBackgroundColor?: string;
-    border?: false | string;
-    suggestions?: {
-        textColor?: string;
-        border?: string;
-        hoverBackgroundColor?: string;
-        loadingGradient?: [string, string];
-    };
-    iconColor?: string;
-}
-export type ChatStyleProviderProps = {
-    children: ReactNode;
-    value: ChatStyle;
-};
-export declare const useChatStyle: () => ChatStyle;
-export declare const ChatStyleProvider: ({ children, value }: ChatStyleProviderProps) => JSX.Element;

package/dist/ai/icons/magic-wand-icon.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="react" />
-export default function MagicWandIcon(): JSX.Element;

package/dist/ai/magic-wand-dropdown.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="react" />
-export default function MagicWandDropdown({ questions, onSelection, isLoading, anchorEl, }: {
-    questions: string[];
-    onSelection: (question: string) => void;
-    isLoading: boolean;
-    anchorEl: Element | null;
-}): JSX.Element;

package/dist/ai/suggestions/suggestion-dropdown-item.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="react" />
-type SuggestionDropdownItemProps = {
-    onClick: () => void;
-    text: string;
-};
-export default function SuggestionDropdownItem(props: SuggestionDropdownItemProps): JSX.Element;
-export {};

package/dist/ai/suggestions/suggestion-dropdown-list.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="react" />
-export interface SuggestionDropdownListProps {
-    onSelect: (selection: string) => void;
-    suggestions: string[];
-    isLoading: boolean;
-}
-export default function SuggestionDropdownList(props: SuggestionDropdownListProps): JSX.Element;