@itwin/core-backend 3.4.0 → 3.4.1

package/lib/cjs/BriefcaseManager.d.ts

@@ -1,166 +1,166 @@
-/** @packageDocumentation
- * @module iModels
- */
-import { AccessToken, BeDuration, GuidString } from "@itwin/core-bentley";
-import { BriefcaseId, BriefcaseProps, ChangesetIndex, LocalBriefcaseProps, LocalDirName, LocalFileName, RequestNewBriefcaseProps, RpcActivity } from "@itwin/core-common";
-import { AcquireNewBriefcaseIdArg } from "./BackendHubAccess";
-import { ProgressFunction } from "./CheckpointManager";
-import { BriefcaseDb, IModelDb, TokenArg } from "./IModelDb";
-/** The argument for [[BriefcaseManager.downloadBriefcase]]
- * @public
-*/
-export interface RequestNewBriefcaseArg extends TokenArg, RequestNewBriefcaseProps {
-    /** If present, a function called periodically during the download to indicate progress.
-     * @note return non-zero from this function to abort the download.
-     */
-    onProgress?: ProgressFunction;
-}
-/**
- * Parameters for pushing changesets to iModelHub
- * @public
- */
-export interface PushChangesArgs extends TokenArg {
-    /** A description of the changes. This is visible on the iModel's timeline. */
-    description: string;
-    /** if present, the locks are retained after the operation. Otherwise, *all* locks are released after the changeset is successfully pushed. */
-    retainLocks?: true;
-    /** number of times to retry pull/merge if other users are pushing at the same time. Default is 5 */
-    mergeRetryCount?: number;
-    /** delay to wait between pull/merge retry attempts. Default is 3 seconds */
-    mergeRetryDelay?: BeDuration;
-    /** the number of time to attempt to retry to push the changeset upon failure. Default is 3 */
-    pushRetryCount?: number;
-    /** The delay to wait between retry attempts on failed pushes. Default is 3 seconds. */
-    pushRetryDelay?: BeDuration;
-}
-/**
- * Specifies a specific index for pulling changes.
- * @public
- */
-export interface ToChangesetArgs extends TokenArg {
-    /** The last ChangesetIndex to pull. If not present, pull *all* newer changesets. */
-    toIndex?: ChangesetIndex;
-}
-/** Arguments for [[BriefcaseManager.pullAndApplyChangesets]]
- * @public
- */
-export declare type PullChangesArgs = ToChangesetArgs;
-/** Manages downloading Briefcases and downloading and uploading changesets.
- * @public
- */
-export declare class BriefcaseManager {
-    /** Get the local path of the folder storing files that are associated with an imodel */
-    static getIModelPath(iModelId: GuidString): LocalDirName;
-    /** @internal */
-    static getChangeSetsPath(iModelId: GuidString): LocalDirName;
-    /** @internal */
-    static getChangeCachePathName(iModelId: GuidString): LocalFileName;
-    /** @internal */
-    static getChangedElementsPathName(iModelId: GuidString): LocalFileName;
-    private static _briefcaseSubDir;
-    /** @internal */
-    static getBriefcaseBasePath(iModelId: GuidString): LocalDirName;
-    /** Get the name of the local file that holds, or will hold, a local briefcase in the briefcase cache.
-     * @note The briefcase cache is a local directory established in the call to [[BriefcaseManager.initialize]].
-     * @param briefcase the iModelId and BriefcaseId for the filename
-     * @see getIModelPath
-     */
-    static getFileName(briefcase: BriefcaseProps): LocalFileName;
-    private static setupCacheDir;
-    private static _initialized?;
-    /** Initialize BriefcaseManager
-     * @param cacheRootDir The root directory for storing a cache of downloaded briefcase files on the local computer.
-     * Briefcases are stored relative to this path in sub-folders organized by IModelId.
-     * @note It is perfectly valid for applications to store briefcases in locations they manage, outside of `cacheRootDir`.
-     */
-    static initialize(cacheRootDir: LocalDirName): void;
-    private static finalize;
-    /** Get a list of the local briefcase held in the briefcase cache, optionally for a single iModelId
-     * @param iModelId if present, only briefcases for this iModelId are returned, otherwise all briefcases for all
-     * iModels in the briefcase cache are returned.
-     * @note usually there should only be one briefcase per iModel.
-     */
-    static getCachedBriefcases(iModelId?: GuidString): LocalBriefcaseProps[];
-    private static _cacheDir;
-    /** Get the root directory for the briefcase cache */
-    static get cacheDir(): LocalDirName;
-    /** Determine whether the supplied briefcaseId is in the range of assigned BriefcaseIds issued by iModelHub
-     * @note this does check whether the id was actually acquired by the caller.
-     */
-    static isValidBriefcaseId(id: BriefcaseId): boolean;
-    /** Acquire a new briefcaseId from iModelHub for the supplied iModelId
-     * @note usually there should only be one briefcase per iModel per user. If a single user acquires more than one briefcaseId,
-     * it's a good idea to supply different aliases for each of them.
-     */
-    static acquireNewBriefcaseId(arg: AcquireNewBriefcaseIdArg): Promise<BriefcaseId>;
-    /**
-     * Download a new briefcase from iModelHub for the supplied iModelId.
-     *
-     * Briefcases are local files holding a copy of an iModel.
-     * Briefcases may either be specific to an individual user (so that it can be modified to create changesets), or it can be readonly so it can accept but not create changesets.
-     * Every briefcase internally holds its [[BriefcaseId]]. Writeable briefcases have a `BriefcaseId` "assigned" to them by iModelHub. No two users will ever have the same BriefcaseId.
-     * Readonly briefcases are "unassigned" with the special value [[BriefcaseId.Unassigned]].
-     *
-     * Typically a given user will have only one briefcase on their machine for a given iModelId. Rarely, it may be necessary to use more than one
-     * briefcase to make isolated independent sets of changes, but that is exceedingly complicated and rare.
-     *
-     * Callers of this method may supply a BriefcaseId, or if none is supplied, a new one is acquired from iModelHub.
-     *
-     * @param arg The arguments that specify the briefcase file to be downloaded.
-     * @returns The properties of the local briefcase in a Promise that is resolved after the briefcase is fully downloaded and the briefcase file is ready for use via [BriefcaseDb.open]($backend).
-     * @note The location of the local file to hold the briefcase is arbitrary and may be any valid *local* path on your machine. If you don't supply
-     * a filename, the local briefcase cache is used by creating a file with the briefcaseId as its name in the `briefcases` folder below the folder named
-     * for the IModelId.
-     * @note *It is invalid to edit briefcases on a shared network drive* and that is a sure way to corrupt your briefcase (see https://www.sqlite.org/howtocorrupt.html)
-     */
-    static downloadBriefcase(arg: RequestNewBriefcaseArg): Promise<LocalBriefcaseProps>;
-    /** Deletes change sets of an iModel from local disk
-     * @internal
-     */
-    static deleteChangeSetsFromLocalDisk(iModelId: string): void;
-    /** Releases a briefcaseId from iModelHub. After this call it is illegal to generate changesets for the released briefcaseId.
-     * @note generally, this method should not be called directly. Instead use [[deleteBriefcaseFiles]].
-     * @see deleteBriefcaseFiles
-     */
-    static releaseBriefcase(accessToken: AccessToken, briefcase: BriefcaseProps): Promise<void>;
-    /**
-     * Delete and clean up a briefcase and all of its associated files. First, this method opens the supplied filename to determine its briefcaseId.
-     * Then, if a requestContext is supplied, it releases a BriefcaseId from iModelHub. Finally it deletes the local briefcase file and
-     * associated files (that is, all files in the same directory that start with the briefcase name).
-     * @param filePath the full file name of the Briefcase to delete
-     * @param accessToken for releasing the briefcaseId
-     */
-    static deleteBriefcaseFiles(filePath: LocalFileName, accessToken?: AccessToken): Promise<void>;
-    /** Deletes a file
-     *  - Does not throw any error, but logs it instead
-     *  - Returns true if the delete was successful
-     */
-    private static deleteFile;
-    /** Deletes a folder, checking if it's empty
-     *  - Does not throw any error, but logs it instead
-     *  - Returns true if the delete was successful
-     */
-    private static deleteFolderIfEmpty;
-    /** Deletes the contents of a folder, but not the folder itself
-     *  - Does not throw any errors, but logs them.
-     *  - returns true if the delete was successful.
-     */
-    private static deleteFolderContents;
-    /** Deletes a folder and all it's contents.
-     *  - Does not throw any errors, but logs them.
-     *  - returns true if the delete was successful.
-     */
-    private static deleteFolderAndContents;
-    private static applySingleChangeset;
-    /** @internal */
-    static pullAndApplyChangesets(db: IModelDb, arg: ToChangesetArgs): Promise<void>;
-    /** create a changeset from the current changes, and push it to iModelHub */
-    private static pushChanges;
-    /** Pull/merge (if necessary), then push all local changes as a changeset. Called by [[BriefcaseDb.pushChanges]]
-     * @internal
-     */
-    static pullMergePush(db: BriefcaseDb, arg: PushChangesArgs): Promise<void>;
-    /** @internal */
-    static logUsage(imodel: IModelDb, activity?: RpcActivity): void;
-}
+/** @packageDocumentation
+ * @module iModels
+ */
+import { AccessToken, BeDuration, GuidString } from "@itwin/core-bentley";
+import { BriefcaseId, BriefcaseProps, ChangesetIndex, LocalBriefcaseProps, LocalDirName, LocalFileName, RequestNewBriefcaseProps, RpcActivity } from "@itwin/core-common";
+import { AcquireNewBriefcaseIdArg } from "./BackendHubAccess";
+import { ProgressFunction } from "./CheckpointManager";
+import { BriefcaseDb, IModelDb, TokenArg } from "./IModelDb";
+/** The argument for [[BriefcaseManager.downloadBriefcase]]
+ * @public
+*/
+export interface RequestNewBriefcaseArg extends TokenArg, RequestNewBriefcaseProps {
+    /** If present, a function called periodically during the download to indicate progress.
+     * @note return non-zero from this function to abort the download.
+     */
+    onProgress?: ProgressFunction;
+}
+/**
+ * Parameters for pushing changesets to iModelHub
+ * @public
+ */
+export interface PushChangesArgs extends TokenArg {
+    /** A description of the changes. This is visible on the iModel's timeline. */
+    description: string;
+    /** if present, the locks are retained after the operation. Otherwise, *all* locks are released after the changeset is successfully pushed. */
+    retainLocks?: true;
+    /** number of times to retry pull/merge if other users are pushing at the same time. Default is 5 */
+    mergeRetryCount?: number;
+    /** delay to wait between pull/merge retry attempts. Default is 3 seconds */
+    mergeRetryDelay?: BeDuration;
+    /** the number of time to attempt to retry to push the changeset upon failure. Default is 3 */
+    pushRetryCount?: number;
+    /** The delay to wait between retry attempts on failed pushes. Default is 3 seconds. */
+    pushRetryDelay?: BeDuration;
+}
+/**
+ * Specifies a specific index for pulling changes.
+ * @public
+ */
+export interface ToChangesetArgs extends TokenArg {
+    /** The last ChangesetIndex to pull. If not present, pull *all* newer changesets. */
+    toIndex?: ChangesetIndex;
+}
+/** Arguments for [[BriefcaseManager.pullAndApplyChangesets]]
+ * @public
+ */
+export declare type PullChangesArgs = ToChangesetArgs;
+/** Manages downloading Briefcases and downloading and uploading changesets.
+ * @public
+ */
+export declare class BriefcaseManager {
+    /** Get the local path of the folder storing files that are associated with an imodel */
+    static getIModelPath(iModelId: GuidString): LocalDirName;
+    /** @internal */
+    static getChangeSetsPath(iModelId: GuidString): LocalDirName;
+    /** @internal */
+    static getChangeCachePathName(iModelId: GuidString): LocalFileName;
+    /** @internal */
+    static getChangedElementsPathName(iModelId: GuidString): LocalFileName;
+    private static _briefcaseSubDir;
+    /** @internal */
+    static getBriefcaseBasePath(iModelId: GuidString): LocalDirName;
+    /** Get the name of the local file that holds, or will hold, a local briefcase in the briefcase cache.
+     * @note The briefcase cache is a local directory established in the call to [[BriefcaseManager.initialize]].
+     * @param briefcase the iModelId and BriefcaseId for the filename
+     * @see getIModelPath
+     */
+    static getFileName(briefcase: BriefcaseProps): LocalFileName;
+    private static setupCacheDir;
+    private static _initialized?;
+    /** Initialize BriefcaseManager
+     * @param cacheRootDir The root directory for storing a cache of downloaded briefcase files on the local computer.
+     * Briefcases are stored relative to this path in sub-folders organized by IModelId.
+     * @note It is perfectly valid for applications to store briefcases in locations they manage, outside of `cacheRootDir`.
+     */
+    static initialize(cacheRootDir: LocalDirName): void;
+    private static finalize;
+    /** Get a list of the local briefcase held in the briefcase cache, optionally for a single iModelId
+     * @param iModelId if present, only briefcases for this iModelId are returned, otherwise all briefcases for all
+     * iModels in the briefcase cache are returned.
+     * @note usually there should only be one briefcase per iModel.
+     */
+    static getCachedBriefcases(iModelId?: GuidString): LocalBriefcaseProps[];
+    private static _cacheDir;
+    /** Get the root directory for the briefcase cache */
+    static get cacheDir(): LocalDirName;
+    /** Determine whether the supplied briefcaseId is in the range of assigned BriefcaseIds issued by iModelHub
+     * @note this does check whether the id was actually acquired by the caller.
+     */
+    static isValidBriefcaseId(id: BriefcaseId): boolean;
+    /** Acquire a new briefcaseId from iModelHub for the supplied iModelId
+     * @note usually there should only be one briefcase per iModel per user. If a single user acquires more than one briefcaseId,
+     * it's a good idea to supply different aliases for each of them.
+     */
+    static acquireNewBriefcaseId(arg: AcquireNewBriefcaseIdArg): Promise<BriefcaseId>;
+    /**
+     * Download a new briefcase from iModelHub for the supplied iModelId.
+     *
+     * Briefcases are local files holding a copy of an iModel.
+     * Briefcases may either be specific to an individual user (so that it can be modified to create changesets), or it can be readonly so it can accept but not create changesets.
+     * Every briefcase internally holds its [[BriefcaseId]]. Writeable briefcases have a `BriefcaseId` "assigned" to them by iModelHub. No two users will ever have the same BriefcaseId.
+     * Readonly briefcases are "unassigned" with the special value [[BriefcaseId.Unassigned]].
+     *
+     * Typically a given user will have only one briefcase on their machine for a given iModelId. Rarely, it may be necessary to use more than one
+     * briefcase to make isolated independent sets of changes, but that is exceedingly complicated and rare.
+     *
+     * Callers of this method may supply a BriefcaseId, or if none is supplied, a new one is acquired from iModelHub.
+     *
+     * @param arg The arguments that specify the briefcase file to be downloaded.
+     * @returns The properties of the local briefcase in a Promise that is resolved after the briefcase is fully downloaded and the briefcase file is ready for use via [BriefcaseDb.open]($backend).
+     * @note The location of the local file to hold the briefcase is arbitrary and may be any valid *local* path on your machine. If you don't supply
+     * a filename, the local briefcase cache is used by creating a file with the briefcaseId as its name in the `briefcases` folder below the folder named
+     * for the IModelId.
+     * @note *It is invalid to edit briefcases on a shared network drive* and that is a sure way to corrupt your briefcase (see https://www.sqlite.org/howtocorrupt.html)
+     */
+    static downloadBriefcase(arg: RequestNewBriefcaseArg): Promise<LocalBriefcaseProps>;
+    /** Deletes change sets of an iModel from local disk
+     * @internal
+     */
+    static deleteChangeSetsFromLocalDisk(iModelId: string): void;
+    /** Releases a briefcaseId from iModelHub. After this call it is illegal to generate changesets for the released briefcaseId.
+     * @note generally, this method should not be called directly. Instead use [[deleteBriefcaseFiles]].
+     * @see deleteBriefcaseFiles
+     */
+    static releaseBriefcase(accessToken: AccessToken, briefcase: BriefcaseProps): Promise<void>;
+    /**
+     * Delete and clean up a briefcase and all of its associated files. First, this method opens the supplied filename to determine its briefcaseId.
+     * Then, if a requestContext is supplied, it releases a BriefcaseId from iModelHub. Finally it deletes the local briefcase file and
+     * associated files (that is, all files in the same directory that start with the briefcase name).
+     * @param filePath the full file name of the Briefcase to delete
+     * @param accessToken for releasing the briefcaseId
+     */
+    static deleteBriefcaseFiles(filePath: LocalFileName, accessToken?: AccessToken): Promise<void>;
+    /** Deletes a file
+     *  - Does not throw any error, but logs it instead
+     *  - Returns true if the delete was successful
+     */
+    private static deleteFile;
+    /** Deletes a folder, checking if it's empty
+     *  - Does not throw any error, but logs it instead
+     *  - Returns true if the delete was successful
+     */
+    private static deleteFolderIfEmpty;
+    /** Deletes the contents of a folder, but not the folder itself
+     *  - Does not throw any errors, but logs them.
+     *  - returns true if the delete was successful.
+     */
+    private static deleteFolderContents;
+    /** Deletes a folder and all it's contents.
+     *  - Does not throw any errors, but logs them.
+     *  - returns true if the delete was successful.
+     */
+    private static deleteFolderAndContents;
+    private static applySingleChangeset;
+    /** @internal */
+    static pullAndApplyChangesets(db: IModelDb, arg: ToChangesetArgs): Promise<void>;
+    /** create a changeset from the current changes, and push it to iModelHub */
+    private static pushChanges;
+    /** Pull/merge (if necessary), then push all local changes as a changeset. Called by [[BriefcaseDb.pushChanges]]
+     * @internal
+     */
+    static pullMergePush(db: BriefcaseDb, arg: PushChangesArgs): Promise<void>;
+    /** @internal */
+    static logUsage(imodel: IModelDb, activity?: RpcActivity): void;
+}
 //# sourceMappingURL=BriefcaseManager.d.ts.map