@itwin/core-common 5.0.0-dev.92 → 5.0.0-dev.94

package/lib/esm/ITwinError.js

@@ -1,95 +0,0 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module iModels
- */
-/**
- * iTwinjs Core namespace namespace for a developer/application.
- * @beta
- */
-export const iTwinjsCoreNamespace = "itwinjs-core";
-/**
- * error keys object used to describe an error keys for a developer/application.
- * @beta
- */
-export const iTwinErrorKeys = {
-    inUseLocks: "in-use-locks",
-    channelNest: "channel-may-not-nest",
-    channelNotAllowed: "channel-not-allowed",
-    channelRootExists: "channel-root-exists"
-};
-/**
- * Record for all itwin error messages.
- * @beta
- */
-export const iTwinErrorMessages = {
-    "inUseLocks": () => 'Objects are locked by another briefcase',
-    "channelNest": (id) => `Channel ${id} may not nest`,
-    "channelNotAllowed": (id) => `Channel ${id} is not allowed`,
-    "channelRootExists": (id) => `Channel ${id} root already exist`,
-};
-/**
-* A function which will be used to construct an [[ITwinError]].
-* @param namespace The namespace associated with the error.
-* @param errorKey The errorKey associated with the error.
-* @param message The message associated with the error.
-* @param metadata Metadata associated with the error.
-* @beta
-*/
-export function constructITwinError(namespace, errorKey, message, metadata) {
-    const error = new Error();
-    error.message = message ?? `${errorKey} occurred`;
-    error.name = `${namespace}:${errorKey}`;
-    error.namespace = namespace;
-    error.errorKey = errorKey;
-    error.metadata = metadata;
-    Error.captureStackTrace(error, constructITwinError); // Optional, but this would hide constructITwinError from stack.
-    return error;
-}
-/**
-* A function which constructs a detailed error for example [[ InUseLocksError ]] above.
-* @param namespace The namespace associated with the error.
-* @param errorKey The errorKey associated with the error.
-* @param details Other details associated with the error.
-* @param message The message associated with the error.
-* @param metadata Metadata associated with the error.
-* @beta
-*/
-export function constructDetailedError(namespace, errorKey, details, message, metadata) {
-    const baseError = constructITwinError(namespace, errorKey, message, metadata);
-    Error.captureStackTrace(baseError, constructDetailedError); // Optional, but this would hide constructDetailedError from stack.
-    return Object.assign(baseError, details);
-}
-/**
- * a high level function that returns a type asserter function which would return whether or not the passed in parameter is an [[ITwinError]]
- * @param namespace The namespace associated with the error.
- * @param errorKey The errorKey associated with the error.
- * @beta
-*/
-export function createITwinErrorTypeAsserter(namespace, errorKey) {
-    return (error) => isITwinError(error, namespace, errorKey);
-}
-/**
- * get the meta data associated with this ITwinError, if any.
- * @param error The error for which metadata is required.
- * @beta
-*/
-export function getITwinErrorMetaData(error) {
-    return (typeof error.metadata === "function") ? error.metadata() : error.metadata;
-}
-/**
- * type guard function that returns whether or not the passed in parameter is an [[ITwinError]]
- * @param error The error which is to ve verified.
- * @param namespace The namespace associated with the error.
- * @param errorKey The errorKey associated with the error.
- * @beta
-*/
-export function isITwinError(error, namespace, errorKey) {
-    return error !== undefined && error !== null && typeof error === "object"
-        && "namespace" in error && "errorKey" in error && "message" in error
-        && (namespace === undefined || error.namespace === namespace)
-        && (errorKey === undefined || error.errorKey === errorKey);
-}
-//# sourceMappingURL=ITwinError.js.map

package/lib/esm/ITwinError.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ITwinError.js","sourceRoot":"","sources":["../../src/ITwinError.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAuBH;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,cAAc,CAAC;AAEnD;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,UAAU,EAAE,cAAc;IAC1B,WAAW,EAAE,sBAAsB;IACnC,iBAAiB,EAAE,qBAAqB;IACxC,iBAAiB,EAAE,qBAAqB;CAChC,CAAC;AAEX;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAoE;IACjG,YAAY,EAAE,GAAG,EAAE,CAAC,yCAAyC;IAC7D,aAAa,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,WAAW,EAAE,eAAe;IACnD,mBAAmB,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,WAAW,EAAE,iBAAiB;IAC3D,mBAAmB,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,WAAW,EAAE,qBAAqB;CAChE,CAAC;AA8BF;;;;;;;EAOE;AACF,MAAM,UAAU,mBAAmB,CAAC,SAAiB,EAAE,QAAgB,EAAE,OAAgB,EAAE,QAA0B;IAEnH,MAAM,KAAK,GAAG,IAAI,KAAK,EAAgB,CAAC;IACxC,KAAK,CAAC,OAAO,GAAG,OAAO,IAAI,GAAG,QAAQ,WAAW,CAAC;IAClD,KAAK,CAAC,IAAI,GAAG,GAAG,SAAS,IAAI,QAAQ,EAAE,CAAC;IACxC,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;IAC5B,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC1B,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAE1B,KAAK,CAAC,iBAAiB,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC,CAAC,gEAAgE;IACrH,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;EAQE;AACF,MAAM,UAAU,sBAAsB,CAAuB,SAAiB,EAAE,QAAgB,EAAE,OAAkC,EAAE,OAAgB,EAAE,QAA0B;IAChL,MAAM,SAAS,GAAG,mBAAmB,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAE9E,KAAK,CAAC,iBAAiB,CAAC,SAAS,EAAE,sBAAsB,CAAC,CAAC,CAAC,mEAAmE;IAC/H,OAAO,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAM,CAAC;AAChD,CAAC;AAED;;;;;EAKE;AACF,MAAM,UAAU,4BAA4B,CAAuB,SAAiB,EAAE,QAAgB;IACpG,OAAO,CAAC,KAAc,EAAc,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;AAClF,CAAC;AAED;;;;EAIE;AACF,MAAM,UAAU,qBAAqB,CAAC,KAAiB;IACrD,OAAO,CAAC,OAAO,KAAK,CAAC,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC;AACpF,CAAC;AAED;;;;;;EAME;AACF,MAAM,UAAU,YAAY,CAAC,KAAc,EAAE,SAAkB,EAAE,QAAiB;IAChF,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;WACpE,WAAW,IAAI,KAAK,IAAI,UAAU,IAAI,KAAK,IAAI,SAAS,IAAI,KAAK;WACjE,CAAC,SAAS,KAAK,SAAS,IAAK,KAAoB,CAAC,SAAS,KAAK,SAAS,CAAC;WAC1E,CAAC,QAAQ,KAAK,SAAS,IAAK,KAAoB,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;AAC/E,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 { LoggingMetaData } from \"@itwin/core-bentley\";\nimport { LockState } from \"./IModelError\";\nimport { BriefcaseId } from \"./BriefcaseTypes\";\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: BriefcaseId[];\n}\n\n/**\n * iTwinjs Core namespace namespace for a developer/application.\n * @beta\n */\nexport const iTwinjsCoreNamespace = \"itwinjs-core\";\n\n/**\n * error keys object used to describe an error keys for a developer/application.\n * @beta\n */\nexport const iTwinErrorKeys = {\n  inUseLocks: \"in-use-locks\",\n  channelNest: \"channel-may-not-nest\",\n  channelNotAllowed: \"channel-not-allowed\",\n  channelRootExists: \"channel-root-exists\"\n} as const;\n\n/**\n * Record for all itwin error messages.\n * @beta\n */\nexport const iTwinErrorMessages: Record<keyof typeof iTwinErrorKeys, (...args: any[]) => string> = {\n  \"inUseLocks\": () => 'Objects are locked by another briefcase',\n  \"channelNest\": (id) => `Channel ${id} may not nest`,\n  \"channelNotAllowed\": (id) => `Channel ${id} is not allowed`,\n  \"channelRootExists\": (id) => `Channel ${id} root already exist`,\n};\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 * @beta\n */\nexport interface ITwinError extends Error {\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  inUseLocks: InUseLock[];\n}\n\n/**\n* A function which will be used to construct an [[ITwinError]].\n* @param namespace The namespace associated with the error.\n* @param errorKey The errorKey associated with the error.\n* @param message The message associated with the error.\n* @param metadata Metadata associated with the error.\n* @beta\n*/\nexport function constructITwinError(namespace: string, errorKey: string, message?: string, metadata?: LoggingMetaData): ITwinError {\n\n  const error = new Error() as ITwinError;\n  error.message = message ?? `${errorKey} occurred`;\n  error.name = `${namespace}:${errorKey}`;\n  error.namespace = namespace;\n  error.errorKey = errorKey;\n  error.metadata = metadata;\n\n  Error.captureStackTrace(error, constructITwinError); // Optional, but this would hide constructITwinError from stack.\n  return error;\n}\n\n/**\n* A function which constructs a detailed error for example [[ InUseLocksError ]] above.\n* @param namespace The namespace associated with the error.\n* @param errorKey The errorKey associated with the error.\n* @param details Other details associated with the error.\n* @param message The message associated with the error.\n* @param metadata Metadata associated with the error.\n* @beta\n*/\nexport function constructDetailedError<T extends ITwinError>(namespace: string, errorKey: string, details: Omit<T, keyof ITwinError>, message?: string, metadata?: LoggingMetaData): T {\n  const baseError = constructITwinError(namespace, errorKey, message, metadata);\n\n  Error.captureStackTrace(baseError, constructDetailedError); // Optional, but this would hide constructDetailedError from stack.\n  return Object.assign(baseError, details) as T;\n}\n\n/**\n * a high level function that returns a type asserter function which would return whether or not the passed in parameter is an [[ITwinError]]\n * @param namespace The namespace associated with the error.\n * @param errorKey The errorKey associated with the error.\n * @beta\n*/\nexport function createITwinErrorTypeAsserter<T extends ITwinError>(namespace: string, errorKey: string) {\n  return (error: unknown): error is T => isITwinError(error, namespace, errorKey);\n}\n\n/**\n * get the meta data associated with this ITwinError, if any.\n * @param error The error for which metadata is required.\n * @beta\n*/\nexport function getITwinErrorMetaData(error: ITwinError): object | undefined {\n  return (typeof error.metadata === \"function\") ? error.metadata() : error.metadata;\n}\n\n/**\n * type guard function that returns whether or not the passed in parameter is an [[ITwinError]]\n * @param error The error which is to ve verified.\n * @param namespace The namespace associated with the error.\n * @param errorKey The errorKey associated with the error.\n * @beta\n*/\nexport function isITwinError(error: unknown, namespace?: string, errorKey?: string): error is ITwinError {\n  return error !== undefined && error !== null && typeof error === \"object\"\n    && \"namespace\" in error && \"errorKey\" in error && \"message\" in error\n    && (namespace === undefined || (error as ITwinError).namespace === namespace)\n    && (errorKey === undefined || (error as ITwinError).errorKey === errorKey);\n}\n"]}