@itwin/core-backend 3.0.0-dev.148 → 3.0.0-dev.153

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,7 +7,7 @@
7
7
  * @module Workspace
8
8
  */
9
9
  Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.EditableWorkspaceFile = exports.WorkspaceFile = exports.ITwinWorkspace = void 0;
10
+ exports.EditableWorkspaceDb = exports.ITwinWorkspaceDb = exports.ITwinWorkspaceContainer = exports.ITwinWorkspace = void 0;
11
11
  const crypto_1 = require("crypto");
12
12
  const fs = require("fs-extra");
13
13
  const path_1 = require("path");
@@ -17,6 +17,7 @@ const core_common_1 = require("@itwin/core-common");
17
17
  const IModelJsFs_1 = require("../IModelJsFs");
18
18
  const SQLiteDb_1 = require("../SQLiteDb");
19
19
  const CloudSqlite_1 = require("./CloudSqlite");
20
+ // cspell:ignore rowid
20
21
  /** The names of Settings used by Workspace
21
22
  * @beta
22
23
  */
@@ -24,40 +25,36 @@ var WorkspaceSetting;
24
25
  (function (WorkspaceSetting) {
25
26
  WorkspaceSetting["ContainerAlias"] = "workspace/container/alias";
26
27
  })(WorkspaceSetting || (WorkspaceSetting = {}));
27
- const containerFileExt = "itwin-workspace-container";
28
+ const workspaceDbFileExt = "itwin-workspace";
28
29
  /** @internal */
29
30
  class ITwinWorkspace {
30
31
  constructor(settings, opts) {
31
- var _a, _b;
32
+ var _a;
32
33
  this._containers = new Map();
33
34
  this.settings = settings;
34
35
  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");
35
- this.filesDir = (_b = opts === null || opts === void 0 ? void 0 : opts.filesDir) !== null && _b !== void 0 ? _b : (0, path_1.join)(this.containerDir, "Files");
36
36
  }
37
- addContainer(container) {
38
- if (undefined !== this._containers.get(container.containerId))
39
- throw new Error("container id already exists in workspace");
40
- this._containers.set(container.containerId, container);
37
+ addContainer(toAdd) {
38
+ if (undefined !== this._containers.get(toAdd.id))
39
+ throw new Error("container already exists in workspace");
40
+ this._containers.set(toAdd.id, toAdd);
41
41
  }
42
- async getContainer(props, cloudProps) {
42
+ getContainer(props) {
43
43
  var _a;
44
44
  const id = this.resolveContainerId(props);
45
45
  if (undefined === id)
46
- throw new Error(`can't resolve container name [${props}]`);
47
- const container = (_a = this._containers.get(id)) !== null && _a !== void 0 ? _a : new WorkspaceFile(id, this);
48
- if (!container.isOpen) {
49
- if (cloudProps)
50
- await CloudSqlite_1.CloudSqlite.downloadDb(container, cloudProps);
51
- container.open();
52
- }
53
- return container;
46
+ throw new Error(`can't resolve workspace container name [${props.containerName}]`);
47
+ return (_a = this._containers.get(id)) !== null && _a !== void 0 ? _a : new ITwinWorkspaceContainer(this, id);
48
+ }
49
+ async getWorkspaceDb(props) {
50
+ return this.getContainer(props).getWorkspaceDb(props);
54
51
  }
55
52
  async loadSettingsDictionary(settingRsc, priority) {
56
- const container = await this.getContainer(settingRsc.container);
57
- const setting = container.getString(settingRsc.rscName);
53
+ const db = await this.getWorkspaceDb(settingRsc);
54
+ const setting = db.getString(settingRsc.rscName);
58
55
  if (undefined === setting)
59
56
  throw new Error(`could not load setting resource ${settingRsc.rscName}`);
60
- this.settings.addJson(`${container.containerId}/${settingRsc.rscName}`, priority, setting);
57
+ this.settings.addJson(`${db.container.id}/${db.dbName}/${settingRsc.rscName}`, priority, setting);
61
58
  }
62
59
  close() {
63
60
  this.settings.close();
@@ -65,91 +62,140 @@ class ITwinWorkspace {
65
62
  container.close();
66
63
  this._containers.clear();
67
64
  }
68
- dropContainer(toDrop) {
69
- const id = toDrop.containerId;
70
- const container = this._containers.get(id);
71
- if (container === toDrop) {
72
- container.close();
73
- this._containers.delete(id);
74
- }
75
- }
76
65
  resolveContainerId(props) {
77
- if (typeof props === "object")
78
- return props.id;
66
+ if (props.containerId)
67
+ return props.containerId; // if the container id is supplied, just use it
79
68
  const id = this.settings.resolveSetting(WorkspaceSetting.ContainerAlias, (val) => {
80
69
  if (Array.isArray(val)) {
81
70
  for (const entry of val) {
82
- if (typeof entry === "object" && entry.name === props && typeof entry.id === "string")
71
+ if (typeof entry === "object" && entry.name === props.containerName && typeof entry.id === "string")
83
72
  return entry.id;
84
73
  }
85
74
  }
86
75
  return undefined; // keep going through all settings dictionaries
87
- }, props);
76
+ }, props.containerName);
88
77
  if (undefined === id)
89
78
  throw new Error("Unable to resolve container id.");
90
79
  return id;
91
80
  }
92
81
  }
93
82
  exports.ITwinWorkspace = ITwinWorkspace;
83
+ /** @internal */
84
+ class ITwinWorkspaceContainer {
85
+ constructor(workspace, id) {
86
+ this._wsDbs = new Map();
87
+ ITwinWorkspaceContainer.validateContainerId(id);
88
+ this.workspace = workspace;
89
+ this.id = id;
90
+ workspace.addContainer(this);
91
+ this.filesDir = (0, path_1.join)(this.dirName, "Files");
92
+ }
93
+ get dirName() { return (0, path_1.join)(this.workspace.containerDir, this.id); }
94
+ /** rules for ContainerIds (from Azure, see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata)
95
+ * - may only contain lower case letters, numbers or dashes
96
+ * - may not start or end with with a dash nor have more than one dash in a row
97
+ * - may not be shorter than 3 or longer than 63 characters
98
+ */
99
+ static validateContainerId(id) {
100
+ if (!/^(?=.{3,63}$)[a-z0-9]+(-[a-z0-9]+)*$/g.test(id))
101
+ throw new Error(`invalid containerId: [${id}]`);
102
+ }
103
+ addWorkspaceDb(toAdd) {
104
+ if (undefined !== this._wsDbs.get(toAdd.dbName))
105
+ throw new Error("dbName already exists in workspace");
106
+ this._wsDbs.set(toAdd.dbName, toAdd);
107
+ }
108
+ async getWorkspaceDb(props) {
109
+ var _a;
110
+ const db = (_a = this._wsDbs.get(props.dbName)) !== null && _a !== void 0 ? _a : new ITwinWorkspaceDb(props.dbName, this);
111
+ if (!db.isOpen) {
112
+ if (props.cloudProps)
113
+ await CloudSqlite_1.CloudSqlite.downloadDb({ ...db, ...props.cloudProps, containerId: this.id });
114
+ db.open();
115
+ }
116
+ return db;
117
+ }
118
+ dropWorkspaceDb(toDrop) {
119
+ const name = toDrop.dbName;
120
+ const wsDb = this._wsDbs.get(name);
121
+ if (wsDb === toDrop) {
122
+ wsDb.close();
123
+ this._wsDbs.delete(name);
124
+ }
125
+ }
126
+ close() {
127
+ for (const [_name, db] of this._wsDbs)
128
+ db.close();
129
+ this._wsDbs.clear();
130
+ }
131
+ purgeContainerFiles() {
132
+ IModelJsFs_1.IModelJsFs.purgeDirSync(this.filesDir);
133
+ }
134
+ }
135
+ exports.ITwinWorkspaceContainer = ITwinWorkspaceContainer;
94
136
  /**
95
- * A local file holding a WorkspaceContainer.
137
+ * A local file holding a WorkspaceDb.
96
138
  * @beta
97
139
  */
98
- class WorkspaceFile {
99
- constructor(containerId, workspace) {
100
- var _a;
101
- this.db = new SQLiteDb_1.SQLiteDb(); // eslint-disable-line @typescript-eslint/naming-convention
102
- this.onContainerClosed = new core_bentley_1.BeEvent();
103
- [containerId, this.dbAlias] = containerId.split("#", 2);
104
- WorkspaceFile.validateContainerId(containerId);
105
- this.workspace = workspace;
106
- this.containerId = containerId;
107
- this.dbAlias = (_a = this.dbAlias) !== null && _a !== void 0 ? _a : "v0";
108
- this.localFile = (0, path_1.join)(workspace.containerDir, `${this.containerId}.${containerFileExt}`);
109
- workspace.addContainer(this);
140
+ class ITwinWorkspaceDb {
141
+ constructor(dbName, container) {
142
+ this.sqliteDb = new SQLiteDb_1.SQLiteDb(); // eslint-disable-line @typescript-eslint/naming-convention
143
+ this.onClosed = new core_bentley_1.BeEvent();
144
+ ITwinWorkspaceDb.validateDbName(dbName);
145
+ this.dbName = dbName;
146
+ this.container = container;
147
+ this.localFile = (0, path_1.join)(container.dirName, `${dbName}.${workspaceDbFileExt}`);
148
+ container.addWorkspaceDb(this);
149
+ }
150
+ static noLeadingOrTrailingSpaces(name, msg) {
151
+ if (name.trim() !== name)
152
+ throw new Error(`${msg} [${name}] may not have leading or tailing spaces`);
110
153
  }
111
- get containerFilesDir() { return (0, path_1.join)(this.workspace.filesDir, this.containerId); }
112
- get isOpen() { return this.db.isOpen; }
154
+ static validateDbName(dbName) {
155
+ if (dbName === "" || dbName.length > 255 || /[#\.<>:"/\\"`'|?*\u0000-\u001F]/g.test(dbName) || /^(con|prn|aux|nul|com\d|lpt\d)$/i.test(dbName))
156
+ throw new Error(`invalid dbName: [${dbName}]`);
157
+ this.noLeadingOrTrailingSpaces(dbName, "dbName");
158
+ }
159
+ get isOpen() { return this.sqliteDb.isOpen; }
113
160
  queryFileResource(rscName) {
114
- const info = this.db.nativeDb.queryEmbeddedFile(rscName);
161
+ const info = this.sqliteDb.nativeDb.queryEmbeddedFile(rscName);
115
162
  if (undefined === info)
116
163
  return undefined;
117
164
  // since resource names can contain illegal characters, path separators, etc., we make the local file name from its hash, in hex.
118
- let localFileName = (0, path_1.join)(this.containerFilesDir, (0, crypto_1.createHash)("sha1").update(rscName).digest("hex"));
165
+ let localFileName = (0, path_1.join)(this.container.filesDir, (0, crypto_1.createHash)("sha1").update(rscName).digest("hex"));
119
166
  if (info.fileExt !== "") // since some applications may expect to see the extension, append it here if it was supplied.
120
167
  localFileName = `${localFileName}.${info.fileExt}`;
121
168
  return { localFileName, info };
122
169
  }
123
- static noLeadingOrTrailingSpaces(name, msg) {
124
- if (name.trim() !== name)
125
- throw new Error(`${msg} [${name}] may not have leading or tailing spaces`);
126
- }
127
- static validateContainerId(id) {
128
- if (id === "" || id.length > 255 || /[#\.<>:"/\\"`'|?*\u0000-\u001F]/g.test(id) || /^(con|prn|aux|nul|com\d|lpt\d)$/i.test(id))
129
- throw new Error(`invalid containerId: [${id}]`);
130
- this.noLeadingOrTrailingSpaces(id, "containerId");
131
- }
132
- purgeContainerFiles() {
133
- IModelJsFs_1.IModelJsFs.purgeDirSync(this.containerFilesDir);
134
- }
135
170
  open() {
136
- this.db.openDb(this.localFile, core_bentley_1.OpenMode.Readonly);
171
+ this.sqliteDb.openDb(this.localFile, core_bentley_1.OpenMode.Readonly);
137
172
  }
138
173
  close() {
139
174
  if (this.isOpen) {
140
- this.onContainerClosed.raiseEvent();
141
- this.db.closeDb();
142
- this.workspace.dropContainer(this);
175
+ this.onClosed.raiseEvent();
176
+ this.sqliteDb.closeDb();
177
+ this.container.dropWorkspaceDb(this);
143
178
  }
144
179
  }
145
180
  getString(rscName) {
146
- return this.db.withSqliteStatement("SELECT value from strings WHERE id=?", (stmt) => {
181
+ return this.sqliteDb.withSqliteStatement("SELECT value from strings WHERE id=?", (stmt) => {
147
182
  stmt.bindString(1, rscName);
148
183
  return core_bentley_1.DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValueString(0) : undefined;
149
184
  });
150
185
  }
186
+ /** Get a BlobIO reader for a blob WorkspaceResource.
187
+ * @note when finished, caller must call `close` on the BlobIO.
188
+ */
189
+ getBlobReader(rscName) {
190
+ return this.sqliteDb.withSqliteStatement("SELECT rowid from blobs WHERE id=?", (stmt) => {
191
+ stmt.bindString(1, rscName);
192
+ const blobReader = new imodeljs_native_1.IModelJsNative.BlobIO();
193
+ blobReader.open(this.sqliteDb.nativeDb, { tableName: "blobs", columnName: "value", row: stmt.getValueInteger(0) });
194
+ return blobReader;
195
+ });
196
+ }
151
197
  getBlob(rscName) {
152
- return this.db.withSqliteStatement("SELECT value from blobs WHERE id=?", (stmt) => {
198
+ return this.sqliteDb.withSqliteStatement("SELECT value from blobs WHERE id=?", (stmt) => {
153
199
  stmt.bindString(1, rscName);
154
200
  return core_bentley_1.DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValueBlob(0) : undefined;
155
201
  });
@@ -169,27 +215,27 @@ class WorkspaceFile {
169
215
  fs.removeSync(localFileName);
170
216
  else
171
217
  IModelJsFs_1.IModelJsFs.recursiveMkDirSync((0, path_1.dirname)(localFileName));
172
- this.db.nativeDb.extractEmbeddedFile({ name: rscName, localFileName });
218
+ this.sqliteDb.nativeDb.extractEmbeddedFile({ name: rscName, localFileName });
173
219
  const date = new Date(info.date);
174
220
  fs.utimesSync(localFileName, date, date); // set the last-modified date of the file to match date in container
175
221
  fs.chmodSync(localFileName, "0444"); // set file readonly
176
222
  return localFileName;
177
223
  }
178
224
  }
179
- exports.WorkspaceFile = WorkspaceFile;
225
+ exports.ITwinWorkspaceDb = ITwinWorkspaceDb;
180
226
  /**
181
- * An editable [[WorkspaceFile]]. This is used by administrators for creating and modifying `WorkspaceContainer`s.
227
+ * An editable [[WorkspaceDb]]. This is used by administrators for creating and modifying `WorkspaceDb`s.
182
228
  * For cloud-backed containers, the write token must be obtained before this class may be used. Only one user at at time
183
229
  * may be editing.
184
230
  * @beta
185
231
  */
186
- class EditableWorkspaceFile extends WorkspaceFile {
232
+ class EditableWorkspaceDb extends ITwinWorkspaceDb {
187
233
  constructor() {
188
234
  super(...arguments);
189
235
  this._isCloudOpen = false;
190
236
  }
191
237
  static validateResourceName(name) {
192
- WorkspaceFile.noLeadingOrTrailingSpaces(name, "resource name");
238
+ ITwinWorkspaceDb.noLeadingOrTrailingSpaces(name, "resource name");
193
239
  if (name.length > 1024)
194
240
  throw new Error("resource name too long");
195
241
  }
@@ -199,12 +245,12 @@ class EditableWorkspaceFile extends WorkspaceFile {
199
245
  throw new Error("value is too large");
200
246
  }
201
247
  async openCloudDb(props) {
202
- this.localFile = await CloudSqlite_1.CloudSqlite.attach(this.dbAlias, props);
203
- this.db.openDb(this.localFile, core_bentley_1.OpenMode.ReadWrite);
248
+ this.localFile = await CloudSqlite_1.CloudSqlite.attach(this.dbName, props);
249
+ this.sqliteDb.openDb(this.localFile, core_bentley_1.OpenMode.ReadWrite);
204
250
  this._isCloudOpen = true;
205
251
  }
206
252
  open() {
207
- this.db.openDb(this.localFile, core_bentley_1.OpenMode.ReadWrite);
253
+ this.sqliteDb.openDb(this.localFile, core_bentley_1.OpenMode.ReadWrite);
208
254
  }
209
255
  close() {
210
256
  if (this._isCloudOpen) {
@@ -217,37 +263,35 @@ class EditableWorkspaceFile extends WorkspaceFile {
217
263
  return Math.round(fs.statSync(localFileName).mtimeMs);
218
264
  }
219
265
  performWriteSql(rscName, sql, bind) {
220
- this.db.withSqliteStatement(sql, (stmt) => {
266
+ this.sqliteDb.withSqliteStatement(sql, (stmt) => {
221
267
  stmt.bindString(1, rscName);
222
268
  bind === null || bind === void 0 ? void 0 : bind(stmt);
223
269
  const rc = stmt.step();
224
270
  if (core_bentley_1.DbResult.BE_SQLITE_DONE !== rc)
225
271
  throw new core_common_1.IModelError(rc, "workspace write error");
226
272
  });
227
- this.db.saveChanges();
273
+ this.sqliteDb.saveChanges();
228
274
  }
229
- /** Create a new, empty, EditableWorkspaceFile for importing Workspace resources. */
230
- async create(cloudProps) {
275
+ /** Create a new, empty, EditableWorkspaceDb for importing Workspace resources. */
276
+ create() {
231
277
  IModelJsFs_1.IModelJsFs.recursiveMkDirSync((0, path_1.dirname)(this.localFile));
232
- this.db.createDb(this.localFile);
233
- this.db.executeSQL("CREATE TABLE strings(id TEXT PRIMARY KEY NOT NULL,value TEXT)");
234
- this.db.executeSQL("CREATE TABLE blobs(id TEXT PRIMARY KEY NOT NULL,value BLOB)");
235
- this.db.saveChanges();
236
- if (cloudProps)
237
- await CloudSqlite_1.CloudSqlite.create(cloudProps);
278
+ this.sqliteDb.createDb(this.localFile);
279
+ this.sqliteDb.executeSQL("CREATE TABLE strings(id TEXT PRIMARY KEY NOT NULL,value TEXT)");
280
+ this.sqliteDb.executeSQL("CREATE TABLE blobs(id TEXT PRIMARY KEY NOT NULL,value BLOB)");
281
+ this.sqliteDb.saveChanges();
238
282
  }
239
283
  static async cloneVersion(oldVersion, newVersion, cloudProps) {
240
284
  return CloudSqlite_1.CloudSqlite.copyDb(oldVersion, newVersion, cloudProps);
241
285
  }
242
286
  async upload(cloudProps) {
243
- return CloudSqlite_1.CloudSqlite.uploadDb(this, cloudProps);
287
+ return CloudSqlite_1.CloudSqlite.uploadDb({ ...cloudProps, ...this });
244
288
  }
245
- /** Add a new string resource to this WorkspaceFile.
289
+ /** Add a new string resource to this WorkspaceDb.
246
290
  * @param rscName The name of the string resource.
247
291
  * @param val The string to save.
248
292
  */
249
293
  addString(rscName, val) {
250
- EditableWorkspaceFile.validateResourceName(rscName);
294
+ EditableWorkspaceDb.validateResourceName(rscName);
251
295
  this.validateResourceSize(val);
252
296
  this.performWriteSql(rscName, "INSERT INTO strings(id,value) VALUES(?,?)", (stmt) => stmt.bindString(2, val));
253
297
  }
@@ -264,12 +308,12 @@ class EditableWorkspaceFile extends WorkspaceFile {
264
308
  removeString(rscName) {
265
309
  this.performWriteSql(rscName, "DELETE FROM strings WHERE id=?");
266
310
  }
267
- /** Add a new blob resource to this WorkspaceFile.
311
+ /** Add a new blob resource to this WorkspaceDb.
268
312
  * @param rscName The name of the blob resource.
269
313
  * @param val The blob to save.
270
314
  */
271
315
  addBlob(rscName, val) {
272
- EditableWorkspaceFile.validateResourceName(rscName);
316
+ EditableWorkspaceDb.validateResourceName(rscName);
273
317
  this.validateResourceSize(val);
274
318
  this.performWriteSql(rscName, "INSERT INTO blobs(id,value) VALUES(?,?)", (stmt) => stmt.bindBlob(2, val));
275
319
  }
@@ -282,23 +326,34 @@ class EditableWorkspaceFile extends WorkspaceFile {
282
326
  this.validateResourceSize(val);
283
327
  this.performWriteSql(rscName, "UPDATE blobs SET value=?2 WHERE id=?1", (stmt) => stmt.bindBlob(2, val));
284
328
  }
329
+ /** Get a BlobIO writer for a previously-added blob WorkspaceResource.
330
+ * @note after writing is complete, caller must call `close` on the BlobIO and must call `saveChanges` on the `db`.
331
+ */
332
+ getBlobWriter(rscName) {
333
+ return this.sqliteDb.withSqliteStatement("SELECT rowid from blobs WHERE id=?", (stmt) => {
334
+ stmt.bindString(1, rscName);
335
+ const blobWriter = new imodeljs_native_1.IModelJsNative.BlobIO();
336
+ blobWriter.open(this.sqliteDb.nativeDb, { tableName: "blobs", columnName: "value", row: stmt.getValueInteger(0), writeable: true });
337
+ return blobWriter;
338
+ });
339
+ }
285
340
  /** Remove a blob resource. */
286
341
  removeBlob(rscName) {
287
342
  this.performWriteSql(rscName, "DELETE FROM blobs WHERE id=?");
288
343
  }
289
- /** Copy the contents of an existing local file into this WorkspaceFile as a file resource.
344
+ /** Copy the contents of an existing local file into this WorkspaceDb as a file resource.
290
345
  * @param rscName The name of the file resource.
291
346
  * @param localFileName The name of a local file to be read.
292
347
  * @param fileExt The extension (do not include the leading ".") to be appended to the generated fileName
293
- * when this file is extracted from the WorkspaceContainer. By default the characters after the last "." in `localFileName`
348
+ * when this WorkspaceDb is extracted from the WorkspaceDb. By default the characters after the last "." in `localFileName`
294
349
  * are used. Pass this argument to override that.
295
350
  */
296
351
  addFile(rscName, localFileName, fileExt) {
297
- EditableWorkspaceFile.validateResourceName(rscName);
352
+ EditableWorkspaceDb.validateResourceName(rscName);
298
353
  fileExt = fileExt !== null && fileExt !== void 0 ? fileExt : (0, path_1.extname)(localFileName);
299
354
  if ((fileExt === null || fileExt === void 0 ? void 0 : fileExt[0]) === ".")
300
355
  fileExt = fileExt.slice(1);
301
- this.db.nativeDb.embedFile({ name: rscName, localFileName, date: this.getFileModifiedTime(localFileName), fileExt });
356
+ this.sqliteDb.nativeDb.embedFile({ name: rscName, localFileName, date: this.getFileModifiedTime(localFileName), fileExt });
302
357
  }
303
358
  /** Replace an existing file resource with the contents of a local file.
304
359
  * @param rscName The name of the file resource.
@@ -307,15 +362,17 @@ class EditableWorkspaceFile extends WorkspaceFile {
307
362
  */
308
363
  updateFile(rscName, localFileName) {
309
364
  this.queryFileResource(rscName); // throws if not present
310
- this.db.nativeDb.replaceEmbeddedFile({ name: rscName, localFileName, date: this.getFileModifiedTime(localFileName) });
365
+ this.sqliteDb.nativeDb.replaceEmbeddedFile({ name: rscName, localFileName, date: this.getFileModifiedTime(localFileName) });
311
366
  }
312
367
  /** Remove a file resource. */
313
368
  removeFile(rscName) {
314
369
  const file = this.queryFileResource(rscName);
370
+ if (undefined === file)
371
+ throw new Error(`file resource "${rscName}" does not exist`);
315
372
  if (file && fs.existsSync(file.localFileName))
316
373
  fs.unlinkSync(file.localFileName);
317
- this.db.nativeDb.removeEmbeddedFile(rscName);
374
+ this.sqliteDb.nativeDb.removeEmbeddedFile(rscName);
318
375
  }
319
376
  }
320
- exports.EditableWorkspaceFile = EditableWorkspaceFile;
377
+ exports.EditableWorkspaceDb = EditableWorkspaceDb;
321
378
  //# sourceMappingURL=Workspace.js.map
@@ -1 +1 @@
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,8DAAyD;AACzD,sDAAkE;AAClE,oDAA8E;AAC9E,8CAA2C;AAC3C,0CAAuC;AAGvC,+CAA4C;AAE5C;;GAEG;AACH,IAAK,gBAEJ;AAFD,WAAK,gBAAgB;IACnB,gEAA4C,CAAA;AAC9C,CAAC,EAFI,gBAAgB,KAAhB,gBAAgB,QAEpB;AAED,MAAM,gBAAgB,GAAG,2BAA2B,CAAC;AA6JrD,gBAAgB;AAChB,MAAa,cAAc;IAMzB,YAAmB,QAAkB,EAAE,IAAoB;;QALnD,gBAAW,GAAG,IAAI,GAAG,EAAuC,CAAC;QAMnE,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;QACpG,IAAI,CAAC,QAAQ,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,mCAAI,IAAA,WAAI,EAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IACM,YAAY,CAAC,SAAwB;QAC1C,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAE9D,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IACzD,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,KAA8B,EAAE,UAAsC;;QAC9F,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,SAAS,KAAK,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,iCAAiC,KAAK,GAAG,CAAC,CAAC;QAE7D,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,mCAAI,IAAI,aAAa,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC1E,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE;YACrB,IAAI,UAAU;gBACZ,MAAM,yBAAW,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YACtD,SAAS,CAAC,IAAI,EAAE,CAAC;SAClB;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,KAAK,CAAC,sBAAsB,CAAC,UAAkC,EAAE,QAA0B;QAChG,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAChE,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACxD,IAAI,SAAS,KAAK,OAAO;YACvB,MAAM,IAAI,KAAK,CAAC,mCAAmC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;QAE3E,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,WAAW,IAAI,UAAU,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7F,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,aAAa,CAAC,MAA0B;QAC7C,MAAM,EAAE,GAAG,MAAM,CAAC,WAAW,CAAC;QAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC3C,IAAI,SAAS,KAAK,MAAM,EAAE;YACxB,SAAS,CAAC,KAAK,EAAE,CAAC;YAClB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;SAC7B;IACH,CAAC;IAEM,kBAAkB,CAAC,KAA8B;QACtD,IAAI,OAAO,KAAK,KAAK,QAAQ;YAC3B,OAAO,KAAK,CAAC,EAAE,CAAC;QAClB,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,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ;wBACnF,OAAO,KAAK,CAAC,EAAE,CAAC;iBACnB;aACF;YACD,OAAO,SAAS,CAAC,CAAC,+CAA+C;QACnE,CAAC,EAAE,KAAK,CAAC,CAAC;QACV,IAAI,SAAS,KAAK,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,OAAO,EAAE,CAAC;IAEZ,CAAC;CACF;AA3ED,wCA2EC;AAED;;;GAGG;AACH,MAAa,aAAa;IAkCxB,YAAmB,WAAiC,EAAE,SAAoB;;QAjCvD,OAAE,GAAG,IAAI,mBAAQ,EAAE,CAAC,CAAC,2DAA2D;QAKnF,sBAAiB,GAAG,IAAI,sBAAO,EAAc,CAAC;QA6B5D,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACxD,aAAa,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,MAAA,IAAI,CAAC,OAAO,mCAAI,IAAI,CAAC;QACpC,IAAI,CAAC,SAAS,GAAG,IAAA,WAAI,EAAC,SAAS,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC,WAAW,IAAI,gBAAgB,EAAE,CAAC,CAAC;QACzF,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAlCD,IAAW,iBAAiB,KAAK,OAAO,IAAA,WAAI,EAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAC1F,IAAW,MAAM,KAAK,OAAO,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEpC,iBAAiB,CAAC,OAA8B;QACxD,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QACzD,IAAI,SAAS,KAAK,IAAI;YACpB,OAAO,SAAS,CAAC;QAEnB,iIAAiI;QACjI,IAAI,aAAa,GAAG,IAAA,WAAI,EAAC,IAAI,CAAC,iBAAiB,EAAE,IAAA,mBAAU,EAAC,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACnG,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;IAES,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,mBAAmB,CAAC,EAAwB;QACzD,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,MAAM,GAAG,GAAG,IAAI,kCAAkC,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,kCAAkC,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5H,MAAM,IAAI,KAAK,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAC;QAClD,IAAI,CAAC,yBAAyB,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;IACpD,CAAC;IAYM,mBAAmB;QACxB,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAClD,CAAC;IAEM,IAAI;QACT,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,uBAAQ,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC;IAEM,KAAK;QACV,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;YACpC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;SACpC;IACH,CAAC;IAEM,SAAS,CAAC,OAA8B;QAC7C,OAAO,IAAI,CAAC,EAAE,CAAC,mBAAmB,CAAC,sCAAsC,EAAE,CAAC,IAAI,EAAE,EAAE;YAClF,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;IAEM,OAAO,CAAC,OAA8B;QAC3C,OAAO,IAAI,CAAC,EAAE,CAAC,mBAAmB,CAAC,oCAAoC,EAAE,CAAC,IAAI,EAAE,EAAE;YAChF,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,EAAE,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QACvE,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;AAnGD,sCAmGC;AAED;;;;;GAKG;AACH,MAAa,qBAAsB,SAAQ,aAAa;IAAxD;;QACU,iBAAY,GAAG,KAAK,CAAC;IAmJ/B,CAAC;IAlJS,MAAM,CAAC,oBAAoB,CAAC,IAA2B;QAC7D,aAAa,CAAC,yBAAyB,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QAC/D,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;IAEM,KAAK,CAAC,WAAW,CAAC,KAA8B;QACrD,IAAI,CAAC,SAAS,GAAG,MAAM,yBAAW,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC/D,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,uBAAQ,CAAC,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC3B,CAAC;IAEe,IAAI;QAClB,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,uBAAQ,CAAC,SAAS,CAAC,CAAC;IACrD,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,EAAE,CAAC,mBAAmB,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE;YACxC,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,EAAE,CAAC,WAAW,EAAE,CAAC;IACxB,CAAC;IAED,oFAAoF;IAC7E,KAAK,CAAC,MAAM,CAAC,UAAoC;QACtD,uBAAU,CAAC,kBAAkB,CAAC,IAAA,cAAO,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QACvD,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,+DAA+D,CAAC,CAAC;QACpF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,6DAA6D,CAAC,CAAC;QAClF,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC;QACtB,IAAI,UAAU;YACZ,MAAM,yBAAW,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,UAAqC,EAAE,UAAqC,EAAE,UAAmC;QAChJ,OAAO,yBAAW,CAAC,MAAM,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,UAAmC;QACrD,OAAO,yBAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,SAAS,CAAC,OAA8B,EAAE,GAAW;QAC1D,qBAAqB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QACpD,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,qBAAqB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QACpD,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,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,qBAAqB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QACpD,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,EAAE,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;IACvH,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,OAA8B,EAAE,aAA4B;QAC5E,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,wBAAwB;QACzD,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IACxH,CAAC;IAED,8BAA8B;IACvB,UAAU,CAAC,OAA8B;QAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,IAAI,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC;YAC3C,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;CACF;AApJD,sDAoJC","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 { NativeLibrary } from \"@bentley/imodeljs-native\";\r\nimport { BeEvent, DbResult, OpenMode } 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\nimport { CloudSqlite } from \"./CloudSqlite\";\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 containerFileExt = \"itwin-workspace-container\";\r\n\r\n/**\r\n * The name of a workspace container. This is the user-supplied name of a container, used to specify its *purpose* within a workspace.\r\n * WorkspaceNames can be \"aliased\" by `WorkspaceSetting.ContainerAlias` settings so that \"resolved\" [[WorkspaceContainerId]] that supplies\r\n * the actual container 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 container.\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 file holding the WorkspaceContainer, and is also the\r\n * name of its cloud-storage-container. `WorkspaceContainerName` are resolved to WorkspaceContainerId through `WorkspaceSetting.ContainerAlias` settings,\r\n * so users may not recognize the actual WorkspaceContainerId supplying resources for a WorkspaceContainerName.\r\n *\r\n * `WorkspaceContainerId`s may not:\r\n * - be blank or start or end with a space\r\n * - be longer than 255 characters\r\n * - contain any characters with Unicode values less than 0x20\r\n * - contain characters reserved for filename, device, wildcard, or url syntax (e.g. \"#\\.<>:\"/\\\\\"`'|?*\")\r\n * @beta\r\n */\r\nexport type WorkspaceContainerId = string;\r\n\r\n/**\r\n * The version name for a WorkspaceContainer. More than one version of a Workspace may be stored in the same [[CloudSqlite]] container. This\r\n * string identifies a specific version.\r\n * @beta\r\n */\r\nexport type WorkspaceContainerVersion = string;\r\n\r\n/**\r\n * The name for identifying WorkspaceResources in a [[WorkspaceContainer]].\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 WorkspaceContainer 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/**\r\n * Properties that specify a WorkspaceContainer. This can either be a WorkspaceContainerName or an\r\n * object with a member named `id` that holds a WorkspaceContainerId. If WorkspaceContainerId is supplied,\r\n * it is used directly. Otherwise the name must be resolved via [[Workspace.resolveContainerId]].\r\n * @beta\r\n */\r\nexport type WorkspaceContainerProps = WorkspaceContainerName | { id: WorkspaceContainerId };\r\n\r\n/** Properties that specify a WorkspaceResource within a WorkspaceContainer.\r\n * @beta\r\n */\r\nexport interface WorkspaceResourceProps {\r\n /** the properties of the WorkspaceContainer holding the resource. */\r\n container: WorkspaceContainerProps;\r\n /** the name of the resource within [[container]] */\r\n rscName: WorkspaceResourceName;\r\n}\r\n\r\n/**\r\n * A container of workspace resources. `WorkspaceContainer`s may just be local [[WorkspaceFile]]s, or they may be stored and\r\n * synchronized with cloud blob-store containers. WorkspaceContainers hold WorkspaceResources, each identified by a [[WorkspaceResourceName]].\r\n * Resources of type `string` and `blob` may be loaded directly from the `WorkspaceContainer`. Resources of type `file` are\r\n * copied from the container into a temporary local file so they can be accessed directly.\r\n * @beta\r\n */\r\nexport interface WorkspaceContainer {\r\n /** The WorkspaceContainerId of this container. */\r\n readonly containerId: WorkspaceContainerId;\r\n /** The version alias for this container. */\r\n readonly dbAlias: WorkspaceContainerVersion;\r\n /** The Workspace that opened this WorkspaceContainer */\r\n readonly workspace: Workspace;\r\n /** the directory for extracting file resources. */\r\n readonly containerFilesDir: LocalDirName;\r\n /** event raised when the container is closed. */\r\n readonly onContainerClosed: BeEvent<() => void>;\r\n /** Get a string resource from this container, if present. */\r\n getString(rscName: WorkspaceResourceName): string | undefined;\r\n\r\n /** Get a blob resource from this container, if present. */\r\n getBlob(rscName: WorkspaceResourceName): Uint8Array | undefined;\r\n\r\n /** Extract a local copy of a file resource from this container, if present.\r\n * @param rscName The name of the file resource in the WorkspaceContainer\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 [[containerFilesDir]].\r\n * @returns the full path to a file on the local filesystem.\r\n * @note The file is copied from the container 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 container.\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 container.\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 WorkspaceContainer files. The [[Workspace]] will (only) look in this directory\r\n * for files named `${this.containerId}.itwin-workspace-container`.\r\n * @note if not supplied, defaults to `iTwin/Workspace` in the user-local folder.\r\n */\r\n containerDir?: LocalDirName;\r\n /** A local directory to store temporary files extracted for file-resources.\r\n * @note if not supplied, defaults to `a folder named \"Files\" inside [[containerDir]]\r\n */\r\n filesDir?: 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 WorkspaceContainer files with the name `${containerId}.itwin-workspace-container`. */\r\n readonly containerDir: LocalDirName;\r\n /** the local directory where this Workspace will store temporary files extracted for file-resources. */\r\n readonly filesDir: LocalDirName;\r\n /** The [[Settings]] for this Workspace */\r\n readonly settings: Settings;\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 [[WorkspaceContainer]]. If the container 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 getContainer(props: WorkspaceContainerProps, cloudProps?: CloudSqlite.AccessProps): Promise<WorkspaceContainer>;\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 /** @internal */\r\n addContainer(container: WorkspaceFile): void;\r\n /** Close and remove a currently opened [[WorkspaceContainer]] from this Workspace. */\r\n dropContainer(container: WorkspaceContainer): void;\r\n /** Close this Workspace. All currently opened WorkspaceContainers 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, WorkspaceFile>();\r\n public readonly filesDir: LocalDirName;\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 this.filesDir = opts?.filesDir ?? join(this.containerDir, \"Files\");\r\n }\r\n public addContainer(container: WorkspaceFile) {\r\n if (undefined !== this._containers.get(container.containerId))\r\n throw new Error(\"container id already exists in workspace\");\r\n\r\n this._containers.set(container.containerId, container);\r\n }\r\n\r\n public async getContainer(props: WorkspaceContainerProps, cloudProps?: CloudSqlite.DownloadProps): Promise<WorkspaceContainer> {\r\n const id = this.resolveContainerId(props);\r\n if (undefined === id)\r\n throw new Error(`can't resolve container name [${props}]`);\r\n\r\n const container = this._containers.get(id) ?? new WorkspaceFile(id, this);\r\n if (!container.isOpen) {\r\n if (cloudProps)\r\n await CloudSqlite.downloadDb(container, cloudProps);\r\n container.open();\r\n }\r\n\r\n return container;\r\n }\r\n\r\n public async loadSettingsDictionary(settingRsc: WorkspaceResourceProps, priority: SettingsPriority) {\r\n const container = await this.getContainer(settingRsc.container);\r\n const setting = container.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(`${container.containerId}/${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 dropContainer(toDrop: WorkspaceContainer) {\r\n const id = toDrop.containerId;\r\n const container = this._containers.get(id);\r\n if (container === toDrop) {\r\n container.close();\r\n this._containers.delete(id);\r\n }\r\n }\r\n\r\n public resolveContainerId(props: WorkspaceContainerProps): WorkspaceContainerId {\r\n if (typeof props === \"object\")\r\n return props.id;\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 && 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);\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\r\n/**\r\n * A local file holding a WorkspaceContainer.\r\n * @beta\r\n */\r\nexport class WorkspaceFile implements WorkspaceContainer {\r\n protected readonly db = new SQLiteDb(); // eslint-disable-line @typescript-eslint/naming-convention\r\n public readonly workspace: Workspace;\r\n public readonly containerId: WorkspaceContainerId;\r\n public localFile: LocalFileName;\r\n public dbAlias: WorkspaceContainerVersion;\r\n public readonly onContainerClosed = new BeEvent<() => void>();\r\n\r\n public get containerFilesDir() { return join(this.workspace.filesDir, this.containerId); }\r\n public get isOpen() { return this.db.isOpen; }\r\n\r\n protected queryFileResource(rscName: WorkspaceResourceName) {\r\n const info = this.db.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.containerFilesDir, 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 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 validateContainerId(id: WorkspaceContainerId) {\r\n if (id === \"\" || id.length > 255 || /[#\\.<>:\"/\\\\\"`'|?*\\u0000-\\u001F]/g.test(id) || /^(con|prn|aux|nul|com\\d|lpt\\d)$/i.test(id))\r\n throw new Error(`invalid containerId: [${id}]`);\r\n this.noLeadingOrTrailingSpaces(id, \"containerId\");\r\n }\r\n\r\n public constructor(containerId: WorkspaceContainerId, workspace: Workspace) {\r\n [containerId, this.dbAlias] = containerId.split(\"#\", 2);\r\n WorkspaceFile.validateContainerId(containerId);\r\n this.workspace = workspace;\r\n this.containerId = containerId;\r\n this.dbAlias = this.dbAlias ?? \"v0\";\r\n this.localFile = join(workspace.containerDir, `${this.containerId}.${containerFileExt}`);\r\n workspace.addContainer(this);\r\n }\r\n\r\n public purgeContainerFiles() {\r\n IModelJsFs.purgeDirSync(this.containerFilesDir);\r\n }\r\n\r\n public open(): void {\r\n this.db.openDb(this.localFile, OpenMode.Readonly);\r\n }\r\n\r\n public close(): void {\r\n if (this.isOpen) {\r\n this.onContainerClosed.raiseEvent();\r\n this.db.closeDb();\r\n this.workspace.dropContainer(this);\r\n }\r\n }\r\n\r\n public getString(rscName: WorkspaceResourceName): string | undefined {\r\n return this.db.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 public getBlob(rscName: WorkspaceResourceName): Uint8Array | undefined {\r\n return this.db.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.db.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 [[WorkspaceFile]]. This is used by administrators for creating and modifying `WorkspaceContainer`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 EditableWorkspaceFile extends WorkspaceFile {\r\n private _isCloudOpen = false;\r\n private static validateResourceName(name: WorkspaceResourceName) {\r\n WorkspaceFile.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 async openCloudDb(props: CloudSqlite.AccessProps) {\r\n this.localFile = await CloudSqlite.attach(this.dbAlias, props);\r\n this.db.openDb(this.localFile, OpenMode.ReadWrite);\r\n this._isCloudOpen = true;\r\n }\r\n\r\n public override open() {\r\n this.db.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.db.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.db.saveChanges();\r\n }\r\n\r\n /** Create a new, empty, EditableWorkspaceFile for importing Workspace resources. */\r\n public async create(cloudProps?: CloudSqlite.AccessProps) {\r\n IModelJsFs.recursiveMkDirSync(dirname(this.localFile));\r\n this.db.createDb(this.localFile);\r\n this.db.executeSQL(\"CREATE TABLE strings(id TEXT PRIMARY KEY NOT NULL,value TEXT)\");\r\n this.db.executeSQL(\"CREATE TABLE blobs(id TEXT PRIMARY KEY NOT NULL,value BLOB)\");\r\n this.db.saveChanges();\r\n if (cloudProps)\r\n await CloudSqlite.create(cloudProps);\r\n }\r\n\r\n public static async cloneVersion(oldVersion: WorkspaceContainerVersion, newVersion: WorkspaceContainerVersion, cloudProps: CloudSqlite.AccessProps) {\r\n return CloudSqlite.copyDb(oldVersion, newVersion, cloudProps);\r\n }\r\n\r\n public async upload(cloudProps: CloudSqlite.AccessProps) {\r\n return CloudSqlite.uploadDb(this, cloudProps);\r\n }\r\n\r\n /** Add a new string resource to this WorkspaceFile.\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 EditableWorkspaceFile.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 WorkspaceFile.\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 EditableWorkspaceFile.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 /** 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 WorkspaceFile 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 file is extracted from the WorkspaceContainer. 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 EditableWorkspaceFile.validateResourceName(rscName);\r\n fileExt = fileExt ?? extname(localFileName);\r\n if (fileExt?.[0] === \".\")\r\n fileExt = fileExt.slice(1);\r\n this.db.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.db.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 (file && fs.existsSync(file.localFileName))\r\n fs.unlinkSync(file.localFileName);\r\n this.db.nativeDb.removeEmbeddedFile(rscName);\r\n }\r\n}\r\n\r\n"]}
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,8DAAyE;AACzE,sDAA4E;AAC5E,oDAA8E;AAC9E,8CAA2C;AAC3C,0CAAuC;AAEvC,+CAA4C;AAG5C,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,yBAAW,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;IA+J/B,CAAC;IA9JS,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;IAEM,KAAK,CAAC,WAAW,CAAC,KAAuC;QAC9D,IAAI,CAAC,SAAS,GAAG,MAAM,yBAAW,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC9D,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,uBAAQ,CAAC,SAAS,CAAC,CAAC;QACzD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC3B,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,yBAAW,CAAC,MAAM,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,UAAqC;QACvD,OAAO,yBAAW,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;AAhKD,kDAgKC","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 { 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 { CloudSqlite } from \"./CloudSqlite\";\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 async openCloudDb(props: CloudSqlite.ContainerAccessProps) {\r\n this.localFile = await CloudSqlite.attach(this.dbName, props);\r\n this.sqliteDb.openDb(this.localFile, OpenMode.ReadWrite);\r\n this._isCloudOpen = true;\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"]}