@itwin/workspace-editor 4.5.0-dev.9 → 4.6.0-dev.0

package/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2017-2023 Bentley Systems, Incorporated. All rights reserved.
+Copyright © 2017-2024 Bentley Systems, Incorporated. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/lib/WorkspaceEditor.js

@@ -17,7 +17,6 @@ const core_common_1 = require("@itwin/core-common");
 /* eslint-disable id-blacklist,no-console */
 /** Currently executing an "@" script? */
 let inScript = false;
-let logTimer;
 async function askQuestion(query) {
     const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
     return new Promise((resolve) => rl.question(query, (ans) => {
@@ -25,13 +24,8 @@ async function askQuestion(query) {
         resolve(ans);
     }));
 }
-function flushLog() {
-    core_backend_1.IModelHost.platform.flushLog();
-}
-/** show a message, potentially flushing log messages first */
+/** show a message */
 function showMessage(msg) {
-    if (logTimer)
-        flushLog();
     console.log(msg);
 }
 /** perform a vacuum on a database, with a message while it's happening */
@@ -52,7 +46,7 @@ function friendlyFileSize(size) {
 /** Create a new empty WorkspaceDb  */
 async function createWorkspaceDb(args) {
     args.writeable = true;
-    const wsFile = new core_backend_1.EditableWorkspaceDb(args, core_backend_1.IModelHost.appWorkspace.getContainer(args));
+    const wsFile = core_backend_1.EditableWorkspaceDb.construct(args, core_backend_1.IModelHost.appWorkspace.getContainer(args));
     await wsFile.createDb();
     showMessage(`created WorkspaceDb ${wsFile.sqliteDb.nativeDb.getFilePath()}`);
     wsFile.close();
@@ -82,15 +76,15 @@ function getCloudContainer(args) {
     return cloudContainer;
 }
 function fixVersionArg(args) {
-    const dbParts = core_backend_1.ITwinWorkspaceContainer.parseDbFileName(args.dbName);
+    const dbParts = core_backend_1.WorkspaceContainer.parseDbFileName(args.dbName);
     args.dbName = dbParts.dbName;
     args.version = args.version ?? dbParts.version;
-    args.dbFileName = core_backend_1.ITwinWorkspaceContainer.makeDbFileName(dbParts.dbName, dbParts.version);
+    args.dbFileName = core_backend_1.WorkspaceContainer.makeDbFileName(dbParts.dbName, dbParts.version);
 }
 /** Open for write, call a function to process, then close a WorkspaceDb */
 async function editWorkspace(args, fn) {
     fixVersionArg(args);
-    const ws = new core_backend_1.EditableWorkspaceDb(args, getContainer(args));
+    const ws = core_backend_1.EditableWorkspaceDb.construct(args, getContainer(args));
     const cloudContainer = ws.container.cloudContainer;
     if (cloudContainer && cloudContainer.queryDatabase(ws.dbFileName)?.state !== "copied")
         throw new Error(`${args.dbFileName} is not editable. Create a new version first`);
@@ -99,7 +93,7 @@ async function editWorkspace(args, fn) {
 /** Open for read, call a function to process, then close a WorkspaceDb */
 async function readWorkspace(args, fn) {
     fixVersionArg(args);
-    return processWorkspace(args, new core_backend_1.ITwinWorkspaceDb(args, getContainer(args)), fn);
+    return processWorkspace(args, core_backend_1.WorkspaceDb.construct(args, getContainer(args)), fn);
 }
 /** List the contents of a WorkspaceDb */
 async function listWorkspaceDb(args) {
@@ -248,7 +242,7 @@ async function removeResource(args) {
 async function vacuumWorkspaceDb(args) {
     const container = getContainer(args);
     fixVersionArg(args);
-    const localFile = new core_backend_1.ITwinWorkspaceDb(args, container).dbFileName;
+    const localFile = core_backend_1.WorkspaceDb.construct(args, container).dbFileName;
     doVacuum(localFile, container.cloudContainer);
 }
 /** Either upload or download a WorkspaceDb to/from a cloud WorkspaceContainer. Shows progress % during transfer */
@@ -280,7 +274,7 @@ async function performTransfer(container, direction, args) {
 async function importWorkspaceDb(args) {
     const container = getCloudContainer(args);
     if ("" === (0, path_1.extname)(args.localFileName))
-        args.localFileName = `${args.localFileName}.${core_backend_1.ITwinWorkspaceDb.fileExt}`;
+        args.localFileName = `${args.localFileName}.${core_backend_1.WorkspaceDb.fileExt}`;
     if (!core_backend_1.IModelJsFs.existsSync(args.localFileName))
         args.localFileName = (0, path_1.join)(args.directory ?? core_backend_1.IModelHost.appWorkspace.containerDir, args.localFileName);
     await core_backend_1.CloudSqlite.withWriteLock({ ...args, container }, async () => {
@@ -291,8 +285,8 @@ async function importWorkspaceDb(args) {
 /** export a WorkspaceDb from a cloud WorkspaceContainer. */
 async function exportWorkspaceDb(args) {
     if (!(0, path_1.extname)(args.localFileName))
-        args.localFileName = `${args.localFileName}.${core_backend_1.ITwinWorkspaceDb.fileExt}`;
-    const dbParts = core_backend_1.ITwinWorkspaceContainer.parseDbFileName(args.dbName);
+        args.localFileName = `${args.localFileName}.${core_backend_1.WorkspaceDb.fileExt}`;
+    const dbParts = core_backend_1.WorkspaceContainer.parseDbFileName(args.dbName);
     if (!dbParts.version)
         throw new Error("exportDb requires a version");
     await performTransfer(getCloudContainer(args), "download", args);
@@ -337,19 +331,20 @@ async function detachWorkspace(args) {
 }
 /** Make a copy of a WorkspaceDb with a new name. */
 async function copyWorkspaceDb(args) {
-    const container = getCloudContainer(args);
-    const oldName = core_backend_1.ITwinWorkspaceContainer.resolveCloudFileName(container, args);
-    const newVersion = core_backend_1.ITwinWorkspaceContainer.parseDbFileName(args.newDbName);
-    core_backend_1.ITwinWorkspaceContainer.validateDbName(newVersion.dbName);
-    const newName = core_backend_1.ITwinWorkspaceContainer.makeDbFileName(newVersion.dbName, core_backend_1.ITwinWorkspaceContainer.validateVersion(newVersion.version));
-    await core_backend_1.CloudSqlite.withWriteLock({ ...args, container }, async () => container.copyDatabase(oldName, newName));
+    const container = getContainer(args);
+    const oldName = container.resolveDbFileName(args);
+    const newVersion = core_backend_1.WorkspaceContainer.parseDbFileName(args.newDbName);
+    core_backend_1.WorkspaceContainer.validateDbName(newVersion.dbName);
+    const newName = core_backend_1.WorkspaceContainer.makeDbFileName(newVersion.dbName, core_backend_1.WorkspaceContainer.validateVersion(newVersion.version));
+    const cloudContainer = getCloudContainer(args);
+    await core_backend_1.CloudSqlite.withWriteLock({ ...args, container: cloudContainer }, async () => cloudContainer.copyDatabase(oldName, newName));
     showMessage(`copied WorkspaceDb [${oldName}] to [${newName}] in ${sayContainer(args)}`);
 }
 /** Make a copy of a WorkspaceDb with a new name. */
 async function versionWorkspaceDb(args) {
     fixVersionArg(args);
-    const container = getCloudContainer(args);
-    const result = await core_backend_1.ITwinWorkspaceContainer.makeNewVersion(container, args, args.versionType);
+    const container = getContainer(args);
+    const result = await container.makeNewVersion(args, args.versionType);
     showMessage(`created new version: [${result.newName}] from [${result.oldName}] in ${sayContainer(args)}`);
 }
 /** pin a WorkspaceDb from a WorkspaceContainer. */
@@ -420,7 +415,6 @@ function runCommand(cmd) {
                 core_bentley_1.Logger.initializeToConsole();
                 core_bentley_1.Logger.setLevel("CloudSqlite", core_bentley_1.LogLevel.Trace);
                 core_backend_1.IModelHost.appWorkspace.getCloudCache().setLogMask(core_backend_1.CloudSqlite.LoggingMask.All);
-                logTimer = setInterval(() => flushLog(), 250); // logging from other threads is buffered. This causes it to appear every 1/4 second.
             }
             await cmd(args);
         }
@@ -431,10 +425,6 @@ function runCommand(cmd) {
                 console.log(core_bentley_1.BentleyError.getErrorMessage(e));
         }
         finally {
-            if (logTimer) {
-                flushLog();
-                clearInterval(logTimer);
-            }
             await core_backend_1.IModelHost.shutdown();
         }
     };

package/package.json

@@ -2,7 +2,7 @@
   "name": "@itwin/workspace-editor",
   "license": "MIT",
   "main": "lib/WorkspaceEditor.js",
-  "version": "4.5.0-dev.9",
+  "version": "4.6.0-dev.0",
   "bin": {
     "WorkspaceEditor": "./lib/WorkspaceEditor.js"
   },
@@ -17,9 +17,9 @@
   "dependencies": {
     "glob": "^7.1.2",
     "yargs": "^17.4.0",
-    "@itwin/core-bentley": "4.5.0-dev.9",
-    "@itwin/core-common": "4.5.0-dev.9",
-    "@itwin/core-backend": "4.5.0-dev.9"
+    "@itwin/core-backend": "4.6.0-dev.0",
+    "@itwin/core-common": "4.6.0-dev.0",
+    "@itwin/core-bentley": "4.6.0-dev.0"
   },
   "devDependencies": {
     "@itwin/eslint-plugin": "4.0.0-dev.44",
@@ -31,7 +31,7 @@
     "mocha": "^10.2.0",
     "rimraf": "^3.0.2",
     "typescript": "~5.0.2",
-    "@itwin/build-tools": "4.5.0-dev.9"
+    "@itwin/build-tools": "4.6.0-dev.0"
   },
   "scripts": {
     "build": "tsc 1>&2",