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

package/lib/esm/CodeService.js

@@ -0,0 +1,65 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { BentleyError, IModelStatus } from "@itwin/core-bentley";
+/** @alpha */
+export var CodeService;
+(function (CodeService) {
+    /** @internal */
+    const codeSequences = new Map();
+    /** Register an instance of a`CodeSequence` so it can be looked up by name. */
+    function registerSequence(seq) {
+        codeSequences.set(seq.sequenceName, seq);
+    }
+    CodeService.registerSequence = registerSequence;
+    /** Get a previously registered `CodeSequence` by its name.
+     * @throws if no sequence by that name was registered.
+     */
+    function getSequence(name) {
+        const seq = codeSequences.get(name);
+        if (!seq)
+            throw new Error("SequenceNotFound", -1, `code sequence ${name} not found`);
+        return seq;
+    }
+    CodeService.getSequence = getSequence;
+    /**
+     * Turn a `CodePops` for the briefcase of this CodeService into a `ScopeAndSpec` object for use with a CodeService.
+     * This is necessary because the `spec` member of `CodeProps` refers to the id of a code spec in the iModel, and
+     * the `scope` member refers to the element Id of the scope element in the iModel. This helper function
+     * converts the spec Id to the spec name and looks up the `FederationGuid` of the scope element.
+     */
+    function makeScopeAndSpec(iModel, code) {
+        const scopeGuid = iModel.elements.getElementProps({ id: code.scope, onlyBaseProperties: true }).federationGuid;
+        if (undefined === scopeGuid)
+            throw new CodeService.Error("MissingGuid", IModelStatus.InvalidCode, "code scope element has no federationGuid");
+        return { scopeGuid, specName: iModel.codeSpecs.getById(code.spec).name };
+    }
+    CodeService.makeScopeAndSpec = makeScopeAndSpec;
+    /** Turn a `CodeProps` and  `ProposedCodeProps` into a `ProposedCode` for use with a CodeService.
+     * @see [[makeScopeAndSpec]] for explanation of why this is necessary.
+     */
+    function makeProposedCode(arg) {
+        return {
+            ...arg.props,
+            value: arg.code.value,
+            ...makeScopeAndSpec(arg.iModel, arg.code),
+        };
+    }
+    CodeService.makeProposedCode = makeProposedCode;
+    /** Exception class thrown by `CodeService` methods. */
+    class Error extends BentleyError {
+        /** A string that indicates the type of problem that caused the exception. */
+        errorId;
+        /** For [[CodeService.reserveCodes]] and [[CodeService.updateCodes]], a list of the problem details. */
+        problems;
+        /** @internal */
+        constructor(errorId, errNum, message, problems) {
+            super(errNum, message);
+            this.errorId = errorId;
+            this.problems = problems;
+        }
+    }
+    CodeService.Error = Error;
+})(CodeService || (CodeService = {}));
+//# sourceMappingURL=CodeService.js.map

package/lib/esm/CodeService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CodeService.js","sourceRoot":"","sources":["../../src/CodeService.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAE,YAAY,EAAc,YAAY,EAAyB,MAAM,qBAAqB,CAAC;AAyCpG,aAAa;AACb,MAAM,KAAW,WAAW,CA8d3B;AA9dD,WAAiB,WAAW;IAiI1B,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,YAAY,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,YAAY;QACrC,6EAA6E;QAC7D,OAAO,CAAU;QACjC,uGAAuG;QACvF,QAAQ,CAAsC;QAE9D,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,EA9dgB,WAAW,KAAX,WAAW,QA8d3B","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nimport { BentleyError, GuidString, IModelStatus, MarkRequired, Mutable } from \"@itwin/core-bentley\";\nimport { CodeProps, FontId, FontType } from \"@itwin/core-common\";\nimport { CloudSqlite } from \"./CloudSqlite\";\nimport { IModelDb } from \"./IModelDb\";\nimport { SettingsContainer } from \"./workspace/Settings\";\nimport { VersionedSqliteDb } from \"./SQLiteDb\";\n\n/**\n * The services for querying, reserving, updating, and deleting codes for a BriefcaseDb (available via `BriefcaseDb.codeService`) whenever it is opened for write access.\n * See [CodeService]($docs/learning/backend/CodeService).\n * @alpha\n */\nexport interface CodeService {\n  /** @internal */\n  close: () => void;\n\n  initialize(iModel: IModelDb): Promise<void>;\n\n  /** the index for external Codes for this CodeService */\n  readonly externalCodes?: CloudSqlite.DbAccess<CodeService.CodesDb, CodeService.ReadMethods, CodeService.WriteMethods>;\n\n  /** the index for internal Codes for this CodeService */\n  readonly internalCodes?: CloudSqlite.DbAccess<CodeService.InternalCodes, CodeService.InternalReadMethods, CodeService.InternalWriteMethods>;\n\n  /**\n   * Application-supplied parameters for reserving new codes.\n   */\n  readonly appParams: CodeService.AuthorAndOrigin;\n\n  /**\n   * Verify that the Code of a to-be-inserted or to-be-updated Element:\n   * 1. has already been reserved,\n   * 2. if the element has a `federationGuid`, it must match the reserved value. If the federationGuid is undefined,\n   * the value from the code index is returned.\n   *\n   * If not, throw an exception. Elements with no CodeValue are ignored.\n   * @note this method is automatically called whenever elements are added or updated by a BriefcaseDb with a CodeService.\n   */\n  verifyCode(props: CodeService.ElementCodeProps): void;\n}\n\n/** @alpha */\nexport namespace CodeService {\n\n  export interface WriteMethods {\n    /** Add a new code spec to this code service.\n     */\n    addCodeSpec(val: CodeService.NameAndJson): Promise<void>;\n\n    /**\n     * Add all of the codes and code specs from this CodeService's BriefcaseDb into the code index.\n     * @returns the number of codes actually added.\n     * @note It is not necessary to call this method unless the BriefcaseDb somehow becomes out of sync with its CodeService,\n     * for example when migrating iModels to a new code service. It is safe (but relatively expensive) to call this method multiple times, since\n     * any codes or code specs that are already in the index are ignored.\n     */\n    addAllCodes(iModel: IModelDb): Promise<number>;\n\n    /**\n     * Attempt to reserve a single proposed code.\n     * @throws `CodeService.Error` if the proposed code cannot be reserved.\n     */\n    reserveCode(code: CodeService.ProposedCode): Promise<void>;\n\n    /**\n     * Attempt to reserve an array of proposed codes.\n     * @returns number of codes actually reserved.\n     * @see the `problems` member of the `CodeService.Error` exception\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.\n     * @throws `CodeService.Error` if any of the proposed code cannot be reserved. The details for each failed code are in the `problems` member.\n     */\n    reserveCodes(arg: CodeService.ReserveCodesArgs): Promise<number>;\n\n    /**\n     * Attempt to reserve the next available code for a code sequence and scope.\n     */\n    reserveNextAvailableCode(arg: CodeService.ReserveNextArgs): Promise<void>;\n\n    /**\n     * Attempt to reserve an array of the next available codes for a code sequence and scope.\n     * The length of the array determines the number of codes requested. The values for the new codes are returned\n     * in the array, so they can be associated with the supplied GUIDs.\n     * @returns number of codes actually reserved.\n     */\n    reserveNextAvailableCodes(arg: CodeService.ReserveNextArrayArgs): Promise<number>;\n\n    /**\n     * Update the properties of a single code.\n     */\n    updateCode(props: CodeService.UpdatedCode): Promise<void>;\n\n    /**\n     * Update the properties of an array codes.\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.\n     * @returns number of codes actually updated.\n     */\n    updateCodes(arg: CodeService.UpdateCodesArgs): Promise<number>;\n\n    /** Delete an array of codes by their guids. */\n    deleteCodes(guid: CodeService.CodeGuid[]): Promise<void>;\n  }\n\n  export interface ReadMethods {\n    /**\n     * Find the next available value for the supplied `SequenceScope`.\n     * If the sequence is full (there are no available values), this will throw an exception with `errorId=\"SequenceFull\"`\n     * @param from the sequence and scope to search\n     * @returns the next available CodeValue in the sequence.\n     */\n    findNextAvailable(from: CodeService.SequenceScope): CodeService.CodeValue;\n\n    /**\n     * Find the highest currently used value for the supplied `SequenceScope`\n     * @param from the sequence and scope to search\n     * @returns the highest used value, or undefined if no values have been used.\n     */\n    findHighestUsed(from: CodeService.SequenceScope): CodeService.CodeValue | undefined;\n\n    /** Determine whether a code is present in this CodeIndex by its Guid. */\n    isCodePresent(guid: CodeService.CodeGuid): boolean;\n\n    /** Get the data for a code in this CodeIndex by its Guid.\n     * @returns the data for the code or undefined if no code is present for the supplied Guid.\n     */\n    getCode(guid: CodeService.CodeGuid): CodeService.CodeEntry | undefined;\n\n    /** Look up a code by its Scope, Spec, and Value.\n     * @returns the Guid of the code, or undefined if not present.\n     */\n    findCode(code: CodeService.ScopeSpecAndValue): CodeService.CodeGuid | undefined;\n\n    /** Look up a code spec by its name\n     * @throws if the spec is not present.\n     */\n    getCodeSpec(props: CodeService.CodeSpecName): CodeService.NameAndJson;\n\n    /** Call a `CodeIteration` function for all codes in this index, optionally filtered by a `CodeFilter ` */\n    forAllCodes(iter: CodeService.CodeIteration, filter?: CodeService.CodeFilter): void;\n\n    /** Call an iteration function for all code specs in this index, optionally filtered by a `ValueFilter ` */\n    forAllCodeSpecs(iter: CodeService.NameAndJsonIteration, filter?: CodeService.ValueFilter): void;\n\n    /**\n     * Verify that the Code of a to-be-inserted or to-be-updated Element:\n     * 1. has already been reserved,\n     * 2. if the element has a `federationGuid`, it must match the reserved value. If the federationGuid is undefined,\n     * the value from the code index is returned.\n     *\n     * If not, throw an exception. Elements with no CodeValue are ignored.\n     * @note this method is automatically called whenever elements are added or updated by a BriefcaseDb with a CodeService.\n     */\n    verifyCode(specName: string, arg: CodeService.ElementCodeProps): void;\n  }\n\n  export type CodesDb = VersionedSqliteDb & WriteMethods & ReadMethods;\n\n  export interface InternalWriteMethods extends WriteMethods {\n    /**  @internal */\n    reserveFontId(props: CodeService.FontIndexProps): Promise<FontId>;\n    /** @internal */\n    reserveEmbeddedFaceDataId(facesKey: string): Promise<number>;\n    /**  @internal */\n    reserveBisCodeSpecs(specs: CodeService.BisCodeSpecIndexProps[]): Promise<void>;\n  }\n  export interface InternalReadMethods extends ReadMethods {\n    /**  @internal */\n    verifyBisCodeSpec(spec: CodeService.BisCodeSpecIndexProps): void;\n  }\n\n  export type InternalCodes = CodesDb & InternalWriteMethods & InternalReadMethods;\n\n  /** @internal */\n  const codeSequences = new Map<string, CodeSequence>();\n\n  /** @internal */\n  export let createForIModel: ((db: IModelDb) => Promise<CodeService>) | undefined;\n\n  /** Register an instance of a`CodeSequence` so it can be looked up by name. */\n  export function registerSequence(seq: CodeSequence) {\n    codeSequences.set(seq.sequenceName, seq);\n  }\n\n  /** Get a previously registered `CodeSequence` by its name.\n   * @throws if no sequence by that name was registered.\n   */\n  export function getSequence(name: string): CodeSequence {\n    const seq = codeSequences.get(name);\n    if (!seq)\n      throw new Error(\"SequenceNotFound\", -1, `code sequence ${name} not found`);\n    return seq;\n  }\n\n  /**\n   * Turn a `CodePops` for the briefcase of this CodeService into a `ScopeAndSpec` object for use with a CodeService.\n   * This is necessary because the `spec` member of `CodeProps` refers to the id of a code spec in the iModel, and\n   * the `scope` member refers to the element Id of the scope element in the iModel. This helper function\n   * converts the spec Id to the spec name and looks up the `FederationGuid` of the scope element.\n   */\n  export function makeScopeAndSpec(iModel: IModelDb, code: CodeProps): CodeService.ScopeAndSpec {\n    const scopeGuid = iModel.elements.getElementProps({ id: code.scope, onlyBaseProperties: true }).federationGuid;\n    if (undefined === scopeGuid)\n      throw new CodeService.Error(\"MissingGuid\", IModelStatus.InvalidCode, \"code scope element has no federationGuid\");\n\n    return { scopeGuid, specName: iModel.codeSpecs.getById(code.spec).name };\n  }\n\n  /** Turn a `CodeProps` and  `ProposedCodeProps` into a `ProposedCode` for use with a CodeService.\n   * @see [[makeScopeAndSpec]] for explanation of why this is necessary.\n   */\n  export function makeProposedCode(arg: CodeService.MakeProposedCodeArgs): CodeService.ProposedCode {\n    return {\n      ...arg.props,\n      value: arg.code.value,\n      ...makeScopeAndSpec(arg.iModel, arg.code),\n    };\n  }\n\n  /** The name of a code spec */\n  export type CodeSpecName = string;\n\n  /**\n   * The name that identifies the \"originator\" of a code. Usually this is the Guid of the iModel from which a code was added,\n   * but can also be used to identify a system or type from an external code service.\n   */\n  export type CodeOriginName = string;\n\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. */\n  export type AuthorName = string;\n\n  /** The value for a code. */\n  export type CodeValue = string;\n\n  /** The guid for a code. This identifies the real-world entity associated with the code. */\n  export type CodeGuid = GuidString;\n\n  /** The guid of the scope for a code. This identifies the real-world entity that provides the uniqueness scope for code values. */\n  export type ScopeGuid = GuidString;\n\n  /** An optional number associated with a code that may be used for \"status\" information. Values must be defined by applications. */\n  export type CodeState = number;\n\n  /** The return status of an iteration function. The value \"stop\" causes the iteration to terminate. */\n  export type IterationReturn = void | \"stop\";\n\n  /** An iteration function over codes in a code index. It is called with the Guid of a each code. */\n  export type CodeIteration = (guid: GuidString) => IterationReturn;\n\n  /** An iteration function over code specs in a code index. It is called with the name and json of a each code spec. */\n  export type NameAndJsonIteration = (nameAndJson: NameAndJson) => IterationReturn;\n\n  /** Argument for reserving an array of new codes. */\n  export interface ReserveCodesArgs {\n    /** an array of proposed codes to reserve.\n     * @note the guid of each proposed code must be supplied by the caller.\n     */\n    readonly codes: CodeService.ProposedCode[];\n    /** If true, unless all codes are available, don't reserve any codes. Otherwise reserve all available codes. */\n    readonly allOrNothing?: true;\n  }\n\n  /** Argument for reserving a code from a code sequence. */\n  export interface ReserveNextArgs {\n    /** the properties of the new code */\n    readonly code: CodeService.ProposedCodeProps;\n    /** The code sequence and scope for the new code. */\n    readonly from: SequenceScope;\n  }\n\n  /** Argument for reserving an array of codes from a code sequence. */\n  export interface ReserveNextArrayArgs {\n    /** an array of proposed codes to reserve.  */\n    readonly codes: CodeService.ProposedCodeProps[];\n    /** The code sequence and scope for the new codes. */\n    readonly from: CodeService.SequenceScope;\n    /** If true, and in the event that the code sequence does not have enough available codes to fulfill all the entries in `codes`,\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.\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\n     * were actually available. The `value` member will be undefined for any proposed codes that were not reserved.\n     */\n    readonly asManyAsPossible?: true;\n  }\n\n  /** Argument for updating an array of codes. */\n  export interface UpdateCodesArgs {\n    /** Properties of the codes to update */\n    readonly props: CodeService.UpdatedCode[];\n    /** If true, unless all codes are updated, don't update any codes. Otherwise update all possible codes. */\n    readonly allOrNothing?: true;\n  }\n\n  /** Arguments for CodeService.makeProposedCode  */\n  export interface MakeProposedCodeArgs {\n    readonly iModel: IModelDb;\n    readonly code: Required<CodeProps>;\n    readonly props: CodeService.CodeGuidStateJson;\n  }\n\n  /** The properties of an Element to be checked against the code index.\n   * @see CodeService.verifyCode\n   */\n  export interface ElementCodeProps {\n    /** iModel from which the code is being inserted/updated. */\n    readonly iModel: IModelDb;\n    /** Properties of the code */\n    readonly props: {\n      /** The imodel-specific code properties. */\n      readonly code: CodeProps;\n      /**\n       * The federationGuid of the element being inserted or updated.\n       * If federationGuid is defined, it is must match the value in the code index or an error is thrown.\n       * If it is undefined, the value from the code index is returned here.\n       */\n      federationGuid?: GuidString;\n    };\n  }\n\n  /** a name and a json object. Used for code specs, authors and origins. */\n  export interface NameAndJson {\n    readonly name: string;\n    readonly json?: SettingsContainer;\n  }\n\n  /** A code Scope guid, and code spec name. */\n  export interface ScopeAndSpec {\n    readonly specName: CodeSpecName;\n    readonly scopeGuid: ScopeGuid;\n  }\n\n  /** A code Scope guid, code spec, and code value. */\n  export interface ScopeSpecAndValue extends ScopeAndSpec {\n    readonly value: CodeValue;\n  }\n\n  /** The data held in a code index for a single code. */\n  export interface CodeEntry {\n    /** The name of the code spec for this code. */\n    readonly specName: CodeSpecName;\n    /** The guid of the entity that provides the scope for this code. */\n    readonly scopeGuid: ScopeGuid;\n    /** The value of this code. */\n    readonly value: CodeValue;\n    /** The guid of the entity this code identifies. */\n    readonly guid: CodeGuid;\n    /** the state of the code. May be undefined. */\n    readonly state?: CodeState;\n    /** The name of the originating source of this code (usually an iModel Guid). May be undefined. */\n    readonly origin: CodeOriginName;\n    /** The name of the author of this code. May be undefined. */\n    readonly author?: AuthorName;\n    /** Option json properties associated with this code. May be undefined. */\n    readonly json?: SettingsContainer;\n  }\n\n  /** A filter used to limit and/or sort the values returned by an iteration. */\n  export interface ValueFilter {\n    /** A value filter. May include wild cards when used with `GLOB` or `LIKE` */\n    readonly value?: string;\n    /** The comparison operator for `value`. Default is `=` */\n    readonly valueCompare?: \"GLOB\" | \"LIKE\" | \"NOT GLOB\" | \"NOT LIKE\" | \"=\" | \"<\" | \">\";\n    /** Order results ascending or descending. If not supplied, the results are unordered (random). */\n    readonly orderBy?: \"ASC\" | \"DESC\";\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) */\n    readonly sqlExpression?: string;\n  }\n\n  /** A filter to limit and/or sort the values for the [[CodeIndex.forAllCodes]] iteration. */\n  export interface CodeFilter extends ValueFilter {\n    /** If supplied, limit results to only those with this spec */\n    readonly specName?: CodeSpecName;\n    /** If supplied, limit results to only those with this scope Guid */\n    readonly scopeGuid?: ScopeGuid;\n    /** If supplied, limit results to only those with this origin */\n    readonly origin?: CodeOriginName;\n  }\n\n  /** Author and origin information supplied when codes are reserved. */\n  export interface AuthorAndOrigin {\n    /** The name of the individual or group for whom the code was reserved. */\n    readonly author: Mutable<NameAndJson>;\n    /** The identity of the \"originator\" of the code. This is usually a guid of an iModel, but can be any unique string. */\n    readonly origin: Mutable<NameAndJson>;\n  }\n\n  /** The Guid, state, and json properties of a code. */\n  export interface CodeGuidStateJson {\n    /** The Guid of the new code. This must be always be supplied by the application. */\n    readonly guid: CodeGuid;\n    /** An optional value for the state of the code. */\n    readonly state?: CodeState;\n    /** An optional json object to be stored with the code. */\n    readonly json?: SettingsContainer;\n  }\n\n  /** Properties of a \"proposed\" new code to be reserved.\n   * @note the Guid of the entity identified by this code *must* be supplied, but `value` is optional, since\n   * this may be used to reserve codes from a sequence where the value is generated.\n   */\n  export interface ProposedCodeProps extends CodeGuidStateJson {\n    /** The value for the proposed code.\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.\n     */\n    value?: CodeValue;\n  }\n\n  /** Properties of a proposed new code that is not from a code sequence (its `value` is required). */\n  export type ProposedCode = ProposedCodeProps & ScopeSpecAndValue;\n\n  /** Properties that describe a code sequence and a scope and spec for a proposed code or array of codes from a sequence. */\n  export interface SequenceScope extends ScopeAndSpec {\n    /** The code sequence. */\n    readonly seq: CodeSequence;\n    /** A valid current value. If supplied, the returned value will always be later in the sequence than this. */\n    readonly start?: CodeValue;\n  }\n\n  /** Properties of a code to be updated.\n   * @note The `guid` member identifies the code to be updated and is required.\n   * All other properties are optional - if `undefined`, its value is not changed.\n   */\n  export type UpdatedCode = MarkRequired<Partial<ProposedCode>, \"guid\">;\n\n  /** A proposed code that could not be reserved due to some error. */\n  export interface ReserveProblem {\n    /** the proposed code that failed. */\n    readonly code: ProposedCode;\n    /** the reason for the failure */\n    readonly errorId: ErrorId;\n    /** the error message from the exception for this proposed code. */\n    readonly message: string;\n  }\n\n  /** A update to a code that failed for some error. */\n  export interface UpdateProblem {\n    /** The properties of the code that was to be updated */\n    readonly prop: UpdatedCode;\n    /** the reason for the failure */\n    readonly errorId: ErrorId;\n    /** the error message from the exception for the update request. */\n    readonly message: string;\n  }\n\n  /**\n   * A sequence of code values following a increasing pattern. Valid code sequences must have a first value, a last value, and\n   * a way to get the next valid value from an existing valid value.\n   * Code sequences have a `sequenceName` so they can be registered using `CodeService.registerSequence`.\n   */\n  export interface CodeSequence {\n    /** the name of this CodeSequence. */\n    get sequenceName(): string;\n    /** Get the first valid value for this CodeSequence */\n    getFirstValue(): CodeValue;\n    /** Get the last valid value for this CodeSequence */\n    getLastValue(): CodeValue;\n    /** Get the next valid value for this CodeSequence from the supplied value.\n     * If the sequence is full (that is, the next value is greater than the last value, this method should throw with errorId=\"SequenceFull\".\n     * @return the next valid value according to the rules of this CodeSequence.\n     */\n    getNextValue(code: CodeValue): CodeValue;\n    /** Determine whether this supplied value is valid for this sequence. */\n    isValidCode(code: CodeValue): boolean;\n  }\n\n  /** @internal */\n  export interface FontIndexProps {\n    id?: number;\n    fontType: FontType;\n    fontName: string;\n  }\n  /** @internal */\n  export interface BisCodeSpecIndexProps {\n    id?: number;\n    name: string;\n    props: string;\n  }\n\n  /** Exception class thrown by `CodeService` methods. */\n  export class Error extends BentleyError {\n    /** A string that indicates the type of problem that caused the exception. */\n    public readonly errorId: ErrorId;\n    /** For [[CodeService.reserveCodes]] and [[CodeService.updateCodes]], a list of the problem details. */\n    public readonly problems?: ReserveProblem[] | UpdateProblem[];\n\n    /** @internal */\n    constructor(errorId: ErrorId, errNum: number, message: string, problems?: ReserveProblem[] | UpdateProblem[]) {\n      super(errNum, message);\n      this.errorId = errorId;\n      this.problems = problems;\n    }\n  }\n\n  /** Identifiers for exceptions thrown by `CodeService` methods.\n   * @see [[CodeService.Error.errorId]]\n   */\n  export type ErrorId =\n    \"BadIndexProps\" |\n    \"CorruptIModel\" |\n    \"CorruptIndex\" |\n    \"DuplicateValue\" |\n    \"GuidIsInUse\" |\n    \"GuidMismatch\" |\n    \"IllegalValue\" |\n    \"InconsistentIModels\" |\n    \"IndexReadonly\" |\n    \"InvalidCodeScope\" |\n    \"InvalidGuid\" |\n    \"InvalidSequence\" |\n    \"MissingCode\" |\n    \"MissingGuid\" |\n    \"MissingInput\" |\n    \"MissingSpec\" |\n    \"NoCodeIndex\" |\n    \"NotAuthorized\" |\n    \"SequenceFull\" |\n    \"ReserveErrors\" |\n    \"SequenceNotFound\" |\n    \"SqlLogicError\" |\n    \"UpdateErrors\" |\n    \"ValueIsInUse\" |\n    \"WrongVersion\";\n\n}\n"]}

package/lib/esm/CodeSpecs.d.ts

@@ -0,0 +1,59 @@
+/** @packageDocumentation
+ * @module Codes
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { CodeScopeSpec, CodeSpec, CodeSpecProperties } from "@itwin/core-common";
+import { IModelDb } from "./IModelDb";
+/** Manages [CodeSpecs]($docs/BIS/guide/fundamentals/element-fundamentals.md#codespec) within an [[IModelDb]]
+ * @public
+ */
+export declare class CodeSpecs {
+    private static tableName;
+    private _imodel;
+    private _loadedCodeSpecs;
+    constructor(imodel: IModelDb);
+    private findByName;
+    /** Look up the Id of the CodeSpec with the specified name. */
+    queryId(name: string): Id64String;
+    /** Look up a CodeSpec by Id. The CodeSpec will be loaded from the database if necessary.
+     * @param codeSpecId The Id of the CodeSpec to load
+     * @returns The CodeSpec with the specified Id
+     * @throws [[IModelError]] if the Id is invalid or if no CodeSpec with that Id could be found.
+     */
+    getById(codeSpecId: Id64String): CodeSpec;
+    /** Returns true if the IModelDb has a CodeSpec of the specified Id. */
+    hasId(codeSpecId: Id64String): boolean;
+    /** Look up a CodeSpec by name. The CodeSpec will be loaded from the database if necessary.
+     * @param name The name of the CodeSpec to load
+     * @returns The CodeSpec with the specified name
+     * @throws [[IModelError]] if no CodeSpec with the specified name could be found.
+     */
+    getByName(name: string): CodeSpec;
+    /** Returns true if the IModelDb has a CodeSpec of the specified name. */
+    hasName(name: string): boolean;
+    private insertCodeSpec;
+    /** Add a new CodeSpec to the iModel.
+     * @param codeSpec The CodeSpec to insert
+     * @returns The Id of the persistent CodeSpec.
+     * @note If successful, this method will assign a valid CodeSpecId to the supplied CodeSpec
+     * @throws IModelError if the insertion fails
+     */
+    insert(codeSpec: CodeSpec): Id64String;
+    /** Add a new CodeSpec to the IModelDb.
+     * @param name The name for the new CodeSpec.
+     * @param properties The properties or the CodeSpec. For backwards compatibility this may also be a `CodeScopeSpec.Type`.
+     * @returns The Id of the persistent CodeSpec.
+     * @throws IModelError if the insertion fails
+     */
+    insert(name: string, properties: CodeSpecProperties | CodeScopeSpec.Type): Id64String;
+    /** Update the Json properties of an existing CodeSpec.
+   * @param codeSpec The codeSpec holding Json properties values to update
+   * @throws if unable to update the codeSpec.
+   */
+    updateProperties(codeSpec: CodeSpec): void;
+    /** Load a CodeSpec from the iModel
+     * @param id  The persistent Id of the CodeSpec to load
+     */
+    load(id: Id64String): CodeSpec;
+}
+//# sourceMappingURL=CodeSpecs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CodeSpecs.d.ts","sourceRoot":"","sources":["../../src/CodeSpecs.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAgC,UAAU,EAAgB,MAAM,qBAAqB,CAAC;AAC7F,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,kBAAkB,EAAe,MAAM,oBAAoB,CAAC;AAC9F,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,SAAS,CAAkB;IAC1C,OAAO,CAAC,OAAO,CAAW;IAC1B,OAAO,CAAC,gBAAgB,CAAkB;gBAE9B,MAAM,EAAE,QAAQ;IAO5B,OAAO,CAAC,UAAU;IAOlB,8DAA8D;IACvD,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU;IAOxC;;;;OAIG;IACI,OAAO,CAAC,UAAU,EAAE,UAAU,GAAG,QAAQ;IAYhD,uEAAuE;IAChE,KAAK,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO;IAQ7C;;;;OAIG;IACI,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ;IAWxC,yEAAyE;IAClE,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAQrC,OAAO,CAAC,cAAc;IAgCtB;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,EAAE,QAAQ,GAAG,UAAU;IAE7C;;;;;OAKG;IACI,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB,GAAG,aAAa,CAAC,IAAI,GAAG,UAAU;IAiB5F;;;KAGC;IACM,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;IASjD;;OAEG;IACI,IAAI,CAAC,EAAE,EAAE,UAAU,GAAG,QAAQ;CAYtC"}

package/lib/esm/CodeSpecs.js

@@ -0,0 +1,152 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Codes
+ */
+import { BentleyError, DbResult, Id64, IModelStatus } from "@itwin/core-bentley";
+import { CodeSpec, IModelError } from "@itwin/core-common";
+/** Manages [CodeSpecs]($docs/BIS/guide/fundamentals/element-fundamentals.md#codespec) within an [[IModelDb]]
+ * @public
+ */
+export class CodeSpecs {
+    static tableName = "bis_CodeSpec";
+    _imodel;
+    _loadedCodeSpecs = [];
+    constructor(imodel) {
+        this._imodel = imodel;
+        if (imodel.isBriefcaseDb()) {
+            imodel.onChangesetApplied.addListener(() => this._loadedCodeSpecs.length = 0);
+        }
+    }
+    findByName(name) {
+        return this._imodel.withSqliteStatement(`SELECT Id FROM ${CodeSpecs.tableName} WHERE Name=?`, (stmt) => {
+            stmt.bindString(1, name);
+            return stmt.nextRow() ? stmt.getValueId(0) : undefined;
+        });
+    }
+    /** Look up the Id of the CodeSpec with the specified name. */
+    queryId(name) {
+        const id = this.findByName(name);
+        if (!id)
+            throw new IModelError(IModelStatus.NotFound, "CodeSpec not found");
+        return id;
+    }
+    /** Look up a CodeSpec by Id. The CodeSpec will be loaded from the database if necessary.
+     * @param codeSpecId The Id of the CodeSpec to load
+     * @returns The CodeSpec with the specified Id
+     * @throws [[IModelError]] if the Id is invalid or if no CodeSpec with that Id could be found.
+     */
+    getById(codeSpecId) {
+        // good chance it is already loaded - check there before running a query
+        const found = this._loadedCodeSpecs.find((codeSpec) => codeSpec.id === codeSpecId);
+        if (found !== undefined)
+            return found;
+        // must load this codespec
+        const loadedCodeSpec = this.load(codeSpecId);
+        this._loadedCodeSpecs.push(loadedCodeSpec);
+        return loadedCodeSpec;
+    }
+    /** Returns true if the IModelDb has a CodeSpec of the specified Id. */
+    hasId(codeSpecId) {
+        try {
+            return undefined !== this.getById(codeSpecId);
+        }
+        catch {
+            return false;
+        }
+    }
+    /** Look up a CodeSpec by name. The CodeSpec will be loaded from the database if necessary.
+     * @param name The name of the CodeSpec to load
+     * @returns The CodeSpec with the specified name
+     * @throws [[IModelError]] if no CodeSpec with the specified name could be found.
+     */
+    getByName(name) {
+        // good chance it is already loaded - check there before running a query
+        const found = this._loadedCodeSpecs.find((codeSpec) => codeSpec.name === name);
+        if (found !== undefined)
+            return found;
+        const codeSpecId = this.queryId(name);
+        if (codeSpecId === undefined)
+            throw new IModelError(IModelStatus.NotFound, "CodeSpec not found");
+        return this.getById(codeSpecId);
+    }
+    /** Returns true if the IModelDb has a CodeSpec of the specified name. */
+    hasName(name) {
+        try {
+            return undefined !== this.getByName(name);
+        }
+        catch {
+            return false;
+        }
+    }
+    insertCodeSpec(specName, properties) {
+        const iModel = this._imodel;
+        const spec = { name: specName.trim(), props: JSON.stringify(properties) };
+        if (this.findByName(spec.name))
+            throw new IModelError(IModelStatus.DuplicateName, "CodeSpec already exists");
+        const internalCodes = iModel.codeService?.internalCodes;
+        if (internalCodes) {
+            // Since there is no lock on the codespec table, to add a codespec to an iModel it must first be reserved in the
+            // internal code index via `internalCodes.reserveBisCodeSpecs` prior to calling this function.
+            // This ensures that the Ids will be unique, and the property values consistent, even if more than one user
+            // adds them without pushing their changes. The call to `verifyBisCodeSpec` will throw otherwise.
+            internalCodes.reader.verifyBisCodeSpec(spec);
+        }
+        else {
+            // If this iModel doesn't have an internal code index, we have no way of coordinating the Ids for CodeSpecs across multiple users.
+            // Just look in this briefcase to find the currently highest used Id and hope for the best.
+            spec.id = iModel.withSqliteStatement(`SELECT MAX(Id) FROM ${CodeSpecs.tableName}`, (stmt) => stmt.nextRow() ? stmt.getValueInteger(0) + 1 : 1);
+        }
+        const id = spec.id; // eslint-disable-line @typescript-eslint/no-non-null-assertion
+        iModel.withSqliteStatement(`INSERT INTO ${CodeSpecs.tableName}(Id,Name,JsonProperties) VALUES(?,?,?)`, (stmt) => {
+            stmt.bindInteger(1, id);
+            stmt.bindString(2, spec.name);
+            stmt.bindString(3, spec.props);
+            const rc = stmt.step();
+            if (rc !== DbResult.BE_SQLITE_DONE)
+                throw new BentleyError(rc, "Error inserting codeSpec");
+        });
+        return Id64.fromLocalAndBriefcaseIds(id, 0);
+    }
+    insert(codeSpecOrName, props) {
+        if (codeSpecOrName instanceof CodeSpec) {
+            const id = this.insertCodeSpec(codeSpecOrName.name, codeSpecOrName.properties);
+            codeSpecOrName.id = id;
+            return id;
+        }
+        if (props === undefined)
+            throw new IModelError(IModelStatus.BadArg, "Invalid argument");
+        if (typeof props === "object")
+            return this.insertCodeSpec(codeSpecOrName, props);
+        const spec = CodeSpec.create(this._imodel, codeSpecOrName, props);
+        return this.insertCodeSpec(spec.name, spec.properties);
+    }
+    /** Update the Json properties of an existing CodeSpec.
+   * @param codeSpec The codeSpec holding Json properties values to update
+   * @throws if unable to update the codeSpec.
+   */
+    updateProperties(codeSpec) {
+        this._imodel.withSqliteStatement(`UPDATE ${CodeSpecs.tableName} SET JsonProperties=? WHERE Id=?`, (stmt) => {
+            stmt.bindString(1, JSON.stringify(codeSpec.properties));
+            stmt.bindId(2, codeSpec.id);
+            if (DbResult.BE_SQLITE_DONE !== stmt.step())
+                throw new IModelError(IModelStatus.BadArg, "error updating CodeSpec properties");
+        });
+    }
+    /** Load a CodeSpec from the iModel
+     * @param id  The persistent Id of the CodeSpec to load
+     */
+    load(id) {
+        if (Id64.isInvalid(id))
+            throw new IModelError(IModelStatus.InvalidId, "Invalid codeSpecId");
+        return this._imodel.withSqliteStatement(`SELECT Name,JsonProperties FROM ${CodeSpecs.tableName} WHERE Id=?`, (stmt) => {
+            stmt.bindId(1, id);
+            if (!stmt.nextRow())
+                throw new IModelError(IModelStatus.InvalidId, "CodeSpec not found");
+            return CodeSpec.createFromJson(this._imodel, id, stmt.getValueString(0), JSON.parse(stmt.getValueString(1)));
+        });
+    }
+}
+//# sourceMappingURL=CodeSpecs.js.map

package/lib/esm/CodeSpecs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CodeSpecs.js","sourceRoot":"","sources":["../../src/CodeSpecs.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,IAAI,EAAc,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAC7F,OAAO,EAAiB,QAAQ,EAAsB,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAI9F;;GAEG;AACH,MAAM,OAAO,SAAS;IACZ,MAAM,CAAC,SAAS,GAAG,cAAc,CAAC;IAClC,OAAO,CAAW;IAClB,gBAAgB,GAAe,EAAE,CAAC;IAE1C,YAAY,MAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,MAAM,CAAC,aAAa,EAAE,EAAE,CAAC;YAC3B,MAAM,CAAC,kBAAkB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAChF,CAAC;IACH,CAAC;IAEO,UAAU,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,kBAAkB,SAAS,CAAC,SAAS,eAAe,EAAE,CAAC,IAAI,EAAE,EAAE;YACrG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YACzB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC;IAED,8DAA8D;IACvD,OAAO,CAAC,IAAY;QACzB,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,EAAE;YACL,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;QACrE,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,UAAsB;QACnC,wEAAwE;QACxE,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,UAAU,CAAC,CAAC;QACnF,IAAI,KAAK,KAAK,SAAS;YACrB,OAAO,KAAK,CAAC;QAEf,0BAA0B;QAC1B,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3C,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,uEAAuE;IAChE,KAAK,CAAC,UAAsB;QACjC,IAAI,CAAC;YACH,OAAO,SAAS,KAAK,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAChD,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,IAAY;QAC3B,wEAAwE;QACxE,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAC/E,IAAI,KAAK,KAAK,SAAS;YACrB,OAAO,KAAK,CAAC;QACf,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,UAAU,KAAK,SAAS;YAC1B,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;IAED,yEAAyE;IAClE,OAAO,CAAC,IAAY;QACzB,IAAI,CAAC;YACH,OAAO,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAEO,cAAc,CAAC,QAAgB,EAAE,UAA8B;QACrE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,MAAM,IAAI,GAAsC,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;QAC7G,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;YAC5B,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,yBAAyB,CAAC,CAAC;QAE/E,MAAM,aAAa,GAAG,MAAM,CAAC,WAAW,EAAE,aAAa,CAAC;QACxD,IAAI,aAAa,EAAE,CAAC;YAClB,gHAAgH;YAChH,8FAA8F;YAC9F,2GAA2G;YAC3G,iGAAiG;YACjG,aAAa,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC;aAAM,CAAC;YACN,kIAAkI;YAClI,2FAA2F;YAC3F,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,mBAAmB,CAAC,uBAAuB,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACjJ,CAAC;QAED,MAAM,EAAE,GAAG,IAAI,CAAC,EAAG,CAAC,CAAC,+DAA+D;QACpF,MAAM,CAAC,mBAAmB,CAAC,eAAe,SAAS,CAAC,SAAS,wCAAwC,EAAE,CAAC,IAAI,EAAE,EAAE;YAC9G,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACxB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/B,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,EAAE,KAAK,QAAQ,CAAC,cAAc;gBAChC,MAAM,IAAI,YAAY,CAAC,EAAE,EAAE,0BAA0B,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,wBAAwB,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAC9C,CAAC;IAiBM,MAAM,CAAC,cAAiC,EAAE,KAA+C;QAC9F,IAAI,cAAc,YAAY,QAAQ,EAAE,CAAC;YACvC,MAAM,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;YAC/E,cAAc,CAAC,EAAE,GAAG,EAAE,CAAC;YACvB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IAAI,KAAK,KAAK,SAAS;YACrB,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;QAEjE,IAAI,OAAO,KAAK,KAAK,QAAQ;YAC3B,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;QAEpD,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACzD,CAAC;IAED;;;KAGC;IACM,gBAAgB,CAAC,QAAkB;QACxC,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,UAAU,SAAS,CAAC,SAAS,kCAAkC,EAAE,CAAC,IAAI,EAAE,EAAE;YACzG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;YACxD,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;YAC5B,IAAI,QAAQ,CAAC,cAAc,KAAK,IAAI,CAAC,IAAI,EAAE;gBACzC,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,oCAAoC,CAAC,CAAC;QACrF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,IAAI,CAAC,EAAc;QACxB,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACpB,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;QAEtE,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,mCAAmC,SAAS,CAAC,SAAS,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE;YACpH,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;gBACjB,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;YAEtE,OAAO,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/G,CAAC,CAAC,CAAC;IACL,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Codes\n */\n\nimport { BentleyError, DbResult, Id64, Id64String, IModelStatus } from \"@itwin/core-bentley\";\nimport { CodeScopeSpec, CodeSpec, CodeSpecProperties, IModelError } from \"@itwin/core-common\";\nimport { IModelDb } from \"./IModelDb\";\nimport { CodeService } from \"./CodeService\";\n\n/** Manages [CodeSpecs]($docs/BIS/guide/fundamentals/element-fundamentals.md#codespec) within an [[IModelDb]]\n * @public\n */\nexport class CodeSpecs {\n  private static tableName = \"bis_CodeSpec\";\n  private _imodel: IModelDb;\n  private _loadedCodeSpecs: CodeSpec[] = [];\n\n  constructor(imodel: IModelDb) {\n    this._imodel = imodel;\n    if (imodel.isBriefcaseDb()) {\n      imodel.onChangesetApplied.addListener(() => this._loadedCodeSpecs.length = 0);\n    }\n  }\n\n  private findByName(name: string): Id64String | undefined {\n    return this._imodel.withSqliteStatement(`SELECT Id FROM ${CodeSpecs.tableName} WHERE Name=?`, (stmt) => {\n      stmt.bindString(1, name);\n      return stmt.nextRow() ? stmt.getValueId(0) : undefined;\n    });\n  }\n\n  /** Look up the Id of the CodeSpec with the specified name. */\n  public queryId(name: string): Id64String {\n    const id = this.findByName(name);\n    if (!id)\n      throw new IModelError(IModelStatus.NotFound, \"CodeSpec not found\");\n    return id;\n  }\n\n  /** Look up a CodeSpec by Id. The CodeSpec will be loaded from the database if necessary.\n   * @param codeSpecId The Id of the CodeSpec to load\n   * @returns The CodeSpec with the specified Id\n   * @throws [[IModelError]] if the Id is invalid or if no CodeSpec with that Id could be found.\n   */\n  public getById(codeSpecId: Id64String): CodeSpec {\n    // good chance it is already loaded - check there before running a query\n    const found = this._loadedCodeSpecs.find((codeSpec) => codeSpec.id === codeSpecId);\n    if (found !== undefined)\n      return found;\n\n    // must load this codespec\n    const loadedCodeSpec = this.load(codeSpecId);\n    this._loadedCodeSpecs.push(loadedCodeSpec);\n    return loadedCodeSpec;\n  }\n\n  /** Returns true if the IModelDb has a CodeSpec of the specified Id. */\n  public hasId(codeSpecId: Id64String): boolean {\n    try {\n      return undefined !== this.getById(codeSpecId);\n    } catch {\n      return false;\n    }\n  }\n\n  /** Look up a CodeSpec by name. The CodeSpec will be loaded from the database if necessary.\n   * @param name The name of the CodeSpec to load\n   * @returns The CodeSpec with the specified name\n   * @throws [[IModelError]] if no CodeSpec with the specified name could be found.\n   */\n  public getByName(name: string): CodeSpec {\n    // good chance it is already loaded - check there before running a query\n    const found = this._loadedCodeSpecs.find((codeSpec) => codeSpec.name === name);\n    if (found !== undefined)\n      return found;\n    const codeSpecId = this.queryId(name);\n    if (codeSpecId === undefined)\n      throw new IModelError(IModelStatus.NotFound, \"CodeSpec not found\");\n    return this.getById(codeSpecId);\n  }\n\n  /** Returns true if the IModelDb has a CodeSpec of the specified name. */\n  public hasName(name: string): boolean {\n    try {\n      return undefined !== this.getByName(name);\n    } catch {\n      return false;\n    }\n  }\n\n  private insertCodeSpec(specName: string, properties: CodeSpecProperties): Id64String {\n    const iModel = this._imodel;\n    const spec: CodeService.BisCodeSpecIndexProps = { name: specName.trim(), props: JSON.stringify(properties) };\n    if (this.findByName(spec.name))\n      throw new IModelError(IModelStatus.DuplicateName, \"CodeSpec already exists\");\n\n    const internalCodes = iModel.codeService?.internalCodes;\n    if (internalCodes) {\n      // Since there is no lock on the codespec table, to add a codespec to an iModel it must first be reserved in the\n      // internal code index via `internalCodes.reserveBisCodeSpecs` prior to calling this function.\n      // This ensures that the Ids will be unique, and the property values consistent, even if more than one user\n      // adds them without pushing their changes. The call to `verifyBisCodeSpec` will throw otherwise.\n      internalCodes.reader.verifyBisCodeSpec(spec);\n    } else {\n      // If this iModel doesn't have an internal code index, we have no way of coordinating the Ids for CodeSpecs across multiple users.\n      // Just look in this briefcase to find the currently highest used Id and hope for the best.\n      spec.id = iModel.withSqliteStatement(`SELECT MAX(Id) FROM ${CodeSpecs.tableName}`, (stmt) => stmt.nextRow() ? stmt.getValueInteger(0) + 1 : 1);\n    }\n\n    const id = spec.id!; // eslint-disable-line @typescript-eslint/no-non-null-assertion\n    iModel.withSqliteStatement(`INSERT INTO ${CodeSpecs.tableName}(Id,Name,JsonProperties) VALUES(?,?,?)`, (stmt) => {\n      stmt.bindInteger(1, id);\n      stmt.bindString(2, spec.name);\n      stmt.bindString(3, spec.props);\n      const rc = stmt.step();\n      if (rc !== DbResult.BE_SQLITE_DONE)\n        throw new BentleyError(rc, \"Error inserting codeSpec\");\n    });\n\n    return Id64.fromLocalAndBriefcaseIds(id, 0);\n  }\n\n  /** Add a new CodeSpec to the iModel.\n   * @param codeSpec The CodeSpec to insert\n   * @returns The Id of the persistent CodeSpec.\n   * @note If successful, this method will assign a valid CodeSpecId to the supplied CodeSpec\n   * @throws IModelError if the insertion fails\n   */\n  public insert(codeSpec: CodeSpec): Id64String;\n\n  /** Add a new CodeSpec to the IModelDb.\n   * @param name The name for the new CodeSpec.\n   * @param properties The properties or the CodeSpec. For backwards compatibility this may also be a `CodeScopeSpec.Type`.\n   * @returns The Id of the persistent CodeSpec.\n   * @throws IModelError if the insertion fails\n   */\n  public insert(name: string, properties: CodeSpecProperties | CodeScopeSpec.Type): Id64String;\n  public insert(codeSpecOrName: CodeSpec | string, props?: CodeSpecProperties | CodeScopeSpec.Type): Id64String {\n    if (codeSpecOrName instanceof CodeSpec) {\n      const id = this.insertCodeSpec(codeSpecOrName.name, codeSpecOrName.properties);\n      codeSpecOrName.id = id;\n      return id;\n    }\n    if (props === undefined)\n      throw new IModelError(IModelStatus.BadArg, \"Invalid argument\");\n\n    if (typeof props === \"object\")\n      return this.insertCodeSpec(codeSpecOrName, props);\n\n    const spec = CodeSpec.create(this._imodel, codeSpecOrName, props);\n    return this.insertCodeSpec(spec.name, spec.properties);\n  }\n\n  /** Update the Json properties of an existing CodeSpec.\n * @param codeSpec The codeSpec holding Json properties values to update\n * @throws if unable to update the codeSpec.\n */\n  public updateProperties(codeSpec: CodeSpec): void {\n    this._imodel.withSqliteStatement(`UPDATE ${CodeSpecs.tableName} SET JsonProperties=? WHERE Id=?`, (stmt) => {\n      stmt.bindString(1, JSON.stringify(codeSpec.properties));\n      stmt.bindId(2, codeSpec.id);\n      if (DbResult.BE_SQLITE_DONE !== stmt.step())\n        throw new IModelError(IModelStatus.BadArg, \"error updating CodeSpec properties\");\n    });\n  }\n\n  /** Load a CodeSpec from the iModel\n   * @param id  The persistent Id of the CodeSpec to load\n   */\n  public load(id: Id64String): CodeSpec {\n    if (Id64.isInvalid(id))\n      throw new IModelError(IModelStatus.InvalidId, \"Invalid codeSpecId\");\n\n    return this._imodel.withSqliteStatement(`SELECT Name,JsonProperties FROM ${CodeSpecs.tableName} WHERE Id=?`, (stmt) => {\n      stmt.bindId(1, id);\n      if (!stmt.nextRow())\n        throw new IModelError(IModelStatus.InvalidId, \"CodeSpec not found\");\n\n      return CodeSpec.createFromJson(this._imodel, id, stmt.getValueString(0), JSON.parse(stmt.getValueString(1)));\n    });\n  }\n}\n"]}

package/lib/esm/ConcurrentQuery.d.ts

@@ -0,0 +1,14 @@
+import { IModelJsNative } from "@bentley/imodeljs-native";
+import { DbBlobRequest, DbBlobResponse, DbQueryConfig, DbQueryRequest, DbQueryResponse } from "@itwin/core-common";
+/** @internal */
+export type OnResponse = (response: Response) => void;
+/** @internal */
+export declare class ConcurrentQuery {
+    /** @internal */
+    static executeQueryRequest(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb, request: DbQueryRequest): Promise<DbQueryResponse>;
+    /** @internal */
+    static executeBlobRequest(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb, request: DbBlobRequest): Promise<DbBlobResponse>;
+    static resetConfig(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb, config?: DbQueryConfig): DbQueryConfig;
+    static shutdown(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb): void;
+}
+//# sourceMappingURL=ConcurrentQuery.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ConcurrentQuery.d.ts","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAK1D,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAiB,MAAM,oBAAoB,CAAC;AAElI,gBAAgB;AAChB,MAAM,MAAM,UAAU,GAAG,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;AAEtD,gBAAgB;AAChB,qBAAa,eAAe;IAC1B,gBAAgB;WACI,mBAAmB,CAAC,IAAI,EAAE,cAAc,CAAC,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ5I,gBAAgB;WACI,kBAAkB,CAAC,IAAI,EAAE,cAAc,CAAC,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;WAQ3H,WAAW,CAAC,IAAI,EAAE,cAAc,CAAC,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,aAAa;WAGpG,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC,IAAI,GAAG,cAAc,CAAC,KAAK;CAGxE"}

package/lib/esm/ConcurrentQuery.js

@@ -0,0 +1,33 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { DbRequestKind } from "@itwin/core-common";
+/** @internal */
+export class ConcurrentQuery {
+    /** @internal */
+    static async executeQueryRequest(conn, request) {
+        return new Promise((resolve) => {
+            request.kind = DbRequestKind.ECSql;
+            conn.concurrentQueryExecute(request, (response) => {
+                resolve(response);
+            });
+        });
+    }
+    /** @internal */
+    static async executeBlobRequest(conn, request) {
+        return new Promise((resolve) => {
+            request.kind = DbRequestKind.BlobIO;
+            conn.concurrentQueryExecute(request, (response) => {
+                resolve(response);
+            });
+        });
+    }
+    static resetConfig(conn, config) {
+        return conn.concurrentQueryResetConfig(config);
+    }
+    static shutdown(conn) {
+        conn.concurrentQueryShutdown();
+    }
+}
+//# sourceMappingURL=ConcurrentQuery.js.map

package/lib/esm/ConcurrentQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConcurrentQuery.js","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":"AACA;;;+FAG+F;AAC/F,OAAO,EAAiF,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAKlI,gBAAgB;AAChB,MAAM,OAAO,eAAe;IAC1B,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,IAAgD,EAAE,OAAuB;QAC/G,OAAO,IAAI,OAAO,CAAkB,CAAC,OAAO,EAAE,EAAE;YAC9C,OAAO,CAAC,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC;YACnC,IAAI,CAAC,sBAAsB,CAAC,OAAc,EAAE,CAAC,QAAa,EAAE,EAAE;gBAC5D,OAAO,CAAC,QAA2B,CAAC,CAAC;YACvC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IACD,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAAgD,EAAE,OAAsB;QAC7G,OAAO,IAAI,OAAO,CAAiB,CAAC,OAAO,EAAE,EAAE;YAC7C,OAAO,CAAC,IAAI,GAAG,aAAa,CAAC,MAAM,CAAC;YACpC,IAAI,CAAC,sBAAsB,CAAC,OAAc,EAAE,CAAC,QAAa,EAAE,EAAE;gBAC5D,OAAO,CAAC,QAA0B,CAAC,CAAC;YACtC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IACM,MAAM,CAAC,WAAW,CAAC,IAAgD,EAAE,MAAsB;QAChG,OAAO,IAAI,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;IACM,MAAM,CAAC,QAAQ,CAAC,IAAgD;QACrE,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;CACF","sourcesContent":["import { IModelJsNative } from \"@bentley/imodeljs-native\";\n/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\nimport { DbBlobRequest, DbBlobResponse, DbQueryConfig, DbQueryRequest, DbQueryResponse, DbRequestKind } from \"@itwin/core-common\";\n\n/** @internal */\nexport type OnResponse = (response: Response) => void;\n\n/** @internal */\nexport class ConcurrentQuery {\n  /** @internal */\n  public static async executeQueryRequest(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb, request: DbQueryRequest): Promise<DbQueryResponse> {\n    return new Promise<DbQueryResponse>((resolve) => {\n      request.kind = DbRequestKind.ECSql;\n      conn.concurrentQueryExecute(request as any, (response: any) => {\n        resolve(response as DbQueryResponse);\n      });\n    });\n  }\n  /** @internal */\n  public static async executeBlobRequest(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb, request: DbBlobRequest): Promise<DbBlobResponse> {\n    return new Promise<DbBlobResponse>((resolve) => {\n      request.kind = DbRequestKind.BlobIO;\n      conn.concurrentQueryExecute(request as any, (response: any) => {\n        resolve(response as DbBlobResponse);\n      });\n    });\n  }\n  public static resetConfig(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb, config?: DbQueryConfig): DbQueryConfig {\n    return conn.concurrentQueryResetConfig(config);\n  }\n  public static shutdown(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb) {\n    conn.concurrentQueryShutdown();\n  }\n}\n"]}

package/lib/esm/CustomViewState3dCreator.d.ts

@@ -0,0 +1,22 @@
+import { CustomViewState3dCreatorOptions, CustomViewState3dProps } from "@itwin/core-common";
+import { IModelDb } from "./IModelDb";
+/**
+ * Class which helps to generate a custom ViewState3d.
+ * @internal
+ */
+export declare class CustomViewState3dCreator {
+    private _imodel;
+    constructor(iModel: IModelDb);
+    /** Gets default view state data such as category Ids and modelextents. If no model ids are passed in, all 3D models in the iModel are used.
+     * @param [modelIds] Ids of models to display in the view.
+     * @throws [IModelError]($common) If no 3d models are found in the iModel.
+     */
+    getCustomViewState3dData(options: CustomViewState3dCreatorOptions): Promise<CustomViewState3dProps>;
+    private _getAllCategories;
+    /** Compute the union of the extents of all the specified models. */
+    private _getModelExtents;
+    /** Get the Ids of all spatially-located, non-template 3d models in the iModel. */
+    private _getAllModels;
+    private _executeQuery;
+}
+//# sourceMappingURL=CustomViewState3dCreator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CustomViewState3dCreator.d.ts","sourceRoot":"","sources":["../../src/CustomViewState3dCreator.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,+BAA+B,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAG7F,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;;GAGG;AACH,qBAAa,wBAAwB;IACnC,OAAO,CAAC,OAAO,CAAW;gBACP,MAAM,EAAE,QAAQ;IAGnC;;;OAGG;IACU,wBAAwB,CAAC,OAAO,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC;YAelG,iBAAiB;IAS/B,oEAAoE;YACtD,gBAAgB;IAa9B,kFAAkF;YACpE,aAAa;IAmB3B,OAAO,CAAC,aAAa,CAMnB;CACH"}

package/lib/esm/CustomViewState3dCreator.js

@@ -0,0 +1,78 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { CompressedId64Set, Logger, StopWatch } from "@itwin/core-bentley";
+import { Range3d } from "@itwin/core-geometry";
+import { BackendLoggerCategory } from "./BackendLoggerCategory";
+const loggerCategory = BackendLoggerCategory.CustomViewState3dCreator;
+/**
+ * Class which helps to generate a custom ViewState3d.
+ * @internal
+ */
+export class CustomViewState3dCreator {
+    _imodel;
+    constructor(iModel) {
+        this._imodel = iModel;
+    }
+    /** Gets default view state data such as category Ids and modelextents. If no model ids are passed in, all 3D models in the iModel are used.
+     * @param [modelIds] Ids of models to display in the view.
+     * @throws [IModelError]($common) If no 3d models are found in the iModel.
+     */
+    async getCustomViewState3dData(options) {
+        let decompressedModelIds;
+        if (options?.modelIds !== undefined)
+            decompressedModelIds = CompressedId64Set.decompressArray(options.modelIds);
+        const models = decompressedModelIds ?? await this._getAllModels();
+        const categories = await this._getAllCategories();
+        const modelExtents = await this._getModelExtents(models);
+        return {
+            modelIds: CompressedId64Set.sortAndCompress(models),
+            categoryIds: CompressedId64Set.sortAndCompress(categories),
+            modelExtents: modelExtents.toJSON(),
+        };
+    }
+    async _getAllCategories() {
+        // Only use categories with elements in them
+        Logger.logInfo(loggerCategory, "Starting getAllCategories query.");
+        const query = `SELECT DISTINCT Category.Id AS id FROM BisCore.GeometricElement3d WHERE Category.Id IN (SELECT ECInstanceId FROM BisCore.SpatialCategory)`;
+        const categories = await this._executeQuery(query);
+        Logger.logInfo(loggerCategory, "Finished getAllCategories query.");
+        return categories;
+    }
+    /** Compute the union of the extents of all the specified models. */
+    async _getModelExtents(modelIds) {
+        if (modelIds.length === 0)
+            return new Range3d();
+        const timer = new StopWatch("getModelExtents query", true);
+        const range = await this._imodel.models.queryRange(modelIds);
+        timer.stop();
+        Logger.logInfo(loggerCategory, "Finished getModelExtents query.", { timeElapsedMs: timer.elapsed });
+        return range;
+    }
+    /** Get the Ids of all spatially-located, non-template 3d models in the iModel. */
+    async _getAllModels() {
+        // Note: IsNotSpatiallyLocated was introduced in a later version of the BisCore ECSchema.
+        // If the iModel has an earlier version, the statement will throw because the property does not exist.
+        // If the iModel was created from an earlier version and later upgraded to a newer version, the property may be NULL for models created prior to the upgrade.
+        const select = "SELECT ECInstanceId FROM Bis.GeometricModel3D WHERE IsPrivate = false AND IsTemplate = false";
+        const spatialCriterion = "AND (IsNotSpatiallyLocated IS NULL OR IsNotSpatiallyLocated = false)";
+        let models = [];
+        Logger.logInfo(loggerCategory, "Starting getAllModels query.");
+        try {
+            models = await this._executeQuery(`${select} ${spatialCriterion}`);
+        }
+        catch {
+            models = await this._executeQuery(select);
+        }
+        Logger.logInfo(loggerCategory, "Finished getAllModels query.");
+        return models;
+    }
+    _executeQuery = async (query) => {
+        const rows = [];
+        for await (const row of this._imodel.createQueryReader(query))
+            rows.push(row.id);
+        return rows;
+    };
+}
+//# sourceMappingURL=CustomViewState3dCreator.js.map

package/lib/esm/CustomViewState3dCreator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomViewState3dCreator.js","sourceRoot":"","sources":["../../src/CustomViewState3dCreator.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAE,iBAAiB,EAAyB,MAAM,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAElG,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAGhE,MAAM,cAAc,GAAG,qBAAqB,CAAC,wBAAwB,CAAC;AAEtE;;;GAGG;AACH,MAAM,OAAO,wBAAwB;IAC3B,OAAO,CAAW;IAC1B,YAAmB,MAAgB;QACjC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IACD;;;OAGG;IACI,KAAK,CAAC,wBAAwB,CAAC,OAAwC;QAC5E,IAAI,oBAAoB,CAAC;QACzB,IAAI,OAAO,EAAE,QAAQ,KAAK,SAAS;YACjC,oBAAoB,GAAG,iBAAiB,CAAC,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAE7E,MAAM,MAAM,GAAc,oBAAoB,IAAI,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC7E,MAAM,UAAU,GAAc,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC7D,MAAM,YAAY,GAAY,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAClE,OAAO;YACL,QAAQ,EAAE,iBAAiB,CAAC,eAAe,CAAC,MAAM,CAAC;YACnD,WAAW,EAAE,iBAAiB,CAAC,eAAe,CAAC,UAAU,CAAC;YAC1D,YAAY,EAAE,YAAY,CAAC,MAAM,EAAE;SACpC,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,iBAAiB;QAC7B,4CAA4C;QAC5C,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,kCAAkC,CAAC,CAAC;QACnE,MAAM,KAAK,GAAG,2IAA2I,CAAC;QAC1J,MAAM,UAAU,GAAc,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9D,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,kCAAkC,CAAC,CAAC;QACnE,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,oEAAoE;IAC5D,KAAK,CAAC,gBAAgB,CAAC,QAAsB;QACnD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YACvB,OAAO,IAAI,OAAO,EAAE,CAAC;QAEvB,MAAM,KAAK,GAAG,IAAI,SAAS,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAC;QAC3D,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE7D,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,iCAAiC,EAAE,EAAE,aAAa,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAEpG,OAAO,KAAK,CAAC;IACf,CAAC;IAED,kFAAkF;IAC1E,KAAK,CAAC,aAAa;QACzB,yFAAyF;QACzF,sGAAsG;QACtG,6JAA6J;QAC7J,MAAM,MAAM,GAAG,8FAA8F,CAAC;QAC9G,MAAM,gBAAgB,GAAG,sEAAsE,CAAC;QAEhG,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,8BAA8B,CAAC,CAAC;QAC/D,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,MAAM,IAAI,gBAAgB,EAAE,CAAC,CAAC;QACrE,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC;QAED,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,8BAA8B,CAAC,CAAC;QAC/D,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,aAAa,GAAG,KAAK,EAAE,KAAa,EAAE,EAAE;QAC9C,MAAM,IAAI,GAAG,EAAE,CAAC;QAChB,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC;YAC3D,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAEpB,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;CACH","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nimport { CompressedId64Set, Id64Array, Id64String, Logger, StopWatch } from \"@itwin/core-bentley\";\nimport { CustomViewState3dCreatorOptions, CustomViewState3dProps } from \"@itwin/core-common\";\nimport { Range3d } from \"@itwin/core-geometry\";\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\nimport { IModelDb } from \"./IModelDb\";\n\nconst loggerCategory = BackendLoggerCategory.CustomViewState3dCreator;\n\n/**\n * Class which helps to generate a custom ViewState3d.\n * @internal\n */\nexport class CustomViewState3dCreator {\n  private _imodel: IModelDb;\n  public constructor(iModel: IModelDb) {\n    this._imodel = iModel;\n  }\n  /** Gets default view state data such as category Ids and modelextents. If no model ids are passed in, all 3D models in the iModel are used.\n   * @param [modelIds] Ids of models to display in the view.\n   * @throws [IModelError]($common) If no 3d models are found in the iModel.\n   */\n  public async getCustomViewState3dData(options: CustomViewState3dCreatorOptions): Promise<CustomViewState3dProps> {\n    let decompressedModelIds;\n    if (options?.modelIds !== undefined)\n      decompressedModelIds = CompressedId64Set.decompressArray(options.modelIds);\n\n    const models: Id64Array = decompressedModelIds ?? await this._getAllModels();\n    const categories: Id64Array = await this._getAllCategories();\n    const modelExtents: Range3d = await this._getModelExtents(models);\n    return {\n      modelIds: CompressedId64Set.sortAndCompress(models),\n      categoryIds: CompressedId64Set.sortAndCompress(categories),\n      modelExtents: modelExtents.toJSON(),\n    };\n  }\n\n  private async _getAllCategories(): Promise<Id64Array> {\n    // Only use categories with elements in them\n    Logger.logInfo(loggerCategory, \"Starting getAllCategories query.\");\n    const query = `SELECT DISTINCT Category.Id AS id FROM BisCore.GeometricElement3d WHERE Category.Id IN (SELECT ECInstanceId FROM BisCore.SpatialCategory)`;\n    const categories: Id64Array = await this._executeQuery(query);\n    Logger.logInfo(loggerCategory, \"Finished getAllCategories query.\");\n    return categories;\n  }\n\n  /** Compute the union of the extents of all the specified models. */\n  private async _getModelExtents(modelIds: Id64String[]): Promise<Range3d> {\n    if (modelIds.length === 0)\n      return new Range3d();\n\n    const timer = new StopWatch(\"getModelExtents query\", true);\n    const range = await this._imodel.models.queryRange(modelIds);\n\n    timer.stop();\n    Logger.logInfo(loggerCategory, \"Finished getModelExtents query.\", { timeElapsedMs: timer.elapsed });\n\n    return range;\n  }\n\n  /** Get the Ids of all spatially-located, non-template 3d models in the iModel. */\n  private async _getAllModels(): Promise<Id64Array> {\n    // Note: IsNotSpatiallyLocated was introduced in a later version of the BisCore ECSchema.\n    // If the iModel has an earlier version, the statement will throw because the property does not exist.\n    // If the iModel was created from an earlier version and later upgraded to a newer version, the property may be NULL for models created prior to the upgrade.\n    const select = \"SELECT ECInstanceId FROM Bis.GeometricModel3D WHERE IsPrivate = false AND IsTemplate = false\";\n    const spatialCriterion = \"AND (IsNotSpatiallyLocated IS NULL OR IsNotSpatiallyLocated = false)\";\n\n    let models = [];\n    Logger.logInfo(loggerCategory, \"Starting getAllModels query.\");\n    try {\n      models = await this._executeQuery(`${select} ${spatialCriterion}`);\n    } catch {\n      models = await this._executeQuery(select);\n    }\n\n    Logger.logInfo(loggerCategory, \"Finished getAllModels query.\");\n    return models;\n  }\n\n  private _executeQuery = async (query: string) => {\n    const rows = [];\n    for await (const row of this._imodel.createQueryReader(query))\n      rows.push(row.id);\n\n    return rows;\n  };\n}\n"]}

package/lib/esm/DevTools.d.ts

@@ -0,0 +1,73 @@
+import * as os from "os";
+import { LogLevel } from "@itwin/core-bentley";
+import { RpcInterfaceEndpoints } from "@itwin/core-common";
+/**
+ * Performance and Memory statistics of backend
+ * @internal
+ */
+export interface DevToolsStats {
+    os: DevToolsOsStats;
+    process: DevToolsProcessStats;
+}
+/**
+ * OS stats of backend
+ * @internal
+ */
+export interface DevToolsOsStats {
+    platform: NodeJS.Platform;
+    hostname: string;
+    totalmem: number;
+    freemem: number;
+    uptime: number;
+    cpus: os.CpuInfo[];
+    cpuUsage: number;
+}
+/**
+ * Process stats of backend
+ * @internal
+ */
+export interface DevToolsProcessStats {
+    uptime: number;
+    pid: number;
+    ppid: number;
+    memoryUsage: NodeJS.MemoryUsage;
+}
+/** Utility to format the JSON created by DevTools.stats() to include the appropriate units
+ * @internal
+ */
+export declare class DevToolsStatsFormatter {
+    private static readonly _megaByteProps;
+    private static readonly _percentProps;
+    private static readonly _mHzProps;
+    private static readonly _secondsProps;
+    /** Replacer that includes units - can be used with JSON.stringify()  */
+    private static _replacer;
+    /** Converts the input stats to another JSON object with the appropriate units setup for various fields */
+    static toFormattedJson(stats: any): any;
+}
+/**
+ * Internal diagnostic utility
+ * @internal
+ */
+export declare class DevTools {
+    /** Receives a ping and returns true */
+    static ping(): boolean;
+    private static hrtimeToMS;
+    private static bytesToMegaBytes;
+    private static evaluateCpuUsage;
+    private static evaluateCpus;
+    private static evaluateMemoryUsage;
+    private static evaluateProcessStats;
+    private static evaluateOsStats;
+    /** Returns JSON object with backend statistics */
+    static stats(): DevToolsStats;
+    /** Sets up a log level at the backend and returns the old log level */
+    static setLogLevel(inLoggerCategory: string, newLevel: LogLevel): LogLevel | undefined;
+    /** Obtains the backend application and iTwin.js Core versions */
+    static versions(): Promise<{
+        application: string;
+        iTwinJs: any;
+        availableRpcs: RpcInterfaceEndpoints[];
+    }>;
+}
+//# sourceMappingURL=DevTools.d.ts.map