@itwin/core-bentley 5.0.0-dev.1 → 5.0.0-dev.100

package/CHANGELOG.md

@@ -1,6 +1,79 @@
 # Change Log - @itwin/core-bentley
 
-This log was last generated on Tue, 05 Nov 2024 15:24:11 GMT and should not be manually modified.
+This log was last generated on Wed, 02 Apr 2025 19:38:36 GMT and should not be manually modified.
+
+## 4.10.12
+Wed, 02 Apr 2025 19:35:47 GMT
+
+_Version update only_
+
+## 4.10.11
+Wed, 19 Mar 2025 15:30:39 GMT
+
+_Version update only_
+
+## 4.10.10
+Tue, 11 Mar 2025 15:25:11 GMT
+
+_Version update only_
+
+## 4.10.9
+Tue, 11 Mar 2025 05:17:33 GMT
+
+_Version update only_
+
+## 4.10.8
+Thu, 06 Mar 2025 14:13:37 GMT
+
+_Version update only_
+
+## 4.10.7
+Tue, 18 Feb 2025 17:27:03 GMT
+
+_Version update only_
+
+## 4.10.6
+Fri, 24 Jan 2025 08:02:40 GMT
+
+_Version update only_
+
+## 4.10.5
+Tue, 21 Jan 2025 21:56:45 GMT
+
+_Version update only_
+
+## 4.10.4
+Mon, 13 Jan 2025 14:06:43 GMT
+
+_Version update only_
+
+## 4.10.3
+Mon, 06 Jan 2025 14:00:13 GMT
+
+_Version update only_
+
+## 4.10.2
+Thu, 21 Nov 2024 15:22:20 GMT
+
+_Version update only_
+
+## 4.10.1
+Thu, 14 Nov 2024 18:11:00 GMT
+
+_Version update only_
+
+## 4.10.0
+Wed, 13 Nov 2024 15:23:38 GMT
+
+### Updates
+
+- Add MaybePromise utility type.
+- Add Id64.Uint32Set.equals().
+
+## 4.9.7
+Wed, 06 Nov 2024 19:23:04 GMT
+
+_Version update only_
 
 ## 4.9.6
 Tue, 05 Nov 2024 15:22:45 GMT

package/lib/cjs/BeEvent.js

@@ -16,10 +16,8 @@ const UnexpectedErrors_1 = require("./UnexpectedErrors");
  * @public
  */
 class BeEvent {
-    constructor() {
-        this._listeners = [];
-        this._insideRaiseEvent = false;
-    }
+    _listeners = [];
+    _insideRaiseEvent = false;
     /** The number of listeners currently subscribed to the event. */
     get numberOfListeners() { return this._listeners.length; }
     /**
@@ -130,9 +128,7 @@ exports.BeUiEvent = BeUiEvent;
  * @public
  */
 class BeEventList {
-    constructor() {
-        this._events = {};
-    }
+    _events = {};
     /**
      * Gets the event associated with the specified name, creating the event if it does not already exist.
      * @param name The name of the event.

package/lib/cjs/BeEvent.js.map

@@ -1 +1 @@
-{"version":3,"file":"BeEvent.js","sourceRoot":"","sources":["../../src/BeEvent.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yDAAsD;AAatD;;;;;GAKG;AACH,MAAa,OAAO;IAApB;QACU,eAAU,GAAmB,EAAE,CAAC;QAChC,sBAAiB,GAAY,KAAK,CAAC;IAwG7C,CAAC;IAtGC,iEAAiE;IACjE,IAAW,iBAAiB,KAAK,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IAEjE;;;;;;OAMG;IACI,WAAW,CAAC,QAAW,EAAE,KAAW;QACzC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QACvD,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CAAC,QAAW,EAAE,KAAW;QACrC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAC,QAAW,EAAE,KAAW;QAC5C,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;QAElC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YAC1C,MAAM,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,KAAK,KAAK,EAAE,CAAC;gBAC7D,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;oBAC3B,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;gBAC/B,CAAC;qBAAM,CAAC;oBACN,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBACzB,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,GAAG,IAAmB;QACtC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAE9B,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;QAChC,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YAChC,MAAM,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACtB,OAAO,GAAG,IAAI,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC;oBACH,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC9C,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,mCAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAC7B,CAAC;gBACD,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;oBACjB,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;oBAC7B,OAAO,GAAG,IAAI,CAAC;gBACjB,CAAC;YACH,CAAC;QACH,CAAC;QAED,+CAA+C;QAC/C,IAAI,OAAO;YACT,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC;QAEhF,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;IACjC,CAAC;IAED;;;OAGG;IACI,GAAG,CAAC,QAAW,EAAE,KAAW;QACjC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YAClC,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,IAAI,GAAG,CAAC,KAAK,KAAK,KAAK,EAAE,CAAC;gBACrD,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,6CAA6C;IACtC,KAAK,KAAW,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;CACrD;AA1GD,0BA0GC;AAED;;GAEG;AACH,MAAa,SAAsB,SAAQ,OAAmC;IAC5E,wDAAwD;IACjD,IAAI,CAAC,IAAgB,IAAU,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CAC/D;AAHD,8BAGC;AAED;;;;GAIG;AACH,MAAa,WAAW;IAAxB;QACU,YAAO,GAA+C,EAAE,CAAC;IAuBnE,CAAC;IArBC;;;OAGG;IACI,GAAG,CAAC,IAAY;QACrB,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,KAAK;YACP,OAAO,KAAK,CAAC;QAEf,KAAK,GAAG,IAAI,OAAO,EAAE,CAAC;QACtB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,IAAY;QACxB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IACjC,CAAC;CACF;AAxBD,kCAwBC","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 Events\n */\n\nimport { UnexpectedErrors } from \"./UnexpectedErrors\";\n\n/** A function invoked when a BeEvent is raised.\n * @public\n */\nexport type Listener = (...arg: any[]) => void;\n\ninterface EventContext {\n  listener: Listener | undefined;\n  scope: any;\n  once: boolean;\n}\n\n/**\n * Manages a set of *listeners* for a particular event and notifies them when the event is raised.\n * This class is usually instantiated inside of a container class and\n * exposed as a property for others to *subscribe* via [[BeEvent.addListener]].\n * @public\n */\nexport class BeEvent<T extends Listener> {\n  private _listeners: EventContext[] = [];\n  private _insideRaiseEvent: boolean = false;\n\n  /** The number of listeners currently subscribed to the event. */\n  public get numberOfListeners() { return this._listeners.length; }\n\n  /**\n   * Registers a Listener to be executed whenever this event is raised.\n   * @param listener The function to be executed when the event is raised.\n   * @param scope An optional object scope to serve as the 'this' pointer when listener is invoked.\n   * @returns A function that will remove this event listener.\n   * @see [[BeEvent.raiseEvent]], [[BeEvent.removeListener]]\n   */\n  public addListener(listener: T, scope?: any): () => void {\n    this._listeners.push({ listener, scope, once: false });\n    return () => this.removeListener(listener, scope);\n  }\n\n  /**\n   * Registers a callback function to be executed *only once* when the event is raised.\n   * @param listener The function to be executed once when the event is raised.\n   * @param scope An optional object scope to serve as the `this` pointer in which the listener function will execute.\n   * @returns A function that will remove this event listener.\n   * @see [[BeEvent.raiseEvent]], [[BeEvent.removeListener]]\n   */\n  public addOnce(listener: T, scope?: any): () => void {\n    this._listeners.push({ listener, scope, once: true });\n    return () => this.removeListener(listener, scope);\n  }\n\n  /**\n   * Un-register a previously registered listener.\n   * @param listener The listener to be unregistered.\n   * @param  scope The scope that was originally passed to addListener.\n   * @returns 'true' if the listener was removed; 'false' if the listener and scope are not registered with the event.\n   * @see [[BeEvent.raiseEvent]], [[BeEvent.addListener]]\n   */\n  public removeListener(listener: T, scope?: any): boolean {\n    const listeners = this._listeners;\n\n    for (let i = 0; i < listeners.length; ++i) {\n      const context = listeners[i];\n      if (context.listener === listener && context.scope === scope) {\n        if (this._insideRaiseEvent) {\n          context.listener = undefined;\n        } else {\n          listeners.splice(i, 1);\n        }\n        return true;\n      }\n    }\n    return false;\n  }\n\n  /**\n   * Raises the event by calling each registered listener with the supplied arguments.\n   * @param args This method takes any number of parameters and passes them through to the listeners.\n   * @see [[BeEvent.removeListener]], [[BeEvent.addListener]]\n   */\n  public raiseEvent(...args: Parameters<T>) {\n    this._insideRaiseEvent = true;\n\n    const listeners = this._listeners;\n    const length = listeners.length;\n    let dropped = false;\n\n    for (let i = 0; i < length; ++i) {\n      const context = listeners[i];\n      if (!context.listener) {\n        dropped = true;\n      } else {\n        try {\n          context.listener.apply(context.scope, args);\n        } catch (e) {\n          UnexpectedErrors.handle(e);\n        }\n        if (context.once) {\n          context.listener = undefined;\n          dropped = true;\n        }\n      }\n    }\n\n    // if we had dropped listeners, remove them now\n    if (dropped)\n      this._listeners = this._listeners.filter((ctx) => ctx.listener !== undefined);\n\n    this._insideRaiseEvent = false;\n  }\n\n  /** Determine whether this BeEvent has a specified listener registered.\n   * @param listener The listener to check.\n   * @param scope optional scope argument to match call to addListener\n   */\n  public has(listener: T, scope?: any): boolean {\n    for (const ctx of this._listeners) {\n      if (ctx.listener === listener && ctx.scope === scope) {\n        return true;\n      }\n    }\n    return false;\n  }\n\n  /** Clear all Listeners from this BeEvent. */\n  public clear(): void { this._listeners.length = 0; }\n}\n\n/** Specialization of BeEvent for events that take a single strongly typed argument, primarily used for UI events.\n * @public\n */\nexport class BeUiEvent<TEventArgs> extends BeEvent<(args: TEventArgs) => void> {\n  /** Raises event with single strongly typed argument. */\n  public emit(args: TEventArgs): void { this.raiseEvent(args); }\n}\n\n/**\n * A list of BeEvent objects, accessible by an event name.\n * This class may be used instead of explicitly declaring each BeEvent as a member of a containing class.\n * @public\n */\nexport class BeEventList<T extends Listener> {\n  private _events: { [name: string]: BeEvent<T> | undefined } = {};\n\n  /**\n   * Gets the event associated with the specified name, creating the event if it does not already exist.\n   * @param name The name of the event.\n   */\n  public get(name: string): BeEvent<T> {\n    let event = this._events[name];\n    if (event)\n      return event;\n\n    event = new BeEvent();\n    this._events[name] = event;\n    return event;\n  }\n\n  /**\n   * Removes the event associated with a name.\n   * @param name The name of the event.\n   */\n  public remove(name: string): void {\n    this._events[name] = undefined;\n  }\n}\n\n/**\n * Retrieves the type of the callback function for an event type like [[BeEvent]].\n * For example:\n * ```ts\n * const event = new BeEvent<(x: number, y: string) => void>();\n * const callback: ListenerType<typeof event> = (x, y) => {\n *   console.log(`${x}, ${y}`);\n * };\n * ```\n *\n * @public\n */\nexport type ListenerType<TEvent extends {\n  addListener(listener: Listener): () => void;\n}> =\n  TEvent extends {\n    addListener(listener: infer TListener): () => void;\n  } ? TListener : never;\n"]}
+{"version":3,"file":"BeEvent.js","sourceRoot":"","sources":["../../src/BeEvent.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yDAAsD;AAatD;;;;;GAKG;AACH,MAAa,OAAO;IACV,UAAU,GAAmB,EAAE,CAAC;IAChC,iBAAiB,GAAY,KAAK,CAAC;IAE3C,iEAAiE;IACjE,IAAW,iBAAiB,KAAK,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IAEjE;;;;;;OAMG;IACI,WAAW,CAAC,QAAW,EAAE,KAAW;QACzC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QACvD,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CAAC,QAAW,EAAE,KAAW;QACrC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAC,QAAW,EAAE,KAAW;QAC5C,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;QAElC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YAC1C,MAAM,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,KAAK,KAAK,EAAE,CAAC;gBAC7D,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;oBAC3B,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;gBAC/B,CAAC;qBAAM,CAAC;oBACN,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBACzB,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,GAAG,IAAmB;QACtC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAE9B,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;QAChC,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YAChC,MAAM,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACtB,OAAO,GAAG,IAAI,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC;oBACH,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC9C,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,mCAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAC7B,CAAC;gBACD,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;oBACjB,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;oBAC7B,OAAO,GAAG,IAAI,CAAC;gBACjB,CAAC;YACH,CAAC;QACH,CAAC;QAED,+CAA+C;QAC/C,IAAI,OAAO;YACT,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC;QAEhF,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;IACjC,CAAC;IAED;;;OAGG;IACI,GAAG,CAAC,QAAW,EAAE,KAAW;QACjC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YAClC,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,IAAI,GAAG,CAAC,KAAK,KAAK,KAAK,EAAE,CAAC;gBACrD,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,6CAA6C;IACtC,KAAK,KAAW,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;CACrD;AA1GD,0BA0GC;AAED;;GAEG;AACH,MAAa,SAAsB,SAAQ,OAAmC;IAC5E,wDAAwD;IACjD,IAAI,CAAC,IAAgB,IAAU,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CAC/D;AAHD,8BAGC;AAED;;;;GAIG;AACH,MAAa,WAAW;IACd,OAAO,GAA+C,EAAE,CAAC;IAEjE;;;OAGG;IACI,GAAG,CAAC,IAAY;QACrB,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,KAAK;YACP,OAAO,KAAK,CAAC;QAEf,KAAK,GAAG,IAAI,OAAO,EAAE,CAAC;QACtB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,IAAY;QACxB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IACjC,CAAC;CACF;AAxBD,kCAwBC","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 Events\n */\n\nimport { UnexpectedErrors } from \"./UnexpectedErrors\";\n\n/** A function invoked when a BeEvent is raised.\n * @public\n */\nexport type Listener = (...arg: any[]) => void;\n\ninterface EventContext {\n  listener: Listener | undefined;\n  scope: any;\n  once: boolean;\n}\n\n/**\n * Manages a set of *listeners* for a particular event and notifies them when the event is raised.\n * This class is usually instantiated inside of a container class and\n * exposed as a property for others to *subscribe* via [[BeEvent.addListener]].\n * @public\n */\nexport class BeEvent<T extends Listener> {\n  private _listeners: EventContext[] = [];\n  private _insideRaiseEvent: boolean = false;\n\n  /** The number of listeners currently subscribed to the event. */\n  public get numberOfListeners() { return this._listeners.length; }\n\n  /**\n   * Registers a Listener to be executed whenever this event is raised.\n   * @param listener The function to be executed when the event is raised.\n   * @param scope An optional object scope to serve as the 'this' pointer when listener is invoked.\n   * @returns A function that will remove this event listener.\n   * @see [[BeEvent.raiseEvent]], [[BeEvent.removeListener]]\n   */\n  public addListener(listener: T, scope?: any): () => void {\n    this._listeners.push({ listener, scope, once: false });\n    return () => this.removeListener(listener, scope);\n  }\n\n  /**\n   * Registers a callback function to be executed *only once* when the event is raised.\n   * @param listener The function to be executed once when the event is raised.\n   * @param scope An optional object scope to serve as the `this` pointer in which the listener function will execute.\n   * @returns A function that will remove this event listener.\n   * @see [[BeEvent.raiseEvent]], [[BeEvent.removeListener]]\n   */\n  public addOnce(listener: T, scope?: any): () => void {\n    this._listeners.push({ listener, scope, once: true });\n    return () => this.removeListener(listener, scope);\n  }\n\n  /**\n   * Un-register a previously registered listener.\n   * @param listener The listener to be unregistered.\n   * @param  scope The scope that was originally passed to addListener.\n   * @returns 'true' if the listener was removed; 'false' if the listener and scope are not registered with the event.\n   * @see [[BeEvent.raiseEvent]], [[BeEvent.addListener]]\n   */\n  public removeListener(listener: T, scope?: any): boolean {\n    const listeners = this._listeners;\n\n    for (let i = 0; i < listeners.length; ++i) {\n      const context = listeners[i];\n      if (context.listener === listener && context.scope === scope) {\n        if (this._insideRaiseEvent) {\n          context.listener = undefined;\n        } else {\n          listeners.splice(i, 1);\n        }\n        return true;\n      }\n    }\n    return false;\n  }\n\n  /**\n   * Raises the event by calling each registered listener with the supplied arguments.\n   * @param args This method takes any number of parameters and passes them through to the listeners.\n   * @see [[BeEvent.removeListener]], [[BeEvent.addListener]]\n   */\n  public raiseEvent(...args: Parameters<T>) {\n    this._insideRaiseEvent = true;\n\n    const listeners = this._listeners;\n    const length = listeners.length;\n    let dropped = false;\n\n    for (let i = 0; i < length; ++i) {\n      const context = listeners[i];\n      if (!context.listener) {\n        dropped = true;\n      } else {\n        try {\n          context.listener.apply(context.scope, args);\n        } catch (e) {\n          UnexpectedErrors.handle(e);\n        }\n        if (context.once) {\n          context.listener = undefined;\n          dropped = true;\n        }\n      }\n    }\n\n    // if we had dropped listeners, remove them now\n    if (dropped)\n      this._listeners = this._listeners.filter((ctx) => ctx.listener !== undefined);\n\n    this._insideRaiseEvent = false;\n  }\n\n  /** Determine whether this BeEvent has a specified listener registered.\n   * @param listener The listener to check.\n   * @param scope optional scope argument to match call to addListener\n   */\n  public has(listener: T, scope?: any): boolean {\n    for (const ctx of this._listeners) {\n      if (ctx.listener === listener && ctx.scope === scope) {\n        return true;\n      }\n    }\n    return false;\n  }\n\n  /** Clear all Listeners from this BeEvent. */\n  public clear(): void { this._listeners.length = 0; }\n}\n\n/** Specialization of BeEvent for events that take a single strongly typed argument, primarily used for UI events.\n * @public\n */\nexport class BeUiEvent<TEventArgs> extends BeEvent<(args: TEventArgs) => void> {\n  /** Raises event with single strongly typed argument. */\n  public emit(args: TEventArgs): void { this.raiseEvent(args); }\n}\n\n/**\n * A list of BeEvent objects, accessible by an event name.\n * This class may be used instead of explicitly declaring each BeEvent as a member of a containing class.\n * @public\n */\nexport class BeEventList<T extends Listener> {\n  private _events: { [name: string]: BeEvent<T> | undefined } = {};\n\n  /**\n   * Gets the event associated with the specified name, creating the event if it does not already exist.\n   * @param name The name of the event.\n   */\n  public get(name: string): BeEvent<T> {\n    let event = this._events[name];\n    if (event)\n      return event;\n\n    event = new BeEvent();\n    this._events[name] = event;\n    return event;\n  }\n\n  /**\n   * Removes the event associated with a name.\n   * @param name The name of the event.\n   */\n  public remove(name: string): void {\n    this._events[name] = undefined;\n  }\n}\n\n/**\n * Retrieves the type of the callback function for an event type like [[BeEvent]].\n * For example:\n * ```ts\n * const event = new BeEvent<(x: number, y: string) => void>();\n * const callback: ListenerType<typeof event> = (x, y) => {\n *   console.log(`${x}, ${y}`);\n * };\n * ```\n *\n * @public\n */\nexport type ListenerType<TEvent extends {\n  addListener(listener: Listener): () => void;\n}> =\n  TEvent extends {\n    addListener(listener: infer TListener): () => void;\n  } ? TListener : never;\n"]}

package/lib/cjs/BentleyError.d.ts

@@ -1,6 +1,51 @@
 /** @packageDocumentation
  * @module Errors
  */
+import { Optional } from "./UtilityTypes";
+/** Uniquely identifies a specific kind of [[ITwinError]].
+ * @beta
+ */
+export interface ITwinErrorId {
+    /** A "namespace" serving as a qualifier for the [[key]]. It should be specific enough to ensure uniqueness across all applications.
+     * For example, all errors originating from a given package should use that package's full name as their scope.
+     */
+    readonly scope: string;
+    /** Uniquely identifies a specific kind of [[ITwinError]] within the [[scope]]. */
+    readonly key: string;
+}
+/** The interface that all exceptions thrown by iTwin.js libraries and applications should implement.
+ * Specific kinds of `ITwinError`s are identified by an [[ITwinErrorId]] that allows programmers to identify errors when they are caught without relying
+ * on specific class hierarchies, which is especially important when errors are marshalled across process boundaries.
+ * You can extend `ITwinError` to add properties that provide programmers with additional context for a particular kind of error.
+ * When catching errors, programmers can use [[isError]] to determine if the error is of a specific sub-type, and if so access the
+ * additional properties.
+ * Those additional properties will also be logged as metadata by [[Logger.logException]].
+ * @beta
+ */
+export interface ITwinError extends Error {
+    /** Uniquely identifies the kind of error. */
+    readonly iTwinErrorId: ITwinErrorId;
+}
+/** @beta */
+export declare namespace ITwinError {
+    /** Instantiate a new `ITwinError` or subtype thereof.
+     * @see [[ITwinError.throwError]] to conveniently instantiate and throw the error.
+     */
+    function create<T extends ITwinError>(args: Optional<T, "name">): T;
+    /** Instantiate and immediately throw an `ITwinError`.
+     * @see [[ITwinError.create]] to instantiate an error without throwing it.
+     */
+    function throwError<T extends ITwinError>(args: Optional<T, "name">): never;
+    /**
+     * Determine whether an error object was thrown by iTwin.js and has a specific scope and key.
+     *
+     * If the test succeeds, the type of `error` is coerced to `T`
+     * @param error The error to ve verified.
+     * @param scope value for `error.iTwinErrorId.scope`
+     * @param key value for `error.iTwinErrorId.key`
+    */
+    function isError<T extends ITwinError>(error: unknown, scope: string, key?: string): error is T;
+}
 /** Standard status code.
  * This status code should be rarely used.
  * Prefer to throw an exception to indicate an error, rather than returning a special status code.
@@ -265,6 +310,9 @@ export declare enum GeoServiceStatus {
     NoDatumConverter = 147459,
     VerticalDatumConvertError = 147460,
     CSMapError = 147461,
+    /**
+     * @deprecated in 5.0. This status is never returned.
+     */
     Pending = 147462
 }
 /** Error status from various reality data operations
@@ -290,11 +338,29 @@ interface ErrorProps {
     stack?: string;
     metadata?: object;
 }
-/** Base exception class for iTwin.js exceptions.
+/**
+ * An [[ITwinError]] that also supplies an `errorNumber`.
+ * @note this interface exists *only* for legacy errors derived from `BentleyError`. The concept of "error number" is
+ * problematic since it is impossible to enforce across the iTwin.js library, let alone across applications. New code should
+ * use `ITwinError` and identify errors with strings instead.
+ * @beta */
+export interface LegacyITwinErrorWithNumber extends ITwinError {
+    /** a number to identify the error. */
+    readonly errorNumber: number;
+    /** Logging metadata
+     * @note exceptions should *not* include logging data. Logging should be done where exceptions are caught. This member exists
+     * only for backwards compatibility.
+     */
+    loggingMetadata?: object;
+}
+/**
+ * Base exception class for legacy iTwin.js errors.
+ * For backwards compatibility only. Do not create new subclasses of BentleyError. Instead use [[ITwinError]].
  * @public
  */
 export declare class BentleyError extends Error {
     errorNumber: number;
+    static readonly iTwinErrorScope = "bentley-error";
     private readonly _metaData;
     /**
      * @param errorNumber The a number that identifies of the problem.
@@ -302,6 +368,21 @@ export declare class BentleyError extends Error {
      * @param metaData metaData about the exception.
      */
     constructor(errorNumber: number, message?: string, metaData?: LoggingMetaData);
+    /** supply the value for iTwinErrorId  */
+    get iTwinErrorId(): {
+        scope: string;
+        key: string;
+    };
+    /** value for logging metadata */
+    get loggingMetadata(): object | undefined;
+    /**
+     * Determine if an error object implements the `LegacyITwinErrorWithNumber` interface.
+     *
+     * If the test succeeds, the type of `error` is coerced to `T`
+     * @note this method does *not* test that the object is an `instanceOf BentleyError`.
+     * @beta
+     */
+    static isError<T extends LegacyITwinErrorWithNumber>(error: unknown, errorNumber?: number): error is T;
     /** Returns true if this BentleyError includes (optional) metadata. */
     get hasMetaData(): boolean;
     /** get the meta data associated with this BentleyError, if any. */
@@ -310,6 +391,8 @@ export declare class BentleyError extends Error {
     static getMetaData(metaData: LoggingMetaData): object | undefined;
     /** This function returns the name of each error status. Override this method to handle more error status codes. */
     protected _initName(): string;
+    /** This function returns the name of each error status. */
+    static getErrorKey(errorNumber: number): string;
     /** Use run-time type checking to safely get a useful string summary of an unknown error value, or `""` if none exists.
      * @note It's recommended to use this function in `catch` clauses, where a caught value cannot be assumed to be `instanceof Error`
      * @public

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

@@ -1 +1 @@
-{"version":3,"file":"BentleyError.d.ts","sourceRoot":"","sources":["../../src/BentleyError.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH;;;;;GAKG;AACH,oBAAY,aAAa;IACvB,OAAO,IAAS;IAChB,KAAK,QAAS;CACf;AAED;;;GAGG;AACH,oBAAY,YAAY;IACtB,iBAAiB,QAAU;IAC3B,OAAO,IAAI;IACX,aAAa,QAAwB;IACrC,WAAW,QAAwB;IACnC,MAAM,QAAwB;IAC9B,UAAU,QAAwB;IAClC,QAAQ,QAAwB;IAChC,UAAU,QAAwB;IAClC,SAAS,QAAwB;IACjC,UAAU,QAAwB;IAClC,eAAe,QAAwB;IACvC,kBAAkB,QAAyB;IAC3C,aAAa,QAAyB;IACtC,aAAa,QAAyB;IACtC,oBAAoB,QAAyB;IAC7C,iBAAiB,QAAyB;IAC1C,YAAY,QAAyB;IACrC,aAAa,QAAyB;IACtC,oBAAoB,QAAyB;IAC7C,QAAQ,QAAyB;IACjC,oBAAoB,QAAyB;IAC7C,eAAe,QAAyB;IACxC,WAAW,QAAyB;IACpC,eAAe,QAAyB;IACxC,SAAS,QAAyB;IAClC,WAAW,QAAyB;IACpC,aAAa,QAAyB;IACtC,qBAAqB,QAAyB;IAC9C,mBAAmB,QAAyB;IAC5C,WAAW,QAAyB;IACpC,YAAY,QAAyB;IACrC,WAAW,QAAyB;IACpC,aAAa,QAAyB;IACtC,cAAc,QAAyB;IACvC,SAAS,QAAyB;IAClC,UAAU,QAAyB;IACnC,mBAAmB,QAAyB;IAC5C,UAAU,QAAyB;IACnC,QAAQ,QAAyB;IACjC,OAAO,QAAyB;IAChC,eAAe,QAAyB;IACxC,eAAe,QAAyB;IACxC,aAAa,QAAyB;IACtC,aAAa,QAAyB;IACtC,mBAAmB,QAAyB;IAC5C,SAAS,QAAyB;IAClC,QAAQ,QAAyB;IACjC,cAAc,QAAyB;IACvC,sBAAsB,QAAyB;IAC/C,WAAW,QAAyB;IACpC,iBAAiB,QAAyB;IAC1C,YAAY,QAAyB;IACrC,aAAa,QAAyB;IACtC,aAAa,QAAyB;IACtC,gBAAgB,QAAyB;IACzC,aAAa,QAAyB;IACtC,aAAa,QAAyB;IACtC,YAAY,QAAyB;IACrC,UAAU,QAAyB;IACnC,UAAU,QAAyB;IACnC,WAAW,QAAyB;IACpC,WAAW,QAAyB;IACpC,YAAY,QAAyB;IACrC,YAAY,QAAyB;IACrC,UAAU,QAAyB;IACnC,mBAAmB,QAAyB;IAC5C,aAAa,QAAyB;IACtC,aAAa,QAAyB;IACtC,SAAS,QAAyB;IAClC,aAAa,QAAyB;IACtC,gBAAgB,QAAyB;IACzC,eAAe,QAAyB;IACxC,OAAO,QAAyB;CACjC;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB,qBAAqB,SAAU;IAC/B,aAAa,SAAwB;IACrC,cAAc,SAA4B;IAC1C,YAAY,SAA4B;IACxC,UAAU,SAA4B;IACtC,YAAY,SAA4B;IACxC,eAAe,SAA4B;IAC3C,kBAAkB,SAA4B;IAC9C,iBAAiB,SAA4B;IAC7C,yBAAyB,SAA4B;CACtD;AAED;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,OAAO,IAAI;IACX,wBAAwB,SAAU;IAClC,6GAA6G;IAC7G,mBAAmB,SAA2B;CAC/C;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB,OAAO,IAAI;IACX,oBAAoB,QAAU;IAC9B,mEAAmE;IACnE,UAAU,QAA2B;IACrC,6EAA6E;IAC7E,wBAAwB,QAA2B;IACnD,mFAAmF;IACnF,qBAAqB,QAA2B;IAChD,iEAAiE;IACjE,YAAY,QAA2B;IACvC,qFAAqF;IACrF,cAAc,QAA2B;IACzC,mEAAmE;IACnE,eAAe,QAA2B;IAC1C,sFAAsF;IACtF,qBAAqB,QAA2B;IAChD,4BAA4B;IAC5B,SAAS,QAA2B;IACpC,yCAAyC;IACzC,cAAc,QAA2B;IACzC,0FAA0F;IAC1F,oBAAoB,QAA4B;IAChD,wFAAwF;IACxF,mBAAmB,QAA4B;IAC/C,6EAA6E;IAC7E,sBAAsB,QAA4B;IAClD,oDAAoD;IACpD,qBAAqB,QAA4B;IACjD,8BAA8B;IAC9B,cAAc,QAA4B;IAC1C,2DAA2D;IAC3D,cAAc,QAA4B;IAC1C,iFAAiF;IACjF,cAAc,QAA4B;IAC1C,oDAAoD;IACpD,WAAW,QAA4B;IACvC,6CAA6C;IAC7C,UAAU,QAA4B;IACtC,mDAAmD;IACnD,iBAAiB,QAA4B;IAC7C,8GAA8G;IAC9G,wBAAwB,QAA4B;IACpD,kDAAkD;IAClD,+BAA+B,QAA4B;IAC3D,4HAA4H;IAC5H,0BAA0B,QAA4B;IACtD,kDAAkD;IAClD,uBAAuB,QAA4B;IACnD,iDAAiD;IACjD,qBAAqB,QAA4B;IACjD,uEAAuE;IACvE,uBAAuB,QAA4B;IACnD,2CAA2C;IAC3C,iBAAiB,QAA4B;CAC9C;AAED;;GAEG;AACH,oBAAY,UAAU;IACpB,kBAAkB;IAClB,OAAO,IAAI;IACX,kCAAkC;IAClC,IAAI,QAAU;IACd,sBAAsB;IACtB,WAAW,QAAU;IACrB,wBAAwB;IACxB,WAAW,QAAU;IACrB,wBAAwB;IACxB,WAAW,QAAU;CACtB;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB,OAAO,IAAI;IACX,mBAAmB,SAAU;IAC7B,+BAA+B,SAAU;IACzC,OAAO,SAA0B;IACjC,yBAAyB,SAA0B;IACnD,uBAAuB,SAA0B;IACjD,yBAAyB,SAA0B;IACnD,qBAAqB,SAA0B;IAC/C,gBAAgB,SAA0B;IAC1C,qBAAqB,SAA0B;IAC/C,4BAA4B,SAA0B;IACtD,kBAAkB,SAA0B;IAC5C,sBAAsB,SAA2B;IACjD,qBAAqB,SAA2B;IAChD,iBAAiB,SAA2B;IAC5C,sBAAsB,SAA2B;IACjD,wBAAwB,SAA2B;IACnD,eAAe,SAA2B;IAC1C,cAAc,SAA2B;IACzC,gCAAgC,SAA2B;IAC3D,yCAAyC,SAA2B;IACpE,yBAAyB,SAA2B;IACpD,cAAc,SAA2B;IACzC,UAAU,SAA2B;IACrC,UAAU,SAA2B;IACrC,mBAAmB,SAA2B;IAC9C,kBAAkB,SAA2B;IAC7C,gBAAgB,SAA2B;IAC3C,iBAAiB,SAA2B;IAC5C,gBAAgB,SAA2B;IAC3C,2BAA2B,SAA2B;IACtD,gBAAgB,SAA2B;IAC3C,8BAA8B,SAA2B;IACzD,gBAAgB,SAA2B;IAC3C,qBAAqB,SAA2B;IAChD,6BAA6B,SAA2B;IACxD,8BAA8B,SAA2B;IACzD,qBAAqB,SAA2B;IAChD,2BAA2B,SAA2B;IACtD,uBAAuB,SAA2B;IAClD,0BAA0B,SAA2B;IACrD,oBAAoB,SAA2B;IAC/C,mBAAmB,SAA2B;IAC9C,kBAAkB,SAA2B;IAC7C,oBAAoB,SAA2B;IAE/C,uBAAuB,SAA2B;IAClD,4BAA4B,SAA2B;IAEvD,2BAA2B,SAA2B;IACtD,uBAAuB,SAA2B;IAClD,iBAAiB,SAA2B;IAE5C,qBAAqB,SAA2B;IAEhD,uBAAuB,SAA2B;IAClD,sBAAsB,SAA2B;IAGjD,sBAAsB,SAAsC;IAC5D,oBAAoB,SAAsC;IAC1D,uBAAuB,SAAsC;IAC7D,qBAAqB,SAAsC;IAC3D,iBAAiB,SAAsC;IACvD,YAAY,SAAsC;IAClD,qBAAqB,SAAsC;CAC5D;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,OAAO,IAAI;IACX,qBAAqB,SAAU;IAE/B,aAAa,QAA6B;IAE1C,gBAAgB,SAA4B;IAC5C,uBAAuB,SAA4B;IACnD,gBAAgB,SAA4B;IAC5C,yBAAyB,SAA4B;IACrD,UAAU,SAA4B;IACtC,OAAO,SAA4B;CACpC;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,OAAO,IAAI;IACX,sBAAsB,SAAU;IAChC,WAAW,SAA6B;CACzC;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,MAAM,GAAG,SAAS,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,mBAAmB,GAAG,MAAM,GAAG,SAAS,CAAC;AAMvE,UAAU,UAAU;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,KAAK;IAQX,WAAW,EAAE,MAAM;IAP7C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAkB;IAE5C;;;;OAIG;gBACuB,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe;IAO3F,sEAAsE;IACtE,IAAW,WAAW,IAAI,OAAO,CAAyC;IAE1E,mEAAmE;IAC5D,WAAW,IAAI,MAAM,GAAG,SAAS;IAIxC,4EAA4E;WAC9D,WAAW,CAAC,QAAQ,EAAE,eAAe,GAAG,MAAM,GAAG,SAAS;IAIxE,mHAAmH;IACnH,SAAS,CAAC,SAAS,IAAI,MAAM;IA0R7B;;;OAGG;WACW,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM;IAsBrD;;;OAGG;WACW,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAO/D;;;;OAIG;WACW,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAUlE;;;;OAIG;WACW,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,UAAU;CAexD"}
+{"version":3,"file":"BentleyError.d.ts","sourceRoot":"","sources":["../../src/BentleyError.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,kFAAkF;IAClF,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,UAAW,SAAQ,KAAK;IACvC,6CAA6C;IAC7C,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;CACrC;AAED,YAAY;AACZ,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,SAAgB,MAAM,CAAC,CAAC,SAAS,UAAU,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAKzE;IAED;;OAEG;IACH,SAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,KAAK,CAEjF;IAED;;;;;;;MAOE;IACF,SAAgB,OAAO,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,CAAC,CAGrG;CACF;AAED;;;;;GAKG;AACH,oBAAY,aAAa;IACvB,OAAO,IAAS;IAChB,KAAK,QAAS;CACf;AAED;;;GAGG;AACH,oBAAY,YAAY;IACtB,iBAAiB,QAAU;IAC3B,OAAO,IAAI;IACX,aAAa,QAAwB;IACrC,WAAW,QAAwB;IACnC,MAAM,QAAwB;IAC9B,UAAU,QAAwB;IAClC,QAAQ,QAAwB;IAChC,UAAU,QAAwB;IAClC,SAAS,QAAwB;IACjC,UAAU,QAAwB;IAClC,eAAe,QAAwB;IACvC,kBAAkB,QAAyB;IAC3C,aAAa,QAAyB;IACtC,aAAa,QAAyB;IACtC,oBAAoB,QAAyB;IAC7C,iBAAiB,QAAyB;IAC1C,YAAY,QAAyB;IACrC,aAAa,QAAyB;IACtC,oBAAoB,QAAyB;IAC7C,QAAQ,QAAyB;IACjC,oBAAoB,QAAyB;IAC7C,eAAe,QAAyB;IACxC,WAAW,QAAyB;IACpC,eAAe,QAAyB;IACxC,SAAS,QAAyB;IAClC,WAAW,QAAyB;IACpC,aAAa,QAAyB;IACtC,qBAAqB,QAAyB;IAC9C,mBAAmB,QAAyB;IAC5C,WAAW,QAAyB;IACpC,YAAY,QAAyB;IACrC,WAAW,QAAyB;IACpC,aAAa,QAAyB;IACtC,cAAc,QAAyB;IACvC,SAAS,QAAyB;IAClC,UAAU,QAAyB;IACnC,mBAAmB,QAAyB;IAC5C,UAAU,QAAyB;IACnC,QAAQ,QAAyB;IACjC,OAAO,QAAyB;IAChC,eAAe,QAAyB;IACxC,eAAe,QAAyB;IACxC,aAAa,QAAyB;IACtC,aAAa,QAAyB;IACtC,mBAAmB,QAAyB;IAC5C,SAAS,QAAyB;IAClC,QAAQ,QAAyB;IACjC,cAAc,QAAyB;IACvC,sBAAsB,QAAyB;IAC/C,WAAW,QAAyB;IACpC,iBAAiB,QAAyB;IAC1C,YAAY,QAAyB;IACrC,aAAa,QAAyB;IACtC,aAAa,QAAyB;IACtC,gBAAgB,QAAyB;IACzC,aAAa,QAAyB;IACtC,aAAa,QAAyB;IACtC,YAAY,QAAyB;IACrC,UAAU,QAAyB;IACnC,UAAU,QAAyB;IACnC,WAAW,QAAyB;IACpC,WAAW,QAAyB;IACpC,YAAY,QAAyB;IACrC,YAAY,QAAyB;IACrC,UAAU,QAAyB;IACnC,mBAAmB,QAAyB;IAC5C,aAAa,QAAyB;IACtC,aAAa,QAAyB;IACtC,SAAS,QAAyB;IAClC,aAAa,QAAyB;IACtC,gBAAgB,QAAyB;IACzC,eAAe,QAAyB;IACxC,OAAO,QAAyB;CACjC;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB,qBAAqB,SAAU;IAC/B,aAAa,SAAwB;IACrC,cAAc,SAA4B;IAC1C,YAAY,SAA4B;IACxC,UAAU,SAA4B;IACtC,YAAY,SAA4B;IACxC,eAAe,SAA4B;IAC3C,kBAAkB,SAA4B;IAC9C,iBAAiB,SAA4B;IAC7C,yBAAyB,SAA4B;CACtD;AAED;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,OAAO,IAAI;IACX,wBAAwB,SAAU;IAClC,6GAA6G;IAC7G,mBAAmB,SAA2B;CAC/C;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB,OAAO,IAAI;IACX,oBAAoB,QAAU;IAC9B,mEAAmE;IACnE,UAAU,QAA2B;IACrC,6EAA6E;IAC7E,wBAAwB,QAA2B;IACnD,mFAAmF;IACnF,qBAAqB,QAA2B;IAChD,iEAAiE;IACjE,YAAY,QAA2B;IACvC,qFAAqF;IACrF,cAAc,QAA2B;IACzC,mEAAmE;IACnE,eAAe,QAA2B;IAC1C,sFAAsF;IACtF,qBAAqB,QAA2B;IAChD,4BAA4B;IAC5B,SAAS,QAA2B;IACpC,yCAAyC;IACzC,cAAc,QAA2B;IACzC,0FAA0F;IAC1F,oBAAoB,QAA4B;IAChD,wFAAwF;IACxF,mBAAmB,QAA4B;IAC/C,6EAA6E;IAC7E,sBAAsB,QAA4B;IAClD,oDAAoD;IACpD,qBAAqB,QAA4B;IACjD,8BAA8B;IAC9B,cAAc,QAA4B;IAC1C,2DAA2D;IAC3D,cAAc,QAA4B;IAC1C,iFAAiF;IACjF,cAAc,QAA4B;IAC1C,oDAAoD;IACpD,WAAW,QAA4B;IACvC,6CAA6C;IAC7C,UAAU,QAA4B;IACtC,mDAAmD;IACnD,iBAAiB,QAA4B;IAC7C,8GAA8G;IAC9G,wBAAwB,QAA4B;IACpD,kDAAkD;IAClD,+BAA+B,QAA4B;IAC3D,4HAA4H;IAC5H,0BAA0B,QAA4B;IACtD,kDAAkD;IAClD,uBAAuB,QAA4B;IACnD,iDAAiD;IACjD,qBAAqB,QAA4B;IACjD,uEAAuE;IACvE,uBAAuB,QAA4B;IACnD,2CAA2C;IAC3C,iBAAiB,QAA4B;CAC9C;AAED;;GAEG;AACH,oBAAY,UAAU;IACpB,kBAAkB;IAClB,OAAO,IAAI;IACX,kCAAkC;IAClC,IAAI,QAAU;IACd,sBAAsB;IACtB,WAAW,QAAU;IACrB,wBAAwB;IACxB,WAAW,QAAU;IACrB,wBAAwB;IACxB,WAAW,QAAU;CACtB;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB,OAAO,IAAI;IACX,mBAAmB,SAAU;IAC7B,+BAA+B,SAAU;IACzC,OAAO,SAA0B;IACjC,yBAAyB,SAA0B;IACnD,uBAAuB,SAA0B;IACjD,yBAAyB,SAA0B;IACnD,qBAAqB,SAA0B;IAC/C,gBAAgB,SAA0B;IAC1C,qBAAqB,SAA0B;IAC/C,4BAA4B,SAA0B;IACtD,kBAAkB,SAA0B;IAC5C,sBAAsB,SAA2B;IACjD,qBAAqB,SAA2B;IAChD,iBAAiB,SAA2B;IAC5C,sBAAsB,SAA2B;IACjD,wBAAwB,SAA2B;IACnD,eAAe,SAA2B;IAC1C,cAAc,SAA2B;IACzC,gCAAgC,SAA2B;IAC3D,yCAAyC,SAA2B;IACpE,yBAAyB,SAA2B;IACpD,cAAc,SAA2B;IACzC,UAAU,SAA2B;IACrC,UAAU,SAA2B;IACrC,mBAAmB,SAA2B;IAC9C,kBAAkB,SAA2B;IAC7C,gBAAgB,SAA2B;IAC3C,iBAAiB,SAA2B;IAC5C,gBAAgB,SAA2B;IAC3C,2BAA2B,SAA2B;IACtD,gBAAgB,SAA2B;IAC3C,8BAA8B,SAA2B;IACzD,gBAAgB,SAA2B;IAC3C,qBAAqB,SAA2B;IAChD,6BAA6B,SAA2B;IACxD,8BAA8B,SAA2B;IACzD,qBAAqB,SAA2B;IAChD,2BAA2B,SAA2B;IACtD,uBAAuB,SAA2B;IAClD,0BAA0B,SAA2B;IACrD,oBAAoB,SAA2B;IAC/C,mBAAmB,SAA2B;IAC9C,kBAAkB,SAA2B;IAC7C,oBAAoB,SAA2B;IAE/C,uBAAuB,SAA2B;IAClD,4BAA4B,SAA2B;IAEvD,2BAA2B,SAA2B;IACtD,uBAAuB,SAA2B;IAClD,iBAAiB,SAA2B;IAE5C,qBAAqB,SAA2B;IAEhD,uBAAuB,SAA2B;IAClD,sBAAsB,SAA2B;IAGjD,sBAAsB,SAAsC;IAC5D,oBAAoB,SAAsC;IAC1D,uBAAuB,SAAsC;IAC7D,qBAAqB,SAAsC;IAC3D,iBAAiB,SAAsC;IACvD,YAAY,SAAsC;IAClD,qBAAqB,SAAsC;CAC5D;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,OAAO,IAAI;IACX,qBAAqB,SAAU;IAE/B,aAAa,QAA6B;IAE1C,gBAAgB,SAA4B;IAC5C,uBAAuB,SAA4B;IACnD,gBAAgB,SAA4B;IAC5C,yBAAyB,SAA4B;IACrD,UAAU,SAA4B;IACtC;;OAEG;IACH,OAAO,SAA4B;CACpC;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,OAAO,IAAI;IACX,sBAAsB,SAAU;IAChC,WAAW,SAA6B;CACzC;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,MAAM,GAAG,SAAS,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,mBAAmB,GAAG,MAAM,GAAG,SAAS,CAAC;AAGvE,UAAU,UAAU;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;WAKW;AACX,MAAM,WAAW,0BAA2B,SAAQ,UAAU;IAC5D,sCAAsC;IACtC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;GAIG;AACH,qBAAa,YAAa,SAAQ,KAAK;IASX,WAAW,EAAE,MAAM;IAR7C,gBAAuB,eAAe,mBAAmB;IACzD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAkB;IAE5C;;;;OAIG;gBACuB,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe;IAO3F,yCAAyC;IACzC,IAAW,YAAY;;;MAEtB;IACD,iCAAiC;IACjC,IAAW,eAAe,uBAAiC;IAE3D;;;;;;OAMG;WACW,OAAO,CAAC,CAAC,SAAS,0BAA0B,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,CAAC;IAK7G,sEAAsE;IACtE,IAAW,WAAW,IAAI,OAAO,CAAyC;IAE1E,mEAAmE;IAC5D,WAAW,IAAI,MAAM,GAAG,SAAS;IAIxC,4EAA4E;WAC9D,WAAW,CAAC,QAAQ,EAAE,eAAe,GAAG,MAAM,GAAG,SAAS;IAIxE,mHAAmH;IACnH,SAAS,CAAC,SAAS,IAAI,MAAM;IAI7B,2DAA2D;WAC7C,WAAW,CAAC,WAAW,EAAE,MAAM;IA0R7C;;;OAGG;WACW,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM;IAsBrD;;;OAGG;WACW,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAO/D;;;;OAIG;WACW,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAUlE;;;;OAIG;WACW,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,UAAU;CAexD"}

package/lib/cjs/BentleyError.js

@@ -7,9 +7,44 @@
  * @module Errors
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BentleyError = exports.RealityDataStatus = exports.GeoServiceStatus = exports.IModelHubStatus = exports.HttpStatus = exports.ChangeSetStatus = exports.RpcInterfaceStatus = exports.BriefcaseStatus = exports.IModelStatus = exports.BentleyStatus = void 0;
+exports.BentleyError = exports.RealityDataStatus = exports.GeoServiceStatus = exports.IModelHubStatus = exports.HttpStatus = exports.ChangeSetStatus = exports.RpcInterfaceStatus = exports.BriefcaseStatus = exports.IModelStatus = exports.BentleyStatus = exports.ITwinError = void 0;
 const BeSQLite_1 = require("./BeSQLite");
 const RepositoryStatus_1 = require("./internal/RepositoryStatus");
+const JsonUtils_1 = require("./JsonUtils");
+/** @beta */
+var ITwinError;
+(function (ITwinError) {
+    /** Instantiate a new `ITwinError` or subtype thereof.
+     * @see [[ITwinError.throwError]] to conveniently instantiate and throw the error.
+     */
+    function create(args) {
+        const err = new Error(args.message);
+        Object.assign(err, args);
+        err.name = args.iTwinErrorId.key; // helpful because this is used by `toString` for Error class
+        return err;
+    }
+    ITwinError.create = create;
+    /** Instantiate and immediately throw an `ITwinError`.
+     * @see [[ITwinError.create]] to instantiate an error without throwing it.
+     */
+    function throwError(args) {
+        throw create(args);
+    }
+    ITwinError.throwError = throwError;
+    /**
+     * Determine whether an error object was thrown by iTwin.js and has a specific scope and key.
+     *
+     * If the test succeeds, the type of `error` is coerced to `T`
+     * @param error The error to ve verified.
+     * @param scope value for `error.iTwinErrorId.scope`
+     * @param key value for `error.iTwinErrorId.key`
+    */
+    function isError(error, scope, key) {
+        return JsonUtils_1.JsonUtils.isObject(error) && "iTwinErrorId" in error && JsonUtils_1.JsonUtils.isObject(error.iTwinErrorId)
+            && error.iTwinErrorId.scope === scope && (undefined === key || error.iTwinErrorId.key === key);
+    }
+    ITwinError.isError = isError;
+})(ITwinError || (exports.ITwinError = ITwinError = {}));
 /** Standard status code.
  * This status code should be rarely used.
  * Prefer to throw an exception to indicate an error, rather than returning a special status code.
@@ -285,6 +320,9 @@ var GeoServiceStatus;
     GeoServiceStatus[GeoServiceStatus["NoDatumConverter"] = 147459] = "NoDatumConverter";
     GeoServiceStatus[GeoServiceStatus["VerticalDatumConvertError"] = 147460] = "VerticalDatumConvertError";
     GeoServiceStatus[GeoServiceStatus["CSMapError"] = 147461] = "CSMapError";
+    /**
+     * @deprecated in 5.0. This status is never returned.
+     */
     GeoServiceStatus[GeoServiceStatus["Pending"] = 147462] = "Pending";
 })(GeoServiceStatus || (exports.GeoServiceStatus = GeoServiceStatus = {}));
 /** Error status from various reality data operations
@@ -296,13 +334,15 @@ var RealityDataStatus;
     RealityDataStatus[RealityDataStatus["REALITYDATA_ERROR_BASE"] = 151552] = "REALITYDATA_ERROR_BASE";
     RealityDataStatus[RealityDataStatus["InvalidData"] = 151553] = "InvalidData";
 })(RealityDataStatus || (exports.RealityDataStatus = RealityDataStatus = {}));
-function isObject(obj) {
-    return typeof obj === "object" && obj !== null;
-}
-/** Base exception class for iTwin.js exceptions.
+/**
+ * Base exception class for legacy iTwin.js errors.
+ * For backwards compatibility only. Do not create new subclasses of BentleyError. Instead use [[ITwinError]].
  * @public
  */
 class BentleyError extends Error {
+    errorNumber;
+    static iTwinErrorScope = "bentley-error";
+    _metaData;
     /**
      * @param errorNumber The a number that identifies of the problem.
      * @param message  message that describes the problem (should not be localized).
@@ -315,6 +355,23 @@ class BentleyError extends Error {
         this._metaData = metaData;
         this.name = this._initName();
     }
+    /** supply the value for iTwinErrorId  */
+    get iTwinErrorId() {
+        return { scope: BentleyError.iTwinErrorScope, key: this.name };
+    }
+    /** value for logging metadata */
+    get loggingMetadata() { return this.getMetaData(); }
+    /**
+     * Determine if an error object implements the `LegacyITwinErrorWithNumber` interface.
+     *
+     * If the test succeeds, the type of `error` is coerced to `T`
+     * @note this method does *not* test that the object is an `instanceOf BentleyError`.
+     * @beta
+     */
+    static isError(error, errorNumber) {
+        return ITwinError.isError(error, BentleyError.iTwinErrorScope) &&
+            typeof error.errorNumber === "number" && (errorNumber === undefined || error.errorNumber === errorNumber);
+    }
     /** Returns true if this BentleyError includes (optional) metadata. */
     get hasMetaData() { return undefined !== this._metaData; }
     /** get the meta data associated with this BentleyError, if any. */
@@ -327,7 +384,11 @@ class BentleyError extends Error {
     }
     /** This function returns the name of each error status. Override this method to handle more error status codes. */
     _initName() {
-        switch (this.errorNumber) {
+        return BentleyError.getErrorKey(this.errorNumber);
+    }
+    /** This function returns the name of each error status. */
+    static getErrorKey(errorNumber) {
+        switch (errorNumber) {
             case IModelStatus.AlreadyLoaded: return "Already Loaded";
             case IModelStatus.AlreadyOpen: return "Already Open";
             case IModelStatus.BadArg: return "Bad Arg";
@@ -594,7 +655,7 @@ class BentleyError extends Error {
             case GeoServiceStatus.NoDatumConverter: return "No datum converter";
             case GeoServiceStatus.VerticalDatumConvertError: return "Vertical datum convert error";
             case GeoServiceStatus.CSMapError: return "CSMap error";
-            case GeoServiceStatus.Pending: return "Pending";
+            case GeoServiceStatus.Pending: return "Pending"; // eslint-disable-line @typescript-eslint/no-deprecated
             case RealityDataStatus.InvalidData: return "Invalid or unknown data";
             case BeSQLite_1.DbResult.BE_SQLITE_OK:
             case BeSQLite_1.DbResult.BE_SQLITE_ROW:
@@ -602,7 +663,7 @@ class BentleyError extends Error {
             case BentleyStatus.SUCCESS:
                 return "Success";
             default:
-                return `Error (${this.errorNumber})`;
+                return `Error (${errorNumber})`;
         }
     }
     /** Use run-time type checking to safely get a useful string summary of an unknown error value, or `""` if none exists.
@@ -614,7 +675,7 @@ class BentleyError extends Error {
             return error;
         if (error instanceof Error)
             return error.toString();
-        if (isObject(error)) {
+        if (JsonUtils_1.JsonUtils.isObject(error)) {
             if (typeof error.message === "string")
                 return error.message;
             if (typeof error.msg === "string")
@@ -630,7 +691,7 @@ class BentleyError extends Error {
      * @public
      */
     static getErrorStack(error) {
-        if (isObject(error) && typeof error.stack === "string")
+        if (JsonUtils_1.JsonUtils.isObject(error) && typeof error.stack === "string")
             return error.stack;
         return undefined;
     }
@@ -640,7 +701,7 @@ class BentleyError extends Error {
      * @public
      */
     static getErrorMetadata(error) {
-        if (isObject(error) && typeof error.getMetaData === "function") {
+        if (JsonUtils_1.JsonUtils.isObject(error) && typeof error.getMetaData === "function") {
             const metadata = error.getMetaData();
             if (typeof metadata === "object" && metadata !== null)
                 return metadata;