@itwin/core-backend 4.0.0-dev.4 → 4.0.0-dev.41

package/CHANGELOG.md

@@ -1,6 +1,28 @@
 # Change Log - @itwin/core-backend
 
-This log was last generated on Thu, 26 Jan 2023 22:53:27 GMT and should not be manually modified.
+This log was last generated on Wed, 08 Feb 2023 14:58:39 GMT and should not be manually modified.
+
+## 3.6.0
+Wed, 08 Feb 2023 14:58:39 GMT
+
+### Updates
+
+- add CodeSpecs.updateProperties
+- add flag schemaLockHeld
+- Added getOriginPropertyName() method to column info.
+- add allowPreceding as an optional boolean to CheckpointProps interface
+- Log a warning when we fail to download a v2 checkpoint, but download a v1 checkpoint successfully.
+- Promote IModelHost.authorizationClient to public.
+- Add support for material elements with normal maps
+- React to RPC deprecations.
+- Fix documentation of ExternalSourceAspectProps.jsonProperties. It must be a string.
+- Element.toJSON should not include undefined values for userLabel or federationGuid
+- allow passing a custom schema read context to IModelDb.importSchemas
+
+## 3.5.6
+Fri, 24 Feb 2023 16:02:47 GMT
+
+_Version update only_
 
 ## 3.5.5
 Thu, 26 Jan 2023 22:53:27 GMT
@@ -496,7 +518,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
@@ -531,11 +553,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.
 
@@ -556,7 +578,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
@@ -822,8 +844,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.
@@ -1013,8 +1035,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
@@ -1105,7 +1127,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.
@@ -1169,7 +1191,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
@@ -1210,25 +1232,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
@@ -1241,23 +1263,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.
@@ -1278,29 +1300,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)
@@ -1312,13 +1334,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
@@ -1333,7 +1355,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
 
@@ -1348,7 +1370,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
@@ -1359,7 +1381,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.
@@ -1392,7 +1414,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.
 
@@ -1404,7 +1426,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.
@@ -1460,9 +1482,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
@@ -1477,14 +1499,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
 
@@ -1494,14 +1516,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
@@ -1513,7 +1535,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
@@ -1531,19 +1553,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
@@ -1554,7 +1576,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
@@ -1602,12 +1624,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
@@ -1617,7 +1639,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
@@ -1644,7 +1666,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.
@@ -1689,8 +1711,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
 
@@ -1795,7 +1817,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.
@@ -1864,11 +1886,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/AliCloudStorageService.d.ts

@@ -2,7 +2,7 @@ import { CloudStorageContainerDescriptor, CloudStorageContainerUrl, CloudStorage
 import { CloudStorageService, CloudStorageUploadOptions } from "./CloudStorageBackend";
 /**
  * @beta
- * @deprecated in 3.x.
+ * @deprecated in 3.x. Use `@itwin/object-storage-oss` instead, see https://github.com/iTwin/object-storage for more details.
  */
 export interface AliCloudStorageServiceCredentials {
     region: string;

package/lib/cjs/AliCloudStorageService.js.map

@@ -1 +1 @@
-{"version":3,"file":"AliCloudStorageService.js","sourceRoot":"","sources":["../../src/AliCloudStorageService.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,mCAA+C;AAC/C,6BAA6B;AAC7B,sDAAoD;AACpD,oDAAkI;AAClI,+DAAuF;AAmCvF;;;GAGG;AACH,MAAa,sBAAuB,SAAQ,yCAAmB;IAK7D,YAAmB,WAA8C;QAC/D,KAAK,EAAE,CAAC;QAHH,OAAE,GAAG,kCAAoB,CAAC,QAAQ,CAAC;QAKxC,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;IACtC,CAAC;IAEM,kBAAkB,CAAC,EAAmC,EAAE,MAAY,EAAE,SAAkB;QAC7F,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAEjC,MAAM,MAAM,GAA4B;YACtC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,GAAG,GAAG;SAChC,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAEhC,IAAI,SAAS,KAAK,EAAE,CAAC,QAAQ;YAC3B,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,8EAA8E,CAAC,CAAC;QAE7H,MAAM,GAAG,GAA6B;YACpC,UAAU,EAAE,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;YACnC,KAAK,EAAE,CAAC;YACR,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;YACzB,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;YACnD,KAAK,EAAE,IAAI;SACZ,CAAC;QAEF,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,IAAY,EAAE,MAAc,EAAE,KAAa;QACpE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC7B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;QACzE,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/D,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,IAAY,EAAE,IAAgB,EAAE,OAAmC;QACxG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACxC,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,EAAE,aAAa,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QACnJ,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAElC,MAAM,UAAU,GAAG,IAAI,oBAAW,EAAE,CAAC;QACrC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAErB,IAAI,MAAgB,CAAC;QAErB,MAAM,UAAU,GAAG;YACjB,IAAI,EAAE,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,0BAA0B;YAC3E,OAAO,EAAE;gBACP,gEAAgE;gBAChE,eAAe,EAAE,CAAC,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,sCAAsC;aACnH;SACsB,CAAC;QAE1B,IAAI,OAAO,IAAI,OAAO,CAAC,eAAe,KAAK,MAAM,EAAE;YAChD,UAAU,CAAC,OAAe,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC;YAC1E,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;YACrC,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SACtC;aAAM;YACL,MAAM,GAAG,UAAU,CAAC;SACrB;QACD,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;QACvD,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AApED,wDAoEC","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\nimport { PassThrough, Readable } from \"stream\";\r\nimport * as zlib from \"zlib\";\r\nimport { BentleyStatus } from \"@itwin/core-bentley\";\r\nimport { CloudStorageContainerDescriptor, CloudStorageContainerUrl, CloudStorageProvider, IModelError } from \"@itwin/core-common\";\r\nimport { CloudStorageService, CloudStorageUploadOptions } from \"./CloudStorageBackend\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/**\r\n * @beta\r\n * @deprecated in 3.x.\r\n */\r\nexport interface AliCloudStorageServiceCredentials {\r\n  region: string;\r\n  accessKeyId: string;\r\n  accessKeySecret: string;\r\n}\r\n\r\ndeclare class OSS {\r\n  constructor(params: AliCloudStorageServiceCredentials)\r\n  public useBucket(name: string): void;\r\n  public signatureUrl(name: string, policy: OSS.SignatureUrlOptions): string;\r\n  public list(params: { marker: string, \"max-keys\": number }, arg2: {}): Promise<{ objects?: Array<{ name: string }> }>;\r\n  public putBucket(name: string): Promise<void>;\r\n  public putBucketCORS(name: string, params: Array<{ allowedOrigin: string, allowedMethod: string[], allowedHeader: string }>): Promise<void>;\r\n  public putStream(name: string, source: Readable, options: OSS.PutStreamOptions): Promise<void>;\r\n}\r\n\r\ndeclare namespace OSS { // eslint-disable-line no-redeclare\r\n  interface SignatureUrlOptions {\r\n    expires: number;\r\n  }\r\n\r\n  interface PutStreamOptions {\r\n    mime: string;\r\n    headers: { [index: string]: string };\r\n  }\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated in 3.x. Use `@itwin/object-storage-oss` instead, see https://github.com/iTwin/object-storage for more details.\r\n */\r\nexport class AliCloudStorageService extends CloudStorageService {\r\n  private _client: OSS;\r\n\r\n  public id = CloudStorageProvider.AliCloud;\r\n\r\n  public constructor(credentials: AliCloudStorageServiceCredentials) {\r\n    super();\r\n\r\n    this._client = new OSS(credentials);\r\n  }\r\n\r\n  public obtainContainerUrl(id: CloudStorageContainerDescriptor, expiry: Date, _clientIp?: string): CloudStorageContainerUrl {\r\n    const now = new Date().getTime();\r\n\r\n    const policy: OSS.SignatureUrlOptions = {\r\n      expires: expiry.getTime() - now,\r\n    };\r\n\r\n    this._client.useBucket(id.name);\r\n\r\n    if (undefined === id.resource)\r\n      throw new IModelError(BentleyStatus.ERROR, \"Attribute 'resource' on CloudStorageContainerDescriptor object is undefined.\");\r\n\r\n    const url: CloudStorageContainerUrl = {\r\n      descriptor: this.makeDescriptor(id),\r\n      valid: 0,\r\n      expires: expiry.getTime(),\r\n      url: this._client.signatureUrl(id.resource, policy),\r\n      bound: true,\r\n    };\r\n\r\n    return url;\r\n  }\r\n\r\n  public async listContainer(name: string, marker: string, count: number): Promise<string[]> {\r\n    this._client.useBucket(name);\r\n    const query = await this._client.list({ marker, \"max-keys\": count }, {});\r\n    return query.objects ? query.objects.map((o) => o.name) : [];\r\n  }\r\n\r\n  public async upload(container: string, name: string, data: Uint8Array, options?: CloudStorageUploadOptions): Promise<string> {\r\n    await this._client.putBucket(container);\r\n    await this._client.putBucketCORS(container, [{ allowedOrigin: \"*\", allowedMethod: [\"GET\", \"POST\", \"PUT\", \"DELETE\", \"HEAD\"], allowedHeader: \"*\" }]);\r\n    this._client.useBucket(container);\r\n\r\n    const dataStream = new PassThrough();\r\n    dataStream.end(data);\r\n\r\n    let source: Readable;\r\n\r\n    const putOptions = {\r\n      mime: (options && options.type) ? options.type : \"application/octet-stream\",\r\n      headers: {\r\n        // eslint-disable-next-line @typescript-eslint/naming-convention\r\n        \"Cache-Control\": (options && options.cacheControl) ? options.cacheControl : \"private, max-age=31536000, immutable\",\r\n      },\r\n    } as OSS.PutStreamOptions;\r\n\r\n    if (options && options.contentEncoding === \"gzip\") {\r\n      (putOptions.headers as any)[\"Content-Encoding\"] = options.contentEncoding;\r\n      const compressor = zlib.createGzip();\r\n      source = dataStream.pipe(compressor);\r\n    } else {\r\n      source = dataStream;\r\n    }\r\n    await this._client.putStream(name, source, putOptions);\r\n    return \"\";\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"AliCloudStorageService.js","sourceRoot":"","sources":["../../src/AliCloudStorageService.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,mCAA+C;AAC/C,6BAA6B;AAC7B,sDAAoD;AACpD,oDAAkI;AAClI,+DAAuF;AAmCvF;;;GAGG;AACH,MAAa,sBAAuB,SAAQ,yCAAmB;IAK7D,YAAmB,WAA8C;QAC/D,KAAK,EAAE,CAAC;QAHH,OAAE,GAAG,kCAAoB,CAAC,QAAQ,CAAC;QAKxC,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;IACtC,CAAC;IAEM,kBAAkB,CAAC,EAAmC,EAAE,MAAY,EAAE,SAAkB;QAC7F,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAEjC,MAAM,MAAM,GAA4B;YACtC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,GAAG,GAAG;SAChC,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAEhC,IAAI,SAAS,KAAK,EAAE,CAAC,QAAQ;YAC3B,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,8EAA8E,CAAC,CAAC;QAE7H,MAAM,GAAG,GAA6B;YACpC,UAAU,EAAE,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;YACnC,KAAK,EAAE,CAAC;YACR,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;YACzB,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;YACnD,KAAK,EAAE,IAAI;SACZ,CAAC;QAEF,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,IAAY,EAAE,MAAc,EAAE,KAAa;QACpE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC7B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;QACzE,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/D,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,IAAY,EAAE,IAAgB,EAAE,OAAmC;QACxG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACxC,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,EAAE,aAAa,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QACnJ,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAElC,MAAM,UAAU,GAAG,IAAI,oBAAW,EAAE,CAAC;QACrC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAErB,IAAI,MAAgB,CAAC;QAErB,MAAM,UAAU,GAAG;YACjB,IAAI,EAAE,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,0BAA0B;YAC3E,OAAO,EAAE;gBACP,gEAAgE;gBAChE,eAAe,EAAE,CAAC,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,sCAAsC;aACnH;SACsB,CAAC;QAE1B,IAAI,OAAO,IAAI,OAAO,CAAC,eAAe,KAAK,MAAM,EAAE;YAChD,UAAU,CAAC,OAAe,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC;YAC1E,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;YACrC,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SACtC;aAAM;YACL,MAAM,GAAG,UAAU,CAAC;SACrB;QACD,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;QACvD,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AApED,wDAoEC","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\nimport { PassThrough, Readable } from \"stream\";\r\nimport * as zlib from \"zlib\";\r\nimport { BentleyStatus } from \"@itwin/core-bentley\";\r\nimport { CloudStorageContainerDescriptor, CloudStorageContainerUrl, CloudStorageProvider, IModelError } from \"@itwin/core-common\";\r\nimport { CloudStorageService, CloudStorageUploadOptions } from \"./CloudStorageBackend\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/**\r\n * @beta\r\n * @deprecated in 3.x. Use `@itwin/object-storage-oss` instead, see https://github.com/iTwin/object-storage for more details.\r\n */\r\nexport interface AliCloudStorageServiceCredentials {\r\n  region: string;\r\n  accessKeyId: string;\r\n  accessKeySecret: string;\r\n}\r\n\r\ndeclare class OSS {\r\n  constructor(params: AliCloudStorageServiceCredentials)\r\n  public useBucket(name: string): void;\r\n  public signatureUrl(name: string, policy: OSS.SignatureUrlOptions): string;\r\n  public list(params: { marker: string, \"max-keys\": number }, arg2: {}): Promise<{ objects?: Array<{ name: string }> }>;\r\n  public putBucket(name: string): Promise<void>;\r\n  public putBucketCORS(name: string, params: Array<{ allowedOrigin: string, allowedMethod: string[], allowedHeader: string }>): Promise<void>;\r\n  public putStream(name: string, source: Readable, options: OSS.PutStreamOptions): Promise<void>;\r\n}\r\n\r\ndeclare namespace OSS { // eslint-disable-line no-redeclare\r\n  interface SignatureUrlOptions {\r\n    expires: number;\r\n  }\r\n\r\n  interface PutStreamOptions {\r\n    mime: string;\r\n    headers: { [index: string]: string };\r\n  }\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated in 3.x. Use `@itwin/object-storage-oss` instead, see https://github.com/iTwin/object-storage for more details.\r\n */\r\nexport class AliCloudStorageService extends CloudStorageService {\r\n  private _client: OSS;\r\n\r\n  public id = CloudStorageProvider.AliCloud;\r\n\r\n  public constructor(credentials: AliCloudStorageServiceCredentials) {\r\n    super();\r\n\r\n    this._client = new OSS(credentials);\r\n  }\r\n\r\n  public obtainContainerUrl(id: CloudStorageContainerDescriptor, expiry: Date, _clientIp?: string): CloudStorageContainerUrl {\r\n    const now = new Date().getTime();\r\n\r\n    const policy: OSS.SignatureUrlOptions = {\r\n      expires: expiry.getTime() - now,\r\n    };\r\n\r\n    this._client.useBucket(id.name);\r\n\r\n    if (undefined === id.resource)\r\n      throw new IModelError(BentleyStatus.ERROR, \"Attribute 'resource' on CloudStorageContainerDescriptor object is undefined.\");\r\n\r\n    const url: CloudStorageContainerUrl = {\r\n      descriptor: this.makeDescriptor(id),\r\n      valid: 0,\r\n      expires: expiry.getTime(),\r\n      url: this._client.signatureUrl(id.resource, policy),\r\n      bound: true,\r\n    };\r\n\r\n    return url;\r\n  }\r\n\r\n  public async listContainer(name: string, marker: string, count: number): Promise<string[]> {\r\n    this._client.useBucket(name);\r\n    const query = await this._client.list({ marker, \"max-keys\": count }, {});\r\n    return query.objects ? query.objects.map((o) => o.name) : [];\r\n  }\r\n\r\n  public async upload(container: string, name: string, data: Uint8Array, options?: CloudStorageUploadOptions): Promise<string> {\r\n    await this._client.putBucket(container);\r\n    await this._client.putBucketCORS(container, [{ allowedOrigin: \"*\", allowedMethod: [\"GET\", \"POST\", \"PUT\", \"DELETE\", \"HEAD\"], allowedHeader: \"*\" }]);\r\n    this._client.useBucket(container);\r\n\r\n    const dataStream = new PassThrough();\r\n    dataStream.end(data);\r\n\r\n    let source: Readable;\r\n\r\n    const putOptions = {\r\n      mime: (options && options.type) ? options.type : \"application/octet-stream\",\r\n      headers: {\r\n        // eslint-disable-next-line @typescript-eslint/naming-convention\r\n        \"Cache-Control\": (options && options.cacheControl) ? options.cacheControl : \"private, max-age=31536000, immutable\",\r\n      },\r\n    } as OSS.PutStreamOptions;\r\n\r\n    if (options && options.contentEncoding === \"gzip\") {\r\n      (putOptions.headers as any)[\"Content-Encoding\"] = options.contentEncoding;\r\n      const compressor = zlib.createGzip();\r\n      source = dataStream.pipe(compressor);\r\n    } else {\r\n      source = dataStream;\r\n    }\r\n    await this._client.putStream(name, source, putOptions);\r\n    return \"\";\r\n  }\r\n}\r\n"]}

package/lib/cjs/BackendHubAccess.d.ts

@@ -140,7 +140,7 @@ export interface DownloadChangesetRangeArg extends ChangesetRangeArg, DownloadPr
     targetDir: LocalDirName;
 }
 /**
- * @deprecated in 3.x.
+ * @deprecated in 3.x. Use [[DownloadRequest]].
  * @internal
  */
 export declare type CheckpointArg = DownloadRequest;
@@ -190,8 +190,8 @@ export interface BackendHubAccess {
     /** get an array of the briefcases assigned to a user. */
     getMyBriefcaseIds: (arg: IModelIdArg) => Promise<BriefcaseId[]>;
     /**
-     * download a v1 checkpoint
-     * @deprecated in 3.x.
+     * Download a v1 checkpoint
+     * @deprecated in 3.x. V1 checkpoints are deprecated. Download V2 checkpoint using [[V2CheckpointManager.downloadCheckpoint]].
      * @internal
      */
     downloadV1Checkpoint: (arg: CheckpointArg) => Promise<ChangesetIndexAndId>;

package/lib/cjs/BackendHubAccess.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackendHubAccess.js","sourceRoot":"","sources":["../../src/BackendHubAccess.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA2F;AAC3F,oDAG4B;AAI5B;;GAEG;AACH,IAAY,SASX;AATD,WAAY,SAAS;IACnB,gCAAgC;IAChC,yCAAQ,CAAA;IACR,mJAAmJ;IACnJ,6CAAU,CAAA;IACV;;OAEG;IACH,mDAAa,CAAA;AACf,CAAC,EATW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QASpB;AAED;;EAEE;AACF,MAAa,YAAa,SAAQ,yBAAW;IAC3C;IACE,mCAAmC;IACnB,WAAwB;IACxC,sCAAsC;IACtB,cAAsB,EACtC,GAA6D;QAE7D,KAAK,CAAC,8BAAe,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAC;QALxC,gBAAW,GAAX,WAAW,CAAa;QAExB,mBAAc,GAAd,cAAc,CAAQ;IAIxC,CAAC;CACF;AAVD,oCAUC","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 HubAccess\r\n */\r\n\r\nimport { AccessToken, GuidString, Id64String, IModelHubStatus } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseId, ChangesetFileProps, ChangesetIdWithIndex, ChangesetIndex, ChangesetIndexAndId, ChangesetIndexOrId, ChangesetProps, ChangesetRange,\r\n  IModelError, IModelVersion, LocalDirName, LocalFileName,\r\n} from \"@itwin/core-common\";\r\nimport { CheckpointProps, DownloadRequest, ProgressFunction } from \"./CheckpointManager\";\r\nimport { TokenArg } from \"./IModelDb\";\r\n\r\n/** The state of a lock.\r\n * @public\r\n */\r\nexport enum LockState {\r\n  /** The element is not locked */\r\n  None = 0,\r\n  /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */\r\n  Shared = 1,\r\n  /** A Lock that permits modifications to an element and blocks other users from making modifications to it.\r\n   * Holding an exclusive lock on an \"owner\" (a model or a parent element), implicitly exclusively locks all its members.\r\n   */\r\n  Exclusive = 2,\r\n}\r\n\r\n/** Exception thrown if lock cannot be acquired.\r\n * @beta\r\n*/\r\nexport class LockConflict extends IModelError {\r\n  public constructor(\r\n    /** Id of Briefcase holding lock */\r\n    public readonly briefcaseId: BriefcaseId,\r\n    /** Alias of Briefcase holding lock */\r\n    public readonly briefcaseAlias: string,\r\n    msg: \"shared lock is held\" | \"exclusive lock is already held\"\r\n  ) {\r\n    super(IModelHubStatus.LockOwnedByAnotherBriefcase, msg);\r\n  }\r\n}\r\n\r\n/**\r\n * The properties to access a V2 checkpoint through a daemon.\r\n * @internal\r\n */\r\nexport interface V2CheckpointAccessProps {\r\n  /** blob store account name. */\r\n  readonly accountName: string;\r\n  /** AccessToken that grants access to the container. */\r\n  readonly sasToken: AccessToken;\r\n  /** The name of the iModel's blob store container holding all checkpoints. */\r\n  readonly containerId: string;\r\n  /** The name of the virtual file within the container, used for the checkpoint */\r\n  readonly dbName: string;\r\n  /** blob storage module: e.g. \"azure\", \"google\", \"aws\". May also include URI style parameters. */\r\n  readonly storageType: string;\r\n}\r\n\r\n/** @internal */\r\nexport type LockMap = Map<Id64String, LockState>;\r\n\r\n/**\r\n * The properties of a lock that may be obtained from a lock server.\r\n * @beta\r\n */\r\nexport interface LockProps {\r\n  /** The elementId for the lock */\r\n  readonly id: Id64String;\r\n  /** the lock state */\r\n  readonly state: LockState;\r\n}\r\n\r\n/**\r\n * Argument for cancelling and tracking download progress.\r\n * @beta\r\n */\r\nexport interface DownloadProgressArg {\r\n  /** Called to show progress during a download. If this function returns non-zero, the download is aborted. */\r\n  progressCallback?: ProgressFunction;\r\n}\r\n\r\n/**\r\n * Argument for methods that must supply an iTwinId\r\n * @public\r\n */\r\nexport interface ITwinIdArg {\r\n  readonly iTwinId: GuidString;\r\n}\r\n\r\n/**\r\n * Argument for methods that must supply an IModelId\r\n * @public\r\n */\r\nexport interface IModelIdArg extends TokenArg {\r\n  readonly iModelId: GuidString;\r\n}\r\n\r\n/**\r\n * Argument for acquiring a new BriefcaseId\r\n * @public\r\n */\r\nexport interface AcquireNewBriefcaseIdArg extends IModelIdArg {\r\n  /** A string to be reported to other users to identify this briefcase, for example in the case of conflicts or lock collisions. */\r\n  readonly briefcaseAlias?: string;\r\n}\r\n\r\n/** Argument for methods that must supply an IModel name and iTwinId\r\n * @public\r\n */\r\nexport interface IModelNameArg extends TokenArg, ITwinIdArg {\r\n  readonly iModelName: string;\r\n}\r\n\r\n/** Argument for methods that must supply an IModelId and a BriefcaseId\r\n * @public\r\n */\r\nexport interface BriefcaseIdArg extends IModelIdArg {\r\n  readonly briefcaseId: BriefcaseId;\r\n}\r\n\r\n/** Argument for methods that must supply a briefcaseId and a changeset\r\n * @public\r\n */\r\nexport interface BriefcaseDbArg extends BriefcaseIdArg {\r\n  readonly changeset: ChangesetIdWithIndex;\r\n}\r\n\r\n/** Argument for methods that must supply an IModelId and a changeset\r\n * @public\r\n */\r\nexport interface ChangesetArg extends IModelIdArg {\r\n  readonly changeset: ChangesetIndexOrId;\r\n}\r\n\r\n/** Argument for downloading a changeset.\r\n * @beta\r\n */\r\nexport interface DownloadChangesetArg extends ChangesetArg, DownloadProgressArg {\r\n  /** Directory where the changeset should be downloaded. */\r\n  targetDir: LocalDirName;\r\n}\r\n\r\n/** @internal */\r\nexport interface ChangesetIndexArg extends IModelIdArg {\r\n  readonly changeset: ChangesetIdWithIndex;\r\n}\r\n\r\n/** Argument for methods that must supply an IModelId and a range of Changesets.\r\n * @public\r\n */\r\nexport interface ChangesetRangeArg extends IModelIdArg {\r\n  /** the range of changesets desired. If is undefined, *all* changesets are returned. */\r\n  readonly range?: ChangesetRange;\r\n}\r\n\r\n/** Argument for downloading a changeset range.\r\n * @beta\r\n */\r\nexport interface DownloadChangesetRangeArg extends ChangesetRangeArg, DownloadProgressArg {\r\n  /** Directory where the changesets should be downloaded. */\r\n  targetDir: LocalDirName;\r\n}\r\n\r\n/**\r\n * @deprecated in 3.x.\r\n * @internal\r\n */\r\nexport type CheckpointArg = DownloadRequest;\r\n\r\n/**\r\n * Arguments to create a new iModel in iModelHub\r\n *  @public\r\n */\r\nexport interface CreateNewIModelProps extends IModelNameArg {\r\n  readonly description?: string;\r\n  readonly version0?: LocalFileName;\r\n  readonly noLocks?: true;\r\n}\r\n\r\n/**\r\n * Methods for accessing services of IModelHub from an iTwin.js backend.\r\n * Generally direct access to these methods should not be required, since higher-level apis are provided.\r\n * @beta\r\n */\r\nexport interface BackendHubAccess {\r\n  /** Download all the changesets in the specified range. */\r\n  downloadChangesets: (arg: DownloadChangesetRangeArg) => Promise<ChangesetFileProps[]>;\r\n  /** Download a single changeset. */\r\n  downloadChangeset: (arg: DownloadChangesetArg) => Promise<ChangesetFileProps>;\r\n  /** Query the changeset properties given a ChangesetIndex  */\r\n  queryChangeset: (arg: ChangesetArg) => Promise<ChangesetProps>;\r\n  /** Query an array of changeset properties given a range of ChangesetIndexes  */\r\n  queryChangesets: (arg: ChangesetRangeArg) => Promise<ChangesetProps[]>;\r\n  /** Push a changeset to iModelHub. Returns the newly pushed changeset's index */\r\n  pushChangeset: (arg: IModelIdArg & { changesetProps: ChangesetFileProps }) => Promise<ChangesetIndex>;\r\n  /** Get the ChangesetProps of the most recent changeset */\r\n  getLatestChangeset: (arg: IModelIdArg) => Promise<ChangesetProps>;\r\n  /** Get the ChangesetProps for an IModelVersion */\r\n  getChangesetFromVersion: (arg: IModelIdArg & { version: IModelVersion }) => Promise<ChangesetProps>;\r\n  /** Get the ChangesetProps for a named version */\r\n  getChangesetFromNamedVersion: (arg: IModelIdArg & { versionName: string }) => Promise<ChangesetProps>;\r\n\r\n  /** Acquire a new briefcaseId for the supplied iModelId\r\n     * @note usually there should only be one briefcase per iModel per user.\r\n     */\r\n  acquireNewBriefcaseId: (arg: AcquireNewBriefcaseIdArg) => Promise<BriefcaseId>;\r\n  /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */\r\n  releaseBriefcase: (arg: BriefcaseIdArg) => Promise<void>;\r\n\r\n  /** get an array of the briefcases assigned to a user. */\r\n  getMyBriefcaseIds: (arg: IModelIdArg) => Promise<BriefcaseId[]>;\r\n\r\n  /**\r\n   * download a v1 checkpoint\r\n   * @deprecated in 3.x.\r\n   * @internal\r\n   */\r\n  downloadV1Checkpoint: (arg: CheckpointArg) => Promise<ChangesetIndexAndId>; // eslint-disable-line deprecation/deprecation\r\n\r\n  /**\r\n   * Get the access props for a V2 checkpoint. Returns undefined if no V2 checkpoint exists.\r\n   * @internal\r\n   */\r\n  queryV2Checkpoint: (arg: CheckpointProps) => Promise<V2CheckpointAccessProps | undefined>;\r\n\r\n  /**\r\n   * acquire one or more locks. Throws if unsuccessful. If *any* lock cannot be obtained, no locks are acquired\r\n   * @internal\r\n   */\r\n  acquireLocks: (arg: BriefcaseDbArg, locks: LockMap) => Promise<void>;\r\n\r\n  /**\r\n   * Get the list of all held locks for a briefcase. This can be very expensive and is currently used only for tests.\r\n   * @internal\r\n   */\r\n  queryAllLocks: (arg: BriefcaseDbArg) => Promise<LockProps[]>;\r\n\r\n  /**\r\n   * Release all currently held locks\r\n   * @internal\r\n   */\r\n  releaseAllLocks: (arg: BriefcaseDbArg) => Promise<void>;\r\n\r\n  /** Get the iModelId of an iModel by name. Undefined if no iModel with that name exists.  */\r\n  queryIModelByName: (arg: IModelNameArg) => Promise<GuidString | undefined>;\r\n\r\n  /** create a new iModel. Returns the Guid of the newly created iModel */\r\n  createNewIModel: (arg: CreateNewIModelProps) => Promise<GuidString>;\r\n\r\n  /** delete an iModel */\r\n  deleteIModel: (arg: IModelIdArg & ITwinIdArg) => Promise<void>;\r\n}\r\n"]}
+{"version":3,"file":"BackendHubAccess.js","sourceRoot":"","sources":["../../src/BackendHubAccess.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA2F;AAC3F,oDAG4B;AAI5B;;GAEG;AACH,IAAY,SASX;AATD,WAAY,SAAS;IACnB,gCAAgC;IAChC,yCAAQ,CAAA;IACR,mJAAmJ;IACnJ,6CAAU,CAAA;IACV;;OAEG;IACH,mDAAa,CAAA;AACf,CAAC,EATW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QASpB;AAED;;EAEE;AACF,MAAa,YAAa,SAAQ,yBAAW;IAC3C;IACE,mCAAmC;IACnB,WAAwB;IACxC,sCAAsC;IACtB,cAAsB,EACtC,GAA6D;QAE7D,KAAK,CAAC,8BAAe,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAC;QALxC,gBAAW,GAAX,WAAW,CAAa;QAExB,mBAAc,GAAd,cAAc,CAAQ;IAIxC,CAAC;CACF;AAVD,oCAUC","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 HubAccess\r\n */\r\n\r\nimport { AccessToken, GuidString, Id64String, IModelHubStatus } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseId, ChangesetFileProps, ChangesetIdWithIndex, ChangesetIndex, ChangesetIndexAndId, ChangesetIndexOrId, ChangesetProps, ChangesetRange,\r\n  IModelError, IModelVersion, LocalDirName, LocalFileName,\r\n} from \"@itwin/core-common\";\r\nimport { CheckpointProps, DownloadRequest, ProgressFunction } from \"./CheckpointManager\";\r\nimport { TokenArg } from \"./IModelDb\";\r\n\r\n/** The state of a lock.\r\n * @public\r\n */\r\nexport enum LockState {\r\n  /** The element is not locked */\r\n  None = 0,\r\n  /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */\r\n  Shared = 1,\r\n  /** A Lock that permits modifications to an element and blocks other users from making modifications to it.\r\n   * Holding an exclusive lock on an \"owner\" (a model or a parent element), implicitly exclusively locks all its members.\r\n   */\r\n  Exclusive = 2,\r\n}\r\n\r\n/** Exception thrown if lock cannot be acquired.\r\n * @beta\r\n*/\r\nexport class LockConflict extends IModelError {\r\n  public constructor(\r\n    /** Id of Briefcase holding lock */\r\n    public readonly briefcaseId: BriefcaseId,\r\n    /** Alias of Briefcase holding lock */\r\n    public readonly briefcaseAlias: string,\r\n    msg: \"shared lock is held\" | \"exclusive lock is already held\"\r\n  ) {\r\n    super(IModelHubStatus.LockOwnedByAnotherBriefcase, msg);\r\n  }\r\n}\r\n\r\n/**\r\n * The properties to access a V2 checkpoint through a daemon.\r\n * @internal\r\n */\r\nexport interface V2CheckpointAccessProps {\r\n  /** blob store account name. */\r\n  readonly accountName: string;\r\n  /** AccessToken that grants access to the container. */\r\n  readonly sasToken: AccessToken;\r\n  /** The name of the iModel's blob store container holding all checkpoints. */\r\n  readonly containerId: string;\r\n  /** The name of the virtual file within the container, used for the checkpoint */\r\n  readonly dbName: string;\r\n  /** blob storage module: e.g. \"azure\", \"google\", \"aws\". May also include URI style parameters. */\r\n  readonly storageType: string;\r\n}\r\n\r\n/** @internal */\r\nexport type LockMap = Map<Id64String, LockState>;\r\n\r\n/**\r\n * The properties of a lock that may be obtained from a lock server.\r\n * @beta\r\n */\r\nexport interface LockProps {\r\n  /** The elementId for the lock */\r\n  readonly id: Id64String;\r\n  /** the lock state */\r\n  readonly state: LockState;\r\n}\r\n\r\n/**\r\n * Argument for cancelling and tracking download progress.\r\n * @beta\r\n */\r\nexport interface DownloadProgressArg {\r\n  /** Called to show progress during a download. If this function returns non-zero, the download is aborted. */\r\n  progressCallback?: ProgressFunction;\r\n}\r\n\r\n/**\r\n * Argument for methods that must supply an iTwinId\r\n * @public\r\n */\r\nexport interface ITwinIdArg {\r\n  readonly iTwinId: GuidString;\r\n}\r\n\r\n/**\r\n * Argument for methods that must supply an IModelId\r\n * @public\r\n */\r\nexport interface IModelIdArg extends TokenArg {\r\n  readonly iModelId: GuidString;\r\n}\r\n\r\n/**\r\n * Argument for acquiring a new BriefcaseId\r\n * @public\r\n */\r\nexport interface AcquireNewBriefcaseIdArg extends IModelIdArg {\r\n  /** A string to be reported to other users to identify this briefcase, for example in the case of conflicts or lock collisions. */\r\n  readonly briefcaseAlias?: string;\r\n}\r\n\r\n/** Argument for methods that must supply an IModel name and iTwinId\r\n * @public\r\n */\r\nexport interface IModelNameArg extends TokenArg, ITwinIdArg {\r\n  readonly iModelName: string;\r\n}\r\n\r\n/** Argument for methods that must supply an IModelId and a BriefcaseId\r\n * @public\r\n */\r\nexport interface BriefcaseIdArg extends IModelIdArg {\r\n  readonly briefcaseId: BriefcaseId;\r\n}\r\n\r\n/** Argument for methods that must supply a briefcaseId and a changeset\r\n * @public\r\n */\r\nexport interface BriefcaseDbArg extends BriefcaseIdArg {\r\n  readonly changeset: ChangesetIdWithIndex;\r\n}\r\n\r\n/** Argument for methods that must supply an IModelId and a changeset\r\n * @public\r\n */\r\nexport interface ChangesetArg extends IModelIdArg {\r\n  readonly changeset: ChangesetIndexOrId;\r\n}\r\n\r\n/** Argument for downloading a changeset.\r\n * @beta\r\n */\r\nexport interface DownloadChangesetArg extends ChangesetArg, DownloadProgressArg {\r\n  /** Directory where the changeset should be downloaded. */\r\n  targetDir: LocalDirName;\r\n}\r\n\r\n/** @internal */\r\nexport interface ChangesetIndexArg extends IModelIdArg {\r\n  readonly changeset: ChangesetIdWithIndex;\r\n}\r\n\r\n/** Argument for methods that must supply an IModelId and a range of Changesets.\r\n * @public\r\n */\r\nexport interface ChangesetRangeArg extends IModelIdArg {\r\n  /** the range of changesets desired. If is undefined, *all* changesets are returned. */\r\n  readonly range?: ChangesetRange;\r\n}\r\n\r\n/** Argument for downloading a changeset range.\r\n * @beta\r\n */\r\nexport interface DownloadChangesetRangeArg extends ChangesetRangeArg, DownloadProgressArg {\r\n  /** Directory where the changesets should be downloaded. */\r\n  targetDir: LocalDirName;\r\n}\r\n\r\n/**\r\n * @deprecated in 3.x. Use [[DownloadRequest]].\r\n * @internal\r\n */\r\nexport type CheckpointArg = DownloadRequest;\r\n\r\n/**\r\n * Arguments to create a new iModel in iModelHub\r\n *  @public\r\n */\r\nexport interface CreateNewIModelProps extends IModelNameArg {\r\n  readonly description?: string;\r\n  readonly version0?: LocalFileName;\r\n  readonly noLocks?: true;\r\n}\r\n\r\n/**\r\n * Methods for accessing services of IModelHub from an iTwin.js backend.\r\n * Generally direct access to these methods should not be required, since higher-level apis are provided.\r\n * @beta\r\n */\r\nexport interface BackendHubAccess {\r\n  /** Download all the changesets in the specified range. */\r\n  downloadChangesets: (arg: DownloadChangesetRangeArg) => Promise<ChangesetFileProps[]>;\r\n  /** Download a single changeset. */\r\n  downloadChangeset: (arg: DownloadChangesetArg) => Promise<ChangesetFileProps>;\r\n  /** Query the changeset properties given a ChangesetIndex  */\r\n  queryChangeset: (arg: ChangesetArg) => Promise<ChangesetProps>;\r\n  /** Query an array of changeset properties given a range of ChangesetIndexes  */\r\n  queryChangesets: (arg: ChangesetRangeArg) => Promise<ChangesetProps[]>;\r\n  /** Push a changeset to iModelHub. Returns the newly pushed changeset's index */\r\n  pushChangeset: (arg: IModelIdArg & { changesetProps: ChangesetFileProps }) => Promise<ChangesetIndex>;\r\n  /** Get the ChangesetProps of the most recent changeset */\r\n  getLatestChangeset: (arg: IModelIdArg) => Promise<ChangesetProps>;\r\n  /** Get the ChangesetProps for an IModelVersion */\r\n  getChangesetFromVersion: (arg: IModelIdArg & { version: IModelVersion }) => Promise<ChangesetProps>;\r\n  /** Get the ChangesetProps for a named version */\r\n  getChangesetFromNamedVersion: (arg: IModelIdArg & { versionName: string }) => Promise<ChangesetProps>;\r\n\r\n  /** Acquire a new briefcaseId for the supplied iModelId\r\n     * @note usually there should only be one briefcase per iModel per user.\r\n     */\r\n  acquireNewBriefcaseId: (arg: AcquireNewBriefcaseIdArg) => Promise<BriefcaseId>;\r\n  /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */\r\n  releaseBriefcase: (arg: BriefcaseIdArg) => Promise<void>;\r\n\r\n  /** get an array of the briefcases assigned to a user. */\r\n  getMyBriefcaseIds: (arg: IModelIdArg) => Promise<BriefcaseId[]>;\r\n\r\n  /**\r\n   * Download a v1 checkpoint\r\n   * @deprecated in 3.x. V1 checkpoints are deprecated. Download V2 checkpoint using [[V2CheckpointManager.downloadCheckpoint]].\r\n   * @internal\r\n   */\r\n  downloadV1Checkpoint: (arg: CheckpointArg) => Promise<ChangesetIndexAndId>; // eslint-disable-line deprecation/deprecation\r\n\r\n  /**\r\n   * Get the access props for a V2 checkpoint. Returns undefined if no V2 checkpoint exists.\r\n   * @internal\r\n   */\r\n  queryV2Checkpoint: (arg: CheckpointProps) => Promise<V2CheckpointAccessProps | undefined>;\r\n\r\n  /**\r\n   * acquire one or more locks. Throws if unsuccessful. If *any* lock cannot be obtained, no locks are acquired\r\n   * @internal\r\n   */\r\n  acquireLocks: (arg: BriefcaseDbArg, locks: LockMap) => Promise<void>;\r\n\r\n  /**\r\n   * Get the list of all held locks for a briefcase. This can be very expensive and is currently used only for tests.\r\n   * @internal\r\n   */\r\n  queryAllLocks: (arg: BriefcaseDbArg) => Promise<LockProps[]>;\r\n\r\n  /**\r\n   * Release all currently held locks\r\n   * @internal\r\n   */\r\n  releaseAllLocks: (arg: BriefcaseDbArg) => Promise<void>;\r\n\r\n  /** Get the iModelId of an iModel by name. Undefined if no iModel with that name exists.  */\r\n  queryIModelByName: (arg: IModelNameArg) => Promise<GuidString | undefined>;\r\n\r\n  /** create a new iModel. Returns the Guid of the newly created iModel */\r\n  createNewIModel: (arg: CreateNewIModelProps) => Promise<GuidString>;\r\n\r\n  /** delete an iModel */\r\n  deleteIModel: (arg: IModelIdArg & ITwinIdArg) => Promise<void>;\r\n}\r\n"]}