@itwin/core-backend 3.5.0-dev.5 → 3.5.0-dev.52

package/lib/cjs/IpcHost.d.ts

@@ -4,6 +4,7 @@
 import { EditingScopeNotifications, IpcAppNotifications, IpcListener, IpcSocketBackend, RemoveFunction, TxnNotifications } from "@itwin/core-common";
 import { BriefcaseDb, StandaloneDb } from "./IModelDb";
 import { IModelHostOptions } from "./IModelHost";
+import { ProgressFunction, ProgressStatus } from "./CheckpointManager";
 /**
   * Options for [[IpcHost.startup]]
   * @public
@@ -96,4 +97,9 @@ export declare abstract class IpcHandler {
      */
     static register(): RemoveFunction;
 }
+/**
+ * Prevents progress callback being called more frequently when provided interval.
+ * @internal
+ */
+export declare function throttleProgressCallback(func: ProgressFunction, checkAbort: () => ProgressStatus, progressInterval?: number): ProgressFunction;
 //# sourceMappingURL=IpcHost.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"IpcHost.d.ts","sourceRoot":"","sources":["../../src/IpcHost.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EACgC,yBAAyB,EAC9D,mBAAmB,EAAmB,WAAW,EAAE,gBAAgB,EAAoC,cAAc,EACjG,gBAAgB,EACrC,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,WAAW,EAAY,YAAY,EAAE,MAAM,YAAY,CAAC;AACjE,OAAO,EAAc,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAG7D;;;IAGI;AACJ,MAAM,WAAW,WAAW;IAC1B,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,OAAO,CAAC,EAAE;QACR,wGAAwG;QACxG,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAE1B,iDAAiD;QACjD,UAAU,CAAC,EAAE;YACX,OAAO,CAAC,EAAE,OAAO,CAAC;SACnB,CAAC;KACH,CAAC;CACH;AAED;;;;GAIG;AACH,qBAAa,OAAO;IAClB,OAAc,OAAO,UAAS;IAC9B,OAAO,CAAC,MAAM,CAAC,IAAI,CAA+B;IAClD,2EAA2E;IAC3E,OAAO,CAAC,MAAM,KAAK,GAAG,GAA2C;IACjE,gIAAgI;IAChI,WAAkB,OAAO,IAAI,OAAO,CAAoC;IAExE;;;;OAIG;WACW,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;IAIzD;;;;;OAKG;WACW,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,GAAG,cAAc;IAGhG;;;;;OAKG;WACW,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,GAAG,cAAc;IAGjF;;;;OAIG;WACW,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,GAAG,IAAI;IAI1E,OAAO,CAAC,MAAM,CAAC,MAAM;IAKrB,gBAAgB;WACF,iBAAiB,CAAC,CAAC,SAAS,MAAM,mBAAmB,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAI/H,gBAAgB;WACF,UAAU,CAAC,CAAC,SAAS,MAAM,gBAAgB,EAAE,SAAS,EAAE,WAAW,GAAG,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAIzJ,gBAAgB;WACF,kBAAkB,CAAC,CAAC,SAAS,MAAM,yBAAyB,EAAE,SAAS,EAAE,WAAW,GAAG,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;IAInL;;;;OAIG;WACiB,OAAO,CAAC,GAAG,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAY7D,mEAAmE;WAC/C,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;CAI9C;AAED;;;;;;;;;;;GAWG;AACH,8BAAsB,UAAU;IAC9B,+EAA+E;IAC/E,aAAoB,WAAW,IAAI,MAAM,CAAC;IAE1C;;;;;OAKG;WACW,QAAQ,IAAI,cAAc;CAuBzC"}
+{"version":3,"file":"IpcHost.d.ts","sourceRoot":"","sources":["../../src/IpcHost.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EACgC,yBAAyB,EAC9B,mBAAmB,EAAmB,WAAW,EAAE,gBAAgB,EAC/E,cAAc,EAA6C,gBAAgB,EAChG,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,WAAW,EAAY,YAAY,EAAE,MAAM,YAAY,CAAC;AACjE,OAAO,EAAc,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAE7D,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAEvE;;;IAGI;AACJ,MAAM,WAAW,WAAW;IAC1B,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,OAAO,CAAC,EAAE;QACR,wGAAwG;QACxG,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAE1B,iDAAiD;QACjD,UAAU,CAAC,EAAE;YACX,OAAO,CAAC,EAAE,OAAO,CAAC;SACnB,CAAC;KACH,CAAC;CACH;AAED;;;;GAIG;AACH,qBAAa,OAAO;IAClB,OAAc,OAAO,UAAS;IAC9B,OAAO,CAAC,MAAM,CAAC,IAAI,CAA+B;IAClD,2EAA2E;IAC3E,OAAO,CAAC,MAAM,KAAK,GAAG,GAA2C;IACjE,gIAAgI;IAChI,WAAkB,OAAO,IAAI,OAAO,CAAoC;IAExE;;;;OAIG;WACW,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;IAIzD;;;;;OAKG;WACW,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,GAAG,cAAc;IAGhG;;;;;OAKG;WACW,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,GAAG,cAAc;IAGjF;;;;OAIG;WACW,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,GAAG,IAAI;IAI1E,OAAO,CAAC,MAAM,CAAC,MAAM;IAKrB,gBAAgB;WACF,iBAAiB,CAAC,CAAC,SAAS,MAAM,mBAAmB,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAI/H,gBAAgB;WACF,UAAU,CAAC,CAAC,SAAS,MAAM,gBAAgB,EAAE,SAAS,EAAE,WAAW,GAAG,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAIzJ,gBAAgB;WACF,kBAAkB,CAAC,CAAC,SAAS,MAAM,yBAAyB,EAAE,SAAS,EAAE,WAAW,GAAG,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;IAInL;;;;OAIG;WACiB,OAAO,CAAC,GAAG,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAY7D,mEAAmE;WAC/C,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;CAI9C;AAED;;;;;;;;;;;GAWG;AACH,8BAAsB,UAAU;IAC9B,+EAA+E;IAC/E,aAAoB,WAAW,IAAI,MAAM,CAAC;IAE1C;;;;;OAKG;WACW,QAAQ,IAAI,cAAc;CAuBzC;AA+HD;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,cAAc,EAAE,gBAAgB,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAa9I"}

package/lib/cjs/IpcHost.js

@@ -7,12 +7,13 @@
  * @module NativeApp
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IpcHandler = exports.IpcHost = void 0;
+exports.throttleProgressCallback = exports.IpcHandler = exports.IpcHost = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
 const core_common_1 = require("@itwin/core-common");
 const IModelDb_1 = require("./IModelDb");
 const IModelHost_1 = require("./IModelHost");
 const IModelTileRpcImpl_1 = require("./rpc-impl/IModelTileRpcImpl");
+const CheckpointManager_1 = require("./CheckpointManager");
 /**
  * Used by applications that have a dedicated backend. IpcHosts may send messages to their corresponding IpcApp.
  * @note if either end terminates, the other must too.
@@ -145,6 +146,10 @@ exports.IpcHandler = IpcHandler;
  * Implementation  of IpcAppFunctions
  */
 class IpcAppHandler extends IpcHandler {
+    constructor() {
+        super(...arguments);
+        this._iModelKeyToPullStatus = new Map();
+    }
     get channelName() { return core_common_1.IpcAppChannel.Functions; }
     async log(_timestamp, level, category, message, metaData) {
         switch (level) {
@@ -196,11 +201,32 @@ class IpcAppHandler extends IpcHandler {
     async getRedoString(key) {
         return IModelDb_1.IModelDb.findByKey(key).nativeDb.getUndoString();
     }
-    async pullChanges(key, toIndex) {
+    async pullChanges(key, toIndex, options) {
         const iModelDb = IModelDb_1.BriefcaseDb.findByKey(key);
-        await iModelDb.pullChanges({ toIndex });
+        this._iModelKeyToPullStatus.set(key, CheckpointManager_1.ProgressStatus.Continue);
+        const checkAbort = () => { var _a; return (_a = this._iModelKeyToPullStatus.get(key)) !== null && _a !== void 0 ? _a : CheckpointManager_1.ProgressStatus.Continue; };
+        let onProgress;
+        if (options === null || options === void 0 ? void 0 : options.reportProgress) {
+            const progressCallback = (loaded, total) => {
+                IpcHost.send((0, core_common_1.getPullChangesIpcChannel)(iModelDb.iModelId), { loaded, total });
+                return checkAbort();
+            };
+            onProgress = throttleProgressCallback(progressCallback, checkAbort, options === null || options === void 0 ? void 0 : options.progressInterval);
+        }
+        else if (options === null || options === void 0 ? void 0 : options.enableCancellation) {
+            onProgress = checkAbort;
+        }
+        try {
+            await iModelDb.pullChanges({ toIndex, onProgress });
+        }
+        finally {
+            this._iModelKeyToPullStatus.delete(key);
+        }
         return iModelDb.changeset;
     }
+    async cancelPullChangesRequest(key) {
+        this._iModelKeyToPullStatus.set(key, CheckpointManager_1.ProgressStatus.Abort);
+    }
     async pushChanges(key, description) {
         const iModelDb = IModelDb_1.BriefcaseDb.findByKey(key);
         await iModelDb.pushChanges({ description });
@@ -232,4 +258,22 @@ class IpcAppHandler extends IpcHandler {
         return IModelHost_1.IModelHost.platform.queryConcurrency(pool);
     }
 }
+/**
+ * Prevents progress callback being called more frequently when provided interval.
+ * @internal
+ */
+function throttleProgressCallback(func, checkAbort, progressInterval) {
+    const interval = progressInterval !== null && progressInterval !== void 0 ? progressInterval : 250; // by default, only send progress events every 250 milliseconds
+    let nextTime = Date.now() + interval;
+    const progressCallback = (loaded, total) => {
+        const now = Date.now();
+        if (loaded >= total || now >= nextTime) {
+            nextTime = now + interval;
+            return func(loaded, total);
+        }
+        return checkAbort();
+    };
+    return progressCallback;
+}
+exports.throttleProgressCallback = throttleProgressCallback;
 //# sourceMappingURL=IpcHost.js.map

package/lib/cjs/IpcHost.js.map

@@ -1 +1 @@
-{"version":3,"file":"IpcHost.js","sourceRoot":"","sources":["../../src/IpcHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAqG;AACrG,oDAI4B;AAE5B,yCAAiE;AACjE,6CAA6D;AAC7D,oEAAyE;AAmBzE;;;;GAIG;AACH,MAAa,OAAO;IAGlB,2EAA2E;IACnE,MAAM,KAAK,GAAG,KAAuB,OAAO,IAAI,CAAC,IAAK,CAAC,CAAC,CAAC,CAAC,+DAA+D;IACjI,gIAAgI;IACzH,MAAM,KAAK,OAAO,KAAc,OAAO,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAExE;;;;OAIG;IACI,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,GAAG,IAAW;QAChD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,OAAe,EAAE,OAAyC;QAC7E,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,WAAW,CAAC,OAAe,EAAE,QAAqB;QAC9D,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC/D,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,OAAe,EAAE,QAAqB;QACjE,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAEO,MAAM,CAAC,MAAM,CAAC,OAAe,EAAE,SAAqC,EAAE,UAAkB,EAAE,GAAG,IAAW;QAC9G,IAAI,IAAI,CAAC,OAAO;YACd,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IACzE,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAAsC,UAAa,EAAE,GAAG,IAAwC;QAC7H,OAAO,OAAO,CAAC,IAAI,CAAC,2BAAa,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IACpE,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,UAAU,CAAmC,SAAqC,EAAE,UAAa,EAAE,GAAG,IAAqC;QACvJ,IAAI,CAAC,MAAM,CAAC,2BAAa,CAAC,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IAClE,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,kBAAkB,CAA4C,SAAqC,EAAE,UAAa,EAAE,GAAG,IAA8C;QACjL,IAAI,CAAC,MAAM,CAAC,2BAAa,CAAC,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAiB;;QAC3C,IAAI,CAAC,IAAI,GAAG,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,0CAAE,MAAM,CAAC;QACjC,IAAI,MAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,0CAAE,UAAU,0CAAE,OAAO;YACnC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QAEtB,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,sDAAsD;YACxE,aAAa,CAAC,QAAQ,EAAE,CAAC;SAC1B;QAED,MAAM,uBAAU,CAAC,OAAO,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,mEAAmE;IAC5D,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,MAAM,uBAAU,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;;AArFH,0BAsFC;AArFe,eAAO,GAAG,KAAK,CAAC;AAuFhC;;;;;;;;;;;GAWG;AACH,MAAsB,UAAU;IAI9B;;;;;OAKG;IACI,MAAM,CAAC,QAAQ;QACpB,MAAM,IAAI,GAAG,IAAK,IAAY,EAAgB,CAAC,CAAC,uFAAuF;QACvI,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,IAAW,EAAE,QAAgB,EAAE,GAAG,IAAW,EAA4B,EAAE;;YACxH,IAAI;gBACF,MAAM,IAAI,GAAI,IAAY,CAAC,QAAQ,CAAC,CAAC;gBACrC,IAAI,OAAO,IAAI,KAAK,UAAU;oBAC5B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,gBAAgB,EAAE,WAAW,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,QAAQ,qDAAqD,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;gBAE5K,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;aACnD;YAAC,OAAO,GAAQ,EAAE;gBACjB,MAAM,GAAG,GAAoB;oBAC3B,KAAK,EAAE;wBACL,IAAI,EAAE,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,eAAe;wBAC/E,OAAO,EAAE,2BAAY,CAAC,eAAe,CAAC,GAAG,CAAC;wBAC1C,WAAW,EAAE,MAAA,GAAG,CAAC,WAAW,mCAAI,CAAC;qBAClC;iBACF,CAAC;gBACF,IAAI,CAAC,OAAO,CAAC,OAAO;oBAClB,GAAG,CAAC,KAAK,CAAC,KAAK,GAAG,2BAAY,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;gBACpD,OAAO,GAAG,CAAC;aACZ;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAjCD,gCAiCC;AAED;;GAEG;AACH,MAAM,aAAc,SAAQ,UAAU;IACpC,IAAW,WAAW,KAAK,OAAO,2BAAa,CAAC,SAAS,CAAC,CAAC,CAAC;IAErD,KAAK,CAAC,GAAG,CAAC,UAAkB,EAAE,KAAe,EAAE,QAAgB,EAAE,OAAe,EAAE,QAAc;QACrG,QAAQ,KAAK,EAAE;YACb,KAAK,uBAAQ,CAAC,KAAK;gBACjB,qBAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC7C,MAAM;YACR,KAAK,uBAAQ,CAAC,IAAI;gBAChB,qBAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC5C,MAAM;YACR,KAAK,uBAAQ,CAAC,KAAK;gBACjB,qBAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC7C,MAAM;YACR,KAAK,uBAAQ,CAAC,OAAO;gBACnB,qBAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC/C,MAAM;SACT;IACH,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,UAA0B,EAAE,UAAgC;QACjG,OAAO,IAAA,6CAAyB,EAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC3D,CAAC;IACM,KAAK,CAAC,6BAA6B,CAAC,GAAW,EAAE,UAAoB;QAC1E,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,6BAA6B,CAAC,UAAU,CAAC,CAAC;IACpF,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,IAAwB;QACjD,MAAM,EAAE,GAAG,MAAM,sBAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;IACrB,CAAC;IACM,KAAK,CAAC,cAAc,CAAC,QAAgB,EAAE,QAAkB,EAAE,IAA4B;QAC5F,OAAO,uBAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC9E,CAAC;IACM,KAAK,CAAC,WAAW,CAAC,GAAW;QAClC,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IACM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,WAAoB;QACxD,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IACM,KAAK,CAAC,cAAc,CAAC,GAAW;QACrC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;IAC3D,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,GAAW;QACrC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;IAC3D,CAAC;IACM,KAAK,CAAC,cAAc,CAAC,GAAW;QACrC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;IAC3D,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,GAAW;QACpC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;IAC1D,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,GAAW;QACpC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;IAC1D,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,OAAwB;QAC5D,MAAM,QAAQ,GAAG,sBAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACxC,OAAO,QAAQ,CAAC,SAAgC,CAAC;IACnD,CAAC;IACM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,WAAmB;QACvD,MAAM,QAAQ,GAAG,sBAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;QAC5C,OAAO,QAAQ,CAAC,SAAgC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,2BAA2B,CAAC,GAAW,EAAE,YAAqB;QACzE,MAAM,GAAG,GAAqD,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,gCAAgC,CAAC,YAAY,CAAC,CAAC;QAC9I,IAAI,GAAG,CAAC,KAAK;YACX,MAAM,IAAI,yBAAW,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,0CAA0C,CAAC,CAAC;QACtF,IAAA,qBAAM,EAAC,SAAS,KAAK,GAAG,CAAC,MAAM,CAAC,CAAC;QACjC,OAAO,GAAG,CAAC,MAAM,CAAC;IACpB,CAAC;IACM,KAAK,CAAC,2BAA2B,CAAC,GAAW;QAClD,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,iCAAiC,EAAE,CAAC;IAC9E,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,aAAqB;QACzD,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IACrE,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,GAAW;QACpC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;IACvD,CAAC;IACM,KAAK,CAAC,YAAY,CAAC,GAAW;QACnC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC;IACzD,CAAC;IACM,KAAK,CAAC,iBAAiB,CAAC,GAAW;QACxC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;IAC9D,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,IAAkB;QAC9C,OAAO,uBAAU,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;CACF","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 NativeApp\r\n */\r\n\r\nimport { assert, BentleyError, IModelStatus, Logger, LogLevel, OpenMode } from \"@itwin/core-bentley\";\r\nimport {\r\n  ChangesetIndex, ChangesetIndexAndId, EditingScopeNotifications, IModelConnectionProps, IModelError, IModelRpcProps, IpcAppChannel, IpcAppFunctions,\r\n  IpcAppNotifications, IpcInvokeReturn, IpcListener, IpcSocketBackend, iTwinChannel, OpenBriefcaseProps, RemoveFunction, StandaloneOpenOptions,\r\n  TileTreeContentIds, TxnNotifications,\r\n} from \"@itwin/core-common\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { BriefcaseDb, IModelDb, StandaloneDb } from \"./IModelDb\";\r\nimport { IModelHost, IModelHostOptions } from \"./IModelHost\";\r\nimport { cancelTileContentRequests } from \"./rpc-impl/IModelTileRpcImpl\";\r\n\r\n/**\r\n  * Options for [[IpcHost.startup]]\r\n  * @public\r\n  */\r\nexport interface IpcHostOpts {\r\n  iModelHost?: IModelHostOptions;\r\n  ipcHost?: {\r\n    /** The Ipc socket to use for communications with frontend. Allows undefined only for headless tests. */\r\n    socket?: IpcSocketBackend;\r\n\r\n    /** don't send stack information on exceptions */\r\n    exceptions?: {\r\n      noStack?: boolean;\r\n    };\r\n  };\r\n}\r\n\r\n/**\r\n * Used by applications that have a dedicated backend. IpcHosts may send messages to their corresponding IpcApp.\r\n * @note if either end terminates, the other must too.\r\n * @public\r\n */\r\nexport class IpcHost {\r\n  public static noStack = false;\r\n  private static _ipc: IpcSocketBackend | undefined;\r\n  /** Get the implementation of the [IpcSocketBackend]($common) interface. */\r\n  private static get ipc(): IpcSocketBackend { return this._ipc!; } // eslint-disable-line @typescript-eslint/no-non-null-assertion\r\n  /** Determine whether Ipc is available for this backend. This will only be true if [[startup]] has been called on this class. */\r\n  public static get isValid(): boolean { return undefined !== this._ipc; }\r\n\r\n  /**\r\n   * Send a message to the frontend over an Ipc channel.\r\n   * @param channel the name of the channel matching the name registered with [[IpcApp.addListener]].\r\n   * @param data The content of the message.\r\n   */\r\n  public static send(channel: string, ...data: any[]): void {\r\n    this.ipc.send(iTwinChannel(channel), ...data);\r\n  }\r\n\r\n  /**\r\n   * Establish a handler for an Ipc channel to receive [[Frontend.invoke]] calls\r\n   * @param channel The name of the channel for this handler.\r\n   * @param handler A function that supplies the implementation for `channel`\r\n   * @note returns A function to call to remove the handler.\r\n   */\r\n  public static handle(channel: string, handler: (...args: any[]) => Promise<any>): RemoveFunction {\r\n    return this.ipc.handle(iTwinChannel(channel), handler);\r\n  }\r\n  /**\r\n   * Establish a handler to receive messages sent via [[IpcApp.send]].\r\n   * @param channel The name of the channel for the messages.\r\n   * @param listener A function called when messages are sent over `channel`\r\n   * @note returns A function to call to remove the listener.\r\n   */\r\n  public static addListener(channel: string, listener: IpcListener): RemoveFunction {\r\n    return this.ipc.addListener(iTwinChannel(channel), listener);\r\n  }\r\n  /**\r\n   * Remove a previously registered listener\r\n   * @param channel The name of the channel for the listener previously registered with [[addListener]]\r\n   * @param listener The function passed to [[addListener]]\r\n   */\r\n  public static removeListener(channel: string, listener: IpcListener): void {\r\n    this.ipc.removeListener(iTwinChannel(channel), listener);\r\n  }\r\n\r\n  private static notify(channel: string, briefcase: BriefcaseDb | StandaloneDb, methodName: string, ...args: any[]) {\r\n    if (this.isValid)\r\n      return this.send(`${channel}:${briefcase.key}`, methodName, ...args);\r\n  }\r\n\r\n  /** @internal */\r\n  public static notifyIpcFrontend<T extends keyof IpcAppNotifications>(methodName: T, ...args: Parameters<IpcAppNotifications[T]>) {\r\n    return IpcHost.send(IpcAppChannel.AppNotify, methodName, ...args);\r\n  }\r\n\r\n  /** @internal */\r\n  public static notifyTxns<T extends keyof TxnNotifications>(briefcase: BriefcaseDb | StandaloneDb, methodName: T, ...args: Parameters<TxnNotifications[T]>) {\r\n    this.notify(IpcAppChannel.Txns, briefcase, methodName, ...args);\r\n  }\r\n\r\n  /** @internal */\r\n  public static notifyEditingScope<T extends keyof EditingScopeNotifications>(briefcase: BriefcaseDb | StandaloneDb, methodName: T, ...args: Parameters<EditingScopeNotifications[T]>) {\r\n    this.notify(IpcAppChannel.EditingScope, briefcase, methodName, ...args);\r\n  }\r\n\r\n  /**\r\n   * Start the backend of an Ipc app.\r\n   * @param opt\r\n   * @note this method calls [[IModelHost.startup]] internally.\r\n   */\r\n  public static async startup(opt?: IpcHostOpts): Promise<void> {\r\n    this._ipc = opt?.ipcHost?.socket;\r\n    if (opt?.ipcHost?.exceptions?.noStack)\r\n      this.noStack = true;\r\n\r\n    if (this.isValid) { // for tests, we use IpcHost but don't have a frontend\r\n      IpcAppHandler.register();\r\n    }\r\n\r\n    await IModelHost.startup(opt?.iModelHost);\r\n  }\r\n\r\n  /** Shutdown IpcHost backend. Also calls [[IModelHost.shutdown]] */\r\n  public static async shutdown(): Promise<void> {\r\n    this._ipc = undefined;\r\n    await IModelHost.shutdown();\r\n  }\r\n}\r\n\r\n/**\r\n * Base class for all implementations of an Ipc interface.\r\n *\r\n * Create a subclass to implement your Ipc interface. Your class should be declared like this:\r\n * ```ts\r\n * class MyHandler extends IpcHandler implements MyInterface\r\n * ```\r\n * to ensure all methods and signatures are correct.\r\n *\r\n * Then, call `MyClass.register` at startup to connect your class to your channel.\r\n * @public\r\n */\r\nexport abstract class IpcHandler {\r\n  /** All subclasses must implement this method to specify their channel name. */\r\n  public abstract get channelName(): string;\r\n\r\n  /**\r\n   * Register this class as the handler for methods on its channel. This static method creates a new instance\r\n   * that becomes the handler and is `this` when its methods are called.\r\n   * @returns A function that can be called to remove the handler.\r\n   * @note this method should only be called once per channel. If it is called multiple times, subsequent calls replace the previous ones.\r\n   */\r\n  public static register(): RemoveFunction {\r\n    const impl = new (this as any)() as IpcHandler; // create an instance of subclass. \"as any\" is necessary because base class is abstract\r\n    return IpcHost.handle(impl.channelName, async (_evt: Event, funcName: string, ...args: any[]): Promise<IpcInvokeReturn> => {\r\n      try {\r\n        const func = (impl as any)[funcName];\r\n        if (typeof func !== \"function\")\r\n          throw new IModelError(IModelStatus.FunctionNotFound, `Method \"${impl.constructor.name}.${funcName}\" not found on IpcHandler registered for channel: ${impl.channelName}`);\r\n\r\n        return { result: await func.call(impl, ...args) };\r\n      } catch (err: any) {\r\n        const ret: IpcInvokeReturn = {\r\n          error: {\r\n            name: (err && typeof err === \"object\") ? err.constructor.name : \"Unknown Error\",\r\n            message: BentleyError.getErrorMessage(err),\r\n            errorNumber: err.errorNumber ?? 0,\r\n          },\r\n        };\r\n        if (!IpcHost.noStack)\r\n          ret.error.stack = BentleyError.getErrorStack(err);\r\n        return ret;\r\n      }\r\n    });\r\n  }\r\n}\r\n\r\n/**\r\n * Implementation  of IpcAppFunctions\r\n */\r\nclass IpcAppHandler extends IpcHandler implements IpcAppFunctions {\r\n  public get channelName() { return IpcAppChannel.Functions; }\r\n\r\n  public async log(_timestamp: number, level: LogLevel, category: string, message: string, metaData?: any): Promise<void> {\r\n    switch (level) {\r\n      case LogLevel.Error:\r\n        Logger.logError(category, message, metaData);\r\n        break;\r\n      case LogLevel.Info:\r\n        Logger.logInfo(category, message, metaData);\r\n        break;\r\n      case LogLevel.Trace:\r\n        Logger.logTrace(category, message, metaData);\r\n        break;\r\n      case LogLevel.Warning:\r\n        Logger.logWarning(category, message, metaData);\r\n        break;\r\n    }\r\n  }\r\n\r\n  public async cancelTileContentRequests(tokenProps: IModelRpcProps, contentIds: TileTreeContentIds[]): Promise<void> {\r\n    return cancelTileContentRequests(tokenProps, contentIds);\r\n  }\r\n  public async cancelElementGraphicsRequests(key: string, requestIds: string[]): Promise<void> {\r\n    return IModelDb.findByKey(key).nativeDb.cancelElementGraphicsRequests(requestIds);\r\n  }\r\n  public async openBriefcase(args: OpenBriefcaseProps): Promise<IModelConnectionProps> {\r\n    const db = await BriefcaseDb.open(args);\r\n    return db.toJSON();\r\n  }\r\n  public async openStandalone(filePath: string, openMode: OpenMode, opts?: StandaloneOpenOptions): Promise<IModelConnectionProps> {\r\n    return StandaloneDb.openFile(filePath, openMode, opts).getConnectionProps();\r\n  }\r\n  public async closeIModel(key: string): Promise<void> {\r\n    IModelDb.findByKey(key).close();\r\n  }\r\n  public async saveChanges(key: string, description?: string): Promise<void> {\r\n    IModelDb.findByKey(key).saveChanges(description);\r\n  }\r\n  public async hasPendingTxns(key: string): Promise<boolean> {\r\n    return IModelDb.findByKey(key).nativeDb.hasPendingTxns();\r\n  }\r\n\r\n  public async isUndoPossible(key: string): Promise<boolean> {\r\n    return IModelDb.findByKey(key).nativeDb.isUndoPossible();\r\n  }\r\n  public async isRedoPossible(key: string): Promise<boolean> {\r\n    return IModelDb.findByKey(key).nativeDb.isRedoPossible();\r\n  }\r\n  public async getUndoString(key: string): Promise<string> {\r\n    return IModelDb.findByKey(key).nativeDb.getUndoString();\r\n  }\r\n  public async getRedoString(key: string): Promise<string> {\r\n    return IModelDb.findByKey(key).nativeDb.getUndoString();\r\n  }\r\n\r\n  public async pullChanges(key: string, toIndex?: ChangesetIndex): Promise<ChangesetIndexAndId> {\r\n    const iModelDb = BriefcaseDb.findByKey(key);\r\n    await iModelDb.pullChanges({ toIndex });\r\n    return iModelDb.changeset as ChangesetIndexAndId;\r\n  }\r\n  public async pushChanges(key: string, description: string): Promise<ChangesetIndexAndId> {\r\n    const iModelDb = BriefcaseDb.findByKey(key);\r\n    await iModelDb.pushChanges({ description });\r\n    return iModelDb.changeset as ChangesetIndexAndId;\r\n  }\r\n\r\n  public async toggleGraphicalEditingScope(key: string, startSession: boolean): Promise<boolean> {\r\n    const val: IModelJsNative.ErrorStatusOrResult<any, boolean> = IModelDb.findByKey(key).nativeDb.setGeometricModelTrackingEnabled(startSession);\r\n    if (val.error)\r\n      throw new IModelError(val.error.status, \"Failed to toggle graphical editing scope\");\r\n    assert(undefined !== val.result);\r\n    return val.result;\r\n  }\r\n  public async isGraphicalEditingSupported(key: string): Promise<boolean> {\r\n    return IModelDb.findByKey(key).nativeDb.isGeometricModelTrackingSupported();\r\n  }\r\n\r\n  public async reverseTxns(key: string, numOperations: number): Promise<IModelStatus> {\r\n    return IModelDb.findByKey(key).nativeDb.reverseTxns(numOperations);\r\n  }\r\n  public async reverseAllTxn(key: string): Promise<IModelStatus> {\r\n    return IModelDb.findByKey(key).nativeDb.reverseAll();\r\n  }\r\n  public async reinstateTxn(key: string): Promise<IModelStatus> {\r\n    return IModelDb.findByKey(key).nativeDb.reinstateTxn();\r\n  }\r\n  public async restartTxnSession(key: string): Promise<void> {\r\n    return IModelDb.findByKey(key).nativeDb.restartTxnSession();\r\n  }\r\n\r\n  public async queryConcurrency(pool: \"io\" | \"cpu\"): Promise<number> {\r\n    return IModelHost.platform.queryConcurrency(pool);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"IpcHost.js","sourceRoot":"","sources":["../../src/IpcHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAqG;AACrG,oDAI4B;AAE5B,yCAAiE;AACjE,6CAA6D;AAC7D,oEAAyE;AACzE,2DAAuE;AAmBvE;;;;GAIG;AACH,MAAa,OAAO;IAGlB,2EAA2E;IACnE,MAAM,KAAK,GAAG,KAAuB,OAAO,IAAI,CAAC,IAAK,CAAC,CAAC,CAAC,CAAC,+DAA+D;IACjI,gIAAgI;IACzH,MAAM,KAAK,OAAO,KAAc,OAAO,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAExE;;;;OAIG;IACI,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,GAAG,IAAW;QAChD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,OAAe,EAAE,OAAyC;QAC7E,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,WAAW,CAAC,OAAe,EAAE,QAAqB;QAC9D,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC/D,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,OAAe,EAAE,QAAqB;QACjE,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAEO,MAAM,CAAC,MAAM,CAAC,OAAe,EAAE,SAAqC,EAAE,UAAkB,EAAE,GAAG,IAAW;QAC9G,IAAI,IAAI,CAAC,OAAO;YACd,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IACzE,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAAsC,UAAa,EAAE,GAAG,IAAwC;QAC7H,OAAO,OAAO,CAAC,IAAI,CAAC,2BAAa,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IACpE,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,UAAU,CAAmC,SAAqC,EAAE,UAAa,EAAE,GAAG,IAAqC;QACvJ,IAAI,CAAC,MAAM,CAAC,2BAAa,CAAC,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IAClE,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,kBAAkB,CAA4C,SAAqC,EAAE,UAAa,EAAE,GAAG,IAA8C;QACjL,IAAI,CAAC,MAAM,CAAC,2BAAa,CAAC,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAiB;;QAC3C,IAAI,CAAC,IAAI,GAAG,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,0CAAE,MAAM,CAAC;QACjC,IAAI,MAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,0CAAE,UAAU,0CAAE,OAAO;YACnC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QAEtB,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,sDAAsD;YACxE,aAAa,CAAC,QAAQ,EAAE,CAAC;SAC1B;QAED,MAAM,uBAAU,CAAC,OAAO,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,mEAAmE;IAC5D,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,MAAM,uBAAU,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;;AArFH,0BAsFC;AArFe,eAAO,GAAG,KAAK,CAAC;AAuFhC;;;;;;;;;;;GAWG;AACH,MAAsB,UAAU;IAI9B;;;;;OAKG;IACI,MAAM,CAAC,QAAQ;QACpB,MAAM,IAAI,GAAG,IAAK,IAAY,EAAgB,CAAC,CAAC,uFAAuF;QACvI,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,IAAW,EAAE,QAAgB,EAAE,GAAG,IAAW,EAA4B,EAAE;;YACxH,IAAI;gBACF,MAAM,IAAI,GAAI,IAAY,CAAC,QAAQ,CAAC,CAAC;gBACrC,IAAI,OAAO,IAAI,KAAK,UAAU;oBAC5B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,gBAAgB,EAAE,WAAW,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,QAAQ,qDAAqD,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;gBAE5K,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;aACnD;YAAC,OAAO,GAAQ,EAAE;gBACjB,MAAM,GAAG,GAAoB;oBAC3B,KAAK,EAAE;wBACL,IAAI,EAAE,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,eAAe;wBAC/E,OAAO,EAAE,2BAAY,CAAC,eAAe,CAAC,GAAG,CAAC;wBAC1C,WAAW,EAAE,MAAA,GAAG,CAAC,WAAW,mCAAI,CAAC;qBAClC;iBACF,CAAC;gBACF,IAAI,CAAC,OAAO,CAAC,OAAO;oBAClB,GAAG,CAAC,KAAK,CAAC,KAAK,GAAG,2BAAY,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;gBACpD,OAAO,GAAG,CAAC;aACZ;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAjCD,gCAiCC;AAED;;GAEG;AACH,MAAM,aAAc,SAAQ,UAAU;IAAtC;;QAGU,2BAAsB,GAAG,IAAI,GAAG,EAA0B,CAAC;IAqHrE,CAAC;IAvHC,IAAW,WAAW,KAAK,OAAO,2BAAa,CAAC,SAAS,CAAC,CAAC,CAAC;IAIrD,KAAK,CAAC,GAAG,CAAC,UAAkB,EAAE,KAAe,EAAE,QAAgB,EAAE,OAAe,EAAE,QAAc;QACrG,QAAQ,KAAK,EAAE;YACb,KAAK,uBAAQ,CAAC,KAAK;gBACjB,qBAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC7C,MAAM;YACR,KAAK,uBAAQ,CAAC,IAAI;gBAChB,qBAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC5C,MAAM;YACR,KAAK,uBAAQ,CAAC,KAAK;gBACjB,qBAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC7C,MAAM;YACR,KAAK,uBAAQ,CAAC,OAAO;gBACnB,qBAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC/C,MAAM;SACT;IACH,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,UAA0B,EAAE,UAAgC;QACjG,OAAO,IAAA,6CAAyB,EAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC3D,CAAC;IACM,KAAK,CAAC,6BAA6B,CAAC,GAAW,EAAE,UAAoB;QAC1E,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,6BAA6B,CAAC,UAAU,CAAC,CAAC;IACpF,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,IAAwB;QACjD,MAAM,EAAE,GAAG,MAAM,sBAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;IACrB,CAAC;IACM,KAAK,CAAC,cAAc,CAAC,QAAgB,EAAE,QAAkB,EAAE,IAA4B;QAC5F,OAAO,uBAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC9E,CAAC;IACM,KAAK,CAAC,WAAW,CAAC,GAAW;QAClC,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IACM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,WAAoB;QACxD,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IACM,KAAK,CAAC,cAAc,CAAC,GAAW;QACrC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;IAC3D,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,GAAW;QACrC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;IAC3D,CAAC;IACM,KAAK,CAAC,cAAc,CAAC,GAAW;QACrC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;IAC3D,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,GAAW;QACpC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;IAC1D,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,GAAW;QACpC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;IAC1D,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,OAAwB,EAAE,OAA4B;QAC1F,MAAM,QAAQ,GAAG,sBAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAE5C,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,GAAG,EAAE,kCAAc,CAAC,QAAQ,CAAC,CAAC;QAC9D,MAAM,UAAU,GAAG,GAAG,EAAE,WAAC,OAAA,MAAA,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,kCAAc,CAAC,QAAQ,CAAA,EAAA,CAAC;QAEzF,IAAI,UAAwC,CAAC;QAC7C,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,EAAE;YAC3B,MAAM,gBAAgB,GAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBAC3D,OAAO,CAAC,IAAI,CAAC,IAAA,sCAAwB,EAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC7E,OAAO,UAAU,EAAE,CAAC;YACtB,CAAC,CAAC;YACF,UAAU,GAAG,wBAAwB,CAAC,gBAAgB,EAAE,UAAU,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB,CAAC,CAAC;SAChG;aAAM,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,kBAAkB,EAAE;YACtC,UAAU,GAAG,UAAU,CAAC;SACzB;QAED,IAAI;YACF,MAAM,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;SACrD;gBAAS;YACR,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACzC;QAED,OAAO,QAAQ,CAAC,SAAgC,CAAC;IACnD,CAAC;IACM,KAAK,CAAC,wBAAwB,CAAC,GAAW;QAC/C,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,GAAG,EAAE,kCAAc,CAAC,KAAK,CAAC,CAAC;IAC7D,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,WAAmB;QACvD,MAAM,QAAQ,GAAG,sBAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;QAC5C,OAAO,QAAQ,CAAC,SAAgC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,2BAA2B,CAAC,GAAW,EAAE,YAAqB;QACzE,MAAM,GAAG,GAAqD,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,gCAAgC,CAAC,YAAY,CAAC,CAAC;QAC9I,IAAI,GAAG,CAAC,KAAK;YACX,MAAM,IAAI,yBAAW,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,0CAA0C,CAAC,CAAC;QACtF,IAAA,qBAAM,EAAC,SAAS,KAAK,GAAG,CAAC,MAAM,CAAC,CAAC;QACjC,OAAO,GAAG,CAAC,MAAM,CAAC;IACpB,CAAC;IACM,KAAK,CAAC,2BAA2B,CAAC,GAAW;QAClD,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,iCAAiC,EAAE,CAAC;IAC9E,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,aAAqB;QACzD,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IACrE,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,GAAW;QACpC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;IACvD,CAAC;IACM,KAAK,CAAC,YAAY,CAAC,GAAW;QACnC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC;IACzD,CAAC;IACM,KAAK,CAAC,iBAAiB,CAAC,GAAW;QACxC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;IAC9D,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,IAAkB;QAC9C,OAAO,uBAAU,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;CACF;AAED;;;GAGG;AACH,SAAgB,wBAAwB,CAAC,IAAsB,EAAE,UAAgC,EAAE,gBAAyB;IAC1H,MAAM,QAAQ,GAAG,gBAAgB,aAAhB,gBAAgB,cAAhB,gBAAgB,GAAI,GAAG,CAAC,CAAC,+DAA+D;IACzG,IAAI,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ,CAAC;IACrC,MAAM,gBAAgB,GAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QAC3D,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,MAAM,IAAI,KAAK,IAAI,GAAG,IAAI,QAAQ,EAAE;YACtC,QAAQ,GAAG,GAAG,GAAG,QAAQ,CAAC;YAC1B,OAAO,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;SAC5B;QACD,OAAO,UAAU,EAAE,CAAC;IACtB,CAAC,CAAC;IAEF,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAbD,4DAaC","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 NativeApp\r\n */\r\n\r\nimport { assert, BentleyError, IModelStatus, Logger, LogLevel, OpenMode } from \"@itwin/core-bentley\";\r\nimport {\r\n  ChangesetIndex, ChangesetIndexAndId, EditingScopeNotifications, getPullChangesIpcChannel, IModelConnectionProps, IModelError, IModelRpcProps,\r\n  IpcAppChannel, IpcAppFunctions, IpcAppNotifications, IpcInvokeReturn, IpcListener, IpcSocketBackend, iTwinChannel, OpenBriefcaseProps,\r\n  PullChangesOptions, RemoveFunction, StandaloneOpenOptions, TileTreeContentIds, TxnNotifications,\r\n} from \"@itwin/core-common\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { BriefcaseDb, IModelDb, StandaloneDb } from \"./IModelDb\";\r\nimport { IModelHost, IModelHostOptions } from \"./IModelHost\";\r\nimport { cancelTileContentRequests } from \"./rpc-impl/IModelTileRpcImpl\";\r\nimport { ProgressFunction, ProgressStatus } from \"./CheckpointManager\";\r\n\r\n/**\r\n  * Options for [[IpcHost.startup]]\r\n  * @public\r\n  */\r\nexport interface IpcHostOpts {\r\n  iModelHost?: IModelHostOptions;\r\n  ipcHost?: {\r\n    /** The Ipc socket to use for communications with frontend. Allows undefined only for headless tests. */\r\n    socket?: IpcSocketBackend;\r\n\r\n    /** don't send stack information on exceptions */\r\n    exceptions?: {\r\n      noStack?: boolean;\r\n    };\r\n  };\r\n}\r\n\r\n/**\r\n * Used by applications that have a dedicated backend. IpcHosts may send messages to their corresponding IpcApp.\r\n * @note if either end terminates, the other must too.\r\n * @public\r\n */\r\nexport class IpcHost {\r\n  public static noStack = false;\r\n  private static _ipc: IpcSocketBackend | undefined;\r\n  /** Get the implementation of the [IpcSocketBackend]($common) interface. */\r\n  private static get ipc(): IpcSocketBackend { return this._ipc!; } // eslint-disable-line @typescript-eslint/no-non-null-assertion\r\n  /** Determine whether Ipc is available for this backend. This will only be true if [[startup]] has been called on this class. */\r\n  public static get isValid(): boolean { return undefined !== this._ipc; }\r\n\r\n  /**\r\n   * Send a message to the frontend over an Ipc channel.\r\n   * @param channel the name of the channel matching the name registered with [[IpcApp.addListener]].\r\n   * @param data The content of the message.\r\n   */\r\n  public static send(channel: string, ...data: any[]): void {\r\n    this.ipc.send(iTwinChannel(channel), ...data);\r\n  }\r\n\r\n  /**\r\n   * Establish a handler for an Ipc channel to receive [[Frontend.invoke]] calls\r\n   * @param channel The name of the channel for this handler.\r\n   * @param handler A function that supplies the implementation for `channel`\r\n   * @note returns A function to call to remove the handler.\r\n   */\r\n  public static handle(channel: string, handler: (...args: any[]) => Promise<any>): RemoveFunction {\r\n    return this.ipc.handle(iTwinChannel(channel), handler);\r\n  }\r\n  /**\r\n   * Establish a handler to receive messages sent via [[IpcApp.send]].\r\n   * @param channel The name of the channel for the messages.\r\n   * @param listener A function called when messages are sent over `channel`\r\n   * @note returns A function to call to remove the listener.\r\n   */\r\n  public static addListener(channel: string, listener: IpcListener): RemoveFunction {\r\n    return this.ipc.addListener(iTwinChannel(channel), listener);\r\n  }\r\n  /**\r\n   * Remove a previously registered listener\r\n   * @param channel The name of the channel for the listener previously registered with [[addListener]]\r\n   * @param listener The function passed to [[addListener]]\r\n   */\r\n  public static removeListener(channel: string, listener: IpcListener): void {\r\n    this.ipc.removeListener(iTwinChannel(channel), listener);\r\n  }\r\n\r\n  private static notify(channel: string, briefcase: BriefcaseDb | StandaloneDb, methodName: string, ...args: any[]) {\r\n    if (this.isValid)\r\n      return this.send(`${channel}:${briefcase.key}`, methodName, ...args);\r\n  }\r\n\r\n  /** @internal */\r\n  public static notifyIpcFrontend<T extends keyof IpcAppNotifications>(methodName: T, ...args: Parameters<IpcAppNotifications[T]>) {\r\n    return IpcHost.send(IpcAppChannel.AppNotify, methodName, ...args);\r\n  }\r\n\r\n  /** @internal */\r\n  public static notifyTxns<T extends keyof TxnNotifications>(briefcase: BriefcaseDb | StandaloneDb, methodName: T, ...args: Parameters<TxnNotifications[T]>) {\r\n    this.notify(IpcAppChannel.Txns, briefcase, methodName, ...args);\r\n  }\r\n\r\n  /** @internal */\r\n  public static notifyEditingScope<T extends keyof EditingScopeNotifications>(briefcase: BriefcaseDb | StandaloneDb, methodName: T, ...args: Parameters<EditingScopeNotifications[T]>) {\r\n    this.notify(IpcAppChannel.EditingScope, briefcase, methodName, ...args);\r\n  }\r\n\r\n  /**\r\n   * Start the backend of an Ipc app.\r\n   * @param opt\r\n   * @note this method calls [[IModelHost.startup]] internally.\r\n   */\r\n  public static async startup(opt?: IpcHostOpts): Promise<void> {\r\n    this._ipc = opt?.ipcHost?.socket;\r\n    if (opt?.ipcHost?.exceptions?.noStack)\r\n      this.noStack = true;\r\n\r\n    if (this.isValid) { // for tests, we use IpcHost but don't have a frontend\r\n      IpcAppHandler.register();\r\n    }\r\n\r\n    await IModelHost.startup(opt?.iModelHost);\r\n  }\r\n\r\n  /** Shutdown IpcHost backend. Also calls [[IModelHost.shutdown]] */\r\n  public static async shutdown(): Promise<void> {\r\n    this._ipc = undefined;\r\n    await IModelHost.shutdown();\r\n  }\r\n}\r\n\r\n/**\r\n * Base class for all implementations of an Ipc interface.\r\n *\r\n * Create a subclass to implement your Ipc interface. Your class should be declared like this:\r\n * ```ts\r\n * class MyHandler extends IpcHandler implements MyInterface\r\n * ```\r\n * to ensure all methods and signatures are correct.\r\n *\r\n * Then, call `MyClass.register` at startup to connect your class to your channel.\r\n * @public\r\n */\r\nexport abstract class IpcHandler {\r\n  /** All subclasses must implement this method to specify their channel name. */\r\n  public abstract get channelName(): string;\r\n\r\n  /**\r\n   * Register this class as the handler for methods on its channel. This static method creates a new instance\r\n   * that becomes the handler and is `this` when its methods are called.\r\n   * @returns A function that can be called to remove the handler.\r\n   * @note this method should only be called once per channel. If it is called multiple times, subsequent calls replace the previous ones.\r\n   */\r\n  public static register(): RemoveFunction {\r\n    const impl = new (this as any)() as IpcHandler; // create an instance of subclass. \"as any\" is necessary because base class is abstract\r\n    return IpcHost.handle(impl.channelName, async (_evt: Event, funcName: string, ...args: any[]): Promise<IpcInvokeReturn> => {\r\n      try {\r\n        const func = (impl as any)[funcName];\r\n        if (typeof func !== \"function\")\r\n          throw new IModelError(IModelStatus.FunctionNotFound, `Method \"${impl.constructor.name}.${funcName}\" not found on IpcHandler registered for channel: ${impl.channelName}`);\r\n\r\n        return { result: await func.call(impl, ...args) };\r\n      } catch (err: any) {\r\n        const ret: IpcInvokeReturn = {\r\n          error: {\r\n            name: (err && typeof err === \"object\") ? err.constructor.name : \"Unknown Error\",\r\n            message: BentleyError.getErrorMessage(err),\r\n            errorNumber: err.errorNumber ?? 0,\r\n          },\r\n        };\r\n        if (!IpcHost.noStack)\r\n          ret.error.stack = BentleyError.getErrorStack(err);\r\n        return ret;\r\n      }\r\n    });\r\n  }\r\n}\r\n\r\n/**\r\n * Implementation  of IpcAppFunctions\r\n */\r\nclass IpcAppHandler extends IpcHandler implements IpcAppFunctions {\r\n  public get channelName() { return IpcAppChannel.Functions; }\r\n\r\n  private _iModelKeyToPullStatus = new Map<string, ProgressStatus>();\r\n\r\n  public async log(_timestamp: number, level: LogLevel, category: string, message: string, metaData?: any): Promise<void> {\r\n    switch (level) {\r\n      case LogLevel.Error:\r\n        Logger.logError(category, message, metaData);\r\n        break;\r\n      case LogLevel.Info:\r\n        Logger.logInfo(category, message, metaData);\r\n        break;\r\n      case LogLevel.Trace:\r\n        Logger.logTrace(category, message, metaData);\r\n        break;\r\n      case LogLevel.Warning:\r\n        Logger.logWarning(category, message, metaData);\r\n        break;\r\n    }\r\n  }\r\n\r\n  public async cancelTileContentRequests(tokenProps: IModelRpcProps, contentIds: TileTreeContentIds[]): Promise<void> {\r\n    return cancelTileContentRequests(tokenProps, contentIds);\r\n  }\r\n  public async cancelElementGraphicsRequests(key: string, requestIds: string[]): Promise<void> {\r\n    return IModelDb.findByKey(key).nativeDb.cancelElementGraphicsRequests(requestIds);\r\n  }\r\n  public async openBriefcase(args: OpenBriefcaseProps): Promise<IModelConnectionProps> {\r\n    const db = await BriefcaseDb.open(args);\r\n    return db.toJSON();\r\n  }\r\n  public async openStandalone(filePath: string, openMode: OpenMode, opts?: StandaloneOpenOptions): Promise<IModelConnectionProps> {\r\n    return StandaloneDb.openFile(filePath, openMode, opts).getConnectionProps();\r\n  }\r\n  public async closeIModel(key: string): Promise<void> {\r\n    IModelDb.findByKey(key).close();\r\n  }\r\n  public async saveChanges(key: string, description?: string): Promise<void> {\r\n    IModelDb.findByKey(key).saveChanges(description);\r\n  }\r\n  public async hasPendingTxns(key: string): Promise<boolean> {\r\n    return IModelDb.findByKey(key).nativeDb.hasPendingTxns();\r\n  }\r\n\r\n  public async isUndoPossible(key: string): Promise<boolean> {\r\n    return IModelDb.findByKey(key).nativeDb.isUndoPossible();\r\n  }\r\n  public async isRedoPossible(key: string): Promise<boolean> {\r\n    return IModelDb.findByKey(key).nativeDb.isRedoPossible();\r\n  }\r\n  public async getUndoString(key: string): Promise<string> {\r\n    return IModelDb.findByKey(key).nativeDb.getUndoString();\r\n  }\r\n  public async getRedoString(key: string): Promise<string> {\r\n    return IModelDb.findByKey(key).nativeDb.getUndoString();\r\n  }\r\n\r\n  public async pullChanges(key: string, toIndex?: ChangesetIndex, options?: PullChangesOptions): Promise<ChangesetIndexAndId> {\r\n    const iModelDb = BriefcaseDb.findByKey(key);\r\n\r\n    this._iModelKeyToPullStatus.set(key, ProgressStatus.Continue);\r\n    const checkAbort = () => this._iModelKeyToPullStatus.get(key) ?? ProgressStatus.Continue;\r\n\r\n    let onProgress: ProgressFunction | undefined;\r\n    if (options?.reportProgress) {\r\n      const progressCallback: ProgressFunction = (loaded, total) => {\r\n        IpcHost.send(getPullChangesIpcChannel(iModelDb.iModelId), { loaded, total });\r\n        return checkAbort();\r\n      };\r\n      onProgress = throttleProgressCallback(progressCallback, checkAbort, options?.progressInterval);\r\n    } else if (options?.enableCancellation) {\r\n      onProgress = checkAbort;\r\n    }\r\n\r\n    try {\r\n      await iModelDb.pullChanges({ toIndex, onProgress });\r\n    } finally {\r\n      this._iModelKeyToPullStatus.delete(key);\r\n    }\r\n\r\n    return iModelDb.changeset as ChangesetIndexAndId;\r\n  }\r\n  public async cancelPullChangesRequest(key: string): Promise<void> {\r\n    this._iModelKeyToPullStatus.set(key, ProgressStatus.Abort);\r\n  }\r\n\r\n  public async pushChanges(key: string, description: string): Promise<ChangesetIndexAndId> {\r\n    const iModelDb = BriefcaseDb.findByKey(key);\r\n    await iModelDb.pushChanges({ description });\r\n    return iModelDb.changeset as ChangesetIndexAndId;\r\n  }\r\n\r\n  public async toggleGraphicalEditingScope(key: string, startSession: boolean): Promise<boolean> {\r\n    const val: IModelJsNative.ErrorStatusOrResult<any, boolean> = IModelDb.findByKey(key).nativeDb.setGeometricModelTrackingEnabled(startSession);\r\n    if (val.error)\r\n      throw new IModelError(val.error.status, \"Failed to toggle graphical editing scope\");\r\n    assert(undefined !== val.result);\r\n    return val.result;\r\n  }\r\n  public async isGraphicalEditingSupported(key: string): Promise<boolean> {\r\n    return IModelDb.findByKey(key).nativeDb.isGeometricModelTrackingSupported();\r\n  }\r\n\r\n  public async reverseTxns(key: string, numOperations: number): Promise<IModelStatus> {\r\n    return IModelDb.findByKey(key).nativeDb.reverseTxns(numOperations);\r\n  }\r\n  public async reverseAllTxn(key: string): Promise<IModelStatus> {\r\n    return IModelDb.findByKey(key).nativeDb.reverseAll();\r\n  }\r\n  public async reinstateTxn(key: string): Promise<IModelStatus> {\r\n    return IModelDb.findByKey(key).nativeDb.reinstateTxn();\r\n  }\r\n  public async restartTxnSession(key: string): Promise<void> {\r\n    return IModelDb.findByKey(key).nativeDb.restartTxnSession();\r\n  }\r\n\r\n  public async queryConcurrency(pool: \"io\" | \"cpu\"): Promise<number> {\r\n    return IModelHost.platform.queryConcurrency(pool);\r\n  }\r\n}\r\n\r\n/**\r\n * Prevents progress callback being called more frequently when provided interval.\r\n * @internal\r\n */\r\nexport function throttleProgressCallback(func: ProgressFunction, checkAbort: () => ProgressStatus, progressInterval?: number): ProgressFunction {\r\n  const interval = progressInterval ?? 250; // by default, only send progress events every 250 milliseconds\r\n  let nextTime = Date.now() + interval;\r\n  const progressCallback: ProgressFunction = (loaded, total) => {\r\n    const now = Date.now();\r\n    if (loaded >= total || now >= nextTime) {\r\n      nextTime = now + interval;\r\n      return func(loaded, total);\r\n    }\r\n    return checkAbort();\r\n  };\r\n\r\n  return progressCallback;\r\n}\r\n"]}

package/lib/cjs/Model.d.ts

@@ -3,7 +3,7 @@
  */
 import { GuidString, Id64String } from "@itwin/core-bentley";
 import { Point2d } from "@itwin/core-geometry";
-import { AxisAlignedBox3d, ElementProps, GeometricModel2dProps, GeometricModel3dProps, GeometricModelProps, ModelProps, RelatedElement } from "@itwin/core-common";
+import { AxisAlignedBox3d, ElementProps, EntityReferenceSet, GeometricModel2dProps, GeometricModel3dProps, GeometricModelProps, ModelProps, RelatedElement } from "@itwin/core-common";
 import { Entity } from "./Entity";
 import { IModelDb } from "./IModelDb";
 /** Argument for the `Model.onXxx` static methods
@@ -158,6 +158,8 @@ export declare class Model extends Entity {
     update(): void;
     /** Delete this Model from the iModel. */
     delete(): void;
+    /** @internal */
+    protected collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void;
 }
 /** A container for persisting geometric elements.
  * @public
@@ -168,8 +170,12 @@ export declare class GeometricModel extends Model {
     static get className(): string;
     /** @internal */
     constructor(props: GeometricModelProps, iModel: IModelDb);
-    /** Query for the union of the extents of the elements contained by this model. */
+    /** Query for the union of the extents of the elements contained by this model.
+     * @note This function blocks the JavaScript event loop. Consider using [[queryRange]] instead.
+     */
     queryExtents(): AxisAlignedBox3d;
+    /** Query for the union of the extents of all elements contained within this model. */
+    queryRange(): Promise<AxisAlignedBox3d>;
 }
 /** A container for persisting 3d geometric elements.
  * @public

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

@@ -1 +1 @@
-{"version":3,"file":"Model.d.ts","sourceRoot":"","sources":["../../src/Model.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAa,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAAE,OAAO,EAAW,MAAM,sBAAsB,CAAC;AACxD,OAAO,EACL,gBAAgB,EAAE,YAAY,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,mBAAmB,EACjG,UAAU,EAAE,cAAc,EAC3B,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,yCAAyC;IACzC,MAAM,EAAE,QAAQ,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,gDAAgD;IAChD,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,mCAAmC;IACnC,EAAE,EAAE,UAAU,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,YAAY;IAC5D,8DAA8D;IAC9D,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,mDAAmD;IACnD,SAAS,EAAE,UAAU,CAAC;CACvB;AAED;;;;GAIG;AACH,qBAAa,KAAM,SAAQ,MAAM;IAC/B,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoB;IAClE,gBAAgB;IAChB,WAA2B,mBAAmB,aAAmD;IACjG,SAAgB,cAAc,EAAG,cAAc,CAAC;IAChD,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,WAAW,EAAG,UAAU,CAAC;IACzC,SAAgB,cAAc,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAChD,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IAE3B,gBAAgB;gBACJ,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ;IAQ/C;;OAEG;IACa,MAAM,IAAI,UAAU;IAMpC;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IAMrD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAIrD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IAIrD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAGpD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI;IAIlD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAEpD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,wBAAwB,GAAG,IAAI;IAEtE;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAErE;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,wBAAwB,GAAG,IAAI;IAEtE;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAEpE;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAEnE;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAEpE,OAAO,CAAC,oBAAoB;IAO5B,qDAAqD;IAC9C,iBAAiB,CAAC,SAAS,EAAE,MAAM;IAE1C,yEAAyE;IAClE,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAEtD,sFAAsF;IAC/E,oBAAoB,CAAC,SAAS,EAAE,MAAM;IAEtC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG;IAClC,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAE/C,sCAAsC;IAC/B,MAAM;IACb,uCAAuC;IAChC,MAAM;IACb,yCAAyC;IAClC,MAAM;CACd;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,KAAK;IAChC,YAAY,CAAC,EAAE,UAAU,CAAC;IAEjC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAC3E,gBAAgB;gBACJ,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAExD,kFAAkF;IAC3E,YAAY,IAAI,gBAAgB;CAIxC;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,cAAc;IAC3D;;OAEG;IACH,SAAgB,gBAAgB,EAAE,OAAO,CAAC;IAC1C;;OAEG;IACH,SAAgB,qBAAqB,EAAE,OAAO,CAAC;IAC/C,0HAA0H;IAC1H,IAAW,kBAAkB,IAAI,OAAO,CAAwC;IAEhF,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E,gBAAgB;gBACJ,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAK1D,gBAAgB;IACA,MAAM,IAAI,qBAAqB;CAUhD;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,cAAc;IAC3D,8GAA8G;IACvG,YAAY,CAAC,EAAE,OAAO,CAAC;IAC9B,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E,gBAAgB;gBACJ,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAC1D,gBAAgB;IACA,MAAM,IAAI,qBAAqB;CAOhD;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,gBAAgB;IAC7D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E;AAED;;;;GAIG;AACH,8BAAsB,gBAAiB,SAAQ,gBAAgB;IAC7D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E;AAED;;GAEG;AACH,8BAAsB,YAAa,SAAQ,gBAAgB;IACzD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA2B;CAC1E;AAED;;;GAGG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAC7C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA4B;IAC1E;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,UAAU;CAe5H;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAmC;IACjF;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,UAAU;CAe5H;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;IAChD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA2B;CAC1E;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAkC;CACjF;AAED;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,gBAAgB;IAC9C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAyB;CACxE;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAClC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAwB;CACvE;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,KAAK;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E;AAED;;;GAGG;AACH,8BAAsB,qBAAsB,SAAQ,gBAAgB;IAClE,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoC;CACnF;AAED;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,gBAAgB;IAC1D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAqC;IAEnF;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,gBAAgB;IACnD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAE5E;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,eAAe;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA8B;CAC7E;AAED;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,gBAAgB;IACrD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAgC;IAC9E;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;;GAGG;AACH,qBAAa,SAAU,SAAQ,gBAAgB;IAC7C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAwB;CACvE;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,eAAe;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA8B;CAC7E;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAChD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E"}
+{"version":3,"file":"Model.d.ts","sourceRoot":"","sources":["../../src/Model.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAa,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAAE,OAAO,EAAW,MAAM,sBAAsB,CAAC;AACxD,OAAO,EACL,gBAAgB,EAAE,YAAY,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,mBAAmB,EACnF,UAAU,EAAE,cAAc,EAC7D,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,yCAAyC;IACzC,MAAM,EAAE,QAAQ,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,gDAAgD;IAChD,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,mCAAmC;IACnC,EAAE,EAAE,UAAU,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,YAAY;IAC5D,8DAA8D;IAC9D,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,mDAAmD;IACnD,SAAS,EAAE,UAAU,CAAC;CACvB;AAED;;;;GAIG;AACH,qBAAa,KAAM,SAAQ,MAAM;IAC/B,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoB;IAClE,gBAAgB;IAChB,WAA2B,mBAAmB,aAAmD;IACjG,SAAgB,cAAc,EAAG,cAAc,CAAC;IAChD,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,WAAW,EAAG,UAAU,CAAC;IACzC,SAAgB,cAAc,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAChD,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IAE3B,gBAAgB;gBACJ,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ;IAQ/C;;OAEG;IACa,MAAM,IAAI,UAAU;IAMpC;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IAMrD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAIrD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IAIrD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAGpD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI;IAIlD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAEpD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,wBAAwB,GAAG,IAAI;IAEtE;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAErE;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,wBAAwB,GAAG,IAAI;IAEtE;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAEpE;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAEnE;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAEpE,OAAO,CAAC,oBAAoB;IAO5B,qDAAqD;IAC9C,iBAAiB,CAAC,SAAS,EAAE,MAAM;IAE1C,yEAAyE;IAClE,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAEtD,sFAAsF;IAC/E,oBAAoB,CAAC,SAAS,EAAE,MAAM;IAEtC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG;IAClC,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAE/C,sCAAsC;IAC/B,MAAM;IACb,uCAAuC;IAChC,MAAM;IACb,yCAAyC;IAClC,MAAM;IAGb,gBAAgB;cACG,2BAA2B,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAMvF;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,KAAK;IAChC,YAAY,CAAC,EAAE,UAAU,CAAC;IAEjC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAC3E,gBAAgB;gBACJ,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAExD;;OAEG;IACI,YAAY,IAAI,gBAAgB;IAKvC,sFAAsF;IACzE,UAAU,IAAI,OAAO,CAAC,gBAAgB,CAAC;CAGrD;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,cAAc;IAC3D;;OAEG;IACH,SAAgB,gBAAgB,EAAE,OAAO,CAAC;IAC1C;;OAEG;IACH,SAAgB,qBAAqB,EAAE,OAAO,CAAC;IAC/C,0HAA0H;IAC1H,IAAW,kBAAkB,IAAI,OAAO,CAAwC;IAEhF,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E,gBAAgB;gBACJ,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAK1D,gBAAgB;IACA,MAAM,IAAI,qBAAqB;CAUhD;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,cAAc;IAC3D,8GAA8G;IACvG,YAAY,CAAC,EAAE,OAAO,CAAC;IAC9B,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E,gBAAgB;gBACJ,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAC1D,gBAAgB;IACA,MAAM,IAAI,qBAAqB;CAOhD;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,gBAAgB;IAC7D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E;AAED;;;;GAIG;AACH,8BAAsB,gBAAiB,SAAQ,gBAAgB;IAC7D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E;AAED;;GAEG;AACH,8BAAsB,YAAa,SAAQ,gBAAgB;IACzD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA2B;CAC1E;AAED;;;GAGG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAC7C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA4B;IAC1E;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,UAAU;CAe5H;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAmC;IACjF;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,UAAU;CAe5H;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;IAChD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA2B;CAC1E;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAkC;CACjF;AAED;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,gBAAgB;IAC9C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAyB;CACxE;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAClC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAwB;CACvE;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,KAAK;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E;AAED;;;GAGG;AACH,8BAAsB,qBAAsB,SAAQ,gBAAgB;IAClE,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoC;CACnF;AAED;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,gBAAgB;IAC1D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAqC;IAEnF;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,gBAAgB;IACnD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAE5E;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,eAAe;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA8B;CAC7E;AAED;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,gBAAgB;IACrD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAgC;IAC9E;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;;GAGG;AACH,qBAAa,SAAU,SAAQ,gBAAgB;IAC7C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAwB;CACvE;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,eAAe;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA8B;CAC7E;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAChD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E"}

package/lib/cjs/Model.js

@@ -149,6 +149,14 @@ class Model extends Entity_1.Entity {
     update() { this.iModel.models.updateModel(this.toJSON()); }
     /** Delete this Model from the iModel. */
     delete() { this.iModel.models.deleteModel(this.id); }
+    // NOTE: non-element entities do not yet have a concept of required references
+    /** @internal */
+    collectReferenceConcreteIds(referenceIds) {
+        super.collectReferenceConcreteIds(referenceIds);
+        if (this.parentModel)
+            referenceIds.addModel(this.parentModel);
+        referenceIds.addElement(this.modeledElement.id);
+    }
 }
 exports.Model = Model;
 /** A container for persisting geometric elements.
@@ -159,11 +167,17 @@ class GeometricModel extends Model {
     constructor(props, iModel) { super(props, iModel); }
     /** @internal */
     static get className() { return "GeometricModel"; }
-    /** Query for the union of the extents of the elements contained by this model. */
+    /** Query for the union of the extents of the elements contained by this model.
+     * @note This function blocks the JavaScript event loop. Consider using [[queryRange]] instead.
+     */
     queryExtents() {
         const extents = this.iModel.nativeDb.queryModelExtents({ id: this.id }).modelExtents;
         return core_geometry_1.Range3d.fromJSON(extents);
     }
+    /** Query for the union of the extents of all elements contained within this model. */
+    async queryRange() {
+        return this.iModel.models.queryRange(this.id);
+    }
 }
 exports.GeometricModel = GeometricModel;
 /** A container for persisting 3d geometric elements.

package/lib/cjs/Model.js.map

@@ -1 +1 @@
-{"version":3,"file":"Model.js","sourceRoot":"","sources":["../../src/Model.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,qBAAqB;AAErB,sDAAwE;AACxE,wDAAwD;AACxD,oDAG4B;AAC5B,uCAA4I;AAC5I,qCAAkC;AAElC,qEAAwE;AA0CxE;;;;GAIG;AACH,MAAa,KAAM,SAAQ,eAAM;IAY/B,gBAAgB;IAChB,YAAY,KAAiB,EAAE,MAAgB;QAC7C,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,8IAA8I;QACxL,IAAI,CAAC,SAAS,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,CAAC,cAAc,GAAG,EAAE,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC,iCAAiC;IACtF,CAAC;IAlBD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,OAAO,CAAC,CAAC,CAAC;IAClE,gBAAgB;IACT,MAAM,KAAc,mBAAmB,KAAK,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAiBjG;;OAEG;IACa,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAgB,CAAC;QACzC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,cAAc;QACpC,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAoB;QAC5C,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,CAAC;QACtB,IAAI,KAAK,CAAC,WAAW,EAAI,uDAAuD;YAC9E,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,WAAW,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC;IAClF,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAC,UAAU,CAAC,IAAkB;QAC5C,gGAAgG;IAClG,CAAC;IAED;;;;;OAKG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAoB;QAC5C,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,+DAA+D;IACxI,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAC,SAAS,CAAC,IAAkB;IAC7C,CAAC;IAED;;;;;OAKG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAiB;QACzC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAC,SAAS,CAAC,IAAkB,IAAU,CAAC;IAExD;;;;;OAKG;IACO,MAAM,CAAC,eAAe,CAAC,IAA8B,IAAU,CAAC;IAE1E;;;;OAIG;IACO,MAAM,CAAC,iBAAiB,CAAC,IAA2B,IAAU,CAAC;IAEzE;;;;;OAKG;IACO,MAAM,CAAC,eAAe,CAAC,IAA8B,IAAU,CAAC;IAE1E;;;;OAIG;IACO,MAAM,CAAC,gBAAgB,CAAC,IAA2B,IAAU,CAAC;IAExE;;;;;OAKG;IACO,MAAM,CAAC,eAAe,CAAC,IAA2B,IAAU,CAAC;IAEvE;;;;OAIG;IACO,MAAM,CAAC,gBAAgB,CAAC,IAA2B,IAAU,CAAC;IAEhE,oBAAoB;QAC1B,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS;YAChC,IAAI,CAAC,cAAc,CAAC,SAAS,GAAG,IAAI,MAAM,EAAE,CAAC;QAE/C,OAAO,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC;IACvC,CAAC;IAED,qDAAqD;IAC9C,iBAAiB,CAAC,SAAiB,IAAI,OAAO,IAAI,CAAC,oBAAoB,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE9F,yEAAyE;IAClE,iBAAiB,CAAC,SAAiB,EAAE,KAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAE3G,sFAAsF;IAC/E,oBAAoB,CAAC,SAAiB,IAAI,OAAO,IAAI,CAAC,oBAAoB,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE1F,eAAe,CAAC,IAAY,IAAS,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACxE,eAAe,CAAC,IAAY,EAAE,KAAU,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAEvF,sCAAsC;IAC/B,MAAM,KAAK,OAAO,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IACnF,uCAAuC;IAChC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAClE,yCAAyC;IAClC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CAC7D;AA5JD,sBA4JC;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,KAAK;IAKvC,gBAAgB;IAChB,YAAY,KAA0B,EAAE,MAAgB,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAHnF,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAI3E,kFAAkF;IAC3E,YAAY;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC;QACrF,OAAO,uBAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;CACF;AAbD,wCAaC;AAED;;GAEG;AACH,MAAsB,gBAAiB,SAAQ,cAAc;IAc3D,gBAAgB;IAChB,YAAY,KAA4B,EAAE,MAAgB;QACxD,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,qBAAqB,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAC3E,IAAI,CAAC,gBAAgB,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACnE,CAAC;IAVD,0HAA0H;IAC1H,IAAW,kBAAkB,KAAc,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAEhF,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;IAO7E,gBAAgB;IACA,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAA2B,CAAC;QACpD,IAAI,IAAI,CAAC,qBAAqB;YAC5B,GAAG,CAAC,qBAAqB,GAAG,IAAI,CAAC;QAEnC,IAAI,IAAI,CAAC,gBAAgB;YACvB,GAAG,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAE9B,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AA/BD,4CA+BC;AAED;;GAEG;AACH,MAAsB,gBAAiB,SAAQ,cAAc;IAK3D,gBAAgB;IAChB,YAAY,KAA4B,EAAE,MAAgB,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAHrF,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;IAG7E,gBAAgB;IACA,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAA2B,CAAC;QACpD,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY;YACjC,GAAG,CAAC,YAAY,GAAG,uBAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEzD,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAfD,4CAeC;AAED;;GAEG;AACH,MAAsB,gBAAiB,SAAQ,gBAAgB;IAC7D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;CAC9E;AAHD,4CAGC;AAED;;;;GAIG;AACH,MAAsB,gBAAiB,SAAQ,gBAAgB;IAC7D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;CAC9E;AAHD,4CAGC;AAED;;GAEG;AACH,MAAsB,YAAa,SAAQ,gBAAgB;IACzD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;CAC1E;AAHD,oCAGC;AAED;;;GAGG;AACH,MAAa,aAAc,SAAQ,YAAY;IAC7C,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,eAAe,CAAC,CAAC,CAAC;IAC1E;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,eAA2B,EAAE,IAAY,EAAE,gBAA0B;QAC5G,MAAM,cAAc,GAAqC;YACvD,aAAa,EAAE,2BAAiB,CAAC,aAAa;YAC9C,KAAK,EAAE,oBAAM,CAAC,iBAAiB;YAC/B,MAAM,EAAE,IAAI,qDAA4B,CAAC,eAAe,CAAC;YACzD,IAAI,EAAE,2BAAiB,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC;SACpE,CAAC;QACF,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QACpE,MAAM,UAAU,GAA0B;YACxC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;YACnC,gBAAgB;SACjB,CAAC;QACF,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC;CACF;AA1BD,sCA0BC;AAED;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,YAAY;IACpD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IACjF;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,eAA2B,EAAE,IAAY,EAAE,gBAA0B;QAC5G,MAAM,cAAc,GAAqC;YACvD,aAAa,EAAE,kCAAwB,CAAC,aAAa;YACrD,KAAK,EAAE,oBAAM,CAAC,iBAAiB;YAC/B,MAAM,EAAE,IAAI,qDAA4B,CAAC,eAAe,CAAC;YACzD,IAAI,EAAE,kCAAwB,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC;SAC3E,CAAC;QACF,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QACpE,MAAM,UAAU,GAA0B;YACxC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;YACnC,gBAAgB;SACjB,CAAC;QACF,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC;CACF;AA1BD,oDA0BC;AAED;;GAEG;AACH,MAAa,YAAa,SAAQ,gBAAgB;IAChD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;CAC1E;AAHD,oCAGC;AAED;;GAEG;AACH,MAAa,mBAAoB,SAAQ,YAAY;IACnD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,qBAAqB,CAAC,CAAC,CAAC;CACjF;AAHD,kDAGC;AAED;;;;GAIG;AACH,MAAa,UAAW,SAAQ,gBAAgB;IAC9C,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,YAAY,CAAC,CAAC,CAAC;CACxE;AAHD,gCAGC;AAED;;GAEG;AACH,MAAa,SAAU,SAAQ,KAAK;IAClC,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,WAAW,CAAC,CAAC,CAAC;CACvE;AAHD,8BAGC;AAED;;GAEG;AACH,MAAsB,gBAAiB,SAAQ,KAAK;IAClD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;CAC9E;AAHD,4CAGC;AAED;;;GAGG;AACH,MAAsB,qBAAsB,SAAQ,gBAAgB;IAClE,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,uBAAuB,CAAC,CAAC,CAAC;CACnF;AAHD,sDAGC;AAED;;;GAGG;AACH,MAAa,sBAAuB,SAAQ,gBAAgB;IAC1D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,wBAAwB,CAAC,CAAC,CAAC;IAEnF;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,eAA2B,EAAE,IAAY;QAChF,MAAM,cAAc,GAAqC;YACvD,aAAa,EAAE,oCAA0B,CAAC,aAAa;YACvD,KAAK,EAAE,oBAAM,CAAC,iBAAiB;YAC/B,MAAM,EAAE,IAAI,qDAA4B,CAAC,eAAe,CAAC;YACzD,IAAI,EAAE,oCAA0B,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC;SAC7E,CAAC;QACF,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC;YACjC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;SACpC,CAAC,CAAC;IACL,CAAC;CACF;AAxBD,wDAwBC;AAED;;;GAGG;AACH,MAAa,eAAgB,SAAQ,gBAAgB;IACnD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAE5E;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,eAA2B,EAAE,IAAY;QAChF,MAAM,cAAc,GAAqC;YACvD,aAAa,EAAE,6BAAmB,CAAC,aAAa;YAChD,KAAK,EAAE,oBAAM,CAAC,iBAAiB;YAC/B,MAAM,EAAE,IAAI,qDAA4B,CAAC,eAAe,CAAC;YACzD,IAAI,EAAE,6BAAmB,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC;SACtE,CAAC;QACF,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC;YACjC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;SACpC,CAAC,CAAC;IACL,CAAC;CACF;AAxBD,0CAwBC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,eAAe;IAClD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;CAC7E;AAHD,0CAGC;AAED;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,gBAAgB;IACrD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,mBAAmB,CAAC,CAAC,CAAC;IAC9E;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,eAA2B,EAAE,IAAY;QAChF,MAAM,cAAc,GAAqC;YACvD,aAAa,EAAE,2BAAiB,CAAC,aAAa;YAC9C,KAAK,EAAE,oBAAM,CAAC,iBAAiB;YAC/B,MAAM,EAAE,IAAI,qDAA4B,CAAC,eAAe,CAAC;YACzD,IAAI,EAAE,2BAAiB,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC;SACpE,CAAC;QACF,MAAM,WAAW,GAAe,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QAChF,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC;YACjC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;SACpC,CAAC,CAAC;IACL,CAAC;CACF;AAvBD,8CAuBC;AAED;;;GAGG;AACH,MAAa,SAAU,SAAQ,gBAAgB;IAC7C,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,WAAW,CAAC,CAAC,CAAC;CACvE;AAHD,8BAGC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,eAAe;IAClD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;CAC7E;AAHD,0CAGC;AAED;;GAEG;AACH,MAAa,gBAAiB,SAAQ,YAAY;IAChD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;CAC9E;AAHD,4CAGC","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 Models\r\n */\r\n\r\n// cspell:ignore elid\r\n\r\nimport { GuidString, Id64String, JsonUtils } from \"@itwin/core-bentley\";\r\nimport { Point2d, Range3d } from \"@itwin/core-geometry\";\r\nimport {\r\n  AxisAlignedBox3d, ElementProps, GeometricModel2dProps, GeometricModel3dProps, GeometricModelProps, IModel, InformationPartitionElementProps,\r\n  ModelProps, RelatedElement,\r\n} from \"@itwin/core-common\";\r\nimport { DefinitionPartition, DocumentPartition, InformationRecordPartition, PhysicalPartition, SpatialLocationPartition } from \"./Element\";\r\nimport { Entity } from \"./Entity\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { SubjectOwnsPartitionElements } from \"./NavigationRelationship\";\r\n\r\n/** Argument for the `Model.onXxx` static methods\r\n * @beta\r\n */\r\nexport interface OnModelArg {\r\n  /** The iModel for the Model affected. */\r\n  iModel: IModelDb;\r\n}\r\n\r\n/** Argument for the `Model.onXxx` static methods that supply the properties of a Model to be inserted or updated.\r\n * @beta\r\n */\r\nexport interface OnModelPropsArg extends OnModelArg {\r\n  /** The new properties of the Model affected. */\r\n  props: Readonly<ModelProps>;\r\n}\r\n\r\n/** Argument for the `Model.onXxx` static methods that only supply the Id of the affected Model.\r\n * @beta\r\n */\r\nexport interface OnModelIdArg extends OnModelArg {\r\n  /** The Id of the Model affected */\r\n  id: Id64String;\r\n}\r\n\r\n/** Argument for the `Model.onXxxElement` static methods that supply the properties of an Element for a Model.\r\n * @beta\r\n */\r\nexport interface OnElementInModelPropsArg extends OnModelIdArg {\r\n  /** The new properties of an Element for the affected Model */\r\n  elementProps: Readonly<ElementProps>;\r\n}\r\n\r\n/** Argument for the `Model.onXxxElement` static methods that supply the Id of an Element for a Model.\r\n * @beta\r\n */\r\nexport interface OnElementInModelIdArg extends OnModelIdArg {\r\n  /** The Id of the Element for the affected Model */\r\n  elementId: Id64String;\r\n}\r\n\r\n/** A Model is a container for persisting a collection of related elements within an iModel.\r\n * See [[IModelDb.Models]] for how to query and manage the Models in an IModelDb.\r\n * See [Creating models]($docs/learning/backend/CreateModels.md)\r\n * @public\r\n */\r\nexport class Model extends Entity {\r\n  /** @internal */\r\n  public static override get className(): string { return \"Model\"; }\r\n  /** @internal */\r\n  public static override get protectedOperations() { return [\"onInsert\", \"onUpdate\", \"onDelete\"]; }\r\n  public readonly modeledElement!: RelatedElement;\r\n  public readonly name: string;\r\n  public readonly parentModel!: Id64String;\r\n  public readonly jsonProperties: { [key: string]: any };\r\n  public isPrivate: boolean;\r\n  public isTemplate: boolean;\r\n\r\n  /** @internal */\r\n  constructor(props: ModelProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.name = props.name ? props.name : \"\"; // NB this isn't really a property of Model (it's the code.value of the modeled element), but it comes in ModelProps because it's often needed\r\n    this.isPrivate = JsonUtils.asBool(props.isPrivate);\r\n    this.isTemplate = JsonUtils.asBool(props.isTemplate);\r\n    this.jsonProperties = { ...props.jsonProperties }; // make sure we have our own copy\r\n  }\r\n\r\n  /** Add all properties of a Model to a json object.\r\n   * @internal\r\n   */\r\n  public override toJSON(): ModelProps {\r\n    const val = super.toJSON() as ModelProps;\r\n    val.name = this.name; // for cloning\r\n    return val;\r\n  }\r\n\r\n  /** Called before a new Model is inserted.\r\n   * @note throw an exception to disallow the insert\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model to be inserted\r\n   * @beta\r\n   */\r\n  protected static onInsert(arg: OnModelPropsArg): void {\r\n    const { props } = arg;\r\n    if (props.parentModel)   // inserting requires shared lock on parent, if present\r\n      arg.iModel.locks.checkSharedLock(props.parentModel, \"parent model\", \"insert\");\r\n  }\r\n\r\n  /** Called after a new Model is inserted.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model that was inserted\r\n   * @beta\r\n   */\r\n  protected static onInserted(_arg: OnModelIdArg): void {\r\n    // we don't need to tell LockControl about models being created - their ModeledElement does that\r\n  }\r\n\r\n  /** Called before a Model is updated.\r\n   * @note throw an exception to disallow the update\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model to be updated\r\n   * @beta\r\n   */\r\n  protected static onUpdate(arg: OnModelPropsArg): void {\r\n    arg.iModel.locks.checkExclusiveLock(arg.props.id!, \"model\", \"update\"); // eslint-disable-line @typescript-eslint/no-non-null-assertion\r\n  }\r\n\r\n  /** Called after a Model is updated.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model that was updated.\r\n   * @beta\r\n   */\r\n  protected static onUpdated(_arg: OnModelIdArg): void {\r\n  }\r\n\r\n  /** Called before a Model is deleted.\r\n   * @note throw an exception to disallow the delete\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model to be deleted\r\n   * @beta\r\n   */\r\n  protected static onDelete(arg: OnModelIdArg): void {\r\n    arg.iModel.locks.checkExclusiveLock(arg.id, \"model\", \"delete\");\r\n  }\r\n\r\n  /** Called after a Model was deleted.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model that was deleted\r\n   * @beta\r\n   */\r\n  protected static onDeleted(_arg: OnModelIdArg): void { }\r\n\r\n  /** Called before a prospective Element is to be inserted into an instance of a Model of this class.\r\n   * @note throw an exception to disallow the insert\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model to hold the element\r\n   * @beta\r\n   */\r\n  protected static onInsertElement(_arg: OnElementInModelPropsArg): void { }\r\n\r\n  /** Called after an Element has been inserted into an instance of a Model of this class.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model holding the element\r\n   * @beta\r\n   */\r\n  protected static onInsertedElement(_arg: OnElementInModelIdArg): void { }\r\n\r\n  /** Called when an Element in an instance of a Model of this class is about to be updated.\r\n   * @note throw an exception to disallow the update\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model holding the element\r\n   * @beta\r\n   */\r\n  protected static onUpdateElement(_arg: OnElementInModelPropsArg): void { }\r\n\r\n  /** Called after an Element in an instance of a Model of this class has been updated.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model holding the element\r\n   * @beta\r\n   */\r\n  protected static onUpdatedElement(_arg: OnElementInModelIdArg): void { }\r\n\r\n  /** Called when an Element in an instance of a Model of this class is about to be deleted.\r\n   * @note throw an exception to disallow the delete\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model holding the element\r\n   * @beta\r\n   */\r\n  protected static onDeleteElement(_arg: OnElementInModelIdArg): void { }\r\n\r\n  /** Called after an Element in an instance of a Model of this class has been deleted.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model that held the element\r\n   * @beta\r\n   */\r\n  protected static onDeletedElement(_arg: OnElementInModelIdArg): void { }\r\n\r\n  private getAllUserProperties(): any {\r\n    if (!this.jsonProperties.UserProps)\r\n      this.jsonProperties.UserProps = new Object();\r\n\r\n    return this.jsonProperties.UserProps;\r\n  }\r\n\r\n  /** Get a set of JSON user properties by namespace */\r\n  public getUserProperties(namespace: string) { return this.getAllUserProperties()[namespace]; }\r\n\r\n  /** Change a set of user JSON properties of this Element by namespace. */\r\n  public setUserProperties(nameSpace: string, value: any) { this.getAllUserProperties()[nameSpace] = value; }\r\n\r\n  /** Remove a set of JSON user properties, specified by namespace, from this Element */\r\n  public removeUserProperties(nameSpace: string) { delete this.getAllUserProperties()[nameSpace]; }\r\n\r\n  public getJsonProperty(name: string): any { return this.jsonProperties[name]; }\r\n  public setJsonProperty(name: string, value: any) { this.jsonProperties[name] = value; }\r\n\r\n  /** Insert this Model in the iModel */\r\n  public insert() { return this.id = this.iModel.models.insertModel(this.toJSON()); }\r\n  /** Update this Model in the iModel. */\r\n  public update() { this.iModel.models.updateModel(this.toJSON()); }\r\n  /** Delete this Model from the iModel. */\r\n  public delete() { this.iModel.models.deleteModel(this.id); }\r\n}\r\n\r\n/** A container for persisting geometric elements.\r\n * @public\r\n */\r\nexport class GeometricModel extends Model {\r\n  public geometryGuid?: GuidString; // Initialized by the Entity constructor\r\n\r\n  /** @internal */\r\n  public static override get className(): string { return \"GeometricModel\"; }\r\n  /** @internal */\r\n  constructor(props: GeometricModelProps, iModel: IModelDb) { super(props, iModel); }\r\n\r\n  /** Query for the union of the extents of the elements contained by this model. */\r\n  public queryExtents(): AxisAlignedBox3d {\r\n    const extents = this.iModel.nativeDb.queryModelExtents({ id: this.id }).modelExtents;\r\n    return Range3d.fromJSON(extents);\r\n  }\r\n}\r\n\r\n/** A container for persisting 3d geometric elements.\r\n * @public\r\n */\r\nexport abstract class GeometricModel3d extends GeometricModel {\r\n  /** If true, then the elements in this GeometricModel3d are expected to be in an XY plane.\r\n   * @note The associated ECProperty was added to the BisCore schema in version 1.0.8\r\n   */\r\n  public readonly isPlanProjection: boolean;\r\n  /** If true, then the elements in this GeometricModel3d are not in real-world coordinates and will not be in the spatial index.\r\n   * @note The associated ECProperty was added to the BisCore schema in version 1.0.8\r\n   */\r\n  public readonly isNotSpatiallyLocated: boolean;\r\n  /** If true, then the elements in this GeometricModel3d are in real-world coordinates and will be in the spatial index. */\r\n  public get isSpatiallyLocated(): boolean { return !this.isNotSpatiallyLocated; }\r\n\r\n  /** @internal */\r\n  public static override get className(): string { return \"GeometricModel3d\"; }\r\n  /** @internal */\r\n  constructor(props: GeometricModel3dProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.isNotSpatiallyLocated = JsonUtils.asBool(props.isNotSpatiallyLocated);\r\n    this.isPlanProjection = JsonUtils.asBool(props.isPlanProjection);\r\n  }\r\n  /** @internal */\r\n  public override toJSON(): GeometricModel3dProps {\r\n    const val = super.toJSON() as GeometricModel3dProps;\r\n    if (this.isNotSpatiallyLocated)\r\n      val.isNotSpatiallyLocated = true;\r\n\r\n    if (this.isPlanProjection)\r\n      val.isPlanProjection = true;\r\n\r\n    return val;\r\n  }\r\n}\r\n\r\n/** A container for persisting 2d geometric elements.\r\n * @public\r\n */\r\nexport abstract class GeometricModel2d extends GeometricModel {\r\n  /** The actual coordinates of (0,0) in modeling coordinates. An offset applied to all modeling coordinates. */\r\n  public globalOrigin?: Point2d; // Initialized by the Entity constructor\r\n  /** @internal */\r\n  public static override get className(): string { return \"GeometricModel2d\"; }\r\n  /** @internal */\r\n  constructor(props: GeometricModel2dProps, iModel: IModelDb) { super(props, iModel); }\r\n  /** @internal */\r\n  public override toJSON(): GeometricModel2dProps {\r\n    const val = super.toJSON() as GeometricModel2dProps;\r\n    if (undefined !== this.globalOrigin)\r\n      val.globalOrigin = Point2d.fromJSON(this.globalOrigin);\r\n\r\n    return val;\r\n  }\r\n}\r\n\r\n/** A container for persisting 2d graphical elements.\r\n * @public\r\n */\r\nexport abstract class GraphicalModel2d extends GeometricModel2d {\r\n  /** @internal */\r\n  public static override get className(): string { return \"GraphicalModel2d\"; }\r\n}\r\n\r\n/** A container for persisting GraphicalElement3d instances.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.8\r\n * @see [[GraphicalPartition3d]]\r\n * @public\r\n */\r\nexport abstract class GraphicalModel3d extends GeometricModel3d {\r\n  /** @internal */\r\n  public static override get className(): string { return \"GraphicalModel3d\"; }\r\n}\r\n\r\n/** A container for persisting 3d geometric elements that are spatially located.\r\n * @public\r\n */\r\nexport abstract class SpatialModel extends GeometricModel3d {\r\n  /** @internal */\r\n  public static override get className(): string { return \"SpatialModel\"; }\r\n}\r\n\r\n/** A container for persisting physical elements that model physical space.\r\n * @see [[PhysicalPartition]]\r\n * @public\r\n */\r\nexport class PhysicalModel extends SpatialModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"PhysicalModel\"; }\r\n  /** Insert a PhysicalPartition and a PhysicalModel that sub-models it.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param parentSubjectId The PhysicalPartition will be inserted as a child of this Subject element.\r\n   * @param name The name of the PhysicalPartition that the new PhysicalModel will sub-model.\r\n   * @param isPlanProjection Optional value (default is false) that indicates if the contents of this model are expected to be in an XY plane.\r\n   * @returns The Id of the newly inserted PhysicalPartition and PhysicalModel (same value).\r\n   * @throws [[IModelError]] if there is an insert problem.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string, isPlanProjection?: boolean): Id64String {\r\n    const partitionProps: InformationPartitionElementProps = {\r\n      classFullName: PhysicalPartition.classFullName,\r\n      model: IModel.repositoryModelId,\r\n      parent: new SubjectOwnsPartitionElements(parentSubjectId),\r\n      code: PhysicalPartition.createCode(iModelDb, parentSubjectId, name),\r\n    };\r\n    const partitionId = iModelDb.elements.insertElement(partitionProps);\r\n    const modelProps: GeometricModel3dProps = {\r\n      classFullName: this.classFullName,\r\n      modeledElement: { id: partitionId },\r\n      isPlanProjection,\r\n    };\r\n    return iModelDb.models.insertModel(modelProps);\r\n  }\r\n}\r\n\r\n/** A container for persisting spatial location elements.\r\n * @see [[SpatialLocationPartition]]\r\n * @public\r\n */\r\nexport class SpatialLocationModel extends SpatialModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"SpatialLocationModel\"; }\r\n  /** Insert a SpatialLocationPartition and a SpatialLocationModel that sub-models it.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param parentSubjectId The SpatialLocationPartition will be inserted as a child of this Subject element.\r\n   * @param name The name of the SpatialLocationPartition that the new SpatialLocationModel will sub-model.\r\n   * @param isPlanProjection Optional value (default is false) that indicates if the contents of this model are expected to be in an XY plane.\r\n   * @returns The Id of the newly inserted SpatialLocationPartition and SpatialLocationModel (same value).\r\n   * @throws [[IModelError]] if there is an insert problem.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string, isPlanProjection?: boolean): Id64String {\r\n    const partitionProps: InformationPartitionElementProps = {\r\n      classFullName: SpatialLocationPartition.classFullName,\r\n      model: IModel.repositoryModelId,\r\n      parent: new SubjectOwnsPartitionElements(parentSubjectId),\r\n      code: SpatialLocationPartition.createCode(iModelDb, parentSubjectId, name),\r\n    };\r\n    const partitionId = iModelDb.elements.insertElement(partitionProps);\r\n    const modelProps: GeometricModel3dProps = {\r\n      classFullName: this.classFullName,\r\n      modeledElement: { id: partitionId },\r\n      isPlanProjection,\r\n    };\r\n    return iModelDb.models.insertModel(modelProps);\r\n  }\r\n}\r\n\r\n/** A 2d model that holds [[DrawingGraphic]]s. DrawingModels may be dimensional or non-dimensional.\r\n * @public\r\n */\r\nexport class DrawingModel extends GraphicalModel2d {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DrawingModel\"; }\r\n}\r\n\r\n/** A container for persisting section [[DrawingGraphic]]s.\r\n * @public\r\n */\r\nexport class SectionDrawingModel extends DrawingModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"SectionDrawingModel\"; }\r\n}\r\n\r\n/** A container for persisting [[ViewAttachment]]s and [[DrawingGraphic]]s.\r\n * A SheetModel is a digital representation of a *sheet of paper*. SheetModels are 2d models in bounded paper coordinates.\r\n * SheetModels may contain annotation Elements as well as references to 2d or 3d Views.\r\n * @public\r\n */\r\nexport class SheetModel extends GraphicalModel2d {\r\n  /** @internal */\r\n  public static override get className(): string { return \"SheetModel\"; }\r\n}\r\n\r\n/** A container for persisting role elements.\r\n * @public\r\n */\r\nexport class RoleModel extends Model {\r\n  /** @internal */\r\n  public static override get className(): string { return \"RoleModel\"; }\r\n}\r\n\r\n/** A container for persisting information elements.\r\n * @public\r\n */\r\nexport abstract class InformationModel extends Model {\r\n  /** @internal */\r\n  public static override get className(): string { return \"InformationModel\"; }\r\n}\r\n\r\n/** A container for persisting group information elements.\r\n * @see [[GroupInformationPartition]]\r\n * @public\r\n */\r\nexport abstract class GroupInformationModel extends InformationModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"GroupInformationModel\"; }\r\n}\r\n\r\n/** A container for persisting Information Record Elements\r\n * @see [[InformationRecordPartition]]\r\n * @public\r\n */\r\nexport class InformationRecordModel extends InformationModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"InformationRecordModel\"; }\r\n\r\n  /** Insert a InformationRecordPartition and a InformationRecordModel that sub-models it.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param parentSubjectId The InformationRecordPartition will be inserted as a child of this Subject element.\r\n   * @param name The name of the InformationRecordPartition that the new InformationRecordModel will sub-model.\r\n   * @returns The Id of the newly inserted InformationRecordModel.\r\n   * @throws [[IModelError]] if there is an insert problem.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string): Id64String {\r\n    const partitionProps: InformationPartitionElementProps = {\r\n      classFullName: InformationRecordPartition.classFullName,\r\n      model: IModel.repositoryModelId,\r\n      parent: new SubjectOwnsPartitionElements(parentSubjectId),\r\n      code: InformationRecordPartition.createCode(iModelDb, parentSubjectId, name),\r\n    };\r\n    const partitionId = iModelDb.elements.insertElement(partitionProps);\r\n    return iModelDb.models.insertModel({\r\n      classFullName: this.classFullName,\r\n      modeledElement: { id: partitionId },\r\n    });\r\n  }\r\n}\r\n\r\n/** A container for persisting definition elements.\r\n * @see [[DefinitionPartition]]\r\n * @public\r\n */\r\nexport class DefinitionModel extends InformationModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DefinitionModel\"; }\r\n\r\n  /** Insert a DefinitionPartition and a DefinitionModel that sub-models it.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param parentSubjectId The DefinitionPartition will be inserted as a child of this Subject element.\r\n   * @param name The name of the DefinitionPartition that the new DefinitionModel will sub-model.\r\n   * @returns The Id of the newly inserted DefinitionModel.\r\n   * @throws [[IModelError]] if there is an insert problem.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string): Id64String {\r\n    const partitionProps: InformationPartitionElementProps = {\r\n      classFullName: DefinitionPartition.classFullName,\r\n      model: IModel.repositoryModelId,\r\n      parent: new SubjectOwnsPartitionElements(parentSubjectId),\r\n      code: DefinitionPartition.createCode(iModelDb, parentSubjectId, name),\r\n    };\r\n    const partitionId = iModelDb.elements.insertElement(partitionProps);\r\n    return iModelDb.models.insertModel({\r\n      classFullName: this.classFullName,\r\n      modeledElement: { id: partitionId },\r\n    });\r\n  }\r\n}\r\n\r\n/** The singleton container of repository-related information elements.\r\n * @public\r\n */\r\nexport class RepositoryModel extends DefinitionModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"RepositoryModel\"; }\r\n}\r\n\r\n/** Contains a list of document elements.\r\n * @see [[DocumentPartition]]\r\n * @public\r\n */\r\nexport class DocumentListModel extends InformationModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DocumentListModel\"; }\r\n  /** Insert a DocumentPartition and a DocumentListModel that sub-models it.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param parentSubjectId The DocumentPartition will be inserted as a child of this Subject element.\r\n   * @param name The name of the DocumentPartition that the new DocumentListModel will sub-model.\r\n   * @returns The Id of the newly inserted DocumentPartition and DocumentListModel (same value)\r\n   * @throws [[IModelError]] if there is an insert problem.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string): Id64String {\r\n    const partitionProps: InformationPartitionElementProps = {\r\n      classFullName: DocumentPartition.classFullName,\r\n      model: IModel.repositoryModelId,\r\n      parent: new SubjectOwnsPartitionElements(parentSubjectId),\r\n      code: DocumentPartition.createCode(iModelDb, parentSubjectId, name),\r\n    };\r\n    const partitionId: Id64String = iModelDb.elements.insertElement(partitionProps);\r\n    return iModelDb.models.insertModel({\r\n      classFullName: this.classFullName,\r\n      modeledElement: { id: partitionId },\r\n    });\r\n  }\r\n}\r\n\r\n/** A container for persisting link elements.\r\n * @see [[LinkPartition]]\r\n * @public\r\n */\r\nexport class LinkModel extends InformationModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"LinkModel\"; }\r\n}\r\n\r\n/** The singleton container for repository-specific definition elements.\r\n * @public\r\n */\r\nexport class DictionaryModel extends DefinitionModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DictionaryModel\"; }\r\n}\r\n\r\n/** Obtains and displays multi-resolution tiled raster organized according to the WebMercator tiling system.\r\n * @public\r\n */\r\nexport class WebMercatorModel extends SpatialModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"WebMercatorModel\"; }\r\n}\r\n"]}
+{"version":3,"file":"Model.js","sourceRoot":"","sources":["../../src/Model.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,qBAAqB;AAErB,sDAAwE;AACxE,wDAAwD;AACxD,oDAG4B;AAC5B,uCAA4I;AAC5I,qCAAkC;AAElC,qEAAwE;AA0CxE;;;;GAIG;AACH,MAAa,KAAM,SAAQ,eAAM;IAY/B,gBAAgB;IAChB,YAAY,KAAiB,EAAE,MAAgB;QAC7C,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,8IAA8I;QACxL,IAAI,CAAC,SAAS,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,CAAC,cAAc,GAAG,EAAE,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC,iCAAiC;IACtF,CAAC;IAlBD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,OAAO,CAAC,CAAC,CAAC;IAClE,gBAAgB;IACT,MAAM,KAAc,mBAAmB,KAAK,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAiBjG;;OAEG;IACa,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAgB,CAAC;QACzC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,cAAc;QACpC,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAoB;QAC5C,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,CAAC;QACtB,IAAI,KAAK,CAAC,WAAW,EAAI,uDAAuD;YAC9E,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,WAAW,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC;IAClF,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAC,UAAU,CAAC,IAAkB;QAC5C,gGAAgG;IAClG,CAAC;IAED;;;;;OAKG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAoB;QAC5C,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,+DAA+D;IACxI,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAC,SAAS,CAAC,IAAkB;IAC7C,CAAC;IAED;;;;;OAKG;IACO,MAAM,CAAC,QAAQ,CAAC,GAAiB;QACzC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAC,SAAS,CAAC,IAAkB,IAAU,CAAC;IAExD;;;;;OAKG;IACO,MAAM,CAAC,eAAe,CAAC,IAA8B,IAAU,CAAC;IAE1E;;;;OAIG;IACO,MAAM,CAAC,iBAAiB,CAAC,IAA2B,IAAU,CAAC;IAEzE;;;;;OAKG;IACO,MAAM,CAAC,eAAe,CAAC,IAA8B,IAAU,CAAC;IAE1E;;;;OAIG;IACO,MAAM,CAAC,gBAAgB,CAAC,IAA2B,IAAU,CAAC;IAExE;;;;;OAKG;IACO,MAAM,CAAC,eAAe,CAAC,IAA2B,IAAU,CAAC;IAEvE;;;;OAIG;IACO,MAAM,CAAC,gBAAgB,CAAC,IAA2B,IAAU,CAAC;IAEhE,oBAAoB;QAC1B,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS;YAChC,IAAI,CAAC,cAAc,CAAC,SAAS,GAAG,IAAI,MAAM,EAAE,CAAC;QAE/C,OAAO,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC;IACvC,CAAC;IAED,qDAAqD;IAC9C,iBAAiB,CAAC,SAAiB,IAAI,OAAO,IAAI,CAAC,oBAAoB,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE9F,yEAAyE;IAClE,iBAAiB,CAAC,SAAiB,EAAE,KAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAE3G,sFAAsF;IAC/E,oBAAoB,CAAC,SAAiB,IAAI,OAAO,IAAI,CAAC,oBAAoB,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE1F,eAAe,CAAC,IAAY,IAAS,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACxE,eAAe,CAAC,IAAY,EAAE,KAAU,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAEvF,sCAAsC;IAC/B,MAAM,KAAK,OAAO,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IACnF,uCAAuC;IAChC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAClE,yCAAyC;IAClC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAE5D,8EAA8E;IAC9E,gBAAgB;IACG,2BAA2B,CAAC,YAAgC;QAC7E,KAAK,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;QAChD,IAAI,IAAI,CAAC,WAAW;YAClB,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC1C,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;IAClD,CAAC;CACF;AArKD,sBAqKC;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,KAAK;IAKvC,gBAAgB;IAChB,YAAY,KAA0B,EAAE,MAAgB,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAHnF,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAI3E;;OAEG;IACI,YAAY;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC;QACrF,OAAO,uBAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED,sFAAsF;IAC/E,KAAK,CAAC,UAAU;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChD,CAAC;CACF;AApBD,wCAoBC;AAED;;GAEG;AACH,MAAsB,gBAAiB,SAAQ,cAAc;IAc3D,gBAAgB;IAChB,YAAY,KAA4B,EAAE,MAAgB;QACxD,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,qBAAqB,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAC3E,IAAI,CAAC,gBAAgB,GAAG,wBAAS,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACnE,CAAC;IAVD,0HAA0H;IAC1H,IAAW,kBAAkB,KAAc,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAEhF,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;IAO7E,gBAAgB;IACA,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAA2B,CAAC;QACpD,IAAI,IAAI,CAAC,qBAAqB;YAC5B,GAAG,CAAC,qBAAqB,GAAG,IAAI,CAAC;QAEnC,IAAI,IAAI,CAAC,gBAAgB;YACvB,GAAG,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAE9B,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AA/BD,4CA+BC;AAED;;GAEG;AACH,MAAsB,gBAAiB,SAAQ,cAAc;IAK3D,gBAAgB;IAChB,YAAY,KAA4B,EAAE,MAAgB,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAHrF,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;IAG7E,gBAAgB;IACA,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAA2B,CAAC;QACpD,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY;YACjC,GAAG,CAAC,YAAY,GAAG,uBAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEzD,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAfD,4CAeC;AAED;;GAEG;AACH,MAAsB,gBAAiB,SAAQ,gBAAgB;IAC7D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;CAC9E;AAHD,4CAGC;AAED;;;;GAIG;AACH,MAAsB,gBAAiB,SAAQ,gBAAgB;IAC7D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;CAC9E;AAHD,4CAGC;AAED;;GAEG;AACH,MAAsB,YAAa,SAAQ,gBAAgB;IACzD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;CAC1E;AAHD,oCAGC;AAED;;;GAGG;AACH,MAAa,aAAc,SAAQ,YAAY;IAC7C,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,eAAe,CAAC,CAAC,CAAC;IAC1E;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,eAA2B,EAAE,IAAY,EAAE,gBAA0B;QAC5G,MAAM,cAAc,GAAqC;YACvD,aAAa,EAAE,2BAAiB,CAAC,aAAa;YAC9C,KAAK,EAAE,oBAAM,CAAC,iBAAiB;YAC/B,MAAM,EAAE,IAAI,qDAA4B,CAAC,eAAe,CAAC;YACzD,IAAI,EAAE,2BAAiB,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC;SACpE,CAAC;QACF,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QACpE,MAAM,UAAU,GAA0B;YACxC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;YACnC,gBAAgB;SACjB,CAAC;QACF,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC;CACF;AA1BD,sCA0BC;AAED;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,YAAY;IACpD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IACjF;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,eAA2B,EAAE,IAAY,EAAE,gBAA0B;QAC5G,MAAM,cAAc,GAAqC;YACvD,aAAa,EAAE,kCAAwB,CAAC,aAAa;YACrD,KAAK,EAAE,oBAAM,CAAC,iBAAiB;YAC/B,MAAM,EAAE,IAAI,qDAA4B,CAAC,eAAe,CAAC;YACzD,IAAI,EAAE,kCAAwB,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC;SAC3E,CAAC;QACF,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QACpE,MAAM,UAAU,GAA0B;YACxC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;YACnC,gBAAgB;SACjB,CAAC;QACF,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC;CACF;AA1BD,oDA0BC;AAED;;GAEG;AACH,MAAa,YAAa,SAAQ,gBAAgB;IAChD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;CAC1E;AAHD,oCAGC;AAED;;GAEG;AACH,MAAa,mBAAoB,SAAQ,YAAY;IACnD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,qBAAqB,CAAC,CAAC,CAAC;CACjF;AAHD,kDAGC;AAED;;;;GAIG;AACH,MAAa,UAAW,SAAQ,gBAAgB;IAC9C,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,YAAY,CAAC,CAAC,CAAC;CACxE;AAHD,gCAGC;AAED;;GAEG;AACH,MAAa,SAAU,SAAQ,KAAK;IAClC,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,WAAW,CAAC,CAAC,CAAC;CACvE;AAHD,8BAGC;AAED;;GAEG;AACH,MAAsB,gBAAiB,SAAQ,KAAK;IAClD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;CAC9E;AAHD,4CAGC;AAED;;;GAGG;AACH,MAAsB,qBAAsB,SAAQ,gBAAgB;IAClE,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,uBAAuB,CAAC,CAAC,CAAC;CACnF;AAHD,sDAGC;AAED;;;GAGG;AACH,MAAa,sBAAuB,SAAQ,gBAAgB;IAC1D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,wBAAwB,CAAC,CAAC,CAAC;IAEnF;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,eAA2B,EAAE,IAAY;QAChF,MAAM,cAAc,GAAqC;YACvD,aAAa,EAAE,oCAA0B,CAAC,aAAa;YACvD,KAAK,EAAE,oBAAM,CAAC,iBAAiB;YAC/B,MAAM,EAAE,IAAI,qDAA4B,CAAC,eAAe,CAAC;YACzD,IAAI,EAAE,oCAA0B,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC;SAC7E,CAAC;QACF,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC;YACjC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;SACpC,CAAC,CAAC;IACL,CAAC;CACF;AAxBD,wDAwBC;AAED;;;GAGG;AACH,MAAa,eAAgB,SAAQ,gBAAgB;IACnD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAE5E;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,eAA2B,EAAE,IAAY;QAChF,MAAM,cAAc,GAAqC;YACvD,aAAa,EAAE,6BAAmB,CAAC,aAAa;YAChD,KAAK,EAAE,oBAAM,CAAC,iBAAiB;YAC/B,MAAM,EAAE,IAAI,qDAA4B,CAAC,eAAe,CAAC;YACzD,IAAI,EAAE,6BAAmB,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC;SACtE,CAAC;QACF,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC;YACjC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;SACpC,CAAC,CAAC;IACL,CAAC;CACF;AAxBD,0CAwBC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,eAAe;IAClD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;CAC7E;AAHD,0CAGC;AAED;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,gBAAgB;IACrD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,mBAAmB,CAAC,CAAC,CAAC;IAC9E;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,eAA2B,EAAE,IAAY;QAChF,MAAM,cAAc,GAAqC;YACvD,aAAa,EAAE,2BAAiB,CAAC,aAAa;YAC9C,KAAK,EAAE,oBAAM,CAAC,iBAAiB;YAC/B,MAAM,EAAE,IAAI,qDAA4B,CAAC,eAAe,CAAC;YACzD,IAAI,EAAE,2BAAiB,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC;SACpE,CAAC;QACF,MAAM,WAAW,GAAe,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QAChF,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC;YACjC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;SACpC,CAAC,CAAC;IACL,CAAC;CACF;AAvBD,8CAuBC;AAED;;;GAGG;AACH,MAAa,SAAU,SAAQ,gBAAgB;IAC7C,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,WAAW,CAAC,CAAC,CAAC;CACvE;AAHD,8BAGC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,eAAe;IAClD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;CAC7E;AAHD,0CAGC;AAED;;GAEG;AACH,MAAa,gBAAiB,SAAQ,YAAY;IAChD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;CAC9E;AAHD,4CAGC","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 Models\r\n */\r\n\r\n// cspell:ignore elid\r\n\r\nimport { GuidString, Id64String, JsonUtils } from \"@itwin/core-bentley\";\r\nimport { Point2d, Range3d } from \"@itwin/core-geometry\";\r\nimport {\r\n  AxisAlignedBox3d, ElementProps, EntityReferenceSet, GeometricModel2dProps, GeometricModel3dProps, GeometricModelProps, IModel,\r\n  InformationPartitionElementProps, ModelProps, RelatedElement,\r\n} from \"@itwin/core-common\";\r\nimport { DefinitionPartition, DocumentPartition, InformationRecordPartition, PhysicalPartition, SpatialLocationPartition } from \"./Element\";\r\nimport { Entity } from \"./Entity\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { SubjectOwnsPartitionElements } from \"./NavigationRelationship\";\r\n\r\n/** Argument for the `Model.onXxx` static methods\r\n * @beta\r\n */\r\nexport interface OnModelArg {\r\n  /** The iModel for the Model affected. */\r\n  iModel: IModelDb;\r\n}\r\n\r\n/** Argument for the `Model.onXxx` static methods that supply the properties of a Model to be inserted or updated.\r\n * @beta\r\n */\r\nexport interface OnModelPropsArg extends OnModelArg {\r\n  /** The new properties of the Model affected. */\r\n  props: Readonly<ModelProps>;\r\n}\r\n\r\n/** Argument for the `Model.onXxx` static methods that only supply the Id of the affected Model.\r\n * @beta\r\n */\r\nexport interface OnModelIdArg extends OnModelArg {\r\n  /** The Id of the Model affected */\r\n  id: Id64String;\r\n}\r\n\r\n/** Argument for the `Model.onXxxElement` static methods that supply the properties of an Element for a Model.\r\n * @beta\r\n */\r\nexport interface OnElementInModelPropsArg extends OnModelIdArg {\r\n  /** The new properties of an Element for the affected Model */\r\n  elementProps: Readonly<ElementProps>;\r\n}\r\n\r\n/** Argument for the `Model.onXxxElement` static methods that supply the Id of an Element for a Model.\r\n * @beta\r\n */\r\nexport interface OnElementInModelIdArg extends OnModelIdArg {\r\n  /** The Id of the Element for the affected Model */\r\n  elementId: Id64String;\r\n}\r\n\r\n/** A Model is a container for persisting a collection of related elements within an iModel.\r\n * See [[IModelDb.Models]] for how to query and manage the Models in an IModelDb.\r\n * See [Creating models]($docs/learning/backend/CreateModels.md)\r\n * @public\r\n */\r\nexport class Model extends Entity {\r\n  /** @internal */\r\n  public static override get className(): string { return \"Model\"; }\r\n  /** @internal */\r\n  public static override get protectedOperations() { return [\"onInsert\", \"onUpdate\", \"onDelete\"]; }\r\n  public readonly modeledElement!: RelatedElement;\r\n  public readonly name: string;\r\n  public readonly parentModel!: Id64String;\r\n  public readonly jsonProperties: { [key: string]: any };\r\n  public isPrivate: boolean;\r\n  public isTemplate: boolean;\r\n\r\n  /** @internal */\r\n  constructor(props: ModelProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.name = props.name ? props.name : \"\"; // NB this isn't really a property of Model (it's the code.value of the modeled element), but it comes in ModelProps because it's often needed\r\n    this.isPrivate = JsonUtils.asBool(props.isPrivate);\r\n    this.isTemplate = JsonUtils.asBool(props.isTemplate);\r\n    this.jsonProperties = { ...props.jsonProperties }; // make sure we have our own copy\r\n  }\r\n\r\n  /** Add all properties of a Model to a json object.\r\n   * @internal\r\n   */\r\n  public override toJSON(): ModelProps {\r\n    const val = super.toJSON() as ModelProps;\r\n    val.name = this.name; // for cloning\r\n    return val;\r\n  }\r\n\r\n  /** Called before a new Model is inserted.\r\n   * @note throw an exception to disallow the insert\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model to be inserted\r\n   * @beta\r\n   */\r\n  protected static onInsert(arg: OnModelPropsArg): void {\r\n    const { props } = arg;\r\n    if (props.parentModel)   // inserting requires shared lock on parent, if present\r\n      arg.iModel.locks.checkSharedLock(props.parentModel, \"parent model\", \"insert\");\r\n  }\r\n\r\n  /** Called after a new Model is inserted.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model that was inserted\r\n   * @beta\r\n   */\r\n  protected static onInserted(_arg: OnModelIdArg): void {\r\n    // we don't need to tell LockControl about models being created - their ModeledElement does that\r\n  }\r\n\r\n  /** Called before a Model is updated.\r\n   * @note throw an exception to disallow the update\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model to be updated\r\n   * @beta\r\n   */\r\n  protected static onUpdate(arg: OnModelPropsArg): void {\r\n    arg.iModel.locks.checkExclusiveLock(arg.props.id!, \"model\", \"update\"); // eslint-disable-line @typescript-eslint/no-non-null-assertion\r\n  }\r\n\r\n  /** Called after a Model is updated.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model that was updated.\r\n   * @beta\r\n   */\r\n  protected static onUpdated(_arg: OnModelIdArg): void {\r\n  }\r\n\r\n  /** Called before a Model is deleted.\r\n   * @note throw an exception to disallow the delete\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model to be deleted\r\n   * @beta\r\n   */\r\n  protected static onDelete(arg: OnModelIdArg): void {\r\n    arg.iModel.locks.checkExclusiveLock(arg.id, \"model\", \"delete\");\r\n  }\r\n\r\n  /** Called after a Model was deleted.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model that was deleted\r\n   * @beta\r\n   */\r\n  protected static onDeleted(_arg: OnModelIdArg): void { }\r\n\r\n  /** Called before a prospective Element is to be inserted into an instance of a Model of this class.\r\n   * @note throw an exception to disallow the insert\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model to hold the element\r\n   * @beta\r\n   */\r\n  protected static onInsertElement(_arg: OnElementInModelPropsArg): void { }\r\n\r\n  /** Called after an Element has been inserted into an instance of a Model of this class.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model holding the element\r\n   * @beta\r\n   */\r\n  protected static onInsertedElement(_arg: OnElementInModelIdArg): void { }\r\n\r\n  /** Called when an Element in an instance of a Model of this class is about to be updated.\r\n   * @note throw an exception to disallow the update\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model holding the element\r\n   * @beta\r\n   */\r\n  protected static onUpdateElement(_arg: OnElementInModelPropsArg): void { }\r\n\r\n  /** Called after an Element in an instance of a Model of this class has been updated.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model holding the element\r\n   * @beta\r\n   */\r\n  protected static onUpdatedElement(_arg: OnElementInModelIdArg): void { }\r\n\r\n  /** Called when an Element in an instance of a Model of this class is about to be deleted.\r\n   * @note throw an exception to disallow the delete\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model holding the element\r\n   * @beta\r\n   */\r\n  protected static onDeleteElement(_arg: OnElementInModelIdArg): void { }\r\n\r\n  /** Called after an Element in an instance of a Model of this class has been deleted.\r\n   * @note If you override this method, you must call super.\r\n   * @note `this` is the class of the Model that held the element\r\n   * @beta\r\n   */\r\n  protected static onDeletedElement(_arg: OnElementInModelIdArg): void { }\r\n\r\n  private getAllUserProperties(): any {\r\n    if (!this.jsonProperties.UserProps)\r\n      this.jsonProperties.UserProps = new Object();\r\n\r\n    return this.jsonProperties.UserProps;\r\n  }\r\n\r\n  /** Get a set of JSON user properties by namespace */\r\n  public getUserProperties(namespace: string) { return this.getAllUserProperties()[namespace]; }\r\n\r\n  /** Change a set of user JSON properties of this Element by namespace. */\r\n  public setUserProperties(nameSpace: string, value: any) { this.getAllUserProperties()[nameSpace] = value; }\r\n\r\n  /** Remove a set of JSON user properties, specified by namespace, from this Element */\r\n  public removeUserProperties(nameSpace: string) { delete this.getAllUserProperties()[nameSpace]; }\r\n\r\n  public getJsonProperty(name: string): any { return this.jsonProperties[name]; }\r\n  public setJsonProperty(name: string, value: any) { this.jsonProperties[name] = value; }\r\n\r\n  /** Insert this Model in the iModel */\r\n  public insert() { return this.id = this.iModel.models.insertModel(this.toJSON()); }\r\n  /** Update this Model in the iModel. */\r\n  public update() { this.iModel.models.updateModel(this.toJSON()); }\r\n  /** Delete this Model from the iModel. */\r\n  public delete() { this.iModel.models.deleteModel(this.id); }\r\n\r\n  // NOTE: non-element entities do not yet have a concept of required references\r\n  /** @internal */\r\n  protected override collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceConcreteIds(referenceIds);\r\n    if (this.parentModel)\r\n      referenceIds.addModel(this.parentModel);\r\n    referenceIds.addElement(this.modeledElement.id);\r\n  }\r\n}\r\n\r\n/** A container for persisting geometric elements.\r\n * @public\r\n */\r\nexport class GeometricModel extends Model {\r\n  public geometryGuid?: GuidString; // Initialized by the Entity constructor\r\n\r\n  /** @internal */\r\n  public static override get className(): string { return \"GeometricModel\"; }\r\n  /** @internal */\r\n  constructor(props: GeometricModelProps, iModel: IModelDb) { super(props, iModel); }\r\n\r\n  /** Query for the union of the extents of the elements contained by this model.\r\n   * @note This function blocks the JavaScript event loop. Consider using [[queryRange]] instead.\r\n   */\r\n  public queryExtents(): AxisAlignedBox3d {\r\n    const extents = this.iModel.nativeDb.queryModelExtents({ id: this.id }).modelExtents;\r\n    return Range3d.fromJSON(extents);\r\n  }\r\n\r\n  /** Query for the union of the extents of all elements contained within this model. */\r\n  public async queryRange(): Promise<AxisAlignedBox3d> {\r\n    return this.iModel.models.queryRange(this.id);\r\n  }\r\n}\r\n\r\n/** A container for persisting 3d geometric elements.\r\n * @public\r\n */\r\nexport abstract class GeometricModel3d extends GeometricModel {\r\n  /** If true, then the elements in this GeometricModel3d are expected to be in an XY plane.\r\n   * @note The associated ECProperty was added to the BisCore schema in version 1.0.8\r\n   */\r\n  public readonly isPlanProjection: boolean;\r\n  /** If true, then the elements in this GeometricModel3d are not in real-world coordinates and will not be in the spatial index.\r\n   * @note The associated ECProperty was added to the BisCore schema in version 1.0.8\r\n   */\r\n  public readonly isNotSpatiallyLocated: boolean;\r\n  /** If true, then the elements in this GeometricModel3d are in real-world coordinates and will be in the spatial index. */\r\n  public get isSpatiallyLocated(): boolean { return !this.isNotSpatiallyLocated; }\r\n\r\n  /** @internal */\r\n  public static override get className(): string { return \"GeometricModel3d\"; }\r\n  /** @internal */\r\n  constructor(props: GeometricModel3dProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.isNotSpatiallyLocated = JsonUtils.asBool(props.isNotSpatiallyLocated);\r\n    this.isPlanProjection = JsonUtils.asBool(props.isPlanProjection);\r\n  }\r\n  /** @internal */\r\n  public override toJSON(): GeometricModel3dProps {\r\n    const val = super.toJSON() as GeometricModel3dProps;\r\n    if (this.isNotSpatiallyLocated)\r\n      val.isNotSpatiallyLocated = true;\r\n\r\n    if (this.isPlanProjection)\r\n      val.isPlanProjection = true;\r\n\r\n    return val;\r\n  }\r\n}\r\n\r\n/** A container for persisting 2d geometric elements.\r\n * @public\r\n */\r\nexport abstract class GeometricModel2d extends GeometricModel {\r\n  /** The actual coordinates of (0,0) in modeling coordinates. An offset applied to all modeling coordinates. */\r\n  public globalOrigin?: Point2d; // Initialized by the Entity constructor\r\n  /** @internal */\r\n  public static override get className(): string { return \"GeometricModel2d\"; }\r\n  /** @internal */\r\n  constructor(props: GeometricModel2dProps, iModel: IModelDb) { super(props, iModel); }\r\n  /** @internal */\r\n  public override toJSON(): GeometricModel2dProps {\r\n    const val = super.toJSON() as GeometricModel2dProps;\r\n    if (undefined !== this.globalOrigin)\r\n      val.globalOrigin = Point2d.fromJSON(this.globalOrigin);\r\n\r\n    return val;\r\n  }\r\n}\r\n\r\n/** A container for persisting 2d graphical elements.\r\n * @public\r\n */\r\nexport abstract class GraphicalModel2d extends GeometricModel2d {\r\n  /** @internal */\r\n  public static override get className(): string { return \"GraphicalModel2d\"; }\r\n}\r\n\r\n/** A container for persisting GraphicalElement3d instances.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.8\r\n * @see [[GraphicalPartition3d]]\r\n * @public\r\n */\r\nexport abstract class GraphicalModel3d extends GeometricModel3d {\r\n  /** @internal */\r\n  public static override get className(): string { return \"GraphicalModel3d\"; }\r\n}\r\n\r\n/** A container for persisting 3d geometric elements that are spatially located.\r\n * @public\r\n */\r\nexport abstract class SpatialModel extends GeometricModel3d {\r\n  /** @internal */\r\n  public static override get className(): string { return \"SpatialModel\"; }\r\n}\r\n\r\n/** A container for persisting physical elements that model physical space.\r\n * @see [[PhysicalPartition]]\r\n * @public\r\n */\r\nexport class PhysicalModel extends SpatialModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"PhysicalModel\"; }\r\n  /** Insert a PhysicalPartition and a PhysicalModel that sub-models it.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param parentSubjectId The PhysicalPartition will be inserted as a child of this Subject element.\r\n   * @param name The name of the PhysicalPartition that the new PhysicalModel will sub-model.\r\n   * @param isPlanProjection Optional value (default is false) that indicates if the contents of this model are expected to be in an XY plane.\r\n   * @returns The Id of the newly inserted PhysicalPartition and PhysicalModel (same value).\r\n   * @throws [[IModelError]] if there is an insert problem.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string, isPlanProjection?: boolean): Id64String {\r\n    const partitionProps: InformationPartitionElementProps = {\r\n      classFullName: PhysicalPartition.classFullName,\r\n      model: IModel.repositoryModelId,\r\n      parent: new SubjectOwnsPartitionElements(parentSubjectId),\r\n      code: PhysicalPartition.createCode(iModelDb, parentSubjectId, name),\r\n    };\r\n    const partitionId = iModelDb.elements.insertElement(partitionProps);\r\n    const modelProps: GeometricModel3dProps = {\r\n      classFullName: this.classFullName,\r\n      modeledElement: { id: partitionId },\r\n      isPlanProjection,\r\n    };\r\n    return iModelDb.models.insertModel(modelProps);\r\n  }\r\n}\r\n\r\n/** A container for persisting spatial location elements.\r\n * @see [[SpatialLocationPartition]]\r\n * @public\r\n */\r\nexport class SpatialLocationModel extends SpatialModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"SpatialLocationModel\"; }\r\n  /** Insert a SpatialLocationPartition and a SpatialLocationModel that sub-models it.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param parentSubjectId The SpatialLocationPartition will be inserted as a child of this Subject element.\r\n   * @param name The name of the SpatialLocationPartition that the new SpatialLocationModel will sub-model.\r\n   * @param isPlanProjection Optional value (default is false) that indicates if the contents of this model are expected to be in an XY plane.\r\n   * @returns The Id of the newly inserted SpatialLocationPartition and SpatialLocationModel (same value).\r\n   * @throws [[IModelError]] if there is an insert problem.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string, isPlanProjection?: boolean): Id64String {\r\n    const partitionProps: InformationPartitionElementProps = {\r\n      classFullName: SpatialLocationPartition.classFullName,\r\n      model: IModel.repositoryModelId,\r\n      parent: new SubjectOwnsPartitionElements(parentSubjectId),\r\n      code: SpatialLocationPartition.createCode(iModelDb, parentSubjectId, name),\r\n    };\r\n    const partitionId = iModelDb.elements.insertElement(partitionProps);\r\n    const modelProps: GeometricModel3dProps = {\r\n      classFullName: this.classFullName,\r\n      modeledElement: { id: partitionId },\r\n      isPlanProjection,\r\n    };\r\n    return iModelDb.models.insertModel(modelProps);\r\n  }\r\n}\r\n\r\n/** A 2d model that holds [[DrawingGraphic]]s. DrawingModels may be dimensional or non-dimensional.\r\n * @public\r\n */\r\nexport class DrawingModel extends GraphicalModel2d {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DrawingModel\"; }\r\n}\r\n\r\n/** A container for persisting section [[DrawingGraphic]]s.\r\n * @public\r\n */\r\nexport class SectionDrawingModel extends DrawingModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"SectionDrawingModel\"; }\r\n}\r\n\r\n/** A container for persisting [[ViewAttachment]]s and [[DrawingGraphic]]s.\r\n * A SheetModel is a digital representation of a *sheet of paper*. SheetModels are 2d models in bounded paper coordinates.\r\n * SheetModels may contain annotation Elements as well as references to 2d or 3d Views.\r\n * @public\r\n */\r\nexport class SheetModel extends GraphicalModel2d {\r\n  /** @internal */\r\n  public static override get className(): string { return \"SheetModel\"; }\r\n}\r\n\r\n/** A container for persisting role elements.\r\n * @public\r\n */\r\nexport class RoleModel extends Model {\r\n  /** @internal */\r\n  public static override get className(): string { return \"RoleModel\"; }\r\n}\r\n\r\n/** A container for persisting information elements.\r\n * @public\r\n */\r\nexport abstract class InformationModel extends Model {\r\n  /** @internal */\r\n  public static override get className(): string { return \"InformationModel\"; }\r\n}\r\n\r\n/** A container for persisting group information elements.\r\n * @see [[GroupInformationPartition]]\r\n * @public\r\n */\r\nexport abstract class GroupInformationModel extends InformationModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"GroupInformationModel\"; }\r\n}\r\n\r\n/** A container for persisting Information Record Elements\r\n * @see [[InformationRecordPartition]]\r\n * @public\r\n */\r\nexport class InformationRecordModel extends InformationModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"InformationRecordModel\"; }\r\n\r\n  /** Insert a InformationRecordPartition and a InformationRecordModel that sub-models it.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param parentSubjectId The InformationRecordPartition will be inserted as a child of this Subject element.\r\n   * @param name The name of the InformationRecordPartition that the new InformationRecordModel will sub-model.\r\n   * @returns The Id of the newly inserted InformationRecordModel.\r\n   * @throws [[IModelError]] if there is an insert problem.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string): Id64String {\r\n    const partitionProps: InformationPartitionElementProps = {\r\n      classFullName: InformationRecordPartition.classFullName,\r\n      model: IModel.repositoryModelId,\r\n      parent: new SubjectOwnsPartitionElements(parentSubjectId),\r\n      code: InformationRecordPartition.createCode(iModelDb, parentSubjectId, name),\r\n    };\r\n    const partitionId = iModelDb.elements.insertElement(partitionProps);\r\n    return iModelDb.models.insertModel({\r\n      classFullName: this.classFullName,\r\n      modeledElement: { id: partitionId },\r\n    });\r\n  }\r\n}\r\n\r\n/** A container for persisting definition elements.\r\n * @see [[DefinitionPartition]]\r\n * @public\r\n */\r\nexport class DefinitionModel extends InformationModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DefinitionModel\"; }\r\n\r\n  /** Insert a DefinitionPartition and a DefinitionModel that sub-models it.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param parentSubjectId The DefinitionPartition will be inserted as a child of this Subject element.\r\n   * @param name The name of the DefinitionPartition that the new DefinitionModel will sub-model.\r\n   * @returns The Id of the newly inserted DefinitionModel.\r\n   * @throws [[IModelError]] if there is an insert problem.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string): Id64String {\r\n    const partitionProps: InformationPartitionElementProps = {\r\n      classFullName: DefinitionPartition.classFullName,\r\n      model: IModel.repositoryModelId,\r\n      parent: new SubjectOwnsPartitionElements(parentSubjectId),\r\n      code: DefinitionPartition.createCode(iModelDb, parentSubjectId, name),\r\n    };\r\n    const partitionId = iModelDb.elements.insertElement(partitionProps);\r\n    return iModelDb.models.insertModel({\r\n      classFullName: this.classFullName,\r\n      modeledElement: { id: partitionId },\r\n    });\r\n  }\r\n}\r\n\r\n/** The singleton container of repository-related information elements.\r\n * @public\r\n */\r\nexport class RepositoryModel extends DefinitionModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"RepositoryModel\"; }\r\n}\r\n\r\n/** Contains a list of document elements.\r\n * @see [[DocumentPartition]]\r\n * @public\r\n */\r\nexport class DocumentListModel extends InformationModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DocumentListModel\"; }\r\n  /** Insert a DocumentPartition and a DocumentListModel that sub-models it.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param parentSubjectId The DocumentPartition will be inserted as a child of this Subject element.\r\n   * @param name The name of the DocumentPartition that the new DocumentListModel will sub-model.\r\n   * @returns The Id of the newly inserted DocumentPartition and DocumentListModel (same value)\r\n   * @throws [[IModelError]] if there is an insert problem.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string): Id64String {\r\n    const partitionProps: InformationPartitionElementProps = {\r\n      classFullName: DocumentPartition.classFullName,\r\n      model: IModel.repositoryModelId,\r\n      parent: new SubjectOwnsPartitionElements(parentSubjectId),\r\n      code: DocumentPartition.createCode(iModelDb, parentSubjectId, name),\r\n    };\r\n    const partitionId: Id64String = iModelDb.elements.insertElement(partitionProps);\r\n    return iModelDb.models.insertModel({\r\n      classFullName: this.classFullName,\r\n      modeledElement: { id: partitionId },\r\n    });\r\n  }\r\n}\r\n\r\n/** A container for persisting link elements.\r\n * @see [[LinkPartition]]\r\n * @public\r\n */\r\nexport class LinkModel extends InformationModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"LinkModel\"; }\r\n}\r\n\r\n/** The singleton container for repository-specific definition elements.\r\n * @public\r\n */\r\nexport class DictionaryModel extends DefinitionModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DictionaryModel\"; }\r\n}\r\n\r\n/** Obtains and displays multi-resolution tiled raster organized according to the WebMercator tiling system.\r\n * @public\r\n */\r\nexport class WebMercatorModel extends SpatialModel {\r\n  /** @internal */\r\n  public static override get className(): string { return \"WebMercatorModel\"; }\r\n}\r\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"NativeHost.d.ts","sourceRoot":"","sources":["../../src/NativeHost.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAuB,OAAO,EAAc,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EACW,0BAA0B,EAA6D,sBAAsB,EAC7H,YAAY,EACb,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAAuB,WAAW,EAAE,MAAM,WAAW,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAwGtD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,UAAU,CAAC,EAAE;QACX,+GAA+G;QAC/G,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;CACH;AAED;;;GAGG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAA6B;IAC1D,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAS;IACxC,OAAO;IAEP,qEAAqE;IACrE,gBAAuB,6BAA6B,mBAAwB,0BAA0B,KAAK,IAAI,EAAI;IAEnH,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAS;IAE7C,0DAA0D;IAC1D,WAAkB,mBAAmB,IAAI,MAAM,CAI9C;IAED,yEAAyE;WAC3D,oBAAoB,CAAC,CAAC,SAAS,MAAM,sBAAsB,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAIxI,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAS;IAChC,WAAkB,OAAO,IAAI,OAAO,CAA0B;IAC9D,WAAkB,eAAe,WAAoC;IACrE,kDAAkD;IAClD,WAAkB,aAAa,qBAE9B;IAED;;;OAGG;WACiB,OAAO,CAAC,GAAG,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAahE,mEAAmE;WAC/C,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAM7C,iDAAiD;WACnC,yBAAyB,IAAI,0BAA0B;IAIrE;;;;OAIG;WACW,4BAA4B,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,0BAA0B,GAAG,IAAI;CAMjH"}
+{"version":3,"file":"NativeHost.d.ts","sourceRoot":"","sources":["../../src/NativeHost.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAuB,OAAO,EAAc,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EACW,0BAA0B,EAA6D,sBAAsB,EAC7H,YAAY,EACb,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAAuB,WAAW,EAA4B,MAAM,WAAW,CAAC;AACvF,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAoGtD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,UAAU,CAAC,EAAE;QACX,+GAA+G;QAC/G,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;CACH;AAED;;;GAGG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAA6B;IAC1D,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAS;IACxC,OAAO;IAEP,qEAAqE;IACrE,gBAAuB,6BAA6B,mBAAwB,0BAA0B,KAAK,IAAI,EAAI;IAEnH,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAS;IAE7C,0DAA0D;IAC1D,WAAkB,mBAAmB,IAAI,MAAM,CAI9C;IAED,yEAAyE;WAC3D,oBAAoB,CAAC,CAAC,SAAS,MAAM,sBAAsB,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAIxI,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAS;IAChC,WAAkB,OAAO,IAAI,OAAO,CAA0B;IAC9D,WAAkB,eAAe,WAAoC;IACrE,kDAAkD;IAClD,WAAkB,aAAa,qBAE9B;IAED;;;OAGG;WACiB,OAAO,CAAC,GAAG,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAahE,mEAAmE;WAC/C,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAM7C,iDAAiD;WACnC,yBAAyB,IAAI,0BAA0B;IAIrE;;;;OAIG;WACW,4BAA4B,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,0BAA0B,GAAG,IAAI;CAMjH"}

package/lib/cjs/NativeHost.js

@@ -40,27 +40,22 @@ class NativeAppHandler extends IpcHost_1.IpcHandler {
     async downloadBriefcase(request, reportProgress, progressInterval) {
         const args = {
             ...request,
+            accessToken: await this.getAccessToken(),
             onProgress: (_a, _b) => checkAbort(),
         };
-        if (reportProgress) {
-            const interval = progressInterval !== null && progressInterval !== void 0 ? progressInterval : 250; // by default, only send progress events every 250 milliseconds
-            let nextTime = Date.now() + interval;
-            args.onProgress = (loaded, total) => {
-                const now = Date.now();
-                if (loaded >= total || now >= nextTime) {
-                    nextTime = now + interval;
-                    IpcHost_1.IpcHost.send(`nativeApp.progress-${request.iModelId}`, { loaded, total });
-                }
-                return checkAbort();
-            };
-        }
-        const downloadPromise = BriefcaseManager_1.BriefcaseManager.downloadBriefcase(args);
         const checkAbort = () => {
             (0, core_bentley_1.assert)(undefined !== args.fileName);
             const job = CheckpointManager_1.Downloads.isInProgress(args.fileName);
-            return (job && job.request.abort === 1) ? 1 : 0;
+            return (job && job.request.abort === 1) ? CheckpointManager_1.ProgressStatus.Abort : CheckpointManager_1.ProgressStatus.Continue;
         };
-        return downloadPromise;
+        if (reportProgress) {
+            const progressCallback = (loaded, total) => {
+                IpcHost_1.IpcHost.send(`nativeApp.progress-${request.iModelId}`, { loaded, total });
+                return checkAbort();
+            };
+            args.onProgress = (0, IpcHost_1.throttleProgressCallback)(progressCallback, checkAbort, progressInterval);
+        }
+        return BriefcaseManager_1.BriefcaseManager.downloadBriefcase(args);
     }
     async requestCancelDownloadBriefcase(fileName) {
         const job = CheckpointManager_1.Downloads.isInProgress(fileName);

package/lib/cjs/NativeHost.js.map

@@ -1 +1 @@
-{"version":3,"file":"NativeHost.js","sourceRoot":"","sources":["../../src/NativeHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA4B;AAC5B,sDAA+E;AAC/E,oDAG4B;AAC5B,yDAAsD;AACtD,2DAAgD;AAChD,6CAA0C;AAC1C,uCAA6D;AAC7D,yDAAsD;AAEtD;;GAEG;AACH,MAAM,gBAAiB,SAAQ,oBAAU;IACvC,IAAW,WAAW,KAAK,OAAO,8BAAgB,CAAC,CAAC,CAAC;IAE9C,KAAK,CAAC,cAAc;;QACzB,OAAO,MAAA,uBAAU,CAAC,mBAAmB,0CAAE,cAAc,EAAE,CAAC;IAC1D,CAAC;IAEM,KAAK,CAAC,yBAAyB;QACpC,OAAO,UAAU,CAAC,yBAAyB,EAAE,CAAC;IAChD,CAAC;IACM,KAAK,CAAC,4BAA4B,CAAC,EAAgB,EAAE,MAAkC;QAC5F,UAAU,CAAC,4BAA4B,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IACM,KAAK,CAAC,qBAAqB,CAAC,QAAoB;QACrD,OAAO,mCAAgB,CAAC,qBAAqB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC9D,CAAC;IACM,KAAK,CAAC,oBAAoB,CAAC,KAAqB;QACrD,OAAO,mCAAgB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;IACM,KAAK,CAAC,iBAAiB,CAAC,OAAiC,EAAE,cAAuB,EAAE,gBAAyB;QAClH,MAAM,IAAI,GAAG;YACX,GAAG,OAAO;YACV,UAAU,EAAE,CAAC,EAAU,EAAE,EAAU,EAAE,EAAE,CAAC,UAAU,EAAE;SACrD,CAAC;QAEF,IAAI,cAAc,EAAE;YAClB,MAAM,QAAQ,GAAG,gBAAgB,aAAhB,gBAAgB,cAAhB,gBAAgB,GAAI,GAAG,CAAC,CAAC,+DAA+D;YACzG,IAAI,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ,CAAC;YACrC,IAAI,CAAC,UAAU,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBAClC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACvB,IAAI,MAAM,IAAI,KAAK,IAAI,GAAG,IAAI,QAAQ,EAAE;oBACtC,QAAQ,GAAG,GAAG,GAAG,QAAQ,CAAC;oBAC1B,iBAAO,CAAC,IAAI,CAAC,sBAAsB,OAAO,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;iBAC3E;gBACD,OAAO,UAAU,EAAE,CAAC;YACtB,CAAC,CAAC;SACH;QAED,MAAM,eAAe,GAAG,mCAAgB,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACjE,MAAM,UAAU,GAAG,GAAG,EAAE;YACtB,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpC,MAAM,GAAG,GAAG,6BAAS,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAClD,OAAO,CAAC,GAAG,IAAK,GAAG,CAAC,OAAe,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3D,CAAC,CAAC;QACF,OAAO,eAAe,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,8BAA8B,CAAC,QAAgB;QAC1D,MAAM,GAAG,GAAG,6BAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC7C,IAAI,GAAG;YACJ,GAAG,CAAC,OAAe,CAAC,KAAK,GAAG,CAAC,CAAC;QACjC,OAAO,GAAG,KAAK,SAAS,CAAC;IAC3B,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,QAAgB;QAChD,MAAM,mCAAgB,CAAC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC,CAAC;IAC3F,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,QAAqB;QACpD,OAAO,mCAAgB,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,SAAiB;QAC3C,OAAO,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,SAAiB,EAAE,QAAiB;QAC/D,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,OAAO,mCAAgB,CAAC,eAAe,EAAE,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,SAAiB,EAAE,GAAW;QAC7D,OAAO,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IAC5D,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,GAAW;QACpD,OAAO,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,GAAW,EAAE,KAAmB;QACzE,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,SAAiB,EAAE,GAAW;QACvD,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,SAAiB;QACxC,OAAO,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC;IACpD,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,SAAiB;QAC7C,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC;IAC/C,CAAC;CACF;AAYD;;;GAGG;AACH,MAAa,UAAU;IAGrB,gBAAwB,CAAC,CAAC,qCAAqC;IAO/D,0DAA0D;IACnD,MAAM,KAAK,mBAAmB;QACnC,IAAI,IAAI,CAAC,oBAAoB,KAAK,SAAS;YACzC,IAAI,CAAC,oBAAoB,GAAG,IAAA,WAAI,EAAC,uBAAU,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACvE,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAED,yEAAyE;IAClE,MAAM,CAAC,oBAAoB,CAAyC,UAAa,EAAE,GAAG,IAA2C;QACtI,OAAO,iBAAO,CAAC,IAAI,CAAC,6BAAe,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IAC5D,CAAC;IAGM,MAAM,KAAK,OAAO,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvD,MAAM,KAAK,eAAe,KAAK,OAAO,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACrE,kDAAkD;IAC3C,MAAM,KAAK,aAAa;QAC7B,OAAO,mCAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAoB;;QAC9C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,6BAA6B,CAAC,WAAW,CAAC,CAAC,MAAkC,EAAE,EAAE,CACpF,UAAU,CAAC,oBAAoB,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC,CAAC;YAChF,IAAI,CAAC,gBAAgB,GAAG,MAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,0CAAE,eAAe,mCAAI,UAAU,CAAC;SACxE;QAED,MAAM,iBAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,iBAAO,CAAC,OAAO,EAAG,yDAAyD;YAC7E,gBAAgB,CAAC,QAAQ,EAAE,CAAC;IAChC,CAAC;IAED,mEAAmE;IAC5D,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,6BAA6B,CAAC,KAAK,EAAE,CAAC;QAC3C,MAAM,iBAAO,CAAC,QAAQ,EAAE,CAAC;IAC3B,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,yBAAyB;;QACrC,OAAO,MAAA,IAAI,CAAC,aAAa,mCAAI,wCAA0B,CAAC,MAAM,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,4BAA4B,CAAC,YAA0B,EAAE,MAAkC;QACvG,IAAI,IAAI,CAAC,aAAa,KAAK,MAAM,EAAE;YACjC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC;YAC5B,IAAI,CAAC,6BAA6B,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;SACvD;IACH,CAAC;;AArEH,gCAsEC;AAjEC,qEAAqE;AAC9C,wCAA6B,GAAG,IAAI,sBAAO,EAAgD,CAAC;AAgBpG,mBAAQ,GAAG,KAAK,CAAC","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 NativeApp\r\n */\r\n\r\nimport { join } from \"path\";\r\nimport { AccessToken, assert, BeEvent, GuidString } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseProps, InternetConnectivityStatus, LocalBriefcaseProps, nativeAppChannel, NativeAppFunctions, NativeAppNotifications, nativeAppNotify,\r\n  OverriddenBy, RequestNewBriefcaseProps, StorageValue,\r\n} from \"@itwin/core-common\";\r\nimport { BriefcaseManager } from \"./BriefcaseManager\";\r\nimport { Downloads } from \"./CheckpointManager\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { IpcHandler, IpcHost, IpcHostOpts } from \"./IpcHost\";\r\nimport { NativeAppStorage } from \"./NativeAppStorage\";\r\n\r\n/**\r\n * Implementation of NativeAppFunctions\r\n */\r\nclass NativeAppHandler extends IpcHandler implements NativeAppFunctions {\r\n  public get channelName() { return nativeAppChannel; }\r\n\r\n  public async getAccessToken(): Promise<AccessToken | undefined> {\r\n    return IModelHost.authorizationClient?.getAccessToken();\r\n  }\r\n\r\n  public async checkInternetConnectivity(): Promise<InternetConnectivityStatus> {\r\n    return NativeHost.checkInternetConnectivity();\r\n  }\r\n  public async overrideInternetConnectivity(by: OverriddenBy, status: InternetConnectivityStatus): Promise<void> {\r\n    NativeHost.overrideInternetConnectivity(by, status);\r\n  }\r\n  public async acquireNewBriefcaseId(iModelId: GuidString): Promise<number> {\r\n    return BriefcaseManager.acquireNewBriefcaseId({ iModelId });\r\n  }\r\n  public async getBriefcaseFileName(props: BriefcaseProps): Promise<string> {\r\n    return BriefcaseManager.getFileName(props);\r\n  }\r\n  public async downloadBriefcase(request: RequestNewBriefcaseProps, reportProgress: boolean, progressInterval?: number): Promise<LocalBriefcaseProps> {\r\n    const args = {\r\n      ...request,\r\n      onProgress: (_a: number, _b: number) => checkAbort(),\r\n    };\r\n\r\n    if (reportProgress) {\r\n      const interval = progressInterval ?? 250; // by default, only send progress events every 250 milliseconds\r\n      let nextTime = Date.now() + interval;\r\n      args.onProgress = (loaded, total) => {\r\n        const now = Date.now();\r\n        if (loaded >= total || now >= nextTime) {\r\n          nextTime = now + interval;\r\n          IpcHost.send(`nativeApp.progress-${request.iModelId}`, { loaded, total });\r\n        }\r\n        return checkAbort();\r\n      };\r\n    }\r\n\r\n    const downloadPromise = BriefcaseManager.downloadBriefcase(args);\r\n    const checkAbort = () => {\r\n      assert(undefined !== args.fileName);\r\n      const job = Downloads.isInProgress(args.fileName);\r\n      return (job && (job.request as any).abort === 1) ? 1 : 0;\r\n    };\r\n    return downloadPromise;\r\n  }\r\n\r\n  public async requestCancelDownloadBriefcase(fileName: string): Promise<boolean> {\r\n    const job = Downloads.isInProgress(fileName);\r\n    if (job)\r\n      (job.request as any).abort = 1;\r\n    return job !== undefined;\r\n  }\r\n\r\n  public async deleteBriefcaseFiles(fileName: string): Promise<void> {\r\n    await BriefcaseManager.deleteBriefcaseFiles(fileName, await IModelHost.getAccessToken());\r\n  }\r\n\r\n  public async getCachedBriefcases(iModelId?: GuidString): Promise<LocalBriefcaseProps[]> {\r\n    return BriefcaseManager.getCachedBriefcases(iModelId);\r\n  }\r\n\r\n  public async storageMgrOpen(storageId: string): Promise<string> {\r\n    return NativeAppStorage.open(storageId).id;\r\n  }\r\n\r\n  public async storageMgrClose(storageId: string, deleteIt: boolean): Promise<void> {\r\n    NativeAppStorage.find(storageId).close(deleteIt);\r\n  }\r\n\r\n  public async storageMgrNames(): Promise<string[]> {\r\n    return NativeAppStorage.getStorageNames();\r\n  }\r\n\r\n  public async storageGetValueType(storageId: string, key: string): Promise<\"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined> {\r\n    return NativeAppStorage.find(storageId).getValueType(key);\r\n  }\r\n\r\n  public async storageGet(storageId: string, key: string): Promise<StorageValue | undefined> {\r\n    return NativeAppStorage.find(storageId).getData(key);\r\n  }\r\n\r\n  public async storageSet(storageId: string, key: string, value: StorageValue): Promise<void> {\r\n    NativeAppStorage.find(storageId).setData(key, value);\r\n  }\r\n\r\n  public async storageRemove(storageId: string, key: string): Promise<void> {\r\n    NativeAppStorage.find(storageId).removeData(key);\r\n  }\r\n\r\n  public async storageKeys(storageId: string): Promise<string[]> {\r\n    return NativeAppStorage.find(storageId).getKeys();\r\n  }\r\n\r\n  public async storageRemoveAll(storageId: string): Promise<void> {\r\n    NativeAppStorage.find(storageId).removeAll();\r\n  }\r\n}\r\n\r\n/** Options for [[NativeHost.startup]]\r\n * @public\r\n */\r\nexport interface NativeHostOpts extends IpcHostOpts {\r\n  nativeHost?: {\r\n    /** Application name. Used, for example, to name the settings file. If not supplied, defaults to \"iTwinApp\". */\r\n    applicationName?: string;\r\n  };\r\n}\r\n\r\n/**\r\n * Backend for desktop/mobile native applications\r\n * @public\r\n */\r\nexport class NativeHost {\r\n  private static _reachability?: InternetConnectivityStatus;\r\n  private static _applicationName: string;\r\n  private constructor() { } // no instances - static methods only\r\n\r\n  /** Event called when the internet connectivity changes, if known. */\r\n  public static readonly onInternetConnectivityChanged = new BeEvent<(status: InternetConnectivityStatus) => void>();\r\n\r\n  private static _appSettingsCacheDir?: string;\r\n\r\n  /** Get the local cache folder for application settings */\r\n  public static get appSettingsCacheDir(): string {\r\n    if (this._appSettingsCacheDir === undefined)\r\n      this._appSettingsCacheDir = join(IModelHost.cacheDir, \"appSettings\");\r\n    return this._appSettingsCacheDir;\r\n  }\r\n\r\n  /** Send a notification to the NativeApp connected to this NativeHost. */\r\n  public static notifyNativeFrontend<T extends keyof NativeAppNotifications>(methodName: T, ...args: Parameters<NativeAppNotifications[T]>) {\r\n    return IpcHost.send(nativeAppNotify, methodName, ...args);\r\n  }\r\n\r\n  private static _isValid = false;\r\n  public static get isValid(): boolean { return this._isValid; }\r\n  public static get applicationName() { return this._applicationName; }\r\n  /** Get the settings store for this NativeHost. */\r\n  public static get settingsStore() {\r\n    return NativeAppStorage.open(this.applicationName);\r\n  }\r\n\r\n  /**\r\n   * Start the backend of a native app.\r\n   * @note this method calls [[IpcHost.startup]] internally.\r\n   */\r\n  public static async startup(opt?: NativeHostOpts): Promise<void> {\r\n    if (!this.isValid) {\r\n      this._isValid = true;\r\n      this.onInternetConnectivityChanged.addListener((status: InternetConnectivityStatus) =>\r\n        NativeHost.notifyNativeFrontend(\"notifyInternetConnectivityChanged\", status));\r\n      this._applicationName = opt?.nativeHost?.applicationName ?? \"iTwinApp\";\r\n    }\r\n\r\n    await IpcHost.startup(opt);\r\n    if (IpcHost.isValid)  // for tests, we use NativeHost but don't have a frontend\r\n      NativeAppHandler.register();\r\n  }\r\n\r\n  /** Shutdown native app backend. Also calls [[IpcHost.shutdown]] */\r\n  public static async shutdown(): Promise<void> {\r\n    this._isValid = false;\r\n    this.onInternetConnectivityChanged.clear();\r\n    await IpcHost.shutdown();\r\n  }\r\n\r\n  /** get current value of internet connectivity */\r\n  public static checkInternetConnectivity(): InternetConnectivityStatus {\r\n    return this._reachability ?? InternetConnectivityStatus.Online;\r\n  }\r\n\r\n  /**\r\n   * Override internet connectivity state\r\n   * @param _overridenBy who overrode the value.\r\n   * @internal\r\n   */\r\n  public static overrideInternetConnectivity(_overridenBy: OverriddenBy, status: InternetConnectivityStatus): void {\r\n    if (this._reachability !== status) {\r\n      this._reachability = status;\r\n      this.onInternetConnectivityChanged.raiseEvent(status);\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"NativeHost.js","sourceRoot":"","sources":["../../src/NativeHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA4B;AAC5B,sDAA+E;AAC/E,oDAG4B;AAC5B,yDAA8E;AAC9E,2DAAkF;AAClF,6CAA0C;AAC1C,uCAAuF;AACvF,yDAAsD;AAEtD;;GAEG;AACH,MAAM,gBAAiB,SAAQ,oBAAU;IACvC,IAAW,WAAW,KAAK,OAAO,8BAAgB,CAAC,CAAC,CAAC;IAE9C,KAAK,CAAC,cAAc;;QACzB,OAAO,MAAA,uBAAU,CAAC,mBAAmB,0CAAE,cAAc,EAAE,CAAC;IAC1D,CAAC;IAEM,KAAK,CAAC,yBAAyB;QACpC,OAAO,UAAU,CAAC,yBAAyB,EAAE,CAAC;IAChD,CAAC;IACM,KAAK,CAAC,4BAA4B,CAAC,EAAgB,EAAE,MAAkC;QAC5F,UAAU,CAAC,4BAA4B,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IACM,KAAK,CAAC,qBAAqB,CAAC,QAAoB;QACrD,OAAO,mCAAgB,CAAC,qBAAqB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC9D,CAAC;IACM,KAAK,CAAC,oBAAoB,CAAC,KAAqB;QACrD,OAAO,mCAAgB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;IACM,KAAK,CAAC,iBAAiB,CAAC,OAAiC,EAAE,cAAuB,EAAE,gBAAyB;QAClH,MAAM,IAAI,GAA2B;YACnC,GAAG,OAAO;YACV,WAAW,EAAE,MAAM,IAAI,CAAC,cAAc,EAAE;YACxC,UAAU,EAAE,CAAC,EAAU,EAAE,EAAU,EAAE,EAAE,CAAC,UAAU,EAAE;SACrD,CAAC;QAEF,MAAM,UAAU,GAAG,GAAG,EAAE;YACtB,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpC,MAAM,GAAG,GAAG,6BAAS,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAClD,OAAO,CAAC,GAAG,IAAK,GAAG,CAAC,OAAe,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,kCAAc,CAAC,KAAK,CAAC,CAAC,CAAC,kCAAc,CAAC,QAAQ,CAAC;QACpG,CAAC,CAAC;QAEF,IAAI,cAAc,EAAE;YAClB,MAAM,gBAAgB,GAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBAC3D,iBAAO,CAAC,IAAI,CAAC,sBAAsB,OAAO,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC1E,OAAO,UAAU,EAAE,CAAC;YACtB,CAAC,CAAC;YACF,IAAI,CAAC,UAAU,GAAG,IAAA,kCAAwB,EAAC,gBAAgB,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;SAC5F;QAED,OAAO,mCAAgB,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IAEM,KAAK,CAAC,8BAA8B,CAAC,QAAgB;QAC1D,MAAM,GAAG,GAAG,6BAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC7C,IAAI,GAAG;YACJ,GAAG,CAAC,OAAe,CAAC,KAAK,GAAG,CAAC,CAAC;QACjC,OAAO,GAAG,KAAK,SAAS,CAAC;IAC3B,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,QAAgB;QAChD,MAAM,mCAAgB,CAAC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC,CAAC;IAC3F,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,QAAqB;QACpD,OAAO,mCAAgB,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,SAAiB;QAC3C,OAAO,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,SAAiB,EAAE,QAAiB;QAC/D,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,OAAO,mCAAgB,CAAC,eAAe,EAAE,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,SAAiB,EAAE,GAAW;QAC7D,OAAO,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IAC5D,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,GAAW;QACpD,OAAO,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,GAAW,EAAE,KAAmB;QACzE,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,SAAiB,EAAE,GAAW;QACvD,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,SAAiB;QACxC,OAAO,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC;IACpD,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,SAAiB;QAC7C,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC;IAC/C,CAAC;CACF;AAYD;;;GAGG;AACH,MAAa,UAAU;IAGrB,gBAAwB,CAAC,CAAC,qCAAqC;IAO/D,0DAA0D;IACnD,MAAM,KAAK,mBAAmB;QACnC,IAAI,IAAI,CAAC,oBAAoB,KAAK,SAAS;YACzC,IAAI,CAAC,oBAAoB,GAAG,IAAA,WAAI,EAAC,uBAAU,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACvE,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAED,yEAAyE;IAClE,MAAM,CAAC,oBAAoB,CAAyC,UAAa,EAAE,GAAG,IAA2C;QACtI,OAAO,iBAAO,CAAC,IAAI,CAAC,6BAAe,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IAC5D,CAAC;IAGM,MAAM,KAAK,OAAO,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvD,MAAM,KAAK,eAAe,KAAK,OAAO,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACrE,kDAAkD;IAC3C,MAAM,KAAK,aAAa;QAC7B,OAAO,mCAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAoB;;QAC9C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,6BAA6B,CAAC,WAAW,CAAC,CAAC,MAAkC,EAAE,EAAE,CACpF,UAAU,CAAC,oBAAoB,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC,CAAC;YAChF,IAAI,CAAC,gBAAgB,GAAG,MAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,0CAAE,eAAe,mCAAI,UAAU,CAAC;SACxE;QAED,MAAM,iBAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,iBAAO,CAAC,OAAO,EAAG,yDAAyD;YAC7E,gBAAgB,CAAC,QAAQ,EAAE,CAAC;IAChC,CAAC;IAED,mEAAmE;IAC5D,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,6BAA6B,CAAC,KAAK,EAAE,CAAC;QAC3C,MAAM,iBAAO,CAAC,QAAQ,EAAE,CAAC;IAC3B,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,yBAAyB;;QACrC,OAAO,MAAA,IAAI,CAAC,aAAa,mCAAI,wCAA0B,CAAC,MAAM,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,4BAA4B,CAAC,YAA0B,EAAE,MAAkC;QACvG,IAAI,IAAI,CAAC,aAAa,KAAK,MAAM,EAAE;YACjC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC;YAC5B,IAAI,CAAC,6BAA6B,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;SACvD;IACH,CAAC;;AArEH,gCAsEC;AAjEC,qEAAqE;AAC9C,wCAA6B,GAAG,IAAI,sBAAO,EAAgD,CAAC;AAgBpG,mBAAQ,GAAG,KAAK,CAAC","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 NativeApp\r\n */\r\n\r\nimport { join } from \"path\";\r\nimport { AccessToken, assert, BeEvent, GuidString } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseProps, InternetConnectivityStatus, LocalBriefcaseProps, nativeAppChannel, NativeAppFunctions, NativeAppNotifications, nativeAppNotify,\r\n  OverriddenBy, RequestNewBriefcaseProps, StorageValue,\r\n} from \"@itwin/core-common\";\r\nimport { BriefcaseManager, RequestNewBriefcaseArg } from \"./BriefcaseManager\";\r\nimport { Downloads, ProgressFunction, ProgressStatus } from \"./CheckpointManager\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { IpcHandler, IpcHost, IpcHostOpts, throttleProgressCallback } from \"./IpcHost\";\r\nimport { NativeAppStorage } from \"./NativeAppStorage\";\r\n\r\n/**\r\n * Implementation of NativeAppFunctions\r\n */\r\nclass NativeAppHandler extends IpcHandler implements NativeAppFunctions {\r\n  public get channelName() { return nativeAppChannel; }\r\n\r\n  public async getAccessToken(): Promise<AccessToken | undefined> {\r\n    return IModelHost.authorizationClient?.getAccessToken();\r\n  }\r\n\r\n  public async checkInternetConnectivity(): Promise<InternetConnectivityStatus> {\r\n    return NativeHost.checkInternetConnectivity();\r\n  }\r\n  public async overrideInternetConnectivity(by: OverriddenBy, status: InternetConnectivityStatus): Promise<void> {\r\n    NativeHost.overrideInternetConnectivity(by, status);\r\n  }\r\n  public async acquireNewBriefcaseId(iModelId: GuidString): Promise<number> {\r\n    return BriefcaseManager.acquireNewBriefcaseId({ iModelId });\r\n  }\r\n  public async getBriefcaseFileName(props: BriefcaseProps): Promise<string> {\r\n    return BriefcaseManager.getFileName(props);\r\n  }\r\n  public async downloadBriefcase(request: RequestNewBriefcaseProps, reportProgress: boolean, progressInterval?: number): Promise<LocalBriefcaseProps> {\r\n    const args: RequestNewBriefcaseArg = {\r\n      ...request,\r\n      accessToken: await this.getAccessToken(),\r\n      onProgress: (_a: number, _b: number) => checkAbort(),\r\n    };\r\n\r\n    const checkAbort = () => {\r\n      assert(undefined !== args.fileName);\r\n      const job = Downloads.isInProgress(args.fileName);\r\n      return (job && (job.request as any).abort === 1) ? ProgressStatus.Abort : ProgressStatus.Continue;\r\n    };\r\n\r\n    if (reportProgress) {\r\n      const progressCallback: ProgressFunction = (loaded, total) => {\r\n        IpcHost.send(`nativeApp.progress-${request.iModelId}`, { loaded, total });\r\n        return checkAbort();\r\n      };\r\n      args.onProgress = throttleProgressCallback(progressCallback, checkAbort, progressInterval);\r\n    }\r\n\r\n    return BriefcaseManager.downloadBriefcase(args);\r\n  }\r\n\r\n  public async requestCancelDownloadBriefcase(fileName: string): Promise<boolean> {\r\n    const job = Downloads.isInProgress(fileName);\r\n    if (job)\r\n      (job.request as any).abort = 1;\r\n    return job !== undefined;\r\n  }\r\n\r\n  public async deleteBriefcaseFiles(fileName: string): Promise<void> {\r\n    await BriefcaseManager.deleteBriefcaseFiles(fileName, await IModelHost.getAccessToken());\r\n  }\r\n\r\n  public async getCachedBriefcases(iModelId?: GuidString): Promise<LocalBriefcaseProps[]> {\r\n    return BriefcaseManager.getCachedBriefcases(iModelId);\r\n  }\r\n\r\n  public async storageMgrOpen(storageId: string): Promise<string> {\r\n    return NativeAppStorage.open(storageId).id;\r\n  }\r\n\r\n  public async storageMgrClose(storageId: string, deleteIt: boolean): Promise<void> {\r\n    NativeAppStorage.find(storageId).close(deleteIt);\r\n  }\r\n\r\n  public async storageMgrNames(): Promise<string[]> {\r\n    return NativeAppStorage.getStorageNames();\r\n  }\r\n\r\n  public async storageGetValueType(storageId: string, key: string): Promise<\"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined> {\r\n    return NativeAppStorage.find(storageId).getValueType(key);\r\n  }\r\n\r\n  public async storageGet(storageId: string, key: string): Promise<StorageValue | undefined> {\r\n    return NativeAppStorage.find(storageId).getData(key);\r\n  }\r\n\r\n  public async storageSet(storageId: string, key: string, value: StorageValue): Promise<void> {\r\n    NativeAppStorage.find(storageId).setData(key, value);\r\n  }\r\n\r\n  public async storageRemove(storageId: string, key: string): Promise<void> {\r\n    NativeAppStorage.find(storageId).removeData(key);\r\n  }\r\n\r\n  public async storageKeys(storageId: string): Promise<string[]> {\r\n    return NativeAppStorage.find(storageId).getKeys();\r\n  }\r\n\r\n  public async storageRemoveAll(storageId: string): Promise<void> {\r\n    NativeAppStorage.find(storageId).removeAll();\r\n  }\r\n}\r\n\r\n/** Options for [[NativeHost.startup]]\r\n * @public\r\n */\r\nexport interface NativeHostOpts extends IpcHostOpts {\r\n  nativeHost?: {\r\n    /** Application name. Used, for example, to name the settings file. If not supplied, defaults to \"iTwinApp\". */\r\n    applicationName?: string;\r\n  };\r\n}\r\n\r\n/**\r\n * Backend for desktop/mobile native applications\r\n * @public\r\n */\r\nexport class NativeHost {\r\n  private static _reachability?: InternetConnectivityStatus;\r\n  private static _applicationName: string;\r\n  private constructor() { } // no instances - static methods only\r\n\r\n  /** Event called when the internet connectivity changes, if known. */\r\n  public static readonly onInternetConnectivityChanged = new BeEvent<(status: InternetConnectivityStatus) => void>();\r\n\r\n  private static _appSettingsCacheDir?: string;\r\n\r\n  /** Get the local cache folder for application settings */\r\n  public static get appSettingsCacheDir(): string {\r\n    if (this._appSettingsCacheDir === undefined)\r\n      this._appSettingsCacheDir = join(IModelHost.cacheDir, \"appSettings\");\r\n    return this._appSettingsCacheDir;\r\n  }\r\n\r\n  /** Send a notification to the NativeApp connected to this NativeHost. */\r\n  public static notifyNativeFrontend<T extends keyof NativeAppNotifications>(methodName: T, ...args: Parameters<NativeAppNotifications[T]>) {\r\n    return IpcHost.send(nativeAppNotify, methodName, ...args);\r\n  }\r\n\r\n  private static _isValid = false;\r\n  public static get isValid(): boolean { return this._isValid; }\r\n  public static get applicationName() { return this._applicationName; }\r\n  /** Get the settings store for this NativeHost. */\r\n  public static get settingsStore() {\r\n    return NativeAppStorage.open(this.applicationName);\r\n  }\r\n\r\n  /**\r\n   * Start the backend of a native app.\r\n   * @note this method calls [[IpcHost.startup]] internally.\r\n   */\r\n  public static async startup(opt?: NativeHostOpts): Promise<void> {\r\n    if (!this.isValid) {\r\n      this._isValid = true;\r\n      this.onInternetConnectivityChanged.addListener((status: InternetConnectivityStatus) =>\r\n        NativeHost.notifyNativeFrontend(\"notifyInternetConnectivityChanged\", status));\r\n      this._applicationName = opt?.nativeHost?.applicationName ?? \"iTwinApp\";\r\n    }\r\n\r\n    await IpcHost.startup(opt);\r\n    if (IpcHost.isValid)  // for tests, we use NativeHost but don't have a frontend\r\n      NativeAppHandler.register();\r\n  }\r\n\r\n  /** Shutdown native app backend. Also calls [[IpcHost.shutdown]] */\r\n  public static async shutdown(): Promise<void> {\r\n    this._isValid = false;\r\n    this.onInternetConnectivityChanged.clear();\r\n    await IpcHost.shutdown();\r\n  }\r\n\r\n  /** get current value of internet connectivity */\r\n  public static checkInternetConnectivity(): InternetConnectivityStatus {\r\n    return this._reachability ?? InternetConnectivityStatus.Online;\r\n  }\r\n\r\n  /**\r\n   * Override internet connectivity state\r\n   * @param _overridenBy who overrode the value.\r\n   * @internal\r\n   */\r\n  public static overrideInternetConnectivity(_overridenBy: OverriddenBy, status: InternetConnectivityStatus): void {\r\n    if (this._reachability !== status) {\r\n      this._reachability = status;\r\n      this.onInternetConnectivityChanged.raiseEvent(status);\r\n    }\r\n  }\r\n}\r\n"]}