@sisense/sdk-ui 1.15.1 → 1.17.0

package/dist/analytics-composer/index.d.ts

@@ -0,0 +1 @@
+export * from './translators';

package/dist/analytics-composer/translators/code-templates.d.ts

@@ -0,0 +1,11 @@
+import { CodeTemplates } from './types';
+/**
+ * Code templates for different UI frameworks.
+ *
+ * A code template is made up of other code templates and placeholders.
+ * This allows a code template to be reused in other code templates.
+ * For example, a chart widget template can be reused in a dashboard template.
+ *
+ * @internal
+ */
+export declare const CODE_TEMPLATES: CodeTemplates;

package/dist/analytics-composer/translators/generate-code.d.ts

@@ -0,0 +1,18 @@
+import { CodeTemplateKey, UiFramework } from './types';
+/**
+ * Populates placeholders in the given template with the given data.
+ * If a placeholder is not found in the data, a warning is logged.
+ *
+ * @param template - the template to populate
+ * @param data - the data to populate the template with
+ * @returns the populated template
+ */
+export declare const populatePlaceholders: (template: string, data: Record<string, string>) => string;
+/**
+ * Generates code from a template with the given data and UI framework.
+ *
+ * @param templateKey - the key of the template to use
+ * @param data - the data to populate the template with
+ * @param uiFramework - the UI framework for the generated code
+ */
+export declare const generateCode: (templateKey: CodeTemplateKey, data: Record<string, string>, uiFramework?: UiFramework) => string;

package/dist/analytics-composer/translators/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types';
+export { ModelTranslator } from './model-translator';
+export { QueryTranslator } from './query-translator';

package/dist/analytics-composer/translators/model-translator.d.ts

@@ -0,0 +1,48 @@
+import { ExpandedQueryModel, ChartWidgetModel, UiFramework } from './types.js';
+/**
+ * A class that translates expanded query model to CSDK chart model and code.
+ *
+ * @internal
+ */
+export declare class ModelTranslator {
+    queryModel: ExpandedQueryModel;
+    constructor(queryModel: ExpandedQueryModel);
+    /**
+     * Gets chart recommendations or default to table.
+     *
+     * @param chart - chart recommendations
+     * @returns chart recommendations or default to table
+     */
+    private getChartRecommendationsOrDefault;
+    /**
+     * Gets filters from metadata.
+     *
+     * @param metadata - metadata items
+     * @return array of Filter objects
+     */
+    private getFilters;
+    /**
+     * Splits metadata into columns and filters.
+     *
+     * @param metadata - metadata items
+     */
+    private splitMetadata;
+    /**
+     * Converts query model to chart
+     */
+    toChart(): ChartWidgetModel | undefined;
+    private stringifyDataSource;
+    private stringifyChartType;
+    private stringifyFilters;
+    private stringifyDataOptions;
+    private stringifyExtraImports;
+    private getChartWidgetCode;
+    /**
+     * Converts chart widget model to CSDK code.
+     *
+     * @param chartWidgetModel - chart widget model
+     * @param uiFramework - UI framework
+     * @returns CSDK code string of the UI framework
+     */
+    toCode(chartWidgetModel: ChartWidgetModel, uiFramework?: UiFramework): string;
+}

package/dist/analytics-composer/translators/query-templates.d.ts

@@ -0,0 +1 @@
+export declare const QUERY_TEMPLATE = "# This is your query - you can modify it directly and click Run to see new results.\n# Try uncommenting the elements below\n# To learn more about the query syntax, visit [Doc URL]\n---\nmodel: {{dataSourceTitle}}\n# metadata:\n#   - jaql:\n#       dim: \"[DimTable1.SomeTextColumn]\"\n#       title: Dimension1\n#   - jaql:\n#       dim: \"[Table2.SomeDateColumn]\"\n#       level: years\n#       title: Dimension2\n#     format:\n#       mask:\n#         years: yyyy\n#   - jaql:\n#       dim: \"[FactTable1.Column1]\"\n#       agg: sum\n#       title: Measure1\n#   - jaql:\n#       type: measure\n#       formula: (SUM([Column1]) - SUM([Column2])) / SUM([Column1])\n#       context:\n#         \"[Column1]\":\n#           dim: \"[FactTable1.Column1]\"\n#         \"[Column2]\":\n#           dim: \"[FactTable1.Column2]\"\n#       title: Measure2\n#   - jaql:\n#       dim: \"[FactTable1.Column1]\"\n#       filter:\n#         fromNotEqual: 1000\n#     panel: scope\n# chart:\n#   chartType: table\n#   dataOptions:\n#     columns:\n#       - name: Dimension1\n#       - name: Dimension2\n#       - name: Measure1\n#       - name: Measure2";

package/dist/analytics-composer/translators/query-translator.d.ts

@@ -0,0 +1,134 @@
+import { ExpandedQueryModel, SimpleQueryModel, SimpleChartRecommendations } from './types.js';
+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;
+    /**
+     * Returns the query template.
+     */
+    getQueryTemplate(): 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;
+    /**
+     * 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/analytics-composer/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/analytics-composer/translators/translate-props-to-code.d.ts

@@ -0,0 +1,8 @@
+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/analytics-composer/translators/types.d.ts

@@ -0,0 +1,95 @@
+import { MetadataItem } from '@sisense/sdk-query-client';
+import { AxesMapping, NlqResponseData } from '../../ai';
+import { ChartType, WidgetModel } from '../../';
+/**
+ * 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;
+/**
+ * Chart Widget Model
+ *
+ * This model serves two purposes:
+ *
+ * (1) For rendering a chart widget (including table) in the Query Composer.
+ * (2) For reverse engineered (translated) to CSDK code
+ *
+ * @internal
+ */
+export type ChartWidgetModel = Pick<WidgetModel, 'getChartWidgetProps'> & {
+    chartType: ChartType;
+    queryTitle: string;
+};
+/**
+ * UI Framework
+ *
+ * @internal
+ */
+export type UiFramework = 'react' | 'vue' | 'angular';
+/**
+ * Code Template Key
+ *
+ * @internal
+ */
+export type CodeTemplateKey = 'baseChartTmpl' | 'chartTmpl' | 'chartWidgetTmpl';
+/**
+ * Code Templates
+ *
+ * @internal
+ */
+export type CodeTemplates = {
+    [key in UiFramework]: {
+        [key in CodeTemplateKey]: string;
+    };
+};

package/dist/analytics-composer/translators/utils.d.ts

@@ -0,0 +1,13 @@
+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;
+export declare function escapeSingleQuotes(str?: string): string | undefined;