@itwin/core-backend 5.0.0-dev.11 → 5.0.0-dev.110

package/lib/esm/internal/ServerBasedLocks.d.ts

@@ -0,0 +1,52 @@
+/** @packageDocumentation
+ * @module iModels
+ */
+import { Id64Arg, Id64String } from "@itwin/core-bentley";
+import { LockState } from "@itwin/core-common";
+import { BriefcaseDb } from "../IModelDb";
+import { LockControl } from "../LockControl";
+import { SQLiteDb } from "../SQLiteDb";
+import { _close, _elementWasCreated, _implementationProhibited, _releaseAllLocks } from "./Symbols";
+export declare class ServerBasedLocks implements LockControl {
+    readonly [_implementationProhibited]: undefined;
+    get isServerBased(): boolean;
+    protected readonly lockDb: SQLiteDb;
+    protected readonly briefcase: BriefcaseDb;
+    constructor(iModel: BriefcaseDb);
+    [_close](): void;
+    private getOwners;
+    private getLockState;
+    /** Clear the cache of locally held locks.
+     * Note: does *not* release locks from server.
+     */
+    private clearAllLocks;
+    /** only for tests */
+    getLockCount(state: LockState): number;
+    [_releaseAllLocks](): Promise<void>;
+    releaseAllLocks(): Promise<void>;
+    private insertLock;
+    private ownerHoldsExclusiveLock;
+    /** Determine whether an the exclusive lock is already held by an element (or one of its owners) */
+    holdsExclusiveLock(id: Id64String): boolean;
+    holdsSharedLock(id: Id64String): boolean;
+    /** if the shared lock on the element supplied is not already held, add it to the set of shared locks required. Then, check owners. */
+    private addSharedLock;
+    /** add owners (recursively) of an element to a list of required shared locks, if not already held. */
+    private addOwnerSharedLocks;
+    /** attempt to acquire all necessary locks for a set of elements */
+    private acquireAllLocks;
+    acquireLocks(arg: {
+        shared?: Id64Arg;
+        exclusive?: Id64Arg;
+    }): Promise<void>;
+    /** When an element is newly created in a session, we hold the lock on it implicitly. Save that fact. */
+    [_elementWasCreated](id: Id64String): void;
+    /** locks are not necessary during change propagation. */
+    private get _locksAreRequired();
+    /** throw if locks are currently required and the exclusive lock is not held on the supplied element */
+    checkExclusiveLock(id: Id64String, type: string, operation: string): void;
+    /** throw if locks are currently required and a shared lock is not held on the supplied element */
+    checkSharedLock(id: Id64String, type: string, operation: string): void;
+}
+export declare function createServerBasedLocks(iModel: BriefcaseDb): LockControl;
+//# sourceMappingURL=ServerBasedLocks.d.ts.map

package/lib/esm/internal/ServerBasedLocks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServerBasedLocks.d.ts","sourceRoot":"","sources":["../../../src/internal/ServerBasedLocks.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAkB,OAAO,EAAE,UAAU,EAA0B,MAAM,qBAAqB,CAAC;AAClG,OAAO,EAAuB,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAEpE,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAc,yBAAyB,EAAa,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAmB3H,qBAAa,gBAAiB,YAAW,WAAW;IAClD,SAAgB,CAAC,yBAAyB,CAAC,YAAa;IAExD,IAAW,aAAa,YAAmB;IAC3C,SAAS,CAAC,QAAQ,CAAC,MAAM,WAAkB;IAC3C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;gBAEvB,MAAM,EAAE,WAAW;IAY/B,CAAC,MAAM,CAAC;IAKf,OAAO,CAAC,SAAS;IAWjB,OAAO,CAAC,YAAY;IAOpB;;OAEG;IACH,OAAO,CAAC,aAAa;IAKrB,qBAAqB;IACd,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM;IAQhC,CAAC,gBAAgB,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;IAKnC,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ7C,OAAO,CAAC,UAAU;IAYlB,OAAO,CAAC,uBAAuB;IAgB/B,mGAAmG;IAC5F,kBAAkB,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO;IAK3C,eAAe,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO;IAM/C,sIAAsI;IACtI,OAAO,CAAC,aAAa;IAUrB,sGAAsG;IACtG,OAAO,CAAC,mBAAmB;IAM3B,mEAAmE;YACrD,eAAe;IAmBhB,YAAY,CAAC,GAAG,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBxF,wGAAwG;IACjG,CAAC,kBAAkB,CAAC,CAAC,EAAE,EAAE,UAAU;IAK1C,yDAAyD;IACzD,OAAO,KAAK,iBAAiB,GAAqD;IAElF,uGAAuG;IAChG,kBAAkB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAKzE,kGAAkG;IAC3F,eAAe,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;CAKvE;AAED,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,CAEvE"}

package/lib/esm/internal/ServerBasedLocks.js

@@ -0,0 +1,175 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module iModels
+ */
+import { DbResult, Id64, IModelStatus, OpenMode } from "@itwin/core-bentley";
+import { IModel, IModelError, LockState } from "@itwin/core-common";
+import { IModelHost } from "../IModelHost";
+import { SQLiteDb } from "../SQLiteDb";
+import { _close, _elementWasCreated, _hubAccess, _implementationProhibited, _nativeDb, _releaseAllLocks } from "./Symbols";
+export class ServerBasedLocks {
+    [_implementationProhibited] = undefined;
+    get isServerBased() { return true; }
+    lockDb = new SQLiteDb();
+    briefcase;
+    constructor(iModel) {
+        this.briefcase = iModel;
+        const dbName = `${iModel[_nativeDb].getTempFileBaseName()}-locks`;
+        try {
+            this.lockDb.openDb(dbName, OpenMode.ReadWrite);
+        }
+        catch {
+            this.lockDb.createDb(dbName);
+            this.lockDb.executeSQL("CREATE TABLE locks(id INTEGER PRIMARY KEY NOT NULL,state INTEGER NOT NULL,origin INTEGER)");
+            this.lockDb.saveChanges();
+        }
+    }
+    [_close]() {
+        if (this.lockDb.isOpen)
+            this.lockDb.closeDb();
+    }
+    getOwners(id) {
+        return this.briefcase.withPreparedSqliteStatement("SELECT ModelId,ParentId FROM bis_Element WHERE id=?", (stmt) => {
+            stmt.bindId(1, id);
+            const rc = stmt.step();
+            if (DbResult.BE_SQLITE_ROW !== rc)
+                throw new IModelError(rc, `element ${id} not found`);
+            return { modelId: stmt.getValueId(0), parentId: stmt.getValueId(1) };
+        });
+    }
+    getLockState(id) {
+        return (id === undefined || !Id64.isValid(id)) ? undefined : this.lockDb.withPreparedSqliteStatement("SELECT state FROM locks WHERE id=?", (stmt) => {
+            stmt.bindId(1, id);
+            return (DbResult.BE_SQLITE_ROW === stmt.step()) ? stmt.getValueInteger(0) : undefined;
+        });
+    }
+    /** Clear the cache of locally held locks.
+     * Note: does *not* release locks from server.
+     */
+    clearAllLocks() {
+        this.lockDb.executeSQL("DELETE FROM locks");
+        this.lockDb.saveChanges();
+    }
+    /** only for tests */
+    getLockCount(state) {
+        return this.lockDb.withSqliteStatement("SELECT count(*) FROM locks WHERE state=?", (stmt) => {
+            stmt.bindInteger(1, state);
+            stmt.step();
+            return stmt.getValueInteger(0);
+        });
+    }
+    async [_releaseAllLocks]() {
+        await IModelHost[_hubAccess].releaseAllLocks(this.briefcase); // throws if unsuccessful
+        this.clearAllLocks();
+    }
+    async releaseAllLocks() {
+        if (this.briefcase.txns.hasLocalChanges) {
+            throw new Error("Locks cannot be released while the briefcase contains local changes");
+        }
+        return this[_releaseAllLocks]();
+    }
+    insertLock(id, state, origin) {
+        this.lockDb.withPreparedSqliteStatement("INSERT INTO locks(id,state,origin) VALUES (?,?,?) ON CONFLICT(id) DO UPDATE SET state=excluded.state,origin=excluded.origin", (stmt) => {
+            stmt.bindId(1, id);
+            stmt.bindInteger(2, state);
+            stmt.bindInteger(3, origin);
+            const rc = stmt.step();
+            if (DbResult.BE_SQLITE_DONE !== rc)
+                throw new IModelError(rc, "can't insert lock into database");
+        });
+        return true;
+    }
+    ownerHoldsExclusiveLock(id) {
+        if (id === undefined || id === IModel.rootSubjectId)
+            return false; // has no owners
+        const { modelId, parentId } = this.getOwners(id);
+        if (this.getLockState(modelId) === LockState.Exclusive || this.getLockState(parentId) === LockState.Exclusive)
+            return true;
+        // see if this model is exclusively locked by one of its owners. If so, save that fact on modelId so future tests won't have to descend.
+        if (this.ownerHoldsExclusiveLock(modelId))
+            return this.insertLock(modelId, LockState.Exclusive, 2 /* LockOrigin.Discovered */);
+        // see if the parent is exclusively locked by one of its owners. If so, save that fact on parentId so future tests won't have to descend.
+        return this.ownerHoldsExclusiveLock(parentId) ? this.insertLock(parentId, LockState.Exclusive, 2 /* LockOrigin.Discovered */) : false; // eslint-disable-line @typescript-eslint/no-non-null-assertion
+    }
+    /** Determine whether an the exclusive lock is already held by an element (or one of its owners) */
+    holdsExclusiveLock(id) {
+        // see if we hold the exclusive lock. or if one of the element's owners is exclusively locked (recursively)
+        return this.getLockState(id) === LockState.Exclusive || this.ownerHoldsExclusiveLock(id);
+    }
+    holdsSharedLock(id) {
+        const state = this.getLockState(id);
+        // see if we hold shared or exclusive lock, or if an owner has exclusive lock. If so we implicitly have shared lock, but owner holding shared lock doesn't help.
+        return (state === LockState.Shared || state === LockState.Exclusive) || this.ownerHoldsExclusiveLock(id);
+    }
+    /** if the shared lock on the element supplied is not already held, add it to the set of shared locks required. Then, check owners. */
+    addSharedLock(id, locks) {
+        // if the id is not valid, or of the lock is already in the set, or if we already hold a shared lock, we're done
+        // Note: if we hold a shared lock, it is guaranteed that we also hold all required shared locks on owners.
+        if (id === undefined || !Id64.isValid(id) || locks.has(id) || this.holdsSharedLock(id))
+            return;
+        locks.add(id); // add to set of needed shared locks
+        this.addOwnerSharedLocks(id, locks); // check parent models and groups
+    }
+    /** add owners (recursively) of an element to a list of required shared locks, if not already held. */
+    addOwnerSharedLocks(id, locks) {
+        const el = this.getOwners(id);
+        this.addSharedLock(el.parentId, locks); // if this element is in a group
+        this.addSharedLock(el.modelId, locks); // check its model
+    }
+    /** attempt to acquire all necessary locks for a set of elements */
+    async acquireAllLocks(locks) {
+        if (locks.size === 0) // no locks are required.
+            return;
+        const sharedLocks = new Set();
+        for (const lock of locks)
+            this.addOwnerSharedLocks(lock[0], sharedLocks);
+        for (const shared of sharedLocks) {
+            if (!locks.has(shared)) // we may already be asking for exclusive lock
+                locks.set(shared, LockState.Shared);
+        }
+        await IModelHost[_hubAccess].acquireLocks(this.briefcase, locks); // throws if unsuccessful
+        for (const lock of locks)
+            this.insertLock(lock[0], lock[1], 0 /* LockOrigin.Acquired */);
+        this.lockDb.saveChanges();
+    }
+    async acquireLocks(arg) {
+        const locks = new Map();
+        if (arg.shared) {
+            for (const id of Id64.iterable(arg.shared)) {
+                if (!this.holdsSharedLock(id))
+                    locks.set(id, LockState.Shared);
+            }
+        }
+        if (arg.exclusive) {
+            for (const id of Id64.iterable(arg.exclusive)) {
+                if (!this.holdsExclusiveLock(id))
+                    locks.set(id, LockState.Exclusive);
+            }
+        }
+        return this.acquireAllLocks(locks);
+    }
+    /** When an element is newly created in a session, we hold the lock on it implicitly. Save that fact. */
+    [_elementWasCreated](id) {
+        this.insertLock(id, LockState.Exclusive, 1 /* LockOrigin.NewElement */);
+        this.lockDb.saveChanges();
+    }
+    /** locks are not necessary during change propagation. */
+    get _locksAreRequired() { return !this.briefcase.txns.isIndirectChanges; }
+    /** throw if locks are currently required and the exclusive lock is not held on the supplied element */
+    checkExclusiveLock(id, type, operation) {
+        if (this._locksAreRequired && !this.holdsExclusiveLock(id))
+            throw new IModelError(IModelStatus.LockNotHeld, `exclusive lock not held on ${type} for ${operation} (id=${id})`);
+    }
+    /** throw if locks are currently required and a shared lock is not held on the supplied element */
+    checkSharedLock(id, type, operation) {
+        if (this._locksAreRequired && !this.holdsSharedLock(id))
+            throw new IModelError(IModelStatus.LockNotHeld, `shared lock not held on ${type} for ${operation} (id=${id})`);
+    }
+}
+export function createServerBasedLocks(iModel) {
+    return new ServerBasedLocks(iModel);
+}
+//# sourceMappingURL=ServerBasedLocks.js.map

package/lib/esm/internal/ServerBasedLocks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServerBasedLocks.js","sourceRoot":"","sources":["../../../src/internal/ServerBasedLocks.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAuB,YAAY,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAClG,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAIpE,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,UAAU,EAAE,yBAAyB,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAmB3H,MAAM,OAAO,gBAAgB;IACX,CAAC,yBAAyB,CAAC,GAAG,SAAS,CAAC;IAExD,IAAW,aAAa,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IACxB,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;IACxB,SAAS,CAAc;IAE1C,YAAmB,MAAmB;QACpC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC;QACxB,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,mBAAmB,EAAE,QAAQ,CAAC;QAClE,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC7B,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,2FAA2F,CAAC,CAAC;YACpH,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAC5B,CAAC;IACH,CAAC;IAEM,CAAC,MAAM,CAAC;QACb,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YACpB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAEO,SAAS,CAAC,EAAc;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,qDAAqD,EAAE,CAAC,IAAI,EAAE,EAAE;YAChH,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,QAAQ,CAAC,aAAa,KAAK,EAAE;gBAC/B,MAAM,IAAI,WAAW,CAAC,EAAE,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;YAEvD,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QACvE,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,YAAY,CAAC,EAAe;QAClC,OAAO,CAAC,EAAE,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,oCAAoC,EAAE,CAAC,IAAI,EAAE,EAAE;YAClJ,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,OAAO,CAAC,QAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACxF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACK,aAAa;QACnB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED,qBAAqB;IACd,YAAY,CAAC,KAAgB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,0CAA0C,EAAE,CAAC,IAAI,EAAE,EAAE;YAC1F,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,CAAC,gBAAgB,CAAC;QAC7B,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,yBAAyB;QACvF,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;QACzF,CAAC;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;IAClC,CAAC;IAEO,UAAU,CAAC,EAAc,EAAE,KAAgB,EAAE,MAAkB;QACrE,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,6HAA6H,EAAE,CAAC,IAAI,EAAE,EAAE;YAC9K,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC5B,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,QAAQ,CAAC,cAAc,KAAK,EAAE;gBAChC,MAAM,IAAI,WAAW,CAAC,EAAE,EAAE,iCAAiC,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,uBAAuB,CAAC,EAA0B;QACxD,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,MAAM,CAAC,aAAa;YACjD,OAAO,KAAK,CAAC,CAAC,gBAAgB;QAEhC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACjD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,SAAS,CAAC,SAAS,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,SAAS;YAC3G,OAAO,IAAI,CAAC;QAEd,wIAAwI;QACxI,IAAI,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC;YACvC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,SAAS,gCAAwB,CAAC;QAE9E,yIAAyI;QACzI,OAAO,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,QAAS,EAAE,SAAS,CAAC,SAAS,gCAAwB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,+DAA+D;IACjM,CAAC;IAED,mGAAmG;IAC5F,kBAAkB,CAAC,EAAc;QACtC,2GAA2G;QAC3G,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,SAAS,CAAC,SAAS,IAAI,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;IAC3F,CAAC;IAEM,eAAe,CAAC,EAAc;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QACpC,gKAAgK;QAChK,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,MAAM,IAAI,KAAK,KAAK,SAAS,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED,sIAAsI;IAC9H,aAAa,CAAC,EAA0B,EAAE,KAAsB;QACtE,gHAAgH;QAChH,0GAA0G;QAC1G,IAAI,EAAE,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACpF,OAAO;QAET,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,oCAAoC;QACnD,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,iCAAiC;IACxE,CAAC;IAED,sGAAsG;IAC9F,mBAAmB,CAAC,EAAc,EAAE,KAAsB;QAChE,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC9B,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,gCAAgC;QACxE,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,kBAAkB;IAC3D,CAAC;IAED,mEAAmE;IAC3D,KAAK,CAAC,eAAe,CAAC,KAAc;QAC1C,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,yBAAyB;YAC7C,OAAO;QAET,MAAM,WAAW,GAAG,IAAI,GAAG,EAAc,CAAC;QAC1C,KAAK,MAAM,IAAI,IAAI,KAAK;YACtB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QAEjD,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE,CAAC;YACjC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,8CAA8C;gBACpE,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;QACxC,CAAC;QAED,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,yBAAyB;QAC3F,KAAK,MAAM,IAAI,IAAI,KAAK;YACtB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,8BAAsB,CAAC;QACzD,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,GAA8C;QACtE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAyB,CAAC;QAC/C,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YACf,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3C,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;oBAC3B,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;QACD,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;YAClB,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC9C,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;oBAC9B,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED,wGAAwG;IACjG,CAAC,kBAAkB,CAAC,CAAC,EAAc;QACxC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,SAAS,CAAC,SAAS,gCAAwB,CAAC;QAChE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED,yDAAyD;IACzD,IAAY,iBAAiB,KAAK,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAElF,uGAAuG;IAChG,kBAAkB,CAAC,EAAc,EAAE,IAAY,EAAE,SAAiB;QACvE,IAAI,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,8BAA8B,IAAI,QAAQ,SAAS,QAAQ,EAAE,GAAG,CAAC,CAAC;IACtH,CAAC;IAED,kGAAkG;IAC3F,eAAe,CAAC,EAAc,EAAE,IAAY,EAAE,SAAiB;QACpE,IAAI,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,2BAA2B,IAAI,QAAQ,SAAS,QAAQ,EAAE,GAAG,CAAC,CAAC;IACnH,CAAC;CAEF;AAED,MAAM,UAAU,sBAAsB,CAAC,MAAmB;IACxD,OAAO,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;AACtC,CAAC","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\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\nimport { DbResult, Id64, Id64Arg, Id64String, IModelStatus, OpenMode } from \"@itwin/core-bentley\";\r\nimport { IModel, IModelError, LockState } from \"@itwin/core-common\";\r\nimport { LockMap } from \"../BackendHubAccess\";\r\nimport { BriefcaseDb } from \"../IModelDb\";\r\nimport { LockControl } from \"../LockControl\";\r\nimport { IModelHost } from \"../IModelHost\";\r\nimport { SQLiteDb } from \"../SQLiteDb\";\r\nimport { _close, _elementWasCreated, _hubAccess, _implementationProhibited, _nativeDb, _releaseAllLocks } from \"./Symbols\";\r\n\r\n/**\r\n * Both the Model and Parent of an element are considered \"owners\" of their member elements. That means:\r\n * 1) they must hold at least a shared lock before an exclusive lock can be acquired for their members\r\n * 2) if they hold an exclusive lock, then all of their members are exclusively locked implicitly.\r\n */\r\ninterface ElementOwners {\r\n  readonly modelId: Id64String;\r\n  readonly parentId: Id64String | undefined;\r\n}\r\n\r\n// eslint-disable-next-line no-restricted-syntax\r\nconst enum LockOrigin {\r\n  Acquired = 0,\r\n  NewElement = 1,\r\n  Discovered = 2,\r\n}\r\n\r\nexport class ServerBasedLocks implements LockControl {\r\n  public readonly [_implementationProhibited] = undefined;\r\n\r\n  public get isServerBased() { return true; }\r\n  protected readonly lockDb = new SQLiteDb();\r\n  protected readonly briefcase: BriefcaseDb;\r\n\r\n  public constructor(iModel: BriefcaseDb) {\r\n    this.briefcase = iModel;\r\n    const dbName = `${iModel[_nativeDb].getTempFileBaseName()}-locks`;\r\n    try {\r\n      this.lockDb.openDb(dbName, OpenMode.ReadWrite);\r\n    } catch {\r\n      this.lockDb.createDb(dbName);\r\n      this.lockDb.executeSQL(\"CREATE TABLE locks(id INTEGER PRIMARY KEY NOT NULL,state INTEGER NOT NULL,origin INTEGER)\");\r\n      this.lockDb.saveChanges();\r\n    }\r\n  }\r\n\r\n  public [_close]() {\r\n    if (this.lockDb.isOpen)\r\n      this.lockDb.closeDb();\r\n  }\r\n\r\n  private getOwners(id: Id64String): ElementOwners {\r\n    return this.briefcase.withPreparedSqliteStatement(\"SELECT ModelId,ParentId FROM bis_Element WHERE id=?\", (stmt) => {\r\n      stmt.bindId(1, id);\r\n      const rc = stmt.step();\r\n      if (DbResult.BE_SQLITE_ROW !== rc)\r\n        throw new IModelError(rc, `element ${id} not found`);\r\n\r\n      return { modelId: stmt.getValueId(0), parentId: stmt.getValueId(1) };\r\n    });\r\n  }\r\n\r\n  private getLockState(id?: Id64String): LockState | undefined {\r\n    return (id === undefined || !Id64.isValid(id)) ? undefined : this.lockDb.withPreparedSqliteStatement(\"SELECT state FROM locks WHERE id=?\", (stmt) => {\r\n      stmt.bindId(1, id);\r\n      return (DbResult.BE_SQLITE_ROW === stmt.step()) ? stmt.getValueInteger(0) : undefined;\r\n    });\r\n  }\r\n\r\n  /** Clear the cache of locally held locks.\r\n   * Note: does *not* release locks from server.\r\n   */\r\n  private clearAllLocks() {\r\n    this.lockDb.executeSQL(\"DELETE FROM locks\");\r\n    this.lockDb.saveChanges();\r\n  }\r\n\r\n  /** only for tests */\r\n  public getLockCount(state: LockState): number {\r\n    return this.lockDb.withSqliteStatement(\"SELECT count(*) FROM locks WHERE state=?\", (stmt) => {\r\n      stmt.bindInteger(1, state);\r\n      stmt.step();\r\n      return stmt.getValueInteger(0);\r\n    });\r\n  }\r\n\r\n  public async [_releaseAllLocks](): Promise<void> {\r\n    await IModelHost[_hubAccess].releaseAllLocks(this.briefcase); // throws if unsuccessful\r\n    this.clearAllLocks();\r\n  }\r\n\r\n  public async releaseAllLocks(): Promise<void> {\r\n    if (this.briefcase.txns.hasLocalChanges) {\r\n      throw new Error(\"Locks cannot be released while the briefcase contains local changes\");\r\n    }\r\n\r\n    return this[_releaseAllLocks]();\r\n  }\r\n\r\n  private insertLock(id: Id64String, state: LockState, origin: LockOrigin): true {\r\n    this.lockDb.withPreparedSqliteStatement(\"INSERT INTO locks(id,state,origin) VALUES (?,?,?) ON CONFLICT(id) DO UPDATE SET state=excluded.state,origin=excluded.origin\", (stmt) => {\r\n      stmt.bindId(1, id);\r\n      stmt.bindInteger(2, state);\r\n      stmt.bindInteger(3, origin);\r\n      const rc = stmt.step();\r\n      if (DbResult.BE_SQLITE_DONE !== rc)\r\n        throw new IModelError(rc, \"can't insert lock into database\");\r\n    });\r\n    return true;\r\n  }\r\n\r\n  private ownerHoldsExclusiveLock(id: Id64String | undefined): boolean {\r\n    if (id === undefined || id === IModel.rootSubjectId)\r\n      return false; // has no owners\r\n\r\n    const { modelId, parentId } = this.getOwners(id);\r\n    if (this.getLockState(modelId) === LockState.Exclusive || this.getLockState(parentId) === LockState.Exclusive)\r\n      return true;\r\n\r\n    // see if this model is exclusively locked by one of its owners. If so, save that fact on modelId so future tests won't have to descend.\r\n    if (this.ownerHoldsExclusiveLock(modelId))\r\n      return this.insertLock(modelId, LockState.Exclusive, LockOrigin.Discovered);\r\n\r\n    // see if the parent is exclusively locked by one of its owners. If so, save that fact on parentId so future tests won't have to descend.\r\n    return this.ownerHoldsExclusiveLock(parentId) ? this.insertLock(parentId!, LockState.Exclusive, LockOrigin.Discovered) : false; // eslint-disable-line @typescript-eslint/no-non-null-assertion\r\n  }\r\n\r\n  /** Determine whether an the exclusive lock is already held by an element (or one of its owners) */\r\n  public holdsExclusiveLock(id: Id64String): boolean {\r\n    // see if we hold the exclusive lock. or if one of the element's owners is exclusively locked (recursively)\r\n    return this.getLockState(id) === LockState.Exclusive || this.ownerHoldsExclusiveLock(id);\r\n  }\r\n\r\n  public holdsSharedLock(id: Id64String): boolean {\r\n    const state = this.getLockState(id);\r\n    // see if we hold shared or exclusive lock, or if an owner has exclusive lock. If so we implicitly have shared lock, but owner holding shared lock doesn't help.\r\n    return (state === LockState.Shared || state === LockState.Exclusive) || this.ownerHoldsExclusiveLock(id);\r\n  }\r\n\r\n  /** if the shared lock on the element supplied is not already held, add it to the set of shared locks required. Then, check owners. */\r\n  private addSharedLock(id: Id64String | undefined, locks: Set<Id64String>) {\r\n    // if the id is not valid, or of the lock is already in the set, or if we already hold a shared lock, we're done\r\n    // Note: if we hold a shared lock, it is guaranteed that we also hold all required shared locks on owners.\r\n    if (id === undefined || !Id64.isValid(id) || locks.has(id) || this.holdsSharedLock(id))\r\n      return;\r\n\r\n    locks.add(id); // add to set of needed shared locks\r\n    this.addOwnerSharedLocks(id, locks); // check parent models and groups\r\n  }\r\n\r\n  /** add owners (recursively) of an element to a list of required shared locks, if not already held. */\r\n  private addOwnerSharedLocks(id: Id64String, locks: Set<Id64String>) {\r\n    const el = this.getOwners(id);\r\n    this.addSharedLock(el.parentId, locks); // if this element is in a group\r\n    this.addSharedLock(el.modelId, locks); // check its model\r\n  }\r\n\r\n  /** attempt to acquire all necessary locks for a set of elements */\r\n  private async acquireAllLocks(locks: LockMap) {\r\n    if (locks.size === 0) // no locks are required.\r\n      return;\r\n\r\n    const sharedLocks = new Set<Id64String>();\r\n    for (const lock of locks)\r\n      this.addOwnerSharedLocks(lock[0], sharedLocks);\r\n\r\n    for (const shared of sharedLocks) {\r\n      if (!locks.has(shared)) // we may already be asking for exclusive lock\r\n        locks.set(shared, LockState.Shared);\r\n    }\r\n\r\n    await IModelHost[_hubAccess].acquireLocks(this.briefcase, locks); // throws if unsuccessful\r\n    for (const lock of locks)\r\n      this.insertLock(lock[0], lock[1], LockOrigin.Acquired);\r\n    this.lockDb.saveChanges();\r\n  }\r\n\r\n  public async acquireLocks(arg: { shared?: Id64Arg, exclusive?: Id64Arg }): Promise<void> {\r\n    const locks = new Map<Id64String, LockState>();\r\n    if (arg.shared) {\r\n      for (const id of Id64.iterable(arg.shared)) {\r\n        if (!this.holdsSharedLock(id))\r\n          locks.set(id, LockState.Shared);\r\n      }\r\n    }\r\n    if (arg.exclusive) {\r\n      for (const id of Id64.iterable(arg.exclusive)) {\r\n        if (!this.holdsExclusiveLock(id))\r\n          locks.set(id, LockState.Exclusive);\r\n      }\r\n    }\r\n    return this.acquireAllLocks(locks);\r\n  }\r\n\r\n  /** When an element is newly created in a session, we hold the lock on it implicitly. Save that fact. */\r\n  public [_elementWasCreated](id: Id64String) {\r\n    this.insertLock(id, LockState.Exclusive, LockOrigin.NewElement);\r\n    this.lockDb.saveChanges();\r\n  }\r\n\r\n  /** locks are not necessary during change propagation. */\r\n  private get _locksAreRequired() { return !this.briefcase.txns.isIndirectChanges; }\r\n\r\n  /** throw if locks are currently required and the exclusive lock is not held on the supplied element */\r\n  public checkExclusiveLock(id: Id64String, type: string, operation: string) {\r\n    if (this._locksAreRequired && !this.holdsExclusiveLock(id))\r\n      throw new IModelError(IModelStatus.LockNotHeld, `exclusive lock not held on ${type} for ${operation} (id=${id})`);\r\n  }\r\n\r\n  /** throw if locks are currently required and a shared lock is not held on the supplied element */\r\n  public checkSharedLock(id: Id64String, type: string, operation: string) {\r\n    if (this._locksAreRequired && !this.holdsSharedLock(id))\r\n      throw new IModelError(IModelStatus.LockNotHeld, `shared lock not held on ${type} for ${operation} (id=${id})`);\r\n  }\r\n\r\n}\r\n\r\nexport function createServerBasedLocks(iModel: BriefcaseDb): LockControl {\r\n  return new ServerBasedLocks(iModel);\r\n}\r\n"]}

package/lib/esm/internal/Symbols.d.ts

@@ -0,0 +1,19 @@
+/** @packageDocumentation
+ * @module Workspace
+ */
+export declare const _implementationProhibited: unique symbol;
+export declare const _close: unique symbol;
+export declare const _elementWasCreated: unique symbol;
+export declare const _faceProps: unique symbol;
+export declare const _getData: unique symbol;
+export declare const _key: unique symbol;
+/** @internal */
+export declare const _nativeDb: unique symbol;
+export declare const _releaseAllLocks: unique symbol;
+export declare const _verifyChannel: unique symbol;
+/** @internal */
+export declare const _hubAccess: unique symbol;
+export declare const _setHubAccess: unique symbol;
+export declare const _getHubAccess: unique symbol;
+export declare const _mockCheckpoint: unique symbol;
+//# sourceMappingURL=Symbols.d.ts.map

package/lib/esm/internal/Symbols.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Symbols.d.ts","sourceRoot":"","sources":["../../../src/internal/Symbols.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,eAAO,MAAM,yBAAyB,eAAmG,CAAC;AAM1I,eAAO,MAAM,MAAM,eAA2B,CAAC;AAC/C,eAAO,MAAM,kBAAkB,eAAuC,CAAC;AACvE,eAAO,MAAM,UAAU,eAA+B,CAAC;AACvD,eAAO,MAAM,QAAQ,eAA6B,CAAC;AACnD,eAAO,MAAM,IAAI,eAAyB,CAAC;AAC3C,gBAAgB;AAChB,eAAO,MAAM,SAAS,eAA8B,CAAC;AACrD,eAAO,MAAM,gBAAgB,eAAqC,CAAC;AACnE,eAAO,MAAM,cAAc,eAAmC,CAAC;AAC/D,gBAAgB;AAChB,eAAO,MAAM,UAAU,eAA+B,CAAC;AACvD,eAAO,MAAM,aAAa,eAAkC,CAAC;AAC7D,eAAO,MAAM,aAAa,eAAkC,CAAC;AAC7D,eAAO,MAAM,eAAe,eAAoC,CAAC"}

package/lib/esm/internal/Symbols.js

@@ -0,0 +1,26 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Workspace
+ */
+export const _implementationProhibited = Symbol.for("Implementations of this interface can only be obtained from the containing package");
+function sym(name) {
+    return `${name}_core-backend_INTERNAL_ONLY_DO_NOT_USE`;
+}
+export const _close = Symbol.for(sym("close"));
+export const _elementWasCreated = Symbol.for(sym("elementWasCreated"));
+export const _faceProps = Symbol.for(sym("faceProps"));
+export const _getData = Symbol.for(sym("getData"));
+export const _key = Symbol.for(sym("key"));
+/** @internal */
+export const _nativeDb = Symbol.for(sym("nativeDb"));
+export const _releaseAllLocks = Symbol.for(sym("releaseAllLocks"));
+export const _verifyChannel = Symbol.for(sym("verifyChannel"));
+/** @internal */
+export const _hubAccess = Symbol.for(sym("hubAccess"));
+export const _setHubAccess = Symbol.for(sym("setHubAccess"));
+export const _getHubAccess = Symbol.for(sym("getHubAccess"));
+export const _mockCheckpoint = Symbol.for(sym("mockCheckpoint"));
+//# sourceMappingURL=Symbols.js.map

package/lib/esm/internal/Symbols.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Symbols.js","sourceRoot":"","sources":["../../../src/internal/Symbols.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC,GAAG,CAAC,oFAAoF,CAAC,CAAC;AAE1I,SAAS,GAAG,CAAC,IAAY;IACvB,OAAO,GAAG,IAAI,wCAAwC,CAAC;AACzD,CAAC;AAED,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;AAC/C,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC;AACvE,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;AACvD,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;AACnD,MAAM,CAAC,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;AAC3C,gBAAgB;AAChB,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;AACrD,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC;AACnE,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC;AAC/D,gBAAgB;AAChB,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;AACvD,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;AAC7D,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;AAC7D,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC","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 Workspace\r\n */\r\n\r\nexport const _implementationProhibited = Symbol.for(\"Implementations of this interface can only be obtained from the containing package\");\r\n\r\nfunction sym(name: string): string {\r\n  return `${name}_core-backend_INTERNAL_ONLY_DO_NOT_USE`;\r\n}\r\n\r\nexport const _close = Symbol.for(sym(\"close\"));\r\nexport const _elementWasCreated = Symbol.for(sym(\"elementWasCreated\"));\r\nexport const _faceProps = Symbol.for(sym(\"faceProps\"));\r\nexport const _getData = Symbol.for(sym(\"getData\"));\r\nexport const _key = Symbol.for(sym(\"key\"));\r\n/** @internal */\r\nexport const _nativeDb = Symbol.for(sym(\"nativeDb\"));\r\nexport const _releaseAllLocks = Symbol.for(sym(\"releaseAllLocks\"));\r\nexport const _verifyChannel = Symbol.for(sym(\"verifyChannel\"));\r\n/** @internal */\r\nexport const _hubAccess = Symbol.for(sym(\"hubAccess\"));\r\nexport const _setHubAccess = Symbol.for(sym(\"setHubAccess\"));\r\nexport const _getHubAccess = Symbol.for(sym(\"getHubAccess\"));\r\nexport const _mockCheckpoint = Symbol.for(sym(\"mockCheckpoint\"));\r\n"]}

package/lib/esm/internal/cross-package.d.ts

@@ -0,0 +1,4 @@
+export { IModelJsNative, NativeCloudSqlite, NativeLoggerCategory } from "@bentley/imodeljs-native";
+export { IModelNative } from "./NativePlatform";
+export { _nativeDb, } from "./Symbols";
+//# sourceMappingURL=cross-package.d.ts.map

package/lib/esm/internal/cross-package.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cross-package.d.ts","sourceRoot":"","sources":["../../../src/internal/cross-package.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AACnG,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EACL,SAAS,GACV,MAAM,WAAW,CAAC"}

package/lib/esm/internal/cross-package.js

@@ -0,0 +1,8 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+export { IModelJsNative, NativeCloudSqlite, NativeLoggerCategory } from "@bentley/imodeljs-native";
+export { IModelNative } from "./NativePlatform";
+export { _nativeDb, } from "./Symbols";
+//# sourceMappingURL=cross-package.js.map

package/lib/esm/internal/cross-package.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cross-package.js","sourceRoot":"","sources":["../../../src/internal/cross-package.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AACnG,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EACL,SAAS,GACV,MAAM,WAAW,CAAC","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\nexport { IModelJsNative, NativeCloudSqlite, NativeLoggerCategory } from \"@bentley/imodeljs-native\";\r\nexport { IModelNative } from \"./NativePlatform\";\r\nexport {\r\n  _nativeDb,\r\n} from \"./Symbols\";\r\n"]}

package/lib/esm/internal/workspace/SettingsImpl.d.ts

@@ -0,0 +1,43 @@
+/** @packageDocumentation
+ * @module Workspace
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { LocalDirName, LocalFileName } from "@itwin/core-common";
+import { Setting, SettingName, Settings, SettingsContainer, SettingsDictionary, SettingsDictionaryProps, SettingsDictionarySource, SettingsPriority } from "../../workspace/Settings";
+import { _implementationProhibited } from "../Symbols";
+/**
+ * Internal implementation of Settings interface.
+ * @internal
+ */
+export declare class SettingsImpl implements Settings {
+    readonly [_implementationProhibited]: undefined;
+    dictionaries: SettingsDictionary[];
+    protected verifyPriority(_priority: SettingsPriority): void;
+    close(): void;
+    readonly onSettingsChanged: BeEvent<() => void>;
+    addFile(fileName: LocalFileName, priority: SettingsPriority): void;
+    addDirectory(dirName: LocalDirName, priority: SettingsPriority): void;
+    addJson(props: SettingsDictionaryProps, settingsJson: string): void;
+    addDictionary(props: SettingsDictionaryProps, settings: SettingsContainer): void;
+    getDictionary(source: SettingsDictionarySource): SettingsDictionary | undefined;
+    dropDictionary(source: SettingsDictionarySource, raiseEvent?: boolean): boolean;
+    getSettingEntries<T extends Setting>(settingName: SettingName): Iterable<{
+        value: T;
+        dictionary: SettingsDictionary;
+    }>;
+    getSettingValues<T extends Setting>(settingName: SettingName): Iterable<T>;
+    getSetting<T extends Setting>(settingName: SettingName, defaultValue?: T): T | undefined;
+    private getResult;
+    getString(name: SettingName, defaultValue: string): string;
+    getString(name: SettingName): string | undefined;
+    getBoolean(name: SettingName, defaultValue: boolean): boolean;
+    getBoolean(name: SettingName): boolean | undefined;
+    getNumber(name: SettingName, defaultValue: number): number;
+    getNumber(name: SettingName): number | undefined;
+    getObject<T extends object>(name: SettingName, defaultValue: T): T;
+    getObject<T extends object>(name: SettingName): T | undefined;
+    getArray<T extends Setting>(name: SettingName, defaultValue: T[]): T[];
+    getArray<T extends Setting>(name: SettingName): T[] | undefined;
+    private getCombinedArray;
+}
+//# sourceMappingURL=SettingsImpl.d.ts.map

package/lib/esm/internal/workspace/SettingsImpl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SettingsImpl.d.ts","sourceRoot":"","sources":["../../../../src/internal/workspace/SettingsImpl.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEjE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAEtL,OAAO,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAsBvD;;;GAGG;AACH,qBAAa,YAAa,YAAW,QAAQ;IAC3C,SAAgB,CAAC,yBAAyB,CAAC,YAAa;IACjD,YAAY,EAAE,kBAAkB,EAAE,CAAM;IAC/C,SAAS,CAAC,cAAc,CAAC,SAAS,EAAE,gBAAgB;IAC7C,KAAK;IACZ,SAAgB,iBAAiB,gBAAqB,IAAI,EAAI;IAEvD,OAAO,CAAC,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,gBAAgB;IAI3D,YAAY,CAAC,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,gBAAgB;IAQ9D,OAAO,CAAC,KAAK,EAAE,uBAAuB,EAAE,YAAY,EAAE,MAAM;IAI5D,aAAa,CAAC,KAAK,EAAE,uBAAuB,EAAE,QAAQ,EAAE,iBAAiB;IAiBzE,aAAa,CAAC,MAAM,EAAE,wBAAwB,GAAG,kBAAkB,GAAG,SAAS;IAQ/E,cAAc,CAAC,MAAM,EAAE,wBAAwB,EAAE,UAAU,UAAO;IAYhE,iBAAiB,CAAC,CAAC,SAAS,OAAO,EAAE,WAAW,EAAE,WAAW,GAAG,QAAQ,CAAC;QAAE,KAAK,EAAE,CAAC,CAAC;QAAC,UAAU,EAAE,kBAAkB,CAAA;KAAC,CAAC;IASrH,gBAAgB,CAAC,CAAC,SAAS,OAAO,EAAE,WAAW,EAAE,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC;IAM5E,UAAU,CAAC,CAAC,SAAS,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAS/F,OAAO,CAAC,SAAS;IAMV,SAAS,CAAC,IAAI,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM;IAC1D,SAAS,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS;IAIhD,UAAU,CAAC,IAAI,EAAE,WAAW,EAAE,YAAY,EAAE,OAAO,GAAG,OAAO;IAC7D,UAAU,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,GAAG,SAAS;IAIlD,SAAS,CAAC,IAAI,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM;IAC1D,SAAS,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS;IAIhD,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC;IAClE,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,CAAC,GAAG,SAAS;IAK7D,QAAQ,CAAC,CAAC,SAAS,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE;IACtE,QAAQ,CAAC,CAAC,SAAS,OAAO,EAAE,IAAI,EAAE,WAAW,GAAG,CAAC,EAAE,GAAG,SAAS;IActE,OAAO,CAAC,gBAAgB;CAgBzB"}

package/lib/esm/internal/workspace/SettingsImpl.js

@@ -0,0 +1,154 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Workspace
+ */
+import * as fs from "fs-extra";
+import { parse } from "json5";
+import { extname, join } from "path";
+import { BeEvent } from "@itwin/core-bentley";
+import { IModelJsFs } from "../../IModelJsFs";
+import { Setting } from "../../workspace/Settings";
+import { IModelHost } from "../../IModelHost";
+import { _implementationProhibited } from "../Symbols";
+const dictionaryMatches = (d1, d2) => {
+    return (d1.workspaceDb === d2.workspaceDb) && (d1.name === d2.name);
+};
+class SettingsDictionaryImpl {
+    [_implementationProhibited] = undefined;
+    props;
+    settings;
+    constructor(props, settings) {
+        this.props = { ...props }; // make a copy so it can't be changed by caller
+        this.settings = settings;
+    }
+    getSetting(settingName) {
+        const value = this.settings[settingName];
+        return undefined !== value ? Setting.clone(value) : undefined;
+    }
+}
+/**
+ * Internal implementation of Settings interface.
+ * @internal
+ */
+export class SettingsImpl {
+    [_implementationProhibited] = undefined;
+    dictionaries = [];
+    verifyPriority(_priority) { }
+    close() { }
+    onSettingsChanged = new BeEvent();
+    addFile(fileName, priority) {
+        this.addJson({ name: fileName, priority }, fs.readFileSync(fileName, "utf-8"));
+    }
+    addDirectory(dirName, priority) {
+        for (const fileName of IModelJsFs.readdirSync(dirName)) {
+            const ext = extname(fileName);
+            if (ext === ".json5" || ext === ".json")
+                this.addFile(join(dirName, fileName), priority);
+        }
+    }
+    addJson(props, settingsJson) {
+        this.addDictionary(props, parse(settingsJson));
+    }
+    addDictionary(props, settings) {
+        this.verifyPriority(props.priority);
+        this.dropDictionary(props, false); // make sure we don't have the same dictionary twice
+        const dict = new SettingsDictionaryImpl(props, settings);
+        const doAdd = () => {
+            for (let i = 0; i < this.dictionaries.length; ++i) {
+                if (this.dictionaries[i].props.priority <= dict.props.priority) {
+                    this.dictionaries.splice(i, 0, dict);
+                    return;
+                }
+            }
+            this.dictionaries.push(dict);
+        };
+        doAdd();
+        this.onSettingsChanged.raiseEvent();
+    }
+    getDictionary(source) {
+        for (const dictionary of this.dictionaries) {
+            if (dictionaryMatches(dictionary.props, source))
+                return dictionary;
+        }
+        return undefined;
+    }
+    dropDictionary(source, raiseEvent = true) {
+        for (let i = 0; i < this.dictionaries.length; ++i) {
+            if (dictionaryMatches(this.dictionaries[i].props, source)) {
+                this.dictionaries.splice(i, 1);
+                if (raiseEvent)
+                    this.onSettingsChanged.raiseEvent();
+                return true;
+            }
+        }
+        return false;
+    }
+    *getSettingEntries(settingName) {
+        for (const dictionary of this.dictionaries) {
+            const value = dictionary.getSetting(settingName);
+            if (undefined !== value) {
+                yield { value, dictionary };
+            }
+        }
+    }
+    *getSettingValues(settingName) {
+        for (const entry of this.getSettingEntries(settingName)) {
+            yield entry.value;
+        }
+    }
+    getSetting(settingName, defaultValue) {
+        for (const value of this.getSettingValues(settingName)) {
+            return value;
+        }
+        return defaultValue;
+    }
+    // get the setting and verify the result is either undefined or the correct type. If so, return it. Otherwise throw an exception.
+    getResult(name, expectedType) {
+        const out = this.getSetting(name);
+        if (out === undefined || typeof out === expectedType)
+            return out;
+        throw new Error(`setting "${name}" is not a ${expectedType}: ${typeof out}`);
+    }
+    getString(name, defaultValue) {
+        return this.getResult(name, "string") ?? defaultValue;
+    }
+    getBoolean(name, defaultValue) {
+        return this.getResult(name, "boolean") ?? defaultValue;
+    }
+    getNumber(name, defaultValue) {
+        return this.getResult(name, "number") ?? defaultValue;
+    }
+    getObject(name, defaultValue) {
+        const out = this.getResult(name, "object");
+        return out ? IModelHost.settingsSchemas.validateSetting(out, name) : defaultValue;
+    }
+    getArray(name, defaultValue) {
+        if (IModelHost.settingsSchemas.settingDefs.get(name)?.combineArray) {
+            return this.getCombinedArray(name, defaultValue);
+        }
+        const out = this.getSetting(name);
+        if (out === undefined)
+            return defaultValue;
+        if (!Array.isArray(out))
+            throw new Error(`setting ${name} is not an array: ${out}`);
+        return IModelHost.settingsSchemas.validateSetting(out, name);
+    }
+    getCombinedArray(name, defaultValue) {
+        let foundSetting = false;
+        const out = [];
+        for (const array of this.getSettingValues(name)) {
+            foundSetting = true;
+            IModelHost.settingsSchemas.validateSetting(array, name);
+            for (const value of array) {
+                if (undefined === out.find((x) => Setting.areEqual(x, value))) {
+                    out.push(value);
+                }
+            }
+        }
+        return foundSetting ? out : defaultValue;
+    }
+}
+//# sourceMappingURL=SettingsImpl.js.map

package/lib/esm/internal/workspace/SettingsImpl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SettingsImpl.js","sourceRoot":"","sources":["../../../../src/internal/workspace/SettingsImpl.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACrC,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAqI,MAAM,0BAA0B,CAAC;AACtL,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAEvD,MAAM,iBAAiB,GAAG,CAAC,EAA4B,EAAE,EAA4B,EAAW,EAAE;IAChG,OAAO,CAAC,EAAE,CAAC,WAAW,KAAK,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,IAAI,CAAC,CAAC;AACtE,CAAC,CAAC;AAEF,MAAM,sBAAsB;IACV,CAAC,yBAAyB,CAAC,GAAG,SAAS,CAAC;IACxC,KAAK,CAA0B;IAC/B,QAAQ,CAAoB;IAE5C,YAAmB,KAA8B,EAAE,QAA2B;QAC5E,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC,+CAA+C;QAC1E,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAEM,UAAU,CAAoB,WAAmB;QACtD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAkB,CAAC;QAC1D,OAAO,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAChE,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,YAAY;IACP,CAAC,yBAAyB,CAAC,GAAG,SAAS,CAAC;IACjD,YAAY,GAAyB,EAAE,CAAC;IACrC,cAAc,CAAC,SAA2B,IAAI,CAAC;IAClD,KAAK,KAAK,CAAC;IACF,iBAAiB,GAAG,IAAI,OAAO,EAAc,CAAC;IAEvD,OAAO,CAAC,QAAuB,EAAE,QAA0B;QAChE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IACjF,CAAC;IAEM,YAAY,CAAC,OAAqB,EAAE,QAA0B;QACnE,KAAK,MAAM,QAAQ,IAAI,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;YACvD,MAAM,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC9B,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,OAAO;gBACrC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAEM,OAAO,CAAC,KAA8B,EAAE,YAAoB;QACjE,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IACjD,CAAC;IAEM,aAAa,CAAC,KAA8B,EAAE,QAA2B;QAC9E,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,oDAAoD;QACvF,MAAM,IAAI,GAAG,IAAI,sBAAsB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACzD,MAAM,KAAK,GAAG,GAAG,EAAE;YACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;gBAClD,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;oBAC/D,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;oBACrC,OAAO;gBACT,CAAC;YACH,CAAC;YACD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC,CAAC;QACF,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;IACtC,CAAC;IAEM,aAAa,CAAC,MAAgC;QACnD,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YAC3C,IAAI,iBAAiB,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC;gBAC7C,OAAO,UAAU,CAAC;QACtB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,cAAc,CAAC,MAAgC,EAAE,UAAU,GAAG,IAAI;QACvE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YAClD,IAAI,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;gBAC1D,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC/B,IAAI,UAAU;oBACZ,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;gBACtC,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,CAAE,iBAAiB,CAAoB,WAAwB;QACpE,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YAC3C,MAAM,KAAK,GAAG,UAAU,CAAC,UAAU,CAAI,WAAW,CAAC,CAAC;YACpD,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;gBACxB,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;YAC9B,CAAC;QACH,CAAC;IACH,CAAC;IAEM,CAAE,gBAAgB,CAAoB,WAAwB;QACnE,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,iBAAiB,CAAI,WAAW,CAAC,EAAE,CAAC;YAC3D,MAAM,KAAK,CAAC,KAAK,CAAC;QACpB,CAAC;IACH,CAAC;IAEM,UAAU,CAAoB,WAAwB,EAAE,YAAgB;QAC7E,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,gBAAgB,CAAI,WAAW,CAAC,EAAE,CAAC;YAC1D,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,iIAAiI;IACzH,SAAS,CAAoB,IAAiB,EAAE,YAAoB;QAC1E,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAI,IAAI,CAAC,CAAC;QACrC,IAAI,GAAG,KAAK,SAAS,IAAI,OAAO,GAAG,KAAK,YAAY;YAClD,OAAO,GAAG,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,cAAc,YAAY,KAAK,OAAO,GAAG,EAAE,CAAC,CAAC;IAC/E,CAAC;IAGM,SAAS,CAAC,IAAiB,EAAE,YAAqB;QACvD,OAAO,IAAI,CAAC,SAAS,CAAS,IAAI,EAAE,QAAQ,CAAC,IAAI,YAAY,CAAC;IAChE,CAAC;IAGM,UAAU,CAAC,IAAiB,EAAE,YAAsB;QACzD,OAAO,IAAI,CAAC,SAAS,CAAU,IAAI,EAAE,SAAS,CAAC,IAAI,YAAY,CAAC;IAClE,CAAC;IAGM,SAAS,CAAC,IAAiB,EAAE,YAAqB;QACvD,OAAO,IAAI,CAAC,SAAS,CAAS,IAAI,EAAE,QAAQ,CAAC,IAAI,YAAY,CAAC;IAChE,CAAC;IAGM,SAAS,CAAmB,IAAiB,EAAE,YAAgB;QACpE,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAI,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC9C,OAAO,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,eAAe,CAAC,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;IACpF,CAAC;IAGM,QAAQ,CAAoB,IAAiB,EAAE,YAAkB;QACtE,IAAI,UAAU,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,CAAC;YACnE,OAAO,IAAI,CAAC,gBAAgB,CAAI,IAAI,EAAE,YAAY,CAAC,CAAC;QACtD,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAM,IAAI,CAAC,CAAC;QACvC,IAAI,GAAG,KAAK,SAAS;YACnB,OAAO,YAAY,CAAC;QACtB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,WAAW,IAAI,qBAAqB,GAAG,EAAE,CAAC,CAAC;QAC7D,OAAO,UAAU,CAAC,eAAe,CAAC,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC/D,CAAC;IAEO,gBAAgB,CAAoB,IAAiB,EAAE,YAAkB;QAC/E,IAAI,YAAY,GAAG,KAAK,CAAC;QACzB,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,gBAAgB,CAAM,IAAI,CAAC,EAAE,CAAC;YACrD,YAAY,GAAG,IAAI,CAAC;YAEpB,UAAU,CAAC,eAAe,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YACxD,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;gBAC1B,IAAI,SAAS,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;oBAC9D,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAClB,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IAC3C,CAAC;CACF","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 Workspace\r\n */\r\n\r\nimport * as fs from \"fs-extra\";\r\nimport { parse } from \"json5\";\r\nimport { extname, join } from \"path\";\r\nimport { BeEvent } from \"@itwin/core-bentley\";\r\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\r\nimport { IModelJsFs } from \"../../IModelJsFs\";\r\nimport { Setting, SettingName, Settings, SettingsContainer, SettingsDictionary, SettingsDictionaryProps, SettingsDictionarySource, SettingsPriority } from \"../../workspace/Settings\";\r\nimport { IModelHost } from \"../../IModelHost\";\r\nimport { _implementationProhibited } from \"../Symbols\";\r\n\r\nconst dictionaryMatches = (d1: SettingsDictionarySource, d2: SettingsDictionarySource): boolean => {\r\n  return (d1.workspaceDb === d2.workspaceDb) && (d1.name === d2.name);\r\n};\r\n\r\nclass SettingsDictionaryImpl implements SettingsDictionary {\r\n  public readonly [_implementationProhibited] = undefined;\r\n  public readonly props: SettingsDictionaryProps;\r\n  public readonly settings: SettingsContainer;\r\n\r\n  public constructor(props: SettingsDictionaryProps, settings: SettingsContainer) {\r\n    this.props = { ...props }; // make a copy so it can't be changed by caller\r\n    this.settings = settings;\r\n  }\r\n\r\n  public getSetting<T extends Setting>(settingName: string): T | undefined {\r\n    const value = this.settings[settingName] as T | undefined;\r\n    return undefined !== value ? Setting.clone(value) : undefined;\r\n  }\r\n}\r\n\r\n/**\r\n * Internal implementation of Settings interface.\r\n * @internal\r\n */\r\nexport class SettingsImpl implements Settings {\r\n  public readonly [_implementationProhibited] = undefined;\r\n  public dictionaries: SettingsDictionary[] = [];\r\n  protected verifyPriority(_priority: SettingsPriority) { }\r\n  public close() { }\r\n  public readonly onSettingsChanged = new BeEvent<() => void>();\r\n\r\n  public addFile(fileName: LocalFileName, priority: SettingsPriority) {\r\n    this.addJson({ name: fileName, priority }, fs.readFileSync(fileName, \"utf-8\"));\r\n  }\r\n\r\n  public addDirectory(dirName: LocalDirName, priority: SettingsPriority) {\r\n    for (const fileName of IModelJsFs.readdirSync(dirName)) {\r\n      const ext = extname(fileName);\r\n      if (ext === \".json5\" || ext === \".json\")\r\n        this.addFile(join(dirName, fileName), priority);\r\n    }\r\n  }\r\n\r\n  public addJson(props: SettingsDictionaryProps, settingsJson: string) {\r\n    this.addDictionary(props, parse(settingsJson));\r\n  }\r\n\r\n  public addDictionary(props: SettingsDictionaryProps, settings: SettingsContainer) {\r\n    this.verifyPriority(props.priority);\r\n    this.dropDictionary(props, false); // make sure we don't have the same dictionary twice\r\n    const dict = new SettingsDictionaryImpl(props, settings);\r\n    const doAdd = () => {\r\n      for (let i = 0; i < this.dictionaries.length; ++i) {\r\n        if (this.dictionaries[i].props.priority <= dict.props.priority) {\r\n          this.dictionaries.splice(i, 0, dict);\r\n          return;\r\n        }\r\n      }\r\n      this.dictionaries.push(dict);\r\n    };\r\n    doAdd();\r\n    this.onSettingsChanged.raiseEvent();\r\n  }\r\n\r\n  public getDictionary(source: SettingsDictionarySource): SettingsDictionary | undefined {\r\n    for (const dictionary of this.dictionaries) {\r\n      if (dictionaryMatches(dictionary.props, source))\r\n        return dictionary;\r\n    }\r\n    return undefined;\r\n  }\r\n\r\n  public dropDictionary(source: SettingsDictionarySource, raiseEvent = true) {\r\n    for (let i = 0; i < this.dictionaries.length; ++i) {\r\n      if (dictionaryMatches(this.dictionaries[i].props, source)) {\r\n        this.dictionaries.splice(i, 1);\r\n        if (raiseEvent)\r\n          this.onSettingsChanged.raiseEvent();\r\n        return true;\r\n      }\r\n    }\r\n    return false;\r\n  }\r\n\r\n  public * getSettingEntries<T extends Setting>(settingName: SettingName): Iterable<{ value: T, dictionary: SettingsDictionary}> {\r\n    for (const dictionary of this.dictionaries) {\r\n      const value = dictionary.getSetting<T>(settingName);\r\n      if (undefined !== value) {\r\n        yield { value, dictionary };\r\n      }\r\n    }\r\n  }\r\n\r\n  public * getSettingValues<T extends Setting>(settingName: SettingName): Iterable<T> {\r\n    for (const entry of this.getSettingEntries<T>(settingName)) {\r\n      yield entry.value;\r\n    }\r\n  }\r\n\r\n  public getSetting<T extends Setting>(settingName: SettingName, defaultValue?: T): T | undefined {\r\n    for (const value of this.getSettingValues<T>(settingName)) {\r\n      return value;\r\n    }\r\n\r\n    return defaultValue;\r\n  }\r\n\r\n  // get the setting and verify the result is either undefined or the correct type. If so, return it. Otherwise throw an exception.\r\n  private getResult<T extends Setting>(name: SettingName, expectedType: string) {\r\n    const out = this.getSetting<T>(name);\r\n    if (out === undefined || typeof out === expectedType)\r\n      return out;\r\n    throw new Error(`setting \"${name}\" is not a ${expectedType}: ${typeof out}`);\r\n  }\r\n  public getString(name: SettingName, defaultValue: string): string;\r\n  public getString(name: SettingName): string | undefined;\r\n  public getString(name: SettingName, defaultValue?: string): string | undefined {\r\n    return this.getResult<string>(name, \"string\") ?? defaultValue;\r\n  }\r\n  public getBoolean(name: SettingName, defaultValue: boolean): boolean;\r\n  public getBoolean(name: SettingName): boolean | undefined;\r\n  public getBoolean(name: SettingName, defaultValue?: boolean): boolean | undefined {\r\n    return this.getResult<boolean>(name, \"boolean\") ?? defaultValue;\r\n  }\r\n  public getNumber(name: SettingName, defaultValue: number): number;\r\n  public getNumber(name: SettingName): number | undefined;\r\n  public getNumber(name: SettingName, defaultValue?: number): number | undefined {\r\n    return this.getResult<number>(name, \"number\") ?? defaultValue;\r\n  }\r\n  public getObject<T extends object>(name: SettingName, defaultValue: T): T;\r\n  public getObject<T extends object>(name: SettingName): T | undefined;\r\n  public getObject<T extends object>(name: SettingName, defaultValue?: T): T | undefined {\r\n    const out = this.getResult<T>(name, \"object\");\r\n    return out ? IModelHost.settingsSchemas.validateSetting(out, name) : defaultValue;\r\n  }\r\n  public getArray<T extends Setting>(name: SettingName, defaultValue: T[]): T[];\r\n  public getArray<T extends Setting>(name: SettingName): T[] | undefined;\r\n  public getArray<T extends Setting>(name: SettingName, defaultValue?: T[]): T[] | undefined {\r\n    if (IModelHost.settingsSchemas.settingDefs.get(name)?.combineArray) {\r\n      return this.getCombinedArray<T>(name, defaultValue);\r\n    }\r\n\r\n    const out = this.getSetting<T[]>(name);\r\n    if (out === undefined)\r\n      return defaultValue;\r\n    if (!Array.isArray(out))\r\n      throw new Error(`setting ${name} is not an array: ${out}`);\r\n    return IModelHost.settingsSchemas.validateSetting(out, name);\r\n  }\r\n\r\n  private getCombinedArray<T extends Setting>(name: SettingName, defaultValue?: T[]): T[] | undefined {\r\n    let foundSetting = false;\r\n    const out: T[] = [];\r\n    for (const array of this.getSettingValues<T[]>(name)) {\r\n      foundSetting = true;\r\n\r\n      IModelHost.settingsSchemas.validateSetting(array, name);\r\n      for (const value of array) {\r\n        if (undefined === out.find((x) => Setting.areEqual(x, value))) {\r\n          out.push(value);\r\n        }\r\n      }\r\n    }\r\n\r\n    return foundSetting ? out : defaultValue;\r\n  }\r\n}\r\n"]}

package/lib/esm/internal/workspace/SettingsSchemasImpl.d.ts

@@ -0,0 +1,6 @@
+/** @packageDocumentation
+ * @module Workspace
+ */
+import { SettingsSchemas } from "../../workspace/SettingsSchemas";
+export declare function constructSettingsSchemas(): SettingsSchemas;
+//# sourceMappingURL=SettingsSchemasImpl.d.ts.map

package/lib/esm/internal/workspace/SettingsSchemasImpl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SettingsSchemasImpl.d.ts","sourceRoot":"","sources":["../../../../src/internal/workspace/SettingsSchemasImpl.ts"],"names":[],"mappings":"AAIA;;GAEG;AAQH,OAAO,EAAqC,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAyRrG,wBAAgB,wBAAwB,IAAI,eAAe,CAE1D"}