@sisense/sdk-ui 1.8.0 → 1.10.0

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

@@ -1,137 +0,0 @@
-import { ExpandedQueryModel, SimpleQueryModel, SimpleChartRecommendations } from '../../ai/translators/types';
-import { DataSourceField, MetadataItem, MetadataItemJaql } from '@sisense/sdk-query-client';
-import { ChartRecommendations } from '../../ai';
-/**
- * A class that translates ExpandedQueryModel (Raw JAQL+Chart Recommendations)
- * to SimpleQueryModel (Simple JAQL+Simple Chart Options) and vice versa.
- *
- * It also provides methods to stringify query models to YAML strings
- * and parse YAML strings to query models.
- *
- * @internal
- */
-export declare class QueryTranslator {
-    private readonly contextTitle;
-    private readonly indexedFields;
-    /**
-     * Constructor for QueryTranslator.
-     *
-     * @param contextTitle - The context title
-     * @param fields - The data source fields
-     */
-    constructor(contextTitle: string, fields: DataSourceField[]);
-    private indexFields;
-    /**
-     * Concatenates Aggregation Types.
-     */
-    private concatAggTypes;
-    /**
-     * Simplifies Aggregation Formula defined in MetadataItemJaql returned from chat response.
-     *
-     * @param aggFormula - The Aggregation Formula to simplify
-     * @returns The equivalent measure
-     * @privateRemarks
-     * See unit tests for examples of aggregation formulas and their equivalent measures.
-     */
-    simplifyAggFormula(aggFormula: MetadataItemJaql): MetadataItemJaql;
-    /**
-     * Simplifies MetadataItemJaql.
-     *
-     * @param item - The MetadataItemJaql to simplify
-     * @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.
-     *
-     * @param item - The MetadataItem to simplify
-     * @returns The simplified MetadataItem
-     */
-    simplifyMetadataItem(item: MetadataItem): MetadataItem;
-    /**
-     * Simplifies Chart Recommendations.
-     *
-     * @param chartRecommendations - The Chart Recommendations to simplify
-     * @returns The simplified chart data options
-     */
-    simplifyChartRecommendations(chartRecommendations: ChartRecommendations | {}): SimpleChartRecommendations | {};
-    /**
-     * Returns the query title with the chart type.
-     *
-     * @param queryTitle - The query title
-     * @param chartRecommendations - The chart recommendations
-     * @returns The query title with the chart type
-     */
-    getQueryTitleWithChartType(queryTitle: string, chartRecommendations: {} | ChartRecommendations): string;
-    /**
-     * Takes a ExpandedQueryModel (e.g., from chat response) and translates it to SimpleQueryModel.
-     *
-     * @param expandedQueryModel - The Expanded Query model to simplify
-     * @returns The simplified query model
-     */
-    translateToSimple(expandedQueryModel: ExpandedQueryModel): SimpleQueryModel;
-    /**
-     * Stringifies a simple query model to YAML string.
-     *
-     * @param simpleQueryModel - The Simple Query model to convert
-     * @returns The YAML string representing the simple query model
-     */
-    stringifySimple(simpleQueryModel: SimpleQueryModel): string;
-    /**
-     * Parses a YAML string to Simple Query Model.
-     *
-     * @param simpleQueryYaml - The YAML string to parse
-     * @returns The Simple Query Model
-     */
-    parseSimple(simpleQueryYaml: string): SimpleQueryModel;
-    /**
-     * Derives chart family from chart type.
-     *
-     * @param chartType - chart type
-     * @returns chart family
-     */
-    private deriveChartFamily;
-    /**
-     * Expands Chart Recommendations.
-     *
-     * @param chartRecommendations - The Chart Recommendations to expand
-     * @returns The expanded chart recommendations
-     */
-    expandChartRecommendations(chartRecommendations: SimpleChartRecommendations | {}): ChartRecommendations | {};
-    /**
-     * Expands MetadataItemJaql by adding table, column, datatype, and title
-     * if they are missing from the item.
-     *
-     * @param item - The MetadataItemJaql to expand
-     * @returns The expanded MetadataItemJaql
-     */
-    expandMetadataItemJaql(item: MetadataItemJaql): MetadataItemJaql;
-    /**
-     * Expands MetadataItem
-     *
-     * @param item - The MetadataItem to expand
-     * @returns The expanded MetadataItem
-     */
-    expandMetadataItem(item: MetadataItem): MetadataItem;
-    /**
-     * Translates a Simple Query Model to Expanded Query Model.
-     *
-     * @param simpleQueryModel - The Simple Query model to convert
-     * @returns The Expanded Query Model
-     */
-    translateToExpanded(simpleQueryModel: SimpleQueryModel): ExpandedQueryModel;
-}

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

@@ -1,2 +0,0 @@
-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

@@ -1,8 +0,0 @@
-export type MembersFilterJaql = {
-    members: string[];
-};
-export type FromNotEqualFilterJaql = {
-    fromNotEqual: number;
-};
-export type FilterJaql = MembersFilterJaql | FromNotEqualFilterJaql;
-export declare const stringifyProps: (props: object | string, indent?: number, wrapInQuotes?: boolean) => string;

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

@@ -1,105 +0,0 @@
-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/utils.d.ts

@@ -1,12 +0,0 @@
-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;