@malloydata/malloy-query-builder 0.0.240-dev250305162504 → 0.0.240-dev250305163014

package/flow/query-ast.d.ts

@@ -27,61 +27,67 @@ declare class ASTNode<T> {
   _parentASTAny | void;
   build(): T;
   edit(): this;
-  find(path: Path): ASTAny;
-  asQuery(): ASTQuery;
-  findQuery(path: Path): ASTQuery;
-  asReference(): ASTReference;
-  findReference(path: Path): ASTReference;
-  asSourceReference(): ASTSourceReference;
-  findSourceReference(path: Path): ASTSourceReference;
-  asParameterValueList(): ASTParameterValueList;
-  findParameterValueList(path: Path): ASTParameterValueList;
-  asWhere(): ASTWhere;
-  findWhere(path: Path): ASTWhere;
-  asWhereList(): ASTWhereList;
-  findWhereList(path: Path): ASTWhereList;
-  asParameterValue(): ASTParameterValue;
-  findParameterValue(path: Path): ASTParameterValue;
-  asStringLiteralValue(): ASTStringLiteralValue;
-  findStringLiteralValue(path: Path): ASTStringLiteralValue;
-  asNumberLiteralValue(): ASTNumberLiteralValue;
-  findNumberLiteralValue(path: Path): ASTNumberLiteralValue;
-  asViewOperationList(): ASTViewOperationList;
-  findViewOperationList(path: Path): ASTViewOperationList;
-  asGroupByViewOperation(): ASTGroupByViewOperation;
-  findGroupByViewOperation(path: Path): ASTGroupByViewOperation;
-  asAggregateViewOperation(): ASTAggregateViewOperation;
-  findAggregateViewOperation(path: Path): ASTAggregateViewOperation;
-  asOrderByViewOperation(): ASTOrderByViewOperation;
-  findOrderByViewOperation(path: Path): ASTOrderByViewOperation;
-  asField(): ASTField;
-  findField(path: Path): ASTField;
-  asReferenceExpression(): ASTReferenceExpression;
-  findReferenceExpression(path: Path): ASTReferenceExpression;
-  asReferenceViewDefinition(): ASTReferenceViewDefinition;
-  findReferenceViewDefinition(path: Path): ASTReferenceViewDefinition;
-  asArrowQueryDefinition(): ASTArrowQueryDefinition;
-  findArrowQueryDefinition(path: Path): ASTArrowQueryDefinition;
-  asArrowViewDefinition(): ASTArrowViewDefinition;
-  findArrowViewDefinition(path: Path): ASTArrowViewDefinition;
-  asRefinementViewDefinition(): ASTRefinementViewDefinition;
-  findRefinementViewDefinition(path: Path): ASTRefinementViewDefinition;
-  asTimeTruncationExpression(): ASTTimeTruncationExpression;
-  findTimeTruncationExpression(path: Path): ASTTimeTruncationExpression;
-  asFilteredFieldExpression(): ASTFilteredFieldExpression;
-  findFilteredFieldExpression(path: Path): ASTFilteredFieldExpression;
-  asNestViewOperation(): ASTNestViewOperation;
-  findNestViewOperation(path: Path): ASTNestViewOperation;
-  asView(): ASTView;
-  findView(path: Path): ASTView;
-  asSegmentViewDefinition(): ASTSegmentViewDefinition;
-  findSegmentViewDefinition(path: Path): ASTSegmentViewDefinition;
-  asLimitViewOperation(): ASTLimitViewOperation;
-  findLimitViewOperation(path: Path): ASTLimitViewOperation;
-  asAnnotationList(): ASTAnnotationList;
-  findAnnotationList(path: Path): ASTAnnotationList;
-  asAnnotation(): ASTAnnotation;
-  findAnnotation(path: Path): ASTAnnotation;
+  findAny(path: Path): ASTAny;
+  get as(): {
+    Query(): ASTQuery,
+    Reference(): ASTReference,
+    SourceReference(): ASTSourceReference,
+    ParameterValueList(): ASTParameterValueList,
+    Where(): ASTWhere,
+    WhereList(): ASTWhereList,
+    ParameterValue(): ASTParameterValue,
+    StringLiteralValue(): ASTStringLiteralValue,
+    NumberLiteralValue(): ASTNumberLiteralValue,
+    ViewOperationList(): ASTViewOperationList,
+    GroupByViewOperation(): ASTGroupByViewOperation,
+    AggregateViewOperation(): ASTAggregateViewOperation,
+    OrderByViewOperation(): ASTOrderByViewOperation,
+    Field(): ASTField,
+    ReferenceExpression(): ASTReferenceExpression,
+    ReferenceViewDefinition(): ASTReferenceViewDefinition,
+    ArrowQueryDefinition(): ASTArrowQueryDefinition,
+    ArrowViewDefinition(): ASTArrowViewDefinition,
+    RefinementViewDefinition(): ASTRefinementViewDefinition,
+    TimeTruncationExpression(): ASTTimeTruncationExpression,
+    FilteredFieldExpression(): ASTFilteredFieldExpression,
+    NestViewOperation(): ASTNestViewOperation,
+    View(): ASTView,
+    SegmentViewDefinition(): ASTSegmentViewDefinition,
+    LimitViewOperation(): ASTLimitViewOperation,
+    AnnotationList(): ASTAnnotationList,
+    Annotation(): ASTAnnotation,
+    ...
+  };
+  get find(): {
+    Query(path: Path): ASTQuery,
+    Reference(path: Path): ASTReference,
+    SourceReference(path: Path): ASTSourceReference,
+    ParameterValueList(path: Path): ASTParameterValueList,
+    Where(path: Path): ASTWhere,
+    WhereList(path: Path): ASTWhereList,
+    ParameterValue(path: Path): ASTParameterValue,
+    StringLiteralValue(path: Path): ASTStringLiteralValue,
+    NumberLiteralValue(path: Path): ASTNumberLiteralValue,
+    ViewOperationList(path: Path): ASTViewOperationList,
+    GroupByViewOperation(path: Path): ASTGroupByViewOperation,
+    AggregateViewOperation(path: Path): ASTAggregateViewOperation,
+    OrderByViewOperation(path: Path): ASTOrderByViewOperation,
+    Field(path: Path): ASTField,
+    ReferenceExpression(path: Path): ASTReferenceExpression,
+    ReferenceViewDefinition(path: Path): ASTReferenceViewDefinition,
+    ArrowQueryDefinition(path: Path): ASTArrowQueryDefinition,
+    ArrowViewDefinition(path: Path): ASTArrowViewDefinition,
+    RefinementViewDefinition(path: Path): ASTRefinementViewDefinition,
+    TimeTruncationExpression(path: Path): ASTTimeTruncationExpression,
+    FilteredFieldExpression(path: Path): ASTFilteredFieldExpression,
+    NestViewOperation(path: Path): ASTNestViewOperation,
+    View(path: Path): ASTView,
+    SegmentViewDefinition(path: Path): ASTSegmentViewDefinition,
+    LimitViewOperation(path: Path): ASTLimitViewOperation,
+    AnnotationList(path: Path): ASTAnnotationList,
+    Annotation(path: Path): ASTAnnotation,
+    ...
+  };
   get parent(): ASTAny;
   set parent(parent: ASTAny): void;
   schemaTryGet(
@@ -95,6 +101,8 @@ declare class ASTNode<T> {
     path: string[] | void,
   ): Malloy.FieldInfo;
   schemaMerge(a: Malloy.Schema, b: Malloy.Schema): Malloy.Schema;
+  tagFor(a: Malloy.FieldInfo, prefix?: string): Tag;
+  fieldWasCalculation(a: Malloy.FieldInfo): boolean;
 }
 declare class ASTListNode<T, N: ASTNode<T> = ASTNode<T>> extends ASTNode<T[]> {
   nodeT[];
@@ -109,7 +117,7 @@ declare class ASTListNode<T, N: ASTNode<T> = ASTNode<T>> extends ASTNode<T[]> {
   add(n: N): void;
   remove(n: N): this | void;
   build(): T[];
-  find(path: Path): ASTAny;
+  findAny(path: Path): ASTAny;
   findIndex(predicate: (n: N) => boolean): number;
   indexOf(n: N): number;
 }
@@ -118,7 +126,7 @@ declare class ASTObjectNode<T, Children: ASTChildren<T>> extends ASTNode<T> {
   childrenChildren;
   constructor(node: T, children: Children): void;
   build(): T;
-  find(path: Path): ASTAny;
+  findAny(path: Path): ASTAny;
 }
 declare export class ASTQuery
   extends
@@ -209,6 +217,7 @@ declare export class ASTReference
 }
 declare export class ASTFieldReference extends ASTReference {
   get segment(): ASTSegmentViewDefinition;
+  getReferenceSchemaany;
   getFieldInfo(): Malloy.FieldInfo;
 }
 declare export class ASTSourceReference extends ASTReference {
@@ -336,7 +345,7 @@ declare export class ASTUnimplemented<T> extends ASTNode<T> {
   constructor(node: T): void;
   get treeEdited(): boolean;
   build(): T;
-  find(): empty;
+  findAny(): empty;
 }
 declare export interface IASTQueryOrViewDefinition {
   propagateUp(f: PropagationFunction): void;
@@ -599,7 +608,10 @@ declare export class ASTSegmentViewDefinition
       | ASTNestViewOperation,
     name: string,
   ): void;
-  addOrderBy(name: string, direction?: Malloy.OrderByDirection): void;
+  addOrderBy(
+    name: string,
+    direction?: Malloy.OrderByDirection,
+  ): ASTOrderByViewOperation;
   addEmptyNest(name: string): ASTNestViewOperation;
   firstIndexOfOperationTypeany;
   DEFAULT_INSERTION_ORDERany;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@malloydata/malloy-query-builder",
-  "version": "0.0.240-dev250305162504",
+  "version": "0.0.240-dev250305163014",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,9 +22,9 @@
     "serve-docs": "npx http-server -o docs"
   },
   "dependencies": {
-    "@malloydata/malloy-filter": "^0.0.240-dev250305162504",
-    "@malloydata/malloy-interfaces": "^0.0.240-dev250305162504",
-    "@malloydata/malloy-tag": "^0.0.240-dev250305162504"
+    "@malloydata/malloy-filter": "^0.0.240-dev250305163014",
+    "@malloydata/malloy-interfaces": "^0.0.240-dev250305163014",
+    "@malloydata/malloy-tag": "^0.0.240-dev250305163014"
   },
   "devDependencies": {
     "flow-api-translator": "^0.26.0",

package/src/query-ast.spec.ts

@@ -8,7 +8,7 @@
 import * as Malloy from '@malloydata/malloy-interfaces';
 import {flights_model} from './flights_model';
 import './expects';
-import {ASTQuery} from './query-ast';
+import {ASTOrderByViewOperation, ASTQuery} from './query-ast';
 
 function dedent(strs: TemplateStringsArray) {
   const str = strs.join('');
@@ -239,55 +239,101 @@ describe('query builder', () => {
       `,
     });
   });
-  test('add an aggregate with a where', () => {
-    const from: Malloy.Query = {
-      definition: {
-        kind: 'arrow',
-        source_reference: {name: 'flights'},
-        view: {
-          kind: 'segment',
-          operations: [],
+  describe('aggregate', () => {
+    test('added aggregate should have calculation annotation', () => {
+      const from: Malloy.Query = {
+        definition: {
+          kind: 'arrow',
+          source_reference: {name: 'flights'},
+          view: {
+            kind: 'segment',
+            operations: [],
+          },
         },
-      },
-    };
-    expect((q: ASTQuery) => {
-      q.getOrAddDefaultSegment()
-        .addAggregate('flight_count')
-        .addWhere('carrier', 'WN, AA');
-    }).toModifyQuery({
-      model: flights_model,
-      from,
-      to: {
+      };
+      expect((q: ASTQuery) => {
+        const aggregate = q
+          .getOrAddDefaultSegment()
+          .addAggregate('flight_count');
+        expect(ASTQuery.fieldWasCalculation(aggregate.getFieldInfo())).toBe(
+          true
+        );
+      }).toModifyQuery({
+        model: flights_model,
+        from,
+        to: {
+          definition: {
+            kind: 'arrow',
+            source_reference: {name: 'flights'},
+            view: {
+              kind: 'segment',
+              operations: [
+                {
+                  kind: 'aggregate',
+                  field: {
+                    expression: {
+                      kind: 'field_reference',
+                      name: 'flight_count',
+                    },
+                  },
+                },
+              ],
+            },
+          },
+        },
+        malloy: 'run: flights -> { aggregate: flight_count }',
+      });
+    });
+    test('add an aggregate with a where', () => {
+      const from: Malloy.Query = {
         definition: {
           kind: 'arrow',
           source_reference: {name: 'flights'},
           view: {
             kind: 'segment',
-            operations: [
-              {
-                kind: 'aggregate',
-                field: {
-                  expression: {
-                    kind: 'filtered_field',
-                    field_reference: {name: 'flight_count'},
-                    where: [
-                      {
-                        filter: {
-                          kind: 'filter_string',
-                          field_reference: {name: 'carrier'},
-                          filter: 'WN, AA',
+            operations: [],
+          },
+        },
+      };
+      expect((q: ASTQuery) => {
+        q.getOrAddDefaultSegment()
+          .addAggregate('flight_count')
+          .addWhere('carrier', 'WN, AA');
+      }).toModifyQuery({
+        model: flights_model,
+        from,
+        to: {
+          definition: {
+            kind: 'arrow',
+            source_reference: {name: 'flights'},
+            view: {
+              kind: 'segment',
+              operations: [
+                {
+                  kind: 'aggregate',
+                  field: {
+                    expression: {
+                      kind: 'filtered_field',
+                      field_reference: {name: 'flight_count'},
+                      where: [
+                        {
+                          filter: {
+                            kind: 'filter_string',
+                            field_reference: {name: 'carrier'},
+                            filter: 'WN, AA',
+                          },
                         },
-                      },
-                    ],
+                      ],
+                    },
                   },
                 },
-              },
-            ],
+              ],
+            },
           },
         },
-      },
-      malloy:
-        'run: flights -> { aggregate: flight_count { where: carrier ~ f`WN, AA` } }',
+        malloy:
+          'run: flights -> { aggregate: flight_count { where: carrier ~ f`WN, AA` } }',
+      });
     });
   });
   test('add a where', () => {
@@ -834,46 +880,168 @@ describe('query builder', () => {
       malloy: 'run: flights -> by_month + { limit: 10 }',
     });
   });
-  test('add an order by in a refinement', () => {
-    const from: Malloy.Query = {
-      definition: {
-        kind: 'arrow',
-        source_reference: {name: 'flights'},
-        view: {
-          kind: 'view_reference',
-          name: 'by_month',
-        },
-      },
-    };
-    expect((q: ASTQuery) => {
-      q.getOrAddDefaultSegment().addOrderBy('dep_month', 'asc');
-    }).toModifyQuery({
-      model: flights_model,
-      from,
-      to: {
+  describe('add order by', () => {
+    test('add an order by to a complex refinement', () => {
+      const from: Malloy.Query = {
         definition: {
           kind: 'arrow',
-          source_reference: {name: 'flights'},
+          source_reference: {
+            name: 'flights',
+          },
           view: {
             kind: 'refinement',
             base: {
               kind: 'view_reference',
-              name: 'by_month',
+              name: 'top_carriers',
             },
             refinement: {
               kind: 'segment',
               operations: [
                 {
-                  kind: 'order_by',
-                  field_reference: {name: 'dep_month'},
-                  direction: 'asc',
+                  kind: 'group_by',
+                  field: {
+                    expression: {
+                      kind: 'field_reference',
+                      name: 'carrier',
+                      path: [],
+                    },
+                  },
+                },
+                {
+                  kind: 'nest',
+                  name: 'by_month',
+                  view: {
+                    definition: {
+                      kind: 'refinement',
+                      base: {
+                        kind: 'view_reference',
+                        name: 'by_month',
+                      },
+                      refinement: {
+                        kind: 'segment',
+                        operations: [],
+                      },
+                    },
+                  },
                 },
               ],
             },
           },
         },
-      },
-      malloy: 'run: flights -> by_month + { order_by: dep_month asc }',
+      };
+      expect((q: ASTQuery) => {
+        q.getOrAddDefaultSegment().addOrderBy('carrier');
+      }).toModifyQuery({
+        model: flights_model,
+        from,
+        to: {
+          definition: {
+            kind: 'arrow',
+            source_reference: {
+              name: 'flights',
+            },
+            view: {
+              kind: 'refinement',
+              base: {
+                kind: 'view_reference',
+                name: 'top_carriers',
+              },
+              refinement: {
+                kind: 'segment',
+                operations: [
+                  {
+                    kind: 'group_by',
+                    field: {
+                      expression: {
+                        kind: 'field_reference',
+                        name: 'carrier',
+                        path: [],
+                      },
+                    },
+                  },
+                  {
+                    kind: 'nest',
+                    name: 'by_month',
+                    view: {
+                      definition: {
+                        kind: 'refinement',
+                        base: {
+                          kind: 'view_reference',
+                          name: 'by_month',
+                        },
+                        refinement: {
+                          kind: 'segment',
+                          operations: [],
+                        },
+                      },
+                    },
+                  },
+                  {
+                    kind: 'order_by',
+                    field_reference: {
+                      name: 'carrier',
+                    },
+                  },
+                ],
+              },
+            },
+          },
+        },
+        malloy: dedent`
+          run: flights -> top_carriers + {
+            group_by: carrier
+            nest: by_month is by_month + { }
+            order_by: carrier
+          }
+        `,
+      });
+    });
+    test('add an order by in a refinement', () => {
+      let orderBy: ASTOrderByViewOperation | undefined;
+      const from: Malloy.Query = {
+        definition: {
+          kind: 'arrow',
+          source_reference: {name: 'flights'},
+          view: {
+            kind: 'view_reference',
+            name: 'by_month',
+          },
+        },
+      };
+      expect((q: ASTQuery) => {
+        orderBy = q.getOrAddDefaultSegment().addOrderBy('dep_month', 'asc');
+      }).toModifyQuery({
+        model: flights_model,
+        from,
+        to: {
+          definition: {
+            kind: 'arrow',
+            source_reference: {name: 'flights'},
+            view: {
+              kind: 'refinement',
+              base: {
+                kind: 'view_reference',
+                name: 'by_month',
+              },
+              refinement: {
+                kind: 'segment',
+                operations: [
+                  {
+                    kind: 'order_by',
+                    field_reference: {name: 'dep_month'},
+                    direction: 'asc',
+                  },
+                ],
+              },
+            },
+          },
+        },
+        malloy: 'run: flights -> by_month + { order_by: dep_month asc }',
+      });
+      expect(orderBy?.fieldReference.getFieldInfo()).toMatchObject({
+        'kind': 'dimension',
+        'name': 'dep_month',
+      });
     });
   });
   test('do nothing', () => {
@@ -914,8 +1082,8 @@ describe('query builder', () => {
       },
     };
     expect((q: ASTQuery) => {
-      q.definition
-        .asArrowQueryDefinition()
+      q.definition.as
+        .ArrowQueryDefinition()
         .view.addViewRefinement('cool_state_measures');
     }).toModifyQuery({
       source: {
@@ -1302,10 +1470,10 @@ describe('query builder', () => {
       },
     };
     expect((q: ASTQuery) => {
-      const segment = q.definition
-        .asArrowQueryDefinition()
-        .view.asRefinementViewDefinition()
-        .base.asSegmentViewDefinition();
+      const segment = q.definition.as
+        .ArrowQueryDefinition()
+        .view.as.RefinementViewDefinition()
+        .base.as.SegmentViewDefinition();
       segment.getGroupBy('carrier')!.rename('carrier_2');
     }).toModifyQuery({
       model: flights_model,
@@ -1381,10 +1549,10 @@ describe('query builder', () => {
       },
     };
     expect((q: ASTQuery) => {
-      const segment = q.definition
-        .asArrowQueryDefinition()
-        .view.asRefinementViewDefinition()
-        .base.asSegmentViewDefinition();
+      const segment = q.definition.as
+        .ArrowQueryDefinition()
+        .view.as.RefinementViewDefinition()
+        .base.as.SegmentViewDefinition();
       segment.getGroupBy('carrier')!.delete();
     }).toModifyQuery({
       model: flights_model,
@@ -1448,10 +1616,10 @@ describe('query builder', () => {
       },
     };
     expect((q: ASTQuery) => {
-      const segment = q.definition
-        .asArrowQueryDefinition()
-        .view.asArrowViewDefinition()
-        .source.asSegmentViewDefinition();
+      const segment = q.definition.as
+        .ArrowQueryDefinition()
+        .view.as.ArrowViewDefinition()
+        .source.as.SegmentViewDefinition();
       segment.getGroupBy('carrier')!.delete();
     }).toModifyQuery({
       model: flights_model,
@@ -1669,7 +1837,7 @@ describe('query builder', () => {
         },
       };
       expect((q: ASTQuery) => {
-        const source = q.definition.asArrowQueryDefinition().sourceReference;
+        const source = q.definition.as.ArrowQueryDefinition().sourceReference;
         source.setParameter('string_param', 'COOL');
         source.setParameter('number_param', 7);
         source.setParameter('boolean_param', true);