@itwin/core-backend 3.4.0-dev.20 → 3.4.0-dev.21

package/lib/cjs/CodeService.d.ts

@@ -1,7 +1,7 @@
-import { CloudSqlite } from "@bentley/imodeljs-native";
 import { AccessToken, BentleyError, GuidString, MarkRequired, Mutable } from "@itwin/core-bentley";
 import { CodeProps } from "@itwin/core-common";
-import { BriefcaseDb } from "./IModelDb";
+import { IModelDb } from "./IModelDb";
+import { SQLiteDb } from "./SQLiteDb";
 import { SettingObject } from "./workspace/Settings";
 /**
  * A readonly index of all known Codes for an iTwin. The CodeIndex may be slightly out-of-date
@@ -16,31 +16,31 @@ export interface CodeIndex {
      * @param from the sequence and scope to search
      * @returns the next available CodeValue in the sequence.
      */
-    findNextAvailable: (from: CodeService.SequenceScope) => CodeService.CodeValue;
+    findNextAvailable(from: CodeService.SequenceScope): CodeService.CodeValue;
     /**
      * Find the highest currently used value for the supplied `SequenceScope`
      * @param from the sequence and scope to search
      * @returns the highest used value, or undefined if no values have been used.
      */
-    findHighestUsed: (from: CodeService.SequenceScope) => CodeService.CodeValue | undefined;
+    findHighestUsed(from: CodeService.SequenceScope): CodeService.CodeValue | undefined;
     /** Determine whether a code is present in this CodeIndex by its Guid. */
-    isCodePresent: (guid: CodeService.CodeGuid) => boolean;
+    isCodePresent(guid: CodeService.CodeGuid): boolean;
     /** Get the data for a code in this CodeIndex by its Guid.
      * @returns the data for the code or undefined if no code is present for the supplied Guid.
      */
-    getCode: (guid: CodeService.CodeGuid) => CodeService.CodeEntry | undefined;
+    getCode(guid: CodeService.CodeGuid): CodeService.CodeEntry | undefined;
     /** Look up a code by its Scope, Spec, and Value.
      * @returns the Guid of the code, or undefined if not present.
      */
-    findCode: (code: CodeService.ScopeSpecAndValue) => CodeService.CodeGuid | undefined;
+    findCode(code: CodeService.ScopeSpecAndValue): CodeService.CodeGuid | undefined;
     /** Look up a code spec by its name
      * @throws if the spec is not present.
      */
-    getCodeSpec: (props: CodeService.CodeSpecName) => CodeService.NameAndJson;
+    getCodeSpec(props: CodeService.CodeSpecName): CodeService.NameAndJson;
     /** Call a `CodeIteration` function for all codes in this index, optionally filtered by a `CodeFilter ` */
-    forAllCodes: (iter: CodeService.CodeIteration, filter?: CodeService.CodeFilter) => void;
+    forAllCodes(iter: CodeService.CodeIteration, filter?: CodeService.CodeFilter): void;
     /** Call an iteration function for all code specs in this index, optionally filtered by a `ValueFilter ` */
-    forAllCodeSpecs: (iter: CodeService.NameAndJsonIteration, filter?: CodeService.ValueFilter) => void;
+    forAllCodeSpecs(iter: CodeService.NameAndJsonIteration, filter?: CodeService.ValueFilter): void;
 }
 /**
  * The services for querying, reserving, updating, and deleting codes for a BriefcaseDb (available via `BriefcaseDb.codeService`) whenever it is opened for write access.
@@ -50,9 +50,7 @@ export interface CodeService {
     /** @internal */
     close: () => void;
     /** @internal */
-    addAllCodeSpecs: () => Promise<void>;
-    /** the BriefcaseDb of this CodeService */
-    readonly briefcase: BriefcaseDb;
+    addAllCodeSpecs(iModel: IModelDb): Promise<void>;
     /** the code index for this CodeService */
     readonly codeIndex: CodeIndex;
     /**
@@ -60,7 +58,7 @@ export interface CodeService {
      * Applications should set these parameters by adding a listener for `BriefcaseDb.onCodeServiceCreated`
      * that is called every time a BriefcaseDb that uses code services is opened for write access.
      */
-    readonly appParams: CodeService.ObtainLockParams & CodeService.AuthorAndOrigin;
+    readonly appParams: SQLiteDb.ObtainLockParams & CodeService.AuthorAndOrigin;
     /**
      * The token that grants access to the cloud container for this CodeService.
      * It should be established in a listener for `BriefcaseDb.onCodeServiceCreated`, and should be refreshed (via a
@@ -75,7 +73,7 @@ export interface CodeService {
      * @note There is no guarantee that a readonly index is up-to-date even immediately after calling this method, since others
      * may be modifying it at any time.
      */
-    synchronizeWithCloud: () => void;
+    synchronizeWithCloud(): void;
     /**
      * Verify that the Code of a to-be-inserted or to-be-updated Element:
      * 1. has already been reserved,
@@ -85,11 +83,11 @@ export interface CodeService {
      * If not, throw an exception. Elements with no CodeValue are ignored.
      * @note this method is automatically called whenever elements are added or updated by a BriefcaseDb with a CodeService.
      */
-    verifyCode: (props: CodeService.ElementCodeProps) => void;
+    verifyCode(props: CodeService.ElementCodeProps): void;
     /** Add a new code spec to this code service.
      * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.
      */
-    addCodeSpec: (val: CodeService.NameAndJson) => Promise<void>;
+    addCodeSpec(val: CodeService.NameAndJson): Promise<void>;
     /**
      * Add all of the codes and code specs from this CodeService's BriefcaseDb into the code index.
      * @returns the number of codes actually added.
@@ -98,13 +96,13 @@ export interface CodeService {
      * any codes or code specs that are already in the index are ignored.
      * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.
      */
-    addAllCodes: () => Promise<number>;
+    addAllCodes(iModel: IModelDb): Promise<number>;
     /**
      * Attempt to reserve a single proposed code.
      * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.
      * @throws `CodeService.Error` if the proposed code cannot be reserved.
      */
-    reserveCode: (code: CodeService.ProposedCode) => Promise<void>;
+    reserveCode(code: CodeService.ProposedCode): Promise<void>;
     /**
      * Attempt to reserve an array of proposed codes.
      * @returns number of codes actually reserved.
@@ -113,12 +111,12 @@ export interface CodeService {
      * @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.
      * @throws `CodeService.Error` if any of the proposed code cannot be reserved. The details for each failed code are in the `problems` member.
      */
-    reserveCodes: (arg: CodeService.ReserveCodesArgs) => Promise<number>;
+    reserveCodes(arg: CodeService.ReserveCodesArgs): Promise<number>;
     /**
      * Attempt to reserve the next available code for a code sequence and scope.
      * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.
      */
-    reserveNextAvailableCode: (arg: CodeService.ReserveNextArgs) => Promise<void>;
+    reserveNextAvailableCode(arg: CodeService.ReserveNextArgs): Promise<void>;
     /**
      * Attempt to reserve an array of the next available codes for a code sequence and scope.
      * The length of the array determines the number of codes requested. The values for the new codes are returned
@@ -126,28 +124,28 @@ export interface CodeService {
      * @returns number of codes actually reserved.
      * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.
      */
-    reserveNextAvailableCodes: (arg: CodeService.ReserveNextArrayArgs) => Promise<number>;
+    reserveNextAvailableCodes(arg: CodeService.ReserveNextArrayArgs): Promise<number>;
     /**
      * Update the properties of a single code.
      * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.
      */
-    updateCode: (props: CodeService.UpdatedCode) => Promise<void>;
+    updateCode(props: CodeService.UpdatedCode): Promise<void>;
     /**
      * Update the properties of an array codes.
      * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.
      * @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.
      * @returns number of codes actually updated.
      */
-    updateCodes: (arg: CodeService.UpdateCodesArgs) => Promise<number>;
+    updateCodes(arg: CodeService.UpdateCodesArgs): Promise<number>;
     /** Delete an array of codes by their guids.
      * @note This will automatically attempt to obtain, perform the operation, and then release the write lock.
      */
-    deleteCodes: (guid: CodeService.CodeGuid[]) => Promise<void>;
+    deleteCodes(guid: CodeService.CodeGuid[]): Promise<void>;
 }
 /** @alpha */
 export declare namespace CodeService {
     /** @internal */
-    let createForBriefcase: undefined | ((db: BriefcaseDb) => CodeService);
+    let createForIModel: ((db: IModelDb) => CodeService) | undefined;
     /** Register an instance of a`CodeSequence` so it can be looked up by name. */
     function registerSequence(seq: CodeSequence): void;
     /** Get a previously registered `CodeSequence` by its name.
@@ -160,7 +158,7 @@ export declare namespace CodeService {
      * 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(briefcase: BriefcaseDb, code: CodeProps): CodeService.ScopeAndSpec;
+    function makeScopeAndSpec(iModel: IModelDb, code: CodeProps): CodeService.ScopeAndSpec;
     /** Turn a `CodeProps` and  `ProposedCodeProps` into a `ProposedCode` for use with a CodeService.
      * @see [[makeScopeAndSpec]] for explanation of why this is necessary.
      */
@@ -186,21 +184,6 @@ export declare namespace CodeService {
     type CodeIteration = (guid: GuidString) => IterationReturn;
     /** An iteration function over code specs in a code index. It is called with the name and json of a each code spec. */
     type NameAndJsonIteration = (nameAndJson: NameAndJson) => IterationReturn;
-    /** Parameters used to obtain the write lock on a cloud container */
-    interface ObtainLockParams {
-        /** The name of the user attempting to acquire the write lock. This name will be shown to other users while the lock is held. */
-        user?: string;
-        /** number of times to retry in the event the lock currently held by someone else.
-         * After this number of attempts, `onFailure` is called. Default is 20.
-         */
-        nRetries: number;
-        /** Delay between retries, in milliseconds. Default is 100. */
-        retryDelayMs: number;
-        /** function called if lock cannot be obtained after all retries. It is called with the name of the user currently holding the lock and
-         * generally is expected that the user will be consulted whether to wait further.
-         * If this function returns "stop", an exception will be thrown. Otherwise the retry cycle is restarted. */
-        onFailure?: CloudSqlite.WriteLockBusyHandler;
-    }
     /** Argument for reserving an array of new codes. */
     interface ReserveCodesArgs {
         /** an array of proposed codes to reserve.
@@ -239,7 +222,7 @@ export declare namespace CodeService {
     }
     /** Arguments for CodeService.makeProposedCode  */
     interface MakeProposedCodeArgs {
-        readonly briefcase: BriefcaseDb;
+        readonly iModel: IModelDb;
         readonly code: Required<CodeProps>;
         readonly props: CodeService.CodeGuidStateJson;
     }
@@ -247,14 +230,19 @@ export declare namespace CodeService {
      * @see CodeService.verifyCode
      */
     interface ElementCodeProps {
-        /** The imodel-specific code properties. */
-        readonly code: CodeProps;
-        /**
-         * The federationGuid of the element being inserted or updated.
-         * If federationGuid is defined, it is must match the value in the code index or an error is thrown.
-         * If it is undefined, the value from the code index is returned here.
-         */
-        federationGuid?: GuidString;
+        /** iModel from which the code is being inserted/updated. */
+        readonly iModel: IModelDb;
+        /** Properties of the code */
+        readonly props: {
+            /** The imodel-specific code properties. */
+            readonly code: CodeProps;
+            /**
+             * The federationGuid of the element being inserted or updated.
+             * If federationGuid is defined, it is must match the value in the code index or an error is thrown.
+             * If it is undefined, the value from the code index is returned here.
+             */
+            federationGuid?: GuidString;
+        };
     }
     /** a name and a json object. Used for code specs, authors and origins. */
     interface NameAndJson {

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

@@ -1 +1 @@
-{"version":3,"file":"CodeService.d.ts","sourceRoot":"","sources":["../../src/CodeService.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,UAAU,EAAgB,YAAY,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACjH,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB;;;;;OAKG;IACH,iBAAiB,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,aAAa,KAAK,WAAW,CAAC,SAAS,CAAC;IAE9E;;;;OAIG;IACH,eAAe,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,aAAa,KAAK,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC;IAExF,yEAAyE;IACzE,aAAa,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,QAAQ,KAAK,OAAO,CAAC;IAEvD;;OAEG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,QAAQ,KAAK,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC;IAE3E;;OAEG;IACH,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,iBAAiB,KAAK,WAAW,CAAC,QAAQ,GAAG,SAAS,CAAC;IAEpF;;OAEG;IACH,WAAW,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,YAAY,KAAK,WAAW,CAAC,WAAW,CAAC;IAE1E,0GAA0G;IAC1G,WAAW,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,WAAW,CAAC,UAAU,KAAK,IAAI,CAAC;IAExF,2GAA2G;IAC3G,eAAe,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC,EAAE,WAAW,CAAC,WAAW,KAAK,IAAI,CAAC;CACrG;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,gBAAgB;IAChB,KAAK,EAAE,MAAM,IAAI,CAAC;IAElB,gBAAgB;IAChB,eAAe,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAErC,0CAA0C;IAC1C,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;IAEhC,0CAA0C;IAC1C,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,gBAAgB,GAAG,WAAW,CAAC,eAAe,CAAC;IAE/E;;;;OAIG;IACH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;;;;;;OAOG;IACH,oBAAoB,EAAE,MAAM,IAAI,CAAC;IAEjC;;;;;;;;OAQG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,gBAAgB,KAAK,IAAI,CAAC;IAE1D;;OAEG;IACH,WAAW,EAAE,CAAC,GAAG,EAAE,WAAW,CAAC,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D;;;;;;;OAOG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IAEnC;;;;OAIG;IACH,WAAW,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/D;;;;;;;OAOG;IACH,YAAY,EAAE,CAAC,GAAG,EAAE,WAAW,CAAC,gBAAgB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAErE;;;OAGG;IACH,wBAAwB,EAAE,CAAC,GAAG,EAAE,WAAW,CAAC,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9E;;;;;;OAMG;IACH,yBAAyB,EAAE,CAAC,GAAG,EAAE,WAAW,CAAC,oBAAoB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAEtF;;;OAGG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9D;;;;;OAKG;IACH,WAAW,EAAE,CAAC,GAAG,EAAE,WAAW,CAAC,eAAe,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAEnE;;OAEG;IACH,WAAW,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,QAAQ,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D;AAED,aAAa;AACb,yBAAiB,WAAW,CAAC;IAI3B,gBAAgB;IACT,IAAI,kBAAkB,EAAE,SAAS,GAAG,CAAC,CAAC,EAAE,EAAE,WAAW,KAAK,WAAW,CAAC,CAAC;IAE9E,8EAA8E;IAC9E,SAAgB,gBAAgB,CAAC,GAAG,EAAE,YAAY,QAA+C;IAEjG;;MAEE;IACF,SAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAKtD;IAED;;;;;OAKG;IACH,SAAgB,gBAAgB,CAAC,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,GAAG,WAAW,CAAC,YAAY,CAMlG;IAED;;OAEG;IACH,SAAgB,gBAAgB,CAAC,GAAG,EAAE,WAAW,CAAC,oBAAoB,GAAG,WAAW,CAAC,YAAY,CAMhG;IAED,8BAA8B;IAC9B,KAAY,YAAY,GAAG,MAAM,CAAC;IAElC;0FACsF;IACtF,KAAY,cAAc,GAAG,MAAM,CAAC;IAEpC,oKAAoK;IACpK,KAAY,UAAU,GAAG,MAAM,CAAC;IAEhC,4BAA4B;IAC5B,KAAY,SAAS,GAAG,MAAM,CAAC;IAE/B,2FAA2F;IAC3F,KAAY,QAAQ,GAAG,UAAU,CAAC;IAElC,kIAAkI;IAClI,KAAY,SAAS,GAAG,UAAU,CAAC;IAEnC,mIAAmI;IACnI,KAAY,SAAS,GAAG,MAAM,CAAC;IAE/B,sGAAsG;IACtG,KAAY,eAAe,GAAG,IAAI,GAAG,MAAM,CAAC;IAE5C,mGAAmG;IACnG,KAAY,aAAa,GAAG,CAAC,IAAI,EAAE,UAAU,KAAK,eAAe,CAAC;IAElE,sHAAsH;IACtH,KAAY,oBAAoB,GAAG,CAAC,WAAW,EAAE,WAAW,KAAK,eAAe,CAAC;IAEjF,oEAAoE;IACpE,UAAiB,gBAAgB;QAC/B,gIAAgI;QAChI,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QACjB,8DAA8D;QAC9D,YAAY,EAAE,MAAM,CAAC;QACrB;;mHAE2G;QAC3G,SAAS,CAAC,EAAE,WAAW,CAAC,oBAAoB,CAAC;KAC9C;IAED,oDAAoD;IACpD,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,YAAY,EAAE,CAAC;QAC3C,+GAA+G;QAC/G,QAAQ,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC;KAC9B;IAED,0DAA0D;IAC1D,UAAiB,eAAe;QAC9B,qCAAqC;QACrC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,iBAAiB,CAAC;QAC7C,oDAAoD;QACpD,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;KAC9B;IAED,qEAAqE;IACrE,UAAiB,oBAAoB;QACnC,8CAA8C;QAC9C,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,iBAAiB,EAAE,CAAC;QAChD,qDAAqD;QACrD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,aAAa,CAAC;QACzC;;;;WAIG;QACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,IAAI,CAAC;KAClC;IAED,+CAA+C;IAC/C,UAAiB,eAAe;QAC9B,wCAAwC;QACxC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,WAAW,EAAE,CAAC;QAC1C,0GAA0G;QAC1G,QAAQ,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC;KAC9B;IAED,kDAAkD;IAClD,UAAiB,oBAAoB;QACnC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;QAChC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;QACnC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,iBAAiB,CAAC;KAC/C;IAED;;OAEG;IACH,UAAiB,gBAAgB;QAC/B,2CAA2C;QAC3C,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;QACzB;;;;WAIG;QACH,cAAc,CAAC,EAAE,UAAU,CAAC;KAC7B;IAED,0EAA0E;IAC1E,UAAiB,WAAW;QAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC;KAC/B;IAED,6CAA6C;IAC7C,UAAiB,YAAY;QAC3B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;QAC5B,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;KAC3B;IAED,oDAAoD;IACpD,UAAiB,iBAAkB,SAAQ,YAAY;QACrD,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;KAC3B;IAED,uDAAuD;IACvD,UAAiB,SAAS;QACxB,+CAA+C;QAC/C,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;QAC5B,oEAAoE;QACpE,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;QAC1B,8BAA8B;QAC9B,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;QAC1B,mDAAmD;QACnD,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;QACxB,+CAA+C;QAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;QAC3B,kGAAkG;QAClG,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;QAChC,6DAA6D;QAC7D,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;QAC7B,0EAA0E;QAC1E,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC;KAC/B;IAED,8EAA8E;IAC9E,UAAiB,WAAW;QAC1B,6EAA6E;QAC7E,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QACxB,0DAA0D;QAC1D,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;QACpF,kGAAkG;QAClG,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;QAClC,8JAA8J;QAC9J,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;KACjC;IAED,4FAA4F;IAC5F,UAAiB,UAAW,SAAQ,WAAW;QAC7C,8DAA8D;QAC9D,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC;QAC7B,oEAAoE;QACpE,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;QAC3B,gEAAgE;QAChE,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,CAAC;KAClC;IAED,sEAAsE;IACtE,UAAiB,eAAe;QAC9B,0EAA0E;QAC1E,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QACtC,uHAAuH;QACvH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;KACvC;IAED,sDAAsD;IACtD,UAAiB,iBAAiB;QAChC,oFAAoF;QACpF,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;QACxB,mDAAmD;QACnD,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;QAC3B,0DAA0D;QAC1D,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC;KAC/B;IAED;;;OAGG;IACH,UAAiB,iBAAkB,SAAQ,iBAAiB;QAC1D;;WAEG;QACH,KAAK,CAAC,EAAE,SAAS,CAAC;KACnB;IAED,oGAAoG;IACpG,KAAY,YAAY,GAAG,iBAAiB,GAAG,iBAAiB,CAAC;IAEjE,2HAA2H;IAC3H,UAAiB,aAAc,SAAQ,YAAY;QACjD,yBAAyB;QACzB,QAAQ,CAAC,GAAG,EAAE,YAAY,CAAC;QAC3B,6GAA6G;QAC7G,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;KAC5B;IAED;;;OAGG;IACH,KAAY,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,CAAC;IAEtE,oEAAoE;IACpE,UAAiB,cAAc;QAC7B,qCAAqC;QACrC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;QAC5B,iCAAiC;QACjC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;QAC1B,mEAAmE;QACnE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;KAC1B;IAED,qDAAqD;IACrD,UAAiB,aAAa;QAC5B,wDAAwD;QACxD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;QAC3B,iCAAiC;QACjC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;QAC1B,mEAAmE;QACnE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;KAC1B;IAED;;;;OAIG;IACH,UAAiB,YAAY;QAC3B,qCAAqC;QACrC,IAAI,YAAY,IAAI,MAAM,CAAC;QAC3B,sDAAsD;QACtD,aAAa,IAAI,SAAS,CAAC;QAC3B,qDAAqD;QACrD,YAAY,IAAI,SAAS,CAAC;QAC1B;;;WAGG;QACH,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,CAAC;QACzC,wEAAwE;QACxE,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;KACvC;IAED,uDAAuD;IACvD,MAAa,KAAM,SAAQ,YAAY;QACrC,6EAA6E;QAC7E,SAAgB,OAAO,EAAE,OAAO,CAAC;QACjC,uGAAuG;QACvG,SAAgB,QAAQ,CAAC,EAAE,cAAc,EAAE,GAAG,aAAa,EAAE,CAAC;QAE9D,gBAAgB;oBACJ,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,EAAE,GAAG,aAAa,EAAE;KAK7G;IAED;;OAEG;IACH,KAAY,OAAO,GACjB,eAAe,GACf,eAAe,GACf,cAAc,GACd,gBAAgB,GAChB,aAAa,GACb,cAAc,GACd,cAAc,GACd,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,iBAAiB,GACjB,aAAa,GACb,aAAa,GACb,cAAc,GACd,aAAa,GACb,aAAa,GACb,cAAc,GACd,eAAe,GACf,kBAAkB,GAClB,eAAe,GACf,cAAc,GACd,cAAc,GACd,cAAc,CAAC;CAElB"}
+{"version":3,"file":"CodeService.d.ts","sourceRoot":"","sources":["../../src/CodeService.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,UAAU,EAAgB,YAAY,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACjH,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB;;;;;OAKG;IACH,iBAAiB,CAAC,IAAI,EAAE,WAAW,CAAC,aAAa,GAAG,WAAW,CAAC,SAAS,CAAC;IAE1E;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,WAAW,CAAC,aAAa,GAAG,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC;IAEpF,yEAAyE;IACzE,aAAa,CAAC,IAAI,EAAE,WAAW,CAAC,QAAQ,GAAG,OAAO,CAAC;IAEnD;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,QAAQ,GAAG,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC;IAEvE;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,iBAAiB,GAAG,WAAW,CAAC,QAAQ,GAAG,SAAS,CAAC;IAEhF;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC,WAAW,CAAC;IAEtE,0GAA0G;IAC1G,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,WAAW,CAAC,UAAU,GAAG,IAAI,CAAC;IAEpF,2GAA2G;IAC3G,eAAe,CAAC,IAAI,EAAE,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;CACjG;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,gBAAgB;IAChB,KAAK,EAAE,MAAM,IAAI,CAAC;IAElB,gBAAgB;IAChB,eAAe,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD,0CAA0C;IAC1C,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,gBAAgB,GAAG,WAAW,CAAC,eAAe,CAAC;IAE5E;;;;OAIG;IACH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;;;;;;OAOG;IACH,oBAAoB,IAAI,IAAI,CAAC;IAE7B;;;;;;;;OAQG;IACH,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD;;;;;;;OAOG;IACH,WAAW,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE/C;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3D;;;;;;;OAOG;IACH,YAAY,CAAC,GAAG,EAAE,WAAW,CAAC,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjE;;;OAGG;IACH,wBAAwB,CAAC,GAAG,EAAE,WAAW,CAAC,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1E;;;;;;OAMG;IACH,yBAAyB,CAAC,GAAG,EAAE,WAAW,CAAC,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAElF;;;OAGG;IACH,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1D;;;;;OAKG;IACH,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE/D;;OAEG;IACH,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,QAAQ,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1D;AAED,aAAa;AACb,yBAAiB,WAAW,CAAC;IAI3B,gBAAgB;IACT,IAAI,eAAe,EAAE,CAAC,CAAC,EAAE,EAAE,QAAQ,KAAK,WAAW,CAAC,GAAG,SAAS,CAAC;IAExE,8EAA8E;IAC9E,SAAgB,gBAAgB,CAAC,GAAG,EAAE,YAAY,QAA+C;IAEjG;;MAEE;IACF,SAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAKtD;IAED;;;;;OAKG;IACH,SAAgB,gBAAgB,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,GAAG,WAAW,CAAC,YAAY,CAM5F;IAED;;OAEG;IACH,SAAgB,gBAAgB,CAAC,GAAG,EAAE,WAAW,CAAC,oBAAoB,GAAG,WAAW,CAAC,YAAY,CAMhG;IAED,8BAA8B;IAC9B,KAAY,YAAY,GAAG,MAAM,CAAC;IAElC;0FACsF;IACtF,KAAY,cAAc,GAAG,MAAM,CAAC;IAEpC,oKAAoK;IACpK,KAAY,UAAU,GAAG,MAAM,CAAC;IAEhC,4BAA4B;IAC5B,KAAY,SAAS,GAAG,MAAM,CAAC;IAE/B,2FAA2F;IAC3F,KAAY,QAAQ,GAAG,UAAU,CAAC;IAElC,kIAAkI;IAClI,KAAY,SAAS,GAAG,UAAU,CAAC;IAEnC,mIAAmI;IACnI,KAAY,SAAS,GAAG,MAAM,CAAC;IAE/B,sGAAsG;IACtG,KAAY,eAAe,GAAG,IAAI,GAAG,MAAM,CAAC;IAE5C,mGAAmG;IACnG,KAAY,aAAa,GAAG,CAAC,IAAI,EAAE,UAAU,KAAK,eAAe,CAAC;IAElE,sHAAsH;IACtH,KAAY,oBAAoB,GAAG,CAAC,WAAW,EAAE,WAAW,KAAK,eAAe,CAAC;IAEjF,oDAAoD;IACpD,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,YAAY,EAAE,CAAC;QAC3C,+GAA+G;QAC/G,QAAQ,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC;KAC9B;IAED,0DAA0D;IAC1D,UAAiB,eAAe;QAC9B,qCAAqC;QACrC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,iBAAiB,CAAC;QAC7C,oDAAoD;QACpD,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;KAC9B;IAED,qEAAqE;IACrE,UAAiB,oBAAoB;QACnC,8CAA8C;QAC9C,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,iBAAiB,EAAE,CAAC;QAChD,qDAAqD;QACrD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,aAAa,CAAC;QACzC;;;;WAIG;QACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,IAAI,CAAC;KAClC;IAED,+CAA+C;IAC/C,UAAiB,eAAe;QAC9B,wCAAwC;QACxC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,WAAW,EAAE,CAAC;QAC1C,0GAA0G;QAC1G,QAAQ,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC;KAC9B;IAED,kDAAkD;IAClD,UAAiB,oBAAoB;QACnC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;QAC1B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;QACnC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,iBAAiB,CAAC;KAC/C;IAED;;OAEG;IACH,UAAiB,gBAAgB;QAC/B,4DAA4D;QAC5D,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;QAC1B,6BAA6B;QAC7B,QAAQ,CAAC,KAAK,EAAE;YACd,2CAA2C;YAC3C,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;YACzB;;;;eAIG;YACH,cAAc,CAAC,EAAE,UAAU,CAAC;SAC7B,CAAC;KACH;IAED,0EAA0E;IAC1E,UAAiB,WAAW;QAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC;KAC/B;IAED,6CAA6C;IAC7C,UAAiB,YAAY;QAC3B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;QAC5B,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;KAC3B;IAED,oDAAoD;IACpD,UAAiB,iBAAkB,SAAQ,YAAY;QACrD,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;KAC3B;IAED,uDAAuD;IACvD,UAAiB,SAAS;QACxB,+CAA+C;QAC/C,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;QAC5B,oEAAoE;QACpE,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;QAC1B,8BAA8B;QAC9B,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;QAC1B,mDAAmD;QACnD,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;QACxB,+CAA+C;QAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;QAC3B,kGAAkG;QAClG,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;QAChC,6DAA6D;QAC7D,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;QAC7B,0EAA0E;QAC1E,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC;KAC/B;IAED,8EAA8E;IAC9E,UAAiB,WAAW;QAC1B,6EAA6E;QAC7E,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QACxB,0DAA0D;QAC1D,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;QACpF,kGAAkG;QAClG,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;QAClC,8JAA8J;QAC9J,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;KACjC;IAED,4FAA4F;IAC5F,UAAiB,UAAW,SAAQ,WAAW;QAC7C,8DAA8D;QAC9D,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC;QAC7B,oEAAoE;QACpE,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;QAC3B,gEAAgE;QAChE,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,CAAC;KAClC;IAED,sEAAsE;IACtE,UAAiB,eAAe;QAC9B,0EAA0E;QAC1E,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QACtC,uHAAuH;QACvH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;KACvC;IAED,sDAAsD;IACtD,UAAiB,iBAAiB;QAChC,oFAAoF;QACpF,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;QACxB,mDAAmD;QACnD,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;QAC3B,0DAA0D;QAC1D,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC;KAC/B;IAED;;;OAGG;IACH,UAAiB,iBAAkB,SAAQ,iBAAiB;QAC1D;;WAEG;QACH,KAAK,CAAC,EAAE,SAAS,CAAC;KACnB;IAED,oGAAoG;IACpG,KAAY,YAAY,GAAG,iBAAiB,GAAG,iBAAiB,CAAC;IAEjE,2HAA2H;IAC3H,UAAiB,aAAc,SAAQ,YAAY;QACjD,yBAAyB;QACzB,QAAQ,CAAC,GAAG,EAAE,YAAY,CAAC;QAC3B,6GAA6G;QAC7G,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;KAC5B;IAED;;;OAGG;IACH,KAAY,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,CAAC;IAEtE,oEAAoE;IACpE,UAAiB,cAAc;QAC7B,qCAAqC;QACrC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;QAC5B,iCAAiC;QACjC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;QAC1B,mEAAmE;QACnE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;KAC1B;IAED,qDAAqD;IACrD,UAAiB,aAAa;QAC5B,wDAAwD;QACxD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;QAC3B,iCAAiC;QACjC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;QAC1B,mEAAmE;QACnE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;KAC1B;IAED;;;;OAIG;IACH,UAAiB,YAAY;QAC3B,qCAAqC;QACrC,IAAI,YAAY,IAAI,MAAM,CAAC;QAC3B,sDAAsD;QACtD,aAAa,IAAI,SAAS,CAAC;QAC3B,qDAAqD;QACrD,YAAY,IAAI,SAAS,CAAC;QAC1B;;;WAGG;QACH,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,CAAC;QACzC,wEAAwE;QACxE,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;KACvC;IAED,uDAAuD;IACvD,MAAa,KAAM,SAAQ,YAAY;QACrC,6EAA6E;QAC7E,SAAgB,OAAO,EAAE,OAAO,CAAC;QACjC,uGAAuG;QACvG,SAAgB,QAAQ,CAAC,EAAE,cAAc,EAAE,GAAG,aAAa,EAAE,CAAC;QAE9D,gBAAgB;oBACJ,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,EAAE,GAAG,aAAa,EAAE;KAK7G;IAED;;OAEG;IACH,KAAY,OAAO,GACjB,eAAe,GACf,eAAe,GACf,cAAc,GACd,gBAAgB,GAChB,aAAa,GACb,cAAc,GACd,cAAc,GACd,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,iBAAiB,GACjB,aAAa,GACb,aAAa,GACb,cAAc,GACd,aAAa,GACb,aAAa,GACb,cAAc,GACd,eAAe,GACf,kBAAkB,GAClB,eAAe,GACf,cAAc,GACd,cAAc,GACd,cAAc,CAAC;CAElB"}

package/lib/cjs/CodeService.js

@@ -30,11 +30,11 @@ var CodeService;
      * 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(briefcase, code) {
-        const scope = briefcase.elements.getElementProps({ id: code.scope, onlyBaseProperties: true }).federationGuid;
+    function makeScopeAndSpec(iModel, code) {
+        const scope = iModel.elements.getElementProps({ id: code.scope, onlyBaseProperties: true }).federationGuid;
         if (undefined === scope)
             throw new CodeService.Error("MissingGuid", core_bentley_1.IModelStatus.InvalidCode, "code scope element has no federationGuid");
-        return { scope, spec: briefcase.codeSpecs.getById(code.spec).name };
+        return { scope, spec: iModel.codeSpecs.getById(code.spec).name };
     }
     CodeService.makeScopeAndSpec = makeScopeAndSpec;
     /** Turn a `CodeProps` and  `ProposedCodeProps` into a `ProposedCode` for use with a CodeService.
@@ -44,7 +44,7 @@ var CodeService;
         return {
             ...arg.props,
             value: arg.code.value,
-            ...makeScopeAndSpec(arg.briefcase, arg.code),
+            ...makeScopeAndSpec(arg.iModel, arg.code),
         };
     }
     CodeService.makeProposedCode = makeProposedCode;

package/lib/cjs/CodeService.js.map

@@ -1 +1 @@
-{"version":3,"file":"CodeService.js","sourceRoot":"","sources":["../../src/CodeService.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAG/F,sDAAiH;AA2KjH,aAAa;AACb,IAAiB,WAAW,CAsV3B;AAtVD,WAAiB,WAAW;IAC1B,gBAAgB;IAChB,MAAM,aAAa,GAAG,IAAI,GAAG,EAAwB,CAAC;IAKtD,8EAA8E;IAC9E,SAAgB,gBAAgB,CAAC,GAAiB,IAAI,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAAjF,4BAAgB,mBAAiE,CAAA;IAEjG;;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,SAAsB,EAAE,IAAe;QACtE,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,CAAC;QAC9G,IAAI,SAAS,KAAK,KAAK;YACrB,MAAM,IAAI,WAAW,CAAC,KAAK,CAAC,aAAa,EAAE,2BAAY,CAAC,WAAW,EAAE,0CAA0C,CAAC,CAAC;QAEnH,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IACtE,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,SAAS,EAAE,GAAG,CAAC,IAAI,CAAC;SAC7C,CAAC;IACJ,CAAC;IANe,4BAAgB,mBAM/B,CAAA;IAgQD,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,EAtVgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAsV3B","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 { CloudSqlite } from \"@bentley/imodeljs-native\";\r\nimport { AccessToken, BentleyError, GuidString, IModelStatus, MarkRequired, Mutable } from \"@itwin/core-bentley\";\r\nimport { CodeProps } from \"@itwin/core-common\";\r\nimport { BriefcaseDb } 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: () => Promise<void>;\r\n\r\n  /** the BriefcaseDb of this CodeService */\r\n  readonly briefcase: BriefcaseDb;\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 and for reserving new codes.\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 appParams: CodeService.ObtainLockParams & 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: () => 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 createForBriefcase: undefined | ((db: BriefcaseDb) => CodeService);\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) { codeSequences.set(seq.sequenceName, seq); }\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(briefcase: BriefcaseDb, code: CodeProps): CodeService.ScopeAndSpec {\r\n    const scope = briefcase.elements.getElementProps({ id: code.scope, onlyBaseProperties: true }).federationGuid;\r\n    if (undefined === scope)\r\n      throw new CodeService.Error(\"MissingGuid\", IModelStatus.InvalidCode, \"code scope element has no federationGuid\");\r\n\r\n    return { scope, spec: briefcase.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.briefcase, 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  /** Parameters used to obtain the write lock on a cloud container */\r\n  export interface ObtainLockParams {\r\n    /** The name of the user attempting to acquire the write lock. This name will be shown to other users while the lock is held. */\r\n    user?: string;\r\n    /** number of times to retry in the event the lock currently held by someone else.\r\n     * After this number of attempts, `onFailure` is called. Default is 20.\r\n     */\r\n    nRetries: number;\r\n    /** Delay between retries, in milliseconds. Default is 100. */\r\n    retryDelayMs: number;\r\n    /** function called if lock cannot be obtained after all retries. It is called with the name of the user currently holding the lock and\r\n     * generally is expected that the user will be consulted whether to wait further.\r\n     * If this function returns \"stop\", an exception will be thrown. Otherwise the retry cycle is restarted. */\r\n    onFailure?: CloudSqlite.WriteLockBusyHandler;\r\n  }\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 briefcase: BriefcaseDb;\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    /** 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  /** 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 spec: CodeSpecName;\r\n    readonly scope: 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 spec: CodeSpecName;\r\n    /** The guid of the entity that provides the scope for this code. */\r\n    readonly scope: 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 spec?: CodeSpecName;\r\n    /** If supplied, limit results to only those with this scope Guid */\r\n    readonly scope?: 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;AAyKjH,aAAa;AACb,IAAiB,WAAW,CA2U3B;AA3UD,WAAiB,WAAW;IAC1B,gBAAgB;IAChB,MAAM,aAAa,GAAG,IAAI,GAAG,EAAwB,CAAC;IAKtD,8EAA8E;IAC9E,SAAgB,gBAAgB,CAAC,GAAiB,IAAI,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAAjF,4BAAgB,mBAAiE,CAAA;IAEjG;;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,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,CAAC;QAC3G,IAAI,SAAS,KAAK,KAAK;YACrB,MAAM,IAAI,WAAW,CAAC,KAAK,CAAC,aAAa,EAAE,2BAAY,CAAC,WAAW,EAAE,0CAA0C,CAAC,CAAC;QAEnH,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IACnE,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,EA3UgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QA2U3B","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 { IModelDb } from \"./IModelDb\";\r\nimport { SQLiteDb } from \"./SQLiteDb\";\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 and for reserving new codes.\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 appParams: SQLiteDb.ObtainLockParams & 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) { codeSequences.set(seq.sequenceName, seq); }\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 scope = iModel.elements.getElementProps({ id: code.scope, onlyBaseProperties: true }).federationGuid;\r\n    if (undefined === scope)\r\n      throw new CodeService.Error(\"MissingGuid\", IModelStatus.InvalidCode, \"code scope element has no federationGuid\");\r\n\r\n    return { scope, spec: 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 spec: CodeSpecName;\r\n    readonly scope: 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 spec: CodeSpecName;\r\n    /** The guid of the entity that provides the scope for this code. */\r\n    readonly scope: 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 spec?: CodeSpecName;\r\n    /** If supplied, limit results to only those with this scope Guid */\r\n    readonly scope?: 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"]}

package/lib/cjs/Element.js

@@ -62,7 +62,7 @@ class Element extends Entity_1.Entity {
         iModel.locks.checkSharedLock(props.model, "model", "insert"); // inserting requires shared lock on model
         if (props.parent) // inserting requires shared lock on parent, if present
             iModel.locks.checkSharedLock(props.parent.id, "parent", "insert");
-        (_c = iModel.codeService) === null || _c === void 0 ? void 0 : _c.verifyCode(props);
+        (_c = iModel.codeService) === null || _c === void 0 ? void 0 : _c.verifyCode(arg);
     }
     /** Called after a new Element was inserted.
      * @note If you override this method, you must call super.
@@ -81,7 +81,7 @@ class Element extends Entity_1.Entity {
     static onUpdate(arg) {
         var _c;
         arg.iModel.locks.checkExclusiveLock(arg.props.id, "element", "update"); // eslint-disable-line @typescript-eslint/no-non-null-assertion
-        (_c = arg.iModel.codeService) === null || _c === void 0 ? void 0 : _c.verifyCode(arg.props);
+        (_c = arg.iModel.codeService) === null || _c === void 0 ? void 0 : _c.verifyCode(arg);
     }
     /** Called after an Element was updated.
      * @note If you override this method, you must call super.