@itwin/core-backend 5.0.0-dev.98 → 5.0.0

package/lib/cjs/internal/workspace/WorkspaceImpl.d.ts

@@ -3,15 +3,13 @@
  */
 import { FilePropertyProps } from "@itwin/core-common";
 import { Settings } from "../../workspace/Settings";
-import { Workspace, WorkspaceContainer, WorkspaceContainerId, WorkspaceDb, WorkspaceDbFullName, WorkspaceDbLoadError, WorkspaceDbName, WorkspaceDbProps, WorkspaceDbVersion, WorkspaceOpts } from "../../workspace/Workspace";
+import { Workspace, WorkspaceContainer, WorkspaceContainerId, WorkspaceDb, WorkspaceDbLoadError, WorkspaceDbProps, WorkspaceOpts } from "../../workspace/Workspace";
 import { WorkspaceEditor } from "../../workspace/WorkspaceEditor";
 /** file extension for local WorkspaceDbs */
 export declare const workspaceDbFileExt = "itwin-workspace";
 export declare function constructWorkspaceDb(props: WorkspaceDbProps, container: WorkspaceContainer): WorkspaceDb;
 export declare function constructWorkspace(settings: Settings, opts?: WorkspaceOpts): OwnedWorkspace;
 export declare function constructWorkspaceEditor(): WorkspaceEditor;
-export declare function noLeadingOrTrailingSpaces(name: string, msg: string): void;
-export declare function validateWorkspaceDbName(dbName: WorkspaceDbName): void;
 /**
  * Validate that a WorkspaceContainer.Id is valid.
  * The rules for ContainerIds (from Azure, see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata):
@@ -20,20 +18,8 @@ export declare function validateWorkspaceDbName(dbName: WorkspaceDbName): void;
  *  - may not be shorter than 3 or longer than 63 characters
  */
 export declare function validateWorkspaceContainerId(id: WorkspaceContainerId): void;
-export declare function validateWorkspaceDbVersion(version?: WorkspaceDbVersion): string;
-/**
- * Parse the name stored in a WorkspaceContainer into the dbName and version number. A single WorkspaceContainer may hold
- * many versions of the same WorkspaceDb. The name of the Db in the WorkspaceContainer is in the format "name:version". This
- * function splits them into separate strings.
- */
-export declare function parseWorkspaceDbFileName(dbFileName: WorkspaceDbFullName): {
-    dbName: WorkspaceDbName;
-    version: WorkspaceDbVersion;
-};
-/** Create a dbName for a WorkspaceDb from its base name and version. This will be in the format "name:version" */
-export declare function makeWorkspaceDbFileName(dbName: WorkspaceDbName, version?: WorkspaceDbVersion): WorkspaceDbName;
 export declare const workspaceManifestProperty: FilePropertyProps;
-export declare function throwWorkspaceDbLoadErrors(msg: string, errors: WorkspaceDbLoadError[]): never;
+export declare function throwWorkspaceDbLoadErrors(message: string, wsLoadErrors: WorkspaceDbLoadError[]): never;
 export interface OwnedWorkspace extends Workspace {
     /** Only the owner of a Workspace may close it. */
     close(): void;

package/lib/cjs/internal/workspace/WorkspaceImpl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WorkspaceImpl.d.ts","sourceRoot":"","sources":["../../../../src/internal/workspace/WorkspaceImpl.ts"],"names":[],"mappings":"AAIA;;GAEG;AAOH,OAAO,EAAE,iBAAiB,EAA4C,MAAM,oBAAoB,CAAC;AAMjG,OAAO,EAAe,QAAQ,EAAgE,MAAM,0BAA0B,CAAC;AAE/H,OAAO,EACsB,SAAS,EAAE,kBAAkB,EAAE,oBAAoB,EAA2B,WAAW,EACpH,mBAAmB,EAAE,oBAAoB,EAA8C,eAAe,EAA6B,gBAAgB,EAC1F,kBAAkB,EAAE,aAAa,EAC3F,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAqH,eAAe,EAAE,MAAM,iCAAiC,CAAC;AASrL,4CAA4C;AAC5C,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AA6rBpD,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,kBAAkB,GAAG,WAAW,CAExG;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,cAAc,CAE3F;AAED,wBAAgB,wBAAwB,IAAI,eAAe,CAE1D;AAED,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,QAGlE;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,eAAe,QAK9D;AAED;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAAC,EAAE,EAAE,oBAAoB,QAGpE;AAED,wBAAgB,0BAA0B,CAAC,OAAO,CAAC,EAAE,kBAAkB,UAStE;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,mBAAmB,GAAG;IAAE,MAAM,EAAE,eAAe,CAAC;IAAC,OAAO,EAAE,kBAAkB,CAAA;CAAE,CAGlI;AAED,kHAAkH;AAClH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,eAAe,CAE9G;AAED,eAAO,MAAM,yBAAyB,EAAE,iBAAgE,CAAC;AASzG,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,EAAE,GAAG,KAAK,CAI7F;AAED,MAAM,WAAW,cAAe,SAAQ,SAAS;IAC/C,kDAAkD;IAClD,KAAK,IAAI,IAAI,CAAC;CACf"}
+{"version":3,"file":"WorkspaceImpl.d.ts","sourceRoot":"","sources":["../../../../src/internal/workspace/WorkspaceImpl.ts"],"names":[],"mappings":"AAIA;;GAEG;AAMH,OAAO,EAAoB,iBAAiB,EAA+C,MAAM,oBAAoB,CAAC;AAMtH,OAAO,EAAe,QAAQ,EAAgE,MAAM,0BAA0B,CAAC;AAE/H,OAAO,EACsB,SAAS,EAAE,kBAAkB,EAAE,oBAAoB,EAA2B,WAAW,EAC/F,oBAAoB,EAA0F,gBAAgB,EAC1F,aAAa,EACvE,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAqH,eAAe,EAAE,MAAM,iCAAiC,CAAC;AASrL,4CAA4C;AAC5C,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AAgqBpD,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,kBAAkB,GAAG,WAAW,CAExG;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,cAAc,CAE3F;AAED,wBAAgB,wBAAwB,IAAI,eAAe,CAE1D;AAED;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAAC,EAAE,EAAE,oBAAoB,QAGpE;AAED,eAAO,MAAM,yBAAyB,EAAE,iBAAgE,CAAC;AAOzG,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,oBAAoB,EAAE,GAAG,KAAK,CAEvG;AAED,MAAM,WAAW,cAAe,SAAQ,SAAS;IAC/C,kDAAkD;IAClD,KAAK,IAAI,IAAI,CAAC;CACf"}

package/lib/cjs/internal/workspace/WorkspaceImpl.js

@@ -11,17 +11,11 @@ exports.workspaceManifestProperty = exports.workspaceDbFileExt = void 0;
 exports.constructWorkspaceDb = constructWorkspaceDb;
 exports.constructWorkspace = constructWorkspace;
 exports.constructWorkspaceEditor = constructWorkspaceEditor;
-exports.noLeadingOrTrailingSpaces = noLeadingOrTrailingSpaces;
-exports.validateWorkspaceDbName = validateWorkspaceDbName;
 exports.validateWorkspaceContainerId = validateWorkspaceContainerId;
-exports.validateWorkspaceDbVersion = validateWorkspaceDbVersion;
-exports.parseWorkspaceDbFileName = parseWorkspaceDbFileName;
-exports.makeWorkspaceDbFileName = makeWorkspaceDbFileName;
 exports.throwWorkspaceDbLoadErrors = throwWorkspaceDbLoadErrors;
 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");
@@ -42,7 +36,7 @@ exports.workspaceDbFileExt = "itwin-workspace";
 function makeWorkspaceCloudCache(arg) {
     const cache = CloudSqlite_1.CloudSqlite.CloudCaches.getCache(arg);
     if (undefined === cache.workspaceContainers) // if we just created this container, add the map.
-        cache.workspaceContainers = new Map();
+        CloudSqlite_1.CloudSqlite.addHiddenProperty(cache, "workspaceContainers", new Map());
     return cache;
 }
 function getContainerFullId(props) {
@@ -56,20 +50,20 @@ function getWorkspaceCloudContainer(props, cache) {
     cloudContainer = CloudSqlite_1.CloudSqlite.createCloudContainer(props);
     cache.workspaceContainers.set(id, cloudContainer);
     cloudContainer.connectCount = 0;
-    cloudContainer.sharedConnect = function () {
+    CloudSqlite_1.CloudSqlite.addHiddenProperty(cloudContainer, "sharedConnect", function () {
         if (this.connectCount++ === 0) {
             this.connect(cache);
             return true;
         }
         return false;
-    };
-    cloudContainer.sharedDisconnect = function () {
+    });
+    CloudSqlite_1.CloudSqlite.addHiddenProperty(cloudContainer, "sharedDisconnect", function () {
         if (--this.connectCount <= 0) {
             this.disconnect();
             cache.workspaceContainers.delete(id);
             this.connectCount = 0;
         }
-    };
+    });
     return cloudContainer;
 }
 class WorkspaceContainerImpl {
@@ -107,31 +101,14 @@ class WorkspaceContainerImpl {
         }
     }
     resolveDbFileName(props) {
-        const cloudContainer = this.cloudContainer;
-        if (undefined === cloudContainer)
+        const container = this.cloudContainer;
+        if (undefined === container)
             return (0, path_1.join)(this.dirName, `${props.dbName}.${exports.workspaceDbFileExt}`); // local file, versions not allowed
-        const dbName = workspaceDbNameWithDefault(props.dbName);
-        const dbs = cloudContainer.queryDatabases(`${dbName}*`); // get all databases that start with dbName
-        const versions = [];
-        for (const db of dbs) {
-            const thisDb = parseWorkspaceDbFileName(db);
-            if (thisDb.dbName === dbName && "string" === typeof thisDb.version && thisDb.version.length > 0)
-                versions.push(thisDb.version);
-        }
-        if (versions.length === 0)
-            versions[0] = "0.0.0";
-        const range = props.version ?? "*";
-        try {
-            const version = semver.maxSatisfying(versions, range, { loose: true, includePrerelease: props.includePrerelease });
-            if (version)
-                return `${dbName}:${version}`;
-        }
-        catch { }
-        throwWorkspaceDbLoadError(`No version of '${dbName}' available for "${range}"`, props);
+        return CloudSqlite_1.CloudSqlite.querySemverMatch({ ...props, container, dbName: workspaceDbNameWithDefault(props.dbName) });
     }
     addWorkspaceDb(toAdd) {
         if (undefined !== this._wsDbs.get(toAdd.dbName))
-            throw new Error(`workspaceDb '${toAdd.dbName}' already exists in workspace`);
+            core_common_1.WorkspaceError.throwError("already-exists", { message: `workspaceDb '${toAdd.dbName}' already exists in workspace` });
         this._wsDbs.set(toAdd.dbName, toAdd);
     }
     getWorkspaceDb(props) {
@@ -176,7 +153,7 @@ class WorkspaceDbImpl {
     }
     constructor(props, container) {
         this.dbName = workspaceDbNameWithDefault(props.dbName);
-        validateWorkspaceDbName(this.dbName);
+        CloudSqlite_1.CloudSqlite.validateDbName(this.dbName);
         this._container = container;
         this.dbFileName = container.resolveDbFileName(props);
         container.addWorkspaceDb(this);
@@ -197,7 +174,7 @@ class WorkspaceDbImpl {
         const cloudContainer = this.container.cloudContainer;
         if (undefined === cloudContainer)
             return "1.0.0"; // local file, no versioning. return default
-        return parseWorkspaceDbFileName(this.dbFileName).version;
+        return CloudSqlite_1.CloudSqlite.parseDbFileName(this.dbFileName).version;
     }
     get manifest() {
         return this._manifest ??= this.withOpenDb((db) => {
@@ -264,7 +241,7 @@ class WorkspaceDbImpl {
     prefetch(opts) {
         const cloudContainer = this._container.cloudContainer;
         if (cloudContainer === undefined)
-            throw new Error("no cloud container to prefetch");
+            core_common_1.WorkspaceError.throwError("no-cloud-container", { message: "no cloud container to prefetch" });
         return CloudSqlite_1.CloudSqlite.startCloudPrefetch(cloudContainer, this.dbFileName, opts);
     }
     queryResources(args) {
@@ -307,7 +284,7 @@ class WorkspaceImpl {
     }
     addContainer(toAdd) {
         if (undefined !== this._containers.get(toAdd.id))
-            throw new Error("container already exists in workspace");
+            core_common_1.WorkspaceError.throwError("container-exists", { message: `container ${toAdd.id} already exists in workspace` });
         this._containers.set(toAdd.id, toAdd);
     }
     findContainer(containerId) {
@@ -424,7 +401,7 @@ class EditorImpl {
             static _cacheName = workspaceEditorName;
             static async initializeWorkspace(args) {
                 const props = await this.createBlobContainer({ scope: args.scope, metadata: { ...args.metadata, containerType: "workspace" } });
-                const dbFullName = makeWorkspaceDbFileName(workspaceDbNameWithDefault(args.dbName), "0.0.0");
+                const dbFullName = CloudSqlite_1.CloudSqlite.makeSemverName(workspaceDbNameWithDefault(args.dbName), "0.0.0");
                 await super._initializeDb({ ...args, props, dbName: dbFullName, dbType: WorkspaceSqliteDb_1.WorkspaceSqliteDb, blockSize: "4M" });
                 return props;
             }
@@ -464,28 +441,20 @@ class EditorContainerImpl extends WorkspaceContainerImpl {
         };
     }
     async createNewWorkspaceDbVersion(args) {
-        const cloudContainer = this.cloudContainer;
-        if (undefined === cloudContainer)
-            throw new Error("versions require cloud containers");
-        const oldName = this.resolveDbFileName(args.fromProps ?? {});
-        const oldDb = parseWorkspaceDbFileName(oldName);
-        const newVersion = semver.inc(oldDb.version, args.versionType, args.identifier);
-        if (!newVersion)
-            throwWorkspaceDbLoadError("invalid version", args.fromProps ?? {});
-        const newName = makeWorkspaceDbFileName(oldDb.dbName, newVersion);
-        await cloudContainer.copyDatabase(oldName, newName);
-        // return the old and new db names and versions
-        return { oldDb, newDb: { dbName: oldDb.dbName, version: newVersion } };
+        const container = this.cloudContainer;
+        if (undefined === container)
+            core_common_1.WorkspaceError.throwError("no-cloud-container", { message: "versions require cloud containers" });
+        const fromDb = { ...args.fromProps, dbName: workspaceDbNameWithDefault(args.fromProps?.dbName) };
+        return CloudSqlite_1.CloudSqlite.createNewDbVersion(container, { ...args, fromDb });
     }
     getWorkspaceDb(props) {
         return this.getEditableDb(props);
     }
     getEditableDb(props) {
         const db = this._wsDbs.get(workspaceDbNameWithDefault(props.dbName)) ?? new EditableDbImpl(props, this);
-        const isPrerelease = semver.major(db.version) === 0 || semver.prerelease(db.version);
-        if (!isPrerelease && this.cloudContainer && this.cloudContainer.queryDatabase(db.dbFileName)?.state !== "copied") {
+        if (this.cloudContainer && !CloudSqlite_1.CloudSqlite.isSemverEditable(db.dbFileName, this.cloudContainer)) {
             this._wsDbs.delete(workspaceDbNameWithDefault(props.dbName));
-            throw new Error(`${db.dbFileName} has been published and is not editable. Make a new version first.`);
+            core_common_1.CloudSqliteError.throwError("already-published", { message: `${db.dbFileName} has been published and is not editable. Make a new version first.` });
         }
         return db;
     }
@@ -517,7 +486,7 @@ class EditorContainerImpl extends WorkspaceContainerImpl {
             if (fs.existsSync(tempDbFile))
                 IModelJsFs_1.IModelJsFs.removeSync(tempDbFile);
             WorkspaceEditor_1.WorkspaceEditor.createEmptyDb({ localFileName: tempDbFile, manifest: args.manifest });
-            await CloudSqlite_1.CloudSqlite.uploadDb(this.cloudContainer, { localFileName: tempDbFile, dbName: makeWorkspaceDbFileName(workspaceDbNameWithDefault(args.dbName)) });
+            await CloudSqlite_1.CloudSqlite.uploadDb(this.cloudContainer, { localFileName: tempDbFile, dbName: CloudSqlite_1.CloudSqlite.makeSemverName(workspaceDbNameWithDefault(args.dbName)) });
             IModelJsFs_1.IModelJsFs.removeSync(tempDbFile);
         }
         return this.getWorkspaceDb(args);
@@ -529,23 +498,22 @@ class EditableDbImpl extends WorkspaceDbImpl {
         return this._container;
     }
     static validateResourceName(name) {
-        if (name.trim() !== name) {
-            throw new Error("resource name may not have leading or trailing spaces");
-        }
+        if (name.trim() !== name)
+            core_common_1.WorkspaceError.throwError("invalid-name", { message: "resource name may not have leading or trailing spaces" });
         if (name.length > 1024) {
-            throw new Error("resource name too long");
+            core_common_1.WorkspaceError.throwError("invalid-name", { message: "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");
+            core_common_1.WorkspaceError.throwError("too-large", { message: "value is too large" });
     }
     get cloudProps() {
         const props = this._container.cloudProps;
         if (props === undefined)
             return undefined;
-        const parsed = parseWorkspaceDbFileName(this.dbFileName);
+        const parsed = CloudSqlite_1.CloudSqlite.parseDbFileName(this.dbFileName);
         return { ...props, dbName: parsed.dbName, version: parsed.version };
     }
     open() {
@@ -572,8 +540,8 @@ class EditableDbImpl extends WorkspaceDbImpl {
             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}]`);
+                    core_common_1.WorkspaceError.throwError("resource-exists", { message: `resource "${rscName}" already exists` });
+                core_common_1.WorkspaceError.throwError("write-error", { message: `workspace [${sql}], rc=${rc}` });
             }
         });
         this.sqliteDb.saveChanges();
@@ -631,7 +599,7 @@ class EditableDbImpl extends WorkspaceDbImpl {
     removeFile(rscName) {
         const file = this.queryFileResource(rscName);
         if (undefined === file)
-            throw new Error(`file resource "${rscName}" does not exist`);
+            core_common_1.WorkspaceError.throwError("does-not-exist", { message: `file resource "${rscName}" does not exist` });
         if (file && fs.existsSync(file.localFileName))
             fs.unlinkSync(file.localFileName);
         this.sqliteDb[Symbols_1._nativeDb].removeEmbeddedFile(rscName);
@@ -646,15 +614,6 @@ function constructWorkspace(settings, opts) {
 function constructWorkspaceEditor() {
     return new EditorImpl();
 }
-function noLeadingOrTrailingSpaces(name, msg) {
-    if (name.trim() !== name)
-        throw new Error(`${msg} [${name}] may not have leading or trailing spaces`);
-}
-function validateWorkspaceDbName(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}]`);
-    noLeadingOrTrailingSpaces(dbName, "dbName");
-}
 /**
  * Validate that a WorkspaceContainer.Id is valid.
  * The rules for ContainerIds (from Azure, see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata):
@@ -664,41 +623,13 @@ function validateWorkspaceDbName(dbName) {
  */
 function validateWorkspaceContainerId(id) {
     if (!/^(?=.{3,63}$)[a-z0-9]+(-[a-z0-9]+)*$/g.test(id))
-        throw new Error(`invalid containerId: [${id}]`);
-}
-function validateWorkspaceDbVersion(version) {
-    version = version ?? "0.0.0";
-    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;
-}
-/**
- * Parse the name stored in a WorkspaceContainer into the dbName and version number. A single WorkspaceContainer may hold
- * many versions of the same WorkspaceDb. The name of the Db in the WorkspaceContainer is in the format "name:version". This
- * function splits them into separate strings.
- */
-function parseWorkspaceDbFileName(dbFileName) {
-    const parts = dbFileName.split(":");
-    return { dbName: parts[0], version: parts[1] };
-}
-/** Create a dbName for a WorkspaceDb from its base name and version. This will be in the format "name:version" */
-function makeWorkspaceDbFileName(dbName, version) {
-    return `${dbName}:${validateWorkspaceDbVersion(version)}`;
+        core_common_1.WorkspaceError.throwError("invalid-name", { message: `invalid containerId: [${id}]` });
 }
 exports.workspaceManifestProperty = { namespace: "workspace", name: "manifest" };
-function throwWorkspaceDbLoadError(msg, wsDbProps, db) {
-    const error = new Error(msg);
-    error.wsDbProps = wsDbProps;
-    error.wsDb = db;
-    throw error;
+function throwWorkspaceDbLoadError(message, wsDbProps, wsDb) {
+    core_common_1.WorkspaceError.throwError("load-error", { message, wsDb, wsDbProps });
 }
-function throwWorkspaceDbLoadErrors(msg, errors) {
-    const error = new Error(msg);
-    error.wsLoadErrors = errors;
-    throw error;
+function throwWorkspaceDbLoadErrors(message, wsLoadErrors) {
+    core_common_1.WorkspaceError.throwError("load-errors", { message, wsLoadErrors });
 }
 //# sourceMappingURL=WorkspaceImpl.js.map