@itwin/core-i18n 5.0.0-dev.93 → 5.0.0-dev.95

package/lib/cjs/test/webpack/bundled-tests.instrumented.js

@@ -17778,11 +17778,13 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */   HttpStatus: () => (/* binding */ HttpStatus),
 /* harmony export */   IModelHubStatus: () => (/* binding */ IModelHubStatus),
 /* harmony export */   IModelStatus: () => (/* binding */ IModelStatus),
+/* harmony export */   ITwinError: () => (/* binding */ ITwinError),
 /* harmony export */   RealityDataStatus: () => (/* binding */ RealityDataStatus),
 /* harmony export */   RpcInterfaceStatus: () => (/* binding */ RpcInterfaceStatus)
 /* harmony export */ });
 /* harmony import */ var _BeSQLite__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./BeSQLite */ "../bentley/lib/esm/BeSQLite.js");
 /* harmony import */ var _internal_RepositoryStatus__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./internal/RepositoryStatus */ "../bentley/lib/esm/internal/RepositoryStatus.js");
+/* harmony import */ var _JsonUtils__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ./JsonUtils */ "../bentley/lib/esm/JsonUtils.js");
 /*---------------------------------------------------------------------------------------------
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
@@ -17792,6 +17794,41 @@ __webpack_require__.r(__webpack_exports__);
  */
 
 
+
+/** @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__WEBPACK_IMPORTED_MODULE_2__.JsonUtils.isObject(error) && "iTwinErrorId" in error && _JsonUtils__WEBPACK_IMPORTED_MODULE_2__.JsonUtils.isObject(error.iTwinErrorId)
+            && error.iTwinErrorId.scope === scope && (undefined === key || error.iTwinErrorId.key === key);
+    }
+    ITwinError.isError = isError;
+})(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.
@@ -18081,14 +18118,14 @@ var RealityDataStatus;
     RealityDataStatus[RealityDataStatus["REALITYDATA_ERROR_BASE"] = 151552] = "REALITYDATA_ERROR_BASE";
     RealityDataStatus[RealityDataStatus["InvalidData"] = 151553] = "InvalidData";
 })(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.
@@ -18102,6 +18139,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. */
@@ -18114,7 +18168,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";
@@ -18389,7 +18447,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.
@@ -18401,7 +18459,7 @@ class BentleyError extends Error {
             return error;
         if (error instanceof Error)
             return error.toString();
-        if (isObject(error)) {
+        if (_JsonUtils__WEBPACK_IMPORTED_MODULE_2__.JsonUtils.isObject(error)) {
             if (typeof error.message === "string")
                 return error.message;
             if (typeof error.msg === "string")
@@ -18417,7 +18475,7 @@ class BentleyError extends Error {
      * @public
      */
     static getErrorStack(error) {
-        if (isObject(error) && typeof error.stack === "string")
+        if (_JsonUtils__WEBPACK_IMPORTED_MODULE_2__.JsonUtils.isObject(error) && typeof error.stack === "string")
             return error.stack;
         return undefined;
     }
@@ -18427,7 +18485,7 @@ class BentleyError extends Error {
      * @public
      */
     static getErrorMetadata(error) {
-        if (isObject(error) && typeof error.getMetaData === "function") {
+        if (_JsonUtils__WEBPACK_IMPORTED_MODULE_2__.JsonUtils.isObject(error) && typeof error.getMetaData === "function") {
             const metadata = error.getMetaData();
             if (typeof metadata === "object" && metadata !== null)
                 return metadata;
@@ -20591,12 +20649,17 @@ var JsonUtils;
             json[key] = val;
     }
     JsonUtils.setOrRemoveBoolean = setOrRemoveBoolean;
+    /** Returns `true` if `json` is a non-null object. */
+    function isObject(json) {
+        return json !== null && "object" === typeof json;
+    }
+    JsonUtils.isObject = isObject;
     /** Determine if a Javascript object is equivalent to `{}`.
      * @param json The JSON object to test.
      * @returns true if `json` is an Object with no keys.
      */
     function isEmptyObject(json) {
-        return "object" === typeof json && 0 === Object.keys(json).length;
+        return isObject(json) && 0 === Object.keys(json).length;
     }
     JsonUtils.isEmptyObject = isEmptyObject;
     /** Determine if the input is undefined or an empty Javascript object.
@@ -21240,14 +21303,19 @@ class Logger {
         const stack = Logger.logExceptionCallstacks ? `\n${_BentleyError__WEBPACK_IMPORTED_MODULE_1__.BentleyError.getErrorStack(err)}` : "";
         return _BentleyError__WEBPACK_IMPORTED_MODULE_1__.BentleyError.getErrorMessage(err) + stack;
     }
-    /** Log the specified exception. The special "ExceptionType" property will be added as metadata.
+    /** Log the specified exception.
+     * For legacy [[BentleyError]] exceptions, the special "exceptionType" property will be added as metadata. Otherwise, all enumerable members of the exception are logged as metadata.
      * @param category  The category of the message.
      * @param err  The exception object.
      * @param log The logger output function to use - defaults to Logger.logError
      */
     static logException(category, err, log = (_category, message, metaData) => Logger.logError(_category, message, metaData)) {
         log(category, Logger.getExceptionMessage(err), () => {
-            return { ..._BentleyError__WEBPACK_IMPORTED_MODULE_1__.BentleyError.getErrorMetadata(err), exceptionType: err?.constructor?.name ?? "<Unknown>" };
+            // For backwards compatibility, log BentleyError old way
+            if (_BentleyError__WEBPACK_IMPORTED_MODULE_1__.BentleyError.isError(err))
+                return { ..._BentleyError__WEBPACK_IMPORTED_MODULE_1__.BentleyError.getErrorMetadata(err), exceptionType: err?.constructor?.name ?? "<Unknown>" };
+            // return a copy of the error, with non-enumerable members `message` and `stack` removed, as "metadata" for log.
+            return { ...err };
         });
     }
     /** Log the specified message to the **warning** stream.
@@ -23766,6 +23834,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */   HttpStatus: () => (/* reexport safe */ _BentleyError__WEBPACK_IMPORTED_MODULE_3__.HttpStatus),
 /* harmony export */   IModelHubStatus: () => (/* reexport safe */ _BentleyError__WEBPACK_IMPORTED_MODULE_3__.IModelHubStatus),
 /* harmony export */   IModelStatus: () => (/* reexport safe */ _BentleyError__WEBPACK_IMPORTED_MODULE_3__.IModelStatus),
+/* harmony export */   ITwinError: () => (/* reexport safe */ _BentleyError__WEBPACK_IMPORTED_MODULE_3__.ITwinError),
 /* harmony export */   Id64: () => (/* reexport safe */ _Id__WEBPACK_IMPORTED_MODULE_13__.Id64),
 /* harmony export */   IndexMap: () => (/* reexport safe */ _IndexMap__WEBPACK_IMPORTED_MODULE_14__.IndexMap),
 /* harmony export */   IndexedValue: () => (/* reexport safe */ _IndexMap__WEBPACK_IMPORTED_MODULE_14__.IndexedValue),