@itwin/core-backend 5.12.1 → 5.12.3

package/lib/esm/test/imodel/IModel.test.js

@@ -60,7 +60,7 @@ import * as semver from "semver";
 import * as sinon from "sinon";
 import { DbResult, Guid, Id64, IModelStatus, Logger, OpenMode, ProcessDetector } from "@itwin/core-bentley";
 import { EditTxn, withEditTxn } from "../../EditTxn";
-import { BisCodeSpec, BriefcaseIdValue, Code, CodeScopeSpec, CodeSpec, ColorByName, ColorDef, DisplayStyleSettings, EcefLocation, FontMap, FontType, GeoCoordStatus, GeographicCRS, GeometryParams, GeometryStreamBuilder, ImageSourceFormat, IModel, IModelError, QueryBinder, RelatedElement, RenderMode, SchemaState, SubCategoryAppearance, TextureMapping, TextureMapUnits, ViewFlags, } from "@itwin/core-common";
+import { BisCodeSpec, BriefcaseIdValue, Code, CodeScopeSpec, CodeSpec, ColorByName, ColorDef, DisplayStyleSettings, EcefLocation, FontMap, FontType, GeoCoordStatus, GeographicCRS, GeometryParams, GeometryStreamBuilder, ImageSourceFormat, IModel, IModelError, QueryBinder, Rank, RelatedElement, RenderMode, SchemaState, SubCategoryAppearance, TextureMapping, TextureMapUnits, ViewFlags, } from "@itwin/core-common";
 import { Geometry, LineString3d, Loop, Matrix4d, Point3d, PolyfaceBuilder, Range3d, StrokeOptions, Transform, YawPitchRollAngles, } from "@itwin/core-geometry";
 import { V2CheckpointManager } from "../../CheckpointManager";
 import { _nativeDb, BisCoreSchema, Category, ClassRegistry, DefinitionContainer, DefinitionGroup, DefinitionGroupGroupsDefinitions, DefinitionModel, DefinitionPartition, DictionaryModel, DisplayStyle3d, DocumentPartition, DrawingGraphic, Element, ElementDrivesElement, ElementGroupsMembers, ElementOwnsChildElements, GenericGraphicalType2d, GeometricElement2d, GeometricElement3d, GeometricModel, GroupInformationPartition, IModelDb, IModelHost, IModelJsFs, InformationPartitionElement, InformationRecordElement, LinkPartition, Model, PhysicalElement, PhysicalModel, PhysicalObject, PhysicalPartition, RenderMaterialElement, SnapshotDb, SpatialCategory, SqliteValueType, StandaloneDb, SubCategory, Subject, Texture, } from "../../core-backend";
@@ -1527,6 +1527,67 @@ describe("iModel", () => {
         txn.end();
         iModelDb.close();
     });
+    describe("DefinitionSet.rank", () => {
+        function setRank(iModelDb, id, className, rank) {
+            withEditTxn(iModelDb, (txn) => txn.updateElement({ id, classFullName: className, rank }));
+        }
+        it("should insert, update, read and serialize rank", () => {
+            const iModelFileName = IModelTestUtils.prepareOutputFile("IModel", "DefinitionSetRank.bim");
+            const iModelDb = StandaloneDb.createEmpty(iModelFileName, { rootSubject: { name: "DefinitionSetRank" } });
+            const containerId = withEditTxn(iModelDb, (txn) => DefinitionContainer.insert(txn, IModel.dictionaryId, Code.createEmpty()));
+            const groupId = withEditTxn(iModelDb, (txn) => DefinitionGroup.create(iModelDb, IModel.dictionaryId, Code.createEmpty()).insert(txn));
+            // Freshly inserted DefinitionSets have no rank persisted.
+            assert.isUndefined(iModelDb.elements.getElementProps(containerId).rank);
+            assert.isUndefined(iModelDb.elements.getElement(containerId).rank);
+            setRank(iModelDb, containerId, DefinitionContainer.classFullName, Rank.Application);
+            setRank(iModelDb, groupId, DefinitionGroup.classFullName, Rank.Domain);
+            const containerProps = iModelDb.elements.getElementProps(containerId);
+            assert.equal(containerProps.rank, Rank.Application);
+            const container = iModelDb.elements.getElement(containerId);
+            assert.equal(container.rank, Rank.Application);
+            assert.equal(container.toJSON().rank, Rank.Application);
+            const group = iModelDb.elements.getElement(groupId);
+            assert.equal(group.rank, Rank.Domain);
+            assert.equal(group.toJSON().rank, Rank.Domain);
+            iModelDb.close();
+        });
+        it("should serialize/deserialize DefinitionSet.rank via DefinitionSet.serialize/deserialize", () => {
+            const iModelFileName = IModelTestUtils.prepareOutputFile("IModel", "DefinitionSetRankSerialize.bim");
+            const iModelDb = StandaloneDb.createEmpty(iModelFileName, { rootSubject: { name: "DefinitionSetRankSerialize" } });
+            const props = {
+                classFullName: DefinitionContainer.classFullName,
+                model: IModel.dictionaryId,
+                code: Code.createEmpty(),
+                rank: Rank.User,
+            };
+            const row = DefinitionContainer.serialize(props, iModelDb);
+            assert.equal(row.rank, Rank.User);
+            const propsWithoutRank = {
+                classFullName: DefinitionContainer.classFullName,
+                model: IModel.dictionaryId,
+                code: Code.createEmpty(),
+            };
+            const rowWithoutRank = DefinitionContainer.serialize(propsWithoutRank, iModelDb);
+            assert.isUndefined(rowWithoutRank.rank);
+            iModelDb.close();
+        });
+        it("should insert a DefinitionContainer with rank property", () => {
+            const iModelFileName = IModelTestUtils.prepareOutputFile("IModel", "DefinitionContainerRank.bim");
+            const iModelDb = StandaloneDb.createEmpty(iModelFileName, { rootSubject: { name: "DefinitionContainerRank" } });
+            const containerId = withEditTxn(iModelDb, (txn) => {
+                const containerProps = {
+                    classFullName: DefinitionContainer.classFullName,
+                    model: IModel.dictionaryId,
+                    code: Code.createEmpty(),
+                    rank: Rank.Application,
+                };
+                return txn.insertElement(containerProps);
+            });
+            const inserted = iModelDb.elements.getElementProps(containerId);
+            assert.equal(inserted.rank, Rank.Application);
+            iModelDb.close();
+        });
+    });
     it("should set EC properties of various types", async () => {
         const testImodel = imodel1;
         assert.doesNotThrow(() => testImodel.schemaContext.getSchemaItemSync("TestBim:TestPhysicalObject", EntityClass), "TestPhysicalObject is expected to be defined in TestBim.ecschema.xml");
@@ -2968,50 +3029,50 @@ describe("iModel", () => {
             IModelJsFs.unlinkSync(imodelPath);
         const testImodel = SnapshotDb.createEmpty(imodelPath, { rootSubject: { name: "invalidRelationshipClass" } });
         await testImodel.importSchemaStrings([
-            `<?xml version="1.0" encoding="UTF-8"?>
-      <ECSchema schemaName="TestRelationSchema" alias="trs" version="01.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.1">
-          <ECSchemaReference name="BisCore" version="01.00" alias="bis"/>
-          <ECEntityClass typeName="TestElement">
-              <BaseClass>bis:PhysicalElement</BaseClass>
-              <ECProperty propertyName="Name" typeName="string" />
-          </ECEntityClass>
-
-          <ECEntityClass typeName="ChildA" >
-            <BaseClass>TestElement</BaseClass>
-            <ECNavigationProperty propertyName="NavPropChildB" relationshipName="ADrivesB" direction="Forward" readOnly="True">
-            </ECNavigationProperty>
-          </ECEntityClass>
-
-          <ECEntityClass typeName="ChildB" >
-            <BaseClass>TestElement</BaseClass>
-          </ECEntityClass>
-
-          <ECRelationshipClass typeName="ADrivesB" strengthDirection="Backward" strength="referencing" modifier="Sealed">
-            <Source multiplicity="(0..*)" polymorphic="true" roleLabel="drives">
-              <Class class="ChildA"/>
-            </Source>
-            <Target multiplicity="(0..1)" polymorphic="true" roleLabel="is driven by">
-              <Class class="ChildB"/>
-            </Target>
-          </ECRelationshipClass>
-
-          <ECEntityClass typeName="ChildC">
-            <BaseClass>TestElement</BaseClass>
-          </ECEntityClass>
-
-          <ECEntityClass typeName="ChildD">
-            <BaseClass>TestElement</BaseClass>
-          </ECEntityClass>
-
-          <ECRelationshipClass typeName="CIsRelatedToD" strength="referencing" modifier="Sealed">
-             <BaseClass>bis:ElementRefersToElements</BaseClass>
-            <Source multiplicity="(0..*)" roleLabel="IsRelatedTo" polymorphic="true">
-              <Class class="ChildC"/>
-            </Source>
-            <Target multiplicity="(0..*)" roleLabel="IsRelatedTo (Reversed)" polymorphic="true">
-              <Class class="ChildD"/>
-            </Target>
-          </ECRelationshipClass>
+            `<?xml version="1.0" encoding="UTF-8"?>
+      <ECSchema schemaName="TestRelationSchema" alias="trs" version="01.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.1">
+          <ECSchemaReference name="BisCore" version="01.00" alias="bis"/>
+          <ECEntityClass typeName="TestElement">
+              <BaseClass>bis:PhysicalElement</BaseClass>
+              <ECProperty propertyName="Name" typeName="string" />
+          </ECEntityClass>
+
+          <ECEntityClass typeName="ChildA" >
+            <BaseClass>TestElement</BaseClass>
+            <ECNavigationProperty propertyName="NavPropChildB" relationshipName="ADrivesB" direction="Forward" readOnly="True">
+            </ECNavigationProperty>
+          </ECEntityClass>
+
+          <ECEntityClass typeName="ChildB" >
+            <BaseClass>TestElement</BaseClass>
+          </ECEntityClass>
+
+          <ECRelationshipClass typeName="ADrivesB" strengthDirection="Backward" strength="referencing" modifier="Sealed">
+            <Source multiplicity="(0..*)" polymorphic="true" roleLabel="drives">
+              <Class class="ChildA"/>
+            </Source>
+            <Target multiplicity="(0..1)" polymorphic="true" roleLabel="is driven by">
+              <Class class="ChildB"/>
+            </Target>
+          </ECRelationshipClass>
+
+          <ECEntityClass typeName="ChildC">
+            <BaseClass>TestElement</BaseClass>
+          </ECEntityClass>
+
+          <ECEntityClass typeName="ChildD">
+            <BaseClass>TestElement</BaseClass>
+          </ECEntityClass>
+
+          <ECRelationshipClass typeName="CIsRelatedToD" strength="referencing" modifier="Sealed">
+             <BaseClass>bis:ElementRefersToElements</BaseClass>
+            <Source multiplicity="(0..*)" roleLabel="IsRelatedTo" polymorphic="true">
+              <Class class="ChildC"/>
+            </Source>
+            <Target multiplicity="(0..*)" roleLabel="IsRelatedTo (Reversed)" polymorphic="true">
+              <Class class="ChildD"/>
+            </Target>
+          </ECRelationshipClass>
         </ECSchema>`
         ]);
         // Enable ECSQL write validation and verify it's set