@itwin/core-backend 5.0.0-dev.11 → 5.0.0-dev.111

package/lib/cjs/LocalhostIpcHost.js.map

@@ -1 +1 @@
-{"version":3,"file":"LocalhostIpcHost.js","sourceRoot":"","sources":["../../src/LocalhostIpcHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yBAAyB;AACzB,oDAE4B;AAE5B,uCAAgD;AAQhD,MAAM,cAAe,SAAQ,mCAAqB;IAIhD,YAAmB,IAA0B;QAC3C,KAAK,EAAE,CAAC;QAHF,iBAAY,GAAoB,IAAI,GAAG,EAAE,CAAC;QAKhD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC,CAAC;YAChE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;QACtF,CAAC;IACH,CAAC;IAEM,IAAI,CAAC,OAA4B;QACtC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE;YAC7C,OAAO,CAAC,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC;YAC5B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;YACpD,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACtC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,OAAO,CAAC,UAAc;QAC3B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC;QAEtC,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YACtC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAC5D,IAAI,iCAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;gBACtC,OAAO;YACT,CAAC;YAED,KAAK,MAAM,QAAQ,IAAI,0BAAY,CAAC,SAAS,EAAE,CAAC;gBAC9C,QAAQ,CAAC,EAAW,EAAE,OAAO,CAAC,CAAC;YACjC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAC1B,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACrC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,UAAW,SAAQ,oBAAU;IAAnC;;QACS,gBAAW,GAAG,+BAAiB,CAAC,WAAW,CAAC;IAOrD,CAAC;IALQ,KAAK,CAAC,OAAO,CAAC,IAA2B;QAC9C,MAAM,UAAU,GAAG,kCAAoB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACrD,MAAM,WAAW,GAAG,MAAM,UAAU,CAAC,WAAW,CAAC;QACjD,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,sEAAsE;IACpK,CAAC;CACF;AAED,gBAAgB;AAChB,MAAa,gBAAgB;IAIpB,MAAM,CAAC,OAAO,CAAC,UAAc;QACjC,0BAAY,CAAC,SAA4B,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACjE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAkF;QAC5G,IAAI,eAAe,GAAG,KAAK,CAAC;QAE5B,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,eAAe,GAAG,IAAI,CAAC;YACvB,0BAAY,CAAC,SAAS,GAAG,IAAI,cAAc,CAAC,IAAI,EAAE,gBAAgB,IAAI,EAAE,CAAC,CAAC;YAC1E,IAAI,CAAC,MAAM,GAAG,IAAI,iCAAmB,EAAE,CAAC;YACxC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAC3B,CAAC;QAED,MAAM,iBAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;QAE1F,IAAI,eAAe;YACjB,UAAU,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC;;AAtBH,4CAuBC;AAtBgB,6BAAY,GAAG,KAAK,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 IModelHost\r\n */\r\n\r\nimport * as ws from \"ws\";\r\nimport {\r\n  InterceptedRpcRequest, IpcWebSocket, IpcWebSocketBackend, IpcWebSocketMessage, IpcWebSocketTransport, rpcOverIpcStrings, RpcSessionInvocation,\r\n} from \"@itwin/core-common\";\r\nimport { IModelHostOptions } from \"./IModelHost\";\r\nimport { IpcHandler, IpcHost } from \"./IpcHost\";\r\n\r\n/** @internal */\r\nexport interface LocalhostIpcHostOpts {\r\n  socketPort?: number;\r\n  noServer?: boolean;\r\n}\r\n\r\nclass LocalTransport extends IpcWebSocketTransport {\r\n  private _server: ws.Server | undefined;\r\n  private _connections: Map<ws, number> = new Map();\r\n\r\n  public constructor(opts: LocalhostIpcHostOpts) {\r\n    super();\r\n\r\n    if (!opts.noServer) {\r\n      this._server = new ws.Server({ port: opts.socketPort ?? 3002 });\r\n      this._server.on(\"connection\", (connection) => LocalhostIpcHost.connect(connection));\r\n    }\r\n  }\r\n\r\n  public send(message: IpcWebSocketMessage): void {\r\n    this._connections.forEach((last, connection) => {\r\n      message.sequence = last + 1;\r\n      this._connections.set(connection, message.sequence);\r\n      const parts = this.serialize(message);\r\n      parts.forEach((part) => connection.send(part));\r\n    });\r\n  }\r\n\r\n  public connect(connection: ws) {\r\n    this._connections.set(connection, -1);\r\n\r\n    connection.on(\"message\", async (data) => {\r\n      const message = await this.notifyIncoming(data, connection);\r\n      if (IpcWebSocketMessage.skip(message)) {\r\n        return;\r\n      }\r\n\r\n      for (const listener of IpcWebSocket.receivers) {\r\n        listener({} as Event, message);\r\n      }\r\n    });\r\n\r\n    connection.on(\"close\", () => {\r\n      this._connections.delete(connection);\r\n      this.notifyClose(connection);\r\n    });\r\n  }\r\n}\r\n\r\nclass RpcHandler extends IpcHandler {\r\n  public channelName = rpcOverIpcStrings.channelName;\r\n\r\n  public async request(info: InterceptedRpcRequest) {\r\n    const invocation = RpcSessionInvocation.create(info);\r\n    const fulfillment = await invocation.fulfillment;\r\n    return invocation.rejected ? Promise.reject(fulfillment.rawResult) : fulfillment.rawResult; // eslint-disable-line @typescript-eslint/prefer-promise-reject-errors\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport class LocalhostIpcHost {\r\n  private static _initialized = false;\r\n  public static socket: IpcWebSocketBackend;\r\n\r\n  public static connect(connection: ws) {\r\n    (IpcWebSocket.transport as LocalTransport).connect(connection);\r\n  }\r\n\r\n  public static async startup(opts?: { localhostIpcHost?: LocalhostIpcHostOpts, iModelHost?: IModelHostOptions }) {\r\n    let registerHandler = false;\r\n\r\n    if (!this._initialized) {\r\n      registerHandler = true;\r\n      IpcWebSocket.transport = new LocalTransport(opts?.localhostIpcHost ?? {});\r\n      this.socket = new IpcWebSocketBackend();\r\n      this._initialized = true;\r\n    }\r\n\r\n    await IpcHost.startup({ ipcHost: { socket: this.socket }, iModelHost: opts?.iModelHost });\r\n\r\n    if (registerHandler)\r\n      RpcHandler.register();\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"LocalhostIpcHost.js","sourceRoot":"","sources":["../../src/LocalhostIpcHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yBAAyB;AACzB,oDAE4B;AAE5B,uCAAgD;AAQhD,MAAM,cAAe,SAAQ,mCAAqB;IACxC,OAAO,CAAwB;IAC/B,YAAY,GAAoB,IAAI,GAAG,EAAE,CAAC;IAElD,YAAmB,IAA0B;QAC3C,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC,CAAC;YAChE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;QACtF,CAAC;IACH,CAAC;IAEM,IAAI,CAAC,OAA4B;QACtC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE;YAC7C,OAAO,CAAC,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC;YAC5B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;YACpD,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACtC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,OAAO,CAAC,UAAc;QAC3B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC;QAEtC,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YACtC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAC5D,IAAI,iCAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;gBACtC,OAAO;YACT,CAAC;YAED,KAAK,MAAM,QAAQ,IAAI,0BAAY,CAAC,SAAS,EAAE,CAAC;gBAC9C,QAAQ,CAAC,EAAW,EAAE,OAAO,CAAC,CAAC;YACjC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAC1B,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACrC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,UAAW,SAAQ,oBAAU;IAC1B,WAAW,GAAG,+BAAiB,CAAC,WAAW,CAAC;IAE5C,KAAK,CAAC,OAAO,CAAC,IAA2B;QAC9C,MAAM,UAAU,GAAG,kCAAoB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACrD,MAAM,WAAW,GAAG,MAAM,UAAU,CAAC,WAAW,CAAC;QACjD,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,sEAAsE;IACpK,CAAC;CACF;AAED,gBAAgB;AAChB,MAAa,gBAAgB;IACnB,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC;IAC7B,MAAM,CAAC,MAAM,CAAsB;IAEnC,MAAM,CAAC,OAAO,CAAC,UAAc;QACjC,0BAAY,CAAC,SAA4B,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACjE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAkF;QAC5G,IAAI,eAAe,GAAG,KAAK,CAAC;QAE5B,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,eAAe,GAAG,IAAI,CAAC;YACvB,0BAAY,CAAC,SAAS,GAAG,IAAI,cAAc,CAAC,IAAI,EAAE,gBAAgB,IAAI,EAAE,CAAC,CAAC;YAC1E,IAAI,CAAC,MAAM,GAAG,IAAI,iCAAmB,EAAE,CAAC;YACxC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAC3B,CAAC;QAED,MAAM,iBAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;QAE1F,IAAI,eAAe;YACjB,UAAU,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC;;AAtBH,4CAuBC","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 IModelHost\n */\n\nimport * as ws from \"ws\";\nimport {\n  InterceptedRpcRequest, IpcWebSocket, IpcWebSocketBackend, IpcWebSocketMessage, IpcWebSocketTransport, rpcOverIpcStrings, RpcSessionInvocation,\n} from \"@itwin/core-common\";\nimport { IModelHostOptions } from \"./IModelHost\";\nimport { IpcHandler, IpcHost } from \"./IpcHost\";\n\n/** @internal */\nexport interface LocalhostIpcHostOpts {\n  socketPort?: number;\n  noServer?: boolean;\n}\n\nclass LocalTransport extends IpcWebSocketTransport {\n  private _server: ws.Server | undefined;\n  private _connections: Map<ws, number> = new Map();\n\n  public constructor(opts: LocalhostIpcHostOpts) {\n    super();\n\n    if (!opts.noServer) {\n      this._server = new ws.Server({ port: opts.socketPort ?? 3002 });\n      this._server.on(\"connection\", (connection) => LocalhostIpcHost.connect(connection));\n    }\n  }\n\n  public send(message: IpcWebSocketMessage): void {\n    this._connections.forEach((last, connection) => {\n      message.sequence = last + 1;\n      this._connections.set(connection, message.sequence);\n      const parts = this.serialize(message);\n      parts.forEach((part) => connection.send(part));\n    });\n  }\n\n  public connect(connection: ws) {\n    this._connections.set(connection, -1);\n\n    connection.on(\"message\", async (data) => {\n      const message = await this.notifyIncoming(data, connection);\n      if (IpcWebSocketMessage.skip(message)) {\n        return;\n      }\n\n      for (const listener of IpcWebSocket.receivers) {\n        listener({} as Event, message);\n      }\n    });\n\n    connection.on(\"close\", () => {\n      this._connections.delete(connection);\n      this.notifyClose(connection);\n    });\n  }\n}\n\nclass RpcHandler extends IpcHandler {\n  public channelName = rpcOverIpcStrings.channelName;\n\n  public async request(info: InterceptedRpcRequest) {\n    const invocation = RpcSessionInvocation.create(info);\n    const fulfillment = await invocation.fulfillment;\n    return invocation.rejected ? Promise.reject(fulfillment.rawResult) : fulfillment.rawResult; // eslint-disable-line @typescript-eslint/prefer-promise-reject-errors\n  }\n}\n\n/** @internal */\nexport class LocalhostIpcHost {\n  private static _initialized = false;\n  public static socket: IpcWebSocketBackend;\n\n  public static connect(connection: ws) {\n    (IpcWebSocket.transport as LocalTransport).connect(connection);\n  }\n\n  public static async startup(opts?: { localhostIpcHost?: LocalhostIpcHostOpts, iModelHost?: IModelHostOptions }) {\n    let registerHandler = false;\n\n    if (!this._initialized) {\n      registerHandler = true;\n      IpcWebSocket.transport = new LocalTransport(opts?.localhostIpcHost ?? {});\n      this.socket = new IpcWebSocketBackend();\n      this._initialized = true;\n    }\n\n    await IpcHost.startup({ ipcHost: { socket: this.socket }, iModelHost: opts?.iModelHost });\n\n    if (registerHandler)\n      RpcHandler.register();\n  }\n}\n"]}

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":["/*---------------------------------------------------------------------------------------------\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"]}
+{"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"]}

package/lib/cjs/Material.d.ts

@@ -6,6 +6,7 @@ import { Code, CodeScopeProps, ElementProps, NormalMapProps, RenderMaterialProps
 import { DefinitionElement } from "./Element";
 import { IModelDb } from "./IModelDb";
 import { IModelElementCloneContext } from "./IModelElementCloneContext";
+import { CustomHandledProperty, DeserializeEntityArgs, ECSqlRow } from "./Entity";
 /** A PhysicalMaterial defines the matter that makes up physical elements.
  * @note See [[RenderMaterialElement]] for the DefinitionElement used to define rendering characteristics.
  * @public
@@ -39,6 +40,24 @@ export declare class RenderMaterialElement extends DefinitionElement {
     description?: string;
     private constructor();
     toJSON(): RenderMaterialProps;
+    /**
+     * RenderMaterialElement custom HandledProps includes 'paletteName'.
+     * @inheritdoc
+     * @beta
+     */
+    protected static readonly _customHandledProps: CustomHandledProperty[];
+    /**
+     * RenderMaterialElement deserializes 'paletteName'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props: DeserializeEntityArgs): RenderMaterialProps;
+    /**
+     * RenderMaterialElement serializes 'paletteName'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props: RenderMaterialProps, iModel: IModelDb): ECSqlRow;
     /** Create a Code for a RenderMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
      * @param iModel  The IModelDb
      * @param scopeModelId The Id of the DefinitionModel that contains the RenderMaterial and provides the scope for its name.

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

@@ -1 +1 @@
-{"version":3,"file":"Material.d.ts","sourceRoot":"","sources":["../../src/Material.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EACQ,IAAI,EAAE,cAAc,EAAoC,YAAY,EAAE,cAAc,EAAgC,mBAAmB,EAAE,cAAc,EAAE,eAAe,EACtL,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAIxE;;;GAGG;AACH,8BAAsB,gBAAiB,SAAQ,iBAAiB;IAC9D,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,iBAAiB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAIjG;;;;;;OAMG;WACW,MAAM,CAAC,CAAC,SAAS,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;CAQzH;AAED;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,iBAAiB;IAC1D,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAE3E,+EAA+E;IACxE,WAAW,EAAE,MAAM,CAAC;IAC3B,+CAA+C;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE5B,OAAO;IAMS,MAAM,IAAI,mBAAmB;IAM7C;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAI5F;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,2BAA2B,GAAG,qBAAqB;IAgFzJ;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,2BAA2B,GAAG,UAAU;IAK9I,YAAY;qBACc,QAAQ,CAAC,OAAO,EAAE,yBAAyB,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,YAAY;CAgB5H;AAED,cAAc;AACd,yBAAiB,qBAAqB,CAAC;IACrC;;;;OAIG;IACH,MAAa,MAAM;QACjB,mEAAmE;QAC5D,WAAW,EAAE,MAAM,CAAC;QAC3B,qDAAqD;QAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;QAC5B,iHAAiH;QAC1G,KAAK,CAAC,EAAE,cAAc,CAAC;QAC9B,kEAAkE;QAC3D,aAAa,CAAC,EAAE,cAAc,CAAC;QACtC;;WAEG;QACI,MAAM,CAAC,EAAE,MAAM,CAAC;QACvB;;;WAGG;QACI,QAAQ,CAAC,EAAE,MAAM,CAAC;QACzB,wEAAwE;QACjE,OAAO,CAAC,EAAE,MAAM,CAAC;QACxB,yEAAyE;QAClE,QAAQ,CAAC,EAAE,MAAM,CAAC;QACzB,wBAAwB;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACxB,wBAAwB;QACjB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;QAC/B;;;WAGG;QACI,UAAU,CAAC,EAAE,eAAe,CAAC;QACpC;;;;WAIG;QACI,SAAS,CAAC,EAAE,cAAc,GAAG;YAClC;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QAEF,gJAAgJ;oBAC7H,WAAW,EAAE,MAAM;KAGvC;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB,CAAC,MAAM;CAChF"}
+{"version":3,"file":"Material.d.ts","sourceRoot":"","sources":["../../src/Material.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAa,MAAM,qBAAqB,CAAC;AAClE,OAAO,EACQ,IAAI,EAAE,cAAc,EAAoC,YAAY,EAAE,cAAc,EAAgC,mBAAmB,EAAE,cAAc,EAAE,eAAe,EACtL,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAIlF;;;GAGG;AACH,8BAAsB,gBAAiB,SAAQ,iBAAiB;IAC9D,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,iBAAiB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAIjG;;;;;;OAMG;WACW,MAAM,CAAC,CAAC,SAAS,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;CAQzH;AAED;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,iBAAiB;IAC1D,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAE3E,+EAA+E;IACxE,WAAW,EAAE,MAAM,CAAC;IAC3B,+CAA+C;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE5B,OAAO;IAMS,MAAM,IAAI,mBAAmB;IAO7C;;;;OAIG;IACH,0BAAmC,mBAAmB,EAAE,qBAAqB,EAAE,CAE7E;IAEF;;;;OAIG;WACoB,WAAW,CAAC,KAAK,EAAE,qBAAqB,GAAG,mBAAmB;IAOrF;;;;OAIG;WACoB,SAAS,CAAC,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ,GAAG,QAAQ;IAMxF;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAI5F;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,2BAA2B,GAAG,qBAAqB;IAgFzJ;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,2BAA2B,GAAG,UAAU;IAK9I,YAAY;qBACc,QAAQ,CAAC,OAAO,EAAE,yBAAyB,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,YAAY;CAgB5H;AAED,cAAc;AACd,yBAAiB,qBAAqB,CAAC;IACrC;;;;OAIG;IACH,MAAa,MAAM;QACjB,mEAAmE;QAC5D,WAAW,EAAE,MAAM,CAAC;QAC3B,qDAAqD;QAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;QAC5B,iHAAiH;QAC1G,KAAK,CAAC,EAAE,cAAc,CAAC;QAC9B,kEAAkE;QAC3D,aAAa,CAAC,EAAE,cAAc,CAAC;QACtC;;WAEG;QACI,MAAM,CAAC,EAAE,MAAM,CAAC;QACvB;;;WAGG;QACI,QAAQ,CAAC,EAAE,MAAM,CAAC;QACzB,wEAAwE;QACjE,OAAO,CAAC,EAAE,MAAM,CAAC;QACxB,yEAAyE;QAClE,QAAQ,CAAC,EAAE,MAAM,CAAC;QACzB,wBAAwB;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACxB,wBAAwB;QACjB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;QAC/B;;;WAGG;QACI,UAAU,CAAC,EAAE,eAAe,CAAC;QACpC;;;;WAIG;QACI,SAAS,CAAC,EAAE,cAAc,GAAG;YAClC;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QAEF,gJAAgJ;oBAC7H,WAAW,EAAE,MAAM;KAGvC;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB,CAAC,MAAM;CAChF"}

package/lib/cjs/Material.js

@@ -50,6 +50,10 @@ exports.PhysicalMaterial = PhysicalMaterial;
  */
 class RenderMaterialElement extends Element_1.DefinitionElement {
     static get className() { return "RenderMaterial"; }
+    /** The name of a palette that can be used to categorize multiple materials. */
+    paletteName;
+    /** An optional description of the material. */
+    description;
     constructor(props, iModel) {
         super(props, iModel);
         this.paletteName = props.paletteName;
@@ -61,6 +65,35 @@ class RenderMaterialElement extends Element_1.DefinitionElement {
         val.description = this.description;
         return val;
     }
+    /**
+     * RenderMaterialElement custom HandledProps includes 'paletteName'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "paletteName", source: "Class" },
+    ];
+    /**
+     * RenderMaterialElement deserializes 'paletteName'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const elProps = super.deserialize(props);
+        const instance = props.row;
+        elProps.paletteName = core_bentley_1.JsonUtils.asString(instance.paletteName);
+        return elProps;
+    }
+    /**
+     * RenderMaterialElement serializes 'paletteName'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, iModel) {
+        const inst = super.serialize(props, iModel);
+        inst.paletteName = props.paletteName;
+        return inst;
+    }
     /** Create a Code for a RenderMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
      * @param iModel  The IModelDb
      * @param scopeModelId The Id of the DefinitionModel that contains the RenderMaterial and provides the scope for its name.
@@ -190,6 +223,42 @@ exports.RenderMaterialElement = RenderMaterialElement;
      * @deprecated in 3.6 because it is not useful to use a `class` - just use [[RenderMaterialElementParams]] directly instead.
      */
     class Params {
+        /** A required palette name that categorizes this RenderMaterial */
+        paletteName;
+        /** An optional description of this RenderMaterial */
+        description;
+        /** If defined, the color to use for surface fill or diffuse illumination, overriding the surface's own color. */
+        color;
+        /** The color to use for specular illumination. Default: black. */
+        specularColor;
+        /** The specular exponent describing the surface's shininess, in the range 0 through 128.
+         * Default: 0.
+         */
+        finish;
+        /** A transparency to be applied to the surface, ranging from 0 (fully opaque) to 1 (fully transparent).
+         * The surface's own transparency will be multiplied by `(1 - transmit)`. permitting the material to increase but not decrease the surface transparency.
+         * Default: 13.5.
+         */
+        transmit;
+        /** The surface's diffuse reflectivity from 0.0 to 1.0. Default: 0.6. */
+        diffuse;
+        /** The surface's specular reflectivity from 0.0 to 1.0. Default: 0.0. */
+        specular;
+        /** Currently unused. */
+        reflect;
+        /** Currently unused. */
+        reflectColor;
+        /** Specifies a texture image to map onto the surface, replacing or mixing with the surface's own color and transparency.
+         * @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
+         * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.
+         */
+        patternMap;
+        /** 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
+         * surface's geometry.
+         * @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
+         * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.
+         */
+        normalMap;
         /** Construct a new RenderMaterial.Params object with the specified paletteName. Alter the public members on that object to specify settings. */
         constructor(paletteName) {
             this.paletteName = paletteName;

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,sDAAuD;AACvD,oDAE4B;AAC5B,uCAA8C;AAI9C,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;IAO3E,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;IACD;;;;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;CACF;AArJD,sDAqJC;AAED,cAAc;AACd,WAAiB,qBAAqB;IACpC;;;;OAIG;IACH,MAAa,MAAM;QA2CjB,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 } 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\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  /** 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 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"]}
+{"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"]}

package/lib/cjs/Model.d.ts

@@ -4,7 +4,7 @@
 import { GuidString, Id64String } from "@itwin/core-bentley";
 import { Point2d } from "@itwin/core-geometry";
 import { AxisAlignedBox3d, ElementProps, EntityReferenceSet, GeometricModel2dProps, GeometricModel3dProps, GeometricModelProps, ModelProps, RelatedElement } from "@itwin/core-common";
-import { Entity } from "./Entity";
+import { CustomHandledProperty, DeserializeEntityArgs, ECSqlRow, Entity } from "./Entity";
 import { IModelDb } from "./IModelDb";
 /** Argument for the `Model.onXxx` static methods
  * @beta
@@ -52,13 +52,31 @@ export declare class Model extends Entity {
     static get protectedOperations(): string[];
     readonly modeledElement: RelatedElement;
     readonly name: string;
-    readonly parentModel: Id64String;
+    readonly parentModel?: Id64String;
     readonly jsonProperties: {
         [key: string]: any;
     };
     isPrivate: boolean;
     isTemplate: boolean;
     protected constructor(props: ModelProps, iModel: IModelDb);
+    /**
+     * Model custom HandledProps includes 'isPrivate', 'isTemplate', and 'lastMod'.
+     * @inheritdoc
+     * @beta
+     */
+    protected static readonly _customHandledProps: CustomHandledProperty[];
+    /**
+     * Model deserializes 'isPrivate', and 'isTemplate', and sets the proper parentModel.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props: DeserializeEntityArgs): ModelProps;
+    /**
+     * Model serializes 'isPrivate', and 'isTemplate'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props: ModelProps, _iModel: IModelDb): ECSqlRow;
     toJSON(): ModelProps;
     /** Called before a new Model is inserted.
      * @note throw an exception to disallow the insert
@@ -85,7 +103,7 @@ export declare class Model extends Entity {
      * @note `this` is the class of the Model that was updated.
      * @beta
      */
-    protected static onUpdated(_arg: OnModelIdArg): void;
+    protected static onUpdated(arg: OnModelIdArg): void;
     /** Called before a Model is deleted.
      * @note throw an exception to disallow the delete
      * @note If you override this method, you must call super.
@@ -98,7 +116,7 @@ export declare class Model extends Entity {
      * @note `this` is the class of the Model that was deleted
      * @beta
      */
-    protected static onDeleted(_arg: OnModelIdArg): void;
+    protected static onDeleted(arg: OnModelIdArg): void;
     /** Called before a prospective Element is to be inserted into an instance of a Model of this class.
      * @note throw an exception to disallow the insert
      * @note If you override this method, you must call super.
@@ -111,7 +129,7 @@ export declare class Model extends Entity {
      * @note `this` is the class of the Model holding the element
      * @beta
      */
-    protected static onInsertedElement(_arg: OnElementInModelIdArg): void;
+    protected static onInsertedElement(arg: OnElementInModelIdArg): void;
     /** Called when an Element in an instance of a Model of this class is about to be updated.
      * @note throw an exception to disallow the update
      * @note If you override this method, you must call super.
@@ -124,7 +142,7 @@ export declare class Model extends Entity {
      * @note `this` is the class of the Model holding the element
      * @beta
      */
-    protected static onUpdatedElement(_arg: OnElementInModelIdArg): void;
+    protected static onUpdatedElement(arg: OnElementInModelIdArg): void;
     /** Called when an Element in an instance of a Model of this class is about to be deleted.
      * @note throw an exception to disallow the delete
      * @note If you override this method, you must call super.
@@ -137,7 +155,7 @@ export declare class Model extends Entity {
      * @note `this` is the class of the Model that held the element
      * @beta
      */
-    protected static onDeletedElement(_arg: OnElementInModelIdArg): void;
+    protected static onDeletedElement(arg: OnElementInModelIdArg): void;
     private getAllUserProperties;
     /** Get a set of JSON user properties by namespace */
     getUserProperties(namespace: string): any;
@@ -185,6 +203,24 @@ export declare abstract class GeometricModel3d extends GeometricModel {
     get isSpatiallyLocated(): boolean;
     static get className(): string;
     protected constructor(props: GeometricModel3dProps, iModel: IModelDb);
+    /**
+     * GeometricModel3d custom HandledProps includes 'isPlanProjection', and 'isNotSpatiallyLocated'.
+     * @inheritdoc
+     * @beta
+     */
+    protected static readonly _customHandledProps: CustomHandledProperty[];
+    /**
+     * GeometricModel3d deserializes 'isPlanProjection', and 'isNotSpatiallyLocated'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props: DeserializeEntityArgs): GeometricModel3dProps;
+    /**
+     * GeometricModel3d serializes 'isPlanProjection', and 'isNotSpatiallyLocated'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props: GeometricModel3dProps, _iModel: IModelDb): ECSqlRow;
     toJSON(): GeometricModel3dProps;
 }
 /** A container for persisting 2d geometric elements.

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

@@ -1 +1 @@
-{"version":3,"file":"Model.d.ts","sourceRoot":"","sources":["../../src/Model.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAa,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAAE,OAAO,EAAW,MAAM,sBAAsB,CAAC;AACxD,OAAO,EACL,gBAAgB,EAAE,YAAY,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,mBAAmB,EACnF,UAAU,EAAE,cAAc,EAC7D,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,yCAAyC;IACzC,MAAM,EAAE,QAAQ,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,gDAAgD;IAChD,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,mCAAmC;IACnC,EAAE,EAAE,UAAU,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,YAAY;IAC5D,8DAA8D;IAC9D,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,mDAAmD;IACnD,SAAS,EAAE,UAAU,CAAC;CACvB;AAED;;;;GAIG;AACH,qBAAa,KAAM,SAAQ,MAAM;IAC/B,WAA2B,SAAS,IAAI,MAAM,CAAoB;IAClE,gBAAgB;IAChB,WAA2B,mBAAmB,aAAmD;IACjG,SAAgB,cAAc,EAAG,cAAc,CAAC;IAChD,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,WAAW,EAAG,UAAU,CAAC;IACzC,SAAgB,cAAc,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAChD,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IAE3B,SAAS,aAAa,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ;IAQzC,MAAM,IAAI,UAAU;IAMpC;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IAOrD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAIrD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IAMrD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAGpD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI;IAKlD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAEpD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,wBAAwB,GAAG,IAAI;IAEtE;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAErE;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,wBAAwB,GAAG,IAAI;IAEtE;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAEpE;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAEnE;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAEpE,OAAO,CAAC,oBAAoB;IAO5B,qDAAqD;IAC9C,iBAAiB,CAAC,SAAS,EAAE,MAAM;IAE1C,yEAAyE;IAClE,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAEtD,sFAAsF;IAC/E,oBAAoB,CAAC,SAAS,EAAE,MAAM;IAEtC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG;IAClC,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAE/C,sCAAsC;IAC/B,MAAM;IACb,uCAAuC;IAChC,MAAM;IACb,yCAAyC;IAClC,MAAM;cAEM,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAM/E;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,KAAK;IAChC,YAAY,CAAC,EAAE,UAAU,CAAC;IAEjC,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAE3E,SAAS,aAAa,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAElE;;OAEG;IACI,YAAY,IAAI,gBAAgB;IAKvC,sFAAsF;IACzE,UAAU,IAAI,OAAO,CAAC,gBAAgB,CAAC;CAGrD;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,cAAc;IAC3D;;OAEG;IACH,SAAgB,gBAAgB,EAAE,OAAO,CAAC;IAC1C;;OAEG;IACH,SAAgB,qBAAqB,EAAE,OAAO,CAAC;IAC/C,0HAA0H;IAC1H,IAAW,kBAAkB,IAAI,OAAO,CAAwC;IAEhF,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAE7E,SAAS,aAAa,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAMpD,MAAM,IAAI,qBAAqB;CAUhD;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,cAAc;IAC3D,8GAA8G;IACvG,YAAY,CAAC,EAAE,OAAO,CAAC;IAC9B,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAE7E,SAAS,aAAa,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAEpD,MAAM,IAAI,qBAAqB;CAOhD;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,gBAAgB;IAC7D,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E;AAED;;;;GAIG;AACH,8BAAsB,gBAAiB,SAAQ,gBAAgB;IAC7D,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E;AAED;;GAEG;AACH,8BAAsB,YAAa,SAAQ,gBAAgB;IACzD,WAA2B,SAAS,IAAI,MAAM,CAA2B;CAC1E;AAED;;;GAGG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAC7C,WAA2B,SAAS,IAAI,MAAM,CAA4B;IAC1E;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,UAAU;CAe5H;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,WAA2B,SAAS,IAAI,MAAM,CAAmC;IACjF;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,UAAU;CAe5H;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;IAChD,WAA2B,SAAS,IAAI,MAAM,CAA2B;CAC1E;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,WAA2B,SAAS,IAAI,MAAM,CAAkC;CACjF;AAED;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,gBAAgB;IAC9C,WAA2B,SAAS,IAAI,MAAM,CAAyB;CACxE;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAClC,WAA2B,SAAS,IAAI,MAAM,CAAwB;CACvE;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,KAAK;IAClD,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E;AAED;;;GAGG;AACH,8BAAsB,qBAAsB,SAAQ,gBAAgB;IAClE,WAA2B,SAAS,IAAI,MAAM,CAAoC;CACnF;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,gBAAgB;IACnD,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAE5E;;;;;;KAMC;WACa,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,gBAAgB;IAC1D,WAA2B,SAAS,IAAI,MAAM,CAAqC;IAEnF;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,gBAAgB;IACnD,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAE5E;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,eAAe;IAClD,WAA2B,SAAS,IAAI,MAAM,CAA8B;CAC7E;AAED;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,gBAAgB;IACrD,WAA2B,SAAS,IAAI,MAAM,CAAgC;IAC9E;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;;GAGG;AACH,qBAAa,SAAU,SAAQ,gBAAgB;IAC7C,WAA2B,SAAS,IAAI,MAAM,CAAwB;CACvE;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,eAAe;IAClD,WAA2B,SAAS,IAAI,MAAM,CAA8B;CAC7E;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAChD,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E"}
+{"version":3,"file":"Model.d.ts","sourceRoot":"","sources":["../../src/Model.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAa,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAAE,OAAO,EAAW,MAAM,sBAAsB,CAAC;AACxD,OAAO,EACL,gBAAgB,EAAE,YAAY,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,mBAAmB,EACnF,UAAU,EAAE,cAAc,EAC7D,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAC1F,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,yCAAyC;IACzC,MAAM,EAAE,QAAQ,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,gDAAgD;IAChD,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,mCAAmC;IACnC,EAAE,EAAE,UAAU,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,YAAY;IAC5D,8DAA8D;IAC9D,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,mDAAmD;IACnD,SAAS,EAAE,UAAU,CAAC;CACvB;AAED;;;;GAIG;AACH,qBAAa,KAAM,SAAQ,MAAM;IAC/B,WAA2B,SAAS,IAAI,MAAM,CAAoB;IAClE,gBAAgB;IAChB,WAA2B,mBAAmB,aAAmD;IACjG,SAAgB,cAAc,EAAE,cAAc,CAAC;IAC/C,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,WAAW,CAAC,EAAE,UAAU,CAAC;IACzC,SAAgB,cAAc,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAChD,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IAE3B,SAAS,aAAa,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ;IAUzD;;;;OAIG;IACH,0BAAmC,mBAAmB,EAAE,qBAAqB,EAAE,CAI7E;IAEF;;;;OAIG;WACoB,WAAW,CAAC,KAAK,EAAE,qBAAqB,GAAG,UAAU;IAmB5E;;;;OAIG;WACoB,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,GAAG,QAAQ;IAOhE,MAAM,IAAI,UAAU;IAMpC;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IAOrD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAIrD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IAMrD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI;IAInD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI;IAKlD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI;IAKnD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,wBAAwB,GAAG,IAAI;IAEtE;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,iBAAiB,CAAC,GAAG,EAAE,qBAAqB,GAAG,IAAI;IAIpE;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,wBAAwB,GAAG,IAAI;IAEtE;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG,EAAE,qBAAqB,GAAG,IAAI;IAInE;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAEnE;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG,EAAE,qBAAqB,GAAG,IAAI;IAInE,OAAO,CAAC,oBAAoB;IAO5B,qDAAqD;IAC9C,iBAAiB,CAAC,SAAS,EAAE,MAAM;IAE1C,yEAAyE;IAClE,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAEtD,sFAAsF;IAC/E,oBAAoB,CAAC,SAAS,EAAE,MAAM;IAEtC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG;IAClC,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAE/C,sCAAsC;IAC/B,MAAM;IACb,uCAAuC;IAChC,MAAM;IACb,yCAAyC;IAClC,MAAM;cAEM,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAM/E;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,KAAK;IAChC,YAAY,CAAC,EAAE,UAAU,CAAC;IAEjC,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAE3E,SAAS,aAAa,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAKlE;;OAEG;IACI,YAAY,IAAI,gBAAgB;IAKvC,sFAAsF;IACzE,UAAU,IAAI,OAAO,CAAC,gBAAgB,CAAC;CAGrD;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,cAAc;IAC3D;;OAEG;IACH,SAAgB,gBAAgB,EAAE,OAAO,CAAC;IAC1C;;OAEG;IACH,SAAgB,qBAAqB,EAAE,OAAO,CAAC;IAC/C,0HAA0H;IAC1H,IAAW,kBAAkB,IAAI,OAAO,CAAwC;IAEhF,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAE7E,SAAS,aAAa,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAMpE;;;;OAIG;IACH,0BAAmC,mBAAmB,EAAE,qBAAqB,EAAE,CAG7E;IAEF;;;;OAIG;WACoB,WAAW,CAAC,KAAK,EAAE,qBAAqB,GAAG,qBAAqB;IAUvF;;;;OAIG;WACoB,SAAS,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,EAAE,QAAQ,GAAG,QAAQ;IAO3E,MAAM,IAAI,qBAAqB;CAUhD;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,cAAc;IAC3D,8GAA8G;IACvG,YAAY,CAAC,EAAE,OAAO,CAAC;IAC9B,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAE7E,SAAS,aAAa,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAKpD,MAAM,IAAI,qBAAqB;CAOhD;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,gBAAgB;IAC7D,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E;AAED;;;;GAIG;AACH,8BAAsB,gBAAiB,SAAQ,gBAAgB;IAC7D,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E;AAED;;GAEG;AACH,8BAAsB,YAAa,SAAQ,gBAAgB;IACzD,WAA2B,SAAS,IAAI,MAAM,CAA2B;CAC1E;AAED;;;GAGG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAC7C,WAA2B,SAAS,IAAI,MAAM,CAA4B;IAC1E;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,UAAU;CAe5H;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,WAA2B,SAAS,IAAI,MAAM,CAAmC;IACjF;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,UAAU;CAe5H;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;IAChD,WAA2B,SAAS,IAAI,MAAM,CAA2B;CAC1E;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,WAA2B,SAAS,IAAI,MAAM,CAAkC;CACjF;AAED;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,gBAAgB;IAC9C,WAA2B,SAAS,IAAI,MAAM,CAAyB;CACxE;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAClC,WAA2B,SAAS,IAAI,MAAM,CAAwB;CACvE;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,KAAK;IAClD,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E;AAED;;;GAGG;AACH,8BAAsB,qBAAsB,SAAQ,gBAAgB;IAClE,WAA2B,SAAS,IAAI,MAAM,CAAoC;CACnF;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,gBAAgB;IACnD,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAE5E;;;;;;KAMC;WACa,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,gBAAgB;IAC1D,WAA2B,SAAS,IAAI,MAAM,CAAqC;IAEnF;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,gBAAgB;IACnD,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAE5E;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,eAAe;IAClD,WAA2B,SAAS,IAAI,MAAM,CAA8B;CAC7E;AAED;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,gBAAgB;IACrD,WAA2B,SAAS,IAAI,MAAM,CAAgC;IAC9E;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;;GAGG;AACH,qBAAa,SAAU,SAAQ,gBAAgB;IAC7C,WAA2B,SAAS,IAAI,MAAM,CAAwB;CACvE;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,eAAe;IAClD,WAA2B,SAAS,IAAI,MAAM,CAA8B;CAC7E;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAChD,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E"}

package/lib/cjs/Model.js

@@ -25,13 +25,65 @@ class Model extends Entity_1.Entity {
     static get className() { return "Model"; }
     /** @internal */
     static get protectedOperations() { return ["onInsert", "onUpdate", "onDelete"]; }
+    modeledElement;
+    name;
+    parentModel;
+    jsonProperties;
+    isPrivate;
+    isTemplate;
     constructor(props, iModel) {
         super(props, iModel);
+        this.modeledElement = new core_common_1.RelatedElement(props.modeledElement);
         this.name = props.name ? props.name : ""; // NB this isn't really a property of Model (it's the code.value of the modeled element), but it comes in ModelProps because it's often needed
+        this.parentModel = props.parentModel;
         this.isPrivate = core_bentley_1.JsonUtils.asBool(props.isPrivate);
         this.isTemplate = core_bentley_1.JsonUtils.asBool(props.isTemplate);
         this.jsonProperties = { ...props.jsonProperties }; // make sure we have our own copy
     }
+    /**
+     * Model custom HandledProps includes 'isPrivate', 'isTemplate', and 'lastMod'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "isPrivate", source: "Class" },
+        { propertyName: "isTemplate", source: "Class" },
+        { propertyName: "lastMod", source: "Class" },
+    ];
+    /**
+     * Model deserializes 'isPrivate', and 'isTemplate', and sets the proper parentModel.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const instance = props.row;
+        const modelProps = super.deserialize(props);
+        const modeledElementProps = props.iModel.elements.tryGetElementProps(instance.modeledElement.id);
+        if (modeledElementProps) {
+            // ModeledElement may be undefined in the case of root Element
+            modelProps.name = core_bentley_1.JsonUtils.asString(modeledElementProps.code.value);
+            if (instance.parentModel !== undefined)
+                modelProps.parentModel = instance.parentModel.id;
+            else
+                modelProps.parentModel = modeledElementProps.model;
+        }
+        if (instance.isPrivate === true)
+            modelProps.isPrivate = true;
+        if (instance.isTemplate === true)
+            modelProps.isTemplate = true;
+        return modelProps;
+    }
+    /**
+     * Model serializes 'isPrivate', and 'isTemplate'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, _iModel) {
+        const inst = super.serialize(props, _iModel);
+        inst.isPrivate = props.isPrivate ?? false;
+        inst.isTemplate = props.isTemplate ?? false;
+        return inst;
+    }
     toJSON() {
         const val = super.toJSON();
         val.name = this.name; // for cloning
@@ -73,7 +125,8 @@ class Model extends Entity_1.Entity {
      * @note `this` is the class of the Model that was updated.
      * @beta
      */
-    static onUpdated(_arg) {
+    static onUpdated(arg) {
+        arg.iModel.models[Symbols_1._cache].delete(arg.id);
     }
     /** Called before a Model is deleted.
      * @note throw an exception to disallow the delete
@@ -90,7 +143,10 @@ class Model extends Entity_1.Entity {
      * @note `this` is the class of the Model that was deleted
      * @beta
      */
-    static onDeleted(_arg) { }
+    static onDeleted(arg) {
+        arg.iModel.models[Symbols_1._cache].delete(arg.id);
+        arg.iModel.elements[Symbols_1._cache].deleteWithModel(arg.id);
+    }
     /** Called before a prospective Element is to be inserted into an instance of a Model of this class.
      * @note throw an exception to disallow the insert
      * @note If you override this method, you must call super.
@@ -103,7 +159,9 @@ class Model extends Entity_1.Entity {
      * @note `this` is the class of the Model holding the element
      * @beta
      */
-    static onInsertedElement(_arg) { }
+    static onInsertedElement(arg) {
+        arg.iModel.models[Symbols_1._cache].delete(arg.id);
+    }
     /** Called when an Element in an instance of a Model of this class is about to be updated.
      * @note throw an exception to disallow the update
      * @note If you override this method, you must call super.
@@ -116,7 +174,9 @@ class Model extends Entity_1.Entity {
      * @note `this` is the class of the Model holding the element
      * @beta
      */
-    static onUpdatedElement(_arg) { }
+    static onUpdatedElement(arg) {
+        arg.iModel.models[Symbols_1._cache].delete(arg.id);
+    }
     /** Called when an Element in an instance of a Model of this class is about to be deleted.
      * @note throw an exception to disallow the delete
      * @note If you override this method, you must call super.
@@ -129,7 +189,9 @@ class Model extends Entity_1.Entity {
      * @note `this` is the class of the Model that held the element
      * @beta
      */
-    static onDeletedElement(_arg) { }
+    static onDeletedElement(arg) {
+        arg.iModel.models[Symbols_1._cache].delete(arg.id);
+    }
     getAllUserProperties() {
         if (!this.jsonProperties.UserProps)
             this.jsonProperties.UserProps = new Object();
@@ -161,8 +223,12 @@ exports.Model = Model;
  * @public
  */
 class GeometricModel extends Model {
+    geometryGuid;
     static get className() { return "GeometricModel"; }
-    constructor(props, iModel) { super(props, iModel); }
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.geometryGuid = props.geometryGuid;
+    }
     /** Query for the union of the extents of the elements contained by this model.
      * @note This function blocks the JavaScript event loop. Consider using [[queryRange]] instead.
      */
@@ -180,6 +246,14 @@ exports.GeometricModel = GeometricModel;
  * @public
  */
 class GeometricModel3d extends GeometricModel {
+    /** If true, then the elements in this GeometricModel3d are expected to be in an XY plane.
+     * @note The associated ECProperty was added to the BisCore schema in version 1.0.8
+     */
+    isPlanProjection;
+    /** If true, then the elements in this GeometricModel3d are not in real-world coordinates and will not be in the spatial index.
+     * @note The associated ECProperty was added to the BisCore schema in version 1.0.8
+     */
+    isNotSpatiallyLocated;
     /** If true, then the elements in this GeometricModel3d are in real-world coordinates and will be in the spatial index. */
     get isSpatiallyLocated() { return !this.isNotSpatiallyLocated; }
     static get className() { return "GeometricModel3d"; }
@@ -188,6 +262,40 @@ class GeometricModel3d extends GeometricModel {
         this.isNotSpatiallyLocated = core_bentley_1.JsonUtils.asBool(props.isNotSpatiallyLocated);
         this.isPlanProjection = core_bentley_1.JsonUtils.asBool(props.isPlanProjection);
     }
+    /**
+     * GeometricModel3d custom HandledProps includes 'isPlanProjection', and 'isNotSpatiallyLocated'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "isPlanProjection", source: "Class" },
+        { propertyName: "isNotSpatiallyLocated", source: "Class" },
+    ];
+    /**
+     * GeometricModel3d deserializes 'isPlanProjection', and 'isNotSpatiallyLocated'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const modelProps = super.deserialize(props);
+        const instance = props.row;
+        if (instance.isNotSpatiallyLocated === true || instance.isTemplate === true)
+            modelProps.isNotSpatiallyLocated = true;
+        if (instance.isPlanProjection === true)
+            modelProps.isPlanProjection = true;
+        return modelProps;
+    }
+    /**
+     * GeometricModel3d serializes 'isPlanProjection', and 'isNotSpatiallyLocated'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, _iModel) {
+        const inst = super.serialize(props, _iModel);
+        inst.isNotSpatiallyLocated = props.isNotSpatiallyLocated ?? false;
+        inst.isPlanProjection = props.isPlanProjection ?? false;
+        return inst;
+    }
     toJSON() {
         const val = super.toJSON();
         if (this.isNotSpatiallyLocated)
@@ -202,8 +310,13 @@ exports.GeometricModel3d = GeometricModel3d;
  * @public
  */
 class GeometricModel2d extends GeometricModel {
+    /** The actual coordinates of (0,0) in modeling coordinates. An offset applied to all modeling coordinates. */
+    globalOrigin;
     static get className() { return "GeometricModel2d"; }
-    constructor(props, iModel) { super(props, iModel); }
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.globalOrigin = props.globalOrigin ? core_geometry_1.Point2d.fromJSON(props.globalOrigin) : undefined;
+    }
     toJSON() {
         const val = super.toJSON();
         if (undefined !== this.globalOrigin)