@itwin/core-backend 4.8.0-dev.16 → 4.8.0-dev.18

package/lib/cjs/workspace/WorkspaceEditor.js.map

@@ -1 +1 @@
-{"version":3,"file":"WorkspaceEditor.js","sourceRoot":"","sources":["../../../src/workspace/WorkspaceEditor.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAUH,+EAA4E;AAC5E,uEAA+E;AAC/E,mFAAgF;AAEhF,YAAY;AACZ,IAAiB,eAAe,CAgB/B;AAhBD,WAAiB,eAAe;IAC9B;;;;OAIG;IACH,SAAgB,SAAS;QACvB,OAAO,IAAA,wCAAwB,GAAE,CAAC;IACpC,CAAC;IAFe,yBAAS,YAExB,CAAA;IAED;;OAEG;IACH,SAAgB,aAAa,CAAC,IAAqE;QACjG,qCAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;IAFe,6BAAa,gBAE5B,CAAA;AACH,CAAC,EAhBgB,eAAe,+BAAf,eAAe,QAgB/B","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 { LocalFileName } from \"@itwin/core-common\";\r\nimport { SQLiteDb } from \"../SQLiteDb\";\r\nimport { SettingsContainer } from \"./Settings\";\r\nimport { BlobContainer } from \"../BlobContainerService\";\r\nimport {\r\n  GetWorkspaceContainerArgs, Workspace, WorkspaceContainer, WorkspaceContainerProps, WorkspaceDb, WorkspaceDbCloudProps, WorkspaceDbManifest, WorkspaceDbName, WorkspaceDbNameAndVersion,\r\n  WorkspaceDbProps, WorkspaceDbVersion, WorkspaceResourceName,\r\n} from \"./Workspace\";\r\nimport { WorkspaceSqliteDb } from \"../internal/workspace/WorkspaceSqliteDb\";\r\nimport { constructWorkspaceEditor } from \"../internal/workspace/WorkspaceImpl\";\r\nimport { implementationProhibited } from \"../internal/ImplementationProhibited\";\r\n\r\n/** @beta */\r\nexport namespace WorkspaceEditor {\r\n  /**\r\n   * Create a new [[WorkspaceEditor]] for creating new versions of [[WorkspaceDb]]s.\r\n   * @note the caller becomes the owner of the Workspace.Editor and is responsible for calling [[WorkspaceEditor.close]] on it when they are finished using it.\r\n   * @note It is illegal to have more than one Workspace.Editor active in a single session.\r\n   */\r\n  export function construct(): WorkspaceEditor {\r\n    return constructWorkspaceEditor();\r\n  }\r\n\r\n  /**\r\n   * Create a new, empty, [[EditableWorkspaceDb]] file on the local filesystem for importing [[Workspace]] resources.\r\n   */\r\n  export function createEmptyDb(args: { localFileName: LocalFileName, manifest: WorkspaceDbManifest }): void {\r\n    WorkspaceSqliteDb.createNewDb(args.localFileName, args);\r\n  }\r\n}\r\n\r\n/** Arguments supplied to [[WorkspaceEditor.createNewCloudContainer]] to create a new [[EditableWorkspaceContainer]].\r\n * @beta\r\n */\r\nexport interface CreateNewWorkspaceContainerArgs {\r\n  /**\r\n   * The scope of the container. This determines the ownership of the container, how RBAC rights are assigned,\r\n   * and the location of the datacenter\r\n   */\r\n  scope: BlobContainer.Scope;\r\n  /** The manifest to be stored in the default WorkspaceDb in the new container. */\r\n  manifest: WorkspaceDbManifest;\r\n  /** Metadata stored by the BlobContainer service */\r\n  metadata: Omit<BlobContainer.Metadata, \"containerType\">;\r\n  /** The name of the default [[WorkspaceDb]] created inside the new container.\r\n   * Default: \"workspace-db\";\r\n   */\r\n  dbName?: WorkspaceDbName;\r\n}\r\n\r\n/**\r\n * A [[WorkspaceContainer]] opened for editing by a [[WorkspaceEditor]].\r\n * You can create new [[WorkspaceDb]]s or new versions of existing [[WorkspaceDb]]s inside it.\r\n * Before actually making any changes to the container's contents, you must first obtain an exclusive write lock on it via\r\n * [[acquireWriteLock]]. Only one user can hold the write lock at any given time. When you have finished making changes,\r\n * you can use [[releaseWriteLock]] to publish your changes, or [[abandonChanges]] to discard them.\r\n * @beta\r\n */\r\nexport interface EditableWorkspaceContainer extends WorkspaceContainer {\r\n  /**\r\n   * Create a copy of an existing [[WorkspaceDb]] in this container with a new [[WorkspaceDbVersion]].\r\n   * The copy should be modified with new content before the write lock is released,\r\n   * and thereafter may never be modified again.\r\n   * @note The copy actually shares all of the data with the original, but with copy-on-write if/when data in the new WorkspaceDb is modified.\r\n   * @param props - The properties that determine the source WorkspaceDb to serve as the basis for the new version.\r\n   * @returns A promise that resolves to an object containing the old and new WorkspaceDb names and versions.\r\n   */\r\n  createNewWorkspaceDbVersion(props: CreateNewWorkspaceDbVersionArgs): Promise<{ oldDb: WorkspaceDbNameAndVersion, newDb: WorkspaceDbNameAndVersion }>;\r\n\r\n  /**\r\n   * Create a new, empty [[WorkspaceDb]].\r\n   * @param args - The arguments for creating the new WorkspaceDb.\r\n   * @returns A promise that resolves to an EditableWorkspaceDb.\r\n   */\r\n  createDb(args: { dbName?: WorkspaceDbName, version?: WorkspaceDbVersion, manifest: WorkspaceDbManifest }): Promise<EditableWorkspaceDb>;\r\n\r\n  /**\r\n   * Get the cloud properties of this container.\r\n   */\r\n  readonly cloudProps: WorkspaceContainerProps | undefined;\r\n\r\n  /**\r\n   * Get an editable [[WorkspaceDb]] to add, delete, or update resources *within a newly created version* of a WorkspaceDb.\r\n   * @param props - The properties of the WorkspaceDb.\r\n   */\r\n  getEditableDb(props: WorkspaceDbProps): EditableWorkspaceDb;\r\n\r\n  /**\r\n   * Acquire the write lock on the container. Use [[releaseWriteLock]] to release the lock after publishing your changes, or\r\n   * [[abandonChanges]] to release the lock and discard your changes.\r\n   * Only one use can hold the write lock at any given time. However, readers can continue to read the published contents of the container while\r\n   * a writer holds the write lock. Readers will only see the writer's changes after they are published by [[releaseWriteLock]].\r\n   * @param user - The name of the user acquiring the write lock.\r\n   */\r\n  acquireWriteLock(user: string): void;\r\n\r\n  /**\r\n   * Release the write lock on the container. This should be called after all changes to the container's contents are complete. It\r\n   * publishes and uploads the changes made to any [[WorkspaceDb]]s while the lock was held, after which those dbs become immutable.\r\n   */\r\n  releaseWriteLock(): void;\r\n\r\n  /**\r\n   * Abandon any changes made to the container and release the write lock. Any newly created versions of WorkspaceDbs are discarded.\r\n   */\r\n  abandonChanges(): void;\r\n}\r\n\r\n/**\r\n * The release increment for a version number, used as part of [[CreateNewWorkspaceDbVersionArgs]] to specify the kind of version to create.\r\n * @see [semver.ReleaseType](https://www.npmjs.com/package/semver)\r\n * @beta\r\n */\r\nexport type WorkspaceDbVersionIncrement = \"major\" | \"minor\" | \"patch\" | \"premajor\" | \"preminor\" | \"prepatch\" | \"prerelease\";\r\n\r\n/**\r\n * Arguments supplied to [[Workspace.createNewWorkspaceDbVersion]].\r\n * @beta\r\n */\r\nexport interface CreateNewWorkspaceDbVersionArgs {\r\n  /**\r\n   * The properties that determine the source [[WorkspaceDb]] to serve as the basis for the new version.\r\n   * This is usually the latest version, but it is possible to create patches to older versions.\r\n   */\r\n  fromProps?: WorkspaceDbProps;\r\n  /** The type of version increment to apply to the source version. */\r\n  versionType: WorkspaceDbVersionIncrement;\r\n  /** For prerelease versions, a string that becomes part of the version name. */\r\n  identifier?: string;\r\n}\r\n\r\n/**\r\n * An editable [[WorkspaceDb]]. This is used only by tools to allow administrators to create and modify WorkspaceDbs.\r\n * For cloud-based WorkspaceDbs, the container's write token must be obtained via [[EditableWorkspaceContainer.acquireWriteLock]] before the methods in this interface may be used.\r\n * Normally, only admins will have write access to a [[Workspace]].\r\n * Only one admin at a time may be editing a Workspace.\r\n * @beta\r\n */\r\nexport interface EditableWorkspaceDb extends WorkspaceDb {\r\n  readonly container: EditableWorkspaceContainer;\r\n  /**\r\n   * The cloud properties of the [[WorkspaceDb]], if this is a cloud-based WorkspaceDb.\r\n   */\r\n  get cloudProps(): WorkspaceDbCloudProps | undefined;\r\n\r\n  /**\r\n   * Update the contents of the manifest in this WorkspaceDb.\r\n   * @param manifest - The updated manifest.\r\n   */\r\n  updateManifest(manifest: WorkspaceDbManifest): void;\r\n\r\n  /**\r\n   * Add or update a resource in this WorkspaceDb that can be loaded as a [[SettingsDictionary]].\r\n   * The `settings` will be stored as stringified JSON.\r\n   * @param settings - The settings object to add or update.\r\n   * @param rscName - The name of the settings resource. Defaults to \"settingsDictionary\" if undefined.\r\n   */\r\n  updateSettingsResource(settings: SettingsContainer, rscName?: string): void;\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   * @throws if a string resource named `rscName` already exists.\r\n   */\r\n  addString(rscName: WorkspaceResourceName, val: string): void;\r\n\r\n  /**\r\n   * Update an existing string resource with a new value, or add it if it does not exist.\r\n   * @param rscName - The name of the string resource.\r\n   * @param val - The new value.\r\n   */\r\n  updateString(rscName: WorkspaceResourceName, val: string): void;\r\n\r\n  /**\r\n   * Remove a string resource.\r\n   * @param rscName - The name of the string resource to remove.\r\n   */\r\n  removeString(rscName: WorkspaceResourceName): void;\r\n\r\n  /**\r\n   * Add a new binary resource to this WorkspaceDb.\r\n   * @param rscName - The name of the blob resource.\r\n   * @param val - The blob to save.\r\n   * @throws if a blob resource named `rscName` already exists.\r\n   */\r\n  addBlob(rscName: WorkspaceResourceName, val: Uint8Array): void;\r\n\r\n  /**\r\n   * Update an existing blob resource with a new value, or add it if it does not exist.\r\n   * @param rscName - The name of the blob resource.\r\n   * @param val - The new value.\r\n   */\r\n  updateBlob(rscName: WorkspaceResourceName, val: Uint8Array): void;\r\n\r\n  /**\r\n   * Get a BlobIO writer for a previously-added blob WorkspaceResource.\r\n   * @param rscName - The name of the blob resource.\r\n   * @returns A BlobIO writer.\r\n   * @note After writing is complete, the caller must call `close` on the BlobIO and must call `saveChanges` on the `db`.\r\n   * @internal\r\n   */\r\n  getBlobWriter(rscName: WorkspaceResourceName): SQLiteDb.BlobIO;\r\n\r\n  /**\r\n   * Remove a binary resource.\r\n   * @param rscName - The name of the blob resource to remove.\r\n   */\r\n  removeBlob(rscName: WorkspaceResourceName): void;\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 to be appended to the generated fileName when this WorkspaceDb is extracted from the WorkspaceDb.\r\n   * By default, the characters after the last \".\" in `localFileName` are used. Pass this argument to override that.\r\n   */\r\n  addFile(rscName: WorkspaceResourceName, localFileName: LocalFileName, fileExt?: string): void;\r\n\r\n  /**\r\n   * Replace an existing file resource with the contents of another 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 the file resource does not exist.\r\n   */\r\n  updateFile(rscName: WorkspaceResourceName, localFileName: LocalFileName): void;\r\n\r\n  /**\r\n   * Remove a file resource.\r\n   * @param rscName - The name of the file resource to remove.\r\n   */\r\n  removeFile(rscName: WorkspaceResourceName): void;\r\n}\r\n\r\n/** An object that permits administrators to modify the contents of a [[Workspace]].\r\n * Use [[WorkspaceEditor.construct]] to obtain a WorkspaceEditor, and [[close]] when finished using it.\r\n * Only one WorkspaceEditor may be in use at any given time.\r\n * Use [[getContainer]] to edit an existing [[WorkspaceContainer]], or [[createNewCloudContainer]] to create a new [[WorkspaceContainer]].\r\n * @beta\r\n */\r\nexport interface WorkspaceEditor {\r\n  /** @internal */\r\n  [implementationProhibited]: unknown;\r\n\r\n  /**\r\n   * The workspace dedicated to this editor.\r\n   * @note This workspace is independent from [[IModelHost.appWorkspace]] and all [[IModelDb.workspace]]s. It has its own [[Settings]] and [[WorkspaceDb]]s.\r\n   */\r\n  readonly workspace: Workspace;\r\n\r\n  /**\r\n   * Retrieves a container for the editor with the specified properties and access token.\r\n   */\r\n  getContainer(args: GetWorkspaceContainerArgs): EditableWorkspaceContainer;\r\n\r\n  /**\r\n   * Asynchronously retrieves a container for the editor with the specified properties.\r\n   */\r\n  getContainerAsync(props: WorkspaceContainerProps): Promise<EditableWorkspaceContainer>;\r\n\r\n  /**\r\n   * Creates a new cloud container for holding WorkspaceDbs, from the [[BlobContainer]] service.\r\n   * @note The current user must have administrator rights for the iTwin for the container.\r\n   */\r\n  createNewCloudContainer(args: CreateNewWorkspaceContainerArgs): Promise<EditableWorkspaceContainer>;\r\n\r\n  /**\r\n   * Closes this editor. All [[workspace]] containers are dropped.\r\n   */\r\n  close(): void;\r\n}\r\n"]}
+{"version":3,"file":"WorkspaceEditor.js","sourceRoot":"","sources":["../../../src/workspace/WorkspaceEditor.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAUH,+EAA4E;AAC5E,uEAA+E;AAC/E,iDAAgE;AAEhE,YAAY;AACZ,IAAiB,eAAe,CAgB/B;AAhBD,WAAiB,eAAe;IAC9B;;;;OAIG;IACH,SAAgB,SAAS;QACvB,OAAO,IAAA,wCAAwB,GAAE,CAAC;IACpC,CAAC;IAFe,yBAAS,YAExB,CAAA;IAED;;OAEG;IACH,SAAgB,aAAa,CAAC,IAAqE;QACjG,qCAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;IAFe,6BAAa,gBAE5B,CAAA;AACH,CAAC,EAhBgB,eAAe,+BAAf,eAAe,QAgB/B","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Workspace\n */\n\nimport { LocalFileName } from \"@itwin/core-common\";\nimport { SQLiteDb } from \"../SQLiteDb\";\nimport { SettingsContainer } from \"./Settings\";\nimport { BlobContainer } from \"../BlobContainerService\";\nimport {\n  GetWorkspaceContainerArgs, Workspace, WorkspaceContainer, WorkspaceContainerProps, WorkspaceDb, WorkspaceDbCloudProps, WorkspaceDbManifest, WorkspaceDbName, WorkspaceDbNameAndVersion,\n  WorkspaceDbProps, WorkspaceDbVersion, WorkspaceResourceName,\n} from \"./Workspace\";\nimport { WorkspaceSqliteDb } from \"../internal/workspace/WorkspaceSqliteDb\";\nimport { constructWorkspaceEditor } from \"../internal/workspace/WorkspaceImpl\";\nimport { _implementationProhibited } from \"../internal/Symbols\";\n\n/** @beta */\nexport namespace WorkspaceEditor {\n  /**\n   * Create a new [[WorkspaceEditor]] for creating new versions of [[WorkspaceDb]]s.\n   * @note the caller becomes the owner of the Workspace.Editor and is responsible for calling [[WorkspaceEditor.close]] on it when they are finished using it.\n   * @note It is illegal to have more than one Workspace.Editor active in a single session.\n   */\n  export function construct(): WorkspaceEditor {\n    return constructWorkspaceEditor();\n  }\n\n  /**\n   * Create a new, empty, [[EditableWorkspaceDb]] file on the local filesystem for importing [[Workspace]] resources.\n   */\n  export function createEmptyDb(args: { localFileName: LocalFileName, manifest: WorkspaceDbManifest }): void {\n    WorkspaceSqliteDb.createNewDb(args.localFileName, args);\n  }\n}\n\n/** Arguments supplied to [[WorkspaceEditor.createNewCloudContainer]] to create a new [[EditableWorkspaceContainer]].\n * @beta\n */\nexport interface CreateNewWorkspaceContainerArgs {\n  /**\n   * The scope of the container. This determines the ownership of the container, how RBAC rights are assigned,\n   * and the location of the datacenter\n   */\n  scope: BlobContainer.Scope;\n  /** The manifest to be stored in the default WorkspaceDb in the new container. */\n  manifest: WorkspaceDbManifest;\n  /** Metadata stored by the BlobContainer service */\n  metadata: Omit<BlobContainer.Metadata, \"containerType\">;\n  /** The name of the default [[WorkspaceDb]] created inside the new container.\n   * Default: \"workspace-db\";\n   */\n  dbName?: WorkspaceDbName;\n}\n\n/**\n * A [[WorkspaceContainer]] opened for editing by a [[WorkspaceEditor]].\n * You can create new [[WorkspaceDb]]s or new versions of existing [[WorkspaceDb]]s inside it.\n * Before actually making any changes to the container's contents, you must first obtain an exclusive write lock on it via\n * [[acquireWriteLock]]. Only one user can hold the write lock at any given time. When you have finished making changes,\n * you can use [[releaseWriteLock]] to publish your changes, or [[abandonChanges]] to discard them.\n * @beta\n */\nexport interface EditableWorkspaceContainer extends WorkspaceContainer {\n  /**\n   * Create a copy of an existing [[WorkspaceDb]] in this container with a new [[WorkspaceDbVersion]].\n   * The copy should be modified with new content before the write lock is released,\n   * and thereafter may never be modified again.\n   * @note The copy actually shares all of the data with the original, but with copy-on-write if/when data in the new WorkspaceDb is modified.\n   * @param props - The properties that determine the source WorkspaceDb to serve as the basis for the new version.\n   * @returns A promise that resolves to an object containing the old and new WorkspaceDb names and versions.\n   */\n  createNewWorkspaceDbVersion(props: CreateNewWorkspaceDbVersionArgs): Promise<{ oldDb: WorkspaceDbNameAndVersion, newDb: WorkspaceDbNameAndVersion }>;\n\n  /**\n   * Create a new, empty [[WorkspaceDb]].\n   * @param args - The arguments for creating the new WorkspaceDb.\n   * @returns A promise that resolves to an EditableWorkspaceDb.\n   */\n  createDb(args: { dbName?: WorkspaceDbName, version?: WorkspaceDbVersion, manifest: WorkspaceDbManifest }): Promise<EditableWorkspaceDb>;\n\n  /**\n   * Get the cloud properties of this container.\n   */\n  readonly cloudProps: WorkspaceContainerProps | undefined;\n\n  /**\n   * Get an editable [[WorkspaceDb]] to add, delete, or update resources *within a newly created version* of a WorkspaceDb.\n   * @param props - The properties of the WorkspaceDb.\n   */\n  getEditableDb(props: WorkspaceDbProps): EditableWorkspaceDb;\n\n  /**\n   * Acquire the write lock on the container. Use [[releaseWriteLock]] to release the lock after publishing your changes, or\n   * [[abandonChanges]] to release the lock and discard your changes.\n   * Only one use can hold the write lock at any given time. However, readers can continue to read the published contents of the container while\n   * a writer holds the write lock. Readers will only see the writer's changes after they are published by [[releaseWriteLock]].\n   * @param user - The name of the user acquiring the write lock.\n   */\n  acquireWriteLock(user: string): void;\n\n  /**\n   * Release the write lock on the container. This should be called after all changes to the container's contents are complete. It\n   * publishes and uploads the changes made to any [[WorkspaceDb]]s while the lock was held, after which those dbs become immutable.\n   */\n  releaseWriteLock(): void;\n\n  /**\n   * Abandon any changes made to the container and release the write lock. Any newly created versions of WorkspaceDbs are discarded.\n   */\n  abandonChanges(): void;\n}\n\n/**\n * The release increment for a version number, used as part of [[CreateNewWorkspaceDbVersionArgs]] to specify the kind of version to create.\n * @see [semver.ReleaseType](https://www.npmjs.com/package/semver)\n * @beta\n */\nexport type WorkspaceDbVersionIncrement = \"major\" | \"minor\" | \"patch\" | \"premajor\" | \"preminor\" | \"prepatch\" | \"prerelease\";\n\n/**\n * Arguments supplied to [[Workspace.createNewWorkspaceDbVersion]].\n * @beta\n */\nexport interface CreateNewWorkspaceDbVersionArgs {\n  /**\n   * The properties that determine the source [[WorkspaceDb]] to serve as the basis for the new version.\n   * This is usually the latest version, but it is possible to create patches to older versions.\n   */\n  fromProps?: WorkspaceDbProps;\n  /** The type of version increment to apply to the source version. */\n  versionType: WorkspaceDbVersionIncrement;\n  /** For prerelease versions, a string that becomes part of the version name. */\n  identifier?: string;\n}\n\n/**\n * An editable [[WorkspaceDb]]. This is used only by tools to allow administrators to create and modify WorkspaceDbs.\n * For cloud-based WorkspaceDbs, the container's write token must be obtained via [[EditableWorkspaceContainer.acquireWriteLock]] before the methods in this interface may be used.\n * Normally, only admins will have write access to a [[Workspace]].\n * Only one admin at a time may be editing a Workspace.\n * @beta\n */\nexport interface EditableWorkspaceDb extends WorkspaceDb {\n  readonly container: EditableWorkspaceContainer;\n  /**\n   * The cloud properties of the [[WorkspaceDb]], if this is a cloud-based WorkspaceDb.\n   */\n  get cloudProps(): WorkspaceDbCloudProps | undefined;\n\n  /**\n   * Update the contents of the manifest in this WorkspaceDb.\n   * @param manifest - The updated manifest.\n   */\n  updateManifest(manifest: WorkspaceDbManifest): void;\n\n  /**\n   * Add or update a resource in this WorkspaceDb that can be loaded as a [[SettingsDictionary]].\n   * The `settings` will be stored as stringified JSON.\n   * @param settings - The settings object to add or update.\n   * @param rscName - The name of the settings resource. Defaults to \"settingsDictionary\" if undefined.\n   */\n  updateSettingsResource(settings: SettingsContainer, rscName?: string): void;\n\n  /**\n   * Add a new string resource to this WorkspaceDb.\n   * @param rscName - The name of the string resource.\n   * @param val - The string to save.\n   * @throws if a string resource named `rscName` already exists.\n   */\n  addString(rscName: WorkspaceResourceName, val: string): void;\n\n  /**\n   * Update an existing string resource with a new value, or add it if it does not exist.\n   * @param rscName - The name of the string resource.\n   * @param val - The new value.\n   */\n  updateString(rscName: WorkspaceResourceName, val: string): void;\n\n  /**\n   * Remove a string resource.\n   * @param rscName - The name of the string resource to remove.\n   */\n  removeString(rscName: WorkspaceResourceName): void;\n\n  /**\n   * Add a new binary resource to this WorkspaceDb.\n   * @param rscName - The name of the blob resource.\n   * @param val - The blob to save.\n   * @throws if a blob resource named `rscName` already exists.\n   */\n  addBlob(rscName: WorkspaceResourceName, val: Uint8Array): void;\n\n  /**\n   * Update an existing blob resource with a new value, or add it if it does not exist.\n   * @param rscName - The name of the blob resource.\n   * @param val - The new value.\n   */\n  updateBlob(rscName: WorkspaceResourceName, val: Uint8Array): void;\n\n  /**\n   * Get a BlobIO writer for a previously-added blob WorkspaceResource.\n   * @param rscName - The name of the blob resource.\n   * @returns A BlobIO writer.\n   * @note After writing is complete, the caller must call `close` on the BlobIO and must call `saveChanges` on the `db`.\n   * @internal\n   */\n  getBlobWriter(rscName: WorkspaceResourceName): SQLiteDb.BlobIO;\n\n  /**\n   * Remove a binary resource.\n   * @param rscName - The name of the blob resource to remove.\n   */\n  removeBlob(rscName: WorkspaceResourceName): void;\n\n  /**\n   * Copy the contents of an existing local file into this WorkspaceDb as a file resource.\n   * @param rscName - The name of the file resource.\n   * @param localFileName - The name of a local file to be read.\n   * @param fileExt - The extension to be appended to the generated fileName when this WorkspaceDb is extracted from the WorkspaceDb.\n   * By default, the characters after the last \".\" in `localFileName` are used. Pass this argument to override that.\n   */\n  addFile(rscName: WorkspaceResourceName, localFileName: LocalFileName, fileExt?: string): void;\n\n  /**\n   * Replace an existing file resource with the contents of another local file.\n   * @param rscName - The name of the file resource.\n   * @param localFileName - The name of a local file to be read.\n   * @throws If the file resource does not exist.\n   */\n  updateFile(rscName: WorkspaceResourceName, localFileName: LocalFileName): void;\n\n  /**\n   * Remove a file resource.\n   * @param rscName - The name of the file resource to remove.\n   */\n  removeFile(rscName: WorkspaceResourceName): void;\n}\n\n/** An object that permits administrators to modify the contents of a [[Workspace]].\n * Use [[WorkspaceEditor.construct]] to obtain a WorkspaceEditor, and [[close]] when finished using it.\n * Only one WorkspaceEditor may be in use at any given time.\n * Use [[getContainer]] to edit an existing [[WorkspaceContainer]], or [[createNewCloudContainer]] to create a new [[WorkspaceContainer]].\n * @beta\n */\nexport interface WorkspaceEditor {\n  /** @internal */\n  [_implementationProhibited]: unknown;\n\n  /**\n   * The workspace dedicated to this editor.\n   * @note This workspace is independent from [[IModelHost.appWorkspace]] and all [[IModelDb.workspace]]s. It has its own [[Settings]] and [[WorkspaceDb]]s.\n   */\n  readonly workspace: Workspace;\n\n  /**\n   * Retrieves a container for the editor with the specified properties and access token.\n   */\n  getContainer(args: GetWorkspaceContainerArgs): EditableWorkspaceContainer;\n\n  /**\n   * Asynchronously retrieves a container for the editor with the specified properties.\n   */\n  getContainerAsync(props: WorkspaceContainerProps): Promise<EditableWorkspaceContainer>;\n\n  /**\n   * Creates a new cloud container for holding WorkspaceDbs, from the [[BlobContainer]] service.\n   * @note The current user must have administrator rights for the iTwin for the container.\n   */\n  createNewCloudContainer(args: CreateNewWorkspaceContainerArgs): Promise<EditableWorkspaceContainer>;\n\n  /**\n   * Closes this editor. All [[workspace]] containers are dropped.\n   */\n  close(): void;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/core-backend",
-  "version": "4.8.0-dev.16",
+  "version": "4.8.0-dev.18",
   "description": "iTwin.js backend components",
   "main": "lib/cjs/core-backend.js",
   "typings": "lib/cjs/core-backend",
@@ -25,9 +25,9 @@
     "url": "http://www.bentley.com"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "^4.8.0-dev.16",
-    "@itwin/core-common": "^4.8.0-dev.16",
-    "@itwin/core-geometry": "^4.8.0-dev.16",
+    "@itwin/core-bentley": "^4.8.0-dev.18",
+    "@itwin/core-common": "^4.8.0-dev.18",
+    "@itwin/core-geometry": "^4.8.0-dev.18",
     "@opentelemetry/api": "^1.0.4"
   },
   "peerDependenciesMeta": {
@@ -69,16 +69,16 @@
     "ts-node": "^10.8.2",
     "typescript": "~5.3.3",
     "webpack": "^5.76.0",
-    "@itwin/build-tools": "4.8.0-dev.16",
-    "@itwin/core-bentley": "4.8.0-dev.16",
-    "@itwin/core-common": "4.8.0-dev.16",
-    "@itwin/core-geometry": "4.8.0-dev.16",
-    "@itwin/ecsql-common": "4.8.0-dev.16",
-    "internal-tools": "3.0.0-dev.69",
-    "@itwin/core-webpack-tools": "4.8.0-dev.16"
+    "@itwin/build-tools": "4.8.0-dev.18",
+    "@itwin/core-bentley": "4.8.0-dev.18",
+    "@itwin/core-common": "4.8.0-dev.18",
+    "@itwin/core-geometry": "4.8.0-dev.18",
+    "@itwin/ecsql-common": "4.8.0-dev.18",
+    "@itwin/core-webpack-tools": "4.8.0-dev.18",
+    "internal-tools": "3.0.0-dev.69"
   },
   "dependencies": {
-    "@bentley/imodeljs-native": "4.8.12",
+    "@bentley/imodeljs-native": "4.8.17",
     "@itwin/cloud-agnostic-core": "^2.1.0",
     "@itwin/object-storage-azure": "^2.2.2",
     "@itwin/object-storage-core": "^2.2.2",
@@ -92,7 +92,7 @@
     "semver": "^7.3.5",
     "touch": "^3.1.0",
     "ws": "^7.5.10",
-    "@itwin/core-telemetry": "4.8.0-dev.16"
+    "@itwin/core-telemetry": "4.8.0-dev.18"
   },
   "nyc": {
     "extends": "./node_modules/@itwin/build-tools/.nycrc"

package/lib/cjs/ServerBasedLocks.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ServerBasedLocks.d.ts","sourceRoot":"","sources":["../../src/ServerBasedLocks.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAkB,OAAO,EAAE,UAAU,EAA0B,MAAM,qBAAqB,CAAC;AAClG,OAAO,EAAuB,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAEpE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEtD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,UAAU,GAAG,SAAS,CAAC;CAC3C;AASD,gBAAgB;AAChB,qBAAa,gBAAiB,YAAW,WAAW;IAClD,IAAW,aAAa,YAAmB;IAC3C,SAAS,CAAC,QAAQ,CAAC,MAAM,WAAkB;IAC3C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;gBAEvB,MAAM,EAAE,WAAW;IAY/B,KAAK;IAKZ,OAAO,CAAC,SAAS;IAWjB,OAAO,CAAC,YAAY;IAOpB;;OAEG;IACH,OAAO,CAAC,aAAa;IAKrB,qBAAqB;IACd,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM;IAQhC,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAK7C,OAAO,CAAC,UAAU;IAYlB,OAAO,CAAC,uBAAuB;IAgB/B,mGAAmG;IAC5F,kBAAkB,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO;IAK3C,eAAe,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO;IAM/C,sIAAsI;IACtI,OAAO,CAAC,aAAa;IAUrB,sGAAsG;IACtG,OAAO,CAAC,mBAAmB;IAM3B,mEAAmE;YACrD,eAAe;IAmBhB,YAAY,CAAC,GAAG,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBxF,wGAAwG;IACjG,iBAAiB,CAAC,EAAE,EAAE,UAAU;IAKvC,yDAAyD;IACzD,OAAO,KAAK,iBAAiB,GAAqD;IAElF,uGAAuG;IAChG,kBAAkB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAKzE,kGAAkG;IAC3F,eAAe,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;CAKvE"}

package/lib/cjs/ServerBasedLocks.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ServerBasedLocks.js","sourceRoot":"","sources":["../../src/ServerBasedLocks.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,sDAAkG;AAClG,oDAAoE;AAGpE,6CAA0C;AAC1C,yCAAsC;AAoBtC,gBAAgB;AAChB,MAAa,gBAAgB;IAC3B,IAAW,aAAa,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAI3C,YAAmB,MAAmB;QAHnB,WAAM,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAIzC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC;QACxB,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAE,QAAQ,CAAC;QAChE,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,uBAAQ,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC;QAAC,OAAO,EAAE,EAAE,CAAC;YACZ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC7B,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,2FAA2F,CAAC,CAAC;YACpH,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAC5B,CAAC;IACH,CAAC;IAEM,KAAK;QACV,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YACpB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAEO,SAAS,CAAC,EAAc;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,qDAAqD,EAAE,CAAC,IAAI,EAAE,EAAE;YAChH,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,uBAAQ,CAAC,aAAa,KAAK,EAAE;gBAC/B,MAAM,IAAI,yBAAW,CAAC,EAAE,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;YAEvD,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QACvE,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,YAAY,CAAC,EAAe;QAClC,OAAO,CAAC,EAAE,KAAK,SAAS,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,oCAAoC,EAAE,CAAC,IAAI,EAAE,EAAE;YAClJ,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,OAAO,CAAC,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACxF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACK,aAAa;QACnB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED,qBAAqB;IACd,YAAY,CAAC,KAAgB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,0CAA0C,EAAE,CAAC,IAAI,EAAE,EAAE;YAC1F,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,MAAM,uBAAU,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,yBAAyB;QACrF,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEO,UAAU,CAAC,EAAc,EAAE,KAAgB,EAAE,MAAkB;QACrE,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,6HAA6H,EAAE,CAAC,IAAI,EAAE,EAAE;YAC9K,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC5B,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE;gBAChC,MAAM,IAAI,yBAAW,CAAC,EAAE,EAAE,iCAAiC,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,uBAAuB,CAAC,EAA0B;QACxD,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,oBAAM,CAAC,aAAa;YACjD,OAAO,KAAK,CAAC,CAAC,gBAAgB;QAEhC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACjD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,uBAAS,CAAC,SAAS,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,uBAAS,CAAC,SAAS;YAC3G,OAAO,IAAI,CAAC;QAEd,wIAAwI;QACxI,IAAI,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC;YACvC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,uBAAS,CAAC,SAAS,gCAAwB,CAAC;QAE9E,yIAAyI;QACzI,OAAO,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,QAAS,EAAE,uBAAS,CAAC,SAAS,gCAAwB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,+DAA+D;IACjM,CAAC;IAED,mGAAmG;IAC5F,kBAAkB,CAAC,EAAc;QACtC,2GAA2G;QAC3G,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,uBAAS,CAAC,SAAS,IAAI,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;IAC3F,CAAC;IAEM,eAAe,CAAC,EAAc;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QACpC,gKAAgK;QAChK,OAAO,CAAC,KAAK,KAAK,uBAAS,CAAC,MAAM,IAAI,KAAK,KAAK,uBAAS,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED,sIAAsI;IAC9H,aAAa,CAAC,EAA0B,EAAE,KAAsB;QACtE,gHAAgH;QAChH,0GAA0G;QAC1G,IAAI,EAAE,KAAK,SAAS,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACpF,OAAO;QAET,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,oCAAoC;QACnD,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,iCAAiC;IACxE,CAAC;IAED,sGAAsG;IAC9F,mBAAmB,CAAC,EAAc,EAAE,KAAsB;QAChE,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC9B,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,gCAAgC;QACxE,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,kBAAkB;IAC3D,CAAC;IAED,mEAAmE;IAC3D,KAAK,CAAC,eAAe,CAAC,KAAc;QAC1C,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,yBAAyB;YAC7C,OAAO;QAET,MAAM,WAAW,GAAG,IAAI,GAAG,EAAc,CAAC;QAC1C,KAAK,MAAM,IAAI,IAAI,KAAK;YACtB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QAEjD,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE,CAAC;YACjC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,8CAA8C;gBACpE,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,uBAAS,CAAC,MAAM,CAAC,CAAC;QACxC,CAAC;QAED,MAAM,uBAAU,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,yBAAyB;QACzF,KAAK,MAAM,IAAI,IAAI,KAAK;YACtB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,8BAAsB,CAAC;QACzD,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,GAA8C;QACtE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAyB,CAAC;QAC/C,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YACf,KAAK,MAAM,EAAE,IAAI,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3C,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;oBAC3B,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,uBAAS,CAAC,MAAM,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;QACD,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;YAClB,KAAK,MAAM,EAAE,IAAI,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC9C,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;oBAC9B,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,uBAAS,CAAC,SAAS,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED,wGAAwG;IACjG,iBAAiB,CAAC,EAAc;QACrC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,uBAAS,CAAC,SAAS,gCAAwB,CAAC;QAChE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED,yDAAyD;IACzD,IAAY,iBAAiB,KAAK,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAElF,uGAAuG;IAChG,kBAAkB,CAAC,EAAc,EAAE,IAAY,EAAE,SAAiB;QACvE,IAAI,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,WAAW,EAAE,8BAA8B,IAAI,QAAQ,SAAS,QAAQ,EAAE,GAAG,CAAC,CAAC;IACtH,CAAC;IAED,kGAAkG;IAC3F,eAAe,CAAC,EAAc,EAAE,IAAY,EAAE,SAAiB;QACpE,IAAI,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,WAAW,EAAE,2BAA2B,IAAI,QAAQ,SAAS,QAAQ,EAAE,GAAG,CAAC,CAAC;IACnH,CAAC;CAEF;AAlLD,4CAkLC","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\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\nimport { DbResult, Id64, Id64Arg, Id64String, IModelStatus, OpenMode } from \"@itwin/core-bentley\";\r\nimport { IModel, IModelError, LockState } from \"@itwin/core-common\";\r\nimport { LockMap } from \"./BackendHubAccess\";\r\nimport { BriefcaseDb, LockControl } from \"./IModelDb\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { SQLiteDb } from \"./SQLiteDb\";\r\n\r\n/**\r\n * Both the Model and Parent of an element are considered \"owners\" of their member elements. That means:\r\n * 1) they must hold at least a shared lock before an exclusive lock can be acquired for their members\r\n * 2) if they hold an exclusive lock, then all of their members are exclusively locked implicitly.\r\n * @internal\r\n */\r\nexport interface ElementOwners {\r\n  readonly modelId: Id64String;\r\n  readonly parentId: Id64String | undefined;\r\n}\r\n\r\n// eslint-disable-next-line no-restricted-syntax\r\nconst enum LockOrigin {\r\n  Acquired = 0,\r\n  NewElement = 1,\r\n  Discovered = 2,\r\n}\r\n\r\n/** @internal */\r\nexport class ServerBasedLocks implements LockControl {\r\n  public get isServerBased() { return true; }\r\n  protected readonly lockDb = new SQLiteDb();\r\n  protected readonly briefcase: BriefcaseDb;\r\n\r\n  public constructor(iModel: BriefcaseDb) {\r\n    this.briefcase = iModel;\r\n    const dbName = `${iModel.nativeDb.getTempFileBaseName()}-locks`;\r\n    try {\r\n      this.lockDb.openDb(dbName, OpenMode.ReadWrite);\r\n    } catch (_e) {\r\n      this.lockDb.createDb(dbName);\r\n      this.lockDb.executeSQL(\"CREATE TABLE locks(id INTEGER PRIMARY KEY NOT NULL,state INTEGER NOT NULL,origin INTEGER)\");\r\n      this.lockDb.saveChanges();\r\n    }\r\n  }\r\n\r\n  public close() {\r\n    if (this.lockDb.isOpen)\r\n      this.lockDb.closeDb();\r\n  }\r\n\r\n  private getOwners(id: Id64String): ElementOwners {\r\n    return this.briefcase.withPreparedSqliteStatement(\"SELECT ModelId,ParentId FROM bis_Element WHERE id=?\", (stmt) => {\r\n      stmt.bindId(1, id);\r\n      const rc = stmt.step();\r\n      if (DbResult.BE_SQLITE_ROW !== rc)\r\n        throw new IModelError(rc, `element ${id} not found`);\r\n\r\n      return { modelId: stmt.getValueId(0), parentId: stmt.getValueId(1) };\r\n    });\r\n  }\r\n\r\n  private getLockState(id?: Id64String): LockState | undefined {\r\n    return (id === undefined || !Id64.isValid(id)) ? undefined : this.lockDb.withPreparedSqliteStatement(\"SELECT state FROM locks WHERE id=?\", (stmt) => {\r\n      stmt.bindId(1, id);\r\n      return (DbResult.BE_SQLITE_ROW === stmt.step()) ? stmt.getValueInteger(0) : undefined;\r\n    });\r\n  }\r\n\r\n  /** Clear the cache of locally held locks.\r\n   * Note: does *not* release locks from server.\r\n   */\r\n  private clearAllLocks() {\r\n    this.lockDb.executeSQL(\"DELETE FROM locks\");\r\n    this.lockDb.saveChanges();\r\n  }\r\n\r\n  /** only for tests */\r\n  public getLockCount(state: LockState): number {\r\n    return this.lockDb.withSqliteStatement(\"SELECT count(*) FROM locks WHERE state=?\", (stmt) => {\r\n      stmt.bindInteger(1, state);\r\n      stmt.step();\r\n      return stmt.getValueInteger(0);\r\n    });\r\n  }\r\n\r\n  public async releaseAllLocks(): Promise<void> {\r\n    await IModelHost.hubAccess.releaseAllLocks(this.briefcase); // throws if unsuccessful\r\n    this.clearAllLocks();\r\n  }\r\n\r\n  private insertLock(id: Id64String, state: LockState, origin: LockOrigin): true {\r\n    this.lockDb.withPreparedSqliteStatement(\"INSERT INTO locks(id,state,origin) VALUES (?,?,?) ON CONFLICT(id) DO UPDATE SET state=excluded.state,origin=excluded.origin\", (stmt) => {\r\n      stmt.bindId(1, id);\r\n      stmt.bindInteger(2, state);\r\n      stmt.bindInteger(3, origin);\r\n      const rc = stmt.step();\r\n      if (DbResult.BE_SQLITE_DONE !== rc)\r\n        throw new IModelError(rc, \"can't insert lock into database\");\r\n    });\r\n    return true;\r\n  }\r\n\r\n  private ownerHoldsExclusiveLock(id: Id64String | undefined): boolean {\r\n    if (id === undefined || id === IModel.rootSubjectId)\r\n      return false; // has no owners\r\n\r\n    const { modelId, parentId } = this.getOwners(id);\r\n    if (this.getLockState(modelId) === LockState.Exclusive || this.getLockState(parentId) === LockState.Exclusive)\r\n      return true;\r\n\r\n    // see if this model is exclusively locked by one of its owners. If so, save that fact on modelId so future tests won't have to descend.\r\n    if (this.ownerHoldsExclusiveLock(modelId))\r\n      return this.insertLock(modelId, LockState.Exclusive, LockOrigin.Discovered);\r\n\r\n    // see if the parent is exclusively locked by one of its owners. If so, save that fact on parentId so future tests won't have to descend.\r\n    return this.ownerHoldsExclusiveLock(parentId) ? this.insertLock(parentId!, LockState.Exclusive, LockOrigin.Discovered) : false; // eslint-disable-line @typescript-eslint/no-non-null-assertion\r\n  }\r\n\r\n  /** Determine whether an the exclusive lock is already held by an element (or one of its owners) */\r\n  public holdsExclusiveLock(id: Id64String): boolean {\r\n    // see if we hold the exclusive lock. or if one of the element's owners is exclusively locked (recursively)\r\n    return this.getLockState(id) === LockState.Exclusive || this.ownerHoldsExclusiveLock(id);\r\n  }\r\n\r\n  public holdsSharedLock(id: Id64String): boolean {\r\n    const state = this.getLockState(id);\r\n    // see if we hold shared or exclusive lock, or if an owner has exclusive lock. If so we implicitly have shared lock, but owner holding shared lock doesn't help.\r\n    return (state === LockState.Shared || state === LockState.Exclusive) || this.ownerHoldsExclusiveLock(id);\r\n  }\r\n\r\n  /** if the shared lock on the element supplied is not already held, add it to the set of shared locks required. Then, check owners. */\r\n  private addSharedLock(id: Id64String | undefined, locks: Set<Id64String>) {\r\n    // if the id is not valid, or of the lock is already in the set, or if we already hold a shared lock, we're done\r\n    // Note: if we hold a shared lock, it is guaranteed that we also hold all required shared locks on owners.\r\n    if (id === undefined || !Id64.isValid(id) || locks.has(id) || this.holdsSharedLock(id))\r\n      return;\r\n\r\n    locks.add(id); // add to set of needed shared locks\r\n    this.addOwnerSharedLocks(id, locks); // check parent models and groups\r\n  }\r\n\r\n  /** add owners (recursively) of an element to a list of required shared locks, if not already held. */\r\n  private addOwnerSharedLocks(id: Id64String, locks: Set<Id64String>) {\r\n    const el = this.getOwners(id);\r\n    this.addSharedLock(el.parentId, locks); // if this element is in a group\r\n    this.addSharedLock(el.modelId, locks); // check its model\r\n  }\r\n\r\n  /** attempt to acquire all necessary locks for a set of elements */\r\n  private async acquireAllLocks(locks: LockMap) {\r\n    if (locks.size === 0) // no locks are required.\r\n      return;\r\n\r\n    const sharedLocks = new Set<Id64String>();\r\n    for (const lock of locks)\r\n      this.addOwnerSharedLocks(lock[0], sharedLocks);\r\n\r\n    for (const shared of sharedLocks) {\r\n      if (!locks.has(shared)) // we may already be asking for exclusive lock\r\n        locks.set(shared, LockState.Shared);\r\n    }\r\n\r\n    await IModelHost.hubAccess.acquireLocks(this.briefcase, locks); // throws if unsuccessful\r\n    for (const lock of locks)\r\n      this.insertLock(lock[0], lock[1], LockOrigin.Acquired);\r\n    this.lockDb.saveChanges();\r\n  }\r\n\r\n  public async acquireLocks(arg: { shared?: Id64Arg, exclusive?: Id64Arg }): Promise<void> {\r\n    const locks = new Map<Id64String, LockState>();\r\n    if (arg.shared) {\r\n      for (const id of Id64.iterable(arg.shared)) {\r\n        if (!this.holdsSharedLock(id))\r\n          locks.set(id, LockState.Shared);\r\n      }\r\n    }\r\n    if (arg.exclusive) {\r\n      for (const id of Id64.iterable(arg.exclusive)) {\r\n        if (!this.holdsExclusiveLock(id))\r\n          locks.set(id, LockState.Exclusive);\r\n      }\r\n    }\r\n    return this.acquireAllLocks(locks);\r\n  }\r\n\r\n  /** When an element is newly created in a session, we hold the lock on it implicitly. Save that fact. */\r\n  public elementWasCreated(id: Id64String) {\r\n    this.insertLock(id, LockState.Exclusive, LockOrigin.NewElement);\r\n    this.lockDb.saveChanges();\r\n  }\r\n\r\n  /** locks are not necessary during change propagation. */\r\n  private get _locksAreRequired() { return !this.briefcase.txns.isIndirectChanges; }\r\n\r\n  /** throw if locks are currently required and the exclusive lock is not held on the supplied element */\r\n  public checkExclusiveLock(id: Id64String, type: string, operation: string) {\r\n    if (this._locksAreRequired && !this.holdsExclusiveLock(id))\r\n      throw new IModelError(IModelStatus.LockNotHeld, `exclusive lock not held on ${type} for ${operation} (id=${id})`);\r\n  }\r\n\r\n  /** throw if locks are currently required and a shared lock is not held on the supplied element */\r\n  public checkSharedLock(id: Id64String, type: string, operation: string) {\r\n    if (this._locksAreRequired && !this.holdsSharedLock(id))\r\n      throw new IModelError(IModelStatus.LockNotHeld, `shared lock not held on ${type} for ${operation} (id=${id})`);\r\n  }\r\n\r\n}\r\n\r\n"]}

package/lib/cjs/internal/ImplementationProhibited.d.ts

@@ -1,44 +0,0 @@
-/** @packageDocumentation
- * @module Workspace
- */
-/** A symbol used to prevent implementations of an interface from being created outside of the package that defines the interface.
- * This is useful when a package defines a public interface with one or more private implementations.
- * The only way for users of the package to obtain an implementation of the interface is by calling a method in the package's public API that returns one.
- * It permits the package to add new required properties and methods to the interface without breaking API compatibility, because no one
- * else can possibly have created their own implementations lacking those new properties or methods.
- *
- * Simple example:
- * ```ts
- *  // @public
- *  interface Thing {
- *    name: string;
- *    [implementationProhibited]: unknown;
- *  }
- *
- *  // Not exported
- *  class ThingImpl implements Thing {
- *    constructor(public name: string) { }
- *    public readonly [implementationProhibited] = undefined;
- *  }
- *
- *  // @public
- *  export function getThing(name: string): Thing { return new ThingImpl(name); }
- * ```
- *
- * This effectively turns the interface into a nominal type, bypassing TypeScript's structural typing.
- * If someone attempts to supply their own implementation of `Thing`:
- *
- * ```ts
- *  const thing: Thing = { name: "my thing" };
- * ```
- *
- * ...they will receive a compiler error. Because they cannot access the `implementationProhibited` symbol,
- * they will not be able to appease the compiler except by casting to `any`.
- *
- * Of course, you must make sure not to export the symbol from the package - that would defeat the whole purpose.
- * It is exported here from the internal API for consumption inside the package only. It is not exported from the package's barrel file.
- *
- * The vast majority of interfaces do not need this.
- */
-export declare const implementationProhibited: unique symbol;
-//# sourceMappingURL=ImplementationProhibited.d.ts.map

package/lib/cjs/internal/ImplementationProhibited.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ImplementationProhibited.d.ts","sourceRoot":"","sources":["../../../src/internal/ImplementationProhibited.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,eAAO,MAAM,wBAAwB,eAAsC,CAAC"}

package/lib/cjs/internal/ImplementationProhibited.js

@@ -1,51 +0,0 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Workspace
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.implementationProhibited = void 0;
-/** A symbol used to prevent implementations of an interface from being created outside of the package that defines the interface.
- * This is useful when a package defines a public interface with one or more private implementations.
- * The only way for users of the package to obtain an implementation of the interface is by calling a method in the package's public API that returns one.
- * It permits the package to add new required properties and methods to the interface without breaking API compatibility, because no one
- * else can possibly have created their own implementations lacking those new properties or methods.
- *
- * Simple example:
- * ```ts
- *  // @public
- *  interface Thing {
- *    name: string;
- *    [implementationProhibited]: unknown;
- *  }
- *
- *  // Not exported
- *  class ThingImpl implements Thing {
- *    constructor(public name: string) { }
- *    public readonly [implementationProhibited] = undefined;
- *  }
- *
- *  // @public
- *  export function getThing(name: string): Thing { return new ThingImpl(name); }
- * ```
- *
- * This effectively turns the interface into a nominal type, bypassing TypeScript's structural typing.
- * If someone attempts to supply their own implementation of `Thing`:
- *
- * ```ts
- *  const thing: Thing = { name: "my thing" };
- * ```
- *
- * ...they will receive a compiler error. Because they cannot access the `implementationProhibited` symbol,
- * they will not be able to appease the compiler except by casting to `any`.
- *
- * Of course, you must make sure not to export the symbol from the package - that would defeat the whole purpose.
- * It is exported here from the internal API for consumption inside the package only. It is not exported from the package's barrel file.
- *
- * The vast majority of interfaces do not need this.
- */
-exports.implementationProhibited = Symbol("implementation prohibited");
-//# sourceMappingURL=ImplementationProhibited.js.map

package/lib/cjs/internal/ImplementationProhibited.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ImplementationProhibited.js","sourceRoot":"","sources":["../../../src/internal/ImplementationProhibited.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACU,QAAA,wBAAwB,GAAG,MAAM,CAAC,2BAA2B,CAAC,CAAC","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\n/** A symbol used to prevent implementations of an interface from being created outside of the package that defines the interface.\r\n * This is useful when a package defines a public interface with one or more private implementations.\r\n * The only way for users of the package to obtain an implementation of the interface is by calling a method in the package's public API that returns one.\r\n * It permits the package to add new required properties and methods to the interface without breaking API compatibility, because no one\r\n * else can possibly have created their own implementations lacking those new properties or methods.\r\n *\r\n * Simple example:\r\n * ```ts\r\n *  // @public\r\n *  interface Thing {\r\n *    name: string;\r\n *    [implementationProhibited]: unknown;\r\n *  }\r\n *\r\n *  // Not exported\r\n *  class ThingImpl implements Thing {\r\n *    constructor(public name: string) { }\r\n *    public readonly [implementationProhibited] = undefined;\r\n *  }\r\n *\r\n *  // @public\r\n *  export function getThing(name: string): Thing { return new ThingImpl(name); }\r\n * ```\r\n *\r\n * This effectively turns the interface into a nominal type, bypassing TypeScript's structural typing.\r\n * If someone attempts to supply their own implementation of `Thing`:\r\n *\r\n * ```ts\r\n *  const thing: Thing = { name: \"my thing\" };\r\n * ```\r\n *\r\n * ...they will receive a compiler error. Because they cannot access the `implementationProhibited` symbol,\r\n * they will not be able to appease the compiler except by casting to `any`.\r\n *\r\n * Of course, you must make sure not to export the symbol from the package - that would defeat the whole purpose.\r\n * It is exported here from the internal API for consumption inside the package only. It is not exported from the package's barrel file.\r\n *\r\n * The vast majority of interfaces do not need this.\r\n */\r\nexport const implementationProhibited = Symbol(\"implementation prohibited\");\r\n"]}