@itwin/workspace-editor 5.13.0-dev.1 → 5.13.0-dev.11

package/README.md

@@ -10,9 +10,10 @@ There are 3 `WorkspaceResourceType`s that may be accessed by `@itwin-backend` ap
 
  1. `string` accessed via the `getString` method
  2. `blob`  binary data accessed via the `getBlob` method
- 3. `file`  extracted to a local file via the `getFile` method
+ 3. `file`  extracted to a local file via the deprecated `getFile` method (retained for existing resources)
 
 Several `WorkspaceEditor` commands require a `--type` argument to specify which `WorkspaceResourceType` to use.
+Use `string` or `blob` for new resources so applications can access their contents directly from the `WorkspaceDb`. The `file` type remains available for existing workflows that require a local file path.
 
 ## The WorkspaceContainer Directory
 
@@ -137,13 +138,15 @@ Add one or more local files as resources into a `WorkspaceDb`.
 `--type` specifies the type of resource(s) to add. Required
 
 > Note: `--rscName`  is only applicable when adding a single file.
+>
+> The `file` resource type is deprecated. Use `blob` for binary file contents or `string` for text.
 
 Examples:
 
 ```sh
-> WorkspaceEditor add proj --rscName=equipment-data --type=file r:\data\equip.dat
+> WorkspaceEditor add proj --rscName=equipment-data --type=blob r:\data\equip.dat
 WorkspaceDb [r:\workspaces\proj112\proj.itwin-workspace]
- added "r:/data/equip.dat" as file resource [equipment-data]
+ added "r:/data/equip.dat" as blob resource [equipment-data]
 
 > WorkspaceEditor add proj --type=string --root=r:\json *
 WorkspaceDb [r:\workspaces\proj112\proj.itwin-workspace]
@@ -215,6 +218,7 @@ WorkspaceDb [r:\workspaces\proj112\proj.itwin-workspace]
   name=specs.json, size=8K
   name=vendor.json, size=46K
  blobs:
+  name=equipment-data, size=134K
   name=Sparks/KDE05814.dict, size=224K
   name=Sparks/KDE05815.dict, size=307K
   name=Sparks/KDE05816.dict, size=32K
@@ -228,8 +232,6 @@ WorkspaceDb [r:\workspaces\proj112\proj.itwin-workspace]
   name=UniSpace/KRT05800.dict, size=5K
   name=UniSpace/KRT05814.dict, size=13K
   name=UniSpace/KRT05820.dict, size=7K
- files:
-  name=equipment-data, size=134K, ext="dat", date=Tue Jul 08 2021 13:55:19 GMT-0400 (Eastern Daylight Time)
 
 > WorkspaceEditor list proj --strings
 WorkspaceDb [r:\workspaces\proj112\proj.itwin-workspace]
@@ -479,7 +481,7 @@ Assume a file called `importAll.txt` contains:
 # Create a new local WorkspaceDb file and import resources into it
 
 createDb proj # create a new blank WorkspaceDb
-add proj --rscName=equipment-data --type=file r:\data\equip.dat # add file
+add proj --rscName=equipment-data --type=blob r:\data\equip.dat # add binary data
 add proj --type=string --root=r:\json * # add strings
 add proj --type=blob --root=r:\dict **\*.dict # add blob
 listDb proj # so we can tell it worked
@@ -491,7 +493,7 @@ run `importAll.txt` as an @ script using `local.json` as config:
 > WorkspaceEditor @importAll.txt --config=r:\local.json
 created WorkspaceDb r:\workspaces\proj112\proj.itwin-workspace
 WorkspaceDb [r:\workspaces\proj112\proj.itwin-workspace]
- added "r:/data/equip.dat" as file resource [equipment-data]
+ added "r:/data/equip.dat" as blob resource [equipment-data]
 WorkspaceDb [r:\workspaces\proj112\proj.itwin-workspace]
  added "r:\json\contracts.json" as string resource [contracts.json]
  added "r:\json\firecode.json" as string resource [firecode.json]
@@ -519,6 +521,7 @@ WorkspaceDb [r:\workspaces\proj112\proj.itwin-workspace]
   name=specs.json, size=8K
   name=vendor.json, size=46K
  blobs:
+  name=equipment-data, size=134K
   name=Sparks/KDE05814.dict, size=224K
   name=Sparks/KDE05815.dict, size=307K
   name=Sparks/KDE05816.dict, size=32K
@@ -533,8 +536,6 @@ WorkspaceDb [r:\workspaces\proj112\proj.itwin-workspace]
   name=UniSpace/KRT05814.dict, size=13K
   name=UniSpace/KRT05820.dict, size=7K
   name=UniSpace/KRT06519.dict, size=687
- files:
-  name=equipment-data, size=134K, ext="dat", date=Tue Jul 08 2014 13:55:19 GMT-0400 (Eastern Daylight Time)
 ```
 
 Then, a separate file called `createCloud.txt` contains:

package/lib/WorkspaceEditor.js

@@ -169,6 +169,8 @@ async function addResource(args) {
                     wsFile.addBlob(name, val);
                 }
                 else {
+                    // Preserve the deprecated file-resource command so existing workspace maintenance scripts continue to work.
+                    // eslint-disable-next-line @typescript-eslint/no-deprecated
                     wsFile.addFile(name, file);
                 }
                 showMessage(` added "${file}" as ${args.type} resource [${name}]`);
@@ -197,6 +199,7 @@ async function replaceResource(args) {
                     wsFile.updateBlob(name, val);
                 }
                 else {
+                    // eslint-disable-next-line @typescript-eslint/no-deprecated
                     wsFile.updateFile(name, file);
                 }
                 showMessage(` updated "${file}" as ${args.type} resource [${name}]`);
@@ -222,6 +225,7 @@ async function extractResource(args) {
             fs.writeFileSync(args.fileName, verify(file.getBlob(args.rscName)));
         }
         else {
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
             verify(file.getFile(args.rscName, args.fileName));
         }
         showMessage(` ${args.type} resource [${args.rscName}] extracted to "${args.fileName}"`);
@@ -235,6 +239,7 @@ async function removeResource(args) {
         else if (args.type === "blob")
             wsFile.removeBlob(args.rscName);
         else
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
             wsFile.removeFile(args.rscName);
         showMessage(` removed ${args.type} resource [${args.rscName}]`);
     });
@@ -434,7 +439,17 @@ function runCommand(cmd, readonly) {
         }
     };
 }
-const type = { alias: "t", describe: "Type of resource", choices: ["blob", "string", "file"], demandOption: true };
+const type = {
+    alias: "t",
+    describe: "Type of resource",
+    choices: ["blob", "string", "file"],
+    demandOption: true,
+    coerce: (value) => {
+        if (value === "file")
+            console.warn("Warning: --type=file is deprecated but supported for compatibility. Use --type=blob or --type=string for new resources.");
+        return value;
+    },
+};
 const addOrReplace = {
     rscName: { alias: "n", describe: "Resource name for file", string: true },
     root: { alias: "r", describe: "Root directory. Path parts after this will be saved in resource name", string: true },

package/package.json

@@ -2,7 +2,7 @@
   "name": "@itwin/workspace-editor",
   "license": "MIT",
   "main": "lib/WorkspaceEditor.js",
-  "version": "5.13.0-dev.1",
+  "version": "5.13.0-dev.11",
   "bin": {
     "WorkspaceEditor": "./lib/WorkspaceEditor.js"
   },
@@ -15,11 +15,11 @@
     "directory": "utils/workspace-editor"
   },
   "dependencies": {
-    "glob": "^10.5.0",
+    "glob": "^13.0.6",
     "yargs": "^17.4.0",
-    "@itwin/core-common": "5.13.0-dev.1",
-    "@itwin/core-bentley": "5.13.0-dev.1",
-    "@itwin/core-backend": "5.13.0-dev.1"
+    "@itwin/core-common": "5.13.0-dev.11",
+    "@itwin/core-bentley": "5.13.0-dev.11",
+    "@itwin/core-backend": "5.13.0-dev.11"
   },
   "devDependencies": {
     "@itwin/eslint-plugin": "^6.0.0",
@@ -30,7 +30,7 @@
     "mocha": "^11.1.0",
     "rimraf": "^6.0.1",
     "typescript": "~5.6.2",
-    "@itwin/build-tools": "5.13.0-dev.1"
+    "@itwin/build-tools": "5.13.0-dev.11"
   },
   "scripts": {
     "build": "tsc 1>&2",