@malloydata/malloy 0.0.237-dev250225015031 → 0.0.237-dev250225213433

package/dist/lang/syntax-errors/malloy-parser-error-listener.js

@@ -6,11 +6,19 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MalloyParserErrorListener = exports.commonErrorCases = void 0;
+exports.MalloyParserErrorListener = exports.malloyCustomErrorCases = void 0;
 const MalloyParser_1 = require("../lib/Malloy/MalloyParser");
 const custom_error_messages_1 = require("./custom-error-messages");
 const parse_log_1 = require("../parse-log");
-exports.commonErrorCases = [
+// A set of custom error messages and their triggering cases,
+// used for syntax error message re-writing when ANTLR would
+// otherwise print a standard (and not very useful) error message.
+//
+// Most Malloy errors are detected and generated in language elements
+// inside `src/lang/ast`. These custom error messages are used to
+// cover a variety of cases that are not as straightforward to
+// catch in the AST.
+exports.malloyCustomErrorCases = [
     {
         errorMessage: "'view:' must be followed by '<identifier> is {'",
         ruleContextOptions: ['exploreQueryDef'],
@@ -18,7 +26,7 @@ exports.commonErrorCases = [
         precedingTokenOptions: [[MalloyParser_1.MalloyParser.VIEW], [MalloyParser_1.MalloyParser.COLON]],
     },
     {
-        errorMessage: "Missing '}' at '${currentToken}'",
+        errorMessage: "Missing '}' at '${offendingSymbol}'",
         ruleContextOptions: ['vExpr'],
         offendingSymbol: MalloyParser_1.MalloyParser.VIEW,
         currentToken: MalloyParser_1.MalloyParser.OCURLY,
@@ -30,17 +38,106 @@ exports.commonErrorCases = [
             'queryProperties',
             'exploreStatement',
         ],
-        lookAheadOptions: [
-            [MalloyParser_1.MalloyParser.EOF],
-            [MalloyParser_1.MalloyParser.RUN],
-            [MalloyParser_1.MalloyParser.SOURCE],
-        ],
+        offendingSymbolTextOptions: ['<eof>', 'run:', 'source:'],
     },
     {
         errorMessage: "'aggregate:' entries must include a name (ex: `some_name is count()`)",
         precedingTokenOptions: [[MalloyParser_1.MalloyParser.AGGREGATE]],
         lookAheadOptions: [[-MalloyParser_1.MalloyParser.IS]],
-        lookbackFromOffendingSymbol: true,
+    },
+    {
+        errorMessage: "Expected ':' following 'source'",
+        offendingSymbol: MalloyParser_1.MalloyParser.SOURCE_KW,
+        ruleContextOptions: ['malloyDocument'],
+    },
+    {
+        errorMessage: "Expected ':' following '${offendingSymbol}'",
+        offendingSymbolTextOptions: [
+            'dimension',
+            'measure',
+            'where',
+            'declare',
+            'join_one',
+            'join_many',
+            'join_cross',
+            'primary_key',
+        ],
+        ruleContextOptions: ['exploreStatement'],
+    },
+    {
+        errorMessage: "Expected 'is' or '(' following identifier '${previousToken}'",
+        ruleContextOptions: ['sourceDefinition'],
+        lookbackSiblingRuleOptions: [
+            MalloyParser_1.MalloyParser.RULE_sourceNameDef,
+            MalloyParser_1.MalloyParser.RULE_sourceParameters,
+        ],
+    },
+    {
+        errorMessage: "Unexpected '{' following source expression. Expected: 'extend', 'include', '+' or '->'",
+        offendingSymbol: MalloyParser_1.MalloyParser.OCURLY,
+        ruleContextOptions: ['malloyDocument'],
+        predecessorHasAncestorRule: MalloyParser_1.MalloyParser.RULE_sqExplore,
+    },
+    {
+        errorMessage: "Unexpected 'join:'. Did you mean 'join_one:', 'join_many:' or 'join_cross:'?",
+        ruleContextOptions: ['exploreStatement'],
+        offendingSymbolTextOptions: ['join'],
+        lookAheadOptions: [[MalloyParser_1.MalloyParser.COLON]],
+    },
+    {
+        errorMessage: "Unexpected '${offendingSymbol}'. Did you mean 'primary_key:'?",
+        ruleContextOptions: ['exploreStatement'],
+        offendingSymbolTextOptions: ['primarykey', 'primary'],
+        lookAheadOptions: [
+            [MalloyParser_1.MalloyParser.COLON],
+            ['key', MalloyParser_1.MalloyParser.COLON],
+            ['key', MalloyParser_1.MalloyParser.IDENTIFIER],
+        ],
+    },
+    {
+        errorMessage: "Unexpected '${offendingSymbol}'. Did you mean 'group_by:'?",
+        ruleContextOptions: ['queryStatement'],
+        offendingSymbolTextOptions: ['groupby', 'group'],
+        lookAheadOptions: [
+            [MalloyParser_1.MalloyParser.COLON],
+            ['by', MalloyParser_1.MalloyParser.COLON],
+            ['by', MalloyParser_1.MalloyParser.IDENTIFIER],
+        ],
+    },
+    {
+        errorMessage: "Unexpected '${offendingSymbol}'. Did you mean 'order_by:'?",
+        ruleContextOptions: ['queryStatement'],
+        offendingSymbolTextOptions: ['orderby', 'order'],
+        lookAheadOptions: [
+            [MalloyParser_1.MalloyParser.COLON],
+            ['by', MalloyParser_1.MalloyParser.COLON],
+            ['by', MalloyParser_1.MalloyParser.IDENTIFIER],
+        ],
+    },
+    {
+        errorMessage: "Expected ':' following '${offendingSymbol}'",
+        offendingSymbolTextOptions: [
+            'group_by',
+            'declare',
+            'join_one',
+            'join_many',
+            'join_cross',
+            'extend',
+            'select',
+            'project',
+            'index',
+            'aggregate',
+            'calculate',
+            'top',
+            'limit',
+            'order_by',
+            'where',
+            'having',
+            'nest',
+            'sample',
+            'timezone',
+        ],
+        ruleContextOptions: ['queryStatement'],
     },
 ];
 class MalloyParserErrorListener {
@@ -57,7 +154,7 @@ class MalloyParserErrorListener {
         const range = offendingSymbol
             ? this.translator.rangeFromToken(offendingSymbol)
             : { start: errAt, end: errAt };
-        const overrideMessage = (0, custom_error_messages_1.checkCustomErrorMessage)(recognizer, offendingSymbol, exports.commonErrorCases);
+        const overrideMessage = (0, custom_error_messages_1.checkCustomErrorMessage)(recognizer, offendingSymbol, exports.malloyCustomErrorCases);
         if (overrideMessage) {
             message = overrideMessage;
         }

package/dist/lang/test/literals.spec.js

@@ -23,7 +23,6 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const test_translator_1 = require("./test-translator");
-const parse_utils_1 = require("../parse-utils");
 require("./parse-expects");
 const granular_result_1 = require("../ast/types/granular-result");
 describe('literals', () => {
@@ -154,39 +153,6 @@ describe('literals', () => {
     test('regex', () => {
         expect((0, test_translator_1.expr) `r'RegularExpression'`).toTranslate();
     });
-    describe('quote comprehension inside strings', () => {
-        test('\\b', () => {
-            expect((0, parse_utils_1.parseString)('\\b')).toEqual('\b');
-        });
-        test('\\f', () => {
-            expect((0, parse_utils_1.parseString)('\\f')).toEqual('\f');
-        });
-        test('\\n', () => {
-            expect((0, parse_utils_1.parseString)('\\n')).toEqual('\n');
-        });
-        test('\\r', () => {
-            expect((0, parse_utils_1.parseString)('\\r')).toEqual('\r');
-        });
-        test('\\t', () => {
-            expect((0, parse_utils_1.parseString)('\\t')).toEqual('\t');
-        });
-        test('unicode ?', () => {
-            expect((0, parse_utils_1.parseString)('\\u003f')).toEqual('?');
-            expect((0, parse_utils_1.parseString)('\\u003F')).toEqual('?');
-        });
-        test('normal stuff', () => {
-            expect((0, parse_utils_1.parseString)('normal stuff')).toEqual('normal stuff');
-        });
-        test('stuff & nonsense', () => {
-            expect((0, parse_utils_1.parseString)('stuff \\u0026 nonsense')).toEqual('stuff & nonsense');
-        });
-        test('one thing\\nnext thing', () => {
-            expect((0, parse_utils_1.parseString)('one thing\\nnext thing')).toEqual('one thing\nnext thing');
-        });
-        test('quote stripping works', () => {
-            expect((0, parse_utils_1.parseString)('|42|', '|')).toEqual('42');
-        });
-    });
     describe('string parsing in language', () => {
         const tz = 'America/Mexico_City';
         test('multi-line indent increasing', () => {

package/dist/lang/test/syntax-errors.spec.js

@@ -8,62 +8,91 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const test_translator_1 = require("./test-translator");
 require("./parse-expects");
-describe('errors', () => {
-    test('source missing closing curly: EOF', () => {
-        expect('source: x is a extend {').toLogAtLeast((0, test_translator_1.errorMessage)("Missing '}' at '<EOF>'"));
+/**
+ * Unit tests intended to cover the custom error messages defined in
+ * malloy-custom-error-messages.ts.
+ *
+ * These tests are intended to prevent unintended regressions. It is
+ * okay to change or remove tests here as long as you are doing so
+ * for a good reason.
+ */
+describe('custom error messages', () => {
+    describe('source', () => {
+        test('missing alias', () => {
+            expect('source: x extend { }').toLogAtLeast((0, test_translator_1.errorMessage)("Expected 'is' or '(' following identifier 'x'"));
+        });
+        test('missing closing curly: EOF', () => {
+            expect('source: x is a extend {').toLogAtLeast((0, test_translator_1.errorMessage)("Missing '}' at '<EOF>'"));
+        });
+        test('source: missing colon in root context', () => {
+            expect('source x is a extend { }').toLogAtLeast((0, test_translator_1.errorMessage)("Expected ':' following 'source'"));
+        });
+        test('opening curly to EOF', () => {
+            expect(`
+          source: y is x extend {
+        `).toLogAtLeast((0, test_translator_1.errorMessage)("Missing '}' at '<EOF>'"));
+        });
+        test('expression missing operand before curly', () => {
+            expect("source: a is presto.table('malloytest.state_facts') {}").toLogAtLeast((0, test_translator_1.errorMessage)("Unexpected '{' following source expression. Expected: 'extend', 'include', '+' or '->'"));
+        });
+        test('missing opening curly after source extend keyword', () => {
+            expect(`
+        source: x is a extend
+          primary_key: id
+      `).toLogAtLeast((0, test_translator_1.errorMessage)("missing '{' at 'primary_key:'"));
+        });
     });
-    test('view is missing name', () => {
-        expect(`
-      source: x is a extend {
-        view: {
-          group_by: b
+    describe('exploreProperties', () => {
+        test('misspelled "join"', () => {
+            expect(`source: x is a extend {
+        join: data is y on dataId = data.id
+      }`).toLogAtLeast((0, test_translator_1.errorMessage)("Unexpected 'join:'. Did you mean 'join_one:', 'join_many:' or 'join_cross:'?"));
+            expect(`source: x is a extend {
+        primary_key: name
+        join: data is y on dataId = data.id
+      }`).toLogAtLeast((0, test_translator_1.errorMessage)("Unexpected 'join:'. Did you mean 'join_one:', 'join_many:' or 'join_cross:'?"));
+        });
+        test('misspelled "primary_key:"', () => {
+            expect('source: x is a extend { primaryKey: name }').toLogAtLeast((0, test_translator_1.errorMessage)("Unexpected 'primaryKey'. Did you mean 'primary_key:'?"));
+            expect('source: x is a extend { primary key: name }').toLogAtLeast((0, test_translator_1.errorMessage)("Unexpected 'primary'. Did you mean 'primary_key:'?"));
+        });
+        test('explore statement keyword missing colon', () => {
+            expect('source: x is a extend { where x > 5 }').toLogAtLeast((0, test_translator_1.errorMessage)("Expected ':' following 'where'"));
+            expect('source: x is a extend { primary_key name }').toLogAtLeast((0, test_translator_1.errorMessage)("Expected ':' following 'primary_key'"));
+            expect('source: x is a extend { declare total is value.sum() }').toLogAtLeast((0, test_translator_1.errorMessage)("Expected ':' following 'declare'"));
+        });
+        test('incorrect opening curly after dimension', () => {
+            expect(`
+        source: x is a extend {
+          dimension: {
+            test is best
+          }
         }
-      }
-      `).toLogAtLeast((0, test_translator_1.errorMessage)("'view:' must be followed by '<identifier> is {'"));
+        `).toLogAtLeast((0, test_translator_1.errorMessage)("extraneous input '{' expecting {BQ_STRING, IDENTIFIER}"));
+        });
     });
-    test('missing closing curly, source>view', () => {
-        expect(`
-      source: x is a extend {
-        view: y is {
-          group_by: b
+    describe('view', () => {
+        test('view is missing name', () => {
+            expect(`
+        source: x is a extend { view: {
+            group_by: b
+        } }
+        `).toLogAtLeast((0, test_translator_1.errorMessage)("'view:' must be followed by '<identifier> is {'"));
+        });
+        test('missing closing curly, source>view', () => {
+            expect(`
+        source: x is a extend {
+          view: y is {
+            group_by: b
 
-        view: z is {
-          group_by: c
-        }
-      }
-      `).toLogAtLeast((0, test_translator_1.errorMessage)("Missing '}' at 'view:'"));
-    });
-    test('incorrect opening curly after dimension', () => {
-        expect(`
-      source: x is a extend {
-        dimension: {
-          test is best
+          view: z is {
+            group_by: c
+          }
         }
-      }
-      `).toLogAtLeast((0, test_translator_1.errorMessage)("extraneous input '{' expecting {BQ_STRING, IDENTIFIER}"));
-    });
-    test('misspelled primarykey', () => {
-        expect(`
-      source: x is a extend {
-        primarykey: id
-      }
-    `).toLogAtLeast((0, test_translator_1.errorMessage)("no viable alternative at input 'primarykey'"));
-    });
-    test('missing opening curly after source extend keyword', () => {
-        expect(`
-      source: x is a extend
-        primary_key: id
-    `).toLogAtLeast((0, test_translator_1.errorMessage)("Missing '{' after 'extend'"));
-    });
-    test('missing alias for aggregate entry', () => {
-        expect(`
-        run: x -> {
-          aggregate: count()
-        }
-      `).toLogAtLeast((0, test_translator_1.errorMessage)("'aggregate:' entries must include a name (ex: `some_name is count()`)"));
-    });
-    test('missing alias for aggregate inside source>view', () => {
-        expect(`
+        `).toLogAtLeast((0, test_translator_1.errorMessage)("Missing '}' at 'view:'"));
+        });
+        test('missing alias for aggregate inside source>view', () => {
+            expect(`
       source: x is aa extend {
         measure: airport_count is count()
 
@@ -73,16 +102,41 @@ describe('errors', () => {
         }
       }
       `).toLogAtLeast((0, test_translator_1.errorMessage)("'aggregate:' entries must include a name (ex: `some_name is count()`)"));
+        });
     });
-    test('run opening curly to EOF', () => {
-        expect(`
-        run: x -> {
-      `).toLogAtLeast((0, test_translator_1.errorMessage)("Missing '}' at '<EOF>'"));
+    describe('queryStatement', () => {
+        test('misspelled group_by:', () => {
+            expect('source: x is a -> { groupBy: name }').toLogAtLeast((0, test_translator_1.errorMessage)("Unexpected 'groupBy'. Did you mean 'group_by:'?"));
+            expect('source: x is a -> { group by: name }').toLogAtLeast((0, test_translator_1.errorMessage)("Unexpected 'group'. Did you mean 'group_by:'?"));
+            expect('source: x is a -> { group by name }').toLogAtLeast((0, test_translator_1.errorMessage)("Unexpected 'group'. Did you mean 'group_by:'?"));
+        });
+        test('misspelled order_by:', () => {
+            expect('source: x is a -> { orderBy: name }').toLogAtLeast((0, test_translator_1.errorMessage)("Unexpected 'orderBy'. Did you mean 'order_by:'?"));
+            expect('source: x is a -> { order by: name }').toLogAtLeast((0, test_translator_1.errorMessage)("Unexpected 'order'. Did you mean 'order_by:'?"));
+            expect('source: x is a -> { order by name }').toLogAtLeast((0, test_translator_1.errorMessage)("Unexpected 'order'. Did you mean 'order_by:'?"));
+        });
+        test('query statement keyword missing colon', () => {
+            expect('source: x is a -> { group_by x > 5 }').toLogAtLeast((0, test_translator_1.errorMessage)("Expected ':' following 'group_by'"));
+            expect('source: x is a -> { declare name is id }').toLogAtLeast((0, test_translator_1.errorMessage)("Expected ':' following 'declare'"));
+            expect('source: x is a -> { select * }').toLogAtLeast((0, test_translator_1.errorMessage)("Expected ':' following 'select'"));
+            expect('source: x is a -> { project i, j, k}').toLogAtLeast((0, test_translator_1.errorMessage)("Expected ':' following 'project'"));
+            expect('source: x is a -> { where val > 5}').toLogAtLeast((0, test_translator_1.errorMessage)("Expected ':' following 'where'"));
+            expect('source: x is a -> { order_by name desc, 2 asc}').toLogAtLeast((0, test_translator_1.errorMessage)("Expected ':' following 'order_by'"));
+        });
     });
-    test('source opening curly to EOF', () => {
-        expect(`
-        source: y is x extend {
-      `).toLogAtLeast((0, test_translator_1.errorMessage)("Missing '}' at '<EOF>'"));
+    describe('run', () => {
+        test('missing alias for aggregate entry', () => {
+            expect(`
+          run: x -> {
+            aggregate: count()
+          }
+        `).toLogAtLeast((0, test_translator_1.errorMessage)("'aggregate:' entries must include a name (ex: `some_name is count()`)"));
+        });
+        test('run opening curly to EOF', () => {
+            expect(`
+          run: x -> {
+        `).toLogAtLeast((0, test_translator_1.errorMessage)("Missing '}' at '<EOF>'"));
+        });
     });
 });
 //# sourceMappingURL=syntax-errors.spec.js.map

package/dist/malloy.d.ts

@@ -6,9 +6,14 @@ import { DocumentHelpContext } from './lang/parse-tree-walkers/document-help-con
 import { CompiledQuery, DocumentLocation, DocumentReference, BooleanFieldDef, JSONFieldDef, NumberFieldDef, StringFieldDef, FilterCondition, Query as InternalQuery, ModelDef, DocumentPosition as ModelDocumentPosition, NamedQuery, QueryData, QueryDataRow, QueryResult, SearchIndexResult, SearchValueMapResult, StructDef, TurtleDef, NativeUnsupportedFieldDef, QueryRunStats, ImportLocation, Annotation, SQLSentence, SQLSourceDef, AtomicFieldDef, DateFieldDef, TimestampFieldDef, SourceDef, QueryToMaterialize } from './model';
 import { EventStream, InvalidationKey, ModelString, ModelURL, QueryString, QueryURL, URLReader } from './runtime_types';
 import { Connection, FetchSchemaOptions, InfoConnection, LookupConnection } from './connection/types';
-import { Tag, TagParse, TagParseSpec, Taggable } from './tags';
+import { Tag } from '@malloydata/malloy-tag';
 import { Dialect } from './dialect';
 import { PathInfo } from './lang/parse-tree-walkers/find-table-path-walker';
+import { MalloyTagParse, TagParseSpec } from './annotation';
+export interface Taggable {
+    tagParse: (spec?: TagParseSpec) => MalloyTagParse;
+    getTaglines: (prefix?: RegExp) => string[];
+}
 export interface Loggable {
     debug: (message?: any, ...optionalParams: any[]) => void;
     info: (message?: any, ...optionalParams: any[]) => void;
@@ -185,7 +190,7 @@ export declare class Model implements Taggable {
     _referenceAt: (location: ModelDocumentPosition) => DocumentReference | undefined;
     _importAt: (location: ModelDocumentPosition) => ImportLocation | undefined;
     constructor(modelDef: ModelDef, problems: LogMessage[], fromSources: string[], referenceAt?: (location: ModelDocumentPosition) => DocumentReference | undefined, importAt?: (location: ModelDocumentPosition) => ImportLocation | undefined);
-    tagParse(spec?: TagParseSpec): TagParse;
+    tagParse(spec?: TagParseSpec): MalloyTagParse;
     getTaglines(prefix?: RegExp): string[];
     /**
      * Retrieve a document reference for the token at the given position within
@@ -260,7 +265,7 @@ export declare class PreparedQuery implements Taggable {
     _modelDef: ModelDef;
     _query: InternalQuery | NamedQuery;
     constructor(query: InternalQuery, model: ModelDef, problems: LogMessage[], name?: string | undefined);
-    tagParse(spec?: TagParseSpec): TagParse;
+    tagParse(spec?: TagParseSpec): MalloyTagParse;
     getTaglines(prefix?: RegExp): string[];
     /**
      * Generate the SQL for this query.
@@ -457,7 +462,7 @@ export declare class PreparedResult implements Taggable {
     protected inner: CompiledQuery;
     constructor(query: CompiledQuery, modelDef: ModelDef);
     static fromJson({ query, modelDef, }: PreparedResultJSON): PreparedResult;
-    tagParse(spec?: TagParseSpec): TagParse;
+    tagParse(spec?: TagParseSpec): MalloyTagParse;
     getTaglines(prefix?: RegExp): string[];
     get annotation(): Annotation | undefined;
     get modelAnnotation(): Annotation | undefined;
@@ -587,7 +592,7 @@ export declare class Explore extends Entity implements Taggable {
     get source(): Explore | undefined;
     isIntrinsic(): boolean;
     isExploreField(): this is ExploreField;
-    tagParse(spec?: TagParseSpec): TagParse;
+    tagParse(spec?: TagParseSpec): MalloyTagParse;
     getTaglines(prefix?: RegExp): string[];
     private parsedModelTag?;
     get modelTag(): Tag;
@@ -632,7 +637,7 @@ export declare class AtomicField extends Entity implements Taggable {
     protected parent: Explore;
     constructor(fieldTypeDef: AtomicFieldDef, parent: Explore, source?: AtomicField);
     get type(): AtomicFieldType;
-    tagParse(spec?: TagParseSpec): TagParse;
+    tagParse(spec?: TagParseSpec): MalloyTagParse;
     getTaglines(prefix?: RegExp): string[];
     isIntrinsic(): boolean;
     isQueryField(): this is QueryField;
@@ -723,7 +728,7 @@ export declare class Query extends Entity {
 export declare class QueryField extends Query implements Taggable {
     protected parent: Explore;
     constructor(turtleDef: TurtleDef, parent: Explore, source?: Query);
-    tagParse(spec?: TagParseSpec): TagParse;
+    tagParse(spec?: TagParseSpec): MalloyTagParse;
     getTaglines(prefix?: RegExp): string[];
     isQueryField(): this is QueryField;
     isExploreField(): this is ExploreField;
@@ -744,7 +749,7 @@ export declare class ExploreField extends Explore {
     get joinRelationship(): JoinRelationship;
     get isRecord(): boolean;
     get isArray(): boolean;
-    tagParse(spec?: TagParseSpec): TagParse;
+    tagParse(spec?: TagParseSpec): MalloyTagParse;
     isQueryField(): this is QueryField;
     isExploreField(): this is ExploreField;
     isAtomicField(): this is AtomicField;

package/dist/malloy.js

@@ -26,10 +26,10 @@ exports.InMemoryModelCache = exports.CacheManager = exports.CSVWriter = exports.
 const lang_1 = require("./lang");
 const model_1 = require("./model");
 const luxon_1 = require("luxon");
-const tags_1 = require("./tags");
 const dialect_1 = require("./dialect");
 const version_1 = require("./version");
 const uuid_1 = require("uuid");
+const annotation_1 = require("./annotation");
 const MALLOY_INTERNAL_URL = 'internal://internal.malloy';
 class Malloy {
     static get version() {
@@ -446,10 +446,10 @@ class Model {
         this._importAt = importAt;
     }
     tagParse(spec) {
-        return tags_1.Tag.annotationToTag(this.modelDef.annotation, spec);
+        return (0, annotation_1.annotationToTag)(this.modelDef.annotation, spec);
     }
     getTaglines(prefix) {
-        return tags_1.Tag.annotationToTaglines(this.modelDef.annotation, prefix);
+        return (0, annotation_1.annotationToTaglines)(this.modelDef.annotation, prefix);
     }
     /**
      * Retrieve a document reference for the token at the given position within
@@ -569,12 +569,12 @@ class PreparedQuery {
         this._modelDef = model;
     }
     tagParse(spec) {
-        const modelScope = tags_1.Tag.annotationToTag(this._modelDef.annotation).tag;
-        spec = tags_1.Tag.addModelScope(spec, modelScope);
-        return tags_1.Tag.annotationToTag(this._query.annotation, spec);
+        const modelScope = (0, annotation_1.annotationToTag)(this._modelDef.annotation).tag;
+        spec = (0, annotation_1.addModelScope)(spec, modelScope);
+        return (0, annotation_1.annotationToTag)(this._query.annotation, spec);
     }
     getTaglines(prefix) {
-        return tags_1.Tag.annotationToTaglines(this._query.annotation, prefix);
+        return (0, annotation_1.annotationToTaglines)(this._query.annotation, prefix);
     }
     /**
      * Generate the SQL for this query.
@@ -831,12 +831,12 @@ class PreparedResult {
         return new PreparedResult(query, modelDef);
     }
     tagParse(spec) {
-        const modelScope = tags_1.Tag.annotationToTag(this.modelDef.annotation).tag;
-        spec = tags_1.Tag.addModelScope(spec, modelScope);
-        return tags_1.Tag.annotationToTag(this.inner.annotation, spec);
+        const modelScope = (0, annotation_1.annotationToTag)(this.modelDef.annotation).tag;
+        spec = (0, annotation_1.addModelScope)(spec, modelScope);
+        return (0, annotation_1.annotationToTag)(this.inner.annotation, spec);
     }
     getTaglines(prefix) {
-        return tags_1.Tag.annotationToTaglines(this.inner.annotation, prefix);
+        return (0, annotation_1.annotationToTaglines)(this.inner.annotation, prefix);
     }
     get annotation() {
         return this.inner.annotation;
@@ -845,7 +845,7 @@ class PreparedResult {
         return this.modelDef.annotation;
     }
     get modelTag() {
-        return tags_1.Tag.annotationToTag(this.modelDef.annotation).tag;
+        return (0, annotation_1.annotationToTag)(this.modelDef.annotation).tag;
     }
     /**
      * @return The name of the connection this query should be run against.
@@ -1096,13 +1096,13 @@ class Explore extends Entity {
         return false;
     }
     tagParse(spec) {
-        return tags_1.Tag.annotationToTag(this._structDef.annotation, spec);
+        return (0, annotation_1.annotationToTag)(this._structDef.annotation, spec);
     }
     getTaglines(prefix) {
-        return tags_1.Tag.annotationToTaglines(this._structDef.annotation, prefix);
+        return (0, annotation_1.annotationToTaglines)(this._structDef.annotation, prefix);
     }
     get modelTag() {
-        this.parsedModelTag || (this.parsedModelTag = tags_1.Tag.annotationToTag(this._structDef.modelAnnotation).tag);
+        this.parsedModelTag || (this.parsedModelTag = (0, annotation_1.annotationToTag)(this._structDef.modelAnnotation).tag);
         return this.parsedModelTag;
     }
     /**
@@ -1343,11 +1343,11 @@ class AtomicField extends Entity {
         }
     }
     tagParse(spec) {
-        spec = tags_1.Tag.addModelScope(spec, this.parent.modelTag);
-        return tags_1.Tag.annotationToTag(this.fieldTypeDef.annotation, spec);
+        spec = (0, annotation_1.addModelScope)(spec, this.parent.modelTag);
+        return (0, annotation_1.annotationToTag)(this.fieldTypeDef.annotation, spec);
     }
     getTaglines(prefix) {
-        return tags_1.Tag.annotationToTaglines(this.fieldTypeDef.annotation, prefix);
+        return (0, annotation_1.annotationToTaglines)(this.fieldTypeDef.annotation, prefix);
     }
     isIntrinsic() {
         return (0, model_1.fieldIsIntrinsic)(this.fieldTypeDef);
@@ -1573,11 +1573,11 @@ class QueryField extends Query {
         this.parent = parent;
     }
     tagParse(spec) {
-        spec = tags_1.Tag.addModelScope(spec, this.parent.modelTag);
-        return tags_1.Tag.annotationToTag(this.turtleDef.annotation, spec);
+        spec = (0, annotation_1.addModelScope)(spec, this.parent.modelTag);
+        return (0, annotation_1.annotationToTag)(this.turtleDef.annotation, spec);
     }
     getTaglines(prefix) {
-        return tags_1.Tag.annotationToTaglines(this.turtleDef.annotation, prefix);
+        return (0, annotation_1.annotationToTaglines)(this.turtleDef.annotation, prefix);
     }
     isQueryField() {
         return true;
@@ -1633,8 +1633,8 @@ class ExploreField extends Explore {
         return this.joinRelationship !== JoinRelationship.OneToOne;
     }
     tagParse(spec) {
-        spec = tags_1.Tag.addModelScope(spec, this._parentExplore.modelTag);
-        return tags_1.Tag.annotationToTag(this._structDef.annotation, spec);
+        spec = (0, annotation_1.addModelScope)(spec, this._parentExplore.modelTag);
+        return (0, annotation_1.annotationToTag)(this._structDef.annotation, spec);
     }
     isQueryField() {
         return false;

package/dist/model/malloy_query.d.ts

@@ -4,7 +4,7 @@ import { Connection } from '../connection/types';
 import { AndChain } from './utils';
 import { QueryInfo } from '../dialect/dialect';
 import { EventStream } from '../runtime_types';
-import { Tag } from '../tags';
+import { Tag } from '@malloydata/malloy-tag';
 interface TurtleDefPlus extends TurtleDef, Filtered {
 }
 /** Parent from QueryStruct. */
@@ -225,6 +225,8 @@ declare class JoinInstance {
 export declare class Segment {
     static nextStructDef(structDef: SourceDef, segment: PipeSegment): QueryResultDef;
 }
+export declare function getResultStructDefForView(source: SourceDef, view: TurtleDef): SourceDef;
+export declare function getResultStructDefForQuery(model: ModelDef, query: Query): SourceDef;
 type StageGroupMaping = {
     fromGroup: number;
     toGroup: number;

package/dist/model/malloy_query.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QueryModel = exports.Segment = void 0;
+exports.QueryModel = exports.getResultStructDefForQuery = exports.getResultStructDefForView = exports.Segment = void 0;
 /*
  * Copyright 2023 Google LLC
  *
@@ -29,7 +29,7 @@ const standardsql_1 = require("../dialect/standardsql/standardsql");
 const malloy_types_1 = require("./malloy_types");
 const utils_1 = require("./utils");
 const utils_2 = require("./materialization/utils");
-const tags_1 = require("../tags");
+const annotation_1 = require("../annotation");
 function pathToCol(path) {
     return path.map(el => encodeURIComponent(el)).join('/');
 }
@@ -1564,6 +1564,21 @@ class Segment {
     }
 }
 exports.Segment = Segment;
+function getResultStructDefForView(source, view) {
+    const qs = new QueryStruct(source, undefined, {
+        model: new QueryModel(undefined),
+    }, {});
+    const queryQueryQuery = QueryQuery.makeQuery(view, qs, new StageWriter(true, undefined), // stage write indicates we want to get a result.
+    false);
+    return queryQueryQuery.getResultStructDef();
+}
+exports.getResultStructDefForView = getResultStructDefForView;
+function getResultStructDefForQuery(model, query) {
+    const queryModel = new QueryModel(model);
+    const compiled = queryModel.compileQuery(query);
+    return compiled.structs[compiled.structs.length - 1];
+}
+exports.getResultStructDefForQuery = getResultStructDefForQuery;
 /** Query builder object. */
 class QueryQuery extends QueryField {
     constructor(fieldDef, parent, stageWriter, isJoinedSubquery) {
@@ -3087,7 +3102,7 @@ class QueryStruct {
     modelCompilerFlags() {
         if (this._modelTag === undefined) {
             const annotation = this.structDef.modelAnnotation;
-            const { tag } = tags_1.Tag.annotationToTag(annotation, { prefix: /^##!\s*/ });
+            const { tag } = (0, annotation_1.annotationToTag)(annotation, { prefix: /^##!\s*/ });
             this._modelTag = tag;
         }
         return this._modelTag;