@itwin/core-backend 4.0.0-dev.51 → 4.0.0-dev.54

package/lib/cjs/CodeService.js

@@ -1,64 +1,64 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CodeService = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-/** @alpha */
-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", core_bentley_1.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 core_bentley_1.BentleyError {
-        /** @internal */
-        constructor(errorId, errNum, message, problems) {
-            super(errNum, message);
-            this.errorId = errorId;
-            this.problems = problems;
-        }
-    }
-    CodeService.Error = Error;
-})(CodeService = exports.CodeService || (exports.CodeService = {}));
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CodeService = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+/** @alpha */
+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", core_bentley_1.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 core_bentley_1.BentleyError {
+        /** @internal */
+        constructor(errorId, errNum, message, problems) {
+            super(errNum, message);
+            this.errorId = errorId;
+            this.problems = problems;
+        }
+    }
+    CodeService.Error = Error;
+})(CodeService = exports.CodeService || (exports.CodeService = {}));
 //# sourceMappingURL=CodeService.js.map

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,sDAAiH;AA+KjH,aAAa;AACb,IAAiB,WAAW,CA6U3B;AA7UD,WAAiB,WAAW;IAC1B,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;;MAEE;IACF,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;IAqPD,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;AA8BH,CAAC,EA7UgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QA6U3B","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 { AccessToken, BentleyError, GuidString, IModelStatus, MarkRequired, Mutable } from \"@itwin/core-bentley\";\r\nimport { CodeProps } from \"@itwin/core-common\";\r\nimport { CloudSqlite } from \"./CloudSqlite\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { SettingObject } from \"./workspace/Settings\";\r\n\r\n/**\r\n * A readonly index of all known Codes for an iTwin. The CodeIndex may be slightly out-of-date\r\n * with the master copy in the cloud, but it should be periodically synchronized. Whenever codes are reserved/updated/deleted\r\n * locally, this copy is always up-to-date as of those changes.\r\n * @alpha\r\n */\r\nexport interface CodeIndex {\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/**\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 * @alpha\r\n */\r\nexport interface CodeService {\r\n  /** @internal */\r\n  close: () => void;\r\n\r\n  /** @internal */\r\n  addAllCodeSpecs(iModel: IModelDb): Promise<void>;\r\n\r\n  /** the code index for this CodeService */\r\n  readonly codeIndex: CodeIndex;\r\n\r\n  /**\r\n   * Application-supplied parameters for obtaining the write lock on the container.\r\n   * Applications should set these parameters by adding a listener for `BriefcaseDb.onCodeServiceCreated`\r\n   * that is called every time a BriefcaseDb that uses code services is opened for write access.\r\n   */\r\n  readonly lockParams: CloudSqlite.ObtainLockParams;\r\n\r\n  /**\r\n   * Application-supplied parameters for reserving new codes.\r\n   * @see lockParams\r\n   */\r\n  readonly appParams: CodeService.AuthorAndOrigin;\r\n\r\n  /**\r\n   * The token that grants access to the cloud container for this CodeService.\r\n   * It should be established in a listener for `BriefcaseDb.onCodeServiceCreated`, and should be refreshed (via a\r\n   * timer) before it expires.\r\n   */\r\n  sasToken: AccessToken;\r\n\r\n  /**\r\n   * Synchronize the local index with any changes by made by others.\r\n   * @note This is called automatically whenever any write operation is performed on the code index. It is only necessary to\r\n   * call this directly if you have not changed the code index recently, but wish to perform a readonly operation and want to\r\n   * ensure it is up-to-date as of now.\r\n   * @note There is no guarantee that a readonly index is up-to-date even immediately after calling this method, since others\r\n   * may be modifying it at any time.\r\n   */\r\n  synchronizeWithCloud(): 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(props: CodeService.ElementCodeProps): void;\r\n\r\n  /** Add a new code spec to this code service.\r\n   * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.\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   * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.\r\n   */\r\n  addAllCodes(iModel: IModelDb): Promise<number>;\r\n\r\n  /**\r\n   * Attempt to reserve a single proposed code.\r\n   * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.\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 This will automatically attempt to obtain, perform the operation, and then release the write lock.\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   * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.\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   * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.\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   * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.\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 This will automatically attempt to obtain, perform the operation, and then release the write lock.\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   * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.\r\n   */\r\n  deleteCodes(guid: CodeService.CodeGuid[]): Promise<void>;\r\n}\r\n\r\n/** @alpha */\r\nexport namespace CodeService {\r\n  /** @internal */\r\n  const codeSequences = new Map<string, CodeSequence>();\r\n\r\n  /** @internal */\r\n  export let createForIModel: ((db: IModelDb) => 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  /** 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  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  /** 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    \"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    \"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,sDAAiH;AA+KjH,aAAa;AACb,IAAiB,WAAW,CA6U3B;AA7UD,WAAiB,WAAW;IAC1B,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;;MAEE;IACF,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;IAqPD,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;AA8BH,CAAC,EA7UgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QA6U3B","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 { AccessToken, BentleyError, GuidString, IModelStatus, MarkRequired, Mutable } from \"@itwin/core-bentley\";\nimport { CodeProps } from \"@itwin/core-common\";\nimport { CloudSqlite } from \"./CloudSqlite\";\nimport { IModelDb } from \"./IModelDb\";\nimport { SettingObject } from \"./workspace/Settings\";\n\n/**\n * A readonly index of all known Codes for an iTwin. The CodeIndex may be slightly out-of-date\n * with the master copy in the cloud, but it should be periodically synchronized. Whenever codes are reserved/updated/deleted\n * locally, this copy is always up-to-date as of those changes.\n * @alpha\n */\nexport interface CodeIndex {\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/**\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 * @alpha\n */\nexport interface CodeService {\n  /** @internal */\n  close: () => void;\n\n  /** @internal */\n  addAllCodeSpecs(iModel: IModelDb): Promise<void>;\n\n  /** the code index for this CodeService */\n  readonly codeIndex: CodeIndex;\n\n  /**\n   * Application-supplied parameters for obtaining the write lock on the container.\n   * Applications should set these parameters by adding a listener for `BriefcaseDb.onCodeServiceCreated`\n   * that is called every time a BriefcaseDb that uses code services is opened for write access.\n   */\n  readonly lockParams: CloudSqlite.ObtainLockParams;\n\n  /**\n   * Application-supplied parameters for reserving new codes.\n   * @see lockParams\n   */\n  readonly appParams: CodeService.AuthorAndOrigin;\n\n  /**\n   * The token that grants access to the cloud container for this CodeService.\n   * It should be established in a listener for `BriefcaseDb.onCodeServiceCreated`, and should be refreshed (via a\n   * timer) before it expires.\n   */\n  sasToken: AccessToken;\n\n  /**\n   * Synchronize the local index with any changes by made by others.\n   * @note This is called automatically whenever any write operation is performed on the code index. It is only necessary to\n   * call this directly if you have not changed the code index recently, but wish to perform a readonly operation and want to\n   * ensure it is up-to-date as of now.\n   * @note There is no guarantee that a readonly index is up-to-date even immediately after calling this method, since others\n   * may be modifying it at any time.\n   */\n  synchronizeWithCloud(): 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(props: CodeService.ElementCodeProps): void;\n\n  /** Add a new code spec to this code service.\n   * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.\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   * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.\n   */\n  addAllCodes(iModel: IModelDb): Promise<number>;\n\n  /**\n   * Attempt to reserve a single proposed code.\n   * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.\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 This will automatically attempt to obtain, perform the operation, and then release the write lock.\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   * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.\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   * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.\n   */\n  reserveNextAvailableCodes(arg: CodeService.ReserveNextArrayArgs): Promise<number>;\n\n  /**\n   * Update the properties of a single code.\n   * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.\n   */\n  updateCode(props: CodeService.UpdatedCode): Promise<void>;\n\n  /**\n   * Update the properties of an array codes.\n   * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.\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   * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.\n   */\n  deleteCodes(guid: CodeService.CodeGuid[]): Promise<void>;\n}\n\n/** @alpha */\nexport namespace CodeService {\n  /** @internal */\n  const codeSequences = new Map<string, CodeSequence>();\n\n  /** @internal */\n  export let createForIModel: ((db: IModelDb) => 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  /** 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  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?: SettingObject;\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?: SettingObject;\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?: SettingObject;\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  /** 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    \"IndexReadonly\" |\n    \"InvalidCodeScope\" |\n    \"InvalidGuid\" |\n    \"InvalidSequence\" |\n    \"MissingCode\" |\n    \"MissingGuid\" |\n    \"MissingInput\" |\n    \"MissingSpec\" |\n    \"NoCodeIndex\" |\n    \"SequenceFull\" |\n    \"ReserveErrors\" |\n    \"SequenceNotFound\" |\n    \"SqlLogicError\" |\n    \"UpdateErrors\" |\n    \"ValueIsInUse\" |\n    \"WrongVersion\";\n\n}\n"]}

package/lib/cjs/CodeSpecs.d.ts

@@ -1,56 +1,56 @@
-/** @packageDocumentation
- * @module Codes
- */
-import { Id64String } from "@itwin/core-bentley";
-import { CodeScopeSpec, CodeSpec } 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 _imodel;
-    private _loadedCodeSpecs;
-    constructor(imodel: IModelDb);
-    /** 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;
-    /** 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 scopeType The scope type
-     * @returns The Id of the persistent CodeSpec.
-     * @throws IModelError if the insertion fails
-     */
-    insert(name: string, scopeType: 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;
-}
+/** @packageDocumentation
+ * @module Codes
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { CodeScopeSpec, CodeSpec } 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 _imodel;
+    private _loadedCodeSpecs;
+    constructor(imodel: IModelDb);
+    /** 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;
+    /** 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 scopeType The scope type
+     * @returns The Id of the persistent CodeSpec.
+     * @throws IModelError if the insertion fails
+     */
+    insert(name: string, scopeType: 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/cjs/CodeSpecs.js

@@ -1,125 +1,125 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CodeSpecs = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_common_1 = require("@itwin/core-common");
-/** Manages [CodeSpecs]($docs/BIS/guide/fundamentals/element-fundamentals.md#codespec) within an [[IModelDb]]
- * @public
- */
-class CodeSpecs {
-    constructor(imodel) {
-        this._loadedCodeSpecs = [];
-        this._imodel = imodel;
-        if (imodel.isBriefcaseDb()) {
-            imodel.onChangesetApplied.addListener(() => this._loadedCodeSpecs.length = 0);
-        }
-    }
-    /** Look up the Id of the CodeSpec with the specified name. */
-    queryId(name) {
-        return this._imodel.withPreparedStatement("SELECT ECInstanceId FROM BisCore.CodeSpec WHERE Name=:name", (stmt) => {
-            stmt.bindString("name", name);
-            if (core_bentley_1.DbResult.BE_SQLITE_ROW !== stmt.step())
-                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, "CodeSpec not found", () => ({ name }));
-            return stmt.getValue(0).getId();
-        });
-    }
-    /** 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) {
-        if (core_bentley_1.Id64.isInvalid(codeSpecId))
-            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.InvalidId, "Invalid 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 (error) {
-            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 core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, "CodeSpec not found", () => ({ name }));
-        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 (error) {
-            return false;
-        }
-    }
-    insert(codeSpecOrName, scopeType) {
-        if (codeSpecOrName instanceof core_common_1.CodeSpec) {
-            const codeSpec = codeSpecOrName;
-            const id = this._imodel.insertCodeSpec(codeSpec);
-            codeSpec.id = id;
-            return id;
-        }
-        if (typeof codeSpecOrName === "string") {
-            const name = codeSpecOrName;
-            if (scopeType)
-                return this._imodel.insertCodeSpec(core_common_1.CodeSpec.create(this._imodel, name, scopeType));
-        }
-        throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, "Invalid argument");
-    }
-    /** 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.withPreparedSqliteStatement("UPDATE bis_CodeSpec SET JsonProperties=? WHERE Id=?", (stmt) => {
-            stmt.bindString(1, JSON.stringify(codeSpec.properties));
-            stmt.bindId(2, codeSpec.id);
-            if (core_bentley_1.DbResult.BE_SQLITE_DONE !== stmt.step())
-                throw new core_common_1.IModelError(core_bentley_1.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 (core_bentley_1.Id64.isInvalid(id))
-            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.InvalidId, "Invalid codeSpecId");
-        return this._imodel.withPreparedStatement("SELECT name,jsonProperties FROM BisCore.CodeSpec WHERE ECInstanceId=?", (stmt) => {
-            stmt.bindId(1, id);
-            if (core_bentley_1.DbResult.BE_SQLITE_ROW !== stmt.step())
-                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.InvalidId, "Invalid codeSpecId");
-            const row = stmt.getRow();
-            return core_common_1.CodeSpec.createFromJson(this._imodel, id, row.name, JSON.parse(row.jsonProperties));
-        });
-    }
-}
-exports.CodeSpecs = CodeSpecs;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CodeSpecs = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+/** Manages [CodeSpecs]($docs/BIS/guide/fundamentals/element-fundamentals.md#codespec) within an [[IModelDb]]
+ * @public
+ */
+class CodeSpecs {
+    constructor(imodel) {
+        this._loadedCodeSpecs = [];
+        this._imodel = imodel;
+        if (imodel.isBriefcaseDb()) {
+            imodel.onChangesetApplied.addListener(() => this._loadedCodeSpecs.length = 0);
+        }
+    }
+    /** Look up the Id of the CodeSpec with the specified name. */
+    queryId(name) {
+        return this._imodel.withPreparedStatement("SELECT ECInstanceId FROM BisCore.CodeSpec WHERE Name=:name", (stmt) => {
+            stmt.bindString("name", name);
+            if (core_bentley_1.DbResult.BE_SQLITE_ROW !== stmt.step())
+                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, "CodeSpec not found", () => ({ name }));
+            return stmt.getValue(0).getId();
+        });
+    }
+    /** 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) {
+        if (core_bentley_1.Id64.isInvalid(codeSpecId))
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.InvalidId, "Invalid 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 (error) {
+            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 core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, "CodeSpec not found", () => ({ name }));
+        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 (error) {
+            return false;
+        }
+    }
+    insert(codeSpecOrName, scopeType) {
+        if (codeSpecOrName instanceof core_common_1.CodeSpec) {
+            const codeSpec = codeSpecOrName;
+            const id = this._imodel.insertCodeSpec(codeSpec);
+            codeSpec.id = id;
+            return id;
+        }
+        if (typeof codeSpecOrName === "string") {
+            const name = codeSpecOrName;
+            if (scopeType)
+                return this._imodel.insertCodeSpec(core_common_1.CodeSpec.create(this._imodel, name, scopeType));
+        }
+        throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, "Invalid argument");
+    }
+    /** 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.withPreparedSqliteStatement("UPDATE bis_CodeSpec SET JsonProperties=? WHERE Id=?", (stmt) => {
+            stmt.bindString(1, JSON.stringify(codeSpec.properties));
+            stmt.bindId(2, codeSpec.id);
+            if (core_bentley_1.DbResult.BE_SQLITE_DONE !== stmt.step())
+                throw new core_common_1.IModelError(core_bentley_1.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 (core_bentley_1.Id64.isInvalid(id))
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.InvalidId, "Invalid codeSpecId");
+        return this._imodel.withPreparedStatement("SELECT name,jsonProperties FROM BisCore.CodeSpec WHERE ECInstanceId=?", (stmt) => {
+            stmt.bindId(1, id);
+            if (core_bentley_1.DbResult.BE_SQLITE_ROW !== stmt.step())
+                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.InvalidId, "Invalid codeSpecId");
+            const row = stmt.getRow();
+            return core_common_1.CodeSpec.createFromJson(this._imodel, id, row.name, JSON.parse(row.jsonProperties));
+        });
+    }
+}
+exports.CodeSpecs = CodeSpecs;
 //# sourceMappingURL=CodeSpecs.js.map