@vizzly/services 0.12.7 → 0.12.8

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.
Files changed (49) hide show
  1. package/dist/index.js +1 -1
  2. package/dist/results-driver/src/driver/Custom.d.ts +6 -0
  3. package/dist/results-driver/src/driver/VizzlyJsQueryEngine.d.ts +6 -0
  4. package/dist/results-driver/src/driver/VizzlyQuery/AdditionalFilter/toQueries.d.ts +9 -0
  5. package/dist/results-driver/src/driver/VizzlyQuery/AreaChart/toQueries.d.ts +4 -0
  6. package/dist/results-driver/src/driver/VizzlyQuery/BarChart/toQueries.d.ts +4 -0
  7. package/dist/results-driver/src/driver/VizzlyQuery/BasicTable/toQueries.d.ts +4 -0
  8. package/dist/results-driver/src/driver/VizzlyQuery/ComboChart/toQueries.d.ts +11 -0
  9. package/dist/results-driver/src/driver/VizzlyQuery/HorizontalBarChart/toQueries.d.ts +4 -0
  10. package/dist/results-driver/src/driver/VizzlyQuery/LineChart/toQueries.d.ts +4 -0
  11. package/dist/results-driver/src/driver/VizzlyQuery/MercatorMap/toQueries.d.ts +11 -0
  12. package/dist/results-driver/src/driver/VizzlyQuery/PieChart/toQueries.d.ts +4 -0
  13. package/dist/results-driver/src/driver/VizzlyQuery/PivotTable/toQueries.d.ts +4 -0
  14. package/dist/results-driver/src/driver/VizzlyQuery/QueryAttributes/toQueries.d.ts +9 -0
  15. package/dist/results-driver/src/driver/VizzlyQuery/ScatterChart/toQueries.d.ts +11 -0
  16. package/dist/results-driver/src/driver/VizzlyQuery/SingleStat/toQueries.d.ts +11 -0
  17. package/dist/results-driver/src/driver/VizzlyQuery/buildVizzlyQuery.d.ts +12 -0
  18. package/dist/results-driver/src/driver/VizzlyQuery/commonToQueries.d.ts +11 -0
  19. package/dist/results-driver/src/driver/VizzlyQuery/toResultFields.d.ts +4 -0
  20. package/dist/results-driver/src/driver/VizzlyQueryEngine.d.ts +6 -0
  21. package/dist/results-driver/src/index.d.ts +16 -0
  22. package/dist/results-driver/src/types.d.ts +37 -0
  23. package/dist/results-driver/src/utils/browserCache.d.ts +3 -0
  24. package/dist/results-driver/src/utils/runWithValidationAndCaching.d.ts +4 -0
  25. package/dist/services/src/index.d.ts +18 -1
  26. package/dist/services/src/schemaValidations/index.d.ts +2 -0
  27. package/dist/services/src/schemaValidations/query.d.ts +3 -0
  28. package/dist/shared-logic/src/Component/sharedSchemas.d.ts +11 -3
  29. package/dist/shared-logic/src/Component/types.d.ts +3 -1
  30. package/dist/shared-logic/src/ComponentInterface/types/namespaces.types.d.ts +2 -2
  31. package/dist/shared-logic/src/CustomComponent/attributesSchema.d.ts +3 -0
  32. package/dist/shared-logic/src/CustomComponent/constants.d.ts +3 -0
  33. package/dist/shared-logic/src/CustomComponent/index.d.ts +3 -2
  34. package/dist/shared-logic/src/CustomComponent/types.d.ts +27 -0
  35. package/dist/shared-logic/src/DateTime/DateTimeFilterOptions.d.ts +105 -0
  36. package/dist/shared-logic/src/JSQueryEngine/fetchData.d.ts +8 -0
  37. package/dist/shared-logic/src/JSQueryEngine/getInMemoryDb.d.ts +2 -0
  38. package/dist/shared-logic/src/JSQueryEngine/localRunQueriesCallback.d.ts +5 -0
  39. package/dist/shared-logic/src/JSQueryEngine/runQueryV3.d.ts +7 -0
  40. package/dist/shared-logic/src/Query/types.d.ts +3 -0
  41. package/dist/shared-logic/src/QueryEngineConfig/types.d.ts +1 -1
  42. package/dist/shared-logic/src/api/queryEngine/createResults.d.ts +3 -0
  43. package/dist/shared-logic/src/api/queryEngine/getRunQueriesCallback.d.ts +19 -0
  44. package/dist/shared-logic/src/errors/MissingVizzlyInMemoryDb.d.ts +4 -0
  45. package/dist/shared-logic/src/utils/DateTime.d.ts +18 -0
  46. package/dist/shared-logic/src/utils/arrayHelpers.d.ts +6 -0
  47. package/dist/shared-logic/src/utils/index.d.ts +5 -0
  48. package/dist/shared-logic/src/utils/numberHelpers.d.ts +8 -0
  49. package/package.json +1 -1
@@ -0,0 +1,6 @@
1
+ import { AdditionalFilter } from "../../../shared-logic/src/AdditionalFilter/types";
2
+ import { CustomDriver, Params } from "../types";
3
+ import { QueryAttributes } from "../../../shared-logic/src/QueryAttributes/types";
4
+ import { Component } from "../../../shared-logic/src/Component/types";
5
+ import { Result } from "../../../shared-logic/src/Result/types";
6
+ export declare const toResults: (driver: CustomDriver, thing: Component.Attributes | AdditionalFilter | QueryAttributes[], params: Params) => Promise<Array<Result | null>>;
@@ -0,0 +1,6 @@
1
+ import { Params, VizzlyJsQueryEngineDriver } from '../types';
2
+ import { Component } from '../../../shared-logic/src/Component/types';
3
+ import { AdditionalFilter } from '../../../shared-logic/src/AdditionalFilter/types';
4
+ import { Result } from '../../../shared-logic/src/Result/types';
5
+ import { QueryAttributes } from '../../../shared-logic/src/QueryAttributes/types';
6
+ export declare const toResults: (vizzlyQueryEngineDriver: VizzlyJsQueryEngineDriver, thing: Component.Attributes | AdditionalFilter | QueryAttributes[], params: Params) => Promise<Array<Result | null>>;
@@ -0,0 +1,9 @@
1
+ import { AdditionalFilter } from '../../../../../shared-logic/src/AdditionalFilter/types';
2
+ import { DataSet } from '../../../../../shared-logic/src/DataSet/types';
3
+ import { QueryEngineConfig } from '../../../../../shared-logic/src/QueryEngineConfig/types';
4
+ import { PreparedQuery, Query as QueryType } from '../../../../../shared-logic/src/Query/types';
5
+ import { Result as ResultType } from '../../../../../shared-logic/src/Result/types';
6
+ export declare const toQueries: (additionalFilter: AdditionalFilter, dataSets: DataSet[], queryEngineConfig: QueryEngineConfig) => {
7
+ queries: (QueryType | PreparedQuery)[];
8
+ resultFields: Array<ResultType.Field[]>;
9
+ };
@@ -0,0 +1,4 @@
1
+ export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../../shared-logic/src/DataSet/types").DataSet.Field>, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("../../../../../shared-logic/src/QueryEngineConfig/types").QueryEngineConfig) => {
2
+ queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
3
+ resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
4
+ };
@@ -0,0 +1,4 @@
1
+ export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../../shared-logic/src/DataSet/types").DataSet.Field>, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("../../../../../shared-logic/src/QueryEngineConfig/types").QueryEngineConfig) => {
2
+ queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
3
+ resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
4
+ };
@@ -0,0 +1,4 @@
1
+ export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../../shared-logic/src/DataSet/types").DataSet.Field>, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("../../../../../shared-logic/src/QueryEngineConfig/types").QueryEngineConfig) => {
2
+ queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
3
+ resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
4
+ };
@@ -0,0 +1,11 @@
1
+ import * as Filter from "../../../../../shared-logic/src/Filter";
2
+ import { Component } from "../../../../../shared-logic/src/Component/types";
3
+ import { DataSet } from "../../../../../shared-logic/src/DataSet/types";
4
+ import { QueryAttributes } from "../../../../../shared-logic/src/QueryAttributes/types";
5
+ import { QueryEngineConfig } from "../../../../../shared-logic/src/QueryEngineConfig/types";
6
+ import { Result as ResultType } from "../../../../../shared-logic/src/Result/types";
7
+ import { Query as QueryType } from "../../../../../shared-logic/src/Query/types";
8
+ export declare const toQueries: (attributes: Component.ComboChartAttributes, dataSet: DataSet, localAndGlobalFilters: QueryAttributes.Filter[], queryEngineConfig: QueryEngineConfig) => {
9
+ queries: QueryType[];
10
+ resultFields: Array<ResultType.Field[]>;
11
+ };
@@ -0,0 +1,4 @@
1
+ export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../../shared-logic/src/DataSet/types").DataSet.Field>, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("../../../../../shared-logic/src/QueryEngineConfig/types").QueryEngineConfig) => {
2
+ queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
3
+ resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
4
+ };
@@ -0,0 +1,4 @@
1
+ export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../../shared-logic/src/DataSet/types").DataSet.Field>, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("../../../../../shared-logic/src/QueryEngineConfig/types").QueryEngineConfig) => {
2
+ queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
3
+ resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
4
+ };
@@ -0,0 +1,11 @@
1
+ import { Component } from "../../../../../shared-logic/src/Component/types";
2
+ import { DataSet } from "../../../../../shared-logic/src/DataSet/types";
3
+ import { Query } from "../../../../../shared-logic/src/Query/types";
4
+ import { QueryAttributes } from "../../../../../shared-logic/src/QueryAttributes/types";
5
+ import { QueryEngineConfig } from "../../../../../shared-logic/src/QueryEngineConfig/types";
6
+ import { Result } from "../../../../../shared-logic/src/Result/types";
7
+ import * as Filter from "../../../../../shared-logic/src/Filter";
8
+ export declare const toQueries: (attributes: Component.MercatorMapAttributes, dataSet: DataSet, additionalFilters: QueryAttributes.Filter[], queryEngineConfig: QueryEngineConfig) => {
9
+ queries: Query[];
10
+ resultFields: Result.Field[][];
11
+ };
@@ -0,0 +1,4 @@
1
+ export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../../shared-logic/src/DataSet/types").DataSet.Field>, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("../../../../../shared-logic/src/QueryEngineConfig/types").QueryEngineConfig) => {
2
+ queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
3
+ resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
4
+ };
@@ -0,0 +1,4 @@
1
+ export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../../shared-logic/src/DataSet/types").DataSet.Field>, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("../../../../../shared-logic/src/QueryEngineConfig/types").QueryEngineConfig) => {
2
+ queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
3
+ resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
4
+ };
@@ -0,0 +1,9 @@
1
+ import { QueryEngineConfig } from "../../../../../shared-logic/src/QueryEngineConfig/types";
2
+ import { DataSet } from "../../../../../shared-logic/src/DataSet/types";
3
+ import { Query } from "../../../../../shared-logic/src/Query/types";
4
+ import { QueryAttributes } from "../../../../../shared-logic/src/QueryAttributes/types";
5
+ import { Result } from "../../../../../shared-logic/src/Result/types";
6
+ export declare const toQueries: (dataSets: DataSet[], queryAttributes: QueryAttributes[], queryEngineConfig: QueryEngineConfig) => {
7
+ queries: Query[];
8
+ resultFields: Array<Result.Field[]>;
9
+ };
@@ -0,0 +1,11 @@
1
+ import * as Filter from "../../../../../shared-logic/src/Filter";
2
+ import { Component } from "../../../../../shared-logic/src/Component/types";
3
+ import { DataSet } from "../../../../../shared-logic/src/DataSet/types";
4
+ import { QueryAttributes } from "../../../../../shared-logic/src/QueryAttributes/types";
5
+ import { QueryEngineConfig } from "../../../../../shared-logic/src/QueryEngineConfig/types";
6
+ import { Result as ResultType } from "../../../../../shared-logic/src/Result/types";
7
+ import { Query as QueryType } from "../../../../../shared-logic/src/Query/types";
8
+ export declare const toQueries: (attributes: Component.ScatterChartAttributes, dataSet: DataSet, localAndGlobalFilters: QueryAttributes.Filter[], queryEngineConfig: QueryEngineConfig) => {
9
+ queries: QueryType[];
10
+ resultFields: Array<ResultType.Field[]>;
11
+ };
@@ -0,0 +1,11 @@
1
+ import * as Filter from '../../../../../shared-logic/src/Filter';
2
+ import { Component } from '../../../../../shared-logic/src/Component/types';
3
+ import { DataSet } from '../../../../../shared-logic/src/DataSet/types';
4
+ import { QueryAttributes } from '../../../../../shared-logic/src/QueryAttributes/types';
5
+ import { QueryEngineConfig } from '../../../../../shared-logic/src/QueryEngineConfig/types';
6
+ import { Result as ResultType } from '../../../../../shared-logic/src/Result/types';
7
+ import { Query as QueryType } from '../../../../../shared-logic/src/Query/types';
8
+ export declare const toQueries: (attributes: Component.SingleStatAttributes | Component.ProgressAttributes, dataSet: DataSet, localAndGlobalFilters: QueryAttributes.Filter[], queryEngineConfig: QueryEngineConfig) => {
9
+ queries: QueryType[];
10
+ resultFields: Array<ResultType.Field[]>;
11
+ };
@@ -0,0 +1,12 @@
1
+ import { PreparedQuery, Query } from '../../../../shared-logic/src/Query/types';
2
+ import { Result } from '../../../../shared-logic/src/Result/types';
3
+ import { QueryAttributes } from '../../../../shared-logic/src/QueryAttributes/types';
4
+ import { Component } from '../../../../shared-logic/src/Component/types';
5
+ import { AdditionalFilter } from '../../../../shared-logic/src/AdditionalFilter/types';
6
+ import { Params } from '../../types';
7
+ import { QueryEngineConfig } from '../../../../shared-logic/src/QueryEngineConfig/types';
8
+ declare const buildVizzlyQuery: (thing: Component.Attributes | AdditionalFilter | Array<QueryAttributes> | Array<PreparedQuery>, queryEngineConfig: QueryEngineConfig, params: Params) => {
9
+ queries: Array<Query | PreparedQuery>;
10
+ resultFields: Array<Result.Field[]>;
11
+ };
12
+ export default buildVizzlyQuery;
@@ -0,0 +1,11 @@
1
+ import { Component } from '../../../../shared-logic/src/Component/types';
2
+ import { DataSet } from '../../../../shared-logic/src/DataSet/types';
3
+ import * as Filter from '../../../../shared-logic/src/Filter';
4
+ import { Query as QueryType } from '../../../../shared-logic/src/Query/types';
5
+ import { QueryAttributes } from '../../../../shared-logic/src/QueryAttributes/types';
6
+ import { QueryEngineConfig } from '../../../../shared-logic/src/QueryEngineConfig/types';
7
+ import { Result } from '../../../../shared-logic/src/Result/types';
8
+ export declare const commonToQueries: (attributes: Component.AreaChartAttributes | Component.BarChartAttributes | Component.DataTableAttributes | Component.BasicTableAttributes | Component.HorizontalBarChartAttributes | Component.LineChartAttributes | Component.PieChartAttributes, dataSet: DataSet, additionalFilters: QueryAttributes.Filter[], queryEngineConfig: QueryEngineConfig) => {
9
+ queries: QueryType[];
10
+ resultFields: Result.Field[][];
11
+ };
@@ -0,0 +1,4 @@
1
+ import { MeasureDescription } from '../../../../shared-logic/src/Query/types';
2
+ import { QueryEngineConfig } from '../../../../shared-logic/src/QueryEngineConfig/types';
3
+ import { Result } from '../../../../shared-logic/src/Result/types';
4
+ export declare const toResultFields: (measureDescriptions: Array<MeasureDescription[]>, _queryEngineConfig: QueryEngineConfig) => Array<Result['fields']>;
@@ -0,0 +1,6 @@
1
+ import { Component } from "../../../shared-logic/src/Component/types";
2
+ import { Result } from "../../../shared-logic/src/Result/types";
3
+ import { Params, VizzlyQueryEngineDriver } from "../types";
4
+ import { AdditionalFilter } from "../../../shared-logic/src/AdditionalFilter/types";
5
+ import { QueryAttributes } from "../../../shared-logic/src/QueryAttributes/types";
6
+ export declare const toResults: (vizzlyQueryEngineDriver: VizzlyQueryEngineDriver, thing: Component.Attributes | AdditionalFilter | QueryAttributes[], params: Params) => Promise<Array<Result | null>>;
@@ -0,0 +1,16 @@
1
+ import { Driver, Params } from './types';
2
+ import { Component } from '../../shared-logic/src/Component/types';
3
+ import { Result } from '../../shared-logic/src/Result/types';
4
+ import { AdditionalFilter } from '../../shared-logic/src/AdditionalFilter/types';
5
+ import { QueryAttributes } from '../../shared-logic/src/QueryAttributes/types';
6
+ declare type resultReturn = Promise<Array<Result | null>>;
7
+ export declare function toResults(driver: Driver, additionalFilter: AdditionalFilter, params: Params): resultReturn;
8
+ export declare function toResults(driver: Driver, queryAttributes: QueryAttributes[], params: Params): resultReturn;
9
+ export declare function toResults(driver: Driver, barChart: Component.BarChartAttributes, params: Params): resultReturn;
10
+ export declare function toResults(driver: Driver, horizontalBarChart: Component.HorizontalBarChartAttributes, params: Params): resultReturn;
11
+ export declare function toResults(driver: Driver, lineChart: Component.LineChartAttributes, params: Params): resultReturn;
12
+ export declare function toResults(driver: Driver, singleStat: Component.SingleStatAttributes, params: Params): resultReturn;
13
+ export declare function toResults(driver: Driver, progress: Component.ProgressAttributes, params: Params): resultReturn;
14
+ export declare function toResults(driver: Driver, basicTable: Component.BasicTableAttributes, params: Params): resultReturn;
15
+ export declare function toResults(driver: Driver, pivotTable: Component.DataTableAttributes, params: Params): resultReturn;
16
+ export {};
@@ -0,0 +1,37 @@
1
+ import { QueryEngineConfig, QueryEngineEndpoint } from "../../shared-logic/src/QueryEngineConfig/types";
2
+ import { DataSet, DataSet as DataSetType } from "../../shared-logic/src/DataSet/types";
3
+ import { TimeRangeOptions, FilterConfig } from "../../shared-logic/src/AdditionalFilter/types";
4
+ import { loadDataCallback } from "../../shared-logic/src/Callbacks/types";
5
+ import { Query } from "../../shared-logic/src/Query/types";
6
+ import { Result } from "../../shared-logic/src/Result/types";
7
+ export declare type VizzlyQueryEngineDriver = {
8
+ type: "vizzlyQueryEngine";
9
+ queryEngineConfig: QueryEngineConfig;
10
+ queryEngineEndpoint: QueryEngineEndpoint;
11
+ dataAccessToken: string;
12
+ cacheKeyNamespace: string;
13
+ };
14
+ export declare type CustomDriver = {
15
+ type: "custom";
16
+ queryEngineConfig: QueryEngineConfig;
17
+ dataAccessToken?: string;
18
+ cacheKeyNamespace: string;
19
+ runQueries: (queries: Query[], params: {
20
+ dataSets: DataSet[];
21
+ abortSignal?: AbortSignal;
22
+ dataAccessToken?: string;
23
+ filterConfig?: FilterConfig;
24
+ }) => Promise<Array<Result | Result["content"] | null> | null>;
25
+ };
26
+ export declare type VizzlyJsQueryEngineDriver = {
27
+ type: "vizzlyJsQueryEngine";
28
+ loadData: loadDataCallback;
29
+ cacheKeyNamespace: string;
30
+ };
31
+ export declare type Driver = VizzlyQueryEngineDriver | VizzlyJsQueryEngineDriver | CustomDriver;
32
+ export declare type Params = {
33
+ dataSets: Array<DataSetType>;
34
+ filterConfig: FilterConfig;
35
+ abortSignal?: AbortSignal;
36
+ timeRangeOptions: TimeRangeOptions;
37
+ };
@@ -0,0 +1,3 @@
1
+ export declare const set: (cacheKey: any, item: any, expiryInSeconds: number) => void;
2
+ export declare const get: <T>(cacheKey: any) => T | null;
3
+ export declare const clear: () => void;
@@ -0,0 +1,4 @@
1
+ import { PreparedQuery } from "../../../shared-logic/src/Query/types";
2
+ /** A generic function to validate a list of queries, and then only run the ones which are valid. */
3
+ declare const runWithValidationAndCaching: <Query, Result>(queries: (PreparedQuery | Query)[], isRunnable: (query: PreparedQuery | Query) => boolean, run: (queries: (PreparedQuery | Query)[]) => Promise<(Result | null)[] | null>, cacheKey: (query: PreparedQuery | Query) => any) => Promise<(Result | null)[] | null>;
4
+ export default runWithValidationAndCaching;
@@ -1,5 +1,5 @@
1
1
  import { QueryEngineConfig, QueryEngineEndpoint } from '../../shared-logic/src/QueryEngineConfig/types';
2
- import { identityCallback, loadDataSetsCallback, loadQueryEngineConfigCallback, programmaticDashboardCallback } from '../../shared-logic/src/Callbacks/types';
2
+ import { identityCallback, loadDataCallback, loadDataSetsCallback, loadQueryEngineConfigCallback, programmaticDashboardCallback } from '../../shared-logic/src/Callbacks/types';
3
3
  import { IdentityConfig } from '../../shared-logic/src/IdentityConfig/types';
4
4
  import { DashboardStorageStrategy } from '../../shared-logic/src/DashboardAPI/types';
5
5
  import { DataSet } from '../../shared-logic/src/DataSet/types';
@@ -11,6 +11,10 @@ import { Row, Cell, Dashboard, Header, Library, Editor } from './Services';
11
11
  import * as Views from './Services/View';
12
12
  import { ViewConfiguration } from '../../shared-logic/src/ViewConfiguration/types';
13
13
  import { EventBus, EventBusParams } from './eventbus.types';
14
+ import { QueryAttributes } from '../../shared-logic/src/QueryAttributes/types';
15
+ import { CustomDriver } from '../../results-driver/src/types';
16
+ import { Result } from '../../shared-logic/src/Result/types';
17
+ import { DateTimeFilterOptions } from '../../shared-logic/src/DateTime/types';
14
18
  export type { ViewConfiguration } from '../../shared-logic/src/ViewConfiguration/types';
15
19
  export { VizzlyInstanceNotLoaded } from './errors/VizzlyInstanceNotLoaded';
16
20
  export declare type Options = {
@@ -31,6 +35,7 @@ export declare type VizzlyServicesProperties = {
31
35
  };
32
36
  declare class VizzlyServices {
33
37
  private queryEngineConfig;
38
+ static queryEngine: QueryEngineEndpoint | loadQueryEngineConfigCallback | undefined;
34
39
  private dataSets;
35
40
  private identityConfig;
36
41
  private vizzlyAPIClient;
@@ -70,6 +75,14 @@ declare class VizzlyServices {
70
75
  */
71
76
  getViewConfiguration(): ViewConfiguration;
72
77
  getIdentityConfig(): IdentityConfig;
78
+ query(queries: Query[], params?: {
79
+ abortController?: AbortController;
80
+ instanceId?: string;
81
+ runQueries?: CustomDriver['runQueries'];
82
+ data?: loadDataCallback;
83
+ queryEngineEndpoint?: QueryEngineEndpoint;
84
+ dateFilterOptions?: DateTimeFilterOptions;
85
+ }): Promise<QueryResponse>;
73
86
  static upcastDashboard(dashboard: DashboardFromAPI, dataSets: DataSet[], queryEngineConfig: QueryEngineConfig): Array<DashboardLogic.Dashboard>;
74
87
  static filterDashboards(dashboards: DashboardLogic.Dashboard[], options: FilterDashboardOptions): DashboardLogic.Dashboard[];
75
88
  static validateDashboard(dashboard: unknown): void;
@@ -139,5 +152,9 @@ export declare type CreateDashboardParams = {
139
152
  parentDashboardId: string;
140
153
  abortSignal?: AbortSignal;
141
154
  };
155
+ export declare type Query = QueryAttributes;
156
+ export declare type QueryResponse = {
157
+ results: (Result | null)[] | (any[][] | null)[] | null;
158
+ };
142
159
  export declare type Vizzly = VizzlyServices;
143
160
  export declare const Vizzly: typeof VizzlyServices;
@@ -0,0 +1,2 @@
1
+ export * from './query';
2
+ export * from './dashboard';
@@ -0,0 +1,3 @@
1
+ import { Query } from 'src';
2
+ import { QueryEngineConfig } from '../../../shared-logic/src/QueryEngineConfig/types';
3
+ export declare const validateQuery: (params: Query[], queryEngineConfig: QueryEngineConfig) => void;
@@ -19,15 +19,17 @@ export declare const baseAttributesSchema: (attributeSchemaOptions: ComponentInt
19
19
  protectedByOrganisation: Joi.BooleanSchema<boolean>;
20
20
  };
21
21
  export declare const approxAxisLabelCountSchema: Joi.AnySchema<any>;
22
- export declare const timeDimensionQuerySchema: (queryEngineConfig: QueryEngineConfig, attributeSchemaOptions: ComponentInterfaceConfig['attributesSchemaOptions']) => {
22
+ export declare const querySchema: (queryEngineConfig: QueryEngineConfig, attributeSchemaOptions: ComponentInterfaceConfig['attributesSchemaOptions']) => {
23
23
  measure: Joi.ArraySchema<any[]>;
24
24
  dimension: Joi.ArraySchema<any[]>;
25
- drilldown: Joi.AlternativesSchema<string | any[]>;
26
25
  order: Joi.ArraySchema<any[]>;
27
- timeDimension: Joi.AlternativesSchema<any>;
28
26
  limit: Joi.NumberSchema<number>;
29
27
  offset: Joi.NumberSchema<number>;
30
28
  filter: Joi.ArraySchema<any[]>;
29
+ };
30
+ export declare const timeDimensionQuerySchema: (queryEngineConfig: QueryEngineConfig, attributeSchemaOptions: ComponentInterfaceConfig['attributesSchemaOptions']) => {
31
+ timeDimension: Joi.AlternativesSchema<any>;
32
+ drilldown: Joi.AlternativesSchema<string | any[]>;
31
33
  xAxisPrefix: Joi.StringSchema<string>;
32
34
  yAxisPrefix: Joi.StringSchema<string>;
33
35
  xAxisPostfix: Joi.StringSchema<string>;
@@ -36,6 +38,12 @@ export declare const timeDimensionQuerySchema: (queryEngineConfig: QueryEngineCo
36
38
  xAxisFormat: Joi.AlternativesSchema<any>;
37
39
  approxYAxisLabelCount: Joi.AnySchema<any>;
38
40
  approxXAxisLabelCount: Joi.AnySchema<any>;
41
+ measure: Joi.ArraySchema<any[]>;
42
+ dimension: Joi.ArraySchema<any[]>;
43
+ order: Joi.ArraySchema<any[]>;
44
+ limit: Joi.NumberSchema<number>;
45
+ offset: Joi.NumberSchema<number>;
46
+ filter: Joi.ArraySchema<any[]>;
39
47
  };
40
48
  export declare const lineCurveSchema: Joi.StringSchema<string>;
41
49
  export declare const protectedFieldsMeasure: (queryEngineConfig: QueryEngineConfig) => Joi.ArraySchema<any[]>;
@@ -11,6 +11,7 @@ export declare type getNumberFormatter = (formatterId: string | undefined | null
11
11
  export declare type FormatType = string | null;
12
12
  export declare type ApproxAxisLabelCount = 'auto' | number;
13
13
  export declare type ComponentType = 'barChart' | 'horizontalBarChart' | 'areaChart' | 'lineChart' | 'scatterChart' | 'pieChart' | 'singleStat' | 'dataTable' | 'basicTable' | 'comboChart' | 'mercatorMap' | 'custom' | 'progress';
14
+ export declare const componentTypes: string[];
14
15
  export declare namespace Component {
15
16
  export type LineCurve = 'natural' | 'straight' | 'step' | 'stepBefore' | 'stepAfter';
16
17
  export type RawComponent = Omit<Component, 'queries' | 'results' | 'span'> & {
@@ -69,7 +70,8 @@ export declare namespace Component {
69
70
  };
70
71
  export type CustomComponentAttributes = BaseAttributes & {
71
72
  type: 'custom';
72
- id: string;
73
+ viewId: string;
74
+ customComponentId: string;
73
75
  };
74
76
  export type AxisTitles = {
75
77
  x?: string;
@@ -37,8 +37,8 @@ export interface DataPanelNamespaces {
37
37
  field_x_axis?: Section<'fieldCollector'>;
38
38
  field_country?: Section<'fieldCollector'>;
39
39
  sort?: Section<'sort'>;
40
- filter: Section<'filter'>;
41
- custom_metrics: Section<'customMetrics'>;
40
+ filter?: Section<'filter'>;
41
+ custom_metrics?: Section<'customMetrics'>;
42
42
  limit?: Section<'limit'>;
43
43
  pagination?: Section<'pagination'>;
44
44
  combo_chart_dimension?: Section<'comboChartDimension'>;
@@ -0,0 +1,3 @@
1
+ import Joi from '@vizzly/joi';
2
+ import { ComponentInterfaceConfig } from '../ComponentInterface/types';
3
+ export declare const attributesSchema: (config: ComponentInterfaceConfig) => Joi.ObjectSchema<any>;
@@ -0,0 +1,3 @@
1
+ import { ViewConstants } from '../ComponentInterface/types/namespaces.types';
2
+ declare const CONSTANTS: ViewConstants;
3
+ export default CONSTANTS;
@@ -1,4 +1,5 @@
1
1
  import { Component } from '../Component/types';
2
- import { ComponentInterface } from '../ComponentInterface/types';
3
- declare const CustomChart: ComponentInterface<Component.CustomComponentAttributes, Component.CustomComponentAttributes>;
2
+ import { LoadComponentInterface } from '../ComponentInterface/types';
3
+ import { DumpedCustomComponentAttributes } from './types';
4
+ declare const CustomChart: LoadComponentInterface<Component.CustomComponentAttributes, DumpedCustomComponentAttributes>;
4
5
  export default CustomChart;
@@ -0,0 +1,27 @@
1
+ /// <reference types="react" />
2
+ import { Component } from '../Component/types';
3
+ export declare type CustomComponent = StaticCustomComponent | SelectableCustomComponent;
4
+ export declare type BaseCustomComponent = {
5
+ id: string;
6
+ };
7
+ export declare type StaticCustomComponent = BaseCustomComponent & {
8
+ rowIndex: number;
9
+ cellIndex: number;
10
+ Component: () => JSX.Element | string;
11
+ options?: {
12
+ disableAddCell?: boolean;
13
+ raw?: boolean;
14
+ };
15
+ attributes?: {
16
+ displayTitle?: string;
17
+ displaySubject?: string;
18
+ };
19
+ };
20
+ export declare type SelectableCustomComponent = BaseCustomComponent & {
21
+ title: string;
22
+ Icon: () => JSX.Element;
23
+ Component: ({ attributes }: {
24
+ attributes: Component.CustomComponentAttributes;
25
+ }) => JSX.Element | string;
26
+ };
27
+ export declare type DumpedCustomComponentAttributes = Component.CustomComponentAttributes;
@@ -0,0 +1,105 @@
1
+ import { TimeRangeOptions } from '../AdditionalFilter/types';
2
+ import { TextOverride } from '../Translations/types';
3
+ import { DateTimeFilterOptions } from './types';
4
+ export declare const buildToday: (NOW: Date, description: string) => {
5
+ description: string;
6
+ range: {
7
+ before: Date;
8
+ after: Date;
9
+ };
10
+ };
11
+ export declare const buildYesterday: (NOW: Date, description: string) => {
12
+ description: string;
13
+ range: {
14
+ before: Date;
15
+ after: Date;
16
+ };
17
+ };
18
+ export declare const buildTimeRange: (days: number, months: number, description: string) => {
19
+ description: string;
20
+ range: {
21
+ before: Date;
22
+ after: Date;
23
+ };
24
+ };
25
+ export declare const defaultTimeRangeMapping: (textOverride: TextOverride) => {
26
+ today: {
27
+ description: string;
28
+ range: {
29
+ before: Date;
30
+ after: Date;
31
+ };
32
+ };
33
+ past_1_day: {
34
+ description: string;
35
+ range: {
36
+ before: Date;
37
+ after: Date;
38
+ };
39
+ };
40
+ yesterday: {
41
+ description: string;
42
+ range: {
43
+ before: Date;
44
+ after: Date;
45
+ };
46
+ };
47
+ past_3_days: {
48
+ description: string;
49
+ range: {
50
+ before: Date;
51
+ after: Date;
52
+ };
53
+ };
54
+ past_7_days: {
55
+ description: string;
56
+ range: {
57
+ before: Date;
58
+ after: Date;
59
+ };
60
+ };
61
+ past_30_days: {
62
+ description: string;
63
+ range: {
64
+ before: Date;
65
+ after: Date;
66
+ };
67
+ };
68
+ past_90_days: {
69
+ description: string;
70
+ range: {
71
+ before: Date;
72
+ after: Date;
73
+ };
74
+ };
75
+ past_3_months: {
76
+ description: string;
77
+ range: {
78
+ before: Date;
79
+ after: Date;
80
+ };
81
+ };
82
+ past_6_months: {
83
+ description: string;
84
+ range: {
85
+ before: Date;
86
+ after: Date;
87
+ };
88
+ };
89
+ past_12_months: {
90
+ description: string;
91
+ range: {
92
+ before: Date;
93
+ after: Date;
94
+ };
95
+ };
96
+ past_18_months: {
97
+ description: string;
98
+ range: {
99
+ before: Date;
100
+ after: Date;
101
+ };
102
+ };
103
+ };
104
+ export declare const defaultDateFilterOptions: () => DateTimeFilterOptions;
105
+ export declare const build: (textOverride: TextOverride, overrides?: DateTimeFilterOptions) => TimeRangeOptions;
@@ -0,0 +1,8 @@
1
+ import { DataSet } from '../../../shared-logic/src/DataSet/types';
2
+ import { loadDataCallback } from '../Callbacks/types';
3
+ import { DataMap } from './types';
4
+ export declare const cachedData: {
5
+ [cacheKey: string]: DataMap[] | null;
6
+ };
7
+ export declare const _clearAllDataDownloadThrottles: () => void;
8
+ export declare const fetchData: (dataSet: DataSet, doFetch: loadDataCallback, cacheKey: string) => Promise<DataMap[] | null>;
@@ -0,0 +1,2 @@
1
+ import * as f from '@vizzly/in-memory-db';
2
+ export declare const getInMemoryDb: () => typeof f;
@@ -0,0 +1,5 @@
1
+ import { Query } from '../../../shared-logic/src/Query/types';
2
+ import { DataSet as DataSetType } from '../../../shared-logic/src/DataSet/types';
3
+ import { Result } from '../../../shared-logic/src/Result/types';
4
+ import { loadDataCallback } from '../Callbacks/types';
5
+ export declare const localRunQueriesCallback: (queries: Query[], dataSets: DataSetType[], doFetch: loadDataCallback, cacheKeyPrefix?: string) => Promise<Result['content'][]>;
@@ -0,0 +1,7 @@
1
+ import { DataSet } from '../DataSet/types';
2
+ import { JSQueryEngineQuery } from './types';
3
+ import { Result } from '../Result/types';
4
+ import { SqlAST } from '@vizzly/sqldialects';
5
+ import { PreparedQuery } from '../Query/types';
6
+ export declare const buildWhereAST: (filter: JSQueryEngineQuery['filter'], dataSet: DataSet) => SqlAST['where'];
7
+ export declare const runQueryV3: (query: JSQueryEngineQuery | PreparedQuery, dataSet: DataSet) => Promise<Result['content']>;
@@ -61,6 +61,9 @@ export declare namespace QueryNameSpace {
61
61
  value: string;
62
62
  } | {
63
63
  type: 'null';
64
+ } | {
65
+ type: 'boolean';
66
+ value: boolean | null;
64
67
  };
65
68
  type ComplexType<SupportedFunction = string, ComparisonOperator = string, MathsOp = string> = {
66
69
  type: 'field';
@@ -2,7 +2,7 @@ import { SupportedAggregates } from '../Aggregate';
2
2
  import { SupportedTimeTruncFunctions } from '../TimeDimension/types';
3
3
  import { SupportedOperators } from '../QueryAttributes/types';
4
4
  import { SupportedTransformationFunctions } from '../Functions/types';
5
- export declare type SupportedFeature = 'subquery' | 'simpleMaths' | 'aggregateMaths' | 'switchField' | 'configManagerUi' | 'roundedNumbers' | 'sqlDefinedDataSet' | 'encryptedDashboards' | 'sqlViews' | 'dateMaths' | 'conditional';
5
+ export declare type SupportedFeature = 'subquery' | 'simpleMaths' | 'aggregateMaths' | 'switchField' | 'configManagerUi' | 'roundedNumbers' | 'sqlDefinedDataSet' | 'encryptedDashboards' | 'sqlViews' | 'dateMaths';
6
6
  export declare type QueryEngineConfig = {
7
7
  origin?: 'in-browser' | 'query-engine' | 'custom';
8
8
  supportedFeatures: SupportedFeature[];
@@ -0,0 +1,3 @@
1
+ import { PreparedQuery, Query } from '../../Query/types';
2
+ import { QueryEngineEndpoint } from '../../QueryEngineConfig/types';
3
+ export declare const createResults: (queries: (Query | PreparedQuery)[], queryEngineEndpoint: QueryEngineEndpoint, dataAccessToken?: string, abortSignal?: AbortSignal) => Promise<any[][][] | null>;