@malloydata/malloy 0.0.30 → 0.0.31-dev230414150450

package/dist/index.d.ts

@@ -2,8 +2,8 @@ export type { QueryDataRow, Fragment, StructDef, StructRelationship, NamedStruct
 export { Segment, isFilteredAliasedName, flattenQuery, expressionIsCalculation, } from './model';
 export { HighlightType, MalloyTranslator, } from './lang';
 export type { LogMessage, TranslateResponse } from './lang';
-export { Malloy, Runtime, AtomicFieldType, ConnectionRuntime, SingleConnectionRuntime, EmptyURLReader, InMemoryURLReader, FixedConnectionMap, MalloyError, JoinRelationship, SourceRelationship, DateTimeframe, TimestampTimeframe, Result, parseTableURI, QueryMaterializer, CSVWriter, JSONWriter, Parse, DataWriter, } from './malloy';
-export type { Explore, Model, PreparedQuery, PreparedResult, Field, AtomicField, ExploreField, QueryField, DataArray, DataRecord, DataColumn, DataArrayOrRecord, ModelMaterializer, DocumentSymbol, DocumentHighlight, ResultJSON, PreparedResultMaterializer, SQLBlockMaterializer, ExploreMaterializer, WriteStream, } from './malloy';
+export { Malloy, Runtime, AtomicFieldType, ConnectionRuntime, SingleConnectionRuntime, EmptyURLReader, InMemoryURLReader, FixedConnectionMap, MalloyError, JoinRelationship, SourceRelationship, DateTimeframe, TimestampTimeframe, Result, parseTableURI, QueryMaterializer, CSVWriter, JSONWriter, Parse, DataWriter, Explore, } from './malloy';
+export type { Model, PreparedQuery, PreparedResult, Field, AtomicField, ExploreField, QueryField, DataArray, DataRecord, DataColumn, DataArrayOrRecord, ModelMaterializer, DocumentSymbol, DocumentHighlight, ResultJSON, PreparedResultMaterializer, SQLBlockMaterializer, ExploreMaterializer, WriteStream, SerializedExplore, } from './malloy';
 export type { RunSQLOptions } from './run_sql_options';
 export type { URLReader, InfoConnection, LookupConnection, Connection, QueryString, ModelString, QueryURL, ModelURL, PooledConnection, TestableConnection, PersistSQLResults, StreamingConnection, } from './runtime_types';
 export type { Loggable } from './malloy';

package/dist/index.js

@@ -22,7 +22,7 @@
  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toAsyncGenerator = exports.DataWriter = exports.Parse = exports.JSONWriter = exports.CSVWriter = exports.QueryMaterializer = exports.parseTableURI = exports.Result = exports.TimestampTimeframe = exports.DateTimeframe = exports.SourceRelationship = exports.JoinRelationship = exports.MalloyError = exports.FixedConnectionMap = exports.InMemoryURLReader = exports.EmptyURLReader = exports.SingleConnectionRuntime = exports.ConnectionRuntime = exports.AtomicFieldType = exports.Runtime = exports.Malloy = exports.MalloyTranslator = exports.HighlightType = exports.expressionIsCalculation = exports.flattenQuery = exports.isFilteredAliasedName = exports.Segment = void 0;
+exports.toAsyncGenerator = exports.Explore = exports.DataWriter = exports.Parse = exports.JSONWriter = exports.CSVWriter = exports.QueryMaterializer = exports.parseTableURI = exports.Result = exports.TimestampTimeframe = exports.DateTimeframe = exports.SourceRelationship = exports.JoinRelationship = exports.MalloyError = exports.FixedConnectionMap = exports.InMemoryURLReader = exports.EmptyURLReader = exports.SingleConnectionRuntime = exports.ConnectionRuntime = exports.AtomicFieldType = exports.Runtime = exports.Malloy = exports.MalloyTranslator = exports.HighlightType = exports.expressionIsCalculation = exports.flattenQuery = exports.isFilteredAliasedName = exports.Segment = void 0;
 var model_1 = require("./model");
 // Used in Composer Demo
 Object.defineProperty(exports, "Segment", { enumerable: true, get: function () { return model_1.Segment; } });
@@ -55,6 +55,7 @@ Object.defineProperty(exports, "CSVWriter", { enumerable: true, get: function ()
 Object.defineProperty(exports, "JSONWriter", { enumerable: true, get: function () { return malloy_1.JSONWriter; } });
 Object.defineProperty(exports, "Parse", { enumerable: true, get: function () { return malloy_1.Parse; } });
 Object.defineProperty(exports, "DataWriter", { enumerable: true, get: function () { return malloy_1.DataWriter; } });
+Object.defineProperty(exports, "Explore", { enumerable: true, get: function () { return malloy_1.Explore; } });
 var connection_utils_1 = require("./connection_utils");
 Object.defineProperty(exports, "toAsyncGenerator", { enumerable: true, get: function () { return connection_utils_1.toAsyncGenerator; } });
 //# sourceMappingURL=index.js.map

package/dist/lang/test/model_serialization.spec.d.ts

@@ -0,0 +1,5 @@
+import { StructDef } from '../../model/malloy_types';
+export declare const CHILD_EXPLORE: StructDef;
+export declare const PARENT_EXPLORE: StructDef;
+export declare const GRADPARENT_EXPLORE: StructDef;
+export declare const SOURCE_EXPLORE: StructDef;

package/dist/lang/test/model_serialization.spec.js

@@ -0,0 +1,128 @@
+"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.SOURCE_EXPLORE = exports.GRADPARENT_EXPLORE = exports.PARENT_EXPLORE = exports.CHILD_EXPLORE = void 0;
+const malloy_1 = require("../../malloy");
+exports.CHILD_EXPLORE = {
+    type: 'struct',
+    name: 'some_ns.child',
+    as: 'child',
+    dialect: 'standardsql',
+    structSource: {
+        type: 'table',
+        tablePath: 'some_ns.child',
+    },
+    structRelationship: { type: 'basetable', connectionName: 'bigquery' },
+    primaryKey: 'id1',
+    fields: [
+        { type: 'string', name: 'carrier' },
+        {
+            type: 'number',
+            name: 'flight_count',
+            expressionType: 'aggregate',
+            e: [{ type: 'aggregate', function: 'count', e: [] }],
+        },
+    ],
+};
+exports.PARENT_EXPLORE = {
+    type: 'struct',
+    name: 'some_ns.parent',
+    as: 'parent',
+    dialect: 'standardsql',
+    structSource: {
+        type: 'table',
+        tablePath: 'some_ns.parent',
+    },
+    structRelationship: { type: 'basetable', connectionName: 'bigquery' },
+    primaryKey: 'id2',
+    fields: [
+        { type: 'string', name: 'name' },
+        {
+            type: 'number',
+            name: 'some_parent_count',
+            expressionType: 'aggregate',
+            e: [{ type: 'aggregate', function: 'count', e: [] }],
+        },
+    ],
+};
+exports.GRADPARENT_EXPLORE = {
+    type: 'struct',
+    name: 'some_ns.gradparent',
+    as: 'parent',
+    dialect: 'standardsql',
+    structSource: {
+        type: 'table',
+        tablePath: 'some_ns.gradparent',
+    },
+    structRelationship: { type: 'basetable', connectionName: 'bigquery' },
+    primaryKey: 'id3',
+    fields: [
+        { type: 'string', name: 'name' },
+        {
+            type: 'number',
+            name: 'some_gradparent_count',
+            expressionType: 'aggregate',
+            e: [{ type: 'aggregate', function: 'count', e: [] }],
+        },
+    ],
+};
+exports.SOURCE_EXPLORE = {
+    type: 'struct',
+    name: 'some_ns.source',
+    as: 'source',
+    dialect: 'standardsql',
+    structSource: {
+        type: 'table',
+        tablePath: 'some_ns.source',
+    },
+    structRelationship: { type: 'basetable', connectionName: 'bigquery' },
+    primaryKey: 'id4',
+    fields: [
+        { type: 'string', name: 'name' },
+        {
+            type: 'number',
+            name: 'some_child_count',
+            expressionType: 'aggregate',
+            e: [{ type: 'aggregate', function: 'count', e: [] }],
+        },
+    ],
+};
+describe('serializeModel', () => {
+    test('Stringify on an `explore` with no parent nor source explore', async () => {
+        const parent_explore = new malloy_1.Explore(exports.PARENT_EXPLORE);
+        expect(JSON.stringify(parent_explore)).toStrictEqual('{"_structDef":{"type":"struct","name":"some_ns.parent","as":"parent","dialect":"standardsql","structSource":{"type":"table","tablePath":"some_ns.parent"},"structRelationship":{"type":"basetable","connectionName":"bigquery"},"primaryKey":"id2","fields":[{"type":"string","name":"name"},{"type":"number","name":"some_parent_count","expressionType":"aggregate","e":[{"type":"aggregate","function":"count","e":[]}]}]}}');
+    });
+    test('No parent nor source explore', async () => {
+        const parent_explore = new malloy_1.Explore(exports.PARENT_EXPLORE);
+        expect(malloy_1.Explore.fromJSON(parent_explore.toJSON())).toStrictEqual(parent_explore);
+    });
+    test('Having parent and source explores', async () => {
+        const gradparent_explore = new malloy_1.Explore(exports.GRADPARENT_EXPLORE);
+        const parent_explore = new malloy_1.Explore(exports.PARENT_EXPLORE, gradparent_explore);
+        const source_explore = new malloy_1.Explore(exports.SOURCE_EXPLORE);
+        const child_explore = new malloy_1.Explore(exports.CHILD_EXPLORE, parent_explore, source_explore);
+        expect(malloy_1.Explore.fromJSON(child_explore.toJSON())).toStrictEqual(child_explore);
+    });
+});
+//# sourceMappingURL=model_serialization.spec.js.map

package/dist/malloy.d.ts

@@ -460,6 +460,11 @@ declare abstract class Entity {
     abstract isIntrinsic(): boolean;
 }
 export declare type Field = AtomicField | QueryField | ExploreField;
+export declare type SerializedExplore = {
+    _structDef: StructDef;
+    sourceExplore?: SerializedExplore;
+    _parentExplore?: SerializedExplore;
+};
 export declare class Explore extends Entity {
     protected readonly _structDef: StructDef;
     protected readonly _parentExplore?: Explore;
@@ -487,6 +492,8 @@ export declare class Explore extends Entity {
     get filters(): FilterExpression[];
     get limit(): number | undefined;
     get structDef(): StructDef;
+    toJSON(): SerializedExplore;
+    static fromJSON(main_explore: SerializedExplore): Explore;
 }
 export declare enum AtomicFieldType {
     String = "string",

package/dist/malloy.js

@@ -979,6 +979,23 @@ class Explore extends Entity {
     get structDef() {
         return this._structDef;
     }
+    toJSON() {
+        var _a, _b;
+        return {
+            _structDef: this._structDef,
+            sourceExplore: (_a = this.sourceExplore) === null || _a === void 0 ? void 0 : _a.toJSON(),
+            _parentExplore: (_b = this._parentExplore) === null || _b === void 0 ? void 0 : _b.toJSON(),
+        };
+    }
+    static fromJSON(main_explore) {
+        const parentExplore = main_explore._parentExplore !== undefined
+            ? Explore.fromJSON(main_explore._parentExplore)
+            : undefined;
+        const sourceExplore = main_explore.sourceExplore !== undefined
+            ? Explore.fromJSON(main_explore.sourceExplore)
+            : undefined;
+        return new Explore(main_explore._structDef, parentExplore, sourceExplore);
+    }
 }
 exports.Explore = Explore;
 var AtomicFieldType;

package/package.json

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