@itwin/core-backend 3.4.0-dev.9 → 3.4.1

package/lib/cjs/Model.js

@@ -1,469 +1,480 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Models
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebMercatorModel = exports.DictionaryModel = exports.LinkModel = exports.DocumentListModel = exports.RepositoryModel = exports.DefinitionModel = exports.InformationRecordModel = exports.GroupInformationModel = exports.InformationModel = exports.RoleModel = exports.SheetModel = exports.SectionDrawingModel = exports.DrawingModel = exports.SpatialLocationModel = exports.PhysicalModel = exports.SpatialModel = exports.GraphicalModel3d = exports.GraphicalModel2d = exports.GeometricModel2d = exports.GeometricModel3d = exports.GeometricModel = exports.Model = void 0;
-// cspell:ignore elid
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_geometry_1 = require("@itwin/core-geometry");
-const core_common_1 = require("@itwin/core-common");
-const Element_1 = require("./Element");
-const Entity_1 = require("./Entity");
-const NavigationRelationship_1 = require("./NavigationRelationship");
-/** A Model is a container for persisting a collection of related elements within an iModel.
- * See [[IModelDb.Models]] for how to query and manage the Models in an IModelDb.
- * See [Creating models]($docs/learning/backend/CreateModels.md)
- * @public
- */
-class Model extends Entity_1.Entity {
-    /** @internal */
-    constructor(props, iModel) {
-        super(props, iModel);
-        this.name = props.name ? props.name : ""; // NB this isn't really a property of Model (it's the code.value of the modeled element), but it comes in ModelProps because it's often needed
-        this.isPrivate = core_bentley_1.JsonUtils.asBool(props.isPrivate);
-        this.isTemplate = core_bentley_1.JsonUtils.asBool(props.isTemplate);
-        this.jsonProperties = { ...props.jsonProperties }; // make sure we have our own copy
-    }
-    /** @internal */
-    static get className() { return "Model"; }
-    /** @internal */
-    static get protectedOperations() { return ["onInsert", "onUpdate", "onDelete"]; }
-    /** Add all properties of a Model to a json object.
-     * @internal
-     */
-    toJSON() {
-        const val = super.toJSON();
-        val.name = this.name; // for cloning
-        return val;
-    }
-    /** Called before a new Model is inserted.
-     * @note throw an exception to disallow the insert
-     * @note If you override this method, you must call super.
-     * @note `this` is the class of the Model to be inserted
-     * @beta
-     */
-    static onInsert(arg) {
-        const { props } = arg;
-        if (props.parentModel) // inserting requires shared lock on parent, if present
-            arg.iModel.locks.checkSharedLock(props.parentModel, "parent model", "insert");
-    }
-    /** Called after a new Model is inserted.
-     * @note If you override this method, you must call super.
-     * @note `this` is the class of the Model that was inserted
-     * @beta
-     */
-    static onInserted(_arg) {
-        // we don't need to tell LockControl about models being created - their ModeledElement does that
-    }
-    /** Called before a Model is updated.
-     * @note throw an exception to disallow the update
-     * @note If you override this method, you must call super.
-     * @note `this` is the class of the Model to be updated
-     * @beta
-     */
-    static onUpdate(arg) {
-        arg.iModel.locks.checkExclusiveLock(arg.props.id, "model", "update"); // eslint-disable-line @typescript-eslint/no-non-null-assertion
-    }
-    /** Called after a Model is updated.
-     * @note If you override this method, you must call super.
-     * @note `this` is the class of the Model that was updated.
-     * @beta
-     */
-    static onUpdated(_arg) {
-    }
-    /** Called before a Model is deleted.
-     * @note throw an exception to disallow the delete
-     * @note If you override this method, you must call super.
-     * @note `this` is the class of the Model to be deleted
-     * @beta
-     */
-    static onDelete(arg) {
-        arg.iModel.locks.checkExclusiveLock(arg.id, "model", "delete");
-    }
-    /** Called after a Model was deleted.
-     * @note If you override this method, you must call super.
-     * @note `this` is the class of the Model that was deleted
-     * @beta
-     */
-    static onDeleted(_arg) { }
-    /** Called before a prospective Element is to be inserted into an instance of a Model of this class.
-     * @note throw an exception to disallow the insert
-     * @note If you override this method, you must call super.
-     * @note `this` is the class of the Model to hold the element
-     * @beta
-     */
-    static onInsertElement(_arg) { }
-    /** Called after an Element has been inserted into an instance of a Model of this class.
-     * @note If you override this method, you must call super.
-     * @note `this` is the class of the Model holding the element
-     * @beta
-     */
-    static onInsertedElement(_arg) { }
-    /** Called when an Element in an instance of a Model of this class is about to be updated.
-     * @note throw an exception to disallow the update
-     * @note If you override this method, you must call super.
-     * @note `this` is the class of the Model holding the element
-     * @beta
-     */
-    static onUpdateElement(_arg) { }
-    /** Called after an Element in an instance of a Model of this class has been updated.
-     * @note If you override this method, you must call super.
-     * @note `this` is the class of the Model holding the element
-     * @beta
-     */
-    static onUpdatedElement(_arg) { }
-    /** Called when an Element in an instance of a Model of this class is about to be deleted.
-     * @note throw an exception to disallow the delete
-     * @note If you override this method, you must call super.
-     * @note `this` is the class of the Model holding the element
-     * @beta
-     */
-    static onDeleteElement(_arg) { }
-    /** Called after an Element in an instance of a Model of this class has been deleted.
-     * @note If you override this method, you must call super.
-     * @note `this` is the class of the Model that held the element
-     * @beta
-     */
-    static onDeletedElement(_arg) { }
-    getAllUserProperties() { if (!this.jsonProperties.UserProps)
-        this.jsonProperties.UserProps = new Object(); return this.jsonProperties.UserProps; }
-    /** Get a set of JSON user properties by namespace */
-    getUserProperties(namespace) { return this.getAllUserProperties()[namespace]; }
-    /** Change a set of user JSON properties of this Element by namespace. */
-    setUserProperties(nameSpace, value) { this.getAllUserProperties()[nameSpace] = value; }
-    /** Remove a set of JSON user properties, specified by namespace, from this Element */
-    removeUserProperties(nameSpace) { delete this.getAllUserProperties()[nameSpace]; }
-    getJsonProperty(name) { return this.jsonProperties[name]; }
-    setJsonProperty(name, value) { this.jsonProperties[name] = value; }
-    /** Insert this Model in the iModel */
-    insert() { return this.id = this.iModel.models.insertModel(this.toJSON()); }
-    /** Update this Model in the iModel. */
-    update() { this.iModel.models.updateModel(this.toJSON()); }
-    /** Delete this Model from the iModel. */
-    delete() { this.iModel.models.deleteModel(this.id); }
-}
-exports.Model = Model;
-/** A container for persisting geometric elements.
- * @public
- */
-class GeometricModel extends Model {
-    /** @internal */
-    constructor(props, iModel) { super(props, iModel); }
-    /** @internal */
-    static get className() { return "GeometricModel"; }
-    /** Query for the union of the extents of the elements contained by this model. */
-    queryExtents() {
-        const extents = this.iModel.nativeDb.queryModelExtents({ id: this.id }).modelExtents;
-        return core_geometry_1.Range3d.fromJSON(extents);
-    }
-}
-exports.GeometricModel = GeometricModel;
-/** A container for persisting 3d geometric elements.
- * @public
- */
-class GeometricModel3d extends GeometricModel {
-    /** @internal */
-    constructor(props, iModel) {
-        super(props, iModel);
-        this.isNotSpatiallyLocated = core_bentley_1.JsonUtils.asBool(props.isNotSpatiallyLocated);
-        this.isPlanProjection = core_bentley_1.JsonUtils.asBool(props.isPlanProjection);
-    }
-    /** If true, then the elements in this GeometricModel3d are in real-world coordinates and will be in the spatial index. */
-    get isSpatiallyLocated() { return !this.isNotSpatiallyLocated; }
-    /** @internal */
-    static get className() { return "GeometricModel3d"; }
-    /** @internal */
-    toJSON() {
-        const val = super.toJSON();
-        if (this.isNotSpatiallyLocated)
-            val.isNotSpatiallyLocated = true;
-        if (this.isPlanProjection)
-            val.isPlanProjection = true;
-        return val;
-    }
-}
-exports.GeometricModel3d = GeometricModel3d;
-/** A container for persisting 2d geometric elements.
- * @public
- */
-class GeometricModel2d extends GeometricModel {
-    /** @internal */
-    constructor(props, iModel) { super(props, iModel); }
-    /** @internal */
-    static get className() { return "GeometricModel2d"; }
-    /** @internal */
-    toJSON() {
-        const val = super.toJSON();
-        if (undefined !== this.globalOrigin)
-            val.globalOrigin = core_geometry_1.Point2d.fromJSON(this.globalOrigin);
-        return val;
-    }
-}
-exports.GeometricModel2d = GeometricModel2d;
-/** A container for persisting 2d graphical elements.
- * @public
- */
-class GraphicalModel2d extends GeometricModel2d {
-    /** @internal */
-    static get className() { return "GraphicalModel2d"; }
-}
-exports.GraphicalModel2d = GraphicalModel2d;
-/** A container for persisting GraphicalElement3d instances.
- * @note The associated ECClass was added to the BisCore schema in version 1.0.8
- * @see [[GraphicalPartition3d]]
- * @public
- */
-class GraphicalModel3d extends GeometricModel3d {
-    /** @internal */
-    static get className() { return "GraphicalModel3d"; }
-}
-exports.GraphicalModel3d = GraphicalModel3d;
-/** A container for persisting 3d geometric elements that are spatially located.
- * @public
- */
-class SpatialModel extends GeometricModel3d {
-    /** @internal */
-    static get className() { return "SpatialModel"; }
-}
-exports.SpatialModel = SpatialModel;
-/** A container for persisting physical elements that model physical space.
- * @see [[PhysicalPartition]]
- * @public
- */
-class PhysicalModel extends SpatialModel {
-    /** @internal */
-    static get className() { return "PhysicalModel"; }
-    /** Insert a PhysicalPartition and a PhysicalModel that sub-models it.
-     * @param iModelDb Insert into this iModel
-     * @param parentSubjectId The PhysicalPartition will be inserted as a child of this Subject element.
-     * @param name The name of the PhysicalPartition that the new PhysicalModel will sub-model.
-     * @param isPlanProjection Optional value (default is false) that indicates if the contents of this model are expected to be in an XY plane.
-     * @returns The Id of the newly inserted PhysicalPartition and PhysicalModel (same value).
-     * @throws [[IModelError]] if there is an insert problem.
-     */
-    static insert(iModelDb, parentSubjectId, name, isPlanProjection) {
-        const partitionProps = {
-            classFullName: Element_1.PhysicalPartition.classFullName,
-            model: core_common_1.IModel.repositoryModelId,
-            parent: new NavigationRelationship_1.SubjectOwnsPartitionElements(parentSubjectId),
-            code: Element_1.PhysicalPartition.createCode(iModelDb, parentSubjectId, name),
-        };
-        const partitionId = iModelDb.elements.insertElement(partitionProps);
-        const modelProps = {
-            classFullName: this.classFullName,
-            modeledElement: { id: partitionId },
-            isPlanProjection,
-        };
-        return iModelDb.models.insertModel(modelProps);
-    }
-}
-exports.PhysicalModel = PhysicalModel;
-/** A container for persisting spatial location elements.
- * @see [[SpatialLocationPartition]]
- * @public
- */
-class SpatialLocationModel extends SpatialModel {
-    /** @internal */
-    static get className() { return "SpatialLocationModel"; }
-    /** Insert a SpatialLocationPartition and a SpatialLocationModel that sub-models it.
-     * @param iModelDb Insert into this iModel
-     * @param parentSubjectId The SpatialLocationPartition will be inserted as a child of this Subject element.
-     * @param name The name of the SpatialLocationPartition that the new SpatialLocationModel will sub-model.
-     * @param isPlanProjection Optional value (default is false) that indicates if the contents of this model are expected to be in an XY plane.
-     * @returns The Id of the newly inserted SpatialLocationPartition and SpatialLocationModel (same value).
-     * @throws [[IModelError]] if there is an insert problem.
-     */
-    static insert(iModelDb, parentSubjectId, name, isPlanProjection) {
-        const partitionProps = {
-            classFullName: Element_1.SpatialLocationPartition.classFullName,
-            model: core_common_1.IModel.repositoryModelId,
-            parent: new NavigationRelationship_1.SubjectOwnsPartitionElements(parentSubjectId),
-            code: Element_1.SpatialLocationPartition.createCode(iModelDb, parentSubjectId, name),
-        };
-        const partitionId = iModelDb.elements.insertElement(partitionProps);
-        const modelProps = {
-            classFullName: this.classFullName,
-            modeledElement: { id: partitionId },
-            isPlanProjection,
-        };
-        return iModelDb.models.insertModel(modelProps);
-    }
-}
-exports.SpatialLocationModel = SpatialLocationModel;
-/** A 2d model that holds [[DrawingGraphic]]s. DrawingModels may be dimensional or non-dimensional.
- * @public
- */
-class DrawingModel extends GraphicalModel2d {
-    /** @internal */
-    static get className() { return "DrawingModel"; }
-}
-exports.DrawingModel = DrawingModel;
-/** A container for persisting section [[DrawingGraphic]]s.
- * @public
- */
-class SectionDrawingModel extends DrawingModel {
-    /** @internal */
-    static get className() { return "SectionDrawingModel"; }
-}
-exports.SectionDrawingModel = SectionDrawingModel;
-/** A container for persisting [[ViewAttachment]]s and [[DrawingGraphic]]s.
- * A SheetModel is a digital representation of a *sheet of paper*. SheetModels are 2d models in bounded paper coordinates.
- * SheetModels may contain annotation Elements as well as references to 2d or 3d Views.
- * @public
- */
-class SheetModel extends GraphicalModel2d {
-    /** @internal */
-    static get className() { return "SheetModel"; }
-}
-exports.SheetModel = SheetModel;
-/** A container for persisting role elements.
- * @public
- */
-class RoleModel extends Model {
-    /** @internal */
-    static get className() { return "RoleModel"; }
-}
-exports.RoleModel = RoleModel;
-/** A container for persisting information elements.
- * @public
- */
-class InformationModel extends Model {
-    /** @internal */
-    static get className() { return "InformationModel"; }
-}
-exports.InformationModel = InformationModel;
-/** A container for persisting group information elements.
- * @see [[GroupInformationPartition]]
- * @public
- */
-class GroupInformationModel extends InformationModel {
-    /** @internal */
-    static get className() { return "GroupInformationModel"; }
-}
-exports.GroupInformationModel = GroupInformationModel;
-/** A container for persisting Information Record Elements
- * @see [[InformationRecordPartition]]
- * @public
- */
-class InformationRecordModel extends InformationModel {
-    /** @internal */
-    static get className() { return "InformationRecordModel"; }
-    /** Insert a InformationRecordPartition and a InformationRecordModel that sub-models it.
-     * @param iModelDb Insert into this iModel
-     * @param parentSubjectId The InformationRecordPartition will be inserted as a child of this Subject element.
-     * @param name The name of the InformationRecordPartition that the new InformationRecordModel will sub-model.
-     * @returns The Id of the newly inserted InformationRecordModel.
-     * @throws [[IModelError]] if there is an insert problem.
-     */
-    static insert(iModelDb, parentSubjectId, name) {
-        const partitionProps = {
-            classFullName: Element_1.InformationRecordPartition.classFullName,
-            model: core_common_1.IModel.repositoryModelId,
-            parent: new NavigationRelationship_1.SubjectOwnsPartitionElements(parentSubjectId),
-            code: Element_1.InformationRecordPartition.createCode(iModelDb, parentSubjectId, name),
-        };
-        const partitionId = iModelDb.elements.insertElement(partitionProps);
-        return iModelDb.models.insertModel({
-            classFullName: this.classFullName,
-            modeledElement: { id: partitionId },
-        });
-    }
-}
-exports.InformationRecordModel = InformationRecordModel;
-/** A container for persisting definition elements.
- * @see [[DefinitionPartition]]
- * @public
- */
-class DefinitionModel extends InformationModel {
-    /** @internal */
-    static get className() { return "DefinitionModel"; }
-    /** Insert a DefinitionPartition and a DefinitionModel that sub-models it.
-     * @param iModelDb Insert into this iModel
-     * @param parentSubjectId The DefinitionPartition will be inserted as a child of this Subject element.
-     * @param name The name of the DefinitionPartition that the new DefinitionModel will sub-model.
-     * @returns The Id of the newly inserted DefinitionModel.
-     * @throws [[IModelError]] if there is an insert problem.
-     */
-    static insert(iModelDb, parentSubjectId, name) {
-        const partitionProps = {
-            classFullName: Element_1.DefinitionPartition.classFullName,
-            model: core_common_1.IModel.repositoryModelId,
-            parent: new NavigationRelationship_1.SubjectOwnsPartitionElements(parentSubjectId),
-            code: Element_1.DefinitionPartition.createCode(iModelDb, parentSubjectId, name),
-        };
-        const partitionId = iModelDb.elements.insertElement(partitionProps);
-        return iModelDb.models.insertModel({
-            classFullName: this.classFullName,
-            modeledElement: { id: partitionId },
-        });
-    }
-}
-exports.DefinitionModel = DefinitionModel;
-/** The singleton container of repository-related information elements.
- * @public
- */
-class RepositoryModel extends DefinitionModel {
-    /** @internal */
-    static get className() { return "RepositoryModel"; }
-}
-exports.RepositoryModel = RepositoryModel;
-/** Contains a list of document elements.
- * @see [[DocumentPartition]]
- * @public
- */
-class DocumentListModel extends InformationModel {
-    /** @internal */
-    static get className() { return "DocumentListModel"; }
-    /** Insert a DocumentPartition and a DocumentListModel that sub-models it.
-     * @param iModelDb Insert into this iModel
-     * @param parentSubjectId The DocumentPartition will be inserted as a child of this Subject element.
-     * @param name The name of the DocumentPartition that the new DocumentListModel will sub-model.
-     * @returns The Id of the newly inserted DocumentPartition and DocumentListModel (same value)
-     * @throws [[IModelError]] if there is an insert problem.
-     */
-    static insert(iModelDb, parentSubjectId, name) {
-        const partitionProps = {
-            classFullName: Element_1.DocumentPartition.classFullName,
-            model: core_common_1.IModel.repositoryModelId,
-            parent: new NavigationRelationship_1.SubjectOwnsPartitionElements(parentSubjectId),
-            code: Element_1.DocumentPartition.createCode(iModelDb, parentSubjectId, name),
-        };
-        const partitionId = iModelDb.elements.insertElement(partitionProps);
-        return iModelDb.models.insertModel({
-            classFullName: this.classFullName,
-            modeledElement: { id: partitionId },
-        });
-    }
-}
-exports.DocumentListModel = DocumentListModel;
-/** A container for persisting link elements.
- * @see [[LinkPartition]]
- * @public
- */
-class LinkModel extends InformationModel {
-    /** @internal */
-    static get className() { return "LinkModel"; }
-}
-exports.LinkModel = LinkModel;
-/** The singleton container for repository-specific definition elements.
- * @public
- */
-class DictionaryModel extends DefinitionModel {
-    /** @internal */
-    static get className() { return "DictionaryModel"; }
-}
-exports.DictionaryModel = DictionaryModel;
-/** Obtains and displays multi-resolution tiled raster organized according to the WebMercator tiling system.
- * @public
- */
-class WebMercatorModel extends SpatialModel {
-    /** @internal */
-    static get className() { return "WebMercatorModel"; }
-}
-exports.WebMercatorModel = WebMercatorModel;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Models
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebMercatorModel = exports.DictionaryModel = exports.LinkModel = exports.DocumentListModel = exports.RepositoryModel = exports.DefinitionModel = exports.InformationRecordModel = exports.GroupInformationModel = exports.InformationModel = exports.RoleModel = exports.SheetModel = exports.SectionDrawingModel = exports.DrawingModel = exports.SpatialLocationModel = exports.PhysicalModel = exports.SpatialModel = exports.GraphicalModel3d = exports.GraphicalModel2d = exports.GeometricModel2d = exports.GeometricModel3d = exports.GeometricModel = exports.Model = void 0;
+// cspell:ignore elid
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_geometry_1 = require("@itwin/core-geometry");
+const core_common_1 = require("@itwin/core-common");
+const Element_1 = require("./Element");
+const Entity_1 = require("./Entity");
+const NavigationRelationship_1 = require("./NavigationRelationship");
+/** A Model is a container for persisting a collection of related elements within an iModel.
+ * See [[IModelDb.Models]] for how to query and manage the Models in an IModelDb.
+ * See [Creating models]($docs/learning/backend/CreateModels.md)
+ * @public
+ */
+class Model extends Entity_1.Entity {
+    /** @internal */
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.name = props.name ? props.name : ""; // NB this isn't really a property of Model (it's the code.value of the modeled element), but it comes in ModelProps because it's often needed
+        this.isPrivate = core_bentley_1.JsonUtils.asBool(props.isPrivate);
+        this.isTemplate = core_bentley_1.JsonUtils.asBool(props.isTemplate);
+        this.jsonProperties = { ...props.jsonProperties }; // make sure we have our own copy
+    }
+    /** @internal */
+    static get className() { return "Model"; }
+    /** @internal */
+    static get protectedOperations() { return ["onInsert", "onUpdate", "onDelete"]; }
+    /** Add all properties of a Model to a json object.
+     * @internal
+     */
+    toJSON() {
+        const val = super.toJSON();
+        val.name = this.name; // for cloning
+        return val;
+    }
+    /** Called before a new Model is inserted.
+     * @note throw an exception to disallow the insert
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model to be inserted
+     * @beta
+     */
+    static onInsert(arg) {
+        const { props } = arg;
+        if (props.parentModel) // inserting requires shared lock on parent, if present
+            arg.iModel.locks.checkSharedLock(props.parentModel, "parent model", "insert");
+    }
+    /** Called after a new Model is inserted.
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model that was inserted
+     * @beta
+     */
+    static onInserted(_arg) {
+        // we don't need to tell LockControl about models being created - their ModeledElement does that
+    }
+    /** Called before a Model is updated.
+     * @note throw an exception to disallow the update
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model to be updated
+     * @beta
+     */
+    static onUpdate(arg) {
+        arg.iModel.locks.checkExclusiveLock(arg.props.id, "model", "update"); // eslint-disable-line @typescript-eslint/no-non-null-assertion
+    }
+    /** Called after a Model is updated.
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model that was updated.
+     * @beta
+     */
+    static onUpdated(_arg) {
+    }
+    /** Called before a Model is deleted.
+     * @note throw an exception to disallow the delete
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model to be deleted
+     * @beta
+     */
+    static onDelete(arg) {
+        arg.iModel.locks.checkExclusiveLock(arg.id, "model", "delete");
+    }
+    /** Called after a Model was deleted.
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model that was deleted
+     * @beta
+     */
+    static onDeleted(_arg) { }
+    /** Called before a prospective Element is to be inserted into an instance of a Model of this class.
+     * @note throw an exception to disallow the insert
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model to hold the element
+     * @beta
+     */
+    static onInsertElement(_arg) { }
+    /** Called after an Element has been inserted into an instance of a Model of this class.
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model holding the element
+     * @beta
+     */
+    static onInsertedElement(_arg) { }
+    /** Called when an Element in an instance of a Model of this class is about to be updated.
+     * @note throw an exception to disallow the update
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model holding the element
+     * @beta
+     */
+    static onUpdateElement(_arg) { }
+    /** Called after an Element in an instance of a Model of this class has been updated.
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model holding the element
+     * @beta
+     */
+    static onUpdatedElement(_arg) { }
+    /** Called when an Element in an instance of a Model of this class is about to be deleted.
+     * @note throw an exception to disallow the delete
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model holding the element
+     * @beta
+     */
+    static onDeleteElement(_arg) { }
+    /** Called after an Element in an instance of a Model of this class has been deleted.
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model that held the element
+     * @beta
+     */
+    static onDeletedElement(_arg) { }
+    getAllUserProperties() {
+        if (!this.jsonProperties.UserProps)
+            this.jsonProperties.UserProps = new Object();
+        return this.jsonProperties.UserProps;
+    }
+    /** Get a set of JSON user properties by namespace */
+    getUserProperties(namespace) { return this.getAllUserProperties()[namespace]; }
+    /** Change a set of user JSON properties of this Element by namespace. */
+    setUserProperties(nameSpace, value) { this.getAllUserProperties()[nameSpace] = value; }
+    /** Remove a set of JSON user properties, specified by namespace, from this Element */
+    removeUserProperties(nameSpace) { delete this.getAllUserProperties()[nameSpace]; }
+    getJsonProperty(name) { return this.jsonProperties[name]; }
+    setJsonProperty(name, value) { this.jsonProperties[name] = value; }
+    /** Insert this Model in the iModel */
+    insert() { return this.id = this.iModel.models.insertModel(this.toJSON()); }
+    /** Update this Model in the iModel. */
+    update() { this.iModel.models.updateModel(this.toJSON()); }
+    /** Delete this Model from the iModel. */
+    delete() { this.iModel.models.deleteModel(this.id); }
+    // NOTE: non-element entities do not yet have a concept of required references
+    /** @internal */
+    collectReferenceConcreteIds(referenceIds) {
+        super.collectReferenceConcreteIds(referenceIds);
+        if (this.parentModel)
+            referenceIds.addModel(this.parentModel);
+        referenceIds.addElement(this.modeledElement.id);
+    }
+}
+exports.Model = Model;
+/** A container for persisting geometric elements.
+ * @public
+ */
+class GeometricModel extends Model {
+    /** @internal */
+    constructor(props, iModel) { super(props, iModel); }
+    /** @internal */
+    static get className() { return "GeometricModel"; }
+    /** Query for the union of the extents of the elements contained by this model. */
+    queryExtents() {
+        const extents = this.iModel.nativeDb.queryModelExtents({ id: this.id }).modelExtents;
+        return core_geometry_1.Range3d.fromJSON(extents);
+    }
+}
+exports.GeometricModel = GeometricModel;
+/** A container for persisting 3d geometric elements.
+ * @public
+ */
+class GeometricModel3d extends GeometricModel {
+    /** @internal */
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.isNotSpatiallyLocated = core_bentley_1.JsonUtils.asBool(props.isNotSpatiallyLocated);
+        this.isPlanProjection = core_bentley_1.JsonUtils.asBool(props.isPlanProjection);
+    }
+    /** If true, then the elements in this GeometricModel3d are in real-world coordinates and will be in the spatial index. */
+    get isSpatiallyLocated() { return !this.isNotSpatiallyLocated; }
+    /** @internal */
+    static get className() { return "GeometricModel3d"; }
+    /** @internal */
+    toJSON() {
+        const val = super.toJSON();
+        if (this.isNotSpatiallyLocated)
+            val.isNotSpatiallyLocated = true;
+        if (this.isPlanProjection)
+            val.isPlanProjection = true;
+        return val;
+    }
+}
+exports.GeometricModel3d = GeometricModel3d;
+/** A container for persisting 2d geometric elements.
+ * @public
+ */
+class GeometricModel2d extends GeometricModel {
+    /** @internal */
+    constructor(props, iModel) { super(props, iModel); }
+    /** @internal */
+    static get className() { return "GeometricModel2d"; }
+    /** @internal */
+    toJSON() {
+        const val = super.toJSON();
+        if (undefined !== this.globalOrigin)
+            val.globalOrigin = core_geometry_1.Point2d.fromJSON(this.globalOrigin);
+        return val;
+    }
+}
+exports.GeometricModel2d = GeometricModel2d;
+/** A container for persisting 2d graphical elements.
+ * @public
+ */
+class GraphicalModel2d extends GeometricModel2d {
+    /** @internal */
+    static get className() { return "GraphicalModel2d"; }
+}
+exports.GraphicalModel2d = GraphicalModel2d;
+/** A container for persisting GraphicalElement3d instances.
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.8
+ * @see [[GraphicalPartition3d]]
+ * @public
+ */
+class GraphicalModel3d extends GeometricModel3d {
+    /** @internal */
+    static get className() { return "GraphicalModel3d"; }
+}
+exports.GraphicalModel3d = GraphicalModel3d;
+/** A container for persisting 3d geometric elements that are spatially located.
+ * @public
+ */
+class SpatialModel extends GeometricModel3d {
+    /** @internal */
+    static get className() { return "SpatialModel"; }
+}
+exports.SpatialModel = SpatialModel;
+/** A container for persisting physical elements that model physical space.
+ * @see [[PhysicalPartition]]
+ * @public
+ */
+class PhysicalModel extends SpatialModel {
+    /** @internal */
+    static get className() { return "PhysicalModel"; }
+    /** Insert a PhysicalPartition and a PhysicalModel that sub-models it.
+     * @param iModelDb Insert into this iModel
+     * @param parentSubjectId The PhysicalPartition will be inserted as a child of this Subject element.
+     * @param name The name of the PhysicalPartition that the new PhysicalModel will sub-model.
+     * @param isPlanProjection Optional value (default is false) that indicates if the contents of this model are expected to be in an XY plane.
+     * @returns The Id of the newly inserted PhysicalPartition and PhysicalModel (same value).
+     * @throws [[IModelError]] if there is an insert problem.
+     */
+    static insert(iModelDb, parentSubjectId, name, isPlanProjection) {
+        const partitionProps = {
+            classFullName: Element_1.PhysicalPartition.classFullName,
+            model: core_common_1.IModel.repositoryModelId,
+            parent: new NavigationRelationship_1.SubjectOwnsPartitionElements(parentSubjectId),
+            code: Element_1.PhysicalPartition.createCode(iModelDb, parentSubjectId, name),
+        };
+        const partitionId = iModelDb.elements.insertElement(partitionProps);
+        const modelProps = {
+            classFullName: this.classFullName,
+            modeledElement: { id: partitionId },
+            isPlanProjection,
+        };
+        return iModelDb.models.insertModel(modelProps);
+    }
+}
+exports.PhysicalModel = PhysicalModel;
+/** A container for persisting spatial location elements.
+ * @see [[SpatialLocationPartition]]
+ * @public
+ */
+class SpatialLocationModel extends SpatialModel {
+    /** @internal */
+    static get className() { return "SpatialLocationModel"; }
+    /** Insert a SpatialLocationPartition and a SpatialLocationModel that sub-models it.
+     * @param iModelDb Insert into this iModel
+     * @param parentSubjectId The SpatialLocationPartition will be inserted as a child of this Subject element.
+     * @param name The name of the SpatialLocationPartition that the new SpatialLocationModel will sub-model.
+     * @param isPlanProjection Optional value (default is false) that indicates if the contents of this model are expected to be in an XY plane.
+     * @returns The Id of the newly inserted SpatialLocationPartition and SpatialLocationModel (same value).
+     * @throws [[IModelError]] if there is an insert problem.
+     */
+    static insert(iModelDb, parentSubjectId, name, isPlanProjection) {
+        const partitionProps = {
+            classFullName: Element_1.SpatialLocationPartition.classFullName,
+            model: core_common_1.IModel.repositoryModelId,
+            parent: new NavigationRelationship_1.SubjectOwnsPartitionElements(parentSubjectId),
+            code: Element_1.SpatialLocationPartition.createCode(iModelDb, parentSubjectId, name),
+        };
+        const partitionId = iModelDb.elements.insertElement(partitionProps);
+        const modelProps = {
+            classFullName: this.classFullName,
+            modeledElement: { id: partitionId },
+            isPlanProjection,
+        };
+        return iModelDb.models.insertModel(modelProps);
+    }
+}
+exports.SpatialLocationModel = SpatialLocationModel;
+/** A 2d model that holds [[DrawingGraphic]]s. DrawingModels may be dimensional or non-dimensional.
+ * @public
+ */
+class DrawingModel extends GraphicalModel2d {
+    /** @internal */
+    static get className() { return "DrawingModel"; }
+}
+exports.DrawingModel = DrawingModel;
+/** A container for persisting section [[DrawingGraphic]]s.
+ * @public
+ */
+class SectionDrawingModel extends DrawingModel {
+    /** @internal */
+    static get className() { return "SectionDrawingModel"; }
+}
+exports.SectionDrawingModel = SectionDrawingModel;
+/** A container for persisting [[ViewAttachment]]s and [[DrawingGraphic]]s.
+ * A SheetModel is a digital representation of a *sheet of paper*. SheetModels are 2d models in bounded paper coordinates.
+ * SheetModels may contain annotation Elements as well as references to 2d or 3d Views.
+ * @public
+ */
+class SheetModel extends GraphicalModel2d {
+    /** @internal */
+    static get className() { return "SheetModel"; }
+}
+exports.SheetModel = SheetModel;
+/** A container for persisting role elements.
+ * @public
+ */
+class RoleModel extends Model {
+    /** @internal */
+    static get className() { return "RoleModel"; }
+}
+exports.RoleModel = RoleModel;
+/** A container for persisting information elements.
+ * @public
+ */
+class InformationModel extends Model {
+    /** @internal */
+    static get className() { return "InformationModel"; }
+}
+exports.InformationModel = InformationModel;
+/** A container for persisting group information elements.
+ * @see [[GroupInformationPartition]]
+ * @public
+ */
+class GroupInformationModel extends InformationModel {
+    /** @internal */
+    static get className() { return "GroupInformationModel"; }
+}
+exports.GroupInformationModel = GroupInformationModel;
+/** A container for persisting Information Record Elements
+ * @see [[InformationRecordPartition]]
+ * @public
+ */
+class InformationRecordModel extends InformationModel {
+    /** @internal */
+    static get className() { return "InformationRecordModel"; }
+    /** Insert a InformationRecordPartition and a InformationRecordModel that sub-models it.
+     * @param iModelDb Insert into this iModel
+     * @param parentSubjectId The InformationRecordPartition will be inserted as a child of this Subject element.
+     * @param name The name of the InformationRecordPartition that the new InformationRecordModel will sub-model.
+     * @returns The Id of the newly inserted InformationRecordModel.
+     * @throws [[IModelError]] if there is an insert problem.
+     */
+    static insert(iModelDb, parentSubjectId, name) {
+        const partitionProps = {
+            classFullName: Element_1.InformationRecordPartition.classFullName,
+            model: core_common_1.IModel.repositoryModelId,
+            parent: new NavigationRelationship_1.SubjectOwnsPartitionElements(parentSubjectId),
+            code: Element_1.InformationRecordPartition.createCode(iModelDb, parentSubjectId, name),
+        };
+        const partitionId = iModelDb.elements.insertElement(partitionProps);
+        return iModelDb.models.insertModel({
+            classFullName: this.classFullName,
+            modeledElement: { id: partitionId },
+        });
+    }
+}
+exports.InformationRecordModel = InformationRecordModel;
+/** A container for persisting definition elements.
+ * @see [[DefinitionPartition]]
+ * @public
+ */
+class DefinitionModel extends InformationModel {
+    /** @internal */
+    static get className() { return "DefinitionModel"; }
+    /** Insert a DefinitionPartition and a DefinitionModel that sub-models it.
+     * @param iModelDb Insert into this iModel
+     * @param parentSubjectId The DefinitionPartition will be inserted as a child of this Subject element.
+     * @param name The name of the DefinitionPartition that the new DefinitionModel will sub-model.
+     * @returns The Id of the newly inserted DefinitionModel.
+     * @throws [[IModelError]] if there is an insert problem.
+     */
+    static insert(iModelDb, parentSubjectId, name) {
+        const partitionProps = {
+            classFullName: Element_1.DefinitionPartition.classFullName,
+            model: core_common_1.IModel.repositoryModelId,
+            parent: new NavigationRelationship_1.SubjectOwnsPartitionElements(parentSubjectId),
+            code: Element_1.DefinitionPartition.createCode(iModelDb, parentSubjectId, name),
+        };
+        const partitionId = iModelDb.elements.insertElement(partitionProps);
+        return iModelDb.models.insertModel({
+            classFullName: this.classFullName,
+            modeledElement: { id: partitionId },
+        });
+    }
+}
+exports.DefinitionModel = DefinitionModel;
+/** The singleton container of repository-related information elements.
+ * @public
+ */
+class RepositoryModel extends DefinitionModel {
+    /** @internal */
+    static get className() { return "RepositoryModel"; }
+}
+exports.RepositoryModel = RepositoryModel;
+/** Contains a list of document elements.
+ * @see [[DocumentPartition]]
+ * @public
+ */
+class DocumentListModel extends InformationModel {
+    /** @internal */
+    static get className() { return "DocumentListModel"; }
+    /** Insert a DocumentPartition and a DocumentListModel that sub-models it.
+     * @param iModelDb Insert into this iModel
+     * @param parentSubjectId The DocumentPartition will be inserted as a child of this Subject element.
+     * @param name The name of the DocumentPartition that the new DocumentListModel will sub-model.
+     * @returns The Id of the newly inserted DocumentPartition and DocumentListModel (same value)
+     * @throws [[IModelError]] if there is an insert problem.
+     */
+    static insert(iModelDb, parentSubjectId, name) {
+        const partitionProps = {
+            classFullName: Element_1.DocumentPartition.classFullName,
+            model: core_common_1.IModel.repositoryModelId,
+            parent: new NavigationRelationship_1.SubjectOwnsPartitionElements(parentSubjectId),
+            code: Element_1.DocumentPartition.createCode(iModelDb, parentSubjectId, name),
+        };
+        const partitionId = iModelDb.elements.insertElement(partitionProps);
+        return iModelDb.models.insertModel({
+            classFullName: this.classFullName,
+            modeledElement: { id: partitionId },
+        });
+    }
+}
+exports.DocumentListModel = DocumentListModel;
+/** A container for persisting link elements.
+ * @see [[LinkPartition]]
+ * @public
+ */
+class LinkModel extends InformationModel {
+    /** @internal */
+    static get className() { return "LinkModel"; }
+}
+exports.LinkModel = LinkModel;
+/** The singleton container for repository-specific definition elements.
+ * @public
+ */
+class DictionaryModel extends DefinitionModel {
+    /** @internal */
+    static get className() { return "DictionaryModel"; }
+}
+exports.DictionaryModel = DictionaryModel;
+/** Obtains and displays multi-resolution tiled raster organized according to the WebMercator tiling system.
+ * @public
+ */
+class WebMercatorModel extends SpatialModel {
+    /** @internal */
+    static get className() { return "WebMercatorModel"; }
+}
+exports.WebMercatorModel = WebMercatorModel;
 //# sourceMappingURL=Model.js.map