@malloydata/malloy 0.0.43 → 0.0.44-dev230623185845

package/dist/lang/ast/types/definition-list.js

@@ -0,0 +1,52 @@
+"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.DefinitionList = void 0;
+const malloy_element_1 = require("./malloy-element");
+const noteable_1 = require("../types/noteable");
+class DefinitionList extends malloy_element_1.ListOf {
+    constructor() {
+        super(...arguments);
+        this.isNoteableObj = true;
+    }
+    extendNote(ext) {
+        (0, noteable_1.extendNoteHelper)(this, ext);
+        this.distributeAnnotation();
+    }
+    distributeAnnotation() {
+        if (this.note) {
+            for (const el of this.elements) {
+                if ((0, noteable_1.isNoteable)(el)) {
+                    el.extendNote(this.note);
+                }
+            }
+        }
+    }
+    newContents() {
+        super.newContents();
+        this.distributeAnnotation();
+    }
+}
+exports.DefinitionList = DefinitionList;
+//# sourceMappingURL=definition-list.js.map

package/dist/lang/ast/types/malloy-element.d.ts

@@ -1,10 +1,11 @@
-import { DocumentLocation, DocumentReference, ModelDef, Query, SQLBlockStructDef } from '../../../model/malloy_types';
+import { Annotation, DocumentLocation, DocumentReference, ModelDef, Query, SQLBlockStructDef } from '../../../model/malloy_types';
 import { LogSeverity } from '../../parse-log';
 import { MalloyTranslation } from '../../parse-malloy';
 import { ModelDataRequest } from '../../translate-response';
 import { DocumentCompileResult } from './document-compile-result';
 import { ModelEntry } from './model-entry';
 import { NameSpace } from './name-space';
+import { Noteable, extendNoteMethod } from './noteable';
 export declare abstract class MalloyElement {
     abstract elementType: string;
     codeLocation?: DocumentLocation;
@@ -62,18 +63,22 @@ export interface DocStatement extends MalloyElement {
     execute(doc: Document): ModelDataRequest;
 }
 export declare function isDocStatement(e: MalloyElement): e is DocStatement;
-export declare class ListOf<ET extends MalloyElement> extends MalloyElement {
+export declare abstract class ListOf<ET extends MalloyElement> extends MalloyElement {
     protected elements: ET[];
-    elementType: string;
-    constructor(listDesc: string, elements: ET[]);
-    private newContents;
+    constructor(elements: ET[]);
+    protected newContents(): void;
     get list(): ET[];
     empty(): boolean;
     notEmpty(): boolean;
     push(...el: ET[]): ET[];
 }
-export declare class RunList extends ListOf<DocStatement> {
+export declare class RunList extends ListOf<DocStatement> implements Noteable {
+    elementType: string;
     execCursor: number;
+    readonly isNoteableObj = true;
+    extendNote: typeof extendNoteMethod;
+    note?: Annotation;
+    noteCursor: number;
     executeList(doc: Document): ModelDataRequest;
 }
 /**
@@ -97,6 +102,7 @@ export declare class Document extends MalloyElement implements NameSpace {
     sqlBlocks: SQLBlockStructDef[];
     statements: RunList;
     didInitModel: boolean;
+    notes: string[];
     constructor(statements: DocStatement[]);
     initModelDef(extendingModelDef: ModelDef | undefined): void;
     compile(): DocumentCompileResult;
@@ -105,4 +111,13 @@ export declare class Document extends MalloyElement implements NameSpace {
     getEntry(str: string): ModelEntry;
     setEntry(str: string, ent: ModelEntry): void;
 }
+export declare class ObjectAnnotation extends MalloyElement {
+    readonly notes: string[];
+    elementType: string;
+    constructor(notes: string[]);
+}
+export declare class ModelAnnotation extends ObjectAnnotation implements DocStatement {
+    elementType: string;
+    execute(doc: Document): ModelDataRequest;
+}
 export {};

package/dist/lang/ast/types/malloy-element.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Document = exports.RunList = exports.ListOf = exports.isDocStatement = exports.ModelEntryReference = exports.Unimplemented = exports.MalloyElement = void 0;
+exports.ModelAnnotation = exports.ObjectAnnotation = exports.Document = exports.RunList = exports.ListOf = exports.isDocStatement = exports.ModelEntryReference = exports.Unimplemented = exports.MalloyElement = void 0;
 /*
  * Copyright 2023 Google LLC
  *
@@ -29,6 +29,7 @@ exports.Document = exports.RunList = exports.ListOf = exports.isDocStatement = e
 const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
 const malloy_types_1 = require("../../../model/malloy_types");
 const global_name_space_1 = require("./global-name-space");
+const noteable_1 = require("./noteable");
 class MalloyElement {
     /**
      * @param kids All children passed to the constructor are not optional
@@ -262,17 +263,13 @@ function isDocStatement(e) {
 }
 exports.isDocStatement = isDocStatement;
 class ListOf extends MalloyElement {
-    constructor(listDesc, elements) {
+    constructor(elements) {
         super();
         this.elements = elements;
-        this.elementType = 'genericElementList';
-        if (this.elementType === 'genericElementList') {
-            this.elementType = listDesc;
-        }
         this.newContents();
     }
     newContents() {
-        this.has({ [this.elementType]: this.elements });
+        this.has({ listOf: this.elements });
     }
     get list() {
         return this.elements;
@@ -293,18 +290,30 @@ exports.ListOf = ListOf;
 class RunList extends ListOf {
     constructor() {
         super(...arguments);
+        this.elementType = 'topLevelStatements';
         this.execCursor = 0;
+        this.isNoteableObj = true;
+        this.extendNote = noteable_1.extendNoteMethod;
+        this.noteCursor = 0;
     }
     executeList(doc) {
         while (this.execCursor < this.elements.length) {
             const el = this.elements[this.execCursor];
-            if (isDocStatement(el)) {
-                const resp = el.execute(doc);
-                if (resp) {
-                    return resp;
+            if (this.noteCursor === this.execCursor) {
+                // We only want to set the note on each element once,
+                // but we might execute a element multiple times
+                if (this.note && (0, noteable_1.isNoteable)(el)) {
+                    el.extendNote(this.note);
                 }
-                this.execCursor += 1;
+                this.noteCursor += 1;
+            }
+            const resp = el.execute(doc);
+            if (resp) {
+                // Statment needs information (likely SQL schema) so we return
+                // the response, and will come back here later
+                return resp;
             }
+            this.execCursor += 1;
         }
         return undefined;
     }
@@ -332,7 +341,8 @@ class Document extends MalloyElement {
         this.queryList = [];
         this.sqlBlocks = [];
         this.didInitModel = false;
-        this.statements = new RunList('topLevelStatements', statements);
+        this.notes = [];
+        this.statements = new RunList(statements);
         this.has({ statements: statements });
     }
     initModelDef(extendingModelDef) {
@@ -376,6 +386,9 @@ class Document extends MalloyElement {
                 def.contents[entry] = (0, cloneDeep_1.default)(entryDef);
             }
         }
+        if (this.notes.length > 0) {
+            def.annotation = { notes: this.notes };
+        }
         return def;
     }
     defineSQL(sql, name) {
@@ -407,4 +420,23 @@ class Document extends MalloyElement {
     }
 }
 exports.Document = Document;
+class ObjectAnnotation extends MalloyElement {
+    constructor(notes) {
+        super();
+        this.notes = notes;
+        this.elementType = 'annotation';
+    }
+}
+exports.ObjectAnnotation = ObjectAnnotation;
+class ModelAnnotation extends ObjectAnnotation {
+    constructor() {
+        super(...arguments);
+        this.elementType = 'modelAnnotation';
+    }
+    execute(doc) {
+        doc.notes = doc.notes.concat(this.notes);
+        return;
+    }
+}
+exports.ModelAnnotation = ModelAnnotation;
 //# sourceMappingURL=malloy-element.js.map

package/dist/lang/ast/types/noteable.d.ts

@@ -0,0 +1,12 @@
+import { Annotation } from '../../../model/malloy_types';
+/**
+ * An object which can receive annotations is "Noteable"
+ */
+export interface Noteable {
+    isNoteableObj: true;
+    note?: Annotation;
+    extendNote(ext: Partial<Annotation>): void;
+}
+export declare function isNoteable(el: unknown): el is Noteable;
+export declare function extendNoteMethod(this: Noteable, ext: Partial<Annotation>): void;
+export declare function extendNoteHelper(to: Noteable, ext: Partial<Annotation>): void;

package/dist/lang/ast/types/noteable.js

@@ -0,0 +1,42 @@
+"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.extendNoteHelper = exports.extendNoteMethod = exports.isNoteable = void 0;
+function isNoteable(el) {
+    return el.isNoteableObj;
+}
+exports.isNoteable = isNoteable;
+function extendNoteMethod(ext) {
+    extendNoteHelper(this, ext);
+}
+exports.extendNoteMethod = extendNoteMethod;
+function extendNoteHelper(to, ext) {
+    if ((ext.notes && ext.notes.length > 0) ||
+        (ext.blockNotes && ext.blockNotes.length > 0) ||
+        ext.inherits !== undefined) {
+        to.note = { ...to.note, ...ext };
+    }
+}
+exports.extendNoteHelper = extendNoteHelper;
+//# sourceMappingURL=noteable.js.map

package/dist/lang/ast/types/query-extend-property.d.ts

@@ -1,4 +1,4 @@
-import { Dimensions } from '../query-properties/dimmensions';
+import { Dimensions } from '../query-properties/dimensions';
 import { Joins } from '../query-properties/joins';
 import { Measures } from '../query-properties/measures';
 import { MalloyElement } from './malloy-element';

package/dist/lang/ast/types/query-extend-property.js

@@ -23,11 +23,11 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isQueryExtendProperty = void 0;
-const dimmensions_1 = require("../query-properties/dimmensions");
+const dimensions_1 = require("../query-properties/dimensions");
 const joins_1 = require("../query-properties/joins");
 const measures_1 = require("../query-properties/measures");
 function isQueryExtendProperty(q) {
-    return q instanceof dimmensions_1.Dimensions || q instanceof measures_1.Measures || q instanceof joins_1.Joins;
+    return q instanceof dimensions_1.Dimensions || q instanceof measures_1.Measures || q instanceof joins_1.Joins;
 }
 exports.isQueryExtendProperty = isQueryExtendProperty;
 //# sourceMappingURL=query-extend-property.js.map

package/dist/lang/ast/types/query-property.d.ts

@@ -1,6 +1,6 @@
 import { NestDefinition } from '../query-properties/nest';
 import { NestReference } from '../query-properties/nest-reference';
-import { MalloyElement } from './malloy-element';
+import { MalloyElement, ObjectAnnotation } from './malloy-element';
 import { Aggregate } from '../query-properties/aggregate';
 import { DeclareFields } from '../query-properties/declare-fields';
 import { Filter } from '../query-properties/filters';
@@ -13,6 +13,7 @@ import { Ordering } from '../query-properties/ordering';
 import { ProjectStatement } from '../query-properties/project-statement';
 import { SampleProperty } from '../query-properties/sampling';
 import { Top } from '../query-properties/top';
+import { TimezoneStatement } from '../source-properties/timezone-statement';
 import { ExtendBlock } from '../query-properties/extend';
-export declare type QueryProperty = Ordering | Top | Limit | Filter | Index | SampleProperty | Joins | DeclareFields | ProjectStatement | NestReference | NestDefinition | NestReference | Nests | Aggregate | GroupBy | ExtendBlock;
+export declare type QueryProperty = Ordering | Top | Limit | Filter | Index | SampleProperty | Joins | DeclareFields | ProjectStatement | NestReference | NestDefinition | NestReference | Nests | Aggregate | GroupBy | ObjectAnnotation | TimezoneStatement | GroupBy | ExtendBlock;
 export declare function isQueryProperty(q: MalloyElement): q is QueryProperty;

package/dist/lang/ast/types/query-property.js

@@ -24,6 +24,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isQueryProperty = void 0;
 const nest_1 = require("../query-properties/nest");
+const malloy_element_1 = require("./malloy-element");
 const aggregate_1 = require("../query-properties/aggregate");
 const declare_fields_1 = require("../query-properties/declare-fields");
 const filters_1 = require("../query-properties/filters");
@@ -53,6 +54,7 @@ function isQueryProperty(q) {
         q instanceof calculate_1.Calculate ||
         q instanceof nests_1.Nests ||
         q instanceof extend_1.ExtendBlock ||
+        q instanceof malloy_element_1.ObjectAnnotation ||
         (0, nest_1.isNestedQuery)(q) ||
         q instanceof group_by_1.GroupBy ||
         q instanceof timezone_statement_1.TimezoneStatement);

package/dist/lang/ast/types/source-desc.d.ts

@@ -0,0 +1,5 @@
+import { SourceProperty } from './source-property';
+import { ListOf } from './malloy-element';
+export declare class SourceDesc extends ListOf<SourceProperty> {
+    elementType: string;
+}

package/dist/lang/ast/types/{explore-desc.js → source-desc.js}

@@ -22,12 +22,13 @@
  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExploreDesc = void 0;
+exports.SourceDesc = void 0;
 const malloy_element_1 = require("./malloy-element");
-class ExploreDesc extends malloy_element_1.ListOf {
-    constructor(props) {
-        super('exploreDesc', props);
+class SourceDesc extends malloy_element_1.ListOf {
+    constructor() {
+        super(...arguments);
+        this.elementType = 'sourceDescription';
     }
 }
-exports.ExploreDesc = ExploreDesc;
-//# sourceMappingURL=explore-desc.js.map
+exports.SourceDesc = SourceDesc;
+//# sourceMappingURL=source-desc.js.map

package/dist/lang/ast/types/source-property.d.ts

@@ -5,7 +5,7 @@ import { FieldListEdit } from '../source-properties/field-list-edit';
 import { Renames } from '../source-properties/renames';
 import { PrimaryKey } from '../source-properties/primary-key';
 import { Turtles } from '../source-properties/turtles';
-import { MalloyElement } from './malloy-element';
+import { MalloyElement, ObjectAnnotation } from './malloy-element';
 import { TimezoneStatement } from '../source-properties/timezone-statement';
-export declare type SourceProperty = Filter | Joins | DeclareFields | FieldListEdit | Renames | PrimaryKey | Turtles | TimezoneStatement;
+export declare type SourceProperty = Filter | Joins | DeclareFields | FieldListEdit | Renames | PrimaryKey | ObjectAnnotation | Turtles | TimezoneStatement;
 export declare function isSourceProperty(p: MalloyElement): p is SourceProperty;

package/dist/lang/ast/types/source-property.js

@@ -30,6 +30,7 @@ const field_list_edit_1 = require("../source-properties/field-list-edit");
 const renames_1 = require("../source-properties/renames");
 const primary_key_1 = require("../source-properties/primary-key");
 const turtles_1 = require("../source-properties/turtles");
+const malloy_element_1 = require("./malloy-element");
 const timezone_statement_1 = require("../source-properties/timezone-statement");
 function isSourceProperty(p) {
     return (p instanceof filters_1.Filter ||
@@ -38,6 +39,7 @@ function isSourceProperty(p) {
         p instanceof field_list_edit_1.FieldListEdit ||
         p instanceof renames_1.Renames ||
         p instanceof primary_key_1.PrimaryKey ||
+        p instanceof malloy_element_1.ObjectAnnotation ||
         p instanceof turtles_1.Turtles ||
         p instanceof timezone_statement_1.TimezoneStatement);
 }

package/dist/lang/ast/types/space-field.d.ts

@@ -3,6 +3,7 @@ import { SpaceEntry } from './space-entry';
 import { FieldSpace } from './field-space';
 export declare abstract class SpaceField extends SpaceEntry {
     readonly refType = "field";
+    haveFieldDef?: FieldDef;
     protected fieldTypeFromFieldDef(def: FieldDef): TypeDesc;
     getQueryFieldDef(_fs: FieldSpace): QueryFieldDef | undefined;
     fieldDef(): FieldDef | undefined;

package/dist/lang/lib/Malloy/MalloyLexer.d.ts

@@ -93,60 +93,62 @@ export declare class MalloyLexer extends Lexer {
     static readonly STRING_ESCAPE = 88;
     static readonly HACKY_REGEX = 89;
     static readonly STRING_LITERAL = 90;
-    static readonly AMPER = 91;
-    static readonly ARROW = 92;
-    static readonly FAT_ARROW = 93;
-    static readonly OPAREN = 94;
-    static readonly CPAREN = 95;
-    static readonly OBRACK = 96;
-    static readonly CBRACK = 97;
-    static readonly OCURLY = 98;
-    static readonly CCURLY = 99;
-    static readonly DOUBLECOLON = 100;
-    static readonly TRIPLECOLON = 101;
-    static readonly EXCLAM = 102;
-    static readonly COLON = 103;
-    static readonly COMMA = 104;
-    static readonly DOT = 105;
-    static readonly LT = 106;
-    static readonly GT = 107;
-    static readonly EQ = 108;
-    static readonly NE = 109;
-    static readonly LTE = 110;
-    static readonly GTE = 111;
-    static readonly PLUS = 112;
-    static readonly MINUS = 113;
-    static readonly STAR = 114;
-    static readonly STARSTAR = 115;
-    static readonly SLASH = 116;
-    static readonly BAR = 117;
-    static readonly SEMI = 118;
-    static readonly NOT_MATCH = 119;
-    static readonly MATCH = 120;
-    static readonly PERCENT = 121;
-    static readonly DOUBLE_QMARK = 122;
-    static readonly QMARK = 123;
-    static readonly LITERAL_TIMESTAMP = 124;
-    static readonly LITERAL_HOUR = 125;
-    static readonly LITERAL_DAY = 126;
-    static readonly LITERAL_QUARTER = 127;
-    static readonly LITERAL_MONTH = 128;
-    static readonly LITERAL_WEEK = 129;
-    static readonly LITERAL_YEAR = 130;
-    static readonly IDENTIFIER = 131;
-    static readonly PERCENT_LITERAL = 132;
-    static readonly INTEGER_LITERAL = 133;
-    static readonly NUMERIC_LITERAL = 134;
-    static readonly OBJECT_NAME_LITERAL = 135;
-    static readonly BLOCK_COMMENT = 136;
-    static readonly COMMENT_TO_EOL = 137;
-    static readonly WHITE_SPACE = 138;
-    static readonly SQL_BEGIN = 139;
-    static readonly CLOSE_CODE = 140;
-    static readonly UNWATED_CHARS_TRAILING_NUMBERS = 141;
-    static readonly UNEXPECTED_CHAR = 142;
-    static readonly OPEN_CODE = 143;
-    static readonly SQL_END = 144;
+    static readonly DOC_ANNOTATION = 91;
+    static readonly ANNOTATION = 92;
+    static readonly AMPER = 93;
+    static readonly ARROW = 94;
+    static readonly FAT_ARROW = 95;
+    static readonly OPAREN = 96;
+    static readonly CPAREN = 97;
+    static readonly OBRACK = 98;
+    static readonly CBRACK = 99;
+    static readonly OCURLY = 100;
+    static readonly CCURLY = 101;
+    static readonly DOUBLECOLON = 102;
+    static readonly TRIPLECOLON = 103;
+    static readonly EXCLAM = 104;
+    static readonly COLON = 105;
+    static readonly COMMA = 106;
+    static readonly DOT = 107;
+    static readonly LT = 108;
+    static readonly GT = 109;
+    static readonly EQ = 110;
+    static readonly NE = 111;
+    static readonly LTE = 112;
+    static readonly GTE = 113;
+    static readonly PLUS = 114;
+    static readonly MINUS = 115;
+    static readonly STAR = 116;
+    static readonly STARSTAR = 117;
+    static readonly SLASH = 118;
+    static readonly BAR = 119;
+    static readonly SEMI = 120;
+    static readonly NOT_MATCH = 121;
+    static readonly MATCH = 122;
+    static readonly PERCENT = 123;
+    static readonly DOUBLE_QMARK = 124;
+    static readonly QMARK = 125;
+    static readonly LITERAL_TIMESTAMP = 126;
+    static readonly LITERAL_HOUR = 127;
+    static readonly LITERAL_DAY = 128;
+    static readonly LITERAL_QUARTER = 129;
+    static readonly LITERAL_MONTH = 130;
+    static readonly LITERAL_WEEK = 131;
+    static readonly LITERAL_YEAR = 132;
+    static readonly IDENTIFIER = 133;
+    static readonly PERCENT_LITERAL = 134;
+    static readonly INTEGER_LITERAL = 135;
+    static readonly NUMERIC_LITERAL = 136;
+    static readonly OBJECT_NAME_LITERAL = 137;
+    static readonly BLOCK_COMMENT = 138;
+    static readonly COMMENT_TO_EOL = 139;
+    static readonly WHITE_SPACE = 140;
+    static readonly SQL_BEGIN = 141;
+    static readonly CLOSE_CODE = 142;
+    static readonly UNWATED_CHARS_TRAILING_NUMBERS = 143;
+    static readonly UNEXPECTED_CHAR = 144;
+    static readonly OPEN_CODE = 145;
+    static readonly SQL_END = 146;
     static readonly SQL_MODE = 1;
     static readonly channelNames: string[];
     static readonly modeNames: string[];