@itwin/core-backend 3.6.0-dev.7 → 3.6.0

package/lib/cjs/BackendHubAccess.d.ts

@@ -1,225 +1,225 @@
-/** @packageDocumentation
- * @module HubAccess
- */
-import { AccessToken, GuidString, Id64String } from "@itwin/core-bentley";
-import { BriefcaseId, ChangesetFileProps, ChangesetIdWithIndex, ChangesetIndex, ChangesetIndexAndId, ChangesetIndexOrId, ChangesetProps, ChangesetRange, IModelError, IModelVersion, LocalDirName, LocalFileName } from "@itwin/core-common";
-import { CheckpointProps, DownloadRequest, ProgressFunction } from "./CheckpointManager";
-import { TokenArg } from "./IModelDb";
-/** The state of a lock.
- * @public
- */
-export declare enum LockState {
-    /** The element is not locked */
-    None = 0,
-    /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */
-    Shared = 1,
-    /** A Lock that permits modifications to an element and blocks other users from making modifications to it.
-     * Holding an exclusive lock on an "owner" (a model or a parent element), implicitly exclusively locks all its members.
-     */
-    Exclusive = 2
-}
-/** Exception thrown if lock cannot be acquired.
- * @beta
-*/
-export declare class LockConflict extends IModelError {
-    /** Id of Briefcase holding lock */
-    readonly briefcaseId: BriefcaseId;
-    /** Alias of Briefcase holding lock */
-    readonly briefcaseAlias: string;
-    constructor(
-    /** Id of Briefcase holding lock */
-    briefcaseId: BriefcaseId, 
-    /** Alias of Briefcase holding lock */
-    briefcaseAlias: string, msg: "shared lock is held" | "exclusive lock is already held");
-}
-/**
- * The properties to access a V2 checkpoint through a daemon.
- * @internal
- */
-export interface V2CheckpointAccessProps {
-    /** blob store account name. */
-    readonly accountName: string;
-    /** AccessToken that grants access to the container. */
-    readonly sasToken: AccessToken;
-    /** The name of the iModel's blob store container holding all checkpoints. */
-    readonly containerId: string;
-    /** The name of the virtual file within the container, used for the checkpoint */
-    readonly dbName: string;
-    /** blob storage module: e.g. "azure", "google", "aws". May also include URI style parameters. */
-    readonly storageType: string;
-}
-/** @internal */
-export declare type LockMap = Map<Id64String, LockState>;
-/**
- * The properties of a lock that may be obtained from a lock server.
- * @beta
- */
-export interface LockProps {
-    /** The elementId for the lock */
-    readonly id: Id64String;
-    /** the lock state */
-    readonly state: LockState;
-}
-/**
- * Argument for cancelling and tracking download progress.
- * @beta
- */
-export interface DownloadProgressArg {
-    /** Called to show progress during a download. If this function returns non-zero, the download is aborted. */
-    progressCallback?: ProgressFunction;
-}
-/**
- * Argument for methods that must supply an iTwinId
- * @public
- */
-export interface ITwinIdArg {
-    readonly iTwinId: GuidString;
-}
-/**
- * Argument for methods that must supply an IModelId
- * @public
- */
-export interface IModelIdArg extends TokenArg {
-    readonly iModelId: GuidString;
-}
-/**
- * Argument for acquiring a new BriefcaseId
- * @public
- */
-export interface AcquireNewBriefcaseIdArg extends IModelIdArg {
-    /** A string to be reported to other users to identify this briefcase, for example in the case of conflicts or lock collisions. */
-    readonly briefcaseAlias?: string;
-}
-/** Argument for methods that must supply an IModel name and iTwinId
- * @public
- */
-export interface IModelNameArg extends TokenArg, ITwinIdArg {
-    readonly iModelName: string;
-}
-/** Argument for methods that must supply an IModelId and a BriefcaseId
- * @public
- */
-export interface BriefcaseIdArg extends IModelIdArg {
-    readonly briefcaseId: BriefcaseId;
-}
-/** Argument for methods that must supply a briefcaseId and a changeset
- * @public
- */
-export interface BriefcaseDbArg extends BriefcaseIdArg {
-    readonly changeset: ChangesetIdWithIndex;
-}
-/** Argument for methods that must supply an IModelId and a changeset
- * @public
- */
-export interface ChangesetArg extends IModelIdArg {
-    readonly changeset: ChangesetIndexOrId;
-}
-/** Argument for downloading a changeset.
- * @beta
- */
-export interface DownloadChangesetArg extends ChangesetArg, DownloadProgressArg {
-    /** Directory where the changeset should be downloaded. */
-    targetDir: LocalDirName;
-}
-/** @internal */
-export interface ChangesetIndexArg extends IModelIdArg {
-    readonly changeset: ChangesetIdWithIndex;
-}
-/** Argument for methods that must supply an IModelId and a range of Changesets.
- * @public
- */
-export interface ChangesetRangeArg extends IModelIdArg {
-    /** the range of changesets desired. If is undefined, *all* changesets are returned. */
-    readonly range?: ChangesetRange;
-}
-/** Argument for downloading a changeset range.
- * @beta
- */
-export interface DownloadChangesetRangeArg extends ChangesetRangeArg, DownloadProgressArg {
-    /** Directory where the changesets should be downloaded. */
-    targetDir: LocalDirName;
-}
-/**
- * @deprecated
- * @internal
- */
-export declare type CheckpointArg = DownloadRequest;
-/**
- * Arguments to create a new iModel in iModelHub
- *  @public
- */
-export interface CreateNewIModelProps extends IModelNameArg {
-    readonly description?: string;
-    readonly version0?: LocalFileName;
-    readonly noLocks?: true;
-}
-/**
- * Methods for accessing services of IModelHub from an iTwin.js backend.
- * Generally direct access to these methods should not be required, since higher-level apis are provided.
- * @beta
- */
-export interface BackendHubAccess {
-    /** Download all the changesets in the specified range. */
-    downloadChangesets: (arg: DownloadChangesetRangeArg) => Promise<ChangesetFileProps[]>;
-    /** Download a single changeset. */
-    downloadChangeset: (arg: DownloadChangesetArg) => Promise<ChangesetFileProps>;
-    /** Query the changeset properties given a ChangesetIndex  */
-    queryChangeset: (arg: ChangesetArg) => Promise<ChangesetProps>;
-    /** Query an array of changeset properties given a range of ChangesetIndexes  */
-    queryChangesets: (arg: ChangesetRangeArg) => Promise<ChangesetProps[]>;
-    /** Push a changeset to iModelHub. Returns the newly pushed changeset's index */
-    pushChangeset: (arg: IModelIdArg & {
-        changesetProps: ChangesetFileProps;
-    }) => Promise<ChangesetIndex>;
-    /** Get the ChangesetProps of the most recent changeset */
-    getLatestChangeset: (arg: IModelIdArg) => Promise<ChangesetProps>;
-    /** Get the ChangesetProps for an IModelVersion */
-    getChangesetFromVersion: (arg: IModelIdArg & {
-        version: IModelVersion;
-    }) => Promise<ChangesetProps>;
-    /** Get the ChangesetProps for a named version */
-    getChangesetFromNamedVersion: (arg: IModelIdArg & {
-        versionName: string;
-    }) => Promise<ChangesetProps>;
-    /** Acquire a new briefcaseId for the supplied iModelId
-       * @note usually there should only be one briefcase per iModel per user.
-       */
-    acquireNewBriefcaseId: (arg: AcquireNewBriefcaseIdArg) => Promise<BriefcaseId>;
-    /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */
-    releaseBriefcase: (arg: BriefcaseIdArg) => Promise<void>;
-    /** get an array of the briefcases assigned to a user. */
-    getMyBriefcaseIds: (arg: IModelIdArg) => Promise<BriefcaseId[]>;
-    /**
-     * download a v1 checkpoint
-     * @deprecated
-     * @internal
-     */
-    downloadV1Checkpoint: (arg: CheckpointArg) => Promise<ChangesetIndexAndId>;
-    /**
-     * Get the access props for a V2 checkpoint. Returns undefined if no V2 checkpoint exists.
-     * @internal
-     */
-    queryV2Checkpoint: (arg: CheckpointProps) => Promise<V2CheckpointAccessProps | undefined>;
-    /**
-     * acquire one or more locks. Throws if unsuccessful. If *any* lock cannot be obtained, no locks are acquired
-     * @internal
-     */
-    acquireLocks: (arg: BriefcaseDbArg, locks: LockMap) => Promise<void>;
-    /**
-     * Get the list of all held locks for a briefcase. This can be very expensive and is currently used only for tests.
-     * @internal
-     */
-    queryAllLocks: (arg: BriefcaseDbArg) => Promise<LockProps[]>;
-    /**
-     * Release all currently held locks
-     * @internal
-     */
-    releaseAllLocks: (arg: BriefcaseDbArg) => Promise<void>;
-    /** Get the iModelId of an iModel by name. Undefined if no iModel with that name exists.  */
-    queryIModelByName: (arg: IModelNameArg) => Promise<GuidString | undefined>;
-    /** create a new iModel. Returns the Guid of the newly created iModel */
-    createNewIModel: (arg: CreateNewIModelProps) => Promise<GuidString>;
-    /** delete an iModel */
-    deleteIModel: (arg: IModelIdArg & ITwinIdArg) => Promise<void>;
-}
+/** @packageDocumentation
+ * @module HubAccess
+ */
+import { AccessToken, GuidString, Id64String } from "@itwin/core-bentley";
+import { BriefcaseId, ChangesetFileProps, ChangesetIdWithIndex, ChangesetIndex, ChangesetIndexAndId, ChangesetIndexOrId, ChangesetProps, ChangesetRange, IModelError, IModelVersion, LocalDirName, LocalFileName } from "@itwin/core-common";
+import { CheckpointProps, DownloadRequest, ProgressFunction } from "./CheckpointManager";
+import { TokenArg } from "./IModelDb";
+/** The state of a lock.
+ * @public
+ */
+export declare enum LockState {
+    /** The element is not locked */
+    None = 0,
+    /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */
+    Shared = 1,
+    /** A Lock that permits modifications to an element and blocks other users from making modifications to it.
+     * Holding an exclusive lock on an "owner" (a model or a parent element), implicitly exclusively locks all its members.
+     */
+    Exclusive = 2
+}
+/** Exception thrown if lock cannot be acquired.
+ * @beta
+*/
+export declare class LockConflict extends IModelError {
+    /** Id of Briefcase holding lock */
+    readonly briefcaseId: BriefcaseId;
+    /** Alias of Briefcase holding lock */
+    readonly briefcaseAlias: string;
+    constructor(
+    /** Id of Briefcase holding lock */
+    briefcaseId: BriefcaseId, 
+    /** Alias of Briefcase holding lock */
+    briefcaseAlias: string, msg: "shared lock is held" | "exclusive lock is already held");
+}
+/**
+ * The properties to access a V2 checkpoint through a daemon.
+ * @internal
+ */
+export interface V2CheckpointAccessProps {
+    /** blob store account name. */
+    readonly accountName: string;
+    /** AccessToken that grants access to the container. */
+    readonly sasToken: AccessToken;
+    /** The name of the iModel's blob store container holding all checkpoints. */
+    readonly containerId: string;
+    /** The name of the virtual file within the container, used for the checkpoint */
+    readonly dbName: string;
+    /** blob storage module: e.g. "azure", "google", "aws". May also include URI style parameters. */
+    readonly storageType: string;
+}
+/** @internal */
+export declare type LockMap = Map<Id64String, LockState>;
+/**
+ * The properties of a lock that may be obtained from a lock server.
+ * @beta
+ */
+export interface LockProps {
+    /** The elementId for the lock */
+    readonly id: Id64String;
+    /** the lock state */
+    readonly state: LockState;
+}
+/**
+ * Argument for cancelling and tracking download progress.
+ * @beta
+ */
+export interface DownloadProgressArg {
+    /** Called to show progress during a download. If this function returns non-zero, the download is aborted. */
+    progressCallback?: ProgressFunction;
+}
+/**
+ * Argument for methods that must supply an iTwinId
+ * @public
+ */
+export interface ITwinIdArg {
+    readonly iTwinId: GuidString;
+}
+/**
+ * Argument for methods that must supply an IModelId
+ * @public
+ */
+export interface IModelIdArg extends TokenArg {
+    readonly iModelId: GuidString;
+}
+/**
+ * Argument for acquiring a new BriefcaseId
+ * @public
+ */
+export interface AcquireNewBriefcaseIdArg extends IModelIdArg {
+    /** A string to be reported to other users to identify this briefcase, for example in the case of conflicts or lock collisions. */
+    readonly briefcaseAlias?: string;
+}
+/** Argument for methods that must supply an IModel name and iTwinId
+ * @public
+ */
+export interface IModelNameArg extends TokenArg, ITwinIdArg {
+    readonly iModelName: string;
+}
+/** Argument for methods that must supply an IModelId and a BriefcaseId
+ * @public
+ */
+export interface BriefcaseIdArg extends IModelIdArg {
+    readonly briefcaseId: BriefcaseId;
+}
+/** Argument for methods that must supply a briefcaseId and a changeset
+ * @public
+ */
+export interface BriefcaseDbArg extends BriefcaseIdArg {
+    readonly changeset: ChangesetIdWithIndex;
+}
+/** Argument for methods that must supply an IModelId and a changeset
+ * @public
+ */
+export interface ChangesetArg extends IModelIdArg {
+    readonly changeset: ChangesetIndexOrId;
+}
+/** Argument for downloading a changeset.
+ * @beta
+ */
+export interface DownloadChangesetArg extends ChangesetArg, DownloadProgressArg {
+    /** Directory where the changeset should be downloaded. */
+    targetDir: LocalDirName;
+}
+/** @internal */
+export interface ChangesetIndexArg extends IModelIdArg {
+    readonly changeset: ChangesetIdWithIndex;
+}
+/** Argument for methods that must supply an IModelId and a range of Changesets.
+ * @public
+ */
+export interface ChangesetRangeArg extends IModelIdArg {
+    /** the range of changesets desired. If is undefined, *all* changesets are returned. */
+    readonly range?: ChangesetRange;
+}
+/** Argument for downloading a changeset range.
+ * @beta
+ */
+export interface DownloadChangesetRangeArg extends ChangesetRangeArg, DownloadProgressArg {
+    /** Directory where the changesets should be downloaded. */
+    targetDir: LocalDirName;
+}
+/**
+ * @deprecated in 3.x.
+ * @internal
+ */
+export declare type CheckpointArg = DownloadRequest;
+/**
+ * Arguments to create a new iModel in iModelHub
+ *  @public
+ */
+export interface CreateNewIModelProps extends IModelNameArg {
+    readonly description?: string;
+    readonly version0?: LocalFileName;
+    readonly noLocks?: true;
+}
+/**
+ * Methods for accessing services of IModelHub from an iTwin.js backend.
+ * Generally direct access to these methods should not be required, since higher-level apis are provided.
+ * @beta
+ */
+export interface BackendHubAccess {
+    /** Download all the changesets in the specified range. */
+    downloadChangesets: (arg: DownloadChangesetRangeArg) => Promise<ChangesetFileProps[]>;
+    /** Download a single changeset. */
+    downloadChangeset: (arg: DownloadChangesetArg) => Promise<ChangesetFileProps>;
+    /** Query the changeset properties given a ChangesetIndex  */
+    queryChangeset: (arg: ChangesetArg) => Promise<ChangesetProps>;
+    /** Query an array of changeset properties given a range of ChangesetIndexes  */
+    queryChangesets: (arg: ChangesetRangeArg) => Promise<ChangesetProps[]>;
+    /** Push a changeset to iModelHub. Returns the newly pushed changeset's index */
+    pushChangeset: (arg: IModelIdArg & {
+        changesetProps: ChangesetFileProps;
+    }) => Promise<ChangesetIndex>;
+    /** Get the ChangesetProps of the most recent changeset */
+    getLatestChangeset: (arg: IModelIdArg) => Promise<ChangesetProps>;
+    /** Get the ChangesetProps for an IModelVersion */
+    getChangesetFromVersion: (arg: IModelIdArg & {
+        version: IModelVersion;
+    }) => Promise<ChangesetProps>;
+    /** Get the ChangesetProps for a named version */
+    getChangesetFromNamedVersion: (arg: IModelIdArg & {
+        versionName: string;
+    }) => Promise<ChangesetProps>;
+    /** Acquire a new briefcaseId for the supplied iModelId
+       * @note usually there should only be one briefcase per iModel per user.
+       */
+    acquireNewBriefcaseId: (arg: AcquireNewBriefcaseIdArg) => Promise<BriefcaseId>;
+    /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */
+    releaseBriefcase: (arg: BriefcaseIdArg) => Promise<void>;
+    /** get an array of the briefcases assigned to a user. */
+    getMyBriefcaseIds: (arg: IModelIdArg) => Promise<BriefcaseId[]>;
+    /**
+     * download a v1 checkpoint
+     * @deprecated in 3.x.
+     * @internal
+     */
+    downloadV1Checkpoint: (arg: CheckpointArg) => Promise<ChangesetIndexAndId>;
+    /**
+     * Get the access props for a V2 checkpoint. Returns undefined if no V2 checkpoint exists.
+     * @internal
+     */
+    queryV2Checkpoint: (arg: CheckpointProps) => Promise<V2CheckpointAccessProps | undefined>;
+    /**
+     * acquire one or more locks. Throws if unsuccessful. If *any* lock cannot be obtained, no locks are acquired
+     * @internal
+     */
+    acquireLocks: (arg: BriefcaseDbArg, locks: LockMap) => Promise<void>;
+    /**
+     * Get the list of all held locks for a briefcase. This can be very expensive and is currently used only for tests.
+     * @internal
+     */
+    queryAllLocks: (arg: BriefcaseDbArg) => Promise<LockProps[]>;
+    /**
+     * Release all currently held locks
+     * @internal
+     */
+    releaseAllLocks: (arg: BriefcaseDbArg) => Promise<void>;
+    /** Get the iModelId of an iModel by name. Undefined if no iModel with that name exists.  */
+    queryIModelByName: (arg: IModelNameArg) => Promise<GuidString | undefined>;
+    /** create a new iModel. Returns the Guid of the newly created iModel */
+    createNewIModel: (arg: CreateNewIModelProps) => Promise<GuidString>;
+    /** delete an iModel */
+    deleteIModel: (arg: IModelIdArg & ITwinIdArg) => Promise<void>;
+}
 //# sourceMappingURL=BackendHubAccess.d.ts.map

package/lib/cjs/BackendHubAccess.js

@@ -1,42 +1,42 @@
-"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 HubAccess
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LockConflict = exports.LockState = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_common_1 = require("@itwin/core-common");
-/** The state of a lock.
- * @public
- */
-var LockState;
-(function (LockState) {
-    /** The element is not locked */
-    LockState[LockState["None"] = 0] = "None";
-    /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */
-    LockState[LockState["Shared"] = 1] = "Shared";
-    /** A Lock that permits modifications to an element and blocks other users from making modifications to it.
-     * Holding an exclusive lock on an "owner" (a model or a parent element), implicitly exclusively locks all its members.
-     */
-    LockState[LockState["Exclusive"] = 2] = "Exclusive";
-})(LockState = exports.LockState || (exports.LockState = {}));
-/** Exception thrown if lock cannot be acquired.
- * @beta
-*/
-class LockConflict extends core_common_1.IModelError {
-    constructor(
-    /** Id of Briefcase holding lock */
-    briefcaseId, 
-    /** Alias of Briefcase holding lock */
-    briefcaseAlias, msg) {
-        super(core_bentley_1.IModelHubStatus.LockOwnedByAnotherBriefcase, msg);
-        this.briefcaseId = briefcaseId;
-        this.briefcaseAlias = briefcaseAlias;
-    }
-}
-exports.LockConflict = LockConflict;
+"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 HubAccess
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LockConflict = exports.LockState = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+/** The state of a lock.
+ * @public
+ */
+var LockState;
+(function (LockState) {
+    /** The element is not locked */
+    LockState[LockState["None"] = 0] = "None";
+    /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */
+    LockState[LockState["Shared"] = 1] = "Shared";
+    /** A Lock that permits modifications to an element and blocks other users from making modifications to it.
+     * Holding an exclusive lock on an "owner" (a model or a parent element), implicitly exclusively locks all its members.
+     */
+    LockState[LockState["Exclusive"] = 2] = "Exclusive";
+})(LockState = exports.LockState || (exports.LockState = {}));
+/** Exception thrown if lock cannot be acquired.
+ * @beta
+*/
+class LockConflict extends core_common_1.IModelError {
+    constructor(
+    /** Id of Briefcase holding lock */
+    briefcaseId, 
+    /** Alias of Briefcase holding lock */
+    briefcaseAlias, msg) {
+        super(core_bentley_1.IModelHubStatus.LockOwnedByAnotherBriefcase, msg);
+        this.briefcaseId = briefcaseId;
+        this.briefcaseAlias = briefcaseAlias;
+    }
+}
+exports.LockConflict = LockConflict;
 //# sourceMappingURL=BackendHubAccess.js.map

package/lib/cjs/BackendHubAccess.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackendHubAccess.js","sourceRoot":"","sources":["../../src/BackendHubAccess.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA2F;AAC3F,oDAG4B;AAI5B;;GAEG;AACH,IAAY,SASX;AATD,WAAY,SAAS;IACnB,gCAAgC;IAChC,yCAAQ,CAAA;IACR,mJAAmJ;IACnJ,6CAAU,CAAA;IACV;;OAEG;IACH,mDAAa,CAAA;AACf,CAAC,EATW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QASpB;AAED;;EAEE;AACF,MAAa,YAAa,SAAQ,yBAAW;IAC3C;IACE,mCAAmC;IACnB,WAAwB;IACxC,sCAAsC;IACtB,cAAsB,EACtC,GAA6D;QAE7D,KAAK,CAAC,8BAAe,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAC;QALxC,gBAAW,GAAX,WAAW,CAAa;QAExB,mBAAc,GAAd,cAAc,CAAQ;IAIxC,CAAC;CACF;AAVD,oCAUC","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 HubAccess\r\n */\r\n\r\nimport { AccessToken, GuidString, Id64String, IModelHubStatus } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseId, ChangesetFileProps, ChangesetIdWithIndex, ChangesetIndex, ChangesetIndexAndId, ChangesetIndexOrId, ChangesetProps, ChangesetRange,\r\n  IModelError, IModelVersion, LocalDirName, LocalFileName,\r\n} from \"@itwin/core-common\";\r\nimport { CheckpointProps, DownloadRequest, ProgressFunction } from \"./CheckpointManager\";\r\nimport { TokenArg } from \"./IModelDb\";\r\n\r\n/** The state of a lock.\r\n * @public\r\n */\r\nexport enum LockState {\r\n  /** The element is not locked */\r\n  None = 0,\r\n  /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */\r\n  Shared = 1,\r\n  /** A Lock that permits modifications to an element and blocks other users from making modifications to it.\r\n   * Holding an exclusive lock on an \"owner\" (a model or a parent element), implicitly exclusively locks all its members.\r\n   */\r\n  Exclusive = 2,\r\n}\r\n\r\n/** Exception thrown if lock cannot be acquired.\r\n * @beta\r\n*/\r\nexport class LockConflict extends IModelError {\r\n  public constructor(\r\n    /** Id of Briefcase holding lock */\r\n    public readonly briefcaseId: BriefcaseId,\r\n    /** Alias of Briefcase holding lock */\r\n    public readonly briefcaseAlias: string,\r\n    msg: \"shared lock is held\" | \"exclusive lock is already held\"\r\n  ) {\r\n    super(IModelHubStatus.LockOwnedByAnotherBriefcase, msg);\r\n  }\r\n}\r\n\r\n/**\r\n * The properties to access a V2 checkpoint through a daemon.\r\n * @internal\r\n */\r\nexport interface V2CheckpointAccessProps {\r\n  /** blob store account name. */\r\n  readonly accountName: string;\r\n  /** AccessToken that grants access to the container. */\r\n  readonly sasToken: AccessToken;\r\n  /** The name of the iModel's blob store container holding all checkpoints. */\r\n  readonly containerId: string;\r\n  /** The name of the virtual file within the container, used for the checkpoint */\r\n  readonly dbName: string;\r\n  /** blob storage module: e.g. \"azure\", \"google\", \"aws\". May also include URI style parameters. */\r\n  readonly storageType: string;\r\n}\r\n\r\n/** @internal */\r\nexport type LockMap = Map<Id64String, LockState>;\r\n\r\n/**\r\n * The properties of a lock that may be obtained from a lock server.\r\n * @beta\r\n */\r\nexport interface LockProps {\r\n  /** The elementId for the lock */\r\n  readonly id: Id64String;\r\n  /** the lock state */\r\n  readonly state: LockState;\r\n}\r\n\r\n/**\r\n * Argument for cancelling and tracking download progress.\r\n * @beta\r\n */\r\nexport interface DownloadProgressArg {\r\n  /** Called to show progress during a download. If this function returns non-zero, the download is aborted. */\r\n  progressCallback?: ProgressFunction;\r\n}\r\n\r\n/**\r\n * Argument for methods that must supply an iTwinId\r\n * @public\r\n */\r\nexport interface ITwinIdArg {\r\n  readonly iTwinId: GuidString;\r\n}\r\n\r\n/**\r\n * Argument for methods that must supply an IModelId\r\n * @public\r\n */\r\nexport interface IModelIdArg extends TokenArg {\r\n  readonly iModelId: GuidString;\r\n}\r\n\r\n/**\r\n * Argument for acquiring a new BriefcaseId\r\n * @public\r\n */\r\nexport interface AcquireNewBriefcaseIdArg extends IModelIdArg {\r\n  /** A string to be reported to other users to identify this briefcase, for example in the case of conflicts or lock collisions. */\r\n  readonly briefcaseAlias?: string;\r\n}\r\n\r\n/** Argument for methods that must supply an IModel name and iTwinId\r\n * @public\r\n */\r\nexport interface IModelNameArg extends TokenArg, ITwinIdArg {\r\n  readonly iModelName: string;\r\n}\r\n\r\n/** Argument for methods that must supply an IModelId and a BriefcaseId\r\n * @public\r\n */\r\nexport interface BriefcaseIdArg extends IModelIdArg {\r\n  readonly briefcaseId: BriefcaseId;\r\n}\r\n\r\n/** Argument for methods that must supply a briefcaseId and a changeset\r\n * @public\r\n */\r\nexport interface BriefcaseDbArg extends BriefcaseIdArg {\r\n  readonly changeset: ChangesetIdWithIndex;\r\n}\r\n\r\n/** Argument for methods that must supply an IModelId and a changeset\r\n * @public\r\n */\r\nexport interface ChangesetArg extends IModelIdArg {\r\n  readonly changeset: ChangesetIndexOrId;\r\n}\r\n\r\n/** Argument for downloading a changeset.\r\n * @beta\r\n */\r\nexport interface DownloadChangesetArg extends ChangesetArg, DownloadProgressArg {\r\n  /** Directory where the changeset should be downloaded. */\r\n  targetDir: LocalDirName;\r\n}\r\n\r\n/** @internal */\r\nexport interface ChangesetIndexArg extends IModelIdArg {\r\n  readonly changeset: ChangesetIdWithIndex;\r\n}\r\n\r\n/** Argument for methods that must supply an IModelId and a range of Changesets.\r\n * @public\r\n */\r\nexport interface ChangesetRangeArg extends IModelIdArg {\r\n  /** the range of changesets desired. If is undefined, *all* changesets are returned. */\r\n  readonly range?: ChangesetRange;\r\n}\r\n\r\n/** Argument for downloading a changeset range.\r\n * @beta\r\n */\r\nexport interface DownloadChangesetRangeArg extends ChangesetRangeArg, DownloadProgressArg {\r\n  /** Directory where the changesets should be downloaded. */\r\n  targetDir: LocalDirName;\r\n}\r\n\r\n/**\r\n * @deprecated\r\n * @internal\r\n */\r\nexport type CheckpointArg = DownloadRequest;\r\n\r\n/**\r\n * Arguments to create a new iModel in iModelHub\r\n *  @public\r\n */\r\nexport interface CreateNewIModelProps extends IModelNameArg {\r\n  readonly description?: string;\r\n  readonly version0?: LocalFileName;\r\n  readonly noLocks?: true;\r\n}\r\n\r\n/**\r\n * Methods for accessing services of IModelHub from an iTwin.js backend.\r\n * Generally direct access to these methods should not be required, since higher-level apis are provided.\r\n * @beta\r\n */\r\nexport interface BackendHubAccess {\r\n  /** Download all the changesets in the specified range. */\r\n  downloadChangesets: (arg: DownloadChangesetRangeArg) => Promise<ChangesetFileProps[]>;\r\n  /** Download a single changeset. */\r\n  downloadChangeset: (arg: DownloadChangesetArg) => Promise<ChangesetFileProps>;\r\n  /** Query the changeset properties given a ChangesetIndex  */\r\n  queryChangeset: (arg: ChangesetArg) => Promise<ChangesetProps>;\r\n  /** Query an array of changeset properties given a range of ChangesetIndexes  */\r\n  queryChangesets: (arg: ChangesetRangeArg) => Promise<ChangesetProps[]>;\r\n  /** Push a changeset to iModelHub. Returns the newly pushed changeset's index */\r\n  pushChangeset: (arg: IModelIdArg & { changesetProps: ChangesetFileProps }) => Promise<ChangesetIndex>;\r\n  /** Get the ChangesetProps of the most recent changeset */\r\n  getLatestChangeset: (arg: IModelIdArg) => Promise<ChangesetProps>;\r\n  /** Get the ChangesetProps for an IModelVersion */\r\n  getChangesetFromVersion: (arg: IModelIdArg & { version: IModelVersion }) => Promise<ChangesetProps>;\r\n  /** Get the ChangesetProps for a named version */\r\n  getChangesetFromNamedVersion: (arg: IModelIdArg & { versionName: string }) => Promise<ChangesetProps>;\r\n\r\n  /** Acquire a new briefcaseId for the supplied iModelId\r\n     * @note usually there should only be one briefcase per iModel per user.\r\n     */\r\n  acquireNewBriefcaseId: (arg: AcquireNewBriefcaseIdArg) => Promise<BriefcaseId>;\r\n  /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */\r\n  releaseBriefcase: (arg: BriefcaseIdArg) => Promise<void>;\r\n\r\n  /** get an array of the briefcases assigned to a user. */\r\n  getMyBriefcaseIds: (arg: IModelIdArg) => Promise<BriefcaseId[]>;\r\n\r\n  /**\r\n   * download a v1 checkpoint\r\n   * @deprecated\r\n   * @internal\r\n   */\r\n  downloadV1Checkpoint: (arg: CheckpointArg) => Promise<ChangesetIndexAndId>; // eslint-disable-line deprecation/deprecation\r\n\r\n  /**\r\n   * Get the access props for a V2 checkpoint. Returns undefined if no V2 checkpoint exists.\r\n   * @internal\r\n   */\r\n  queryV2Checkpoint: (arg: CheckpointProps) => Promise<V2CheckpointAccessProps | undefined>;\r\n\r\n  /**\r\n   * acquire one or more locks. Throws if unsuccessful. If *any* lock cannot be obtained, no locks are acquired\r\n   * @internal\r\n   */\r\n  acquireLocks: (arg: BriefcaseDbArg, locks: LockMap) => Promise<void>;\r\n\r\n  /**\r\n   * Get the list of all held locks for a briefcase. This can be very expensive and is currently used only for tests.\r\n   * @internal\r\n   */\r\n  queryAllLocks: (arg: BriefcaseDbArg) => Promise<LockProps[]>;\r\n\r\n  /**\r\n   * Release all currently held locks\r\n   * @internal\r\n   */\r\n  releaseAllLocks: (arg: BriefcaseDbArg) => Promise<void>;\r\n\r\n  /** Get the iModelId of an iModel by name. Undefined if no iModel with that name exists.  */\r\n  queryIModelByName: (arg: IModelNameArg) => Promise<GuidString | undefined>;\r\n\r\n  /** create a new iModel. Returns the Guid of the newly created iModel */\r\n  createNewIModel: (arg: CreateNewIModelProps) => Promise<GuidString>;\r\n\r\n  /** delete an iModel */\r\n  deleteIModel: (arg: IModelIdArg & ITwinIdArg) => Promise<void>;\r\n}\r\n"]}
+{"version":3,"file":"BackendHubAccess.js","sourceRoot":"","sources":["../../src/BackendHubAccess.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA2F;AAC3F,oDAG4B;AAI5B;;GAEG;AACH,IAAY,SASX;AATD,WAAY,SAAS;IACnB,gCAAgC;IAChC,yCAAQ,CAAA;IACR,mJAAmJ;IACnJ,6CAAU,CAAA;IACV;;OAEG;IACH,mDAAa,CAAA;AACf,CAAC,EATW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QASpB;AAED;;EAEE;AACF,MAAa,YAAa,SAAQ,yBAAW;IAC3C;IACE,mCAAmC;IACnB,WAAwB;IACxC,sCAAsC;IACtB,cAAsB,EACtC,GAA6D;QAE7D,KAAK,CAAC,8BAAe,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAC;QALxC,gBAAW,GAAX,WAAW,CAAa;QAExB,mBAAc,GAAd,cAAc,CAAQ;IAIxC,CAAC;CACF;AAVD,oCAUC","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 HubAccess\n */\n\nimport { AccessToken, GuidString, Id64String, IModelHubStatus } from \"@itwin/core-bentley\";\nimport {\n  BriefcaseId, ChangesetFileProps, ChangesetIdWithIndex, ChangesetIndex, ChangesetIndexAndId, ChangesetIndexOrId, ChangesetProps, ChangesetRange,\n  IModelError, IModelVersion, LocalDirName, LocalFileName,\n} from \"@itwin/core-common\";\nimport { CheckpointProps, DownloadRequest, ProgressFunction } from \"./CheckpointManager\";\nimport { TokenArg } from \"./IModelDb\";\n\n/** The state of a lock.\n * @public\n */\nexport enum LockState {\n  /** The element is not locked */\n  None = 0,\n  /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */\n  Shared = 1,\n  /** A Lock that permits modifications to an element and blocks other users from making modifications to it.\n   * Holding an exclusive lock on an \"owner\" (a model or a parent element), implicitly exclusively locks all its members.\n   */\n  Exclusive = 2,\n}\n\n/** Exception thrown if lock cannot be acquired.\n * @beta\n*/\nexport class LockConflict extends IModelError {\n  public constructor(\n    /** Id of Briefcase holding lock */\n    public readonly briefcaseId: BriefcaseId,\n    /** Alias of Briefcase holding lock */\n    public readonly briefcaseAlias: string,\n    msg: \"shared lock is held\" | \"exclusive lock is already held\"\n  ) {\n    super(IModelHubStatus.LockOwnedByAnotherBriefcase, msg);\n  }\n}\n\n/**\n * The properties to access a V2 checkpoint through a daemon.\n * @internal\n */\nexport interface V2CheckpointAccessProps {\n  /** blob store account name. */\n  readonly accountName: string;\n  /** AccessToken that grants access to the container. */\n  readonly sasToken: AccessToken;\n  /** The name of the iModel's blob store container holding all checkpoints. */\n  readonly containerId: string;\n  /** The name of the virtual file within the container, used for the checkpoint */\n  readonly dbName: string;\n  /** blob storage module: e.g. \"azure\", \"google\", \"aws\". May also include URI style parameters. */\n  readonly storageType: string;\n}\n\n/** @internal */\nexport type LockMap = Map<Id64String, LockState>;\n\n/**\n * The properties of a lock that may be obtained from a lock server.\n * @beta\n */\nexport interface LockProps {\n  /** The elementId for the lock */\n  readonly id: Id64String;\n  /** the lock state */\n  readonly state: LockState;\n}\n\n/**\n * Argument for cancelling and tracking download progress.\n * @beta\n */\nexport interface DownloadProgressArg {\n  /** Called to show progress during a download. If this function returns non-zero, the download is aborted. */\n  progressCallback?: ProgressFunction;\n}\n\n/**\n * Argument for methods that must supply an iTwinId\n * @public\n */\nexport interface ITwinIdArg {\n  readonly iTwinId: GuidString;\n}\n\n/**\n * Argument for methods that must supply an IModelId\n * @public\n */\nexport interface IModelIdArg extends TokenArg {\n  readonly iModelId: GuidString;\n}\n\n/**\n * Argument for acquiring a new BriefcaseId\n * @public\n */\nexport interface AcquireNewBriefcaseIdArg extends IModelIdArg {\n  /** A string to be reported to other users to identify this briefcase, for example in the case of conflicts or lock collisions. */\n  readonly briefcaseAlias?: string;\n}\n\n/** Argument for methods that must supply an IModel name and iTwinId\n * @public\n */\nexport interface IModelNameArg extends TokenArg, ITwinIdArg {\n  readonly iModelName: string;\n}\n\n/** Argument for methods that must supply an IModelId and a BriefcaseId\n * @public\n */\nexport interface BriefcaseIdArg extends IModelIdArg {\n  readonly briefcaseId: BriefcaseId;\n}\n\n/** Argument for methods that must supply a briefcaseId and a changeset\n * @public\n */\nexport interface BriefcaseDbArg extends BriefcaseIdArg {\n  readonly changeset: ChangesetIdWithIndex;\n}\n\n/** Argument for methods that must supply an IModelId and a changeset\n * @public\n */\nexport interface ChangesetArg extends IModelIdArg {\n  readonly changeset: ChangesetIndexOrId;\n}\n\n/** Argument for downloading a changeset.\n * @beta\n */\nexport interface DownloadChangesetArg extends ChangesetArg, DownloadProgressArg {\n  /** Directory where the changeset should be downloaded. */\n  targetDir: LocalDirName;\n}\n\n/** @internal */\nexport interface ChangesetIndexArg extends IModelIdArg {\n  readonly changeset: ChangesetIdWithIndex;\n}\n\n/** Argument for methods that must supply an IModelId and a range of Changesets.\n * @public\n */\nexport interface ChangesetRangeArg extends IModelIdArg {\n  /** the range of changesets desired. If is undefined, *all* changesets are returned. */\n  readonly range?: ChangesetRange;\n}\n\n/** Argument for downloading a changeset range.\n * @beta\n */\nexport interface DownloadChangesetRangeArg extends ChangesetRangeArg, DownloadProgressArg {\n  /** Directory where the changesets should be downloaded. */\n  targetDir: LocalDirName;\n}\n\n/**\n * @deprecated in 3.x.\n * @internal\n */\nexport type CheckpointArg = DownloadRequest;\n\n/**\n * Arguments to create a new iModel in iModelHub\n *  @public\n */\nexport interface CreateNewIModelProps extends IModelNameArg {\n  readonly description?: string;\n  readonly version0?: LocalFileName;\n  readonly noLocks?: true;\n}\n\n/**\n * Methods for accessing services of IModelHub from an iTwin.js backend.\n * Generally direct access to these methods should not be required, since higher-level apis are provided.\n * @beta\n */\nexport interface BackendHubAccess {\n  /** Download all the changesets in the specified range. */\n  downloadChangesets: (arg: DownloadChangesetRangeArg) => Promise<ChangesetFileProps[]>;\n  /** Download a single changeset. */\n  downloadChangeset: (arg: DownloadChangesetArg) => Promise<ChangesetFileProps>;\n  /** Query the changeset properties given a ChangesetIndex  */\n  queryChangeset: (arg: ChangesetArg) => Promise<ChangesetProps>;\n  /** Query an array of changeset properties given a range of ChangesetIndexes  */\n  queryChangesets: (arg: ChangesetRangeArg) => Promise<ChangesetProps[]>;\n  /** Push a changeset to iModelHub. Returns the newly pushed changeset's index */\n  pushChangeset: (arg: IModelIdArg & { changesetProps: ChangesetFileProps }) => Promise<ChangesetIndex>;\n  /** Get the ChangesetProps of the most recent changeset */\n  getLatestChangeset: (arg: IModelIdArg) => Promise<ChangesetProps>;\n  /** Get the ChangesetProps for an IModelVersion */\n  getChangesetFromVersion: (arg: IModelIdArg & { version: IModelVersion }) => Promise<ChangesetProps>;\n  /** Get the ChangesetProps for a named version */\n  getChangesetFromNamedVersion: (arg: IModelIdArg & { versionName: string }) => Promise<ChangesetProps>;\n\n  /** Acquire a new briefcaseId for the supplied iModelId\n     * @note usually there should only be one briefcase per iModel per user.\n     */\n  acquireNewBriefcaseId: (arg: AcquireNewBriefcaseIdArg) => Promise<BriefcaseId>;\n  /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */\n  releaseBriefcase: (arg: BriefcaseIdArg) => Promise<void>;\n\n  /** get an array of the briefcases assigned to a user. */\n  getMyBriefcaseIds: (arg: IModelIdArg) => Promise<BriefcaseId[]>;\n\n  /**\n   * download a v1 checkpoint\n   * @deprecated in 3.x.\n   * @internal\n   */\n  downloadV1Checkpoint: (arg: CheckpointArg) => Promise<ChangesetIndexAndId>; // eslint-disable-line deprecation/deprecation\n\n  /**\n   * Get the access props for a V2 checkpoint. Returns undefined if no V2 checkpoint exists.\n   * @internal\n   */\n  queryV2Checkpoint: (arg: CheckpointProps) => Promise<V2CheckpointAccessProps | undefined>;\n\n  /**\n   * acquire one or more locks. Throws if unsuccessful. If *any* lock cannot be obtained, no locks are acquired\n   * @internal\n   */\n  acquireLocks: (arg: BriefcaseDbArg, locks: LockMap) => Promise<void>;\n\n  /**\n   * Get the list of all held locks for a briefcase. This can be very expensive and is currently used only for tests.\n   * @internal\n   */\n  queryAllLocks: (arg: BriefcaseDbArg) => Promise<LockProps[]>;\n\n  /**\n   * Release all currently held locks\n   * @internal\n   */\n  releaseAllLocks: (arg: BriefcaseDbArg) => Promise<void>;\n\n  /** Get the iModelId of an iModel by name. Undefined if no iModel with that name exists.  */\n  queryIModelByName: (arg: IModelNameArg) => Promise<GuidString | undefined>;\n\n  /** create a new iModel. Returns the Guid of the newly created iModel */\n  createNewIModel: (arg: CreateNewIModelProps) => Promise<GuidString>;\n\n  /** delete an iModel */\n  deleteIModel: (arg: IModelIdArg & ITwinIdArg) => Promise<void>;\n}\n"]}