@itwin/core-backend 4.0.0-dev.52 → 4.0.0-dev.55

package/lib/cjs/DevTools.js.map

@@ -1 +1 @@
-{"version":3,"file":"DevTools.js","sourceRoot":"","sources":["../../src/DevTools.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,yBAAyB;AACzB,mCAAmC;AACnC,sDAAuD;AACvD,mEAAgE;AAChE,6CAA0C;AAG1C,0BAA0B;AAE1B,MAAM,cAAc,GAAW,6CAAqB,CAAC,QAAQ,CAAC;AAwC9D;;GAEG;AACH,MAAa,sBAAsB;IAmBjC,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;;AA1BH,wDA2BC;AA1ByB,qCAAc,GAAG,CAAC,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;AACrF,oCAAa,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;AACnE,gCAAS,GAAG,CAAC,OAAO,CAAC,CAAC;AACtB,oCAAa,GAAG,CAAC,QAAQ,CAAC,CAAC;AAEnD,wEAAwE;AACzD,gCAAS,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,EAAE;IACrD,IAAI,sBAAsB,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC;QACrD,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC;IACjC,IAAI,sBAAsB,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC;QACpD,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC;IAC/B,IAAI,sBAAsB,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC;QAChD,OAAO,GAAG,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC;IACnC,IAAI,sBAAsB,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC;QACpD,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC;IACnC,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAYJ;;;GAGG;AACH,MAAa,QAAQ;IAEnB,uCAAuC;IAChC,MAAM,CAAC,IAAI;QAChB,qBAAM,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;YACrC,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;gBACxC,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;aAC7B;SACF;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;YAC3C,WAAW,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;SAC9D;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;YACF,MAAM,KAAK,GAAG;gBACZ,EAAE,EAAE,IAAI,CAAC,eAAe,EAAE;gBAC1B,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE;aACpB,CAAC;YACnB,OAAO,KAAK,CAAC;SACd;QAAC,OAAO,KAAK,EAAE;YACd,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,kCAAkC,CAAC,CAAC;YACpE,MAAM,KAAK,CAAC;SACb;IACH,CAAC;IAED,uEAAuE;IAChE,MAAM,CAAC,WAAW,CAAC,gBAAwB,EAAE,QAAkB;QACpE,MAAM,QAAQ,GAAG,qBAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QACnD,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,cAAc,EAAE,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;QACtH,qBAAM,CAAC,QAAQ,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAC5C,uBAAU,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC;QACzC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,iEAAiE;IAC1D,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,MAAM,aAAa,GAA4B,EAAE,CAAC;QAClD,OAAO;YACL,WAAW,EAAE,uBAAU,CAAC,kBAAkB;YAC1C,OAAO,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC,OAAO;YAC9C,aAAa,EAAE,4BAA4B;SAC5C,CAAC;IACJ,CAAC;CACF;AA3HD,4BA2HC","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\r\nimport * as os from \"os\";\r\nimport * as process from \"process\";\r\nimport { Logger, LogLevel } from \"@itwin/core-bentley\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { RpcInterfaceEndpoints } from \"@itwin/core-common\";\r\n\r\n// cspell:ignore ppid elap\r\n\r\nconst loggerCategory: string = BackendLoggerCategory.DevTools;\r\n\r\ninterface StringIndexedObject<T> {\r\n  [index: string]: T;\r\n}\r\n\r\n/**\r\n * Performance and Memory statistics of backend\r\n * @internal\r\n */\r\nexport interface DevToolsStats {\r\n  os: DevToolsOsStats;\r\n  process: DevToolsProcessStats;\r\n}\r\n\r\n/**\r\n * OS stats of backend\r\n * @internal\r\n */\r\nexport interface DevToolsOsStats {\r\n  platform: NodeJS.Platform;\r\n  hostname: string;\r\n  totalmem: number;\r\n  freemem: number;\r\n  uptime: number;\r\n  cpus: os.CpuInfo[];\r\n  cpuUsage: number;\r\n}\r\n\r\n/**\r\n * Process stats of backend\r\n * @internal\r\n */\r\nexport interface DevToolsProcessStats {\r\n  uptime: number;\r\n  pid: number;\r\n  ppid: number;\r\n  memoryUsage: NodeJS.MemoryUsage;\r\n}\r\n\r\n/** Utility to format the JSON created by DevTools.stats() to include the appropriate units\r\n * @internal\r\n */\r\nexport class DevToolsStatsFormatter {\r\n  private static readonly _megaByteProps = [\"totalmem\", \"freemem\", \"rss\", \"heapTotal\", \"heapUsed\", \"external\"];\r\n  private static readonly _percentProps = [\"user\", \"nice\", \"sys\", \"idle\", \"irq\", \"cpuUsage\"];\r\n  private static readonly _mHzProps = [\"speed\"];\r\n  private static readonly _secondsProps = [\"uptime\"];\r\n\r\n  /** Replacer that includes units - can be used with JSON.stringify()  */\r\n  private static _replacer = (key: string, value: any) => {\r\n    if (DevToolsStatsFormatter._megaByteProps.includes(key))\r\n      return `${value.toFixed()} MB`;\r\n    if (DevToolsStatsFormatter._percentProps.includes(key))\r\n      return `${value.toFixed()}%`;\r\n    if (DevToolsStatsFormatter._mHzProps.includes(key))\r\n      return `${value.toString()} MHz`;\r\n    if (DevToolsStatsFormatter._secondsProps.includes(key))\r\n      return `${value.toFixed()} secs`;\r\n    return value;\r\n  };\r\n\r\n  /** Converts the input stats to another JSON object with the appropriate units setup for various fields */\r\n  public static toFormattedJson(stats: any) {\r\n    // Serialize the stats to a string with a replacer that sets up units during the serialization\r\n    const statsStr = JSON.stringify(stats, DevToolsStatsFormatter._replacer);\r\n\r\n    // Deserialize back to JSON\r\n    return JSON.parse(statsStr);\r\n  }\r\n}\r\n\r\n/**\r\n * Internal diagnostic utility\r\n * @internal\r\n */\r\nexport class DevTools {\r\n\r\n  /** Receives a ping and returns true */\r\n  public static ping(): boolean {\r\n    Logger.logInfo(loggerCategory, \"Received ping at backend\");\r\n    return true;\r\n  }\r\n\r\n  private static hrtimeToMS(hrtime: any) {\r\n    return hrtime[0] * 1000 + hrtime[1] / 1000000;\r\n  }\r\n\r\n  private static bytesToMegaBytes(bytes: number): number {\r\n    const megaBytes = bytes / Math.pow(1024, 2);\r\n    return Math.round(megaBytes * 100) / 100;\r\n  }\r\n\r\n  private static evaluateCpuUsage(): number {\r\n    const NUMBER_OF_CPUS = os.cpus().length;\r\n    const startTime = process.hrtime();\r\n    const startUsage = process.cpuUsage();\r\n\r\n    // spin the CPU for 500 milliseconds\r\n    const now = Date.now();\r\n    while (Date.now() - now < 500)\r\n      ;\r\n\r\n    const elapTime = process.hrtime(startTime);\r\n    const elapUsage = process.cpuUsage(startUsage);\r\n\r\n    const elapTimeMS = this.hrtimeToMS(elapTime);\r\n\r\n    const elapUserMS = elapUsage.user / 1000; // microseconds to milliseconds\r\n    const elapSystMS = elapUsage.system / 1000;\r\n    const cpuPercent = Math.round((100 * (elapUserMS + elapSystMS) / elapTimeMS / NUMBER_OF_CPUS));\r\n\r\n    return cpuPercent;\r\n  }\r\n\r\n  private static evaluateCpus(): os.CpuInfo[] {\r\n    // Create a clone\r\n    const srcCpus = os.cpus();\r\n    const cpus = new Array<os.CpuInfo>(srcCpus.length);\r\n    let ii = 0;\r\n    for (const srcCpu of srcCpus)\r\n      cpus[ii++] = { ...srcCpu };\r\n\r\n    // Evaluate cpu usage as percentages\r\n    for (const cpu of Object.values(cpus)) {\r\n      const total = Object.values(cpu.times).reduce((_total: number, currValue) => _total += currValue, 0);\r\n      const cpuTimes = cpu.times as StringIndexedObject<number>;\r\n      for (const type of Object.keys(cpuTimes)) {\r\n        const cpuPercent = Math.round(100 * cpuTimes[type] / total);\r\n        cpuTimes[type] = cpuPercent;\r\n      }\r\n    }\r\n    return cpus;\r\n  }\r\n\r\n  private static evaluateMemoryUsage() {\r\n    // Create a clone\r\n    const memUsage = { ...process.memoryUsage() } as NodeJS.MemoryUsage;\r\n    const memUsageObj = (memUsage as any) as StringIndexedObject<number>;\r\n    // Evaluate memory usage as mega bytes\r\n    for (const type of Object.keys(memUsageObj)) {\r\n      memUsageObj[type] = this.bytesToMegaBytes(memUsageObj[type]);\r\n    }\r\n    return memUsage;\r\n  }\r\n\r\n  private static evaluateProcessStats(): DevToolsProcessStats {\r\n    return {\r\n      uptime: process.uptime(),\r\n      pid: process.pid,\r\n      ppid: process.ppid,\r\n      memoryUsage: this.evaluateMemoryUsage(),\r\n    } as DevToolsProcessStats;\r\n  }\r\n\r\n  private static evaluateOsStats(): DevToolsOsStats {\r\n    return {\r\n      platform: os.platform(),\r\n      hostname: os.hostname(),\r\n      totalmem: this.bytesToMegaBytes(os.totalmem()),\r\n      freemem: this.bytesToMegaBytes(os.freemem()),\r\n      uptime: os.uptime(),\r\n      cpus: this.evaluateCpus(),\r\n      cpuUsage: this.evaluateCpuUsage(),\r\n    } as DevToolsOsStats;\r\n  }\r\n\r\n  /** Returns JSON object with backend statistics */\r\n  public static stats(): DevToolsStats {\r\n    try {\r\n      const stats = {\r\n        os: this.evaluateOsStats(),\r\n        process: this.evaluateProcessStats(),\r\n      } as DevToolsStats;\r\n      return stats;\r\n    } catch (error) {\r\n      Logger.logError(loggerCategory, \"Could not fetch stats at backend\");\r\n      throw error;\r\n    }\r\n  }\r\n\r\n  /** Sets up a log level at the backend and returns the old log level */\r\n  public static setLogLevel(inLoggerCategory: string, newLevel: LogLevel): LogLevel | undefined {\r\n    const oldLevel = Logger.getLevel(inLoggerCategory);\r\n    Logger.logInfo(loggerCategory, `Setting log level`, () => ({ loggerCategory: inLoggerCategory, oldLevel, newLevel }));\r\n    Logger.setLevel(inLoggerCategory, newLevel);\r\n    IModelHost.platform.clearLogLevelCache();\r\n    return oldLevel;\r\n  }\r\n\r\n  /** Obtains the backend application and iTwin.js Core versions */\r\n  public static async versions() {\r\n    const availableRpcs: RpcInterfaceEndpoints[] = [];\r\n    return {\r\n      application: IModelHost.applicationVersion,\r\n      iTwinJs: require(\"../../package.json\").version, // eslint-disable-line @typescript-eslint/no-var-requires\r\n      availableRpcs, // filled in on the frontend\r\n    };\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"DevTools.js","sourceRoot":"","sources":["../../src/DevTools.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,yBAAyB;AACzB,mCAAmC;AACnC,sDAAuD;AACvD,mEAAgE;AAChE,6CAA0C;AAG1C,0BAA0B;AAE1B,MAAM,cAAc,GAAW,6CAAqB,CAAC,QAAQ,CAAC;AAwC9D;;GAEG;AACH,MAAa,sBAAsB;IAmBjC,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;;AAzBuB,qCAAc,GAAG,CAAC,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;AACrF,oCAAa,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;AACnE,gCAAS,GAAG,CAAC,OAAO,CAAC,CAAC;AACtB,oCAAa,GAAG,CAAC,QAAQ,CAAC,CAAC;AAEnD,wEAAwE;AACzD,gCAAS,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,EAAE;IACrD,IAAI,sBAAsB,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC;QACrD,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC;IACjC,IAAI,sBAAsB,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC;QACpD,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC;IAC/B,IAAI,sBAAsB,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC;QAChD,OAAO,GAAG,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC;IACnC,IAAI,sBAAsB,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC;QACpD,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC;IACnC,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAjBS,wDAAsB;AA6BnC;;;GAGG;AACH,MAAa,QAAQ;IAEnB,uCAAuC;IAChC,MAAM,CAAC,IAAI;QAChB,qBAAM,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;YACrC,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;gBACxC,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;aAC7B;SACF;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;YAC3C,WAAW,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;SAC9D;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;YACF,MAAM,KAAK,GAAG;gBACZ,EAAE,EAAE,IAAI,CAAC,eAAe,EAAE;gBAC1B,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE;aACpB,CAAC;YACnB,OAAO,KAAK,CAAC;SACd;QAAC,OAAO,KAAK,EAAE;YACd,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,kCAAkC,CAAC,CAAC;YACpE,MAAM,KAAK,CAAC;SACb;IACH,CAAC;IAED,uEAAuE;IAChE,MAAM,CAAC,WAAW,CAAC,gBAAwB,EAAE,QAAkB;QACpE,MAAM,QAAQ,GAAG,qBAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QACnD,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,cAAc,EAAE,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;QACtH,qBAAM,CAAC,QAAQ,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAC5C,uBAAU,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC;QACzC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,iEAAiE;IAC1D,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,MAAM,aAAa,GAA4B,EAAE,CAAC;QAClD,OAAO;YACL,WAAW,EAAE,uBAAU,CAAC,kBAAkB;YAC1C,OAAO,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC,OAAO;YAC9C,aAAa,EAAE,4BAA4B;SAC5C,CAAC;IACJ,CAAC;CACF;AA3HD,4BA2HC","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\r\nimport * as os from \"os\";\r\nimport * as process from \"process\";\r\nimport { Logger, LogLevel } from \"@itwin/core-bentley\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { RpcInterfaceEndpoints } from \"@itwin/core-common\";\r\n\r\n// cspell:ignore ppid elap\r\n\r\nconst loggerCategory: string = BackendLoggerCategory.DevTools;\r\n\r\ninterface StringIndexedObject<T> {\r\n  [index: string]: T;\r\n}\r\n\r\n/**\r\n * Performance and Memory statistics of backend\r\n * @internal\r\n */\r\nexport interface DevToolsStats {\r\n  os: DevToolsOsStats;\r\n  process: DevToolsProcessStats;\r\n}\r\n\r\n/**\r\n * OS stats of backend\r\n * @internal\r\n */\r\nexport interface DevToolsOsStats {\r\n  platform: NodeJS.Platform;\r\n  hostname: string;\r\n  totalmem: number;\r\n  freemem: number;\r\n  uptime: number;\r\n  cpus: os.CpuInfo[];\r\n  cpuUsage: number;\r\n}\r\n\r\n/**\r\n * Process stats of backend\r\n * @internal\r\n */\r\nexport interface DevToolsProcessStats {\r\n  uptime: number;\r\n  pid: number;\r\n  ppid: number;\r\n  memoryUsage: NodeJS.MemoryUsage;\r\n}\r\n\r\n/** Utility to format the JSON created by DevTools.stats() to include the appropriate units\r\n * @internal\r\n */\r\nexport class DevToolsStatsFormatter {\r\n  private static readonly _megaByteProps = [\"totalmem\", \"freemem\", \"rss\", \"heapTotal\", \"heapUsed\", \"external\"];\r\n  private static readonly _percentProps = [\"user\", \"nice\", \"sys\", \"idle\", \"irq\", \"cpuUsage\"];\r\n  private static readonly _mHzProps = [\"speed\"];\r\n  private static readonly _secondsProps = [\"uptime\"];\r\n\r\n  /** Replacer that includes units - can be used with JSON.stringify()  */\r\n  private static _replacer = (key: string, value: any) => {\r\n    if (DevToolsStatsFormatter._megaByteProps.includes(key))\r\n      return `${value.toFixed()} MB`;\r\n    if (DevToolsStatsFormatter._percentProps.includes(key))\r\n      return `${value.toFixed()}%`;\r\n    if (DevToolsStatsFormatter._mHzProps.includes(key))\r\n      return `${value.toString()} MHz`;\r\n    if (DevToolsStatsFormatter._secondsProps.includes(key))\r\n      return `${value.toFixed()} secs`;\r\n    return value;\r\n  };\r\n\r\n  /** Converts the input stats to another JSON object with the appropriate units setup for various fields */\r\n  public static toFormattedJson(stats: any) {\r\n    // Serialize the stats to a string with a replacer that sets up units during the serialization\r\n    const statsStr = JSON.stringify(stats, DevToolsStatsFormatter._replacer);\r\n\r\n    // Deserialize back to JSON\r\n    return JSON.parse(statsStr);\r\n  }\r\n}\r\n\r\n/**\r\n * Internal diagnostic utility\r\n * @internal\r\n */\r\nexport class DevTools {\r\n\r\n  /** Receives a ping and returns true */\r\n  public static ping(): boolean {\r\n    Logger.logInfo(loggerCategory, \"Received ping at backend\");\r\n    return true;\r\n  }\r\n\r\n  private static hrtimeToMS(hrtime: any) {\r\n    return hrtime[0] * 1000 + hrtime[1] / 1000000;\r\n  }\r\n\r\n  private static bytesToMegaBytes(bytes: number): number {\r\n    const megaBytes = bytes / Math.pow(1024, 2);\r\n    return Math.round(megaBytes * 100) / 100;\r\n  }\r\n\r\n  private static evaluateCpuUsage(): number {\r\n    const NUMBER_OF_CPUS = os.cpus().length;\r\n    const startTime = process.hrtime();\r\n    const startUsage = process.cpuUsage();\r\n\r\n    // spin the CPU for 500 milliseconds\r\n    const now = Date.now();\r\n    while (Date.now() - now < 500)\r\n      ;\r\n\r\n    const elapTime = process.hrtime(startTime);\r\n    const elapUsage = process.cpuUsage(startUsage);\r\n\r\n    const elapTimeMS = this.hrtimeToMS(elapTime);\r\n\r\n    const elapUserMS = elapUsage.user / 1000; // microseconds to milliseconds\r\n    const elapSystMS = elapUsage.system / 1000;\r\n    const cpuPercent = Math.round((100 * (elapUserMS + elapSystMS) / elapTimeMS / NUMBER_OF_CPUS));\r\n\r\n    return cpuPercent;\r\n  }\r\n\r\n  private static evaluateCpus(): os.CpuInfo[] {\r\n    // Create a clone\r\n    const srcCpus = os.cpus();\r\n    const cpus = new Array<os.CpuInfo>(srcCpus.length);\r\n    let ii = 0;\r\n    for (const srcCpu of srcCpus)\r\n      cpus[ii++] = { ...srcCpu };\r\n\r\n    // Evaluate cpu usage as percentages\r\n    for (const cpu of Object.values(cpus)) {\r\n      const total = Object.values(cpu.times).reduce((_total: number, currValue) => _total += currValue, 0);\r\n      const cpuTimes = cpu.times as StringIndexedObject<number>;\r\n      for (const type of Object.keys(cpuTimes)) {\r\n        const cpuPercent = Math.round(100 * cpuTimes[type] / total);\r\n        cpuTimes[type] = cpuPercent;\r\n      }\r\n    }\r\n    return cpus;\r\n  }\r\n\r\n  private static evaluateMemoryUsage() {\r\n    // Create a clone\r\n    const memUsage = { ...process.memoryUsage() } as NodeJS.MemoryUsage;\r\n    const memUsageObj = (memUsage as any) as StringIndexedObject<number>;\r\n    // Evaluate memory usage as mega bytes\r\n    for (const type of Object.keys(memUsageObj)) {\r\n      memUsageObj[type] = this.bytesToMegaBytes(memUsageObj[type]);\r\n    }\r\n    return memUsage;\r\n  }\r\n\r\n  private static evaluateProcessStats(): DevToolsProcessStats {\r\n    return {\r\n      uptime: process.uptime(),\r\n      pid: process.pid,\r\n      ppid: process.ppid,\r\n      memoryUsage: this.evaluateMemoryUsage(),\r\n    } as DevToolsProcessStats;\r\n  }\r\n\r\n  private static evaluateOsStats(): DevToolsOsStats {\r\n    return {\r\n      platform: os.platform(),\r\n      hostname: os.hostname(),\r\n      totalmem: this.bytesToMegaBytes(os.totalmem()),\r\n      freemem: this.bytesToMegaBytes(os.freemem()),\r\n      uptime: os.uptime(),\r\n      cpus: this.evaluateCpus(),\r\n      cpuUsage: this.evaluateCpuUsage(),\r\n    } as DevToolsOsStats;\r\n  }\r\n\r\n  /** Returns JSON object with backend statistics */\r\n  public static stats(): DevToolsStats {\r\n    try {\r\n      const stats = {\r\n        os: this.evaluateOsStats(),\r\n        process: this.evaluateProcessStats(),\r\n      } as DevToolsStats;\r\n      return stats;\r\n    } catch (error) {\r\n      Logger.logError(loggerCategory, \"Could not fetch stats at backend\");\r\n      throw error;\r\n    }\r\n  }\r\n\r\n  /** Sets up a log level at the backend and returns the old log level */\r\n  public static setLogLevel(inLoggerCategory: string, newLevel: LogLevel): LogLevel | undefined {\r\n    const oldLevel = Logger.getLevel(inLoggerCategory);\r\n    Logger.logInfo(loggerCategory, `Setting log level`, () => ({ loggerCategory: inLoggerCategory, oldLevel, newLevel }));\r\n    Logger.setLevel(inLoggerCategory, newLevel);\r\n    IModelHost.platform.clearLogLevelCache();\r\n    return oldLevel;\r\n  }\r\n\r\n  /** Obtains the backend application and iTwin.js Core versions */\r\n  public static async versions() {\r\n    const availableRpcs: RpcInterfaceEndpoints[] = [];\r\n    return {\r\n      application: IModelHost.applicationVersion,\r\n      iTwinJs: require(\"../../package.json\").version, // eslint-disable-line @typescript-eslint/no-var-requires\r\n      availableRpcs, // filled in on the frontend\r\n    };\r\n  }\r\n}\r\n"]}

package/lib/cjs/DisplayStyle.d.ts

@@ -1,107 +1,107 @@
-/** @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 {
-    /** @internal */
-    static get className(): string;
-    abstract get settings(): DisplayStyleSettings;
-    /** @internal */
-    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;
-    /** @internal */
-    protected collectReferenceConcreteIds(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 {
-    /** @internal */
-    static get className(): string;
-    private readonly _settings;
-    get settings(): DisplayStyleSettings;
-    /** @internal */
-    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 {
-    /** @internal */
-    static get className(): string;
-    private readonly _settings;
-    get settings(): DisplayStyle3dSettings;
-    /** @internal */
-    constructor(props: DisplayStyle3dProps, iModel: IModelDb);
-    /** @internal */
-    protected collectReferenceConcreteIds(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;
-}
+/** @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 {
+    /** @internal */
+    static get className(): string;
+    abstract get settings(): DisplayStyleSettings;
+    /** @internal */
+    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;
+    /** @internal */
+    protected collectReferenceConcreteIds(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 {
+    /** @internal */
+    static get className(): string;
+    private readonly _settings;
+    get settings(): DisplayStyleSettings;
+    /** @internal */
+    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 {
+    /** @internal */
+    static get className(): string;
+    private readonly _settings;
+    get settings(): DisplayStyle3dSettings;
+    /** @internal */
+    constructor(props: DisplayStyle3dProps, iModel: IModelDb);
+    /** @internal */
+    protected collectReferenceConcreteIds(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