@itwin/core-backend 5.0.0-dev.9 → 5.0.0-dev.92

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

@@ -0,0 +1 @@
+{"version":3,"file":"DevTools.d.ts","sourceRoot":"","sources":["../../src/DevTools.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAEzB,OAAO,EAAU,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAIvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAU3D;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,eAAe,CAAC;IACpB,OAAO,EAAE,oBAAoB,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC;CACjC;AAED;;GAEG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAuE;IAC7G,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAsD;IAC3F,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAa;IAC9C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAc;IAEnD,wEAAwE;IACxE,OAAO,CAAC,MAAM,CAAC,SAAS,CAUtB;IAEF,0GAA0G;WAC5F,eAAe,CAAC,KAAK,EAAE,GAAG;CAOzC;AAED;;;GAGG;AACH,qBAAa,QAAQ;IAEnB,uCAAuC;WACzB,IAAI,IAAI,OAAO;IAK7B,OAAO,CAAC,MAAM,CAAC,UAAU;IAIzB,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAK/B,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAsB/B,OAAO,CAAC,MAAM,CAAC,YAAY;IAoB3B,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAWlC,OAAO,CAAC,MAAM,CAAC,oBAAoB;IASnC,OAAO,CAAC,MAAM,CAAC,eAAe;IAY9B,kDAAkD;WACpC,KAAK,IAAI,aAAa;IAapC,uEAAuE;WACzD,WAAW,CAAC,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IAQ7F,iEAAiE;WAC7C,QAAQ;;;;;CAQ7B"}

package/lib/esm/DevTools.js

@@ -0,0 +1,153 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import * as os from "os";
+import * as process from "process";
+import { Logger } from "@itwin/core-bentley";
+import { BackendLoggerCategory } from "./BackendLoggerCategory";
+import { IModelHost } from "./IModelHost";
+import { IModelNative } from "./internal/NativePlatform";
+// cspell:ignore ppid elap
+const loggerCategory = BackendLoggerCategory.DevTools;
+/** Utility to format the JSON created by DevTools.stats() to include the appropriate units
+ * @internal
+ */
+export class DevToolsStatsFormatter {
+    static _megaByteProps = ["totalmem", "freemem", "rss", "heapTotal", "heapUsed", "external"];
+    static _percentProps = ["user", "nice", "sys", "idle", "irq", "cpuUsage"];
+    static _mHzProps = ["speed"];
+    static _secondsProps = ["uptime"];
+    /** Replacer that includes units - can be used with JSON.stringify()  */
+    static _replacer = (key, value) => {
+        if (DevToolsStatsFormatter._megaByteProps.includes(key))
+            return `${value.toFixed()} MB`;
+        if (DevToolsStatsFormatter._percentProps.includes(key))
+            return `${value.toFixed()}%`;
+        if (DevToolsStatsFormatter._mHzProps.includes(key))
+            return `${value.toString()} MHz`;
+        if (DevToolsStatsFormatter._secondsProps.includes(key))
+            return `${value.toFixed()} secs`;
+        return value;
+    };
+    /** Converts the input stats to another JSON object with the appropriate units setup for various fields */
+    static toFormattedJson(stats) {
+        // Serialize the stats to a string with a replacer that sets up units during the serialization
+        const statsStr = JSON.stringify(stats, DevToolsStatsFormatter._replacer);
+        // Deserialize back to JSON
+        return JSON.parse(statsStr);
+    }
+}
+/**
+ * Internal diagnostic utility
+ * @internal
+ */
+export class DevTools {
+    /** Receives a ping and returns true */
+    static ping() {
+        Logger.logInfo(loggerCategory, "Received ping at backend");
+        return true;
+    }
+    static hrtimeToMS(hrtime) {
+        return hrtime[0] * 1000 + hrtime[1] / 1000000;
+    }
+    static bytesToMegaBytes(bytes) {
+        const megaBytes = bytes / Math.pow(1024, 2);
+        return Math.round(megaBytes * 100) / 100;
+    }
+    static evaluateCpuUsage() {
+        const NUMBER_OF_CPUS = os.cpus().length;
+        const startTime = process.hrtime();
+        const startUsage = process.cpuUsage();
+        // spin the CPU for 500 milliseconds
+        const now = Date.now();
+        while (Date.now() - now < 500)
+            ;
+        const elapTime = process.hrtime(startTime);
+        const elapUsage = process.cpuUsage(startUsage);
+        const elapTimeMS = this.hrtimeToMS(elapTime);
+        const elapUserMS = elapUsage.user / 1000; // microseconds to milliseconds
+        const elapSystMS = elapUsage.system / 1000;
+        const cpuPercent = Math.round((100 * (elapUserMS + elapSystMS) / elapTimeMS / NUMBER_OF_CPUS));
+        return cpuPercent;
+    }
+    static evaluateCpus() {
+        // Create a clone
+        const srcCpus = os.cpus();
+        const cpus = new Array(srcCpus.length);
+        let ii = 0;
+        for (const srcCpu of srcCpus)
+            cpus[ii++] = { ...srcCpu };
+        // Evaluate cpu usage as percentages
+        for (const cpu of Object.values(cpus)) {
+            const total = Object.values(cpu.times).reduce((_total, currValue) => _total += currValue, 0);
+            const cpuTimes = cpu.times;
+            for (const type of Object.keys(cpuTimes)) {
+                const cpuPercent = Math.round(100 * cpuTimes[type] / total);
+                cpuTimes[type] = cpuPercent;
+            }
+        }
+        return cpus;
+    }
+    static evaluateMemoryUsage() {
+        // Create a clone
+        const memUsage = { ...process.memoryUsage() };
+        const memUsageObj = memUsage;
+        // Evaluate memory usage as mega bytes
+        for (const type of Object.keys(memUsageObj)) {
+            memUsageObj[type] = this.bytesToMegaBytes(memUsageObj[type]);
+        }
+        return memUsage;
+    }
+    static evaluateProcessStats() {
+        return {
+            uptime: process.uptime(),
+            pid: process.pid,
+            ppid: process.ppid,
+            memoryUsage: this.evaluateMemoryUsage(),
+        };
+    }
+    static evaluateOsStats() {
+        return {
+            platform: os.platform(),
+            hostname: os.hostname(),
+            totalmem: this.bytesToMegaBytes(os.totalmem()),
+            freemem: this.bytesToMegaBytes(os.freemem()),
+            uptime: os.uptime(),
+            cpus: this.evaluateCpus(),
+            cpuUsage: this.evaluateCpuUsage(),
+        };
+    }
+    /** Returns JSON object with backend statistics */
+    static stats() {
+        try {
+            const stats = {
+                os: this.evaluateOsStats(),
+                process: this.evaluateProcessStats(),
+            };
+            return stats;
+        }
+        catch (error) {
+            Logger.logError(loggerCategory, "Could not fetch stats at backend");
+            throw error;
+        }
+    }
+    /** Sets up a log level at the backend and returns the old log level */
+    static setLogLevel(inLoggerCategory, newLevel) {
+        const oldLevel = Logger.getLevel(inLoggerCategory);
+        Logger.logInfo(loggerCategory, `Setting log level`, () => ({ loggerCategory: inLoggerCategory, oldLevel, newLevel }));
+        Logger.setLevel(inLoggerCategory, newLevel);
+        IModelNative.platform.clearLogLevelCache();
+        return oldLevel;
+    }
+    /** Obtains the backend application and iTwin.js Core versions */
+    static async versions() {
+        const availableRpcs = [];
+        return {
+            application: IModelHost.applicationVersion,
+            iTwinJs: require("../../package.json").version, // eslint-disable-line @typescript-eslint/no-require-imports
+            availableRpcs, // filled in on the frontend
+        };
+    }
+}
+//# sourceMappingURL=DevTools.js.map

package/lib/esm/DevTools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DevTools.js","sourceRoot":"","sources":["../../src/DevTools.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,MAAM,EAAY,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAGzD,0BAA0B;AAE1B,MAAM,cAAc,GAAW,qBAAqB,CAAC,QAAQ,CAAC;AAwC9D;;GAEG;AACH,MAAM,OAAO,sBAAsB;IACzB,MAAM,CAAU,cAAc,GAAG,CAAC,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;IACrG,MAAM,CAAU,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IACnF,MAAM,CAAU,SAAS,GAAG,CAAC,OAAO,CAAC,CAAC;IACtC,MAAM,CAAU,aAAa,GAAG,CAAC,QAAQ,CAAC,CAAC;IAEnD,wEAAwE;IAChE,MAAM,CAAC,SAAS,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,EAAE;QACrD,IAAI,sBAAsB,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC;YACrD,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC;QACjC,IAAI,sBAAsB,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC;YACpD,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC;QAC/B,IAAI,sBAAsB,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC;YAChD,OAAO,GAAG,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC;QACnC,IAAI,sBAAsB,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC;YACpD,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC;QACnC,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,0GAA0G;IACnG,MAAM,CAAC,eAAe,CAAC,KAAU;QACtC,8FAA8F;QAC9F,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,sBAAsB,CAAC,SAAS,CAAC,CAAC;QAEzE,2BAA2B;QAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;;AAGH;;;GAGG;AACH,MAAM,OAAO,QAAQ;IAEnB,uCAAuC;IAChC,MAAM,CAAC,IAAI;QAChB,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,0BAA0B,CAAC,CAAC;QAC3D,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,MAAM,CAAC,UAAU,CAAC,MAAW;QACnC,OAAO,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;IAChD,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,KAAa;QAC3C,MAAM,SAAS,GAAG,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC;IAC3C,CAAC;IAEO,MAAM,CAAC,gBAAgB;QAC7B,MAAM,cAAc,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC;QACxC,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QACnC,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;QAEtC,oCAAoC;QACpC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG;YAC3B,CAAC;QAEH,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC3C,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAE/C,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE7C,MAAM,UAAU,GAAG,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,+BAA+B;QACzE,MAAM,UAAU,GAAG,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC;QAC3C,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,GAAG,CAAC,UAAU,GAAG,UAAU,CAAC,GAAG,UAAU,GAAG,cAAc,CAAC,CAAC,CAAC;QAE/F,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,MAAM,CAAC,YAAY;QACzB,iBAAiB;QACjB,MAAM,OAAO,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,IAAI,KAAK,CAAa,OAAO,CAAC,MAAM,CAAC,CAAC;QACnD,IAAI,EAAE,GAAG,CAAC,CAAC;QACX,KAAK,MAAM,MAAM,IAAI,OAAO;YAC1B,IAAI,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;QAE7B,oCAAoC;QACpC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACtC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,MAAc,EAAE,SAAS,EAAE,EAAE,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;YACrG,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAoC,CAAC;YAC1D,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACzC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;gBAC5D,QAAQ,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;YAC9B,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,MAAM,CAAC,mBAAmB;QAChC,iBAAiB;QACjB,MAAM,QAAQ,GAAG,EAAE,GAAG,OAAO,CAAC,WAAW,EAAE,EAAwB,CAAC;QACpE,MAAM,WAAW,GAAI,QAA+C,CAAC;QACrE,sCAAsC;QACtC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC5C,WAAW,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,MAAM,CAAC,oBAAoB;QACjC,OAAO;YACL,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE;YACxB,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,WAAW,EAAE,IAAI,CAAC,mBAAmB,EAAE;SAChB,CAAC;IAC5B,CAAC;IAEO,MAAM,CAAC,eAAe;QAC5B,OAAO;YACL,QAAQ,EAAE,EAAE,CAAC,QAAQ,EAAE;YACvB,QAAQ,EAAE,EAAE,CAAC,QAAQ,EAAE;YACvB,QAAQ,EAAE,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;YAC9C,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC;YAC5C,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE;YACnB,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE;YACzB,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE;SACf,CAAC;IACvB,CAAC;IAED,kDAAkD;IAC3C,MAAM,CAAC,KAAK;QACjB,IAAI,CAAC;YACH,MAAM,KAAK,GAAG;gBACZ,EAAE,EAAE,IAAI,CAAC,eAAe,EAAE;gBAC1B,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE;aACpB,CAAC;YACnB,OAAO,KAAK,CAAC;QACf,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,kCAAkC,CAAC,CAAC;YACpE,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,uEAAuE;IAChE,MAAM,CAAC,WAAW,CAAC,gBAAwB,EAAE,QAAkB;QACpE,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QACnD,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,cAAc,EAAE,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;QACtH,MAAM,CAAC,QAAQ,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAC5C,YAAY,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC;QAC3C,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,iEAAiE;IAC1D,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,MAAM,aAAa,GAA4B,EAAE,CAAC;QAClD,OAAO;YACL,WAAW,EAAE,UAAU,CAAC,kBAAkB;YAC1C,OAAO,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC,OAAO,EAAE,4DAA4D;YAC5G,aAAa,EAAE,4BAA4B;SAC5C,CAAC;IACJ,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nimport * as os from \"os\";\nimport * as process from \"process\";\nimport { Logger, LogLevel } from \"@itwin/core-bentley\";\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\nimport { IModelHost } from \"./IModelHost\";\nimport { IModelNative } from \"./internal/NativePlatform\";\nimport { RpcInterfaceEndpoints } from \"@itwin/core-common\";\n\n// cspell:ignore ppid elap\n\nconst loggerCategory: string = BackendLoggerCategory.DevTools;\n\ninterface StringIndexedObject<T> {\n  [index: string]: T;\n}\n\n/**\n * Performance and Memory statistics of backend\n * @internal\n */\nexport interface DevToolsStats {\n  os: DevToolsOsStats;\n  process: DevToolsProcessStats;\n}\n\n/**\n * OS stats of backend\n * @internal\n */\nexport interface DevToolsOsStats {\n  platform: NodeJS.Platform;\n  hostname: string;\n  totalmem: number;\n  freemem: number;\n  uptime: number;\n  cpus: os.CpuInfo[];\n  cpuUsage: number;\n}\n\n/**\n * Process stats of backend\n * @internal\n */\nexport interface DevToolsProcessStats {\n  uptime: number;\n  pid: number;\n  ppid: number;\n  memoryUsage: NodeJS.MemoryUsage;\n}\n\n/** Utility to format the JSON created by DevTools.stats() to include the appropriate units\n * @internal\n */\nexport class DevToolsStatsFormatter {\n  private static readonly _megaByteProps = [\"totalmem\", \"freemem\", \"rss\", \"heapTotal\", \"heapUsed\", \"external\"];\n  private static readonly _percentProps = [\"user\", \"nice\", \"sys\", \"idle\", \"irq\", \"cpuUsage\"];\n  private static readonly _mHzProps = [\"speed\"];\n  private static readonly _secondsProps = [\"uptime\"];\n\n  /** Replacer that includes units - can be used with JSON.stringify()  */\n  private static _replacer = (key: string, value: any) => {\n    if (DevToolsStatsFormatter._megaByteProps.includes(key))\n      return `${value.toFixed()} MB`;\n    if (DevToolsStatsFormatter._percentProps.includes(key))\n      return `${value.toFixed()}%`;\n    if (DevToolsStatsFormatter._mHzProps.includes(key))\n      return `${value.toString()} MHz`;\n    if (DevToolsStatsFormatter._secondsProps.includes(key))\n      return `${value.toFixed()} secs`;\n    return value;\n  };\n\n  /** Converts the input stats to another JSON object with the appropriate units setup for various fields */\n  public static toFormattedJson(stats: any) {\n    // Serialize the stats to a string with a replacer that sets up units during the serialization\n    const statsStr = JSON.stringify(stats, DevToolsStatsFormatter._replacer);\n\n    // Deserialize back to JSON\n    return JSON.parse(statsStr);\n  }\n}\n\n/**\n * Internal diagnostic utility\n * @internal\n */\nexport class DevTools {\n\n  /** Receives a ping and returns true */\n  public static ping(): boolean {\n    Logger.logInfo(loggerCategory, \"Received ping at backend\");\n    return true;\n  }\n\n  private static hrtimeToMS(hrtime: any) {\n    return hrtime[0] * 1000 + hrtime[1] / 1000000;\n  }\n\n  private static bytesToMegaBytes(bytes: number): number {\n    const megaBytes = bytes / Math.pow(1024, 2);\n    return Math.round(megaBytes * 100) / 100;\n  }\n\n  private static evaluateCpuUsage(): number {\n    const NUMBER_OF_CPUS = os.cpus().length;\n    const startTime = process.hrtime();\n    const startUsage = process.cpuUsage();\n\n    // spin the CPU for 500 milliseconds\n    const now = Date.now();\n    while (Date.now() - now < 500)\n      ;\n\n    const elapTime = process.hrtime(startTime);\n    const elapUsage = process.cpuUsage(startUsage);\n\n    const elapTimeMS = this.hrtimeToMS(elapTime);\n\n    const elapUserMS = elapUsage.user / 1000; // microseconds to milliseconds\n    const elapSystMS = elapUsage.system / 1000;\n    const cpuPercent = Math.round((100 * (elapUserMS + elapSystMS) / elapTimeMS / NUMBER_OF_CPUS));\n\n    return cpuPercent;\n  }\n\n  private static evaluateCpus(): os.CpuInfo[] {\n    // Create a clone\n    const srcCpus = os.cpus();\n    const cpus = new Array<os.CpuInfo>(srcCpus.length);\n    let ii = 0;\n    for (const srcCpu of srcCpus)\n      cpus[ii++] = { ...srcCpu };\n\n    // Evaluate cpu usage as percentages\n    for (const cpu of Object.values(cpus)) {\n      const total = Object.values(cpu.times).reduce((_total: number, currValue) => _total += currValue, 0);\n      const cpuTimes = cpu.times as StringIndexedObject<number>;\n      for (const type of Object.keys(cpuTimes)) {\n        const cpuPercent = Math.round(100 * cpuTimes[type] / total);\n        cpuTimes[type] = cpuPercent;\n      }\n    }\n    return cpus;\n  }\n\n  private static evaluateMemoryUsage() {\n    // Create a clone\n    const memUsage = { ...process.memoryUsage() } as NodeJS.MemoryUsage;\n    const memUsageObj = (memUsage as any) as StringIndexedObject<number>;\n    // Evaluate memory usage as mega bytes\n    for (const type of Object.keys(memUsageObj)) {\n      memUsageObj[type] = this.bytesToMegaBytes(memUsageObj[type]);\n    }\n    return memUsage;\n  }\n\n  private static evaluateProcessStats(): DevToolsProcessStats {\n    return {\n      uptime: process.uptime(),\n      pid: process.pid,\n      ppid: process.ppid,\n      memoryUsage: this.evaluateMemoryUsage(),\n    } as DevToolsProcessStats;\n  }\n\n  private static evaluateOsStats(): DevToolsOsStats {\n    return {\n      platform: os.platform(),\n      hostname: os.hostname(),\n      totalmem: this.bytesToMegaBytes(os.totalmem()),\n      freemem: this.bytesToMegaBytes(os.freemem()),\n      uptime: os.uptime(),\n      cpus: this.evaluateCpus(),\n      cpuUsage: this.evaluateCpuUsage(),\n    } as DevToolsOsStats;\n  }\n\n  /** Returns JSON object with backend statistics */\n  public static stats(): DevToolsStats {\n    try {\n      const stats = {\n        os: this.evaluateOsStats(),\n        process: this.evaluateProcessStats(),\n      } as DevToolsStats;\n      return stats;\n    } catch (error) {\n      Logger.logError(loggerCategory, \"Could not fetch stats at backend\");\n      throw error;\n    }\n  }\n\n  /** Sets up a log level at the backend and returns the old log level */\n  public static setLogLevel(inLoggerCategory: string, newLevel: LogLevel): LogLevel | undefined {\n    const oldLevel = Logger.getLevel(inLoggerCategory);\n    Logger.logInfo(loggerCategory, `Setting log level`, () => ({ loggerCategory: inLoggerCategory, oldLevel, newLevel }));\n    Logger.setLevel(inLoggerCategory, newLevel);\n    IModelNative.platform.clearLogLevelCache();\n    return oldLevel;\n  }\n\n  /** Obtains the backend application and iTwin.js Core versions */\n  public static async versions() {\n    const availableRpcs: RpcInterfaceEndpoints[] = [];\n    return {\n      application: IModelHost.applicationVersion,\n      iTwinJs: require(\"../../package.json\").version, // eslint-disable-line @typescript-eslint/no-require-imports\n      availableRpcs, // filled in on the frontend\n    };\n  }\n}\n"]}

package/lib/esm/DisplayStyle.d.ts

@@ -0,0 +1,99 @@
+/** @packageDocumentation
+ * @module ViewDefinitions
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { Code, CodeScopeProps, ColorDef, DisplayStyle3dProps, DisplayStyle3dSettings, DisplayStyle3dSettingsProps, DisplayStyleProps, DisplayStyleSettings, EntityReferenceSet, RenderSchedule, ViewFlags } from "@itwin/core-common";
+import { DefinitionElement } from "./Element";
+import { IModelDb } from "./IModelDb";
+import { IModelElementCloneContext } from "./IModelElementCloneContext";
+/** A DisplayStyle defines the parameters for 'styling' the contents of a view.
+ * Internally a DisplayStyle consists of a dictionary of several named 'styles' describing specific aspects of the display style as a whole.
+ * Many ViewDefinitions may share the same DisplayStyle.
+ * @public
+ */
+export declare abstract class DisplayStyle extends DefinitionElement {
+    static get className(): string;
+    abstract get settings(): DisplayStyleSettings;
+    protected constructor(props: DisplayStyleProps, iModel: IModelDb);
+    /** Create a Code for a DisplayStyle given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModelDb
+     * @param scopeModelId The Id of the DefinitionModel that contains the DisplayStyle and provides the scope for its name.
+     * @param codeValue The DisplayStyle name
+     */
+    static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code;
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
+    /** @alpha */
+    protected static onCloned(context: IModelElementCloneContext, sourceElementProps: DisplayStyleProps, targetElementProps: DisplayStyleProps): void;
+    loadScheduleScript(): RenderSchedule.ScriptReference | undefined;
+}
+/** A DisplayStyle for 2d views.
+ * @public
+ */
+export declare class DisplayStyle2d extends DisplayStyle {
+    static get className(): string;
+    private readonly _settings;
+    get settings(): DisplayStyleSettings;
+    protected constructor(props: DisplayStyleProps, iModel: IModelDb);
+    /** Create a DisplayStyle2d for use by a ViewDefinition.
+     * @param iModelDb The iModel
+     * @param definitionModelId The [[DefinitionModel]]
+     * @param name The name/CodeValue of the DisplayStyle2d
+     * @returns The newly constructed DisplayStyle2d element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DisplayStyle2d;
+    /** Insert a DisplayStyle2d for use by a ViewDefinition.
+     * @param iModelDb Insert into this iModel
+     * @param definitionModelId Insert the new DisplayStyle2d into this DefinitionModel
+     * @param name The name of the DisplayStyle2d
+     * @returns The Id of the newly inserted DisplayStyle2d element.
+     * @throws [[IModelError]] if unable to insert the element.
+     */
+    static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string): Id64String;
+}
+/** Describes initial settings for a new [[DisplayStyle3d]].
+ * Most properties are inherited from [DisplayStyle3dSettingsProps]($common), but for backwards compatibility reasons, this interface is slightly awkward:
+ * - It adds a `viewFlags` member that differs only in case and type from [DisplayStyleSettingsProps.viewflags]($common); and
+ * - It extends the type of [DisplayStyleSettingsProps.backgroundColor]($common) to include [ColorDef]($common).
+ * These idiosyncrasies will be addressed in a future version of core-backend.
+ * @see [[DisplayStyle3d.create]].
+ * @public
+ */
+export interface DisplayStyleCreationOptions extends Omit<DisplayStyle3dSettingsProps, "backgroundColor" | "scheduleScript"> {
+    /** If supplied, the [ViewFlags]($common) applied by the display style.
+     * If undefined, [DisplayStyle3dSettingsProps.viewflags]($common) will be used if present (note the difference in case); otherwise, default-constructed [ViewFlags]($common) will be used.
+     */
+    viewFlags?: ViewFlags;
+    backgroundColor?: ColorDef | number;
+}
+/** A DisplayStyle for 3d views.
+ * See [how to create a DisplayStyle3d]$(docs/learning/backend/CreateElements.md#DisplayStyle3d).
+ * @public
+ */
+export declare class DisplayStyle3d extends DisplayStyle {
+    static get className(): string;
+    private readonly _settings;
+    get settings(): DisplayStyle3dSettings;
+    protected constructor(props: DisplayStyle3dProps, iModel: IModelDb);
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
+    /** @alpha */
+    protected static onCloned(context: IModelElementCloneContext, sourceElementProps: DisplayStyle3dProps, targetElementProps: DisplayStyle3dProps): void;
+    /** Create a DisplayStyle3d for use by a ViewDefinition.
+     * @param iModelDb The iModel
+     * @param definitionModelId The [[DefinitionModel]]
+     * @param name The name/CodeValue of the DisplayStyle3d
+     * @returns The newly constructed DisplayStyle3d element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): DisplayStyle3d;
+    /**
+     * Insert a DisplayStyle3d for use by a ViewDefinition.
+     * @param iModelDb Insert into this iModel
+     * @param definitionModelId Insert the new DisplayStyle3d into this [[DefinitionModel]]
+     * @param name The name of the DisplayStyle3d
+     * @returns The Id of the newly inserted DisplayStyle3d element.
+     * @throws [[IModelError]] if unable to insert the element.
+     */
+    static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): Id64String;
+}
+//# sourceMappingURL=DisplayStyle.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DisplayStyle.d.ts","sourceRoot":"","sources":["../../src/DisplayStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAsC,UAAU,EAAuB,MAAM,qBAAqB,CAAC;AAC1G,OAAO,EACQ,IAAI,EAAE,cAAc,EAAY,QAAQ,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,2BAA2B,EAC/H,iBAAiB,EAAE,oBAAoB,EAAgC,kBAAkB,EAA+B,cAAc,EAAoB,SAAS,EACpK,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAkB,MAAM,WAAW,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE;;;;GAIG;AACH,8BAAsB,YAAa,SAAQ,iBAAiB;IAC1D,WAA2B,SAAS,IAAI,MAAM,CAA2B;IACzE,aAAoB,QAAQ,IAAI,oBAAoB,CAAC;IAErD,SAAS,aAAa,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ;IAIhE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;cAK9E,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAkB9E,aAAa;qBACa,QAAQ,CAAC,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,iBAAiB,GAAG,IAAI;IAgDnJ,kBAAkB,IAAI,cAAc,CAAC,eAAe,GAAG,SAAS;CAgBxE;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAC3E,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAuB;IAEjD,IAAW,QAAQ,IAAI,oBAAoB,CAA2B;IAEtE,SAAS,aAAa,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ;IAIhE;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,cAAc;IAgBrG;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAIlG;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA4B,SAAQ,IAAI,CAAC,2BAA2B,EAAE,iBAAiB,GAAG,gBAAgB,CAAC;IAC1H;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,eAAe,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CACrC;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAC3E,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAyB;IAEnD,IAAW,QAAQ,IAAI,sBAAsB,CAA2B;IAExE,SAAS,aAAa,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;cAK/C,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAkB9E,aAAa;qBACa,QAAQ,CAAC,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,mBAAmB,GAAG,IAAI;IAgD9J;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,2BAA2B,GAAG,cAAc;IAyB5I;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,2BAA2B,GAAG,UAAU;CAIzI"}

package/lib/esm/DisplayStyle.js

@@ -0,0 +1,264 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module ViewDefinitions
+ */
+import { CompressedId64Set, Id64, OrderedId64Iterable } from "@itwin/core-bentley";
+import { BisCodeSpec, Code, ColorDef, DisplayStyle3dSettings, DisplayStyleSettings, RenderSchedule, ViewFlags, } from "@itwin/core-common";
+import { DefinitionElement, RenderTimeline } from "./Element";
+/** A DisplayStyle defines the parameters for 'styling' the contents of a view.
+ * Internally a DisplayStyle consists of a dictionary of several named 'styles' describing specific aspects of the display style as a whole.
+ * Many ViewDefinitions may share the same DisplayStyle.
+ * @public
+ */
+export class DisplayStyle extends DefinitionElement {
+    static get className() { return "DisplayStyle"; }
+    constructor(props, iModel) {
+        super(props, iModel);
+    }
+    /** Create a Code for a DisplayStyle given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModelDb
+     * @param scopeModelId The Id of the DefinitionModel that contains the DisplayStyle and provides the scope for its name.
+     * @param codeValue The DisplayStyle name
+     */
+    static createCode(iModel, scopeModelId, codeValue) {
+        const codeSpec = iModel.codeSpecs.getByName(BisCodeSpec.displayStyle);
+        return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
+    }
+    collectReferenceIds(referenceIds) {
+        super.collectReferenceIds(referenceIds);
+        for (const [id] of this.settings.subCategoryOverrides) {
+            referenceIds.addElement(id);
+        }
+        for (const excludedElementId of this.settings.excludedElementIds)
+            referenceIds.addElement(excludedElementId);
+        if (this.settings.renderTimeline) {
+            referenceIds.addElement(this.settings.renderTimeline);
+        }
+        else {
+            const script = this.loadScheduleScript();
+            if (script)
+                script.script.discloseIds(referenceIds);
+        }
+    }
+    /** @alpha */
+    static onCloned(context, sourceElementProps, targetElementProps) {
+        super.onCloned(context, sourceElementProps, targetElementProps);
+        if (!context.isBetweenIModels || !targetElementProps.jsonProperties?.styles)
+            return;
+        const settings = targetElementProps.jsonProperties.styles;
+        if (settings.subCategoryOvr) {
+            const targetOverrides = [];
+            for (const ovr of settings.subCategoryOvr) {
+                ovr.subCategory;
+                const targetSubCategoryId = context.findTargetElementId(Id64.fromJSON(ovr.subCategory));
+                if (Id64.isValid(targetSubCategoryId))
+                    targetOverrides.push({ ...ovr, subCategory: targetSubCategoryId });
+            }
+            settings.subCategoryOvr = targetOverrides;
+        }
+        if (settings.excludedElements) {
+            const excluded = "string" === typeof settings.excludedElements ? CompressedId64Set.decompressArray(settings.excludedElements) : settings.excludedElements;
+            const excludedTargetElements = [];
+            for (const excludedElement of excluded) {
+                const remapped = context.findTargetElementId(excludedElement);
+                if (Id64.isValid(remapped))
+                    excludedTargetElements.push(remapped);
+            }
+            if (0 === excludedTargetElements.length)
+                delete settings.excludedElements;
+            else
+                settings.excludedElements = CompressedId64Set.compressIds(OrderedId64Iterable.sortArray(excludedTargetElements));
+        }
+        if (settings.renderTimeline) {
+            const renderTimeline = context.findTargetElementId(settings.renderTimeline);
+            if (Id64.isValid(renderTimeline))
+                settings.renderTimeline = renderTimeline;
+            else
+                delete settings.renderTimeline;
+        }
+        else if (settings.scheduleScript) {
+            const scheduleScript = RenderTimeline.remapScript(context, settings.scheduleScript);
+            if (scheduleScript.length > 0)
+                settings.scheduleScript = scheduleScript;
+            else
+                delete settings.scheduleScript;
+        }
+    }
+    loadScheduleScript() {
+        let script;
+        let sourceId;
+        if (this.settings.renderTimeline) {
+            const timeline = this.iModel.elements.tryGetElement(this.settings.renderTimeline);
+            if (timeline) {
+                script = RenderSchedule.Script.fromJSON(timeline.scriptProps);
+                sourceId = timeline.id;
+            }
+        }
+        else if (this.settings.scheduleScriptProps) {
+            script = RenderSchedule.Script.fromJSON(this.settings.scheduleScriptProps);
+            sourceId = this.id;
+        }
+        return undefined !== sourceId && undefined !== script ? new RenderSchedule.ScriptReference(sourceId, script) : undefined;
+    }
+}
+/** A DisplayStyle for 2d views.
+ * @public
+ */
+export class DisplayStyle2d extends DisplayStyle {
+    static get className() { return "DisplayStyle2d"; }
+    _settings;
+    get settings() { return this._settings; }
+    constructor(props, iModel) {
+        super(props, iModel);
+        this._settings = new DisplayStyleSettings(this.jsonProperties);
+    }
+    /** Create a DisplayStyle2d for use by a ViewDefinition.
+     * @param iModelDb The iModel
+     * @param definitionModelId The [[DefinitionModel]]
+     * @param name The name/CodeValue of the DisplayStyle2d
+     * @returns The newly constructed DisplayStyle2d element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(iModelDb, definitionModelId, name) {
+        const displayStyleProps = {
+            classFullName: this.classFullName,
+            code: this.createCode(iModelDb, definitionModelId, name),
+            model: definitionModelId,
+            isPrivate: false,
+            jsonProperties: {
+                styles: {
+                    backgroundColor: 0,
+                    monochromeColor: ColorDef.white.toJSON(),
+                    viewflags: ViewFlags.defaults,
+                },
+            },
+        };
+        return new DisplayStyle2d(displayStyleProps, iModelDb);
+    }
+    /** Insert a DisplayStyle2d for use by a ViewDefinition.
+     * @param iModelDb Insert into this iModel
+     * @param definitionModelId Insert the new DisplayStyle2d into this DefinitionModel
+     * @param name The name of the DisplayStyle2d
+     * @returns The Id of the newly inserted DisplayStyle2d element.
+     * @throws [[IModelError]] if unable to insert the element.
+     */
+    static insert(iModelDb, definitionModelId, name) {
+        const displayStyle = this.create(iModelDb, definitionModelId, name);
+        return iModelDb.elements.insertElement(displayStyle.toJSON());
+    }
+}
+/** A DisplayStyle for 3d views.
+ * See [how to create a DisplayStyle3d]$(docs/learning/backend/CreateElements.md#DisplayStyle3d).
+ * @public
+ */
+export class DisplayStyle3d extends DisplayStyle {
+    static get className() { return "DisplayStyle3d"; }
+    _settings;
+    get settings() { return this._settings; }
+    constructor(props, iModel) {
+        super(props, iModel);
+        this._settings = new DisplayStyle3dSettings(this.jsonProperties);
+    }
+    collectReferenceIds(referenceIds) {
+        super.collectReferenceIds(referenceIds);
+        for (const textureId of this.settings.environment.sky.textureIds)
+            referenceIds.addElement(textureId);
+        if (this.settings.planProjectionSettings)
+            for (const planProjectionSetting of this.settings.planProjectionSettings)
+                referenceIds.addElement(planProjectionSetting[0]);
+        const groups = this.settings.contours.groups;
+        for (const group of groups) {
+            const subCategories = group.subCategories;
+            for (const subCategoryId of subCategories) {
+                referenceIds.addElement(subCategoryId);
+            }
+        }
+    }
+    /** @alpha */
+    static onCloned(context, sourceElementProps, targetElementProps) {
+        super.onCloned(context, sourceElementProps, targetElementProps);
+        if (context.isBetweenIModels) {
+            const convertTexture = (id) => Id64.isValidId64(id) ? context.findTargetElementId(id) : id;
+            const skyBoxImageProps = targetElementProps?.jsonProperties?.styles?.environment?.sky?.image;
+            if (skyBoxImageProps?.texture && Id64.isValidId64(skyBoxImageProps.texture))
+                skyBoxImageProps.texture = convertTexture(skyBoxImageProps.texture);
+            if (skyBoxImageProps?.textures) {
+                skyBoxImageProps.textures.front = convertTexture(skyBoxImageProps.textures.front);
+                skyBoxImageProps.textures.back = convertTexture(skyBoxImageProps.textures.back);
+                skyBoxImageProps.textures.left = convertTexture(skyBoxImageProps.textures.left);
+                skyBoxImageProps.textures.right = convertTexture(skyBoxImageProps.textures.right);
+                skyBoxImageProps.textures.top = convertTexture(skyBoxImageProps.textures.top);
+                skyBoxImageProps.textures.bottom = convertTexture(skyBoxImageProps.textures.bottom);
+            }
+            if (targetElementProps?.jsonProperties?.styles?.planProjections) {
+                const remappedPlanProjections = {};
+                for (const entry of Object.entries(targetElementProps.jsonProperties.styles.planProjections)) {
+                    const remappedModelId = context.findTargetElementId(entry[0]);
+                    if (Id64.isValidId64(remappedModelId)) {
+                        remappedPlanProjections[remappedModelId] = entry[1];
+                    }
+                }
+                targetElementProps.jsonProperties.styles.planProjections = remappedPlanProjections;
+            }
+            const groups = targetElementProps?.jsonProperties?.styles?.contours?.groups;
+            if (groups) {
+                for (const group of groups) {
+                    if (group.subCategories) {
+                        const subCategories = CompressedId64Set.decompressArray(group.subCategories);
+                        const remappedSubCategories = [];
+                        for (const subCategoryId of subCategories) {
+                            const remappedSubCategoryId = context.findTargetElementId(subCategoryId);
+                            if (Id64.isValidId64(remappedSubCategoryId)) {
+                                remappedSubCategories.push(remappedSubCategoryId);
+                            }
+                        }
+                        group.subCategories = CompressedId64Set.sortAndCompress(remappedSubCategories);
+                    }
+                }
+            }
+        }
+    }
+    /** Create a DisplayStyle3d for use by a ViewDefinition.
+     * @param iModelDb The iModel
+     * @param definitionModelId The [[DefinitionModel]]
+     * @param name The name/CodeValue of the DisplayStyle3d
+     * @returns The newly constructed DisplayStyle3d element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(iModelDb, definitionModelId, name, options) {
+        options = options ?? {};
+        let viewflags = options.viewFlags?.toJSON();
+        if (!viewflags)
+            viewflags = options.viewflags ?? new ViewFlags().toJSON();
+        const backgroundColor = options.backgroundColor instanceof ColorDef ? options.backgroundColor.toJSON() : options.backgroundColor;
+        const settings = {
+            ...options,
+            viewflags,
+            backgroundColor,
+        };
+        const displayStyleProps = {
+            classFullName: this.classFullName,
+            code: this.createCode(iModelDb, definitionModelId, name),
+            model: definitionModelId,
+            jsonProperties: { styles: settings },
+            isPrivate: false,
+        };
+        return new DisplayStyle3d(displayStyleProps, iModelDb);
+    }
+    /**
+     * Insert a DisplayStyle3d for use by a ViewDefinition.
+     * @param iModelDb Insert into this iModel
+     * @param definitionModelId Insert the new DisplayStyle3d into this [[DefinitionModel]]
+     * @param name The name of the DisplayStyle3d
+     * @returns The Id of the newly inserted DisplayStyle3d element.
+     * @throws [[IModelError]] if unable to insert the element.
+     */
+    static insert(iModelDb, definitionModelId, name, options) {
+        const displayStyle = this.create(iModelDb, definitionModelId, name, options);
+        return iModelDb.elements.insertElement(displayStyle.toJSON());
+    }
+}
+//# sourceMappingURL=DisplayStyle.js.map

package/lib/esm/DisplayStyle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DisplayStyle.js","sourceRoot":"","sources":["../../src/DisplayStyle.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAyB,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1G,OAAO,EACL,WAAW,EAAE,IAAI,EAA4B,QAAQ,EAAuB,sBAAsB,EAC/E,oBAAoB,EAAiF,cAAc,EAAoB,SAAS,GACpK,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAI9D;;;;GAIG;AACH,MAAM,OAAgB,YAAa,SAAQ,iBAAiB;IACnD,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;IAGzE,YAAsB,KAAwB,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAChF,OAAO,IAAI,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,KAAK,MAAM,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;YACtD,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAC9B,CAAC;QAED,KAAK,MAAM,iBAAiB,IAAI,IAAI,CAAC,QAAQ,CAAC,kBAAkB;YAC9D,YAAY,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;QAE7C,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;YACjC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACzC,IAAI,MAAM;gBACR,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,aAAa;IACH,MAAM,CAAU,QAAQ,CAAC,OAAkC,EAAE,kBAAqC,EAAE,kBAAqC;QACjJ,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;QAEhE,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,CAAC,kBAAkB,CAAC,cAAc,EAAE,MAAM;YACzE,OAAO;QAET,MAAM,QAAQ,GAAG,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC;QAC1D,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;YAC5B,MAAM,eAAe,GAAmC,EAAE,CAAC;YAC3D,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;gBAC1C,GAAG,CAAC,WAAW,CAAC;gBAChB,MAAM,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;gBACxF,IAAI,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC;oBACnC,eAAe,CAAC,IAAI,CAAC,EAAC,GAAG,GAAG,EAAE,WAAW,EAAE,mBAAmB,EAAC,CAAC,CAAC;YACrE,CAAC;YACD,QAAQ,CAAC,cAAc,GAAG,eAAe,CAAC;QAC5C,CAAC;QAED,IAAI,QAAQ,CAAC,gBAAgB,EAAE,CAAC;YAC9B,MAAM,QAAQ,GAAc,QAAQ,KAAK,OAAO,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,iBAAiB,CAAC,eAAe,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YACrK,MAAM,sBAAsB,GAAc,EAAE,CAAC;YAC7C,KAAK,MAAM,eAAe,IAAI,QAAQ,EAAE,CAAC;gBACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;gBAC9D,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;oBACxB,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC1C,CAAC;YAED,IAAI,CAAC,KAAK,sBAAsB,CAAC,MAAM;gBACrC,OAAO,QAAQ,CAAC,gBAAgB,CAAC;;gBAEjC,QAAQ,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,WAAW,CAAC,mBAAmB,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACrH,CAAC;QAED,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;YAC5B,MAAM,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YAC5E,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;gBAC9B,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;;gBAEzC,OAAO,QAAQ,CAAC,cAAc,CAAC;QACnC,CAAC;aAAM,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;YACnC,MAAM,cAAc,GAAG,cAAc,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;YACpF,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC;gBAC3B,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;;gBAEzC,OAAO,QAAQ,CAAC,cAAc,CAAC;QACnC,CAAC;IACH,CAAC;IAEM,kBAAkB;QACvB,IAAI,MAAM,CAAC;QACX,IAAI,QAAQ,CAAC;QACb,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAiB,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YAClG,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;gBAC9D,QAAQ,GAAG,QAAQ,CAAC,EAAE,CAAC;YACzB,CAAC;QACH,CAAC;aAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,mBAAmB,EAAE,CAAC;YAC7C,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;YAC3E,QAAQ,GAAG,IAAI,CAAC,EAAE,CAAC;QACrB,CAAC;QAED,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3H,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,YAAY;IACvC,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAC1D,SAAS,CAAuB;IAEjD,IAAW,QAAQ,KAA2B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEtE,YAAsB,KAAwB,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACjE,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,iBAAiB,GAAsB;YAC3C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,KAAK,EAAE,iBAAiB;YACxB,SAAS,EAAE,KAAK;YAChB,cAAc,EAAE;gBACd,MAAM,EAAE;oBACN,eAAe,EAAE,CAAC;oBAClB,eAAe,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE;oBACxC,SAAS,EAAE,SAAS,CAAC,QAAQ;iBAC9B;aACF;SACF,CAAC;QACF,OAAO,IAAI,cAAc,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AAkBD;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,YAAY;IACvC,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAC1D,SAAS,CAAyB;IAEnD,IAAW,QAAQ,KAA6B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAExE,YAAsB,KAA0B,EAAE,MAAgB;QAChE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,sBAAsB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACnE,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU;YAC9D,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAErC,IAAI,IAAI,CAAC,QAAQ,CAAC,sBAAsB;YACtC,KAAK,MAAM,qBAAqB,IAAI,IAAI,CAAC,QAAQ,CAAC,sBAAsB;gBACtE,YAAY,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;QAEtD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC7C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;YAC1C,KAAK,MAAM,aAAa,IAAI,aAAa,EAAE,CAAC;gBAC1C,YAAY,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;IACH,CAAC;IAED,aAAa;IACH,MAAM,CAAU,QAAQ,CAAC,OAAkC,EAAE,kBAAuC,EAAE,kBAAuC;QACrJ,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;QAChE,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC7B,MAAM,cAAc,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAEnG,MAAM,gBAAgB,GAAiC,kBAAkB,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,KAAK,CAAC;YAC3H,IAAI,gBAAgB,EAAE,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC;gBACzE,gBAAgB,CAAC,OAAO,GAAG,cAAc,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAEtE,IAAI,gBAAgB,EAAE,QAAQ,EAAE,CAAC;gBAC/B,gBAAgB,CAAC,QAAQ,CAAC,KAAK,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAClF,gBAAgB,CAAC,QAAQ,CAAC,IAAI,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAChF,gBAAgB,CAAC,QAAQ,CAAC,IAAI,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAChF,gBAAgB,CAAC,QAAQ,CAAC,KAAK,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAClF,gBAAgB,CAAC,QAAQ,CAAC,GAAG,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAC9E,gBAAgB,CAAC,QAAQ,CAAC,MAAM,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACtF,CAAC;YAED,IAAI,kBAAkB,EAAE,cAAc,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC;gBAChE,MAAM,uBAAuB,GAAuD,EAAE,CAAC;gBACvF,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;oBAC7F,MAAM,eAAe,GAAe,OAAO,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC1E,IAAI,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE,CAAC;wBACtC,uBAAuB,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;oBACtD,CAAC;gBACH,CAAC;gBACD,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,eAAe,GAAG,uBAAuB,CAAC;YACrF,CAAC;YAED,MAAM,MAAM,GAAG,kBAAkB,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC;YAC5E,IAAI,MAAM,EAAE,CAAC;gBACX,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;oBAC3B,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;wBACxB,MAAM,aAAa,GAAG,iBAAiB,CAAC,eAAe,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;wBAC7E,MAAM,qBAAqB,GAAiB,EAAE,CAAC;wBAC/C,KAAK,MAAM,aAAa,IAAI,aAAa,EAAE,CAAC;4BAC1C,MAAM,qBAAqB,GAAe,OAAO,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;4BACrF,IAAI,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC,EAAE,CAAC;gCAC5C,qBAAqB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;4BACpD,CAAC;wBACH,CAAC;wBACD,KAAK,CAAC,aAAa,GAAG,iBAAiB,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC;oBACjF,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,OAAqC;QACzH,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC;QAC5C,IAAI,CAAC,SAAS;YACZ,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,SAAS,EAAE,CAAC,MAAM,EAAE,CAAC;QAE5D,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,YAAY,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;QAEjI,MAAM,QAAQ,GAAgC;YAC5C,GAAG,OAAO;YACV,SAAS;YACT,eAAe;SAChB,CAAC;QAEF,MAAM,iBAAiB,GAAwB;YAC7C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,KAAK,EAAE,iBAAiB;YACxB,cAAc,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE;YACpC,SAAS,EAAE,KAAK;SAEjB,CAAC;QAEF,OAAO,IAAI,cAAc,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,OAAqC;QACzH,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7E,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module ViewDefinitions\n */\n\nimport { CompressedId64Set, Id64, Id64Array, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\nimport {\n  BisCodeSpec, Code, CodeScopeProps, CodeSpec, ColorDef, DisplayStyle3dProps, DisplayStyle3dSettings, DisplayStyle3dSettingsProps,\n  DisplayStyleProps, DisplayStyleSettings, DisplayStyleSubCategoryProps, EntityReferenceSet, PlanProjectionSettingsProps, RenderSchedule, SkyBoxImageProps, ViewFlags,\n} from \"@itwin/core-common\";\nimport { DefinitionElement, RenderTimeline } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\nimport { IModelElementCloneContext } from \"./IModelElementCloneContext\";\n\n/** A DisplayStyle defines the parameters for 'styling' the contents of a view.\n * Internally a DisplayStyle consists of a dictionary of several named 'styles' describing specific aspects of the display style as a whole.\n * Many ViewDefinitions may share the same DisplayStyle.\n * @public\n */\nexport abstract class DisplayStyle extends DefinitionElement {\n  public static override get className(): string { return \"DisplayStyle\"; }\n  public abstract get settings(): DisplayStyleSettings;\n\n  protected constructor(props: DisplayStyleProps, iModel: IModelDb) {\n    super(props, iModel);\n  }\n\n  /** Create a Code for a DisplayStyle given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModelDb\n   * @param scopeModelId The Id of the DefinitionModel that contains the DisplayStyle and provides the scope for its name.\n   * @param codeValue The DisplayStyle name\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.displayStyle);\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    for (const [id] of this.settings.subCategoryOverrides) {\n      referenceIds.addElement(id);\n    }\n\n    for (const excludedElementId of this.settings.excludedElementIds)\n      referenceIds.addElement(excludedElementId);\n\n    if (this.settings.renderTimeline) {\n      referenceIds.addElement(this.settings.renderTimeline);\n    } else {\n      const script = this.loadScheduleScript();\n      if (script)\n        script.script.discloseIds(referenceIds);\n    }\n  }\n\n  /** @alpha */\n  protected static override onCloned(context: IModelElementCloneContext, sourceElementProps: DisplayStyleProps, targetElementProps: DisplayStyleProps): void {\n    super.onCloned(context, sourceElementProps, targetElementProps);\n\n    if (!context.isBetweenIModels || !targetElementProps.jsonProperties?.styles)\n      return;\n\n    const settings = targetElementProps.jsonProperties.styles;\n    if (settings.subCategoryOvr) {\n      const targetOverrides: DisplayStyleSubCategoryProps[] = [];\n      for (const ovr of settings.subCategoryOvr) {\n        ovr.subCategory;\n        const targetSubCategoryId = context.findTargetElementId(Id64.fromJSON(ovr.subCategory));\n        if (Id64.isValid(targetSubCategoryId))\n          targetOverrides.push({...ovr, subCategory: targetSubCategoryId});\n      }\n      settings.subCategoryOvr = targetOverrides;\n    }\n\n    if (settings.excludedElements) {\n      const excluded: Id64Array = \"string\" === typeof settings.excludedElements ? CompressedId64Set.decompressArray(settings.excludedElements) : settings.excludedElements;\n      const excludedTargetElements: Id64Array = [];\n      for (const excludedElement of excluded) {\n        const remapped = context.findTargetElementId(excludedElement);\n        if (Id64.isValid(remapped))\n          excludedTargetElements.push(remapped);\n      }\n\n      if (0 === excludedTargetElements.length)\n        delete settings.excludedElements;\n      else\n        settings.excludedElements = CompressedId64Set.compressIds(OrderedId64Iterable.sortArray(excludedTargetElements));\n    }\n\n    if (settings.renderTimeline) {\n      const renderTimeline = context.findTargetElementId(settings.renderTimeline);\n      if (Id64.isValid(renderTimeline))\n        settings.renderTimeline = renderTimeline;\n      else\n        delete settings.renderTimeline;\n    } else if (settings.scheduleScript) {\n      const scheduleScript = RenderTimeline.remapScript(context, settings.scheduleScript);\n      if (scheduleScript.length > 0)\n        settings.scheduleScript = scheduleScript;\n      else\n        delete settings.scheduleScript;\n    }\n  }\n\n  public loadScheduleScript(): RenderSchedule.ScriptReference | undefined {\n    let script;\n    let sourceId;\n    if (this.settings.renderTimeline) {\n      const timeline = this.iModel.elements.tryGetElement<RenderTimeline>(this.settings.renderTimeline);\n      if (timeline) {\n        script = RenderSchedule.Script.fromJSON(timeline.scriptProps);\n        sourceId = timeline.id;\n      }\n    } else if (this.settings.scheduleScriptProps) {\n      script = RenderSchedule.Script.fromJSON(this.settings.scheduleScriptProps);\n      sourceId = this.id;\n    }\n\n    return undefined !== sourceId && undefined !== script ? new RenderSchedule.ScriptReference(sourceId, script) : undefined;\n  }\n}\n\n/** A DisplayStyle for 2d views.\n * @public\n */\nexport class DisplayStyle2d extends DisplayStyle {\n  public static override get className(): string { return \"DisplayStyle2d\"; }\n  private readonly _settings: DisplayStyleSettings;\n\n  public get settings(): DisplayStyleSettings { return this._settings; }\n\n  protected constructor(props: DisplayStyleProps, iModel: IModelDb) {\n    super(props, iModel);\n    this._settings = new DisplayStyleSettings(this.jsonProperties);\n  }\n  /** Create a DisplayStyle2d for use by a ViewDefinition.\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name/CodeValue of the DisplayStyle2d\n   * @returns The newly constructed DisplayStyle2d element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DisplayStyle2d {\n    const displayStyleProps: DisplayStyleProps = {\n      classFullName: this.classFullName,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      model: definitionModelId,\n      isPrivate: false,\n      jsonProperties: {\n        styles: {\n          backgroundColor: 0,\n          monochromeColor: ColorDef.white.toJSON(),\n          viewflags: ViewFlags.defaults,\n        },\n      },\n    };\n    return new DisplayStyle2d(displayStyleProps, iModelDb);\n  }\n  /** Insert a DisplayStyle2d for use by a ViewDefinition.\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new DisplayStyle2d into this DefinitionModel\n   * @param name The name of the DisplayStyle2d\n   * @returns The Id of the newly inserted DisplayStyle2d element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string): Id64String {\n    const displayStyle = this.create(iModelDb, definitionModelId, name);\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\n  }\n}\n\n/** Describes initial settings for a new [[DisplayStyle3d]].\n * Most properties are inherited from [DisplayStyle3dSettingsProps]($common), but for backwards compatibility reasons, this interface is slightly awkward:\n * - It adds a `viewFlags` member that differs only in case and type from [DisplayStyleSettingsProps.viewflags]($common); and\n * - It extends the type of [DisplayStyleSettingsProps.backgroundColor]($common) to include [ColorDef]($common).\n * These idiosyncrasies will be addressed in a future version of core-backend.\n * @see [[DisplayStyle3d.create]].\n * @public\n */\nexport interface DisplayStyleCreationOptions extends Omit<DisplayStyle3dSettingsProps, \"backgroundColor\" | \"scheduleScript\"> {\n  /** If supplied, the [ViewFlags]($common) applied by the display style.\n   * If undefined, [DisplayStyle3dSettingsProps.viewflags]($common) will be used if present (note the difference in case); otherwise, default-constructed [ViewFlags]($common) will be used.\n   */\n  viewFlags?: ViewFlags;\n  backgroundColor?: ColorDef | number;\n}\n\n/** A DisplayStyle for 3d views.\n * See [how to create a DisplayStyle3d]$(docs/learning/backend/CreateElements.md#DisplayStyle3d).\n * @public\n */\nexport class DisplayStyle3d extends DisplayStyle {\n  public static override get className(): string { return \"DisplayStyle3d\"; }\n  private readonly _settings: DisplayStyle3dSettings;\n\n  public get settings(): DisplayStyle3dSettings { return this._settings; }\n\n  protected constructor(props: DisplayStyle3dProps, iModel: IModelDb) {\n    super(props, iModel);\n    this._settings = new DisplayStyle3dSettings(this.jsonProperties);\n  }\n\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    for (const textureId of this.settings.environment.sky.textureIds)\n      referenceIds.addElement(textureId);\n\n    if (this.settings.planProjectionSettings)\n      for (const planProjectionSetting of this.settings.planProjectionSettings)\n        referenceIds.addElement(planProjectionSetting[0]);\n\n    const groups = this.settings.contours.groups;\n    for (const group of groups) {\n      const subCategories = group.subCategories;\n      for (const subCategoryId of subCategories) {\n        referenceIds.addElement(subCategoryId);\n      }\n    }\n  }\n\n  /** @alpha */\n  protected static override onCloned(context: IModelElementCloneContext, sourceElementProps: DisplayStyle3dProps, targetElementProps: DisplayStyle3dProps): void {\n    super.onCloned(context, sourceElementProps, targetElementProps);\n    if (context.isBetweenIModels) {\n      const convertTexture = (id: string) => Id64.isValidId64(id) ? context.findTargetElementId(id) : id;\n\n      const skyBoxImageProps: SkyBoxImageProps | undefined = targetElementProps?.jsonProperties?.styles?.environment?.sky?.image;\n      if (skyBoxImageProps?.texture && Id64.isValidId64(skyBoxImageProps.texture))\n        skyBoxImageProps.texture = convertTexture(skyBoxImageProps.texture);\n\n      if (skyBoxImageProps?.textures) {\n        skyBoxImageProps.textures.front = convertTexture(skyBoxImageProps.textures.front);\n        skyBoxImageProps.textures.back = convertTexture(skyBoxImageProps.textures.back);\n        skyBoxImageProps.textures.left = convertTexture(skyBoxImageProps.textures.left);\n        skyBoxImageProps.textures.right = convertTexture(skyBoxImageProps.textures.right);\n        skyBoxImageProps.textures.top = convertTexture(skyBoxImageProps.textures.top);\n        skyBoxImageProps.textures.bottom = convertTexture(skyBoxImageProps.textures.bottom);\n      }\n\n      if (targetElementProps?.jsonProperties?.styles?.planProjections) {\n        const remappedPlanProjections: { [modelId: string]: PlanProjectionSettingsProps } = {};\n        for (const entry of Object.entries(targetElementProps.jsonProperties.styles.planProjections)) {\n          const remappedModelId: Id64String = context.findTargetElementId(entry[0]);\n          if (Id64.isValidId64(remappedModelId)) {\n            remappedPlanProjections[remappedModelId] = entry[1];\n          }\n        }\n        targetElementProps.jsonProperties.styles.planProjections = remappedPlanProjections;\n      }\n\n      const groups = targetElementProps?.jsonProperties?.styles?.contours?.groups;\n      if (groups) {\n        for (const group of groups) {\n          if (group.subCategories) {\n            const subCategories = CompressedId64Set.decompressArray(group.subCategories);\n            const remappedSubCategories: Id64String[] = [];\n            for (const subCategoryId of subCategories) {\n              const remappedSubCategoryId: Id64String = context.findTargetElementId(subCategoryId);\n              if (Id64.isValidId64(remappedSubCategoryId)) {\n                remappedSubCategories.push(remappedSubCategoryId);\n              }\n            }\n            group.subCategories = CompressedId64Set.sortAndCompress(remappedSubCategories);\n          }\n        }\n      }\n    }\n  }\n\n  /** Create a DisplayStyle3d for use by a ViewDefinition.\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name/CodeValue of the DisplayStyle3d\n   * @returns The newly constructed DisplayStyle3d element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): DisplayStyle3d {\n    options = options ?? {};\n    let viewflags = options.viewFlags?.toJSON();\n    if (!viewflags)\n      viewflags = options.viewflags ?? new ViewFlags().toJSON();\n\n    const backgroundColor = options.backgroundColor instanceof ColorDef ? options.backgroundColor.toJSON() : options.backgroundColor;\n\n    const settings: DisplayStyle3dSettingsProps = {\n      ...options,\n      viewflags,\n      backgroundColor,\n    };\n\n    const displayStyleProps: DisplayStyle3dProps = {\n      classFullName: this.classFullName,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      model: definitionModelId,\n      jsonProperties: { styles: settings },\n      isPrivate: false,\n\n    };\n\n    return new DisplayStyle3d(displayStyleProps, iModelDb);\n  }\n  /**\n   * Insert a DisplayStyle3d for use by a ViewDefinition.\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new DisplayStyle3d into this [[DefinitionModel]]\n   * @param name The name of the DisplayStyle3d\n   * @returns The Id of the newly inserted DisplayStyle3d element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): Id64String {\n    const displayStyle = this.create(iModelDb, definitionModelId, name, options);\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\n  }\n}\n"]}