@malloydata/malloy 0.0.404 → 0.0.405

package/LICENSE

@@ -0,0 +1,77 @@
+Malloy Project License
+SPDX-License-Identifier: MIT
+
+Copyright Contributors to the Malloy project
+
+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.
+
+========================================================================
+SOURCE FILE HEADER
+========================================================================
+
+Every source file in this project carries the following header (shown here
+in C/Java/JavaScript comment style; equivalent comment styles are used for
+other languages):
+
+/*
+ * Copyright Contributors to the Malloy project
+ * SPDX-License-Identifier: MIT
+ */
+
+========================================================================
+HISTORICAL ATTRIBUTIONS & NOTICES
+========================================================================
+
+Portions of this software were originally contributed by Google LLC and
+Meta Platforms, Inc. and affiliates under the MIT License. For ease of
+maintenance, individual file headers have been updated to the current
+standard header. The full historical attribution and authorship for
+individual files remains completely preserved and accessible via the Git
+repository history.
+
+The original copyright and permission notices for those contributions
+are preserved below:
+
+------------------------------------------------------------------------
+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.
+------------------------------------------------------------------------
+Copyright (c) Meta Platforms, Inc. and affiliates.
+
+This source code is licensed under the MIT license found in the
+LICENSE file in the root directory of this source tree.
+------------------------------------------------------------------------

package/dist/api/asynchronous.js

@@ -1,9 +1,7 @@
 "use strict";
 /*
- * Copyright (c) Meta Platforms, Inc. and affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
+ * Copyright Contributors to the Malloy project
+ * SPDX-License-Identifier: MIT
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;

package/dist/api/connection.js

@@ -1,9 +1,7 @@
 "use strict";
 /*
- * Copyright (c) Meta Platforms, Inc. and affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
+ * Copyright Contributors to the Malloy project
+ * SPDX-License-Identifier: MIT
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=connection.js.map

package/dist/api/core.js

@@ -1,9 +1,7 @@
 "use strict";
 /*
- * Copyright (c) Meta Platforms, Inc. and affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
+ * Copyright Contributors to the Malloy project
+ * SPDX-License-Identifier: MIT
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -52,6 +50,7 @@ exports.hasErrors = hasErrors;
 exports.newCompileQueryState = newCompileQueryState;
 exports.statedCompileQuery = statedCompileQuery;
 const Malloy = __importStar(require("@malloydata/malloy-interfaces"));
+const uuid_1 = require("uuid");
 const lang_1 = require("../lang");
 const model_1 = require("../model");
 const to_stable_1 = require("../to_stable");
@@ -457,7 +456,7 @@ function newCompileQueryState(request) {
     const needs = {
         ...((_b = request.compiler_needs) !== null && _b !== void 0 ? _b : {}),
     };
-    const queryURL = 'internal://query.malloy';
+    const queryURL = `internal://query/${(0, uuid_1.v4)()}`;
     needs.files = [
         {
             url: queryURL,
@@ -505,7 +504,7 @@ function statedCompileQuery(state) {
                 defaultRowLimit: state.defaultRowLimit,
             });
             timer.contribute([sqlTimer.stop()]);
-            const modelAnnotations = (0, to_stable_1.toStableAnnotations)(result.modelDef.annotations);
+            const modelAnnotations = (0, to_stable_1.toStableAnnotations)((0, model_1.getModelAnnotations)(result.modelDef));
             let source;
             if (query.compositeResolvedSourceDef) {
                 source = query.compositeResolvedSourceDef;

package/dist/api/foundation/annotation.js

@@ -9,6 +9,7 @@ exports.collectAnnotations = collectAnnotations;
 exports.annotationToTaglines = annotationToTaglines;
 exports.annotationToTag = annotationToTag;
 const malloy_tag_1 = require("@malloydata/malloy-tag");
+const annotation_utils_1 = require("../../model/annotation_utils");
 const annotation_prefix_1 = require("../../lang/annotation-prefix");
 /**
  * One annotation, returned by {@link Annotations.forRoute} — wraps an IR
@@ -56,15 +57,6 @@ class RoutedNote {
     }
 }
 exports.RoutedNote = RoutedNote;
-/** Every Note of an annotation, inherited first, in document order. */
-function* notesInOrder(annote) {
-    if (annote.inherits)
-        yield* notesInOrder(annote.inherits);
-    if (annote.blockNotes)
-        yield* annote.blockNotes;
-    if (annote.notes)
-        yield* annote.notes;
-}
 /**
  * Collect annotations, using the shared prefix parser.
  * - no `route`: every annotation, each carrying its own `route` (the only
@@ -73,7 +65,7 @@ function* notesInOrder(annote) {
  */
 function collectAnnotations(annote, route) {
     const matching = [];
-    for (const note of notesInOrder(annote !== null && annote !== void 0 ? annote : {})) {
+    for (const note of (0, annotation_utils_1.notesInOrder)(annote !== null && annote !== void 0 ? annote : {})) {
         const parsed = (0, annotation_prefix_1.parsePrefix)(note.text);
         if (route === undefined) {
             matching.push(new RoutedNote(note, parsed.route, parsed.contentIndex));
@@ -92,7 +84,7 @@ function collectAnnotations(annote, route) {
  * @deprecated RegExp prefix matching; use {@link collectAnnotations} with a route.
  */
 function collectNotes(annote, prefix) {
-    const notes = [...notesInOrder(annote)];
+    const notes = [...(0, annotation_utils_1.notesInOrder)(annote)];
     return prefix ? notes.filter(note => note.text.match(prefix)) : notes;
 }
 /**

package/dist/api/foundation/compile.js

@@ -12,9 +12,19 @@ const sql_block_1 = require("../../model/sql_block");
 const version_1 = require("../../version");
 const readers_1 = require("./readers");
 const document_1 = require("./document");
+const uuid_1 = require("uuid");
 const core_1 = require("./core");
 const result_1 = require("./result");
-const MALLOY_INTERNAL_URL = 'internal://internal.malloy';
+/**
+ * Mint the synthetic URL for an inline (URL-less) compile. Each call is
+ * unique, so two inline models — or an inline base and its inline extension —
+ * never collide on identity. Stays under the `internal://` scheme so it
+ * remains uncacheable (see `isInternalURL`). The `method` segment is a
+ * diagnostic label only.
+ */
+function mkInternalURL(method = 'loadModel') {
+    return `internal://${method}/${(0, uuid_1.v4)()}`;
+}
 // =============================================================================
 // Helper Functions
 // =============================================================================
@@ -69,7 +79,7 @@ class Malloy {
     static _parse(source, url, eventStream, options, invalidationKey) {
         var _a;
         if (url === undefined) {
-            url = new URL(MALLOY_INTERNAL_URL);
+            url = new URL(mkInternalURL(options === null || options === void 0 ? void 0 : options.method));
         }
         let importBaseURL = url;
         if (options === null || options === void 0 ? void 0 : options.importBaseURL) {
@@ -111,7 +121,7 @@ class Malloy {
     static async compile(req) {
         var _a, _b, _c, _d, _e;
         let { url, source, importBaseURL, cacheManager } = req;
-        const { parse, urlReader, connections, model, refreshSchemaCache, noThrowOnError, eventStream, restrictedMode, } = req;
+        const { parse, urlReader, connections, model, refreshSchemaCache, noThrowOnError, eventStream, restrictedMode, method, } = req;
         if (restrictedMode) {
             // Restricted-mode compiles do not participate in the model-def
             // cache. The cache key is the URL, but restricted vs. unrestricted
@@ -136,7 +146,7 @@ class Malloy {
                 url = new URL(parse._translator.sourceURL);
             }
             else {
-                url = new URL(MALLOY_INTERNAL_URL);
+                url = new URL(mkInternalURL(method));
             }
         }
         const invalidationKeys = {};
@@ -250,7 +260,6 @@ class Malloy {
                         }
                     }
                 }
-                const { modelAnnotations } = 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();
@@ -273,7 +282,6 @@ class Malloy {
                             //      the translator runs into an infinite loop fetching tables.
                             const { schemas: tables, errors } = await Malloy.safelyFetchTableSchema(connection, tablePathByKey, {
                                 refreshTimestamp,
-                                modelAnnotations,
                             });
                             translator.update({ tables, errors: { tables: errors } });
                         }
@@ -318,7 +326,6 @@ class Malloy {
                         const conn = await connections.lookupConnection(connectionName);
                         const resolved = await conn.fetchSchemaForSQLStruct(toCompile, {
                             refreshTimestamp,
-                            modelAnnotations,
                         });
                         if (resolved.error) {
                             translator.update({
@@ -416,7 +423,7 @@ class Malloy {
         let sql;
         let resultExplore;
         if (sqlStruct) {
-            resultExplore = new core_1.Explore(sqlStruct);
+            resultExplore = new core_1.Explore((0, core_1.pseudoModelFor)(sqlStruct), sqlStruct);
             sql = sqlStruct.selectStr;
         }
         else if (preparedResult !== undefined) {

package/dist/api/foundation/core.d.ts

@@ -1,5 +1,5 @@
 import type { LogMessage } from '../../lang';
-import type { BuildID, CompiledQuery, ConstantExpr, DocumentLocation, BooleanFieldDef, JSONFieldDef, NumberFieldDef, StringFieldDef, FilterCondition, Given as InternalGiven, GivenID, GivenTypeDef, Query as InternalQuery, Pipeline, ModelDef, DocumentPosition as ModelDocumentPosition, NamedQueryDef, StructDef, TurtleDef, NativeUnsupportedFieldDef, ImportLocation, AnnotationsDef, NamedModelObject, AtomicFieldDef, DateFieldDef, ATimestampFieldDef, SourceDef, Argument, SourceComponentInfo, DocumentReference, PersistableSourceDef } from '../../model';
+import type { BuildID, CompiledQuery, ConstantExpr, DocumentLocation, BooleanFieldDef, JSONFieldDef, NumberFieldDef, StringFieldDef, FilterCondition, Given as InternalGiven, GivenID, GivenTypeDef, Query as InternalQuery, Pipeline, ModelDef, DocumentPosition as ModelDocumentPosition, NamedQueryDef, StructDef, TurtleDef, NativeUnsupportedFieldDef, ImportLocation, AnnotationsDef, ModelAnnotationEntry, ModelID, NamedModelObject, AtomicFieldDef, DateFieldDef, ATimestampFieldDef, SourceDef, Argument, SourceComponentInfo, DocumentReference, PersistableSourceDef } from '../../model';
 import { QueryModel } from '../../model';
 import type { Dialect } from '../../dialect';
 import type { BuildGraph, CompileQueryOptions } from './types';
@@ -8,6 +8,7 @@ import type { MalloyTagParse, TagParseSpec } from './annotation';
 import { Annotations } from './annotation';
 import type * as Malloy from '@malloydata/malloy-interfaces';
 import type { Taggable } from './taggable';
+export declare function pseudoModelFor(structDef: StructDef, modelID?: ModelID, modelAnnotations?: Record<ModelID, ModelAnnotationEntry>): ModelDef;
 declare abstract class Entity {
     private readonly _name;
     protected readonly _parent?: Explore;
@@ -79,6 +80,10 @@ export declare enum JoinRelationship {
 export type Field = AtomicField | QueryField | ExploreField;
 export type SerializedExplore = {
     _structDef: StructDef;
+    /** Owner model id + annotation closure, so a deserialized Explore folds
+     *  model annotations as the live one did. */
+    modelID: ModelID;
+    modelAnnotations: Record<ModelID, ModelAnnotationEntry>;
     sourceExplore?: SerializedExplore;
     _parentExplore?: SerializedExplore;
 };
@@ -103,10 +108,16 @@ interface ModelQueries {
 export declare class Explore extends Entity implements Taggable {
     protected readonly _structDef: StructDef;
     protected readonly _parentExplore?: Explore;
+    private readonly _ownerModelDef;
     private _fieldMap;
     private sourceExplore;
     private _allFieldsWithOrder;
-    constructor(structDef: StructDef, parentExplore?: Explore, source?: Explore);
+    constructor(modelDef: ModelDef, structDef: StructDef, parentExplore?: Explore, source?: Explore);
+    /** The model this Explore was resolved in. For detached Explores
+     *  (`fromJSON`, raw SQL block) this is a synthetic single-source model
+     *  with no model annotations. Read by child fields to resolve their own
+     *  model annotations. */
+    get _modelDef(): ModelDef;
     get source(): Explore | undefined;
     isIntrinsic(): boolean;
     isExploreField(): this is ExploreField;
@@ -115,14 +126,18 @@ export declare class Explore extends Entity implements Taggable {
     /** @deprecated Use `.annotations.texts(route)`. */
     getTaglines(prefix?: RegExp): string[];
     get annotations(): Annotations;
+    /** The model annotations resolved for this object. */
+    get modelAnnotations(): Annotations;
     private parsedModelTag?;
+    /**
+     * @deprecated Use `.modelAnnotations.parseAsTag(route)`.
+     */
     get modelTag(): Tag;
     /**
      * @return The name of the entity.
      */
     get name(): string;
     getQueryByName(name: string): PreparedQuery;
-    private get modelDef();
     getSingleExploreModel(): Model;
     private get fieldMap();
     get allFields(): Field[];
@@ -158,6 +173,8 @@ export declare class AtomicField extends Entity implements Taggable {
     /** @deprecated Use `.annotations.texts(route)`. */
     getTaglines(prefix?: RegExp): string[];
     get annotations(): Annotations;
+    /** The model annotations resolved for this field, via its parent. */
+    get modelAnnotations(): Annotations;
     isIntrinsic(): boolean;
     isQueryField(): this is QueryField;
     isExploreField(): this is ExploreField;
@@ -224,6 +241,9 @@ export declare class Query extends Entity implements Taggable {
     /** @deprecated Use `.annotations.texts(route)`. */
     getTaglines(prefix?: RegExp): string[];
     get annotations(): Annotations;
+    /** The model annotations resolved for this view, via its parent
+     *  explore. A bare `Query` with no parent has none. */
+    get modelAnnotations(): Annotations;
 }
 export declare class QueryField extends Query {
     protected parent: Explore;
@@ -335,11 +355,15 @@ export declare class Model implements Taggable {
      * every given the model can accept.
      */
     get givens(): ReadonlyMap<string, Given>;
+    /** This model's own `##` bundle (its self-entry's `ownNotes`). */
+    private get _ownModelAnnotations();
     /** @deprecated Use `.annotations.parseAsTag(route)`. */
     tagParse(spec?: TagParseSpec): MalloyTagParse;
     /** @deprecated Use `.annotations.texts(route)`. */
     getTaglines(prefix?: RegExp): string[];
     get annotations(): Annotations;
+    /** The model annotations resolved across this model's import/extend lineage. */
+    get modelAnnotations(): Annotations;
     /**
      * Retrieve a reference for the token at the given position within the
      * document that produced this model.
@@ -491,6 +515,8 @@ export declare class PersistSource implements Taggable {
     /** @deprecated Use `.annotations.texts(route)`. */
     getTaglines(prefix?: RegExp): string[];
     get annotations(): Annotations;
+    /** The model annotations resolved for this source. */
+    get modelAnnotations(): Annotations;
     /**
      * The connection name for this source.
      */
@@ -542,14 +568,17 @@ export declare class Given implements Taggable {
     readonly name: string;
     readonly id: GivenID;
     private readonly _internal;
+    private readonly _modelDef;
     /**
      * @param name        Caller-facing surface name in the model (post-rename
      *                    on import). The key by which the caller passes a
      *                    value to `.run({givens: {[name]: ...}})`.
      * @param id          Global GivenID. Stable across imports and renames.
      * @param _internal   The internal Given declaration record.
+     * @param _modelDef   The model this given is declared in, for resolving
+     *                    its model annotations.
      */
-    constructor(name: string, id: GivenID, _internal: InternalGiven);
+    constructor(name: string, id: GivenID, _internal: InternalGiven, _modelDef: ModelDef);
     get type(): GivenTypeDef;
     /** `undefined` when no default — the caller must supply at run time. */
     get default(): ConstantExpr | undefined;
@@ -559,6 +588,8 @@ export declare class Given implements Taggable {
     /** @deprecated Use `.annotations.texts(route)`. */
     getTaglines(prefix?: RegExp): string[];
     get annotations(): Annotations;
+    /** The model annotations resolved for this given. */
+    get modelAnnotations(): Annotations;
 }
 /**
  * Internal abstract base for Foundation wrappers around an IR `Pipeline`
@@ -570,6 +601,9 @@ declare abstract class PipelineBase implements Taggable {
     protected pipelineDef: Pipeline;
     constructor(pipelineDef: Pipeline);
     get annotations(): Annotations;
+    /** Resolved model annotations. Abstract because the base has no
+     *  model in hand — subclasses that carry one supply the resolution. */
+    abstract get modelAnnotations(): Annotations;
     get location(): DocumentLocation | undefined;
     /** @deprecated Use `.annotations.parseAsTag(route)`. */
     tagParse(spec?: TagParseSpec): MalloyTagParse;
@@ -583,6 +617,8 @@ export declare class PreparedQuery extends PipelineBase {
     constructor(query: InternalQuery, _model: Model, problems: LogMessage[], name?: string | undefined);
     get _query(): InternalQuery | NamedQueryDef;
     get _modelDef(): ModelDef;
+    /** The model annotations resolved for this query's head. */
+    get modelAnnotations(): Annotations;
     /**
      * Generate the SQL for this query.
      *
@@ -629,6 +665,8 @@ export declare class PreparedResult implements Taggable {
     /** @deprecated Use `.annotations.texts(route)`. */
     getTaglines(prefix?: RegExp): string[];
     get annotations(): Annotations;
+    /** The model annotations resolved for this query's run-head. */
+    get modelAnnotations(): Annotations;
     /**
      * @deprecated Hands out raw IR (`AnnotationsDef`). Use `.annotations`
      * (returns the {@link Annotations} view) for read access. Internal
@@ -637,8 +675,8 @@ export declare class PreparedResult implements Taggable {
      */
     get annotation(): AnnotationsDef | undefined;
     /**
-     * @deprecated Hands out raw IR (`AnnotationsDef`). Internal code that
-     * needs the model-level IR shape should read `._modelDef.annotations`
+     * @deprecated Hands out raw IR (`AnnotationsDef`). Internal code that needs
+     * the model-level IR shape should call `getModelAnnotations(this.modelDef)`
      * directly. Slated for removal once external consumers migrate.
      */
     get modelAnnotation(): AnnotationsDef | undefined;