@malloydata/malloy 0.0.104-dev231117205713 → 0.0.104-dev231117214047

package/dist/lang/parse-malloy.d.ts

@@ -3,7 +3,7 @@ import { DocumentLocation, DocumentPosition, DocumentRange, DocumentReference, I
 import { LogMessage, MessageLog, MessageLogger } from './parse-log';
 import { Zone, ZoneData } from './zone';
 import { ReferenceList } from './reference-list';
-import { ASTResponse, CompletionsResponse, DataRequestResponse, ProblemResponse, FatalResponse, FinalResponse, HelpContextResponse, MetadataResponse, ModelDataRequest, NeedURLData, TranslateResponse } from './translate-response';
+import { ASTResponse, CompletionsResponse, DataRequestResponse, ProblemResponse, FatalResponse, FinalResponse, HelpContextResponse, MetadataResponse, ModelDataRequest, NeedURLData, TranslateResponse, ModelAnnotationResponse } from './translate-response';
 import { Tag } from '../tags';
 import { MalloyParseInfo } from './malloy-parse-info';
 export type StepResponses = DataRequestResponse | ASTResponse | TranslateResponse | ParseResponse | MetadataResponse;
@@ -83,6 +83,12 @@ declare class HelpContextStep implements TranslationStep {
         character: number;
     }): HelpContextResponse;
 }
+declare class ModelAnnotationStep implements TranslationStep {
+    readonly parseStep: ParseStep;
+    response?: ModelAnnotationResponse;
+    constructor(parseStep: ParseStep);
+    step(that: MalloyTranslation, extendingModel?: ModelDef): ModelAnnotationResponse;
+}
 declare class TranslateStep implements TranslationStep {
     readonly astStep: ASTStep;
     response?: TranslateResponse;
@@ -103,6 +109,7 @@ export declare abstract class MalloyTranslation {
     imports: ImportLocation[];
     compilerFlags: Tag;
     readonly parseStep: ParseStep;
+    readonly modelAnnotationStep: ModelAnnotationStep;
     readonly importsAndTablesStep: ImportsAndTablesStep;
     readonly astStep: ASTStep;
     readonly metadataStep: MetadataStep;
@@ -136,6 +143,7 @@ export declare abstract class MalloyTranslation {
     translate(extendingModel?: ModelDef): TranslateResponse;
     importAt(position: DocumentPosition): ImportLocation | undefined;
     metadata(): MetadataResponse;
+    modelAnnotation(extendingModel?: ModelDef): ModelAnnotationResponse;
     completions(position: {
         line: number;
         character: number;

package/dist/lang/parse-malloy.js

@@ -62,6 +62,7 @@ const reference_list_1 = require("./reference-list");
 const translate_response_1 = require("./translate-response");
 const utils_1 = require("./utils");
 const tags_1 = require("../tags");
+const model_annotation_walker_1 = require("./parse-tree-walkers/model-annotation-walker");
 /**
  * This ignores a -> popMode when the mode stack is empty, which is a hack,
  * but it let's us parse }%
@@ -451,6 +452,29 @@ class HelpContextStep {
         }
     }
 }
+class ModelAnnotationStep {
+    constructor(parseStep) {
+        this.parseStep = parseStep;
+    }
+    step(that, extendingModel) {
+        if (!this.response) {
+            const tryParse = this.parseStep.step(that);
+            if (!tryParse.parse || tryParse.final) {
+                return tryParse;
+            }
+            else {
+                const modelAnnotation = (0, model_annotation_walker_1.walkForModelAnnotation)(that, tryParse.parse.tokenStream, tryParse.parse);
+                this.response = {
+                    modelAnnotation: {
+                        ...modelAnnotation,
+                        inherits: extendingModel === null || extendingModel === void 0 ? void 0 : extendingModel.annotation,
+                    },
+                };
+            }
+        }
+        return this.response;
+    }
+}
 class TranslateStep {
     constructor(astStep) {
         this.astStep = astStep;
@@ -545,6 +569,7 @@ class MalloyTranslation {
          * things will happen automatically.
          */
         this.parseStep = new ParseStep();
+        this.modelAnnotationStep = new ModelAnnotationStep(this.parseStep);
         this.metadataStep = new MetadataStep(this.parseStep);
         this.completionsStep = new CompletionsStep(this.parseStep);
         this.helpContextStep = new HelpContextStep(this.parseStep);
@@ -703,6 +728,9 @@ class MalloyTranslation {
     metadata() {
         return this.metadataStep.step(this);
     }
+    modelAnnotation(extendingModel) {
+        return this.modelAnnotationStep.step(this, extendingModel);
+    }
     completions(position) {
         return this.completionsStep.step(this, position);
     }

package/dist/lang/parse-tree-walkers/model-annotation-walker.d.ts

@@ -0,0 +1,5 @@
+import { CommonTokenStream } from 'antlr4ts';
+import { MalloyTranslation } from '../parse-malloy';
+import { Annotation } from '../../model/malloy_types';
+import { MalloyParseInfo } from '../malloy-parse-info';
+export declare function walkForModelAnnotation(forParse: MalloyTranslation, tokens: CommonTokenStream, parseInfo: MalloyParseInfo): Annotation;

package/dist/lang/parse-tree-walkers/model-annotation-walker.js

@@ -0,0 +1,60 @@
+"use strict";
+/*
+ * Copyright 2023 Google LLC
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files
+ * (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge,
+ * publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.walkForModelAnnotation = void 0;
+const ParseTreeWalker_1 = require("antlr4ts/tree/ParseTreeWalker");
+class ModelAnnotationWalker {
+    constructor(translator, tokens, parseInfo) {
+        this.translator = translator;
+        this.tokens = tokens;
+        this.parseInfo = parseInfo;
+        this.notes = [];
+    }
+    getLocation(cx) {
+        return {
+            url: this.parseInfo.sourceURL,
+            range: this.parseInfo.rangeFromContext(cx),
+        };
+    }
+    enterDocAnnotations(pcx) {
+        const allNotes = pcx.DOC_ANNOTATION().map(note => {
+            return {
+                text: note.text,
+                at: this.getLocation(pcx),
+            };
+        });
+        this.notes.push(...allNotes);
+    }
+    get annotation() {
+        return { notes: this.notes };
+    }
+}
+function walkForModelAnnotation(forParse, tokens, parseInfo) {
+    const finder = new ModelAnnotationWalker(forParse, tokens, parseInfo);
+    const listener = finder;
+    ParseTreeWalker_1.ParseTreeWalker.DEFAULT.walk(listener, parseInfo.root);
+    return finder.annotation;
+}
+exports.walkForModelAnnotation = walkForModelAnnotation;
+//# sourceMappingURL=model-annotation-walker.js.map

package/dist/lang/test/model-annotation-walker.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/lang/test/model-annotation-walker.spec.js

@@ -0,0 +1,46 @@
+"use strict";
+/*
+ * Copyright 2023 Google LLC
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files
+ * (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge,
+ * publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_translator_1 = require("./test-translator");
+test('model annotations can be retrieved', () => {
+    var _a, _b;
+    const src = (0, test_translator_1.markSource) `${'## foo'}`;
+    const doc = new test_translator_1.TestTranslator(src.code);
+    const { modelAnnotation } = doc.modelAnnotation();
+    expect((_a = modelAnnotation === null || modelAnnotation === void 0 ? void 0 : modelAnnotation.notes) === null || _a === void 0 ? void 0 : _a.length).toBe(1);
+    const notes = (_b = modelAnnotation === null || modelAnnotation === void 0 ? void 0 : modelAnnotation.notes) !== null && _b !== void 0 ? _b : [];
+    expect(notes[0].text).toBe('## foo');
+    expect(notes[0].at).toMatchObject(src.locations[0]);
+});
+test('does not explode if bad parse', () => {
+    const src = (0, test_translator_1.markSource) `
+    ${'## foo'}
+    asd afsjei ; duavby {{}}}
+  `;
+    const doc = new test_translator_1.TestTranslator(src.code);
+    const response = doc.modelAnnotation();
+    expect(response.modelAnnotation).toBe(undefined);
+    expect(response.final).toBe(true);
+});
+//# sourceMappingURL=model-annotation-walker.spec.js.map

package/dist/lang/translate-response.d.ts

@@ -1,4 +1,4 @@
-import { ModelDef, Query, SQLBlockSource, SQLBlockStructDef } from '../model/malloy_types';
+import { Annotation, ModelDef, Query, SQLBlockSource, SQLBlockStructDef } from '../model/malloy_types';
 import { MalloyElement } from './ast';
 import { LogMessage } from './parse-log';
 import { DocumentSymbol } from './parse-tree-walkers/document-symbol-walker';
@@ -43,6 +43,10 @@ interface Metadata extends NeededData, ProblemResponse, FinalResponse {
     highlights: DocumentHighlight[];
 }
 export type MetadataResponse = Partial<Metadata>;
+interface ModelAnnotationData extends NeededData, ProblemResponse, FinalResponse {
+    modelAnnotation: Annotation;
+}
+export type ModelAnnotationResponse = Partial<ModelAnnotationData>;
 interface Completions extends NeededData, ProblemResponse, FinalResponse {
     completions: DocumentCompletion[];
 }

package/dist/malloy.d.ts

@@ -2,7 +2,7 @@
 import { RunSQLOptions } from './run_sql_options';
 import { DocumentCompletion as DocumentCompletionDefinition, DocumentHighlight as DocumentHighlightDefinition, DocumentSymbol as DocumentSymbolDefinition, LogMessage, MalloyTranslator } from './lang';
 import { DocumentHelpContext } from './lang/parse-tree-walkers/document-help-context-walker';
-import { CompiledQuery, DocumentLocation, DocumentReference, FieldBooleanDef, FieldDateDef, FieldJSONDef, FieldNumberDef, FieldStringDef, FieldTimestampDef, FieldTypeDef, FilterExpression, Query as InternalQuery, ModelDef, DocumentPosition as ModelDocumentPosition, NamedQuery, QueryData, QueryDataRow, QueryResult, SQLBlock, SQLBlockStructDef, SearchIndexResult, SearchValueMapResult, StructDef, TurtleDef, FieldUnsupportedDef, QueryRunStats, ImportLocation } from './model';
+import { CompiledQuery, DocumentLocation, DocumentReference, FieldBooleanDef, FieldDateDef, FieldJSONDef, FieldNumberDef, FieldStringDef, FieldTimestampDef, FieldTypeDef, FilterExpression, Query as InternalQuery, ModelDef, DocumentPosition as ModelDocumentPosition, NamedQuery, QueryData, QueryDataRow, QueryResult, SQLBlock, SQLBlockStructDef, SearchIndexResult, SearchValueMapResult, StructDef, TurtleDef, FieldUnsupportedDef, QueryRunStats, ImportLocation, Annotation } from './model';
 import { Connection, InfoConnection, LookupConnection, ModelString, ModelURL, QueryString, QueryURL, URLReader } from './runtime_types';
 import { Tag, TagParse, TagParseSpec, Taggable } from './tags';
 export interface Loggable {
@@ -425,6 +425,8 @@ export declare class PreparedResult implements Taggable {
     constructor(query: CompiledQuery, modelDef: ModelDef);
     tagParse(spec?: TagParseSpec): TagParse;
     getTaglines(prefix?: RegExp): string[];
+    get annotation(): Annotation | undefined;
+    get modelAnnotation(): Annotation | undefined;
     /**
      * @return The name of the connection this query should be run against.
      */

package/dist/malloy.js

@@ -129,6 +129,7 @@ class Malloy {
                         }
                     }
                 }
+                const { modelAnnotation } = translator.modelAnnotation(model === null || model === void 0 ? void 0 : model._modelDef);
                 if (result.tables) {
                     // collect tables by connection name since there may be multiple connections
                     const tablesByConnection = new Map();
@@ -151,6 +152,7 @@ class Malloy {
                             //      the translator runs into an infinite loop fetching tables.
                             const { schemas: tables, errors } = await connection.fetchSchemaForTables(tablePathByKey, {
                                 refreshTimestamp,
+                                modelAnnotation,
                             });
                             translator.update({ tables, errors: { tables: errors } });
                         }
@@ -175,6 +177,7 @@ class Malloy {
                         const expanded = Malloy.compileSQLBlock(result.partialModel, toCompile);
                         const resolved = await conn.fetchSchemaForSQLBlock(expanded, {
                             refreshTimestamp,
+                            modelAnnotation,
                         });
                         if (resolved.error) {
                             translator.update({
@@ -747,6 +750,12 @@ class PreparedResult {
     getTaglines(prefix) {
         return tags_1.Tag.annotationToTaglines(this.inner.annotation, prefix);
     }
+    get annotation() {
+        return this.inner.annotation;
+    }
+    get modelAnnotation() {
+        return this.modelDef.annotation;
+    }
     /**
      * @return The name of the connection this query should be run against.
      */
@@ -2033,12 +2042,18 @@ class QueryMaterializer extends FluentState {
     async run(options) {
         const connections = this.runtime.connections;
         const preparedResult = await this.getPreparedResult();
-        return Malloy.run({ connections, preparedResult, options });
+        const finalOptions = runSQLOptionsWithAnnotations(preparedResult, options);
+        return Malloy.run({ connections, preparedResult, options: finalOptions });
     }
     async *runStream(options) {
         const preparedResult = await this.getPreparedResult();
         const connections = this.runtime.connections;
-        const stream = Malloy.runStream({ connections, preparedResult, options });
+        const finalOptions = runSQLOptionsWithAnnotations(preparedResult, options);
+        const stream = Malloy.runStream({
+            connections,
+            preparedResult,
+            options: finalOptions,
+        });
         for await (const row of stream) {
             yield row;
         }
@@ -2090,6 +2105,13 @@ class QueryMaterializer extends FluentState {
     }
 }
 exports.QueryMaterializer = QueryMaterializer;
+function runSQLOptionsWithAnnotations(preparedResult, givenOptions) {
+    return {
+        queryAnnotation: preparedResult.annotation,
+        modelAnnotation: preparedResult.modelAnnotation,
+        ...givenOptions,
+    };
+}
 /**
  * An object representing the task of loading a `PreparedResult`, capable of
  * materializing the prepared result (via `getPreparedResult()`) or extending the task run
@@ -2104,12 +2126,22 @@ class PreparedResultMaterializer extends FluentState {
     async run(options) {
         const preparedResult = await this.getPreparedResult();
         const connections = this.runtime.connections;
-        return Malloy.run({ connections, preparedResult, options });
+        const finalOptions = runSQLOptionsWithAnnotations(preparedResult, options);
+        return Malloy.run({
+            connections,
+            preparedResult,
+            options: finalOptions,
+        });
     }
     async *runStream(options) {
         const preparedResult = await this.getPreparedResult();
         const connections = this.runtime.connections;
-        const stream = Malloy.runStream({ connections, preparedResult, options });
+        const finalOptions = runSQLOptionsWithAnnotations(preparedResult, options);
+        const stream = Malloy.runStream({
+            connections,
+            preparedResult,
+            options: finalOptions,
+        });
         for await (const row of stream) {
             yield row;
         }

package/dist/run_sql_options.d.ts

@@ -1,4 +1,7 @@
+import { Annotation } from './model/malloy_types';
 export interface RunSQLOptions {
     rowLimit?: number;
     abortSignal?: AbortSignal;
+    modelAnnotation?: Annotation;
+    queryAnnotation?: Annotation;
 }

package/dist/runtime_types.d.ts

@@ -1,5 +1,5 @@
 import { RunSQLOptions } from './run_sql_options';
-import { MalloyQueryData, QueryDataRow, QueryRunStats, SQLBlock, StructDef } from './model/malloy_types';
+import { Annotation, MalloyQueryData, QueryDataRow, QueryRunStats, SQLBlock, StructDef } from './model/malloy_types';
 import { Dialect } from './dialect';
 /**
  * The contents of a Malloy query document.
@@ -34,6 +34,7 @@ export interface URLReader {
  */
 export interface FetchSchemaOptions {
     refreshTimestamp?: number;
+    modelAnnotation?: Annotation;
 }
 /**
  * An object capable of reading schemas for given table names.

package/package.json

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