@malloydata/malloy-query-builder 0.0.298 → 0.0.300

package/dist/query-ast.d.ts

@@ -856,12 +856,12 @@ export declare class ASTSegmentViewDefinition extends ASTObjectNode<Malloy.ViewD
     private firstIndexOfOperationType;
     private DEFAULT_INSERTION_ORDER;
     private findInsertionPoint;
-    getFieldNamed(name: string): ASTGroupByViewOperation | ASTAggregateViewOperation | ASTNestViewOperation | undefined;
+    getFieldNamed(name: string): ASTGroupByViewOperation | ASTAggregateViewOperation | ASTNestViewOperation | ASTCalculateViewOperation | undefined;
     hasFieldNamed(name: string): boolean;
     hasField(name: string, path?: string[]): boolean;
-    getField(name: string, path?: string[]): ASTGroupByViewOperation | ASTAggregateViewOperation | ASTNestViewOperation;
-    tryGetField(name: string, path?: string[]): ASTGroupByViewOperation | ASTAggregateViewOperation | ASTNestViewOperation | undefined;
-    tryGetFieldNamed(name: string): ASTGroupByViewOperation | ASTAggregateViewOperation | ASTNestViewOperation | undefined;
+    getField(name: string, path?: string[]): ASTGroupByViewOperation | ASTAggregateViewOperation | ASTNestViewOperation | ASTCalculateViewOperation;
+    tryGetField(name: string, path?: string[]): ASTGroupByViewOperation | ASTAggregateViewOperation | ASTNestViewOperation | ASTCalculateViewOperation | undefined;
+    tryGetFieldNamed(name: string): ASTGroupByViewOperation | ASTAggregateViewOperation | ASTNestViewOperation | ASTCalculateViewOperation | undefined;
     getGroupBy(name: string): ASTGroupByViewOperation | undefined;
     removeGroupBy(name: string): this;
     /**
@@ -930,6 +930,7 @@ export declare class ASTSegmentViewDefinition extends ASTObjectNode<Malloy.ViewD
     addHaving(name: string, filterString: string): ASTHavingViewOperation;
     addHaving(name: string, path: string[], filter: ParsedFilter): ASTHavingViewOperation;
     addHaving(name: string, path: string[], filterString: string): ASTHavingViewOperation;
+    addCalculateMovingAverage(outputName: string, inputName: string, inputPath: string[], rowsPreceding: number, rowsFollowing: number): ASTCalculateViewOperation;
     private addTimeGroupBy;
     addDateGroupBy(name: string, path: string[], timeframe: Malloy.DateTimeframe): ASTGroupByViewOperation;
     addDateGroupBy(name: string, timeframe: Malloy.DateTimeframe): ASTGroupByViewOperation;
@@ -1030,7 +1031,7 @@ export declare class ASTViewOperationList extends ASTListNode<Malloy.ViewOperati
      */
     get segment(): ASTSegmentViewDefinition;
 }
-export type ASTViewOperation = ASTGroupByViewOperation | ASTAggregateViewOperation | ASTOrderByViewOperation | ASTNestViewOperation | ASTLimitViewOperation | ASTWhereViewOperation | ASTDrillViewOperation | ASTHavingViewOperation;
+export type ASTViewOperation = ASTGroupByViewOperation | ASTAggregateViewOperation | ASTOrderByViewOperation | ASTNestViewOperation | ASTLimitViewOperation | ASTWhereViewOperation | ASTDrillViewOperation | ASTHavingViewOperation | ASTCalculateViewOperation;
 export declare const ASTViewOperation: {
     from(value: Malloy.ViewOperation): ASTViewOperation;
     isLimit(x: ASTViewOperation): x is ASTLimitViewOperation;
@@ -1186,6 +1187,11 @@ export declare class ASTAggregateViewOperation extends ASTObjectNode<Malloy.View
      * @param name The new name
      */
     rename(name: string): void;
+    /**
+     * Removes this aggregate item from the query and replaces it with a smoothed
+     * calculation of the same field.
+     */
+    convertToCalculateMovingAverage(name: string, rows_preceding: number, rows_following?: number, partition_fields?: string[]): ASTCalculateViewOperation;
     /**
      * @internal
      */
@@ -1238,7 +1244,7 @@ export declare class ASTField extends ASTObjectNode<Malloy.Field, {
     get segment(): ASTSegmentViewDefinition;
     getInheritedAnnotations(): Malloy.Annotation[];
 }
-export type ASTExpression = ASTReferenceExpression | ASTFilteredFieldExpression | ASTTimeTruncationExpression | ASTLiteralValueExpression;
+export type ASTExpression = ASTReferenceExpression | ASTFilteredFieldExpression | ASTTimeTruncationExpression | ASTLiteralValueExpression | ASTMovingAverageExpression;
 export declare const ASTExpression: {
     from(value: Malloy.Expression): ASTExpression;
 };
@@ -1307,6 +1313,33 @@ export declare class ASTLiteralValueExpression extends ASTObjectNode<Malloy.Expr
     getInheritedAnnotations(): Malloy.Annotation[];
     getFieldInfo(): undefined;
 }
+export declare class ASTFieldReferenceList extends ASTListNode<Malloy.Reference, ASTFieldReference> {
+    constructor(fields: Malloy.Reference[]);
+}
+export declare class ASTMovingAverageExpression extends ASTObjectNode<Malloy.ExpressionWithMovingAverage, {
+    kind: 'moving_average';
+    field_reference: ASTFieldReference;
+    rows_preceding?: number;
+    rows_following?: number;
+    partition_fields: ASTFieldReferenceList;
+}> {
+    node: Malloy.ExpressionWithMovingAverage;
+    readonly kind: Malloy.ExpressionType;
+    constructor(node: Malloy.ExpressionWithMovingAverage);
+    getReference(): Malloy.Reference;
+    get fieldReference(): ASTFieldReference;
+    get rowsPreceding(): number | undefined;
+    set rowsPreceding(rows: number | undefined);
+    get rowsFollowing(): number | undefined;
+    set rowsFollowing(rows: number | undefined);
+    get name(): string;
+    get field(): ASTField;
+    get partitionFields(): ASTFieldReferenceList;
+    setPartitionFields(references: Malloy.Reference[]): void;
+    getFieldInfo(): Malloy.FieldInfoWithDimension | Malloy.FieldInfoWithMeasure;
+    get fieldType(): Malloy.AtomicType;
+    getInheritedAnnotations(): Malloy.Annotation[];
+}
 export declare class ASTFilterOperation extends ASTObjectNode<Malloy.FilterOperation, {
     filter: ASTFilter;
 }> {
@@ -1455,6 +1488,25 @@ export declare class ASTHavingViewOperation extends ASTObjectNode<Malloy.ViewOpe
     get list(): ASTViewOperationList;
     delete(): void;
 }
+export declare class ASTCalculateViewOperation extends ASTObjectNode<Malloy.ViewOperationWithCalculate, {
+    kind: 'calculate';
+    field: ASTField;
+    name: string;
+}> {
+    node: Malloy.ViewOperationWithCalculate;
+    readonly kind: Malloy.ViewOperationType;
+    constructor(node: Malloy.ViewOperationWithCalculate);
+    get expression(): ASTMovingAverageExpression;
+    set expression(expression: ASTMovingAverageExpression);
+    get name(): string;
+    set name(name: string);
+    getFieldInfo(): Malloy.FieldInfo;
+    /**
+     * @internal
+     */
+    get list(): ASTViewOperationList;
+    delete(): void;
+}
 export type ASTFilter = ASTFilterWithFilterString | ASTFilterWithLiteralEquality;
 export declare const ASTFilter: {
     from(filter: Malloy.Filter): ASTFilterWithFilterString | ASTFilterWithLiteralEquality;

package/dist/query-ast.js

@@ -33,7 +33,8 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ASTAnnotation = exports.ASTAnnotationList = exports.ASTLimitViewOperation = exports.ASTView = exports.ASTFilterWithLiteralEquality = exports.ASTFilterWithFilterString = exports.ASTFilter = exports.ASTHavingViewOperation = exports.ASTDrillViewOperation = exports.ASTWhereViewOperation = exports.ASTNestViewOperation = exports.ASTFilteredFieldExpression = exports.ASTFilterOperationList = exports.ASTFilterOperation = exports.ASTLiteralValueExpression = exports.ASTTimeTruncationExpression = exports.ASTReferenceExpression = exports.ASTExpression = exports.ASTField = exports.ASTAggregateViewOperation = exports.ASTGroupByViewOperation = exports.ASTOrderByViewOperation = exports.ASTViewOperation = exports.ASTViewOperationList = exports.ASTSegmentViewDefinition = exports.ASTRefinementViewDefinition = exports.ASTArrowViewDefinition = exports.ASTReferenceViewDefinition = exports.ASTReferenceQueryArrowSource = exports.ASTReferenceQueryDefinition = exports.ASTRefinementQueryDefinition = exports.ASTArrowQueryDefinition = exports.ASTQueryDefinition = exports.ASTQueryArrowSource = exports.ASTUnimplemented = exports.ASTFilterExpressionLiteralValue = exports.ASTTimestampLiteralValue = exports.ASTDateLiteralValue = exports.ASTBooleanLiteralValue = exports.ASTNumberLiteralValue = exports.ASTNullLiteralValue = exports.ASTStringLiteralValue = exports.ASTLiteralValue = exports.ASTParameterValue = exports.ASTParameterValueList = exports.ASTFieldReference = exports.ASTReference = exports.ASTQuery = void 0;
+exports.ASTAnnotationList = exports.ASTLimitViewOperation = exports.ASTView = exports.ASTFilterWithLiteralEquality = exports.ASTFilterWithFilterString = exports.ASTFilter = exports.ASTCalculateViewOperation = exports.ASTHavingViewOperation = exports.ASTDrillViewOperation = exports.ASTWhereViewOperation = exports.ASTNestViewOperation = exports.ASTFilteredFieldExpression = exports.ASTFilterOperationList = exports.ASTFilterOperation = exports.ASTMovingAverageExpression = exports.ASTFieldReferenceList = exports.ASTLiteralValueExpression = exports.ASTTimeTruncationExpression = exports.ASTReferenceExpression = exports.ASTExpression = exports.ASTField = exports.ASTAggregateViewOperation = exports.ASTGroupByViewOperation = exports.ASTOrderByViewOperation = exports.ASTViewOperation = exports.ASTViewOperationList = exports.ASTSegmentViewDefinition = exports.ASTRefinementViewDefinition = exports.ASTArrowViewDefinition = exports.ASTReferenceViewDefinition = exports.ASTReferenceQueryArrowSource = exports.ASTReferenceQueryDefinition = exports.ASTRefinementQueryDefinition = exports.ASTArrowQueryDefinition = exports.ASTQueryDefinition = exports.ASTQueryArrowSource = exports.ASTUnimplemented = exports.ASTFilterExpressionLiteralValue = exports.ASTTimestampLiteralValue = exports.ASTDateLiteralValue = exports.ASTBooleanLiteralValue = exports.ASTNumberLiteralValue = exports.ASTNullLiteralValue = exports.ASTStringLiteralValue = exports.ASTLiteralValue = exports.ASTParameterValue = exports.ASTParameterValueList = exports.ASTFieldReference = exports.ASTReference = exports.ASTQuery = void 0;
+exports.ASTAnnotation = void 0;
 /*
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
@@ -1898,6 +1899,7 @@ class ASTSegmentViewDefinition extends ASTObjectNode {
             'having',
             'nest',
             'order_by',
+            'calculate',
             'limit',
         ];
     }
@@ -2169,6 +2171,14 @@ class ASTSegmentViewDefinition extends ASTObjectNode {
                     return operation;
                 }
             }
+            else if (operation instanceof ASTCalculateViewOperation) {
+                const reference = operation.expression.field.getReference();
+                if (reference &&
+                    reference.name === name &&
+                    pathsMatch(reference.path, path)) {
+                    return operation;
+                }
+            }
         }
         return undefined;
     }
@@ -2176,7 +2186,8 @@ class ASTSegmentViewDefinition extends ASTObjectNode {
         for (const operation of this.operations.iter()) {
             if (operation instanceof ASTGroupByViewOperation ||
                 operation instanceof ASTAggregateViewOperation ||
-                operation instanceof ASTNestViewOperation) {
+                operation instanceof ASTNestViewOperation ||
+                operation instanceof ASTCalculateViewOperation) {
                 if (operation.name === name) {
                     return operation;
                 }
@@ -2315,6 +2326,22 @@ class ASTSegmentViewDefinition extends ASTObjectNode {
         this.addOperation(item);
         return item;
     }
+    addCalculateMovingAverage(outputName, inputName, inputPath, rowsPreceding, rowsFollowing) {
+        const item = new ASTCalculateViewOperation({
+            kind: 'calculate',
+            name: outputName,
+            field: {
+                expression: {
+                    kind: 'moving_average',
+                    field_reference: { name: inputName, path: inputPath },
+                    rows_preceding: rowsPreceding,
+                    rows_following: rowsFollowing,
+                },
+            },
+        });
+        this.addOperation(item);
+        return item;
+    }
     addTimeGroupBy(name, path, timeframe, type) {
         const schema = this.getInputSchema();
         const fieldInfo = ASTNode.schemaGet(schema, name, path);
@@ -2428,7 +2455,8 @@ class ASTSegmentViewDefinition extends ASTObjectNode {
     addOperation(item) {
         if (item instanceof ASTGroupByViewOperation ||
             item instanceof ASTAggregateViewOperation ||
-            item instanceof ASTNestViewOperation) {
+            item instanceof ASTNestViewOperation ||
+            item instanceof ASTCalculateViewOperation) {
             if (this.hasFieldNamed(item.name)) {
                 throw new Error(`Query already has a field named ${item.name}`);
             }
@@ -2445,7 +2473,8 @@ class ASTSegmentViewDefinition extends ASTObjectNode {
         for (const operation of this.operations.iter()) {
             if (operation instanceof ASTGroupByViewOperation ||
                 operation instanceof ASTAggregateViewOperation ||
-                operation instanceof ASTNestViewOperation) {
+                operation instanceof ASTNestViewOperation ||
+                operation instanceof ASTCalculateViewOperation) {
                 // TODO convert measures into dimensions for output
                 fields.push(operation.getFieldInfo());
             }
@@ -2561,6 +2590,8 @@ exports.ASTViewOperation = {
                 return new ASTDrillViewOperation(value);
             case 'having':
                 return new ASTHavingViewOperation(value);
+            case 'calculate':
+                return new ASTCalculateViewOperation(value);
         }
     },
     isLimit(x) {
@@ -2833,6 +2864,36 @@ class ASTAggregateViewOperation extends ASTObjectNode {
     rename(name) {
         this.list.segment.renameField(this, name);
     }
+    /**
+     * Removes this aggregate item from the query and replaces it with a smoothed
+     * calculation of the same field.
+     */
+    convertToCalculateMovingAverage(name, rows_preceding, rows_following = 0, partition_fields = []) {
+        if (!(this.field.expression instanceof ASTReferenceExpression)) {
+            throw new Error('Cannot convert aggregate to smoothed metric unless it is a field reference');
+        }
+        this.list.remove(this);
+        const calculateItem = new ASTCalculateViewOperation({
+            kind: 'calculate',
+            name: name,
+            field: {
+                expression: {
+                    kind: 'moving_average',
+                    field_reference: {
+                        name: this.field.expression.name,
+                        path: this.field.expression.path,
+                    },
+                    rows_preceding,
+                    rows_following,
+                    partition_fields: partition_fields.map(fieldName => ({
+                        name: fieldName,
+                    })),
+                },
+            },
+        });
+        this.list.add(calculateItem);
+        return calculateItem;
+    }
     /**
      * @internal
      */
@@ -3031,6 +3092,8 @@ exports.ASTExpression = {
                 return new ASTTimeTruncationExpression(value);
             case 'literal_value':
                 return new ASTLiteralValueExpression(value);
+            case 'moving_average':
+                return new ASTMovingAverageExpression(value);
         }
     },
 };
@@ -3195,6 +3258,74 @@ class ASTLiteralValueExpression extends ASTObjectNode {
     }
 }
 exports.ASTLiteralValueExpression = ASTLiteralValueExpression;
+class ASTFieldReferenceList extends ASTListNode {
+    constructor(fields) {
+        super(fields, fields.map(p => new ASTFieldReference(p)));
+    }
+}
+exports.ASTFieldReferenceList = ASTFieldReferenceList;
+class ASTMovingAverageExpression extends ASTObjectNode {
+    constructor(node) {
+        super(node, {
+            kind: node.kind,
+            field_reference: new ASTFieldReference(node.field_reference),
+            rows_preceding: node.rows_preceding,
+            rows_following: node.rows_following,
+            partition_fields: new ASTFieldReferenceList(node.partition_fields || []),
+        });
+        this.node = node;
+        this.kind = 'moving_average';
+    }
+    getReference() {
+        return this.fieldReference.build();
+    }
+    get fieldReference() {
+        return this.children.field_reference;
+    }
+    get rowsPreceding() {
+        return this.children.rows_preceding;
+    }
+    set rowsPreceding(rows) {
+        this.edit();
+        this.children.rows_preceding = rows;
+    }
+    get rowsFollowing() {
+        return this.children.rows_following;
+    }
+    set rowsFollowing(rows) {
+        this.edit();
+        this.children.rows_following = rows;
+    }
+    get name() {
+        return this.fieldReference.name;
+    }
+    get field() {
+        return this.parent.as.Field();
+    }
+    get partitionFields() {
+        return this.children.partition_fields;
+    }
+    setPartitionFields(references) {
+        this.children.partition_fields = new ASTFieldReferenceList(references);
+    }
+    getFieldInfo() {
+        const schema = this.field.segment.getInputSchema();
+        const def = ASTNode.schemaGet(schema, this.name, this.fieldReference.path);
+        if (def.kind !== 'dimension' && def.kind !== 'measure') {
+            throw new Error('Invalid field for ASTReferenceExpression');
+        }
+        return def;
+    }
+    get fieldType() {
+        return this.getFieldInfo().type;
+    }
+    getInheritedAnnotations() {
+        var _a;
+        const field = this.getFieldInfo();
+        return (_a = field.annotations) !== null && _a !== void 0 ? _a : [];
+    }
+}
+exports.ASTMovingAverageExpression = ASTMovingAverageExpression;
 class ASTFilterOperation extends ASTObjectNode {
     constructor(node) {
         super(node, {
@@ -3487,6 +3618,56 @@ class ASTHavingViewOperation extends ASTObjectNode {
     }
 }
 exports.ASTHavingViewOperation = ASTHavingViewOperation;
+class ASTCalculateViewOperation extends ASTObjectNode {
+    constructor(node) {
+        super(node, {
+            kind: 'calculate',
+            field: new ASTField(node.field),
+            name: node.name,
+        });
+        this.node = node;
+        this.kind = 'calculate';
+    }
+    get expression() {
+        return this.children.field.expression;
+    }
+    set expression(expression) {
+        this.edit();
+        this.children.field.expression = expression;
+        expression.parent = this;
+    }
+    get name() {
+        return this.node.name;
+    }
+    set name(name) {
+        if (this.name === name)
+            return;
+        this.edit();
+        this.node.name = name;
+    }
+    getFieldInfo() {
+        return {
+            annotations: [
+                {
+                    value: malloy_tag_1.Tag.withPrefix('#(malloy) ').set(['calculation']).toString(),
+                },
+            ],
+            kind: 'calculate',
+            name: this.name,
+            type: this.expression.fieldType,
+        };
+    }
+    /**
+     * @internal
+     */
+    get list() {
+        return this.parent.as.ViewOperationList();
+    }
+    delete() {
+        this.list.remove(this);
+    }
+}
+exports.ASTCalculateViewOperation = ASTCalculateViewOperation;
 exports.ASTFilter = {
     from(filter) {
         switch (filter.kind) {
@@ -3717,6 +3898,8 @@ function fieldTypeToAction(type) {
             return 'nest';
         case 'join':
             return 'join';
+        case 'calculate':
+            return 'calculate';
     }
 }
 function fieldTypeName(type) {