@itwin/core-backend 5.9.0-dev.1 → 5.9.0-dev.11

package/lib/esm/IModelDbFonts.js.map

@@ -1 +1 @@
-{"version":3,"file":"IModelDbFonts.js","sourceRoot":"","sources":["../../src/IModelDbFonts.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC","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 iModels\n */\n\nimport { FontFamilyDescriptor, FontFamilySelector, FontId, FontProps } from \"@itwin/core-common\";\nimport { _implementationProhibited } from \"./internal/Symbols\";\nimport { FontFile } from \"./FontFile\";\n\n/** Arguments supplied to [[IModelDbFonts.embedFontFile]].\n * @beta\n */\nexport interface EmbedFontFileArgs {\n  /** The file to embed. */\n  file: FontFile;\n  /** Unless true, [[IModelDbFonts.acquireId]] will be used to ensure that every font family in [[file]] is assigned a [FontId]($common). */\n  skipFontIdAllocation?: boolean;\n}\n\n/** Arguments supplied to [[IModelDbFonts.queryMappedFamilies]].\n * @beta\n */\nexport interface QueryMappedFamiliesArgs {\n  /** If true, include families that have been assigned a [FontId]($common) but for which no [FontFace]($common)s have been embedded. */\n  includeNonEmbedded?: boolean;\n}\n\n/** Provides read-write access to the [font-related information]($docs/learning/backend/Fonts.md) stored in an [[IModelDb]].\n * @see [[IModelDb.fonts]] to access the fonts for a specific iModel.\n * @beta\n */\nexport interface IModelDbFonts {\n  /** @internal */\n  readonly [_implementationProhibited]: unknown;\n\n  /** Obtain the collection of font families that have been assigned a [FontId]($common).\n   * By default, font families with no corresponding embedded font faces are omitted.\n   */\n  queryMappedFamilies(args?: QueryMappedFamiliesArgs): Iterable<FontProps>;\n\n  /** Obtain the collection of [[FontFile]]s embedded in the iModel.\n   * A FontFile obtained from one iModel can be embedded into another iModel using [[embedFontFile]], but the source iModel must remain open\n   */\n  queryEmbeddedFontFiles(): Iterable<FontFile>;\n\n  /** Store a [[FontFile]] in the iModel. By default, this method also ensures a [FontId]($common) is assigned to each font family in the file. */\n  embedFontFile(args: EmbedFontFileArgs): Promise<void>;\n\n  /** Returns the Id assigned to the specified font family, or `undefined` if no Id has been assigned.\n   * If only a name is supplied instead of a descriptor, and more than one family with the same name but different types exist, then\n   * [FontType.TrueType]($common) will be preferred over [FontType.Rsc]($common), and [FontType.Rsc]($common) over [FontType.Shx]($common).\n   * @see [[acquireId]] to assign an Id.\n   * @see [[findDescriptor]] to perform a reverse lookup.\n   */\n  findId(selector: FontFamilySelector): FontId | undefined;\n\n  /** Returns the font family associated with the specified Id, or `undefined` if no such mapping exists.\n   * @see [[findId]] to perform a reverse lookup.\n   */\n  findDescriptor(id: FontId): FontFamilyDescriptor | undefined;\n\n  /** Look up the Id assigned to the specified font family, allocating a new Id if one has not already been assigned. */\n  acquireId(descriptor: FontFamilyDescriptor): Promise<FontId>;\n}\n"]}
+{"version":3,"file":"IModelDbFonts.js","sourceRoot":"","sources":["../../src/IModelDbFonts.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\nimport { FontFamilyDescriptor, FontFamilySelector, FontId, FontProps } from \"@itwin/core-common\";\r\nimport { _implementationProhibited } from \"./internal/Symbols\";\r\nimport { FontFile } from \"./FontFile\";\r\n\r\n/** Arguments supplied to [[IModelDbFonts.embedFontFile]].\r\n * @beta\r\n */\r\nexport interface EmbedFontFileArgs {\r\n  /** The file to embed. */\r\n  file: FontFile;\r\n  /** Unless true, [[IModelDbFonts.acquireId]] will be used to ensure that every font family in [[file]] is assigned a [FontId]($common). */\r\n  skipFontIdAllocation?: boolean;\r\n}\r\n\r\n/** Arguments supplied to [[IModelDbFonts.queryMappedFamilies]].\r\n * @beta\r\n */\r\nexport interface QueryMappedFamiliesArgs {\r\n  /** If true, include families that have been assigned a [FontId]($common) but for which no [FontFace]($common)s have been embedded. */\r\n  includeNonEmbedded?: boolean;\r\n}\r\n\r\n/** Provides read-write access to the [font-related information]($docs/learning/backend/Fonts.md) stored in an [[IModelDb]].\r\n * @see [[IModelDb.fonts]] to access the fonts for a specific iModel.\r\n * @beta\r\n */\r\nexport interface IModelDbFonts {\r\n  /** @internal */\r\n  readonly [_implementationProhibited]: unknown;\r\n\r\n  /** Obtain the collection of font families that have been assigned a [FontId]($common).\r\n   * By default, font families with no corresponding embedded font faces are omitted.\r\n   */\r\n  queryMappedFamilies(args?: QueryMappedFamiliesArgs): Iterable<FontProps>;\r\n\r\n  /** Obtain the collection of [[FontFile]]s embedded in the iModel.\r\n   * A FontFile obtained from one iModel can be embedded into another iModel using [[embedFontFile]], but the source iModel must remain open\r\n   */\r\n  queryEmbeddedFontFiles(): Iterable<FontFile>;\r\n\r\n  /** Store a [[FontFile]] in the iModel. By default, this method also ensures a [FontId]($common) is assigned to each font family in the file. */\r\n  embedFontFile(args: EmbedFontFileArgs): Promise<void>;\r\n\r\n  /** Returns the Id assigned to the specified font family, or `undefined` if no Id has been assigned.\r\n   * If only a name is supplied instead of a descriptor, and more than one family with the same name but different types exist, then\r\n   * [FontType.TrueType]($common) will be preferred over [FontType.Rsc]($common), and [FontType.Rsc]($common) over [FontType.Shx]($common).\r\n   * @see [[acquireId]] to assign an Id.\r\n   * @see [[findDescriptor]] to perform a reverse lookup.\r\n   */\r\n  findId(selector: FontFamilySelector): FontId | undefined;\r\n\r\n  /** Returns the font family associated with the specified Id, or `undefined` if no such mapping exists.\r\n   * @see [[findId]] to perform a reverse lookup.\r\n   */\r\n  findDescriptor(id: FontId): FontFamilyDescriptor | undefined;\r\n\r\n  /** Look up the Id assigned to the specified font family, allocating a new Id if one has not already been assigned. */\r\n  acquireId(descriptor: FontFamilyDescriptor): Promise<FontId>;\r\n}\r\n"]}

package/lib/esm/IModelElementCloneContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"IModelElementCloneContext.js","sourceRoot":"","sources":["../../src/IModelElementCloneContext.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,aAAa,EAA0B,MAAM,EAAoB,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAE3H,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGzC,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C;;GAEG;AACH,MAAM,OAAO,yBAAyB;IACpC,2BAA2B;IACX,QAAQ,CAAW;IACnC,2BAA2B;IACX,QAAQ,CAAW;IACnC,gCAAgC;IACxB,cAAc,CAA+B;IAErD;;;OAGG;IACH,YAAmB,QAAkB,EAAE,QAAmB;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC/D,IAAI,CAAC,cAAc,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;IACpH,CAAC;IAED,0HAA0H;IACnH,KAAK,CAAC,UAAU;IACvB,CAAC;IAED,iHAAiH;IAC1G,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAA6D;QACzF,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QACnC,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;QAC5B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,sIAAsI;IACtI,IAAW,gBAAgB,KAAc,OAAO,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAElF,mFAAmF;IAC5E,CAAC,MAAM,CAAC,OAAO,CAAC,KAAW,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IAElE,qGAAqG;IAC9F,OAAO;QACZ,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACI,IAAI,CAAC,cAAsB,IAAU,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAEvF;;;;OAIG;IACI,aAAa,CAAC,kBAA0B,EAAE,kBAA0B;QACzE,MAAM,cAAc,GAAa,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QACvF,MAAM,cAAc,GAAa,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QACvF,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,EAAE,cAAc,CAAC,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,uFAAuF;IAChF,iBAAiB,CAAC,mBAA2B,EAAE,mBAA2B;QAC/E,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAC;IACzE,CAAC;IAED,2FAA2F;IACpF,YAAY,CAAC,QAAoB,EAAE,QAAoB;QAC5D,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;IAED,8DAA8D;IACvD,aAAa,CAAC,QAAoB;QACvC,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACI,oBAAoB,CAAC,QAAoB;QAC9C,IAAI,IAAI,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,mBAAmB,CAAC,eAA2B;QACpD,IAAI,IAAI,CAAC,OAAO,KAAK,eAAe,EAAE,CAAC;YACrC,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,mBAA+B;QACtD,MAAM,iBAAiB,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAc,mBAAmB,EAAE,WAAW,CAAC,CAAC;QAC9G,IAAI,iBAAiB,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,EAAE,CAAC;YACjE,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAED,oEAAoE;IACpE,IAAW,oBAAoB;QAC7B,OAAO,IAAI,CAAC,cAAc,CAAC,oBAAoB,EAAE,CAAC;IACpD,CAAC;IAED,4DAA4D;IACrD,qBAAqB,CAAC,aAAyB;QACpD,OAAO,IAAI,CAAC,cAAc,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACI,UAAU,CAAC,gBAAwB;QACxC,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,4CAA4C;QAC1E,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,gBAA4B;QAChD,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,aAAsB,EAAE,YAAiD;QACjG,MAAM,kBAAkB,GAAiB,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;QAC1G,iJAAiJ;QACjJ,4DAA4D;QAC5D,aAAa,CAAC,eAAe,CAAC,CAAC,YAAoB,EAAE,IAAsB,EAAE,EAAE;YAC7E,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,KAAM,aAAqB,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;gBAC/E,kBAA0B,CAAC,YAAY,CAAC,GAAG,cAAc,CAAC,IAAI,CAAC;YAClE,CAAC;QACH,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,sDAAsD;QACjE,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,kHAAkH;YAClH,kBAAkB,CAAC,cAAc,GAAG,aAAa,CAAC,cAAc,CAAC;YACjE,IAAI,aAAa,CAAC,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC;gBAC9G,kBAAkB,CAAC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,aAAa,CAAC;YACvD,CAAC;QACH,CAAC;QACD,yFAAyF;QACzF,IAAI,kBAAkB,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;YACpG,kBAAkB,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAC/C,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAiB,aAAa,CAAC,aAAa,CAAC,CAAC;QACtF,2DAA2D;QAC3D,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,EAAE,EAAE,kBAAkB,CAAC,CAAC;QAC5E,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,EAAY;QAC/B,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,eAAe,CAAC,EAAY;QACjC,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IACrD,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 iModels\n */\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\nimport { Code, CodeScopeSpec, CodeSpec, ElementProps, IModel, PropertyMetaData, RelatedElement } from \"@itwin/core-common\";\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\nimport { SubCategory } from \"./Category\";\nimport { Element } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\nimport { IModelNative } from \"./internal/NativePlatform\";\nimport { SQLiteDb } from \"./SQLiteDb\";\nimport { _nativeDb } from \"./internal/Symbols\";\n\n/** The context for transforming a *source* Element to a *target* Element and remapping internal identifiers to the target iModel.\n * @beta\n */\nexport class IModelElementCloneContext {\n  /** The source IModelDb. */\n  public readonly sourceDb: IModelDb;\n  /** The target IModelDb. */\n  public readonly targetDb: IModelDb;\n  /** The native import context */\n  private _nativeContext: IModelJsNative.ImportContext;\n\n  /** Construct a new IModelElementCloneContext. It must be initialized with `initialize`, consider using [[IModelElementCloneContext.create]] instead\n   * @param sourceDb The source IModelDb.\n   * @param targetDb If provided the target IModelDb. If not provided, the source and target are the same IModelDb.\n   */\n  public constructor(sourceDb: IModelDb, targetDb?: IModelDb) {\n    this.sourceDb = sourceDb;\n    this.targetDb = (undefined !== targetDb) ? targetDb : sourceDb;\n    this._nativeContext = new IModelNative.platform.ImportContext(this.sourceDb[_nativeDb], this.targetDb[_nativeDb]);\n  }\n\n  /** perform necessary initialization to use a clone context, namely caching the reference types in the source's schemas */\n  public async initialize() {\n  }\n\n  /** construct and initialize an IModelElementCloneContext at once, for where you construct in an async context */\n  public static async create(...args: ConstructorParameters<typeof IModelElementCloneContext>): Promise<IModelElementCloneContext> {\n    const instance = new this(...args);\n    await instance.initialize();\n    return instance;\n  }\n\n  /** Returns `true` if this context is for transforming between 2 iModels and `false` if it for transforming within the same iModel. */\n  public get isBetweenIModels(): boolean { return this.sourceDb !== this.targetDb; }\n\n  /** Dispose any native resources associated with this IModelElementCloneContext. */\n  public [Symbol.dispose](): void { this._nativeContext.dispose(); }\n\n  /** @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [Symbol.dispose] instead. */\n  public dispose() {\n    this[Symbol.dispose]();\n  }\n\n  /** Debugging aid that dumps the Id remapping details and other information to the specified output file.\n   * @internal\n   */\n  public dump(outputFileName: string): void { this._nativeContext.dump(outputFileName); }\n\n  /** Add a rule that remaps the specified source [CodeSpec]($common) to the specified target [CodeSpec]($common).\n   * @param sourceCodeSpecName The name of the CodeSpec from the source iModel.\n   * @param targetCodeSpecName The name of the CodeSpec from the target iModel.\n   * @throws [[IModelError]] if either CodeSpec could not be found.\n   */\n  public remapCodeSpec(sourceCodeSpecName: string, targetCodeSpecName: string): void {\n    const sourceCodeSpec: CodeSpec = this.sourceDb.codeSpecs.getByName(sourceCodeSpecName);\n    const targetCodeSpec: CodeSpec = this.targetDb.codeSpecs.getByName(targetCodeSpecName);\n    this._nativeContext.addCodeSpecId(sourceCodeSpec.id, targetCodeSpec.id);\n  }\n\n  /** Add a rule that remaps the specified source class to the specified target class. */\n  public remapElementClass(sourceClassFullName: string, targetClassFullName: string): void {\n    this._nativeContext.addClass(sourceClassFullName, targetClassFullName);\n  }\n\n  /** Add a rule that remaps the specified source Element to the specified target Element. */\n  public remapElement(sourceId: Id64String, targetId: Id64String): void {\n    this._nativeContext.addElementId(sourceId, targetId);\n  }\n\n  /** Remove a rule that remaps the specified source Element. */\n  public removeElement(sourceId: Id64String): void {\n    this._nativeContext.removeElementId(sourceId);\n  }\n\n  /** Look up a target CodeSpecId from the source CodeSpecId.\n   * @returns the target CodeSpecId or [Id64.invalid]($bentley) if a mapping not found.\n   */\n  public findTargetCodeSpecId(sourceId: Id64String): Id64String {\n    if (Id64.invalid === sourceId) {\n      return Id64.invalid;\n    }\n    return this._nativeContext.findCodeSpecId(sourceId);\n  }\n\n  /** Look up a target ElementId from the source ElementId.\n   * @returns the target ElementId or [Id64.invalid]($bentley) if a mapping not found.\n   */\n  public findTargetElementId(sourceElementId: Id64String): Id64String {\n    if (Id64.invalid === sourceElementId) {\n      return Id64.invalid;\n    }\n    return this._nativeContext.findElementId(sourceElementId);\n  }\n\n  /** Filter out geometry entries in the specified SubCategory from GeometryStreams in the target iModel.\n   * @note It is not possible to filter out a *default* SubCategory. A request to do so will be ignored.\n   * @see [SubCategory.isDefaultSubCategory]($backend)\n   */\n  public filterSubCategory(sourceSubCategoryId: Id64String): void {\n    const sourceSubCategory = this.sourceDb.elements.tryGetElement<SubCategory>(sourceSubCategoryId, SubCategory);\n    if (sourceSubCategory && !sourceSubCategory.isDefaultSubCategory) {\n      this._nativeContext.filterSubCategoryId(sourceSubCategoryId);\n    }\n  }\n\n  /** Returns `true` if there are any SubCategories being filtered. */\n  public get hasSubCategoryFilter(): boolean {\n    return this._nativeContext.hasSubCategoryFilter();\n  }\n\n  /** Returns `true` if this SubCategory is being filtered. */\n  public isSubCategoryFiltered(subCategoryId: Id64String): boolean {\n    return this._nativeContext.isSubCategoryFiltered(subCategoryId);\n  }\n\n  /** Import the specified font from the source iModel into the target iModel.\n   * @internal\n   */\n  public importFont(sourceFontNumber: number): void {\n    this.targetDb.clearFontMap(); // so it will be reloaded with new font info\n    this._nativeContext.importFont(sourceFontNumber);\n  }\n\n  /** Import a single CodeSpec from the source iModel into the target iModel.\n   * @internal\n   */\n  public importCodeSpec(sourceCodeSpecId: Id64String): void {\n    this._nativeContext.importCodeSpec(sourceCodeSpecId);\n  }\n\n  /** Clone the specified source Element into ElementProps for the target iModel.\n   * @internal\n   */\n  public async cloneElement(sourceElement: Element, cloneOptions?: IModelJsNative.CloneElementOptions): Promise<ElementProps> {\n    const targetElementProps: ElementProps = this._nativeContext.cloneElement(sourceElement.id, cloneOptions);\n    // Ensure that all NavigationProperties in targetElementProps have a defined value so \"clearing\" changes will be part of the JSON used for update\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    sourceElement.forEachProperty((propertyName: string, meta: PropertyMetaData) => {\n      if ((meta.isNavigation) && (undefined === (sourceElement as any)[propertyName])) {\n        (targetElementProps as any)[propertyName] = RelatedElement.none;\n      }\n    }, false); // exclude custom because C++ has already handled them\n    if (this.isBetweenIModels) {\n      // The native C++ cloneElement strips off federationGuid, want to put it back if transformation is between iModels\n      targetElementProps.federationGuid = sourceElement.federationGuid;\n      if (CodeScopeSpec.Type.Repository === this.targetDb.codeSpecs.getById(targetElementProps.code.spec).scopeType) {\n        targetElementProps.code.scope = IModel.rootSubjectId;\n      }\n    }\n    // unlike other references, code cannot be null. If it is null, use an empty code instead\n    if (targetElementProps.code.scope === Id64.invalid || targetElementProps.code.spec === Id64.invalid) {\n      targetElementProps.code = Code.createEmpty();\n    }\n    const jsClass = this.sourceDb.getJsClass<typeof Element>(sourceElement.classFullName);\n    // eslint-disable-next-line @typescript-eslint/dot-notation\n    await jsClass[\"onCloned\"](this, sourceElement.toJSON(), targetElementProps);\n    return targetElementProps;\n  }\n\n  /**\n   * serialize state to a sqlite database at a given path\n   * assumes the database has not already had any context state serialized to it\n   * @internal\n   */\n  public saveStateToDb(db: SQLiteDb): void {\n    this._nativeContext.saveStateToDb(db[_nativeDb]);\n  }\n\n  /**\n   * load state from a sqlite database at a given path\n   * @internal\n   */\n  public loadStateFromDb(db: SQLiteDb): void {\n    this._nativeContext.loadStateFromDb(db[_nativeDb]);\n  }\n}\n"]}
+{"version":3,"file":"IModelElementCloneContext.js","sourceRoot":"","sources":["../../src/IModelElementCloneContext.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,aAAa,EAA0B,MAAM,EAAoB,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAE3H,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGzC,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C;;GAEG;AACH,MAAM,OAAO,yBAAyB;IACpC,2BAA2B;IACX,QAAQ,CAAW;IACnC,2BAA2B;IACX,QAAQ,CAAW;IACnC,gCAAgC;IACxB,cAAc,CAA+B;IAErD;;;OAGG;IACH,YAAmB,QAAkB,EAAE,QAAmB;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC/D,IAAI,CAAC,cAAc,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;IACpH,CAAC;IAED,0HAA0H;IACnH,KAAK,CAAC,UAAU;IACvB,CAAC;IAED,iHAAiH;IAC1G,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAA6D;QACzF,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QACnC,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;QAC5B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,sIAAsI;IACtI,IAAW,gBAAgB,KAAc,OAAO,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAElF,mFAAmF;IAC5E,CAAC,MAAM,CAAC,OAAO,CAAC,KAAW,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IAElE,qGAAqG;IAC9F,OAAO;QACZ,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACI,IAAI,CAAC,cAAsB,IAAU,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAEvF;;;;OAIG;IACI,aAAa,CAAC,kBAA0B,EAAE,kBAA0B;QACzE,MAAM,cAAc,GAAa,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QACvF,MAAM,cAAc,GAAa,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QACvF,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,EAAE,cAAc,CAAC,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,uFAAuF;IAChF,iBAAiB,CAAC,mBAA2B,EAAE,mBAA2B;QAC/E,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAC;IACzE,CAAC;IAED,2FAA2F;IACpF,YAAY,CAAC,QAAoB,EAAE,QAAoB;QAC5D,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;IAED,8DAA8D;IACvD,aAAa,CAAC,QAAoB;QACvC,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACI,oBAAoB,CAAC,QAAoB;QAC9C,IAAI,IAAI,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,mBAAmB,CAAC,eAA2B;QACpD,IAAI,IAAI,CAAC,OAAO,KAAK,eAAe,EAAE,CAAC;YACrC,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,mBAA+B;QACtD,MAAM,iBAAiB,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAc,mBAAmB,EAAE,WAAW,CAAC,CAAC;QAC9G,IAAI,iBAAiB,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,EAAE,CAAC;YACjE,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAED,oEAAoE;IACpE,IAAW,oBAAoB;QAC7B,OAAO,IAAI,CAAC,cAAc,CAAC,oBAAoB,EAAE,CAAC;IACpD,CAAC;IAED,4DAA4D;IACrD,qBAAqB,CAAC,aAAyB;QACpD,OAAO,IAAI,CAAC,cAAc,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACI,UAAU,CAAC,gBAAwB;QACxC,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,4CAA4C;QAC1E,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,gBAA4B;QAChD,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,aAAsB,EAAE,YAAiD;QACjG,MAAM,kBAAkB,GAAiB,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;QAC1G,iJAAiJ;QACjJ,4DAA4D;QAC5D,aAAa,CAAC,eAAe,CAAC,CAAC,YAAoB,EAAE,IAAsB,EAAE,EAAE;YAC7E,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,KAAM,aAAqB,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;gBAC/E,kBAA0B,CAAC,YAAY,CAAC,GAAG,cAAc,CAAC,IAAI,CAAC;YAClE,CAAC;QACH,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,sDAAsD;QACjE,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,kHAAkH;YAClH,kBAAkB,CAAC,cAAc,GAAG,aAAa,CAAC,cAAc,CAAC;YACjE,IAAI,aAAa,CAAC,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC;gBAC9G,kBAAkB,CAAC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,aAAa,CAAC;YACvD,CAAC;QACH,CAAC;QACD,yFAAyF;QACzF,IAAI,kBAAkB,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;YACpG,kBAAkB,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAC/C,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAiB,aAAa,CAAC,aAAa,CAAC,CAAC;QACtF,2DAA2D;QAC3D,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,EAAE,EAAE,kBAAkB,CAAC,CAAC;QAC5E,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,EAAY;QAC/B,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,eAAe,CAAC,EAAY;QACjC,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IACrD,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 iModels\r\n */\r\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { Code, CodeScopeSpec, CodeSpec, ElementProps, IModel, PropertyMetaData, RelatedElement } from \"@itwin/core-common\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { SubCategory } from \"./Category\";\r\nimport { Element } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { IModelNative } from \"./internal/NativePlatform\";\r\nimport { SQLiteDb } from \"./SQLiteDb\";\r\nimport { _nativeDb } from \"./internal/Symbols\";\r\n\r\n/** The context for transforming a *source* Element to a *target* Element and remapping internal identifiers to the target iModel.\r\n * @beta\r\n */\r\nexport class IModelElementCloneContext {\r\n  /** The source IModelDb. */\r\n  public readonly sourceDb: IModelDb;\r\n  /** The target IModelDb. */\r\n  public readonly targetDb: IModelDb;\r\n  /** The native import context */\r\n  private _nativeContext: IModelJsNative.ImportContext;\r\n\r\n  /** Construct a new IModelElementCloneContext. It must be initialized with `initialize`, consider using [[IModelElementCloneContext.create]] instead\r\n   * @param sourceDb The source IModelDb.\r\n   * @param targetDb If provided the target IModelDb. If not provided, the source and target are the same IModelDb.\r\n   */\r\n  public constructor(sourceDb: IModelDb, targetDb?: IModelDb) {\r\n    this.sourceDb = sourceDb;\r\n    this.targetDb = (undefined !== targetDb) ? targetDb : sourceDb;\r\n    this._nativeContext = new IModelNative.platform.ImportContext(this.sourceDb[_nativeDb], this.targetDb[_nativeDb]);\r\n  }\r\n\r\n  /** perform necessary initialization to use a clone context, namely caching the reference types in the source's schemas */\r\n  public async initialize() {\r\n  }\r\n\r\n  /** construct and initialize an IModelElementCloneContext at once, for where you construct in an async context */\r\n  public static async create(...args: ConstructorParameters<typeof IModelElementCloneContext>): Promise<IModelElementCloneContext> {\r\n    const instance = new this(...args);\r\n    await instance.initialize();\r\n    return instance;\r\n  }\r\n\r\n  /** Returns `true` if this context is for transforming between 2 iModels and `false` if it for transforming within the same iModel. */\r\n  public get isBetweenIModels(): boolean { return this.sourceDb !== this.targetDb; }\r\n\r\n  /** Dispose any native resources associated with this IModelElementCloneContext. */\r\n  public [Symbol.dispose](): void { this._nativeContext.dispose(); }\r\n\r\n  /** @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [Symbol.dispose] instead. */\r\n  public dispose() {\r\n    this[Symbol.dispose]();\r\n  }\r\n\r\n  /** Debugging aid that dumps the Id remapping details and other information to the specified output file.\r\n   * @internal\r\n   */\r\n  public dump(outputFileName: string): void { this._nativeContext.dump(outputFileName); }\r\n\r\n  /** Add a rule that remaps the specified source [CodeSpec]($common) to the specified target [CodeSpec]($common).\r\n   * @param sourceCodeSpecName The name of the CodeSpec from the source iModel.\r\n   * @param targetCodeSpecName The name of the CodeSpec from the target iModel.\r\n   * @throws [[IModelError]] if either CodeSpec could not be found.\r\n   */\r\n  public remapCodeSpec(sourceCodeSpecName: string, targetCodeSpecName: string): void {\r\n    const sourceCodeSpec: CodeSpec = this.sourceDb.codeSpecs.getByName(sourceCodeSpecName);\r\n    const targetCodeSpec: CodeSpec = this.targetDb.codeSpecs.getByName(targetCodeSpecName);\r\n    this._nativeContext.addCodeSpecId(sourceCodeSpec.id, targetCodeSpec.id);\r\n  }\r\n\r\n  /** Add a rule that remaps the specified source class to the specified target class. */\r\n  public remapElementClass(sourceClassFullName: string, targetClassFullName: string): void {\r\n    this._nativeContext.addClass(sourceClassFullName, targetClassFullName);\r\n  }\r\n\r\n  /** Add a rule that remaps the specified source Element to the specified target Element. */\r\n  public remapElement(sourceId: Id64String, targetId: Id64String): void {\r\n    this._nativeContext.addElementId(sourceId, targetId);\r\n  }\r\n\r\n  /** Remove a rule that remaps the specified source Element. */\r\n  public removeElement(sourceId: Id64String): void {\r\n    this._nativeContext.removeElementId(sourceId);\r\n  }\r\n\r\n  /** Look up a target CodeSpecId from the source CodeSpecId.\r\n   * @returns the target CodeSpecId or [Id64.invalid]($bentley) if a mapping not found.\r\n   */\r\n  public findTargetCodeSpecId(sourceId: Id64String): Id64String {\r\n    if (Id64.invalid === sourceId) {\r\n      return Id64.invalid;\r\n    }\r\n    return this._nativeContext.findCodeSpecId(sourceId);\r\n  }\r\n\r\n  /** Look up a target ElementId from the source ElementId.\r\n   * @returns the target ElementId or [Id64.invalid]($bentley) if a mapping not found.\r\n   */\r\n  public findTargetElementId(sourceElementId: Id64String): Id64String {\r\n    if (Id64.invalid === sourceElementId) {\r\n      return Id64.invalid;\r\n    }\r\n    return this._nativeContext.findElementId(sourceElementId);\r\n  }\r\n\r\n  /** Filter out geometry entries in the specified SubCategory from GeometryStreams in the target iModel.\r\n   * @note It is not possible to filter out a *default* SubCategory. A request to do so will be ignored.\r\n   * @see [SubCategory.isDefaultSubCategory]($backend)\r\n   */\r\n  public filterSubCategory(sourceSubCategoryId: Id64String): void {\r\n    const sourceSubCategory = this.sourceDb.elements.tryGetElement<SubCategory>(sourceSubCategoryId, SubCategory);\r\n    if (sourceSubCategory && !sourceSubCategory.isDefaultSubCategory) {\r\n      this._nativeContext.filterSubCategoryId(sourceSubCategoryId);\r\n    }\r\n  }\r\n\r\n  /** Returns `true` if there are any SubCategories being filtered. */\r\n  public get hasSubCategoryFilter(): boolean {\r\n    return this._nativeContext.hasSubCategoryFilter();\r\n  }\r\n\r\n  /** Returns `true` if this SubCategory is being filtered. */\r\n  public isSubCategoryFiltered(subCategoryId: Id64String): boolean {\r\n    return this._nativeContext.isSubCategoryFiltered(subCategoryId);\r\n  }\r\n\r\n  /** Import the specified font from the source iModel into the target iModel.\r\n   * @internal\r\n   */\r\n  public importFont(sourceFontNumber: number): void {\r\n    this.targetDb.clearFontMap(); // so it will be reloaded with new font info\r\n    this._nativeContext.importFont(sourceFontNumber);\r\n  }\r\n\r\n  /** Import a single CodeSpec from the source iModel into the target iModel.\r\n   * @internal\r\n   */\r\n  public importCodeSpec(sourceCodeSpecId: Id64String): void {\r\n    this._nativeContext.importCodeSpec(sourceCodeSpecId);\r\n  }\r\n\r\n  /** Clone the specified source Element into ElementProps for the target iModel.\r\n   * @internal\r\n   */\r\n  public async cloneElement(sourceElement: Element, cloneOptions?: IModelJsNative.CloneElementOptions): Promise<ElementProps> {\r\n    const targetElementProps: ElementProps = this._nativeContext.cloneElement(sourceElement.id, cloneOptions);\r\n    // Ensure that all NavigationProperties in targetElementProps have a defined value so \"clearing\" changes will be part of the JSON used for update\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    sourceElement.forEachProperty((propertyName: string, meta: PropertyMetaData) => {\r\n      if ((meta.isNavigation) && (undefined === (sourceElement as any)[propertyName])) {\r\n        (targetElementProps as any)[propertyName] = RelatedElement.none;\r\n      }\r\n    }, false); // exclude custom because C++ has already handled them\r\n    if (this.isBetweenIModels) {\r\n      // The native C++ cloneElement strips off federationGuid, want to put it back if transformation is between iModels\r\n      targetElementProps.federationGuid = sourceElement.federationGuid;\r\n      if (CodeScopeSpec.Type.Repository === this.targetDb.codeSpecs.getById(targetElementProps.code.spec).scopeType) {\r\n        targetElementProps.code.scope = IModel.rootSubjectId;\r\n      }\r\n    }\r\n    // unlike other references, code cannot be null. If it is null, use an empty code instead\r\n    if (targetElementProps.code.scope === Id64.invalid || targetElementProps.code.spec === Id64.invalid) {\r\n      targetElementProps.code = Code.createEmpty();\r\n    }\r\n    const jsClass = this.sourceDb.getJsClass<typeof Element>(sourceElement.classFullName);\r\n    // eslint-disable-next-line @typescript-eslint/dot-notation\r\n    await jsClass[\"onCloned\"](this, sourceElement.toJSON(), targetElementProps);\r\n    return targetElementProps;\r\n  }\r\n\r\n  /**\r\n   * serialize state to a sqlite database at a given path\r\n   * assumes the database has not already had any context state serialized to it\r\n   * @internal\r\n   */\r\n  public saveStateToDb(db: SQLiteDb): void {\r\n    this._nativeContext.saveStateToDb(db[_nativeDb]);\r\n  }\r\n\r\n  /**\r\n   * load state from a sqlite database at a given path\r\n   * @internal\r\n   */\r\n  public loadStateFromDb(db: SQLiteDb): void {\r\n    this._nativeContext.loadStateFromDb(db[_nativeDb]);\r\n  }\r\n}\r\n"]}

package/lib/esm/IModelHost.d.ts

@@ -7,8 +7,10 @@ import { AuthorizationClient, LocalDirName, SessionProps } from "@itwin/core-com
 import type { ServerStorage } from "@itwin/object-storage-core";
 import { BackendHubAccess, CreateNewIModelProps } from "./BackendHubAccess";
 import { TileStorage } from "./TileStorage";
+import { SettingsContainer } from "./workspace/Settings";
 import { SettingsSchemas } from "./workspace/SettingsSchemas";
-import { Workspace, WorkspaceOpts } from "./workspace/Workspace";
+import { Workspace, WorkspaceDbSettingsProps, WorkspaceOpts } from "./workspace/Workspace";
+import { OwnedWorkspace } from "./internal/workspace/WorkspaceImpl";
 import { _getHubAccess, _hubAccess, _setHubAccess } from "./internal/Symbols";
 /** @internal */
 export interface CrashReportingConfigNameValuePair {
@@ -47,6 +49,15 @@ export interface AzureBlobStorageCredentials {
     accessKey: string;
     baseUrl?: string;
 }
+/** Controls how iModel writes through the implicit transaction are enforced.
+ *
+ * Allowed values:
+ * - "allow": preserve pre-version 5.8.0 behavior for backwards compatibility.
+ * - "log": allow the operation but log each implicit write as an error case.
+ * - "throw": reject writes through the implicit transaction and require explicit EditTxns.
+ * @beta
+ */
+export type ImplicitWriteEnforcement = "allow" | "log" | "throw";
 /**
  * Options for [[IModelHost.startup]]
  * @public
@@ -160,6 +171,13 @@ export interface IModelHostOptions {
      * @beta
      */
     useSemanticRebase?: boolean;
+    /**
+      * Controls how writes through the implicit transaction are enforced.
+      * See [[ImplicitWriteEnforcement]] for the allowed values.
+      * Defaults to "allow" for backwards compatibility.
+     * @beta
+     */
+    implicitWriteEnforcement?: ImplicitWriteEnforcement;
 }
 /** Configuration of core-backend.
  * @public
@@ -214,6 +232,12 @@ export declare class IModelHostConfiguration implements IModelHostOptions {
      * @beta
      */
     useSemanticRebase?: boolean;
+    /**
+      * Controls how writes through the implicit transaction are enforced.
+      * See [[IModelHostOptions.implicitWriteEnforcement]] for the meaning of each allowed value.
+     * @beta
+     */
+    implicitWriteEnforcement: ImplicitWriteEnforcement;
 }
 /** IModelHost initializes ($backend) and captures its configuration. A backend must call [[IModelHost.startup]] before using any backend classes.
  * See [the learning article]($docs/learning/backend/IModelHost.md)
@@ -274,6 +298,39 @@ export declare class IModelHost {
      * @beta
      */
     static get appWorkspace(): Workspace;
+    /** Obtain the [[Workspace]] for an iTwin by discovering its settings container.
+     * All named dictionary resources in the container's [[WorkspaceDb]] are loaded into the workspace at [[SettingsPriority.iTwin]].
+     * @note This method requires an internet connection to discover the container.
+     * To use an iTwin workspace offline, use the overload that accepts [[WorkspaceDbSettingsProps]].
+     * @note The returned workspace is caller-owned. Call `close` when finished.
+     * @beta
+     */
+    static getITwinWorkspace(iTwinId: GuidString): Promise<OwnedWorkspace>;
+    /** Obtain the [[Workspace]] for an iTwin.
+     * The supplied [[WorkspaceDbSettingsProps]] are passed directly to [[Workspace.loadSettingsDictionary]].
+      * @note You can derive these from the `settingsSources` property on a previously returned workspace.
+      * @note The returned workspace is caller-owned. Call `close` when finished.
+     * @beta
+     */
+    static getITwinWorkspace(props: WorkspaceDbSettingsProps | WorkspaceDbSettingsProps[]): Promise<OwnedWorkspace>;
+    /** Save a named [[SettingsDictionary]] to the iTwin's settings container.
+     * If no iTwin settings container exists for `iTwinId`, one is created.
+     * The dictionary is stored as a named resource in the container's default [[WorkspaceDb]], where `name` is used as the resource name.
+     * @param iTwinId The iTwin whose settings container should be updated.
+     * @param name The name of the dictionary, used as the resource name in the [[WorkspaceDb]].
+     * @param settings The settings key-value pairs to store.
+     * @note uses [[IModelHost.userMoniker]] as the user name for acquiring the write lock on the settings container.
+     * @beta
+     */
+    static saveSettingDictionary(iTwinId: GuidString, name: string, settings: SettingsContainer): Promise<void>;
+    /** Delete a named [[SettingsDictionary]] from the iTwin's settings container.
+     * If no iTwin settings container exists, this method does nothing.
+     * @param iTwinId The iTwin whose settings container should be updated.
+     * @param name The name of the dictionary (resource name) to delete.
+     * @note uses [[IModelHost.userMoniker]] as the user name for acquiring the write lock on the settings container.
+     * @beta
+     */
+    static deleteSettingDictionary(iTwinId: GuidString, name: string): Promise<void>;
     /** The registry of schemas describing the [[Setting]]s for the application session.
      * Applications should register their schemas via methods like [[SettingsSchemas.addGroup]].
      * @beta

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

@@ -1 +1 @@
-{"version":3,"file":"IModelHost.d.ts","sourceRoot":"","sources":["../../src/IModelHost.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,YAAY,CAAC;AAKpB,OAAO,EAAE,WAAW,EAAU,OAAO,EAAiC,UAAU,EAAwB,OAAO,EAAmB,MAAM,qBAAqB,CAAC;AAC9J,OAAO,EAAE,mBAAmB,EAAe,YAAY,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAGlG,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAc5E,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAKjE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAM9E,gBAAgB;AAChB,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,8JAA8J;IAC9J,QAAQ,EAAE,MAAM,CAAC;IACjB,sEAAsE;IACtE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wOAAwO;IACxO,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,sFAAsF;IACtF,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,iLAAiL;IACjL,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iHAAiH;IACjH,MAAM,CAAC,EAAE,iCAAiC,EAAE,CAAC;IAC7C;;;;;OAKG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,iGAAiG;IACjG,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,YAAY;AACZ,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC;IAExB,wDAAwD;IACxD,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B;;;OAGG;IACH,SAAS,CAAC,EAAE,aAAa,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAE7B;;OAEG;IACH,yBAAyB,CAAC,EAAE,2BAA2B,CAAC;IAExD;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,aAAa,CAAC;IAEjC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAE5C,uEAAuE;IACvE,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAE1C;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;OAKG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAE/C;;;OAGG;IACH,8BAA8B,CAAC,EAAE,IAAI,CAAC;IACtC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC;IAClD;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,uBAAwB,YAAW,iBAAiB;IAC/D,OAAc,yBAAyB,SAAa;IACpD,OAAc,+BAA+B,SAAM;IACnD,OAAc,2BAA2B,SAAgB;IACzD,gBAAgB;IAChB,OAAc,yBAAyB,SAAsB;IACtD,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,EAAE,YAAY,CAAC;IAE/B,YAAY;IACL,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,SAAS,CAAC,EAAE,gBAAgB,CAAC;IACpC,uEAAuE;IAChE,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IACjD,YAAY;IACL,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IACrC,YAAY;IACL,yBAAyB,CAAC,EAAE,2BAA2B,CAAC;IAC/D,gBAAgB;IACT,sBAAsB,SAAqD;IAClF,gBAAgB;IACT,yBAAyB,SAAqD;IACrF,gBAAgB;IACT,wBAAwB,SAA2D;IAC1F,gBAAgB;IACT,oBAAoB,SAAuD;IAClF,gBAAgB;IACT,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IACnD;;;;MAIE;IACK,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAEtD;;;OAGG;IACI,8BAA8B,CAAC,EAAE,IAAI,CAAC;IAC7C;;;;OAIG;IACI,wBAAwB,EAAE,SAAS,GAAG,UAAU,CAAc;IACrE;;;OAGG;IACI,iBAAiB,CAAC,EAAE,OAAO,CAAC;CACpC;AAyCD;;;GAGG;AACH,qBAAa,UAAU;IACrB,OAAO;IAEP,uEAAuE;IACvE,OAAc,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAExD,OAAc,cAAc,SAAM;IAClC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAS;IACpC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAM;IAC9B,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAkB;IAClD,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAiB;IAG9C,OAAc,aAAa,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;IAEnE;;;;;;;;;;OAUG;IACH,WAAkB,WAAW,IAAI,MAAM,CAEtC;IAED;;;OAGG;IACH,WAAkB,UAAU,IAAI,YAAY,CAE3C;IAED,iEAAiE;IACjE,gBAAuB,kBAAkB,gBAAqB,IAAI,EAAI;IAEtE,iEAAiE;IACjE,gBAAuB,cAAc,gBAAqB,IAAI,EAAI;IAElE,yEAAyE;IACzE,gBAAuB,gBAAgB,gBAAqB,IAAI,EAAI;IAEpE,gBAAgB;IAChB,gBAAuB,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,CAAyE;IAE9H,kCAAkC;IAClC,WAAkB,SAAS,IACK,UAAU,CADsB;IAChE,WAAkB,SAAS,CAAC,EAAE,EAAE,UAAU,EAAkC;IAE5E,mJAAmJ;IACnJ,WAAkB,aAAa,IACK,MAAM,CAD8B;IACxE,WAAkB,aAAa,CAAC,EAAE,EAAE,MAAM,EAAsC;IAEhF,qJAAqJ;IACrJ,WAAkB,kBAAkB,IACU,MAAM,CAD8B;IAClF,WAAkB,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAgD;IAEpG,qFAAqF;IACrF,OAAc,WAAW,SAAa;IAEtC,wDAAwD;IACxD,WAAkB,QAAQ,IAAI,YAAY,CAA2B;IAErE;;;;;OAKG;IACH,WAAkB,YAAY,IAAI,SAAS,CAAiD;IAE5F;;;OAGG;IACH,WAAkB,eAAe,IAAI,eAAe,CAAoD;IAExG;;OAEG;IACH,OAAc,wBAAwB,CAAC,EAAE,gBAAgB,CAAC;IAE1D;;;;;;OAMG;WACiB,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC;IAQ1D,OAAO,CAAC,MAAM,CAAC,UAAU;IA0BzB,gBAAgB;IAChB,OAAc,WAAW,CAAC,EAAE,WAAW,CAAC;IAExC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAmB;IAC7C,gBAAgB;WACF,CAAC,aAAa,CAAC,CAAC,SAAS,EAAE,gBAAgB,GAAG,SAAS;IAErE;;OAEG;WACW,CAAC,aAAa,CAAC,IAAI,gBAAgB,GAAG,SAAS;IAE7D;;;;OAIG;IACH,WAAkB,CAAC,UAAU,CAAC,IAAI,gBAAgB,CAIjD;IAED,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAoBlC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAS;IAEhC,4EAA4E;IAC5E,WAAkB,OAAO,YAExB;IAED;;;;OAIG;WACiB,OAAO,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IA4CvE,OAAO,CAAC,MAAM,CAAC,aAAa;IAQ5B,iGAAiG;WAC7E,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAMvD;;;;;OAKG;WACiB,eAAe,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;mBAI9D,UAAU;IAkB/B;;;OAGG;WACW,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAIvE;;;OAGG;WACW,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAI3D;;;OAGG;WACW,wBAAwB,IAAI,iCAAiC,EAAE;IAI7E,0DAA0D;IAC1D,WAAkB,YAAY,IAAI,MAAM,GAAG,SAAS,CAEnD;IAED;;OAEG;IACH,WAAkB,sBAAsB,IAAI,MAAM,CAEjD;IACD;;OAEG;IACH,WAAkB,yBAAyB,IAAI,MAAM,CAEpD;IAED,2FAA2F;IAC3F,WAAkB,wBAAwB,IAAI,MAAM,CAEnD;IACD,4FAA4F;IAC5F,WAAkB,oBAAoB,IAAI,MAAM,CAE/C;IAED;;OAEG;IACH,WAAkB,sBAAsB,IAAI,OAAO,CAElD;IAED;;OAEG;IACH,WAAkB,0BAA0B,IAAI,OAAO,CAEtD;IAED;;OAEG;IACH,WAAkB,mBAAmB,IAAI,OAAO,CAE/C;IAED;;;OAGG;IACH,WAAkB,iBAAiB,IAAI,OAAO,CAE7C;IAED,OAAO,CAAC,MAAM,CAAC,cAAc;IAqB7B,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAclC,gBAAgB;WACF,qBAAqB,CAAC,GAAG,EAAE;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,EAAE,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,MAAM;CAG5H;AAED;;GAEG;AACH,qBAAa,QAAQ;IACnB,oCAAoC;IACpC,WAAkB,YAAY,IAAI,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,CAEzF;CACF;AAED;;GAEG;AACH,qBAAa,cAAc;IAEzB,iEAAiE;IACjE,WAAkB,eAAe,IAAI,YAAY,CAEhD;IAED,8DAA8D;IAC9D,WAAkB,gBAAgB,IAAI,YAAY,CAEjD;IAED,+BAA+B;IAC/B,WAAkB,MAAM,IAAI,YAAY,CAEvC;CACF;AAED;;;;;GAKG;AACH,8BAAsB,gBAAgB;IACpC;;;OAGG;IACI,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAC1D;;;;OAIG;IACI,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAO1C;;;OAGG;IACI,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IACjE;;;;OAIG;IACI,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;CAOnD"}
+{"version":3,"file":"IModelHost.d.ts","sourceRoot":"","sources":["../../src/IModelHost.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,YAAY,CAAC;AAKpB,OAAO,EAAE,WAAW,EAAU,OAAO,EAAiC,UAAU,EAAwB,OAAO,EAAmB,MAAM,qBAAqB,CAAC;AAC9J,OAAO,EAAE,mBAAmB,EAAmC,YAAY,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAGtH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAe5E,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAgB,iBAAiB,EAAwC,MAAM,sBAAsB,CAAC;AAG7G,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAwB,wBAAwB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEjH,OAAO,EAAsB,cAAc,EAA8B,MAAM,oCAAoC,CAAC;AAGpH,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAM9E,gBAAgB;AAChB,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,8JAA8J;IAC9J,QAAQ,EAAE,MAAM,CAAC;IACjB,sEAAsE;IACtE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wOAAwO;IACxO,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,sFAAsF;IACtF,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,iLAAiL;IACjL,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iHAAiH;IACjH,MAAM,CAAC,EAAE,iCAAiC,EAAE,CAAC;IAC7C;;;;;OAKG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,iGAAiG;IACjG,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,YAAY;AACZ,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,wBAAwB,GAAG,OAAO,GAAG,KAAK,GAAG,OAAO,CAAC;AAEjE;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC;IAExB,wDAAwD;IACxD,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B;;;OAGG;IACH,SAAS,CAAC,EAAE,aAAa,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAE7B;;OAEG;IACH,yBAAyB,CAAC,EAAE,2BAA2B,CAAC;IAExD;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,aAAa,CAAC;IAEjC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAE5C,uEAAuE;IACvE,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAE1C;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;OAKG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAE/C;;;OAGG;IACH,8BAA8B,CAAC,EAAE,IAAI,CAAC;IACtC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC;IAClD;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;CACrD;AAED;;GAEG;AACH,qBAAa,uBAAwB,YAAW,iBAAiB;IAC/D,OAAc,yBAAyB,SAAa;IACpD,OAAc,+BAA+B,SAAM;IACnD,OAAc,2BAA2B,SAAgB;IACzD,gBAAgB;IAChB,OAAc,yBAAyB,SAAsB;IACtD,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,EAAE,YAAY,CAAC;IAE/B,YAAY;IACL,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,SAAS,CAAC,EAAE,gBAAgB,CAAC;IACpC,uEAAuE;IAChE,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IACjD,YAAY;IACL,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IACrC,YAAY;IACL,yBAAyB,CAAC,EAAE,2BAA2B,CAAC;IAC/D,gBAAgB;IACT,sBAAsB,SAAqD;IAClF,gBAAgB;IACT,yBAAyB,SAAqD;IACrF,gBAAgB;IACT,wBAAwB,SAA2D;IAC1F,gBAAgB;IACT,oBAAoB,SAAuD;IAClF,gBAAgB;IACT,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IACnD;;;;MAIE;IACK,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAEtD;;;OAGG;IACI,8BAA8B,CAAC,EAAE,IAAI,CAAC;IAC7C;;;;OAIG;IACI,wBAAwB,EAAE,SAAS,GAAG,UAAU,CAAc;IACrE;;;OAGG;IACI,iBAAiB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;OAIG;IACI,wBAAwB,EAAE,wBAAwB,CAAW;CACrE;AA0DD;;;GAGG;AACH,qBAAa,UAAU;IACrB,OAAO;IAEP,uEAAuE;IACvE,OAAc,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAExD,OAAc,cAAc,SAAM;IAClC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAS;IACpC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAM;IAC9B,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAkB;IAClD,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAiB;IAG9C,OAAc,aAAa,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;IAEnE;;;;;;;;;;OAUG;IACH,WAAkB,WAAW,IAAI,MAAM,CAEtC;IAED;;;OAGG;IACH,WAAkB,UAAU,IAAI,YAAY,CAE3C;IAED,iEAAiE;IACjE,gBAAuB,kBAAkB,gBAAqB,IAAI,EAAI;IAEtE,iEAAiE;IACjE,gBAAuB,cAAc,gBAAqB,IAAI,EAAI;IAElE,yEAAyE;IACzE,gBAAuB,gBAAgB,gBAAqB,IAAI,EAAI;IAEpE,gBAAgB;IAChB,gBAAuB,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,CAAyE;IAE9H,kCAAkC;IAClC,WAAkB,SAAS,IACK,UAAU,CADsB;IAChE,WAAkB,SAAS,CAAC,EAAE,EAAE,UAAU,EAAkC;IAE5E,mJAAmJ;IACnJ,WAAkB,aAAa,IACK,MAAM,CAD8B;IACxE,WAAkB,aAAa,CAAC,EAAE,EAAE,MAAM,EAAsC;IAEhF,qJAAqJ;IACrJ,WAAkB,kBAAkB,IACU,MAAM,CAD8B;IAClF,WAAkB,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAgD;IAEpG,qFAAqF;IACrF,OAAc,WAAW,SAAa;IAEtC,wDAAwD;IACxD,WAAkB,QAAQ,IAAI,YAAY,CAA2B;IAErE;;;;;OAKG;IACH,WAAkB,YAAY,IAAI,SAAS,CAAiD;IAE5F;;;;;;OAMG;WACiB,iBAAiB,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC;IACnF;;;;;OAKG;WACiB,iBAAiB,CAAC,KAAK,EAAE,wBAAwB,GAAG,wBAAwB,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IA4B5H;;;;;;;;OAQG;WACiB,qBAAqB,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAWxH;;;;;;OAMG;WACiB,uBAAuB,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAe7F;;;OAGG;IACH,WAAkB,eAAe,IAAI,eAAe,CAAoD;IAExG;;OAEG;IACH,OAAc,wBAAwB,CAAC,EAAE,gBAAgB,CAAC;IAE1D;;;;;;OAMG;WACiB,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC;IAQ1D,OAAO,CAAC,MAAM,CAAC,UAAU;IA0BzB,gBAAgB;IAChB,OAAc,WAAW,CAAC,EAAE,WAAW,CAAC;IAExC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAmB;IAC7C,gBAAgB;WACF,CAAC,aAAa,CAAC,CAAC,SAAS,EAAE,gBAAgB,GAAG,SAAS;IAErE;;OAEG;WACW,CAAC,aAAa,CAAC,IAAI,gBAAgB,GAAG,SAAS;IAE7D;;;;OAIG;IACH,WAAkB,CAAC,UAAU,CAAC,IAAI,gBAAgB,CAIjD;IAED,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAoBlC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAS;IAEhC,4EAA4E;IAC5E,WAAkB,OAAO,YAExB;IAED;;;;OAIG;WACiB,OAAO,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IA4CvE,OAAO,CAAC,MAAM,CAAC,aAAa;IAQ5B,iGAAiG;WAC7E,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAMvD;;;;;OAKG;WACiB,eAAe,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;mBAI9D,UAAU;IAmB/B;;;OAGG;WACW,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAIvE;;;OAGG;WACW,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAI3D;;;OAGG;WACW,wBAAwB,IAAI,iCAAiC,EAAE;IAI7E,0DAA0D;IAC1D,WAAkB,YAAY,IAAI,MAAM,GAAG,SAAS,CAEnD;IAED;;OAEG;IACH,WAAkB,sBAAsB,IAAI,MAAM,CAEjD;IACD;;OAEG;IACH,WAAkB,yBAAyB,IAAI,MAAM,CAEpD;IAED,2FAA2F;IAC3F,WAAkB,wBAAwB,IAAI,MAAM,CAEnD;IACD,4FAA4F;IAC5F,WAAkB,oBAAoB,IAAI,MAAM,CAE/C;IAED;;OAEG;IACH,WAAkB,sBAAsB,IAAI,OAAO,CAElD;IAED;;OAEG;IACH,WAAkB,0BAA0B,IAAI,OAAO,CAEtD;IAED;;OAEG;IACH,WAAkB,mBAAmB,IAAI,OAAO,CAE/C;IAED;;;OAGG;IACH,WAAkB,iBAAiB,IAAI,OAAO,CAE7C;IAED,OAAO,CAAC,MAAM,CAAC,cAAc;IAqB7B,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAclC,gBAAgB;WACF,qBAAqB,CAAC,GAAG,EAAE;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,EAAE,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,MAAM;CAG5H;AAED;;GAEG;AACH,qBAAa,QAAQ;IACnB,oCAAoC;IACpC,WAAkB,YAAY,IAAI,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,CAEzF;CACF;AAED;;GAEG;AACH,qBAAa,cAAc;IAEzB,iEAAiE;IACjE,WAAkB,eAAe,IAAI,YAAY,CAEhD;IAED,8DAA8D;IAC9D,WAAkB,gBAAgB,IAAI,YAAY,CAEjD;IAED,+BAA+B;IAC/B,WAAkB,MAAM,IAAI,YAAY,CAEvC;CACF;AAED;;;;;GAKG;AACH,8BAAsB,gBAAgB;IACpC;;;OAGG;IACI,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAC1D;;;;OAIG;IACI,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAO1C;;;OAGG;IACI,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IACjE;;;;OAIG;IACI,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;CAOnD"}

package/lib/esm/IModelHost.js

@@ -11,7 +11,7 @@ import { IModelNative, loadNativePlatform } from "./internal/NativePlatform";
 import * as os from "node:os";
 import { NativeLibrary } from "@bentley/imodeljs-native";
 import { assert, BeEvent, BentleyStatus, DbResult, Guid, IModelStatus, Logger, ProcessDetector } from "@itwin/core-bentley";
-import { IModelError } from "@itwin/core-common";
+import { IModelError, ITwinSettingsError } from "@itwin/core-common";
 import { AzureServerStorage, BlobServiceClientWrapper } from "@itwin/object-storage-azure";
 import { BlobServiceClient, StorageSharedKeyCredential } from "@azure/storage-blob";
 import { BackendLoggerCategory } from "./BackendLoggerCategory";
@@ -20,6 +20,7 @@ import { BriefcaseManager } from "./BriefcaseManager";
 import { CloudSqlite } from "./CloudSqlite";
 import { FunctionalSchema } from "./domains/FunctionalSchema";
 import { GenericSchema } from "./domains/GenericSchema";
+import { EditTxn } from "./EditTxn";
 import { GeoCoordConfig } from "./GeoCoordConfig";
 import { IModelJsFs } from "./IModelJsFs";
 import { DevToolsRpcImpl } from "./rpc-impl/DevToolsRpcImpl";
@@ -29,8 +30,10 @@ import { SnapshotIModelRpcImpl } from "./rpc-impl/SnapshotIModelRpcImpl";
 import { initializeRpcBackend } from "./RpcBackend";
 import { TileStorage } from "./TileStorage";
 import { SettingsPriority } from "./workspace/Settings";
+import { settingsWorkspaceDbName } from "./workspace/SettingsDb";
+import { SettingsContainers, SettingsEditor } from "./workspace/SettingsEditor";
 import { join, normalize as normalizeDir } from "path";
-import { constructWorkspace } from "./internal/workspace/WorkspaceImpl";
+import { constructWorkspace, throwWorkspaceDbLoadErrors } from "./internal/workspace/WorkspaceImpl";
 import { SettingsImpl } from "./internal/workspace/SettingsImpl";
 import { constructSettingsSchemas } from "./internal/workspace/SettingsSchemasImpl";
 import { _getHubAccess, _hubAccess, _setHubAccess } from "./internal/Symbols";
@@ -88,6 +91,12 @@ export class IModelHostConfiguration {
      * @beta
      */
     useSemanticRebase;
+    /**
+      * Controls how writes through the implicit transaction are enforced.
+      * See [[IModelHostOptions.implicitWriteEnforcement]] for the meaning of each allowed value.
+     * @beta
+     */
+    implicitWriteEnforcement = "allow";
 }
 /**
  * Settings for `IModelHost.appWorkspace`.
@@ -119,6 +128,21 @@ class ApplicationSettings extends SettingsImpl {
         }
     }
 }
+/**
+ * Settings for an iTwin. May only include settings priority for iTwin and organization.
+ */
+class ITwinWorkspaceSettings extends SettingsImpl {
+    verifyPriority(priority) {
+        if (priority <= SettingsPriority.application)
+            ITwinSettingsError.throwError("invalid-priority", { message: `Settings with priority ${priority} cannot be added to an iTwin workspace.` });
+        if (priority > SettingsPriority.iTwin)
+            ITwinSettingsError.throwError("invalid-priority", { message: `Settings with priority ${priority} cannot be added to an iTwin workspace.` });
+    }
+    *getSettingEntries(name) {
+        yield* super.getSettingEntries(name);
+        yield* IModelHost.appWorkspace.settings.getSettingEntries(name);
+    }
+}
 const definedInStartup = (obj) => {
     if (obj === undefined)
         throw new Error("IModelHost.startup must be called first");
@@ -188,6 +212,69 @@ export class IModelHost {
      * @beta
      */
     static get appWorkspace() { return definedInStartup(this._appWorkspace); }
+    /** @internal */
+    static async getITwinWorkspace(args) {
+        const isITwinId = typeof args === "string";
+        const workspace = constructWorkspace(new ITwinWorkspaceSettings());
+        try {
+            const settingsSources = isITwinId ? await SettingsContainers.getITwinSettingsSources(args) : args;
+            if (undefined === settingsSources)
+                return workspace;
+            workspace.settingsSources = settingsSources;
+            const problems = [];
+            await workspace.loadSettingsDictionary(settingsSources, problems);
+            if (problems.length > 0) {
+                const label = isITwinId ? `iTwin '${args}'` : "the supplied settings workspace db properties";
+                throwWorkspaceDbLoadErrors(`attempting to load workspace settings for ${label}`, problems);
+            }
+            return workspace;
+        }
+        catch (error) {
+            workspace.close();
+            throw error;
+        }
+    }
+    /** Save a named [[SettingsDictionary]] to the iTwin's settings container.
+     * If no iTwin settings container exists for `iTwinId`, one is created.
+     * The dictionary is stored as a named resource in the container's default [[WorkspaceDb]], where `name` is used as the resource name.
+     * @param iTwinId The iTwin whose settings container should be updated.
+     * @param name The name of the dictionary, used as the resource name in the [[WorkspaceDb]].
+     * @param settings The settings key-value pairs to store.
+     * @note uses [[IModelHost.userMoniker]] as the user name for acquiring the write lock on the settings container.
+     * @beta
+     */
+    static async saveSettingDictionary(iTwinId, name, settings) {
+        const { editor, container } = await SettingsEditor.constructForITwin(iTwinId);
+        try {
+            await container.withEditableDb(this.userMoniker, (db) => {
+                db.updateSettingsResource(settings, name);
+            }, { dbName: settingsWorkspaceDbName });
+        }
+        finally {
+            editor.close();
+        }
+    }
+    /** Delete a named [[SettingsDictionary]] from the iTwin's settings container.
+     * If no iTwin settings container exists, this method does nothing.
+     * @param iTwinId The iTwin whose settings container should be updated.
+     * @param name The name of the dictionary (resource name) to delete.
+     * @note uses [[IModelHost.userMoniker]] as the user name for acquiring the write lock on the settings container.
+     * @beta
+     */
+    static async deleteSettingDictionary(iTwinId, name) {
+        const settingsEditor = await SettingsEditor.getForITwin(iTwinId);
+        if (undefined === settingsEditor)
+            return;
+        const { editor, container } = settingsEditor;
+        try {
+            await container.withEditableDb(this.userMoniker, (db) => {
+                db.removeString(name);
+            }, { dbName: settingsWorkspaceDbName });
+        }
+        finally {
+            editor.close();
+        }
+    }
     /** The registry of schemas describing the [[Setting]]s for the application session.
      * Applications should register their schemas via methods like [[SettingsSchemas.addGroup]].
      * @beta
@@ -294,6 +381,7 @@ export class IModelHost {
         this.loadNative(options);
         this.setupCacheDir(options);
         this.initializeWorkspace(options);
+        EditTxn.implicitWriteEnforcement = options.implicitWriteEnforcement ?? "allow";
         BriefcaseManager.initialize(join(this._cacheDir, "imodels"));
         [
             IModelReadRpcImpl,
@@ -341,6 +429,7 @@ export class IModelHost {
         this._isValid = false;
         this.onBeforeShutdown.raiseEvent();
         this.configuration = undefined;
+        EditTxn.implicitWriteEnforcement = "allow";
         this.tileStorage = undefined;
         this._appWorkspace?.close();
         this._appWorkspace = undefined;