@vizzly/dashboard 0.7.3 → 0.7.4-dev-396503edb3f72dee2437663fb8b8398a998ed90b

package/dist/results-driver/src/utils/runWithValidationAndCaching.d.ts

@@ -1,4 +1,4 @@
 import { PreparedQuery } from "../../../shared-logic/src/Query/types";
 /** A generic function to validate a list of queries, and then only run the ones which are valid. */
-declare const runWithValidationAndCaching: <Query, Result>(queries: (import("../../../shared-logic/src/Query/types").UniqueArrayValuesQuery | Query)[], isRunnable: (query: import("../../../shared-logic/src/Query/types").UniqueArrayValuesQuery | Query) => boolean, run: (queries: (import("../../../shared-logic/src/Query/types").UniqueArrayValuesQuery | Query)[]) => Promise<(Result | null)[] | null>, cacheKey: (query: import("../../../shared-logic/src/Query/types").UniqueArrayValuesQuery | Query) => any) => Promise<(Result | null)[] | null>;
+declare const runWithValidationAndCaching: <Query, Result>(queries: (import("../../../shared-logic/src/Query/types").UniqueArrayValuesQuery | import("../../../shared-logic/src/Query/types").PreAggregatedQuery | Query)[], isRunnable: (query: import("../../../shared-logic/src/Query/types").UniqueArrayValuesQuery | import("../../../shared-logic/src/Query/types").PreAggregatedQuery | Query) => boolean, run: (queries: (import("../../../shared-logic/src/Query/types").UniqueArrayValuesQuery | import("../../../shared-logic/src/Query/types").PreAggregatedQuery | Query)[]) => Promise<(Result | null)[] | null>, cacheKey: (query: import("../../../shared-logic/src/Query/types").UniqueArrayValuesQuery | import("../../../shared-logic/src/Query/types").PreAggregatedQuery | Query) => any) => Promise<(Result | null)[] | null>;
 export default runWithValidationAndCaching;

package/dist/shared-logic/src/AdditionalFilter/types.d.ts

@@ -32,6 +32,7 @@ declare type BaseAdditionalFilter<T extends AdditionalFilterType> = {
     requiresValue: boolean;
     title?: string;
     optionsFilters?: OptionalFilters;
+    hidden?: boolean;
 };
 declare type FixedRangeValue = {
     type: 'fixedRange';

package/dist/shared-logic/src/Component/sharedSchemas.d.ts

@@ -43,6 +43,7 @@ export declare const protectedFieldsDimension: (queryEngineConfig: QueryEngineCo
 export declare const parametersSchema: (queryEngineConfig: QueryEngineConfig, attributeSchemaOptions: ComponentInterfaceConfig['attributesSchemaOptions']) => Joi.ObjectSchema<any>;
 export declare const goalLineSchema: () => Joi.ObjectSchema<any>;
 export declare const goalLinesSchema: () => Joi.ArraySchema<any[]>;
+export declare const headlineSchema: () => Joi.ObjectSchema<any>;
 export declare const axisTitleSchema: () => Joi.ObjectSchema<any>;
 export declare const sizingSchema: Joi.ObjectSchema<any>;
 export declare const conditionalFormattingRulesSchema: (queryEngineConfig: QueryEngineConfig) => Joi.ArraySchema<any[]>;

package/dist/shared-logic/src/Component/types.d.ts

@@ -60,6 +60,7 @@ export declare namespace Component {
         parameters?: Parameters;
         goalLines?: Array<Component.GoalLine.Rule>;
         axisTitles?: AxisTitles;
+        headline?: Headline;
     };
     export type CustomComponentAttributes = BaseAttributes & {
         type: 'custom';
@@ -69,6 +70,10 @@ export declare namespace Component {
         x?: string;
         y?: string;
     };
+    export type HeadlineFunction = 'mean' | 'sum' | 'current' | null;
+    export type Headline = {
+        func?: HeadlineFunction;
+    };
     export type HorizontalBarChartAttributes = Omit<BarChartAttributes, 'type'> & {
         type: 'horizontalBarChart';
         conditionalFormattingRules: Array<ConditionalFormatting.Rule>;
@@ -92,6 +97,7 @@ export declare namespace Component {
         goalLines?: Array<Component.GoalLine.Rule>;
         conditionalFormattingRules?: {
             bar?: Array<ConditionalFormatting.Rule>;
+            line?: Array<ConditionalFormatting.Rule>;
         };
         axisTitles?: AxisTitles;
     };
@@ -113,6 +119,7 @@ export declare namespace Component {
         parameters?: Parameters;
         goalLines?: Array<Component.GoalLine.Rule>;
         axisTitles?: AxisTitles;
+        headline?: Headline;
     };
     export type PieChartAttributes = BaseAttributes & BaseQueryAttributes & {
         type: 'pieChart';
@@ -140,6 +147,7 @@ export declare namespace Component {
         parameters?: Parameters;
         goalLines?: Array<Component.GoalLine.Rule>;
         axisTitles?: AxisTitles;
+        headline?: Headline;
     };
     export namespace ConditionalFormatting {
         type Rule = {

package/dist/shared-logic/src/ComponentInterface/types/namespaces.types.d.ts

@@ -93,12 +93,14 @@ export interface FormatPanelNamespaces {
     };
     goal_line?: Section<'goalLine'>;
     map_colors?: Section<'mapColors'>;
+    headline?: Section<'headline'>;
     prefixes?: Section<'prefixes'>;
     conditional_formatting?: Section<'conditionalFormatting'> & {
         subSectionDefinition?: {
             bar: SubSection<'stacked'>;
+            line: SubSection<'stacked'>;
         };
     };
 }
-export declare type ComponentNamespace = 'pivot_table' | 'horizontal_bar_chart' | 'bar_chart' | 'area_chart' | 'line_chart' | 'scatter_chart' | 'pie_chart' | 'single_stat' | 'basic_table' | 'combo_chart' | 'mercator_map' | 'custom' | 'fields' | 'progress';
+export declare type ComponentNamespace = 'pivot_table' | 'horizontal_bar_chart' | 'bar_chart' | 'area_chart' | 'line_chart' | 'scatter_chart' | 'pie_chart' | 'single_stat' | 'basic_table' | 'combo_chart' | 'mercator_map' | 'custom' | 'fields' | 'progress' | 'headline';
 export {};

package/dist/shared-logic/src/DashboardAPI/types.d.ts

@@ -4,6 +4,7 @@ export declare type VizzlyDashboard = {
     id: Dashboard['id'];
     parentDashboardId: Dashboard['parentDashboardId'] | undefined;
     display: Dashboard['display'];
+    globalFilters: Dashboard['globalFilters'];
     componentLibrary: Dashboard['componentLibrary'];
     createdAt: Dashboard['createdAt'];
     updatedAt: Dashboard['updatedAt'];

package/dist/shared-logic/src/DataSet/DataSet.d.ts

@@ -1,7 +1,7 @@
 import { DataSet } from './types';
 import { CustomField, SimpleMathField } from '../CustomField/types';
 import { DateTimeField, NonDateTimeField } from '../Field/types';
-import { Query } from '../Query/types';
+import { PreAggregatedQuery, Query } from '../Query/types';
 import * as Field from '../Field/Field';
 import FieldNotFoundInDataSet from '../errors/FieldNotFoundInDataSet';
 import { QueryAttributes } from '../QueryAttributes/types';
@@ -42,6 +42,6 @@ export declare const findRemovedFieldsBetweenDataSets: (previousDataSets: DataSe
 export declare const findRemovedFields: (original: DataSet, latest: DataSet) => Array<DataSet.Field>;
 export declare const buildQueryAttributes: (dataSet: DataSet, queryEngineConfig: QueryEngineConfig, componentType: ComponentType) => QueryAttributes;
 export declare const buildDownloadQuery: (dataSet: DataSet, maxCSVDownloadLimit: number, viewFilters: QueryAttributes['filter']) => QueryAttributes;
-export declare const buildViewOnlyQuery: (dataSet: DataSet) => QueryAttributes;
+export declare const buildViewOnlyQuery: (dataSet: DataSet) => PreAggregatedQuery;
 export declare const addCustomFields: (dataSets: Array<DataSet>, customFields: RawDashboard['definition']['customFields']) => Array<DataSet>;
 export declare const validId: (id: string, dataSet: DataSet[]) => boolean;

package/dist/shared-logic/src/DataSet/types.d.ts

@@ -9,7 +9,7 @@ export declare type DataSet = {
     name: string;
     description?: string;
     fields: DataSet.Field[];
-    preAggregated?: boolean;
+    preAggregated?: undefined | false | string[];
 };
 export declare type FieldFilterOptions = {
     removeSimplePercentage?: boolean;

package/dist/shared-logic/src/FeatureToggle/types.d.ts

@@ -26,4 +26,5 @@ export declare type FeatureToggles = {
      * @default true */
     showDateFilter: boolean;
     canSeeEmptyState: boolean;
+    canDownloadPDF: boolean;
 };

package/dist/shared-logic/src/FormatPanelConfig/types.d.ts

@@ -26,11 +26,12 @@ export declare type AxisLabelsSection = Section<'axisLabels'> & {
 export declare type LabelsSection = Section<'statsLabels'> & LabelSection<'statsLabels'>;
 export declare type PrefixSection = Section<'prefixes'>;
 export declare type MapColorsSection = Section<'mapColors'>;
+export declare type HeadlineSection = Section<'headline'>;
 export interface ConditionalFormattingSection extends Section<'conditionalFormatting'> {
     ruleType: FormattingRuleType;
     subSection?: {
         title: string;
-        propKey: 'bar';
+        propKey: 'bar' | 'line';
     }[];
 }
 export interface GoalLineSection extends Section<'goalLine'> {
@@ -39,5 +40,5 @@ export interface ProgressTypeSection<T> extends Omit<Section<T>, 'type'> {
     progressType?: Omit<Section<T>, 'type'>;
 }
 export declare type ProgressTypesSection = Section<'progressType'> & ProgressTypeSection<'progressType'>;
-export declare type FormatPanelSection = HeadingSection | FormatSection | ChartStylesSection | PrefixSection | AxisLabelsSection | LabelsSection | MapColorsSection | ConditionalFormattingSection | GoalLineSection | ProgressTypesSection;
+export declare type FormatPanelSection = HeadingSection | FormatSection | ChartStylesSection | PrefixSection | AxisLabelsSection | LabelsSection | MapColorsSection | ConditionalFormattingSection | GoalLineSection | ProgressTypesSection | HeadlineSection;
 export declare type FormatPanelConfig = Array<FormatPanelSection>;

package/dist/shared-logic/src/Headline/index.d.ts

@@ -0,0 +1,5 @@
+import { DataSet as DataSetType } from '../DataSet/types';
+import { QueryAttributes } from '../QueryAttributes/types';
+import { SupportedAggregates } from '../Aggregate';
+import { Component } from '../Component/types';
+export declare function measureIsSuitableFunc(dataSet: DataSetType, item: QueryAttributes.Measure, supportedAggregates: SupportedAggregates, includes?: Component.HeadlineFunction): boolean;

package/dist/shared-logic/src/IdentityConfig/types.d.ts

@@ -18,6 +18,7 @@ export declare type DataAccessConfig = {
     secureFilters: {
         [dataSetId: string]: QueryAttributes.Filter[];
     };
+    parameters?: Object;
     expires: string;
     signature: string;
 };

package/dist/shared-logic/src/PDFGenerator/constants.d.ts

@@ -0,0 +1,3 @@
+import { ConversionOptions } from './types';
+export declare const MM_TO_PX = 3.77952755906;
+export declare const DEFAULT_OPTIONS: Readonly<ConversionOptions>;

package/dist/shared-logic/src/PDFGenerator/converter.d.ts

@@ -0,0 +1,36 @@
+import jsPDF from 'jspdf';
+import { ConversionOptions, Options } from './types';
+export default class Converter {
+    pdf: InstanceType<typeof jsPDF>;
+    canvas: HTMLCanvasElement;
+    options: Options;
+    constructor(canvas: HTMLCanvasElement, options: ConversionOptions);
+    getMarginTopMM(): number;
+    getMarginLeftMM(): number;
+    getMarginRightMM(): number;
+    getMarginBottomMM(): number;
+    getMarginTop(): number;
+    getMarginBottom(): number;
+    getMarginLeft(): number;
+    getMarginRight(): number;
+    getScale(): number;
+    getPageHeight(): number;
+    getPageHeightMM(): number;
+    getPageWidthMM(): number;
+    getPageWidth(): number;
+    getOriginalCanvasWidth(): number;
+    getOriginalCanvasHeight(): number;
+    getCanvasPageAvailableHeight(): number;
+    getPageAvailableWidth(): number;
+    getPageAvailableHeight(): number;
+    getPageAvailableWidthMM(): number;
+    getPageAvailableHeightMM(): number;
+    getNumberPages(): number;
+    getHorizontalFitFactor(): number;
+    getCanvasOffsetY(pageNumber: number): number;
+    getCanvasHeightLeft(pageNumber: number): number;
+    getCanvasPageHeight(pageNumber: number): number;
+    getCanvasPageWidth(): number;
+    createCanvasPage(pageNumber: number): HTMLCanvasElement;
+    convert(): InstanceType<typeof jsPDF>;
+}

package/dist/shared-logic/src/PDFGenerator/index.d.ts

@@ -0,0 +1,17 @@
+import { Options, TargetElementFinder } from './types';
+import jsPDF from 'jspdf';
+export type { Options };
+export declare const generatePDF: (targetRefOrFunction: TargetElementFinder, customOptions?: (Pick<Partial<import("./types").ConversionOptions>, "filename" | "method" | "resolution"> & {
+    page?: Partial<import("./types").PageConversionOptions> | undefined;
+    canvas?: Partial<Pick<import("html2canvas").Options, "useCORS" | "logging"> & {
+        mimeType: "image/jpeg" | "image/png";
+        qualityRatio: number;
+    }> | undefined;
+    overrides?: Partial<{
+        pdf?: Partial<import("jspdf").jsPDFOptions> | undefined;
+        canvas?: Partial<import("html2canvas").Options> | undefined;
+    }> | undefined;
+} & {
+    header?: TargetElementFinder | undefined;
+}) | undefined) => Promise<InstanceType<typeof jsPDF>>;
+export default generatePDF;

package/dist/shared-logic/src/PDFGenerator/types.d.ts

@@ -0,0 +1,91 @@
+import { jsPDFOptions } from 'jspdf';
+import { Options as Html2CanvasOptions } from 'html2canvas';
+export declare type PDFSettings = {
+    header?: string;
+};
+export declare type DetailedMargin = {
+    top: Margin | number;
+    right: Margin | number;
+    bottom: Margin | number;
+    left: Margin | number;
+};
+export declare type Orientation = jsPDFOptions['orientation'];
+export declare type PageConversionOptions = {
+    /** Margin of the page in MM, defaults to 0. */
+    margin: DetailedMargin | Margin | number;
+    /** Format of the page (A4, letter), defaults to A4. */
+    format: jsPDFOptions['format'];
+    /** Orientation of the page (portrait or landscape), defaults to `portrait`. */
+    orientation: Orientation;
+};
+declare type CanvasConversionOptions = Pick<Html2CanvasOptions, 'useCORS' | 'logging'> & {
+    /**
+     * Mime type of the canvas captured from the screenshot, defaults to
+     * 'image/jpeg' for better size performance.
+     * See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toDataURL
+     */
+    mimeType: 'image/jpeg' | 'image/png';
+    /**
+     * Quality ratio of the canvas captured from the screenshot
+     * See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toDataURL
+     */
+    qualityRatio: number;
+};
+export declare type ConversionOptions = {
+    /**
+     * File name of the PDF file if the method select is `save`, which is the
+     * default. Not used for the `build` and `open` methods. *
+     */
+    filename?: string;
+    /**
+     * Method that will follow to do with the PDF file. The `build` method just
+     * returns the PDF instance in the invoked function `generatePDF` or `toPDF`.
+     * By default is `open`.
+     */
+    method: 'save' | 'open' | 'build';
+    /**
+     * Resolution in a scale where 1 gives a low resolution and possible blurred
+     * image, 3 a medium and 10 an extreme quality. The size of the file increases
+     * as the resolution is higher. Not recommended to use extreme resolution, e.g
+     * '>= 10' for multiple pages otherwise this can make the browser cache hang
+     * or crash, due to the size of the image generated for the PDF.
+     */
+    resolution: Resolution | number;
+    /** Page options */
+    page: PageConversionOptions;
+    /** Canvas options */
+    canvas: CanvasConversionOptions;
+    /** Override values passed for the jsPDF document and html2canvas */
+    overrides: {
+        /**
+         * Override the values passed for the jsPDF instance. See its docs for more details
+         * in https://artskydj.github.io/jsPDF/docs/jsPDF.html.
+         * */
+        pdf?: Partial<jsPDFOptions>;
+        /**
+         * Override the values passed for the html2canvas function. See its docs
+         * for more details in https://html2canvas.hertzen.com/documentation
+         * */
+        canvas?: Partial<Html2CanvasOptions>;
+    };
+};
+export declare type Options = Omit<Partial<ConversionOptions>, 'page' | 'canvas' | 'overrides'> & {
+    page?: Partial<PageConversionOptions>;
+    canvas?: Partial<CanvasConversionOptions>;
+    overrides?: Partial<ConversionOptions['overrides']>;
+};
+export declare type TargetElementFinder = () => HTMLElement | null;
+export declare enum Resolution {
+    LOW = 1,
+    NORMAL = 2,
+    MEDIUM = 3,
+    HIGH = 7,
+    EXTREME = 12
+}
+export declare enum Margin {
+    NONE = 0,
+    SMALL = 5,
+    MEDIUM = 10,
+    LARGE = 25
+}
+export {};

package/dist/shared-logic/src/PDFGenerator/utils.d.ts

@@ -0,0 +1,2 @@
+import { ConversionOptions, Options } from './types';
+export declare const buildConvertOptions: (options?: Options | undefined) => ConversionOptions;

package/dist/shared-logic/src/Query/Query.d.ts

@@ -1,4 +1,4 @@
-import { PreparedQuery, Query, SubQuery } from './types';
+import { PreAggregatedQuery, PreparedQuery, Query, SubQuery } from './types';
 import { QueryAttributes } from '../QueryAttributes/types';
 import { QueryEngineConfig, SupportedFeature as SupportedFeatureType } from '../QueryEngineConfig/types';
 import { DataSet } from '../DataSet/types';
@@ -19,7 +19,11 @@ export declare const hasDimensions: (query: {
     group: Query['group'];
 }) => boolean;
 export declare const getMeasures: (query: Query) => Query['measure'];
-export declare const buildPreparedQuery: (dataSetId: string, dataSetField: DataSet['fields'][number], optionsFilters?: import("./types").QueryNameSpace.Filter<import("./types").QueryNameSpace.FieldDefinition<string, string, string>, string>[][] | undefined) => {
+export declare const buildPreAggregatedPreparedQuery: (query: PreAggregatedQuery, dataSet: DataSet) => {
+    query: PreAggregatedQuery;
+    resultFields: Result.Field[];
+};
+export declare const buildUniqueArrayValuesPreparedQuery: (dataSetId: string, dataSetField: DataSet['fields'][number], optionsFilters?: import("./types").QueryNameSpace.Filter<import("./types").QueryNameSpace.FieldDefinition<string, string, string>, string>[][] | undefined) => {
     query: PreparedQuery;
     resultFields: Result.Field[];
 };

package/dist/shared-logic/src/Query/types.d.ts

@@ -99,7 +99,13 @@ export declare type UniqueArrayValuesQuery = BasePreparedQuery<'uniqueArrayValue
     fieldId: string;
     filter: Query['filter'];
 };
-export declare type PreparedQuery = UniqueArrayValuesQuery;
+export declare type PreAggregatedQuery = BasePreparedQuery<'preAggregated'> & {
+    dataSetId: string;
+    filter: {
+        [dataSetId: string]: Query['filter'];
+    };
+};
+export declare type PreparedQuery = UniqueArrayValuesQuery | PreAggregatedQuery;
 /** Most commonly used query format. */
 export declare type Query<SupportedFunction = string, ComparisonOperator = string, MathsOp = string> = {
     type: 'query';

package/dist/shared-logic/src/QueryEngineConfig/types.d.ts

@@ -2,7 +2,7 @@ import { SupportedAggregates } from '../Aggregate';
 import { SupportedTimeTruncFunctions } from '../TimeDimension/types';
 import { SupportedOperators } from '../QueryAttributes/types';
 import { SupportedTransformationFunctions } from '../Functions/types';
-export declare type SupportedFeature = 'subquery' | 'simpleMaths' | 'aggregateMaths' | 'switchField' | 'configManagerUi' | 'roundedNumbers' | 'sqlDefinedDataSet' | 'encryptedDashboards';
+export declare type SupportedFeature = 'subquery' | 'simpleMaths' | 'aggregateMaths' | 'switchField' | 'configManagerUi' | 'roundedNumbers' | 'sqlDefinedDataSet' | 'encryptedDashboards' | 'sqlViews';
 export declare type QueryEngineConfig = {
     origin?: 'in-browser' | 'query-engine' | 'custom';
     supportedFeatures: SupportedFeature[];

package/dist/shared-logic/src/SQLViews/index.d.ts

@@ -0,0 +1,11 @@
+export declare const findUsedDataSets: (sql: string | undefined, dataSets: Array<{
+    name: string;
+    id: string;
+}>) => {
+    id: string;
+    name: string;
+}[];
+export declare const usedDataSetDescription: (usedDataSets: Array<{
+    id: string;
+    name: string;
+}>) => string;

package/dist/shared-logic/src/SQLViews/types.d.ts

@@ -0,0 +1,7 @@
+export declare type SqlViewStore = {
+    [sqlViewId: string]: SqlView;
+};
+export declare type SqlView = {
+    sql: string;
+    name: string;
+};

package/dist/shared-logic/src/SimpleInsecureHash/index.d.ts

@@ -0,0 +1 @@
+export declare const simpleInsecureHash: (str: string, prefix: 'data_set' | 'field') => string;

package/dist/shared-logic/src/Theme/types.d.ts

@@ -297,6 +297,8 @@ export declare namespace VizzlyTheming {
         axisTitles?: ChartAxisTitle;
         grid?: ChartGrid;
         axis?: ChartAxis;
+        pie?: Pie;
+        barChart?: BarChart;
     };
     interface ViewText extends FontStyle {
         textAlign?: CSSProperties['textAlign'];
@@ -479,10 +481,23 @@ export declare namespace VizzlyTheming {
         };
     };
     type Icons = {
+        borderRadius?: CSSProperties['borderRadius'];
         color?: CSSProperties['color'];
+        padding?: CSSProperties['padding'];
+        width?: CSSProperties['width'];
+        height?: CSSProperties['height'];
         '&:hover'?: {
             color?: CSSProperties['color'];
+            background?: CSSProperties['background'];
         };
     };
+    type Pie = {
+        cornerRadius?: number;
+        gap?: boolean;
+        hole?: boolean;
+    };
+    type BarChart = {
+        cornerRadius?: number;
+    };
 }
 export declare type ThemeVersion = 1 | 2;

package/dist/shared-logic/src/Threshold/threshold.utils.d.ts

@@ -0,0 +1,10 @@
+import { Component } from '../Component/types';
+declare type ThresholdDirecton = '>=' | '<=';
+declare type ThresholdType = {
+    key: string;
+    value: number;
+    color: string;
+    direction: ThresholdDirecton;
+};
+export declare const buildThreshold: (formatting?: Component.ConditionalFormatting.Rule[] | undefined) => ThresholdType[];
+export {};