@itwin/ecschema-metadata 5.15.0-dev.9 → 5.16.0-dev.2

package/lib/esm/SchemaView/SchemaView.js

@@ -137,8 +137,8 @@ export class SchemaView {
             throw new Error("SchemaView is not mergeable: create it via SchemaView.createMergeable to merge fragments.");
         this._mergeContext.mergeBlob(blob);
         // A new fragment can add subclasses to an already-present base class, so the derived-class map
-        // must be rebuilt. transitiveBaseCache stays valid: a class's ancestors are always merged
-        // before it (dependency order), so an append never adds an ancestor to an already-cached class.
+        // must be rebuilt. transitiveBaseCache and PropertyRef.overriddenProperty stay valid: a class's ancestors
+        // are always merged before it (dependency order), so an append never adds an ancestor to an already-cached class.
         this[_storage].derivedClassMap = undefined;
     }
     // --- Internal helpers used by view objects ---
@@ -228,12 +228,18 @@ export class SchemaView {
         // 1. Base class (recursive, depth-first)
         if (cls.baseClassIdx !== -1)
             this._collectProperties(cls.baseClassIdx, merged);
-        // 2. Mixins in declaration order
+        // 2. Mixins in declaration order. Each mixin is resolved on its own so its overrides win over its
+        // ancestors, then only adds names not already provided by the base class or an earlier mixin.
         for (let i = 0; i < cls.mixinCount; i++) {
             const mixinIdx = this[_storage].classMixins[cls.mixinStartIdx + i];
             if (mixinIdx === -1 || mixinIdx === undefined)
                 continue; // safety: dangling mixin ref
-            this._collectMixinProperties(mixinIdx, merged);
+            const mixinProperties = new Map();
+            this._collectProperties(mixinIdx, mixinProperties);
+            for (const [nameKey, resolved] of mixinProperties) {
+                if (!merged.has(nameKey))
+                    merged.set(nameKey, resolved);
+            }
         }
         // 3. Own properties - always override
         for (let i = 0; i < cls.ownPropCount; i++) {
@@ -242,27 +248,62 @@ export class SchemaView {
             merged.set(nameKey, { ref, classIdx });
         }
     }
-    _collectMixinProperties(mixinIdx, merged) {
-        const mixin = this[_storage].classes[mixinIdx];
-        if (mixin === undefined)
-            return; // safety: dangling index from excluded schema
-        // Walk mixin's own base chain (mixins can extend other mixins)
-        if (mixin.baseClassIdx !== -1)
-            this._collectMixinProperties(mixin.baseClassIdx, merged);
-        // Mixin's own mixins
-        for (let i = 0; i < mixin.mixinCount; i++) {
-            const subMixinIdx = this[_storage].classMixins[mixin.mixinStartIdx + i];
-            if (subMixinIdx === -1 || subMixinIdx === undefined)
+    /** Finds the property declaration that a property of the given class overrides.
+     * Searches the base class and its ancestors first, then each mixin in declaration order.
+     */
+    _findOverriddenProperty(classIdx, nameKey) {
+        const cls = this[_storage].classes[classIdx];
+        if (cls === undefined || cls.type === ClassType.View)
+            return undefined;
+        if (cls.baseClassIdx !== -1) {
+            const found = this._findPropertyDeclaration(cls.baseClassIdx, nameKey);
+            if (found !== undefined)
+                return found;
+        }
+        for (let i = 0; i < cls.mixinCount; i++) {
+            const mixinIdx = this[_storage].classMixins[cls.mixinStartIdx + i];
+            if (mixinIdx === -1 || mixinIdx === undefined)
                 continue; // safety: dangling mixin ref
-            this._collectMixinProperties(subMixinIdx, merged);
+            const found = this._findPropertyDeclaration(mixinIdx, nameKey);
+            if (found !== undefined)
+                return found;
+        }
+        return undefined;
+    }
+    _findPropertyDeclaration(classIdx, nameKey) {
+        const cls = this[_storage].classes[classIdx];
+        if (cls === undefined)
+            return undefined; // safety: dangling index from excluded schema
+        for (let i = 0; i < cls.ownPropCount; i++) {
+            const ref = this[_storage].propertyRefs[cls.ownPropStart + i];
+            if (this[_storage].lowerStrings[this[_storage].propDefs[ref.defIdx].nameStringIdx] === nameKey)
+                return { ref, classIdx };
         }
-        // Mixin's own properties - only set if not already present (first mixin wins)
-        for (let i = 0; i < mixin.ownPropCount; i++) {
-            const ref = this[_storage].propertyRefs[mixin.ownPropStart + i];
+        return this._findOverriddenProperty(classIdx, nameKey);
+    }
+    /** Returns the first declaration matching `predicate`, starting with the given declaration and
+     * continuing with the declarations it overrides.
+     * @internal
+     */
+    findPropertyDefInOverrides(ref, classIdx, predicate) {
+        let current = { ref, classIdx };
+        while (current !== null) {
+            const def = this[_storage].propDefs[current.ref.defIdx];
+            if (predicate(def))
+                return def;
+            current = this._getOverriddenProperty(current.ref, current.classIdx);
+        }
+        return undefined;
+    }
+    /** Returns the declaration the given one overrides, resolving and storing it on the ref on first access.
+     * Caching per ref is sound because a ref belongs to exactly one class; view properties (classIdx -1) never override.
+     */
+    _getOverriddenProperty(ref, classIdx) {
+        if (ref.overriddenProperty === undefined) {
             const nameKey = this[_storage].lowerStrings[this[_storage].propDefs[ref.defIdx].nameStringIdx];
-            if (!merged.has(nameKey))
-                merged.set(nameKey, { ref, classIdx: mixinIdx });
+            ref.overriddenProperty = classIdx !== -1 ? this._findOverriddenProperty(classIdx, nameKey) ?? null : null;
         }
+        return ref.overriddenProperty;
     }
     /** @internal */
     buildDerivedClassMap() {
@@ -287,6 +328,9 @@ export class SchemaView {
 // =====================================================================================
 // SchemaView namespace - flyweight view types
 // =====================================================================================
+function hasCategory(def) { return def.categoryIdx !== -1; }
+function hasKindOfQuantity(def) { return def.koqIdx !== -1; }
+function isHiddenDef(def) { return def.isHidden; }
 /** @beta */
 (function (SchemaView) {
     /** Lightweight view over a schema in a `SchemaView`. Holds only a view reference and
@@ -630,10 +674,21 @@ export class SchemaView {
         }
         get kind() { return this._def.kind; }
         get isReadOnly() { return this._def.isReadOnly; }
-        /** Reflects the `HiddenProperty` custom attribute from `CoreCustomAttributes`.
-         * Properties marked hidden are typically excluded from UI display but remain accessible programmatically. */
+        /** Reflects the `HiddenProperty` custom attribute from `CoreCustomAttributes` on this declaration only;
+         * see `isEffectivelyHidden`. Properties marked hidden are typically excluded from UI display but remain
+         * accessible programmatically. */
         get isHidden() { return this._def.isHidden; }
-        /** Display priority. Higher values should be displayed more prominently. 0 means default. */
+        /** True if this declaration is hidden. If it is not and the property is an override, we take this from the
+         * overridden property. Limitation: `HiddenProperty(Show=true)` reads the same as no `HiddenProperty`, so it does not
+         * unhide a property whose overridden property is hidden. */
+        get isEffectivelyHidden() {
+            if (this._def.isHidden)
+                return true;
+            return this._ctx.findPropertyDefInOverrides(this._ref, this._classIdx, isHiddenDef) !== undefined;
+        }
+        /** Display priority. Higher values should be displayed more prominently. 0 means default.
+         * Not inherited from the overridden property: an omitted priority is stored as 0, which cannot be told
+         * apart from an explicit 0 that overrides a base priority. */
         get priority() { return this._ref.priority; }
         /** The class that declared or contributed this property through inheritance.
          * For own properties, returns the class itself. For inherited properties, returns the
@@ -644,11 +699,21 @@ export class SchemaView {
         get declaringClass() {
             return this._classIdx !== -1 ? createClass(this._ctx, this._classIdx) : undefined;
         }
-        /** Property category, or undefined if none assigned. Available on all property kinds. */
+        /** Property category. If there is no local category and the property is an override, we take this from
+         * the overridden property. Available on all property kinds. */
         get category() {
-            const idx = this._def.categoryIdx;
+            let idx = this._def.categoryIdx;
+            if (idx === -1 && this._ctx[_storage].propCategories.length !== 0)
+                idx = this._ctx.findPropertyDefInOverrides(this._ref, this._classIdx, hasCategory)?.categoryIdx ?? -1;
             return idx !== -1 ? new PropertyCategory(this._ctx, idx) : undefined;
         }
+        /** @internal */
+        get _kindOfQuantity() {
+            let idx = this._def.koqIdx;
+            if (idx === -1 && this._ctx[_storage].koqs.length !== 0)
+                idx = this._ctx.findPropertyDefInOverrides(this._ref, this._classIdx, hasKindOfQuantity)?.koqIdx ?? -1;
+            return idx !== -1 ? new KindOfQuantity(this._ctx, idx) : undefined;
+        }
         // Type guards - real type predicates that narrow `this`
         /** True for `SchemaView.PrimitiveProperty` and `SchemaView.PrimitiveArrayProperty`.
          * Matches ecschema-metadata behavior where `isPrimitive()` includes primitive arrays. */
@@ -710,10 +775,9 @@ export class SchemaView {
             const idx = this._def.enumIdx;
             return idx !== -1 ? new Enumeration(this._ctx, idx) : undefined;
         }
-        get kindOfQuantity() {
-            const idx = this._def.koqIdx;
-            return idx !== -1 ? new KindOfQuantity(this._ctx, idx) : undefined;
-        }
+        /** KindOfQuantity. If there is no local KindOfQuantity and the property is an override, we take this
+         * from the overridden property. */
+        get kindOfQuantity() { return this._kindOfQuantity; }
     }
     SchemaView.PrimitiveProperty = PrimitiveProperty;
     /** An array of primitive values. Same primitive/enum fields as `PrimitiveProperty`,
@@ -730,10 +794,9 @@ export class SchemaView {
             const idx = this._def.enumIdx;
             return idx !== -1 ? new Enumeration(this._ctx, idx) : undefined;
         }
-        get kindOfQuantity() {
-            const idx = this._def.koqIdx;
-            return idx !== -1 ? new KindOfQuantity(this._ctx, idx) : undefined;
-        }
+        /** KindOfQuantity. If there is no local KindOfQuantity and the property is an override, we take this
+         * from the overridden property. */
+        get kindOfQuantity() { return this._kindOfQuantity; }
         get arrayMinOccurs() { return this._def.arrayMinOccurs; }
         get arrayMaxOccurs() { return this._def.arrayMaxOccurs; }
     }