@itwin/core-backend 5.9.3 → 5.9.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. package/CHANGELOG.md +11 -1
  2. package/lib/cjs/Category.d.ts +4 -4
  3. package/lib/cjs/Category.js.map +1 -1
  4. package/lib/cjs/ChangesetECAdaptor.d.ts +6 -6
  5. package/lib/cjs/ChangesetECAdaptor.js +4 -4
  6. package/lib/cjs/ChangesetECAdaptor.js.map +1 -1
  7. package/lib/cjs/CodeSpecs.d.ts +3 -3
  8. package/lib/cjs/CodeSpecs.js.map +1 -1
  9. package/lib/cjs/DisplayStyle.d.ts +2 -2
  10. package/lib/cjs/DisplayStyle.js.map +1 -1
  11. package/lib/cjs/Element.d.ts +10 -10
  12. package/lib/cjs/Element.js +2 -2
  13. package/lib/cjs/Element.js.map +1 -1
  14. package/lib/cjs/ElementAspect.d.ts +1 -1
  15. package/lib/cjs/ElementAspect.js.map +1 -1
  16. package/lib/cjs/ElementTreeWalker.d.ts +5 -5
  17. package/lib/cjs/ElementTreeWalker.js.map +1 -1
  18. package/lib/cjs/ExternalSource.d.ts +2 -2
  19. package/lib/cjs/ExternalSource.js.map +1 -1
  20. package/lib/cjs/IModelDb.d.ts +23 -23
  21. package/lib/cjs/IModelDb.js +21 -21
  22. package/lib/cjs/IModelDb.js.map +1 -1
  23. package/lib/cjs/LineStyle.d.ts +6 -6
  24. package/lib/cjs/LineStyle.js.map +1 -1
  25. package/lib/cjs/Material.d.ts +1 -1
  26. package/lib/cjs/Material.js.map +1 -1
  27. package/lib/cjs/Model.d.ts +6 -6
  28. package/lib/cjs/Model.js.map +1 -1
  29. package/lib/cjs/Relationship.d.ts +10 -10
  30. package/lib/cjs/Relationship.js +6 -6
  31. package/lib/cjs/Relationship.js.map +1 -1
  32. package/lib/cjs/SheetIndex.d.ts +4 -4
  33. package/lib/cjs/SheetIndex.js.map +1 -1
  34. package/lib/cjs/Texture.d.ts +1 -1
  35. package/lib/cjs/Texture.js.map +1 -1
  36. package/lib/cjs/ViewDefinition.d.ts +6 -6
  37. package/lib/cjs/ViewDefinition.js.map +1 -1
  38. package/lib/cjs/annotations/ElementDrivesTextAnnotation.d.ts +1 -1
  39. package/lib/cjs/annotations/ElementDrivesTextAnnotation.js.map +1 -1
  40. package/lib/cjs/domains/FunctionalElements.d.ts +1 -1
  41. package/lib/cjs/domains/FunctionalElements.js.map +1 -1
  42. package/lib/cjs/domains/GenericElements.d.ts +2 -2
  43. package/lib/cjs/domains/GenericElements.js.map +1 -1
  44. package/lib/cjs/internal/ChannelAdmin.d.ts +2 -2
  45. package/lib/cjs/internal/ChannelAdmin.js.map +1 -1
  46. package/lib/esm/Category.d.ts +4 -4
  47. package/lib/esm/Category.js.map +1 -1
  48. package/lib/esm/ChangesetECAdaptor.d.ts +6 -6
  49. package/lib/esm/ChangesetECAdaptor.js +4 -4
  50. package/lib/esm/ChangesetECAdaptor.js.map +1 -1
  51. package/lib/esm/CodeSpecs.d.ts +3 -3
  52. package/lib/esm/CodeSpecs.js.map +1 -1
  53. package/lib/esm/DisplayStyle.d.ts +2 -2
  54. package/lib/esm/DisplayStyle.js.map +1 -1
  55. package/lib/esm/Element.d.ts +10 -10
  56. package/lib/esm/Element.js +2 -2
  57. package/lib/esm/Element.js.map +1 -1
  58. package/lib/esm/ElementAspect.d.ts +1 -1
  59. package/lib/esm/ElementAspect.js.map +1 -1
  60. package/lib/esm/ElementTreeWalker.d.ts +5 -5
  61. package/lib/esm/ElementTreeWalker.js.map +1 -1
  62. package/lib/esm/ExternalSource.d.ts +2 -2
  63. package/lib/esm/ExternalSource.js.map +1 -1
  64. package/lib/esm/IModelDb.d.ts +23 -23
  65. package/lib/esm/IModelDb.js +21 -21
  66. package/lib/esm/IModelDb.js.map +1 -1
  67. package/lib/esm/LineStyle.d.ts +6 -6
  68. package/lib/esm/LineStyle.js.map +1 -1
  69. package/lib/esm/Material.d.ts +1 -1
  70. package/lib/esm/Material.js.map +1 -1
  71. package/lib/esm/Model.d.ts +6 -6
  72. package/lib/esm/Model.js.map +1 -1
  73. package/lib/esm/Relationship.d.ts +10 -10
  74. package/lib/esm/Relationship.js +6 -6
  75. package/lib/esm/Relationship.js.map +1 -1
  76. package/lib/esm/SheetIndex.d.ts +4 -4
  77. package/lib/esm/SheetIndex.js.map +1 -1
  78. package/lib/esm/Texture.d.ts +1 -1
  79. package/lib/esm/Texture.js.map +1 -1
  80. package/lib/esm/ViewDefinition.d.ts +6 -6
  81. package/lib/esm/ViewDefinition.js.map +1 -1
  82. package/lib/esm/annotations/ElementDrivesTextAnnotation.d.ts +1 -1
  83. package/lib/esm/annotations/ElementDrivesTextAnnotation.js.map +1 -1
  84. package/lib/esm/domains/FunctionalElements.d.ts +1 -1
  85. package/lib/esm/domains/FunctionalElements.js.map +1 -1
  86. package/lib/esm/domains/GenericElements.d.ts +2 -2
  87. package/lib/esm/domains/GenericElements.js.map +1 -1
  88. package/lib/esm/internal/ChannelAdmin.d.ts +2 -2
  89. package/lib/esm/internal/ChannelAdmin.js.map +1 -1
  90. package/package.json +14 -14
@@ -626,7 +626,7 @@ export declare abstract class IModelDb extends IModel {
626
626
  * ``` ts
627
627
  * [[include:IModelDb.updateProjectExtents]]
628
628
  * ```
629
- * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.updateProjectExtents instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
629
+ * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.updateProjectExtents instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
630
630
  */
631
631
  updateProjectExtents(newExtents: AxisAlignedBox3d): void;
632
632
  /** Compute an appropriate project extents for this iModel based on the ranges of all spatial elements.
@@ -639,11 +639,11 @@ export declare abstract class IModelDb extends IModel {
639
639
  */
640
640
  computeProjectExtents(options?: ComputeProjectExtentsOptions): ComputedProjectExtents;
641
641
  /** Update the [EcefLocation]($docs/learning/glossary#eceflocation) of this iModel.
642
- * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.updateEcefLocation instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
642
+ * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.updateEcefLocation instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
643
643
  */
644
644
  updateEcefLocation(ecef: EcefLocation): void;
645
645
  /** Update the IModelProps of this iModel in the database.
646
- * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.updateIModelProps instead, within an explicit EditTxn scope (or via withEditTxn).
646
+ * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.updateIModelProps instead, within an explicit EditTxn scope (or via withEditTxn).
647
647
  */
648
648
  updateIModelProps(): void;
649
649
  /** Commit unsaved changes in memory as a Txn to this iModelDb.
@@ -652,7 +652,7 @@ export declare abstract class IModelDb extends IModel {
652
652
  * @note This will not push changes to the iModelHub.
653
653
  * @note This method should not be called from {TxnManager.withIndirectTxnModeAsync}, {TxnManager.withIndirectTxnMode} or {RebaseHandler.recompute}.
654
654
  * @see [[IModelDb.pushChanges]] to push changes to the iModelHub.
655
- * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.saveChanges instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
655
+ * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.saveChanges instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
656
656
  */
657
657
  saveChanges(description?: string): void;
658
658
  /** Commit unsaved changes in memory as a Txn to this iModelDb. This is preferable for case where application like to store additional structured information with the change that could be useful later when rebasing.
@@ -662,11 +662,11 @@ export declare abstract class IModelDb extends IModel {
662
662
  * @note This will not push changes to the iModelHub.
663
663
  * @note This method should not be called from {TxnManager.withIndirectTxnModeAsync}, {TxnManager.withIndirectTxnMode} or {RebaseHandler.recompute}.
664
664
  * @see [[IModelDb.pushChanges]] to push changes to the iModelHub.
665
- * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.saveChanges instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
665
+ * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.saveChanges instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
666
666
  */
667
667
  saveChanges(args: SaveChangesArgs): void;
668
668
  /** Abandon changes in memory that have not been saved as a Txn to this iModelDb.
669
- * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.abandonChanges instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
669
+ * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.abandonChanges instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
670
670
  */
671
671
  abandonChanges(): void;
672
672
  /**
@@ -950,13 +950,13 @@ export declare abstract class IModelDb extends IModel {
950
950
  * @param prop the FilePropertyProps that describes the new property
951
951
  * @param value either a string or a blob to save as the file property
952
952
  * @note This method should not be called from {TxnManager.withIndirectTxnModeAsync} or {TxnManager.withIndirectTxnMode}.
953
- * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.saveFileProperty instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
953
+ * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.saveFileProperty instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
954
954
  */
955
955
  saveFileProperty(prop: FilePropertyProps, strValue: string | undefined, blobVal?: Uint8Array): void;
956
956
  /** delete a "file property" from this iModel
957
957
  * @param prop the FilePropertyProps that describes the property
958
958
  * @note This method should not be called from {TxnManager.withIndirectTxnModeAsync} or {TxnManager.withIndirectTxnMode}.
959
- * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.deleteFileProperty instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
959
+ * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.deleteFileProperty instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
960
960
  */
961
961
  deleteFileProperty(prop: FilePropertyProps): void;
962
962
  /** Query for the next available major id for a "file property" from this iModel.
@@ -1106,12 +1106,12 @@ export declare abstract class IModelDb extends IModel {
1106
1106
  * @param dict The SettingDictionary object to stringify and save.
1107
1107
  * @note All saved `SettingDictionary`s are loaded into [[workspace.settings]] every time an iModel is opened.
1108
1108
  * @see [[Settings.addDictionary]] to register a dictionary for the current session only without persisting it.
1109
- * @beta @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.saveSettingDictionary instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1109
+ * @beta @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.saveSettingDictionary instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1110
1110
  */
1111
1111
  saveSettingDictionary(name: string, dict: SettingsContainer): void;
1112
1112
  /** Delete a SettingDictionary, previously added with [[saveSettingDictionary]], from this iModel.
1113
1113
  * @param name The name of the dictionary to delete.
1114
- * @beta @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.deleteSettingDictionary instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1114
+ * @beta @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.deleteSettingDictionary instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1115
1115
  */
1116
1116
  deleteSettingDictionary(name: string): void;
1117
1117
  /** Load all setting dictionaries in this iModel into `this.workspace.settings` */
@@ -1238,13 +1238,13 @@ export declare namespace IModelDb {
1238
1238
  * @param props The data for the new model.
1239
1239
  * @returns The newly inserted model's Id.
1240
1240
  * @throws [[IModelError]] if insertion fails.
1241
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.insertModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1241
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.insertModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1242
1242
  */
1243
1243
  insertModel(props: ModelProps): Id64String;
1244
1244
  /** Update an existing model.
1245
1245
  * @param props the properties of the model to change
1246
1246
  * @throws [[IModelError]] if update fails.
1247
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.updateModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1247
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.updateModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1248
1248
  */
1249
1249
  updateModel(props: UpdateModelOptions): void;
1250
1250
  /** Mark the geometry of [[GeometricModel]] as having changed, by recording an indirect change to its GeometryGuid property.
@@ -1254,14 +1254,14 @@ export declare namespace IModelDb {
1254
1254
  * Cached [Tile]($frontend)s are only invalidated after the geometry guid of the model changes.
1255
1255
  * @note This will throw IModelError with [IModelStatus.VersionTooOld]($core-bentley) if a version of the BisCore schema older than 1.0.11 is present in the iModel.
1256
1256
  * @throws [[IModelError]] if the update fails.
1257
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.updateGeometryGuid instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1257
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.updateGeometryGuid instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1258
1258
  * @see [[TxnManager.onModelGeometryChanged]] for the event emitted in response to such a change.
1259
1259
  */
1260
1260
  updateGeometryGuid(modelId: Id64String): void;
1261
1261
  /** Delete one or more existing models.
1262
1262
  * @param ids The Ids of the models to be deleted
1263
1263
  * @throws [[IModelError]] if deletion fails.
1264
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.deleteModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1264
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.deleteModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1265
1265
  */
1266
1266
  deleteModel(ids: Id64Arg): void;
1267
1267
  /** For each specified [[GeometricModel]], attempts to obtain the union of the volumes of all geometric elements within that model.
@@ -1354,7 +1354,7 @@ export declare namespace IModelDb {
1354
1354
  * However when `elProps.federationGuid` is not present or undefined, a new Guid will be generated and stored on the resultant element. But
1355
1355
  * the value of `elProps.federationGuid` is *not* updated. Generally, it is best to re-read the element after inserting (e.g. via [[getElementProps]])
1356
1356
  * if you intend to continue working with it. That will ensure its values reflect the persistent state.
1357
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.insertElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1357
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.insertElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1358
1358
  */
1359
1359
  insertElement(elProps: ElementProps, options?: InsertElementOptions): Id64String;
1360
1360
  /**
@@ -1367,14 +1367,14 @@ export declare namespace IModelDb {
1367
1367
  * @note The values of `classFullName` and `model` *may not be changed* by this method. Further, it will permute the `elProps` object by adding or
1368
1368
  * overwriting their values to the correct values.
1369
1369
  * @throws [[ITwinError]] if update fails.
1370
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.updateElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1370
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.updateElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1371
1371
  */
1372
1372
  updateElement<T extends ElementProps>(elProps: Partial<T>): void;
1373
1373
  /** Delete one or more elements from this iModel.
1374
1374
  * @param ids The set of Ids of the element(s) to be deleted
1375
1375
  * @throws [[ITwinError]]
1376
1376
  * @see deleteDefinitionElements
1377
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.deleteElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1377
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.deleteElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1378
1378
  */
1379
1379
  deleteElement(ids: Id64Arg): void;
1380
1380
  /**
@@ -1383,7 +1383,7 @@ export declare namespace IModelDb {
1383
1383
  * @param deleteOptions Options for the delete operation.
1384
1384
  * @returns A result object containing information about the deletion operation success and the element ids that failed to delete (if any).
1385
1385
  * @throws [[ITwinError]] if any of the supplied ids are not well-formed/valid [[Id64String]]s.
1386
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-15. Use EditTxn.deleteElements instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1386
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-15. Use EditTxn.deleteElements instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1387
1387
  * @beta
1388
1388
  */
1389
1389
  deleteElements(ids: Id64Array, deleteOptions?: BulkDeleteElementsArgs): BulkDeleteElementsResult;
@@ -1395,7 +1395,7 @@ export declare namespace IModelDb {
1395
1395
  * DefinitionElements rather than calling this method separately for each one. Ids that are not valid DefinitionElements will be ignored.
1396
1396
  * @returns An IdSet of the DefinitionElements that are used and were therefore not deleted.
1397
1397
  * @see deleteElement
1398
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.deleteDefinitionElements instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1398
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.deleteDefinitionElements instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1399
1399
  */
1400
1400
  deleteDefinitionElements(definitionElementIds: Id64Array): Id64Set;
1401
1401
  /** Query for the child elements of the specified element.
@@ -1444,19 +1444,19 @@ export declare namespace IModelDb {
1444
1444
  * @returns the id of the newly inserted aspect.
1445
1445
  * @note Aspect Ids may collide with element Ids, so don't put both in a container like Set or Map
1446
1446
  * use [EntityReference]($common) for that instead.
1447
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.insertAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1447
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.insertAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1448
1448
  */
1449
1449
  insertAspect(aspectProps: ElementAspectProps): Id64String;
1450
1450
  /** Update an exist ElementAspect within the iModel.
1451
1451
  * @param aspectProps The properties to use to update the ElementAspect.
1452
1452
  * @throws [[IModelError]] if unable to update the ElementAspect.
1453
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.updateAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1453
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.updateAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1454
1454
  */
1455
1455
  updateAspect(aspectProps: ElementAspectProps): void;
1456
1456
  /** Delete one or more ElementAspects from this iModel.
1457
1457
  * @param aspectInstanceIds The set of instance Ids of the ElementAspect(s) to be deleted
1458
1458
  * @throws [[IModelError]] if unable to delete the ElementAspect.
1459
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.deleteAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1459
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.deleteAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1460
1460
  */
1461
1461
  deleteAspect(aspectInstanceIds: Id64Arg): void;
1462
1462
  }
@@ -1479,7 +1479,7 @@ export declare namespace IModelDb {
1479
1479
  accessLevel?: BlobContainer.RequestAccessLevel;
1480
1480
  }): Promise<ViewStore.CloudAccess>;
1481
1481
  /**
1482
- * @beta @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.saveDefaultViewStore instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1482
+ * @beta @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.saveDefaultViewStore instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1483
1483
  */
1484
1484
  saveDefaultViewStore(arg: CloudSqlite.ContainerProps): void;
1485
1485
  /** Query for the array of ViewDefinitionProps of the specified class and matching the specified IsPrivate setting.
@@ -806,7 +806,7 @@ export class IModelDb extends IModel {
806
806
  * ``` ts
807
807
  * [[include:IModelDb.updateProjectExtents]]
808
808
  * ```
809
- * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.updateProjectExtents instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
809
+ * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.updateProjectExtents instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
810
810
  */
811
811
  updateProjectExtents(newExtents) {
812
812
  this[_implicitTxn].updateProjectExtents(newExtents);
@@ -830,13 +830,13 @@ export class IModelDb extends IModel {
830
830
  };
831
831
  }
832
832
  /** Update the [EcefLocation]($docs/learning/glossary#eceflocation) of this iModel.
833
- * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.updateEcefLocation instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
833
+ * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.updateEcefLocation instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
834
834
  */
835
835
  updateEcefLocation(ecef) {
836
836
  this[_implicitTxn].updateEcefLocation(ecef);
837
837
  }
838
838
  /** Update the IModelProps of this iModel in the database.
839
- * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.updateIModelProps instead, within an explicit EditTxn scope (or via withEditTxn).
839
+ * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.updateIModelProps instead, within an explicit EditTxn scope (or via withEditTxn).
840
840
  */
841
841
  updateIModelProps() {
842
842
  this[_implicitTxn].updateIModelProps();
@@ -845,7 +845,7 @@ export class IModelDb extends IModel {
845
845
  this[_implicitTxn].saveChanges(descriptionOrArgs);
846
846
  }
847
847
  /** Abandon changes in memory that have not been saved as a Txn to this iModelDb.
848
- * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.abandonChanges instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
848
+ * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.abandonChanges instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
849
849
  */
850
850
  abandonChanges() {
851
851
  this[_implicitTxn].abandonChanges();
@@ -1573,7 +1573,7 @@ export class IModelDb extends IModel {
1573
1573
  * @param prop the FilePropertyProps that describes the new property
1574
1574
  * @param value either a string or a blob to save as the file property
1575
1575
  * @note This method should not be called from {TxnManager.withIndirectTxnModeAsync} or {TxnManager.withIndirectTxnMode}.
1576
- * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.saveFileProperty instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1576
+ * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.saveFileProperty instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1577
1577
  */
1578
1578
  saveFileProperty(prop, strValue, blobVal) {
1579
1579
  this[_implicitTxn].saveFileProperty(prop, strValue, blobVal);
@@ -1581,7 +1581,7 @@ export class IModelDb extends IModel {
1581
1581
  /** delete a "file property" from this iModel
1582
1582
  * @param prop the FilePropertyProps that describes the property
1583
1583
  * @note This method should not be called from {TxnManager.withIndirectTxnModeAsync} or {TxnManager.withIndirectTxnMode}.
1584
- * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.deleteFileProperty instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1584
+ * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.deleteFileProperty instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1585
1585
  */
1586
1586
  deleteFileProperty(prop) {
1587
1587
  this[_implicitTxn].deleteFileProperty(prop);
@@ -1789,14 +1789,14 @@ export class IModelDb extends IModel {
1789
1789
  * @param dict The SettingDictionary object to stringify and save.
1790
1790
  * @note All saved `SettingDictionary`s are loaded into [[workspace.settings]] every time an iModel is opened.
1791
1791
  * @see [[Settings.addDictionary]] to register a dictionary for the current session only without persisting it.
1792
- * @beta @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.saveSettingDictionary instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1792
+ * @beta @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.saveSettingDictionary instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1793
1793
  */
1794
1794
  saveSettingDictionary(name, dict) {
1795
1795
  this[_implicitTxn].saveSettingDictionary(name, dict);
1796
1796
  }
1797
1797
  /** Delete a SettingDictionary, previously added with [[saveSettingDictionary]], from this iModel.
1798
1798
  * @param name The name of the dictionary to delete.
1799
- * @beta @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.deleteSettingDictionary instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1799
+ * @beta @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.deleteSettingDictionary instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
1800
1800
  */
1801
1801
  deleteSettingDictionary(name) {
1802
1802
  this[_implicitTxn].deleteSettingDictionary(name);
@@ -2085,7 +2085,7 @@ function processSchemaWriteStatus(status) {
2085
2085
  * @param props The data for the new model.
2086
2086
  * @returns The newly inserted model's Id.
2087
2087
  * @throws [[IModelError]] if insertion fails.
2088
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.insertModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2088
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.insertModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2089
2089
  */
2090
2090
  insertModel(props) {
2091
2091
  return this._iModel[_implicitTxn].insertModel(props);
@@ -2093,7 +2093,7 @@ function processSchemaWriteStatus(status) {
2093
2093
  /** Update an existing model.
2094
2094
  * @param props the properties of the model to change
2095
2095
  * @throws [[IModelError]] if update fails.
2096
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.updateModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2096
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.updateModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2097
2097
  */
2098
2098
  updateModel(props) {
2099
2099
  this._iModel[_implicitTxn].updateModel(props);
@@ -2105,7 +2105,7 @@ function processSchemaWriteStatus(status) {
2105
2105
  * Cached [Tile]($frontend)s are only invalidated after the geometry guid of the model changes.
2106
2106
  * @note This will throw IModelError with [IModelStatus.VersionTooOld]($core-bentley) if a version of the BisCore schema older than 1.0.11 is present in the iModel.
2107
2107
  * @throws [[IModelError]] if the update fails.
2108
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.updateGeometryGuid instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2108
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.updateGeometryGuid instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2109
2109
  * @see [[TxnManager.onModelGeometryChanged]] for the event emitted in response to such a change.
2110
2110
  */
2111
2111
  updateGeometryGuid(modelId) {
@@ -2114,7 +2114,7 @@ function processSchemaWriteStatus(status) {
2114
2114
  /** Delete one or more existing models.
2115
2115
  * @param ids The Ids of the models to be deleted
2116
2116
  * @throws [[IModelError]] if deletion fails.
2117
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.deleteModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2117
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.deleteModel instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2118
2118
  */
2119
2119
  deleteModel(ids) {
2120
2120
  this._iModel[_implicitTxn].deleteModel(ids);
@@ -2340,7 +2340,7 @@ function processSchemaWriteStatus(status) {
2340
2340
  * However when `elProps.federationGuid` is not present or undefined, a new Guid will be generated and stored on the resultant element. But
2341
2341
  * the value of `elProps.federationGuid` is *not* updated. Generally, it is best to re-read the element after inserting (e.g. via [[getElementProps]])
2342
2342
  * if you intend to continue working with it. That will ensure its values reflect the persistent state.
2343
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.insertElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2343
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.insertElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2344
2344
  */
2345
2345
  insertElement(elProps, options) {
2346
2346
  return this._iModel[_implicitTxn].insertElement(elProps, options);
@@ -2355,7 +2355,7 @@ function processSchemaWriteStatus(status) {
2355
2355
  * @note The values of `classFullName` and `model` *may not be changed* by this method. Further, it will permute the `elProps` object by adding or
2356
2356
  * overwriting their values to the correct values.
2357
2357
  * @throws [[ITwinError]] if update fails.
2358
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.updateElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2358
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.updateElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2359
2359
  */
2360
2360
  updateElement(elProps) {
2361
2361
  this._iModel[_implicitTxn].updateElement(elProps);
@@ -2364,7 +2364,7 @@ function processSchemaWriteStatus(status) {
2364
2364
  * @param ids The set of Ids of the element(s) to be deleted
2365
2365
  * @throws [[ITwinError]]
2366
2366
  * @see deleteDefinitionElements
2367
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.deleteElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2367
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.deleteElement instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2368
2368
  */
2369
2369
  deleteElement(ids) {
2370
2370
  this._iModel[_implicitTxn].deleteElement(ids);
@@ -2375,7 +2375,7 @@ function processSchemaWriteStatus(status) {
2375
2375
  * @param deleteOptions Options for the delete operation.
2376
2376
  * @returns A result object containing information about the deletion operation success and the element ids that failed to delete (if any).
2377
2377
  * @throws [[ITwinError]] if any of the supplied ids are not well-formed/valid [[Id64String]]s.
2378
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-15. Use EditTxn.deleteElements instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2378
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-15. Use EditTxn.deleteElements instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2379
2379
  * @beta
2380
2380
  */
2381
2381
  deleteElements(ids, deleteOptions) {
@@ -2389,7 +2389,7 @@ function processSchemaWriteStatus(status) {
2389
2389
  * DefinitionElements rather than calling this method separately for each one. Ids that are not valid DefinitionElements will be ignored.
2390
2390
  * @returns An IdSet of the DefinitionElements that are used and were therefore not deleted.
2391
2391
  * @see deleteElement
2392
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.deleteDefinitionElements instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2392
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.deleteDefinitionElements instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2393
2393
  */
2394
2394
  deleteDefinitionElements(definitionElementIds) {
2395
2395
  return this._iModel[_implicitTxn].deleteDefinitionElements(definitionElementIds);
@@ -2583,7 +2583,7 @@ function processSchemaWriteStatus(status) {
2583
2583
  * @returns the id of the newly inserted aspect.
2584
2584
  * @note Aspect Ids may collide with element Ids, so don't put both in a container like Set or Map
2585
2585
  * use [EntityReference]($common) for that instead.
2586
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.insertAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2586
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.insertAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2587
2587
  */
2588
2588
  insertAspect(aspectProps) {
2589
2589
  return this._iModel[_implicitTxn].insertAspect(aspectProps);
@@ -2591,7 +2591,7 @@ function processSchemaWriteStatus(status) {
2591
2591
  /** Update an exist ElementAspect within the iModel.
2592
2592
  * @param aspectProps The properties to use to update the ElementAspect.
2593
2593
  * @throws [[IModelError]] if unable to update the ElementAspect.
2594
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.updateAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2594
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.updateAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2595
2595
  */
2596
2596
  updateAspect(aspectProps) {
2597
2597
  this._iModel[_implicitTxn].updateAspect(aspectProps);
@@ -2599,7 +2599,7 @@ function processSchemaWriteStatus(status) {
2599
2599
  /** Delete one or more ElementAspects from this iModel.
2600
2600
  * @param aspectInstanceIds The set of instance Ids of the ElementAspect(s) to be deleted
2601
2601
  * @throws [[IModelError]] if unable to delete the ElementAspect.
2602
- * @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.deleteAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2602
+ * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.deleteAspect instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2603
2603
  */
2604
2604
  deleteAspect(aspectInstanceIds) {
2605
2605
  this._iModel[_implicitTxn].deleteAspect(aspectInstanceIds);
@@ -2646,7 +2646,7 @@ function processSchemaWriteStatus(status) {
2646
2646
  return this._viewStore;
2647
2647
  }
2648
2648
  /**
2649
- * @beta @deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use EditTxn.saveDefaultViewStore instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2649
+ * @beta @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use EditTxn.saveDefaultViewStore instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
2650
2650
  */
2651
2651
  saveDefaultViewStore(arg) {
2652
2652
  this._iModel[_implicitTxn].saveDefaultViewStore(arg);