@itwin/workspace-editor 4.8.0-dev.3 → 4.8.0-dev.5

package/lib/WorkspaceEditor.js

@@ -11,12 +11,14 @@ const path_1 = require("path");
 const readline = require("readline");
 const Yargs = require("yargs");
 const core_backend_1 = require("@itwin/core-backend");
+const WorkspaceImpl_1 = require("@itwin/core-backend/lib/cjs/internal/workspace/WorkspaceImpl");
 const core_bentley_1 = require("@itwin/core-bentley");
 const core_common_1 = require("@itwin/core-common");
 // cspell:ignore nodir nocase
 /* eslint-disable id-blacklist,no-console */
 /** Currently executing an "@" script? */
 let inScript = false;
+let wsEditor;
 async function askQuestion(query) {
     const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
     return new Promise((resolve) => rl.question(query, (ans) => {
@@ -43,14 +45,13 @@ function friendlyFileSize(size) {
     const units = Math.floor(Math.log(size) / Math.log(1024));
     return `${Math.round(size / Math.pow(1024, units))}${["", "K", "M", "G", "T"][units]}`;
 }
-/** Create a new empty WorkspaceDb  */
-async function createWorkspaceDb(args) {
-    args.writeable = true;
-    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();
-}
+// /** Create a new empty WorkspaceDb  */
+// async function createWorkspaceDb(args: CreateWorkspaceDbOpt) {
+//   const wsFile = WorkspaceEditor.createEmptyDb(args);, IModelHost.appWorkspace.getContainer(args));
+//   await wsFile.createDb({ manifest: { workspaceName: args.workspaceName } });
+//   showMessage(`created WorkspaceDb ${wsFile.sqliteDb.nativeDb.getFilePath()}`);
+//   wsFile.close();
+// }
 /** open, call a function to process, then close a WorkspaceDb */
 async function processWorkspace(args, ws, fn) {
     ws.open();
@@ -63,10 +64,15 @@ async function processWorkspace(args, ws, fn) {
     }
 }
 /** get a WorkspaceContainer that may or may not be a cloud container. */
-function getContainer(args) {
-    args.writeable = true;
+function getWriteContainer(args) {
+    return wsEditor.getContainer(args);
+}
+function getReadContainer(args) {
     return core_backend_1.IModelHost.appWorkspace.getContainer(args);
 }
+function getContainer(args) {
+    return true !== args.forReadOnly ? getWriteContainer(args) : getReadContainer(args);
+}
 /** get a WorkspaceContainer that is expected to be a cloud container, throw otherwise. */
 function getCloudContainer(args) {
     const container = getContainer(args);
@@ -76,24 +82,21 @@ function getCloudContainer(args) {
     return cloudContainer;
 }
 function fixVersionArg(args) {
-    const dbParts = core_backend_1.WorkspaceContainer.parseDbFileName(args.dbName);
+    const dbParts = (0, WorkspaceImpl_1.parseWorkspaceDbFileName)(args.dbName);
     args.dbName = dbParts.dbName;
     args.version = args.version ?? dbParts.version;
-    args.dbFileName = core_backend_1.WorkspaceContainer.makeDbFileName(dbParts.dbName, dbParts.version);
+    args.dbFileName = (0, WorkspaceImpl_1.makeWorkspaceDbFileName)(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 = 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`);
-    await processWorkspace(args, ws, fn);
+    const db = getWriteContainer(args).getEditableDb(args);
+    await processWorkspace(args, db, fn);
 }
 /** Open for read, call a function to process, then close a WorkspaceDb */
 async function readWorkspace(args, fn) {
     fixVersionArg(args);
-    return processWorkspace(args, core_backend_1.WorkspaceDb.construct(args, getContainer(args)), fn);
+    return processWorkspace(args, getContainer(args).getWorkspaceDb(args), fn);
 }
 /** List the contents of a WorkspaceDb */
 async function listWorkspaceDb(args) {
@@ -242,7 +245,7 @@ async function removeResource(args) {
 async function vacuumWorkspaceDb(args) {
     const container = getContainer(args);
     fixVersionArg(args);
-    const localFile = core_backend_1.WorkspaceDb.construct(args, container).dbFileName;
+    const localFile = (0, WorkspaceImpl_1.constructWorkspaceDb)(args, container).dbFileName;
     doVacuum(localFile, container.cloudContainer);
 }
 /** Either upload or download a WorkspaceDb to/from a cloud WorkspaceContainer. Shows progress % during transfer */
@@ -274,7 +277,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.WorkspaceDb.fileExt}`;
+        args.localFileName = `${args.localFileName}.${WorkspaceImpl_1.workspaceDbFileExt}`;
     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 () => {
@@ -285,8 +288,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.WorkspaceDb.fileExt}`;
-    const dbParts = core_backend_1.WorkspaceContainer.parseDbFileName(args.dbName);
+        args.localFileName = `${args.localFileName}.${WorkspaceImpl_1.workspaceDbFileExt}`;
+    const dbParts = (0, WorkspaceImpl_1.parseWorkspaceDbFileName)(args.dbName);
     if (!dbParts.version)
         throw new Error("exportDb requires a version");
     await performTransfer(getCloudContainer(args), "download", args);
@@ -333,9 +336,9 @@ async function detachWorkspace(args) {
 async function copyWorkspaceDb(args) {
     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 newVersion = (0, WorkspaceImpl_1.parseWorkspaceDbFileName)(args.newDbName);
+    (0, WorkspaceImpl_1.validateWorkspaceDbName)(newVersion.dbName);
+    const newName = (0, WorkspaceImpl_1.makeWorkspaceDbFileName)(newVersion.dbName, (0, WorkspaceImpl_1.validateWorkspaceDbVersion)(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)}`);
@@ -343,9 +346,9 @@ async function copyWorkspaceDb(args) {
 /** Make a copy of a WorkspaceDb with a new name. */
 async function versionWorkspaceDb(args) {
     fixVersionArg(args);
-    const container = getContainer(args);
-    const result = await container.makeNewVersion(args, args.versionType);
-    showMessage(`created new version: [${result.newName}] from [${result.oldName}] in ${sayContainer(args)}`);
+    const container = getWriteContainer(args);
+    const result = await container.createNewWorkspaceDbVersion({ fromProps: args, versionType: args.versionType });
+    showMessage(`created new version: [${result.newDb.dbName}] from [${result.oldDb.dbName}] in ${sayContainer(args)}`);
 }
 /** pin a WorkspaceDb from a WorkspaceContainer. */
 async function preFetchWorkspaceDb(args) {
@@ -398,8 +401,10 @@ async function queryWorkspaceDbs(args) {
     }
 }
 /** Start `IModelHost`, then run a WorkspaceEditor command. Errors are logged to console. */
-function runCommand(cmd) {
+function runCommand(cmd, readonly) {
     return async (args) => {
+        if (readonly === "readonly")
+            args.forReadOnly = true;
         if (inScript)
             return cmd(args);
         try {
@@ -416,6 +421,7 @@ function runCommand(cmd) {
                 core_bentley_1.Logger.setLevel("CloudSqlite", core_bentley_1.LogLevel.Trace);
                 core_backend_1.IModelHost.appWorkspace.getCloudCache().setLogMask(core_backend_1.CloudSqlite.LoggingMask.All);
             }
+            wsEditor = core_backend_1.WorkspaceEditor.construct();
             await cmd(args);
         }
         catch (e) {
@@ -446,7 +452,7 @@ Yargs.options({
     nRequests: { describe: "Number of simultaneous http requests for cloud operations", number: true, hidden: true },
     containerId: { alias: "c", describe: "ContainerId for WorkspaceDb", string: true, demandOption: true },
     user: { describe: "String shown in cloud container locked message", string: true, default: "workspace-editor" },
-    baseUri: { alias: "b", describe: "The base uri for the container", string: true },
+    baseUri: { describe: "The base uri for the container", string: true },
     accessToken: { describe: "Token that grants access to the container (either SAS or account key)", string: true, default: "" },
     storageType: { describe: "Cloud storage module type", string: true, default: "azure" },
     logging: { describe: "enable log messages", boolean: true, default: false, hidden: true },
@@ -485,18 +491,21 @@ Yargs.command({
         blobs: { alias: "b", describe: "list blob resources", boolean: true, default: false },
         files: { alias: "f", describe: "list file resources", boolean: true, default: false },
     },
-    handler: runCommand(listWorkspaceDb),
+    handler: runCommand(listWorkspaceDb, "readonly"),
 });
 Yargs.command({
     command: "deleteDb <dbName>",
     describe: "delete a WorkspaceDb from a cloud container",
     handler: runCommand(deleteWorkspaceDb),
 });
-Yargs.command({
-    command: "createDb <dbName>",
-    describe: "create a new WorkspaceDb",
-    handler: runCommand(createWorkspaceDb),
-});
+// Yargs.command<CreateWorkspaceDbOpt>({
+//   command: "createDb <dbName>",
+//   describe: "create a new WorkspaceDb",
+//   builder: {
+//     workspaceName: { describe: "user interface name for the WorkspaceDb", string: true },
+//   },
+//   handler: runCommand(createWorkspaceDb),
+// });
 Yargs.command({
     command: "copyDb <dbName> <newDbName>",
     describe: "make a copy of a WorkspaceDb in a cloud container with a new name",
@@ -536,7 +545,7 @@ Yargs.command({
 Yargs.command({
     command: "queryDbs [glob]",
     describe: "query the list of WorkspaceDbs in a cloud container",
-    handler: runCommand(queryWorkspaceDbs),
+    handler: runCommand(queryWorkspaceDbs, "readonly"),
 });
 Yargs.command({
     command: "acquireLock",

package/package.json

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