@malloydata/malloy 0.0.43 → 0.0.44-dev230623185845

package/dist/lang/test/test-translator.d.ts

@@ -49,7 +49,7 @@ export declare class BetaExpression extends TestTranslator {
 }
 export declare function getExplore(modelDef: ModelDef, name: string): StructDef;
 export declare function getModelQuery(modelDef: ModelDef, name: string): Query;
-export declare function getField(thing: StructDef | PipeSegment, name: string): FieldDef;
+export declare function getFieldDef(thing: StructDef | PipeSegment, name: string): FieldDef;
 export declare function getQueryField(structDef: StructDef, name: string): TurtleDef;
 export declare function getJoinField(structDef: StructDef, name: string): StructDef;
 export interface MarkedSource {
@@ -57,10 +57,10 @@ export interface MarkedSource {
     locations: DocumentLocation[];
     translator?: TestTranslator;
 }
-export declare function expr(unmarked: TemplateStringsArray, ...marked: string[]): MarkedSource;
 interface HasTranslator extends MarkedSource {
     translator: TestTranslator;
 }
+export declare function expr(unmarked: TemplateStringsArray, ...marked: string[]): HasTranslator;
 export declare function model(unmarked: TemplateStringsArray, ...marked: string[]): HasTranslator;
 export declare function markSource(unmarked: TemplateStringsArray, ...marked: string[]): MarkedSource;
 export {};

package/dist/lang/test/test-translator.js

@@ -23,7 +23,7 @@
  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.markSource = exports.model = exports.expr = exports.getJoinField = exports.getQueryField = exports.getField = exports.getModelQuery = exports.getExplore = exports.BetaExpression = exports.TestTranslator = exports.TestChildTranslator = exports.aTableDef = exports.pretty = void 0;
+exports.markSource = exports.model = exports.expr = exports.getJoinField = exports.getQueryField = exports.getFieldDef = exports.getModelQuery = exports.getExplore = exports.BetaExpression = exports.TestTranslator = exports.TestChildTranslator = exports.aTableDef = exports.pretty = void 0;
 const util_1 = require("util");
 const malloy_types_1 = require("../../model/malloy_types");
 const ast_1 = require("../ast");
@@ -396,34 +396,46 @@ function getModelQuery(modelDef, name) {
     return modelDef.contents[name];
 }
 exports.getModelQuery = getModelQuery;
-function getField(thing, name) {
-    const result = thing.fields.find((field) => typeof field !== 'string' && (field.as || field.name) === name);
-    if (typeof result === 'string') {
-        throw new Error('Expected a def, got a ref.');
+function getFieldDef(thing, name) {
+    let found = undefined;
+    for (const f of thing.fields) {
+        if (typeof f === 'string') {
+            if (f === name) {
+                throw new Error(`Expected def for '${name}', found a ref`);
+            }
+        }
+        else if ((f.as || f.name) === name) {
+            if ((0, malloy_types_1.isFilteredAliasedName)(f)) {
+                throw new Error(`FilteredAliasedName for '${name}' unexpected`);
+            }
+            found = f;
+            break;
+        }
     }
-    if (result === undefined) {
-        throw new Error('Expected a field, not undefined');
+    if (found === undefined) {
+        throw new Error(`Compiled code did not contain expected field '${name}'`);
     }
-    if ((0, malloy_types_1.isFilteredAliasedName)(result)) {
-        throw new Error('Ignoring these for now');
+    else {
+        return found;
     }
-    return result;
 }
-exports.getField = getField;
+exports.getFieldDef = getFieldDef;
 // TODO "as" is almost always a code smell ...
 function getQueryField(structDef, name) {
-    return getField(structDef, name);
+    return getFieldDef(structDef, name);
 }
 exports.getQueryField = getQueryField;
 // TODO "as" is almost always a code smell ...
 function getJoinField(structDef, name) {
-    return getField(structDef, name);
+    return getFieldDef(structDef, name);
 }
 exports.getJoinField = getJoinField;
 function expr(unmarked, ...marked) {
     const ms = markSource(unmarked, ...marked);
-    ms.translator = new BetaExpression(ms.code);
-    return ms;
+    return {
+        ...ms,
+        translator: new BetaExpression(ms.code),
+    };
 }
 exports.expr = expr;
 function model(unmarked, ...marked) {

package/dist/malloy.d.ts

@@ -4,6 +4,7 @@ import { DocumentCompletion as DocumentCompletionDefinition, DocumentHighlight a
 import { DocumentHelpContext } from './lang/parse-tree-walkers/document-help-context-walker';
 import { CompiledQuery, 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 } from './model';
 import { Connection, InfoConnection, LookupConnection, ModelString, ModelURL, QueryString, QueryURL, URLReader } from './runtime_types';
+import { Taggable, Tags } from './tags';
 export interface Loggable {
     debug: (message?: any, ...optionalParams: any[]) => void;
     info: (message?: any, ...optionalParams: any[]) => void;
@@ -211,11 +212,12 @@ export declare class Model {
 /**
  * A prepared query which has all the necessary information to produce its SQL.
  */
-export declare class PreparedQuery {
+export declare class PreparedQuery implements Taggable {
     _modelDef: ModelDef;
     _query: InternalQuery | NamedQuery;
     name?: string;
     constructor(query: InternalQuery, model: ModelDef, name?: string);
+    getTags(): Tags;
     /**
      * Generate the SQL for this query.
      *
@@ -378,10 +380,11 @@ export declare class DocumentCompletion {
 /**
  * A fully-prepared query containing SQL and metadata required to run the query.
  */
-export declare class PreparedResult {
+export declare class PreparedResult implements Taggable {
     protected inner: CompiledQuery;
     protected modelDef: ModelDef;
     constructor(query: CompiledQuery, modelDef: ModelDef);
+    getTags(): Tags;
     /**
      * @return The name of the connection this query should be run against.
      */
@@ -515,11 +518,12 @@ export declare enum AtomicFieldType {
     Unsupported = "unsupported",
     Error = "error"
 }
-export declare class AtomicField extends Entity {
+export declare class AtomicField extends Entity implements Taggable {
     protected fieldTypeDef: FieldTypeDef;
     protected parent: Explore;
     constructor(fieldTypeDef: FieldTypeDef, parent: Explore, source?: AtomicField);
     get type(): AtomicFieldType;
+    getTags(): Tags;
     isIntrinsic(): boolean;
     isQueryField(): this is QueryField;
     isExploreField(): this is ExploreField;
@@ -595,9 +599,10 @@ export declare class Query extends Entity {
     get source(): Query | undefined;
     isIntrinsic(): boolean;
 }
-export declare class QueryField extends Query {
+export declare class QueryField extends Query implements Taggable {
     protected parent: Explore;
     constructor(turtleDef: TurtleDef, parent: Explore, source?: Query);
+    getTags(): Tags;
     isQueryField(): this is QueryField;
     isExploreField(): this is ExploreField;
     isAtomicField(): this is AtomicField;
@@ -611,10 +616,11 @@ export declare enum JoinRelationship {
     OneToMany = "one_to_many",
     ManyToOne = "many_to_one"
 }
-export declare class ExploreField extends Explore {
+export declare class ExploreField extends Explore implements Taggable {
     protected _parentExplore: Explore;
     constructor(structDef: StructDef, parentExplore: Explore, source?: Explore);
     get joinRelationship(): JoinRelationship;
+    getTags(): Tags;
     isQueryField(): this is QueryField;
     isExploreField(): this is ExploreField;
     isAtomicField(): this is AtomicField;

package/dist/malloy.js

@@ -26,6 +26,7 @@ exports.CSVWriter = exports.JSONWriter = exports.DataWriter = exports.DataRecord
 const lang_1 = require("./lang");
 const model_1 = require("./model");
 const luxon_1 = require("luxon");
+const tags_1 = require("./tags");
 class Malloy {
     // TODO load from file built during release
     static get version() {
@@ -444,6 +445,9 @@ class PreparedQuery {
         this._modelDef = model;
         this.name = name;
     }
+    getTags() {
+        return new tags_1.Tags(this._query.annotation);
+    }
     /**
      * Generate the SQL for this query.
      *
@@ -677,6 +681,9 @@ class PreparedResult {
         this.inner = query;
         this.modelDef = modelDef;
     }
+    getTags() {
+        return new tags_1.Tags(this.inner.annotation);
+    }
     /**
      * @return The name of the connection this query should be run against.
      */
@@ -1062,6 +1069,9 @@ class AtomicField extends Entity {
                 return AtomicFieldType.Error;
         }
     }
+    getTags() {
+        return new tags_1.Tags(this.fieldTypeDef.annotation);
+    }
     isIntrinsic() {
         return (0, model_1.FieldIsIntrinsic)(this.fieldTypeDef);
     }
@@ -1261,6 +1271,9 @@ class QueryField extends Query {
         super(turtleDef, parent, source);
         this.parent = parent;
     }
+    getTags() {
+        return new tags_1.Tags(this.turtleDef.annotation);
+    }
     isQueryField() {
         return true;
     }
@@ -1311,6 +1324,9 @@ class ExploreField extends Explore {
                 throw new Error('A source field must have a join relationship.');
         }
     }
+    getTags() {
+        return new tags_1.Tags(this._structDef.annotation);
+    }
     isQueryField() {
         return false;
     }

package/dist/model/malloy_query.js

@@ -1764,6 +1764,7 @@ class QueryQuery extends QueryField {
                         dimCount++;
                     }
                     const location = fi.f.fieldDef.location;
+                    const annotation = fi.f.fieldDef.annotation;
                     // build out the result fields...
                     switch (fi.f.fieldDef.type) {
                         case 'boolean':
@@ -1774,6 +1775,7 @@ class QueryQuery extends QueryField {
                                 type: fi.f.fieldDef.type,
                                 resultMetadata,
                                 location,
+                                annotation,
                             });
                             break;
                         case 'timestamp': {
@@ -1785,6 +1787,7 @@ class QueryQuery extends QueryField {
                                     timeframe,
                                     resultMetadata,
                                     location,
+                                    annotation,
                                 });
                             }
                             else {
@@ -1793,6 +1796,7 @@ class QueryQuery extends QueryField {
                                     type: 'timestamp',
                                     resultMetadata,
                                     location,
+                                    annotation,
                                 });
                             }
                             break;
@@ -1804,6 +1808,7 @@ class QueryQuery extends QueryField {
                                 timeframe: fi.f.fieldDef.timeframe,
                                 resultMetadata,
                                 location,
+                                annotation,
                             });
                             break;
                         }
@@ -1814,6 +1819,7 @@ class QueryQuery extends QueryField {
                                 type: 'number',
                                 resultMetadata,
                                 location,
+                                annotation,
                             });
                             break;
                         case 'unsupported':
@@ -2423,6 +2429,7 @@ class QueryQuery extends QueryField {
             // console.log(stageWriter.generateSQLStages());
             structDef = pipeOut.outputStruct;
         }
+        structDef.annotation = fi.turtleDef.annotation;
         return {
             structDef,
             pipeOut,
@@ -3151,6 +3158,7 @@ class QueryStruct extends QueryNode {
     flattenTurtleDef(turtleDef) {
         let pipeline = turtleDef.pipeline;
         let pipeHead = turtleDef.pipeHead;
+        const annotation = turtleDef.annotation;
         while (pipeHead) {
             const field = this.getFieldByName(pipeHead.name);
             if (field instanceof QueryQuery) {
@@ -3168,6 +3176,7 @@ class QueryStruct extends QueryNode {
             type: 'turtle',
             name: turtleDef.name,
             pipeline,
+            annotation,
             location: turtleDef.location,
         };
         return flatTurtleDef;
@@ -3299,6 +3308,7 @@ class QueryModel {
                 ? query.pipeHead.name
                 : undefined,
             connectionName: ret.connectionName,
+            annotation: query.annotation,
         };
     }
     async searchIndex(connection, explore, searchValue, limit = 1000, searchField = undefined) {

package/dist/model/malloy_types.d.ts

@@ -265,15 +265,20 @@ interface JustExpression {
     e: Expr;
 }
 declare type HasExpression = FieldDef & JustExpression;
-/**  Grants access to the expression property of a FielfDef */
+/**  Grants access to the expression property of a FieldDef */
 export declare function hasExpression(f: FieldDef): f is HasExpression;
 export declare type TimeFieldType = 'date' | 'timestamp';
 export declare function isTimeFieldType(s: string): s is TimeFieldType;
 export declare type AtomicFieldType = 'string' | 'number' | TimeFieldType | 'boolean' | 'unsupported' | 'json' | 'error';
 export declare function isAtomicFieldType(s: string): s is AtomicFieldType;
-/** All scalars can have an optional expression */
+/**
+ * Fields which contain scalar data all inherit from this. The field
+ * value could be an expression, and this is one of the objects
+ * which might have an annotation.
+ */
 export interface FieldAtomicDef extends NamedObject, Expression, ResultMetadata {
     type: AtomicFieldType;
+    annotation?: Annotation;
 }
 export declare function FieldIsIntrinsic(f: FieldDef): boolean;
 /** Scalar String Field */
@@ -368,6 +373,7 @@ export interface Pipeline {
 export interface Query extends Pipeline, Filtered, HasLocation {
     type?: 'query';
     structRef: StructRef;
+    annotation?: Annotation;
 }
 export declare type NamedQuery = Query & NamedObject;
 export declare type PipeSegment = QuerySegment | IndexSegment;
@@ -412,6 +418,7 @@ export interface QuerySegment extends Filtered {
 }
 export interface TurtleDef extends NamedObject, Pipeline {
     type: 'turtle';
+    annotation?: Annotation;
 }
 export declare type JoinRelationship = 'one_to_one' | 'one_to_many' | 'many_to_one' | 'many_to_many';
 export interface JoinOn {
@@ -482,6 +489,7 @@ export interface StructDef extends NamedObject, ResultStructMetadata, Filtered {
     parameters?: Record<string, Parameter>;
     queryTimezone?: string;
     dialect: string;
+    annotation?: Annotation;
 }
 export declare type ExpressionValueType = AtomicFieldType | 'null' | 'duration' | 'any' | 'regular expression';
 export declare type FieldValueType = ExpressionValueType | 'turtle' | 'struct';
@@ -559,10 +567,17 @@ export interface ModelDef {
     name: string;
     exports: string[];
     contents: Record<string, NamedModelObject>;
+    annotation?: Annotation;
 }
 /** Very common record type */
 export declare type NamedStructDefs = Record<string, StructDef>;
 export declare type NamedModelObjects = Record<string, NamedModelObject>;
+/** Malloy source annotations attached to objects */
+export interface Annotation {
+    inherits?: Annotation;
+    blockNotes?: string[];
+    notes?: string[];
+}
 export declare type QueryScalar = string | boolean | number | Date | Buffer | null;
 /** One value in one column of returned data. */
 export declare type QueryValue = QueryScalar | QueryData | QueryDataRow;
@@ -593,6 +608,8 @@ export interface CompiledQuery extends DrillSource {
     malloy: string;
     queryName?: string | undefined;
     connectionName: string;
+    queryTimezone?: string;
+    annotation?: Annotation;
 }
 /** Result type for running a Malloy query. */
 export interface QueryResult extends CompiledQuery {

package/dist/model/malloy_types.js

@@ -204,7 +204,7 @@ function maxOfExpressionTypes(types) {
     return types.reduce(maxExpressionType, 'scalar');
 }
 exports.maxOfExpressionTypes = maxOfExpressionTypes;
-/**  Grants access to the expression property of a FielfDef */
+/**  Grants access to the expression property of a FieldDef */
 function hasExpression(f) {
     return f.e !== undefined;
 }

package/dist/tags.d.ts

@@ -0,0 +1,21 @@
+import { Annotation } from './model';
+declare type MalloyTagProperties = Record<string, string | boolean>;
+interface PropertyTag {
+    properties: MalloyTagProperties;
+}
+export interface MalloyTags extends PropertyTag {
+    docStrings: string[];
+}
+export interface Taggable {
+    getTags: () => Tags;
+}
+/**
+ * Collection of useful functions for handing tag data ...
+ */
+export declare class Tags {
+    private tags;
+    constructor(annotation: Annotation | undefined);
+    getMalloyTags(): MalloyTags;
+    getTagList(): string[];
+}
+export {};

package/dist/tags.js

@@ -0,0 +1,155 @@
+"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.Tags = void 0;
+function isDocTag(a) {
+    return (a === null || a === void 0 ? void 0 : a.docString) !== undefined;
+}
+/**
+ * Collection of useful functions for handing tag data ...
+ */
+class Tags {
+    constructor(annotation) {
+        this.tags = annotation;
+    }
+    getMalloyTags() {
+        const ret = { docStrings: [], properties: {} };
+        for (const tagLine of tagList(this.tags)) {
+            const tag = parseTag(tagLine, ret.properties);
+            if (isDocTag(tag)) {
+                ret.docStrings.push(tag.docString);
+            }
+        }
+        return ret;
+    }
+    getTagList() {
+        return tagList(this.tags);
+    }
+}
+exports.Tags = Tags;
+function tagList(tagNode) {
+    if (!tagNode) {
+        return [];
+    }
+    return [
+        ...(tagNode.inherits ? tagList(tagNode.inherits) : []),
+        ...(tagNode.blockNotes || []),
+        ...(tagNode.notes || []),
+    ];
+}
+/**
+ * Lines which start '#"' are doc strings
+ * Lines which start '# ' are property lines ... The property parser is
+ * pretty simple, the langauge is:
+ * Property can be
+ *   name       -- set the value to "true"
+ *   -name      -- delete a value from the property
+ *   name=value -- assign value to the name
+ * Name can be any sequence of non space characters, or a string
+ * A value is any sequence of non space characters, or a string
+ * A string is " enclosing and ending in " with \" allowed inside
+ */
+function parseTag(src, tagProp) {
+    if (src.startsWith('#" ')) {
+        return { docString: src.slice(3) };
+    }
+    if (!src.startsWith('# ')) {
+        return;
+    }
+    /*
+     * I went back and forth if the grammar for these annotations should be
+     * in the parser or the lexer. Eventually the fact that the lexer ate
+     * newlines meant I couldn't figure out how to do it in the parser.
+     *
+     * Seems wrong to be writing a parser though.
+     */
+    const tokens = tokenize(src.slice(2));
+    let tn = 0;
+    const lastToken = tokens.length - 1;
+    while (tn <= lastToken) {
+        let token = tokens[tn];
+        if (token === '=') {
+            return undefined;
+        }
+        if (token[0] === '"') {
+            token = token.slice(1, -1);
+        }
+        if (tn !== lastToken && tokens[tn + 1] === '=') {
+            if (tn + 2 <= lastToken) {
+                let value = tokens[tn + 2];
+                if (value !== '=') {
+                    if (value[0] === '"') {
+                        value = value.slice(1, -1);
+                    }
+                    tagProp[token] = value;
+                    tn += 3;
+                    continue;
+                }
+            }
+            return undefined;
+        }
+        if (token.startsWith('-')) {
+            delete tagProp[token.slice(1)];
+        }
+        else {
+            tagProp[token] = true;
+        }
+        tn += 1;
+    }
+    return { properties: tagProp };
+}
+function tokenize(src) {
+    const parts = [];
+    src = src.trim();
+    while (src) {
+        const skipSpace = src.match(/^\s*(.+$)/);
+        if (skipSpace === null) {
+            break;
+        }
+        src = skipSpace[1];
+        if (src[0] === '=') {
+            parts.push('=');
+            src = src.slice(1);
+            continue;
+        }
+        if (src[0] === '"') {
+            const matchString = src.match(/^"(\\"|[^"])*"/);
+            if (!matchString) {
+                break;
+            }
+            parts.push(matchString[0]);
+            src = src.slice(matchString[0].length);
+            continue;
+        }
+        const token = src.match(/^[^\s "=]+/);
+        if (token) {
+            parts.push(token[0]);
+            src = src.slice(token[0].length);
+            continue;
+        }
+        break;
+    }
+    return parts;
+}
+//# sourceMappingURL=tags.js.map

package/package.json

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

package/dist/lang/ast/query-properties/dimmensions.d.ts

@@ -1,5 +0,0 @@
-import { FieldDeclaration } from '../query-items/field-declaration';
-import { DeclareFields } from './declare-fields';
-export declare class Dimensions extends DeclareFields {
-    constructor(dimensions: FieldDeclaration[]);
-}

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

@@ -1,5 +0,0 @@
-import { SourceProperty } from './source-property';
-import { ListOf } from './malloy-element';
-export declare class ExploreDesc extends ListOf<SourceProperty> {
-    constructor(props: SourceProperty[]);
-}