@itwin/core-common 5.0.0-dev.11 → 5.0.0-dev.110

package/lib/cjs/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,MAAa,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;AAjFD,sCAiFC","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,MAAa,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;AAjFD,sCAiFC","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"]}

package/lib/cjs/ITwinCoreErrors.d.ts

@@ -0,0 +1,107 @@
+/** @packageDocumentation
+ * @module iModels
+ */
+import { ITwinError } from "@itwin/core-bentley";
+/**
+ * An error originating from the [SQLiteDb]($backend) API.
+ * @beta
+ */
+export interface SqliteError extends ITwinError {
+    /** The name of the database for this problem. */
+    dbName: string;
+}
+/** @beta */
+export declare namespace SqliteError {
+    const scope = "itwin-Sqlite";
+    type Key = "already-open" | "incompatible-version" | "invalid-versions-property" | "readonly";
+    /** Determine whether an error object is a SqliteError */
+    function isError(error: unknown, key?: Key): error is SqliteError;
+    /** Instantiate and throw a SqliteError */
+    function throwError(key: Key, message: string, dbName: string): never;
+}
+/**
+ * An error originating from the [CloudSqlite]($backend) API.
+ * @beta
+ */
+export interface CloudSqliteError extends ITwinError {
+    /** The name of the database that generated the error */
+    readonly dbName?: string;
+    /** The name of the container associated with the error */
+    readonly containerId?: string;
+}
+/** @beta */
+export declare namespace CloudSqliteError {
+    const scope = "itwin-CloudSqlite";
+    type Key = "already-published" | "copy-error" | "invalid-name" | "no-version-available" | "not-a-function" | "service-not-available" | 
+    /** The write lock cannot be acquired because it is currently held by somebody else.
+     * @see WriteLockHeld for details
+     */
+    "write-lock-held" | 
+    /** The write lock on a container is not held, but is required for this operation */
+    "write-lock-not-held";
+    /** thrown when an attempt to acquire the write lock for a container fails because the lock is already held by somebody else ("write-lock-held").  */
+    interface WriteLockHeld extends CloudSqliteError {
+        /** @internal */
+        errorNumber: number;
+        /** moniker of user currently holding container's lock */
+        lockedBy: string;
+        /** time the lock expires */
+        expires: string;
+    }
+    /** Determine whether an error object is a CloudSqliteError */
+    function isError<T extends CloudSqliteError>(error: unknown, key?: Key): error is T;
+    /** Instantiate and throw a CloudSqliteError */
+    function throwError<T extends CloudSqliteError>(key: Key, e: Omit<T, "name" | "iTwinErrorId">): never;
+}
+/** Errors thrown by the [ViewStore]($backend) API.
+ * @beta
+ */
+export interface ViewStoreError extends ITwinError {
+    /** The name of the ViewStore that generated the error */
+    viewStoreName?: string;
+}
+/** @beta */
+export declare namespace ViewStoreError {
+    const scope = "itwin-ViewStore";
+    type Key = "invalid-value" | "invalid-member" | "no-owner" | "not-found" | "not-unique" | "group-error";
+    /** Determine whether an error object is a ViewStoreError */
+    function isError<T extends ViewStoreError>(error: unknown, key?: Key): error is T;
+    /** Instantiate and throw a ViewStoreError */
+    function throwError<T extends ViewStoreError>(key: Key, e: Omit<T, "name" | "iTwinErrorId">): never;
+}
+/**
+ * Errors thrown by the [Workspace]($backend) APIs.
+ * @beta
+ */
+export declare namespace WorkspaceError {
+    const scope = "itwin-Workspace";
+    type Key = "already-exists" | "container-exists" | "does-not-exist" | "invalid-name" | "no-cloud-container" | "load-error" | "load-errors" | "resource-exists" | "too-large" | "write-error";
+    /** Determine whether an error object is a WorkspaceError */
+    function isError<T extends ITwinError>(error: unknown, key?: Key): error is T;
+    function throwError<T extends ITwinError>(key: Key, e: Omit<T, "name" | "iTwinErrorId">): never;
+}
+/** Errors originating from the [ChannelControl]($backend) interface.
+ * @beta
+ */
+export interface ChannelControlError extends ITwinError {
+    /** The channel key that caused the error. */
+    readonly channelKey: string;
+}
+/** @beta */
+export declare namespace ChannelControlError {
+    /** the ITwinError scope for `ChannelControlError`s. */
+    const scope = "itwin-ChannelControl";
+    /** Keys that identify `ChannelControlError`s */
+    type Key = 
+    /** an attempt to create a channel within an existing channel */
+    "may-not-nest" | 
+    /** an attempt to use a channel that was not "allowed" */
+    "not-allowed" | 
+    /** the root channel already exists */
+    "root-exists";
+    /** Instantiate and throw a ChannelControlError */
+    function throwError(key: Key, message: string, channelKey: string): never;
+    /** Determine whether an error object is a ChannelControlError */
+    function isError(error: unknown, key?: Key): error is ChannelControlError;
+}
+//# sourceMappingURL=ITwinCoreErrors.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ITwinCoreErrors.d.ts","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,YAAY;AACZ,yBAAiB,WAAW,CAAC;IACpB,MAAM,KAAK,iBAAiB,CAAC;IACpC,KAAY,GAAG,GACb,cAAc,GACd,sBAAsB,GACtB,2BAA2B,GAC3B,UAAU,CAAC;IAEb,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,WAAW,CAEvE;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK,CAE3E;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,wDAAwD;IACxD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,yBAAiB,gBAAgB,CAAC;IACzB,MAAM,KAAK,sBAAsB,CAAC;IACzC,KAAY,GAAG,GACb,mBAAmB,GACnB,YAAY,GACZ,cAAc,GACd,sBAAsB,GACtB,gBAAgB,GAChB,uBAAuB;IACvB;;OAEG;IACH,iBAAiB;IACjB,oFAAoF;IACpF,qBAAqB,CAAC;IAExB,qJAAqJ;IACrJ,UAAiB,aAAc,SAAQ,gBAAgB;QACrD,gBAAgB;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,yDAAyD;QACzD,QAAQ,EAAE,MAAM,CAAC;QACjB,4BAA4B;QAC5B,OAAO,EAAE,MAAM,CAAC;KACjB;IAED,8DAA8D;IAC9D,SAAgB,OAAO,CAAC,CAAC,SAAS,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEzF;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAAC,CAAC,SAAS,gBAAgB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAE3G;CACF;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,yDAAyD;IACzD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,YAAY;AACZ,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,eAAe,GACf,gBAAgB,GAChB,UAAU,GACV,WAAW,GACX,YAAY,GACZ,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEvF;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAAC,CAAC,SAAS,cAAc,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAEzG;CACF;AAED;;;GAGG;AACH,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,gBAAgB,GAChB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,oBAAoB,GACpB,YAAY,GACZ,aAAa,GACb,iBAAiB,GACjB,WAAW,GACX,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEnF;IAED,SAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAErG;CACF;AAGD;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD,6CAA6C;IAC7C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,YAAY;AACZ,yBAAiB,mBAAmB,CAAC;IACnC,uDAAuD;IAChD,MAAM,KAAK,yBAAyB,CAAC;IAE5C,gDAAgD;IAChD,KAAY,GAAG;IACb,gEAAgE;IAChE,cAAc;IACd,yDAAyD;IACzD,aAAa;IACb,sCAAsC;IACtC,aAAa,CAAC;IAEhB,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,KAAK,CAE/E;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,mBAAmB,CAE/E;CACF"}

package/lib/cjs/ITwinCoreErrors.js

@@ -0,0 +1,90 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChannelControlError = exports.WorkspaceError = exports.ViewStoreError = exports.CloudSqliteError = exports.SqliteError = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+/** @beta */
+var SqliteError;
+(function (SqliteError) {
+    SqliteError.scope = "itwin-Sqlite";
+    /** Determine whether an error object is a SqliteError */
+    function isError(error, key) {
+        return core_bentley_1.ITwinError.isError(error, SqliteError.scope, key) && typeof error.dbName === "string";
+    }
+    SqliteError.isError = isError;
+    /** Instantiate and throw a SqliteError */
+    function throwError(key, message, dbName) {
+        core_bentley_1.ITwinError.throwError({ iTwinErrorId: { scope: SqliteError.scope, key }, message, dbName });
+    }
+    SqliteError.throwError = throwError;
+})(SqliteError || (exports.SqliteError = SqliteError = {}));
+/** @beta */
+var CloudSqliteError;
+(function (CloudSqliteError) {
+    CloudSqliteError.scope = "itwin-CloudSqlite";
+    /** Determine whether an error object is a CloudSqliteError */
+    function isError(error, key) {
+        return core_bentley_1.ITwinError.isError(error, CloudSqliteError.scope, key);
+    }
+    CloudSqliteError.isError = isError;
+    /** Instantiate and throw a CloudSqliteError */
+    function throwError(key, e) {
+        core_bentley_1.ITwinError.throwError({ ...e, iTwinErrorId: { scope: CloudSqliteError.scope, key } });
+    }
+    CloudSqliteError.throwError = throwError;
+})(CloudSqliteError || (exports.CloudSqliteError = CloudSqliteError = {}));
+/** @beta */
+var ViewStoreError;
+(function (ViewStoreError) {
+    ViewStoreError.scope = "itwin-ViewStore";
+    /** Determine whether an error object is a ViewStoreError */
+    function isError(error, key) {
+        return core_bentley_1.ITwinError.isError(error, ViewStoreError.scope, key);
+    }
+    ViewStoreError.isError = isError;
+    /** Instantiate and throw a ViewStoreError */
+    function throwError(key, e) {
+        core_bentley_1.ITwinError.throwError({ ...e, iTwinErrorId: { scope: ViewStoreError.scope, key } });
+    }
+    ViewStoreError.throwError = throwError;
+})(ViewStoreError || (exports.ViewStoreError = ViewStoreError = {}));
+/**
+ * Errors thrown by the [Workspace]($backend) APIs.
+ * @beta
+ */
+var WorkspaceError;
+(function (WorkspaceError) {
+    WorkspaceError.scope = "itwin-Workspace";
+    /** Determine whether an error object is a WorkspaceError */
+    function isError(error, key) {
+        return core_bentley_1.ITwinError.isError(error, WorkspaceError.scope, key);
+    }
+    WorkspaceError.isError = isError;
+    function throwError(key, e) {
+        core_bentley_1.ITwinError.throwError({ ...e, iTwinErrorId: { key, scope: WorkspaceError.scope } });
+    }
+    WorkspaceError.throwError = throwError;
+})(WorkspaceError || (exports.WorkspaceError = WorkspaceError = {}));
+/** @beta */
+var ChannelControlError;
+(function (ChannelControlError) {
+    /** the ITwinError scope for `ChannelControlError`s. */
+    ChannelControlError.scope = "itwin-ChannelControl";
+    /** Instantiate and throw a ChannelControlError */
+    function throwError(key, message, channelKey) {
+        core_bentley_1.ITwinError.throwError({ iTwinErrorId: { scope: ChannelControlError.scope, key }, message, channelKey });
+    }
+    ChannelControlError.throwError = throwError;
+    /** Determine whether an error object is a ChannelControlError */
+    function isError(error, key) {
+        return core_bentley_1.ITwinError.isError(error, ChannelControlError.scope, key) && typeof error.channelKey === "string";
+    }
+    ChannelControlError.isError = isError;
+})(ChannelControlError || (exports.ChannelControlError = ChannelControlError = {}));
+//# sourceMappingURL=ITwinCoreErrors.js.map

package/lib/cjs/ITwinCoreErrors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITwinCoreErrors.js","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAiD;AAWjD,YAAY;AACZ,IAAiB,WAAW,CAiB3B;AAjBD,WAAiB,WAAW;IACb,iBAAK,GAAG,cAAc,CAAC;IAOpC,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAc,KAAK,EAAE,YAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC;IAChG,CAAC;IAFe,mBAAO,UAEtB,CAAA;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,MAAc;QAClE,yBAAU,CAAC,UAAU,CAAc,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,YAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IACxF,CAAC;IAFe,sBAAU,aAEzB,CAAA;AACH,CAAC,EAjBgB,WAAW,2BAAX,WAAW,QAiB3B;AAaD,YAAY;AACZ,IAAiB,gBAAgB,CAmChC;AAnCD,WAAiB,gBAAgB;IAClB,sBAAK,GAAG,mBAAmB,CAAC;IAyBzC,8DAA8D;IAC9D,SAAgB,OAAO,CAA6B,KAAc,EAAE,GAAS;QAC3E,OAAO,yBAAU,CAAC,OAAO,CAAI,KAAK,EAAE,iBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,wBAAO,UAEtB,CAAA;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAA6B,GAAQ,EAAE,CAAmC;QAClG,yBAAU,CAAC,UAAU,CAAmB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,iBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAClF,CAAC;IAFe,2BAAU,aAEzB,CAAA;AACH,CAAC,EAnCgB,gBAAgB,gCAAhB,gBAAgB,QAmChC;AAUD,YAAY;AACZ,IAAiB,cAAc,CAmB9B;AAnBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IASvC,4DAA4D;IAC5D,SAAgB,OAAO,CAA2B,KAAc,EAAE,GAAS;QACzE,OAAO,yBAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAA2B,GAAQ,EAAE,CAAmC;QAChG,yBAAU,CAAC,UAAU,CAAiB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAChF,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EAnBgB,cAAc,8BAAd,cAAc,QAmB9B;AAED;;;GAGG;AACH,IAAiB,cAAc,CAsB9B;AAtBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IAavC,4DAA4D;IAC5D,SAAgB,OAAO,CAAuB,KAAc,EAAE,GAAS;QACrE,OAAO,yBAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,SAAgB,UAAU,CAAuB,GAAQ,EAAE,CAAmC;QAC5F,yBAAU,CAAC,UAAU,CAAa,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EAtBgB,cAAc,8BAAd,cAAc,QAsB9B;AAWD,YAAY;AACZ,IAAiB,mBAAmB,CAqBnC;AArBD,WAAiB,mBAAmB;IAClC,uDAAuD;IAC1C,yBAAK,GAAG,sBAAsB,CAAC;IAW5C,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,UAAkB;QACtE,yBAAU,CAAC,UAAU,CAAsB,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,oBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IACpG,CAAC;IAFe,8BAAU,aAEzB,CAAA;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAsB,KAAK,EAAE,oBAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,UAAU,KAAK,QAAQ,CAAC;IAC5G,CAAC;IAFe,2BAAO,UAEtB,CAAA;AACH,CAAC,EArBgB,mBAAmB,mCAAnB,mBAAmB,QAqBnC","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 { ITwinError } from \"@itwin/core-bentley\";\r\n\r\n/**\r\n * An error originating from the [SQLiteDb]($backend) API.\r\n * @beta\r\n */\r\nexport interface SqliteError extends ITwinError {\r\n  /** The name of the database for this problem. */\r\n  dbName: string;\r\n}\r\n\r\n/** @beta */\r\nexport namespace SqliteError {\r\n  export const scope = \"itwin-Sqlite\";\r\n  export type Key =\r\n    \"already-open\" |\r\n    \"incompatible-version\" |\r\n    \"invalid-versions-property\" |\r\n    \"readonly\";\r\n\r\n  /** Determine whether an error object is a SqliteError */\r\n  export function isError(error: unknown, key?: Key): error is SqliteError {\r\n    return ITwinError.isError<SqliteError>(error, scope, key) && typeof error.dbName === \"string\";\r\n  }\r\n\r\n  /** Instantiate and throw a SqliteError */\r\n  export function throwError(key: Key, message: string, dbName: string): never {\r\n    ITwinError.throwError<SqliteError>({ iTwinErrorId: { scope, key }, message, dbName });\r\n  }\r\n}\r\n\r\n/**\r\n * An error originating from the [CloudSqlite]($backend) API.\r\n * @beta\r\n */\r\nexport interface CloudSqliteError extends ITwinError {\r\n  /** The name of the database that generated the error */\r\n  readonly dbName?: string;\r\n  /** The name of the container associated with the error */\r\n  readonly containerId?: string;\r\n}\r\n\r\n/** @beta */\r\nexport namespace CloudSqliteError {\r\n  export const scope = \"itwin-CloudSqlite\";\r\n  export type Key =\r\n    \"already-published\" |\r\n    \"copy-error\" |\r\n    \"invalid-name\" |\r\n    \"no-version-available\" |\r\n    \"not-a-function\" |\r\n    \"service-not-available\" |\r\n    /** The write lock cannot be acquired because it is currently held by somebody else.\r\n     * @see WriteLockHeld for details\r\n     */\r\n    \"write-lock-held\" |\r\n    /** The write lock on a container is not held, but is required for this operation */\r\n    \"write-lock-not-held\";\r\n\r\n  /** thrown when an attempt to acquire the write lock for a container fails because the lock is already held by somebody else (\"write-lock-held\").  */\r\n  export interface WriteLockHeld extends CloudSqliteError {\r\n    /** @internal */\r\n    errorNumber: number;\r\n    /** moniker of user currently holding container's lock */\r\n    lockedBy: string;\r\n    /** time the lock expires */\r\n    expires: string;\r\n  }\r\n\r\n  /** Determine whether an error object is a CloudSqliteError */\r\n  export function isError<T extends CloudSqliteError>(error: unknown, key?: Key): error is T {\r\n    return ITwinError.isError<T>(error, scope, key);\r\n  }\r\n\r\n  /** Instantiate and throw a CloudSqliteError */\r\n  export function throwError<T extends CloudSqliteError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\r\n    ITwinError.throwError<CloudSqliteError>({ ...e, iTwinErrorId: { scope, key } });\r\n  }\r\n}\r\n\r\n/** Errors thrown by the [ViewStore]($backend) API.\r\n * @beta\r\n */\r\nexport interface ViewStoreError extends ITwinError {\r\n  /** The name of the ViewStore that generated the error */\r\n  viewStoreName?: string;\r\n}\r\n\r\n/** @beta */\r\nexport namespace ViewStoreError {\r\n  export const scope = \"itwin-ViewStore\";\r\n  export type Key =\r\n    \"invalid-value\" |\r\n    \"invalid-member\" |\r\n    \"no-owner\" |\r\n    \"not-found\" |\r\n    \"not-unique\" |\r\n    \"group-error\";\r\n\r\n  /** Determine whether an error object is a ViewStoreError */\r\n  export function isError<T extends ViewStoreError>(error: unknown, key?: Key): error is T {\r\n    return ITwinError.isError<T>(error, scope, key);\r\n  }\r\n\r\n  /** Instantiate and throw a ViewStoreError */\r\n  export function throwError<T extends ViewStoreError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\r\n    ITwinError.throwError<ViewStoreError>({ ...e, iTwinErrorId: { scope, key } });\r\n  }\r\n}\r\n\r\n/**\r\n * Errors thrown by the [Workspace]($backend) APIs.\r\n * @beta\r\n */\r\nexport namespace WorkspaceError {\r\n  export const scope = \"itwin-Workspace\";\r\n  export type Key =\r\n    \"already-exists\" |\r\n    \"container-exists\" |\r\n    \"does-not-exist\" |\r\n    \"invalid-name\" |\r\n    \"no-cloud-container\" |\r\n    \"load-error\" |\r\n    \"load-errors\" |\r\n    \"resource-exists\" |\r\n    \"too-large\" |\r\n    \"write-error\";\r\n\r\n  /** Determine whether an error object is a WorkspaceError */\r\n  export function isError<T extends ITwinError>(error: unknown, key?: Key): error is T {\r\n    return ITwinError.isError<T>(error, scope, key);\r\n  }\r\n\r\n  export function throwError<T extends ITwinError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\r\n    ITwinError.throwError<ITwinError>({ ...e, iTwinErrorId: { key, scope } });\r\n  }\r\n}\r\n\r\n\r\n/** Errors originating from the [ChannelControl]($backend) interface.\r\n * @beta\r\n */\r\nexport interface ChannelControlError extends ITwinError {\r\n  /** The channel key that caused the error. */\r\n  readonly channelKey: string;\r\n}\r\n\r\n/** @beta */\r\nexport namespace ChannelControlError {\r\n  /** the ITwinError scope for `ChannelControlError`s. */\r\n  export const scope = \"itwin-ChannelControl\";\r\n\r\n  /** Keys that identify `ChannelControlError`s */\r\n  export type Key =\r\n    /** an attempt to create a channel within an existing channel */\r\n    \"may-not-nest\" |\r\n    /** an attempt to use a channel that was not \"allowed\" */\r\n    \"not-allowed\" |\r\n    /** the root channel already exists */\r\n    \"root-exists\";\r\n\r\n  /** Instantiate and throw a ChannelControlError */\r\n  export function throwError(key: Key, message: string, channelKey: string): never {\r\n    ITwinError.throwError<ChannelControlError>({ iTwinErrorId: { scope, key }, message, channelKey });\r\n  }\r\n  /** Determine whether an error object is a ChannelControlError */\r\n  export function isError(error: unknown, key?: Key): error is ChannelControlError {\r\n    return ITwinError.isError<ChannelControlError>(error, scope, key) && typeof error.channelKey === \"string\";\r\n  }\r\n}\r\n"]}

package/lib/cjs/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/cjs/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/cjs/Image.js

@@ -11,6 +11,7 @@ exports.ImageSource = exports.ImageSourceFormat = exports.ImageBuffer = exports.
 exports.isPowerOfTwo = isPowerOfTwo;
 exports.nextHighestPowerOfTwo = nextHighestPowerOfTwo;
 exports.isValidImageSourceFormat = isValidImageSourceFormat;
+exports.isBinaryImageSource = isBinaryImageSource;
 /** Format of an [[ImageBuffer]].
  * The format determines how many bytes are allocated for each pixel in the buffer and the semantics of each byte.
  * @see [[ImageBuffer.getNumBytesPerPixel]]
@@ -30,6 +31,12 @@ var ImageBufferFormat;
  * @public
  */
 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. */
@@ -55,16 +62,13 @@ 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;
@@ -104,7 +108,9 @@ var ImageSourceFormat;
      */
     ImageSourceFormat[ImageSourceFormat["Svg"] = 3] = "Svg";
 })(ImageSourceFormat || (exports.ImageSourceFormat = ImageSourceFormat = {}));
-/** @internal */
+/** Returns true if the numeric `format` value is a valid member of the [[ImageSourceFormat]] enumeration.
+ * @public
+ */
 function isValidImageSourceFormat(format) {
     switch (format) {
         case ImageSourceFormat.Jpeg:
@@ -119,6 +125,10 @@ function isValidImageSourceFormat(format) {
  * @public
  */
 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;
@@ -126,4 +136,10 @@ class ImageSource {
     }
 }
 exports.ImageSource = ImageSource;
+/** Returns true if `source` is a [[BinaryImageSource]].
+ * @public
+ */
+function isBinaryImageSource(source) {
+    return source.format !== ImageSourceFormat.Svg && source.data instanceof Uint8Array;
+}
 //# sourceMappingURL=Image.js.map

package/lib/cjs/Image.js.map

@@ -1 +1 @@
-{"version":3,"file":"Image.js","sourceRoot":"","sources":["../../src/Image.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAiFH,oCAEC;AAMD,sDAMC;AAkBD,4DASC;AAxHD;;;;;GAKG;AACH,IAAY,iBAOX;AAPD,WAAY,iBAAiB;IAC3B,uCAAuC;IACvC,yDAAQ,CAAA;IACR,sCAAsC;IACtC,uDAAO,CAAA;IACP,wBAAwB;IACxB,2DAAS,CAAA;AACX,CAAC,EAPW,iBAAiB,iCAAjB,iBAAiB,QAO5B;AAED;;GAEG;AACH,MAAa,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;AAvDD,kCAuDC;AAED;;;GAGG;AACH,SAAgB,YAAY,CAAC,GAAW;IACtC,OAAO,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,SAAgB,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,IAAY,iBASX;AATD,WAAY,iBAAiB;IAC3B,kDAAkD;IAClD,yDAAQ,CAAA;IACR,iDAAiD;IACjD,uDAAO,CAAA;IACP;;OAEG;IACH,uDAAO,CAAA;AACT,CAAC,EATW,iBAAiB,iCAAjB,iBAAiB,QAS5B;AAED,gBAAgB;AAChB,SAAgB,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,MAAa,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;AAXD,kCAWC","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;;;AA8EH,oCAEC;AAMD,sDAMC;AAoBD,4DASC;AAiCD,kDAEC;AA1JD;;;;;GAKG;AACH,IAAY,iBAOX;AAPD,WAAY,iBAAiB;IAC3B,uCAAuC;IACvC,yDAAQ,CAAA;IACR,sCAAsC;IACtC,uDAAO,CAAA;IACP,wBAAwB;IACxB,2DAAS,CAAA;AACX,CAAC,EAPW,iBAAiB,iCAAjB,iBAAiB,QAO5B;AAED;;GAEG;AACH,MAAa,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;AApDD,kCAoDC;AAED;;;GAGG;AACH,SAAgB,YAAY,CAAC,GAAW;IACtC,OAAO,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,SAAgB,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,IAAY,iBASX;AATD,WAAY,iBAAiB;IAC3B,kDAAkD;IAClD,yDAAQ,CAAA;IACR,iDAAiD;IACjD,uDAAO,CAAA;IACP;;OAEG;IACH,uDAAO,CAAA;AACT,CAAC,EATW,iBAAiB,iCAAjB,iBAAiB,QAS5B;AAED;;GAEG;AACH,SAAgB,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,MAAa,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;AAXD,kCAWC;AAcD;;GAEG;AACH,SAAgB,mBAAmB,CAAC,MAAmB;IACrD,OAAO,MAAM,CAAC,MAAM,KAAK,iBAAiB,CAAC,GAAG,IAAI,MAAM,CAAC,IAAI,YAAY,UAAU,CAAC;AACtF,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 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  private 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  private static computeHeight(data: Uint8Array, format: ImageBufferFormat, width: number): number {\r\n    return data.length / (width * this.getNumBytesPerPixel(format));\r\n  }\r\n\r\n  private 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/** Returns true if the numeric `format` value is a valid member of the [[ImageSourceFormat]] enumeration.\r\n * @public\r\n */\r\nexport function isValidImageSourceFormat(format: number): format is ImageSourceFormat {\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\r\n/** An [[ImageSource]] encoded in binary form as a Jpeg or Png, as opposed to one encoded\r\n * in string format as an Svg.\r\n * Only binary ImageSources can be used for [[Texture]]s stored in [[IModelDb]]s.\r\n * @public\r\n */\r\nexport interface BinaryImageSource {\r\n  /** The format in which the [[data]] is encoded. */\r\n  readonly format: ImageSourceFormat.Jpeg | ImageSourceFormat.Png;\r\n  /** The image data encoded according to [[format]]. */\r\n  readonly data: Uint8Array;\r\n}\r\n\r\n/** Returns true if `source` is a [[BinaryImageSource]].\r\n * @public\r\n */\r\nexport function isBinaryImageSource(source: ImageSource): source is BinaryImageSource {\r\n  return source.format !== ImageSourceFormat.Svg && source.data instanceof Uint8Array;\r\n}\r\n"]}

package/lib/cjs/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/cjs/IpcAppProps.d.ts.map

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

package/lib/cjs/IpcAppProps.js.map

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

package/lib/cjs/LightSettings.js

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