@itwin/core-frontend 5.14.0-dev.8 → 5.15.0-dev.1

package/CHANGELOG.md

@@ -1,6 +1,38 @@
 # Change Log - @itwin/core-frontend
 
-This log was last generated on Thu, 03 Sep 2026 18:51:17 GMT and should not be manually modified.
+This log was last generated on Fri, 25 Sep 2026 22:28:38 GMT and should not be manually modified.
+
+## 5.13.6
+Fri, 25 Sep 2026 22:27:22 GMT
+
+_Version update only_
+
+## 5.13.5
+Tue, 22 Sep 2026 22:38:08 GMT
+
+### Updates
+
+- Fixed GL_INVALID_FRAMEBUFFER_OPERATION that could occur when reading pixels right after a second viewport was closed
+
+## 5.13.4
+Fri, 18 Sep 2026 15:11:19 GMT
+
+_Version update only_
+
+## 5.13.3
+Tue, 15 Sep 2026 20:25:28 GMT
+
+_Version update only_
+
+## 5.13.2
+Mon, 14 Sep 2026 20:22:20 GMT
+
+_Version update only_
+
+## 5.13.1
+Tue, 08 Sep 2026 18:43:29 GMT
+
+_Version update only_
 
 ## 5.13.0
 Thu, 03 Sep 2026 18:49:56 GMT

package/lib/cjs/BriefcaseConnection.d.ts

@@ -46,6 +46,21 @@ export interface PullChangesOptions {
      */
     abortSignal?: GenericAbortSignal;
 }
+/**
+ * Options for pushing iModel changes.
+ * @beta
+ */
+export interface PushChangesOptions {
+    /** Function called regularly to report progress of the download of the changes that must be merged before pushing. */
+    downloadProgressCallback?: OnDownloadProgress;
+    /** Interval for calling [[downloadProgressCallback]] (in milliseconds). */
+    downloadProgressInterval?: number;
+    /** Signal for cancelling the push.
+     * @note Currently this only cancels the download of the changes that must be merged before pushing - it has no effect once the local
+     * changeset is being uploaded.
+     */
+    abortSignal?: GenericAbortSignal;
+}
 /**
  * Provides access to lock information in the iModel.
  * @see [[BriefcaseConnection.locks]]
@@ -151,6 +166,10 @@ export declare class BriefcaseConnection extends IModelConnection {
      * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use methods on EditCommand instead.
      */
     abandonChanges(): Promise<void>;
+    /** Subscribes to changeset download progress events on `channel` and wires `abortSignal` to `cancel`.
+     * @returns a function that removes every listener that was added.
+     */
+    private listenForChangesetDownloadProgress;
     /** Pull (and potentially merge if there are local changes) up to a specified changeset from iModelHub into this briefcase
      * @param toIndex The changeset index to pull changes to. If `undefined`, pull all changes.
      * @param options Options for pulling changes.
@@ -160,9 +179,22 @@ export declare class BriefcaseConnection extends IModelConnection {
     /** Create a changeset from local Txns and push to iModelHub. On success, clear Txn table.
      * @param description The description for the changeset
      * @returns the changesetId of the pushed changes
+     * @note Any changes made by other users are first pulled, applied, and merged with the local Txns. Only then is the resulting changeset
+     * uploaded.
      * @see [[BriefcaseTxns.onChangesPushed]] for the event dispatched after changes are pushed.
+     * @public
      */
     pushChanges(description: string): Promise<ChangesetIndexAndId>;
+    /** Create a changeset from local Txns and push to iModelHub. On success, clear Txn table.
+     * @param description The description for the changeset
+     * @param options Options reporting the progress of - and optionally cancelling - the download of the changes that are pulled before pushing.
+     * @returns the changesetId of the pushed changes
+     * @note Any changes made by other users are first pulled, applied, and merged with the local Txns. Only then is the resulting changeset
+     * uploaded.
+     * @see [[BriefcaseTxns.onChangesPushed]] for the event dispatched after changes are pushed.
+     * @beta
+     */
+    pushChanges(description: string, options?: PushChangesOptions): Promise<ChangesetIndexAndId>;
     /** The current graphical editing scope, if one is in progress.
      * @see [[enterEditingScope]] to begin graphical editing.
      */

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

@@ -1 +1 @@
-{"version":3,"file":"BriefcaseConnection.d.ts","sourceRoot":"","sources":["../../src/BriefcaseConnection.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,OAAO,EAA2B,UAAU,EAAE,OAAO,EAAE,UAAU,EAAgB,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACxI,OAAO,EACL,wBAAwB,EAAE,cAAc,EAAE,mBAAmB,EACb,SAAS,EAAE,kBAAkB,EAAE,qBAAqB,EACrG,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAKtD;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,wBAAwB;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,QAAQ,EAAE,oBAAoB,KAAK,IAAI,CAAC;AAE1E;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,qCAAqC;IACrC,gBAAgB,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,kBAAkB,EAAE,EAAE,EAAE,GAAG,KAAK,GAAG,KAAK,IAAI,CAAC;IAChG,wCAAwC;IACxC,mBAAmB,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,kBAAkB,EAAE,EAAE,EAAE,GAAG,KAAK,GAAG,KAAK,IAAI,CAAC;CACpG;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,wEAAwE;IACxE,wBAAwB,CAAC,EAAE,kBAAkB,CAAC;IAC9C,gEAAgE;IAChE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAkID;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,uEAAuE;IACvE,wBAAwB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7C,oEAAoE;IACpE,qBAAqB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1C,qEAAqE;IACrE,4BAA4B,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACxF;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AAEvF;;;;;;;GAOG;AACH,qBAAa,2BAA2B;IACtC,OAAO,CAAC,SAAS,CAAC,CAAa;IAC/B,OAAO,CAAC,MAAM,CAAC,CAAa;IAE5B,sEAAsE;IACtE,SAAgB,iBAAiB,6BAAkC,UAAU,GAAG,SAAS,KAAK,IAAI,EAAI;IAEtG,mEAAmE;IACnE,SAAgB,cAAc,0BAA+B,UAAU,GAAG,SAAS,KAAK,IAAI,EAAI;IAEhG;;;;OAIG;IACH,IAAW,QAAQ,IAAI,UAAU,GAAG,SAAS,CAE5C;IACD,IAAW,QAAQ,CAAC,QAAQ,EAAE,UAAU,GAAG,SAAS,EAMnD;IAED;;;;OAIG;IACH,IAAW,KAAK,IAAI,UAAU,GAAG,SAAS,CAEzC;IACD,IAAW,KAAK,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,EAM7C;CACF;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,gBAAgB;IACvD,SAAS,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC9B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAqB;IACpD,OAAO,CAAC,MAAM,CAAC,CAAc;IAE7B;;OAEG;IACH,SAAgB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,SAAgB,kBAAkB,8BAAqC;IAEvE,+FAA+F;IAC/F,SAAgB,IAAI,EAAE,aAAa,CAAC;IAEpC;;;OAGG;IACH,IAAW,KAAK,IAAI,WAAW,GAAG,SAAS,CAAwB;IAEnD,qBAAqB,IAAI,IAAI,IAAI,mBAAmB;IAEpE,gEAAgE;IAChE,IAAoB,OAAO,IAAI,UAAU,CAAwC;IAEjF,4CAA4C;IAC5C,IAAoB,QAAQ,IAAI,UAAU,CAAyC;IAEnF,SAAS,aAAa,KAAK,EAAE,wBAAwB,EAAE,QAAQ,EAAE,QAAQ;IAYzE,+DAA+D;WAC3C,QAAQ,CAAC,cAAc,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAE9F;;OAEG;WACiB,QAAQ,CAAC,cAAc,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYvI;;OAEG;WACiB,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAE,QAA6B,EAAE,IAAI,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAOzJ,2DAA2D;IAC3D,IAAW,QAAQ,IAAI,OAAO,CAAoC;IAElE;;;OAGG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAanC,SAAS,CAAC,eAAe;IAKzB,2FAA2F;IAC9E,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;IAI/C;;;OAGG;IACU,WAAW,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7D;;OAEG;IACU,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5C;;;;OAIG;IACU,WAAW,CAAC,OAAO,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoC/F;;;;OAIG;IACU,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAK3E;;OAEG;IACH,IAAW,YAAY,IAAI,qBAAqB,GAAG,SAAS,CAE3D;IAED;;;OAGG;IACU,wBAAwB,IAAI,OAAO,CAAC,OAAO,CAAC;IAIzD;;;;;OAKG;IACU,iBAAiB,IAAI,OAAO,CAAC,qBAAqB,CAAC;IAIhE;;OAEG;IACH,SAAgB,sBAAsB,4BAAiC,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,EAAI;CAChG"}
+{"version":3,"file":"BriefcaseConnection.d.ts","sourceRoot":"","sources":["../../src/BriefcaseConnection.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,OAAO,EAA2B,UAAU,EAAE,OAAO,EAAE,UAAU,EAAgB,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACxI,OAAO,EACL,wBAAwB,EAAE,cAAc,EAAE,mBAAmB,EACmC,SAAS,EAAE,kBAAkB,EAAE,qBAAqB,EACrJ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAKtD;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,wBAAwB;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,QAAQ,EAAE,oBAAoB,KAAK,IAAI,CAAC;AAE1E;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,qCAAqC;IACrC,gBAAgB,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,kBAAkB,EAAE,EAAE,EAAE,GAAG,KAAK,GAAG,KAAK,IAAI,CAAC;IAChG,wCAAwC;IACxC,mBAAmB,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,kBAAkB,EAAE,EAAE,EAAE,GAAG,KAAK,GAAG,KAAK,IAAI,CAAC;CACpG;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,wEAAwE;IACxE,wBAAwB,CAAC,EAAE,kBAAkB,CAAC;IAC9C,gEAAgE;IAChE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,sHAAsH;IACtH,wBAAwB,CAAC,EAAE,kBAAkB,CAAC;IAC9C,2EAA2E;IAC3E,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAkID;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,uEAAuE;IACvE,wBAAwB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7C,oEAAoE;IACpE,qBAAqB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1C,qEAAqE;IACrE,4BAA4B,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACxF;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AAEvF;;;;;;;GAOG;AACH,qBAAa,2BAA2B;IACtC,OAAO,CAAC,SAAS,CAAC,CAAa;IAC/B,OAAO,CAAC,MAAM,CAAC,CAAa;IAE5B,sEAAsE;IACtE,SAAgB,iBAAiB,6BAAkC,UAAU,GAAG,SAAS,KAAK,IAAI,EAAI;IAEtG,mEAAmE;IACnE,SAAgB,cAAc,0BAA+B,UAAU,GAAG,SAAS,KAAK,IAAI,EAAI;IAEhG;;;;OAIG;IACH,IAAW,QAAQ,IAAI,UAAU,GAAG,SAAS,CAE5C;IACD,IAAW,QAAQ,CAAC,QAAQ,EAAE,UAAU,GAAG,SAAS,EAMnD;IAED;;;;OAIG;IACH,IAAW,KAAK,IAAI,UAAU,GAAG,SAAS,CAEzC;IACD,IAAW,KAAK,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,EAM7C;CACF;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,gBAAgB;IACvD,SAAS,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC9B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAqB;IACpD,OAAO,CAAC,MAAM,CAAC,CAAc;IAE7B;;OAEG;IACH,SAAgB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,SAAgB,kBAAkB,8BAAqC;IAEvE,+FAA+F;IAC/F,SAAgB,IAAI,EAAE,aAAa,CAAC;IAEpC;;;OAGG;IACH,IAAW,KAAK,IAAI,WAAW,GAAG,SAAS,CAAwB;IAEnD,qBAAqB,IAAI,IAAI,IAAI,mBAAmB;IAEpE,gEAAgE;IAChE,IAAoB,OAAO,IAAI,UAAU,CAAwC;IAEjF,4CAA4C;IAC5C,IAAoB,QAAQ,IAAI,UAAU,CAAyC;IAEnF,SAAS,aAAa,KAAK,EAAE,wBAAwB,EAAE,QAAQ,EAAE,QAAQ;IAYzE,+DAA+D;WAC3C,QAAQ,CAAC,cAAc,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAE9F;;OAEG;WACiB,QAAQ,CAAC,cAAc,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYvI;;OAEG;WACiB,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAE,QAA6B,EAAE,IAAI,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAOzJ,2DAA2D;IAC3D,IAAW,QAAQ,IAAI,OAAO,CAAoC;IAElE;;;OAGG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAanC,SAAS,CAAC,eAAe;IAKzB,2FAA2F;IAC9E,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;IAI/C;;;OAGG;IACU,WAAW,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7D;;OAEG;IACU,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5C;;OAEG;IACH,OAAO,CAAC,kCAAkC;IAuB1C;;;;OAIG;IACU,WAAW,CAAC,OAAO,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB/F;;;;;;;OAOG;IACI,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IACrE;;;;;;;;OAQG;IACI,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAuBnG;;OAEG;IACH,IAAW,YAAY,IAAI,qBAAqB,GAAG,SAAS,CAE3D;IAED;;;OAGG;IACU,wBAAwB,IAAI,OAAO,CAAC,OAAO,CAAC;IAIzD;;;;;OAKG;IACU,iBAAiB,IAAI,OAAO,CAAC,qBAAqB,CAAC;IAIhE;;OAEG;IACH,SAAgB,sBAAsB,4BAAiC,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,EAAI;CAChG"}

package/lib/cjs/BriefcaseConnection.js

@@ -259,29 +259,38 @@ class BriefcaseConnection extends IModelConnection_1.IModelConnection {
     async abandonChanges() {
         await IpcApp_1.IpcApp.appFunctionIpc.abandonChanges(this.key); // eslint-disable-line @typescript-eslint/no-deprecated
     }
+    /** Subscribes to changeset download progress events on `channel` and wires `abortSignal` to `cancel`.
+     * @returns a function that removes every listener that was added.
+     */
+    listenForChangesetDownloadProgress(args) {
+        const { channel, cancel, downloadProgressCallback, abortSignal } = args;
+        const removeListeners = [];
+        if (downloadProgressCallback) {
+            const handleProgress = (_evt, data) => downloadProgressCallback(data);
+            removeListeners.push(IpcApp_1.IpcApp.addListener(channel, handleProgress));
+        }
+        if (abortSignal) {
+            const abort = () => void cancel();
+            abortSignal.addEventListener("abort", abort);
+            removeListeners.push(() => abortSignal.removeEventListener("abort", abort));
+        }
+        return () => removeListeners.forEach((remove) => remove());
+    }
     /** Pull (and potentially merge if there are local changes) up to a specified changeset from iModelHub into this briefcase
      * @param toIndex The changeset index to pull changes to. If `undefined`, pull all changes.
      * @param options Options for pulling changes.
      * @see [[BriefcaseTxns.onChangesPulled]] for the event dispatched after changes are pulled.
      */
     async pullChanges(toIndex, options) {
-        const removeListeners = [];
-        const shouldReportProgress = !!options?.downloadProgressCallback;
-        if (shouldReportProgress) {
-            const handleProgress = (_evt, data) => {
-                options?.downloadProgressCallback?.(data);
-            };
-            const removeProgressListener = IpcApp_1.IpcApp.addListener((0, core_common_1.getPullChangesIpcChannel)(this.iModelId), handleProgress);
-            removeListeners.push(removeProgressListener);
-        }
-        if (options?.abortSignal) {
-            const abort = () => void IpcApp_1.IpcApp.appFunctionIpc.cancelPullChangesRequest(this.key);
-            options?.abortSignal.addEventListener("abort", abort);
-            removeListeners.push(() => options?.abortSignal?.removeEventListener("abort", abort));
-        }
         this.requireTimeline();
+        const removeListeners = this.listenForChangesetDownloadProgress({
+            channel: (0, core_common_1.getPullChangesIpcChannel)(this.key),
+            cancel: async () => IpcApp_1.IpcApp.appFunctionIpc.cancelPullChangesRequest(this.key),
+            downloadProgressCallback: options?.downloadProgressCallback,
+            abortSignal: options?.abortSignal,
+        });
         const ipcAppOptions = {
-            reportProgress: shouldReportProgress,
+            reportProgress: !!options?.downloadProgressCallback,
             progressInterval: options?.progressInterval,
             enableCancellation: !!options?.abortSignal,
         };
@@ -289,18 +298,29 @@ class BriefcaseConnection extends IModelConnection_1.IModelConnection {
             this.changeset = await IpcApp_1.IpcApp.appFunctionIpc.pullChanges(this.key, toIndex, ipcAppOptions);
         }
         finally {
-            removeListeners.forEach((remove) => remove());
+            removeListeners();
         }
         await this.invalidateSchemaViewIfChanged();
     }
-    /** Create a changeset from local Txns and push to iModelHub. On success, clear Txn table.
-     * @param description The description for the changeset
-     * @returns the changesetId of the pushed changes
-     * @see [[BriefcaseTxns.onChangesPushed]] for the event dispatched after changes are pushed.
-     */
-    async pushChanges(description) {
+    async pushChanges(description, options) {
         this.requireTimeline();
-        return this.changeset = await IpcApp_1.IpcApp.appFunctionIpc.pushChanges(this.key, description);
+        const removeListeners = this.listenForChangesetDownloadProgress({
+            channel: (0, core_common_1.getPushChangesIpcChannel)(this.key),
+            cancel: async () => IpcApp_1.IpcApp.appFunctionIpc.cancelPushChangesRequest(this.key),
+            downloadProgressCallback: options?.downloadProgressCallback,
+            abortSignal: options?.abortSignal,
+        });
+        const ipcAppOptions = {
+            reportDownloadProgress: !!options?.downloadProgressCallback,
+            downloadProgressInterval: options?.downloadProgressInterval,
+            enableCancellation: !!options?.abortSignal,
+        };
+        try {
+            return this.changeset = await IpcApp_1.IpcApp.appFunctionIpc.pushChanges(this.key, description, ipcAppOptions);
+        }
+        finally {
+            removeListeners();
+        }
     }
     /** The current graphical editing scope, if one is in progress.
      * @see [[enterEditingScope]] to begin graphical editing.

package/lib/cjs/BriefcaseConnection.js.map

@@ -1 +1 @@
-{"version":3,"file":"BriefcaseConnection.js","sourceRoot":"","sources":["../../src/BriefcaseConnection.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAwI;AACxI,oDAG4B;AAC5B,mDAAgD;AAChD,mEAAgE;AAChE,2CAAwC;AACxC,yDAAsD;AACtD,qCAAkC;AAClC,8CAAqE;AACrE,yCAAsC;AA8CtC;;;GAGG;AACH,MAAM,kBAAkB;IACd,aAAa,CAAyB;IAC7B,UAAU,CAAsB;IAChC,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;IACnC,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC3C,SAAS,GAAmB,EAAE,CAAC;IAEhD,YAAmB,SAA8B;QAC/C,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,iCAAiC;QACjC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,EAAE;YAChF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBACtC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;YAClD,CAAC;QACH,CAAC,CAAC,CAAC,CAAC;QAEJ,8BAA8B;QAC9B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,EAAE;YACzE,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBACpB,KAAK,MAAM,EAAE,IAAI,gCAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC7D,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBAC/B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC,CAAC;QAEJ,gHAAgH;QAChH,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;YAC9B,IAAI,IAAI,CAAC,YAAY;gBACnB,OAAO;YAET,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC;YACxD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;gBACrB,MAAM,qBAAS,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAEtE,IAAI,CAAC,eAAe,EAAE,CAAC;QACzB,CAAC,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;QACrF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;QAC9E,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;IAChF,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS;YAClC,OAAO,EAAE,CAAC;QAEZ,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;QAE1B,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;YAChC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QACjC,CAAC;IACH,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC5B,IAAI,IAAI,CAAC,aAAa;YACpB,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;QAEvF,IAAI,CAAC,aAAa,GAAG,MAAM,6CAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAExE,MAAM,kBAAkB,GAAG,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,EAAE;YACtF,MAAM,QAAQ,GAAG,EAAE,CAAC;YACpB,KAAK,MAAM,MAAM,IAAI,OAAO;gBAC1B,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAE3B,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC5C,IAAA,qBAAM,EAAC,KAAK,KAAK,IAAI,CAAC,aAAa,CAAC,CAAC;YACrC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;YAC/B,kBAAkB,EAAE,CAAC;YACrB,IAAI,CAAC,eAAe,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEO,eAAe;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QACtC,KAAK,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,gBAAgB,CAAC;YACrD,IAAI,KAAK;gBACP,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC9B,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAS,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC;QAC7D,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YAC1C,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACtB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC;QAED,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAChC,IAAA,6CAAkC,EAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE9D,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE5D,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAC5B,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;IAEO,gBAAgB,CAAC,aAAmC;QAC1D,KAAK,MAAM,IAAI,IAAI,qBAAS,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;YACjD,IAAI,IAAI,YAAY,mBAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChE,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;oBACpC,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;wBAClC,IAAI,CAAC,eAAe,EAAE,CAAC;wBACvB,IAAI,CAAC,iCAAiC,EAAE,CAAC;wBACzC,MAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAqBD;;;;;;;GAOG;AACH,MAAa,2BAA2B;IAC9B,SAAS,CAAc;IACvB,MAAM,CAAc;IAE5B,sEAAsE;IACtD,iBAAiB,GAAG,IAAI,sBAAO,EAAsD,CAAC;IAEtG,mEAAmE;IACnD,cAAc,GAAG,IAAI,sBAAO,EAAmD,CAAC;IAEhG;;;;OAIG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IACD,IAAW,QAAQ,CAAC,QAAgC;QAClD,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC;QACvC,IAAI,QAAQ,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC/B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;YAC1B,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IACD,IAAW,KAAK,CAAC,KAA6B;QAC5C,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC;QACjC,IAAI,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;YACpB,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;CACF;AAzCD,kEAyCC;AAED;;;GAGG;AACH,MAAa,mBAAoB,SAAQ,mCAAgB;IAC7C,SAAS,CAAW;IACb,cAAc,CAAqB;IAC5C,MAAM,CAAe;IAE7B;;OAEG;IACa,WAAW,CAAU;IAErC;;OAEG;IACa,kBAAkB,GAAG,IAAI,2BAA2B,EAAE,CAAC;IAEvE,+FAA+F;IAC/E,IAAI,CAAgB;IAEpC;;;OAGG;IACH,IAAW,KAAK,KAA8B,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAEnD,qBAAqB,KAAkC,OAAO,IAAI,CAAC,CAAC,CAAC;IAErF,gEAAgE;IAChE,IAAoB,OAAO,KAAiB,OAAO,KAAK,CAAC,OAAO,IAAI,mBAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,oFAAoF;IAEtK,4CAA4C;IAC5C,IAAoB,QAAQ,KAAiB,OAAO,KAAK,CAAC,QAAQ,IAAI,mBAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,oFAAoF;IAExK,YAAsB,KAA+B,EAAE,QAAkB;QACvE,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,IAAI,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,cAAc,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,uBAAQ,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACvC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE,GAAG,MAAM,qBAAS,CAAC,SAAS,CAAC,oBAAoB,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3G,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC;IAUM,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,cAAkC,EAAE,kBAAuC;QACtG,MAAM,WAAW,GAAG,MAAM,eAAM,CAAC,cAAc,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QAC9E,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,EAAE,GAAG,cAAc,EAAE,GAAG,WAAW,EAAE,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,uBAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,uBAAQ,CAAC,SAAS,CAAC,CAAC;QACrI,IAAI,kBAAkB;YACpB,UAAU,CAAC,MAAM,GAAG,MAAM,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAE3D,mCAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAC/C,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,QAAgB,EAAE,WAAqB,uBAAQ,CAAC,SAAS,EAAE,IAA4B;QACxH,MAAM,YAAY,GAAG,MAAM,eAAM,CAAC,cAAc,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC1F,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QACpD,mCAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAC/C,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,2DAA2D;IAC3D,IAAW,QAAQ,KAAc,OAAO,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC;IAElE;;;OAGG;IACI,KAAK,CAAC,KAAK;QAChB,IAAI,IAAI,CAAC,QAAQ;YACf,OAAO;QAET,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAElC,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAE5B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,MAAM,eAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAES,eAAe;QACvB,IAAI,IAAI,CAAC,OAAO,KAAK,mBAAI,CAAC,KAAK;YAC7B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,WAAW,EAAE,wBAAwB,CAAC,CAAC;IAC9E,CAAC;IAED,2FAA2F;IACpF,KAAK,CAAC,cAAc;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;IACpC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW,CAAC,WAAoB;QAC3C,MAAM,eAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,uDAAuD;IACzH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc;QACzB,MAAM,eAAM,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,uDAAuD;IAC/G,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,OAA4B;QAC7E,MAAM,eAAe,GAAmB,EAAE,CAAC;QAC3C,MAAM,oBAAoB,GAAG,CAAC,CAAC,OAAO,EAAE,wBAAwB,CAAC;QAEjE,IAAI,oBAAoB,EAAE,CAAC;YACzB,MAAM,cAAc,GAAG,CAAC,IAAW,EAAE,IAAuC,EAAE,EAAE;gBAC9E,OAAO,EAAE,wBAAwB,EAAE,CAAC,IAAI,CAAC,CAAC;YAC5C,CAAC,CAAC;YAEF,MAAM,sBAAsB,GAAG,eAAM,CAAC,WAAW,CAC/C,IAAA,sCAAwB,EAAC,IAAI,CAAC,QAAQ,CAAC,EACvC,cAAc,CACf,CAAC;YACF,eAAe,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QAC/C,CAAC;QAED,IAAI,OAAO,EAAE,WAAW,EAAE,CAAC;YACzB,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,KAAK,eAAM,CAAC,cAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClF,OAAO,EAAE,WAAW,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACtD,eAAe,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QACxF,CAAC;QAED,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,MAAM,aAAa,GAA6B;YAC9C,cAAc,EAAE,oBAAoB;YACpC,gBAAgB,EAAE,OAAO,EAAE,gBAAgB;YAC3C,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,WAAW;SAC3C,CAAC;QACF,IAAI,CAAC;YACH,IAAI,CAAC,SAAS,GAAG,MAAM,eAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC;QAC7F,CAAC;gBAAS,CAAC;YACT,eAAe,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;QAChD,CAAC;QACD,MAAM,IAAI,CAAC,6BAA6B,EAAE,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CAAC,WAAmB;QAC1C,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC,SAAS,GAAG,MAAM,eAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,wBAAwB;QACnC,OAAO,eAAM,CAAC,cAAc,CAAC,2BAA2B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,iBAAiB;QAC5B,OAAO,IAAI,CAAC,cAAc,CAAC,iBAAiB,EAAE,CAAC;IACjD,CAAC;IAED;;OAEG;IACa,sBAAsB,GAAG,IAAI,sBAAO,EAA0C,CAAC;CAChG;AArMD,kDAqMC","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 IModelConnection\r\n */\r\n\r\nimport { assert, BeEvent, CompressedId64Set, Guid, GuidString, Id64Set, Id64String, IModelStatus, OpenMode } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseConnectionProps, ChangesetIndex, ChangesetIndexAndId, getPullChangesIpcChannel, IModelError,\r\n  PullChangesOptions as IpcAppPullChangesOptions, LockState, OpenBriefcaseProps, StandaloneOpenOptions,\r\n} from \"@itwin/core-common\";\r\nimport { BriefcaseTxns } from \"./BriefcaseTxns\";\r\nimport { GraphicalEditingScope } from \"./GraphicalEditingScope\";\r\nimport { IModelApp } from \"./IModelApp\";\r\nimport { IModelConnection } from \"./IModelConnection\";\r\nimport { IpcApp } from \"./IpcApp\";\r\nimport { disposeTileTreesForGeometricModels } from \"./tile/internal\";\r\nimport { Viewport } from \"./Viewport\";\r\n\r\n/**\r\n * Download progress information.\r\n * @public\r\n */\r\nexport interface DownloadProgressInfo {\r\n  /** Bytes downloaded. */\r\n  loaded: number;\r\n  /** Total size of the download in bytes. */\r\n  total: number;\r\n}\r\n\r\n/**\r\n * Called to show progress during a download.\r\n * @public\r\n */\r\nexport type OnDownloadProgress = (progress: DownloadProgressInfo) => void;\r\n\r\n/**\r\n * Partial interface of AbortSignal.\r\n * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal\r\n * @beta\r\n */\r\nexport interface GenericAbortSignal {\r\n  /** Add Listener for abort signal. */\r\n  addEventListener: (type: \"abort\", listener: (this: GenericAbortSignal, ev: any) => any) => void;\r\n  /** Remove Listener for abort signal. */\r\n  removeEventListener: (type: \"abort\", listener: (this: GenericAbortSignal, ev: any) => any) => void;\r\n}\r\n\r\n/**\r\n * Options for pulling iModel changes.\r\n * @public\r\n */\r\nexport interface PullChangesOptions {\r\n  /** Function called regularly to report progress of changes download. */\r\n  downloadProgressCallback?: OnDownloadProgress;\r\n  /** Interval for calling progress callback (in milliseconds). */\r\n  progressInterval?: number;\r\n  /** Signal for cancelling the download.\r\n   * @beta\r\n   */\r\n  abortSignal?: GenericAbortSignal;\r\n}\r\n\r\n/** Keeps track of changes to models, buffering them until synchronization points.\r\n * While a GraphicalEditingScope is open, the changes are buffered until the scope exits, at which point they are processed.\r\n * Otherwise, the buffered changes are processed after undo/redo, commit, or pull+merge changes.\r\n */\r\nclass ModelChangeMonitor {\r\n  private _editingScope?: GraphicalEditingScope;\r\n  private readonly _briefcase: BriefcaseConnection;\r\n  private readonly _deletedModels = new Set<string>();\r\n  private readonly _modelIdToGuid = new Map<string, string>();\r\n  private readonly _removals: VoidFunction[] = [];\r\n\r\n  public constructor(briefcase: BriefcaseConnection) {\r\n    this._briefcase = briefcase;\r\n\r\n    // Buffer updated geometry guids.\r\n    this._removals.push(briefcase.txns.onModelGeometryChanged.addListener((changes) => {\r\n      for (const change of changes) {\r\n        this._deletedModels.delete(change.id);\r\n        this._modelIdToGuid.set(change.id, change.guid);\r\n      }\r\n    }));\r\n\r\n    // Buffer deletions of models.\r\n    this._removals.push(briefcase.txns.onModelsChanged.addListener((changes) => {\r\n      if (changes.deleted) {\r\n        for (const id of CompressedId64Set.iterable(changes.deleted)) {\r\n          this._modelIdToGuid.delete(id);\r\n          this._deletedModels.add(id);\r\n        }\r\n      }\r\n    }));\r\n\r\n    // Outside of an editing scope, we want to update viewport contents after commit, undo/redo, or merging changes.\r\n    const maybeProcess = async () => {\r\n      if (this.editingScope)\r\n        return;\r\n\r\n      const modelIds = Array.from(this._modelIdToGuid.keys());\r\n      if (modelIds.length > 0)\r\n        await IModelApp.tileAdmin.purgeTileTrees(this._briefcase, modelIds);\r\n\r\n      this.processBuffered();\r\n    };\r\n\r\n    this._removals.push(briefcase.txns.onCommitted.addListener(maybeProcess));\r\n    this._removals.push(briefcase.txns.onReplayedExternalTxns.addListener(maybeProcess));\r\n    this._removals.push(briefcase.txns.onAfterUndoRedo.addListener(maybeProcess));\r\n    this._removals.push(briefcase.txns.onChangesPulled.addListener(maybeProcess));\r\n  }\r\n\r\n  public async close(): Promise<void> {\r\n    for (const removal of this._removals)\r\n      removal();\r\n\r\n    this._removals.length = 0;\r\n\r\n    if (this._editingScope) {\r\n      await this._editingScope.exit();\r\n      this._editingScope = undefined;\r\n    }\r\n  }\r\n\r\n  public get editingScope(): GraphicalEditingScope | undefined {\r\n    return this._editingScope;\r\n  }\r\n\r\n  public async enterEditingScope(): Promise<GraphicalEditingScope> {\r\n    if (this._editingScope)\r\n      throw new Error(\"Cannot create an editing scope for an iModel that already has one\");\r\n\r\n    this._editingScope = await GraphicalEditingScope.enter(this._briefcase);\r\n\r\n    const removeGeomListener = this._editingScope.onGeometryChanges.addListener((changes) => {\r\n      const modelIds = [];\r\n      for (const change of changes)\r\n        modelIds.push(change.id);\r\n\r\n      this.invalidateScenes(modelIds);\r\n    });\r\n\r\n    this._editingScope.onExited.addOnce((scope) => {\r\n      assert(scope === this._editingScope);\r\n      this._editingScope = undefined;\r\n      removeGeomListener();\r\n      this.processBuffered();\r\n    });\r\n\r\n    return this._editingScope;\r\n  }\r\n\r\n  private processBuffered(): void {\r\n    const models = this._briefcase.models;\r\n    for (const [id, guid] of this._modelIdToGuid) {\r\n      const model = models.getLoaded(id)?.asGeometricModel;\r\n      if (model)\r\n        model.geometryGuid = guid;\r\n    }\r\n\r\n    const modelIds = new Set<string>(this._modelIdToGuid.keys());\r\n    for (const deleted of this._deletedModels) {\r\n      modelIds.add(deleted);\r\n      models.unload(deleted);\r\n    }\r\n\r\n    this.invalidateScenes(modelIds);\r\n    disposeTileTreesForGeometricModels(modelIds, this._briefcase);\r\n\r\n    this._briefcase.onBufferedModelChanges.raiseEvent(modelIds);\r\n\r\n    this._modelIdToGuid.clear();\r\n    this._deletedModels.clear();\r\n  }\r\n\r\n  private invalidateScenes(changedModels: Iterable<Id64String>): void {\r\n    for (const user of IModelApp.tileAdmin.tileUsers) {\r\n      if (user instanceof Viewport && user.iModel === this._briefcase) {\r\n        for (const modelId of changedModels) {\r\n          if (user.view.viewsModel(modelId)) {\r\n            user.invalidateScene();\r\n            user.setFeatureOverrideProviderChanged();\r\n            break;\r\n          }\r\n        }\r\n      }\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * Provides access to lock information in the iModel.\r\n * @see [[BriefcaseConnection.locks]]\r\n * @alpha\r\n */\r\nexport interface LockService {\r\n  /** Get all elements with exclusive locks owned by other briefcases. */\r\n  getExclusiveForeignLocks(): Promise<Id64Set>;\r\n  /** Get all elements with shared locks owned by other briefcases. */\r\n  getSharedForeignLocks(): Promise<Id64Set>;\r\n  /** Check whether it's possible to acquire a lock for the element. */\r\n  checkElementLockAvailability(elementId: Id64String, lock: LockState): Promise<boolean>;\r\n}\r\n\r\n/** Function for creating a [[LockService]] for a [[BriefcaseConnection]].\r\n * @alpha\r\n */\r\nexport type LockServiceFactory = (iModel: BriefcaseConnection) => Promise<LockService>;\r\n\r\n/** Settings that can be used to control the behavior of [[Tool]]s that modify a [[BriefcaseConnection]].\r\n * For example, tools that want to create new elements can consult the briefcase's editor tool settings to\r\n * determine into which model and category to insert the elements.\r\n * Specialized tools are free to ignore these settings.\r\n * @see [[BriefcaseConnection.editorToolSettings]] to query or modify the current settings for a briefcase.\r\n * @see [CreateElementTool]($editor-frontend) for an example of a tool that uses these settings.\r\n * @beta\r\n */\r\nexport class BriefcaseEditorToolSettings {\r\n  private _category?: Id64String;\r\n  private _model?: Id64String;\r\n\r\n  /** An event raised just after the default [[category]] is changed. */\r\n  public readonly onCategoryChanged = new BeEvent<(previousCategory: Id64String | undefined) => void>();\r\n\r\n  /** An event raised just after the default [[model]] is changed. */\r\n  public readonly onModelChanged = new BeEvent<(previousModel: Id64String | undefined) => void>();\r\n\r\n  /** The [Category]($backend) into which new elements should be inserted by default.\r\n   * Specialized tools are free to ignore this setting and instead use their own logic to select an appropriate category.\r\n   * @see [[onCategoryChanged]] to be notified when this property is modified.\r\n   * @see [CreateElementTool.targetCategory]($editor-frontend) for an example of a tool that uses this setting.\r\n   */\r\n  public get category(): Id64String | undefined {\r\n    return this._category;\r\n  }\r\n  public set category(category: Id64String | undefined) {\r\n    const previousCategory = this.category;\r\n    if (category !== this.category) {\r\n      this._category = category;\r\n      this.onCategoryChanged.raiseEvent(previousCategory);\r\n    }\r\n  }\r\n\r\n  /** The [Model]($backend) into which new elements should be inserted by default.\r\n   * Specialized tools are free to ignore this setting and instead use their own logic to select an appropriate model.\r\n   * @see [[onModelChanged]] to be notified when this property is modified.\r\n   * @see [CreateElementTool.targetModelId]($editor-frontend) for an example of a tool that uses this setting.\r\n   */\r\n  public get model(): Id64String | undefined {\r\n    return this._model;\r\n  }\r\n  public set model(model: Id64String | undefined) {\r\n    const previousModel = this.model;\r\n    if (model !== this.model) {\r\n      this._model = model;\r\n      this.onModelChanged.raiseEvent(previousModel);\r\n    }\r\n  }\r\n}\r\n\r\n/** A connection to an editable briefcase on the backend. This class uses [Ipc]($docs/learning/IpcInterface.md) to communicate\r\n * to the backend and may only be used by [[IpcApp]]s.\r\n * @public\r\n */\r\nexport class BriefcaseConnection extends IModelConnection {\r\n  protected _isClosed?: boolean;\r\n  private readonly _modelsMonitor: ModelChangeMonitor;\r\n  private _locks?: LockService;\r\n\r\n  /** The ID of the briefcase.\r\n   * @beta\r\n   */\r\n  public readonly briefcaseId?: number;\r\n\r\n  /** Default settings that can be used to control the behavior of [[Tool]]s that modify this briefcase.\r\n   * @beta\r\n   */\r\n  public readonly editorToolSettings = new BriefcaseEditorToolSettings();\r\n\r\n  /** Manages local changes to the briefcase via [Txns]($docs/learning/InteractiveEditing.md). */\r\n  public readonly txns: BriefcaseTxns;\r\n\r\n  /** Information about locks held on this iModel.\r\n   * @note This is intended to be used by tools and other UI elements, to provide information about the current lock state. Implementations are expected to cache lock information and so may not reflect changes to locks immediately.\r\n   * @alpha\r\n   */\r\n  public get locks(): LockService | undefined { return this._locks; }\r\n\r\n  public override isBriefcaseConnection(): this is BriefcaseConnection { return true; }\r\n\r\n  /** The Guid that identifies the iTwin that owns this iModel. */\r\n  public override get iTwinId(): GuidString { return super.iTwinId ?? Guid.empty; } // GuidString | undefined for IModelConnection, but required for BriefcaseConnection\r\n\r\n  /** The Guid that identifies this iModel. */\r\n  public override get iModelId(): GuidString { return super.iModelId ?? Guid.empty; } // GuidString | undefined for IModelConnection, but required for BriefcaseConnection\r\n\r\n  protected constructor(props: BriefcaseConnectionProps, openMode: OpenMode) {\r\n    super(props);\r\n    this._openMode = openMode;\r\n    this.briefcaseId = props.briefcaseId;\r\n    this.txns = new BriefcaseTxns(this);\r\n    this._modelsMonitor = new ModelChangeMonitor(this);\r\n    if (OpenMode.ReadWrite === this._openMode)\r\n      this.txns.onAfterUndoRedo.addListener(async () => { await IModelApp.toolAdmin.restartPrimitiveTool(); });\r\n\r\n    this.categories.cache.attachToBriefcase(this);\r\n  }\r\n\r\n  /** Open a BriefcaseConnection to a [BriefcaseDb]($backend). */\r\n  public static async openFile(briefcaseProps: OpenBriefcaseProps): Promise<BriefcaseConnection>;\r\n\r\n  /** Open a BriefcaseConnection to a [BriefcaseDb]($backend).\r\n   * @alpha\r\n   */\r\n  public static async openFile(briefcaseProps: OpenBriefcaseProps, lockServiceFactory?: LockServiceFactory): Promise<BriefcaseConnection>\r\n\r\n  public static async openFile(briefcaseProps: OpenBriefcaseProps, lockServiceFactory?: LockServiceFactory): Promise<BriefcaseConnection> {\r\n    const iModelProps = await IpcApp.appFunctionIpc.openBriefcase(briefcaseProps);\r\n    const connection = new this({ ...briefcaseProps, ...iModelProps }, briefcaseProps.readonly ? OpenMode.Readonly : OpenMode.ReadWrite);\r\n    if (lockServiceFactory)\r\n      connection._locks = await lockServiceFactory(connection);\r\n\r\n    IModelConnection.onOpen.raiseEvent(connection);\r\n    return connection;\r\n  }\r\n\r\n  /** Open a BriefcaseConnection to a [StandaloneDb]($backend)\r\n   * @note StandaloneDbs, by definition, may not push or pull changes. Attempting to do so will throw exceptions.\r\n   */\r\n  public static async openStandalone(filePath: string, openMode: OpenMode = OpenMode.ReadWrite, opts?: StandaloneOpenOptions): Promise<BriefcaseConnection> {\r\n    const openResponse = await IpcApp.appFunctionIpc.openStandalone(filePath, openMode, opts);\r\n    const connection = new this(openResponse, openMode);\r\n    IModelConnection.onOpen.raiseEvent(connection);\r\n    return connection;\r\n  }\r\n\r\n  /** Returns `true` if [[close]] has already been called. */\r\n  public get isClosed(): boolean { return this._isClosed === true; }\r\n\r\n  /**\r\n   * Close this BriefcaseConnection.\r\n   * @note make sure to call [[saveChanges]] before calling this method. Unsaved local changes are abandoned.\r\n   */\r\n  public async close(): Promise<void> {\r\n    if (this.isClosed)\r\n      return;\r\n\r\n    await this._modelsMonitor.close();\r\n\r\n    this.beforeClose();\r\n    this.txns[Symbol.dispose]();\r\n\r\n    this._isClosed = true;\r\n    await IpcApp.appFunctionIpc.closeIModel(this._fileKey);\r\n  }\r\n\r\n  protected requireTimeline() {\r\n    if (this.iTwinId === Guid.empty)\r\n      throw new IModelError(IModelStatus.WrongIModel, \"iModel has no timeline\");\r\n  }\r\n\r\n  /** Query if there are any pending Txns in this briefcase that are waiting to be pushed. */\r\n  public async hasPendingTxns(): Promise<boolean> { // eslint-disable-line @itwin/prefer-get\r\n    return this.txns.hasPendingTxns();\r\n  }\r\n\r\n  /** Commit pending changes to this briefcase.\r\n   * @param description Optional description of the changes.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use methods on EditCommand instead.\r\n   */\r\n  public async saveChanges(description?: string): Promise<void> {\r\n    await IpcApp.appFunctionIpc.saveChanges(this.key, description); // eslint-disable-line @typescript-eslint/no-deprecated\r\n  }\r\n\r\n  /** Abandon pending changes to this briefcase.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use methods on EditCommand instead.\r\n   */\r\n  public async abandonChanges(): Promise<void> {\r\n    await IpcApp.appFunctionIpc.abandonChanges(this.key); // eslint-disable-line @typescript-eslint/no-deprecated\r\n  }\r\n\r\n  /** Pull (and potentially merge if there are local changes) up to a specified changeset from iModelHub into this briefcase\r\n   * @param toIndex The changeset index to pull changes to. If `undefined`, pull all changes.\r\n   * @param options Options for pulling changes.\r\n   * @see [[BriefcaseTxns.onChangesPulled]] for the event dispatched after changes are pulled.\r\n   */\r\n  public async pullChanges(toIndex?: ChangesetIndex, options?: PullChangesOptions): Promise<void> {\r\n    const removeListeners: VoidFunction[] = [];\r\n    const shouldReportProgress = !!options?.downloadProgressCallback;\r\n\r\n    if (shouldReportProgress) {\r\n      const handleProgress = (_evt: Event, data: { loaded: number, total: number }) => {\r\n        options?.downloadProgressCallback?.(data);\r\n      };\r\n\r\n      const removeProgressListener = IpcApp.addListener(\r\n        getPullChangesIpcChannel(this.iModelId),\r\n        handleProgress,\r\n      );\r\n      removeListeners.push(removeProgressListener);\r\n    }\r\n\r\n    if (options?.abortSignal) {\r\n      const abort = () => void IpcApp.appFunctionIpc.cancelPullChangesRequest(this.key);\r\n      options?.abortSignal.addEventListener(\"abort\", abort);\r\n      removeListeners.push(() => options?.abortSignal?.removeEventListener(\"abort\", abort));\r\n    }\r\n\r\n    this.requireTimeline();\r\n    const ipcAppOptions: IpcAppPullChangesOptions = {\r\n      reportProgress: shouldReportProgress,\r\n      progressInterval: options?.progressInterval,\r\n      enableCancellation: !!options?.abortSignal,\r\n    };\r\n    try {\r\n      this.changeset = await IpcApp.appFunctionIpc.pullChanges(this.key, toIndex, ipcAppOptions);\r\n    } finally {\r\n      removeListeners.forEach((remove) => remove());\r\n    }\r\n    await this.invalidateSchemaViewIfChanged();\r\n  }\r\n\r\n  /** Create a changeset from local Txns and push to iModelHub. On success, clear Txn table.\r\n   * @param description The description for the changeset\r\n   * @returns the changesetId of the pushed changes\r\n   * @see [[BriefcaseTxns.onChangesPushed]] for the event dispatched after changes are pushed.\r\n   */\r\n  public async pushChanges(description: string): Promise<ChangesetIndexAndId> {\r\n    this.requireTimeline();\r\n    return this.changeset = await IpcApp.appFunctionIpc.pushChanges(this.key, description);\r\n  }\r\n\r\n  /** The current graphical editing scope, if one is in progress.\r\n   * @see [[enterEditingScope]] to begin graphical editing.\r\n   */\r\n  public get editingScope(): GraphicalEditingScope | undefined {\r\n    return this._modelsMonitor.editingScope;\r\n  }\r\n\r\n  /** Return whether graphical editing is supported for this briefcase. It is not supported if the briefcase is read-only, or the briefcase contains a version of\r\n   * the BisCore ECSchema older than v0.1.11.\r\n   * @see [[enterEditingScope]] to enable graphical editing.\r\n   */\r\n  public async supportsGraphicalEditing(): Promise<boolean> {\r\n    return IpcApp.appFunctionIpc.isGraphicalEditingSupported(this.key);\r\n  }\r\n\r\n  /** Begin a new graphical editing scope.\r\n   * @throws Error if an editing scope already exists or one could not be created.\r\n   * @see [[GraphicalEditingScope.exit]] to exit the scope.\r\n   * @see [[supportsGraphicalEditing]] to determine whether this method should be expected to succeed.\r\n   * @see [[editingScope]] to obtain the current editing scope, if one is in progress.\r\n   */\r\n  public async enterEditingScope(): Promise<GraphicalEditingScope> {\r\n    return this._modelsMonitor.enterEditingScope();\r\n  }\r\n\r\n  /** Strictly for tests - dispatched from ModelChangeMonitor.processBuffered.\r\n   * @internal\r\n   */\r\n  public readonly onBufferedModelChanges = new BeEvent<(changedModelIds: Set<string>) => void>();\r\n}\r\n"]}
+{"version":3,"file":"BriefcaseConnection.js","sourceRoot":"","sources":["../../src/BriefcaseConnection.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAwI;AACxI,oDAG4B;AAC5B,mDAAgD;AAChD,mEAAgE;AAChE,2CAAwC;AACxC,yDAAsD;AACtD,qCAAkC;AAClC,8CAAqE;AACrE,yCAAsC;AA8DtC;;;GAGG;AACH,MAAM,kBAAkB;IACd,aAAa,CAAyB;IAC7B,UAAU,CAAsB;IAChC,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;IACnC,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC3C,SAAS,GAAmB,EAAE,CAAC;IAEhD,YAAmB,SAA8B;QAC/C,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,iCAAiC;QACjC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,EAAE;YAChF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBACtC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;YAClD,CAAC;QACH,CAAC,CAAC,CAAC,CAAC;QAEJ,8BAA8B;QAC9B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,EAAE;YACzE,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBACpB,KAAK,MAAM,EAAE,IAAI,gCAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC7D,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBAC/B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC,CAAC;QAEJ,gHAAgH;QAChH,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;YAC9B,IAAI,IAAI,CAAC,YAAY;gBACnB,OAAO;YAET,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC;YACxD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;gBACrB,MAAM,qBAAS,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAEtE,IAAI,CAAC,eAAe,EAAE,CAAC;QACzB,CAAC,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;QACrF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;QAC9E,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;IAChF,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS;YAClC,OAAO,EAAE,CAAC;QAEZ,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;QAE1B,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;YAChC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QACjC,CAAC;IACH,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC5B,IAAI,IAAI,CAAC,aAAa;YACpB,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;QAEvF,IAAI,CAAC,aAAa,GAAG,MAAM,6CAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAExE,MAAM,kBAAkB,GAAG,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,EAAE;YACtF,MAAM,QAAQ,GAAG,EAAE,CAAC;YACpB,KAAK,MAAM,MAAM,IAAI,OAAO;gBAC1B,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAE3B,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC5C,IAAA,qBAAM,EAAC,KAAK,KAAK,IAAI,CAAC,aAAa,CAAC,CAAC;YACrC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;YAC/B,kBAAkB,EAAE,CAAC;YACrB,IAAI,CAAC,eAAe,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEO,eAAe;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QACtC,KAAK,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,gBAAgB,CAAC;YACrD,IAAI,KAAK;gBACP,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC9B,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAS,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC;QAC7D,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YAC1C,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACtB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC;QAED,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAChC,IAAA,6CAAkC,EAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE9D,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE5D,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAC5B,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;IAEO,gBAAgB,CAAC,aAAmC;QAC1D,KAAK,MAAM,IAAI,IAAI,qBAAS,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;YACjD,IAAI,IAAI,YAAY,mBAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChE,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;oBACpC,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;wBAClC,IAAI,CAAC,eAAe,EAAE,CAAC;wBACvB,IAAI,CAAC,iCAAiC,EAAE,CAAC;wBACzC,MAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAqBD;;;;;;;GAOG;AACH,MAAa,2BAA2B;IAC9B,SAAS,CAAc;IACvB,MAAM,CAAc;IAE5B,sEAAsE;IACtD,iBAAiB,GAAG,IAAI,sBAAO,EAAsD,CAAC;IAEtG,mEAAmE;IACnD,cAAc,GAAG,IAAI,sBAAO,EAAmD,CAAC;IAEhG;;;;OAIG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IACD,IAAW,QAAQ,CAAC,QAAgC;QAClD,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC;QACvC,IAAI,QAAQ,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC/B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;YAC1B,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IACD,IAAW,KAAK,CAAC,KAA6B;QAC5C,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC;QACjC,IAAI,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;YACpB,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;CACF;AAzCD,kEAyCC;AAED;;;GAGG;AACH,MAAa,mBAAoB,SAAQ,mCAAgB;IAC7C,SAAS,CAAW;IACb,cAAc,CAAqB;IAC5C,MAAM,CAAe;IAE7B;;OAEG;IACa,WAAW,CAAU;IAErC;;OAEG;IACa,kBAAkB,GAAG,IAAI,2BAA2B,EAAE,CAAC;IAEvE,+FAA+F;IAC/E,IAAI,CAAgB;IAEpC;;;OAGG;IACH,IAAW,KAAK,KAA8B,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAEnD,qBAAqB,KAAkC,OAAO,IAAI,CAAC,CAAC,CAAC;IAErF,gEAAgE;IAChE,IAAoB,OAAO,KAAiB,OAAO,KAAK,CAAC,OAAO,IAAI,mBAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,oFAAoF;IAEtK,4CAA4C;IAC5C,IAAoB,QAAQ,KAAiB,OAAO,KAAK,CAAC,QAAQ,IAAI,mBAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,oFAAoF;IAExK,YAAsB,KAA+B,EAAE,QAAkB;QACvE,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,IAAI,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,cAAc,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,uBAAQ,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACvC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE,GAAG,MAAM,qBAAS,CAAC,SAAS,CAAC,oBAAoB,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3G,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC;IAUM,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,cAAkC,EAAE,kBAAuC;QACtG,MAAM,WAAW,GAAG,MAAM,eAAM,CAAC,cAAc,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QAC9E,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,EAAE,GAAG,cAAc,EAAE,GAAG,WAAW,EAAE,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,uBAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,uBAAQ,CAAC,SAAS,CAAC,CAAC;QACrI,IAAI,kBAAkB;YACpB,UAAU,CAAC,MAAM,GAAG,MAAM,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAE3D,mCAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAC/C,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,QAAgB,EAAE,WAAqB,uBAAQ,CAAC,SAAS,EAAE,IAA4B;QACxH,MAAM,YAAY,GAAG,MAAM,eAAM,CAAC,cAAc,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC1F,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QACpD,mCAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAC/C,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,2DAA2D;IAC3D,IAAW,QAAQ,KAAc,OAAO,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC;IAElE;;;OAGG;IACI,KAAK,CAAC,KAAK;QAChB,IAAI,IAAI,CAAC,QAAQ;YACf,OAAO;QAET,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAElC,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAE5B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,MAAM,eAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAES,eAAe;QACvB,IAAI,IAAI,CAAC,OAAO,KAAK,mBAAI,CAAC,KAAK;YAC7B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,WAAW,EAAE,wBAAwB,CAAC,CAAC;IAC9E,CAAC;IAED,2FAA2F;IACpF,KAAK,CAAC,cAAc;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;IACpC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW,CAAC,WAAoB;QAC3C,MAAM,eAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,uDAAuD;IACzH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc;QACzB,MAAM,eAAM,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,uDAAuD;IAC/G,CAAC;IAED;;OAEG;IACK,kCAAkC,CAAC,IAK1C;QACC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,wBAAwB,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QACxE,MAAM,eAAe,GAAmB,EAAE,CAAC;QAE3C,IAAI,wBAAwB,EAAE,CAAC;YAC7B,MAAM,cAAc,GAAG,CAAC,IAAW,EAAE,IAA0B,EAAE,EAAE,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;YACnG,eAAe,CAAC,IAAI,CAAC,eAAM,CAAC,WAAW,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC;QACpE,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,KAAK,MAAM,EAAE,CAAC;YAClC,WAAW,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC7C,eAAe,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QAC9E,CAAC;QAED,OAAO,GAAG,EAAE,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,OAA4B;QAC7E,IAAI,CAAC,eAAe,EAAE,CAAC;QAEvB,MAAM,eAAe,GAAG,IAAI,CAAC,kCAAkC,CAAC;YAC9D,OAAO,EAAE,IAAA,sCAAwB,EAAC,IAAI,CAAC,GAAG,CAAC;YAC3C,MAAM,EAAE,KAAK,IAAI,EAAE,CAAC,eAAM,CAAC,cAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,GAAG,CAAC;YAC5E,wBAAwB,EAAE,OAAO,EAAE,wBAAwB;YAC3D,WAAW,EAAE,OAAO,EAAE,WAAW;SAClC,CAAC,CAAC;QAEH,MAAM,aAAa,GAA6B;YAC9C,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE,wBAAwB;YACnD,gBAAgB,EAAE,OAAO,EAAE,gBAAgB;YAC3C,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,WAAW;SAC3C,CAAC;QACF,IAAI,CAAC;YACH,IAAI,CAAC,SAAS,GAAG,MAAM,eAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC;QAC7F,CAAC;gBAAS,CAAC;YACT,eAAe,EAAE,CAAC;QACpB,CAAC;QACD,MAAM,IAAI,CAAC,6BAA6B,EAAE,CAAC;IAC7C,CAAC;IAqBM,KAAK,CAAC,WAAW,CAAC,WAAmB,EAAE,OAA4B;QACxE,IAAI,CAAC,eAAe,EAAE,CAAC;QAEvB,MAAM,eAAe,GAAG,IAAI,CAAC,kCAAkC,CAAC;YAC9D,OAAO,EAAE,IAAA,sCAAwB,EAAC,IAAI,CAAC,GAAG,CAAC;YAC3C,MAAM,EAAE,KAAK,IAAI,EAAE,CAAC,eAAM,CAAC,cAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,GAAG,CAAC;YAC5E,wBAAwB,EAAE,OAAO,EAAE,wBAAwB;YAC3D,WAAW,EAAE,OAAO,EAAE,WAAW;SAClC,CAAC,CAAC;QAEH,MAAM,aAAa,GAA6B;YAC9C,sBAAsB,EAAE,CAAC,CAAC,OAAO,EAAE,wBAAwB;YAC3D,wBAAwB,EAAE,OAAO,EAAE,wBAAwB;YAC3D,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,WAAW;SAC3C,CAAC;QACF,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,SAAS,GAAG,MAAM,eAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;QACxG,CAAC;gBAAS,CAAC;YACT,eAAe,EAAE,CAAC;QACpB,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,wBAAwB;QACnC,OAAO,eAAM,CAAC,cAAc,CAAC,2BAA2B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,iBAAiB;QAC5B,OAAO,IAAI,CAAC,cAAc,CAAC,iBAAiB,EAAE,CAAC;IACjD,CAAC;IAED;;OAEG;IACa,sBAAsB,GAAG,IAAI,sBAAO,EAA0C,CAAC;CAChG;AAjPD,kDAiPC","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 IModelConnection\r\n */\r\n\r\nimport { assert, BeEvent, CompressedId64Set, Guid, GuidString, Id64Set, Id64String, IModelStatus, OpenMode } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseConnectionProps, ChangesetIndex, ChangesetIndexAndId, getPullChangesIpcChannel, getPushChangesIpcChannel, IModelError,\r\n  PullChangesOptions as IpcAppPullChangesOptions, PushChangesOptions as IpcAppPushChangesOptions, LockState, OpenBriefcaseProps, StandaloneOpenOptions,\r\n} from \"@itwin/core-common\";\r\nimport { BriefcaseTxns } from \"./BriefcaseTxns\";\r\nimport { GraphicalEditingScope } from \"./GraphicalEditingScope\";\r\nimport { IModelApp } from \"./IModelApp\";\r\nimport { IModelConnection } from \"./IModelConnection\";\r\nimport { IpcApp } from \"./IpcApp\";\r\nimport { disposeTileTreesForGeometricModels } from \"./tile/internal\";\r\nimport { Viewport } from \"./Viewport\";\r\n\r\n/**\r\n * Download progress information.\r\n * @public\r\n */\r\nexport interface DownloadProgressInfo {\r\n  /** Bytes downloaded. */\r\n  loaded: number;\r\n  /** Total size of the download in bytes. */\r\n  total: number;\r\n}\r\n\r\n/**\r\n * Called to show progress during a download.\r\n * @public\r\n */\r\nexport type OnDownloadProgress = (progress: DownloadProgressInfo) => void;\r\n\r\n/**\r\n * Partial interface of AbortSignal.\r\n * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal\r\n * @beta\r\n */\r\nexport interface GenericAbortSignal {\r\n  /** Add Listener for abort signal. */\r\n  addEventListener: (type: \"abort\", listener: (this: GenericAbortSignal, ev: any) => any) => void;\r\n  /** Remove Listener for abort signal. */\r\n  removeEventListener: (type: \"abort\", listener: (this: GenericAbortSignal, ev: any) => any) => void;\r\n}\r\n\r\n/**\r\n * Options for pulling iModel changes.\r\n * @public\r\n */\r\nexport interface PullChangesOptions {\r\n  /** Function called regularly to report progress of changes download. */\r\n  downloadProgressCallback?: OnDownloadProgress;\r\n  /** Interval for calling progress callback (in milliseconds). */\r\n  progressInterval?: number;\r\n  /** Signal for cancelling the download.\r\n   * @beta\r\n   */\r\n  abortSignal?: GenericAbortSignal;\r\n}\r\n\r\n/**\r\n * Options for pushing iModel changes.\r\n * @beta\r\n */\r\nexport interface PushChangesOptions {\r\n  /** Function called regularly to report progress of the download of the changes that must be merged before pushing. */\r\n  downloadProgressCallback?: OnDownloadProgress;\r\n  /** Interval for calling [[downloadProgressCallback]] (in milliseconds). */\r\n  downloadProgressInterval?: number;\r\n  /** Signal for cancelling the push.\r\n   * @note Currently this only cancels the download of the changes that must be merged before pushing - it has no effect once the local\r\n   * changeset is being uploaded.\r\n   */\r\n  abortSignal?: GenericAbortSignal;\r\n}\r\n\r\n/** Keeps track of changes to models, buffering them until synchronization points.\r\n * While a GraphicalEditingScope is open, the changes are buffered until the scope exits, at which point they are processed.\r\n * Otherwise, the buffered changes are processed after undo/redo, commit, or pull+merge changes.\r\n */\r\nclass ModelChangeMonitor {\r\n  private _editingScope?: GraphicalEditingScope;\r\n  private readonly _briefcase: BriefcaseConnection;\r\n  private readonly _deletedModels = new Set<string>();\r\n  private readonly _modelIdToGuid = new Map<string, string>();\r\n  private readonly _removals: VoidFunction[] = [];\r\n\r\n  public constructor(briefcase: BriefcaseConnection) {\r\n    this._briefcase = briefcase;\r\n\r\n    // Buffer updated geometry guids.\r\n    this._removals.push(briefcase.txns.onModelGeometryChanged.addListener((changes) => {\r\n      for (const change of changes) {\r\n        this._deletedModels.delete(change.id);\r\n        this._modelIdToGuid.set(change.id, change.guid);\r\n      }\r\n    }));\r\n\r\n    // Buffer deletions of models.\r\n    this._removals.push(briefcase.txns.onModelsChanged.addListener((changes) => {\r\n      if (changes.deleted) {\r\n        for (const id of CompressedId64Set.iterable(changes.deleted)) {\r\n          this._modelIdToGuid.delete(id);\r\n          this._deletedModels.add(id);\r\n        }\r\n      }\r\n    }));\r\n\r\n    // Outside of an editing scope, we want to update viewport contents after commit, undo/redo, or merging changes.\r\n    const maybeProcess = async () => {\r\n      if (this.editingScope)\r\n        return;\r\n\r\n      const modelIds = Array.from(this._modelIdToGuid.keys());\r\n      if (modelIds.length > 0)\r\n        await IModelApp.tileAdmin.purgeTileTrees(this._briefcase, modelIds);\r\n\r\n      this.processBuffered();\r\n    };\r\n\r\n    this._removals.push(briefcase.txns.onCommitted.addListener(maybeProcess));\r\n    this._removals.push(briefcase.txns.onReplayedExternalTxns.addListener(maybeProcess));\r\n    this._removals.push(briefcase.txns.onAfterUndoRedo.addListener(maybeProcess));\r\n    this._removals.push(briefcase.txns.onChangesPulled.addListener(maybeProcess));\r\n  }\r\n\r\n  public async close(): Promise<void> {\r\n    for (const removal of this._removals)\r\n      removal();\r\n\r\n    this._removals.length = 0;\r\n\r\n    if (this._editingScope) {\r\n      await this._editingScope.exit();\r\n      this._editingScope = undefined;\r\n    }\r\n  }\r\n\r\n  public get editingScope(): GraphicalEditingScope | undefined {\r\n    return this._editingScope;\r\n  }\r\n\r\n  public async enterEditingScope(): Promise<GraphicalEditingScope> {\r\n    if (this._editingScope)\r\n      throw new Error(\"Cannot create an editing scope for an iModel that already has one\");\r\n\r\n    this._editingScope = await GraphicalEditingScope.enter(this._briefcase);\r\n\r\n    const removeGeomListener = this._editingScope.onGeometryChanges.addListener((changes) => {\r\n      const modelIds = [];\r\n      for (const change of changes)\r\n        modelIds.push(change.id);\r\n\r\n      this.invalidateScenes(modelIds);\r\n    });\r\n\r\n    this._editingScope.onExited.addOnce((scope) => {\r\n      assert(scope === this._editingScope);\r\n      this._editingScope = undefined;\r\n      removeGeomListener();\r\n      this.processBuffered();\r\n    });\r\n\r\n    return this._editingScope;\r\n  }\r\n\r\n  private processBuffered(): void {\r\n    const models = this._briefcase.models;\r\n    for (const [id, guid] of this._modelIdToGuid) {\r\n      const model = models.getLoaded(id)?.asGeometricModel;\r\n      if (model)\r\n        model.geometryGuid = guid;\r\n    }\r\n\r\n    const modelIds = new Set<string>(this._modelIdToGuid.keys());\r\n    for (const deleted of this._deletedModels) {\r\n      modelIds.add(deleted);\r\n      models.unload(deleted);\r\n    }\r\n\r\n    this.invalidateScenes(modelIds);\r\n    disposeTileTreesForGeometricModels(modelIds, this._briefcase);\r\n\r\n    this._briefcase.onBufferedModelChanges.raiseEvent(modelIds);\r\n\r\n    this._modelIdToGuid.clear();\r\n    this._deletedModels.clear();\r\n  }\r\n\r\n  private invalidateScenes(changedModels: Iterable<Id64String>): void {\r\n    for (const user of IModelApp.tileAdmin.tileUsers) {\r\n      if (user instanceof Viewport && user.iModel === this._briefcase) {\r\n        for (const modelId of changedModels) {\r\n          if (user.view.viewsModel(modelId)) {\r\n            user.invalidateScene();\r\n            user.setFeatureOverrideProviderChanged();\r\n            break;\r\n          }\r\n        }\r\n      }\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * Provides access to lock information in the iModel.\r\n * @see [[BriefcaseConnection.locks]]\r\n * @alpha\r\n */\r\nexport interface LockService {\r\n  /** Get all elements with exclusive locks owned by other briefcases. */\r\n  getExclusiveForeignLocks(): Promise<Id64Set>;\r\n  /** Get all elements with shared locks owned by other briefcases. */\r\n  getSharedForeignLocks(): Promise<Id64Set>;\r\n  /** Check whether it's possible to acquire a lock for the element. */\r\n  checkElementLockAvailability(elementId: Id64String, lock: LockState): Promise<boolean>;\r\n}\r\n\r\n/** Function for creating a [[LockService]] for a [[BriefcaseConnection]].\r\n * @alpha\r\n */\r\nexport type LockServiceFactory = (iModel: BriefcaseConnection) => Promise<LockService>;\r\n\r\n/** Settings that can be used to control the behavior of [[Tool]]s that modify a [[BriefcaseConnection]].\r\n * For example, tools that want to create new elements can consult the briefcase's editor tool settings to\r\n * determine into which model and category to insert the elements.\r\n * Specialized tools are free to ignore these settings.\r\n * @see [[BriefcaseConnection.editorToolSettings]] to query or modify the current settings for a briefcase.\r\n * @see [CreateElementTool]($editor-frontend) for an example of a tool that uses these settings.\r\n * @beta\r\n */\r\nexport class BriefcaseEditorToolSettings {\r\n  private _category?: Id64String;\r\n  private _model?: Id64String;\r\n\r\n  /** An event raised just after the default [[category]] is changed. */\r\n  public readonly onCategoryChanged = new BeEvent<(previousCategory: Id64String | undefined) => void>();\r\n\r\n  /** An event raised just after the default [[model]] is changed. */\r\n  public readonly onModelChanged = new BeEvent<(previousModel: Id64String | undefined) => void>();\r\n\r\n  /** The [Category]($backend) into which new elements should be inserted by default.\r\n   * Specialized tools are free to ignore this setting and instead use their own logic to select an appropriate category.\r\n   * @see [[onCategoryChanged]] to be notified when this property is modified.\r\n   * @see [CreateElementTool.targetCategory]($editor-frontend) for an example of a tool that uses this setting.\r\n   */\r\n  public get category(): Id64String | undefined {\r\n    return this._category;\r\n  }\r\n  public set category(category: Id64String | undefined) {\r\n    const previousCategory = this.category;\r\n    if (category !== this.category) {\r\n      this._category = category;\r\n      this.onCategoryChanged.raiseEvent(previousCategory);\r\n    }\r\n  }\r\n\r\n  /** The [Model]($backend) into which new elements should be inserted by default.\r\n   * Specialized tools are free to ignore this setting and instead use their own logic to select an appropriate model.\r\n   * @see [[onModelChanged]] to be notified when this property is modified.\r\n   * @see [CreateElementTool.targetModelId]($editor-frontend) for an example of a tool that uses this setting.\r\n   */\r\n  public get model(): Id64String | undefined {\r\n    return this._model;\r\n  }\r\n  public set model(model: Id64String | undefined) {\r\n    const previousModel = this.model;\r\n    if (model !== this.model) {\r\n      this._model = model;\r\n      this.onModelChanged.raiseEvent(previousModel);\r\n    }\r\n  }\r\n}\r\n\r\n/** A connection to an editable briefcase on the backend. This class uses [Ipc]($docs/learning/IpcInterface.md) to communicate\r\n * to the backend and may only be used by [[IpcApp]]s.\r\n * @public\r\n */\r\nexport class BriefcaseConnection extends IModelConnection {\r\n  protected _isClosed?: boolean;\r\n  private readonly _modelsMonitor: ModelChangeMonitor;\r\n  private _locks?: LockService;\r\n\r\n  /** The ID of the briefcase.\r\n   * @beta\r\n   */\r\n  public readonly briefcaseId?: number;\r\n\r\n  /** Default settings that can be used to control the behavior of [[Tool]]s that modify this briefcase.\r\n   * @beta\r\n   */\r\n  public readonly editorToolSettings = new BriefcaseEditorToolSettings();\r\n\r\n  /** Manages local changes to the briefcase via [Txns]($docs/learning/InteractiveEditing.md). */\r\n  public readonly txns: BriefcaseTxns;\r\n\r\n  /** Information about locks held on this iModel.\r\n   * @note This is intended to be used by tools and other UI elements, to provide information about the current lock state. Implementations are expected to cache lock information and so may not reflect changes to locks immediately.\r\n   * @alpha\r\n   */\r\n  public get locks(): LockService | undefined { return this._locks; }\r\n\r\n  public override isBriefcaseConnection(): this is BriefcaseConnection { return true; }\r\n\r\n  /** The Guid that identifies the iTwin that owns this iModel. */\r\n  public override get iTwinId(): GuidString { return super.iTwinId ?? Guid.empty; } // GuidString | undefined for IModelConnection, but required for BriefcaseConnection\r\n\r\n  /** The Guid that identifies this iModel. */\r\n  public override get iModelId(): GuidString { return super.iModelId ?? Guid.empty; } // GuidString | undefined for IModelConnection, but required for BriefcaseConnection\r\n\r\n  protected constructor(props: BriefcaseConnectionProps, openMode: OpenMode) {\r\n    super(props);\r\n    this._openMode = openMode;\r\n    this.briefcaseId = props.briefcaseId;\r\n    this.txns = new BriefcaseTxns(this);\r\n    this._modelsMonitor = new ModelChangeMonitor(this);\r\n    if (OpenMode.ReadWrite === this._openMode)\r\n      this.txns.onAfterUndoRedo.addListener(async () => { await IModelApp.toolAdmin.restartPrimitiveTool(); });\r\n\r\n    this.categories.cache.attachToBriefcase(this);\r\n  }\r\n\r\n  /** Open a BriefcaseConnection to a [BriefcaseDb]($backend). */\r\n  public static async openFile(briefcaseProps: OpenBriefcaseProps): Promise<BriefcaseConnection>;\r\n\r\n  /** Open a BriefcaseConnection to a [BriefcaseDb]($backend).\r\n   * @alpha\r\n   */\r\n  public static async openFile(briefcaseProps: OpenBriefcaseProps, lockServiceFactory?: LockServiceFactory): Promise<BriefcaseConnection>\r\n\r\n  public static async openFile(briefcaseProps: OpenBriefcaseProps, lockServiceFactory?: LockServiceFactory): Promise<BriefcaseConnection> {\r\n    const iModelProps = await IpcApp.appFunctionIpc.openBriefcase(briefcaseProps);\r\n    const connection = new this({ ...briefcaseProps, ...iModelProps }, briefcaseProps.readonly ? OpenMode.Readonly : OpenMode.ReadWrite);\r\n    if (lockServiceFactory)\r\n      connection._locks = await lockServiceFactory(connection);\r\n\r\n    IModelConnection.onOpen.raiseEvent(connection);\r\n    return connection;\r\n  }\r\n\r\n  /** Open a BriefcaseConnection to a [StandaloneDb]($backend)\r\n   * @note StandaloneDbs, by definition, may not push or pull changes. Attempting to do so will throw exceptions.\r\n   */\r\n  public static async openStandalone(filePath: string, openMode: OpenMode = OpenMode.ReadWrite, opts?: StandaloneOpenOptions): Promise<BriefcaseConnection> {\r\n    const openResponse = await IpcApp.appFunctionIpc.openStandalone(filePath, openMode, opts);\r\n    const connection = new this(openResponse, openMode);\r\n    IModelConnection.onOpen.raiseEvent(connection);\r\n    return connection;\r\n  }\r\n\r\n  /** Returns `true` if [[close]] has already been called. */\r\n  public get isClosed(): boolean { return this._isClosed === true; }\r\n\r\n  /**\r\n   * Close this BriefcaseConnection.\r\n   * @note make sure to call [[saveChanges]] before calling this method. Unsaved local changes are abandoned.\r\n   */\r\n  public async close(): Promise<void> {\r\n    if (this.isClosed)\r\n      return;\r\n\r\n    await this._modelsMonitor.close();\r\n\r\n    this.beforeClose();\r\n    this.txns[Symbol.dispose]();\r\n\r\n    this._isClosed = true;\r\n    await IpcApp.appFunctionIpc.closeIModel(this._fileKey);\r\n  }\r\n\r\n  protected requireTimeline() {\r\n    if (this.iTwinId === Guid.empty)\r\n      throw new IModelError(IModelStatus.WrongIModel, \"iModel has no timeline\");\r\n  }\r\n\r\n  /** Query if there are any pending Txns in this briefcase that are waiting to be pushed. */\r\n  public async hasPendingTxns(): Promise<boolean> { // eslint-disable-line @itwin/prefer-get\r\n    return this.txns.hasPendingTxns();\r\n  }\r\n\r\n  /** Commit pending changes to this briefcase.\r\n   * @param description Optional description of the changes.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use methods on EditCommand instead.\r\n   */\r\n  public async saveChanges(description?: string): Promise<void> {\r\n    await IpcApp.appFunctionIpc.saveChanges(this.key, description); // eslint-disable-line @typescript-eslint/no-deprecated\r\n  }\r\n\r\n  /** Abandon pending changes to this briefcase.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use methods on EditCommand instead.\r\n   */\r\n  public async abandonChanges(): Promise<void> {\r\n    await IpcApp.appFunctionIpc.abandonChanges(this.key); // eslint-disable-line @typescript-eslint/no-deprecated\r\n  }\r\n\r\n  /** Subscribes to changeset download progress events on `channel` and wires `abortSignal` to `cancel`.\r\n   * @returns a function that removes every listener that was added.\r\n   */\r\n  private listenForChangesetDownloadProgress(args: {\r\n    channel: string,\r\n    cancel: () => Promise<void>,\r\n    downloadProgressCallback?: OnDownloadProgress,\r\n    abortSignal?: GenericAbortSignal,\r\n  }): VoidFunction {\r\n    const { channel, cancel, downloadProgressCallback, abortSignal } = args;\r\n    const removeListeners: VoidFunction[] = [];\r\n\r\n    if (downloadProgressCallback) {\r\n      const handleProgress = (_evt: Event, data: DownloadProgressInfo) => downloadProgressCallback(data);\r\n      removeListeners.push(IpcApp.addListener(channel, handleProgress));\r\n    }\r\n\r\n    if (abortSignal) {\r\n      const abort = () => void cancel();\r\n      abortSignal.addEventListener(\"abort\", abort);\r\n      removeListeners.push(() => abortSignal.removeEventListener(\"abort\", abort));\r\n    }\r\n\r\n    return () => removeListeners.forEach((remove) => remove());\r\n  }\r\n\r\n  /** Pull (and potentially merge if there are local changes) up to a specified changeset from iModelHub into this briefcase\r\n   * @param toIndex The changeset index to pull changes to. If `undefined`, pull all changes.\r\n   * @param options Options for pulling changes.\r\n   * @see [[BriefcaseTxns.onChangesPulled]] for the event dispatched after changes are pulled.\r\n   */\r\n  public async pullChanges(toIndex?: ChangesetIndex, options?: PullChangesOptions): Promise<void> {\r\n    this.requireTimeline();\r\n\r\n    const removeListeners = this.listenForChangesetDownloadProgress({\r\n      channel: getPullChangesIpcChannel(this.key),\r\n      cancel: async () => IpcApp.appFunctionIpc.cancelPullChangesRequest(this.key),\r\n      downloadProgressCallback: options?.downloadProgressCallback,\r\n      abortSignal: options?.abortSignal,\r\n    });\r\n\r\n    const ipcAppOptions: IpcAppPullChangesOptions = {\r\n      reportProgress: !!options?.downloadProgressCallback,\r\n      progressInterval: options?.progressInterval,\r\n      enableCancellation: !!options?.abortSignal,\r\n    };\r\n    try {\r\n      this.changeset = await IpcApp.appFunctionIpc.pullChanges(this.key, toIndex, ipcAppOptions);\r\n    } finally {\r\n      removeListeners();\r\n    }\r\n    await this.invalidateSchemaViewIfChanged();\r\n  }\r\n\r\n  /** Create a changeset from local Txns and push to iModelHub. On success, clear Txn table.\r\n   * @param description The description for the changeset\r\n   * @returns the changesetId of the pushed changes\r\n   * @note Any changes made by other users are first pulled, applied, and merged with the local Txns. Only then is the resulting changeset\r\n   * uploaded.\r\n   * @see [[BriefcaseTxns.onChangesPushed]] for the event dispatched after changes are pushed.\r\n   * @public\r\n   */\r\n  public pushChanges(description: string): Promise<ChangesetIndexAndId>;\r\n  /** Create a changeset from local Txns and push to iModelHub. On success, clear Txn table.\r\n   * @param description The description for the changeset\r\n   * @param options Options reporting the progress of - and optionally cancelling - the download of the changes that are pulled before pushing.\r\n   * @returns the changesetId of the pushed changes\r\n   * @note Any changes made by other users are first pulled, applied, and merged with the local Txns. Only then is the resulting changeset\r\n   * uploaded.\r\n   * @see [[BriefcaseTxns.onChangesPushed]] for the event dispatched after changes are pushed.\r\n   * @beta\r\n   */\r\n  public pushChanges(description: string, options?: PushChangesOptions): Promise<ChangesetIndexAndId>;\r\n  public async pushChanges(description: string, options?: PushChangesOptions): Promise<ChangesetIndexAndId> {\r\n    this.requireTimeline();\r\n\r\n    const removeListeners = this.listenForChangesetDownloadProgress({\r\n      channel: getPushChangesIpcChannel(this.key),\r\n      cancel: async () => IpcApp.appFunctionIpc.cancelPushChangesRequest(this.key),\r\n      downloadProgressCallback: options?.downloadProgressCallback,\r\n      abortSignal: options?.abortSignal,\r\n    });\r\n\r\n    const ipcAppOptions: IpcAppPushChangesOptions = {\r\n      reportDownloadProgress: !!options?.downloadProgressCallback,\r\n      downloadProgressInterval: options?.downloadProgressInterval,\r\n      enableCancellation: !!options?.abortSignal,\r\n    };\r\n    try {\r\n      return this.changeset = await IpcApp.appFunctionIpc.pushChanges(this.key, description, ipcAppOptions);\r\n    } finally {\r\n      removeListeners();\r\n    }\r\n  }\r\n\r\n  /** The current graphical editing scope, if one is in progress.\r\n   * @see [[enterEditingScope]] to begin graphical editing.\r\n   */\r\n  public get editingScope(): GraphicalEditingScope | undefined {\r\n    return this._modelsMonitor.editingScope;\r\n  }\r\n\r\n  /** Return whether graphical editing is supported for this briefcase. It is not supported if the briefcase is read-only, or the briefcase contains a version of\r\n   * the BisCore ECSchema older than v0.1.11.\r\n   * @see [[enterEditingScope]] to enable graphical editing.\r\n   */\r\n  public async supportsGraphicalEditing(): Promise<boolean> {\r\n    return IpcApp.appFunctionIpc.isGraphicalEditingSupported(this.key);\r\n  }\r\n\r\n  /** Begin a new graphical editing scope.\r\n   * @throws Error if an editing scope already exists or one could not be created.\r\n   * @see [[GraphicalEditingScope.exit]] to exit the scope.\r\n   * @see [[supportsGraphicalEditing]] to determine whether this method should be expected to succeed.\r\n   * @see [[editingScope]] to obtain the current editing scope, if one is in progress.\r\n   */\r\n  public async enterEditingScope(): Promise<GraphicalEditingScope> {\r\n    return this._modelsMonitor.enterEditingScope();\r\n  }\r\n\r\n  /** Strictly for tests - dispatched from ModelChangeMonitor.processBuffered.\r\n   * @internal\r\n   */\r\n  public readonly onBufferedModelChanges = new BeEvent<(changedModelIds: Set<string>) => void>();\r\n}\r\n"]}

package/lib/cjs/GeoServices.d.ts

@@ -9,6 +9,8 @@ import { IModelConnection } from "./IModelConnection";
  * @internal exported strictly for tests.
  */
 export interface CoordinateConverterOptions {
+    /** Conversion direction included in error diagnostics. */
+    direction: "geoToIModel" | "iModelToGeo";
     isIModelClosed: () => boolean;
     /** Asynchronously convert each point. The resultant array should have the same number and order of points as the input. */
     requestPoints: (points: XYAndZ[]) => Promise<PointWithStatus[]>;
@@ -43,6 +45,7 @@ export declare class CoordinateConverter {
     protected readonly _maxPointsPerRequest: number;
     protected readonly _isIModelClosed: () => boolean;
     protected readonly _requestPoints: (points: XYAndZ[]) => Promise<PointWithStatus[]>;
+    private readonly _direction;
     protected _redispatchOnCompletion: boolean;
     get isIdle(): boolean;
     protected toXYAndZ(input: XYZProps, output: WritableXYAndZ): XYAndZ;

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

@@ -1 +1 @@
-{"version":3,"file":"GeoServices.d.ts","sourceRoot":"","sources":["../../src/GeoServices.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EACG,OAAO,EAAE,UAAU,EAAU,WAAW,EACjD,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACxE,OAAO,EACL,0BAA0B,EAAE,2BAA2B,EAAkB,kBAAkB,EAAE,6BAA6B,EAAE,8BAA8B,EAClI,eAAe,EACxC,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAGtD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,cAAc,EAAE,MAAM,OAAO,CAAC;IAC9B,2HAA2H;IAC3H,aAAa,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;IAChE,yEAAyE;IACzE,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAUD,KAAK,wBAAwB,GAE3B,MAAM,GAEN,WAAW,GAEX,WAAW,CAAC;AAEd;;;;;;;;;;;;GAYG;AACH,qBAAa,mBAAmB;IAC9B,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC/D,SAAS,CAAC,MAAM,EAAE,wBAAwB,CAAU;IAEpD,SAAS,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAExC,SAAS,CAAC,SAAS,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAEzC,SAAS,CAAC,YAAY,gBAAqB,IAAI,EAAI;IAEnD,SAAS,CAAC,QAAQ,CAAC,WAAW;;;;MAAwB;IACtD,SAAS,CAAC,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;IAChD,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,MAAM,OAAO,CAAC;IAClD,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;IAIpF,SAAS,CAAC,uBAAuB,UAAS;IAE1C,IAAW,MAAM,IAAI,OAAO,CAE3B;IAED,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,GAAG,MAAM;gBAchD,IAAI,EAAE,0BAA0B;cAUnC,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IA4DzC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM;IAiB7C,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,eAAe,EAAE;cAc7C,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAapC,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,eAAe,EAAE,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAa5F,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,oCAAoC;CAiB5E;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD,oIAAoI;IACpI,MAAM,EAAE,KAAK,CAAC,eAAe,GAAG,SAAS,CAAC,CAAC;IAC3C,mIAAmI;IACnI,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,OAAO,CAAC;IAC9B,cAAc,EAAE,CAAC,OAAO,EAAE,6BAA6B,KAAK,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;IACvF,gBAAgB,EAAE,CAAC,OAAO,EAAE,0BAA0B,KAAK,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;CACvF;AAED;;;;GAIG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsB;IACnD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsB;IACnD;;OAEG;IACH,SAAgB,sBAAsB,gBAAqB,IAAI,EAAI;IAEnE,gBAAgB;gBACJ,IAAI,EAAE,mBAAmB;IAarC,4EAA4E;IAC/D,qBAAqB,CAAC,SAAS,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAKrF,4EAA4E;IAC/D,uBAAuB,CAAC,YAAY,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAK1F,gBAAgB;IACH,sCAAsC,CAAC,SAAS,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,8BAA8B,CAAC;IASnH,gBAAgB;IACH,sCAAsC,CAAC,YAAY,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,2BAA2B,CAAC;IASnH,OAAO,CAAC,eAAe;IAKvB,gBAAgB;IACT,4CAA4C,CAAC,SAAS,EAAE,QAAQ,EAAE,GAAG,oCAAoC;CAGjH;AAED,gBAAgB;AAChB,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;AAEpE;;;GAGG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqB;IAC9C;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmC;IAE1D,gBAAgB;gBACG,OAAO,EAAE,kBAAkB;IAI9C,gBAAgB;WACF,eAAe,CAAC,MAAM,EAAE,gBAAgB,GAAG,WAAW;IAgBpE;;;;OAIG;IACI,YAAY,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,YAAY,GAAG,SAAS;CAmBzF"}
+{"version":3,"file":"GeoServices.d.ts","sourceRoot":"","sources":["../../src/GeoServices.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EACG,OAAO,EAAE,UAAU,EAAU,WAAW,EACjD,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACxE,OAAO,EACL,0BAA0B,EAAE,2BAA2B,EAAkB,kBAAkB,EAAE,6BAA6B,EAAE,8BAA8B,EAClI,eAAe,EACxC,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAGtD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,0DAA0D;IAC1D,SAAS,EAAE,aAAa,GAAG,aAAa,CAAC;IACzC,cAAc,EAAE,MAAM,OAAO,CAAC;IAC9B,2HAA2H;IAC3H,aAAa,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;IAChE,yEAAyE;IACzE,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAUD,KAAK,wBAAwB,GAE3B,MAAM,GAEN,WAAW,GAEX,WAAW,CAAC;AAEd;;;;;;;;;;;;GAYG;AACH,qBAAa,mBAAmB;IAC9B,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC/D,SAAS,CAAC,MAAM,EAAE,wBAAwB,CAAU;IAEpD,SAAS,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAExC,SAAS,CAAC,SAAS,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAEzC,SAAS,CAAC,YAAY,gBAAqB,IAAI,EAAI;IAEnD,SAAS,CAAC,QAAQ,CAAC,WAAW;;;;MAAwB;IACtD,SAAS,CAAC,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;IAChD,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,MAAM,OAAO,CAAC;IAClD,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;IACpF,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA0C;IAIrE,SAAS,CAAC,uBAAuB,UAAS;IAE1C,IAAW,MAAM,IAAI,OAAO,CAE3B;IAED,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,GAAG,MAAM;gBAchD,IAAI,EAAE,0BAA0B;cAWnC,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IA+DzC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM;IAiB7C,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,eAAe,EAAE;cAc7C,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAapC,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,eAAe,EAAE,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAa5F,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,oCAAoC;CAiB5E;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD,oIAAoI;IACpI,MAAM,EAAE,KAAK,CAAC,eAAe,GAAG,SAAS,CAAC,CAAC;IAC3C,mIAAmI;IACnI,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,OAAO,CAAC;IAC9B,cAAc,EAAE,CAAC,OAAO,EAAE,6BAA6B,KAAK,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;IACvF,gBAAgB,EAAE,CAAC,OAAO,EAAE,0BAA0B,KAAK,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;CACvF;AAED;;;;GAIG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsB;IACnD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsB;IACnD;;OAEG;IACH,SAAgB,sBAAsB,gBAAqB,IAAI,EAAI;IAEnE,gBAAgB;gBACJ,IAAI,EAAE,mBAAmB;IAerC,4EAA4E;IAC/D,qBAAqB,CAAC,SAAS,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAKrF,4EAA4E;IAC/D,uBAAuB,CAAC,YAAY,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAK1F,gBAAgB;IACH,sCAAsC,CAAC,SAAS,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,8BAA8B,CAAC;IASnH,gBAAgB;IACH,sCAAsC,CAAC,YAAY,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,2BAA2B,CAAC;IASnH,OAAO,CAAC,eAAe;IAKvB,gBAAgB;IACT,4CAA4C,CAAC,SAAS,EAAE,QAAQ,EAAE,GAAG,oCAAoC;CAGjH;AAED,gBAAgB;AAChB,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;AAEpE;;;GAGG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqB;IAC9C;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmC;IAE1D,gBAAgB;gBACG,OAAO,EAAE,kBAAkB;IAI9C,gBAAgB;WACF,eAAe,CAAC,MAAM,EAAE,gBAAgB,GAAG,WAAW;IAgBpE;;;;OAIG;IACI,YAAY,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,YAAY,GAAG,SAAS;CAmBzF"}

package/lib/cjs/GeoServices.js

@@ -45,6 +45,7 @@ class CoordinateConverter {
     _maxPointsPerRequest;
     _isIModelClosed;
     _requestPoints;
+    _direction;
     // If true, [[dispatch]] will schedule another dispatch after it receives a response.
     // This is needed when all the points requested after the most recent dispatch were included in the currently-in-flight request -
     // _pending will be empty but new callers will be awaiting the results of the in-flight request.
@@ -69,6 +70,7 @@ class CoordinateConverter {
         this._maxPointsPerRequest = Math.max(1, opts.maxPointsPerRequest ?? 300);
         this._isIModelClosed = opts.isIModelClosed;
         this._requestPoints = opts.requestPoints;
+        this._direction = opts.direction;
         this._cache = new core_bentley_1.Dictionary(compareXYAndZ, cloneXYAndZ);
         this._pending = new core_bentley_1.SortedArray(compareXYAndZ, false, cloneXYAndZ);
         this._inflight = new core_bentley_1.SortedArray(compareXYAndZ, false, cloneXYAndZ);
@@ -103,7 +105,10 @@ class CoordinateConverter {
                         this._cache.set(requests[j], results[j]);
                 }
             }).catch((err) => {
-                core_bentley_1.Logger.logError(`${FrontendLoggerCategory_1.FrontendLoggerCategory.Package}.geoservices`, err);
+                core_bentley_1.Logger.logError(`${FrontendLoggerCategory_1.FrontendLoggerCategory.Package}.geoservices`, err, () => ({
+                    direction: this._direction,
+                    pointCount: requests.length,
+                }));
             });
             promises.push(promise);
         }
@@ -200,10 +205,12 @@ class GeoConverter {
     constructor(opts) {
         const isIModelClosed = opts.isIModelClosed;
         this._geoToIModel = new CoordinateConverter({
+            direction: "geoToIModel",
             isIModelClosed,
             requestPoints: async (geoCoords) => opts.toIModelCoords({ source: opts.datum, geoCoords }),
         });
         this._iModelToGeo = new CoordinateConverter({
+            direction: "iModelToGeo",
             isIModelClosed,
             requestPoints: async (iModelCoords) => opts.fromIModelCoords({ target: opts.datum, iModelCoords }),
         });

package/lib/cjs/GeoServices.js.map

@@ -1 +1 @@
-{"version":3,"file":"GeoServices.js","sourceRoot":"","sources":["../../src/GeoServices.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,qBAAqB;AACrB,sDAE6B;AAE7B,oDAG4B;AAE5B,4EAAyE;AAazE,SAAS,aAAa,CAAC,GAAW,EAAE,GAAW;IAC7C,OAAO,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,OAAO,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;AAC1C,CAAC;AAUD;;;;;;;;;;;;GAYG;AACH,MAAa,mBAAmB;IACX,MAAM,CAAsC;IACrD,MAAM,GAA6B,MAAM,CAAC;IACpD,qEAAqE;IAC3D,QAAQ,CAAsB;IACxC,iFAAiF;IACvE,SAAS,CAAsB;IACzC,kDAAkD;IACxC,YAAY,GAAG,IAAI,sBAAO,EAAc,CAAC;IACnD,oGAAoG;IACjF,WAAW,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;IACnC,oBAAoB,CAAS;IAC7B,eAAe,CAAgB;IAC/B,cAAc,CAAmD;IACpF,qFAAqF;IACrF,iIAAiI;IACjI,gGAAgG;IACtF,uBAAuB,GAAG,KAAK,CAAC;IAE1C,IAAW,MAAM;QACf,OAAO,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC;IAChC,CAAC;IAES,QAAQ,CAAC,KAAe,EAAE,MAAsB;QACxD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACzB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACzB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;YACxB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;YACxB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,YAAmB,IAAgC;QACjD,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,mBAAmB,IAAI,GAAG,CAAC,CAAC;QACzE,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC;QAEzC,IAAI,CAAC,MAAM,GAAG,IAAI,yBAAU,CAA0B,aAAa,EAAE,WAAW,CAAC,CAAC;QAClF,IAAI,CAAC,QAAQ,GAAG,IAAI,0BAAW,CAAS,aAAa,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;QAC3E,IAAI,CAAC,SAAS,GAAG,IAAI,0BAAW,CAAS,aAAa,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;IAC9E,CAAC;IAES,KAAK,CAAC,QAAQ;QACtB,IAAA,qBAAM,EAAC,IAAI,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC;QACpC,IAAI,IAAI,CAAC,eAAe,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACpD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACrB,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;YAC/B,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;QAE1B,uFAAuF;QACvF,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,IAAI,CAAC,YAAY,GAAG,IAAI,sBAAO,EAAc,CAAC;QAE9C,+HAA+H;QAC/H,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,IAAA,qBAAM,EAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAE1B,kGAAkG;QAClG,MAAM,QAAQ,GAAyB,EAAE,CAAC;QAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YACpE,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,CAAC,YAAY,EAAE,CAAC;YACjF,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC7D,IAAI,IAAI,CAAC,eAAe,EAAE;oBACxB,OAAO;gBAET,IAAI,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM;oBACpC,qBAAM,CAAC,QAAQ,CAAC,GAAG,+CAAsB,CAAC,OAAO,cAAc,EAAE,2BAA2B,QAAQ,CAAC,MAAM,yBAAyB,OAAO,CAAC,MAAM,SAAS,CAAC,CAAC;gBAE/J,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBACxC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM;wBACrB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC7C,CAAC;YACH,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACf,qBAAM,CAAC,QAAQ,CAAC,GAAG,+CAAsB,CAAC,OAAO,cAAc,EAAE,GAAG,CAAC,CAAC;YACxE,CAAC,CAAC,CAAC;YAEH,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAE5B,IAAA,qBAAM,EAAC,IAAI,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QAEvB,iGAAiG;QACjG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC3D,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAC;YACrC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,8DAA8D;QACzF,CAAC;QAED,kEAAkE;QAClE,WAAW,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;IAED,+DAA+D;IAC/D,gDAAgD;IACtC,OAAO,CAAC,MAAkB;QAClC,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACnD,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC;gBACtB,EAAE,UAAU,CAAC;iBACV,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC;gBACnC,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC;;gBAEpC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC9B,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,0HAA0H;IAC1H,2EAA2E;IACjE,YAAY,CAAC,MAAkB;QACvC,MAAM,OAAO,GAAsB,EAAE,CAAC;QACtC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACnD,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,MAAM;gBACT,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,GAAG,GAAG,EAAE,EAAE,CAAC,EAAE,4BAAc,CAAC,UAAU,EAAE,CAAC;YAE3D,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACvB,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAES,KAAK,CAAC,gBAAgB;QAC9B,IAAI,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;YAC3B,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;YAC1B,qBAAqB,CAAC,GAAG,EAAE;gBACzB,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,8DAA8D;YACjF,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,MAAkB;QACrC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACvC,IAAA,qBAAM,EAAC,SAAS,IAAI,CAAC,CAAC,CAAC;QACvB,IAAA,qBAAM,EAAC,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;QAEnC,IAAI,SAAS,KAAK,MAAM,CAAC,MAAM;YAC7B,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;QAE1D,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAE9B,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;IAC1D,CAAC;IAEM,UAAU,CAAC,MAAkB;QAClC,MAAM,MAAM,GAAuC,EAAE,CAAC;QACtD,IAAI,OAA+B,CAAC;QACpC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACnD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACpC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACpB,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,IAAI,CAAC,OAAO;oBACV,OAAO,GAAG,EAAE,CAAC;gBAEf,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;QACH,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAC7B,CAAC;CACF;AArLD,kDAqLC;AAsBD;;;;GAIG;AACH,MAAa,YAAY;IACN,YAAY,CAAsB;IAClC,YAAY,CAAsB;IACnD;;OAEG;IACa,sBAAsB,GAAG,IAAI,sBAAO,EAAc,CAAC;IAEnE,gBAAgB;IAChB,YAAY,IAAyB;QACnC,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC3C,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC;YAC1C,cAAc;YACd,aAAa,EAAE,KAAK,EAAE,SAAmB,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC;SACrG,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC;YAC1C,cAAc;YACd,aAAa,EAAE,KAAK,EAAE,YAAsB,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,CAAC;SAC7G,CAAC,CAAC;IACL,CAAC;IAED,4EAA4E;IACrE,KAAK,CAAC,qBAAqB,CAAC,SAAqB;QACtD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,sCAAsC,CAAC,SAAS,CAAC,CAAC;QAC5E,OAAO,MAAM,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED,4EAA4E;IACrE,KAAK,CAAC,uBAAuB,CAAC,YAAwB;QAC3D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,sCAAsC,CAAC,YAAY,CAAC,CAAC;QAC/E,OAAO,MAAM,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,sCAAsC,CAAC,SAAqB;QACvE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC1D,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,OAAO;YACL,YAAY,EAAE,MAAM,CAAC,MAAM;YAC3B,SAAS,EAAE,MAAM,CAAC,SAAS;SAC5B,CAAC;IACJ,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,sCAAsC,CAAC,YAAwB;QAC1E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAC7D,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,OAAO;YACL,SAAS,EAAE,MAAM,CAAC,MAAM;YACxB,SAAS,EAAE,MAAM,CAAC,SAAS;SAC5B,CAAC;IACJ,CAAC;IAEO,eAAe;QACrB,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM;YACtD,IAAI,CAAC,sBAAsB,CAAC,UAAU,EAAE,CAAC;IAC7C,CAAC;IAED,gBAAgB;IACT,4CAA4C,CAAC,SAAqB;QACvE,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACjD,CAAC;CACF;AA/DD,oCA+DC;AAKD;;;GAGG;AACH,MAAa,WAAW;IACL,QAAQ,CAAqB;IAC9C;;;;;;;;;OASG;IACc,MAAM,GAAG,IAAI,GAAG,EAAwB,CAAC;IAE1D,gBAAgB;IAChB,YAAmB,OAA2B;QAC5C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,eAAe,CAAC,MAAwB;QACpD,OAAO,IAAI,WAAW,CAAC;YACrB,cAAc,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ;YACrC,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;gBAChC,MAAM,GAAG,GAAG,oCAAsB,CAAC,mBAAmB,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;gBACpF,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,sCAAsC,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;gBACjG,OAAO,QAAQ,CAAC,YAAY,CAAC;YAC/B,CAAC;YACD,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;gBAClC,MAAM,GAAG,GAAG,oCAAsB,CAAC,mBAAmB,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;gBACpF,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,sCAAsC,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;gBACjG,OAAO,QAAQ,CAAC,SAAS,CAAC;YAC5B,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,WAAyC;QAC3D,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE;YAChC,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAG,CAAC,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QAElG,IAAI,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACvC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAS,GAAG,IAAI,YAAY,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;YAC1D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YAElC,SAAS,CAAC,sBAAsB,CAAC,OAAO,CAAC,GAAG,EAAE;gBAC5C,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;oBACtC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AA5DD,kCA4DC","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 IModelConnection\r\n */\r\n\r\n// cspell:ignore GCRS\r\nimport {\r\n  assert, BeEvent, Dictionary, Logger, SortedArray,\r\n} from \"@itwin/core-bentley\";\r\nimport { WritableXYAndZ, XYAndZ, XYZProps } from \"@itwin/core-geometry\";\r\nimport {\r\n  GeoCoordinatesRequestProps, GeoCoordinatesResponseProps, GeoCoordStatus, GeographicCRSProps, IModelCoordinatesRequestProps, IModelCoordinatesResponseProps,\r\n  IModelReadRpcInterface, PointWithStatus,\r\n} from \"@itwin/core-common\";\r\nimport { IModelConnection } from \"./IModelConnection\";\r\nimport { FrontendLoggerCategory } from \"./common/FrontendLoggerCategory\";\r\n\r\n/** Options used to create a [[CoordinateConverter]].\r\n * @internal exported strictly for tests.\r\n */\r\nexport interface CoordinateConverterOptions {\r\n  isIModelClosed: () => boolean;\r\n  /** Asynchronously convert each point. The resultant array should have the same number and order of points as the input. */\r\n  requestPoints: (points: XYAndZ[]) => Promise<PointWithStatus[]>;\r\n  /** Maximum number of points to include in each request. Default: 300. */\r\n  maxPointsPerRequest?: number;\r\n}\r\n\r\nfunction compareXYAndZ(lhs: XYAndZ, rhs: XYAndZ): number {\r\n  return lhs.x - rhs.x || lhs.y - rhs.y || lhs.z - rhs.z;\r\n}\r\n\r\nfunction cloneXYAndZ(xyz: XYAndZ): XYAndZ {\r\n  return { x: xyz.x, y: xyz.y, z: xyz.z };\r\n}\r\n\r\ntype CoordinateConverterState =\r\n  // No pending requests.\r\n  \"idle\" |\r\n  // We have scheduled a requestAnimationFrame to dispatch all pending requests.\r\n  \"scheduled\" |\r\n  // We have dispatched all requests that were pending at the most recent requestAnimationFrame callback.\r\n  \"in-flight\";\r\n\r\n/** Performs conversion of coordinates from one coordinate system to another.\r\n * A [[GeoConverter]] has a pair of these for converting between iModel coordinates and geographic coordinates.\r\n * Uses a cache to avoid repeatedly requesting the same points, and a batching strategy to avoid making frequent small requests.\r\n * The cache stores every point that was ever converted by [[convert]]. It is currently permitted to grow to unbounded size.\r\n * The batching works as follows:\r\n *  When a conversion is requested via [[convert]], if all the requested points are in the cache, they are returned immediately.\r\n *  Otherwise, any points not in the cache and not in the current in-flight request (if any) are placed onto the queue of pending requests.\r\n *  A pending request is scheduled if one hasn't already been scheduled, via requestAnimationFrame.\r\n *  In the animation frame callback, the pending requests are split into batches of no more than options.maxPointsPerRequest and dispatched to the backend.\r\n *  Once the response is received, the results are loaded into and returned from the cache.\r\n *  If more calls to convert occurred while the request was in flight, another request is dispatched.\r\n * @internal exported strictly for tests.\r\n */\r\nexport class CoordinateConverter {\r\n  protected readonly _cache: Dictionary<XYAndZ, PointWithStatus>;\r\n  protected _state: CoordinateConverterState = \"idle\";\r\n  // The accumulated set of points to be converted by the next request.\r\n  protected _pending: SortedArray<XYAndZ>;\r\n  // The set of points that were included in the current in-flight request, if any.\r\n  protected _inflight: SortedArray<XYAndZ>;\r\n  // An event fired when the next request completes.\r\n  protected _onCompleted = new BeEvent<() => void>();\r\n  // Used for creating cache keys (XYAndZ) from XYZProps without having to allocate temporary objects.\r\n  protected readonly _scratchXYZ = { x: 0, y: 0, z: 0 };\r\n  protected readonly _maxPointsPerRequest: number;\r\n  protected readonly _isIModelClosed: () => boolean;\r\n  protected readonly _requestPoints: (points: XYAndZ[]) => Promise<PointWithStatus[]>;\r\n  // If true, [[dispatch]] will schedule another dispatch after it receives a response.\r\n  // This is needed when all the points requested after the most recent dispatch were included in the currently-in-flight request -\r\n  // _pending will be empty but new callers will be awaiting the results of the in-flight request.\r\n  protected _redispatchOnCompletion = false;\r\n\r\n  public get isIdle(): boolean {\r\n    return \"idle\" === this._state;\r\n  }\r\n\r\n  protected toXYAndZ(input: XYZProps, output: WritableXYAndZ): XYAndZ {\r\n    if (Array.isArray(input)) {\r\n      output.x = input[0] ?? 0;\r\n      output.y = input[1] ?? 0;\r\n      output.z = input[2] ?? 0;\r\n    } else {\r\n      output.x = input.x ?? 0;\r\n      output.y = input.y ?? 0;\r\n      output.z = input.z ?? 0;\r\n    }\r\n\r\n    return output;\r\n  }\r\n\r\n  public constructor(opts: CoordinateConverterOptions) {\r\n    this._maxPointsPerRequest = Math.max(1, opts.maxPointsPerRequest ?? 300);\r\n    this._isIModelClosed = opts.isIModelClosed;\r\n    this._requestPoints = opts.requestPoints;\r\n\r\n    this._cache = new Dictionary<XYAndZ, PointWithStatus>(compareXYAndZ, cloneXYAndZ);\r\n    this._pending = new SortedArray<XYAndZ>(compareXYAndZ, false, cloneXYAndZ);\r\n    this._inflight = new SortedArray<XYAndZ>(compareXYAndZ, false, cloneXYAndZ);\r\n  }\r\n\r\n  protected async dispatch(): Promise<void> {\r\n    assert(this._state === \"scheduled\");\r\n    if (this._isIModelClosed() || this._pending.isEmpty) {\r\n      this._state = \"idle\";\r\n      this._onCompleted.raiseEvent();\r\n      return;\r\n    }\r\n\r\n    this._state = \"in-flight\";\r\n\r\n    // Ensure subsequently-enqueued requests listen for the *next* response to be received.\r\n    const onCompleted = this._onCompleted;\r\n    this._onCompleted = new BeEvent<() => void>();\r\n\r\n    // Pending requests are now in flight. Start a new list of pending requests. It's cheaper to swap than to allocate new objects.\r\n    const inflight = this._pending;\r\n    this._pending = this._inflight;\r\n    assert(this._pending.isEmpty);\r\n    this._inflight = inflight;\r\n\r\n    // Split requests if necessary to avoid requesting more than the maximum allowed number of points.\r\n    const promises: Array<Promise<void>> = [];\r\n    for (let i = 0; i < inflight.length; i += this._maxPointsPerRequest) {\r\n      const requests = inflight.slice(i, i + this._maxPointsPerRequest).extractArray();\r\n      const promise = this._requestPoints(requests).then((results) => {\r\n        if (this._isIModelClosed())\r\n          return;\r\n\r\n        if (results.length !== requests.length)\r\n          Logger.logError(`${FrontendLoggerCategory.Package}.geoservices`, `requested conversion of ${requests.length} points, but received ${results.length} points`);\r\n\r\n        for (let j = 0; j < results.length; j++) {\r\n          if (j < requests.length)\r\n            this._cache.set(requests[j], results[j]);\r\n        }\r\n      }).catch((err) => {\r\n        Logger.logError(`${FrontendLoggerCategory.Package}.geoservices`, err);\r\n      });\r\n\r\n      promises.push(promise);\r\n    }\r\n\r\n    await Promise.all(promises);\r\n\r\n    assert(this._state === \"in-flight\");\r\n    this._state = \"idle\";\r\n    this._inflight.clear();\r\n\r\n    // If any more pending conversions arrived while awaiting this request, schedule another request.\r\n    if (!this._pending.isEmpty || this._redispatchOnCompletion) {\r\n      this._redispatchOnCompletion = false;\r\n      this.scheduleDispatch(); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n    }\r\n\r\n    // Resolve promises of all callers who were awaiting this request.\r\n    onCompleted.raiseEvent();\r\n  }\r\n\r\n  // Add any points not present in cache to pending request list.\r\n  // Return the number of points present in cache.\r\n  protected enqueue(points: XYZProps[]): number {\r\n    let numInCache = 0;\r\n    for (const point of points) {\r\n      const xyz = this.toXYAndZ(point, this._scratchXYZ);\r\n      if (this._cache.get(xyz))\r\n        ++numInCache;\r\n      else if (this._inflight.contains(xyz))\r\n        this._redispatchOnCompletion = true;\r\n      else\r\n        this._pending.insert(xyz);\r\n    }\r\n\r\n    return numInCache;\r\n  }\r\n\r\n  // Obtain converted points from the cache. The assumption is that every point in `inputs` is already present in the cache.\r\n  // Any point not present will be returned unconverted with an error status.\r\n  protected getFromCache(inputs: XYZProps[]): PointWithStatus[] {\r\n    const outputs: PointWithStatus[] = [];\r\n    for (const input of inputs) {\r\n      const xyz = this.toXYAndZ(input, this._scratchXYZ);\r\n      let output = this._cache.get(xyz);\r\n      if (!output)\r\n        output = { p: { ...xyz }, s: GeoCoordStatus.CSMapError };\r\n\r\n      outputs.push(output);\r\n    }\r\n\r\n    return outputs;\r\n  }\r\n\r\n  protected async scheduleDispatch(): Promise<void> {\r\n    if (\"idle\" === this._state) {\r\n      this._state = \"scheduled\";\r\n      requestAnimationFrame(() => {\r\n        this.dispatch(); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n      });\r\n    }\r\n\r\n    return new Promise((resolve) => {\r\n      this._onCompleted.addOnce(() => resolve());\r\n    });\r\n  }\r\n\r\n  public async convert(inputs: XYZProps[]): Promise<{ points: PointWithStatus[], fromCache: number }> {\r\n    const fromCache = this.enqueue(inputs);\r\n    assert(fromCache >= 0);\r\n    assert(fromCache <= inputs.length);\r\n\r\n    if (fromCache === inputs.length)\r\n      return { points: this.getFromCache(inputs), fromCache };\r\n\r\n    await this.scheduleDispatch();\r\n\r\n    return { points: this.getFromCache(inputs), fromCache };\r\n  }\r\n\r\n  public findCached(inputs: XYZProps[]): CachedIModelCoordinatesResponseProps {\r\n    const result: Array<PointWithStatus | undefined> = [];\r\n    let missing: XYZProps[] | undefined;\r\n    for (const input of inputs) {\r\n      const key = this.toXYAndZ(input, this._scratchXYZ);\r\n      const output = this._cache.get(key);\r\n      result.push(output);\r\n      if (!output) {\r\n        if (!missing)\r\n          missing = [];\r\n\r\n        missing.push(input);\r\n      }\r\n    }\r\n\r\n    return { result, missing };\r\n  }\r\n}\r\n\r\n/** Response to a request to obtain imodel coordinates from cache.\r\n * @internal\r\n */\r\nexport interface CachedIModelCoordinatesResponseProps {\r\n  /** An array of the same length as the input array, with undefined entries at indices corresponding to points not found in cache. */\r\n  result: Array<PointWithStatus | undefined>;\r\n  /** An array of points in the input array which were not found in the cache, or undefined if all points were found in the cache. */\r\n  missing?: XYZProps[];\r\n}\r\n\r\n/** Options used to create a [[GeoConverter]].\r\n * @internal exported strictly for tests.\r\n */\r\nexport interface GeoConverterOptions {\r\n  readonly datum: string;\r\n  isIModelClosed: () => boolean;\r\n  toIModelCoords: (request: IModelCoordinatesRequestProps) => Promise<PointWithStatus[]>;\r\n  fromIModelCoords: (request: GeoCoordinatesRequestProps) => Promise<PointWithStatus[]>;\r\n}\r\n\r\n/** An object capable of communicating with the backend to convert between coordinates in a geographic coordinate system and coordinates in an [[IModelConnection]]'s own coordinate system.\r\n * @see [[GeoServices.getConverter]] to obtain a converter.\r\n * @see [GeographicCRS]($common) for more information about geographic coordinate reference systems.\r\n * @public\r\n */\r\nexport class GeoConverter {\r\n  private readonly _geoToIModel: CoordinateConverter;\r\n  private readonly _iModelToGeo: CoordinateConverter;\r\n  /** Used for removing this converter from GeoServices' cache after all requests are completed.\r\n   * @internal\r\n   */\r\n  public readonly onAllRequestsCompleted = new BeEvent<() => void>();\r\n\r\n  /** @internal */\r\n  constructor(opts: GeoConverterOptions) {\r\n    const isIModelClosed = opts.isIModelClosed;\r\n    this._geoToIModel = new CoordinateConverter({\r\n      isIModelClosed,\r\n      requestPoints: async (geoCoords: XYAndZ[]) => opts.toIModelCoords({ source: opts.datum, geoCoords }),\r\n    });\r\n\r\n    this._iModelToGeo = new CoordinateConverter({\r\n      isIModelClosed,\r\n      requestPoints: async (iModelCoords: XYAndZ[]) => opts.fromIModelCoords({ target: opts.datum, iModelCoords }),\r\n    });\r\n  }\r\n\r\n  /** Convert the specified geographic coordinates into iModel coordinates. */\r\n  public async convertToIModelCoords(geoPoints: XYZProps[]): Promise<PointWithStatus[]> {\r\n    const result = await this.getIModelCoordinatesFromGeoCoordinates(geoPoints);\r\n    return result.iModelCoords;\r\n  }\r\n\r\n  /** Convert the specified iModel coordinates into geographic coordinates. */\r\n  public async convertFromIModelCoords(iModelCoords: XYZProps[]): Promise<PointWithStatus[]> {\r\n    const result = await this.getGeoCoordinatesFromIModelCoordinates(iModelCoords);\r\n    return result.geoCoords;\r\n  }\r\n\r\n  /** @internal */\r\n  public async getIModelCoordinatesFromGeoCoordinates(geoPoints: XYZProps[]): Promise<IModelCoordinatesResponseProps> {\r\n    const result = await this._geoToIModel.convert(geoPoints);\r\n    this.checkCompletion();\r\n    return {\r\n      iModelCoords: result.points,\r\n      fromCache: result.fromCache,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  public async getGeoCoordinatesFromIModelCoordinates(iModelPoints: XYZProps[]): Promise<GeoCoordinatesResponseProps> {\r\n    const result = await this._iModelToGeo.convert(iModelPoints);\r\n    this.checkCompletion();\r\n    return {\r\n      geoCoords: result.points,\r\n      fromCache: result.fromCache,\r\n    };\r\n  }\r\n\r\n  private checkCompletion(): void {\r\n    if (this._geoToIModel.isIdle && this._iModelToGeo.isIdle)\r\n      this.onAllRequestsCompleted.raiseEvent();\r\n  }\r\n\r\n  /** @internal */\r\n  public getCachedIModelCoordinatesFromGeoCoordinates(geoPoints: XYZProps[]): CachedIModelCoordinatesResponseProps {\r\n    return this._geoToIModel.findCached(geoPoints);\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport type GeoServicesOptions = Omit<GeoConverterOptions, \"datum\">;\r\n\r\n/** The Geographic Services available for an [[IModelConnection]].\r\n * @see [[IModelConnection.geoServices]] to obtain the GeoServices for a specific iModel.\r\n * @public\r\n */\r\nexport class GeoServices {\r\n  private readonly _options: GeoServicesOptions;\r\n  /** Each GeoConverter has its own independent request queue and cache of previously-converted points.\r\n   * Some callers like RealityTileTree obtain a single GeoConverter and reuse it throughout their own lifetime. Therefore they benefit from both batching and caching, and\r\n   * the cache gets deleted once the RealityTileTree becomes disused.\r\n   *\r\n   * Other callers like IModelConnection.spatialToCartographic obtain a new GeoConverter every time they need one, use it to convert a single point(!), and then discard the converter.\r\n   * This entirely prevents batching - e.g., calling spatialToCartographic 20 times in one frame results in 20 http requests.\r\n   * To address that, we cache each GeoConverter returned by getConverter until it has converted at least one point and has no further outstanding conversion requests.\r\n   * In this way, the converter lives for as long as (and no longer than) any caller is awaiting conversion to/from its datum - it and its cache are deleted once it becomes disused.\r\n   * This makes the coordinate caching generally less useful, but at least bounded - and maximizes batching of requests.\r\n   */\r\n  private readonly _cache = new Map<string, GeoConverter>();\r\n\r\n  /** @internal */\r\n  public constructor(options: GeoServicesOptions) {\r\n    this._options = options;\r\n  }\r\n\r\n  /** @internal */\r\n  public static createForIModel(iModel: IModelConnection): GeoServices {\r\n    return new GeoServices({\r\n      isIModelClosed: () => iModel.isClosed,\r\n      toIModelCoords: async (request) => {\r\n        const rpc = IModelReadRpcInterface.getClientForRouting(iModel.routingContext.token);\r\n        const response = await rpc.getIModelCoordinatesFromGeoCoordinates(iModel.getRpcProps(), request);\r\n        return response.iModelCoords;\r\n      },\r\n      fromIModelCoords: async (request) => {\r\n        const rpc = IModelReadRpcInterface.getClientForRouting(iModel.routingContext.token);\r\n        const response = await rpc.getGeoCoordinatesFromIModelCoordinates(iModel.getRpcProps(), request);\r\n        return response.geoCoords;\r\n      },\r\n    });\r\n  }\r\n\r\n  /** Obtain a converter that can convert between a geographic coordinate system and the iModel's own coordinate system.\r\n   * @param datumOrGCRS The name or JSON representation of the geographic coordinate system datum - for example, \"WGS84\".\r\n   * @returns a converter, or `undefined` if the iModel is not open.\r\n   * @note A [[BlankConnection]] has no connection to a backend, so it is never \"open\"; therefore it always returns `undefined`.\r\n   */\r\n  public getConverter(datumOrGCRS?: string | GeographicCRSProps): GeoConverter | undefined {\r\n    if (this._options.isIModelClosed())\r\n      return undefined;\r\n\r\n    const datum = (typeof datumOrGCRS === \"object\" ? JSON.stringify(datumOrGCRS) : datumOrGCRS) ?? \"\";\r\n\r\n    let converter = this._cache.get(datum);\r\n    if (!converter) {\r\n      converter = new GeoConverter({ ...this._options, datum });\r\n      this._cache.set(datum, converter);\r\n\r\n      converter.onAllRequestsCompleted.addOnce(() => {\r\n        if (converter === this._cache.get(datum))\r\n          this._cache.delete(datum);\r\n      });\r\n    }\r\n\r\n    return converter;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"GeoServices.js","sourceRoot":"","sources":["../../src/GeoServices.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,qBAAqB;AACrB,sDAE6B;AAE7B,oDAG4B;AAE5B,4EAAyE;AAezE,SAAS,aAAa,CAAC,GAAW,EAAE,GAAW;IAC7C,OAAO,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,OAAO,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;AAC1C,CAAC;AAUD;;;;;;;;;;;;GAYG;AACH,MAAa,mBAAmB;IACX,MAAM,CAAsC;IACrD,MAAM,GAA6B,MAAM,CAAC;IACpD,qEAAqE;IAC3D,QAAQ,CAAsB;IACxC,iFAAiF;IACvE,SAAS,CAAsB;IACzC,kDAAkD;IACxC,YAAY,GAAG,IAAI,sBAAO,EAAc,CAAC;IACnD,oGAAoG;IACjF,WAAW,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;IACnC,oBAAoB,CAAS;IAC7B,eAAe,CAAgB;IAC/B,cAAc,CAAmD;IACnE,UAAU,CAA0C;IACrE,qFAAqF;IACrF,iIAAiI;IACjI,gGAAgG;IACtF,uBAAuB,GAAG,KAAK,CAAC;IAE1C,IAAW,MAAM;QACf,OAAO,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC;IAChC,CAAC;IAES,QAAQ,CAAC,KAAe,EAAE,MAAsB;QACxD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACzB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACzB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;YACxB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;YACxB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,YAAmB,IAAgC;QACjD,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,mBAAmB,IAAI,GAAG,CAAC,CAAC;QACzE,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC;QAEjC,IAAI,CAAC,MAAM,GAAG,IAAI,yBAAU,CAA0B,aAAa,EAAE,WAAW,CAAC,CAAC;QAClF,IAAI,CAAC,QAAQ,GAAG,IAAI,0BAAW,CAAS,aAAa,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;QAC3E,IAAI,CAAC,SAAS,GAAG,IAAI,0BAAW,CAAS,aAAa,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;IAC9E,CAAC;IAES,KAAK,CAAC,QAAQ;QACtB,IAAA,qBAAM,EAAC,IAAI,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC;QACpC,IAAI,IAAI,CAAC,eAAe,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACpD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACrB,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;YAC/B,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;QAE1B,uFAAuF;QACvF,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,IAAI,CAAC,YAAY,GAAG,IAAI,sBAAO,EAAc,CAAC;QAE9C,+HAA+H;QAC/H,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,IAAA,qBAAM,EAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAE1B,kGAAkG;QAClG,MAAM,QAAQ,GAAyB,EAAE,CAAC;QAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YACpE,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,CAAC,YAAY,EAAE,CAAC;YACjF,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC7D,IAAI,IAAI,CAAC,eAAe,EAAE;oBACxB,OAAO;gBAET,IAAI,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM;oBACpC,qBAAM,CAAC,QAAQ,CAAC,GAAG,+CAAsB,CAAC,OAAO,cAAc,EAAE,2BAA2B,QAAQ,CAAC,MAAM,yBAAyB,OAAO,CAAC,MAAM,SAAS,CAAC,CAAC;gBAE/J,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBACxC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM;wBACrB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC7C,CAAC;YACH,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACf,qBAAM,CAAC,QAAQ,CAAC,GAAG,+CAAsB,CAAC,OAAO,cAAc,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;oBAC3E,SAAS,EAAE,IAAI,CAAC,UAAU;oBAC1B,UAAU,EAAE,QAAQ,CAAC,MAAM;iBAC5B,CAAC,CAAC,CAAC;YACN,CAAC,CAAC,CAAC;YAEH,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAE5B,IAAA,qBAAM,EAAC,IAAI,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QAEvB,iGAAiG;QACjG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC3D,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAC;YACrC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,8DAA8D;QACzF,CAAC;QAED,kEAAkE;QAClE,WAAW,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;IAED,+DAA+D;IAC/D,gDAAgD;IACtC,OAAO,CAAC,MAAkB;QAClC,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACnD,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC;gBACtB,EAAE,UAAU,CAAC;iBACV,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC;gBACnC,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC;;gBAEpC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC9B,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,0HAA0H;IAC1H,2EAA2E;IACjE,YAAY,CAAC,MAAkB;QACvC,MAAM,OAAO,GAAsB,EAAE,CAAC;QACtC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACnD,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,MAAM;gBACT,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,GAAG,GAAG,EAAE,EAAE,CAAC,EAAE,4BAAc,CAAC,UAAU,EAAE,CAAC;YAE3D,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACvB,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAES,KAAK,CAAC,gBAAgB;QAC9B,IAAI,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;YAC3B,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;YAC1B,qBAAqB,CAAC,GAAG,EAAE;gBACzB,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,8DAA8D;YACjF,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,MAAkB;QACrC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACvC,IAAA,qBAAM,EAAC,SAAS,IAAI,CAAC,CAAC,CAAC;QACvB,IAAA,qBAAM,EAAC,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;QAEnC,IAAI,SAAS,KAAK,MAAM,CAAC,MAAM;YAC7B,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;QAE1D,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAE9B,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;IAC1D,CAAC;IAEM,UAAU,CAAC,MAAkB;QAClC,MAAM,MAAM,GAAuC,EAAE,CAAC;QACtD,IAAI,OAA+B,CAAC;QACpC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACnD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACpC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACpB,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,IAAI,CAAC,OAAO;oBACV,OAAO,GAAG,EAAE,CAAC;gBAEf,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;QACH,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAC7B,CAAC;CACF;AA1LD,kDA0LC;AAsBD;;;;GAIG;AACH,MAAa,YAAY;IACN,YAAY,CAAsB;IAClC,YAAY,CAAsB;IACnD;;OAEG;IACa,sBAAsB,GAAG,IAAI,sBAAO,EAAc,CAAC;IAEnE,gBAAgB;IAChB,YAAY,IAAyB;QACnC,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC3C,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC;YAC1C,SAAS,EAAE,aAAa;YACxB,cAAc;YACd,aAAa,EAAE,KAAK,EAAE,SAAmB,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC;SACrG,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC;YAC1C,SAAS,EAAE,aAAa;YACxB,cAAc;YACd,aAAa,EAAE,KAAK,EAAE,YAAsB,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,CAAC;SAC7G,CAAC,CAAC;IACL,CAAC;IAED,4EAA4E;IACrE,KAAK,CAAC,qBAAqB,CAAC,SAAqB;QACtD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,sCAAsC,CAAC,SAAS,CAAC,CAAC;QAC5E,OAAO,MAAM,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED,4EAA4E;IACrE,KAAK,CAAC,uBAAuB,CAAC,YAAwB;QAC3D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,sCAAsC,CAAC,YAAY,CAAC,CAAC;QAC/E,OAAO,MAAM,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,sCAAsC,CAAC,SAAqB;QACvE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC1D,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,OAAO;YACL,YAAY,EAAE,MAAM,CAAC,MAAM;YAC3B,SAAS,EAAE,MAAM,CAAC,SAAS;SAC5B,CAAC;IACJ,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,sCAAsC,CAAC,YAAwB;QAC1E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAC7D,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,OAAO;YACL,SAAS,EAAE,MAAM,CAAC,MAAM;YACxB,SAAS,EAAE,MAAM,CAAC,SAAS;SAC5B,CAAC;IACJ,CAAC;IAEO,eAAe;QACrB,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM;YACtD,IAAI,CAAC,sBAAsB,CAAC,UAAU,EAAE,CAAC;IAC7C,CAAC;IAED,gBAAgB;IACT,4CAA4C,CAAC,SAAqB;QACvE,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACjD,CAAC;CACF;AAjED,oCAiEC;AAKD;;;GAGG;AACH,MAAa,WAAW;IACL,QAAQ,CAAqB;IAC9C;;;;;;;;;OASG;IACc,MAAM,GAAG,IAAI,GAAG,EAAwB,CAAC;IAE1D,gBAAgB;IAChB,YAAmB,OAA2B;QAC5C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,eAAe,CAAC,MAAwB;QACpD,OAAO,IAAI,WAAW,CAAC;YACrB,cAAc,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ;YACrC,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;gBAChC,MAAM,GAAG,GAAG,oCAAsB,CAAC,mBAAmB,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;gBACpF,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,sCAAsC,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;gBACjG,OAAO,QAAQ,CAAC,YAAY,CAAC;YAC/B,CAAC;YACD,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;gBAClC,MAAM,GAAG,GAAG,oCAAsB,CAAC,mBAAmB,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;gBACpF,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,sCAAsC,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;gBACjG,OAAO,QAAQ,CAAC,SAAS,CAAC;YAC5B,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,WAAyC;QAC3D,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE;YAChC,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAG,CAAC,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QAElG,IAAI,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACvC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAS,GAAG,IAAI,YAAY,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;YAC1D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YAElC,SAAS,CAAC,sBAAsB,CAAC,OAAO,CAAC,GAAG,EAAE;gBAC5C,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;oBACtC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AA5DD,kCA4DC","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 IModelConnection\r\n */\r\n\r\n// cspell:ignore GCRS\r\nimport {\r\n  assert, BeEvent, Dictionary, Logger, SortedArray,\r\n} from \"@itwin/core-bentley\";\r\nimport { WritableXYAndZ, XYAndZ, XYZProps } from \"@itwin/core-geometry\";\r\nimport {\r\n  GeoCoordinatesRequestProps, GeoCoordinatesResponseProps, GeoCoordStatus, GeographicCRSProps, IModelCoordinatesRequestProps, IModelCoordinatesResponseProps,\r\n  IModelReadRpcInterface, PointWithStatus,\r\n} from \"@itwin/core-common\";\r\nimport { IModelConnection } from \"./IModelConnection\";\r\nimport { FrontendLoggerCategory } from \"./common/FrontendLoggerCategory\";\r\n\r\n/** Options used to create a [[CoordinateConverter]].\r\n * @internal exported strictly for tests.\r\n */\r\nexport interface CoordinateConverterOptions {\r\n  /** Conversion direction included in error diagnostics. */\r\n  direction: \"geoToIModel\" | \"iModelToGeo\";\r\n  isIModelClosed: () => boolean;\r\n  /** Asynchronously convert each point. The resultant array should have the same number and order of points as the input. */\r\n  requestPoints: (points: XYAndZ[]) => Promise<PointWithStatus[]>;\r\n  /** Maximum number of points to include in each request. Default: 300. */\r\n  maxPointsPerRequest?: number;\r\n}\r\n\r\nfunction compareXYAndZ(lhs: XYAndZ, rhs: XYAndZ): number {\r\n  return lhs.x - rhs.x || lhs.y - rhs.y || lhs.z - rhs.z;\r\n}\r\n\r\nfunction cloneXYAndZ(xyz: XYAndZ): XYAndZ {\r\n  return { x: xyz.x, y: xyz.y, z: xyz.z };\r\n}\r\n\r\ntype CoordinateConverterState =\r\n  // No pending requests.\r\n  \"idle\" |\r\n  // We have scheduled a requestAnimationFrame to dispatch all pending requests.\r\n  \"scheduled\" |\r\n  // We have dispatched all requests that were pending at the most recent requestAnimationFrame callback.\r\n  \"in-flight\";\r\n\r\n/** Performs conversion of coordinates from one coordinate system to another.\r\n * A [[GeoConverter]] has a pair of these for converting between iModel coordinates and geographic coordinates.\r\n * Uses a cache to avoid repeatedly requesting the same points, and a batching strategy to avoid making frequent small requests.\r\n * The cache stores every point that was ever converted by [[convert]]. It is currently permitted to grow to unbounded size.\r\n * The batching works as follows:\r\n *  When a conversion is requested via [[convert]], if all the requested points are in the cache, they are returned immediately.\r\n *  Otherwise, any points not in the cache and not in the current in-flight request (if any) are placed onto the queue of pending requests.\r\n *  A pending request is scheduled if one hasn't already been scheduled, via requestAnimationFrame.\r\n *  In the animation frame callback, the pending requests are split into batches of no more than options.maxPointsPerRequest and dispatched to the backend.\r\n *  Once the response is received, the results are loaded into and returned from the cache.\r\n *  If more calls to convert occurred while the request was in flight, another request is dispatched.\r\n * @internal exported strictly for tests.\r\n */\r\nexport class CoordinateConverter {\r\n  protected readonly _cache: Dictionary<XYAndZ, PointWithStatus>;\r\n  protected _state: CoordinateConverterState = \"idle\";\r\n  // The accumulated set of points to be converted by the next request.\r\n  protected _pending: SortedArray<XYAndZ>;\r\n  // The set of points that were included in the current in-flight request, if any.\r\n  protected _inflight: SortedArray<XYAndZ>;\r\n  // An event fired when the next request completes.\r\n  protected _onCompleted = new BeEvent<() => void>();\r\n  // Used for creating cache keys (XYAndZ) from XYZProps without having to allocate temporary objects.\r\n  protected readonly _scratchXYZ = { x: 0, y: 0, z: 0 };\r\n  protected readonly _maxPointsPerRequest: number;\r\n  protected readonly _isIModelClosed: () => boolean;\r\n  protected readonly _requestPoints: (points: XYAndZ[]) => Promise<PointWithStatus[]>;\r\n  private readonly _direction: CoordinateConverterOptions[\"direction\"];\r\n  // If true, [[dispatch]] will schedule another dispatch after it receives a response.\r\n  // This is needed when all the points requested after the most recent dispatch were included in the currently-in-flight request -\r\n  // _pending will be empty but new callers will be awaiting the results of the in-flight request.\r\n  protected _redispatchOnCompletion = false;\r\n\r\n  public get isIdle(): boolean {\r\n    return \"idle\" === this._state;\r\n  }\r\n\r\n  protected toXYAndZ(input: XYZProps, output: WritableXYAndZ): XYAndZ {\r\n    if (Array.isArray(input)) {\r\n      output.x = input[0] ?? 0;\r\n      output.y = input[1] ?? 0;\r\n      output.z = input[2] ?? 0;\r\n    } else {\r\n      output.x = input.x ?? 0;\r\n      output.y = input.y ?? 0;\r\n      output.z = input.z ?? 0;\r\n    }\r\n\r\n    return output;\r\n  }\r\n\r\n  public constructor(opts: CoordinateConverterOptions) {\r\n    this._maxPointsPerRequest = Math.max(1, opts.maxPointsPerRequest ?? 300);\r\n    this._isIModelClosed = opts.isIModelClosed;\r\n    this._requestPoints = opts.requestPoints;\r\n    this._direction = opts.direction;\r\n\r\n    this._cache = new Dictionary<XYAndZ, PointWithStatus>(compareXYAndZ, cloneXYAndZ);\r\n    this._pending = new SortedArray<XYAndZ>(compareXYAndZ, false, cloneXYAndZ);\r\n    this._inflight = new SortedArray<XYAndZ>(compareXYAndZ, false, cloneXYAndZ);\r\n  }\r\n\r\n  protected async dispatch(): Promise<void> {\r\n    assert(this._state === \"scheduled\");\r\n    if (this._isIModelClosed() || this._pending.isEmpty) {\r\n      this._state = \"idle\";\r\n      this._onCompleted.raiseEvent();\r\n      return;\r\n    }\r\n\r\n    this._state = \"in-flight\";\r\n\r\n    // Ensure subsequently-enqueued requests listen for the *next* response to be received.\r\n    const onCompleted = this._onCompleted;\r\n    this._onCompleted = new BeEvent<() => void>();\r\n\r\n    // Pending requests are now in flight. Start a new list of pending requests. It's cheaper to swap than to allocate new objects.\r\n    const inflight = this._pending;\r\n    this._pending = this._inflight;\r\n    assert(this._pending.isEmpty);\r\n    this._inflight = inflight;\r\n\r\n    // Split requests if necessary to avoid requesting more than the maximum allowed number of points.\r\n    const promises: Array<Promise<void>> = [];\r\n    for (let i = 0; i < inflight.length; i += this._maxPointsPerRequest) {\r\n      const requests = inflight.slice(i, i + this._maxPointsPerRequest).extractArray();\r\n      const promise = this._requestPoints(requests).then((results) => {\r\n        if (this._isIModelClosed())\r\n          return;\r\n\r\n        if (results.length !== requests.length)\r\n          Logger.logError(`${FrontendLoggerCategory.Package}.geoservices`, `requested conversion of ${requests.length} points, but received ${results.length} points`);\r\n\r\n        for (let j = 0; j < results.length; j++) {\r\n          if (j < requests.length)\r\n            this._cache.set(requests[j], results[j]);\r\n        }\r\n      }).catch((err) => {\r\n        Logger.logError(`${FrontendLoggerCategory.Package}.geoservices`, err, () => ({\r\n          direction: this._direction,\r\n          pointCount: requests.length,\r\n        }));\r\n      });\r\n\r\n      promises.push(promise);\r\n    }\r\n\r\n    await Promise.all(promises);\r\n\r\n    assert(this._state === \"in-flight\");\r\n    this._state = \"idle\";\r\n    this._inflight.clear();\r\n\r\n    // If any more pending conversions arrived while awaiting this request, schedule another request.\r\n    if (!this._pending.isEmpty || this._redispatchOnCompletion) {\r\n      this._redispatchOnCompletion = false;\r\n      this.scheduleDispatch(); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n    }\r\n\r\n    // Resolve promises of all callers who were awaiting this request.\r\n    onCompleted.raiseEvent();\r\n  }\r\n\r\n  // Add any points not present in cache to pending request list.\r\n  // Return the number of points present in cache.\r\n  protected enqueue(points: XYZProps[]): number {\r\n    let numInCache = 0;\r\n    for (const point of points) {\r\n      const xyz = this.toXYAndZ(point, this._scratchXYZ);\r\n      if (this._cache.get(xyz))\r\n        ++numInCache;\r\n      else if (this._inflight.contains(xyz))\r\n        this._redispatchOnCompletion = true;\r\n      else\r\n        this._pending.insert(xyz);\r\n    }\r\n\r\n    return numInCache;\r\n  }\r\n\r\n  // Obtain converted points from the cache. The assumption is that every point in `inputs` is already present in the cache.\r\n  // Any point not present will be returned unconverted with an error status.\r\n  protected getFromCache(inputs: XYZProps[]): PointWithStatus[] {\r\n    const outputs: PointWithStatus[] = [];\r\n    for (const input of inputs) {\r\n      const xyz = this.toXYAndZ(input, this._scratchXYZ);\r\n      let output = this._cache.get(xyz);\r\n      if (!output)\r\n        output = { p: { ...xyz }, s: GeoCoordStatus.CSMapError };\r\n\r\n      outputs.push(output);\r\n    }\r\n\r\n    return outputs;\r\n  }\r\n\r\n  protected async scheduleDispatch(): Promise<void> {\r\n    if (\"idle\" === this._state) {\r\n      this._state = \"scheduled\";\r\n      requestAnimationFrame(() => {\r\n        this.dispatch(); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n      });\r\n    }\r\n\r\n    return new Promise((resolve) => {\r\n      this._onCompleted.addOnce(() => resolve());\r\n    });\r\n  }\r\n\r\n  public async convert(inputs: XYZProps[]): Promise<{ points: PointWithStatus[], fromCache: number }> {\r\n    const fromCache = this.enqueue(inputs);\r\n    assert(fromCache >= 0);\r\n    assert(fromCache <= inputs.length);\r\n\r\n    if (fromCache === inputs.length)\r\n      return { points: this.getFromCache(inputs), fromCache };\r\n\r\n    await this.scheduleDispatch();\r\n\r\n    return { points: this.getFromCache(inputs), fromCache };\r\n  }\r\n\r\n  public findCached(inputs: XYZProps[]): CachedIModelCoordinatesResponseProps {\r\n    const result: Array<PointWithStatus | undefined> = [];\r\n    let missing: XYZProps[] | undefined;\r\n    for (const input of inputs) {\r\n      const key = this.toXYAndZ(input, this._scratchXYZ);\r\n      const output = this._cache.get(key);\r\n      result.push(output);\r\n      if (!output) {\r\n        if (!missing)\r\n          missing = [];\r\n\r\n        missing.push(input);\r\n      }\r\n    }\r\n\r\n    return { result, missing };\r\n  }\r\n}\r\n\r\n/** Response to a request to obtain imodel coordinates from cache.\r\n * @internal\r\n */\r\nexport interface CachedIModelCoordinatesResponseProps {\r\n  /** An array of the same length as the input array, with undefined entries at indices corresponding to points not found in cache. */\r\n  result: Array<PointWithStatus | undefined>;\r\n  /** An array of points in the input array which were not found in the cache, or undefined if all points were found in the cache. */\r\n  missing?: XYZProps[];\r\n}\r\n\r\n/** Options used to create a [[GeoConverter]].\r\n * @internal exported strictly for tests.\r\n */\r\nexport interface GeoConverterOptions {\r\n  readonly datum: string;\r\n  isIModelClosed: () => boolean;\r\n  toIModelCoords: (request: IModelCoordinatesRequestProps) => Promise<PointWithStatus[]>;\r\n  fromIModelCoords: (request: GeoCoordinatesRequestProps) => Promise<PointWithStatus[]>;\r\n}\r\n\r\n/** An object capable of communicating with the backend to convert between coordinates in a geographic coordinate system and coordinates in an [[IModelConnection]]'s own coordinate system.\r\n * @see [[GeoServices.getConverter]] to obtain a converter.\r\n * @see [GeographicCRS]($common) for more information about geographic coordinate reference systems.\r\n * @public\r\n */\r\nexport class GeoConverter {\r\n  private readonly _geoToIModel: CoordinateConverter;\r\n  private readonly _iModelToGeo: CoordinateConverter;\r\n  /** Used for removing this converter from GeoServices' cache after all requests are completed.\r\n   * @internal\r\n   */\r\n  public readonly onAllRequestsCompleted = new BeEvent<() => void>();\r\n\r\n  /** @internal */\r\n  constructor(opts: GeoConverterOptions) {\r\n    const isIModelClosed = opts.isIModelClosed;\r\n    this._geoToIModel = new CoordinateConverter({\r\n      direction: \"geoToIModel\",\r\n      isIModelClosed,\r\n      requestPoints: async (geoCoords: XYAndZ[]) => opts.toIModelCoords({ source: opts.datum, geoCoords }),\r\n    });\r\n\r\n    this._iModelToGeo = new CoordinateConverter({\r\n      direction: \"iModelToGeo\",\r\n      isIModelClosed,\r\n      requestPoints: async (iModelCoords: XYAndZ[]) => opts.fromIModelCoords({ target: opts.datum, iModelCoords }),\r\n    });\r\n  }\r\n\r\n  /** Convert the specified geographic coordinates into iModel coordinates. */\r\n  public async convertToIModelCoords(geoPoints: XYZProps[]): Promise<PointWithStatus[]> {\r\n    const result = await this.getIModelCoordinatesFromGeoCoordinates(geoPoints);\r\n    return result.iModelCoords;\r\n  }\r\n\r\n  /** Convert the specified iModel coordinates into geographic coordinates. */\r\n  public async convertFromIModelCoords(iModelCoords: XYZProps[]): Promise<PointWithStatus[]> {\r\n    const result = await this.getGeoCoordinatesFromIModelCoordinates(iModelCoords);\r\n    return result.geoCoords;\r\n  }\r\n\r\n  /** @internal */\r\n  public async getIModelCoordinatesFromGeoCoordinates(geoPoints: XYZProps[]): Promise<IModelCoordinatesResponseProps> {\r\n    const result = await this._geoToIModel.convert(geoPoints);\r\n    this.checkCompletion();\r\n    return {\r\n      iModelCoords: result.points,\r\n      fromCache: result.fromCache,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  public async getGeoCoordinatesFromIModelCoordinates(iModelPoints: XYZProps[]): Promise<GeoCoordinatesResponseProps> {\r\n    const result = await this._iModelToGeo.convert(iModelPoints);\r\n    this.checkCompletion();\r\n    return {\r\n      geoCoords: result.points,\r\n      fromCache: result.fromCache,\r\n    };\r\n  }\r\n\r\n  private checkCompletion(): void {\r\n    if (this._geoToIModel.isIdle && this._iModelToGeo.isIdle)\r\n      this.onAllRequestsCompleted.raiseEvent();\r\n  }\r\n\r\n  /** @internal */\r\n  public getCachedIModelCoordinatesFromGeoCoordinates(geoPoints: XYZProps[]): CachedIModelCoordinatesResponseProps {\r\n    return this._geoToIModel.findCached(geoPoints);\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport type GeoServicesOptions = Omit<GeoConverterOptions, \"datum\">;\r\n\r\n/** The Geographic Services available for an [[IModelConnection]].\r\n * @see [[IModelConnection.geoServices]] to obtain the GeoServices for a specific iModel.\r\n * @public\r\n */\r\nexport class GeoServices {\r\n  private readonly _options: GeoServicesOptions;\r\n  /** Each GeoConverter has its own independent request queue and cache of previously-converted points.\r\n   * Some callers like RealityTileTree obtain a single GeoConverter and reuse it throughout their own lifetime. Therefore they benefit from both batching and caching, and\r\n   * the cache gets deleted once the RealityTileTree becomes disused.\r\n   *\r\n   * Other callers like IModelConnection.spatialToCartographic obtain a new GeoConverter every time they need one, use it to convert a single point(!), and then discard the converter.\r\n   * This entirely prevents batching - e.g., calling spatialToCartographic 20 times in one frame results in 20 http requests.\r\n   * To address that, we cache each GeoConverter returned by getConverter until it has converted at least one point and has no further outstanding conversion requests.\r\n   * In this way, the converter lives for as long as (and no longer than) any caller is awaiting conversion to/from its datum - it and its cache are deleted once it becomes disused.\r\n   * This makes the coordinate caching generally less useful, but at least bounded - and maximizes batching of requests.\r\n   */\r\n  private readonly _cache = new Map<string, GeoConverter>();\r\n\r\n  /** @internal */\r\n  public constructor(options: GeoServicesOptions) {\r\n    this._options = options;\r\n  }\r\n\r\n  /** @internal */\r\n  public static createForIModel(iModel: IModelConnection): GeoServices {\r\n    return new GeoServices({\r\n      isIModelClosed: () => iModel.isClosed,\r\n      toIModelCoords: async (request) => {\r\n        const rpc = IModelReadRpcInterface.getClientForRouting(iModel.routingContext.token);\r\n        const response = await rpc.getIModelCoordinatesFromGeoCoordinates(iModel.getRpcProps(), request);\r\n        return response.iModelCoords;\r\n      },\r\n      fromIModelCoords: async (request) => {\r\n        const rpc = IModelReadRpcInterface.getClientForRouting(iModel.routingContext.token);\r\n        const response = await rpc.getGeoCoordinatesFromIModelCoordinates(iModel.getRpcProps(), request);\r\n        return response.geoCoords;\r\n      },\r\n    });\r\n  }\r\n\r\n  /** Obtain a converter that can convert between a geographic coordinate system and the iModel's own coordinate system.\r\n   * @param datumOrGCRS The name or JSON representation of the geographic coordinate system datum - for example, \"WGS84\".\r\n   * @returns a converter, or `undefined` if the iModel is not open.\r\n   * @note A [[BlankConnection]] has no connection to a backend, so it is never \"open\"; therefore it always returns `undefined`.\r\n   */\r\n  public getConverter(datumOrGCRS?: string | GeographicCRSProps): GeoConverter | undefined {\r\n    if (this._options.isIModelClosed())\r\n      return undefined;\r\n\r\n    const datum = (typeof datumOrGCRS === \"object\" ? JSON.stringify(datumOrGCRS) : datumOrGCRS) ?? \"\";\r\n\r\n    let converter = this._cache.get(datum);\r\n    if (!converter) {\r\n      converter = new GeoConverter({ ...this._options, datum });\r\n      this._cache.set(datum, converter);\r\n\r\n      converter.onAllRequestsCompleted.addOnce(() => {\r\n        if (converter === this._cache.get(datum))\r\n          this._cache.delete(datum);\r\n      });\r\n    }\r\n\r\n    return converter;\r\n  }\r\n}\r\n"]}

package/lib/cjs/IModelApp.d.ts

@@ -414,6 +414,7 @@ export declare class IModelApp {
      */
     static makeIModelJsLogoCard(): HTMLTableRowElement;
     /** Format the tooltip strings returned by [[IModelConnection.getToolTipMessage]].
+     * @note Each string is interpreted as HTML. Any untrusted content must be HTML-escaped or sanitized before calling this method.
      * @alpha
      */
     static formatElementToolTip(msg: string[]): HTMLElement;