@itwin/core-backend 5.0.0-dev.11 → 5.0.0-dev.111

package/lib/esm/IpcHost.js

@@ -0,0 +1,292 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module NativeApp
+ */
+import { assert, BentleyError, IModelStatus, JsonUtils, Logger, LogLevel } from "@itwin/core-bentley";
+import { getPullChangesIpcChannel, IModelError, IModelNotFoundResponse, ipcAppChannels, iTwinChannel, } from "@itwin/core-common";
+import { ProgressStatus } from "./CheckpointManager";
+import { BriefcaseDb, IModelDb, SnapshotDb, StandaloneDb } from "./IModelDb";
+import { IModelHost } from "./IModelHost";
+import { IModelNative } from "./internal/NativePlatform";
+import { _nativeDb } from "./internal/Symbols";
+import { cancelTileContentRequests } from "./rpc-impl/IModelTileRpcImpl";
+/**
+ * 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.
+ * @public
+ */
+export class IpcHost {
+    static noStack = false;
+    static _ipc;
+    /** Get the implementation of the [IpcSocketBackend]($common) interface. */
+    static get ipc() { return this._ipc; } // eslint-disable-line @typescript-eslint/no-non-null-assertion
+    /** Determine whether Ipc is available for this backend. This will only be true if [[startup]] has been called on this class. */
+    static get isValid() { return undefined !== this._ipc; }
+    /**
+     * Send a message to the frontend over an Ipc channel.
+     * @param channel the name of the channel matching the name registered with [[IpcApp.addListener]].
+     * @param data The content of the message.
+     */
+    static send(channel, ...data) {
+        this.ipc.send(iTwinChannel(channel), ...data);
+    }
+    /**
+     * Establish a handler for an Ipc channel to receive [[Frontend.invoke]] calls
+     * @param channel The name of the channel for this handler.
+     * @param handler A function that supplies the implementation for `channel`
+     * @note returns A function to call to remove the handler.
+     */
+    static handle(channel, handler) {
+        return this.ipc.handle(iTwinChannel(channel), handler);
+    }
+    /**
+     * Establish a handler to receive messages sent via [[IpcApp.send]].
+     * @param channel The name of the channel for the messages.
+     * @param listener A function called when messages are sent over `channel`
+     * @note returns A function to call to remove the listener.
+     */
+    static addListener(channel, listener) {
+        return this.ipc.addListener(iTwinChannel(channel), listener);
+    }
+    /**
+     * Remove a previously registered listener
+     * @param channel The name of the channel for the listener previously registered with [[addListener]]
+     * @param listener The function passed to [[addListener]]
+     */
+    static removeListener(channel, listener) {
+        this.ipc.removeListener(iTwinChannel(channel), listener);
+    }
+    static notify(channel, briefcase, methodName, ...args) {
+        if (this.isValid)
+            return this.send(`${channel}/${briefcase.key}`, methodName, ...args);
+    }
+    /** @internal */
+    static notifyIpcFrontend(methodName, ...args) {
+        return IpcHost.send(ipcAppChannels.appNotify, methodName, ...args);
+    }
+    /** @internal */
+    static notifyTxns(briefcase, methodName, ...args) {
+        this.notify(ipcAppChannels.txns, briefcase, methodName, ...args);
+    }
+    /** @internal */
+    static notifyEditingScope(briefcase, methodName, ...args) {
+        this.notify(ipcAppChannels.editingScope, briefcase, methodName, ...args);
+    }
+    /**
+     * Start the backend of an Ipc app.
+     * @param opt
+     * @note this method calls [[IModelHost.startup]] internally.
+     */
+    static async startup(opt) {
+        this._ipc = opt?.ipcHost?.socket;
+        if (opt?.ipcHost?.exceptions?.noStack)
+            this.noStack = true;
+        if (this.isValid) { // for tests, we use IpcHost but don't have a frontend
+            IpcAppHandler.register();
+        }
+        await IModelHost.startup(opt?.iModelHost);
+    }
+    /** Shutdown IpcHost backend. Also calls [[IModelHost.shutdown]] */
+    static async shutdown() {
+        this._ipc = undefined;
+        await IModelHost.shutdown();
+    }
+}
+/**
+ * Base class for all implementations of an Ipc interface.
+ *
+ * Create a subclass to implement your Ipc interface. Your class should be declared like this:
+ * ```ts
+ * class MyHandler extends IpcHandler implements MyInterface
+ * ```
+ * to ensure all methods and signatures are correct.
+ *
+ * Then, call `MyClass.register` at startup to connect your class to your channel.
+ * @public
+ */
+export class IpcHandler {
+    /**
+     * Register this class as the handler for methods on its channel. This static method creates a new instance
+     * that becomes the handler and is `this` when its methods are called.
+     * @returns A function that can be called to remove the handler.
+     * @note this method should only be called once per channel. If it is called multiple times, subsequent calls replace the previous ones.
+     */
+    static register() {
+        const impl = new this(); // create an instance of subclass. "as any" is necessary because base class is abstract
+        const prohibitedFunctions = Object.getOwnPropertyNames(Object.getPrototypeOf({}));
+        return IpcHost.handle(impl.channelName, async (_evt, funcName, ...args) => {
+            try {
+                if (prohibitedFunctions.includes(funcName))
+                    throw new Error(`Method "${funcName}" not available for channel: ${impl.channelName}`);
+                const func = impl[funcName];
+                if (typeof func !== "function")
+                    throw new IModelError(IModelStatus.FunctionNotFound, `Method "${impl.constructor.name}.${funcName}" not found on IpcHandler registered for channel: ${impl.channelName}`);
+                return { result: await func.call(impl, ...args) };
+            }
+            catch (err) {
+                if (!JsonUtils.isObject(err)) // if the exception isn't an object, just forward it
+                    return { error: err };
+                const ret = { error: { ...err } };
+                ret.error.message = err.message; // NB: .message, and .stack members of Error are not enumerable, so spread operator above does not copy them.
+                if (!IpcHost.noStack)
+                    ret.error.stack = err.stack;
+                if (err instanceof BentleyError) {
+                    ret.error.iTwinErrorId = err.iTwinErrorId;
+                    if (err.hasMetaData)
+                        ret.error.loggingMetadata = err.loggingMetadata;
+                    delete ret.error._metaData;
+                }
+                return ret;
+            }
+        });
+    }
+}
+/**
+ * Implementation  of IpcAppFunctions
+ */
+class IpcAppHandler extends IpcHandler {
+    get channelName() { return ipcAppChannels.functions; }
+    _iModelKeyToPullStatus = new Map();
+    async log(_timestamp, level, category, message, metaData) {
+        switch (level) {
+            case LogLevel.Error:
+                Logger.logError(category, message, metaData);
+                break;
+            case LogLevel.Info:
+                Logger.logInfo(category, message, metaData);
+                break;
+            case LogLevel.Trace:
+                Logger.logTrace(category, message, metaData);
+                break;
+            case LogLevel.Warning:
+                Logger.logWarning(category, message, metaData);
+                break;
+        }
+    }
+    async cancelTileContentRequests(tokenProps, contentIds) {
+        return cancelTileContentRequests(tokenProps, contentIds);
+    }
+    async cancelElementGraphicsRequests(key, requestIds) {
+        return IModelDb.findByKey(key)[_nativeDb].cancelElementGraphicsRequests(requestIds);
+    }
+    async openBriefcase(args) {
+        const db = await BriefcaseDb.open(args);
+        return db.toJSON();
+    }
+    async openCheckpoint(checkpoint) {
+        return (await SnapshotDb.openCheckpoint(checkpoint)).getConnectionProps();
+    }
+    async openStandalone(filePath, openMode, opts) {
+        return StandaloneDb.openFile(filePath, openMode, opts).getConnectionProps();
+    }
+    async openSnapshot(filePath, opts) {
+        let resolvedFileName = filePath;
+        if (IModelHost.snapshotFileNameResolver) { // eslint-disable-line @typescript-eslint/no-deprecated
+            resolvedFileName = IModelHost.snapshotFileNameResolver.tryResolveFileName(filePath); // eslint-disable-line @typescript-eslint/no-deprecated
+            if (!resolvedFileName)
+                throw new IModelNotFoundResponse(); // eslint-disable-line @typescript-eslint/only-throw-error
+        }
+        return SnapshotDb.openFile(resolvedFileName, opts).getConnectionProps();
+    }
+    async closeIModel(key) {
+        IModelDb.findByKey(key).close();
+    }
+    async saveChanges(key, description) {
+        IModelDb.findByKey(key).saveChanges(description);
+    }
+    async abandonChanges(key) {
+        IModelDb.findByKey(key).abandonChanges();
+    }
+    async hasPendingTxns(key) {
+        return IModelDb.findByKey(key)[_nativeDb].hasPendingTxns();
+    }
+    async isUndoPossible(key) {
+        return IModelDb.findByKey(key)[_nativeDb].isUndoPossible();
+    }
+    async isRedoPossible(key) {
+        return IModelDb.findByKey(key)[_nativeDb].isRedoPossible();
+    }
+    async getUndoString(key) {
+        return IModelDb.findByKey(key)[_nativeDb].getUndoString();
+    }
+    async getRedoString(key) {
+        return IModelDb.findByKey(key)[_nativeDb].getRedoString();
+    }
+    async pullChanges(key, toIndex, options) {
+        const iModelDb = BriefcaseDb.findByKey(key);
+        this._iModelKeyToPullStatus.set(key, ProgressStatus.Continue);
+        const checkAbort = () => this._iModelKeyToPullStatus.get(key) ?? ProgressStatus.Continue;
+        let onProgress;
+        if (options?.reportProgress) {
+            const progressCallback = (loaded, total) => {
+                IpcHost.send(getPullChangesIpcChannel(iModelDb.iModelId), { loaded, total });
+                return checkAbort();
+            };
+            onProgress = throttleProgressCallback(progressCallback, checkAbort, options?.progressInterval);
+        }
+        else if (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, ProgressStatus.Abort);
+    }
+    async pushChanges(key, description) {
+        const iModelDb = BriefcaseDb.findByKey(key);
+        await iModelDb.pushChanges({ description });
+        return iModelDb.changeset;
+    }
+    async toggleGraphicalEditingScope(key, startSession) {
+        const val = IModelDb.findByKey(key)[_nativeDb].setGeometricModelTrackingEnabled(startSession);
+        if (val.error)
+            throw new IModelError(val.error.status, "Failed to toggle graphical editing scope");
+        assert(undefined !== val.result);
+        return val.result;
+    }
+    async isGraphicalEditingSupported(key) {
+        return IModelDb.findByKey(key)[_nativeDb].isGeometricModelTrackingSupported();
+    }
+    async reverseTxns(key, numOperations) {
+        return IModelDb.findByKey(key)[_nativeDb].reverseTxns(numOperations);
+    }
+    async reverseAllTxn(key) {
+        return IModelDb.findByKey(key)[_nativeDb].reverseAll();
+    }
+    async reinstateTxn(key) {
+        return IModelDb.findByKey(key)[_nativeDb].reinstateTxn();
+    }
+    async restartTxnSession(key) {
+        return IModelDb.findByKey(key)[_nativeDb].restartTxnSession();
+    }
+    async queryConcurrency(pool) {
+        return IModelNative.platform.queryConcurrency(pool);
+    }
+}
+/**
+ * Prevents progress callback being called more frequently when provided interval.
+ * @internal
+ */
+export function throttleProgressCallback(func, checkAbort, progressInterval) {
+    const interval = 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;
+}
+//# sourceMappingURL=IpcHost.js.map

package/lib/esm/IpcHost.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IpcHost.js","sourceRoot":"","sources":["../../src/IpcHost.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAY,MAAM,qBAAqB,CAAC;AAChH,OAAO,EAC2D,wBAAwB,EAAyB,WAAW,EAAE,sBAAsB,EACpJ,cAAc,EAAwF,YAAY,GAEnH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAoB,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC7E,OAAO,EAAE,UAAU,EAAqB,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AAmBzE;;;;GAIG;AACH,MAAM,OAAO,OAAO;IACX,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC;IACtB,MAAM,CAAC,IAAI,CAA+B;IAClD,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,YAAY,CAAC,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,YAAY,CAAC,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,YAAY,CAAC,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,YAAY,CAAC,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,cAAc,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IACrE,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,UAAU,CAAmC,SAAqC,EAAE,UAAa,EAAE,GAAG,IAAqC;QACvJ,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IACnE,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,kBAAkB,CAA4C,SAAqC,EAAE,UAAa,EAAE,GAAG,IAA8C;QACjL,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAiB;QAC3C,IAAI,CAAC,IAAI,GAAG,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC;QACjC,IAAI,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO;YACnC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QAEtB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,sDAAsD;YACxE,aAAa,CAAC,QAAQ,EAAE,CAAC;QAC3B,CAAC;QAED,MAAM,UAAU,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,mEAAmE;IAC5D,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,MAAM,UAAU,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;;AAGH;;;;;;;;;;;GAWG;AACH,MAAM,OAAgB,UAAU;IAU9B;;;;;OAKG;IACI,MAAM,CAAC,QAAQ;QACpB,MAAM,IAAI,GAAG,IAAK,IAAY,EAAgB,CAAC,CAAC,uFAAuF;QACvI,MAAM,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;QAElF,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,IAAW,EAAE,QAAgB,EAAE,GAAG,IAAW,EAA4B,EAAE;YACxH,IAAI,CAAC;gBACH,IAAI,mBAAmB,CAAC,QAAQ,CAAC,QAAQ,CAAC;oBACxC,MAAM,IAAI,KAAK,CAAC,WAAW,QAAQ,gCAAgC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;gBAEzF,MAAM,IAAI,GAAI,IAAY,CAAC,QAAQ,CAAC,CAAC;gBACrC,IAAI,OAAO,IAAI,KAAK,UAAU;oBAC5B,MAAM,IAAI,WAAW,CAAC,YAAY,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;YACpD,CAAC;YAAC,OAAO,GAAY,EAAE,CAAC;gBAEtB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,oDAAoD;oBAChF,OAAO,EAAE,KAAK,EAAE,GAAU,EAAE,CAAC;gBAE/B,MAAM,GAAG,GAAG,EAAE,KAAK,EAAE,EAAE,GAAG,GAAG,EAAE,EAAE,CAAC;gBAClC,GAAG,CAAC,KAAK,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,6GAA6G;gBAC9I,IAAI,CAAC,OAAO,CAAC,OAAO;oBAClB,GAAG,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;gBAE9B,IAAI,GAAG,YAAY,YAAY,EAAE,CAAC;oBAChC,GAAG,CAAC,KAAK,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC;oBAC1C,IAAI,GAAG,CAAC,WAAW;wBACjB,GAAG,CAAC,KAAK,CAAC,eAAe,GAAG,GAAG,CAAC,eAAe,CAAC;oBAClD,OAAO,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC;gBAC7B,CAAC;gBACD,OAAO,GAAG,CAAC;YACb,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED;;GAEG;AACH,MAAM,aAAc,SAAQ,UAAU;IACpC,IAAW,WAAW,KAAK,OAAO,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC;IAErD,sBAAsB,GAAG,IAAI,GAAG,EAA0B,CAAC;IAE5D,KAAK,CAAC,GAAG,CAAC,UAAkB,EAAE,KAAe,EAAE,QAAgB,EAAE,OAAe,EAAE,QAAc;QACrG,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,QAAQ,CAAC,KAAK;gBACjB,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC7C,MAAM;YACR,KAAK,QAAQ,CAAC,IAAI;gBAChB,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC5C,MAAM;YACR,KAAK,QAAQ,CAAC,KAAK;gBACjB,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC7C,MAAM;YACR,KAAK,QAAQ,CAAC,OAAO;gBACnB,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC/C,MAAM;QACV,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,UAA0B,EAAE,UAAgC;QACjG,OAAO,yBAAyB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC3D,CAAC;IACM,KAAK,CAAC,6BAA6B,CAAC,GAAW,EAAE,UAAoB;QAC1E,OAAO,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,6BAA6B,CAAC,UAAU,CAAC,CAAC;IACtF,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,IAAwB;QACjD,MAAM,EAAE,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;IACrB,CAAC;IACM,KAAK,CAAC,cAAc,CAAC,UAA8B;QACxD,OAAO,CAAC,MAAM,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC5E,CAAC;IACM,KAAK,CAAC,cAAc,CAAC,QAAgB,EAAE,QAAkB,EAAE,IAA4B;QAC5F,OAAO,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC9E,CAAC;IACM,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,IAA0B;QACpE,IAAI,gBAAgB,GAAuB,QAAQ,CAAC;QACpD,IAAI,UAAU,CAAC,wBAAwB,EAAE,CAAC,CAAC,uDAAuD;YAChG,gBAAgB,GAAG,UAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,uDAAuD;YAC5I,IAAI,CAAC,gBAAgB;gBACnB,MAAM,IAAI,sBAAsB,EAAE,CAAC,CAAC,0DAA0D;QAClG,CAAC;QACD,OAAO,UAAU,CAAC,QAAQ,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC1E,CAAC;IACM,KAAK,CAAC,WAAW,CAAC,GAAW;QAClC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IACM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,WAAoB;QACxD,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IACM,KAAK,CAAC,cAAc,CAAC,GAAW;QACrC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,CAAC;IAC3C,CAAC;IACM,KAAK,CAAC,cAAc,CAAC,GAAW;QACrC,OAAO,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,cAAc,EAAE,CAAC;IAC7D,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,GAAW;QACrC,OAAO,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,cAAc,EAAE,CAAC;IAC7D,CAAC;IACM,KAAK,CAAC,cAAc,CAAC,GAAW;QACrC,OAAO,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,cAAc,EAAE,CAAC;IAC7D,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,GAAW;QACpC,OAAO,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,aAAa,EAAE,CAAC;IAC5D,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,GAAW;QACpC,OAAO,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,aAAa,EAAE,CAAC;IAC5D,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,OAAwB,EAAE,OAA4B;QAC1F,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAE5C,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC9D,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,cAAc,CAAC,QAAQ,CAAC;QAEzF,IAAI,UAAwC,CAAC;QAC7C,IAAI,OAAO,EAAE,cAAc,EAAE,CAAC;YAC5B,MAAM,gBAAgB,GAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBAC3D,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,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,EAAE,gBAAgB,CAAC,CAAC;QACjG,CAAC;aAAM,IAAI,OAAO,EAAE,kBAAkB,EAAE,CAAC;YACvC,UAAU,GAAG,UAAU,CAAC;QAC1B,CAAC;QAED,IAAI,CAAC;YACH,MAAM,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;QACtD,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1C,CAAC;QAED,OAAO,QAAQ,CAAC,SAAgC,CAAC;IACnD,CAAC;IACM,KAAK,CAAC,wBAAwB,CAAC,GAAW;QAC/C,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC;IAC7D,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,WAAmB;QACvD,MAAM,QAAQ,GAAG,WAAW,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,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,gCAAgC,CAAC,YAAY,CAAC,CAAC;QAChJ,IAAI,GAAG,CAAC,KAAK;YACX,MAAM,IAAI,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,0CAA0C,CAAC,CAAC;QACtF,MAAM,CAAC,SAAS,KAAK,GAAG,CAAC,MAAM,CAAC,CAAC;QACjC,OAAO,GAAG,CAAC,MAAM,CAAC;IACpB,CAAC;IACM,KAAK,CAAC,2BAA2B,CAAC,GAAW;QAClD,OAAO,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,iCAAiC,EAAE,CAAC;IAChF,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,aAAqB;QACzD,OAAO,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IACvE,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,GAAW;QACpC,OAAO,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,CAAC;IACzD,CAAC;IACM,KAAK,CAAC,YAAY,CAAC,GAAW;QACnC,OAAO,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,CAAC;IAC3D,CAAC;IACM,KAAK,CAAC,iBAAiB,CAAC,GAAW;QACxC,OAAO,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,IAAkB;QAC9C,OAAO,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CAAC,IAAsB,EAAE,UAAgC,EAAE,gBAAyB;IAC1H,MAAM,QAAQ,GAAG,gBAAgB,IAAI,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,CAAC;YACvC,QAAQ,GAAG,GAAG,GAAG,QAAQ,CAAC;YAC1B,OAAO,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,UAAU,EAAE,CAAC;IACtB,CAAC,CAAC;IAEF,OAAO,gBAAgB,CAAC;AAC1B,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module NativeApp\n */\n\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\nimport { assert, BentleyError, IModelStatus, JsonUtils, Logger, LogLevel, OpenMode } from \"@itwin/core-bentley\";\nimport {\n  ChangesetIndex, ChangesetIndexAndId, EditingScopeNotifications, getPullChangesIpcChannel, IModelConnectionProps, IModelError, IModelNotFoundResponse, IModelRpcProps,\n  ipcAppChannels, IpcAppFunctions, IpcAppNotifications, IpcInvokeReturn, IpcListener, IpcSocketBackend, iTwinChannel,\n  OpenBriefcaseProps, OpenCheckpointArgs, PullChangesOptions, RemoveFunction, SnapshotOpenOptions, StandaloneOpenOptions, TileTreeContentIds, TxnNotifications,\n} from \"@itwin/core-common\";\nimport { ProgressFunction, ProgressStatus } from \"./CheckpointManager\";\nimport { BriefcaseDb, IModelDb, SnapshotDb, StandaloneDb } from \"./IModelDb\";\nimport { IModelHost, IModelHostOptions } from \"./IModelHost\";\nimport { IModelNative } from \"./internal/NativePlatform\";\nimport { _nativeDb } from \"./internal/Symbols\";\nimport { cancelTileContentRequests } from \"./rpc-impl/IModelTileRpcImpl\";\n\n/**\n  * Options for [[IpcHost.startup]]\n  * @public\n  */\nexport interface IpcHostOpts {\n  iModelHost?: IModelHostOptions;\n  ipcHost?: {\n    /** The Ipc socket to use for communications with frontend. Allows undefined only for headless tests. */\n    socket?: IpcSocketBackend;\n\n    /** don't send stack information on exceptions */\n    exceptions?: {\n      noStack?: boolean;\n    };\n  };\n}\n\n/**\n * Used by applications that have a dedicated backend. IpcHosts may send messages to their corresponding IpcApp.\n * @note if either end terminates, the other must too.\n * @public\n */\nexport class IpcHost {\n  public static noStack = false;\n  private static _ipc: IpcSocketBackend | undefined;\n  /** Get the implementation of the [IpcSocketBackend]($common) interface. */\n  private static get ipc(): IpcSocketBackend { return this._ipc!; } // eslint-disable-line @typescript-eslint/no-non-null-assertion\n  /** Determine whether Ipc is available for this backend. This will only be true if [[startup]] has been called on this class. */\n  public static get isValid(): boolean { return undefined !== this._ipc; }\n\n  /**\n   * Send a message to the frontend over an Ipc channel.\n   * @param channel the name of the channel matching the name registered with [[IpcApp.addListener]].\n   * @param data The content of the message.\n   */\n  public static send(channel: string, ...data: any[]): void {\n    this.ipc.send(iTwinChannel(channel), ...data);\n  }\n\n  /**\n   * Establish a handler for an Ipc channel to receive [[Frontend.invoke]] calls\n   * @param channel The name of the channel for this handler.\n   * @param handler A function that supplies the implementation for `channel`\n   * @note returns A function to call to remove the handler.\n   */\n  public static handle(channel: string, handler: (...args: any[]) => Promise<any>): RemoveFunction {\n    return this.ipc.handle(iTwinChannel(channel), handler);\n  }\n  /**\n   * Establish a handler to receive messages sent via [[IpcApp.send]].\n   * @param channel The name of the channel for the messages.\n   * @param listener A function called when messages are sent over `channel`\n   * @note returns A function to call to remove the listener.\n   */\n  public static addListener(channel: string, listener: IpcListener): RemoveFunction {\n    return this.ipc.addListener(iTwinChannel(channel), listener);\n  }\n  /**\n   * Remove a previously registered listener\n   * @param channel The name of the channel for the listener previously registered with [[addListener]]\n   * @param listener The function passed to [[addListener]]\n   */\n  public static removeListener(channel: string, listener: IpcListener): void {\n    this.ipc.removeListener(iTwinChannel(channel), listener);\n  }\n\n  private static notify(channel: string, briefcase: BriefcaseDb | StandaloneDb, methodName: string, ...args: any[]) {\n    if (this.isValid)\n      return this.send(`${channel}/${briefcase.key}`, methodName, ...args);\n  }\n\n  /** @internal */\n  public static notifyIpcFrontend<T extends keyof IpcAppNotifications>(methodName: T, ...args: Parameters<IpcAppNotifications[T]>) {\n    return IpcHost.send(ipcAppChannels.appNotify, methodName, ...args);\n  }\n\n  /** @internal */\n  public static notifyTxns<T extends keyof TxnNotifications>(briefcase: BriefcaseDb | StandaloneDb, methodName: T, ...args: Parameters<TxnNotifications[T]>) {\n    this.notify(ipcAppChannels.txns, briefcase, methodName, ...args);\n  }\n\n  /** @internal */\n  public static notifyEditingScope<T extends keyof EditingScopeNotifications>(briefcase: BriefcaseDb | StandaloneDb, methodName: T, ...args: Parameters<EditingScopeNotifications[T]>) {\n    this.notify(ipcAppChannels.editingScope, briefcase, methodName, ...args);\n  }\n\n  /**\n   * Start the backend of an Ipc app.\n   * @param opt\n   * @note this method calls [[IModelHost.startup]] internally.\n   */\n  public static async startup(opt?: IpcHostOpts): Promise<void> {\n    this._ipc = opt?.ipcHost?.socket;\n    if (opt?.ipcHost?.exceptions?.noStack)\n      this.noStack = true;\n\n    if (this.isValid) { // for tests, we use IpcHost but don't have a frontend\n      IpcAppHandler.register();\n    }\n\n    await IModelHost.startup(opt?.iModelHost);\n  }\n\n  /** Shutdown IpcHost backend. Also calls [[IModelHost.shutdown]] */\n  public static async shutdown(): Promise<void> {\n    this._ipc = undefined;\n    await IModelHost.shutdown();\n  }\n}\n\n/**\n * Base class for all implementations of an Ipc interface.\n *\n * Create a subclass to implement your Ipc interface. Your class should be declared like this:\n * ```ts\n * class MyHandler extends IpcHandler implements MyInterface\n * ```\n * to ensure all methods and signatures are correct.\n *\n * Then, call `MyClass.register` at startup to connect your class to your channel.\n * @public\n */\nexport abstract class IpcHandler {\n  /**\n   * All subclasses *must* implement this method to specify their channel name.\n   *\n   * Channel names are the key that connects Handlers and senders. The channel name of IpcHandlers must exactly match the name used by senders.\n   * By convention, channel names should be prefixed by a *namespace* (e.g. `${appName}/`)\n   * unique enough to disambiguate them from channels for other apps that may be running in the same processes.\n   */\n  public abstract get channelName(): string;\n\n  /**\n   * Register this class as the handler for methods on its channel. This static method creates a new instance\n   * that becomes the handler and is `this` when its methods are called.\n   * @returns A function that can be called to remove the handler.\n   * @note this method should only be called once per channel. If it is called multiple times, subsequent calls replace the previous ones.\n   */\n  public static register(): RemoveFunction {\n    const impl = new (this as any)() as IpcHandler; // create an instance of subclass. \"as any\" is necessary because base class is abstract\n    const prohibitedFunctions = Object.getOwnPropertyNames(Object.getPrototypeOf({}));\n\n    return IpcHost.handle(impl.channelName, async (_evt: Event, funcName: string, ...args: any[]): Promise<IpcInvokeReturn> => {\n      try {\n        if (prohibitedFunctions.includes(funcName))\n          throw new Error(`Method \"${funcName}\" not available for channel: ${impl.channelName}`);\n\n        const func = (impl as any)[funcName];\n        if (typeof func !== \"function\")\n          throw new IModelError(IModelStatus.FunctionNotFound, `Method \"${impl.constructor.name}.${funcName}\" not found on IpcHandler registered for channel: ${impl.channelName}`);\n\n        return { result: await func.call(impl, ...args) };\n      } catch (err: unknown) {\n\n        if (!JsonUtils.isObject(err)) // if the exception isn't an object, just forward it\n          return { error: err as any };\n\n        const ret = { error: { ...err } };\n        ret.error.message = err.message; // NB: .message, and .stack members of Error are not enumerable, so spread operator above does not copy them.\n        if (!IpcHost.noStack)\n          ret.error.stack = err.stack;\n\n        if (err instanceof BentleyError) {\n          ret.error.iTwinErrorId = err.iTwinErrorId;\n          if (err.hasMetaData)\n            ret.error.loggingMetadata = err.loggingMetadata;\n          delete ret.error._metaData;\n        }\n        return ret;\n      }\n    });\n  }\n}\n\n/**\n * Implementation  of IpcAppFunctions\n */\nclass IpcAppHandler extends IpcHandler implements IpcAppFunctions {\n  public get channelName() { return ipcAppChannels.functions; }\n\n  private _iModelKeyToPullStatus = new Map<string, ProgressStatus>();\n\n  public async log(_timestamp: number, level: LogLevel, category: string, message: string, metaData?: any): Promise<void> {\n    switch (level) {\n      case LogLevel.Error:\n        Logger.logError(category, message, metaData);\n        break;\n      case LogLevel.Info:\n        Logger.logInfo(category, message, metaData);\n        break;\n      case LogLevel.Trace:\n        Logger.logTrace(category, message, metaData);\n        break;\n      case LogLevel.Warning:\n        Logger.logWarning(category, message, metaData);\n        break;\n    }\n  }\n\n  public async cancelTileContentRequests(tokenProps: IModelRpcProps, contentIds: TileTreeContentIds[]): Promise<void> {\n    return cancelTileContentRequests(tokenProps, contentIds);\n  }\n  public async cancelElementGraphicsRequests(key: string, requestIds: string[]): Promise<void> {\n    return IModelDb.findByKey(key)[_nativeDb].cancelElementGraphicsRequests(requestIds);\n  }\n  public async openBriefcase(args: OpenBriefcaseProps): Promise<IModelConnectionProps> {\n    const db = await BriefcaseDb.open(args);\n    return db.toJSON();\n  }\n  public async openCheckpoint(checkpoint: OpenCheckpointArgs): Promise<IModelConnectionProps> {\n    return (await SnapshotDb.openCheckpoint(checkpoint)).getConnectionProps();\n  }\n  public async openStandalone(filePath: string, openMode: OpenMode, opts?: StandaloneOpenOptions): Promise<IModelConnectionProps> {\n    return StandaloneDb.openFile(filePath, openMode, opts).getConnectionProps();\n  }\n  public async openSnapshot(filePath: string, opts?: SnapshotOpenOptions): Promise<IModelConnectionProps> {\n    let resolvedFileName: string | undefined = filePath;\n    if (IModelHost.snapshotFileNameResolver) { // eslint-disable-line @typescript-eslint/no-deprecated\n      resolvedFileName = IModelHost.snapshotFileNameResolver.tryResolveFileName(filePath); // eslint-disable-line @typescript-eslint/no-deprecated\n      if (!resolvedFileName)\n        throw new IModelNotFoundResponse(); // eslint-disable-line @typescript-eslint/only-throw-error\n    }\n    return SnapshotDb.openFile(resolvedFileName, opts).getConnectionProps();\n  }\n  public async closeIModel(key: string): Promise<void> {\n    IModelDb.findByKey(key).close();\n  }\n  public async saveChanges(key: string, description?: string): Promise<void> {\n    IModelDb.findByKey(key).saveChanges(description);\n  }\n  public async abandonChanges(key: string): Promise<void> {\n    IModelDb.findByKey(key).abandonChanges();\n  }\n  public async hasPendingTxns(key: string): Promise<boolean> {\n    return IModelDb.findByKey(key)[_nativeDb].hasPendingTxns();\n  }\n\n  public async isUndoPossible(key: string): Promise<boolean> {\n    return IModelDb.findByKey(key)[_nativeDb].isUndoPossible();\n  }\n  public async isRedoPossible(key: string): Promise<boolean> {\n    return IModelDb.findByKey(key)[_nativeDb].isRedoPossible();\n  }\n  public async getUndoString(key: string): Promise<string> {\n    return IModelDb.findByKey(key)[_nativeDb].getUndoString();\n  }\n  public async getRedoString(key: string): Promise<string> {\n    return IModelDb.findByKey(key)[_nativeDb].getRedoString();\n  }\n\n  public async pullChanges(key: string, toIndex?: ChangesetIndex, options?: PullChangesOptions): Promise<ChangesetIndexAndId> {\n    const iModelDb = BriefcaseDb.findByKey(key);\n\n    this._iModelKeyToPullStatus.set(key, ProgressStatus.Continue);\n    const checkAbort = () => this._iModelKeyToPullStatus.get(key) ?? ProgressStatus.Continue;\n\n    let onProgress: ProgressFunction | undefined;\n    if (options?.reportProgress) {\n      const progressCallback: ProgressFunction = (loaded, total) => {\n        IpcHost.send(getPullChangesIpcChannel(iModelDb.iModelId), { loaded, total });\n        return checkAbort();\n      };\n      onProgress = throttleProgressCallback(progressCallback, checkAbort, options?.progressInterval);\n    } else if (options?.enableCancellation) {\n      onProgress = checkAbort;\n    }\n\n    try {\n      await iModelDb.pullChanges({ toIndex, onProgress });\n    } finally {\n      this._iModelKeyToPullStatus.delete(key);\n    }\n\n    return iModelDb.changeset as ChangesetIndexAndId;\n  }\n  public async cancelPullChangesRequest(key: string): Promise<void> {\n    this._iModelKeyToPullStatus.set(key, ProgressStatus.Abort);\n  }\n\n  public async pushChanges(key: string, description: string): Promise<ChangesetIndexAndId> {\n    const iModelDb = BriefcaseDb.findByKey(key);\n    await iModelDb.pushChanges({ description });\n    return iModelDb.changeset as ChangesetIndexAndId;\n  }\n\n  public async toggleGraphicalEditingScope(key: string, startSession: boolean): Promise<boolean> {\n    const val: IModelJsNative.ErrorStatusOrResult<any, boolean> = IModelDb.findByKey(key)[_nativeDb].setGeometricModelTrackingEnabled(startSession);\n    if (val.error)\n      throw new IModelError(val.error.status, \"Failed to toggle graphical editing scope\");\n    assert(undefined !== val.result);\n    return val.result;\n  }\n  public async isGraphicalEditingSupported(key: string): Promise<boolean> {\n    return IModelDb.findByKey(key)[_nativeDb].isGeometricModelTrackingSupported();\n  }\n\n  public async reverseTxns(key: string, numOperations: number): Promise<IModelStatus> {\n    return IModelDb.findByKey(key)[_nativeDb].reverseTxns(numOperations);\n  }\n  public async reverseAllTxn(key: string): Promise<IModelStatus> {\n    return IModelDb.findByKey(key)[_nativeDb].reverseAll();\n  }\n  public async reinstateTxn(key: string): Promise<IModelStatus> {\n    return IModelDb.findByKey(key)[_nativeDb].reinstateTxn();\n  }\n  public async restartTxnSession(key: string): Promise<void> {\n    return IModelDb.findByKey(key)[_nativeDb].restartTxnSession();\n  }\n\n  public async queryConcurrency(pool: \"io\" | \"cpu\"): Promise<number> {\n    return IModelNative.platform.queryConcurrency(pool);\n  }\n}\n\n/**\n * Prevents progress callback being called more frequently when provided interval.\n * @internal\n */\nexport function throttleProgressCallback(func: ProgressFunction, checkAbort: () => ProgressStatus, progressInterval?: number): ProgressFunction {\n  const interval = progressInterval ?? 250; // by default, only send progress events every 250 milliseconds\n  let nextTime = Date.now() + interval;\n  const progressCallback: ProgressFunction = (loaded, total) => {\n    const now = Date.now();\n    if (loaded >= total || now >= nextTime) {\n      nextTime = now + interval;\n      return func(loaded, total);\n    }\n    return checkAbort();\n  };\n\n  return progressCallback;\n}\n"]}

package/lib/esm/LineStyle.d.ts

@@ -0,0 +1,312 @@
+/** @packageDocumentation
+ * @module ElementGeometry
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { LinePixels } from "@itwin/core-common";
+import { IModelDb } from "./IModelDb";
+/** A line style definition is a uniquely named pattern that repeats as it is displayed along a curve path. In the absence of a line style, curve display is limited to solid lines with a width in pixels.
+ * There are three varieties of line styles:
+ * - A style described by a stroke pattern (series of dashes and gaps) that may also include symbol graphics.
+ * - A style using pre-defined pixel bit patterns [[LinePixels]] for dashed display (Code1-Code7).
+ * - A style that uses a texture.
+ *
+ * A definition is defined by one or more components. A component is saved as a "file property" and can be referenced by other components. The line style definition references a component
+ * by file property id and type and is saved as a dictionary element.
+ * @public
+ */
+export declare namespace LineStyleDefinition {
+    /** Line style component type identifiers */
+    enum ComponentType {
+        /** Component type for [[LineStyleDefinition.PointSymbolProps]] */
+        PointSymbol = 1,
+        /** Component type for [[LineStyleDefinition.CompoundProps]] */
+        Compound = 2,
+        /** Component type for [[LineStyleDefinition.StrokePatternProps]] */
+        StrokePattern = 3,
+        /** Component type for [[LineStyleDefinition.StrokePointProps]] */
+        StrokePoint = 4,
+        /** Component type for [[LinePixels]], never saved as a file property */
+        Internal = 6,
+        /** Component type for [[LineStyleDefinition.RasterImageProps]] */
+        RasterImage = 7
+    }
+    /** Mask of values for StrokeMode */
+    enum StrokeMode {
+        /** Stroke represents a blank space */
+        Gap = 0,
+        /** Stroke represents a solid dash */
+        Dash = 1,
+        /** Treat stroke as rigid and continue past a corner to complete the stroke as opposed to breaking at the corner */
+        Ray = 2,
+        /** Stroke length can be stretched when [[LineStyleDefinition.StrokePatternOptions.Iteration]] and [[LineStyleDefinition.StrokePatternOptions.AutoPhase]] options are set, applicable to both Gap and Dash strokes */
+        Scale = 4,
+        /** Invert stroke in first stroke pattern */
+        FirstInvert = 8,
+        /** Invert stroke in last stroke pattern */
+        LastInvert = 16
+    }
+    /** Define constant width or tapered strokes with distance specified in meters */
+    enum StrokeWidth {
+        /** Stroke draws as one pixel wide line */
+        None = 0,
+        /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to left side of stroke */
+        Left = 1,
+        /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to right side of stroke */
+        Right = 2,
+        /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to both sides of stroke */
+        Full = 3
+    }
+    /** Controls appearance of stroke end caps. If StrokeCap is >= Hexagon, the end cap is stroked as an arc and the value of
+     * StrokeCap indicates the number of vectors in the arc.
+     */
+    enum StrokeCap {
+        /** Stroke displays as a closed polygon */
+        Closed = 0,
+        /** Stroke displays lines at specified width instead of a polygon */
+        Open = 1,
+        /** Stroke length extended by half the stroke width */
+        Extended = 2,
+        /** Stroke end cap is a hexagon */
+        Hexagon = 3,
+        /** Stroke end cap is an octagon */
+        Octagon = 4,
+        /** Stroke end cap is a decagon */
+        Decagon = 5,
+        /** Stroke end cap is an arc */
+        Arc = 30
+    }
+    /** A stroke representing either a dash or gap in a stroke pattern */
+    interface StrokeProps {
+        /** Length of stroke in meters */
+        length: number;
+        /** Width at start of stroke. Behavior controlled by [[LineStyleDefinition.StrokeWidth]], choose value other than [[LineStyleDefinition.StrokeWidth.None]] */
+        orgWidth?: number;
+        /** Width at end of stroke, same as start width if not present. Behavior controlled by [[LineStyleDefinition.StrokeWidth]], choose value other than [[LineStyleDefinition.StrokeWidth.None]] */
+        endWidth?: number;
+        /** Type and behavior of stroke */
+        strokeMode?: StrokeMode;
+        /** How to apply orgWidth and endWidth to stroke */
+        widthMode?: StrokeWidth;
+        /** Appearance of stroke end cap */
+        capMode?: StrokeCap;
+    }
+    type Strokes = StrokeProps[];
+    /** Options to control how stroke pattern is applied to underlying curve */
+    enum StrokePatternOptions {
+        /** Use default stroke behavior */
+        None = 0,
+        /** [[LineStyleDefinition.StrokePatternProps.phase]] represents fractional distance into first stroke of pattern */
+        AutoPhase = 1,
+        /** Use [[LineStyleDefinition.StrokePatternProps.maxIter]] to limit the number of iterations of the stroke pattern */
+        Iteration = 8,
+        /** Single segment mode restarts the stroke pattern at corners instead of continuing around corners */
+        Segment = 16,
+        /** Center the line style and stretch the ends */
+        CenterStretch = 32
+    }
+    /** Stroke pattern component definition [[LineStyleDefinition.ComponentType.StrokePattern]].
+     * A stroke pattern component consists of a series of dashes and gaps having specified lengths and widths in meters. Simple dash-dot type line styles that do not
+     * include point symbols can be created by referencing a stroke pattern component by its file property id.
+     */
+    interface StrokePatternProps {
+        /** Name for this stroke pattern */
+        descr: string;
+        /** Skip into the pattern before starting to draw. Value treated as fraction of the first stroke when [[LineStyleDefinition.StrokePatternOptions.AutoPhase]] set. Value used as distance when [[LineStyleDefinition.StrokePatternOptions.CenterStretch]] is not set. */
+        phase?: number;
+        /** Options mask for this stroke pattern */
+        options?: StrokePatternOptions;
+        /** The entire stroke pattern will be repeated no more than maxIter on curve or segment when [[LineStyleDefinition.StrokePatternOptions.Iteration]] is set and stroke pattern includes stretchable strokes. */
+        maxIter?: number;
+        /** Array of strokes, maximum number that will be used is 32 */
+        strokes: Strokes;
+    }
+    /** Flags to identify point symbol behavior */
+    enum PointSymbolFlags {
+        /** Default symbol behavior */
+        None = 0,
+        /** Symbol includes 3d geometry */
+        Is3d = 1,
+        /** Symbol does not allow scaling */
+        NoScale = 2
+    }
+    /** Point symbol component definition [[LineStyleDefinition.ComponentType.PointSymbol]].
+     * A point symbol component identifies a GeometryPart for reference by a [[LineStyleDefinition.SymbolProps]].
+     */
+    interface PointSymbolProps {
+        /** GeometryPart Id to use as a pattern symbol */
+        geomPartId: Id64String;
+        /** GeometryPart.bbox.low.x */
+        baseX?: number;
+        /** GeometryPart.bbox.low.y */
+        baseY?: number;
+        /** GeometryPart.bbox.low.z */
+        baseZ?: number;
+        /** GeometryPart.bbox.high.x */
+        sizeX?: number;
+        /** GeometryPart.bbox.high.y */
+        sizeY?: number;
+        /** GeometryPart.bbox.high.z */
+        sizeZ?: number;
+        /** Symbol behavior flags */
+        symFlags?: PointSymbolFlags;
+        /** Symbol scale, defaults to 1 */
+        scale?: number;
+    }
+    /** Symbol options for location, orientation, and behavior */
+    enum SymbolOptions {
+        /** No point symbol */
+        None = 0,
+        /** Symbol at origin of stroke */
+        Origin = 1,
+        /** Symbol at end of stroke */
+        End = 2,
+        /** symbol at center of stroke */
+        Center = 3,
+        /** Symbol at curve start point */
+        CurveOrigin = 4,
+        /** Symbol at curve end point */
+        CurveEnd = 8,
+        /** Symbol at each vertex */
+        CurveVertex = 16,
+        /** Adjust symbol rotation left->right */
+        AdjustRotation = 32,
+        /** Angle of symbol not relative to stroke direction */
+        AbsoluteRotation = 64,
+        /** No scale on variable strokes */
+        NoScale = 256,
+        /** No clip on partial strokes */
+        NoClip = 512,
+        /** No partial strokes */
+        NoPartial = 1024,
+        /** Project partial origin */
+        ProjectOrigin = 2048,
+        /** Use color from symbol instead of inheriting curve color */
+        UseColor = 16384,
+        /** Use weight from symbol instead of inheriting curve weight */
+        UseWeight = 32768
+    }
+    /** Identifies a symbol and its location and orientation relative to a stroke pattern */
+    interface SymbolProps {
+        /** The file property id of the symbol component, assumed to be [[LineStyleDefinition.ComponentType.PointSymbol]] if symType is undefined. */
+        symId: number;
+        /** The component type, leave undefined if symId is a [[LineStyleDefinition.ComponentType.PointSymbol]] */
+        symType?: ComponentType;
+        /** The 0 based stroke index for base stroke pattern [[LineStyleDefinition.ComponentType.StrokePattern]] component */
+        strokeNum?: number;
+        /** Symbol x offset distance in meters */
+        xOffset?: number;
+        /** Symbol y offset distance in meters */
+        yOffset?: number;
+        /** Symbol rotation in radians */
+        angle?: number;
+        /** Must set location for symbol as default value is [[LineStyleDefinition.SymbolOptions.None]] */
+        mod1?: SymbolOptions;
+    }
+    type Symbols = SymbolProps[];
+    /** Stroke point component definition [[LineStyleDefinition.ComponentType.StrokePoint]].
+     * A stroke point component identifies the locations of point symbol components relative to a base stroke pattern component.
+     */
+    interface StrokePointProps {
+        /** Name for this stroke point component */
+        descr: string;
+        /** The file property id of the stroke component, assumed to be [[LineStyleDefinition.ComponentType.StrokePattern]] if lcType is undefined */
+        lcId: number;
+        /** The component type, leave undefined if lcId is a [[LineStyleDefinition.ComponentType.StrokePattern]] */
+        lcType?: ComponentType;
+        /** Array of symbols */
+        symbols: Symbols;
+    }
+    /** Raster component definition [[LineStyleDefinition.ComponentType.RasterImage]].
+     * A raster component identifies a texture for a line style.
+     */
+    interface RasterImageProps {
+        /** Name for this raster image component */
+        descr: string;
+        /** Raster width */
+        x: number;
+        /** Raster height */
+        y: number;
+        /** True width flag */
+        trueWidth?: number;
+        /** Raster flags */
+        flags?: number;
+        /** The file property id of raster image */
+        imageId?: number;
+    }
+    /** Identifies a component by file property id and type */
+    interface ComponentProps {
+        /** The file property id of [[LineStyleDefinition.ComponentType.StrokePattern]] or [[LineStyleDefinition.ComponentType.StrokePoint]] component */
+        id: number;
+        /** The type of component for specified file property id */
+        type: ComponentType;
+        /** Offset distance for this component, default is 0 */
+        offset?: number;
+    }
+    type Components = ComponentProps[];
+    /** Compound component definition [[LineStyleDefinition.ComponentType.Compound]].
+     * A compound component is used to link stroke pattern and stroke point components to create a style that displays dashes, gaps, and symbols.
+     */
+    interface CompoundProps {
+        comps: Components;
+    }
+    /** Flags to describe a style or control style behavior */
+    enum StyleFlags {
+        /** Use defaults */
+        None = 0,
+        /** Only snap to center line and not individual strokes and symbols of line style */
+        NoSnap = 4,
+        /** Style represents a continuous line with width (determined by looking at components if not set) */
+        Continuous = 8,
+        /** Style represents physical geometry and should be scaled as such */
+        Physical = 128
+    }
+    /** The line style definition element data */
+    interface StyleProps {
+        /** The file property id for either a [[LineStyleDefinition.ComponentType.StrokePattern]] or [[LineStyleDefinition.ComponentType.Compound]] component */
+        compId: number;
+        /** The type of component for specified file property id */
+        compType: ComponentType;
+        /** Style behavior flags. Defaults to [[LineStyleDefinition.StyleFlags.NoSnap]] if left undefined */
+        flags?: StyleFlags;
+        /** Style scale, defaults to 1 */
+        unitDef?: number;
+    }
+    /** Helper methods for creating and querying line styles */
+    class Utils {
+        /** Create a file property for a new stroke pattern component. */
+        static createStrokePatternComponent(iModel: IModelDb, props: StrokePatternProps): StyleProps;
+        /** Create a file property for a new point symbol component.
+         * If base and size parameters are not supplied, queries GeometryPart by id to set them.
+         */
+        static createPointSymbolComponent(iModel: IModelDb, props: PointSymbolProps): StyleProps | undefined;
+        /** Create a file property for a new stroke point component. */
+        static createStrokePointComponent(iModel: IModelDb, props: StrokePointProps): StyleProps;
+        /** Create a file property for a new compound component. */
+        static createCompoundComponent(iModel: IModelDb, props: CompoundProps): StyleProps;
+        /** Create a file property for a new raster image component. */
+        static createRasterComponent(iModel: IModelDb, props: RasterImageProps, image: Uint8Array): StyleProps | undefined;
+        /** Query for an existing line style with the supplied name. */
+        static queryStyle(imodel: IModelDb, scopeModelId: Id64String, name: string): Id64String | undefined;
+        /** Insert a new line style with the supplied name.
+         * @throws [[IModelError]] if unable to insert the line style definition element.
+         */
+        static createStyle(imodel: IModelDb, scopeModelId: Id64String, name: string, props: StyleProps): Id64String;
+        /** Query for a continuous line style that can be used to create curves with physical width instead of weight in pixels and create one if it does not already exist.
+         * There are 2 ways to define a continuous line style:
+         * - Width is not specified in the style itself and instead will be supplied as an override for each curve that is drawn.
+         *  - Defined using [[LineStyleDefinition.ComponentType.Internal]] with component id 0 [[LinePixels.Solid]] which has special behavior of being affected by width overrides.
+         * - Width is specified in the style.
+         *  - Defined using a single stroke component that is a long dash.
+         *
+         * @throws [[IModelError]] if unable to insert the line style definition element.
+         */
+        static getOrCreateContinuousStyle(imodel: IModelDb, scopeModelId: Id64String, width?: number): Id64String;
+        /** Query for a line style using the supplied [[LinePixels]] value (Code1-Code7) and create one if it does not already exist.
+         * Most applications should instead use [[createStrokePatternComponent]] to define a style with physical dash and gap lengths.
+         * Unlike other components, [[LineStyleDefinition.ComponentType.Internal]] uses the line code as the compId instead of a file property id.
+         * @throws [[IModelError]] if supplied an invalid [[LinePixels]] value or if unable to insert the line style definition element.
+         */
+        static getOrCreateLinePixelsStyle(imodel: IModelDb, scopeModelId: Id64String, linePixels: LinePixels): Id64String;
+    }
+}
+//# sourceMappingURL=LineStyle.d.ts.map