autoql-fe-utils 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,3 @@
+declare function sayHello(): void;
+
+export { sayHello };

package/dist/index.d.ts

@@ -0,0 +1,355 @@
+import dayjs from 'dayjs';
+
+declare const TABLE_TYPES: string[];
+declare const CHART_TYPES: string[];
+declare const DATE_ONLY_CHART_TYPES: string[];
+declare const DOUBLE_AXIS_CHART_TYPES: string[];
+declare const MONTH_NAMES: string[];
+declare const DEFAULT_DATA_PAGE_SIZE = 500;
+declare const MAX_DATA_PAGE_SIZE = 5000;
+declare const WEEKDAY_NAMES_MON: string[];
+declare const WEEKDAY_NAMES_SUN: string[];
+declare const DOW_STYLES: string[];
+declare const SEASON_NAMES: string[];
+declare const DAYJS_PRECISION_FORMATS: {
+    DAY: string;
+    MONTH: string;
+    YEAR: string;
+    DATE_HOUR: string;
+    DATE_MINUTE: string;
+};
+declare const DEFAULT_AGG_TYPE = "sum";
+declare const AGG_TYPES: {
+    displayName: string;
+    value: string;
+    unit: string;
+    tooltip: string;
+}[];
+declare const MAX_LEGEND_LABELS = 22;
+declare const MIN_HISTOGRAM_SAMPLE = 20;
+
+declare enum TimestampFormats {
+    epoch = "EPOCH",
+    iso8601 = "ISO8601"
+}
+declare enum PrecisionTypes {
+    DAY = "DAY",
+    MONTH = "MONTH",
+    YEAR = "YEAR",
+    WEEK = "WEEK",
+    QUARTER = "QUARTER",
+    DATE_HOUR = "DATE_HOUR",
+    DATE_MINUTE = "DATE_MINUTE",
+    HOUR = "HOUR",
+    MINUTE = "MINUTE"
+}
+declare enum NumberColumnTypes {
+    CURRENCY = "DOLLAR_AMT",
+    QUANTITY = "QUANTITY",
+    RATIO = "RATIO",
+    PERCENT = "PERCENT"
+}
+declare enum NumberColumnTypeDisplayNames {
+    DOLLAR_AMT = "Currency",
+    QUANTITY = "Quantity",
+    RATIO = "Ratio",
+    PERCENT = "Percent"
+}
+
+interface Column {
+    dow_style: string;
+    type: string;
+    groupable: boolean;
+    precision: string;
+    name: string;
+    display_name: string;
+    is_visible: boolean;
+    multi_series: boolean;
+    aggType?: string;
+    title?: string;
+}
+type Columns = Column[];
+interface FilterLock {
+    filter_type: string;
+    key: string;
+    value: string;
+    show_message: string;
+}
+interface FrontendReq {
+    session_locked_conditions: Object;
+    page_size: number;
+    debug: false;
+    disambiguation: any[];
+    chart_images: string;
+    orders: any[];
+    filters: any[];
+    translation: string;
+    text: string;
+    date_format: string;
+    scope: string;
+    source: string;
+    test: boolean;
+    session_filter_locks: any[];
+    v2_dates: number;
+    persistent_filter_locks: FilterLock[];
+}
+type Rows = Array<Array<string | number>>;
+interface QueryData {
+    session_locked_conditions: any[];
+    count_rows: number;
+    fe_req: FrontendReq;
+    query_id: string;
+    row_limit: number;
+    rows: Rows;
+    chart_images: null;
+    display_type: string;
+    columns: Columns;
+    interpretation: string;
+    text: string;
+    parsed_interpretation: Object[];
+    persistent_locked_conditions: any[];
+    condition_filter: any[];
+    sql: any[];
+}
+interface QueryResponse {
+    data: QueryData;
+    message: string;
+    reference_id: string;
+}
+interface AxiosResponse {
+    data: QueryResponse;
+}
+interface DataFormatting {
+    timestampFormat: TimestampFormats;
+    currencyCode: string;
+    languageCode: string;
+    currencyDecimals: number;
+    quantityDecimals: number;
+    ratioDecimals: number;
+    comparisonDisplay: string;
+    monthYearFormat: string;
+    dayMonthYearFormat: string;
+}
+interface Scale {
+}
+
+declare const authenticationDefault: {
+    token: any;
+    apiKey: any;
+    domain: any;
+    dprKey: any;
+    dprDomain: any;
+};
+declare const dataFormattingDefault: {
+    timestampFormat: TimestampFormats;
+    currencyCode: string;
+    languageCode: string;
+    currencyDecimals: number;
+    quantityDecimals: number;
+    ratioDecimals: number;
+    comparisonDisplay: string;
+    monthYearFormat: string;
+    dayMonthYearFormat: string;
+};
+declare const autoQLConfigDefault: {
+    debug: boolean;
+    test: boolean;
+    enableAutocomplete: boolean;
+    enableQueryInterpretation: boolean;
+    enableQueryValidation: boolean;
+    enableQuerySuggestions: boolean;
+    enableColumnVisibilityManager: boolean;
+    enableDrilldowns: boolean;
+    enableNotifications: boolean;
+    enableCSVDownload: boolean;
+    enableReportProblem: boolean;
+};
+declare const dataConfigDefault: {
+    stringColumnIndices: any[];
+    numberColumnIndices: any[];
+    stringColumnIndex: number;
+    legendColumnIndex: any;
+    numberColumnIndex: number;
+};
+declare const getAuthentication: (prop?: {}) => {
+    token: any;
+    apiKey: any;
+    domain: any;
+    dprKey: any;
+    dprDomain: any;
+};
+declare const getDataFormatting: (prop?: {}) => DataFormatting;
+declare const getAutoQLConfig: (prop?: {}) => {
+    debug: boolean;
+    test: boolean;
+    enableAutocomplete: boolean;
+    enableQueryInterpretation: boolean;
+    enableQueryValidation: boolean;
+    enableQuerySuggestions: boolean;
+    enableColumnVisibilityManager: boolean;
+    enableDrilldowns: boolean;
+    enableNotifications: boolean;
+    enableCSVDownload: boolean;
+    enableReportProblem: boolean;
+};
+declare const getDataConfig: (prop?: {}) => {
+    stringColumnIndices: any[];
+    numberColumnIndices: any[];
+    stringColumnIndex: number;
+    legendColumnIndex: any;
+    numberColumnIndex: number;
+};
+
+declare const isColumnNumberType: (col: any) => boolean;
+declare const isColumnStringType: (col: any) => boolean;
+declare const isColumnDateType: (col: any) => boolean;
+declare const hasNumberColumn: (columns: any) => boolean;
+declare const hasStringColumn: (columns: any) => boolean;
+declare const hasDateColumn: (columns: any) => boolean;
+declare const getVisibleColumns: (columns: any) => Columns;
+declare const getGroupableColumns: (columns: any) => any[];
+declare const getGroupBys: (row: any, columns: any) => {
+    groupBys: any[];
+    supportedByAPI: boolean;
+};
+declare const getGroupBysFromTable: (cell: any, tableColumns: any) => any[];
+declare const getGroupBysFromPivotTable: ({ cell, rowHeaders, columnHeaders, rowHeaderDefinition, columnHeaderDefinition, }: {
+    cell: any;
+    rowHeaders: any;
+    columnHeaders: any;
+    rowHeaderDefinition: any;
+    columnHeaderDefinition: any;
+}) => {
+    name: any;
+    value: string;
+}[];
+declare const isAggregation: (columns: any) => boolean;
+declare const getColumnTypeAmounts: (columns: any) => {
+    amountOfNumberColumns: number;
+    amountOfStringColumns: number;
+};
+declare const getDateColumnIndex: (columns: any) => any;
+declare const getNumberOfGroupables: (columns: any) => number;
+declare const isListQuery: (columns: any) => boolean;
+
+declare const formatStringDateWithPrecision: (value: any, col: any) => any;
+declare const formatStringDate: (value: any, config?: DataFormatting) => any;
+declare const formatDateType: (element: any, column: Column, config?: DataFormatting) => any;
+declare const formatDateStringType: (element: any, column: Column, config?: DataFormatting) => any;
+declare const formatISODateWithPrecision: (value: any, col: Column, config?: DataFormatting) => any;
+declare const formatEpochDate: (value: any, col: Column, config?: DataFormatting) => any;
+declare const dateStringSortFn: (a: any, b: any, col: Column) => number;
+declare const dateSortFn: (a: any, b: any, col: Column, isTable: any) => number;
+declare const sortDataByDate: (data: any, tableColumns: any, sortDirection: string, isTable: any) => any;
+interface formatElementParams {
+    element: string | number;
+    column: Column;
+    config: DataFormatting;
+    htmlElement?: HTMLElement;
+    isChart?: boolean;
+}
+declare const formatElement: ({ element, column, config, htmlElement, isChart, }: formatElementParams) => string | number;
+declare const getNumberFormatConfig: (d: any, scale: any) => {
+    minimumFractionDigits: number;
+    maximumFractionDigits: number;
+    notation: any;
+};
+declare const formatChartLabel: ({ d, scale, column, dataFormatting, maxLabelWidth }: {
+    d: any;
+    scale: any;
+    column: any;
+    dataFormatting: any;
+    maxLabelWidth: any;
+}) => {
+    fullWidthLabel: any;
+    formattedLabel: any;
+};
+declare const getCurrencySymbol: (dataFormatting?: {
+    timestampFormat: TimestampFormats;
+    currencyCode: string;
+    languageCode: string;
+    currencyDecimals: number;
+    quantityDecimals: number;
+    ratioDecimals: number;
+    comparisonDisplay: string;
+    monthYearFormat: string;
+    dayMonthYearFormat: string;
+}) => string;
+declare const getDayjsObjForStringType: (value: any, col: any) => dayjs.Dayjs;
+declare const getDayJSObj: ({ value, column }: {
+    value: any;
+    column: any;
+}) => dayjs.Dayjs;
+declare const getEpochFromDate: (date: any, precision?: any, precisionFrame?: any) => any;
+
+interface getSupportedDisplayTypesParams {
+    response?: AxiosResponse;
+    columns?: Columns;
+    dataLength?: number;
+    pivotDataLength?: number;
+    isDataLimited?: boolean;
+}
+declare const isChartType: (type: any) => boolean;
+declare const isTableType: (type: any) => boolean;
+declare const isDisplayTypeValid: (response: AxiosResponse, displayType: string, dataLength: number, pivotDataLength: number, columns: Columns, isDataLimited: boolean) => boolean;
+declare const shouldPlotMultiSeries: (columns: any) => boolean;
+declare const supportsPieChart: (columns: any, chartData: any) => boolean;
+declare const supports2DCharts: (columns: any, dataLength: any) => boolean;
+declare const supportsRegularPivotTable: (columns: any, dataLength: any, data: any) => boolean;
+declare const supportsDatePivotTable: (columns: any) => boolean;
+declare const isSingleValueResponse: (response: any) => boolean;
+declare const getSupportedDisplayTypes: ({ response, columns, dataLength, pivotDataLength, isDataLimited, }?: getSupportedDisplayTypesParams) => string[];
+declare const getFirstChartDisplayType: (supportedDisplayTypes: any, fallback: any) => any;
+declare const getDefaultDisplayType: (response?: AxiosResponse, defaultToChart?: boolean, columns?: Columns, dataLength?: number, pivotDataLength?: number, preferredDisplayType?: string, isDataLimited?: boolean) => string;
+declare const hasData: (response: any) => any;
+
+declare const currentEventLoopEnd: () => Promise<unknown>;
+declare const animateInputText: ({ text, inputRef, callback, totalAnimationTime }: {
+    text?: string;
+    inputRef: any;
+    callback?: () => void;
+    totalAnimationTime?: number;
+}) => Promise<void>;
+declare const handleTooltipBoundaryCollision: (e: any, self: any) => void;
+declare const removeFromDOM: (elem: any) => void;
+declare const setCaretPosition: (elem: any, caretPos: any) => void;
+declare const getPadding: (element: any) => {
+    left: number;
+    right: number;
+    top: number;
+    bottom: number;
+};
+declare const getQueryParams: (url: any) => {};
+/**
+ * converts an svg string to base64 png using the domUrl
+ * @param {string} svgElement the svgElement
+ * @param {number} [margin=0] the width of the border - the image size will be height+margin by width+margin
+ * @param {string} [fill] optionally backgrund canvas fill
+ * @return {Promise} a promise to the bas64 png image
+ */
+declare const svgToPng: (svgElement: any, scale?: number) => Promise<unknown>;
+declare const getBBoxFromRef: (ref: any) => any;
+declare const getSVGBase64: (svgElement: any) => string;
+
+declare const nameValueObject: (name: any, value: any) => {
+    name: any;
+    value: any;
+};
+declare const getKeyByValue: (object: any, value: any) => string;
+
+declare const getStringFromSource: (source: string | number | Array<string>) => string | null;
+declare const mergeSources: (source: string | number | Array<string>, newSource: string | number | Array<string>) => string | null;
+
+declare const capitalizeFirstChar: (string: any) => any;
+declare const isNumber: (str: any) => boolean;
+
+declare const invertArray: (array: any[]) => any[];
+declare const functionsEqual: (a: Function, b: Function) => boolean;
+declare const isObject: (obj: any) => boolean;
+declare const deepEqual: (objA: Object, objB: Object) => boolean;
+declare const difference: (objA: Object, objB: Object) => any[];
+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 };