@qrvey/utils 1.16.0-2 → 1.16.0-20

package/dist/cjs/charts/interfaces/IChartV2.d.ts

@@ -0,0 +1,537 @@
+import { IChartColumn } from "../../column_format/interfaces/IChartColumn";
+import { IColumnType } from "../../columns/interfaces/IColumnType";
+import { IColumnCalculation } from "../../columns/interfaces/IColunmCalculation";
+import { CHART_TYPE } from "../../constants";
+import { IOutputFormat } from "../../interfaces/IChartBuilder.Interface";
+import { AutoType, CHART_ORIENTATION, CHART_THICKNESS, CONDITIONAL_CROSS, ICustomization, IDateRange, legendState, LINE_STYLE, LINE_TYPE, PIE_TYPE } from "../constants/CHART_OBJECT";
+import { QUESTIONS_TYPES } from "../constants/QUESTION_TYPES";
+import { MetricRequestResponse } from "./IRequestAdapterMetric";
+export interface VisualizationSortBy {
+    type: string;
+    order: string;
+}
+export interface VisualizationAggregate {
+    text: string;
+    label: string;
+    abbreviation: string;
+    id: string;
+    key: string;
+}
+export interface VisualizationSorting {
+    sortBy: string;
+    showIndicator: boolean;
+    order: string;
+}
+export interface VisualizationColumn {
+    aggregate: VisualizationAggregate;
+    id?: string;
+    label: string;
+    qrveyid: string;
+    sorting: VisualizationSorting;
+    uniqueid: string;
+    type: IColumnType;
+    text: string;
+    shelfTypeSort: string;
+    colIndex: number;
+    uniqueCode: string;
+    maxmin: unknown;
+    visualization: string;
+}
+export interface VisualizationSortByColumn {
+    type: string;
+    order: string;
+    column: VisualizationColumn;
+}
+interface VisualizationNullData {
+    value: boolean;
+    option: string;
+}
+export interface VisualizationMaxOption {
+    value: boolean;
+    option: number;
+}
+interface VisualizationCalculationsOptions {
+    sums: boolean;
+}
+interface VisualizationCalculations {
+    value: boolean;
+    options: VisualizationCalculationsOptions;
+}
+interface VisualizationPagination {
+    enabled: boolean;
+    recordsPage: number;
+}
+export interface VisualizationTableMenu {
+    label_edit: boolean;
+    sorting: boolean;
+    multi_sorting: boolean;
+    value_view: boolean;
+    totals: boolean;
+    calculations: VisualizationCalculations;
+    pagination: VisualizationPagination;
+    filtering: boolean;
+    column_resizing: boolean;
+    column_arrangement: boolean;
+    column_update: boolean;
+    change_aggregation: boolean;
+}
+interface VisualizationCrosstabLabelsOptions {
+    sorting: boolean;
+}
+interface VisualizationCrosstabLabels {
+    value: boolean;
+    options: VisualizationCrosstabLabelsOptions;
+}
+interface VisualizationGlobalSettings {
+    size: number;
+    legend: string;
+    sort_by: VisualizationSortBy;
+    sort_by_column: VisualizationSortByColumn;
+    sort_by_multi_columns: VisualizationSortByColumn[];
+    auto_sort_by: boolean;
+    calculation_direction: string;
+    tooltips: {
+        value: boolean;
+        advanced?: any;
+    };
+    drilldown: boolean;
+    quick_sort: boolean;
+    null_data: VisualizationNullData;
+    max_data_point: VisualizationMaxOption;
+    max_series_point: VisualizationMaxOption;
+    max_rows: VisualizationMaxOption;
+    max_groups: VisualizationMaxOption;
+    max_value_point: VisualizationMaxOption;
+    table_menu: VisualizationTableMenu;
+    crosstab_labels: VisualizationCrosstabLabels;
+    crosstab_totals: {
+        value: boolean;
+        option: string;
+    };
+    average: boolean;
+    crosstab_subtotals: boolean;
+    chartVersion: string;
+    fit_panel: boolean;
+    i18nTokenMode: string;
+    hasPivot: boolean;
+    metric_scale?: IMetricScale;
+    startNumeric: string | number;
+    endNumeric: string | number;
+    startDate?: IDateRange;
+    endDate?: IDateRange;
+    startTime: string;
+    endTime: string;
+    labelRotation?: number;
+    customization?: Partial<ICustomization>;
+}
+interface IMetricScale {
+    value: boolean;
+    min_value: number;
+    max_value: number;
+}
+interface VisualizationFormat {
+    value: string;
+    currency: string;
+    decimals: number;
+}
+interface VisualizationScale {
+    type: string;
+    steps: unknown;
+    min_range: unknown;
+    max_range: unknown;
+}
+export interface VisualizationAxis {
+    labels: boolean;
+    showAxisTitle: boolean;
+    custom_label: unknown;
+    fontType: unknown;
+    fontWeight: string;
+    fontSize: string;
+    fontColor: unknown;
+    values: boolean;
+    fontTypeValues: unknown;
+    fontWeightValues: string;
+    fontSizeValues: string;
+    fontColorValues: unknown;
+    rotation: number;
+    customValue: unknown;
+    customRotation: number;
+    format: VisualizationFormat;
+    scale: VisualizationScale;
+}
+interface VisualizationSimpleLabels {
+    border: boolean;
+    format: VisualizationFormat;
+}
+interface VisualizationDataLabels {
+    value: boolean;
+    simple_labels: VisualizationSimpleLabels;
+    pie_labels?: {
+        position: number;
+    };
+    visible?: boolean;
+}
+export interface VisualizationTableHeaderStyle {
+    headerColor: string;
+    headerFontColor: string;
+    outerBorder: boolean;
+    fontFamily: string;
+    fontSize: string;
+    fontWeight: string;
+}
+export interface VisualizationTableBodyStyle {
+    borderColor: string;
+    outerBorder: string;
+    verticalBorder: string;
+}
+export interface ITableDimensions {
+    rowHeight: AutoType | number;
+    columnWidth: AutoType | number;
+    textWrap: boolean;
+    fitToData: boolean;
+}
+export declare const enum SYMBOL_FILL_TYPE {
+    FILLED = "Filled",
+    HOLLOW = "Hollow"
+}
+export declare enum SYMBOL_TYPE {
+    CIRCLE = "circle",
+    TRIANGLE_UP = "triangle-up",
+    TRIANGLE_DOWN = "triangle-down",
+    SQUARE = "square",
+    DIAMOND = "diamond",
+    X = "x",
+    CROSS = "cross",
+    SORT_ASC = "sort-asc",
+    SORT_DESC = "sort-desc",
+    SYMBOL_FILL = "symbol-fill",
+    TRIANGLE = "triangle"
+}
+export interface VisualizationStylesSettings {
+    bar_type?: string;
+    color_type: string;
+    color: string;
+    custom_color: boolean;
+    theme: string[];
+    custom_theme: boolean;
+    match_colors: boolean;
+    x_axis: VisualizationAxis;
+    y_axis: VisualizationAxis;
+    data_labels: VisualizationDataLabels;
+    tableHeaderStyle: VisualizationTableHeaderStyle;
+    tableBodyStyle: VisualizationTableBodyStyle;
+    tableDimensions: ITableDimensions;
+    useThemeColor: boolean;
+    offset: IStyleSettingOptionsOffset;
+    orientation: CHART_ORIENTATION;
+    thickness: CHART_THICKNESS;
+    shadding: boolean;
+    category_labels: {
+        segments: boolean;
+        categories: boolean;
+    };
+    percent_labels?: unknown;
+    pie_type?: PIE_TYPE;
+    line_type?: LINE_TYPE;
+    line_style?: LINE_STYLE;
+    bullet_target?: IBulletTarget;
+    opacity?: string | number;
+    format?: VisualizationFormat;
+    indicator_font?: IIndicatorFont;
+    animation?: {
+        enable: boolean;
+    };
+    dial_size?: number;
+    gauge?: string;
+    metric_comparison?: IMetricComparison;
+    comparison_font?: IComparisonFont;
+    indicator_symbol?: IIndicatorSymbol;
+    legend?: legendState;
+    tooltips?: IMetricTooltips;
+    repeatebleRows?: unknown;
+    symbol_fill?: SYMBOL_FILL_TYPE;
+    symbol_type?: SYMBOL_TYPE;
+    reverse_color?: boolean;
+    pivot_axis?: unknown;
+}
+export declare const enum OFFSET_TYPE {
+    PERCENTAGE = "PERCENTAGE",
+    PIXELS = "PIXELS"
+}
+export type offsetType = OFFSET_TYPE;
+export interface IStyleSettingOptionsOffset {
+    type: offsetType;
+    left?: number;
+    bottom?: number;
+    top?: number;
+}
+interface IMetricTooltips {
+    value: boolean;
+    advanced?: {
+        data: any;
+        columns: any;
+        description?: string;
+    };
+}
+interface IIndicatorSymbol {
+    increase: IIndicatorSymbolOption;
+    decrease: IIndicatorSymbolOption;
+    nochange: IIndicatorSymbolOption;
+}
+interface IIndicatorSymbolOption {
+    symbol: string;
+    color: string;
+}
+interface IComparisonFont {
+    color: string;
+    style: string;
+    size: number;
+    automatic: boolean;
+}
+interface IMetricComparison {
+    value: boolean;
+    color: string;
+}
+interface IIndicatorFont {
+    color: string;
+    style: string;
+    size: number;
+    automatic: boolean;
+}
+interface IBulletTarget {
+    indicator: string;
+    value: number;
+    label: string;
+    color: string;
+}
+interface VisualizationComboLayer {
+    color_type: string;
+    color: string;
+    custom_color: boolean;
+    theme: string[];
+    custom_theme: boolean;
+    match_colors: boolean;
+    x_axis: VisualizationAxis;
+    y_axis: VisualizationAxis;
+    data_labels: VisualizationDataLabels;
+    tableHeaderStyle: VisualizationTableHeaderStyle;
+    useThemeColor: boolean;
+    offset: IStyleSettingOptionsOffset;
+    orientation: string;
+    thickness: string;
+    shadding: boolean;
+    symbol_type: string;
+    symbol_fill: string;
+    line_style: string;
+    line_type: string;
+    layer_type: string;
+    bar_type: string;
+}
+export interface VisualizationDimensionColumn extends IChartColumn, VisualizationConditions {
+    id: string;
+    text: string;
+    type: IColumnType;
+    qrveyid: string;
+    aggregate: VisualizationAggregate;
+    comboLayer: VisualizationComboLayer;
+    axisId: string;
+    uniqueCode: string;
+    colIndex: number;
+    dataField: string;
+    resultingType?: string;
+    columnTitle?: string;
+    groupAggregate: VisualizationAggregate;
+    visualization?: "Bars" | "Values";
+    maxmin?: unknown;
+    label?: string;
+    index?: number;
+    uniqueid?: string;
+    shelfTypeSort?: string;
+    sortOrder?: string;
+    formulaInputType?: string;
+    columnSetting?: {
+        imageField?: ImageFieldConfig;
+        hierarchy?: IHierarchyConfig;
+    };
+}
+export interface IHierarchyConfig {
+    enabled: boolean;
+    hierarchy: string;
+    hierarchyId: string;
+    rootValue: {
+        null: boolean;
+        otherValue: string;
+    };
+}
+export interface ImageFieldConfig {
+    id: string;
+    size: {
+        id: TableImageSizeId;
+        width: number;
+        height: number;
+    };
+    display: TableImageDisplay;
+    aspect: TableImageAspect;
+}
+export declare enum TableImageSizeId {
+    SMALL = "SMALL",
+    MEDIUM = "MEDIUM",
+    LARGE = "LARGE",
+    CUSTOM = "CUSTOM"
+}
+export declare enum TableImageDisplay {
+    LEFT = "LEFT",
+    RIGHT = "RIGHT",
+    ONLYIMAGE = "ONLYIMAGE"
+}
+export declare enum TableImageAspect {
+    CONTAIN = "CONTAIN",
+    COVER = "COVER",
+    FILL = "FILL"
+}
+export type AvailableColumn = {
+    label: string;
+    value: {
+        id: string;
+        type: string;
+    };
+};
+export interface RecursiveGrouping {
+    enabled?: boolean;
+    hierarchicalGroup?: object;
+    hierarchy?: object;
+    hierarchyId?: object;
+}
+export interface VisualizationDimensionsCategory extends VisualizationDimensionColumn {
+}
+export interface VisualizationCondition {
+    conditionPriority: number;
+    columnRef?: string;
+    crossRef?: {
+        id: CONDITIONAL_CROSS;
+        uniqueCode: string;
+    };
+    color?: string;
+    textColor?: string;
+    type?: SYMBOL_FILL_TYPE;
+    text?: string;
+}
+interface VisualizationConditions {
+    conditions?: VisualizationCondition[];
+}
+export interface VisualizationDimensionsValue extends VisualizationDimensionsCategory {
+    calculation?: IColumnCalculation;
+}
+export interface VisualizationDimensionsSerie extends VisualizationDimensionsCategory {
+}
+export interface VisualizationDimensions {
+    categories: VisualizationDimensionsCategory[];
+    values: VisualizationDimensionsValue[];
+    series: VisualizationDimensionsSerie[];
+    pivots: VisualizationDimensionColumn[];
+    smallmultiple: VisualizationDimensionColumn[];
+    trend: VisualizationDimensionColumn[];
+    reference: VisualizationDimensionColumn[];
+    geolocation: VisualizationDimensionColumn[];
+    comparison: VisualizationDimensionColumn[];
+    thresholds: VisualizationDimensionColumn[];
+    tableTotals: VisualizationDimensionColumn[];
+}
+interface VisualizationDataset {
+    text?: string;
+}
+export type IQuestionTypes = keyof typeof QUESTIONS_TYPES;
+export type FORMULA_MODE = "STANDARD" | "ADVANCED";
+export interface IQrveyModelDataset {
+    sourceid: string;
+    qrveyid: string;
+    name: string;
+    text: string;
+    linkid: string;
+}
+export interface ISortingOptions {
+    order?: string;
+    sortBy?: string;
+    showIndicator?: boolean;
+}
+/**
+ * The MetricThresholdRequestResponse type is an object that contains an array of numbers called
+ * "summary".
+ * @property {number[]} summary - The `summary` property is an array of numbers.
+ */
+export type MetricThresholdRequestResponse = {
+    summary: number[];
+};
+export type MetricResultRequest = MetricRequestResponse | MetricThresholdRequestResponse;
+export interface IQrveyModelColumn {
+    id: string;
+    qid: string;
+    text: string;
+    name: string;
+    typeLabel?: string;
+    type: IQuestionTypes;
+    answers?: unknown[];
+    archived?: boolean;
+    linked?: string;
+    bucketType?: string;
+    formulaType?: string;
+    formulaMode?: FORMULA_MODE;
+    property?: string;
+    calculation?: unknown;
+    dataset?: IQrveyModelDataset;
+    label?: string;
+    imageUploadOption?: "Text" | "Object" | "None";
+    outputFormat?: IOutputFormat;
+    sorting?: ISortingOptions;
+    selectedFormat?: IOutputFormat;
+    dateGroup?: unknown;
+    timeGroup?: unknown;
+    uniqueCode?: string;
+    colIndex?: string;
+    activeCat?: unknown;
+    formulaInputType?: string;
+}
+export interface ChartV2Model {
+    chart?: unknown;
+    component?: {
+        getVisibleRows?: () => unknown;
+    };
+    question?: IQrveyModelColumn;
+    type: CHART_TYPE;
+    previousType: CHART_TYPE;
+    panelId?: string;
+    defaultFilters?: unknown;
+    position: number;
+    title: string;
+    version: number;
+    globalSettings: VisualizationGlobalSettings;
+    stylesSettings: VisualizationStylesSettings;
+    dimensions: VisualizationDimensions;
+    chartid?: string;
+    metricid?: string;
+    createDate: string;
+    modifyDate: string;
+    dataset?: VisualizationDataset;
+    v2?: unknown;
+    results?: MetricResultRequest;
+    thresholdResults?: MetricResultRequest;
+    branchInfo?: unknown;
+    customTokens?: unknown[];
+    conditions?: unknown[];
+    comparisonList?: unknown;
+    qrveyid?: string;
+    hasDefaultConfig?: boolean;
+    isMulti?: boolean;
+    isTrend?: boolean;
+    isReference?: boolean;
+    isGrouped?: boolean;
+    isCombolayer?: boolean;
+    isCombo?: boolean;
+    isStakedBar?: boolean;
+    isSmallMultiples?: boolean;
+    isTableChartGrouped?: boolean;
+    isOldChart: boolean;
+    isMultipleSorted?: boolean;
+    trendsCharts?: unknown[];
+}
+export {};

package/dist/cjs/charts/interfaces/IChartV2.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TableImageAspect = exports.TableImageDisplay = exports.TableImageSizeId = exports.SYMBOL_TYPE = void 0;
+var SYMBOL_TYPE;
+(function (SYMBOL_TYPE) {
+    SYMBOL_TYPE["CIRCLE"] = "circle";
+    SYMBOL_TYPE["TRIANGLE_UP"] = "triangle-up";
+    SYMBOL_TYPE["TRIANGLE_DOWN"] = "triangle-down";
+    SYMBOL_TYPE["SQUARE"] = "square";
+    SYMBOL_TYPE["DIAMOND"] = "diamond";
+    SYMBOL_TYPE["X"] = "x";
+    SYMBOL_TYPE["CROSS"] = "cross";
+    SYMBOL_TYPE["SORT_ASC"] = "sort-asc";
+    SYMBOL_TYPE["SORT_DESC"] = "sort-desc";
+    SYMBOL_TYPE["SYMBOL_FILL"] = "symbol-fill";
+    SYMBOL_TYPE["TRIANGLE"] = "triangle";
+})(SYMBOL_TYPE || (exports.SYMBOL_TYPE = SYMBOL_TYPE = {}));
+var TableImageSizeId;
+(function (TableImageSizeId) {
+    TableImageSizeId["SMALL"] = "SMALL";
+    TableImageSizeId["MEDIUM"] = "MEDIUM";
+    TableImageSizeId["LARGE"] = "LARGE";
+    TableImageSizeId["CUSTOM"] = "CUSTOM";
+})(TableImageSizeId || (exports.TableImageSizeId = TableImageSizeId = {}));
+var TableImageDisplay;
+(function (TableImageDisplay) {
+    TableImageDisplay["LEFT"] = "LEFT";
+    TableImageDisplay["RIGHT"] = "RIGHT";
+    TableImageDisplay["ONLYIMAGE"] = "ONLYIMAGE";
+})(TableImageDisplay || (exports.TableImageDisplay = TableImageDisplay = {}));
+var TableImageAspect;
+(function (TableImageAspect) {
+    TableImageAspect["CONTAIN"] = "CONTAIN";
+    TableImageAspect["COVER"] = "COVER";
+    TableImageAspect["FILL"] = "FILL";
+})(TableImageAspect || (exports.TableImageAspect = TableImageAspect = {}));

package/dist/cjs/charts/interfaces/IRequestAdapterMetric.d.ts

@@ -2,7 +2,7 @@ import { IBColumn, IColumnType } from "../../columns";
 import { IDateGroupingProperty, RelativeCursor } from "../../dates";
 import { IFBLogic } from "../../filters";
 import { TimePeriod, TP_CUSTOM_RANGE } from "../../interfaces";
-import { AGGREGATE_LABEL } from "../constants";
+import { AGGREGATE, AGGREGATE_LABEL } from "../constants";
 export interface MetricRequestPayload {
     logic: IFBLogic[];
     value: MetricValue;
@@ -18,9 +18,10 @@ export interface MetricRequestPayload {
  * property "answered".
  */
 export type MetricValue = {
-    aggregate: AGGREGATE_LABEL;
+    aggregate?: AGGREGATE_LABEL;
     questionid: string;
     property?: string | null;
+    dateAsText?: boolean;
 };
 /**
  * A `RelativeDateConfig` is an object with a `questionid` property, a `cursor` property, an optional
@@ -109,9 +110,11 @@ export type MetricConfigData = {
     value: {
         id: string;
         property: string;
+        formulaInputType?: string;
     };
     valueAggregate: {
         label: AGGREGATE_LABEL;
+        id: AGGREGATE;
     };
 };
 export type MetricTimeCustomRange = {

package/dist/cjs/charts/interfaces/index.d.ts

@@ -3,3 +3,4 @@ export * from "./IAggregateInfo";
 export * from "./IAggregateLabel";
 export * from "./IAggregateType";
 export * from "./IRequestAdapterMetric";
+export * from "./IChartV2";

package/dist/cjs/charts/interfaces/index.js

@@ -19,3 +19,4 @@ __exportStar(require("./IAggregateInfo"), exports);
 __exportStar(require("./IAggregateLabel"), exports);
 __exportStar(require("./IAggregateType"), exports);
 __exportStar(require("./IRequestAdapterMetric"), exports);
+__exportStar(require("./IChartV2"), exports);

package/dist/cjs/column_format/helpers/columnTypeByChart.js

@@ -17,6 +17,7 @@ const parseFormulaTypeByCharts_1 = require("./parseFormulaTypeByCharts");
  * @returns The column type of the column.
  */
 const columnTypeByChart = (column, shelfType, chartGroup, isGroupedTable) => {
+    var _a;
     if (!column)
         return;
     const currentType = column.type === columns_1.COLUMN.FORMULA
@@ -25,7 +26,8 @@ const columnTypeByChart = (column, shelfType, chartGroup, isGroupedTable) => {
     const isNumericalColumn = __1.NUMERICAL_COLUMNS.some((colType) => colType === currentType) ||
         (chartGroup === CHART_GROUP_1.CHART_GROUPS.TABLES &&
             isGroupedTable === true &&
-            shelfType === SHELF_TYPE_1.SHELF_TYPE.COLUMNS) ||
+            shelfType === SHELF_TYPE_1.SHELF_TYPE.COLUMNS &&
+            ![__1.AGGREGATE.MIN, __1.AGGREGATE.MAX].includes((_a = column === null || column === void 0 ? void 0 : column.aggregate) === null || _a === void 0 ? void 0 : _a.id)) ||
         (chartGroup === CHART_GROUP_1.CHART_GROUPS.XY && shelfType === SHELF_TYPE_1.SHELF_TYPE.VALUE);
     return isNumericalColumn === true ? __1.NUMERICAL_COLUMN.NUMERIC : currentType;
 };

package/dist/cjs/columns/interfaces/IColumn.d.ts

@@ -22,4 +22,5 @@ export interface IColumn extends Omit<IBColumn, "text" | "bucketId" | "formulaId
     property?: IColumnPropertyType;
     slidebarValue?: number;
     sorting?: IColumnSortingSettings;
+    formulaInputType?: string;
 }

package/dist/cjs/columns/interfaces/IColunmCalculation.d.ts

@@ -1,5 +1,10 @@
+export interface IColumnCalculationLevel {
+    id: string;
+    colIndex: number;
+}
 export interface IColumnCalculation {
     abbreviation: string;
     aggregate?: string;
     value?: string;
+    levels?: IColumnCalculationLevel;
 }

package/dist/cjs/constants/Charts.Const.d.ts

@@ -30,7 +30,8 @@ export declare enum CHART_TYPE {
     RADAR_CHART = "RADAR_CHART",
     TREEMAP_CHART = "TREEMAP_CHART",
     AREA_CHART = "AREA_CHART",
-    AREA_CHART_MS = "AREA_CHART_MS"
+    AREA_CHART_MS = "AREA_CHART_MS",
+    SCATTER_CHART = "SCATTER_CHART"
 }
 export declare enum CHART_DIMENSION {
     CATEGORIES = "categories",

package/dist/cjs/constants/Charts.Const.js

@@ -35,6 +35,7 @@ var CHART_TYPE;
     CHART_TYPE["TREEMAP_CHART"] = "TREEMAP_CHART";
     CHART_TYPE["AREA_CHART"] = "AREA_CHART";
     CHART_TYPE["AREA_CHART_MS"] = "AREA_CHART_MS";
+    CHART_TYPE["SCATTER_CHART"] = "SCATTER_CHART";
 })(CHART_TYPE || (exports.CHART_TYPE = CHART_TYPE = {}));
 var CHART_DIMENSION;
 (function (CHART_DIMENSION) {