@itwin/core-backend 4.8.0-dev.3 → 4.8.0-dev.32

package/lib/cjs/CodeService.js.map

@@ -1 +1 @@
-{"version":3,"file":"CodeService.js","sourceRoot":"","sources":["../../src/CodeService.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,sDAAoG;AAyCpG,aAAa;AACb,IAAiB,WAAW,CA4d3B;AA5dD,WAAiB,WAAW;IA+H1B,gBAAgB;IAChB,MAAM,aAAa,GAAG,IAAI,GAAG,EAAwB,CAAC;IAKtD,8EAA8E;IAC9E,SAAgB,gBAAgB,CAAC,GAAiB;QAChD,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IAC3C,CAAC;IAFe,4BAAgB,mBAE/B,CAAA;IAED;;OAEG;IACH,SAAgB,WAAW,CAAC,IAAY;QACtC,MAAM,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,GAAG;YACN,MAAM,IAAI,KAAK,CAAC,kBAAkB,EAAE,CAAC,CAAC,EAAE,iBAAiB,IAAI,YAAY,CAAC,CAAC;QAC7E,OAAO,GAAG,CAAC;IACb,CAAC;IALe,uBAAW,cAK1B,CAAA;IAED;;;;;OAKG;IACH,SAAgB,gBAAgB,CAAC,MAAgB,EAAE,IAAe;QAChE,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,CAAC;QAC/G,IAAI,SAAS,KAAK,SAAS;YACzB,MAAM,IAAI,WAAW,CAAC,KAAK,CAAC,aAAa,EAAE,2BAAY,CAAC,WAAW,EAAE,0CAA0C,CAAC,CAAC;QAEnH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IAC3E,CAAC;IANe,4BAAgB,mBAM/B,CAAA;IAED;;OAEG;IACH,SAAgB,gBAAgB,CAAC,GAAqC;QACpE,OAAO;YACL,GAAG,GAAG,CAAC,KAAK;YACZ,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK;YACrB,GAAG,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC;SAC1C,CAAC;IACJ,CAAC;IANe,4BAAgB,mBAM/B,CAAA;IAoQD,uDAAuD;IACvD,MAAa,KAAM,SAAQ,2BAAY;QAMrC,gBAAgB;QAChB,YAAY,OAAgB,EAAE,MAAc,EAAE,OAAe,EAAE,QAA6C;YAC1G,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC3B,CAAC;KACF;IAZY,iBAAK,QAYjB,CAAA;AAgCH,CAAC,EA5dgB,WAAW,2BAAX,WAAW,QA4d3B","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 { BentleyError, GuidString, IModelStatus, MarkRequired, Mutable } from \"@itwin/core-bentley\";\r\nimport { CodeProps, FontId, FontType } from \"@itwin/core-common\";\r\nimport { CloudSqlite } from \"./CloudSqlite\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { SettingObject } from \"./workspace/Settings\";\r\nimport { VersionedSqliteDb } from \"./SQLiteDb\";\r\n\r\n/**\r\n * The services for querying, reserving, updating, and deleting codes for a BriefcaseDb (available via `BriefcaseDb.codeService`) whenever it is opened for write access.\r\n * See [CodeService]($docs/learning/backend/CodeService).\r\n * @alpha\r\n */\r\nexport interface CodeService {\r\n  /** @internal */\r\n  close: () => void;\r\n\r\n  initialize(iModel: IModelDb): Promise<void>;\r\n\r\n  /** the index for external Codes for this CodeService */\r\n  readonly externalCodes?: CloudSqlite.DbAccess<CodeService.CodesDb, CodeService.ReadMethods, CodeService.WriteMethods>;\r\n\r\n  /** the index for internal Codes for this CodeService */\r\n  readonly internalCodes?: CloudSqlite.DbAccess<CodeService.InternalCodes, CodeService.InternalReadMethods, CodeService.InternalWriteMethods>;\r\n\r\n  /**\r\n   * Application-supplied parameters for reserving new codes.\r\n   */\r\n  readonly appParams: CodeService.AuthorAndOrigin;\r\n\r\n  /**\r\n   * Verify that the Code of a to-be-inserted or to-be-updated Element:\r\n   * 1. has already been reserved,\r\n   * 2. if the element has a `federationGuid`, it must match the reserved value. If the federationGuid is undefined,\r\n   * the value from the code index is returned.\r\n   *\r\n   * If not, throw an exception. Elements with no CodeValue are ignored.\r\n   * @note this method is automatically called whenever elements are added or updated by a BriefcaseDb with a CodeService.\r\n   */\r\n  verifyCode(props: CodeService.ElementCodeProps): void;\r\n}\r\n\r\n/** @alpha */\r\nexport namespace CodeService {\r\n\r\n  export interface WriteMethods {\r\n    /** Add a new code spec to this code service.\r\n     */\r\n    addCodeSpec(val: CodeService.NameAndJson): Promise<void>;\r\n\r\n    /**\r\n     * Add all of the codes and code specs from this CodeService's BriefcaseDb into the code index.\r\n     * @returns the number of codes actually added.\r\n     * @note It is not necessary to call this method unless the BriefcaseDb somehow becomes out of sync with its CodeService,\r\n     * for example when migrating iModels to a new code service. It is safe (but relatively expensive) to call this method multiple times, since\r\n     * any codes or code specs that are already in the index are ignored.\r\n     */\r\n    addAllCodes(iModel: IModelDb): Promise<number>;\r\n\r\n    /**\r\n     * Attempt to reserve a single proposed code.\r\n     * @throws `CodeService.Error` if the proposed code cannot be reserved.\r\n     */\r\n    reserveCode(code: CodeService.ProposedCode): Promise<void>;\r\n\r\n    /**\r\n     * Attempt to reserve an array of proposed codes.\r\n     * @returns number of codes actually reserved.\r\n     * @see the `problems` member of the `CodeService.Error` exception\r\n     * @note If you have a set of codes to reserve, it is considerably more efficient to do them as an array rather than one at a time.\r\n     * @throws `CodeService.Error` if any of the proposed code cannot be reserved. The details for each failed code are in the `problems` member.\r\n     */\r\n    reserveCodes(arg: CodeService.ReserveCodesArgs): Promise<number>;\r\n\r\n    /**\r\n     * Attempt to reserve the next available code for a code sequence and scope.\r\n     */\r\n    reserveNextAvailableCode(arg: CodeService.ReserveNextArgs): Promise<void>;\r\n\r\n    /**\r\n     * Attempt to reserve an array of the next available codes for a code sequence and scope.\r\n     * The length of the array determines the number of codes requested. The values for the new codes are returned\r\n     * in the array, so they can be associated with the supplied GUIDs.\r\n     * @returns number of codes actually reserved.\r\n     */\r\n    reserveNextAvailableCodes(arg: CodeService.ReserveNextArrayArgs): Promise<number>;\r\n\r\n    /**\r\n     * Update the properties of a single code.\r\n     */\r\n    updateCode(props: CodeService.UpdatedCode): Promise<void>;\r\n\r\n    /**\r\n     * Update the properties of an array codes.\r\n     * @note If you have a set of codes to update, it is considerably more efficient to do them as an array rather than one at a time.\r\n     * @returns number of codes actually updated.\r\n     */\r\n    updateCodes(arg: CodeService.UpdateCodesArgs): Promise<number>;\r\n\r\n    /** Delete an array of codes by their guids. */\r\n    deleteCodes(guid: CodeService.CodeGuid[]): Promise<void>;\r\n  }\r\n\r\n  export interface ReadMethods {\r\n    /**\r\n     * Find the next available value for the supplied `SequenceScope`.\r\n     * If the sequence is full (there are no available values), this will throw an exception with `errorId=\"SequenceFull\"`\r\n     * @param from the sequence and scope to search\r\n     * @returns the next available CodeValue in the sequence.\r\n     */\r\n    findNextAvailable(from: CodeService.SequenceScope): CodeService.CodeValue;\r\n\r\n    /**\r\n     * Find the highest currently used value for the supplied `SequenceScope`\r\n     * @param from the sequence and scope to search\r\n     * @returns the highest used value, or undefined if no values have been used.\r\n     */\r\n    findHighestUsed(from: CodeService.SequenceScope): CodeService.CodeValue | undefined;\r\n\r\n    /** Determine whether a code is present in this CodeIndex by its Guid. */\r\n    isCodePresent(guid: CodeService.CodeGuid): boolean;\r\n\r\n    /** Get the data for a code in this CodeIndex by its Guid.\r\n     * @returns the data for the code or undefined if no code is present for the supplied Guid.\r\n     */\r\n    getCode(guid: CodeService.CodeGuid): CodeService.CodeEntry | undefined;\r\n\r\n    /** Look up a code by its Scope, Spec, and Value.\r\n     * @returns the Guid of the code, or undefined if not present.\r\n     */\r\n    findCode(code: CodeService.ScopeSpecAndValue): CodeService.CodeGuid | undefined;\r\n\r\n    /** Look up a code spec by its name\r\n     * @throws if the spec is not present.\r\n     */\r\n    getCodeSpec(props: CodeService.CodeSpecName): CodeService.NameAndJson;\r\n\r\n    /** Call a `CodeIteration` function for all codes in this index, optionally filtered by a `CodeFilter ` */\r\n    forAllCodes(iter: CodeService.CodeIteration, filter?: CodeService.CodeFilter): void;\r\n\r\n    /** Call an iteration function for all code specs in this index, optionally filtered by a `ValueFilter ` */\r\n    forAllCodeSpecs(iter: CodeService.NameAndJsonIteration, filter?: CodeService.ValueFilter): void;\r\n\r\n    /**\r\n     * Verify that the Code of a to-be-inserted or to-be-updated Element:\r\n     * 1. has already been reserved,\r\n     * 2. if the element has a `federationGuid`, it must match the reserved value. If the federationGuid is undefined,\r\n     * the value from the code index is returned.\r\n     *\r\n     * If not, throw an exception. Elements with no CodeValue are ignored.\r\n     * @note this method is automatically called whenever elements are added or updated by a BriefcaseDb with a CodeService.\r\n     */\r\n    verifyCode(specName: string, arg: CodeService.ElementCodeProps): void;\r\n  }\r\n\r\n  export type CodesDb = VersionedSqliteDb & WriteMethods & ReadMethods;\r\n\r\n  export interface InternalWriteMethods extends WriteMethods {\r\n    /**  @internal */\r\n    reserveFontId(props: CodeService.FontIndexProps): Promise<FontId>;\r\n    /**  @internal */\r\n    reserveBisCodeSpecs(specs: CodeService.BisCodeSpecIndexProps[]): Promise<void>;\r\n  }\r\n  export interface InternalReadMethods extends ReadMethods {\r\n    /**  @internal */\r\n    verifyBisCodeSpec(spec: CodeService.BisCodeSpecIndexProps): void;\r\n  }\r\n\r\n  export type InternalCodes = CodesDb & InternalWriteMethods & InternalReadMethods;\r\n\r\n  /** @internal */\r\n  const codeSequences = new Map<string, CodeSequence>();\r\n\r\n  /** @internal */\r\n  export let createForIModel: ((db: IModelDb) => Promise<CodeService>) | undefined;\r\n\r\n  /** Register an instance of a`CodeSequence` so it can be looked up by name. */\r\n  export function registerSequence(seq: CodeSequence) {\r\n    codeSequences.set(seq.sequenceName, seq);\r\n  }\r\n\r\n  /** Get a previously registered `CodeSequence` by its name.\r\n   * @throws if no sequence by that name was registered.\r\n   */\r\n  export function getSequence(name: string): CodeSequence {\r\n    const seq = codeSequences.get(name);\r\n    if (!seq)\r\n      throw new Error(\"SequenceNotFound\", -1, `code sequence ${name} not found`);\r\n    return seq;\r\n  }\r\n\r\n  /**\r\n   * Turn a `CodePops` for the briefcase of this CodeService into a `ScopeAndSpec` object for use with a CodeService.\r\n   * This is necessary because the `spec` member of `CodeProps` refers to the id of a code spec in the iModel, and\r\n   * the `scope` member refers to the element Id of the scope element in the iModel. This helper function\r\n   * converts the spec Id to the spec name and looks up the `FederationGuid` of the scope element.\r\n   */\r\n  export function makeScopeAndSpec(iModel: IModelDb, code: CodeProps): CodeService.ScopeAndSpec {\r\n    const scopeGuid = iModel.elements.getElementProps({ id: code.scope, onlyBaseProperties: true }).federationGuid;\r\n    if (undefined === scopeGuid)\r\n      throw new CodeService.Error(\"MissingGuid\", IModelStatus.InvalidCode, \"code scope element has no federationGuid\");\r\n\r\n    return { scopeGuid, specName: iModel.codeSpecs.getById(code.spec).name };\r\n  }\r\n\r\n  /** Turn a `CodeProps` and  `ProposedCodeProps` into a `ProposedCode` for use with a CodeService.\r\n   * @see [[makeScopeAndSpec]] for explanation of why this is necessary.\r\n   */\r\n  export function makeProposedCode(arg: CodeService.MakeProposedCodeArgs): CodeService.ProposedCode {\r\n    return {\r\n      ...arg.props,\r\n      value: arg.code.value,\r\n      ...makeScopeAndSpec(arg.iModel, arg.code),\r\n    };\r\n  }\r\n\r\n  /** The name of a code spec */\r\n  export type CodeSpecName = string;\r\n\r\n  /**\r\n   * The name that identifies the \"originator\" of a code. Usually this is the Guid of the iModel from which a code was added,\r\n   * but can also be used to identify a system or type from an external code service.\r\n   */\r\n  export type CodeOriginName = string;\r\n\r\n  /** The name that identifies the \"author\" of a code. Generally, this is intended to be the name of a person or group that helps identify the purpose of the code. */\r\n  export type AuthorName = string;\r\n\r\n  /** The value for a code. */\r\n  export type CodeValue = string;\r\n\r\n  /** The guid for a code. This identifies the real-world entity associated with the code. */\r\n  export type CodeGuid = GuidString;\r\n\r\n  /** The guid of the scope for a code. This identifies the real-world entity that provides the uniqueness scope for code values. */\r\n  export type ScopeGuid = GuidString;\r\n\r\n  /** An optional number associated with a code that may be used for \"status\" information. Values must be defined by applications. */\r\n  export type CodeState = number;\r\n\r\n  /** The return status of an iteration function. The value \"stop\" causes the iteration to terminate. */\r\n  export type IterationReturn = void | \"stop\";\r\n\r\n  /** An iteration function over codes in a code index. It is called with the Guid of a each code. */\r\n  export type CodeIteration = (guid: GuidString) => IterationReturn;\r\n\r\n  /** An iteration function over code specs in a code index. It is called with the name and json of a each code spec. */\r\n  export type NameAndJsonIteration = (nameAndJson: NameAndJson) => IterationReturn;\r\n\r\n  /** Argument for reserving an array of new codes. */\r\n  export interface ReserveCodesArgs {\r\n    /** an array of proposed codes to reserve.\r\n     * @note the guid of each proposed code must be supplied by the caller.\r\n     */\r\n    readonly codes: CodeService.ProposedCode[];\r\n    /** If true, unless all codes are available, don't reserve any codes. Otherwise reserve all available codes. */\r\n    readonly allOrNothing?: true;\r\n  }\r\n\r\n  /** Argument for reserving a code from a code sequence. */\r\n  export interface ReserveNextArgs {\r\n    /** the properties of the new code */\r\n    readonly code: CodeService.ProposedCodeProps;\r\n    /** The code sequence and scope for the new code. */\r\n    readonly from: SequenceScope;\r\n  }\r\n\r\n  /** Argument for reserving an array of codes from a code sequence. */\r\n  export interface ReserveNextArrayArgs {\r\n    /** an array of proposed codes to reserve.  */\r\n    readonly codes: CodeService.ProposedCodeProps[];\r\n    /** The code sequence and scope for the new codes. */\r\n    readonly from: CodeService.SequenceScope;\r\n    /** If true, and in the event that the code sequence does not have enough available codes to fulfill all the entries in `codes`,\r\n     * return as many as possible. Otherwise no codes are reserved. The `problems` member of the exception can be used to determine how many codes were available.\r\n     * @note if `asManyAsPossible` is true, no error is thrown if the sequence becomes full. You must check the return value to see how many\r\n     * were actually available. The `value` member will be undefined for any proposed codes that were not reserved.\r\n     */\r\n    readonly asManyAsPossible?: true;\r\n  }\r\n\r\n  /** Argument for updating an array of codes. */\r\n  export interface UpdateCodesArgs {\r\n    /** Properties of the codes to update */\r\n    readonly props: CodeService.UpdatedCode[];\r\n    /** If true, unless all codes are updated, don't update any codes. Otherwise update all possible codes. */\r\n    readonly allOrNothing?: true;\r\n  }\r\n\r\n  /** Arguments for CodeService.makeProposedCode  */\r\n  export interface MakeProposedCodeArgs {\r\n    readonly iModel: IModelDb;\r\n    readonly code: Required<CodeProps>;\r\n    readonly props: CodeService.CodeGuidStateJson;\r\n  }\r\n\r\n  /** The properties of an Element to be checked against the code index.\r\n   * @see CodeService.verifyCode\r\n   */\r\n  export interface ElementCodeProps {\r\n    /** iModel from which the code is being inserted/updated. */\r\n    readonly iModel: IModelDb;\r\n    /** Properties of the code */\r\n    readonly props: {\r\n      /** The imodel-specific code properties. */\r\n      readonly code: CodeProps;\r\n      /**\r\n       * The federationGuid of the element being inserted or updated.\r\n       * If federationGuid is defined, it is must match the value in the code index or an error is thrown.\r\n       * If it is undefined, the value from the code index is returned here.\r\n       */\r\n      federationGuid?: GuidString;\r\n    };\r\n  }\r\n\r\n  /** a name and a json object. Used for code specs, authors and origins. */\r\n  export interface NameAndJson {\r\n    readonly name: string;\r\n    readonly json?: SettingObject;\r\n  }\r\n\r\n  /** A code Scope guid, and code spec name. */\r\n  export interface ScopeAndSpec {\r\n    readonly specName: CodeSpecName;\r\n    readonly scopeGuid: ScopeGuid;\r\n  }\r\n\r\n  /** A code Scope guid, code spec, and code value. */\r\n  export interface ScopeSpecAndValue extends ScopeAndSpec {\r\n    readonly value: CodeValue;\r\n  }\r\n\r\n  /** The data held in a code index for a single code. */\r\n  export interface CodeEntry {\r\n    /** The name of the code spec for this code. */\r\n    readonly specName: CodeSpecName;\r\n    /** The guid of the entity that provides the scope for this code. */\r\n    readonly scopeGuid: ScopeGuid;\r\n    /** The value of this code. */\r\n    readonly value: CodeValue;\r\n    /** The guid of the entity this code identifies. */\r\n    readonly guid: CodeGuid;\r\n    /** the state of the code. May be undefined. */\r\n    readonly state?: CodeState;\r\n    /** The name of the originating source of this code (usually an iModel Guid). May be undefined. */\r\n    readonly origin: CodeOriginName;\r\n    /** The name of the author of this code. May be undefined. */\r\n    readonly author?: AuthorName;\r\n    /** Option json properties associated with this code. May be undefined. */\r\n    readonly json?: SettingObject;\r\n  }\r\n\r\n  /** A filter used to limit and/or sort the values returned by an iteration. */\r\n  export interface ValueFilter {\r\n    /** A value filter. May include wild cards when used with `GLOB` or `LIKE` */\r\n    readonly value?: string;\r\n    /** The comparison operator for `value`. Default is `=` */\r\n    readonly valueCompare?: \"GLOB\" | \"LIKE\" | \"NOT GLOB\" | \"NOT LIKE\" | \"=\" | \"<\" | \">\";\r\n    /** Order results ascending or descending. If not supplied, the results are unordered (random). */\r\n    readonly orderBy?: \"ASC\" | \"DESC\";\r\n    /** An SQL expression to further filter results. This string is appended to the `WHERE` clause with an `AND` (that should not be part of the sqlExpression) */\r\n    readonly sqlExpression?: string;\r\n  }\r\n\r\n  /** A filter to limit and/or sort the values for the [[CodeIndex.forAllCodes]] iteration. */\r\n  export interface CodeFilter extends ValueFilter {\r\n    /** If supplied, limit results to only those with this spec */\r\n    readonly specName?: CodeSpecName;\r\n    /** If supplied, limit results to only those with this scope Guid */\r\n    readonly scopeGuid?: ScopeGuid;\r\n    /** If supplied, limit results to only those with this origin */\r\n    readonly origin?: CodeOriginName;\r\n  }\r\n\r\n  /** Author and origin information supplied when codes are reserved. */\r\n  export interface AuthorAndOrigin {\r\n    /** The name of the individual or group for whom the code was reserved. */\r\n    readonly author: Mutable<NameAndJson>;\r\n    /** The identity of the \"originator\" of the code. This is usually a guid of an iModel, but can be any unique string. */\r\n    readonly origin: Mutable<NameAndJson>;\r\n  }\r\n\r\n  /** The Guid, state, and json properties of a code. */\r\n  export interface CodeGuidStateJson {\r\n    /** The Guid of the new code. This must be always be supplied by the application. */\r\n    readonly guid: CodeGuid;\r\n    /** An optional value for the state of the code. */\r\n    readonly state?: CodeState;\r\n    /** An optional json object to be stored with the code. */\r\n    readonly json?: SettingObject;\r\n  }\r\n\r\n  /** Properties of a \"proposed\" new code to be reserved.\r\n   * @note the Guid of the entity identified by this code *must* be supplied, but `value` is optional, since\r\n   * this may be used to reserve codes from a sequence where the value is generated.\r\n   */\r\n  export interface ProposedCodeProps extends CodeGuidStateJson {\r\n    /** The value for the proposed code.\r\n     * @note For code sequence operations, this value is ignored on input and is set with a new value from the sequence on successful return.\r\n     */\r\n    value?: CodeValue;\r\n  }\r\n\r\n  /** Properties of a proposed new code that is not from a code sequence (its `value` is required). */\r\n  export type ProposedCode = ProposedCodeProps & ScopeSpecAndValue;\r\n\r\n  /** Properties that describe a code sequence and a scope and spec for a proposed code or array of codes from a sequence. */\r\n  export interface SequenceScope extends ScopeAndSpec {\r\n    /** The code sequence. */\r\n    readonly seq: CodeSequence;\r\n    /** A valid current value. If supplied, the returned value will always be later in the sequence than this. */\r\n    readonly start?: CodeValue;\r\n  }\r\n\r\n  /** Properties of a code to be updated.\r\n   * @note The `guid` member identifies the code to be updated and is required.\r\n   * All other properties are optional - if `undefined`, its value is not changed.\r\n   */\r\n  export type UpdatedCode = MarkRequired<Partial<ProposedCode>, \"guid\">;\r\n\r\n  /** A proposed code that could not be reserved due to some error. */\r\n  export interface ReserveProblem {\r\n    /** the proposed code that failed. */\r\n    readonly code: ProposedCode;\r\n    /** the reason for the failure */\r\n    readonly errorId: ErrorId;\r\n    /** the error message from the exception for this proposed code. */\r\n    readonly message: string;\r\n  }\r\n\r\n  /** A update to a code that failed for some error. */\r\n  export interface UpdateProblem {\r\n    /** The properties of the code that was to be updated */\r\n    readonly prop: UpdatedCode;\r\n    /** the reason for the failure */\r\n    readonly errorId: ErrorId;\r\n    /** the error message from the exception for the update request. */\r\n    readonly message: string;\r\n  }\r\n\r\n  /**\r\n   * A sequence of code values following a increasing pattern. Valid code sequences must have a first value, a last value, and\r\n   * a way to get the next valid value from an existing valid value.\r\n   * Code sequences have a `sequenceName` so they can be registered using `CodeService.registerSequence`.\r\n   */\r\n  export interface CodeSequence {\r\n    /** the name of this CodeSequence. */\r\n    get sequenceName(): string;\r\n    /** Get the first valid value for this CodeSequence */\r\n    getFirstValue(): CodeValue;\r\n    /** Get the last valid value for this CodeSequence */\r\n    getLastValue(): CodeValue;\r\n    /** Get the next valid value for this CodeSequence from the supplied value.\r\n     * If the sequence is full (that is, the next value is greater than the last value, this method should throw with errorId=\"SequenceFull\".\r\n     * @return the next valid value according to the rules of this CodeSequence.\r\n     */\r\n    getNextValue(code: CodeValue): CodeValue;\r\n    /** Determine whether this supplied value is valid for this sequence. */\r\n    isValidCode(code: CodeValue): boolean;\r\n  }\r\n\r\n  /** @internal */\r\n  export interface FontIndexProps {\r\n    id?: number;\r\n    fontType: FontType;\r\n    fontName: string;\r\n  }\r\n  /** @internal */\r\n  export interface BisCodeSpecIndexProps {\r\n    id?: number;\r\n    name: string;\r\n    props: string;\r\n  }\r\n\r\n  /** Exception class thrown by `CodeService` methods. */\r\n  export class Error extends BentleyError {\r\n    /** A string that indicates the type of problem that caused the exception. */\r\n    public readonly errorId: ErrorId;\r\n    /** For [[CodeService.reserveCodes]] and [[CodeService.updateCodes]], a list of the problem details. */\r\n    public readonly problems?: ReserveProblem[] | UpdateProblem[];\r\n\r\n    /** @internal */\r\n    constructor(errorId: ErrorId, errNum: number, message: string, problems?: ReserveProblem[] | UpdateProblem[]) {\r\n      super(errNum, message);\r\n      this.errorId = errorId;\r\n      this.problems = problems;\r\n    }\r\n  }\r\n\r\n  /** Identifiers for exceptions thrown by `CodeService` methods.\r\n   * @see [[CodeService.Error.errorId]]\r\n   */\r\n  export type ErrorId =\r\n    \"BadIndexProps\" |\r\n    \"CorruptIModel\" |\r\n    \"CorruptIndex\" |\r\n    \"DuplicateValue\" |\r\n    \"GuidIsInUse\" |\r\n    \"GuidMismatch\" |\r\n    \"IllegalValue\" |\r\n    \"InconsistentIModels\" |\r\n    \"IndexReadonly\" |\r\n    \"InvalidCodeScope\" |\r\n    \"InvalidGuid\" |\r\n    \"InvalidSequence\" |\r\n    \"MissingCode\" |\r\n    \"MissingGuid\" |\r\n    \"MissingInput\" |\r\n    \"MissingSpec\" |\r\n    \"NoCodeIndex\" |\r\n    \"NotAuthorized\" |\r\n    \"SequenceFull\" |\r\n    \"ReserveErrors\" |\r\n    \"SequenceNotFound\" |\r\n    \"SqlLogicError\" |\r\n    \"UpdateErrors\" |\r\n    \"ValueIsInUse\" |\r\n    \"WrongVersion\";\r\n\r\n}\r\n"]}
+{"version":3,"file":"CodeService.js","sourceRoot":"","sources":["../../src/CodeService.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,sDAAoG;AAyCpG,aAAa;AACb,IAAiB,WAAW,CA4d3B;AA5dD,WAAiB,WAAW;IA+H1B,gBAAgB;IAChB,MAAM,aAAa,GAAG,IAAI,GAAG,EAAwB,CAAC;IAKtD,8EAA8E;IAC9E,SAAgB,gBAAgB,CAAC,GAAiB;QAChD,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IAC3C,CAAC;IAFe,4BAAgB,mBAE/B,CAAA;IAED;;OAEG;IACH,SAAgB,WAAW,CAAC,IAAY;QACtC,MAAM,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,GAAG;YACN,MAAM,IAAI,KAAK,CAAC,kBAAkB,EAAE,CAAC,CAAC,EAAE,iBAAiB,IAAI,YAAY,CAAC,CAAC;QAC7E,OAAO,GAAG,CAAC;IACb,CAAC;IALe,uBAAW,cAK1B,CAAA;IAED;;;;;OAKG;IACH,SAAgB,gBAAgB,CAAC,MAAgB,EAAE,IAAe;QAChE,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,CAAC;QAC/G,IAAI,SAAS,KAAK,SAAS;YACzB,MAAM,IAAI,WAAW,CAAC,KAAK,CAAC,aAAa,EAAE,2BAAY,CAAC,WAAW,EAAE,0CAA0C,CAAC,CAAC;QAEnH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IAC3E,CAAC;IANe,4BAAgB,mBAM/B,CAAA;IAED;;OAEG;IACH,SAAgB,gBAAgB,CAAC,GAAqC;QACpE,OAAO;YACL,GAAG,GAAG,CAAC,KAAK;YACZ,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK;YACrB,GAAG,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC;SAC1C,CAAC;IACJ,CAAC;IANe,4BAAgB,mBAM/B,CAAA;IAoQD,uDAAuD;IACvD,MAAa,KAAM,SAAQ,2BAAY;QAMrC,gBAAgB;QAChB,YAAY,OAAgB,EAAE,MAAc,EAAE,OAAe,EAAE,QAA6C;YAC1G,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC3B,CAAC;KACF;IAZY,iBAAK,QAYjB,CAAA;AAgCH,CAAC,EA5dgB,WAAW,2BAAX,WAAW,QA4d3B","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 { BentleyError, GuidString, IModelStatus, MarkRequired, Mutable } from \"@itwin/core-bentley\";\r\nimport { CodeProps, FontId, FontType } from \"@itwin/core-common\";\r\nimport { CloudSqlite } from \"./CloudSqlite\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { SettingsContainer } from \"./workspace/Settings\";\r\nimport { VersionedSqliteDb } from \"./SQLiteDb\";\r\n\r\n/**\r\n * The services for querying, reserving, updating, and deleting codes for a BriefcaseDb (available via `BriefcaseDb.codeService`) whenever it is opened for write access.\r\n * See [CodeService]($docs/learning/backend/CodeService).\r\n * @alpha\r\n */\r\nexport interface CodeService {\r\n  /** @internal */\r\n  close: () => void;\r\n\r\n  initialize(iModel: IModelDb): Promise<void>;\r\n\r\n  /** the index for external Codes for this CodeService */\r\n  readonly externalCodes?: CloudSqlite.DbAccess<CodeService.CodesDb, CodeService.ReadMethods, CodeService.WriteMethods>;\r\n\r\n  /** the index for internal Codes for this CodeService */\r\n  readonly internalCodes?: CloudSqlite.DbAccess<CodeService.InternalCodes, CodeService.InternalReadMethods, CodeService.InternalWriteMethods>;\r\n\r\n  /**\r\n   * Application-supplied parameters for reserving new codes.\r\n   */\r\n  readonly appParams: CodeService.AuthorAndOrigin;\r\n\r\n  /**\r\n   * Verify that the Code of a to-be-inserted or to-be-updated Element:\r\n   * 1. has already been reserved,\r\n   * 2. if the element has a `federationGuid`, it must match the reserved value. If the federationGuid is undefined,\r\n   * the value from the code index is returned.\r\n   *\r\n   * If not, throw an exception. Elements with no CodeValue are ignored.\r\n   * @note this method is automatically called whenever elements are added or updated by a BriefcaseDb with a CodeService.\r\n   */\r\n  verifyCode(props: CodeService.ElementCodeProps): void;\r\n}\r\n\r\n/** @alpha */\r\nexport namespace CodeService {\r\n\r\n  export interface WriteMethods {\r\n    /** Add a new code spec to this code service.\r\n     */\r\n    addCodeSpec(val: CodeService.NameAndJson): Promise<void>;\r\n\r\n    /**\r\n     * Add all of the codes and code specs from this CodeService's BriefcaseDb into the code index.\r\n     * @returns the number of codes actually added.\r\n     * @note It is not necessary to call this method unless the BriefcaseDb somehow becomes out of sync with its CodeService,\r\n     * for example when migrating iModels to a new code service. It is safe (but relatively expensive) to call this method multiple times, since\r\n     * any codes or code specs that are already in the index are ignored.\r\n     */\r\n    addAllCodes(iModel: IModelDb): Promise<number>;\r\n\r\n    /**\r\n     * Attempt to reserve a single proposed code.\r\n     * @throws `CodeService.Error` if the proposed code cannot be reserved.\r\n     */\r\n    reserveCode(code: CodeService.ProposedCode): Promise<void>;\r\n\r\n    /**\r\n     * Attempt to reserve an array of proposed codes.\r\n     * @returns number of codes actually reserved.\r\n     * @see the `problems` member of the `CodeService.Error` exception\r\n     * @note If you have a set of codes to reserve, it is considerably more efficient to do them as an array rather than one at a time.\r\n     * @throws `CodeService.Error` if any of the proposed code cannot be reserved. The details for each failed code are in the `problems` member.\r\n     */\r\n    reserveCodes(arg: CodeService.ReserveCodesArgs): Promise<number>;\r\n\r\n    /**\r\n     * Attempt to reserve the next available code for a code sequence and scope.\r\n     */\r\n    reserveNextAvailableCode(arg: CodeService.ReserveNextArgs): Promise<void>;\r\n\r\n    /**\r\n     * Attempt to reserve an array of the next available codes for a code sequence and scope.\r\n     * The length of the array determines the number of codes requested. The values for the new codes are returned\r\n     * in the array, so they can be associated with the supplied GUIDs.\r\n     * @returns number of codes actually reserved.\r\n     */\r\n    reserveNextAvailableCodes(arg: CodeService.ReserveNextArrayArgs): Promise<number>;\r\n\r\n    /**\r\n     * Update the properties of a single code.\r\n     */\r\n    updateCode(props: CodeService.UpdatedCode): Promise<void>;\r\n\r\n    /**\r\n     * Update the properties of an array codes.\r\n     * @note If you have a set of codes to update, it is considerably more efficient to do them as an array rather than one at a time.\r\n     * @returns number of codes actually updated.\r\n     */\r\n    updateCodes(arg: CodeService.UpdateCodesArgs): Promise<number>;\r\n\r\n    /** Delete an array of codes by their guids. */\r\n    deleteCodes(guid: CodeService.CodeGuid[]): Promise<void>;\r\n  }\r\n\r\n  export interface ReadMethods {\r\n    /**\r\n     * Find the next available value for the supplied `SequenceScope`.\r\n     * If the sequence is full (there are no available values), this will throw an exception with `errorId=\"SequenceFull\"`\r\n     * @param from the sequence and scope to search\r\n     * @returns the next available CodeValue in the sequence.\r\n     */\r\n    findNextAvailable(from: CodeService.SequenceScope): CodeService.CodeValue;\r\n\r\n    /**\r\n     * Find the highest currently used value for the supplied `SequenceScope`\r\n     * @param from the sequence and scope to search\r\n     * @returns the highest used value, or undefined if no values have been used.\r\n     */\r\n    findHighestUsed(from: CodeService.SequenceScope): CodeService.CodeValue | undefined;\r\n\r\n    /** Determine whether a code is present in this CodeIndex by its Guid. */\r\n    isCodePresent(guid: CodeService.CodeGuid): boolean;\r\n\r\n    /** Get the data for a code in this CodeIndex by its Guid.\r\n     * @returns the data for the code or undefined if no code is present for the supplied Guid.\r\n     */\r\n    getCode(guid: CodeService.CodeGuid): CodeService.CodeEntry | undefined;\r\n\r\n    /** Look up a code by its Scope, Spec, and Value.\r\n     * @returns the Guid of the code, or undefined if not present.\r\n     */\r\n    findCode(code: CodeService.ScopeSpecAndValue): CodeService.CodeGuid | undefined;\r\n\r\n    /** Look up a code spec by its name\r\n     * @throws if the spec is not present.\r\n     */\r\n    getCodeSpec(props: CodeService.CodeSpecName): CodeService.NameAndJson;\r\n\r\n    /** Call a `CodeIteration` function for all codes in this index, optionally filtered by a `CodeFilter ` */\r\n    forAllCodes(iter: CodeService.CodeIteration, filter?: CodeService.CodeFilter): void;\r\n\r\n    /** Call an iteration function for all code specs in this index, optionally filtered by a `ValueFilter ` */\r\n    forAllCodeSpecs(iter: CodeService.NameAndJsonIteration, filter?: CodeService.ValueFilter): void;\r\n\r\n    /**\r\n     * Verify that the Code of a to-be-inserted or to-be-updated Element:\r\n     * 1. has already been reserved,\r\n     * 2. if the element has a `federationGuid`, it must match the reserved value. If the federationGuid is undefined,\r\n     * the value from the code index is returned.\r\n     *\r\n     * If not, throw an exception. Elements with no CodeValue are ignored.\r\n     * @note this method is automatically called whenever elements are added or updated by a BriefcaseDb with a CodeService.\r\n     */\r\n    verifyCode(specName: string, arg: CodeService.ElementCodeProps): void;\r\n  }\r\n\r\n  export type CodesDb = VersionedSqliteDb & WriteMethods & ReadMethods;\r\n\r\n  export interface InternalWriteMethods extends WriteMethods {\r\n    /**  @internal */\r\n    reserveFontId(props: CodeService.FontIndexProps): Promise<FontId>;\r\n    /**  @internal */\r\n    reserveBisCodeSpecs(specs: CodeService.BisCodeSpecIndexProps[]): Promise<void>;\r\n  }\r\n  export interface InternalReadMethods extends ReadMethods {\r\n    /**  @internal */\r\n    verifyBisCodeSpec(spec: CodeService.BisCodeSpecIndexProps): void;\r\n  }\r\n\r\n  export type InternalCodes = CodesDb & InternalWriteMethods & InternalReadMethods;\r\n\r\n  /** @internal */\r\n  const codeSequences = new Map<string, CodeSequence>();\r\n\r\n  /** @internal */\r\n  export let createForIModel: ((db: IModelDb) => Promise<CodeService>) | undefined;\r\n\r\n  /** Register an instance of a`CodeSequence` so it can be looked up by name. */\r\n  export function registerSequence(seq: CodeSequence) {\r\n    codeSequences.set(seq.sequenceName, seq);\r\n  }\r\n\r\n  /** Get a previously registered `CodeSequence` by its name.\r\n   * @throws if no sequence by that name was registered.\r\n   */\r\n  export function getSequence(name: string): CodeSequence {\r\n    const seq = codeSequences.get(name);\r\n    if (!seq)\r\n      throw new Error(\"SequenceNotFound\", -1, `code sequence ${name} not found`);\r\n    return seq;\r\n  }\r\n\r\n  /**\r\n   * Turn a `CodePops` for the briefcase of this CodeService into a `ScopeAndSpec` object for use with a CodeService.\r\n   * This is necessary because the `spec` member of `CodeProps` refers to the id of a code spec in the iModel, and\r\n   * the `scope` member refers to the element Id of the scope element in the iModel. This helper function\r\n   * converts the spec Id to the spec name and looks up the `FederationGuid` of the scope element.\r\n   */\r\n  export function makeScopeAndSpec(iModel: IModelDb, code: CodeProps): CodeService.ScopeAndSpec {\r\n    const scopeGuid = iModel.elements.getElementProps({ id: code.scope, onlyBaseProperties: true }).federationGuid;\r\n    if (undefined === scopeGuid)\r\n      throw new CodeService.Error(\"MissingGuid\", IModelStatus.InvalidCode, \"code scope element has no federationGuid\");\r\n\r\n    return { scopeGuid, specName: iModel.codeSpecs.getById(code.spec).name };\r\n  }\r\n\r\n  /** Turn a `CodeProps` and  `ProposedCodeProps` into a `ProposedCode` for use with a CodeService.\r\n   * @see [[makeScopeAndSpec]] for explanation of why this is necessary.\r\n   */\r\n  export function makeProposedCode(arg: CodeService.MakeProposedCodeArgs): CodeService.ProposedCode {\r\n    return {\r\n      ...arg.props,\r\n      value: arg.code.value,\r\n      ...makeScopeAndSpec(arg.iModel, arg.code),\r\n    };\r\n  }\r\n\r\n  /** The name of a code spec */\r\n  export type CodeSpecName = string;\r\n\r\n  /**\r\n   * The name that identifies the \"originator\" of a code. Usually this is the Guid of the iModel from which a code was added,\r\n   * but can also be used to identify a system or type from an external code service.\r\n   */\r\n  export type CodeOriginName = string;\r\n\r\n  /** The name that identifies the \"author\" of a code. Generally, this is intended to be the name of a person or group that helps identify the purpose of the code. */\r\n  export type AuthorName = string;\r\n\r\n  /** The value for a code. */\r\n  export type CodeValue = string;\r\n\r\n  /** The guid for a code. This identifies the real-world entity associated with the code. */\r\n  export type CodeGuid = GuidString;\r\n\r\n  /** The guid of the scope for a code. This identifies the real-world entity that provides the uniqueness scope for code values. */\r\n  export type ScopeGuid = GuidString;\r\n\r\n  /** An optional number associated with a code that may be used for \"status\" information. Values must be defined by applications. */\r\n  export type CodeState = number;\r\n\r\n  /** The return status of an iteration function. The value \"stop\" causes the iteration to terminate. */\r\n  export type IterationReturn = void | \"stop\";\r\n\r\n  /** An iteration function over codes in a code index. It is called with the Guid of a each code. */\r\n  export type CodeIteration = (guid: GuidString) => IterationReturn;\r\n\r\n  /** An iteration function over code specs in a code index. It is called with the name and json of a each code spec. */\r\n  export type NameAndJsonIteration = (nameAndJson: NameAndJson) => IterationReturn;\r\n\r\n  /** Argument for reserving an array of new codes. */\r\n  export interface ReserveCodesArgs {\r\n    /** an array of proposed codes to reserve.\r\n     * @note the guid of each proposed code must be supplied by the caller.\r\n     */\r\n    readonly codes: CodeService.ProposedCode[];\r\n    /** If true, unless all codes are available, don't reserve any codes. Otherwise reserve all available codes. */\r\n    readonly allOrNothing?: true;\r\n  }\r\n\r\n  /** Argument for reserving a code from a code sequence. */\r\n  export interface ReserveNextArgs {\r\n    /** the properties of the new code */\r\n    readonly code: CodeService.ProposedCodeProps;\r\n    /** The code sequence and scope for the new code. */\r\n    readonly from: SequenceScope;\r\n  }\r\n\r\n  /** Argument for reserving an array of codes from a code sequence. */\r\n  export interface ReserveNextArrayArgs {\r\n    /** an array of proposed codes to reserve.  */\r\n    readonly codes: CodeService.ProposedCodeProps[];\r\n    /** The code sequence and scope for the new codes. */\r\n    readonly from: CodeService.SequenceScope;\r\n    /** If true, and in the event that the code sequence does not have enough available codes to fulfill all the entries in `codes`,\r\n     * return as many as possible. Otherwise no codes are reserved. The `problems` member of the exception can be used to determine how many codes were available.\r\n     * @note if `asManyAsPossible` is true, no error is thrown if the sequence becomes full. You must check the return value to see how many\r\n     * were actually available. The `value` member will be undefined for any proposed codes that were not reserved.\r\n     */\r\n    readonly asManyAsPossible?: true;\r\n  }\r\n\r\n  /** Argument for updating an array of codes. */\r\n  export interface UpdateCodesArgs {\r\n    /** Properties of the codes to update */\r\n    readonly props: CodeService.UpdatedCode[];\r\n    /** If true, unless all codes are updated, don't update any codes. Otherwise update all possible codes. */\r\n    readonly allOrNothing?: true;\r\n  }\r\n\r\n  /** Arguments for CodeService.makeProposedCode  */\r\n  export interface MakeProposedCodeArgs {\r\n    readonly iModel: IModelDb;\r\n    readonly code: Required<CodeProps>;\r\n    readonly props: CodeService.CodeGuidStateJson;\r\n  }\r\n\r\n  /** The properties of an Element to be checked against the code index.\r\n   * @see CodeService.verifyCode\r\n   */\r\n  export interface ElementCodeProps {\r\n    /** iModel from which the code is being inserted/updated. */\r\n    readonly iModel: IModelDb;\r\n    /** Properties of the code */\r\n    readonly props: {\r\n      /** The imodel-specific code properties. */\r\n      readonly code: CodeProps;\r\n      /**\r\n       * The federationGuid of the element being inserted or updated.\r\n       * If federationGuid is defined, it is must match the value in the code index or an error is thrown.\r\n       * If it is undefined, the value from the code index is returned here.\r\n       */\r\n      federationGuid?: GuidString;\r\n    };\r\n  }\r\n\r\n  /** a name and a json object. Used for code specs, authors and origins. */\r\n  export interface NameAndJson {\r\n    readonly name: string;\r\n    readonly json?: SettingsContainer;\r\n  }\r\n\r\n  /** A code Scope guid, and code spec name. */\r\n  export interface ScopeAndSpec {\r\n    readonly specName: CodeSpecName;\r\n    readonly scopeGuid: ScopeGuid;\r\n  }\r\n\r\n  /** A code Scope guid, code spec, and code value. */\r\n  export interface ScopeSpecAndValue extends ScopeAndSpec {\r\n    readonly value: CodeValue;\r\n  }\r\n\r\n  /** The data held in a code index for a single code. */\r\n  export interface CodeEntry {\r\n    /** The name of the code spec for this code. */\r\n    readonly specName: CodeSpecName;\r\n    /** The guid of the entity that provides the scope for this code. */\r\n    readonly scopeGuid: ScopeGuid;\r\n    /** The value of this code. */\r\n    readonly value: CodeValue;\r\n    /** The guid of the entity this code identifies. */\r\n    readonly guid: CodeGuid;\r\n    /** the state of the code. May be undefined. */\r\n    readonly state?: CodeState;\r\n    /** The name of the originating source of this code (usually an iModel Guid). May be undefined. */\r\n    readonly origin: CodeOriginName;\r\n    /** The name of the author of this code. May be undefined. */\r\n    readonly author?: AuthorName;\r\n    /** Option json properties associated with this code. May be undefined. */\r\n    readonly json?: SettingsContainer;\r\n  }\r\n\r\n  /** A filter used to limit and/or sort the values returned by an iteration. */\r\n  export interface ValueFilter {\r\n    /** A value filter. May include wild cards when used with `GLOB` or `LIKE` */\r\n    readonly value?: string;\r\n    /** The comparison operator for `value`. Default is `=` */\r\n    readonly valueCompare?: \"GLOB\" | \"LIKE\" | \"NOT GLOB\" | \"NOT LIKE\" | \"=\" | \"<\" | \">\";\r\n    /** Order results ascending or descending. If not supplied, the results are unordered (random). */\r\n    readonly orderBy?: \"ASC\" | \"DESC\";\r\n    /** An SQL expression to further filter results. This string is appended to the `WHERE` clause with an `AND` (that should not be part of the sqlExpression) */\r\n    readonly sqlExpression?: string;\r\n  }\r\n\r\n  /** A filter to limit and/or sort the values for the [[CodeIndex.forAllCodes]] iteration. */\r\n  export interface CodeFilter extends ValueFilter {\r\n    /** If supplied, limit results to only those with this spec */\r\n    readonly specName?: CodeSpecName;\r\n    /** If supplied, limit results to only those with this scope Guid */\r\n    readonly scopeGuid?: ScopeGuid;\r\n    /** If supplied, limit results to only those with this origin */\r\n    readonly origin?: CodeOriginName;\r\n  }\r\n\r\n  /** Author and origin information supplied when codes are reserved. */\r\n  export interface AuthorAndOrigin {\r\n    /** The name of the individual or group for whom the code was reserved. */\r\n    readonly author: Mutable<NameAndJson>;\r\n    /** The identity of the \"originator\" of the code. This is usually a guid of an iModel, but can be any unique string. */\r\n    readonly origin: Mutable<NameAndJson>;\r\n  }\r\n\r\n  /** The Guid, state, and json properties of a code. */\r\n  export interface CodeGuidStateJson {\r\n    /** The Guid of the new code. This must be always be supplied by the application. */\r\n    readonly guid: CodeGuid;\r\n    /** An optional value for the state of the code. */\r\n    readonly state?: CodeState;\r\n    /** An optional json object to be stored with the code. */\r\n    readonly json?: SettingsContainer;\r\n  }\r\n\r\n  /** Properties of a \"proposed\" new code to be reserved.\r\n   * @note the Guid of the entity identified by this code *must* be supplied, but `value` is optional, since\r\n   * this may be used to reserve codes from a sequence where the value is generated.\r\n   */\r\n  export interface ProposedCodeProps extends CodeGuidStateJson {\r\n    /** The value for the proposed code.\r\n     * @note For code sequence operations, this value is ignored on input and is set with a new value from the sequence on successful return.\r\n     */\r\n    value?: CodeValue;\r\n  }\r\n\r\n  /** Properties of a proposed new code that is not from a code sequence (its `value` is required). */\r\n  export type ProposedCode = ProposedCodeProps & ScopeSpecAndValue;\r\n\r\n  /** Properties that describe a code sequence and a scope and spec for a proposed code or array of codes from a sequence. */\r\n  export interface SequenceScope extends ScopeAndSpec {\r\n    /** The code sequence. */\r\n    readonly seq: CodeSequence;\r\n    /** A valid current value. If supplied, the returned value will always be later in the sequence than this. */\r\n    readonly start?: CodeValue;\r\n  }\r\n\r\n  /** Properties of a code to be updated.\r\n   * @note The `guid` member identifies the code to be updated and is required.\r\n   * All other properties are optional - if `undefined`, its value is not changed.\r\n   */\r\n  export type UpdatedCode = MarkRequired<Partial<ProposedCode>, \"guid\">;\r\n\r\n  /** A proposed code that could not be reserved due to some error. */\r\n  export interface ReserveProblem {\r\n    /** the proposed code that failed. */\r\n    readonly code: ProposedCode;\r\n    /** the reason for the failure */\r\n    readonly errorId: ErrorId;\r\n    /** the error message from the exception for this proposed code. */\r\n    readonly message: string;\r\n  }\r\n\r\n  /** A update to a code that failed for some error. */\r\n  export interface UpdateProblem {\r\n    /** The properties of the code that was to be updated */\r\n    readonly prop: UpdatedCode;\r\n    /** the reason for the failure */\r\n    readonly errorId: ErrorId;\r\n    /** the error message from the exception for the update request. */\r\n    readonly message: string;\r\n  }\r\n\r\n  /**\r\n   * A sequence of code values following a increasing pattern. Valid code sequences must have a first value, a last value, and\r\n   * a way to get the next valid value from an existing valid value.\r\n   * Code sequences have a `sequenceName` so they can be registered using `CodeService.registerSequence`.\r\n   */\r\n  export interface CodeSequence {\r\n    /** the name of this CodeSequence. */\r\n    get sequenceName(): string;\r\n    /** Get the first valid value for this CodeSequence */\r\n    getFirstValue(): CodeValue;\r\n    /** Get the last valid value for this CodeSequence */\r\n    getLastValue(): CodeValue;\r\n    /** Get the next valid value for this CodeSequence from the supplied value.\r\n     * If the sequence is full (that is, the next value is greater than the last value, this method should throw with errorId=\"SequenceFull\".\r\n     * @return the next valid value according to the rules of this CodeSequence.\r\n     */\r\n    getNextValue(code: CodeValue): CodeValue;\r\n    /** Determine whether this supplied value is valid for this sequence. */\r\n    isValidCode(code: CodeValue): boolean;\r\n  }\r\n\r\n  /** @internal */\r\n  export interface FontIndexProps {\r\n    id?: number;\r\n    fontType: FontType;\r\n    fontName: string;\r\n  }\r\n  /** @internal */\r\n  export interface BisCodeSpecIndexProps {\r\n    id?: number;\r\n    name: string;\r\n    props: string;\r\n  }\r\n\r\n  /** Exception class thrown by `CodeService` methods. */\r\n  export class Error extends BentleyError {\r\n    /** A string that indicates the type of problem that caused the exception. */\r\n    public readonly errorId: ErrorId;\r\n    /** For [[CodeService.reserveCodes]] and [[CodeService.updateCodes]], a list of the problem details. */\r\n    public readonly problems?: ReserveProblem[] | UpdateProblem[];\r\n\r\n    /** @internal */\r\n    constructor(errorId: ErrorId, errNum: number, message: string, problems?: ReserveProblem[] | UpdateProblem[]) {\r\n      super(errNum, message);\r\n      this.errorId = errorId;\r\n      this.problems = problems;\r\n    }\r\n  }\r\n\r\n  /** Identifiers for exceptions thrown by `CodeService` methods.\r\n   * @see [[CodeService.Error.errorId]]\r\n   */\r\n  export type ErrorId =\r\n    \"BadIndexProps\" |\r\n    \"CorruptIModel\" |\r\n    \"CorruptIndex\" |\r\n    \"DuplicateValue\" |\r\n    \"GuidIsInUse\" |\r\n    \"GuidMismatch\" |\r\n    \"IllegalValue\" |\r\n    \"InconsistentIModels\" |\r\n    \"IndexReadonly\" |\r\n    \"InvalidCodeScope\" |\r\n    \"InvalidGuid\" |\r\n    \"InvalidSequence\" |\r\n    \"MissingCode\" |\r\n    \"MissingGuid\" |\r\n    \"MissingInput\" |\r\n    \"MissingSpec\" |\r\n    \"NoCodeIndex\" |\r\n    \"NotAuthorized\" |\r\n    \"SequenceFull\" |\r\n    \"ReserveErrors\" |\r\n    \"SequenceNotFound\" |\r\n    \"SqlLogicError\" |\r\n    \"UpdateErrors\" |\r\n    \"ValueIsInUse\" |\r\n    \"WrongVersion\";\r\n\r\n}\r\n"]}

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

@@ -1 +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;AAGvD,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"}
+{"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/cjs/DevTools.js

@@ -10,6 +10,7 @@ const process = require("process");
 const core_bentley_1 = require("@itwin/core-bentley");
 const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
 const IModelHost_1 = require("./IModelHost");
+const NativePlatform_1 = require("./internal/NativePlatform");
 // cspell:ignore ppid elap
 const loggerCategory = BackendLoggerCategory_1.BackendLoggerCategory.DevTools;
 /** Utility to format the JSON created by DevTools.stats() to include the appropriate units
@@ -140,7 +141,7 @@ class DevTools {
         const oldLevel = core_bentley_1.Logger.getLevel(inLoggerCategory);
         core_bentley_1.Logger.logInfo(loggerCategory, `Setting log level`, () => ({ loggerCategory: inLoggerCategory, oldLevel, newLevel }));
         core_bentley_1.Logger.setLevel(inLoggerCategory, newLevel);
-        IModelHost_1.IModelHost.platform.clearLogLevelCache();
+        NativePlatform_1.IModelNative.platform.clearLogLevelCache();
         return oldLevel;
     }
     /** Obtains the backend application and iTwin.js Core versions */

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,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,qBAAM,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,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,EAAE,yDAAyD;YACzG,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;AAC1C,8DAAyD;AAGzD,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,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,qBAAM,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,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,6BAAY,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,uBAAU,CAAC,kBAAkB;YAC1C,OAAO,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC,OAAO,EAAE,yDAAyD;YACzG,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 { IModelNative } from \"./internal/NativePlatform\";\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    IModelNative.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

@@ -12,7 +12,6 @@ import { IModelElementCloneContext } from "./IModelElementCloneContext";
  * @public
  */
 export declare abstract class DisplayStyle extends DefinitionElement {
-    /** @internal */
     static get className(): string;
     abstract get settings(): DisplayStyleSettings;
     protected constructor(props: DisplayStyleProps, iModel: IModelDb);
@@ -31,7 +30,6 @@ export declare abstract class DisplayStyle extends DefinitionElement {
  * @public
  */
 export declare class DisplayStyle2d extends DisplayStyle {
-    /** @internal */
     static get className(): string;
     private readonly _settings;
     get settings(): DisplayStyleSettings;
@@ -73,7 +71,6 @@ export interface DisplayStyleCreationOptions extends Omit<DisplayStyle3dSettings
  * @public
  */
 export declare class DisplayStyle3d extends DisplayStyle {
-    /** @internal */
     static get className(): string;
     private readonly _settings;
     get settings(): DisplayStyle3dSettings;

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

@@ -1 +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,EAAE,kBAAkB,EAA+B,cAAc,EAAoB,SAAS,EACtI,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,gBAAgB;IAChB,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;IAiDnJ,kBAAkB,IAAI,cAAc,CAAC,eAAe,GAAG,SAAS;CAgBxE;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C,gBAAgB;IAChB,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,gBAAgB;IAChB,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;IAU9E,aAAa;qBACa,QAAQ,CAAC,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,mBAAmB,GAAG,IAAI;IA+B9J;;;;;;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"}
+{"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,EAAE,kBAAkB,EAA+B,cAAc,EAAoB,SAAS,EACtI,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;IAiDnJ,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;IAU9E,aAAa;qBACa,QAAQ,CAAC,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,mBAAmB,GAAG,IAAI;IA+B9J;;;;;;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/cjs/DisplayStyle.js

@@ -17,7 +17,6 @@ const Element_1 = require("./Element");
  * @public
  */
 class DisplayStyle extends Element_1.DefinitionElement {
-    /** @internal */
     static get className() { return "DisplayStyle"; }
     constructor(props, iModel) {
         super(props, iModel);
@@ -114,7 +113,6 @@ exports.DisplayStyle = DisplayStyle;
  * @public
  */
 class DisplayStyle2d extends DisplayStyle {
-    /** @internal */
     static get className() { return "DisplayStyle2d"; }
     get settings() { return this._settings; }
     constructor(props, iModel) {
@@ -162,7 +160,6 @@ exports.DisplayStyle2d = DisplayStyle2d;
  * @public
  */
 class DisplayStyle3d extends DisplayStyle {
-    /** @internal */
     static get className() { return "DisplayStyle3d"; }
     get settings() { return this._settings; }
     constructor(props, iModel) {

package/lib/cjs/DisplayStyle.js.map

@@ -1 +1 @@
-{"version":3,"file":"DisplayStyle.js","sourceRoot":"","sources":["../../src/DisplayStyle.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA0G;AAC1G,oDAG4B;AAC5B,uCAA8D;AAI9D;;;;GAIG;AACH,MAAsB,YAAa,SAAQ,2BAAiB;IAC1D,gBAAgB;IACT,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,yBAAW,CAAC,YAAY,CAAC,CAAC;QAChF,OAAO,IAAI,kBAAI,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,CAAC,8CAA8C;QAC3F,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,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;gBAC1D,MAAM,GAAG,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;gBACvC,GAAG,CAAC,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;gBAC9E,IAAI,mBAAI,CAAC,OAAO,KAAK,GAAG,CAAC,WAAW;oBAClC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;;oBAErC,CAAC,EAAE,CAAC;YACR,CAAC;QACH,CAAC;QAED,IAAI,QAAQ,CAAC,gBAAgB,EAAE,CAAC;YAC9B,MAAM,QAAQ,GAAc,QAAQ,KAAK,OAAO,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,gCAAiB,CAAC,eAAe,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YACrK,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;gBAC3C,MAAM,QAAQ,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC1D,IAAI,mBAAI,CAAC,OAAO,KAAK,QAAQ;oBAC3B,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;;oBAEtB,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC;YAC7B,CAAC;YAED,IAAI,CAAC,KAAK,QAAQ,CAAC,MAAM;gBACvB,OAAO,QAAQ,CAAC,gBAAgB,CAAC;;gBAEjC,QAAQ,CAAC,gBAAgB,GAAG,gCAAiB,CAAC,WAAW,CAAC,kCAAmB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvG,CAAC;QAED,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;YAC5B,MAAM,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YAC5E,IAAI,mBAAI,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,wBAAc,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,4BAAc,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,4BAAc,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,4BAAc,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3H,CAAC;CACF;AAvGD,oCAuGC;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,YAAY;IAC9C,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAG3E,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,kCAAoB,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,sBAAQ,CAAC,KAAK,CAAC,MAAM,EAAE;oBACxC,SAAS,EAAE,uBAAS,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;AA7CD,wCA6CC;AAkBD;;;GAGG;AACH,MAAa,cAAe,SAAQ,YAAY;IAC9C,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAG3E,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,oCAAsB,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;IACxD,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,mBAAI,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,mBAAI,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,mBAAI,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;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,uBAAS,EAAE,CAAC,MAAM,EAAE,CAAC;QAE5D,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,YAAY,sBAAQ,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;AAlGD,wCAkGC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module ViewDefinitions\r\n */\r\n\r\nimport { CompressedId64Set, Id64, Id64Array, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\r\nimport {\r\n  BisCodeSpec, Code, CodeScopeProps, CodeSpec, ColorDef, DisplayStyle3dProps, DisplayStyle3dSettings, DisplayStyle3dSettingsProps,\r\n  DisplayStyleProps, DisplayStyleSettings, EntityReferenceSet, PlanProjectionSettingsProps, RenderSchedule, SkyBoxImageProps, ViewFlags,\r\n} from \"@itwin/core-common\";\r\nimport { DefinitionElement, RenderTimeline } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { IModelElementCloneContext } from \"./IModelElementCloneContext\";\r\n\r\n/** A DisplayStyle defines the parameters for 'styling' the contents of a view.\r\n * Internally a DisplayStyle consists of a dictionary of several named 'styles' describing specific aspects of the display style as a whole.\r\n * Many ViewDefinitions may share the same DisplayStyle.\r\n * @public\r\n */\r\nexport abstract class DisplayStyle extends DefinitionElement {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DisplayStyle\"; }\r\n  public abstract get settings(): DisplayStyleSettings;\r\n\r\n  protected constructor(props: DisplayStyleProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n  }\r\n\r\n  /** Create a Code for a DisplayStyle given a name that is meant to be unique within the scope of the specified DefinitionModel.\r\n   * @param iModel  The IModelDb\r\n   * @param scopeModelId The Id of the DefinitionModel that contains the DisplayStyle and provides the scope for its name.\r\n   * @param codeValue The DisplayStyle name\r\n   */\r\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.displayStyle);\r\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    for (const [id] of this.settings.subCategoryOverrides) {\r\n      referenceIds.addElement(id);\r\n    }\r\n\r\n    for (const excludedElementId of this.settings.excludedElementIds)\r\n      referenceIds.addElement(excludedElementId);\r\n\r\n    if (this.settings.renderTimeline) {\r\n      referenceIds.addElement(this.settings.renderTimeline);\r\n    } else {\r\n      const script = this.loadScheduleScript();\r\n      if (script)\r\n        script.script.discloseIds(referenceIds); // eslint-disable-line deprecation/deprecation\r\n    }\r\n  }\r\n\r\n  /** @alpha */\r\n  protected static override onCloned(context: IModelElementCloneContext, sourceElementProps: DisplayStyleProps, targetElementProps: DisplayStyleProps): void {\r\n    super.onCloned(context, sourceElementProps, targetElementProps);\r\n\r\n    if (!context.isBetweenIModels || !targetElementProps.jsonProperties?.styles)\r\n      return;\r\n\r\n    const settings = targetElementProps.jsonProperties.styles;\r\n    if (settings.subCategoryOvr) {\r\n      for (let i = 0; i < settings.subCategoryOvr.length; /* */) {\r\n        const ovr = settings.subCategoryOvr[i];\r\n        ovr.subCategory = context.findTargetElementId(Id64.fromJSON(ovr.subCategory));\r\n        if (Id64.invalid === ovr.subCategory)\r\n          settings.subCategoryOvr.splice(i, 1);\r\n        else\r\n          i++;\r\n      }\r\n    }\r\n\r\n    if (settings.excludedElements) {\r\n      const excluded: Id64Array = \"string\" === typeof settings.excludedElements ? CompressedId64Set.decompressArray(settings.excludedElements) : settings.excludedElements;\r\n      for (let i = 0; i < excluded.length; /* */) {\r\n        const remapped = context.findTargetElementId(excluded[i]);\r\n        if (Id64.invalid === remapped)\r\n          excluded.splice(i, 1);\r\n        else\r\n          excluded[i++] = remapped;\r\n      }\r\n\r\n      if (0 === excluded.length)\r\n        delete settings.excludedElements;\r\n      else\r\n        settings.excludedElements = CompressedId64Set.compressIds(OrderedId64Iterable.sortArray(excluded));\r\n    }\r\n\r\n    if (settings.renderTimeline) {\r\n      const renderTimeline = context.findTargetElementId(settings.renderTimeline);\r\n      if (Id64.isValid(renderTimeline))\r\n        settings.renderTimeline = renderTimeline;\r\n      else\r\n        delete settings.renderTimeline;\r\n    } else if (settings.scheduleScript) {\r\n      const scheduleScript = RenderTimeline.remapScript(context, settings.scheduleScript);\r\n      if (scheduleScript.length > 0)\r\n        settings.scheduleScript = scheduleScript;\r\n      else\r\n        delete settings.scheduleScript;\r\n    }\r\n  }\r\n\r\n  public loadScheduleScript(): RenderSchedule.ScriptReference | undefined {\r\n    let script;\r\n    let sourceId;\r\n    if (this.settings.renderTimeline) {\r\n      const timeline = this.iModel.elements.tryGetElement<RenderTimeline>(this.settings.renderTimeline);\r\n      if (timeline) {\r\n        script = RenderSchedule.Script.fromJSON(timeline.scriptProps);\r\n        sourceId = timeline.id;\r\n      }\r\n    } else if (this.settings.scheduleScriptProps) {\r\n      script = RenderSchedule.Script.fromJSON(this.settings.scheduleScriptProps);\r\n      sourceId = this.id;\r\n    }\r\n\r\n    return undefined !== sourceId && undefined !== script ? new RenderSchedule.ScriptReference(sourceId, script) : undefined;\r\n  }\r\n}\r\n\r\n/** A DisplayStyle for 2d views.\r\n * @public\r\n */\r\nexport class DisplayStyle2d extends DisplayStyle {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DisplayStyle2d\"; }\r\n  private readonly _settings: DisplayStyleSettings;\r\n\r\n  public get settings(): DisplayStyleSettings { return this._settings; }\r\n\r\n  protected constructor(props: DisplayStyleProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this._settings = new DisplayStyleSettings(this.jsonProperties);\r\n  }\r\n  /** Create a DisplayStyle2d for use by a ViewDefinition.\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param name The name/CodeValue of the DisplayStyle2d\r\n   * @returns The newly constructed DisplayStyle2d element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DisplayStyle2d {\r\n    const displayStyleProps: DisplayStyleProps = {\r\n      classFullName: this.classFullName,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n      model: definitionModelId,\r\n      isPrivate: false,\r\n      jsonProperties: {\r\n        styles: {\r\n          backgroundColor: 0,\r\n          monochromeColor: ColorDef.white.toJSON(),\r\n          viewflags: ViewFlags.defaults,\r\n        },\r\n      },\r\n    };\r\n    return new DisplayStyle2d(displayStyleProps, iModelDb);\r\n  }\r\n  /** Insert a DisplayStyle2d for use by a ViewDefinition.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param definitionModelId Insert the new DisplayStyle2d into this DefinitionModel\r\n   * @param name The name of the DisplayStyle2d\r\n   * @returns The Id of the newly inserted DisplayStyle2d element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string): Id64String {\r\n    const displayStyle = this.create(iModelDb, definitionModelId, name);\r\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\r\n  }\r\n}\r\n\r\n/** Describes initial settings for a new [[DisplayStyle3d]].\r\n * Most properties are inherited from [DisplayStyle3dSettingsProps]($common), but for backwards compatibility reasons, this interface is slightly awkward:\r\n * - It adds a `viewFlags` member that differs only in case and type from [DisplayStyleSettingsProps.viewflags]($common); and\r\n * - It extends the type of [DisplayStyleSettingsProps.backgroundColor]($common) to include [ColorDef]($common).\r\n * These idiosyncrasies will be addressed in a future version of core-backend.\r\n * @see [[DisplayStyle3d.create]].\r\n * @public\r\n */\r\nexport interface DisplayStyleCreationOptions extends Omit<DisplayStyle3dSettingsProps, \"backgroundColor\" | \"scheduleScript\"> {\r\n  /** If supplied, the [ViewFlags]($common) applied by the display style.\r\n   * If undefined, [DisplayStyle3dSettingsProps.viewflags]($common) will be used if present (note the difference in case); otherwise, default-constructed [ViewFlags]($common) will be used.\r\n   */\r\n  viewFlags?: ViewFlags;\r\n  backgroundColor?: ColorDef | number;\r\n}\r\n\r\n/** A DisplayStyle for 3d views.\r\n * See [how to create a DisplayStyle3d]$(docs/learning/backend/CreateElements.md#DisplayStyle3d).\r\n * @public\r\n */\r\nexport class DisplayStyle3d extends DisplayStyle {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DisplayStyle3d\"; }\r\n  private readonly _settings: DisplayStyle3dSettings;\r\n\r\n  public get settings(): DisplayStyle3dSettings { return this._settings; }\r\n\r\n  protected constructor(props: DisplayStyle3dProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this._settings = new DisplayStyle3dSettings(this.jsonProperties);\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    for (const textureId of this.settings.environment.sky.textureIds)\r\n      referenceIds.addElement(textureId);\r\n\r\n    if (this.settings.planProjectionSettings)\r\n      for (const planProjectionSetting of this.settings.planProjectionSettings)\r\n        referenceIds.addElement(planProjectionSetting[0]);\r\n  }\r\n\r\n  /** @alpha */\r\n  protected static override onCloned(context: IModelElementCloneContext, sourceElementProps: DisplayStyle3dProps, targetElementProps: DisplayStyle3dProps): void {\r\n    super.onCloned(context, sourceElementProps, targetElementProps);\r\n    if (context.isBetweenIModels) {\r\n      const convertTexture = (id: string) => Id64.isValidId64(id) ? context.findTargetElementId(id) : id;\r\n\r\n      const skyBoxImageProps: SkyBoxImageProps | undefined = targetElementProps?.jsonProperties?.styles?.environment?.sky?.image;\r\n      if (skyBoxImageProps?.texture && Id64.isValidId64(skyBoxImageProps.texture))\r\n        skyBoxImageProps.texture = convertTexture(skyBoxImageProps.texture);\r\n\r\n      if (skyBoxImageProps?.textures) {\r\n        skyBoxImageProps.textures.front = convertTexture(skyBoxImageProps.textures.front);\r\n        skyBoxImageProps.textures.back = convertTexture(skyBoxImageProps.textures.back);\r\n        skyBoxImageProps.textures.left = convertTexture(skyBoxImageProps.textures.left);\r\n        skyBoxImageProps.textures.right = convertTexture(skyBoxImageProps.textures.right);\r\n        skyBoxImageProps.textures.top = convertTexture(skyBoxImageProps.textures.top);\r\n        skyBoxImageProps.textures.bottom = convertTexture(skyBoxImageProps.textures.bottom);\r\n      }\r\n\r\n      if (targetElementProps?.jsonProperties?.styles?.planProjections) {\r\n        const remappedPlanProjections: { [modelId: string]: PlanProjectionSettingsProps } = {};\r\n        for (const entry of Object.entries(targetElementProps.jsonProperties.styles.planProjections)) {\r\n          const remappedModelId: Id64String = context.findTargetElementId(entry[0]);\r\n          if (Id64.isValidId64(remappedModelId)) {\r\n            remappedPlanProjections[remappedModelId] = entry[1];\r\n          }\r\n        }\r\n        targetElementProps.jsonProperties.styles.planProjections = remappedPlanProjections;\r\n      }\r\n    }\r\n  }\r\n\r\n  /** Create a DisplayStyle3d for use by a ViewDefinition.\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param name The name/CodeValue of the DisplayStyle3d\r\n   * @returns The newly constructed DisplayStyle3d element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): DisplayStyle3d {\r\n    options = options ?? {};\r\n    let viewflags = options.viewFlags?.toJSON();\r\n    if (!viewflags)\r\n      viewflags = options.viewflags ?? new ViewFlags().toJSON();\r\n\r\n    const backgroundColor = options.backgroundColor instanceof ColorDef ? options.backgroundColor.toJSON() : options.backgroundColor;\r\n\r\n    const settings: DisplayStyle3dSettingsProps = {\r\n      ...options,\r\n      viewflags,\r\n      backgroundColor,\r\n    };\r\n\r\n    const displayStyleProps: DisplayStyle3dProps = {\r\n      classFullName: this.classFullName,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n      model: definitionModelId,\r\n      jsonProperties: { styles: settings },\r\n      isPrivate: false,\r\n\r\n    };\r\n\r\n    return new DisplayStyle3d(displayStyleProps, iModelDb);\r\n  }\r\n  /**\r\n   * Insert a DisplayStyle3d for use by a ViewDefinition.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param definitionModelId Insert the new DisplayStyle3d into this [[DefinitionModel]]\r\n   * @param name The name of the DisplayStyle3d\r\n   * @returns The Id of the newly inserted DisplayStyle3d element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): Id64String {\r\n    const displayStyle = this.create(iModelDb, definitionModelId, name, options);\r\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"DisplayStyle.js","sourceRoot":"","sources":["../../src/DisplayStyle.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA0G;AAC1G,oDAG4B;AAC5B,uCAA8D;AAI9D;;;;GAIG;AACH,MAAsB,YAAa,SAAQ,2BAAiB;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,yBAAW,CAAC,YAAY,CAAC,CAAC;QAChF,OAAO,IAAI,kBAAI,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,CAAC,8CAA8C;QAC3F,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,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;gBAC1D,MAAM,GAAG,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;gBACvC,GAAG,CAAC,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;gBAC9E,IAAI,mBAAI,CAAC,OAAO,KAAK,GAAG,CAAC,WAAW;oBAClC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;;oBAErC,CAAC,EAAE,CAAC;YACR,CAAC;QACH,CAAC;QAED,IAAI,QAAQ,CAAC,gBAAgB,EAAE,CAAC;YAC9B,MAAM,QAAQ,GAAc,QAAQ,KAAK,OAAO,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,gCAAiB,CAAC,eAAe,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YACrK,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;gBAC3C,MAAM,QAAQ,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC1D,IAAI,mBAAI,CAAC,OAAO,KAAK,QAAQ;oBAC3B,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;;oBAEtB,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC;YAC7B,CAAC;YAED,IAAI,CAAC,KAAK,QAAQ,CAAC,MAAM;gBACvB,OAAO,QAAQ,CAAC,gBAAgB,CAAC;;gBAEjC,QAAQ,CAAC,gBAAgB,GAAG,gCAAiB,CAAC,WAAW,CAAC,kCAAmB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvG,CAAC;QAED,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;YAC5B,MAAM,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YAC5E,IAAI,mBAAI,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,wBAAc,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,4BAAc,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,4BAAc,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,4BAAc,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3H,CAAC;CACF;AAtGD,oCAsGC;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,YAAY;IACvC,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAG3E,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,kCAAoB,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,sBAAQ,CAAC,KAAK,CAAC,MAAM,EAAE;oBACxC,SAAS,EAAE,uBAAS,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;AA5CD,wCA4CC;AAkBD;;;GAGG;AACH,MAAa,cAAe,SAAQ,YAAY;IACvC,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAG3E,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,oCAAsB,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;IACxD,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,mBAAI,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,mBAAI,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,mBAAI,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;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,uBAAS,EAAE,CAAC,MAAM,EAAE,CAAC;QAE5D,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,YAAY,sBAAQ,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;AAjGD,wCAiGC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module ViewDefinitions\r\n */\r\n\r\nimport { CompressedId64Set, Id64, Id64Array, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\r\nimport {\r\n  BisCodeSpec, Code, CodeScopeProps, CodeSpec, ColorDef, DisplayStyle3dProps, DisplayStyle3dSettings, DisplayStyle3dSettingsProps,\r\n  DisplayStyleProps, DisplayStyleSettings, EntityReferenceSet, PlanProjectionSettingsProps, RenderSchedule, SkyBoxImageProps, ViewFlags,\r\n} from \"@itwin/core-common\";\r\nimport { DefinitionElement, RenderTimeline } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { IModelElementCloneContext } from \"./IModelElementCloneContext\";\r\n\r\n/** A DisplayStyle defines the parameters for 'styling' the contents of a view.\r\n * Internally a DisplayStyle consists of a dictionary of several named 'styles' describing specific aspects of the display style as a whole.\r\n * Many ViewDefinitions may share the same DisplayStyle.\r\n * @public\r\n */\r\nexport abstract class DisplayStyle extends DefinitionElement {\r\n  public static override get className(): string { return \"DisplayStyle\"; }\r\n  public abstract get settings(): DisplayStyleSettings;\r\n\r\n  protected constructor(props: DisplayStyleProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n  }\r\n\r\n  /** Create a Code for a DisplayStyle given a name that is meant to be unique within the scope of the specified DefinitionModel.\r\n   * @param iModel  The IModelDb\r\n   * @param scopeModelId The Id of the DefinitionModel that contains the DisplayStyle and provides the scope for its name.\r\n   * @param codeValue The DisplayStyle name\r\n   */\r\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.displayStyle);\r\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    for (const [id] of this.settings.subCategoryOverrides) {\r\n      referenceIds.addElement(id);\r\n    }\r\n\r\n    for (const excludedElementId of this.settings.excludedElementIds)\r\n      referenceIds.addElement(excludedElementId);\r\n\r\n    if (this.settings.renderTimeline) {\r\n      referenceIds.addElement(this.settings.renderTimeline);\r\n    } else {\r\n      const script = this.loadScheduleScript();\r\n      if (script)\r\n        script.script.discloseIds(referenceIds); // eslint-disable-line deprecation/deprecation\r\n    }\r\n  }\r\n\r\n  /** @alpha */\r\n  protected static override onCloned(context: IModelElementCloneContext, sourceElementProps: DisplayStyleProps, targetElementProps: DisplayStyleProps): void {\r\n    super.onCloned(context, sourceElementProps, targetElementProps);\r\n\r\n    if (!context.isBetweenIModels || !targetElementProps.jsonProperties?.styles)\r\n      return;\r\n\r\n    const settings = targetElementProps.jsonProperties.styles;\r\n    if (settings.subCategoryOvr) {\r\n      for (let i = 0; i < settings.subCategoryOvr.length; /* */) {\r\n        const ovr = settings.subCategoryOvr[i];\r\n        ovr.subCategory = context.findTargetElementId(Id64.fromJSON(ovr.subCategory));\r\n        if (Id64.invalid === ovr.subCategory)\r\n          settings.subCategoryOvr.splice(i, 1);\r\n        else\r\n          i++;\r\n      }\r\n    }\r\n\r\n    if (settings.excludedElements) {\r\n      const excluded: Id64Array = \"string\" === typeof settings.excludedElements ? CompressedId64Set.decompressArray(settings.excludedElements) : settings.excludedElements;\r\n      for (let i = 0; i < excluded.length; /* */) {\r\n        const remapped = context.findTargetElementId(excluded[i]);\r\n        if (Id64.invalid === remapped)\r\n          excluded.splice(i, 1);\r\n        else\r\n          excluded[i++] = remapped;\r\n      }\r\n\r\n      if (0 === excluded.length)\r\n        delete settings.excludedElements;\r\n      else\r\n        settings.excludedElements = CompressedId64Set.compressIds(OrderedId64Iterable.sortArray(excluded));\r\n    }\r\n\r\n    if (settings.renderTimeline) {\r\n      const renderTimeline = context.findTargetElementId(settings.renderTimeline);\r\n      if (Id64.isValid(renderTimeline))\r\n        settings.renderTimeline = renderTimeline;\r\n      else\r\n        delete settings.renderTimeline;\r\n    } else if (settings.scheduleScript) {\r\n      const scheduleScript = RenderTimeline.remapScript(context, settings.scheduleScript);\r\n      if (scheduleScript.length > 0)\r\n        settings.scheduleScript = scheduleScript;\r\n      else\r\n        delete settings.scheduleScript;\r\n    }\r\n  }\r\n\r\n  public loadScheduleScript(): RenderSchedule.ScriptReference | undefined {\r\n    let script;\r\n    let sourceId;\r\n    if (this.settings.renderTimeline) {\r\n      const timeline = this.iModel.elements.tryGetElement<RenderTimeline>(this.settings.renderTimeline);\r\n      if (timeline) {\r\n        script = RenderSchedule.Script.fromJSON(timeline.scriptProps);\r\n        sourceId = timeline.id;\r\n      }\r\n    } else if (this.settings.scheduleScriptProps) {\r\n      script = RenderSchedule.Script.fromJSON(this.settings.scheduleScriptProps);\r\n      sourceId = this.id;\r\n    }\r\n\r\n    return undefined !== sourceId && undefined !== script ? new RenderSchedule.ScriptReference(sourceId, script) : undefined;\r\n  }\r\n}\r\n\r\n/** A DisplayStyle for 2d views.\r\n * @public\r\n */\r\nexport class DisplayStyle2d extends DisplayStyle {\r\n  public static override get className(): string { return \"DisplayStyle2d\"; }\r\n  private readonly _settings: DisplayStyleSettings;\r\n\r\n  public get settings(): DisplayStyleSettings { return this._settings; }\r\n\r\n  protected constructor(props: DisplayStyleProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this._settings = new DisplayStyleSettings(this.jsonProperties);\r\n  }\r\n  /** Create a DisplayStyle2d for use by a ViewDefinition.\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param name The name/CodeValue of the DisplayStyle2d\r\n   * @returns The newly constructed DisplayStyle2d element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DisplayStyle2d {\r\n    const displayStyleProps: DisplayStyleProps = {\r\n      classFullName: this.classFullName,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n      model: definitionModelId,\r\n      isPrivate: false,\r\n      jsonProperties: {\r\n        styles: {\r\n          backgroundColor: 0,\r\n          monochromeColor: ColorDef.white.toJSON(),\r\n          viewflags: ViewFlags.defaults,\r\n        },\r\n      },\r\n    };\r\n    return new DisplayStyle2d(displayStyleProps, iModelDb);\r\n  }\r\n  /** Insert a DisplayStyle2d for use by a ViewDefinition.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param definitionModelId Insert the new DisplayStyle2d into this DefinitionModel\r\n   * @param name The name of the DisplayStyle2d\r\n   * @returns The Id of the newly inserted DisplayStyle2d element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string): Id64String {\r\n    const displayStyle = this.create(iModelDb, definitionModelId, name);\r\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\r\n  }\r\n}\r\n\r\n/** Describes initial settings for a new [[DisplayStyle3d]].\r\n * Most properties are inherited from [DisplayStyle3dSettingsProps]($common), but for backwards compatibility reasons, this interface is slightly awkward:\r\n * - It adds a `viewFlags` member that differs only in case and type from [DisplayStyleSettingsProps.viewflags]($common); and\r\n * - It extends the type of [DisplayStyleSettingsProps.backgroundColor]($common) to include [ColorDef]($common).\r\n * These idiosyncrasies will be addressed in a future version of core-backend.\r\n * @see [[DisplayStyle3d.create]].\r\n * @public\r\n */\r\nexport interface DisplayStyleCreationOptions extends Omit<DisplayStyle3dSettingsProps, \"backgroundColor\" | \"scheduleScript\"> {\r\n  /** If supplied, the [ViewFlags]($common) applied by the display style.\r\n   * If undefined, [DisplayStyle3dSettingsProps.viewflags]($common) will be used if present (note the difference in case); otherwise, default-constructed [ViewFlags]($common) will be used.\r\n   */\r\n  viewFlags?: ViewFlags;\r\n  backgroundColor?: ColorDef | number;\r\n}\r\n\r\n/** A DisplayStyle for 3d views.\r\n * See [how to create a DisplayStyle3d]$(docs/learning/backend/CreateElements.md#DisplayStyle3d).\r\n * @public\r\n */\r\nexport class DisplayStyle3d extends DisplayStyle {\r\n  public static override get className(): string { return \"DisplayStyle3d\"; }\r\n  private readonly _settings: DisplayStyle3dSettings;\r\n\r\n  public get settings(): DisplayStyle3dSettings { return this._settings; }\r\n\r\n  protected constructor(props: DisplayStyle3dProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this._settings = new DisplayStyle3dSettings(this.jsonProperties);\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    for (const textureId of this.settings.environment.sky.textureIds)\r\n      referenceIds.addElement(textureId);\r\n\r\n    if (this.settings.planProjectionSettings)\r\n      for (const planProjectionSetting of this.settings.planProjectionSettings)\r\n        referenceIds.addElement(planProjectionSetting[0]);\r\n  }\r\n\r\n  /** @alpha */\r\n  protected static override onCloned(context: IModelElementCloneContext, sourceElementProps: DisplayStyle3dProps, targetElementProps: DisplayStyle3dProps): void {\r\n    super.onCloned(context, sourceElementProps, targetElementProps);\r\n    if (context.isBetweenIModels) {\r\n      const convertTexture = (id: string) => Id64.isValidId64(id) ? context.findTargetElementId(id) : id;\r\n\r\n      const skyBoxImageProps: SkyBoxImageProps | undefined = targetElementProps?.jsonProperties?.styles?.environment?.sky?.image;\r\n      if (skyBoxImageProps?.texture && Id64.isValidId64(skyBoxImageProps.texture))\r\n        skyBoxImageProps.texture = convertTexture(skyBoxImageProps.texture);\r\n\r\n      if (skyBoxImageProps?.textures) {\r\n        skyBoxImageProps.textures.front = convertTexture(skyBoxImageProps.textures.front);\r\n        skyBoxImageProps.textures.back = convertTexture(skyBoxImageProps.textures.back);\r\n        skyBoxImageProps.textures.left = convertTexture(skyBoxImageProps.textures.left);\r\n        skyBoxImageProps.textures.right = convertTexture(skyBoxImageProps.textures.right);\r\n        skyBoxImageProps.textures.top = convertTexture(skyBoxImageProps.textures.top);\r\n        skyBoxImageProps.textures.bottom = convertTexture(skyBoxImageProps.textures.bottom);\r\n      }\r\n\r\n      if (targetElementProps?.jsonProperties?.styles?.planProjections) {\r\n        const remappedPlanProjections: { [modelId: string]: PlanProjectionSettingsProps } = {};\r\n        for (const entry of Object.entries(targetElementProps.jsonProperties.styles.planProjections)) {\r\n          const remappedModelId: Id64String = context.findTargetElementId(entry[0]);\r\n          if (Id64.isValidId64(remappedModelId)) {\r\n            remappedPlanProjections[remappedModelId] = entry[1];\r\n          }\r\n        }\r\n        targetElementProps.jsonProperties.styles.planProjections = remappedPlanProjections;\r\n      }\r\n    }\r\n  }\r\n\r\n  /** Create a DisplayStyle3d for use by a ViewDefinition.\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param name The name/CodeValue of the DisplayStyle3d\r\n   * @returns The newly constructed DisplayStyle3d element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): DisplayStyle3d {\r\n    options = options ?? {};\r\n    let viewflags = options.viewFlags?.toJSON();\r\n    if (!viewflags)\r\n      viewflags = options.viewflags ?? new ViewFlags().toJSON();\r\n\r\n    const backgroundColor = options.backgroundColor instanceof ColorDef ? options.backgroundColor.toJSON() : options.backgroundColor;\r\n\r\n    const settings: DisplayStyle3dSettingsProps = {\r\n      ...options,\r\n      viewflags,\r\n      backgroundColor,\r\n    };\r\n\r\n    const displayStyleProps: DisplayStyle3dProps = {\r\n      classFullName: this.classFullName,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n      model: definitionModelId,\r\n      jsonProperties: { styles: settings },\r\n      isPrivate: false,\r\n\r\n    };\r\n\r\n    return new DisplayStyle3d(displayStyleProps, iModelDb);\r\n  }\r\n  /**\r\n   * Insert a DisplayStyle3d for use by a ViewDefinition.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param definitionModelId Insert the new DisplayStyle3d into this [[DefinitionModel]]\r\n   * @param name The name of the DisplayStyle3d\r\n   * @returns The Id of the newly inserted DisplayStyle3d element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): Id64String {\r\n    const displayStyle = this.create(iModelDb, definitionModelId, name, options);\r\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\r\n  }\r\n}\r\n"]}

package/lib/cjs/ECDb.d.ts

@@ -6,6 +6,7 @@ import { IModelJsNative } from "@bentley/imodeljs-native";
 import { ECSchemaProps, ECSqlReader, QueryBinder, QueryOptions } from "@itwin/core-common";
 import { ECSqlStatement } from "./ECSqlStatement";
 import { SqliteStatement } from "./SqliteStatement";
+import { _nativeDb } from "./internal/Symbols";
 /** Modes for how to open [ECDb]($backend) files.
  * @public
  */
@@ -139,8 +140,12 @@ export declare class ECDb implements IDisposable {
      * @internal
      */
     prepareSqliteStatement(sql: string, logErrors?: boolean): SqliteStatement;
-    /** @internal */
+    /** @internal
+     * @deprecated in 4.8. This internal API will be removed in 5.0. Use ECDb's public API instead.
+     */
     get nativeDb(): IModelJsNative.ECDb;
+    /** @internal */
+    get [_nativeDb](): IModelJsNative.ECDb;
     /** Allow to execute query and read results along with meta data. The result are streamed.
      *
      * See also:

package/lib/cjs/ECDb.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ECDb.d.ts","sourceRoot":"","sources":["../../src/ECDb.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAoB,WAAW,EAAoB,MAAM,qBAAqB,CAAC;AACtF,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAkB,aAAa,EAAE,WAAW,EAAe,WAAW,EAAE,YAAY,EAAuB,MAAM,oBAAoB,CAAC;AAG7I,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAE,eAAe,EAAkB,MAAM,mBAAmB,CAAC;AAIpE;;GAEG;AACH,oBAAY,YAAY;IACtB,QAAQ,IAAA;IACR,SAAS,IAAA;IACT,sGAAsG;IACtG,WAAW,IAAA;CACZ;AAED;;GAEG;AACH,qBAAa,IAAK,YAAW,WAAW;IACtC,OAAO,CAAC,SAAS,CAAC,CAAsB;IACxC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAwC;IACxE,OAAO,CAAC,qBAAqB,CAAyC;IAEtE;;OAEG;IACI,gBAAgB,CAAC,IAAI,EAAE,MAAM;;IAQpC;;OAEG;IACI,OAAO,IAAI,IAAI;IAStB;;;OAGG;IACI,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAMvC;;;;OAIG;IACI,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAE,YAAoC,GAAG,IAAI;IAQrF,uCAAuC;IACvC,IAAW,MAAM,IAAI,OAAO,CAAmC;IAE/D;;OAEG;IACI,OAAO,IAAI,IAAI;IAMtB,8CAA8C;IACvC,mBAAmB;IAI1B,8CAA8C;IACvC,uBAAuB;IAI9B;;;OAGG;IACI,WAAW,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI;IAMhD;;OAEG;IACI,cAAc,IAAI,IAAI;IAM7B;;;;;OAKG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAQ3C;;;;;OAKG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa;IAIlD;;;;;;;;;;;;OAYG;IACI,qBAAqB,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,CAAC,EAAE,SAAS,UAAO,GAAG,CAAC;IAiB1G;;;;;;;;;;OAUG;IACI,aAAa,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,CAAC,EAAE,SAAS,UAAO,GAAG,CAAC;IAiBlG;;;;OAIG;IACI,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,cAAc;IAMxE;;;;;;;;;;;;OAYG;IACI,2BAA2B,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,CAAC,EAAE,SAAS,UAAO,GAAG,CAAC;IAiB/G;;;;;;;;;OASG;IACI,mBAAmB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,CAAC,EAAE,SAAS,UAAO,GAAG,CAAC;IAiBvG;;;;;OAKG;IACI,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,eAAe;IAM7E,gBAAgB;IAChB,IAAW,QAAQ,IAAI,cAAc,CAAC,IAAI,CAGzC;IAED;;;;;;;;;;;SAWK;IACE,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,WAAW;IAYjG;;;;;;;;;;;;;;;OAeG;IACY,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,qBAAqB,CAAC,GAAG,CAAC;IAM7G;;;;;;;;;;;;OAYG;IACU,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAOhF;;;;;;;;;;;;;;;;;OAiBG;IACY,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,qBAAqB,CAAC,GAAG,CAAC;CAKpI"}
+{"version":3,"file":"ECDb.d.ts","sourceRoot":"","sources":["../../src/ECDb.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAoB,WAAW,EAAoB,MAAM,qBAAqB,CAAC;AACtF,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAkB,aAAa,EAAE,WAAW,EAAe,WAAW,EAAE,YAAY,EAAuB,MAAM,oBAAoB,CAAC;AAG7I,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAE,eAAe,EAAkB,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAI/C;;GAEG;AACH,oBAAY,YAAY;IACtB,QAAQ,IAAA;IACR,SAAS,IAAA;IACT,sGAAsG;IACtG,WAAW,IAAA;CACZ;AAED;;GAEG;AACH,qBAAa,IAAK,YAAW,WAAW;IACtC,OAAO,CAAC,SAAS,CAAC,CAAsB;IACxC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAwC;IACxE,OAAO,CAAC,qBAAqB,CAAyC;IAEtE;;OAEG;IACI,gBAAgB,CAAC,IAAI,EAAE,MAAM;;IAQpC;;OAEG;IACI,OAAO,IAAI,IAAI;IAStB;;;OAGG;IACI,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAMvC;;;;OAIG;IACI,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAE,YAAoC,GAAG,IAAI;IAQrF,uCAAuC;IACvC,IAAW,MAAM,IAAI,OAAO,CAAqC;IAEjE;;OAEG;IACI,OAAO,IAAI,IAAI;IAMtB,8CAA8C;IACvC,mBAAmB;IAI1B,8CAA8C;IACvC,uBAAuB;IAI9B;;;OAGG;IACI,WAAW,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI;IAMhD;;OAEG;IACI,cAAc,IAAI,IAAI;IAM7B;;;;;OAKG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAQ3C;;;;;OAKG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa;IAIlD;;;;;;;;;;;;OAYG;IACI,qBAAqB,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,CAAC,EAAE,SAAS,UAAO,GAAG,CAAC;IAiB1G;;;;;;;;;;OAUG;IACI,aAAa,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,CAAC,EAAE,SAAS,UAAO,GAAG,CAAC;IAiBlG;;;;OAIG;IACI,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,cAAc;IAMxE;;;;;;;;;;;;OAYG;IACI,2BAA2B,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,CAAC,EAAE,SAAS,UAAO,GAAG,CAAC;IAiB/G;;;;;;;;;OASG;IACI,mBAAmB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,CAAC,EAAE,SAAS,UAAO,GAAG,CAAC;IAiBvG;;;;;OAKG;IACI,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,eAAe;IAM7E;;OAEG;IACH,IAAW,QAAQ,IAAI,cAAc,CAAC,IAAI,CAA4B;IAEtE,gBAAgB;IAChB,IAAW,CAAC,SAAS,CAAC,IAAI,cAAc,CAAC,IAAI,CAG5C;IAED;;;;;;;;;;;SAWK;IACE,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,WAAW;IAYjG;;;;;;;;;;;;;;;OAeG;IACY,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,qBAAqB,CAAC,GAAG,CAAC;IAM7G;;;;;;;;;;;;OAYG;IACU,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAOhF;;;;;;;;;;;;;;;;;OAiBG;IACY,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,qBAAqB,CAAC,GAAG,CAAC;CAKpI"}

package/lib/cjs/ECDb.js

@@ -13,8 +13,9 @@ const core_common_1 = require("@itwin/core-common");
 const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
 const ConcurrentQuery_1 = require("./ConcurrentQuery");
 const ECSqlStatement_1 = require("./ECSqlStatement");
-const IModelHost_1 = require("./IModelHost");
+const NativePlatform_1 = require("./internal/NativePlatform");
 const SqliteStatement_1 = require("./SqliteStatement");
+const Symbols_1 = require("./internal/Symbols");
 const loggerCategory = BackendLoggerCategory_1.BackendLoggerCategory.ECDb;
 /** Modes for how to open [ECDb]($backend) files.
  * @public
@@ -40,7 +41,7 @@ class ECDb {
     constructor() {
         this._statementCache = new SqliteStatement_1.StatementCache();
         this._sqliteStatementCache = new SqliteStatement_1.StatementCache();
-        this._nativeDb = new IModelHost_1.IModelHost.platform.ECDb();
+        this._nativeDb = new NativePlatform_1.IModelNative.platform.ECDb();
     }
     /** Call this function when finished with this ECDb object. This releases the native resources held by the
      *  ECDb object.
@@ -57,7 +58,7 @@ class ECDb {
      * @throws [IModelError]($common) if the operation failed.
      */
     createDb(pathName) {
-        const status = this.nativeDb.createDb(pathName);
+        const status = this[Symbols_1._nativeDb].createDb(pathName);
         if (status !== core_bentley_1.DbResult.BE_SQLITE_OK)
             throw new core_common_1.IModelError(status, "Failed to created ECDb");
     }
@@ -69,19 +70,19 @@ class ECDb {
     openDb(pathName, openMode = ECDbOpenMode.Readonly) {
         const nativeOpenMode = openMode === ECDbOpenMode.Readonly ? core_bentley_1.OpenMode.Readonly : core_bentley_1.OpenMode.ReadWrite;
         const tryUpgrade = openMode === ECDbOpenMode.FileUpgrade;
-        const status = this.nativeDb.openDb(pathName, nativeOpenMode, tryUpgrade);
+        const status = this[Symbols_1._nativeDb].openDb(pathName, nativeOpenMode, tryUpgrade);
         if (status !== core_bentley_1.DbResult.BE_SQLITE_OK)
             throw new core_common_1.IModelError(status, "Failed to open ECDb");
     }
     /** Returns true if the ECDb is open */
-    get isOpen() { return this.nativeDb.isOpen(); }
+    get isOpen() { return this[Symbols_1._nativeDb].isOpen(); }
     /** Close the Db after saving any uncommitted changes.
      * @throws [IModelError]($common) if the database is not open.
      */
     closeDb() {
         this._statementCache.clear();
         this._sqliteStatementCache.clear();
-        this.nativeDb.closeDb();
+        this[Symbols_1._nativeDb].closeDb();
     }
     /** @internal use to test statement caching */
     clearStatementCache() {
@@ -96,7 +97,7 @@ class ECDb {
      * @throws [IModelError]($common) if the database is not open or if the operation failed.
      */
     saveChanges(changesetName) {
-        const status = this.nativeDb.saveChanges(changesetName);
+        const status = this[Symbols_1._nativeDb].saveChanges(changesetName);
         if (status !== core_bentley_1.DbResult.BE_SQLITE_OK)
             throw new core_common_1.IModelError(status, "Failed to save changes");
     }
@@ -104,7 +105,7 @@ class ECDb {
      * @throws [IModelError]($common) if the database is not open or if the operation failed.
      */
     abandonChanges() {
-        const status = this.nativeDb.abandonChanges();
+        const status = this[Symbols_1._nativeDb].abandonChanges();
         if (status !== core_bentley_1.DbResult.BE_SQLITE_OK)
             throw new core_common_1.IModelError(status, "Failed to abandon changes");
     }
@@ -115,7 +116,7 @@ class ECDb {
      * @throws [IModelError]($common) if the database is not open or if the operation failed.
      */
     importSchema(pathName) {
-        const status = this.nativeDb.importSchema(pathName);
+        const status = this[Symbols_1._nativeDb].importSchema(pathName);
         if (status !== core_bentley_1.DbResult.BE_SQLITE_OK) {
             core_bentley_1.Logger.logError(loggerCategory, `Failed to import schema from '${pathName}'.`);
             throw new core_common_1.IModelError(status, `Failed to import schema from '${pathName}'.`);
@@ -128,7 +129,7 @@ class ECDb {
      * @throws if the schema can not be found or loaded.
      */
     getSchemaProps(name) {
-        return this.nativeDb.getSchemaProps(name);
+        return this[Symbols_1._nativeDb].getSchemaProps(name);
     }
     /**
      * Use a prepared ECSQL statement, potentially from the statement cache. If the requested statement doesn't exist
@@ -197,7 +198,7 @@ class ECDb {
      */
     prepareStatement(ecsql, logErrors = true) {
         const stmt = new ECSqlStatement_1.ECSqlStatement();
-        stmt.prepare(this.nativeDb, ecsql, logErrors);
+        stmt.prepare(this[Symbols_1._nativeDb], ecsql, logErrors);
         return stmt;
     }
     /**
@@ -267,11 +268,15 @@ class ECDb {
      */
     prepareSqliteStatement(sql, logErrors = true) {
         const stmt = new SqliteStatement_1.SqliteStatement(sql);
-        stmt.prepare(this.nativeDb, logErrors);
+        stmt.prepare(this[Symbols_1._nativeDb], logErrors);
         return stmt;
     }
+    /** @internal
+     * @deprecated in 4.8. This internal API will be removed in 5.0. Use ECDb's public API instead.
+     */
+    get nativeDb() { return this[Symbols_1._nativeDb]; }
     /** @internal */
-    get nativeDb() {
+    get [Symbols_1._nativeDb]() {
         (0, core_bentley_1.assert)(undefined !== this._nativeDb);
         return this._nativeDb;
     }
@@ -293,7 +298,7 @@ class ECDb {
         }
         const executor = {
             execute: async (request) => {
-                return ConcurrentQuery_1.ConcurrentQuery.executeQueryRequest(this.nativeDb, request);
+                return ConcurrentQuery_1.ConcurrentQuery.executeQueryRequest(this[Symbols_1._nativeDb], request);
             },
         };
         return new core_common_1.ECSqlReader(executor, ecsql, params, config);