@malloydata/malloy 0.0.239 → 0.0.240-dev250305162504

package/dist/to_stable.d.ts

@@ -1,3 +1,4 @@
 import * as Malloy from '@malloydata/malloy-interfaces';
-import { ModelDef } from './model';
+import { FieldDef, ModelDef, SourceDef } from './model';
 export declare function modelDefToModelInfo(modelDef: ModelDef): Malloy.ModelInfo;
+export declare function convertFieldInfos(source: SourceDef, fields: FieldDef[]): Malloy.FieldInfo[];

package/dist/to_stable.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.modelDefToModelInfo = void 0;
+exports.convertFieldInfos = exports.modelDefToModelInfo = void 0;
 const model_1 = require("./model");
 const malloy_query_1 = require("./model/malloy_query");
+const annotation_1 = require("./annotation");
+const malloy_tag_1 = require("@malloydata/malloy-tag");
 function modelDefToModelInfo(modelDef) {
     const modelInfo = {
         entries: [],
@@ -23,37 +25,74 @@ function modelDefToModelInfo(modelDef) {
         }
         else if (entry.type === 'query') {
             const outputStruct = (0, malloy_query_1.getResultStructDefForQuery)(modelDef, entry);
+            const annotations = getAnnotationsFromField(entry);
+            const resultMetadataAnnotation = outputStruct.resultMetadata
+                ? getResultStructMetadataAnnotation(outputStruct, outputStruct.resultMetadata)
+                : undefined;
+            const fieldAnnotations = [
+                ...(annotations !== null && annotations !== void 0 ? annotations : []),
+                ...(resultMetadataAnnotation ? [resultMetadataAnnotation] : []),
+            ];
             const queryInfo = {
                 kind: 'source',
                 name,
                 schema: {
                     fields: convertFieldInfos(outputStruct, outputStruct.fields),
                 },
+                annotations: fieldAnnotations.length > 0 ? fieldAnnotations : undefined,
             };
             modelInfo.entries.push(queryInfo);
         }
     }
     for (const query of modelDef.queryList) {
         const outputStruct = (0, malloy_query_1.getResultStructDefForQuery)(modelDef, query);
+        const annotations = getAnnotationsFromField(query);
+        const resultMetadataAnnotation = outputStruct.resultMetadata
+            ? getResultStructMetadataAnnotation(outputStruct, outputStruct.resultMetadata)
+            : undefined;
+        const fieldAnnotations = [
+            ...(annotations !== null && annotations !== void 0 ? annotations : []),
+            ...(resultMetadataAnnotation ? [resultMetadataAnnotation] : []),
+        ];
         const queryInfo = {
             schema: {
                 fields: convertFieldInfos(outputStruct, outputStruct.fields),
             },
+            annotations: fieldAnnotations.length > 0 ? fieldAnnotations : undefined,
         };
         modelInfo.anonymous_queries.push(queryInfo);
     }
     return modelInfo;
 }
 exports.modelDefToModelInfo = modelDefToModelInfo;
+function getAnnotationsFromField(field) {
+    const taglines = (0, annotation_1.annotationToTaglines)(field.annotation);
+    return taglines.map(tagline => ({
+        value: tagline,
+    }));
+}
 function convertFieldInfos(source, fields) {
     var _a, _b, _c;
     const result = [];
     for (const field of fields) {
+        const taglines = (0, annotation_1.annotationToTaglines)(field.annotation);
+        const rawAnnotations = taglines.map(tagline => ({
+            value: tagline,
+        }));
+        const annotations = rawAnnotations.length > 0 ? rawAnnotations : undefined;
         if ((0, model_1.isTurtle)(field)) {
             const outputStruct = (0, malloy_query_1.getResultStructDefForView)(source, field);
+            const resultMetadataAnnotation = outputStruct.resultMetadata
+                ? getResultStructMetadataAnnotation(outputStruct, outputStruct.resultMetadata)
+                : undefined;
+            const fieldAnnotations = [
+                ...(annotations !== null && annotations !== void 0 ? annotations : []),
+                ...(resultMetadataAnnotation ? [resultMetadataAnnotation] : []),
+            ];
             const fieldInfo = {
                 kind: 'view',
                 name: (_a = field.as) !== null && _a !== void 0 ? _a : field.name,
+                annotations: fieldAnnotations.length > 0 ? fieldAnnotations : undefined,
                 schema: { fields: convertFieldInfos(outputStruct, outputStruct.fields) },
             };
             result.push(fieldInfo);
@@ -65,10 +104,18 @@ function convertFieldInfos(source, fields) {
                 continue;
             if (field.type === 'error')
                 continue;
+            const resultMetadataAnnotation = field.resultMetadata
+                ? getResultMetadataAnnotation(field, field.resultMetadata)
+                : undefined;
+            const fieldAnnotations = [
+                ...(annotations !== null && annotations !== void 0 ? annotations : []),
+                ...(resultMetadataAnnotation ? [resultMetadataAnnotation] : []),
+            ];
             const fieldInfo = {
                 kind: aggregate ? 'measure' : 'dimension',
                 name: (_b = field.as) !== null && _b !== void 0 ? _b : field.name,
                 type: typeDefToType(field),
+                annotations: fieldAnnotations.length > 0 ? fieldAnnotations : undefined,
             };
             result.push(fieldInfo);
         }
@@ -76,6 +123,7 @@ function convertFieldInfos(source, fields) {
             const fieldInfo = {
                 kind: 'join',
                 name: (_c = field.as) !== null && _c !== void 0 ? _c : field.name,
+                annotations,
                 schema: {
                     fields: convertFieldInfos(field, field.fields),
                 },
@@ -86,6 +134,60 @@ function convertFieldInfos(source, fields) {
     }
     return result;
 }
+exports.convertFieldInfos = convertFieldInfos;
+function getResultMetadataAnnotation(field, resultMetadata) {
+    const tag = malloy_tag_1.Tag.withPrefix('#(malloy) ');
+    let hasAny = false;
+    if (resultMetadata.referenceId !== undefined) {
+        tag.set(['reference_id'], resultMetadata.referenceId);
+        hasAny = true;
+    }
+    if (resultMetadata.fieldKind === 'measure') {
+        tag.set(['calculation']);
+        hasAny = true;
+    }
+    if (resultMetadata.fieldKind === 'dimension') {
+        const dot = '.';
+        // If field is joined-in from another table i.e. of type `tableName.columnName`,
+        // return sourceField, else return name because this could be a renamed field.
+        const drillExpression = (resultMetadata === null || resultMetadata === void 0 ? void 0 : resultMetadata.sourceExpression) ||
+            ((resultMetadata === null || resultMetadata === void 0 ? void 0 : resultMetadata.sourceField.includes(dot))
+                ? resultMetadata === null || resultMetadata === void 0 ? void 0 : resultMetadata.sourceField
+                : field.name);
+        tag.set(['drill_expression'], drillExpression);
+        hasAny = true;
+    }
+    return hasAny
+        ? {
+            value: tag.toString(),
+        }
+        : undefined;
+}
+function getResultStructMetadataAnnotation(field, resultMetadata) {
+    var _a, _b;
+    const tag = malloy_tag_1.Tag.withPrefix('#(malloy) ');
+    let hasAny = false;
+    if (resultMetadata.limit !== undefined) {
+        tag.set(['limit'], resultMetadata.limit);
+        hasAny = true;
+    }
+    if (resultMetadata.orderBy) {
+        for (let i = 0; i < resultMetadata.orderBy.length; i++) {
+            const orderBy = resultMetadata.orderBy[i];
+            const orderByField = typeof orderBy.field === 'number'
+                ? (_a = field.fields[orderBy.field].as) !== null && _a !== void 0 ? _a : field.fields[orderBy.field].name
+                : orderBy.field;
+            const direction = (_b = orderBy.dir) !== null && _b !== void 0 ? _b : null;
+            tag.set(['ordered_by', i, orderByField], direction);
+        }
+        hasAny = true;
+    }
+    return hasAny
+        ? {
+            value: tag.toString(),
+        }
+        : undefined;
+}
 function typeDefToType(field) {
     if ((0, model_1.isLeafAtomic)(field)) {
         switch (field.type) {
@@ -102,11 +204,21 @@ function typeDefToType(field) {
                 };
             case 'boolean':
                 return { kind: 'boolean_type' };
-            case 'date':
+            case 'date': {
+                // TODO there seems to be a bug where date literals with a timestamp truncation have
+                // type: date, but still have a timestamp truncation.
+                const timeframe = field.timeframe;
+                if (timeframe && !isDateTimeframe(timeframe)) {
+                    return {
+                        kind: 'timestamp_type',
+                        timeframe: convertTimestampTimeframe(field.timeframe),
+                    };
+                }
                 return {
                     kind: 'date_type',
                     timeframe: convertDateTimeframe(field.timeframe),
                 };
+            }
             case 'timestamp':
                 return {
                     kind: 'timestamp_type',
@@ -144,9 +256,25 @@ function convertRecordType(field) {
     return {
         kind: 'record_type',
         fields: field.fields.map(f => {
+            const annotations = [];
+            if ('resultMetadata' in f) {
+                if (f.resultMetadata) {
+                    const ann = getResultMetadataAnnotation(f, f.resultMetadata);
+                    if (ann) {
+                        annotations.push(ann);
+                    }
+                }
+            }
+            if (f.annotation) {
+                const taglines = (0, annotation_1.annotationToTaglines)(f.annotation);
+                annotations.push(...taglines.map(tagline => ({
+                    value: tagline,
+                })));
+            }
             if ((0, model_1.isAtomic)(f)) {
                 return {
                     name: f.name,
+                    annotations: annotations.length > 0 ? annotations : undefined,
                     type: typeDefToType(f),
                 };
             }
@@ -156,6 +284,18 @@ function convertRecordType(field) {
         }),
     };
 }
+function isDateTimeframe(timeframe) {
+    switch (timeframe) {
+        case 'day':
+        case 'week':
+        case 'month':
+        case 'year':
+        case 'quarter':
+            return true;
+        default:
+            return false;
+    }
+}
 function convertDateTimeframe(timeframe) {
     switch (timeframe) {
         case undefined:
@@ -167,7 +307,7 @@ function convertDateTimeframe(timeframe) {
         case 'quarter':
             return timeframe;
         default:
-            throw new Error('Invalid date timeframe');
+            throw new Error(`Invalid date timeframe ${timeframe}`);
     }
 }
 function convertTimestampTimeframe(timeframe) {

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const MALLOY_VERSION = "0.0.239";
+export declare const MALLOY_VERSION = "0.0.240";

package/dist/version.js

@@ -2,5 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MALLOY_VERSION = void 0;
 // generated with 'generate-version-file' script; do not edit manually
-exports.MALLOY_VERSION = '0.0.239';
+exports.MALLOY_VERSION = '0.0.240';
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@malloydata/malloy",
-  "version": "0.0.239",
+  "version": "0.0.240-dev250305162504",
   "license": "MIT",
   "exports": {
     ".": "./dist/index.js",
@@ -41,8 +41,8 @@
     "generate-version-file": "VERSION=$(npm pkg get version --workspaces=false | tr -d \\\")\necho \"// generated with 'generate-version-file' script; do not edit manually\\nexport const MALLOY_VERSION = '$VERSION';\" > src/version.ts"
   },
   "dependencies": {
-    "@malloydata/malloy-interfaces": "^0.0.239",
-    "@malloydata/malloy-tag": "^0.0.239",
+    "@malloydata/malloy-interfaces": "^0.0.240-dev250305162504",
+    "@malloydata/malloy-tag": "^0.0.240-dev250305162504",
     "antlr4ts": "^0.5.0-alpha.4",
     "assert": "^2.0.0",
     "jest-diff": "^29.6.2",