@itwin/core-backend 3.1.0-dev.8 → 3.2.0-dev.0

package/CHANGELOG.md

@@ -1,6 +1,74 @@
 # Change Log - @itwin/core-backend
 
-This log was last generated on Wed, 12 Jan 2022 14:52:38 GMT and should not be manually modified.
+This log was last generated on Thu, 24 Feb 2022 15:26:55 GMT and should not be manually modified.
+
+## 3.0.1
+Thu, 24 Feb 2022 15:26:55 GMT
+
+_Version update only_
+
+## 3.0.0
+Mon, 24 Jan 2022 14:00:52 GMT
+
+### Updates
+
+- add briefcaseAlias argument to acquireNewBriefcaseId
+- make one method to acquire both shared and exclusive locks
+- Add GeometryClass to ExportGraphics
+- Update SQLiteDb to public release tag
+- initial support for cloud-based WorkspaceContainers
+- added IModelDb.workspace
+- improve concurrent query changes
+- Skip full schema load that cause OOM error on node backend
+- Do not reopen connection on schema change
+- Remove usage-logging-client
+- Upgrade target to ES2019
+- Entity no longer implements EntityProps.
+- suppress error logging during test that expect errors
+- add test and improved concurrent query support
+- fix flaky test
+- Update BackendHubAccess api to use ChangesetIndexAndId
+- Add new GeoServices class and first method to interpret WKT or complete GCS JSON."
+- getAccessToken always returns a token
+- Fix an exception when attempting to pull changes into a briefcase that already has all the changes.
+- LocalhostIpcHost, display-test-app support for R/W web (via orchestrator)
+- Added ability to convert iModel coordinates to or from any Geographic CRS
+- rename contextId -> iTwinId
+- Tests for solid kernel severe error exceptions.
+- throw rather than returning status from IModelDb.saveFileProperty and IModelDb.deleteFileProperty
+- use db.locks to release all locks
+- rename to @itwin/core-backend
+- export blobdaemon, blobdaemoncommandargs from imodeljs-native
+- Log the error that we catch when v2 checkpoint fails to open
+- use BentleyError.getErrorProps(e) instead of just logging e
+- Introduce no-non-null-assertion lint rule.
+- remove ClientRequestContext and its subclasses
+- Removed config.app usage
+- Remove deprecated APIs for 3.0.
+- allow apps to set safety interval for reattaching deamon
+- removed several previously-deprecated apis
+- remove IModelWriteRpcInterface
+- remove ClientRequestContext.current
+- Renamed all occurrences of the term revision0 to version0.
+- rework locks
+- Removed NativeAppAuthorizationBackend
+- Removed two unit tests for reproj and added one
+- added RpcTrace
+- Bumped dotenv and removed deprecated @types/dotenv
+- Replaced ContextRegistry with generalized ITwinAccess interface
+- Switching to consume new Projects-Client
+-  Renamed an iModel's parent container to iTwin
+- Removed references to the deleted config-loader package
+- split imodel-transformer out of imodel-backend package
+- remove use of "any" types in SqliteStatement
+- IModelDb.getTextureImage is async.
+- Support for TypeDoc v0.22.7. Fix various broken docs links.
+- only export necessary schemas during imodel transformation
+- Improved log message when v2 checkpoint downloaded is not for the changeset requested
+- caching options for changed elements processing
+- Adding WebEditServer (test scenarios only for now)
+- add persistent iModel-based settings
+- initial implementation of Workspace and Settings
 
 ## 2.19.28
 Wed, 12 Jan 2022 14:52:38 GMT
@@ -166,7 +234,7 @@ Mon, 26 Jul 2021 12:21:25 GMT
 
 - Reactivated test that stopped working when a previous PR for ecef dependency to geographicCRS was reverted
 - store changesetIndex on IModelDb
-- Better error checks when creating SpatialViewDefinition-s.
+- Better error checks when creating SpatialViewDefinition-s. 
 - remove internal barrel-import usage
 - throw exception when attempting to download a briefcase on top of an existing file
 - Add case for InterpolationCurve3d
@@ -201,11 +269,11 @@ Fri, 09 Jul 2021 18:11:24 GMT
 ### Updates
 
 - TemplateModelCloner now assigns a new FederationGuid for cloned element instances.
-- Accomodated the inability to reverse Changesets when creating change summaries.
+- Accomodated the inability to reverse Changesets when creating change summaries. 
 - fix lint issue
 - begin api transition to changeset index rather than changeset Id
 - Use ecef location calculated for projected iModels
-- Push refreshes access token if necessary.
+- Push refreshes access token if necessary. 
 - Do not reuse briefcase ids in ReadWrite workflows when using the RPC interfaces (if the briefcase was not found in the local file system)
 - Add missing SectionDrawing properties.
 
@@ -226,7 +294,7 @@ Fri, 02 Jul 2021 15:38:31 GMT
 
 ### Updates
 
-- Update to @bentley/imodeljs-native@2.17.10
+- Update to @bentley/imodeljs-native@2.17.10 
 
 ## 2.17.0
 Mon, 28 Jun 2021 16:20:11 GMT
@@ -492,8 +560,8 @@ Thu, 28 Jan 2021 13:39:27 GMT
 
 - Changed storageType from azure to azure?sas=1 for getCommandArgs function
 - Fix brep DataProps to/from flatbuffer to account for base64 string header.
-- Element geometry creation by brep operations.
-- Reinstated behavior when re-opening files read-write.
+- Element geometry creation by brep operations. 
+- Reinstated behavior when re-opening files read-write. 
 - enhance BriefcaseManager and BriefcaseDb for edit commands
 - Improve ElementGeometry documentation.
 - Add a check to verify, and fix, the DbGuid in the iModel if it is different than the Guid in iModelHub.
@@ -683,8 +751,8 @@ Fri, 02 Oct 2020 18:03:32 GMT
 ### Updates
 
 - Update to @bentley/imodeljs-native@2.7.4
-- Fixes to front end methods to pull, merge and push.
-- Setup IModelHost.startup() to use proxy servers if configured/available - this is valuable for debugging agents, backends and electron applications.
+- Fixes to front end methods to pull, merge and push. 
+- Setup IModelHost.startup() to use proxy servers if configured/available - this is valuable for debugging agents, backends and electron applications. 
 - On iOS download in background
 - Fix ios hang issue
 - Modify queryModelRanges to handle non geometric model errors
@@ -775,7 +843,7 @@ Thu, 20 Aug 2020 20:57:09 GMT
 ### Updates
 
 - Update to imodeljs-native 2.5.0
-- VSTS#419723: Accomodated "bad" checkpoints that may have serialized transactions preventing their use in ReadWrite cases.
+- VSTS#419723: Accomodated "bad" checkpoints that may have serialized transactions preventing their use in ReadWrite cases. 
 - Fix for a recursive exception while closing a briefcase
 - Added mobile oidc client
 - Remove special code handling for mobile.
@@ -839,7 +907,7 @@ Fri, 10 Jul 2020 17:23:14 GMT
 - Changes to support imodel-bridge
 - fix spelling mistakes in Device class
 - Fix typo in comments
-- Setup BriefcaseDb.open() to allow profile and domain schema validation and upgrades.
+- Setup BriefcaseDb.open() to allow profile and domain schema validation and upgrades. 
 - disallow protected operations for missing schemas marked with SchemaHasBehavior custom attribute
 
 ## 2.2.1
@@ -880,25 +948,25 @@ Thu, 28 May 2020 22:48:59 GMT
 - Update to imodeljs-native 2.1.0
 - Support for finding an ExternalSourceAspect given scope, id, and kind/hash.
 - ApplyChangeset perf tests updated
-- Fixed token expiry check for desktop authorization.
+- Fixed token expiry check for desktop authorization. 
 - Download ChangeSets in chunks
 - (1) In xy region booleans, support curved edges; (2) ExportGraphicsMeshVisitor class
 - Add ability to convert ExportGraphicsMesh to Polyface
 - Fixed validation of Guids (ContextId, IModelId) cached within a briefcase.
 - Moved iModelBridgeFwk to a separate package
-- Simplified logging for monitoring briefcase operations.
+- Simplified logging for monitoring briefcase operations. 
 - Fix transforms for creating and querying part instance geometry in world coordinate.
 - Fix and improvement to performance tests
 - Added support for schema XML import to iModelJs backend via the IModelDb.importSchemaStrings method.
 - channel rules
-- Fixed logging usage when opening connections.
+- Fixed logging usage when opening connections. 
 
 ## 2.0.0
 Wed, 06 May 2020 13:17:49 GMT
 
 ### Updates
 
-- Fixed setup of UserInfo from browser clients, and more cleanups to AccessToken API.
+- Fixed setup of UserInfo from browser clients, and more cleanups to AccessToken API. 
 - Added RivisionUtility class for debug/testing
 - node addon 2.0.18
 - addon 2.0.25
@@ -911,23 +979,23 @@ Wed, 06 May 2020 13:17:49 GMT
 - Performance tests for Applying Changesets
 - `IModelHost.startup` is now async.
 - `IModelHost.shutdown` is now async.
-- Refined checks for briefcase id, and fixed failing integration tests.
+- Refined checks for briefcase id, and fixed failing integration tests. 
 - Product Backlog Item 276268: Deleting the briefcase cache if the cache version is incorrect should not attempt to delete the root directory.
 - Setup initialization of briefcase cache for offline workflows. (VSTS#286489)
-- Monitor progress of downloading briefcases, ability to cancel download of briefcases.
+- Monitor progress of downloading briefcases, ability to cancel download of briefcases. 
 - Move briefcase-specific events into BriefcaseIModelDb subclass
 - Fixed param when calling logger so that it is a function as the logger expects
-- Setup a common cache locaton for iModel.js, with briefcases taking up a sub-folder.
+- Setup a common cache locaton for iModel.js, with briefcases taking up a sub-folder. 
 - Changed ChangeSets download API
 - Added unlink for file handler
 - Update UlasClient tests to send more detailed feature log data
 - react to renaming of imodeljs-clients-backend to backend-itwin-client
 - apply changeset performance tests with local datasets
-- BriefcaseManager.delete should work in offline scenarios.
+- BriefcaseManager.delete should work in offline scenarios. 
 - Remove deprecated members of SectionLocation and downgrade to alpha pending refactor.
 - Support for progress/cancel from ios
 - Remove deprecated ExportGraphics types etc for 2.0
-- Updated docs.
+- Updated docs. 
 - IModelDb.findByKey replaces IModelDb.find
 - Include model extents with ViewStateProps for drawing views.
 - Remove deprecated APIs; see NextVersion.md for details.
@@ -948,29 +1016,29 @@ Wed, 06 May 2020 13:17:49 GMT
 - Introduce the BriefcaseIModelDb class, make IModelDb abstract.
 - Cleaned up unused async-s in BriefcaseManager
 - Avoided casting of BriefcaseProps to IModelRpcProps.
-- Added NativeApp.deleteBriefcase, avoided authorization exceptions when offline.
+- Added NativeApp.deleteBriefcase, avoided authorization exceptions when offline. 
 - Move briefcase property from IModelDb --> BriefcaseIModelDb
 - BriefcaseId is now an enum instead of a class
 - Rename BriefcaseId --> ReservedBriefcaseId, introduce BriefcaseId type
-- VSTS#297017: Update cached briefcase information if changes were applied.
-- Refactored NativeApp API and RPC interfaces. This continues to be WIP.
-- Removed the call to simultaneously download and open the briefcase at the backend. This should be done in two separate steps henceforth. The download must be done with BriefcaseManager, and the open is now a synchronous call in BriefcaseDb.
-- Added DownloadBriefcaseOptions and OpenBriefcaseOptions as parameters to the download/open calls for a briefcase.
+- VSTS#297017: Update cached briefcase information if changes were applied. 
+- Refactored NativeApp API and RPC interfaces. This continues to be WIP. 
+- Removed the call to simultaneously download and open the briefcase at the backend. This should be done in two separate steps henceforth. The download must be done with BriefcaseManager, and the open is now a synchronous call in BriefcaseDb. 
+- Added DownloadBriefcaseOptions and OpenBriefcaseOptions as parameters to the download/open calls for a briefcase. 
 - Removed BriefcaseDb.create
-- Setup ability to use NativeApp.openBriefcase() in offline scenarios.
+- Setup ability to use NativeApp.openBriefcase() in offline scenarios. 
 - fixed flaky test
-- VSTS#217447, 162382: Cleanups to implementation of downloading/opening/discovering briefcases in native applications (WIP).
+- VSTS#217447, 162382: Cleanups to implementation of downloading/opening/discovering briefcases in native applications (WIP). 
 - do not throw exception in NativeAppBackend.startup()
-- VSTS#296110: Setup a way to close briefcases when the native application is offline.
+- VSTS#296110: Setup a way to close briefcases when the native application is offline. 
 - Move concurrencyControl from IModelDb to BriefcaseIModelDb
 - Renamed OIDC constructs for consistency; Removed SAML support.
 - Add support for password-protecting snapshot iModels
 - Fixed typo for ElementAspect perf tests
-- VSTS#217447, VSTS#162382: Reinstated option to open briefcases with SyncMode = PullOnly.
+- VSTS#217447, VSTS#162382: Reinstated option to open briefcases with SyncMode = PullOnly. 
 - Add purge dir method to iModelJsFs
 - react to creation of new clients packages from imodeljs-clients
 - ; substitute current date for feature usage without any set start/end dates
-- Removed deprecated utilities.
+- Removed deprecated utilities. 
 - enforce opening Snapshots readonly through StandaloneDb
 - Remove the deprecated Entity.clone method
 - Adjusted calls to some node addon changes (ECUtils removed)
@@ -982,13 +1050,13 @@ Wed, 06 May 2020 13:17:49 GMT
 - Add FileNameResolver class
 - Move snapshot methods out of IModelDb and into new SnapshotIModelDb class.
 - Add TemplateModelCloner to place instances of a template model
-- Renamed TestOidcClient and related constructs for consistency.
+- Renamed TestOidcClient and related constructs for consistency. 
 - Add IModelDb.tryPrepareStatement
-- Fixed usage logging.
+- Fixed usage logging. 
 - fix failing ulas tests due to invalid featureId
 - update ULAS test logging & feedback
 - Update UlasUtilities to support exception-throwing native functions
-- Use standalone briefcases for PullOnly cases.
+- Use standalone briefcases for PullOnly cases. 
 
 ## 1.14.1
 Wed, 22 Apr 2020 19:04:00 GMT
@@ -1003,7 +1071,7 @@ Tue, 31 Mar 2020 15:44:19 GMT
 ### Updates
 
 - Update to addon 1.14.1
-- Fixed downloading of files using https/streaming to resolve when the filestream is closed instead of when the input stream is exhausted.
+- Fixed downloading of files using https/streaming to resolve when the filestream is closed instead of when the input stream is exhausted. 
 - Add handling for invalid predecessor ids to IModelTransformer
 - Accomodate updated imodeljs-native ULAS functions
 
@@ -1018,7 +1086,7 @@ Wed, 12 Feb 2020 17:45:50 GMT
 ### Updates
 
 - Fix IGeometry roundtripping issue through ECSql.  Fix insert/update binary properties for Element Aspect.
-- Separated out routines to download and open briefcases.
+- Separated out routines to download and open briefcases. 
 - bulk mode
 - Consolidated sign-in for integration tests
 - bulkmode
@@ -1029,7 +1097,7 @@ Wed, 12 Feb 2020 17:45:50 GMT
 - Add ViewDefinition.getAuxiliaryCoordinateSystemId and ViewDefinition.setAuxiliaryCoordinateSystemId methods
 - Add SpatialLocationModel.insert
 - Add optional isPlantProjection parameter to PhysicalModel.insert
-- VSTS#256133: Fixed issue with reopening connections if the backend crashes. Fixes to integration tests.
+- VSTS#256133: Fixed issue with reopening connections if the backend crashes. Fixes to integration tests. 
 - Better documentation of OidcDesktopClient
 - Fixed changeset perf test by using another iModel on Hub
 - Add ViewDetails to ViewDefinition.
@@ -1062,7 +1130,7 @@ Tue, 07 Jan 2020 19:44:01 GMT
 - Allow events to be sent from backend to frontend
 - Add tryGetInstance / tryGetInstanceProps methods to the Relationship class which return undefined rather than throwing an exception when a relationship is not found.
 - Fix webpack for ios test that were failing due to new dependencies
-- VSTS#225894 - Allowed agents to bypass usage logging calls. These cause usage logging errors.
+- VSTS#225894 - Allowed agents to bypass usage logging calls. These cause usage logging errors. 
 - Add tryGetElement / tryGetElementProps which return undefined rather than throwing an exception when an element is not found.
 - Add tryGetModel, tryGetModelProps, tryGetSubModel which return undefined instead of throwing exceptions when the model is not found.
 
@@ -1074,7 +1142,7 @@ Tue, 10 Dec 2019 18:08:56 GMT
 - Updated to addon 9.1.3
 - Added AliCloud tile cache service
 - Added framework to run imodeljs-backend test on ios using appcenter
-- Setup OidcDesktopClient for Electron use cases.
+- Setup OidcDesktopClient for Electron use cases. 
 - fix warnings from static analysis
 - Enabling testing code for updating LR aspects after fix in native side.
 - Addressing typo in a couple of members, making them match the schema properly.
@@ -1130,9 +1198,9 @@ Mon, 30 Sep 2019 22:28:48 GMT
 ### Updates
 
 - added support for blank IModelConnections
-- Setup a way to supply authorization through the backend for frontend requests.
-- Error log when downloading change sets should include iModelId for context.
-- Fixed the iModelHub client to properly dispose a file handle after upload to the iModelHub.
+- Setup a way to supply authorization through the backend for frontend requests. 
+- Error log when downloading change sets should include iModelId for context. 
+- Fixed the iModelHub client to properly dispose a file handle after upload to the iModelHub. 
 - Add IModelDb.Elements.hasSubModel
 - Make ExternalSourceAspect.checksum optional
 - Clear statement cache after schema import
@@ -1147,14 +1215,14 @@ Tue, 10 Sep 2019 12:09:49 GMT
 
 ### Updates
 
-- Setup a way to supply authorization through the backend for frontend requests.
-- Allow attaching change cache file before change summary extraction.
-- Added change summary test, and improved doc a little.
+- Setup a way to supply authorization through the backend for frontend requests. 
+- Allow attaching change cache file before change summary extraction. 
+- Added change summary test, and improved doc a little. 
 - Add minimum brep size option to IModelDb.exportGraphics
 - FunctionalSchema.importSchema is now deprecated.
 - Add support for GeometricModel.geometryGuid for detecting whether tiles for a model can be reused across versions
 - Added performance logging for tile upload
-- IModelConnection.close() for read-only connections should not close the Db at the backend; Opening an iModel with SyncModel.PullAndPush() multiple times (without disposing it) must reuse the briefcase.
+- IModelConnection.close() for read-only connections should not close the Db at the backend; Opening an iModel with SyncModel.PullAndPush() multiple times (without disposing it) must reuse the briefcase. 
 - Add method to create view with camera
 - Fixed misleading logging output in tile upload
 
@@ -1164,14 +1232,14 @@ Tue, 13 Aug 2019 20:25:53 GMT
 ### Updates
 
 - Allow custom tile cache services.
-- Always acquire a briefcase when creating a new backend instance for PullAndPush workflows.
-- Added Change Summary integration test, and fixed documentation.
+- Always acquire a briefcase when creating a new backend instance for PullAndPush workflows. 
+- Added Change Summary integration test, and fixed documentation. 
 - Trial code for tile upload errors
 - Fixed changeset performance tests
 - Tile upload logging.
 - Mark ExportGraphics API as public
 - Support for gzip compression of tiles
-- Fixed issue with opening iModels with names that are invalid on Unix or Windows.
+- Fixed issue with opening iModels with names that are invalid on Unix or Windows. 
 - Add IModelDb.isSnapshot
 - Tile upload error catching.
 - Azure tile upload logging
@@ -1183,7 +1251,7 @@ Wed, 24 Jul 2019 11:47:26 GMT
 ### Updates
 
 - Added option to restrict tile cache URLs by client IP address.
-- Apply change sets at the backend in a non-blocking worker thread.
+- Apply change sets at the backend in a non-blocking worker thread. 
 - Add ElementAspect handler methods
 - When deleting a parent element, make sure there are onDelete/onDeleted callbacks for child elements
 - Add support for linework to IModelDb.exportGraphics
@@ -1201,19 +1269,19 @@ Mon, 01 Jul 2019 19:04:29 GMT
 
 ### Updates
 
-- Open fixes when briefcase requires merges.
+- Open fixes when briefcase requires merges. 
 - Catch tile upload errors.
-- Setting up briefcase is always from an older checkpoint.
+- Setting up briefcase is always from an older checkpoint. 
 - Add materialId, subCategory to ExportGraphicsInfo
-- Fix crash in getViewThumbnail for odd number of bytes
+- Fix crash in getViewThumbnail for odd number of bytes 
 - Adding relationship class for GraphicalElement3dRepresentsElement.
 - Initial implementation of the LinearReferencing typescript domain
 - Adding domain classes for all relatinships in the LinearReferencing schema.
 - Exporting relationships module.
-- Fixes to opening iModel-s ReadWrite from mutiple IModelConnection-s.
-- Fixed issues with deleting briefcases if there were errors with preparing briefcases.
+- Fixes to opening iModel-s ReadWrite from mutiple IModelConnection-s. 
+- Fixed issues with deleting briefcases if there were errors with preparing briefcases. 
 - Add a new method `forceLoadSchemas` to `IModelJsNative.ECPresentationManager`.
-- Introduced AsyncMutex - a utility to run async blocks of code in sequence.
+- Introduced AsyncMutex - a utility to run async blocks of code in sequence. 
 - Properly document ModelSelector.models and CategorySelector.categories as Id64String arrays
 - Made `insertElement` not return Id64.invalid, throws error instead
 - Update to TypeScript 3.5
@@ -1224,7 +1292,7 @@ Mon, 03 Jun 2019 18:09:39 GMT
 
 ### Updates
 
-- Migrated agent applications to the newer client
+- Migrated agent applications to the newer client 
 - RPC system now accepts only basic values (primitives, "interface" objects, and binary).
 - Switched from iModelHub Project API to Context API
 - Fix bug in IModelDb.createSnapshotFromSeed
@@ -1272,12 +1340,12 @@ Mon, 13 May 2019 15:52:05 GMT
 - Cleanup old imodelbank references
 - Add InformationRecordModel.insert, GroupModel.insert
 - Introduce LoggerCategory enum to advertise logger categories used by this package.
-- Limited maximum cache size of the backend PromiseMemoizer.
+- Limited maximum cache size of the backend PromiseMemoizer. 
 - Missing dependency on node-report
-- Fixed memoization problem that caused an endless stream of 404 NotFound errors.
+- Fixed memoization problem that caused an endless stream of 404 NotFound errors. 
 - Reinstated old version of OidcAgentClient
-- Unauthorized open requests should cause a more obvious error.
-- Improved performance logging, especially of IModelDb open operations; ChangeSets are merged one-by-one to prevent hogging the event loop.
+- Unauthorized open requests should cause a more obvious error. 
+- Improved performance logging, especially of IModelDb open operations; ChangeSets are merged one-by-one to prevent hogging the event loop. 
 - Memoization fix when opening iModels in shared, read-only mode .
 - Fixed setup of application version.
 - Updated Element CRUD perf tests
@@ -1287,7 +1355,7 @@ Mon, 13 May 2019 15:52:05 GMT
 - Remove ElementPropertyFormatter, IModelDb.getElementPropertiesForDisplay (use presentation rules instead)
 - Remove StandaloneIModelRpcImpl
 - Fix for Render Gradient.Symb test
-- Setup a generic context for tracking client requests, and made various related enhancements to logging, usage tracking and authorization.
+- Setup a generic context for tracking client requests, and made various related enhancements to logging, usage tracking and authorization. 
 - Add IModelDb.createSnapshot/openSnapshot/closeSnapshot, deprecate IModelDb.createStandalone/openStandalone/closeStandalone
 - Moved IModelJsExpressServer class into a new package (@itwin/express-server).
 - Simplified tile caching IModelHost config and removed dev flags. Allow
@@ -1314,7 +1382,7 @@ Wed, 06 Mar 2019 15:41:22 GMT
 - Changes package.json to include api-extractor and adds api-extractor.json
 - Use new buildIModelJsBuild script
 - AxisAlignedBox and ElementAlignedBox are now typed to Range3d rather than classes
-- Moved AzureFileHandler, IOSAzureFileHandler, UrlFileHandler and the iModelHub tests to the imodeljs-clients-backend package. This removes the dependency of imodeljs-clients on the "fs" module, and turns it into a browser only package.
+- Moved AzureFileHandler, IOSAzureFileHandler, UrlFileHandler and the iModelHub tests to the imodeljs-clients-backend package. This removes the dependency of imodeljs-clients on the "fs" module, and turns it into a browser only package. 
 - Clone methods are no longer generic
 - Remove unneeded typedoc plugin dependency
 - Added spatial <-> cartographic methods that check/use the geographic coordinate system before using ecef location.
@@ -1359,8 +1427,8 @@ Mon, 14 Jan 2019 23:09:10 GMT
 
 ### Updates
 
-- More logging of HTTP requests, and enabled use of fiddler for backend diagnostics.
-- Removed IModelDb's cache of accessToken. For long running operations like AutoPush, the user must explicitly supply an IAccessTokenManager to keep the token current.
+- More logging of HTTP requests, and enabled use of fiddler for backend diagnostics. 
+- Removed IModelDb's cache of accessToken. For long running operations like AutoPush, the user must explicitly supply an IAccessTokenManager to keep the token current. 
 - Renamed RequestProxy->RequestHost. Allowed applications to configure proxy server with HTTPS_PROXY env.
 - Add backend TextureAPI and accompanying test
 
@@ -1465,7 +1533,7 @@ Mon, 03 Dec 2018 18:52:58 GMT
 
 ### Updates
 
-- More information logged from BriefcaseManager.\nFixed deletion/cleanup of invalid briefcases.\nAdded OIDC support for simpleviewtest application.
+- More information logged from BriefcaseManager.\nFixed deletion/cleanup of invalid briefcases.\nAdded OIDC support for simpleviewtest application. 
 - Add ElementRefersToElements.insert
 - Fixed front end integration tests.
 - Document the intended purpose of IModelJsExpressServer within a deployment environment.
@@ -1534,11 +1602,11 @@ Thu, 08 Nov 2018 17:59:20 GMT
 
 - Fix JSON representation of DisplayStyle.
 - Add IModelImporter as a base class for utility methods needed by all importers
-- Removed assertion when deleting a memoized open call.
+- Removed assertion when deleting a memoized open call. 
 - Add more methods to IModelImporter
 - Fix snapping test
 - OIDC related enhancments (WIP).
-- Re-enabled several backend integration tests.
+- Re-enabled several backend integration tests. 
 - Refactor analysis-importer to use IModelImporter
 - Updated to TypeScript 3.1
 

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

@@ -1 +1 @@
-{"version":3,"file":"ClassRegistry.d.ts","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAW,MAAM,UAAU,CAAC;AAE3C;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAoC;IACrE,gBAAgB;WACF,eAAe,CAAC,GAAG,EAAE,GAAG;IACtC,gBAAgB;WACF,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW;IACvE,gBAAgB;WACF,QAAQ,CAAC,WAAW,EAAE,OAAO,MAAM,EAAE,MAAM,EAAE,OAAO,MAAM;IAYxE,yEAAyE;IACzE,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAqBlC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAgCrC;;;OAGG;WACW,cAAc,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,MAAM;IAQlE;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,aAAa;IAa5B;;;;OAIG;WACW,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,MAAM,GAAG,SAAS;IAInF;;;;OAIG;WACW,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO,MAAM;IAM9E;;;;;OAKG;WACW,eAAe,CAAC,aAAa,EAAE,MAAM;IACnD;;;;OAIG;WACW,qBAAqB,CAAC,MAAM,EAAE,OAAO,MAAM;CAM1D;AAED;;;GAGG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,SAAS,CAAkE;IAEnF,wCAAwC;IACjC,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAE9D,gCAAgC;IACzB,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,IAAI;CAClE"}
+{"version":3,"file":"ClassRegistry.d.ts","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAE,WAAW,EAAkB,MAAM,oBAAoB,CAAC;AACjF,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAW,MAAM,UAAU,CAAC;AAI3C;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAoC;IACrE,gBAAgB;WACF,eAAe,CAAC,GAAG,EAAE,GAAG;IACtC,gBAAgB;WACF,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW;IACvE,gBAAgB;WACF,QAAQ,CAAC,WAAW,EAAE,OAAO,MAAM,EAAE,MAAM,EAAE,OAAO,MAAM;IAYxE,yEAAyE;IACzE,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAqBlC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAyFrC;;;OAGG;WACW,cAAc,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,MAAM;IAQlE;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,aAAa;IAa5B;;;;OAIG;WACW,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,MAAM,GAAG,SAAS;IAInF;;;;OAIG;WACW,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO,MAAM;IAM9E;;;;;OAKG;WACW,eAAe,CAAC,aAAa,EAAE,MAAM;IACnD;;;;OAIG;WACW,qBAAqB,CAAC,MAAM,EAAE,OAAO,MAAM;CAM1D;AAED;;;GAGG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,SAAS,CAAkE;IAEnF,wCAAwC;IACjC,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAE9D,gCAAgC;IACzB,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,IAAI;CAClE"}

package/lib/cjs/ClassRegistry.js

@@ -11,7 +11,9 @@ exports.MetaDataRegistry = exports.ClassRegistry = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
 const core_common_1 = require("@itwin/core-common");
 const Entity_1 = require("./Entity");
+const Element_1 = require("./Element");
 const Schema_1 = require("./Schema");
+const isGeneratedClassTag = Symbol("isGeneratedClassTag");
 /** The mapping between a BIS class name (in the form "schema:class") and its JavaScript constructor function
  * @public
  */
@@ -54,6 +56,7 @@ class ClassRegistry {
      * @param entityMetaData The Entity metadata that defines the class
      */
     static generateClassForEntity(entityMetaData, iModel) {
+        var _a, _b;
         const name = entityMetaData.ecclass.split(":");
         const domainName = name[0];
         const className = name[1];
@@ -63,15 +66,65 @@ class ClassRegistry {
         let schema = Schema_1.Schemas.getRegisteredSchema(domainName);
         if (undefined === schema)
             schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too
-        // this method relies on the caller having previously created/registered all superclasses
         const superclass = this._classMap.get(entityMetaData.baseClasses[0].toLowerCase());
         if (undefined === superclass)
             throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `cannot find superclass for class ${name}`);
-        const generatedClass = class extends superclass {
-            static get className() { return className; }
-        };
-        // the above line creates an anonymous class. For help debugging, set the "constructor.name" property to be the same as the bisClassName.
+        // user defined class hierarchies may skip a class in the hierarchy, and therefore their JS base class cannot
+        // be used to tell if there are any generated classes in the hierarchy
+        let generatedClassHasNonGeneratedNonCoreAncestor = false;
+        let currentSuperclass = superclass;
+        const MAX_ITERS = 1000;
+        for (let i = 0; i < MAX_ITERS; ++i) {
+            if (currentSuperclass.schema.schemaName === "BisCore")
+                break;
+            if (!currentSuperclass.isGeneratedClass) {
+                generatedClassHasNonGeneratedNonCoreAncestor = true;
+                break;
+            }
+            const superclassMetaData = iModel.classMetaDataRegistry.find(currentSuperclass.classFullName);
+            if (superclassMetaData === undefined)
+                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadSchema, `could not find the metadata for class '${currentSuperclass.name}', class metadata should be loaded by now`);
+            const maybeNextSuperclass = this.getClass(superclassMetaData.baseClasses[0], iModel);
+            if (maybeNextSuperclass === undefined)
+                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadSchema, `could not find the base class of '${currentSuperclass.name}', all generated classes must have a base class`);
+            currentSuperclass = maybeNextSuperclass;
+        }
+        const generatedClass = (_b = class extends superclass {
+                static get className() { return className; }
+                static get isGeneratedClass() { return this.hasOwnProperty(isGeneratedClassTag); }
+            },
+            _a = isGeneratedClassTag,
+            _b[_a] = true,
+            _b);
+        // the above creates an anonymous class. For help debugging, set the "constructor.name" property to be the same as the bisClassName.
         Object.defineProperty(generatedClass, "name", { get: () => className }); // this is the (only) way to change that readonly property.
+        const navigationProps = Object.entries(entityMetaData.properties)
+            .filter(([_propName, prop]) => prop.isNavigation)
+            .map(([propName, _prop]) => propName);
+        const isElement = (t) => t.is(Element_1.Element); // Entity.is check but with type information to avoid casts later
+        // a class only gets an automatic `collectPredecessorIds` implementation if:
+        // - it derives from `BisCore:Element`
+        // - it is not in the `BisCore` schema
+        // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)
+        if (!generatedClassHasNonGeneratedNonCoreAncestor && isElement(superclass)) {
+            Object.defineProperty(generatedClass.prototype, "collectPredecessorIds", {
+                // first prototype of `this` is its class
+                value(predecessorIds) {
+                    // eslint-disable-next-line @typescript-eslint/dot-notation
+                    const superImpl = superclass.prototype["collectPredecessorIds"];
+                    superImpl.call(this, predecessorIds);
+                    for (const navProp of navigationProps) {
+                        const relatedElem = this[navProp]; // cast to any since subclass can have any extensions
+                        if (!relatedElem || !core_bentley_1.Id64.isValid(relatedElem.id))
+                            continue;
+                        predecessorIds.add(relatedElem.id);
+                    }
+                },
+                // defaults for methods on a prototype (required for sinon to stub out methods on tests)
+                writable: true,
+                configurable: true,
+            });
+        }
         // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations
         if (schema.missingRequiredBehavior) {
             const throwError = () => { throw new core_common_1.IModelError(core_bentley_1.IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`); };

package/lib/cjs/ClassRegistry.js.map

@@ -1 +1 @@
-{"version":3,"file":"ClassRegistry.js","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAqE;AACrE,oDAAiE;AACjE,qCAAkC;AAElC,qCAA2C;AAE3C;;GAEG;AACH,MAAa,aAAa;IAExB,gBAAgB;IACT,MAAM,CAAC,eAAe,CAAC,GAAQ,IAAI,OAAO,CAAC,GAAG,YAAY,yBAAW,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,KAAK,2BAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC/H,gBAAgB;IACT,MAAM,CAAC,yBAAyB,CAAC,SAAiB,IAAiB,OAAO,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,0BAA0B,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;IACjK,gBAAgB;IACT,MAAM,CAAC,QAAQ,CAAC,WAA0B,EAAE,MAAqB;QACtE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC;QAC5B,MAAM,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,MAAM,GAAG,SAAS,GAAG,4FAA4F,WAAW,CAAC,IAAI,EAAE,CAAC;YAC1I,qBAAM,CAAC,QAAQ,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;SACzB;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IACvC,CAAC;IAED,yEAAyE;IACjE,MAAM,CAAC,mBAAmB,CAAC,MAAc,EAAE,MAAgB;QACjE,MAAM,WAAW,GAAG,MAAM,CAAC,2BAA2B,CAAC;;;;;+FAKoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACpG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,KAAM,SAAQ,eAAM;YAC/B,MAAM,KAAc,UAAU,KAAK,OAAO,MAAM,CAAC,CAAC,CAAC;YACnD,MAAM,KAAc,uBAAuB,KAAK,OAAO,WAAW,CAAC,CAAC,CAAC;SAC7E,CAAC;QAEF,gBAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,0CAA0C;QAC/E,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,sBAAsB,CAAC,cAA8B,EAAE,MAAgB;QACpF,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAE1B,IAAI,CAAC,KAAK,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,qCAAqC;YAChF,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,SAAS,IAAI,oBAAoB,CAAC,CAAC;QAEhF,0BAA0B;QAC1B,IAAI,MAAM,GAAG,gBAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,MAAM;YACtB,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,iCAAiC;QAE1F,yFAAyF;QACzF,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QACnF,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,oCAAoC,IAAI,EAAE,CAAC,CAAC;QAE3F,MAAM,cAAc,GAAG,KAAM,SAAQ,UAAU;YAAU,MAAM,KAAc,SAAS,KAAK,OAAO,SAAS,CAAC,CAAC,CAAC;SAAE,CAAC;QACjH,yIAAyI;QACzI,MAAM,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAE,2DAA2D;QAErI,qGAAqG;QACrG,IAAI,MAAM,CAAC,uBAAuB,EAAE;YAClC,MAAM,UAAU,GAAG,GAAG,EAAE,GAAG,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,YAAY,EAAE,WAAW,UAAU,wDAAwD,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9J,UAAU,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAE,cAAsB,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,CAAC;SACxG;QAED,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,+BAA+B;QACtE,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,SAAc,EAAE,MAAqB;QAChE,KAAK,MAAM,UAAU,IAAI,SAAS,EAAE,EAAE,mCAAmC;YACvE,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;YACxC,IAAI,SAAS,CAAC,SAAS,YAAY,eAAM;gBACvC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;SACpC;IACH,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,aAAa,CAAC,aAAqB,EAAE,MAAgB;QAClE,MAAM,QAAQ,GAA+B,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9F,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS;YAC1D,MAAM,IAAI,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;QAEtD,iDAAiD;QACjD,IAAI,QAAQ,CAAC,WAAW,IAAI,CAAC,CAAC,KAAK,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC;YAC7D,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAEjD,mDAAmD;QACnD,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,aAAqB;QACrD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAqB,EAAE,MAAgB;QAC5D,MAAM,GAAG,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,aAAqB,IAAI,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IACnH;;;;OAIG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAAqB;QACvD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC9C,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM;gBAC5B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAClC;IACH,CAAC;;AA9IH,sCA+IC;AA9IyB,uBAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;AAgJvE;;;GAGG;AACH,MAAa,gBAAgB;IAA7B;QACU,cAAS,GAAgC,IAAI,GAAG,EAA0B,CAAC;IAOrF,CAAC;IALC,wCAAwC;IACjC,IAAI,CAAC,aAAqB,IAAgC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IAE1H,gCAAgC;IACzB,GAAG,CAAC,aAAqB,EAAE,QAAwB,IAAU,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CACjI;AARD,4CAQC","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 Schema\r\n */\r\n\r\nimport { DbResult, IModelStatus, Logger } from \"@itwin/core-bentley\";\r\nimport { EntityMetaData, IModelError } from \"@itwin/core-common\";\r\nimport { Entity } from \"./Entity\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { Schema, Schemas } from \"./Schema\";\r\n\r\n/** The mapping between a BIS class name (in the form \"schema:class\") and its JavaScript constructor function\r\n * @public\r\n */\r\nexport class ClassRegistry {\r\n  private static readonly _classMap = new Map<string, typeof Entity>();\r\n  /** @internal */\r\n  public static isNotFoundError(err: any) { return (err instanceof IModelError) && (err.errorNumber === IModelStatus.NotFound); }\r\n  /** @internal */\r\n  public static makeMetaDataNotFoundError(className: string): IModelError { return new IModelError(IModelStatus.NotFound, `metadata not found for ${className}`); }\r\n  /** @internal */\r\n  public static register(entityClass: typeof Entity, schema: typeof Schema) {\r\n    entityClass.schema = schema;\r\n    const key = (`${schema.schemaName}:${entityClass.className}`).toLowerCase();\r\n    if (this._classMap.has(key)) {\r\n      const errMsg = `Class ${key} is already registered. Make sure static className member is correct on JavaScript class ${entityClass.name}`;\r\n      Logger.logError(\"core-frontend.classRegistry\", errMsg);\r\n      throw new Error(errMsg);\r\n    }\r\n\r\n    this._classMap.set(key, entityClass);\r\n  }\r\n\r\n  /** Generate a proxy Schema for a domain that has not been registered. */\r\n  private static generateProxySchema(domain: string, iModel: IModelDb): typeof Schema {\r\n    const hasBehavior = iModel.withPreparedSqliteStatement(`\r\n      SELECT NULL FROM [ec_CustomAttribute] [c]\r\n        JOIN [ec_schema] [s] ON [s].[Id] = [c].[ContainerId]\r\n        JOIN [ec_class] [e] ON [e].[Id] = [c].[ClassId]\r\n        JOIN [ec_schema] [b] ON [e].[SchemaId] = [b].[Id]\r\n      WHERE [c].[ContainerType] = 1 AND [s].[Name] = ? AND [b].[Name] || '.' || [e].[name] = ?`, (stmt) => {\r\n      stmt.bindString(1, domain);\r\n      stmt.bindString(2, \"BisCore.SchemaHasBehavior\");\r\n      return stmt.step() === DbResult.BE_SQLITE_ROW;\r\n    });\r\n\r\n    const schemaClass = class extends Schema {\r\n      public static override get schemaName() { return domain; }\r\n      public static override get missingRequiredBehavior() { return hasBehavior; }\r\n    };\r\n\r\n    Schemas.registerSchema(schemaClass); // register the class before we return it.\r\n    return schemaClass;\r\n  }\r\n\r\n  /** Generate a JavaScript class from Entity metadata.\r\n   * @param entityMetaData The Entity metadata that defines the class\r\n   */\r\n  private static generateClassForEntity(entityMetaData: EntityMetaData, iModel: IModelDb): typeof Entity {\r\n    const name = entityMetaData.ecclass.split(\":\");\r\n    const domainName = name[0];\r\n    const className = name[1];\r\n\r\n    if (0 === entityMetaData.baseClasses.length) // metadata must contain a superclass\r\n      throw new IModelError(IModelStatus.BadArg, `class ${name} has no superclass`);\r\n\r\n    // make sure schema exists\r\n    let schema = Schemas.getRegisteredSchema(domainName);\r\n    if (undefined === schema)\r\n      schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too\r\n\r\n    // this method relies on the caller having previously created/registered all superclasses\r\n    const superclass = this._classMap.get(entityMetaData.baseClasses[0].toLowerCase());\r\n    if (undefined === superclass)\r\n      throw new IModelError(IModelStatus.NotFound, `cannot find superclass for class ${name}`);\r\n\r\n    const generatedClass = class extends superclass { public static override get className() { return className; } };\r\n    // the above line creates an anonymous class. For help debugging, set the \"constructor.name\" property to be the same as the bisClassName.\r\n    Object.defineProperty(generatedClass, \"name\", { get: () => className });  // this is the (only) way to change that readonly property.\r\n\r\n    // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations\r\n    if (schema.missingRequiredBehavior) {\r\n      const throwError = () => { throw new IModelError(IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`); };\r\n      superclass.protectedOperations.forEach((operation) => (generatedClass as any)[operation] = throwError);\r\n    }\r\n\r\n    this.register(generatedClass, schema); // register it before returning\r\n    return generatedClass;\r\n  }\r\n\r\n  /** Register all of the classes found in the given module that derive from Entity. See the example in [[Schema]]\r\n   * @param moduleObj The module to search for subclasses of Entity\r\n   * @param schema The schema for all found classes\r\n   */\r\n  public static registerModule(moduleObj: any, schema: typeof Schema) {\r\n    for (const thisMember in moduleObj) { // eslint-disable-line guard-for-in\r\n      const thisClass = moduleObj[thisMember];\r\n      if (thisClass.prototype instanceof Entity)\r\n        this.register(thisClass, schema);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated\r\n   * class. This function also ensures that all of the base classes of the Entity exist and are registered.\r\n   */\r\n  private static generateClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n    const metadata: EntityMetaData | undefined = iModel.classMetaDataRegistry.find(classFullName);\r\n    if (metadata === undefined || metadata.ecclass === undefined)\r\n      throw this.makeMetaDataNotFoundError(classFullName);\r\n\r\n    // Make sure we have all base classes registered.\r\n    if (metadata.baseClasses && (0 !== metadata.baseClasses.length))\r\n      this.getClass(metadata.baseClasses[0], iModel);\r\n\r\n    // Now we can generate the class from the classDef.\r\n    return this.generateClassForEntity(metadata, iModel);\r\n  }\r\n\r\n  /** Find a registered class by classFullName.\r\n   * @param classFullName class to find\r\n   * @param iModel The IModel that contains the class definitions\r\n   * @returns The Entity class or undefined\r\n   */\r\n  public static findRegisteredClass(classFullName: string): typeof Entity | undefined {\r\n    return this._classMap.get(classFullName.toLowerCase());\r\n  }\r\n\r\n  /** Get the Entity class for the specified Entity className.\r\n   * @param classFullName The full BIS class name of the Entity\r\n   * @param iModel The IModel that contains the class definitions\r\n   * @returns The Entity class\r\n   */\r\n  public static getClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n    const key = classFullName.toLowerCase();\r\n    const ctor = this._classMap.get(key);\r\n    return ctor ? ctor : this.generateClass(key, iModel);\r\n  }\r\n\r\n  /** Unregister a class, by name, if one is already registered.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.\r\n   * @param classFullName Name of the class to unregister\r\n   * @return true if the class was unregistered\r\n   * @internal\r\n   */\r\n  public static unregisterCLass(classFullName: string) { return this._classMap.delete(classFullName.toLowerCase()); }\r\n  /** Unregister all classes from a schema.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.\r\n   * @param schema Name of the schema to unregister\r\n   * @internal\r\n   */\r\n  public static unregisterClassesFrom(schema: typeof Schema) {\r\n    for (const entry of Array.from(this._classMap)) {\r\n      if (entry[1].schema === schema)\r\n        this.unregisterCLass(entry[0]);\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * A cache that records the mapping between class names and class metadata\r\n * @internal\r\n */\r\nexport class MetaDataRegistry {\r\n  private _registry: Map<string, EntityMetaData> = new Map<string, EntityMetaData>();\r\n\r\n  /** Get the specified Entity metadata */\r\n  public find(classFullName: string): EntityMetaData | undefined { return this._registry.get(classFullName.toLowerCase()); }\r\n\r\n  /** Add metadata to the cache */\r\n  public add(classFullName: string, metaData: EntityMetaData): void { this._registry.set(classFullName.toLowerCase(), metaData); }\r\n}\r\n"]}
+{"version":3,"file":"ClassRegistry.js","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAoF;AACpF,oDAAiF;AACjF,qCAAkC;AAClC,uCAAoC;AAEpC,qCAA2C;AAE3C,MAAM,mBAAmB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAa,aAAa;IAExB,gBAAgB;IACT,MAAM,CAAC,eAAe,CAAC,GAAQ,IAAI,OAAO,CAAC,GAAG,YAAY,yBAAW,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,KAAK,2BAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC/H,gBAAgB;IACT,MAAM,CAAC,yBAAyB,CAAC,SAAiB,IAAiB,OAAO,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,0BAA0B,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;IACjK,gBAAgB;IACT,MAAM,CAAC,QAAQ,CAAC,WAA0B,EAAE,MAAqB;QACtE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC;QAC5B,MAAM,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,MAAM,GAAG,SAAS,GAAG,4FAA4F,WAAW,CAAC,IAAI,EAAE,CAAC;YAC1I,qBAAM,CAAC,QAAQ,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;SACzB;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IACvC,CAAC;IAED,yEAAyE;IACjE,MAAM,CAAC,mBAAmB,CAAC,MAAc,EAAE,MAAgB;QACjE,MAAM,WAAW,GAAG,MAAM,CAAC,2BAA2B,CAAC;;;;;+FAKoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACpG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,KAAM,SAAQ,eAAM;YAC/B,MAAM,KAAc,UAAU,KAAK,OAAO,MAAM,CAAC,CAAC,CAAC;YACnD,MAAM,KAAc,uBAAuB,KAAK,OAAO,WAAW,CAAC,CAAC,CAAC;SAC7E,CAAC;QAEF,gBAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,0CAA0C;QAC/E,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,sBAAsB,CAAC,cAA8B,EAAE,MAAgB;;QACpF,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAE1B,IAAI,CAAC,KAAK,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,qCAAqC;YAChF,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,SAAS,IAAI,oBAAoB,CAAC,CAAC;QAEhF,0BAA0B;QAC1B,IAAI,MAAM,GAAG,gBAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,MAAM;YACtB,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,iCAAiC;QAE1F,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QACnF,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,oCAAoC,IAAI,EAAE,CAAC,CAAC;QAE3F,6GAA6G;QAC7G,sEAAsE;QACtE,IAAI,4CAA4C,GAAG,KAAK,CAAC;QACzD,IAAI,iBAAiB,GAAG,UAAU,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC;QACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,EAAE,CAAC,EAAE;YAClC,IAAI,iBAAiB,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS;gBAAE,MAAM;YAC7D,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE;gBACvC,4CAA4C,GAAG,IAAI,CAAC;gBACpD,MAAM;aACP;YACD,MAAM,kBAAkB,GAAG,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAC9F,IAAI,kBAAkB,KAAK,SAAS;gBAClC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,0CAA0C,iBAAiB,CAAC,IAAI,2CAA2C,CAAC,CAAC;YAC7J,MAAM,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YACrF,IAAI,mBAAmB,KAAK,SAAS;gBACnC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,qCAAqC,iBAAiB,CAAC,IAAI,iDAAiD,CAAC,CAAC;YAC9J,iBAAiB,GAAG,mBAAmB,CAAC;SACzC;QAED,MAAM,cAAc,SAAG,KAAM,SAAQ,UAAU;gBACtC,MAAM,KAAc,SAAS,KAAK,OAAO,SAAS,CAAC,CAAC,CAAC;gBAErD,MAAM,KAAc,gBAAgB,KAAK,OAAO,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;aACnG;iBAFiB,mBAAmB;YAApB,MAAqB,GAAG,IAAK;eAE7C,CAAC;QAEF,oIAAoI;QACpI,MAAM,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAE,2DAA2D;QAErI,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC;aAC9D,MAAM,CAAC,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;aAChD,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;QAExC,MAAM,SAAS,GAAG,CAAC,CAAgB,EAAuB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,iBAAO,CAAC,CAAC,CAAC,iEAAiE;QAE7I,4EAA4E;QAC5E,sCAAsC;QACtC,sCAAsC;QACtC,yGAAyG;QACzG,IAAI,CAAC,4CAA4C,IAAI,SAAS,CAAC,UAAU,CAAC,EAAE;YAC1E,MAAM,CAAC,cAAc,CACnB,cAAc,CAAC,SAAS,EACxB,uBAAuB,EACvB;gBACE,yCAAyC;gBACzC,KAAK,CAA8B,cAAuB;oBACxD,2DAA2D;oBAC3D,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC;oBAChE,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;oBACrC,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE;wBACrC,MAAM,WAAW,GAAgC,IAAY,CAAC,OAAO,CAAC,CAAC,CAAC,qDAAqD;wBAC7H,IAAI,CAAC,WAAW,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;4BAAE,SAAS;wBAC5D,cAAc,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;qBACpC;gBACH,CAAC;gBACD,wFAAwF;gBACxF,QAAQ,EAAE,IAAI;gBACd,YAAY,EAAE,IAAI;aACnB,CACF,CAAC;SACH;QAED,qGAAqG;QACrG,IAAI,MAAM,CAAC,uBAAuB,EAAE;YAClC,MAAM,UAAU,GAAG,GAAG,EAAE,GAAG,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,YAAY,EAAE,WAAW,UAAU,wDAAwD,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9J,UAAU,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAE,cAAsB,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,CAAC;SACxG;QAED,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,+BAA+B;QACtE,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,SAAc,EAAE,MAAqB;QAChE,KAAK,MAAM,UAAU,IAAI,SAAS,EAAE,EAAE,mCAAmC;YACvE,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;YACxC,IAAI,SAAS,CAAC,SAAS,YAAY,eAAM;gBACvC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;SACpC;IACH,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,aAAa,CAAC,aAAqB,EAAE,MAAgB;QAClE,MAAM,QAAQ,GAA+B,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9F,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS;YAC1D,MAAM,IAAI,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;QAEtD,iDAAiD;QACjD,IAAI,QAAQ,CAAC,WAAW,IAAI,CAAC,CAAC,KAAK,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC;YAC7D,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAEjD,mDAAmD;QACnD,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,aAAqB;QACrD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAqB,EAAE,MAAgB;QAC5D,MAAM,GAAG,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,aAAqB,IAAI,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IACnH;;;;OAIG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAAqB;QACvD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC9C,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM;gBAC5B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAClC;IACH,CAAC;;AAvMH,sCAwMC;AAvMyB,uBAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;AAyMvE;;;GAGG;AACH,MAAa,gBAAgB;IAA7B;QACU,cAAS,GAAgC,IAAI,GAAG,EAA0B,CAAC;IAOrF,CAAC;IALC,wCAAwC;IACjC,IAAI,CAAC,aAAqB,IAAgC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IAE1H,gCAAgC;IACzB,GAAG,CAAC,aAAqB,EAAE,QAAwB,IAAU,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CACjI;AARD,4CAQC","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 Schema\r\n */\r\n\r\nimport { DbResult, Id64, Id64Set, IModelStatus, Logger } from \"@itwin/core-bentley\";\r\nimport { EntityMetaData, IModelError, RelatedElement } from \"@itwin/core-common\";\r\nimport { Entity } from \"./Entity\";\r\nimport { Element } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { Schema, Schemas } from \"./Schema\";\r\n\r\nconst isGeneratedClassTag = Symbol(\"isGeneratedClassTag\");\r\n\r\n/** The mapping between a BIS class name (in the form \"schema:class\") and its JavaScript constructor function\r\n * @public\r\n */\r\nexport class ClassRegistry {\r\n  private static readonly _classMap = new Map<string, typeof Entity>();\r\n  /** @internal */\r\n  public static isNotFoundError(err: any) { return (err instanceof IModelError) && (err.errorNumber === IModelStatus.NotFound); }\r\n  /** @internal */\r\n  public static makeMetaDataNotFoundError(className: string): IModelError { return new IModelError(IModelStatus.NotFound, `metadata not found for ${className}`); }\r\n  /** @internal */\r\n  public static register(entityClass: typeof Entity, schema: typeof Schema) {\r\n    entityClass.schema = schema;\r\n    const key = (`${schema.schemaName}:${entityClass.className}`).toLowerCase();\r\n    if (this._classMap.has(key)) {\r\n      const errMsg = `Class ${key} is already registered. Make sure static className member is correct on JavaScript class ${entityClass.name}`;\r\n      Logger.logError(\"core-frontend.classRegistry\", errMsg);\r\n      throw new Error(errMsg);\r\n    }\r\n\r\n    this._classMap.set(key, entityClass);\r\n  }\r\n\r\n  /** Generate a proxy Schema for a domain that has not been registered. */\r\n  private static generateProxySchema(domain: string, iModel: IModelDb): typeof Schema {\r\n    const hasBehavior = iModel.withPreparedSqliteStatement(`\r\n      SELECT NULL FROM [ec_CustomAttribute] [c]\r\n        JOIN [ec_schema] [s] ON [s].[Id] = [c].[ContainerId]\r\n        JOIN [ec_class] [e] ON [e].[Id] = [c].[ClassId]\r\n        JOIN [ec_schema] [b] ON [e].[SchemaId] = [b].[Id]\r\n      WHERE [c].[ContainerType] = 1 AND [s].[Name] = ? AND [b].[Name] || '.' || [e].[name] = ?`, (stmt) => {\r\n      stmt.bindString(1, domain);\r\n      stmt.bindString(2, \"BisCore.SchemaHasBehavior\");\r\n      return stmt.step() === DbResult.BE_SQLITE_ROW;\r\n    });\r\n\r\n    const schemaClass = class extends Schema {\r\n      public static override get schemaName() { return domain; }\r\n      public static override get missingRequiredBehavior() { return hasBehavior; }\r\n    };\r\n\r\n    Schemas.registerSchema(schemaClass); // register the class before we return it.\r\n    return schemaClass;\r\n  }\r\n\r\n  /** Generate a JavaScript class from Entity metadata.\r\n   * @param entityMetaData The Entity metadata that defines the class\r\n   */\r\n  private static generateClassForEntity(entityMetaData: EntityMetaData, iModel: IModelDb): typeof Entity {\r\n    const name = entityMetaData.ecclass.split(\":\");\r\n    const domainName = name[0];\r\n    const className = name[1];\r\n\r\n    if (0 === entityMetaData.baseClasses.length) // metadata must contain a superclass\r\n      throw new IModelError(IModelStatus.BadArg, `class ${name} has no superclass`);\r\n\r\n    // make sure schema exists\r\n    let schema = Schemas.getRegisteredSchema(domainName);\r\n    if (undefined === schema)\r\n      schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too\r\n\r\n    const superclass = this._classMap.get(entityMetaData.baseClasses[0].toLowerCase());\r\n    if (undefined === superclass)\r\n      throw new IModelError(IModelStatus.NotFound, `cannot find superclass for class ${name}`);\r\n\r\n    // user defined class hierarchies may skip a class in the hierarchy, and therefore their JS base class cannot\r\n    // be used to tell if there are any generated classes in the hierarchy\r\n    let generatedClassHasNonGeneratedNonCoreAncestor = false;\r\n    let currentSuperclass = superclass;\r\n    const MAX_ITERS = 1000;\r\n    for (let i = 0; i < MAX_ITERS; ++i) {\r\n      if (currentSuperclass.schema.schemaName === \"BisCore\") break;\r\n      if (!currentSuperclass.isGeneratedClass) {\r\n        generatedClassHasNonGeneratedNonCoreAncestor = true;\r\n        break;\r\n      }\r\n      const superclassMetaData = iModel.classMetaDataRegistry.find(currentSuperclass.classFullName);\r\n      if (superclassMetaData === undefined)\r\n        throw new IModelError(IModelStatus.BadSchema, `could not find the metadata for class '${currentSuperclass.name}', class metadata should be loaded by now`);\r\n      const maybeNextSuperclass = this.getClass(superclassMetaData.baseClasses[0], iModel);\r\n      if (maybeNextSuperclass === undefined)\r\n        throw new IModelError(IModelStatus.BadSchema, `could not find the base class of '${currentSuperclass.name}', all generated classes must have a base class`);\r\n      currentSuperclass = maybeNextSuperclass;\r\n    }\r\n\r\n    const generatedClass = class extends superclass {\r\n      public static override get className() { return className; }\r\n      private static [isGeneratedClassTag] = true;\r\n      public static override get isGeneratedClass() { return this.hasOwnProperty(isGeneratedClassTag); }\r\n    };\r\n\r\n    // the above creates an anonymous class. For help debugging, set the \"constructor.name\" property to be the same as the bisClassName.\r\n    Object.defineProperty(generatedClass, \"name\", { get: () => className });  // this is the (only) way to change that readonly property.\r\n\r\n    const navigationProps = Object.entries(entityMetaData.properties)\r\n      .filter(([_propName, prop]) => prop.isNavigation)\r\n      .map(([propName, _prop]) => propName);\r\n\r\n    const isElement = (t: typeof Entity): t is typeof Element => t.is(Element); // Entity.is check but with type information to avoid casts later\r\n\r\n    // a class only gets an automatic `collectPredecessorIds` implementation if:\r\n    // - it derives from `BisCore:Element`\r\n    // - it is not in the `BisCore` schema\r\n    // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)\r\n    if (!generatedClassHasNonGeneratedNonCoreAncestor && isElement(superclass)) {\r\n      Object.defineProperty(\r\n        generatedClass.prototype,\r\n        \"collectPredecessorIds\",\r\n        {\r\n          // first prototype of `this` is its class\r\n          value(this: typeof generatedClass, predecessorIds: Id64Set) {\r\n            // eslint-disable-next-line @typescript-eslint/dot-notation\r\n            const superImpl = superclass.prototype[\"collectPredecessorIds\"];\r\n            superImpl.call(this, predecessorIds);\r\n            for (const navProp of navigationProps) {\r\n              const relatedElem: RelatedElement | undefined = (this as any)[navProp]; // cast to any since subclass can have any extensions\r\n              if (!relatedElem || !Id64.isValid(relatedElem.id)) continue;\r\n              predecessorIds.add(relatedElem.id);\r\n            }\r\n          },\r\n          // defaults for methods on a prototype (required for sinon to stub out methods on tests)\r\n          writable: true,\r\n          configurable: true,\r\n        }\r\n      );\r\n    }\r\n\r\n    // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations\r\n    if (schema.missingRequiredBehavior) {\r\n      const throwError = () => { throw new IModelError(IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`); };\r\n      superclass.protectedOperations.forEach((operation) => (generatedClass as any)[operation] = throwError);\r\n    }\r\n\r\n    this.register(generatedClass, schema); // register it before returning\r\n    return generatedClass;\r\n  }\r\n\r\n  /** Register all of the classes found in the given module that derive from Entity. See the example in [[Schema]]\r\n   * @param moduleObj The module to search for subclasses of Entity\r\n   * @param schema The schema for all found classes\r\n   */\r\n  public static registerModule(moduleObj: any, schema: typeof Schema) {\r\n    for (const thisMember in moduleObj) { // eslint-disable-line guard-for-in\r\n      const thisClass = moduleObj[thisMember];\r\n      if (thisClass.prototype instanceof Entity)\r\n        this.register(thisClass, schema);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated\r\n   * class. This function also ensures that all of the base classes of the Entity exist and are registered.\r\n   */\r\n  private static generateClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n    const metadata: EntityMetaData | undefined = iModel.classMetaDataRegistry.find(classFullName);\r\n    if (metadata === undefined || metadata.ecclass === undefined)\r\n      throw this.makeMetaDataNotFoundError(classFullName);\r\n\r\n    // Make sure we have all base classes registered.\r\n    if (metadata.baseClasses && (0 !== metadata.baseClasses.length))\r\n      this.getClass(metadata.baseClasses[0], iModel);\r\n\r\n    // Now we can generate the class from the classDef.\r\n    return this.generateClassForEntity(metadata, iModel);\r\n  }\r\n\r\n  /** Find a registered class by classFullName.\r\n   * @param classFullName class to find\r\n   * @param iModel The IModel that contains the class definitions\r\n   * @returns The Entity class or undefined\r\n   */\r\n  public static findRegisteredClass(classFullName: string): typeof Entity | undefined {\r\n    return this._classMap.get(classFullName.toLowerCase());\r\n  }\r\n\r\n  /** Get the Entity class for the specified Entity className.\r\n   * @param classFullName The full BIS class name of the Entity\r\n   * @param iModel The IModel that contains the class definitions\r\n   * @returns The Entity class\r\n   */\r\n  public static getClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n    const key = classFullName.toLowerCase();\r\n    const ctor = this._classMap.get(key);\r\n    return ctor ? ctor : this.generateClass(key, iModel);\r\n  }\r\n\r\n  /** Unregister a class, by name, if one is already registered.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.\r\n   * @param classFullName Name of the class to unregister\r\n   * @return true if the class was unregistered\r\n   * @internal\r\n   */\r\n  public static unregisterCLass(classFullName: string) { return this._classMap.delete(classFullName.toLowerCase()); }\r\n  /** Unregister all classes from a schema.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.\r\n   * @param schema Name of the schema to unregister\r\n   * @internal\r\n   */\r\n  public static unregisterClassesFrom(schema: typeof Schema) {\r\n    for (const entry of Array.from(this._classMap)) {\r\n      if (entry[1].schema === schema)\r\n        this.unregisterCLass(entry[0]);\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * A cache that records the mapping between class names and class metadata\r\n * @internal\r\n */\r\nexport class MetaDataRegistry {\r\n  private _registry: Map<string, EntityMetaData> = new Map<string, EntityMetaData>();\r\n\r\n  /** Get the specified Entity metadata */\r\n  public find(classFullName: string): EntityMetaData | undefined { return this._registry.get(classFullName.toLowerCase()); }\r\n\r\n  /** Add metadata to the cache */\r\n  public add(classFullName: string, metaData: EntityMetaData): void { this._registry.set(classFullName.toLowerCase(), metaData); }\r\n}\r\n"]}