@itwin/core-frontend 5.12.0-dev.13 → 5.12.0-dev.15

package/lib/esm/tile/TileRequestChannel.js.map

@@ -1 +1 @@
-{"version":3,"file":"TileRequestChannel.js","sourceRoot":"","sources":["../../../src/tile/TileRequestChannel.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAI5D,MAAM,gBAAiB,SAAQ,aAA0B;IACvD;QACE,KAAK,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACjB,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;YACrE,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAmBD;;;;;;GAMG;AACH,MAAM,OAAO,4BAA4B;IACvC,uEAAuE;IAChE,kBAAkB,GAAG,CAAC,CAAC;IAC9B,8EAA8E;IACvE,iBAAiB,GAAG,CAAC,CAAC;IAC7B,qEAAqE;IAC9D,WAAW,GAAG,CAAC,CAAC;IACvB,kEAAkE;IAC3D,sBAAsB,GAAG,CAAC,CAAC;IAClC,+DAA+D;IACxD,mBAAmB,GAAG,CAAC,CAAC;IAC/B,kEAAkE;IAC3D,qBAAqB,GAAG,CAAC,CAAC;IACjC;;OAEG;IACI,eAAe,GAAG,CAAC,CAAC;IAC3B;;OAEG;IACI,uBAAuB,GAAG,CAAC,CAAC;IACnC,+JAA+J;IACxJ,gBAAgB,GAAG,CAAC,CAAC;IAC5B,4EAA4E;IACrE,uBAAuB,GAAG,CAAC,CAAC;IACnC,+HAA+H;IACxH,oBAAoB,GAAG,CAAC,CAAC;IAChC;;OAEG;IACI,QAAQ,GAAkC;QAC/C,KAAK,EAAE,CAAC;QACR,IAAI,EAAE,CAAC;QACP,GAAG,EAAE,MAAM,CAAC,gBAAgB;QAC5B,GAAG,EAAE,MAAM,CAAC,gBAAgB;KAC7B,CAAC;IAEF,gBAAgB;IACT,KAAK,CAAC,KAAmC;QAC9C,KAAK,MAAM,QAAQ,IAAI,IAAI,EAAE,CAAC,CAAC,mCAAmC;YAChE,MAAM,GAAG,GAAG,QAA8C,CAAC;YAC3D,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;YACtB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,MAAM,CAAC,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,CAAC;gBACtC,KAAK,CAAC,GAAG,CAAY,IAAI,GAAG,CAAC,CAAC,uEAAuE;YACxG,CAAC;QACH,CAAC;QAED,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC5C,KAAK,CAAC,QAAQ,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACrE,KAAK,CAAC,QAAQ,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAErE,IAAI,KAAK,CAAC,sBAAsB,GAAG,CAAC;YAClC,KAAK,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,sBAAsB,CAAC;IAChF,CAAC;IAED,gBAAgB;IACT,gBAAgB,CAAC,IAAU,EAAE,mBAA2B;QAC7D,EAAE,IAAI,CAAC,sBAAsB,CAAC;QAC9B,IAAI,IAAI,CAAC,OAAO;YACd,EAAE,IAAI,CAAC,eAAe,CAAC;aACpB,IAAI,CAAC,IAAI,CAAC,aAAa;YAC1B,EAAE,IAAI,CAAC,uBAAuB,CAAC;QAEjC,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,mBAAmB,CAAC;QAC3C,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,sBAAsB,CAAC;QACvE,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;QACrE,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;IACvE,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,kBAAkB;IAC7B,0FAA0F;IAC1E,IAAI,CAAS;IACrB,YAAY,CAAS;IAC7B,8CAA8C;IAC3B,OAAO,GAAG,IAAI,GAAG,EAAe,CAAC;IAC5C,QAAQ,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAClC,kBAAkB,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAC1C,WAAW,GAAG,IAAI,4BAA4B,EAAE,CAAC;IAC3D;;OAEG;IACI,eAAe,CAA8C;IAEpE;;;;OAIG;IACH,YAAmB,IAAY,EAAE,WAAmB;QAClD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IACD,IAAW,WAAW,CAAC,GAAW;QAChC,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;IAC1B,CAAC;IAED,oFAAoF;IACpF,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED,yEAAyE;IACzE,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED,oFAAoF;IACpF,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED,mDAAmD;IACnD,IAAW,UAAU;QACnB,IAAI,CAAC,WAAW,CAAC,kBAAkB,GAAG,IAAI,CAAC,UAAU,CAAC;QACtD,IAAI,CAAC,WAAW,CAAC,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC;QACpD,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,0DAA0D;IACnD,eAAe;QACpB,IAAI,CAAC,WAAW,GAAG,IAAI,4BAA4B,EAAE,CAAC;IACxD,CAAC;IAED;;OAEG;IACI,aAAa;QAClB,EAAE,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC;IAC3C,CAAC;IAED;;OAEG;IACI,aAAa;QAClB,EAAE,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,IAAU,EAAE,OAAoB,EAAE,mBAA2B;QACnF,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;QAE7D,IAAI,IAAI,CAAC,eAAe;YACtB,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,MAAM,iBAAiB,GAAG,IAAI,CAAC,QAAQ,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,OAAoB;QAChC,MAAM,CAAC,OAAO,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,WAAW,CAAC,WAAW,GAAG,CAAC,CAAC;QAEjC,sCAAsC;QACtC,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ;YACjC,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QAExF,qCAAqC;QACrC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAErB,oEAAoE;QACpE,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,kBAAkB;YAC1C,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO;gBACtB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAExB,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC;QAEhC,wDAAwD;QACxD,sFAAsF;QACtF,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO;YAC/B,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO;gBACtB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAExB,iCAAiC;QACjC,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAE5B,sDAAsD;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;YAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YACpC,IAAI,CAAC,OAAO;gBACV,MAAM;YAER,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED;;OAEG;IACI,iBAAiB;QACtB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO;YAC/B,MAAM,CAAC,MAAM,EAAE,CAAC;QAElB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,QAAQ;YAChC,MAAM,CAAC,MAAM,EAAE,CAAC;QAElB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,QAAqB;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,uBAAuB,CAAC,QAAqB,IAAU,CAAC;IAE/D;;OAEG;IACI,oBAAoB,KAAW,CAAC;IAEvC,2FAA2F;IACpF,cAAc,CAAC,OAAyB,IAAU,CAAC;IAE1D,qHAAqH;IAC9G,KAAK,CAAC,cAAc,CAAC,IAAU,EAAE,UAAyB;QAC/D,OAAO,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,OAAoB;QACrC,EAAE,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAAC;QAC3C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1B,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;YACpB,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACb,EAAE;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACO,MAAM,CAAC,OAAoB;QACnC,OAAO,CAAC,MAAM,EAAE,CAAC;QACjB,EAAE,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;IACjC,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,OAAoB;QAC9C,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;QACxD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF","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 */\n\nimport { assert, PriorityQueue } from \"@itwin/core-bentley\";\nimport { IModelConnection } from \"../IModelConnection\";\nimport { Tile, TileContent, TileRequest } from \"./internal\";\n\nclass TileRequestQueue extends PriorityQueue<TileRequest> {\n  public constructor() {\n    super((lhs, rhs) => {\n      const diff = lhs.tile.tree.loadPriority - rhs.tile.tree.loadPriority;\n      return 0 !== diff ? diff : lhs.priority - rhs.priority;\n    });\n  }\n}\n\n/** As part of a [[TileRequestChannelStatistics]], summarizes cumulative time spent decoding tile content.\n * For each Tile, the time elapsed between receiving the raw tile content (e.g., over the network) and converting it to a [[TileContent]] via [[Tile.readContent]]\n * is recorded.\n * All times are reported in milliseconds.\n * @beta\n */\nexport interface TileContentDecodingStatistics {\n  /** The total number of milliseconds spent decoding content. */\n  total: number;\n  /** The mean (average) number of milliseconds spent decoding content. */\n  mean: number;\n  /** The longest amount of time, in milliseconds, spent decoding any single tile's content. */\n  max: number;\n  /** The shortest amount of time, in milliseconds, spent decoding any single tile's content. */\n  min: number;\n}\n\n/** Statistics regarding the current and cumulative state of one or more [[TileRequestChannel]]s. Useful for monitoring performance and diagnosing problems.\n * @see [[TileRequestChannel.statistics]] for a specific channel's statistics.\n * @see [[TileRequestChannels.statistics]] for statistics from all channels.\n * @see [[TileAdmin.statistics]] for additional statistics.\n * @public\n * @extensions\n */\nexport class TileRequestChannelStatistics {\n  /** The number of queued requests that have not yet been dispatched. */\n  public numPendingRequests = 0;\n  /** The number of requests that have been dispatched but not yet completed. */\n  public numActiveRequests = 0;\n  /** The number of requests canceled during the most recent update. */\n  public numCanceled = 0;\n  /** The total number of completed requests during this session. */\n  public totalCompletedRequests = 0;\n  /** The total number of failed requests during this session. */\n  public totalFailedRequests = 0;\n  /** The total number of timed-out requests during this session. */\n  public totalTimedOutRequests = 0;\n  /** The total number of completed requests during this session which produced an empty tile.\n   * These tiles also contribute to [[totalCompletedRequests]], but not to [[totalUndisplayableTiles]].\n   */\n  public totalEmptyTiles = 0;\n  /** The total number of completed requests during this session that produced an undisplayable tile.\n   * These tiles also contribute to [[totalCompletedRequests]], but not to [[totalEmptyTiles]].\n   */\n  public totalUndisplayableTiles = 0;\n  /** The total number of tiles whose contents were not found in cloud storage cache and therefore resulted in a backend request to generate the tile content. */\n  public totalCacheMisses = 0;\n  /** The total number of tiles for which content requests were dispatched. */\n  public totalDispatchedRequests = 0;\n  /** The total number of tiles for which content requests were dispatched and then canceled on the backend before completion. */\n  public totalAbortedRequests = 0;\n  /** Statistics summarizing time spent decoding tile content.\n   * @beta\n   */\n  public decoding: TileContentDecodingStatistics = {\n    total: 0,\n    mean: 0,\n    max: Number.MIN_SAFE_INTEGER,\n    min: Number.MAX_SAFE_INTEGER,\n  };\n\n  /** @internal */\n  public addTo(stats: TileRequestChannelStatistics): void {\n    for (const propName in this) { // eslint-disable-line guard-for-in\n      const key = propName as keyof TileRequestChannelStatistics;\n      const val = this[key];\n      if (typeof val === \"number\") {\n        assert(typeof stats[key] === \"number\");\n        (stats[key] as number) += val; // eslint-disable-line @typescript-eslint/no-unnecessary-type-assertion\n      }\n    }\n\n    stats.decoding.total += this.decoding.total;\n    stats.decoding.max = Math.max(this.decoding.max, stats.decoding.max);\n    stats.decoding.min = Math.min(this.decoding.min, stats.decoding.min);\n\n    if (stats.totalCompletedRequests > 0)\n      stats.decoding.mean = (stats.decoding.total) / stats.totalCompletedRequests;\n  }\n\n  /** @internal */\n  public recordCompletion(tile: Tile, elapsedMilliseconds: number): void {\n    ++this.totalCompletedRequests;\n    if (tile.isEmpty)\n      ++this.totalEmptyTiles;\n    else if (!tile.isDisplayable)\n      ++this.totalUndisplayableTiles;\n\n    this.decoding.total += elapsedMilliseconds;\n    this.decoding.mean = this.decoding.total / this.totalCompletedRequests;\n    this.decoding.max = Math.max(this.decoding.max, elapsedMilliseconds);\n    this.decoding.min = Math.min(this.decoding.min, elapsedMilliseconds);\n  }\n}\n\n/** A channel over which requests for tile content can be made. The channel may request content over HTTP, calls to the backend via IPC or RPC, or any other method like generating the content\n * on the frontend. The channel consists of a queue of pending requests and a set of \"active\" requests (dispatched and awaiting a response). Incoming requests are placed onto the queue. Requests are popped of the queue in order of priority and dispatched, until the maximum number of simultaneously-active requests is reached.\n * The maximum number of active requests depends on the transport mechanism. For HTTP 1.1, browsers impose a limit of 6 simultaneous connections to a given domain, so ideally each unique domain will use its own unique channel with a limit of 6 active requests. Even for requests satisfied entirely by the frontend, imposing a limit is important for throttling the amount of work done at one time, especially because as the user navigates the view, tiles that were previously requested may no longer be of interest and we shouldn't waste resources producing their content.\n * A channel must be registered with [[TileRequestChannels]] and must have a unique name among all registered channels.\n * @see [[TileRequestChannels.getForHttp]] to obtain (and register if not already registered) an HTTP-based channel.\n * @see [[TileAdmin.channels]] for the channels configured for use with the iTwin.js display system.\n * @see [[Tile.channel]] to specify the channel to be used to request a given tile's content.\n * @public\n * @extensions\n */\nexport class TileRequestChannel {\n  /** The channel's name. It must be unique among all registered [[TileRequestChannels]]. */\n  public readonly name: string;\n  private _concurrency: number;\n  /** Protected strictly for tests. @internal */\n  protected readonly _active = new Set<TileRequest>();\n  private _pending = new TileRequestQueue();\n  private _previouslyPending = new TileRequestQueue();\n  protected _statistics = new TileRequestChannelStatistics();\n  /** Callback invoked by recordCompletion. See IModelTileMetadataCacheChannel.\n   * @internal\n   */\n  public contentCallback?: (tile: Tile, content: TileContent) => void;\n\n  /** Create a new channel.\n   * @param name The unique name of the channel.\n   * @param concurrency The maximum number of requests that can be dispatched and awaiting a response at any given time. Requests beyond this maximum are enqueued for deferred dispatch.\n   * @see [[TileRequestChannels.getForHttp]] to create an HTTP-based channel.\n   */\n  public constructor(name: string, concurrency: number) {\n    this.name = name;\n    this._concurrency = concurrency;\n  }\n\n  /** The maximum number of active requests. This is generally only modified for debugging purposes.\n   * @note When reducing `concurrency`, the number of active requests ([[numActive]]) will only decrease to the new value after a sufficient number of dispatched requests are resolved.\n   */\n  public get concurrency(): number {\n    return this._concurrency;\n  }\n  public set concurrency(max: number) {\n    this._concurrency = max;\n  }\n\n  /** The number of requests that have been dispatched and are awaiting a response. */\n  public get numActive(): number {\n    return this._active.size;\n  }\n\n  /** The number of requests that have been enqueued for later dispatch. */\n  public get numPending(): number {\n    return this._pending.length;\n  }\n\n  /** The total number of requests in this channel, whether dispatched or enqueued. */\n  public get size(): number {\n    return this.numActive + this.numPending;\n  }\n\n  /** Statistics intended primarily for debugging. */\n  public get statistics(): Readonly<TileRequestChannelStatistics> {\n    this._statistics.numPendingRequests = this.numPending;\n    this._statistics.numActiveRequests = this.numActive;\n    return this._statistics;\n  }\n\n  /** Reset all of this channel's [[statistics]] to zero. */\n  public resetStatistics(): void {\n    this._statistics = new TileRequestChannelStatistics();\n  }\n\n  /** Invoked by [[TileRequest]] when a request times out.\n   * @internal\n   */\n  public recordTimeout(): void {\n    ++this._statistics.totalTimedOutRequests;\n  }\n\n  /** Invoked by [[TileRequest]] when a request fails to produce a response.\n   * @internal\n   */\n  public recordFailure(): void {\n    ++this._statistics.totalFailedRequests;\n  }\n\n  /** Invoked by [[TileRequest]] after a request completes.\n   * @internal\n   */\n  public recordCompletion(tile: Tile, content: TileContent, elapsedMilliseconds: number): void {\n    this._statistics.recordCompletion(tile, elapsedMilliseconds);\n\n    if (this.contentCallback)\n      this.contentCallback(tile, content);\n  }\n\n  /** Invoked by [[TileRequestChannels.swapPending]] when [[TileAdmin]] is about to start enqueuing new requests.\n   * @internal\n   */\n  public swapPending(): void {\n    const previouslyPending = this._pending;\n    this._pending = this._previouslyPending;\n    this._previouslyPending = previouslyPending;\n  }\n\n  /** Invoked by [[TileAdmin.processRequests]] to enqueue a request. Ordering is ignored - the queue will be re-sorted later.\n   * @internal\n   */\n  public append(request: TileRequest): void {\n    assert(request.channel === this);\n    this._pending.append(request);\n  }\n\n  /** Invoked by [[TileRequestChannels.process]] to process the active and pending requests.\n   * @internal\n   */\n  public process(): void {\n    this._statistics.numCanceled = 0;\n\n    // Recompute priority of each request.\n    for (const pending of this._pending)\n      pending.priority = pending.tile.computeLoadPriority(pending.viewports, pending.users);\n\n    // Sort pending requests by priority.\n    this._pending.sort();\n\n    // Cancel any previously pending requests that are no longer needed.\n    for (const queued of this._previouslyPending)\n      if (queued.users.isEmpty)\n        this.cancel(queued);\n\n    this._previouslyPending.clear();\n\n    // Cancel any active requests that are no longer needed.\n    // NB: Do NOT remove them from the active set until their http activity has completed.\n    for (const active of this._active)\n      if (active.users.isEmpty)\n        this.cancel(active);\n\n    // Batch-cancel running requests.\n    this.processCancellations();\n\n    // Dispatch requests from the queue up to our maximum.\n    while (this._active.size < this._concurrency) {\n      const request = this._pending.pop();\n      if (!request)\n        break;\n\n      this.dispatch(request);\n    }\n  }\n\n  /** Cancel all active and queued requests and clear the active set and queue.\n   * @internal\n   */\n  public cancelAndClearAll(): void {\n    for (const active of this._active)\n      active.cancel();\n\n    for (const queued of this._pending)\n      queued.cancel();\n\n    this._active.clear();\n    this._pending.clear();\n  }\n\n  /** Invoked when [[Tile.requestContent]] returns `undefined`. Return true if the request can be retried, e.g., via different channel.\n   * If so, the tile will remain marked as \"not loaded\" and, if re-selected for display, a new [[TileRequest]] will be enqueued for it.\n   * Otherwise, the tile will be marked as \"failed to load\" and no further requests will be made for its content.\n   * The default implementation always returns `false`.\n   */\n  public onNoContent(_request: TileRequest): boolean {\n    return false;\n  }\n\n  /** Invoked when a request that was previously dispatched is canceled before a response is received.\n   * Some channels accumulate such requests for later cancellation in [[processCancellations]].\n   */\n  public onActiveRequestCanceled(_request: TileRequest): void { }\n\n  /** Invoked to do any additional work to cancel tiles accumulated by [[onActiveRequestCanceled]]. For example, a channel that requests tile content\n   * over IPC may signal to the tile generation process that it should cease generating content for those tiles.\n   */\n  public processCancellations(): void { }\n\n  /** Invoked when an iModel is closed, to clean up any state associated with that iModel. */\n  public onIModelClosed(_iModel: IModelConnection): void { }\n\n  /** Request content for the specified tile. The default implementation simply forwards to [[Tile.requestContent]]. */\n  public async requestContent(tile: Tile, isCanceled: () => boolean): Promise<TileRequest.Response> {\n    return tile.requestContent(isCanceled);\n  }\n\n  /** Protected only for tests - do not override.\n   * @internal\n   */\n  protected dispatch(request: TileRequest): void {\n    ++this._statistics.totalDispatchedRequests;\n    this._active.add(request);\n    request.dispatch(() => {\n      this.dropActiveRequest(request);\n    }).catch((_) => {\n      //\n    });\n  }\n\n  /** Protected only for tests - do not override.\n   * @internal\n   */\n  protected cancel(request: TileRequest): void {\n    request.cancel();\n    ++this._statistics.numCanceled;\n  }\n\n  /** Protected only for tests - do not override.\n   * @internal\n   */\n  protected dropActiveRequest(request: TileRequest): void {\n    assert(this._active.has(request) || request.isCanceled);\n    this._active.delete(request);\n  }\n}\n"]}
+{"version":3,"file":"TileRequestChannel.js","sourceRoot":"","sources":["../../../src/tile/TileRequestChannel.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAA2B,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAIrF,MAAM,gBAAiB,SAAQ,aAA0B;IACvD;QACE,KAAK,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACjB,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;YACrE,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAmBD;;;;;;GAMG;AACH,MAAM,OAAO,4BAA4B;IACvC,uEAAuE;IAChE,kBAAkB,GAAG,CAAC,CAAC;IAC9B,8EAA8E;IACvE,iBAAiB,GAAG,CAAC,CAAC;IAC7B,qEAAqE;IAC9D,WAAW,GAAG,CAAC,CAAC;IACvB,kEAAkE;IAC3D,sBAAsB,GAAG,CAAC,CAAC;IAClC,+DAA+D;IACxD,mBAAmB,GAAG,CAAC,CAAC;IAC/B,kEAAkE;IAC3D,qBAAqB,GAAG,CAAC,CAAC;IACjC;;OAEG;IACI,eAAe,GAAG,CAAC,CAAC;IAC3B;;OAEG;IACI,uBAAuB,GAAG,CAAC,CAAC;IACnC,+JAA+J;IACxJ,gBAAgB,GAAG,CAAC,CAAC;IAC5B,4EAA4E;IACrE,uBAAuB,GAAG,CAAC,CAAC;IACnC,+HAA+H;IACxH,oBAAoB,GAAG,CAAC,CAAC;IAChC;;OAEG;IACI,QAAQ,GAAkC;QAC/C,KAAK,EAAE,CAAC;QACR,IAAI,EAAE,CAAC;QACP,GAAG,EAAE,MAAM,CAAC,gBAAgB;QAC5B,GAAG,EAAE,MAAM,CAAC,gBAAgB;KAC7B,CAAC;IAEF,gBAAgB;IACT,KAAK,CAAC,KAAmC;QAC9C,KAAK,MAAM,QAAQ,IAAI,IAAI,EAAE,CAAC,CAAC,mCAAmC;YAChE,MAAM,GAAG,GAAG,QAAuE,CAAC;YACpF,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;YACtB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,MAAM,CAAC,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,CAAC;gBACtC,KAAK,CAAC,GAAG,CAAY,IAAI,GAAG,CAAC,CAAC,uEAAuE;YACxG,CAAC;QACH,CAAC;QAED,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC5C,KAAK,CAAC,QAAQ,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACrE,KAAK,CAAC,QAAQ,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAErE,IAAI,KAAK,CAAC,sBAAsB,GAAG,CAAC;YAClC,KAAK,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,sBAAsB,CAAC;IAChF,CAAC;IAED,gBAAgB;IACT,gBAAgB,CAAC,IAAU,EAAE,mBAA2B;QAC7D,EAAE,IAAI,CAAC,sBAAsB,CAAC;QAC9B,IAAI,IAAI,CAAC,OAAO;YACd,EAAE,IAAI,CAAC,eAAe,CAAC;aACpB,IAAI,CAAC,IAAI,CAAC,aAAa;YAC1B,EAAE,IAAI,CAAC,uBAAuB,CAAC;QAEjC,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,mBAAmB,CAAC;QAC3C,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,sBAAsB,CAAC;QACvE,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;QACrE,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;IACvE,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,kBAAkB;IAC7B,0FAA0F;IAC1E,IAAI,CAAS;IACrB,YAAY,CAAS;IAC7B,8CAA8C;IAC3B,OAAO,GAAG,IAAI,GAAG,EAAe,CAAC;IAC5C,QAAQ,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAClC,kBAAkB,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAC1C,WAAW,GAAG,IAAI,4BAA4B,EAAE,CAAC;IAC3D;;OAEG;IACI,eAAe,CAA8C;IAEpE;;;;OAIG;IACH,YAAmB,IAAY,EAAE,WAAmB;QAClD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IACD,IAAW,WAAW,CAAC,GAAW;QAChC,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;IAC1B,CAAC;IAED,oFAAoF;IACpF,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED,yEAAyE;IACzE,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED,oFAAoF;IACpF,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED,mDAAmD;IACnD,IAAW,UAAU;QACnB,IAAI,CAAC,WAAW,CAAC,kBAAkB,GAAG,IAAI,CAAC,UAAU,CAAC;QACtD,IAAI,CAAC,WAAW,CAAC,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC;QACpD,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,0DAA0D;IACnD,eAAe;QACpB,IAAI,CAAC,WAAW,GAAG,IAAI,4BAA4B,EAAE,CAAC;IACxD,CAAC;IAED;;OAEG;IACI,aAAa;QAClB,EAAE,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC;IAC3C,CAAC;IAED;;OAEG;IACI,aAAa;QAClB,EAAE,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,IAAU,EAAE,OAAoB,EAAE,mBAA2B;QACnF,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;QAE7D,IAAI,IAAI,CAAC,eAAe;YACtB,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,MAAM,iBAAiB,GAAG,IAAI,CAAC,QAAQ,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,OAAoB;QAChC,MAAM,CAAC,OAAO,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,WAAW,CAAC,WAAW,GAAG,CAAC,CAAC;QAEjC,sCAAsC;QACtC,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ;YACjC,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QAExF,qCAAqC;QACrC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAErB,oEAAoE;QACpE,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,kBAAkB;YAC1C,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO;gBACtB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAExB,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC;QAEhC,wDAAwD;QACxD,sFAAsF;QACtF,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO;YAC/B,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO;gBACtB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAExB,iCAAiC;QACjC,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAE5B,sDAAsD;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;YAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YACpC,IAAI,CAAC,OAAO;gBACV,MAAM;YAER,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED;;OAEG;IACI,iBAAiB;QACtB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO;YAC/B,MAAM,CAAC,MAAM,EAAE,CAAC;QAElB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,QAAQ;YAChC,MAAM,CAAC,MAAM,EAAE,CAAC;QAElB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,QAAqB;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,uBAAuB,CAAC,QAAqB,IAAU,CAAC;IAE/D;;OAEG;IACI,oBAAoB,KAAW,CAAC;IAEvC,2FAA2F;IACpF,cAAc,CAAC,OAAyB,IAAU,CAAC;IAE1D,qHAAqH;IAC9G,KAAK,CAAC,cAAc,CAAC,IAAU,EAAE,UAAyB;QAC/D,OAAO,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,OAAoB;QACrC,EAAE,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAAC;QAC3C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1B,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;YACpB,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACb,EAAE;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACO,MAAM,CAAC,OAAoB;QACnC,OAAO,CAAC,MAAM,EAAE,CAAC;QACjB,EAAE,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;IACjC,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,OAAoB;QAC9C,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;QACxD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF","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 */\n\nimport { assert, NonFunctionPropertiesOf, PriorityQueue } from \"@itwin/core-bentley\";\nimport { IModelConnection } from \"../IModelConnection\";\nimport { Tile, TileContent, TileRequest } from \"./internal\";\n\nclass TileRequestQueue extends PriorityQueue<TileRequest> {\n  public constructor() {\n    super((lhs, rhs) => {\n      const diff = lhs.tile.tree.loadPriority - rhs.tile.tree.loadPriority;\n      return 0 !== diff ? diff : lhs.priority - rhs.priority;\n    });\n  }\n}\n\n/** As part of a [[TileRequestChannelStatistics]], summarizes cumulative time spent decoding tile content.\n * For each Tile, the time elapsed between receiving the raw tile content (e.g., over the network) and converting it to a [[TileContent]] via [[Tile.readContent]]\n * is recorded.\n * All times are reported in milliseconds.\n * @beta\n */\nexport interface TileContentDecodingStatistics {\n  /** The total number of milliseconds spent decoding content. */\n  total: number;\n  /** The mean (average) number of milliseconds spent decoding content. */\n  mean: number;\n  /** The longest amount of time, in milliseconds, spent decoding any single tile's content. */\n  max: number;\n  /** The shortest amount of time, in milliseconds, spent decoding any single tile's content. */\n  min: number;\n}\n\n/** Statistics regarding the current and cumulative state of one or more [[TileRequestChannel]]s. Useful for monitoring performance and diagnosing problems.\n * @see [[TileRequestChannel.statistics]] for a specific channel's statistics.\n * @see [[TileRequestChannels.statistics]] for statistics from all channels.\n * @see [[TileAdmin.statistics]] for additional statistics.\n * @public\n * @extensions\n */\nexport class TileRequestChannelStatistics {\n  /** The number of queued requests that have not yet been dispatched. */\n  public numPendingRequests = 0;\n  /** The number of requests that have been dispatched but not yet completed. */\n  public numActiveRequests = 0;\n  /** The number of requests canceled during the most recent update. */\n  public numCanceled = 0;\n  /** The total number of completed requests during this session. */\n  public totalCompletedRequests = 0;\n  /** The total number of failed requests during this session. */\n  public totalFailedRequests = 0;\n  /** The total number of timed-out requests during this session. */\n  public totalTimedOutRequests = 0;\n  /** The total number of completed requests during this session which produced an empty tile.\n   * These tiles also contribute to [[totalCompletedRequests]], but not to [[totalUndisplayableTiles]].\n   */\n  public totalEmptyTiles = 0;\n  /** The total number of completed requests during this session that produced an undisplayable tile.\n   * These tiles also contribute to [[totalCompletedRequests]], but not to [[totalEmptyTiles]].\n   */\n  public totalUndisplayableTiles = 0;\n  /** The total number of tiles whose contents were not found in cloud storage cache and therefore resulted in a backend request to generate the tile content. */\n  public totalCacheMisses = 0;\n  /** The total number of tiles for which content requests were dispatched. */\n  public totalDispatchedRequests = 0;\n  /** The total number of tiles for which content requests were dispatched and then canceled on the backend before completion. */\n  public totalAbortedRequests = 0;\n  /** Statistics summarizing time spent decoding tile content.\n   * @beta\n   */\n  public decoding: TileContentDecodingStatistics = {\n    total: 0,\n    mean: 0,\n    max: Number.MIN_SAFE_INTEGER,\n    min: Number.MAX_SAFE_INTEGER,\n  };\n\n  /** @internal */\n  public addTo(stats: TileRequestChannelStatistics): void {\n    for (const propName in this) { // eslint-disable-line guard-for-in\n      const key = propName as keyof NonFunctionPropertiesOf<TileRequestChannelStatistics>;\n      const val = this[key];\n      if (typeof val === \"number\") {\n        assert(typeof stats[key] === \"number\");\n        (stats[key] as number) += val; // eslint-disable-line @typescript-eslint/no-unnecessary-type-assertion\n      }\n    }\n\n    stats.decoding.total += this.decoding.total;\n    stats.decoding.max = Math.max(this.decoding.max, stats.decoding.max);\n    stats.decoding.min = Math.min(this.decoding.min, stats.decoding.min);\n\n    if (stats.totalCompletedRequests > 0)\n      stats.decoding.mean = (stats.decoding.total) / stats.totalCompletedRequests;\n  }\n\n  /** @internal */\n  public recordCompletion(tile: Tile, elapsedMilliseconds: number): void {\n    ++this.totalCompletedRequests;\n    if (tile.isEmpty)\n      ++this.totalEmptyTiles;\n    else if (!tile.isDisplayable)\n      ++this.totalUndisplayableTiles;\n\n    this.decoding.total += elapsedMilliseconds;\n    this.decoding.mean = this.decoding.total / this.totalCompletedRequests;\n    this.decoding.max = Math.max(this.decoding.max, elapsedMilliseconds);\n    this.decoding.min = Math.min(this.decoding.min, elapsedMilliseconds);\n  }\n}\n\n/** A channel over which requests for tile content can be made. The channel may request content over HTTP, calls to the backend via IPC or RPC, or any other method like generating the content\n * on the frontend. The channel consists of a queue of pending requests and a set of \"active\" requests (dispatched and awaiting a response). Incoming requests are placed onto the queue. Requests are popped of the queue in order of priority and dispatched, until the maximum number of simultaneously-active requests is reached.\n * The maximum number of active requests depends on the transport mechanism. For HTTP 1.1, browsers impose a limit of 6 simultaneous connections to a given domain, so ideally each unique domain will use its own unique channel with a limit of 6 active requests. Even for requests satisfied entirely by the frontend, imposing a limit is important for throttling the amount of work done at one time, especially because as the user navigates the view, tiles that were previously requested may no longer be of interest and we shouldn't waste resources producing their content.\n * A channel must be registered with [[TileRequestChannels]] and must have a unique name among all registered channels.\n * @see [[TileRequestChannels.getForHttp]] to obtain (and register if not already registered) an HTTP-based channel.\n * @see [[TileAdmin.channels]] for the channels configured for use with the iTwin.js display system.\n * @see [[Tile.channel]] to specify the channel to be used to request a given tile's content.\n * @public\n * @extensions\n */\nexport class TileRequestChannel {\n  /** The channel's name. It must be unique among all registered [[TileRequestChannels]]. */\n  public readonly name: string;\n  private _concurrency: number;\n  /** Protected strictly for tests. @internal */\n  protected readonly _active = new Set<TileRequest>();\n  private _pending = new TileRequestQueue();\n  private _previouslyPending = new TileRequestQueue();\n  protected _statistics = new TileRequestChannelStatistics();\n  /** Callback invoked by recordCompletion. See IModelTileMetadataCacheChannel.\n   * @internal\n   */\n  public contentCallback?: (tile: Tile, content: TileContent) => void;\n\n  /** Create a new channel.\n   * @param name The unique name of the channel.\n   * @param concurrency The maximum number of requests that can be dispatched and awaiting a response at any given time. Requests beyond this maximum are enqueued for deferred dispatch.\n   * @see [[TileRequestChannels.getForHttp]] to create an HTTP-based channel.\n   */\n  public constructor(name: string, concurrency: number) {\n    this.name = name;\n    this._concurrency = concurrency;\n  }\n\n  /** The maximum number of active requests. This is generally only modified for debugging purposes.\n   * @note When reducing `concurrency`, the number of active requests ([[numActive]]) will only decrease to the new value after a sufficient number of dispatched requests are resolved.\n   */\n  public get concurrency(): number {\n    return this._concurrency;\n  }\n  public set concurrency(max: number) {\n    this._concurrency = max;\n  }\n\n  /** The number of requests that have been dispatched and are awaiting a response. */\n  public get numActive(): number {\n    return this._active.size;\n  }\n\n  /** The number of requests that have been enqueued for later dispatch. */\n  public get numPending(): number {\n    return this._pending.length;\n  }\n\n  /** The total number of requests in this channel, whether dispatched or enqueued. */\n  public get size(): number {\n    return this.numActive + this.numPending;\n  }\n\n  /** Statistics intended primarily for debugging. */\n  public get statistics(): Readonly<TileRequestChannelStatistics> {\n    this._statistics.numPendingRequests = this.numPending;\n    this._statistics.numActiveRequests = this.numActive;\n    return this._statistics;\n  }\n\n  /** Reset all of this channel's [[statistics]] to zero. */\n  public resetStatistics(): void {\n    this._statistics = new TileRequestChannelStatistics();\n  }\n\n  /** Invoked by [[TileRequest]] when a request times out.\n   * @internal\n   */\n  public recordTimeout(): void {\n    ++this._statistics.totalTimedOutRequests;\n  }\n\n  /** Invoked by [[TileRequest]] when a request fails to produce a response.\n   * @internal\n   */\n  public recordFailure(): void {\n    ++this._statistics.totalFailedRequests;\n  }\n\n  /** Invoked by [[TileRequest]] after a request completes.\n   * @internal\n   */\n  public recordCompletion(tile: Tile, content: TileContent, elapsedMilliseconds: number): void {\n    this._statistics.recordCompletion(tile, elapsedMilliseconds);\n\n    if (this.contentCallback)\n      this.contentCallback(tile, content);\n  }\n\n  /** Invoked by [[TileRequestChannels.swapPending]] when [[TileAdmin]] is about to start enqueuing new requests.\n   * @internal\n   */\n  public swapPending(): void {\n    const previouslyPending = this._pending;\n    this._pending = this._previouslyPending;\n    this._previouslyPending = previouslyPending;\n  }\n\n  /** Invoked by [[TileAdmin.processRequests]] to enqueue a request. Ordering is ignored - the queue will be re-sorted later.\n   * @internal\n   */\n  public append(request: TileRequest): void {\n    assert(request.channel === this);\n    this._pending.append(request);\n  }\n\n  /** Invoked by [[TileRequestChannels.process]] to process the active and pending requests.\n   * @internal\n   */\n  public process(): void {\n    this._statistics.numCanceled = 0;\n\n    // Recompute priority of each request.\n    for (const pending of this._pending)\n      pending.priority = pending.tile.computeLoadPriority(pending.viewports, pending.users);\n\n    // Sort pending requests by priority.\n    this._pending.sort();\n\n    // Cancel any previously pending requests that are no longer needed.\n    for (const queued of this._previouslyPending)\n      if (queued.users.isEmpty)\n        this.cancel(queued);\n\n    this._previouslyPending.clear();\n\n    // Cancel any active requests that are no longer needed.\n    // NB: Do NOT remove them from the active set until their http activity has completed.\n    for (const active of this._active)\n      if (active.users.isEmpty)\n        this.cancel(active);\n\n    // Batch-cancel running requests.\n    this.processCancellations();\n\n    // Dispatch requests from the queue up to our maximum.\n    while (this._active.size < this._concurrency) {\n      const request = this._pending.pop();\n      if (!request)\n        break;\n\n      this.dispatch(request);\n    }\n  }\n\n  /** Cancel all active and queued requests and clear the active set and queue.\n   * @internal\n   */\n  public cancelAndClearAll(): void {\n    for (const active of this._active)\n      active.cancel();\n\n    for (const queued of this._pending)\n      queued.cancel();\n\n    this._active.clear();\n    this._pending.clear();\n  }\n\n  /** Invoked when [[Tile.requestContent]] returns `undefined`. Return true if the request can be retried, e.g., via different channel.\n   * If so, the tile will remain marked as \"not loaded\" and, if re-selected for display, a new [[TileRequest]] will be enqueued for it.\n   * Otherwise, the tile will be marked as \"failed to load\" and no further requests will be made for its content.\n   * The default implementation always returns `false`.\n   */\n  public onNoContent(_request: TileRequest): boolean {\n    return false;\n  }\n\n  /** Invoked when a request that was previously dispatched is canceled before a response is received.\n   * Some channels accumulate such requests for later cancellation in [[processCancellations]].\n   */\n  public onActiveRequestCanceled(_request: TileRequest): void { }\n\n  /** Invoked to do any additional work to cancel tiles accumulated by [[onActiveRequestCanceled]]. For example, a channel that requests tile content\n   * over IPC may signal to the tile generation process that it should cease generating content for those tiles.\n   */\n  public processCancellations(): void { }\n\n  /** Invoked when an iModel is closed, to clean up any state associated with that iModel. */\n  public onIModelClosed(_iModel: IModelConnection): void { }\n\n  /** Request content for the specified tile. The default implementation simply forwards to [[Tile.requestContent]]. */\n  public async requestContent(tile: Tile, isCanceled: () => boolean): Promise<TileRequest.Response> {\n    return tile.requestContent(isCanceled);\n  }\n\n  /** Protected only for tests - do not override.\n   * @internal\n   */\n  protected dispatch(request: TileRequest): void {\n    ++this._statistics.totalDispatchedRequests;\n    this._active.add(request);\n    request.dispatch(() => {\n      this.dropActiveRequest(request);\n    }).catch((_) => {\n      //\n    });\n  }\n\n  /** Protected only for tests - do not override.\n   * @internal\n   */\n  protected cancel(request: TileRequest): void {\n    request.cancel();\n    ++this._statistics.numCanceled;\n  }\n\n  /** Protected only for tests - do not override.\n   * @internal\n   */\n  protected dropActiveRequest(request: TileRequest): void {\n    assert(this._active.has(request) || request.isCanceled);\n    this._active.delete(request);\n  }\n}\n"]}

package/lib/esm/tools/AccuDrawTool.d.ts

@@ -1,7 +1,6 @@
 /** @packageDocumentation
  * @module Tools
  */
-import { BentleyStatus } from "@itwin/core-bentley";
 import { Point3d } from "@itwin/core-geometry";
 import { ItemField, RotationMode } from "../AccuDraw";
 import { AuxCoordSystemState } from "../AuxCoordSys";
@@ -14,6 +13,7 @@ import { AccuDrawShortcutImplementation, AccuDrawShortcutTool } from "./AccuDraw
  * @beta
  */
 export declare class AccuDrawShortcuts {
+    private static _acsRequestGeneration;
     /** Disable/Enable AccuDraw for the session */
     static sessionToggle(): void;
     /** Suspend/Unsuspend AccuDraw for the active tool */
@@ -51,8 +51,25 @@ export declare class AccuDrawShortcuts {
     static rotateToElement(): Promise<boolean>;
     static defineACSByElement(): Promise<boolean>;
     static defineACSByPoints(): Promise<boolean>;
-    static getACS(acsName: string | undefined, useOrigin: boolean, useRotation: boolean): BentleyStatus;
-    static writeACS(_acsName: string): BentleyStatus;
+    private static getACSCode;
+    private static getNamedACS;
+    private static createNewACS;
+    /**
+     * Set the AuxiliaryCoordinateSystem for the current AccuDraw viewport by name.
+     * Optionally updates the AccuDraw origin and rotation to match the ACS.
+     * @note When no name is specified, AccuDraw is updated using the view's current ACS.
+     * @returns AuxCoordSystemState or undefined if name does not exist or is invalid for the view.
+     * @throws Error if resolving the ACS CodeSpec or loading ACS element properties fails.
+     */
+    static getACS(acsName: string | undefined, useOrigin: boolean, useRotation: boolean): Promise<AuxCoordSystemState | undefined>;
+    /**
+     * Create a new AuxiliaryCoordinateSystem for the current AccuDraw viewport using the compass origin, orientation, and mode.
+     * @note When no name is specified, the view's current ACS is updated from AccuDraw. Caller can choose to create
+     * an EditCommand to insert/update as a named ACS element using the returned AuxCoordSystemState.
+     * @returns AuxCoordSystemState or undefined if ACS could not be created.
+     * @throws Error if resolving the ACS CodeSpec or loading ACS element properties fails.
+     */
+    static writeACS(acsName: string | undefined): Promise<AuxCoordSystemState | undefined>;
     static itemFieldUnlockAll(): void;
 }
 /**

package/lib/esm/tools/AccuDrawTool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AccuDrawTool.d.ts","sourceRoot":"","sources":["../../../src/tools/AccuDrawTool.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAA+D,OAAO,EAAuB,MAAM,sBAAsB,CAAC;AACjI,OAAO,EAAqD,SAAS,EAA6B,YAAY,EAAa,MAAM,aAAa,CAAC;AAE/I,OAAO,EAAqB,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAIxE,OAAO,EAAkB,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAA4B,IAAI,EAAE,MAAM,QAAQ,CAAC;AACxD,OAAO,EAAE,8BAA8B,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAa9F;;;;GAIG;AACH,qBAAa,iBAAiB;IAC5B,8CAA8C;WAChC,aAAa,IAAI,IAAI;IASnC,qDAAqD;WACvC,aAAa,IAAI,IAAI;WAarB,iBAAiB,CAAC,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,GAAG,OAAO;WAsCtE,iBAAiB,CAAC,GAAG,EAAE,mBAAmB,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,OAAO,GAAG,OAAO;WAiE1G,mBAAmB;WAInB,iBAAiB;WAKX,iBAAiB,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;WA6CvF,iBAAiB,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;WACzC,uBAAuB,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;WAEzC,oBAAoB,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;WAgDxE,mBAAmB,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;WA0D3C,mBAAmB,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;WAM3C,eAAe,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;WAMvC,gBAAgB,IAAI,IAAI;WAKxB,sBAAsB,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;WAapD,SAAS,CAAC,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI;WA+CzC,iBAAiB,IAAI,IAAI;WAmCzB,SAAS,IAAI,IAAI;IAsF/B,uFAAuF;WACzE,SAAS,IAAI,IAAI;WAgDjB,KAAK,IAAI,IAAI;WA4Bb,KAAK,IAAI,IAAI;WA4Bb,KAAK,IAAI,IAAI;WAyBb,YAAY,IAAI,IAAI;WA8BpB,SAAS,IAAI,IAAI;WAQjB,mBAAmB,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;WAmBjD,SAAS,IAAI,IAAI;WAyBjB,YAAY,IAAI,IAAI;WAEpB,WAAW,IAAI,IAAI;WASnB,WAAW,IAAI,IAAI;WA2EnB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;WAkCtB,UAAU,CAAC,aAAa,EAAE,OAAO;WAIjC,eAAe;WAIf,kBAAkB;WAIlB,iBAAiB;WAIvB,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,GAAG,aAAa;WAiF5F,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,aAAa;WAkCzC,kBAAkB,IAAI,IAAI;CAKzC;AAED;;;;GAIG;AACH,qBAAa,yBAA0B,SAAQ,IAAI;IACjD,OAAuB,MAAM,SAA4B;IACnC,GAAG;CAI1B;AAED;;;;GAIG;AACH,qBAAa,yBAA0B,SAAQ,IAAI;IACjD,OAAuB,MAAM,SAA4B;IACnC,GAAG;CAI1B;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,IAAI;IAC7C,OAAuB,MAAM,SAAwB;IAC/B,GAAG;CAI1B;AAED;;;;GAIG;AACH,qBAAa,wBAAyB,SAAQ,IAAI;IAChD,OAAuB,MAAM,SAAwB;IAC/B,GAAG;CAI1B;AAED;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,IAAI;IAChD,OAAuB,MAAM,SAAwB;IAC/B,GAAG;CAI1B;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,IAAI;IAC5C,OAAuB,MAAM,SAAoB;IAC3B,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,IAAI;IAC5C,OAAuB,MAAM,SAAoB;IAC3B,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,IAAI;IAC5C,OAAuB,MAAM,SAAoB;IAC3B,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,2BAA4B,SAAQ,IAAI;IACnD,OAAuB,MAAM,SAA2B;IAClC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,IAAI;IAChD,OAAuB,MAAM,SAAwB;IAC/B,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,IAAI;IAC9C,OAAuB,MAAM,SAAyB;IAChC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,IAAI;IAC/C,OAAuB,MAAM,SAA0B;IACjC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,IAAI;IAC7C,OAAuB,MAAM,SAAwB;IAC/B,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,IAAI;IAC/C,OAAuB,MAAM,SAA0B;IACjC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,IAAI;IAC9C,OAAuB,MAAM,SAAyB;IAChC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,IAAI;IAC9C,OAAuB,MAAM,SAAyB;IAChC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,IAAI;IAClD,OAAuB,MAAM,SAA6B;IACpC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,IAAI;IAClD,OAAuB,MAAM,SAA6B;IACpC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,IAAI;IAClD,OAAuB,MAAM,SAA6B;IACpC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AA6CD;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,oBAAoB;IAGpC,aAAa,EAAE,OAAO;IAFhD,OAAuB,MAAM,SAAyB;IACtD,WAA2B,OAAO,IAAI,MAAM,CAAc;gBAChC,aAAa,GAAE,OAAc;IAEvD,gBAAgB;cACG,oBAAoB,IAAI,8BAA8B;IAInD,WAAW,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAOpE;AA0DD;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,oBAAoB;IACjE,OAAuB,MAAM,SAA4B;IAEzD,gBAAgB;cACG,oBAAoB,IAAI,8BAA8B;CAG1E;AA2ID;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,oBAAoB;IAChE,OAAuB,MAAM,SAA2B;IAExD,gBAAgB;cACG,oBAAoB,IAAI,8BAA8B;CAG1E;AAsDD;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,oBAAoB;IAC9D,OAAuB,MAAM,SAAiC;IAE9D,gBAAgB;cACG,oBAAoB,IAAI,8BAA8B;CAG1E;AAiFD;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,oBAAoB;IAC7D,OAAuB,MAAM,SAAgC;IAE7D,gBAAgB;cACG,oBAAoB,IAAI,8BAA8B;CAG1E"}
+{"version":3,"file":"AccuDrawTool.d.ts","sourceRoot":"","sources":["../../../src/tools/AccuDrawTool.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAA+D,OAAO,EAAuB,MAAM,sBAAsB,CAAC;AACjI,OAAO,EAAqD,SAAS,EAA6B,YAAY,EAAa,MAAM,aAAa,CAAC;AAE/I,OAAO,EAA8B,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAKjF,OAAO,EAAkB,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAA4B,IAAI,EAAE,MAAM,QAAQ,CAAC;AACxD,OAAO,EAAE,8BAA8B,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAa9F;;;;GAIG;AACH,qBAAa,iBAAiB;IAE5B,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAK;IAEzC,8CAA8C;WAChC,aAAa,IAAI,IAAI;IASnC,qDAAqD;WACvC,aAAa,IAAI,IAAI;WAarB,iBAAiB,CAAC,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,GAAG,OAAO;WAsCtE,iBAAiB,CAAC,GAAG,EAAE,mBAAmB,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,OAAO,GAAG,OAAO;WAiE1G,mBAAmB;WAInB,iBAAiB;WAKX,iBAAiB,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;WA6CvF,iBAAiB,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;WACzC,uBAAuB,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;WAEzC,oBAAoB,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;WAgDxE,mBAAmB,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;WA0D3C,mBAAmB,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;WAM3C,eAAe,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;WAMvC,gBAAgB,IAAI,IAAI;WAKxB,sBAAsB,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;WAapD,SAAS,CAAC,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI;WA+CzC,iBAAiB,IAAI,IAAI;WAmCzB,SAAS,IAAI,IAAI;IAsF/B,uFAAuF;WACzE,SAAS,IAAI,IAAI;WAgDjB,KAAK,IAAI,IAAI;WA4Bb,KAAK,IAAI,IAAI;WA4Bb,KAAK,IAAI,IAAI;WAyBb,YAAY,IAAI,IAAI;WA8BpB,SAAS,IAAI,IAAI;WAQjB,mBAAmB,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;WAmBjD,SAAS,IAAI,IAAI;WAyBjB,YAAY,IAAI,IAAI;WAEpB,WAAW,IAAI,IAAI;WASnB,WAAW,IAAI,IAAI;WA2EnB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;WAkCtB,UAAU,CAAC,aAAa,EAAE,OAAO;WAIjC,eAAe;WAIf,kBAAkB;WAIlB,iBAAiB;mBAIhB,UAAU;mBAMV,WAAW;mBAYX,YAAY;IAkBjC;;;;;;OAMG;WACiB,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAiE3I;;;;;;OAMG;WACiB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;WAiDrF,kBAAkB,IAAI,IAAI;CAKzC;AAED;;;;GAIG;AACH,qBAAa,yBAA0B,SAAQ,IAAI;IACjD,OAAuB,MAAM,SAA4B;IACnC,GAAG;CAI1B;AAED;;;;GAIG;AACH,qBAAa,yBAA0B,SAAQ,IAAI;IACjD,OAAuB,MAAM,SAA4B;IACnC,GAAG;CAI1B;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,IAAI;IAC7C,OAAuB,MAAM,SAAwB;IAC/B,GAAG;CAI1B;AAED;;;;GAIG;AACH,qBAAa,wBAAyB,SAAQ,IAAI;IAChD,OAAuB,MAAM,SAAwB;IAC/B,GAAG;CAI1B;AAED;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,IAAI;IAChD,OAAuB,MAAM,SAAwB;IAC/B,GAAG;CAI1B;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,IAAI;IAC5C,OAAuB,MAAM,SAAoB;IAC3B,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,IAAI;IAC5C,OAAuB,MAAM,SAAoB;IAC3B,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,IAAI;IAC5C,OAAuB,MAAM,SAAoB;IAC3B,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,2BAA4B,SAAQ,IAAI;IACnD,OAAuB,MAAM,SAA2B;IAClC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,IAAI;IAChD,OAAuB,MAAM,SAAwB;IAC/B,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,IAAI;IAC9C,OAAuB,MAAM,SAAyB;IAChC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,IAAI;IAC/C,OAAuB,MAAM,SAA0B;IACjC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,IAAI;IAC7C,OAAuB,MAAM,SAAwB;IAC/B,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,IAAI;IAC/C,OAAuB,MAAM,SAA0B;IACjC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,IAAI;IAC9C,OAAuB,MAAM,SAAyB;IAChC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,IAAI;IAC9C,OAAuB,MAAM,SAAyB;IAChC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,IAAI;IAClD,OAAuB,MAAM,SAA6B;IACpC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,IAAI;IAClD,OAAuB,MAAM,SAA6B;IACpC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,IAAI;IAClD,OAAuB,MAAM,SAA6B;IACpC,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AA6CD;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,oBAAoB;IAGpC,aAAa,EAAE,OAAO;IAFhD,OAAuB,MAAM,SAAyB;IACtD,WAA2B,OAAO,IAAI,MAAM,CAAc;gBAChC,aAAa,GAAE,OAAc;IAEvD,gBAAgB;cACG,oBAAoB,IAAI,8BAA8B;IAInD,WAAW,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAOpE;AA0DD;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,oBAAoB;IACjE,OAAuB,MAAM,SAA4B;IAEzD,gBAAgB;cACG,oBAAoB,IAAI,8BAA8B;CAG1E;AA2ID;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,oBAAoB;IAChE,OAAuB,MAAM,SAA2B;IAExD,gBAAgB;cACG,oBAAoB,IAAI,8BAA8B;CAG1E;AAsDD;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,oBAAoB;IAC9D,OAAuB,MAAM,SAAiC;IAE9D,gBAAgB;cACG,oBAAoB,IAAI,8BAA8B;CAG1E;AAiFD;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,oBAAoB;IAC7D,OAAuB,MAAM,SAAgC;IAE7D,gBAAgB;cACG,oBAAoB,IAAI,8BAA8B;CAG1E"}

package/lib/esm/tools/AccuDrawTool.js

@@ -5,11 +5,11 @@
 /** @packageDocumentation
  * @module Tools
  */
-import { BentleyStatus } from "@itwin/core-bentley";
+import { BisCodeSpec, Code } from "@itwin/core-common";
 import { AxisOrder, Geometry, Matrix3d, Plane3dByOriginAndUnitNormal, Point3d, Transform, Vector3d } from "@itwin/core-geometry";
 import { AccuDraw, AccuDrawFlags, CompassMode, ContextMode, ItemField, KeyinStatus, LockedStates, RotationMode, ThreeAxes } from "../AccuDraw";
 import { TentativeOrAccuSnap } from "../AccuSnap";
-import { ACSDisplayOptions } from "../AuxCoordSys";
+import { ACSDisplayOptions, ACSType, AuxCoordSystemState } from "../AuxCoordSys";
 import { IModelApp } from "../IModelApp";
 import { BeButtonEvent, CoreTools, Tool } from "./Tool";
 import { AccuDrawShortcutImplementation, AccuDrawShortcutTool } from "./AccuDrawShortcutTool";
@@ -27,6 +27,8 @@ function normalizedCrossProduct(vec1, vec2, out) {
  * @beta
  */
 export class AccuDrawShortcuts {
+    // Monotonic token used to ignore stale async ACS operations.
+    static _acsRequestGeneration = 0;
     /** Disable/Enable AccuDraw for the session */
     static sessionToggle() {
         const accudraw = IModelApp.accuDraw;
@@ -733,41 +735,71 @@ export class AccuDrawShortcuts {
     static async defineACSByPoints() {
         return IModelApp.tools.run("AccuDraw.DefineACSByPoints");
     }
-    static getACS(acsName, useOrigin, useRotation) {
+    static async getACSCode(view, acsName) {
+        const codeSpecName = view.isSpatialView() ? BisCodeSpec.auxCoordSystemSpatial : (view.is3d() ? BisCodeSpec.auxCoordSystem3d : BisCodeSpec.auxCoordSystem2d);
+        const codeSpec = await view.iModel.codeSpecs.getByName(codeSpecName);
+        return new Code({ spec: codeSpec.id, scope: view.model, value: acsName });
+    }
+    static async getNamedACS(view, acsName) {
+        const acsCode = await this.getACSCode(view, acsName);
+        const acsProps = await view.iModel.elements.loadProps(acsCode.toJSON());
+        if (!acsProps)
+            return { validForView: false };
+        const namedAcs = AuxCoordSystemState.fromProps(acsProps, view.iModel);
+        const validForView = namedAcs.isValidForView(view);
+        return { validForView, acs: namedAcs };
+    }
+    static async createNewACS(view, acsName) {
+        // Want a CodeProps to support insert so ViewState.createAuxCoordSystem(acsName) is not called.
+        const acsCode = await this.getACSCode(view, acsName);
+        // Determine the class name based on view type
+        let classFullName;
+        if (view.isSpatialView())
+            classFullName = "BisCore:AuxCoordSystemSpatial";
+        else if (view.is3d())
+            classFullName = "BisCore:AuxCoordSystem3d";
+        else
+            classFullName = "BisCore:AuxCoordSystem2d";
+        const acsProps = { model: acsCode.scope, code: acsCode.toJSON(), classFullName, type: ACSType.None };
+        const acs = AuxCoordSystemState.fromProps(acsProps, view.iModel);
+        return acs;
+    }
+    /**
+     * Set the AuxiliaryCoordinateSystem for the current AccuDraw viewport by name.
+     * Optionally updates the AccuDraw origin and rotation to match the ACS.
+     * @note When no name is specified, AccuDraw is updated using the view's current ACS.
+     * @returns AuxCoordSystemState or undefined if name does not exist or is invalid for the view.
+     * @throws Error if resolving the ACS CodeSpec or loading ACS element properties fails.
+     */
+    static async getACS(acsName, useOrigin, useRotation) {
         const accudraw = IModelApp.accuDraw;
         if (!accudraw.isEnabled)
-            return BentleyStatus.ERROR;
+            return undefined;
         const vp = accudraw.currentView;
         if (!vp)
-            return BentleyStatus.ERROR;
-        let currRotation = 0, currBaseRotation = 0;
-        const axes = new ThreeAxes();
-        if (!useRotation) {
-            // Save current rotation, event listener on ACS change will orient AccuDraw to ACS...
-            currRotation = accudraw.rotationMode;
-            currBaseRotation = accudraw.flags.baseRotation;
-            axes.setFrom(accudraw.axes);
-        }
+            return undefined;
+        const view = vp.view;
+        const requestGeneration = ++this._acsRequestGeneration;
+        const isRequestCurrent = () => accudraw.isEnabled && accudraw.currentView === vp && vp.view === view && requestGeneration === this._acsRequestGeneration;
+        let currentACS = view.auxiliaryCoordinateSystem;
         if (acsName && "" !== acsName) {
-            //   // See if this ACS already exists...
-            //   DgnCode acsCode = AuxCoordSystem:: CreateCode(vp -> GetViewControllerR().GetViewDefinition(), acsName);
-            //   DgnElementId acsId = vp -> GetViewController().GetDgnDb().Elements().QueryElementIdByCode(acsCode);
-            //   if (!acsId.IsValid())
-            //     return ERROR;
-            //   AuxCoordSystemCPtr auxElm = vp -> GetViewController().GetDgnDb().Elements().Get<AuxCoordSystem>(acsId);
-            //   if (!auxElm.IsValid())
-            //     return ERROR;
-            //   AuxCoordSystemPtr acsPtr = auxElm -> MakeCopy<AuxCoordSystem>();
-            //   if (!acsPtr.IsValid())
-            //     return ERROR;
-            //   AuxCoordSystemCR oldACS = vp -> GetViewController().GetAuxCoordinateSystem();
-            //   if (!useOrigin)
-            //     acsPtr -> SetOrigin(oldACS.GetOrigin());
-            //   if (!useRotation)
-            //     acsPtr -> SetRotation(oldACS.GetRotation());
-            //   AccuDraw:: UpdateAuxCoordinateSystem(* acsPtr, * vp);
+            const namedAcsResult = await this.getNamedACS(view, acsName);
+            if (!isRequestCurrent())
+                return undefined;
+            if (!namedAcsResult.validForView)
+                return undefined;
+            const namedAcs = namedAcsResult.acs;
+            if (!namedAcs)
+                return undefined;
+            if (!useOrigin)
+                namedAcs.setOrigin(currentACS.getOrigin());
+            if (!useRotation)
+                namedAcs.setRotation(currentACS.getRotation());
+            AccuDraw.updateAuxCoordinateSystem(namedAcs, vp); // Sets AccuDrawFlags.OrientACS hint to orient AccuDraw to ACS...
+            currentACS = namedAcs;
         }
-        const currentACS = vp.view.auxiliaryCoordinateSystem;
+        if (!isRequestCurrent())
+            return undefined;
         if (useOrigin) {
             accudraw.origin.setFrom(currentACS.getOrigin());
             accudraw.point.setFrom(accudraw.origin);
@@ -779,44 +811,62 @@ export class AccuDrawShortcuts {
         }
         else {
             this.itemFieldUnlockAll();
-            accudraw.setRotationMode(currRotation);
-            accudraw.flags.baseRotation = currBaseRotation;
-            accudraw.axes.setFrom(axes);
             if (RotationMode.ACS === accudraw.flags.baseRotation) {
                 const acs = currentACS.clone();
-                const rMatrix = accudraw.getRotation();
-                acs.setRotation(rMatrix);
+                acs.setRotation(accudraw.getRotation());
                 AccuDraw.updateAuxCoordinateSystem(acs, vp);
             }
             accudraw.published.flags &= ~AccuDrawFlags.OrientACS;
         }
-        return BentleyStatus.SUCCESS;
-    }
-    static writeACS(_acsName) {
+        return currentACS;
+    }
+    /**
+     * Create a new AuxiliaryCoordinateSystem for the current AccuDraw viewport using the compass origin, orientation, and mode.
+     * @note When no name is specified, the view's current ACS is updated from AccuDraw. Caller can choose to create
+     * an EditCommand to insert/update as a named ACS element using the returned AuxCoordSystemState.
+     * @returns AuxCoordSystemState or undefined if ACS could not be created.
+     * @throws Error if resolving the ACS CodeSpec or loading ACS element properties fails.
+     */
+    static async writeACS(acsName) {
         const accudraw = IModelApp.accuDraw;
         if (!accudraw.isEnabled)
-            return BentleyStatus.ERROR;
+            return undefined;
         const vp = accudraw.currentView;
         if (!vp)
-            return BentleyStatus.ERROR;
-        // const origin = accudraw.origin;
-        // const rMatrix = accudraw.getRotation();
-        // AuxCoordSystemPtr acsPtr = AuxCoordSystem:: CreateFrom(vp -> GetViewController().GetAuxCoordinateSystem());
-        // acsPtr -> SetOrigin(origin);
-        // acsPtr -> SetRotation(rMatrix);
-        // acsPtr -> SetType(CompassMode.Polar == accudraw.getCompassMode() ? ACSType :: Cylindrical : ACSType:: Rectangular);
-        // acsPtr -> SetCode(AuxCoordSystem:: CreateCode(vp -> GetViewControllerR().GetViewDefinition(), nullptr != acsName ? acsName : ""));
-        // acsPtr -> SetDescription("");
-        // if (acsName && '\0' != acsName[0]) {
-        //   DgnDbStatus status;
-        //   acsPtr -> Insert(& status);
-        //   if (DgnDbStatus:: Success != status)
-        //   return BentleyStatus.ERROR;
-        // }
-        // AccuDraw:: UpdateAuxCoordinateSystem(* acsPtr, * vp);
-        // accudraw.flags.baseRotation = RotationMode.ACS;
-        // accudraw.SetRotationMode(RotationMode.ACS);
-        return BentleyStatus.SUCCESS;
+            return undefined;
+        const view = vp.view;
+        const requestGeneration = ++this._acsRequestGeneration;
+        const isRequestCurrent = () => accudraw.isEnabled && accudraw.currentView === vp && vp.view === view && requestGeneration === this._acsRequestGeneration;
+        let acs;
+        if (acsName && "" !== acsName) {
+            const namedAcsResult = await this.getNamedACS(view, acsName);
+            if (!isRequestCurrent())
+                return undefined;
+            acs = namedAcsResult.acs;
+            if (!acs) {
+                acs = await this.createNewACS(view, acsName);
+                if (!isRequestCurrent())
+                    return undefined;
+            }
+            else if (!namedAcsResult.validForView) {
+                return undefined;
+            }
+        }
+        else {
+            acs = view.auxiliaryCoordinateSystem.clone();
+            acs.description = "";
+        }
+        if (!isRequestCurrent())
+            return undefined;
+        if (!acs)
+            return undefined;
+        acs.setOrigin(accudraw.origin);
+        acs.setRotation(accudraw.getRotation());
+        acs.type = CompassMode.Polar === accudraw.compassMode ? ACSType.Cylindrical : ACSType.Rectangular;
+        AccuDraw.updateAuxCoordinateSystem(acs, vp);
+        accudraw.flags.baseRotation = RotationMode.ACS;
+        accudraw.setRotationMode(RotationMode.ACS);
+        return acs;
     }
     static itemFieldUnlockAll() {
         const accudraw = IModelApp.accuDraw;