@itwin/core-backend 3.0.0-dev.98 → 3.1.0-dev.0

package/lib/cjs/workspace/Workspace.js

@@ -0,0 +1,372 @@
+"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 = void 0;
+const crypto_1 = require("crypto");
+const fs = require("fs-extra");
+const path_1 = require("path");
+const imodeljs_native_1 = require("@bentley/imodeljs-native");
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const IModelJsFs_1 = require("../IModelJsFs");
+const SQLiteDb_1 = require("../SQLiteDb");
+// cspell:ignore rowid
+/** The names of Settings used by Workspace
+ * @beta
+ */
+var WorkspaceSetting;
+(function (WorkspaceSetting) {
+    WorkspaceSetting["ContainerAlias"] = "workspace/container/alias";
+})(WorkspaceSetting || (WorkspaceSetting = {}));
+const workspaceDbFileExt = "itwin-workspace";
+/** @internal */
+class ITwinWorkspace {
+    constructor(settings, opts) {
+        var _a;
+        this._containers = new Map();
+        this.settings = settings;
+        this.containerDir = (_a = opts === null || opts === void 0 ? void 0 : opts.containerDir) !== null && _a !== void 0 ? _a : (0, path_1.join)(imodeljs_native_1.NativeLibrary.defaultLocalDir, "iTwin", "Workspace");
+    }
+    addContainer(toAdd) {
+        if (undefined !== this._containers.get(toAdd.id))
+            throw new Error("container already exists in workspace");
+        this._containers.set(toAdd.id, toAdd);
+    }
+    getContainer(props) {
+        var _a;
+        const id = this.resolveContainerId(props);
+        if (undefined === id)
+            throw new Error(`can't resolve workspace container name [${props.containerName}]`);
+        return (_a = this._containers.get(id)) !== null && _a !== void 0 ? _a : new ITwinWorkspaceContainer(this, id);
+    }
+    async getWorkspaceDb(props) {
+        return this.getContainer(props).getWorkspaceDb(props);
+    }
+    async loadSettingsDictionary(settingRsc, priority) {
+        const db = await this.getWorkspaceDb(settingRsc);
+        const setting = db.getString(settingRsc.rscName);
+        if (undefined === setting)
+            throw new Error(`could not load setting resource ${settingRsc.rscName}`);
+        this.settings.addJson(`${db.container.id}/${db.dbName}/${settingRsc.rscName}`, priority, setting);
+    }
+    close() {
+        this.settings.close();
+        for (const [_id, container] of this._containers)
+            container.close();
+        this._containers.clear();
+    }
+    resolveContainerId(props) {
+        if (props.containerId)
+            return props.containerId; // if the container id is supplied, just use it
+        const id = this.settings.resolveSetting(WorkspaceSetting.ContainerAlias, (val) => {
+            if (Array.isArray(val)) {
+                for (const entry of val) {
+                    if (typeof entry === "object" && entry.name === props.containerName && typeof entry.id === "string")
+                        return entry.id;
+                }
+            }
+            return undefined; // keep going through all settings dictionaries
+        }, props.containerName);
+        if (undefined === id)
+            throw new Error("Unable to resolve container id.");
+        return id;
+    }
+}
+exports.ITwinWorkspace = ITwinWorkspace;
+/** @internal */
+class ITwinWorkspaceContainer {
+    constructor(workspace, id) {
+        this._wsDbs = new Map();
+        ITwinWorkspaceContainer.validateContainerId(id);
+        this.workspace = workspace;
+        this.id = id;
+        workspace.addContainer(this);
+        this.filesDir = (0, path_1.join)(this.dirName, "Files");
+    }
+    get dirName() { return (0, path_1.join)(this.workspace.containerDir, this.id); }
+    /** 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}]`);
+    }
+    addWorkspaceDb(toAdd) {
+        if (undefined !== this._wsDbs.get(toAdd.dbName))
+            throw new Error("dbName already exists in workspace");
+        this._wsDbs.set(toAdd.dbName, toAdd);
+    }
+    async getWorkspaceDb(props) {
+        var _a;
+        const db = (_a = this._wsDbs.get(props.dbName)) !== null && _a !== void 0 ? _a : new ITwinWorkspaceDb(props.dbName, this);
+        if (!db.isOpen) {
+            if (props.cloudProps)
+                await imodeljs_native_1.CloudSqlite.downloadDb({ ...db, ...props.cloudProps, containerId: this.id });
+            db.open();
+        }
+        return db;
+    }
+    dropWorkspaceDb(toDrop) {
+        const name = toDrop.dbName;
+        const wsDb = this._wsDbs.get(name);
+        if (wsDb === toDrop) {
+            wsDb.close();
+            this._wsDbs.delete(name);
+        }
+    }
+    close() {
+        for (const [_name, db] of this._wsDbs)
+            db.close();
+        this._wsDbs.clear();
+    }
+    purgeContainerFiles() {
+        IModelJsFs_1.IModelJsFs.purgeDirSync(this.filesDir);
+    }
+}
+exports.ITwinWorkspaceContainer = ITwinWorkspaceContainer;
+/**
+ * A local file holding a WorkspaceDb.
+ * @beta
+ */
+class ITwinWorkspaceDb {
+    constructor(dbName, container) {
+        this.sqliteDb = new SQLiteDb_1.SQLiteDb(); // eslint-disable-line @typescript-eslint/naming-convention
+        this.onClosed = new core_bentley_1.BeEvent();
+        ITwinWorkspaceDb.validateDbName(dbName);
+        this.dbName = dbName;
+        this.container = container;
+        this.localFile = (0, path_1.join)(container.dirName, `${dbName}.${workspaceDbFileExt}`);
+        container.addWorkspaceDb(this);
+    }
+    static noLeadingOrTrailingSpaces(name, msg) {
+        if (name.trim() !== name)
+            throw new Error(`${msg} [${name}] may not have leading or tailing spaces`);
+    }
+    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");
+    }
+    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(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.localFile, core_bentley_1.OpenMode.Readonly);
+    }
+    close() {
+        if (this.isOpen) {
+            this.onClosed.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 = new imodeljs_native_1.IModelJsNative.BlobIO();
+            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 !== null && targetFileName !== void 0 ? 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;
+    }
+}
+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.
+ * @beta
+ */
+class EditableWorkspaceDb extends ITwinWorkspaceDb {
+    constructor() {
+        super(...arguments);
+        this._isCloudOpen = false;
+    }
+    static validateResourceName(name) {
+        ITwinWorkspaceDb.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.localFile, core_bentley_1.OpenMode.ReadWrite);
+    }
+    close() {
+        if (this._isCloudOpen) {
+            //  this.db.nativeDb.flushCloudUpload(); TODO: add back when available
+            this._isCloudOpen = false;
+        }
+        super.close();
+    }
+    getFileModifiedTime(localFileName) {
+        return Math.round(fs.statSync(localFileName).mtimeMs);
+    }
+    performWriteSql(rscName, sql, bind) {
+        this.sqliteDb.withSqliteStatement(sql, (stmt) => {
+            stmt.bindString(1, rscName);
+            bind === null || bind === void 0 ? void 0 : bind(stmt);
+            const rc = stmt.step();
+            if (core_bentley_1.DbResult.BE_SQLITE_DONE !== rc)
+                throw new core_common_1.IModelError(rc, "workspace write error");
+        });
+        this.sqliteDb.saveChanges();
+    }
+    /** Create a new, empty, EditableWorkspaceDb for importing Workspace resources. */
+    create() {
+        IModelJsFs_1.IModelJsFs.recursiveMkDirSync((0, path_1.dirname)(this.localFile));
+        this.sqliteDb.createDb(this.localFile);
+        this.sqliteDb.executeSQL("CREATE TABLE strings(id TEXT PRIMARY KEY NOT NULL,value TEXT)");
+        this.sqliteDb.executeSQL("CREATE TABLE blobs(id TEXT PRIMARY KEY NOT NULL,value BLOB)");
+        this.sqliteDb.saveChanges();
+    }
+    static async cloneVersion(oldVersion, newVersion, cloudProps) {
+        return imodeljs_native_1.CloudSqlite.copyDb(oldVersion, newVersion, cloudProps);
+    }
+    async upload(cloudProps) {
+        return imodeljs_native_1.CloudSqlite.uploadDb({ ...cloudProps, ...this });
+    }
+    /** 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 = new imodeljs_native_1.IModelJsNative.BlobIO();
+            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 !== null && fileExt !== void 0 ? fileExt : (0, path_1.extname)(localFileName);
+        if ((fileExt === null || fileExt === void 0 ? void 0 : 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 a 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

package/lib/cjs/workspace/Workspace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Workspace.js","sourceRoot":"","sources":["../../../src/workspace/Workspace.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,mCAAoC;AACpC,+BAA+B;AAC/B,+BAA8C;AAC9C,8DAAsF;AACtF,sDAA4E;AAC5E,oDAA8E;AAC9E,8CAA2C;AAC3C,0CAAuC;AAIvC,sBAAsB;AAEtB;;GAEG;AACH,IAAK,gBAEJ;AAFD,WAAK,gBAAgB;IACnB,gEAA4C,CAAA;AAC9C,CAAC,EAFI,gBAAgB,KAAhB,gBAAgB,QAEpB;AAED,MAAM,kBAAkB,GAAG,iBAAiB,CAAC;AAyL7C,gBAAgB;AAChB,MAAa,cAAc;IAKzB,YAAmB,QAAkB,EAAE,IAAoB;;QAJnD,gBAAW,GAAG,IAAI,GAAG,EAAiD,CAAC;QAK7E,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,YAAY,mCAAI,IAAA,WAAI,EAAC,+BAAa,CAAC,eAAe,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IACtG,CAAC;IAEM,YAAY,CAAC,KAA8B;QAChD,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC3D,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;IACM,YAAY,CAAC,KAA8B;;QAChD,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,SAAS,KAAK,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,2CAA2C,KAAK,CAAC,aAAa,GAAG,CAAC,CAAC;QAErF,OAAO,MAAA,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,mCAAI,IAAI,uBAAuB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC3E,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,KAAuB;QACjD,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;IAEM,KAAK,CAAC,sBAAsB,CAAC,UAAkC,EAAE,QAA0B;QAChG,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACjD,MAAM,OAAO,GAAG,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,SAAS,KAAK,OAAO;YACvB,MAAM,IAAI,KAAK,CAAC,mCAAmC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;QAE3E,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,MAAM,IAAI,UAAU,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACpG,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACtB,KAAK,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,WAAW;YAC7C,SAAS,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;IAEM,kBAAkB,CAAC,KAA8B;QACtD,IAAI,KAAK,CAAC,WAAW;YACnB,OAAO,KAAK,CAAC,WAAW,CAAC,CAAC,+CAA+C;QAE3E,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,gBAAgB,CAAC,cAAc,EAAE,CAAC,GAAG,EAAE,EAAE;YAC/E,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBACtB,KAAK,MAAM,KAAK,IAAI,GAAG,EAAE;oBACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,aAAa,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ;wBACjG,OAAO,KAAK,CAAC,EAAE,CAAC;iBACnB;aACF;YACD,OAAO,SAAS,CAAC,CAAC,+CAA+C;QACnE,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;QACxB,IAAI,SAAS,KAAK,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AA5DD,wCA4DC;AAED,gBAAgB;AAChB,MAAa,uBAAuB;IAiBlC,YAAmB,SAAyB,EAAE,EAAwB;QAb9D,WAAM,GAAG,IAAI,GAAG,EAAqC,CAAC;QAc5D,uBAAuB,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC;QAChD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,IAAA,WAAI,EAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAlBD,IAAW,OAAO,KAAK,OAAO,IAAA,WAAI,EAAC,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAE3E;;;;OAIG;IACK,MAAM,CAAC,mBAAmB,CAAC,EAAwB;QACzD,IAAI,CAAC,uCAAuC,CAAC,IAAI,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAC;IACpD,CAAC;IAUM,cAAc,CAAC,KAAuB;QAC3C,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC;YAC7C,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,KAAkD;;QAC5E,MAAM,EAAE,GAAG,MAAA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,mCAAI,IAAI,gBAAgB,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACrF,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE;YACd,IAAI,KAAK,CAAC,UAAU;gBAClB,MAAM,6BAAW,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,EAAE,GAAG,KAAK,CAAC,UAAU,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;YACrF,EAAE,CAAC,IAAI,EAAE,CAAC;SACX;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,eAAe,CAAC,MAAmB;QACxC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,IAAI,KAAK,MAAM,EAAE;YACnB,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAC1B;IACH,CAAC;IAEM,KAAK;QACV,KAAK,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,MAAM;YACnC,EAAE,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;IAEM,mBAAmB;QACxB,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AA3DD,0DA2DC;AAED;;;GAGG;AACH,MAAa,gBAAgB;IA+B3B,YAAmB,MAAuB,EAAE,SAA6B;QA9BzD,aAAQ,GAAG,IAAI,mBAAQ,EAAE,CAAC,CAAC,2DAA2D;QAItF,aAAQ,GAAG,IAAI,sBAAO,EAAc,CAAC;QA2BnD,gBAAgB,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,IAAA,WAAI,EAAC,SAAS,CAAC,OAAO,EAAE,GAAG,MAAM,IAAI,kBAAkB,EAAE,CAAC,CAAC;QAC5E,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IA9BS,MAAM,CAAC,yBAAyB,CAAC,IAAY,EAAE,GAAW;QAClE,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,IAAI;YACtB,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,KAAK,IAAI,0CAA0C,CAAC,CAAC;IAC/E,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,MAAuB;QACnD,IAAI,MAAM,KAAK,EAAE,IAAI,MAAM,CAAC,MAAM,GAAG,GAAG,IAAI,kCAAkC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,kCAAkC,CAAC,IAAI,CAAC,MAAM,CAAC;YAC5I,MAAM,IAAI,KAAK,CAAC,oBAAoB,MAAM,GAAG,CAAC,CAAC;QACjD,IAAI,CAAC,yBAAyB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED,IAAW,MAAM,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7C,iBAAiB,CAAC,OAA8B;QACrD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,SAAS,KAAK,IAAI;YACpB,OAAO,SAAS,CAAC;QAEnB,iIAAiI;QACjI,IAAI,aAAa,GAAG,IAAA,WAAI,EAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAA,mBAAU,EAAC,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACpG,IAAI,IAAI,CAAC,OAAO,KAAK,EAAE,EAAE,8FAA8F;YACrH,aAAa,GAAG,GAAG,aAAa,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACrD,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;IACjC,CAAC;IAUM,IAAI;QACT,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,uBAAQ,CAAC,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAEM,KAAK;QACV,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;YAC3B,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;SACtC;IACH,CAAC;IAEM,SAAS,CAAC,OAA8B;QAC7C,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,sCAAsC,EAAE,CAAC,IAAI,EAAE,EAAE;YACxF,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5B,OAAO,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACrF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,OAA8B;QACjD,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,oCAAoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACtF,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5B,MAAM,UAAU,GAAG,IAAI,gCAAc,CAAC,MAAM,EAAE,CAAC;YAC/C,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACnH,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,OAAO,CAAC,OAA8B;QAC3C,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,oCAAoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACtF,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5B,OAAO,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACnF,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,OAAO,CAAC,OAA8B,EAAE,cAA8B;QAC3E,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,CAAC,IAAI;YACP,OAAO,SAAS,CAAC;QAEnB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,MAAM,aAAa,GAAG,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,IAAI,CAAC,aAAa,CAAC;QAE3D,gDAAgD;QAChD,MAAM,IAAI,GAAG,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QACxE,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI;YAC3E,OAAO,aAAa,CAAC,CAAC,kBAAkB;QAE1C,kFAAkF;QAClF,IAAI,IAAI;YACN,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;;YAE7B,uBAAU,CAAC,kBAAkB,CAAC,IAAA,cAAO,EAAC,aAAa,CAAC,CAAC,CAAC;QAExD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QAC7E,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,EAAE,CAAC,UAAU,CAAC,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,oEAAoE;QAC9G,EAAE,CAAC,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC,oBAAoB;QACzD,OAAO,aAAa,CAAC;IACvB,CAAC;CACF;AAtGD,4CAsGC;AAED;;;;;GAKG;AACH,MAAa,mBAAoB,SAAQ,gBAAgB;IAAzD;;QACU,iBAAY,GAAG,KAAK,CAAC;IAyJ/B,CAAC;IAxJS,MAAM,CAAC,oBAAoB,CAAC,IAA2B;QAC7D,gBAAgB,CAAC,yBAAyB,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QAClE,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI;YACpB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC9C,CAAC;IAEO,oBAAoB,CAAC,GAAwB;QACnD,MAAM,GAAG,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC;QAClE,IAAI,GAAG,GAAG,CAAC,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC,EAAE,eAAe;YAC7C,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAC1C,CAAC;IAEe,IAAI;QAClB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,uBAAQ,CAAC,SAAS,CAAC,CAAC;IAC3D,CAAC;IAEe,KAAK;QACnB,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,sEAAsE;YACtE,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;SAC3B;QACD,KAAK,CAAC,KAAK,EAAE,CAAC;IAChB,CAAC;IAEO,mBAAmB,CAAC,aAA4B;QACtD,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC;IACxD,CAAC;IAEO,eAAe,CAAC,OAA8B,EAAE,GAAW,EAAE,IAAsC;QACzG,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE;YAC9C,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5B,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAG,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE;gBAChC,MAAM,IAAI,yBAAW,CAAC,EAAE,EAAE,uBAAuB,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC9B,CAAC;IAED,kFAAkF;IAC3E,MAAM;QACX,uBAAU,CAAC,kBAAkB,CAAC,IAAA,cAAO,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QACvD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,+DAA+D,CAAC,CAAC;QAC1F,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,6DAA6D,CAAC,CAAC;QACxF,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC9B,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,UAA8B,EAAE,UAA8B,EAAE,UAA4C;QAC3I,OAAO,6BAAW,CAAC,MAAM,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,UAAqC;QACvD,OAAO,6BAAW,CAAC,QAAQ,CAAC,EAAE,GAAG,UAAU,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACI,SAAS,CAAC,OAA8B,EAAE,GAAW;QAC1D,mBAAmB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,2CAA2C,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAChH,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,OAA8B,EAAE,GAAW;QAC7D,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,yCAAyC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC9G,CAAC;IAED,gCAAgC;IACzB,YAAY,CAAC,OAA8B;QAChD,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,gCAAgC,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,OAA8B,EAAE,GAAe;QAC5D,mBAAmB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,yCAAyC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC5G,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,OAA8B,EAAE,GAAe;QAC/D,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,uCAAuC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC1G,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,OAA8B;QACjD,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,oCAAoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACtF,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5B,MAAM,UAAU,GAAG,IAAI,gCAAc,CAAC,MAAM,EAAE,CAAC;YAC/C,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACpI,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,8BAA8B;IACvB,UAAU,CAAC,OAA8B;QAC9C,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,8BAA8B,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CAAC,OAA8B,EAAE,aAA4B,EAAE,OAAgB;QAC3F,mBAAmB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAClD,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAA,cAAO,EAAC,aAAa,CAAC,CAAC;QAC5C,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,CAAC,CAAC,MAAK,GAAG;YACtB,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;IAC7H,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,OAA8B,EAAE,aAA4B;QAC5E,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,wBAAwB;QACzD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IAC9H,CAAC;IAED,8BAA8B;IACvB,UAAU,CAAC,OAA8B;QAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,SAAS,KAAK,IAAI;YACpB,MAAM,IAAI,KAAK,CAAC,kBAAkB,OAAO,kBAAkB,CAAC,CAAC;QAC/D,IAAI,IAAI,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC;YAC3C,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC;CACF;AA1JD,kDA0JC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Workspace\r\n */\r\n\r\nimport { createHash } from \"crypto\";\r\nimport * as fs from \"fs-extra\";\r\nimport { dirname, extname, join } from \"path\";\r\nimport { CloudSqlite, IModelJsNative, NativeLibrary } from \"@bentley/imodeljs-native\";\r\nimport { BeEvent, DbResult, OpenMode, Optional } from \"@itwin/core-bentley\";\r\nimport { IModelError, LocalDirName, LocalFileName } from \"@itwin/core-common\";\r\nimport { IModelJsFs } from \"../IModelJsFs\";\r\nimport { SQLiteDb } from \"../SQLiteDb\";\r\nimport { SqliteStatement } from \"../SqliteStatement\";\r\nimport { Settings, SettingsPriority } from \"./Settings\";\r\n\r\n// cspell:ignore rowid\r\n\r\n/** The names of Settings used by Workspace\r\n * @beta\r\n */\r\nenum WorkspaceSetting {\r\n  ContainerAlias = \"workspace/container/alias\",\r\n}\r\n\r\nconst workspaceDbFileExt = \"itwin-workspace\";\r\n\r\n/**\r\n * The name of a WorkspaceContainer. This is the user-supplied name of a WorkspaceContainer, used to specify its *purpose* within a workspace.\r\n * WorkspaceContainerName can be \"aliased\" by `WorkspaceSetting.containerAlias` settings so that \"resolved\" [[WorkspaceContainerId]] that supplies\r\n * the actual WorkspaceContainer for a WorkspaceContainerName may vary. Also note that more than one WorkspaceContainerName may resolve to the same\r\n * WorkspaceContainerId, if multiple purposes are served by the same WorkspaceContainer.\r\n * @note there are no constraints on the contents or length of `WorkspaceContainerName`s, although short descriptive names are recommended.\r\n * However, when no alias exists in WorkspaceSetting.containerAlias for a WorkspaceContainerName, then the WorkspaceContainerName becomes\r\n * the WorkspaceContainerId, and the constraints on WorkspaceContainerId apply.\r\n * @beta\r\n */\r\nexport type WorkspaceContainerName = string;\r\n\r\n/**\r\n * The unique identifier of a WorkspaceContainer. This becomes the base name for the local directory holding the WorkspaceDbs from a WorkspaceContainer.\r\n * `WorkspaceContainerName`s are resolved to WorkspaceContainerId through `WorkspaceSetting.containerAlias` settings,\r\n * so users may not recognize the actual WorkspaceContainerId supplying resources for a WorkspaceDbName.\r\n *\r\n * `WorkspaceContainerId`s :\r\n *  - may only contain lower case letters, numbers or dashes\r\n *  - may not start or end with with a dash\r\n *  - be shorter than 3 or longer than 63 characters\r\n * @beta\r\n */\r\nexport type WorkspaceContainerId = string;\r\n\r\n/** The name of a WorkspaceDb within a WorkspaceContainer.\r\n * @beta\r\n */\r\nexport type WorkspaceDbName = string;\r\n\r\n/**\r\n * The version name for a WorkspaceDb. More than one version of a WorkspaceDb may be stored in the same WorkspaceContainer. This\r\n * string identifies a specific version.\r\n * @beta\r\n */\r\nexport type WorkspaceDbVersion = string;\r\n\r\n/**\r\n * The name for identifying WorkspaceResources in a [[WorkspaceDb]].\r\n * * `WorkspaceResourceName`s may not:\r\n *  - be blank or start or end with a space\r\n *  - be longer than 1024 characters\r\n * @note a single WorkspaceDb may hold WorkspaceResources of type 'blob', 'string' and 'file', all with the same WorkspaceResourceName.\r\n * @beta\r\n */\r\nexport type WorkspaceResourceName = string;\r\n\r\n/** supply either container name of id, not both\r\n * @beta\r\n */\r\nexport type ContainerNameOrId = { containerName: WorkspaceContainerName, containerId?: never } | { containerId: WorkspaceContainerId, containerName?: never };\r\n\r\n/**\r\n * Properties that specify a WorkspaceContainer.\r\n * This can either be a WorkspaceContainerName or a WorkspaceContainerId. If id is supplied,\r\n * it is used directly. Otherwise name must be resolved via [[Workspace.resolveContainerId]].\r\n * @beta\r\n */\r\nexport type WorkspaceContainerProps = ContainerNameOrId & {\r\n  cloudProps?: CloudSqlite.TransferProps;\r\n};\r\n\r\n/** Properties of a WorkspaceDb\r\n * @beta\r\n */\r\nexport type WorkspaceDbProps = WorkspaceContainerProps & {\r\n  /** the name of the WorkspaceDb */\r\n  dbName: WorkspaceDbName;\r\n};\r\n\r\n/** Properties that specify a WorkspaceResource within a WorkspaceDb.\r\n * @beta\r\n */\r\nexport type WorkspaceResourceProps = WorkspaceDbProps & {\r\n  /** the name of the resource within [[db]] */\r\n  rscName: WorkspaceResourceName;\r\n};\r\n\r\n/**\r\n * A WorkspaceDb holds workspace resources. `WorkspaceDb`s may just be local files, or they may be  stored and\r\n * synchronized in WorkspaceContainers. Each `WorkspaceResource` in a WorkspaceDb is  identified by a [[WorkspaceResourceName]].\r\n * Resources of type `string` and `blob` may be loaded directly from the `WorkspaceDb`. Resources of type `file` are\r\n * copied from the WorkspaceDb into a temporary local file so they can be accessed directly.\r\n * @beta\r\n */\r\nexport interface WorkspaceDb {\r\n  readonly container: WorkspaceContainer;\r\n  /** The WorkspaceDbName of this WorkspaceDb. */\r\n  readonly dbName: WorkspaceDbName;\r\n  /** event raised when this WorkspaceDb is closed. */\r\n  readonly onClosed: BeEvent<() => void>;\r\n  /** The name of the local file for holding this WorkspaceDb. */\r\n  readonly localFile: LocalDirName;\r\n  /** Get a string resource from this WorkspaceDb, if present. */\r\n  getString(rscName: WorkspaceResourceName): string | undefined;\r\n\r\n  /** Get a blob resource from this WorkspaceDb, if present. */\r\n  getBlob(rscName: WorkspaceResourceName): Uint8Array | undefined;\r\n  /** @internal */\r\n  getBlobReader(rscName: WorkspaceResourceName): IModelJsNative.BlobIO;\r\n\r\n  /** Extract a local copy of a file resource from this WorkspaceDb, if present.\r\n   * @param rscName The name of the file resource in the WorkspaceDb\r\n   * @param targetFileName optional name for extracted file. Some applications require files in specific locations or filenames. If\r\n   * you know the full path to use for the extracted file, you can supply it. Generally, it is best to *not* supply the filename and\r\n   * keep the extracted files in the  container filesDir.\r\n   * @returns the full path to a file on the local filesystem.\r\n   * @note The file is copied from the file into the local filesystem so it may be accessed directly. This happens only\r\n   * as necessary, if the local file doesn't exist, or if it is out-of-date because it was updated in the file.\r\n   * For this reason, you should not save the local file name, and instead call this method every time you access it, so its\r\n   * content is always holds the correct version.\r\n   * @note The filename will be a hash value, not the resource name.\r\n   * @note Workspace resource files are set readonly as they are copied from the file.\r\n   * To edit them, you must first copy them to another location.\r\n   */\r\n  getFile(rscName: WorkspaceResourceName, targetFileName?: LocalFileName): LocalFileName | undefined;\r\n}\r\n\r\n/**\r\n * Options for constructing a [[Workspace]].\r\n * @beta\r\n */\r\nexport interface WorkspaceOpts {\r\n  /** The local directory for the WorkspaceDb files. The [[Workspace]] will (only) look in this directory\r\n   * for files named `${this.containerId}/${this.dbId}.itwin-workspace`.\r\n   * @note if not supplied, defaults to `iTwin/Workspace` in the user-local folder.\r\n   */\r\n  containerDir?: LocalDirName;\r\n}\r\n\r\n/**\r\n * Settings and resources that customize an application for the current session.\r\n * See [Workspaces]($docs/learning/backend/Workspace)\r\n * @beta\r\n */\r\nexport interface Workspace {\r\n  /** The local directory for the WorkspaceDb files with the name `${containerId}.itwin-workspace`. */\r\n  readonly containerDir: LocalDirName;\r\n  /** The [[Settings]] for this Workspace */\r\n  readonly settings: Settings;\r\n\r\n  getContainer(props: WorkspaceContainerProps): WorkspaceContainer;\r\n\r\n  /**\r\n   * Resolve a WorkspaceContainerProps to a WorkspaceContainerId. If props is an object with an `id` member, that value is returned unchanged.\r\n   * If it is a string, then the highest priority [[WorkspaceSetting.containerAlias]] setting with an entry for the WorkspaceContainerName\r\n   * is used. If no WorkspaceSetting.containerAlias entry for the WorkspaceContainerName can be found, the name is returned as the id.\r\n   */\r\n  resolveContainerId(props: WorkspaceContainerProps): WorkspaceContainerId;\r\n  /**\r\n   * Get an open [[WorkspaceDb]]. If the WorkspaceDb is present but not open, it is opened first.\r\n   * If `cloudProps` are supplied, and if container is not  present or not up-to-date, it is downloaded first.\r\n   * @returns a Promise that is resolved when the container is local, opened, and available for access.\r\n   */\r\n  getWorkspaceDb(props: WorkspaceDbProps): Promise<WorkspaceDb>;\r\n  /** Load a WorkspaceResource of type string, parse it, and add it to the current Settings for this Workspace.\r\n   * @note settingsRsc must specify a resource holding a stringified JSON representation of a [[SettingDictionary]]\r\n   * @returns a Promise that is resolved when the settings resource has been loaded.\r\n   */\r\n  loadSettingsDictionary(settingRsc: WorkspaceResourceProps, priority: SettingsPriority): Promise<void>;\r\n  /** Close this Workspace. All WorkspaceContainers are dropped. */\r\n  close(): void;\r\n}\r\n\r\n/** A WorkspaceContainer holds WorkspaceDbs.\r\n * @beta\r\n */\r\nexport interface WorkspaceContainer {\r\n  readonly dirName: LocalDirName;\r\n  /** the local directory where this WorkspaceContainer will store temporary files extracted for file-resources. */\r\n  readonly filesDir: LocalDirName;\r\n  readonly id: WorkspaceContainerId;\r\n  readonly workspace: Workspace;\r\n  /** @internal */\r\n  addWorkspaceDb(toAdd: ITwinWorkspaceDb): void;\r\n\r\n  getWorkspaceDb(props: Optional<WorkspaceDbProps, \"containerName\">): Promise<WorkspaceDb>;\r\n  /** Close and remove a currently opened [[WorkspaceDb]] from this Workspace. */\r\n  dropWorkspaceDb(container: WorkspaceDb): void;\r\n  /** Close this WorkspaceContainer. All currently opened WorkspaceDbs are dropped. */\r\n  close(): void;\r\n}\r\n\r\n/** @internal */\r\nexport class ITwinWorkspace implements Workspace {\r\n  private _containers = new Map<WorkspaceContainerId, ITwinWorkspaceContainer>();\r\n  public readonly containerDir: LocalDirName;\r\n  public readonly settings: Settings;\r\n\r\n  public constructor(settings: Settings, opts?: WorkspaceOpts) {\r\n    this.settings = settings;\r\n    this.containerDir = opts?.containerDir ?? join(NativeLibrary.defaultLocalDir, \"iTwin\", \"Workspace\");\r\n  }\r\n\r\n  public addContainer(toAdd: ITwinWorkspaceContainer) {\r\n    if (undefined !== this._containers.get(toAdd.id))\r\n      throw new Error(\"container already exists in workspace\");\r\n    this._containers.set(toAdd.id, toAdd);\r\n  }\r\n  public getContainer(props: WorkspaceContainerProps): WorkspaceContainer {\r\n    const id = this.resolveContainerId(props);\r\n    if (undefined === id)\r\n      throw new Error(`can't resolve workspace container name [${props.containerName}]`);\r\n\r\n    return this._containers.get(id) ?? new ITwinWorkspaceContainer(this, id);\r\n  }\r\n\r\n  public async getWorkspaceDb(props: WorkspaceDbProps): Promise<WorkspaceDb> {\r\n    return this.getContainer(props).getWorkspaceDb(props);\r\n  }\r\n\r\n  public async loadSettingsDictionary(settingRsc: WorkspaceResourceProps, priority: SettingsPriority) {\r\n    const db = await this.getWorkspaceDb(settingRsc);\r\n    const setting = db.getString(settingRsc.rscName);\r\n    if (undefined === setting)\r\n      throw new Error(`could not load setting resource ${settingRsc.rscName}`);\r\n\r\n    this.settings.addJson(`${db.container.id}/${db.dbName}/${settingRsc.rscName}`, priority, setting);\r\n  }\r\n\r\n  public close() {\r\n    this.settings.close();\r\n    for (const [_id, container] of this._containers)\r\n      container.close();\r\n    this._containers.clear();\r\n  }\r\n\r\n  public resolveContainerId(props: WorkspaceContainerProps): WorkspaceContainerId {\r\n    if (props.containerId)\r\n      return props.containerId; // if the container id is supplied, just use it\r\n\r\n    const id = this.settings.resolveSetting(WorkspaceSetting.ContainerAlias, (val) => {\r\n      if (Array.isArray(val)) {\r\n        for (const entry of val) {\r\n          if (typeof entry === \"object\" && entry.name === props.containerName && typeof entry.id === \"string\")\r\n            return entry.id;\r\n        }\r\n      }\r\n      return undefined; // keep going through all settings dictionaries\r\n    }, props.containerName);\r\n    if (undefined === id)\r\n      throw new Error(\"Unable to resolve container id.\");\r\n    return id;\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport class ITwinWorkspaceContainer implements WorkspaceContainer {\r\n  public readonly workspace: ITwinWorkspace;\r\n  public readonly filesDir: LocalDirName;\r\n  public readonly id: WorkspaceContainerId;\r\n  private _wsDbs = new Map<WorkspaceDbName, ITwinWorkspaceDb>();\r\n  public get dirName() { return join(this.workspace.containerDir, this.id); }\r\n\r\n  /** rules for ContainerIds (from Azure, see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata)\r\n   *  - may only contain lower case letters, numbers or dashes\r\n   *  - may not start or end with with a dash nor have more than one dash in a row\r\n   *  - may not be shorter than 3 or longer than 63 characters\r\n   */\r\n  private static validateContainerId(id: WorkspaceContainerId) {\r\n    if (!/^(?=.{3,63}$)[a-z0-9]+(-[a-z0-9]+)*$/g.test(id))\r\n      throw new Error(`invalid containerId: [${id}]`);\r\n  }\r\n\r\n  public constructor(workspace: ITwinWorkspace, id: WorkspaceContainerId) {\r\n    ITwinWorkspaceContainer.validateContainerId(id);\r\n    this.workspace = workspace;\r\n    this.id = id;\r\n    workspace.addContainer(this);\r\n    this.filesDir = join(this.dirName, \"Files\");\r\n  }\r\n\r\n  public addWorkspaceDb(toAdd: ITwinWorkspaceDb) {\r\n    if (undefined !== this._wsDbs.get(toAdd.dbName))\r\n      throw new Error(\"dbName already exists in workspace\");\r\n    this._wsDbs.set(toAdd.dbName, toAdd);\r\n  }\r\n\r\n  public async getWorkspaceDb(props: Optional<WorkspaceDbProps, \"containerName\">): Promise<WorkspaceDb> {\r\n    const db = this._wsDbs.get(props.dbName) ?? new ITwinWorkspaceDb(props.dbName, this);\r\n    if (!db.isOpen) {\r\n      if (props.cloudProps)\r\n        await CloudSqlite.downloadDb({ ...db, ...props.cloudProps, containerId: this.id });\r\n      db.open();\r\n    }\r\n    return db;\r\n  }\r\n\r\n  public dropWorkspaceDb(toDrop: WorkspaceDb): void {\r\n    const name = toDrop.dbName;\r\n    const wsDb = this._wsDbs.get(name);\r\n    if (wsDb === toDrop) {\r\n      wsDb.close();\r\n      this._wsDbs.delete(name);\r\n    }\r\n  }\r\n\r\n  public close() {\r\n    for (const [_name, db] of this._wsDbs)\r\n      db.close();\r\n    this._wsDbs.clear();\r\n  }\r\n\r\n  public purgeContainerFiles() {\r\n    IModelJsFs.purgeDirSync(this.filesDir);\r\n  }\r\n}\r\n\r\n/**\r\n * A local file holding a WorkspaceDb.\r\n * @beta\r\n */\r\nexport class ITwinWorkspaceDb implements WorkspaceDb {\r\n  public readonly sqliteDb = new SQLiteDb(); // eslint-disable-line @typescript-eslint/naming-convention\r\n  public readonly dbName: WorkspaceDbName;\r\n  public readonly container: WorkspaceContainer;\r\n  public localFile: LocalFileName;\r\n  public readonly onClosed = new BeEvent<() => void>();\r\n\r\n  protected static noLeadingOrTrailingSpaces(name: string, msg: string) {\r\n    if (name.trim() !== name)\r\n      throw new Error(`${msg} [${name}] may not have leading or tailing spaces`);\r\n  }\r\n\r\n  private static validateDbName(dbName: WorkspaceDbName) {\r\n    if (dbName === \"\" || dbName.length > 255 || /[#\\.<>:\"/\\\\\"`'|?*\\u0000-\\u001F]/g.test(dbName) || /^(con|prn|aux|nul|com\\d|lpt\\d)$/i.test(dbName))\r\n      throw new Error(`invalid dbName: [${dbName}]`);\r\n    this.noLeadingOrTrailingSpaces(dbName, \"dbName\");\r\n  }\r\n\r\n  public get isOpen() { return this.sqliteDb.isOpen; }\r\n  public queryFileResource(rscName: WorkspaceResourceName) {\r\n    const info = this.sqliteDb.nativeDb.queryEmbeddedFile(rscName);\r\n    if (undefined === info)\r\n      return undefined;\r\n\r\n    // since resource names can contain illegal characters, path separators, etc., we make the local file name from its hash, in hex.\r\n    let localFileName = join(this.container.filesDir, createHash(\"sha1\").update(rscName).digest(\"hex\"));\r\n    if (info.fileExt !== \"\") // since some applications may expect to see the extension, append it here if it was supplied.\r\n      localFileName = `${localFileName}.${info.fileExt}`;\r\n    return { localFileName, info };\r\n  }\r\n\r\n  public constructor(dbName: WorkspaceDbName, container: WorkspaceContainer) {\r\n    ITwinWorkspaceDb.validateDbName(dbName);\r\n    this.dbName = dbName;\r\n    this.container = container;\r\n    this.localFile = join(container.dirName, `${dbName}.${workspaceDbFileExt}`);\r\n    container.addWorkspaceDb(this);\r\n  }\r\n\r\n  public open(): void {\r\n    this.sqliteDb.openDb(this.localFile, OpenMode.Readonly);\r\n  }\r\n\r\n  public close(): void {\r\n    if (this.isOpen) {\r\n      this.onClosed.raiseEvent();\r\n      this.sqliteDb.closeDb();\r\n      this.container.dropWorkspaceDb(this);\r\n    }\r\n  }\r\n\r\n  public getString(rscName: WorkspaceResourceName): string | undefined {\r\n    return this.sqliteDb.withSqliteStatement(\"SELECT value from strings WHERE id=?\", (stmt) => {\r\n      stmt.bindString(1, rscName);\r\n      return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValueString(0) : undefined;\r\n    });\r\n  }\r\n\r\n  /** Get a BlobIO reader for a blob WorkspaceResource.\r\n   * @note when finished, caller must call `close` on the BlobIO.\r\n   */\r\n  public getBlobReader(rscName: WorkspaceResourceName): IModelJsNative.BlobIO {\r\n    return this.sqliteDb.withSqliteStatement(\"SELECT rowid from blobs WHERE id=?\", (stmt) => {\r\n      stmt.bindString(1, rscName);\r\n      const blobReader = new IModelJsNative.BlobIO();\r\n      blobReader.open(this.sqliteDb.nativeDb, { tableName: \"blobs\", columnName: \"value\", row: stmt.getValueInteger(0) });\r\n      return blobReader;\r\n    });\r\n  }\r\n\r\n  public getBlob(rscName: WorkspaceResourceName): Uint8Array | undefined {\r\n    return this.sqliteDb.withSqliteStatement(\"SELECT value from blobs WHERE id=?\", (stmt) => {\r\n      stmt.bindString(1, rscName);\r\n      return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValueBlob(0) : undefined;\r\n    });\r\n  }\r\n\r\n  public getFile(rscName: WorkspaceResourceName, targetFileName?: LocalFileName): LocalFileName | undefined {\r\n    const file = this.queryFileResource(rscName);\r\n    if (!file)\r\n      return undefined;\r\n\r\n    const info = file.info;\r\n    const localFileName = targetFileName ?? file.localFileName;\r\n\r\n    // check whether the file is already up to date.\r\n    const stat = fs.existsSync(localFileName) && fs.statSync(localFileName);\r\n    if (stat && Math.round(stat.mtimeMs) === info.date && stat.size === info.size)\r\n      return localFileName; // yes, we're done\r\n\r\n    // extractEmbeddedFile fails if the file exists or if the directory does not exist\r\n    if (stat)\r\n      fs.removeSync(localFileName);\r\n    else\r\n      IModelJsFs.recursiveMkDirSync(dirname(localFileName));\r\n\r\n    this.sqliteDb.nativeDb.extractEmbeddedFile({ name: rscName, localFileName });\r\n    const date = new Date(info.date);\r\n    fs.utimesSync(localFileName, date, date); // set the last-modified date of the file to match date in container\r\n    fs.chmodSync(localFileName, \"0444\"); // set file readonly\r\n    return localFileName;\r\n  }\r\n}\r\n\r\n/**\r\n * An editable [[WorkspaceDb]]. This is used by administrators for creating and modifying `WorkspaceDb`s.\r\n * For cloud-backed containers, the write token must be obtained before this class may be used. Only one user at at time\r\n * may be editing.\r\n * @beta\r\n */\r\nexport class EditableWorkspaceDb extends ITwinWorkspaceDb {\r\n  private _isCloudOpen = false;\r\n  private static validateResourceName(name: WorkspaceResourceName) {\r\n    ITwinWorkspaceDb.noLeadingOrTrailingSpaces(name, \"resource name\");\r\n    if (name.length > 1024)\r\n      throw new Error(\"resource name too long\");\r\n  }\r\n\r\n  private validateResourceSize(val: Uint8Array | string) {\r\n    const len = typeof val === \"string\" ? val.length : val.byteLength;\r\n    if (len > (1024 * 1024 * 1024)) // one gigabyte\r\n      throw new Error(\"value is too large\");\r\n  }\r\n\r\n  public override open() {\r\n    this.sqliteDb.openDb(this.localFile, OpenMode.ReadWrite);\r\n  }\r\n\r\n  public override close() {\r\n    if (this._isCloudOpen) {\r\n      //  this.db.nativeDb.flushCloudUpload(); TODO: add back when available\r\n      this._isCloudOpen = false;\r\n    }\r\n    super.close();\r\n  }\r\n\r\n  private getFileModifiedTime(localFileName: LocalFileName): number {\r\n    return Math.round(fs.statSync(localFileName).mtimeMs);\r\n  }\r\n\r\n  private performWriteSql(rscName: WorkspaceResourceName, sql: string, bind?: (stmt: SqliteStatement) => void) {\r\n    this.sqliteDb.withSqliteStatement(sql, (stmt) => {\r\n      stmt.bindString(1, rscName);\r\n      bind?.(stmt);\r\n      const rc = stmt.step();\r\n      if (DbResult.BE_SQLITE_DONE !== rc)\r\n        throw new IModelError(rc, \"workspace write error\");\r\n    });\r\n    this.sqliteDb.saveChanges();\r\n  }\r\n\r\n  /** Create a new, empty, EditableWorkspaceDb for importing Workspace resources. */\r\n  public create() {\r\n    IModelJsFs.recursiveMkDirSync(dirname(this.localFile));\r\n    this.sqliteDb.createDb(this.localFile);\r\n    this.sqliteDb.executeSQL(\"CREATE TABLE strings(id TEXT PRIMARY KEY NOT NULL,value TEXT)\");\r\n    this.sqliteDb.executeSQL(\"CREATE TABLE blobs(id TEXT PRIMARY KEY NOT NULL,value BLOB)\");\r\n    this.sqliteDb.saveChanges();\r\n  }\r\n\r\n  public static async cloneVersion(oldVersion: WorkspaceDbVersion, newVersion: WorkspaceDbVersion, cloudProps: CloudSqlite.ContainerAccessProps) {\r\n    return CloudSqlite.copyDb(oldVersion, newVersion, cloudProps);\r\n  }\r\n\r\n  public async upload(cloudProps: CloudSqlite.TransferProps) {\r\n    return CloudSqlite.uploadDb({ ...cloudProps, ...this });\r\n  }\r\n\r\n  /** Add a new string resource to this WorkspaceDb.\r\n   * @param rscName The name of the string resource.\r\n   * @param val The string to save.\r\n   */\r\n  public addString(rscName: WorkspaceResourceName, val: string): void {\r\n    EditableWorkspaceDb.validateResourceName(rscName);\r\n    this.validateResourceSize(val);\r\n    this.performWriteSql(rscName, \"INSERT INTO strings(id,value) VALUES(?,?)\", (stmt) => stmt.bindString(2, val));\r\n  }\r\n\r\n  /** Update an existing string resource with a new value.\r\n   * @param rscName The name of the string resource.\r\n   * @param val The new value.\r\n   * @throws if rscName does not exist\r\n   */\r\n  public updateString(rscName: WorkspaceResourceName, val: string): void {\r\n    this.validateResourceSize(val);\r\n    this.performWriteSql(rscName, \"UPDATE strings SET value=?2 WHERE id=?1\", (stmt) => stmt.bindString(2, val));\r\n  }\r\n\r\n  /** Remove a string resource. */\r\n  public removeString(rscName: WorkspaceResourceName): void {\r\n    this.performWriteSql(rscName, \"DELETE FROM strings WHERE id=?\");\r\n  }\r\n\r\n  /** Add a new blob resource to this WorkspaceDb.\r\n   * @param rscName The name of the blob resource.\r\n   * @param val The blob to save.\r\n   */\r\n  public addBlob(rscName: WorkspaceResourceName, val: Uint8Array): void {\r\n    EditableWorkspaceDb.validateResourceName(rscName);\r\n    this.validateResourceSize(val);\r\n    this.performWriteSql(rscName, \"INSERT INTO blobs(id,value) VALUES(?,?)\", (stmt) => stmt.bindBlob(2, val));\r\n  }\r\n\r\n  /** Update an existing blob resource with a new value.\r\n   * @param rscName The name of the blob resource.\r\n   * @param val The new value.\r\n   * @throws if rscName does not exist\r\n   */\r\n  public updateBlob(rscName: WorkspaceResourceName, val: Uint8Array): void {\r\n    this.validateResourceSize(val);\r\n    this.performWriteSql(rscName, \"UPDATE blobs SET value=?2 WHERE id=?1\", (stmt) => stmt.bindBlob(2, val));\r\n  }\r\n\r\n  /** Get a BlobIO writer for a previously-added blob WorkspaceResource.\r\n   * @note after writing is complete, caller must call `close` on the BlobIO and must call `saveChanges` on the `db`.\r\n   */\r\n  public getBlobWriter(rscName: WorkspaceResourceName): IModelJsNative.BlobIO {\r\n    return this.sqliteDb.withSqliteStatement(\"SELECT rowid from blobs WHERE id=?\", (stmt) => {\r\n      stmt.bindString(1, rscName);\r\n      const blobWriter = new IModelJsNative.BlobIO();\r\n      blobWriter.open(this.sqliteDb.nativeDb, { tableName: \"blobs\", columnName: \"value\", row: stmt.getValueInteger(0), writeable: true });\r\n      return blobWriter;\r\n    });\r\n  }\r\n\r\n  /** Remove a blob resource. */\r\n  public removeBlob(rscName: WorkspaceResourceName): void {\r\n    this.performWriteSql(rscName, \"DELETE FROM blobs WHERE id=?\");\r\n  }\r\n\r\n  /** Copy the contents of an existing local file into this WorkspaceDb as a file resource.\r\n   * @param rscName The name of the file resource.\r\n   * @param localFileName The name of a local file to be read.\r\n   * @param fileExt The extension (do not include the leading \".\") to be appended to the generated fileName\r\n   * when this WorkspaceDb is extracted from the WorkspaceDb. By default the characters after the last \".\" in `localFileName`\r\n   * are used. Pass this argument to override that.\r\n   */\r\n  public addFile(rscName: WorkspaceResourceName, localFileName: LocalFileName, fileExt?: string): void {\r\n    EditableWorkspaceDb.validateResourceName(rscName);\r\n    fileExt = fileExt ?? extname(localFileName);\r\n    if (fileExt?.[0] === \".\")\r\n      fileExt = fileExt.slice(1);\r\n    this.sqliteDb.nativeDb.embedFile({ name: rscName, localFileName, date: this.getFileModifiedTime(localFileName), fileExt });\r\n  }\r\n\r\n  /** Replace an existing file resource with the contents of a local file.\r\n   * @param rscName The name of the file resource.\r\n   * @param localFileName The name of a local file to be read.\r\n   * @throws if rscName does not exist\r\n   */\r\n  public updateFile(rscName: WorkspaceResourceName, localFileName: LocalFileName): void {\r\n    this.queryFileResource(rscName); // throws if not present\r\n    this.sqliteDb.nativeDb.replaceEmbeddedFile({ name: rscName, localFileName, date: this.getFileModifiedTime(localFileName) });\r\n  }\r\n\r\n  /** Remove a file resource. */\r\n  public removeFile(rscName: WorkspaceResourceName): void {\r\n    const file = this.queryFileResource(rscName);\r\n    if (undefined === file)\r\n      throw new Error(`file resource \"${rscName}\" does not exist`);\r\n    if (file && fs.existsSync(file.localFileName))\r\n      fs.unlinkSync(file.localFileName);\r\n    this.sqliteDb.nativeDb.removeEmbeddedFile(rscName);\r\n  }\r\n}\r\n\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/core-backend",
-  "version": "3.0.0-dev.98",
+  "version": "3.1.0-dev.0",
   "description": "iTwin.js backend components",
   "main": "lib/cjs/core-backend.js",
   "typings": "lib/cjs/core-backend",
@@ -10,7 +10,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/imodeljs/imodeljs/tree/master/core/backend"
+    "url": "https://github.com/iTwin/itwinjs-core/tree/master/core/backend"
   },
   "keywords": [
     "Bentley",
@@ -24,24 +24,22 @@
     "url": "http://www.bentley.com"
   },
   "peerDependencies": {
-    "@bentley/itwin-client": "^3.0.0-dev.98",
-    "@itwin/core-bentley": "^3.0.0-dev.98",
-    "@itwin/core-common": "^3.0.0-dev.98",
-    "@itwin/core-geometry": "^3.0.0-dev.98",
-    "@itwin/ecschema-metadata": "^3.0.0-dev.98"
+    "@itwin/core-bentley": "^3.1.0-dev.0",
+    "@itwin/core-common": "^3.1.0-dev.0",
+    "@itwin/core-geometry": "^3.1.0-dev.0",
+    "@itwin/ecschema-metadata": "^3.1.0-dev.0"
   },
   "//devDependencies": [
     "NOTE: All peerDependencies should also be listed as devDependencies since peerDependencies are not considered by npm install",
     "NOTE: All tools used by scripts in this package must be listed as devDependencies"
   ],
   "devDependencies": {
-    "@bentley/itwin-client": "3.0.0-dev.98",
-    "@itwin/build-tools": "3.0.0-dev.98",
-    "@itwin/core-bentley": "3.0.0-dev.98",
-    "@itwin/core-common": "3.0.0-dev.98",
-    "@itwin/core-geometry": "3.0.0-dev.98",
-    "@itwin/ecschema-metadata": "3.0.0-dev.98",
-    "@itwin/eslint-plugin": "3.0.0-dev.98",
+    "@itwin/build-tools": "3.1.0-dev.0",
+    "@itwin/core-bentley": "3.1.0-dev.0",
+    "@itwin/core-common": "3.1.0-dev.0",
+    "@itwin/core-geometry": "3.1.0-dev.0",
+    "@itwin/ecschema-metadata": "3.1.0-dev.0",
+    "@itwin/eslint-plugin": "3.1.0-dev.0",
     "@types/chai": "^4.1.4",
     "@types/chai-as-promised": "^7",
     "@types/fs-extra": "^4.0.7",
@@ -53,7 +51,7 @@
     "@types/ws": "^6.0.4",
     "chai": "^4.1.2",
     "chai-as-promised": "^7",
-    "cpx": "^1.5.0",
+    "cpx2": "^3.0.0",
     "dotenv": "^10.0.0",
     "dotenv-expand": "^5.1.0",
     "eslint": "^7.11.0",
@@ -66,10 +64,11 @@
   },
   "dependencies": {
     "@azure/storage-blob": "^12.7.0",
-    "@bentley/imodeljs-native": "3.0.16",
-    "@bentley/telemetry-client": "3.0.0-dev.98",
+    "@bentley/imodeljs-native": "3.0.31",
+    "@itwin/core-telemetry": "3.1.0-dev.0",
     "form-data": "^2.3.2",
     "fs-extra": "^8.1.0",
+    "json5": "^2.2.0",
     "js-base64": "^3.6.1",
     "multiparty": "^4.2.1",
     "semver": "^5.5.0",
@@ -82,7 +81,21 @@
     "plugins": [
       "@itwin"
     ],
-    "extends": "plugin:@itwin/itwinjs-recommended"
+    "extends": "plugin:@itwin/itwinjs-recommended",
+    "rules": {
+      "@typescript-eslint/no-non-null-assertion": "error"
+    },
+    "overrides": [
+      {
+        "files": [
+          "*.test.ts",
+          "**/test/**/*.ts"
+        ],
+        "rules": {
+          "@typescript-eslint/no-non-null-assertion": "off"
+        }
+      }
+    ]
   },
   "scripts": {
     "build": "npm run -s build:cjs && npm run -s copy:assets && npm run -s copy:test-assets",
@@ -97,5 +110,6 @@
     "extract-api": "betools extract-api --entry=core-backend",
     "lint": "eslint -f visualstudio \"./src/**/*.ts\" 1>&2",
     "test": "mocha"
-  }
+  },
+  "readme": "# @itwin/core-backend\r\n\r\nCopyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.\r\n\r\n## Description\r\n\r\nThe __@itwin/core-backend__ package contains classes that backend code can use to work with directly with iModels.\r\n\r\n## Documentation\r\n\r\nSee the [iTwin.js](https://www.itwinjs.org) documentation for more information.\r\n"
 }