@malloydata/malloy-interfaces 0.0.298 → 0.0.300

package/dist/to_malloy.js

@@ -55,6 +55,17 @@ function wrap(open, block, close, options) {
 function escapeString(str) {
     return { contents: str, quoteCharacter: '"' }; // TODO
 }
+function join(fragments, separator) {
+    const result = [];
+    for (let i = 0; i < fragments.length; i++) {
+        const fragment = fragments[i];
+        result.push(fragment);
+        if (i < fragments.length - 1) {
+            result.push(separator);
+        }
+    }
+    return result;
+}
 function literalToFragments(literal) {
     var _a, _b;
     switch (literal.kind) {
@@ -268,9 +279,9 @@ function segmentToFragments(segment) {
 function groupedOperationsToFragments(operations) {
     switch (operations[0].kind) {
         case 'aggregate':
-            return aggregateToFragments(operations);
+            return fieldOperationToFragments(operations, 'aggregate');
         case 'group_by':
-            return groupByToFragments(operations);
+            return fieldOperationToFragments(operations, 'group_by');
         case 'order_by':
             return orderByToFragments(operations);
         case 'nest':
@@ -283,6 +294,8 @@ function groupedOperationsToFragments(operations) {
             return havingToFragments(operations);
         case 'drill':
             return drillToFragments(operations);
+        case 'calculate':
+            return fieldOperationToFragments(operations, 'calculate');
     }
 }
 function formatBlock(label, items, separator = '') {
@@ -320,6 +333,7 @@ function timeUnitToFragment(timeUnit) {
     return timeUnit;
 }
 function expressionToFragments(expression) {
+    var _a;
     switch (expression.kind) {
         case 'field_reference':
             return referenceToFragments(expression);
@@ -336,9 +350,31 @@ function expressionToFragments(expression) {
             ];
         case 'literal_value':
             return literalToFragments(expression.literal_value);
+        case 'moving_average': {
+            const fragments = [
+                'avg_moving',
+                ...wrap('(', [
+                    ...referenceToFragments(expression.field_reference),
+                    expression.rows_preceding !== undefined
+                        ? `, ${expression.rows_preceding}`
+                        : ', 0',
+                    expression.rows_following !== undefined
+                        ? `, ${expression.rows_following}`
+                        : '',
+                ], ')', { spaces: false }),
+            ];
+            if ((_a = expression.partition_fields) === null || _a === void 0 ? void 0 : _a.length) {
+                fragments.push(...wrap(' {', [
+                    'partition_by',
+                    ': ',
+                    ...join(expression.partition_fields.flatMap(partitionField => referenceToFragments(partitionField)), ', '),
+                ], '}'));
+            }
+            return fragments;
+        }
     }
 }
-function groupByOrAggregateItemToFragments(item, hideAnnotations = false) {
+function fieldItemToFragments(item, hideAnnotations = false) {
     const fragments = [];
     if (!hideAnnotations) {
         fragments.push(...annotationsToFragments(item.field.annotations));
@@ -350,22 +386,13 @@ function groupByOrAggregateItemToFragments(item, hideAnnotations = false) {
     fragments.push(...fieldToFragments(item.field));
     return fragments;
 }
-function groupByToFragments(groupBy) {
-    const fragments = [];
-    const hoistAnnotations = groupBy.length === 1;
-    if (hoistAnnotations) {
-        fragments.push(...annotationsToFragments(groupBy[0].field.annotations));
-    }
-    fragments.push(...formatBlock('group_by', groupBy.map(i => groupByOrAggregateItemToFragments(i, hoistAnnotations))));
-    return fragments;
-}
-function aggregateToFragments(groupBy) {
+function fieldOperationToFragments(operation, label) {
     const fragments = [];
-    const hoistAnnotations = groupBy.length === 1;
+    const hoistAnnotations = operation.length === 1;
     if (hoistAnnotations) {
-        fragments.push(...annotationsToFragments(groupBy[0].field.annotations));
+        fragments.push(...annotationsToFragments(operation[0].field.annotations));
     }
-    fragments.push(...formatBlock('aggregate', groupBy.map(i => groupByOrAggregateItemToFragments(i, hoistAnnotations))));
+    fragments.push(...formatBlock(label, operation.map(i => fieldItemToFragments(i, hoistAnnotations))));
     return fragments;
 }
 function orderByToFragments(orderBy) {

package/dist/types.d.ts

@@ -73,6 +73,15 @@ export type BooleanLiteral = {
     boolean_value: boolean;
 };
 export type BooleanType = {};
+export type CalculateInfo = {
+    name: string;
+    type: AtomicType;
+    annotations?: Array<Annotation>;
+};
+export type CalculateOperation = {
+    name: string;
+    field: Field;
+};
 export type CellType = 'string_cell' | 'boolean_cell' | 'date_cell' | 'timestamp_cell' | 'number_cell' | 'json_cell' | 'record_cell' | 'array_cell' | 'null_cell' | 'sql_native_cell';
 export type Cell = CellWithStringCell | CellWithBooleanCell | CellWithDateCell | CellWithTimestampCell | CellWithNumberCell | CellWithJSONCell | CellWithRecordCell | CellWithArrayCell | CellWithNullCell | CellWithSQLNativeCell;
 export type CellWithStringCell = {
@@ -108,6 +117,7 @@ export type CellWithSQLNativeCell = {
 export type CompileModelRequest = {
     model_url: string;
     extend_model_url?: string;
+    exclude_references?: boolean;
     compiler_needs?: CompilerNeeds;
 };
 export type CompileModelResponse = {
@@ -119,8 +129,10 @@ export type CompileModelResponse = {
 };
 export type CompileQueryRequest = {
     model_url: string;
-    query: Query;
+    query?: Query;
+    query_malloy?: string;
     default_row_limit?: number;
+    exclude_references?: boolean;
     compiler_needs?: CompilerNeeds;
 };
 export type CompileQueryResponse = {
@@ -135,6 +147,7 @@ export type CompileSourceRequest = {
     model_url: string;
     name: string;
     extend_model_url?: string;
+    exclude_references?: boolean;
     compiler_needs?: CompilerNeeds;
 };
 export type CompileSourceResponse = {
@@ -190,8 +203,8 @@ export type DocumentRange = {
 export type DrillOperation = {
     filter: Filter;
 };
-export type ExpressionType = 'field_reference' | 'time_truncation' | 'filtered_field' | 'literal_value';
-export type Expression = ExpressionWithFieldReference | ExpressionWithTimeTruncation | ExpressionWithFilteredField | ExpressionWithLiteralValue;
+export type ExpressionType = 'field_reference' | 'time_truncation' | 'filtered_field' | 'literal_value' | 'moving_average';
+export type Expression = ExpressionWithFieldReference | ExpressionWithTimeTruncation | ExpressionWithFilteredField | ExpressionWithLiteralValue | ExpressionWithMovingAverage;
 export type ExpressionWithFieldReference = {
     kind: 'field_reference';
 } & Reference;
@@ -204,12 +217,15 @@ export type ExpressionWithFilteredField = {
 export type ExpressionWithLiteralValue = {
     kind: 'literal_value';
 } & LiteralValueExpression;
+export type ExpressionWithMovingAverage = {
+    kind: 'moving_average';
+} & MovingAverage;
 export type Field = {
     expression: Expression;
     annotations?: Array<Annotation>;
 };
-export type FieldInfoType = 'dimension' | 'measure' | 'join' | 'view';
-export type FieldInfo = FieldInfoWithDimension | FieldInfoWithMeasure | FieldInfoWithJoin | FieldInfoWithView;
+export type FieldInfoType = 'dimension' | 'measure' | 'join' | 'view' | 'calculate';
+export type FieldInfo = FieldInfoWithDimension | FieldInfoWithMeasure | FieldInfoWithJoin | FieldInfoWithView | FieldInfoWithCalculate;
 export type FieldInfoWithDimension = {
     kind: 'dimension';
 } & DimensionInfo;
@@ -222,6 +238,9 @@ export type FieldInfoWithJoin = {
 export type FieldInfoWithView = {
     kind: 'view';
 } & ViewInfo;
+export type FieldInfoWithCalculate = {
+    kind: 'calculate';
+} & CalculateInfo;
 export type File = {
     url: string;
     contents?: string;
@@ -345,6 +364,12 @@ export type ModelInfo = {
     annotations?: Array<Annotation>;
     anonymous_queries: Array<AnonymousQueryInfo>;
 };
+export type MovingAverage = {
+    field_reference: Reference;
+    rows_preceding?: number;
+    rows_following?: number;
+    partition_fields?: Array<Reference>;
+};
 export type Nest = {
     name?: string;
     view: View;
@@ -479,6 +504,7 @@ export type Result = {
 export type RunIndexQueryRequest = {
     model_url: string;
     source_name: string;
+    exclude_references?: boolean;
     compiler_needs?: CompilerNeeds;
 };
 export type RunIndexQueryResponse = {
@@ -488,8 +514,10 @@ export type RunIndexQueryResponse = {
 };
 export type RunQueryRequest = {
     model_url: string;
-    query: Query;
+    query?: Query;
+    query_malloy?: string;
     default_row_limit?: number;
+    exclude_references?: boolean;
     compiler_needs?: CompilerNeeds;
 };
 export type RunQueryResponse = {
@@ -584,8 +612,8 @@ export type ViewInfo = {
     annotations?: Array<Annotation>;
     definition?: View;
 };
-export type ViewOperationType = 'group_by' | 'aggregate' | 'order_by' | 'limit' | 'where' | 'nest' | 'having' | 'drill';
-export type ViewOperation = ViewOperationWithGroupBy | ViewOperationWithAggregate | ViewOperationWithOrderBy | ViewOperationWithLimit | ViewOperationWithWhere | ViewOperationWithNest | ViewOperationWithHaving | ViewOperationWithDrill;
+export type ViewOperationType = 'group_by' | 'aggregate' | 'order_by' | 'limit' | 'where' | 'nest' | 'having' | 'drill' | 'calculate';
+export type ViewOperation = ViewOperationWithGroupBy | ViewOperationWithAggregate | ViewOperationWithOrderBy | ViewOperationWithLimit | ViewOperationWithWhere | ViewOperationWithNest | ViewOperationWithHaving | ViewOperationWithDrill | ViewOperationWithCalculate;
 export type ViewOperationWithGroupBy = {
     kind: 'group_by';
 } & GroupBy;
@@ -610,6 +638,9 @@ export type ViewOperationWithHaving = {
 export type ViewOperationWithDrill = {
     kind: 'drill';
 } & DrillOperation;
+export type ViewOperationWithCalculate = {
+    kind: 'calculate';
+} & CalculateOperation;
 export type ViewRefinement = {
     base: ViewDefinition;
     refinement: ViewDefinition;

package/dist/types.js

@@ -134,6 +134,43 @@ exports.MALLOY_INTERFACE_TYPES = {
         'name': 'BooleanType',
         'fields': {},
     },
+    'CalculateInfo': {
+        'type': 'struct',
+        'name': 'CalculateInfo',
+        'fields': {
+            'name': {
+                'type': 'string',
+                'optional': false,
+                'array': false,
+            },
+            'type': {
+                'type': 'AtomicType',
+                'optional': false,
+                'array': false,
+            },
+            'annotations': {
+                'type': 'Annotation',
+                'array': true,
+                'optional': true,
+            },
+        },
+    },
+    'CalculateOperation': {
+        'type': 'struct',
+        'name': 'CalculateOperation',
+        'fields': {
+            'name': {
+                'type': 'string',
+                'optional': false,
+                'array': false,
+            },
+            'field': {
+                'type': 'Field',
+                'optional': false,
+                'array': false,
+            },
+        },
+    },
     'Cell': {
         'type': 'union',
         'name': 'Cell',
@@ -164,6 +201,11 @@ exports.MALLOY_INTERFACE_TYPES = {
                 'optional': true,
                 'array': false,
             },
+            'exclude_references': {
+                'type': 'boolean',
+                'optional': true,
+                'array': false,
+            },
             'compiler_needs': {
                 'type': 'CompilerNeeds',
                 'optional': true,
@@ -213,7 +255,12 @@ exports.MALLOY_INTERFACE_TYPES = {
             },
             'query': {
                 'type': 'Query',
-                'optional': false,
+                'optional': true,
+                'array': false,
+            },
+            'query_malloy': {
+                'type': 'string',
+                'optional': true,
                 'array': false,
             },
             'default_row_limit': {
@@ -221,6 +268,11 @@ exports.MALLOY_INTERFACE_TYPES = {
                 'optional': true,
                 'array': false,
             },
+            'exclude_references': {
+                'type': 'boolean',
+                'optional': true,
+                'array': false,
+            },
             'compiler_needs': {
                 'type': 'CompilerNeeds',
                 'optional': true,
@@ -283,6 +335,11 @@ exports.MALLOY_INTERFACE_TYPES = {
                 'optional': true,
                 'array': false,
             },
+            'exclude_references': {
+                'type': 'boolean',
+                'optional': true,
+                'array': false,
+            },
             'compiler_needs': {
                 'type': 'CompilerNeeds',
                 'optional': true,
@@ -497,6 +554,7 @@ exports.MALLOY_INTERFACE_TYPES = {
             'time_truncation': 'TimeTruncationFieldReference',
             'filtered_field': 'FilteredField',
             'literal_value': 'LiteralValueExpression',
+            'moving_average': 'MovingAverage',
         },
     },
     'Field': {
@@ -523,6 +581,7 @@ exports.MALLOY_INTERFACE_TYPES = {
             'measure': 'MeasureInfo',
             'join': 'JoinInfo',
             'view': 'ViewInfo',
+            'calculate': 'CalculateInfo',
         },
     },
     'File': {
@@ -841,6 +900,32 @@ exports.MALLOY_INTERFACE_TYPES = {
             },
         },
     },
+    'MovingAverage': {
+        'type': 'struct',
+        'name': 'MovingAverage',
+        'fields': {
+            'field_reference': {
+                'type': 'Reference',
+                'optional': false,
+                'array': false,
+            },
+            'rows_preceding': {
+                'type': 'number',
+                'optional': true,
+                'array': false,
+            },
+            'rows_following': {
+                'type': 'number',
+                'optional': true,
+                'array': false,
+            },
+            'partition_fields': {
+                'type': 'Reference',
+                'array': true,
+                'optional': true,
+            },
+        },
+    },
     'Nest': {
         'type': 'struct',
         'name': 'Nest',
@@ -1230,6 +1315,11 @@ exports.MALLOY_INTERFACE_TYPES = {
                 'optional': false,
                 'array': false,
             },
+            'exclude_references': {
+                'type': 'boolean',
+                'optional': true,
+                'array': false,
+            },
             'compiler_needs': {
                 'type': 'CompilerNeeds',
                 'optional': true,
@@ -1269,7 +1359,12 @@ exports.MALLOY_INTERFACE_TYPES = {
             },
             'query': {
                 'type': 'Query',
-                'optional': false,
+                'optional': true,
+                'array': false,
+            },
+            'query_malloy': {
+                'type': 'string',
+                'optional': true,
                 'array': false,
             },
             'default_row_limit': {
@@ -1277,6 +1372,11 @@ exports.MALLOY_INTERFACE_TYPES = {
                 'optional': true,
                 'array': false,
             },
+            'exclude_references': {
+                'type': 'boolean',
+                'optional': true,
+                'array': false,
+            },
             'compiler_needs': {
                 'type': 'CompilerNeeds',
                 'optional': true,
@@ -1633,6 +1733,7 @@ exports.MALLOY_INTERFACE_TYPES = {
             'nest': 'Nest',
             'having': 'FilterOperation',
             'drill': 'DrillOperation',
+            'calculate': 'CalculateOperation',
         },
     },
     'ViewRefinement': {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@malloydata/malloy-interfaces",
-  "version": "0.0.298",
+  "version": "0.0.300",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/thrift/malloy.thrift

@@ -95,6 +95,7 @@ union FieldInfo {
   2: required MeasureInfo measure,
   3: required JoinInfo join,
   4: required ViewInfo view,
+  5: required CalculateInfo calculate,
 }
 
 // TODO should these just be "AtomicField" with a "fieldtype"
@@ -140,6 +141,12 @@ struct ViewInfo {
   // Possibly need `filterList` depending on how we do drills
 }
 
+struct CalculateInfo {
+  1: required string name,
+  2: required AtomicType type,
+  3: optional list<Annotation> annotations,
+}
+
 struct View {
   2: required ViewDefinition definition,
   3: optional list<Annotation> annotations,
@@ -265,6 +272,7 @@ union ViewOperation {
   6: required Nest nest,
   7: required FilterOperation having,
   8: required DrillOperation drill,
+  9: required CalculateOperation calculate,
 }
 
 struct GroupBy {
@@ -310,6 +318,11 @@ struct DrillOperation {
   1: required Filter filter,
 }
 
+struct CalculateOperation {
+  1: required string name,
+  2: required Field field,
+}
+
 union Filter {
   1: required FilterStringApplication filter_string,
   2: required LiteralEqualityComparison literal_equality,
@@ -452,6 +465,7 @@ union Expression {
   2: required TimeTruncationFieldReference time_truncation,
   3: required FilteredField filtered_field,
   4: required LiteralValueExpression literal_value,
+  5: required MovingAverage moving_average
 }
 
 struct TimeTruncationFieldReference {
@@ -464,6 +478,13 @@ struct FilteredField {
   2: required list<FilterOperation> where,
 }
 
+struct MovingAverage {
+  1: required Reference field_reference,
+  2: optional i32 rows_preceding,
+  3: optional i32 rows_following,
+  4: optional list<Reference> partition_fields,
+}
+
 struct StringCell {
   1: required string string_value,
 }
@@ -645,9 +666,14 @@ struct TimingInfo {
 // Given the URL to a model, return the StableModelDef for that model
 
 struct CompileModelRequest {
+  // Main parameters
   1: required string model_url,
   2: optional string extend_model_url,
 
+  // Options
+  4: optional bool exclude_references,
+
+  // Response to compiler needs
   9: optional CompilerNeeds compiler_needs,
 }
 
@@ -663,10 +689,15 @@ struct CompileModelResponse {
 // Given the URL to a model and a name of a queryable thing, get a StableSourceDef
 
 struct CompileSourceRequest {
+  // Main parameters
   1: required string model_url,
   2: required string name,
   3: optional string extend_model_url,
 
+  // Options
+  4: optional bool exclude_references,
+
+  // Response to compiler needs
   9: optional CompilerNeeds compiler_needs,
 }
 
@@ -681,10 +712,16 @@ struct CompileSourceResponse {
 // Given a StableQueryDef and the URL to a model, run it and return a StableResult
 
 struct RunQueryRequest {
+  // Main parameters
   1: required string model_url,
-  2: required Query query,
+  2: optional Query query,
+  5: optional string query_malloy,
+
+  // Options
   3: optional i32 default_row_limit,
+  4: optional bool exclude_references,
 
+  // Response to compiler needs
   9: optional CompilerNeeds compiler_needs,
 }
 
@@ -700,10 +737,16 @@ struct RunQueryResponse {
 // Given a StableQueryDef and the URL to a model, compile it and return a StableResultDef
 
 struct CompileQueryRequest {
+  // Main parameters
   1: required string model_url,
-  2: required Query query,
+  2: optional Query query,
+  5: optional string query_malloy,
+
+  // Options
   3: optional i32 default_row_limit,
+  4: optional bool exclude_references,
 
+  // Response to compiler needs
   9: optional CompilerNeeds compiler_needs,
 }
 
@@ -720,9 +763,14 @@ struct CompileQueryResponse {
 // Given a URL to a model and the name of a source, run the indexing query
 
 struct RunIndexQueryRequest {
+  // Main parameters
   1: required string model_url,
   2: required string source_name,
 
+  // Options
+  4: optional bool exclude_references,
+
+  // Response to compiler needs
   9: optional CompilerNeeds compiler_needs,
 }