@itwin/core-frontend 5.11.0-dev.9 → 5.11.0

package/lib/cjs/IpcApp.js

@@ -93,7 +93,7 @@ class IpcApp {
         throw Object.assign(new core_common_1.BackendError(err.errorNumber, err.iTwinErrorId.key, err.message, err.loggingMetadata), trimErr);
     }
     /** @internal
-     * @deprecated in 4.8 - will not be removed until after 2026-06-13. Use [[makeIpcProxy]] for a type-safe interface.
+     * @deprecated in 4.8 - might be removed in next major version. Use [[makeIpcProxy]] for a type-safe interface.
      */
     static async callIpcChannel(channelName, methodName, ...args) {
         return this[Symbols_1._callIpcChannel](channelName, methodName, ...args);

package/lib/cjs/IpcApp.js.map

@@ -1 +1 @@
-{"version":3,"file":"IpcApp.js","sourceRoot":"","sources":["../../src/IpcApp.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6G;AAC7G,oDAG4B;AAC5B,uDAA4D;AAC5D,2CAA0D;AAU1D;;;GAGG;AACH,MAAa,MAAM;IACT,MAAM,CAAC,IAAI,CAAgC;IAC3C,MAAM,CAAC,gBAAgB,CAA6B;IAC5D,qEAAqE;IAE7D,MAAM,KAAK,GAAG,KAAwB,OAAO,IAAA,4BAAa,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAEhF,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,IAAA,0BAAY,EAAC,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,IAAA,0BAAY,EAAC,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,IAAA,0BAAY,EAAC,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,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,KAAK,CAAC,CAAC,yBAAe,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;QAExF,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS;YAC5B,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,wBAAwB;QAEhD,sDAAsD;QACtD,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC;QACzB,IAAI,CAAC,wBAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,8BAA8B;YAC9B,MAAM,MAAM,CAAC,KAAK,CAAC,CAAC,0DAA0D;QAChF,CAAC;QAED,yIAAyI;QACzI,IAAI,CAAC,2BAAY,CAAC,OAAO,CAAC,GAAG,CAAC;YAC5B,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,EAAE,GAAG,CAAC,CAAC;QAEvG,MAAM,OAAO,GAAG,EAAE,GAAG,GAAG,EAAS,CAAC;QAClC,OAAO,OAAO,CAAC,YAAY,CAAA,CAAC,0EAA0E;QACtG,OAAO,OAAO,CAAC,eAAe,CAAC;QAC/B,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,0BAAY,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC,CAAC;IAC1H,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,WAAmB,EAAE,UAAkB,EAAE,GAAG,IAAW;QACxF,OAAO,IAAI,CAAC,yBAAe,CAAC,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,YAAY,CAA+B,WAAc;QACrE,OAAO,IAAI,KAAK,CAAC,EAAyB,EAAE;YAC1C,GAAG,CAAC,OAAO,EAAE,UAAkB;gBAC7B,OAAO,KAAK,EAAE,GAAG,IAAW,EAAE,EAAE,CAC9B,MAAM,CAAC,yBAAe,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,yBAAe,CAAC,CAAC,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;YAC5E,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED,+EAA+E;IACxE,MAAM,CAAC,cAAc,GAAG,MAAM,CAAC,YAAY,CAAkB,4BAAc,CAAC,SAAS,CAAC,CAAC;IAE9F;qFACiF;IAC1E,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAsB,EAAE,IAAoB;QACtE,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,gBAAgB,GAAG,mBAAmB,CAAC,QAAQ,EAAE,CAAC,CAAC,sCAAsC;QAC9F,MAAM,qBAAS,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,MAAM,qBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;;AAxIH,wBAyIC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAsB,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,yBAAW,CAAC,2BAAY,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;AAvBD,kDAuBC;AAED,wCAAwC;AACxC,MAAM,mBAAoB,SAAQ,mBAAmB;IACnD,IAAW,WAAW,KAAK,OAAO,4BAAc,CAAC,SAAS,CAAC,CAAC,CAAC;IACtD,SAAS,KAAK,CAAC;CACvB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module NativeApp\n */\n\nimport { BentleyError, expectDefined, IModelStatus, JsonUtils, PickAsyncMethods } from \"@itwin/core-bentley\";\nimport {\n  BackendError, IModelError, ipcAppChannels, IpcAppFunctions, IpcAppNotifications, IpcInvokeReturn, IpcListener, IpcSocketFrontend, iTwinChannel,\n  RemoveFunction,\n} from \"@itwin/core-common\";\nimport { _callIpcChannel } from \"./common/internal/Symbols\";\nimport { IModelApp, IModelAppOptions } from \"./IModelApp\";\n\n/**\n * Options for [[IpcApp.startup]]\n * @public\n */\nexport interface IpcAppOptions {\n  iModelApp?: IModelAppOptions;\n}\n\n/**\n * The frontend of apps with a dedicated backend that can use [Ipc]($docs/learning/IpcInterface.md).\n * @public\n */\nexport class IpcApp {\n  private static _ipc: IpcSocketFrontend | undefined;\n  private static _removeAppNotify: RemoveFunction | undefined;\n  /** Get the implementation of the [[IpcSocketFrontend]] interface. */\n\n  private static get ipc(): IpcSocketFrontend { return expectDefined(this._ipc); }\n\n  /** Determine whether Ipc is available for this frontend. This will only be true if [[startup]] has been called on this class. */\n  public static get isValid(): boolean { return undefined !== this._ipc; }\n\n  /**\n   * Establish a message handler function for the supplied channel over Ipc. The handler will be called when messages are sent for\n   * the channel via  [[BackendIpc.send]].\n   * @param channel the name of the channel\n   * @param handler the message handler\n   * @returns A function to remove the handler\n   * @note Ipc is only supported if [[isValid]] is true.\n   */\n  public static addListener(channel: string, handler: IpcListener): RemoveFunction {\n    return this.ipc.addListener(iTwinChannel(channel), handler);\n  }\n\n  /**\n   * Remove a previously registered listener\n   * @param channel The name of the channel for the listener previously registered with [[addListener]]\n   * @param listener The function passed to [[addListener]]\n   */\n  public static removeListener(channel: string, listener: IpcListener) {\n    this.ipc.removeListener(iTwinChannel(channel), listener);\n  }\n\n  /**\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]]\n   * @param channel The name of the channel for the method.\n   * @see Electron [ipcRenderer.invoke](https://www.electronjs.org/docs/api/ipc-renderer) documentation for details.\n   * Note that this interface may be implemented via Electron for desktop apps, or via\n   * [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) for mobile or web-based\n   * Ipc connections. In either case, the Electron documentation provides the specifications for how it works.\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\n   * primitive types and `ArrayBuffers` are allowed.\n   */\n  public static async invoke(channel: string, ...args: any[]): Promise<any> {\n    return this.ipc.invoke(iTwinChannel(channel), ...args);\n  }\n\n  /**\n   * Send a message over the socket.\n   * @param channel The name of the channel for the message.\n   * @param data The optional data of the message.\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\n   * primitive types and `ArrayBuffers` are allowed.\n   */\n  public static send(channel: string, ...data: any[]) {\n    return this.ipc.send(iTwinChannel(channel), ...data);\n  }\n\n  /**\n   * Call a method on the backend through an Ipc channel.\n   * @param channelName the channel registered by the backend handler.\n   * @param methodName  the name of a method implemented by the backend handler.\n   * @param args arguments to `methodName`\n   * @return a Promise with the return value from `methodName`\n   * @note If the backend implementation throws an exception, this method will throw an exception with its contents\n   * @internal Use [[makeIpcProxy]] for a type-safe interface.\n   */\n  public static async [_callIpcChannel](channelName: string, methodName: string, ...args: any[]): Promise<any> {\n    const retVal = (await this.invoke(channelName, methodName, ...args)) as IpcInvokeReturn;\n\n    if (retVal.error === undefined)\n      return retVal.result; // method was successful\n\n    // backend threw an exception, rethrow one on frontend\n    const err = retVal.error;\n    if (!JsonUtils.isObject(err)) {\n      // Exception wasn't an object?\n      throw retVal.error; // eslint-disable-line @typescript-eslint/only-throw-error\n    }\n\n    // Note: for backwards compatibility, if the exception was from a BentleyError on the backend, throw an exception of type `BackendError`.\n    if (!BentleyError.isError(err))\n      throw Object.assign(new Error(typeof err.message === \"string\" ? err.message : \"unknown error\"), err);\n\n    const trimErr = { ...err } as any;\n    delete trimErr.iTwinErrorId // these are methods on BackendError and will cause Object.assign to fail.\n    delete trimErr.loggingMetadata;\n    throw Object.assign(new BackendError(err.errorNumber, err.iTwinErrorId.key, err.message, err.loggingMetadata), trimErr);\n  }\n\n  /** @internal\n   * @deprecated in 4.8 - will not be removed until after 2026-06-13. Use [[makeIpcProxy]] for a type-safe interface.\n   */\n  public static async callIpcChannel(channelName: string, methodName: string, ...args: any[]): Promise<any> {\n    return this[_callIpcChannel](channelName, methodName, ...args);\n  }\n\n  /** Create a type safe Proxy object to make IPC calls to a registered backend interface.\n   * @param channelName the channel registered by the backend handler.\n   */\n  public static makeIpcProxy<K, C extends string = string>(channelName: C): PickAsyncMethods<K> {\n    return new Proxy({} as PickAsyncMethods<K>, {\n      get(_target, methodName: string) {\n        return async (...args: any[]) =>\n          IpcApp[_callIpcChannel](channelName, methodName, ...args);\n      },\n    });\n  }\n\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\n   * @param channelName the channel registered by the backend handler.\n   * @param functionName the function to call on the handler.\n   */\n  public static makeIpcFunctionProxy<K>(channelName: string, functionName: string): PickAsyncMethods<K> {\n    return new Proxy({} as PickAsyncMethods<K>, {\n      get(_target, methodName: string) {\n        return async (...args: any[]) =>\n          IpcApp[_callIpcChannel](channelName, functionName, methodName, ...args);\n      },\n    });\n  }\n\n  /** A Proxy to call one of the [IpcAppFunctions]($common) functions via IPC. */\n  public static appFunctionIpc = IpcApp.makeIpcProxy<IpcAppFunctions>(ipcAppChannels.functions);\n\n  /** start an IpcApp.\n   * @note this should not be called directly. It is called by NativeApp.startup */\n  public static async startup(ipc: IpcSocketFrontend, opts?: IpcAppOptions) {\n    this._ipc = ipc;\n    this._removeAppNotify = IpcAppNotifyHandler.register(); // receives notifications from backend\n    await IModelApp.startup(opts?.iModelApp);\n  }\n\n  /** @internal */\n  public static async shutdown() {\n    this._removeAppNotify?.();\n    this._ipc = undefined;\n    await IModelApp.shutdown();\n  }\n}\n\n/**\n * Base class for all implementations of an Ipc notification response interface. This class is implemented on your frontend to supply\n * methods to receive notifications from your backend.\n *\n * Create a subclass to implement your Ipc response interface. Your class should be declared like this:\n * ```ts\n * class MyNotificationHandler extends NotificationHandler implements MyNotifications\n * ```\n * to ensure all method names and signatures are correct. Your methods cannot have a return value.\n *\n * Then, call `MyNotificationHandler.register` at startup to connect your class to your channel.\n * @public\n * @extensions\n */\nexport abstract class NotificationHandler {\n  /** All subclasses must implement this method to specify their response channel name. */\n  public abstract get channelName(): string;\n\n  public registerImpl(): RemoveFunction {\n    return IpcApp.addListener(this.channelName, (_evt: Event, funcName: string, ...args: any[]) => {\n      const func = (this as any)[funcName];\n      if (typeof func !== \"function\")\n        throw new IModelError(IModelStatus.FunctionNotFound, `Method \"${this.constructor.name}.${funcName}\" not found on NotificationHandler registered for channel: ${this.channelName}`);\n\n      func.call(this, ...args);\n    });\n  }\n\n  /**\n   * Register this class as the handler for notifications on its channel. This static method creates a new instance\n   * that becomes the notification handler and is `this` when its methods are called.\n   * @returns A function that can be called to remove the handler.\n   * @note this method should only be called once per channel. If it is called multiple times, multiple handlers are established.\n   */\n  public static register(): RemoveFunction {\n    return (new (this as any)() as NotificationHandler).registerImpl(); // create an instance of subclass. \"as any\" is necessary because base class is abstract\n  }\n}\n\n/** IpcApp notifications from backend */\nclass IpcAppNotifyHandler extends NotificationHandler implements IpcAppNotifications {\n  public get channelName() { return ipcAppChannels.appNotify; }\n  public notifyApp() { }\n}\n"]}
+{"version":3,"file":"IpcApp.js","sourceRoot":"","sources":["../../src/IpcApp.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6G;AAC7G,oDAG4B;AAC5B,uDAA4D;AAC5D,2CAA0D;AAU1D;;;GAGG;AACH,MAAa,MAAM;IACT,MAAM,CAAC,IAAI,CAAgC;IAC3C,MAAM,CAAC,gBAAgB,CAA6B;IAC5D,qEAAqE;IAE7D,MAAM,KAAK,GAAG,KAAwB,OAAO,IAAA,4BAAa,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAEhF,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,IAAA,0BAAY,EAAC,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,IAAA,0BAAY,EAAC,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,IAAA,0BAAY,EAAC,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,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,KAAK,CAAC,CAAC,yBAAe,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;QAExF,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS;YAC5B,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,wBAAwB;QAEhD,sDAAsD;QACtD,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC;QACzB,IAAI,CAAC,wBAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,8BAA8B;YAC9B,MAAM,MAAM,CAAC,KAAK,CAAC,CAAC,0DAA0D;QAChF,CAAC;QAED,yIAAyI;QACzI,IAAI,CAAC,2BAAY,CAAC,OAAO,CAAC,GAAG,CAAC;YAC5B,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,EAAE,GAAG,CAAC,CAAC;QAEvG,MAAM,OAAO,GAAG,EAAE,GAAG,GAAG,EAAS,CAAC;QAClC,OAAO,OAAO,CAAC,YAAY,CAAA,CAAC,0EAA0E;QACtG,OAAO,OAAO,CAAC,eAAe,CAAC;QAC/B,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,0BAAY,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC,CAAC;IAC1H,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,WAAmB,EAAE,UAAkB,EAAE,GAAG,IAAW;QACxF,OAAO,IAAI,CAAC,yBAAe,CAAC,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,YAAY,CAA+B,WAAc;QACrE,OAAO,IAAI,KAAK,CAAC,EAAyB,EAAE;YAC1C,GAAG,CAAC,OAAO,EAAE,UAAkB;gBAC7B,OAAO,KAAK,EAAE,GAAG,IAAW,EAAE,EAAE,CAC9B,MAAM,CAAC,yBAAe,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,yBAAe,CAAC,CAAC,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;YAC5E,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED,+EAA+E;IACxE,MAAM,CAAC,cAAc,GAAG,MAAM,CAAC,YAAY,CAAkB,4BAAc,CAAC,SAAS,CAAC,CAAC;IAE9F;qFACiF;IAC1E,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAsB,EAAE,IAAoB;QACtE,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,gBAAgB,GAAG,mBAAmB,CAAC,QAAQ,EAAE,CAAC,CAAC,sCAAsC;QAC9F,MAAM,qBAAS,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,MAAM,qBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;;AAxIH,wBAyIC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAsB,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,yBAAW,CAAC,2BAAY,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;AAvBD,kDAuBC;AAED,wCAAwC;AACxC,MAAM,mBAAoB,SAAQ,mBAAmB;IACnD,IAAW,WAAW,KAAK,OAAO,4BAAc,CAAC,SAAS,CAAC,CAAC,CAAC;IACtD,SAAS,KAAK,CAAC;CACvB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module NativeApp\n */\n\nimport { BentleyError, expectDefined, IModelStatus, JsonUtils, PickAsyncMethods } from \"@itwin/core-bentley\";\nimport {\n  BackendError, IModelError, ipcAppChannels, IpcAppFunctions, IpcAppNotifications, IpcInvokeReturn, IpcListener, IpcSocketFrontend, iTwinChannel,\n  RemoveFunction,\n} from \"@itwin/core-common\";\nimport { _callIpcChannel } from \"./common/internal/Symbols\";\nimport { IModelApp, IModelAppOptions } from \"./IModelApp\";\n\n/**\n * Options for [[IpcApp.startup]]\n * @public\n */\nexport interface IpcAppOptions {\n  iModelApp?: IModelAppOptions;\n}\n\n/**\n * The frontend of apps with a dedicated backend that can use [Ipc]($docs/learning/IpcInterface.md).\n * @public\n */\nexport class IpcApp {\n  private static _ipc: IpcSocketFrontend | undefined;\n  private static _removeAppNotify: RemoveFunction | undefined;\n  /** Get the implementation of the [[IpcSocketFrontend]] interface. */\n\n  private static get ipc(): IpcSocketFrontend { return expectDefined(this._ipc); }\n\n  /** Determine whether Ipc is available for this frontend. This will only be true if [[startup]] has been called on this class. */\n  public static get isValid(): boolean { return undefined !== this._ipc; }\n\n  /**\n   * Establish a message handler function for the supplied channel over Ipc. The handler will be called when messages are sent for\n   * the channel via  [[BackendIpc.send]].\n   * @param channel the name of the channel\n   * @param handler the message handler\n   * @returns A function to remove the handler\n   * @note Ipc is only supported if [[isValid]] is true.\n   */\n  public static addListener(channel: string, handler: IpcListener): RemoveFunction {\n    return this.ipc.addListener(iTwinChannel(channel), handler);\n  }\n\n  /**\n   * Remove a previously registered listener\n   * @param channel The name of the channel for the listener previously registered with [[addListener]]\n   * @param listener The function passed to [[addListener]]\n   */\n  public static removeListener(channel: string, listener: IpcListener) {\n    this.ipc.removeListener(iTwinChannel(channel), listener);\n  }\n\n  /**\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]]\n   * @param channel The name of the channel for the method.\n   * @see Electron [ipcRenderer.invoke](https://www.electronjs.org/docs/api/ipc-renderer) documentation for details.\n   * Note that this interface may be implemented via Electron for desktop apps, or via\n   * [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) for mobile or web-based\n   * Ipc connections. In either case, the Electron documentation provides the specifications for how it works.\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\n   * primitive types and `ArrayBuffers` are allowed.\n   */\n  public static async invoke(channel: string, ...args: any[]): Promise<any> {\n    return this.ipc.invoke(iTwinChannel(channel), ...args);\n  }\n\n  /**\n   * Send a message over the socket.\n   * @param channel The name of the channel for the message.\n   * @param data The optional data of the message.\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\n   * primitive types and `ArrayBuffers` are allowed.\n   */\n  public static send(channel: string, ...data: any[]) {\n    return this.ipc.send(iTwinChannel(channel), ...data);\n  }\n\n  /**\n   * Call a method on the backend through an Ipc channel.\n   * @param channelName the channel registered by the backend handler.\n   * @param methodName  the name of a method implemented by the backend handler.\n   * @param args arguments to `methodName`\n   * @return a Promise with the return value from `methodName`\n   * @note If the backend implementation throws an exception, this method will throw an exception with its contents\n   * @internal Use [[makeIpcProxy]] for a type-safe interface.\n   */\n  public static async [_callIpcChannel](channelName: string, methodName: string, ...args: any[]): Promise<any> {\n    const retVal = (await this.invoke(channelName, methodName, ...args)) as IpcInvokeReturn;\n\n    if (retVal.error === undefined)\n      return retVal.result; // method was successful\n\n    // backend threw an exception, rethrow one on frontend\n    const err = retVal.error;\n    if (!JsonUtils.isObject(err)) {\n      // Exception wasn't an object?\n      throw retVal.error; // eslint-disable-line @typescript-eslint/only-throw-error\n    }\n\n    // Note: for backwards compatibility, if the exception was from a BentleyError on the backend, throw an exception of type `BackendError`.\n    if (!BentleyError.isError(err))\n      throw Object.assign(new Error(typeof err.message === \"string\" ? err.message : \"unknown error\"), err);\n\n    const trimErr = { ...err } as any;\n    delete trimErr.iTwinErrorId // these are methods on BackendError and will cause Object.assign to fail.\n    delete trimErr.loggingMetadata;\n    throw Object.assign(new BackendError(err.errorNumber, err.iTwinErrorId.key, err.message, err.loggingMetadata), trimErr);\n  }\n\n  /** @internal\n   * @deprecated in 4.8 - might be removed in next major version. Use [[makeIpcProxy]] for a type-safe interface.\n   */\n  public static async callIpcChannel(channelName: string, methodName: string, ...args: any[]): Promise<any> {\n    return this[_callIpcChannel](channelName, methodName, ...args);\n  }\n\n  /** Create a type safe Proxy object to make IPC calls to a registered backend interface.\n   * @param channelName the channel registered by the backend handler.\n   */\n  public static makeIpcProxy<K, C extends string = string>(channelName: C): PickAsyncMethods<K> {\n    return new Proxy({} as PickAsyncMethods<K>, {\n      get(_target, methodName: string) {\n        return async (...args: any[]) =>\n          IpcApp[_callIpcChannel](channelName, methodName, ...args);\n      },\n    });\n  }\n\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\n   * @param channelName the channel registered by the backend handler.\n   * @param functionName the function to call on the handler.\n   */\n  public static makeIpcFunctionProxy<K>(channelName: string, functionName: string): PickAsyncMethods<K> {\n    return new Proxy({} as PickAsyncMethods<K>, {\n      get(_target, methodName: string) {\n        return async (...args: any[]) =>\n          IpcApp[_callIpcChannel](channelName, functionName, methodName, ...args);\n      },\n    });\n  }\n\n  /** A Proxy to call one of the [IpcAppFunctions]($common) functions via IPC. */\n  public static appFunctionIpc = IpcApp.makeIpcProxy<IpcAppFunctions>(ipcAppChannels.functions);\n\n  /** start an IpcApp.\n   * @note this should not be called directly. It is called by NativeApp.startup */\n  public static async startup(ipc: IpcSocketFrontend, opts?: IpcAppOptions) {\n    this._ipc = ipc;\n    this._removeAppNotify = IpcAppNotifyHandler.register(); // receives notifications from backend\n    await IModelApp.startup(opts?.iModelApp);\n  }\n\n  /** @internal */\n  public static async shutdown() {\n    this._removeAppNotify?.();\n    this._ipc = undefined;\n    await IModelApp.shutdown();\n  }\n}\n\n/**\n * Base class for all implementations of an Ipc notification response interface. This class is implemented on your frontend to supply\n * methods to receive notifications from your backend.\n *\n * Create a subclass to implement your Ipc response interface. Your class should be declared like this:\n * ```ts\n * class MyNotificationHandler extends NotificationHandler implements MyNotifications\n * ```\n * to ensure all method names and signatures are correct. Your methods cannot have a return value.\n *\n * Then, call `MyNotificationHandler.register` at startup to connect your class to your channel.\n * @public\n * @extensions\n */\nexport abstract class NotificationHandler {\n  /** All subclasses must implement this method to specify their response channel name. */\n  public abstract get channelName(): string;\n\n  public registerImpl(): RemoveFunction {\n    return IpcApp.addListener(this.channelName, (_evt: Event, funcName: string, ...args: any[]) => {\n      const func = (this as any)[funcName];\n      if (typeof func !== \"function\")\n        throw new IModelError(IModelStatus.FunctionNotFound, `Method \"${this.constructor.name}.${funcName}\" not found on NotificationHandler registered for channel: ${this.channelName}`);\n\n      func.call(this, ...args);\n    });\n  }\n\n  /**\n   * Register this class as the handler for notifications on its channel. This static method creates a new instance\n   * that becomes the notification handler and is `this` when its methods are called.\n   * @returns A function that can be called to remove the handler.\n   * @note this method should only be called once per channel. If it is called multiple times, multiple handlers are established.\n   */\n  public static register(): RemoveFunction {\n    return (new (this as any)() as NotificationHandler).registerImpl(); // create an instance of subclass. \"as any\" is necessary because base class is abstract\n  }\n}\n\n/** IpcApp notifications from backend */\nclass IpcAppNotifyHandler extends NotificationHandler implements IpcAppNotifications {\n  public get channelName() { return ipcAppChannels.appNotify; }\n  public notifyApp() { }\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"NativeApp.d.ts","sourceRoot":"","sources":["../../src/NativeApp.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,UAAU,EAAU,MAAM,qBAAqB,CAAC;AAClE,OAAO,EACL,mBAAmB,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,EAAE,0BAA0B,EAAE,iBAAiB,EAAE,mBAAmB,EACrI,kBAAkB,EACwB,YAAY,EAAE,QAAQ,EACjE,MAAM,oBAAoB,CAAC;AAE5B,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,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAiB;IAEjD,kFAAkF;IAClF,OAAc,YAAY,qEAA4E;IACtG,OAAc,UAAU,2EAAgG;IAExH,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;IA2CrD,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;IAU/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,OAAO,EAAE,UAAU,EAAU,MAAM,qBAAqB,CAAC;AAClE,OAAO,EACL,mBAAmB,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,EAAE,0BAA0B,EAAE,iBAAiB,EAAE,mBAAmB,EACrI,kBAAkB,EACwB,YAAY,EAAE,QAAQ,EACjE,MAAM,oBAAoB,CAAC;AAE5B,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,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAiB;IAEjD,kFAAkF;IAClF,OAAc,YAAY,qEAA4E;IACtG,OAAc,UAAU,2EAAgG;IAExH,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;IAaxE,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;IA2CrD,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;IAU/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/cjs/NativeApp.js

@@ -77,9 +77,7 @@ class NativeApp {
         this._removeAppNotify = NativeAppNotifyHandler.register(); // receives notifications from backend
         NativeApp.hookBrowserConnectivityEvents();
         // initialize current online state.
-        if (window.navigator.onLine) {
-            await this.setConnectivity(core_common_1.OverriddenBy.Browser, window.navigator.onLine ? core_common_1.InternetConnectivityStatus.Online : core_common_1.InternetConnectivityStatus.Offline);
-        }
+        await this.setConnectivity(core_common_1.OverriddenBy.Browser, window.navigator.onLine ? core_common_1.InternetConnectivityStatus.Online : core_common_1.InternetConnectivityStatus.Offline);
     }
     /** @internal */
     static async shutdown() {

package/lib/cjs/NativeApp.js.map

@@ -1 +1 @@
-{"version":3,"file":"NativeApp.js","sourceRoot":"","sources":["../../src/NativeApp.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkE;AAClE,oDAI4B;AAC5B,4EAAyE;AACzE,qCAAsE;AACtE,uDAAoD;AAyBpD,2CAA2C;AAC3C,MAAM,sBAAuB,SAAQ,4BAAmB;IACtD,IAAW,WAAW,KAAK,OAAO,iCAAmB,CAAC,aAAa,CAAC,CAAC,CAAC;IAC/D,iCAAiC,CAAC,MAAkC;QACzE,qBAAM,CAAC,OAAO,CAAC,+CAAsB,CAAC,SAAS,EAAE,+BAA+B,CAAC,CAAC;QAClF,SAAS,CAAC,6BAA6B,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC;CACF;AAUD;;;;GAIG;AACH,MAAa,SAAS;IACZ,MAAM,CAAC,gBAAgB,CAAkB;IAEjD,kFAAkF;IAC3E,MAAM,CAAC,YAAY,GAAG,eAAM,CAAC,YAAY,CAAqB,iCAAmB,CAAC,WAAW,CAAC,CAAC;IAC/F,MAAM,CAAC,UAAU,GAAG,eAAM,CAAC,YAAY,CAAqD,mBAAmB,CAAC,CAAC;IAEhH,MAAM,CAAC,SAAS,GAAG,IAAI,GAAG,EAAmB,CAAC;IAC9C,MAAM,CAAC,SAAS,GAAG,KAAK,IAAI,EAAE;QACpC,MAAM,SAAS,CAAC,eAAe,CAAC,0BAAY,CAAC,OAAO,EAAE,wCAA0B,CAAC,MAAM,CAAC,CAAC;IAC3F,CAAC,CAAC;IACM,MAAM,CAAC,UAAU,GAAG,KAAK,IAAI,EAAE;QACrC,MAAM,SAAS,CAAC,eAAe,CAAC,0BAAY,CAAC,OAAO,EAAE,wCAA0B,CAAC,OAAO,CAAC,CAAC;IAC5F,CAAC,CAAC;IACM,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;IACD,gEAAgE;IACzD,MAAM,CAAC,6BAA6B,GAAG,IAAI,sBAAO,EAAgD,CAAC;IAE1G,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,0BAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACnF,CAAC;IACO,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC;IACzB,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,eAAM,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,SAAS,CAAC,6BAA6B,EAAE,CAAC;QAE1C,mCAAmC;QACnC,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YAC5B,MAAM,IAAI,CAAC,eAAe,CAAC,0BAAY,CAAC,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,wCAA0B,CAAC,MAAM,CAAC,CAAC,CAAC,wCAA0B,CAAC,OAAO,CAAC,CAAC;QACrJ,CAAC;IACH,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC;QAC1B,SAAS,CAAC,+BAA+B,EAAE,CAAC;QAC5C,MAAM,iCAAe,CAAC,KAAK,EAAE,CAAC;QAC9B,MAAM,eAAM,CAAC,QAAQ,EAAE,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,CAAC;IAKM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAC1C,OAAe,EACf,QAAgB,EAChB,eAAyC,EACzC,OAAsB,2BAAa,CAAC,MAAM,EAAE;QAE5C,MAAM,oBAAoB,GAAG,CAAC,CAAC,eAAe,CAAC,gBAAgB,CAAC;QAEhE,IAAI,kBAAkB,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;QACnC,IAAI,oBAAoB,EAAE,CAAC;YACzB,MAAM,cAAc,GAAG,CAAC,IAAW,EAAE,IAAuC,EAAE,EAAE;gBAC9E,eAAe,CAAC,gBAAgB,EAAE,CAAC,IAAI,CAAC,CAAC;YAC3C,CAAC,CAAC;YAEF,kBAAkB,GAAG,eAAM,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,sBAAQ,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,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,GAAG,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;YACpE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAC1C,CAAC;QAED,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,SAAS,CAAC,YAAY,CAAC,eAAe,EAAE,CAAC;IAClD,CAAC;;AAnKH,8BAoKC;AAED;;;;GAIG;AACH,MAAa,OAAO;IACU;IAA5B,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;AAnCD,0BAmCC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module NativeApp\n */\n\nimport { BeEvent, GuidString, Logger } from \"@itwin/core-bentley\";\nimport {\n  BriefcaseDownloader, BriefcaseProps, CatalogIModel, IModelVersion, InternetConnectivityStatus, IpcSocketFrontend, LocalBriefcaseProps,\n  NativeAppFunctions, nativeAppIpcStrings, NativeAppNotifications, OverriddenBy,\n  RemoveFunction, RequestNewBriefcaseProps, StorageValue, SyncMode,\n} from \"@itwin/core-common\";\nimport { FrontendLoggerCategory } from \"./common/FrontendLoggerCategory\";\nimport { IpcApp, IpcAppOptions, NotificationHandler } from \"./IpcApp\";\nimport { NativeAppLogger } from \"./NativeAppLogger\";\nimport { OnDownloadProgress } from \"./BriefcaseConnection\";\nimport { _callIpcChannel } from \"./common/internal/Symbols\";\n\n/** Properties for specifying the BriefcaseId for downloading. May either specify a BriefcaseId directly (preferable) or, for\n * backwards compatibility, a [SyncMode]($common). If [SyncMode.PullAndPush]($common) is supplied, a new briefcaseId will be acquired.\n * @public\n */\nexport type DownloadBriefcaseId =\n  { syncMode?: SyncMode, briefcaseId?: never } |\n  { briefcaseId: number, syncMode?: never };\n\n/**\n* Options to download a briefcase\n* @public\n*/\nexport type DownloadBriefcaseOptions = DownloadBriefcaseId & {\n  /** the full path for the briefcase file */\n  fileName?: string;\n  /** Function called regularly to report progress of download. */\n  progressCallback?: OnDownloadProgress;\n  /** interval for calling progress function, in milliseconds */\n  progressInterval?: number;\n};\n\n/** NativeApp notifications from backend */\nclass NativeAppNotifyHandler extends NotificationHandler implements NativeAppNotifications {\n  public get channelName() { return nativeAppIpcStrings.notifyChannel; }\n  public notifyInternetConnectivityChanged(status: InternetConnectivityStatus) {\n    Logger.logInfo(FrontendLoggerCategory.NativeApp, \"Internet connectivity changed\");\n    NativeApp.onInternetConnectivityChanged.raiseEvent(status);\n  }\n}\n\n/**\n * Options for [[NativeApp.startup]]\n * @public\n */\nexport interface NativeAppOpts extends IpcAppOptions {\n  nativeApp?: object;\n}\n\n/**\n * The frontend of a native application\n * @see [Native Applications]($docs/learning/NativeApps.md)\n * @public\n */\nexport class NativeApp {\n  private static _removeAppNotify?: RemoveFunction;\n\n  /** A Proxy to call one of the [NativeAppFunctions]($common) functions via IPC. */\n  public static nativeAppIpc = IpcApp.makeIpcProxy<NativeAppFunctions>(nativeAppIpcStrings.channelName);\n  public static catalogIpc = IpcApp.makeIpcProxy<CatalogIModel.IpcMethods, CatalogIModel.IpcChannel>(\"catalogIModel/ipc\");\n\n  private static _storages = new Map<string, Storage>();\n  private static _onOnline = async () => {\n    await NativeApp.setConnectivity(OverriddenBy.Browser, InternetConnectivityStatus.Online);\n  };\n  private static _onOffline = async () => {\n    await NativeApp.setConnectivity(OverriddenBy.Browser, InternetConnectivityStatus.Offline);\n  };\n  private static async setConnectivity(by: OverriddenBy, status: InternetConnectivityStatus) {\n    await this.nativeAppIpc.overrideInternetConnectivity(by, status);\n  }\n  private static hookBrowserConnectivityEvents() {\n    if (typeof window === \"object\" && window.ononline && window.onoffline) {\n      window.addEventListener(\"online\", this._onOnline);\n      window.addEventListener(\"offline\", this._onOffline);\n    }\n  }\n  private static unhookBrowserConnectivityEvents() {\n    if (typeof window === \"object\" && window.ononline && window.onoffline) {\n      window.removeEventListener(\"online\", this._onOnline);\n      window.removeEventListener(\"offline\", this._onOffline);\n    }\n  }\n  /** event called when internet connectivity changes, if known */\n  public static onInternetConnectivityChanged = new BeEvent<(status: InternetConnectivityStatus) => void>();\n\n  /** determine whether the app currently has internet connectivity, if known */\n  public static async checkInternetConnectivity(): Promise<InternetConnectivityStatus> {\n    return this.nativeAppIpc.checkInternetConnectivity();\n  }\n  /** @internal */\n  public static async overrideInternetConnectivity(status: InternetConnectivityStatus): Promise<void> {\n    return this.nativeAppIpc.overrideInternetConnectivity(OverriddenBy.User, status);\n  }\n  private static _isValid = false;\n  public static get isValid(): boolean { return this._isValid; }\n\n  /**\n   * This is called by either ElectronApp.startup or MobileApp.startup - it should not be called directly\n   * @internal\n   */\n  public static async startup(ipc: IpcSocketFrontend, opts?: NativeAppOpts) {\n    await IpcApp.startup(ipc, opts);\n    if (this._isValid)\n      return;\n    this._isValid = true;\n\n    this._removeAppNotify = NativeAppNotifyHandler.register(); // receives notifications from backend\n    NativeApp.hookBrowserConnectivityEvents();\n\n    // initialize current online state.\n    if (window.navigator.onLine) {\n      await this.setConnectivity(OverriddenBy.Browser, window.navigator.onLine ? InternetConnectivityStatus.Online : InternetConnectivityStatus.Offline);\n    }\n  }\n\n  /** @internal */\n  public static async shutdown() {\n    this._removeAppNotify?.();\n    NativeApp.unhookBrowserConnectivityEvents();\n    await NativeAppLogger.flush();\n    await IpcApp.shutdown();\n    this._isValid = false;\n  }\n\n  public static async requestDownloadBriefcase(iTwinId: string, iModelId: string, downloadOptions: DownloadBriefcaseOptions,\n    asOf?: IModelVersion): Promise<BriefcaseDownloader>;\n\n  public static async requestDownloadBriefcase(\n    iTwinId: string,\n    iModelId: string,\n    downloadOptions: DownloadBriefcaseOptions,\n    asOf: IModelVersion = IModelVersion.latest()\n  ): Promise<BriefcaseDownloader> {\n    const shouldReportProgress = !!downloadOptions.progressCallback;\n\n    let stopProgressEvents = () => { };\n    if (shouldReportProgress) {\n      const handleProgress = (_evt: Event, data: { loaded: number, total: number }) => {\n        downloadOptions.progressCallback?.(data);\n      };\n\n      stopProgressEvents = IpcApp.addListener(`nativeApp.progress-${iModelId}`, handleProgress);\n    }\n\n    const briefcaseId = (undefined !== downloadOptions.briefcaseId) ? downloadOptions.briefcaseId :\n      (downloadOptions.syncMode === SyncMode.PullOnly ? 0 : await this.nativeAppIpc.acquireNewBriefcaseId(iModelId));\n\n    const fileName = downloadOptions.fileName ?? await this.getBriefcaseFileName({ briefcaseId, iModelId });\n    const requestProps: RequestNewBriefcaseProps = { iModelId, briefcaseId, iTwinId, asOf: asOf.toJSON(), fileName };\n\n    const doDownload = async (): Promise<void> => {\n      try {\n        await this.nativeAppIpc.downloadBriefcase(requestProps, shouldReportProgress, downloadOptions.progressInterval);\n      } finally {\n        stopProgressEvents();\n      }\n    };\n\n    const requestCancel = async (): Promise<boolean> => {\n      const status = await this.nativeAppIpc.requestCancelDownloadBriefcase(fileName);\n      if (status)\n        stopProgressEvents();\n      return status;\n    };\n\n    return { briefcaseId, fileName, downloadPromise: doDownload(), requestCancel };\n  }\n\n  /** Get the full path filename for a briefcase within the briefcase cache */\n  public static async getBriefcaseFileName(props: BriefcaseProps): Promise<string> {\n    return this.nativeAppIpc.getBriefcaseFileName(props);\n  }\n\n  /** Delete an existing briefcase\n   * @param fileName the briefcase fileName\n   */\n  public static async deleteBriefcase(fileName: string): Promise<void> {\n    await this.nativeAppIpc.deleteBriefcaseFiles(fileName);\n  }\n\n  /** Get a list of all briefcase files held in the local briefcase cache directory */\n  public static async getCachedBriefcases(iModelId?: GuidString): Promise<LocalBriefcaseProps[]> {\n    return this.nativeAppIpc.getCachedBriefcases(iModelId);\n  }\n\n  /**\n   * Open a [[Storage]]. Creates a new Storage with that name if it does not already exist.\n   * @param name Should be a local filename without an extension.\n   * @returns a Promise for the [[Storage]].\n   */\n  public static async openStorage(name: string): Promise<Storage> {\n    let storage = this._storages.get(name);\n    if (!storage) {\n      storage = new Storage(await this.nativeAppIpc.storageMgrOpen(name));\n      this._storages.set(storage.id, storage);\n    }\n    \n    return storage;\n  }\n\n  /**\n   * Close a Storage and optionally delete it.\n   * @param storage normally not call directly instead use Storage.close()\n   * @param deleteStorage if true, delete the storage from disk after closing it.\n   */\n  public static async closeStorage(storage: Storage, deleteStorage: boolean = false): Promise<void> {\n    if (!this._storages.has(storage.id))\n      throw new Error(`Storage [Id=${storage.id}] not open`);\n\n    await this.nativeAppIpc.storageMgrClose(storage.id, deleteStorage);\n    this._storages.delete(storage.id);\n  }\n\n  /** Get the list of existing Storages on the local disk. */\n  public static async getStorageNames(): Promise<string[]> {\n    return NativeApp.nativeAppIpc.storageMgrNames();\n  }\n}\n\n/**\n *  A local disk-based cache for key value pairs for NativeApps.\n * @note This should be used only for local caching, since its not guaranteed to exist permanently.\n * @public\n */\nexport class Storage {\n  constructor(public readonly id: string) { }\n\n  /** get the type of a value for a key, or undefined if not present. */\n  public async getValueType(key: string): Promise<\"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined> {\n    return NativeApp.nativeAppIpc.storageGetValueType(this.id, key);\n  }\n\n  /** Get the value for a key */\n  public async getData(key: string): Promise<StorageValue> {\n    return NativeApp.nativeAppIpc.storageGet(this.id, key);\n  }\n\n  /** Set value for a key */\n  public async setData(key: string, value: StorageValue): Promise<void> {\n    return NativeApp.nativeAppIpc.storageSet(this.id, key, value);\n  }\n\n  /**\n   * Return an array of all keys in this Storage.\n   * @note This can be expensive, depending on the number of keys present.\n   */\n  public async getKeys(): Promise<string[]> {\n    return NativeApp.nativeAppIpc.storageKeys(this.id);\n  }\n\n  /** Remove a key and its data. */\n  public async removeData(key: string): Promise<void> {\n    return NativeApp.nativeAppIpc.storageRemove(this.id, key);\n  }\n\n  /** Remove all keys and their data. */\n  public async removeAll(): Promise<void> {\n    return NativeApp.nativeAppIpc.storageRemoveAll(this.id);\n  }\n}\n"]}
+{"version":3,"file":"NativeApp.js","sourceRoot":"","sources":["../../src/NativeApp.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkE;AAClE,oDAI4B;AAC5B,4EAAyE;AACzE,qCAAsE;AACtE,uDAAoD;AAyBpD,2CAA2C;AAC3C,MAAM,sBAAuB,SAAQ,4BAAmB;IACtD,IAAW,WAAW,KAAK,OAAO,iCAAmB,CAAC,aAAa,CAAC,CAAC,CAAC;IAC/D,iCAAiC,CAAC,MAAkC;QACzE,qBAAM,CAAC,OAAO,CAAC,+CAAsB,CAAC,SAAS,EAAE,+BAA+B,CAAC,CAAC;QAClF,SAAS,CAAC,6BAA6B,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC;CACF;AAUD;;;;GAIG;AACH,MAAa,SAAS;IACZ,MAAM,CAAC,gBAAgB,CAAkB;IAEjD,kFAAkF;IAC3E,MAAM,CAAC,YAAY,GAAG,eAAM,CAAC,YAAY,CAAqB,iCAAmB,CAAC,WAAW,CAAC,CAAC;IAC/F,MAAM,CAAC,UAAU,GAAG,eAAM,CAAC,YAAY,CAAqD,mBAAmB,CAAC,CAAC;IAEhH,MAAM,CAAC,SAAS,GAAG,IAAI,GAAG,EAAmB,CAAC;IAC9C,MAAM,CAAC,SAAS,GAAG,KAAK,IAAI,EAAE;QACpC,MAAM,SAAS,CAAC,eAAe,CAAC,0BAAY,CAAC,OAAO,EAAE,wCAA0B,CAAC,MAAM,CAAC,CAAC;IAC3F,CAAC,CAAC;IACM,MAAM,CAAC,UAAU,GAAG,KAAK,IAAI,EAAE;QACrC,MAAM,SAAS,CAAC,eAAe,CAAC,0BAAY,CAAC,OAAO,EAAE,wCAA0B,CAAC,OAAO,CAAC,CAAC;IAC5F,CAAC,CAAC;IACM,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;IACD,gEAAgE;IACzD,MAAM,CAAC,6BAA6B,GAAG,IAAI,sBAAO,EAAgD,CAAC;IAE1G,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,0BAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACnF,CAAC;IACO,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC;IACzB,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,eAAM,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,SAAS,CAAC,6BAA6B,EAAE,CAAC;QAE1C,mCAAmC;QACnC,MAAM,IAAI,CAAC,eAAe,CAAC,0BAAY,CAAC,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,wCAA0B,CAAC,MAAM,CAAC,CAAC,CAAC,wCAA0B,CAAC,OAAO,CAAC,CAAC;IACrJ,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC;QAC1B,SAAS,CAAC,+BAA+B,EAAE,CAAC;QAC5C,MAAM,iCAAe,CAAC,KAAK,EAAE,CAAC;QAC9B,MAAM,eAAM,CAAC,QAAQ,EAAE,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,CAAC;IAKM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAC1C,OAAe,EACf,QAAgB,EAChB,eAAyC,EACzC,OAAsB,2BAAa,CAAC,MAAM,EAAE;QAE5C,MAAM,oBAAoB,GAAG,CAAC,CAAC,eAAe,CAAC,gBAAgB,CAAC;QAEhE,IAAI,kBAAkB,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;QACnC,IAAI,oBAAoB,EAAE,CAAC;YACzB,MAAM,cAAc,GAAG,CAAC,IAAW,EAAE,IAAuC,EAAE,EAAE;gBAC9E,eAAe,CAAC,gBAAgB,EAAE,CAAC,IAAI,CAAC,CAAC;YAC3C,CAAC,CAAC;YAEF,kBAAkB,GAAG,eAAM,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,sBAAQ,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,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,GAAG,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;YACpE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAC1C,CAAC;QAED,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,SAAS,CAAC,YAAY,CAAC,eAAe,EAAE,CAAC;IAClD,CAAC;;AAjKH,8BAkKC;AAED;;;;GAIG;AACH,MAAa,OAAO;IACU;IAA5B,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;AAnCD,0BAmCC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module NativeApp\n */\n\nimport { BeEvent, GuidString, Logger } from \"@itwin/core-bentley\";\nimport {\n  BriefcaseDownloader, BriefcaseProps, CatalogIModel, IModelVersion, InternetConnectivityStatus, IpcSocketFrontend, LocalBriefcaseProps,\n  NativeAppFunctions, nativeAppIpcStrings, NativeAppNotifications, OverriddenBy,\n  RemoveFunction, RequestNewBriefcaseProps, StorageValue, SyncMode,\n} from \"@itwin/core-common\";\nimport { FrontendLoggerCategory } from \"./common/FrontendLoggerCategory\";\nimport { IpcApp, IpcAppOptions, NotificationHandler } from \"./IpcApp\";\nimport { NativeAppLogger } from \"./NativeAppLogger\";\nimport { OnDownloadProgress } from \"./BriefcaseConnection\";\nimport { _callIpcChannel } from \"./common/internal/Symbols\";\n\n/** Properties for specifying the BriefcaseId for downloading. May either specify a BriefcaseId directly (preferable) or, for\n * backwards compatibility, a [SyncMode]($common). If [SyncMode.PullAndPush]($common) is supplied, a new briefcaseId will be acquired.\n * @public\n */\nexport type DownloadBriefcaseId =\n  { syncMode?: SyncMode, briefcaseId?: never } |\n  { briefcaseId: number, syncMode?: never };\n\n/**\n* Options to download a briefcase\n* @public\n*/\nexport type DownloadBriefcaseOptions = DownloadBriefcaseId & {\n  /** the full path for the briefcase file */\n  fileName?: string;\n  /** Function called regularly to report progress of download. */\n  progressCallback?: OnDownloadProgress;\n  /** interval for calling progress function, in milliseconds */\n  progressInterval?: number;\n};\n\n/** NativeApp notifications from backend */\nclass NativeAppNotifyHandler extends NotificationHandler implements NativeAppNotifications {\n  public get channelName() { return nativeAppIpcStrings.notifyChannel; }\n  public notifyInternetConnectivityChanged(status: InternetConnectivityStatus) {\n    Logger.logInfo(FrontendLoggerCategory.NativeApp, \"Internet connectivity changed\");\n    NativeApp.onInternetConnectivityChanged.raiseEvent(status);\n  }\n}\n\n/**\n * Options for [[NativeApp.startup]]\n * @public\n */\nexport interface NativeAppOpts extends IpcAppOptions {\n  nativeApp?: object;\n}\n\n/**\n * The frontend of a native application\n * @see [Native Applications]($docs/learning/NativeApps.md)\n * @public\n */\nexport class NativeApp {\n  private static _removeAppNotify?: RemoveFunction;\n\n  /** A Proxy to call one of the [NativeAppFunctions]($common) functions via IPC. */\n  public static nativeAppIpc = IpcApp.makeIpcProxy<NativeAppFunctions>(nativeAppIpcStrings.channelName);\n  public static catalogIpc = IpcApp.makeIpcProxy<CatalogIModel.IpcMethods, CatalogIModel.IpcChannel>(\"catalogIModel/ipc\");\n\n  private static _storages = new Map<string, Storage>();\n  private static _onOnline = async () => {\n    await NativeApp.setConnectivity(OverriddenBy.Browser, InternetConnectivityStatus.Online);\n  };\n  private static _onOffline = async () => {\n    await NativeApp.setConnectivity(OverriddenBy.Browser, InternetConnectivityStatus.Offline);\n  };\n  private static async setConnectivity(by: OverriddenBy, status: InternetConnectivityStatus) {\n    await this.nativeAppIpc.overrideInternetConnectivity(by, status);\n  }\n  private static hookBrowserConnectivityEvents() {\n    if (typeof window === \"object\" && window.ononline && window.onoffline) {\n      window.addEventListener(\"online\", this._onOnline);\n      window.addEventListener(\"offline\", this._onOffline);\n    }\n  }\n  private static unhookBrowserConnectivityEvents() {\n    if (typeof window === \"object\" && window.ononline && window.onoffline) {\n      window.removeEventListener(\"online\", this._onOnline);\n      window.removeEventListener(\"offline\", this._onOffline);\n    }\n  }\n  /** event called when internet connectivity changes, if known */\n  public static onInternetConnectivityChanged = new BeEvent<(status: InternetConnectivityStatus) => void>();\n\n  /** determine whether the app currently has internet connectivity, if known */\n  public static async checkInternetConnectivity(): Promise<InternetConnectivityStatus> {\n    return this.nativeAppIpc.checkInternetConnectivity();\n  }\n  /** @internal */\n  public static async overrideInternetConnectivity(status: InternetConnectivityStatus): Promise<void> {\n    return this.nativeAppIpc.overrideInternetConnectivity(OverriddenBy.User, status);\n  }\n  private static _isValid = false;\n  public static get isValid(): boolean { return this._isValid; }\n\n  /**\n   * This is called by either ElectronApp.startup or MobileApp.startup - it should not be called directly\n   * @internal\n   */\n  public static async startup(ipc: IpcSocketFrontend, opts?: NativeAppOpts) {\n    await IpcApp.startup(ipc, opts);\n    if (this._isValid)\n      return;\n    this._isValid = true;\n\n    this._removeAppNotify = NativeAppNotifyHandler.register(); // receives notifications from backend\n    NativeApp.hookBrowserConnectivityEvents();\n\n    // initialize current online state.\n    await this.setConnectivity(OverriddenBy.Browser, window.navigator.onLine ? InternetConnectivityStatus.Online : InternetConnectivityStatus.Offline);\n  }\n\n  /** @internal */\n  public static async shutdown() {\n    this._removeAppNotify?.();\n    NativeApp.unhookBrowserConnectivityEvents();\n    await NativeAppLogger.flush();\n    await IpcApp.shutdown();\n    this._isValid = false;\n  }\n\n  public static async requestDownloadBriefcase(iTwinId: string, iModelId: string, downloadOptions: DownloadBriefcaseOptions,\n    asOf?: IModelVersion): Promise<BriefcaseDownloader>;\n\n  public static async requestDownloadBriefcase(\n    iTwinId: string,\n    iModelId: string,\n    downloadOptions: DownloadBriefcaseOptions,\n    asOf: IModelVersion = IModelVersion.latest()\n  ): Promise<BriefcaseDownloader> {\n    const shouldReportProgress = !!downloadOptions.progressCallback;\n\n    let stopProgressEvents = () => { };\n    if (shouldReportProgress) {\n      const handleProgress = (_evt: Event, data: { loaded: number, total: number }) => {\n        downloadOptions.progressCallback?.(data);\n      };\n\n      stopProgressEvents = IpcApp.addListener(`nativeApp.progress-${iModelId}`, handleProgress);\n    }\n\n    const briefcaseId = (undefined !== downloadOptions.briefcaseId) ? downloadOptions.briefcaseId :\n      (downloadOptions.syncMode === SyncMode.PullOnly ? 0 : await this.nativeAppIpc.acquireNewBriefcaseId(iModelId));\n\n    const fileName = downloadOptions.fileName ?? await this.getBriefcaseFileName({ briefcaseId, iModelId });\n    const requestProps: RequestNewBriefcaseProps = { iModelId, briefcaseId, iTwinId, asOf: asOf.toJSON(), fileName };\n\n    const doDownload = async (): Promise<void> => {\n      try {\n        await this.nativeAppIpc.downloadBriefcase(requestProps, shouldReportProgress, downloadOptions.progressInterval);\n      } finally {\n        stopProgressEvents();\n      }\n    };\n\n    const requestCancel = async (): Promise<boolean> => {\n      const status = await this.nativeAppIpc.requestCancelDownloadBriefcase(fileName);\n      if (status)\n        stopProgressEvents();\n      return status;\n    };\n\n    return { briefcaseId, fileName, downloadPromise: doDownload(), requestCancel };\n  }\n\n  /** Get the full path filename for a briefcase within the briefcase cache */\n  public static async getBriefcaseFileName(props: BriefcaseProps): Promise<string> {\n    return this.nativeAppIpc.getBriefcaseFileName(props);\n  }\n\n  /** Delete an existing briefcase\n   * @param fileName the briefcase fileName\n   */\n  public static async deleteBriefcase(fileName: string): Promise<void> {\n    await this.nativeAppIpc.deleteBriefcaseFiles(fileName);\n  }\n\n  /** Get a list of all briefcase files held in the local briefcase cache directory */\n  public static async getCachedBriefcases(iModelId?: GuidString): Promise<LocalBriefcaseProps[]> {\n    return this.nativeAppIpc.getCachedBriefcases(iModelId);\n  }\n\n  /**\n   * Open a [[Storage]]. Creates a new Storage with that name if it does not already exist.\n   * @param name Should be a local filename without an extension.\n   * @returns a Promise for the [[Storage]].\n   */\n  public static async openStorage(name: string): Promise<Storage> {\n    let storage = this._storages.get(name);\n    if (!storage) {\n      storage = new Storage(await this.nativeAppIpc.storageMgrOpen(name));\n      this._storages.set(storage.id, storage);\n    }\n\n    return storage;\n  }\n\n  /**\n   * Close a Storage and optionally delete it.\n   * @param storage normally not call directly instead use Storage.close()\n   * @param deleteStorage if true, delete the storage from disk after closing it.\n   */\n  public static async closeStorage(storage: Storage, deleteStorage: boolean = false): Promise<void> {\n    if (!this._storages.has(storage.id))\n      throw new Error(`Storage [Id=${storage.id}] not open`);\n\n    await this.nativeAppIpc.storageMgrClose(storage.id, deleteStorage);\n    this._storages.delete(storage.id);\n  }\n\n  /** Get the list of existing Storages on the local disk. */\n  public static async getStorageNames(): Promise<string[]> {\n    return NativeApp.nativeAppIpc.storageMgrNames();\n  }\n}\n\n/**\n *  A local disk-based cache for key value pairs for NativeApps.\n * @note This should be used only for local caching, since its not guaranteed to exist permanently.\n * @public\n */\nexport class Storage {\n  constructor(public readonly id: string) { }\n\n  /** get the type of a value for a key, or undefined if not present. */\n  public async getValueType(key: string): Promise<\"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined> {\n    return NativeApp.nativeAppIpc.storageGetValueType(this.id, key);\n  }\n\n  /** Get the value for a key */\n  public async getData(key: string): Promise<StorageValue> {\n    return NativeApp.nativeAppIpc.storageGet(this.id, key);\n  }\n\n  /** Set value for a key */\n  public async setData(key: string, value: StorageValue): Promise<void> {\n    return NativeApp.nativeAppIpc.storageSet(this.id, key, value);\n  }\n\n  /**\n   * Return an array of all keys in this Storage.\n   * @note This can be expensive, depending on the number of keys present.\n   */\n  public async getKeys(): Promise<string[]> {\n    return NativeApp.nativeAppIpc.storageKeys(this.id);\n  }\n\n  /** Remove a key and its data. */\n  public async removeData(key: string): Promise<void> {\n    return NativeApp.nativeAppIpc.storageRemove(this.id, key);\n  }\n\n  /** Remove all keys and their data. */\n  public async removeAll(): Promise<void> {\n    return NativeApp.nativeAppIpc.storageRemoveAll(this.id);\n  }\n}\n"]}

package/lib/cjs/RealityDataSourceCesiumIonAssetImpl.d.ts

@@ -2,7 +2,7 @@ import { GuidString } from "@itwin/core-bentley";
 import { RealityData, RealityDataSourceKey, RealityDataSourceProps } from "@itwin/core-common";
 import { PublisherProductInfo, RealityDataSource, SpatialLocationAndExtents } from "./RealityDataSource";
 /** This class provides access to the reality data provider services.
- * It encapsulates access to a reality data weiter it be from local access, http or ProjectWise Context Share.
+ * It encapsulates access to a reality data whether it be from local access, http or ProjectWise Context Share.
  * The key provided at the creation determines if this is ProjectWise Context Share reference.
  * If not then it is considered local (ex: C:\temp\TileRoot.json) or plain http access (http://someserver.com/data/TileRoot.json)
  * There is a one to one relationship between a reality data and the instances of present class.

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

@@ -1 +1 @@
-{"version":3,"file":"RealityDataSourceCesiumIonAssetImpl.d.ts","sourceRoot":"","sources":["../../src/RealityDataSourceCesiumIonAssetImpl.ts"],"names":[],"mappings":"AAQA,OAAO,EAAyB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAAe,WAAW,EAAuB,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAEjI,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAEzG;;;;;;EAME;AACF,qBAAa,mCAAoC,YAAW,iBAAiB;IAC3E,SAAgB,GAAG,EAAE,oBAAoB,CAAC;IAC1C,2EAA2E;IAC3E,OAAO,CAAC,WAAW,CAAqB;IACxC,sIAAsI;IACtI,OAAO,CAAC,QAAQ,CAAc;IAC9B,6DAA6D;IAC7D,OAAO,CAAC,qBAAqB,CAAC,CAAS;IAEvC;;OAEG;IACH,SAAS,aAAa,KAAK,EAAE,sBAAsB;IAKnD;;OAEG;WACiB,aAAa,CAAC,SAAS,EAAE,oBAAoB,EAAE,OAAO,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAY3I,IAAW,cAAc,IAAI,OAAO,CAEnC;IAED;;MAEE;IACF,IAAW,WAAW,IAAI,WAAW,GAAG,SAAS,CAEhD;IACD,IAAW,aAAa,IAAI,MAAM,GAAG,SAAS,CAE7C;IACD;;OAEG;IACH,IAAW,eAAe,IAAI,MAAM,GAAG,SAAS,CAE/C;IAOD,OAAO,CAAC,UAAU;IASlB;;;OAGG;IACU,aAAa,CAAC,QAAQ,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAe5E,eAAe,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC;IAsB3E;;OAEG;IACU,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAO/D;;OAEG;IACU,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAO7C,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI1D;;;;OAIG;IACU,4BAA4B,IAAI,OAAO,CAAC,yBAAyB,GAAG,SAAS,CAAC;IAK3F;;;;;OAKG;IACU,uBAAuB,IAAI,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;CAIlF"}
+{"version":3,"file":"RealityDataSourceCesiumIonAssetImpl.d.ts","sourceRoot":"","sources":["../../src/RealityDataSourceCesiumIonAssetImpl.ts"],"names":[],"mappings":"AAQA,OAAO,EAAyB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAAe,WAAW,EAAuB,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAEjI,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAEzG;;;;;;EAME;AACF,qBAAa,mCAAoC,YAAW,iBAAiB;IAC3E,SAAgB,GAAG,EAAE,oBAAoB,CAAC;IAC1C,2EAA2E;IAC3E,OAAO,CAAC,WAAW,CAAqB;IACxC,sIAAsI;IACtI,OAAO,CAAC,QAAQ,CAAc;IAC9B,6DAA6D;IAC7D,OAAO,CAAC,qBAAqB,CAAC,CAAS;IAEvC;;OAEG;IACH,SAAS,aAAa,KAAK,EAAE,sBAAsB;IAKnD;;OAEG;WACiB,aAAa,CAAC,SAAS,EAAE,oBAAoB,EAAE,OAAO,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAY3I,IAAW,cAAc,IAAI,OAAO,CAEnC;IAED;;MAEE;IACF,IAAW,WAAW,IAAI,WAAW,GAAG,SAAS,CAEhD;IACD,IAAW,aAAa,IAAI,MAAM,GAAG,SAAS,CAE7C;IACD;;OAEG;IACH,IAAW,eAAe,IAAI,MAAM,GAAG,SAAS,CAE/C;IAOD,OAAO,CAAC,UAAU;IASlB;;;OAGG;IACU,aAAa,CAAC,QAAQ,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAe5E,eAAe,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC;IAuC3E;;OAEG;IACU,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAO/D;;OAEG;IACU,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAO7C,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI1D;;;;OAIG;IACU,4BAA4B,IAAI,OAAO,CAAC,yBAAyB,GAAG,SAAS,CAAC;IAK3F;;;;;OAKG;IACU,uBAAuB,IAAI,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;CAIlF"}

package/lib/cjs/RealityDataSourceCesiumIonAssetImpl.js

@@ -13,7 +13,7 @@ const core_bentley_1 = require("@itwin/core-bentley");
 const core_common_1 = require("@itwin/core-common");
 const internal_1 = require("./tile/internal");
 /** This class provides access to the reality data provider services.
- * It encapsulates access to a reality data weiter it be from local access, http or ProjectWise Context Share.
+ * It encapsulates access to a reality data whether it be from local access, http or ProjectWise Context Share.
  * The key provided at the creation determines if this is ProjectWise Context Share reference.
  * If not then it is considered local (ex: C:\temp\TileRoot.json) or plain http access (http://someserver.com/data/TileRoot.json)
  * There is a one to one relationship between a reality data and the instances of present class.
@@ -104,10 +104,28 @@ class RealityDataSourceCesiumIonAssetImpl {
         // The following is only if the reality data is not stored on PW Context Share.
         const cesiumAsset = internal_1.CesiumIonAssetProvider.parseCesiumUrl(url);
         if (cesiumAsset) {
-            const tokenAndUrl = await (0, internal_1.getCesiumAccessTokenAndEndpointUrl)(`${cesiumAsset.id}`, cesiumAsset.key);
-            if (tokenAndUrl.url && tokenAndUrl.token) {
-                url = tokenAndUrl.url;
-                this._requestAuthorization = `Bearer ${tokenAndUrl.token}`;
+            let resolvedToken;
+            let resolvedUrl;
+            if (cesiumAsset.key) {
+                // Legacy key-bearing URL (e.g. persisted saved view) - authenticate directly with the embedded Ion key.
+                // Such URLs are intentionally exempt from the cesiumAccess-over-cesiumIonKey precedence rule and are not
+                // routed through a registered CesiumAccessClient; see [[CesiumAccessClient]].
+                const tokenAndUrl = await (0, internal_1.getCesiumAccessTokenAndEndpointUrl)(`${cesiumAsset.id}`, cesiumAsset.key);
+                resolvedToken = tokenAndUrl.token;
+                resolvedUrl = tokenAndUrl.url;
+            }
+            else {
+                // delegate to the registered CesiumAccessClient
+                const client = (0, internal_1.getCesiumAccessClient)();
+                const endpoint = await client.getAssetEndpoint(`${cesiumAsset.id}`, iTwinId);
+                if (endpoint) {
+                    resolvedToken = endpoint.accessToken;
+                    resolvedUrl = endpoint.url;
+                }
+            }
+            if (resolvedUrl && resolvedToken) {
+                url = resolvedUrl;
+                this._requestAuthorization = `Bearer ${resolvedToken}`;
             }
         }
         // The following is only if the reality data is not stored on PW Context Share.

package/lib/cjs/RealityDataSourceCesiumIonAssetImpl.js.map

@@ -1 +1 @@
-{"version":3,"file":"RealityDataSourceCesiumIonAssetImpl.js","sourceRoot":"","sources":["../../src/RealityDataSourceCesiumIonAssetImpl.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,+CAA4C;AAC5C,sDAAwE;AACxE,oDAAiI;AACjI,8CAA0I;AAG1I;;;;;;EAME;AACF,MAAa,mCAAmC;IAC9B,GAAG,CAAuB;IAC1C,2EAA2E;IACnE,WAAW,CAAqB;IACxC,sIAAsI;IAC9H,QAAQ,GAAW,EAAE,CAAC;IAC9B,6DAA6D;IACrD,qBAAqB,CAAU;IAEvC;;OAEG;IACH,YAAsB,KAA6B;QACjD,IAAA,qBAAM,EAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,KAAK,iCAAmB,CAAC,cAAc,CAAC,CAAC;QACxE,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,SAA+B,EAAE,OAA+B;QAChG,IAAI,SAAS,CAAC,QAAQ,KAAK,iCAAmB,CAAC,cAAc;YAC3D,OAAO,SAAS,CAAC;QACnB,MAAM,QAAQ,GAAG,IAAI,mCAAmC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACxE,IAAI,UAA8B,CAAC;QACnC,IAAI,CAAC;YACH,UAAU,GAAG,MAAM,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACrD,CAAC;QAAC,MAAM,CAAC,CAAC,CAAC;QAEX,OAAO,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3D,CAAC;IAED,IAAW,cAAc;QACvB,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;MAEE;IACF,IAAW,WAAW;QACpB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAW,aAAa;QACtB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD;;OAEG;IACH,IAAW,eAAe;QACxB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,oEAAoE;IACpE,sHAAsH;IACtH,qDAAqD;IACrD,oFAAoF;IACpF,kFAAkF;IAC1E,UAAU,CAAC,GAAW;QAC5B,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChC,QAAQ,CAAC,GAAG,EAAE,CAAC;QACf,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YACvB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;;YAEnB,IAAI,CAAC,QAAQ,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,aAAa,CAAC,QAAgC;QACzD,uCAAuC;QACvC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/B,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,iCAAsB,CAAC,aAAa,EAAE,CAAC;YACzD,IAAI,CAAC,WAAW,GAAG,IAAA,mCAAwB,GAAE,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,MAAM,QAAQ,GAAG,iCAAsB,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACpE,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAI,CAAC,WAAW,GAAG,IAAA,4BAAiB,EAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;YAClE,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,OAA+B;QAC1D,IAAI,GAAG,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC5C,IAAI,CAAC,GAAG;YACN,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,2BAA2B,CAAC,CAAC;QAE1E,+EAA+E;QAC/E,MAAM,WAAW,GAAG,iCAAsB,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/D,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,WAAW,GAAG,MAAM,IAAA,6CAAkC,EAAC,GAAG,WAAW,CAAC,EAAE,EAAE,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;YACnG,IAAI,WAAW,CAAC,GAAG,IAAI,WAAW,CAAC,KAAK,EAAE,CAAC;gBACzC,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC;gBACtB,IAAI,CAAC,qBAAqB,GAAG,UAAU,WAAW,CAAC,KAAK,EAAE,CAAC;YAC7D,CAAC;QACH,CAAC;QAED,+EAA+E;QAC/E,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACrB,MAAM,OAAO,GAAG,EAAE,aAAa,EAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAE9D,OAAO,IAAA,iBAAO,EAAC,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc,CAAC,IAAY;QACtC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrC,MAAM,OAAO,GAAG,EAAE,aAAa,EAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAE9D,OAAO,IAAA,iBAAO,EAAC,OAAO,EAAE,aAAa,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,WAAW,CAAC,IAAY;QACnC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrC,MAAM,OAAO,GAAG,EAAE,aAAa,EAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAE9D,OAAO,IAAA,iBAAO,EAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/C,CAAC;IAEM,kBAAkB,CAAC,GAAW;QACnC,OAAO,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,4BAA4B;QACvC,sEAAsE;QACtE,MAAM,eAAe,GAA0C,SAAS,CAAC;QACzE,OAAO,eAAe,CAAC;IACzB,CAAC;IACD;;;;;OAKG;IACI,KAAK,CAAC,uBAAuB;QAClC,IAAI,aAA+C,CAAC;QACpD,OAAO,aAAa,CAAC;IACvB,CAAC;CACF;AAvJD,kFAuJC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Tiles\n */\nimport { request } from \"./request/Request\";\nimport { assert, BentleyStatus, GuidString } from \"@itwin/core-bentley\";\nimport { IModelError, RealityData, RealityDataProvider, RealityDataSourceKey, RealityDataSourceProps } from \"@itwin/core-common\";\nimport { CesiumIonAssetProvider, getCesiumAccessTokenAndEndpointUrl, getCesiumAssetUrl, getCesiumOSMBuildingsUrl } from \"./tile/internal\";\nimport { PublisherProductInfo, RealityDataSource, SpatialLocationAndExtents } from \"./RealityDataSource\";\n\n/** This class provides access to the reality data provider services.\n * It encapsulates access to a reality data weiter it be from local access, http or ProjectWise Context Share.\n * The key provided at the creation determines if this is ProjectWise Context Share reference.\n * If not then it is considered local (ex: C:\\temp\\TileRoot.json) or plain http access (http://someserver.com/data/TileRoot.json)\n * There is a one to one relationship between a reality data and the instances of present class.\n* @internal\n*/\nexport class RealityDataSourceCesiumIonAssetImpl implements RealityDataSource {\n  public readonly key: RealityDataSourceKey;\n  /** The URL that supplies the 3d tiles for displaying the reality model. */\n  private _tilesetUrl: string | undefined;\n  /** For use by all Reality Data. For RD stored on PW Context Share, represents the portion from the root of the Azure Blob Container*/\n  private _baseUrl: string = \"\";\n  /** Request authorization for non PW ContextShare requests.*/\n  private _requestAuthorization?: string;\n\n  /** Construct a new reality data source.\n   * @param props JSON representation of the reality data source\n   */\n  protected constructor(props: RealityDataSourceProps) {\n    assert(props.sourceKey.provider === RealityDataProvider.CesiumIonAsset);\n    this.key = props.sourceKey;\n  }\n\n  /**\n   * Create an instance of this class from a source key and iTwin context/\n   */\n  public static async createFromKey(sourceKey: RealityDataSourceKey, iTwinId: GuidString | undefined): Promise<RealityDataSource | undefined> {\n    if (sourceKey.provider !== RealityDataProvider.CesiumIonAsset)\n      return undefined;\n    const rdSource = new RealityDataSourceCesiumIonAssetImpl({ sourceKey });\n    let tilesetUrl: string | undefined;\n    try {\n      tilesetUrl = await rdSource.getServiceUrl(iTwinId);\n    } catch { }\n\n    return (tilesetUrl !== undefined) ? rdSource : undefined;\n  }\n\n  public get isContextShare(): boolean {\n    return false;\n  }\n\n  /**\n   * Returns Reality Data if available\n  */\n  public get realityData(): RealityData | undefined {\n    return undefined;\n  }\n  public get realityDataId(): string | undefined {\n    return undefined;\n  }\n  /**\n   * Returns Reality Data type if available\n   */\n  public get realityDataType(): string | undefined {\n    return undefined;\n  }\n\n  // This is to set the root url from the provided root document path.\n  // If the root document is stored on PW Context Share then the root document property of the Reality Data is provided,\n  // otherwise the full path to root document is given.\n  // The base URL contains the base URL from which tile relative path are constructed.\n  // The tile's path root will need to be reinserted for child tiles to return a 200\n  private setBaseUrl(url: string): void {\n    const urlParts = url.split(\"/\");\n    urlParts.pop();\n    if (urlParts.length === 0)\n      this._baseUrl = \"\";\n    else\n      this._baseUrl = `${urlParts.join(\"/\")}/`;\n  }\n\n  /**\n   * This method returns the URL to access the actual 3d tiles from the service provider.\n   * @returns string containing the URL to reality data.\n   */\n  public async getServiceUrl(_iTwinId: GuidString | undefined): Promise<string | undefined> {\n    // If url was not resolved - resolve it\n    this._tilesetUrl = this.key.id;\n    if (this.key.id === CesiumIonAssetProvider.osmBuildingId) {\n      this._tilesetUrl = getCesiumOSMBuildingsUrl();\n    } else {\n      const parsedId = CesiumIonAssetProvider.parseCesiumUrl(this.key.id);\n      if (parsedId) {\n        this._tilesetUrl = getCesiumAssetUrl(parsedId.id, parsedId.key);\n      }\n    }\n\n    return this._tilesetUrl;\n  }\n\n  public async getRootDocument(iTwinId: GuidString | undefined): Promise<any> {\n    let url = await this.getServiceUrl(iTwinId);\n    if (!url)\n      throw new IModelError(BentleyStatus.ERROR, \"Unable to get service url\");\n\n    // The following is only if the reality data is not stored on PW Context Share.\n    const cesiumAsset = CesiumIonAssetProvider.parseCesiumUrl(url);\n    if (cesiumAsset) {\n      const tokenAndUrl = await getCesiumAccessTokenAndEndpointUrl(`${cesiumAsset.id}`, cesiumAsset.key);\n      if (tokenAndUrl.url && tokenAndUrl.token) {\n        url = tokenAndUrl.url;\n        this._requestAuthorization = `Bearer ${tokenAndUrl.token}`;\n      }\n    }\n\n    // The following is only if the reality data is not stored on PW Context Share.\n    this.setBaseUrl(url);\n    const headers = { authorization: this._requestAuthorization };\n\n    return request(url, \"json\", { headers });\n  }\n\n  /**\n   * Returns the tile content. The path to the tile is relative to the base url of present reality data whatever the type.\n   */\n  public async getTileContent(name: string): Promise<ArrayBuffer> {\n    const tileUrl = this._baseUrl + name;\n    const headers = { authorization: this._requestAuthorization };\n\n    return request(tileUrl, \"arraybuffer\", { headers });\n  }\n\n  /**\n   * Returns the tile content in json format. The path to the tile is relative to the base url of present reality data whatever the type.\n   */\n  public async getTileJson(name: string): Promise<any> {\n    const tileUrl = this._baseUrl + name;\n    const headers = { authorization: this._requestAuthorization };\n\n    return request(tileUrl, \"json\", { headers });\n  }\n\n  public getTileContentType(url: string): \"tile\" | \"tileset\" {\n    return url.endsWith(\"json\") ? \"tileset\" : \"tile\";\n  }\n\n  /**\n   * Gets spatial location and extents of this reality data source\n   * @returns spatial location and extents\n   * @internal\n   */\n  public async getSpatialLocationAndExtents(): Promise<SpatialLocationAndExtents | undefined> {\n    // Cesium Ion asset we currenlty support are unbound (cover all earth)\n    const spatialLocation: SpatialLocationAndExtents | undefined = undefined;\n    return spatialLocation;\n  }\n  /**\n   * Gets information to identify the product and engine that create this reality data\n   * Will return undefined if cannot be resolved\n   * @returns information to identify the product and engine that create this reality data\n   * @alpha\n   */\n  public async getPublisherProductInfo(): Promise<PublisherProductInfo | undefined> {\n    let publisherInfo: PublisherProductInfo | undefined;\n    return publisherInfo;\n  }\n}\n\n"]}
+{"version":3,"file":"RealityDataSourceCesiumIonAssetImpl.js","sourceRoot":"","sources":["../../src/RealityDataSourceCesiumIonAssetImpl.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,+CAA4C;AAC5C,sDAAwE;AACxE,oDAAiI;AACjI,8CAAiK;AAGjK;;;;;;EAME;AACF,MAAa,mCAAmC;IAC9B,GAAG,CAAuB;IAC1C,2EAA2E;IACnE,WAAW,CAAqB;IACxC,sIAAsI;IAC9H,QAAQ,GAAW,EAAE,CAAC;IAC9B,6DAA6D;IACrD,qBAAqB,CAAU;IAEvC;;OAEG;IACH,YAAsB,KAA6B;QACjD,IAAA,qBAAM,EAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,KAAK,iCAAmB,CAAC,cAAc,CAAC,CAAC;QACxE,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,SAA+B,EAAE,OAA+B;QAChG,IAAI,SAAS,CAAC,QAAQ,KAAK,iCAAmB,CAAC,cAAc;YAC3D,OAAO,SAAS,CAAC;QACnB,MAAM,QAAQ,GAAG,IAAI,mCAAmC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACxE,IAAI,UAA8B,CAAC;QACnC,IAAI,CAAC;YACH,UAAU,GAAG,MAAM,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACrD,CAAC;QAAC,MAAM,CAAC,CAAC,CAAC;QAEX,OAAO,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3D,CAAC;IAED,IAAW,cAAc;QACvB,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;MAEE;IACF,IAAW,WAAW;QACpB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAW,aAAa;QACtB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD;;OAEG;IACH,IAAW,eAAe;QACxB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,oEAAoE;IACpE,sHAAsH;IACtH,qDAAqD;IACrD,oFAAoF;IACpF,kFAAkF;IAC1E,UAAU,CAAC,GAAW;QAC5B,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChC,QAAQ,CAAC,GAAG,EAAE,CAAC;QACf,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YACvB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;;YAEnB,IAAI,CAAC,QAAQ,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,aAAa,CAAC,QAAgC;QACzD,uCAAuC;QACvC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/B,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,iCAAsB,CAAC,aAAa,EAAE,CAAC;YACzD,IAAI,CAAC,WAAW,GAAG,IAAA,mCAAwB,GAAE,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,MAAM,QAAQ,GAAG,iCAAsB,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACpE,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAI,CAAC,WAAW,GAAG,IAAA,4BAAiB,EAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;YAClE,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,OAA+B;QAC1D,IAAI,GAAG,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC5C,IAAI,CAAC,GAAG;YACN,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,2BAA2B,CAAC,CAAC;QAE1E,+EAA+E;QAC/E,MAAM,WAAW,GAAG,iCAAsB,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/D,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,aAAiC,CAAC;YACtC,IAAI,WAA+B,CAAC;YACpC,IAAI,WAAW,CAAC,GAAG,EAAE,CAAC;gBACpB,wGAAwG;gBACxG,yGAAyG;gBACzG,8EAA8E;gBAC9E,MAAM,WAAW,GAAG,MAAM,IAAA,6CAAkC,EAAC,GAAG,WAAW,CAAC,EAAE,EAAE,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;gBACnG,aAAa,GAAG,WAAW,CAAC,KAAK,CAAC;gBAClC,WAAW,GAAG,WAAW,CAAC,GAAG,CAAC;YAChC,CAAC;iBAAM,CAAC;gBACN,gDAAgD;gBAChD,MAAM,MAAM,GAAG,IAAA,gCAAqB,GAAE,CAAC;gBACvC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,GAAG,WAAW,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;gBAC7E,IAAI,QAAQ,EAAE,CAAC;oBACb,aAAa,GAAG,QAAQ,CAAC,WAAW,CAAC;oBACrC,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC;gBAC7B,CAAC;YACH,CAAC;YACD,IAAI,WAAW,IAAI,aAAa,EAAE,CAAC;gBACjC,GAAG,GAAG,WAAW,CAAC;gBAClB,IAAI,CAAC,qBAAqB,GAAG,UAAU,aAAa,EAAE,CAAC;YACzD,CAAC;QACH,CAAC;QAED,+EAA+E;QAC/E,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACrB,MAAM,OAAO,GAAG,EAAE,aAAa,EAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAE9D,OAAO,IAAA,iBAAO,EAAC,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc,CAAC,IAAY;QACtC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrC,MAAM,OAAO,GAAG,EAAE,aAAa,EAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAE9D,OAAO,IAAA,iBAAO,EAAC,OAAO,EAAE,aAAa,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,WAAW,CAAC,IAAY;QACnC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrC,MAAM,OAAO,GAAG,EAAE,aAAa,EAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAE9D,OAAO,IAAA,iBAAO,EAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/C,CAAC;IAEM,kBAAkB,CAAC,GAAW;QACnC,OAAO,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,4BAA4B;QACvC,sEAAsE;QACtE,MAAM,eAAe,GAA0C,SAAS,CAAC;QACzE,OAAO,eAAe,CAAC;IACzB,CAAC;IACD;;;;;OAKG;IACI,KAAK,CAAC,uBAAuB;QAClC,IAAI,aAA+C,CAAC;QACpD,OAAO,aAAa,CAAC;IACvB,CAAC;CACF;AAxKD,kFAwKC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Tiles\n */\nimport { request } from \"./request/Request\";\nimport { assert, BentleyStatus, GuidString } from \"@itwin/core-bentley\";\nimport { IModelError, RealityData, RealityDataProvider, RealityDataSourceKey, RealityDataSourceProps } from \"@itwin/core-common\";\nimport { CesiumIonAssetProvider, getCesiumAccessClient, getCesiumAccessTokenAndEndpointUrl, getCesiumAssetUrl, getCesiumOSMBuildingsUrl } from \"./tile/internal\";\nimport { PublisherProductInfo, RealityDataSource, SpatialLocationAndExtents } from \"./RealityDataSource\";\n\n/** This class provides access to the reality data provider services.\n * It encapsulates access to a reality data whether it be from local access, http or ProjectWise Context Share.\n * The key provided at the creation determines if this is ProjectWise Context Share reference.\n * If not then it is considered local (ex: C:\\temp\\TileRoot.json) or plain http access (http://someserver.com/data/TileRoot.json)\n * There is a one to one relationship between a reality data and the instances of present class.\n* @internal\n*/\nexport class RealityDataSourceCesiumIonAssetImpl implements RealityDataSource {\n  public readonly key: RealityDataSourceKey;\n  /** The URL that supplies the 3d tiles for displaying the reality model. */\n  private _tilesetUrl: string | undefined;\n  /** For use by all Reality Data. For RD stored on PW Context Share, represents the portion from the root of the Azure Blob Container*/\n  private _baseUrl: string = \"\";\n  /** Request authorization for non PW ContextShare requests.*/\n  private _requestAuthorization?: string;\n\n  /** Construct a new reality data source.\n   * @param props JSON representation of the reality data source\n   */\n  protected constructor(props: RealityDataSourceProps) {\n    assert(props.sourceKey.provider === RealityDataProvider.CesiumIonAsset);\n    this.key = props.sourceKey;\n  }\n\n  /**\n   * Create an instance of this class from a source key and iTwin context/\n   */\n  public static async createFromKey(sourceKey: RealityDataSourceKey, iTwinId: GuidString | undefined): Promise<RealityDataSource | undefined> {\n    if (sourceKey.provider !== RealityDataProvider.CesiumIonAsset)\n      return undefined;\n    const rdSource = new RealityDataSourceCesiumIonAssetImpl({ sourceKey });\n    let tilesetUrl: string | undefined;\n    try {\n      tilesetUrl = await rdSource.getServiceUrl(iTwinId);\n    } catch { }\n\n    return (tilesetUrl !== undefined) ? rdSource : undefined;\n  }\n\n  public get isContextShare(): boolean {\n    return false;\n  }\n\n  /**\n   * Returns Reality Data if available\n  */\n  public get realityData(): RealityData | undefined {\n    return undefined;\n  }\n  public get realityDataId(): string | undefined {\n    return undefined;\n  }\n  /**\n   * Returns Reality Data type if available\n   */\n  public get realityDataType(): string | undefined {\n    return undefined;\n  }\n\n  // This is to set the root url from the provided root document path.\n  // If the root document is stored on PW Context Share then the root document property of the Reality Data is provided,\n  // otherwise the full path to root document is given.\n  // The base URL contains the base URL from which tile relative path are constructed.\n  // The tile's path root will need to be reinserted for child tiles to return a 200\n  private setBaseUrl(url: string): void {\n    const urlParts = url.split(\"/\");\n    urlParts.pop();\n    if (urlParts.length === 0)\n      this._baseUrl = \"\";\n    else\n      this._baseUrl = `${urlParts.join(\"/\")}/`;\n  }\n\n  /**\n   * This method returns the URL to access the actual 3d tiles from the service provider.\n   * @returns string containing the URL to reality data.\n   */\n  public async getServiceUrl(_iTwinId: GuidString | undefined): Promise<string | undefined> {\n    // If url was not resolved - resolve it\n    this._tilesetUrl = this.key.id;\n    if (this.key.id === CesiumIonAssetProvider.osmBuildingId) {\n      this._tilesetUrl = getCesiumOSMBuildingsUrl();\n    } else {\n      const parsedId = CesiumIonAssetProvider.parseCesiumUrl(this.key.id);\n      if (parsedId) {\n        this._tilesetUrl = getCesiumAssetUrl(parsedId.id, parsedId.key);\n      }\n    }\n\n    return this._tilesetUrl;\n  }\n\n  public async getRootDocument(iTwinId: GuidString | undefined): Promise<any> {\n    let url = await this.getServiceUrl(iTwinId);\n    if (!url)\n      throw new IModelError(BentleyStatus.ERROR, \"Unable to get service url\");\n\n    // The following is only if the reality data is not stored on PW Context Share.\n    const cesiumAsset = CesiumIonAssetProvider.parseCesiumUrl(url);\n    if (cesiumAsset) {\n      let resolvedToken: string | undefined;\n      let resolvedUrl: string | undefined;\n      if (cesiumAsset.key) {\n        // Legacy key-bearing URL (e.g. persisted saved view) - authenticate directly with the embedded Ion key.\n        // Such URLs are intentionally exempt from the cesiumAccess-over-cesiumIonKey precedence rule and are not\n        // routed through a registered CesiumAccessClient; see [[CesiumAccessClient]].\n        const tokenAndUrl = await getCesiumAccessTokenAndEndpointUrl(`${cesiumAsset.id}`, cesiumAsset.key);\n        resolvedToken = tokenAndUrl.token;\n        resolvedUrl = tokenAndUrl.url;\n      } else {\n        // delegate to the registered CesiumAccessClient\n        const client = getCesiumAccessClient();\n        const endpoint = await client.getAssetEndpoint(`${cesiumAsset.id}`, iTwinId);\n        if (endpoint) {\n          resolvedToken = endpoint.accessToken;\n          resolvedUrl = endpoint.url;\n        }\n      }\n      if (resolvedUrl && resolvedToken) {\n        url = resolvedUrl;\n        this._requestAuthorization = `Bearer ${resolvedToken}`;\n      }\n    }\n\n    // The following is only if the reality data is not stored on PW Context Share.\n    this.setBaseUrl(url);\n    const headers = { authorization: this._requestAuthorization };\n\n    return request(url, \"json\", { headers });\n  }\n\n  /**\n   * Returns the tile content. The path to the tile is relative to the base url of present reality data whatever the type.\n   */\n  public async getTileContent(name: string): Promise<ArrayBuffer> {\n    const tileUrl = this._baseUrl + name;\n    const headers = { authorization: this._requestAuthorization };\n\n    return request(tileUrl, \"arraybuffer\", { headers });\n  }\n\n  /**\n   * Returns the tile content in json format. The path to the tile is relative to the base url of present reality data whatever the type.\n   */\n  public async getTileJson(name: string): Promise<any> {\n    const tileUrl = this._baseUrl + name;\n    const headers = { authorization: this._requestAuthorization };\n\n    return request(tileUrl, \"json\", { headers });\n  }\n\n  public getTileContentType(url: string): \"tile\" | \"tileset\" {\n    return url.endsWith(\"json\") ? \"tileset\" : \"tile\";\n  }\n\n  /**\n   * Gets spatial location and extents of this reality data source\n   * @returns spatial location and extents\n   * @internal\n   */\n  public async getSpatialLocationAndExtents(): Promise<SpatialLocationAndExtents | undefined> {\n    // Cesium Ion asset we currenlty support are unbound (cover all earth)\n    const spatialLocation: SpatialLocationAndExtents | undefined = undefined;\n    return spatialLocation;\n  }\n  /**\n   * Gets information to identify the product and engine that create this reality data\n   * Will return undefined if cannot be resolved\n   * @returns information to identify the product and engine that create this reality data\n   * @alpha\n   */\n  public async getPublisherProductInfo(): Promise<PublisherProductInfo | undefined> {\n    let publisherInfo: PublisherProductInfo | undefined;\n    return publisherInfo;\n  }\n}\n\n"]}

package/lib/cjs/SelectionSet.d.ts

@@ -25,7 +25,7 @@ export interface SelectAddEvent {
     type: SelectionSetEventType.Add;
     /**
      * The Ids of the elements added to the set.
-     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use the [[additions]] attribute instead.
+     * @deprecated in 5.0 - might be removed in next major version. Use the [[additions]] attribute instead.
      */
     added: Id64Arg;
     /** A collection of geometric element, model and subcategory ids that have been added to selection set. */
@@ -42,7 +42,7 @@ export interface SelectRemoveEvent {
     type: SelectionSetEventType.Remove | SelectionSetEventType.Clear;
     /**
      * The element Ids removed from the set.
-     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use the [[removals]] attribute instead.
+     * @deprecated in 5.0 - might be removed in next major version. Use the [[removals]] attribute instead.
      */
     removed: Id64Arg;
     /** A collection of geometric element, model and subcategory ids that have been removed from selection set. */
@@ -58,14 +58,14 @@ export interface SelectReplaceEvent {
     type: SelectionSetEventType.Replace;
     /**
      * The element Ids added to the set.
-     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use the [[additions]] attribute instead.
+     * @deprecated in 5.0 - might be removed in next major version. Use the [[additions]] attribute instead.
      */
     added: Id64Arg;
     /** A collection of geometric element, model and subcategory ids that have been added to selection set. */
     additions: SelectableIds;
     /**
      * The element Ids removed from the set.
-     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use the [[removals]] attribute instead.
+     * @deprecated in 5.0 - might be removed in next major version. Use the [[removals]] attribute instead.
      */
     removed: Id64Arg;
     /** A collection of geometric element, model and subcategory ids that have been removed from selection set. */
@@ -163,7 +163,7 @@ export declare class HiliteSet {
     /** Toggle the hilited state of one or more elements.
      * @param arg the ID(s) of the elements whose state is to be toggled.
      * @param onOff True to add the elements to the hilited set, false to remove them.
-     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [[add]], [[remove]], [[replace]] instead.
+     * @deprecated in 5.0 - might be removed in next major version. Use [[add]], [[remove]], [[replace]] instead.
      */
     setHilite(arg: Id64Arg, onOff: boolean): void;
 }
@@ -203,12 +203,12 @@ export declare class SelectionSet {
     get isActive(): boolean;
     /** Return true if elemId is in this `SelectionSet`.
      * @see [[isSelected]]
-     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `SelectionSet.elements.has(elemId)` instead.
+     * @deprecated in 5.0 - might be removed in next major version. Use `SelectionSet.elements.has(elemId)` instead.
      */
     has(elemId?: string): boolean;
     /** Query whether an Id is in the selection set.
      * @see [[has]]
-     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `SelectionSet.elements.has(elemId)` instead.
+     * @deprecated in 5.0 - might be removed in next major version. Use `SelectionSet.elements.has(elemId)` instead.
      */
     isSelected(elemId?: Id64String): boolean;
     /** Clear current selection set.

package/lib/cjs/SelectionSet.js

@@ -205,7 +205,7 @@ class HiliteSet {
     /** Toggle the hilited state of one or more elements.
      * @param arg the ID(s) of the elements whose state is to be toggled.
      * @param onOff True to add the elements to the hilited set, false to remove them.
-     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [[add]], [[remove]], [[replace]] instead.
+     * @deprecated in 5.0 - might be removed in next major version. Use [[add]], [[remove]], [[replace]] instead.
      */
     setHilite(arg, onOff) {
         if (onOff) {
@@ -274,14 +274,14 @@ class SelectionSet {
     }
     /** Return true if elemId is in this `SelectionSet`.
      * @see [[isSelected]]
-     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `SelectionSet.elements.has(elemId)` instead.
+     * @deprecated in 5.0 - might be removed in next major version. Use `SelectionSet.elements.has(elemId)` instead.
      */
     has(elemId) {
         return !!elemId && this.elements.has(elemId);
     }
     /** Query whether an Id is in the selection set.
      * @see [[has]]
-     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `SelectionSet.elements.has(elemId)` instead.
+     * @deprecated in 5.0 - might be removed in next major version. Use `SelectionSet.elements.has(elemId)` instead.
      */
     isSelected(elemId) {
         return !!elemId && this.elements.has(elemId);