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

package/lib/cjs/workspace/Workspace.js

@@ -1,538 +1,538 @@
-"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 Workspace
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EditableWorkspaceDb = exports.ITwinWorkspaceDb = exports.ITwinWorkspaceContainer = exports.ITwinWorkspace = exports.WorkspaceSetting = void 0;
-const crypto_1 = require("crypto");
-const fs = require("fs-extra");
-const path_1 = require("path");
-const semver = require("semver");
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_common_1 = require("@itwin/core-common");
-const CloudSqlite_1 = require("../CloudSqlite");
-const IModelHost_1 = require("../IModelHost");
-const IModelJsFs_1 = require("../IModelJsFs");
-const SQLiteDb_1 = require("../SQLiteDb");
-const Settings_1 = require("./Settings");
-const SettingsSchemas_1 = require("./SettingsSchemas");
-/* eslint-disable @typescript-eslint/naming-convention */
-// cspell:ignore rowid primarykey julianday
-/** The Settings used by Workspace api
- * @beta
- */
-exports.WorkspaceSetting = {
-    Accounts: "cloud/accounts",
-    Containers: "cloud/containers",
-    Databases: "workspace/databases",
-};
-/** @internal */
-class ITwinWorkspace {
-    constructor(settings, opts) {
-        this._containers = new Map();
-        this.settings = settings;
-        this.containerDir = opts?.containerDir ?? (0, path_1.join)(IModelHost_1.IModelHost.cacheDir, "Workspace");
-        this._cloudCache = opts?.testCloudCache;
-        let settingsFiles = opts?.settingsFiles;
-        if (settingsFiles) {
-            if (typeof settingsFiles === "string")
-                settingsFiles = [settingsFiles];
-            settingsFiles.forEach((file) => settings.addFile(file, Settings_1.SettingsPriority.application));
-        }
-    }
-    get cloudCache() {
-        if (undefined === this._cloudCache)
-            this._cloudCache = ITwinWorkspace.getSharedCloudCache();
-        return this._cloudCache;
-    }
-    static getSharedCloudCache() {
-        if (undefined === this._sharedCloudCache) {
-            const rootDir = (0, path_1.join)(IModelHost_1.IModelHost.cacheDir, "Workspace", "cloud");
-            IModelJsFs_1.IModelJsFs.recursiveMkDirSync(rootDir);
-            this._sharedCloudCache = CloudSqlite_1.CloudSqlite.createCloudCache({ rootDir, cacheSize: "20G", name: "workspace" });
-        }
-        return this._sharedCloudCache;
-    }
-    static finalize() {
-        if (this._sharedCloudCache) {
-            this._sharedCloudCache.destroy();
-            this._sharedCloudCache = undefined;
-        }
-    }
-    addContainer(toAdd) {
-        if (undefined !== this._containers.get(toAdd.id))
-            throw new Error("container already exists in workspace");
-        this._containers.set(toAdd.id, toAdd);
-    }
-    findContainer(containerId) {
-        return this._containers.get(containerId);
-    }
-    getContainer(props, account) {
-        return this.findContainer(props.containerId) ?? new ITwinWorkspaceContainer(this, props, account);
-    }
-    getWorkspaceDbFromProps(dbProps, containerProps, account) {
-        return this.getContainer(containerProps, account).getWorkspaceDb(dbProps);
-    }
-    async getWorkspaceDb(dbAlias, tokenFunc) {
-        const dbProps = this.resolveDatabase(dbAlias);
-        const containerProps = this.resolveContainer(dbProps.containerName);
-        const account = containerProps.accountName !== "" ? this.resolveAccount(containerProps.accountName) : undefined;
-        let container = this.findContainer(containerProps.containerId);
-        if (undefined === container) {
-            if (tokenFunc && account)
-                containerProps.accessToken = await tokenFunc(containerProps, account);
-            container = this.getContainer(containerProps, account);
-        }
-        return container?.getWorkspaceDb(dbProps);
-    }
-    loadSettingsDictionary(settingRsc, db, priority) {
-        const setting = db.getString(settingRsc);
-        if (undefined === setting)
-            throw new Error(`could not load setting resource ${settingRsc}`);
-        this.settings.addJson(`${db.container.id}/${db.dbName}/${settingRsc}`, priority, setting);
-    }
-    close() {
-        this.settings.close();
-        for (const [_id, container] of this._containers)
-            container.close();
-        this._containers.clear();
-    }
-    resolveAccount(accountName) {
-        const resolved = this.settings.resolveSetting(exports.WorkspaceSetting.Accounts, (val) => {
-            if (Array.isArray(val)) {
-                for (const entry of val) {
-                    if (typeof entry === "object" && entry.name === accountName)
-                        return SettingsSchemas_1.SettingsSchemas.validateArrayObject(entry, exports.WorkspaceSetting.Accounts, accountName);
-                }
-            }
-            return undefined; // keep going through all settings dictionaries
-        });
-        if (resolved === undefined)
-            throw new Error(`no setting "${exports.WorkspaceSetting.Accounts}" entry for "${accountName}"`);
-        return resolved;
-    }
-    resolveContainer(containerName) {
-        const resolved = this.settings.resolveSetting(exports.WorkspaceSetting.Containers, (val) => {
-            if (Array.isArray(val)) {
-                for (const entry of val) {
-                    if (typeof entry === "object" && entry.name === containerName)
-                        return SettingsSchemas_1.SettingsSchemas.validateArrayObject(entry, exports.WorkspaceSetting.Containers, containerName);
-                }
-            }
-            return undefined; // keep going through all settings dictionaries
-        });
-        if (resolved === undefined)
-            throw new Error(`no setting "${exports.WorkspaceSetting.Containers}" entry for "${containerName}"`);
-        return resolved;
-    }
-    resolveDatabase(databaseName) {
-        const resolved = this.settings.resolveSetting(exports.WorkspaceSetting.Databases, (val) => {
-            if (Array.isArray(val)) {
-                for (const entry of val) {
-                    if (typeof entry === "object" && entry.name === databaseName)
-                        return SettingsSchemas_1.SettingsSchemas.validateArrayObject(entry, exports.WorkspaceSetting.Databases, databaseName);
-                }
-            }
-            return undefined; // keep going through all settings dictionaries
-        });
-        if (resolved === undefined)
-            throw new Error(`no setting "${exports.WorkspaceSetting.Databases}" entry for "${databaseName}"`);
-        return resolved;
-    }
-}
-exports.ITwinWorkspace = ITwinWorkspace;
-/** @internal */
-class ITwinWorkspaceContainer {
-    constructor(workspace, props, account) {
-        this._wsDbs = new Map();
-        ITwinWorkspaceContainer.validateContainerId(props.containerId);
-        this.workspace = workspace;
-        this.id = props.containerId;
-        if (account?.accessName && account.storageType)
-            this.cloudContainer = CloudSqlite_1.CloudSqlite.createCloudContainer({ accessToken: "", ...props, ...account });
-        workspace.addContainer(this);
-        this.filesDir = (0, path_1.join)(this.dirName, "Files");
-        const cloudContainer = this.cloudContainer;
-        if (undefined === cloudContainer)
-            return;
-        cloudContainer.connect(this.workspace.cloudCache);
-        if (false !== props.syncOnConnect) {
-            try {
-                cloudContainer.checkForChanges();
-            }
-            catch (e) {
-                // must be offline
-            }
-        }
-    }
-    get dirName() { return (0, path_1.join)(this.workspace.containerDir, this.id); }
-    static noLeadingOrTrailingSpaces(name, msg) {
-        if (name.trim() !== name)
-            throw new Error(`${msg} [${name}] may not have leading or tailing spaces`);
-    }
-    /** rules for ContainerIds (from Azure, see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata)
-     *  - may only contain lower case letters, numbers or dashes
-     *  - may not start or end with with a dash nor have more than one dash in a row
-     *  - may not be shorter than 3 or longer than 63 characters
-     */
-    static validateContainerId(id) {
-        if (!/^(?=.{3,63}$)[a-z0-9]+(-[a-z0-9]+)*$/g.test(id))
-            throw new Error(`invalid containerId: [${id}]`);
-    }
-    static validateDbName(dbName) {
-        if (dbName === "" || dbName.length > 255 || /[#\.<>:"/\\"`'|?*\u0000-\u001F]/g.test(dbName) || /^(con|prn|aux|nul|com\d|lpt\d)$/i.test(dbName))
-            throw new Error(`invalid dbName: [${dbName}]`);
-        this.noLeadingOrTrailingSpaces(dbName, "dbName");
-    }
-    static validateVersion(version) {
-        version = version ?? "1.0.0";
-        if (version) {
-            const opts = { loose: true, includePrerelease: true };
-            // clean allows prerelease, so try it first. If that fails attempt to coerce it (coerce strips prerelease even if you say not to.)
-            const semVersion = semver.clean(version, opts) ?? semver.coerce(version, opts)?.version;
-            if (!semVersion)
-                throw new Error("invalid version specification");
-            version = semVersion;
-        }
-        return version;
-    }
-    static parseDbFileName(dbFileName) {
-        const parts = dbFileName.split(":");
-        return { dbName: parts[0], version: parts[1] };
-    }
-    static makeDbFileName(dbName, version) {
-        return `${dbName}:${this.validateVersion(version)}`;
-    }
-    static resolveCloudFileName(cloudContainer, props) {
-        const dbName = props.dbName;
-        const dbs = cloudContainer.queryDatabases(`${dbName}*`); // get all databases that start with dbName
-        const versions = [];
-        for (const db of dbs) {
-            const thisDb = ITwinWorkspaceContainer.parseDbFileName(db);
-            if (thisDb.dbName === dbName && "string" === typeof thisDb.version && thisDb.version.length > 0)
-                versions.push(thisDb.version);
-        }
-        if (versions.length === 0)
-            versions[0] = "1.0.0";
-        const range = props.version ?? "*";
-        try {
-            const version = semver.maxSatisfying(versions, range, { loose: true, includePrerelease: props.includePrerelease });
-            if (version)
-                return `${dbName}:${version}`;
-        }
-        catch (e) {
-        }
-        throw new Error(`No version of [${dbName}] available for "${range}"`);
-    }
-    /**
-     * Create a copy of an existing [[WorkspaceDb]] in a cloud container with a new version number.
-     * @param cloudContainer The attached cloud container holding the existing WorkspaceDb
-     * @param fromProps Properties that describe the source WorkspaceDb for the new version
-     * @param versionType The type of version increment to apply to the existing version.
-     * @note This requires that the cloudContainer is attached and the write lock on the container be held. The copy should be modified with
-     * new content before the write lock is released, and thereafter should never be modified again.
-     */
-    static async makeNewVersion(cloudContainer, fromProps, versionType) {
-        const oldName = this.resolveCloudFileName(cloudContainer, fromProps);
-        const oldDb = this.parseDbFileName(oldName);
-        const newVersion = semver.inc(oldDb.version, versionType);
-        if (!newVersion)
-            throw new Error("invalid version");
-        const newName = this.makeDbFileName(oldDb.dbName, newVersion);
-        await cloudContainer.copyDatabase(oldName, newName);
-        return { oldName, newName };
-    }
-    /**
-     * Convert a WorkspaceDb.Props specification into a DbFileName. For cloud-based containers, this resolves to the dbName, incorporating the appropriate
-     * version. For file-based containers, this returns a local filename of a WorkspaceDb file with the extension ".itwin-workspace"
-     */
-    resolveDbFileName(props) {
-        const cloudContainer = this.cloudContainer;
-        if (undefined === cloudContainer)
-            return (0, path_1.join)(this.dirName, `${props.dbName}.${ITwinWorkspaceDb.fileExt}`); // local file, versions not allowed
-        return ITwinWorkspaceContainer.resolveCloudFileName(cloudContainer, props);
-    }
-    addWorkspaceDb(toAdd) {
-        if (undefined !== this._wsDbs.get(toAdd.dbName))
-            throw new Error(`workspaceDb ${toAdd.dbName} already exists in workspace`);
-        this._wsDbs.set(toAdd.dbName, toAdd);
-    }
-    getWorkspaceDb(props) {
-        const db = this._wsDbs.get(props.dbName) ?? new ITwinWorkspaceDb(props, this);
-        if (!db.isOpen)
-            db.open();
-        return db;
-    }
-    dropWorkspaceDb(toDrop) {
-        const name = toDrop.dbName;
-        const wsDb = this._wsDbs.get(name);
-        if (wsDb === toDrop) {
-            this._wsDbs.delete(name);
-            wsDb.close();
-        }
-    }
-    close() {
-        for (const [_name, db] of this._wsDbs)
-            db.close();
-        this._wsDbs.clear();
-        this.cloudContainer?.disconnect();
-    }
-    /** Delete all local files extracted by [[WorkspaceDb.getFile]] for this container. */
-    purgeContainerFiles() {
-        IModelJsFs_1.IModelJsFs.purgeDirSync(this.filesDir);
-    }
-}
-exports.ITwinWorkspaceContainer = ITwinWorkspaceContainer;
-/**
- * Implementation of WorkspaceDb
- * @internal
- */
-class ITwinWorkspaceDb {
-    constructor(props, container) {
-        /** the SQLiteDb for this WorkspaceDb*/
-        this.sqliteDb = new SQLiteDb_1.SQLiteDb();
-        /** called before db is closed */
-        this.onClose = new core_bentley_1.BeEvent();
-        ITwinWorkspaceContainer.validateDbName(props.dbName);
-        this.dbName = props.dbName;
-        this.container = container;
-        this.dbFileName = container.resolveDbFileName(props);
-        container.addWorkspaceDb(this);
-    }
-    /** true if this WorkspaceDb is currently open */
-    get isOpen() { return this.sqliteDb.isOpen; }
-    queryFileResource(rscName) {
-        const info = this.sqliteDb.nativeDb.queryEmbeddedFile(rscName);
-        if (undefined === info)
-            return undefined;
-        // since resource names can contain illegal characters, path separators, etc., we make the local file name from its hash, in hex.
-        let localFileName = (0, path_1.join)(this.container.filesDir, (0, crypto_1.createHash)("sha1").update(this.dbFileName).update(rscName).digest("hex"));
-        if (info.fileExt !== "") // since some applications may expect to see the extension, append it here if it was supplied.
-            localFileName = `${localFileName}.${info.fileExt}`;
-        return { localFileName, info };
-    }
-    open() {
-        this.sqliteDb.openDb(this.dbFileName, core_bentley_1.OpenMode.Readonly, this.container.cloudContainer);
-    }
-    close() {
-        if (this.isOpen) {
-            this.onClose.raiseEvent();
-            this.sqliteDb.closeDb();
-            this.container.dropWorkspaceDb(this);
-        }
-    }
-    getString(rscName) {
-        return this.sqliteDb.withSqliteStatement("SELECT value from strings WHERE id=?", (stmt) => {
-            stmt.bindString(1, rscName);
-            return core_bentley_1.DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValueString(0) : undefined;
-        });
-    }
-    /** Get a BlobIO reader for a blob WorkspaceResource.
-     * @note when finished, caller *must* call `close` on the BlobIO.
-     */
-    getBlobReader(rscName) {
-        return this.sqliteDb.withSqliteStatement("SELECT rowid from blobs WHERE id=?", (stmt) => {
-            stmt.bindString(1, rscName);
-            const blobReader = SQLiteDb_1.SQLiteDb.createBlobIO();
-            blobReader.open(this.sqliteDb.nativeDb, { tableName: "blobs", columnName: "value", row: stmt.getValueInteger(0) });
-            return blobReader;
-        });
-    }
-    getBlob(rscName) {
-        return this.sqliteDb.withSqliteStatement("SELECT value from blobs WHERE id=?", (stmt) => {
-            stmt.bindString(1, rscName);
-            return core_bentley_1.DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValueBlob(0) : undefined;
-        });
-    }
-    getFile(rscName, targetFileName) {
-        const file = this.queryFileResource(rscName);
-        if (!file)
-            return undefined;
-        const info = file.info;
-        const localFileName = targetFileName ?? file.localFileName;
-        // check whether the file is already up to date.
-        const stat = fs.existsSync(localFileName) && fs.statSync(localFileName);
-        if (stat && Math.round(stat.mtimeMs) === info.date && stat.size === info.size)
-            return localFileName; // yes, we're done
-        // extractEmbeddedFile fails if the file exists or if the directory does not exist
-        if (stat)
-            fs.removeSync(localFileName);
-        else
-            IModelJsFs_1.IModelJsFs.recursiveMkDirSync((0, path_1.dirname)(localFileName));
-        this.sqliteDb.nativeDb.extractEmbeddedFile({ name: rscName, localFileName });
-        const date = new Date(info.date);
-        fs.utimesSync(localFileName, date, date); // set the last-modified date of the file to match date in container
-        fs.chmodSync(localFileName, "0444"); // set file readonly
-        return localFileName;
-    }
-    prefetch(opts) {
-        const cloudContainer = this.container.cloudContainer;
-        if (cloudContainer === undefined)
-            throw new Error("no cloud container to prefetch");
-        return CloudSqlite_1.CloudSqlite.startCloudPrefetch(cloudContainer, this.dbFileName, opts);
-    }
-}
-exports.ITwinWorkspaceDb = ITwinWorkspaceDb;
-/** file extension for local WorkspaceDbs */
-ITwinWorkspaceDb.fileExt = "itwin-workspace";
-/**
- * An editable [[WorkspaceDb]]. This is used by administrators for creating and modifying `WorkspaceDb`s.
- * For cloud-backed containers, the write token must be obtained before this class may be used. Only one user at at time
- * may be editing.
- * @internal
- */
-class EditableWorkspaceDb extends ITwinWorkspaceDb {
-    static validateResourceName(name) {
-        ITwinWorkspaceContainer.noLeadingOrTrailingSpaces(name, "resource name");
-        if (name.length > 1024)
-            throw new Error("resource name too long");
-    }
-    validateResourceSize(val) {
-        const len = typeof val === "string" ? val.length : val.byteLength;
-        if (len > (1024 * 1024 * 1024)) // one gigabyte
-            throw new Error("value is too large");
-    }
-    open() {
-        this.sqliteDb.openDb(this.dbFileName, core_bentley_1.OpenMode.ReadWrite, this.container.cloudContainer);
-    }
-    getFileModifiedTime(localFileName) {
-        return Math.round(fs.statSync(localFileName).mtimeMs);
-    }
-    performWriteSql(rscName, sql, bind) {
-        this.sqliteDb.withSqliteStatement(sql, (stmt) => {
-            stmt.bindString(1, rscName);
-            bind?.(stmt);
-            const rc = stmt.step();
-            if (core_bentley_1.DbResult.BE_SQLITE_DONE !== rc) {
-                if (core_bentley_1.DbResult.BE_SQLITE_CONSTRAINT_PRIMARYKEY === rc)
-                    throw new core_common_1.IModelError(rc, `resource "${rscName}" already exists`);
-                throw new core_common_1.IModelError(rc, `workspace [${sql}]`);
-            }
-        });
-        this.sqliteDb.saveChanges();
-    }
-    async createDb(version) {
-        if (!this.container.cloudContainer) {
-            EditableWorkspaceDb.createEmpty(this.dbFileName);
-        }
-        else {
-            // currently the only way to create a workspaceDb in a cloud container is to create a temporary workspaceDb and upload it.
-            const tempDbFile = (0, path_1.join)(IModelHost_1.KnownLocations.tmpdir, `empty.${ITwinWorkspaceDb.fileExt}`);
-            if (fs.existsSync(tempDbFile))
-                IModelJsFs_1.IModelJsFs.removeSync(tempDbFile);
-            EditableWorkspaceDb.createEmpty(tempDbFile);
-            this.dbFileName = ITwinWorkspaceContainer.makeDbFileName(this.dbName, version);
-            await CloudSqlite_1.CloudSqlite.uploadDb(this.container.cloudContainer, { localFileName: tempDbFile, dbName: this.dbFileName });
-            IModelJsFs_1.IModelJsFs.removeSync(tempDbFile);
-        }
-        this.open();
-    }
-    /** Create a new, empty, EditableWorkspaceDb for importing Workspace resources. */
-    static createEmpty(fileName) {
-        const db = new SQLiteDb_1.SQLiteDb();
-        IModelJsFs_1.IModelJsFs.recursiveMkDirSync((0, path_1.dirname)(fileName));
-        db.createDb(fileName);
-        const timeStampCol = "lastMod TIMESTAMP NOT NULL DEFAULT(julianday('now'))";
-        db.executeSQL(`CREATE TABLE strings(id TEXT PRIMARY KEY NOT NULL,value TEXT,${timeStampCol})`);
-        db.executeSQL(`CREATE TABLE blobs(id TEXT PRIMARY KEY NOT NULL,value BLOB,${timeStampCol})`);
-        const createTrigger = (tableName) => {
-            db.executeSQL(`CREATE TRIGGER ${tableName}_timeStamp AFTER UPDATE ON ${tableName} WHEN old.lastMod=new.lastMod AND old.lastMod != julianday('now') BEGIN UPDATE ${tableName} SET lastMod=julianday('now') WHERE id=new.id; END`);
-        };
-        createTrigger("strings");
-        createTrigger("blobs");
-        db.closeDb(true);
-    }
-    /** Add a new string resource to this WorkspaceDb.
-     * @param rscName The name of the string resource.
-     * @param val The string to save.
-     */
-    addString(rscName, val) {
-        EditableWorkspaceDb.validateResourceName(rscName);
-        this.validateResourceSize(val);
-        this.performWriteSql(rscName, "INSERT INTO strings(id,value) VALUES(?,?)", (stmt) => stmt.bindString(2, val));
-    }
-    /** Update an existing string resource with a new value.
-     * @param rscName The name of the string resource.
-     * @param val The new value.
-     * @throws if rscName does not exist
-     */
-    updateString(rscName, val) {
-        this.validateResourceSize(val);
-        this.performWriteSql(rscName, "UPDATE strings SET value=?2 WHERE id=?1", (stmt) => stmt.bindString(2, val));
-    }
-    /** Remove a string resource. */
-    removeString(rscName) {
-        this.performWriteSql(rscName, "DELETE FROM strings WHERE id=?");
-    }
-    /** Add a new blob resource to this WorkspaceDb.
-     * @param rscName The name of the blob resource.
-     * @param val The blob to save.
-     */
-    addBlob(rscName, val) {
-        EditableWorkspaceDb.validateResourceName(rscName);
-        this.validateResourceSize(val);
-        this.performWriteSql(rscName, "INSERT INTO blobs(id,value) VALUES(?,?)", (stmt) => stmt.bindBlob(2, val));
-    }
-    /** Update an existing blob resource with a new value.
-     * @param rscName The name of the blob resource.
-     * @param val The new value.
-     * @throws if rscName does not exist
-     */
-    updateBlob(rscName, val) {
-        this.validateResourceSize(val);
-        this.performWriteSql(rscName, "UPDATE blobs SET value=?2 WHERE id=?1", (stmt) => stmt.bindBlob(2, val));
-    }
-    /** Get a BlobIO writer for a previously-added blob WorkspaceResource.
-     * @note after writing is complete, caller must call `close` on the BlobIO and must call `saveChanges` on the `db`.
-     */
-    getBlobWriter(rscName) {
-        return this.sqliteDb.withSqliteStatement("SELECT rowid from blobs WHERE id=?", (stmt) => {
-            stmt.bindString(1, rscName);
-            const blobWriter = SQLiteDb_1.SQLiteDb.createBlobIO();
-            blobWriter.open(this.sqliteDb.nativeDb, { tableName: "blobs", columnName: "value", row: stmt.getValueInteger(0), writeable: true });
-            return blobWriter;
-        });
-    }
-    /** Remove a blob resource. */
-    removeBlob(rscName) {
-        this.performWriteSql(rscName, "DELETE FROM blobs WHERE id=?");
-    }
-    /** Copy the contents of an existing local file into this WorkspaceDb as a file resource.
-     * @param rscName The name of the file resource.
-     * @param localFileName The name of a local file to be read.
-     * @param fileExt The extension (do not include the leading ".") to be appended to the generated fileName
-     * when this WorkspaceDb is extracted from the WorkspaceDb. By default the characters after the last "." in `localFileName`
-     * are used. Pass this argument to override that.
-     */
-    addFile(rscName, localFileName, fileExt) {
-        EditableWorkspaceDb.validateResourceName(rscName);
-        fileExt = fileExt ?? (0, path_1.extname)(localFileName);
-        if (fileExt?.[0] === ".")
-            fileExt = fileExt.slice(1);
-        this.sqliteDb.nativeDb.embedFile({ name: rscName, localFileName, date: this.getFileModifiedTime(localFileName), fileExt });
-    }
-    /** Replace an existing file resource with the contents of another local file.
-     * @param rscName The name of the file resource.
-     * @param localFileName The name of a local file to be read.
-     * @throws if rscName does not exist
-     */
-    updateFile(rscName, localFileName) {
-        this.queryFileResource(rscName); // throws if not present
-        this.sqliteDb.nativeDb.replaceEmbeddedFile({ name: rscName, localFileName, date: this.getFileModifiedTime(localFileName) });
-    }
-    /** Remove a file resource. */
-    removeFile(rscName) {
-        const file = this.queryFileResource(rscName);
-        if (undefined === file)
-            throw new Error(`file resource "${rscName}" does not exist`);
-        if (file && fs.existsSync(file.localFileName))
-            fs.unlinkSync(file.localFileName);
-        this.sqliteDb.nativeDb.removeEmbeddedFile(rscName);
-    }
-}
-exports.EditableWorkspaceDb = EditableWorkspaceDb;
+"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 Workspace
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EditableWorkspaceDb = exports.ITwinWorkspaceDb = exports.ITwinWorkspaceContainer = exports.ITwinWorkspace = exports.WorkspaceSetting = void 0;
+const crypto_1 = require("crypto");
+const fs = require("fs-extra");
+const path_1 = require("path");
+const semver = require("semver");
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const CloudSqlite_1 = require("../CloudSqlite");
+const IModelHost_1 = require("../IModelHost");
+const IModelJsFs_1 = require("../IModelJsFs");
+const SQLiteDb_1 = require("../SQLiteDb");
+const Settings_1 = require("./Settings");
+const SettingsSchemas_1 = require("./SettingsSchemas");
+/* eslint-disable @typescript-eslint/naming-convention */
+// cspell:ignore rowid primarykey julianday
+/** The Settings used by Workspace api
+ * @beta
+ */
+exports.WorkspaceSetting = {
+    Accounts: "cloud/accounts",
+    Containers: "cloud/containers",
+    Databases: "workspace/databases",
+};
+/** @internal */
+class ITwinWorkspace {
+    get cloudCache() {
+        if (undefined === this._cloudCache)
+            this._cloudCache = ITwinWorkspace.getSharedCloudCache();
+        return this._cloudCache;
+    }
+    static getSharedCloudCache() {
+        if (undefined === this._sharedCloudCache) {
+            const rootDir = (0, path_1.join)(IModelHost_1.IModelHost.cacheDir, "Workspace", "cloud");
+            IModelJsFs_1.IModelJsFs.recursiveMkDirSync(rootDir);
+            this._sharedCloudCache = CloudSqlite_1.CloudSqlite.createCloudCache({ rootDir, cacheSize: "20G", name: "workspace" });
+        }
+        return this._sharedCloudCache;
+    }
+    static finalize() {
+        if (this._sharedCloudCache) {
+            this._sharedCloudCache.destroy();
+            this._sharedCloudCache = undefined;
+        }
+    }
+    constructor(settings, opts) {
+        this._containers = new Map();
+        this.settings = settings;
+        this.containerDir = opts?.containerDir ?? (0, path_1.join)(IModelHost_1.IModelHost.cacheDir, "Workspace");
+        this._cloudCache = opts?.testCloudCache;
+        let settingsFiles = opts?.settingsFiles;
+        if (settingsFiles) {
+            if (typeof settingsFiles === "string")
+                settingsFiles = [settingsFiles];
+            settingsFiles.forEach((file) => settings.addFile(file, Settings_1.SettingsPriority.application));
+        }
+    }
+    addContainer(toAdd) {
+        if (undefined !== this._containers.get(toAdd.id))
+            throw new Error("container already exists in workspace");
+        this._containers.set(toAdd.id, toAdd);
+    }
+    findContainer(containerId) {
+        return this._containers.get(containerId);
+    }
+    getContainer(props, account) {
+        return this.findContainer(props.containerId) ?? new ITwinWorkspaceContainer(this, props, account);
+    }
+    getWorkspaceDbFromProps(dbProps, containerProps, account) {
+        return this.getContainer(containerProps, account).getWorkspaceDb(dbProps);
+    }
+    async getWorkspaceDb(dbAlias, tokenFunc) {
+        const dbProps = this.resolveDatabase(dbAlias);
+        const containerProps = this.resolveContainer(dbProps.containerName);
+        const account = containerProps.accountName !== "" ? this.resolveAccount(containerProps.accountName) : undefined;
+        let container = this.findContainer(containerProps.containerId);
+        if (undefined === container) {
+            if (tokenFunc && account)
+                containerProps.accessToken = await tokenFunc(containerProps, account);
+            container = this.getContainer(containerProps, account);
+        }
+        return container?.getWorkspaceDb(dbProps);
+    }
+    loadSettingsDictionary(settingRsc, db, priority) {
+        const setting = db.getString(settingRsc);
+        if (undefined === setting)
+            throw new Error(`could not load setting resource ${settingRsc}`);
+        this.settings.addJson(`${db.container.id}/${db.dbName}/${settingRsc}`, priority, setting);
+    }
+    close() {
+        this.settings.close();
+        for (const [_id, container] of this._containers)
+            container.close();
+        this._containers.clear();
+    }
+    resolveAccount(accountName) {
+        const resolved = this.settings.resolveSetting(exports.WorkspaceSetting.Accounts, (val) => {
+            if (Array.isArray(val)) {
+                for (const entry of val) {
+                    if (typeof entry === "object" && entry.name === accountName)
+                        return SettingsSchemas_1.SettingsSchemas.validateArrayObject(entry, exports.WorkspaceSetting.Accounts, accountName);
+                }
+            }
+            return undefined; // keep going through all settings dictionaries
+        });
+        if (resolved === undefined)
+            throw new Error(`no setting "${exports.WorkspaceSetting.Accounts}" entry for "${accountName}"`);
+        return resolved;
+    }
+    resolveContainer(containerName) {
+        const resolved = this.settings.resolveSetting(exports.WorkspaceSetting.Containers, (val) => {
+            if (Array.isArray(val)) {
+                for (const entry of val) {
+                    if (typeof entry === "object" && entry.name === containerName)
+                        return SettingsSchemas_1.SettingsSchemas.validateArrayObject(entry, exports.WorkspaceSetting.Containers, containerName);
+                }
+            }
+            return undefined; // keep going through all settings dictionaries
+        });
+        if (resolved === undefined)
+            throw new Error(`no setting "${exports.WorkspaceSetting.Containers}" entry for "${containerName}"`);
+        return resolved;
+    }
+    resolveDatabase(databaseName) {
+        const resolved = this.settings.resolveSetting(exports.WorkspaceSetting.Databases, (val) => {
+            if (Array.isArray(val)) {
+                for (const entry of val) {
+                    if (typeof entry === "object" && entry.name === databaseName)
+                        return SettingsSchemas_1.SettingsSchemas.validateArrayObject(entry, exports.WorkspaceSetting.Databases, databaseName);
+                }
+            }
+            return undefined; // keep going through all settings dictionaries
+        });
+        if (resolved === undefined)
+            throw new Error(`no setting "${exports.WorkspaceSetting.Databases}" entry for "${databaseName}"`);
+        return resolved;
+    }
+}
+exports.ITwinWorkspace = ITwinWorkspace;
+/** @internal */
+class ITwinWorkspaceContainer {
+    get dirName() { return (0, path_1.join)(this.workspace.containerDir, this.id); }
+    static noLeadingOrTrailingSpaces(name, msg) {
+        if (name.trim() !== name)
+            throw new Error(`${msg} [${name}] may not have leading or tailing spaces`);
+    }
+    /** rules for ContainerIds (from Azure, see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata)
+     *  - may only contain lower case letters, numbers or dashes
+     *  - may not start or end with with a dash nor have more than one dash in a row
+     *  - may not be shorter than 3 or longer than 63 characters
+     */
+    static validateContainerId(id) {
+        if (!/^(?=.{3,63}$)[a-z0-9]+(-[a-z0-9]+)*$/g.test(id))
+            throw new Error(`invalid containerId: [${id}]`);
+    }
+    static validateDbName(dbName) {
+        if (dbName === "" || dbName.length > 255 || /[#\.<>:"/\\"`'|?*\u0000-\u001F]/g.test(dbName) || /^(con|prn|aux|nul|com\d|lpt\d)$/i.test(dbName))
+            throw new Error(`invalid dbName: [${dbName}]`);
+        this.noLeadingOrTrailingSpaces(dbName, "dbName");
+    }
+    constructor(workspace, props, account) {
+        this._wsDbs = new Map();
+        ITwinWorkspaceContainer.validateContainerId(props.containerId);
+        this.workspace = workspace;
+        this.id = props.containerId;
+        if (account?.accessName && account.storageType)
+            this.cloudContainer = CloudSqlite_1.CloudSqlite.createCloudContainer({ accessToken: "", ...props, ...account });
+        workspace.addContainer(this);
+        this.filesDir = (0, path_1.join)(this.dirName, "Files");
+        const cloudContainer = this.cloudContainer;
+        if (undefined === cloudContainer)
+            return;
+        cloudContainer.connect(this.workspace.cloudCache);
+        if (false !== props.syncOnConnect) {
+            try {
+                cloudContainer.checkForChanges();
+            }
+            catch (e) {
+                // must be offline
+            }
+        }
+    }
+    static validateVersion(version) {
+        version = version ?? "1.0.0";
+        if (version) {
+            const opts = { loose: true, includePrerelease: true };
+            // clean allows prerelease, so try it first. If that fails attempt to coerce it (coerce strips prerelease even if you say not to.)
+            const semVersion = semver.clean(version, opts) ?? semver.coerce(version, opts)?.version;
+            if (!semVersion)
+                throw new Error("invalid version specification");
+            version = semVersion;
+        }
+        return version;
+    }
+    static parseDbFileName(dbFileName) {
+        const parts = dbFileName.split(":");
+        return { dbName: parts[0], version: parts[1] };
+    }
+    static makeDbFileName(dbName, version) {
+        return `${dbName}:${this.validateVersion(version)}`;
+    }
+    static resolveCloudFileName(cloudContainer, props) {
+        const dbName = props.dbName;
+        const dbs = cloudContainer.queryDatabases(`${dbName}*`); // get all databases that start with dbName
+        const versions = [];
+        for (const db of dbs) {
+            const thisDb = ITwinWorkspaceContainer.parseDbFileName(db);
+            if (thisDb.dbName === dbName && "string" === typeof thisDb.version && thisDb.version.length > 0)
+                versions.push(thisDb.version);
+        }
+        if (versions.length === 0)
+            versions[0] = "1.0.0";
+        const range = props.version ?? "*";
+        try {
+            const version = semver.maxSatisfying(versions, range, { loose: true, includePrerelease: props.includePrerelease });
+            if (version)
+                return `${dbName}:${version}`;
+        }
+        catch (e) {
+        }
+        throw new Error(`No version of [${dbName}] available for "${range}"`);
+    }
+    /**
+     * Create a copy of an existing [[WorkspaceDb]] in a cloud container with a new version number.
+     * @param cloudContainer The attached cloud container holding the existing WorkspaceDb
+     * @param fromProps Properties that describe the source WorkspaceDb for the new version
+     * @param versionType The type of version increment to apply to the existing version.
+     * @note This requires that the cloudContainer is attached and the write lock on the container be held. The copy should be modified with
+     * new content before the write lock is released, and thereafter should never be modified again.
+     */
+    static async makeNewVersion(cloudContainer, fromProps, versionType) {
+        const oldName = this.resolveCloudFileName(cloudContainer, fromProps);
+        const oldDb = this.parseDbFileName(oldName);
+        const newVersion = semver.inc(oldDb.version, versionType);
+        if (!newVersion)
+            throw new Error("invalid version");
+        const newName = this.makeDbFileName(oldDb.dbName, newVersion);
+        await cloudContainer.copyDatabase(oldName, newName);
+        return { oldName, newName };
+    }
+    /**
+     * Convert a WorkspaceDb.Props specification into a DbFileName. For cloud-based containers, this resolves to the dbName, incorporating the appropriate
+     * version. For file-based containers, this returns a local filename of a WorkspaceDb file with the extension ".itwin-workspace"
+     */
+    resolveDbFileName(props) {
+        const cloudContainer = this.cloudContainer;
+        if (undefined === cloudContainer)
+            return (0, path_1.join)(this.dirName, `${props.dbName}.${ITwinWorkspaceDb.fileExt}`); // local file, versions not allowed
+        return ITwinWorkspaceContainer.resolveCloudFileName(cloudContainer, props);
+    }
+    addWorkspaceDb(toAdd) {
+        if (undefined !== this._wsDbs.get(toAdd.dbName))
+            throw new Error(`workspaceDb ${toAdd.dbName} already exists in workspace`);
+        this._wsDbs.set(toAdd.dbName, toAdd);
+    }
+    getWorkspaceDb(props) {
+        const db = this._wsDbs.get(props.dbName) ?? new ITwinWorkspaceDb(props, this);
+        if (!db.isOpen)
+            db.open();
+        return db;
+    }
+    dropWorkspaceDb(toDrop) {
+        const name = toDrop.dbName;
+        const wsDb = this._wsDbs.get(name);
+        if (wsDb === toDrop) {
+            this._wsDbs.delete(name);
+            wsDb.close();
+        }
+    }
+    close() {
+        for (const [_name, db] of this._wsDbs)
+            db.close();
+        this._wsDbs.clear();
+        this.cloudContainer?.disconnect();
+    }
+    /** Delete all local files extracted by [[WorkspaceDb.getFile]] for this container. */
+    purgeContainerFiles() {
+        IModelJsFs_1.IModelJsFs.purgeDirSync(this.filesDir);
+    }
+}
+exports.ITwinWorkspaceContainer = ITwinWorkspaceContainer;
+/**
+ * Implementation of WorkspaceDb
+ * @internal
+ */
+class ITwinWorkspaceDb {
+    /** true if this WorkspaceDb is currently open */
+    get isOpen() { return this.sqliteDb.isOpen; }
+    queryFileResource(rscName) {
+        const info = this.sqliteDb.nativeDb.queryEmbeddedFile(rscName);
+        if (undefined === info)
+            return undefined;
+        // since resource names can contain illegal characters, path separators, etc., we make the local file name from its hash, in hex.
+        let localFileName = (0, path_1.join)(this.container.filesDir, (0, crypto_1.createHash)("sha1").update(this.dbFileName).update(rscName).digest("hex"));
+        if (info.fileExt !== "") // since some applications may expect to see the extension, append it here if it was supplied.
+            localFileName = `${localFileName}.${info.fileExt}`;
+        return { localFileName, info };
+    }
+    constructor(props, container) {
+        /** the SQLiteDb for this WorkspaceDb*/
+        this.sqliteDb = new SQLiteDb_1.SQLiteDb();
+        /** called before db is closed */
+        this.onClose = new core_bentley_1.BeEvent();
+        ITwinWorkspaceContainer.validateDbName(props.dbName);
+        this.dbName = props.dbName;
+        this.container = container;
+        this.dbFileName = container.resolveDbFileName(props);
+        container.addWorkspaceDb(this);
+    }
+    open() {
+        this.sqliteDb.openDb(this.dbFileName, core_bentley_1.OpenMode.Readonly, this.container.cloudContainer);
+    }
+    close() {
+        if (this.isOpen) {
+            this.onClose.raiseEvent();
+            this.sqliteDb.closeDb();
+            this.container.dropWorkspaceDb(this);
+        }
+    }
+    getString(rscName) {
+        return this.sqliteDb.withSqliteStatement("SELECT value from strings WHERE id=?", (stmt) => {
+            stmt.bindString(1, rscName);
+            return core_bentley_1.DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValueString(0) : undefined;
+        });
+    }
+    /** Get a BlobIO reader for a blob WorkspaceResource.
+     * @note when finished, caller *must* call `close` on the BlobIO.
+     */
+    getBlobReader(rscName) {
+        return this.sqliteDb.withSqliteStatement("SELECT rowid from blobs WHERE id=?", (stmt) => {
+            stmt.bindString(1, rscName);
+            const blobReader = SQLiteDb_1.SQLiteDb.createBlobIO();
+            blobReader.open(this.sqliteDb.nativeDb, { tableName: "blobs", columnName: "value", row: stmt.getValueInteger(0) });
+            return blobReader;
+        });
+    }
+    getBlob(rscName) {
+        return this.sqliteDb.withSqliteStatement("SELECT value from blobs WHERE id=?", (stmt) => {
+            stmt.bindString(1, rscName);
+            return core_bentley_1.DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValueBlob(0) : undefined;
+        });
+    }
+    getFile(rscName, targetFileName) {
+        const file = this.queryFileResource(rscName);
+        if (!file)
+            return undefined;
+        const info = file.info;
+        const localFileName = targetFileName ?? file.localFileName;
+        // check whether the file is already up to date.
+        const stat = fs.existsSync(localFileName) && fs.statSync(localFileName);
+        if (stat && Math.round(stat.mtimeMs) === info.date && stat.size === info.size)
+            return localFileName; // yes, we're done
+        // extractEmbeddedFile fails if the file exists or if the directory does not exist
+        if (stat)
+            fs.removeSync(localFileName);
+        else
+            IModelJsFs_1.IModelJsFs.recursiveMkDirSync((0, path_1.dirname)(localFileName));
+        this.sqliteDb.nativeDb.extractEmbeddedFile({ name: rscName, localFileName });
+        const date = new Date(info.date);
+        fs.utimesSync(localFileName, date, date); // set the last-modified date of the file to match date in container
+        fs.chmodSync(localFileName, "0444"); // set file readonly
+        return localFileName;
+    }
+    prefetch(opts) {
+        const cloudContainer = this.container.cloudContainer;
+        if (cloudContainer === undefined)
+            throw new Error("no cloud container to prefetch");
+        return CloudSqlite_1.CloudSqlite.startCloudPrefetch(cloudContainer, this.dbFileName, opts);
+    }
+}
+/** file extension for local WorkspaceDbs */
+ITwinWorkspaceDb.fileExt = "itwin-workspace";
+exports.ITwinWorkspaceDb = ITwinWorkspaceDb;
+/**
+ * An editable [[WorkspaceDb]]. This is used by administrators for creating and modifying `WorkspaceDb`s.
+ * For cloud-backed containers, the write token must be obtained before this class may be used. Only one user at at time
+ * may be editing.
+ * @internal
+ */
+class EditableWorkspaceDb extends ITwinWorkspaceDb {
+    static validateResourceName(name) {
+        ITwinWorkspaceContainer.noLeadingOrTrailingSpaces(name, "resource name");
+        if (name.length > 1024)
+            throw new Error("resource name too long");
+    }
+    validateResourceSize(val) {
+        const len = typeof val === "string" ? val.length : val.byteLength;
+        if (len > (1024 * 1024 * 1024)) // one gigabyte
+            throw new Error("value is too large");
+    }
+    open() {
+        this.sqliteDb.openDb(this.dbFileName, core_bentley_1.OpenMode.ReadWrite, this.container.cloudContainer);
+    }
+    getFileModifiedTime(localFileName) {
+        return Math.round(fs.statSync(localFileName).mtimeMs);
+    }
+    performWriteSql(rscName, sql, bind) {
+        this.sqliteDb.withSqliteStatement(sql, (stmt) => {
+            stmt.bindString(1, rscName);
+            bind?.(stmt);
+            const rc = stmt.step();
+            if (core_bentley_1.DbResult.BE_SQLITE_DONE !== rc) {
+                if (core_bentley_1.DbResult.BE_SQLITE_CONSTRAINT_PRIMARYKEY === rc)
+                    throw new core_common_1.IModelError(rc, `resource "${rscName}" already exists`);
+                throw new core_common_1.IModelError(rc, `workspace [${sql}]`);
+            }
+        });
+        this.sqliteDb.saveChanges();
+    }
+    async createDb(version) {
+        if (!this.container.cloudContainer) {
+            EditableWorkspaceDb.createEmpty(this.dbFileName);
+        }
+        else {
+            // currently the only way to create a workspaceDb in a cloud container is to create a temporary workspaceDb and upload it.
+            const tempDbFile = (0, path_1.join)(IModelHost_1.KnownLocations.tmpdir, `empty.${ITwinWorkspaceDb.fileExt}`);
+            if (fs.existsSync(tempDbFile))
+                IModelJsFs_1.IModelJsFs.removeSync(tempDbFile);
+            EditableWorkspaceDb.createEmpty(tempDbFile);
+            this.dbFileName = ITwinWorkspaceContainer.makeDbFileName(this.dbName, version);
+            await CloudSqlite_1.CloudSqlite.uploadDb(this.container.cloudContainer, { localFileName: tempDbFile, dbName: this.dbFileName });
+            IModelJsFs_1.IModelJsFs.removeSync(tempDbFile);
+        }
+        this.open();
+    }
+    /** Create a new, empty, EditableWorkspaceDb for importing Workspace resources. */
+    static createEmpty(fileName) {
+        const db = new SQLiteDb_1.SQLiteDb();
+        IModelJsFs_1.IModelJsFs.recursiveMkDirSync((0, path_1.dirname)(fileName));
+        db.createDb(fileName);
+        const timeStampCol = "lastMod TIMESTAMP NOT NULL DEFAULT(julianday('now'))";
+        db.executeSQL(`CREATE TABLE strings(id TEXT PRIMARY KEY NOT NULL,value TEXT,${timeStampCol})`);
+        db.executeSQL(`CREATE TABLE blobs(id TEXT PRIMARY KEY NOT NULL,value BLOB,${timeStampCol})`);
+        const createTrigger = (tableName) => {
+            db.executeSQL(`CREATE TRIGGER ${tableName}_timeStamp AFTER UPDATE ON ${tableName} WHEN old.lastMod=new.lastMod AND old.lastMod != julianday('now') BEGIN UPDATE ${tableName} SET lastMod=julianday('now') WHERE id=new.id; END`);
+        };
+        createTrigger("strings");
+        createTrigger("blobs");
+        db.closeDb(true);
+    }
+    /** Add a new string resource to this WorkspaceDb.
+     * @param rscName The name of the string resource.
+     * @param val The string to save.
+     */
+    addString(rscName, val) {
+        EditableWorkspaceDb.validateResourceName(rscName);
+        this.validateResourceSize(val);
+        this.performWriteSql(rscName, "INSERT INTO strings(id,value) VALUES(?,?)", (stmt) => stmt.bindString(2, val));
+    }
+    /** Update an existing string resource with a new value.
+     * @param rscName The name of the string resource.
+     * @param val The new value.
+     * @throws if rscName does not exist
+     */
+    updateString(rscName, val) {
+        this.validateResourceSize(val);
+        this.performWriteSql(rscName, "UPDATE strings SET value=?2 WHERE id=?1", (stmt) => stmt.bindString(2, val));
+    }
+    /** Remove a string resource. */
+    removeString(rscName) {
+        this.performWriteSql(rscName, "DELETE FROM strings WHERE id=?");
+    }
+    /** Add a new blob resource to this WorkspaceDb.
+     * @param rscName The name of the blob resource.
+     * @param val The blob to save.
+     */
+    addBlob(rscName, val) {
+        EditableWorkspaceDb.validateResourceName(rscName);
+        this.validateResourceSize(val);
+        this.performWriteSql(rscName, "INSERT INTO blobs(id,value) VALUES(?,?)", (stmt) => stmt.bindBlob(2, val));
+    }
+    /** Update an existing blob resource with a new value.
+     * @param rscName The name of the blob resource.
+     * @param val The new value.
+     * @throws if rscName does not exist
+     */
+    updateBlob(rscName, val) {
+        this.validateResourceSize(val);
+        this.performWriteSql(rscName, "UPDATE blobs SET value=?2 WHERE id=?1", (stmt) => stmt.bindBlob(2, val));
+    }
+    /** Get a BlobIO writer for a previously-added blob WorkspaceResource.
+     * @note after writing is complete, caller must call `close` on the BlobIO and must call `saveChanges` on the `db`.
+     */
+    getBlobWriter(rscName) {
+        return this.sqliteDb.withSqliteStatement("SELECT rowid from blobs WHERE id=?", (stmt) => {
+            stmt.bindString(1, rscName);
+            const blobWriter = SQLiteDb_1.SQLiteDb.createBlobIO();
+            blobWriter.open(this.sqliteDb.nativeDb, { tableName: "blobs", columnName: "value", row: stmt.getValueInteger(0), writeable: true });
+            return blobWriter;
+        });
+    }
+    /** Remove a blob resource. */
+    removeBlob(rscName) {
+        this.performWriteSql(rscName, "DELETE FROM blobs WHERE id=?");
+    }
+    /** Copy the contents of an existing local file into this WorkspaceDb as a file resource.
+     * @param rscName The name of the file resource.
+     * @param localFileName The name of a local file to be read.
+     * @param fileExt The extension (do not include the leading ".") to be appended to the generated fileName
+     * when this WorkspaceDb is extracted from the WorkspaceDb. By default the characters after the last "." in `localFileName`
+     * are used. Pass this argument to override that.
+     */
+    addFile(rscName, localFileName, fileExt) {
+        EditableWorkspaceDb.validateResourceName(rscName);
+        fileExt = fileExt ?? (0, path_1.extname)(localFileName);
+        if (fileExt?.[0] === ".")
+            fileExt = fileExt.slice(1);
+        this.sqliteDb.nativeDb.embedFile({ name: rscName, localFileName, date: this.getFileModifiedTime(localFileName), fileExt });
+    }
+    /** Replace an existing file resource with the contents of another local file.
+     * @param rscName The name of the file resource.
+     * @param localFileName The name of a local file to be read.
+     * @throws if rscName does not exist
+     */
+    updateFile(rscName, localFileName) {
+        this.queryFileResource(rscName); // throws if not present
+        this.sqliteDb.nativeDb.replaceEmbeddedFile({ name: rscName, localFileName, date: this.getFileModifiedTime(localFileName) });
+    }
+    /** Remove a file resource. */
+    removeFile(rscName) {
+        const file = this.queryFileResource(rscName);
+        if (undefined === file)
+            throw new Error(`file resource "${rscName}" does not exist`);
+        if (file && fs.existsSync(file.localFileName))
+            fs.unlinkSync(file.localFileName);
+        this.sqliteDb.nativeDb.removeEmbeddedFile(rscName);
+    }
+}
+exports.EditableWorkspaceDb = EditableWorkspaceDb;
 //# sourceMappingURL=Workspace.js.map