@itwin/core-common 3.4.0-dev.50 → 3.4.0-dev.55

package/lib/cjs/BriefcaseTypes.js

@@ -1,96 +1,96 @@
-"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.SchemaState = exports.ProfileOptions = exports.DomainOptions = exports.SyncMode = exports.BriefcaseIdValue = void 0;
-/** Values of [[BriefcaseId]] that have special meaning.
- * @public
- * @extensions
- */
-var BriefcaseIdValue;
-(function (BriefcaseIdValue) {
-    /** Indicates an invalid/illegal BriefcaseId */
-    BriefcaseIdValue[BriefcaseIdValue["Illegal"] = 4294967295] = "Illegal";
-    /** BriefcaseIds must be less than this value */
-    BriefcaseIdValue[BriefcaseIdValue["Max"] = 16777216] = "Max";
-    /** All valid iModelHub issued BriefcaseIds will be equal or higher than this */
-    BriefcaseIdValue[BriefcaseIdValue["FirstValid"] = 2] = "FirstValid";
-    /** All valid iModelHub issued BriefcaseIds will be equal or lower than this */
-    BriefcaseIdValue[BriefcaseIdValue["LastValid"] = 16777205] = "LastValid";
-    /**
-     * The briefcase has not been assigned a unique Id by iModelHub. Only briefcases that have been assigned a unique BriefcaseId may create changesets,
-     * because BriefcaseId is used to create unique ElementIds for new elements.
-     *
-     * The `Unassigned` briefcaseId is used for several purposes:
-     *  - **Snapshots**. Snapshot files are immutable copies of an iModel for archival or data exchange purposes. They can neither generate nor accept new changesets.
-     *  - **Checkpoints**. Checkpoints are Snapshots that represent a specific version on an iModel's timeline.
-     *  - **PullOnly**. A local briefcase file that may be used to "slide" along a timeline by applying incoming changesets.
-     * They are always opened readonly except to apply changesets.
-     *  - **Standalone**. Standalone iModels are local files that are not connected to iModelHub, and therefore cannot accept or create changesets.
-     */
-    BriefcaseIdValue[BriefcaseIdValue["Unassigned"] = 0] = "Unassigned";
-})(BriefcaseIdValue = exports.BriefcaseIdValue || (exports.BriefcaseIdValue = {}));
-/** Whether a briefcase is editable or may only accept incoming changesets from iModelHub
- * @public
- * @extensions
- */
-var SyncMode;
-(function (SyncMode) {
-    /** Use a fixed version (i.e. a checkpoint). See [CheckpointManager]($backend) for preferred approach to using checkpoint files. */
-    SyncMode[SyncMode["FixedVersion"] = 1] = "FixedVersion";
-    /** A briefcase that can be edited. A unique briefcaseId must be assigned by iModelHub. */
-    SyncMode[SyncMode["PullAndPush"] = 2] = "PullAndPush";
-    /** use [BriefcaseIdValue.Unassigned](%backend). This makes a briefcase that can accept changesets from iModelHub but can never create changesets. */
-    SyncMode[SyncMode["PullOnly"] = 3] = "PullOnly";
-})(SyncMode = exports.SyncMode || (exports.SyncMode = {}));
-/** Option to control the validation and upgrade of domain schemas in the Db
- * @beta
- */
-var DomainOptions;
-(function (DomainOptions) {
-    /** Domain schemas will be validated for any required upgrades. Any errors will be reported back, and cause the application to fail opening the Db */
-    DomainOptions[DomainOptions["CheckRequiredUpgrades"] = 0] = "CheckRequiredUpgrades";
-    /** Domain schemas will be validated for any required or optional upgrades. Any errors will be reported back, and cause the application to fail opening the Db */
-    DomainOptions[DomainOptions["CheckRecommendedUpgrades"] = 1] = "CheckRecommendedUpgrades";
-    /** Domain schemas will be upgraded if necessary. However, only compatible schema upgrades will be allowed - these are typically additions of classes, properties, and changes to custom attributes */
-    DomainOptions[DomainOptions["Upgrade"] = 2] = "Upgrade";
-    /** Domain schemas will neither be validated nor be upgraded. Used only internally */
-    DomainOptions[DomainOptions["SkipCheck"] = 3] = "SkipCheck";
-})(DomainOptions = exports.DomainOptions || (exports.DomainOptions = {}));
-/** Options that control whether a profile upgrade should be performed when opening a Db
- * @beta
- */
-var ProfileOptions;
-(function (ProfileOptions) {
-    /** No profile upgrade will be performed. If a profile upgrade was required, opening the file will fail */
-    ProfileOptions[ProfileOptions["None"] = 0] = "None";
-    /** Profile upgrade will be performed if necessary */
-    ProfileOptions[ProfileOptions["Upgrade"] = 1] = "Upgrade";
-})(ProfileOptions = exports.ProfileOptions || (exports.ProfileOptions = {}));
-/**
- * The state of the schemas in the Db compared with what the current version of the software expects
- * Note: The state may vary depending on whether the Db is to be opened ReadOnly or ReadWrite.
- * @beta
- */
-var SchemaState;
-(function (SchemaState) {
-    /** The schemas in the Db are up-to-date, and do not need to be upgraded before opening it with the current version of the software */
-    SchemaState[SchemaState["UpToDate"] = 0] = "UpToDate";
-    /** It's required that the schemas in the Db be upgraded before it can be opened with the current version of the software.
-     * This may happen in read-write scenarios where the application requires a newer version of the schemas to be in place before
-     * it can write data based on that new schema.
-     */
-    SchemaState[SchemaState["UpgradeRequired"] = 1] = "UpgradeRequired";
-    /** It's recommended, but not necessary that the schemas in the Db be upgraded before opening it with the current version of the software */
-    SchemaState[SchemaState["UpgradeRecommended"] = 2] = "UpgradeRecommended";
-    /** The schemas in the Db are too old to be opened by the current version of the software. Upgrade using the API is not possible. */
-    SchemaState[SchemaState["TooOld"] = 3] = "TooOld";
-    /** The schemas in the Db are too new to be opened by the current version of the software */
-    SchemaState[SchemaState["TooNew"] = 4] = "TooNew";
-})(SchemaState = exports.SchemaState || (exports.SchemaState = {}));
+"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.SchemaState = exports.ProfileOptions = exports.DomainOptions = exports.SyncMode = exports.BriefcaseIdValue = void 0;
+/** Values of [[BriefcaseId]] that have special meaning.
+ * @public
+ * @extensions
+ */
+var BriefcaseIdValue;
+(function (BriefcaseIdValue) {
+    /** Indicates an invalid/illegal BriefcaseId */
+    BriefcaseIdValue[BriefcaseIdValue["Illegal"] = 4294967295] = "Illegal";
+    /** BriefcaseIds must be less than this value */
+    BriefcaseIdValue[BriefcaseIdValue["Max"] = 16777216] = "Max";
+    /** All valid iModelHub issued BriefcaseIds will be equal or higher than this */
+    BriefcaseIdValue[BriefcaseIdValue["FirstValid"] = 2] = "FirstValid";
+    /** All valid iModelHub issued BriefcaseIds will be equal or lower than this */
+    BriefcaseIdValue[BriefcaseIdValue["LastValid"] = 16777205] = "LastValid";
+    /**
+     * The briefcase has not been assigned a unique Id by iModelHub. Only briefcases that have been assigned a unique BriefcaseId may create changesets,
+     * because BriefcaseId is used to create unique ElementIds for new elements.
+     *
+     * The `Unassigned` briefcaseId is used for several purposes:
+     *  - **Snapshots**. Snapshot files are immutable copies of an iModel for archival or data exchange purposes. They can neither generate nor accept new changesets.
+     *  - **Checkpoints**. Checkpoints are Snapshots that represent a specific version on an iModel's timeline.
+     *  - **PullOnly**. A local briefcase file that may be used to "slide" along a timeline by applying incoming changesets.
+     * They are always opened readonly except to apply changesets.
+     *  - **Standalone**. Standalone iModels are local files that are not connected to iModelHub, and therefore cannot accept or create changesets.
+     */
+    BriefcaseIdValue[BriefcaseIdValue["Unassigned"] = 0] = "Unassigned";
+})(BriefcaseIdValue = exports.BriefcaseIdValue || (exports.BriefcaseIdValue = {}));
+/** Whether a briefcase is editable or may only accept incoming changesets from iModelHub
+ * @public
+ * @extensions
+ */
+var SyncMode;
+(function (SyncMode) {
+    /** Use a fixed version (i.e. a checkpoint). See [CheckpointManager]($backend) for preferred approach to using checkpoint files. */
+    SyncMode[SyncMode["FixedVersion"] = 1] = "FixedVersion";
+    /** A briefcase that can be edited. A unique briefcaseId must be assigned by iModelHub. */
+    SyncMode[SyncMode["PullAndPush"] = 2] = "PullAndPush";
+    /** use [BriefcaseIdValue.Unassigned](%backend). This makes a briefcase that can accept changesets from iModelHub but can never create changesets. */
+    SyncMode[SyncMode["PullOnly"] = 3] = "PullOnly";
+})(SyncMode = exports.SyncMode || (exports.SyncMode = {}));
+/** Option to control the validation and upgrade of domain schemas in the Db
+ * @beta
+ */
+var DomainOptions;
+(function (DomainOptions) {
+    /** Domain schemas will be validated for any required upgrades. Any errors will be reported back, and cause the application to fail opening the Db */
+    DomainOptions[DomainOptions["CheckRequiredUpgrades"] = 0] = "CheckRequiredUpgrades";
+    /** Domain schemas will be validated for any required or optional upgrades. Any errors will be reported back, and cause the application to fail opening the Db */
+    DomainOptions[DomainOptions["CheckRecommendedUpgrades"] = 1] = "CheckRecommendedUpgrades";
+    /** Domain schemas will be upgraded if necessary. However, only compatible schema upgrades will be allowed - these are typically additions of classes, properties, and changes to custom attributes */
+    DomainOptions[DomainOptions["Upgrade"] = 2] = "Upgrade";
+    /** Domain schemas will neither be validated nor be upgraded. Used only internally */
+    DomainOptions[DomainOptions["SkipCheck"] = 3] = "SkipCheck";
+})(DomainOptions = exports.DomainOptions || (exports.DomainOptions = {}));
+/** Options that control whether a profile upgrade should be performed when opening a Db
+ * @beta
+ */
+var ProfileOptions;
+(function (ProfileOptions) {
+    /** No profile upgrade will be performed. If a profile upgrade was required, opening the file will fail */
+    ProfileOptions[ProfileOptions["None"] = 0] = "None";
+    /** Profile upgrade will be performed if necessary */
+    ProfileOptions[ProfileOptions["Upgrade"] = 1] = "Upgrade";
+})(ProfileOptions = exports.ProfileOptions || (exports.ProfileOptions = {}));
+/**
+ * The state of the schemas in the Db compared with what the current version of the software expects
+ * Note: The state may vary depending on whether the Db is to be opened ReadOnly or ReadWrite.
+ * @beta
+ */
+var SchemaState;
+(function (SchemaState) {
+    /** The schemas in the Db are up-to-date, and do not need to be upgraded before opening it with the current version of the software */
+    SchemaState[SchemaState["UpToDate"] = 0] = "UpToDate";
+    /** It's required that the schemas in the Db be upgraded before it can be opened with the current version of the software.
+     * This may happen in read-write scenarios where the application requires a newer version of the schemas to be in place before
+     * it can write data based on that new schema.
+     */
+    SchemaState[SchemaState["UpgradeRequired"] = 1] = "UpgradeRequired";
+    /** It's recommended, but not necessary that the schemas in the Db be upgraded before opening it with the current version of the software */
+    SchemaState[SchemaState["UpgradeRecommended"] = 2] = "UpgradeRecommended";
+    /** The schemas in the Db are too old to be opened by the current version of the software. Upgrade using the API is not possible. */
+    SchemaState[SchemaState["TooOld"] = 3] = "TooOld";
+    /** The schemas in the Db are too new to be opened by the current version of the software */
+    SchemaState[SchemaState["TooNew"] = 4] = "TooNew";
+})(SchemaState = exports.SchemaState || (exports.SchemaState = {}));
 //# sourceMappingURL=BriefcaseTypes.js.map

package/lib/cjs/BriefcaseTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"BriefcaseTypes.js","sourceRoot":"","sources":["../../src/BriefcaseTypes.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAaH;;;GAGG;AACH,IAAY,gBAyBX;AAzBD,WAAY,gBAAgB;IAC1B,+CAA+C;IAC/C,sEAAoB,CAAA;IAEpB,gDAAgD;IAChD,4DAAa,CAAA;IAEb,gFAAgF;IAChF,mEAAc,CAAA;IAEd,+EAA+E;IAC/E,wEAAqC,CAAA;IAErC;;;;;;;;;;OAUG;IACH,mEAAc,CAAA;AAChB,CAAC,EAzBW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAyB3B;AAED;;;GAGG;AACH,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,mIAAmI;IACnI,uDAAgB,CAAA;IAChB,0FAA0F;IAC1F,qDAAe,CAAA;IACf,qJAAqJ;IACrJ,+CAAY,CAAA;AACd,CAAC,EAPW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB;AA6GD;;GAEG;AACH,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,qJAAqJ;IACrJ,mFAAyB,CAAA;IAEzB,iKAAiK;IACjK,yFAA4B,CAAA;IAE5B,sMAAsM;IACtM,uDAAW,CAAA;IAEX,qFAAqF;IACrF,2DAAa,CAAA;AACf,CAAC,EAZW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAYxB;AAED;;GAEG;AACH,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,0GAA0G;IAC1G,mDAAQ,CAAA;IAER,qDAAqD;IACrD,yDAAW,CAAA;AACb,CAAC,EANW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAMzB;AAaD;;;;GAIG;AACH,IAAY,WAkBX;AAlBD,WAAY,WAAW;IACrB,sIAAsI;IACtI,qDAAQ,CAAA;IAER;;;OAGG;IACH,mEAAe,CAAA;IAEf,4IAA4I;IAC5I,yEAAkB,CAAA;IAElB,oIAAoI;IACpI,iDAAM,CAAA;IAEN,4FAA4F;IAC5F,iDAAM,CAAA;AACR,CAAC,EAlBW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAkBtB","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 { GuidString } from \"@itwin/core-bentley\";\r\nimport { ChangesetIdWithIndex, LocalFileName } from \"./ChangesetProps\";\r\nimport { IModelEncryptionProps, OpenDbKey } from \"./IModel\";\r\nimport { IModelVersionProps } from \"./IModelVersion\";\r\n\r\n/** The Id assigned to a briefcase by iModelHub, or [[BriefcaseIdValue.Unassigned]] .\r\n * @public\r\n * @extensions\r\n */\r\nexport type BriefcaseId = number;\r\n\r\n/** Values of [[BriefcaseId]] that have special meaning.\r\n * @public\r\n * @extensions\r\n */\r\nexport enum BriefcaseIdValue {\r\n  /** Indicates an invalid/illegal BriefcaseId */\r\n  Illegal = 0xffffffff,\r\n\r\n  /** BriefcaseIds must be less than this value */\r\n  Max = 1 << 24,\r\n\r\n  /** All valid iModelHub issued BriefcaseIds will be equal or higher than this */\r\n  FirstValid = 2,\r\n\r\n  /** All valid iModelHub issued BriefcaseIds will be equal or lower than this */\r\n  LastValid = BriefcaseIdValue.Max - 11,\r\n\r\n  /**\r\n   * The briefcase has not been assigned a unique Id by iModelHub. Only briefcases that have been assigned a unique BriefcaseId may create changesets,\r\n   * because BriefcaseId is used to create unique ElementIds for new elements.\r\n   *\r\n   * The `Unassigned` briefcaseId is used for several purposes:\r\n   *  - **Snapshots**. Snapshot files are immutable copies of an iModel for archival or data exchange purposes. They can neither generate nor accept new changesets.\r\n   *  - **Checkpoints**. Checkpoints are Snapshots that represent a specific version on an iModel's timeline.\r\n   *  - **PullOnly**. A local briefcase file that may be used to \"slide\" along a timeline by applying incoming changesets.\r\n   * They are always opened readonly except to apply changesets.\r\n   *  - **Standalone**. Standalone iModels are local files that are not connected to iModelHub, and therefore cannot accept or create changesets.\r\n   */\r\n  Unassigned = 0,\r\n}\r\n\r\n/** Whether a briefcase is editable or may only accept incoming changesets from iModelHub\r\n * @public\r\n * @extensions\r\n */\r\nexport enum SyncMode {\r\n  /** Use a fixed version (i.e. a checkpoint). See [CheckpointManager]($backend) for preferred approach to using checkpoint files. */\r\n  FixedVersion = 1,\r\n  /** A briefcase that can be edited. A unique briefcaseId must be assigned by iModelHub. */\r\n  PullAndPush = 2,\r\n  /** use [BriefcaseIdValue.Unassigned](%backend). This makes a briefcase that can accept changesets from iModelHub but can never create changesets. */\r\n  PullOnly = 3,\r\n}\r\n\r\n/**\r\n * Options to open a previously downloaded briefcase\r\n * @public\r\n */\r\nexport interface OpenBriefcaseOptions {\r\n  /** open briefcase Readonly */\r\n  readonly openAsReadOnly?: boolean;\r\n}\r\n\r\n/**\r\n * Properties that specify a briefcase within the local briefcase cache.\r\n * @see BriefcaseManager.getFileName\r\n * @public\r\n */\r\nexport interface BriefcaseProps {\r\n  /** Id of the iModel */\r\n  readonly iModelId: GuidString;\r\n\r\n  /** BriefcaseId of the briefcase */\r\n  readonly briefcaseId: BriefcaseId;\r\n}\r\n\r\n/** Properties for opening a local briefcase file via [BriefcaseDb.open]($backend)\r\n * @public\r\n */\r\nexport interface OpenBriefcaseProps extends IModelEncryptionProps, OpenDbKey { // eslint-disable-line deprecation/deprecation\r\n  /** the full path to the briefcase file  */\r\n  readonly fileName: LocalFileName;\r\n  /** If true, open the briefcase readonly */\r\n  readonly readonly?: boolean;\r\n}\r\n\r\n/** Properties of a local briefcase file, returned by [BriefcaseManager.getCachedBriefcases]($backend) and [BriefcaseManager.downloadBriefcase]($backend)\r\n * @public\r\n * @extensions\r\n */\r\nexport interface LocalBriefcaseProps {\r\n  /** Full path of local file. */\r\n  readonly fileName: LocalFileName;\r\n\r\n  /** The iTwin containing the iModel. */\r\n  readonly iTwinId: GuidString;\r\n\r\n  /** The iModelId. */\r\n  readonly iModelId: GuidString;\r\n\r\n  /** The briefcaseId. */\r\n  readonly briefcaseId: BriefcaseId;\r\n\r\n  /** The current changesetId.\r\n   * @note ChangeSet Ids are string hash values based on the ChangeSet's content and parent.\r\n   */\r\n  readonly changeset: ChangesetIdWithIndex;\r\n\r\n  /** Size of the briefcase file in bytes  */\r\n  readonly fileSize: number;\r\n}\r\n\r\n/** Properties for downloading a briefcase to a local file, from iModelHub.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface RequestNewBriefcaseProps {\r\n  /** iTwin that the iModel belongs to. */\r\n  readonly iTwinId: GuidString;\r\n\r\n  /** The iModelId for the new briefcase. */\r\n  readonly iModelId: GuidString;\r\n\r\n  /** Full path of local file to store the briefcase. If undefined, a file will be created in the briefcase cache, and this member will be filled with the full path to the file.\r\n   * Callers can use this to open the briefcase after the download completes.\r\n   * @note this member is both an input and an output.\r\n   */\r\n  readonly fileName?: LocalFileName;\r\n\r\n  /**\r\n   * The BriefcaseId for the new briefcase. If undefined, a new BriefcaseId will be acquired from iModelHub before the download, and is returned in this member.\r\n   * @note To download a briefcase that can accept but not create new changesets (sometimes referred to as \"pull only\" briefcases), set this value to [[BriefcaseIdValue.Unassigned]].\r\n   * After downloading, you can merely delete unassigned briefcase files when they are no longer needed. Assigned BriefcaseIds should be released (via [BriefcaseManager.releaseBriefcase]($backend) )\r\n   * when you are done with them.\r\n   * @note this member is both an input and an output.\r\n   *\r\n   */\r\n  briefcaseId?: BriefcaseId;\r\n\r\n  /** Id of the change set of the new briefcase. If undefined, use latest. */\r\n  asOf?: IModelVersionProps;\r\n}\r\n\r\n/**\r\n * Manages the download of a briefcase\r\n * @public\r\n */\r\nexport interface BriefcaseDownloader {\r\n  /** Id of the briefcase being downloaded */\r\n  readonly briefcaseId: BriefcaseId;\r\n\r\n  /** the name of the local file for the briefcase */\r\n  readonly fileName: LocalFileName;\r\n\r\n  /** Promise that resolves when the download completes. await this to complete the download */\r\n  readonly downloadPromise: Promise<void>;\r\n\r\n  /** Request cancellation of the download */\r\n  readonly requestCancel: () => Promise<boolean>;\r\n}\r\n\r\n/** Option to control the validation and upgrade of domain schemas in the Db\r\n * @beta\r\n */\r\nexport enum DomainOptions {\r\n  /** Domain schemas will be validated for any required upgrades. Any errors will be reported back, and cause the application to fail opening the Db */\r\n  CheckRequiredUpgrades = 0,\r\n\r\n  /** Domain schemas will be validated for any required or optional upgrades. Any errors will be reported back, and cause the application to fail opening the Db */\r\n  CheckRecommendedUpgrades = 1,\r\n\r\n  /** Domain schemas will be upgraded if necessary. However, only compatible schema upgrades will be allowed - these are typically additions of classes, properties, and changes to custom attributes */\r\n  Upgrade = 2,\r\n\r\n  /** Domain schemas will neither be validated nor be upgraded. Used only internally */\r\n  SkipCheck = 3,\r\n}\r\n\r\n/** Options that control whether a profile upgrade should be performed when opening a Db\r\n * @beta\r\n */\r\nexport enum ProfileOptions {\r\n  /** No profile upgrade will be performed. If a profile upgrade was required, opening the file will fail */\r\n  None = 0,\r\n\r\n  /** Profile upgrade will be performed if necessary */\r\n  Upgrade = 1,\r\n}\r\n\r\n/** Arguments to validate and update the profile and domain schemas when opening a Db\r\n * @beta\r\n */\r\nexport interface UpgradeOptions {\r\n  /** Option to control the validation and upgrade of domain schemas in the Db */\r\n  readonly domain?: DomainOptions;\r\n\r\n  /** Options that control whether a profile upgrade should be performed when opening a file */\r\n  readonly profile?: ProfileOptions;\r\n}\r\n\r\n/**\r\n * The state of the schemas in the Db compared with what the current version of the software expects\r\n * Note: The state may vary depending on whether the Db is to be opened ReadOnly or ReadWrite.\r\n * @beta\r\n */\r\nexport enum SchemaState {\r\n  /** The schemas in the Db are up-to-date, and do not need to be upgraded before opening it with the current version of the software */\r\n  UpToDate,\r\n\r\n  /** It's required that the schemas in the Db be upgraded before it can be opened with the current version of the software.\r\n   * This may happen in read-write scenarios where the application requires a newer version of the schemas to be in place before\r\n   * it can write data based on that new schema.\r\n   */\r\n  UpgradeRequired,\r\n\r\n  /** It's recommended, but not necessary that the schemas in the Db be upgraded before opening it with the current version of the software */\r\n  UpgradeRecommended,\r\n\r\n  /** The schemas in the Db are too old to be opened by the current version of the software. Upgrade using the API is not possible. */\r\n  TooOld,\r\n\r\n  /** The schemas in the Db are too new to be opened by the current version of the software */\r\n  TooNew,\r\n}\r\n"]}
+{"version":3,"file":"BriefcaseTypes.js","sourceRoot":"","sources":["../../src/BriefcaseTypes.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAaH;;;GAGG;AACH,IAAY,gBAyBX;AAzBD,WAAY,gBAAgB;IAC1B,+CAA+C;IAC/C,sEAAoB,CAAA;IAEpB,gDAAgD;IAChD,4DAAa,CAAA;IAEb,gFAAgF;IAChF,mEAAc,CAAA;IAEd,+EAA+E;IAC/E,wEAAqC,CAAA;IAErC;;;;;;;;;;OAUG;IACH,mEAAc,CAAA;AAChB,CAAC,EAzBW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAyB3B;AAED;;;GAGG;AACH,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,mIAAmI;IACnI,uDAAgB,CAAA;IAChB,0FAA0F;IAC1F,qDAAe,CAAA;IACf,qJAAqJ;IACrJ,+CAAY,CAAA;AACd,CAAC,EAPW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB;AA6GD;;GAEG;AACH,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,qJAAqJ;IACrJ,mFAAyB,CAAA;IAEzB,iKAAiK;IACjK,yFAA4B,CAAA;IAE5B,sMAAsM;IACtM,uDAAW,CAAA;IAEX,qFAAqF;IACrF,2DAAa,CAAA;AACf,CAAC,EAZW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAYxB;AAED;;GAEG;AACH,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,0GAA0G;IAC1G,mDAAQ,CAAA;IAER,qDAAqD;IACrD,yDAAW,CAAA;AACb,CAAC,EANW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAMzB;AAaD;;;;GAIG;AACH,IAAY,WAkBX;AAlBD,WAAY,WAAW;IACrB,sIAAsI;IACtI,qDAAQ,CAAA;IAER;;;OAGG;IACH,mEAAe,CAAA;IAEf,4IAA4I;IAC5I,yEAAkB,CAAA;IAElB,oIAAoI;IACpI,iDAAM,CAAA;IAEN,4FAA4F;IAC5F,iDAAM,CAAA;AACR,CAAC,EAlBW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAkBtB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport { GuidString } from \"@itwin/core-bentley\";\nimport { ChangesetIdWithIndex, LocalFileName } from \"./ChangesetProps\";\nimport { IModelEncryptionProps, OpenDbKey } from \"./IModel\";\nimport { IModelVersionProps } from \"./IModelVersion\";\n\n/** The Id assigned to a briefcase by iModelHub, or [[BriefcaseIdValue.Unassigned]] .\n * @public\n * @extensions\n */\nexport type BriefcaseId = number;\n\n/** Values of [[BriefcaseId]] that have special meaning.\n * @public\n * @extensions\n */\nexport enum BriefcaseIdValue {\n  /** Indicates an invalid/illegal BriefcaseId */\n  Illegal = 0xffffffff,\n\n  /** BriefcaseIds must be less than this value */\n  Max = 1 << 24,\n\n  /** All valid iModelHub issued BriefcaseIds will be equal or higher than this */\n  FirstValid = 2,\n\n  /** All valid iModelHub issued BriefcaseIds will be equal or lower than this */\n  LastValid = BriefcaseIdValue.Max - 11,\n\n  /**\n   * The briefcase has not been assigned a unique Id by iModelHub. Only briefcases that have been assigned a unique BriefcaseId may create changesets,\n   * because BriefcaseId is used to create unique ElementIds for new elements.\n   *\n   * The `Unassigned` briefcaseId is used for several purposes:\n   *  - **Snapshots**. Snapshot files are immutable copies of an iModel for archival or data exchange purposes. They can neither generate nor accept new changesets.\n   *  - **Checkpoints**. Checkpoints are Snapshots that represent a specific version on an iModel's timeline.\n   *  - **PullOnly**. A local briefcase file that may be used to \"slide\" along a timeline by applying incoming changesets.\n   * They are always opened readonly except to apply changesets.\n   *  - **Standalone**. Standalone iModels are local files that are not connected to iModelHub, and therefore cannot accept or create changesets.\n   */\n  Unassigned = 0,\n}\n\n/** Whether a briefcase is editable or may only accept incoming changesets from iModelHub\n * @public\n * @extensions\n */\nexport enum SyncMode {\n  /** Use a fixed version (i.e. a checkpoint). See [CheckpointManager]($backend) for preferred approach to using checkpoint files. */\n  FixedVersion = 1,\n  /** A briefcase that can be edited. A unique briefcaseId must be assigned by iModelHub. */\n  PullAndPush = 2,\n  /** use [BriefcaseIdValue.Unassigned](%backend). This makes a briefcase that can accept changesets from iModelHub but can never create changesets. */\n  PullOnly = 3,\n}\n\n/**\n * Options to open a previously downloaded briefcase\n * @public\n */\nexport interface OpenBriefcaseOptions {\n  /** open briefcase Readonly */\n  readonly openAsReadOnly?: boolean;\n}\n\n/**\n * Properties that specify a briefcase within the local briefcase cache.\n * @see BriefcaseManager.getFileName\n * @public\n */\nexport interface BriefcaseProps {\n  /** Id of the iModel */\n  readonly iModelId: GuidString;\n\n  /** BriefcaseId of the briefcase */\n  readonly briefcaseId: BriefcaseId;\n}\n\n/** Properties for opening a local briefcase file via [BriefcaseDb.open]($backend)\n * @public\n */\nexport interface OpenBriefcaseProps extends IModelEncryptionProps, OpenDbKey { // eslint-disable-line deprecation/deprecation\n  /** the full path to the briefcase file  */\n  readonly fileName: LocalFileName;\n  /** If true, open the briefcase readonly */\n  readonly readonly?: boolean;\n}\n\n/** Properties of a local briefcase file, returned by [BriefcaseManager.getCachedBriefcases]($backend) and [BriefcaseManager.downloadBriefcase]($backend)\n * @public\n * @extensions\n */\nexport interface LocalBriefcaseProps {\n  /** Full path of local file. */\n  readonly fileName: LocalFileName;\n\n  /** The iTwin containing the iModel. */\n  readonly iTwinId: GuidString;\n\n  /** The iModelId. */\n  readonly iModelId: GuidString;\n\n  /** The briefcaseId. */\n  readonly briefcaseId: BriefcaseId;\n\n  /** The current changesetId.\n   * @note ChangeSet Ids are string hash values based on the ChangeSet's content and parent.\n   */\n  readonly changeset: ChangesetIdWithIndex;\n\n  /** Size of the briefcase file in bytes  */\n  readonly fileSize: number;\n}\n\n/** Properties for downloading a briefcase to a local file, from iModelHub.\n * @public\n * @extensions\n */\nexport interface RequestNewBriefcaseProps {\n  /** iTwin that the iModel belongs to. */\n  readonly iTwinId: GuidString;\n\n  /** The iModelId for the new briefcase. */\n  readonly iModelId: GuidString;\n\n  /** Full path of local file to store the briefcase. If undefined, a file will be created in the briefcase cache, and this member will be filled with the full path to the file.\n   * Callers can use this to open the briefcase after the download completes.\n   * @note this member is both an input and an output.\n   */\n  readonly fileName?: LocalFileName;\n\n  /**\n   * The BriefcaseId for the new briefcase. If undefined, a new BriefcaseId will be acquired from iModelHub before the download, and is returned in this member.\n   * @note To download a briefcase that can accept but not create new changesets (sometimes referred to as \"pull only\" briefcases), set this value to [[BriefcaseIdValue.Unassigned]].\n   * After downloading, you can merely delete unassigned briefcase files when they are no longer needed. Assigned BriefcaseIds should be released (via [BriefcaseManager.releaseBriefcase]($backend) )\n   * when you are done with them.\n   * @note this member is both an input and an output.\n   *\n   */\n  briefcaseId?: BriefcaseId;\n\n  /** Id of the change set of the new briefcase. If undefined, use latest. */\n  asOf?: IModelVersionProps;\n}\n\n/**\n * Manages the download of a briefcase\n * @public\n */\nexport interface BriefcaseDownloader {\n  /** Id of the briefcase being downloaded */\n  readonly briefcaseId: BriefcaseId;\n\n  /** the name of the local file for the briefcase */\n  readonly fileName: LocalFileName;\n\n  /** Promise that resolves when the download completes. await this to complete the download */\n  readonly downloadPromise: Promise<void>;\n\n  /** Request cancellation of the download */\n  readonly requestCancel: () => Promise<boolean>;\n}\n\n/** Option to control the validation and upgrade of domain schemas in the Db\n * @beta\n */\nexport enum DomainOptions {\n  /** Domain schemas will be validated for any required upgrades. Any errors will be reported back, and cause the application to fail opening the Db */\n  CheckRequiredUpgrades = 0,\n\n  /** Domain schemas will be validated for any required or optional upgrades. Any errors will be reported back, and cause the application to fail opening the Db */\n  CheckRecommendedUpgrades = 1,\n\n  /** Domain schemas will be upgraded if necessary. However, only compatible schema upgrades will be allowed - these are typically additions of classes, properties, and changes to custom attributes */\n  Upgrade = 2,\n\n  /** Domain schemas will neither be validated nor be upgraded. Used only internally */\n  SkipCheck = 3,\n}\n\n/** Options that control whether a profile upgrade should be performed when opening a Db\n * @beta\n */\nexport enum ProfileOptions {\n  /** No profile upgrade will be performed. If a profile upgrade was required, opening the file will fail */\n  None = 0,\n\n  /** Profile upgrade will be performed if necessary */\n  Upgrade = 1,\n}\n\n/** Arguments to validate and update the profile and domain schemas when opening a Db\n * @beta\n */\nexport interface UpgradeOptions {\n  /** Option to control the validation and upgrade of domain schemas in the Db */\n  readonly domain?: DomainOptions;\n\n  /** Options that control whether a profile upgrade should be performed when opening a file */\n  readonly profile?: ProfileOptions;\n}\n\n/**\n * The state of the schemas in the Db compared with what the current version of the software expects\n * Note: The state may vary depending on whether the Db is to be opened ReadOnly or ReadWrite.\n * @beta\n */\nexport enum SchemaState {\n  /** The schemas in the Db are up-to-date, and do not need to be upgraded before opening it with the current version of the software */\n  UpToDate,\n\n  /** It's required that the schemas in the Db be upgraded before it can be opened with the current version of the software.\n   * This may happen in read-write scenarios where the application requires a newer version of the schemas to be in place before\n   * it can write data based on that new schema.\n   */\n  UpgradeRequired,\n\n  /** It's recommended, but not necessary that the schemas in the Db be upgraded before opening it with the current version of the software */\n  UpgradeRecommended,\n\n  /** The schemas in the Db are too old to be opened by the current version of the software. Upgrade using the API is not possible. */\n  TooOld,\n\n  /** The schemas in the Db are too new to be opened by the current version of the software */\n  TooNew,\n}\n"]}

package/lib/cjs/Camera.d.ts

@@ -1,43 +1,43 @@
-/** @packageDocumentation
- * @module Views
- */
-import { Angle, AngleProps, Point3d, XYAndZ, XYZProps } from "@itwin/core-geometry";
-/** JSON representation of a [[Camera]].
- * @public
- * @extensions
- */
-export interface CameraProps {
-    lens: AngleProps;
-    focusDist: number;
-    eye: XYZProps;
-}
-/** The current position (eyepoint), lens angle, and focus distance of a camera.
- * @see [Views]($docs/learning/frontend/Views.md)
- * @public
- */
-export declare class Camera implements CameraProps {
-    readonly lens: Angle;
-    focusDist: number;
-    readonly eye: Point3d;
-    static isValidLensAngle(val: Angle): boolean;
-    static validateLensAngle(val: Angle): void;
-    invalidateFocus(): void;
-    get isFocusValid(): boolean;
-    getFocusDistance(): number;
-    setFocusDistance(dist: number): void;
-    get isLensValid(): boolean;
-    validateLens(): void;
-    getLensAngle(): Angle;
-    setLensAngle(angle: Angle): void;
-    getEyePoint(): Point3d;
-    setEyePoint(pt: XYAndZ): void;
-    get isValid(): boolean;
-    equals(other: Camera): boolean;
-    clone(): Camera;
-    setFrom(rhs: Camera): void;
-    /** Construct a Camera
-     * @param props The properties of the new camera. If undefined, create a camera with eye at {0,0,0}, 90 degree lens, 1 meter focus distance.
-     */
-    constructor(props?: CameraProps);
-}
+/** @packageDocumentation
+ * @module Views
+ */
+import { Angle, AngleProps, Point3d, XYAndZ, XYZProps } from "@itwin/core-geometry";
+/** JSON representation of a [[Camera]].
+ * @public
+ * @extensions
+ */
+export interface CameraProps {
+    lens: AngleProps;
+    focusDist: number;
+    eye: XYZProps;
+}
+/** The current position (eyepoint), lens angle, and focus distance of a camera.
+ * @see [Views]($docs/learning/frontend/Views.md)
+ * @public
+ */
+export declare class Camera implements CameraProps {
+    readonly lens: Angle;
+    focusDist: number;
+    readonly eye: Point3d;
+    static isValidLensAngle(val: Angle): boolean;
+    static validateLensAngle(val: Angle): void;
+    invalidateFocus(): void;
+    get isFocusValid(): boolean;
+    getFocusDistance(): number;
+    setFocusDistance(dist: number): void;
+    get isLensValid(): boolean;
+    validateLens(): void;
+    getLensAngle(): Angle;
+    setLensAngle(angle: Angle): void;
+    getEyePoint(): Point3d;
+    setEyePoint(pt: XYAndZ): void;
+    get isValid(): boolean;
+    equals(other: Camera): boolean;
+    clone(): Camera;
+    setFrom(rhs: Camera): void;
+    /** Construct a Camera
+     * @param props The properties of the new camera. If undefined, create a camera with eye at {0,0,0}, 90 degree lens, 1 meter focus distance.
+     */
+    constructor(props?: CameraProps);
+}
 //# sourceMappingURL=Camera.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Camera.d.ts","sourceRoot":"","sources":["../../src/Camera.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEpF;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,UAAU,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,QAAQ,CAAC;CACf;AAED;;;GAGG;AACH,qBAAa,MAAO,YAAW,WAAW;IACxC,SAAgB,IAAI,EAAE,KAAK,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IACzB,SAAgB,GAAG,EAAE,OAAO,CAAC;WAEf,gBAAgB,CAAC,GAAG,EAAE,KAAK;WAC3B,iBAAiB,CAAC,GAAG,EAAE,KAAK;IACnC,eAAe;IACtB,IAAW,YAAY,YAA8D;IAC9E,gBAAgB;IAChB,gBAAgB,CAAC,IAAI,EAAE,MAAM;IACpC,IAAW,WAAW,YAAiD;IAChE,YAAY;IACZ,YAAY;IACZ,YAAY,CAAC,KAAK,EAAE,KAAK;IACzB,WAAW;IACX,WAAW,CAAC,EAAE,EAAE,MAAM;IAC7B,IAAW,OAAO,YAAoD;IAC/D,MAAM,CAAC,KAAK,EAAE,MAAM;IAKpB,KAAK;IACL,OAAO,CAAC,GAAG,EAAE,MAAM;IAM1B;;OAEG;gBACgB,KAAK,CAAC,EAAE,WAAW;CAWvC"}
+{"version":3,"file":"Camera.d.ts","sourceRoot":"","sources":["../../src/Camera.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEpF;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,UAAU,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,QAAQ,CAAC;CACf;AAED;;;GAGG;AACH,qBAAa,MAAO,YAAW,WAAW;IACxC,SAAgB,IAAI,EAAE,KAAK,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IACzB,SAAgB,GAAG,EAAE,OAAO,CAAC;WAEf,gBAAgB,CAAC,GAAG,EAAE,KAAK;WAI3B,iBAAiB,CAAC,GAAG,EAAE,KAAK;IAKnC,eAAe;IACtB,IAAW,YAAY,YAA8D;IAC9E,gBAAgB;IAChB,gBAAgB,CAAC,IAAI,EAAE,MAAM;IACpC,IAAW,WAAW,YAAiD;IAChE,YAAY;IACZ,YAAY;IACZ,YAAY,CAAC,KAAK,EAAE,KAAK;IACzB,WAAW;IACX,WAAW,CAAC,EAAE,EAAE,MAAM;IAC7B,IAAW,OAAO,YAAoD;IAC/D,MAAM,CAAC,KAAK,EAAE,MAAM;IAKpB,KAAK;IACL,OAAO,CAAC,GAAG,EAAE,MAAM;IAM1B;;OAEG;gBACgB,KAAK,CAAC,EAAE,WAAW;CAWvC"}

package/lib/cjs/Camera.js

@@ -1,59 +1,63 @@
-"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 Views
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Camera = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_geometry_1 = require("@itwin/core-geometry");
-/** The current position (eyepoint), lens angle, and focus distance of a camera.
- * @see [Views]($docs/learning/frontend/Views.md)
- * @public
- */
-class Camera {
-    /** Construct a Camera
-     * @param props The properties of the new camera. If undefined, create a camera with eye at {0,0,0}, 90 degree lens, 1 meter focus distance.
-     */
-    constructor(props) {
-        if (props !== undefined) {
-            this.lens = core_geometry_1.Angle.fromJSON(props.lens);
-            this.focusDist = core_bentley_1.JsonUtils.asDouble(props.focusDist);
-            this.eye = core_geometry_1.Point3d.fromJSON(props.eye);
-            return;
-        }
-        this.lens = core_geometry_1.Angle.createRadians(Math.PI / 2.0);
-        this.focusDist = 1;
-        this.eye = new core_geometry_1.Point3d();
-    }
-    static isValidLensAngle(val) { return val.radians > (Math.PI / 8.0) && val.radians < Math.PI; }
-    static validateLensAngle(val) { if (!this.isValidLensAngle(val))
-        val.setRadians(Math.PI / 2.0); }
-    invalidateFocus() { this.focusDist = 0.0; }
-    get isFocusValid() { return this.focusDist > 0.0 && this.focusDist < 1.0e14; }
-    getFocusDistance() { return this.focusDist; }
-    setFocusDistance(dist) { this.focusDist = dist; }
-    get isLensValid() { return Camera.isValidLensAngle(this.lens); }
-    validateLens() { Camera.validateLensAngle(this.lens); }
-    getLensAngle() { return this.lens; }
-    setLensAngle(angle) { this.lens.setFrom(angle); }
-    getEyePoint() { return this.eye; }
-    setEyePoint(pt) { this.eye.setFrom(pt); }
-    get isValid() { return this.isLensValid && this.isFocusValid; }
-    equals(other) {
-        return Math.abs(this.lens.radians - other.lens.radians) < .01 &&
-            Math.abs(this.focusDist - other.focusDist) < .1 &&
-            this.eye.isAlmostEqual(other.eye);
-    }
-    clone() { return new Camera(this); }
-    setFrom(rhs) {
-        this.lens.setFrom(rhs.lens);
-        this.focusDist = rhs.focusDist;
-        this.eye.setFrom(rhs.eye);
-    }
-}
-exports.Camera = Camera;
+"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 Views
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Camera = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_geometry_1 = require("@itwin/core-geometry");
+/** The current position (eyepoint), lens angle, and focus distance of a camera.
+ * @see [Views]($docs/learning/frontend/Views.md)
+ * @public
+ */
+class Camera {
+    /** Construct a Camera
+     * @param props The properties of the new camera. If undefined, create a camera with eye at {0,0,0}, 90 degree lens, 1 meter focus distance.
+     */
+    constructor(props) {
+        if (props !== undefined) {
+            this.lens = core_geometry_1.Angle.fromJSON(props.lens);
+            this.focusDist = core_bentley_1.JsonUtils.asDouble(props.focusDist);
+            this.eye = core_geometry_1.Point3d.fromJSON(props.eye);
+            return;
+        }
+        this.lens = core_geometry_1.Angle.createRadians(Math.PI / 2.0);
+        this.focusDist = 1;
+        this.eye = new core_geometry_1.Point3d();
+    }
+    static isValidLensAngle(val) {
+        return val.radians > (Math.PI / 8.0) && val.radians < Math.PI;
+    }
+    static validateLensAngle(val) {
+        if (!this.isValidLensAngle(val))
+            val.setRadians(Math.PI / 2.0);
+    }
+    invalidateFocus() { this.focusDist = 0.0; }
+    get isFocusValid() { return this.focusDist > 0.0 && this.focusDist < 1.0e14; }
+    getFocusDistance() { return this.focusDist; }
+    setFocusDistance(dist) { this.focusDist = dist; }
+    get isLensValid() { return Camera.isValidLensAngle(this.lens); }
+    validateLens() { Camera.validateLensAngle(this.lens); }
+    getLensAngle() { return this.lens; }
+    setLensAngle(angle) { this.lens.setFrom(angle); }
+    getEyePoint() { return this.eye; }
+    setEyePoint(pt) { this.eye.setFrom(pt); }
+    get isValid() { return this.isLensValid && this.isFocusValid; }
+    equals(other) {
+        return Math.abs(this.lens.radians - other.lens.radians) < .01 &&
+            Math.abs(this.focusDist - other.focusDist) < .1 &&
+            this.eye.isAlmostEqual(other.eye);
+    }
+    clone() { return new Camera(this); }
+    setFrom(rhs) {
+        this.lens.setFrom(rhs.lens);
+        this.focusDist = rhs.focusDist;
+        this.eye.setFrom(rhs.eye);
+    }
+}
+exports.Camera = Camera;
 //# sourceMappingURL=Camera.js.map

package/lib/cjs/Camera.js.map

@@ -1 +1 @@
-{"version":3,"file":"Camera.js","sourceRoot":"","sources":["../../src/Camera.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAgD;AAChD,wDAAoF;AAYpF;;;GAGG;AACH,MAAa,MAAM;IA8BjB;;OAEG;IACH,YAAmB,KAAmB;QACpC,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,IAAI,CAAC,IAAI,GAAG,qBAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACvC,IAAI,CAAC,SAAS,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACrD,IAAI,CAAC,GAAG,GAAG,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACvC,OAAO;SACR;QACD,IAAI,CAAC,IAAI,GAAG,qBAAK,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,IAAI,uBAAO,EAAE,CAAC;IAC3B,CAAC;IAtCM,MAAM,CAAC,gBAAgB,CAAC,GAAU,IAAI,OAAO,GAAG,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IACtG,MAAM,CAAC,iBAAiB,CAAC,GAAU,IAAI,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC;QAAE,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IACxG,eAAe,KAAK,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC;IAClD,IAAW,YAAY,KAAK,OAAO,IAAI,CAAC,SAAS,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC;IAC9E,gBAAgB,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAC7C,gBAAgB,CAAC,IAAY,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC;IAChE,IAAW,WAAW,KAAK,OAAO,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChE,YAAY,KAAK,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACvD,YAAY,KAAK,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACpC,YAAY,CAAC,KAAY,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxD,WAAW,KAAK,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAClC,WAAW,CAAC,EAAU,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACxD,IAAW,OAAO,KAAK,OAAO,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAC/D,MAAM,CAAC,KAAa;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,GAAG;YAC3D,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;YAC/C,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IACM,KAAK,KAAK,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpC,OAAO,CAAC,GAAW;QACxB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;QAC/B,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;CAgBF;AA5CD,wBA4CC","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 Views\r\n */\r\n\r\nimport { JsonUtils } from \"@itwin/core-bentley\";\r\nimport { Angle, AngleProps, Point3d, XYAndZ, XYZProps } from \"@itwin/core-geometry\";\r\n\r\n/** JSON representation of a [[Camera]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface CameraProps {\r\n  lens: AngleProps;\r\n  focusDist: number; // NOTE: this is abbreviated, do not change!\r\n  eye: XYZProps;\r\n}\r\n\r\n/** The current position (eyepoint), lens angle, and focus distance of a camera.\r\n * @see [Views]($docs/learning/frontend/Views.md)\r\n * @public\r\n */\r\nexport class Camera implements CameraProps {\r\n  public readonly lens: Angle;\r\n  public focusDist: number;\r\n  public readonly eye: Point3d;\r\n\r\n  public static isValidLensAngle(val: Angle) { return val.radians > (Math.PI / 8.0) && val.radians < Math.PI; }\r\n  public static validateLensAngle(val: Angle) { if (!this.isValidLensAngle(val)) val.setRadians(Math.PI / 2.0); }\r\n  public invalidateFocus() { this.focusDist = 0.0; }\r\n  public get isFocusValid() { return this.focusDist > 0.0 && this.focusDist < 1.0e14; }\r\n  public getFocusDistance() { return this.focusDist; }\r\n  public setFocusDistance(dist: number) { this.focusDist = dist; }\r\n  public get isLensValid() { return Camera.isValidLensAngle(this.lens); }\r\n  public validateLens() { Camera.validateLensAngle(this.lens); }\r\n  public getLensAngle() { return this.lens; }\r\n  public setLensAngle(angle: Angle) { this.lens.setFrom(angle); }\r\n  public getEyePoint() { return this.eye; }\r\n  public setEyePoint(pt: XYAndZ) { this.eye.setFrom(pt); }\r\n  public get isValid() { return this.isLensValid && this.isFocusValid; }\r\n  public equals(other: Camera) {\r\n    return Math.abs(this.lens.radians - other.lens.radians) < .01 &&\r\n      Math.abs(this.focusDist - other.focusDist) < .1 &&\r\n      this.eye.isAlmostEqual(other.eye);\r\n  }\r\n  public clone() { return new Camera(this); }\r\n  public setFrom(rhs: Camera) {\r\n    this.lens.setFrom(rhs.lens);\r\n    this.focusDist = rhs.focusDist;\r\n    this.eye.setFrom(rhs.eye);\r\n  }\r\n\r\n  /** Construct a Camera\r\n   * @param props The properties of the new camera. If undefined, create a camera with eye at {0,0,0}, 90 degree lens, 1 meter focus distance.\r\n   */\r\n  public constructor(props?: CameraProps) {\r\n    if (props !== undefined) {\r\n      this.lens = Angle.fromJSON(props.lens);\r\n      this.focusDist = JsonUtils.asDouble(props.focusDist);\r\n      this.eye = Point3d.fromJSON(props.eye);\r\n      return;\r\n    }\r\n    this.lens = Angle.createRadians(Math.PI / 2.0);\r\n    this.focusDist = 1;\r\n    this.eye = new Point3d();\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Camera.js","sourceRoot":"","sources":["../../src/Camera.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAgD;AAChD,wDAAoF;AAYpF;;;GAGG;AACH,MAAa,MAAM;IAqCjB;;OAEG;IACH,YAAmB,KAAmB;QACpC,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,IAAI,CAAC,IAAI,GAAG,qBAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACvC,IAAI,CAAC,SAAS,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACrD,IAAI,CAAC,GAAG,GAAG,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACvC,OAAO;SACR;QACD,IAAI,CAAC,IAAI,GAAG,qBAAK,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,IAAI,uBAAO,EAAE,CAAC;IAC3B,CAAC;IA7CM,MAAM,CAAC,gBAAgB,CAAC,GAAU;QACvC,OAAO,GAAG,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC;IAChE,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAAC,GAAU;QACxC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC;YAC7B,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC;IAClC,CAAC;IAEM,eAAe,KAAK,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC;IAClD,IAAW,YAAY,KAAK,OAAO,IAAI,CAAC,SAAS,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC;IAC9E,gBAAgB,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAC7C,gBAAgB,CAAC,IAAY,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC;IAChE,IAAW,WAAW,KAAK,OAAO,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChE,YAAY,KAAK,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACvD,YAAY,KAAK,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACpC,YAAY,CAAC,KAAY,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxD,WAAW,KAAK,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAClC,WAAW,CAAC,EAAU,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACxD,IAAW,OAAO,KAAK,OAAO,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAC/D,MAAM,CAAC,KAAa;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,GAAG;YAC3D,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;YAC/C,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IACM,KAAK,KAAK,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpC,OAAO,CAAC,GAAW;QACxB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;QAC/B,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;CAgBF;AAnDD,wBAmDC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Views\n */\n\nimport { JsonUtils } from \"@itwin/core-bentley\";\nimport { Angle, AngleProps, Point3d, XYAndZ, XYZProps } from \"@itwin/core-geometry\";\n\n/** JSON representation of a [[Camera]].\n * @public\n * @extensions\n */\nexport interface CameraProps {\n  lens: AngleProps;\n  focusDist: number; // NOTE: this is abbreviated, do not change!\n  eye: XYZProps;\n}\n\n/** The current position (eyepoint), lens angle, and focus distance of a camera.\n * @see [Views]($docs/learning/frontend/Views.md)\n * @public\n */\nexport class Camera implements CameraProps {\n  public readonly lens: Angle;\n  public focusDist: number;\n  public readonly eye: Point3d;\n\n  public static isValidLensAngle(val: Angle) {\n    return val.radians > (Math.PI / 8.0) && val.radians < Math.PI;\n  }\n\n  public static validateLensAngle(val: Angle) {\n    if (!this.isValidLensAngle(val))\n      val.setRadians(Math.PI / 2.0);\n  }\n\n  public invalidateFocus() { this.focusDist = 0.0; }\n  public get isFocusValid() { return this.focusDist > 0.0 && this.focusDist < 1.0e14; }\n  public getFocusDistance() { return this.focusDist; }\n  public setFocusDistance(dist: number) { this.focusDist = dist; }\n  public get isLensValid() { return Camera.isValidLensAngle(this.lens); }\n  public validateLens() { Camera.validateLensAngle(this.lens); }\n  public getLensAngle() { return this.lens; }\n  public setLensAngle(angle: Angle) { this.lens.setFrom(angle); }\n  public getEyePoint() { return this.eye; }\n  public setEyePoint(pt: XYAndZ) { this.eye.setFrom(pt); }\n  public get isValid() { return this.isLensValid && this.isFocusValid; }\n  public equals(other: Camera) {\n    return Math.abs(this.lens.radians - other.lens.radians) < .01 &&\n      Math.abs(this.focusDist - other.focusDist) < .1 &&\n      this.eye.isAlmostEqual(other.eye);\n  }\n  public clone() { return new Camera(this); }\n  public setFrom(rhs: Camera) {\n    this.lens.setFrom(rhs.lens);\n    this.focusDist = rhs.focusDist;\n    this.eye.setFrom(rhs.eye);\n  }\n\n  /** Construct a Camera\n   * @param props The properties of the new camera. If undefined, create a camera with eye at {0,0,0}, 90 degree lens, 1 meter focus distance.\n   */\n  public constructor(props?: CameraProps) {\n    if (props !== undefined) {\n      this.lens = Angle.fromJSON(props.lens);\n      this.focusDist = JsonUtils.asDouble(props.focusDist);\n      this.eye = Point3d.fromJSON(props.eye);\n      return;\n    }\n    this.lens = Angle.createRadians(Math.PI / 2.0);\n    this.focusDist = 1;\n    this.eye = new Point3d();\n  }\n}\n"]}