@itwin/core-backend 5.10.0-dev.19 → 5.10.0-dev.21

package/lib/esm/test/schema/SchemaViewHidden.test.js

@@ -0,0 +1,275 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { IModelHost, SnapshotDb } from "../../core-backend";
+import { expect } from "chai";
+import { IModelTestUtils } from "../IModelTestUtils";
+import { TestUtils } from "../TestUtils";
+/**
+ * Tests for the Hidden* custom attributes from CoreCustomAttributes, verifying that SchemaView
+ * correctly exposes the tri-state `isHidden` (true/false/undefined) on classes and the boolean
+ * `isHidden` on schemas and properties. Also tests `isEffectivelyHidden` which walks the base
+ * class chain (not mixins) and stops at explicit `isHidden === false` overrides.
+ *
+ * Class `isHidden` values:
+ * - `true`:      hidden via `HiddenClass(Show!=true)` or schema-level `HiddenSchema(ShowClasses!=true)`
+ * - `false`:     explicitly shown via `HiddenClass(Show=true)` - breaks inheritance chain
+ * - `undefined`: no `HiddenClass` CA, schema doesn't hide classes - neutral, defers to base class
+ *
+ * Binary format: classes serialize this as a single byte (0=undefined, 1=true, 2=false).
+ * Schema-level class propagation from `HiddenSchema(ShowClasses!=true)` is pre-resolved
+ * into each class's isHidden at serialization time.
+ */
+describe("SchemaView hidden flags", () => {
+    before(async () => {
+        if (!IModelHost.isValid)
+            await TestUtils.startBackend();
+    });
+    // Schema with HiddenSchema(ShowClasses=false) - schema AND all classes should be hidden
+    const hiddenSchemaDefault = `<?xml version="1.0" encoding="UTF-8"?>
+    <ECSchema schemaName="HiddenSchemaDefault" alias="hsd" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
+      <ECSchemaReference name="BisCore" version="01.00.00" alias="bis"/>
+      <ECSchemaReference name="CoreCustomAttributes" version="01.00.00" alias="CoreCA"/>
+      <ECCustomAttributes>
+        <HiddenSchema xmlns="CoreCustomAttributes.01.00.00">
+          <ShowClasses>false</ShowClasses>
+        </HiddenSchema>
+      </ECCustomAttributes>
+      <ECEntityClass typeName="InheritedHiddenElement" modifier="Sealed">
+        <BaseClass>bis:PhysicalElement</BaseClass>
+        <ECProperty propertyName="SomeProp" typeName="string"/>
+      </ECEntityClass>
+    </ECSchema>`;
+    // Schema with HiddenSchema(ShowClasses=true) - schema hidden, classes are NOT
+    const hiddenSchemaShowClasses = `<?xml version="1.0" encoding="UTF-8"?>
+    <ECSchema schemaName="HiddenSchemaShowClasses" alias="hssc" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
+      <ECSchemaReference name="BisCore" version="01.00.00" alias="bis"/>
+      <ECSchemaReference name="CoreCustomAttributes" version="01.00.00" alias="CoreCA"/>
+      <ECCustomAttributes>
+        <HiddenSchema xmlns="CoreCustomAttributes.01.00.00">
+          <ShowClasses>true</ShowClasses>
+        </HiddenSchema>
+      </ECCustomAttributes>
+      <ECEntityClass typeName="ShownElement" modifier="Sealed">
+        <BaseClass>bis:PhysicalElement</BaseClass>
+        <ECProperty propertyName="SomeProp" typeName="string"/>
+      </ECEntityClass>
+    </ECSchema>`;
+    // Schema with HiddenSchema(ShowClasses=false) + class with HiddenClass(Show=true) override
+    const hiddenSchemaWithClassOverride = `<?xml version="1.0" encoding="UTF-8"?>
+    <ECSchema schemaName="HiddenSchemaClassOverride" alias="hsco" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
+      <ECSchemaReference name="BisCore" version="01.00.00" alias="bis"/>
+      <ECSchemaReference name="CoreCustomAttributes" version="01.00.00" alias="CoreCA"/>
+      <ECCustomAttributes>
+        <HiddenSchema xmlns="CoreCustomAttributes.01.00.00">
+          <ShowClasses>false</ShowClasses>
+        </HiddenSchema>
+      </ECCustomAttributes>
+      <ECEntityClass typeName="OverriddenShownElement" modifier="Sealed">
+        <BaseClass>bis:PhysicalElement</BaseClass>
+        <ECCustomAttributes>
+          <HiddenClass xmlns="CoreCustomAttributes.01.00.00">
+            <Show>true</Show>
+          </HiddenClass>
+        </ECCustomAttributes>
+        <ECProperty propertyName="SomeProp" typeName="string"/>
+      </ECEntityClass>
+      <ECEntityClass typeName="StillHiddenElement" modifier="Sealed">
+        <BaseClass>bis:PhysicalElement</BaseClass>
+        <ECProperty propertyName="SomeProp" typeName="string"/>
+      </ECEntityClass>
+    </ECSchema>`;
+    // Schema with class-level and property-level hidden flags and Show overrides.
+    // Also includes a non-sealed hidden base class to test derived class inheritance.
+    const hiddenClassAndPropertySchema = `<?xml version="1.0" encoding="UTF-8"?>
+    <ECSchema schemaName="HiddenClassPropSchema" alias="hcps" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
+      <ECSchemaReference name="BisCore" version="01.00.00" alias="bis"/>
+      <ECSchemaReference name="CoreCustomAttributes" version="01.00.00" alias="CoreCA"/>
+      <ECEntityClass typeName="HiddenBase" modifier="Abstract">
+        <BaseClass>bis:PhysicalElement</BaseClass>
+        <ECCustomAttributes>
+          <HiddenClass xmlns="CoreCustomAttributes.01.00.00">
+            <Show>false</Show>
+          </HiddenClass>
+        </ECCustomAttributes>
+        <ECProperty propertyName="HiddenProp" typeName="string">
+          <ECCustomAttributes>
+            <HiddenProperty xmlns="CoreCustomAttributes.01.00.00">
+              <Show>false</Show>
+            </HiddenProperty>
+          </ECCustomAttributes>
+        </ECProperty>
+        <ECProperty propertyName="ShownProp" typeName="string">
+          <ECCustomAttributes>
+            <HiddenProperty xmlns="CoreCustomAttributes.01.00.00">
+              <Show>true</Show>
+            </HiddenProperty>
+          </ECCustomAttributes>
+        </ECProperty>
+        <ECProperty propertyName="NormalProp" typeName="string"/>
+      </ECEntityClass>
+      <ECEntityClass typeName="DerivedNoCA" modifier="Sealed" description="Derived from hidden base, no HiddenClass CA - should inherit hidden via isEffectivelyHidden">
+        <BaseClass>HiddenBase</BaseClass>
+      </ECEntityClass>
+      <ECEntityClass typeName="DerivedShown" description="Derived from hidden base, HiddenClass(Show=true) breaks the chain">
+        <BaseClass>HiddenBase</BaseClass>
+        <ECCustomAttributes>
+          <HiddenClass xmlns="CoreCustomAttributes.01.00.00">
+            <Show>true</Show>
+          </HiddenClass>
+        </ECCustomAttributes>
+      </ECEntityClass>
+      <ECEntityClass typeName="DerivedFromShown" modifier="Sealed" description="Derived from explicitly shown class, no CA - should NOT be effectively hidden">
+        <BaseClass>DerivedShown</BaseClass>
+      </ECEntityClass>
+      <ECEntityClass typeName="ShownClassElement" modifier="Sealed">
+        <BaseClass>bis:PhysicalElement</BaseClass>
+        <ECCustomAttributes>
+          <HiddenClass xmlns="CoreCustomAttributes.01.00.00">
+            <Show>true</Show>
+          </HiddenClass>
+        </ECCustomAttributes>
+        <ECProperty propertyName="SomeProp" typeName="int"/>
+      </ECEntityClass>
+      <ECEntityClass typeName="VisibleElement" modifier="Sealed">
+        <BaseClass>bis:PhysicalElement</BaseClass>
+        <ECProperty propertyName="SomeProp" typeName="int"/>
+      </ECEntityClass>
+    </ECSchema>`;
+    // Visible schema for baseline comparison
+    const visibleTestSchema = `<?xml version="1.0" encoding="UTF-8"?>
+    <ECSchema schemaName="VisibleTestSchema" alias="vts" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
+      <ECSchemaReference name="BisCore" version="01.00.00" alias="bis"/>
+      <ECEntityClass typeName="NormalElement" modifier="Sealed">
+        <BaseClass>bis:PhysicalElement</BaseClass>
+        <ECProperty propertyName="NormalProp" typeName="string"/>
+      </ECEntityClass>
+    </ECSchema>`;
+    let iModel;
+    let view;
+    before(async () => {
+        const testFileName = IModelTestUtils.prepareOutputFile("SchemaViewHidden", "HiddenFlags.bim");
+        iModel = SnapshotDb.createEmpty(testFileName, { rootSubject: { name: "HiddenFlagsTest" } });
+        await iModel.importSchemaStrings([
+            hiddenSchemaDefault,
+            hiddenSchemaShowClasses,
+            hiddenSchemaWithClassOverride,
+            hiddenClassAndPropertySchema,
+            visibleTestSchema,
+        ]);
+        view = await iModel.getSchemaView();
+    });
+    after(() => {
+        if (iModel?.isOpen)
+            iModel.close();
+    });
+    describe("HiddenSchema", () => {
+        it("schema without HiddenSchema CA is not hidden", () => {
+            const schema = view.getSchema("VisibleTestSchema");
+            expect(schema).to.not.be.undefined;
+            expect(schema.isHidden).to.equal(false);
+            const bisCore = view.getSchema("BisCore");
+            expect(bisCore).to.not.be.undefined;
+            expect(bisCore.isHidden).to.equal(false);
+        });
+        it("schema with HiddenSchema(ShowClasses=false) is hidden", () => {
+            const schema = view.getSchema("HiddenSchemaDefault");
+            expect(schema).to.not.be.undefined;
+            expect(schema.isHidden).to.equal(true);
+        });
+        it("schema with HiddenSchema(ShowClasses=true) is still hidden", () => {
+            const schema = view.getSchema("HiddenSchemaShowClasses");
+            expect(schema).to.not.be.undefined;
+            expect(schema.isHidden).to.equal(true, "ShowClasses does not affect the schema's own isHidden");
+        });
+    });
+    describe("HiddenClass - tri-state isHidden", () => {
+        it("class in HiddenSchema(ShowClasses=false) without own CA has isHidden=true", () => {
+            const cls = view.findClass("HiddenSchemaDefault:InheritedHiddenElement");
+            expect(cls).to.not.be.undefined;
+            expect(cls.isHidden).to.equal(true, "schema-level propagation bakes into true");
+            expect(cls.isEffectivelyHidden).to.equal(true);
+        });
+        it("class in HiddenSchema(ShowClasses=true) without own CA has isHidden=undefined", () => {
+            const cls = view.findClass("HiddenSchemaShowClasses:ShownElement");
+            expect(cls).to.not.be.undefined;
+            expect(cls.isHidden).to.equal(undefined, "ShowClasses=true means no schema propagation");
+            expect(cls.isEffectivelyHidden).to.equal(false);
+        });
+        it("class with HiddenClass(Show=false) has isHidden=true", () => {
+            const cls = view.findClass("HiddenClassPropSchema:HiddenBase");
+            expect(cls).to.not.be.undefined;
+            expect(cls.isHidden).to.equal(true);
+            expect(cls.isEffectivelyHidden).to.equal(true);
+        });
+        it("class with HiddenClass(Show=true) has isHidden=false (explicitly shown)", () => {
+            const cls = view.findClass("HiddenClassPropSchema:ShownClassElement");
+            expect(cls).to.not.be.undefined;
+            expect(cls.isHidden).to.equal(false, "explicit Show=true produces false");
+            expect(cls.isEffectivelyHidden).to.equal(false);
+        });
+        it("class without any HiddenClass CA in visible schema has isHidden=undefined", () => {
+            const cls = view.findClass("HiddenClassPropSchema:VisibleElement");
+            expect(cls).to.not.be.undefined;
+            expect(cls.isHidden).to.equal(undefined);
+            expect(cls.isEffectivelyHidden).to.equal(false);
+        });
+        it("HiddenClass(Show=true) in HiddenSchema(ShowClasses=false) produces isHidden=false", () => {
+            const cls = view.findClass("HiddenSchemaClassOverride:OverriddenShownElement");
+            expect(cls).to.not.be.undefined;
+            expect(cls.isHidden).to.equal(false, "explicit Show=true overrides schema propagation");
+            expect(cls.isEffectivelyHidden).to.equal(false);
+        });
+        it("class without HiddenClass in HiddenSchema(ShowClasses=false) has isHidden=true", () => {
+            const cls = view.findClass("HiddenSchemaClassOverride:StillHiddenElement");
+            expect(cls).to.not.be.undefined;
+            expect(cls.isHidden).to.equal(true);
+            expect(cls.isEffectivelyHidden).to.equal(true);
+        });
+    });
+    describe("isEffectivelyHidden - base class inheritance", () => {
+        it("derived class with no CA inherits effectively hidden from hidden base", () => {
+            const cls = view.findClass("HiddenClassPropSchema:DerivedNoCA");
+            expect(cls).to.not.be.undefined;
+            expect(cls.isHidden).to.equal(undefined, "no own CA");
+            expect(cls.isEffectivelyHidden).to.equal(true, "walks up to hidden base");
+        });
+        it("derived class with HiddenClass(Show=true) breaks the inheritance chain", () => {
+            const cls = view.findClass("HiddenClassPropSchema:DerivedShown");
+            expect(cls).to.not.be.undefined;
+            expect(cls.isHidden).to.equal(false);
+            expect(cls.isEffectivelyHidden).to.equal(false, "Show=true breaks the chain");
+        });
+        it("class derived from explicitly shown class is NOT effectively hidden", () => {
+            const cls = view.findClass("HiddenClassPropSchema:DerivedFromShown");
+            expect(cls).to.not.be.undefined;
+            expect(cls.isHidden).to.equal(undefined, "no own CA");
+            expect(cls.isEffectivelyHidden).to.equal(false, "Show=true on ancestor breaks the chain");
+        });
+    });
+    describe("HiddenProperty", () => {
+        it("property with HiddenProperty(Show=false) is hidden", () => {
+            const cls = view.findClass("HiddenClassPropSchema:HiddenBase");
+            expect(cls).to.not.be.undefined;
+            const prop = cls.getProperty("HiddenProp");
+            expect(prop).to.not.be.undefined;
+            expect(prop.isHidden).to.equal(true);
+        });
+        it("property with HiddenProperty(Show=true) is NOT hidden", () => {
+            const cls = view.findClass("HiddenClassPropSchema:HiddenBase");
+            expect(cls).to.not.be.undefined;
+            const prop = cls.getProperty("ShownProp");
+            expect(prop).to.not.be.undefined;
+            expect(prop.isHidden).to.equal(false, "HiddenProperty with Show=true should override");
+        });
+        it("property without HiddenProperty CA is not hidden", () => {
+            const cls = view.findClass("HiddenClassPropSchema:HiddenBase");
+            expect(cls).to.not.be.undefined;
+            const prop = cls.getProperty("NormalProp");
+            expect(prop).to.not.be.undefined;
+            expect(prop.isHidden).to.equal(false);
+        });
+    });
+});
+//# sourceMappingURL=SchemaViewHidden.test.js.map

package/lib/esm/test/schema/SchemaViewHidden.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaViewHidden.test.js","sourceRoot":"","sources":["../../../../src/test/schema/SchemaViewHidden.test.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAE5D,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC;;;;;;;;;;;;;;GAcG;AACH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACvC,MAAM,CAAC,KAAK,IAAI,EAAE;QAChB,IAAI,CAAC,UAAU,CAAC,OAAO;YACrB,MAAM,SAAS,CAAC,YAAY,EAAE,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,wFAAwF;IACxF,MAAM,mBAAmB,GAAG;;;;;;;;;;;;;gBAad,CAAC;IAEf,8EAA8E;IAC9E,MAAM,uBAAuB,GAAG;;;;;;;;;;;;;gBAalB,CAAC;IAEf,2FAA2F;IAC3F,MAAM,6BAA6B,GAAG;;;;;;;;;;;;;;;;;;;;;;gBAsBxB,CAAC;IAEf,8EAA8E;IAC9E,kFAAkF;IAClF,MAAM,4BAA4B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAsDvB,CAAC;IAEf,yCAAyC;IACzC,MAAM,iBAAiB,GAAG;;;;;;;gBAOZ,CAAC;IAEf,IAAI,MAAkB,CAAC;IACvB,IAAI,IAAgB,CAAC;IAErB,MAAM,CAAC,KAAK,IAAI,EAAE;QAChB,MAAM,YAAY,GAAG,eAAe,CAAC,iBAAiB,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,CAAC;QAC9F,MAAM,GAAG,UAAU,CAAC,WAAW,CAAC,YAAY,EAAE,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE,EAAE,CAAC,CAAC;QAC5F,MAAM,MAAM,CAAC,mBAAmB,CAAC;YAC/B,mBAAmB;YACnB,uBAAuB;YACvB,6BAA6B;YAC7B,4BAA4B;YAC5B,iBAAiB;SAClB,CAAC,CAAC;QACH,IAAI,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,GAAG,EAAE;QACT,IAAI,MAAM,EAAE,MAAM;YAChB,MAAM,CAAC,KAAK,EAAE,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;YACnD,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YACnC,MAAM,CAAC,MAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAEzC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;YAC1C,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YACpC,MAAM,CAAC,OAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YACnC,MAAM,CAAC,MAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;YACpE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC;YACzD,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YACnC,MAAM,CAAC,MAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,uDAAuD,CAAC,CAAC;QACnG,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAChD,EAAE,CAAC,2EAA2E,EAAE,GAAG,EAAE;YACnF,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,4CAA4C,CAAC,CAAC;YACzE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YAChC,MAAM,CAAC,GAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,0CAA0C,CAAC,CAAC;YACjF,MAAM,CAAC,GAAI,CAAC,mBAAmB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+EAA+E,EAAE,GAAG,EAAE;YACvF,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,sCAAsC,CAAC,CAAC;YACnE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YAChC,MAAM,CAAC,GAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,8CAA8C,CAAC,CAAC;YAC1F,MAAM,CAAC,GAAI,CAAC,mBAAmB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;YAC9D,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;YAC/D,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YAChC,MAAM,CAAC,GAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACrC,MAAM,CAAC,GAAI,CAAC,mBAAmB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yEAAyE,EAAE,GAAG,EAAE;YACjF,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,yCAAyC,CAAC,CAAC;YACtE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YAChC,MAAM,CAAC,GAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,mCAAmC,CAAC,CAAC;YAC3E,MAAM,CAAC,GAAI,CAAC,mBAAmB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2EAA2E,EAAE,GAAG,EAAE;YACnF,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,sCAAsC,CAAC,CAAC;YACnE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YAChC,MAAM,CAAC,GAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAC1C,MAAM,CAAC,GAAI,CAAC,mBAAmB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mFAAmF,EAAE,GAAG,EAAE;YAC3F,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,kDAAkD,CAAC,CAAC;YAC/E,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YAChC,MAAM,CAAC,GAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,iDAAiD,CAAC,CAAC;YACzF,MAAM,CAAC,GAAI,CAAC,mBAAmB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gFAAgF,EAAE,GAAG,EAAE;YACxF,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,8CAA8C,CAAC,CAAC;YAC3E,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YAChC,MAAM,CAAC,GAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACrC,MAAM,CAAC,GAAI,CAAC,mBAAmB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,8CAA8C,EAAE,GAAG,EAAE;QAC5D,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;YAC/E,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,mCAAmC,CAAC,CAAC;YAChE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YAChC,MAAM,CAAC,GAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YACvD,MAAM,CAAC,GAAI,CAAC,mBAAmB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,yBAAyB,CAAC,CAAC;QAC7E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;YAChF,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,oCAAoC,CAAC,CAAC;YACjE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YAChC,MAAM,CAAC,GAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACtC,MAAM,CAAC,GAAI,CAAC,mBAAmB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,4BAA4B,CAAC,CAAC;QACjF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qEAAqE,EAAE,GAAG,EAAE;YAC7E,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,wCAAwC,CAAC,CAAC;YACrE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YAChC,MAAM,CAAC,GAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YACvD,MAAM,CAAC,GAAI,CAAC,mBAAmB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,wCAAwC,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC5D,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;YAC/D,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YAChC,MAAM,IAAI,GAAG,GAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YAC5C,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YACjC,MAAM,CAAC,IAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;YAC/D,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YAChC,MAAM,IAAI,GAAG,GAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;YAC3C,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YACjC,MAAM,CAAC,IAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,+CAA+C,CAAC,CAAC;QAC1F,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;YAC/D,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YAChC,MAAM,IAAI,GAAG,GAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YAC5C,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;YACjC,MAAM,CAAC,IAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport { IModelHost, SnapshotDb } from \"../../core-backend\";\r\nimport type { SchemaView } from \"@itwin/ecschema-metadata\";\r\nimport { expect } from \"chai\";\r\nimport { IModelTestUtils } from \"../IModelTestUtils\";\r\nimport { TestUtils } from \"../TestUtils\";\r\n\r\n/**\r\n * Tests for the Hidden* custom attributes from CoreCustomAttributes, verifying that SchemaView\r\n * correctly exposes the tri-state `isHidden` (true/false/undefined) on classes and the boolean\r\n * `isHidden` on schemas and properties. Also tests `isEffectivelyHidden` which walks the base\r\n * class chain (not mixins) and stops at explicit `isHidden === false` overrides.\r\n *\r\n * Class `isHidden` values:\r\n * - `true`:      hidden via `HiddenClass(Show!=true)` or schema-level `HiddenSchema(ShowClasses!=true)`\r\n * - `false`:     explicitly shown via `HiddenClass(Show=true)` - breaks inheritance chain\r\n * - `undefined`: no `HiddenClass` CA, schema doesn't hide classes - neutral, defers to base class\r\n *\r\n * Binary format: classes serialize this as a single byte (0=undefined, 1=true, 2=false).\r\n * Schema-level class propagation from `HiddenSchema(ShowClasses!=true)` is pre-resolved\r\n * into each class's isHidden at serialization time.\r\n */\r\ndescribe(\"SchemaView hidden flags\", () => {\r\n  before(async () => {\r\n    if (!IModelHost.isValid)\r\n      await TestUtils.startBackend();\r\n  });\r\n\r\n  // Schema with HiddenSchema(ShowClasses=false) - schema AND all classes should be hidden\r\n  const hiddenSchemaDefault = `<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n    <ECSchema schemaName=\"HiddenSchemaDefault\" alias=\"hsd\" version=\"01.00.00\" xmlns=\"http://www.bentley.com/schemas/Bentley.ECXML.3.2\">\r\n      <ECSchemaReference name=\"BisCore\" version=\"01.00.00\" alias=\"bis\"/>\r\n      <ECSchemaReference name=\"CoreCustomAttributes\" version=\"01.00.00\" alias=\"CoreCA\"/>\r\n      <ECCustomAttributes>\r\n        <HiddenSchema xmlns=\"CoreCustomAttributes.01.00.00\">\r\n          <ShowClasses>false</ShowClasses>\r\n        </HiddenSchema>\r\n      </ECCustomAttributes>\r\n      <ECEntityClass typeName=\"InheritedHiddenElement\" modifier=\"Sealed\">\r\n        <BaseClass>bis:PhysicalElement</BaseClass>\r\n        <ECProperty propertyName=\"SomeProp\" typeName=\"string\"/>\r\n      </ECEntityClass>\r\n    </ECSchema>`;\r\n\r\n  // Schema with HiddenSchema(ShowClasses=true) - schema hidden, classes are NOT\r\n  const hiddenSchemaShowClasses = `<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n    <ECSchema schemaName=\"HiddenSchemaShowClasses\" alias=\"hssc\" version=\"01.00.00\" xmlns=\"http://www.bentley.com/schemas/Bentley.ECXML.3.2\">\r\n      <ECSchemaReference name=\"BisCore\" version=\"01.00.00\" alias=\"bis\"/>\r\n      <ECSchemaReference name=\"CoreCustomAttributes\" version=\"01.00.00\" alias=\"CoreCA\"/>\r\n      <ECCustomAttributes>\r\n        <HiddenSchema xmlns=\"CoreCustomAttributes.01.00.00\">\r\n          <ShowClasses>true</ShowClasses>\r\n        </HiddenSchema>\r\n      </ECCustomAttributes>\r\n      <ECEntityClass typeName=\"ShownElement\" modifier=\"Sealed\">\r\n        <BaseClass>bis:PhysicalElement</BaseClass>\r\n        <ECProperty propertyName=\"SomeProp\" typeName=\"string\"/>\r\n      </ECEntityClass>\r\n    </ECSchema>`;\r\n\r\n  // Schema with HiddenSchema(ShowClasses=false) + class with HiddenClass(Show=true) override\r\n  const hiddenSchemaWithClassOverride = `<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n    <ECSchema schemaName=\"HiddenSchemaClassOverride\" alias=\"hsco\" version=\"01.00.00\" xmlns=\"http://www.bentley.com/schemas/Bentley.ECXML.3.2\">\r\n      <ECSchemaReference name=\"BisCore\" version=\"01.00.00\" alias=\"bis\"/>\r\n      <ECSchemaReference name=\"CoreCustomAttributes\" version=\"01.00.00\" alias=\"CoreCA\"/>\r\n      <ECCustomAttributes>\r\n        <HiddenSchema xmlns=\"CoreCustomAttributes.01.00.00\">\r\n          <ShowClasses>false</ShowClasses>\r\n        </HiddenSchema>\r\n      </ECCustomAttributes>\r\n      <ECEntityClass typeName=\"OverriddenShownElement\" modifier=\"Sealed\">\r\n        <BaseClass>bis:PhysicalElement</BaseClass>\r\n        <ECCustomAttributes>\r\n          <HiddenClass xmlns=\"CoreCustomAttributes.01.00.00\">\r\n            <Show>true</Show>\r\n          </HiddenClass>\r\n        </ECCustomAttributes>\r\n        <ECProperty propertyName=\"SomeProp\" typeName=\"string\"/>\r\n      </ECEntityClass>\r\n      <ECEntityClass typeName=\"StillHiddenElement\" modifier=\"Sealed\">\r\n        <BaseClass>bis:PhysicalElement</BaseClass>\r\n        <ECProperty propertyName=\"SomeProp\" typeName=\"string\"/>\r\n      </ECEntityClass>\r\n    </ECSchema>`;\r\n\r\n  // Schema with class-level and property-level hidden flags and Show overrides.\r\n  // Also includes a non-sealed hidden base class to test derived class inheritance.\r\n  const hiddenClassAndPropertySchema = `<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n    <ECSchema schemaName=\"HiddenClassPropSchema\" alias=\"hcps\" version=\"01.00.00\" xmlns=\"http://www.bentley.com/schemas/Bentley.ECXML.3.2\">\r\n      <ECSchemaReference name=\"BisCore\" version=\"01.00.00\" alias=\"bis\"/>\r\n      <ECSchemaReference name=\"CoreCustomAttributes\" version=\"01.00.00\" alias=\"CoreCA\"/>\r\n      <ECEntityClass typeName=\"HiddenBase\" modifier=\"Abstract\">\r\n        <BaseClass>bis:PhysicalElement</BaseClass>\r\n        <ECCustomAttributes>\r\n          <HiddenClass xmlns=\"CoreCustomAttributes.01.00.00\">\r\n            <Show>false</Show>\r\n          </HiddenClass>\r\n        </ECCustomAttributes>\r\n        <ECProperty propertyName=\"HiddenProp\" typeName=\"string\">\r\n          <ECCustomAttributes>\r\n            <HiddenProperty xmlns=\"CoreCustomAttributes.01.00.00\">\r\n              <Show>false</Show>\r\n            </HiddenProperty>\r\n          </ECCustomAttributes>\r\n        </ECProperty>\r\n        <ECProperty propertyName=\"ShownProp\" typeName=\"string\">\r\n          <ECCustomAttributes>\r\n            <HiddenProperty xmlns=\"CoreCustomAttributes.01.00.00\">\r\n              <Show>true</Show>\r\n            </HiddenProperty>\r\n          </ECCustomAttributes>\r\n        </ECProperty>\r\n        <ECProperty propertyName=\"NormalProp\" typeName=\"string\"/>\r\n      </ECEntityClass>\r\n      <ECEntityClass typeName=\"DerivedNoCA\" modifier=\"Sealed\" description=\"Derived from hidden base, no HiddenClass CA - should inherit hidden via isEffectivelyHidden\">\r\n        <BaseClass>HiddenBase</BaseClass>\r\n      </ECEntityClass>\r\n      <ECEntityClass typeName=\"DerivedShown\" description=\"Derived from hidden base, HiddenClass(Show=true) breaks the chain\">\r\n        <BaseClass>HiddenBase</BaseClass>\r\n        <ECCustomAttributes>\r\n          <HiddenClass xmlns=\"CoreCustomAttributes.01.00.00\">\r\n            <Show>true</Show>\r\n          </HiddenClass>\r\n        </ECCustomAttributes>\r\n      </ECEntityClass>\r\n      <ECEntityClass typeName=\"DerivedFromShown\" modifier=\"Sealed\" description=\"Derived from explicitly shown class, no CA - should NOT be effectively hidden\">\r\n        <BaseClass>DerivedShown</BaseClass>\r\n      </ECEntityClass>\r\n      <ECEntityClass typeName=\"ShownClassElement\" modifier=\"Sealed\">\r\n        <BaseClass>bis:PhysicalElement</BaseClass>\r\n        <ECCustomAttributes>\r\n          <HiddenClass xmlns=\"CoreCustomAttributes.01.00.00\">\r\n            <Show>true</Show>\r\n          </HiddenClass>\r\n        </ECCustomAttributes>\r\n        <ECProperty propertyName=\"SomeProp\" typeName=\"int\"/>\r\n      </ECEntityClass>\r\n      <ECEntityClass typeName=\"VisibleElement\" modifier=\"Sealed\">\r\n        <BaseClass>bis:PhysicalElement</BaseClass>\r\n        <ECProperty propertyName=\"SomeProp\" typeName=\"int\"/>\r\n      </ECEntityClass>\r\n    </ECSchema>`;\r\n\r\n  // Visible schema for baseline comparison\r\n  const visibleTestSchema = `<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n    <ECSchema schemaName=\"VisibleTestSchema\" alias=\"vts\" version=\"01.00.00\" xmlns=\"http://www.bentley.com/schemas/Bentley.ECXML.3.2\">\r\n      <ECSchemaReference name=\"BisCore\" version=\"01.00.00\" alias=\"bis\"/>\r\n      <ECEntityClass typeName=\"NormalElement\" modifier=\"Sealed\">\r\n        <BaseClass>bis:PhysicalElement</BaseClass>\r\n        <ECProperty propertyName=\"NormalProp\" typeName=\"string\"/>\r\n      </ECEntityClass>\r\n    </ECSchema>`;\r\n\r\n  let iModel: SnapshotDb;\r\n  let view: SchemaView;\r\n\r\n  before(async () => {\r\n    const testFileName = IModelTestUtils.prepareOutputFile(\"SchemaViewHidden\", \"HiddenFlags.bim\");\r\n    iModel = SnapshotDb.createEmpty(testFileName, { rootSubject: { name: \"HiddenFlagsTest\" } });\r\n    await iModel.importSchemaStrings([\r\n      hiddenSchemaDefault,\r\n      hiddenSchemaShowClasses,\r\n      hiddenSchemaWithClassOverride,\r\n      hiddenClassAndPropertySchema,\r\n      visibleTestSchema,\r\n    ]);\r\n    view = await iModel.getSchemaView();\r\n  });\r\n\r\n  after(() => {\r\n    if (iModel?.isOpen)\r\n      iModel.close();\r\n  });\r\n\r\n  describe(\"HiddenSchema\", () => {\r\n    it(\"schema without HiddenSchema CA is not hidden\", () => {\r\n      const schema = view.getSchema(\"VisibleTestSchema\");\r\n      expect(schema).to.not.be.undefined;\r\n      expect(schema!.isHidden).to.equal(false);\r\n\r\n      const bisCore = view.getSchema(\"BisCore\");\r\n      expect(bisCore).to.not.be.undefined;\r\n      expect(bisCore!.isHidden).to.equal(false);\r\n    });\r\n\r\n    it(\"schema with HiddenSchema(ShowClasses=false) is hidden\", () => {\r\n      const schema = view.getSchema(\"HiddenSchemaDefault\");\r\n      expect(schema).to.not.be.undefined;\r\n      expect(schema!.isHidden).to.equal(true);\r\n    });\r\n\r\n    it(\"schema with HiddenSchema(ShowClasses=true) is still hidden\", () => {\r\n      const schema = view.getSchema(\"HiddenSchemaShowClasses\");\r\n      expect(schema).to.not.be.undefined;\r\n      expect(schema!.isHidden).to.equal(true, \"ShowClasses does not affect the schema's own isHidden\");\r\n    });\r\n  });\r\n\r\n  describe(\"HiddenClass - tri-state isHidden\", () => {\r\n    it(\"class in HiddenSchema(ShowClasses=false) without own CA has isHidden=true\", () => {\r\n      const cls = view.findClass(\"HiddenSchemaDefault:InheritedHiddenElement\");\r\n      expect(cls).to.not.be.undefined;\r\n      expect(cls!.isHidden).to.equal(true, \"schema-level propagation bakes into true\");\r\n      expect(cls!.isEffectivelyHidden).to.equal(true);\r\n    });\r\n\r\n    it(\"class in HiddenSchema(ShowClasses=true) without own CA has isHidden=undefined\", () => {\r\n      const cls = view.findClass(\"HiddenSchemaShowClasses:ShownElement\");\r\n      expect(cls).to.not.be.undefined;\r\n      expect(cls!.isHidden).to.equal(undefined, \"ShowClasses=true means no schema propagation\");\r\n      expect(cls!.isEffectivelyHidden).to.equal(false);\r\n    });\r\n\r\n    it(\"class with HiddenClass(Show=false) has isHidden=true\", () => {\r\n      const cls = view.findClass(\"HiddenClassPropSchema:HiddenBase\");\r\n      expect(cls).to.not.be.undefined;\r\n      expect(cls!.isHidden).to.equal(true);\r\n      expect(cls!.isEffectivelyHidden).to.equal(true);\r\n    });\r\n\r\n    it(\"class with HiddenClass(Show=true) has isHidden=false (explicitly shown)\", () => {\r\n      const cls = view.findClass(\"HiddenClassPropSchema:ShownClassElement\");\r\n      expect(cls).to.not.be.undefined;\r\n      expect(cls!.isHidden).to.equal(false, \"explicit Show=true produces false\");\r\n      expect(cls!.isEffectivelyHidden).to.equal(false);\r\n    });\r\n\r\n    it(\"class without any HiddenClass CA in visible schema has isHidden=undefined\", () => {\r\n      const cls = view.findClass(\"HiddenClassPropSchema:VisibleElement\");\r\n      expect(cls).to.not.be.undefined;\r\n      expect(cls!.isHidden).to.equal(undefined);\r\n      expect(cls!.isEffectivelyHidden).to.equal(false);\r\n    });\r\n\r\n    it(\"HiddenClass(Show=true) in HiddenSchema(ShowClasses=false) produces isHidden=false\", () => {\r\n      const cls = view.findClass(\"HiddenSchemaClassOverride:OverriddenShownElement\");\r\n      expect(cls).to.not.be.undefined;\r\n      expect(cls!.isHidden).to.equal(false, \"explicit Show=true overrides schema propagation\");\r\n      expect(cls!.isEffectivelyHidden).to.equal(false);\r\n    });\r\n\r\n    it(\"class without HiddenClass in HiddenSchema(ShowClasses=false) has isHidden=true\", () => {\r\n      const cls = view.findClass(\"HiddenSchemaClassOverride:StillHiddenElement\");\r\n      expect(cls).to.not.be.undefined;\r\n      expect(cls!.isHidden).to.equal(true);\r\n      expect(cls!.isEffectivelyHidden).to.equal(true);\r\n    });\r\n  });\r\n\r\n  describe(\"isEffectivelyHidden - base class inheritance\", () => {\r\n    it(\"derived class with no CA inherits effectively hidden from hidden base\", () => {\r\n      const cls = view.findClass(\"HiddenClassPropSchema:DerivedNoCA\");\r\n      expect(cls).to.not.be.undefined;\r\n      expect(cls!.isHidden).to.equal(undefined, \"no own CA\");\r\n      expect(cls!.isEffectivelyHidden).to.equal(true, \"walks up to hidden base\");\r\n    });\r\n\r\n    it(\"derived class with HiddenClass(Show=true) breaks the inheritance chain\", () => {\r\n      const cls = view.findClass(\"HiddenClassPropSchema:DerivedShown\");\r\n      expect(cls).to.not.be.undefined;\r\n      expect(cls!.isHidden).to.equal(false);\r\n      expect(cls!.isEffectivelyHidden).to.equal(false, \"Show=true breaks the chain\");\r\n    });\r\n\r\n    it(\"class derived from explicitly shown class is NOT effectively hidden\", () => {\r\n      const cls = view.findClass(\"HiddenClassPropSchema:DerivedFromShown\");\r\n      expect(cls).to.not.be.undefined;\r\n      expect(cls!.isHidden).to.equal(undefined, \"no own CA\");\r\n      expect(cls!.isEffectivelyHidden).to.equal(false, \"Show=true on ancestor breaks the chain\");\r\n    });\r\n  });\r\n\r\n  describe(\"HiddenProperty\", () => {\r\n    it(\"property with HiddenProperty(Show=false) is hidden\", () => {\r\n      const cls = view.findClass(\"HiddenClassPropSchema:HiddenBase\");\r\n      expect(cls).to.not.be.undefined;\r\n      const prop = cls!.getProperty(\"HiddenProp\");\r\n      expect(prop).to.not.be.undefined;\r\n      expect(prop!.isHidden).to.equal(true);\r\n    });\r\n\r\n    it(\"property with HiddenProperty(Show=true) is NOT hidden\", () => {\r\n      const cls = view.findClass(\"HiddenClassPropSchema:HiddenBase\");\r\n      expect(cls).to.not.be.undefined;\r\n      const prop = cls!.getProperty(\"ShownProp\");\r\n      expect(prop).to.not.be.undefined;\r\n      expect(prop!.isHidden).to.equal(false, \"HiddenProperty with Show=true should override\");\r\n    });\r\n\r\n    it(\"property without HiddenProperty CA is not hidden\", () => {\r\n      const cls = view.findClass(\"HiddenClassPropSchema:HiddenBase\");\r\n      expect(cls).to.not.be.undefined;\r\n      const prop = cls!.getProperty(\"NormalProp\");\r\n      expect(prop).to.not.be.undefined;\r\n      expect(prop!.isHidden).to.equal(false);\r\n    });\r\n  });\r\n});\r\n"]}

package/lib/esm/test/schema/SchemaViewKoQ.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=SchemaViewKoQ.test.d.ts.map

package/lib/esm/test/schema/SchemaViewKoQ.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaViewKoQ.test.d.ts","sourceRoot":"","sources":["../../../../src/test/schema/SchemaViewKoQ.test.ts"],"names":[],"mappings":""}

package/lib/esm/test/schema/SchemaViewKoQ.test.js

@@ -0,0 +1,175 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { IModelHost, SnapshotDb } from "../../core-backend";
+import { Format, KindOfQuantity, SchemaUnitProvider, Unit } from "@itwin/ecschema-metadata";
+import { QueryBinder, QueryRowFormat } from "@itwin/core-common";
+import { assert, expect } from "chai";
+import * as path from "path";
+import { KnownTestLocations } from "../KnownTestLocations";
+import { TestUtils } from "../TestUtils";
+/**
+ * Example-style tests showing how to access KindOfQuantity presentation formats
+ * through SchemaView and resolve the alias-qualified format/unit names
+ * into full schema items via ecschema-metadata or ECSQL.
+ *
+ * Uses sim-master.bim which contains schemas with rich KoQ definitions
+ * (AecUnits, RoadRailUnits, LinearReferencing, etc.).
+ */
+describe("SchemaView KindOfQuantity presentation formats", () => {
+    let iModel;
+    let schemaView;
+    before(async () => {
+        if (!IModelHost.isValid)
+            await TestUtils.startBackend();
+        iModel = SnapshotDb.openFile(path.join(KnownTestLocations.assetsDir, "sim-master.bim"));
+        schemaView = await iModel.getSchemaView();
+    });
+    after(() => {
+        iModel.close();
+    });
+    /**
+     * Example: get a property's KoQ from SchemaView, then resolve the
+     * alias-qualified format and unit names to full ecschema-metadata objects via
+     * IModelDb.schemaContext.
+     *
+     * SchemaView uses alias-qualified names (e.g. "f:DefaultRealU", "u:M")
+     * because the Units and Formats schemas are excluded from the SchemaView blob.
+     * The alias ("f" -> "Formats", "u" -> "Units") is stored in ec_Schema, so we
+     * can resolve it using the schema context that has the full schema set.
+     */
+    it("should resolve KoQ format and unit names via ecschema-metadata", async () => {
+        // --- Step 1: find a property with a KoQ via SchemaView ---
+        const rClass = schemaView.findClass("LinearReferencing:DistanceExpression");
+        assert.isDefined(rClass, "DistanceExpression class not found");
+        const rProp = rClass.getProperty("DistanceAlongFromStart");
+        assert.isDefined(rProp, "DistanceAlongFromStart property not found");
+        const prop = rProp;
+        if (!prop.isPrimitive())
+            throw new Error("expected primitive");
+        const rKoq = prop.kindOfQuantity;
+        assert.isDefined(rKoq, "property should have a KoQ");
+        // --- Step 2: inspect parsed presentation formats ---
+        const formats = rKoq.presentationFormats;
+        expect(formats.length).to.be.greaterThan(0, "KoQ should have presentation formats");
+        // LinearReferencing:LENGTH has: f:DefaultRealU(2)[u:M], f:DefaultRealU(2)[u:FT]
+        const first = formats[0];
+        expect(first.name).to.equal("f:DefaultRealU");
+        expect(first.precision).to.equal(2);
+        expect(first.unitAndLabels).to.have.length(1);
+        expect(first.unitAndLabels[0][0]).to.equal("u:M");
+        // --- Step 3: resolve alias names to full schema items via schemaContext ---
+        // The Formats and Units schemas are excluded from SchemaView,
+        // but IModelDb.schemaContext (ecschema-metadata) has the full set.
+        // Alias "f" -> "Formats", alias "u" -> "Units" - these are standard BIS aliases.
+        // Resolve the format: "f:DefaultRealU" -> "Formats.DefaultRealU"
+        const formatFullName = `Formats.${first.name.split(":")[1]}`;
+        const metaFormat = iModel.schemaContext.getSchemaItemSync(formatFullName, Format);
+        assert.isDefined(metaFormat, `Format '${formatFullName}' not found in ecschema-metadata`);
+        expect(metaFormat.precision).to.be.a("number");
+        // Resolve the unit: "u:M" -> "Units.M"
+        const unitFullName = `Units.${first.unitAndLabels[0][0].split(":")[1]}`;
+        const metaUnit = iModel.schemaContext.getSchemaItemSync(unitFullName, Unit);
+        assert.isDefined(metaUnit, `Unit '${unitFullName}' not found in ecschema-metadata`);
+        expect(metaUnit.fullName).to.equal("Units.M");
+        // Access unit details like label and unit system
+        const unitSystem = await metaUnit.unitSystem;
+        assert.isDefined(unitSystem, "unit should have a unit system");
+        expect(unitSystem.name).to.equal("SI");
+        // --- Step 4: cross-validate against the KoQ in ecschema-metadata ---
+        const metaKoq = iModel.schemaContext.getSchemaItemSync("LinearReferencing", "LENGTH", KindOfQuantity);
+        assert.isDefined(metaKoq, "KoQ not found in ecschema-metadata");
+        expect(metaKoq.relativeError).to.equal(rKoq.relativeError);
+        const metaFormats = metaKoq.presentationFormats;
+        expect(metaFormats.length).to.equal(formats.length);
+        // ecschema-metadata resolves the formats fully - cross-check the format names.
+        // OverrideFormat.fullName includes override syntax (e.g. "Formats.DefaultRealU(2)[Units.M]"),
+        // so strip the override portion before extracting the base name.
+        for (let i = 0; i < formats.length; i++) {
+            const rtItemName = formats[i].name.split(":")[1];
+            const metaBaseFullName = metaFormats[i].fullName.split(/[([]/)[0];
+            const metaItemName = metaBaseFullName.split(".").pop();
+            expect(rtItemName).to.equal(metaItemName, `format name mismatch at index ${i}`);
+        }
+        // The SchemaUnitProvider bridges ecschema-metadata units to the @itwin/core-quantity package.
+        // Use it to build a FormatterSpec for quantity formatting:
+        const unitsProvider = new SchemaUnitProvider(iModel.schemaContext);
+        const persistenceUnitProps = await unitsProvider.findUnitByName("Units.M");
+        expect(persistenceUnitProps.name).to.equal("Units.M");
+    });
+    /**
+     * Example: get a KoQ from SchemaView, then query ECDbMeta via ECSQL
+     * to resolve the referenced format and unit definitions.
+     *
+     * This approach avoids loading the full ecschema-metadata schema set and works
+     * well for targeted lookups - e.g. "I have a format name, give me its NumericSpec."
+     */
+    it("should resolve KoQ format and unit names via ECSQL", async () => {
+        // --- Step 1: find a KoQ via SchemaView ---
+        const rKoq = schemaView.findKindOfQuantity("LinearReferencing:LENGTH");
+        assert.isDefined(rKoq, "KoQ not found in SchemaView");
+        const formats = rKoq.presentationFormats;
+        expect(formats.length).to.be.greaterThan(0);
+        // --- Step 2: resolve the format name via meta.FormatDef ---
+        // "f:DefaultRealU" -> format name is "DefaultRealU" in the "Formats" schema
+        const first = formats[0];
+        const formatItemName = first.name.split(":")[1]; // "DefaultRealU"
+        // Query FormatDef to get the format's NumericSpec (= FormatProps JSON)
+        let formatNumericSpec;
+        for await (const row of iModel.createQueryReader(`SELECT f.NumericSpec, f.CompositeSpec
+       FROM meta.FormatDef f
+       JOIN meta.ECSchemaDef s USING meta.SchemaOwnsFormats
+       WHERE f.Name = ? AND s.Name = 'Formats'`, QueryBinder.from([formatItemName]), { rowFormat: QueryRowFormat.UseJsPropertyNames })) {
+            formatNumericSpec = row.toRow();
+        }
+        assert.isDefined(formatNumericSpec, `FormatDef '${formatItemName}' not found via ECSQL`);
+        // NumericSpec is a JSON string with the format properties (type, precision, traits, etc.)
+        const numericSpec = JSON.parse(formatNumericSpec.numericSpec);
+        expect(numericSpec.type).to.equal("Decimal");
+        expect(numericSpec.precision).to.be.a("number");
+        // The presentation format can override precision - e.g. the override "(2)" means precision 2
+        if (first.precision !== undefined)
+            expect(first.precision).to.equal(2); // our override
+        // --- Step 3: resolve the unit name via meta.UnitDef ---
+        // "u:M" -> unit name is "M" in the "Units" schema
+        const unitItemName = first.unitAndLabels[0][0].split(":")[1]; // "M"
+        let unitRow;
+        for await (const row of iModel.createQueryReader(`SELECT u.Name, u.DisplayLabel, us.Name AS unitSystemName
+       FROM meta.UnitDef u
+       JOIN meta.ECSchemaDef s USING meta.SchemaOwnsUnits
+       JOIN meta.UnitSystemDef us USING meta.UnitSystemHasUnits
+       WHERE u.Name = ? AND s.Name = 'Units'`, QueryBinder.from([unitItemName]), { rowFormat: QueryRowFormat.UseJsPropertyNames })) {
+            unitRow = row.toRow();
+        }
+        assert.isDefined(unitRow, `UnitDef '${unitItemName}' not found via ECSQL`);
+        expect(unitRow.name).to.equal("M");
+        expect(unitRow.unitSystemName).to.equal("SI");
+        // --- Step 4: query the format's composite units (base format units, before overrides) ---
+        // DefaultRealU has no composite units (it's a single-unit format), but AngleDMS does.
+        // Let's also check the second KoQ format which might have composite units.
+        const angleKoq = schemaView.findKindOfQuantity("RoadRailUnits:ANGLE");
+        if (angleKoq) {
+            const angleFormats = angleKoq.presentationFormats;
+            // The AngleDMS format has composite units: ARC_DEG, ARC_MINUTE, ARC_SECOND
+            const dmsFormat = angleFormats.find((f) => f.name.split(":")[1] === "AngleDMS");
+            if (dmsFormat) {
+                const compositeUnits = [];
+                for await (const row of iModel.createQueryReader(`SELECT cu.Ordinal, u.Name AS unitName, cu.Label
+           FROM meta.FormatCompositeUnitDef cu
+           JOIN meta.FormatDef f USING meta.FormatOwnsCompositeUnits
+           JOIN meta.ECSchemaDef s USING meta.SchemaOwnsFormats
+           JOIN meta.UnitDef u USING meta.CompositeUnitRefersToUnit
+           WHERE f.Name = 'AngleDMS' AND s.Name = 'Formats'
+           ORDER BY cu.Ordinal`, undefined, { rowFormat: QueryRowFormat.UseJsPropertyNames })) {
+                    compositeUnits.push(row.toRow());
+                }
+                expect(compositeUnits.length).to.equal(3, "AngleDMS should have 3 composite units");
+                expect(compositeUnits[0].unitName).to.equal("ARC_DEG");
+                expect(compositeUnits[1].unitName).to.equal("ARC_MINUTE");
+                expect(compositeUnits[2].unitName).to.equal("ARC_SECOND");
+            }
+        }
+    });
+});
+//# sourceMappingURL=SchemaViewKoQ.test.js.map

package/lib/esm/test/schema/SchemaViewKoQ.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaViewKoQ.test.js","sourceRoot":"","sources":["../../../../src/test/schema/SchemaViewKoQ.test.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,kBAAkB,EAAmB,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAC7G,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AACtC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC;;;;;;;GAOG;AACH,QAAQ,CAAC,gDAAgD,EAAE,GAAG,EAAE;IAC9D,IAAI,MAAkB,CAAC;IACvB,IAAI,UAAsB,CAAC;IAE3B,MAAM,CAAC,KAAK,IAAI,EAAE;QAChB,IAAI,CAAC,UAAU,CAAC,OAAO;YACrB,MAAM,SAAS,CAAC,YAAY,EAAE,CAAC;QACjC,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC,CAAC;QACxF,UAAU,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,GAAG,EAAE;QACT,MAAM,CAAC,KAAK,EAAE,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH;;;;;;;;;OASG;IACH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,4DAA4D;QAC5D,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,sCAAsC,CAAC,CAAC;QAC5E,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,oCAAoC,CAAC,CAAC;QAE/D,MAAM,KAAK,GAAG,MAAO,CAAC,WAAW,CAAC,wBAAwB,CAAC,CAAC;QAC5D,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,2CAA2C,CAAC,CAAC;QAErE,MAAM,IAAI,GAAG,KAAM,CAAC;QACpB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,4BAA4B,CAAC,CAAC;QAErD,sDAAsD;QACtD,MAAM,OAAO,GAA6C,IAAK,CAAC,mBAAmB,CAAC;QACpF,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,sCAAsC,CAAC,CAAC;QAEpF,gFAAgF;QAChF,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QACzB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAC9C,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC9C,MAAM,CAAC,KAAK,CAAC,aAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAEnD,6EAA6E;QAC7E,8DAA8D;QAC9D,mEAAmE;QACnE,iFAAiF;QAEjF,iEAAiE;QACjE,MAAM,cAAc,GAAG,WAAW,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7D,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;QAClF,MAAM,CAAC,SAAS,CAAC,UAAU,EAAE,WAAW,cAAc,kCAAkC,CAAC,CAAC;QAC1F,MAAM,CAAC,UAAW,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAEhD,uCAAuC;QACvC,MAAM,YAAY,GAAG,SAAS,KAAK,CAAC,aAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACzE,MAAM,QAAQ,GAAG,MAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QAC5E,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAS,YAAY,kCAAkC,CAAC,CAAC;QACpF,MAAM,CAAC,QAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAE/C,iDAAiD;QACjD,MAAM,UAAU,GAAG,MAAM,QAAS,CAAC,UAAU,CAAC;QAC9C,MAAM,CAAC,SAAS,CAAC,UAAU,EAAE,gCAAgC,CAAC,CAAC;QAC/D,MAAM,CAAC,UAAW,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAExC,sEAAsE;QACtE,MAAM,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC,mBAAmB,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC;QACtG,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,oCAAoC,CAAC,CAAC;QAChE,MAAM,CAAC,OAAQ,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAK,CAAC,aAAa,CAAC,CAAC;QAE7D,MAAM,WAAW,GAAG,OAAQ,CAAC,mBAAmB,CAAC;QACjD,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAEpD,+EAA+E;QAC/E,8FAA8F;QAC9F,iEAAiE;QACjE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,MAAM,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YACjD,MAAM,gBAAgB,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YAClE,MAAM,YAAY,GAAG,gBAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;YACvD,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,YAAY,EAAE,iCAAiC,CAAC,EAAE,CAAC,CAAC;QAClF,CAAC;QAED,8FAA8F;QAC9F,2DAA2D;QAC3D,MAAM,aAAa,GAAG,IAAI,kBAAkB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnE,MAAM,oBAAoB,GAAG,MAAM,aAAa,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QAC3E,MAAM,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH;;;;;;OAMG;IACH,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QAClE,4CAA4C;QAC5C,MAAM,IAAI,GAAG,UAAU,CAAC,kBAAkB,CAAC,0BAA0B,CAAC,CAAC;QACvE,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,6BAA6B,CAAC,CAAC;QAEtD,MAAM,OAAO,GAAG,IAAK,CAAC,mBAAmB,CAAC;QAC1C,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QAE5C,6DAA6D;QAC7D,4EAA4E;QAC5E,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QACzB,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB;QAElE,uEAAuE;QACvE,IAAI,iBAAsB,CAAC;QAC3B,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAC9C;;;+CAGyC,EACzC,WAAW,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,CAAC,EAClC,EAAE,SAAS,EAAE,cAAc,CAAC,kBAAkB,EAAE,CACjD,EAAE,CAAC;YACF,iBAAiB,GAAG,GAAG,CAAC,KAAK,EAAE,CAAC;QAClC,CAAC;QACD,MAAM,CAAC,SAAS,CAAC,iBAAiB,EAAE,cAAc,cAAc,uBAAuB,CAAC,CAAC;QAEzF,0FAA0F;QAC1F,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;QAC9D,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC7C,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAEhD,6FAA6F;QAC7F,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS;YAC/B,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe;QAEtD,yDAAyD;QACzD,kDAAkD;QAClD,MAAM,YAAY,GAAG,KAAK,CAAC,aAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM;QAErE,IAAI,OAAY,CAAC;QACjB,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAC9C;;;;6CAIuC,EACvC,WAAW,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,EAChC,EAAE,SAAS,EAAE,cAAc,CAAC,kBAAkB,EAAE,CACjD,EAAE,CAAC;YACF,OAAO,GAAG,GAAG,CAAC,KAAK,EAAE,CAAC;QACxB,CAAC;QACD,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,YAAY,YAAY,uBAAuB,CAAC,CAAC;QAC3E,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAE9C,2FAA2F;QAC3F,sFAAsF;QACtF,2EAA2E;QAC3E,MAAM,QAAQ,GAAG,UAAU,CAAC,kBAAkB,CAAC,qBAAqB,CAAC,CAAC;QACtE,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,YAAY,GAAG,QAAQ,CAAC,mBAAmB,CAAC;YAClD,2EAA2E;YAC3E,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC;YAChF,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,cAAc,GAAgE,EAAE,CAAC;gBACvF,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAC9C;;;;;;+BAMqB,EACrB,SAAS,EACT,EAAE,SAAS,EAAE,cAAc,CAAC,kBAAkB,EAAE,CACjD,EAAE,CAAC;oBACF,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;gBACnC,CAAC;gBACD,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,wCAAwC,CAAC,CAAC;gBACpF,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACvD,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;gBAC1D,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport { IModelHost, SnapshotDb } from \"../../core-backend\";\r\nimport { Format, KindOfQuantity, SchemaUnitProvider, type SchemaView, Unit } from \"@itwin/ecschema-metadata\";\r\nimport { QueryBinder, QueryRowFormat } from \"@itwin/core-common\";\r\nimport { assert, expect } from \"chai\";\r\nimport * as path from \"path\";\r\nimport { KnownTestLocations } from \"../KnownTestLocations\";\r\nimport { TestUtils } from \"../TestUtils\";\r\n\r\n/**\r\n * Example-style tests showing how to access KindOfQuantity presentation formats\r\n * through SchemaView and resolve the alias-qualified format/unit names\r\n * into full schema items via ecschema-metadata or ECSQL.\r\n *\r\n * Uses sim-master.bim which contains schemas with rich KoQ definitions\r\n * (AecUnits, RoadRailUnits, LinearReferencing, etc.).\r\n */\r\ndescribe(\"SchemaView KindOfQuantity presentation formats\", () => {\r\n  let iModel: SnapshotDb;\r\n  let schemaView: SchemaView;\r\n\r\n  before(async () => {\r\n    if (!IModelHost.isValid)\r\n      await TestUtils.startBackend();\r\n    iModel = SnapshotDb.openFile(path.join(KnownTestLocations.assetsDir, \"sim-master.bim\"));\r\n    schemaView = await iModel.getSchemaView();\r\n  });\r\n\r\n  after(() => {\r\n    iModel.close();\r\n  });\r\n\r\n  /**\r\n   * Example: get a property's KoQ from SchemaView, then resolve the\r\n   * alias-qualified format and unit names to full ecschema-metadata objects via\r\n   * IModelDb.schemaContext.\r\n   *\r\n   * SchemaView uses alias-qualified names (e.g. \"f:DefaultRealU\", \"u:M\")\r\n   * because the Units and Formats schemas are excluded from the SchemaView blob.\r\n   * The alias (\"f\" -> \"Formats\", \"u\" -> \"Units\") is stored in ec_Schema, so we\r\n   * can resolve it using the schema context that has the full schema set.\r\n   */\r\n  it(\"should resolve KoQ format and unit names via ecschema-metadata\", async () => {\r\n    // --- Step 1: find a property with a KoQ via SchemaView ---\r\n    const rClass = schemaView.findClass(\"LinearReferencing:DistanceExpression\");\r\n    assert.isDefined(rClass, \"DistanceExpression class not found\");\r\n\r\n    const rProp = rClass!.getProperty(\"DistanceAlongFromStart\");\r\n    assert.isDefined(rProp, \"DistanceAlongFromStart property not found\");\r\n\r\n    const prop = rProp!;\r\n    if (!prop.isPrimitive())\r\n      throw new Error(\"expected primitive\");\r\n    const rKoq = prop.kindOfQuantity;\r\n    assert.isDefined(rKoq, \"property should have a KoQ\");\r\n\r\n    // --- Step 2: inspect parsed presentation formats ---\r\n    const formats: readonly SchemaView.PresentationFormat[] = rKoq!.presentationFormats;\r\n    expect(formats.length).to.be.greaterThan(0, \"KoQ should have presentation formats\");\r\n\r\n    // LinearReferencing:LENGTH has: f:DefaultRealU(2)[u:M], f:DefaultRealU(2)[u:FT]\r\n    const first = formats[0];\r\n    expect(first.name).to.equal(\"f:DefaultRealU\");\r\n    expect(first.precision).to.equal(2);\r\n    expect(first.unitAndLabels).to.have.length(1);\r\n    expect(first.unitAndLabels![0][0]).to.equal(\"u:M\");\r\n\r\n    // --- Step 3: resolve alias names to full schema items via schemaContext ---\r\n    // The Formats and Units schemas are excluded from SchemaView,\r\n    // but IModelDb.schemaContext (ecschema-metadata) has the full set.\r\n    // Alias \"f\" -> \"Formats\", alias \"u\" -> \"Units\" - these are standard BIS aliases.\r\n\r\n    // Resolve the format: \"f:DefaultRealU\" -> \"Formats.DefaultRealU\"\r\n    const formatFullName = `Formats.${first.name.split(\":\")[1]}`;\r\n    const metaFormat = iModel.schemaContext.getSchemaItemSync(formatFullName, Format);\r\n    assert.isDefined(metaFormat, `Format '${formatFullName}' not found in ecschema-metadata`);\r\n    expect(metaFormat!.precision).to.be.a(\"number\");\r\n\r\n    // Resolve the unit: \"u:M\" -> \"Units.M\"\r\n    const unitFullName = `Units.${first.unitAndLabels![0][0].split(\":\")[1]}`;\r\n    const metaUnit = iModel.schemaContext.getSchemaItemSync(unitFullName, Unit);\r\n    assert.isDefined(metaUnit, `Unit '${unitFullName}' not found in ecschema-metadata`);\r\n    expect(metaUnit!.fullName).to.equal(\"Units.M\");\r\n\r\n    // Access unit details like label and unit system\r\n    const unitSystem = await metaUnit!.unitSystem;\r\n    assert.isDefined(unitSystem, \"unit should have a unit system\");\r\n    expect(unitSystem!.name).to.equal(\"SI\");\r\n\r\n    // --- Step 4: cross-validate against the KoQ in ecschema-metadata ---\r\n    const metaKoq = iModel.schemaContext.getSchemaItemSync(\"LinearReferencing\", \"LENGTH\", KindOfQuantity);\r\n    assert.isDefined(metaKoq, \"KoQ not found in ecschema-metadata\");\r\n    expect(metaKoq!.relativeError).to.equal(rKoq!.relativeError);\r\n\r\n    const metaFormats = metaKoq!.presentationFormats;\r\n    expect(metaFormats.length).to.equal(formats.length);\r\n\r\n    // ecschema-metadata resolves the formats fully - cross-check the format names.\r\n    // OverrideFormat.fullName includes override syntax (e.g. \"Formats.DefaultRealU(2)[Units.M]\"),\r\n    // so strip the override portion before extracting the base name.\r\n    for (let i = 0; i < formats.length; i++) {\r\n      const rtItemName = formats[i].name.split(\":\")[1];\r\n      const metaBaseFullName = metaFormats[i].fullName.split(/[([]/)[0];\r\n      const metaItemName = metaBaseFullName.split(\".\").pop();\r\n      expect(rtItemName).to.equal(metaItemName, `format name mismatch at index ${i}`);\r\n    }\r\n\r\n    // The SchemaUnitProvider bridges ecschema-metadata units to the @itwin/core-quantity package.\r\n    // Use it to build a FormatterSpec for quantity formatting:\r\n    const unitsProvider = new SchemaUnitProvider(iModel.schemaContext);\r\n    const persistenceUnitProps = await unitsProvider.findUnitByName(\"Units.M\");\r\n    expect(persistenceUnitProps.name).to.equal(\"Units.M\");\r\n  });\r\n\r\n  /**\r\n   * Example: get a KoQ from SchemaView, then query ECDbMeta via ECSQL\r\n   * to resolve the referenced format and unit definitions.\r\n   *\r\n   * This approach avoids loading the full ecschema-metadata schema set and works\r\n   * well for targeted lookups - e.g. \"I have a format name, give me its NumericSpec.\"\r\n   */\r\n  it(\"should resolve KoQ format and unit names via ECSQL\", async () => {\r\n    // --- Step 1: find a KoQ via SchemaView ---\r\n    const rKoq = schemaView.findKindOfQuantity(\"LinearReferencing:LENGTH\");\r\n    assert.isDefined(rKoq, \"KoQ not found in SchemaView\");\r\n\r\n    const formats = rKoq!.presentationFormats;\r\n    expect(formats.length).to.be.greaterThan(0);\r\n\r\n    // --- Step 2: resolve the format name via meta.FormatDef ---\r\n    // \"f:DefaultRealU\" -> format name is \"DefaultRealU\" in the \"Formats\" schema\r\n    const first = formats[0];\r\n    const formatItemName = first.name.split(\":\")[1]; // \"DefaultRealU\"\r\n\r\n    // Query FormatDef to get the format's NumericSpec (= FormatProps JSON)\r\n    let formatNumericSpec: any;\r\n    for await (const row of iModel.createQueryReader(\r\n      `SELECT f.NumericSpec, f.CompositeSpec\r\n       FROM meta.FormatDef f\r\n       JOIN meta.ECSchemaDef s USING meta.SchemaOwnsFormats\r\n       WHERE f.Name = ? AND s.Name = 'Formats'`,\r\n      QueryBinder.from([formatItemName]),\r\n      { rowFormat: QueryRowFormat.UseJsPropertyNames },\r\n    )) {\r\n      formatNumericSpec = row.toRow();\r\n    }\r\n    assert.isDefined(formatNumericSpec, `FormatDef '${formatItemName}' not found via ECSQL`);\r\n\r\n    // NumericSpec is a JSON string with the format properties (type, precision, traits, etc.)\r\n    const numericSpec = JSON.parse(formatNumericSpec.numericSpec);\r\n    expect(numericSpec.type).to.equal(\"Decimal\");\r\n    expect(numericSpec.precision).to.be.a(\"number\");\r\n\r\n    // The presentation format can override precision - e.g. the override \"(2)\" means precision 2\r\n    if (first.precision !== undefined)\r\n      expect(first.precision).to.equal(2); // our override\r\n\r\n    // --- Step 3: resolve the unit name via meta.UnitDef ---\r\n    // \"u:M\" -> unit name is \"M\" in the \"Units\" schema\r\n    const unitItemName = first.unitAndLabels![0][0].split(\":\")[1]; // \"M\"\r\n\r\n    let unitRow: any;\r\n    for await (const row of iModel.createQueryReader(\r\n      `SELECT u.Name, u.DisplayLabel, us.Name AS unitSystemName\r\n       FROM meta.UnitDef u\r\n       JOIN meta.ECSchemaDef s USING meta.SchemaOwnsUnits\r\n       JOIN meta.UnitSystemDef us USING meta.UnitSystemHasUnits\r\n       WHERE u.Name = ? AND s.Name = 'Units'`,\r\n      QueryBinder.from([unitItemName]),\r\n      { rowFormat: QueryRowFormat.UseJsPropertyNames },\r\n    )) {\r\n      unitRow = row.toRow();\r\n    }\r\n    assert.isDefined(unitRow, `UnitDef '${unitItemName}' not found via ECSQL`);\r\n    expect(unitRow.name).to.equal(\"M\");\r\n    expect(unitRow.unitSystemName).to.equal(\"SI\");\r\n\r\n    // --- Step 4: query the format's composite units (base format units, before overrides) ---\r\n    // DefaultRealU has no composite units (it's a single-unit format), but AngleDMS does.\r\n    // Let's also check the second KoQ format which might have composite units.\r\n    const angleKoq = schemaView.findKindOfQuantity(\"RoadRailUnits:ANGLE\");\r\n    if (angleKoq) {\r\n      const angleFormats = angleKoq.presentationFormats;\r\n      // The AngleDMS format has composite units: ARC_DEG, ARC_MINUTE, ARC_SECOND\r\n      const dmsFormat = angleFormats.find((f) => f.name.split(\":\")[1] === \"AngleDMS\");\r\n      if (dmsFormat) {\r\n        const compositeUnits: Array<{ ordinal: number; unitName: string; label: string }> = [];\r\n        for await (const row of iModel.createQueryReader(\r\n          `SELECT cu.Ordinal, u.Name AS unitName, cu.Label\r\n           FROM meta.FormatCompositeUnitDef cu\r\n           JOIN meta.FormatDef f USING meta.FormatOwnsCompositeUnits\r\n           JOIN meta.ECSchemaDef s USING meta.SchemaOwnsFormats\r\n           JOIN meta.UnitDef u USING meta.CompositeUnitRefersToUnit\r\n           WHERE f.Name = 'AngleDMS' AND s.Name = 'Formats'\r\n           ORDER BY cu.Ordinal`,\r\n          undefined,\r\n          { rowFormat: QueryRowFormat.UseJsPropertyNames },\r\n        )) {\r\n          compositeUnits.push(row.toRow());\r\n        }\r\n        expect(compositeUnits.length).to.equal(3, \"AngleDMS should have 3 composite units\");\r\n        expect(compositeUnits[0].unitName).to.equal(\"ARC_DEG\");\r\n        expect(compositeUnits[1].unitName).to.equal(\"ARC_MINUTE\");\r\n        expect(compositeUnits[2].unitName).to.equal(\"ARC_SECOND\");\r\n      }\r\n    }\r\n  });\r\n});\r\n"]}

package/lib/esm/test/schema/SchemaViewLifecycle.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=SchemaViewLifecycle.test.d.ts.map

package/lib/esm/test/schema/SchemaViewLifecycle.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaViewLifecycle.test.d.ts","sourceRoot":"","sources":["../../../../src/test/schema/SchemaViewLifecycle.test.ts"],"names":[],"mappings":""}