@sisense/sdk-ui 1.5.0 → 1.7.0

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

@@ -0,0 +1,105 @@
+import { MetadataItem } from '@sisense/sdk-query-client';
+import { AxesMapping, NlqResponseData } from '../../ai';
+import { ChartType, TableType } from '../../types';
+import { WidgetModel } from '../../models';
+/**
+ * Expanded Query Model that is based on NlqResponseData.
+ * It contains expanded JAQL and chart recommendations returned from the chat response.
+ *
+ * @internal
+ */
+export type ExpandedQueryModel = Pick<NlqResponseData, 'jaql' | 'chartRecommendations' | 'queryTitle'>;
+/**
+ * Expanded Query Model
+ *
+ * Used as a default value for ExpandedQueryModel
+ *
+ * @internal
+ */
+export declare const EMPTY_EXPANDED_QUERY_MODEL: ExpandedQueryModel;
+/**
+ * Simple Chart Recommendations
+ *
+ * @internal
+ */
+export interface SimpleChartRecommendations {
+    chartType: string;
+    dataOptions: AxesMapping;
+}
+/**
+ * Simple Query Model that is a simplified version of ExpandedQueryModel.
+ *
+ * It removes any JAQL syntax or information that already exists in the schema.
+ * Also, any parameters that have a default do not need to be specified.
+ *
+ * Users manipulates this model via the query in YAML format.
+ *
+ * ModelTranslator is responsible for translating this query model to SimpleWidgetModel.
+ *
+ * @internal
+ */
+export interface SimpleQueryModel {
+    /**
+     * The data model or perspective title.
+     */
+    model: string;
+    metadata: MetadataItem[];
+    chart: SimpleChartRecommendations | {};
+    /**
+     * Title of the query
+     */
+    queryTitle: string;
+}
+/**
+ * Empty Simple Query Model
+ *
+ * Used as a default value for SimpleQueryModel
+ *
+ * @internal
+ */
+export declare const EMPTY_SIMPLE_QUERY_MODEL: SimpleQueryModel;
+/**
+ * All Chart Types including Table
+ * Note: Table will be re-united with ChartType in a future MR
+ *
+ * @internal
+ */
+export type AllChartType = ChartType | TableType;
+/**
+ * Chart Widget Model
+ *
+ * This model serves two purposes:
+ *
+ * (1) For rendering a chart or table widget in the Query Composer.
+ * (2) For reverse engineered (translated) to CSDK code
+ *
+ * Naming TBD
+ *
+ * @internal
+ */
+export type ChartWidgetModel = Pick<WidgetModel, 'getChartWidgetProps' | 'getTableWidgetProps'> & {
+    chartType: AllChartType;
+    queryTitle: string;
+};
+/**
+ * UI Framework
+ *
+ * @internal
+ */
+export type UiFramework = 'react' | 'vue' | 'angular';
+/**
+ * Code Template Key
+ *
+ * @internal
+ */
+export type CodeTemplateKey = 'baseChartTmpl' | 'chartTmpl' | 'chartWidgetTmpl' | 'tableWidgetTmpl';
+/**
+ * Code Templates
+ *
+ * @internal
+ */
+export type CodeTemplates = {
+    [key in UiFramework]: {
+        [key in CodeTemplateKey]: string;
+    };
+};

package/dist/ai/translators/use-get-data-source.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Gets the fields of a data source.
+ *
+ * Alternative hook implementation of QueryApiDispatcher.getDataSourceFields
+ *
+ * @param dataSource - The data source to get the fields for
+ * @internal
+ */
+export declare const useGetDataSource: (dataSource: string | undefined) => {
+    data: import("@sisense/sdk-query-client").DataSourceField[] | undefined;
+    isLoading: boolean;
+};

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

@@ -0,0 +1,2 @@
+export declare function toKebabCase(str: string): string;
+export declare function capitalizeFirstLetter(str: string): string;

package/dist/ai/use-chat-session.d.ts

@@ -1,11 +1,19 @@
-import type { ChatMessage } from './api/types';
-interface UseChatSessionResult {
+import type { ChatMessage, NlqMessage, NlqResponseData } from './api/types';
+/**
+ * Result of the useChatSession hook.
+ *
+ * @internal
+ */
+export interface UseChatSessionResult {
     chatId: string | undefined;
     history: ChatMessage[];
+    lastNlqResponse: NlqResponseData | null;
     sendMessage: (message: string) => void;
     isAwaitingResponse: boolean;
     isLoading: boolean;
+    lastError: Error | null;
 }
+export declare const isNlqMessage: (message: ChatMessage | null | undefined) => message is NlqMessage;
 /**
  * React hook that returns a chat session object for the given data model or
  * perspective.
@@ -19,4 +27,3 @@ interface UseChatSessionResult {
  * @internal
  */
 export declare const useChatSession: (contextTitle: string) => UseChatSessionResult;
-export {};

package/dist/ai/use-get-nlg-query-result.d.ts

@@ -1,4 +1,4 @@
-import { Attribute, Filter, Measure } from '@sisense/sdk-data';
+import { Attribute, DataSource, Filter, FilterRelations, Measure } from '@sisense/sdk-data';
 import { GetNlgQueryResultRequest } from './api/types';
 import { GetNlgQueryResultProps } from './get-nlg-query-result';
 /**
@@ -6,13 +6,13 @@ import { GetNlgQueryResultProps } from './get-nlg-query-result';
  */
 export interface UseGetNlgQueryResultParams {
     /** The data source that the query targets - e.g. `Sample ECommerce` */
-    dataSource: string;
+    dataSource: DataSource;
     /** Dimensions of the query */
     dimensions?: Attribute[];
     /** Measures of the query */
     measures?: Measure[];
     /** Filters of the query */
-    filters?: Filter[];
+    filters?: Filter[] | FilterRelations;
     /**
      * Boolean flag to enable/disable API call by default
      *
@@ -42,9 +42,8 @@ export interface UseGetNlgQueryResultState {
  */
 export declare const useGetNlgQueryResultInternal: (params: GetNlgQueryResultProps | GetNlgQueryResultRequest, enabled?: boolean) => UseGetNlgQueryResultState;
 /**
- * React hook that fetches an analysis of the provided JAQL using natural language generation (NLG).
- *
- * Note that in the example below, this hook expects `metadata` to be in standard JAQL syntax.
+ * React hook that fetches an analysis of the provided query using natural language generation (NLG).
+ * Specifying a query is similar to providing parameters to a {@link useExecuteQuery} hook, using dimensions, measures, and filters.
  *
  * ::: warning Note
  * This hook is currently under private beta for selected customers and is subject to change as we make fixes and improvements.
@@ -66,6 +65,7 @@ export declare const useGetNlgQueryResultInternal: (params: GetNlgQueryResultPro
  * ```
  * @param params - {@link UseGetNlgQueryResultParams}
  * @returns Response object containing a text summary
+ * @group Generative AI
  * @beta
  */
 export declare const useGetNlgQueryResult: (params: UseGetNlgQueryResultParams) => UseGetNlgQueryResultState;

package/dist/ai/use-get-query-recommendations.d.ts

@@ -59,6 +59,7 @@ export declare const useGetQueryRecommendationsInternal: (params: UseGetQueryRec
  * ```
  * @param params - {@link UseGetQueryRecommendationsParams}
  * @returns An array of objects, each containing recommended question text and its corresponding JAQL
+ * @group Generative AI
  * @beta
  */
 export declare const useGetQueryRecommendations: (params: UseGetQueryRecommendationsParams) => UseGetQueryRecommendationsState;