@true-sight/model-schema 1.1.0 → 1.2.0

package/dist/dsl/compile/compile-explore.js

@@ -73,13 +73,13 @@ function resolveAlwaysInclude(ExploreClass, exploreName, views, scopedViewNames)
     if (!Array.isArray(raw)) {
         throw new compile_errors_js_1.AlwaysIncludeError(exploreName, 'callback must return Field[]');
     }
-    const known = new Set();
+    const visibility = new Map();
     for (const view of views) {
         for (const dimension of view.dimensions) {
-            known.add(`${view.name}.${dimension.name}`);
+            visibility.set(`${view.name}.${dimension.name}`, dimension.visible !== false);
         }
         for (const measurement of view.measurements) {
-            known.add(`${view.name}.${measurement.name}`);
+            visibility.set(`${view.name}.${measurement.name}`, measurement.visible !== false);
         }
     }
     const seen = new Set();
@@ -96,9 +96,12 @@ function resolveAlwaysInclude(ExploreClass, exploreName, views, scopedViewNames)
             continue;
         }
         seen.add(ref);
-        if (!known.has(ref)) {
+        if (!visibility.has(ref)) {
             throw new compile_errors_js_1.AlwaysIncludeError(exploreName, `unknown field '${ref}'`);
         }
+        if (visibility.get(ref) === false) {
+            throw new compile_errors_js_1.AlwaysIncludeError(exploreName, `field '${ref}' is not visible and cannot be alwaysInclude`);
+        }
         names.push(ref);
     }
     return names.length > 0 ? names : undefined;

package/dist/dsl/compile/compile-view.js

@@ -18,6 +18,7 @@ function compileView(ViewClass) {
         label: entry.options.label,
         type: entry.options.type,
         expression: `${viewMeta.name}.${entry.propertyKey}`,
+        ...(entry.options.visible === false ? { visible: false } : {}),
     }));
     const measurements = measureEntries.map((entry) => {
         const raw = instance[entry.propertyKey];
@@ -28,6 +29,7 @@ function compileView(ViewClass) {
             label: entry.options.label,
             type: entry.options.type,
             expression,
+            ...(entry.options.visible === false ? { visible: false } : {}),
         };
     });
     return {

package/dist/dsl/expr/define-always-include.d.ts

@@ -0,0 +1,6 @@
+import type { AlwaysIncludeCallback } from '../types/join-scope.types.js';
+import type { StrictViewProxy, ViewConstructor } from '../types/view-proxy.types.js';
+import type { VisibleField } from './field.js';
+export declare function defineAlwaysInclude<const Vs extends readonly ViewConstructor[]>(_views: Vs, fn: (...proxies: {
+    [I in keyof Vs]: Vs[I] extends ViewConstructor ? StrictViewProxy<Vs[I]> : never;
+}) => VisibleField[]): AlwaysIncludeCallback;

package/dist/dsl/expr/define-always-include.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineAlwaysInclude = defineAlwaysInclude;
+function defineAlwaysInclude(_views, fn) {
+    return fn;
+}

package/dist/dsl/expr/field.d.ts

@@ -1,15 +1,18 @@
 import type { ManifestExpr, RefString } from '../../types/manifest-expr.types.js';
-export declare class Field<T> {
+export declare class Field<T, Visible extends boolean = true> {
     readonly ref: RefString;
+    readonly __visible?: Visible;
     constructor(viewName: string, fieldName: string);
-    eq(other: Field<unknown> | ManifestExpr): ManifestExpr;
-    neq(other: Field<unknown> | ManifestExpr): ManifestExpr;
-    gt(other: Field<unknown> | ManifestExpr): ManifestExpr;
-    gte(other: Field<unknown> | ManifestExpr): ManifestExpr;
-    lt(other: Field<unknown> | ManifestExpr): ManifestExpr;
-    lte(other: Field<unknown> | ManifestExpr): ManifestExpr;
+    eq(other: Field<unknown, boolean> | ManifestExpr): ManifestExpr;
+    neq(other: Field<unknown, boolean> | ManifestExpr): ManifestExpr;
+    gt(other: Field<unknown, boolean> | ManifestExpr): ManifestExpr;
+    gte(other: Field<unknown, boolean> | ManifestExpr): ManifestExpr;
+    lt(other: Field<unknown, boolean> | ManifestExpr): ManifestExpr;
+    lte(other: Field<unknown, boolean> | ManifestExpr): ManifestExpr;
     and(other: ManifestExpr): ManifestExpr;
     or(other: ManifestExpr): ManifestExpr;
     not(): ManifestExpr;
 }
-export declare function field<T>(viewName: string, fieldName: string): Field<T>;
+export type VisibleField<T = unknown> = Field<T, true>;
+export type HiddenField<T = unknown> = Field<T, false>;
+export declare function field<T, Visible extends boolean = true>(viewName: string, fieldName: string): Field<T, Visible>;

package/dist/dsl/expr/index.d.ts

@@ -1,4 +1,6 @@
 export { Field, field } from './field.js';
+export type { VisibleField, HiddenField } from './field.js';
+export { defineAlwaysInclude } from './define-always-include.js';
 export { count, max, min, sum } from './aggregates.js';
 export { raw } from './raw.js';
 export { joinScope, isJoinScopeTagged } from './join-scope.js';

package/dist/dsl/expr/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isJoinScopeTagged = exports.joinScope = exports.raw = exports.sum = exports.min = exports.max = exports.count = exports.field = exports.Field = void 0;
+exports.isJoinScopeTagged = exports.joinScope = exports.raw = exports.sum = exports.min = exports.max = exports.count = exports.defineAlwaysInclude = exports.field = exports.Field = void 0;
 var field_js_1 = require("./field.js");
 Object.defineProperty(exports, "Field", { enumerable: true, get: function () { return field_js_1.Field; } });
 Object.defineProperty(exports, "field", { enumerable: true, get: function () { return field_js_1.field; } });
+var define_always_include_js_1 = require("./define-always-include.js");
+Object.defineProperty(exports, "defineAlwaysInclude", { enumerable: true, get: function () { return define_always_include_js_1.defineAlwaysInclude; } });
 var aggregates_js_1 = require("./aggregates.js");
 Object.defineProperty(exports, "count", { enumerable: true, get: function () { return aggregates_js_1.count; } });
 Object.defineProperty(exports, "max", { enumerable: true, get: function () { return aggregates_js_1.max; } });

package/dist/dsl/registry/view-registry.d.ts

@@ -8,11 +8,13 @@ export type DimensionOptions = {
     groupLabel: string;
     label: string;
     type: DimensionType;
+    visible?: boolean;
 };
 export type MeasureOptions = {
     groupLabel: string;
     label: string;
     type: AggregateType;
+    visible?: boolean;
 };
 export type DimensionEntry = {
     propertyKey: string;

package/dist/dsl/types/view-proxy.types.d.ts

@@ -1,11 +1,12 @@
 import type { Field } from '../expr/field.js';
 export type ViewConstructor = new (...args: unknown[]) => object;
 export type DimensionKeys<V extends ViewConstructor> = {
-    [K in keyof InstanceType<V>]: InstanceType<V>[K] extends Field<infer _> ? K : never;
+    [K in keyof InstanceType<V>]: InstanceType<V>[K] extends Field<infer _T, infer _V> ? K : never;
 }[keyof InstanceType<V>];
-export type ViewProxy<V extends ViewConstructor> = {
+export type StrictViewProxy<V extends ViewConstructor> = {
     [K in DimensionKeys<V>]: InstanceType<V>[K];
-} & {
+};
+export type ViewProxy<V extends ViewConstructor> = StrictViewProxy<V> & {
     [key: string]: Field<unknown>;
 };
 export interface ViewBrand {

package/dist/index.d.ts

@@ -4,10 +4,11 @@ export { isJoinPair, isManifestExprObject, isRefString, REF_STRING_PATTERN, } fr
 export type { AggregateType, DimensionDefinition, DimensionType, Explore as ManifestExplore, ExploreJoin, JoinRelationship, JoinType, MeasurementDefinition, Model as ManifestModel, ModelManifest, ViewDefinition, } from './types/manifest.types.js';
 export type { ManifestValidationError, ValidationResult, } from './validate/validation-result.js';
 export { validateManifest } from './validate/validate-manifest.js';
-export { Field, field, count, sum, min, max, raw, joinScope, isJoinScopeTagged } from './dsl/expr/index.js';
+export { Field, field, count, sum, min, max, raw, joinScope, isJoinScopeTagged, defineAlwaysInclude } from './dsl/expr/index.js';
+export type { VisibleField, HiddenField } from './dsl/expr/index.js';
 export type { JoinScopeCallback, JoinScopeSqlOn, JoinScopeTagged, AlwaysIncludeCallback } from './dsl/types/join-scope.types.js';
 export { View, Dimension, Measure, Explore, Join, Model, AlwaysInclude } from './dsl/decorators/index.js';
-export type { ViewProxy, ViewConstructor } from './dsl/types/view-proxy.types.js';
+export type { ViewProxy, ViewConstructor, StrictViewProxy } from './dsl/types/view-proxy.types.js';
 export type { ViewNameMap, ViewProxyByName, } from './dsl/types/view-name-map.types.js';
 export { compileView, compileExplore, compileModel, compileModels } from './dsl/compile/index.js';
 export { MissingMetadataError, InvalidMeasureError, JoinScopeError, DuplicateNameError, AlwaysIncludeError, } from './dsl/errors/compile-errors.js';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AlwaysIncludeError = exports.DuplicateNameError = exports.JoinScopeError = exports.InvalidMeasureError = exports.MissingMetadataError = exports.compileModels = exports.compileModel = exports.compileExplore = exports.compileView = exports.AlwaysInclude = exports.Model = exports.Join = exports.Explore = exports.Measure = exports.Dimension = exports.View = exports.isJoinScopeTagged = exports.joinScope = exports.raw = exports.max = exports.min = exports.sum = exports.count = exports.field = exports.Field = exports.validateManifest = exports.REF_STRING_PATTERN = exports.isRefString = exports.isManifestExprObject = exports.isJoinPair = exports.SCHEMA_VERSION = void 0;
+exports.AlwaysIncludeError = exports.DuplicateNameError = exports.JoinScopeError = exports.InvalidMeasureError = exports.MissingMetadataError = exports.compileModels = exports.compileModel = exports.compileExplore = exports.compileView = exports.AlwaysInclude = exports.Model = exports.Join = exports.Explore = exports.Measure = exports.Dimension = exports.View = exports.defineAlwaysInclude = exports.isJoinScopeTagged = exports.joinScope = exports.raw = exports.max = exports.min = exports.sum = exports.count = exports.field = exports.Field = exports.validateManifest = exports.REF_STRING_PATTERN = exports.isRefString = exports.isManifestExprObject = exports.isJoinPair = exports.SCHEMA_VERSION = void 0;
 var constants_js_1 = require("./constants.js");
 Object.defineProperty(exports, "SCHEMA_VERSION", { enumerable: true, get: function () { return constants_js_1.SCHEMA_VERSION; } });
 var manifest_expr_types_js_1 = require("./types/manifest-expr.types.js");
@@ -20,6 +20,7 @@ Object.defineProperty(exports, "max", { enumerable: true, get: function () { ret
 Object.defineProperty(exports, "raw", { enumerable: true, get: function () { return index_js_1.raw; } });
 Object.defineProperty(exports, "joinScope", { enumerable: true, get: function () { return index_js_1.joinScope; } });
 Object.defineProperty(exports, "isJoinScopeTagged", { enumerable: true, get: function () { return index_js_1.isJoinScopeTagged; } });
+Object.defineProperty(exports, "defineAlwaysInclude", { enumerable: true, get: function () { return index_js_1.defineAlwaysInclude; } });
 var index_js_2 = require("./dsl/decorators/index.js");
 Object.defineProperty(exports, "View", { enumerable: true, get: function () { return index_js_2.View; } });
 Object.defineProperty(exports, "Dimension", { enumerable: true, get: function () { return index_js_2.Dimension; } });

package/dist/types/manifest.types.d.ts

@@ -16,6 +16,7 @@ export interface DimensionDefinition {
     label: string;
     type: DimensionType;
     expression: ManifestExpr;
+    visible?: boolean;
 }
 export interface MeasurementDefinition {
     groupLabel: string;
@@ -23,6 +24,7 @@ export interface MeasurementDefinition {
     label: string;
     type: AggregateType;
     expression: ManifestExpr;
+    visible?: boolean;
 }
 export interface ViewDefinition {
     name: string;

package/dist/validate/semantic-rules.js

@@ -44,13 +44,13 @@ function collectSemanticErrors(manifest) {
                     message: `from view "${explore.from}" is not in explore views`,
                 });
             }
-            const qualifiedFields = new Set();
+            const qualifiedFields = new Map();
             for (const view of explore.views) {
                 for (const dimension of view.dimensions) {
-                    qualifiedFields.add(`${view.name}.${dimension.name}`);
+                    qualifiedFields.set(`${view.name}.${dimension.name}`, dimension.visible !== false);
                 }
                 for (const measurement of view.measurements) {
-                    qualifiedFields.add(`${view.name}.${measurement.name}`);
+                    qualifiedFields.set(`${view.name}.${measurement.name}`, measurement.visible !== false);
                 }
             }
             (explore.alwaysInclude ?? []).forEach((name, index) => {
@@ -67,6 +67,13 @@ function collectSemanticErrors(manifest) {
                         path,
                         message: `alwaysInclude name "${name}" is not a dimension or measurement on this explore`,
                     });
+                    return;
+                }
+                if (qualifiedFields.get(name) === false) {
+                    errors.push({
+                        path,
+                        message: `alwaysInclude name "${name}" is not visible`,
+                    });
                 }
             });
             explore.joins.forEach((join, joinIndex) => {

package/manifest.schema.json

@@ -119,7 +119,8 @@
         "name": { "type": "string", "minLength": 1 },
         "label": { "type": "string" },
         "type": { "$ref": "#/definitions/DimensionType" },
-        "expression": { "$ref": "#/definitions/ManifestExpr" }
+        "expression": { "$ref": "#/definitions/ManifestExpr" },
+        "visible": { "type": "boolean" }
       }
     },
     "MeasurementDefinition": {
@@ -131,7 +132,8 @@
         "name": { "type": "string", "minLength": 1 },
         "label": { "type": "string" },
         "type": { "$ref": "#/definitions/AggregateType" },
-        "expression": { "$ref": "#/definitions/ManifestExpr" }
+        "expression": { "$ref": "#/definitions/ManifestExpr" },
+        "visible": { "type": "boolean" }
       }
     },
     "ViewDefinition": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@true-sight/model-schema",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [