@itwin/core-backend 3.0.0-dev.100

package/lib/cjs/Model.js

@@ -0,0 +1,469 @@
+"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");
+    }
+    /** 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.iModel.models.insertModel(this); }
+    /** Update this Model in the iModel. */
+    update() { this.iModel.models.updateModel(this); }
+    /** 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;
+//# sourceMappingURL=Model.js.map

package/lib/cjs/Model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Model.js","sourceRoot":"","sources":["../../src/Model.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,qBAAqB;AAErB,sDAAwE;AACxE,wDAAwD;AACxD,oDAG4B;AAC5B,uCAA4I;AAC5I,qCAAkC;AAElC,qEAAwE;AA0CxE;;;;GAIG;AACH,MAAa,KAAM,SAAQ,eAAM;IAY/B,gBAAgB;IAChB,YAAY,KAAiB,EAAE,MAAgB;QAC7C,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,8IAA8I;QACxL,IAAI,CAAC,SAAS,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,CAAC,cAAc,GAAG,EAAE,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC,iCAAiC;IACtF,CAAC;IAlBD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,OAAO,CAAC,CAAC,CAAC;IAClE,gBAAgB;IACT,MAAM,KAAc,mBAAmB,KAAK,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAiBjG;;OAEG;IACa,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAgB,CAAC;QACzC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,cAAc;QACpC,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAoB;QAC5C,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,CAAC;QACtB,IAAI,KAAK,CAAC,WAAW,EAAI,uDAAuD;YAC9E,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,WAAW,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC;IAClF,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAC,UAAU,CAAC,IAAkB;QAC5C,gGAAgG;IAClG,CAAC;IAED;;;;;OAKG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAoB;QAC5C,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAC,SAAS,CAAC,IAAkB;IAC7C,CAAC;IAED;;;;;OAKG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAiB;QACzC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAC,SAAS,CAAC,IAAkB,IAAU,CAAC;IAExD;;;;;OAKG;IACO,MAAM,CAAC,eAAe,CAAC,IAA8B,IAAU,CAAC;IAE1E;;;;OAIG;IACO,MAAM,CAAC,iBAAiB,CAAC,IAA2B,IAAU,CAAC;IAEzE;;;;;OAKG;IACO,MAAM,CAAC,eAAe,CAAC,IAA8B,IAAU,CAAC;IAE1E;;;;OAIG;IACO,MAAM,CAAC,gBAAgB,CAAC,IAA2B,IAAU,CAAC;IAExE;;;;;OAKG;IACO,MAAM,CAAC,eAAe,CAAC,IAA2B,IAAU,CAAC;IAEvE;;;;OAIG;IACO,MAAM,CAAC,gBAAgB,CAAC,IAA2B,IAAU,CAAC;IAEhE,oBAAoB,KAAU,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS;QAAE,IAAI,CAAC,cAAc,CAAC,SAAS,GAAG,IAAI,MAAM,EAAE,CAAC,CAAC,OAAO,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC;IAE/J,qDAAqD;IAC9C,iBAAiB,CAAC,SAAiB,IAAI,OAAO,IAAI,CAAC,oBAAoB,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE9F,yEAAyE;IAClE,iBAAiB,CAAC,SAAiB,EAAE,KAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAE3G,sFAAsF;IAC/E,oBAAoB,CAAC,SAAiB,IAAI,OAAO,IAAI,CAAC,oBAAoB,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE1F,eAAe,CAAC,IAAY,IAAS,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACxE,eAAe,CAAC,IAAY,EAAE,KAAU,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAEvF,sCAAsC;IAC/B,MAAM,KAAK,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChE,uCAAuC;IAChC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACzD,yCAAyC;IAClC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CAC7D;AAvJD,sBAuJC;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,KAAK;IAKvC,gBAAgB;IAChB,YAAY,KAA0B,EAAE,MAAgB,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAHnF,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAI3E,kFAAkF;IAC3E,YAAY;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC;QACrF,OAAO,uBAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;CACF;AAbD,wCAaC;AAED;;GAEG;AACH,MAAsB,gBAAiB,SAAQ,cAAc;IAc3D,gBAAgB;IAChB,YAAY,KAA4B,EAAE,MAAgB;QACxD,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,qBAAqB,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAC3E,IAAI,CAAC,gBAAgB,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACnE,CAAC;IAVD,0HAA0H;IAC1H,IAAW,kBAAkB,KAAc,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAEhF,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;IAO7E,gBAAgB;IACA,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAA2B,CAAC;QACpD,IAAI,IAAI,CAAC,qBAAqB;YAAE,GAAG,CAAC,qBAAqB,GAAG,IAAI,CAAC;QACjE,IAAI,IAAI,CAAC,gBAAgB;YAAE,GAAG,CAAC,gBAAgB,GAAG,IAAI,CAAC;QACvD,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AA3BD,4CA2BC;AAED;;GAEG;AACH,MAAsB,gBAAiB,SAAQ,cAAc;IAK3D,gBAAgB;IAChB,YAAY,KAA4B,EAAE,MAAgB,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAHrF,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;IAG7E,gBAAgB;IACA,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAA2B,CAAC;QACpD,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY;YAAE,GAAG,CAAC,YAAY,GAAG,uBAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5F,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAbD,4CAaC;AAED;;GAEG;AACH,MAAsB,gBAAiB,SAAQ,gBAAgB;IAC7D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;CAC9E;AAHD,4CAGC;AAED;;;;GAIG;AACH,MAAsB,gBAAiB,SAAQ,gBAAgB;IAC7D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;CAC9E;AAHD,4CAGC;AAED;;GAEG;AACH,MAAsB,YAAa,SAAQ,gBAAgB;IACzD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;CAC1E;AAHD,oCAGC;AAED;;;GAGG;AACH,MAAa,aAAc,SAAQ,YAAY;IAC7C,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,eAAe,CAAC,CAAC,CAAC;IAC1E;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,eAA2B,EAAE,IAAY,EAAE,gBAA0B;QAC5G,MAAM,cAAc,GAAqC;YACvD,aAAa,EAAE,2BAAiB,CAAC,aAAa;YAC9C,KAAK,EAAE,oBAAM,CAAC,iBAAiB;YAC/B,MAAM,EAAE,IAAI,qDAA4B,CAAC,eAAe,CAAC;YACzD,IAAI,EAAE,2BAAiB,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC;SACpE,CAAC;QACF,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QACpE,MAAM,UAAU,GAA0B;YACxC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;YACnC,gBAAgB;SACjB,CAAC;QACF,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC;CACF;AA1BD,sCA0BC;AAED;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,YAAY;IACpD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IACjF;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,eAA2B,EAAE,IAAY,EAAE,gBAA0B;QAC5G,MAAM,cAAc,GAAqC;YACvD,aAAa,EAAE,kCAAwB,CAAC,aAAa;YACrD,KAAK,EAAE,oBAAM,CAAC,iBAAiB;YAC/B,MAAM,EAAE,IAAI,qDAA4B,CAAC,eAAe,CAAC;YACzD,IAAI,EAAE,kCAAwB,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC;SAC3E,CAAC;QACF,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QACpE,MAAM,UAAU,GAA0B;YACxC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;YACnC,gBAAgB;SACjB,CAAC;QACF,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC;CACF;AA1BD,oDA0BC;AAED;;GAEG;AACH,MAAa,YAAa,SAAQ,gBAAgB;IAChD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;CAC1E;AAHD,oCAGC;AAED;;GAEG;AACH,MAAa,mBAAoB,SAAQ,YAAY;IACnD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,qBAAqB,CAAC,CAAC,CAAC;CACjF;AAHD,kDAGC;AAED;;;;GAIG;AACH,MAAa,UAAW,SAAQ,gBAAgB;IAC9C,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,YAAY,CAAC,CAAC,CAAC;CACxE;AAHD,gCAGC;AAED;;GAEG;AACH,MAAa,SAAU,SAAQ,KAAK;IAClC,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,WAAW,CAAC,CAAC,CAAC;CACvE;AAHD,8BAGC;AAED;;GAEG;AACH,MAAsB,gBAAiB,SAAQ,KAAK;IAClD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;CAC9E;AAHD,4CAGC;AAED;;;GAGG;AACH,MAAsB,qBAAsB,SAAQ,gBAAgB;IAClE,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,uBAAuB,CAAC,CAAC,CAAC;CACnF;AAHD,sDAGC;AAED;;;GAGG;AACH,MAAa,sBAAuB,SAAQ,gBAAgB;IAC1D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,wBAAwB,CAAC,CAAC,CAAC;IAEnF;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,eAA2B,EAAE,IAAY;QAChF,MAAM,cAAc,GAAqC;YACvD,aAAa,EAAE,oCAA0B,CAAC,aAAa;YACvD,KAAK,EAAE,oBAAM,CAAC,iBAAiB;YAC/B,MAAM,EAAE,IAAI,qDAA4B,CAAC,eAAe,CAAC;YACzD,IAAI,EAAE,oCAA0B,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC;SAC7E,CAAC;QACF,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC;YACjC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;SACpC,CAAC,CAAC;IACL,CAAC;CACF;AAxBD,wDAwBC;AAED;;;GAGG;AACH,MAAa,eAAgB,SAAQ,gBAAgB;IACnD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAE5E;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,eAA2B,EAAE,IAAY;QAChF,MAAM,cAAc,GAAqC;YACvD,aAAa,EAAE,6BAAmB,CAAC,aAAa;YAChD,KAAK,EAAE,oBAAM,CAAC,iBAAiB;YAC/B,MAAM,EAAE,IAAI,qDAA4B,CAAC,eAAe,CAAC;YACzD,IAAI,EAAE,6BAAmB,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC;SACtE,CAAC;QACF,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC;YACjC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;SACpC,CAAC,CAAC;IACL,CAAC;CACF;AAxBD,0CAwBC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,eAAe;IAClD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;CAC7E;AAHD,0CAGC;AAED;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,gBAAgB;IACrD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,mBAAmB,CAAC,CAAC,CAAC;IAC9E;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,eAA2B,EAAE,IAAY;QAChF,MAAM,cAAc,GAAqC;YACvD,aAAa,EAAE,2BAAiB,CAAC,aAAa;YAC9C,KAAK,EAAE,oBAAM,CAAC,iBAAiB;YAC/B,MAAM,EAAE,IAAI,qDAA4B,CAAC,eAAe,CAAC;YACzD,IAAI,EAAE,2BAAiB,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC;SACpE,CAAC;QACF,MAAM,WAAW,GAAe,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QAChF,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC;YACjC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;SACpC,CAAC,CAAC;IACL,CAAC;CACF;AAvBD,8CAuBC;AAED;;;GAGG;AACH,MAAa,SAAU,SAAQ,gBAAgB;IAC7C,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,WAAW,CAAC,CAAC,CAAC;CACvE;AAHD,8BAGC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,eAAe;IAClD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;CAC7E;AAHD,0CAGC;AAED;;GAEG;AACH,MAAa,gBAAiB,SAAQ,YAAY;IAChD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;CAC9E;AAHD,4CAGC","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/** @packageDocumentation\r\n * @module Models\r\n */\r\n\r\n// cspell:ignore elid\r\n\r\nimport { GuidString, Id64String, JsonUtils } from \"@itwin/core-bentley\";\r\nimport { Point2d, Range3d } from \"@itwin/core-geometry\";\r\nimport {\r\n  AxisAlignedBox3d, ElementProps, GeometricModel2dProps, GeometricModel3dProps, GeometricModelProps, IModel, InformationPartitionElementProps,\r\n  ModelProps, RelatedElement,\r\n} from \"@itwin/core-common\";\r\nimport { DefinitionPartition, DocumentPartition, InformationRecordPartition, PhysicalPartition, SpatialLocationPartition } from \"./Element\";\r\nimport { Entity } from \"./Entity\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { SubjectOwnsPartitionElements } from \"./NavigationRelationship\";\r\n\r\n/** Argument for the `Model.onXxx` static methods\r\n * @beta\r\n */\r\nexport interface OnModelArg {\r\n  /** The iModel for the Model affected. */\r\n  iModel: IModelDb;\r\n}\r\n\r\n/** Argument for the `Model.onXxx` static methods that supply the properties of a Model to be inserted or updated.\r\n * @beta\r\n */\r\nexport interface OnModelPropsArg extends OnModelArg {\r\n  /** The new properties of the Model affected. */\r\n  props: Readonly<ModelProps>;\r\n}\r\n\r\n/** Argument for the `Model.onXxx` static methods that only supply the Id of the affected Model.\r\n * @beta\r\n */\r\nexport interface OnModelIdArg extends OnModelArg {\r\n  /** The Id of the Model affected */\r\n  id: Id64String;\r\n}\r\n\r\n/** Argument for the `Model.onXxxElement` static methods that supply the properties of an Element for a Model.\r\n * @beta\r\n */\r\nexport interface OnElementInModelPropsArg extends OnModelIdArg {\r\n  /** The new properties of an Element for the affected Model */\r\n  elementProps: Readonly<ElementProps>;\r\n}\r\n\r\n/** Argument for the `Model.onXxxElement` static methods that supply the Id of an Element for a Model.\r\n * @beta\r\n */\r\nexport interface OnElementInModelIdArg extends OnModelIdArg {\r\n  /** The Id of the Element for the affected Model */\r\n  elementId: Id64String;\r\n}\r\n\r\n/** A Model is a container for persisting a collection of related elements within an iModel.\r\n * See [[IModelDb.Models]] for how to query and manage the Models in an IModelDb.\r\n * See [Creating models]($docs/learning/backend/CreateModels.md)\r\n * @public\r\n */\r\nexport class Model extends Entity implements ModelProps {\r\n  /** @internal */\r\n  public static override get className(): string { return \"Model\"; }\r\n  /** @internal */\r\n  public static override get protectedOperations() { return [\"onInsert\", \"onUpdate\", \"onDelete\"]; }\r\n  public readonly modeledElement!: RelatedElement;\r\n  public readonly name: string;\r\n  public readonly parentModel!: Id64String;\r\n  public readonly jsonProperties: { [key: string]: any };\r\n  public isPrivate: boolean;\r\n  public isTemplate: boolean;\r\n\r\n  /** @internal */\r\n  constructor(props: ModelProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    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\r\n    this.isPrivate = JsonUtils.asBool(props.isPrivate);\r\n    this.isTemplate = JsonUtils.asBool(props.isTemplate);\r\n    this.jsonProperties = { ...props.jsonProperties }; // make sure we have our own copy\r\n  }\r\n\r\n  /** Add all properties of a Model to a json object.\r\n   * @internal\r\n   */\r\n  public override toJSON(): ModelProps {\r\n    const val = super.toJSON() as ModelProps;\r\n    val.name = this.name; // for cloning\r\n    return val;\r\n  }\r\n\r\n  /** Called before a new Model is inserted.\r\n   * @note throw an exception to disallow the insert\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model to be inserted\r\n   * @beta\r\n   */\r\n  protected static onInsert(arg: OnModelPropsArg): void {\r\n    const { props } = arg;\r\n    if (props.parentModel)   // inserting requires shared lock on parent, if present\r\n      arg.iModel.locks.checkSharedLock(props.parentModel, \"parent model\", \"insert\");\r\n  }\r\n\r\n  /** Called after a new Model is inserted.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model that was inserted\r\n   * @beta\r\n   */\r\n  protected static onInserted(_arg: OnModelIdArg): void {\r\n    // we don't need to tell LockControl about models being created - their ModeledElement does that\r\n  }\r\n\r\n  /** Called before a Model is updated.\r\n   * @note throw an exception to disallow the update\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model to be updated\r\n   * @beta\r\n   */\r\n  protected static onUpdate(arg: OnModelPropsArg): void {\r\n    arg.iModel.locks.checkExclusiveLock(arg.props.id!, \"model\", \"update\");\r\n  }\r\n\r\n  /** Called after a Model is updated.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model that was updated.\r\n   * @beta\r\n   */\r\n  protected static onUpdated(_arg: OnModelIdArg): void {\r\n  }\r\n\r\n  /** Called before a Model is deleted.\r\n   * @note throw an exception to disallow the delete\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model to be deleted\r\n   * @beta\r\n   */\r\n  protected static onDelete(arg: OnModelIdArg): void {\r\n    arg.iModel.locks.checkExclusiveLock(arg.id, \"model\", \"delete\");\r\n  }\r\n\r\n  /** Called after a Model was deleted.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model that was deleted\r\n   * @beta\r\n   */\r\n  protected static onDeleted(_arg: OnModelIdArg): void { }\r\n\r\n  /** Called before a prospective Element is to be inserted into an instance of a Model of this class.\r\n   * @note throw an exception to disallow the insert\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model to hold the element\r\n   * @beta\r\n   */\r\n  protected static onInsertElement(_arg: OnElementInModelPropsArg): void { }\r\n\r\n  /** Called after an Element has been inserted into an instance of a Model of this class.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model holding the element\r\n   * @beta\r\n   */\r\n  protected static onInsertedElement(_arg: OnElementInModelIdArg): void { }\r\n\r\n  /** Called when an Element in an instance of a Model of this class is about to be updated.\r\n   * @note throw an exception to disallow the update\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model holding the element\r\n   * @beta\r\n   */\r\n  protected static onUpdateElement(_arg: OnElementInModelPropsArg): void { }\r\n\r\n  /** Called after an Element in an instance of a Model of this class has been updated.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model holding the element\r\n   * @beta\r\n   */\r\n  protected static onUpdatedElement(_arg: OnElementInModelIdArg): void { }\r\n\r\n  /** Called when an Element in an instance of a Model of this class is about to be deleted.\r\n   * @note throw an exception to disallow the delete\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model holding the element\r\n   * @beta\r\n   */\r\n  protected static onDeleteElement(_arg: OnElementInModelIdArg): void { }\r\n\r\n  /** Called after an Element in an instance of a Model of this class has been deleted.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model that held the element\r\n   * @beta\r\n   */\r\n  protected static onDeletedElement(_arg: OnElementInModelIdArg): void { }\r\n\r\n  private getAllUserProperties(): any { if (!this.jsonProperties.UserProps) this.jsonProperties.UserProps = new Object(); return this.jsonProperties.UserProps; }\r\n\r\n  /** Get a set of JSON user properties by namespace */\r\n  public getUserProperties(namespace: string) { return this.getAllUserProperties()[namespace]; }\r\n\r\n  /** Change a set of user JSON properties of this Element by namespace. */\r\n  public setUserProperties(nameSpace: string, value: any) { this.getAllUserProperties()[nameSpace] = value; }\r\n\r\n  /** Remove a set of JSON user properties, specified by namespace, from this Element */\r\n  public removeUserProperties(nameSpace: string) { delete this.getAllUserProperties()[nameSpace]; }\r\n\r\n  public getJsonProperty(name: string): any { return this.jsonProperties[name]; }\r\n  public setJsonProperty(name: string, value: any) { this.jsonProperties[name] = value; }\r\n\r\n  /** Insert this Model in the iModel */\r\n  public insert() { return this.iModel.models.insertModel(this); }\r\n  /** Update this Model in the iModel. */\r\n  public update() { this.iModel.models.updateModel(this); }\r\n  /** Delete this Model from the iModel. */\r\n  public delete() { this.iModel.models.deleteModel(this.id); }\r\n}\r\n\r\n/** A container for persisting geometric elements.\r\n * @public\r\n */\r\nexport class GeometricModel extends Model implements GeometricModelProps {\r\n  public geometryGuid?: GuidString; // Initialized by the Entity constructor\r\n\r\n  /** @internal */\r\n  public static override get className(): string { return \"GeometricModel\"; }\r\n  /** @internal */\r\n  constructor(props: GeometricModelProps, iModel: IModelDb) { super(props, iModel); }\r\n\r\n  /** Query for the union of the extents of the elements contained by this model. */\r\n  public queryExtents(): AxisAlignedBox3d {\r\n    const extents = this.iModel.nativeDb.queryModelExtents({ id: this.id }).modelExtents;\r\n    return Range3d.fromJSON(extents);\r\n  }\r\n}\r\n\r\n/** A container for persisting 3d geometric elements.\r\n * @public\r\n */\r\nexport abstract class GeometricModel3d extends GeometricModel implements GeometricModel3dProps {\r\n  /** If true, then the elements in this GeometricModel3d are expected to be in an XY plane.\r\n   * @note The associated ECProperty was added to the BisCore schema in version 1.0.8\r\n   */\r\n  public readonly isPlanProjection: boolean;\r\n  /** If true, then the elements in this GeometricModel3d are not in real-world coordinates and will not be in the spatial index.\r\n   * @note The associated ECProperty was added to the BisCore schema in version 1.0.8\r\n   */\r\n  public readonly isNotSpatiallyLocated: boolean;\r\n  /** If true, then the elements in this GeometricModel3d are in real-world coordinates and will be in the spatial index. */\r\n  public get isSpatiallyLocated(): boolean { return !this.isNotSpatiallyLocated; }\r\n\r\n  /** @internal */\r\n  public static override get className(): string { return \"GeometricModel3d\"; }\r\n  /** @internal */\r\n  constructor(props: GeometricModel3dProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.isNotSpatiallyLocated = JsonUtils.asBool(props.isNotSpatiallyLocated);\r\n    this.isPlanProjection = JsonUtils.asBool(props.isPlanProjection);\r\n  }\r\n  /** @internal */\r\n  public override toJSON(): GeometricModel3dProps {\r\n    const val = super.toJSON() as GeometricModel3dProps;\r\n    if (this.isNotSpatiallyLocated) val.isNotSpatiallyLocated = true;\r\n    if (this.isPlanProjection) val.isPlanProjection = true;\r\n    return val;\r\n  }\r\n}\r\n\r\n/** A container for persisting 2d geometric elements.\r\n * @public\r\n */\r\nexport abstract class GeometricModel2d extends GeometricModel implements GeometricModel2dProps {\r\n  /** The actual coordinates of (0,0) in modeling coordinates. An offset applied to all modeling coordinates. */\r\n  public globalOrigin?: Point2d; // Initialized by the Entity constructor\r\n  /** @internal */\r\n  public static override get className(): string { return \"GeometricModel2d\"; }\r\n  /** @internal */\r\n  constructor(props: GeometricModel2dProps, iModel: IModelDb) { super(props, iModel); }\r\n  /** @internal */\r\n  public override toJSON(): GeometricModel2dProps {\r\n    const val = super.toJSON() as GeometricModel2dProps;\r\n    if (undefined !== this.globalOrigin) val.globalOrigin = Point2d.fromJSON(this.globalOrigin);\r\n    return val;\r\n  }\r\n}\r\n\r\n/** A container for persisting 2d graphical elements.\r\n * @public\r\n */\r\nexport abstract class GraphicalModel2d extends GeometricModel2d {\r\n  /** @internal */\r\n  public static override get className(): string { return \"GraphicalModel2d\"; }\r\n}\r\n\r\n/** A container for persisting GraphicalElement3d instances.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.8\r\n * @see [[GraphicalPartition3d]]\r\n * @public\r\n */\r\nexport abstract class GraphicalModel3d extends GeometricModel3d {\r\n  /** @internal */\r\n  public static override get className(): string { return \"GraphicalModel3d\"; }\r\n}\r\n\r\n/** A container for persisting 3d geometric elements that are spatially located.\r\n * @public\r\n */\r\nexport abstract class SpatialModel extends GeometricModel3d {\r\n  /** @internal */\r\n  public static override get className(): string { return \"SpatialModel\"; }\r\n}\r\n\r\n/** A container for persisting physical elements that model physical space.\r\n * @see [[PhysicalPartition]]\r\n * @public\r\n */\r\nexport class PhysicalModel extends SpatialModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"PhysicalModel\"; }\r\n  /** Insert a PhysicalPartition and a PhysicalModel that sub-models it.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param parentSubjectId The PhysicalPartition will be inserted as a child of this Subject element.\r\n   * @param name The name of the PhysicalPartition that the new PhysicalModel will sub-model.\r\n   * @param isPlanProjection Optional value (default is false) that indicates if the contents of this model are expected to be in an XY plane.\r\n   * @returns The Id of the newly inserted PhysicalPartition and PhysicalModel (same value).\r\n   * @throws [[IModelError]] if there is an insert problem.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string, isPlanProjection?: boolean): Id64String {\r\n    const partitionProps: InformationPartitionElementProps = {\r\n      classFullName: PhysicalPartition.classFullName,\r\n      model: IModel.repositoryModelId,\r\n      parent: new SubjectOwnsPartitionElements(parentSubjectId),\r\n      code: PhysicalPartition.createCode(iModelDb, parentSubjectId, name),\r\n    };\r\n    const partitionId = iModelDb.elements.insertElement(partitionProps);\r\n    const modelProps: GeometricModel3dProps = {\r\n      classFullName: this.classFullName,\r\n      modeledElement: { id: partitionId },\r\n      isPlanProjection,\r\n    };\r\n    return iModelDb.models.insertModel(modelProps);\r\n  }\r\n}\r\n\r\n/** A container for persisting spatial location elements.\r\n * @see [[SpatialLocationPartition]]\r\n * @public\r\n */\r\nexport class SpatialLocationModel extends SpatialModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"SpatialLocationModel\"; }\r\n  /** Insert a SpatialLocationPartition and a SpatialLocationModel that sub-models it.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param parentSubjectId The SpatialLocationPartition will be inserted as a child of this Subject element.\r\n   * @param name The name of the SpatialLocationPartition that the new SpatialLocationModel will sub-model.\r\n   * @param isPlanProjection Optional value (default is false) that indicates if the contents of this model are expected to be in an XY plane.\r\n   * @returns The Id of the newly inserted SpatialLocationPartition and SpatialLocationModel (same value).\r\n   * @throws [[IModelError]] if there is an insert problem.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string, isPlanProjection?: boolean): Id64String {\r\n    const partitionProps: InformationPartitionElementProps = {\r\n      classFullName: SpatialLocationPartition.classFullName,\r\n      model: IModel.repositoryModelId,\r\n      parent: new SubjectOwnsPartitionElements(parentSubjectId),\r\n      code: SpatialLocationPartition.createCode(iModelDb, parentSubjectId, name),\r\n    };\r\n    const partitionId = iModelDb.elements.insertElement(partitionProps);\r\n    const modelProps: GeometricModel3dProps = {\r\n      classFullName: this.classFullName,\r\n      modeledElement: { id: partitionId },\r\n      isPlanProjection,\r\n    };\r\n    return iModelDb.models.insertModel(modelProps);\r\n  }\r\n}\r\n\r\n/** A 2d model that holds [[DrawingGraphic]]s. DrawingModels may be dimensional or non-dimensional.\r\n * @public\r\n */\r\nexport class DrawingModel extends GraphicalModel2d {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DrawingModel\"; }\r\n}\r\n\r\n/** A container for persisting section [[DrawingGraphic]]s.\r\n * @public\r\n */\r\nexport class SectionDrawingModel extends DrawingModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"SectionDrawingModel\"; }\r\n}\r\n\r\n/** A container for persisting [[ViewAttachment]]s and [[DrawingGraphic]]s.\r\n * A SheetModel is a digital representation of a *sheet of paper*. SheetModels are 2d models in bounded paper coordinates.\r\n * SheetModels may contain annotation Elements as well as references to 2d or 3d Views.\r\n * @public\r\n */\r\nexport class SheetModel extends GraphicalModel2d {\r\n  /** @internal */\r\n  public static override get className(): string { return \"SheetModel\"; }\r\n}\r\n\r\n/** A container for persisting role elements.\r\n * @public\r\n */\r\nexport class RoleModel extends Model {\r\n  /** @internal */\r\n  public static override get className(): string { return \"RoleModel\"; }\r\n}\r\n\r\n/** A container for persisting information elements.\r\n * @public\r\n */\r\nexport abstract class InformationModel extends Model {\r\n  /** @internal */\r\n  public static override get className(): string { return \"InformationModel\"; }\r\n}\r\n\r\n/** A container for persisting group information elements.\r\n * @see [[GroupInformationPartition]]\r\n * @public\r\n */\r\nexport abstract class GroupInformationModel extends InformationModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"GroupInformationModel\"; }\r\n}\r\n\r\n/** A container for persisting Information Record Elements\r\n * @see [[InformationRecordPartition]]\r\n * @public\r\n */\r\nexport class InformationRecordModel extends InformationModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"InformationRecordModel\"; }\r\n\r\n  /** Insert a InformationRecordPartition and a InformationRecordModel that sub-models it.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param parentSubjectId The InformationRecordPartition will be inserted as a child of this Subject element.\r\n   * @param name The name of the InformationRecordPartition that the new InformationRecordModel will sub-model.\r\n   * @returns The Id of the newly inserted InformationRecordModel.\r\n   * @throws [[IModelError]] if there is an insert problem.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string): Id64String {\r\n    const partitionProps: InformationPartitionElementProps = {\r\n      classFullName: InformationRecordPartition.classFullName,\r\n      model: IModel.repositoryModelId,\r\n      parent: new SubjectOwnsPartitionElements(parentSubjectId),\r\n      code: InformationRecordPartition.createCode(iModelDb, parentSubjectId, name),\r\n    };\r\n    const partitionId = iModelDb.elements.insertElement(partitionProps);\r\n    return iModelDb.models.insertModel({\r\n      classFullName: this.classFullName,\r\n      modeledElement: { id: partitionId },\r\n    });\r\n  }\r\n}\r\n\r\n/** A container for persisting definition elements.\r\n * @see [[DefinitionPartition]]\r\n * @public\r\n */\r\nexport class DefinitionModel extends InformationModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DefinitionModel\"; }\r\n\r\n  /** Insert a DefinitionPartition and a DefinitionModel that sub-models it.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param parentSubjectId The DefinitionPartition will be inserted as a child of this Subject element.\r\n   * @param name The name of the DefinitionPartition that the new DefinitionModel will sub-model.\r\n   * @returns The Id of the newly inserted DefinitionModel.\r\n   * @throws [[IModelError]] if there is an insert problem.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string): Id64String {\r\n    const partitionProps: InformationPartitionElementProps = {\r\n      classFullName: DefinitionPartition.classFullName,\r\n      model: IModel.repositoryModelId,\r\n      parent: new SubjectOwnsPartitionElements(parentSubjectId),\r\n      code: DefinitionPartition.createCode(iModelDb, parentSubjectId, name),\r\n    };\r\n    const partitionId = iModelDb.elements.insertElement(partitionProps);\r\n    return iModelDb.models.insertModel({\r\n      classFullName: this.classFullName,\r\n      modeledElement: { id: partitionId },\r\n    });\r\n  }\r\n}\r\n\r\n/** The singleton container of repository-related information elements.\r\n * @public\r\n */\r\nexport class RepositoryModel extends DefinitionModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"RepositoryModel\"; }\r\n}\r\n\r\n/** Contains a list of document elements.\r\n * @see [[DocumentPartition]]\r\n * @public\r\n */\r\nexport class DocumentListModel extends InformationModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DocumentListModel\"; }\r\n  /** Insert a DocumentPartition and a DocumentListModel that sub-models it.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param parentSubjectId The DocumentPartition will be inserted as a child of this Subject element.\r\n   * @param name The name of the DocumentPartition that the new DocumentListModel will sub-model.\r\n   * @returns The Id of the newly inserted DocumentPartition and DocumentListModel (same value)\r\n   * @throws [[IModelError]] if there is an insert problem.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string): Id64String {\r\n    const partitionProps: InformationPartitionElementProps = {\r\n      classFullName: DocumentPartition.classFullName,\r\n      model: IModel.repositoryModelId,\r\n      parent: new SubjectOwnsPartitionElements(parentSubjectId),\r\n      code: DocumentPartition.createCode(iModelDb, parentSubjectId, name),\r\n    };\r\n    const partitionId: Id64String = iModelDb.elements.insertElement(partitionProps);\r\n    return iModelDb.models.insertModel({\r\n      classFullName: this.classFullName,\r\n      modeledElement: { id: partitionId },\r\n    });\r\n  }\r\n}\r\n\r\n/** A container for persisting link elements.\r\n * @see [[LinkPartition]]\r\n * @public\r\n */\r\nexport class LinkModel extends InformationModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"LinkModel\"; }\r\n}\r\n\r\n/** The singleton container for repository-specific definition elements.\r\n * @public\r\n */\r\nexport class DictionaryModel extends DefinitionModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DictionaryModel\"; }\r\n}\r\n\r\n/** Obtains and displays multi-resolution tiled raster organized according to the WebMercator tiling system.\r\n * @public\r\n */\r\nexport class WebMercatorModel extends SpatialModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"WebMercatorModel\"; }\r\n}\r\n"]}

package/lib/cjs/NativeAppStorage.d.ts

@@ -0,0 +1,52 @@
+/** @packageDocumentation
+ * @module NativeApp
+ */
+import { StorageValue } from "@itwin/core-common";
+/**
+ * A local file stored in the [[NativeHost.appSettingsCacheDir]] for storing key/value pairs.
+ * @public
+ */
+export declare class NativeAppStorage {
+    private _ecdb;
+    readonly id: string;
+    private static readonly _ext;
+    private static _storages;
+    private static _init;
+    private constructor();
+    /** Set the value for a key */
+    setData(key: string, value: StorageValue): void;
+    /** Get the value for a key from this Storage. If key is not present or is null, return undefined. */
+    getData(key: string): StorageValue;
+    /** return the type of the value for a key, or undefined if not present. */
+    getValueType(key: string): "number" | "string" | "boolean" | "Uint8Array" | "null" | undefined;
+    /** return `true` if the key is present, but has a null value. */
+    hasNullValue(key: string): boolean;
+    /** Get the value for a key as a string. If it is not present, or not of type string, return undefined */
+    getString(key: string): string | undefined;
+    /** Get the value for a key as a number. If it is not present, or not of type number, return undefined */
+    getNumber(key: string): number | undefined;
+    /** Get the value for a key as a boolean. If it is not present, or not of type boolean, return undefined */
+    getBoolean(key: string): boolean | undefined;
+    /** Get the value for a key as a Uint8Array. If it is not present, or not of type Uint8Array, return undefined */
+    getUint8Array(key: string): Uint8Array | undefined;
+    /** Get all key names in this Storage */
+    getKeys(): string[];
+    /** Remove a key/value pair from this Storage */
+    removeData(key: string): void;
+    /** Remove all key/value pairs */
+    removeAll(): void;
+    /** Close this Storage. */
+    close(deleteFile?: boolean): void;
+    private static init;
+    /** find and open storage by its name. */
+    static find(name: string): NativeAppStorage;
+    /** Close all opened Storages.
+     * @internal
+     */
+    static closeAll(): void;
+    /** @internal */
+    static getStorageNames(): string[];
+    /** Open or find a Storage by name. */
+    static open(name: string): NativeAppStorage;
+}
+//# sourceMappingURL=NativeAppStorage.d.ts.map

package/lib/cjs/NativeAppStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NativeAppStorage.d.ts","sourceRoot":"","sources":["../../src/NativeAppStorage.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAe,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAQ/D;;;GAGG;AACH,qBAAa,gBAAgB;IAIP,OAAO,CAAC,KAAK;aAAwB,EAAE,EAAE,MAAM;IAHnE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAkB;IAC9C,OAAO,CAAC,MAAM,CAAC,SAAS,CAAuC;IAC/D,OAAO,CAAC,MAAM,CAAC,KAAK,CAAkB;IACtC,OAAO;IAEP,8BAA8B;IACvB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,IAAI;IA4BtD,qGAAqG;IAC9F,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY;IAsBzC,2EAA2E;IACpE,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,GAAG,SAAS;IAOrG,iEAAiE;IAC1D,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIzC,yGAAyG;IAClG,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAKjD,yGAAyG;IAClG,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAKjD,2GAA2G;IACpG,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAKnD,iHAAiH;IAC1G,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAKzD,wCAAwC;IACjC,OAAO,IAAI,MAAM,EAAE;IAU1B,gDAAgD;IACzC,UAAU,CAAC,GAAG,EAAE,MAAM;IAU7B,iCAAiC;IAC1B,SAAS;IAShB,0BAA0B;IACnB,KAAK,CAAC,UAAU,GAAE,OAAe;IAUxC,OAAO,CAAC,MAAM,CAAC,IAAI;IAMnB,yCAAyC;WAC3B,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB;IAOlD;;OAEG;WACW,QAAQ;IAKtB,gBAAgB;WACF,eAAe,IAAI,MAAM,EAAE;IAIzC,sCAAsC;WACxB,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB;CA4BnD"}