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

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

@@ -3,6 +3,7 @@
  */
 import { LoggingMetaData } from "@itwin/core-bentley";
 import { LockState } from "./IModelError";
+import { BriefcaseId } from "./BriefcaseTypes";
 /**
  * Detailed information about a particular object Lock that is causing the Lock update conflict.
  * 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.
@@ -17,20 +18,34 @@ export interface InUseLock {
      */
     state: LockState;
     /** An array of Briefcase ids that hold this lock. */
-    briefcaseIds: number[];
+    briefcaseIds: BriefcaseId[];
 }
+/**
+ * iTwinjs Core namespace namespace for a developer/application.
+ * @beta
+ */
+export declare const iTwinjsCoreNamespace = "itwinjs-core";
+/**
+ * error keys object used to describe an error keys for a developer/application.
+ * @beta
+ */
+export declare const iTwinErrorKeys: {
+    readonly inUseLocks: "in-use-locks";
+    readonly channelNest: "channel-may-not-nest";
+    readonly channelNotAllowed: "channel-not-allowed";
+    readonly channelRootExists: "channel-root-exists";
+};
+/**
+ * Record for all itwin error messages.
+ * @beta
+ */
+export declare const iTwinErrorMessages: Record<keyof typeof iTwinErrorKeys, (...args: any[]) => string>;
 /**
  * An interface used to describe an error for a developer/application. The message is not intended to be displayed to an end user.
  * This error interface should be extended when needing to throw errors with extra properties defined on them. See [[InUseLocksError]] for an example.
- * 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.
- * See [[InUseLocksError.throwInUseLocksError]] and [[InUseLocksError.isInUseLocksError]] for examples of how to throw and check that an error is of type InUseLocksError.
- * * Example of catching a ITwinError:
- * ``` ts
- * [[include:ITwinError.catchAndHandleITwinError]]
- * ```
  * @beta
  */
-export interface ITwinError {
+export interface ITwinError extends Error {
     /** namespace for the error. This is a unique qualifier for the errorKey. */
     namespace: string;
     /** unique key for error, within namespace. All errorKeys within the same namespace must be unique. */
@@ -48,25 +63,46 @@ export interface ITwinError {
  * @beta
 */
 export interface InUseLocksError extends ITwinError {
-    namespace: "itwinjs-core";
-    errorKey: "in-use-locks";
     inUseLocks: InUseLock[];
 }
-/** @beta */
-export declare namespace InUseLocksError {
-    /**
-     * type guard function that returns whether or not the passed in parameter is an [[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 [[InUseLocksError.isInUseLocksError]] type guard function */
-    function throwInUseLocksError(inUseLocks: InUseLock[], message?: string, metadata?: LoggingMetaData): never;
-}
-/** @beta */
-export declare namespace ITwinError {
-    /** type guard function that returns whether or not the passed in parameter is an [[ITwinError]] */
-    function isITwinError(error: unknown): error is ITwinError;
-    /** get the meta data associated with this ITwinError, if any. */
-    function getMetaData(err: ITwinError): object | undefined;
-}
+/**
+* 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 declare function constructITwinError(namespace: string, errorKey: string, message?: string, metadata?: LoggingMetaData): ITwinError;
+/**
+* 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 declare function constructDetailedError<T extends ITwinError>(namespace: string, errorKey: string, details: Omit<T, keyof ITwinError>, message?: string, metadata?: LoggingMetaData): T;
+/**
+ * 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 declare function createITwinErrorTypeAsserter<T extends ITwinError>(namespace: string, errorKey: string): (error: unknown) => error is T;
+/**
+ * get the meta data associated with this ITwinError, if any.
+ * @param error The error for which metadata is required.
+ * @beta
+*/
+export declare function getITwinErrorMetaData(error: ITwinError): object | undefined;
+/**
+ * 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 declare function isITwinError(error: unknown, namespace?: string, errorKey?: string): error is ITwinError;
 //# sourceMappingURL=ITwinError.d.ts.map

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,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"}
+{"version":3,"file":"ITwinError.d.ts","sourceRoot":"","sources":["../../src/ITwinError.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,iDAAiD;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,KAAK,EAAE,SAAS,CAAC;IACjB,qDAAqD;IACrD,YAAY,EAAE,WAAW,EAAE,CAAC;CAC7B;AAED;;;GAGG;AACH,eAAO,MAAM,oBAAoB,iBAAiB,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,cAAc;;;;;CAKjB,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,MAAM,OAAO,cAAc,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,CAK9F,CAAC;AAGF;;;;GAIG;AACH,MAAM,WAAW,UAAW,SAAQ,KAAK;IACvC,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,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB;AAED;;;;;;;EAOE;AACF,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe,GAAG,UAAU,CAWjI;AAED;;;;;;;;EAQE;AACF,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,UAAU,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe,GAAG,CAAC,CAKrL;AAED;;;;;EAKE;AACF,wBAAgB,4BAA4B,CAAC,CAAC,SAAS,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,WACrF,OAAO,KAAG,KAAK,IAAI,CAAC,CACpC;AAED;;;;EAIE;AACF,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,CAE3E;AAED;;;;;;EAME;AACF,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,UAAU,CAKvG"}

package/lib/esm/ITwinError.js

@@ -5,48 +5,91 @@
 /** @packageDocumentation
  * @module iModels
  */
-import { BentleyError } from "@itwin/core-bentley";
-/** @beta */
-export var InUseLocksError;
-(function (InUseLocksError) {
-    /**
-     * type guard function that returns whether or not the passed in parameter is an [[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) {
-        return ITwinError.isITwinError(error) && error.namespace === "itwinjs-core" && error.errorKey === "in-use-locks";
-    }
-    InUseLocksError.isInUseLocksError = isInUseLocksError;
-    /** 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'
-        Error.captureStackTrace(errorObject, throwInUseLocksError); // optional: whether we want to hide throwInUseLocksError or not from the stack. not super important
-        const lockError = {
-            namespace: "itwinjs-core",
-            errorKey: "in-use-locks",
-            message: message ?? "One or more objects are already locked by another briefcase.",
-            metadata,
-            inUseLocks,
-        };
-        Object.assign(errorObject, lockError);
-        throw errorObject;
-    }
-    InUseLocksError.throwInUseLocksError = throwInUseLocksError;
-})(InUseLocksError || (InUseLocksError = {}));
-/** @beta */
-export var ITwinError;
-(function (ITwinError) {
-    /** type guard function that returns whether or not the passed in parameter is an [[ITwinError]] */
-    function isITwinError(error) {
-        return error !== undefined && error !== null && typeof error === "object" && "namespace" in error && "errorKey" in error && "message" in error;
-    }
-    ITwinError.isITwinError = isITwinError;
-    /** get the meta data associated with this ITwinError, if any. */
-    function getMetaData(err) {
-        return BentleyError.getMetaData(err.metadata);
-    }
-    ITwinError.getMetaData = getMetaData;
-})(ITwinError || (ITwinError = {}));
-;
+/**
+ * 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 +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,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":["/*---------------------------------------------------------------------------------------------\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 [[InUseLocksError.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;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"]}

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"}