@thoughtspot/ts-chart-sdk 0.0.2-alpha.2 → 0.0.2-alpha.20

package/src/types/answer-column.types.ts

@@ -1,7 +1,23 @@
+import type { Maybe } from './common.types';
+import { ConditionalFormatting } from './conditional-formatting.types';
+import { FormatConfig } from './number-formatting.types';
+
 export enum ColumnType {
     UNKNOWN,
     MEASURE,
     ATTRIBUTE,
+    // Virtual columns that are measure name/value columns
+    VIRTUAL,
+}
+
+/**
+ * When the column is generated for the chart for creating views,
+ * on top of measure columns from the worksheet which are part of answer query.
+ */
+export enum ChartSpecificColumnType {
+    UNKNOWN,
+    MEASURE_NAMES,
+    MEASURE_VALUES,
 }
 
 /**
@@ -71,6 +87,51 @@ export enum CurrencyFormatType {
     ISO_CODE,
 }
 
+/**
+ * Type of aggregations applied on the column data
+ *
+ * @version SDK: 0.1 | ThoughtSpot:
+ */
+export enum ColumnAggregationType {
+    AGGREGATE,
+    AGGREGATE_DISTINCT,
+    APPROX_AGGR_DISTINCT,
+    APPROX_AGGR_DISTINCT_MERGE,
+    APPROX_COUNT_DISTINCT,
+    AVERAGE,
+    COUNT,
+    COUNT_DISTINCT,
+    CUMULATIVE_AVERAGE,
+    CUMULATIVE_COUNT,
+    CUMULATIVE_MAX,
+    CUMULATIVE_MIN,
+    CUMULATIVE_SUM,
+    GROWTH,
+    MAX,
+    MEDIAN,
+    MIN,
+    MOVING_AVERAGE,
+    MOVING_COUNT,
+    MOVING_MAX,
+    MOVING_MIN,
+    MOVING_SUM,
+    NONE,
+    PERCENTILE,
+    RANK,
+    RANK_PERCENTILE,
+    SQL_BOOL_AGGREGATE_OP,
+    SQL_DATE_AGGREGATE_OP,
+    SQL_DATE_TIME_AGGREGATE_OP,
+    SQL_DOUBLE_AGGREGATE_OP,
+    SQL_INT_AGGREGATE_OP,
+    SQL_STRING_AGGREGATE_OP,
+    SQL_TIME_AGGREGATE_OP,
+    STD_DEVIATION,
+    SUM,
+    TABLE_AGGR,
+    VARIANCE,
+}
+
 /**
  * Currency format for the column defined in the worksheet
  *
@@ -124,7 +185,7 @@ export interface ChartColumn {
      */
     id: string;
     /**
-     * Column name
+     * Column name property
      *
      * @version SDK: 0.1 | ThoughtSpot:
      */
@@ -171,4 +232,44 @@ export interface ChartColumn {
      * @version SDK: 0.1 | ThoughtSpot:
      */
     format?: ColumnFormat;
+
+    /**
+     * Column Properties of the columns
+     *
+     * @version SDK: 0.0.2-alpha.15 | ThoughtSpot:
+     */
+    columnProperties?: {
+        conditionalFormatting?: Maybe<ConditionalFormatting>;
+        numberFormatting?: Maybe<FormatConfig>;
+    };
+
+    /**
+     * Aggregation applied on the column data
+     *
+     * @version SDK: 0.1 | ThoughtSpot:
+     */
+    aggregationType?: ColumnAggregationType;
+
+    /**
+     * Custom sort order defined for the column to sort charts in a specific order
+     * Defined in worksheet
+     *
+     * @version SDK: 0.1 | ThoughtSpot:
+     */
+    customOrder?: Array<string>;
+
+    /**
+     * Guid of Custom calender for the column if defined in worksheet else null
+     *
+     * @version SDK: 0.1 | ThoughtSpot: sdcwdc
+     */
+    calenderGuid?: string;
+
+    /**
+     * Type of arbitrary column, can be measure names or measure values
+     * also, unknown if regular column
+     *
+     * @version SDK: 0.1 | ThoughtSpot:
+     */
+    chartSpecificColumnType: ChartSpecificColumnType;
 }

package/src/types/chart-to-ts-event.types.ts

@@ -25,6 +25,7 @@ export enum ChartToTSEvent {
     /**
      * Render life cycle events
      */
+    InitStart = 'InitStart',
     RenderStart = 'RenderStart',
     RenderError = 'RenderError',
     RenderComplete = 'RenderComplete',
@@ -72,6 +73,12 @@ export interface ChartToTSEventsPayloadMap {
      */
     [ChartToTSEvent.CloseContextMenu]: [];
 
+    /**
+     * Trigger to notify the Initialization start
+     *
+     * @version SDK: 0.2 | ThoughtSpot:
+     */
+    [ChartToTSEvent.InitStart]: [];
     /**
      * Trigger to notify the render start
      *

package/src/types/common.types.ts

@@ -7,6 +7,48 @@
  */
 
 import { ChartColumn } from './answer-column.types';
+import type { ChartConfigEditorDefinition } from './configurator.types';
+import type { VisualPropEditorDefinition } from './visual-prop.types';
+
+/**
+ * Defines types of features for which font can be customised with Custom style config used in TS.
+ * @remarks
+ * Use chartFeatureToFontGuid to get the guid for the feature and get the font face from guid
+ * from customFontFaces
+ */
+
+export type Maybe<T> = T | null;
+export type InputMaybe<T> = Maybe<T>;
+
+export type Scalars = {
+    ID: string;
+    String: string;
+    Boolean: boolean;
+    Int: number;
+    Float: number;
+    FileUpload: unknown;
+    GUID: string;
+    JSON: {
+        [key: string]: unknown;
+    };
+    JSONObject: unknown;
+    Long: unknown;
+};
+
+export enum CustomizableChartFeature {
+    X_AXIS_LABEL,
+    X_AXIS_TITLE,
+    Y_AXIS_LABEL,
+    Y_AXIS_TITLE,
+    TOOLTIP,
+    SCATTER_CHART,
+    PIE_CHART,
+    LINE_CHART,
+    COLUMN_CHART,
+    BAR_CHART,
+    AREA_CHART,
+    TAIL_FEATURE,
+}
 
 /**
  * List of Columns for a dimension in the Custom Chart Config.
@@ -140,6 +182,12 @@ export interface ChartModel {
     };
 }
 
+// Validation Response for valid config or visual props
+export type SuccessValidationResponse = {
+    chartConfigEditorDefinition: ChartConfigEditorDefinition[];
+    visualPropEditorDefinition: VisualPropEditorDefinition;
+};
+
 // Generic Validation Response
 export type ValidationResponse = {
     isValid: boolean;
@@ -149,21 +197,61 @@ export type ValidationResponse = {
 /**
  * Custom Visual props is the stored metadata for the visual props definition
  * configured by the user in the visual prop editor
- * The JSON is defined by the visual prop types. See VisualPropEditorDefinition.
- *
+ * The object is defined by the visual prop types. See VisualPropEditorDefinition.
+ * If there is any local state specific to charts needs to be maintained on save answer, store it
+ * in VisualProps, with visualProps.clientState variable. The clientState variable should be a
+ * string, preferrably a result of JSON.stringify(<yourlocalClientState>).
+ * @remark
+ * only values stored in clientSate variable will be preserved on changing the
+ * visualPropeditorDefinition, any other variable store would not be preserved
  * @group Chart Model
  * @version SDK: 0.1 | ThoughtSpot:
  */
-export type VisualProps = JSON;
+export type VisualProps = unknown;
+
+/**
+ *  Font Faces type from TS.
+ *  guid will be null in case of default Font types
+ *  If a custom Font is added in Dev section on TS this guid can be used to Match
+ *  the Font Face That needs to be applied to @link CustomizableChartFeature
+ */
 
-// Todo: this should be imported from the custom style config package.
-type CustomStylingConfig = any;
+export type TSFontFace = {
+    guid: string | null;
+    family?: string;
+    format?: string;
+    url?: string;
+    weight?: string;
+    style?: string;
+    size?: string;
+    unicodeRange?: string;
+    variant?: string;
+    stretch?: string;
+    color?: string;
+};
+
+/**
+ * Used for Custom color pallete and Custom font for charts defined in Style customisations
+ * inside thoughtspot admin or developer section
+ *
+ */
+
+export type ChartSdkCustomStylingConfig = {
+    appBackground?: {
+        color?: string;
+    };
+    appPanelColor?: {
+        color?: string;
+    };
+    chartColorPalettes?: Array<{ colors: Array<string> }>;
+    numColorPalettes?: number;
+    disableColorRotation?: boolean;
+    chartFeatureToFontGuid?: Record<CustomizableChartFeature, string>;
+    fontFaces?: Array<TSFontFace>;
+};
 
 export interface AppConfig {
-    /**
-     * @hidden
-     */
-    styleConfig?: CustomStylingConfig;
+    styleConfig?: ChartSdkCustomStylingConfig;
 
     appOptions?: {
         isMobile?: boolean;
@@ -195,4 +283,10 @@ export interface AppConfig {
      * @hidden
      */
     customCalendarConfig?: any; // this is to initialize custom calendar service
+
+    /**
+     * Unique identifier for the customer. This can be used as a way to maintain licensing by the
+     * third party developer
+     */
+    chartAppAccessToken?: string;
 }

package/src/types/conditional-formatting.types.ts

@@ -0,0 +1,157 @@
+/**
+ * @file: Conditional Formatting Types
+ * @fileoverview All CF types for the Custom Chart implementations
+ * @author Yashvardhan Nehra <yashvardhan.nehra@thoughtspot.com>
+ *
+ * Copyright: ThoughtSpot Inc. 2024
+ */
+
+import type { InputMaybe, Maybe, Scalars } from './common.types';
+
+export type ConditionalFormatting = {
+    __typename?: 'ConditionalFormatting';
+    rows?: Maybe<Array<Maybe<ConditionalMetric>>>;
+};
+export declare enum BackgroundFormatTypes {
+    Gradient = 'GRADIENT',
+    Solid = 'SOLID',
+}
+export enum ConditionalFormattingComparisonTypes {
+    ColumnBased = 'COLUMN_BASED',
+    ParameterBased = 'PARAMETER_BASED',
+    ValueBased = 'VALUE_BASED',
+}
+export type FontAttrs = {
+    __typename?: 'FontAttrs';
+    bold?: Maybe<Scalars['Boolean']>;
+    color?: Maybe<Scalars['String']>;
+    italic?: Maybe<Scalars['Boolean']>;
+    strikeThrough?: Maybe<Scalars['Boolean']>;
+    underline?: Maybe<Scalars['Boolean']>;
+};
+export type GradientBackgroundAttrs = {
+    __typename?: 'GradientBackgroundAttrs';
+    backgroundFormatMidpoint?: Maybe<Scalars['Float']>;
+    backgroundFormatRange?: Maybe<Array<Maybe<Scalars['Float']>>>;
+    colors?: Maybe<Array<Maybe<Scalars['String']>>>;
+};
+export enum Operators {
+    Contains = 'CONTAINS',
+    DoesNotContain = 'DOES_NOT_CONTAIN',
+    EndsWith = 'ENDS_WITH',
+    EqualTo = 'EQUAL_TO',
+    GreaterThan = 'GREATER_THAN',
+    GreaterThanEqualTo = 'GREATER_THAN_EQUAL_TO',
+    Is = 'IS',
+    IsBetween = 'IS_BETWEEN',
+    IsEmpty = 'IS_EMPTY',
+    IsNot = 'IS_NOT',
+    IsNotEmpty = 'IS_NOT_EMPTY',
+    IsNotNull = 'IS_NOT_NULL',
+    IsNull = 'IS_NULL',
+    LessThan = 'LESS_THAN',
+    LessThanEqualTo = 'LESS_THAN_EQUAL_TO',
+    NotEqualTo = 'NOT_EQUAL_TO',
+    StartsWith = 'STARTS_WITH',
+}
+export type SolidBackgroundAttrs = {
+    __typename?: 'SolidBackgroundAttrs';
+    color?: Maybe<Scalars['String']>;
+};
+export type Range = {
+    __typename?: 'Range';
+    max?: Maybe<Scalars['Float']>;
+    min?: Maybe<Scalars['Float']>;
+};
+export type ConditionalMetric = {
+    __typename?: 'ConditionalMetric';
+    backgroundFormatType?: Maybe<BackgroundFormatTypes>;
+    comparisonParameterId?: Maybe<Scalars['String']>;
+    comparisonType?: Maybe<ConditionalFormattingComparisonTypes>;
+    fontProperties?: Maybe<FontAttrs>;
+    gradientBackgroundAttrs?: Maybe<GradientBackgroundAttrs>;
+    isHighlightRow?: Maybe<Scalars['Boolean']>;
+    lhsColumnId?: Maybe<Scalars['String']>;
+    operator?: Maybe<Operators>;
+    plotAsBand?: Maybe<Scalars['Boolean']>;
+    rangeValues?: Maybe<Range>;
+    rhsColumnId?: Maybe<Scalars['String']>;
+    solidBackgroundAttrs?: Maybe<SolidBackgroundAttrs>;
+    value?: Maybe<Scalars['String']>;
+};
+
+export type Parameter = {
+    __typename?: 'Parameter';
+    dataType: FalconDataType;
+    defaultValue: Scalars['String'];
+    description: Scalars['String'];
+    id: Scalars['GUID'];
+    name: Scalars['String'];
+    /** If not present, the parameter has not been overridden */
+    overrideValue?: Maybe<Scalars['String']>;
+    owner: ParameterOwnerInfo;
+    valueList?: Maybe<Array<ParameterValueListItem>>;
+    valueRange?: Maybe<ParameterValueRange>;
+    valueType: ParameterValueType;
+};
+
+export enum FalconDataType {
+    Bool = 'BOOL',
+    Char = 'CHAR',
+    Date = 'DATE',
+    DateTime = 'DATE_TIME',
+    Double = 'DOUBLE',
+    Float = 'FLOAT',
+    Int32 = 'INT32',
+    Int64 = 'INT64',
+    List = 'LIST',
+    ListBool = 'LIST_BOOL',
+    ListDate = 'LIST_DATE',
+    ListDateTime = 'LIST_DATE_TIME',
+    ListDouble = 'LIST_DOUBLE',
+    ListInt = 'LIST_INT',
+    ListString = 'LIST_STRING',
+    ListTime = 'LIST_TIME',
+    MaxType = 'MAX_TYPE',
+    Time = 'TIME',
+    Unknown = 'UNKNOWN',
+}
+export type ParameterOwnerInfo = {
+    __typename?: 'ParameterOwnerInfo';
+    id: Scalars['GUID'];
+    name: Scalars['String'];
+    type: ParameterOwnerType;
+};
+
+export enum ParameterOwnerType {
+    Answer = 'ANSWER',
+    Worksheet = 'WORKSHEET',
+}
+
+export type ParameterValueListItem = {
+    __typename?: 'ParameterValueListItem';
+    displayAs?: Maybe<Scalars['String']>;
+    value: Scalars['String'];
+};
+
+export type ParameterValueListItemInput = {
+    displayAs?: InputMaybe<Scalars['String']>;
+    value: Scalars['String'];
+};
+
+export type ParameterValueRange = {
+    __typename?: 'ParameterValueRange';
+    max?: Maybe<Scalars['Float']>;
+    min?: Maybe<Scalars['Float']>;
+};
+
+export type ParameterValueRangeInput = {
+    max?: InputMaybe<Scalars['Float']>;
+    min?: InputMaybe<Scalars['Float']>;
+};
+
+export enum ParameterValueType {
+    Any = 'ANY',
+    List = 'LIST',
+    Range = 'RANGE',
+}

package/src/types/configurator.types.ts

@@ -14,6 +14,8 @@
  * Copyright: ThoughtSpot Inc. 2023
  */
 
+import type { CustomChartContext } from '../main/custom-chart-context';
+import { ChartModel } from './common.types';
 /**
  *
  * @group Chart Configuration Editor
@@ -68,6 +70,20 @@ export interface ChartConfigSection {
      * @version SDK: 0.1 | ThoughtSpot:
      */
     allowTimeSeriesColumns?: boolean;
+    /**
+     * Allow measure name Column on the Section
+     *
+     * @default true
+     * @version SDK: 0.1 | ThoughtSpot:
+     */
+    allowMeasureNameColumn?: boolean;
+    /**
+     * Allow measure value Column on the Section
+     *
+     * @default true
+     * @version SDK: 0.1 | ThoughtSpot:
+     */
+    allowMeasureValueColumn?: boolean;
 }
 
 /**
@@ -100,3 +116,8 @@ export interface ChartConfigEditorDefinition {
      */
     columnSections: ChartConfigSection[];
 }
+
+export type ConfigEditorDefinitionSetter = (
+    currentState: ChartModel,
+    ctx: CustomChartContext,
+) => ChartConfigEditorDefinition[];

package/src/types/number-formatting.types.ts

@@ -0,0 +1,80 @@
+/**
+ * @file: Number Formatting Types
+ * @author Yashvardhan Nehra <yashvardhan.nehra@thoughtspot.com>
+ *
+ * Copyright: ThoughtSpot Inc. 2024
+ */
+
+import type { Maybe, Scalars } from './common.types';
+
+export enum CategoryType {
+    Currency = 'CURRENCY',
+    Custom = 'CUSTOM',
+    Number = 'NUMBER',
+    Percentage = 'PERCENTAGE',
+}
+
+export enum Unit {
+    Auto = 'AUTO',
+    Billion = 'BILLION',
+    Million = 'MILLION',
+    None = 'NONE',
+    Thousands = 'THOUSANDS',
+    Trillion = 'TRILLION',
+}
+
+export enum NegativeValueFormat {
+    BracesNodash = 'BRACES_NODASH',
+    PrefixDash = 'PREFIX_DASH',
+    SuffixDash = 'SUFFIX_DASH',
+}
+
+export type CurrencyFormatConfig = {
+    __typename?: 'CurrencyFormatConfig';
+    /** default to 2 */
+    decimals?: Maybe<Scalars['Float']>;
+    locale?: Maybe<Scalars['String']>;
+    /** default to false */
+    removeTrailingZeroes?: Maybe<Scalars['Boolean']>;
+    /** default to true */
+    toSeparateThousands?: Maybe<Scalars['Boolean']>;
+    /** default is MILLION */
+    unit?: Maybe<Unit>;
+};
+
+export type CustomFormatConfig = {
+    __typename?: 'CustomFormatConfig';
+    format?: Maybe<Scalars['String']>;
+};
+
+export type NumberFormatConfig = {
+    __typename?: 'NumberFormatConfig';
+    /** default to 2 */
+    decimals?: Maybe<Scalars['Float']>;
+    /** default to PREFIX_DASH */
+    negativeValueFormat?: Maybe<NegativeValueFormat>;
+    /** default to false */
+    removeTrailingZeroes?: Maybe<Scalars['Boolean']>;
+    /** default to true */
+    toSeparateThousands?: Maybe<Scalars['Boolean']>;
+    /** default is Auto */
+    unit?: Maybe<Unit>;
+};
+
+export type PercentageFormatConfig = {
+    __typename?: 'PercentageFormatConfig';
+    /** default to 2 */
+    decimals?: Maybe<Scalars['Float']>;
+    /** default to false */
+    removeTrailingZeroes?: Maybe<Scalars['Boolean']>;
+};
+
+export type FormatConfig = {
+    __typename?: 'FormatConfig';
+    category?: Maybe<CategoryType>;
+    currencyFormatConfig?: Maybe<CurrencyFormatConfig>;
+    customFormatConfig?: Maybe<CustomFormatConfig>;
+    isCategoryEditable?: Maybe<Scalars['Boolean']>;
+    numberFormatConfig?: Maybe<NumberFormatConfig>;
+    percentageFormatConfig?: Maybe<PercentageFormatConfig>;
+};

package/src/types/ts-to-chart-event.types.ts

@@ -1,6 +1,9 @@
-import { AllowedConfigurations } from '../main/custom-chart-context';
+import type {
+    AllowedConfigurations,
+    ChartConfigParameters,
+} from '../main/custom-chart-context';
 import { ChartColumn } from './answer-column.types';
-import { Point } from './chart-to-ts-event.types';
+import type { Point } from './chart-to-ts-event.types';
 import {
     AppConfig,
     ChartConfig,
@@ -9,8 +12,8 @@ import {
     ValidationResponse,
     VisualProps,
 } from './common.types';
-import { ChartConfigEditorDefinition } from './configurator.types';
-import { VisualPropEditorDefinition } from './visual-prop.types';
+import type { ChartConfigEditorDefinition } from './configurator.types';
+import type { VisualPropEditorDefinition } from './visual-prop.types';
 
 /**
  * All the events sent from the ThoughtSpot application to Custom Chart App
@@ -200,11 +203,19 @@ export interface InitializeEventResponsePayload {
      */
     visualPropEditorDefinition?: VisualPropEditorDefinition;
     /**
-     * Toggle native configurations supported by TS UI. Ex: column level number and conditional formatting.
+     * Toggle native configurations supported by TS UI. Ex: column level number and conditional
+     * formatting.
      *
      * @version SDK: 0.1 | ThoughtSpot:
      */
     allowedConfigurations?: AllowedConfigurations;
+    /**
+     * Additional chart configuration parameters supported by TS UI. Ex: show/hide Measure Name/
+     * Value columns.
+     *
+     * @version SDK: 0.1 | ThoughtSpot:
+     */
+    chartConfigParameters?: ChartConfigParameters;
 }
 
 /**
@@ -215,12 +226,26 @@ export interface GetDataQueryPayload {
     config: ChartConfig[];
 }
 
+/**
+ *
+ * @group ThoughtSpot to Chart Events
+ */
+export interface QueryColumn extends ChartColumn {
+    /**
+     * Flag to identify if the column is a measure value,
+     * to be used along with MEASURE_NAME/MEASUE_VALUE column in the query
+     *
+     * @version SDK: 0.1 | ThoughtSpot:
+     */
+    isMeasureValue?: boolean;
+}
+
 /**
  *
  * @group ThoughtSpot to Chart Events
  */
 export interface Query {
-    queryColumns: ChartColumn[];
+    queryColumns: QueryColumn[];
     queryParams?: {
         offset?: number;
         size?: number;
@@ -280,6 +305,13 @@ export interface VisualPropsValidateEventPayload {
      * @version SDK: 0.1 | ThoughtSpot:
      */
     visualProps: VisualProps;
+    /**
+     * used to identify active column for column level settings, empty string in case of overall
+     * chart settings
+     *
+     * @version SDK: 0.1 | ThoughtSpot:
+     */
+    activeColumnId?: string;
 }
 
 /**