@itwin/core-frontend 5.1.0-dev.7 → 5.1.0-dev.71

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,sDAA8F;AAC9F,oDAG4B;AAC5B,uDAA4D;AAC5D,2CAA0D;AAU1D;;;GAGG;AACH,MAAa,MAAM;IACT,MAAM,CAAC,IAAI,CAAgC;IACnD,qEAAqE;IAE7D,MAAM,KAAK,GAAG,KAAwB,OAAO,IAAI,CAAC,IAAK,CAAC,CAAC,CAAC;IAElE,iIAAiI;IAC1H,MAAM,KAAK,OAAO,KAAc,OAAO,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAExE;;;;;;;OAOG;IACI,MAAM,CAAC,WAAW,CAAC,OAAe,EAAE,OAAoB;QAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,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,mBAAmB,CAAC,QAAQ,EAAE,CAAC,CAAC,sCAAsC;QACtE,MAAM,qBAAS,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,MAAM,qBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;;AAtIH,wBAuIC;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, 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  /** Get the implementation of the [[IpcSocketFrontend]] interface. */\n\n  private static get ipc(): IpcSocketFrontend { return 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. 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    IpcAppNotifyHandler.register(); // receives notifications from backend\n    await IModelApp.startup(opts?.iModelApp);\n  }\n\n  /** @internal */\n  public static async shutdown() {\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,sDAA8F;AAC9F,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,IAAI,CAAC,IAAK,CAAC,CAAC,CAAC;IAElE,iIAAiI;IAC1H,MAAM,KAAK,OAAO,KAAc,OAAO,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAExE;;;;;;;OAOG;IACI,MAAM,CAAC,WAAW,CAAC,OAAe,EAAE,OAAoB;QAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,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, 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 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"]}

package/lib/cjs/RealityDataSource.d.ts

@@ -4,6 +4,8 @@
 import { BentleyError, GuidString, LoggingMetaData, RealityDataStatus } from "@itwin/core-bentley";
 import { Cartographic, EcefLocation, OrbitGtBlobProps, RealityData, RealityDataFormat, RealityDataProvider, RealityDataSourceKey } from "@itwin/core-common";
 import { Range3d } from "@itwin/core-geometry";
+import { DecorateContext } from "./ViewContext";
+import { ScreenViewport } from "./Viewport";
 /**
  * Reality Data Operation error
  * @alpha
@@ -133,7 +135,7 @@ export declare namespace RealityDataSource {
  * The provider's name is stored in a [RealityDataSourceKey]($common). When the [[RealityDataSource]] is requested from the key,
  * the provider is looked up in [[IModelApp.realityDataSourceProviders]] by its name and, if found, its [[createRealityDataSource]] method
  * is invoked to produce the reality data source.
- * @alpha
+ * @beta
  */
 export interface RealityDataSourceProvider {
     /** Produce a RealityDataSource for the specified `key`.
@@ -142,11 +144,19 @@ export interface RealityDataSourceProvider {
      * @returns the requested reality data source, or `undefined` if it could not be produced.
      */
     createRealityDataSource(key: RealityDataSourceKey, iTwinId: GuidString | undefined): Promise<RealityDataSource | undefined>;
+    /** Optionally add any decorations specific to this reality data source provider.
+     * For example, the Google Photorealistic 3D Tiles reality data source provider will add the Google logo.
+     */
+    decorate?(_context: DecorateContext): void;
+    /** Optionally add attribution logo cards to the viewport's logo div. */
+    addAttributions?(cards: HTMLTableElement, vp: ScreenViewport): Promise<void>;
+    /** Enables cached decorations for this provider. @see [[ViewportDecorator.useCachedDecorations]] */
+    useCachedDecorations?: true | undefined;
 }
 /** A registry of [[RealityDataSourceProvider]]s identified by their unique names. The registry can be accessed via [[IModelApp.realityDataSourceProviders]].
  * It includes a handful of built-in providers for sources like Cesium ION, ContextShare, OrbitGT, and arbitrary public-accessible URLs.
- * Any number of additional providers can be registered. They should typically be registered just after [[IModelAp.startup]].
- * @alpha
+ * Any number of additional providers can be registered. They should typically be registered just after [[IModelApp.startup]].
+ * @beta
  */
 export declare class RealityDataSourceProviderRegistry {
     private readonly _providers;
@@ -157,4 +167,56 @@ export declare class RealityDataSourceProviderRegistry {
     /** Look up the provider registered by the specified `name`. */
     find(name: string): RealityDataSourceProvider | undefined;
 }
+/**
+ * Options for creating a Google Photorealistic 3D Tiles reality data source provider.
+ * The caller must provide either an API key or a function that returns an auth token.
+ * @beta
+ */
+export type Google3dTilesProviderOptions = {
+    /** Google Map Tiles API Key used to access Google 3D Tiles. */
+    apiKey: string;
+    getAuthToken?: never;
+    /** If true, the data attributions/copyrights from the Google 3D Tiles will be displayed on screen. The Google Maps logo will always be displayed. Defaults to `true`. */
+    showCreditsOnScreen?: boolean;
+} | {
+    apiKey?: never;
+    /** Function that returns an OAuth token for authenticating with Google 3D Tiles. This token is expected to not contain the "Bearer" prefix. */
+    getAuthToken: () => Promise<string>;
+    /** If true, the data attributions/copyrights from the Google 3D Tiles will be displayed on screen. The Google Maps logo will always be displayed. Defaults to `true`. */
+    showCreditsOnScreen?: boolean;
+};
+/**
+ * Will provide Google Photorealistic 3D Tiles (in 3dTile format).
+ * A valid API key or getAuthToken fuction must be supplied when creating this provider.
+ * To use this provider, you must register it with [[IModelApp.realityDataSourceProviders]].
+ * Example usage:
+ * ```ts
+ * [[include:GooglePhotorealistic3dTiles_providerApiKey]]
+ * ```
+ * @see [Google Photorealistic 3D Tiles]($docs/learning/frontend/GooglePhotorealistic3dTiles.md)
+ * @beta
+ */
+export declare class Google3dTilesProvider implements RealityDataSourceProvider {
+    /** Google Map Tiles API Key used to access Google 3D Tiles. */
+    private _apiKey?;
+    /** Function that returns an OAuth token for authenticating with Google 3D Tiles. This token is expected to not contain the "Bearer" prefix. */
+    private _getAuthToken?;
+    /** Decorator for Google Maps logos. */
+    private _decorator;
+    /** Enables cached decorations for this provider. @see [[ViewportDecorator.useCachedDecorations]] */
+    readonly useCachedDecorations = true;
+    createRealityDataSource(key: RealityDataSourceKey, iTwinId: GuidString | undefined): Promise<RealityDataSource | undefined>;
+    constructor(options: Google3dTilesProviderOptions);
+    /**
+     * Initialize the Google 3D Tiles reality data source provider by activating its decorator, which consists of loading the correct Google Maps logo.
+     * @returns `true` if the decorator was successfully activated, otherwise `false`.
+     */
+    initialize(): Promise<boolean>;
+    decorate(_context: DecorateContext): void;
+    addAttributions(cards: HTMLTableElement, vp: ScreenViewport): Promise<void>;
+}
+/** Returns the URL used for retrieving Google Photorealistic 3D Tiles.
+ * @beta
+ */
+export declare function getGoogle3dTilesUrl(): string;
 //# sourceMappingURL=RealityDataSource.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"RealityDataSource.d.ts","sourceRoot":"","sources":["../../src/RealityDataSource.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,YAAY,EAAE,UAAU,EAAU,eAAe,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC3G,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAO7J,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAI/C;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;gBAC7B,WAAW,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,eAAe;CAGlG;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,6DAA6D;IAC7D,QAAQ,EAAE,YAAY,GAAG,YAAY,CAAC;IACtC,4CAA4C;IAC5C,UAAU,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,YAAY,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,GAAG,EAAE,oBAAoB,CAAC;IACnC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C,2CAA2C;IAC3C,QAAQ,CAAC,WAAW,EAAE,WAAW,GAAG,SAAS,CAAC;IAC9C,kGAAkG;IAClG,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7C;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC5E;;OAEG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IACtC;;;OAGG;IACH,QAAQ,CAAC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAC1C;;;;OAIG;IACH,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IAEpD;;;OAGG;IACH,eAAe,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/D;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3C;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC;;;;;OAKG;IACH,4BAA4B,IAAI,OAAO,CAAC,yBAAyB,GAAG,SAAS,CAAC,CAAC;IAC/E;;;;OAIG;IACH,uBAAuB,IAAI,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CAAC;IACrE;;;OAGG;IACH,aAAa,CAAC,IAAI,MAAM,GAAG,SAAS,CAAC;CACtC;AACD;;GAEG;AACH,yBAAiB,iBAAiB,CAAC;IACjC;;;;;OAKG;IACH,SAAgB,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,mBAAmB,EAAE,WAAW,CAAC,EAAE,iBAAiB,GAAG,oBAAoB,CA0B/I;IACD,gHAAgH;IAChH,SAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,mBAAmB,EAAE,WAAW,CAAC,EAAE,iBAAiB,GAAG,oBAAoB,CAMhJ;IACD,yCAAyC;IACzC,SAAgB,6BAA6B,CAAC,WAAW,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,mBAAmB,EAAE,WAAW,CAAC,EAAE,iBAAiB,GAAG,oBAAoB,CAUvK;IACD,yCAAyC;IACzC,SAAgB,6BAA6B,CAAC,WAAW,EAAE,oBAAoB,GAAG,gBAAgB,GAAG,SAAS,CAa7G;IACD,4DAA4D;IAC5D,SAAgB,uBAAuB,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,oBAAoB,CAGpG;IACD;;;OAGG;IACH,SAAsB,OAAO,CAAC,GAAG,EAAE,oBAAoB,EAAE,OAAO,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAQhI;CACF;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;OAIG;IACH,uBAAuB,CAAC,GAAG,EAAE,oBAAoB,EAAE,OAAO,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAC;CAC7H;AAED;;;;GAIG;AACH,qBAAa,iCAAiC;IAC5C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgD;IAE3E,gBAAgB;;IAiBhB,+FAA+F;IACxF,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,yBAAyB,GAAG,IAAI;IAIxE,+DAA+D;IACxD,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS;CAGjE"}
+{"version":3,"file":"RealityDataSource.d.ts","sourceRoot":"","sources":["../../src/RealityDataSource.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,YAAY,EAAiB,UAAU,EAAU,eAAe,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC1H,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC7J,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAS/C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAI5C;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;gBAC7B,WAAW,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,eAAe;CAGlG;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,6DAA6D;IAC7D,QAAQ,EAAE,YAAY,GAAG,YAAY,CAAC;IACtC,4CAA4C;IAC5C,UAAU,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,YAAY,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,GAAG,EAAE,oBAAoB,CAAC;IACnC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C,2CAA2C;IAC3C,QAAQ,CAAC,WAAW,EAAE,WAAW,GAAG,SAAS,CAAC;IAC9C,kGAAkG;IAClG,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7C;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC5E;;OAEG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IACtC;;;OAGG;IACH,QAAQ,CAAC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAC1C;;;;OAIG;IACH,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IAEpD;;;OAGG;IACH,eAAe,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/D;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3C;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC;;;;;OAKG;IACH,4BAA4B,IAAI,OAAO,CAAC,yBAAyB,GAAG,SAAS,CAAC,CAAC;IAC/E;;;;OAIG;IACH,uBAAuB,IAAI,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CAAC;IACrE;;;OAGG;IACH,aAAa,CAAC,IAAI,MAAM,GAAG,SAAS,CAAC;CACtC;AACD;;GAEG;AACH,yBAAiB,iBAAiB,CAAC;IACjC;;;;;OAKG;IACH,SAAgB,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,mBAAmB,EAAE,WAAW,CAAC,EAAE,iBAAiB,GAAG,oBAAoB,CA0B/I;IACD,gHAAgH;IAChH,SAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,mBAAmB,EAAE,WAAW,CAAC,EAAE,iBAAiB,GAAG,oBAAoB,CAMhJ;IACD,yCAAyC;IACzC,SAAgB,6BAA6B,CAAC,WAAW,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,mBAAmB,EAAE,WAAW,CAAC,EAAE,iBAAiB,GAAG,oBAAoB,CAUvK;IACD,yCAAyC;IACzC,SAAgB,6BAA6B,CAAC,WAAW,EAAE,oBAAoB,GAAG,gBAAgB,GAAG,SAAS,CAa7G;IACD,4DAA4D;IAC5D,SAAgB,uBAAuB,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,oBAAoB,CAGpG;IACD;;;OAGG;IACH,SAAsB,OAAO,CAAC,GAAG,EAAE,oBAAoB,EAAE,OAAO,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAQhI;CACF;AAED;;;;;GAKG;AAEH,MAAM,WAAW,yBAAyB;IACxC;;;;OAIG;IACH,uBAAuB,CAAC,GAAG,EAAE,oBAAoB,EAAE,OAAO,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAC;IAC5H;;OAEG;IACH,QAAQ,CAAC,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI,CAAC;IAC3C,wEAAwE;IACxE,eAAe,CAAC,CAAC,KAAK,EAAE,gBAAgB,EAAE,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7E,oGAAoG;IACpG,oBAAoB,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CACzC;AAED;;;;GAIG;AACH,qBAAa,iCAAiC;IAC5C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgD;IAE3E,gBAAgB;;IAiBhB,+FAA+F;IACxF,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,yBAAyB,GAAG,IAAI;IAIxE,+DAA+D;IACxD,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS;CAGjE;AAED;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,+DAA+D;IAC/D,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,KAAK,CAAC;IACrB,yKAAyK;IACzK,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B,GAAG;IACF,MAAM,CAAC,EAAE,KAAK,CAAC;IACf,+IAA+I;IAC/I,YAAY,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IACpC,yKAAyK;IACzK,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,qBAAa,qBAAsB,YAAW,yBAAyB;IACrE,+DAA+D;IAC/D,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,+IAA+I;IAC/I,OAAO,CAAC,aAAa,CAAC,CAAoC;IAC1D,uCAAuC;IACvC,OAAO,CAAC,UAAU,CAAsB;IACxC,oGAAoG;IACpG,SAAgB,oBAAoB,QAAQ;IAE/B,uBAAuB,CAAC,GAAG,EAAE,oBAAoB,EAAE,OAAO,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;gBAQrH,OAAO,EAAE,4BAA4B;IAMxD;;;OAGG;IACU,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;IAUpC,QAAQ,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI;IAInC,eAAe,CAAC,KAAK,EAAE,gBAAgB,EAAE,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAoBzF;AAED;;GAEG;AACH,wBAAgB,mBAAmB,WAElC"}

package/lib/cjs/RealityDataSource.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RealityDataSourceProviderRegistry = exports.RealityDataSource = exports.RealityDataError = void 0;
+exports.Google3dTilesProvider = exports.RealityDataSourceProviderRegistry = exports.RealityDataSource = exports.RealityDataError = void 0;
+exports.getGoogle3dTilesUrl = getGoogle3dTilesUrl;
 /*---------------------------------------------------------------------------------------------
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
@@ -15,7 +16,9 @@ const internal_1 = require("./tile/internal");
 const RealityDataSourceTilesetUrlImpl_1 = require("./RealityDataSourceTilesetUrlImpl");
 const RealityDataSourceContextShareImpl_1 = require("./RealityDataSourceContextShareImpl");
 const RealityDataSourceCesiumIonAssetImpl_1 = require("./RealityDataSourceCesiumIonAssetImpl");
+const RealityDataSourceGoogle3dTilesImpl_1 = require("./internal/RealityDataSourceGoogle3dTilesImpl");
 const IModelApp_1 = require("./IModelApp");
+const GoogleMapsDecorator_1 = require("./internal/GoogleMapsDecorator");
 const loggerCategory = FrontendLoggerCategory_1.FrontendLoggerCategory.RealityData;
 /**
  * Reality Data Operation error
@@ -125,8 +128,8 @@ var RealityDataSource;
 })(RealityDataSource || (exports.RealityDataSource = RealityDataSource = {}));
 /** A registry of [[RealityDataSourceProvider]]s identified by their unique names. The registry can be accessed via [[IModelApp.realityDataSourceProviders]].
  * It includes a handful of built-in providers for sources like Cesium ION, ContextShare, OrbitGT, and arbitrary public-accessible URLs.
- * Any number of additional providers can be registered. They should typically be registered just after [[IModelAp.startup]].
- * @alpha
+ * Any number of additional providers can be registered. They should typically be registered just after [[IModelApp.startup]].
+ * @beta
  */
 class RealityDataSourceProviderRegistry {
     _providers = new Map();
@@ -156,4 +159,77 @@ class RealityDataSourceProviderRegistry {
     }
 }
 exports.RealityDataSourceProviderRegistry = RealityDataSourceProviderRegistry;
+/**
+ * Will provide Google Photorealistic 3D Tiles (in 3dTile format).
+ * A valid API key or getAuthToken fuction must be supplied when creating this provider.
+ * To use this provider, you must register it with [[IModelApp.realityDataSourceProviders]].
+ * Example usage:
+ * ```ts
+ * [[include:GooglePhotorealistic3dTiles_providerApiKey]]
+ * ```
+ * @see [Google Photorealistic 3D Tiles]($docs/learning/frontend/GooglePhotorealistic3dTiles.md)
+ * @beta
+ */
+class Google3dTilesProvider {
+    /** Google Map Tiles API Key used to access Google 3D Tiles. */
+    _apiKey;
+    /** Function that returns an OAuth token for authenticating with Google 3D Tiles. This token is expected to not contain the "Bearer" prefix. */
+    _getAuthToken;
+    /** Decorator for Google Maps logos. */
+    _decorator;
+    /** Enables cached decorations for this provider. @see [[ViewportDecorator.useCachedDecorations]] */
+    useCachedDecorations = true;
+    async createRealityDataSource(key, iTwinId) {
+        if (!this._apiKey && !this._getAuthToken) {
+            core_bentley_1.Logger.logError(loggerCategory, "Either an API key or getAuthToken function are required to create a Google3dTilesProvider.");
+            return undefined;
+        }
+        return RealityDataSourceGoogle3dTilesImpl_1.RealityDataSourceGoogle3dTilesImpl.createFromKey(key, iTwinId, this._apiKey, this._getAuthToken);
+    }
+    constructor(options) {
+        this._apiKey = options.apiKey;
+        this._getAuthToken = options.getAuthToken;
+        this._decorator = new GoogleMapsDecorator_1.GoogleMapsDecorator(options.showCreditsOnScreen ?? true);
+    }
+    /**
+     * Initialize the Google 3D Tiles reality data source provider by activating its decorator, which consists of loading the correct Google Maps logo.
+     * @returns `true` if the decorator was successfully activated, otherwise `false`.
+     */
+    async initialize() {
+        const isActivated = await this._decorator.activate("satellite");
+        if (!isActivated) {
+            const msg = "Failed to activate decorator";
+            core_bentley_1.Logger.logError(loggerCategory, msg);
+            throw new core_bentley_1.BentleyError(core_bentley_1.BentleyStatus.ERROR, msg);
+        }
+        return isActivated;
+    }
+    decorate(_context) {
+        this._decorator.decorate(_context);
+    }
+    async addAttributions(cards, vp) {
+        const copyrightMap = (0, GoogleMapsDecorator_1.getCopyrights)(vp);
+        // Only add another logo card if the tiles have copyright
+        if (copyrightMap.size > 0) {
+            // Order by most occurances to least
+            // See https://developers.google.com/maps/documentation/tile/create-renderer#display-attributions
+            const sortedCopyrights = [...copyrightMap.entries()].sort((a, b) => b[1] - a[1]);
+            let copyrightMsg = "Data provided by:<br><ul>";
+            copyrightMsg += sortedCopyrights.map(([key]) => `<li>${key}</li>`).join("");
+            copyrightMsg += "</ul>";
+            cards.appendChild(IModelApp_1.IModelApp.makeLogoCard({
+                iconSrc: `${IModelApp_1.IModelApp.publicPath}images/google_on_white_hdpi.png`,
+                heading: "Google Photorealistic 3D Tiles",
+                notice: copyrightMsg
+            }));
+        }
+    }
+}
+exports.Google3dTilesProvider = Google3dTilesProvider;
+/** Returns the URL used for retrieving Google Photorealistic 3D Tiles.
+ * @beta
+ */
+function getGoogle3dTilesUrl() {
+    return "https://tile.googleapis.com/v1/3dtiles/root.json";
+}
 //# sourceMappingURL=RealityDataSource.js.map

package/lib/cjs/RealityDataSource.js.map

@@ -1 +1 @@
-{"version":3,"file":"RealityDataSource.js","sourceRoot":"","sources":["../../src/RealityDataSource.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,sDAA2G;AAC3G,oDAA6J;AAC7J,4EAAyE;AACzE,8CAAkG;AAClG,uFAAoF;AACpF,2FAAwF;AACxF,+FAA4F;AAC5F,2CAAwC;AAGxC,MAAM,cAAc,GAAW,+CAAsB,CAAC,WAAW,CAAC;AAElE;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,2BAAY;IAChD,YAAmB,WAA8B,EAAE,OAAe,EAAE,WAA6B;QAC/F,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC3C,CAAC;CACF;AAJD,4CAIC;AAkGD;;GAEG;AACH,IAAiB,iBAAiB,CAuFjC;AAvFD,WAAiB,iBAAiB;IAChC;;;;;OAKG;IACH,SAAgB,gBAAgB,CAAC,UAAkB,EAAE,aAAmC,EAAE,WAA+B;QACvH,IAAI,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,+BAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC/E,IAAI,iCAAsB,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;YACrD,MAAM,QAAQ,GAAG,iCAAmB,CAAC,cAAc,CAAC;YACpD,IAAI,iBAAiB,GAAyB,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAG,iCAAsB,CAAC,aAAa,EAAE,CAAC,CAAC,uBAAuB;YACtI,6DAA6D;YAC7D,MAAM,WAAW,GAAG,iCAAsB,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YACtE,IAAI,WAAW,EAAE,CAAC;gBAChB,iBAAiB,GAAG,iBAAiB,CAAC,uBAAuB,CAAC,WAAW,CAAC,EAAE,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;YACjG,CAAC;YACD,OAAO,iBAAiB,CAAC;QAC3B,CAAC;QAED,oFAAoF;QACpF,IAAI,+BAAoB,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,GAAG,+BAAoB,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YAC7D,MAAM,QAAQ,GAAG,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC/D,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;YACjD,MAAM,eAAe,GAAyB,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;YACvG,OAAO,eAAe,CAAC;QACzB,CAAC;QAED,wBAAwB;QACxB,MAAM,SAAS,GAAG,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,iCAAmB,CAAC,UAAU,CAAC;QACjF,MAAM,MAAM,GAAyB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC;QACrF,OAAO,MAAM,CAAC;IAChB,CAAC;IA1Be,kCAAgB,mBA0B/B,CAAA;IACD,gHAAgH;IAChH,SAAgB,oBAAoB,CAAC,OAAe,EAAE,aAAmC,EAAE,WAA+B;QACxH,MAAM,IAAI,GAAG,+BAAoB,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC9D,MAAM,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QACvD,MAAM,QAAQ,GAAG,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;QAC/D,MAAM,eAAe,GAAyB,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;QAChF,OAAO,eAAe,CAAC;IACzB,CAAC;IANe,sCAAoB,uBAMnC,CAAA;IACD,yCAAyC;IACzC,SAAgB,6BAA6B,CAAC,WAA6B,EAAE,aAAmC,EAAE,WAA+B;QAC/I,MAAM,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,+BAAiB,CAAC,GAAG,CAAC;QACjE,IAAI,WAAW,CAAC,YAAY,IAAI,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1F,OAAO,iBAAiB,CAAC,oBAAoB,CAAC,WAAW,CAAC,YAAY,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;QACjG,CAAC;aAAM,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;YAC9B,OAAO,iBAAiB,CAAC,gBAAgB,CAAC,WAAW,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;QACvF,CAAC;QACD,MAAM,QAAQ,GAAG,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,iCAAmB,CAAC,WAAW,CAAC;QACjF,MAAM,EAAE,GAAG,GAAG,WAAW,CAAC,WAAW,IAAI,WAAW,CAAC,aAAa,IAAI,WAAW,CAAC,YAAY,KAAK,WAAW,CAAC,QAAQ,EAAE,CAAC;QAC1H,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAClC,CAAC;IAVe,+CAA6B,gCAU5C,CAAA;IACD,yCAAyC;IACzC,SAAgB,6BAA6B,CAAC,WAAiC;QAC7E,IAAI,WAAW,CAAC,QAAQ,KAAK,iCAAmB,CAAC,WAAW;YAC1D,OAAO,SAAS,CAAC;QACnB,MAAM,QAAQ,GAAG,WAAW,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3C,MAAM,aAAa,GAAG,WAAW,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnD,MAAM,QAAQ,GAAG,WAAW,CAAC,EAAE,CAAC,SAAS,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC;QAC7D,MAAM,WAAW,GAAqB;YACpC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;YACxB,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC1B,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC;YACzB,QAAQ;SACT,CAAC;QACF,OAAO,WAAW,CAAC;IACrB,CAAC;IAbe,+CAA6B,gCAa5C,CAAA;IACD,4DAA4D;IAC5D,SAAgB,uBAAuB,CAAC,UAAkB,EAAE,UAAkB;QAC5E,MAAM,EAAE,GAAG,IAAA,4BAAiB,EAAC,UAAU,EAAC,UAAU,CAAC,CAAC;QACpD,OAAO,EAAC,QAAQ,EAAE,iCAAmB,CAAC,cAAc,EAAE,MAAM,EAAE,+BAAiB,CAAC,UAAU,EAAE,EAAE,EAAC,CAAC;IAClG,CAAC;IAHe,yCAAuB,0BAGtC,CAAA;IACD;;;OAGG;IACI,KAAK,UAAU,OAAO,CAAC,GAAyB,EAAE,OAA+B;QACtF,MAAM,QAAQ,GAAG,qBAAS,CAAC,0BAA0B,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,qBAAM,CAAC,UAAU,CAAC,cAAc,EAAE,8BAA8B,GAAG,CAAC,QAAQ,qBAAqB,CAAC,CAAC;YACnG,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,QAAQ,CAAC,uBAAuB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IARqB,yBAAO,UAQ5B,CAAA;AACH,CAAC,EAvFgB,iBAAiB,iCAAjB,iBAAiB,QAuFjC;AAiBD;;;;GAIG;AACH,MAAa,iCAAiC;IAC3B,UAAU,GAAG,IAAI,GAAG,EAAqC,CAAC;IAE3E,gBAAgB;IAChB;QACE,IAAI,CAAC,QAAQ,CAAC,iCAAmB,CAAC,cAAc,EAAE;YAChD,uBAAuB,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,yEAAmC,CAAC,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC;SACjH,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,iCAAmB,CAAC,UAAU,EAAE;YAC5C,uBAAuB,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,iEAA+B,CAAC,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC;SAC7G,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,iCAAmB,CAAC,YAAY,EAAE;YAC9C,uBAAuB,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,qEAAiC,CAAC,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC;SAC/G,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,iCAAmB,CAAC,WAAW,EAAE;YAC7C,kCAAkC;YAClC,uBAAuB,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,iEAA+B,CAAC,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC;SAC7G,CAAC,CAAC;IACL,CAAC;IAED,+FAA+F;IACxF,QAAQ,CAAC,IAAY,EAAE,QAAmC;QAC/D,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED,+DAA+D;IACxD,IAAI,CAAC,IAAY;QACtB,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;CACF;AA7BD,8EA6BC","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 { BentleyError, GuidString, Logger, LoggingMetaData, RealityDataStatus } from \"@itwin/core-bentley\";\nimport { Cartographic, EcefLocation, OrbitGtBlobProps, RealityData, RealityDataFormat, RealityDataProvider, RealityDataSourceKey } from \"@itwin/core-common\";\nimport { FrontendLoggerCategory } from \"./common/FrontendLoggerCategory\";\nimport { CesiumIonAssetProvider, ContextShareProvider, getCesiumAssetUrl } from \"./tile/internal\";\nimport { RealityDataSourceTilesetUrlImpl } from \"./RealityDataSourceTilesetUrlImpl\";\nimport { RealityDataSourceContextShareImpl } from \"./RealityDataSourceContextShareImpl\";\nimport { RealityDataSourceCesiumIonAssetImpl } from \"./RealityDataSourceCesiumIonAssetImpl\";\nimport { IModelApp } from \"./IModelApp\";\nimport { Range3d } from \"@itwin/core-geometry\";\n\nconst loggerCategory: string = FrontendLoggerCategory.RealityData;\n\n/**\n * Reality Data Operation error\n * @alpha\n */\nexport class RealityDataError extends BentleyError {\n  public constructor(errorNumber: RealityDataStatus, message: string, getMetaData?: LoggingMetaData) {\n    super(errorNumber, message, getMetaData);\n  }\n}\n\n/** This interface provide spatial location and volume of interest, in meters, centered around `spatial location`\n * @alpha\n */\nexport interface SpatialLocationAndExtents {\n  /** location of the point at the center of the reaity data */\n  location: Cartographic | EcefLocation;\n  /** extents of the volume around location */\n  worldRange: Range3d;\n  /** true if this reality data is geolocated\n   * A reality data is geolocated when we can compute a valid position relative to the earth surface.\n   * Note that some reality data contains custom coordinate system without any information on the relative position on earth.\n   * These reality data will have a location and worldRange but will be identified by the isGeoLocated set to false.\n   */\n  isGeolocated: boolean;\n}\n\n/** This interface provides information to identify the product and engine that create this reality data\n * @alpha\n */\nexport interface PublisherProductInfo {\n  /** product that create this reality data */\n  product: string;\n  /** engine that create this reality data */\n  engine: string;\n  /** the version of the engine that create this reality data */\n  version: string;\n}\n\n/** This interface provide methods used to access a reality data from a reality data provider\n * @beta\n */\nexport interface RealityDataSource {\n  readonly key: RealityDataSourceKey;\n  readonly isContextShare: boolean;\n  readonly realityDataId: string | undefined;\n  /** Metatdata on the reality data source */\n  readonly realityData: RealityData | undefined;\n  /** The reality data type (e.g.: \"RealityMesh3DTiles\", OPC, Terrain3DTiles, Cesium3DTiles, ... )*/\n  readonly realityDataType: string | undefined;\n  /** This method returns the URL to obtain the Reality Data properties.\n   * @param iTwinId id of associated iTwin project\n   * @returns string containing the URL to reality data.\n   */\n  getServiceUrl(iTwinId: GuidString | undefined): Promise<string | undefined>;\n  /** If true, the geometricError property of the tiles will be used to compute screen-space error.\n   * @alpha\n   */\n  readonly usesGeometricError?: boolean;\n  /** If [[usesGeometricError]] is `true`, optionally specifies the maximum error, in pixels, to permit for a tile before requiring refinement of that tile.\n   * Default: 16\n   * @alpha\n   */\n  readonly maximumScreenSpaceError?: number;\n  /** Given the URL of a tile's content, return the type of that content.\n   * \"tileset\" indicates the content points to a JSON tileset describing the structure of the tile tree below the tile.\n   * \"tile\" indicates the content points to a binary representation of the tile's graphics.\n   * @alpha\n   */\n  getTileContentType(url: string): \"tile\" | \"tileset\";\n\n  /** Gets a reality data root document json\n   * @returns tile data json\n   * @internal\n   */\n  getRootDocument(iTwinId: GuidString | undefined): Promise<any>;\n  /** Gets tile content\n   * @param name name or path of tile\n   * @returns array buffer of tile content\n   * @internal\n   */\n  getTileContent(name: string): Promise<any>;\n  /** Gets a tileset's app data json\n   * @param name name or path of tile\n   * @returns app data json object\n   * @internal\n   */\n  getTileJson(name: string): Promise<any>;\n  /** Gets spatial location and extents of this reality data source.\n   * Will return undefined if cannot be resolved or is unbounded (cover entire earth eg: Open Street Map Building from Ion Asset)\n   * @returns spatial location and extents\n   * @throws [[RealityDataError]] if source is invalid or cannot be read\n   * @alpha\n   */\n  getSpatialLocationAndExtents(): Promise<SpatialLocationAndExtents | undefined>;\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  getPublisherProductInfo(): Promise<PublisherProductInfo | undefined>;\n  /** Optional, gets the tileset url associated with the reality data source\n   * @returns tileset url\n   * @internal\n   */\n  getTilesetUrl?(): string | undefined;\n}\n/** Utility functions for RealityDataSource\n * @beta\n */\nexport namespace RealityDataSource {\n  /** Create a RealityDataSourceKey from a tilesetUrl.\n   * @param tilesetUrl the reality data attachment url\n   * @param inputProvider identify the RealityDataProvider if known, otherwise function will try to extract it from the tilesetUrl\n   * @param inputFormat identify the RealityDataFormat if known, otherwise function will try to extract it from the tilesetUrl\n   * @returns the RealityDataSourceKey that uniquely identify a reality data for a provider\n   */\n  export function createKeyFromUrl(tilesetUrl: string, inputProvider?: RealityDataProvider, inputFormat?: RealityDataFormat): RealityDataSourceKey {\n    let format = inputFormat ? inputFormat : RealityDataFormat.fromUrl(tilesetUrl);\n    if (CesiumIonAssetProvider.isProviderUrl(tilesetUrl)) {\n      const provider = RealityDataProvider.CesiumIonAsset;\n      let cesiumIonAssetKey: RealityDataSourceKey = { provider, format, id:  CesiumIonAssetProvider.osmBuildingId }; // default OSM building\n      // Parse URL to extract possible asset id and key if provided\n      const cesiumAsset = CesiumIonAssetProvider.parseCesiumUrl(tilesetUrl);\n      if (cesiumAsset) {\n        cesiumIonAssetKey = RealityDataSource.createCesiumIonAssetKey(cesiumAsset.id, cesiumAsset.key);\n      }\n      return cesiumIonAssetKey;\n    }\n\n    // Try to extract realityDataId from URL and if not possible, use the url as the key\n    if (ContextShareProvider.isProviderUrl(tilesetUrl)) {\n      const info = ContextShareProvider.getInfoFromUrl(tilesetUrl);\n      const provider = inputProvider ? inputProvider : info.provider;\n      format = inputFormat ? inputFormat : info.format;\n      const contextShareKey: RealityDataSourceKey = { provider, format, id: info.id, iTwinId: info.iTwinId };\n      return contextShareKey;\n    }\n\n    // default to tileSetUrl\n    const provider2 = inputProvider ? inputProvider : RealityDataProvider.TilesetUrl;\n    const urlKey: RealityDataSourceKey = { provider: provider2, format, id: tilesetUrl };\n    return urlKey;\n  }\n  /** @alpha - was used for a very specific case of point cloud (opc) attachment that should not be made public */\n  export function createKeyFromBlobUrl(blobUrl: string, inputProvider?: RealityDataProvider, inputFormat?: RealityDataFormat): RealityDataSourceKey {\n    const info = ContextShareProvider.getInfoFromBlobUrl(blobUrl);\n    const format = inputFormat ? inputFormat : info.format;\n    const provider = inputProvider ? inputProvider : info.provider;\n    const contextShareKey: RealityDataSourceKey = { provider, format, id: info.id };\n    return contextShareKey;\n  }\n  /** @alpha - OrbitGtBlobProps is alpha */\n  export function createKeyFromOrbitGtBlobProps(orbitGtBlob: OrbitGtBlobProps, inputProvider?: RealityDataProvider, inputFormat?: RealityDataFormat): RealityDataSourceKey {\n    const format = inputFormat ? inputFormat : RealityDataFormat.OPC;\n    if (orbitGtBlob.blobFileName && orbitGtBlob.blobFileName.toLowerCase().startsWith(\"http\")) {\n      return RealityDataSource.createKeyFromBlobUrl(orbitGtBlob.blobFileName, inputProvider, format);\n    } else if (orbitGtBlob.rdsUrl) {\n      return RealityDataSource.createKeyFromUrl(orbitGtBlob.rdsUrl, inputProvider, format);\n    }\n    const provider = inputProvider ? inputProvider : RealityDataProvider.OrbitGtBlob;\n    const id = `${orbitGtBlob.accountName}:${orbitGtBlob.containerName}:${orbitGtBlob.blobFileName}:?${orbitGtBlob.sasToken}`;\n    return { provider, format, id };\n  }\n  /** @alpha - OrbitGtBlobProps is alpha */\n  export function createOrbitGtBlobPropsFromKey(rdSourceKey: RealityDataSourceKey): OrbitGtBlobProps | undefined {\n    if (rdSourceKey.provider !== RealityDataProvider.OrbitGtBlob)\n      return undefined;\n    const splitIds = rdSourceKey.id.split(\":\");\n    const sasTokenIndex = rdSourceKey.id.indexOf(\":?\");\n    const sasToken = rdSourceKey.id.substring(sasTokenIndex + 2);\n    const orbitGtBlob: OrbitGtBlobProps = {\n      accountName: splitIds[0],\n      containerName: splitIds[1],\n      blobFileName: splitIds[2],\n      sasToken,\n    };\n    return orbitGtBlob;\n  }\n  /** @internal - Is used by \"fdt attach cesium asset\" keyin*/\n  export function createCesiumIonAssetKey(osmAssetId: number, requestKey: string): RealityDataSourceKey {\n    const id = getCesiumAssetUrl(osmAssetId,requestKey);\n    return {provider: RealityDataProvider.CesiumIonAsset, format: RealityDataFormat.ThreeDTile, id};\n  }\n  /** Return an instance of a RealityDataSource from a source key.\n   * There will aways be only one reality data RealityDataSource for a corresponding reality data source key.\n   * @alpha\n   */\n  export async function fromKey(key: RealityDataSourceKey, iTwinId: GuidString | undefined): Promise<RealityDataSource | undefined> {\n    const provider = IModelApp.realityDataSourceProviders.find(key.provider);\n    if (!provider) {\n      Logger.logWarning(loggerCategory, `RealityDataSourceProvider \"${key.provider}\" is not registered`);\n      return undefined;\n    }\n\n    return provider.createRealityDataSource(key, iTwinId);\n  }\n}\n\n/** A named supplier of [RealityDataSource]]s.\n * The provider's name is stored in a [RealityDataSourceKey]($common). When the [[RealityDataSource]] is requested from the key,\n * the provider is looked up in [[IModelApp.realityDataSourceProviders]] by its name and, if found, its [[createRealityDataSource]] method\n * is invoked to produce the reality data source.\n * @alpha\n */\nexport interface RealityDataSourceProvider {\n  /** Produce a RealityDataSource for the specified `key`.\n   * @param key Identifies the reality data source.\n   * @param iTwinId A default iTwinId to use.\n   * @returns the requested reality data source, or `undefined` if it could not be produced.\n   */\n  createRealityDataSource(key: RealityDataSourceKey, iTwinId: GuidString | undefined): Promise<RealityDataSource | undefined>;\n}\n\n/** A registry of [[RealityDataSourceProvider]]s identified by their unique names. The registry can be accessed via [[IModelApp.realityDataSourceProviders]].\n * It includes a handful of built-in providers for sources like Cesium ION, ContextShare, OrbitGT, and arbitrary public-accessible URLs.\n * Any number of additional providers can be registered. They should typically be registered just after [[IModelAp.startup]].\n * @alpha\n */\nexport class RealityDataSourceProviderRegistry {\n  private readonly _providers = new Map<string, RealityDataSourceProvider>();\n\n  /** @internal */\n  public constructor() {\n    this.register(RealityDataProvider.CesiumIonAsset, {\n      createRealityDataSource: async (key, iTwinId) => RealityDataSourceCesiumIonAssetImpl.createFromKey(key, iTwinId),\n    });\n    this.register(RealityDataProvider.TilesetUrl, {\n      createRealityDataSource: async (key, iTwinId) => RealityDataSourceTilesetUrlImpl.createFromKey(key, iTwinId),\n    });\n    this.register(RealityDataProvider.ContextShare, {\n      createRealityDataSource: async (key, iTwinId) => RealityDataSourceContextShareImpl.createFromKey(key, iTwinId),\n    });\n    this.register(RealityDataProvider.OrbitGtBlob, {\n      // ###TODO separate TilesetUrlImpl\n      createRealityDataSource: async (key, iTwinId) => RealityDataSourceTilesetUrlImpl.createFromKey(key, iTwinId),\n    });\n  }\n\n  /** Register `provider` to produce [[RealityDataSource]]s for the specified provider `name`. */\n  public register(name: string, provider: RealityDataSourceProvider): void {\n    this._providers.set(name, provider);\n  }\n\n  /** Look up the provider registered by the specified `name`. */\n  public find(name: string): RealityDataSourceProvider | undefined {\n    return this._providers.get(name);\n  }\n}\n"]}
+{"version":3,"file":"RealityDataSource.js","sourceRoot":"","sources":["../../src/RealityDataSource.ts"],"names":[],"mappings":";;;AA0XA,kDAEC;AA5XD;;;+FAG+F;AAC/F;;GAEG;AACH,sDAA0H;AAC1H,oDAA6J;AAE7J,4EAAyE;AACzE,8CAAkG;AAClG,uFAAoF;AACpF,2FAAwF;AACxF,+FAA4F;AAC5F,sGAAmG;AACnG,2CAAwC;AACxC,wEAAoF;AAIpF,MAAM,cAAc,GAAW,+CAAsB,CAAC,WAAW,CAAC;AAElE;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,2BAAY;IAChD,YAAmB,WAA8B,EAAE,OAAe,EAAE,WAA6B;QAC/F,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC3C,CAAC;CACF;AAJD,4CAIC;AAkGD;;GAEG;AACH,IAAiB,iBAAiB,CAuFjC;AAvFD,WAAiB,iBAAiB;IAChC;;;;;OAKG;IACH,SAAgB,gBAAgB,CAAC,UAAkB,EAAE,aAAmC,EAAE,WAA+B;QACvH,IAAI,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,+BAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC/E,IAAI,iCAAsB,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;YACrD,MAAM,QAAQ,GAAG,iCAAmB,CAAC,cAAc,CAAC;YACpD,IAAI,iBAAiB,GAAyB,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAG,iCAAsB,CAAC,aAAa,EAAE,CAAC,CAAC,uBAAuB;YACtI,6DAA6D;YAC7D,MAAM,WAAW,GAAG,iCAAsB,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YACtE,IAAI,WAAW,EAAE,CAAC;gBAChB,iBAAiB,GAAG,iBAAiB,CAAC,uBAAuB,CAAC,WAAW,CAAC,EAAE,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;YACjG,CAAC;YACD,OAAO,iBAAiB,CAAC;QAC3B,CAAC;QAED,oFAAoF;QACpF,IAAI,+BAAoB,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,GAAG,+BAAoB,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YAC7D,MAAM,QAAQ,GAAG,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC/D,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;YACjD,MAAM,eAAe,GAAyB,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;YACvG,OAAO,eAAe,CAAC;QACzB,CAAC;QAED,wBAAwB;QACxB,MAAM,SAAS,GAAG,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,iCAAmB,CAAC,UAAU,CAAC;QACjF,MAAM,MAAM,GAAyB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC;QACrF,OAAO,MAAM,CAAC;IAChB,CAAC;IA1Be,kCAAgB,mBA0B/B,CAAA;IACD,gHAAgH;IAChH,SAAgB,oBAAoB,CAAC,OAAe,EAAE,aAAmC,EAAE,WAA+B;QACxH,MAAM,IAAI,GAAG,+BAAoB,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC9D,MAAM,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QACvD,MAAM,QAAQ,GAAG,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;QAC/D,MAAM,eAAe,GAAyB,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;QAChF,OAAO,eAAe,CAAC;IACzB,CAAC;IANe,sCAAoB,uBAMnC,CAAA;IACD,yCAAyC;IACzC,SAAgB,6BAA6B,CAAC,WAA6B,EAAE,aAAmC,EAAE,WAA+B;QAC/I,MAAM,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,+BAAiB,CAAC,GAAG,CAAC;QACjE,IAAI,WAAW,CAAC,YAAY,IAAI,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1F,OAAO,iBAAiB,CAAC,oBAAoB,CAAC,WAAW,CAAC,YAAY,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;QACjG,CAAC;aAAM,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;YAC9B,OAAO,iBAAiB,CAAC,gBAAgB,CAAC,WAAW,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;QACvF,CAAC;QACD,MAAM,QAAQ,GAAG,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,iCAAmB,CAAC,WAAW,CAAC;QACjF,MAAM,EAAE,GAAG,GAAG,WAAW,CAAC,WAAW,IAAI,WAAW,CAAC,aAAa,IAAI,WAAW,CAAC,YAAY,KAAK,WAAW,CAAC,QAAQ,EAAE,CAAC;QAC1H,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAClC,CAAC;IAVe,+CAA6B,gCAU5C,CAAA;IACD,yCAAyC;IACzC,SAAgB,6BAA6B,CAAC,WAAiC;QAC7E,IAAI,WAAW,CAAC,QAAQ,KAAK,iCAAmB,CAAC,WAAW;YAC1D,OAAO,SAAS,CAAC;QACnB,MAAM,QAAQ,GAAG,WAAW,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3C,MAAM,aAAa,GAAG,WAAW,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnD,MAAM,QAAQ,GAAG,WAAW,CAAC,EAAE,CAAC,SAAS,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC;QAC7D,MAAM,WAAW,GAAqB;YACpC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;YACxB,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC1B,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC;YACzB,QAAQ;SACT,CAAC;QACF,OAAO,WAAW,CAAC;IACrB,CAAC;IAbe,+CAA6B,gCAa5C,CAAA;IACD,4DAA4D;IAC5D,SAAgB,uBAAuB,CAAC,UAAkB,EAAE,UAAkB;QAC5E,MAAM,EAAE,GAAG,IAAA,4BAAiB,EAAC,UAAU,EAAC,UAAU,CAAC,CAAC;QACpD,OAAO,EAAC,QAAQ,EAAE,iCAAmB,CAAC,cAAc,EAAE,MAAM,EAAE,+BAAiB,CAAC,UAAU,EAAE,EAAE,EAAC,CAAC;IAClG,CAAC;IAHe,yCAAuB,0BAGtC,CAAA;IACD;;;OAGG;IACI,KAAK,UAAU,OAAO,CAAC,GAAyB,EAAE,OAA+B;QACtF,MAAM,QAAQ,GAAG,qBAAS,CAAC,0BAA0B,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,qBAAM,CAAC,UAAU,CAAC,cAAc,EAAE,8BAA8B,GAAG,CAAC,QAAQ,qBAAqB,CAAC,CAAC;YACnG,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,QAAQ,CAAC,uBAAuB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IARqB,yBAAO,UAQ5B,CAAA;AACH,CAAC,EAvFgB,iBAAiB,iCAAjB,iBAAiB,QAuFjC;AA0BD;;;;GAIG;AACH,MAAa,iCAAiC;IAC3B,UAAU,GAAG,IAAI,GAAG,EAAqC,CAAC;IAE3E,gBAAgB;IAChB;QACE,IAAI,CAAC,QAAQ,CAAC,iCAAmB,CAAC,cAAc,EAAE;YAChD,uBAAuB,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,yEAAmC,CAAC,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC;SACjH,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,iCAAmB,CAAC,UAAU,EAAE;YAC5C,uBAAuB,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,iEAA+B,CAAC,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC;SAC7G,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,iCAAmB,CAAC,YAAY,EAAE;YAC9C,uBAAuB,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,qEAAiC,CAAC,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC;SAC/G,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,iCAAmB,CAAC,WAAW,EAAE;YAC7C,kCAAkC;YAClC,uBAAuB,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,iEAA+B,CAAC,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC;SAC7G,CAAC,CAAC;IACL,CAAC;IAED,+FAA+F;IACxF,QAAQ,CAAC,IAAY,EAAE,QAAmC;QAC/D,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED,+DAA+D;IACxD,IAAI,CAAC,IAAY;QACtB,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;CACF;AA7BD,8EA6BC;AAqBD;;;;;;;;;;GAUG;AACH,MAAa,qBAAqB;IAChC,+DAA+D;IACvD,OAAO,CAAU;IACzB,+IAA+I;IACvI,aAAa,CAAqC;IAC1D,uCAAuC;IAC/B,UAAU,CAAsB;IACxC,oGAAoG;IACpF,oBAAoB,GAAG,IAAI,CAAC;IAErC,KAAK,CAAC,uBAAuB,CAAC,GAAyB,EAAE,OAA+B;QAC7F,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACzC,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,4FAA4F,CAAC,CAAC;YAC9H,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,uEAAkC,CAAC,aAAa,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IAC1G,CAAC;IAED,YAAmB,OAAqC;QACtD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9B,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,IAAI,yCAAmB,CAAC,OAAO,CAAC,mBAAmB,IAAI,IAAI,CAAC,CAAC;IACjF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,UAAU;QACrB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,GAAG,GAAG,8BAA8B,CAAC;YAC3C,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;YACrC,MAAM,IAAI,2BAAY,CAAC,4BAAa,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEM,QAAQ,CAAC,QAAyB;QACvC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,KAAuB,EAAE,EAAkB;QACtE,MAAM,YAAY,GAAG,IAAA,mCAAa,EAAC,EAAE,CAAC,CAAC;QAEvC,yDAAyD;QACzD,IAAI,YAAY,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAC1B,oCAAoC;YACpC,iGAAiG;YACjG,MAAM,gBAAgB,GAAG,CAAC,GAAG,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAEjF,IAAI,YAAY,GAAG,2BAA2B,CAAC;YAC/C,YAAY,IAAI,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,OAAO,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC5E,YAAY,IAAI,OAAO,CAAC;YAExB,KAAK,CAAC,WAAW,CAAC,qBAAS,CAAC,YAAY,CAAC;gBACvC,OAAO,EAAE,GAAG,qBAAS,CAAC,UAAU,iCAAiC;gBACjE,OAAO,EAAE,gCAAgC;gBACzC,MAAM,EAAE,YAAY;aACrB,CAAC,CAAC,CAAC;QACN,CAAC;IACH,CAAC;CACF;AA9DD,sDA8DC;AAED;;GAEG;AACH,SAAgB,mBAAmB;IACjC,OAAO,kDAAkD,CAAC;AAC5D,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Tiles\n */\nimport { BentleyError, BentleyStatus, GuidString, Logger, LoggingMetaData, RealityDataStatus } from \"@itwin/core-bentley\";\nimport { Cartographic, EcefLocation, OrbitGtBlobProps, RealityData, RealityDataFormat, RealityDataProvider, RealityDataSourceKey } from \"@itwin/core-common\";\nimport { Range3d } from \"@itwin/core-geometry\";\nimport { FrontendLoggerCategory } from \"./common/FrontendLoggerCategory\";\nimport { CesiumIonAssetProvider, ContextShareProvider, getCesiumAssetUrl } from \"./tile/internal\";\nimport { RealityDataSourceTilesetUrlImpl } from \"./RealityDataSourceTilesetUrlImpl\";\nimport { RealityDataSourceContextShareImpl } from \"./RealityDataSourceContextShareImpl\";\nimport { RealityDataSourceCesiumIonAssetImpl } from \"./RealityDataSourceCesiumIonAssetImpl\";\nimport { RealityDataSourceGoogle3dTilesImpl } from \"./internal/RealityDataSourceGoogle3dTilesImpl\";\nimport { IModelApp } from \"./IModelApp\";\nimport { getCopyrights, GoogleMapsDecorator } from \"./internal/GoogleMapsDecorator\";\nimport { DecorateContext } from \"./ViewContext\";\nimport { ScreenViewport } from \"./Viewport\";\n\nconst loggerCategory: string = FrontendLoggerCategory.RealityData;\n\n/**\n * Reality Data Operation error\n * @alpha\n */\nexport class RealityDataError extends BentleyError {\n  public constructor(errorNumber: RealityDataStatus, message: string, getMetaData?: LoggingMetaData) {\n    super(errorNumber, message, getMetaData);\n  }\n}\n\n/** This interface provide spatial location and volume of interest, in meters, centered around `spatial location`\n * @alpha\n */\nexport interface SpatialLocationAndExtents {\n  /** location of the point at the center of the reaity data */\n  location: Cartographic | EcefLocation;\n  /** extents of the volume around location */\n  worldRange: Range3d;\n  /** true if this reality data is geolocated\n   * A reality data is geolocated when we can compute a valid position relative to the earth surface.\n   * Note that some reality data contains custom coordinate system without any information on the relative position on earth.\n   * These reality data will have a location and worldRange but will be identified by the isGeoLocated set to false.\n   */\n  isGeolocated: boolean;\n}\n\n/** This interface provides information to identify the product and engine that create this reality data\n * @alpha\n */\nexport interface PublisherProductInfo {\n  /** product that create this reality data */\n  product: string;\n  /** engine that create this reality data */\n  engine: string;\n  /** the version of the engine that create this reality data */\n  version: string;\n}\n\n/** This interface provide methods used to access a reality data from a reality data provider\n * @beta\n */\nexport interface RealityDataSource {\n  readonly key: RealityDataSourceKey;\n  readonly isContextShare: boolean;\n  readonly realityDataId: string | undefined;\n  /** Metatdata on the reality data source */\n  readonly realityData: RealityData | undefined;\n  /** The reality data type (e.g.: \"RealityMesh3DTiles\", OPC, Terrain3DTiles, Cesium3DTiles, ... )*/\n  readonly realityDataType: string | undefined;\n  /** This method returns the URL to obtain the Reality Data properties.\n   * @param iTwinId id of associated iTwin project\n   * @returns string containing the URL to reality data.\n   */\n  getServiceUrl(iTwinId: GuidString | undefined): Promise<string | undefined>;\n  /** If true, the geometricError property of the tiles will be used to compute screen-space error.\n   * @alpha\n   */\n  readonly usesGeometricError?: boolean;\n  /** If [[usesGeometricError]] is `true`, optionally specifies the maximum error, in pixels, to permit for a tile before requiring refinement of that tile.\n   * Default: 16\n   * @alpha\n   */\n  readonly maximumScreenSpaceError?: number;\n  /** Given the URL of a tile's content, return the type of that content.\n   * \"tileset\" indicates the content points to a JSON tileset describing the structure of the tile tree below the tile.\n   * \"tile\" indicates the content points to a binary representation of the tile's graphics.\n   * @alpha\n   */\n  getTileContentType(url: string): \"tile\" | \"tileset\";\n\n  /** Gets a reality data root document json\n   * @returns tile data json\n   * @internal\n   */\n  getRootDocument(iTwinId: GuidString | undefined): Promise<any>;\n  /** Gets tile content\n   * @param name name or path of tile\n   * @returns array buffer of tile content\n   * @internal\n   */\n  getTileContent(name: string): Promise<any>;\n  /** Gets a tileset's app data json\n   * @param name name or path of tile\n   * @returns app data json object\n   * @internal\n   */\n  getTileJson(name: string): Promise<any>;\n  /** Gets spatial location and extents of this reality data source.\n   * Will return undefined if cannot be resolved or is unbounded (cover entire earth eg: Open Street Map Building from Ion Asset)\n   * @returns spatial location and extents\n   * @throws [[RealityDataError]] if source is invalid or cannot be read\n   * @alpha\n   */\n  getSpatialLocationAndExtents(): Promise<SpatialLocationAndExtents | undefined>;\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  getPublisherProductInfo(): Promise<PublisherProductInfo | undefined>;\n  /** Optional, gets the tileset url associated with the reality data source\n   * @returns tileset url\n   * @internal\n   */\n  getTilesetUrl?(): string | undefined;\n}\n/** Utility functions for RealityDataSource\n * @beta\n */\nexport namespace RealityDataSource {\n  /** Create a RealityDataSourceKey from a tilesetUrl.\n   * @param tilesetUrl the reality data attachment url\n   * @param inputProvider identify the RealityDataProvider if known, otherwise function will try to extract it from the tilesetUrl\n   * @param inputFormat identify the RealityDataFormat if known, otherwise function will try to extract it from the tilesetUrl\n   * @returns the RealityDataSourceKey that uniquely identify a reality data for a provider\n   */\n  export function createKeyFromUrl(tilesetUrl: string, inputProvider?: RealityDataProvider, inputFormat?: RealityDataFormat): RealityDataSourceKey {\n    let format = inputFormat ? inputFormat : RealityDataFormat.fromUrl(tilesetUrl);\n    if (CesiumIonAssetProvider.isProviderUrl(tilesetUrl)) {\n      const provider = RealityDataProvider.CesiumIonAsset;\n      let cesiumIonAssetKey: RealityDataSourceKey = { provider, format, id:  CesiumIonAssetProvider.osmBuildingId }; // default OSM building\n      // Parse URL to extract possible asset id and key if provided\n      const cesiumAsset = CesiumIonAssetProvider.parseCesiumUrl(tilesetUrl);\n      if (cesiumAsset) {\n        cesiumIonAssetKey = RealityDataSource.createCesiumIonAssetKey(cesiumAsset.id, cesiumAsset.key);\n      }\n      return cesiumIonAssetKey;\n    }\n\n    // Try to extract realityDataId from URL and if not possible, use the url as the key\n    if (ContextShareProvider.isProviderUrl(tilesetUrl)) {\n      const info = ContextShareProvider.getInfoFromUrl(tilesetUrl);\n      const provider = inputProvider ? inputProvider : info.provider;\n      format = inputFormat ? inputFormat : info.format;\n      const contextShareKey: RealityDataSourceKey = { provider, format, id: info.id, iTwinId: info.iTwinId };\n      return contextShareKey;\n    }\n\n    // default to tileSetUrl\n    const provider2 = inputProvider ? inputProvider : RealityDataProvider.TilesetUrl;\n    const urlKey: RealityDataSourceKey = { provider: provider2, format, id: tilesetUrl };\n    return urlKey;\n  }\n  /** @alpha - was used for a very specific case of point cloud (opc) attachment that should not be made public */\n  export function createKeyFromBlobUrl(blobUrl: string, inputProvider?: RealityDataProvider, inputFormat?: RealityDataFormat): RealityDataSourceKey {\n    const info = ContextShareProvider.getInfoFromBlobUrl(blobUrl);\n    const format = inputFormat ? inputFormat : info.format;\n    const provider = inputProvider ? inputProvider : info.provider;\n    const contextShareKey: RealityDataSourceKey = { provider, format, id: info.id };\n    return contextShareKey;\n  }\n  /** @alpha - OrbitGtBlobProps is alpha */\n  export function createKeyFromOrbitGtBlobProps(orbitGtBlob: OrbitGtBlobProps, inputProvider?: RealityDataProvider, inputFormat?: RealityDataFormat): RealityDataSourceKey {\n    const format = inputFormat ? inputFormat : RealityDataFormat.OPC;\n    if (orbitGtBlob.blobFileName && orbitGtBlob.blobFileName.toLowerCase().startsWith(\"http\")) {\n      return RealityDataSource.createKeyFromBlobUrl(orbitGtBlob.blobFileName, inputProvider, format);\n    } else if (orbitGtBlob.rdsUrl) {\n      return RealityDataSource.createKeyFromUrl(orbitGtBlob.rdsUrl, inputProvider, format);\n    }\n    const provider = inputProvider ? inputProvider : RealityDataProvider.OrbitGtBlob;\n    const id = `${orbitGtBlob.accountName}:${orbitGtBlob.containerName}:${orbitGtBlob.blobFileName}:?${orbitGtBlob.sasToken}`;\n    return { provider, format, id };\n  }\n  /** @alpha - OrbitGtBlobProps is alpha */\n  export function createOrbitGtBlobPropsFromKey(rdSourceKey: RealityDataSourceKey): OrbitGtBlobProps | undefined {\n    if (rdSourceKey.provider !== RealityDataProvider.OrbitGtBlob)\n      return undefined;\n    const splitIds = rdSourceKey.id.split(\":\");\n    const sasTokenIndex = rdSourceKey.id.indexOf(\":?\");\n    const sasToken = rdSourceKey.id.substring(sasTokenIndex + 2);\n    const orbitGtBlob: OrbitGtBlobProps = {\n      accountName: splitIds[0],\n      containerName: splitIds[1],\n      blobFileName: splitIds[2],\n      sasToken,\n    };\n    return orbitGtBlob;\n  }\n  /** @internal - Is used by \"fdt attach cesium asset\" keyin*/\n  export function createCesiumIonAssetKey(osmAssetId: number, requestKey: string): RealityDataSourceKey {\n    const id = getCesiumAssetUrl(osmAssetId,requestKey);\n    return {provider: RealityDataProvider.CesiumIonAsset, format: RealityDataFormat.ThreeDTile, id};\n  }\n  /** Return an instance of a RealityDataSource from a source key.\n   * There will aways be only one reality data RealityDataSource for a corresponding reality data source key.\n   * @alpha\n   */\n  export async function fromKey(key: RealityDataSourceKey, iTwinId: GuidString | undefined): Promise<RealityDataSource | undefined> {\n    const provider = IModelApp.realityDataSourceProviders.find(key.provider);\n    if (!provider) {\n      Logger.logWarning(loggerCategory, `RealityDataSourceProvider \"${key.provider}\" is not registered`);\n      return undefined;\n    }\n\n    return provider.createRealityDataSource(key, iTwinId);\n  }\n}\n\n/** A named supplier of [RealityDataSource]]s.\n * The provider's name is stored in a [RealityDataSourceKey]($common). When the [[RealityDataSource]] is requested from the key,\n * the provider is looked up in [[IModelApp.realityDataSourceProviders]] by its name and, if found, its [[createRealityDataSource]] method\n * is invoked to produce the reality data source.\n * @beta\n */\n\nexport interface RealityDataSourceProvider {\n  /** Produce a RealityDataSource for the specified `key`.\n   * @param key Identifies the reality data source.\n   * @param iTwinId A default iTwinId to use.\n   * @returns the requested reality data source, or `undefined` if it could not be produced.\n   */\n  createRealityDataSource(key: RealityDataSourceKey, iTwinId: GuidString | undefined): Promise<RealityDataSource | undefined>;\n  /** Optionally add any decorations specific to this reality data source provider.\n   * For example, the Google Photorealistic 3D Tiles reality data source provider will add the Google logo.\n   */\n  decorate?(_context: DecorateContext): void;\n  /** Optionally add attribution logo cards to the viewport's logo div. */\n  addAttributions?(cards: HTMLTableElement, vp: ScreenViewport): Promise<void>;\n  /** Enables cached decorations for this provider. @see [[ViewportDecorator.useCachedDecorations]] */\n  useCachedDecorations?: true | undefined;\n}\n\n/** A registry of [[RealityDataSourceProvider]]s identified by their unique names. The registry can be accessed via [[IModelApp.realityDataSourceProviders]].\n * It includes a handful of built-in providers for sources like Cesium ION, ContextShare, OrbitGT, and arbitrary public-accessible URLs.\n * Any number of additional providers can be registered. They should typically be registered just after [[IModelApp.startup]].\n * @beta\n */\nexport class RealityDataSourceProviderRegistry {\n  private readonly _providers = new Map<string, RealityDataSourceProvider>();\n\n  /** @internal */\n  public constructor() {\n    this.register(RealityDataProvider.CesiumIonAsset, {\n      createRealityDataSource: async (key, iTwinId) => RealityDataSourceCesiumIonAssetImpl.createFromKey(key, iTwinId),\n    });\n    this.register(RealityDataProvider.TilesetUrl, {\n      createRealityDataSource: async (key, iTwinId) => RealityDataSourceTilesetUrlImpl.createFromKey(key, iTwinId),\n    });\n    this.register(RealityDataProvider.ContextShare, {\n      createRealityDataSource: async (key, iTwinId) => RealityDataSourceContextShareImpl.createFromKey(key, iTwinId),\n    });\n    this.register(RealityDataProvider.OrbitGtBlob, {\n      // ###TODO separate TilesetUrlImpl\n      createRealityDataSource: async (key, iTwinId) => RealityDataSourceTilesetUrlImpl.createFromKey(key, iTwinId),\n    });\n  }\n\n  /** Register `provider` to produce [[RealityDataSource]]s for the specified provider `name`. */\n  public register(name: string, provider: RealityDataSourceProvider): void {\n    this._providers.set(name, provider);\n  }\n\n  /** Look up the provider registered by the specified `name`. */\n  public find(name: string): RealityDataSourceProvider | undefined {\n    return this._providers.get(name);\n  }\n}\n\n/**\n * Options for creating a Google Photorealistic 3D Tiles reality data source provider.\n * The caller must provide either an API key or a function that returns an auth token.\n * @beta\n */\nexport type Google3dTilesProviderOptions = {\n  /** Google Map Tiles API Key used to access Google 3D Tiles. */\n  apiKey: string;\n  getAuthToken?: never;\n  /** If true, the data attributions/copyrights from the Google 3D Tiles will be displayed on screen. The Google Maps logo will always be displayed. Defaults to `true`. */\n  showCreditsOnScreen?: boolean\n} | {\n  apiKey?: never;\n  /** Function that returns an OAuth token for authenticating with Google 3D Tiles. This token is expected to not contain the \"Bearer\" prefix. */\n  getAuthToken: () => Promise<string>;\n  /** If true, the data attributions/copyrights from the Google 3D Tiles will be displayed on screen. The Google Maps logo will always be displayed. Defaults to `true`. */\n  showCreditsOnScreen?: boolean;\n};\n\n/**\n * Will provide Google Photorealistic 3D Tiles (in 3dTile format).\n * A valid API key or getAuthToken fuction must be supplied when creating this provider.\n * To use this provider, you must register it with [[IModelApp.realityDataSourceProviders]].\n * Example usage:\n * ```ts\n * [[include:GooglePhotorealistic3dTiles_providerApiKey]]\n * ```\n * @see [Google Photorealistic 3D Tiles]($docs/learning/frontend/GooglePhotorealistic3dTiles.md)\n * @beta\n */\nexport class Google3dTilesProvider implements RealityDataSourceProvider {\n  /** Google Map Tiles API Key used to access Google 3D Tiles. */\n  private _apiKey?: string;\n  /** Function that returns an OAuth token for authenticating with Google 3D Tiles. This token is expected to not contain the \"Bearer\" prefix. */\n  private _getAuthToken?: () => Promise<string | undefined>;\n  /** Decorator for Google Maps logos. */\n  private _decorator: GoogleMapsDecorator;\n  /** Enables cached decorations for this provider. @see [[ViewportDecorator.useCachedDecorations]] */\n  public readonly useCachedDecorations = true;\n\n  public async createRealityDataSource(key: RealityDataSourceKey, iTwinId: GuidString | undefined): Promise<RealityDataSource | undefined> {\n    if (!this._apiKey && !this._getAuthToken) {\n      Logger.logError(loggerCategory, \"Either an API key or getAuthToken function are required to create a Google3dTilesProvider.\");\n      return undefined;\n    }\n    return RealityDataSourceGoogle3dTilesImpl.createFromKey(key, iTwinId, this._apiKey, this._getAuthToken);\n  }\n\n  public constructor(options: Google3dTilesProviderOptions) {\n    this._apiKey = options.apiKey;\n    this._getAuthToken = options.getAuthToken;\n    this._decorator = new GoogleMapsDecorator(options.showCreditsOnScreen ?? true);\n  }\n\n  /**\n   * Initialize the Google 3D Tiles reality data source provider by activating its decorator, which consists of loading the correct Google Maps logo.\n   * @returns `true` if the decorator was successfully activated, otherwise `false`.\n   */\n  public async initialize(): Promise<boolean> {\n    const isActivated = await this._decorator.activate(\"satellite\");\n    if (!isActivated) {\n      const msg = \"Failed to activate decorator\";\n      Logger.logError(loggerCategory, msg);\n      throw new BentleyError(BentleyStatus.ERROR, msg);\n    }\n    return isActivated;\n  }\n\n  public decorate(_context: DecorateContext): void {\n    this._decorator.decorate(_context);\n  }\n\n  public async addAttributions(cards: HTMLTableElement, vp: ScreenViewport): Promise<void> {\n    const copyrightMap = getCopyrights(vp);\n\n    // Only add another logo card if the tiles have copyright\n    if (copyrightMap.size > 0) {\n      // Order by most occurances to least\n      // See https://developers.google.com/maps/documentation/tile/create-renderer#display-attributions\n      const sortedCopyrights = [...copyrightMap.entries()].sort((a, b) => b[1] - a[1]);\n\n      let copyrightMsg = \"Data provided by:<br><ul>\";\n      copyrightMsg += sortedCopyrights.map(([key]) => `<li>${key}</li>`).join(\"\");\n      copyrightMsg += \"</ul>\";\n\n      cards.appendChild(IModelApp.makeLogoCard({\n        iconSrc: `${IModelApp.publicPath}images/google_on_white_hdpi.png`,\n        heading: \"Google Photorealistic 3D Tiles\",\n        notice: copyrightMsg\n      }));\n    }\n  }\n}\n\n/** Returns the URL used for retrieving Google Photorealistic 3D Tiles.\n * @beta\n */\nexport function getGoogle3dTilesUrl() {\n  return \"https://tile.googleapis.com/v1/3dtiles/root.json\";\n}\n"]}

package/lib/cjs/RealityDataSourceTilesetUrlImpl.js

@@ -70,7 +70,7 @@ class RealityDataSourceTilesetUrlImpl {
     // otherwise the full path to root document is given.
     // The base URL contains the base URL from which tile relative path are constructed.
     // The tile's path root will need to be reinserted for child tiles to return a 200
-    // If the original url includes search paramaters, they are stored in _searchParams to be reinserted into child tile requests.
+    // If the original root tileset url includes search paramaters, they are stored in _searchParams to be reinserted into child tile requests.
     setBaseUrl(url) {
         const urlParts = url.split("/");
         const newUrl = new URL(url);

package/lib/cjs/RealityDataSourceTilesetUrlImpl.js.map

@@ -1 +1 @@
-{"version":3,"file":"RealityDataSourceTilesetUrlImpl.js","sourceRoot":"","sources":["../../src/RealityDataSourceTilesetUrlImpl.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,sDAAwE;AACxE,oDAAoJ;AAEpJ,+CAA4C;AAE5C,8CAA8D;AAE9D;;;;;;EAME;AACF,MAAa,+BAA+B;IAC1B,GAAG,CAAuB;IAC1C,2EAA2E;IACnE,WAAW,CAAqB;IACxC,sIAAsI;IAC9H,QAAQ,GAAW,EAAE,CAAC;IAC9B,wIAAwI;IAChI,aAAa,GAAW,EAAE,CAAC;IAEnC;;OAEG;IACH,YAAsB,KAA6B;QACjD,IAAA,qBAAM,EAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,KAAK,iCAAmB,CAAC,UAAU,IAAI,KAAK,CAAC,SAAS,CAAC,QAAQ,KAAK,iCAAmB,CAAC,WAAW,CAAC,CAAC;QACpI,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC;QAC3B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,SAA+B,EAAE,QAAgC;QACjG,IAAI,SAAS,CAAC,QAAQ,KAAK,iCAAmB,CAAC,UAAU;YACvD,OAAO,SAAS,CAAC;QACnB,MAAM,QAAQ,GAAG,IAAI,+BAA+B,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,IAAW,cAAc;QACvB,OAAO,KAAK,CAAC;IACf,CAAC;IACD;;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;IAEM,aAAa;QAClB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IACD,oEAAoE;IACpE,sHAAsH;IACtH,qDAAqD;IACrD,oFAAoF;IACpF,kFAAkF;IAClF,8HAA8H;IACtH,UAAU,CAAC,GAAW;QAC5B,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC;QACnC,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,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,OAA+B;QAC1D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,GAAG;YACN,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,2BAA2B,CAAC,CAAC;QAE1E,+EAA+E;QAC/E,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACrB,OAAO,IAAA,iBAAO,EAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC9B,CAAC;IAEO,UAAU,CAAC,GAAW;QAC5B,IAAI,CAAC;YACH,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QACf,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACK,UAAU,CAAC,QAAgB;QACjC,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC9B,OAAO,GAAG,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC3E,CAAC;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,GAAG,QAAQ,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,GAAG,QAAQ,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;IACrH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc,CAAC,IAAY;QACtC,OAAO,IAAA,iBAAO,EAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,WAAW,CAAC,IAAY;QACnC,OAAO,IAAA,iBAAO,EAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAEM,kBAAkB,CAAC,GAAW;QACnC,OAAO,IAAI,GAAG,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;IACzG,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,4BAA4B;QACvC,IAAI,eAAsD,CAAC;QAC3D,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,KAAK,+BAAiB,CAAC,UAAU,EAAE,CAAC;YACrD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YAC3D,eAAe,GAAG,sCAA2B,CAAC,4BAA4B,CAAC,YAAY,CAAC,CAAC;QAC3F,CAAC;QACD,OAAO,eAAe,CAAC;IACzB,CAAC;IACD;;;;;OAKG;IACI,KAAK,CAAC,uBAAuB;QAClC,IAAI,aAA+C,CAAC;QACpD,OAAO,aAAa,CAAC;IACvB,CAAC;CACF;AAnJD,0EAmJC","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 { assert, BentleyStatus, GuidString } from \"@itwin/core-bentley\";\nimport { IModelError, RealityData, RealityDataFormat, RealityDataProvider, RealityDataSourceKey, RealityDataSourceProps } from \"@itwin/core-common\";\n\nimport { request } from \"./request/Request\";\nimport { PublisherProductInfo, RealityDataSource, SpatialLocationAndExtents } from \"./RealityDataSource\";\nimport { ThreeDTileFormatInterpreter } from \"./tile/internal\";\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 RealityDataSourceTilesetUrlImpl 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  /** Need to be passed down to child tile requests when requesting from blob storage, e.g. a Cesium export from the Mesh Export Service*/\n  private _searchParams: 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.TilesetUrl || props.sourceKey.provider === RealityDataProvider.OrbitGtBlob);\n    this.key = props.sourceKey;\n    this._tilesetUrl = this.key.id;\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.TilesetUrl)\n      return undefined;\n    const rdSource = new RealityDataSourceTilesetUrlImpl({ sourceKey });\n    return rdSource;\n  }\n\n  public get isContextShare(): boolean {\n    return false;\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  public getTilesetUrl(): string | undefined {\n    return this._tilesetUrl;\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  // If the original url includes search paramaters, they are stored in _searchParams to be reinserted into child tile requests.\n  private setBaseUrl(url: string): void {\n    const urlParts = url.split(\"/\");\n    const newUrl = new URL(url);\n    this._searchParams = newUrl.search;\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    return this._tilesetUrl;\n  }\n\n  public async getRootDocument(iTwinId: GuidString | undefined): Promise<any> {\n    const 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    this.setBaseUrl(url);\n    return request(url, \"json\");\n  }\n\n  private isValidURL(url: string){\n    try {\n      new URL(url);\n    } catch {\n      return false;\n    }\n    return true;\n  }\n\n  /** Returns the tile URL.\n   * If the tile path is a relative URL, the base URL is prepended to it.\n   * For both absolute and relative tile path URLs, the search parameters are checked. If the search params are empty, the base URL's search params are appended to the tile path.\n   */\n  private getTileUrl(tilePath: string){\n    if (this.isValidURL(tilePath)) {\n      const url = new URL(tilePath);\n      return url.search === \"\" ? `${tilePath}${this._searchParams}` : tilePath;\n    }\n    return tilePath.includes(\"?\") ? `${this._baseUrl}${tilePath}` : `${this._baseUrl}${tilePath}${this._searchParams}`;\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    return request(this.getTileUrl(name), \"arraybuffer\");\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    return request(this.getTileUrl(name), \"json\");\n  }\n\n  public getTileContentType(url: string): \"tile\" | \"tileset\" {\n    return new URL(url, \"https://localhost/\").pathname.toLowerCase().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    let spatialLocation: SpatialLocationAndExtents | undefined;\n    if (this.key.format === RealityDataFormat.ThreeDTile) {\n      const rootDocument = await this.getRootDocument(undefined);\n      spatialLocation = ThreeDTileFormatInterpreter.getSpatialLocationAndExtents(rootDocument);\n    }\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":"RealityDataSourceTilesetUrlImpl.js","sourceRoot":"","sources":["../../src/RealityDataSourceTilesetUrlImpl.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,sDAAwE;AACxE,oDAAoJ;AAEpJ,+CAA4C;AAE5C,8CAA8D;AAE9D;;;;;;EAME;AACF,MAAa,+BAA+B;IAC1B,GAAG,CAAuB;IAC1C,2EAA2E;IACnE,WAAW,CAAqB;IACxC,sIAAsI;IAC9H,QAAQ,GAAW,EAAE,CAAC;IAC9B,wIAAwI;IAChI,aAAa,GAAW,EAAE,CAAC;IAEnC;;OAEG;IACH,YAAsB,KAA6B;QACjD,IAAA,qBAAM,EAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,KAAK,iCAAmB,CAAC,UAAU,IAAI,KAAK,CAAC,SAAS,CAAC,QAAQ,KAAK,iCAAmB,CAAC,WAAW,CAAC,CAAC;QACpI,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC;QAC3B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,SAA+B,EAAE,QAAgC;QACjG,IAAI,SAAS,CAAC,QAAQ,KAAK,iCAAmB,CAAC,UAAU;YACvD,OAAO,SAAS,CAAC;QACnB,MAAM,QAAQ,GAAG,IAAI,+BAA+B,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,IAAW,cAAc;QACvB,OAAO,KAAK,CAAC;IACf,CAAC;IACD;;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;IAEM,aAAa;QAClB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IACD,oEAAoE;IACpE,sHAAsH;IACtH,qDAAqD;IACrD,oFAAoF;IACpF,kFAAkF;IAClF,2IAA2I;IACnI,UAAU,CAAC,GAAW;QAC5B,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC;QACnC,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,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,OAA+B;QAC1D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,GAAG;YACN,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,2BAA2B,CAAC,CAAC;QAE1E,+EAA+E;QAC/E,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACrB,OAAO,IAAA,iBAAO,EAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC9B,CAAC;IAEO,UAAU,CAAC,GAAW;QAC5B,IAAI,CAAC;YACH,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QACf,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACK,UAAU,CAAC,QAAgB;QACjC,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC9B,OAAO,GAAG,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC3E,CAAC;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,GAAG,QAAQ,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,GAAG,QAAQ,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;IACrH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc,CAAC,IAAY;QACtC,OAAO,IAAA,iBAAO,EAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,WAAW,CAAC,IAAY;QACnC,OAAO,IAAA,iBAAO,EAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAEM,kBAAkB,CAAC,GAAW;QACnC,OAAO,IAAI,GAAG,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;IACzG,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,4BAA4B;QACvC,IAAI,eAAsD,CAAC;QAC3D,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,KAAK,+BAAiB,CAAC,UAAU,EAAE,CAAC;YACrD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YAC3D,eAAe,GAAG,sCAA2B,CAAC,4BAA4B,CAAC,YAAY,CAAC,CAAC;QAC3F,CAAC;QACD,OAAO,eAAe,CAAC;IACzB,CAAC;IACD;;;;;OAKG;IACI,KAAK,CAAC,uBAAuB;QAClC,IAAI,aAA+C,CAAC;QACpD,OAAO,aAAa,CAAC;IACvB,CAAC;CACF;AAnJD,0EAmJC","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 { assert, BentleyStatus, GuidString } from \"@itwin/core-bentley\";\nimport { IModelError, RealityData, RealityDataFormat, RealityDataProvider, RealityDataSourceKey, RealityDataSourceProps } from \"@itwin/core-common\";\n\nimport { request } from \"./request/Request\";\nimport { PublisherProductInfo, RealityDataSource, SpatialLocationAndExtents } from \"./RealityDataSource\";\nimport { ThreeDTileFormatInterpreter } from \"./tile/internal\";\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 RealityDataSourceTilesetUrlImpl 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  /** Need to be passed down to child tile requests when requesting from blob storage, e.g. a Cesium export from the Mesh Export Service*/\n  private _searchParams: 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.TilesetUrl || props.sourceKey.provider === RealityDataProvider.OrbitGtBlob);\n    this.key = props.sourceKey;\n    this._tilesetUrl = this.key.id;\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.TilesetUrl)\n      return undefined;\n    const rdSource = new RealityDataSourceTilesetUrlImpl({ sourceKey });\n    return rdSource;\n  }\n\n  public get isContextShare(): boolean {\n    return false;\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  public getTilesetUrl(): string | undefined {\n    return this._tilesetUrl;\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  // If the original root tileset url includes search paramaters, they are stored in _searchParams to be reinserted into child tile requests.\n  private setBaseUrl(url: string): void {\n    const urlParts = url.split(\"/\");\n    const newUrl = new URL(url);\n    this._searchParams = newUrl.search;\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    return this._tilesetUrl;\n  }\n\n  public async getRootDocument(iTwinId: GuidString | undefined): Promise<any> {\n    const 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    this.setBaseUrl(url);\n    return request(url, \"json\");\n  }\n\n  private isValidURL(url: string){\n    try {\n      new URL(url);\n    } catch {\n      return false;\n    }\n    return true;\n  }\n\n  /** Returns the tile URL.\n   * If the tile path is a relative URL, the base URL is prepended to it.\n   * For both absolute and relative tile path URLs, the search parameters are checked. If the search params are empty, the base URL's search params are appended to the tile path.\n   */\n  private getTileUrl(tilePath: string){\n    if (this.isValidURL(tilePath)) {\n      const url = new URL(tilePath);\n      return url.search === \"\" ? `${tilePath}${this._searchParams}` : tilePath;\n    }\n    return tilePath.includes(\"?\") ? `${this._baseUrl}${tilePath}` : `${this._baseUrl}${tilePath}${this._searchParams}`;\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    return request(this.getTileUrl(name), \"arraybuffer\");\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    return request(this.getTileUrl(name), \"json\");\n  }\n\n  public getTileContentType(url: string): \"tile\" | \"tileset\" {\n    return new URL(url, \"https://localhost/\").pathname.toLowerCase().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    let spatialLocation: SpatialLocationAndExtents | undefined;\n    if (this.key.format === RealityDataFormat.ThreeDTile) {\n      const rootDocument = await this.getRootDocument(undefined);\n      spatialLocation = ThreeDTileFormatInterpreter.getSpatialLocationAndExtents(rootDocument);\n    }\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. Use the [[additions]] attribute instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. 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. Use the [[removals]] attribute instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. 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. Use the [[additions]] attribute instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. 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. Use the [[removals]] attribute instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. 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. Use [[add]], [[remove]], [[replace]] instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. 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. Use `SelectionSet.elements.has(elemId)` instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. 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. Use `SelectionSet.elements.has(elemId)` instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `SelectionSet.elements.has(elemId)` instead.
      */
     isSelected(elemId?: Id64String): boolean;
     /** Clear current selection set.

package/lib/cjs/SelectionSet.js

@@ -204,7 +204,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. Use [[add]], [[remove]], [[replace]] instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [[add]], [[remove]], [[replace]] instead.
      */
     setHilite(arg, onOff) {
         if (onOff) {
@@ -273,14 +273,14 @@ class SelectionSet {
     }
     /** Return true if elemId is in this `SelectionSet`.
      * @see [[isSelected]]
-     * @deprecated in 5.0. Use `SelectionSet.elements.has(elemId)` instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. 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. Use `SelectionSet.elements.has(elemId)` instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `SelectionSet.elements.has(elemId)` instead.
      */
     isSelected(elemId) {
         return !!elemId && this.elements.has(elemId);