@sisense/sdk-ui 1.7.2 → 1.9.0

package/dist/ai/ai-disclaimer.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { CompleteThemeSettings } from '..';
+export default function AiDisclaimer({ theme }: {
+    theme: CompleteThemeSettings;
+}): JSX.Element;

package/dist/ai/chat-config.d.ts

@@ -13,6 +13,12 @@ export interface ChatConfig {
      * If not specified, the default value is `4`
      */
     numOfRecommendations: number;
+    /**
+     * Number of recent prompts that should be shown in a chat session
+     *
+     * If not specified, the default value is `5`
+     */
+    numOfRecentPrompts: number;
     /**
      * The default context (data model or perspective) title to use for a chat session
      *
@@ -27,6 +33,26 @@ export interface ChatConfig {
     chatMode?: ChatMode;
     /** The input prompt text to show in the chat input box */
     inputPromptText: string;
+    /**
+     * The welcome text to show at the top of a chat session.
+     *
+     * A value of `false` will hide the welcome text.
+     */
+    welcomeText?: string | false;
+    /**
+     * Boolean flag to show or hide the header in a chat session.
+     *
+     * @default true
+     * @internal
+     */
+    enableHeader?: boolean;
+    /**
+     * Boolean flag to show or hide the insights button in a chat session.
+     *
+     * @default true
+     * @internal
+     */
+    enableInsights?: boolean;
 }
 export declare const DEFAULTS: Readonly<ChatConfig>;
 export type ChatConfigProviderProps = {

package/dist/ai/chat-dropup.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+export declare const isCommand: (text: string) => boolean;
+interface ChatDropupProps {
+    recentPrompts: string[];
+    suggestions: string[];
+    isLoading: boolean;
+    onSelection: (q: string) => void;
+    anchorEl: HTMLElement | null;
+    text: string;
+}
+export default function ChatDropup({ recentPrompts, suggestions, isLoading, onSelection, anchorEl, text, }: ChatDropupProps): JSX.Element;
+export {};

package/dist/ai/chat-frame.d.ts

@@ -1,8 +1,11 @@
-import { CSSProperties, ReactNode } from 'react';
-type ChatFrameProps = {
+import { Themable } from '../theme-provider/types';
+import { CSSProperties } from 'react';
+type Sizable = {
     width?: CSSProperties['width'];
     height?: CSSProperties['height'];
-    children: ReactNode;
 };
-export default function ChatFrame({ width, height, children, }: ChatFrameProps): JSX.Element;
+export declare const ChatFrame: import("@emotion/styled").StyledComponent<{
+    theme?: import("@emotion/react").Theme | undefined;
+    as?: import("react").ElementType<any> | undefined;
+} & Themable & Sizable, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
 export {};

package/dist/ai/chat-input.d.ts

@@ -3,5 +3,8 @@ export type ChatInputProps = {
     onSendMessage: (message: string) => void;
     onClearHistoryClick?: () => void;
     disabled?: boolean;
+    recentPrompts: string[];
+    suggestions: string[];
+    isLoading: boolean;
 };
-export default function ChatInput({ onSendMessage, onClearHistoryClick, disabled, }: ChatInputProps): JSX.Element;
+export default function ChatInput({ onSendMessage, onClearHistoryClick, disabled, recentPrompts, suggestions, isLoading, }: ChatInputProps): JSX.Element;

package/dist/ai/chatbot.d.ts

@@ -1,6 +1,5 @@
 import { CSSProperties } from 'react';
 import { ChatConfig } from './chat-config';
-import { ChatStyle } from './chat-style-provider';
 /**
  * Props for {@link Chatbot} component.
  */
@@ -17,12 +16,6 @@ export type ChatbotProps = {
      * If not specified, a default height of `900px` will be used.
      */
     height?: CSSProperties['height'];
-    /**
-     * Style settings for the chatbot
-     *
-     * @internal
-     */
-    style?: ChatStyle;
     /**
      * Various configuration options for the chatbot
      */

package/dist/ai/common/dropup-section.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+export interface DropupSectionProps {
+    title: string;
+    items: string[];
+    onSelect: (selection: string) => void;
+    alwaysExpanded?: boolean;
+}
+export default function DropupSection({ title, items, onSelect, alwaysExpanded, }: DropupSectionProps): JSX.Element;

package/dist/ai/common/icon-button.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import { type IconButtonProps as MuiIconButtonProps } from '@mui/material/IconButton';
+import { CompleteThemeSettings } from '../../types';
+interface IconButtonProps extends MuiIconButtonProps {
+    $themeSettings?: CompleteThemeSettings;
+}
+declare const IconButton: import("@emotion/styled").StyledComponent<import("@mui/material/IconButton").IconButtonOwnProps & Omit<import("@mui/material").ButtonBaseOwnProps, "classes"> & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
+    ref?: ((instance: HTMLButtonElement | null) => void) | import("react").RefObject<HTMLButtonElement> | null | undefined;
+}, "style" | "children" | "disabled" | "size" | "className" | "tabIndex" | "color" | "action" | "classes" | "sx" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge"> & {
+    theme?: import("@emotion/react").Theme | undefined;
+} & IconButtonProps, {}, {}>;
+export default IconButton;

package/dist/ai/{toolbar.d.ts → common/toolbar.d.ts}

@@ -1,8 +1,13 @@
 import { ReactNode } from 'react';
+type ToolbarStyle = {
+    textColor: string;
+    backgroundColor: string;
+};
 export interface Props {
     title: string;
     leftNav: ReactNode;
     rightNav?: JSX.Element;
+    style: ToolbarStyle;
 }
 declare const _default: import("react").ForwardRefExoticComponent<Props & import("react").RefAttributes<HTMLDivElement>>;
 export default _default;

package/dist/ai/common/tooltip.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { type TooltipProps as MuiTooltipProps } from '@mui/material';
+import { type TooltipProps as MuiTooltipProps } from '@mui/material/Tooltip';
 type TooltipProps = Pick<MuiTooltipProps, 'title' | 'children'>;
 export default function Tooltip({ title, children }: TooltipProps): JSX.Element;
 export {};

package/dist/ai/icons/arrow-left-icon.d.ts

@@ -1,2 +1,6 @@
 /// <reference types="react" />
-export default function ArrowLeftIcon(): JSX.Element;
+type Colorable = {
+    color: string;
+};
+export default function ArrowLeftIcon({ color }: Colorable): JSX.Element;
+export {};

package/dist/ai/icons/clear-chat-icon.d.ts

@@ -1,2 +1,3 @@
 /// <reference types="react" />
-export default function ClearChatIcon(): JSX.Element;
+import { Themable } from '../../theme-provider/types';
+export default function ClearChatIcon({ theme }: Themable): JSX.Element;

package/dist/ai/icons/expand-icon.d.ts

@@ -1,2 +1,4 @@
 /// <reference types="react" />
-export default function ExpandIcon(): JSX.Element;
+export default function ExpandIcon({ fill }: {
+    fill?: string;
+}): JSX.Element;

package/dist/ai/icons/info-icon.d.ts

@@ -1,2 +1,4 @@
 /// <reference types="react" />
-export default function InfoIcon(): JSX.Element;
+export default function InfoIcon({ fill }: {
+    fill?: string;
+}): JSX.Element;

package/dist/ai/icons/light-bulb-icon.d.ts

@@ -1,2 +1,4 @@
 /// <reference types="react" />
-export default function LightBulbIcon(): JSX.Element;
+export default function LightBulbIcon({ hover }: {
+    hover?: boolean;
+}): JSX.Element;

package/dist/ai/icons/message-icon.d.ts

@@ -1,2 +1,3 @@
 /// <reference types="react" />
-export default function MessageIcon(): JSX.Element;
+import { Themable } from '../../theme-provider/types';
+export default function MessageIcon({ theme }: Themable): JSX.Element;

package/dist/ai/icons/sisense-logo.d.ts

@@ -1,2 +1,6 @@
 /// <reference types="react" />
-export default function SisenseLogo(): JSX.Element;
+type ColorSchema = 'yellow-white' | 'yellow-black';
+export default function SisenseLogo({ colorSchema }: {
+    colorSchema: ColorSchema;
+}): JSX.Element;
+export {};

package/dist/ai/icons/three-dots-icon.d.ts

@@ -1,2 +1,4 @@
 /// <reference types="react" />
-export default function ThreeDotsIcon(): JSX.Element;
+export default function ThreeDotsIcon({ fill }: {
+    fill?: string;
+}): JSX.Element;

package/dist/ai/icons/thumbs-down-hovered-icon.d.ts

@@ -1,2 +1,3 @@
 /// <reference types="react" />
-export default function ThumbsDownHoveredIcon(): JSX.Element;
+import { Themable } from '../../theme-provider/types';
+export default function ThumbsDownHoveredIcon({ theme }: Themable): JSX.Element;

package/dist/ai/icons/thumbs-down-icon.d.ts

@@ -1,2 +1,3 @@
 /// <reference types="react" />
-export default function ThumbsDownIcon(): JSX.Element;
+import { Themable } from '../../theme-provider/types';
+export default function ThumbsDownIcon({ theme }: Themable): JSX.Element;

package/dist/ai/icons/thumbs-up-hovered-icon.d.ts

@@ -1,2 +1,3 @@
 /// <reference types="react" />
-export default function ThumbsUpHoveredIcon(): JSX.Element;
+import { Themable } from '../../theme-provider/types';
+export default function ThumbsUpHoveredIcon({ theme }: Themable): JSX.Element;

package/dist/ai/icons/thumbs-up-icon.d.ts

@@ -1,2 +1,3 @@
 /// <reference types="react" />
-export default function ThumbsUpIcon(): JSX.Element;
+import { Themable } from '../../theme-provider/types';
+export default function ThumbsUpIcon({ theme }: Themable): JSX.Element;

package/dist/ai/messages/chat-welcome-message.d.ts

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

package/dist/ai/messages/clickable-message.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+type Props = {
+    children: string | JSX.Element;
+    align: 'left' | 'right';
+    onClick?: () => void;
+    disabled?: boolean;
+    onMouseEnter?: () => void;
+    onMouseLeave?: () => void;
+};
+export default function ClickableMessage({ children, align, onClick, disabled, onMouseEnter, onMouseLeave, }: Props): JSX.Element;
+export {};

package/dist/ai/messages/feedback-wrapper.d.ts

@@ -3,8 +3,8 @@ type FeedbackWrapperProps = {
     sourceId: string;
     data: object;
     type: string;
-    rightFooter?: ReactNode;
+    buttonVisibility?: 'onHover' | 'always' | 'never';
     children: ReactNode;
 };
-export default function FeedbackWrapper({ sourceId, data, type, rightFooter, children, }: FeedbackWrapperProps): JSX.Element;
+export default function FeedbackWrapper({ sourceId, data, type, buttonVisibility, children, }: FeedbackWrapperProps): JSX.Element;
 export {};

package/dist/ai/messages/insights-message.d.ts

@@ -1,12 +1,12 @@
 /// <reference types="react" />
+import { GetNlgQueryResultRequest } from '../api/types';
 export declare function InsightsButton({ onClick, disabled, }: {
     onClick?: () => void;
     disabled?: boolean;
 }): JSX.Element;
 type InsightsMessageProps = {
-    dataSource: string;
-    metadata: object[];
+    nlgRequest: GetNlgQueryResultRequest;
     visible?: boolean;
 };
-export default function InsightsMessage({ dataSource, metadata, visible, }: InsightsMessageProps): JSX.Element | null;
+export default function InsightsMessage({ nlgRequest, visible }: InsightsMessageProps): JSX.Element | null;
 export {};

package/dist/ai/messages/jaql-element.d.ts

@@ -1,4 +1,4 @@
-import { DimensionalElement } from '@sisense/sdk-data';
+import { DimensionalElement, SortDirection } from '@sisense/sdk-data';
 import { MetadataItem } from '@sisense/sdk-query-client';
 /**
  * This implementation wraps metadata for a JAQL query. The metadata could be
@@ -15,9 +15,12 @@ import { MetadataItem } from '@sisense/sdk-query-client';
  * @internal
  */
 export declare class JaqlElement extends DimensionalElement {
-    private metadataItem;
+    private readonly metadataItem;
     expression: string;
     skipValidation: boolean;
+    aggregation?: string;
+    formula?: string;
+    sortType?: SortDirection;
     constructor(item: MetadataItem, type: string);
     get id(): string;
     jaql(): MetadataItem;

package/dist/ai/messages/message-resolver.d.ts

@@ -2,7 +2,8 @@
 import { ChatMessage } from '../api/types';
 type MessageResolverProps = {
     message: ChatMessage;
+    isLastMessage?: boolean;
 };
-declare function MessageResolver({ message }: MessageResolverProps): JSX.Element;
+declare function MessageResolver({ message, isLastMessage }: MessageResolverProps): JSX.Element;
 declare const _default: import("react").MemoExoticComponent<typeof MessageResolver>;
 export default _default;

package/dist/ai/messages/nlq-message-group.d.ts

@@ -1,10 +1,13 @@
 /// <reference types="react" />
 import { NlqResponseData } from '../api/types';
+interface NlqMessageGroupProps {
+    data: NlqResponseData;
+    alwaysShowFeedback?: boolean;
+}
 /**
  * Renders a NLQ response as a series of chat messages/buttons.
  *
  * @internal
  */
-export default function NlqMessageGroup({ data }: {
-    data: NlqResponseData;
-}): JSX.Element;
+export default function NlqMessageGroup({ data, alwaysShowFeedback }: NlqMessageGroupProps): JSX.Element;
+export {};

package/dist/ai/messages/text-message.d.ts

@@ -1,8 +1,6 @@
-/// <reference types="react" />
-type Props = {
-    children: string | JSX.Element;
+import { FC, PropsWithChildren } from 'react';
+type Alignable = {
     align: 'left' | 'right' | 'full';
-    onClick?: () => void;
 };
-export default function TextMessage({ children, align, onClick }: Props): JSX.Element;
-export {};
+declare const TextMessage: FC<PropsWithChildren<Alignable>>;
+export default TextMessage;

package/dist/ai/nav-back-button.d.ts

@@ -1,6 +1,9 @@
 /// <reference types="react" />
-interface Props {
+type Colorable = {
+    color: string;
+};
+type Clickable = {
     onClick: () => void;
-}
-export default function NavBackButton({ onClick }: Props): JSX.Element;
+};
+export default function NavBackButton({ onClick, color }: Clickable & Colorable): JSX.Element;
 export {};

package/dist/ai/translators/model-translator.d.ts

@@ -18,6 +18,7 @@ export declare class ModelTranslator {
      * Gets filters from metadata.
      *
      * @param metadata - metadata items
+     * @return array of Filter objects
      */
     private getFilters;
     /**

package/dist/ai/translators/query-translator.d.ts

@@ -12,7 +12,7 @@ import { ChartRecommendations } from '../../ai';
  */
 export declare class QueryTranslator {
     private readonly contextTitle;
-    private indexedFields;
+    private readonly indexedFields;
     /**
      * Constructor for QueryTranslator.
      *
@@ -20,6 +20,7 @@ export declare class QueryTranslator {
      * @param fields - The data source fields
      */
     constructor(contextTitle: string, fields: DataSourceField[]);
+    private indexFields;
     /**
      * Concatenates Aggregation Types.
      */
@@ -40,6 +41,20 @@ export declare class QueryTranslator {
      * @returns The simplified MetadataItemJaql
      */
     simplifyMetadataItemJaql(item: MetadataItemJaql): MetadataItemJaql;
+    /**
+     * Simplify filter
+     *
+     * @param item - the MetadataItem
+     * @return the MetadataItem with simplified filter
+     */
+    simplifyMetadataItemFilter(item: MetadataItem): MetadataItem;
+    /**
+     * Simplify date and number format
+     *
+     * @param item - the MetadataItem
+     * @return the MetadataItem with simplified format
+     */
+    simplifyMetadataItemFormat(item: MetadataItem): MetadataItem;
     /**
      * Simplifies MetadataItem.
      *

package/dist/ai/translators/translate-filters-to-code.d.ts

@@ -0,0 +1,2 @@
+import { Filter } from '@sisense/sdk-data';
+export declare const stringifyFilterList: (filters: Filter[], indent?: number) => string;

package/dist/ai/translators/translate-props-to-code.d.ts

@@ -5,4 +5,4 @@ export type FromNotEqualFilterJaql = {
     fromNotEqual: number;
 };
 export type FilterJaql = MembersFilterJaql | FromNotEqualFilterJaql;
-export declare const stringifyProps: (props: object, indent?: number, wrapInQuotes?: boolean) => string;
+export declare const stringifyProps: (props: object | string, indent?: number, wrapInQuotes?: boolean) => string;

package/dist/ai/translators/utils.d.ts

@@ -1,2 +1,12 @@
+import { ExpandedQueryModel, SimpleQueryModel } from './types';
 export declare function toKebabCase(str: string): string;
 export declare function capitalizeFirstLetter(str: string): string;
+/**
+ * Sanitize ID of a dimension
+ *
+ * @param str - input string
+ * @return sanitized ID
+ */
+export declare function sanitizeDimensionId(str: string): string;
+export declare function validateQueryModel(model: any): SimpleQueryModel;
+export declare function isEmptyQueryModel(queryModel: ExpandedQueryModel | undefined | null): boolean;