@itwin/core-common 3.5.0-dev.63 → 3.5.0-dev.66

package/lib/esm/BriefcaseTypes.d.ts

@@ -1,190 +1,190 @@
-/** @packageDocumentation
- * @module iModels
- */
-import { GuidString } from "@itwin/core-bentley";
-import { ChangesetIdWithIndex, LocalFileName } from "./ChangesetProps";
-import { IModelEncryptionProps, OpenDbKey } from "./IModel";
-import { IModelVersionProps } from "./IModelVersion";
-/** The Id assigned to a briefcase by iModelHub, or [[BriefcaseIdValue.Unassigned]] .
- * @public
- * @extensions
- */
-export declare type BriefcaseId = number;
-/** Values of [[BriefcaseId]] that have special meaning.
- * @public
- * @extensions
- */
-export declare enum BriefcaseIdValue {
-    /** Indicates an invalid/illegal BriefcaseId */
-    Illegal = 4294967295,
-    /** BriefcaseIds must be less than this value */
-    Max = 16777216,
-    /** All valid iModelHub issued BriefcaseIds will be equal or higher than this */
-    FirstValid = 2,
-    /** All valid iModelHub issued BriefcaseIds will be equal or lower than this */
-    LastValid = 16777205,
-    /**
-     * 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.
-     */
-    Unassigned = 0
-}
-/** Whether a briefcase is editable or may only accept incoming changesets from iModelHub
- * @public
- * @extensions
- */
-export declare enum SyncMode {
-    /** Use a fixed version (i.e. a checkpoint). See [CheckpointManager]($backend) for preferred approach to using checkpoint files. */
-    FixedVersion = 1,
-    /** A briefcase that can be edited. A unique briefcaseId must be assigned by iModelHub. */
-    PullAndPush = 2,
-    /** use [BriefcaseIdValue.Unassigned](%backend). This makes a briefcase that can accept changesets from iModelHub but can never create changesets. */
-    PullOnly = 3
-}
-/**
- * Options to open a previously downloaded briefcase
- * @public
- */
-export interface OpenBriefcaseOptions {
-    /** open briefcase Readonly */
-    readonly openAsReadOnly?: boolean;
-}
-/**
- * Properties that specify a briefcase within the local briefcase cache.
- * @see BriefcaseManager.getFileName
- * @public
- */
-export interface BriefcaseProps {
-    /** Id of the iModel */
-    readonly iModelId: GuidString;
-    /** BriefcaseId of the briefcase */
-    readonly briefcaseId: BriefcaseId;
-}
-/** Properties for opening a local briefcase file via [BriefcaseDb.open]($backend)
- * @public
- */
-export interface OpenBriefcaseProps extends IModelEncryptionProps, OpenDbKey {
-    /** the full path to the briefcase file  */
-    readonly fileName: LocalFileName;
-    /** If true, open the briefcase readonly */
-    readonly readonly?: boolean;
-}
-/** Properties of a local briefcase file, returned by [BriefcaseManager.getCachedBriefcases]($backend) and [BriefcaseManager.downloadBriefcase]($backend)
- * @public
- * @extensions
- */
-export interface LocalBriefcaseProps {
-    /** Full path of local file. */
-    readonly fileName: LocalFileName;
-    /** The iTwin containing the iModel. */
-    readonly iTwinId: GuidString;
-    /** The iModelId. */
-    readonly iModelId: GuidString;
-    /** The briefcaseId. */
-    readonly briefcaseId: BriefcaseId;
-    /** The current changesetId.
-     * @note ChangeSet Ids are string hash values based on the ChangeSet's content and parent.
-     */
-    readonly changeset: ChangesetIdWithIndex;
-    /** Size of the briefcase file in bytes  */
-    readonly fileSize: number;
-}
-/** Properties for downloading a briefcase to a local file, from iModelHub.
- * @public
- * @extensions
- */
-export interface RequestNewBriefcaseProps {
-    /** iTwin that the iModel belongs to. */
-    readonly iTwinId: GuidString;
-    /** The iModelId for the new briefcase. */
-    readonly iModelId: GuidString;
-    /** 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.
-     * Callers can use this to open the briefcase after the download completes.
-     * @note this member is both an input and an output.
-     */
-    readonly fileName?: LocalFileName;
-    /**
-     * 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.
-     * @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]].
-     * After downloading, you can merely delete unassigned briefcase files when they are no longer needed. Assigned BriefcaseIds should be released (via [BriefcaseManager.releaseBriefcase]($backend) )
-     * when you are done with them.
-     * @note this member is both an input and an output.
-     *
-     */
-    briefcaseId?: BriefcaseId;
-    /** Id of the change set of the new briefcase. If undefined, use latest. */
-    asOf?: IModelVersionProps;
-}
-/**
- * Manages the download of a briefcase
- * @public
- */
-export interface BriefcaseDownloader {
-    /** Id of the briefcase being downloaded */
-    readonly briefcaseId: BriefcaseId;
-    /** the name of the local file for the briefcase */
-    readonly fileName: LocalFileName;
-    /** Promise that resolves when the download completes. await this to complete the download */
-    readonly downloadPromise: Promise<void>;
-    /** Request cancellation of the download */
-    readonly requestCancel: () => Promise<boolean>;
-}
-/** Option to control the validation and upgrade of domain schemas in the Db
- * @beta
- */
-export declare enum 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 */
-    CheckRequiredUpgrades = 0,
-    /** 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 */
-    CheckRecommendedUpgrades = 1,
-    /** 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 */
-    Upgrade = 2,
-    /** Domain schemas will neither be validated nor be upgraded. Used only internally */
-    SkipCheck = 3
-}
-/** Options that control whether a profile upgrade should be performed when opening a Db
- * @beta
- */
-export declare enum ProfileOptions {
-    /** No profile upgrade will be performed. If a profile upgrade was required, opening the file will fail */
-    None = 0,
-    /** Profile upgrade will be performed if necessary */
-    Upgrade = 1
-}
-/** Arguments to validate and update the profile and domain schemas when opening a Db
- * @beta
- */
-export interface UpgradeOptions {
-    /** Option to control the validation and upgrade of domain schemas in the Db */
-    readonly domain?: DomainOptions;
-    /** Options that control whether a profile upgrade should be performed when opening a file */
-    readonly profile?: 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
- */
-export declare enum 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 */
-    UpToDate = 0,
-    /** 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.
-     */
-    UpgradeRequired = 1,
-    /** It's recommended, but not necessary that the schemas in the Db be upgraded before opening it with the current version of the software */
-    UpgradeRecommended = 2,
-    /** 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. */
-    TooOld = 3,
-    /** The schemas in the Db are too new to be opened by the current version of the software */
-    TooNew = 4
-}
+/** @packageDocumentation
+ * @module iModels
+ */
+import { GuidString } from "@itwin/core-bentley";
+import { ChangesetIdWithIndex, LocalFileName } from "./ChangesetProps";
+import { IModelEncryptionProps, OpenDbKey } from "./IModel";
+import { IModelVersionProps } from "./IModelVersion";
+/** The Id assigned to a briefcase by iModelHub, or [[BriefcaseIdValue.Unassigned]] .
+ * @public
+ * @extensions
+ */
+export declare type BriefcaseId = number;
+/** Values of [[BriefcaseId]] that have special meaning.
+ * @public
+ * @extensions
+ */
+export declare enum BriefcaseIdValue {
+    /** Indicates an invalid/illegal BriefcaseId */
+    Illegal = 4294967295,
+    /** BriefcaseIds must be less than this value */
+    Max = 16777216,
+    /** All valid iModelHub issued BriefcaseIds will be equal or higher than this */
+    FirstValid = 2,
+    /** All valid iModelHub issued BriefcaseIds will be equal or lower than this */
+    LastValid = 16777205,
+    /**
+     * 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.
+     */
+    Unassigned = 0
+}
+/** Whether a briefcase is editable or may only accept incoming changesets from iModelHub
+ * @public
+ * @extensions
+ */
+export declare enum SyncMode {
+    /** Use a fixed version (i.e. a checkpoint). See [CheckpointManager]($backend) for preferred approach to using checkpoint files. */
+    FixedVersion = 1,
+    /** A briefcase that can be edited. A unique briefcaseId must be assigned by iModelHub. */
+    PullAndPush = 2,
+    /** use [BriefcaseIdValue.Unassigned](%backend). This makes a briefcase that can accept changesets from iModelHub but can never create changesets. */
+    PullOnly = 3
+}
+/**
+ * Options to open a previously downloaded briefcase
+ * @public
+ */
+export interface OpenBriefcaseOptions {
+    /** open briefcase Readonly */
+    readonly openAsReadOnly?: boolean;
+}
+/**
+ * Properties that specify a briefcase within the local briefcase cache.
+ * @see BriefcaseManager.getFileName
+ * @public
+ */
+export interface BriefcaseProps {
+    /** Id of the iModel */
+    readonly iModelId: GuidString;
+    /** BriefcaseId of the briefcase */
+    readonly briefcaseId: BriefcaseId;
+}
+/** Properties for opening a local briefcase file via [BriefcaseDb.open]($backend)
+ * @public
+ */
+export interface OpenBriefcaseProps extends IModelEncryptionProps, OpenDbKey {
+    /** the full path to the briefcase file  */
+    readonly fileName: LocalFileName;
+    /** If true, open the briefcase readonly */
+    readonly readonly?: boolean;
+}
+/** Properties of a local briefcase file, returned by [BriefcaseManager.getCachedBriefcases]($backend) and [BriefcaseManager.downloadBriefcase]($backend)
+ * @public
+ * @extensions
+ */
+export interface LocalBriefcaseProps {
+    /** Full path of local file. */
+    readonly fileName: LocalFileName;
+    /** The iTwin containing the iModel. */
+    readonly iTwinId: GuidString;
+    /** The iModelId. */
+    readonly iModelId: GuidString;
+    /** The briefcaseId. */
+    readonly briefcaseId: BriefcaseId;
+    /** The current changesetId.
+     * @note ChangeSet Ids are string hash values based on the ChangeSet's content and parent.
+     */
+    readonly changeset: ChangesetIdWithIndex;
+    /** Size of the briefcase file in bytes  */
+    readonly fileSize: number;
+}
+/** Properties for downloading a briefcase to a local file, from iModelHub.
+ * @public
+ * @extensions
+ */
+export interface RequestNewBriefcaseProps {
+    /** iTwin that the iModel belongs to. */
+    readonly iTwinId: GuidString;
+    /** The iModelId for the new briefcase. */
+    readonly iModelId: GuidString;
+    /** 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.
+     * Callers can use this to open the briefcase after the download completes.
+     * @note this member is both an input and an output.
+     */
+    readonly fileName?: LocalFileName;
+    /**
+     * 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.
+     * @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]].
+     * After downloading, you can merely delete unassigned briefcase files when they are no longer needed. Assigned BriefcaseIds should be released (via [BriefcaseManager.releaseBriefcase]($backend) )
+     * when you are done with them.
+     * @note this member is both an input and an output.
+     *
+     */
+    briefcaseId?: BriefcaseId;
+    /** Id of the change set of the new briefcase. If undefined, use latest. */
+    asOf?: IModelVersionProps;
+}
+/**
+ * Manages the download of a briefcase
+ * @public
+ */
+export interface BriefcaseDownloader {
+    /** Id of the briefcase being downloaded */
+    readonly briefcaseId: BriefcaseId;
+    /** the name of the local file for the briefcase */
+    readonly fileName: LocalFileName;
+    /** Promise that resolves when the download completes. await this to complete the download */
+    readonly downloadPromise: Promise<void>;
+    /** Request cancellation of the download */
+    readonly requestCancel: () => Promise<boolean>;
+}
+/** Option to control the validation and upgrade of domain schemas in the Db
+ * @beta
+ */
+export declare enum 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 */
+    CheckRequiredUpgrades = 0,
+    /** 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 */
+    CheckRecommendedUpgrades = 1,
+    /** 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 */
+    Upgrade = 2,
+    /** Domain schemas will neither be validated nor be upgraded. Used only internally */
+    SkipCheck = 3
+}
+/** Options that control whether a profile upgrade should be performed when opening a Db
+ * @beta
+ */
+export declare enum ProfileOptions {
+    /** No profile upgrade will be performed. If a profile upgrade was required, opening the file will fail */
+    None = 0,
+    /** Profile upgrade will be performed if necessary */
+    Upgrade = 1
+}
+/** Arguments to validate and update the profile and domain schemas when opening a Db
+ * @beta
+ */
+export interface UpgradeOptions {
+    /** Option to control the validation and upgrade of domain schemas in the Db */
+    readonly domain?: DomainOptions;
+    /** Options that control whether a profile upgrade should be performed when opening a file */
+    readonly profile?: 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
+ */
+export declare enum 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 */
+    UpToDate = 0,
+    /** 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.
+     */
+    UpgradeRequired = 1,
+    /** It's recommended, but not necessary that the schemas in the Db be upgraded before opening it with the current version of the software */
+    UpgradeRecommended = 2,
+    /** 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. */
+    TooOld = 3,
+    /** The schemas in the Db are too new to be opened by the current version of the software */
+    TooNew = 4
+}
 //# sourceMappingURL=BriefcaseTypes.d.ts.map

package/lib/esm/BriefcaseTypes.js

@@ -1,93 +1,93 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-/** Values of [[BriefcaseId]] that have special meaning.
- * @public
- * @extensions
- */
-export 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 || (BriefcaseIdValue = {}));
-/** Whether a briefcase is editable or may only accept incoming changesets from iModelHub
- * @public
- * @extensions
- */
-export 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 || (SyncMode = {}));
-/** Option to control the validation and upgrade of domain schemas in the Db
- * @beta
- */
-export 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 || (DomainOptions = {}));
-/** Options that control whether a profile upgrade should be performed when opening a Db
- * @beta
- */
-export 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 || (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
- */
-export 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 || (SchemaState = {}));
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/** Values of [[BriefcaseId]] that have special meaning.
+ * @public
+ * @extensions
+ */
+export 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 || (BriefcaseIdValue = {}));
+/** Whether a briefcase is editable or may only accept incoming changesets from iModelHub
+ * @public
+ * @extensions
+ */
+export 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 || (SyncMode = {}));
+/** Option to control the validation and upgrade of domain schemas in the Db
+ * @beta
+ */
+export 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 || (DomainOptions = {}));
+/** Options that control whether a profile upgrade should be performed when opening a Db
+ * @beta
+ */
+export 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 || (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
+ */
+export 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 || (SchemaState = {}));
 //# sourceMappingURL=BriefcaseTypes.js.map

package/lib/esm/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,MAAM,CAAN,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,KAAhB,gBAAgB,QAyB3B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,mIAAmI;IACnI,uDAAgB,CAAA;IAChB,0FAA0F;IAC1F,qDAAe,CAAA;IACf,qJAAqJ;IACrJ,+CAAY,CAAA;AACd,CAAC,EAPW,QAAQ,KAAR,QAAQ,QAOnB;AA6GD;;GAEG;AACH,MAAM,CAAN,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,KAAb,aAAa,QAYxB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,0GAA0G;IAC1G,mDAAQ,CAAA;IAER,qDAAqD;IACrD,yDAAW,CAAA;AACb,CAAC,EANW,cAAc,KAAd,cAAc,QAMzB;AAaD;;;;GAIG;AACH,MAAM,CAAN,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,KAAX,WAAW,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,MAAM,CAAN,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,KAAhB,gBAAgB,QAyB3B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,mIAAmI;IACnI,uDAAgB,CAAA;IAChB,0FAA0F;IAC1F,qDAAe,CAAA;IACf,qJAAqJ;IACrJ,+CAAY,CAAA;AACd,CAAC,EAPW,QAAQ,KAAR,QAAQ,QAOnB;AA6GD;;GAEG;AACH,MAAM,CAAN,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,KAAb,aAAa,QAYxB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,0GAA0G;IAC1G,mDAAQ,CAAA;IAER,qDAAqD;IACrD,yDAAW,CAAA;AACb,CAAC,EANW,cAAc,KAAd,cAAc,QAMzB;AAaD;;;;GAIG;AACH,MAAM,CAAN,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,KAAX,WAAW,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"]}