@itwin/core-frontend 4.8.0-dev.4 → 4.8.0-dev.41

package/lib/esm/IpcApp.js

@@ -7,6 +7,7 @@
  */
 import { BackendError, IModelError, IModelStatus, ipcAppChannels, iTwinChannel, } from "@itwin/core-common";
 import { IModelApp } from "./IModelApp";
+import { _callIpcChannel } from "./common/internal/Symbols";
 /**
  * The frontend of apps with a dedicated backend that can use [Ipc]($docs/learning/IpcInterface.md).
  * @public
@@ -69,7 +70,7 @@ export class IpcApp {
      * @note Ipc is only supported if [[isValid]] is true.
      * @internal Use [[makeIpcProxy]] for a type-safe interface.
      */
-    static async callIpcChannel(channelName, methodName, ...args) {
+    static async [_callIpcChannel](channelName, methodName, ...args) {
         const retVal = (await this.invoke(channelName, methodName, ...args));
         if (undefined !== retVal.error) {
             const err = new BackendError(retVal.error.errorNumber, retVal.error.name, retVal.error.message);
@@ -78,31 +79,36 @@ export class IpcApp {
         }
         return retVal.result;
     }
+    /** @internal
+     * @deprecated in 4.8. Use [[makeIpcProxy]] for a type-safe interface.
+     */
+    static async callIpcChannel(channelName, methodName, ...args) {
+        return this[_callIpcChannel](channelName, methodName, ...args);
+    }
     /** Create a type safe Proxy object to make IPC calls to a registered backend interface.
      * @param channelName the channel registered by the backend handler.
      */
     static makeIpcProxy(channelName) {
         return new Proxy({}, {
             get(_target, methodName) {
-                return async (...args) => IpcApp.callIpcChannel(channelName, methodName, ...args);
+                return async (...args) => IpcApp[_callIpcChannel](channelName, methodName, ...args);
             },
         });
     }
     /** Create a type safe Proxy object to call an IPC function on a of registered backend handler that accepts a "methodName" argument followed by optional arguments
      * @param channelName the channel registered by the backend handler.
      * @param functionName the function to call on the handler.
-     * @internal
      */
     static makeIpcFunctionProxy(channelName, functionName) {
         return new Proxy({}, {
             get(_target, methodName) {
-                return async (...args) => IpcApp.callIpcChannel(channelName, functionName, methodName, ...args);
+                return async (...args) => IpcApp[_callIpcChannel](channelName, functionName, methodName, ...args);
             },
         });
     }
     /** @deprecated in 3.x. use [[appFunctionIpc]] */
     static async callIpcHost(methodName, ...args) {
-        return this.callIpcChannel(ipcAppChannels.functions, methodName, ...args);
+        return this[_callIpcChannel](ipcAppChannels.functions, methodName, ...args);
     }
     /** start an IpcApp.
      * @note this should not be called directly. It is called by NativeApp.startup */

package/lib/esm/IpcApp.js.map

@@ -1 +1 @@
-{"version":3,"file":"IpcApp.js","sourceRoot":"","sources":["../../src/IpcApp.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EACL,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,cAAc,EACvD,YAAY,GACb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAoB,MAAM,aAAa,CAAC;AAU1D;;;GAGG;AACH,MAAM,OAAO,MAAM;IAEjB,qEAAqE;IAE7D,MAAM,KAAK,GAAG,KAAwB,OAAO,IAAI,CAAC,IAAK,CAAC,CAAC,CAAC;IAElE,iIAAiI;IAC1H,MAAM,KAAK,OAAO,KAAc,OAAO,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAExE;;;;;;;OAOG;IACI,MAAM,CAAC,WAAW,CAAC,OAAe,EAAE,OAAoB;QAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;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;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,GAAG,IAAW;QACxD,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,GAAG,IAAW;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,WAAmB,EAAE,UAAkB,EAAE,GAAG,IAAW;QACxF,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAoB,CAAC;QACxF,IAAI,SAAS,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAChG,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;YAC/B,MAAM,GAAG,CAAC;QACZ,CAAC;QACD,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,YAAY,CAAI,WAAmB;QAC/C,OAAO,IAAI,KAAK,CAAC,EAAyB,EAAE;YAC1C,GAAG,CAAC,OAAO,EAAE,UAAkB;gBAC7B,OAAO,KAAK,EAAE,GAAG,IAAW,EAAE,EAAE,CAC9B,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;YAC5D,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,oBAAoB,CAAI,WAAmB,EAAE,YAAoB;QAC7E,OAAO,IAAI,KAAK,CAAC,EAAyB,EAAE;YAC1C,GAAG,CAAC,OAAO,EAAE,UAAkB;gBAC7B,OAAO,KAAK,EAAE,GAAG,IAAW,EAAE,EAAE,CAC9B,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;YAC1E,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,KAAK,CAAC,WAAW,CAA4C,UAAa,EAAE,GAAG,IAAoC;QAC/H,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAA0C,CAAC;IACrH,CAAC;IAKD;qFACiF;IAC1E,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAsB,EAAE,IAAoB;QACtE,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,mBAAmB,CAAC,QAAQ,EAAE,CAAC,CAAC,sCAAsC;QACtE,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;;AAfD,+EAA+E;AACjE,qBAAc,GAAG,MAAM,CAAC,YAAY,CAAkB,cAAc,CAAC,SAAS,CAAC,CAAC;AAiBhG;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAgB,mBAAmB;IAIhC,YAAY;QACjB,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAW,EAAE,QAAgB,EAAE,GAAG,IAAW,EAAE,EAAE;YAC5F,MAAM,IAAI,GAAI,IAAY,CAAC,QAAQ,CAAC,CAAC;YACrC,IAAI,OAAO,IAAI,KAAK,UAAU;gBAC5B,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,gBAAgB,EAAE,WAAW,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,QAAQ,8DAA8D,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YAErL,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,QAAQ;QACpB,OAAQ,IAAK,IAAY,EAA0B,CAAC,YAAY,EAAE,CAAC,CAAC,uFAAuF;IAC7J,CAAC;CACF;AAED,wCAAwC;AACxC,MAAM,mBAAoB,SAAQ,mBAAmB;IACnD,IAAW,WAAW,KAAK,OAAO,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC;IACtD,SAAS,KAAK,CAAC;CACvB","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 { AsyncMethodsOf, PickAsyncMethods, PromiseReturnType } from \"@itwin/core-bentley\";\r\nimport {\r\n  BackendError, IModelError, IModelStatus, ipcAppChannels, IpcAppFunctions, IpcAppNotifications, IpcInvokeReturn, IpcListener, IpcSocketFrontend,\r\n  iTwinChannel, RemoveFunction,\r\n} from \"@itwin/core-common\";\r\nimport { IModelApp, IModelAppOptions } from \"./IModelApp\";\r\n\r\n/**\r\n * Options for [[IpcApp.startup]]\r\n * @public\r\n */\r\nexport interface IpcAppOptions {\r\n  iModelApp?: IModelAppOptions;\r\n}\r\n\r\n/**\r\n * The frontend of apps with a dedicated backend that can use [Ipc]($docs/learning/IpcInterface.md).\r\n * @public\r\n */\r\nexport class IpcApp {\r\n  private static _ipc: IpcSocketFrontend | undefined;\r\n  /** Get the implementation of the [[IpcSocketFrontend]] interface. */\r\n\r\n  private static get ipc(): IpcSocketFrontend { return this._ipc!; }\r\n\r\n  /** Determine whether Ipc is available for this frontend. 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   * Establish a message handler function for the supplied channel over Ipc. The handler will be called when messages are sent for\r\n   * the channel via  [[BackendIpc.send]].\r\n   * @param channel the name of the channel\r\n   * @param handler the message handler\r\n   * @returns A function to remove the handler\r\n   * @note Ipc is only supported if [[isValid]] is true.\r\n   */\r\n  public static addListener(channel: string, handler: IpcListener): RemoveFunction {\r\n    return this.ipc.addListener(iTwinChannel(channel), handler);\r\n  }\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) {\r\n    this.ipc.removeListener(iTwinChannel(channel), listener);\r\n  }\r\n\r\n  /**\r\n   * Send a message to the backend via `channel` and expect a result asynchronously. The handler must be established on the backend via [[BackendIpc.handle]]\r\n   * @param channel The name of the channel for the method.\r\n   * @see Electron [ipcRenderer.invoke](https://www.electronjs.org/docs/api/ipc-renderer) documentation for details.\r\n   * Note that this interface may be implemented via Electron for desktop apps, or via\r\n   * [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) for mobile or web-based\r\n   * Ipc connections. In either case, the Electron documentation provides the specifications for how it works.\r\n   * @note `args` are serialized with the [Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), so only\r\n   * primitive types and `ArrayBuffers` are allowed.\r\n   */\r\n  public static async invoke(channel: string, ...args: any[]): Promise<any> {\r\n    return this.ipc.invoke(iTwinChannel(channel), ...args);\r\n  }\r\n\r\n  /**\r\n   * Send a message over the socket.\r\n   * @param channel The name of the channel for the message.\r\n   * @param data The optional data of the message.\r\n   * @note `data` is serialized with the [Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), so only\r\n   * primitive types and `ArrayBuffers` are allowed.\r\n   */\r\n  public static send(channel: string, ...data: any[]) {\r\n    return this.ipc.send(iTwinChannel(channel), ...data);\r\n  }\r\n\r\n  /**\r\n   * Call a method on the backend through an Ipc channel.\r\n   * @param channelName the channel registered by the backend handler.\r\n   * @param methodName  the name of a method implemented by the backend handler.\r\n   * @param args arguments to `methodName`\r\n   * @return a Promise with the return value from `methodName`\r\n   * @note If the backend implementation throws an exception, this method will throw a [[BackendError]] exception\r\n   * with the `errorNumber` and `message` from the backend.\r\n   * @note Ipc is only supported if [[isValid]] is true.\r\n   * @internal Use [[makeIpcProxy]] for a type-safe interface.\r\n   */\r\n  public static async callIpcChannel(channelName: string, methodName: string, ...args: any[]): Promise<any> {\r\n    const retVal = (await this.invoke(channelName, methodName, ...args)) as IpcInvokeReturn;\r\n    if (undefined !== retVal.error) {\r\n      const err = new BackendError(retVal.error.errorNumber, retVal.error.name, retVal.error.message);\r\n      err.stack = retVal.error.stack;\r\n      throw err;\r\n    }\r\n    return retVal.result;\r\n  }\r\n\r\n  /** Create a type safe Proxy object to make IPC calls to a registered backend interface.\r\n   * @param channelName the channel registered by the backend handler.\r\n   */\r\n  public static makeIpcProxy<K>(channelName: string): PickAsyncMethods<K> {\r\n    return new Proxy({} as PickAsyncMethods<K>, {\r\n      get(_target, methodName: string) {\r\n        return async (...args: any[]) =>\r\n          IpcApp.callIpcChannel(channelName, methodName, ...args);\r\n      },\r\n    });\r\n  }\r\n\r\n  /** Create a type safe Proxy object to call an IPC function on a of registered backend handler that accepts a \"methodName\" argument followed by optional arguments\r\n   * @param channelName the channel registered by the backend handler.\r\n   * @param functionName the function to call on the handler.\r\n   * @internal\r\n   */\r\n  public static makeIpcFunctionProxy<K>(channelName: string, functionName: string): PickAsyncMethods<K> {\r\n    return new Proxy({} as PickAsyncMethods<K>, {\r\n      get(_target, methodName: string) {\r\n        return async (...args: any[]) =>\r\n          IpcApp.callIpcChannel(channelName, functionName, methodName, ...args);\r\n      },\r\n    });\r\n  }\r\n\r\n  /** @deprecated in 3.x. use [[appFunctionIpc]] */\r\n  public static async callIpcHost<T extends AsyncMethodsOf<IpcAppFunctions>>(methodName: T, ...args: Parameters<IpcAppFunctions[T]>) {\r\n    return this.callIpcChannel(ipcAppChannels.functions, methodName, ...args) as PromiseReturnType<IpcAppFunctions[T]>;\r\n  }\r\n\r\n  /** A Proxy to call one of the [IpcAppFunctions]($common) functions via IPC. */\r\n  public static appFunctionIpc = IpcApp.makeIpcProxy<IpcAppFunctions>(ipcAppChannels.functions);\r\n\r\n  /** start an IpcApp.\r\n   * @note this should not be called directly. It is called by NativeApp.startup */\r\n  public static async startup(ipc: IpcSocketFrontend, opts?: IpcAppOptions) {\r\n    this._ipc = ipc;\r\n    IpcAppNotifyHandler.register(); // receives notifications from backend\r\n    await IModelApp.startup(opts?.iModelApp);\r\n  }\r\n\r\n  /** @internal */\r\n  public static async shutdown() {\r\n    this._ipc = undefined;\r\n    await IModelApp.shutdown();\r\n  }\r\n}\r\n\r\n/**\r\n * Base class for all implementations of an Ipc notification response interface. This class is implemented on your frontend to supply\r\n * methods to receive notifications from your backend.\r\n *\r\n * Create a subclass to implement your Ipc response interface. Your class should be declared like this:\r\n * ```ts\r\n * class MyNotificationHandler extends NotificationHandler implements MyNotifications\r\n * ```\r\n * to ensure all method names and signatures are correct. Your methods cannot have a return value.\r\n *\r\n * Then, call `MyNotificationHandler.register` at startup to connect your class to your channel.\r\n * @public\r\n * @extensions\r\n */\r\nexport abstract class NotificationHandler {\r\n  /** All subclasses must implement this method to specify their response channel name. */\r\n  public abstract get channelName(): string;\r\n\r\n  public registerImpl(): RemoveFunction {\r\n    return IpcApp.addListener(this.channelName, (_evt: Event, funcName: string, ...args: any[]) => {\r\n      const func = (this as any)[funcName];\r\n      if (typeof func !== \"function\")\r\n        throw new IModelError(IModelStatus.FunctionNotFound, `Method \"${this.constructor.name}.${funcName}\" not found on NotificationHandler registered for channel: ${this.channelName}`);\r\n\r\n      func.call(this, ...args);\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Register this class as the handler for notifications on its channel. This static method creates a new instance\r\n   * that becomes the notification 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, multiple handlers are established.\r\n   */\r\n  public static register(): RemoveFunction {\r\n    return (new (this as any)() as NotificationHandler).registerImpl(); // create an instance of subclass. \"as any\" is necessary because base class is abstract\r\n  }\r\n}\r\n\r\n/** IpcApp notifications from backend */\r\nclass IpcAppNotifyHandler extends NotificationHandler implements IpcAppNotifications {\r\n  public get channelName() { return ipcAppChannels.appNotify; }\r\n  public notifyApp() { }\r\n}\r\n"]}
+{"version":3,"file":"IpcApp.js","sourceRoot":"","sources":["../../src/IpcApp.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EACL,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,cAAc,EACvD,YAAY,GACb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAoB,MAAM,aAAa,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAU5D;;;GAGG;AACH,MAAM,OAAO,MAAM;IAEjB,qEAAqE;IAE7D,MAAM,KAAK,GAAG,KAAwB,OAAO,IAAI,CAAC,IAAK,CAAC,CAAC,CAAC;IAElE,iIAAiI;IAC1H,MAAM,KAAK,OAAO,KAAc,OAAO,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAExE;;;;;;;OAOG;IACI,MAAM,CAAC,WAAW,CAAC,OAAe,EAAE,OAAoB;QAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;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;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,GAAG,IAAW;QACxD,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,GAAG,IAAW;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,CAAC,WAAmB,EAAE,UAAkB,EAAE,GAAG,IAAW;QAC3F,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAoB,CAAC;QACxF,IAAI,SAAS,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAChG,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;YAC/B,MAAM,GAAG,CAAC;QACZ,CAAC;QACD,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,WAAmB,EAAE,UAAkB,EAAE,GAAG,IAAW;QACxF,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,YAAY,CAAI,WAAmB;QAC/C,OAAO,IAAI,KAAK,CAAC,EAAyB,EAAE;YAC1C,GAAG,CAAC,OAAO,EAAE,UAAkB;gBAC7B,OAAO,KAAK,EAAE,GAAG,IAAW,EAAE,EAAE,CAC9B,MAAM,CAAC,eAAe,CAAC,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;YAC9D,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,oBAAoB,CAAI,WAAmB,EAAE,YAAoB;QAC7E,OAAO,IAAI,KAAK,CAAC,EAAyB,EAAE;YAC1C,GAAG,CAAC,OAAO,EAAE,UAAkB;gBAC7B,OAAO,KAAK,EAAE,GAAG,IAAW,EAAE,EAAE,CAC9B,MAAM,CAAC,eAAe,CAAC,CAAC,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;YAC5E,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,KAAK,CAAC,WAAW,CAA4C,UAAa,EAAE,GAAG,IAAoC;QAC/H,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,cAAc,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAA0C,CAAC;IACvH,CAAC;IAKD;qFACiF;IAC1E,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAsB,EAAE,IAAoB;QACtE,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,mBAAmB,CAAC,QAAQ,EAAE,CAAC,CAAC,sCAAsC;QACtE,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;;AAfD,+EAA+E;AACjE,qBAAc,GAAG,MAAM,CAAC,YAAY,CAAkB,cAAc,CAAC,SAAS,CAAC,CAAC;AAiBhG;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAgB,mBAAmB;IAIhC,YAAY;QACjB,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAW,EAAE,QAAgB,EAAE,GAAG,IAAW,EAAE,EAAE;YAC5F,MAAM,IAAI,GAAI,IAAY,CAAC,QAAQ,CAAC,CAAC;YACrC,IAAI,OAAO,IAAI,KAAK,UAAU;gBAC5B,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,gBAAgB,EAAE,WAAW,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,QAAQ,8DAA8D,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YAErL,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,QAAQ;QACpB,OAAQ,IAAK,IAAY,EAA0B,CAAC,YAAY,EAAE,CAAC,CAAC,uFAAuF;IAC7J,CAAC;CACF;AAED,wCAAwC;AACxC,MAAM,mBAAoB,SAAQ,mBAAmB;IACnD,IAAW,WAAW,KAAK,OAAO,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC;IACtD,SAAS,KAAK,CAAC;CACvB","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 { AsyncMethodsOf, PickAsyncMethods, PromiseReturnType } from \"@itwin/core-bentley\";\r\nimport {\r\n  BackendError, IModelError, IModelStatus, ipcAppChannels, IpcAppFunctions, IpcAppNotifications, IpcInvokeReturn, IpcListener, IpcSocketFrontend,\r\n  iTwinChannel, RemoveFunction,\r\n} from \"@itwin/core-common\";\r\nimport { IModelApp, IModelAppOptions } from \"./IModelApp\";\r\nimport { _callIpcChannel } from \"./common/internal/Symbols\";\r\n\r\n/**\r\n * Options for [[IpcApp.startup]]\r\n * @public\r\n */\r\nexport interface IpcAppOptions {\r\n  iModelApp?: IModelAppOptions;\r\n}\r\n\r\n/**\r\n * The frontend of apps with a dedicated backend that can use [Ipc]($docs/learning/IpcInterface.md).\r\n * @public\r\n */\r\nexport class IpcApp {\r\n  private static _ipc: IpcSocketFrontend | undefined;\r\n  /** Get the implementation of the [[IpcSocketFrontend]] interface. */\r\n\r\n  private static get ipc(): IpcSocketFrontend { return this._ipc!; }\r\n\r\n  /** Determine whether Ipc is available for this frontend. 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   * Establish a message handler function for the supplied channel over Ipc. The handler will be called when messages are sent for\r\n   * the channel via  [[BackendIpc.send]].\r\n   * @param channel the name of the channel\r\n   * @param handler the message handler\r\n   * @returns A function to remove the handler\r\n   * @note Ipc is only supported if [[isValid]] is true.\r\n   */\r\n  public static addListener(channel: string, handler: IpcListener): RemoveFunction {\r\n    return this.ipc.addListener(iTwinChannel(channel), handler);\r\n  }\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) {\r\n    this.ipc.removeListener(iTwinChannel(channel), listener);\r\n  }\r\n\r\n  /**\r\n   * Send a message to the backend via `channel` and expect a result asynchronously. The handler must be established on the backend via [[BackendIpc.handle]]\r\n   * @param channel The name of the channel for the method.\r\n   * @see Electron [ipcRenderer.invoke](https://www.electronjs.org/docs/api/ipc-renderer) documentation for details.\r\n   * Note that this interface may be implemented via Electron for desktop apps, or via\r\n   * [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) for mobile or web-based\r\n   * Ipc connections. In either case, the Electron documentation provides the specifications for how it works.\r\n   * @note `args` are serialized with the [Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), so only\r\n   * primitive types and `ArrayBuffers` are allowed.\r\n   */\r\n  public static async invoke(channel: string, ...args: any[]): Promise<any> {\r\n    return this.ipc.invoke(iTwinChannel(channel), ...args);\r\n  }\r\n\r\n  /**\r\n   * Send a message over the socket.\r\n   * @param channel The name of the channel for the message.\r\n   * @param data The optional data of the message.\r\n   * @note `data` is serialized with the [Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), so only\r\n   * primitive types and `ArrayBuffers` are allowed.\r\n   */\r\n  public static send(channel: string, ...data: any[]) {\r\n    return this.ipc.send(iTwinChannel(channel), ...data);\r\n  }\r\n\r\n  /**\r\n   * Call a method on the backend through an Ipc channel.\r\n   * @param channelName the channel registered by the backend handler.\r\n   * @param methodName  the name of a method implemented by the backend handler.\r\n   * @param args arguments to `methodName`\r\n   * @return a Promise with the return value from `methodName`\r\n   * @note If the backend implementation throws an exception, this method will throw a [[BackendError]] exception\r\n   * with the `errorNumber` and `message` from the backend.\r\n   * @note Ipc is only supported if [[isValid]] is true.\r\n   * @internal Use [[makeIpcProxy]] for a type-safe interface.\r\n   */\r\n  public static async [_callIpcChannel](channelName: string, methodName: string, ...args: any[]): Promise<any> {\r\n    const retVal = (await this.invoke(channelName, methodName, ...args)) as IpcInvokeReturn;\r\n    if (undefined !== retVal.error) {\r\n      const err = new BackendError(retVal.error.errorNumber, retVal.error.name, retVal.error.message);\r\n      err.stack = retVal.error.stack;\r\n      throw err;\r\n    }\r\n    return retVal.result;\r\n  }\r\n\r\n  /** @internal\r\n   * @deprecated in 4.8. Use [[makeIpcProxy]] for a type-safe interface.\r\n   */\r\n  public static async callIpcChannel(channelName: string, methodName: string, ...args: any[]): Promise<any> {\r\n    return this[_callIpcChannel](channelName, methodName, ...args);\r\n  }\r\n\r\n  /** Create a type safe Proxy object to make IPC calls to a registered backend interface.\r\n   * @param channelName the channel registered by the backend handler.\r\n   */\r\n  public static makeIpcProxy<K>(channelName: string): PickAsyncMethods<K> {\r\n    return new Proxy({} as PickAsyncMethods<K>, {\r\n      get(_target, methodName: string) {\r\n        return async (...args: any[]) =>\r\n          IpcApp[_callIpcChannel](channelName, methodName, ...args);\r\n      },\r\n    });\r\n  }\r\n\r\n  /** Create a type safe Proxy object to call an IPC function on a of registered backend handler that accepts a \"methodName\" argument followed by optional arguments\r\n   * @param channelName the channel registered by the backend handler.\r\n   * @param functionName the function to call on the handler.\r\n   */\r\n  public static makeIpcFunctionProxy<K>(channelName: string, functionName: string): PickAsyncMethods<K> {\r\n    return new Proxy({} as PickAsyncMethods<K>, {\r\n      get(_target, methodName: string) {\r\n        return async (...args: any[]) =>\r\n          IpcApp[_callIpcChannel](channelName, functionName, methodName, ...args);\r\n      },\r\n    });\r\n  }\r\n\r\n  /** @deprecated in 3.x. use [[appFunctionIpc]] */\r\n  public static async callIpcHost<T extends AsyncMethodsOf<IpcAppFunctions>>(methodName: T, ...args: Parameters<IpcAppFunctions[T]>) {\r\n    return this[_callIpcChannel](ipcAppChannels.functions, methodName, ...args) as PromiseReturnType<IpcAppFunctions[T]>;\r\n  }\r\n\r\n  /** A Proxy to call one of the [IpcAppFunctions]($common) functions via IPC. */\r\n  public static appFunctionIpc = IpcApp.makeIpcProxy<IpcAppFunctions>(ipcAppChannels.functions);\r\n\r\n  /** start an IpcApp.\r\n   * @note this should not be called directly. It is called by NativeApp.startup */\r\n  public static async startup(ipc: IpcSocketFrontend, opts?: IpcAppOptions) {\r\n    this._ipc = ipc;\r\n    IpcAppNotifyHandler.register(); // receives notifications from backend\r\n    await IModelApp.startup(opts?.iModelApp);\r\n  }\r\n\r\n  /** @internal */\r\n  public static async shutdown() {\r\n    this._ipc = undefined;\r\n    await IModelApp.shutdown();\r\n  }\r\n}\r\n\r\n/**\r\n * Base class for all implementations of an Ipc notification response interface. This class is implemented on your frontend to supply\r\n * methods to receive notifications from your backend.\r\n *\r\n * Create a subclass to implement your Ipc response interface. Your class should be declared like this:\r\n * ```ts\r\n * class MyNotificationHandler extends NotificationHandler implements MyNotifications\r\n * ```\r\n * to ensure all method names and signatures are correct. Your methods cannot have a return value.\r\n *\r\n * Then, call `MyNotificationHandler.register` at startup to connect your class to your channel.\r\n * @public\r\n * @extensions\r\n */\r\nexport abstract class NotificationHandler {\r\n  /** All subclasses must implement this method to specify their response channel name. */\r\n  public abstract get channelName(): string;\r\n\r\n  public registerImpl(): RemoveFunction {\r\n    return IpcApp.addListener(this.channelName, (_evt: Event, funcName: string, ...args: any[]) => {\r\n      const func = (this as any)[funcName];\r\n      if (typeof func !== \"function\")\r\n        throw new IModelError(IModelStatus.FunctionNotFound, `Method \"${this.constructor.name}.${funcName}\" not found on NotificationHandler registered for channel: ${this.channelName}`);\r\n\r\n      func.call(this, ...args);\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Register this class as the handler for notifications on its channel. This static method creates a new instance\r\n   * that becomes the notification 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, multiple handlers are established.\r\n   */\r\n  public static register(): RemoveFunction {\r\n    return (new (this as any)() as NotificationHandler).registerImpl(); // create an instance of subclass. \"as any\" is necessary because base class is abstract\r\n  }\r\n}\r\n\r\n/** IpcApp notifications from backend */\r\nclass IpcAppNotifyHandler extends NotificationHandler implements IpcAppNotifications {\r\n  public get channelName() { return ipcAppChannels.appNotify; }\r\n  public notifyApp() { }\r\n}\r\n"]}

package/lib/esm/LocalhostIpcApp.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LocalhostIpcApp.d.ts","sourceRoot":"","sources":["../../src/LocalhostIpcApp.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAa,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE1D,gBAAgB;AAChB,MAAM,WAAW,mBAAmB;IAClC,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAE7B,eAAe,CAAC,EAAE;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,GAAG,CAAC;KACjB,CAAC;CACH;AAwDD;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,MAAM,CAAC,YAAY,CAAS;IACpC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAuB;WAE5B,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,SAAQ,GAAG,GAAG;WAOzC,OAAO,CAAC,IAAI,EAAE,mBAAmB;CActD"}
+{"version":3,"file":"LocalhostIpcApp.d.ts","sourceRoot":"","sources":["../../src/LocalhostIpcApp.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAa,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAG1D,gBAAgB;AAChB,MAAM,WAAW,mBAAmB;IAClC,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAE7B,eAAe,CAAC,EAAE;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,GAAG,CAAC;KACjB,CAAC;CACH;AAwDD;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,MAAM,CAAC,YAAY,CAAS;IACpC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAuB;WAE5B,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,SAAQ,GAAG,GAAG;WAOzC,OAAO,CAAC,IAAI,EAAE,mBAAmB;CActD"}

package/lib/esm/LocalhostIpcApp.js

@@ -8,6 +8,7 @@
 import { IpcSession, IpcWebSocket, IpcWebSocketFrontend, IpcWebSocketMessage, IpcWebSocketTransport, rpcOverIpcStrings } from "@itwin/core-common";
 import { IpcApp } from "./IpcApp";
 import { IModelApp } from "./IModelApp";
+import { _callIpcChannel } from "./common/internal/Symbols";
 class LocalTransport extends IpcWebSocketTransport {
     constructor(opts) {
         super();
@@ -48,7 +49,7 @@ class LocalTransport extends IpcWebSocketTransport {
 }
 class LocalSession extends IpcSession {
     async handleRpc(info) {
-        return IpcApp.callIpcChannel(rpcOverIpcStrings.channelName, "request", info);
+        return IpcApp[_callIpcChannel](rpcOverIpcStrings.channelName, "request", info);
     }
 }
 /**

package/lib/esm/LocalhostIpcApp.js.map

@@ -1 +1 @@
-{"version":3,"file":"LocalhostIpcApp.js","sourceRoot":"","sources":["../../src/LocalhostIpcApp.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAyB,UAAU,EAAE,YAAY,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC1K,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,SAAS,EAAoB,MAAM,aAAa,CAAC;AAY1D,MAAM,cAAe,SAAQ,qBAAqB;IAKhD,YAAmB,IAAyB;QAC1C,KAAK,EAAE,CAAC;QAHF,aAAQ,GAA2B,EAAE,CAAC;QAK5C,IAAI,GAAQ,CAAC;QACb,IAAI,IAAI,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC;YACrC,GAAG,GAAG,IAAI,EAAE,eAAe,EAAE,SAAS,CAAC;QACzC,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,IAAI,EAAE,eAAe,EAAE,UAAU,IAAI,IAAI,CAAC;YACvD,GAAG,GAAG,IAAI,GAAG,CAAC,kBAAkB,IAAI,GAAG,CAAC,CAAC;QAC3C,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAEhB,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE;YACzC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAS,CAAC;YAC/B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;YAC1B,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;YACvD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YACpE,IAAI,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;gBACtC,OAAO;YACT,CAAC;YAED,KAAK,MAAM,QAAQ,IAAI,YAAY,CAAC,SAAS;gBAC3C,QAAQ,CAAC,EAAW,EAAE,OAAO,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,IAAI,CAAC,OAA4B;QACtC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC5B,OAAO;QACT,CAAC;QAED,OAAO,CAAC,QAAQ,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACtC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACnD,CAAC;CACF;AAED,MAAM,YAAa,SAAQ,UAAU;IACnB,KAAK,CAAC,SAAS,CAAC,IAA2B;QACzD,OAAO,MAAM,CAAC,cAAc,CAAC,iBAAiB,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IAC/E,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,eAAe;IAInB,MAAM,CAAC,iBAAiB,CAAC,IAAS,EAAE,IAAI,GAAG,KAAK;QACrD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QACpB,GAAG,CAAC,QAAQ,GAAG,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7E,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAyB;QACnD,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,YAAY,CAAC,SAAS,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;YAClD,IAAI,CAAC,IAAI,GAAG,IAAI,oBAAoB,EAAE,CAAC;YACvC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAC3B,CAAC;QAED,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAEtC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YACvB,UAAU,CAAC,KAAK,CAAC,IAAI,YAAY,EAAE,CAAC,CAAC;YACrC,SAAS,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;;AAvBc,4BAAY,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 IModelApp\r\n */\r\n\r\nimport { InterceptedRpcRequest, IpcSession, IpcWebSocket, IpcWebSocketFrontend, IpcWebSocketMessage, IpcWebSocketTransport, rpcOverIpcStrings } from \"@itwin/core-common\";\r\nimport { IpcApp } from \"./IpcApp\";\r\nimport { IModelApp, IModelAppOptions } from \"./IModelApp\";\r\n\r\n/** @internal */\r\nexport interface LocalHostIpcAppOpts {\r\n  iModelApp?: IModelAppOptions;\r\n\r\n  localhostIpcApp?: {\r\n    socketPort?: number;\r\n    socketUrl?: URL;\r\n  };\r\n}\r\n\r\nclass LocalTransport extends IpcWebSocketTransport {\r\n  private _client: WebSocket;\r\n  private _next: number;\r\n  private _pending?: IpcWebSocketMessage[] = [];\r\n\r\n  public constructor(opts: LocalHostIpcAppOpts) {\r\n    super();\r\n\r\n    let url: URL;\r\n    if (opts?.localhostIpcApp?.socketUrl) {\r\n      url = opts?.localhostIpcApp?.socketUrl;\r\n    } else {\r\n      const port = opts?.localhostIpcApp?.socketPort ?? 3002;\r\n      url = new URL(`ws://localhost:${port}/`);\r\n    }\r\n\r\n    this._client = new WebSocket(url);\r\n    this._next = -1;\r\n\r\n    this._client.addEventListener(\"open\", () => {\r\n      const pending = this._pending!;\r\n      this._pending = undefined;\r\n      pending.forEach((m) => this.send(m));\r\n    });\r\n\r\n    this._client.addEventListener(\"message\", async (event) => {\r\n      const message = await this.notifyIncoming(event.data, this._client);\r\n      if (IpcWebSocketMessage.skip(message)) {\r\n        return;\r\n      }\r\n\r\n      for (const listener of IpcWebSocket.receivers)\r\n        listener({} as Event, message);\r\n    });\r\n  }\r\n\r\n  public send(message: IpcWebSocketMessage): void {\r\n    if (this._pending) {\r\n      this._pending.push(message);\r\n      return;\r\n    }\r\n\r\n    message.sequence = ++this._next;\r\n    const parts = this.serialize(message);\r\n    parts.forEach((part) => this._client.send(part));\r\n  }\r\n}\r\n\r\nclass LocalSession extends IpcSession {\r\n  public override async handleRpc(info: InterceptedRpcRequest) {\r\n    return IpcApp.callIpcChannel(rpcOverIpcStrings.channelName, \"request\", info);\r\n  }\r\n}\r\n\r\n/**\r\n * To be used only by test applications that want to test web-based editing using localhost.\r\n *  @internal\r\n */\r\nexport class LocalhostIpcApp {\r\n  private static _initialized = false;\r\n  private static _ipc: IpcWebSocketFrontend;\r\n\r\n  public static buildUrlForSocket(base: URL, path = \"ipc\"): URL {\r\n    const url = new URL(base);\r\n    url.protocol = \"ws\";\r\n    url.pathname = [...url.pathname.split(\"/\"), path].filter((v) => v).join(\"/\");\r\n    return url;\r\n  }\r\n\r\n  public static async startup(opts: LocalHostIpcAppOpts) {\r\n    if (!this._initialized) {\r\n      IpcWebSocket.transport = new LocalTransport(opts);\r\n      this._ipc = new IpcWebSocketFrontend();\r\n      this._initialized = true;\r\n    }\r\n\r\n    await IpcApp.startup(this._ipc, opts);\r\n\r\n    if (!IpcSession.active) {\r\n      IpcSession.start(new LocalSession());\r\n      IModelApp.onBeforeShutdown.addListener(() => IpcSession.stop());\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"LocalhostIpcApp.js","sourceRoot":"","sources":["../../src/LocalhostIpcApp.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAyB,UAAU,EAAE,YAAY,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC1K,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,SAAS,EAAoB,MAAM,aAAa,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAY5D,MAAM,cAAe,SAAQ,qBAAqB;IAKhD,YAAmB,IAAyB;QAC1C,KAAK,EAAE,CAAC;QAHF,aAAQ,GAA2B,EAAE,CAAC;QAK5C,IAAI,GAAQ,CAAC;QACb,IAAI,IAAI,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC;YACrC,GAAG,GAAG,IAAI,EAAE,eAAe,EAAE,SAAS,CAAC;QACzC,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,IAAI,EAAE,eAAe,EAAE,UAAU,IAAI,IAAI,CAAC;YACvD,GAAG,GAAG,IAAI,GAAG,CAAC,kBAAkB,IAAI,GAAG,CAAC,CAAC;QAC3C,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAEhB,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE;YACzC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAS,CAAC;YAC/B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;YAC1B,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;YACvD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YACpE,IAAI,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;gBACtC,OAAO;YACT,CAAC;YAED,KAAK,MAAM,QAAQ,IAAI,YAAY,CAAC,SAAS;gBAC3C,QAAQ,CAAC,EAAW,EAAE,OAAO,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,IAAI,CAAC,OAA4B;QACtC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC5B,OAAO;QACT,CAAC;QAED,OAAO,CAAC,QAAQ,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACtC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACnD,CAAC;CACF;AAED,MAAM,YAAa,SAAQ,UAAU;IACnB,KAAK,CAAC,SAAS,CAAC,IAA2B;QACzD,OAAO,MAAM,CAAC,eAAe,CAAC,CAAC,iBAAiB,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IACjF,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,eAAe;IAInB,MAAM,CAAC,iBAAiB,CAAC,IAAS,EAAE,IAAI,GAAG,KAAK;QACrD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QACpB,GAAG,CAAC,QAAQ,GAAG,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7E,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAyB;QACnD,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,YAAY,CAAC,SAAS,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;YAClD,IAAI,CAAC,IAAI,GAAG,IAAI,oBAAoB,EAAE,CAAC;YACvC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAC3B,CAAC;QAED,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAEtC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YACvB,UAAU,CAAC,KAAK,CAAC,IAAI,YAAY,EAAE,CAAC,CAAC;YACrC,SAAS,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;;AAvBc,4BAAY,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 IModelApp\r\n */\r\n\r\nimport { InterceptedRpcRequest, IpcSession, IpcWebSocket, IpcWebSocketFrontend, IpcWebSocketMessage, IpcWebSocketTransport, rpcOverIpcStrings } from \"@itwin/core-common\";\r\nimport { IpcApp } from \"./IpcApp\";\r\nimport { IModelApp, IModelAppOptions } from \"./IModelApp\";\r\nimport { _callIpcChannel } from \"./common/internal/Symbols\";\r\n\r\n/** @internal */\r\nexport interface LocalHostIpcAppOpts {\r\n  iModelApp?: IModelAppOptions;\r\n\r\n  localhostIpcApp?: {\r\n    socketPort?: number;\r\n    socketUrl?: URL;\r\n  };\r\n}\r\n\r\nclass LocalTransport extends IpcWebSocketTransport {\r\n  private _client: WebSocket;\r\n  private _next: number;\r\n  private _pending?: IpcWebSocketMessage[] = [];\r\n\r\n  public constructor(opts: LocalHostIpcAppOpts) {\r\n    super();\r\n\r\n    let url: URL;\r\n    if (opts?.localhostIpcApp?.socketUrl) {\r\n      url = opts?.localhostIpcApp?.socketUrl;\r\n    } else {\r\n      const port = opts?.localhostIpcApp?.socketPort ?? 3002;\r\n      url = new URL(`ws://localhost:${port}/`);\r\n    }\r\n\r\n    this._client = new WebSocket(url);\r\n    this._next = -1;\r\n\r\n    this._client.addEventListener(\"open\", () => {\r\n      const pending = this._pending!;\r\n      this._pending = undefined;\r\n      pending.forEach((m) => this.send(m));\r\n    });\r\n\r\n    this._client.addEventListener(\"message\", async (event) => {\r\n      const message = await this.notifyIncoming(event.data, this._client);\r\n      if (IpcWebSocketMessage.skip(message)) {\r\n        return;\r\n      }\r\n\r\n      for (const listener of IpcWebSocket.receivers)\r\n        listener({} as Event, message);\r\n    });\r\n  }\r\n\r\n  public send(message: IpcWebSocketMessage): void {\r\n    if (this._pending) {\r\n      this._pending.push(message);\r\n      return;\r\n    }\r\n\r\n    message.sequence = ++this._next;\r\n    const parts = this.serialize(message);\r\n    parts.forEach((part) => this._client.send(part));\r\n  }\r\n}\r\n\r\nclass LocalSession extends IpcSession {\r\n  public override async handleRpc(info: InterceptedRpcRequest) {\r\n    return IpcApp[_callIpcChannel](rpcOverIpcStrings.channelName, \"request\", info);\r\n  }\r\n}\r\n\r\n/**\r\n * To be used only by test applications that want to test web-based editing using localhost.\r\n *  @internal\r\n */\r\nexport class LocalhostIpcApp {\r\n  private static _initialized = false;\r\n  private static _ipc: IpcWebSocketFrontend;\r\n\r\n  public static buildUrlForSocket(base: URL, path = \"ipc\"): URL {\r\n    const url = new URL(base);\r\n    url.protocol = \"ws\";\r\n    url.pathname = [...url.pathname.split(\"/\"), path].filter((v) => v).join(\"/\");\r\n    return url;\r\n  }\r\n\r\n  public static async startup(opts: LocalHostIpcAppOpts) {\r\n    if (!this._initialized) {\r\n      IpcWebSocket.transport = new LocalTransport(opts);\r\n      this._ipc = new IpcWebSocketFrontend();\r\n      this._initialized = true;\r\n    }\r\n\r\n    await IpcApp.startup(this._ipc, opts);\r\n\r\n    if (!IpcSession.active) {\r\n      IpcSession.start(new LocalSession());\r\n      IModelApp.onBeforeShutdown.addListener(() => IpcSession.stop());\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/esm/NativeApp.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NativeApp.d.ts","sourceRoot":"","sources":["../../src/NativeApp.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,UAAU,EAAU,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACrG,OAAO,EACL,mBAAmB,EAAE,cAAc,EAAE,aAAa,EAAE,0BAA0B,EAAE,iBAAiB,EAAE,mBAAmB,EACtH,kBAAkB,EACwB,YAAY,EAAE,QAAQ,EACjE,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAErD,OAAO,EAAU,aAAa,EAAuB,MAAM,UAAU,CAAC;AAEtE,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAC7B;IAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAAC,WAAW,CAAC,EAAE,KAAK,CAAA;CAAE,GAC5C;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAE5C;;;EAGE;AACF,MAAM,MAAM,wBAAwB,GAAG,mBAAmB,GAAG;IAC3D,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gEAAgE;IAChE,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;IACtC,8DAA8D;IAC9D,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAWF;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,aAAa;IAClD,SAAS,CAAC,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAiB;IAEjD,2CAA2C;WACvB,cAAc,CAAC,CAAC,SAAS,cAAc,CAAC,kBAAkB,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAG1I,kFAAkF;IAClF,OAAc,YAAY,qEAA4E;IAEtG,OAAO,CAAC,MAAM,CAAC,SAAS,CAA8B;IACtD,OAAO,CAAC,MAAM,CAAC,SAAS,CAEtB;IACF,OAAO,CAAC,MAAM,CAAC,UAAU,CAEvB;mBACmB,eAAe;IAGpC,OAAO,CAAC,MAAM,CAAC,6BAA6B;IAM5C,OAAO,CAAC,MAAM,CAAC,+BAA+B;IAM9C,gEAAgE;IAChE,OAAc,6BAA6B,mBAAwB,0BAA0B,KAAK,IAAI,EAAI;IAE1G,8EAA8E;WAC1D,yBAAyB,IAAI,OAAO,CAAC,0BAA0B,CAAC;IAGpF,gBAAgB;WACI,4BAA4B,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;IAGnG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAS;IAChC,WAAkB,OAAO,IAAI,OAAO,CAA0B;IAE9D;;;OAGG;WACiB,OAAO,CAAC,GAAG,EAAE,iBAAiB,EAAE,IAAI,CAAC,EAAE,aAAa;IAexE,gBAAgB;WACI,QAAQ;WAQR,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,wBAAwB,EACvH,IAAI,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAErD;;OAEG;WACiB,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,wBAAwB,EAEvH,IAAI,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA6ClF,4EAA4E;WACxD,oBAAoB,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAIhF;;OAEG;WACiB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpE,oFAAoF;WAChE,mBAAmB,CAAC,QAAQ,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAI9F;;;;OAIG;WACiB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAS/D;;;;OAIG;WACiB,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,aAAa,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAQjG,2DAA2D;WACvC,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;CAGzD;AAED;;;;GAIG;AACH,qBAAa,OAAO;aACU,EAAE,EAAE,MAAM;gBAAV,EAAE,EAAE,MAAM;IAEtC,sEAAsE;IACzD,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,GAAG,SAAS,CAAC;IAIpH,8BAA8B;IACjB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAIxD,0BAA0B;IACb,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrE;;;OAGG;IACU,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAIzC,iCAAiC;IACpB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAInD,sCAAsC;IACzB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;CAGxC"}
+{"version":3,"file":"NativeApp.d.ts","sourceRoot":"","sources":["../../src/NativeApp.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,UAAU,EAAU,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACrG,OAAO,EACL,mBAAmB,EAAE,cAAc,EAAE,aAAa,EAAE,0BAA0B,EAAE,iBAAiB,EAAE,mBAAmB,EACtH,kBAAkB,EACwB,YAAY,EAAE,QAAQ,EACjE,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAErD,OAAO,EAAU,aAAa,EAAuB,MAAM,UAAU,CAAC;AAEtE,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAG3D;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAC7B;IAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAAC,WAAW,CAAC,EAAE,KAAK,CAAA;CAAE,GAC5C;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAE5C;;;EAGE;AACF,MAAM,MAAM,wBAAwB,GAAG,mBAAmB,GAAG;IAC3D,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gEAAgE;IAChE,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;IACtC,8DAA8D;IAC9D,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAWF;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,aAAa;IAClD,SAAS,CAAC,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAiB;IAEjD,2CAA2C;WACvB,cAAc,CAAC,CAAC,SAAS,cAAc,CAAC,kBAAkB,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAG1I,kFAAkF;IAClF,OAAc,YAAY,qEAA4E;IAEtG,OAAO,CAAC,MAAM,CAAC,SAAS,CAA8B;IACtD,OAAO,CAAC,MAAM,CAAC,SAAS,CAEtB;IACF,OAAO,CAAC,MAAM,CAAC,UAAU,CAEvB;mBACmB,eAAe;IAGpC,OAAO,CAAC,MAAM,CAAC,6BAA6B;IAM5C,OAAO,CAAC,MAAM,CAAC,+BAA+B;IAM9C,gEAAgE;IAChE,OAAc,6BAA6B,mBAAwB,0BAA0B,KAAK,IAAI,EAAI;IAE1G,8EAA8E;WAC1D,yBAAyB,IAAI,OAAO,CAAC,0BAA0B,CAAC;IAGpF,gBAAgB;WACI,4BAA4B,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;IAGnG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAS;IAChC,WAAkB,OAAO,IAAI,OAAO,CAA0B;IAE9D;;;OAGG;WACiB,OAAO,CAAC,GAAG,EAAE,iBAAiB,EAAE,IAAI,CAAC,EAAE,aAAa;IAexE,gBAAgB;WACI,QAAQ;WAQR,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,wBAAwB,EACvH,IAAI,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAErD;;OAEG;WACiB,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,wBAAwB,EAEvH,IAAI,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA6ClF,4EAA4E;WACxD,oBAAoB,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAIhF;;OAEG;WACiB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpE,oFAAoF;WAChE,mBAAmB,CAAC,QAAQ,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAI9F;;;;OAIG;WACiB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAS/D;;;;OAIG;WACiB,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,aAAa,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAQjG,2DAA2D;WACvC,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;CAGzD;AAED;;;;GAIG;AACH,qBAAa,OAAO;aACU,EAAE,EAAE,MAAM;gBAAV,EAAE,EAAE,MAAM;IAEtC,sEAAsE;IACzD,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,GAAG,SAAS,CAAC;IAIpH,8BAA8B;IACjB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAIxD,0BAA0B;IACb,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrE;;;OAGG;IACU,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAIzC,iCAAiC;IACpB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAInD,sCAAsC;IACzB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;CAGxC"}

package/lib/esm/NativeApp.js

@@ -11,6 +11,7 @@ import { IModelVersion, InternetConnectivityStatus, nativeAppIpcStrings, Overrid
 import { FrontendLoggerCategory } from "./common/FrontendLoggerCategory";
 import { IpcApp, NotificationHandler } from "./IpcApp";
 import { NativeAppLogger } from "./NativeAppLogger";
+import { _callIpcChannel } from "./common/internal/Symbols";
 /** NativeApp notifications from backend */
 class NativeAppNotifyHandler extends NotificationHandler {
     get channelName() { return nativeAppIpcStrings.notifyChannel; }
@@ -27,7 +28,7 @@ class NativeAppNotifyHandler extends NotificationHandler {
 export class NativeApp {
     /** @deprecated in 3.x. use nativeAppIpc */
     static async callNativeHost(methodName, ...args) {
-        return IpcApp.callIpcChannel(nativeAppIpcStrings.channelName, methodName, ...args);
+        return IpcApp[_callIpcChannel](nativeAppIpcStrings.channelName, methodName, ...args);
     }
     static async setConnectivity(by, status) {
         await this.nativeAppIpc.overrideInternetConnectivity(by, status);

package/lib/esm/NativeApp.js.map

@@ -1 +1 @@
-{"version":3,"file":"NativeApp.js","sourceRoot":"","sources":["../../src/NativeApp.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;;AAEH,OAAO,EAAkB,OAAO,EAAc,MAAM,EAAqB,MAAM,qBAAqB,CAAC;AACrG,OAAO,EACgC,aAAa,EAAE,0BAA0B,EAC1D,mBAAmB,EAA0B,YAAY,EACrB,QAAQ,GACjE,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,MAAM,EAAiB,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAwBpD,2CAA2C;AAC3C,MAAM,sBAAuB,SAAQ,mBAAmB;IACtD,IAAW,WAAW,KAAK,OAAO,mBAAmB,CAAC,aAAa,CAAC,CAAC,CAAC;IAC/D,iCAAiC,CAAC,MAAkC;QACzE,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,SAAS,EAAE,+BAA+B,CAAC,CAAC;QAClF,SAAS,CAAC,6BAA6B,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC;CACF;AAUD;;;;GAIG;AACH,MAAM,OAAO,SAAS;IAGpB,2CAA2C;IACpC,MAAM,CAAC,KAAK,CAAC,cAAc,CAA+C,UAAa,EAAE,GAAG,IAAuC;QACxI,OAAO,MAAM,CAAC,cAAc,CAAC,mBAAmB,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI,CAA6C,CAAC;IACjI,CAAC;IAWO,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,EAAgB,EAAE,MAAkC;QACvF,MAAM,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;IACO,MAAM,CAAC,6BAA6B;QAC1C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACtE,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAClD,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IACO,MAAM,CAAC,+BAA+B;QAC5C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACtE,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YACrD,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAID,8EAA8E;IACvE,MAAM,CAAC,KAAK,CAAC,yBAAyB;QAC3C,OAAO,IAAI,CAAC,YAAY,CAAC,yBAAyB,EAAE,CAAC;IACvD,CAAC;IACD,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,MAAkC;QACjF,OAAO,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACnF,CAAC;IAEM,MAAM,KAAK,OAAO,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE9D;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAsB,EAAE,IAAoB;QACtE,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAChC,IAAI,IAAI,CAAC,QAAQ;YACf,OAAO;QACT,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,IAAI,CAAC,gBAAgB,GAAG,sBAAsB,CAAC,QAAQ,EAAE,CAAC,CAAC,sCAAsC;QACjG,EAAS,CAAC,6BAA6B,EAAE,CAAC;QAE1C,mCAAmC;QACnC,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YAC5B,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;QACrJ,CAAC;IACH,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC;QAC1B,EAAS,CAAC,+BAA+B,EAAE,CAAC;QAC5C,MAAM,eAAe,CAAC,KAAK,EAAE,CAAC;QAC9B,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,CAAC;IAYM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAC1C,OAAe,EACf,QAAgB,EAChB,eAAyC,EACzC,OAAsB,aAAa,CAAC,MAAM,EAAE,EAC5C,QAA2B;QAE3B,MAAM,oBAAoB,GAAG,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,eAAe,CAAC,gBAAgB,CAAC;QAE9E,IAAI,kBAAkB,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;QACnC,IAAI,oBAAoB,EAAE,CAAC;YACzB,MAAM,cAAc,GAAG,CAAC,IAAW,EAAE,IAAuC,EAAE,EAAE;gBAC9E,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC;gBACjB,eAAe,CAAC,gBAAgB,EAAE,CAAC,IAAI,CAAC,CAAC;YAC3C,CAAC,CAAC;YAEF,kBAAkB,GAAG,MAAM,CAAC,WAAW,CAAC,sBAAsB,QAAQ,EAAE,EAAE,cAAc,CAAC,CAAC;QAC5F,CAAC;QAED,MAAM,WAAW,GAAG,CAAC,SAAS,KAAK,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;YAC7F,CAAC,eAAe,CAAC,QAAQ,KAAK,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEjH,MAAM,QAAQ,GAAG,eAAe,CAAC,QAAQ,IAAI,MAAM,IAAI,CAAC,oBAAoB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;QACxG,MAAM,YAAY,GAA6B,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,CAAC;QAEjH,MAAM,UAAU,GAAG,KAAK,IAAmB,EAAE;YAC3C,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,YAAY,EAAE,oBAAoB,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;YAClH,CAAC;oBAAS,CAAC;gBACT,kBAAkB,EAAE,CAAC;YACvB,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,aAAa,GAAG,KAAK,IAAsB,EAAE;YACjD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,8BAA8B,CAAC,QAAQ,CAAC,CAAC;YAChF,IAAI,MAAM;gBACR,kBAAkB,EAAE,CAAC;YACvB,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QAEF,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,EAAE,aAAa,EAAE,CAAC;IACjF,CAAC;IAED,4EAA4E;IACrE,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,KAAqB;QAC5D,OAAO,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAgB;QAClD,MAAM,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED,oFAAoF;IAC7E,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,QAAqB;QAC3D,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,IAAY;QAC1C,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC;YAC1B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;QAEnC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QACxC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,OAAgB,EAAE,gBAAyB,KAAK;QAC/E,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,eAAe,OAAO,CAAC,EAAE,YAAY,CAAC,CAAC;QAEzD,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;QACnE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,KAAK,CAAC,eAAe;QACjC,OAAO,EAAS,CAAC,YAAY,CAAC,eAAe,EAAE,CAAC;IAClD,CAAC;;;AAvKD,kFAAkF;AACpE,sBAAY,GAAG,MAAM,CAAC,YAAY,CAAqB,mBAAmB,CAAC,WAAW,CAAC,AAA3E,CAA4E;AAEvF,mBAAS,GAAG,IAAI,GAAG,EAAmB,AAA7B,CAA8B;AACvC,mBAAS,GAAG,KAAK,IAAI,EAAE;IACpC,MAAM,EAAS,CAAC,eAAe,CAAC,YAAY,CAAC,OAAO,EAAE,0BAA0B,CAAC,MAAM,CAAC,CAAC;AAC3F,CAAC,AAFuB,CAEtB;AACa,oBAAU,GAAG,KAAK,IAAI,EAAE;IACrC,MAAM,EAAS,CAAC,eAAe,CAAC,YAAY,CAAC,OAAO,EAAE,0BAA0B,CAAC,OAAO,CAAC,CAAC;AAC5F,CAAC,AAFwB,CAEvB;AAgBF,gEAAgE;AAClD,uCAA6B,GAAG,IAAI,OAAO,EAAgD,AAA9D,CAA+D;AAU3F,kBAAQ,GAAG,KAAK,AAAR,CAAS;AAsIlC;;;;GAIG;AACH,MAAM,OAAO,OAAO;IAClB,YAA4B,EAAU;QAAV,OAAE,GAAF,EAAE,CAAQ;IAAI,CAAC;IAE3C,sEAAsE;IAC/D,KAAK,CAAC,YAAY,CAAC,GAAW;QACnC,OAAO,SAAS,CAAC,YAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAClE,CAAC;IAED,8BAA8B;IACvB,KAAK,CAAC,OAAO,CAAC,GAAW;QAC9B,OAAO,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IACzD,CAAC;IAED,0BAA0B;IACnB,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,KAAmB;QACnD,OAAO,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO;QAClB,OAAO,SAAS,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,iCAAiC;IAC1B,KAAK,CAAC,UAAU,CAAC,GAAW;QACjC,OAAO,SAAS,CAAC,YAAY,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAC5D,CAAC;IAED,sCAAsC;IAC/B,KAAK,CAAC,SAAS;QACpB,OAAO,SAAS,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1D,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 { AsyncMethodsOf, BeEvent, GuidString, Logger, PromiseReturnType } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseDownloader, BriefcaseProps, IModelVersion, InternetConnectivityStatus, IpcSocketFrontend, LocalBriefcaseProps,\r\n  NativeAppFunctions, nativeAppIpcStrings, NativeAppNotifications, OverriddenBy,\r\n  RemoveFunction, RequestNewBriefcaseProps, StorageValue, SyncMode,\r\n} from \"@itwin/core-common\";\r\nimport { ProgressCallback } from \"./request/Request\";\r\nimport { FrontendLoggerCategory } from \"./common/FrontendLoggerCategory\";\r\nimport { IpcApp, IpcAppOptions, NotificationHandler } from \"./IpcApp\";\r\nimport { NativeAppLogger } from \"./NativeAppLogger\";\r\nimport { OnDownloadProgress } from \"./BriefcaseConnection\";\r\n\r\n/** Properties for specifying the BriefcaseId for downloading. May either specify a BriefcaseId directly (preferable) or, for\r\n * backwards compatibility, a [SyncMode]($common). If [SyncMode.PullAndPush]($common) is supplied, a new briefcaseId will be acquired.\r\n * @public\r\n */\r\nexport type DownloadBriefcaseId =\r\n  { syncMode?: SyncMode, briefcaseId?: never } |\r\n  { briefcaseId: number, syncMode?: never };\r\n\r\n/**\r\n* Options to download a briefcase\r\n* @public\r\n*/\r\nexport type DownloadBriefcaseOptions = DownloadBriefcaseId & {\r\n  /** the full path for the briefcase file */\r\n  fileName?: string;\r\n  /** Function called regularly to report progress of download. */\r\n  progressCallback?: OnDownloadProgress;\r\n  /** interval for calling progress function, in milliseconds */\r\n  progressInterval?: number;\r\n};\r\n\r\n/** NativeApp notifications from backend */\r\nclass NativeAppNotifyHandler extends NotificationHandler implements NativeAppNotifications {\r\n  public get channelName() { return nativeAppIpcStrings.notifyChannel; }\r\n  public notifyInternetConnectivityChanged(status: InternetConnectivityStatus) {\r\n    Logger.logInfo(FrontendLoggerCategory.NativeApp, \"Internet connectivity changed\");\r\n    NativeApp.onInternetConnectivityChanged.raiseEvent(status);\r\n  }\r\n}\r\n\r\n/**\r\n * Options for [[NativeApp.startup]]\r\n * @public\r\n */\r\nexport interface NativeAppOpts extends IpcAppOptions {\r\n  nativeApp?: {};\r\n}\r\n\r\n/**\r\n * The frontend of a native application\r\n * @see [Native Applications]($docs/learning/NativeApps.md)\r\n * @public\r\n */\r\nexport class NativeApp {\r\n  private static _removeAppNotify?: RemoveFunction;\r\n\r\n  /** @deprecated in 3.x. use nativeAppIpc */\r\n  public static async callNativeHost<T extends AsyncMethodsOf<NativeAppFunctions>>(methodName: T, ...args: Parameters<NativeAppFunctions[T]>) {\r\n    return IpcApp.callIpcChannel(nativeAppIpcStrings.channelName, methodName, ...args) as PromiseReturnType<NativeAppFunctions[T]>;\r\n  }\r\n  /** A Proxy to call one of the [NativeAppFunctions]($common) functions via IPC. */\r\n  public static nativeAppIpc = IpcApp.makeIpcProxy<NativeAppFunctions>(nativeAppIpcStrings.channelName);\r\n\r\n  private static _storages = new Map<string, Storage>();\r\n  private static _onOnline = async () => {\r\n    await NativeApp.setConnectivity(OverriddenBy.Browser, InternetConnectivityStatus.Online);\r\n  };\r\n  private static _onOffline = async () => {\r\n    await NativeApp.setConnectivity(OverriddenBy.Browser, InternetConnectivityStatus.Offline);\r\n  };\r\n  private static async setConnectivity(by: OverriddenBy, status: InternetConnectivityStatus) {\r\n    await this.nativeAppIpc.overrideInternetConnectivity(by, status);\r\n  }\r\n  private static hookBrowserConnectivityEvents() {\r\n    if (typeof window === \"object\" && window.ononline && window.onoffline) {\r\n      window.addEventListener(\"online\", this._onOnline);\r\n      window.addEventListener(\"offline\", this._onOffline);\r\n    }\r\n  }\r\n  private static unhookBrowserConnectivityEvents() {\r\n    if (typeof window === \"object\" && window.ononline && window.onoffline) {\r\n      window.removeEventListener(\"online\", this._onOnline);\r\n      window.removeEventListener(\"offline\", this._onOffline);\r\n    }\r\n  }\r\n  /** event called when internet connectivity changes, if known */\r\n  public static onInternetConnectivityChanged = new BeEvent<(status: InternetConnectivityStatus) => void>();\r\n\r\n  /** determine whether the app currently has internet connectivity, if known */\r\n  public static async checkInternetConnectivity(): Promise<InternetConnectivityStatus> {\r\n    return this.nativeAppIpc.checkInternetConnectivity();\r\n  }\r\n  /** @internal */\r\n  public static async overrideInternetConnectivity(status: InternetConnectivityStatus): Promise<void> {\r\n    return this.nativeAppIpc.overrideInternetConnectivity(OverriddenBy.User, status);\r\n  }\r\n  private static _isValid = false;\r\n  public static get isValid(): boolean { return this._isValid; }\r\n\r\n  /**\r\n   * This is called by either ElectronApp.startup or MobileApp.startup - it should not be called directly\r\n   * @internal\r\n   */\r\n  public static async startup(ipc: IpcSocketFrontend, opts?: NativeAppOpts) {\r\n    await IpcApp.startup(ipc, opts);\r\n    if (this._isValid)\r\n      return;\r\n    this._isValid = true;\r\n\r\n    this._removeAppNotify = NativeAppNotifyHandler.register(); // receives notifications from backend\r\n    NativeApp.hookBrowserConnectivityEvents();\r\n\r\n    // initialize current online state.\r\n    if (window.navigator.onLine) {\r\n      await this.setConnectivity(OverriddenBy.Browser, window.navigator.onLine ? InternetConnectivityStatus.Online : InternetConnectivityStatus.Offline);\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  public static async shutdown() {\r\n    this._removeAppNotify?.();\r\n    NativeApp.unhookBrowserConnectivityEvents();\r\n    await NativeAppLogger.flush();\r\n    await IpcApp.shutdown();\r\n    this._isValid = false;\r\n  }\r\n\r\n  public static async requestDownloadBriefcase(iTwinId: string, iModelId: string, downloadOptions: DownloadBriefcaseOptions,\r\n    asOf?: IModelVersion): Promise<BriefcaseDownloader>;\r\n\r\n  /**\r\n   * @deprecated in 3.6. `progress` argument is now deprecated, use [[DownloadBriefcaseOptions.progressCallback]] instead.\r\n   */\r\n  public static async requestDownloadBriefcase(iTwinId: string, iModelId: string, downloadOptions: DownloadBriefcaseOptions,\r\n    // eslint-disable-next-line @typescript-eslint/unified-signatures, deprecation/deprecation\r\n    asOf?: IModelVersion, progress?: ProgressCallback): Promise<BriefcaseDownloader>;\r\n\r\n  public static async requestDownloadBriefcase(\r\n    iTwinId: string,\r\n    iModelId: string,\r\n    downloadOptions: DownloadBriefcaseOptions,\r\n    asOf: IModelVersion = IModelVersion.latest(),\r\n    progress?: ProgressCallback, // eslint-disable-line deprecation/deprecation\r\n  ): Promise<BriefcaseDownloader> {\r\n    const shouldReportProgress = !!progress || !!downloadOptions.progressCallback;\r\n\r\n    let stopProgressEvents = () => { };\r\n    if (shouldReportProgress) {\r\n      const handleProgress = (_evt: Event, data: { loaded: number, total: number }) => {\r\n        progress?.(data);\r\n        downloadOptions.progressCallback?.(data);\r\n      };\r\n\r\n      stopProgressEvents = IpcApp.addListener(`nativeApp.progress-${iModelId}`, handleProgress);\r\n    }\r\n\r\n    const briefcaseId = (undefined !== downloadOptions.briefcaseId) ? downloadOptions.briefcaseId :\r\n      (downloadOptions.syncMode === SyncMode.PullOnly ? 0 : await this.nativeAppIpc.acquireNewBriefcaseId(iModelId));\r\n\r\n    const fileName = downloadOptions.fileName ?? await this.getBriefcaseFileName({ briefcaseId, iModelId });\r\n    const requestProps: RequestNewBriefcaseProps = { iModelId, briefcaseId, iTwinId, asOf: asOf.toJSON(), fileName };\r\n\r\n    const doDownload = async (): Promise<void> => {\r\n      try {\r\n        await this.nativeAppIpc.downloadBriefcase(requestProps, shouldReportProgress, downloadOptions.progressInterval);\r\n      } finally {\r\n        stopProgressEvents();\r\n      }\r\n    };\r\n\r\n    const requestCancel = async (): Promise<boolean> => {\r\n      const status = await this.nativeAppIpc.requestCancelDownloadBriefcase(fileName);\r\n      if (status)\r\n        stopProgressEvents();\r\n      return status;\r\n    };\r\n\r\n    return { briefcaseId, fileName, downloadPromise: doDownload(), requestCancel };\r\n  }\r\n\r\n  /** Get the full path filename for a briefcase within the briefcase cache */\r\n  public static async getBriefcaseFileName(props: BriefcaseProps): Promise<string> {\r\n    return this.nativeAppIpc.getBriefcaseFileName(props);\r\n  }\r\n\r\n  /** Delete an existing briefcase\r\n   * @param fileName the briefcase fileName\r\n   */\r\n  public static async deleteBriefcase(fileName: string): Promise<void> {\r\n    await this.nativeAppIpc.deleteBriefcaseFiles(fileName);\r\n  }\r\n\r\n  /** Get a list of all briefcase files held in the local briefcase cache directory */\r\n  public static async getCachedBriefcases(iModelId?: GuidString): Promise<LocalBriefcaseProps[]> {\r\n    return this.nativeAppIpc.getCachedBriefcases(iModelId);\r\n  }\r\n\r\n  /**\r\n   * Open a [[Storage]]. Creates a new Storage with that name if it does not already exist.\r\n   * @param name Should be a local filename without an extension.\r\n   * @returns a Promise for the [[Storage]].\r\n   */\r\n  public static async openStorage(name: string): Promise<Storage> {\r\n    if (this._storages.has(name))\r\n      return this._storages.get(name)!;\r\n\r\n    const storage = new Storage(await this.nativeAppIpc.storageMgrOpen(name));\r\n    this._storages.set(storage.id, storage);\r\n    return storage;\r\n  }\r\n\r\n  /**\r\n   * Close a Storage and optionally delete it.\r\n   * @param storage normally not call directly instead use Storage.close()\r\n   * @param deleteStorage if true, delete the storage from disk after closing it.\r\n   */\r\n  public static async closeStorage(storage: Storage, deleteStorage: boolean = false): Promise<void> {\r\n    if (!this._storages.has(storage.id))\r\n      throw new Error(`Storage [Id=${storage.id}] not open`);\r\n\r\n    await this.nativeAppIpc.storageMgrClose(storage.id, deleteStorage);\r\n    this._storages.delete(storage.id);\r\n  }\r\n\r\n  /** Get the list of existing Storages on the local disk. */\r\n  public static async getStorageNames(): Promise<string[]> {\r\n    return NativeApp.nativeAppIpc.storageMgrNames();\r\n  }\r\n}\r\n\r\n/**\r\n *  A local disk-based cache for key value pairs for NativeApps.\r\n * @note This should be used only for local caching, since its not guaranteed to exist permanently.\r\n * @public\r\n */\r\nexport class Storage {\r\n  constructor(public readonly id: string) { }\r\n\r\n  /** get the type of a value for a key, or undefined if not present. */\r\n  public async getValueType(key: string): Promise<\"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined> {\r\n    return NativeApp.nativeAppIpc.storageGetValueType(this.id, key);\r\n  }\r\n\r\n  /** Get the value for a key */\r\n  public async getData(key: string): Promise<StorageValue> {\r\n    return NativeApp.nativeAppIpc.storageGet(this.id, key);\r\n  }\r\n\r\n  /** Set value for a key */\r\n  public async setData(key: string, value: StorageValue): Promise<void> {\r\n    return NativeApp.nativeAppIpc.storageSet(this.id, key, value);\r\n  }\r\n\r\n  /**\r\n   * Return an array of all keys in this Storage.\r\n   * @note This can be expensive, depending on the number of keys present.\r\n   */\r\n  public async getKeys(): Promise<string[]> {\r\n    return NativeApp.nativeAppIpc.storageKeys(this.id);\r\n  }\r\n\r\n  /** Remove a key and its data. */\r\n  public async removeData(key: string): Promise<void> {\r\n    return NativeApp.nativeAppIpc.storageRemove(this.id, key);\r\n  }\r\n\r\n  /** Remove all keys and their data. */\r\n  public async removeAll(): Promise<void> {\r\n    return NativeApp.nativeAppIpc.storageRemoveAll(this.id);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"NativeApp.js","sourceRoot":"","sources":["../../src/NativeApp.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;;AAEH,OAAO,EAAkB,OAAO,EAAc,MAAM,EAAqB,MAAM,qBAAqB,CAAC;AACrG,OAAO,EACgC,aAAa,EAAE,0BAA0B,EAC1D,mBAAmB,EAA0B,YAAY,EACrB,QAAQ,GACjE,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,MAAM,EAAiB,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAuB5D,2CAA2C;AAC3C,MAAM,sBAAuB,SAAQ,mBAAmB;IACtD,IAAW,WAAW,KAAK,OAAO,mBAAmB,CAAC,aAAa,CAAC,CAAC,CAAC;IAC/D,iCAAiC,CAAC,MAAkC;QACzE,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,SAAS,EAAE,+BAA+B,CAAC,CAAC;QAClF,SAAS,CAAC,6BAA6B,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC;CACF;AAUD;;;;GAIG;AACH,MAAM,OAAO,SAAS;IAGpB,2CAA2C;IACpC,MAAM,CAAC,KAAK,CAAC,cAAc,CAA+C,UAAa,EAAE,GAAG,IAAuC;QACxI,OAAO,MAAM,CAAC,eAAe,CAAC,CAAC,mBAAmB,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI,CAA6C,CAAC;IACnI,CAAC;IAWO,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,EAAgB,EAAE,MAAkC;QACvF,MAAM,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;IACO,MAAM,CAAC,6BAA6B;QAC1C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACtE,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAClD,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IACO,MAAM,CAAC,+BAA+B;QAC5C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACtE,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YACrD,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAID,8EAA8E;IACvE,MAAM,CAAC,KAAK,CAAC,yBAAyB;QAC3C,OAAO,IAAI,CAAC,YAAY,CAAC,yBAAyB,EAAE,CAAC;IACvD,CAAC;IACD,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,MAAkC;QACjF,OAAO,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACnF,CAAC;IAEM,MAAM,KAAK,OAAO,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE9D;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAsB,EAAE,IAAoB;QACtE,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAChC,IAAI,IAAI,CAAC,QAAQ;YACf,OAAO;QACT,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,IAAI,CAAC,gBAAgB,GAAG,sBAAsB,CAAC,QAAQ,EAAE,CAAC,CAAC,sCAAsC;QACjG,EAAS,CAAC,6BAA6B,EAAE,CAAC;QAE1C,mCAAmC;QACnC,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YAC5B,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;QACrJ,CAAC;IACH,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC;QAC1B,EAAS,CAAC,+BAA+B,EAAE,CAAC;QAC5C,MAAM,eAAe,CAAC,KAAK,EAAE,CAAC;QAC9B,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,CAAC;IAYM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAC1C,OAAe,EACf,QAAgB,EAChB,eAAyC,EACzC,OAAsB,aAAa,CAAC,MAAM,EAAE,EAC5C,QAA2B;QAE3B,MAAM,oBAAoB,GAAG,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,eAAe,CAAC,gBAAgB,CAAC;QAE9E,IAAI,kBAAkB,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;QACnC,IAAI,oBAAoB,EAAE,CAAC;YACzB,MAAM,cAAc,GAAG,CAAC,IAAW,EAAE,IAAuC,EAAE,EAAE;gBAC9E,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC;gBACjB,eAAe,CAAC,gBAAgB,EAAE,CAAC,IAAI,CAAC,CAAC;YAC3C,CAAC,CAAC;YAEF,kBAAkB,GAAG,MAAM,CAAC,WAAW,CAAC,sBAAsB,QAAQ,EAAE,EAAE,cAAc,CAAC,CAAC;QAC5F,CAAC;QAED,MAAM,WAAW,GAAG,CAAC,SAAS,KAAK,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;YAC7F,CAAC,eAAe,CAAC,QAAQ,KAAK,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEjH,MAAM,QAAQ,GAAG,eAAe,CAAC,QAAQ,IAAI,MAAM,IAAI,CAAC,oBAAoB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;QACxG,MAAM,YAAY,GAA6B,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,CAAC;QAEjH,MAAM,UAAU,GAAG,KAAK,IAAmB,EAAE;YAC3C,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,YAAY,EAAE,oBAAoB,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;YAClH,CAAC;oBAAS,CAAC;gBACT,kBAAkB,EAAE,CAAC;YACvB,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,aAAa,GAAG,KAAK,IAAsB,EAAE;YACjD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,8BAA8B,CAAC,QAAQ,CAAC,CAAC;YAChF,IAAI,MAAM;gBACR,kBAAkB,EAAE,CAAC;YACvB,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QAEF,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,EAAE,aAAa,EAAE,CAAC;IACjF,CAAC;IAED,4EAA4E;IACrE,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,KAAqB;QAC5D,OAAO,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAgB;QAClD,MAAM,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED,oFAAoF;IAC7E,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,QAAqB;QAC3D,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,IAAY;QAC1C,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC;YAC1B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;QAEnC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QACxC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,OAAgB,EAAE,gBAAyB,KAAK;QAC/E,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,eAAe,OAAO,CAAC,EAAE,YAAY,CAAC,CAAC;QAEzD,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;QACnE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,KAAK,CAAC,eAAe;QACjC,OAAO,EAAS,CAAC,YAAY,CAAC,eAAe,EAAE,CAAC;IAClD,CAAC;;;AAvKD,kFAAkF;AACpE,sBAAY,GAAG,MAAM,CAAC,YAAY,CAAqB,mBAAmB,CAAC,WAAW,CAAC,AAA3E,CAA4E;AAEvF,mBAAS,GAAG,IAAI,GAAG,EAAmB,AAA7B,CAA8B;AACvC,mBAAS,GAAG,KAAK,IAAI,EAAE;IACpC,MAAM,EAAS,CAAC,eAAe,CAAC,YAAY,CAAC,OAAO,EAAE,0BAA0B,CAAC,MAAM,CAAC,CAAC;AAC3F,CAAC,AAFuB,CAEtB;AACa,oBAAU,GAAG,KAAK,IAAI,EAAE;IACrC,MAAM,EAAS,CAAC,eAAe,CAAC,YAAY,CAAC,OAAO,EAAE,0BAA0B,CAAC,OAAO,CAAC,CAAC;AAC5F,CAAC,AAFwB,CAEvB;AAgBF,gEAAgE;AAClD,uCAA6B,GAAG,IAAI,OAAO,EAAgD,AAA9D,CAA+D;AAU3F,kBAAQ,GAAG,KAAK,AAAR,CAAS;AAsIlC;;;;GAIG;AACH,MAAM,OAAO,OAAO;IAClB,YAA4B,EAAU;QAAV,OAAE,GAAF,EAAE,CAAQ;IAAI,CAAC;IAE3C,sEAAsE;IAC/D,KAAK,CAAC,YAAY,CAAC,GAAW;QACnC,OAAO,SAAS,CAAC,YAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAClE,CAAC;IAED,8BAA8B;IACvB,KAAK,CAAC,OAAO,CAAC,GAAW;QAC9B,OAAO,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IACzD,CAAC;IAED,0BAA0B;IACnB,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,KAAmB;QACnD,OAAO,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO;QAClB,OAAO,SAAS,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,iCAAiC;IAC1B,KAAK,CAAC,UAAU,CAAC,GAAW;QACjC,OAAO,SAAS,CAAC,YAAY,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAC5D,CAAC;IAED,sCAAsC;IAC/B,KAAK,CAAC,SAAS;QACpB,OAAO,SAAS,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1D,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 { AsyncMethodsOf, BeEvent, GuidString, Logger, PromiseReturnType } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseDownloader, BriefcaseProps, IModelVersion, InternetConnectivityStatus, IpcSocketFrontend, LocalBriefcaseProps,\r\n  NativeAppFunctions, nativeAppIpcStrings, NativeAppNotifications, OverriddenBy,\r\n  RemoveFunction, RequestNewBriefcaseProps, StorageValue, SyncMode,\r\n} from \"@itwin/core-common\";\r\nimport { ProgressCallback } from \"./request/Request\";\r\nimport { FrontendLoggerCategory } from \"./common/FrontendLoggerCategory\";\r\nimport { IpcApp, IpcAppOptions, NotificationHandler } from \"./IpcApp\";\r\nimport { NativeAppLogger } from \"./NativeAppLogger\";\r\nimport { OnDownloadProgress } from \"./BriefcaseConnection\";\r\nimport { _callIpcChannel } from \"./common/internal/Symbols\";\r\n\r\n/** Properties for specifying the BriefcaseId for downloading. May either specify a BriefcaseId directly (preferable) or, for\r\n * backwards compatibility, a [SyncMode]($common). If [SyncMode.PullAndPush]($common) is supplied, a new briefcaseId will be acquired.\r\n * @public\r\n */\r\nexport type DownloadBriefcaseId =\r\n  { syncMode?: SyncMode, briefcaseId?: never } |\r\n  { briefcaseId: number, syncMode?: never };\r\n\r\n/**\r\n* Options to download a briefcase\r\n* @public\r\n*/\r\nexport type DownloadBriefcaseOptions = DownloadBriefcaseId & {\r\n  /** the full path for the briefcase file */\r\n  fileName?: string;\r\n  /** Function called regularly to report progress of download. */\r\n  progressCallback?: OnDownloadProgress;\r\n  /** interval for calling progress function, in milliseconds */\r\n  progressInterval?: number;\r\n};\r\n\r\n/** NativeApp notifications from backend */\r\nclass NativeAppNotifyHandler extends NotificationHandler implements NativeAppNotifications {\r\n  public get channelName() { return nativeAppIpcStrings.notifyChannel; }\r\n  public notifyInternetConnectivityChanged(status: InternetConnectivityStatus) {\r\n    Logger.logInfo(FrontendLoggerCategory.NativeApp, \"Internet connectivity changed\");\r\n    NativeApp.onInternetConnectivityChanged.raiseEvent(status);\r\n  }\r\n}\r\n\r\n/**\r\n * Options for [[NativeApp.startup]]\r\n * @public\r\n */\r\nexport interface NativeAppOpts extends IpcAppOptions {\r\n  nativeApp?: {};\r\n}\r\n\r\n/**\r\n * The frontend of a native application\r\n * @see [Native Applications]($docs/learning/NativeApps.md)\r\n * @public\r\n */\r\nexport class NativeApp {\r\n  private static _removeAppNotify?: RemoveFunction;\r\n\r\n  /** @deprecated in 3.x. use nativeAppIpc */\r\n  public static async callNativeHost<T extends AsyncMethodsOf<NativeAppFunctions>>(methodName: T, ...args: Parameters<NativeAppFunctions[T]>) {\r\n    return IpcApp[_callIpcChannel](nativeAppIpcStrings.channelName, methodName, ...args) as PromiseReturnType<NativeAppFunctions[T]>;\r\n  }\r\n  /** A Proxy to call one of the [NativeAppFunctions]($common) functions via IPC. */\r\n  public static nativeAppIpc = IpcApp.makeIpcProxy<NativeAppFunctions>(nativeAppIpcStrings.channelName);\r\n\r\n  private static _storages = new Map<string, Storage>();\r\n  private static _onOnline = async () => {\r\n    await NativeApp.setConnectivity(OverriddenBy.Browser, InternetConnectivityStatus.Online);\r\n  };\r\n  private static _onOffline = async () => {\r\n    await NativeApp.setConnectivity(OverriddenBy.Browser, InternetConnectivityStatus.Offline);\r\n  };\r\n  private static async setConnectivity(by: OverriddenBy, status: InternetConnectivityStatus) {\r\n    await this.nativeAppIpc.overrideInternetConnectivity(by, status);\r\n  }\r\n  private static hookBrowserConnectivityEvents() {\r\n    if (typeof window === \"object\" && window.ononline && window.onoffline) {\r\n      window.addEventListener(\"online\", this._onOnline);\r\n      window.addEventListener(\"offline\", this._onOffline);\r\n    }\r\n  }\r\n  private static unhookBrowserConnectivityEvents() {\r\n    if (typeof window === \"object\" && window.ononline && window.onoffline) {\r\n      window.removeEventListener(\"online\", this._onOnline);\r\n      window.removeEventListener(\"offline\", this._onOffline);\r\n    }\r\n  }\r\n  /** event called when internet connectivity changes, if known */\r\n  public static onInternetConnectivityChanged = new BeEvent<(status: InternetConnectivityStatus) => void>();\r\n\r\n  /** determine whether the app currently has internet connectivity, if known */\r\n  public static async checkInternetConnectivity(): Promise<InternetConnectivityStatus> {\r\n    return this.nativeAppIpc.checkInternetConnectivity();\r\n  }\r\n  /** @internal */\r\n  public static async overrideInternetConnectivity(status: InternetConnectivityStatus): Promise<void> {\r\n    return this.nativeAppIpc.overrideInternetConnectivity(OverriddenBy.User, status);\r\n  }\r\n  private static _isValid = false;\r\n  public static get isValid(): boolean { return this._isValid; }\r\n\r\n  /**\r\n   * This is called by either ElectronApp.startup or MobileApp.startup - it should not be called directly\r\n   * @internal\r\n   */\r\n  public static async startup(ipc: IpcSocketFrontend, opts?: NativeAppOpts) {\r\n    await IpcApp.startup(ipc, opts);\r\n    if (this._isValid)\r\n      return;\r\n    this._isValid = true;\r\n\r\n    this._removeAppNotify = NativeAppNotifyHandler.register(); // receives notifications from backend\r\n    NativeApp.hookBrowserConnectivityEvents();\r\n\r\n    // initialize current online state.\r\n    if (window.navigator.onLine) {\r\n      await this.setConnectivity(OverriddenBy.Browser, window.navigator.onLine ? InternetConnectivityStatus.Online : InternetConnectivityStatus.Offline);\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  public static async shutdown() {\r\n    this._removeAppNotify?.();\r\n    NativeApp.unhookBrowserConnectivityEvents();\r\n    await NativeAppLogger.flush();\r\n    await IpcApp.shutdown();\r\n    this._isValid = false;\r\n  }\r\n\r\n  public static async requestDownloadBriefcase(iTwinId: string, iModelId: string, downloadOptions: DownloadBriefcaseOptions,\r\n    asOf?: IModelVersion): Promise<BriefcaseDownloader>;\r\n\r\n  /**\r\n   * @deprecated in 3.6. `progress` argument is now deprecated, use [[DownloadBriefcaseOptions.progressCallback]] instead.\r\n   */\r\n  public static async requestDownloadBriefcase(iTwinId: string, iModelId: string, downloadOptions: DownloadBriefcaseOptions,\r\n    // eslint-disable-next-line @typescript-eslint/unified-signatures, deprecation/deprecation\r\n    asOf?: IModelVersion, progress?: ProgressCallback): Promise<BriefcaseDownloader>;\r\n\r\n  public static async requestDownloadBriefcase(\r\n    iTwinId: string,\r\n    iModelId: string,\r\n    downloadOptions: DownloadBriefcaseOptions,\r\n    asOf: IModelVersion = IModelVersion.latest(),\r\n    progress?: ProgressCallback, // eslint-disable-line deprecation/deprecation\r\n  ): Promise<BriefcaseDownloader> {\r\n    const shouldReportProgress = !!progress || !!downloadOptions.progressCallback;\r\n\r\n    let stopProgressEvents = () => { };\r\n    if (shouldReportProgress) {\r\n      const handleProgress = (_evt: Event, data: { loaded: number, total: number }) => {\r\n        progress?.(data);\r\n        downloadOptions.progressCallback?.(data);\r\n      };\r\n\r\n      stopProgressEvents = IpcApp.addListener(`nativeApp.progress-${iModelId}`, handleProgress);\r\n    }\r\n\r\n    const briefcaseId = (undefined !== downloadOptions.briefcaseId) ? downloadOptions.briefcaseId :\r\n      (downloadOptions.syncMode === SyncMode.PullOnly ? 0 : await this.nativeAppIpc.acquireNewBriefcaseId(iModelId));\r\n\r\n    const fileName = downloadOptions.fileName ?? await this.getBriefcaseFileName({ briefcaseId, iModelId });\r\n    const requestProps: RequestNewBriefcaseProps = { iModelId, briefcaseId, iTwinId, asOf: asOf.toJSON(), fileName };\r\n\r\n    const doDownload = async (): Promise<void> => {\r\n      try {\r\n        await this.nativeAppIpc.downloadBriefcase(requestProps, shouldReportProgress, downloadOptions.progressInterval);\r\n      } finally {\r\n        stopProgressEvents();\r\n      }\r\n    };\r\n\r\n    const requestCancel = async (): Promise<boolean> => {\r\n      const status = await this.nativeAppIpc.requestCancelDownloadBriefcase(fileName);\r\n      if (status)\r\n        stopProgressEvents();\r\n      return status;\r\n    };\r\n\r\n    return { briefcaseId, fileName, downloadPromise: doDownload(), requestCancel };\r\n  }\r\n\r\n  /** Get the full path filename for a briefcase within the briefcase cache */\r\n  public static async getBriefcaseFileName(props: BriefcaseProps): Promise<string> {\r\n    return this.nativeAppIpc.getBriefcaseFileName(props);\r\n  }\r\n\r\n  /** Delete an existing briefcase\r\n   * @param fileName the briefcase fileName\r\n   */\r\n  public static async deleteBriefcase(fileName: string): Promise<void> {\r\n    await this.nativeAppIpc.deleteBriefcaseFiles(fileName);\r\n  }\r\n\r\n  /** Get a list of all briefcase files held in the local briefcase cache directory */\r\n  public static async getCachedBriefcases(iModelId?: GuidString): Promise<LocalBriefcaseProps[]> {\r\n    return this.nativeAppIpc.getCachedBriefcases(iModelId);\r\n  }\r\n\r\n  /**\r\n   * Open a [[Storage]]. Creates a new Storage with that name if it does not already exist.\r\n   * @param name Should be a local filename without an extension.\r\n   * @returns a Promise for the [[Storage]].\r\n   */\r\n  public static async openStorage(name: string): Promise<Storage> {\r\n    if (this._storages.has(name))\r\n      return this._storages.get(name)!;\r\n\r\n    const storage = new Storage(await this.nativeAppIpc.storageMgrOpen(name));\r\n    this._storages.set(storage.id, storage);\r\n    return storage;\r\n  }\r\n\r\n  /**\r\n   * Close a Storage and optionally delete it.\r\n   * @param storage normally not call directly instead use Storage.close()\r\n   * @param deleteStorage if true, delete the storage from disk after closing it.\r\n   */\r\n  public static async closeStorage(storage: Storage, deleteStorage: boolean = false): Promise<void> {\r\n    if (!this._storages.has(storage.id))\r\n      throw new Error(`Storage [Id=${storage.id}] not open`);\r\n\r\n    await this.nativeAppIpc.storageMgrClose(storage.id, deleteStorage);\r\n    this._storages.delete(storage.id);\r\n  }\r\n\r\n  /** Get the list of existing Storages on the local disk. */\r\n  public static async getStorageNames(): Promise<string[]> {\r\n    return NativeApp.nativeAppIpc.storageMgrNames();\r\n  }\r\n}\r\n\r\n/**\r\n *  A local disk-based cache for key value pairs for NativeApps.\r\n * @note This should be used only for local caching, since its not guaranteed to exist permanently.\r\n * @public\r\n */\r\nexport class Storage {\r\n  constructor(public readonly id: string) { }\r\n\r\n  /** get the type of a value for a key, or undefined if not present. */\r\n  public async getValueType(key: string): Promise<\"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined> {\r\n    return NativeApp.nativeAppIpc.storageGetValueType(this.id, key);\r\n  }\r\n\r\n  /** Get the value for a key */\r\n  public async getData(key: string): Promise<StorageValue> {\r\n    return NativeApp.nativeAppIpc.storageGet(this.id, key);\r\n  }\r\n\r\n  /** Set value for a key */\r\n  public async setData(key: string, value: StorageValue): Promise<void> {\r\n    return NativeApp.nativeAppIpc.storageSet(this.id, key, value);\r\n  }\r\n\r\n  /**\r\n   * Return an array of all keys in this Storage.\r\n   * @note This can be expensive, depending on the number of keys present.\r\n   */\r\n  public async getKeys(): Promise<string[]> {\r\n    return NativeApp.nativeAppIpc.storageKeys(this.id);\r\n  }\r\n\r\n  /** Remove a key and its data. */\r\n  public async removeData(key: string): Promise<void> {\r\n    return NativeApp.nativeAppIpc.storageRemove(this.id, key);\r\n  }\r\n\r\n  /** Remove all keys and their data. */\r\n  public async removeAll(): Promise<void> {\r\n    return NativeApp.nativeAppIpc.storageRemoveAll(this.id);\r\n  }\r\n}\r\n"]}

package/lib/esm/NoRenderApp.d.ts

@@ -6,12 +6,14 @@ import { AnimationBranchStates } from "./render/GraphicBranch";
 import { RenderSystem } from "./render/RenderSystem";
 import { RenderTarget } from "./render/RenderTarget";
 import { ViewRect } from "./common/ViewRect";
+import { _implementationProhibited } from "./common/internal/Symbols";
 /**
  * A RenderTarget for applications that must run in environments where WebGL is not present.
  * This is typically used in tests.
  * @internal
  */
 export declare class NullTarget extends RenderTarget {
+    protected readonly [_implementationProhibited]: undefined;
     get analysisFraction(): number;
     set analysisFraction(_fraction: number);
     get renderSystem(): any;

package/lib/esm/NoRenderApp.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NoRenderApp.d.ts","sourceRoot":"","sources":["../../src/NoRenderApp.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAa,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,YAAY;IAC1C,IAAW,gBAAgB,IAAI,MAAM,CAAc;IACnD,IAAW,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAK;IAClD,IAAW,YAAY,QAA+B;IACtD,IAAW,QAAQ,IAAI,QAAQ,CAA2B;IAC1D,IAAW,yBAAyB,IAAI,OAAO,CAAkB;IACjE,IAAoB,iBAAiB,IAAI,qBAAqB,GAAG,SAAS,CAAsB;IAChG,IAAoB,iBAAiB,CAAC,SAAS,EAAE,qBAAqB,GAAG,SAAS,EAAK;IAChF,SAAS,IAAI,IAAI;IACR,KAAK,IAAI,IAAI;IACtB,WAAW,IAAI,IAAI;IACnB,cAAc,IAAI,IAAI;IACtB,iBAAiB,IAAI,IAAI;IACzB,gBAAgB,IAAI,IAAI;IACxB,SAAS,CAAC,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI;IACpC,wBAAwB,IAAI,IAAI;IAChC,YAAY,IAAI,IAAI;IACpB,UAAU,IAAI,IAAI;IAC3B,WAAW,IAAI,IAAI;IACV,SAAS,IAAI,IAAI;IACjB,OAAO,IAAI,IAAI;IACxB,cAAc,IAAI,OAAO;IACzB,UAAU,IAAI,IAAI;IACzB,IAAW,kBAAkB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAe;IAChE,IAAW,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAK;CAC9D;AAED;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAChD,IAAW,OAAO,IAAI,OAAO,CAAkB;IACxC,UAAU,IAAI,OAAO;IACrB,YAAY;IACZ,qBAAqB;IACrB,aAAa;IACb,iBAAiB;IACjB,mBAAmB;IACnB,WAAW;IACX,OAAO;;IAEE,mBAAmB;CACpC;AAED;;;;;GAKG;AACH,qBAAa,WAAW;IACtB;;OAEG;WACiB,OAAO,CAAC,IAAI,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;CAOpE"}
+{"version":3,"file":"NoRenderApp.d.ts","sourceRoot":"","sources":["../../src/NoRenderApp.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAa,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAEtE;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,YAAY;IAC1C,mBAA4B,CAAC,yBAAyB,CAAC,YAAa;IACpE,IAAW,gBAAgB,IAAI,MAAM,CAAc;IACnD,IAAW,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAK;IAClD,IAAW,YAAY,QAA+B;IACtD,IAAW,QAAQ,IAAI,QAAQ,CAA2B;IAC1D,IAAW,yBAAyB,IAAI,OAAO,CAAkB;IACjE,IAAoB,iBAAiB,IAAI,qBAAqB,GAAG,SAAS,CAAsB;IAChG,IAAoB,iBAAiB,CAAC,SAAS,EAAE,qBAAqB,GAAG,SAAS,EAAK;IAChF,SAAS,IAAI,IAAI;IACR,KAAK,IAAI,IAAI;IACtB,WAAW,IAAI,IAAI;IACnB,cAAc,IAAI,IAAI;IACtB,iBAAiB,IAAI,IAAI;IACzB,gBAAgB,IAAI,IAAI;IACxB,SAAS,CAAC,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI;IACpC,wBAAwB,IAAI,IAAI;IAChC,YAAY,IAAI,IAAI;IACpB,UAAU,IAAI,IAAI;IAC3B,WAAW,IAAI,IAAI;IACV,SAAS,IAAI,IAAI;IACjB,OAAO,IAAI,IAAI;IACxB,cAAc,IAAI,OAAO;IACzB,UAAU,IAAI,IAAI;IACzB,IAAW,kBAAkB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAe;IAChE,IAAW,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAK;CAC9D;AAED;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAChD,IAAW,OAAO,IAAI,OAAO,CAAkB;IACxC,UAAU,IAAI,OAAO;IACrB,YAAY;IACZ,qBAAqB;IACrB,aAAa;IACb,iBAAiB;IACjB,mBAAmB;IACnB,WAAW;IACX,OAAO;;IAEE,mBAAmB;CACpC;AAED;;;;;GAKG;AACH,qBAAa,WAAW;IACtB;;OAEG;WACiB,OAAO,CAAC,IAAI,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;CAOpE"}

package/lib/esm/NoRenderApp.js

@@ -5,17 +5,23 @@
 /** @packageDocumentation
  * @module IModelApp
  */
+var _a;
 import { EmptyLocalization } from "@itwin/core-common";
 import { IModelApp } from "./IModelApp";
 import { RenderSystem } from "./render/RenderSystem";
 import { RenderTarget } from "./render/RenderTarget";
 import { ViewRect } from "./common/ViewRect";
+import { _implementationProhibited } from "./common/internal/Symbols";
 /**
  * A RenderTarget for applications that must run in environments where WebGL is not present.
  * This is typically used in tests.
  * @internal
  */
 export class NullTarget extends RenderTarget {
+    constructor() {
+        super(...arguments);
+        this[_a] = undefined;
+    }
     get analysisFraction() { return 0; }
     set analysisFraction(_fraction) { }
     get renderSystem() { return undefined; }
@@ -41,6 +47,7 @@ export class NullTarget extends RenderTarget {
     get screenSpaceEffects() { return []; }
     set screenSpaceEffects(_effects) { }
 }
+_a = _implementationProhibited;
 /**
  * A RenderSystem for applications that must run in environments where WebGL is not present.
  * This is typically used in tests.

package/lib/esm/NoRenderApp.js.map

@@ -1 +1 @@
-{"version":3,"file":"NoRenderApp.js","sourceRoot":"","sources":["../../src/NoRenderApp.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAoB,MAAM,aAAa,CAAC;AAE1D,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C;;;;GAIG;AACH,MAAM,OAAO,UAAW,SAAQ,YAAY;IAC1C,IAAW,gBAAgB,KAAa,OAAO,CAAC,CAAC,CAAC,CAAC;IACnD,IAAW,gBAAgB,CAAC,SAAiB,IAAI,CAAC;IAClD,IAAW,YAAY,KAAK,OAAO,SAAgB,CAAC,CAAC,CAAC;IACtD,IAAW,QAAQ,KAAe,OAAO,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC;IAC1D,IAAW,yBAAyB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IACjE,IAAoB,iBAAiB,KAAwC,OAAO,SAAS,CAAC,CAAC,CAAC;IAChG,IAAoB,iBAAiB,CAAC,SAA4C,IAAI,CAAC;IAChF,SAAS,KAAW,CAAC;IACZ,KAAK,KAAW,CAAC;IAC1B,WAAW,KAAW,CAAC;IACvB,cAAc,KAAW,CAAC;IAC1B,iBAAiB,KAAW,CAAC;IAC7B,gBAAgB,KAAW,CAAC;IAC5B,SAAS,CAAC,mBAA4B,IAAU,CAAC;IACxC,wBAAwB,KAAW,CAAC;IACpC,YAAY,KAAW,CAAC;IACxB,UAAU,KAAW,CAAC;IAC/B,WAAW,KAAW,CAAC;IACd,SAAS,KAAW,CAAC;IACrB,OAAO,KAAW,CAAC;IAC5B,cAAc,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAC3C,UAAU,KAAW,CAAC;IAC7B,IAAW,kBAAkB,KAAuB,OAAO,EAAE,CAAC,CAAC,CAAC;IAChE,IAAW,kBAAkB,CAAC,QAA0B,IAAI,CAAC;CAC9D;AAED;;;;GAIG;AACH,MAAM,OAAO,gBAAiB,SAAQ,YAAY;IAChD,IAAW,OAAO,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IACxC,UAAU,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IACvC,YAAY,KAAK,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC,CAAC;IAC3C,qBAAqB,KAAK,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC,CAAC;IACpD,aAAa,KAAK,OAAO,SAAgB,CAAC,CAAC,CAAC;IAC5C,iBAAiB,KAAK,OAAO,SAAgB,CAAC,CAAC,CAAC;IAChD,mBAAmB,KAAK,OAAO,SAAgB,CAAC,CAAC,CAAC;IAClD,WAAW,KAAK,OAAO,SAAgB,CAAC,CAAC,CAAC;IAC1C,OAAO,KAAK,CAAC;IACpB,gBAAuB,KAAK,EAAE,CAAC,CAAC,CAAC;IACjB,mBAAmB,KAAK,OAAO,SAAS,CAAC,CAAC,CAAC;CAC5D;AAED;;;;;GAKG;AACH,MAAM,OAAO,WAAW;IACtB;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAuB;QACjD,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,IAAI,gBAAgB,EAAE,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,iBAAiB,EAAE,CAAC;QACjE,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAChC,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 IModelApp\r\n */\r\n\r\nimport { EmptyLocalization } from \"@itwin/core-common\";\r\nimport { IModelApp, IModelAppOptions } from \"./IModelApp\";\r\nimport { AnimationBranchStates } from \"./render/GraphicBranch\";\r\nimport { RenderSystem } from \"./render/RenderSystem\";\r\nimport { RenderTarget } from \"./render/RenderTarget\";\r\nimport { ViewRect } from \"./common/ViewRect\";\r\n\r\n/**\r\n * A RenderTarget for applications that must run in environments where WebGL is not present.\r\n * This is typically used in tests.\r\n * @internal\r\n */\r\nexport class NullTarget extends RenderTarget {\r\n  public get analysisFraction(): number { return 0; }\r\n  public set analysisFraction(_fraction: number) { }\r\n  public get renderSystem() { return undefined as any; }\r\n  public get viewRect(): ViewRect { return new ViewRect(); }\r\n  public get wantInvertBlackBackground(): boolean { return false; }\r\n  public override get animationBranches(): AnimationBranchStates | undefined { return undefined; }\r\n  public override set animationBranches(_branches: AnimationBranchStates | undefined) { }\r\n  public onDestroy(): void { }\r\n  public override reset(): void { }\r\n  public changeScene(): void { }\r\n  public changeDynamics(): void { }\r\n  public changeDecorations(): void { }\r\n  public changeRenderPlan(): void { }\r\n  public drawFrame(_sceneMilSecElapsed?: number): void { }\r\n  public override overrideFeatureSymbology(): void { }\r\n  public override setHiliteSet(): void { }\r\n  public override setFlashed(): void { }\r\n  public setViewRect(): void { }\r\n  public override onResized(): void { }\r\n  public override dispose(): void { }\r\n  public updateViewRect(): boolean { return false; }\r\n  public readPixels(): void { }\r\n  public get screenSpaceEffects(): Iterable<string> { return []; }\r\n  public set screenSpaceEffects(_effects: Iterable<string>) { }\r\n}\r\n\r\n/**\r\n * A RenderSystem for applications that must run in environments where WebGL is not present.\r\n * This is typically used in tests.\r\n * @internal\r\n */\r\nexport class NullRenderSystem extends RenderSystem {\r\n  public get isValid(): boolean { return false; }\r\n  public doIdleWork(): boolean { return false; }\r\n  public createTarget() { return new NullTarget(); }\r\n  public createOffscreenTarget() { return new NullTarget(); }\r\n  public createGraphic() { return undefined as any; }\r\n  public createGraphicList() { return undefined as any; }\r\n  public createGraphicBranch() { return undefined as any; }\r\n  public createBatch() { return undefined as any; }\r\n  public dispose() { }\r\n  public constructor() { super(); }\r\n  public override createRenderGraphic() { return undefined; }\r\n}\r\n\r\n/** A utility class intended for applications (primarily test-runners) that run in environments that lack support for WebGL.\r\n * It installs a [[RenderSystem]] that produces no graphics.\r\n * Use [[NoRenderApp.startup]] instead of [[IModelApp.startup]] to initialize your application frontend.\r\n * You may then use the [[IModelApp]] API as normal.\r\n * @public\r\n */\r\nexport class NoRenderApp {\r\n  /** Initializes [[IModelApp]] with a [[RenderSystem]] that produces no graphics.\r\n   * Use this in place of [[IModelApp.startup]], then proceed to use [[IModelApp]]'s API as normal.\r\n   */\r\n  public static async startup(opts?: IModelAppOptions): Promise<void> {\r\n    opts = opts ? opts : {};\r\n    opts.renderSys = new NullRenderSystem();\r\n    opts.noRender = true;\r\n    opts.localization = opts.localization ?? new EmptyLocalization();\r\n    await IModelApp.startup(opts);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"NoRenderApp.js","sourceRoot":"","sources":["../../src/NoRenderApp.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAoB,MAAM,aAAa,CAAC;AAE1D,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAEtE;;;;GAIG;AACH,MAAM,OAAO,UAAW,SAAQ,YAAY;IAA5C;;QAC8B,QAA2B,GAAG,SAAS,CAAC;IAyBtE,CAAC;IAxBC,IAAW,gBAAgB,KAAa,OAAO,CAAC,CAAC,CAAC,CAAC;IACnD,IAAW,gBAAgB,CAAC,SAAiB,IAAI,CAAC;IAClD,IAAW,YAAY,KAAK,OAAO,SAAgB,CAAC,CAAC,CAAC;IACtD,IAAW,QAAQ,KAAe,OAAO,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC;IAC1D,IAAW,yBAAyB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IACjE,IAAoB,iBAAiB,KAAwC,OAAO,SAAS,CAAC,CAAC,CAAC;IAChG,IAAoB,iBAAiB,CAAC,SAA4C,IAAI,CAAC;IAChF,SAAS,KAAW,CAAC;IACZ,KAAK,KAAW,CAAC;IAC1B,WAAW,KAAW,CAAC;IACvB,cAAc,KAAW,CAAC;IAC1B,iBAAiB,KAAW,CAAC;IAC7B,gBAAgB,KAAW,CAAC;IAC5B,SAAS,CAAC,mBAA4B,IAAU,CAAC;IACxC,wBAAwB,KAAW,CAAC;IACpC,YAAY,KAAW,CAAC;IACxB,UAAU,KAAW,CAAC;IAC/B,WAAW,KAAW,CAAC;IACd,SAAS,KAAW,CAAC;IACrB,OAAO,KAAW,CAAC;IAC5B,cAAc,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAC3C,UAAU,KAAW,CAAC;IAC7B,IAAW,kBAAkB,KAAuB,OAAO,EAAE,CAAC,CAAC,CAAC;IAChE,IAAW,kBAAkB,CAAC,QAA0B,IAAI,CAAC;CAC9D;KAzB8B,yBAAyB;AA2BxD;;;;GAIG;AACH,MAAM,OAAO,gBAAiB,SAAQ,YAAY;IAChD,IAAW,OAAO,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IACxC,UAAU,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IACvC,YAAY,KAAK,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC,CAAC;IAC3C,qBAAqB,KAAK,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC,CAAC;IACpD,aAAa,KAAK,OAAO,SAAgB,CAAC,CAAC,CAAC;IAC5C,iBAAiB,KAAK,OAAO,SAAgB,CAAC,CAAC,CAAC;IAChD,mBAAmB,KAAK,OAAO,SAAgB,CAAC,CAAC,CAAC;IAClD,WAAW,KAAK,OAAO,SAAgB,CAAC,CAAC,CAAC;IAC1C,OAAO,KAAK,CAAC;IACpB,gBAAuB,KAAK,EAAE,CAAC,CAAC,CAAC;IACjB,mBAAmB,KAAK,OAAO,SAAS,CAAC,CAAC,CAAC;CAC5D;AAED;;;;;GAKG;AACH,MAAM,OAAO,WAAW;IACtB;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAuB;QACjD,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,IAAI,gBAAgB,EAAE,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,iBAAiB,EAAE,CAAC;QACjE,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAChC,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 IModelApp\r\n */\r\n\r\nimport { EmptyLocalization } from \"@itwin/core-common\";\r\nimport { IModelApp, IModelAppOptions } from \"./IModelApp\";\r\nimport { AnimationBranchStates } from \"./render/GraphicBranch\";\r\nimport { RenderSystem } from \"./render/RenderSystem\";\r\nimport { RenderTarget } from \"./render/RenderTarget\";\r\nimport { ViewRect } from \"./common/ViewRect\";\r\nimport { _implementationProhibited } from \"./common/internal/Symbols\";\r\n\r\n/**\r\n * A RenderTarget for applications that must run in environments where WebGL is not present.\r\n * This is typically used in tests.\r\n * @internal\r\n */\r\nexport class NullTarget extends RenderTarget {\r\n  protected override readonly [_implementationProhibited] = undefined;\r\n  public get analysisFraction(): number { return 0; }\r\n  public set analysisFraction(_fraction: number) { }\r\n  public get renderSystem() { return undefined as any; }\r\n  public get viewRect(): ViewRect { return new ViewRect(); }\r\n  public get wantInvertBlackBackground(): boolean { return false; }\r\n  public override get animationBranches(): AnimationBranchStates | undefined { return undefined; }\r\n  public override set animationBranches(_branches: AnimationBranchStates | undefined) { }\r\n  public onDestroy(): void { }\r\n  public override reset(): void { }\r\n  public changeScene(): void { }\r\n  public changeDynamics(): void { }\r\n  public changeDecorations(): void { }\r\n  public changeRenderPlan(): void { }\r\n  public drawFrame(_sceneMilSecElapsed?: number): void { }\r\n  public override overrideFeatureSymbology(): void { }\r\n  public override setHiliteSet(): void { }\r\n  public override setFlashed(): void { }\r\n  public setViewRect(): void { }\r\n  public override onResized(): void { }\r\n  public override dispose(): void { }\r\n  public updateViewRect(): boolean { return false; }\r\n  public readPixels(): void { }\r\n  public get screenSpaceEffects(): Iterable<string> { return []; }\r\n  public set screenSpaceEffects(_effects: Iterable<string>) { }\r\n}\r\n\r\n/**\r\n * A RenderSystem for applications that must run in environments where WebGL is not present.\r\n * This is typically used in tests.\r\n * @internal\r\n */\r\nexport class NullRenderSystem extends RenderSystem {\r\n  public get isValid(): boolean { return false; }\r\n  public doIdleWork(): boolean { return false; }\r\n  public createTarget() { return new NullTarget(); }\r\n  public createOffscreenTarget() { return new NullTarget(); }\r\n  public createGraphic() { return undefined as any; }\r\n  public createGraphicList() { return undefined as any; }\r\n  public createGraphicBranch() { return undefined as any; }\r\n  public createBatch() { return undefined as any; }\r\n  public dispose() { }\r\n  public constructor() { super(); }\r\n  public override createRenderGraphic() { return undefined; }\r\n}\r\n\r\n/** A utility class intended for applications (primarily test-runners) that run in environments that lack support for WebGL.\r\n * It installs a [[RenderSystem]] that produces no graphics.\r\n * Use [[NoRenderApp.startup]] instead of [[IModelApp.startup]] to initialize your application frontend.\r\n * You may then use the [[IModelApp]] API as normal.\r\n * @public\r\n */\r\nexport class NoRenderApp {\r\n  /** Initializes [[IModelApp]] with a [[RenderSystem]] that produces no graphics.\r\n   * Use this in place of [[IModelApp.startup]], then proceed to use [[IModelApp]]'s API as normal.\r\n   */\r\n  public static async startup(opts?: IModelAppOptions): Promise<void> {\r\n    opts = opts ? opts : {};\r\n    opts.renderSys = new NullRenderSystem();\r\n    opts.noRender = true;\r\n    opts.localization = opts.localization ?? new EmptyLocalization();\r\n    await IModelApp.startup(opts);\r\n  }\r\n}\r\n"]}

package/lib/esm/PlanarClipMaskState.d.ts

@@ -5,7 +5,9 @@ import { Id64String } from "@itwin/core-bentley";
 import { PlanarClipMaskProps, PlanarClipMaskSettings } from "@itwin/core-common";
 import { FeatureSymbology } from "./render/FeatureSymbology";
 import { DisclosedTileTreeSet, TileTreeReference } from "./tile/internal";
-import { ViewState3d } from "./ViewState";
+import { SceneContext } from "./ViewContext";
+import { SpatialViewState } from "./SpatialViewState";
+import { Range3d } from "@itwin/core-geometry";
 /** The State of Planar Clip Mask applied to a reality model or background map.
  * Handles loading models and their associated tiles for models that are used by masks but may not be otherwise loaded or displayed.
  * @beta
@@ -14,11 +16,14 @@ export declare class PlanarClipMaskState {
     readonly settings: PlanarClipMaskSettings;
     private _tileTreeRefs?;
     private _allLoaded;
+    private _usingViewportOverrides;
+    private _maskRange;
     private constructor();
     static create(settings: PlanarClipMaskSettings): PlanarClipMaskState;
     static fromJSON(props: PlanarClipMaskProps): PlanarClipMaskState;
+    get usingViewportOverrides(): boolean;
     discloseTileTrees(trees: DisclosedTileTreeSet): void;
-    getTileTrees(view: ViewState3d, classifiedModelId: Id64String): TileTreeReference[] | undefined;
-    getPlanarClipMaskSymbologyOverrides(): FeatureSymbology.Overrides | undefined;
+    getTileTrees(view: SpatialViewState, classifiedModelId: Id64String, maskRange: Range3d): TileTreeReference[] | undefined;
+    getPlanarClipMaskSymbologyOverrides(view: SpatialViewState, context: SceneContext, featureSymbologySource: FeatureSymbology.Source): FeatureSymbology.Overrides | undefined;
 }
 //# sourceMappingURL=PlanarClipMaskState.d.ts.map

package/lib/esm/PlanarClipMaskState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PlanarClipMaskState.d.ts","sourceRoot":"","sources":["../../src/PlanarClipMaskState.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAA8C,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC7H,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAA2B,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACnG,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C;;;GAGG;AACH,qBAAa,mBAAmB;IAC9B,SAAgB,QAAQ,EAAE,sBAAsB,CAAC;IACjD,OAAO,CAAC,aAAa,CAAC,CAAsB;IAC5C,OAAO,CAAC,UAAU,CAAS;IAE3B,OAAO;WAIO,MAAM,CAAC,QAAQ,EAAE,sBAAsB,GAAG,mBAAmB;WAI7D,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,mBAAmB;IAIhE,iBAAiB,CAAC,KAAK,EAAE,oBAAoB,GAAG,IAAI;IAKpD,YAAY,CAAC,IAAI,EAAE,WAAW,EAAE,iBAAiB,EAAE,UAAU,GAAG,iBAAiB,EAAE,GAAG,SAAS;IA+B/F,mCAAmC,IAAI,gBAAgB,CAAC,SAAS,GAAG,SAAS;CA6BrF"}
+{"version":3,"file":"PlanarClipMaskState.d.ts","sourceRoot":"","sources":["../../src/PlanarClipMaskState.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAiE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAChJ,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C;;;GAGG;AACH,qBAAa,mBAAmB;IAC9B,SAAgB,QAAQ,EAAE,sBAAsB,CAAC;IACjD,OAAO,CAAC,aAAa,CAAC,CAAsB;IAC5C,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,uBAAuB,CAAS;IACxC,OAAO,CAAC,UAAU,CAAiC;IAEnD,OAAO;WAIO,MAAM,CAAC,QAAQ,EAAE,sBAAsB,GAAG,mBAAmB;WAI7D,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,mBAAmB;IAIvE,IAAW,sBAAsB,IAAI,OAAO,CAAyC;IAE9E,iBAAiB,CAAC,KAAK,EAAE,oBAAoB,GAAG,IAAI;IAMpD,YAAY,CAAC,IAAI,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,GAAG,iBAAiB,EAAE,GAAG,SAAS;IAgCxH,mCAAmC,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,YAAY,EAAE,sBAAsB,EAAE,gBAAgB,CAAC,MAAM,GAAG,gBAAgB,CAAC,SAAS,GAAG,SAAS;CAoDnL"}

package/lib/esm/PlanarClipMaskState.js

@@ -5,10 +5,9 @@
 /** @packageDocumentation
  * @module Views
  */
-import { assert } from "@itwin/core-bentley";
-import { PlanarClipMaskMode, PlanarClipMaskPriority, PlanarClipMaskSettings } from "@itwin/core-common";
+import { FeatureAppearance, PlanarClipMaskMode, PlanarClipMaskPriority, PlanarClipMaskSettings } from "@itwin/core-common";
 import { FeatureSymbology } from "./render/FeatureSymbology";
-import { createMaskTreeReference } from "./tile/internal";
+import { Range3d } from "@itwin/core-geometry";
 /** The State of Planar Clip Mask applied to a reality model or background map.
  * Handles loading models and their associated tiles for models that are used by masks but may not be otherwise loaded or displayed.
  * @beta
@@ -16,6 +15,8 @@ import { createMaskTreeReference } from "./tile/internal";
 export class PlanarClipMaskState {
     constructor(settings) {
         this._allLoaded = false;
+        this._usingViewportOverrides = false;
+        this._maskRange = Range3d.createNull();
         this.settings = settings;
     }
     static create(settings) {
@@ -24,12 +25,17 @@ export class PlanarClipMaskState {
     static fromJSON(props) {
         return this.create(PlanarClipMaskSettings.fromJSON(props));
     }
+    get usingViewportOverrides() { return this._usingViewportOverrides; }
+    ;
     discloseTileTrees(trees) {
         if (this._tileTreeRefs)
             this._tileTreeRefs.forEach((treeRef) => treeRef.discloseTileTrees(trees));
     }
-    getTileTrees(view, classifiedModelId) {
+    // Returns the TileTreeReferences for the models that need to be drawn to create the planar clip mask, and extend the maskRange if needed.
+    getTileTrees(view, classifiedModelId, maskRange) {
         if (this.settings.mode === PlanarClipMaskMode.Priority) {
+            // For priority mode we simply want refs for all viewed models if the priority is higher than the mask priority.
+            // For this case, we don't need a maskRange so leave it as null.
             const viewTrees = new Array();
             const thisPriority = this.settings.priority === undefined ? PlanarClipMaskPriority.RealityModel : this.settings.priority;
             view.forEachTileTreeRef((ref) => {
@@ -39,38 +45,62 @@ export class PlanarClipMaskState {
             });
             return viewTrees;
         }
-        if (!this._tileTreeRefs) {
+        // For all other modes we need to let the tree refs in the view state decide which refs need to be drawn
+        // since batched tiles cannot turn on/off individual models just by their tile tree refs.
+        // Keep calling this until loaded so that the range is valid.
+        if (!this._allLoaded) {
             this._tileTreeRefs = new Array();
             if (this.settings.modelIds) {
-                for (const modelId of this.settings.modelIds) {
-                    const model = view.iModel.models.getLoaded(modelId);
-                    assert(model !== undefined); // Models should be loaded by RealityModelTileTree
-                    if (model?.asGeometricModel)
-                        this._tileTreeRefs.push(createMaskTreeReference(view, model.asGeometricModel));
-                }
+                view.collectMaskRefs(this.settings.modelIds, this._tileTreeRefs, maskRange);
             }
-        }
-        if (!this._allLoaded)
             this._allLoaded = this._tileTreeRefs.every((treeRef) => treeRef.treeOwner.load() !== undefined);
+            maskRange.clone(this._maskRange);
+        }
+        else // If already loaded, just set the maskRange to the saved maskRange.
+            this._maskRange.clone(maskRange);
         return this._allLoaded ? this._tileTreeRefs : undefined;
     }
-    getPlanarClipMaskSymbologyOverrides() {
-        if (!this.settings.subCategoryOrElementIds)
+    // Returns any potential FeatureSymbology overrides for drawing the planar clip mask.
+    getPlanarClipMaskSymbologyOverrides(view, context, featureSymbologySource) {
+        this._usingViewportOverrides = false;
+        // First obtain a list of models that will need to be turned off for drawing the planar clip mask (only used for batched tile trees).
+        const overrideModels = view.getModelsNotInMask(this.settings.modelIds, PlanarClipMaskMode.Priority === this.settings.mode);
+        const noSubCategoryOrElementIds = !this.settings.subCategoryOrElementIds;
+        if (noSubCategoryOrElementIds && !overrideModels)
             return undefined;
+        const ovrBasedOnContext = PlanarClipMaskMode.Priority === this.settings.mode || PlanarClipMaskMode.Models === this.settings.mode || noSubCategoryOrElementIds;
+        const viewport = overrideModels && ovrBasedOnContext ? context.viewport : undefined;
+        const overrides = FeatureSymbology.Overrides.withSource(featureSymbologySource, viewport);
+        if (overrideModels) {
+            // overrideModels is used for batched models.  For those, we need to create model overrides to turn off models that are
+            // not wanted in the mask (using transparency) no matter what mask mode is being used.
+            const appOff = FeatureAppearance.fromTransparency(1.0);
+            // For Priority or Models mode, we need to start with the current overrides and modify them
+            if (ovrBasedOnContext) {
+                this._usingViewportOverrides = true; // Set flag to use listener since context.viewport might change afterwards.
+                overrides.addInvisibleElementOverridesToNeverDrawn(); // need this for fully trans element overrides to not participate in mask
+                overrideModels.forEach((modelId) => {
+                    overrides.override({ modelId, appearance: appOff, onConflict: "replace" });
+                });
+                return overrides;
+            }
+            // Otherwise, we just start with a default overrides and modify it.
+            overrideModels.forEach((modelId) => {
+                overrides.override({ modelId, appearance: appOff, onConflict: "replace" });
+            });
+        }
+        // Add overrides to turn things on or off based on the subcategories or elements in the mask settings.
         switch (this.settings.mode) {
             case PlanarClipMaskMode.IncludeElements: {
-                const overrides = new FeatureSymbology.Overrides();
                 overrides.setAlwaysDrawnSet(this.settings.subCategoryOrElementIds, true);
                 return overrides;
             }
             case PlanarClipMaskMode.ExcludeElements: {
-                const overrides = new FeatureSymbology.Overrides();
                 overrides.ignoreSubCategory = true;
                 overrides.setNeverDrawnSet(this.settings.subCategoryOrElementIds);
                 return overrides;
             }
             case PlanarClipMaskMode.IncludeSubCategories: {
-                const overrides = new FeatureSymbology.Overrides();
                 for (const subCategoryId of this.settings.subCategoryOrElementIds)
                     overrides.setVisibleSubCategory(subCategoryId);
                 return overrides;

package/lib/esm/PlanarClipMaskState.js.map

@@ -1 +1 @@
-{"version":3,"file":"PlanarClipMaskState.js","sourceRoot":"","sources":["../../src/PlanarClipMaskState.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAc,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAuB,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC7H,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,uBAAuB,EAA2C,MAAM,iBAAiB,CAAC;AAGnG;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAK9B,YAAoB,QAAgC;QAF5C,eAAU,GAAG,KAAK,CAAC;QAGzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,QAAgC;QACnD,OAAO,IAAI,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAA0B;QAC/C,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7D,CAAC;IAEM,iBAAiB,CAAC,KAA2B;QAClD,IAAI,IAAI,CAAC,aAAa;YACpB,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9E,CAAC;IAEM,YAAY,CAAC,IAAiB,EAAE,iBAA6B;QAClE,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,kBAAkB,CAAC,QAAQ,EAAE,CAAC;YACvD,MAAM,SAAS,GAAG,IAAI,KAAK,EAAqB,CAAC;YACjD,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;YACzH,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC9B,MAAM,IAAI,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;gBAClC,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,iBAAiB,IAAI,GAAG,CAAC,sBAAsB,GAAG,YAAY;oBACzF,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC;YAEH,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,IAAI,CAAC,aAAa,GAAG,IAAI,KAAK,EAAqB,CAAC;YACpD,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBAC3B,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;oBAC7C,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;oBACpD,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAG,kDAAkD;oBACjF,IAAI,KAAK,EAAE,gBAAgB;wBACzB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,uBAAuB,CAAC,IAAI,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;gBACnF,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,SAAS,CAAC,CAAC;QAElG,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1D,CAAC;IAEM,mCAAmC;QACxC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,uBAAuB;YACxC,OAAO,SAAS,CAAC;QAEnB,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC3B,KAAK,kBAAkB,CAAC,eAAe,CAAC,CAAC,CAAC;gBACxC,MAAM,SAAS,GAAG,IAAI,gBAAgB,CAAC,SAAS,EAAE,CAAC;gBACnD,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAC;gBACzE,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,KAAK,kBAAkB,CAAC,eAAe,CAAC,CAAC,CAAC;gBACxC,MAAM,SAAS,GAAG,IAAI,gBAAgB,CAAC,SAAS,EAAE,CAAC;gBAEnD,SAAS,CAAC,iBAAiB,GAAG,IAAI,CAAC;gBACnC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC,CAAC;gBAElE,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,KAAK,kBAAkB,CAAC,oBAAoB,CAAC,CAAC,CAAC;gBAC7C,MAAM,SAAS,GAAG,IAAI,gBAAgB,CAAC,SAAS,EAAE,CAAC;gBACnD,KAAK,MAAM,aAAa,IAAI,IAAI,CAAC,QAAQ,CAAC,uBAAuB;oBAC/D,SAAS,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;gBAEjD,OAAO,SAAS,CAAC;YACnB,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,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 Views\r\n */\r\n\r\nimport { assert, Id64String } from \"@itwin/core-bentley\";\r\nimport { PlanarClipMaskMode, PlanarClipMaskPriority, PlanarClipMaskProps, PlanarClipMaskSettings } from \"@itwin/core-common\";\r\nimport { FeatureSymbology } from \"./render/FeatureSymbology\";\r\nimport { createMaskTreeReference, DisclosedTileTreeSet, TileTreeReference } from \"./tile/internal\";\r\nimport { ViewState3d } from \"./ViewState\";\r\n\r\n/** The State of Planar Clip Mask applied to a reality model or background map.\r\n * Handles loading models and their associated tiles for models that are used by masks but may not be otherwise loaded or displayed.\r\n * @beta\r\n */\r\nexport class PlanarClipMaskState {\r\n  public readonly settings: PlanarClipMaskSettings;\r\n  private _tileTreeRefs?: TileTreeReference[];\r\n  private _allLoaded = false;\r\n\r\n  private constructor(settings: PlanarClipMaskSettings) {\r\n    this.settings = settings;\r\n  }\r\n\r\n  public static create(settings: PlanarClipMaskSettings): PlanarClipMaskState {\r\n    return new PlanarClipMaskState(settings);\r\n  }\r\n\r\n  public static fromJSON(props: PlanarClipMaskProps): PlanarClipMaskState {\r\n    return this.create(PlanarClipMaskSettings.fromJSON(props));\r\n  }\r\n\r\n  public discloseTileTrees(trees: DisclosedTileTreeSet): void {\r\n    if (this._tileTreeRefs)\r\n      this._tileTreeRefs.forEach((treeRef) => treeRef.discloseTileTrees(trees));\r\n  }\r\n\r\n  public getTileTrees(view: ViewState3d, classifiedModelId: Id64String): TileTreeReference[] | undefined {\r\n    if (this.settings.mode === PlanarClipMaskMode.Priority) {\r\n      const viewTrees = new Array<TileTreeReference>();\r\n      const thisPriority = this.settings.priority === undefined ? PlanarClipMaskPriority.RealityModel : this.settings.priority;\r\n      view.forEachTileTreeRef((ref) => {\r\n        const tree = ref.treeOwner.load();\r\n        if (tree && tree.modelId !== classifiedModelId && ref.planarclipMaskPriority > thisPriority)\r\n          viewTrees.push(ref);\r\n      });\r\n\r\n      return viewTrees;\r\n    }\r\n\r\n    if (!this._tileTreeRefs) {\r\n      this._tileTreeRefs = new Array<TileTreeReference>();\r\n      if (this.settings.modelIds) {\r\n        for (const modelId of this.settings.modelIds) {\r\n          const model = view.iModel.models.getLoaded(modelId);\r\n          assert(model !== undefined);   // Models should be loaded by RealityModelTileTree\r\n          if (model?.asGeometricModel)\r\n            this._tileTreeRefs.push(createMaskTreeReference(view, model.asGeometricModel));\r\n        }\r\n      }\r\n    }\r\n\r\n    if (!this._allLoaded)\r\n      this._allLoaded = this._tileTreeRefs.every((treeRef) => treeRef.treeOwner.load() !== undefined);\r\n\r\n    return this._allLoaded ? this._tileTreeRefs : undefined;\r\n  }\r\n\r\n  public getPlanarClipMaskSymbologyOverrides(): FeatureSymbology.Overrides | undefined {\r\n    if (!this.settings.subCategoryOrElementIds)\r\n      return undefined;\r\n\r\n    switch (this.settings.mode) {\r\n      case PlanarClipMaskMode.IncludeElements: {\r\n        const overrides = new FeatureSymbology.Overrides();\r\n        overrides.setAlwaysDrawnSet(this.settings.subCategoryOrElementIds, true);\r\n        return overrides;\r\n      }\r\n      case PlanarClipMaskMode.ExcludeElements: {\r\n        const overrides = new FeatureSymbology.Overrides();\r\n\r\n        overrides.ignoreSubCategory = true;\r\n        overrides.setNeverDrawnSet(this.settings.subCategoryOrElementIds);\r\n\r\n        return overrides;\r\n      }\r\n      case PlanarClipMaskMode.IncludeSubCategories: {\r\n        const overrides = new FeatureSymbology.Overrides();\r\n        for (const subCategoryId of this.settings.subCategoryOrElementIds)\r\n          overrides.setVisibleSubCategory(subCategoryId);\r\n\r\n        return overrides;\r\n      }\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"PlanarClipMaskState.js","sourceRoot":"","sources":["../../src/PlanarClipMaskState.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,sBAAsB,EAAuB,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAChJ,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAI7D,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAO9B,YAAoB,QAAgC;QAJ5C,eAAU,GAAG,KAAK,CAAC;QACnB,4BAAuB,GAAG,KAAK,CAAC;QAChC,eAAU,GAAY,OAAO,CAAC,UAAU,EAAE,CAAC;QAGjD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,QAAgC;QACnD,OAAO,IAAI,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAA0B;QAC/C,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,IAAW,sBAAsB,KAAc,OAAO,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC;IAAA,CAAC;IAE/E,iBAAiB,CAAC,KAA2B;QAClD,IAAI,IAAI,CAAC,aAAa;YACpB,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED,0IAA0I;IACnI,YAAY,CAAC,IAAsB,EAAE,iBAA6B,EAAE,SAAkB;QAC3F,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,kBAAkB,CAAC,QAAQ,EAAE,CAAC;YACvD,gHAAgH;YAChH,gEAAgE;YAChE,MAAM,SAAS,GAAG,IAAI,KAAK,EAAqB,CAAC;YACjD,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;YACzH,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC9B,MAAM,IAAI,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;gBAClC,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,iBAAiB,IAAI,GAAG,CAAC,sBAAsB,GAAG,YAAY;oBACzF,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC;YAEH,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,wGAAwG;QACxG,yFAAyF;QACzF,6DAA6D;QAC7D,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,IAAI,CAAC,aAAa,GAAG,IAAI,KAAK,EAAqB,CAAC;YACpD,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBAC3B,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;YAC9E,CAAC;YACD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,SAAS,CAAC,CAAC;YAChG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnC,CAAC;aAAO,oEAAoE;YAC1E,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1D,CAAC;IAED,qFAAqF;IAC9E,mCAAmC,CAAC,IAAsB,EAAE,OAAqB,EAAE,sBAA+C;QACvI,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAC;QACrC,qIAAqI;QACrI,MAAM,cAAc,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAE3H,MAAM,yBAAyB,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC;QACzE,IAAI,yBAAyB,IAAI,CAAC,cAAc;YAC9C,OAAO,SAAS,CAAC;QAEnB,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,kBAAkB,CAAC,MAAM,KAAK,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,yBAAyB,CAAC;QAC9J,MAAM,QAAQ,GAAG,cAAc,IAAI,iBAAiB,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;QACpF,MAAM,SAAS,GAAG,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC;QAE1F,IAAI,cAAc,EAAE,CAAC;YACnB,uHAAuH;YACvH,sFAAsF;YACtF,MAAM,MAAM,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;YACvD,2FAA2F;YAC3F,IAAI,iBAAiB,EAAE,CAAC;gBACtB,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,CAAC,2EAA2E;gBAChH,SAAS,CAAC,wCAAwC,EAAE,CAAC,CAAE,yEAAyE;gBAChI,cAAc,CAAC,OAAO,CAAC,CAAC,OAAe,EAAE,EAAE;oBACzC,SAAS,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;gBAC7E,CAAC,CAAC,CAAC;gBACH,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,mEAAmE;YACnE,cAAc,CAAC,OAAO,CAAC,CAAC,OAAe,EAAE,EAAE;gBACzC,SAAS,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;YAC7E,CAAC,CAAC,CAAC;QACL,CAAC;QAED,sGAAsG;QACtG,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC3B,KAAK,kBAAkB,CAAC,eAAe,CAAC,CAAC,CAAC;gBACxC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,uBAAwB,EAAE,IAAI,CAAC,CAAC;gBAC1E,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,KAAK,kBAAkB,CAAC,eAAe,CAAC,CAAC,CAAC;gBACxC,SAAS,CAAC,iBAAiB,GAAG,IAAI,CAAC;gBACnC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,uBAAwB,CAAC,CAAC;gBACnE,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,KAAK,kBAAkB,CAAC,oBAAoB,CAAC,CAAC,CAAC;gBAC7C,KAAK,MAAM,aAAa,IAAI,IAAI,CAAC,QAAQ,CAAC,uBAAwB;oBAChE,SAAS,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;gBACjD,OAAO,SAAS,CAAC;YACnB,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,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 Views\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { FeatureAppearance, PlanarClipMaskMode, PlanarClipMaskPriority, PlanarClipMaskProps, PlanarClipMaskSettings } from \"@itwin/core-common\";\r\nimport { FeatureSymbology } from \"./render/FeatureSymbology\";\r\nimport { DisclosedTileTreeSet, TileTreeReference } from \"./tile/internal\";\r\nimport { SceneContext } from \"./ViewContext\";\r\nimport { SpatialViewState } from \"./SpatialViewState\";\r\nimport { Range3d } from \"@itwin/core-geometry\";\r\n\r\n/** The State of Planar Clip Mask applied to a reality model or background map.\r\n * Handles loading models and their associated tiles for models that are used by masks but may not be otherwise loaded or displayed.\r\n * @beta\r\n */\r\nexport class PlanarClipMaskState {\r\n  public readonly settings: PlanarClipMaskSettings;\r\n  private _tileTreeRefs?: TileTreeReference[];\r\n  private _allLoaded = false;\r\n  private _usingViewportOverrides = false;\r\n  private _maskRange: Range3d = Range3d.createNull();\r\n\r\n  private constructor(settings: PlanarClipMaskSettings) {\r\n    this.settings = settings;\r\n  }\r\n\r\n  public static create(settings: PlanarClipMaskSettings): PlanarClipMaskState {\r\n    return new PlanarClipMaskState(settings);\r\n  }\r\n\r\n  public static fromJSON(props: PlanarClipMaskProps): PlanarClipMaskState {\r\n    return this.create(PlanarClipMaskSettings.fromJSON(props));\r\n  }\r\n\r\n  public get usingViewportOverrides(): boolean { return this._usingViewportOverrides; };\r\n\r\n  public discloseTileTrees(trees: DisclosedTileTreeSet): void {\r\n    if (this._tileTreeRefs)\r\n      this._tileTreeRefs.forEach((treeRef) => treeRef.discloseTileTrees(trees));\r\n  }\r\n\r\n  // Returns the TileTreeReferences for the models that need to be drawn to create the planar clip mask, and extend the maskRange if needed.\r\n  public getTileTrees(view: SpatialViewState, classifiedModelId: Id64String, maskRange: Range3d): TileTreeReference[] | undefined {\r\n    if (this.settings.mode === PlanarClipMaskMode.Priority) {\r\n      // For priority mode we simply want refs for all viewed models if the priority is higher than the mask priority.\r\n      // For this case, we don't need a maskRange so leave it as null.\r\n      const viewTrees = new Array<TileTreeReference>();\r\n      const thisPriority = this.settings.priority === undefined ? PlanarClipMaskPriority.RealityModel : this.settings.priority;\r\n      view.forEachTileTreeRef((ref) => {\r\n        const tree = ref.treeOwner.load();\r\n        if (tree && tree.modelId !== classifiedModelId && ref.planarclipMaskPriority > thisPriority)\r\n          viewTrees.push(ref);\r\n      });\r\n\r\n      return viewTrees;\r\n    }\r\n\r\n    // For all other modes we need to let the tree refs in the view state decide which refs need to be drawn\r\n    // since batched tiles cannot turn on/off individual models just by their tile tree refs.\r\n    // Keep calling this until loaded so that the range is valid.\r\n    if (!this._allLoaded) {\r\n      this._tileTreeRefs = new Array<TileTreeReference>();\r\n      if (this.settings.modelIds) {\r\n        view.collectMaskRefs(this.settings.modelIds, this._tileTreeRefs, maskRange);\r\n      }\r\n      this._allLoaded = this._tileTreeRefs.every((treeRef) => treeRef.treeOwner.load() !== undefined);\r\n      maskRange.clone(this._maskRange);\r\n    } else  // If already loaded, just set the maskRange to the saved maskRange.\r\n      this._maskRange.clone(maskRange);\r\n\r\n    return this._allLoaded ? this._tileTreeRefs : undefined;\r\n  }\r\n\r\n  // Returns any potential FeatureSymbology overrides for drawing the planar clip mask.\r\n  public getPlanarClipMaskSymbologyOverrides(view: SpatialViewState, context: SceneContext, featureSymbologySource: FeatureSymbology.Source): FeatureSymbology.Overrides | undefined {\r\n    this._usingViewportOverrides = false;\r\n    // First obtain a list of models that will need to be turned off for drawing the planar clip mask (only used for batched tile trees).\r\n    const overrideModels = view.getModelsNotInMask(this.settings.modelIds, PlanarClipMaskMode.Priority === this.settings.mode);\r\n\r\n    const noSubCategoryOrElementIds = !this.settings.subCategoryOrElementIds;\r\n    if (noSubCategoryOrElementIds && !overrideModels)\r\n      return undefined;\r\n\r\n    const ovrBasedOnContext = PlanarClipMaskMode.Priority === this.settings.mode || PlanarClipMaskMode.Models === this.settings.mode || noSubCategoryOrElementIds;\r\n    const viewport = overrideModels && ovrBasedOnContext ? context.viewport : undefined;\r\n    const overrides = FeatureSymbology.Overrides.withSource(featureSymbologySource, viewport);\r\n\r\n    if (overrideModels) {\r\n      // overrideModels is used for batched models.  For those, we need to create model overrides to turn off models that are\r\n      // not wanted in the mask (using transparency) no matter what mask mode is being used.\r\n      const appOff = FeatureAppearance.fromTransparency(1.0);\r\n      // For Priority or Models mode, we need to start with the current overrides and modify them\r\n      if (ovrBasedOnContext) {\r\n        this._usingViewportOverrides = true; // Set flag to use listener since context.viewport might change afterwards.\r\n        overrides.addInvisibleElementOverridesToNeverDrawn();  // need this for fully trans element overrides to not participate in mask\r\n        overrideModels.forEach((modelId: string) => {\r\n          overrides.override({ modelId, appearance: appOff, onConflict: \"replace\" });\r\n        });\r\n        return overrides;\r\n      }\r\n      // Otherwise, we just start with a default overrides and modify it.\r\n      overrideModels.forEach((modelId: string) => {\r\n        overrides.override({ modelId, appearance: appOff, onConflict: \"replace\" });\r\n      });\r\n    }\r\n\r\n    // Add overrides to turn things on or off based on the subcategories or elements in the mask settings.\r\n    switch (this.settings.mode) {\r\n      case PlanarClipMaskMode.IncludeElements: {\r\n        overrides.setAlwaysDrawnSet(this.settings.subCategoryOrElementIds!, true);\r\n        return overrides;\r\n      }\r\n      case PlanarClipMaskMode.ExcludeElements: {\r\n        overrides.ignoreSubCategory = true;\r\n        overrides.setNeverDrawnSet(this.settings.subCategoryOrElementIds!);\r\n        return overrides;\r\n      }\r\n      case PlanarClipMaskMode.IncludeSubCategories: {\r\n        for (const subCategoryId of this.settings.subCategoryOrElementIds!)\r\n          overrides.setVisibleSubCategory(subCategoryId);\r\n        return overrides;\r\n      }\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n}\r\n"]}