@itwin/core-common 5.0.0-dev.7 → 5.0.0-dev.70

package/lib/esm/IModelError.js

@@ -6,7 +6,6 @@
  * @module iModels
  */
 import { BentleyError, IModelHubStatus, IModelStatus, } from "@itwin/core-bentley";
-export { BentleyStatus, BentleyError, IModelStatus, BriefcaseStatus, DbResult, ChangeSetStatus, } from "@itwin/core-bentley";
 /** The error type thrown by this module.
  * Creating subclasses of IModelError should be avoided. Instead use [[ITwinError]].
  * @see [[ITwinError]]
@@ -38,6 +37,8 @@ export var LockState;
  * @public @deprecated in 4.10 Use [InUseLocksError]($common) instead.
 */
 export class ConflictingLocksError extends IModelError {
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    conflictingLocks;
     // eslint-disable-next-line @typescript-eslint/no-deprecated
     constructor(message, getMetaData, conflictingLocks) {
         super(IModelHubStatus.LockOwnedByAnotherBriefcase, message, getMetaData);

package/lib/esm/IModelError.js.map

@@ -1 +1 @@
-{"version":3,"file":"IModelError.js","sourceRoot":"","sources":["../../src/IModelError.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EACL,YAAY,EAA6D,eAAe,EAAE,YAAY,GACvG,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,QAAQ,EAAE,eAAe,GACtF,MAAM,qBAAqB,CAAC;AAU7B;;;;;GAKG;AACH,MAAM,OAAO,WAAY,SAAQ,YAAY;IAC3C,YAAmB,WAAuC,EAAE,OAAe,EAAE,WAA6B;QACxG,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC3C,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,SASX;AATD,WAAY,SAAS;IACnB,gCAAgC;IAChC,yCAAQ,CAAA;IACR,mJAAmJ;IACnJ,6CAAU,CAAA;IACV;;OAEG;IACH,mDAAa,CAAA;AACf,CAAC,EATW,SAAS,KAAT,SAAS,QASpB;AAkBD;;;;EAIE;AACF,MAAM,OAAO,qBAAsB,SAAQ,WAAW;IAGpD,4DAA4D;IAC5D,YAAY,OAAe,EAAE,WAA6B,EAAE,gBAAoC;QAC9F,KAAK,CAAC,eAAe,CAAC,2BAA2B,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QACzE,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;IAC3C,CAAC;CAEF;AAED,cAAc;AACd,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C,YAAmB,WAAmB,EAAE,OAAe;QACrD,KAAK,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,iBAAiB,WAAW,GAAG,CAAC;IAC9C,CAAC;CACF;AAED,cAAc;AACd,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IACjD,YAAmB,OAAe;QAChC,KAAK,CAAC,YAAY,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACrC,CAAC;CACF;AAED,cAAc;AACd,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C,YAAmB,WAAmB,EAAE,IAAY,EAAE,OAAe,EAAE,WAA6B;QAClG,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;QACE,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\nimport {\r\n  BentleyError, BentleyStatus, BriefcaseStatus, ChangeSetStatus, DbResult, IModelHubStatus, IModelStatus, LoggingMetaData,\r\n} from \"@itwin/core-bentley\";\r\n\r\nexport {\r\n  BentleyStatus, BentleyError, IModelStatus, BriefcaseStatus, DbResult, ChangeSetStatus,\r\n} from \"@itwin/core-bentley\";\r\n\r\nexport type { GetMetaDataFunction, LogFunction, LoggingMetaData } from \"@itwin/core-bentley\";\r\n\r\n/** Numeric values for common errors produced by iTwin.js APIs, typically provided by [[IModelError]].\r\n * The values within each of these `enum`s are guaranteed not to conflict with one another.\r\n * @public\r\n */\r\nexport type IModelErrorNumber = IModelStatus | DbResult | BentleyStatus | BriefcaseStatus | ChangeSetStatus;\r\n\r\n/** The error type thrown by this module.\r\n * Creating subclasses of IModelError should be avoided. Instead use [[ITwinError]].\r\n * @see [[ITwinError]]\r\n * @see [[IModelErrorNumber]] for commonly-used error codes.\r\n * @public\r\n */\r\nexport class IModelError extends BentleyError {\r\n  public constructor(errorNumber: IModelErrorNumber | number, message: string, getMetaData?: LoggingMetaData) {\r\n    super(errorNumber, message, getMetaData);\r\n  }\r\n}\r\n\r\n/** The state of a lock. See [Acquiring locks on elements.]($docs/learning/backend/ConcurrencyControl.md#acquiring-locks-on-elements).\r\n * @public\r\n */\r\nexport enum LockState {\r\n  /** The element is not locked */\r\n  None = 0,\r\n  /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */\r\n  Shared = 1,\r\n  /** A Lock that permits modifications to an element and blocks other users from making modifications to it.\r\n   * Holding an exclusive lock on an \"owner\" (a model or a parent element), implicitly exclusively locks all its members.\r\n   */\r\n  Exclusive = 2,\r\n}\r\n\r\n/** Detailed information about a particular object Lock that is causing the Lock update conflict.\r\n * An example of a lock update conflict would be attempting to use [LockControl.acquireLocks]($backend) on an object that is already locked by another Briefcase.\r\n * @public @deprecated in 4.10 Use [InUseLock]($common) instead.\r\n*/\r\nexport interface ConflictingLock {\r\n  /** Id of the object that is causing conflict. */\r\n  objectId: string;\r\n  /**\r\n     * The level of conflicting lock. Possible values are {@link LockState.Shared}, {@link LockState.Exclusive}.\r\n     * See {@link LockState}.\r\n     */\r\n  state: LockState;\r\n  /** An array of Briefcase ids that hold this lock. */\r\n  briefcaseIds: number[];\r\n}\r\n\r\n/**\r\n * An error raised when there is a lock conflict detected.\r\n * Typically this error would be thrown by [LockControl.acquireLocks]($backend) when you are requesting a lock on an element that is already held by another briefcase.\r\n * @public @deprecated in 4.10 Use [InUseLocksError]($common) instead.\r\n*/\r\nexport class ConflictingLocksError extends IModelError {\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  public conflictingLocks?: ConflictingLock[];\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  constructor(message: string, getMetaData?: LoggingMetaData, conflictingLocks?: ConflictingLock[]) {\r\n    super(IModelHubStatus.LockOwnedByAnotherBriefcase, message, getMetaData);\r\n    this.conflictingLocks = conflictingLocks;\r\n  }\r\n\r\n}\r\n\r\n/** @public */\r\nexport class ServerError extends IModelError {\r\n  public constructor(errorNumber: number, message: string) {\r\n    super(errorNumber, message);\r\n    this.name = `Server error (${errorNumber})`;\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport class ServerTimeoutError extends ServerError {\r\n  public constructor(message: string) {\r\n    super(IModelStatus.ServerTimeout, message);\r\n    this.name = \"Server timeout error\";\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport class BackendError extends IModelError {\r\n  public constructor(errorNumber: number, name: string, message: string, getMetaData?: LoggingMetaData) {\r\n    super(errorNumber, message, getMetaData);\r\n    this.name = name;\r\n  }\r\n}\r\n\r\n/** Intended for API \"no content\" semantics where the error case should not trigger application failure monitoring systems.\r\n * @public\r\n */\r\nexport class NoContentError extends IModelError {\r\n  public constructor() {\r\n    super(IModelStatus.NoContent, \"No Content\");\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"IModelError.js","sourceRoot":"","sources":["../../src/IModelError.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EACL,YAAY,EAA6D,eAAe,EAAE,YAAY,GACvG,MAAM,qBAAqB,CAAC;AAQ7B;;;;;GAKG;AACH,MAAM,OAAO,WAAY,SAAQ,YAAY;IAC3C,YAAmB,WAAuC,EAAE,OAAe,EAAE,WAA6B;QACxG,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC3C,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,SASX;AATD,WAAY,SAAS;IACnB,gCAAgC;IAChC,yCAAQ,CAAA;IACR,mJAAmJ;IACnJ,6CAAU,CAAA;IACV;;OAEG;IACH,mDAAa,CAAA;AACf,CAAC,EATW,SAAS,KAAT,SAAS,QASpB;AAkBD;;;;EAIE;AACF,MAAM,OAAO,qBAAsB,SAAQ,WAAW;IACpD,4DAA4D;IACrD,gBAAgB,CAAqB;IAC5C,4DAA4D;IAC5D,YAAY,OAAe,EAAE,WAA6B,EAAE,gBAAoC;QAC9F,KAAK,CAAC,eAAe,CAAC,2BAA2B,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QACzE,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;IAC3C,CAAC;CAEF;AAED,cAAc;AACd,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C,YAAmB,WAAmB,EAAE,OAAe;QACrD,KAAK,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,iBAAiB,WAAW,GAAG,CAAC;IAC9C,CAAC;CACF;AAED,cAAc;AACd,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IACjD,YAAmB,OAAe;QAChC,KAAK,CAAC,YAAY,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACrC,CAAC;CACF;AAED,cAAc;AACd,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C,YAAmB,WAAmB,EAAE,IAAY,EAAE,OAAe,EAAE,WAA6B;QAClG,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;QACE,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport {\n  BentleyError, BentleyStatus, BriefcaseStatus, ChangeSetStatus, DbResult, IModelHubStatus, IModelStatus, LoggingMetaData,\n} from \"@itwin/core-bentley\";\n\n/** Numeric values for common errors produced by iTwin.js APIs, typically provided by [[IModelError]].\n * The values within each of these `enum`s are guaranteed not to conflict with one another.\n * @public\n */\nexport type IModelErrorNumber = IModelStatus | DbResult | BentleyStatus | BriefcaseStatus | ChangeSetStatus;\n\n/** The error type thrown by this module.\n * Creating subclasses of IModelError should be avoided. Instead use [[ITwinError]].\n * @see [[ITwinError]]\n * @see [[IModelErrorNumber]] for commonly-used error codes.\n * @public\n */\nexport class IModelError extends BentleyError {\n  public constructor(errorNumber: IModelErrorNumber | number, message: string, getMetaData?: LoggingMetaData) {\n    super(errorNumber, message, getMetaData);\n  }\n}\n\n/** The state of a lock. See [Acquiring locks on elements.]($docs/learning/backend/ConcurrencyControl.md#acquiring-locks-on-elements).\n * @public\n */\nexport enum LockState {\n  /** The element is not locked */\n  None = 0,\n  /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */\n  Shared = 1,\n  /** A Lock that permits modifications to an element and blocks other users from making modifications to it.\n   * Holding an exclusive lock on an \"owner\" (a model or a parent element), implicitly exclusively locks all its members.\n   */\n  Exclusive = 2,\n}\n\n/** Detailed information about a particular object Lock that is causing the Lock update conflict.\n * An example of a lock update conflict would be attempting to use [LockControl.acquireLocks]($backend) on an object that is already locked by another Briefcase.\n * @public @deprecated in 4.10 Use [InUseLock]($common) instead.\n*/\nexport interface ConflictingLock {\n  /** Id of the object that is causing conflict. */\n  objectId: string;\n  /**\n     * The level of conflicting lock. Possible values are {@link LockState.Shared}, {@link LockState.Exclusive}.\n     * See {@link LockState}.\n     */\n  state: LockState;\n  /** An array of Briefcase ids that hold this lock. */\n  briefcaseIds: number[];\n}\n\n/**\n * An error raised when there is a lock conflict detected.\n * Typically this error would be thrown by [LockControl.acquireLocks]($backend) when you are requesting a lock on an element that is already held by another briefcase.\n * @public @deprecated in 4.10 Use [InUseLocksError]($common) instead.\n*/\nexport class ConflictingLocksError extends IModelError {\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public conflictingLocks?: ConflictingLock[];\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  constructor(message: string, getMetaData?: LoggingMetaData, conflictingLocks?: ConflictingLock[]) {\n    super(IModelHubStatus.LockOwnedByAnotherBriefcase, message, getMetaData);\n    this.conflictingLocks = conflictingLocks;\n  }\n\n}\n\n/** @public */\nexport class ServerError extends IModelError {\n  public constructor(errorNumber: number, message: string) {\n    super(errorNumber, message);\n    this.name = `Server error (${errorNumber})`;\n  }\n}\n\n/** @public */\nexport class ServerTimeoutError extends ServerError {\n  public constructor(message: string) {\n    super(IModelStatus.ServerTimeout, message);\n    this.name = \"Server timeout error\";\n  }\n}\n\n/** @public */\nexport class BackendError extends IModelError {\n  public constructor(errorNumber: number, name: string, message: string, getMetaData?: LoggingMetaData) {\n    super(errorNumber, message, getMetaData);\n    this.name = name;\n  }\n}\n\n/** Intended for API \"no content\" semantics where the error case should not trigger application failure monitoring systems.\n * @public\n */\nexport class NoContentError extends IModelError {\n  public constructor() {\n    super(IModelStatus.NoContent, \"No Content\");\n  }\n}\n"]}

package/lib/esm/IModelVersion.js

@@ -9,6 +9,10 @@
  * @public
  */
 export class IModelVersion {
+    _first;
+    _latest;
+    _afterChangeSetId;
+    _versionName;
     constructor() { }
     /** Describes the first version of the iModel */
     static first() {

package/lib/esm/IModelVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"IModelVersion.js","sourceRoot":"","sources":["../../src/IModelVersion.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAaH;;GAEG;AACH,MAAM,OAAO,aAAa;IAMxB,gBAAwB,CAAC;IAEzB,gDAAgD;IACzC,MAAM,CAAC,KAAK;QACjB,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;QACtB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,kDAAkD;IAC3C,MAAM,CAAC,MAAM;QAClB,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;QACvB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,WAAmB;QAC7C,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QAEpC,IAAI,WAAW,KAAK,EAAE,EAAE,CAAC;YACvB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;YACtB,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,OAAO,CAAC,iBAAiB,GAAG,WAAW,CAAC;QACxC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,yEAAyE;IAClE,MAAM,CAAC,KAAK,CAAC,WAAmB;QACrC,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,YAAY,GAAG,WAAW,CAAC;QACnC,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;YAC7D,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBACrE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;oBACpC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACzB,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,QAAQ,CAAC,IAAwB;QAC7C,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC;QAC5B,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAClD,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC;QAC9B,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC;QACxC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,uDAAuD;IACvD,IAAW,OAAO,KAAc,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAEvD,wDAAwD;IACxD,IAAW,QAAQ,KAAc,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAEzD;;;;;OAKG;IACI,gBAAgB,KAA8B,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAErF,sFAAsF;IAC/E,OAAO,KAAyB,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;CACnE","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 { ChangesetId } from \"./ChangesetProps\";\r\n\r\n/** Properties for IModelVersion\r\n * @public\r\n */\r\nexport type IModelVersionProps =\r\n  { first: true, latest?: never, afterChangeSetId?: never, versionName?: never } |\r\n  { latest: true, first?: never, afterChangeSetId?: never, versionName?: never } |\r\n  { afterChangeSetId: string, first?: never, latest?: never, versionName?: never } |\r\n  { versionName: string, first?: never, latest?: never, afterChangeSetId?: never };\r\n\r\n/** Option to specify the version of the iModel to be acquired and used\r\n * @public\r\n */\r\nexport class IModelVersion {\r\n  private _first?: boolean;\r\n  private _latest?: boolean;\r\n  private _afterChangeSetId?: string;\r\n  private _versionName?: string;\r\n\r\n  private constructor() { }\r\n\r\n  /** Describes the first version of the iModel */\r\n  public static first(): IModelVersion {\r\n    const version = new IModelVersion();\r\n    version._first = true;\r\n    return version;\r\n  }\r\n\r\n  /** Describes the latest version of the iModel  */\r\n  public static latest(): IModelVersion {\r\n    const version = new IModelVersion();\r\n    version._latest = true;\r\n    return version;\r\n  }\r\n\r\n  /** Describes a version of the iModel by the last change set that needs\r\n   * to be applied or merged to the iModel.\r\n   * Note that all ChangeSets up to and and including the specified ChangeSet\r\n   * needs to be applied.\r\n   * If the changesetId is an empty string, it is assumed to be the first version\r\n   * before any change sets have been applied.\r\n   */\r\n  public static asOfChangeSet(changesetId: string): IModelVersion {\r\n    const version = new IModelVersion();\r\n\r\n    if (changesetId === \"\") {\r\n      version._first = true;\r\n      return version;\r\n    }\r\n\r\n    version._afterChangeSetId = changesetId;\r\n    return version;\r\n  }\r\n\r\n  /** Describes a version of the iModel with the specified version name  */\r\n  public static named(versionName: string): IModelVersion {\r\n    const version = new IModelVersion();\r\n    version._versionName = versionName;\r\n    return version;\r\n  }\r\n\r\n  public toJSON(): IModelVersionProps {\r\n    return this._versionName ? { versionName: this._versionName } :\r\n      this._afterChangeSetId ? { afterChangeSetId: this._afterChangeSetId } :\r\n        this._first ? { first: this._first } :\r\n          { latest: true };\r\n  }\r\n\r\n  /** Creates a version from an IModelVersionProps */\r\n  public static fromJSON(json: IModelVersionProps): IModelVersion {\r\n    const version = new IModelVersion();\r\n    version._first = json.first;\r\n    version._afterChangeSetId = json.afterChangeSetId;\r\n    version._latest = json.latest;\r\n    version._versionName = json.versionName;\r\n    return version;\r\n  }\r\n\r\n  /** Returns true if this describes the first version */\r\n  public get isFirst(): boolean { return !!this._first; }\r\n\r\n  /** Returns true if this describes the latest version */\r\n  public get isLatest(): boolean { return !!this._latest; }\r\n\r\n  /** Returns the last change set id to be applied to the iModel\r\n   * to get to this specified version. @see asOfChangeSet().\r\n   * Note that this method does not attempt to resolve the change set\r\n   * if this describes the first version, last version, named version, etc.\r\n   * @see evaluateChangeSet() for those use cases.\r\n   */\r\n  public getAsOfChangeSet(): ChangesetId | undefined { return this._afterChangeSetId; }\r\n\r\n  /** Returns the name of the version if this describes a named version. @see named() */\r\n  public getName(): string | undefined { return this._versionName; }\r\n}\r\n"]}
+{"version":3,"file":"IModelVersion.js","sourceRoot":"","sources":["../../src/IModelVersion.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAaH;;GAEG;AACH,MAAM,OAAO,aAAa;IAChB,MAAM,CAAW;IACjB,OAAO,CAAW;IAClB,iBAAiB,CAAU;IAC3B,YAAY,CAAU;IAE9B,gBAAwB,CAAC;IAEzB,gDAAgD;IACzC,MAAM,CAAC,KAAK;QACjB,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;QACtB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,kDAAkD;IAC3C,MAAM,CAAC,MAAM;QAClB,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;QACvB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,WAAmB;QAC7C,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QAEpC,IAAI,WAAW,KAAK,EAAE,EAAE,CAAC;YACvB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;YACtB,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,OAAO,CAAC,iBAAiB,GAAG,WAAW,CAAC;QACxC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,yEAAyE;IAClE,MAAM,CAAC,KAAK,CAAC,WAAmB;QACrC,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,YAAY,GAAG,WAAW,CAAC;QACnC,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;YAC7D,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBACrE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;oBACpC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACzB,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,QAAQ,CAAC,IAAwB;QAC7C,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC;QAC5B,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAClD,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC;QAC9B,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC;QACxC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,uDAAuD;IACvD,IAAW,OAAO,KAAc,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAEvD,wDAAwD;IACxD,IAAW,QAAQ,KAAc,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAEzD;;;;;OAKG;IACI,gBAAgB,KAA8B,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAErF,sFAAsF;IAC/E,OAAO,KAAyB,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;CACnE","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 { ChangesetId } from \"./ChangesetProps\";\n\n/** Properties for IModelVersion\n * @public\n */\nexport type IModelVersionProps =\n  { first: true, latest?: never, afterChangeSetId?: never, versionName?: never } |\n  { latest: true, first?: never, afterChangeSetId?: never, versionName?: never } |\n  { afterChangeSetId: string, first?: never, latest?: never, versionName?: never } |\n  { versionName: string, first?: never, latest?: never, afterChangeSetId?: never };\n\n/** Option to specify the version of the iModel to be acquired and used\n * @public\n */\nexport class IModelVersion {\n  private _first?: boolean;\n  private _latest?: boolean;\n  private _afterChangeSetId?: string;\n  private _versionName?: string;\n\n  private constructor() { }\n\n  /** Describes the first version of the iModel */\n  public static first(): IModelVersion {\n    const version = new IModelVersion();\n    version._first = true;\n    return version;\n  }\n\n  /** Describes the latest version of the iModel  */\n  public static latest(): IModelVersion {\n    const version = new IModelVersion();\n    version._latest = true;\n    return version;\n  }\n\n  /** Describes a version of the iModel by the last change set that needs\n   * to be applied or merged to the iModel.\n   * Note that all ChangeSets up to and and including the specified ChangeSet\n   * needs to be applied.\n   * If the changesetId is an empty string, it is assumed to be the first version\n   * before any change sets have been applied.\n   */\n  public static asOfChangeSet(changesetId: string): IModelVersion {\n    const version = new IModelVersion();\n\n    if (changesetId === \"\") {\n      version._first = true;\n      return version;\n    }\n\n    version._afterChangeSetId = changesetId;\n    return version;\n  }\n\n  /** Describes a version of the iModel with the specified version name  */\n  public static named(versionName: string): IModelVersion {\n    const version = new IModelVersion();\n    version._versionName = versionName;\n    return version;\n  }\n\n  public toJSON(): IModelVersionProps {\n    return this._versionName ? { versionName: this._versionName } :\n      this._afterChangeSetId ? { afterChangeSetId: this._afterChangeSetId } :\n        this._first ? { first: this._first } :\n          { latest: true };\n  }\n\n  /** Creates a version from an IModelVersionProps */\n  public static fromJSON(json: IModelVersionProps): IModelVersion {\n    const version = new IModelVersion();\n    version._first = json.first;\n    version._afterChangeSetId = json.afterChangeSetId;\n    version._latest = json.latest;\n    version._versionName = json.versionName;\n    return version;\n  }\n\n  /** Returns true if this describes the first version */\n  public get isFirst(): boolean { return !!this._first; }\n\n  /** Returns true if this describes the latest version */\n  public get isLatest(): boolean { return !!this._latest; }\n\n  /** Returns the last change set id to be applied to the iModel\n   * to get to this specified version. @see asOfChangeSet().\n   * Note that this method does not attempt to resolve the change set\n   * if this describes the first version, last version, named version, etc.\n   * @see evaluateChangeSet() for those use cases.\n   */\n  public getAsOfChangeSet(): ChangesetId | undefined { return this._afterChangeSetId; }\n\n  /** Returns the name of the version if this describes a named version. @see named() */\n  public getName(): string | undefined { return this._versionName; }\n}\n"]}

package/lib/esm/ITwinError.d.ts

@@ -59,7 +59,7 @@ export declare namespace InUseLocksError {
      * it first checks [[ITwinError.isITwinError]] and then checks that the namespace property is "itwinjs-core" and the errorKey property is "in-use-locks".
      */
     function isInUseLocksError(error: unknown): error is InUseLocksError;
-    /** throws an error which passes the [[isInUseLocksError]] type guard function */
+    /** throws an error which passes the [[InUseLocksError.isInUseLocksError]] type guard function */
     function throwInUseLocksError(inUseLocks: InUseLock[], message?: string, metadata?: LoggingMetaData): never;
 }
 /** @beta */

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

@@ -1 +1 @@
-{"version":3,"file":"ITwinError.d.ts","sourceRoot":"","sources":["../../src/ITwinError.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAgB,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,iDAAiD;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,KAAK,EAAE,SAAS,CAAC;IACjB,qDAAqD;IACrD,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,UAAU;IACzB,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAC;IAClB,sGAAsG;IACtG,QAAQ,EAAE,MAAM,CAAC;IACjB,0EAA0E;IAC1E,OAAO,EAAE,MAAM,CAAC;IAChB,gCAAgC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oCAAoC;IACpC,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B;AAED;;;;EAIE;AACF,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,SAAS,EAAE,cAAc,CAAC;IAC1B,QAAQ,EAAE,cAAc,CAAC;IACzB,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB;AAED,YAAY;AACZ,yBAAiB,eAAe,CAAC;IAE/B;;;OAGG;IACH,SAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,eAAe,CAE1E;IAED,iFAAiF;IACjF,SAAgB,oBAAoB,CAAC,UAAU,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe,GAAG,KAAK,CAajH;CAEF;AACD,YAAY;AACZ,yBAAiB,UAAU,CAAC;IAC1B,mGAAmG;IACnG,SAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,UAAU,CAEhE;IAED,iEAAiE;IACjE,SAAgB,WAAW,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,CAE/D;CAEF"}
+{"version":3,"file":"ITwinError.d.ts","sourceRoot":"","sources":["../../src/ITwinError.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAgB,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,iDAAiD;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,KAAK,EAAE,SAAS,CAAC;IACjB,qDAAqD;IACrD,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,UAAU;IACzB,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAC;IAClB,sGAAsG;IACtG,QAAQ,EAAE,MAAM,CAAC;IACjB,0EAA0E;IAC1E,OAAO,EAAE,MAAM,CAAC;IAChB,gCAAgC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oCAAoC;IACpC,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B;AAED;;;;EAIE;AACF,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,SAAS,EAAE,cAAc,CAAC;IAC1B,QAAQ,EAAE,cAAc,CAAC;IACzB,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB;AAED,YAAY;AACZ,yBAAiB,eAAe,CAAC;IAE/B;;;OAGG;IACH,SAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,eAAe,CAE1E;IAED,iGAAiG;IACjG,SAAgB,oBAAoB,CAAC,UAAU,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe,GAAG,KAAK,CAajH;CAEF;AACD,YAAY;AACZ,yBAAiB,UAAU,CAAC;IAC1B,mGAAmG;IACnG,SAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,UAAU,CAEhE;IAED,iEAAiE;IACjE,SAAgB,WAAW,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,CAE/D;CAEF"}

package/lib/esm/ITwinError.js

@@ -17,7 +17,7 @@ export var InUseLocksError;
         return ITwinError.isITwinError(error) && error.namespace === "itwinjs-core" && error.errorKey === "in-use-locks";
     }
     InUseLocksError.isInUseLocksError = isInUseLocksError;
-    /** throws an error which passes the [[isInUseLocksError]] type guard function */
+    /** throws an error which passes the [[InUseLocksError.isInUseLocksError]] type guard function */
     function throwInUseLocksError(inUseLocks, message, metadata) {
         const errorObject = new Error();
         errorObject.name = "InUseLocksError"; // optional but makes it so that when the error is thrown and not caught we see InUseLocksError: 'message' instead of Error: 'message'

package/lib/esm/ITwinError.js.map

@@ -1 +1 @@
-{"version":3,"file":"ITwinError.js","sourceRoot":"","sources":["../../src/ITwinError.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAmB,MAAM,qBAAqB,CAAC;AAuDpE,YAAY;AACZ,MAAM,KAAW,eAAe,CA0B/B;AA1BD,WAAiB,eAAe;IAE9B;;;OAGG;IACH,SAAgB,iBAAiB,CAAC,KAAc;QAC9C,OAAO,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,SAAS,KAAK,cAAc,IAAI,KAAK,CAAC,QAAQ,KAAK,cAAc,CAAC;IACnH,CAAC;IAFe,iCAAiB,oBAEhC,CAAA;IAED,iFAAiF;IACjF,SAAgB,oBAAoB,CAAC,UAAuB,EAAE,OAAgB,EAAE,QAA0B;QACxG,MAAM,WAAW,GAAG,IAAI,KAAK,EAAE,CAAC;QAChC,WAAW,CAAC,IAAI,GAAG,iBAAiB,CAAC,CAAC,sIAAsI;QAC5K,KAAK,CAAC,iBAAiB,CAAC,WAAW,EAAE,oBAAoB,CAAC,CAAC,CAAC,oGAAoG;QAChK,MAAM,SAAS,GAAoB;YACjC,SAAS,EAAE,cAAc;YACzB,QAAQ,EAAE,cAAc;YACxB,OAAO,EAAE,OAAO,IAAI,8DAA8D;YAClF,QAAQ;YACR,UAAU;SACX,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QACtC,MAAM,WAAW,CAAC;IACpB,CAAC;IAbe,oCAAoB,uBAanC,CAAA;AAEH,CAAC,EA1BgB,eAAe,KAAf,eAAe,QA0B/B;AACD,YAAY;AACZ,MAAM,KAAW,UAAU,CAW1B;AAXD,WAAiB,UAAU;IACzB,mGAAmG;IACnG,SAAgB,YAAY,CAAC,KAAc;QACzC,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,WAAW,IAAI,KAAK,IAAI,UAAU,IAAI,KAAK,IAAI,SAAS,IAAI,KAAK,CAAC;IACjJ,CAAC;IAFe,uBAAY,eAE3B,CAAA;IAED,iEAAiE;IACjE,SAAgB,WAAW,CAAC,GAAe;QACzC,OAAO,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAFe,sBAAW,cAE1B,CAAA;AAEH,CAAC,EAXgB,UAAU,KAAV,UAAU,QAW1B;AAAA,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\nimport { BentleyError, LoggingMetaData } from \"@itwin/core-bentley\";\r\nimport { LockState } from \"./IModelError\";\r\n\r\n/**\r\n * Detailed information about a particular object Lock that is causing the Lock update conflict.\r\n * An example of a lock update conflict would be attempting to use [LockControl.acquireLocks]($backend) on an object that is already locked by another Briefcase.\r\n * @beta\r\n */\r\nexport interface InUseLock {\r\n  /** Id of the object that is causing conflict. */\r\n  objectId: string;\r\n  /**\r\n   * The level of conflicting lock. Possible values are {@link LockState.Shared}, {@link LockState.Exclusive}.\r\n   * See {@link LockState}.\r\n   */\r\n  state: LockState;\r\n  /** An array of Briefcase ids that hold this lock. */\r\n  briefcaseIds: number[];\r\n}\r\n\r\n/**\r\n * An interface used to describe an error for a developer/application. The message is not intended to be displayed to an end user.\r\n * This error interface should be extended when needing to throw errors with extra properties defined on them. See [[InUseLocksError]] for an example.\r\n * When extending ITwinError, one should typically add a type guard function and a function to throw the error either to a namespace for their error or as standalone functions.\r\n * See [[InUseLocksError.throwInUseLocksError]] and [[InUseLocksError.isInUseLocksError]] for examples of how to throw and check that an error is of type InUseLocksError.\r\n * * Example of catching a ITwinError:\r\n * ``` ts\r\n * [[include:ITwinError.catchAndHandleITwinError]]\r\n * ```\r\n * @beta\r\n */\r\nexport interface ITwinError {\r\n  /** namespace for the error. This is a unique qualifier for the errorKey. */\r\n  namespace: string;\r\n  /** unique key for error, within namespace. All errorKeys within the same namespace must be unique. */\r\n  errorKey: string;\r\n  /** explanation of what went wrong. Intended to be read by a developer. */\r\n  message: string;\r\n  /** stack trace of the error. */\r\n  stack?: string;\r\n  /** metadata about the exception. */\r\n  metadata?: LoggingMetaData;\r\n}\r\n\r\n/**\r\n * An error raised when there is a lock conflict detected.\r\n * Typically this error would be thrown by [LockControl.acquireLocks]($backend) when you are requesting a lock on an element that is already held by another briefcase.\r\n * @beta\r\n*/\r\nexport interface InUseLocksError extends ITwinError {\r\n  namespace: \"itwinjs-core\";\r\n  errorKey: \"in-use-locks\";\r\n  inUseLocks: InUseLock[];\r\n}\r\n\r\n/** @beta */\r\nexport namespace InUseLocksError {\r\n\r\n  /**\r\n   * type guard function that returns whether or not the passed in parameter is an [[InUseLocksError]].\r\n   * it first checks [[ITwinError.isITwinError]] and then checks that the namespace property is \"itwinjs-core\" and the errorKey property is \"in-use-locks\".\r\n   */\r\n  export function isInUseLocksError(error: unknown): error is InUseLocksError {\r\n    return ITwinError.isITwinError(error) && error.namespace === \"itwinjs-core\" && error.errorKey === \"in-use-locks\";\r\n  }\r\n\r\n  /** throws an error which passes the [[isInUseLocksError]] type guard function */\r\n  export function throwInUseLocksError(inUseLocks: InUseLock[], message?: string, metadata?: LoggingMetaData): never {\r\n    const errorObject = new Error();\r\n    errorObject.name = \"InUseLocksError\"; // optional but makes it so that when the error is thrown and not caught we see InUseLocksError: 'message' instead of Error: 'message'\r\n    Error.captureStackTrace(errorObject, throwInUseLocksError); // optional: whether we want to hide throwInUseLocksError or not from the stack. not super important\r\n    const lockError: InUseLocksError = {\r\n      namespace: \"itwinjs-core\",\r\n      errorKey: \"in-use-locks\",\r\n      message: message ?? \"One or more objects are already locked by another briefcase.\",\r\n      metadata,\r\n      inUseLocks,\r\n    };\r\n    Object.assign(errorObject, lockError);\r\n    throw errorObject;\r\n  }\r\n\r\n}\r\n/** @beta */\r\nexport namespace ITwinError {\r\n  /** type guard function that returns whether or not the passed in parameter is an [[ITwinError]] */\r\n  export function isITwinError(error: unknown): error is ITwinError {\r\n    return error !== undefined && error !== null && typeof error === \"object\" && \"namespace\" in error && \"errorKey\" in error && \"message\" in error;\r\n  }\r\n\r\n  /** get the meta data associated with this ITwinError, if any. */\r\n  export function getMetaData(err: ITwinError): object | undefined {\r\n    return BentleyError.getMetaData(err.metadata);\r\n  }\r\n\r\n};\r\n"]}
+{"version":3,"file":"ITwinError.js","sourceRoot":"","sources":["../../src/ITwinError.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAmB,MAAM,qBAAqB,CAAC;AAuDpE,YAAY;AACZ,MAAM,KAAW,eAAe,CA0B/B;AA1BD,WAAiB,eAAe;IAE9B;;;OAGG;IACH,SAAgB,iBAAiB,CAAC,KAAc;QAC9C,OAAO,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,SAAS,KAAK,cAAc,IAAI,KAAK,CAAC,QAAQ,KAAK,cAAc,CAAC;IACnH,CAAC;IAFe,iCAAiB,oBAEhC,CAAA;IAED,iGAAiG;IACjG,SAAgB,oBAAoB,CAAC,UAAuB,EAAE,OAAgB,EAAE,QAA0B;QACxG,MAAM,WAAW,GAAG,IAAI,KAAK,EAAE,CAAC;QAChC,WAAW,CAAC,IAAI,GAAG,iBAAiB,CAAC,CAAC,sIAAsI;QAC5K,KAAK,CAAC,iBAAiB,CAAC,WAAW,EAAE,oBAAoB,CAAC,CAAC,CAAC,oGAAoG;QAChK,MAAM,SAAS,GAAoB;YACjC,SAAS,EAAE,cAAc;YACzB,QAAQ,EAAE,cAAc;YACxB,OAAO,EAAE,OAAO,IAAI,8DAA8D;YAClF,QAAQ;YACR,UAAU;SACX,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QACtC,MAAM,WAAW,CAAC;IACpB,CAAC;IAbe,oCAAoB,uBAanC,CAAA;AAEH,CAAC,EA1BgB,eAAe,KAAf,eAAe,QA0B/B;AACD,YAAY;AACZ,MAAM,KAAW,UAAU,CAW1B;AAXD,WAAiB,UAAU;IACzB,mGAAmG;IACnG,SAAgB,YAAY,CAAC,KAAc;QACzC,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,WAAW,IAAI,KAAK,IAAI,UAAU,IAAI,KAAK,IAAI,SAAS,IAAI,KAAK,CAAC;IACjJ,CAAC;IAFe,uBAAY,eAE3B,CAAA;IAED,iEAAiE;IACjE,SAAgB,WAAW,CAAC,GAAe;QACzC,OAAO,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAFe,sBAAW,cAE1B,CAAA;AAEH,CAAC,EAXgB,UAAU,KAAV,UAAU,QAW1B;AAAA,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport { BentleyError, LoggingMetaData } from \"@itwin/core-bentley\";\nimport { LockState } from \"./IModelError\";\n\n/**\n * Detailed information about a particular object Lock that is causing the Lock update conflict.\n * An example of a lock update conflict would be attempting to use [LockControl.acquireLocks]($backend) on an object that is already locked by another Briefcase.\n * @beta\n */\nexport interface InUseLock {\n  /** Id of the object that is causing conflict. */\n  objectId: string;\n  /**\n   * The level of conflicting lock. Possible values are {@link LockState.Shared}, {@link LockState.Exclusive}.\n   * See {@link LockState}.\n   */\n  state: LockState;\n  /** An array of Briefcase ids that hold this lock. */\n  briefcaseIds: number[];\n}\n\n/**\n * An interface used to describe an error for a developer/application. The message is not intended to be displayed to an end user.\n * This error interface should be extended when needing to throw errors with extra properties defined on them. See [[InUseLocksError]] for an example.\n * When extending ITwinError, one should typically add a type guard function and a function to throw the error either to a namespace for their error or as standalone functions.\n * See [[InUseLocksError.throwInUseLocksError]] and [[InUseLocksError.isInUseLocksError]] for examples of how to throw and check that an error is of type InUseLocksError.\n * * Example of catching a ITwinError:\n * ``` ts\n * [[include:ITwinError.catchAndHandleITwinError]]\n * ```\n * @beta\n */\nexport interface ITwinError {\n  /** namespace for the error. This is a unique qualifier for the errorKey. */\n  namespace: string;\n  /** unique key for error, within namespace. All errorKeys within the same namespace must be unique. */\n  errorKey: string;\n  /** explanation of what went wrong. Intended to be read by a developer. */\n  message: string;\n  /** stack trace of the error. */\n  stack?: string;\n  /** metadata about the exception. */\n  metadata?: LoggingMetaData;\n}\n\n/**\n * An error raised when there is a lock conflict detected.\n * Typically this error would be thrown by [LockControl.acquireLocks]($backend) when you are requesting a lock on an element that is already held by another briefcase.\n * @beta\n*/\nexport interface InUseLocksError extends ITwinError {\n  namespace: \"itwinjs-core\";\n  errorKey: \"in-use-locks\";\n  inUseLocks: InUseLock[];\n}\n\n/** @beta */\nexport namespace InUseLocksError {\n\n  /**\n   * type guard function that returns whether or not the passed in parameter is an [[InUseLocksError]].\n   * it first checks [[ITwinError.isITwinError]] and then checks that the namespace property is \"itwinjs-core\" and the errorKey property is \"in-use-locks\".\n   */\n  export function isInUseLocksError(error: unknown): error is InUseLocksError {\n    return ITwinError.isITwinError(error) && error.namespace === \"itwinjs-core\" && error.errorKey === \"in-use-locks\";\n  }\n\n  /** throws an error which passes the [[InUseLocksError.isInUseLocksError]] type guard function */\n  export function throwInUseLocksError(inUseLocks: InUseLock[], message?: string, metadata?: LoggingMetaData): never {\n    const errorObject = new Error();\n    errorObject.name = \"InUseLocksError\"; // optional but makes it so that when the error is thrown and not caught we see InUseLocksError: 'message' instead of Error: 'message'\n    Error.captureStackTrace(errorObject, throwInUseLocksError); // optional: whether we want to hide throwInUseLocksError or not from the stack. not super important\n    const lockError: InUseLocksError = {\n      namespace: \"itwinjs-core\",\n      errorKey: \"in-use-locks\",\n      message: message ?? \"One or more objects are already locked by another briefcase.\",\n      metadata,\n      inUseLocks,\n    };\n    Object.assign(errorObject, lockError);\n    throw errorObject;\n  }\n\n}\n/** @beta */\nexport namespace ITwinError {\n  /** type guard function that returns whether or not the passed in parameter is an [[ITwinError]] */\n  export function isITwinError(error: unknown): error is ITwinError {\n    return error !== undefined && error !== null && typeof error === \"object\" && \"namespace\" in error && \"errorKey\" in error && \"message\" in error;\n  }\n\n  /** get the meta data associated with this ITwinError, if any. */\n  export function getMetaData(err: ITwinError): object | undefined {\n    return BentleyError.getMetaData(err.metadata);\n  }\n\n};\n"]}

package/lib/esm/Image.d.ts

@@ -40,12 +40,9 @@ export declare class ImageBuffer {
      * @throws Error if the length of the Uint8Array is not appropriate for the specified width and format.
      */
     static create(data: Uint8Array, format: ImageBufferFormat, width: number): ImageBuffer;
-    /** @internal */
-    protected static isValidData(data: Uint8Array, format: ImageBufferFormat, width: number): boolean;
-    /** @internal */
-    protected static computeHeight(data: Uint8Array, format: ImageBufferFormat, width: number): number;
-    /** @internal */
-    protected constructor(data: Uint8Array, format: ImageBufferFormat, width: number);
+    private static isValidData;
+    private static computeHeight;
+    private constructor();
 }
 /** Returns whether the input is a power of two.
  * @note Floating point inputs are truncated.
@@ -71,8 +68,10 @@ export declare enum ImageSourceFormat {
      */
     Svg = 3
 }
-/** @internal */
-export declare function isValidImageSourceFormat(format: ImageSourceFormat): boolean;
+/** Returns true if the numeric `format` value is a valid member of the [[ImageSourceFormat]] enumeration.
+ * @public
+ */
+export declare function isValidImageSourceFormat(format: number): format is ImageSourceFormat;
 /** Image data encoded and compressed in either Jpeg or Png format.
  * @public
  */
@@ -84,4 +83,19 @@ export declare class ImageSource {
     /** Construct a new ImageSource, which takes ownership of the Uint8Array. */
     constructor(data: Uint8Array | string, format: ImageSourceFormat);
 }
+/** An [[ImageSource]] encoded in binary form as a Jpeg or Png, as opposed to one encoded
+ * in string format as an Svg.
+ * Only binary ImageSources can be used for [[Texture]]s stored in [[IModelDb]]s.
+ * @public
+ */
+export interface BinaryImageSource {
+    /** The format in which the [[data]] is encoded. */
+    readonly format: ImageSourceFormat.Jpeg | ImageSourceFormat.Png;
+    /** The image data encoded according to [[format]]. */
+    readonly data: Uint8Array;
+}
+/** Returns true if `source` is a [[BinaryImageSource]].
+ * @public
+ */
+export declare function isBinaryImageSource(source: ImageSource): source is BinaryImageSource;
 //# sourceMappingURL=Image.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Image.d.ts","sourceRoot":"","sources":["../../src/Image.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;GAKG;AACH,oBAAY,iBAAiB;IAC3B,uCAAuC;IACvC,IAAI,IAAI;IACR,sCAAsC;IACtC,GAAG,IAAI;IACP,wBAAwB;IACxB,KAAK,IAAI;CACV;AAED;;GAEG;AACH,qBAAa,WAAW;IACtB,sGAAsG;IACtG,SAAgB,IAAI,EAAE,UAAU,CAAC;IACjC,wCAAwC;IACxC,SAAgB,MAAM,EAAE,iBAAiB,CAAC;IAC1C,+BAA+B;IAC/B,SAAgB,KAAK,EAAE,MAAM,CAAC;IAE9B,2DAA2D;IAC3D,IAAW,gBAAgB,IAAI,MAAM,CAAyD;IAE9F,0FAA0F;WAC5E,mBAAmB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM;IAQpE,8CAA8C;IAC9C,IAAW,MAAM,IAAI,MAAM,CAA0E;IAErG;;;;;;;OAOG;WACW,MAAM,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW;IAO7F,gBAAgB;IAChB,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO;IAKjG,gBAAgB;IAChB,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;IAIlG,gBAAgB;IAChB,SAAS,aAAa,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAE,MAAM;CAKjF;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAEjD;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAMzD;AAED;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,kDAAkD;IAClD,IAAI,IAAI;IACR,iDAAiD;IACjD,GAAG,IAAI;IACP;;OAEG;IACH,GAAG,IAAI;CACR;AAED,gBAAgB;AAChB,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAS3E;AAED;;GAEG;AACH,qBAAa,WAAW;IACtB,2CAA2C;IAC3C,SAAgB,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;IAC1C,4BAA4B;IAC5B,SAAgB,MAAM,EAAE,iBAAiB,CAAC;IAE1C,4EAA4E;gBACzD,IAAI,EAAE,UAAU,GAAG,MAAM,EAAE,MAAM,EAAE,iBAAiB;CAIxE"}
+{"version":3,"file":"Image.d.ts","sourceRoot":"","sources":["../../src/Image.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;GAKG;AACH,oBAAY,iBAAiB;IAC3B,uCAAuC;IACvC,IAAI,IAAI;IACR,sCAAsC;IACtC,GAAG,IAAI;IACP,wBAAwB;IACxB,KAAK,IAAI;CACV;AAED;;GAEG;AACH,qBAAa,WAAW;IACtB,sGAAsG;IACtG,SAAgB,IAAI,EAAE,UAAU,CAAC;IACjC,wCAAwC;IACxC,SAAgB,MAAM,EAAE,iBAAiB,CAAC;IAC1C,+BAA+B;IAC/B,SAAgB,KAAK,EAAE,MAAM,CAAC;IAE9B,2DAA2D;IAC3D,IAAW,gBAAgB,IAAI,MAAM,CAAyD;IAE9F,0FAA0F;WAC5E,mBAAmB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM;IAQpE,8CAA8C;IAC9C,IAAW,MAAM,IAAI,MAAM,CAA0E;IAErG;;;;;;;OAOG;WACW,MAAM,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW;IAO7F,OAAO,CAAC,MAAM,CAAC,WAAW;IAK1B,OAAO,CAAC,MAAM,CAAC,aAAa;IAI5B,OAAO;CAKR;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAEjD;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAMzD;AAED;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,kDAAkD;IAClD,IAAI,IAAI;IACR,iDAAiD;IACjD,GAAG,IAAI;IACP;;OAEG;IACH,GAAG,IAAI;CACR;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,IAAI,iBAAiB,CASpF;AAED;;GAEG;AACH,qBAAa,WAAW;IACtB,2CAA2C;IAC3C,SAAgB,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;IAC1C,4BAA4B;IAC5B,SAAgB,MAAM,EAAE,iBAAiB,CAAC;IAE1C,4EAA4E;gBACzD,IAAI,EAAE,UAAU,GAAG,MAAM,EAAE,MAAM,EAAE,iBAAiB;CAIxE;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,mDAAmD;IACnD,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAC,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC;IAChE,sDAAsD;IACtD,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;CAC3B;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,IAAI,iBAAiB,CAEpF"}

package/lib/esm/Image.js

@@ -24,6 +24,12 @@ export var ImageBufferFormat;
  * @public
  */
 export class ImageBuffer {
+    /** Image data in which each pixel occupies 1 or more bytes depending of the [[ImageBufferFormat]]. */
+    data;
+    /** Format of the bytes in the image. */
+    format;
+    /** Width of image in pixels */
+    width;
     /** Return the number of bytes allocated for each pixel. */
     get numBytesPerPixel() { return ImageBuffer.getNumBytesPerPixel(this.format); }
     /** Determine the number of bytes allocated to a single pixel for the specified format. */
@@ -49,16 +55,13 @@ export class ImageBuffer {
             throw new Error("The number of bytes supplied for ImageBuffer do not match its width and format.");
         return new ImageBuffer(data, format, width);
     }
-    /** @internal */
     static isValidData(data, format, width) {
         const height = this.computeHeight(data, format, width);
         return width > 0 && height > 0 && Math.floor(width) === width && Math.floor(height) === height;
     }
-    /** @internal */
     static computeHeight(data, format, width) {
         return data.length / (width * this.getNumBytesPerPixel(format));
     }
-    /** @internal */
     constructor(data, format, width) {
         this.data = data;
         this.format = format;
@@ -97,7 +100,9 @@ export var ImageSourceFormat;
      */
     ImageSourceFormat[ImageSourceFormat["Svg"] = 3] = "Svg";
 })(ImageSourceFormat || (ImageSourceFormat = {}));
-/** @internal */
+/** Returns true if the numeric `format` value is a valid member of the [[ImageSourceFormat]] enumeration.
+ * @public
+ */
 export function isValidImageSourceFormat(format) {
     switch (format) {
         case ImageSourceFormat.Jpeg:
@@ -112,10 +117,20 @@ export function isValidImageSourceFormat(format) {
  * @public
  */
 export class ImageSource {
+    /** The content of the image, compressed */
+    data;
+    /** The compression type. */
+    format;
     /** Construct a new ImageSource, which takes ownership of the Uint8Array. */
     constructor(data, format) {
         this.data = data;
         this.format = format;
     }
 }
+/** Returns true if `source` is a [[BinaryImageSource]].
+ * @public
+ */
+export function isBinaryImageSource(source) {
+    return source.format !== ImageSourceFormat.Svg && source.data instanceof Uint8Array;
+}
 //# sourceMappingURL=Image.js.map

package/lib/esm/Image.js.map

@@ -1 +1 @@
-{"version":3,"file":"Image.js","sourceRoot":"","sources":["../../src/Image.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,CAAN,IAAY,iBAOX;AAPD,WAAY,iBAAiB;IAC3B,uCAAuC;IACvC,yDAAQ,CAAA;IACR,sCAAsC;IACtC,uDAAO,CAAA;IACP,wBAAwB;IACxB,2DAAS,CAAA;AACX,CAAC,EAPW,iBAAiB,KAAjB,iBAAiB,QAO5B;AAED;;GAEG;AACH,MAAM,OAAO,WAAW;IAQtB,2DAA2D;IAC3D,IAAW,gBAAgB,KAAa,OAAO,WAAW,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAE9F,0FAA0F;IACnF,MAAM,CAAC,mBAAmB,CAAC,MAAyB;QACzD,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,iBAAiB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;YACvC,KAAK,iBAAiB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;YACrC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;IAED,8CAA8C;IAC9C,IAAW,MAAM,KAAa,OAAO,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAErG;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,IAAgB,EAAE,MAAyB,EAAE,KAAa;QAC7E,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,iFAAiF,CAAC,CAAC;QAErG,OAAO,IAAI,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACN,MAAM,CAAC,WAAW,CAAC,IAAgB,EAAE,MAAyB,EAAE,KAAa;QACrF,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;QACvD,OAAO,KAAK,GAAG,CAAC,IAAI,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC;IACjG,CAAC;IAED,gBAAgB;IACN,MAAM,CAAC,aAAa,CAAC,IAAgB,EAAE,MAAyB,EAAE,KAAa;QACvF,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;IAClE,CAAC;IAED,gBAAgB;IAChB,YAAsB,IAAgB,EAAE,MAAyB,EAAE,KAAa;QAC9E,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,OAAO,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CAAC,GAAW;IAC/C,EAAE,GAAG,CAAC;IACN,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC;QAC7B,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC;IAEvB,OAAO,GAAG,GAAG,CAAC,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,iBASX;AATD,WAAY,iBAAiB;IAC3B,kDAAkD;IAClD,yDAAQ,CAAA;IACR,iDAAiD;IACjD,uDAAO,CAAA;IACP;;OAEG;IACH,uDAAO,CAAA;AACT,CAAC,EATW,iBAAiB,KAAjB,iBAAiB,QAS5B;AAED,gBAAgB;AAChB,MAAM,UAAU,wBAAwB,CAAC,MAAyB;IAChE,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,iBAAiB,CAAC,IAAI,CAAC;QAC5B,KAAK,iBAAiB,CAAC,GAAG,CAAC;QAC3B,KAAK,iBAAiB,CAAC,GAAG;YACxB,OAAO,IAAI,CAAC;QACd;YACE,OAAO,KAAK,CAAC;IACjB,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,WAAW;IAMtB,4EAA4E;IAC5E,YAAmB,IAAyB,EAAE,MAAyB;QACrE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Rendering\r\n */\r\n\r\n/** Format of an [[ImageBuffer]].\r\n * The format determines how many bytes are allocated for each pixel in the buffer and the semantics of each byte.\r\n * @see [[ImageBuffer.getNumBytesPerPixel]]\r\n * @public\r\n * @extensions\r\n */\r\nexport enum ImageBufferFormat {\r\n  /** RGBA format - 4 bytes per pixel. */\r\n  Rgba = 0,\r\n  /** RGB format - 3 bytes per pixel. */\r\n  Rgb = 2,\r\n  /** 1 byte per pixel. */\r\n  Alpha = 5,\r\n}\r\n\r\n/** Uncompressed rectangular bitmap image data.\r\n * @public\r\n */\r\nexport class ImageBuffer {\r\n  /** Image data in which each pixel occupies 1 or more bytes depending of the [[ImageBufferFormat]]. */\r\n  public readonly data: Uint8Array;\r\n  /** Format of the bytes in the image. */\r\n  public readonly format: ImageBufferFormat;\r\n  /** Width of image in pixels */\r\n  public readonly width: number;\r\n\r\n  /** Return the number of bytes allocated for each pixel. */\r\n  public get numBytesPerPixel(): number { return ImageBuffer.getNumBytesPerPixel(this.format); }\r\n\r\n  /** Determine the number of bytes allocated to a single pixel for the specified format. */\r\n  public static getNumBytesPerPixel(format: ImageBufferFormat): number {\r\n    switch (format) {\r\n      case ImageBufferFormat.Alpha: return 1;\r\n      case ImageBufferFormat.Rgb: return 3;\r\n      default: return 4;\r\n    }\r\n  }\r\n\r\n  /** Get the height of this image in pixels. */\r\n  public get height(): number { return ImageBuffer.computeHeight(this.data, this.format, this.width); }\r\n\r\n  /** Create a new ImageBuffer.\r\n   * @note The ImageBuffer takes ownership of the input Uint8Array.\r\n   * @param data The uncompressed image bytes. Must be a multiple of the width times the number of bytes per pixel specified by the format.\r\n   * @param format The format of the image.\r\n   * @param width The width of the image in pixels.\r\n   * @returns A new ImageBuffer.\r\n   * @throws Error if the length of the Uint8Array is not appropriate for the specified width and format.\r\n   */\r\n  public static create(data: Uint8Array, format: ImageBufferFormat, width: number): ImageBuffer {\r\n    if (!this.isValidData(data, format, width))\r\n      throw new Error(\"The number of bytes supplied for ImageBuffer do not match its width and format.\");\r\n\r\n    return new ImageBuffer(data, format, width);\r\n  }\r\n\r\n  /** @internal */\r\n  protected static isValidData(data: Uint8Array, format: ImageBufferFormat, width: number): boolean {\r\n    const height = this.computeHeight(data, format, width);\r\n    return width > 0 && height > 0 && Math.floor(width) === width && Math.floor(height) === height;\r\n  }\r\n\r\n  /** @internal */\r\n  protected static computeHeight(data: Uint8Array, format: ImageBufferFormat, width: number): number {\r\n    return data.length / (width * this.getNumBytesPerPixel(format));\r\n  }\r\n\r\n  /** @internal */\r\n  protected constructor(data: Uint8Array, format: ImageBufferFormat, width: number) {\r\n    this.data = data;\r\n    this.format = format;\r\n    this.width = width;\r\n  }\r\n}\r\n\r\n/** Returns whether the input is a power of two.\r\n * @note Floating point inputs are truncated.\r\n * @public\r\n */\r\nexport function isPowerOfTwo(num: number): boolean {\r\n  return 0 === (num & (num - 1));\r\n}\r\n\r\n/** Returns the first power-of-two value greater than or equal to the input.\r\n * @note Floating point inputs are truncated.\r\n * @public\r\n */\r\nexport function nextHighestPowerOfTwo(num: number): number {\r\n  --num;\r\n  for (let i = 1; i < 32; i <<= 1)\r\n    num = num | num >> i;\r\n\r\n  return num + 1;\r\n}\r\n\r\n/** The format of an ImageSource.\r\n * @public\r\n * @extensions\r\n */\r\nexport enum ImageSourceFormat {\r\n  /** Image data is stored with JPEG compression. */\r\n  Jpeg = 0,\r\n  /** Image data is stored with PNG compression. */\r\n  Png = 2,\r\n  /** Image is stored as an Svg stream.\r\n   * @note SVG is only valid for ImageSources in JavaScript. It *may not* be used for persistent textures.\r\n   */\r\n  Svg = 3,\r\n}\r\n\r\n/** @internal */\r\nexport function isValidImageSourceFormat(format: ImageSourceFormat): boolean {\r\n  switch (format) {\r\n    case ImageSourceFormat.Jpeg:\r\n    case ImageSourceFormat.Png:\r\n    case ImageSourceFormat.Svg:\r\n      return true;\r\n    default:\r\n      return false;\r\n  }\r\n}\r\n\r\n/** Image data encoded and compressed in either Jpeg or Png format.\r\n * @public\r\n */\r\nexport class ImageSource {\r\n  /** The content of the image, compressed */\r\n  public readonly data: Uint8Array | string;\r\n  /** The compression type. */\r\n  public readonly format: ImageSourceFormat;\r\n\r\n  /** Construct a new ImageSource, which takes ownership of the Uint8Array. */\r\n  public constructor(data: Uint8Array | string, format: ImageSourceFormat) {\r\n    this.data = data;\r\n    this.format = format;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Image.js","sourceRoot":"","sources":["../../src/Image.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,CAAN,IAAY,iBAOX;AAPD,WAAY,iBAAiB;IAC3B,uCAAuC;IACvC,yDAAQ,CAAA;IACR,sCAAsC;IACtC,uDAAO,CAAA;IACP,wBAAwB;IACxB,2DAAS,CAAA;AACX,CAAC,EAPW,iBAAiB,KAAjB,iBAAiB,QAO5B;AAED;;GAEG;AACH,MAAM,OAAO,WAAW;IACtB,sGAAsG;IACtF,IAAI,CAAa;IACjC,wCAAwC;IACxB,MAAM,CAAoB;IAC1C,+BAA+B;IACf,KAAK,CAAS;IAE9B,2DAA2D;IAC3D,IAAW,gBAAgB,KAAa,OAAO,WAAW,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAE9F,0FAA0F;IACnF,MAAM,CAAC,mBAAmB,CAAC,MAAyB;QACzD,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,iBAAiB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;YACvC,KAAK,iBAAiB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;YACrC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;IAED,8CAA8C;IAC9C,IAAW,MAAM,KAAa,OAAO,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAErG;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,IAAgB,EAAE,MAAyB,EAAE,KAAa;QAC7E,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,iFAAiF,CAAC,CAAC;QAErG,OAAO,IAAI,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC9C,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,IAAgB,EAAE,MAAyB,EAAE,KAAa;QACnF,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;QACvD,OAAO,KAAK,GAAG,CAAC,IAAI,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC;IACjG,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,IAAgB,EAAE,MAAyB,EAAE,KAAa;QACrF,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;IAClE,CAAC;IAED,YAAoB,IAAgB,EAAE,MAAyB,EAAE,KAAa;QAC5E,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,OAAO,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CAAC,GAAW;IAC/C,EAAE,GAAG,CAAC;IACN,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC;QAC7B,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC;IAEvB,OAAO,GAAG,GAAG,CAAC,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,iBASX;AATD,WAAY,iBAAiB;IAC3B,kDAAkD;IAClD,yDAAQ,CAAA;IACR,iDAAiD;IACjD,uDAAO,CAAA;IACP;;OAEG;IACH,uDAAO,CAAA;AACT,CAAC,EATW,iBAAiB,KAAjB,iBAAiB,QAS5B;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,MAAc;IACrD,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,iBAAiB,CAAC,IAAI,CAAC;QAC5B,KAAK,iBAAiB,CAAC,GAAG,CAAC;QAC3B,KAAK,iBAAiB,CAAC,GAAG;YACxB,OAAO,IAAI,CAAC;QACd;YACE,OAAO,KAAK,CAAC;IACjB,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,WAAW;IACtB,2CAA2C;IAC3B,IAAI,CAAsB;IAC1C,4BAA4B;IACZ,MAAM,CAAoB;IAE1C,4EAA4E;IAC5E,YAAmB,IAAyB,EAAE,MAAyB;QACrE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAcD;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAmB;IACrD,OAAO,MAAM,CAAC,MAAM,KAAK,iBAAiB,CAAC,GAAG,IAAI,MAAM,CAAC,IAAI,YAAY,UAAU,CAAC;AACtF,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Rendering\n */\n\n/** Format of an [[ImageBuffer]].\n * The format determines how many bytes are allocated for each pixel in the buffer and the semantics of each byte.\n * @see [[ImageBuffer.getNumBytesPerPixel]]\n * @public\n * @extensions\n */\nexport enum ImageBufferFormat {\n  /** RGBA format - 4 bytes per pixel. */\n  Rgba = 0,\n  /** RGB format - 3 bytes per pixel. */\n  Rgb = 2,\n  /** 1 byte per pixel. */\n  Alpha = 5,\n}\n\n/** Uncompressed rectangular bitmap image data.\n * @public\n */\nexport class ImageBuffer {\n  /** Image data in which each pixel occupies 1 or more bytes depending of the [[ImageBufferFormat]]. */\n  public readonly data: Uint8Array;\n  /** Format of the bytes in the image. */\n  public readonly format: ImageBufferFormat;\n  /** Width of image in pixels */\n  public readonly width: number;\n\n  /** Return the number of bytes allocated for each pixel. */\n  public get numBytesPerPixel(): number { return ImageBuffer.getNumBytesPerPixel(this.format); }\n\n  /** Determine the number of bytes allocated to a single pixel for the specified format. */\n  public static getNumBytesPerPixel(format: ImageBufferFormat): number {\n    switch (format) {\n      case ImageBufferFormat.Alpha: return 1;\n      case ImageBufferFormat.Rgb: return 3;\n      default: return 4;\n    }\n  }\n\n  /** Get the height of this image in pixels. */\n  public get height(): number { return ImageBuffer.computeHeight(this.data, this.format, this.width); }\n\n  /** Create a new ImageBuffer.\n   * @note The ImageBuffer takes ownership of the input Uint8Array.\n   * @param data The uncompressed image bytes. Must be a multiple of the width times the number of bytes per pixel specified by the format.\n   * @param format The format of the image.\n   * @param width The width of the image in pixels.\n   * @returns A new ImageBuffer.\n   * @throws Error if the length of the Uint8Array is not appropriate for the specified width and format.\n   */\n  public static create(data: Uint8Array, format: ImageBufferFormat, width: number): ImageBuffer {\n    if (!this.isValidData(data, format, width))\n      throw new Error(\"The number of bytes supplied for ImageBuffer do not match its width and format.\");\n\n    return new ImageBuffer(data, format, width);\n  }\n\n  private static isValidData(data: Uint8Array, format: ImageBufferFormat, width: number): boolean {\n    const height = this.computeHeight(data, format, width);\n    return width > 0 && height > 0 && Math.floor(width) === width && Math.floor(height) === height;\n  }\n\n  private static computeHeight(data: Uint8Array, format: ImageBufferFormat, width: number): number {\n    return data.length / (width * this.getNumBytesPerPixel(format));\n  }\n\n  private constructor(data: Uint8Array, format: ImageBufferFormat, width: number) {\n    this.data = data;\n    this.format = format;\n    this.width = width;\n  }\n}\n\n/** Returns whether the input is a power of two.\n * @note Floating point inputs are truncated.\n * @public\n */\nexport function isPowerOfTwo(num: number): boolean {\n  return 0 === (num & (num - 1));\n}\n\n/** Returns the first power-of-two value greater than or equal to the input.\n * @note Floating point inputs are truncated.\n * @public\n */\nexport function nextHighestPowerOfTwo(num: number): number {\n  --num;\n  for (let i = 1; i < 32; i <<= 1)\n    num = num | num >> i;\n\n  return num + 1;\n}\n\n/** The format of an ImageSource.\n * @public\n * @extensions\n */\nexport enum ImageSourceFormat {\n  /** Image data is stored with JPEG compression. */\n  Jpeg = 0,\n  /** Image data is stored with PNG compression. */\n  Png = 2,\n  /** Image is stored as an Svg stream.\n   * @note SVG is only valid for ImageSources in JavaScript. It *may not* be used for persistent textures.\n   */\n  Svg = 3,\n}\n\n/** Returns true if the numeric `format` value is a valid member of the [[ImageSourceFormat]] enumeration.\n * @public\n */\nexport function isValidImageSourceFormat(format: number): format is ImageSourceFormat {\n  switch (format) {\n    case ImageSourceFormat.Jpeg:\n    case ImageSourceFormat.Png:\n    case ImageSourceFormat.Svg:\n      return true;\n    default:\n      return false;\n  }\n}\n\n/** Image data encoded and compressed in either Jpeg or Png format.\n * @public\n */\nexport class ImageSource {\n  /** The content of the image, compressed */\n  public readonly data: Uint8Array | string;\n  /** The compression type. */\n  public readonly format: ImageSourceFormat;\n\n  /** Construct a new ImageSource, which takes ownership of the Uint8Array. */\n  public constructor(data: Uint8Array | string, format: ImageSourceFormat) {\n    this.data = data;\n    this.format = format;\n  }\n}\n\n/** An [[ImageSource]] encoded in binary form as a Jpeg or Png, as opposed to one encoded\n * in string format as an Svg.\n * Only binary ImageSources can be used for [[Texture]]s stored in [[IModelDb]]s.\n * @public\n */\nexport interface BinaryImageSource {\n  /** The format in which the [[data]] is encoded. */\n  readonly format: ImageSourceFormat.Jpeg | ImageSourceFormat.Png;\n  /** The image data encoded according to [[format]]. */\n  readonly data: Uint8Array;\n}\n\n/** Returns true if `source` is a [[BinaryImageSource]].\n * @public\n */\nexport function isBinaryImageSource(source: ImageSource): source is BinaryImageSource {\n  return source.format !== ImageSourceFormat.Svg && source.data instanceof Uint8Array;\n}\n"]}

package/lib/esm/IpcAppProps.d.ts

@@ -136,6 +136,8 @@ export interface IpcAppFunctions {
     closeIModel: (key: string) => Promise<void>;
     /** see BriefcaseConnection.saveChanges */
     saveChanges: (key: string, description?: string) => Promise<void>;
+    /** see BriefcaseConnection.abandonChanges */
+    abandonChanges: (key: string) => Promise<void>;
     /** see BriefcaseTxns.hasPendingTxns */
     hasPendingTxns: (key: string) => Promise<boolean>;
     /** see BriefcaseTxns.isUndoPossible */

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

@@ -1 +1 @@
-{"version":3,"file":"IpcAppProps.d.ts","sourceRoot":"","sources":["../../src/IpcAppProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/F,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,cAAc,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAClJ,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,kCAAkC;IAClC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,yDAAyD;IACzD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gCAAgC;IAChC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,eAAO,MAAM,wBAAwB,aAAc,MAAM,WAA0D,CAAC;AAEpH;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,sBAAsB;IACtB,EAAE,EAAE,UAAU,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,gBAAgB;AAChB,eAAO,MAAM,cAAc;;;;;CAKjB,CAAC;AAEX;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,IAAI,CAAC;CACvB;AAED,gBAAgB;AAChB,MAAM,WAAW,6BAA6B;IAC5C,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,yGAAyG;IACzG,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,eAAe;IAChE;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,wBAAwB;IACxB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,wBAAwB;IACxB,WAAW,EAAE,MAAM,EAAE,CAAC;IAEtB,sJAAsJ;IACtJ,IAAI,EAAE,6BAA6B,EAAE,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,qBAAqB,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,CAAC;IACpE,mBAAmB,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,CAAC;IAClE,0BAA0B,EAAE,CAAC,OAAO,EAAE,sBAAsB,EAAE,KAAK,IAAI,CAAC;IACxE,YAAY,EAAE,MAAM,IAAI,CAAC;IACzB,eAAe,EAAE,CAAC,cAAc,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACjE,wBAAwB,EAAE,MAAM,IAAI,CAAC;IACrC,0BAA0B,EAAE,MAAM,IAAI,CAAC;IACvC,oBAAoB,EAAE,MAAM,IAAI,CAAC;IACjC,oBAAoB,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IAChD,mBAAmB,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IAC/C,mBAAmB,EAAE,CAAC,iBAAiB,EAAE,mBAAmB,KAAK,IAAI,CAAC;IACtE,mBAAmB,EAAE,CAAC,iBAAiB,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAEtE,uBAAuB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAChD,wBAAwB,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC9D,2BAA2B,EAAE,CAAC,OAAO,EAAE,YAAY,KAAK,IAAI,CAAC;IAC7D,yBAAyB,EAAE,CAAC,MAAM,EAAE,QAAQ,KAAK,IAAI,CAAC;IACtD,yBAAyB,EAAE,CAAC,IAAI,EAAE,iBAAiB,GAAG,SAAS,KAAK,IAAI,CAAC;IACzE,uCAAuC,EAAE,CAAC,GAAG,EAAE,kBAAkB,GAAG,SAAS,KAAK,IAAI,CAAC;CACxF;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,qBAAqB,EAAE,CAAC,UAAU,EAAE,yBAAyB,EAAE,KAAK,IAAI,CAAC;CAC1E;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,GAAG,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnH,uCAAuC;IACvC,aAAa,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC5E,6CAA6C;IAC7C,cAAc,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC7E,6CAA6C;IAC7C,cAAc,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,qBAAqB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACvH,sCAAsC;IACtC,YAAY,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,mBAAmB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC/F,oCAAoC;IACpC,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,0CAA0C;IAC1C,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAClE,uCAAuC;IACvC,cAAc,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAClD,uCAAuC;IACvC,cAAc,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAClD,uCAAuC;IACvC,cAAc,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAClD,sCAAsC;IACtC,aAAa,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAChD,sCAAsC;IACtC,aAAa,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAEhD,0CAA0C;IAC1C,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACnH,+BAA+B;IAC/B,wBAAwB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,0CAA0C;IAC1C,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAChF,uEAAuE;IACvE,yBAAyB,EAAE,CAAC,UAAU,EAAE,cAAc,EAAE,WAAW,EAAE,kBAAkB,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5G;;OAEG;IACH,6BAA6B,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAErF,2BAA2B,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACvF,2BAA2B,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/D,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IAC3E,aAAa,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IACtD,YAAY,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IACrD,iBAAiB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD,4FAA4F;IAC5F,gBAAgB,EAAE,CAAC,IAAI,EAAE,IAAI,GAAG,KAAK,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CAC3D"}
+{"version":3,"file":"IpcAppProps.d.ts","sourceRoot":"","sources":["../../src/IpcAppProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/F,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,cAAc,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAClJ,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,kCAAkC;IAClC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,yDAAyD;IACzD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gCAAgC;IAChC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,eAAO,MAAM,wBAAwB,aAAc,MAAM,WAA0D,CAAC;AAEpH;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,sBAAsB;IACtB,EAAE,EAAE,UAAU,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,gBAAgB;AAChB,eAAO,MAAM,cAAc;;;;;CAKjB,CAAC;AAEX;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,IAAI,CAAC;CACvB;AAED,gBAAgB;AAChB,MAAM,WAAW,6BAA6B;IAC5C,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,yGAAyG;IACzG,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,eAAe;IAChE;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,wBAAwB;IACxB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,wBAAwB;IACxB,WAAW,EAAE,MAAM,EAAE,CAAC;IAEtB,sJAAsJ;IACtJ,IAAI,EAAE,6BAA6B,EAAE,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,qBAAqB,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,CAAC;IACpE,mBAAmB,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,CAAC;IAClE,0BAA0B,EAAE,CAAC,OAAO,EAAE,sBAAsB,EAAE,KAAK,IAAI,CAAC;IACxE,YAAY,EAAE,MAAM,IAAI,CAAC;IACzB,eAAe,EAAE,CAAC,cAAc,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACjE,wBAAwB,EAAE,MAAM,IAAI,CAAC;IACrC,0BAA0B,EAAE,MAAM,IAAI,CAAC;IACvC,oBAAoB,EAAE,MAAM,IAAI,CAAC;IACjC,oBAAoB,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IAChD,mBAAmB,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IAC/C,mBAAmB,EAAE,CAAC,iBAAiB,EAAE,mBAAmB,KAAK,IAAI,CAAC;IACtE,mBAAmB,EAAE,CAAC,iBAAiB,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAEtE,uBAAuB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAChD,wBAAwB,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC9D,2BAA2B,EAAE,CAAC,OAAO,EAAE,YAAY,KAAK,IAAI,CAAC;IAC7D,yBAAyB,EAAE,CAAC,MAAM,EAAE,QAAQ,KAAK,IAAI,CAAC;IACtD,yBAAyB,EAAE,CAAC,IAAI,EAAE,iBAAiB,GAAG,SAAS,KAAK,IAAI,CAAC;IACzE,uCAAuC,EAAE,CAAC,GAAG,EAAE,kBAAkB,GAAG,SAAS,KAAK,IAAI,CAAC;CACxF;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,qBAAqB,EAAE,CAAC,UAAU,EAAE,yBAAyB,EAAE,KAAK,IAAI,CAAC;CAC1E;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,GAAG,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnH,uCAAuC;IACvC,aAAa,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC5E,6CAA6C;IAC7C,cAAc,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC7E,6CAA6C;IAC7C,cAAc,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,qBAAqB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACvH,sCAAsC;IACtC,YAAY,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,mBAAmB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC/F,oCAAoC;IACpC,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,0CAA0C;IAC1C,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAClE,6CAA6C;IAC7C,cAAc,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,uCAAuC;IACvC,cAAc,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAClD,uCAAuC;IACvC,cAAc,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAClD,uCAAuC;IACvC,cAAc,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAClD,sCAAsC;IACtC,aAAa,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAChD,sCAAsC;IACtC,aAAa,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAEhD,0CAA0C;IAC1C,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACnH,+BAA+B;IAC/B,wBAAwB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,0CAA0C;IAC1C,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAChF,uEAAuE;IACvE,yBAAyB,EAAE,CAAC,UAAU,EAAE,cAAc,EAAE,WAAW,EAAE,kBAAkB,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5G;;OAEG;IACH,6BAA6B,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAErF,2BAA2B,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACvF,2BAA2B,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/D,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IAC3E,aAAa,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IACtD,YAAY,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IACrD,iBAAiB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD,4FAA4F;IAC5F,gBAAgB,EAAE,CAAC,IAAI,EAAE,IAAI,GAAG,KAAK,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CAC3D"}

package/lib/esm/IpcAppProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"IpcAppProps.js","sourceRoot":"","sources":["../../src/IpcAppProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAuBH;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,GAAG,cAAc,CAAC,SAAS,gBAAgB,QAAQ,EAAE,CAAC;AAwBpH,gBAAgB;AAChB,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,sBAAsB;IACjC,SAAS,EAAE,4BAA4B;IACvC,IAAI,EAAE,mBAAmB;IACzB,YAAY,EAAE,4BAA4B;CAClC,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 NativeApp\r\n */\r\n\r\nimport { GuidString, Id64String, IModelStatus, LogLevel, OpenMode } from \"@itwin/core-bentley\";\r\nimport { Range3dProps, XYZProps } from \"@itwin/core-geometry\";\r\nimport { OpenBriefcaseProps, OpenCheckpointArgs } from \"./BriefcaseTypes\";\r\nimport { ChangedEntities } from \"./ChangedEntities\";\r\nimport { ChangesetIndex, ChangesetIndexAndId } from \"./ChangesetProps\";\r\nimport { GeographicCRSProps } from \"./geometry/CoordinateReferenceSystem\";\r\nimport { EcefLocationProps, IModelConnectionProps, IModelRpcProps, RootSubjectProps, SnapshotOpenOptions, StandaloneOpenOptions } from \"./IModel\";\r\nimport { ModelGeometryChangesProps } from \"./ModelGeometryChanges\";\r\n\r\n/** Options for pulling changes into iModel.\r\n * @internal\r\n */\r\nexport interface PullChangesOptions {\r\n  /** Enables progress reporting. */\r\n  reportProgress?: boolean;\r\n  /** Interval for reporting progress (in milliseconds). */\r\n  progressInterval?: number;\r\n  /** Enables checks for abort. */\r\n  enableCancellation?: boolean;\r\n}\r\n\r\n/** Get IPC channel name used for reporting progress of pulling changes into iModel.\r\n * @internal\r\n */\r\nexport const getPullChangesIpcChannel = (iModelId: string) => `${ipcAppChannels.functions}/pullChanges/${iModelId}`;\r\n\r\n/** Identifies a list of tile content Ids belonging to a single tile tree.\r\n * @internal\r\n */\r\nexport interface TileTreeContentIds {\r\n  treeId: string;\r\n  contentIds: string[];\r\n}\r\n\r\n/** Specifies a [GeometricModel]($backend)'s Id and a Guid identifying the current state of the geometry contained within the model.\r\n * @see [TxnManager.onModelGeometryChanged]($backend) and [BriefcaseTxns.onModelGeometryChanged]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelIdAndGeometryGuid {\r\n  /** The model's Id. */\r\n  id: Id64String;\r\n  /** A unique identifier for the current state of the model's geometry. If the guid differs between two revisions of the same iModel, it indicates that the geometry differs.\r\n   * This is primarily an implementation detail used to determine whether [Tile]($frontend)s produced for one revision are compatible with another revision.\r\n   */\r\n  guid: GuidString;\r\n}\r\n\r\n/** @internal */\r\nexport const ipcAppChannels = {\r\n  functions: \"itwinjs-core/ipc-app\",\r\n  appNotify: \"itwinjs-core/ipcApp-notify\",\r\n  txns: \"itwinjs-core/txns\",\r\n  editingScope: \"itwinjs-core/editing-scope\",\r\n} as const;\r\n\r\n/**\r\n * Interface implemented by the frontend [NotificationHandler]($common) to be notified of events from IpcApp backend.\r\n * @internal\r\n */\r\nexport interface IpcAppNotifications {\r\n  notifyApp: () => void;\r\n}\r\n\r\n/** @internal */\r\nexport interface NotifyEntitiesChangedMetadata {\r\n  /** Class full name (\"Schema:Class\") */\r\n  name: string;\r\n  /** The indices in [[NotifyEntitiesChangedArgs.meta]] of each of this class's **direct** base classes. */\r\n  bases: number[];\r\n}\r\n\r\n/** Arguments supplied to [[TxnNotifications.notifyElementsChanged]] and [[TxnNotifications.notifyModelsChanged]].\r\n * @internal\r\n */\r\nexport interface NotifyEntitiesChangedArgs extends ChangedEntities {\r\n  /** An array of the same length as [[ChangedEntities.inserted]] (or empty if that array is undefined), containing the index in the [[meta]] array at which the\r\n   * metadata for each entity's class is located.\r\n   */\r\n  insertedMeta: number[];\r\n  /** See insertedMeta. */\r\n  updatedMeta: number[];\r\n  /** See insertedMeta. */\r\n  deletedMeta: number[];\r\n\r\n  /** Metadata describing each unique class of entity in this set of changes, followed by each unique direct or indirect base class of those classes. */\r\n  meta: NotifyEntitiesChangedMetadata[];\r\n}\r\n\r\n/** Interface implemented by the frontend [NotificationHandler]($common) to be notified of changes to an iModel.\r\n * @see [TxnManager]($backend) for the source of these events.\r\n * @see [BriefcaseTxns]($frontend) for the frontend implementation.\r\n * @internal\r\n */\r\nexport interface TxnNotifications {\r\n  notifyElementsChanged: (changes: NotifyEntitiesChangedArgs) => void;\r\n  notifyModelsChanged: (changes: NotifyEntitiesChangedArgs) => void;\r\n  notifyGeometryGuidsChanged: (changes: ModelIdAndGeometryGuid[]) => void;\r\n  notifyCommit: () => void;\r\n  notifyCommitted: (hasPendingTxns: boolean, time: number) => void;\r\n  notifyReplayExternalTxns: () => void;\r\n  notifyReplayedExternalTxns: () => void;\r\n  notifyChangesApplied: () => void;\r\n  notifyBeforeUndoRedo: (isUndo: boolean) => void;\r\n  notifyAfterUndoRedo: (isUndo: boolean) => void;\r\n  notifyPulledChanges: (parentChangeSetId: ChangesetIndexAndId) => void;\r\n  notifyPushedChanges: (parentChangeSetId: ChangesetIndexAndId) => void;\r\n\r\n  notifyIModelNameChanged: (name: string) => void;\r\n  notifyRootSubjectChanged: (subject: RootSubjectProps) => void;\r\n  notifyProjectExtentsChanged: (extents: Range3dProps) => void;\r\n  notifyGlobalOriginChanged: (origin: XYZProps) => void;\r\n  notifyEcefLocationChanged: (ecef: EcefLocationProps | undefined) => void;\r\n  notifyGeographicCoordinateSystemChanged: (gcs: GeographicCRSProps | undefined) => void;\r\n}\r\n\r\n/**\r\n * Interface registered by the frontend [NotificationHandler]($common) to be notified of changes to an iModel during an [GraphicalEditingScope]($frontend).\r\n * @internal\r\n */\r\nexport interface EditingScopeNotifications {\r\n  notifyGeometryChanged: (modelProps: ModelGeometryChangesProps[]) => void;\r\n}\r\n\r\n/**\r\n * The methods that may be invoked via Ipc from the frontend of an IpcApp and are implemented on its backend.\r\n * @internal\r\n */\r\nexport interface IpcAppFunctions {\r\n  /** Send frontend log to backend.\r\n   * @param _level Specify log level.\r\n   * @param _category Specify log category.\r\n   * @param _message Specify log message.\r\n   * @param _metaData metaData if any.\r\n   */\r\n  log: (_timestamp: number, _level: LogLevel, _category: string, _message: string, _metaData?: any) => Promise<void>;\r\n\r\n  /** see BriefcaseConnection.openFile */\r\n  openBriefcase: (args: OpenBriefcaseProps) => Promise<IModelConnectionProps>;\r\n  /** see BriefcaseConnection.openStandalone */\r\n  openCheckpoint: (args: OpenCheckpointArgs) => Promise<IModelConnectionProps>;\r\n  /** see BriefcaseConnection.openStandalone */\r\n  openStandalone: (filePath: string, openMode: OpenMode, opts?: StandaloneOpenOptions) => Promise<IModelConnectionProps>;\r\n  /** see SnapshotConnection.openFile */\r\n  openSnapshot: (filePath: string, opts?: SnapshotOpenOptions) => Promise<IModelConnectionProps>;\r\n  /** see BriefcaseConnection.close */\r\n  closeIModel: (key: string) => Promise<void>;\r\n  /** see BriefcaseConnection.saveChanges */\r\n  saveChanges: (key: string, description?: string) => Promise<void>;\r\n  /** see BriefcaseTxns.hasPendingTxns */\r\n  hasPendingTxns: (key: string) => Promise<boolean>;\r\n  /** see BriefcaseTxns.isUndoPossible */\r\n  isUndoPossible: (key: string) => Promise<boolean>;\r\n  /** see BriefcaseTxns.isRedoPossible */\r\n  isRedoPossible: (key: string) => Promise<boolean>;\r\n  /** see BriefcaseTxns.getUndoString */\r\n  getUndoString: (key: string) => Promise<string>;\r\n  /** see BriefcaseTxns.getRedoString */\r\n  getRedoString: (key: string) => Promise<string>;\r\n\r\n  /** see BriefcaseConnection.pullChanges */\r\n  pullChanges: (key: string, toIndex?: ChangesetIndex, options?: PullChangesOptions) => Promise<ChangesetIndexAndId>;\r\n  /** Cancels pull of changes. */\r\n  cancelPullChangesRequest: (key: string) => Promise<void>;\r\n  /** see BriefcaseConnection.pushChanges */\r\n  pushChanges: (key: string, description: string) => Promise<ChangesetIndexAndId>;\r\n  /** Cancels currently pending or active generation of tile content.  */\r\n  cancelTileContentRequests: (tokenProps: IModelRpcProps, _contentIds: TileTreeContentIds[]) => Promise<void>;\r\n\r\n  /** Cancel element graphics requests.\r\n   * @see [[IModelTileRpcInterface.requestElementGraphics]].\r\n   */\r\n  cancelElementGraphicsRequests: (key: string, _requestIds: string[]) => Promise<void>;\r\n\r\n  toggleGraphicalEditingScope: (key: string, _startSession: boolean) => Promise<boolean>;\r\n  isGraphicalEditingSupported: (key: string) => Promise<boolean>;\r\n\r\n  reverseTxns: (key: string, numOperations: number) => Promise<IModelStatus>;\r\n  reverseAllTxn: (key: string) => Promise<IModelStatus>;\r\n  reinstateTxn: (key: string) => Promise<IModelStatus>;\r\n  restartTxnSession: (key: string) => Promise<void>;\r\n\r\n  /** Query the number of concurrent threads supported by the host's IO or CPU thread pool. */\r\n  queryConcurrency: (pool: \"io\" | \"cpu\") => Promise<number>;\r\n}\r\n\r\n"]}
+{"version":3,"file":"IpcAppProps.js","sourceRoot":"","sources":["../../src/IpcAppProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAuBH;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,GAAG,cAAc,CAAC,SAAS,gBAAgB,QAAQ,EAAE,CAAC;AAwBpH,gBAAgB;AAChB,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,sBAAsB;IACjC,SAAS,EAAE,4BAA4B;IACvC,IAAI,EAAE,mBAAmB;IACzB,YAAY,EAAE,4BAA4B;CAClC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module NativeApp\n */\n\nimport { GuidString, Id64String, IModelStatus, LogLevel, OpenMode } from \"@itwin/core-bentley\";\nimport { Range3dProps, XYZProps } from \"@itwin/core-geometry\";\nimport { OpenBriefcaseProps, OpenCheckpointArgs } from \"./BriefcaseTypes\";\nimport { ChangedEntities } from \"./ChangedEntities\";\nimport { ChangesetIndex, ChangesetIndexAndId } from \"./ChangesetProps\";\nimport { GeographicCRSProps } from \"./geometry/CoordinateReferenceSystem\";\nimport { EcefLocationProps, IModelConnectionProps, IModelRpcProps, RootSubjectProps, SnapshotOpenOptions, StandaloneOpenOptions } from \"./IModel\";\nimport { ModelGeometryChangesProps } from \"./ModelGeometryChanges\";\n\n/** Options for pulling changes into iModel.\n * @internal\n */\nexport interface PullChangesOptions {\n  /** Enables progress reporting. */\n  reportProgress?: boolean;\n  /** Interval for reporting progress (in milliseconds). */\n  progressInterval?: number;\n  /** Enables checks for abort. */\n  enableCancellation?: boolean;\n}\n\n/** Get IPC channel name used for reporting progress of pulling changes into iModel.\n * @internal\n */\nexport const getPullChangesIpcChannel = (iModelId: string) => `${ipcAppChannels.functions}/pullChanges/${iModelId}`;\n\n/** Identifies a list of tile content Ids belonging to a single tile tree.\n * @internal\n */\nexport interface TileTreeContentIds {\n  treeId: string;\n  contentIds: string[];\n}\n\n/** Specifies a [GeometricModel]($backend)'s Id and a Guid identifying the current state of the geometry contained within the model.\n * @see [TxnManager.onModelGeometryChanged]($backend) and [BriefcaseTxns.onModelGeometryChanged]($frontend).\n * @public\n * @extensions\n */\nexport interface ModelIdAndGeometryGuid {\n  /** The model's Id. */\n  id: Id64String;\n  /** A unique identifier for the current state of the model's geometry. If the guid differs between two revisions of the same iModel, it indicates that the geometry differs.\n   * This is primarily an implementation detail used to determine whether [Tile]($frontend)s produced for one revision are compatible with another revision.\n   */\n  guid: GuidString;\n}\n\n/** @internal */\nexport const ipcAppChannels = {\n  functions: \"itwinjs-core/ipc-app\",\n  appNotify: \"itwinjs-core/ipcApp-notify\",\n  txns: \"itwinjs-core/txns\",\n  editingScope: \"itwinjs-core/editing-scope\",\n} as const;\n\n/**\n * Interface implemented by the frontend [NotificationHandler]($common) to be notified of events from IpcApp backend.\n * @internal\n */\nexport interface IpcAppNotifications {\n  notifyApp: () => void;\n}\n\n/** @internal */\nexport interface NotifyEntitiesChangedMetadata {\n  /** Class full name (\"Schema:Class\") */\n  name: string;\n  /** The indices in [[NotifyEntitiesChangedArgs.meta]] of each of this class's **direct** base classes. */\n  bases: number[];\n}\n\n/** Arguments supplied to [[TxnNotifications.notifyElementsChanged]] and [[TxnNotifications.notifyModelsChanged]].\n * @internal\n */\nexport interface NotifyEntitiesChangedArgs extends ChangedEntities {\n  /** An array of the same length as [[ChangedEntities.inserted]] (or empty if that array is undefined), containing the index in the [[meta]] array at which the\n   * metadata for each entity's class is located.\n   */\n  insertedMeta: number[];\n  /** See insertedMeta. */\n  updatedMeta: number[];\n  /** See insertedMeta. */\n  deletedMeta: number[];\n\n  /** Metadata describing each unique class of entity in this set of changes, followed by each unique direct or indirect base class of those classes. */\n  meta: NotifyEntitiesChangedMetadata[];\n}\n\n/** Interface implemented by the frontend [NotificationHandler]($common) to be notified of changes to an iModel.\n * @see [TxnManager]($backend) for the source of these events.\n * @see [BriefcaseTxns]($frontend) for the frontend implementation.\n * @internal\n */\nexport interface TxnNotifications {\n  notifyElementsChanged: (changes: NotifyEntitiesChangedArgs) => void;\n  notifyModelsChanged: (changes: NotifyEntitiesChangedArgs) => void;\n  notifyGeometryGuidsChanged: (changes: ModelIdAndGeometryGuid[]) => void;\n  notifyCommit: () => void;\n  notifyCommitted: (hasPendingTxns: boolean, time: number) => void;\n  notifyReplayExternalTxns: () => void;\n  notifyReplayedExternalTxns: () => void;\n  notifyChangesApplied: () => void;\n  notifyBeforeUndoRedo: (isUndo: boolean) => void;\n  notifyAfterUndoRedo: (isUndo: boolean) => void;\n  notifyPulledChanges: (parentChangeSetId: ChangesetIndexAndId) => void;\n  notifyPushedChanges: (parentChangeSetId: ChangesetIndexAndId) => void;\n\n  notifyIModelNameChanged: (name: string) => void;\n  notifyRootSubjectChanged: (subject: RootSubjectProps) => void;\n  notifyProjectExtentsChanged: (extents: Range3dProps) => void;\n  notifyGlobalOriginChanged: (origin: XYZProps) => void;\n  notifyEcefLocationChanged: (ecef: EcefLocationProps | undefined) => void;\n  notifyGeographicCoordinateSystemChanged: (gcs: GeographicCRSProps | undefined) => void;\n}\n\n/**\n * Interface registered by the frontend [NotificationHandler]($common) to be notified of changes to an iModel during an [GraphicalEditingScope]($frontend).\n * @internal\n */\nexport interface EditingScopeNotifications {\n  notifyGeometryChanged: (modelProps: ModelGeometryChangesProps[]) => void;\n}\n\n/**\n * The methods that may be invoked via Ipc from the frontend of an IpcApp and are implemented on its backend.\n * @internal\n */\nexport interface IpcAppFunctions {\n  /** Send frontend log to backend.\n   * @param _level Specify log level.\n   * @param _category Specify log category.\n   * @param _message Specify log message.\n   * @param _metaData metaData if any.\n   */\n  log: (_timestamp: number, _level: LogLevel, _category: string, _message: string, _metaData?: any) => Promise<void>;\n\n  /** see BriefcaseConnection.openFile */\n  openBriefcase: (args: OpenBriefcaseProps) => Promise<IModelConnectionProps>;\n  /** see BriefcaseConnection.openStandalone */\n  openCheckpoint: (args: OpenCheckpointArgs) => Promise<IModelConnectionProps>;\n  /** see BriefcaseConnection.openStandalone */\n  openStandalone: (filePath: string, openMode: OpenMode, opts?: StandaloneOpenOptions) => Promise<IModelConnectionProps>;\n  /** see SnapshotConnection.openFile */\n  openSnapshot: (filePath: string, opts?: SnapshotOpenOptions) => Promise<IModelConnectionProps>;\n  /** see BriefcaseConnection.close */\n  closeIModel: (key: string) => Promise<void>;\n  /** see BriefcaseConnection.saveChanges */\n  saveChanges: (key: string, description?: string) => Promise<void>;\n  /** see BriefcaseConnection.abandonChanges */\n  abandonChanges: (key: string) => Promise<void>;\n  /** see BriefcaseTxns.hasPendingTxns */\n  hasPendingTxns: (key: string) => Promise<boolean>;\n  /** see BriefcaseTxns.isUndoPossible */\n  isUndoPossible: (key: string) => Promise<boolean>;\n  /** see BriefcaseTxns.isRedoPossible */\n  isRedoPossible: (key: string) => Promise<boolean>;\n  /** see BriefcaseTxns.getUndoString */\n  getUndoString: (key: string) => Promise<string>;\n  /** see BriefcaseTxns.getRedoString */\n  getRedoString: (key: string) => Promise<string>;\n\n  /** see BriefcaseConnection.pullChanges */\n  pullChanges: (key: string, toIndex?: ChangesetIndex, options?: PullChangesOptions) => Promise<ChangesetIndexAndId>;\n  /** Cancels pull of changes. */\n  cancelPullChangesRequest: (key: string) => Promise<void>;\n  /** see BriefcaseConnection.pushChanges */\n  pushChanges: (key: string, description: string) => Promise<ChangesetIndexAndId>;\n  /** Cancels currently pending or active generation of tile content.  */\n  cancelTileContentRequests: (tokenProps: IModelRpcProps, _contentIds: TileTreeContentIds[]) => Promise<void>;\n\n  /** Cancel element graphics requests.\n   * @see [[IModelTileRpcInterface.requestElementGraphics]].\n   */\n  cancelElementGraphicsRequests: (key: string, _requestIds: string[]) => Promise<void>;\n\n  toggleGraphicalEditingScope: (key: string, _startSession: boolean) => Promise<boolean>;\n  isGraphicalEditingSupported: (key: string) => Promise<boolean>;\n\n  reverseTxns: (key: string, numOperations: number) => Promise<IModelStatus>;\n  reverseAllTxn: (key: string) => Promise<IModelStatus>;\n  reinstateTxn: (key: string) => Promise<IModelStatus>;\n  restartTxnSession: (key: string) => Promise<void>;\n\n  /** Query the number of concurrent threads supported by the host's IO or CPU thread pool. */\n  queryConcurrency: (pool: \"io\" | \"cpu\") => Promise<number>;\n}\n\n"]}

package/lib/esm/LightSettings.js

@@ -18,6 +18,19 @@ const defaultSolarDirection = Vector3d.create(0.272166, 0.680414, 0.680414);
  * @public
  */
 export class SolarLight {
+    /** Direction of the light in world coordinates. Defaults to a vector looking down on the scene at a 45 degree angle mostly along the Y axis. */
+    direction;
+    /** Intensity of the light, typically in [0..1] but can range up to 5. Default: 1.0 */
+    intensity;
+    /** If true, the light will be applied even when shadows are turned off for the view.
+     * If false, a roughly overhead light of the same intensity oriented in view space will be used instead.
+     * Default: false.
+     */
+    alwaysEnabled;
+    /** If defined, the time in UNIX milliseconds from which [[direction]] was calculated.
+     * @see [[DisplayStyleSettings.setSunTime]] to compute the solar direction from a point in time.
+     */
+    timePoint;
     constructor(json) {
         json = json || {};
         this.intensity = extractIntensity(json.intensity, 1);
@@ -81,6 +94,8 @@ export class SolarLight {
  * @public
  */
 export class AmbientLight {
+    color;
+    intensity;
     constructor(json) {
         json = json || {};
         this.intensity = extractIntensity(json.intensity, 0.2);
@@ -120,6 +135,9 @@ const defaultLowerHemisphereColor = new RgbColor(120, 143, 125);
  * @public
  */
 export class HemisphereLights {
+    upperColor;
+    lowerColor;
+    intensity;
     constructor(json) {
         json = json || {};
         this.intensity = extractIntensity(json.intensity, 0);
@@ -172,11 +190,23 @@ function clampIntensity(intensity = 0) {
  * @public
  */
 export class FresnelSettings {
+    /** The strength of the effect in terms of how much brighter the surface becomes. The intensity at a given point on the surface is determined by
+     * the angle between the viewer's line of sight and the vector from the viewer to that point. Maximum intensity is produced when those vectors are
+     * perpendicular, and zero intensity is produced when those vectors are parallel (unless [[invert]] is `true`).
+     *
+     * A value of zero turns off the effect. Values less than zero are clamped to zero. Typical values range between 0 and 1.
+     */
+    intensity;
+    /** If true, inverts the effect's [[intensity]] such that maximum intensity is produced when the viewer's line of sight is parallel to the vector between
+     * the viewer and the point on the surface, and zero intensity is produced when the viewer's line of sight is perpendicular to that vector.
+     */
+    invert;
     constructor(intensity, invert) {
         assert(intensity >= 0);
         this.intensity = intensity;
         this.invert = invert;
     }
+    static _defaults = new FresnelSettings(0, false);
     /** Create from JSON representation, using default values for any unspecified or `undefined` properties. */
     static fromJSON(props) {
         const intensity = clampIntensity(JsonUtils.asDouble(props?.intensity));
@@ -218,12 +248,20 @@ export class FresnelSettings {
         return this === rhs || (this.intensity === rhs.intensity && this.invert === rhs.invert);
     }
 }
-FresnelSettings._defaults = new FresnelSettings(0, false);
 /** Describes the lighting for a 3d scene, associated with a [[DisplayStyle3dSettings]] in turn associated with a [DisplayStyle3d]($backend) or [DisplayStyle3dState]($frontend).
  * @see [[LightSettingsProps]]
  * @public
  */
 export class LightSettings {
+    solar;
+    ambient;
+    hemisphere;
+    /** See [[LightSettingsProps.portrait]]. */
+    portraitIntensity;
+    specularIntensity;
+    /** See [[LightSettingsProps.numCels]]. */
+    numCels;
+    fresnel;
     constructor(solar, ambient, hemisphere, portraitIntensity, specularIntensity, numCels, fresnel) {
         this.solar = solar;
         this.ambient = ambient;