@malloydata/malloy 0.0.399 → 0.0.400

package/dist/model/query_query.js

@@ -403,9 +403,9 @@ class QueryQuery extends query_node_1.QueryField {
                         join: 'many',
                         name,
                         fields: structDef.fields,
-                        ...(structDef.annotation && { annotation: structDef.annotation }),
-                        ...(structDef.modelAnnotation && {
-                            modelAnnotation: structDef.modelAnnotation,
+                        ...(structDef.annotations && { annotations: structDef.annotations }),
+                        ...(structDef.modelAnnotations && {
+                            modelAnnotations: structDef.modelAnnotations,
                         }),
                         resultMetadata,
                         ...(queryTimezone && { queryTimezone }),
@@ -418,9 +418,9 @@ class QueryQuery extends query_node_1.QueryField {
                         join: 'one',
                         name,
                         fields: structDef.fields,
-                        ...(structDef.annotation && { annotation: structDef.annotation }),
-                        ...(structDef.modelAnnotation && {
-                            modelAnnotation: structDef.modelAnnotation,
+                        ...(structDef.annotations && { annotations: structDef.annotations }),
+                        ...(structDef.modelAnnotations && {
+                            modelAnnotations: structDef.modelAnnotations,
                         }),
                         resultMetadata,
                         ...(queryTimezone && { queryTimezone }),
@@ -451,11 +451,11 @@ class QueryQuery extends query_node_1.QueryField {
                         delete fOut.expressionType;
                     }
                     const location = fOut.location;
-                    const annotation = fOut.annotation;
+                    const annotations = fOut.annotations;
                     const common = {
                         resultMetadata,
                         location,
-                        annotation,
+                        annotations,
                     };
                     // build out the result fields...
                     switch (fOut.type) {
@@ -513,8 +513,8 @@ class QueryQuery extends query_node_1.QueryField {
             resultMetadata: this.getResultMetadata(this.rootResult),
             queryTimezone: resultStruct.getQueryInfo().queryTimezone,
         };
-        if (this.parent.structDef.modelAnnotation) {
-            outputStruct.modelAnnotation = this.parent.structDef.modelAnnotation;
+        if (this.parent.structDef.modelAnnotations) {
+            outputStruct.modelAnnotations = this.parent.structDef.modelAnnotations;
         }
         return outputStruct;
     }
@@ -1546,7 +1546,7 @@ class QueryQuery extends query_node_1.QueryField {
             // console.log(stageWriter.generateSQLStages());
             structDef = pipeOut.outputStruct;
         }
-        structDef.annotation = fi.turtleDef.annotation;
+        structDef.annotations = fi.turtleDef.annotations;
         return {
             structDef,
             pipeOut,
@@ -1821,8 +1821,8 @@ class QueryQueryIndex extends QueryQuery {
             ],
             connection: this.parent.connectionName,
         };
-        if (this.parent.structDef.modelAnnotation) {
-            ret.modelAnnotation = this.parent.structDef.modelAnnotation;
+        if (this.parent.structDef.modelAnnotations) {
+            ret.modelAnnotations = this.parent.structDef.modelAnnotations;
         }
         return ret;
     }

package/dist/model/source_def_utils.js

@@ -44,8 +44,8 @@ function mkQuerySourceDef(base, query, name) {
         // HasLocation
         location: base.location,
         // StructDefBase
-        annotation: base.annotation,
-        modelAnnotation: base.modelAnnotation,
+        annotations: base.annotations,
+        modelAnnotations: base.modelAnnotations,
         fields: base.fields,
         // Filtered
         filterList: base.filterList,
@@ -83,8 +83,8 @@ function mkSQLSourceDef(base, selectStr, selectSegments) {
         // HasLocation
         location: base.location,
         // StructDefBase
-        annotation: base.annotation,
-        modelAnnotation: base.modelAnnotation,
+        annotations: base.annotations,
+        modelAnnotations: base.modelAnnotations,
         fields: base.fields,
         // Filtered
         filterList: base.filterList,

package/dist/run_sql_options.d.ts

@@ -1,13 +1,15 @@
-import type { Annotation, NamedObject, SourceComponentInfo } from './model/malloy_types';
+import type { AnnotationsDef, NamedObject, SourceComponentInfo } from './model/malloy_types';
 type SourceRefWithMetadata = NamedObject & {
-    annotation?: Annotation;
+    annotations?: AnnotationsDef;
     sourceComponentInfos?: SourceComponentInfo[];
 };
 export interface RunSQLOptions {
     rowLimit?: number;
     abortSignal?: AbortSignal;
-    modelAnnotation?: Annotation;
-    queryAnnotation?: Annotation;
+    /** Model annotations forwarded to the adapter (e.g. `##!` dialect flags). */
+    modelAnnotations?: AnnotationsDef;
+    /** Query annotations forwarded to the adapter. */
+    queryAnnotations?: AnnotationsDef;
     clientMetadata?: {
         sourceRefWithMetadata?: SourceRefWithMetadata;
     };

package/dist/to_stable.d.ts

@@ -1,5 +1,5 @@
 import * as Malloy from '@malloydata/malloy-interfaces';
-import type { Annotation, FieldDef, ModelDef, ResultStructMetadataDef, SourceDef } from './model';
+import type { AnnotationsDef, FieldDef, ModelDef, ResultStructMetadataDef, SourceDef } from './model';
 import { Tag } from '@malloydata/malloy-tag';
 export declare function sourceDefToSourceInfo(sourceDef: SourceDef): Malloy.SourceInfo;
 export declare function modelDefToModelInfo(modelDef: ModelDef): Malloy.ModelInfo;
@@ -8,7 +8,7 @@ export declare function modelDefToModelInfo(modelDef: ModelDef): Malloy.ModelInf
  * and the api surfaces. The stable shape carries the raw annotation strings;
  * routes are derivable at the consumer via `parsePrefix` (`./prefix.ts`).
  */
-export declare function toStableAnnotations(annot: Annotation | undefined): Malloy.Annotation[];
+export declare function toStableAnnotations(annot: AnnotationsDef | undefined): Malloy.Annotation[];
 export declare function convertFieldInfos(source: SourceDef, fields: FieldDef[]): Malloy.FieldInfo[];
 export declare function writeLiteralToTag(tag: Tag, path: (string | number)[], literal: Malloy.LiteralValue): void;
 export declare function getResultStructMetadataAnnotation(field: SourceDef, resultMetadata: ResultStructMetadataDef): Malloy.Annotation | undefined;

package/dist/to_stable.js

@@ -47,7 +47,7 @@ exports.writeLiteralToTag = writeLiteralToTag;
 exports.getResultStructMetadataAnnotation = getResultStructMetadataAnnotation;
 const Malloy = __importStar(require("@malloydata/malloy-interfaces"));
 const model_1 = require("./model");
-const annotation_1 = require("./annotation");
+const annotation_1 = require("./api/foundation/annotation");
 const malloy_tag_1 = require("@malloydata/malloy-tag");
 function sourceDefToSourceInfo(sourceDef) {
     var _a;
@@ -78,7 +78,7 @@ function sourceDefToSourceInfo(sourceDef) {
             fields: convertFieldInfos(sourceDef, sourceDef.fields),
         },
         parameters,
-        annotations: toStableAnnotations(sourceDef.annotation),
+        annotations: toStableAnnotations(sourceDef.annotations),
     };
     return sourceInfo;
 }
@@ -99,7 +99,7 @@ function modelDefToModelInfo(modelDef) {
         }
         else if (entry.type === 'query') {
             const outputStruct = (0, model_1.getResultStructDefForQuery)(modelDef, entry);
-            const annotations = toStableAnnotations(entry.annotation);
+            const annotations = toStableAnnotations(entry.annotations);
             const resultMetadataAnnotation = outputStruct.resultMetadata
                 ? getResultStructMetadataAnnotation(outputStruct, outputStruct.resultMetadata)
                 : undefined;
@@ -120,7 +120,7 @@ function modelDefToModelInfo(modelDef) {
     }
     for (const query of modelDef.queryList) {
         const outputStruct = (0, model_1.getResultStructDefForQuery)(modelDef, query);
-        const annotations = toStableAnnotations(query.annotation);
+        const annotations = toStableAnnotations(query.annotations);
         const resultMetadataAnnotation = outputStruct.resultMetadata
             ? getResultStructMetadataAnnotation(outputStruct, outputStruct.resultMetadata)
             : undefined;
@@ -189,7 +189,7 @@ function convertFieldInfos(source, fields) {
         const isPublic = field.accessModifier === undefined;
         if (!isPublic)
             continue;
-        const rawAnnotations = toStableAnnotations(field.annotation);
+        const rawAnnotations = toStableAnnotations(field.annotations);
         const annotations = rawAnnotations.length > 0 ? rawAnnotations : undefined;
         if ((0, model_1.isTurtle)(field)) {
             const outputStruct = (0, model_1.getResultStructDefForView)(source, field);
@@ -451,8 +451,8 @@ function convertRecordType(field) {
                     }
                 }
             }
-            if (f.annotation) {
-                annotations.push(...toStableAnnotations(f.annotation));
+            if (f.annotations) {
+                annotations.push(...toStableAnnotations(f.annotations));
             }
             if ((0, model_1.isAtomic)(f)) {
                 return {

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const MALLOY_VERSION = "0.0.399";
+export declare const MALLOY_VERSION = "0.0.400";

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.399';
+exports.MALLOY_VERSION = '0.0.400';
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@malloydata/malloy",
-  "version": "0.0.399",
+  "version": "0.0.400",
   "license": "MIT",
   "exports": {
     ".": "./dist/index.js",
@@ -51,9 +51,9 @@
     "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-filter": "0.0.399",
-    "@malloydata/malloy-interfaces": "0.0.399",
-    "@malloydata/malloy-tag": "0.0.399",
+    "@malloydata/malloy-filter": "0.0.400",
+    "@malloydata/malloy-interfaces": "0.0.400",
+    "@malloydata/malloy-tag": "0.0.400",
     "@noble/hashes": "^1.8.0",
     "antlr4ts": "^0.5.0-alpha.4",
     "assert": "^2.0.0",

package/dist/annotation.d.ts

@@ -1,96 +0,0 @@
-import type { Tag } from '@malloydata/malloy-tag';
-import type { Annotation, DocumentLocation } from './model';
-import type { LogMessage } from './lang';
-/**
- * @deprecated Argument shape for the deprecated RegExp form of
- * {@link annotationToTag}. The RegExp form cannot see block annotations
- * (`#|`…`|#`). Pass a route string to `annotationToTag` instead, or use the
- * {@link Annotations} view on a tagged entity.
- */
-export interface TagParseSpec {
-    prefix?: RegExp;
-}
-/** One annotation, unparsed — its raw text and where its content begins. */
-export interface AnnotationText {
-    /** The annotation exactly as written — prefix + content. */
-    rawText: string;
-    /** Offset where the content begins; `rawText.slice(contentIndex)` is the content. */
-    contentIndex: number;
-    /** Where `rawText` begins in the source document. */
-    at: DocumentLocation;
-    /**
-     * For block annotations: characters of leading whitespace removed from
-     * each body line by the translator's dedent pass. A BYO parser that wants
-     * source-mapped error columns adds this to the parser's reported column for
-     * body lines (`source_col = indentStripped + parser_col`).
-     */
-    indentStripped?: number;
-}
-/** An {@link AnnotationText} that also carries its route (`''` is MOTLY). */
-export interface RoutedAnnotation extends AnnotationText {
-    route: string;
-}
-/**
- * Collect annotations, using the shared prefix parser.
- * - no `route`: every annotation, each carrying its own `route` (the only way
- *   to reach one whose prefix is malformed).
- * - a `route`: only annotations on that route, `route` omitted from each result
- *   (you passed it); malformed prefixes excluded.
- */
-export declare function collectAnnotations(annote: Annotation | undefined): RoutedAnnotation[];
-export declare function collectAnnotations(annote: Annotation | undefined, route: string): AnnotationText[];
-/**
- * @deprecated The RegExp form cannot see block annotations (`#|`…`|#`). Use
- * `new Annotations(annote).texts(route)` instead, or the {@link Annotations}
- * view on a tagged entity (`entity.annotations.texts(route)`).
- */
-export declare function annotationToTaglines(annote: Annotation | undefined, prefix?: RegExp): string[];
-export interface MalloyTagParse {
-    tag: Tag;
-    log: LogMessage[];
-}
-/** Parse the annotations on `route` (default `''`, the MOTLY tag route) as MOTLY. */
-export declare function annotationToTag(annote: Annotation | undefined, route?: string): MalloyTagParse;
-/**
- * @deprecated The RegExp `prefix` form cannot see block annotations
- * (`#|`…`|#`) and cannot report content offsets for error mapping. Pass a route
- * string (the other overload), or use {@link Annotations.parseAsTag} on a
- * tagged entity.
- */
-export declare function annotationToTag(annote: Annotation | undefined, spec?: TagParseSpec): MalloyTagParse;
-/**
- * The route-aware annotation API for a tagged entity.
- *
- * An annotation has a *prefix* (everything from `#`/`##` up to the first
- * whitespace) that resolves to a *route* — a namespace key. Built-in routes:
- * `''` (MOTLY tags, the human default), `!` (compiler flags), `@` (persistence
- * directives), `"` (doc-string markdown). Apps stake their own routes with
- * brackets: `#(myApp) ...` is route `myApp`. The grammar (forms, bracket
- * pairs, malformation warnings) lives in `./prefix.ts`.
- *
- * All annotation reading lives here, written once; each tagged class only has
- * to say *where* its annotation is (by handing it to the constructor). Unlike
- * the deprecated RegExp readers (`tagParse`/`getTaglines`), this sees block
- * annotations.
- */
-export declare class Annotations {
-    private readonly annote;
-    constructor(annote: Annotation | undefined);
-    /**
-     * Raw annotation text strings (prefix + content) — all routes if `route` is
-     * omitted, just that route's otherwise. The route-based successor to the
-     * deprecated `getTaglines`. For source-mapped offsets (bring-your-own
-     * parsers), see {@link forRoute}.
-     */
-    texts(route?: string): string[];
-    /**
-     * Your route's annotations as objects (`rawText` + `contentIndex` + `at`) —
-     * the bring-your-own-parser door. A non-MOTLY app (e.g. JSON on its own
-     * route) reads these to slice the content (`rawText.slice(contentIndex)`)
-     * itself and map its parser's errors back to source via `at`. Malformed-prefix
-     * annotations are excluded.
-     */
-    forRoute(route: string): AnnotationText[];
-    /** Parse a route's annotations as a MOTLY tag. Default `''` is the tag route. */
-    parseAsTag(route?: string): MalloyTagParse;
-}