@itwin/core-backend 5.8.2 → 5.9.0-dev.10

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;;;AAMH,kEAAwD;AAKxD,+EAA4E;AAC5E,uEAA+E;AAC/E,iDAAgE;AAEhE,8CAA2C;AAE3C,YAAY;AACZ,IAAiB,eAAe,CA2C/B;AA3CD,WAAiB,eAAe;IAC9B;;;;OAIG;IACH,SAAgB,SAAS;QACvB,OAAO,IAAA,wCAAwB,GAAE,CAAC;IACpC,CAAC;IAFe,yBAAS,YAExB,CAAA;IAED;;;;OAIG;IACH,SAAgB,aAAa,CAAC,IAAqE;QACjG,qCAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;IAFe,6BAAa,gBAE5B,CAAA;IAYD;;;;;;;OAOG;IACI,KAAK,UAAU,eAAe,CAAC,IAAkC;QACtE,IAAI,SAAS,KAAK,oCAAa,CAAC,OAAO;YACrC,MAAM,IAAI,KAAK,CAAC,sGAAsG,CAAC,CAAC;QAC1H,MAAM,SAAS,GAAG,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC;QACpD,OAAO,oCAAa,CAAC,OAAO,CAAC,uBAAuB,CAAC,SAAS,EAAE,EAAE,GAAG,IAAI,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC,CAAC;IAC3G,CAAC;IALqB,+BAAe,kBAKpC,CAAA;AACH,CAAC,EA3CgB,eAAe,+BAAf,eAAe,QA2C/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 { GuidString } from \"@itwin/core-bentley\";\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/Symbols\";\r\nimport { CloudSqlite } from \"../CloudSqlite\";\r\nimport { IModelHost } from \"../IModelHost\";\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   * @note Do not pass an untrusted or unintended path in `localFileName`.\r\n   * This helper creates or overwrites the file at that location; callers that need fail-if-exists behavior should check first.\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  /** Arguments for [[WorkspaceEditor.queryContainers]] and [[WorkspaceEditor.findContainers]]. */\r\n  export interface QueryWorkspaceContainersArgs {\r\n    /** The iTwinId whose workspace containers should be queried. */\r\n    iTwinId: GuidString;\r\n    /** Optional iModelId to further scope the query to containers associated with a specific iModel. */\r\n    iModelId?: GuidString;\r\n    /** Optional label filter. */\r\n    label?: string;\r\n  }\r\n\r\n  /**\r\n   * Query the [[BlobContainer]] service for all workspace containers associated with a given iTwin.\r\n   * This is a convenience wrapper around `BlobContainer.service.queryContainersMetadata` that\r\n   * automatically filters by `containerType: \"workspace\"`.\r\n   * @param args - The query arguments including the iTwinId.\r\n   * @returns A promise that resolves to the matching container metadata entries.\r\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\r\n   */\r\n  export async function queryContainers(args: QueryWorkspaceContainersArgs): Promise<BlobContainer.MetadataResponse[]> {\r\n    if (undefined === BlobContainer.service)\r\n      throw new Error(\"BlobContainer.service is not available. Ensure IModelHost is initialized with a valid configuration.\");\r\n    const userToken = await IModelHost.getAccessToken();\r\n    return BlobContainer.service.queryContainersMetadata(userToken, { ...args, containerType: \"workspace\" });\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. If `args.version` is omitted for a cloud container, the new db is created as version `0.0.0`.\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   * Repeated calls that resolve to the same WorkspaceDb return the same cached instance until it is closed.\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 * 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: CloudSqlite.SemverIncrement;\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   * Find and open existing workspace containers by querying the [[BlobContainer]] service.\r\n   * This is a convenience method that queries for all workspace containers matching the given iTwinId\r\n   * (and optionally iModelId), requests write access tokens, and opens each matching container.\r\n   * @param args - The query arguments including iTwinId and optionally iModelId and label.\r\n   * @returns A promise that resolves to an array of opened [[EditableWorkspaceContainer]]s.\r\n   * @note Requires [[IModelHost.authorizationClient]] and [[BlobContainer.service]] to be configured.\r\n   */\r\n  findContainers(args: WorkspaceEditor.QueryWorkspaceContainersArgs): 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;;;AAMH,kEAAwD;AAKxD,+EAA4E;AAC5E,uEAA+E;AAC/E,iDAAgE;AAEhE,8CAA2C;AAE3C,YAAY;AACZ,IAAiB,eAAe,CA6C/B;AA7CD,WAAiB,eAAe;IAC9B;;;;OAIG;IACH,SAAgB,SAAS;QACvB,OAAO,IAAA,wCAAwB,GAAE,CAAC;IACpC,CAAC;IAFe,yBAAS,YAExB,CAAA;IAED;;;;OAIG;IACH,SAAgB,aAAa,CAAC,IAAqE;QACjG,qCAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;IAFe,6BAAa,gBAE5B,CAAA;IAcD;;;;;;;OAOG;IACI,KAAK,UAAU,eAAe,CAAC,IAAkC;QACtE,IAAI,SAAS,KAAK,oCAAa,CAAC,OAAO;YACrC,MAAM,IAAI,KAAK,CAAC,sGAAsG,CAAC,CAAC;QAC1H,MAAM,SAAS,GAAG,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC;QACpD,OAAO,oCAAa,CAAC,OAAO,CAAC,uBAAuB,CAAC,SAAS,EAAE,EAAE,GAAG,IAAI,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,IAAI,WAAW,EAAE,CAAC,CAAC;IACjI,CAAC;IALqB,+BAAe,kBAKpC,CAAA;AACH,CAAC,EA7CgB,eAAe,+BAAf,eAAe,QA6C/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 { GuidString } from \"@itwin/core-bentley\";\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\";\nimport { CloudSqlite } from \"../CloudSqlite\";\nimport { IModelHost } from \"../IModelHost\";\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   * @note Do not pass an untrusted or unintended path in `localFileName`.\n   * This helper creates or overwrites the file at that location; callers that need fail-if-exists behavior should check first.\n   */\n  export function createEmptyDb(args: { localFileName: LocalFileName, manifest: WorkspaceDbManifest }): void {\n    WorkspaceSqliteDb.createNewDb(args.localFileName, args);\n  }\n\n  /** Arguments for [[WorkspaceEditor.queryContainers]] and [[WorkspaceEditor.findContainers]]. */\n  export interface QueryWorkspaceContainersArgs {\n    /** The iTwinId whose workspace containers should be queried. */\n    iTwinId: GuidString;\n    /** Optional iModelId to further scope the query to containers associated with a specific iModel. */\n    iModelId?: GuidString;\n    /** Optional label filter. */\n    label?: string;\n    /** The type of container to query. Defaults to `\"workspace\"`. */\n    containerType?: \"workspace\" | \"settings\";\n  }\n\n  /**\n   * Query the [[BlobContainer]] service for all workspace containers associated with a given iTwin.\n   * This is a convenience wrapper around `BlobContainer.service.queryContainersMetadata` that\n   * automatically filters by `containerType: \"workspace\"`.\n   * @param args - The query arguments including the iTwinId.\n   * @returns A promise that resolves to the matching container metadata entries.\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\n   */\n  export async function queryContainers(args: QueryWorkspaceContainersArgs): Promise<BlobContainer.MetadataResponse[]> {\n    if (undefined === BlobContainer.service)\n      throw new Error(\"BlobContainer.service is not available. Ensure IModelHost is initialized with a valid configuration.\");\n    const userToken = await IModelHost.getAccessToken();\n    return BlobContainer.service.queryContainersMetadata(userToken, { ...args, containerType: args.containerType ?? \"workspace\" });\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 type of container to create. Defaults to `\"workspace\"`. */\n  containerType?: \"workspace\" | \"settings\";\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. If `args.version` is omitted for a cloud container, the new db is created as version `0.0.0`.\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   * Repeated calls that resolve to the same WorkspaceDb return the same cached instance until it is closed.\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   * Acquire the write lock, get or create an editable tip [[WorkspaceDb]], open it, run `operation`,\n   * then close the db and release the lock.\n   * If the current tip has already been published, a new prerelease version is created automatically.\n   * On error the lock is released and changes are abandoned.\n   * @param user - The name of the user acquiring the write lock.\n   * @param operation - A callback invoked with the opened [[EditableWorkspaceDb]].\n   * @param props - Properties identifying which db to operate on. Defaults to the container's default db.\n   */\n  withEditableDb(user: string, operation: (db: EditableWorkspaceDb) => void, props?: WorkspaceDbProps): Promise<void>;\n}\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: CloudSqlite.SemverIncrement;\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   * Find and open existing workspace containers by querying the [[BlobContainer]] service.\n   * This is a convenience method that queries for all workspace containers matching the given iTwinId\n   * (and optionally iModelId), requests write access tokens, and opens each matching container.\n   * @param args - The query arguments including iTwinId and optionally iModelId and label.\n   * @returns A promise that resolves to an array of opened [[EditableWorkspaceContainer]]s.\n   * @note Requires [[IModelHost.authorizationClient]] and [[BlobContainer.service]] to be configured.\n   */\n  findContainers(args: WorkspaceEditor.QueryWorkspaceContainersArgs): Promise<EditableWorkspaceContainer[]>;\n\n  /**\n   * Closes this editor. All [[workspace]] containers are dropped.\n   */\n  close(): void;\n}\n"]}

package/lib/esm/BackendHubAccess.d.ts

@@ -197,10 +197,48 @@ export interface BackendHubAccess {
      * @throws ConflictingLocksError if one or more requested locks are held by other briefcases.
      */
     acquireLocks: (arg: BriefcaseDbArg, locks: LockMap) => Promise<void>;
+    /**
+     * Abandons the specified locks when none of the associated elements have
+     * been or will be modified. Depending on the {@link LockState} specified for the lock,
+     * it may be returned to the {@link LockState.Shared} state or released entirely. It is only
+     * valid to call this method when none of the elements protected by the locks have been edited, or if all edits
+     * have been reversed or abandoned without pushing them.
+     *
+     * The locks are released on the IModelHub, but the changeset associated with the locks is not updated.
+     *
+     * It is an error to specify {@link LockState.Exclusive} for any element, to specify {@link LockState.Shared}
+     * for an element where the Exclusive lock is not currently held, or to include any element for which no lock
+     * is currently held.
+     *
+     * This method is optional, so not all IModelHubs will implement it. If this method is not implemented
+     * explicitly by an IModelHub, it will be implemented implicitly by calling
+     * {@link BackendHubAccess.acquireLocks} with the same locks and passing `changeset.id=""` and
+     * `changeset.index=0` in the first argument to indicate that the lock state should change without updating
+     * the changeset associated with the locks.
+     *
+     * @beta
+     */
+    abandonLocks?: (arg: BriefcaseIdArg, locks: LockMap) => Promise<void>;
     /** Get the list of all held locks for a briefcase. This can be very expensive and is currently used only for tests. */
     queryAllLocks: (arg: BriefcaseDbArg) => Promise<LockProps[]>;
     /** Release all currently held locks */
     releaseAllLocks: (arg: BriefcaseDbArg) => Promise<void>;
+    /**
+     * Abandons all currently held locks when none of the associated elements have been or will be modified.
+     * It is only valid to call this method when none of the elements protected by the locks have been edited,
+     * or if all edits have been reversed or abandoned without pushing them.
+     *
+     * The locks are released on the IModelHub, but the changeset associated with the locks is not updated.
+     *
+     * This method is optional, so not all IModelHubs will implement it. If this method is not implemented
+     * explicitly by an IModelHub, it will be implemented implicitly by calling
+     * {@link BackendHubAccess.releaseAllLocks}, passing `changeset.id=""` and `changeset.index=0` in the
+     * first argument to indicate that the lock state should change without updating the changeset associated
+     * with the locks.
+     *
+     * @beta
+     */
+    abandonAllLocks?: (arg: BriefcaseIdArg) => Promise<void>;
     /** Get the iModelId of an iModel by name. Undefined if no iModel with that name exists.  */
     queryIModelByName: (arg: IModelNameArg) => Promise<GuidString | undefined>;
     /** create a new iModel. Returns the Guid of the newly created iModel */

package/lib/esm/BackendHubAccess.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BackendHubAccess.d.ts","sourceRoot":"","sources":["../../src/BackendHubAccess.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAmB,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EACL,WAAW,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,cAAc,EACzH,SAAS,IAAI,eAAe,EAAE,WAAW,EAAE,aAAa,EACxD,YAAY,EAAE,aAAa,EAC5B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;EAEE;AACF,qBAAa,YAAa,SAAQ,WAAW;IAEzC,mCAAmC;aACnB,WAAW,EAAE,WAAW;IACxC,sCAAsC;aACtB,cAAc,EAAE,MAAM;;IAHtC,mCAAmC;IACnB,WAAW,EAAE,WAAW;IACxC,sCAAsC;IACtB,cAAc,EAAE,MAAM,EACtC,GAAG,EAAE,qBAAqB,GAAG,gCAAgC;CAIhE;AAED;;;GAGG;AACH,oBAAY,SAAS;IACnB,gCAAgC;IAChC,IAAI,IAAI;IACR,mJAAmJ;IACnJ,MAAM,IAAI;IACV;;OAEG;IACH,SAAS,IAAI;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,+BAA+B;IAC/B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B,6EAA6E;IAC7E,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,iFAAiF;IACjF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,iGAAiG;IACjG,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC;IACxB,qBAAqB;IACrB,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,6GAA6G;IAC7G,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,QAAQ;IAC3C,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,WAAW;IAC3D,kIAAkI;IAClI,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,iEAAiE;IACjE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ,EAAE,UAAU;IACzD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,YAAY,EAAE,mBAAmB;IAC7E,0DAA0D;IAC1D,SAAS,EAAE,YAAY,CAAC;CACzB;AAED,gBAAgB;AAChB,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,uFAAuF;IACvF,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB,EAAE,mBAAmB;IACvF,2DAA2D;IAC3D,SAAS,EAAE,YAAY,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,0DAA0D;IAC1D,kBAAkB,EAAE,CAAC,GAAG,EAAE,yBAAyB,KAAK,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACtF,mCAAmC;IACnC,iBAAiB,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC9E,6DAA6D;IAC7D,cAAc,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAC/D,gFAAgF;IAChF,eAAe,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACvE,gFAAgF;IAChF,aAAa,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,cAAc,EAAE,kBAAkB,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACtG,0DAA0D;IAC1D,kBAAkB,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAClE,kDAAkD;IAClD,uBAAuB,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,OAAO,EAAE,aAAa,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACpG,iDAAiD;IACjD,4BAA4B,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAEtG;;SAEK;IACL,qBAAqB,EAAE,CAAC,GAAG,EAAE,wBAAwB,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/E,gHAAgH;IAChH,gBAAgB,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD,yDAAyD;IACzD,iBAAiB,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAEhE,8FAA8F;IAC9F,iBAAiB,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC,CAAC;IAE1F;;;OAGG;IACH,YAAY,EAAE,CAAC,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE,uHAAuH;IACvH,aAAa,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAE7D,uCAAuC;IACvC,eAAe,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD,4FAA4F;IAC5F,iBAAiB,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAE3E,wEAAwE;IACxE,eAAe,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;IAEpE,uBAAuB;IACvB,YAAY,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAChE"}
+{"version":3,"file":"BackendHubAccess.d.ts","sourceRoot":"","sources":["../../src/BackendHubAccess.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAmB,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EACL,WAAW,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,cAAc,EACzH,SAAS,IAAI,eAAe,EAAE,WAAW,EAAE,aAAa,EACxD,YAAY,EAAE,aAAa,EAC5B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;EAEE;AACF,qBAAa,YAAa,SAAQ,WAAW;IAEzC,mCAAmC;aACnB,WAAW,EAAE,WAAW;IACxC,sCAAsC;aACtB,cAAc,EAAE,MAAM;;IAHtC,mCAAmC;IACnB,WAAW,EAAE,WAAW;IACxC,sCAAsC;IACtB,cAAc,EAAE,MAAM,EACtC,GAAG,EAAE,qBAAqB,GAAG,gCAAgC;CAIhE;AAED;;;GAGG;AACH,oBAAY,SAAS;IACnB,gCAAgC;IAChC,IAAI,IAAI;IACR,mJAAmJ;IACnJ,MAAM,IAAI;IACV;;OAEG;IACH,SAAS,IAAI;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,+BAA+B;IAC/B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B,6EAA6E;IAC7E,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,iFAAiF;IACjF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,iGAAiG;IACjG,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC;IACxB,qBAAqB;IACrB,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,6GAA6G;IAC7G,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,QAAQ;IAC3C,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,WAAW;IAC3D,kIAAkI;IAClI,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,iEAAiE;IACjE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ,EAAE,UAAU;IACzD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,YAAY,EAAE,mBAAmB;IAC7E,0DAA0D;IAC1D,SAAS,EAAE,YAAY,CAAC;CACzB;AAED,gBAAgB;AAChB,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,uFAAuF;IACvF,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB,EAAE,mBAAmB;IACvF,2DAA2D;IAC3D,SAAS,EAAE,YAAY,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,0DAA0D;IAC1D,kBAAkB,EAAE,CAAC,GAAG,EAAE,yBAAyB,KAAK,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACtF,mCAAmC;IACnC,iBAAiB,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC9E,6DAA6D;IAC7D,cAAc,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAC/D,gFAAgF;IAChF,eAAe,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACvE,gFAAgF;IAChF,aAAa,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,cAAc,EAAE,kBAAkB,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACtG,0DAA0D;IAC1D,kBAAkB,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAClE,kDAAkD;IAClD,uBAAuB,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,OAAO,EAAE,aAAa,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACpG,iDAAiD;IACjD,4BAA4B,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAEtG;;SAEK;IACL,qBAAqB,EAAE,CAAC,GAAG,EAAE,wBAAwB,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/E,gHAAgH;IAChH,gBAAgB,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD,yDAAyD;IACzD,iBAAiB,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAEhE,8FAA8F;IAC9F,iBAAiB,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC,CAAC;IAE1F;;;OAGG;IACH,YAAY,EAAE,CAAC,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtE,uHAAuH;IACvH,aAAa,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAE7D,uCAAuC;IACvC,eAAe,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;;;;;;;;;;;;OAcG;IACH,eAAe,CAAC,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD,4FAA4F;IAC5F,iBAAiB,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAE3E,wEAAwE;IACxE,eAAe,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;IAEpE,uBAAuB;IACvB,YAAY,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAChE"}

package/lib/esm/BackendHubAccess.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackendHubAccess.js","sourceRoot":"","sources":["../../src/BackendHubAccess.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAuC,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAEyB,WAAW,GAE1C,MAAM,oBAAoB,CAAC;AAI5B;;EAEE;AACF,MAAM,OAAO,YAAa,SAAQ,WAAW;IAGzB;IAEA;IAJlB;IACE,mCAAmC;IACnB,WAAwB;IACxC,sCAAsC;IACtB,cAAsB,EACtC,GAA6D;QAE7D,KAAK,CAAC,eAAe,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAC;QALxC,gBAAW,GAAX,WAAW,CAAa;QAExB,mBAAc,GAAd,cAAc,CAAQ;IAIxC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,SASX;AATD,WAAY,SAAS;IACnB,gCAAgC;IAChC,yCAAQ,CAAA;IACR,mJAAmJ;IACnJ,6CAAU,CAAA;IACV;;OAEG;IACH,mDAAa,CAAA;AACf,CAAC,EATW,SAAS,KAAT,SAAS,QASpB","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 HubAccess\r\n */\r\n\r\nimport { AccessToken, GuidString, Id64String, IModelHubStatus } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseId, ChangesetFileProps, ChangesetIdWithIndex, ChangesetIndex, ChangesetIndexOrId, ChangesetProps, ChangesetRange,\r\n  LockState as CommonLockState, IModelError, IModelVersion,\r\n  LocalDirName, LocalFileName,\r\n} from \"@itwin/core-common\";\r\nimport { CheckpointProps, ProgressFunction } from \"./CheckpointManager\";\r\nimport type { TokenArg } from \"./IModelDb\";\r\n\r\n/** Exception thrown if lock cannot be acquired.\r\n * @beta\r\n*/\r\nexport class LockConflict extends IModelError {\r\n  public constructor(\r\n    /** Id of Briefcase holding lock */\r\n    public readonly briefcaseId: BriefcaseId,\r\n    /** Alias of Briefcase holding lock */\r\n    public readonly briefcaseAlias: string,\r\n    msg: \"shared lock is held\" | \"exclusive lock is already held\",\r\n  ) {\r\n    super(IModelHubStatus.LockOwnedByAnotherBriefcase, msg);\r\n  }\r\n}\r\n\r\n/** The state of a lock. See [Acquiring locks on elements.]($docs/learning/backend/ConcurrencyControl.md#acquiring-locks-on-elements).\r\n * @deprecated in 4.7 - will not be removed until after 2026-06-13. Use [LockState]($common)\r\n * @public\r\n */\r\nexport enum LockState {\r\n  /** The element is not locked */\r\n  None = 0,\r\n  /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */\r\n  Shared = 1,\r\n  /** A Lock that permits modifications to an element and blocks other users from making modifications to it.\r\n   * Holding an exclusive lock on an \"owner\" (a model or a parent element), implicitly exclusively locks all its members.\r\n   */\r\n  Exclusive = 2,\r\n}\r\n\r\n/**\r\n * The properties to access a V2 checkpoint through a daemon.\r\n * @public\r\n */\r\nexport interface V2CheckpointAccessProps {\r\n  /** blob store account name. */\r\n  readonly accountName: string;\r\n  /** AccessToken that grants access to the container. */\r\n  readonly sasToken: AccessToken;\r\n  /** The name of the iModel's blob store container holding all checkpoints. */\r\n  readonly containerId: string;\r\n  /** The name of the virtual file within the container, used for the checkpoint */\r\n  readonly dbName: string;\r\n  /** blob storage module: e.g. \"azure\", \"google\", \"aws\". May also include URI style parameters. */\r\n  readonly storageType: string;\r\n}\r\n\r\n/**\r\n * Maps element Ids to their corresponding [LockState]($common)s.\r\n * @public\r\n */\r\nexport type LockMap = Map<Id64String, CommonLockState>;\r\n\r\n/**\r\n * The properties of a lock that may be obtained from a lock server.\r\n * @public\r\n */\r\nexport interface LockProps {\r\n  /** The elementId for the lock */\r\n  readonly id: Id64String;\r\n  /** the lock state */\r\n  readonly state: CommonLockState;\r\n}\r\n\r\n/**\r\n * Argument for cancelling and tracking download progress.\r\n * @public\r\n */\r\nexport interface DownloadProgressArg {\r\n  /** Called to show progress during a download. If this function returns non-zero, the download is aborted. */\r\n  progressCallback?: ProgressFunction;\r\n}\r\n\r\n/**\r\n * Argument for methods that must supply an iTwinId\r\n * @public\r\n */\r\nexport interface ITwinIdArg {\r\n  readonly iTwinId: GuidString;\r\n}\r\n\r\n/**\r\n * Argument for methods that must supply an IModelId\r\n * @public\r\n */\r\nexport interface IModelIdArg extends TokenArg {\r\n  readonly iModelId: GuidString;\r\n}\r\n\r\n/**\r\n * Argument for acquiring a new BriefcaseId\r\n * @public\r\n */\r\nexport interface AcquireNewBriefcaseIdArg extends IModelIdArg {\r\n  /** A string to be reported to other users to identify this briefcase, for example in the case of conflicts or lock collisions. */\r\n  readonly briefcaseAlias?: string;\r\n  /** A string to represent the device that holds the briefcase. */\r\n  readonly deviceName?: string;\r\n}\r\n\r\n/** Argument for methods that must supply an IModel name and iTwinId\r\n * @public\r\n */\r\nexport interface IModelNameArg extends TokenArg, ITwinIdArg {\r\n  readonly iModelName: string;\r\n}\r\n\r\n/** Argument for methods that must supply an IModelId and a BriefcaseId\r\n * @public\r\n */\r\nexport interface BriefcaseIdArg extends IModelIdArg {\r\n  readonly briefcaseId: BriefcaseId;\r\n}\r\n\r\n/** Argument for methods that must supply a briefcaseId and a changeset\r\n * @public\r\n */\r\nexport interface BriefcaseDbArg extends BriefcaseIdArg {\r\n  readonly changeset: ChangesetIdWithIndex;\r\n}\r\n\r\n/** Argument for methods that must supply an IModelId and a changeset\r\n * @public\r\n */\r\nexport interface ChangesetArg extends IModelIdArg {\r\n  readonly changeset: ChangesetIndexOrId;\r\n}\r\n\r\n/** Argument for downloading a changeset.\r\n * @public\r\n */\r\nexport interface DownloadChangesetArg extends ChangesetArg, DownloadProgressArg {\r\n  /** Directory where the changeset should be downloaded. */\r\n  targetDir: LocalDirName;\r\n}\r\n\r\n/** @internal */\r\nexport interface ChangesetIndexArg extends IModelIdArg {\r\n  readonly changeset: ChangesetIdWithIndex;\r\n}\r\n\r\n/** Argument for methods that must supply an IModelId and a range of Changesets.\r\n * @public\r\n */\r\nexport interface ChangesetRangeArg extends IModelIdArg {\r\n  /** the range of changesets desired. If is undefined, *all* changesets are returned. */\r\n  readonly range?: ChangesetRange;\r\n}\r\n\r\n/** Argument for downloading a changeset range.\r\n * @public\r\n */\r\nexport interface DownloadChangesetRangeArg extends ChangesetRangeArg, DownloadProgressArg {\r\n  /** Directory where the changesets should be downloaded. */\r\n  targetDir: LocalDirName;\r\n}\r\n\r\n/**\r\n * Arguments to create a new iModel in iModelHub\r\n *  @public\r\n */\r\nexport interface CreateNewIModelProps extends IModelNameArg {\r\n  readonly description?: string;\r\n  readonly version0?: LocalFileName;\r\n  readonly noLocks?: true;\r\n}\r\n\r\n/**\r\n * Methods for accessing services of IModelHub from an iTwin.js backend.\r\n * Generally direct access to these methods should not be required, since higher-level apis are provided.\r\n * @public\r\n */\r\nexport interface BackendHubAccess {\r\n  /** Download all the changesets in the specified range. */\r\n  downloadChangesets: (arg: DownloadChangesetRangeArg) => Promise<ChangesetFileProps[]>;\r\n  /** Download a single changeset. */\r\n  downloadChangeset: (arg: DownloadChangesetArg) => Promise<ChangesetFileProps>;\r\n  /** Query the changeset properties given a ChangesetIndex  */\r\n  queryChangeset: (arg: ChangesetArg) => Promise<ChangesetProps>;\r\n  /** Query an array of changeset properties given a range of ChangesetIndexes  */\r\n  queryChangesets: (arg: ChangesetRangeArg) => Promise<ChangesetProps[]>;\r\n  /** Push a changeset to iModelHub. Returns the newly pushed changeset's index */\r\n  pushChangeset: (arg: IModelIdArg & { changesetProps: ChangesetFileProps }) => Promise<ChangesetIndex>;\r\n  /** Get the ChangesetProps of the most recent changeset */\r\n  getLatestChangeset: (arg: IModelIdArg) => Promise<ChangesetProps>;\r\n  /** Get the ChangesetProps for an IModelVersion */\r\n  getChangesetFromVersion: (arg: IModelIdArg & { version: IModelVersion }) => Promise<ChangesetProps>;\r\n  /** Get the ChangesetProps for a named version */\r\n  getChangesetFromNamedVersion: (arg: IModelIdArg & { versionName: string }) => Promise<ChangesetProps>;\r\n\r\n  /** Acquire a new briefcaseId for the supplied iModelId\r\n     * @note usually there should only be one briefcase per iModel per user.\r\n     */\r\n  acquireNewBriefcaseId: (arg: AcquireNewBriefcaseIdArg) => Promise<BriefcaseId>;\r\n  /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */\r\n  releaseBriefcase: (arg: BriefcaseIdArg) => Promise<void>;\r\n\r\n  /** get an array of the briefcases assigned to a user. */\r\n  getMyBriefcaseIds: (arg: IModelIdArg) => Promise<BriefcaseId[]>;\r\n\r\n  /** Get the access props for a V2 checkpoint. Returns undefined if no V2 checkpoint exists. */\r\n  queryV2Checkpoint: (arg: CheckpointProps) => Promise<V2CheckpointAccessProps | undefined>;\r\n\r\n  /**\r\n   * acquire one or more locks. Throws if unsuccessful. If *any* lock cannot be obtained, no locks are acquired\r\n   * @throws ConflictingLocksError if one or more requested locks are held by other briefcases.\r\n   */\r\n  acquireLocks: (arg: BriefcaseDbArg, locks: LockMap) => Promise<void>;\r\n\r\n  /** Get the list of all held locks for a briefcase. This can be very expensive and is currently used only for tests. */\r\n  queryAllLocks: (arg: BriefcaseDbArg) => Promise<LockProps[]>;\r\n\r\n  /** Release all currently held locks */\r\n  releaseAllLocks: (arg: BriefcaseDbArg) => Promise<void>;\r\n\r\n  /** Get the iModelId of an iModel by name. Undefined if no iModel with that name exists.  */\r\n  queryIModelByName: (arg: IModelNameArg) => Promise<GuidString | undefined>;\r\n\r\n  /** create a new iModel. Returns the Guid of the newly created iModel */\r\n  createNewIModel: (arg: CreateNewIModelProps) => Promise<GuidString>;\r\n\r\n  /** delete an iModel */\r\n  deleteIModel: (arg: IModelIdArg & ITwinIdArg) => Promise<void>;\r\n}\r\n"]}
+{"version":3,"file":"BackendHubAccess.js","sourceRoot":"","sources":["../../src/BackendHubAccess.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAuC,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAEyB,WAAW,GAE1C,MAAM,oBAAoB,CAAC;AAI5B;;EAEE;AACF,MAAM,OAAO,YAAa,SAAQ,WAAW;IAGzB;IAEA;IAJlB;IACE,mCAAmC;IACnB,WAAwB;IACxC,sCAAsC;IACtB,cAAsB,EACtC,GAA6D;QAE7D,KAAK,CAAC,eAAe,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAC;QALxC,gBAAW,GAAX,WAAW,CAAa;QAExB,mBAAc,GAAd,cAAc,CAAQ;IAIxC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,SASX;AATD,WAAY,SAAS;IACnB,gCAAgC;IAChC,yCAAQ,CAAA;IACR,mJAAmJ;IACnJ,6CAAU,CAAA;IACV;;OAEG;IACH,mDAAa,CAAA;AACf,CAAC,EATW,SAAS,KAAT,SAAS,QASpB","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 HubAccess\n */\n\nimport { AccessToken, GuidString, Id64String, IModelHubStatus } from \"@itwin/core-bentley\";\nimport {\n  BriefcaseId, ChangesetFileProps, ChangesetIdWithIndex, ChangesetIndex, ChangesetIndexOrId, ChangesetProps, ChangesetRange,\n  LockState as CommonLockState, IModelError, IModelVersion,\n  LocalDirName, LocalFileName,\n} from \"@itwin/core-common\";\nimport { CheckpointProps, ProgressFunction } from \"./CheckpointManager\";\nimport type { TokenArg } from \"./IModelDb\";\n\n/** Exception thrown if lock cannot be acquired.\n * @beta\n*/\nexport class LockConflict extends IModelError {\n  public constructor(\n    /** Id of Briefcase holding lock */\n    public readonly briefcaseId: BriefcaseId,\n    /** Alias of Briefcase holding lock */\n    public readonly briefcaseAlias: string,\n    msg: \"shared lock is held\" | \"exclusive lock is already held\",\n  ) {\n    super(IModelHubStatus.LockOwnedByAnotherBriefcase, msg);\n  }\n}\n\n/** The state of a lock. See [Acquiring locks on elements.]($docs/learning/backend/ConcurrencyControl.md#acquiring-locks-on-elements).\n * @deprecated in 4.7 - will not be removed until after 2026-06-13. Use [LockState]($common)\n * @public\n */\nexport enum LockState {\n  /** The element is not locked */\n  None = 0,\n  /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */\n  Shared = 1,\n  /** A Lock that permits modifications to an element and blocks other users from making modifications to it.\n   * Holding an exclusive lock on an \"owner\" (a model or a parent element), implicitly exclusively locks all its members.\n   */\n  Exclusive = 2,\n}\n\n/**\n * The properties to access a V2 checkpoint through a daemon.\n * @public\n */\nexport interface V2CheckpointAccessProps {\n  /** blob store account name. */\n  readonly accountName: string;\n  /** AccessToken that grants access to the container. */\n  readonly sasToken: AccessToken;\n  /** The name of the iModel's blob store container holding all checkpoints. */\n  readonly containerId: string;\n  /** The name of the virtual file within the container, used for the checkpoint */\n  readonly dbName: string;\n  /** blob storage module: e.g. \"azure\", \"google\", \"aws\". May also include URI style parameters. */\n  readonly storageType: string;\n}\n\n/**\n * Maps element Ids to their corresponding [LockState]($common)s.\n * @public\n */\nexport type LockMap = Map<Id64String, CommonLockState>;\n\n/**\n * The properties of a lock that may be obtained from a lock server.\n * @public\n */\nexport interface LockProps {\n  /** The elementId for the lock */\n  readonly id: Id64String;\n  /** the lock state */\n  readonly state: CommonLockState;\n}\n\n/**\n * Argument for cancelling and tracking download progress.\n * @public\n */\nexport interface DownloadProgressArg {\n  /** Called to show progress during a download. If this function returns non-zero, the download is aborted. */\n  progressCallback?: ProgressFunction;\n}\n\n/**\n * Argument for methods that must supply an iTwinId\n * @public\n */\nexport interface ITwinIdArg {\n  readonly iTwinId: GuidString;\n}\n\n/**\n * Argument for methods that must supply an IModelId\n * @public\n */\nexport interface IModelIdArg extends TokenArg {\n  readonly iModelId: GuidString;\n}\n\n/**\n * Argument for acquiring a new BriefcaseId\n * @public\n */\nexport interface AcquireNewBriefcaseIdArg extends IModelIdArg {\n  /** A string to be reported to other users to identify this briefcase, for example in the case of conflicts or lock collisions. */\n  readonly briefcaseAlias?: string;\n  /** A string to represent the device that holds the briefcase. */\n  readonly deviceName?: string;\n}\n\n/** Argument for methods that must supply an IModel name and iTwinId\n * @public\n */\nexport interface IModelNameArg extends TokenArg, ITwinIdArg {\n  readonly iModelName: string;\n}\n\n/** Argument for methods that must supply an IModelId and a BriefcaseId\n * @public\n */\nexport interface BriefcaseIdArg extends IModelIdArg {\n  readonly briefcaseId: BriefcaseId;\n}\n\n/** Argument for methods that must supply a briefcaseId and a changeset\n * @public\n */\nexport interface BriefcaseDbArg extends BriefcaseIdArg {\n  readonly changeset: ChangesetIdWithIndex;\n}\n\n/** Argument for methods that must supply an IModelId and a changeset\n * @public\n */\nexport interface ChangesetArg extends IModelIdArg {\n  readonly changeset: ChangesetIndexOrId;\n}\n\n/** Argument for downloading a changeset.\n * @public\n */\nexport interface DownloadChangesetArg extends ChangesetArg, DownloadProgressArg {\n  /** Directory where the changeset should be downloaded. */\n  targetDir: LocalDirName;\n}\n\n/** @internal */\nexport interface ChangesetIndexArg extends IModelIdArg {\n  readonly changeset: ChangesetIdWithIndex;\n}\n\n/** Argument for methods that must supply an IModelId and a range of Changesets.\n * @public\n */\nexport interface ChangesetRangeArg extends IModelIdArg {\n  /** the range of changesets desired. If is undefined, *all* changesets are returned. */\n  readonly range?: ChangesetRange;\n}\n\n/** Argument for downloading a changeset range.\n * @public\n */\nexport interface DownloadChangesetRangeArg extends ChangesetRangeArg, DownloadProgressArg {\n  /** Directory where the changesets should be downloaded. */\n  targetDir: LocalDirName;\n}\n\n/**\n * Arguments to create a new iModel in iModelHub\n *  @public\n */\nexport interface CreateNewIModelProps extends IModelNameArg {\n  readonly description?: string;\n  readonly version0?: LocalFileName;\n  readonly noLocks?: true;\n}\n\n/**\n * Methods for accessing services of IModelHub from an iTwin.js backend.\n * Generally direct access to these methods should not be required, since higher-level apis are provided.\n * @public\n */\nexport interface BackendHubAccess {\n  /** Download all the changesets in the specified range. */\n  downloadChangesets: (arg: DownloadChangesetRangeArg) => Promise<ChangesetFileProps[]>;\n  /** Download a single changeset. */\n  downloadChangeset: (arg: DownloadChangesetArg) => Promise<ChangesetFileProps>;\n  /** Query the changeset properties given a ChangesetIndex  */\n  queryChangeset: (arg: ChangesetArg) => Promise<ChangesetProps>;\n  /** Query an array of changeset properties given a range of ChangesetIndexes  */\n  queryChangesets: (arg: ChangesetRangeArg) => Promise<ChangesetProps[]>;\n  /** Push a changeset to iModelHub. Returns the newly pushed changeset's index */\n  pushChangeset: (arg: IModelIdArg & { changesetProps: ChangesetFileProps }) => Promise<ChangesetIndex>;\n  /** Get the ChangesetProps of the most recent changeset */\n  getLatestChangeset: (arg: IModelIdArg) => Promise<ChangesetProps>;\n  /** Get the ChangesetProps for an IModelVersion */\n  getChangesetFromVersion: (arg: IModelIdArg & { version: IModelVersion }) => Promise<ChangesetProps>;\n  /** Get the ChangesetProps for a named version */\n  getChangesetFromNamedVersion: (arg: IModelIdArg & { versionName: string }) => Promise<ChangesetProps>;\n\n  /** Acquire a new briefcaseId for the supplied iModelId\n     * @note usually there should only be one briefcase per iModel per user.\n     */\n  acquireNewBriefcaseId: (arg: AcquireNewBriefcaseIdArg) => Promise<BriefcaseId>;\n  /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */\n  releaseBriefcase: (arg: BriefcaseIdArg) => Promise<void>;\n\n  /** get an array of the briefcases assigned to a user. */\n  getMyBriefcaseIds: (arg: IModelIdArg) => Promise<BriefcaseId[]>;\n\n  /** Get the access props for a V2 checkpoint. Returns undefined if no V2 checkpoint exists. */\n  queryV2Checkpoint: (arg: CheckpointProps) => Promise<V2CheckpointAccessProps | undefined>;\n\n  /**\n   * acquire one or more locks. Throws if unsuccessful. If *any* lock cannot be obtained, no locks are acquired\n   * @throws ConflictingLocksError if one or more requested locks are held by other briefcases.\n   */\n  acquireLocks: (arg: BriefcaseDbArg, locks: LockMap) => Promise<void>;\n\n  /**\n   * Abandons the specified locks when none of the associated elements have\n   * been or will be modified. Depending on the {@link LockState} specified for the lock,\n   * it may be returned to the {@link LockState.Shared} state or released entirely. It is only\n   * valid to call this method when none of the elements protected by the locks have been edited, or if all edits\n   * have been reversed or abandoned without pushing them.\n   *\n   * The locks are released on the IModelHub, but the changeset associated with the locks is not updated.\n   *\n   * It is an error to specify {@link LockState.Exclusive} for any element, to specify {@link LockState.Shared}\n   * for an element where the Exclusive lock is not currently held, or to include any element for which no lock\n   * is currently held.\n   *\n   * This method is optional, so not all IModelHubs will implement it. If this method is not implemented\n   * explicitly by an IModelHub, it will be implemented implicitly by calling\n   * {@link BackendHubAccess.acquireLocks} with the same locks and passing `changeset.id=\"\"` and\n   * `changeset.index=0` in the first argument to indicate that the lock state should change without updating\n   * the changeset associated with the locks.\n   *\n   * @beta\n   */\n  abandonLocks?: (arg: BriefcaseIdArg, locks: LockMap) => Promise<void>;\n\n  /** Get the list of all held locks for a briefcase. This can be very expensive and is currently used only for tests. */\n  queryAllLocks: (arg: BriefcaseDbArg) => Promise<LockProps[]>;\n\n  /** Release all currently held locks */\n  releaseAllLocks: (arg: BriefcaseDbArg) => Promise<void>;\n\n  /**\n   * Abandons all currently held locks when none of the associated elements have been or will be modified.\n   * It is only valid to call this method when none of the elements protected by the locks have been edited,\n   * or if all edits have been reversed or abandoned without pushing them.\n   *\n   * The locks are released on the IModelHub, but the changeset associated with the locks is not updated.\n   *\n   * This method is optional, so not all IModelHubs will implement it. If this method is not implemented\n   * explicitly by an IModelHub, it will be implemented implicitly by calling\n   * {@link BackendHubAccess.releaseAllLocks}, passing `changeset.id=\"\"` and `changeset.index=0` in the\n   * first argument to indicate that the lock state should change without updating the changeset associated\n   * with the locks.\n   *\n   * @beta\n   */\n  abandonAllLocks?: (arg: BriefcaseIdArg) => Promise<void>;\n\n  /** Get the iModelId of an iModel by name. Undefined if no iModel with that name exists.  */\n  queryIModelByName: (arg: IModelNameArg) => Promise<GuidString | undefined>;\n\n  /** create a new iModel. Returns the Guid of the newly created iModel */\n  createNewIModel: (arg: CreateNewIModelProps) => Promise<GuidString>;\n\n  /** delete an iModel */\n  deleteIModel: (arg: IModelIdArg & ITwinIdArg) => Promise<void>;\n}\n"]}

package/lib/esm/BackendLoggerCategory.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackendLoggerCategory.js","sourceRoot":"","sources":["../../src/BackendLoggerCategory.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;;GAIG;AACH,MAAM,CAAN,IAAY,qBAsGX;AAtGD,WAAY,qBAAqB;IAC/B,+DAA+D;IAC/D,qEAA4C,CAAA;IAE5C;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;OAEG;IACH,2FAAkE,CAAA;IAElE;;OAEG;IACH,2DAAkC,CAAA;IAElC;;;;OAIG;IACH,mDAA0B,CAAA;IAE1B;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,6EAAoD,CAAA;IAEpD;;;OAGG;IACH,2DAAkC,CAAA;IAElC;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,mFAA0D,CAAA;IAE1D;;OAEG;IACH,2EAAkD,CAAA;IAElD;;OAEG;IACH,6EAAoD,CAAA;IAEpD;;OAEG;IACH,mEAA0C,CAAA;IAE1C;;OAEG;IACH,yDAAgC,CAAA;IAEhC;;OAEG;IACH,yEAAgD,CAAA;IAChD;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;;;OAIG;IACH,mEAA0C,CAAA;IAE1C;;;OAGG;IACH,6DAAoC,CAAA;IAEpC;;;OAGG;IACH,6EAAoD,CAAA;IAEpD,gBAAgB;IAChB,6DAAoC,CAAA;AACtC,CAAC,EAtGW,qBAAqB,KAArB,qBAAqB,QAsGhC","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 Logging\r\n */\r\n\r\n/** Logger categories used by this package\r\n * @note All logger categories in this package start with the `core-backend` prefix.\r\n * @see [Logger]($bentley)\r\n * @public\r\n */\r\nexport enum BackendLoggerCategory {\r\n  /** The logger category used by API related to authorization */\r\n  Authorization = \"core-backend.Authorization\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[CodeSpecs]]\r\n   */\r\n  CodeSpecs = \"core-backend.CodeSpecs\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[CustomViewState3dCreator]]\r\n   */\r\n  CustomViewState3dCreator = \"core-backend.CustomViewState3dCreator\",\r\n\r\n  /** The logger category used by the [[DevTools]] class and related classes.\r\n   * @internal\r\n   */\r\n  DevTools = \"core-backend.DevTools\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[ChangeSummaryManager]]\r\n   * - [[ECDb]]\r\n   * - [[ECSqlStatement]]\r\n   */\r\n  ECDb = \"core-backend.ECDb\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Functional]]\r\n   */\r\n  Functional = \"core-backend.Functional\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[LinearReferencing]]\r\n   */\r\n  LinearReferencing = \"core-backend.LinearReferencing\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - BriefcaseManager\r\n   * - [[IModelDb]]\r\n   */\r\n  IModelDb = \"core-backend.IModelDb\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[IModelHost]]\r\n   */\r\n  IModelHost = \"core-backend.IModelHost\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - TileRequestMemoizer\r\n   */\r\n  IModelTileRequestRpc = \"core-backend.IModelTileRequestRpc\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - IModelTileRpcImpl (Tile Uploading)\r\n   */\r\n  IModelTileUpload = \"core-backend.IModelTileUpload\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - TileStorage (tile upload/download)\r\n   */\r\n  IModelTileStorage = \"core-backend.IModelTileStorage\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Relationship]]\r\n   */\r\n  Relationship = \"core-backend.Relationship\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Schemas]]\r\n   */\r\n  Schemas = \"core-backend.Schemas\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[PromiseMemoizer]]\r\n   */\r\n  PromiseMemoizer = \"core-backend.PromiseMemoizer\",\r\n  /** The logger category used by the following classes:\r\n   * - [[EventSink]]\r\n   */\r\n  EventSink = \"core-backend.EventSink\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[StashManager]]\r\n   * - [[StashError]]\r\n   * @internal\r\n   */\r\n  StashManager = \"core-backend.StashManager\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[NativeHost]], [[NativeAppStorage]]\r\n   * @internal\r\n   */\r\n  NativeApp = \"core-backend.NativeApp\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[ViewStateHydrator]]\r\n   * @internal\r\n   */\r\n  ViewStateHydrator = \"core-backend.ViewStateHydrator\",\r\n\r\n  /** @internal */\r\n  Workspace = \"core-backend.Workspace\",\r\n}\r\n"]}
+{"version":3,"file":"BackendLoggerCategory.js","sourceRoot":"","sources":["../../src/BackendLoggerCategory.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;;GAIG;AACH,MAAM,CAAN,IAAY,qBAsGX;AAtGD,WAAY,qBAAqB;IAC/B,+DAA+D;IAC/D,qEAA4C,CAAA;IAE5C;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;OAEG;IACH,2FAAkE,CAAA;IAElE;;OAEG;IACH,2DAAkC,CAAA;IAElC;;;;OAIG;IACH,mDAA0B,CAAA;IAE1B;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,6EAAoD,CAAA;IAEpD;;;OAGG;IACH,2DAAkC,CAAA;IAElC;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,mFAA0D,CAAA;IAE1D;;OAEG;IACH,2EAAkD,CAAA;IAElD;;OAEG;IACH,6EAAoD,CAAA;IAEpD;;OAEG;IACH,mEAA0C,CAAA;IAE1C;;OAEG;IACH,yDAAgC,CAAA;IAEhC;;OAEG;IACH,yEAAgD,CAAA;IAChD;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;;;OAIG;IACH,mEAA0C,CAAA;IAE1C;;;OAGG;IACH,6DAAoC,CAAA;IAEpC;;;OAGG;IACH,6EAAoD,CAAA;IAEpD,gBAAgB;IAChB,6DAAoC,CAAA;AACtC,CAAC,EAtGW,qBAAqB,KAArB,qBAAqB,QAsGhC","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 Logging\n */\n\n/** Logger categories used by this package\n * @note All logger categories in this package start with the `core-backend` prefix.\n * @see [Logger]($bentley)\n * @public\n */\nexport enum BackendLoggerCategory {\n  /** The logger category used by API related to authorization */\n  Authorization = \"core-backend.Authorization\",\n\n  /** The logger category used by the following classes:\n   * - [[CodeSpecs]]\n   */\n  CodeSpecs = \"core-backend.CodeSpecs\",\n\n  /** The logger category used by the following classes:\n   * - [[CustomViewState3dCreator]]\n   */\n  CustomViewState3dCreator = \"core-backend.CustomViewState3dCreator\",\n\n  /** The logger category used by the [[DevTools]] class and related classes.\n   * @internal\n   */\n  DevTools = \"core-backend.DevTools\",\n\n  /** The logger category used by the following classes:\n   * - [[ChangeSummaryManager]]\n   * - [[ECDb]]\n   * - [[ECSqlStatement]]\n   */\n  ECDb = \"core-backend.ECDb\",\n\n  /** The logger category used by the following classes:\n   * - [[Functional]]\n   */\n  Functional = \"core-backend.Functional\",\n\n  /** The logger category used by the following classes:\n   * - [[LinearReferencing]]\n   */\n  LinearReferencing = \"core-backend.LinearReferencing\",\n\n  /** The logger category used by the following classes:\n   * - BriefcaseManager\n   * - [[IModelDb]]\n   */\n  IModelDb = \"core-backend.IModelDb\",\n\n  /** The logger category used by the following classes:\n   * - [[IModelHost]]\n   */\n  IModelHost = \"core-backend.IModelHost\",\n\n  /** The logger category used by the following classes:\n   * - TileRequestMemoizer\n   */\n  IModelTileRequestRpc = \"core-backend.IModelTileRequestRpc\",\n\n  /** The logger category used by the following classes:\n   * - IModelTileRpcImpl (Tile Uploading)\n   */\n  IModelTileUpload = \"core-backend.IModelTileUpload\",\n\n  /** The logger category used by the following classes:\n   * - TileStorage (tile upload/download)\n   */\n  IModelTileStorage = \"core-backend.IModelTileStorage\",\n\n  /** The logger category used by the following classes:\n   * - [[Relationship]]\n   */\n  Relationship = \"core-backend.Relationship\",\n\n  /** The logger category used by the following classes:\n   * - [[Schemas]]\n   */\n  Schemas = \"core-backend.Schemas\",\n\n  /** The logger category used by the following classes:\n   * - [[PromiseMemoizer]]\n   */\n  PromiseMemoizer = \"core-backend.PromiseMemoizer\",\n  /** The logger category used by the following classes:\n   * - [[EventSink]]\n   */\n  EventSink = \"core-backend.EventSink\",\n\n  /** The logger category used by the following classes:\n   * - [[StashManager]]\n   * - [[StashError]]\n   * @internal\n   */\n  StashManager = \"core-backend.StashManager\",\n\n  /** The logger category used by the following classes:\n   * - [[NativeHost]], [[NativeAppStorage]]\n   * @internal\n   */\n  NativeApp = \"core-backend.NativeApp\",\n\n  /** The logger category used by the following classes:\n   * - [[ViewStateHydrator]]\n   * @internal\n   */\n  ViewStateHydrator = \"core-backend.ViewStateHydrator\",\n\n  /** @internal */\n  Workspace = \"core-backend.Workspace\",\n}\n"]}

package/lib/esm/BisCoreSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"BisCoreSchema.js","sourceRoot":"","sources":["../../src/BisCoreSchema.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,UAAU,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,iBAAiB,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,KAAK,UAAU,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,eAAe,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,cAAc,MAAM,qCAAqC,CAAC;AACtE,OAAO,KAAK,2BAA2B,MAAM,2CAA2C,CAAC;AACzF,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAE3C;;;;;;;;;;GAUG;AACH,MAAM,OAAO,aAAc,SAAQ,MAAM;IAChC,MAAM,KAAc,UAAU,KAAa,OAAO,SAAS,CAAC,CAAC,CAAC;IAC9D,MAAM,KAAK,cAAc,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,aAAa,CAAC,UAAU,eAAe,CAAC,CAAC,CAAC,CAAC;IAEhK,gBAAgB;IACT,MAAM,CAAC,cAAc;QAC1B,IAAI,IAAI,KAAK,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;YACvD,OAAO;QAET,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAE7B,sHAAsH;QACtH;YACE,UAAU;YACV,SAAS;YACT,QAAQ;YACR,WAAW;YACX,OAAO;YACP,OAAO;YACP,UAAU;YACV,WAAW;YACX,iBAAiB;YACjB,eAAe;YACf,cAAc;YACd,UAAU;YACV,2BAA2B;SAC5B,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,aAAa,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IACpE,CAAC;CACF","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 Schema\r\n */\r\n\r\nimport * as path from \"path\";\r\nimport * as categoryMod from \"./Category\";\r\nimport { ClassRegistry } from \"./ClassRegistry\";\r\nimport * as elementMod from \"./Element\";\r\nimport * as aspectMod from \"./ElementAspect\";\r\nimport * as externalSourceMod from \"./ExternalSource\";\r\nimport { KnownLocations } from \"./IModelHost\";\r\nimport * as materialMod from \"./Material\";\r\nimport * as modelMod from \"./Model\";\r\nimport * as linkMod from \"./Relationship\";\r\nimport { Schema, Schemas } from \"./Schema\";\r\nimport * as textureMod from \"./Texture\";\r\nimport * as viewMod from \"./ViewDefinition\";\r\nimport * as displayStyleMod from \"./DisplayStyle\";\r\nimport * as annotationsMod from \"./annotations/TextAnnotationElement\";\r\nimport * as elementDrivesTextAnnotation from \"./annotations/ElementDrivesTextAnnotation\";\r\nimport * as sheetIndex from \"./SheetIndex\";\r\n\r\n/**\r\n * The [BisCore]($docs/bis/guide/fundamentals/schemas-domains.md) schema is the lowest level Schema in an iModel.\r\n *\r\n * It is automatically registered when [[IModelHost.startup]] is called.\r\n *\r\n * Example:\r\n * ``` ts\r\n * [[include:BisCore.registerSchemaAndGetClass]]\r\n * ```\r\n * @public\r\n */\r\nexport class BisCoreSchema extends Schema {\r\n  public static override get schemaName(): string { return \"BisCore\"; }\r\n  public static get schemaFilePath(): string { return path.join(KnownLocations.nativeAssetsDir, \"ECSchemas\", \"Dgn\", `${BisCoreSchema.schemaName}.ecschema.xml`); }\r\n\r\n  /** @internal */\r\n  public static registerSchema() {\r\n    if (this === Schemas.getRegisteredSchema(this.schemaName))\r\n      return;\r\n\r\n    Schemas.unregisterSchema(this.schemaName);\r\n    Schemas.registerSchema(this);\r\n\r\n    // this list should include all backend .ts files with implementations of Entity-based classes. Order does not matter.\r\n    [\r\n      elementMod,\r\n      aspectMod,\r\n      modelMod,\r\n      categoryMod,\r\n      viewMod,\r\n      linkMod,\r\n      textureMod,\r\n      materialMod,\r\n      externalSourceMod,\r\n      displayStyleMod,\r\n      annotationsMod,\r\n      sheetIndex,\r\n      elementDrivesTextAnnotation,\r\n    ].forEach((module) => ClassRegistry.registerModule(module, this));\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BisCoreSchema.js","sourceRoot":"","sources":["../../src/BisCoreSchema.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,UAAU,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,iBAAiB,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,KAAK,UAAU,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,eAAe,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,cAAc,MAAM,qCAAqC,CAAC;AACtE,OAAO,KAAK,2BAA2B,MAAM,2CAA2C,CAAC;AACzF,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAE3C;;;;;;;;;;GAUG;AACH,MAAM,OAAO,aAAc,SAAQ,MAAM;IAChC,MAAM,KAAc,UAAU,KAAa,OAAO,SAAS,CAAC,CAAC,CAAC;IAC9D,MAAM,KAAK,cAAc,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,aAAa,CAAC,UAAU,eAAe,CAAC,CAAC,CAAC,CAAC;IAEhK,gBAAgB;IACT,MAAM,CAAC,cAAc;QAC1B,IAAI,IAAI,KAAK,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;YACvD,OAAO;QAET,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAE7B,sHAAsH;QACtH;YACE,UAAU;YACV,SAAS;YACT,QAAQ;YACR,WAAW;YACX,OAAO;YACP,OAAO;YACP,UAAU;YACV,WAAW;YACX,iBAAiB;YACjB,eAAe;YACf,cAAc;YACd,UAAU;YACV,2BAA2B;SAC5B,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,aAAa,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IACpE,CAAC;CACF","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 Schema\n */\n\nimport * as path from \"path\";\nimport * as categoryMod from \"./Category\";\nimport { ClassRegistry } from \"./ClassRegistry\";\nimport * as elementMod from \"./Element\";\nimport * as aspectMod from \"./ElementAspect\";\nimport * as externalSourceMod from \"./ExternalSource\";\nimport { KnownLocations } from \"./IModelHost\";\nimport * as materialMod from \"./Material\";\nimport * as modelMod from \"./Model\";\nimport * as linkMod from \"./Relationship\";\nimport { Schema, Schemas } from \"./Schema\";\nimport * as textureMod from \"./Texture\";\nimport * as viewMod from \"./ViewDefinition\";\nimport * as displayStyleMod from \"./DisplayStyle\";\nimport * as annotationsMod from \"./annotations/TextAnnotationElement\";\nimport * as elementDrivesTextAnnotation from \"./annotations/ElementDrivesTextAnnotation\";\nimport * as sheetIndex from \"./SheetIndex\";\n\n/**\n * The [BisCore]($docs/bis/guide/fundamentals/schemas-domains.md) schema is the lowest level Schema in an iModel.\n *\n * It is automatically registered when [[IModelHost.startup]] is called.\n *\n * Example:\n * ``` ts\n * [[include:BisCore.registerSchemaAndGetClass]]\n * ```\n * @public\n */\nexport class BisCoreSchema extends Schema {\n  public static override get schemaName(): string { return \"BisCore\"; }\n  public static get schemaFilePath(): string { return path.join(KnownLocations.nativeAssetsDir, \"ECSchemas\", \"Dgn\", `${BisCoreSchema.schemaName}.ecschema.xml`); }\n\n  /** @internal */\n  public static registerSchema() {\n    if (this === Schemas.getRegisteredSchema(this.schemaName))\n      return;\n\n    Schemas.unregisterSchema(this.schemaName);\n    Schemas.registerSchema(this);\n\n    // this list should include all backend .ts files with implementations of Entity-based classes. Order does not matter.\n    [\n      elementMod,\n      aspectMod,\n      modelMod,\n      categoryMod,\n      viewMod,\n      linkMod,\n      textureMod,\n      materialMod,\n      externalSourceMod,\n      displayStyleMod,\n      annotationsMod,\n      sheetIndex,\n      elementDrivesTextAnnotation,\n    ].forEach((module) => ClassRegistry.registerModule(module, this));\n  }\n}\n"]}

package/lib/esm/BlobContainerService.js.map

@@ -1 +1 @@
-{"version":3,"file":"BlobContainerService.js","sourceRoot":"","sources":["../../src/BlobContainerService.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;;GAGG;AACH,MAAM,KAAW,aAAa,CA2K7B;AA3KD,WAAiB,aAAa;AA2K9B,CAAC,EA3KgB,aAAa,KAAb,aAAa,QA2K7B","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 BlobContainers\r\n */\r\n\r\n// spell:ignore datacenter\r\n\r\nimport { AccessToken, GuidString, Id64String } from \"@itwin/core-bentley\";\r\nimport { SettingsContainer } from \"./workspace/Settings\";\r\n\r\n/**\r\n * Types and functions for creating, deleting and authorizing access to cloud-based blob containers for an iTwin.\r\n * @beta\r\n */\r\nexport namespace BlobContainer {\r\n\r\n  /** Object that implements the methods to create, delete, and request access to a container. */\r\n  export let service: BlobContainer.ContainerService | undefined;\r\n\r\n  /** name of cloud provider for a container. */\r\n  export type Provider = \"azure\" | \"google\";\r\n\r\n  /** the name of the container within its `Scope` */\r\n  export type ContainerId = string;\r\n\r\n  /** token that authenticates a user. This token is required to obtain a `ContainerToken`. */\r\n  export type UserToken = AccessToken;\r\n\r\n  /** token that authenticates access to a container for either read or write. */\r\n  export type ContainerToken = AccessToken;\r\n\r\n  /**\r\n   * The scope for a container. This determines:\r\n   *  - the \"owner\" organization, including the contract that governs its legal and commercial terms and obligations\r\n   *  - the administrators who may configure RBAC permissions\r\n   *  - the datacenter for the container. Every container resides in a datacenter as determined by the iTwinId. This\r\n   * determines the region for data residency requirements.\r\n   *  - the lifecycle constraints for the container. No container can outlive its iTwin or its iModel (if defined). That is,\r\n   * when the iTwin/iModel is deleted (either explicitly or due to contract expiration), the container is also deleted.\r\n   */\r\n  export interface Scope {\r\n    /** iTwinId of the owner of this container. */\r\n    iTwinId: Id64String;\r\n    /** optionally, an iModelId within the iTwin. If present, container is deleted when the iModel is deleted. */\r\n    iModelId?: Id64String;\r\n    /** the user GUID an individual, if this container is private. */\r\n    ownerGuid?: GuidString;\r\n  }\r\n\r\n  /**\r\n   * Metadata about the use of a container so that:\r\n   *  - administrators can understand why a container exists for assigning RBAC permissions appropriately\r\n   *  - usage reports can aggregate types of containers\r\n   *  - applications can identify their containers\r\n   *  - applications can store properties about their containers\r\n   */\r\n  export interface Metadata {\r\n    /** The machine-readable string that describes what the container is being used for (e.g. \"workspace\"). Always lowercase and singular. */\r\n    containerType: string;\r\n    /** Human-readable name for the container. This will be displayed in the administrator RBAC panel, and on usage reports. Not required to be unique.*/\r\n    label: string;\r\n    /** Optional human-readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */\r\n    description?: string;\r\n    /** optional properties for the container */\r\n    json?: SettingsContainer;\r\n  }\r\n\r\n  /**\r\n   * Properties returned by queryContainersMetadata\r\n   */\r\n  export interface MetadataResponse extends Metadata {\r\n    containerId: string;\r\n  }\r\n\r\n  /** Properties returned by `Service.requestToken` */\r\n  export interface TokenProps {\r\n    /**\r\n     * Expiring token that provides the requested access to the container. Should be used in all subsequent requests for blobs within the container,\r\n     * and must be refreshed before it expires\r\n     */\r\n    token: ContainerToken;\r\n    /** Scope of the container. */\r\n    scope: Scope;\r\n    /** Name of the blob storage provider. */\r\n    provider: Provider;\r\n    /** Time at which the token will expire. The token should be refreshed (that is, a new token should be requested) before this time. */\r\n    expiration: Date;\r\n    /** Metadata of the container. */\r\n    metadata: Metadata;\r\n    /** Base URI of the storage account that hosts the container */\r\n    baseUri: string;\r\n  }\r\n\r\n  /** The URI and Id of the container. */\r\n  export interface UriAndId {\r\n    baseUri: string;\r\n    containerId: ContainerId;\r\n  }\r\n\r\n  /** Information required to access an existing container. */\r\n  export interface AccessContainerProps extends UriAndId {\r\n    userToken: UserToken;\r\n  }\r\n\r\n  /** Information about a newly created container. */\r\n  export interface CreatedContainerProps extends UriAndId {\r\n    /** name of the blob storage provider. */\r\n    provider: Provider;\r\n  }\r\n\r\n  /**\r\n   * Access level to request for token.\r\n   * - `\"write\"`: request a writeable AccessToken.\r\n   * - `\"read\"`:  request a read-only AccessToken.\r\n   * - `\"admin\"`:  request a admin AccessToken.\r\n   * - `\"writeIfPossible\"`: first request a writeable AccessToken. If the user is not authorized for write, request a read-only AccessToken.\r\n   * If the user is not authorized for the level requested, an exception is thrown.\r\n   */\r\n  export type RequestAccessLevel = \"write\" | \"read\" | \"admin\" | \"writeIfPossible\";\r\n\r\n  /** Information required to request an access token for a container. */\r\n  export interface RequestTokenProps extends Omit<AccessContainerProps, \"baseUri\"> {\r\n    /** the level of access requested. If not specified, defaults to `\"writeIfPossible\"`. */\r\n    accessLevel?: RequestAccessLevel;\r\n    /** the number of seconds before the token should expire.\r\n     * @note A maximum duration is determined by the service. If no value is supplied, or the value is larger than the maximum, the maximum duration is used.\r\n     */\r\n    durationSeconds?: number;\r\n  }\r\n\r\n  /** Information required to create a new container. */\r\n  export interface CreateNewContainerProps {\r\n    /** the scope of the new container */\r\n    scope: Scope;\r\n    /** metadata to be stored on the new container */\r\n    metadata: Metadata;\r\n    /** The user's access token. The user must be authorized with \"create container\" RBAC role for the iTwin. */\r\n    userToken: UserToken;\r\n    /**\r\n     * the id for the container. Useful for tests.\r\n     * @internal\r\n     */\r\n    containerId?: ContainerId;\r\n  }\r\n\r\n  /**\r\n   * Query Parameters for querying containers\r\n   */\r\n  export interface QueryContainerProps {\r\n    /** the iTwinId of the containers to query */\r\n    iTwinId: GuidString;\r\n    /** optional iModelId of the containers to query */\r\n    iModelId?: GuidString;\r\n    /** optional containerType of the containers to query */\r\n    containerType?: GuidString;\r\n    /** optional label of the containers to query */\r\n    label?: GuidString;\r\n  }\r\n\r\n  /** Methods to create, delete, and access blob containers. */\r\n  export interface ContainerService {\r\n    /**  Create a new blob container. Throws on failure (e.g. access denied or container already exists.) */\r\n    create(props: CreateNewContainerProps): Promise<CreatedContainerProps>;\r\n\r\n    /**\r\n     * Delete an existing blob container.\r\n     * @note This method requires that the user be authorized with \"delete container\" RBAC role for the iTwin.\r\n     */\r\n    delete(container: AccessContainerProps): Promise<void>;\r\n\r\n    /** query the Scope for a container */\r\n    queryScope(container: AccessContainerProps): Promise<Scope>;\r\n\r\n    /** query the Metadata for a specific container */\r\n    queryMetadata(container: AccessContainerProps): Promise<Metadata>;\r\n\r\n    /** Returns all containers and their metadata associated with a given iTwinId. Can be further queried by label and containerType. */\r\n    queryContainersMetadata(userToken: UserToken, args: QueryContainerProps): Promise<MetadataResponse[]>;\r\n\r\n    /** update the json properties of this container */\r\n    updateJson(container: AccessContainerProps, json: SettingsContainer): Promise<void>;\r\n\r\n    /** Request a `ContainerToken` for a container. Throws on failure. */\r\n    requestToken(props: RequestTokenProps): Promise<TokenProps>;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BlobContainerService.js","sourceRoot":"","sources":["../../src/BlobContainerService.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;;GAGG;AACH,MAAM,KAAW,aAAa,CA2K7B;AA3KD,WAAiB,aAAa;AA2K9B,CAAC,EA3KgB,aAAa,KAAb,aAAa,QA2K7B","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 BlobContainers\n */\n\n// spell:ignore datacenter\n\nimport { AccessToken, GuidString, Id64String } from \"@itwin/core-bentley\";\nimport { SettingsContainer } from \"./workspace/Settings\";\n\n/**\n * Types and functions for creating, deleting and authorizing access to cloud-based blob containers for an iTwin.\n * @beta\n */\nexport namespace BlobContainer {\n\n  /** Object that implements the methods to create, delete, and request access to a container. */\n  export let service: BlobContainer.ContainerService | undefined;\n\n  /** name of cloud provider for a container. */\n  export type Provider = \"azure\" | \"google\";\n\n  /** the name of the container within its `Scope` */\n  export type ContainerId = string;\n\n  /** token that authenticates a user. This token is required to obtain a `ContainerToken`. */\n  export type UserToken = AccessToken;\n\n  /** token that authenticates access to a container for either read or write. */\n  export type ContainerToken = AccessToken;\n\n  /**\n   * The scope for a container. This determines:\n   *  - the \"owner\" organization, including the contract that governs its legal and commercial terms and obligations\n   *  - the administrators who may configure RBAC permissions\n   *  - the datacenter for the container. Every container resides in a datacenter as determined by the iTwinId. This\n   * determines the region for data residency requirements.\n   *  - the lifecycle constraints for the container. No container can outlive its iTwin or its iModel (if defined). That is,\n   * when the iTwin/iModel is deleted (either explicitly or due to contract expiration), the container is also deleted.\n   */\n  export interface Scope {\n    /** iTwinId of the owner of this container. */\n    iTwinId: Id64String;\n    /** optionally, an iModelId within the iTwin. If present, container is deleted when the iModel is deleted. */\n    iModelId?: Id64String;\n    /** the user GUID an individual, if this container is private. */\n    ownerGuid?: GuidString;\n  }\n\n  /**\n   * Metadata about the use of a container so that:\n   *  - administrators can understand why a container exists for assigning RBAC permissions appropriately\n   *  - usage reports can aggregate types of containers\n   *  - applications can identify their containers\n   *  - applications can store properties about their containers\n   */\n  export interface Metadata {\n    /** The machine-readable string that describes what the container is being used for (e.g. \"workspace\"). Always lowercase and singular. */\n    containerType: string;\n    /** Human-readable name for the container. This will be displayed in the administrator RBAC panel, and on usage reports. Not required to be unique.*/\n    label: string;\n    /** Optional human-readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */\n    description?: string;\n    /** optional properties for the container */\n    json?: SettingsContainer;\n  }\n\n  /**\n   * Properties returned by queryContainersMetadata\n   */\n  export interface MetadataResponse extends Metadata {\n    containerId: string;\n  }\n\n  /** Properties returned by `Service.requestToken` */\n  export interface TokenProps {\n    /**\n     * Expiring token that provides the requested access to the container. Should be used in all subsequent requests for blobs within the container,\n     * and must be refreshed before it expires\n     */\n    token: ContainerToken;\n    /** Scope of the container. */\n    scope: Scope;\n    /** Name of the blob storage provider. */\n    provider: Provider;\n    /** Time at which the token will expire. The token should be refreshed (that is, a new token should be requested) before this time. */\n    expiration: Date;\n    /** Metadata of the container. */\n    metadata: Metadata;\n    /** Base URI of the storage account that hosts the container */\n    baseUri: string;\n  }\n\n  /** The URI and Id of the container. */\n  export interface UriAndId {\n    baseUri: string;\n    containerId: ContainerId;\n  }\n\n  /** Information required to access an existing container. */\n  export interface AccessContainerProps extends UriAndId {\n    userToken: UserToken;\n  }\n\n  /** Information about a newly created container. */\n  export interface CreatedContainerProps extends UriAndId {\n    /** name of the blob storage provider. */\n    provider: Provider;\n  }\n\n  /**\n   * Access level to request for token.\n   * - `\"write\"`: request a writeable AccessToken.\n   * - `\"read\"`:  request a read-only AccessToken.\n   * - `\"admin\"`:  request a admin AccessToken.\n   * - `\"writeIfPossible\"`: first request a writeable AccessToken. If the user is not authorized for write, request a read-only AccessToken.\n   * If the user is not authorized for the level requested, an exception is thrown.\n   */\n  export type RequestAccessLevel = \"write\" | \"read\" | \"admin\" | \"writeIfPossible\";\n\n  /** Information required to request an access token for a container. */\n  export interface RequestTokenProps extends Omit<AccessContainerProps, \"baseUri\"> {\n    /** the level of access requested. If not specified, defaults to `\"writeIfPossible\"`. */\n    accessLevel?: RequestAccessLevel;\n    /** the number of seconds before the token should expire.\n     * @note A maximum duration is determined by the service. If no value is supplied, or the value is larger than the maximum, the maximum duration is used.\n     */\n    durationSeconds?: number;\n  }\n\n  /** Information required to create a new container. */\n  export interface CreateNewContainerProps {\n    /** the scope of the new container */\n    scope: Scope;\n    /** metadata to be stored on the new container */\n    metadata: Metadata;\n    /** The user's access token. The user must be authorized with \"create container\" RBAC role for the iTwin. */\n    userToken: UserToken;\n    /**\n     * the id for the container. Useful for tests.\n     * @internal\n     */\n    containerId?: ContainerId;\n  }\n\n  /**\n   * Query Parameters for querying containers\n   */\n  export interface QueryContainerProps {\n    /** the iTwinId of the containers to query */\n    iTwinId: GuidString;\n    /** optional iModelId of the containers to query */\n    iModelId?: GuidString;\n    /** optional containerType of the containers to query */\n    containerType?: GuidString;\n    /** optional label of the containers to query */\n    label?: GuidString;\n  }\n\n  /** Methods to create, delete, and access blob containers. */\n  export interface ContainerService {\n    /**  Create a new blob container. Throws on failure (e.g. access denied or container already exists.) */\n    create(props: CreateNewContainerProps): Promise<CreatedContainerProps>;\n\n    /**\n     * Delete an existing blob container.\n     * @note This method requires that the user be authorized with \"delete container\" RBAC role for the iTwin.\n     */\n    delete(container: AccessContainerProps): Promise<void>;\n\n    /** query the Scope for a container */\n    queryScope(container: AccessContainerProps): Promise<Scope>;\n\n    /** query the Metadata for a specific container */\n    queryMetadata(container: AccessContainerProps): Promise<Metadata>;\n\n    /** Returns all containers and their metadata associated with a given iTwinId. Can be further queried by label and containerType. */\n    queryContainersMetadata(userToken: UserToken, args: QueryContainerProps): Promise<MetadataResponse[]>;\n\n    /** update the json properties of this container */\n    updateJson(container: AccessContainerProps, json: SettingsContainer): Promise<void>;\n\n    /** Request a `ContainerToken` for a container. Throws on failure. */\n    requestToken(props: RequestTokenProps): Promise<TokenProps>;\n  }\n}\n"]}

package/lib/esm/BriefcaseManager.js

@@ -559,7 +559,7 @@ export class BriefcaseManager {
                 if (err instanceof Error) {
                     Logger.logError(loggerCategory, `Error applying changeset with id ${stopwatch.description}: ${err.message}`);
                 }
-                db.abandonChanges();
+                db[_nativeDb].abandonChanges();
                 throw err;
             }
         }
@@ -609,7 +609,7 @@ export class BriefcaseManager {
         this.dropRestorePoint(db, name);
         const stash = await StashManager.stash({ db, description: this.makeRestorePointKey(name) });
         db[_nativeDb].saveLocalValue(this.makeRestorePointKey(name), stash.id);
-        db.saveChanges("Create restore point");
+        db[_nativeDb].saveChanges("Create restore point");
         Logger.logTrace(loggerCategory, `Created restore point ${name}`, () => stash);
         return stash;
     }
@@ -626,7 +626,7 @@ export class BriefcaseManager {
         if (restorePointId) {
             StashManager.dropStash({ db, stash: restorePointId });
             db[_nativeDb].deleteLocalValue(this.makeRestorePointKey(name));
-            db.saveChanges("Drop restore point");
+            db[_nativeDb].saveChanges("Drop restore point");
             Logger.logTrace(loggerCategory, `Dropped restore point ${name}`);
         }
     }