@itwin/core-backend 4.0.0-dev.94 → 4.0.0-dev.96

package/lib/cjs/CodeService.d.ts

@@ -1,152 +1,12 @@
-import { AccessToken, BentleyError, GuidString, MarkRequired, Mutable } from "@itwin/core-bentley";
+import { BentleyError, GuidString, MarkRequired, Mutable } from "@itwin/core-bentley";
 import { CodeProps, FontId, FontType } from "@itwin/core-common";
 import { CloudSqlite } from "./CloudSqlite";
 import { IModelDb } from "./IModelDb";
 import { SettingObject } from "./workspace/Settings";
-/**
- * A readonly index of all known Codes for an iTwin. The CodeIndex may be slightly out-of-date
- * with the master copy in the cloud, but it should be periodically synchronized. Whenever codes are reserved/updated/deleted
- * locally, this copy is always up-to-date as of those changes.
- * @alpha
- */
-export interface CodeIndex {
-    /**
-     * Find the next available value for the supplied `SequenceScope`.
-     * If the sequence is full (there are no available values), this will throw an exception with `errorId="SequenceFull"`
-     * @param from the sequence and scope to search
-     * @returns the next available CodeValue in the sequence.
-     */
-    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;
-    /** Determine whether a code is present in this CodeIndex by its Guid. */
-    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;
-    /** 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;
-    /** Look up a code spec by its name
-     * @throws if the spec is not present.
-     */
-    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;
-    /** Call an iteration function for all code specs in this index, optionally filtered by a `ValueFilter ` */
-    forAllCodeSpecs(iter: CodeService.NameAndJsonIteration, filter?: CodeService.ValueFilter): void;
-}
-/**
- * @alpha
- */
-export interface CodesDb {
-    /**
-     * Application-supplied parameters for obtaining the write lock on the container.
-     * 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 lockParams: CloudSqlite.ObtainLockParams;
-    /** the code index for this CodeService */
-    readonly codeIndex: CodeIndex;
-    /**
-     * 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
-     * timer) before it expires.
-     */
-    sasToken: AccessToken;
-    /**
-     * Synchronize the local index with any changes by made by others.
-     * @note This is called automatically whenever any write operation is performed on the code index. It is only necessary to
-     * call this directly if you have not changed the code index recently, but wish to perform a readonly operation and want to
-     * ensure it is up-to-date as of now.
-     * @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;
-    /**
-     * Verify that the Code of a to-be-inserted or to-be-updated Element:
-     * 1. has already been reserved,
-     * 2. if the element has a `federationGuid`, it must match the reserved value. If the federationGuid is undefined,
-     * the value from the code index is returned.
-     *
-     * 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(specName: string, arg: 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>;
-    /**
-     * Add all of the codes and code specs from this CodeService's BriefcaseDb into the code index.
-     * @returns the number of codes actually added.
-     * @note It is not necessary to call this method unless the BriefcaseDb somehow becomes out of sync with its CodeService,
-     * for example when migrating iModels to a new code service. It is safe (but relatively expensive) to call this method multiple times, since
-     * 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(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>;
-    /**
-     * Attempt to reserve an array of proposed codes.
-     * @returns number of codes actually reserved.
-     * @see the `problems` member of the `CodeService.Error` exception
-     * @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 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>;
-    /**
-     * 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>;
-    /**
-     * 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
-     * in the array, so they can be associated with the supplied GUIDs.
-     * @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>;
-    /**
-     * 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>;
-    /**
-     * 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>;
-    /** 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>;
-}
-/**
- * @internal
- */
-export interface InternalCodes extends CodesDb {
-    reserveFontId(props: CodeService.FontIndexProps): Promise<FontId>;
-    reserveBisCodeSpecs(specs: CodeService.BisCodeSpecIndexProps[]): Promise<void>;
-    verifyBisCodeSpec(spec: CodeService.BisCodeSpecIndexProps): void;
-}
+import { VersionedSqliteDb } from "./SQLiteDb";
 /**
  * The services for querying, reserving, updating, and deleting codes for a BriefcaseDb (available via `BriefcaseDb.codeService`) whenever it is opened for write access.
+ * See [CodeService]($docs/learning/backend/CodeService).
  * @alpha
  */
 export interface CodeService {
@@ -154,11 +14,9 @@ export interface CodeService {
     close: () => void;
     initialize(iModel: IModelDb): Promise<void>;
     /** the index for external Codes for this CodeService */
-    readonly externalCodes?: CodesDb;
-    /** the index for internal Codes for this CodeService
-     * @internal
-     */
-    readonly internalCodes?: InternalCodes;
+    readonly externalCodes?: CloudSqlite.DbAccess<CodeService.CodesDb, CodeService.ReadMethods, CodeService.WriteMethods>;
+    /** the index for internal Codes for this CodeService */
+    readonly internalCodes?: CloudSqlite.DbAccess<CodeService.InternalCodes, CodeService.InternalReadMethods, CodeService.InternalWriteMethods>;
     /**
      * Application-supplied parameters for reserving new codes.
      */
@@ -176,6 +34,110 @@ export interface CodeService {
 }
 /** @alpha */
 export declare namespace CodeService {
+    interface WriteMethods {
+        /** Add a new code spec to this code service.
+         */
+        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.
+         * @note It is not necessary to call this method unless the BriefcaseDb somehow becomes out of sync with its CodeService,
+         * for example when migrating iModels to a new code service. It is safe (but relatively expensive) to call this method multiple times, since
+         * any codes or code specs that are already in the index are ignored.
+         */
+        addAllCodes(iModel: IModelDb): Promise<number>;
+        /**
+         * Attempt to reserve a single proposed code.
+         * @throws `CodeService.Error` if the proposed code cannot be reserved.
+         */
+        reserveCode(code: CodeService.ProposedCode): Promise<void>;
+        /**
+         * Attempt to reserve an array of proposed codes.
+         * @returns number of codes actually reserved.
+         * @see the `problems` member of the `CodeService.Error` exception
+         * @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>;
+        /**
+         * Attempt to reserve the next available code for a code sequence and scope.
+         */
+        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
+         * in the array, so they can be associated with the supplied GUIDs.
+         * @returns number of codes actually reserved.
+         */
+        reserveNextAvailableCodes(arg: CodeService.ReserveNextArrayArgs): Promise<number>;
+        /**
+         * Update the properties of a single code.
+         */
+        updateCode(props: CodeService.UpdatedCode): Promise<void>;
+        /**
+         * Update the properties of an array codes.
+         * @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>;
+        /** Delete an array of codes by their guids. */
+        deleteCodes(guid: CodeService.CodeGuid[]): Promise<void>;
+    }
+    interface ReadMethods {
+        /**
+         * Find the next available value for the supplied `SequenceScope`.
+         * If the sequence is full (there are no available values), this will throw an exception with `errorId="SequenceFull"`
+         * @param from the sequence and scope to search
+         * @returns the next available CodeValue in the sequence.
+         */
+        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;
+        /** Determine whether a code is present in this CodeIndex by its Guid. */
+        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;
+        /** 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;
+        /** Look up a code spec by its name
+         * @throws if the spec is not present.
+         */
+        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;
+        /** Call an iteration function for all code specs in this index, optionally filtered by a `ValueFilter ` */
+        forAllCodeSpecs(iter: CodeService.NameAndJsonIteration, filter?: CodeService.ValueFilter): void;
+        /**
+         * Verify that the Code of a to-be-inserted or to-be-updated Element:
+         * 1. has already been reserved,
+         * 2. if the element has a `federationGuid`, it must match the reserved value. If the federationGuid is undefined,
+         * the value from the code index is returned.
+         *
+         * 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(specName: string, arg: CodeService.ElementCodeProps): void;
+    }
+    type CodesDb = VersionedSqliteDb & WriteMethods & ReadMethods;
+    interface InternalWriteMethods extends WriteMethods {
+        /**  @internal */
+        reserveFontId(props: CodeService.FontIndexProps): Promise<FontId>;
+        /**  @internal */
+        reserveBisCodeSpecs(specs: CodeService.BisCodeSpecIndexProps[]): Promise<void>;
+    }
+    interface InternalReadMethods extends ReadMethods {
+        /**  @internal */
+        verifyBisCodeSpec(spec: CodeService.BisCodeSpecIndexProps): void;
+    }
+    type InternalCodes = CodesDb & InternalWriteMethods & InternalReadMethods;
     /** @internal */
     let createForIModel: ((db: IModelDb) => Promise<CodeService>) | undefined;
     /** Register an instance of a`CodeSequence` so it can be looked up by name. */

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,YAAY,EAAE,UAAU,EAAgB,YAAY,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACjH,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,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;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,gBAAgB,CAAC;IAElD,0CAA0C;IAC1C,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;;;;;;OAOG;IACH,oBAAoB,IAAI,IAAI,CAAC;IAE7B;;;;;;;;OAQG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAEtE;;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;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,OAAO;IAC5C,aAAa,CAAC,KAAK,EAAE,WAAW,CAAC,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAClE,mBAAmB,CAAC,KAAK,EAAE,WAAW,CAAC,qBAAqB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/E,iBAAiB,CAAC,IAAI,EAAE,WAAW,CAAC,qBAAqB,GAAG,IAAI,CAAC;CAClE;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,gBAAgB;IAChB,KAAK,EAAE,MAAM,IAAI,CAAC;IAElB,UAAU,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C,wDAAwD;IACxD,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,eAAe,CAAC;IAEhD;;;;;;;;OAQG;IACH,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,gBAAgB,GAAG,IAAI,CAAC;CACvD;AAED,aAAa;AACb,yBAAiB,WAAW,CAAC;IAI3B,gBAAgB;IACT,IAAI,eAAe,EAAE,CAAC,CAAC,EAAE,EAAE,QAAQ,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC,GAAG,SAAS,CAAC;IAEjF,8EAA8E;IAC9E,SAAgB,gBAAgB,CAAC,GAAG,EAAE,YAAY,QAEjD;IAED;;OAEG;IACH,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;;;OAGG;IACH,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,QAAQ,EAAE,YAAY,CAAC;QAChC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;KAC/B;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,QAAQ,EAAE,YAAY,CAAC;QAChC,oEAAoE;QACpE,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;QAC9B,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,QAAQ,CAAC,EAAE,YAAY,CAAC;QACjC,oEAAoE;QACpE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;QAC/B,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,gBAAgB;IAChB,UAAiB,cAAc;QAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,QAAQ,EAAE,QAAQ,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;KAClB;IACD,gBAAgB;IAChB,UAAiB,qBAAqB;QACpC,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACf;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,qBAAqB,GACrB,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,YAAY,EAAE,UAAU,EAAgB,YAAY,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACpG,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAE/C;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,gBAAgB;IAChB,KAAK,EAAE,MAAM,IAAI,CAAC;IAElB,UAAU,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C,wDAAwD;IACxD,QAAQ,CAAC,aAAa,CAAC,EAAE,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,WAAW,EAAE,WAAW,CAAC,YAAY,CAAC,CAAC;IAEtH,wDAAwD;IACxD,QAAQ,CAAC,aAAa,CAAC,EAAE,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,aAAa,EAAE,WAAW,CAAC,mBAAmB,EAAE,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAE5I;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,eAAe,CAAC;IAEhD;;;;;;;;OAQG;IACH,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,gBAAgB,GAAG,IAAI,CAAC;CACvD;AAED,aAAa;AACb,yBAAiB,WAAW,CAAC;IAE3B,UAAiB,YAAY;QAC3B;WACG;QACH,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEzD;;;;;;WAMG;QACH,WAAW,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAE/C;;;WAGG;QACH,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAE3D;;;;;;WAMG;QACH,YAAY,CAAC,GAAG,EAAE,WAAW,CAAC,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAEjE;;WAEG;QACH,wBAAwB,CAAC,GAAG,EAAE,WAAW,CAAC,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAE1E;;;;;WAKG;QACH,yBAAyB,CAAC,GAAG,EAAE,WAAW,CAAC,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAElF;;WAEG;QACH,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAE1D;;;;WAIG;QACH,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAE/D,+CAA+C;QAC/C,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,QAAQ,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KAC1D;IAED,UAAiB,WAAW;QAC1B;;;;;WAKG;QACH,iBAAiB,CAAC,IAAI,EAAE,WAAW,CAAC,aAAa,GAAG,WAAW,CAAC,SAAS,CAAC;QAE1E;;;;WAIG;QACH,eAAe,CAAC,IAAI,EAAE,WAAW,CAAC,aAAa,GAAG,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC;QAEpF,yEAAyE;QACzE,aAAa,CAAC,IAAI,EAAE,WAAW,CAAC,QAAQ,GAAG,OAAO,CAAC;QAEnD;;WAEG;QACH,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,QAAQ,GAAG,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC;QAEvE;;WAEG;QACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,iBAAiB,GAAG,WAAW,CAAC,QAAQ,GAAG,SAAS,CAAC;QAEhF;;WAEG;QACH,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC,WAAW,CAAC;QAEtE,0GAA0G;QAC1G,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,WAAW,CAAC,UAAU,GAAG,IAAI,CAAC;QAEpF,2GAA2G;QAC3G,eAAe,CAAC,IAAI,EAAE,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;QAEhG;;;;;;;;WAQG;QACH,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,CAAC,gBAAgB,GAAG,IAAI,CAAC;KACvE;IAED,KAAY,OAAO,GAAG,iBAAiB,GAAG,YAAY,GAAG,WAAW,CAAC;IAErE,UAAiB,oBAAqB,SAAQ,YAAY;QACxD,iBAAiB;QACjB,aAAa,CAAC,KAAK,EAAE,WAAW,CAAC,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAClE,iBAAiB;QACjB,mBAAmB,CAAC,KAAK,EAAE,WAAW,CAAC,qBAAqB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KAChF;IACD,UAAiB,mBAAoB,SAAQ,WAAW;QACtD,iBAAiB;QACjB,iBAAiB,CAAC,IAAI,EAAE,WAAW,CAAC,qBAAqB,GAAG,IAAI,CAAC;KAClE;IAED,KAAY,aAAa,GAAG,OAAO,GAAG,oBAAoB,GAAG,mBAAmB,CAAC;IAKjF,gBAAgB;IACT,IAAI,eAAe,EAAE,CAAC,CAAC,EAAE,EAAE,QAAQ,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC,GAAG,SAAS,CAAC;IAEjF,8EAA8E;IAC9E,SAAgB,gBAAgB,CAAC,GAAG,EAAE,YAAY,QAEjD;IAED;;OAEG;IACH,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;;;OAGG;IACH,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,QAAQ,EAAE,YAAY,CAAC;QAChC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;KAC/B;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,QAAQ,EAAE,YAAY,CAAC;QAChC,oEAAoE;QACpE,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;QAC9B,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,QAAQ,CAAC,EAAE,YAAY,CAAC;QACjC,oEAAoE;QACpE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;QAC/B,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,gBAAgB;IAChB,UAAiB,cAAc;QAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,QAAQ,EAAE,QAAQ,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;KAClB;IACD,gBAAgB;IAChB,UAAiB,qBAAqB;QACpC,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACf;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,qBAAqB,GACrB,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.map

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

@@ -93,7 +93,7 @@ class CodeSpecs {
             // internal code index via `internalCodes.reserveBisCodeSpecs` prior to calling this function.
             // This ensures that the Ids will be unique, and the property values consistent, even if more than one user
             // adds them without pushing their changes. The call to `verifyBisCodeSpec` will throw otherwise.
-            internalCodes.verifyBisCodeSpec(spec);
+            internalCodes.reader.verifyBisCodeSpec(spec);
         }
         else {
             // If this iModel doesn't have an internal code index, we have no way of coordinating the Ids for CodeSpecs across multiple users.

package/lib/cjs/CodeSpecs.js.map

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

package/lib/cjs/DisplayStyle.d.ts

@@ -23,8 +23,7 @@ export declare abstract class DisplayStyle extends DefinitionElement {
      * @param codeValue The DisplayStyle name
      */
     static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code;
-    /** @internal */
-    protected collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void;
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
     /** @alpha */
     protected static onCloned(context: IModelElementCloneContext, sourceElementProps: DisplayStyleProps, targetElementProps: DisplayStyleProps): void;
     loadScheduleScript(): RenderSchedule.ScriptReference | undefined;
@@ -82,8 +81,7 @@ export declare class DisplayStyle3d extends DisplayStyle {
     get settings(): DisplayStyle3dSettings;
     /** @internal */
     constructor(props: DisplayStyle3dProps, iModel: IModelDb);
-    /** @internal */
-    protected collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void;
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
     /** @alpha */
     protected static onCloned(context: IModelElementCloneContext, sourceElementProps: DisplayStyle3dProps, targetElementProps: DisplayStyle3dProps): void;
     /** Create a DisplayStyle3d for use by a ViewDefinition.

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

@@ -1 +1 @@
-{"version":3,"file":"DisplayStyle.d.ts","sourceRoot":"","sources":["../../src/DisplayStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAsC,UAAU,EAAuB,MAAM,qBAAqB,CAAC;AAC1G,OAAO,EACQ,IAAI,EAAE,cAAc,EAAY,QAAQ,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,2BAA2B,EAC/H,iBAAiB,EAAE,oBAAoB,EAAE,kBAAkB,EAA+B,cAAc,EAAoB,SAAS,EACtI,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAkB,MAAM,WAAW,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE;;;;GAIG;AACH,8BAAsB,YAAa,SAAQ,iBAAiB;IAC1D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA2B;IACzE,aAAoB,QAAQ,IAAI,oBAAoB,CAAC;IAErD,gBAAgB;IAChB,SAAS,aAAa,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ;IAIhE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG,gBAAgB;cACG,2BAA2B,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAkBtF,aAAa;qBACa,QAAQ,CAAC,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,iBAAiB,GAAG,IAAI;IAiDnJ,kBAAkB,IAAI,cAAc,CAAC,eAAe,GAAG,SAAS;CAgBxE;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAC3E,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAuB;IAEjD,IAAW,QAAQ,IAAI,oBAAoB,CAA2B;IAEtE,gBAAgB;gBACG,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ;IAI7D;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,cAAc;IAgBrG;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAIlG;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA4B,SAAQ,IAAI,CAAC,2BAA2B,EAAE,iBAAiB,GAAG,gBAAgB,CAAC;IAC1H;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,eAAe,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CACrC;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAC3E,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAyB;IAEnD,IAAW,QAAQ,IAAI,sBAAsB,CAA2B;IAExE,gBAAgB;gBACG,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAK/D,gBAAgB;cACG,2BAA2B,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAUtF,aAAa;qBACa,QAAQ,CAAC,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,mBAAmB,GAAG,IAAI;IA+B9J;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,2BAA2B,GAAG,cAAc;IAyB5I;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,2BAA2B,GAAG,UAAU;CAIzI"}
+{"version":3,"file":"DisplayStyle.d.ts","sourceRoot":"","sources":["../../src/DisplayStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAsC,UAAU,EAAuB,MAAM,qBAAqB,CAAC;AAC1G,OAAO,EACQ,IAAI,EAAE,cAAc,EAAY,QAAQ,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,2BAA2B,EAC/H,iBAAiB,EAAE,oBAAoB,EAAE,kBAAkB,EAA+B,cAAc,EAAoB,SAAS,EACtI,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAkB,MAAM,WAAW,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE;;;;GAIG;AACH,8BAAsB,YAAa,SAAQ,iBAAiB;IAC1D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA2B;IACzE,aAAoB,QAAQ,IAAI,oBAAoB,CAAC;IAErD,gBAAgB;IAChB,SAAS,aAAa,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ;IAIhE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;cAK9E,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAkB9E,aAAa;qBACa,QAAQ,CAAC,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,iBAAiB,GAAG,IAAI;IAiDnJ,kBAAkB,IAAI,cAAc,CAAC,eAAe,GAAG,SAAS;CAgBxE;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAC3E,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAuB;IAEjD,IAAW,QAAQ,IAAI,oBAAoB,CAA2B;IAEtE,gBAAgB;gBACG,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ;IAI7D;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,cAAc;IAgBrG;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAIlG;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA4B,SAAQ,IAAI,CAAC,2BAA2B,EAAE,iBAAiB,GAAG,gBAAgB,CAAC;IAC1H;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,eAAe,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CACrC;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAC3E,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAyB;IAEnD,IAAW,QAAQ,IAAI,sBAAsB,CAA2B;IAExE,gBAAgB;gBACG,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;cAK5C,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAU9E,aAAa;qBACa,QAAQ,CAAC,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,mBAAmB,GAAG,IAAI;IA+B9J;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,2BAA2B,GAAG,cAAc;IAyB5I;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,2BAA2B,GAAG,UAAU;CAIzI"}

package/lib/cjs/DisplayStyle.js

@@ -32,9 +32,8 @@ class DisplayStyle extends Element_1.DefinitionElement {
         const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.displayStyle);
         return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
     }
-    /** @internal */
-    collectReferenceConcreteIds(referenceIds) {
-        super.collectReferenceConcreteIds(referenceIds);
+    collectReferenceIds(referenceIds) {
+        super.collectReferenceIds(referenceIds);
         for (const [id] of this.settings.subCategoryOverrides) {
             referenceIds.addElement(id);
         }
@@ -173,9 +172,8 @@ class DisplayStyle3d extends DisplayStyle {
         super(props, iModel);
         this._settings = new core_common_1.DisplayStyle3dSettings(this.jsonProperties);
     }
-    /** @internal */
-    collectReferenceConcreteIds(referenceIds) {
-        super.collectReferenceConcreteIds(referenceIds);
+    collectReferenceIds(referenceIds) {
+        super.collectReferenceIds(referenceIds);
         for (const textureId of this.settings.environment.sky.textureIds)
             referenceIds.addElement(textureId);
         if (this.settings.planProjectionSettings)