@itwin/core-backend 4.0.0-dev.52 → 4.0.0-dev.54

package/lib/cjs/CheckpointManager.d.ts

@@ -1,122 +1,122 @@
-/** @packageDocumentation
- * @module iModels
- */
-import { BeEvent, GuidString } from "@itwin/core-bentley";
-import { ChangesetId, ChangesetIdWithIndex, LocalDirName, LocalFileName } from "@itwin/core-common";
-import { CloudSqlite } from "./CloudSqlite";
-import { SnapshotDb, TokenArg } from "./IModelDb";
-/**
- * Properties of a checkpoint
- * @public
- */
-export interface CheckpointProps extends TokenArg {
-    readonly expectV2?: boolean;
-    /** iTwin that the iModel belongs to */
-    readonly iTwinId: GuidString;
-    /** Id of the iModel */
-    readonly iModelId: GuidString;
-    /** changeset for the checkpoint */
-    readonly changeset: ChangesetIdWithIndex;
-    /** If true, then the latest successful v2 checkpoint at or before the provided changeset will be returned when calling queryV2Checkpoint.  */
-    readonly allowPreceding?: boolean;
-    /** The number of seconds before the current token expires to attempt to reacquire a new token. Default is 1 hour. */
-    readonly reattachSafetySeconds?: number;
-}
-/** Return value from [[ProgressFunction]].
- *  @public
- */
-export declare enum ProgressStatus {
-    /** Continue download. */
-    Continue = 0,
-    /** Abort download. */
-    Abort = 1
-}
-/** Called to show progress during a download. If this function returns non-zero, the download is aborted.
- *  @public
- */
-export declare type ProgressFunction = (loaded: number, total: number) => ProgressStatus;
-/** The parameters that specify a request to download a checkpoint file from iModelHub.
- * @internal
- */
-export interface DownloadRequest {
-    /** name of local file to hold the downloaded data. */
-    localFile: LocalFileName;
-    /** A list of full fileName paths to test before downloading. If a valid file exists by one of these names,
-     * no download is performed and `localFile` is updated to reflect the fact that the file exists with that name.
-     * This can be used, for example, to look for checkpoints from previous versions if the naming strategy changes.
-     */
-    readonly aliasFiles?: ReadonlyArray<string>;
-    /** Properties of the checkpoint to be downloaded */
-    readonly checkpoint: CheckpointProps;
-    /** If present, this function will be called to indicate progress as the briefcase is downloaded. If this
-     * function returns a non-zero value, the download is aborted.
-     */
-    readonly onProgress?: ProgressFunction;
-}
-/** @internal */
-export interface DownloadJob {
-    request: DownloadRequest;
-    promise?: Promise<any>;
-}
-/** @internal */
-export declare class Downloads {
-    private static _active;
-    private static process;
-    static isInProgress(pathName: LocalFileName): DownloadJob | undefined;
-    static download<T>(request: DownloadRequest, downloadFn: (job: DownloadJob) => Promise<T>): Promise<any>;
-}
-/**
- * Utility class for opening V2 checkpoints from cloud containers, and also for downloading them.
- * @internal
-*/
-export declare class V2CheckpointManager {
-    static readonly cloudCacheName = "v2Checkpoints";
-    private static _cloudCache?;
-    private static containers;
-    static getFolder(): LocalDirName;
-    static cleanup(): void;
-    static getFileName(checkpoint: CheckpointProps): LocalFileName;
-    private static get cloudCache();
-    /** Member names differ slightly between the V2Checkpoint api and the CloudSqlite api. Add aliases `accessName` for `accountName` and `accessToken` for `sasToken` */
-    private static toCloudContainerProps;
-    private static getContainer;
-    static attach(checkpoint: CheckpointProps): Promise<{
-        dbName: string;
-        container: CloudSqlite.CloudContainer;
-    }>;
-    private static performDownload;
-    /** Fully download a V2 checkpoint to a local file that can be used to create a briefcase or to work offline.
-     * @returns a Promise that is resolved when the download completes with the changesetId of the downloaded checkpoint (which will
-     * be the same as the requested changesetId or the most recent checkpoint before it.)
-     */
-    static downloadCheckpoint(request: DownloadRequest): Promise<ChangesetId>;
-}
-/** Utility class to deal with downloading V1 checkpoints from iModelHub.
- * @internal
- */
-export declare class V1CheckpointManager {
-    static getFolder(iModelId: GuidString): LocalDirName;
-    static getFileName(checkpoint: CheckpointProps): LocalFileName;
-    static getCheckpointDb(request: DownloadRequest): Promise<SnapshotDb>;
-    /** Download a V1 checkpoint */
-    static downloadCheckpoint(request: DownloadRequest): Promise<ChangesetId>;
-    private static downloadAndOpen;
-    private static performDownload;
-}
-/** @internal  */
-export declare class CheckpointManager {
-    static readonly onDownloadV1: BeEvent<(job: DownloadJob) => void>;
-    static readonly onDownloadV2: BeEvent<(job: DownloadJob) => void>;
-    static getKey(checkpoint: CheckpointProps): string;
-    private static doDownload;
-    static updateToRequestedVersion(request: DownloadRequest): Promise<void>;
-    /** Download a checkpoint file from iModelHub into a local file specified in the request parameters. */
-    static downloadCheckpoint(request: DownloadRequest): Promise<void>;
-    /** checks a file's dbGuid & iTwinId for consistency, and updates the dbGuid when possible */
-    static validateCheckpointGuids(checkpoint: CheckpointProps, snapshotDb: SnapshotDb): void;
-    /** @returns true if the file is the checkpoint requested */
-    static verifyCheckpoint(checkpoint: CheckpointProps, fileName: LocalFileName): boolean;
-    /** try to open an existing local file to satisfy a download request */
-    static tryOpenLocalFile(request: DownloadRequest): SnapshotDb | undefined;
-}
+/** @packageDocumentation
+ * @module iModels
+ */
+import { BeEvent, GuidString } from "@itwin/core-bentley";
+import { ChangesetId, ChangesetIdWithIndex, LocalDirName, LocalFileName } from "@itwin/core-common";
+import { CloudSqlite } from "./CloudSqlite";
+import { SnapshotDb, TokenArg } from "./IModelDb";
+/**
+ * Properties of a checkpoint
+ * @public
+ */
+export interface CheckpointProps extends TokenArg {
+    readonly expectV2?: boolean;
+    /** iTwin that the iModel belongs to */
+    readonly iTwinId: GuidString;
+    /** Id of the iModel */
+    readonly iModelId: GuidString;
+    /** changeset for the checkpoint */
+    readonly changeset: ChangesetIdWithIndex;
+    /** If true, then the latest successful v2 checkpoint at or before the provided changeset will be returned when calling queryV2Checkpoint.  */
+    readonly allowPreceding?: boolean;
+    /** The number of seconds before the current token expires to attempt to reacquire a new token. Default is 1 hour. */
+    readonly reattachSafetySeconds?: number;
+}
+/** Return value from [[ProgressFunction]].
+ *  @public
+ */
+export declare enum ProgressStatus {
+    /** Continue download. */
+    Continue = 0,
+    /** Abort download. */
+    Abort = 1
+}
+/** Called to show progress during a download. If this function returns non-zero, the download is aborted.
+ *  @public
+ */
+export type ProgressFunction = (loaded: number, total: number) => ProgressStatus;
+/** The parameters that specify a request to download a checkpoint file from iModelHub.
+ * @internal
+ */
+export interface DownloadRequest {
+    /** name of local file to hold the downloaded data. */
+    localFile: LocalFileName;
+    /** A list of full fileName paths to test before downloading. If a valid file exists by one of these names,
+     * no download is performed and `localFile` is updated to reflect the fact that the file exists with that name.
+     * This can be used, for example, to look for checkpoints from previous versions if the naming strategy changes.
+     */
+    readonly aliasFiles?: ReadonlyArray<string>;
+    /** Properties of the checkpoint to be downloaded */
+    readonly checkpoint: CheckpointProps;
+    /** If present, this function will be called to indicate progress as the briefcase is downloaded. If this
+     * function returns a non-zero value, the download is aborted.
+     */
+    readonly onProgress?: ProgressFunction;
+}
+/** @internal */
+export interface DownloadJob {
+    request: DownloadRequest;
+    promise?: Promise<any>;
+}
+/** @internal */
+export declare class Downloads {
+    private static _active;
+    private static process;
+    static isInProgress(pathName: LocalFileName): DownloadJob | undefined;
+    static download<T>(request: DownloadRequest, downloadFn: (job: DownloadJob) => Promise<T>): Promise<any>;
+}
+/**
+ * Utility class for opening V2 checkpoints from cloud containers, and also for downloading them.
+ * @internal
+*/
+export declare class V2CheckpointManager {
+    static readonly cloudCacheName = "v2Checkpoints";
+    private static _cloudCache?;
+    private static containers;
+    static getFolder(): LocalDirName;
+    static cleanup(): void;
+    static getFileName(checkpoint: CheckpointProps): LocalFileName;
+    private static get cloudCache();
+    /** Member names differ slightly between the V2Checkpoint api and the CloudSqlite api. Add aliases `accessName` for `accountName` and `accessToken` for `sasToken` */
+    private static toCloudContainerProps;
+    private static getContainer;
+    static attach(checkpoint: CheckpointProps): Promise<{
+        dbName: string;
+        container: CloudSqlite.CloudContainer;
+    }>;
+    private static performDownload;
+    /** Fully download a V2 checkpoint to a local file that can be used to create a briefcase or to work offline.
+     * @returns a Promise that is resolved when the download completes with the changesetId of the downloaded checkpoint (which will
+     * be the same as the requested changesetId or the most recent checkpoint before it.)
+     */
+    static downloadCheckpoint(request: DownloadRequest): Promise<ChangesetId>;
+}
+/** Utility class to deal with downloading V1 checkpoints from iModelHub.
+ * @internal
+ */
+export declare class V1CheckpointManager {
+    static getFolder(iModelId: GuidString): LocalDirName;
+    static getFileName(checkpoint: CheckpointProps): LocalFileName;
+    static getCheckpointDb(request: DownloadRequest): Promise<SnapshotDb>;
+    /** Download a V1 checkpoint */
+    static downloadCheckpoint(request: DownloadRequest): Promise<ChangesetId>;
+    private static downloadAndOpen;
+    private static performDownload;
+}
+/** @internal  */
+export declare class CheckpointManager {
+    static readonly onDownloadV1: BeEvent<(job: DownloadJob) => void>;
+    static readonly onDownloadV2: BeEvent<(job: DownloadJob) => void>;
+    static getKey(checkpoint: CheckpointProps): string;
+    private static doDownload;
+    static updateToRequestedVersion(request: DownloadRequest): Promise<void>;
+    /** Download a checkpoint file from iModelHub into a local file specified in the request parameters. */
+    static downloadCheckpoint(request: DownloadRequest): Promise<void>;
+    /** checks a file's dbGuid & iTwinId for consistency, and updates the dbGuid when possible */
+    static validateCheckpointGuids(checkpoint: CheckpointProps, snapshotDb: SnapshotDb): void;
+    /** @returns true if the file is the checkpoint requested */
+    static verifyCheckpoint(checkpoint: CheckpointProps, fileName: LocalFileName): boolean;
+    /** try to open an existing local file to satisfy a download request */
+    static tryOpenLocalFile(request: DownloadRequest): SnapshotDb | undefined;
+}
 //# sourceMappingURL=CheckpointManager.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"CheckpointManager.d.ts","sourceRoot":"","sources":["../../src/CheckpointManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,OAAO,EAAyB,UAAU,EAAgE,MAAM,qBAAqB,CAAC;AAC/I,OAAO,EACa,WAAW,EAAE,oBAAoB,EAAmD,YAAY,EAAE,aAAa,EAClI,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAOlD;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAE5B,uCAAuC;IACvC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAE7B,uBAAuB;IACvB,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B,mCAAmC;IACnC,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;IAEzC,8IAA8I;IAC9I,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAElC,qHAAqH;IACrH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CACzC;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB,yBAAyB;IACzB,QAAQ,IAAI;IACZ,sBAAsB;IACtB,KAAK,IAAI;CACV;AAED;;GAEG;AACH,oBAAY,gBAAgB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,sDAAsD;IACtD,SAAS,EAAE,aAAa,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAE5C,oDAAoD;IACpD,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,gBAAgB,CAAC;CACxC;AAED,gBAAgB;AAChB,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,eAAe,CAAC;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;CACxB;AAED,gBAAgB;AAChB,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,OAAO,CAAkC;mBAEnC,OAAO;WAUd,YAAY,CAAC,QAAQ,EAAE,aAAa,GAAG,WAAW,GAAG,SAAS;WAIxD,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC;CAUvG;AAED;;;EAGE;AACF,qBAAa,mBAAmB;IAC9B,gBAAuB,cAAc,mBAAmB;IACxD,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAyB;IACpD,OAAO,CAAC,MAAM,CAAC,UAAU,CAAiD;WAE5D,SAAS,IAAI,YAAY;WASzB,OAAO,IAAI,IAAI;WAUf,WAAW,CAAC,UAAU,EAAE,eAAe,GAAG,aAAa;IAKrE,OAAO,CAAC,MAAM,KAAK,UAAU,GAqB5B;IAED,qKAAqK;IACrK,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAIpC,OAAO,CAAC,MAAM,CAAC,YAAY;WASP,MAAM,CAAC,UAAU,EAAE,eAAe,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,WAAW,CAAC,cAAc,CAAA;KAAE,CAAC;mBAoCtG,eAAe;IAYpC;;;OAGG;WACiB,kBAAkB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;CAGvF;AAED;;GAEG;AACH,qBAAa,mBAAmB;WAChB,SAAS,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;WAI7C,WAAW,CAAC,UAAU,EAAE,eAAe,GAAG,aAAa;WAKjD,eAAe,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC;IAKlF,+BAA+B;WACX,kBAAkB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;mBAIjE,eAAe;mBASf,eAAe;CAKrC;AAED,iBAAiB;AACjB,qBAAa,iBAAiB;IAC5B,gBAAuB,YAAY,gBAAqB,WAAW,KAAK,IAAI,EAAI;IAChF,gBAAuB,YAAY,gBAAqB,WAAW,KAAK,IAAI,EAAI;WAClE,MAAM,CAAC,UAAU,EAAE,eAAe;mBAE3B,UAAU;WAmBX,wBAAwB,CAAC,OAAO,EAAE,eAAe;IAkDrE,uGAAuG;WACnF,kBAAkB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB/E,6FAA6F;WAC/E,uBAAuB,CAAC,UAAU,EAAE,eAAe,EAAE,UAAU,EAAE,UAAU;IAyBzF,4DAA4D;WAC9C,gBAAgB,CAAC,UAAU,EAAE,eAAe,EAAE,QAAQ,EAAE,aAAa,GAAG,OAAO;IAmB7F,uEAAuE;WACzD,gBAAgB,CAAC,OAAO,EAAE,eAAe,GAAG,UAAU,GAAG,SAAS;CAgBjF"}
+{"version":3,"file":"CheckpointManager.d.ts","sourceRoot":"","sources":["../../src/CheckpointManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,OAAO,EAAyB,UAAU,EAAgE,MAAM,qBAAqB,CAAC;AAC/I,OAAO,EACa,WAAW,EAAE,oBAAoB,EAAmD,YAAY,EAAE,aAAa,EAClI,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAOlD;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAE5B,uCAAuC;IACvC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAE7B,uBAAuB;IACvB,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B,mCAAmC;IACnC,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;IAEzC,8IAA8I;IAC9I,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAElC,qHAAqH;IACrH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CACzC;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB,yBAAyB;IACzB,QAAQ,IAAI;IACZ,sBAAsB;IACtB,KAAK,IAAI;CACV;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,sDAAsD;IACtD,SAAS,EAAE,aAAa,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAE5C,oDAAoD;IACpD,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,gBAAgB,CAAC;CACxC;AAED,gBAAgB;AAChB,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,eAAe,CAAC;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;CACxB;AAED,gBAAgB;AAChB,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,OAAO,CAAkC;mBAEnC,OAAO;WAUd,YAAY,CAAC,QAAQ,EAAE,aAAa,GAAG,WAAW,GAAG,SAAS;WAIxD,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC;CAUvG;AAED;;;EAGE;AACF,qBAAa,mBAAmB;IAC9B,gBAAuB,cAAc,mBAAmB;IACxD,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAyB;IACpD,OAAO,CAAC,MAAM,CAAC,UAAU,CAAiD;WAE5D,SAAS,IAAI,YAAY;WASzB,OAAO,IAAI,IAAI;WAUf,WAAW,CAAC,UAAU,EAAE,eAAe,GAAG,aAAa;IAKrE,OAAO,CAAC,MAAM,KAAK,UAAU,GAqB5B;IAED,qKAAqK;IACrK,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAIpC,OAAO,CAAC,MAAM,CAAC,YAAY;WASP,MAAM,CAAC,UAAU,EAAE,eAAe,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,WAAW,CAAC,cAAc,CAAA;KAAE,CAAC;mBAoCtG,eAAe;IAYpC;;;OAGG;WACiB,kBAAkB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;CAGvF;AAED;;GAEG;AACH,qBAAa,mBAAmB;WAChB,SAAS,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;WAI7C,WAAW,CAAC,UAAU,EAAE,eAAe,GAAG,aAAa;WAKjD,eAAe,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC;IAKlF,+BAA+B;WACX,kBAAkB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;mBAIjE,eAAe;mBASf,eAAe;CAKrC;AAED,iBAAiB;AACjB,qBAAa,iBAAiB;IAC5B,gBAAuB,YAAY,gBAAqB,WAAW,KAAK,IAAI,EAAI;IAChF,gBAAuB,YAAY,gBAAqB,WAAW,KAAK,IAAI,EAAI;WAClE,MAAM,CAAC,UAAU,EAAE,eAAe;mBAE3B,UAAU;WAmBX,wBAAwB,CAAC,OAAO,EAAE,eAAe;IAkDrE,uGAAuG;WACnF,kBAAkB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB/E,6FAA6F;WAC/E,uBAAuB,CAAC,UAAU,EAAE,eAAe,EAAE,UAAU,EAAE,UAAU;IAyBzF,4DAA4D;WAC9C,gBAAgB,CAAC,UAAU,EAAE,eAAe,EAAE,QAAQ,EAAE,aAAa,GAAG,OAAO;IAmB7F,uEAAuE;WACzD,gBAAgB,CAAC,OAAO,EAAE,eAAe,GAAG,UAAU,GAAG,SAAS;CAgBjF"}