@itwin/core-backend 5.1.0-dev.5 → 5.1.0-dev.51

package/lib/cjs/LockControl.js.map

@@ -1 +1 @@
-{"version":3,"file":"LockControl.js","sourceRoot":"","sources":["../../src/LockControl.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;AAGH,gDAA6G","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 { Id64Arg, Id64String } from \"@itwin/core-bentley\";\nimport { _close, _elementWasCreated, _implementationProhibited, _releaseAllLocks } from \"./internal/Symbols\";\n\n/**\n * Interface for acquiring element locks to [coordinate simultaneous edits]($docs/learning/backend/ConcurrencyControl.md) from multiple briefcases.\n * @see [[IModelDb.locks]] to access the locks for an iModel.\n * @public\n */\nexport interface LockControl {\n  /** @internal*/\n  readonly [_implementationProhibited]: unknown;\n\n  /**\n   * true if this LockControl uses a server-based concurrency approach.\n   */\n  readonly isServerBased: boolean;\n\n  /**\n   * Close the local lock control database\n   * @internal\n   */\n  [_close]: () => void;\n\n  /**\n   * Notification that a new element was just created. Called by [[Element.onInserted]]\n   * @internal\n   */\n  [_elementWasCreated]: (id: Id64String) => void;\n\n  /**\n   * Throw if locks are required and the exclusive lock is not held on the supplied element.\n   * Note: there is no need to check the shared locks on parents/models since an element cannot hold the exclusive lock without first obtaining them.\n   * Called by functions like [[Element.onUpdate]], [[Element.onDelete]], etc.\n   */\n  checkExclusiveLock(id: Id64String, type: string, operation: string): void;\n\n  /**\n   * Throw if locks are required and a shared lock is not held on the supplied element.\n   * Called by [[Element.onInsert]] to ensure shared lock is held on the new element's model and parent element.\n   */\n  checkSharedLock(id: Id64String, type: string, operation: string): void;\n\n  /**\n   * Determine whether the owning iModel currently holds the exclusive lock on the specified element.\n   */\n  holdsExclusiveLock(id: Id64String): boolean;\n\n  /**\n   * Determine whether the owning iModel currently holds a shared lock on the specified element.\n   */\n  holdsSharedLock(id: Id64String): boolean;\n\n  /**\n   * Acquire locks on one or more elements from the lock server, if required and not already held.\n   * If any required lock is not available, this method throws an exception and *none* of the requested locks are acquired.\n   * @note Acquiring the exclusive lock on an element requires also obtaining a shared lock on all its owner elements. This method will\n   * attempt to acquire all necessary locks for both sets of input ids.\n   */\n  acquireLocks(arg: {\n    /** if present, one or more elements to obtain shared lock */\n    shared?: Id64Arg;\n    /** if present, one or more elements to obtain exclusive lock */\n    exclusive?: Id64Arg;\n  }): Promise<void>;\n\n  /** Release all locks currently held by this briefcase from the locker server.\n   * This is typically done on your behalf by [[BriefcaseDb.pushChanges]].\n   * You may want to do it manually when abandoning all of your briefcase's local changes.\n   * You cannot release your locks if your briefcase contains local changes.\n   * @throws Error if the briefcase has local changes, or if any other error occurs while releasing the locks.\n   */\n  releaseAllLocks(): Promise<void>;\n\n  /**\n   * Release all locks currently held by this Briefcase from the lock server.\n   * Not possible to release locks unless push or abandon all changes. Should only be called internally.\n   * @internal\n   */\n  [_releaseAllLocks]: () => Promise<void>;\n}\n"]}
+{"version":3,"file":"LockControl.js","sourceRoot":"","sources":["../../src/LockControl.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;AAGH,gDAA6G","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 { Id64Arg, Id64String } from \"@itwin/core-bentley\";\r\nimport { _close, _elementWasCreated, _implementationProhibited, _releaseAllLocks } from \"./internal/Symbols\";\r\n\r\n/**\r\n * Interface for acquiring element locks to [coordinate simultaneous edits]($docs/learning/backend/ConcurrencyControl.md) from multiple briefcases.\r\n * @see [[IModelDb.locks]] to access the locks for an iModel.\r\n * @public\r\n */\r\nexport interface LockControl {\r\n  /** @internal*/\r\n  readonly [_implementationProhibited]: unknown;\r\n\r\n  /**\r\n   * true if this LockControl uses a server-based concurrency approach.\r\n   */\r\n  readonly isServerBased: boolean;\r\n\r\n  /**\r\n   * Close the local lock control database\r\n   * @internal\r\n   */\r\n  [_close]: () => void;\r\n\r\n  /**\r\n   * Notification that a new element was just created. Called by [[Element.onInserted]]\r\n   * @internal\r\n   */\r\n  [_elementWasCreated]: (id: Id64String) => void;\r\n\r\n  /**\r\n   * Throw if locks are required and the exclusive lock is not held on the supplied element.\r\n   * Note: there is no need to check the shared locks on parents/models since an element cannot hold the exclusive lock without first obtaining them.\r\n   * Called by functions like [[Element.onUpdate]], [[Element.onDelete]], etc.\r\n   */\r\n  checkExclusiveLock(id: Id64String, type: string, operation: string): void;\r\n\r\n  /**\r\n   * Throw if locks are required and a shared lock is not held on the supplied element.\r\n   * Called by [[Element.onInsert]] to ensure shared lock is held on the new element's model and parent element.\r\n   */\r\n  checkSharedLock(id: Id64String, type: string, operation: string): void;\r\n\r\n  /**\r\n   * Determine whether the owning iModel currently holds the exclusive lock on the specified element.\r\n   */\r\n  holdsExclusiveLock(id: Id64String): boolean;\r\n\r\n  /**\r\n   * Determine whether the owning iModel currently holds a shared lock on the specified element.\r\n   */\r\n  holdsSharedLock(id: Id64String): boolean;\r\n\r\n  /**\r\n   * Acquire locks on one or more elements from the lock server, if required and not already held.\r\n   * If any required lock is not available, this method throws an exception and *none* of the requested locks are acquired.\r\n   * @note Acquiring the exclusive lock on an element requires also obtaining a shared lock on all its owner elements. This method will\r\n   * attempt to acquire all necessary locks for both sets of input ids.\r\n   */\r\n  acquireLocks(arg: {\r\n    /** if present, one or more elements to obtain shared lock */\r\n    shared?: Id64Arg;\r\n    /** if present, one or more elements to obtain exclusive lock */\r\n    exclusive?: Id64Arg;\r\n  }): Promise<void>;\r\n\r\n  /** Release all locks currently held by this briefcase from the locker server.\r\n   * This is typically done on your behalf by [[BriefcaseDb.pushChanges]].\r\n   * You may want to do it manually when abandoning all of your briefcase's local changes.\r\n   * You cannot release your locks if your briefcase contains local changes.\r\n   * @throws Error if the briefcase has local changes, or if any other error occurs while releasing the locks.\r\n   */\r\n  releaseAllLocks(): Promise<void>;\r\n\r\n  /**\r\n   * Release all locks currently held by this Briefcase from the lock server.\r\n   * Not possible to release locks unless push or abandon all changes. Should only be called internally.\r\n   * @internal\r\n   */\r\n  [_releaseAllLocks]: () => Promise<void>;\r\n}\r\n"]}

package/lib/cjs/Material.d.ts

@@ -92,7 +92,7 @@ export declare namespace RenderMaterialElement {
     /** Parameters used to construct a [[RenderMaterial]].
      * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.
      * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.
-     * @deprecated in 3.6 because it is not useful to use a `class` - just use [[RenderMaterialElementParams]] directly instead.
+     * @deprecated in 3.6 - might be removed in next major version. Because it is not useful to use a `class` - just use [[RenderMaterialElementParams]] directly instead.
      */
     class Params {
         /** A required palette name that categorizes this RenderMaterial */

package/lib/cjs/Material.js

@@ -220,7 +220,7 @@ exports.RenderMaterialElement = RenderMaterialElement;
     /** Parameters used to construct a [[RenderMaterial]].
      * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.
      * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.
-     * @deprecated in 3.6 because it is not useful to use a `class` - just use [[RenderMaterialElementParams]] directly instead.
+     * @deprecated in 3.6 - might be removed in next major version. Because it is not useful to use a `class` - just use [[RenderMaterialElementParams]] directly instead.
      */
     class Params {
         /** A required palette name that categorizes this RenderMaterial */

package/lib/cjs/Material.js.map

@@ -1 +1 @@
-{"version":3,"file":"Material.js","sourceRoot":"","sources":["../../src/Material.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkE;AAClE,oDAE4B;AAC5B,uCAA8C;AAK9C,yDAAyD;AAEzD;;;GAGG;AACH,MAAsB,gBAAiB,SAAQ,2BAAiB;IACvD,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;IAC7E;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,iBAAiC,EAAE,IAAY;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,gBAAgB,CAAC,CAAC;QACpF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,iBAAiB,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAChF,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAA6B,QAAkB,EAAE,iBAAiC,EAAE,IAAY;QAClH,MAAM,YAAY,GAA2B;YAC3C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;SACzD,CAAC;QACF,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IACvD,CAAC;CACF;AA1BD,4CA0BC;AAED;;;GAGG;AACH,MAAa,qBAAsB,SAAQ,2BAAiB;IACnD,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAE3E,+EAA+E;IACxE,WAAW,CAAS;IAC3B,+CAA+C;IACxC,WAAW,CAAU;IAE5B,YAAoB,KAA0B,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;IACvC,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAyB,CAAC;QAClD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACnC,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACnC,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAmB,mBAAmB,GAA4B;QAChF,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;KACjD,CAAC;IAEF;;;;OAIG;IACI,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAwB,CAAC;QAChE,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC;QAC3B,OAAO,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC/D,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAU,SAAS,CAAC,KAA0B,EAAE,MAAgB;QAC3E,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,IAAY;QACnF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,cAAc,CAAC,CAAC;QAClF,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,kBAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACpH,CAAC;IACD;;;;;;;;OAQG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,YAAoB,EAAE,MAAmC;QAC/H,IAAI,IAA8C,CAAC;QACnD,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC;QAC3C,IAAI,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YAG1C,SAAS,MAAM,CAAyB,GAAW,EAAE,GAAM;gBACzD,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC;gBAC9B,IAAI,GAAG,IAAI,SAAS,KAAK,GAAG,CAAC,GAAG,CAAC;oBAC/B,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;qBACjB,IAAI,MAAM,CAAC,SAAS,IAAI,SAAS,KAAK,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;oBAC9D,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YACrC,CAAC;YAED,MAAM,SAAS,GAAW,EAAE,CAAC;YAC7B,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YACnC,MAAM,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;YACpC,MAAM,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;YAClC,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YACnC,MAAM,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;YACpC,MAAM,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;YACvC,MAAM,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;YACrC,MAAM,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;YACpC,MAAM,CAAC,SAAS,EAAE,wBAAwB,CAAC,CAAC;YAC5C,MAAM,CAAC,SAAS,EAAE,iCAAiC,CAAC,CAAC;YACrD,MAAM,CAAC,SAAS,EAAE,4BAA4B,CAAC,CAAC;YAChD,MAAM,CAAC,SAAS,EAAE,sCAAsC,CAAC,CAAC;YAC1D,MAAM,CAAC,SAAS,EAAE,sCAAsC,CAAC,CAAC;YAE1D,IAAI,GAAG,EAAE,CAAC;YACV,IAAI,MAAM,CAAC,UAAU;gBACnB,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,MAAM,CAAC,UAAU,EAAE,GAAG,SAAS,EAAE,CAAC;YAExD,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;gBACrB,IAAI,CAAC,MAAM,GAAG;oBACZ,GAAG,MAAM,CAAC,SAAS;oBACnB,GAAG,SAAS;iBACb,CAAC;gBAEF,OAAQ,IAAI,CAAC,MAAc,CAAC,KAAK,CAAC;YACpC,CAAC;QACH,CAAC;QAED,4FAA4F;QAC5F,MAAM,mBAAmB,GAAwB;YAC/C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,YAAY,CAAC;YAChE,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,cAAc,EAAE;gBACd,cAAc,EAAE;oBACd,cAAc,EAAE;wBACd,YAAY,EAAE,MAAM,CAAC,KAAK,KAAK,SAAS;wBACxC,KAAK,EAAE,MAAM,CAAC,KAAK;wBACnB,gBAAgB,EAAE,MAAM,CAAC,aAAa,KAAK,SAAS;wBACpD,cAAc,EAAE,MAAM,CAAC,aAAa;wBACpC,SAAS,EAAE,MAAM,CAAC,MAAM,KAAK,SAAS;wBACtC,MAAM,EAAE,MAAM,CAAC,MAAM;wBACrB,WAAW,EAAE,MAAM,CAAC,QAAQ,KAAK,SAAS;wBAC1C,QAAQ,EAAE,MAAM,CAAC,QAAQ;wBACzB,UAAU,EAAE,MAAM,CAAC,OAAO,KAAK,SAAS;wBACxC,OAAO,EAAE,MAAM,CAAC,OAAO;wBACvB,WAAW,EAAE,MAAM,CAAC,QAAQ,KAAK,SAAS;wBAC1C,QAAQ,EAAE,MAAM,CAAC,QAAQ;wBACzB,UAAU,EAAE,MAAM,CAAC,OAAO,KAAK,SAAS;wBACxC,OAAO,EAAE,MAAM,CAAC,OAAO;wBACvB,eAAe,EAAE,MAAM,CAAC,YAAY,KAAK,SAAS;wBAClD,aAAa,EAAE,MAAM,CAAC,YAAY;wBAClC,GAAG,EAAE,IAAI;wBACT,UAAU;qBACX;iBACF;aACF;YACD,KAAK,EAAE,iBAAiB;YACxB,SAAS,EAAE,KAAK;SACjB,CAAC;QAEF,OAAO,IAAI,qBAAqB,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,YAAoB,EAAE,MAAmC;QAC/H,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;QACtF,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,YAAY;IACF,MAAM,CAAU,QAAQ,CAAC,OAAkC,EAAE,WAAyB,EAAE,WAAyB;QACzH,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;QAClD,KAAK,MAAM,OAAO,IAAI,WAAW,CAAC,cAAc,EAAE,cAAc,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC;YAC5F,IAAI,OAAO,OAAO,KAAK,QAAQ;gBAC7B,SAAS;YACX,MAAM,SAAS,GAAG,WAAW,CAAC,cAAc,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACxF,qEAAqE;YACrE,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,WAAW,CAAC,cAAc,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;gBAClF,SAAS;YACX,CAAC;YACD,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,KAAK,SAAS;gBACzE,SAAS;YACX,WAAW,CAAC,cAAc,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC,SAAS,CAAC,SAAS,IAAI,mBAAI,CAAC,OAAO,CAAC,CAAC;QACrJ,CAAC;IACH,CAAC;;AArLH,sDAsLC;AAED,cAAc;AACd,WAAiB,qBAAqB;IACpC;;;;OAIG;IACH,MAAa,MAAM;QACjB,mEAAmE;QAC5D,WAAW,CAAS;QAC3B,qDAAqD;QAC9C,WAAW,CAAU;QAC5B,iHAAiH;QAC1G,KAAK,CAAkB;QAC9B,kEAAkE;QAC3D,aAAa,CAAkB;QACtC;;WAEG;QACI,MAAM,CAAU;QACvB;;;WAGG;QACI,QAAQ,CAAU;QACzB,wEAAwE;QACjE,OAAO,CAAU;QACxB,yEAAyE;QAClE,QAAQ,CAAU;QACzB,wBAAwB;QACjB,OAAO,CAAU;QACxB,wBAAwB;QACjB,YAAY,CAAY;QAC/B;;;WAGG;QACI,UAAU,CAAmB;QACpC;;;;WAIG;QACI,SAAS,CAKd;QAEF,gJAAgJ;QAChJ,YAAmB,WAAmB;YACpC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QACjC,CAAC;KACF;IA/CY,4BAAM,SA+ClB,CAAA;AACH,CAAC,EAtDgB,qBAAqB,qCAArB,qBAAqB,QAsDrC","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 Elements\n */\n\nimport { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\nimport {\n  BisCodeSpec, Code, CodeScopeProps, CodeSpec, DefinitionElementProps, ElementProps, NormalMapProps, RenderMaterialAssetMapsProps, RenderMaterialProps, RgbFactorProps, TextureMapProps,\n} from \"@itwin/core-common\";\nimport { DefinitionElement } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\nimport { IModelElementCloneContext } from \"./IModelElementCloneContext\";\nimport { CustomHandledProperty, DeserializeEntityArgs, ECSqlRow } from \"./Entity\";\n\n/* eslint-disable @typescript-eslint/naming-convention */\n\n/** A PhysicalMaterial defines the matter that makes up physical elements.\n * @note See [[RenderMaterialElement]] for the DefinitionElement used to define rendering characteristics.\n * @public\n */\nexport abstract class PhysicalMaterial extends DefinitionElement {\n  public static override get className(): string { return \"PhysicalMaterial\"; }\n  /** Create a Code for a PhysicalMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModelDb\n   * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.\n   * @param name The name (codeValue) of the PhysicalMaterial\n   */\n  public static createCode(iModel: IModelDb, definitionModelId: CodeScopeProps, name: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.physicalMaterial);\n    return new Code({ spec: codeSpec.id, scope: definitionModelId, value: name });\n  }\n  /** Create a PhysicalMaterial\n   * @param iModelDb The IModelDb\n   * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.\n   * @param name The name (codeValue) of the PhysicalMaterial\n   * @returns The newly constructed PhysicalMaterial\n   * @throws [[IModelError]] if there is a problem creating the PhysicalMaterial\n   */\n  public static create<T extends PhysicalMaterial>(iModelDb: IModelDb, definitionModelId: CodeScopeProps, name: string): T {\n    const elementProps: DefinitionElementProps = {\n      classFullName: this.classFullName,\n      model: definitionModelId,\n      code: this.createCode(iModelDb, definitionModelId, name),\n    };\n    return iModelDb.elements.createElement(elementProps);\n  }\n}\n\n/** Defines a rendering material.\n * @note See [[PhysicalMaterial]] for the DefinitionElement used to define the matter that makes up physical elements.\n * @public\n */\nexport class RenderMaterialElement extends DefinitionElement {\n  public static override get className(): string { return \"RenderMaterial\"; }\n\n  /** The name of a palette that can be used to categorize multiple materials. */\n  public paletteName: string;\n  /** An optional description of the material. */\n  public description?: string;\n\n  private constructor(props: RenderMaterialProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.paletteName = props.paletteName;\n    this.description = props.description;\n  }\n\n  public override toJSON(): RenderMaterialProps {\n    const val = super.toJSON() as RenderMaterialProps;\n    val.paletteName = this.paletteName;\n    val.description = this.description;\n    return val;\n  }\n\n  /**\n   * RenderMaterialElement custom HandledProps includes 'paletteName'.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\n    { propertyName: \"paletteName\", source: \"Class\" },\n  ];\n\n  /**\n   * RenderMaterialElement deserializes 'paletteName'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override deserialize(props: DeserializeEntityArgs): RenderMaterialProps {\n    const elProps = super.deserialize(props) as RenderMaterialProps;\n    const instance = props.row;\n    elProps.paletteName = JsonUtils.asString(instance.paletteName);\n    return elProps;\n  }\n\n  /**\n   * RenderMaterialElement serializes 'paletteName'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override serialize(props: RenderMaterialProps, iModel: IModelDb): ECSqlRow {\n    const inst = super.serialize(props, iModel);\n    inst.paletteName = props.paletteName;\n    return inst;\n  }\n\n  /** Create a Code for a RenderMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModelDb\n   * @param scopeModelId The Id of the DefinitionModel that contains the RenderMaterial and provides the scope for its name.\n   * @param name The RenderMaterial name\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, name: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.renderMaterial);\n    return 0 === name.length ? Code.createEmpty() : new Code({ spec: codeSpec.id, scope: scopeModelId, value: name });\n  }\n  /**\n   * Create a RenderMaterial with given parameters.\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param materialName The name/CodeValue of the RenderMaterial\n   * @param params Parameters object which describes how to construct the RenderMaterial\n   * @returns The newly constructed RenderMaterial element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElementParams): RenderMaterialElement {\n    let maps: RenderMaterialAssetMapsProps | undefined;\n    const pbr_normal = params.normalMap?.scale;\n    if (params.patternMap || params.normalMap) {\n      // If both normal and pattern map are present, their texture mapping modes, angles, scales, etc are expected to match.\n      type TexMap = Omit<TextureMapProps, \"TextureId\">;\n      function choose<K extends keyof TexMap>(obj: TexMap, key: K): void {\n        const pat = params.patternMap;\n        if (pat && undefined !== pat[key])\n          obj[key] = pat[key];\n        else if (params.normalMap && undefined !== params.normalMap[key])\n          obj[key] = params.normalMap[key];\n      }\n\n      const baseProps: TexMap = {};\n      choose(baseProps, \"pattern_angle\");\n      choose(baseProps, \"pattern_u_flip\");\n      choose(baseProps, \"pattern_flip\");\n      choose(baseProps, \"pattern_scale\");\n      choose(baseProps, \"pattern_offset\");\n      choose(baseProps, \"pattern_scalemode\");\n      choose(baseProps, \"pattern_mapping\");\n      choose(baseProps, \"pattern_weight\");\n      choose(baseProps, \"pattern_useconstantlod\");\n      choose(baseProps, \"pattern_constantlod_repetitions\");\n      choose(baseProps, \"pattern_constantlod_offset\");\n      choose(baseProps, \"pattern_constantlod_mindistanceclamp\");\n      choose(baseProps, \"pattern_constantlod_maxdistanceclamp\");\n\n      maps = {};\n      if (params.patternMap)\n        maps.Pattern = { ...params.patternMap, ...baseProps };\n\n      if (params.normalMap) {\n        maps.Normal = {\n          ...params.normalMap,\n          ...baseProps,\n        };\n\n        delete (maps.Normal as any).scale;\n      }\n    }\n\n    // const map = undefined !== params.patternMap ? { Pattern: params.patternMap } : undefined;\n    const renderMaterialProps: RenderMaterialProps = {\n      classFullName: this.classFullName,\n      code: this.createCode(iModelDb, definitionModelId, materialName),\n      paletteName: params.paletteName,\n      description: params.description,\n      jsonProperties: {\n        materialAssets: {\n          renderMaterial: {\n            HasBaseColor: params.color !== undefined,\n            color: params.color,\n            HasSpecularColor: params.specularColor !== undefined,\n            specular_color: params.specularColor,\n            HasFinish: params.finish !== undefined,\n            finish: params.finish,\n            HasTransmit: params.transmit !== undefined,\n            transmit: params.transmit,\n            HasDiffuse: params.diffuse !== undefined,\n            diffuse: params.diffuse,\n            HasSpecular: params.specular !== undefined,\n            specular: params.specular,\n            HasReflect: params.reflect !== undefined,\n            reflect: params.reflect,\n            HasReflectColor: params.reflectColor !== undefined,\n            reflect_color: params.reflectColor,\n            Map: maps,\n            pbr_normal,\n          },\n        },\n      },\n      model: definitionModelId,\n      isPrivate: false,\n    };\n\n    return new RenderMaterialElement(renderMaterialProps, iModelDb);\n  }\n\n  /**\n   * Insert a new RenderMaterial into a model.\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new Texture into this DefinitionModel\n   * @param materialName The name/CodeValue of the RenderMaterial\n   * @param params Parameters object which describes how to construct the RenderMaterial\n   * @returns The Id of the newly inserted RenderMaterial element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElementParams): Id64String {\n    const renderMaterial = this.create(iModelDb, definitionModelId, materialName, params);\n    return iModelDb.elements.insertElement(renderMaterial.toJSON());\n  }\n\n  /** @beta */\n  protected static override onCloned(context: IModelElementCloneContext, sourceProps: ElementProps, targetProps: ElementProps) {\n    super.onCloned(context, sourceProps, targetProps);\n    for (const mapName in sourceProps.jsonProperties?.materialAssets?.renderMaterial?.Map ?? {}) {\n      if (typeof mapName !== \"string\")\n        continue;\n      const sourceMap = sourceProps.jsonProperties.materialAssets.renderMaterial.Map[mapName];\n      // sourceMap could be null/undefined, keep it the same in targetProps\n      if (!sourceMap) {\n        targetProps.jsonProperties.materialAssets.renderMaterial.Map[mapName] = sourceMap;\n        continue;\n      }\n      if (!Id64.isValid(sourceMap.TextureId) || sourceMap.TextureId === undefined)\n        continue;\n      targetProps.jsonProperties.materialAssets.renderMaterial.Map[mapName].TextureId = context.findTargetElementId(sourceMap.TextureId ?? Id64.invalid);\n    }\n  }\n}\n\n/** @public */\nexport namespace RenderMaterialElement {\n  /** Parameters used to construct a [[RenderMaterial]].\n   * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.\n   * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.\n   * @deprecated in 3.6 because it is not useful to use a `class` - just use [[RenderMaterialElementParams]] directly instead.\n   */\n  export class Params {\n    /** A required palette name that categorizes this RenderMaterial */\n    public paletteName: string;\n    /** An optional description of this RenderMaterial */\n    public description?: string;\n    /** If defined, the color to use for surface fill or diffuse illumination, overriding the surface's own color. */\n    public color?: RgbFactorProps;\n    /** The color to use for specular illumination. Default: black. */\n    public specularColor?: RgbFactorProps;\n    /** The specular exponent describing the surface's shininess, in the range 0 through 128.\n     * Default: 0.\n     */\n    public finish?: number;\n    /** A transparency to be applied to the surface, ranging from 0 (fully opaque) to 1 (fully transparent).\n     * The surface's own transparency will be multiplied by `(1 - transmit)`. permitting the material to increase but not decrease the surface transparency.\n     * Default: 13.5.\n     */\n    public transmit?: number;\n    /** The surface's diffuse reflectivity from 0.0 to 1.0. Default: 0.6. */\n    public diffuse?: number;\n    /** The surface's specular reflectivity from 0.0 to 1.0. Default: 0.0. */\n    public specular?: number;\n    /** Currently unused. */\n    public reflect?: number;\n    /** Currently unused. */\n    public reflectColor?: number[];\n    /** Specifies a texture image to map onto the surface, replacing or mixing with the surface's own color and transparency.\n     * @note With the exception of `TextureId`, the [TextureMapProps]($common) of [[patternMap]] and [[normalMap]] are expected to be identical. If a property is defined in both\n     * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.\n     */\n    public patternMap?: TextureMapProps;\n    /** Specifies a [normal map](https://en.wikipedia.org/wiki/Normal_mapping) to apply to the surface to simulate more surface detail than is present in the\n     * surface's geometry.\n     * @note With the exception of `TextureId`, the [TextureMapProps]($common) of [[patternMap]] and [[normalMap]] are expected to be identical. If a property is defined in both\n     * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.\n     */\n    public normalMap?: NormalMapProps & {\n      /** A factor by which to multiply the components of the normal vectors read from the texture.\n       * Default: 1.\n       */\n      scale?: number;\n    };\n\n    /** Construct a new RenderMaterial.Params object with the specified paletteName. Alter the public members on that object to specify settings. */\n    public constructor(paletteName: string) {\n      this.paletteName = paletteName;\n    }\n  }\n}\n\n/** Parameters used to create a [[RenderMaterial]] element.\n * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.\n * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.\n * @public\n */\nexport interface RenderMaterialElementParams extends RenderMaterialElement.Params { // eslint-disable-line @typescript-eslint/no-deprecated, @typescript-eslint/no-empty-object-type\n}\n"]}
+{"version":3,"file":"Material.js","sourceRoot":"","sources":["../../src/Material.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkE;AAClE,oDAE4B;AAC5B,uCAA8C;AAK9C,yDAAyD;AAEzD;;;GAGG;AACH,MAAsB,gBAAiB,SAAQ,2BAAiB;IACvD,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;IAC7E;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,iBAAiC,EAAE,IAAY;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,gBAAgB,CAAC,CAAC;QACpF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,iBAAiB,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAChF,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAA6B,QAAkB,EAAE,iBAAiC,EAAE,IAAY;QAClH,MAAM,YAAY,GAA2B;YAC3C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;SACzD,CAAC;QACF,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IACvD,CAAC;CACF;AA1BD,4CA0BC;AAED;;;GAGG;AACH,MAAa,qBAAsB,SAAQ,2BAAiB;IACnD,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAE3E,+EAA+E;IACxE,WAAW,CAAS;IAC3B,+CAA+C;IACxC,WAAW,CAAU;IAE5B,YAAoB,KAA0B,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;IACvC,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAyB,CAAC;QAClD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACnC,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACnC,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAmB,mBAAmB,GAA4B;QAChF,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;KACjD,CAAC;IAEF;;;;OAIG;IACI,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAwB,CAAC;QAChE,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC;QAC3B,OAAO,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC/D,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAU,SAAS,CAAC,KAA0B,EAAE,MAAgB;QAC3E,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,IAAY;QACnF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,cAAc,CAAC,CAAC;QAClF,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,kBAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACpH,CAAC;IACD;;;;;;;;OAQG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,YAAoB,EAAE,MAAmC;QAC/H,IAAI,IAA8C,CAAC;QACnD,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC;QAC3C,IAAI,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YAG1C,SAAS,MAAM,CAAyB,GAAW,EAAE,GAAM;gBACzD,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC;gBAC9B,IAAI,GAAG,IAAI,SAAS,KAAK,GAAG,CAAC,GAAG,CAAC;oBAC/B,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;qBACjB,IAAI,MAAM,CAAC,SAAS,IAAI,SAAS,KAAK,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;oBAC9D,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YACrC,CAAC;YAED,MAAM,SAAS,GAAW,EAAE,CAAC;YAC7B,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YACnC,MAAM,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;YACpC,MAAM,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;YAClC,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YACnC,MAAM,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;YACpC,MAAM,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;YACvC,MAAM,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;YACrC,MAAM,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;YACpC,MAAM,CAAC,SAAS,EAAE,wBAAwB,CAAC,CAAC;YAC5C,MAAM,CAAC,SAAS,EAAE,iCAAiC,CAAC,CAAC;YACrD,MAAM,CAAC,SAAS,EAAE,4BAA4B,CAAC,CAAC;YAChD,MAAM,CAAC,SAAS,EAAE,sCAAsC,CAAC,CAAC;YAC1D,MAAM,CAAC,SAAS,EAAE,sCAAsC,CAAC,CAAC;YAE1D,IAAI,GAAG,EAAE,CAAC;YACV,IAAI,MAAM,CAAC,UAAU;gBACnB,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,MAAM,CAAC,UAAU,EAAE,GAAG,SAAS,EAAE,CAAC;YAExD,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;gBACrB,IAAI,CAAC,MAAM,GAAG;oBACZ,GAAG,MAAM,CAAC,SAAS;oBACnB,GAAG,SAAS;iBACb,CAAC;gBAEF,OAAQ,IAAI,CAAC,MAAc,CAAC,KAAK,CAAC;YACpC,CAAC;QACH,CAAC;QAED,4FAA4F;QAC5F,MAAM,mBAAmB,GAAwB;YAC/C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,YAAY,CAAC;YAChE,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,cAAc,EAAE;gBACd,cAAc,EAAE;oBACd,cAAc,EAAE;wBACd,YAAY,EAAE,MAAM,CAAC,KAAK,KAAK,SAAS;wBACxC,KAAK,EAAE,MAAM,CAAC,KAAK;wBACnB,gBAAgB,EAAE,MAAM,CAAC,aAAa,KAAK,SAAS;wBACpD,cAAc,EAAE,MAAM,CAAC,aAAa;wBACpC,SAAS,EAAE,MAAM,CAAC,MAAM,KAAK,SAAS;wBACtC,MAAM,EAAE,MAAM,CAAC,MAAM;wBACrB,WAAW,EAAE,MAAM,CAAC,QAAQ,KAAK,SAAS;wBAC1C,QAAQ,EAAE,MAAM,CAAC,QAAQ;wBACzB,UAAU,EAAE,MAAM,CAAC,OAAO,KAAK,SAAS;wBACxC,OAAO,EAAE,MAAM,CAAC,OAAO;wBACvB,WAAW,EAAE,MAAM,CAAC,QAAQ,KAAK,SAAS;wBAC1C,QAAQ,EAAE,MAAM,CAAC,QAAQ;wBACzB,UAAU,EAAE,MAAM,CAAC,OAAO,KAAK,SAAS;wBACxC,OAAO,EAAE,MAAM,CAAC,OAAO;wBACvB,eAAe,EAAE,MAAM,CAAC,YAAY,KAAK,SAAS;wBAClD,aAAa,EAAE,MAAM,CAAC,YAAY;wBAClC,GAAG,EAAE,IAAI;wBACT,UAAU;qBACX;iBACF;aACF;YACD,KAAK,EAAE,iBAAiB;YACxB,SAAS,EAAE,KAAK;SACjB,CAAC;QAEF,OAAO,IAAI,qBAAqB,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,YAAoB,EAAE,MAAmC;QAC/H,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;QACtF,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,YAAY;IACF,MAAM,CAAU,QAAQ,CAAC,OAAkC,EAAE,WAAyB,EAAE,WAAyB;QACzH,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;QAClD,KAAK,MAAM,OAAO,IAAI,WAAW,CAAC,cAAc,EAAE,cAAc,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC;YAC5F,IAAI,OAAO,OAAO,KAAK,QAAQ;gBAC7B,SAAS;YACX,MAAM,SAAS,GAAG,WAAW,CAAC,cAAc,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACxF,qEAAqE;YACrE,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,WAAW,CAAC,cAAc,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;gBAClF,SAAS;YACX,CAAC;YACD,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,KAAK,SAAS;gBACzE,SAAS;YACX,WAAW,CAAC,cAAc,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC,SAAS,CAAC,SAAS,IAAI,mBAAI,CAAC,OAAO,CAAC,CAAC;QACrJ,CAAC;IACH,CAAC;;AArLH,sDAsLC;AAED,cAAc;AACd,WAAiB,qBAAqB;IACpC;;;;OAIG;IACH,MAAa,MAAM;QACjB,mEAAmE;QAC5D,WAAW,CAAS;QAC3B,qDAAqD;QAC9C,WAAW,CAAU;QAC5B,iHAAiH;QAC1G,KAAK,CAAkB;QAC9B,kEAAkE;QAC3D,aAAa,CAAkB;QACtC;;WAEG;QACI,MAAM,CAAU;QACvB;;;WAGG;QACI,QAAQ,CAAU;QACzB,wEAAwE;QACjE,OAAO,CAAU;QACxB,yEAAyE;QAClE,QAAQ,CAAU;QACzB,wBAAwB;QACjB,OAAO,CAAU;QACxB,wBAAwB;QACjB,YAAY,CAAY;QAC/B;;;WAGG;QACI,UAAU,CAAmB;QACpC;;;;WAIG;QACI,SAAS,CAKd;QAEF,gJAAgJ;QAChJ,YAAmB,WAAmB;YACpC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QACjC,CAAC;KACF;IA/CY,4BAAM,SA+ClB,CAAA;AACH,CAAC,EAtDgB,qBAAqB,qCAArB,qBAAqB,QAsDrC","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 Elements\r\n */\r\n\r\nimport { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\r\nimport {\r\n  BisCodeSpec, Code, CodeScopeProps, CodeSpec, DefinitionElementProps, ElementProps, NormalMapProps, RenderMaterialAssetMapsProps, RenderMaterialProps, RgbFactorProps, TextureMapProps,\r\n} from \"@itwin/core-common\";\r\nimport { DefinitionElement } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { IModelElementCloneContext } from \"./IModelElementCloneContext\";\r\nimport { CustomHandledProperty, DeserializeEntityArgs, ECSqlRow } from \"./Entity\";\r\n\r\n/* eslint-disable @typescript-eslint/naming-convention */\r\n\r\n/** A PhysicalMaterial defines the matter that makes up physical elements.\r\n * @note See [[RenderMaterialElement]] for the DefinitionElement used to define rendering characteristics.\r\n * @public\r\n */\r\nexport abstract class PhysicalMaterial extends DefinitionElement {\r\n  public static override get className(): string { return \"PhysicalMaterial\"; }\r\n  /** Create a Code for a PhysicalMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.\r\n   * @param iModel  The IModelDb\r\n   * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.\r\n   * @param name The name (codeValue) of the PhysicalMaterial\r\n   */\r\n  public static createCode(iModel: IModelDb, definitionModelId: CodeScopeProps, name: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.physicalMaterial);\r\n    return new Code({ spec: codeSpec.id, scope: definitionModelId, value: name });\r\n  }\r\n  /** Create a PhysicalMaterial\r\n   * @param iModelDb The IModelDb\r\n   * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.\r\n   * @param name The name (codeValue) of the PhysicalMaterial\r\n   * @returns The newly constructed PhysicalMaterial\r\n   * @throws [[IModelError]] if there is a problem creating the PhysicalMaterial\r\n   */\r\n  public static create<T extends PhysicalMaterial>(iModelDb: IModelDb, definitionModelId: CodeScopeProps, name: string): T {\r\n    const elementProps: DefinitionElementProps = {\r\n      classFullName: this.classFullName,\r\n      model: definitionModelId,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n    };\r\n    return iModelDb.elements.createElement(elementProps);\r\n  }\r\n}\r\n\r\n/** Defines a rendering material.\r\n * @note See [[PhysicalMaterial]] for the DefinitionElement used to define the matter that makes up physical elements.\r\n * @public\r\n */\r\nexport class RenderMaterialElement extends DefinitionElement {\r\n  public static override get className(): string { return \"RenderMaterial\"; }\r\n\r\n  /** The name of a palette that can be used to categorize multiple materials. */\r\n  public paletteName: string;\r\n  /** An optional description of the material. */\r\n  public description?: string;\r\n\r\n  private constructor(props: RenderMaterialProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.paletteName = props.paletteName;\r\n    this.description = props.description;\r\n  }\r\n\r\n  public override toJSON(): RenderMaterialProps {\r\n    const val = super.toJSON() as RenderMaterialProps;\r\n    val.paletteName = this.paletteName;\r\n    val.description = this.description;\r\n    return val;\r\n  }\r\n\r\n  /**\r\n   * RenderMaterialElement custom HandledProps includes 'paletteName'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\r\n    { propertyName: \"paletteName\", source: \"Class\" },\r\n  ];\r\n\r\n  /**\r\n   * RenderMaterialElement deserializes 'paletteName'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  public static override deserialize(props: DeserializeEntityArgs): RenderMaterialProps {\r\n    const elProps = super.deserialize(props) as RenderMaterialProps;\r\n    const instance = props.row;\r\n    elProps.paletteName = JsonUtils.asString(instance.paletteName);\r\n    return elProps;\r\n  }\r\n\r\n  /**\r\n   * RenderMaterialElement serializes 'paletteName'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  public static override serialize(props: RenderMaterialProps, iModel: IModelDb): ECSqlRow {\r\n    const inst = super.serialize(props, iModel);\r\n    inst.paletteName = props.paletteName;\r\n    return inst;\r\n  }\r\n\r\n  /** Create a Code for a RenderMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.\r\n   * @param iModel  The IModelDb\r\n   * @param scopeModelId The Id of the DefinitionModel that contains the RenderMaterial and provides the scope for its name.\r\n   * @param name The RenderMaterial name\r\n   */\r\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, name: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.renderMaterial);\r\n    return 0 === name.length ? Code.createEmpty() : new Code({ spec: codeSpec.id, scope: scopeModelId, value: name });\r\n  }\r\n  /**\r\n   * Create a RenderMaterial with given parameters.\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param materialName The name/CodeValue of the RenderMaterial\r\n   * @param params Parameters object which describes how to construct the RenderMaterial\r\n   * @returns The newly constructed RenderMaterial element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElementParams): RenderMaterialElement {\r\n    let maps: RenderMaterialAssetMapsProps | undefined;\r\n    const pbr_normal = params.normalMap?.scale;\r\n    if (params.patternMap || params.normalMap) {\r\n      // If both normal and pattern map are present, their texture mapping modes, angles, scales, etc are expected to match.\r\n      type TexMap = Omit<TextureMapProps, \"TextureId\">;\r\n      function choose<K extends keyof TexMap>(obj: TexMap, key: K): void {\r\n        const pat = params.patternMap;\r\n        if (pat && undefined !== pat[key])\r\n          obj[key] = pat[key];\r\n        else if (params.normalMap && undefined !== params.normalMap[key])\r\n          obj[key] = params.normalMap[key];\r\n      }\r\n\r\n      const baseProps: TexMap = {};\r\n      choose(baseProps, \"pattern_angle\");\r\n      choose(baseProps, \"pattern_u_flip\");\r\n      choose(baseProps, \"pattern_flip\");\r\n      choose(baseProps, \"pattern_scale\");\r\n      choose(baseProps, \"pattern_offset\");\r\n      choose(baseProps, \"pattern_scalemode\");\r\n      choose(baseProps, \"pattern_mapping\");\r\n      choose(baseProps, \"pattern_weight\");\r\n      choose(baseProps, \"pattern_useconstantlod\");\r\n      choose(baseProps, \"pattern_constantlod_repetitions\");\r\n      choose(baseProps, \"pattern_constantlod_offset\");\r\n      choose(baseProps, \"pattern_constantlod_mindistanceclamp\");\r\n      choose(baseProps, \"pattern_constantlod_maxdistanceclamp\");\r\n\r\n      maps = {};\r\n      if (params.patternMap)\r\n        maps.Pattern = { ...params.patternMap, ...baseProps };\r\n\r\n      if (params.normalMap) {\r\n        maps.Normal = {\r\n          ...params.normalMap,\r\n          ...baseProps,\r\n        };\r\n\r\n        delete (maps.Normal as any).scale;\r\n      }\r\n    }\r\n\r\n    // const map = undefined !== params.patternMap ? { Pattern: params.patternMap } : undefined;\r\n    const renderMaterialProps: RenderMaterialProps = {\r\n      classFullName: this.classFullName,\r\n      code: this.createCode(iModelDb, definitionModelId, materialName),\r\n      paletteName: params.paletteName,\r\n      description: params.description,\r\n      jsonProperties: {\r\n        materialAssets: {\r\n          renderMaterial: {\r\n            HasBaseColor: params.color !== undefined,\r\n            color: params.color,\r\n            HasSpecularColor: params.specularColor !== undefined,\r\n            specular_color: params.specularColor,\r\n            HasFinish: params.finish !== undefined,\r\n            finish: params.finish,\r\n            HasTransmit: params.transmit !== undefined,\r\n            transmit: params.transmit,\r\n            HasDiffuse: params.diffuse !== undefined,\r\n            diffuse: params.diffuse,\r\n            HasSpecular: params.specular !== undefined,\r\n            specular: params.specular,\r\n            HasReflect: params.reflect !== undefined,\r\n            reflect: params.reflect,\r\n            HasReflectColor: params.reflectColor !== undefined,\r\n            reflect_color: params.reflectColor,\r\n            Map: maps,\r\n            pbr_normal,\r\n          },\r\n        },\r\n      },\r\n      model: definitionModelId,\r\n      isPrivate: false,\r\n    };\r\n\r\n    return new RenderMaterialElement(renderMaterialProps, iModelDb);\r\n  }\r\n\r\n  /**\r\n   * Insert a new RenderMaterial into a model.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param definitionModelId Insert the new Texture into this DefinitionModel\r\n   * @param materialName The name/CodeValue of the RenderMaterial\r\n   * @param params Parameters object which describes how to construct the RenderMaterial\r\n   * @returns The Id of the newly inserted RenderMaterial element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElementParams): Id64String {\r\n    const renderMaterial = this.create(iModelDb, definitionModelId, materialName, params);\r\n    return iModelDb.elements.insertElement(renderMaterial.toJSON());\r\n  }\r\n\r\n  /** @beta */\r\n  protected static override onCloned(context: IModelElementCloneContext, sourceProps: ElementProps, targetProps: ElementProps) {\r\n    super.onCloned(context, sourceProps, targetProps);\r\n    for (const mapName in sourceProps.jsonProperties?.materialAssets?.renderMaterial?.Map ?? {}) {\r\n      if (typeof mapName !== \"string\")\r\n        continue;\r\n      const sourceMap = sourceProps.jsonProperties.materialAssets.renderMaterial.Map[mapName];\r\n      // sourceMap could be null/undefined, keep it the same in targetProps\r\n      if (!sourceMap) {\r\n        targetProps.jsonProperties.materialAssets.renderMaterial.Map[mapName] = sourceMap;\r\n        continue;\r\n      }\r\n      if (!Id64.isValid(sourceMap.TextureId) || sourceMap.TextureId === undefined)\r\n        continue;\r\n      targetProps.jsonProperties.materialAssets.renderMaterial.Map[mapName].TextureId = context.findTargetElementId(sourceMap.TextureId ?? Id64.invalid);\r\n    }\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport namespace RenderMaterialElement {\r\n  /** Parameters used to construct a [[RenderMaterial]].\r\n   * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.\r\n   * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.\r\n   * @deprecated in 3.6 - might be removed in next major version. Because it is not useful to use a `class` - just use [[RenderMaterialElementParams]] directly instead.\r\n   */\r\n  export class Params {\r\n    /** A required palette name that categorizes this RenderMaterial */\r\n    public paletteName: string;\r\n    /** An optional description of this RenderMaterial */\r\n    public description?: string;\r\n    /** If defined, the color to use for surface fill or diffuse illumination, overriding the surface's own color. */\r\n    public color?: RgbFactorProps;\r\n    /** The color to use for specular illumination. Default: black. */\r\n    public specularColor?: RgbFactorProps;\r\n    /** The specular exponent describing the surface's shininess, in the range 0 through 128.\r\n     * Default: 0.\r\n     */\r\n    public finish?: number;\r\n    /** A transparency to be applied to the surface, ranging from 0 (fully opaque) to 1 (fully transparent).\r\n     * The surface's own transparency will be multiplied by `(1 - transmit)`. permitting the material to increase but not decrease the surface transparency.\r\n     * Default: 13.5.\r\n     */\r\n    public transmit?: number;\r\n    /** The surface's diffuse reflectivity from 0.0 to 1.0. Default: 0.6. */\r\n    public diffuse?: number;\r\n    /** The surface's specular reflectivity from 0.0 to 1.0. Default: 0.0. */\r\n    public specular?: number;\r\n    /** Currently unused. */\r\n    public reflect?: number;\r\n    /** Currently unused. */\r\n    public reflectColor?: number[];\r\n    /** Specifies a texture image to map onto the surface, replacing or mixing with the surface's own color and transparency.\r\n     * @note With the exception of `TextureId`, the [TextureMapProps]($common) of [[patternMap]] and [[normalMap]] are expected to be identical. If a property is defined in both\r\n     * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.\r\n     */\r\n    public patternMap?: TextureMapProps;\r\n    /** Specifies a [normal map](https://en.wikipedia.org/wiki/Normal_mapping) to apply to the surface to simulate more surface detail than is present in the\r\n     * surface's geometry.\r\n     * @note With the exception of `TextureId`, the [TextureMapProps]($common) of [[patternMap]] and [[normalMap]] are expected to be identical. If a property is defined in both\r\n     * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.\r\n     */\r\n    public normalMap?: NormalMapProps & {\r\n      /** A factor by which to multiply the components of the normal vectors read from the texture.\r\n       * Default: 1.\r\n       */\r\n      scale?: number;\r\n    };\r\n\r\n    /** Construct a new RenderMaterial.Params object with the specified paletteName. Alter the public members on that object to specify settings. */\r\n    public constructor(paletteName: string) {\r\n      this.paletteName = paletteName;\r\n    }\r\n  }\r\n}\r\n\r\n/** Parameters used to create a [[RenderMaterial]] element.\r\n * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.\r\n * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.\r\n * @public\r\n */\r\nexport interface RenderMaterialElementParams extends RenderMaterialElement.Params { // eslint-disable-line @typescript-eslint/no-deprecated, @typescript-eslint/no-empty-object-type\r\n}\r\n"]}

package/lib/cjs/Model.d.ts

@@ -44,7 +44,7 @@ export interface OnElementInModelIdArg extends OnModelIdArg {
 /** A Model is a container for persisting a collection of related elements within an iModel.
  * See [[IModelDb.Models]] for how to query and manage the Models in an IModelDb.
  * See [Creating models]($docs/learning/backend/CreateModels.md)
- * @public
+ * @public @preview
  */
 export declare class Model extends Entity {
     static get className(): string;
@@ -174,7 +174,7 @@ export declare class Model extends Entity {
     protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
 }
 /** A container for persisting geometric elements.
- * @public
+ * @public @preview
  */
 export declare class GeometricModel extends Model {
     geometryGuid?: GuidString;
@@ -188,7 +188,7 @@ export declare class GeometricModel extends Model {
     queryRange(): Promise<AxisAlignedBox3d>;
 }
 /** A container for persisting 3d geometric elements.
- * @public
+ * @public @preview
  */
 export declare abstract class GeometricModel3d extends GeometricModel {
     /** If true, then the elements in this GeometricModel3d are expected to be in an XY plane.
@@ -224,7 +224,7 @@ export declare abstract class GeometricModel3d extends GeometricModel {
     toJSON(): GeometricModel3dProps;
 }
 /** A container for persisting 2d geometric elements.
- * @public
+ * @public @preview
  */
 export declare abstract class GeometricModel2d extends GeometricModel {
     /** The actual coordinates of (0,0) in modeling coordinates. An offset applied to all modeling coordinates. */
@@ -234,7 +234,7 @@ export declare abstract class GeometricModel2d extends GeometricModel {
     toJSON(): GeometricModel2dProps;
 }
 /** A container for persisting 2d graphical elements.
- * @public
+ * @public @preview
  */
 export declare abstract class GraphicalModel2d extends GeometricModel2d {
     static get className(): string;
@@ -242,20 +242,20 @@ export declare abstract class GraphicalModel2d extends GeometricModel2d {
 /** A container for persisting GraphicalElement3d instances.
  * @note The associated ECClass was added to the BisCore schema in version 1.0.8
  * @see [[GraphicalPartition3d]]
- * @public
+ * @public @preview
  */
 export declare abstract class GraphicalModel3d extends GeometricModel3d {
     static get className(): string;
 }
 /** A container for persisting 3d geometric elements that are spatially located.
- * @public
+ * @public @preview
  */
 export declare abstract class SpatialModel extends GeometricModel3d {
     static get className(): string;
 }
 /** A container for persisting physical elements that model physical space.
  * @see [[PhysicalPartition]]
- * @public
+ * @public @preview
  */
 export declare class PhysicalModel extends SpatialModel {
     static get className(): string;
@@ -271,7 +271,7 @@ export declare class PhysicalModel extends SpatialModel {
 }
 /** A container for persisting spatial location elements.
  * @see [[SpatialLocationPartition]]
- * @public
+ * @public @preview
  */
 export declare class SpatialLocationModel extends SpatialModel {
     static get className(): string;
@@ -286,13 +286,13 @@ export declare class SpatialLocationModel extends SpatialModel {
     static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string, isPlanProjection?: boolean): Id64String;
 }
 /** A 2d model that holds [[DrawingGraphic]]s. DrawingModels may be dimensional or non-dimensional.
- * @public
+ * @public @preview
  */
 export declare class DrawingModel extends GraphicalModel2d {
     static get className(): string;
 }
 /** A container for persisting section [[DrawingGraphic]]s.
- * @public
+ * @public @preview
  */
 export declare class SectionDrawingModel extends DrawingModel {
     static get className(): string;
@@ -300,26 +300,26 @@ export declare class SectionDrawingModel extends DrawingModel {
 /** A container for persisting [[ViewAttachment]]s and [[DrawingGraphic]]s.
  * A SheetModel is a digital representation of a *sheet of paper*. SheetModels are 2d models in bounded paper coordinates.
  * SheetModels may contain annotation Elements as well as references to 2d or 3d Views.
- * @public
+ * @public @preview
  */
 export declare class SheetModel extends GraphicalModel2d {
     static get className(): string;
 }
 /** A container for persisting role elements.
- * @public
+ * @public @preview
  */
 export declare class RoleModel extends Model {
     static get className(): string;
 }
 /** A container for persisting information elements.
- * @public
+ * @public @preview
  */
 export declare abstract class InformationModel extends Model {
     static get className(): string;
 }
 /** A container for persisting group information elements.
  * @see [[GroupInformationPartition]]
- * @public
+ * @public @preview
  */
 export declare abstract class GroupInformationModel extends InformationModel {
     static get className(): string;
@@ -340,7 +340,7 @@ export declare class SheetIndexModel extends InformationModel {
 }
 /** A container for persisting Information Record Elements
  * @see [[InformationRecordPartition]]
- * @public
+ * @public @preview
  */
 export declare class InformationRecordModel extends InformationModel {
     static get className(): string;
@@ -355,7 +355,7 @@ export declare class InformationRecordModel extends InformationModel {
 }
 /** A container for persisting definition elements.
  * @see [[DefinitionPartition]]
- * @public
+ * @public @preview
  */
 export declare class DefinitionModel extends InformationModel {
     static get className(): string;
@@ -369,14 +369,14 @@ export declare class DefinitionModel extends InformationModel {
     static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string): Id64String;
 }
 /** The singleton container of repository-related information elements.
- * @public
+ * @public @preview
  */
 export declare class RepositoryModel extends DefinitionModel {
     static get className(): string;
 }
 /** Contains a list of document elements.
  * @see [[DocumentPartition]]
- * @public
+ * @public @preview
  */
 export declare class DocumentListModel extends InformationModel {
     static get className(): string;
@@ -391,19 +391,19 @@ export declare class DocumentListModel extends InformationModel {
 }
 /** A container for persisting link elements.
  * @see [[LinkPartition]]
- * @public
+ * @public @preview
  */
 export declare class LinkModel extends InformationModel {
     static get className(): string;
 }
 /** The singleton container for repository-specific definition elements.
- * @public
+ * @public @preview
  */
 export declare class DictionaryModel extends DefinitionModel {
     static get className(): string;
 }
 /** Obtains and displays multi-resolution tiled raster organized according to the WebMercator tiling system.
- * @public
+ * @public @preview
  */
 export declare class WebMercatorModel extends SpatialModel {
     static get className(): string;

package/lib/cjs/Model.js

@@ -19,7 +19,7 @@ const Symbols_1 = require("./internal/Symbols");
 /** A Model is a container for persisting a collection of related elements within an iModel.
  * See [[IModelDb.Models]] for how to query and manage the Models in an IModelDb.
  * See [Creating models]($docs/learning/backend/CreateModels.md)
- * @public
+ * @public @preview
  */
 class Model extends Entity_1.Entity {
     static get className() { return "Model"; }
@@ -220,7 +220,7 @@ class Model extends Entity_1.Entity {
 }
 exports.Model = Model;
 /** A container for persisting geometric elements.
- * @public
+ * @public @preview
  */
 class GeometricModel extends Model {
     geometryGuid;
@@ -243,7 +243,7 @@ class GeometricModel extends Model {
 }
 exports.GeometricModel = GeometricModel;
 /** A container for persisting 3d geometric elements.
- * @public
+ * @public @preview
  */
 class GeometricModel3d extends GeometricModel {
     /** If true, then the elements in this GeometricModel3d are expected to be in an XY plane.
@@ -307,7 +307,7 @@ class GeometricModel3d extends GeometricModel {
 }
 exports.GeometricModel3d = GeometricModel3d;
 /** A container for persisting 2d geometric elements.
- * @public
+ * @public @preview
  */
 class GeometricModel2d extends GeometricModel {
     /** The actual coordinates of (0,0) in modeling coordinates. An offset applied to all modeling coordinates. */
@@ -326,7 +326,7 @@ class GeometricModel2d extends GeometricModel {
 }
 exports.GeometricModel2d = GeometricModel2d;
 /** A container for persisting 2d graphical elements.
- * @public
+ * @public @preview
  */
 class GraphicalModel2d extends GeometricModel2d {
     static get className() { return "GraphicalModel2d"; }
@@ -335,14 +335,14 @@ exports.GraphicalModel2d = GraphicalModel2d;
 /** A container for persisting GraphicalElement3d instances.
  * @note The associated ECClass was added to the BisCore schema in version 1.0.8
  * @see [[GraphicalPartition3d]]
- * @public
+ * @public @preview
  */
 class GraphicalModel3d extends GeometricModel3d {
     static get className() { return "GraphicalModel3d"; }
 }
 exports.GraphicalModel3d = GraphicalModel3d;
 /** A container for persisting 3d geometric elements that are spatially located.
- * @public
+ * @public @preview
  */
 class SpatialModel extends GeometricModel3d {
     static get className() { return "SpatialModel"; }
@@ -350,7 +350,7 @@ class SpatialModel extends GeometricModel3d {
 exports.SpatialModel = SpatialModel;
 /** A container for persisting physical elements that model physical space.
  * @see [[PhysicalPartition]]
- * @public
+ * @public @preview
  */
 class PhysicalModel extends SpatialModel {
     static get className() { return "PhysicalModel"; }
@@ -381,7 +381,7 @@ class PhysicalModel extends SpatialModel {
 exports.PhysicalModel = PhysicalModel;
 /** A container for persisting spatial location elements.
  * @see [[SpatialLocationPartition]]
- * @public
+ * @public @preview
  */
 class SpatialLocationModel extends SpatialModel {
     static get className() { return "SpatialLocationModel"; }
@@ -411,14 +411,14 @@ class SpatialLocationModel extends SpatialModel {
 }
 exports.SpatialLocationModel = SpatialLocationModel;
 /** A 2d model that holds [[DrawingGraphic]]s. DrawingModels may be dimensional or non-dimensional.
- * @public
+ * @public @preview
  */
 class DrawingModel extends GraphicalModel2d {
     static get className() { return "DrawingModel"; }
 }
 exports.DrawingModel = DrawingModel;
 /** A container for persisting section [[DrawingGraphic]]s.
- * @public
+ * @public @preview
  */
 class SectionDrawingModel extends DrawingModel {
     static get className() { return "SectionDrawingModel"; }
@@ -427,21 +427,21 @@ exports.SectionDrawingModel = SectionDrawingModel;
 /** A container for persisting [[ViewAttachment]]s and [[DrawingGraphic]]s.
  * A SheetModel is a digital representation of a *sheet of paper*. SheetModels are 2d models in bounded paper coordinates.
  * SheetModels may contain annotation Elements as well as references to 2d or 3d Views.
- * @public
+ * @public @preview
  */
 class SheetModel extends GraphicalModel2d {
     static get className() { return "SheetModel"; }
 }
 exports.SheetModel = SheetModel;
 /** A container for persisting role elements.
- * @public
+ * @public @preview
  */
 class RoleModel extends Model {
     static get className() { return "RoleModel"; }
 }
 exports.RoleModel = RoleModel;
 /** A container for persisting information elements.
- * @public
+ * @public @preview
  */
 class InformationModel extends Model {
     static get className() { return "InformationModel"; }
@@ -449,7 +449,7 @@ class InformationModel extends Model {
 exports.InformationModel = InformationModel;
 /** A container for persisting group information elements.
  * @see [[GroupInformationPartition]]
- * @public
+ * @public @preview
  */
 class GroupInformationModel extends InformationModel {
     static get className() { return "GroupInformationModel"; }
@@ -484,7 +484,7 @@ class SheetIndexModel extends InformationModel {
 exports.SheetIndexModel = SheetIndexModel;
 /** A container for persisting Information Record Elements
  * @see [[InformationRecordPartition]]
- * @public
+ * @public @preview
  */
 class InformationRecordModel extends InformationModel {
     static get className() { return "InformationRecordModel"; }
@@ -512,7 +512,7 @@ class InformationRecordModel extends InformationModel {
 exports.InformationRecordModel = InformationRecordModel;
 /** A container for persisting definition elements.
  * @see [[DefinitionPartition]]
- * @public
+ * @public @preview
  */
 class DefinitionModel extends InformationModel {
     static get className() { return "DefinitionModel"; }
@@ -539,7 +539,7 @@ class DefinitionModel extends InformationModel {
 }
 exports.DefinitionModel = DefinitionModel;
 /** The singleton container of repository-related information elements.
- * @public
+ * @public @preview
  */
 class RepositoryModel extends DefinitionModel {
     static get className() { return "RepositoryModel"; }
@@ -547,7 +547,7 @@ class RepositoryModel extends DefinitionModel {
 exports.RepositoryModel = RepositoryModel;
 /** Contains a list of document elements.
  * @see [[DocumentPartition]]
- * @public
+ * @public @preview
  */
 class DocumentListModel extends InformationModel {
     static get className() { return "DocumentListModel"; }
@@ -575,21 +575,21 @@ class DocumentListModel extends InformationModel {
 exports.DocumentListModel = DocumentListModel;
 /** A container for persisting link elements.
  * @see [[LinkPartition]]
- * @public
+ * @public @preview
  */
 class LinkModel extends InformationModel {
     static get className() { return "LinkModel"; }
 }
 exports.LinkModel = LinkModel;
 /** The singleton container for repository-specific definition elements.
- * @public
+ * @public @preview
  */
 class DictionaryModel extends DefinitionModel {
     static get className() { return "DictionaryModel"; }
 }
 exports.DictionaryModel = DictionaryModel;
 /** Obtains and displays multi-resolution tiled raster organized according to the WebMercator tiling system.
- * @public
+ * @public @preview
  */
 class WebMercatorModel extends SpatialModel {
     static get className() { return "WebMercatorModel"; }