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

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

@@ -32,6 +32,7 @@ type BaseAdditionalFilter<T extends AdditionalFilterType> = {
     requiresValue: boolean;
     title?: string;
     optionsFilters?: OptionalFilters;
+    hidden?: boolean;
 };
 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 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 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 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 type DataSet = {
     name: string;
     description?: string;
     fields: DataSet.Field[];
-    preAggregated?: boolean;
+    preAggregated?: undefined | false | string[];
 };
 export type FieldFilterOptions = {
     removeSimplePercentage?: boolean;

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

@@ -26,11 +26,12 @@ export type AxisLabelsSection = Section<'axisLabels'> & {
 export type LabelsSection = Section<'statsLabels'> & LabelSection<'statsLabels'>;
 export type PrefixSection = Section<'prefixes'>;
 export type MapColorsSection = Section<'mapColors'>;
+export 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 type ProgressTypesSection = Section<'progressType'> & ProgressTypeSection<'progressType'>;
-export type FormatPanelSection = HeadingSection | FormatSection | ChartStylesSection | PrefixSection | AxisLabelsSection | LabelsSection | MapColorsSection | ConditionalFormattingSection | GoalLineSection | ProgressTypesSection;
+export type FormatPanelSection = HeadingSection | FormatSection | ChartStylesSection | PrefixSection | AxisLabelsSection | LabelsSection | MapColorsSection | ConditionalFormattingSection | GoalLineSection | ProgressTypesSection | HeadlineSection;
 export type FormatPanelConfig = Array<FormatPanelSection>;

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

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

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';
@@ -20,7 +20,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?: Query['filter']) => {
+export declare const buildPreAggregatedPreparedQuery: (query: PreAggregatedQuery, dataSet: DataSet) => {
+    query: PreAggregatedQuery;
+    resultFields: Result.Field[];
+};
+export declare const buildUniqueArrayValuesPreparedQuery: (dataSetId: string, dataSetField: DataSet['fields'][number], optionsFilters?: Query['filter']) => {
     query: PreparedQuery;
     resultFields: Result.Field[];
 };

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

@@ -99,7 +99,13 @@ export type UniqueArrayValuesQuery = BasePreparedQuery<'uniqueArrayValues'> & {
     fieldId: string;
     filter: Query['filter'];
 };
-export type PreparedQuery = UniqueArrayValuesQuery;
+export type PreAggregatedQuery = BasePreparedQuery<'preAggregated'> & {
+    dataSetId: string;
+    filter: {
+        [dataSetId: string]: Query['filter'];
+    };
+};
+export type PreparedQuery = UniqueArrayValuesQuery | PreAggregatedQuery;
 /** Most commonly used query format. */
 export 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 type SupportedFeature = 'subquery' | 'simpleMaths' | 'aggregateMaths' | 'switchField' | 'configManagerUi' | 'roundedNumbers' | 'sqlDefinedDataSet' | 'encryptedDashboards';
+export type SupportedFeature = 'subquery' | 'simpleMaths' | 'aggregateMaths' | 'switchField' | 'configManagerUi' | 'roundedNumbers' | 'sqlDefinedDataSet' | 'encryptedDashboards' | 'sqlViews';
 export type QueryEngineConfig = {
     origin?: 'in-browser' | 'query-engine' | 'custom';
     supportedFeatures: SupportedFeature[];

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 type ThemeVersion = 1 | 2;

package/dist/shared-logic/src/Translations/translation.types.d.ts

@@ -462,6 +462,48 @@ export type VizzlyTranslations = {
      * String containing the translation.
      */
     download: string;
+    /**
+     * @default 'Download dashboard to PDF'
+     *
+     * @returns
+     * String containing the translation.
+     */
+    download_dashboard_to_pdf: string;
+    /**
+     * @default 'Download the dashboard you see in this view.'
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'pdf_download.description': string;
+    /**
+     * @default 'Portrait'
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'pdf_download.page.orientation.portrait': string;
+    /**
+     * @default 'Landscape'
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'pdf_download.page.orientation.landscape': string;
+    /**
+     * @default 'Orientation'
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'pdf_download.page.orientation': string;
+    /**
+     * @default 'Download to PDF'
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'download_dashboard_to_pdf.button': string;
     /**
      * @default 'Add alternative group'
      *
@@ -539,6 +581,61 @@ export type VizzlyTranslations = {
      * String containing the translation.
      */
     format: string;
+    /**
+     * @default 'Current'
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'single_stat.current': string;
+    /**
+     * @default 'Previous'
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'single_stat.previous': string;
+    /**
+     * @default 'Show as value'
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'single_stat.show_as_value': string;
+    /**
+     * @default 'Show as percentage'
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'single_stat.show_as_percentage': string;
+    /**
+     * @default 'No data available for [[deltaTimeDimension]] comparison'
+     *
+     * @params
+     * Fixed Variables: [[deltaTimeDimension]]
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'single_stat.no_data_for_delta_description': string;
+    /**
+     * @default 'Comparing [[deltaTimeDimension]] over [[deltaTimeDimension]]'
+     *
+     * @params
+     * Fixed Variables: [[deltaTimeDimension]]
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'single_stat.delta_description': string;
+    /**
+     * @default 'No value'
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'single_stat.no_value': string;
     /**
      * @default 'Confirm Reset'
      *
@@ -1160,14 +1257,7 @@ export type VizzlyTranslations = {
      */
     dataset: string;
     /**
-     * @default 'Pre-aggregated data set'
-     *
-     * @returns
-     * String containing the translation.
-     */
-    'pre-aggregated_data_set_title': string;
-    /**
-     * @default 'This data set has already been aggregated, therefore you will find some data properties have already been set.'
+     * @default 'Please note; this data set is pre-aggregated, therefore customization options on the data panel are limited.'
      *
      * @returns
      * String containing the translation.
@@ -1492,26 +1582,26 @@ export type VizzlyTranslations = {
      */
     display_conditional_format_configuration: string;
     /**
-     * @default 'Error'
+     * @default 'Add Condition'
      *
      * @returns
      * String containing the translation.
      */
-    error: string;
+    add_condition: string;
     /**
-     * @default 'Invalid rule'
+     * @default 'Error'
      *
      * @returns
      * String containing the translation.
      */
-    invalid_rule: string;
+    error: string;
     /**
-     * @default 'Add Condition'
+     * @default 'Invalid or broken rule'
      *
      * @returns
      * String containing the translation.
      */
-    add_condition: string;
+    invalid_rule: string;
     /**
      * @default 'Add Goal Line'
      *
@@ -1529,6 +1619,27 @@ export type VizzlyTranslations = {
      * String containing the translation.
      */
     goal_line_configuration: string;
+    /**
+     * @default 'None'
+     *
+     * @returns
+     * String containing the translation.
+     */
+    none: string;
+    /**
+     * @default 'Current'
+     *
+     * @returns
+     * String containing the translation.
+     */
+    current: string;
+    /**
+     * @default 'Options'
+     *
+     * @returns
+     * String containing the translation.
+     */
+    options: string;
     /**
      * @default 'Background'
      *
@@ -2141,6 +2252,13 @@ export type VizzlyTranslations = {
      * String containing the translation.
      */
     'bar_chart.format_panel.axis_labels.y.axis_title.title': string;
+    /**
+     * @default "Headline"
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'bar_chart.format_panel.headline.title': string;
     /**
      * @default "Goal Lines"
      *
@@ -2428,6 +2546,20 @@ export type VizzlyTranslations = {
      * String containing the translation.
      */
     'area_chart.format_panel.axis_labels.y.axis_title.title': string;
+    /**
+     * @default "Conditional Formatting"
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'area_chart.format_panel.conditional_formatting.title': string;
+    /**
+     * @default "Headline"
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'area_chart.format_panel.headline.title': string;
     /**
      * @default "Goal Lines"
      *
@@ -2715,6 +2847,13 @@ export type VizzlyTranslations = {
      * String containing the translation.
      */
     'combo_chart.format_panel.conditional_formatting.bar.title': string;
+    /**
+     * @default "Line"
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'combo_chart.format_panel.conditional_formatting.line.title': string;
     /**
      * @default "Basic table"
      *
@@ -3359,6 +3498,13 @@ export type VizzlyTranslations = {
      * String containing the translation.
      */
     'horizontal_bar_chart.format_panel.axis_labels.y.axis_title.title': string;
+    /**
+     * @default "Headline"
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'horizontal_bar_chart.format_panel.headline.title': string;
     /**
      * @default "Conditional Formatting"
      *
@@ -3646,6 +3792,20 @@ export type VizzlyTranslations = {
      * String containing the translation.
      */
     'line_chart.format_panel.axis_labels.y.axis_title.title': string;
+    /**
+     * @default "Conditional Formatting"
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'line_chart.format_panel.conditional_formatting.title': string;
+    /**
+     * @default "Headline"
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'line_chart.format_panel.headline.title': string;
     /**
      * @default "Goal Lines"
      *

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

@@ -43,6 +43,7 @@ export declare const api: (config: ApiConfig) => {
     getProjectAccessToken: (projectId: string, appSessionAuthToken?: string | undefined, resourceFilters?: string[] | undefined) => Promise<string | undefined>;
     getProject: (projectId: string) => Promise<import("../Project/types").Project | null>;
     createQueryEngineUser: (projectId: string, email: string, password: string) => Promise<boolean>;
+    updateQueryEngineUser: (projectId: string, updateQueryEngineUser: string, password: string) => Promise<boolean>;
     getQueryEngineUser: (projectId: string, email: string) => Promise<{
         id: string;
         password: string | null;

package/dist/shared-logic/src/api/vizzly/updateQueryEngineUser.d.ts

@@ -0,0 +1,2 @@
+import { HttpClient } from '../types';
+export declare const updateQueryEngineUser: (httpClient: HttpClient) => (projectId: string, updateQueryEngineUser: string, password: string) => Promise<boolean>;

package/package.json

@@ -22,5 +22,5 @@
     "test": "jest",
     "prepare": "yarn build"
   },
-  "version": "0.7.3"
+  "version": "0.7.4-dev-396503edb3f72dee2437663fb8b8398a998ed90b"
 }