@qrvey/utils 1.16.1-8 → 1.17.0-0

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

@@ -1,538 +0,0 @@
-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;
-    columnGrouping: 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/IRequestAdapterMetric.d.ts

@@ -1,129 +0,0 @@
-import { IBColumn, IColumnType } from "../../columns";
-import { IDateGroupingProperty, RelativeCursor } from "../../dates";
-import { IFBLogic } from "../../filters";
-import { TimePeriod, TP_CUSTOM_RANGE } from "../../interfaces";
-import { AGGREGATE, AGGREGATE_LABEL } from "../constants";
-export interface MetricRequestPayload {
-    logic: IFBLogic[];
-    value: MetricValue;
-    period?: MetricPeriod | MetricCustomRange;
-    comparison?: MetricComparison | MetricCustomRange;
-}
-/**
- * A metric value is an object with an aggregate label, a question id, and an optional property.
- * @property {AGGREGATE_LABEL} aggregate - The aggregate label to use.
- * @property {string} questionid - The question ID of the question you want to get the metric for.
- * @property {string | null} property - The property of the question that you want to aggregate. For
- * example, if you want to aggregate the number of times a question was answered, you would use the
- * property "answered".
- */
-export type MetricValue = {
-    aggregate?: AGGREGATE_LABEL;
-    questionid: string;
-    property?: string | null;
-    dateAsText?: boolean;
-};
-/**
- * A `RelativeDateConfig` is an object with a `questionid` property, a `cursor` property, an optional
- * `number` property, a `unit` property, an optional `includeCurrent` property, and an optional
- * `isCalendarDate` property.
- * @property {string} questionid - The question id of the question that you want to filter on.
- * @property {RelativeCursor} cursor - The cursor is the date that the relative date is based on.  It
- * can be one of the following:
- * @property {number} number - The number of units to go back.
- * @property {IDateGroupingProperty} unit - The unit of time to use for the relative date. This can be
- * one of the following:
- * @property {boolean} includeCurrent - If true, the current date is included in the range.
- * @property {boolean} isCalendarDate - If true, the date is a calendar date, otherwise it's a relative
- * date.
- */
-export type RelativeDateConfig = {
-    questionid: string;
-    cursor: RelativeCursor;
-    number?: number;
-    unit: IDateGroupingProperty;
-    includeCurrent?: boolean;
-    isCalendarDate?: boolean;
-    type?: IColumnType;
-};
-/**
- * `MetricCustomRange` is a type that has a property called `customRange` that is of type
- * `CustomRange`.
- * @property {CustomRange} customRange - The custom range to use for the metric.
- */
-export type MetricCustomRange = {
-    customRange: CustomRange;
-    type?: IColumnType;
-};
-/**
- * `CustomRangeConfig` is an object with optional properties `startingDate`, `endDate`, and `label`.
- * @property {string} startingDate - The starting date of the custom range.
- * @property {string} endDate - The end date of the custom range.
- * @property {TP_CUSTOM_RANGE} label - The label for the custom range.
- */
-export type CustomRangeConfig = {
-    startingDate?: string;
-    endDate?: string;
-    label?: TP_CUSTOM_RANGE;
-};
-/**
- * CustomRange is an object with optional gte and lte properties, both of which are strings.
- * @property {string} gte - Greater than or equal to
- * @property {string} lte - Less than or equal to
- */
-export type CustomRange = {
-    gte?: string;
-    lte?: string;
-};
-/**
- * `MetricRequestResponse` is an object with four properties: `value`, `min`, `max`, and `comparison`.
- *
- * The `value` property is a number. The `min` and `max` properties are also numbers. The `comparison`
- * property is a number.
- * @property {number} value - The value of the metric
- * @property {number} min - The minimum value of the metric
- * @property {number} max - The maximum value of the metric
- * @property {number} comparison - The value of the metric for the previous period.
- */
-export type MetricRequestResponse = {
-    value: number;
-    min: number;
-    max: number;
-    comparison: number;
-};
-export type MetricPeriod = RelativeDateConfig;
-export type MetricComparison = RelativeDateConfig;
-export type MetricConfig = {
-    logic: IFBLogic[];
-    data: MetricConfigData;
-};
-export type MetricConfigData = {
-    dateColumn: IBColumn;
-    timePeriod: MetricTimeInfo;
-    timePeriodCustomRange: MetricTimeCustomRange;
-    timePeriodDate: string;
-    timePeriodEndDate: string;
-    comparison: MetricTimeInfo;
-    comparisonCustomRange: MetricTimeCustomRange;
-    comparisonDate: string;
-    comparisonEndDate: string;
-    value: {
-        id: string;
-        property: string;
-        formulaInputType?: string;
-    };
-    valueAggregate: {
-        label: AGGREGATE_LABEL;
-        id: AGGREGATE;
-    };
-};
-export type MetricTimeCustomRange = {
-    key: string;
-    label: TP_CUSTOM_RANGE;
-    text: string;
-};
-export type MetricTimeInfo = {
-    key: string;
-    label: TimePeriod;
-    text: string;
-};

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

@@ -1,6 +0,0 @@
-export * from "./IAggregateAbbreviation";
-export * from "./IAggregateInfo";
-export * from "./IAggregateLabel";
-export * from "./IAggregateType";
-export * from "./IRequestAdapterMetric";
-export * from "./IChartV2";

package/dist/cjs/column_format/constants/CHART_GROUP.d.ts

@@ -1,4 +0,0 @@
-export declare enum CHART_GROUPS {
-    TABLES = "tables",
-    XY = "xy"
-}

package/dist/cjs/column_format/constants/DATEGROUP_UNSUPPORT_FORMAT.d.ts

@@ -1,2 +0,0 @@
-import { DATEGROUP_WITHOUT_FORMAT } from "./DATEGROUP_WITHOUT_FORMAT";
-export declare const DATEGROUP_UNSUPPORT_FORMAT: DATEGROUP_WITHOUT_FORMAT[];

package/dist/cjs/column_format/constants/DATEGROUP_WITHOUT_FORMAT.d.ts

@@ -1,12 +0,0 @@
-export declare enum DATEGROUP_WITHOUT_FORMAT {
-    YEAR = "YEAR",
-    QUARTER = "QUARTER",
-    MONTH = "MONTH",
-    WEEK = "WEEK",
-    QUARTER_ONLY = "QUARTER_ONLY",
-    MONTH_ONLY = "MONTH_ONLY",
-    DAY_ONLY = "DAY_ONLY",
-    HOUR_ONLY = "HOUR_ONLY",
-    MINUTE_ONLY = "MINUTE_ONLY",
-    SECOND_ONLY = "SECOND_ONLY"
-}

package/dist/cjs/column_format/constants/DURATION_PARTS_LIST.d.ts

@@ -1 +0,0 @@
-export declare const DURATION_PARTS_LIST: string[];

package/dist/cjs/column_format/constants/SHELF_TYPE.d.ts

@@ -1,7 +0,0 @@
-export declare enum SHELF_TYPE {
-    CATEGORY = "category",
-    VALUE = "value",
-    GROUPS = "groups",
-    COLUMNS = "columns",
-    SERIES = "series"
-}

package/dist/cjs/column_format/constants/STRING_FORMAT.d.ts

@@ -1,3 +0,0 @@
-export declare enum STRING_FORMAT {
-    NONE = "none"
-}