@vizzly/services 0.15.0-dev-3d764e5c2346be462bbcf7327369903e64b96b40 → 0.15.1-dev-7c85efb9d70a7b5e5367d265c0b48faf46ecac6e

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

@@ -1,15 +1,108 @@
 import { DataSet } from '../DataSet/types';
-import { QueryNameSpace, SQLQuery } from '@vizzly/sqlbuilder-public';
-export type { QueryNameSpace } from '@vizzly/sqlbuilder-public';
+export declare namespace QueryNameSpace {
+    /**
+     * Which direction should the values be sorted in?
+     */
+    type SortDirection = 'asc' | 'desc';
+    /**
+     * ID of the field. This is the same ID that is used in
+     * the data sets.
+     */
+    type Field = string;
+    /**
+     * Index of the measure to group the aggregates on.
+     * Index starts from 0.
+     */
+    type Group = {
+        index: number;
+    };
+    /**
+     * Index of the measure to sort the results by.
+     * Index starts from 0.
+     */
+    type Order = {
+        index: number;
+        direction: SortDirection;
+    };
+    /**
+     * Defines filters to apply on the query. This can be thought of
+     * as the WHERE clause in a SQL statement.
+     */
+    type Filter<Field, ComparisonOperator> = {
+        field: Field | BasicType;
+        op: ComparisonOperator;
+        value: any;
+    };
+    type SecureFilterGuard<ComparisonOperator> = {
+        fieldId: string;
+        op: ComparisonOperator;
+    };
+    /**
+     * Limit the number of results returned from the query.
+     */
+    type Limit = number;
+    /**
+     * Sets the offset of results to return.
+     */
+    type Offset = number;
+    type Cases<SupportedFunction = string, ComparisonOperator = string, MathsOp = string> = {
+        returns: BasicType | {
+            type: 'field';
+            value: string;
+            function: SupportedFunction;
+        };
+        filter: QueryNameSpace.Filter<QueryNameSpace.FieldDefinition<SupportedFunction, ComparisonOperator, MathsOp>, ComparisonOperator>[][];
+    };
+    type BasicType = {
+        type: 'number';
+        value: number;
+    } | {
+        type: 'string';
+        value: string;
+    } | {
+        type: 'null';
+    } | {
+        type: 'boolean';
+        value: boolean | null;
+    };
+    type ComplexType<SupportedFunction = string, ComparisonOperator = string, MathsOp = string> = {
+        type: 'field';
+        value: string;
+        function: SupportedFunction;
+    } | {
+        type: 'switchField';
+        value: {
+            cases: Cases<SupportedFunction, ComparisonOperator, MathsOp>[];
+        };
+    } | {
+        type: 'subquery';
+        value: SubQuery<SupportedFunction, ComparisonOperator, MathsOp>;
+    } | {
+        type: 'maths';
+        left: FieldDefinition<SupportedFunction, ComparisonOperator, MathsOp>;
+        op: MathsOp;
+        right: FieldDefinition<SupportedFunction, ComparisonOperator, MathsOp>;
+    } | {
+        type: 'date_maths';
+        left: FieldDefinition<SupportedFunction, ComparisonOperator, MathsOp>;
+        op: MathsOp;
+        right: FieldDefinition<SupportedFunction, ComparisonOperator, MathsOp>;
+    } | {
+        type: 'function';
+        function: SupportedFunction;
+        value: FieldDefinition<SupportedFunction, ComparisonOperator, MathsOp>;
+    };
+    type FieldDefinition<SupportedFunction = string, ComparisonOperator = string, MathsOp = string> = BasicType | ComplexType<SupportedFunction, ComparisonOperator, MathsOp>;
+}
 export declare type MeasureDescription = {
     /** What is the underlying field of the data set? */
     field: DataSet.Field;
     /** What function was applied? */
     functionId: string;
 };
-export declare type SubQuery = {
-    measure: [QueryNameSpace.FieldDefinition];
-    filter: Query['filter'];
+export declare type SubQuery<SupportedFunction = string, ComparisonOperator = string, MathsOp = string> = {
+    measure: [QueryNameSpace.FieldDefinition<SupportedFunction, ComparisonOperator, MathsOp>];
+    filter: QueryNameSpace.Filter<QueryNameSpace.FieldDefinition<SupportedFunction, ComparisonOperator, MathsOp>, ComparisonOperator>[][];
 };
 /** For when a query cannot be generalised into the TraditionalQuery format. We can provide a very specific query for a specific purpose. */
 declare type BasePreparedQuery<PreparedQueryType> = {
@@ -30,6 +123,16 @@ export declare type PreAggregatedQuery = BasePreparedQuery<'preAggregated'> & {
     };
 };
 export declare type PreparedQuery = UniqueArrayValuesQuery | PreAggregatedQuery;
-export declare type Query = Omit<SQLQuery, 'timeZone'> & {
+/** Most commonly used query format. */
+export declare type Query<SupportedFunction = string, ComparisonOperator = string, MathsOp = string> = {
+    type: 'query';
     timeZone?: string;
+    dataSetId: string;
+    measure: Array<QueryNameSpace.FieldDefinition<SupportedFunction, ComparisonOperator, MathsOp>>;
+    filter: QueryNameSpace.Filter<QueryNameSpace.FieldDefinition<SupportedFunction, ComparisonOperator, MathsOp>, ComparisonOperator>[][];
+    order: Array<QueryNameSpace.Order>;
+    group: Array<QueryNameSpace.Group>;
+    limit?: QueryNameSpace.Limit;
+    offset?: QueryNameSpace.Offset;
 };
+export {};

package/dist/shared-logic/src/api/queryEngine/getRunQueriesCallback.d.ts

@@ -9,7 +9,6 @@ import { Result } from '../../Result/types';
 import { DataSet } from '../../DataSet/types';
 import { IdentityConfig as IdentityConfigType } from '../../IdentityConfig/types';
 import { VariableList } from '../../Variables/types';
-import { AliasFields } from '../../AliasFields/types';
 declare type CallbackError = null;
 export declare type runQueriesCallback = (queries: Component.Attributes | AdditionalFilter | QueryAttributes[] | [PreparedQuery], params: {
     dataSets: DataSet[];
@@ -17,5 +16,5 @@ export declare type runQueriesCallback = (queries: Component.Attributes | Additi
     dataAccessToken?: string;
     filterConfig?: FilterConfig;
 }) => Promise<(Result | null)[] | Array<Result['content'] | null> | CallbackError>;
-declare const getRunQueriesCallback: (identityConfig: IdentityConfigType, queryEngineConfig: QueryEngineConfigType, timeRangeOptions: TimeRangeOptions, variables: VariableList, aliasFields: AliasFields, runQueries?: CustomDriver['runQueries'], data?: loadDataCallback, queryEngineEndpoint?: QueryEngineEndpoint, timeZone?: string) => runQueriesCallback;
+declare const getRunQueriesCallback: (identityConfig: IdentityConfigType, queryEngineConfig: QueryEngineConfigType, timeRangeOptions: TimeRangeOptions, variables: VariableList, runQueries?: CustomDriver['runQueries'], data?: loadDataCallback, queryEngineEndpoint?: QueryEngineEndpoint, timeZone?: string) => runQueriesCallback;
 export default getRunQueriesCallback;

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

@@ -1,6 +1,6 @@
-import { BasicTableComponentInterface } from './BasicTable';
 import { Component, ComponentType } from './Component/types';
 import { ComponentInterface, ComponentInterfaceConfig } from './ComponentInterface/types';
+import { BasicTableComponentInterface } from './BasicTable';
 declare function getComponentInterface(type: 'custom', config?: ComponentInterfaceConfig): ComponentInterface<Component.CustomViewAttributes>;
 declare function getComponentInterface(type: 'pieChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.PieChartAttributes>;
 declare function getComponentInterface(type: 'bubbleChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.BubbleChartAttributes>;

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

@@ -1,4 +1,4 @@
 import { Component } from '../../src/Component/types';
-export declare const getGroupingFeedbackMessage: (attributes: Component.Attributes) => string;
+export declare const getGroupingFeedbackMessage: (attributes: Component.Attributes) => string | null;
 export declare const chartHasDimensions: (attributes: Component.Attributes) => boolean;
-export declare const createFeedback: (attribute: Component.Attributes) => string | true;
+export declare const createFeedback: (attribute: Component.Attributes) => string | true | null;

package/package.json

@@ -26,7 +26,7 @@
     "fix-type-alias": "tsc-alias -p tsconfig.json",
     "prepare": "yarn build"
   },
-  "version": "0.15.0-dev-3d764e5c2346be462bbcf7327369903e64b96b40",
+  "version": "0.15.1-dev-7c85efb9d70a7b5e5367d265c0b48faf46ecac6e",
   "dependencies": {
     "@vizzly/api-client": "0.0.57",
     "@vizzly/joi": "^17.11.0",

package/dist/results-driver/src/driver/VizzlyQuery/HorizontalBarChartV2/toQueries.d.ts

@@ -1,4 +0,0 @@
-export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BubbleChartV2Attributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.FunnelChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartV2Attributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartV2Attributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartV2Attributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.SunburstChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.RichTextAttributes | import("../../../../../shared-logic/src/Component/types").Component.WaterfallChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.RadarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartV2Attributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../../shared-logic/src/DataSet/types").DataSet.Field>, queryEngineConfig: import("@vizzly/semantic-layer-public/dist/types").QueryEngineConfig, params: import("../../../types").Params) => {
-    queries: import("../../../../../shared-logic/src/Query/types").Query[];
-    resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
-};

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

@@ -1,5 +0,0 @@
-export declare type AliasFields = {
-    [dataSetId: string]: {
-        [fieldId: string]: string;
-    };
-};

package/dist/shared-logic/src/CustomField/AliasField/index.d.ts

@@ -1,7 +0,0 @@
-import { Params } from '../../../../results-driver/src/types';
-import { DataSet } from '../../DataSet/types';
-import { Query } from '../../Query/types';
-import { QueryAttributes } from '../../QueryAttributes/types';
-import { QueryEngineConfig } from '../../QueryEngineConfig/types';
-import { AliasFieldType } from '../types';
-export declare const build: (measureAttribute: QueryAttributes.Measure, customField: AliasFieldType, _queryEngineConfig: QueryEngineConfig, dataSet: DataSet, _queryHasDimension: boolean, params: Params) => Query['measure'][number];

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

@@ -1,15 +0,0 @@
-import { Clause } from '../Filter/types';
-export declare const alwaysTrueFilter: {
-    type: Clause.AND_WHERE;
-    value: {
-        type: Clause.WHERE;
-        value: {
-            field: {
-                type: "number";
-                value: number;
-            };
-            op: string;
-            value: number;
-        };
-    }[];
-};

package/dist/shared-logic/src/HorizontalBarChartV2/attributesSchema.d.ts

@@ -1,3 +0,0 @@
-import Joi from '@vizzly/joi';
-import { ComponentInterfaceConfig } from '../ComponentInterface/types';
-export declare const attributesSchema: (config: ComponentInterfaceConfig) => Joi.ObjectSchema<any>;

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

@@ -1,3 +0,0 @@
-import { ViewConstants } from '../ComponentInterface/types/namespaces.types';
-declare const CONSTANTS: ViewConstants;
-export default CONSTANTS;

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

@@ -1,4 +0,0 @@
-import { Component } from '../Component/types';
-import { LoadComponentInterface } from '../ComponentInterface/types';
-declare const HorizontalBarChart: LoadComponentInterface<Component.HorizontalBarChartV2Attributes, Component.HorizontalBarChartV2Attributes>;
-export default HorizontalBarChart;

package/dist/shared-logic/src/HorizontalBarChartV2/setAttributes.d.ts

@@ -1,4 +0,0 @@
-import { Component } from '../Component/types';
-import { ComponentInterfaceConfig } from '../ComponentInterface/types';
-declare const _default: (config: ComponentInterfaceConfig) => (horizontalBarChart: Component.HorizontalBarChartV2Attributes, partial: Partial<Component.HorizontalBarChartV2Attributes>) => Component.HorizontalBarChartV2Attributes;
-export default _default;