@itwin/core-backend 5.0.0-dev.105 → 5.0.0-dev.109

package/lib/cjs/CatalogDb.d.ts

@@ -0,0 +1,103 @@
+/** @packageDocumentation
+ * @module iModels
+ */
+import { type CatalogIModel, IModelConnectionProps } from "@itwin/core-common";
+import { IpcHandler } from "./IpcHost";
+import { StandaloneDb } from "./IModelDb";
+/** A [[StandaloneDb]] that provides read-only access to the contents of a [CatalogIModel]($common).
+ * @see [[CatalogDb.openReadonly]] to instantiate this type.
+ * @beta
+ */
+export interface CatalogDb extends StandaloneDb {
+    /** Get the catalog's manifest. */
+    getManifest(): CatalogIModel.Manifest | undefined;
+    /** Get the catalog's version information. */
+    getVersion(): string;
+    /** Get the catalog's manifest and version. */
+    getInfo(): {
+        manifest?: CatalogIModel.Manifest;
+        version: string;
+    };
+    /** Returns true if the catalog was opened in read-write mode. */
+    isEditable(): this is EditableCatalogDb;
+}
+/** A writable [[CatalogDb]].
+ * @see [[CatalogDb.openEditable]] to instantiate this type.
+ * @beta
+ */
+export interface EditableCatalogDb extends CatalogDb {
+    /** Update the contents of the catalog manifest.  */
+    updateCatalogManifest(manifest: CatalogIModel.Manifest): void;
+}
+/** @beta */
+export declare namespace CatalogDb {
+    /** Create a new [[BlobContainer]] to hold versions of a [[CatalogDb]].
+     * @returns The properties of the newly created container.
+     * @note creating new containers requires "admin" authorization.
+    */
+    function createNewContainer(args: CatalogIModel.CreateNewContainerArgs): Promise<CatalogIModel.NewContainerProps>;
+    /** Acquire the write lock for a [CatalogIModel]($common) container. Only one person may obtain the write lock at a time.
+     * You must obtain the lock before attempting to write to the container via functions like [[CatalogDb.openEditable]] and [[CatalogDb.createNewVersion]].
+     * @note This requires "write" authorization to the container
+     */
+    function acquireWriteLock(args: {
+        /** The id of the container */
+        containerId: string;
+        /**
+         * The name of the individual acquiring the lock. This will be shown to others who attempt to acquire the lock while it is held.
+         * It is also stored in the "lastEditedBy" field of the manifest of any new version edited while the lock is held.
+         */
+        username: string;
+    }): Promise<void>;
+    /** Release the write lock on a [CatalogIModel]($common) container. This uploads all changes made while the lock is held, so they become visible to other users. */
+    function releaseWriteLock(args: {
+        /** The id of the container */
+        containerId: string;
+        /** If true, abandon all local changes before releasing the lock */
+        abandon?: true;
+    }): Promise<void>;
+    /** Open an [[EditableCatalogDb]] for write access.
+     * @note Once a version of a catalog iModel has been published (i.e. the write lock has been released), it is no longer editable, *unless* it is a prerelease version.
+     * @note The write lock must be held for this operation to succeed
+     */
+    function openEditable(args: CatalogIModel.OpenArgs): Promise<EditableCatalogDb>;
+    /** Open a [[CatalogDb]] for read-only access. */
+    function openReadonly(args: CatalogIModel.OpenArgs): Promise<CatalogDb>;
+    /**
+     * Create a new version of a [CatalogIModel]($common) as a copy of an existing version. Immediately after this operation, the new version will be an exact copy
+     * of the source CatalogIModel. Then, use [[CatalogDb.openEditable]] to modify the new version with new content.
+     * @note The write lock must be held for this operation to succeed
+     */
+    function createNewVersion(args: CatalogIModel.CreateNewVersionArgs): Promise<{
+        oldDb: CatalogIModel.NameAndVersion;
+        newDb: CatalogIModel.NameAndVersion;
+    }>;
+}
+/**
+ * Handler for Ipc access to CatalogIModels. Registered by NativeHost.
+ * @internal
+ */
+export declare class CatalogIModelHandler extends IpcHandler implements CatalogIModel.IpcMethods {
+    get channelName(): CatalogIModel.IpcChannel;
+    createNewContainer(args: CatalogIModel.CreateNewContainerArgs): Promise<CatalogIModel.NewContainerProps>;
+    acquireWriteLock(args: {
+        containerId: string;
+        username: string;
+    }): Promise<void>;
+    releaseWriteLock(args: {
+        containerId: string;
+        abandon?: true;
+    }): Promise<void>;
+    openReadonly(args: CatalogIModel.OpenArgs): Promise<IModelConnectionProps>;
+    openEditable(args: CatalogIModel.OpenArgs): Promise<IModelConnectionProps>;
+    createNewVersion(args: CatalogIModel.CreateNewVersionArgs): Promise<{
+        oldDb: CatalogIModel.NameAndVersion;
+        newDb: CatalogIModel.NameAndVersion;
+    }>;
+    getInfo(key: string): Promise<{
+        manifest?: CatalogIModel.Manifest;
+        version: string;
+    }>;
+    updateCatalogManifest(key: string, manifest: CatalogIModel.Manifest): Promise<void>;
+}
+//# sourceMappingURL=CatalogDb.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CatalogDb.d.ts","sourceRoot":"","sources":["../../src/CatalogDb.ts"],"names":[],"mappings":"AAIA;;GAEG;AAMH,OAAO,EAAkC,KAAK,aAAa,EAAoB,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AACjI,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAkE1C;;;GAGG;AACH,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC7C,kCAAkC;IAClC,WAAW,IAAI,aAAa,CAAC,QAAQ,GAAG,SAAS,CAAC;IAClD,6CAA6C;IAC7C,UAAU,IAAI,MAAM,CAAC;IACrB,8CAA8C;IAC9C,OAAO,IAAI;QAAE,QAAQ,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAClE,iEAAiE;IACjE,UAAU,IAAI,IAAI,IAAI,iBAAiB,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,SAAS;IAClD,oDAAoD;IACpD,qBAAqB,CAAC,QAAQ,EAAE,aAAa,CAAC,QAAQ,GAAG,IAAI,CAAC;CAC/D;AA6DD,YAAY;AACZ,yBAAiB,SAAS,CAAC;IACzB;;;MAGE;IACF,SAAsB,kBAAkB,CAAC,IAAI,EAAE,aAAa,CAAC,sBAAsB,GAAG,OAAO,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAgD7H;IAED;;;OAGG;IACH,SAAsB,gBAAgB,CAAC,IAAI,EAAE;QAC3C,8BAA8B;QAC9B,WAAW,EAAE,MAAM,CAAC;QACpB;;;WAGG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC,IAAI,CAAC,CAGhB;IAED,mKAAmK;IACnK,SAAsB,gBAAgB,CAAC,IAAI,EAAE;QAC3C,8BAA8B;QAC9B,WAAW,EAAE,MAAM,CAAC;QACpB,mEAAmE;QACnE,OAAO,CAAC,EAAE,IAAI,CAAA;KACf,GAAG,OAAO,CAAC,IAAI,CAAC,CAKhB;IAED;;;OAGG;IACH,SAAsB,YAAY,CAAC,IAAI,EAAE,aAAa,CAAC,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAiB3F;IAED,iDAAiD;IACjD,SAAsB,YAAY,CAAC,IAAI,EAAE,aAAa,CAAC,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAcnF;IAED;;;;OAIG;IACH,SAAsB,gBAAgB,CAAC,IAAI,EAAE,aAAa,CAAC,oBAAoB,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,aAAa,CAAC,cAAc,CAAC;QAAC,KAAK,EAAE,aAAa,CAAC,cAAc,CAAC;KAAE,CAAC,CAIvK;CACF;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,UAAW,YAAW,aAAa,CAAC,UAAU;IACtF,IAAW,WAAW,IAAI,aAAa,CAAC,UAAU,CAAgC;IAErE,kBAAkB,CAAC,IAAI,EAAE,aAAa,CAAC,sBAAsB,GAAG,OAAO,CAAC,aAAa,CAAC,iBAAiB,CAAC;IAGxG,gBAAgB,CAAC,IAAI,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAGjF,gBAAgB,CAAC,IAAI,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,IAAI,CAAC;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAG/E,YAAY,CAAC,IAAI,EAAE,aAAa,CAAC,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAG1E,YAAY,CAAC,IAAI,EAAE,aAAa,CAAC,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAG1E,gBAAgB,CAAC,IAAI,EAAE,aAAa,CAAC,oBAAoB,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,aAAa,CAAC,cAAc,CAAC;QAAC,KAAK,EAAE,aAAa,CAAC,cAAc,CAAC;KAAE,CAAC;IAGlJ,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,QAAQ,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAGrF,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CAGjG"}

package/lib/cjs/CatalogDb.js

@@ -0,0 +1,271 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module iModels
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CatalogIModelHandler = exports.CatalogDb = void 0;
+const fs = require("fs");
+const path_1 = require("path");
+const CloudSqlite_1 = require("./CloudSqlite");
+const IModelHost_1 = require("./IModelHost");
+const core_common_1 = require("@itwin/core-common");
+const IpcHost_1 = require("./IpcHost");
+const IModelDb_1 = require("./IModelDb");
+const core_bentley_1 = require("@itwin/core-bentley");
+const Symbols_1 = require("./internal/Symbols");
+const NativePlatform_1 = require("./internal/NativePlatform");
+let readonlyCloudCache;
+let writeableCloudCache;
+const catalogManifestName = "CatalogManifest";
+// we make a readonly CloudCache and a writeable CloudCache. That way the access token authorizations are distinct.
+function makeCloudCache(arg, writeable) {
+    const cache = CloudSqlite_1.CloudSqlite.CloudCaches.getCache(arg);
+    // if the cache was just created, add the "catalog" members as hidden
+    if (undefined === cache.catalogContainers) {
+        CloudSqlite_1.CloudSqlite.addHiddenProperty(cache, "catalogContainers", new Map());
+        CloudSqlite_1.CloudSqlite.addHiddenProperty(cache, "writeable", writeable);
+    }
+    return cache;
+}
+// find an existing CloudContainer for accessing a CatalogIModel, or make a new one and connect it
+async function getCatalogContainerObj(cache, containerId) {
+    const cloudContainer = cache.catalogContainers.get(containerId);
+    if (undefined !== cloudContainer)
+        return cloudContainer;
+    const accessLevel = cache.writeable ? "write" : "read";
+    const tokenProps = await CloudSqlite_1.CloudSqlite.getBlobService().requestToken({ containerId, accessLevel, userToken: await IModelHost_1.IModelHost.getAccessToken() });
+    const container = CloudSqlite_1.CloudSqlite.createCloudContainer({
+        accessLevel,
+        baseUri: tokenProps.baseUri,
+        containerId,
+        storageType: tokenProps.provider,
+        writeable: cache.writeable,
+        accessToken: tokenProps.token
+    });
+    cache.catalogContainers.set(containerId, container); // save the container in the map of ContainerIds so we can reuse them
+    container.connect(cache);
+    return container;
+}
+function getReadonlyCloudCache() { return readonlyCloudCache ??= makeCloudCache({ cacheName: "catalogs", cacheSize: "10G" }, false); }
+;
+function getWritableCloudCache() { return writeableCloudCache ??= makeCloudCache({ cacheName: "writeableCatalogs", cacheSize: "10G" }, true); }
+;
+async function getReadonlyContainer(containerId) { return getCatalogContainerObj(getReadonlyCloudCache(), containerId); }
+;
+async function getWriteableContainer(containerId) { return getCatalogContainerObj(getWritableCloudCache(), containerId); }
+;
+/** Throw an error if the write lock is not held for the supplied container */
+function ensureLocked(container, reason) {
+    if (!container.hasWriteLock)
+        core_common_1.CloudSqliteError.throwError("write-lock-not-held", { message: `Write lock must be held to ${reason}` });
+}
+/** update the manifest in a CatalogIModel (calls `saveChanges`) */
+function updateManifest(nativeDb, manifest) {
+    nativeDb.saveLocalValue(catalogManifestName, JSON.stringify(manifest));
+    nativeDb.saveChanges("update manifest");
+}
+function catalogDbNameWithDefault(dbName) {
+    return dbName ?? "catalog-db";
+}
+/** A StandaloneDb that holds a CatalogIModel */
+class CatalogDbImpl extends IModelDb_1.StandaloneDb {
+    isEditable() {
+        return false;
+    }
+    getManifest() {
+        const manifestString = this[Symbols_1._nativeDb].queryLocalValue(catalogManifestName);
+        if (undefined === manifestString)
+            return undefined;
+        return JSON.parse(manifestString);
+    }
+    getVersion() {
+        return CloudSqlite_1.CloudSqlite.parseDbFileName(this[Symbols_1._nativeDb].getFilePath()).version;
+    }
+    getInfo() {
+        return { manifest: this.getManifest(), version: this.getVersion() };
+    }
+}
+/**
+ * A CatalogDb that permits editing.
+ * This class ensures that CatalogIModels never have a Txn table when they are published.
+ * It also automatically updates the `lastEditedBy` field in the CatalogManifest.
+ */
+class EditableCatalogDbImpl extends CatalogDbImpl {
+    isEditable() {
+        return true;
+    }
+    updateCatalogManifest(manifest) {
+        updateManifest(this[Symbols_1._nativeDb], manifest);
+    }
+    // Make sure the txn table is deleted and update the manifest every time we close.
+    beforeClose() {
+        try {
+            const manifest = this.getManifest();
+            const container = this.cloudContainer;
+            if (container && manifest) {
+                manifest.lastEditedBy = CloudSqlite_1.CloudSqlite.getWriteLockHeldBy(container);
+                this.updateCatalogManifest(manifest);
+            }
+            // when saved, CatalogIModels should never have any Txns. If we wanted to create a changeset, we'd have to do it here.
+            this[Symbols_1._nativeDb].deleteAllTxns();
+        }
+        catch { } // ignore errors attempting to update
+        // might also want to vacuum here?
+        super.beforeClose();
+    }
+}
+function findCatalogByKey(key) {
+    return CatalogDbImpl.findByKey(key);
+}
+/** @beta */
+var CatalogDb;
+(function (CatalogDb) {
+    /** Create a new [[BlobContainer]] to hold versions of a [[CatalogDb]].
+     * @returns The properties of the newly created container.
+     * @note creating new containers requires "admin" authorization.
+    */
+    async function createNewContainer(args) {
+        const dbName = catalogDbNameWithDefault(args.dbName);
+        CloudSqlite_1.CloudSqlite.validateDbName(dbName);
+        CloudSqlite_1.CloudSqlite.validateDbVersion(args.version);
+        const tmpName = (0, path_1.join)(IModelHost_1.KnownLocations.tmpdir, `temp-${dbName}`);
+        try {
+            // make a copy of the file they supplied so we can modify its contents safely
+            fs.copyFileSync(args.localCatalogFile, tmpName);
+            const nativeDb = new NativePlatform_1.IModelNative.platform.DgnDb();
+            nativeDb.openIModel(tmpName, core_bentley_1.OpenMode.ReadWrite);
+            nativeDb.setITwinId(core_bentley_1.Guid.empty); // catalogs must be a StandaloneDb
+            nativeDb.setIModelId(core_bentley_1.Guid.createValue()); // make sure its iModelId is unique
+            updateManifest(nativeDb, args.manifest); // store the manifest inside the Catalog
+            nativeDb.deleteAllTxns(); // Catalogs should never have Txns (and, this must be empty before resetting BriefcaseId)
+            nativeDb.resetBriefcaseId(core_common_1.BriefcaseIdValue.Unassigned); // catalogs should always be unassigned
+            nativeDb.saveChanges(); // save change to briefcaseId
+            nativeDb.vacuum();
+            nativeDb.closeFile();
+        }
+        catch (e) {
+            core_common_1.CatalogError.throwError("invalid-seed-catalog", { message: "Illegal seed catalog", ...args, cause: e });
+        }
+        const userToken = await IModelHost_1.IModelHost.getAccessToken();
+        // create tne new container from the blob service, requires "admin" authorization
+        const cloudContainerProps = await CloudSqlite_1.CloudSqlite.getBlobService().create({ scope: { iTwinId: args.iTwinId }, metadata: { ...args.metadata, containerType: "CatalogIModel" }, userToken });
+        // now create a CloudSqlite container object to access it
+        const container = CloudSqlite_1.CloudSqlite.createCloudContainer({
+            accessToken: await CloudSqlite_1.CloudSqlite.requestToken(cloudContainerProps),
+            accessLevel: "admin",
+            writeable: true,
+            baseUri: cloudContainerProps.baseUri,
+            containerId: cloudContainerProps.containerId,
+            storageType: cloudContainerProps.provider,
+        });
+        // initialize the container for use by CloudSqlite
+        container.initializeContainer({ blockSize: 4 * 1024 * 1024 });
+        container.connect(getWritableCloudCache());
+        // upload the initial version of the Catalog
+        await CloudSqlite_1.CloudSqlite.withWriteLock({ user: "initialize", container }, async () => {
+            await CloudSqlite_1.CloudSqlite.uploadDb(container, { dbName: CloudSqlite_1.CloudSqlite.makeSemverName(dbName, args.version), localFileName: tmpName });
+            fs.unlinkSync(tmpName); // delete temporary copy of catalog
+        });
+        container.disconnect();
+        return cloudContainerProps;
+    }
+    CatalogDb.createNewContainer = createNewContainer;
+    /** Acquire the write lock for a [CatalogIModel]($common) container. Only one person may obtain the write lock at a time.
+     * You must obtain the lock before attempting to write to the container via functions like [[CatalogDb.openEditable]] and [[CatalogDb.createNewVersion]].
+     * @note This requires "write" authorization to the container
+     */
+    async function acquireWriteLock(args) {
+        const container = await getWriteableContainer(args.containerId);
+        return CloudSqlite_1.CloudSqlite.acquireWriteLock({ container, user: args.username });
+    }
+    CatalogDb.acquireWriteLock = acquireWriteLock;
+    /** Release the write lock on a [CatalogIModel]($common) container. This uploads all changes made while the lock is held, so they become visible to other users. */
+    async function releaseWriteLock(args) {
+        const container = await getWriteableContainer(args.containerId);
+        if (args.abandon)
+            container.abandonChanges();
+        CloudSqlite_1.CloudSqlite.releaseWriteLock(container);
+    }
+    CatalogDb.releaseWriteLock = releaseWriteLock;
+    /** Open an [[EditableCatalogDb]] for write access.
+     * @note Once a version of a catalog iModel has been published (i.e. the write lock has been released), it is no longer editable, *unless* it is a prerelease version.
+     * @note The write lock must be held for this operation to succeed
+     */
+    async function openEditable(args) {
+        const dbName = catalogDbNameWithDefault(args.dbName);
+        if (undefined === args.containerId) // local file?
+            return EditableCatalogDbImpl.openFile(dbName, core_bentley_1.OpenMode.ReadWrite, args);
+        const container = await getWriteableContainer(args.containerId);
+        ensureLocked(container, "open a Catalog for editing"); // editing Catalogs requires the write lock
+        // look up the full name with version
+        const dbFullName = CloudSqlite_1.CloudSqlite.querySemverMatch({ container, dbName, version: args.version ?? "*" });
+        if (!CloudSqlite_1.CloudSqlite.isSemverEditable(dbFullName, container))
+            core_common_1.CloudSqliteError.throwError("already-published", { message: "Catalog has already been published and is not editable. Make a new version first.", ...args });
+        if (args.prefetch)
+            CloudSqlite_1.CloudSqlite.startCloudPrefetch(container, dbFullName);
+        return EditableCatalogDbImpl.openFile(dbFullName, core_bentley_1.OpenMode.ReadWrite, { container, ...args });
+    }
+    CatalogDb.openEditable = openEditable;
+    /** Open a [[CatalogDb]] for read-only access. */
+    async function openReadonly(args) {
+        const dbName = catalogDbNameWithDefault(args.dbName);
+        if (undefined === args.containerId) // local file?
+            return CatalogDbImpl.openFile(dbName, core_bentley_1.OpenMode.Readonly, args);
+        const container = await getReadonlyContainer(args.containerId);
+        if (args.syncWithCloud)
+            container.checkForChanges();
+        const dbFullName = CloudSqlite_1.CloudSqlite.querySemverMatch({ container, ...args, dbName });
+        if (args.prefetch)
+            CloudSqlite_1.CloudSqlite.startCloudPrefetch(container, dbFullName);
+        return CatalogDbImpl.openFile(dbFullName, core_bentley_1.OpenMode.Readonly, { container, ...args });
+    }
+    CatalogDb.openReadonly = openReadonly;
+    /**
+     * Create a new version of a [CatalogIModel]($common) as a copy of an existing version. Immediately after this operation, the new version will be an exact copy
+     * of the source CatalogIModel. Then, use [[CatalogDb.openEditable]] to modify the new version with new content.
+     * @note The write lock must be held for this operation to succeed
+     */
+    async function createNewVersion(args) {
+        const container = await getWriteableContainer(args.containerId);
+        ensureLocked(container, "create a new version");
+        return CloudSqlite_1.CloudSqlite.createNewDbVersion(container, { ...args, fromDb: { ...args.fromDb, dbName: catalogDbNameWithDefault(args.fromDb.dbName) } });
+    }
+    CatalogDb.createNewVersion = createNewVersion;
+})(CatalogDb || (exports.CatalogDb = CatalogDb = {}));
+/**
+ * Handler for Ipc access to CatalogIModels. Registered by NativeHost.
+ * @internal
+ */
+class CatalogIModelHandler extends IpcHost_1.IpcHandler {
+    get channelName() { return "catalogIModel/ipc"; }
+    async createNewContainer(args) {
+        return CatalogDb.createNewContainer(args);
+    }
+    async acquireWriteLock(args) {
+        return CatalogDb.acquireWriteLock(args);
+    }
+    async releaseWriteLock(args) {
+        return CatalogDb.releaseWriteLock(args);
+    }
+    async openReadonly(args) {
+        return ((await CatalogDb.openReadonly(args)).getConnectionProps());
+    }
+    async openEditable(args) {
+        return (await CatalogDb.openEditable(args)).getConnectionProps();
+    }
+    async createNewVersion(args) {
+        return CatalogDb.createNewVersion(args);
+    }
+    async getInfo(key) {
+        return findCatalogByKey(key).getInfo();
+    }
+    async updateCatalogManifest(key, manifest) {
+        findCatalogByKey(key).updateCatalogManifest(manifest);
+    }
+}
+exports.CatalogIModelHandler = CatalogIModelHandler;
+//# sourceMappingURL=CatalogDb.js.map

package/lib/cjs/CatalogDb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CatalogDb.js","sourceRoot":"","sources":["../../src/CatalogDb.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yBAAyB;AACzB,+BAA4B;AAC5B,+CAA4C;AAC5C,6CAA0D;AAC1D,oDAAiI;AACjI,uCAAuC;AACvC,yCAA0C;AAC1C,sDAAqD;AACrD,gDAA+C;AAC/C,8DAAyD;AAQzD,IAAI,kBAAiD,CAAC;AACtD,IAAI,mBAAkD,CAAC;AACvD,MAAM,mBAAmB,GAAG,iBAAiB,CAAC;AAE9C,mHAAmH;AACnH,SAAS,cAAc,CAAC,GAAoC,EAAE,SAAkB;IAC9E,MAAM,KAAK,GAAG,yBAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAsB,CAAC;IACzE,qEAAqE;IACrE,IAAI,SAAS,KAAK,KAAK,CAAC,iBAAiB,EAAE,CAAC;QAC1C,yBAAW,CAAC,iBAAiB,CAAC,KAAK,EAAE,mBAAmB,EAAE,IAAI,GAAG,EAAsC,CAAC,CAAC;QACzG,yBAAW,CAAC,iBAAiB,CAAC,KAAK,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,kGAAkG;AAClG,KAAK,UAAU,sBAAsB,CAAC,KAAwB,EAAE,WAAmB;IACjF,MAAM,cAAc,GAAG,KAAK,CAAC,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAChE,IAAI,SAAS,KAAK,cAAc;QAC9B,OAAO,cAAc,CAAC;IAExB,MAAM,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;IACvD,MAAM,UAAU,GAAG,MAAM,yBAAW,CAAC,cAAc,EAAE,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,uBAAU,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAC/I,MAAM,SAAS,GAAG,yBAAW,CAAC,oBAAoB,CAAC;QACjD,WAAW;QACX,OAAO,EAAE,UAAU,CAAC,OAAO;QAC3B,WAAW;QACX,WAAW,EAAE,UAAU,CAAC,QAAQ;QAChC,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,WAAW,EAAE,UAAU,CAAC,KAAK;KAC9B,CAAC,CAAC;IACH,KAAK,CAAC,iBAAiB,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC,qEAAqE;IAC1H,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACzB,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,qBAAqB,KAAK,OAAO,kBAAkB,KAAK,cAAc,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC,CAAA,CAAC,CAAC;AAAA,CAAC;AACtI,SAAS,qBAAqB,KAAK,OAAO,mBAAmB,KAAK,cAAc,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,IAAI,CAAC,CAAA,CAAC,CAAC;AAAA,CAAC;AAC/I,KAAK,UAAU,oBAAoB,CAAC,WAAmB,IAAI,OAAO,sBAAsB,CAAC,qBAAqB,EAAE,EAAE,WAAW,CAAC,CAAA,CAAC,CAAC;AAAA,CAAC;AACjI,KAAK,UAAU,qBAAqB,CAAC,WAAmB,IAAI,OAAO,sBAAsB,CAAC,qBAAqB,EAAE,EAAE,WAAW,CAAC,CAAA,CAAC,CAAC;AAAA,CAAC;AAElI,8EAA8E;AAC9E,SAAS,YAAY,CAAC,SAAqC,EAAE,MAAc;IACzE,IAAI,CAAC,SAAS,CAAC,YAAY;QACzB,8BAAgB,CAAC,UAAU,CAAC,qBAAqB,EAAE,EAAE,OAAO,EAAE,8BAA8B,MAAM,EAAE,EAAE,CAAC,CAAC;AAC5G,CAAC;AACD,mEAAmE;AACnE,SAAS,cAAc,CAAC,QAA8B,EAAE,QAAgC;IACtF,QAAQ,CAAC,cAAc,CAAC,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvE,QAAQ,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;AAC1C,CAAC;AACD,SAAS,wBAAwB,CAAC,MAAe;IAC/C,OAAO,MAAM,IAAI,YAAY,CAAC;AAChC,CAAC;AA0BD,gDAAgD;AAChD,MAAM,aAAc,SAAQ,uBAAY;IAC/B,UAAU;QACf,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,WAAW;QAChB,MAAM,cAAc,GAAG,IAAI,CAAC,mBAAS,CAAC,CAAC,eAAe,CAAC,mBAAmB,CAAC,CAAC;QAC5E,IAAI,SAAS,KAAK,cAAc;YAC9B,OAAO,SAAS,CAAC;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAA2B,CAAC;IAC9D,CAAC;IAEM,UAAU;QACf,OAAO,yBAAW,CAAC,eAAe,CAAC,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC;IAC5E,CAAC;IAEM,OAAO;QACZ,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;IACtE,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,qBAAsB,SAAQ,aAAa;IAC/B,UAAU;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,qBAAqB,CAAC,QAAgC;QAC3D,cAAc,CAAC,IAAI,CAAC,mBAAS,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED,kFAAkF;IAClE,WAAW;QACzB,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YACpC,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC;YACtC,IAAI,SAAS,IAAI,QAAQ,EAAE,CAAC;gBAC1B,QAAQ,CAAC,YAAY,GAAG,yBAAW,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;gBAClE,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;YACvC,CAAC;YAED,sHAAsH;YACtH,IAAI,CAAC,mBAAS,CAAC,CAAC,aAAa,EAAE,CAAC;QAClC,CAAC;QAAC,MAAM,CAAC,CAAC,CAAC,CAAC,qCAAqC;QAEjD,kCAAkC;QAClC,KAAK,CAAC,WAAW,EAAE,CAAC;IACtB,CAAC;CACF;AAED,SAAS,gBAAgB,CAAC,GAAW;IACnC,OAAO,aAAa,CAAC,SAAS,CAAC,GAAG,CAAsC,CAAC;AAC3E,CAAC;AAED,YAAY;AACZ,IAAiB,SAAS,CAuIzB;AAvID,WAAiB,SAAS;IACxB;;;MAGE;IACK,KAAK,UAAU,kBAAkB,CAAC,IAA0C;QACjF,MAAM,MAAM,GAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrD,yBAAW,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACnC,yBAAW,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE5C,MAAM,OAAO,GAAG,IAAA,WAAI,EAAC,2BAAc,CAAC,MAAM,EAAE,QAAQ,MAAM,EAAE,CAAC,CAAC;QAC9D,IAAI,CAAC;YACH,6EAA6E;YAC7E,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;YAChD,MAAM,QAAQ,GAAG,IAAI,6BAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YACnD,QAAQ,CAAC,UAAU,CAAC,OAAO,EAAE,uBAAQ,CAAC,SAAS,CAAC,CAAC;YACjD,QAAQ,CAAC,UAAU,CAAC,mBAAI,CAAC,KAAK,CAAC,CAAC,CAAC,kCAAkC;YACnE,QAAQ,CAAC,WAAW,CAAC,mBAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,mCAAmC;YAC7E,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,wCAAwC;YACjF,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC,yFAAyF;YACnH,QAAQ,CAAC,gBAAgB,CAAC,8BAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,uCAAuC;YAC/F,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,6BAA6B;YACrD,QAAQ,CAAC,MAAM,EAAE,CAAC;YAClB,QAAQ,CAAC,SAAS,EAAE,CAAC;QACvB,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,0BAAY,CAAC,UAAU,CAAC,sBAAsB,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAC1G,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC;QACpD,iFAAiF;QACjF,MAAM,mBAAmB,GAAG,MAAM,yBAAW,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QAEvL,yDAAyD;QACzD,MAAM,SAAS,GAAG,yBAAW,CAAC,oBAAoB,CAAC;YACjD,WAAW,EAAE,MAAM,yBAAW,CAAC,YAAY,CAAC,mBAAmB,CAAC;YAChE,WAAW,EAAE,OAAO;YACpB,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,mBAAmB,CAAC,OAAO;YACpC,WAAW,EAAE,mBAAmB,CAAC,WAAW;YAC5C,WAAW,EAAE,mBAAmB,CAAC,QAAQ;SAC1C,CAAC,CAAC;QAEH,kDAAkD;QAClD,SAAS,CAAC,mBAAmB,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC,CAAC;QAC9D,SAAS,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC;QAE3C,4CAA4C;QAC5C,MAAM,yBAAW,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,KAAK,IAAI,EAAE;YAC5E,MAAM,yBAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,yBAAW,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC,CAAC;YAC5H,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,mCAAmC;QAC7D,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,UAAU,EAAE,CAAC;QACvB,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAhDqB,4BAAkB,qBAgDvC,CAAA;IAED;;;OAGG;IACI,KAAK,UAAU,gBAAgB,CAAC,IAQtC;QACC,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,yBAAW,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC1E,CAAC;IAXqB,0BAAgB,mBAWrC,CAAA;IAED,mKAAmK;IAC5J,KAAK,UAAU,gBAAgB,CAAC,IAKtC;QACC,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,IAAI,CAAC,OAAO;YACd,SAAS,CAAC,cAAc,EAAE,CAAC;QAC7B,yBAAW,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC1C,CAAC;IAVqB,0BAAgB,mBAUrC,CAAA;IAED;;;OAGG;IACI,KAAK,UAAU,YAAY,CAAC,IAA4B;QAC7D,MAAM,MAAM,GAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW,EAAE,cAAc;YAChD,OAAO,qBAAqB,CAAC,QAAQ,CAAC,MAAM,EAAE,uBAAQ,CAAC,SAAS,EAAE,IAAI,CAA0B,CAAC;QAEnG,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,YAAY,CAAC,SAAS,EAAE,4BAA4B,CAAC,CAAC,CAAC,2CAA2C;QAElG,qCAAqC;QACrC,MAAM,UAAU,GAAG,yBAAW,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,GAAG,EAAE,CAAC,CAAC;QACrG,IAAI,CAAC,yBAAW,CAAC,gBAAgB,CAAC,UAAU,EAAE,SAAS,CAAC;YACtD,8BAAgB,CAAC,UAAU,CAAC,mBAAmB,EAAE,EAAE,OAAO,EAAE,mFAAmF,EAAE,GAAG,IAAI,EAAE,CAAC,CAAA;QAE7J,IAAI,IAAI,CAAC,QAAQ;YACf,yBAAW,CAAC,kBAAkB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAExD,OAAO,qBAAqB,CAAC,QAAQ,CAAC,UAAU,EAAE,uBAAQ,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,CAA0B,CAAC;IACzH,CAAC;IAjBqB,sBAAY,eAiBjC,CAAA;IAED,iDAAiD;IAC1C,KAAK,UAAU,YAAY,CAAC,IAA4B;QAC7D,MAAM,MAAM,GAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW,EAAE,cAAc;YAChD,OAAO,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,uBAAQ,CAAC,QAAQ,EAAE,IAAI,CAAkB,CAAC;QAElF,MAAM,SAAS,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC/D,IAAI,IAAI,CAAC,aAAa;YACpB,SAAS,CAAC,eAAe,EAAE,CAAC;QAE9B,MAAM,UAAU,GAAG,yBAAW,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QAChF,IAAI,IAAI,CAAC,QAAQ;YACf,yBAAW,CAAC,kBAAkB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAExD,OAAO,aAAa,CAAC,QAAQ,CAAC,UAAU,EAAE,uBAAQ,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,CAAkB,CAAC;IACxG,CAAC;IAdqB,sBAAY,eAcjC,CAAA;IAED;;;;OAIG;IACI,KAAK,UAAU,gBAAgB,CAAC,IAAwC;QAC7E,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,YAAY,CAAC,SAAS,EAAE,sBAAsB,CAAC,CAAC;QAChD,OAAO,yBAAW,CAAC,kBAAkB,CAAC,SAAS,EAAE,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;IAClJ,CAAC;IAJqB,0BAAgB,mBAIrC,CAAA;AACH,CAAC,EAvIgB,SAAS,yBAAT,SAAS,QAuIzB;AAED;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,oBAAU;IAClD,IAAW,WAAW,KAA+B,OAAO,mBAAmB,CAAC,CAAC,CAAC;IAE3E,KAAK,CAAC,kBAAkB,CAAC,IAA0C;QACxE,OAAO,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,IAAgD;QAC5E,OAAO,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,IAA8C;QAC1E,OAAO,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IACM,KAAK,CAAC,YAAY,CAAC,IAA4B;QACpD,OAAO,CAAC,CAAC,MAAM,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACrE,CAAC;IACM,KAAK,CAAC,YAAY,CAAC,IAA4B;QACpD,OAAO,CAAC,MAAM,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC;IACnE,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,IAAwC;QACpE,OAAO,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IACM,KAAK,CAAC,OAAO,CAAC,GAAW;QAC9B,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;IACzC,CAAC;IACM,KAAK,CAAC,qBAAqB,CAAC,GAAW,EAAE,QAAgC;QAC9E,gBAAgB,CAAC,GAAG,CAAC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;CACF;AA3BD,oDA2BC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport * as fs from \"fs\";\nimport { join } from \"path\";\nimport { CloudSqlite } from \"./CloudSqlite\";\nimport { IModelHost, KnownLocations } from \"./IModelHost\";\nimport { BriefcaseIdValue, CatalogError, type CatalogIModel, CloudSqliteError, IModelConnectionProps } from \"@itwin/core-common\";\nimport { IpcHandler } from \"./IpcHost\";\nimport { StandaloneDb } from \"./IModelDb\";\nimport { Guid, OpenMode } from \"@itwin/core-bentley\";\nimport { _nativeDb } from \"./internal/Symbols\";\nimport { IModelNative } from \"./internal/NativePlatform\";\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\n\ninterface CatalogCloudCache extends CloudSqlite.CloudCache {\n  writeable: boolean;\n  catalogContainers: Map<string, CloudSqlite.CloudContainer>;\n}\n\nlet readonlyCloudCache: CatalogCloudCache | undefined;\nlet writeableCloudCache: CatalogCloudCache | undefined;\nconst catalogManifestName = \"CatalogManifest\";\n\n// we make a readonly CloudCache and a writeable CloudCache. That way the access token authorizations are distinct.\nfunction makeCloudCache(arg: CloudSqlite.CreateCloudCacheArg, writeable: boolean) {\n  const cache = CloudSqlite.CloudCaches.getCache(arg) as CatalogCloudCache;\n  // if the cache was just created, add the \"catalog\" members as hidden\n  if (undefined === cache.catalogContainers) {\n    CloudSqlite.addHiddenProperty(cache, \"catalogContainers\", new Map<string, CloudSqlite.CloudContainer>());\n    CloudSqlite.addHiddenProperty(cache, \"writeable\", writeable);\n  }\n  return cache;\n}\n\n// find an existing CloudContainer for accessing a CatalogIModel, or make a new one and connect it\nasync function getCatalogContainerObj(cache: CatalogCloudCache, containerId: string): Promise<CloudSqlite.CloudContainer> {\n  const cloudContainer = cache.catalogContainers.get(containerId);\n  if (undefined !== cloudContainer)\n    return cloudContainer;\n\n  const accessLevel = cache.writeable ? \"write\" : \"read\";\n  const tokenProps = await CloudSqlite.getBlobService().requestToken({ containerId, accessLevel, userToken: await IModelHost.getAccessToken() });\n  const container = CloudSqlite.createCloudContainer({\n    accessLevel,\n    baseUri: tokenProps.baseUri,\n    containerId,\n    storageType: tokenProps.provider,\n    writeable: cache.writeable,\n    accessToken: tokenProps.token\n  });\n  cache.catalogContainers.set(containerId, container); // save the container in the map of ContainerIds so we can reuse them\n  container.connect(cache);\n  return container;\n}\n\nfunction getReadonlyCloudCache() { return readonlyCloudCache ??= makeCloudCache({ cacheName: \"catalogs\", cacheSize: \"10G\" }, false) };\nfunction getWritableCloudCache() { return writeableCloudCache ??= makeCloudCache({ cacheName: \"writeableCatalogs\", cacheSize: \"10G\" }, true) };\nasync function getReadonlyContainer(containerId: string) { return getCatalogContainerObj(getReadonlyCloudCache(), containerId) };\nasync function getWriteableContainer(containerId: string) { return getCatalogContainerObj(getWritableCloudCache(), containerId) };\n\n/** Throw an error if the write lock is not held for the supplied container */\nfunction ensureLocked(container: CloudSqlite.CloudContainer, reason: string) {\n  if (!container.hasWriteLock)\n    CloudSqliteError.throwError(\"write-lock-not-held\", { message: `Write lock must be held to ${reason}` });\n}\n/** update the manifest in a CatalogIModel (calls `saveChanges`) */\nfunction updateManifest(nativeDb: IModelJsNative.DgnDb, manifest: CatalogIModel.Manifest) {\n  nativeDb.saveLocalValue(catalogManifestName, JSON.stringify(manifest));\n  nativeDb.saveChanges(\"update manifest\");\n}\nfunction catalogDbNameWithDefault(dbName?: string): string {\n  return dbName ?? \"catalog-db\";\n}\n\n/** A [[StandaloneDb]] that provides read-only access to the contents of a [CatalogIModel]($common).\n * @see [[CatalogDb.openReadonly]] to instantiate this type.\n * @beta\n */\nexport interface CatalogDb extends StandaloneDb {\n  /** Get the catalog's manifest. */\n  getManifest(): CatalogIModel.Manifest | undefined;\n  /** Get the catalog's version information. */\n  getVersion(): string;\n  /** Get the catalog's manifest and version. */\n  getInfo(): { manifest?: CatalogIModel.Manifest, version: string };\n  /** Returns true if the catalog was opened in read-write mode. */\n  isEditable(): this is EditableCatalogDb;\n}\n\n/** A writable [[CatalogDb]].\n * @see [[CatalogDb.openEditable]] to instantiate this type.\n * @beta\n */\nexport interface EditableCatalogDb extends CatalogDb {\n  /** Update the contents of the catalog manifest.  */\n  updateCatalogManifest(manifest: CatalogIModel.Manifest): void;\n}\n\n/** A StandaloneDb that holds a CatalogIModel */\nclass CatalogDbImpl extends StandaloneDb implements CatalogDb {\n  public isEditable(): this is EditableCatalogDb {\n    return false;\n  }\n\n  public getManifest(): CatalogIModel.Manifest | undefined {\n    const manifestString = this[_nativeDb].queryLocalValue(catalogManifestName);\n    if (undefined === manifestString)\n      return undefined;\n    return JSON.parse(manifestString) as CatalogIModel.Manifest;\n  }\n\n  public getVersion(): string {\n    return CloudSqlite.parseDbFileName(this[_nativeDb].getFilePath()).version;\n  }\n\n  public getInfo() {\n    return { manifest: this.getManifest(), version: this.getVersion() };\n  }\n}\n\n/**\n * A CatalogDb that permits editing.\n * This class ensures that CatalogIModels never have a Txn table when they are published.\n * It also automatically updates the `lastEditedBy` field in the CatalogManifest.\n */\nclass EditableCatalogDbImpl extends CatalogDbImpl implements EditableCatalogDb {\n  public override isEditable(): this is EditableCatalogDb {\n    return true;\n  }\n\n  public updateCatalogManifest(manifest: CatalogIModel.Manifest): void {\n    updateManifest(this[_nativeDb], manifest);\n  }\n\n  // Make sure the txn table is deleted and update the manifest every time we close.\n  public override beforeClose(): void {\n    try {\n      const manifest = this.getManifest();\n      const container = this.cloudContainer;\n      if (container && manifest) {\n        manifest.lastEditedBy = CloudSqlite.getWriteLockHeldBy(container);\n        this.updateCatalogManifest(manifest);\n      }\n\n      // when saved, CatalogIModels should never have any Txns. If we wanted to create a changeset, we'd have to do it here.\n      this[_nativeDb].deleteAllTxns();\n    } catch { } // ignore errors attempting to update\n\n    // might also want to vacuum here?\n    super.beforeClose();\n  }\n}\n\nfunction findCatalogByKey(key: string): CatalogDbImpl & EditableCatalogDb {\n  return CatalogDbImpl.findByKey(key) as CatalogDbImpl & EditableCatalogDb;\n}\n\n/** @beta */\nexport namespace CatalogDb {\n  /** Create a new [[BlobContainer]] to hold versions of a [[CatalogDb]].\n   * @returns The properties of the newly created container.\n   * @note creating new containers requires \"admin\" authorization.\n  */\n  export async function createNewContainer(args: CatalogIModel.CreateNewContainerArgs): Promise<CatalogIModel.NewContainerProps> {\n    const dbName = catalogDbNameWithDefault(args.dbName);\n    CloudSqlite.validateDbName(dbName);\n    CloudSqlite.validateDbVersion(args.version);\n\n    const tmpName = join(KnownLocations.tmpdir, `temp-${dbName}`);\n    try {\n      // make a copy of the file they supplied so we can modify its contents safely\n      fs.copyFileSync(args.localCatalogFile, tmpName);\n      const nativeDb = new IModelNative.platform.DgnDb();\n      nativeDb.openIModel(tmpName, OpenMode.ReadWrite);\n      nativeDb.setITwinId(Guid.empty); // catalogs must be a StandaloneDb\n      nativeDb.setIModelId(Guid.createValue()); // make sure its iModelId is unique\n      updateManifest(nativeDb, args.manifest); // store the manifest inside the Catalog\n      nativeDb.deleteAllTxns(); // Catalogs should never have Txns (and, this must be empty before resetting BriefcaseId)\n      nativeDb.resetBriefcaseId(BriefcaseIdValue.Unassigned); // catalogs should always be unassigned\n      nativeDb.saveChanges(); // save change to briefcaseId\n      nativeDb.vacuum();\n      nativeDb.closeFile();\n    } catch (e: unknown) {\n      CatalogError.throwError(\"invalid-seed-catalog\", { message: \"Illegal seed catalog\", ...args, cause: e });\n    }\n\n    const userToken = await IModelHost.getAccessToken();\n    // create tne new container from the blob service, requires \"admin\" authorization\n    const cloudContainerProps = await CloudSqlite.getBlobService().create({ scope: { iTwinId: args.iTwinId }, metadata: { ...args.metadata, containerType: \"CatalogIModel\" }, userToken });\n\n    // now create a CloudSqlite container object to access it\n    const container = CloudSqlite.createCloudContainer({\n      accessToken: await CloudSqlite.requestToken(cloudContainerProps),\n      accessLevel: \"admin\",\n      writeable: true,\n      baseUri: cloudContainerProps.baseUri,\n      containerId: cloudContainerProps.containerId,\n      storageType: cloudContainerProps.provider,\n    });\n\n    // initialize the container for use by CloudSqlite\n    container.initializeContainer({ blockSize: 4 * 1024 * 1024 });\n    container.connect(getWritableCloudCache());\n\n    // upload the initial version of the Catalog\n    await CloudSqlite.withWriteLock({ user: \"initialize\", container }, async () => {\n      await CloudSqlite.uploadDb(container, { dbName: CloudSqlite.makeSemverName(dbName, args.version), localFileName: tmpName });\n      fs.unlinkSync(tmpName); // delete temporary copy of catalog\n    });\n    container.disconnect();\n    return cloudContainerProps;\n  }\n\n  /** Acquire the write lock for a [CatalogIModel]($common) container. Only one person may obtain the write lock at a time.\n   * You must obtain the lock before attempting to write to the container via functions like [[CatalogDb.openEditable]] and [[CatalogDb.createNewVersion]].\n   * @note This requires \"write\" authorization to the container\n   */\n  export async function acquireWriteLock(args: {\n    /** The id of the container */\n    containerId: string,\n    /**\n     * The name of the individual acquiring the lock. This will be shown to others who attempt to acquire the lock while it is held.\n     * It is also stored in the \"lastEditedBy\" field of the manifest of any new version edited while the lock is held.\n     */\n    username: string;\n  }): Promise<void> {\n    const container = await getWriteableContainer(args.containerId);\n    return CloudSqlite.acquireWriteLock({ container, user: args.username });\n  }\n\n  /** Release the write lock on a [CatalogIModel]($common) container. This uploads all changes made while the lock is held, so they become visible to other users. */\n  export async function releaseWriteLock(args: {\n    /** The id of the container */\n    containerId: string,\n    /** If true, abandon all local changes before releasing the lock */\n    abandon?: true\n  }): Promise<void> {\n    const container = await getWriteableContainer(args.containerId);\n    if (args.abandon)\n      container.abandonChanges();\n    CloudSqlite.releaseWriteLock(container);\n  }\n\n  /** Open an [[EditableCatalogDb]] for write access.\n   * @note Once a version of a catalog iModel has been published (i.e. the write lock has been released), it is no longer editable, *unless* it is a prerelease version.\n   * @note The write lock must be held for this operation to succeed\n   */\n  export async function openEditable(args: CatalogIModel.OpenArgs): Promise<EditableCatalogDb> {\n    const dbName = catalogDbNameWithDefault(args.dbName);\n    if (undefined === args.containerId) // local file?\n      return EditableCatalogDbImpl.openFile(dbName, OpenMode.ReadWrite, args) as EditableCatalogDbImpl;\n\n    const container = await getWriteableContainer(args.containerId);\n    ensureLocked(container, \"open a Catalog for editing\"); // editing Catalogs requires the write lock\n\n    // look up the full name with version\n    const dbFullName = CloudSqlite.querySemverMatch({ container, dbName, version: args.version ?? \"*\" });\n    if (!CloudSqlite.isSemverEditable(dbFullName, container))\n      CloudSqliteError.throwError(\"already-published\", { message: \"Catalog has already been published and is not editable. Make a new version first.\", ...args })\n\n    if (args.prefetch)\n      CloudSqlite.startCloudPrefetch(container, dbFullName);\n\n    return EditableCatalogDbImpl.openFile(dbFullName, OpenMode.ReadWrite, { container, ...args }) as EditableCatalogDbImpl;\n  }\n\n  /** Open a [[CatalogDb]] for read-only access. */\n  export async function openReadonly(args: CatalogIModel.OpenArgs): Promise<CatalogDb> {\n    const dbName = catalogDbNameWithDefault(args.dbName);\n    if (undefined === args.containerId) // local file?\n      return CatalogDbImpl.openFile(dbName, OpenMode.Readonly, args) as CatalogDbImpl;\n\n    const container = await getReadonlyContainer(args.containerId);\n    if (args.syncWithCloud)\n      container.checkForChanges();\n\n    const dbFullName = CloudSqlite.querySemverMatch({ container, ...args, dbName });\n    if (args.prefetch)\n      CloudSqlite.startCloudPrefetch(container, dbFullName);\n\n    return CatalogDbImpl.openFile(dbFullName, OpenMode.Readonly, { container, ...args }) as CatalogDbImpl;\n  }\n\n  /**\n   * Create a new version of a [CatalogIModel]($common) as a copy of an existing version. Immediately after this operation, the new version will be an exact copy\n   * of the source CatalogIModel. Then, use [[CatalogDb.openEditable]] to modify the new version with new content.\n   * @note The write lock must be held for this operation to succeed\n   */\n  export async function createNewVersion(args: CatalogIModel.CreateNewVersionArgs): Promise<{ oldDb: CatalogIModel.NameAndVersion; newDb: CatalogIModel.NameAndVersion; }> {\n    const container = await getWriteableContainer(args.containerId);\n    ensureLocked(container, \"create a new version\");\n    return CloudSqlite.createNewDbVersion(container, { ...args, fromDb: { ...args.fromDb, dbName: catalogDbNameWithDefault(args.fromDb.dbName) } });\n  }\n}\n\n/**\n * Handler for Ipc access to CatalogIModels. Registered by NativeHost.\n * @internal\n */\nexport class CatalogIModelHandler extends IpcHandler implements CatalogIModel.IpcMethods {\n  public get channelName(): CatalogIModel.IpcChannel { return \"catalogIModel/ipc\"; }\n\n  public async createNewContainer(args: CatalogIModel.CreateNewContainerArgs): Promise<CatalogIModel.NewContainerProps> {\n    return CatalogDb.createNewContainer(args);\n  }\n  public async acquireWriteLock(args: { containerId: string, username: string; }): Promise<void> {\n    return CatalogDb.acquireWriteLock(args);\n  }\n  public async releaseWriteLock(args: { containerId: string, abandon?: true; }): Promise<void> {\n    return CatalogDb.releaseWriteLock(args);\n  }\n  public async openReadonly(args: CatalogIModel.OpenArgs): Promise<IModelConnectionProps> {\n    return ((await CatalogDb.openReadonly(args)).getConnectionProps());\n  }\n  public async openEditable(args: CatalogIModel.OpenArgs): Promise<IModelConnectionProps> {\n    return (await CatalogDb.openEditable(args)).getConnectionProps();\n  }\n  public async createNewVersion(args: CatalogIModel.CreateNewVersionArgs): Promise<{ oldDb: CatalogIModel.NameAndVersion; newDb: CatalogIModel.NameAndVersion; }> {\n    return CatalogDb.createNewVersion(args);\n  }\n  public async getInfo(key: string): Promise<{ manifest?: CatalogIModel.Manifest, version: string }> {\n    return findCatalogByKey(key).getInfo();\n  }\n  public async updateCatalogManifest(key: string, manifest: CatalogIModel.Manifest): Promise<void> {\n    findCatalogByKey(key).updateCatalogManifest(manifest);\n  }\n}\n"]}

package/lib/cjs/CloudSqlite.d.ts

@@ -11,11 +11,20 @@ import type { SQLiteDb, VersionedSqliteDb } from "./SQLiteDb";
  */
 export declare namespace CloudSqlite {
     export type RequestTokenArgs = Optional<BlobContainer.RequestTokenProps, "userToken">;
+    /** Add (or replace) a property to an object that is not enumerable.
+     * This is important so this member will be skipped when the object is the target of
+     * [structuredClone](https://developer.mozilla.org/docs/Web/API/Web_Workers_API/Structured_clone_algorithm)
+     * (e.g. when the object is part of an exception that is marshalled across process boundaries.)
+     */
+    export function addHiddenProperty<T>(o: T, p: PropertyKey, value?: any): T;
+    export function getBlobService(): BlobContainer.ContainerService;
     /**
      * Request a new AccessToken for a cloud container using the [[BlobContainer]] service.
      * If the service is unavailable or returns an error, an empty token is returned.
      */
     export function requestToken(args: RequestTokenArgs): Promise<AccessToken>;
+    export function noLeadingOrTrailingSpaces(name: string, msg: string): void;
+    export function validateDbName(dbName: DbName): void;
     /**
      * Create a new CloudContainer from a ContainerAccessProps. For non-public containers, a valid accessToken must be provided before the container
      * can be used (e.g. via [[CloudSqlite.requestToken]]).
@@ -135,16 +144,65 @@ export declare namespace CloudSqlite {
         /** The total number of attached containers on this cache. */
         readonly attachedContainers?: number;
     }
+    /** The base name of a CloudSqlite database, without any version information.
+     * The name must conform to the following constraints:
+     * - Case-insensitively unique among all databases in the same [[CloudSqlite.CloudContainer]]
+     * - Between 1 and 255 characters in length.
+     * - A legal filename on both [Windows](https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file#naming-conventions) and UNIX.
+     * - Contain none of the following characters: forward or backward slash, period, single or double quote, backtick, colon, and "#".
+     * - Begin or end with a whitespace character.
+     * @see [[CloudSqlite.DbFullName]] for the fully-specified name, including version information.
+     */
+    export type DbName = string;
+    /** The fully-specified name of a CloudSqlite database, combining its [[CloudSqlite.DbName]] and [[CloudSqlite.DbVersion]] in the format "name:version".
+     */
+    export type DbFullName = string;
+    /** A [semver](https://github.com/npm/node-semver) string describing the version of a database, e.g., "4.2.11".
+     */
+    export type DbVersion = string;
+    /** A [semver string](https://github.com/npm/node-semver?tab=readme-ov-file#ranges) describing a range of acceptable versions,
+     * e.g., ">=1.2.7 <1.3.0".
+     */
+    export type DbVersionRange = string;
+    /** Specifies the name and version of a CloudSqlite database.
+     */
+    export interface DbNameAndVersion {
+        /** The name of the database */
+        readonly dbName: DbName;
+        /** The range of acceptable versions of the database of the specified [[dbName]].
+         * If omitted, it defaults to the newest available version.
+         */
+        readonly version?: DbVersionRange;
+    }
+    export interface LoadProps extends DbNameAndVersion {
+        readonly container: CloudContainer;
+        /** If true, allow semver [prerelease versions](https://github.com/npm/node-semver?tab=readme-ov-file#prerelease-tags), e.g., "1.4.2-beta.0".
+         * By default, only released version are allowed.
+         */
+        readonly includePrerelease?: boolean;
+        /** If true, start a prefetch operation whenever this database is opened, to begin downloading pages of the database before they are needed. */
+        readonly prefetch?: boolean;
+    }
+    /**
+     * The release increment for a version number, used as part of [[CloudSqlite.CreateNewDbVersionArgs]] to specify the kind of version to create.
+     * @see [semver.ReleaseType](https://www.npmjs.com/package/semver)
+     */
+    export type SemverIncrement = "major" | "minor" | "patch" | "premajor" | "preminor" | "prepatch" | "prerelease";
+    /**
+     * Arguments supplied to [[CloudSqlite.createNewDbVersion]].
+     */
+    export interface CreateNewDbVersionArgs {
+        readonly fromDb: DbNameAndVersion;
+        /** The type of version increment to apply to the source version. */
+        readonly versionType: SemverIncrement;
+        /** For prerelease versions, a string that becomes part of the version name. */
+        readonly identifier?: string;
+    }
     /** The name of a CloudSqlite database within a CloudContainer. */
     export interface DbNameProp {
         /** the name of the database within the CloudContainer.
          * @note names of databases within a CloudContainer are always **case sensitive** on all platforms.*/
-        dbName: string;
-    }
-    /** Properties for accessing a database within a CloudContainer */
-    export interface DbProps extends DbNameProp {
-        /** the name of the local file to access the database. */
-        localFileName: LocalFileName;
+        dbName: DbFullName;
     }
     export type TransferDirection = "upload" | "download";
     export interface TransferProgress {
@@ -161,7 +219,10 @@ export declare namespace CloudSqlite {
         /** The number of prefetch requests to issue while there is foreground activity. Default is 3. */
         minRequests?: number;
     }
-    export type TransferDbProps = DbProps & TransferProgress & CloudHttpProps;
+    export interface TransferDbProps extends DbNameProp, TransferProgress, CloudHttpProps {
+        /** the name of the local file to access the database for uploading and downloading */
+        localFileName: LocalFileName;
+    }
     /** Properties for creating a CloudCache. */
     export interface CacheProps extends CloudHttpProps {
         /** full path of directory for cache to store its files. Must be on a (preferably fast) local drive, and must be empty when the cache is first created. */
@@ -517,25 +578,48 @@ export declare namespace CloudSqlite {
         container: CloudContainer;
         busyHandler?: WriteLockBusyHandler;
     }): Promise<void>;
+    export function getWriteLockHeldBy(container: CloudContainer): string | undefined;
+    /** release the write lock on a container. */
+    export function releaseWriteLock(container: CloudContainer): void;
     /**
-   * Perform an asynchronous write operation on a CloudContainer with the write lock held.
-   * 1. if write lock is already held by the current user, refresh write lock's expiry time, call operation and return.
-   * 2. attempt to acquire the write lock, with retries. Throw if unable to obtain write lock.
-   * 3. perform the operation
-   * 3.a if the operation throws, abandon all changes and re-throw
-   * 4. release the write lock.
-   * 5. return value from operation
-   * @param user the name to be displayed to other users in the event they attempt to obtain the lock while it is held by us
-   * @param container the CloudContainer for which the lock is to be acquired
-   * @param operation an asynchronous operation performed with the write lock held.
-   * @param busyHandler if present, function called when the write lock is currently held by another user.
-   * @returns a Promise with the result of `operation`
-   */
+    * Perform an asynchronous write operation on a CloudContainer with the write lock held.
+    * 1. if write lock is already held by the current user, refresh write lock's expiry time, call operation and return.
+    * 2. attempt to acquire the write lock, with retries. Throw if unable to obtain write lock.
+    * 3. perform the operation
+    * 3.a if the operation throws, abandon all changes and re-throw
+    * 4. release the write lock.
+    * 5. return value from operation
+    * @param user the name to be displayed to other users in the event they attempt to obtain the lock while it is held by us
+    * @param container the CloudContainer for which the lock is to be acquired
+    * @param operation an asynchronous operation performed with the write lock held.
+    * @param busyHandler if present, function called when the write lock is currently held by another user.
+    * @returns a Promise with the result of `operation`
+    */
     export function withWriteLock<T>(args: {
         user: string;
         container: CloudContainer;
         busyHandler?: WriteLockBusyHandler;
     }, operation: () => Promise<T>): Promise<T>;
+    /**
+     * Parse the name of a Db stored in a CloudContainer into the dbName and version number. A single CloudContainer may hold
+     * many versions of the same Db. The name of the Db in the CloudContainer is in the format "name:version". This
+     * function splits them into separate strings.
+     */
+    export function parseDbFileName(dbFileName: DbFullName): {
+        dbName: DbName;
+        version: DbVersion;
+    };
+    export function validateDbVersion(version?: DbVersion): string;
+    export function isSemverPrerelease(version: string): true | readonly (string | number)[] | null;
+    export function isSemverEditable(dbFullName: string, container: CloudContainer): boolean | readonly (string | number)[];
+    /** Create a dbName for a database from its base name and version. This will be in the format "name:version" */
+    export function makeSemverName(dbName: DbName, version?: DbVersion): DbName;
+    /** query the databases in the supplied container for the highest SemVer match according to the version range. Throws if no version available for the range. */
+    export function querySemverMatch(props: LoadProps): DbFullName;
+    export function createNewDbVersion(container: CloudContainer, args: CreateNewDbVersionArgs): Promise<{
+        oldDb: DbNameAndVersion;
+        newDb: DbNameAndVersion;
+    }>;
     /** Arguments to create or find a CloudCache */
     export interface CreateCloudCacheArg {
         /** The name of the CloudCache. CloudCache names must be unique. */