@itwin/core-common 5.15.1 → 5.16.0-dev.11

package/lib/esm/ECSqlReader.d.ts

@@ -8,15 +8,39 @@ import { ECSqlReaderBase, QueryRowProxy } from "./ECSqlReaderBase";
  * @public
  */
 export interface QueryStats {
-    /** Time spent running the query; not including time spent queued. Time is in microseconds */
+    /** Elapsed wait attributed to successful block downloads for the main Cloud SQLite database, in fractional milliseconds.
+     * Shared downloads count each request's own wait; measured cache hits report zero.
+     * Collection is controlled by the backend host, not by reader options.
+     * Absent when collection is disabled, unsupported, or incomplete, or the database is local-only.
+     */
+    backendDownloadTime?: number;
+    /** Active backend elapsed time excluding main-database block waits, in fractional milliseconds; not CPU usage.
+     * Includes preparation but excludes queueing, RPC, and application work between reader calls.
+     * Available under the same conditions as [[backendDownloadTime]].
+     */
+    backendExecutionTime?: number;
+    /** Number of successful main-database block acquisitions that waited, including shared downloads but excluding cache hits.
+     * Reacquiring a block after eviction or a retry counts again. Absent when block statistics are unsupported or incomplete.
+     */
+    backendDownloadBlocks?: number;
+    /** Bytes of the blocks counted by [[backendDownloadBlocks]], including repeated acquisitions.
+     * A download shared by several requests counts for each request that waited on it, so this is not unique network traffic.
+     * Absent under the same conditions as [[backendDownloadBlocks]].
+     */
+    backendDownloadBytes?: number;
+    /** Elapsed backend execution time, including preparation and blocking waits but not queueing, in microseconds.
+     * Despite its name, this does not measure CPU usage.
+     */
     backendCpuTime: number;
-    /** Total time it took the backend to run the query. Time is in milliseconds. */
+    /** Backend time through response construction, including queueing, in milliseconds. */
     backendTotalTime: number;
     /** Estimated memory used for the query. */
     backendMemUsed: number;
     /** Total number of rows returned by the backend. */
     backendRowsReturned: number;
-    /** The total round trip time from the client's perspective. Time is in milliseconds. */
+    /** Sum of executor-call elapsed times, including failed calls, in fractional milliseconds.
+     * Excludes application work between reader calls.
+     */
     totalTime: number;
     /** The number of retries attempted to execute the query. */
     retryCount: number;
@@ -58,6 +82,8 @@ export declare class ECSqlReader extends ECSqlReaderBase implements AsyncIterabl
     private _lockArgs;
     private _cursorId;
     private _stats;
+    private _cloudTimingUnavailable;
+    private _cloudBlocksUnavailable;
     private _options;
     /**
      * @internal
@@ -81,7 +107,8 @@ export declare class ECSqlReader extends ECSqlReaderBase implements AsyncIterabl
      */
     getRowInternal(): any[];
     /**
-     * Get performance-related statistics for the current query.
+     * Get accumulated statistics for this reader's lifetime, including retries and failed attempts with available timings.
+     * Deprecated resets do not clear these statistics.
      */
     get stats(): QueryStats;
     /**
@@ -92,6 +119,8 @@ export declare class ECSqlReader extends ECSqlReaderBase implements AsyncIterabl
      * @internal
      */
     protected runWithRetry(request: DbQueryRequest): Promise<DbQueryResponse>;
+    private invalidateCloudTiming;
+    private invalidateCloudBlocks;
     /**
      * Get the metadata for each column in the query result.
      *
@@ -111,6 +140,7 @@ export declare class ECSqlReader extends ECSqlReaderBase implements AsyncIterabl
     step(): Promise<boolean>;
     /**
      * Get all remaining rows from the query result.
+     * Buffered pages are materialized without awaiting each individual row.
      *
      * @returns An array of all remaining rows from the query result.
      */

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

@@ -1 +1 @@
-{"version":3,"file":"ECSqlReader.d.ts","sourceRoot":"","sources":["../../src/ECSqlReader.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EACS,cAAc,EAAE,eAAe,EAAE,iBAAiB,EAAkD,WAAW,EAAE,YAAY,EAC3I,qBAAqB,EACtB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,eAAe,EAAuB,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAExF;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,6FAA6F;IAC7F,cAAc,EAAE,MAAM,CAAC;IACvB,gFAAgF;IAChF,gBAAgB,EAAE,MAAM,CAAC;IACzB,2CAA2C;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,oDAAoD;IACpD,mBAAmB,EAAE,MAAM,CAAC;IAC5B,wFAAwF;IACxF,SAAS,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,UAAU,EAAE,MAAM,CAAC;IACnB,iGAAiG;IACjG,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,WAAY,SAAQ,eAAgB,YAAW,qBAAqB,CAAC,aAAa,CAAC;IAiB3E,OAAO,CAAC,SAAS;aAAsE,KAAK,EAAE,MAAM;IAhBvH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAM;IAE5C,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,aAAa,CAAc;IACnC,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,MAAM,CAAiC;IAC/C,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,SAAS,CAAc;IAC/B,OAAO,CAAC,MAAM,CAAsI;IACpJ,OAAO,CAAC,QAAQ,CAAwD;IAExE;;OAEG;gBACwB,SAAS,EAAE,iBAAiB,CAAC,cAAc,EAAE,eAAe,CAAC,EAAkB,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY;IAYpK;;OAEG;IACI,SAAS,CAAC,KAAK,EAAE,WAAW;IAMnC;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,EAAE,YAAY;IAsBnC;;;OAGG;IACI,aAAa;IAMpB;;OAEG;IACa,cAAc,IAAI,GAAG,EAAE;IAMvC;;OAEG;IACH,IAAW,KAAK,IAAI,UAAU,CAE7B;IAED;;OAEG;YACW,QAAQ;IAiCtB;;OAEG;cACa,YAAY,CAAC,OAAO,EAAE,cAAc;IAgCpD;;;;OAIG;IACU,WAAW,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAO5D;;OAEG;YACW,SAAS;IAQvB;;;;;OAKG;IACU,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC;IAerC;;;;OAIG;IACU,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAQtC;;;;OAIG;IACI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,aAAa,CAAC;IAIrE;;;;;;OAMG;IACU,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;CAajE"}
+{"version":3,"file":"ECSqlReader.d.ts","sourceRoot":"","sources":["../../src/ECSqlReader.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EACS,cAAc,EAAE,eAAe,EAAE,iBAAiB,EAAkD,WAAW,EAAE,YAAY,EAC3I,qBAAqB,EACtB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,eAAe,EAAuB,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAExF;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,uFAAuF;IACvF,gBAAgB,EAAE,MAAM,CAAC;IACzB,2CAA2C;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,oDAAoD;IACpD,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,UAAU,EAAE,MAAM,CAAC;IACnB,iGAAiG;IACjG,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,WAAY,SAAQ,eAAgB,YAAW,qBAAqB,CAAC,aAAa,CAAC;IAmB3E,OAAO,CAAC,SAAS;aAAsE,KAAK,EAAE,MAAM;IAlBvH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAM;IAE5C,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,aAAa,CAAc;IACnC,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,MAAM,CAAiC;IAC/C,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,SAAS,CAAc;IAC/B,OAAO,CAAC,MAAM,CAAkJ;IAChK,OAAO,CAAC,uBAAuB,CAAS;IACxC,OAAO,CAAC,uBAAuB,CAAS;IACxC,OAAO,CAAC,QAAQ,CAAwD;IAExE;;OAEG;gBACwB,SAAS,EAAE,iBAAiB,CAAC,cAAc,EAAE,eAAe,CAAC,EAAkB,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY;IAYpK;;OAEG;IACI,SAAS,CAAC,KAAK,EAAE,WAAW;IAMnC;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,EAAE,YAAY;IAsBnC;;;OAGG;IACI,aAAa;IAMpB;;OAEG;IACa,cAAc,IAAI,GAAG,EAAE;IAMvC;;;OAGG;IACH,IAAW,KAAK,IAAI,UAAU,CAE7B;IAED;;OAEG;YACW,QAAQ;IAiCtB;;OAEG;cACa,YAAY,CAAC,OAAO,EAAE,cAAc;IAuEpD,OAAO,CAAC,qBAAqB;IAO7B,OAAO,CAAC,qBAAqB;IAM7B;;;;OAIG;IACU,WAAW,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAO5D;;OAEG;YACW,SAAS;IAQvB;;;;;OAKG;IACU,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC;IAerC;;;;;OAKG;IACU,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAetC;;;;OAIG;IACI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,aAAa,CAAC;IAIrE;;;;;;OAMG;IACU,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;CAajE"}

package/lib/esm/ECSqlReader.js

@@ -43,6 +43,8 @@ export class ECSqlReader extends ECSqlReaderBase {
     _lockArgs = false;
     _cursorId = "";
     _stats = { backendCpuTime: 0, backendTotalTime: 0, backendMemUsed: 0, backendRowsReturned: 0, totalTime: 0, retryCount: 0, prepareTime: 0 };
+    _cloudTimingUnavailable = false;
+    _cloudBlocksUnavailable = false;
     _options = new QueryOptionsBuilder().getOptions();
     /**
      * @internal
@@ -111,7 +113,8 @@ export class ECSqlReader extends ECSqlReaderBase {
         return this._localRows[this._localOffset];
     }
     /**
-     * Get performance-related statistics for the current query.
+     * Get accumulated statistics for this reader's lifetime, including retries and failed attempts with available timings.
+     * Deprecated resets do not clear these statistics.
      */
     get stats() {
         return this._stats;
@@ -157,24 +160,66 @@ export class ECSqlReader extends ECSqlReaderBase {
     async runWithRetry(request) {
         const needRetry = (rs) => (rs.status === DbResponseStatus.Partial || rs.status === DbResponseStatus.QueueFull || rs.status === DbResponseStatus.Timeout || rs.status === DbResponseStatus.ShuttingDown) && (rs.data === undefined || rs.data.length === 0);
         const updateStats = (rs) => {
+            this._stats.backendMemUsed += rs.stats.memUsed;
+            this._stats.backendRowsReturned += (rs.data === undefined) ? 0 : rs.data.length;
+        };
+        const updateTiming = (rs) => {
             this._stats.backendCpuTime += rs.stats.cpuTime;
             this._stats.backendTotalTime += rs.stats.totalTime;
-            this._stats.backendMemUsed += rs.stats.memUsed;
             this._stats.prepareTime += rs.stats.prepareTime;
-            this._stats.backendRowsReturned += (rs.data === undefined) ? 0 : rs.data.length;
+            if (rs.stats.cloudSqliteTimingState === "notExecuted")
+                return;
+            if (this._cloudTimingUnavailable)
+                return;
+            if (rs.stats.cloudSqliteTimingState !== "unavailable" && rs.stats.downloadTime !== undefined && rs.stats.executionTime !== undefined) {
+                this._stats.backendDownloadTime = (this._stats.backendDownloadTime ?? 0) + rs.stats.downloadTime;
+                this._stats.backendExecutionTime = (this._stats.backendExecutionTime ?? 0) + rs.stats.executionTime;
+                if (!this._cloudBlocksUnavailable) {
+                    const { downloadBlocks, downloadBytes } = rs.stats;
+                    if (downloadBlocks !== undefined && Number.isSafeInteger(downloadBlocks) && downloadBlocks >= 0
+                        && downloadBytes !== undefined && Number.isSafeInteger(downloadBytes) && downloadBytes >= 0) {
+                        this._stats.backendDownloadBlocks = (this._stats.backendDownloadBlocks ?? 0) + downloadBlocks;
+                        this._stats.backendDownloadBytes = (this._stats.backendDownloadBytes ?? 0) + downloadBytes;
+                    }
+                    else {
+                        this.invalidateCloudBlocks();
+                    }
+                }
+            }
+            else {
+                this.invalidateCloudTiming();
+            }
         };
-        const execQuery = async (req) => {
-            const startTime = Date.now();
-            const rs = await this._executor.execute(req);
-            this.stats.totalTime += (Date.now() - startTime);
-            return rs;
+        const execQuery = (req) => {
+            const startTime = performance.now();
+            const onResponse = (rs) => {
+                this._stats.totalTime += performance.now() - startTime;
+                updateTiming(rs);
+                return rs;
+            };
+            const onError = (err) => {
+                this._stats.totalTime += performance.now() - startTime;
+                this.invalidateCloudTiming();
+                throw err;
+            };
+            let result;
+            try {
+                result = this._executor.execute(req);
+            }
+            catch (err) {
+                return onError(err);
+            }
+            return "then" in result ? result.then(onResponse, onError) : onResponse(result);
         };
         let retry = ECSqlReader._maxRetryCount;
-        let resp = await execQuery(request);
+        let pending = execQuery(request);
+        let resp = "then" in pending ? await pending : pending;
         DbQueryError.throwIfError(resp, request);
         while (--retry > 0 && needRetry(resp)) {
-            resp = await execQuery(request);
+            pending = execQuery(request);
+            resp = "then" in pending ? await pending : pending;
             this._stats.retryCount += 1;
+            DbQueryError.throwIfError(resp, request);
             if (needRetry(resp)) {
                 updateStats(resp);
             }
@@ -185,6 +230,17 @@ export class ECSqlReader extends ECSqlReaderBase {
         updateStats(resp);
         return resp;
     }
+    invalidateCloudTiming() {
+        this._cloudTimingUnavailable = true;
+        delete this._stats.backendDownloadTime;
+        delete this._stats.backendExecutionTime;
+        this.invalidateCloudBlocks();
+    }
+    invalidateCloudBlocks() {
+        this._cloudBlocksUnavailable = true;
+        delete this._stats.backendDownloadBlocks;
+        delete this._stats.backendDownloadBytes;
+    }
     /**
      * Get the metadata for each column in the query result.
      *
@@ -229,13 +285,21 @@ export class ECSqlReader extends ECSqlReaderBase {
     }
     /**
      * Get all remaining rows from the query result.
+     * Buffered pages are materialized without awaiting each individual row.
      *
      * @returns An array of all remaining rows from the query result.
      */
     async toArray() {
         const rows = [];
+        const drainPage = this.step === ECSqlReader.prototype.step;
         while (await this.step()) {
             rows.push(this.formatCurrentRow());
+            if (drainPage) {
+                while (this._localOffset < this._localRows.length - 1) {
+                    ++this._localOffset;
+                    rows.push(this.formatCurrentRow());
+                }
+            }
         }
         return rows;
     }

package/lib/esm/ECSqlReader.js.map

@@ -1 +1 @@
-{"version":3,"file":"ECSqlReader.js","sourceRoot":"","sources":["../../src/ECSqlReader.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EACL,YAAY,EAAsD,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,WAAW,EAAgB,mBAAmB,EACzI,cAAc,GACtC,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAiB,MAAM,mBAAmB,CAAC;AAuBxF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,WAAY,SAAQ,eAAe;IAiBnB;IAA+E;IAhBlG,MAAM,CAAU,cAAc,GAAG,EAAE,CAAC;IAEpC,UAAU,GAAU,EAAE,CAAC;IACvB,YAAY,GAAW,CAAC,CAAC;IACzB,aAAa,GAAW,CAAC,CAAC,CAAC;IAC3B,YAAY,GAAW,CAAC,CAAC,CAAC;IAC1B,WAAW,GAAY,KAAK,CAAC;IAC7B,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;IACvC,SAAS,GAAY,KAAK,CAAC;IAC3B,SAAS,GAAW,EAAE,CAAC;IACvB,MAAM,GAAG,EAAE,cAAc,EAAE,CAAC,EAAE,gBAAgB,EAAE,CAAC,EAAE,cAAc,EAAE,CAAC,EAAE,mBAAmB,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;IAC5I,QAAQ,GAAiB,IAAI,mBAAmB,EAAE,CAAC,UAAU,EAAE,CAAC;IAExE;;OAEG;IACH,YAA2B,SAA6D,EAAkB,KAAa,EAAE,KAAmB,EAAE,OAAsB;QAClK,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QADD,cAAS,GAAT,SAAS,CAAoD;QAAkB,UAAK,GAAL,KAAK,CAAQ;QAErH,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;QAClC,CAAC;QACD,4DAA4D;QAC5D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,KAAkB;QACjC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;IAClC,CAAC;IACD;;OAEG;IACI,KAAK,CAAC,OAAsB;QACjC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACpC,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAC1B,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,mBAAmB,CAAC,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;QACvB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QACvB,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,WAAW;YAChD,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,cAAc,CAAC,uBAAuB,CAAC;QACnE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QAC1C,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YACxB,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;gBAClF,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC;YAClD,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC;gBAChF,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;QAClD,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,aAAa;QAClB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC;IAED;;OAEG;IACa,cAAc;QAC5B,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY;YAC7C,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAU,CAAC;IACrD,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,QAAQ;QACpB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC7C,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC5C,IAAI,IAAI,CAAC,YAAY,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,4DAA4D;QAC5D,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,UAAU,CAAC;QACrI,MAAM,OAAO,GAAmB;YAC9B,GAAI,IAAI,CAAC,QAAQ;YACjB,IAAI,EAAE,aAAa,CAAC,KAAK;YACzB,WAAW;YACX,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI,EAAE,IAAI,CAAC,MAAM;YACjB,QAAQ,EAAE,IAAI,CAAC,SAAS;SACzB,CAAC;QACF,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QAChE,OAAO,CAAC,KAAK,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;QACtG,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,KAAK,gBAAgB,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,gBAAgB,CAAC,OAAO,CAAC;QACrG,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrD,IAAI,CAAC,MAAM,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnD,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YAC5B,WAAW,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;QAC/C,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,YAAY,CAAC,OAAuB;QAClD,MAAM,SAAS,GAAG,CAAC,EAAmB,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,MAAM,KAAK,gBAAgB,CAAC,OAAO,IAAI,EAAE,CAAC,MAAM,KAAK,gBAAgB,CAAC,SAAS,IAAI,EAAE,CAAC,MAAM,KAAK,gBAAgB,CAAC,OAAO,IAAI,EAAE,CAAC,MAAM,KAAK,gBAAgB,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;QAC5Q,MAAM,WAAW,GAAG,CAAC,EAAmB,EAAE,EAAE;YAC1C,IAAI,CAAC,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;YAC/C,IAAI,CAAC,MAAM,CAAC,gBAAgB,IAAI,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;YACnD,IAAI,CAAC,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;YAC/C,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC;YAChD,IAAI,CAAC,MAAM,CAAC,mBAAmB,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;QAClF,CAAC,CAAC;QACF,MAAM,SAAS,GAAG,KAAK,EAAE,GAAmB,EAAE,EAAE;YAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC7B,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC7C,IAAI,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC;YACjD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACF,IAAI,KAAK,GAAG,WAAW,CAAC,cAAc,CAAC;QACvC,IAAI,IAAI,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;QACpC,YAAY,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACzC,OAAO,EAAE,KAAK,GAAG,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACtC,IAAI,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC;YAC5B,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpB,WAAW,CAAC,IAAI,CAAC,CAAC;YACpB,CAAC;QACH,CAAC;QACD,IAAI,KAAK,KAAK,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACrE,CAAC;QACD,WAAW,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW;QACtB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACzB,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;IAChC,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,SAAS;QACrB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACxC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QACpB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC1C,IAAI,IAAI,CAAC,YAAY,GAAG,UAAU,GAAG,CAAC,EAAE,CAAC;YACvC,EAAE,IAAI,CAAC,YAAY,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YACvB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;YACtB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;QACrB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO;QAClB,MAAM,IAAI,GAAG,EAAE,CAAC;QAChB,OAAO,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,CAAC,MAAM,CAAC,aAAa,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,IAAI;QACf,IAAI,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;YACtB,OAAO;gBACL,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,IAAI,CAAC,OAAO;aACpB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,KAAK,EAAE,IAAI,CAAC,OAAO;aACpB,CAAC;QACJ,CAAC;IACH,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\nimport {\r\n  DbQueryError, DbQueryRequest, DbQueryResponse, DbRequestExecutor, DbRequestKind, DbResponseStatus, DbValueFormat, QueryBinder, QueryOptions, QueryOptionsBuilder,\r\n  QueryPropertyMetaData, QueryRowFormat,\r\n} from \"./ConcurrentQuery\";\r\nimport { Guid } from \"@itwin/core-bentley\";\r\nimport { ECSqlReaderBase, PropertyMetaDataMap, QueryRowProxy } from \"./ECSqlReaderBase\";\r\n\r\n/**\r\n * Performance-related statistics for [[ECSqlReader]].\r\n * @public\r\n */\r\nexport interface QueryStats {\r\n  /** Time spent running the query; not including time spent queued. Time is in microseconds */\r\n  backendCpuTime: number;\r\n  /** Total time it took the backend to run the query. Time is in milliseconds. */\r\n  backendTotalTime: number;\r\n  /** Estimated memory used for the query. */\r\n  backendMemUsed: number;\r\n  /** Total number of rows returned by the backend. */\r\n  backendRowsReturned: number;\r\n  /** The total round trip time from the client's perspective. Time is in milliseconds. */\r\n  totalTime: number;\r\n  /** The number of retries attempted to execute the query. */\r\n  retryCount: number;\r\n  /** Total time in millisecond to prepare ECSQL or grabing it from cache and binding parameters */\r\n  prepareTime: number;\r\n}\r\n\r\n/**\r\n * Execute ECSQL statements and read the results.\r\n *\r\n * The query results are returned one row at a time. The format of the row is dictated by the\r\n * [[QueryOptions.rowFormat]] specified in the `options` parameter of the constructed ECSqlReader object. Defaults to\r\n * [[QueryRowFormat.UseECSqlPropertyIndexes]] when no `rowFormat` is defined.\r\n *\r\n * There are three primary ways to interact with and read the results:\r\n * - Stream them using ECSqlReader as an asynchronous iterator.\r\n * - Iterator over them manually using [[ECSqlReader.step]].\r\n * - Capture all of the results at once in an array using [[ECSqlReader.toArray]].\r\n *\r\n * @see\r\n * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)\r\n * - [ECSQL Row Formats]($docs/learning/ECSQLRowFormat) for more details on how rows are formatted.\r\n * - [ECSQL Code Examples]($docs/learning/ECSQLCodeExamples#iterating-over-query-results) for examples of each\r\n *      of the above ways of interacting with ECSqlReader.\r\n *\r\n * @note When iterating over the results, the current row will be a [[QueryRowProxy]] object. To get the row as a basic\r\n *       JavaScript object, call [[QueryRowProxy.toRow]] on it.\r\n * @public\r\n */\r\nexport class ECSqlReader extends ECSqlReaderBase implements AsyncIterableIterator<QueryRowProxy> {\r\n  private static readonly _maxRetryCount = 10;\r\n\r\n  private _localRows: any[] = [];\r\n  private _localOffset: number = 0;\r\n  private _globalOffset: number = -1;\r\n  private _globalCount: number = -1;\r\n  private _globalDone: boolean = false;\r\n  private _param = new QueryBinder().serialize();\r\n  private _lockArgs: boolean = false;\r\n  private _cursorId: string = \"\";\r\n  private _stats = { backendCpuTime: 0, backendTotalTime: 0, backendMemUsed: 0, backendRowsReturned: 0, totalTime: 0, retryCount: 0, prepareTime: 0 };\r\n  private _options: QueryOptions = new QueryOptionsBuilder().getOptions();\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  public constructor(private _executor: DbRequestExecutor<DbQueryRequest, DbQueryResponse>, public readonly query: string, param?: QueryBinder, options?: QueryOptions) {\r\n    super(options?.rowFormat);\r\n    if (query.trim().length === 0) {\r\n      throw new Error(\"expecting non-empty ecsql statement\");\r\n    }\r\n    if (param) {\r\n      this._param = param.serialize();\r\n    }\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.reset(options);\r\n  }\r\n\r\n  /**\r\n   * @deprecated in 5.6 - will not be removed until after 2027-04-02. Should not be used. Will be made private in a future release.\r\n   */\r\n  public setParams(param: QueryBinder) {\r\n    if (this._lockArgs) {\r\n      throw new Error(\"call resetBindings() before setting or changing parameters\");\r\n    }\r\n    this._param = param.serialize();\r\n  }\r\n  /**\r\n   * @deprecated in 5.6 - will not be removed until after 2027-04-02. Should not be used. Will be made private in a future release.\r\n   */\r\n  public reset(options?: QueryOptions) {\r\n    this._cursorId = Guid.createValue();\r\n    if (options) {\r\n      this._options = options;\r\n    }\r\n    this._props = new PropertyMetaDataMap([]);\r\n    this._localRows = [];\r\n    this._globalDone = false;\r\n    this._globalOffset = 0;\r\n    this._globalCount = -1;\r\n    if (typeof this._options.rowFormat === \"undefined\")\r\n      this._options.rowFormat = QueryRowFormat.UseECSqlPropertyIndexes;\r\n    this._rowFormat = this._options.rowFormat;\r\n    if (this._options.limit) {\r\n      if (typeof this._options.limit.offset === \"number\" && this._options.limit.offset > 0)\r\n        this._globalOffset = this._options.limit.offset;\r\n      if (typeof this._options.limit.count === \"number\" && this._options.limit.count > 0)\r\n        this._globalCount = this._options.limit.count;\r\n    }\r\n    this._done = false;\r\n  }\r\n\r\n  /**\r\n   * Clear all bindings.\r\n   * @deprecated in 5.6 - will not be removed until after 2027-04-02. Should not be used. Will be made private in a future release.\r\n   */\r\n  public resetBindings() {\r\n    this._cursorId = Guid.createValue();\r\n    this._param = new QueryBinder().serialize();\r\n    this._lockArgs = false;\r\n  }\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  public override getRowInternal(): any[] {\r\n    if (this._localRows.length <= this._localOffset)\r\n      throw new Error(\"no current row\");\r\n    return this._localRows[this._localOffset] as any[];\r\n  }\r\n\r\n  /**\r\n   * Get performance-related statistics for the current query.\r\n   */\r\n  public get stats(): QueryStats {\r\n    return this._stats;\r\n  }\r\n\r\n  /**\r\n   *\r\n   */\r\n  private async readRows(): Promise<any[]> {\r\n    if (this._globalDone) {\r\n      return [];\r\n    }\r\n    this._lockArgs = true;\r\n    this._globalOffset += this._localRows.length;\r\n    this._globalCount -= this._localRows.length;\r\n    if (this._globalCount === 0) {\r\n      return [];\r\n    }\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    const valueFormat = this._options.rowFormat === QueryRowFormat.UseJsPropertyNames ? DbValueFormat.JsNames : DbValueFormat.ECSqlNames;\r\n    const request: DbQueryRequest = {\r\n      ... this._options,\r\n      kind: DbRequestKind.ECSql,\r\n      valueFormat,\r\n      query: this.query,\r\n      args: this._param,\r\n      cursorId: this._cursorId,\r\n    };\r\n    request.includeMetaData = this._props.length > 0 ? false : true;\r\n    request.limit = { offset: this._globalOffset, count: this._globalCount < 1 ? -1 : this._globalCount };\r\n    const resp = await this.runWithRetry(request);\r\n    this._globalDone = resp.status === DbResponseStatus.Done || resp.status === DbResponseStatus.NotOpen;\r\n    if (this._props.length === 0 && resp.meta.length > 0) {\r\n      this._props = new PropertyMetaDataMap(resp.meta);\r\n    }\r\n    for (const row of resp.data) {\r\n      ECSqlReader.replaceBase64WithUint8Array(row);\r\n    }\r\n    return resp.data;\r\n  }\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  protected async runWithRetry(request: DbQueryRequest) {\r\n    const needRetry = (rs: DbQueryResponse) => (rs.status === DbResponseStatus.Partial || rs.status === DbResponseStatus.QueueFull || rs.status === DbResponseStatus.Timeout || rs.status === DbResponseStatus.ShuttingDown) && (rs.data === undefined || rs.data.length === 0);\r\n    const updateStats = (rs: DbQueryResponse) => {\r\n      this._stats.backendCpuTime += rs.stats.cpuTime;\r\n      this._stats.backendTotalTime += rs.stats.totalTime;\r\n      this._stats.backendMemUsed += rs.stats.memUsed;\r\n      this._stats.prepareTime += rs.stats.prepareTime;\r\n      this._stats.backendRowsReturned += (rs.data === undefined) ? 0 : rs.data.length;\r\n    };\r\n    const execQuery = async (req: DbQueryRequest) => {\r\n      const startTime = Date.now();\r\n      const rs = await this._executor.execute(req);\r\n      this.stats.totalTime += (Date.now() - startTime);\r\n      return rs;\r\n    };\r\n    let retry = ECSqlReader._maxRetryCount;\r\n    let resp = await execQuery(request);\r\n    DbQueryError.throwIfError(resp, request);\r\n    while (--retry > 0 && needRetry(resp)) {\r\n      resp = await execQuery(request);\r\n      this._stats.retryCount += 1;\r\n      if (needRetry(resp)) {\r\n        updateStats(resp);\r\n      }\r\n    }\r\n    if (retry === 0 && needRetry(resp)) {\r\n      throw new Error(\"query too long to execute or server is too busy\");\r\n    }\r\n    updateStats(resp);\r\n    return resp;\r\n  }\r\n\r\n  /**\r\n   * Get the metadata for each column in the query result.\r\n   *\r\n   * @returns An array of [[QueryPropertyMetaData]].\r\n   */\r\n  public async getMetaData(): Promise<QueryPropertyMetaData[]> {\r\n    if (this._props.length === 0) {\r\n      await this.fetchRows();\r\n    }\r\n    return this._props.properties;\r\n  }\r\n\r\n  /**\r\n   *\r\n   */\r\n  private async fetchRows() {\r\n    this._localOffset = -1;\r\n    this._localRows = await this.readRows();\r\n    if (this._localRows.length === 0) {\r\n      this._done = true;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Step to the next row of the query result.\r\n   *\r\n   * @returns `true` if a row can be read from `current`.<br/>\r\n   *          `false` if there are no more rows; i.e., all rows have been stepped through already.\r\n   */\r\n  public async step(): Promise<boolean> {\r\n    if (this._done) {\r\n      return false;\r\n    }\r\n    const cachedRows = this._localRows.length;\r\n    if (this._localOffset < cachedRows - 1) {\r\n      ++this._localOffset;\r\n    } else {\r\n      await this.fetchRows();\r\n      this._localOffset = 0;\r\n      return !this._done;\r\n    }\r\n    return true;\r\n  }\r\n\r\n  /**\r\n   * Get all remaining rows from the query result.\r\n   *\r\n   * @returns An array of all remaining rows from the query result.\r\n   */\r\n  public async toArray(): Promise<any[]> {\r\n    const rows = [];\r\n    while (await this.step()) {\r\n      rows.push(this.formatCurrentRow());\r\n    }\r\n    return rows;\r\n  }\r\n\r\n  /**\r\n   * Accessor for using ECSqlReader as an asynchronous iterator.\r\n   *\r\n   * @returns An asynchronous iterator over the rows returned by the executed ECSQL query.\r\n   */\r\n  public [Symbol.asyncIterator](): AsyncIterableIterator<QueryRowProxy> {\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * Calls step when called as an iterator.\r\n   *\r\n   * Returns the row alongside a `done` boolean to indicate if there are any more rows for an iterator to step to.\r\n   *\r\n   * @returns An object with the keys: `value` which contains the row and `done` which contains a boolean.\r\n   */\r\n  public async next(): Promise<IteratorResult<QueryRowProxy, any>> {\r\n    if (await this.step()) {\r\n      return {\r\n        done: false,\r\n        value: this.current,\r\n      };\r\n    } else {\r\n      return {\r\n        done: true,\r\n        value: this.current,\r\n      };\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ECSqlReader.js","sourceRoot":"","sources":["../../src/ECSqlReader.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EACL,YAAY,EAAsD,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,WAAW,EAAgB,mBAAmB,EACzI,cAAc,GACtC,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAiB,MAAM,mBAAmB,CAAC;AA+CxF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,WAAY,SAAQ,eAAe;IAmBnB;IAA+E;IAlBlG,MAAM,CAAU,cAAc,GAAG,EAAE,CAAC;IAEpC,UAAU,GAAU,EAAE,CAAC;IACvB,YAAY,GAAW,CAAC,CAAC;IACzB,aAAa,GAAW,CAAC,CAAC,CAAC;IAC3B,YAAY,GAAW,CAAC,CAAC,CAAC;IAC1B,WAAW,GAAY,KAAK,CAAC;IAC7B,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;IACvC,SAAS,GAAY,KAAK,CAAC;IAC3B,SAAS,GAAW,EAAE,CAAC;IACvB,MAAM,GAAe,EAAE,cAAc,EAAE,CAAC,EAAE,gBAAgB,EAAE,CAAC,EAAE,cAAc,EAAE,CAAC,EAAE,mBAAmB,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;IACxJ,uBAAuB,GAAG,KAAK,CAAC;IAChC,uBAAuB,GAAG,KAAK,CAAC;IAChC,QAAQ,GAAiB,IAAI,mBAAmB,EAAE,CAAC,UAAU,EAAE,CAAC;IAExE;;OAEG;IACH,YAA2B,SAA6D,EAAkB,KAAa,EAAE,KAAmB,EAAE,OAAsB;QAClK,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QADD,cAAS,GAAT,SAAS,CAAoD;QAAkB,UAAK,GAAL,KAAK,CAAQ;QAErH,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;QAClC,CAAC;QACD,4DAA4D;QAC5D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,KAAkB;QACjC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;IAClC,CAAC;IACD;;OAEG;IACI,KAAK,CAAC,OAAsB;QACjC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACpC,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAC1B,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,mBAAmB,CAAC,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;QACvB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QACvB,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,WAAW;YAChD,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,cAAc,CAAC,uBAAuB,CAAC;QACnE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QAC1C,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YACxB,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;gBAClF,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC;YAClD,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC;gBAChF,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;QAClD,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,aAAa;QAClB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC;IAED;;OAEG;IACa,cAAc;QAC5B,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY;YAC7C,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAU,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,QAAQ;QACpB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC7C,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC5C,IAAI,IAAI,CAAC,YAAY,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,4DAA4D;QAC5D,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,UAAU,CAAC;QACrI,MAAM,OAAO,GAAmB;YAC9B,GAAI,IAAI,CAAC,QAAQ;YACjB,IAAI,EAAE,aAAa,CAAC,KAAK;YACzB,WAAW;YACX,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI,EAAE,IAAI,CAAC,MAAM;YACjB,QAAQ,EAAE,IAAI,CAAC,SAAS;SACzB,CAAC;QACF,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QAChE,OAAO,CAAC,KAAK,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;QACtG,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,KAAK,gBAAgB,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,gBAAgB,CAAC,OAAO,CAAC;QACrG,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrD,IAAI,CAAC,MAAM,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnD,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YAC5B,WAAW,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;QAC/C,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,YAAY,CAAC,OAAuB;QAClD,MAAM,SAAS,GAAG,CAAC,EAAmB,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,MAAM,KAAK,gBAAgB,CAAC,OAAO,IAAI,EAAE,CAAC,MAAM,KAAK,gBAAgB,CAAC,SAAS,IAAI,EAAE,CAAC,MAAM,KAAK,gBAAgB,CAAC,OAAO,IAAI,EAAE,CAAC,MAAM,KAAK,gBAAgB,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;QAC5Q,MAAM,WAAW,GAAG,CAAC,EAAmB,EAAE,EAAE;YAC1C,IAAI,CAAC,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;YAC/C,IAAI,CAAC,MAAM,CAAC,mBAAmB,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;QAClF,CAAC,CAAC;QACF,MAAM,YAAY,GAAG,CAAC,EAAmB,EAAE,EAAE;YAC3C,IAAI,CAAC,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;YAC/C,IAAI,CAAC,MAAM,CAAC,gBAAgB,IAAI,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;YACnD,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC;YAChD,IAAI,EAAE,CAAC,KAAK,CAAC,sBAAsB,KAAK,aAAa;gBACnD,OAAO;YACT,IAAI,IAAI,CAAC,uBAAuB;gBAC9B,OAAO;YACT,IAAI,EAAE,CAAC,KAAK,CAAC,sBAAsB,KAAK,aAAa,IAAI,EAAE,CAAC,KAAK,CAAC,YAAY,KAAK,SAAS,IAAI,EAAE,CAAC,KAAK,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBACrI,IAAI,CAAC,MAAM,CAAC,mBAAmB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,mBAAmB,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC;gBACjG,IAAI,CAAC,MAAM,CAAC,oBAAoB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,oBAAoB,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC;gBACpG,IAAI,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;oBAClC,MAAM,EAAE,cAAc,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC;oBACnD,IAAI,cAAc,KAAK,SAAS,IAAI,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,cAAc,IAAI,CAAC;2BAC1F,aAAa,KAAK,SAAS,IAAI,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,aAAa,IAAI,CAAC,EAAE,CAAC;wBAC9F,IAAI,CAAC,MAAM,CAAC,qBAAqB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,qBAAqB,IAAI,CAAC,CAAC,GAAG,cAAc,CAAC;wBAC9F,IAAI,CAAC,MAAM,CAAC,oBAAoB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,oBAAoB,IAAI,CAAC,CAAC,GAAG,aAAa,CAAC;oBAC7F,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,qBAAqB,EAAE,CAAC;oBAC/B,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC/B,CAAC;QACH,CAAC,CAAC;QACF,MAAM,SAAS,GAAG,CAAC,GAAmB,EAA8C,EAAE;YACpF,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;YACpC,MAAM,UAAU,GAAG,CAAC,EAAmB,EAAE,EAAE;gBACzC,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;gBACvD,YAAY,CAAC,EAAE,CAAC,CAAC;gBACjB,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC;YACF,MAAM,OAAO,GAAG,CAAC,GAAY,EAAS,EAAE;gBACtC,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;gBACvD,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC7B,MAAM,GAAG,CAAC;YACZ,CAAC,CAAC;YACF,IAAI,MAAkD,CAAC;YACvD,IAAI,CAAC;gBACH,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACvC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;YACtB,CAAC;YACD,OAAO,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAClF,CAAC,CAAC;QACF,IAAI,KAAK,GAAG,WAAW,CAAC,cAAc,CAAC;QACvC,IAAI,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;QACjC,IAAI,IAAI,GAAG,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;QACvD,YAAY,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACzC,OAAO,EAAE,KAAK,GAAG,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACtC,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;YAC7B,IAAI,GAAG,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;YACnD,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC;YAC5B,YAAY,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YACzC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpB,WAAW,CAAC,IAAI,CAAC,CAAC;YACpB,CAAC;QACH,CAAC;QACD,IAAI,KAAK,KAAK,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACrE,CAAC;QACD,WAAW,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,qBAAqB;QAC3B,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC;QACpC,OAAO,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;QACxC,IAAI,CAAC,qBAAqB,EAAE,CAAC;IAC/B,CAAC;IAEO,qBAAqB;QAC3B,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC;QACpC,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW;QACtB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACzB,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;IAChC,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,SAAS;QACrB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACxC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QACpB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC1C,IAAI,IAAI,CAAC,YAAY,GAAG,UAAU,GAAG,CAAC,EAAE,CAAC;YACvC,EAAE,IAAI,CAAC,YAAY,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YACvB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;YACtB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;QACrB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO;QAClB,MAAM,IAAI,GAAG,EAAE,CAAC;QAChB,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC;QAC3D,OAAO,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;YACnC,IAAI,SAAS,EAAE,CAAC;gBACd,OAAO,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACtD,EAAE,IAAI,CAAC,YAAY,CAAC;oBACpB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,CAAC,MAAM,CAAC,aAAa,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,IAAI;QACf,IAAI,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;YACtB,OAAO;gBACL,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,IAAI,CAAC,OAAO;aACpB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,KAAK,EAAE,IAAI,CAAC,OAAO;aACpB,CAAC;QACJ,CAAC;IACH,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\nimport {\r\n  DbQueryError, DbQueryRequest, DbQueryResponse, DbRequestExecutor, DbRequestKind, DbResponseStatus, DbValueFormat, QueryBinder, QueryOptions, QueryOptionsBuilder,\r\n  QueryPropertyMetaData, QueryRowFormat,\r\n} from \"./ConcurrentQuery\";\r\nimport { Guid } from \"@itwin/core-bentley\";\r\nimport { ECSqlReaderBase, PropertyMetaDataMap, QueryRowProxy } from \"./ECSqlReaderBase\";\r\n\r\n/**\r\n * Performance-related statistics for [[ECSqlReader]].\r\n * @public\r\n */\r\nexport interface QueryStats {\r\n  /** Elapsed wait attributed to successful block downloads for the main Cloud SQLite database, in fractional milliseconds.\r\n   * Shared downloads count each request's own wait; measured cache hits report zero.\r\n   * Collection is controlled by the backend host, not by reader options.\r\n   * Absent when collection is disabled, unsupported, or incomplete, or the database is local-only.\r\n   */\r\n  backendDownloadTime?: number;\r\n  /** Active backend elapsed time excluding main-database block waits, in fractional milliseconds; not CPU usage.\r\n   * Includes preparation but excludes queueing, RPC, and application work between reader calls.\r\n   * Available under the same conditions as [[backendDownloadTime]].\r\n   */\r\n  backendExecutionTime?: number;\r\n  /** Number of successful main-database block acquisitions that waited, including shared downloads but excluding cache hits.\r\n   * Reacquiring a block after eviction or a retry counts again. Absent when block statistics are unsupported or incomplete.\r\n   */\r\n  backendDownloadBlocks?: number;\r\n  /** Bytes of the blocks counted by [[backendDownloadBlocks]], including repeated acquisitions.\r\n   * A download shared by several requests counts for each request that waited on it, so this is not unique network traffic.\r\n   * Absent under the same conditions as [[backendDownloadBlocks]].\r\n   */\r\n  backendDownloadBytes?: number;\r\n  /** Elapsed backend execution time, including preparation and blocking waits but not queueing, in microseconds.\r\n   * Despite its name, this does not measure CPU usage.\r\n   */\r\n  backendCpuTime: number;\r\n  /** Backend time through response construction, including queueing, in milliseconds. */\r\n  backendTotalTime: number;\r\n  /** Estimated memory used for the query. */\r\n  backendMemUsed: number;\r\n  /** Total number of rows returned by the backend. */\r\n  backendRowsReturned: number;\r\n  /** Sum of executor-call elapsed times, including failed calls, in fractional milliseconds.\r\n   * Excludes application work between reader calls.\r\n   */\r\n  totalTime: number;\r\n  /** The number of retries attempted to execute the query. */\r\n  retryCount: number;\r\n  /** Total time in millisecond to prepare ECSQL or grabing it from cache and binding parameters */\r\n  prepareTime: number;\r\n}\r\n\r\n/**\r\n * Execute ECSQL statements and read the results.\r\n *\r\n * The query results are returned one row at a time. The format of the row is dictated by the\r\n * [[QueryOptions.rowFormat]] specified in the `options` parameter of the constructed ECSqlReader object. Defaults to\r\n * [[QueryRowFormat.UseECSqlPropertyIndexes]] when no `rowFormat` is defined.\r\n *\r\n * There are three primary ways to interact with and read the results:\r\n * - Stream them using ECSqlReader as an asynchronous iterator.\r\n * - Iterator over them manually using [[ECSqlReader.step]].\r\n * - Capture all of the results at once in an array using [[ECSqlReader.toArray]].\r\n *\r\n * @see\r\n * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)\r\n * - [ECSQL Row Formats]($docs/learning/ECSQLRowFormat) for more details on how rows are formatted.\r\n * - [ECSQL Code Examples]($docs/learning/ECSQLCodeExamples#iterating-over-query-results) for examples of each\r\n *      of the above ways of interacting with ECSqlReader.\r\n *\r\n * @note When iterating over the results, the current row will be a [[QueryRowProxy]] object. To get the row as a basic\r\n *       JavaScript object, call [[QueryRowProxy.toRow]] on it.\r\n * @public\r\n */\r\nexport class ECSqlReader extends ECSqlReaderBase implements AsyncIterableIterator<QueryRowProxy> {\r\n  private static readonly _maxRetryCount = 10;\r\n\r\n  private _localRows: any[] = [];\r\n  private _localOffset: number = 0;\r\n  private _globalOffset: number = -1;\r\n  private _globalCount: number = -1;\r\n  private _globalDone: boolean = false;\r\n  private _param = new QueryBinder().serialize();\r\n  private _lockArgs: boolean = false;\r\n  private _cursorId: string = \"\";\r\n  private _stats: QueryStats = { backendCpuTime: 0, backendTotalTime: 0, backendMemUsed: 0, backendRowsReturned: 0, totalTime: 0, retryCount: 0, prepareTime: 0 };\r\n  private _cloudTimingUnavailable = false;\r\n  private _cloudBlocksUnavailable = false;\r\n  private _options: QueryOptions = new QueryOptionsBuilder().getOptions();\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  public constructor(private _executor: DbRequestExecutor<DbQueryRequest, DbQueryResponse>, public readonly query: string, param?: QueryBinder, options?: QueryOptions) {\r\n    super(options?.rowFormat);\r\n    if (query.trim().length === 0) {\r\n      throw new Error(\"expecting non-empty ecsql statement\");\r\n    }\r\n    if (param) {\r\n      this._param = param.serialize();\r\n    }\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.reset(options);\r\n  }\r\n\r\n  /**\r\n   * @deprecated in 5.6 - will not be removed until after 2027-04-02. Should not be used. Will be made private in a future release.\r\n   */\r\n  public setParams(param: QueryBinder) {\r\n    if (this._lockArgs) {\r\n      throw new Error(\"call resetBindings() before setting or changing parameters\");\r\n    }\r\n    this._param = param.serialize();\r\n  }\r\n  /**\r\n   * @deprecated in 5.6 - will not be removed until after 2027-04-02. Should not be used. Will be made private in a future release.\r\n   */\r\n  public reset(options?: QueryOptions) {\r\n    this._cursorId = Guid.createValue();\r\n    if (options) {\r\n      this._options = options;\r\n    }\r\n    this._props = new PropertyMetaDataMap([]);\r\n    this._localRows = [];\r\n    this._globalDone = false;\r\n    this._globalOffset = 0;\r\n    this._globalCount = -1;\r\n    if (typeof this._options.rowFormat === \"undefined\")\r\n      this._options.rowFormat = QueryRowFormat.UseECSqlPropertyIndexes;\r\n    this._rowFormat = this._options.rowFormat;\r\n    if (this._options.limit) {\r\n      if (typeof this._options.limit.offset === \"number\" && this._options.limit.offset > 0)\r\n        this._globalOffset = this._options.limit.offset;\r\n      if (typeof this._options.limit.count === \"number\" && this._options.limit.count > 0)\r\n        this._globalCount = this._options.limit.count;\r\n    }\r\n    this._done = false;\r\n  }\r\n\r\n  /**\r\n   * Clear all bindings.\r\n   * @deprecated in 5.6 - will not be removed until after 2027-04-02. Should not be used. Will be made private in a future release.\r\n   */\r\n  public resetBindings() {\r\n    this._cursorId = Guid.createValue();\r\n    this._param = new QueryBinder().serialize();\r\n    this._lockArgs = false;\r\n  }\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  public override getRowInternal(): any[] {\r\n    if (this._localRows.length <= this._localOffset)\r\n      throw new Error(\"no current row\");\r\n    return this._localRows[this._localOffset] as any[];\r\n  }\r\n\r\n  /**\r\n   * Get accumulated statistics for this reader's lifetime, including retries and failed attempts with available timings.\r\n   * Deprecated resets do not clear these statistics.\r\n   */\r\n  public get stats(): QueryStats {\r\n    return this._stats;\r\n  }\r\n\r\n  /**\r\n   *\r\n   */\r\n  private async readRows(): Promise<any[]> {\r\n    if (this._globalDone) {\r\n      return [];\r\n    }\r\n    this._lockArgs = true;\r\n    this._globalOffset += this._localRows.length;\r\n    this._globalCount -= this._localRows.length;\r\n    if (this._globalCount === 0) {\r\n      return [];\r\n    }\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    const valueFormat = this._options.rowFormat === QueryRowFormat.UseJsPropertyNames ? DbValueFormat.JsNames : DbValueFormat.ECSqlNames;\r\n    const request: DbQueryRequest = {\r\n      ... this._options,\r\n      kind: DbRequestKind.ECSql,\r\n      valueFormat,\r\n      query: this.query,\r\n      args: this._param,\r\n      cursorId: this._cursorId,\r\n    };\r\n    request.includeMetaData = this._props.length > 0 ? false : true;\r\n    request.limit = { offset: this._globalOffset, count: this._globalCount < 1 ? -1 : this._globalCount };\r\n    const resp = await this.runWithRetry(request);\r\n    this._globalDone = resp.status === DbResponseStatus.Done || resp.status === DbResponseStatus.NotOpen;\r\n    if (this._props.length === 0 && resp.meta.length > 0) {\r\n      this._props = new PropertyMetaDataMap(resp.meta);\r\n    }\r\n    for (const row of resp.data) {\r\n      ECSqlReader.replaceBase64WithUint8Array(row);\r\n    }\r\n    return resp.data;\r\n  }\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  protected async runWithRetry(request: DbQueryRequest) {\r\n    const needRetry = (rs: DbQueryResponse) => (rs.status === DbResponseStatus.Partial || rs.status === DbResponseStatus.QueueFull || rs.status === DbResponseStatus.Timeout || rs.status === DbResponseStatus.ShuttingDown) && (rs.data === undefined || rs.data.length === 0);\r\n    const updateStats = (rs: DbQueryResponse) => {\r\n      this._stats.backendMemUsed += rs.stats.memUsed;\r\n      this._stats.backendRowsReturned += (rs.data === undefined) ? 0 : rs.data.length;\r\n    };\r\n    const updateTiming = (rs: DbQueryResponse) => {\r\n      this._stats.backendCpuTime += rs.stats.cpuTime;\r\n      this._stats.backendTotalTime += rs.stats.totalTime;\r\n      this._stats.prepareTime += rs.stats.prepareTime;\r\n      if (rs.stats.cloudSqliteTimingState === \"notExecuted\")\r\n        return;\r\n      if (this._cloudTimingUnavailable)\r\n        return;\r\n      if (rs.stats.cloudSqliteTimingState !== \"unavailable\" && rs.stats.downloadTime !== undefined && rs.stats.executionTime !== undefined) {\r\n        this._stats.backendDownloadTime = (this._stats.backendDownloadTime ?? 0) + rs.stats.downloadTime;\r\n        this._stats.backendExecutionTime = (this._stats.backendExecutionTime ?? 0) + rs.stats.executionTime;\r\n        if (!this._cloudBlocksUnavailable) {\r\n          const { downloadBlocks, downloadBytes } = rs.stats;\r\n          if (downloadBlocks !== undefined && Number.isSafeInteger(downloadBlocks) && downloadBlocks >= 0\r\n            && downloadBytes !== undefined && Number.isSafeInteger(downloadBytes) && downloadBytes >= 0) {\r\n            this._stats.backendDownloadBlocks = (this._stats.backendDownloadBlocks ?? 0) + downloadBlocks;\r\n            this._stats.backendDownloadBytes = (this._stats.backendDownloadBytes ?? 0) + downloadBytes;\r\n          } else {\r\n            this.invalidateCloudBlocks();\r\n          }\r\n        }\r\n      } else {\r\n        this.invalidateCloudTiming();\r\n      }\r\n    };\r\n    const execQuery = (req: DbQueryRequest): DbQueryResponse | Promise<DbQueryResponse> => {\r\n      const startTime = performance.now();\r\n      const onResponse = (rs: DbQueryResponse) => {\r\n        this._stats.totalTime += performance.now() - startTime;\r\n        updateTiming(rs);\r\n        return rs;\r\n      };\r\n      const onError = (err: unknown): never => {\r\n        this._stats.totalTime += performance.now() - startTime;\r\n        this.invalidateCloudTiming();\r\n        throw err;\r\n      };\r\n      let result: DbQueryResponse | Promise<DbQueryResponse>;\r\n      try {\r\n        result = this._executor.execute(req);\r\n      } catch (err) {\r\n        return onError(err);\r\n      }\r\n      return \"then\" in result ? result.then(onResponse, onError) : onResponse(result);\r\n    };\r\n    let retry = ECSqlReader._maxRetryCount;\r\n    let pending = execQuery(request);\r\n    let resp = \"then\" in pending ? await pending : pending;\r\n    DbQueryError.throwIfError(resp, request);\r\n    while (--retry > 0 && needRetry(resp)) {\r\n      pending = execQuery(request);\r\n      resp = \"then\" in pending ? await pending : pending;\r\n      this._stats.retryCount += 1;\r\n      DbQueryError.throwIfError(resp, request);\r\n      if (needRetry(resp)) {\r\n        updateStats(resp);\r\n      }\r\n    }\r\n    if (retry === 0 && needRetry(resp)) {\r\n      throw new Error(\"query too long to execute or server is too busy\");\r\n    }\r\n    updateStats(resp);\r\n    return resp;\r\n  }\r\n\r\n  private invalidateCloudTiming(): void {\r\n    this._cloudTimingUnavailable = true;\r\n    delete this._stats.backendDownloadTime;\r\n    delete this._stats.backendExecutionTime;\r\n    this.invalidateCloudBlocks();\r\n  }\r\n\r\n  private invalidateCloudBlocks(): void {\r\n    this._cloudBlocksUnavailable = true;\r\n    delete this._stats.backendDownloadBlocks;\r\n    delete this._stats.backendDownloadBytes;\r\n  }\r\n\r\n  /**\r\n   * Get the metadata for each column in the query result.\r\n   *\r\n   * @returns An array of [[QueryPropertyMetaData]].\r\n   */\r\n  public async getMetaData(): Promise<QueryPropertyMetaData[]> {\r\n    if (this._props.length === 0) {\r\n      await this.fetchRows();\r\n    }\r\n    return this._props.properties;\r\n  }\r\n\r\n  /**\r\n   *\r\n   */\r\n  private async fetchRows() {\r\n    this._localOffset = -1;\r\n    this._localRows = await this.readRows();\r\n    if (this._localRows.length === 0) {\r\n      this._done = true;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Step to the next row of the query result.\r\n   *\r\n   * @returns `true` if a row can be read from `current`.<br/>\r\n   *          `false` if there are no more rows; i.e., all rows have been stepped through already.\r\n   */\r\n  public async step(): Promise<boolean> {\r\n    if (this._done) {\r\n      return false;\r\n    }\r\n    const cachedRows = this._localRows.length;\r\n    if (this._localOffset < cachedRows - 1) {\r\n      ++this._localOffset;\r\n    } else {\r\n      await this.fetchRows();\r\n      this._localOffset = 0;\r\n      return !this._done;\r\n    }\r\n    return true;\r\n  }\r\n\r\n  /**\r\n   * Get all remaining rows from the query result.\r\n   * Buffered pages are materialized without awaiting each individual row.\r\n   *\r\n   * @returns An array of all remaining rows from the query result.\r\n   */\r\n  public async toArray(): Promise<any[]> {\r\n    const rows = [];\r\n    const drainPage = this.step === ECSqlReader.prototype.step;\r\n    while (await this.step()) {\r\n      rows.push(this.formatCurrentRow());\r\n      if (drainPage) {\r\n        while (this._localOffset < this._localRows.length - 1) {\r\n          ++this._localOffset;\r\n          rows.push(this.formatCurrentRow());\r\n        }\r\n      }\r\n    }\r\n    return rows;\r\n  }\r\n\r\n  /**\r\n   * Accessor for using ECSqlReader as an asynchronous iterator.\r\n   *\r\n   * @returns An asynchronous iterator over the rows returned by the executed ECSQL query.\r\n   */\r\n  public [Symbol.asyncIterator](): AsyncIterableIterator<QueryRowProxy> {\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * Calls step when called as an iterator.\r\n   *\r\n   * Returns the row alongside a `done` boolean to indicate if there are any more rows for an iterator to step to.\r\n   *\r\n   * @returns An object with the keys: `value` which contains the row and `done` which contains a boolean.\r\n   */\r\n  public async next(): Promise<IteratorResult<QueryRowProxy, any>> {\r\n    if (await this.step()) {\r\n      return {\r\n        done: false,\r\n        value: this.current,\r\n      };\r\n    } else {\r\n      return {\r\n        done: true,\r\n        value: this.current,\r\n      };\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/esm/ECSqlReaderBase.d.ts

@@ -114,6 +114,8 @@ export declare abstract class ECSqlReaderBase {
      * @internal
      */
     protected abstract getRowInternal(): any[];
+    /** @internal */
+    protected getMetaDataInternal(): QueryPropertyMetaData[];
     /**
      * Converts Base64-encoded strings in a row object into Uint8Arrays in-place.
      * @internal

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

@@ -1 +1 @@
-{"version":3,"file":"ECSqlReaderBase.d.ts","sourceRoot":"","sources":["../../src/ECSqlReaderBase.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAE1E,cAAc;AACd,qBAAa,mBAAoB,YAAW,QAAQ,CAAC,qBAAqB,CAAC;aAKtC,UAAU,EAAE,qBAAqB,EAAE;IAJtE,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,SAAS,CAA6B;gBAEX,UAAU,EAAE,qBAAqB,EAAE;IAWtE,IAAW,MAAM,IAAI,MAAM,CAE1B;IAEM,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE,SAAS,CAAC;IAIpE,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAQ3D,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAQ/D,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;CAOrE;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,GAAG,CAAC;AAEjC;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,KAAK,IAAI,GAAG,CAAC;IAEb;;;;;OAKG;IACH,OAAO,IAAI,cAAc,EAAE,CAAC;IAE5B;;;;OAIG;IACH,WAAW,IAAI,qBAAqB,EAAE,CAAC;IAEvC;;;;;;;;;;;;OAYG;IACH,CAAC,YAAY,EAAE,MAAM,GAAG,cAAc,CAAC;IAEvC;;;;;;;OAOG;IACH,CAAC,aAAa,EAAE,MAAM,GAAG,cAAc,CAAC;CACzC;AAED;;;;;;;GAOG;AACH,8BAAsB,eAAe;IACnC,gBAAgB;IAChB,SAAS,CAAC,KAAK,EAAE,OAAO,CAAS;IACjC,gBAAgB;IAChB,SAAS,CAAC,MAAM,sBAA+B;IAC/C,gBAAgB;IAChB,SAAS,CAAC,UAAU,EAAE,cAAc,CAAC;IAErC,OAAO,CAAC,SAAS,CAiCd;IAEH;;OAEG;IACH,SAAS,aAAa,SAAS,CAAC,EAAE,cAAc;IAIhD;;;;;;;;;;;;;;OAcG;IACH,IAAW,OAAO,IAAI,aAAa,CAElC;IAED;;;;;OAKG;IACH,IAAW,IAAI,IAAI,OAAO,CAEzB;IAED;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,IAAI,GAAG,EAAE;IAE1C;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,2BAA2B,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAa5D;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,gBAAgB,GAAE,OAAe,GAAG,GAAG,EAAE,GAAG,MAAM;CAkB9E"}
+{"version":3,"file":"ECSqlReaderBase.d.ts","sourceRoot":"","sources":["../../src/ECSqlReaderBase.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAE1E,cAAc;AACd,qBAAa,mBAAoB,YAAW,QAAQ,CAAC,qBAAqB,CAAC;aAKtC,UAAU,EAAE,qBAAqB,EAAE;IAJtE,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,SAAS,CAA6B;gBAEX,UAAU,EAAE,qBAAqB,EAAE;IAWtE,IAAW,MAAM,IAAI,MAAM,CAE1B;IAEM,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE,SAAS,CAAC;IAIpE,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAQ3D,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAQ/D,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;CAOrE;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,GAAG,CAAC;AAEjC;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,KAAK,IAAI,GAAG,CAAC;IAEb;;;;;OAKG;IACH,OAAO,IAAI,cAAc,EAAE,CAAC;IAE5B;;;;OAIG;IACH,WAAW,IAAI,qBAAqB,EAAE,CAAC;IAEvC;;;;;;;;;;;;OAYG;IACH,CAAC,YAAY,EAAE,MAAM,GAAG,cAAc,CAAC;IAEvC;;;;;;;OAOG;IACH,CAAC,aAAa,EAAE,MAAM,GAAG,cAAc,CAAC;CACzC;AAED;;;;;;;GAOG;AACH,8BAAsB,eAAe;IACnC,gBAAgB;IAChB,SAAS,CAAC,KAAK,EAAE,OAAO,CAAS;IACjC,gBAAgB;IAChB,SAAS,CAAC,MAAM,sBAA+B;IAC/C,gBAAgB;IAChB,SAAS,CAAC,UAAU,EAAE,cAAc,CAAC;IAErC,OAAO,CAAC,SAAS,CAiCd;IAEH;;OAEG;IACH,SAAS,aAAa,SAAS,CAAC,EAAE,cAAc;IAIhD;;;;;;;;;;;;;;OAcG;IACH,IAAW,OAAO,IAAI,aAAa,CAElC;IAED;;;;;OAKG;IACH,IAAW,IAAI,IAAI,OAAO,CAEzB;IAED;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,IAAI,GAAG,EAAE;IAE1C,gBAAgB;IAChB,SAAS,CAAC,mBAAmB,IAAI,qBAAqB,EAAE;IAIxD;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,2BAA2B,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAa5D;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,gBAAgB,GAAE,OAAe,GAAG,GAAG,EAAE,GAAG,MAAM;CAkB9E"}

package/lib/esm/ECSqlReaderBase.js

@@ -79,7 +79,7 @@ export class ECSqlReaderBase {
                     return target.getRowInternal()[prop.index];
                 }
                 if (key === "getMetaData") {
-                    return () => target._props.properties;
+                    return () => target.getMetaDataInternal();
                 }
                 if (key === "toRow") {
                     return () => target.formatCurrentRow(true);
@@ -134,6 +134,10 @@ export class ECSqlReaderBase {
     get done() {
         return this._done;
     }
+    /** @internal */
+    getMetaDataInternal() {
+        return this._props.properties;
+    }
     /**
      * Converts Base64-encoded strings in a row object into Uint8Arrays in-place.
      * @internal

package/lib/esm/ECSqlReaderBase.js.map

@@ -1 +1 @@
-{"version":3,"file":"ECSqlReaderBase.js","sourceRoot":"","sources":["../../src/ECSqlReaderBase.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAyB,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAE1E,cAAc;AACd,MAAM,OAAO,mBAAmB;IAKK;IAJ3B,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;IACxC,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;IACxC,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;IAE9C,YAAmC,UAAmC;QAAnC,eAAU,GAAV,UAAU,CAAyB;QACpE,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACvC,QAAQ,CAAC,UAAU,GAAG,QAAQ,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAG,uDAAuD;YACjJ,QAAQ,CAAC,YAAY,GAAG,QAAQ,CAAC,YAAY,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC;YACzF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;YACpD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;YACxD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAChC,CAAC;IAEM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC5C,CAAC;IAEM,UAAU,CAAC,IAAY;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,cAAc,CAAC,IAAY;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,YAAY,CAAC,IAAY;QAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QACrD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AA6DD;;;;;;;GAOG;AACH,MAAM,OAAgB,eAAe;IACnC,gBAAgB;IACN,KAAK,GAAY,KAAK,CAAC;IACjC,gBAAgB;IACN,MAAM,GAAG,IAAI,mBAAmB,CAAC,EAAE,CAAC,CAAC;IAC/C,gBAAgB;IACN,UAAU,CAAiB;IAE7B,SAAS,GAAG,IAAI,KAAK,CAAkB,IAAI,EAAE;QACnD,GAAG,EAAE,CAAC,MAAuB,EAAE,GAAoB,EAAE,EAAE;YACrD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;gBACrC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;oBACvB,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC;gBACtC,CAAC;gBACD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;gBAC7C,IAAI,IAAI,EAAE,CAAC;oBACT,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC7C,CAAC;gBACD,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;oBAC1B,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC;gBACxC,CAAC;gBACD,IAAI,GAAG,KAAK,OAAO,EAAE,CAAC;oBACpB,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBAC7C,CAAC;gBACD,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;oBACtB,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;gBACvC,CAAC;YACH,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,GAAG,EAAE,CAAC,MAAuB,EAAE,CAAkB,EAAE,EAAE;YACnD,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAW,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,EAAE,CAAC,MAAuB,EAAE,EAAE;YACnC,MAAM,IAAI,GAAG,EAAE,CAAC;YAChB,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBACjC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACvB,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC,CAAC;IAEH;;OAEG;IACH,YAAsB,SAA0B;QAC9C,IAAI,CAAC,UAAU,GAAG,SAAS,IAAI,cAAc,CAAC,uBAAuB,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,SAAgB,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IASD;;;OAGG;IACO,MAAM,CAAC,2BAA2B,CAAC,GAAQ;QACnD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACnC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;YACrB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,IAAI,mBAAmB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;oBACvC,GAAG,CAAC,GAAG,CAAC,GAAG,mBAAmB,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;gBACnD,CAAC;YACH,CAAC;iBAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBACnD,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;YACxC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACO,gBAAgB,CAAC,mBAA4B,KAAK;QAC1D,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,UAAU,KAAK,cAAc,CAAC,uBAAuB,EAAE,CAAC;YACpF,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;QAC/B,CAAC;QACD,MAAM,YAAY,GAAG,EAAE,CAAC;QACxB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAC/B,4DAA4D;YAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,KAAK,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YACnG,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC9C,IAAI,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBAC/C,MAAM,CAAC,cAAc,CAAC,YAAY,EAAE,QAAQ,EAAE;oBAC5C,KAAK,EAAE,GAAG;oBACV,UAAU,EAAE,IAAI;iBACjB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\nimport { Base64EncodedString } from \"./Base64EncodedString\";\r\nimport { QueryPropertyMetaData, QueryRowFormat } from \"./ConcurrentQuery\";\r\n\r\n/** @public */\r\nexport class PropertyMetaDataMap implements Iterable<QueryPropertyMetaData> {\r\n  private _byPropName = new Map<string, number>();\r\n  private _byJsonName = new Map<string, number>();\r\n  private _byNoCase = new Map<string, number>();\r\n\r\n  public constructor(public readonly properties: QueryPropertyMetaData[]) {\r\n    for (const property of this.properties) {\r\n      property.extendType = property.extendedType !== undefined ? property.extendedType : \"\";   // eslint-disable-line @typescript-eslint/no-deprecated\r\n      property.extendedType = property.extendedType === \"\" ? undefined : property.extendedType;\r\n      this._byPropName.set(property.name, property.index);\r\n      this._byJsonName.set(property.jsonName, property.index);\r\n      this._byNoCase.set(property.name.toLowerCase(), property.index);\r\n      this._byNoCase.set(property.jsonName.toLowerCase(), property.index);\r\n    }\r\n  }\r\n\r\n  public get length(): number {\r\n    return this.properties.length;\r\n  }\r\n\r\n  public [Symbol.iterator](): Iterator<QueryPropertyMetaData, any, undefined> {\r\n    return this.properties[Symbol.iterator]();\r\n  }\r\n\r\n  public findByName(name: string): QueryPropertyMetaData | undefined {\r\n    const index = this._byPropName.get(name);\r\n    if (typeof index === \"number\") {\r\n      return this.properties[index];\r\n    }\r\n    return undefined;\r\n  }\r\n\r\n  public findByJsonName(name: string): QueryPropertyMetaData | undefined {\r\n    const index = this._byJsonName.get(name);\r\n    if (typeof index === \"number\") {\r\n      return this.properties[index];\r\n    }\r\n    return undefined;\r\n  }\r\n\r\n  public findByNoCase(name: string): QueryPropertyMetaData | undefined {\r\n    const index = this._byNoCase.get(name.toLowerCase());\r\n    if (typeof index === \"number\") {\r\n      return this.properties[index];\r\n    }\r\n    return undefined;\r\n  }\r\n}\r\n\r\n/**\r\n * The format for rows returned by [[ECSqlReader]].\r\n * @public\r\n */\r\nexport type QueryValueType = any;\r\n\r\n/**\r\n * Methods and ways of accessing values from rows returned by [[ECSqlReader]].\r\n * @public\r\n */\r\nexport interface QueryRowProxy {\r\n  /**\r\n   * Get the current row as a JavaScript `object`.\r\n   *\r\n   * @returns The current row as a JavaScript `object`.\r\n   */\r\n  toRow(): any;\r\n\r\n  /**\r\n   * Get the current row's raw values as an array in SELECT-column order.\r\n   * To collect all remaining rows, use [[ECSqlReader.toArray]] instead.\r\n   *\r\n   * @returns The current row's values.\r\n   */\r\n  toArray(): QueryValueType[];\r\n\r\n  /**\r\n   * Get the metadata for each column in the query result.\r\n   *\r\n   * @returns The metadata for each column in the query result.\r\n   */\r\n  getMetaData(): QueryPropertyMetaData[];\r\n\r\n  /**\r\n   * Access a property using its name.\r\n   *\r\n   * @returns The value from the row whose key (ECSQL column name) is `propertyName`.\r\n   *\r\n   * @example\r\n   * The following lines will all return the same result:\r\n   * ```ts\r\n   * reader.current.ECInstanceId;\r\n   * reader.current.ecinstanceid;\r\n   * reader.current.[\"ECInstanceId\"];\r\n   * ```\r\n   */\r\n  [propertyName: string]: QueryValueType;\r\n\r\n  /**\r\n   * Access a property using its index.\r\n   * The index is relative to the order of the columns returned by the query that produced the row.\r\n   *\r\n   * @returns The value from the column at `propertyIndex`.\r\n   *\r\n   * @example reader.current[0]\r\n   */\r\n  [propertyIndex: number]: QueryValueType;\r\n}\r\n\r\n/**\r\n * Abstract base class providing shared row-proxy access, row formatting, and\r\n * Base64-to-Uint8Array conversion logic for both the asynchronous [[ECSqlReader]]\r\n * and the synchronous ECSqlSyncReader.\r\n *\r\n * Subclasses must implement [[getRowInternal]] to supply the current row data.\r\n * @public\r\n */\r\nexport abstract class ECSqlReaderBase {\r\n  /** @internal */\r\n  protected _done: boolean = false;\r\n  /** @internal */\r\n  protected _props = new PropertyMetaDataMap([]);\r\n  /** @internal */\r\n  protected _rowFormat: QueryRowFormat;\r\n\r\n  private _rowProxy = new Proxy<ECSqlReaderBase>(this, {\r\n    get: (target: ECSqlReaderBase, key: string | symbol) => {\r\n      if (typeof key === \"string\") {\r\n        const idx = Number.parseInt(key, 10);\r\n        if (!Number.isNaN(idx)) {\r\n          return target.getRowInternal()[idx];\r\n        }\r\n        const prop = target._props.findByNoCase(key);\r\n        if (prop) {\r\n          return target.getRowInternal()[prop.index];\r\n        }\r\n        if (key === \"getMetaData\") {\r\n          return () => target._props.properties;\r\n        }\r\n        if (key === \"toRow\") {\r\n          return () => target.formatCurrentRow(true);\r\n        }\r\n        if (key === \"toArray\") {\r\n          return () => target.getRowInternal();\r\n        }\r\n      }\r\n      return undefined;\r\n    },\r\n    has: (target: ECSqlReaderBase, p: string | symbol) => {\r\n      return !target._props.findByNoCase(p as string);\r\n    },\r\n    ownKeys: (target: ECSqlReaderBase) => {\r\n      const keys = [];\r\n      for (const prop of target._props) {\r\n        keys.push(prop.name);\r\n      }\r\n      return keys;\r\n    },\r\n  });\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  protected constructor(rowFormat?: QueryRowFormat) {\r\n    this._rowFormat = rowFormat ?? QueryRowFormat.UseECSqlPropertyIndexes;\r\n  }\r\n\r\n  /**\r\n   * Get the current row from the query result. The current row is the one most recently stepped-to\r\n   * (by step() or during iteration).\r\n   *\r\n   * Each value from the row can be accessed by index or by name.\r\n   *\r\n   * @see\r\n   * - [[QueryRowFormat]]\r\n   * - [ECSQL Row Formats]($docs/learning/ECSQLRowFormat)\r\n   *\r\n   * @note The current row is a [[QueryRowProxy]] object. To get the row as a basic JavaScript object, call\r\n   *       [[QueryRowProxy.toRow]] on it.\r\n   *\r\n   * @return The current row as a [[QueryRowProxy]].\r\n   */\r\n  public get current(): QueryRowProxy {\r\n    return this._rowProxy as any;\r\n  }\r\n\r\n  /**\r\n   * Returns if there are more rows available.\r\n   *\r\n   * @returns `true` if all rows have been stepped through already.<br/>\r\n   *          `false` if there are any yet unaccessed rows.\r\n   */\r\n  public get done(): boolean {\r\n    return this._done;\r\n  }\r\n\r\n  /**\r\n   * Returns the raw current row data array. Subclasses implement this to return\r\n   * from their specific storage mechanism.\r\n   * @internal\r\n   */\r\n  protected abstract getRowInternal(): any[];\r\n\r\n  /**\r\n   * Converts Base64-encoded strings in a row object into Uint8Arrays in-place.\r\n   * @internal\r\n   */\r\n  protected static replaceBase64WithUint8Array(row: any): void {\r\n    for (const key of Object.keys(row)) {\r\n      const val = row[key];\r\n      if (typeof val === \"string\") {\r\n        if (Base64EncodedString.hasPrefix(val)) {\r\n          row[key] = Base64EncodedString.toUint8Array(val);\r\n        }\r\n      } else if (typeof val === \"object\" && val !== null) {\r\n        this.replaceBase64WithUint8Array(val);\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Format the current row as a JavaScript object or array depending on the row format.\r\n   * @internal\r\n   */\r\n  protected formatCurrentRow(onlyReturnObject: boolean = false): any[] | object {\r\n    if (!onlyReturnObject && this._rowFormat === QueryRowFormat.UseECSqlPropertyIndexes) {\r\n      return this.getRowInternal();\r\n    }\r\n    const formattedRow = {};\r\n    for (const prop of this._props) {\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n      const propName = this._rowFormat === QueryRowFormat.UseJsPropertyNames ? prop.jsonName : prop.name;\r\n      const val = this.getRowInternal()[prop.index];\r\n      if (typeof val !== \"undefined\" && val !== null) {\r\n        Object.defineProperty(formattedRow, propName, {\r\n          value: val,\r\n          enumerable: true,\r\n        });\r\n      }\r\n    }\r\n    return formattedRow;\r\n  }\r\n}"]}
+{"version":3,"file":"ECSqlReaderBase.js","sourceRoot":"","sources":["../../src/ECSqlReaderBase.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAyB,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAE1E,cAAc;AACd,MAAM,OAAO,mBAAmB;IAKK;IAJ3B,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;IACxC,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;IACxC,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;IAE9C,YAAmC,UAAmC;QAAnC,eAAU,GAAV,UAAU,CAAyB;QACpE,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACvC,QAAQ,CAAC,UAAU,GAAG,QAAQ,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAG,uDAAuD;YACjJ,QAAQ,CAAC,YAAY,GAAG,QAAQ,CAAC,YAAY,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC;YACzF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;YACpD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;YACxD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAChC,CAAC;IAEM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC5C,CAAC;IAEM,UAAU,CAAC,IAAY;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,cAAc,CAAC,IAAY;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,YAAY,CAAC,IAAY;QAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QACrD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AA6DD;;;;;;;GAOG;AACH,MAAM,OAAgB,eAAe;IACnC,gBAAgB;IACN,KAAK,GAAY,KAAK,CAAC;IACjC,gBAAgB;IACN,MAAM,GAAG,IAAI,mBAAmB,CAAC,EAAE,CAAC,CAAC;IAC/C,gBAAgB;IACN,UAAU,CAAiB;IAE7B,SAAS,GAAG,IAAI,KAAK,CAAkB,IAAI,EAAE;QACnD,GAAG,EAAE,CAAC,MAAuB,EAAE,GAAoB,EAAE,EAAE;YACrD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;gBACrC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;oBACvB,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC;gBACtC,CAAC;gBACD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;gBAC7C,IAAI,IAAI,EAAE,CAAC;oBACT,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC7C,CAAC;gBACD,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;oBAC1B,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,mBAAmB,EAAE,CAAC;gBAC5C,CAAC;gBACD,IAAI,GAAG,KAAK,OAAO,EAAE,CAAC;oBACpB,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBAC7C,CAAC;gBACD,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;oBACtB,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;gBACvC,CAAC;YACH,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,GAAG,EAAE,CAAC,MAAuB,EAAE,CAAkB,EAAE,EAAE;YACnD,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAW,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,EAAE,CAAC,MAAuB,EAAE,EAAE;YACnC,MAAM,IAAI,GAAG,EAAE,CAAC;YAChB,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBACjC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACvB,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC,CAAC;IAEH;;OAEG;IACH,YAAsB,SAA0B;QAC9C,IAAI,CAAC,UAAU,GAAG,SAAS,IAAI,cAAc,CAAC,uBAAuB,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,SAAgB,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IASD,gBAAgB;IACN,mBAAmB;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;IAChC,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,2BAA2B,CAAC,GAAQ;QACnD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACnC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;YACrB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,IAAI,mBAAmB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;oBACvC,GAAG,CAAC,GAAG,CAAC,GAAG,mBAAmB,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;gBACnD,CAAC;YACH,CAAC;iBAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBACnD,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;YACxC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACO,gBAAgB,CAAC,mBAA4B,KAAK;QAC1D,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,UAAU,KAAK,cAAc,CAAC,uBAAuB,EAAE,CAAC;YACpF,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;QAC/B,CAAC;QACD,MAAM,YAAY,GAAG,EAAE,CAAC;QACxB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAC/B,4DAA4D;YAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,KAAK,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YACnG,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC9C,IAAI,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBAC/C,MAAM,CAAC,cAAc,CAAC,YAAY,EAAE,QAAQ,EAAE;oBAC5C,KAAK,EAAE,GAAG;oBACV,UAAU,EAAE,IAAI;iBACjB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\nimport { Base64EncodedString } from \"./Base64EncodedString\";\r\nimport { QueryPropertyMetaData, QueryRowFormat } from \"./ConcurrentQuery\";\r\n\r\n/** @public */\r\nexport class PropertyMetaDataMap implements Iterable<QueryPropertyMetaData> {\r\n  private _byPropName = new Map<string, number>();\r\n  private _byJsonName = new Map<string, number>();\r\n  private _byNoCase = new Map<string, number>();\r\n\r\n  public constructor(public readonly properties: QueryPropertyMetaData[]) {\r\n    for (const property of this.properties) {\r\n      property.extendType = property.extendedType !== undefined ? property.extendedType : \"\";   // eslint-disable-line @typescript-eslint/no-deprecated\r\n      property.extendedType = property.extendedType === \"\" ? undefined : property.extendedType;\r\n      this._byPropName.set(property.name, property.index);\r\n      this._byJsonName.set(property.jsonName, property.index);\r\n      this._byNoCase.set(property.name.toLowerCase(), property.index);\r\n      this._byNoCase.set(property.jsonName.toLowerCase(), property.index);\r\n    }\r\n  }\r\n\r\n  public get length(): number {\r\n    return this.properties.length;\r\n  }\r\n\r\n  public [Symbol.iterator](): Iterator<QueryPropertyMetaData, any, undefined> {\r\n    return this.properties[Symbol.iterator]();\r\n  }\r\n\r\n  public findByName(name: string): QueryPropertyMetaData | undefined {\r\n    const index = this._byPropName.get(name);\r\n    if (typeof index === \"number\") {\r\n      return this.properties[index];\r\n    }\r\n    return undefined;\r\n  }\r\n\r\n  public findByJsonName(name: string): QueryPropertyMetaData | undefined {\r\n    const index = this._byJsonName.get(name);\r\n    if (typeof index === \"number\") {\r\n      return this.properties[index];\r\n    }\r\n    return undefined;\r\n  }\r\n\r\n  public findByNoCase(name: string): QueryPropertyMetaData | undefined {\r\n    const index = this._byNoCase.get(name.toLowerCase());\r\n    if (typeof index === \"number\") {\r\n      return this.properties[index];\r\n    }\r\n    return undefined;\r\n  }\r\n}\r\n\r\n/**\r\n * The format for rows returned by [[ECSqlReader]].\r\n * @public\r\n */\r\nexport type QueryValueType = any;\r\n\r\n/**\r\n * Methods and ways of accessing values from rows returned by [[ECSqlReader]].\r\n * @public\r\n */\r\nexport interface QueryRowProxy {\r\n  /**\r\n   * Get the current row as a JavaScript `object`.\r\n   *\r\n   * @returns The current row as a JavaScript `object`.\r\n   */\r\n  toRow(): any;\r\n\r\n  /**\r\n   * Get the current row's raw values as an array in SELECT-column order.\r\n   * To collect all remaining rows, use [[ECSqlReader.toArray]] instead.\r\n   *\r\n   * @returns The current row's values.\r\n   */\r\n  toArray(): QueryValueType[];\r\n\r\n  /**\r\n   * Get the metadata for each column in the query result.\r\n   *\r\n   * @returns The metadata for each column in the query result.\r\n   */\r\n  getMetaData(): QueryPropertyMetaData[];\r\n\r\n  /**\r\n   * Access a property using its name.\r\n   *\r\n   * @returns The value from the row whose key (ECSQL column name) is `propertyName`.\r\n   *\r\n   * @example\r\n   * The following lines will all return the same result:\r\n   * ```ts\r\n   * reader.current.ECInstanceId;\r\n   * reader.current.ecinstanceid;\r\n   * reader.current.[\"ECInstanceId\"];\r\n   * ```\r\n   */\r\n  [propertyName: string]: QueryValueType;\r\n\r\n  /**\r\n   * Access a property using its index.\r\n   * The index is relative to the order of the columns returned by the query that produced the row.\r\n   *\r\n   * @returns The value from the column at `propertyIndex`.\r\n   *\r\n   * @example reader.current[0]\r\n   */\r\n  [propertyIndex: number]: QueryValueType;\r\n}\r\n\r\n/**\r\n * Abstract base class providing shared row-proxy access, row formatting, and\r\n * Base64-to-Uint8Array conversion logic for both the asynchronous [[ECSqlReader]]\r\n * and the synchronous ECSqlSyncReader.\r\n *\r\n * Subclasses must implement [[getRowInternal]] to supply the current row data.\r\n * @public\r\n */\r\nexport abstract class ECSqlReaderBase {\r\n  /** @internal */\r\n  protected _done: boolean = false;\r\n  /** @internal */\r\n  protected _props = new PropertyMetaDataMap([]);\r\n  /** @internal */\r\n  protected _rowFormat: QueryRowFormat;\r\n\r\n  private _rowProxy = new Proxy<ECSqlReaderBase>(this, {\r\n    get: (target: ECSqlReaderBase, key: string | symbol) => {\r\n      if (typeof key === \"string\") {\r\n        const idx = Number.parseInt(key, 10);\r\n        if (!Number.isNaN(idx)) {\r\n          return target.getRowInternal()[idx];\r\n        }\r\n        const prop = target._props.findByNoCase(key);\r\n        if (prop) {\r\n          return target.getRowInternal()[prop.index];\r\n        }\r\n        if (key === \"getMetaData\") {\r\n          return () => target.getMetaDataInternal();\r\n        }\r\n        if (key === \"toRow\") {\r\n          return () => target.formatCurrentRow(true);\r\n        }\r\n        if (key === \"toArray\") {\r\n          return () => target.getRowInternal();\r\n        }\r\n      }\r\n      return undefined;\r\n    },\r\n    has: (target: ECSqlReaderBase, p: string | symbol) => {\r\n      return !target._props.findByNoCase(p as string);\r\n    },\r\n    ownKeys: (target: ECSqlReaderBase) => {\r\n      const keys = [];\r\n      for (const prop of target._props) {\r\n        keys.push(prop.name);\r\n      }\r\n      return keys;\r\n    },\r\n  });\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  protected constructor(rowFormat?: QueryRowFormat) {\r\n    this._rowFormat = rowFormat ?? QueryRowFormat.UseECSqlPropertyIndexes;\r\n  }\r\n\r\n  /**\r\n   * Get the current row from the query result. The current row is the one most recently stepped-to\r\n   * (by step() or during iteration).\r\n   *\r\n   * Each value from the row can be accessed by index or by name.\r\n   *\r\n   * @see\r\n   * - [[QueryRowFormat]]\r\n   * - [ECSQL Row Formats]($docs/learning/ECSQLRowFormat)\r\n   *\r\n   * @note The current row is a [[QueryRowProxy]] object. To get the row as a basic JavaScript object, call\r\n   *       [[QueryRowProxy.toRow]] on it.\r\n   *\r\n   * @return The current row as a [[QueryRowProxy]].\r\n   */\r\n  public get current(): QueryRowProxy {\r\n    return this._rowProxy as any;\r\n  }\r\n\r\n  /**\r\n   * Returns if there are more rows available.\r\n   *\r\n   * @returns `true` if all rows have been stepped through already.<br/>\r\n   *          `false` if there are any yet unaccessed rows.\r\n   */\r\n  public get done(): boolean {\r\n    return this._done;\r\n  }\r\n\r\n  /**\r\n   * Returns the raw current row data array. Subclasses implement this to return\r\n   * from their specific storage mechanism.\r\n   * @internal\r\n   */\r\n  protected abstract getRowInternal(): any[];\r\n\r\n  /** @internal */\r\n  protected getMetaDataInternal(): QueryPropertyMetaData[] {\r\n    return this._props.properties;\r\n  }\r\n\r\n  /**\r\n   * Converts Base64-encoded strings in a row object into Uint8Arrays in-place.\r\n   * @internal\r\n   */\r\n  protected static replaceBase64WithUint8Array(row: any): void {\r\n    for (const key of Object.keys(row)) {\r\n      const val = row[key];\r\n      if (typeof val === \"string\") {\r\n        if (Base64EncodedString.hasPrefix(val)) {\r\n          row[key] = Base64EncodedString.toUint8Array(val);\r\n        }\r\n      } else if (typeof val === \"object\" && val !== null) {\r\n        this.replaceBase64WithUint8Array(val);\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Format the current row as a JavaScript object or array depending on the row format.\r\n   * @internal\r\n   */\r\n  protected formatCurrentRow(onlyReturnObject: boolean = false): any[] | object {\r\n    if (!onlyReturnObject && this._rowFormat === QueryRowFormat.UseECSqlPropertyIndexes) {\r\n      return this.getRowInternal();\r\n    }\r\n    const formattedRow = {};\r\n    for (const prop of this._props) {\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n      const propName = this._rowFormat === QueryRowFormat.UseJsPropertyNames ? prop.jsonName : prop.name;\r\n      const val = this.getRowInternal()[prop.index];\r\n      if (typeof val !== \"undefined\" && val !== null) {\r\n        Object.defineProperty(formattedRow, propName, {\r\n          value: val,\r\n          enumerable: true,\r\n        });\r\n      }\r\n    }\r\n    return formattedRow;\r\n  }\r\n}"]}

package/lib/esm/MapLayerSettings.d.ts

@@ -113,7 +113,9 @@ export interface ImageMapLayerProps extends CommonMapLayerProps {
     accessKey?: MapLayerKey;
     /** @internal */
     modelId?: never;
-    /** List of query parameters that will get appended to the source.
+    /** Non-secret query parameters appended to every request made for the layer, persisted with it.
+     * Secrets must never be placed here; the hosting application injects them per session through a fetch handler
+     * (see `MapLayerFormatRegistry.addMapLayerFetchHandler` in `@itwin/core-frontend`).
      * @beta
     */
     queryParams?: {
@@ -210,14 +212,28 @@ export declare class ImageMapLayerSettings extends MapLayerSettings {
     userName?: string;
     password?: string;
     accessKey?: MapLayerKey;
-    /** List of query parameters to append to the settings URL and persisted as part of the JSON representation.
-     * @note Sensitive information like user credentials should be provided in [[unsavedQueryParams]] to ensure it is never persisted.
+    /** Former name of [[queryParams]], which stores the value; retained as the backing field so existing subclasses
+     * and `delete` keep working.
+     * @deprecated in 5.16. Use [[queryParams]].
      * @beta
     */
     savedQueryParams?: {
         [key: string]: string;
     };
+    /** Non-secret query parameters appended to every request made for the layer, persisted as part of the JSON
+     * representation ([[ImageMapLayerProps.queryParams]]). Secrets must never be placed here; the hosting application
+     * injects them per session through a fetch handler (see `MapLayerFormatRegistry.addMapLayerFetchHandler` in
+     * `@itwin/core-frontend`), which also protects them against leaking through redirects.
+     * @beta
+    */
+    get queryParams(): {
+        [key: string]: string;
+    } | undefined;
+    set queryParams(value: {
+        [key: string]: string;
+    } | undefined);
     /** List of query parameters that will get appended to the settings URL that should *not* be be persisted part of the JSON representation.
+     * @deprecated in 5.16. Register a fetch handler (`MapLayerFormatRegistry.addMapLayerFetchHandler` in `@itwin/core-frontend`) to inject secret or per-session parameters, which unlike this field are protected against leaking through redirects; use [[queryParams]] for non-secret parameters.
      * @beta
     */
     unsavedQueryParams?: {
@@ -255,9 +271,10 @@ export declare class ImageMapLayerSettings extends MapLayerSettings {
     /** @internal */
     protected static mapTypeName(type: BackgroundMapType): "Aerial Imagery" | "Aerial Imagery with labels" | "Streets";
     setCredentials(userName?: string, password?: string): void;
-    /** Collect all query parameters
-   * @beta
-   */
+    /** The query parameters actually sent with requests: [[queryParams]] overlaid with the deprecated `unsavedQueryParams`
+     * (a key present in both takes the latter's value). Equals a copy of [[queryParams]] once `unsavedQueryParams` is removed.
+     * @beta
+     */
     collectQueryParams(): {
         [key: string]: string;
     };

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

@@ -1 +1 @@
-{"version":3,"file":"MapLayerSettings.d.ts","sourceRoot":"","sources":["../../src/MapLayerSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC/G,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AAEvE;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAI,QAAQ,GAAG,UAAU,GAAG,eAAe,GAAG,SAAS,GAAG,KAAK,GAAG,MAAM,CAAC;AAE5G,cAAc;AACd,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEzC;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC;AAE5E;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IAAG,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,6BAA6B,CAAA;CAAE;AAExH;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,EAAE,CAAC,EAAE,UAAU,CAAC;IAChB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,qBAAa,mBAAmB;IAC9B,mIAAmI;IACnI,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,aAAa;IACb,SAAgB,KAAK,CAAC,EAAE,MAAM,CAAC;IAC/B,gIAAgI;IAChI,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,oFAAoF;IACpF,SAAgB,EAAE,EAAE,UAAU,CAAC;IAC/B,oCAAoC;IACpC,SAAgB,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IACxC,uBAAuB;IACvB,SAAgB,MAAM,CAAC,EAAE,UAAU,CAAC;gBAExB,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,UAAU,EAAE;IAS1H,mGAAmG;WACrF,QAAQ,CAAC,IAAI,EAAE,gBAAgB,GAAG,mBAAmB;IAI5D,MAAM,IAAI,gBAAgB;IAkBjC,uFAAuF;IAChF,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,mBAAmB;IAe1E,gBAAgB;IACT,cAAc,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO;IAI1D,6CAA6C;IAC7C,IAAW,OAAO,IAAI,OAAO,CAAiC;IAE9D,+DAA+D;IAC/D,IAAW,MAAM,IAAI,OAAO,CAAsE;IAElG,uDAAuD;IACvD,IAAW,cAAc,IAAI,OAAO,CAA0C;IAE9E,sGAAsG;IACtG,IAAW,QAAQ,IAAI,MAAM,CAA2E;CACzG;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,wDAAwD;IACxD,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IAEH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,UAAU;IACV,GAAG,EAAE,MAAM,CAAC;IACZ,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,4DAA4D;IAC5D,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC/B;;OAEG;IACH,gBAAgB;IAChB,SAAS,CAAC,EAAE,WAAW,CAAC;IAExB,gBAAgB;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;IAEhB;;MAEE;IACF,WAAW,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAExC;;MAEE;IACF,UAAU,CAAC,EAAE,0BAA0B,CAAC;CAEzC;AAED;;GAEG;AACH,oBAAY,wBAAwB;IAClC,iCAAiC;IACjC,KAAK,IAAS;IACd,iDAAiD;IACjD,WAAW,IAAS;IACpB,oDAAoD;IACpD,MAAM,IAAS;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,iGAAiG;IACjG,OAAO,EAAE,UAAU,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,wBAAwB,CAAC;IACvC,gBAAgB;IAChB,GAAG,CAAC,EAAE,KAAK,CAAC;IACZ,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;IACjB,gBAAgB;IAChB,SAAS,CAAC,EAAE,KAAK,CAAC;IAClB,gBAAgB;IAChB,SAAS,CAAC,EAAE,KAAK,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,kBAAkB,GAAG,kBAAkB,CAAC;AAEpE;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,8BAAsB,gBAAgB;IACpC,SAAgB,OAAO,EAAE,OAAO,CAAC;IAEjC,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,YAAY,EAAE,MAAM,CAAC;IACrC,SAAgB,qBAAqB,EAAE,OAAO,CAAC;IAC/C,aAAoB,qBAAqB,IAAI,OAAO,CAAC;aACrC,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,gBAAgB;aAC7D,MAAM,IAAI,aAAa;IAEvC,gBAAgB;IAChB,SAAS,aAAa,IAAI,EAAE,MAAM,EAAE,OAAO,UAAO,EAAE,YAAY,GAAE,MAAU,EAAE,qBAAqB,UAAO;IAO1G,gEAAgE;WAClD,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB;IAI9D,gBAAgB;IAChB,SAAS,CAAC,OAAO,IAAI,mBAAmB;IAexC,gBAAgB;IAChB,SAAS,CAAC,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,mBAAmB;IAS/E,gBAAgB;IACT,cAAc,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO;IAIvD,kHAAkH;IAClH,aAAoB,MAAM,IAAI,MAAM,CAAC;IAErC,gBAAgB;IACT,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;CAGnE;AAED;;;;;;GAMG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,SAAgB,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,WAAW,CAAC;IAE/B;;;MAGE;IACK,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpD;;MAEE;IACK,kBAAkB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEtD;;MAEE;IACF,SAAgB,UAAU,CAAC,EAAE,0BAA0B,CAAC;IAExD,SAAgB,SAAS,EAAE,mBAAmB,EAAE,CAAC;IACjD,IAAoB,MAAM,IAAI,MAAM,CAAqB;IAEzD,gBAAgB;IAChB,SAAS,aAAa,KAAK,EAAE,kBAAkB;WA0BxB,QAAQ,CAAC,KAAK,EAAE,kBAAkB,GAAG,qBAAqB;IAIjF,iEAAiE;IACjD,MAAM,IAAI,kBAAkB;IAkB5C;;;OAGG;IACI,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,qBAAqB;IAc9E,gBAAgB;cACG,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,kBAAkB;IAqB5F,gBAAgB;IACA,cAAc,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO;IAehE,iEAAiE;IAC1D,YAAY,CAAC,EAAE,CAAC,EAAE,UAAU,GAAG,mBAAmB,GAAG,SAAS;IAIrE,OAAO,CAAC,qBAAqB;IAa7B,4FAA4F;IACrF,iBAAiB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,OAAO;IAOhE,kDAAkD;IAClD,IAAW,qBAAqB,IAAI,OAAO,CAK1C;IAED,yCAAyC;IAClC,mBAAmB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,mBAAmB,EAAE,GAAG,SAAS;IAc5F,gBAAgB;IAChB,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,iBAAiB;IAY7C,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;IAK1D;;KAEC;IACM,kBAAkB;;;CAU1B;AAED;;;;;;GAMG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,SAAgB,WAAW,EAAE,wBAAwB,CAAC;IACtD,SAAgB,OAAO,EAAE,UAAU,CAAC;IACpC,IAAoB,MAAM,IAAI,MAAM,CAAyB;IAE7D,gBAAgB;IAChB,SAAS,aAAa,OAAO,EAAE,UAAU,EAAG,IAAI,EAAE,MAAM,EAAE,OAAO,UAAO,EACtE,YAAY,GAAE,MAAU,EAAE,qBAAqB,UAAO,EAAE,WAAW,2BAAiC;IAMtG,mGAAmG;WAC5E,QAAQ,CAAC,IAAI,EAAE,kBAAkB,GAAG,qBAAqB;IAKhF,iEAAiE;IACjD,MAAM,IAAI,kBAAkB;IAQ5C;;;OAGG;IACI,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,qBAAqB;IAI9E,gBAAgB;cACG,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,kBAAkB;IAO5F,gBAAgB;IACA,cAAc,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO;IAOhE,0GAA0G;IAC1G,IAAW,qBAAqB,IAAI,OAAO,CAE1C;CACF;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IAC3D,QAAQ,CAAC,EAAE,0BAA0B,CAAC;CACvC;AAED;;;;;;;GAOG;AACH,qBAAa,oBAAqB,SAAQ,qBAAqB;IAC7D,OAAO,CAAC,SAAS,CAAC,CAAwB;IAE1C,sEAAsE;IACtE,IAAW,QAAQ,IAAI,qBAAqB,GAAG,SAAS,CAA2B;IAEnF;;;;OAIG;WACoB,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,oBAAoB;IAS/E,qDAAqD;IACrC,MAAM,IAAI,iBAAiB;IAQ3C,gBAAgB;IACA,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,iBAAiB;IAWvF,mCAAmC;IACnB,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,oBAAoB;IAUrF,wDAAwD;WAC1C,YAAY,CAAC,QAAQ,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,oBAAoB;IA2D3I,gBAAgB;WACF,sBAAsB,CAAC,KAAK,EAAE,4BAA4B,GAAG,oBAAoB;IAI/F,aAAa;IACN,iBAAiB,CAAC,QAAQ,EAAE,qBAAqB,GAAG,oBAAoB;CAGhF"}
+{"version":3,"file":"MapLayerSettings.d.ts","sourceRoot":"","sources":["../../src/MapLayerSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC/G,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AAEvE;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAI,QAAQ,GAAG,UAAU,GAAG,eAAe,GAAG,SAAS,GAAG,KAAK,GAAG,MAAM,CAAC;AAE5G,cAAc;AACd,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEzC;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC;AAE5E;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IAAG,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,6BAA6B,CAAA;CAAE;AAExH;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,EAAE,CAAC,EAAE,UAAU,CAAC;IAChB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,qBAAa,mBAAmB;IAC9B,mIAAmI;IACnI,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,aAAa;IACb,SAAgB,KAAK,CAAC,EAAE,MAAM,CAAC;IAC/B,gIAAgI;IAChI,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,oFAAoF;IACpF,SAAgB,EAAE,EAAE,UAAU,CAAC;IAC/B,oCAAoC;IACpC,SAAgB,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IACxC,uBAAuB;IACvB,SAAgB,MAAM,CAAC,EAAE,UAAU,CAAC;gBAExB,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,UAAU,EAAE;IAS1H,mGAAmG;WACrF,QAAQ,CAAC,IAAI,EAAE,gBAAgB,GAAG,mBAAmB;IAI5D,MAAM,IAAI,gBAAgB;IAkBjC,uFAAuF;IAChF,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,mBAAmB;IAe1E,gBAAgB;IACT,cAAc,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO;IAI1D,6CAA6C;IAC7C,IAAW,OAAO,IAAI,OAAO,CAAiC;IAE9D,+DAA+D;IAC/D,IAAW,MAAM,IAAI,OAAO,CAAsE;IAElG,uDAAuD;IACvD,IAAW,cAAc,IAAI,OAAO,CAA0C;IAE9E,sGAAsG;IACtG,IAAW,QAAQ,IAAI,MAAM,CAA2E;CACzG;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,wDAAwD;IACxD,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IAEH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,UAAU;IACV,GAAG,EAAE,MAAM,CAAC;IACZ,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,4DAA4D;IAC5D,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC/B;;OAEG;IACH,gBAAgB;IAChB,SAAS,CAAC,EAAE,WAAW,CAAC;IAExB,gBAAgB;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;IAEhB;;;;MAIE;IACF,WAAW,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAExC;;MAEE;IACF,UAAU,CAAC,EAAE,0BAA0B,CAAC;CAEzC;AAED;;GAEG;AACH,oBAAY,wBAAwB;IAClC,iCAAiC;IACjC,KAAK,IAAS;IACd,iDAAiD;IACjD,WAAW,IAAS;IACpB,oDAAoD;IACpD,MAAM,IAAS;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,iGAAiG;IACjG,OAAO,EAAE,UAAU,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,wBAAwB,CAAC;IACvC,gBAAgB;IAChB,GAAG,CAAC,EAAE,KAAK,CAAC;IACZ,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;IACjB,gBAAgB;IAChB,SAAS,CAAC,EAAE,KAAK,CAAC;IAClB,gBAAgB;IAChB,SAAS,CAAC,EAAE,KAAK,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,kBAAkB,GAAG,kBAAkB,CAAC;AAEpE;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,8BAAsB,gBAAgB;IACpC,SAAgB,OAAO,EAAE,OAAO,CAAC;IAEjC,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,YAAY,EAAE,MAAM,CAAC;IACrC,SAAgB,qBAAqB,EAAE,OAAO,CAAC;IAC/C,aAAoB,qBAAqB,IAAI,OAAO,CAAC;aACrC,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,gBAAgB;aAC7D,MAAM,IAAI,aAAa;IAEvC,gBAAgB;IAChB,SAAS,aAAa,IAAI,EAAE,MAAM,EAAE,OAAO,UAAO,EAAE,YAAY,GAAE,MAAU,EAAE,qBAAqB,UAAO;IAO1G,gEAAgE;WAClD,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB;IAI9D,gBAAgB;IAChB,SAAS,CAAC,OAAO,IAAI,mBAAmB;IAexC,gBAAgB;IAChB,SAAS,CAAC,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,mBAAmB;IAS/E,gBAAgB;IACT,cAAc,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO;IAIvD,kHAAkH;IAClH,aAAoB,MAAM,IAAI,MAAM,CAAC;IAErC,gBAAgB;IACT,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;CAGnE;AAED;;;;;;GAMG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,SAAgB,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,WAAW,CAAC;IAE/B;;;;MAIE;IACK,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpD;;;;;MAKE;IAEF,IAAW,WAAW,IAAI;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,SAAS,CAAkC;IAEjG,IAAW,WAAW,CAAC,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,SAAS,EAAoC;IAEvG;;;MAGE;IACK,kBAAkB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEtD;;MAEE;IACF,SAAgB,UAAU,CAAC,EAAE,0BAA0B,CAAC;IAExD,SAAgB,SAAS,EAAE,mBAAmB,EAAE,CAAC;IACjD,IAAoB,MAAM,IAAI,MAAM,CAAqB;IAEzD,gBAAgB;IAChB,SAAS,aAAa,KAAK,EAAE,kBAAkB;WA0BxB,QAAQ,CAAC,KAAK,EAAE,kBAAkB,GAAG,qBAAqB;IAIjF,iEAAiE;IACjD,MAAM,IAAI,kBAAkB;IAkB5C;;;OAGG;IACI,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,qBAAqB;IAc9E,gBAAgB;cACG,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,kBAAkB;IAqB5F,gBAAgB;IACA,cAAc,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO;IAehE,iEAAiE;IAC1D,YAAY,CAAC,EAAE,CAAC,EAAE,UAAU,GAAG,mBAAmB,GAAG,SAAS;IAIrE,OAAO,CAAC,qBAAqB;IAa7B,4FAA4F;IACrF,iBAAiB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,OAAO;IAOhE,kDAAkD;IAClD,IAAW,qBAAqB,IAAI,OAAO,CAK1C;IAED,yCAAyC;IAClC,mBAAmB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,mBAAmB,EAAE,GAAG,SAAS;IAc5F,gBAAgB;IAChB,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,iBAAiB;IAY7C,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;IAK1D;;;OAGG;IACI,kBAAkB;;;CAY1B;AAED;;;;;;GAMG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,SAAgB,WAAW,EAAE,wBAAwB,CAAC;IACtD,SAAgB,OAAO,EAAE,UAAU,CAAC;IACpC,IAAoB,MAAM,IAAI,MAAM,CAAyB;IAE7D,gBAAgB;IAChB,SAAS,aAAa,OAAO,EAAE,UAAU,EAAG,IAAI,EAAE,MAAM,EAAE,OAAO,UAAO,EACtE,YAAY,GAAE,MAAU,EAAE,qBAAqB,UAAO,EAAE,WAAW,2BAAiC;IAMtG,mGAAmG;WAC5E,QAAQ,CAAC,IAAI,EAAE,kBAAkB,GAAG,qBAAqB;IAKhF,iEAAiE;IACjD,MAAM,IAAI,kBAAkB;IAQ5C;;;OAGG;IACI,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,qBAAqB;IAI9E,gBAAgB;cACG,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,kBAAkB;IAO5F,gBAAgB;IACA,cAAc,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO;IAOhE,0GAA0G;IAC1G,IAAW,qBAAqB,IAAI,OAAO,CAE1C;CACF;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IAC3D,QAAQ,CAAC,EAAE,0BAA0B,CAAC;CACvC;AAED;;;;;;;GAOG;AACH,qBAAa,oBAAqB,SAAQ,qBAAqB;IAC7D,OAAO,CAAC,SAAS,CAAC,CAAwB;IAE1C,sEAAsE;IACtE,IAAW,QAAQ,IAAI,qBAAqB,GAAG,SAAS,CAA2B;IAEnF;;;;OAIG;WACoB,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,oBAAoB;IAS/E,qDAAqD;IACrC,MAAM,IAAI,iBAAiB;IAQ3C,gBAAgB;IACA,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,iBAAiB;IAWvF,mCAAmC;IACnB,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,oBAAoB;IAUrF,wDAAwD;WAC1C,YAAY,CAAC,QAAQ,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,oBAAoB;IA2D3I,gBAAgB;WACF,sBAAsB,CAAC,KAAK,EAAE,4BAA4B,GAAG,oBAAoB;IAI/F,aAAa;IACN,iBAAiB,CAAC,QAAQ,EAAE,qBAAqB,GAAG,oBAAoB;CAGhF"}

package/lib/esm/MapLayerSettings.js

@@ -157,12 +157,24 @@ export class ImageMapLayerSettings extends MapLayerSettings {
     userName;
     password;
     accessKey;
-    /** List of query parameters to append to the settings URL and persisted as part of the JSON representation.
-     * @note Sensitive information like user credentials should be provided in [[unsavedQueryParams]] to ensure it is never persisted.
+    /** Former name of [[queryParams]], which stores the value; retained as the backing field so existing subclasses
+     * and `delete` keep working.
+     * @deprecated in 5.16. Use [[queryParams]].
      * @beta
     */
     savedQueryParams;
+    /** Non-secret query parameters appended to every request made for the layer, persisted as part of the JSON
+     * representation ([[ImageMapLayerProps.queryParams]]). Secrets must never be placed here; the hosting application
+     * injects them per session through a fetch handler (see `MapLayerFormatRegistry.addMapLayerFetchHandler` in
+     * `@itwin/core-frontend`), which also protects them against leaking through redirects.
+     * @beta
+    */
+    // eslint-disable-next-line @typescript-eslint/no-deprecated -- the deprecated field is the storage until its removal.
+    get queryParams() { return this.savedQueryParams; }
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    set queryParams(value) { this.savedQueryParams = value; }
     /** List of query parameters that will get appended to the settings URL that should *not* be be persisted part of the JSON representation.
+     * @deprecated in 5.16. Register a fetch handler (`MapLayerFormatRegistry.addMapLayerFetchHandler` in `@itwin/core-frontend`) to inject secret or per-session parameters, which unlike this field are protected against leaking through redirects; use [[queryParams]] for non-secret parameters.
      * @beta
     */
     unsavedQueryParams;
@@ -180,7 +192,7 @@ export class ImageMapLayerSettings extends MapLayerSettings {
         this.url = props.url;
         this.accessKey = props.accessKey;
         if (props.queryParams) {
-            this.savedQueryParams = { ...props.queryParams };
+            this.queryParams = { ...props.queryParams };
         }
         if (props.properties) {
             this.properties = { ...props.properties };
@@ -204,8 +216,8 @@ export class ImageMapLayerSettings extends MapLayerSettings {
         props.formatId = this.formatId;
         if (this.subLayers.length > 0)
             props.subLayers = this.subLayers.map((x) => x.toJSON());
-        if (this.savedQueryParams)
-            props.queryParams = { ...this.savedQueryParams };
+        if (this.queryParams)
+            props.queryParams = { ...this.queryParams };
         if (this.properties) {
             props.properties = structuredClone(this.properties);
         }
@@ -220,10 +232,10 @@ export class ImageMapLayerSettings extends MapLayerSettings {
         // Clone members not part of MapLayerProps
         clone.userName = this.userName;
         clone.password = this.password;
+        // eslint-disable-next-line @typescript-eslint/no-deprecated -- kept for backward compatibility until removal.
         if (this.unsavedQueryParams)
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
             clone.unsavedQueryParams = { ...this.unsavedQueryParams };
-        if (this.savedQueryParams)
-            clone.savedQueryParams = { ...this.savedQueryParams };
         return clone;
     }
     /** @internal */
@@ -236,8 +248,8 @@ export class ImageMapLayerSettings extends MapLayerSettings {
         if (changedProps.queryParams) {
             props.queryParams = { ...changedProps.queryParams };
         }
-        else if (this.savedQueryParams) {
-            props.queryParams = { ...this.savedQueryParams };
+        else if (this.queryParams) {
+            props.queryParams = { ...this.queryParams };
         }
         if (changedProps.properties) {
             props.properties = { ...changedProps.properties };
@@ -313,14 +325,17 @@ export class ImageMapLayerSettings extends MapLayerSettings {
         this.userName = userName;
         this.password = password;
     }
-    /** Collect all query parameters
-   * @beta
-   */
+    /** The query parameters actually sent with requests: [[queryParams]] overlaid with the deprecated `unsavedQueryParams`
+     * (a key present in both takes the latter's value). Equals a copy of [[queryParams]] once `unsavedQueryParams` is removed.
+     * @beta
+     */
     collectQueryParams() {
         let queryParams = {};
-        if (this.savedQueryParams)
-            queryParams = { ...this.savedQueryParams };
+        if (this.queryParams)
+            queryParams = { ...this.queryParams };
+        // eslint-disable-next-line @typescript-eslint/no-deprecated -- kept for backward compatibility until removal.
         if (this.unsavedQueryParams)
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
             queryParams = { ...queryParams, ...this.unsavedQueryParams };
         return queryParams;
     }