@itwin/core-common 3.0.0-dev.98 → 3.0.0

package/lib/esm/ECSqlReader.js

@@ -6,7 +6,7 @@
  * @module iModels
  */
 import { Base64EncodedString } from "./Base64EncodedString";
-import { DbQueryError, DbRequestKind, DbResponseStatus, QueryBinder, QueryOptionsBuilder, QueryRowFormat, } from "./ConcurrentQuery";
+import { DbQueryError, DbRequestKind, DbResponseStatus, DbValueFormat, QueryBinder, QueryOptionsBuilder, QueryRowFormat, } from "./ConcurrentQuery";
 /** @beta */
 export class PropertyMetaDataMap {
     constructor(properties) {
@@ -62,6 +62,7 @@ export class ECSqlReader {
         this._props = new PropertyMetaDataMap([]);
         this._param = new QueryBinder().serialize();
         this._lockArgs = false;
+        this._stats = { backendCpuTime: 0, backendTotalTime: 0, backendMemUsed: 0, backendRowsReturned: 0, totalTime: 0, retryCount: 0 };
         this._rowProxy = new Proxy(this, {
             get: (target, key) => {
                 if (typeof key === "string") {
@@ -77,10 +78,7 @@ export class ECSqlReader {
                         return () => target._props.properties;
                     }
                     if (key === "toRow") {
-                        return () => target.formatCurrentRow(QueryRowFormat.UseECSqlPropertyNames);
-                    }
-                    if (key === "toJsRow") {
-                        return () => target.formatCurrentRow(QueryRowFormat.UseJsPropertyNames);
+                        return () => target.formatCurrentRow(true);
                     }
                     if (key === "getArray" || key === "toJSON") {
                         return () => this.getRowInternal();
@@ -136,6 +134,8 @@ export class ECSqlReader {
         this._globalDone = false;
         this._globalOffset = 0;
         this._globalCount = -1;
+        if (typeof this._options.rowFormat === "undefined")
+            this._options.rowFormat = QueryRowFormat.UseECSqlPropertyIndexes;
         if (this._options.limit) {
             if (typeof this._options.limit.offset === "number" && this._options.limit.offset > 0)
                 this._globalOffset = this._options.limit.offset;
@@ -145,16 +145,20 @@ export class ECSqlReader {
         this._done = false;
     }
     get current() { return this._rowProxy; }
+    // clear all bindings
     resetBindings() {
         this._param = new QueryBinder().serialize();
         this._lockArgs = false;
     }
+    // return if there is any more rows available
     get done() { return this._done; }
     getRowInternal() {
         if (this._localRows.length <= this._localOffset)
             throw new Error("no current row");
         return this._localRows[this._localOffset];
     }
+    // return performance related statistics for current query.
+    get stats() { return this._stats; }
     async readRows() {
         if (this._globalDone) {
             return [];
@@ -165,11 +169,13 @@ export class ECSqlReader {
         if (this._globalCount === 0) {
             return [];
         }
+        const valueFormat = this._options.rowFormat === QueryRowFormat.UseJsPropertyNames ? DbValueFormat.JsNames : DbValueFormat.ECSqlNames;
         const request = {
+            ...this._options,
             kind: DbRequestKind.ECSql,
+            valueFormat,
             query: this.query,
             args: this._param,
-            ...this._options,
         };
         request.includeMetaData = this._props.length > 0 ? false : true;
         request.limit = { offset: this._globalOffset, count: this._globalCount < 1 ? -1 : this._globalCount };
@@ -184,25 +190,42 @@ export class ECSqlReader {
         return resp.data;
     }
     async runWithRetry(request) {
-        let resp = await this._executor.execute(request);
-        let retry = 10;
+        const needRetry = (rs) => (rs.status === DbResponseStatus.Partial || rs.status === DbResponseStatus.QueueFull || rs.status === DbResponseStatus.Timeout) && (rs.data.length === 0);
+        const updateStats = (rs) => {
+            this._stats.backendCpuTime += rs.stats.cpuTime;
+            this._stats.backendTotalTime += rs.stats.totalTime;
+            this._stats.backendMemUsed += rs.stats.memUsed;
+            this._stats.backendRowsReturned += rs.data.length;
+        };
+        const execQuery = async (req) => {
+            const startTime = Date.now();
+            const rs = await this._executor.execute(req);
+            this.stats.totalTime += (Date.now() - startTime);
+            return rs;
+        };
+        let retry = ECSqlReader._maxRetryCount;
+        let resp = await execQuery(request);
         DbQueryError.throwIfError(resp, request);
-        while (--retry > 0 && resp.data.length === 0 && (resp.status === DbResponseStatus.Partial || resp.status === DbResponseStatus.QueueFull || resp.status === DbResponseStatus.TimeOut)) {
-            // add timeout
-            resp = await this._executor.execute(request);
+        while (--retry > 0 && needRetry(resp)) {
+            resp = await execQuery(request);
+            this._stats.retryCount += 1;
+            if (needRetry(resp)) {
+                updateStats(resp);
+            }
         }
-        if (retry === 0 && resp.data.length === 0 && (resp.status === DbResponseStatus.Partial || resp.status === DbResponseStatus.QueueFull || resp.status === DbResponseStatus.TimeOut)) {
+        if (retry === 0 && needRetry(resp)) {
             throw new Error("query too long to execute or server is too busy");
         }
+        updateStats(resp);
         return resp;
     }
-    formatCurrentRow(format) {
-        if (format === QueryRowFormat.UseArrayIndexes) {
+    formatCurrentRow(onlyReturnObject = false) {
+        if (!onlyReturnObject && this._options.rowFormat === QueryRowFormat.UseECSqlPropertyIndexes) {
             return this.getRowInternal();
         }
         const formattedRow = {};
         for (const prop of this._props) {
-            const propName = format === QueryRowFormat.UseJsPropertyNames ? prop.jsonName : prop.name;
+            const propName = this._options.rowFormat === QueryRowFormat.UseJsPropertyNames ? prop.jsonName : prop.name;
             const val = this.getRowInternal()[prop.index];
             if (typeof val !== "undefined" && val !== null) {
                 Object.defineProperty(formattedRow, propName, {
@@ -213,7 +236,19 @@ export class ECSqlReader {
         }
         return formattedRow;
     }
-    getMetaData() { return this._props.properties; }
+    async getMetaData() {
+        if (this._props.length === 0) {
+            await this.fetchRows();
+        }
+        return this._props.properties;
+    }
+    async fetchRows() {
+        this._localOffset = -1;
+        this._localRows = await this.readRows();
+        if (this._localRows.length === 0) {
+            this._done = true;
+        }
+    }
     async step() {
         if (this._done) {
             return false;
@@ -223,21 +258,19 @@ export class ECSqlReader {
             ++this._localOffset;
         }
         else {
-            this._localRows = await this.readRows();
+            await this.fetchRows();
             this._localOffset = 0;
-            if (this._localRows.length === 0) {
-                this._done = true;
-                return false;
-            }
+            return !this._done;
         }
         return true;
     }
-    async toArray(format) {
+    async toArray() {
         const rows = [];
         while (await this.step()) {
-            rows.push(this.formatCurrentRow(format));
+            rows.push(this.formatCurrentRow());
         }
         return rows;
     }
 }
+ECSqlReader._maxRetryCount = 10;
 //# sourceMappingURL=ECSqlReader.js.map

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,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EACL,YAAY,EAAsD,aAAa,EAAE,gBAAgB,EAAE,WAAW,EAAgB,mBAAmB,EAC1H,cAAc,GACtC,MAAM,mBAAmB,CAAC;AAE3B,YAAY;AACZ,MAAM,OAAO,mBAAmB;IAI9B,YAAmC,UAAmC;QAAnC,eAAU,GAAV,UAAU,CAAyB;QAH9D,gBAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;QACxC,gBAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;QACxC,cAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;QAE5C,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE;YACtC,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;SACrE;IACH,CAAC;IACD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IAEvD,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC5C,CAAC;IACM,UAAU,CAAC,IAAY;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SAC/B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACM,cAAc,CAAC,IAAY;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SAC/B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACM,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;YAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SAC/B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAeD,YAAY;AACZ,MAAM,OAAO,WAAW;IAgDtB,gBAAgB;IAChB,YAA2B,SAA6D,EAAkB,KAAa,EAAE,KAAmB,EAAE,OAAsB;QAAzI,cAAS,GAAT,SAAS,CAAoD;QAAkB,UAAK,GAAL,KAAK,CAAQ;QAhD/G,eAAU,GAAU,EAAE,CAAC;QACvB,iBAAY,GAAW,CAAC,CAAC;QACzB,kBAAa,GAAW,CAAC,CAAC,CAAC;QAC3B,iBAAY,GAAW,CAAC,CAAC,CAAC;QAC1B,UAAK,GAAY,KAAK,CAAC;QACvB,gBAAW,GAAY,KAAK,CAAC;QAC7B,WAAM,GAAG,IAAI,mBAAmB,CAAC,EAAE,CAAC,CAAC;QACrC,WAAM,GAAG,IAAI,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;QACvC,cAAS,GAAY,KAAK,CAAC;QAC3B,cAAS,GAAG,IAAI,KAAK,CAAc,IAAI,EAAE;YAC/C,GAAG,EAAE,CAAC,MAAmB,EAAE,GAAoB,EAAE,EAAE;gBACjD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;oBAC3B,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;oBACrC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;wBACtB,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC;qBACrC;oBACD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;oBAC7C,IAAI,IAAI,EAAE;wBACR,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;qBAC5C;oBACD,IAAI,GAAG,KAAK,aAAa,EAAE;wBACzB,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC;qBACvC;oBACD,IAAI,GAAG,KAAK,OAAO,EAAE;wBACnB,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,cAAc,CAAC,qBAAqB,CAAC,CAAC;qBAC5E;oBACD,IAAI,GAAG,KAAK,SAAS,EAAE;wBACrB,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;qBACzE;oBACD,IAAI,GAAG,KAAK,UAAU,IAAI,GAAG,KAAK,QAAQ,EAAE;wBAC1C,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;qBACpC;iBACF;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,GAAG,EAAE,CAAC,MAAmB,EAAE,CAAkB,EAAE,EAAE;gBAC/C,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAW,CAAC,CAAC;YAClD,CAAC;YACD,OAAO,EAAE,CAAC,MAAmB,EAAE,EAAE;gBAC/B,MAAM,IAAI,GAAG,EAAE,CAAC;gBAChB,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,EAAE;oBAChC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACtB;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;SACF,CAAC,CAAC;QACK,aAAQ,GAAiB,IAAI,mBAAmB,EAAE,CAAC,UAAU,EAAE,CAAC;QAGtE,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;SACxD;QACD,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;SACjC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC;IACO,MAAM,CAAC,2BAA2B,CAAC,GAAQ;QACjD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YAClC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;YACrB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;gBAC3B,IAAI,mBAAmB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE;oBACtC,GAAG,CAAC,GAAG,CAAC,GAAG,mBAAmB,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;iBAClD;aACF;iBAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE;gBAClD,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;aACvC;SACF;IACH,CAAC;IACM,SAAS,CAAC,KAAkB;QACjC,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;SAC/E;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;IAClC,CAAC;IACM,KAAK,CAAC,OAAsB;QACjC,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;SACzB;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,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE;YACvB,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;SACjD;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IACD,IAAW,OAAO,KAAoB,OAAQ,IAAI,CAAC,SAAiB,CAAC,CAAC,CAAC;IAChE,aAAa;QAClB,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC;IACD,IAAW,IAAI,KAAc,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1C,cAAc;QACnB,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;IACO,KAAK,CAAC,QAAQ;QACpB,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,EAAE,CAAC;SACX;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;YAC3B,OAAO,EAAE,CAAC;SACX;QACD,MAAM,OAAO,GAAmB;YAC9B,IAAI,EAAE,aAAa,CAAC,KAAK;YACzB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI,EAAE,IAAI,CAAC,MAAM;YACjB,GAAI,IAAI,CAAC,QAAQ;SAClB,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,CAAC;QACzD,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACpD,IAAI,CAAC,MAAM,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAClD;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE;YAC3B,WAAW,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;SAC9C;QACD,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IACO,KAAK,CAAC,YAAY,CAAC,OAAuB;QAChD,IAAI,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,YAAY,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACzC,OAAO,EAAE,KAAK,GAAG,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,gBAAgB,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,KAAK,gBAAgB,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,gBAAgB,CAAC,OAAO,CAAC,EAAE;YACpL,cAAc;YACd,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SAC9C;QACD,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,gBAAgB,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,KAAK,gBAAgB,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,gBAAgB,CAAC,OAAO,CAAC,EAAE;YACjL,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACpE;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,gBAAgB,CAAC,MAAsB;QAC5C,IAAI,MAAM,KAAK,cAAc,CAAC,eAAe,EAAE;YAC7C,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;SAC9B;QACD,MAAM,YAAY,GAAG,EAAE,CAAC;QACxB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE;YAC9B,MAAM,QAAQ,GAAG,MAAM,KAAK,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YAC1F,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC9C,IAAI,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI,EAAE;gBAC9C,MAAM,CAAC,cAAc,CAAC,YAAY,EAAE,QAAQ,EAAE;oBAC5C,KAAK,EAAE,GAAG;oBACV,UAAU,EAAE,IAAI;iBACjB,CAAC,CAAC;aACJ;SACF;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IACM,WAAW,KAA8B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IACzE,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,OAAO,KAAK,CAAC;SACd;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC1C,IAAI,IAAI,CAAC,YAAY,GAAG,UAAU,GAAG,CAAC,EAAE;YACtC,EAAE,IAAI,CAAC,YAAY,CAAC;SACrB;aAAM;YACL,IAAI,CAAC,UAAU,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;YACxC,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;YACtB,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;gBAChC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;gBAClB,OAAO,KAAK,CAAC;aACd;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,KAAK,CAAC,OAAO,CAAC,MAAsB;QACzC,MAAM,IAAI,GAAG,EAAE,CAAC;QAChB,OAAO,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE;YACxB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;SAC1C;QACD,OAAO,IAAI,CAAC;IACd,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 {\r\n  DbQueryError, DbQueryRequest, DbQueryResponse, DbRequestExecutor, DbRequestKind, DbResponseStatus, QueryBinder, QueryOptions, QueryOptionsBuilder,\r\n  QueryPropertyMetaData, QueryRowFormat,\r\n} from \"./ConcurrentQuery\";\r\n\r\n/** @beta */\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  public constructor(public readonly properties: QueryPropertyMetaData[]) {\r\n    for (const property of this.properties) {\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  public get length(): number { return this.properties.length; }\r\n\r\n  public [Symbol.iterator](): Iterator<QueryPropertyMetaData, any, undefined> {\r\n    return this.properties[Symbol.iterator]();\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  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  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 * @beta\r\n*/\r\nexport type QueryValueType = any;\r\n\r\n/** @beta */\r\nexport interface QueryRowProxy {\r\n  toJsRow(): any;\r\n  toRow(): any;\r\n  toArray(): QueryValueType[];\r\n  getMetaData(): QueryPropertyMetaData[];\r\n  [propertyName: string]: QueryValueType;\r\n  [propertyIndex: number]: QueryValueType;\r\n}\r\n/** @beta */\r\nexport class ECSqlReader {\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 _done: boolean = false;\r\n  private _globalDone: boolean = false;\r\n  private _props = new PropertyMetaDataMap([]);\r\n  private _param = new QueryBinder().serialize();\r\n  private _lockArgs: boolean = false;\r\n  private _rowProxy = new Proxy<ECSqlReader>(this, {\r\n    get: (target: ECSqlReader, 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(QueryRowFormat.UseECSqlPropertyNames);\r\n        }\r\n        if (key === \"toJsRow\") {\r\n          return () => target.formatCurrentRow(QueryRowFormat.UseJsPropertyNames);\r\n        }\r\n        if (key === \"getArray\" || key === \"toJSON\") {\r\n          return () => this.getRowInternal();\r\n        }\r\n      }\r\n      return undefined;\r\n    },\r\n    has: (target: ECSqlReader, p: string | symbol) => {\r\n      return !target._props.findByNoCase(p as string);\r\n    },\r\n    ownKeys: (target: ECSqlReader) => {\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  private _options: QueryOptions = new QueryOptionsBuilder().getOptions();\r\n  /** @internal */\r\n  public constructor(private _executor: DbRequestExecutor<DbQueryRequest, DbQueryResponse>, public readonly query: string, param?: QueryBinder, options?: QueryOptions) {\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    this.reset(options);\r\n  }\r\n  private static replaceBase64WithUint8Array(row: any) {\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  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  public reset(options?: QueryOptions) {\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 (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  public get current(): QueryRowProxy { return (this._rowProxy as any); }\r\n  public resetBindings() {\r\n    this._param = new QueryBinder().serialize();\r\n    this._lockArgs = false;\r\n  }\r\n  public get done(): boolean { return this._done; }\r\n  public 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  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    const request: DbQueryRequest = {\r\n      kind: DbRequestKind.ECSql,\r\n      query: this.query,\r\n      args: this._param,\r\n      ... this._options,\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;\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  private async runWithRetry(request: DbQueryRequest) {\r\n    let resp = await this._executor.execute(request);\r\n    let retry = 10;\r\n    DbQueryError.throwIfError(resp, request);\r\n    while (--retry > 0 && resp.data.length === 0 && (resp.status === DbResponseStatus.Partial || resp.status === DbResponseStatus.QueueFull || resp.status === DbResponseStatus.TimeOut)) {\r\n      // add timeout\r\n      resp = await this._executor.execute(request);\r\n    }\r\n    if (retry === 0 && resp.data.length === 0 && (resp.status === DbResponseStatus.Partial || resp.status === DbResponseStatus.QueueFull || resp.status === DbResponseStatus.TimeOut)) {\r\n      throw new Error(\"query too long to execute or server is too busy\");\r\n    }\r\n    return resp;\r\n  }\r\n  public formatCurrentRow(format: QueryRowFormat): any[] | object {\r\n    if (format === QueryRowFormat.UseArrayIndexes) {\r\n      return this.getRowInternal();\r\n    }\r\n    const formattedRow = {};\r\n    for (const prop of this._props) {\r\n      const propName = format === 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  public getMetaData(): QueryPropertyMetaData[] { return this._props.properties; }\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      this._localRows = await this.readRows();\r\n      this._localOffset = 0;\r\n      if (this._localRows.length === 0) {\r\n        this._done = true;\r\n        return false;\r\n      }\r\n    }\r\n    return true;\r\n  }\r\n  public async toArray(format: QueryRowFormat): Promise<any[]> {\r\n    const rows = [];\r\n    while (await this.step()) {\r\n      rows.push(this.formatCurrentRow(format));\r\n    }\r\n    return rows;\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,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EACL,YAAY,EAAsD,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,WAAW,EAAgB,mBAAmB,EACzI,cAAc,GACtC,MAAM,mBAAmB,CAAC;AAE3B,YAAY;AACZ,MAAM,OAAO,mBAAmB;IAI9B,YAAmC,UAAmC;QAAnC,eAAU,GAAV,UAAU,CAAyB;QAH9D,gBAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;QACxC,gBAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;QACxC,cAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;QAE5C,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE;YACtC,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;SACrE;IACH,CAAC;IACD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IAEvD,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC5C,CAAC;IACM,UAAU,CAAC,IAAY;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SAC/B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACM,cAAc,CAAC,IAAY;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SAC/B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACM,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;YAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SAC/B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAyBD,YAAY;AACZ,MAAM,OAAO,WAAW;IA+CtB,gBAAgB;IAChB,YAA2B,SAA6D,EAAkB,KAAa,EAAE,KAAmB,EAAE,OAAsB;QAAzI,cAAS,GAAT,SAAS,CAAoD;QAAkB,UAAK,GAAL,KAAK,CAAQ;QA9C/G,eAAU,GAAU,EAAE,CAAC;QACvB,iBAAY,GAAW,CAAC,CAAC;QACzB,kBAAa,GAAW,CAAC,CAAC,CAAC;QAC3B,iBAAY,GAAW,CAAC,CAAC,CAAC;QAC1B,UAAK,GAAY,KAAK,CAAC;QACvB,gBAAW,GAAY,KAAK,CAAC;QAC7B,WAAM,GAAG,IAAI,mBAAmB,CAAC,EAAE,CAAC,CAAC;QACrC,WAAM,GAAG,IAAI,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;QACvC,cAAS,GAAY,KAAK,CAAC;QAC3B,WAAM,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,CAAC;QAC5H,cAAS,GAAG,IAAI,KAAK,CAAc,IAAI,EAAE;YAC/C,GAAG,EAAE,CAAC,MAAmB,EAAE,GAAoB,EAAE,EAAE;gBACjD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;oBAC3B,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;oBACrC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;wBACtB,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC;qBACrC;oBACD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;oBAC7C,IAAI,IAAI,EAAE;wBACR,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;qBAC5C;oBACD,IAAI,GAAG,KAAK,aAAa,EAAE;wBACzB,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC;qBACvC;oBACD,IAAI,GAAG,KAAK,OAAO,EAAE;wBACnB,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;qBAC5C;oBACD,IAAI,GAAG,KAAK,UAAU,IAAI,GAAG,KAAK,QAAQ,EAAE;wBAC1C,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;qBACpC;iBACF;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,GAAG,EAAE,CAAC,MAAmB,EAAE,CAAkB,EAAE,EAAE;gBAC/C,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAW,CAAC,CAAC;YAClD,CAAC;YACD,OAAO,EAAE,CAAC,MAAmB,EAAE,EAAE;gBAC/B,MAAM,IAAI,GAAG,EAAE,CAAC;gBAChB,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,EAAE;oBAChC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACtB;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;SACF,CAAC,CAAC;QACK,aAAQ,GAAiB,IAAI,mBAAmB,EAAE,CAAC,UAAU,EAAE,CAAC;QAGtE,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;SACxD;QACD,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;SACjC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC;IACO,MAAM,CAAC,2BAA2B,CAAC,GAAQ;QACjD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YAClC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;YACrB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;gBAC3B,IAAI,mBAAmB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE;oBACtC,GAAG,CAAC,GAAG,CAAC,GAAG,mBAAmB,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;iBAClD;aACF;iBAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE;gBAClD,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;aACvC;SACF;IACH,CAAC;IACM,SAAS,CAAC,KAAkB;QACjC,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;SAC/E;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;IAClC,CAAC;IACM,KAAK,CAAC,OAAsB;QACjC,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;SACzB;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,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE;YACvB,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;SACjD;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IACD,IAAW,OAAO,KAAoB,OAAQ,IAAI,CAAC,SAAiB,CAAC,CAAC,CAAC;IACvE,qBAAqB;IACd,aAAa;QAClB,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC;IACD,6CAA6C;IAC7C,IAAW,IAAI,KAAc,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1C,cAAc;QACnB,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;IACD,2DAA2D;IAC3D,IAAW,KAAK,KAAiB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9C,KAAK,CAAC,QAAQ;QACpB,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,EAAE,CAAC;SACX;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;YAC3B,OAAO,EAAE,CAAC;SACX;QACD,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,cAAc,CAAC,kBAAkB,CAAA,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA,aAAa,CAAC,UAAU,CAAC;QACnI,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;SAClB,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,CAAC;QACzD,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACpD,IAAI,CAAC,MAAM,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAClD;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE;YAC3B,WAAW,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;SAC9C;QACD,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IACO,KAAK,CAAC,YAAY,CAAC,OAAuB;QAChD,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,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;QACpM,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,mBAAmB,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;QACpD,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;YACrC,IAAI,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC;YAC5B,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE;gBACnB,WAAW,CAAC,IAAI,CAAC,CAAC;aACnB;SACF;QACD,IAAI,KAAK,KAAK,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACpE;QACD,WAAW,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IACM,gBAAgB,CAAC,mBAA4B,KAAK;QACvD,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,cAAc,CAAC,uBAAuB,EAAE;YAC3F,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;SAC9B;QACD,MAAM,YAAY,GAAG,EAAE,CAAC;QACxB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE;YAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YAC3G,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC9C,IAAI,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI,EAAE;gBAC9C,MAAM,CAAC,cAAc,CAAC,YAAY,EAAE,QAAQ,EAAE;oBAC5C,KAAK,EAAE,GAAG;oBACV,UAAU,EAAE,IAAI;iBACjB,CAAC,CAAC;aACJ;SACF;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IACM,KAAK,CAAC,WAAW;QACtB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;YAC5B,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;SACxB;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;IAChC,CAAC;IACO,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;YAChC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;SACnB;IACH,CAAC;IACM,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,OAAO,KAAK,CAAC;SACd;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC1C,IAAI,IAAI,CAAC,YAAY,GAAG,UAAU,GAAG,CAAC,EAAE;YACtC,EAAE,IAAI,CAAC,YAAY,CAAC;SACrB;aAAM;YACL,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YACvB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;YACtB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;SACpB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,KAAK,CAAC,OAAO;QAClB,MAAM,IAAI,GAAG,EAAE,CAAC;QAChB,OAAO,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE;YACxB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;;AA1NuB,0BAAc,GAAG,EAAE,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 { Base64EncodedString } from \"./Base64EncodedString\";\r\nimport {\r\n  DbQueryError, DbQueryRequest, DbQueryResponse, DbRequestExecutor, DbRequestKind, DbResponseStatus, DbValueFormat, QueryBinder, QueryOptions, QueryOptionsBuilder,\r\n  QueryPropertyMetaData, QueryRowFormat,\r\n} from \"./ConcurrentQuery\";\r\n\r\n/** @beta */\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  public constructor(public readonly properties: QueryPropertyMetaData[]) {\r\n    for (const property of this.properties) {\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  public get length(): number { return this.properties.length; }\r\n\r\n  public [Symbol.iterator](): Iterator<QueryPropertyMetaData, any, undefined> {\r\n    return this.properties[Symbol.iterator]();\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  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  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 * @beta\r\n*/\r\nexport type QueryValueType = any;\r\n\r\n/** @beta */\r\nexport interface QueryRowProxy {\r\n  toRow(): any;\r\n  toArray(): QueryValueType[];\r\n  getMetaData(): QueryPropertyMetaData[];\r\n  [propertyName: string]: QueryValueType;\r\n  [propertyIndex: number]: QueryValueType;\r\n}\r\n\r\n/** @beta */\r\nexport interface QueryStats {\r\n  backendCpuTime: number; // Time spent running the query. It exclude query time in queue. Time is in microseconds.\r\n  backendTotalTime: number; // backend total time spent running the query. Time is in milliseconds.\r\n  backendMemUsed: number; // Estimated m emory used for query. Time is in milliseconds.\r\n  backendRowsReturned: number; // Total rows returned by backend.\r\n  totalTime: number; // Round trip time from client perspective.Time is in milliseconds.\r\n  retryCount: number;\r\n}\r\n\r\n/** @beta */\r\nexport class ECSqlReader {\r\n  private static readonly _maxRetryCount = 10;\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 _done: boolean = false;\r\n  private _globalDone: boolean = false;\r\n  private _props = new PropertyMetaDataMap([]);\r\n  private _param = new QueryBinder().serialize();\r\n  private _lockArgs: boolean = false;\r\n  private _stats = { backendCpuTime: 0, backendTotalTime: 0, backendMemUsed: 0, backendRowsReturned: 0, totalTime: 0, retryCount: 0 };\r\n  private _rowProxy = new Proxy<ECSqlReader>(this, {\r\n    get: (target: ECSqlReader, 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 === \"getArray\" || key === \"toJSON\") {\r\n          return () => this.getRowInternal();\r\n        }\r\n      }\r\n      return undefined;\r\n    },\r\n    has: (target: ECSqlReader, p: string | symbol) => {\r\n      return !target._props.findByNoCase(p as string);\r\n    },\r\n    ownKeys: (target: ECSqlReader) => {\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  private _options: QueryOptions = new QueryOptionsBuilder().getOptions();\r\n  /** @internal */\r\n  public constructor(private _executor: DbRequestExecutor<DbQueryRequest, DbQueryResponse>, public readonly query: string, param?: QueryBinder, options?: QueryOptions) {\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    this.reset(options);\r\n  }\r\n  private static replaceBase64WithUint8Array(row: any) {\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  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  public reset(options?: QueryOptions) {\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    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  public get current(): QueryRowProxy { return (this._rowProxy as any); }\r\n  // clear all bindings\r\n  public resetBindings() {\r\n    this._param = new QueryBinder().serialize();\r\n    this._lockArgs = false;\r\n  }\r\n  // return if there is any more rows available\r\n  public get done(): boolean { return this._done; }\r\n  public 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  // return performance related statistics for current query.\r\n  public get stats(): QueryStats { return this._stats; }\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    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    };\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;\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  private async runWithRetry(request: DbQueryRequest) {\r\n    const needRetry = (rs: DbQueryResponse) => (rs.status === DbResponseStatus.Partial || rs.status === DbResponseStatus.QueueFull || rs.status === DbResponseStatus.Timeout) && (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.backendRowsReturned += 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  public formatCurrentRow(onlyReturnObject: boolean = false): any[] | object {\r\n    if (!onlyReturnObject && this._options.rowFormat === QueryRowFormat.UseECSqlPropertyIndexes) {\r\n      return this.getRowInternal();\r\n    }\r\n    const formattedRow = {};\r\n    for (const prop of this._props) {\r\n      const propName = this._options.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  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  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  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  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"]}

package/lib/esm/ECSqlTypes.d.ts

@@ -94,12 +94,12 @@ export declare enum ECSqlSystemProperty {
     PointY = 9,
     PointZ = 10
 }
-/** Utility to format ECProperty names according to the iModel.js formatting rules.
+/** Utility to format ECProperty names according to the iTwin.js formatting rules.
  * See also [ECSQL Row Format]($docs/learning/ECSQLRowFormat).
  * @public
  */
 export declare class ECJsNames {
-    /** Formats the specified ECProperty name according to the iModel.js formatting rules.
+    /** Formats the specified ECProperty name according to the iTwin.js formatting rules.
      *
      *  See [ECSQL Row Format]($docs/learning/ECSQLRowFormat) which describes the formatting rules.
      *
@@ -112,7 +112,7 @@ export declare class ECJsNames {
      */
     static toJsName(propName: string, isSystemProperty?: boolean): string;
     /** Returns the name of the specified ECSQL system property according to the
-     *  iModel.js formatting rules.
+     *  iTwin.js formatting rules.
      *
      *  See [ECSQL Row Format]($docs/learning/ECSQLRowFormat) which describes the formatting rules.
      * @param systemPropertyType System property type

package/lib/esm/ECSqlTypes.js

@@ -77,12 +77,12 @@ export var ECSqlSystemProperty;
     ECSqlSystemProperty[ECSqlSystemProperty["PointY"] = 9] = "PointY";
     ECSqlSystemProperty[ECSqlSystemProperty["PointZ"] = 10] = "PointZ";
 })(ECSqlSystemProperty || (ECSqlSystemProperty = {}));
-/** Utility to format ECProperty names according to the iModel.js formatting rules.
+/** Utility to format ECProperty names according to the iTwin.js formatting rules.
  * See also [ECSQL Row Format]($docs/learning/ECSQLRowFormat).
  * @public
  */
 export class ECJsNames {
-    /** Formats the specified ECProperty name according to the iModel.js formatting rules.
+    /** Formats the specified ECProperty name according to the iTwin.js formatting rules.
      *
      *  See [ECSQL Row Format]($docs/learning/ECSQLRowFormat) which describes the formatting rules.
      *
@@ -145,7 +145,7 @@ export class ECJsNames {
         return jsName;
     }
     /** Returns the name of the specified ECSQL system property according to the
-     *  iModel.js formatting rules.
+     *  iTwin.js formatting rules.
      *
      *  See [ECSQL Row Format]($docs/learning/ECSQLRowFormat) which describes the formatting rules.
      * @param systemPropertyType System property type

package/lib/esm/ECSqlTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"ECSqlTypes.js","sourceRoot":"","sources":["../../src/ECSqlTypes.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAc,MAAM,qBAAqB,CAAC;AAEzD;;;GAGG;AACH,MAAM,CAAN,IAAY,cAkBX;AAlBD,WAAY,cAAc;IACxB,qFAAqF;IACrF,mDAAQ,CAAA;IACR,yDAAW,CAAA;IACX,2DAAY,CAAA;IACZ,uDAAU,CAAA;IACV,2DAAY,CAAA;IACZ,+CAAM,CAAA;IACN,iDAAO,CAAA;IACP,qDAAS,CAAA;IACT,yDAAW,CAAA;IACX,0DAAY,CAAA;IACZ,wDAAW,CAAA;IACX,gEAAe,CAAA;IACf,wDAAW,CAAA;IACX,wEAAmB,CAAA;IACnB,kEAAgB,CAAA;IAChB,oDAAS,CAAA;AACX,CAAC,EAlBW,cAAc,KAAd,cAAc,QAkBzB;AA8BD;;;;;;;GAOG;AACH,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,mDAAU,CAAA;IACV,mDAAU,CAAA;IACV,mDAAU,CAAA;AACZ,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AAED;;;;;;;GAOG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,uEAAe,CAAA;IACf,yEAAgB,CAAA;IAChB,uEAAe,CAAA;IACf,yEAAgB,CAAA;AAClB,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,mBAYX;AAZD,WAAY,mBAAmB;IAC7B,6EAAY,CAAA;IACZ,uEAAS,CAAA;IACT,yFAAkB,CAAA;IAClB,mFAAe,CAAA;IACf,yFAAkB,CAAA;IAClB,mFAAe,CAAA;IACf,6EAAY,CAAA;IACZ,6FAAoB,CAAA;IACpB,iEAAM,CAAA;IACN,iEAAM,CAAA;IACN,kEAAM,CAAA;AACR,CAAC,EAZW,mBAAmB,KAAnB,mBAAmB,QAY9B;AAED;;;GAGG;AACH,MAAM,OAAO,SAAS;IAEpB;;;;;;;;;;OAUG;IACI,MAAM,CAAC,QAAQ,CAAC,QAAgB,EAAE,gBAA0B;QACjE,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,gCAAgC,CAAC,CAAC;QAEjE,MAAM,eAAe,GAAY,gBAAgB,KAAK,SAAS,IAAI,gBAAgB,KAAK,IAAI,CAAC;QAE7F,MAAM,kBAAkB,GAAa,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACzD,MAAM,UAAU,GAAW,kBAAkB,CAAC,MAAM,CAAC;QACrD,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QAEvB,IAAI,UAAU,KAAK,CAAC,EAAE;YACpB,IAAI,eAAe,IAAI,gBAAiB,EAAE;gBACxC,IAAI,QAAQ,KAAK,cAAc;oBAC7B,OAAO,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;gBAE5E,IAAI,QAAQ,KAAK,WAAW;oBAC1B,OAAO,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;gBAEzE,IAAI,QAAQ,KAAK,oBAAoB;oBACnC,OAAO,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;gBAElF,IAAI,QAAQ,KAAK,oBAAoB;oBACnC,OAAO,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;gBAElF,IAAI,QAAQ,KAAK,iBAAiB;oBAChC,OAAO,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;gBAE/E,IAAI,QAAQ,KAAK,iBAAiB;oBAChC,OAAO,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;gBAE/E,OAAO,SAAS,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;aAC3C;YAED,OAAO,SAAS,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;SAC3C;QAED,2EAA2E;QAC3E,kDAAkD;QAClD,IAAI,MAAM,GAAW,SAAS,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAC3E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YACvC,MAAM,IAAI,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,CAAC;SACvC;QAED,MAAM,SAAS,GAAW,kBAAkB,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QAE7D,IAAI,eAAe,IAAI,gBAAiB,EAAE;YACxC,IAAI,SAAS,KAAK,IAAI;gBACpB,MAAM,IAAI,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;iBAC1E,IAAI,SAAS,KAAK,cAAc;gBACnC,MAAM,IAAI,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;iBAClF,IAAI,SAAS,KAAK,GAAG;gBACxB,MAAM,IAAI,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;iBACpE,IAAI,SAAS,KAAK,GAAG;gBACxB,MAAM,IAAI,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;iBACpE,IAAI,SAAS,KAAK,GAAG;gBACxB,MAAM,IAAI,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;iBACpE,IAAI,eAAe;gBACtB,MAAM,IAAI,SAAS,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;;gBAE9C,MAAM,IAAI,KAAK,CAAC,YAAY,SAAS,qBAAqB,QAAQ,+BAA+B,CAAC,CAAC;SACtG;;YACC,MAAM,IAAI,SAAS,CAAC;QAEtB,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,sBAAsB,CAAC,kBAAuC;QAC1E,QAAQ,kBAAkB,EAAE;YAC1B,KAAK,mBAAmB,CAAC,YAAY,CAAC;YACtC,KAAK,mBAAmB,CAAC,YAAY;gBACnC,OAAO,IAAI,CAAC;YACd,KAAK,mBAAmB,CAAC,SAAS;gBAChC,OAAO,WAAW,CAAC;YACrB,KAAK,mBAAmB,CAAC,kBAAkB;gBACzC,OAAO,UAAU,CAAC;YACpB,KAAK,mBAAmB,CAAC,eAAe;gBACtC,OAAO,iBAAiB,CAAC;YAC3B,KAAK,mBAAmB,CAAC,kBAAkB;gBACzC,OAAO,UAAU,CAAC;YACpB,KAAK,mBAAmB,CAAC,eAAe;gBACtC,OAAO,iBAAiB,CAAC;YAC3B,KAAK,mBAAmB,CAAC,oBAAoB;gBAC3C,OAAO,cAAc,CAAC;YACxB,KAAK,mBAAmB,CAAC,MAAM;gBAC7B,OAAO,GAAG,CAAC;YACb,KAAK,mBAAmB,CAAC,MAAM;gBAC7B,OAAO,GAAG,CAAC;YACb,KAAK,mBAAmB,CAAC,MAAM;gBAC7B,OAAO,GAAG,CAAC;YACb;gBACE,MAAM,IAAI,KAAK,CAAC,0CAA0C,kBAAkB,GAAG,CAAC,CAAC;SACpF;IACH,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,IAAY,IAAY,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC1G","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 ECSQL\r\n */\r\n\r\nimport { assert, Id64String } from \"@itwin/core-bentley\";\r\n\r\n/** Describes the different data types an ECSQL value can be of.\r\n * See also [ECSQL]($docs/learning/ECSQL).\r\n * @public\r\n */\r\nexport enum ECSqlValueType {\r\n  // do not change the values of the enum as it must match its counterpart in the addon\r\n  Blob = 1,\r\n  Boolean = 2,\r\n  DateTime = 3,\r\n  Double = 4,\r\n  Geometry = 5,\r\n  Id = 6,\r\n  Int = 7,\r\n  Int64 = 8,\r\n  Point2d = 9,\r\n  Point3d = 10,\r\n  String = 11,\r\n  Navigation = 12,\r\n  Struct = 13,\r\n  PrimitiveArray = 14,\r\n  StructArray = 15,\r\n  Guid = 16,\r\n}\r\n\r\n/** An ECSQL Navigation value.\r\n * It is returned from ECSQL SELECT statements for navigation properties.\r\n * See also [ECSQL]($docs/learning/ECSQL).\r\n * @public\r\n */\r\nexport interface NavigationValue {\r\n  /** ECInstanceId of the related instance */\r\n  id: Id64String;\r\n  /** Fully qualified class name of the relationship backing the Navigation property */\r\n  relClassName?: string;\r\n}\r\n\r\n/** An ECSQL Navigation value which can be bound to a navigation property ECSQL parameter\r\n * See also [ECSQL]($docs/learning/ECSQL).\r\n * @public\r\n */\r\nexport interface NavigationBindingValue {\r\n  /** ECInstanceId of the related instance */\r\n  id: Id64String;\r\n  /** Fully qualified class name of the relationship backing the Navigation property */\r\n  relClassName?: string;\r\n  /** Table space where the relationship's schema is persisted. This is only required\r\n   * if other ECDb files are attached to the primary one. In case a schema exists in more than one of the files,\r\n   * pass the table space to disambiguate.\r\n   */\r\n  relClassTableSpace?: string;\r\n}\r\n\r\n/** Equivalent of the ECEnumeration OpCode in the **ECDbChange** ECSchema.\r\n * The enum can be used when programmatically binding values to the InstanceChange.OpCode property of\r\n * the ECDbChange ECSchema.\r\n *\r\n * See also\r\n * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)\r\n * @public\r\n */\r\nexport enum ChangeOpCode {\r\n  Insert = 1,\r\n  Update = 2,\r\n  Delete = 4,\r\n}\r\n\r\n/** The enum represents the values for the ChangedValueState argument of the ECSQL function **Changes**.\r\n * The enum can be used when programmatically binding values to the ChangedValueState argument\r\n * in an ECSQL using the **Changes** ECSQL function.\r\n *\r\n * See also\r\n * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)\r\n * @public\r\n */\r\nexport enum ChangedValueState {\r\n  AfterInsert = 1,\r\n  BeforeUpdate = 2,\r\n  AfterUpdate = 3,\r\n  BeforeDelete = 4,\r\n}\r\n\r\n/** Defines the ECSQL system properties.\r\n * See also [ECSQL]($docs/learning/ECSQL).\r\n * @public\r\n */\r\nexport enum ECSqlSystemProperty {\r\n  ECInstanceId,\r\n  ECClassId,\r\n  SourceECInstanceId,\r\n  SourceECClassId,\r\n  TargetECInstanceId,\r\n  TargetECClassId,\r\n  NavigationId,\r\n  NavigationRelClassId,\r\n  PointX,\r\n  PointY,\r\n  PointZ,\r\n}\r\n\r\n/** Utility to format ECProperty names according to the iModel.js formatting rules.\r\n * See also [ECSQL Row Format]($docs/learning/ECSQLRowFormat).\r\n * @public\r\n */\r\nexport class ECJsNames {\r\n\r\n  /** Formats the specified ECProperty name according to the iModel.js formatting rules.\r\n   *\r\n   *  See [ECSQL Row Format]($docs/learning/ECSQLRowFormat) which describes the formatting rules.\r\n   *\r\n   * @param ecProperty Property name as defined in the ECSchema for regular ECProperties\r\n   *        or the name of an ECSQL system properties\r\n   * @param isSystemProperty if omitted, the method will try to find out whether the given property\r\n   *        is a system property or not. If true is specified, the method will throw if the property name\r\n   *        is not a known system property. If false is specified, the method will not attempt to recognize\r\n   *        the property name as system property.\r\n   */\r\n  public static toJsName(propName: string, isSystemProperty?: boolean) {\r\n    assert(propName !== undefined, \"propName must not be undefined\");\r\n\r\n    const propTypeUnknown: boolean = isSystemProperty === undefined || isSystemProperty === null;\r\n\r\n    const accessStringTokens: string[] = propName.split(\".\");\r\n    const tokenCount: number = accessStringTokens.length;\r\n    assert(tokenCount > 0);\r\n\r\n    if (tokenCount === 1) {\r\n      if (propTypeUnknown || isSystemProperty!) {\r\n        if (propName === \"ECInstanceId\")\r\n          return ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.ECInstanceId);\r\n\r\n        if (propName === \"ECClassId\")\r\n          return ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.ECClassId);\r\n\r\n        if (propName === \"SourceECInstanceId\")\r\n          return ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.SourceECInstanceId);\r\n\r\n        if (propName === \"TargetECInstanceId\")\r\n          return ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.TargetECInstanceId);\r\n\r\n        if (propName === \"SourceECClassId\")\r\n          return ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.SourceECClassId);\r\n\r\n        if (propName === \"TargetECClassId\")\r\n          return ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.TargetECClassId);\r\n\r\n        return ECJsNames.lowerFirstChar(propName);\r\n      }\r\n\r\n      return ECJsNames.lowerFirstChar(propName);\r\n    }\r\n\r\n    // parse access string and convert the leaf tokens if they are system props\r\n    // The first char of the access string is lowered.\r\n    let jsName: string = ECJsNames.lowerFirstChar(`${accessStringTokens[0]}.`);\r\n    for (let j = 1; j < tokenCount - 1; j++) {\r\n      jsName += `${accessStringTokens[j]}.`;\r\n    }\r\n\r\n    const leafToken: string = accessStringTokens[tokenCount - 1];\r\n\r\n    if (propTypeUnknown || isSystemProperty!) {\r\n      if (leafToken === \"Id\")\r\n        jsName += ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.NavigationId);\r\n      else if (leafToken === \"RelECClassId\")\r\n        jsName += ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.NavigationRelClassId);\r\n      else if (leafToken === \"X\")\r\n        jsName += ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.PointX);\r\n      else if (leafToken === \"Y\")\r\n        jsName += ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.PointY);\r\n      else if (leafToken === \"Z\")\r\n        jsName += ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.PointZ);\r\n      else if (propTypeUnknown)\r\n        jsName += ECJsNames.lowerFirstChar(leafToken);\r\n      else\r\n        throw new Error(`Property ${leafToken} of access string ${propName} is no ECSQL system property.`);\r\n    } else\r\n      jsName += leafToken;\r\n\r\n    return jsName;\r\n  }\r\n\r\n  /** Returns the name of the specified ECSQL system property according to the\r\n   *  iModel.js formatting rules.\r\n   *\r\n   *  See [ECSQL Row Format]($docs/learning/ECSQLRowFormat) which describes the formatting rules.\r\n   * @param systemPropertyType System property type\r\n   */\r\n  public static systemPropertyToJsName(systemPropertyType: ECSqlSystemProperty): string {\r\n    switch (systemPropertyType) {\r\n      case ECSqlSystemProperty.ECInstanceId:\r\n      case ECSqlSystemProperty.NavigationId:\r\n        return \"id\";\r\n      case ECSqlSystemProperty.ECClassId:\r\n        return \"className\";\r\n      case ECSqlSystemProperty.SourceECInstanceId:\r\n        return \"sourceId\";\r\n      case ECSqlSystemProperty.SourceECClassId:\r\n        return \"sourceClassName\";\r\n      case ECSqlSystemProperty.TargetECInstanceId:\r\n        return \"targetId\";\r\n      case ECSqlSystemProperty.TargetECClassId:\r\n        return \"targetClassName\";\r\n      case ECSqlSystemProperty.NavigationRelClassId:\r\n        return \"relClassName\";\r\n      case ECSqlSystemProperty.PointX:\r\n        return \"x\";\r\n      case ECSqlSystemProperty.PointY:\r\n        return \"y\";\r\n      case ECSqlSystemProperty.PointZ:\r\n        return \"z\";\r\n      default:\r\n        throw new Error(`Unknown ECSqlSystemProperty enum value ${systemPropertyType}.`);\r\n    }\r\n  }\r\n\r\n  private static lowerFirstChar(name: string): string { return name[0].toLowerCase() + name.substring(1); }\r\n}\r\n"]}
+{"version":3,"file":"ECSqlTypes.js","sourceRoot":"","sources":["../../src/ECSqlTypes.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAc,MAAM,qBAAqB,CAAC;AAEzD;;;GAGG;AACH,MAAM,CAAN,IAAY,cAkBX;AAlBD,WAAY,cAAc;IACxB,qFAAqF;IACrF,mDAAQ,CAAA;IACR,yDAAW,CAAA;IACX,2DAAY,CAAA;IACZ,uDAAU,CAAA;IACV,2DAAY,CAAA;IACZ,+CAAM,CAAA;IACN,iDAAO,CAAA;IACP,qDAAS,CAAA;IACT,yDAAW,CAAA;IACX,0DAAY,CAAA;IACZ,wDAAW,CAAA;IACX,gEAAe,CAAA;IACf,wDAAW,CAAA;IACX,wEAAmB,CAAA;IACnB,kEAAgB,CAAA;IAChB,oDAAS,CAAA;AACX,CAAC,EAlBW,cAAc,KAAd,cAAc,QAkBzB;AA8BD;;;;;;;GAOG;AACH,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,mDAAU,CAAA;IACV,mDAAU,CAAA;IACV,mDAAU,CAAA;AACZ,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AAED;;;;;;;GAOG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,uEAAe,CAAA;IACf,yEAAgB,CAAA;IAChB,uEAAe,CAAA;IACf,yEAAgB,CAAA;AAClB,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,mBAYX;AAZD,WAAY,mBAAmB;IAC7B,6EAAY,CAAA;IACZ,uEAAS,CAAA;IACT,yFAAkB,CAAA;IAClB,mFAAe,CAAA;IACf,yFAAkB,CAAA;IAClB,mFAAe,CAAA;IACf,6EAAY,CAAA;IACZ,6FAAoB,CAAA;IACpB,iEAAM,CAAA;IACN,iEAAM,CAAA;IACN,kEAAM,CAAA;AACR,CAAC,EAZW,mBAAmB,KAAnB,mBAAmB,QAY9B;AAED;;;GAGG;AACH,MAAM,OAAO,SAAS;IAEpB;;;;;;;;;;OAUG;IACI,MAAM,CAAC,QAAQ,CAAC,QAAgB,EAAE,gBAA0B;QACjE,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,gCAAgC,CAAC,CAAC;QAEjE,MAAM,eAAe,GAAY,gBAAgB,KAAK,SAAS,IAAI,gBAAgB,KAAK,IAAI,CAAC;QAE7F,MAAM,kBAAkB,GAAa,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACzD,MAAM,UAAU,GAAW,kBAAkB,CAAC,MAAM,CAAC;QACrD,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QAEvB,IAAI,UAAU,KAAK,CAAC,EAAE;YACpB,IAAI,eAAe,IAAI,gBAAiB,EAAE;gBACxC,IAAI,QAAQ,KAAK,cAAc;oBAC7B,OAAO,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;gBAE5E,IAAI,QAAQ,KAAK,WAAW;oBAC1B,OAAO,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;gBAEzE,IAAI,QAAQ,KAAK,oBAAoB;oBACnC,OAAO,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;gBAElF,IAAI,QAAQ,KAAK,oBAAoB;oBACnC,OAAO,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;gBAElF,IAAI,QAAQ,KAAK,iBAAiB;oBAChC,OAAO,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;gBAE/E,IAAI,QAAQ,KAAK,iBAAiB;oBAChC,OAAO,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;gBAE/E,OAAO,SAAS,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;aAC3C;YAED,OAAO,SAAS,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;SAC3C;QAED,2EAA2E;QAC3E,kDAAkD;QAClD,IAAI,MAAM,GAAW,SAAS,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAC3E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YACvC,MAAM,IAAI,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,CAAC;SACvC;QAED,MAAM,SAAS,GAAW,kBAAkB,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QAE7D,IAAI,eAAe,IAAI,gBAAiB,EAAE;YACxC,IAAI,SAAS,KAAK,IAAI;gBACpB,MAAM,IAAI,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;iBAC1E,IAAI,SAAS,KAAK,cAAc;gBACnC,MAAM,IAAI,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;iBAClF,IAAI,SAAS,KAAK,GAAG;gBACxB,MAAM,IAAI,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;iBACpE,IAAI,SAAS,KAAK,GAAG;gBACxB,MAAM,IAAI,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;iBACpE,IAAI,SAAS,KAAK,GAAG;gBACxB,MAAM,IAAI,SAAS,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;iBACpE,IAAI,eAAe;gBACtB,MAAM,IAAI,SAAS,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;;gBAE9C,MAAM,IAAI,KAAK,CAAC,YAAY,SAAS,qBAAqB,QAAQ,+BAA+B,CAAC,CAAC;SACtG;;YACC,MAAM,IAAI,SAAS,CAAC;QAEtB,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,sBAAsB,CAAC,kBAAuC;QAC1E,QAAQ,kBAAkB,EAAE;YAC1B,KAAK,mBAAmB,CAAC,YAAY,CAAC;YACtC,KAAK,mBAAmB,CAAC,YAAY;gBACnC,OAAO,IAAI,CAAC;YACd,KAAK,mBAAmB,CAAC,SAAS;gBAChC,OAAO,WAAW,CAAC;YACrB,KAAK,mBAAmB,CAAC,kBAAkB;gBACzC,OAAO,UAAU,CAAC;YACpB,KAAK,mBAAmB,CAAC,eAAe;gBACtC,OAAO,iBAAiB,CAAC;YAC3B,KAAK,mBAAmB,CAAC,kBAAkB;gBACzC,OAAO,UAAU,CAAC;YACpB,KAAK,mBAAmB,CAAC,eAAe;gBACtC,OAAO,iBAAiB,CAAC;YAC3B,KAAK,mBAAmB,CAAC,oBAAoB;gBAC3C,OAAO,cAAc,CAAC;YACxB,KAAK,mBAAmB,CAAC,MAAM;gBAC7B,OAAO,GAAG,CAAC;YACb,KAAK,mBAAmB,CAAC,MAAM;gBAC7B,OAAO,GAAG,CAAC;YACb,KAAK,mBAAmB,CAAC,MAAM;gBAC7B,OAAO,GAAG,CAAC;YACb;gBACE,MAAM,IAAI,KAAK,CAAC,0CAA0C,kBAAkB,GAAG,CAAC,CAAC;SACpF;IACH,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,IAAY,IAAY,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC1G","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 ECSQL\r\n */\r\n\r\nimport { assert, Id64String } from \"@itwin/core-bentley\";\r\n\r\n/** Describes the different data types an ECSQL value can be of.\r\n * See also [ECSQL]($docs/learning/ECSQL).\r\n * @public\r\n */\r\nexport enum ECSqlValueType {\r\n  // do not change the values of the enum as it must match its counterpart in the addon\r\n  Blob = 1,\r\n  Boolean = 2,\r\n  DateTime = 3,\r\n  Double = 4,\r\n  Geometry = 5,\r\n  Id = 6,\r\n  Int = 7,\r\n  Int64 = 8,\r\n  Point2d = 9,\r\n  Point3d = 10,\r\n  String = 11,\r\n  Navigation = 12,\r\n  Struct = 13,\r\n  PrimitiveArray = 14,\r\n  StructArray = 15,\r\n  Guid = 16,\r\n}\r\n\r\n/** An ECSQL Navigation value.\r\n * It is returned from ECSQL SELECT statements for navigation properties.\r\n * See also [ECSQL]($docs/learning/ECSQL).\r\n * @public\r\n */\r\nexport interface NavigationValue {\r\n  /** ECInstanceId of the related instance */\r\n  id: Id64String;\r\n  /** Fully qualified class name of the relationship backing the Navigation property */\r\n  relClassName?: string;\r\n}\r\n\r\n/** An ECSQL Navigation value which can be bound to a navigation property ECSQL parameter\r\n * See also [ECSQL]($docs/learning/ECSQL).\r\n * @public\r\n */\r\nexport interface NavigationBindingValue {\r\n  /** ECInstanceId of the related instance */\r\n  id: Id64String;\r\n  /** Fully qualified class name of the relationship backing the Navigation property */\r\n  relClassName?: string;\r\n  /** Table space where the relationship's schema is persisted. This is only required\r\n   * if other ECDb files are attached to the primary one. In case a schema exists in more than one of the files,\r\n   * pass the table space to disambiguate.\r\n   */\r\n  relClassTableSpace?: string;\r\n}\r\n\r\n/** Equivalent of the ECEnumeration OpCode in the **ECDbChange** ECSchema.\r\n * The enum can be used when programmatically binding values to the InstanceChange.OpCode property of\r\n * the ECDbChange ECSchema.\r\n *\r\n * See also\r\n * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)\r\n * @public\r\n */\r\nexport enum ChangeOpCode {\r\n  Insert = 1,\r\n  Update = 2,\r\n  Delete = 4,\r\n}\r\n\r\n/** The enum represents the values for the ChangedValueState argument of the ECSQL function **Changes**.\r\n * The enum can be used when programmatically binding values to the ChangedValueState argument\r\n * in an ECSQL using the **Changes** ECSQL function.\r\n *\r\n * See also\r\n * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)\r\n * @public\r\n */\r\nexport enum ChangedValueState {\r\n  AfterInsert = 1,\r\n  BeforeUpdate = 2,\r\n  AfterUpdate = 3,\r\n  BeforeDelete = 4,\r\n}\r\n\r\n/** Defines the ECSQL system properties.\r\n * See also [ECSQL]($docs/learning/ECSQL).\r\n * @public\r\n */\r\nexport enum ECSqlSystemProperty {\r\n  ECInstanceId,\r\n  ECClassId,\r\n  SourceECInstanceId,\r\n  SourceECClassId,\r\n  TargetECInstanceId,\r\n  TargetECClassId,\r\n  NavigationId,\r\n  NavigationRelClassId,\r\n  PointX,\r\n  PointY,\r\n  PointZ,\r\n}\r\n\r\n/** Utility to format ECProperty names according to the iTwin.js formatting rules.\r\n * See also [ECSQL Row Format]($docs/learning/ECSQLRowFormat).\r\n * @public\r\n */\r\nexport class ECJsNames {\r\n\r\n  /** Formats the specified ECProperty name according to the iTwin.js formatting rules.\r\n   *\r\n   *  See [ECSQL Row Format]($docs/learning/ECSQLRowFormat) which describes the formatting rules.\r\n   *\r\n   * @param ecProperty Property name as defined in the ECSchema for regular ECProperties\r\n   *        or the name of an ECSQL system properties\r\n   * @param isSystemProperty if omitted, the method will try to find out whether the given property\r\n   *        is a system property or not. If true is specified, the method will throw if the property name\r\n   *        is not a known system property. If false is specified, the method will not attempt to recognize\r\n   *        the property name as system property.\r\n   */\r\n  public static toJsName(propName: string, isSystemProperty?: boolean) {\r\n    assert(propName !== undefined, \"propName must not be undefined\");\r\n\r\n    const propTypeUnknown: boolean = isSystemProperty === undefined || isSystemProperty === null;\r\n\r\n    const accessStringTokens: string[] = propName.split(\".\");\r\n    const tokenCount: number = accessStringTokens.length;\r\n    assert(tokenCount > 0);\r\n\r\n    if (tokenCount === 1) {\r\n      if (propTypeUnknown || isSystemProperty!) {\r\n        if (propName === \"ECInstanceId\")\r\n          return ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.ECInstanceId);\r\n\r\n        if (propName === \"ECClassId\")\r\n          return ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.ECClassId);\r\n\r\n        if (propName === \"SourceECInstanceId\")\r\n          return ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.SourceECInstanceId);\r\n\r\n        if (propName === \"TargetECInstanceId\")\r\n          return ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.TargetECInstanceId);\r\n\r\n        if (propName === \"SourceECClassId\")\r\n          return ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.SourceECClassId);\r\n\r\n        if (propName === \"TargetECClassId\")\r\n          return ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.TargetECClassId);\r\n\r\n        return ECJsNames.lowerFirstChar(propName);\r\n      }\r\n\r\n      return ECJsNames.lowerFirstChar(propName);\r\n    }\r\n\r\n    // parse access string and convert the leaf tokens if they are system props\r\n    // The first char of the access string is lowered.\r\n    let jsName: string = ECJsNames.lowerFirstChar(`${accessStringTokens[0]}.`);\r\n    for (let j = 1; j < tokenCount - 1; j++) {\r\n      jsName += `${accessStringTokens[j]}.`;\r\n    }\r\n\r\n    const leafToken: string = accessStringTokens[tokenCount - 1];\r\n\r\n    if (propTypeUnknown || isSystemProperty!) {\r\n      if (leafToken === \"Id\")\r\n        jsName += ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.NavigationId);\r\n      else if (leafToken === \"RelECClassId\")\r\n        jsName += ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.NavigationRelClassId);\r\n      else if (leafToken === \"X\")\r\n        jsName += ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.PointX);\r\n      else if (leafToken === \"Y\")\r\n        jsName += ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.PointY);\r\n      else if (leafToken === \"Z\")\r\n        jsName += ECJsNames.systemPropertyToJsName(ECSqlSystemProperty.PointZ);\r\n      else if (propTypeUnknown)\r\n        jsName += ECJsNames.lowerFirstChar(leafToken);\r\n      else\r\n        throw new Error(`Property ${leafToken} of access string ${propName} is no ECSQL system property.`);\r\n    } else\r\n      jsName += leafToken;\r\n\r\n    return jsName;\r\n  }\r\n\r\n  /** Returns the name of the specified ECSQL system property according to the\r\n   *  iTwin.js formatting rules.\r\n   *\r\n   *  See [ECSQL Row Format]($docs/learning/ECSQLRowFormat) which describes the formatting rules.\r\n   * @param systemPropertyType System property type\r\n   */\r\n  public static systemPropertyToJsName(systemPropertyType: ECSqlSystemProperty): string {\r\n    switch (systemPropertyType) {\r\n      case ECSqlSystemProperty.ECInstanceId:\r\n      case ECSqlSystemProperty.NavigationId:\r\n        return \"id\";\r\n      case ECSqlSystemProperty.ECClassId:\r\n        return \"className\";\r\n      case ECSqlSystemProperty.SourceECInstanceId:\r\n        return \"sourceId\";\r\n      case ECSqlSystemProperty.SourceECClassId:\r\n        return \"sourceClassName\";\r\n      case ECSqlSystemProperty.TargetECInstanceId:\r\n        return \"targetId\";\r\n      case ECSqlSystemProperty.TargetECClassId:\r\n        return \"targetClassName\";\r\n      case ECSqlSystemProperty.NavigationRelClassId:\r\n        return \"relClassName\";\r\n      case ECSqlSystemProperty.PointX:\r\n        return \"x\";\r\n      case ECSqlSystemProperty.PointY:\r\n        return \"y\";\r\n      case ECSqlSystemProperty.PointZ:\r\n        return \"z\";\r\n      default:\r\n        throw new Error(`Unknown ECSqlSystemProperty enum value ${systemPropertyType}.`);\r\n    }\r\n  }\r\n\r\n  private static lowerFirstChar(name: string): string { return name[0].toLowerCase() + name.substring(1); }\r\n}\r\n"]}

package/lib/esm/EntityProps.d.ts

@@ -2,10 +2,17 @@
  * @module Entities
  */
 import { Id64String } from "@itwin/core-bentley";
-/** The properties of an [Entity]($backend) as they are read/stored from/to the iModel.
+/** The persistent format of an [Entity]($backend), also used as the "wire format" when transmitting information about entities
+ * between the backend and frontend.
+ * EntityProps and all of its sub-types like [[ElementProps]] are "plain old Javascript objects" - that is, objects containing
+ * no methods and no properties of `class` type.
  * @public
  */
 export interface EntityProps {
+    /** A non-existent property used to discriminate between [[EntityProps]] and [Entity]($backend).
+     * @see [Entity.isInstanceOfEntity]($backend).
+     */
+    readonly isInstanceOfEntity?: never;
     /** The full name of the [ECClass]($docs/bis/intro/glossary/#ecclass) for this entity, in the form "Schema:ClassName" */
     classFullName: string;
     /** The Id of the entity. Must be present for SELECT, UPDATE, or DELETE, ignored for INSERT. */

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

@@ -1 +1 @@
-{"version":3,"file":"EntityProps.d.ts","sourceRoot":"","sources":["../../src/EntityProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAIvD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,wHAAwH;IACxH,aAAa,EAAE,MAAM,CAAC;IACtB,+FAA+F;IAC/F,EAAE,CAAC,EAAE,UAAU,CAAC;IAChB,yGAAyG;IACzG,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,UAAU,CAAC;IACrB,QAAQ,EAAE,UAAU,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW,EAAE,eAAe;CACtE;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,iFAAiF;IACjF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gFAAgF;IAChF,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,8FAA8F;IAC9F,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+FAA+F;IAC/F,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oEAAoE;IACpE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,aAAa,IAAO;IACpB,MAAM,MAAQ;IACd,OAAO,MAAQ;IACf,QAAQ,MAAQ;IAChB,MAAM,OAAQ;IACd,OAAO,OAAQ;IACf,IAAI,OAAQ;IACZ,OAAO,OAAQ;IACf,OAAO,OAAQ;IACf,MAAM,OAAQ;CACf;AAED;;GAEG;AACH,oBAAY,gBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,yGAAyG;IACzG,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACzC;AAID,YAAY;AACZ,MAAM,WAAW,qBAAqB;IACpC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;CACtC;AAED;;GAEG;AACH,qBAAa,gBAAiB,YAAW,qBAAqB;IACrD,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;gBAEzB,OAAO,EAAE,qBAAqB;IA2BjD,mFAAmF;IACnF,OAAO,CAAC,kBAAkB;IAS1B,kFAAkF;IAC3E,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;IAyBxC,8DAA8D;IAC9D,IAAW,YAAY,IAAI,OAAO,CAEjC;CACF;AAED,YAAY;AACZ,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gKAAgK;IAChK,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,2CAA2C;IAC3C,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC,qFAAqF;IACrF,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,CAAC;CACtD;AAED;;GAEG;AACH,qBAAa,cAAe,YAAW,mBAAmB;IACxD,sBAAsB;IACtB,SAAgB,OAAO,EAAE,MAAM,CAAC;IAChC,SAAgB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrC,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClC,SAAgB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtC,uIAAuI;IACvI,SAAgB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtC,2CAA2C;IAC3C,SAAgB,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrD,qFAAqF;IACrF,SAAgB,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,CAAC;gBAElD,OAAO,EAAE,mBAAmB;CAahD"}
+{"version":3,"file":"EntityProps.d.ts","sourceRoot":"","sources":["../../src/EntityProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAIvD;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,KAAK,CAAC;IACpC,wHAAwH;IACxH,aAAa,EAAE,MAAM,CAAC;IACtB,+FAA+F;IAC/F,EAAE,CAAC,EAAE,UAAU,CAAC;IAChB,yGAAyG;IACzG,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,UAAU,CAAC;IACrB,QAAQ,EAAE,UAAU,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW,EAAE,eAAe;CACtE;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,iFAAiF;IACjF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gFAAgF;IAChF,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,8FAA8F;IAC9F,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+FAA+F;IAC/F,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oEAAoE;IACpE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,aAAa,IAAO;IACpB,MAAM,MAAQ;IACd,OAAO,MAAQ;IACf,QAAQ,MAAQ;IAChB,MAAM,OAAQ;IACd,OAAO,OAAQ;IACf,IAAI,OAAQ;IACZ,OAAO,OAAQ;IACf,OAAO,OAAQ;IACf,MAAM,OAAQ;CACf;AAED;;GAEG;AACH,oBAAY,gBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,yGAAyG;IACzG,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACzC;AAID,YAAY;AACZ,MAAM,WAAW,qBAAqB;IACpC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;CACtC;AAED;;GAEG;AACH,qBAAa,gBAAiB,YAAW,qBAAqB;IACrD,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;gBAEzB,OAAO,EAAE,qBAAqB;IA2BjD,mFAAmF;IACnF,OAAO,CAAC,kBAAkB;IAS1B,kFAAkF;IAC3E,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;IAyBxC,8DAA8D;IAC9D,IAAW,YAAY,IAAI,OAAO,CAEjC;CACF;AAED,YAAY;AACZ,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gKAAgK;IAChK,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,2CAA2C;IAC3C,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC,qFAAqF;IACrF,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,CAAC;CACtD;AAED;;GAEG;AACH,qBAAa,cAAe,YAAW,mBAAmB;IACxD,sBAAsB;IACtB,SAAgB,OAAO,EAAE,MAAM,CAAC;IAChC,SAAgB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrC,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClC,SAAgB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtC,uIAAuI;IACvI,SAAgB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtC,2CAA2C;IAC3C,SAAgB,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrD,qFAAqF;IACrF,SAAgB,UAAU,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,CAAC;gBAElD,OAAO,EAAE,mBAAmB;CAahD"}

package/lib/esm/EntityProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"EntityProps.js","sourceRoot":"","sources":["../../src/EntityProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAkDhD;;GAEG;AACH,MAAM,CAAN,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IAC3B,2EAAoB,CAAA;IACpB,+DAAc,CAAA;IACd,iEAAe,CAAA;IACf,mEAAgB,CAAA;IAChB,gEAAc,CAAA;IACd,kEAAe,CAAA;IACf,4DAAY,CAAA;IACZ,kEAAe,CAAA;IACf,kEAAe,CAAA;IACf,gEAAc,CAAA;AAChB,CAAC,EAXW,iBAAiB,KAAjB,iBAAiB,QAW5B;AAyCD;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAoB3B,YAAmB,OAA8B;QAC/C,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC3C,IAAI,OAAO,CAAC,UAAU;YACpB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IACnD,CAAC;IAED,mFAAmF;IAC3E,kBAAkB,CAAC,IAAiB,EAAE,OAAY;QACxD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;QAEvC,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,OAAO,CAAC,OAAO,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3D,OAAO,GAAG,CAAC;IACb,CAAC;IAED,kFAAkF;IAC3E,cAAc,CAAC,OAAY;QAChC,IAAI,OAAO,KAAK,SAAS;YACvB,OAAO,SAAS,CAAC;QAEnB,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa,EAAE;YACpC,QAAQ,IAAI,CAAC,aAAa,EAAE;gBAC1B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM,CAAC;gBAC9B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM;oBAC3B,OAAO,OAAO,CAAC,CAAC,wGAAwG;gBAE1H,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAE5D,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;aAC7D;SACF;QACD,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO,OAAO,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEzF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,8DAA8D;IAC9D,IAAW,YAAY;QACrB,OAAO,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,gEAAgE;IACzG,CAAC;CACF;AAgBD;;GAEG;AACH,MAAM,OAAO,cAAc;IAazB,YAAmB,OAA4B;QAC7C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QAErB,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,UAAU,EAAE,EAAE,mCAAmC;YAC9E,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;SAChF;IACH,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 Entities\r\n */\r\n\r\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { Point2d, Point3d } from \"@itwin/core-geometry\";\r\nimport { RelatedElement } from \"./ElementProps\";\r\n\r\n/** The properties of an [Entity]($backend) as they are read/stored from/to the iModel.\r\n * @public\r\n */\r\nexport interface EntityProps {\r\n  /** The full name of the [ECClass]($docs/bis/intro/glossary/#ecclass) for this entity, in the form \"Schema:ClassName\" */\r\n  classFullName: string;\r\n  /** The Id of the entity. Must be present for SELECT, UPDATE, or DELETE, ignored for INSERT. */\r\n  id?: Id64String;\r\n  /** Optional [json properties]($docs/bis/intro/element-fundamentals.md#jsonproperties) of this Entity. */\r\n  jsonProperties?: { [key: string]: any };\r\n}\r\n\r\n/** Specifies the source and target elements of a [[Relationship]] instance.\r\n * @public\r\n */\r\nexport interface SourceAndTarget {\r\n  sourceId: Id64String;\r\n  targetId: Id64String;\r\n}\r\n\r\n/** Properties that are common to all types of link table ECRelationships\r\n * @public\r\n */\r\nexport interface RelationshipProps extends EntityProps, SourceAndTarget {\r\n}\r\n\r\n/** Parameters for performing a query on [Entity]($backend) classes.\r\n * @public\r\n */\r\nexport interface EntityQueryParams {\r\n  /** The sql className, in the form \"Schema.ClassName\", of the class to search. */\r\n  from?: string;\r\n  /** Set to true to limit results to *not* include sub-classes of \"from\" class */\r\n  only?: boolean;\r\n  /** Optional \"WHERE\" clause to filter entities. Note: do *not* include the \"WHERE\" keyword. */\r\n  where?: string;\r\n  /** Optional \"ORDERBY\" clause to sort results. Note: do *not* include the \"ORDERBY\" keyword. */\r\n  orderBy?: string;\r\n  /** Optional \"LIMIT\" clause to limit the number of rows returned. */\r\n  limit?: number;\r\n  /** Optional \"OFFSET\" clause. Only valid if Limit is also present. */\r\n  offset?: number;\r\n  /** Bindings for parameterized values.\r\n   * @see [[ECSqlStatement.bindValues]]\r\n   */\r\n  bindings?: any[] | object;\r\n}\r\n\r\n/** The primitive types of an Entity property.\r\n * @beta\r\n */\r\nexport enum PrimitiveTypeCode {\r\n  Uninitialized = 0x00,\r\n  Binary = 0x101,\r\n  Boolean = 0x201,\r\n  DateTime = 0x301,\r\n  Double = 0x401,\r\n  Integer = 0x501,\r\n  Long = 0x601,\r\n  Point2d = 0x701, // eslint-disable-line @typescript-eslint/no-shadow\r\n  Point3d = 0x801, // eslint-disable-line @typescript-eslint/no-shadow\r\n  String = 0x901,\r\n}\r\n\r\n/** A callback function to process properties of an Entity\r\n * @beta\r\n */\r\nexport type PropertyCallback = (name: string, meta: PropertyMetaData) => void;\r\n\r\n/** A custom attribute instance\r\n * @beta\r\n */\r\nexport interface CustomAttribute {\r\n  /** The class of the CustomAttribute */\r\n  ecclass: string;\r\n  /** An object whose properties correspond by name to the properties of this custom attribute instance. */\r\n  properties: { [propName: string]: any };\r\n}\r\n\r\ntype FactoryFunc = (jsonObj: any) => any;\r\n\r\n/** @beta */\r\nexport interface PropertyMetaDataProps {\r\n  primitiveType?: number;\r\n  structName?: string;\r\n  extendedType?: string;\r\n  description?: string;\r\n  displayLabel?: string;\r\n  minimumValue?: any;\r\n  maximumValue?: any;\r\n  minimumLength?: number;\r\n  maximumLength?: number;\r\n  readOnly?: boolean;\r\n  kindOfQuantity?: string;\r\n  isCustomHandled?: boolean;\r\n  isCustomHandledOrphan?: boolean;\r\n  minOccurs?: number;\r\n  maxOccurs?: number;\r\n  direction?: string;\r\n  relationshipClass?: string;\r\n  customAttributes?: CustomAttribute[];\r\n}\r\n\r\n/** Metadata for a property.\r\n * @beta\r\n */\r\nexport class PropertyMetaData implements PropertyMetaDataProps {\r\n  public primitiveType?: PrimitiveTypeCode;\r\n  public structName?: string;\r\n  public extendedType?: string;\r\n  public description?: string;\r\n  public displayLabel?: string;\r\n  public minimumValue?: any;\r\n  public maximumValue?: any;\r\n  public minimumLength?: number;\r\n  public maximumLength?: number;\r\n  public readOnly?: boolean;\r\n  public kindOfQuantity?: string;\r\n  public isCustomHandled?: boolean;\r\n  public isCustomHandledOrphan?: boolean;\r\n  public minOccurs?: number;\r\n  public maxOccurs?: number;\r\n  public direction?: string;\r\n  public relationshipClass?: string;\r\n  public customAttributes?: CustomAttribute[];\r\n\r\n  public constructor(jsonObj: PropertyMetaDataProps) {\r\n    this.primitiveType = jsonObj.primitiveType;\r\n    if (jsonObj.structName)\r\n      this.structName = jsonObj.structName;\r\n    this.extendedType = jsonObj.extendedType;\r\n    this.description = jsonObj.description;\r\n    this.displayLabel = jsonObj.displayLabel;\r\n    if (undefined !== jsonObj.minimumValue)\r\n      this.minimumValue = jsonObj.minimumValue;\r\n    if (undefined !== jsonObj.maximumValue)\r\n      this.maximumValue = jsonObj.maximumValue;\r\n    if (undefined !== jsonObj.minimumLength)\r\n      this.minimumLength = jsonObj.minimumLength;\r\n    if (undefined !== jsonObj.maximumLength)\r\n      this.maximumLength = jsonObj.maximumLength;\r\n    this.readOnly = jsonObj.readOnly;\r\n    this.kindOfQuantity = jsonObj.kindOfQuantity;\r\n    this.isCustomHandled = jsonObj.isCustomHandled;\r\n    if (undefined !== jsonObj.minOccurs)\r\n      this.minOccurs = jsonObj.minOccurs;\r\n    if (undefined !== jsonObj.maxOccurs)\r\n      this.maxOccurs = jsonObj.maxOccurs;\r\n    this.direction = jsonObj.direction;\r\n    this.relationshipClass = jsonObj.relationshipClass;\r\n    this.customAttributes = jsonObj.customAttributes;\r\n  }\r\n\r\n  /** Create a typed value, or array of values, from a factory and an input object */\r\n  private createValueOrArray(func: FactoryFunc, jsonObj: any) {\r\n    if (undefined === this.minOccurs)\r\n      return func(jsonObj); // not an array\r\n\r\n    const val: any = [];\r\n    jsonObj.forEach((element: any) => val.push(func(element)));\r\n    return val;\r\n  }\r\n\r\n  /** construct a single property from an input object according to this metadata */\r\n  public createProperty(jsonObj: any): any {\r\n    if (jsonObj === undefined)\r\n      return undefined;\r\n\r\n    if (undefined !== this.primitiveType) {\r\n      switch (this.primitiveType) {\r\n        case PrimitiveTypeCode.Boolean:\r\n        case PrimitiveTypeCode.Double:\r\n        case PrimitiveTypeCode.Integer:\r\n        case PrimitiveTypeCode.String:\r\n          return jsonObj; // this works even for arrays or strings that are JSON because the parsed JSON is already the right type\r\n\r\n        case PrimitiveTypeCode.Point2d:\r\n          return this.createValueOrArray(Point2d.fromJSON, jsonObj);\r\n\r\n        case PrimitiveTypeCode.Point3d:\r\n          return this.createValueOrArray(Point3d.fromJSON, jsonObj);\r\n      }\r\n    }\r\n    if (this.isNavigation)\r\n      return jsonObj.id !== undefined ? new RelatedElement(jsonObj) : Id64.fromJSON(jsonObj);\r\n\r\n    return jsonObj;\r\n  }\r\n\r\n  /** Return `true` if this property is a NavigationProperty. */\r\n  public get isNavigation(): boolean {\r\n    return (this.direction !== undefined); // the presence of `direction` means it is a navigation property\r\n  }\r\n}\r\n\r\n/** @beta */\r\nexport interface EntityMetaDataProps {\r\n  ecclass: string;\r\n  description?: string;\r\n  modifier?: string;\r\n  displayLabel?: string;\r\n  /** The  base classes from which this class derives. If more than one, the first is the super class and the others are [mixins]($docs/bis/ec/ec-mixin-class). */\r\n  baseClasses: string[];\r\n  /** The Custom Attributes for this class */\r\n  customAttributes?: CustomAttribute[];\r\n  /** An object whose properties correspond by name to the properties of this class. */\r\n  properties: { [propName: string]: PropertyMetaData };\r\n}\r\n\r\n/** Metadata for an Entity.\r\n * @beta\r\n */\r\nexport class EntityMetaData implements EntityMetaDataProps {\r\n  /** The Entity name */\r\n  public readonly ecclass: string;\r\n  public readonly description?: string;\r\n  public readonly modifier?: string;\r\n  public readonly displayLabel?: string;\r\n  /** The  base class that this class is derives from. If more than one, the first is the actual base class and the others are mixins. */\r\n  public readonly baseClasses: string[];\r\n  /** The Custom Attributes for this class */\r\n  public readonly customAttributes?: CustomAttribute[];\r\n  /** An object whose properties correspond by name to the properties of this class. */\r\n  public readonly properties: { [propName: string]: PropertyMetaData };\r\n\r\n  public constructor(jsonObj: EntityMetaDataProps) {\r\n    this.ecclass = jsonObj.ecclass;\r\n    this.description = jsonObj.description;\r\n    this.modifier = jsonObj.modifier;\r\n    this.displayLabel = jsonObj.displayLabel;\r\n    this.baseClasses = jsonObj.baseClasses;\r\n    this.customAttributes = jsonObj.customAttributes;\r\n    this.properties = {};\r\n\r\n    for (const propName in jsonObj.properties) { // eslint-disable-line guard-for-in\r\n      this.properties[propName] = new PropertyMetaData(jsonObj.properties[propName]);\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"EntityProps.js","sourceRoot":"","sources":["../../src/EntityProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAyDhD;;GAEG;AACH,MAAM,CAAN,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IAC3B,2EAAoB,CAAA;IACpB,+DAAc,CAAA;IACd,iEAAe,CAAA;IACf,mEAAgB,CAAA;IAChB,gEAAc,CAAA;IACd,kEAAe,CAAA;IACf,4DAAY,CAAA;IACZ,kEAAe,CAAA;IACf,kEAAe,CAAA;IACf,gEAAc,CAAA;AAChB,CAAC,EAXW,iBAAiB,KAAjB,iBAAiB,QAW5B;AAyCD;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAoB3B,YAAmB,OAA8B;QAC/C,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC3C,IAAI,OAAO,CAAC,UAAU;YACpB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IACnD,CAAC;IAED,mFAAmF;IAC3E,kBAAkB,CAAC,IAAiB,EAAE,OAAY;QACxD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;QAEvC,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,OAAO,CAAC,OAAO,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3D,OAAO,GAAG,CAAC;IACb,CAAC;IAED,kFAAkF;IAC3E,cAAc,CAAC,OAAY;QAChC,IAAI,OAAO,KAAK,SAAS;YACvB,OAAO,SAAS,CAAC;QAEnB,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa,EAAE;YACpC,QAAQ,IAAI,CAAC,aAAa,EAAE;gBAC1B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM,CAAC;gBAC9B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM;oBAC3B,OAAO,OAAO,CAAC,CAAC,wGAAwG;gBAE1H,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAE5D,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;aAC7D;SACF;QACD,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO,OAAO,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEzF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,8DAA8D;IAC9D,IAAW,YAAY;QACrB,OAAO,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,gEAAgE;IACzG,CAAC;CACF;AAgBD;;GAEG;AACH,MAAM,OAAO,cAAc;IAazB,YAAmB,OAA4B;QAC7C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QAErB,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,UAAU,EAAE,EAAE,mCAAmC;YAC9E,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;SAChF;IACH,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 Entities\r\n */\r\n\r\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { Point2d, Point3d } from \"@itwin/core-geometry\";\r\nimport { RelatedElement } from \"./ElementProps\";\r\n\r\n/** The persistent format of an [Entity]($backend), also used as the \"wire format\" when transmitting information about entities\r\n * between the backend and frontend.\r\n * EntityProps and all of its sub-types like [[ElementProps]] are \"plain old Javascript objects\" - that is, objects containing\r\n * no methods and no properties of `class` type.\r\n * @public\r\n */\r\nexport interface EntityProps {\r\n  /** A non-existent property used to discriminate between [[EntityProps]] and [Entity]($backend).\r\n   * @see [Entity.isInstanceOfEntity]($backend).\r\n   */\r\n  readonly isInstanceOfEntity?: never;\r\n  /** The full name of the [ECClass]($docs/bis/intro/glossary/#ecclass) for this entity, in the form \"Schema:ClassName\" */\r\n  classFullName: string;\r\n  /** The Id of the entity. Must be present for SELECT, UPDATE, or DELETE, ignored for INSERT. */\r\n  id?: Id64String;\r\n  /** Optional [json properties]($docs/bis/intro/element-fundamentals.md#jsonproperties) of this Entity. */\r\n  jsonProperties?: { [key: string]: any };\r\n}\r\n\r\n/** Specifies the source and target elements of a [[Relationship]] instance.\r\n * @public\r\n */\r\nexport interface SourceAndTarget {\r\n  sourceId: Id64String;\r\n  targetId: Id64String;\r\n}\r\n\r\n/** Properties that are common to all types of link table ECRelationships\r\n * @public\r\n */\r\nexport interface RelationshipProps extends EntityProps, SourceAndTarget {\r\n}\r\n\r\n/** Parameters for performing a query on [Entity]($backend) classes.\r\n * @public\r\n */\r\nexport interface EntityQueryParams {\r\n  /** The sql className, in the form \"Schema.ClassName\", of the class to search. */\r\n  from?: string;\r\n  /** Set to true to limit results to *not* include sub-classes of \"from\" class */\r\n  only?: boolean;\r\n  /** Optional \"WHERE\" clause to filter entities. Note: do *not* include the \"WHERE\" keyword. */\r\n  where?: string;\r\n  /** Optional \"ORDERBY\" clause to sort results. Note: do *not* include the \"ORDERBY\" keyword. */\r\n  orderBy?: string;\r\n  /** Optional \"LIMIT\" clause to limit the number of rows returned. */\r\n  limit?: number;\r\n  /** Optional \"OFFSET\" clause. Only valid if Limit is also present. */\r\n  offset?: number;\r\n  /** Bindings for parameterized values.\r\n   * @see [[ECSqlStatement.bindValues]]\r\n   */\r\n  bindings?: any[] | object;\r\n}\r\n\r\n/** The primitive types of an Entity property.\r\n * @beta\r\n */\r\nexport enum PrimitiveTypeCode {\r\n  Uninitialized = 0x00,\r\n  Binary = 0x101,\r\n  Boolean = 0x201,\r\n  DateTime = 0x301,\r\n  Double = 0x401,\r\n  Integer = 0x501,\r\n  Long = 0x601,\r\n  Point2d = 0x701, // eslint-disable-line @typescript-eslint/no-shadow\r\n  Point3d = 0x801, // eslint-disable-line @typescript-eslint/no-shadow\r\n  String = 0x901,\r\n}\r\n\r\n/** A callback function to process properties of an Entity\r\n * @beta\r\n */\r\nexport type PropertyCallback = (name: string, meta: PropertyMetaData) => void;\r\n\r\n/** A custom attribute instance\r\n * @beta\r\n */\r\nexport interface CustomAttribute {\r\n  /** The class of the CustomAttribute */\r\n  ecclass: string;\r\n  /** An object whose properties correspond by name to the properties of this custom attribute instance. */\r\n  properties: { [propName: string]: any };\r\n}\r\n\r\ntype FactoryFunc = (jsonObj: any) => any;\r\n\r\n/** @beta */\r\nexport interface PropertyMetaDataProps {\r\n  primitiveType?: number;\r\n  structName?: string;\r\n  extendedType?: string;\r\n  description?: string;\r\n  displayLabel?: string;\r\n  minimumValue?: any;\r\n  maximumValue?: any;\r\n  minimumLength?: number;\r\n  maximumLength?: number;\r\n  readOnly?: boolean;\r\n  kindOfQuantity?: string;\r\n  isCustomHandled?: boolean;\r\n  isCustomHandledOrphan?: boolean;\r\n  minOccurs?: number;\r\n  maxOccurs?: number;\r\n  direction?: string;\r\n  relationshipClass?: string;\r\n  customAttributes?: CustomAttribute[];\r\n}\r\n\r\n/** Metadata for a property.\r\n * @beta\r\n */\r\nexport class PropertyMetaData implements PropertyMetaDataProps {\r\n  public primitiveType?: PrimitiveTypeCode;\r\n  public structName?: string;\r\n  public extendedType?: string;\r\n  public description?: string;\r\n  public displayLabel?: string;\r\n  public minimumValue?: any;\r\n  public maximumValue?: any;\r\n  public minimumLength?: number;\r\n  public maximumLength?: number;\r\n  public readOnly?: boolean;\r\n  public kindOfQuantity?: string;\r\n  public isCustomHandled?: boolean;\r\n  public isCustomHandledOrphan?: boolean;\r\n  public minOccurs?: number;\r\n  public maxOccurs?: number;\r\n  public direction?: string;\r\n  public relationshipClass?: string;\r\n  public customAttributes?: CustomAttribute[];\r\n\r\n  public constructor(jsonObj: PropertyMetaDataProps) {\r\n    this.primitiveType = jsonObj.primitiveType;\r\n    if (jsonObj.structName)\r\n      this.structName = jsonObj.structName;\r\n    this.extendedType = jsonObj.extendedType;\r\n    this.description = jsonObj.description;\r\n    this.displayLabel = jsonObj.displayLabel;\r\n    if (undefined !== jsonObj.minimumValue)\r\n      this.minimumValue = jsonObj.minimumValue;\r\n    if (undefined !== jsonObj.maximumValue)\r\n      this.maximumValue = jsonObj.maximumValue;\r\n    if (undefined !== jsonObj.minimumLength)\r\n      this.minimumLength = jsonObj.minimumLength;\r\n    if (undefined !== jsonObj.maximumLength)\r\n      this.maximumLength = jsonObj.maximumLength;\r\n    this.readOnly = jsonObj.readOnly;\r\n    this.kindOfQuantity = jsonObj.kindOfQuantity;\r\n    this.isCustomHandled = jsonObj.isCustomHandled;\r\n    if (undefined !== jsonObj.minOccurs)\r\n      this.minOccurs = jsonObj.minOccurs;\r\n    if (undefined !== jsonObj.maxOccurs)\r\n      this.maxOccurs = jsonObj.maxOccurs;\r\n    this.direction = jsonObj.direction;\r\n    this.relationshipClass = jsonObj.relationshipClass;\r\n    this.customAttributes = jsonObj.customAttributes;\r\n  }\r\n\r\n  /** Create a typed value, or array of values, from a factory and an input object */\r\n  private createValueOrArray(func: FactoryFunc, jsonObj: any) {\r\n    if (undefined === this.minOccurs)\r\n      return func(jsonObj); // not an array\r\n\r\n    const val: any = [];\r\n    jsonObj.forEach((element: any) => val.push(func(element)));\r\n    return val;\r\n  }\r\n\r\n  /** construct a single property from an input object according to this metadata */\r\n  public createProperty(jsonObj: any): any {\r\n    if (jsonObj === undefined)\r\n      return undefined;\r\n\r\n    if (undefined !== this.primitiveType) {\r\n      switch (this.primitiveType) {\r\n        case PrimitiveTypeCode.Boolean:\r\n        case PrimitiveTypeCode.Double:\r\n        case PrimitiveTypeCode.Integer:\r\n        case PrimitiveTypeCode.String:\r\n          return jsonObj; // this works even for arrays or strings that are JSON because the parsed JSON is already the right type\r\n\r\n        case PrimitiveTypeCode.Point2d:\r\n          return this.createValueOrArray(Point2d.fromJSON, jsonObj);\r\n\r\n        case PrimitiveTypeCode.Point3d:\r\n          return this.createValueOrArray(Point3d.fromJSON, jsonObj);\r\n      }\r\n    }\r\n    if (this.isNavigation)\r\n      return jsonObj.id !== undefined ? new RelatedElement(jsonObj) : Id64.fromJSON(jsonObj);\r\n\r\n    return jsonObj;\r\n  }\r\n\r\n  /** Return `true` if this property is a NavigationProperty. */\r\n  public get isNavigation(): boolean {\r\n    return (this.direction !== undefined); // the presence of `direction` means it is a navigation property\r\n  }\r\n}\r\n\r\n/** @beta */\r\nexport interface EntityMetaDataProps {\r\n  ecclass: string;\r\n  description?: string;\r\n  modifier?: string;\r\n  displayLabel?: string;\r\n  /** The  base classes from which this class derives. If more than one, the first is the super class and the others are [mixins]($docs/bis/ec/ec-mixin-class). */\r\n  baseClasses: string[];\r\n  /** The Custom Attributes for this class */\r\n  customAttributes?: CustomAttribute[];\r\n  /** An object whose properties correspond by name to the properties of this class. */\r\n  properties: { [propName: string]: PropertyMetaData };\r\n}\r\n\r\n/** Metadata for an Entity.\r\n * @beta\r\n */\r\nexport class EntityMetaData implements EntityMetaDataProps {\r\n  /** The Entity name */\r\n  public readonly ecclass: string;\r\n  public readonly description?: string;\r\n  public readonly modifier?: string;\r\n  public readonly displayLabel?: string;\r\n  /** The  base class that this class is derives from. If more than one, the first is the actual base class and the others are mixins. */\r\n  public readonly baseClasses: string[];\r\n  /** The Custom Attributes for this class */\r\n  public readonly customAttributes?: CustomAttribute[];\r\n  /** An object whose properties correspond by name to the properties of this class. */\r\n  public readonly properties: { [propName: string]: PropertyMetaData };\r\n\r\n  public constructor(jsonObj: EntityMetaDataProps) {\r\n    this.ecclass = jsonObj.ecclass;\r\n    this.description = jsonObj.description;\r\n    this.modifier = jsonObj.modifier;\r\n    this.displayLabel = jsonObj.displayLabel;\r\n    this.baseClasses = jsonObj.baseClasses;\r\n    this.customAttributes = jsonObj.customAttributes;\r\n    this.properties = {};\r\n\r\n    for (const propName in jsonObj.properties) { // eslint-disable-line guard-for-in\r\n      this.properties[propName] = new PropertyMetaData(jsonObj.properties[propName]);\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/esm/Environment.d.ts

@@ -0,0 +1,61 @@
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+import { NonFunctionPropertiesOf } from "@itwin/core-bentley";
+import { GroundPlane, GroundPlaneProps } from "./GroundPlane";
+import { SkyBox, SkyBoxProps } from "./SkyBox";
+/** JSON representation of an [[Environment]].
+ * @see [[DisplayStyle3dSettingsProps.environment]].
+ * @public
+ */
+export interface EnvironmentProps {
+    /** @see [[Environment.ground]] and [[Environment.displayGround]]. */
+    ground?: GroundPlaneProps;
+    /** @see [[Environment.sky]] and [[Environment.displaySky]]. */
+    sky?: SkyBoxProps;
+}
+/** A type containing all of the properties of [[Environment]] with none of the methods and with the `readonly` modifiers removed.
+ * @see [[Environment.create]] and [[Environment.clone]].
+ * @public
+ */
+export declare type EnvironmentProperties = NonFunctionPropertiesOf<Environment>;
+/** As part of a [[DisplayStyle3dSettings]], controls the display of a [[SkyBox]] and [[GroundPlane]] to simulate the
+ * outdoor environment.
+ * @see [[DisplayStyle3dSettings.environment]].
+ * @public
+ */
+export declare class Environment {
+    /** If true, the sky box will be displayed.
+     * Default: false.
+     * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleSkyBox]] to change this.
+     */
+    readonly displaySky: boolean;
+    /** If true, the ground plane will be displayed.
+     * Default: false.
+     * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleGroundPlane]] to change this.
+     */
+    readonly displayGround: boolean;
+    /** Describes how the sky box should be drawn. */
+    readonly sky: SkyBox;
+    /** Describes how the ground plane should be drawn. */
+    readonly ground: GroundPlane;
+    protected constructor(props?: Partial<EnvironmentProperties>);
+    /** Default settings with neither ground plane nor sky box displayed. */
+    static readonly defaults: Environment;
+    /** Create a new Environment. Any properties not specified by `props` will be initialized to their default values. */
+    static create(props?: Partial<EnvironmentProperties>): Environment;
+    /** Create a copy of this environment, changing the `displayGround` and/or `displaySky` flags. */
+    withDisplay(display: {
+        sky?: boolean;
+        ground?: boolean;
+    }): Environment;
+    /** Convert to JSON representation. */
+    toJSON(): EnvironmentProps;
+    /** Create from JSON representation. */
+    static fromJSON(props?: EnvironmentProps): Environment;
+    /** Create a copy of this environment, identical except for any properties specified by `changedProps`.
+     * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.
+     */
+    clone(changedProps?: Partial<EnvironmentProperties>): Environment;
+}
+//# sourceMappingURL=Environment.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Environment.d.ts","sourceRoot":"","sources":["../../src/Environment.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAE/C;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,qEAAqE;IACrE,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,+DAA+D;IAC/D,GAAG,CAAC,EAAE,WAAW,CAAC;CACnB;AAED;;;GAGG;AACH,oBAAY,qBAAqB,GAAG,uBAAuB,CAAC,WAAW,CAAC,CAAC;AAEzE;;;;GAIG;AACH,qBAAa,WAAW;IACtB;;;OAGG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC;;;OAGG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,iDAAiD;IACjD,SAAgB,GAAG,EAAE,MAAM,CAAC;IAC5B,sDAAsD;IACtD,SAAgB,MAAM,EAAE,WAAW,CAAC;IAEpC,SAAS,aAAa,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC;IAO5D,wEAAwE;IACxE,gBAAuB,QAAQ,cAAqB;IAEpD,qHAAqH;WACvG,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,WAAW;IAIzE,iGAAiG;IAC1F,WAAW,CAAC,OAAO,EAAE;QAAE,GAAG,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,WAAW;IAa7E,sCAAsC;IAC/B,MAAM,IAAI,gBAAgB;IAOjC,uCAAuC;WACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,gBAAgB,GAAG,WAAW;IAY7D;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,WAAW;CAMzE"}

package/lib/esm/Environment.js

@@ -0,0 +1,70 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+import { GroundPlane } from "./GroundPlane";
+import { SkyBox } from "./SkyBox";
+/** As part of a [[DisplayStyle3dSettings]], controls the display of a [[SkyBox]] and [[GroundPlane]] to simulate the
+ * outdoor environment.
+ * @see [[DisplayStyle3dSettings.environment]].
+ * @public
+ */
+export class Environment {
+    constructor(props) {
+        var _a, _b, _c, _d;
+        this.displaySky = (_a = props === null || props === void 0 ? void 0 : props.displaySky) !== null && _a !== void 0 ? _a : false;
+        this.displayGround = (_b = props === null || props === void 0 ? void 0 : props.displayGround) !== null && _b !== void 0 ? _b : false;
+        this.sky = (_c = props === null || props === void 0 ? void 0 : props.sky) !== null && _c !== void 0 ? _c : SkyBox.defaults;
+        this.ground = (_d = props === null || props === void 0 ? void 0 : props.ground) !== null && _d !== void 0 ? _d : GroundPlane.defaults;
+    }
+    /** Create a new Environment. Any properties not specified by `props` will be initialized to their default values. */
+    static create(props) {
+        return props ? new this(props) : this.defaults;
+    }
+    /** Create a copy of this environment, changing the `displayGround` and/or `displaySky` flags. */
+    withDisplay(display) {
+        var _a, _b;
+        const displaySky = (_a = display.sky) !== null && _a !== void 0 ? _a : this.displaySky;
+        const displayGround = (_b = display.ground) !== null && _b !== void 0 ? _b : this.displayGround;
+        if (displaySky === this.displaySky && displayGround === this.displayGround)
+            return this;
+        return Environment.create({
+            ...this,
+            displaySky: displaySky !== null && displaySky !== void 0 ? displaySky : this.displaySky,
+            displayGround: displayGround !== null && displayGround !== void 0 ? displayGround : this.displayGround,
+        });
+    }
+    /** Convert to JSON representation. */
+    toJSON() {
+        return {
+            sky: this.sky.toJSON(this.displaySky),
+            ground: this.ground.toJSON(this.displayGround),
+        };
+    }
+    /** Create from JSON representation. */
+    static fromJSON(props) {
+        var _a, _b;
+        if (!props)
+            return this.defaults;
+        return new this({
+            displaySky: (_a = props === null || props === void 0 ? void 0 : props.sky) === null || _a === void 0 ? void 0 : _a.display,
+            displayGround: (_b = props === null || props === void 0 ? void 0 : props.ground) === null || _b === void 0 ? void 0 : _b.display,
+            sky: (props === null || props === void 0 ? void 0 : props.sky) ? SkyBox.fromJSON(props.sky) : undefined,
+            ground: (props === null || props === void 0 ? void 0 : props.ground) ? GroundPlane.fromJSON(props.ground) : undefined,
+        });
+    }
+    /** Create a copy of this environment, identical except for any properties specified by `changedProps`.
+     * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.
+     */
+    clone(changedProps) {
+        if (!changedProps)
+            return this;
+        return Environment.create({ ...this, ...changedProps });
+    }
+}
+/** Default settings with neither ground plane nor sky box displayed. */
+Environment.defaults = new Environment();
+//# sourceMappingURL=Environment.js.map