@itwin/core-backend 5.0.0-dev.9 → 5.0.0-dev.92

package/CHANGELOG.md

@@ -1,6 +1,65 @@
 # Change Log - @itwin/core-backend
 
-This log was last generated on Thu, 14 Nov 2024 18:13:56 GMT and should not be manually modified.
+This log was last generated on Wed, 19 Mar 2025 15:33:24 GMT and should not be manually modified.
+
+## 4.10.11
+Wed, 19 Mar 2025 15:30:39 GMT
+
+### Updates
+
+- new test for 3d linestyle part export
+
+## 4.10.10
+Tue, 11 Mar 2025 15:25:11 GMT
+
+### Updates
+
+- Resolves CVE-2025-27152
+
+## 4.10.9
+Tue, 11 Mar 2025 05:17:33 GMT
+
+_Version update only_
+
+## 4.10.8
+Thu, 06 Mar 2025 14:13:37 GMT
+
+_Version update only_
+
+## 4.10.7
+Tue, 18 Feb 2025 17:27:03 GMT
+
+### Updates
+
+- Fix issue with concurrent query where it interrupt statement during prepare
+
+## 4.10.6
+Fri, 24 Jan 2025 08:02:40 GMT
+
+_Version update only_
+
+## 4.10.5
+Tue, 21 Jan 2025 21:56:45 GMT
+
+_Version update only_
+
+## 4.10.4
+Mon, 13 Jan 2025 14:06:43 GMT
+
+_Version update only_
+
+## 4.10.3
+Mon, 06 Jan 2025 14:00:13 GMT
+
+_Version update only_
+
+## 4.10.2
+Thu, 21 Nov 2024 15:22:20 GMT
+
+### Updates
+
+- Add test for BE_SQLITE_CONSTRAINT_UNIQUE
+- Fix CloudSqlite.DbAccess.createBlobContainer always overwriting containerType with "property-store".
 
 ## 4.10.1
 Thu, 14 Nov 2024 18:11:00 GMT

package/lib/cjs/BackendHubAccess.d.ts

@@ -35,7 +35,7 @@ export declare enum LockState {
 }
 /**
  * The properties to access a V2 checkpoint through a daemon.
- * @internal
+ * @public
  */
 export interface V2CheckpointAccessProps {
     /** blob store account name. */
@@ -49,11 +49,14 @@ export interface V2CheckpointAccessProps {
     /** blob storage module: e.g. "azure", "google", "aws". May also include URI style parameters. */
     readonly storageType: string;
 }
-/** @internal */
+/**
+ * Maps element Ids to their corresponding [LockState]($common)s.
+ * @public
+ */
 export type LockMap = Map<Id64String, CommonLockState>;
 /**
  * The properties of a lock that may be obtained from a lock server.
- * @beta
+ * @public
  */
 export interface LockProps {
     /** The elementId for the lock */
@@ -63,7 +66,7 @@ export interface LockProps {
 }
 /**
  * Argument for cancelling and tracking download progress.
- * @beta
+ * @public
  */
 export interface DownloadProgressArg {
     /** Called to show progress during a download. If this function returns non-zero, the download is aborted. */
@@ -116,7 +119,7 @@ export interface ChangesetArg extends IModelIdArg {
     readonly changeset: ChangesetIndexOrId;
 }
 /** Argument for downloading a changeset.
- * @beta
+ * @public
  */
 export interface DownloadChangesetArg extends ChangesetArg, DownloadProgressArg {
     /** Directory where the changeset should be downloaded. */
@@ -134,17 +137,12 @@ export interface ChangesetRangeArg extends IModelIdArg {
     readonly range?: ChangesetRange;
 }
 /** Argument for downloading a changeset range.
- * @beta
+ * @public
  */
 export interface DownloadChangesetRangeArg extends ChangesetRangeArg, DownloadProgressArg {
     /** Directory where the changesets should be downloaded. */
     targetDir: LocalDirName;
 }
-/**
- * @deprecated in 3.x. Use [[DownloadRequest]].
- * @internal
- */
-export type CheckpointArg = DownloadRequest;
 /**
  * Arguments to create a new iModel in iModelHub
  *  @public
@@ -157,9 +155,7 @@ export interface CreateNewIModelProps extends IModelNameArg {
 /**
  * Methods for accessing services of IModelHub from an iTwin.js backend.
  * Generally direct access to these methods should not be required, since higher-level apis are provided.
- * @note This interface is implemented in another repository. Any changes made to this interface must be validated against
- * the implementation found here: https://github.com/iTwin/imodels-clients/blob/main/itwin-platform-access/imodels-access-backend/src/BackendIModelsAccess.ts
- * @internal
+ * @public
  */
 export interface BackendHubAccess {
     /** Download all the changesets in the specified range. */
@@ -197,27 +193,17 @@ export interface BackendHubAccess {
      * @deprecated in 3.x. V1 checkpoints are deprecated. Download V2 checkpoint using [[V2CheckpointManager.downloadCheckpoint]].
      * @internal
      */
-    downloadV1Checkpoint: (arg: CheckpointArg) => Promise<ChangesetIndexAndId>;
-    /**
-     * Get the access props for a V2 checkpoint. Returns undefined if no V2 checkpoint exists.
-     * @internal
-     */
+    downloadV1Checkpoint: (arg: DownloadRequest) => Promise<ChangesetIndexAndId>;
+    /** Get the access props for a V2 checkpoint. Returns undefined if no V2 checkpoint exists. */
     queryV2Checkpoint: (arg: CheckpointProps) => Promise<V2CheckpointAccessProps | undefined>;
     /**
      * acquire one or more locks. Throws if unsuccessful. If *any* lock cannot be obtained, no locks are acquired
-     * @internal
      * @throws ConflictingLocksError if one or more requested locks are held by other briefcases.
      */
     acquireLocks: (arg: BriefcaseDbArg, locks: LockMap) => Promise<void>;
-    /**
-     * Get the list of all held locks for a briefcase. This can be very expensive and is currently used only for tests.
-     * @internal
-     */
+    /** Get the list of all held locks for a briefcase. This can be very expensive and is currently used only for tests. */
     queryAllLocks: (arg: BriefcaseDbArg) => Promise<LockProps[]>;
-    /**
-     * Release all currently held locks
-     * @internal
-     */
+    /** Release all currently held locks */
     releaseAllLocks: (arg: BriefcaseDbArg) => Promise<void>;
     /** Get the iModelId of an iModel by name. Undefined if no iModel with that name exists.  */
     queryIModelByName: (arg: IModelNameArg) => Promise<GuidString | undefined>;

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

@@ -1 +1 @@
-{"version":3,"file":"BackendHubAccess.d.ts","sourceRoot":"","sources":["../../src/BackendHubAccess.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAmB,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EACL,WAAW,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,cAAc,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,cAAc,EAAE,cAAc,EAC9I,SAAS,IAAI,eAAe,EAAE,WAAW,EAAE,aAAa,EACxD,YAAY,EAAE,aAAa,EAC5B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACzF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;EAEE;AACF,qBAAa,YAAa,SAAQ,WAAW;IAEzC,mCAAmC;aACnB,WAAW,EAAE,WAAW;IACxC,sCAAsC;aACtB,cAAc,EAAE,MAAM;;IAHtC,mCAAmC;IACnB,WAAW,EAAE,WAAW;IACxC,sCAAsC;IACtB,cAAc,EAAE,MAAM,EACtC,GAAG,EAAE,qBAAqB,GAAG,gCAAgC;CAIhE;AAED;;;GAGG;AACH,oBAAY,SAAS;IACnB,gCAAgC;IAChC,IAAI,IAAI;IACR,mJAAmJ;IACnJ,MAAM,IAAI;IACV;;OAEG;IACH,SAAS,IAAI;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,+BAA+B;IAC/B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B,6EAA6E;IAC7E,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,iFAAiF;IACjF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,iGAAiG;IACjG,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED,gBAAgB;AAChB,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC;IACxB,qBAAqB;IACrB,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,6GAA6G;IAC7G,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,QAAQ;IAC3C,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,WAAW;IAC3D,kIAAkI;IAClI,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ,EAAE,UAAU;IACzD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,YAAY,EAAE,mBAAmB;IAC7E,0DAA0D;IAC1D,SAAS,EAAE,YAAY,CAAC;CACzB;AAED,gBAAgB;AAChB,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,uFAAuF;IACvF,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB,EAAE,mBAAmB;IACvF,2DAA2D;IAC3D,SAAS,EAAE,YAAY,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,eAAe,CAAC;AAE5C;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC;CACzB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B,0DAA0D;IAC1D,kBAAkB,EAAE,CAAC,GAAG,EAAE,yBAAyB,KAAK,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACtF,mCAAmC;IACnC,iBAAiB,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC9E,6DAA6D;IAC7D,cAAc,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAC/D,gFAAgF;IAChF,eAAe,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACvE,gFAAgF;IAChF,aAAa,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,cAAc,EAAE,kBAAkB,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACtG,0DAA0D;IAC1D,kBAAkB,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAClE,kDAAkD;IAClD,uBAAuB,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,OAAO,EAAE,aAAa,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACpG,iDAAiD;IACjD,4BAA4B,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAEtG;;SAEK;IACL,qBAAqB,EAAE,CAAC,GAAG,EAAE,wBAAwB,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/E,gHAAgH;IAChH,gBAAgB,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD,yDAAyD;IACzD,iBAAiB,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAEhE;;;;OAIG;IACH,oBAAoB,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAE3E;;;OAGG;IACH,iBAAiB,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC,CAAC;IAE1F;;;;OAIG;IACH,YAAY,EAAE,CAAC,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE;;;OAGG;IACH,aAAa,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAE7D;;;OAGG;IACH,eAAe,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD,4FAA4F;IAC5F,iBAAiB,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAE3E,wEAAwE;IACxE,eAAe,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;IAEpE,uBAAuB;IACvB,YAAY,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAChE"}
+{"version":3,"file":"BackendHubAccess.d.ts","sourceRoot":"","sources":["../../src/BackendHubAccess.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAmB,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EACL,WAAW,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,cAAc,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,cAAc,EAAE,cAAc,EAC9I,SAAS,IAAI,eAAe,EAAE,WAAW,EAAE,aAAa,EACxD,YAAY,EAAE,aAAa,EAC5B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACzF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;EAEE;AACF,qBAAa,YAAa,SAAQ,WAAW;IAEzC,mCAAmC;aACnB,WAAW,EAAE,WAAW;IACxC,sCAAsC;aACtB,cAAc,EAAE,MAAM;;IAHtC,mCAAmC;IACnB,WAAW,EAAE,WAAW;IACxC,sCAAsC;IACtB,cAAc,EAAE,MAAM,EACtC,GAAG,EAAE,qBAAqB,GAAG,gCAAgC;CAIhE;AAED;;;GAGG;AACH,oBAAY,SAAS;IACnB,gCAAgC;IAChC,IAAI,IAAI;IACR,mJAAmJ;IACnJ,MAAM,IAAI;IACV;;OAEG;IACH,SAAS,IAAI;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,+BAA+B;IAC/B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B,6EAA6E;IAC7E,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,iFAAiF;IACjF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,iGAAiG;IACjG,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC;IACxB,qBAAqB;IACrB,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,6GAA6G;IAC7G,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,QAAQ;IAC3C,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,WAAW;IAC3D,kIAAkI;IAClI,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ,EAAE,UAAU;IACzD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,YAAY,EAAE,mBAAmB;IAC7E,0DAA0D;IAC1D,SAAS,EAAE,YAAY,CAAC;CACzB;AAED,gBAAgB;AAChB,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,uFAAuF;IACvF,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB,EAAE,mBAAmB;IACvF,2DAA2D;IAC3D,SAAS,EAAE,YAAY,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,0DAA0D;IAC1D,kBAAkB,EAAE,CAAC,GAAG,EAAE,yBAAyB,KAAK,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACtF,mCAAmC;IACnC,iBAAiB,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC9E,6DAA6D;IAC7D,cAAc,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAC/D,gFAAgF;IAChF,eAAe,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACvE,gFAAgF;IAChF,aAAa,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,cAAc,EAAE,kBAAkB,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACtG,0DAA0D;IAC1D,kBAAkB,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAClE,kDAAkD;IAClD,uBAAuB,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,OAAO,EAAE,aAAa,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACpG,iDAAiD;IACjD,4BAA4B,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAEtG;;SAEK;IACL,qBAAqB,EAAE,CAAC,GAAG,EAAE,wBAAwB,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/E,gHAAgH;IAChH,gBAAgB,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD,yDAAyD;IACzD,iBAAiB,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAEhE;;;;OAIG;IACH,oBAAoB,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAE7E,8FAA8F;IAC9F,iBAAiB,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC,CAAC;IAE1F;;;OAGG;IACH,YAAY,EAAE,CAAC,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE,uHAAuH;IACvH,aAAa,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAE7D,uCAAuC;IACvC,eAAe,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD,4FAA4F;IAC5F,iBAAiB,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAE3E,wEAAwE;IACxE,eAAe,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;IAEpE,uBAAuB;IACvB,YAAY,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAChE"}

package/lib/cjs/BackendHubAccess.js

@@ -14,6 +14,8 @@ const core_common_1 = require("@itwin/core-common");
  * @beta
 */
 class LockConflict extends core_common_1.IModelError {
+    briefcaseId;
+    briefcaseAlias;
     constructor(
     /** Id of Briefcase holding lock */
     briefcaseId, 

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,oDAI4B;AAI5B;;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;AAED;;;GAGG;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,yBAAT,SAAS,QASpB","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  LockState as CommonLockState, IModelError, IModelVersion,\r\n  LocalDirName, LocalFileName,\r\n} from \"@itwin/core-common\";\r\nimport { CheckpointProps, DownloadRequest, ProgressFunction } from \"./CheckpointManager\";\r\nimport type { TokenArg } from \"./IModelDb\";\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/** The state of a lock. See [Acquiring locks on elements.]($docs/learning/backend/ConcurrencyControl.md#acquiring-locks-on-elements).\r\n * @deprecated in 4.7 Use [LockState]($common)\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/**\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, CommonLockState>;\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: CommonLockState;\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 * @note This interface is implemented in another repository. Any changes made to this interface must be validated against\r\n * the implementation found here: https://github.com/iTwin/imodels-clients/blob/main/itwin-platform-access/imodels-access-backend/src/BackendIModelsAccess.ts\r\n * @internal\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 @typescript-eslint/no-deprecated\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   * @throws ConflictingLocksError if one or more requested locks are held by other briefcases.\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,oDAI4B;AAI5B;;EAEE;AACF,MAAa,YAAa,SAAQ,yBAAW;IAGzB;IAEA;IAJlB;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;AAED;;;GAGG;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,yBAAT,SAAS,QASpB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module HubAccess\n */\n\nimport { AccessToken, GuidString, Id64String, IModelHubStatus } from \"@itwin/core-bentley\";\nimport {\n  BriefcaseId, ChangesetFileProps, ChangesetIdWithIndex, ChangesetIndex, ChangesetIndexAndId, ChangesetIndexOrId, ChangesetProps, ChangesetRange,\n  LockState as CommonLockState, IModelError, IModelVersion,\n  LocalDirName, LocalFileName,\n} from \"@itwin/core-common\";\nimport { CheckpointProps, DownloadRequest, ProgressFunction } from \"./CheckpointManager\";\nimport type { TokenArg } from \"./IModelDb\";\n\n/** Exception thrown if lock cannot be acquired.\n * @beta\n*/\nexport class LockConflict extends IModelError {\n  public constructor(\n    /** Id of Briefcase holding lock */\n    public readonly briefcaseId: BriefcaseId,\n    /** Alias of Briefcase holding lock */\n    public readonly briefcaseAlias: string,\n    msg: \"shared lock is held\" | \"exclusive lock is already held\",\n  ) {\n    super(IModelHubStatus.LockOwnedByAnotherBriefcase, msg);\n  }\n}\n\n/** The state of a lock. See [Acquiring locks on elements.]($docs/learning/backend/ConcurrencyControl.md#acquiring-locks-on-elements).\n * @deprecated in 4.7 Use [LockState]($common)\n * @public\n */\nexport enum LockState {\n  /** The element is not locked */\n  None = 0,\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. */\n  Shared = 1,\n  /** A Lock that permits modifications to an element and blocks other users from making modifications to it.\n   * Holding an exclusive lock on an \"owner\" (a model or a parent element), implicitly exclusively locks all its members.\n   */\n  Exclusive = 2,\n}\n\n/**\n * The properties to access a V2 checkpoint through a daemon.\n * @public\n */\nexport interface V2CheckpointAccessProps {\n  /** blob store account name. */\n  readonly accountName: string;\n  /** AccessToken that grants access to the container. */\n  readonly sasToken: AccessToken;\n  /** The name of the iModel's blob store container holding all checkpoints. */\n  readonly containerId: string;\n  /** The name of the virtual file within the container, used for the checkpoint */\n  readonly dbName: string;\n  /** blob storage module: e.g. \"azure\", \"google\", \"aws\". May also include URI style parameters. */\n  readonly storageType: string;\n}\n\n/**\n * Maps element Ids to their corresponding [LockState]($common)s.\n * @public\n */\nexport type LockMap = Map<Id64String, CommonLockState>;\n\n/**\n * The properties of a lock that may be obtained from a lock server.\n * @public\n */\nexport interface LockProps {\n  /** The elementId for the lock */\n  readonly id: Id64String;\n  /** the lock state */\n  readonly state: CommonLockState;\n}\n\n/**\n * Argument for cancelling and tracking download progress.\n * @public\n */\nexport interface DownloadProgressArg {\n  /** Called to show progress during a download. If this function returns non-zero, the download is aborted. */\n  progressCallback?: ProgressFunction;\n}\n\n/**\n * Argument for methods that must supply an iTwinId\n * @public\n */\nexport interface ITwinIdArg {\n  readonly iTwinId: GuidString;\n}\n\n/**\n * Argument for methods that must supply an IModelId\n * @public\n */\nexport interface IModelIdArg extends TokenArg {\n  readonly iModelId: GuidString;\n}\n\n/**\n * Argument for acquiring a new BriefcaseId\n * @public\n */\nexport interface AcquireNewBriefcaseIdArg extends IModelIdArg {\n  /** A string to be reported to other users to identify this briefcase, for example in the case of conflicts or lock collisions. */\n  readonly briefcaseAlias?: string;\n}\n\n/** Argument for methods that must supply an IModel name and iTwinId\n * @public\n */\nexport interface IModelNameArg extends TokenArg, ITwinIdArg {\n  readonly iModelName: string;\n}\n\n/** Argument for methods that must supply an IModelId and a BriefcaseId\n * @public\n */\nexport interface BriefcaseIdArg extends IModelIdArg {\n  readonly briefcaseId: BriefcaseId;\n}\n\n/** Argument for methods that must supply a briefcaseId and a changeset\n * @public\n */\nexport interface BriefcaseDbArg extends BriefcaseIdArg {\n  readonly changeset: ChangesetIdWithIndex;\n}\n\n/** Argument for methods that must supply an IModelId and a changeset\n * @public\n */\nexport interface ChangesetArg extends IModelIdArg {\n  readonly changeset: ChangesetIndexOrId;\n}\n\n/** Argument for downloading a changeset.\n * @public\n */\nexport interface DownloadChangesetArg extends ChangesetArg, DownloadProgressArg {\n  /** Directory where the changeset should be downloaded. */\n  targetDir: LocalDirName;\n}\n\n/** @internal */\nexport interface ChangesetIndexArg extends IModelIdArg {\n  readonly changeset: ChangesetIdWithIndex;\n}\n\n/** Argument for methods that must supply an IModelId and a range of Changesets.\n * @public\n */\nexport interface ChangesetRangeArg extends IModelIdArg {\n  /** the range of changesets desired. If is undefined, *all* changesets are returned. */\n  readonly range?: ChangesetRange;\n}\n\n/** Argument for downloading a changeset range.\n * @public\n */\nexport interface DownloadChangesetRangeArg extends ChangesetRangeArg, DownloadProgressArg {\n  /** Directory where the changesets should be downloaded. */\n  targetDir: LocalDirName;\n}\n\n/**\n * Arguments to create a new iModel in iModelHub\n *  @public\n */\nexport interface CreateNewIModelProps extends IModelNameArg {\n  readonly description?: string;\n  readonly version0?: LocalFileName;\n  readonly noLocks?: true;\n}\n\n/**\n * Methods for accessing services of IModelHub from an iTwin.js backend.\n * Generally direct access to these methods should not be required, since higher-level apis are provided.\n * @public\n */\nexport interface BackendHubAccess {\n  /** Download all the changesets in the specified range. */\n  downloadChangesets: (arg: DownloadChangesetRangeArg) => Promise<ChangesetFileProps[]>;\n  /** Download a single changeset. */\n  downloadChangeset: (arg: DownloadChangesetArg) => Promise<ChangesetFileProps>;\n  /** Query the changeset properties given a ChangesetIndex  */\n  queryChangeset: (arg: ChangesetArg) => Promise<ChangesetProps>;\n  /** Query an array of changeset properties given a range of ChangesetIndexes  */\n  queryChangesets: (arg: ChangesetRangeArg) => Promise<ChangesetProps[]>;\n  /** Push a changeset to iModelHub. Returns the newly pushed changeset's index */\n  pushChangeset: (arg: IModelIdArg & { changesetProps: ChangesetFileProps }) => Promise<ChangesetIndex>;\n  /** Get the ChangesetProps of the most recent changeset */\n  getLatestChangeset: (arg: IModelIdArg) => Promise<ChangesetProps>;\n  /** Get the ChangesetProps for an IModelVersion */\n  getChangesetFromVersion: (arg: IModelIdArg & { version: IModelVersion }) => Promise<ChangesetProps>;\n  /** Get the ChangesetProps for a named version */\n  getChangesetFromNamedVersion: (arg: IModelIdArg & { versionName: string }) => Promise<ChangesetProps>;\n\n  /** Acquire a new briefcaseId for the supplied iModelId\n     * @note usually there should only be one briefcase per iModel per user.\n     */\n  acquireNewBriefcaseId: (arg: AcquireNewBriefcaseIdArg) => Promise<BriefcaseId>;\n  /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */\n  releaseBriefcase: (arg: BriefcaseIdArg) => Promise<void>;\n\n  /** get an array of the briefcases assigned to a user. */\n  getMyBriefcaseIds: (arg: IModelIdArg) => Promise<BriefcaseId[]>;\n\n  /**\n   * Download a v1 checkpoint\n   * @deprecated in 3.x. V1 checkpoints are deprecated. Download V2 checkpoint using [[V2CheckpointManager.downloadCheckpoint]].\n   * @internal\n   */\n  downloadV1Checkpoint: (arg: DownloadRequest) => Promise<ChangesetIndexAndId>;\n\n  /** Get the access props for a V2 checkpoint. Returns undefined if no V2 checkpoint exists. */\n  queryV2Checkpoint: (arg: CheckpointProps) => Promise<V2CheckpointAccessProps | undefined>;\n\n  /**\n   * acquire one or more locks. Throws if unsuccessful. If *any* lock cannot be obtained, no locks are acquired\n   * @throws ConflictingLocksError if one or more requested locks are held by other briefcases.\n   */\n  acquireLocks: (arg: BriefcaseDbArg, locks: LockMap) => Promise<void>;\n\n  /** Get the list of all held locks for a briefcase. This can be very expensive and is currently used only for tests. */\n  queryAllLocks: (arg: BriefcaseDbArg) => Promise<LockProps[]>;\n\n  /** Release all currently held locks */\n  releaseAllLocks: (arg: BriefcaseDbArg) => Promise<void>;\n\n  /** Get the iModelId of an iModel by name. Undefined if no iModel with that name exists.  */\n  queryIModelByName: (arg: IModelNameArg) => Promise<GuidString | undefined>;\n\n  /** create a new iModel. Returns the Guid of the newly created iModel */\n  createNewIModel: (arg: CreateNewIModelProps) => Promise<GuidString>;\n\n  /** delete an iModel */\n  deleteIModel: (arg: IModelIdArg & ITwinIdArg) => Promise<void>;\n}\n"]}

package/lib/cjs/BackendLoggerCategory.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackendLoggerCategory.js","sourceRoot":"","sources":["../../src/BackendLoggerCategory.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;;;GAIG;AACH,IAAY,qBA+FX;AA/FD,WAAY,qBAAqB;IAC/B,+DAA+D;IAC/D,qEAA4C,CAAA;IAE5C;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;OAEG;IACH,2FAAkE,CAAA;IAElE;;OAEG;IACH,2DAAkC,CAAA;IAElC;;;;OAIG;IACH,mDAA0B,CAAA;IAE1B;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,6EAAoD,CAAA;IAEpD;;;OAGG;IACH,2DAAkC,CAAA;IAElC;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,mFAA0D,CAAA;IAE1D;;OAEG;IACH,2EAAkD,CAAA;IAElD;;OAEG;IACH,6EAAoD,CAAA;IAEpD;;OAEG;IACH,mEAA0C,CAAA;IAE1C;;OAEG;IACH,yDAAgC,CAAA;IAEhC;;OAEG;IACH,yEAAgD,CAAA;IAChD;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;;OAGG;IACH,6DAAoC,CAAA;IAEpC;;;OAGG;IACH,6EAAoD,CAAA;IAEpD,gBAAgB;IAChB,6DAAoC,CAAA;AACtC,CAAC,EA/FW,qBAAqB,qCAArB,qBAAqB,QA+FhC","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 Logging\r\n */\r\n\r\n/** Logger categories used by this package\r\n * @note All logger categories in this package start with the `core-backend` prefix.\r\n * @see [Logger]($bentley)\r\n * @public\r\n */\r\nexport enum BackendLoggerCategory {\r\n  /** The logger category used by API related to authorization */\r\n  Authorization = \"core-backend.Authorization\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[CodeSpecs]]\r\n   */\r\n  CodeSpecs = \"core-backend.CodeSpecs\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[CustomViewState3dCreator]]\r\n   */\r\n  CustomViewState3dCreator = \"core-backend.CustomViewState3dCreator\",\r\n\r\n  /** The logger category used by the [[DevTools]] class and related classes.\r\n   * @internal\r\n   */\r\n  DevTools = \"core-backend.DevTools\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[ChangeSummaryManager]]\r\n   * - [[ECDb]]\r\n   * - [[ECSqlStatement]]\r\n   */\r\n  ECDb = \"core-backend.ECDb\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Functional]]\r\n   */\r\n  Functional = \"core-backend.Functional\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[LinearReferencing]]\r\n   */\r\n  LinearReferencing = \"core-backend.LinearReferencing\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - BriefcaseManager\r\n   * - [[IModelDb]]\r\n   */\r\n  IModelDb = \"core-backend.IModelDb\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[IModelHost]]\r\n   */\r\n  IModelHost = \"core-backend.IModelHost\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - TileRequestMemoizer\r\n   */\r\n  IModelTileRequestRpc = \"core-backend.IModelTileRequestRpc\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - IModelTileRpcImpl (Tile Uploading)\r\n   */\r\n  IModelTileUpload = \"core-backend.IModelTileUpload\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - TileStorage (tile upload/download)\r\n   */\r\n  IModelTileStorage = \"core-backend.IModelTileStorage\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Relationship]]\r\n   */\r\n  Relationship = \"core-backend.Relationship\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Schemas]]\r\n   */\r\n  Schemas = \"core-backend.Schemas\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[PromiseMemoizer]]\r\n   */\r\n  PromiseMemoizer = \"core-backend.PromiseMemoizer\",\r\n  /** The logger category used by the following classes:\r\n   * - [[EventSink]]\r\n   */\r\n  EventSink = \"core-backend.EventSink\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[NativeHost]], [[NativeAppStorage]]\r\n   * @internal\r\n   */\r\n  NativeApp = \"core-backend.NativeApp\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[ViewStateHydrator]]\r\n   * @internal\r\n   */\r\n  ViewStateHydrator = \"core-backend.ViewStateHydrator\",\r\n\r\n  /** @internal */\r\n  Workspace = \"core-backend.Workspace\",\r\n}\r\n"]}
+{"version":3,"file":"BackendLoggerCategory.js","sourceRoot":"","sources":["../../src/BackendLoggerCategory.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;;;GAIG;AACH,IAAY,qBA+FX;AA/FD,WAAY,qBAAqB;IAC/B,+DAA+D;IAC/D,qEAA4C,CAAA;IAE5C;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;OAEG;IACH,2FAAkE,CAAA;IAElE;;OAEG;IACH,2DAAkC,CAAA;IAElC;;;;OAIG;IACH,mDAA0B,CAAA;IAE1B;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,6EAAoD,CAAA;IAEpD;;;OAGG;IACH,2DAAkC,CAAA;IAElC;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,mFAA0D,CAAA;IAE1D;;OAEG;IACH,2EAAkD,CAAA;IAElD;;OAEG;IACH,6EAAoD,CAAA;IAEpD;;OAEG;IACH,mEAA0C,CAAA;IAE1C;;OAEG;IACH,yDAAgC,CAAA;IAEhC;;OAEG;IACH,yEAAgD,CAAA;IAChD;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;;OAGG;IACH,6DAAoC,CAAA;IAEpC;;;OAGG;IACH,6EAAoD,CAAA;IAEpD,gBAAgB;IAChB,6DAAoC,CAAA;AACtC,CAAC,EA/FW,qBAAqB,qCAArB,qBAAqB,QA+FhC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Logging\n */\n\n/** Logger categories used by this package\n * @note All logger categories in this package start with the `core-backend` prefix.\n * @see [Logger]($bentley)\n * @public\n */\nexport enum BackendLoggerCategory {\n  /** The logger category used by API related to authorization */\n  Authorization = \"core-backend.Authorization\",\n\n  /** The logger category used by the following classes:\n   * - [[CodeSpecs]]\n   */\n  CodeSpecs = \"core-backend.CodeSpecs\",\n\n  /** The logger category used by the following classes:\n   * - [[CustomViewState3dCreator]]\n   */\n  CustomViewState3dCreator = \"core-backend.CustomViewState3dCreator\",\n\n  /** The logger category used by the [[DevTools]] class and related classes.\n   * @internal\n   */\n  DevTools = \"core-backend.DevTools\",\n\n  /** The logger category used by the following classes:\n   * - [[ChangeSummaryManager]]\n   * - [[ECDb]]\n   * - [[ECSqlStatement]]\n   */\n  ECDb = \"core-backend.ECDb\",\n\n  /** The logger category used by the following classes:\n   * - [[Functional]]\n   */\n  Functional = \"core-backend.Functional\",\n\n  /** The logger category used by the following classes:\n   * - [[LinearReferencing]]\n   */\n  LinearReferencing = \"core-backend.LinearReferencing\",\n\n  /** The logger category used by the following classes:\n   * - BriefcaseManager\n   * - [[IModelDb]]\n   */\n  IModelDb = \"core-backend.IModelDb\",\n\n  /** The logger category used by the following classes:\n   * - [[IModelHost]]\n   */\n  IModelHost = \"core-backend.IModelHost\",\n\n  /** The logger category used by the following classes:\n   * - TileRequestMemoizer\n   */\n  IModelTileRequestRpc = \"core-backend.IModelTileRequestRpc\",\n\n  /** The logger category used by the following classes:\n   * - IModelTileRpcImpl (Tile Uploading)\n   */\n  IModelTileUpload = \"core-backend.IModelTileUpload\",\n\n  /** The logger category used by the following classes:\n   * - TileStorage (tile upload/download)\n   */\n  IModelTileStorage = \"core-backend.IModelTileStorage\",\n\n  /** The logger category used by the following classes:\n   * - [[Relationship]]\n   */\n  Relationship = \"core-backend.Relationship\",\n\n  /** The logger category used by the following classes:\n   * - [[Schemas]]\n   */\n  Schemas = \"core-backend.Schemas\",\n\n  /** The logger category used by the following classes:\n   * - [[PromiseMemoizer]]\n   */\n  PromiseMemoizer = \"core-backend.PromiseMemoizer\",\n  /** The logger category used by the following classes:\n   * - [[EventSink]]\n   */\n  EventSink = \"core-backend.EventSink\",\n\n  /** The logger category used by the following classes:\n   * - [[NativeHost]], [[NativeAppStorage]]\n   * @internal\n   */\n  NativeApp = \"core-backend.NativeApp\",\n\n  /** The logger category used by the following classes:\n   * - [[ViewStateHydrator]]\n   * @internal\n   */\n  ViewStateHydrator = \"core-backend.ViewStateHydrator\",\n\n  /** @internal */\n  Workspace = \"core-backend.Workspace\",\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"BisCoreSchema.d.ts","sourceRoot":"","sources":["../../src/BisCoreSchema.ts"],"names":[],"mappings":"AAIA;;GAEG;AAYH,OAAO,EAAE,MAAM,EAAW,MAAM,UAAU,CAAC;AAM3C;;;;;;;;;;GAUG;AACH,qBAAa,aAAc,SAAQ,MAAM;IACvC,WAA2B,UAAU,IAAI,MAAM,CAAsB;IACrE,WAAkB,cAAc,IAAI,MAAM,CAAsH;IAEhK,gBAAgB;WACF,cAAc;CAsB7B"}
+{"version":3,"file":"BisCoreSchema.d.ts","sourceRoot":"","sources":["../../src/BisCoreSchema.ts"],"names":[],"mappings":"AAIA;;GAEG;AAYH,OAAO,EAAE,MAAM,EAAW,MAAM,UAAU,CAAC;AAO3C;;;;;;;;;;GAUG;AACH,qBAAa,aAAc,SAAQ,MAAM;IACvC,WAA2B,UAAU,IAAI,MAAM,CAAsB;IACrE,WAAkB,cAAc,IAAI,MAAM,CAAsH;IAEhK,gBAAgB;WACF,cAAc;CAuB7B"}

package/lib/cjs/BisCoreSchema.js

@@ -23,6 +23,7 @@ const textureMod = require("./Texture");
 const viewMod = require("./ViewDefinition");
 const displayStyleMod = require("./DisplayStyle");
 const annotationsMod = require("./TextAnnotationElement");
+const sheetIndex = require("./SheetIndex");
 /**
  * The [BisCore]($docs/bis/guide/fundamentals/schemas-domains.md) schema is the lowest level Schema in an iModel.
  *
@@ -56,6 +57,7 @@ class BisCoreSchema extends Schema_1.Schema {
             externalSourceMod,
             displayStyleMod,
             annotationsMod,
+            sheetIndex
         ].forEach((module) => ClassRegistry_1.ClassRegistry.registerModule(module, this));
     }
 }

package/lib/cjs/BisCoreSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"BisCoreSchema.js","sourceRoot":"","sources":["../../src/BisCoreSchema.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,6BAA6B;AAC7B,0CAA0C;AAC1C,mDAAgD;AAChD,wCAAwC;AACxC,6CAA6C;AAC7C,sDAAsD;AACtD,6CAA8C;AAC9C,0CAA0C;AAC1C,oCAAoC;AACpC,0CAA0C;AAC1C,qCAA2C;AAC3C,wCAAwC;AACxC,4CAA4C;AAC5C,kDAAkD;AAClD,0DAA0D;AAE1D;;;;;;;;;;GAUG;AACH,MAAa,aAAc,SAAQ,eAAM;IAChC,MAAM,KAAc,UAAU,KAAa,OAAO,SAAS,CAAC,CAAC,CAAC;IAC9D,MAAM,KAAK,cAAc,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,2BAAc,CAAC,eAAe,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,aAAa,CAAC,UAAU,eAAe,CAAC,CAAC,CAAC,CAAC;IAEhK,gBAAgB;IACT,MAAM,CAAC,cAAc;QAC1B,IAAI,IAAI,KAAK,gBAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;YACvD,OAAO;QAET,gBAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1C,gBAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAE7B,sHAAsH;QACtH;YACE,UAAU;YACV,SAAS;YACT,QAAQ;YACR,WAAW;YACX,OAAO;YACP,OAAO;YACP,UAAU;YACV,WAAW;YACX,iBAAiB;YACjB,eAAe;YACf,cAAc;SACf,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,6BAAa,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IACpE,CAAC;CACF;AA3BD,sCA2BC","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 * as path from \"path\";\r\nimport * as categoryMod from \"./Category\";\r\nimport { ClassRegistry } from \"./ClassRegistry\";\r\nimport * as elementMod from \"./Element\";\r\nimport * as aspectMod from \"./ElementAspect\";\r\nimport * as externalSourceMod from \"./ExternalSource\";\r\nimport { KnownLocations } from \"./IModelHost\";\r\nimport * as materialMod from \"./Material\";\r\nimport * as modelMod from \"./Model\";\r\nimport * as linkMod from \"./Relationship\";\r\nimport { Schema, Schemas } from \"./Schema\";\r\nimport * as textureMod from \"./Texture\";\r\nimport * as viewMod from \"./ViewDefinition\";\r\nimport * as displayStyleMod from \"./DisplayStyle\";\r\nimport * as annotationsMod from \"./TextAnnotationElement\";\r\n\r\n/**\r\n * The [BisCore]($docs/bis/guide/fundamentals/schemas-domains.md) schema is the lowest level Schema in an iModel.\r\n *\r\n * It is automatically registered when [[IModelHost.startup]] is called.\r\n *\r\n * Example:\r\n * ``` ts\r\n * [[include:BisCore.registerSchemaAndGetClass]]\r\n * ```\r\n * @public\r\n */\r\nexport class BisCoreSchema extends Schema {\r\n  public static override get schemaName(): string { return \"BisCore\"; }\r\n  public static get schemaFilePath(): string { return path.join(KnownLocations.nativeAssetsDir, \"ECSchemas\", \"Dgn\", `${BisCoreSchema.schemaName}.ecschema.xml`); }\r\n\r\n  /** @internal */\r\n  public static registerSchema() {\r\n    if (this === Schemas.getRegisteredSchema(this.schemaName))\r\n      return;\r\n\r\n    Schemas.unregisterSchema(this.schemaName);\r\n    Schemas.registerSchema(this);\r\n\r\n    // this list should include all backend .ts files with implementations of Entity-based classes. Order does not matter.\r\n    [\r\n      elementMod,\r\n      aspectMod,\r\n      modelMod,\r\n      categoryMod,\r\n      viewMod,\r\n      linkMod,\r\n      textureMod,\r\n      materialMod,\r\n      externalSourceMod,\r\n      displayStyleMod,\r\n      annotationsMod,\r\n    ].forEach((module) => ClassRegistry.registerModule(module, this));\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BisCoreSchema.js","sourceRoot":"","sources":["../../src/BisCoreSchema.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,6BAA6B;AAC7B,0CAA0C;AAC1C,mDAAgD;AAChD,wCAAwC;AACxC,6CAA6C;AAC7C,sDAAsD;AACtD,6CAA8C;AAC9C,0CAA0C;AAC1C,oCAAoC;AACpC,0CAA0C;AAC1C,qCAA2C;AAC3C,wCAAwC;AACxC,4CAA4C;AAC5C,kDAAkD;AAClD,0DAA0D;AAC1D,2CAA2C;AAE3C;;;;;;;;;;GAUG;AACH,MAAa,aAAc,SAAQ,eAAM;IAChC,MAAM,KAAc,UAAU,KAAa,OAAO,SAAS,CAAC,CAAC,CAAC;IAC9D,MAAM,KAAK,cAAc,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,2BAAc,CAAC,eAAe,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,aAAa,CAAC,UAAU,eAAe,CAAC,CAAC,CAAC,CAAC;IAEhK,gBAAgB;IACT,MAAM,CAAC,cAAc;QAC1B,IAAI,IAAI,KAAK,gBAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;YACvD,OAAO;QAET,gBAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1C,gBAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAE7B,sHAAsH;QACtH;YACE,UAAU;YACV,SAAS;YACT,QAAQ;YACR,WAAW;YACX,OAAO;YACP,OAAO;YACP,UAAU;YACV,WAAW;YACX,iBAAiB;YACjB,eAAe;YACf,cAAc;YACd,UAAU;SACX,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,6BAAa,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IACpE,CAAC;CACF;AA5BD,sCA4BC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Schema\n */\n\nimport * as path from \"path\";\nimport * as categoryMod from \"./Category\";\nimport { ClassRegistry } from \"./ClassRegistry\";\nimport * as elementMod from \"./Element\";\nimport * as aspectMod from \"./ElementAspect\";\nimport * as externalSourceMod from \"./ExternalSource\";\nimport { KnownLocations } from \"./IModelHost\";\nimport * as materialMod from \"./Material\";\nimport * as modelMod from \"./Model\";\nimport * as linkMod from \"./Relationship\";\nimport { Schema, Schemas } from \"./Schema\";\nimport * as textureMod from \"./Texture\";\nimport * as viewMod from \"./ViewDefinition\";\nimport * as displayStyleMod from \"./DisplayStyle\";\nimport * as annotationsMod from \"./TextAnnotationElement\";\nimport * as sheetIndex from \"./SheetIndex\";\n\n/**\n * The [BisCore]($docs/bis/guide/fundamentals/schemas-domains.md) schema is the lowest level Schema in an iModel.\n *\n * It is automatically registered when [[IModelHost.startup]] is called.\n *\n * Example:\n * ``` ts\n * [[include:BisCore.registerSchemaAndGetClass]]\n * ```\n * @public\n */\nexport class BisCoreSchema extends Schema {\n  public static override get schemaName(): string { return \"BisCore\"; }\n  public static get schemaFilePath(): string { return path.join(KnownLocations.nativeAssetsDir, \"ECSchemas\", \"Dgn\", `${BisCoreSchema.schemaName}.ecschema.xml`); }\n\n  /** @internal */\n  public static registerSchema() {\n    if (this === Schemas.getRegisteredSchema(this.schemaName))\n      return;\n\n    Schemas.unregisterSchema(this.schemaName);\n    Schemas.registerSchema(this);\n\n    // this list should include all backend .ts files with implementations of Entity-based classes. Order does not matter.\n    [\n      elementMod,\n      aspectMod,\n      modelMod,\n      categoryMod,\n      viewMod,\n      linkMod,\n      textureMod,\n      materialMod,\n      externalSourceMod,\n      displayStyleMod,\n      annotationsMod,\n      sheetIndex\n    ].forEach((module) => ClassRegistry.registerModule(module, this));\n  }\n}\n"]}

package/lib/cjs/BlobContainerService.d.ts

@@ -61,19 +61,19 @@ export declare namespace BlobContainer {
     /** Properties returned by `Service.requestToken` */
     interface TokenProps {
         /**
-         * expiring token that provides the requested access to the container. Should be used in all subsequent requests for blobs within the container,
+         * Expiring token that provides the requested access to the container. Should be used in all subsequent requests for blobs within the container,
          * and must be refreshed before it expires
          */
         token: ContainerToken;
-        /** scope of the container. */
+        /** Scope of the container. */
         scope: Scope;
-        /** name of the blob storage provider. */
+        /** Name of the blob storage provider. */
         provider: Provider;
         /** Time at which the token will expire. The token should be refreshed (that is, a new token should be requested) before this time. */
         expiration: Date;
         /** Metadata of the container. */
         metadata: Metadata;
-        /** Base URI of container */
+        /** Base URI of the storage account that hosts the container */
         baseUri: string;
     }
     /** The URI and Id of the container. */

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

@@ -1 +1 @@
-{"version":3,"file":"BlobContainerService.d.ts","sourceRoot":"","sources":["../../src/BlobContainerService.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzD;;;GAGG;AACH,yBAAiB,aAAa,CAAC;IAE7B,+FAA+F;IACxF,IAAI,OAAO,EAAE,aAAa,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAE/D,8CAA8C;IAC9C,KAAY,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;IAE1C,mDAAmD;IACnD,KAAY,WAAW,GAAG,MAAM,CAAC;IAEjC,4FAA4F;IAC5F,KAAY,SAAS,GAAG,WAAW,CAAC;IAEpC,+EAA+E;IAC/E,KAAY,cAAc,GAAG,WAAW,CAAC;IAEzC;;;;;;;;OAQG;IACH,UAAiB,KAAK;QACpB,8CAA8C;QAC9C,OAAO,EAAE,UAAU,CAAC;QACpB,6GAA6G;QAC7G,QAAQ,CAAC,EAAE,UAAU,CAAC;QACtB,iEAAiE;QACjE,SAAS,CAAC,EAAE,UAAU,CAAC;KACxB;IAED;;;;;;OAMG;IACH,UAAiB,QAAQ;QACvB,yIAAyI;QACzI,aAAa,EAAE,MAAM,CAAC;QACtB,qJAAqJ;QACrJ,KAAK,EAAE,MAAM,CAAC;QACd,kKAAkK;QAClK,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,4CAA4C;QAC5C,IAAI,CAAC,EAAE,iBAAiB,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,gBAAiB,SAAQ,QAAQ;QAChD,WAAW,EAAE,MAAM,CAAC;KACrB;IAED,oDAAoD;IACpD,UAAiB,UAAU;QACzB;;;WAGG;QACH,KAAK,EAAE,cAAc,CAAC;QACtB,8BAA8B;QAC9B,KAAK,EAAE,KAAK,CAAC;QACb,yCAAyC;QACzC,QAAQ,EAAE,QAAQ,CAAC;QACnB,sIAAsI;QACtI,UAAU,EAAE,IAAI,CAAC;QACjB,iCAAiC;QACjC,QAAQ,EAAE,QAAQ,CAAC;QACnB,4BAA4B;QAC5B,OAAO,EAAE,MAAM,CAAC;KACjB;IAED,uCAAuC;IACvC,UAAiB,QAAQ;QACvB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,WAAW,CAAC;KAC1B;IAED,4DAA4D;IAC5D,UAAiB,oBAAqB,SAAQ,QAAQ;QACpD,SAAS,EAAE,SAAS,CAAC;KACtB;IAED,mDAAmD;IACnD,UAAiB,qBAAsB,SAAQ,QAAQ;QACrD,yCAAyC;QACzC,QAAQ,EAAE,QAAQ,CAAC;KACpB;IAED;;;;;;;OAOG;IACH,KAAY,kBAAkB,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,iBAAiB,CAAC;IAEhF,uEAAuE;IACvE,UAAiB,iBAAkB,SAAQ,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC;QAC9E,wFAAwF;QACxF,WAAW,CAAC,EAAE,kBAAkB,CAAC;QACjC;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED,sDAAsD;IACtD,UAAiB,uBAAuB;QACtC,qCAAqC;QACrC,KAAK,EAAE,KAAK,CAAC;QACb,iDAAiD;QACjD,QAAQ,EAAE,QAAQ,CAAC;QACnB,4GAA4G;QAC5G,SAAS,EAAE,SAAS,CAAC;QACrB;;;WAGG;QACH,WAAW,CAAC,EAAE,WAAW,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC,6CAA6C;QAC7C,OAAO,EAAE,UAAU,CAAC;QACpB,mDAAmD;QACnD,QAAQ,CAAC,EAAE,UAAU,CAAC;QACtB,wDAAwD;QACxD,aAAa,CAAC,EAAE,UAAU,CAAC;QAC3B,gDAAgD;QAChD,KAAK,CAAC,EAAE,UAAU,CAAC;KACpB;IAED,6DAA6D;IAC7D,UAAiB,gBAAgB;QAC/B,wGAAwG;QACxG,MAAM,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAEvE;;;WAGG;QACH,MAAM,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEvD,sCAAsC;QACtC,UAAU,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAE5D,kDAAkD;QAClD,aAAa,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QAElE,oIAAoI;QACpI,uBAAuB,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAEtG,mDAAmD;QACnD,UAAU,CAAC,SAAS,EAAE,oBAAoB,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEpF,qEAAqE;QACrE,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;KAC7D;CACF"}
+{"version":3,"file":"BlobContainerService.d.ts","sourceRoot":"","sources":["../../src/BlobContainerService.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzD;;;GAGG;AACH,yBAAiB,aAAa,CAAC;IAE7B,+FAA+F;IACxF,IAAI,OAAO,EAAE,aAAa,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAE/D,8CAA8C;IAC9C,KAAY,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;IAE1C,mDAAmD;IACnD,KAAY,WAAW,GAAG,MAAM,CAAC;IAEjC,4FAA4F;IAC5F,KAAY,SAAS,GAAG,WAAW,CAAC;IAEpC,+EAA+E;IAC/E,KAAY,cAAc,GAAG,WAAW,CAAC;IAEzC;;;;;;;;OAQG;IACH,UAAiB,KAAK;QACpB,8CAA8C;QAC9C,OAAO,EAAE,UAAU,CAAC;QACpB,6GAA6G;QAC7G,QAAQ,CAAC,EAAE,UAAU,CAAC;QACtB,iEAAiE;QACjE,SAAS,CAAC,EAAE,UAAU,CAAC;KACxB;IAED;;;;;;OAMG;IACH,UAAiB,QAAQ;QACvB,yIAAyI;QACzI,aAAa,EAAE,MAAM,CAAC;QACtB,qJAAqJ;QACrJ,KAAK,EAAE,MAAM,CAAC;QACd,kKAAkK;QAClK,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,4CAA4C;QAC5C,IAAI,CAAC,EAAE,iBAAiB,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,gBAAiB,SAAQ,QAAQ;QAChD,WAAW,EAAE,MAAM,CAAC;KACrB;IAED,oDAAoD;IACpD,UAAiB,UAAU;QACzB;;;WAGG;QACH,KAAK,EAAE,cAAc,CAAC;QACtB,8BAA8B;QAC9B,KAAK,EAAE,KAAK,CAAC;QACb,yCAAyC;QACzC,QAAQ,EAAE,QAAQ,CAAC;QACnB,sIAAsI;QACtI,UAAU,EAAE,IAAI,CAAC;QACjB,iCAAiC;QACjC,QAAQ,EAAE,QAAQ,CAAC;QACnB,+DAA+D;QAC/D,OAAO,EAAE,MAAM,CAAC;KACjB;IAED,uCAAuC;IACvC,UAAiB,QAAQ;QACvB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,WAAW,CAAC;KAC1B;IAED,4DAA4D;IAC5D,UAAiB,oBAAqB,SAAQ,QAAQ;QACpD,SAAS,EAAE,SAAS,CAAC;KACtB;IAED,mDAAmD;IACnD,UAAiB,qBAAsB,SAAQ,QAAQ;QACrD,yCAAyC;QACzC,QAAQ,EAAE,QAAQ,CAAC;KACpB;IAED;;;;;;;OAOG;IACH,KAAY,kBAAkB,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,iBAAiB,CAAC;IAEhF,uEAAuE;IACvE,UAAiB,iBAAkB,SAAQ,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC;QAC9E,wFAAwF;QACxF,WAAW,CAAC,EAAE,kBAAkB,CAAC;QACjC;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED,sDAAsD;IACtD,UAAiB,uBAAuB;QACtC,qCAAqC;QACrC,KAAK,EAAE,KAAK,CAAC;QACb,iDAAiD;QACjD,QAAQ,EAAE,QAAQ,CAAC;QACnB,4GAA4G;QAC5G,SAAS,EAAE,SAAS,CAAC;QACrB;;;WAGG;QACH,WAAW,CAAC,EAAE,WAAW,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC,6CAA6C;QAC7C,OAAO,EAAE,UAAU,CAAC;QACpB,mDAAmD;QACnD,QAAQ,CAAC,EAAE,UAAU,CAAC;QACtB,wDAAwD;QACxD,aAAa,CAAC,EAAE,UAAU,CAAC;QAC3B,gDAAgD;QAChD,KAAK,CAAC,EAAE,UAAU,CAAC;KACpB;IAED,6DAA6D;IAC7D,UAAiB,gBAAgB;QAC/B,wGAAwG;QACxG,MAAM,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAEvE;;;WAGG;QACH,MAAM,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEvD,sCAAsC;QACtC,UAAU,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAE5D,kDAAkD;QAClD,aAAa,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QAElE,oIAAoI;QACpI,uBAAuB,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAEtG,mDAAmD;QACnD,UAAU,CAAC,SAAS,EAAE,oBAAoB,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEpF,qEAAqE;QACrE,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;KAC7D;CACF"}

package/lib/cjs/BlobContainerService.js.map

@@ -1 +1 @@
-{"version":3,"file":"BlobContainerService.js","sourceRoot":"","sources":["../../src/BlobContainerService.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;;GAGG;AACH,IAAiB,aAAa,CA2K7B;AA3KD,WAAiB,aAAa;AA2K9B,CAAC,EA3KgB,aAAa,6BAAb,aAAa,QA2K7B","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 BlobContainers\r\n */\r\n\r\n// spell:ignore datacenter\r\n\r\nimport { AccessToken, GuidString, Id64String } from \"@itwin/core-bentley\";\r\nimport { SettingsContainer } from \"./workspace/Settings\";\r\n\r\n/**\r\n * Types and functions for creating, deleting and authorizing access to cloud-based blob containers for an iTwin.\r\n * @beta\r\n */\r\nexport namespace BlobContainer {\r\n\r\n  /** Object that implements the methods to create, delete, and request access to a container. */\r\n  export let service: BlobContainer.ContainerService | undefined;\r\n\r\n  /** name of cloud provider for a container. */\r\n  export type Provider = \"azure\" | \"google\";\r\n\r\n  /** the name of the container within its `Scope` */\r\n  export type ContainerId = string;\r\n\r\n  /** token that authenticates a user. This token is required to obtain a `ContainerToken`. */\r\n  export type UserToken = AccessToken;\r\n\r\n  /** token that authenticates access to a container for either read or write. */\r\n  export type ContainerToken = AccessToken;\r\n\r\n  /**\r\n   * The scope for a container. This determines:\r\n   *  - the \"owner\" organization, including the contract that governs its legal and commercial terms and obligations\r\n   *  - the administrators who may configure RBAC permissions\r\n   *  - the datacenter for the container. Every container resides in a datacenter as determined by the iTwinId. This\r\n   * determines the region for data residency requirements.\r\n   *  - the lifecycle constraints for the container. No container can outlive its iTwin or its iModel (if defined). That is,\r\n   * when the iTwin/iModel is deleted (either explicitly or due to contract expiration), the container is also deleted.\r\n   */\r\n  export interface Scope {\r\n    /** iTwinId of the owner of this container. */\r\n    iTwinId: Id64String;\r\n    /** optionally, an iModelId within the iTwin. If present, container is deleted when the iModel is deleted. */\r\n    iModelId?: Id64String;\r\n    /** the user GUID an individual, if this container is private. */\r\n    ownerGuid?: GuidString;\r\n  }\r\n\r\n  /**\r\n   * Metadata about the use of a container so that:\r\n   *  - administrators can understand why a container exists for assigning RBAC permissions appropriately\r\n   *  - usage reports can aggregate types of containers\r\n   *  - applications can identify their containers\r\n   *  - applications can store properties about their containers\r\n   */\r\n  export interface Metadata {\r\n    /** The machine-readable string that describes what the container is being used for (e.g. \"workspace\"). Always lowercase and singular. */\r\n    containerType: string;\r\n    /** Human-readable name for the container. This will be displayed in the administrator RBAC panel, and on usage reports. Not required to be unique.*/\r\n    label: string;\r\n    /** Optional human-readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */\r\n    description?: string;\r\n    /** optional properties for the container */\r\n    json?: SettingsContainer;\r\n  }\r\n\r\n  /**\r\n   * Properties returned by queryContainersMetadata\r\n   */\r\n  export interface MetadataResponse extends Metadata {\r\n    containerId: string;\r\n  }\r\n\r\n  /** Properties returned by `Service.requestToken` */\r\n  export interface TokenProps {\r\n    /**\r\n     * expiring token that provides the requested access to the container. Should be used in all subsequent requests for blobs within the container,\r\n     * and must be refreshed before it expires\r\n     */\r\n    token: ContainerToken;\r\n    /** scope of the container. */\r\n    scope: Scope;\r\n    /** name of the blob storage provider. */\r\n    provider: Provider;\r\n    /** Time at which the token will expire. The token should be refreshed (that is, a new token should be requested) before this time. */\r\n    expiration: Date;\r\n    /** Metadata of the container. */\r\n    metadata: Metadata;\r\n    /** Base URI of container */\r\n    baseUri: string;\r\n  }\r\n\r\n  /** The URI and Id of the container. */\r\n  export interface UriAndId {\r\n    baseUri: string;\r\n    containerId: ContainerId;\r\n  }\r\n\r\n  /** Information required to access an existing container. */\r\n  export interface AccessContainerProps extends UriAndId {\r\n    userToken: UserToken;\r\n  }\r\n\r\n  /** Information about a newly created container. */\r\n  export interface CreatedContainerProps extends UriAndId {\r\n    /** name of the blob storage provider. */\r\n    provider: Provider;\r\n  }\r\n\r\n  /**\r\n   * Access level to request for token.\r\n   * - `\"write\"`: request a writeable AccessToken.\r\n   * - `\"read\"`:  request a read-only AccessToken.\r\n   * - `\"admin\"`:  request a admin AccessToken.\r\n   * - `\"writeIfPossible\"`: first request a writeable AccessToken. If the user is not authorized for write, request a read-only AccessToken.\r\n   * If the user is not authorized for the level requested, an exception is thrown.\r\n   */\r\n  export type RequestAccessLevel = \"write\" | \"read\" | \"admin\" | \"writeIfPossible\";\r\n\r\n  /** Information required to request an access token for a container. */\r\n  export interface RequestTokenProps extends Omit<AccessContainerProps, \"baseUri\"> {\r\n    /** the level of access requested. If not specified, defaults to `\"writeIfPossible\"`. */\r\n    accessLevel?: RequestAccessLevel;\r\n    /** the number of seconds before the token should expire.\r\n     * @note A maximum duration is determined by the service. If no value is supplied, or the value is larger than the maximum, the maximum duration is used.\r\n     */\r\n    durationSeconds?: number;\r\n  }\r\n\r\n  /** Information required to create a new container. */\r\n  export interface CreateNewContainerProps {\r\n    /** the scope of the new container */\r\n    scope: Scope;\r\n    /** metadata to be stored on the new container */\r\n    metadata: Metadata;\r\n    /** The user's access token. The user must be authorized with \"create container\" RBAC role for the iTwin. */\r\n    userToken: UserToken;\r\n    /**\r\n     * the id for the container. Useful for tests.\r\n     * @internal\r\n     */\r\n    containerId?: ContainerId;\r\n  }\r\n\r\n  /**\r\n   * Query Parameters for querying containers\r\n   */\r\n  export interface QueryContainerProps {\r\n    /** the iTwinId of the containers to query */\r\n    iTwinId: GuidString;\r\n    /** optional iModelId of the containers to query */\r\n    iModelId?: GuidString;\r\n    /** optional containerType of the containers to query */\r\n    containerType?: GuidString;\r\n    /** optional label of the containers to query */\r\n    label?: GuidString;\r\n  }\r\n\r\n  /** Methods to create, delete, and access blob containers. */\r\n  export interface ContainerService {\r\n    /**  Create a new blob container. Throws on failure (e.g. access denied or container already exists.) */\r\n    create(props: CreateNewContainerProps): Promise<CreatedContainerProps>;\r\n\r\n    /**\r\n     * Delete an existing blob container.\r\n     * @note This method requires that the user be authorized with \"delete container\" RBAC role for the iTwin.\r\n     */\r\n    delete(container: AccessContainerProps): Promise<void>;\r\n\r\n    /** query the Scope for a container */\r\n    queryScope(container: AccessContainerProps): Promise<Scope>;\r\n\r\n    /** query the Metadata for a specific container */\r\n    queryMetadata(container: AccessContainerProps): Promise<Metadata>;\r\n\r\n    /** Returns all containers and their metadata associated with a given iTwinId. Can be further queried by label and containerType. */\r\n    queryContainersMetadata(userToken: UserToken, args: QueryContainerProps): Promise<MetadataResponse[]>;\r\n\r\n    /** update the json properties of this container */\r\n    updateJson(container: AccessContainerProps, json: SettingsContainer): Promise<void>;\r\n\r\n    /** Request a `ContainerToken` for a container. Throws on failure. */\r\n    requestToken(props: RequestTokenProps): Promise<TokenProps>;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BlobContainerService.js","sourceRoot":"","sources":["../../src/BlobContainerService.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;;GAGG;AACH,IAAiB,aAAa,CA2K7B;AA3KD,WAAiB,aAAa;AA2K9B,CAAC,EA3KgB,aAAa,6BAAb,aAAa,QA2K7B","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module BlobContainers\n */\n\n// spell:ignore datacenter\n\nimport { AccessToken, GuidString, Id64String } from \"@itwin/core-bentley\";\nimport { SettingsContainer } from \"./workspace/Settings\";\n\n/**\n * Types and functions for creating, deleting and authorizing access to cloud-based blob containers for an iTwin.\n * @beta\n */\nexport namespace BlobContainer {\n\n  /** Object that implements the methods to create, delete, and request access to a container. */\n  export let service: BlobContainer.ContainerService | undefined;\n\n  /** name of cloud provider for a container. */\n  export type Provider = \"azure\" | \"google\";\n\n  /** the name of the container within its `Scope` */\n  export type ContainerId = string;\n\n  /** token that authenticates a user. This token is required to obtain a `ContainerToken`. */\n  export type UserToken = AccessToken;\n\n  /** token that authenticates access to a container for either read or write. */\n  export type ContainerToken = AccessToken;\n\n  /**\n   * The scope for a container. This determines:\n   *  - the \"owner\" organization, including the contract that governs its legal and commercial terms and obligations\n   *  - the administrators who may configure RBAC permissions\n   *  - the datacenter for the container. Every container resides in a datacenter as determined by the iTwinId. This\n   * determines the region for data residency requirements.\n   *  - the lifecycle constraints for the container. No container can outlive its iTwin or its iModel (if defined). That is,\n   * when the iTwin/iModel is deleted (either explicitly or due to contract expiration), the container is also deleted.\n   */\n  export interface Scope {\n    /** iTwinId of the owner of this container. */\n    iTwinId: Id64String;\n    /** optionally, an iModelId within the iTwin. If present, container is deleted when the iModel is deleted. */\n    iModelId?: Id64String;\n    /** the user GUID an individual, if this container is private. */\n    ownerGuid?: GuidString;\n  }\n\n  /**\n   * Metadata about the use of a container so that:\n   *  - administrators can understand why a container exists for assigning RBAC permissions appropriately\n   *  - usage reports can aggregate types of containers\n   *  - applications can identify their containers\n   *  - applications can store properties about their containers\n   */\n  export interface Metadata {\n    /** The machine-readable string that describes what the container is being used for (e.g. \"workspace\"). Always lowercase and singular. */\n    containerType: string;\n    /** Human-readable name for the container. This will be displayed in the administrator RBAC panel, and on usage reports. Not required to be unique.*/\n    label: string;\n    /** Optional human-readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */\n    description?: string;\n    /** optional properties for the container */\n    json?: SettingsContainer;\n  }\n\n  /**\n   * Properties returned by queryContainersMetadata\n   */\n  export interface MetadataResponse extends Metadata {\n    containerId: string;\n  }\n\n  /** Properties returned by `Service.requestToken` */\n  export interface TokenProps {\n    /**\n     * Expiring token that provides the requested access to the container. Should be used in all subsequent requests for blobs within the container,\n     * and must be refreshed before it expires\n     */\n    token: ContainerToken;\n    /** Scope of the container. */\n    scope: Scope;\n    /** Name of the blob storage provider. */\n    provider: Provider;\n    /** Time at which the token will expire. The token should be refreshed (that is, a new token should be requested) before this time. */\n    expiration: Date;\n    /** Metadata of the container. */\n    metadata: Metadata;\n    /** Base URI of the storage account that hosts the container */\n    baseUri: string;\n  }\n\n  /** The URI and Id of the container. */\n  export interface UriAndId {\n    baseUri: string;\n    containerId: ContainerId;\n  }\n\n  /** Information required to access an existing container. */\n  export interface AccessContainerProps extends UriAndId {\n    userToken: UserToken;\n  }\n\n  /** Information about a newly created container. */\n  export interface CreatedContainerProps extends UriAndId {\n    /** name of the blob storage provider. */\n    provider: Provider;\n  }\n\n  /**\n   * Access level to request for token.\n   * - `\"write\"`: request a writeable AccessToken.\n   * - `\"read\"`:  request a read-only AccessToken.\n   * - `\"admin\"`:  request a admin AccessToken.\n   * - `\"writeIfPossible\"`: first request a writeable AccessToken. If the user is not authorized for write, request a read-only AccessToken.\n   * If the user is not authorized for the level requested, an exception is thrown.\n   */\n  export type RequestAccessLevel = \"write\" | \"read\" | \"admin\" | \"writeIfPossible\";\n\n  /** Information required to request an access token for a container. */\n  export interface RequestTokenProps extends Omit<AccessContainerProps, \"baseUri\"> {\n    /** the level of access requested. If not specified, defaults to `\"writeIfPossible\"`. */\n    accessLevel?: RequestAccessLevel;\n    /** the number of seconds before the token should expire.\n     * @note A maximum duration is determined by the service. If no value is supplied, or the value is larger than the maximum, the maximum duration is used.\n     */\n    durationSeconds?: number;\n  }\n\n  /** Information required to create a new container. */\n  export interface CreateNewContainerProps {\n    /** the scope of the new container */\n    scope: Scope;\n    /** metadata to be stored on the new container */\n    metadata: Metadata;\n    /** The user's access token. The user must be authorized with \"create container\" RBAC role for the iTwin. */\n    userToken: UserToken;\n    /**\n     * the id for the container. Useful for tests.\n     * @internal\n     */\n    containerId?: ContainerId;\n  }\n\n  /**\n   * Query Parameters for querying containers\n   */\n  export interface QueryContainerProps {\n    /** the iTwinId of the containers to query */\n    iTwinId: GuidString;\n    /** optional iModelId of the containers to query */\n    iModelId?: GuidString;\n    /** optional containerType of the containers to query */\n    containerType?: GuidString;\n    /** optional label of the containers to query */\n    label?: GuidString;\n  }\n\n  /** Methods to create, delete, and access blob containers. */\n  export interface ContainerService {\n    /**  Create a new blob container. Throws on failure (e.g. access denied or container already exists.) */\n    create(props: CreateNewContainerProps): Promise<CreatedContainerProps>;\n\n    /**\n     * Delete an existing blob container.\n     * @note This method requires that the user be authorized with \"delete container\" RBAC role for the iTwin.\n     */\n    delete(container: AccessContainerProps): Promise<void>;\n\n    /** query the Scope for a container */\n    queryScope(container: AccessContainerProps): Promise<Scope>;\n\n    /** query the Metadata for a specific container */\n    queryMetadata(container: AccessContainerProps): Promise<Metadata>;\n\n    /** Returns all containers and their metadata associated with a given iTwinId. Can be further queried by label and containerType. */\n    queryContainersMetadata(userToken: UserToken, args: QueryContainerProps): Promise<MetadataResponse[]>;\n\n    /** update the json properties of this container */\n    updateJson(container: AccessContainerProps, json: SettingsContainer): Promise<void>;\n\n    /** Request a `ContainerToken` for a container. Throws on failure. */\n    requestToken(props: RequestTokenProps): Promise<TokenProps>;\n  }\n}\n"]}

package/lib/cjs/BriefcaseManager.d.ts

@@ -32,6 +32,11 @@ export interface PushChangesArgs extends TokenArg {
     pushRetryCount?: number;
     /** The delay to wait between retry attempts on failed pushes. Default is 3 seconds. */
     pushRetryDelay?: BeDuration;
+    /**
+     *  For testing purpose
+     * @internal
+     */
+    noFastForward?: true;
 }
 /**
  * Specifies a specific index for pulling changes.
@@ -49,6 +54,11 @@ export type PullChangesArgs = ToChangesetArgs & {
      * @note return non-zero from this function to abort the download.
      */
     onProgress?: ProgressFunction;
+    /**
+     *  For testing purpose
+     * @internal
+     */
+    noFastForward?: true;
 };
 /** Arguments for [[BriefcaseManager.revertTimelineChanges]]
  * @public

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

@@ -1 +1 @@
-{"version":3,"file":"BriefcaseManager.d.ts","sourceRoot":"","sources":["../../src/BriefcaseManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EACL,WAAW,EAAE,UAAU,EAAmB,UAAU,EAAmD,QAAQ,EAChH,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,WAAW,EAAoB,cAAc,EAAsB,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,cAAc,EAA6C,mBAAmB,EACrM,YAAY,EAAE,aAAa,EAAE,wBAAwB,EACtD,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,wBAAwB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAE7E,OAAO,EAAsC,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAS7D;;EAEE;AACF,MAAM,WAAW,sBAAuB,SAAQ,QAAQ,EAAE,wBAAwB;IAChF;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,8EAA8E;IAC9E,WAAW,EAAE,MAAM,CAAC;IACpB,8IAA8I;IAC9I,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,oGAAoG;IACpG,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,4EAA4E;IAC5E,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,8FAA8F;IAC9F,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uFAAuF;IACvF,cAAc,CAAC,EAAE,UAAU,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,oFAAoF;IACpF,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG;IAC9C;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG;IACzE;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,8CAA8C;IAC9C,OAAO,EAAE,cAAc,CAAC;IACxB,0EAA0E;IAC1E,iBAAiB,CAAC,EAAE,IAAI,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,wFAAwF;WAC1E,aAAa,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAE/D,gBAAgB;WACF,iBAAiB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAEnE,gBAAgB;WACF,sBAAsB,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAEzE,gBAAgB;WACF,0BAA0B,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAE7E,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAgB;IAC/C,gGAAgG;WAClF,oBAAoB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAItE;;;;OAIG;WACW,WAAW,CAAC,SAAS,EAAE,cAAc,GAAG,aAAa;IAInE,OAAO,CAAC,MAAM,CAAC,aAAa;IAK5B,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAU;IACtC;;;;OAIG;WACW,UAAU,CAAC,YAAY,EAAE,YAAY;IAQnD,OAAO,CAAC,MAAM,CAAC,QAAQ;IAIvB;;;;OAIG;WACW,mBAAmB,CAAC,QAAQ,CAAC,EAAE,UAAU,GAAG,mBAAmB,EAAE;IA8B/E,OAAO,CAAC,MAAM,CAAC,SAAS,CAAe;IACvC,qDAAqD;IACrD,WAAkB,QAAQ,IAAI,YAAY,CAA2B;IAErE;;OAEG;WACW,kBAAkB,CAAC,EAAE,EAAE,WAAW;IAIhD;;;OAGG;WACiB,qBAAqB,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC;IAI9F;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,iBAAiB,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA+DhG;;OAEG;WACW,6BAA6B,CAAC,QAAQ,EAAE,MAAM;IAK5D;;;OAGG;WACiB,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxG;;;;;;OAMG;WACiB,oBAAoB,CAAC,QAAQ,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAoC3G;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU;IAUzB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAclC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAenC,4EAA4E;WACxD,cAAc,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAC;QAAC,SAAS,EAAE,kBAAkB,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAIzH,gFAAgF;WAC5D,eAAe,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAC;QAAC,KAAK,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAIpH,wEAAwE;WACpD,kBAAkB,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAI9F;;;OAGG;WACiB,iBAAiB,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAI1F;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;mBAajB,oBAAoB;IAWzC,gBAAgB;WACI,qBAAqB,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoD9F,gBAAgB;WACI,sBAAsB,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAkC7F,4EAA4E;mBACvD,WAAW;IA4ChC;;OAEG;WACiB,aAAa,CAAC,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;CAgBxF"}
+{"version":3,"file":"BriefcaseManager.d.ts","sourceRoot":"","sources":["../../src/BriefcaseManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EACL,WAAW,EAAE,UAAU,EAAmB,UAAU,EAAmD,QAAQ,EAChH,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,WAAW,EAAoB,cAAc,EAAsB,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,cAAc,EAA6C,mBAAmB,EACrM,YAAY,EAAE,aAAa,EAAE,wBAAwB,EACtD,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,wBAAwB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAE7E,OAAO,EAAsC,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAS7D;;EAEE;AACF,MAAM,WAAW,sBAAuB,SAAQ,QAAQ,EAAE,wBAAwB;IAChF;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,8EAA8E;IAC9E,WAAW,EAAE,MAAM,CAAC;IACpB,8IAA8I;IAC9I,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,oGAAoG;IACpG,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,4EAA4E;IAC5E,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,8FAA8F;IAC9F,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uFAAuF;IACvF,cAAc,CAAC,EAAE,UAAU,CAAC;IAC5B;;;OAGG;IACH,aAAa,CAAC,EAAE,IAAI,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,oFAAoF;IACpF,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG;IAC9C;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B;;;OAGG;IACH,aAAa,CAAC,EAAE,IAAI,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG;IACzE;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,8CAA8C;IAC9C,OAAO,EAAE,cAAc,CAAC;IACxB,0EAA0E;IAC1E,iBAAiB,CAAC,EAAE,IAAI,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,wFAAwF;WAC1E,aAAa,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAE/D,gBAAgB;WACF,iBAAiB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAEnE,gBAAgB;WACF,sBAAsB,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAEzE,gBAAgB;WACF,0BAA0B,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAE7E,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAgB;IAC/C,gGAAgG;WAClF,oBAAoB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAItE;;;;OAIG;WACW,WAAW,CAAC,SAAS,EAAE,cAAc,GAAG,aAAa;IAInE,OAAO,CAAC,MAAM,CAAC,aAAa;IAK5B,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAU;IACtC;;;;OAIG;WACW,UAAU,CAAC,YAAY,EAAE,YAAY;IAQnD,OAAO,CAAC,MAAM,CAAC,QAAQ;IAIvB;;;;OAIG;WACW,mBAAmB,CAAC,QAAQ,CAAC,EAAE,UAAU,GAAG,mBAAmB,EAAE;IA8B/E,OAAO,CAAC,MAAM,CAAC,SAAS,CAAe;IACvC,qDAAqD;IACrD,WAAkB,QAAQ,IAAI,YAAY,CAA2B;IAErE;;OAEG;WACW,kBAAkB,CAAC,EAAE,EAAE,WAAW;IAIhD;;;OAGG;WACiB,qBAAqB,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC;IAI9F;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,iBAAiB,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA+DhG;;OAEG;WACW,6BAA6B,CAAC,QAAQ,EAAE,MAAM;IAK5D;;;OAGG;WACiB,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxG;;;;;;OAMG;WACiB,oBAAoB,CAAC,QAAQ,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAoC3G;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU;IAUzB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAclC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAenC,4EAA4E;WACxD,cAAc,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAC;QAAC,SAAS,EAAE,kBAAkB,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAIzH,gFAAgF;WAC5D,eAAe,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAC;QAAC,KAAK,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAIpH,wEAAwE;WACpD,kBAAkB,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAI9F;;;OAGG;WACiB,iBAAiB,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAI1F;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;mBAajB,oBAAoB;IAWzC,gBAAgB;WACI,qBAAqB,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoD9F,gBAAgB;WACI,sBAAsB,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IA8E7F,4EAA4E;mBACvD,WAAW;IA4ChC;;OAEG;WACiB,aAAa,CAAC,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;CAgBxF"}