@vizzly/dashboard 0.14.4-dev-853fa16da5e049a03a787a1aedebe8e5ce756e21 → 0.14.4-dev-ac144c6e109da595b1c8df4be87f046b8be9fe29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -15,8 +15,9 @@ import { QueryAttributes } from '../../shared-logic/src/QueryAttributes/types';
15
15
  import { CustomDriver } from '../../results-driver/src/types';
16
16
  import { Result } from '../../shared-logic/src/Result/types';
17
17
  import { DateTimeFilterOptions } from '../../shared-logic/src/DateTime/types';
18
- import { DataSetDashboardFilters } from '../../shared-logic/src/CustomView/types';
19
18
  import { VariableList } from '../../shared-logic/src/Variables/types';
19
+ import { FilterConfig } from '../../shared-logic/src/AdditionalFilter/types';
20
+ export type { FilterConfig } from '../../shared-logic/src/AdditionalFilter/types';
20
21
  export type { ViewConfiguration } from '../../shared-logic/src/ViewConfiguration/types';
21
22
  export { VizzlyInstanceNotLoaded } from './errors/VizzlyInstanceNotLoaded';
22
23
  export declare type Options = {
@@ -172,6 +173,6 @@ export declare type QueryParams = {
172
173
  data?: loadDataCallback;
173
174
  queryEngineEndpoint?: QueryEngineEndpoint;
174
175
  dateFilterOptions?: DateTimeFilterOptions;
175
- dashboardFilters: DataSetDashboardFilters;
176
176
  variables?: VariableList;
177
+ filterConfig?: FilterConfig;
177
178
  };
@@ -270,7 +270,6 @@ export declare namespace Component {
270
270
  labels?: boolean;
271
271
  labelFormat: FormatType;
272
272
  parameters?: Parameters;
273
- drilldownOptions: Array<DrilldownOptions> | undefined;
274
273
  };
275
274
  export type AreaChartAttributes = BaseAttributes & BaseQueryAttributes & {
276
275
  type: 'areaChart';
@@ -40,5 +40,6 @@ export interface ComponentInterface<Hydrated = any, Dumped = any> extends Dumpab
40
40
  parameters: boolean;
41
41
  colorGradient: boolean;
42
42
  };
43
+ supportedAggregations?: Array<string>;
43
44
  }
44
45
  export declare type LoadComponentInterface<Hydrated, Dumped> = (config: ComponentInterfaceConfig) => ComponentInterface<Hydrated, Dumped>;
@@ -1,13 +1,10 @@
1
1
  /// <reference types="react" />
2
+ import { FilterConfig } from '../AdditionalFilter/types';
2
3
  import { Component } from '../Component/types';
3
- import { QueryAttributes } from '../QueryAttributes/types';
4
4
  export declare type CustomView = StaticCustomView | SelectableCustomView;
5
- export declare type DataSetDashboardFilters = {
6
- [dataSetId: string]: QueryAttributes.Filter[][];
7
- };
8
5
  export declare type CustomViewCallbackParams = {
9
- dashboardFilters: DataSetDashboardFilters;
10
6
  attributes?: Component.CustomViewAttributes;
7
+ filterConfig: FilterConfig;
11
8
  };
12
9
  export declare type BaseCustomView = {
13
10
  id: string;
@@ -1,9 +1,8 @@
1
1
  import { DataSet } from './types';
2
2
  import { CustomField, SimpleMathField } from '../CustomField/types';
3
3
  import { DateTimeField, NonDateTimeField } from '../Field/types';
4
- import { PreAggregatedQuery, Query } from '../Query/types';
4
+ import { PreAggregatedQuery } from '../Query/types';
5
5
  import * as Field from '../Field/Field';
6
- import FieldNotFoundInDataSet from '../errors/FieldNotFoundInDataSet';
7
6
  import { QueryAttributes } from '../QueryAttributes/types';
8
7
  import { QueryEngineConfig } from '../QueryEngineConfig/types';
9
8
  import { ComponentType } from '../Component/types';
@@ -24,7 +23,6 @@ export declare const hasDateTimeFields: (dataSet: DataSet) => boolean;
24
23
  export declare const getPlaceholder: (dataSet: DataSet, field: string | null) => string;
25
24
  export declare const takeFieldsForDimension: (dataSet: DataSet) => DataSet.Field[];
26
25
  export declare const takeFieldsForMeasure: (dataSet: DataSet, componentType: ComponentType) => DataSet.Field[];
27
- export declare const validateQueries: (dataSet: DataSet, queries: Query[]) => undefined | FieldNotFoundInDataSet;
28
26
  /**
29
27
  * Return all custom fields for a data set, and optionally
30
28
  * provide the componentType to ensure the custom fields which are returned
@@ -1,9 +1,9 @@
1
- import { DataSet } from '../DataSet/types';
2
- import { QueryAttributes } from '../QueryAttributes/types';
3
- import { QueryEngineConfig } from '../QueryEngineConfig/types';
4
1
  import { Component } from '../Component/types';
2
+ import { DataSet } from '../DataSet/types';
5
3
  import { Datum, ParsedDatumKey } from '../DatumKey';
6
4
  import * as Dimension from '../Dimension';
5
+ import { QueryAttributes } from '../QueryAttributes/types';
6
+ import { QueryEngineConfig } from '../QueryEngineConfig/types';
7
7
  export declare const updateTimeDimension: (dataSet: DataSet, option: QueryAttributes.TimeDimension & {
8
8
  function?: string;
9
9
  }) => QueryAttributes.TimeDimension | null;
@@ -28,4 +28,4 @@ export declare function buildClickedOnFieldForQuery(getField: (metric: {
28
28
  field: string;
29
29
  function: string;
30
30
  }) => string, parseKey: (key: string) => ParsedDatumKey | undefined, dimension?: QueryAttributes.Dimension[], timeDimension?: QueryAttributes.TimeDimension | null, clickedValue?: Datum | undefined): DrilldownField[];
31
- export declare function buildDrilldownFilters(attributes: Component.BarChartAttributes | Component.HorizontalBarChartAttributes | Component.PieChartAttributes | Component.SunburstChartAttributes, queries: Partial<QueryAttributes>, existingField: DrilldownField[], combineFilters: (array1: QueryAttributes.Filter[][], array2: QueryAttributes.Filter[][]) => QueryAttributes.Filter[][], updateFilter: (field: DrilldownField, timeDimension: QueryAttributes.TimeDimension | null, dimension: QueryAttributes.Dimension[]) => QueryAttributes.Filter[][]): QueryAttributes.Filter[][];
31
+ export declare function buildDrilldownFilters(attributes: Component.BarChartAttributes | Component.HorizontalBarChartAttributes | Component.PieChartAttributes, queries: Partial<QueryAttributes>, existingField: DrilldownField[], combineFilters: (array1: QueryAttributes.Filter[][], array2: QueryAttributes.Filter[][]) => QueryAttributes.Filter[][], updateFilter: (field: DrilldownField, timeDimension: QueryAttributes.TimeDimension | null, dimension: QueryAttributes.Dimension[]) => QueryAttributes.Filter[][]): QueryAttributes.Filter[][];
@@ -1,18 +1,8 @@
1
- import { PreAggregatedQuery, PreparedQuery, Query, SubQuery } from './types';
1
+ import { PreAggregatedQuery, PreparedQuery, Query } from './types';
2
2
  import { QueryAttributes } from '../QueryAttributes/types';
3
3
  import { QueryEngineConfig, SupportedFeature as SupportedFeatureType } from '../QueryEngineConfig/types';
4
4
  import { DataSet } from '../DataSet/types';
5
5
  import { Result } from '../Result/types';
6
- import { AdditionalFilter, TimeRangeOptions } from '../AdditionalFilter/types';
7
- import { DataSetDashboardFilters } from '../CustomView/types';
8
- export { validate } from './validate';
9
- export declare const isValidMathsOp: (value: string) => value is import("../CustomField/types").MathOperator;
10
- export declare const containsSubquery: (measures: Query['measure']) => boolean;
11
- export declare const containsAggregates: (query: Query | SubQuery) => boolean;
12
- export declare const hasGroups: (query: Query) => boolean;
13
- export declare const setQueryLimit: (query: Query, limit: number) => Query;
14
- export declare const isRunnable: (query: Query | null, queryEngineConfig: QueryEngineConfig) => boolean;
15
- export declare const takeRunnableQueries: (queries: (Query | null)[], queryEngineConfig: QueryEngineConfig) => Query<string, string, string>[];
16
6
  export declare const build: (dataSet: DataSet<DataSet.Field>, measureAttr: QueryAttributes.Measure[], orderAttr: QueryAttributes.Order[], dimensionAttr: QueryAttributes.Dimension[], timeDimensionAttr: QueryAttributes.TimeDimension | null, limitAttr: number | undefined, offsetAttr: number | undefined, queryEngineConfig: import("@vizzly/semantic-layer-public/dist/types").QueryEngineConfig, params: import("../../../results-driver/src/types").Params, prebuiltFilters?: QueryAttributes.Filter[][] | undefined) => {
17
7
  query: Query<string, string, string>;
18
8
  measureDescription: import("./types").MeasureDescription[];
@@ -20,7 +10,6 @@ export declare const build: (dataSet: DataSet<DataSet.Field>, measureAttr: Query
20
10
  export declare const hasDimensions: (query: {
21
11
  group: Query['group'];
22
12
  }) => boolean;
23
- export declare const getMeasures: (query: Query) => Query['measure'];
24
13
  export declare const buildPreAggregatedPreparedQuery: (query: PreAggregatedQuery, dataSet: DataSet) => {
25
14
  query: PreAggregatedQuery;
26
15
  resultFields: Result.Field[];
@@ -30,7 +19,4 @@ export declare const buildUniqueArrayValuesPreparedQuery: (dataSetId: string, da
30
19
  resultFields: Result.Field[];
31
20
  };
32
21
  export declare const buildFilterQuery: (dataSet: DataSet, fieldId: string, optionsFilters?: QueryAttributes.Filter[] | undefined, optionsOrders?: QueryAttributes.Order[] | undefined) => QueryAttributes;
33
- export declare const requiredFields: (query: Query) => Array<string>;
34
22
  export declare const supportsFeature: (queryEngineConfig: QueryEngineConfig, feature: SupportedFeatureType) => boolean;
35
- export declare const toDataSetDashboardFilters: (dataSets: DataSet[], additionalFilters: AdditionalFilter[], dateFilterOptions: TimeRangeOptions) => DataSetDashboardFilters;
36
- export declare function addGlobalFiltersToQueries(queries: QueryAttributes[], dashboardFilters?: DataSetDashboardFilters): QueryAttributes[];
@@ -1,9 +1,7 @@
1
- import { Query } from '../Query/types';
2
1
  import * as Measure from '../Measure';
3
2
  import { DataType } from '../Field/types';
4
3
  import { Result } from './types';
5
4
  import { SupportedAggregates } from '../Aggregate';
6
- import { QueryEngineConfig } from '../QueryEngineConfig/types';
7
5
  import { PivotConfig } from '../PivotConfig/types';
8
6
  import { QueryAttributes as QueryAttributesType } from '../QueryAttributes/types';
9
7
  export declare type RawResult = {
@@ -38,6 +36,5 @@ export declare const getLabel: (result: Result | null, fieldId: string, supporte
38
36
  export declare const isLoading: (result: Result | null | undefined) => result is undefined;
39
37
  export declare const hasFailed: (result: Result | null | undefined) => result is null;
40
38
  export declare const isEmpty: (result: Result | null | undefined) => boolean;
41
- export declare const validate: (result: Result, query: Query, params: QueryEngineConfig) => void;
42
39
  export declare const to100PercentResultSet: (resultSet: Array<TimeSeriesResultSet>) => Array<TimeSeriesResultSet>;
43
40
  export {};
@@ -19,7 +19,7 @@ declare const getRunQueriesCallback: (identityConfig: IdentityConfigType, queryE
19
19
  dataSets: import("../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../shared-logic/src/DataSet/types").DataSet.Field>[];
20
20
  abortSignal?: AbortSignal | undefined;
21
21
  dataAccessToken?: string | undefined;
22
- filterConfig?: import("../../../../shared-logic/src/AdditionalFilter/types").FilterConfig | undefined;
22
+ filterConfig?: import("@vizzly/services/src").FilterConfig | undefined;
23
23
  }) => Promise<(import("../../../../shared-logic/src/Result/types").Result | any[][] | null)[] | null>) | undefined, data?: loadDataCallback | undefined, queryEngineEndpoint?: string | {
24
24
  endpoint: string;
25
25
  dynamicConfig?: Object | undefined;
@@ -1,8 +1,8 @@
1
1
  /// <reference types="react" />
2
2
  import { VizzlyComponents } from '../types';
3
+ import { AdditionalFilter } from '../../../shared-logic/src/AdditionalFilter/types';
3
4
  import { Component as ComponentType } from '../../../shared-logic/src/Component/types';
4
5
  import { Result } from '../../../shared-logic/src/Result/types';
5
- import { AdditionalFilter } from '../../../shared-logic/src/AdditionalFilter/types';
6
6
  export declare type ComponentProps = {
7
7
  id: string;
8
8
  component: ComponentType;
@@ -1,10 +1,10 @@
1
1
  /// <reference types="react" />
2
2
  import { Component } from '../../../../shared-logic/src/Component/types';
3
3
  import { DataSet } from '../../../../shared-logic/src/DataSet/types';
4
- import { Result } from '../../../../shared-logic/src/Result/types';
5
4
  import * as Drilldown from '../../../../shared-logic/src/Drilldown/Drilldown';
6
5
  import { QueryEngineConfig } from '../../../../shared-logic/src/QueryEngineConfig/types';
7
- export declare type AcceptedDrilldownAttributes = Component.PieChartAttributes | Component.SunburstChartAttributes | Component.BarChartAttributes | Component.HorizontalBarChartAttributes | Component.BarChartV2Attributes;
6
+ import { Result } from '../../../../shared-logic/src/Result/types';
7
+ export declare type AcceptedDrilldownAttributes = Component.PieChartAttributes | Component.BarChartAttributes | Component.HorizontalBarChartAttributes | Component.BarChartV2Attributes;
8
8
  export declare function useDrilldownSelection(results: (Result | null)[], attributes: AcceptedDrilldownAttributes, setAttributes: (newAttributes: AcceptedDrilldownAttributes) => void, dataSet: DataSet, queryEngineConfig: QueryEngineConfig, hasDateTimeInDimension?: boolean): {
9
9
  onDrilldownChange: ({ existingField, newField }: Drilldown.SelectedDrilldown) => void;
10
10
  setDrilldownSelections: import("react").Dispatch<import("react").SetStateAction<Drilldown.SelectedDrilldown[]>>;
@@ -1,3 +1,3 @@
1
1
  /// <reference types="react" />
2
2
  import { SunburstChartProps } from '../Component/types';
3
- export declare const SunburstChart: (props: SunburstChartProps) => JSX.Element | null;
3
+ export declare const SunburstChart: (props: SunburstChartProps) => JSX.Element;
@@ -1,14 +1,14 @@
1
1
  import React from 'react';
2
- import { FormattedResult } from '../../../../shared-logic/src/Result/types';
3
- interface SunburstProps {
4
- data: FormattedResult;
5
- }
6
- export declare const SunburstChartView: (props: SunburstProps & {
2
+ import { Component } from '../../../../shared-logic/src/Component/types';
3
+ import { FormatResultArgs } from '../../../../shared-logic/src/Result/formatResult';
4
+ import { VizzlyComponents } from '../../types';
5
+ export declare type SunburstProps = Pick<VizzlyComponents.ViewProps<{
6
+ attributes: Component.SunburstChartAttributes;
7
+ }>, 'attributes' | 'result' | 'dataSet' | 'localFilters' | 'setLocalFilters' | 'setPartialAttributes' | 'library'> & {
8
+ formatResultParams: FormatResultArgs;
7
9
  width: number;
8
10
  height: number;
9
- }) => JSX.Element;
10
- declare const memoized: React.MemoExoticComponent<(props: SunburstProps & {
11
- width: number;
12
- height: number;
13
- }) => JSX.Element>;
11
+ };
12
+ export declare const SunburstChartView: (props: SunburstProps) => JSX.Element;
13
+ declare const memoized: React.MemoExoticComponent<(props: SunburstProps) => JSX.Element>;
14
14
  export default memoized;
@@ -1,11 +1,11 @@
1
1
  import { FormattedResult } from '../../../../shared-logic/src/Result/types';
2
- interface DataType {
2
+ declare type SunburstNode = {
3
3
  name: string;
4
- children?: DataType[];
4
+ children?: SunburstNode[];
5
5
  hierarchy: string;
6
- size?: string | number;
6
+ value?: number;
7
7
  parents: string[];
8
8
  color: string;
9
- }
10
- export declare const convertDataToSunburstData: (formattedData: FormattedResult) => DataType;
9
+ };
10
+ export declare const convertDataToSunburstData: (formattedData: FormattedResult) => SunburstNode;
11
11
  export {};
@@ -1,15 +1,15 @@
1
1
  /// <reference types="react" />
2
- import * as Field from '../../../../shared-logic/src/Field';
2
+ import { SupportedTimeTruncFunctions } from '@vizzly/semantic-layer-public';
3
3
  import { Component } from '../../../../shared-logic/src/Component/types';
4
4
  import { FieldCollectorOptions } from '../../../../shared-logic/src/DataPanelConfig/types';
5
- import { QueryEngineConfig } from '../../../../shared-logic/src/QueryEngineConfig/types';
6
5
  import { DataSet as DataSetType } from '../../../../shared-logic/src/DataSet/types';
7
- import { FieldFilterOptions } from '../../../../shared-logic/src/DataSet/fieldFilterOptions';
6
+ import * as Field from '../../../../shared-logic/src/Field';
8
7
  import { QueryAttributes } from '../../../../shared-logic/src/QueryAttributes/types';
9
- import { SupportedTimeTruncFunctions } from '@vizzly/semantic-layer-public';
8
+ import { QueryEngineConfig } from '../../../../shared-logic/src/QueryEngineConfig/types';
9
+ import { FieldFilterOptions } from '../../../../shared-logic/src/DataSet/fieldFilterOptions';
10
10
  import { InitValue } from '../../base/ListView/ListView';
11
- import { VizzlyComponents } from '../../types';
12
11
  import { ListViewItem } from '../../base/ListView/types';
12
+ import { VizzlyComponents } from '../../types';
13
13
  declare type FieldCollectorInputFieldValue = QueryAttributes['measure'][number] | QueryAttributes['dimension'][number];
14
14
  declare type SelectOptionType = {
15
15
  value: any;
@@ -28,5 +28,5 @@ export declare const getDateTimeSelectOptions: (allowedGranularities: string[],
28
28
  export declare function handleCreateNewField(values: (QueryAttributes.Dimension | QueryAttributes.Measure)[], purpose: string, queryEngineConfig: QueryEngineConfig, onChange: (values: FieldCollectorInputFieldValue[]) => void): (field: DataSetType.Field) => void;
29
29
  export declare function buildDimensionFromField(purpose: string, field: DataSetType.Field, queryEngineConfig: QueryEngineConfig): QueryAttributes.Dimension | QueryAttributes.Measure;
30
30
  export declare function buildFieldsToPickFrom(dataSet: DataSetType, fieldFilterOptions: FieldFilterOptions | undefined, preventDuplicates: boolean | undefined, values: (QueryAttributes.Measure | QueryAttributes.Dimension)[]): InitValue<DataSetType.Field>[];
31
- export declare function buildFieldCollectorItems(values: (QueryAttributes.Measure | QueryAttributes.Dimension)[], dataSet: DataSetType, purpose: string, queryEngineConfig: QueryEngineConfig, onChange: (values: FieldCollectorInputFieldValue[]) => void): ListViewItem<any>[];
31
+ export declare function buildFieldCollectorItems(values: (QueryAttributes.Measure | QueryAttributes.Dimension)[], dataSet: DataSetType, purpose: string, queryEngineConfig: QueryEngineConfig, onChange: (values: FieldCollectorInputFieldValue[]) => void, supportedAggregations?: string[]): ListViewItem<any>[];
32
32
  export {};
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@vizzly/dashboard",
3
3
  "author": "james@vizzly.co",
4
- "version": "0.14.4-dev-853fa16da5e049a03a787a1aedebe8e5ce756e21",
4
+ "version": "0.14.4-dev-ac144c6e109da595b1c8df4be87f046b8be9fe29",
5
5
  "source": "src/index.tsx",
6
6
  "types": "./dist/dashboard/src/index.d.ts",
7
7
  "module": "./dist/dashboard.esm.js",
@@ -55,7 +55,7 @@
55
55
  "@visx/visx": "^3.10.2",
56
56
  "@vizzly/api-client": "0.0.57",
57
57
  "@vizzly/joi": "^17.7.0",
58
- "@vizzly/semantic-layer-public": "0.0.233",
58
+ "@vizzly/semantic-layer-public": "0.0.234",
59
59
  "@vizzly/sqlbuilder-public": "0.1.43",
60
60
  "chroma-js": "2.4.2",
61
61
  "copy-to-clipboard": "^3.3.3",
@@ -1,13 +0,0 @@
1
- import Joi from '@vizzly/joi';
2
- import { QueryEngineConfig } from '../QueryEngineConfig/types';
3
- import { Query } from './types';
4
- import { JoiOptions } from '../validations';
5
- export declare class InvalidQuery extends Error {
6
- }
7
- export declare const postgresQuerySchema: Joi.AlternativesSchema<unknown>;
8
- export declare const snowflakeQuerySchema: Joi.AlternativesSchema<unknown>;
9
- export declare const mariadbQuerySchema: Joi.AlternativesSchema<unknown>;
10
- export declare const mysqlQuerySchema: Joi.AlternativesSchema<unknown>;
11
- export declare const bigqueryQuerySchema: Joi.AlternativesSchema<unknown>;
12
- export declare const redshiftSchema: Joi.AlternativesSchema<unknown>;
13
- export declare const validate: (queries: Array<unknown>, queryEngineConfig: QueryEngineConfig, joiOptions: JoiOptions) => Array<Query>;
@@ -1,7 +0,0 @@
1
- import { Result } from './types';
2
- import { Query as QueryType } from '../Query/types';
3
- import { SupportedAggregates } from '../Aggregate';
4
- export declare const validateDimensionsInResult: (result: Result, query: QueryType) => void;
5
- export declare const validateAllMeasuresAreInTheResult: (result: Result, query: QueryType) => void;
6
- export declare const limitIsNotExceeded: (result: Result, query: QueryType) => void;
7
- export declare const resultsAreOfCorrectType: (result: Result, supportedAggregates: SupportedAggregates) => void;