autoql-fe-utils 1.0.0 → 1.0.2

package/dist/index.d.ts

@@ -28,6 +28,176 @@ declare const AGG_TYPES: {
 declare const MAX_LEGEND_LABELS = 22;
 declare const MIN_HISTOGRAM_SAMPLE = 20;
 
+declare const CUSTOM_TYPE = "CUSTOM";
+declare const PROJECT_TYPE = "PROJECT";
+declare const PERIODIC_TYPE = "PERIODIC";
+declare const CONTINUOUS_TYPE = "CONTINUOUS";
+declare const SCHEDULED_TYPE = "SCHEDULED";
+declare const COMPARE_TYPE = "COMPARE";
+declare const EXISTS_TYPE = "EXISTS";
+declare const NUMBER_TERM_TYPE = "CONSTANT";
+declare const QUERY_TERM_TYPE = "QUERY";
+declare const GROUP_TERM_TYPE = "GROUP";
+declare const DEFAULT_EVALUATION_FREQUENCY = 5;
+declare const DATA_ALERT_STATUSES: {
+    ACTIVE: string;
+    RETRY: string;
+    WAITING: string;
+    INACTIVE: string;
+    EVALUATION_ERROR: string;
+    DATA_RETURN_ERROR: string;
+    GENERAL_ERROR: string;
+};
+declare const DATA_ALERT_ENABLED_STATUSES: string[];
+declare const DATA_ALERT_OPERATORS: {
+    GREATER_THAN: {
+        displayName: string;
+        symbol: string;
+        conditionText: string;
+        conditionTextPast: string;
+    };
+    GREATER_THAN_EQUAL_TO: {
+        displayName: string;
+        symbol: string;
+        conditionText: string;
+        conditionTextPast: string;
+    };
+    LESS_THAN: {
+        displayName: string;
+        symbol: string;
+        conditionText: string;
+        conditionTextPast: string;
+    };
+    LESS_THAN_EQUAL_TO: {
+        displayName: string;
+        symbol: string;
+        conditionText: string;
+        conditionTextPast: string;
+    };
+    EQUAL_TO: {
+        displayName: string;
+        symbol: string;
+        conditionText: string;
+        conditionTextPast: string;
+    };
+};
+declare const DATA_ALERT_CONDITION_TYPES: {
+    COMPARE: {
+        displayName: string;
+    };
+    EXISTS: {
+        displayName: string;
+    };
+};
+declare const DATA_ALERT_FREQUENCY_TYPE_OPTIONS: {
+    SCHEDULED: {
+        label: string;
+        listLabel: string;
+    };
+    CONTINUOUS: {
+        label: string;
+        listLabel: string;
+    };
+};
+declare const SCHEDULE_INTERVAL_OPTIONS: {
+    DAY: {
+        displayName: string;
+        getLocalStartDate: ({ timeObj, timezone, daysToAdd }: {
+            timeObj: any;
+            timezone: any;
+            daysToAdd?: number;
+        }) => string;
+    };
+    WEEK: {
+        displayName: string;
+        getLocalStartDate: ({ weekDay, timeObj, timezone }: {
+            weekDay: any;
+            timeObj: any;
+            timezone: any;
+        }) => string;
+    };
+    MONTH: {
+        displayName: string;
+        getLocalStartDate: ({ monthDay, timeObj, timezone }: {
+            monthDay: any;
+            timeObj: any;
+            timezone: any;
+        }) => string;
+    };
+};
+declare const SCHEDULE_FREQUENCY_OPTIONS: {
+    DAY: {
+        displayText: string;
+    };
+    WEEK: {
+        displayText: string;
+    };
+    MONTH: {
+        displayText: string;
+    };
+    MONTH_LAST_DAY: {
+        displayText: string;
+    };
+    YEAR: {
+        displayText: string;
+    };
+};
+declare const RESET_PERIOD_OPTIONS: {
+    DAY: {
+        displayName: string;
+        displayText: string;
+    };
+    WEEK: {
+        displayName: string;
+        displayText: string;
+    };
+    MONTH: {
+        displayName: string;
+        displayText: string;
+    };
+    NONE: {
+        displayName: string;
+        displayText: string;
+    };
+};
+declare const MONTH_DAY_SELECT_OPTIONS: {
+    FIRST: string;
+    LAST: string;
+};
+declare const EVALUATION_FREQUENCY_OPTIONS: {
+    1: {
+        value: number;
+        label: string;
+    };
+    2: {
+        value: number;
+        label: string;
+    };
+    3: {
+        value: number;
+        label: string;
+    };
+    5: {
+        value: number;
+        label: string;
+        listLabel: string;
+    };
+    10: {
+        value: number;
+        label: string;
+    };
+    30: {
+        value: number;
+        label: string;
+    };
+    60: {
+        value: number;
+        label: string;
+    };
+};
+
+declare const DEFAULT_SOURCE = "widgets";
+
 declare enum TimestampFormats {
     epoch = "EPOCH",
     iso8601 = "ISO8601"
@@ -55,6 +225,10 @@ declare enum NumberColumnTypeDisplayNames {
     RATIO = "Ratio",
     PERCENT = "Percent"
 }
+declare enum DataExplorerTypes {
+    SUBJECT_TYPE = "subject",
+    VL_TYPE = "VL"
+}
 
 interface Column {
     dow_style: string;
@@ -352,4 +526,216 @@ declare const rotateArray: (array: any, n: any) => any[];
 declare const onlyUnique: (value: any, index: any, self: any) => boolean;
 declare const makeEmptyArray: (w: any, h: any, value?: string) => any[];
 
-export { AGG_TYPES, AxiosResponse, CHART_TYPES, Column, Columns, DATE_ONLY_CHART_TYPES, DAYJS_PRECISION_FORMATS, DEFAULT_AGG_TYPE, DEFAULT_DATA_PAGE_SIZE, DOUBLE_AXIS_CHART_TYPES, DOW_STYLES, DataFormatting, FilterLock, FrontendReq, MAX_DATA_PAGE_SIZE, MAX_LEGEND_LABELS, MIN_HISTOGRAM_SAMPLE, MONTH_NAMES, NumberColumnTypeDisplayNames, NumberColumnTypes, PrecisionTypes, QueryData, QueryResponse, Rows, SEASON_NAMES, Scale, TABLE_TYPES, TimestampFormats, WEEKDAY_NAMES_MON, WEEKDAY_NAMES_SUN, animateInputText, authenticationDefault, autoQLConfigDefault, capitalizeFirstChar, currentEventLoopEnd, dataConfigDefault, dataFormattingDefault, dateSortFn, dateStringSortFn, deepEqual, difference, formatChartLabel, formatDateStringType, formatDateType, formatElement, formatEpochDate, formatISODateWithPrecision, formatStringDate, formatStringDateWithPrecision, functionsEqual, getAuthentication, getAutoQLConfig, getBBoxFromRef, getColumnTypeAmounts, getCurrencySymbol, getDataConfig, getDataFormatting, getDateColumnIndex, getDayJSObj, getDayjsObjForStringType, getDefaultDisplayType, getEpochFromDate, getFirstChartDisplayType, getGroupBys, getGroupBysFromPivotTable, getGroupBysFromTable, getGroupableColumns, getKeyByValue, getNumberFormatConfig, getNumberOfGroupables, getPadding, getQueryParams, getSVGBase64, getStringFromSource, getSupportedDisplayTypes, getVisibleColumns, handleTooltipBoundaryCollision, hasData, hasDateColumn, hasNumberColumn, hasStringColumn, invertArray, isAggregation, isChartType, isColumnDateType, isColumnNumberType, isColumnStringType, isDisplayTypeValid, isListQuery, isNumber, isObject, isSingleValueResponse, isTableType, makeEmptyArray, mergeSources, nameValueObject, onlyUnique, removeFromDOM, rotateArray, setCaretPosition, shouldPlotMultiSeries, sortDataByDate, supports2DCharts, supportsDatePivotTable, supportsPieChart, supportsRegularPivotTable, svgToPng };
+declare const dataStructureChanged: (props: any, prevProps: any) => boolean;
+declare const onlySeriesVisibilityChanged: (props: any, prevProps: any) => boolean;
+declare const scaleZero: (scale: any) => any;
+declare const getKey: (rowIndex: any, cellIndex: any, extraIndex?: number) => string;
+declare const shouldLabelsRotate: (axisElement: any) => boolean;
+declare const getTooltipContent: ({ row, columns, colIndex, colIndex2, legendColumn, dataFormatting, aggregated, }: {
+    row: any;
+    columns: any;
+    colIndex: any;
+    colIndex2: any;
+    legendColumn: any;
+    dataFormatting: any;
+    aggregated?: boolean;
+}) => any;
+declare const getLegendLabelsForMultiSeries: (columns: any, colorScale: any, numberColumnIndices?: any[]) => {
+    label: any;
+    color: any;
+    hidden: any;
+    columnIndex: any;
+    column: any;
+}[];
+declare const getNumberOfSeries: (data: any) => any;
+declare const convertToNumber: (value: any) => number;
+declare const calculateMinAndMaxSums: (data: any, stringColumnIndex: any, numberColumnIndices: any, isScaled: any) => {
+    maxValue: number;
+    minValue: number;
+};
+declare const getObjSize: (obj: any) => number;
+declare const getMaxValueFromKeyValueObj: (obj: any) => number;
+declare const getMinValueFromKeyValueObj: (obj: any) => number;
+declare const getMinAndMaxValues: (data: any, numberColumnIndices: any, isScaled: any, sum: any, stringColumnIndex: any) => {
+    minValue: number;
+    maxValue: number;
+};
+declare const getLegendLocation: (seriesArray: any, displayType: any, preferredLocation?: string) => string;
+declare const getRangeForAxis: ({ axis, height, width }: {
+    axis: any;
+    height: any;
+    width: any;
+}) => any[];
+declare const getTimeScale: ({ data, columns, columnIndex, axis, domain, dataFormatting, outerPadding, innerPadding, height, width, stringColumnIndices, changeColumnIndices, enableAxisDropdown, changeStringColumnIndex, }: {
+    data: Rows;
+    columns: Columns;
+    columnIndex: number;
+    axis: string;
+    domain: number[];
+    dataFormatting: DataFormatting;
+    outerPadding: number;
+    innerPadding: number;
+    height: number;
+    width: number;
+    stringColumnIndices: number[];
+    changeColumnIndices: number[];
+    enableAxisDropdown: boolean;
+    changeStringColumnIndex: Function;
+}) => any;
+declare const getBandScale: ({ data, columns, columnIndex, axis, domain, dataFormatting, outerPadding, innerPadding, height, width, stringColumnIndices, changeColumnIndices, enableAxisDropdown, changeStringColumnIndex, }: {
+    data: Rows;
+    columns: Columns;
+    columnIndex: number;
+    axis: string;
+    domain: number[];
+    dataFormatting: DataFormatting;
+    outerPadding: number;
+    innerPadding: number;
+    height: number;
+    width: number;
+    stringColumnIndices: number[];
+    changeColumnIndices: number[];
+    enableAxisDropdown: boolean;
+    changeStringColumnIndex: Function;
+}) => any;
+declare const getUnitsForColumn: (column: Column, useAgg?: boolean) => "none" | "currency" | "percent";
+declare const getUnitSymbol: ({ column, dataFormatting, }: {
+    column: Column;
+    dataFormatting: DataFormatting;
+}) => string;
+declare const getLinearAxisTitle: ({ numberColumns, aggregated, }: {
+    numberColumns: Columns;
+    aggregated: boolean;
+}) => string;
+declare const getNumberAxisUnits: (numberColumns: any) => any;
+declare const getBinLinearScale: ({ columns, columnIndex, axis, buckets, bins, changeColumnIndices, enableAxisDropdown, innerHeight, innerWidth, height, width, dataFormatting, changeNumberColumnIndices, }: {
+    columns: Columns;
+    columnIndex: number;
+    axis: string;
+    buckets: any[];
+    bins: (string | number)[];
+    changeColumnIndices: Function;
+    enableAxisDropdown: boolean;
+    innerHeight: number;
+    innerWidth: number;
+    height: number;
+    width: number;
+    dataFormatting: DataFormatting;
+    changeNumberColumnIndices: Function;
+}) => any;
+declare const getHistogramScale: ({ axis, buckets, columnIndex, height, width, minValue, maxValue, tickValues, numTicks, stacked, isScaled, columns, columnIndices, changeColumnIndices, dataFormatting, changeNumberColumnIndices, enableAxisDropdown, aggregated, }: {
+    buckets: any[];
+    minValue: number;
+    maxValue: number;
+    axis: string;
+    range: number[];
+    domain: number[];
+    tickValues: number[];
+    numTicks: number;
+    stacked: boolean;
+    isScaled: boolean;
+    columns: Columns;
+    units: string;
+    title: string;
+    columnIndex: number;
+    columnIndices: number[];
+    hasDropdown: boolean;
+    allowMultipleSeries: boolean;
+    changeColumnIndices: Function;
+    disableAutoScale: boolean;
+    dataFormatting: DataFormatting;
+    changeNumberColumnIndices: Function;
+    enableAxisDropdown: boolean;
+    height: number;
+    width: number;
+    aggregated: boolean;
+}) => any;
+declare const getLinearScale: ({ minValue, maxValue, axis, range, domain, tickValues, numTicks, stacked, isScaled, columns, units, title, columnIndex, columnIndices, hasDropdown, allowMultipleSeries, changeColumnIndices, disableAutoScale, dataFormatting, changeNumberColumnIndices, enableAxisDropdown, height, width, aggregated, }: {
+    axis: string;
+    columns: Columns;
+    columnIndex: number;
+    columnIndices: number[];
+    height: number;
+    width: number;
+    units?: string;
+    dataFormatting?: DataFormatting;
+    changeNumberColumnIndices?: Function;
+    enableAxisDropdown?: boolean;
+    stacked?: boolean;
+    isScaled?: boolean;
+    minValue?: number;
+    maxValue?: number;
+    aggregated?: boolean;
+    changeColumnIndices?: Function;
+    numTicks?: number;
+    range?: number[];
+    tickValues?: number[];
+    allowMultipleSeries?: boolean;
+    disableAutoScale?: boolean;
+    hasDropdown?: boolean;
+    domain?: number[];
+    title?: string;
+}) => any;
+declare const getLinearScales: ({ data, columnIndices1, columnIndices2, axis, stacked, isScaled, columns, hasDropdown, allowMultipleSeries, changeColumnIndices, disableAutoScale, dataFormatting, changeNumberColumnIndices, enableAxisDropdown, stringColumnIndex, height, width, aggregated, }: {
+    data: Rows;
+    columnIndices1: number[];
+    columnIndices2: number[];
+    axis: string;
+    stacked: boolean;
+    isScaled: boolean;
+    columns: Columns;
+    hasDropdown: boolean;
+    allowMultipleSeries: boolean;
+    changeColumnIndices: Function;
+    disableAutoScale: boolean;
+    dataFormatting: DataFormatting;
+    changeNumberColumnIndices: Function;
+    enableAxisDropdown: boolean;
+    stringColumnIndex: number;
+    height: number;
+    width: number;
+    aggregated: boolean;
+}) => {
+    scale: any;
+    scale2?: undefined;
+} | {
+    scale: any;
+    scale2: any;
+};
+declare const doesElementOverflowContainer: (element: any, container: any) => boolean;
+declare const DateUTC: (d: any) => Date;
+declare const getNiceDateTickValues: ({ tickValues, scale }: {
+    tickValues: any;
+    scale: any;
+}) => any;
+declare const getNiceTickValues: ({ tickValues, scale }: {
+    tickValues: any;
+    scale: any;
+}) => any;
+declare const getTickSizeFromNumTicks: ({ scale, numTicks, innerPadding, outerPadding, }: {
+    scale: any;
+    numTicks: any;
+    innerPadding?: number;
+    outerPadding?: number;
+}) => number;
+declare const getTickValues: ({ scale, initialTicks, numTicks, innerPadding, outerPadding, }: {
+    scale: any;
+    initialTicks?: (string | number)[];
+    numTicks?: number;
+    innerPadding?: number;
+    outerPadding?: number;
+}) => any;
+declare const mergeBboxes: (boundingBoxes: any) => {
+    x: any;
+    y: any;
+    height: number;
+    width: number;
+};
+
+declare const GENERAL_ERROR = "Uh oh, Our system is experiencing an unexpected error. We're aware of this issue and are working to fix it as soon as possible.";
+declare const GENERAL_QUERY_ERROR = "Internal Service Error: Our system is experiencing an unexpected error. We're aware of this issue and are working to fix it as soon as possible.";
+declare const GENERAL_HTML_ERROR = "Internal Service Error: Our system is experiencing an unexpected error. We're aware of this issue and are working to fix it as soon as possible.";
+declare const UNAUTHENTICATED_ERROR = "Uh oh.. It looks like you don't have access to this resource. Please double check that all required authentication fields are correct.";
+declare const REQUEST_CANCELLED_ERROR = "Request cancelled";
+
+export { AGG_TYPES, AxiosResponse, CHART_TYPES, COMPARE_TYPE, CONTINUOUS_TYPE, CUSTOM_TYPE, Column, Columns, DATA_ALERT_CONDITION_TYPES, DATA_ALERT_ENABLED_STATUSES, DATA_ALERT_FREQUENCY_TYPE_OPTIONS, DATA_ALERT_OPERATORS, DATA_ALERT_STATUSES, DATE_ONLY_CHART_TYPES, DAYJS_PRECISION_FORMATS, DEFAULT_AGG_TYPE, DEFAULT_DATA_PAGE_SIZE, DEFAULT_EVALUATION_FREQUENCY, DEFAULT_SOURCE, DOUBLE_AXIS_CHART_TYPES, DOW_STYLES, DataExplorerTypes, DataFormatting, DateUTC, EVALUATION_FREQUENCY_OPTIONS, EXISTS_TYPE, FilterLock, FrontendReq, GENERAL_ERROR, GENERAL_HTML_ERROR, GENERAL_QUERY_ERROR, GROUP_TERM_TYPE, MAX_DATA_PAGE_SIZE, MAX_LEGEND_LABELS, MIN_HISTOGRAM_SAMPLE, MONTH_DAY_SELECT_OPTIONS, MONTH_NAMES, NUMBER_TERM_TYPE, NumberColumnTypeDisplayNames, NumberColumnTypes, PERIODIC_TYPE, PROJECT_TYPE, PrecisionTypes, QUERY_TERM_TYPE, QueryData, QueryResponse, REQUEST_CANCELLED_ERROR, RESET_PERIOD_OPTIONS, Rows, SCHEDULED_TYPE, SCHEDULE_FREQUENCY_OPTIONS, SCHEDULE_INTERVAL_OPTIONS, SEASON_NAMES, Scale, TABLE_TYPES, TimestampFormats, UNAUTHENTICATED_ERROR, WEEKDAY_NAMES_MON, WEEKDAY_NAMES_SUN, animateInputText, authenticationDefault, autoQLConfigDefault, calculateMinAndMaxSums, capitalizeFirstChar, convertToNumber, currentEventLoopEnd, dataConfigDefault, dataFormattingDefault, dataStructureChanged, dateSortFn, dateStringSortFn, deepEqual, difference, doesElementOverflowContainer, formatChartLabel, formatDateStringType, formatDateType, formatElement, formatEpochDate, formatISODateWithPrecision, formatStringDate, formatStringDateWithPrecision, functionsEqual, getAuthentication, getAutoQLConfig, getBBoxFromRef, getBandScale, getBinLinearScale, getColumnTypeAmounts, getCurrencySymbol, getDataConfig, getDataFormatting, getDateColumnIndex, getDayJSObj, getDayjsObjForStringType, getDefaultDisplayType, getEpochFromDate, getFirstChartDisplayType, getGroupBys, getGroupBysFromPivotTable, getGroupBysFromTable, getGroupableColumns, getHistogramScale, getKey, getKeyByValue, getLegendLabelsForMultiSeries, getLegendLocation, getLinearAxisTitle, getLinearScale, getLinearScales, getMaxValueFromKeyValueObj, getMinAndMaxValues, getMinValueFromKeyValueObj, getNiceDateTickValues, getNiceTickValues, getNumberAxisUnits, getNumberFormatConfig, getNumberOfGroupables, getNumberOfSeries, getObjSize, getPadding, getQueryParams, getRangeForAxis, getSVGBase64, getStringFromSource, getSupportedDisplayTypes, getTickSizeFromNumTicks, getTickValues, getTimeScale, getTooltipContent, getUnitSymbol, getUnitsForColumn, getVisibleColumns, handleTooltipBoundaryCollision, hasData, hasDateColumn, hasNumberColumn, hasStringColumn, invertArray, isAggregation, isChartType, isColumnDateType, isColumnNumberType, isColumnStringType, isDisplayTypeValid, isListQuery, isNumber, isObject, isSingleValueResponse, isTableType, makeEmptyArray, mergeBboxes, mergeSources, nameValueObject, onlySeriesVisibilityChanged, onlyUnique, removeFromDOM, rotateArray, scaleZero, setCaretPosition, shouldLabelsRotate, shouldPlotMultiSeries, sortDataByDate, supports2DCharts, supportsDatePivotTable, supportsPieChart, supportsRegularPivotTable, svgToPng };