@itwin/core-frontend 3.6.0-dev.52 → 3.6.0-dev.54

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,sDAAqG;AACrG,oDAI4B;AAC5B,+CAA2E;AAC3E,qEAAkE;AAClE,qCAAsE;AACtE,uDAAoD;AAwBpD,2CAA2C;AAC3C,MAAM,sBAAuB,SAAQ,4BAAmB;IACtD,IAAW,WAAW,KAAK,OAAO,6BAAe,CAAC,CAAC,CAAC;IAC7C,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;IAGpB,mCAAmC;IAC5B,MAAM,CAAC,KAAK,CAAC,cAAc,CAA+C,UAAa,EAAE,GAAG,IAAuC;QACxI,OAAO,eAAM,CAAC,cAAc,CAAC,8BAAgB,EAAE,UAAU,EAAE,GAAG,IAAI,CAA6C,CAAC;IAClH,CAAC;IAWO,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,EAAgB,EAAE,MAAkC;QACvF,8BAAoB,CAAC,MAAM,GAAG,CAAC,MAAM,KAAK,wCAA0B,CAAC,MAAM,CAAC,CAAC;QAC7E,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;YACrE,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAClD,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;SACrD;IACH,CAAC;IACO,MAAM,CAAC,+BAA+B;QAC5C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,SAAS,EAAE;YACrE,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YACrD,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;SACxD;IACH,CAAC;IAID,8EAA8E;IACvE,MAAM,CAAC,KAAK,CAAC,yBAAyB;QAC3C,OAAO,IAAI,CAAC,YAAY,CAAC,yBAAyB,EAAE,CAAC;IACvD,CAAC;IACD,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,MAAkC;QACjF,OAAO,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,0BAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACnF,CAAC;IAEM,MAAM,KAAK,OAAO,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE9D;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAsB,EAAE,IAAoB;QACtE,MAAM,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;YAC3B,8BAAoB,CAAC,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC;YACtD,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;SACpJ;IACH,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,QAAQ;;QAC1B,MAAA,IAAI,CAAC,gBAAgB,+CAArB,IAAI,CAAqB,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;IAYM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAC1C,OAAe,EACf,QAAgB,EAChB,eAAyC,EACzC,OAAsB,2BAAa,CAAC,MAAM,EAAE,EAC5C,QAA2B;;QAE3B,MAAM,oBAAoB,GAAG,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,eAAe,CAAC,gBAAgB,CAAC;QAE9E,IAAI,kBAAkB,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;QACnC,IAAI,oBAAoB,EAAE;YACxB,MAAM,cAAc,GAAG,CAAC,IAAW,EAAE,IAAuC,EAAE,EAAE;;gBAC9E,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,IAAI,CAAC,CAAC;gBACjB,MAAA,eAAe,CAAC,gBAAgB,+CAAhC,eAAe,EAAoB,IAAI,CAAC,CAAC;YAC3C,CAAC,CAAC;YAEF,kBAAkB,GAAG,eAAM,CAAC,WAAW,CAAC,sBAAsB,QAAQ,EAAE,EAAE,cAAc,CAAC,CAAC;SAC3F;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,MAAA,eAAe,CAAC,QAAQ,mCAAI,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;gBACF,MAAM,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,YAAY,EAAE,oBAAoB,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;aACjH;oBAAS;gBACR,kBAAkB,EAAE,CAAC;aACtB;QACH,CAAC,CAAC;QAEF,MAAM,aAAa,GAAG,KAAK,IAAsB,EAAE;YACjD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,8BAA8B,CAAC,QAAQ,CAAC,CAAC;YAChF,IAAI,MAAM;gBACR,kBAAkB,EAAE,CAAC;YACvB,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QAEF,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,EAAE,aAAa,EAAE,CAAC;IACjF,CAAC;IAED,4EAA4E;IACrE,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,KAAqB;QAC5D,OAAO,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAgB;QAClD,MAAM,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED,oFAAoF;IAC7E,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,QAAqB;QAC3D,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,IAAY;QAC1C,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC;YAC1B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;QAEnC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QACxC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,OAAgB,EAAE,gBAAyB,KAAK;QAC/E,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,eAAe,OAAO,CAAC,EAAE,YAAY,CAAC,CAAC;QAEzD,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;QACnE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,KAAK,CAAC,eAAe;QACjC,OAAO,SAAS,CAAC,YAAY,CAAC,eAAe,EAAE,CAAC;IAClD,CAAC;;AAhLH,8BAiLC;;AA1KC,kFAAkF;AACpE,sBAAY,GAAG,eAAM,CAAC,YAAY,CAAqB,8BAAgB,CAAE,CAAA;AAExE,mBAAS,GAAG,IAAI,GAAG,EAAoB,CAAA;AACvC,mBAAS,GAAG,KAAK,IAAI,EAAE;IACpC,MAAM,SAAS,CAAC,eAAe,CAAC,0BAAY,CAAC,OAAO,EAAE,wCAA0B,CAAC,MAAM,CAAC,CAAC;AAC3F,CAAE,CAAA;AACa,oBAAU,GAAG,KAAK,IAAI,EAAE;IACrC,MAAM,SAAS,CAAC,eAAe,CAAC,0BAAY,CAAC,OAAO,EAAE,wCAA0B,CAAC,OAAO,CAAC,CAAC;AAC5F,CAAE,CAAA;AAiBF,gEAAgE;AAClD,uCAA6B,GAAG,IAAI,sBAAO,EAAiD,CAAA;AAU3F,kBAAQ,GAAG,KAAM,CAAA;AAuIlC;;;;GAIG;AACH,MAAa,OAAO;IAClB,YAA4B,EAAU;QAAV,OAAE,GAAF,EAAE,CAAQ;IAAI,CAAC;IAE3C,sEAAsE;IAC/D,KAAK,CAAC,YAAY,CAAC,GAAW;QACnC,OAAO,SAAS,CAAC,YAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAClE,CAAC;IAED,8BAA8B;IACvB,KAAK,CAAC,OAAO,CAAC,GAAW;QAC9B,OAAO,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IACzD,CAAC;IAED,0BAA0B;IACnB,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,KAAmB;QACnD,OAAO,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO;QAClB,OAAO,SAAS,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,iCAAiC;IAC1B,KAAK,CAAC,UAAU,CAAC,GAAW;QACjC,OAAO,SAAS,CAAC,YAAY,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAC5D,CAAC;IAED,sCAAsC;IAC/B,KAAK,CAAC,SAAS;QACpB,OAAO,SAAS,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC;CACF;AAnCD,0BAmCC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module NativeApp\r\n */\r\n\r\nimport { AsyncMethodsOf, BeEvent, GuidString, Logger, PromiseReturnType } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseDownloader, BriefcaseProps, IModelVersion, InternetConnectivityStatus, IpcSocketFrontend, LocalBriefcaseProps,\r\n  nativeAppChannel, NativeAppFunctions, NativeAppNotifications, nativeAppNotify, OverriddenBy,\r\n  RemoveFunction, RequestNewBriefcaseProps, StorageValue, SyncMode,\r\n} from \"@itwin/core-common\";\r\nimport { ProgressCallback, RequestGlobalOptions } from \"./request/Request\";\r\nimport { FrontendLoggerCategory } from \"./FrontendLoggerCategory\";\r\nimport { IpcApp, IpcAppOptions, NotificationHandler } from \"./IpcApp\";\r\nimport { NativeAppLogger } from \"./NativeAppLogger\";\r\nimport { OnDownloadProgress } from \"./BriefcaseConnection\";\r\n\r\n/** Properties for specifying the BriefcaseId for downloading. May either specify a BriefcaseId directly (preferable) or, for\r\n * backwards compatibility, a [SyncMode]($common). If [SyncMode.PullAndPush]($common) is supplied, a new briefcaseId will be acquired.\r\n * @public\r\n */\r\nexport type DownloadBriefcaseId =\r\n  { syncMode?: SyncMode, briefcaseId?: never } |\r\n  { briefcaseId: number, syncMode?: never };\r\n\r\n/**\r\n* Options to download a briefcase\r\n* @public\r\n*/\r\nexport type DownloadBriefcaseOptions = DownloadBriefcaseId & {\r\n  /** the full path for the briefcase file */\r\n  fileName?: string;\r\n  /** Function called regularly to report progress of download. */\r\n  progressCallback?: OnDownloadProgress;\r\n  /** interval for calling progress function, in milliseconds */\r\n  progressInterval?: number;\r\n};\r\n\r\n/** NativeApp notifications from backend */\r\nclass NativeAppNotifyHandler extends NotificationHandler implements NativeAppNotifications {\r\n  public get channelName() { return nativeAppNotify; }\r\n  public notifyInternetConnectivityChanged(status: InternetConnectivityStatus) {\r\n    Logger.logInfo(FrontendLoggerCategory.NativeApp, \"Internet connectivity changed\");\r\n    NativeApp.onInternetConnectivityChanged.raiseEvent(status);\r\n  }\r\n}\r\n\r\n/**\r\n * Options for [[NativeApp.startup]]\r\n * @public\r\n */\r\nexport interface NativeAppOpts extends IpcAppOptions {\r\n  nativeApp?: {};\r\n}\r\n\r\n/**\r\n * The frontend of a native application\r\n * @see [Native Applications]($docs/learning/NativeApps.md)\r\n * @public\r\n */\r\nexport class NativeApp {\r\n  private static _removeAppNotify?: RemoveFunction;\r\n\r\n  /** @deprecated use nativeAppIpc */\r\n  public static async callNativeHost<T extends AsyncMethodsOf<NativeAppFunctions>>(methodName: T, ...args: Parameters<NativeAppFunctions[T]>) {\r\n    return IpcApp.callIpcChannel(nativeAppChannel, methodName, ...args) as PromiseReturnType<NativeAppFunctions[T]>;\r\n  }\r\n  /** A Proxy to call one of the [NativeAppFunctions]($common) functions via IPC. */\r\n  public static nativeAppIpc = IpcApp.makeIpcProxy<NativeAppFunctions>(nativeAppChannel);\r\n\r\n  private static _storages = new Map<string, Storage>();\r\n  private static _onOnline = async () => {\r\n    await NativeApp.setConnectivity(OverriddenBy.Browser, InternetConnectivityStatus.Online);\r\n  };\r\n  private static _onOffline = async () => {\r\n    await NativeApp.setConnectivity(OverriddenBy.Browser, InternetConnectivityStatus.Offline);\r\n  };\r\n  private static async setConnectivity(by: OverriddenBy, status: InternetConnectivityStatus) {\r\n    RequestGlobalOptions.online = (status === InternetConnectivityStatus.Online);\r\n    await this.nativeAppIpc.overrideInternetConnectivity(by, status);\r\n  }\r\n  private static hookBrowserConnectivityEvents() {\r\n    if (typeof window === \"object\" && window.ononline && window.onoffline) {\r\n      window.addEventListener(\"online\", this._onOnline);\r\n      window.addEventListener(\"offline\", this._onOffline);\r\n    }\r\n  }\r\n  private static unhookBrowserConnectivityEvents() {\r\n    if (typeof window === \"object\" && window.ononline && window.onoffline) {\r\n      window.removeEventListener(\"online\", this._onOnline);\r\n      window.removeEventListener(\"offline\", this._onOffline);\r\n    }\r\n  }\r\n  /** event called when internet connectivity changes, if known */\r\n  public static onInternetConnectivityChanged = new BeEvent<(status: InternetConnectivityStatus) => void>();\r\n\r\n  /** determine whether the app currently has internet connectivity, if known */\r\n  public static async checkInternetConnectivity(): Promise<InternetConnectivityStatus> {\r\n    return this.nativeAppIpc.checkInternetConnectivity();\r\n  }\r\n  /** @internal */\r\n  public static async overrideInternetConnectivity(status: InternetConnectivityStatus): Promise<void> {\r\n    return this.nativeAppIpc.overrideInternetConnectivity(OverriddenBy.User, status);\r\n  }\r\n  private static _isValid = false;\r\n  public static get isValid(): boolean { return this._isValid; }\r\n\r\n  /**\r\n   * This is called by either ElectronApp.startup or MobileApp.startup - it should not be called directly\r\n   * @internal\r\n   */\r\n  public static async startup(ipc: IpcSocketFrontend, opts?: NativeAppOpts) {\r\n    await IpcApp.startup(ipc, opts);\r\n    if (this._isValid)\r\n      return;\r\n    this._isValid = true;\r\n\r\n    this._removeAppNotify = NativeAppNotifyHandler.register(); // receives notifications from backend\r\n    NativeApp.hookBrowserConnectivityEvents();\r\n\r\n    // initialize current online state.\r\n    if (window.navigator.onLine) {\r\n      RequestGlobalOptions.online = window.navigator.onLine;\r\n      await this.setConnectivity(OverriddenBy.Browser, window.navigator.onLine ? InternetConnectivityStatus.Online : InternetConnectivityStatus.Offline);\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  public static async shutdown() {\r\n    this._removeAppNotify?.();\r\n    NativeApp.unhookBrowserConnectivityEvents();\r\n    await NativeAppLogger.flush();\r\n    await IpcApp.shutdown();\r\n    this._isValid = false;\r\n  }\r\n\r\n  public static async requestDownloadBriefcase(iTwinId: string, iModelId: string, downloadOptions: DownloadBriefcaseOptions,\r\n    asOf?: IModelVersion): Promise<BriefcaseDownloader>;\r\n\r\n  /**\r\n   * @deprecated in 3.6. [[progress]] argument is now deprecated, use [[DownloadBriefcaseOptions.progressCallback]] instead.\r\n   */\r\n  public static async requestDownloadBriefcase(iTwinId: string, iModelId: string, downloadOptions: DownloadBriefcaseOptions,\r\n    // eslint-disable-next-line @typescript-eslint/unified-signatures\r\n    asOf?: IModelVersion, progress?: ProgressCallback): Promise<BriefcaseDownloader>;\r\n\r\n  public static async requestDownloadBriefcase(\r\n    iTwinId: string,\r\n    iModelId: string,\r\n    downloadOptions: DownloadBriefcaseOptions,\r\n    asOf: IModelVersion = IModelVersion.latest(),\r\n    progress?: ProgressCallback\r\n  ): Promise<BriefcaseDownloader> {\r\n    const shouldReportProgress = !!progress || !!downloadOptions.progressCallback;\r\n\r\n    let stopProgressEvents = () => { };\r\n    if (shouldReportProgress) {\r\n      const handleProgress = (_evt: Event, data: { loaded: number, total: number }) => {\r\n        progress?.(data);\r\n        downloadOptions.progressCallback?.(data);\r\n      };\r\n\r\n      stopProgressEvents = IpcApp.addListener(`nativeApp.progress-${iModelId}`, handleProgress);\r\n    }\r\n\r\n    const briefcaseId = (undefined !== downloadOptions.briefcaseId) ? downloadOptions.briefcaseId :\r\n      (downloadOptions.syncMode === SyncMode.PullOnly ? 0 : await this.nativeAppIpc.acquireNewBriefcaseId(iModelId));\r\n\r\n    const fileName = downloadOptions.fileName ?? await this.getBriefcaseFileName({ briefcaseId, iModelId });\r\n    const requestProps: RequestNewBriefcaseProps = { iModelId, briefcaseId, iTwinId, asOf: asOf.toJSON(), fileName };\r\n\r\n    const doDownload = async (): Promise<void> => {\r\n      try {\r\n        await this.nativeAppIpc.downloadBriefcase(requestProps, shouldReportProgress, downloadOptions.progressInterval);\r\n      } finally {\r\n        stopProgressEvents();\r\n      }\r\n    };\r\n\r\n    const requestCancel = async (): Promise<boolean> => {\r\n      const status = await this.nativeAppIpc.requestCancelDownloadBriefcase(fileName);\r\n      if (status)\r\n        stopProgressEvents();\r\n      return status;\r\n    };\r\n\r\n    return { briefcaseId, fileName, downloadPromise: doDownload(), requestCancel };\r\n  }\r\n\r\n  /** Get the full path filename for a briefcase within the briefcase cache */\r\n  public static async getBriefcaseFileName(props: BriefcaseProps): Promise<string> {\r\n    return this.nativeAppIpc.getBriefcaseFileName(props);\r\n  }\r\n\r\n  /** Delete an existing briefcase\r\n   * @param fileName the briefcase fileName\r\n   */\r\n  public static async deleteBriefcase(fileName: string): Promise<void> {\r\n    await this.nativeAppIpc.deleteBriefcaseFiles(fileName);\r\n  }\r\n\r\n  /** Get a list of all briefcase files held in the local briefcase cache directory */\r\n  public static async getCachedBriefcases(iModelId?: GuidString): Promise<LocalBriefcaseProps[]> {\r\n    return this.nativeAppIpc.getCachedBriefcases(iModelId);\r\n  }\r\n\r\n  /**\r\n   * Open a [[Storage]]. Creates a new Storage with that name if it does not already exist.\r\n   * @param name Should be a local filename without an extension.\r\n   * @returns a Promise for the [[Storage]].\r\n   */\r\n  public static async openStorage(name: string): Promise<Storage> {\r\n    if (this._storages.has(name))\r\n      return this._storages.get(name)!;\r\n\r\n    const storage = new Storage(await this.nativeAppIpc.storageMgrOpen(name));\r\n    this._storages.set(storage.id, storage);\r\n    return storage;\r\n  }\r\n\r\n  /**\r\n   * Close a Storage and optionally delete it.\r\n   * @param storage normally not call directly instead use Storage.close()\r\n   * @param deleteStorage if true, delete the storage from disk after closing it.\r\n   */\r\n  public static async closeStorage(storage: Storage, deleteStorage: boolean = false): Promise<void> {\r\n    if (!this._storages.has(storage.id))\r\n      throw new Error(`Storage [Id=${storage.id}] not open`);\r\n\r\n    await this.nativeAppIpc.storageMgrClose(storage.id, deleteStorage);\r\n    this._storages.delete(storage.id);\r\n  }\r\n\r\n  /** Get the list of existing Storages on the local disk. */\r\n  public static async getStorageNames(): Promise<string[]> {\r\n    return NativeApp.nativeAppIpc.storageMgrNames();\r\n  }\r\n}\r\n\r\n/**\r\n *  A local disk-based cache for key value pairs for NativeApps.\r\n * @note This should be used only for local caching, since its not guaranteed to exist permanently.\r\n * @public\r\n */\r\nexport class Storage {\r\n  constructor(public readonly id: string) { }\r\n\r\n  /** get the type of a value for a key, or undefined if not present. */\r\n  public async getValueType(key: string): Promise<\"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined> {\r\n    return NativeApp.nativeAppIpc.storageGetValueType(this.id, key);\r\n  }\r\n\r\n  /** Get the value for a key */\r\n  public async getData(key: string): Promise<StorageValue> {\r\n    return NativeApp.nativeAppIpc.storageGet(this.id, key);\r\n  }\r\n\r\n  /** Set value for a key */\r\n  public async setData(key: string, value: StorageValue): Promise<void> {\r\n    return NativeApp.nativeAppIpc.storageSet(this.id, key, value);\r\n  }\r\n\r\n  /**\r\n   * Return an array of all keys in this Storage.\r\n   * @note This can be expensive, depending on the number of keys present.\r\n   */\r\n  public async getKeys(): Promise<string[]> {\r\n    return NativeApp.nativeAppIpc.storageKeys(this.id);\r\n  }\r\n\r\n  /** Remove a key and its data. */\r\n  public async removeData(key: string): Promise<void> {\r\n    return NativeApp.nativeAppIpc.storageRemove(this.id, key);\r\n  }\r\n\r\n  /** Remove all keys and their data. */\r\n  public async removeAll(): Promise<void> {\r\n    return NativeApp.nativeAppIpc.storageRemoveAll(this.id);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"NativeApp.js","sourceRoot":"","sources":["../../src/NativeApp.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;AAEH,sDAAqG;AACrG,oDAI4B;AAC5B,+CAA2E;AAC3E,qEAAkE;AAClE,qCAAsE;AACtE,uDAAoD;AAwBpD,2CAA2C;AAC3C,MAAM,sBAAuB,SAAQ,4BAAmB;IACtD,IAAW,WAAW,KAAK,OAAO,6BAAe,CAAC,CAAC,CAAC;IAC7C,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;IAGpB,2CAA2C;IACpC,MAAM,CAAC,KAAK,CAAC,cAAc,CAA+C,UAAa,EAAE,GAAG,IAAuC;QACxI,OAAO,eAAM,CAAC,cAAc,CAAC,8BAAgB,EAAE,UAAU,EAAE,GAAG,IAAI,CAA6C,CAAC;IAClH,CAAC;IAWO,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,EAAgB,EAAE,MAAkC;QACvF,8BAAoB,CAAC,MAAM,GAAG,CAAC,MAAM,KAAK,wCAA0B,CAAC,MAAM,CAAC,CAAC;QAC7E,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;YACrE,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAClD,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;SACrD;IACH,CAAC;IACO,MAAM,CAAC,+BAA+B;QAC5C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,SAAS,EAAE;YACrE,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YACrD,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;SACxD;IACH,CAAC;IAID,8EAA8E;IACvE,MAAM,CAAC,KAAK,CAAC,yBAAyB;QAC3C,OAAO,IAAI,CAAC,YAAY,CAAC,yBAAyB,EAAE,CAAC;IACvD,CAAC;IACD,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,MAAkC;QACjF,OAAO,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,0BAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACnF,CAAC;IAEM,MAAM,KAAK,OAAO,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE9D;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAsB,EAAE,IAAoB;QACtE,MAAM,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;YAC3B,8BAAoB,CAAC,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC;YACtD,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;SACpJ;IACH,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,QAAQ;;QAC1B,MAAA,IAAI,CAAC,gBAAgB,+CAArB,IAAI,CAAqB,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;IAYM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAC1C,OAAe,EACf,QAAgB,EAChB,eAAyC,EACzC,OAAsB,2BAAa,CAAC,MAAM,EAAE,EAC5C,QAA2B;;QAE3B,MAAM,oBAAoB,GAAG,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,eAAe,CAAC,gBAAgB,CAAC;QAE9E,IAAI,kBAAkB,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;QACnC,IAAI,oBAAoB,EAAE;YACxB,MAAM,cAAc,GAAG,CAAC,IAAW,EAAE,IAAuC,EAAE,EAAE;;gBAC9E,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,IAAI,CAAC,CAAC;gBACjB,MAAA,eAAe,CAAC,gBAAgB,+CAAhC,eAAe,EAAoB,IAAI,CAAC,CAAC;YAC3C,CAAC,CAAC;YAEF,kBAAkB,GAAG,eAAM,CAAC,WAAW,CAAC,sBAAsB,QAAQ,EAAE,EAAE,cAAc,CAAC,CAAC;SAC3F;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,MAAA,eAAe,CAAC,QAAQ,mCAAI,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;gBACF,MAAM,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,YAAY,EAAE,oBAAoB,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;aACjH;oBAAS;gBACR,kBAAkB,EAAE,CAAC;aACtB;QACH,CAAC,CAAC;QAEF,MAAM,aAAa,GAAG,KAAK,IAAsB,EAAE;YACjD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,8BAA8B,CAAC,QAAQ,CAAC,CAAC;YAChF,IAAI,MAAM;gBACR,kBAAkB,EAAE,CAAC;YACvB,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QAEF,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,EAAE,aAAa,EAAE,CAAC;IACjF,CAAC;IAED,4EAA4E;IACrE,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,KAAqB;QAC5D,OAAO,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAgB;QAClD,MAAM,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED,oFAAoF;IAC7E,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,QAAqB;QAC3D,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,IAAY;QAC1C,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC;YAC1B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;QAEnC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QACxC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,OAAgB,EAAE,gBAAyB,KAAK;QAC/E,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,eAAe,OAAO,CAAC,EAAE,YAAY,CAAC,CAAC;QAEzD,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;QACnE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,KAAK,CAAC,eAAe;QACjC,OAAO,SAAS,CAAC,YAAY,CAAC,eAAe,EAAE,CAAC;IAClD,CAAC;;AAhLH,8BAiLC;;AA1KC,kFAAkF;AACpE,sBAAY,GAAG,eAAM,CAAC,YAAY,CAAqB,8BAAgB,CAAE,CAAA;AAExE,mBAAS,GAAG,IAAI,GAAG,EAAoB,CAAA;AACvC,mBAAS,GAAG,KAAK,IAAI,EAAE;IACpC,MAAM,SAAS,CAAC,eAAe,CAAC,0BAAY,CAAC,OAAO,EAAE,wCAA0B,CAAC,MAAM,CAAC,CAAC;AAC3F,CAAE,CAAA;AACa,oBAAU,GAAG,KAAK,IAAI,EAAE;IACrC,MAAM,SAAS,CAAC,eAAe,CAAC,0BAAY,CAAC,OAAO,EAAE,wCAA0B,CAAC,OAAO,CAAC,CAAC;AAC5F,CAAE,CAAA;AAiBF,gEAAgE;AAClD,uCAA6B,GAAG,IAAI,sBAAO,EAAiD,CAAA;AAU3F,kBAAQ,GAAG,KAAM,CAAA;AAuIlC;;;;GAIG;AACH,MAAa,OAAO;IAClB,YAA4B,EAAU;QAAV,OAAE,GAAF,EAAE,CAAQ;IAAI,CAAC;IAE3C,sEAAsE;IAC/D,KAAK,CAAC,YAAY,CAAC,GAAW;QACnC,OAAO,SAAS,CAAC,YAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAClE,CAAC;IAED,8BAA8B;IACvB,KAAK,CAAC,OAAO,CAAC,GAAW;QAC9B,OAAO,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IACzD,CAAC;IAED,0BAA0B;IACnB,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,KAAmB;QACnD,OAAO,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO;QAClB,OAAO,SAAS,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,iCAAiC;IAC1B,KAAK,CAAC,UAAU,CAAC,GAAW;QACjC,OAAO,SAAS,CAAC,YAAY,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAC5D,CAAC;IAED,sCAAsC;IAC/B,KAAK,CAAC,SAAS;QACpB,OAAO,SAAS,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC;CACF;AAnCD,0BAmCC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module NativeApp\r\n */\r\n\r\nimport { AsyncMethodsOf, BeEvent, GuidString, Logger, PromiseReturnType } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseDownloader, BriefcaseProps, IModelVersion, InternetConnectivityStatus, IpcSocketFrontend, LocalBriefcaseProps,\r\n  nativeAppChannel, NativeAppFunctions, NativeAppNotifications, nativeAppNotify, OverriddenBy,\r\n  RemoveFunction, RequestNewBriefcaseProps, StorageValue, SyncMode,\r\n} from \"@itwin/core-common\";\r\nimport { ProgressCallback, RequestGlobalOptions } from \"./request/Request\";\r\nimport { FrontendLoggerCategory } from \"./FrontendLoggerCategory\";\r\nimport { IpcApp, IpcAppOptions, NotificationHandler } from \"./IpcApp\";\r\nimport { NativeAppLogger } from \"./NativeAppLogger\";\r\nimport { OnDownloadProgress } from \"./BriefcaseConnection\";\r\n\r\n/** Properties for specifying the BriefcaseId for downloading. May either specify a BriefcaseId directly (preferable) or, for\r\n * backwards compatibility, a [SyncMode]($common). If [SyncMode.PullAndPush]($common) is supplied, a new briefcaseId will be acquired.\r\n * @public\r\n */\r\nexport type DownloadBriefcaseId =\r\n  { syncMode?: SyncMode, briefcaseId?: never } |\r\n  { briefcaseId: number, syncMode?: never };\r\n\r\n/**\r\n* Options to download a briefcase\r\n* @public\r\n*/\r\nexport type DownloadBriefcaseOptions = DownloadBriefcaseId & {\r\n  /** the full path for the briefcase file */\r\n  fileName?: string;\r\n  /** Function called regularly to report progress of download. */\r\n  progressCallback?: OnDownloadProgress;\r\n  /** interval for calling progress function, in milliseconds */\r\n  progressInterval?: number;\r\n};\r\n\r\n/** NativeApp notifications from backend */\r\nclass NativeAppNotifyHandler extends NotificationHandler implements NativeAppNotifications {\r\n  public get channelName() { return nativeAppNotify; }\r\n  public notifyInternetConnectivityChanged(status: InternetConnectivityStatus) {\r\n    Logger.logInfo(FrontendLoggerCategory.NativeApp, \"Internet connectivity changed\");\r\n    NativeApp.onInternetConnectivityChanged.raiseEvent(status);\r\n  }\r\n}\r\n\r\n/**\r\n * Options for [[NativeApp.startup]]\r\n * @public\r\n */\r\nexport interface NativeAppOpts extends IpcAppOptions {\r\n  nativeApp?: {};\r\n}\r\n\r\n/**\r\n * The frontend of a native application\r\n * @see [Native Applications]($docs/learning/NativeApps.md)\r\n * @public\r\n */\r\nexport class NativeApp {\r\n  private static _removeAppNotify?: RemoveFunction;\r\n\r\n  /** @deprecated in 3.x. use nativeAppIpc */\r\n  public static async callNativeHost<T extends AsyncMethodsOf<NativeAppFunctions>>(methodName: T, ...args: Parameters<NativeAppFunctions[T]>) {\r\n    return IpcApp.callIpcChannel(nativeAppChannel, methodName, ...args) as PromiseReturnType<NativeAppFunctions[T]>;\r\n  }\r\n  /** A Proxy to call one of the [NativeAppFunctions]($common) functions via IPC. */\r\n  public static nativeAppIpc = IpcApp.makeIpcProxy<NativeAppFunctions>(nativeAppChannel);\r\n\r\n  private static _storages = new Map<string, Storage>();\r\n  private static _onOnline = async () => {\r\n    await NativeApp.setConnectivity(OverriddenBy.Browser, InternetConnectivityStatus.Online);\r\n  };\r\n  private static _onOffline = async () => {\r\n    await NativeApp.setConnectivity(OverriddenBy.Browser, InternetConnectivityStatus.Offline);\r\n  };\r\n  private static async setConnectivity(by: OverriddenBy, status: InternetConnectivityStatus) {\r\n    RequestGlobalOptions.online = (status === InternetConnectivityStatus.Online);\r\n    await this.nativeAppIpc.overrideInternetConnectivity(by, status);\r\n  }\r\n  private static hookBrowserConnectivityEvents() {\r\n    if (typeof window === \"object\" && window.ononline && window.onoffline) {\r\n      window.addEventListener(\"online\", this._onOnline);\r\n      window.addEventListener(\"offline\", this._onOffline);\r\n    }\r\n  }\r\n  private static unhookBrowserConnectivityEvents() {\r\n    if (typeof window === \"object\" && window.ononline && window.onoffline) {\r\n      window.removeEventListener(\"online\", this._onOnline);\r\n      window.removeEventListener(\"offline\", this._onOffline);\r\n    }\r\n  }\r\n  /** event called when internet connectivity changes, if known */\r\n  public static onInternetConnectivityChanged = new BeEvent<(status: InternetConnectivityStatus) => void>();\r\n\r\n  /** determine whether the app currently has internet connectivity, if known */\r\n  public static async checkInternetConnectivity(): Promise<InternetConnectivityStatus> {\r\n    return this.nativeAppIpc.checkInternetConnectivity();\r\n  }\r\n  /** @internal */\r\n  public static async overrideInternetConnectivity(status: InternetConnectivityStatus): Promise<void> {\r\n    return this.nativeAppIpc.overrideInternetConnectivity(OverriddenBy.User, status);\r\n  }\r\n  private static _isValid = false;\r\n  public static get isValid(): boolean { return this._isValid; }\r\n\r\n  /**\r\n   * This is called by either ElectronApp.startup or MobileApp.startup - it should not be called directly\r\n   * @internal\r\n   */\r\n  public static async startup(ipc: IpcSocketFrontend, opts?: NativeAppOpts) {\r\n    await IpcApp.startup(ipc, opts);\r\n    if (this._isValid)\r\n      return;\r\n    this._isValid = true;\r\n\r\n    this._removeAppNotify = NativeAppNotifyHandler.register(); // receives notifications from backend\r\n    NativeApp.hookBrowserConnectivityEvents();\r\n\r\n    // initialize current online state.\r\n    if (window.navigator.onLine) {\r\n      RequestGlobalOptions.online = window.navigator.onLine;\r\n      await this.setConnectivity(OverriddenBy.Browser, window.navigator.onLine ? InternetConnectivityStatus.Online : InternetConnectivityStatus.Offline);\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  public static async shutdown() {\r\n    this._removeAppNotify?.();\r\n    NativeApp.unhookBrowserConnectivityEvents();\r\n    await NativeAppLogger.flush();\r\n    await IpcApp.shutdown();\r\n    this._isValid = false;\r\n  }\r\n\r\n  public static async requestDownloadBriefcase(iTwinId: string, iModelId: string, downloadOptions: DownloadBriefcaseOptions,\r\n    asOf?: IModelVersion): Promise<BriefcaseDownloader>;\r\n\r\n  /**\r\n   * @deprecated in 3.6. [[progress]] argument is now deprecated, use [[DownloadBriefcaseOptions.progressCallback]] instead.\r\n   */\r\n  public static async requestDownloadBriefcase(iTwinId: string, iModelId: string, downloadOptions: DownloadBriefcaseOptions,\r\n    // eslint-disable-next-line @typescript-eslint/unified-signatures\r\n    asOf?: IModelVersion, progress?: ProgressCallback): Promise<BriefcaseDownloader>;\r\n\r\n  public static async requestDownloadBriefcase(\r\n    iTwinId: string,\r\n    iModelId: string,\r\n    downloadOptions: DownloadBriefcaseOptions,\r\n    asOf: IModelVersion = IModelVersion.latest(),\r\n    progress?: ProgressCallback\r\n  ): Promise<BriefcaseDownloader> {\r\n    const shouldReportProgress = !!progress || !!downloadOptions.progressCallback;\r\n\r\n    let stopProgressEvents = () => { };\r\n    if (shouldReportProgress) {\r\n      const handleProgress = (_evt: Event, data: { loaded: number, total: number }) => {\r\n        progress?.(data);\r\n        downloadOptions.progressCallback?.(data);\r\n      };\r\n\r\n      stopProgressEvents = IpcApp.addListener(`nativeApp.progress-${iModelId}`, handleProgress);\r\n    }\r\n\r\n    const briefcaseId = (undefined !== downloadOptions.briefcaseId) ? downloadOptions.briefcaseId :\r\n      (downloadOptions.syncMode === SyncMode.PullOnly ? 0 : await this.nativeAppIpc.acquireNewBriefcaseId(iModelId));\r\n\r\n    const fileName = downloadOptions.fileName ?? await this.getBriefcaseFileName({ briefcaseId, iModelId });\r\n    const requestProps: RequestNewBriefcaseProps = { iModelId, briefcaseId, iTwinId, asOf: asOf.toJSON(), fileName };\r\n\r\n    const doDownload = async (): Promise<void> => {\r\n      try {\r\n        await this.nativeAppIpc.downloadBriefcase(requestProps, shouldReportProgress, downloadOptions.progressInterval);\r\n      } finally {\r\n        stopProgressEvents();\r\n      }\r\n    };\r\n\r\n    const requestCancel = async (): Promise<boolean> => {\r\n      const status = await this.nativeAppIpc.requestCancelDownloadBriefcase(fileName);\r\n      if (status)\r\n        stopProgressEvents();\r\n      return status;\r\n    };\r\n\r\n    return { briefcaseId, fileName, downloadPromise: doDownload(), requestCancel };\r\n  }\r\n\r\n  /** Get the full path filename for a briefcase within the briefcase cache */\r\n  public static async getBriefcaseFileName(props: BriefcaseProps): Promise<string> {\r\n    return this.nativeAppIpc.getBriefcaseFileName(props);\r\n  }\r\n\r\n  /** Delete an existing briefcase\r\n   * @param fileName the briefcase fileName\r\n   */\r\n  public static async deleteBriefcase(fileName: string): Promise<void> {\r\n    await this.nativeAppIpc.deleteBriefcaseFiles(fileName);\r\n  }\r\n\r\n  /** Get a list of all briefcase files held in the local briefcase cache directory */\r\n  public static async getCachedBriefcases(iModelId?: GuidString): Promise<LocalBriefcaseProps[]> {\r\n    return this.nativeAppIpc.getCachedBriefcases(iModelId);\r\n  }\r\n\r\n  /**\r\n   * Open a [[Storage]]. Creates a new Storage with that name if it does not already exist.\r\n   * @param name Should be a local filename without an extension.\r\n   * @returns a Promise for the [[Storage]].\r\n   */\r\n  public static async openStorage(name: string): Promise<Storage> {\r\n    if (this._storages.has(name))\r\n      return this._storages.get(name)!;\r\n\r\n    const storage = new Storage(await this.nativeAppIpc.storageMgrOpen(name));\r\n    this._storages.set(storage.id, storage);\r\n    return storage;\r\n  }\r\n\r\n  /**\r\n   * Close a Storage and optionally delete it.\r\n   * @param storage normally not call directly instead use Storage.close()\r\n   * @param deleteStorage if true, delete the storage from disk after closing it.\r\n   */\r\n  public static async closeStorage(storage: Storage, deleteStorage: boolean = false): Promise<void> {\r\n    if (!this._storages.has(storage.id))\r\n      throw new Error(`Storage [Id=${storage.id}] not open`);\r\n\r\n    await this.nativeAppIpc.storageMgrClose(storage.id, deleteStorage);\r\n    this._storages.delete(storage.id);\r\n  }\r\n\r\n  /** Get the list of existing Storages on the local disk. */\r\n  public static async getStorageNames(): Promise<string[]> {\r\n    return NativeApp.nativeAppIpc.storageMgrNames();\r\n  }\r\n}\r\n\r\n/**\r\n *  A local disk-based cache for key value pairs for NativeApps.\r\n * @note This should be used only for local caching, since its not guaranteed to exist permanently.\r\n * @public\r\n */\r\nexport class Storage {\r\n  constructor(public readonly id: string) { }\r\n\r\n  /** get the type of a value for a key, or undefined if not present. */\r\n  public async getValueType(key: string): Promise<\"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined> {\r\n    return NativeApp.nativeAppIpc.storageGetValueType(this.id, key);\r\n  }\r\n\r\n  /** Get the value for a key */\r\n  public async getData(key: string): Promise<StorageValue> {\r\n    return NativeApp.nativeAppIpc.storageGet(this.id, key);\r\n  }\r\n\r\n  /** Set value for a key */\r\n  public async setData(key: string, value: StorageValue): Promise<void> {\r\n    return NativeApp.nativeAppIpc.storageSet(this.id, key, value);\r\n  }\r\n\r\n  /**\r\n   * Return an array of all keys in this Storage.\r\n   * @note This can be expensive, depending on the number of keys present.\r\n   */\r\n  public async getKeys(): Promise<string[]> {\r\n    return NativeApp.nativeAppIpc.storageKeys(this.id);\r\n  }\r\n\r\n  /** Remove a key and its data. */\r\n  public async removeData(key: string): Promise<void> {\r\n    return NativeApp.nativeAppIpc.storageRemove(this.id, key);\r\n  }\r\n\r\n  /** Remove all keys and their data. */\r\n  public async removeAll(): Promise<void> {\r\n    return NativeApp.nativeAppIpc.storageRemoveAll(this.id);\r\n  }\r\n}\r\n"]}

package/lib/cjs/Viewport.d.ts

@@ -1071,7 +1071,7 @@ export declare abstract class Viewport implements IDisposable, TileUser {
      * @param flipVertically If true, the image is flipped along the x-axis.
      * @returns The contents of the viewport within the specified rectangle as a bitmap image, or undefined if the image could not be read.
      * @note By default the image is returned with the coordinate (0,0) referring to the bottom-most pixel. Pass `true` for `flipVertically` to flip it along the x-axis.
-     * @deprecated Use readImageBuffer.
+     * @deprecated in 3.x. Use readImageBuffer.
      */
     readImage(rect?: ViewRect, targetSize?: Point2d, flipVertically?: boolean): ImageBuffer | undefined;
     /** Capture the image currently rendered in this viewport, or a subset thereof.
@@ -1321,7 +1321,7 @@ export declare class ScreenViewport extends Viewport {
     /** @internal */
     mouseMovementFromEvent(ev: MouseEvent): XAndY;
     /** Set the event controller for this Viewport. Destroys previous controller, if one was defined.
-     * @deprecated this was intended for internal use only.
+     * @deprecated in 3.x. this was intended for internal use only.
      */
     setEventController(controller?: EventController): void;
     /** Invoked by ViewManager.addViewport.

package/lib/cjs/Viewport.js

@@ -2023,7 +2023,7 @@ class Viewport {
      * @param flipVertically If true, the image is flipped along the x-axis.
      * @returns The contents of the viewport within the specified rectangle as a bitmap image, or undefined if the image could not be read.
      * @note By default the image is returned with the coordinate (0,0) referring to the bottom-most pixel. Pass `true` for `flipVertically` to flip it along the x-axis.
-     * @deprecated Use readImageBuffer.
+     * @deprecated in 3.x. Use readImageBuffer.
      */
     readImage(rect = new ViewRect_1.ViewRect(1, 1, 0, 0), targetSize = core_geometry_1.Point2d.createZero(), flipVertically = false) {
         // eslint-disable-next-line deprecation/deprecation
@@ -2439,7 +2439,7 @@ class ScreenViewport extends Viewport {
         return { x: ev.movementX, y: ev.movementY };
     }
     /** Set the event controller for this Viewport. Destroys previous controller, if one was defined.
-     * @deprecated this was intended for internal use only.
+     * @deprecated in 3.x. this was intended for internal use only.
      */
     setEventController(controller) {
         if (this._evController)