@itwin/core-backend 4.6.0-dev.22 → 4.6.0-dev.24

package/lib/cjs/BackendHubAccess.js

@@ -23,7 +23,7 @@ var LockState;
      * 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 = {}));
+})(LockState || (exports.LockState = LockState = {}));
 /** Exception thrown if lock cannot be acquired.
  * @beta
 */

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 type { 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 in 3.x. Use [[DownloadRequest]].\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 * @note This interface is implemented in another repository. Any changes made to this interface must be validated against\r\n * the implementation found here: https://github.com/iTwin/imodels-clients/blob/main/itwin-platform-access/imodels-access-backend/src/BackendIModelsAccess.ts\r\n * @internal\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 in 3.x. V1 checkpoints are deprecated. Download V2 checkpoint using [[V2CheckpointManager.downloadCheckpoint]].\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,yBAAT,SAAS,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 type { 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 in 3.x. Use [[DownloadRequest]].\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 * @note This interface is implemented in another repository. Any changes made to this interface must be validated against\r\n * the implementation found here: https://github.com/iTwin/imodels-clients/blob/main/itwin-platform-access/imodels-access-backend/src/BackendIModelsAccess.ts\r\n * @internal\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 in 3.x. V1 checkpoints are deprecated. Download V2 checkpoint using [[V2CheckpointManager.downloadCheckpoint]].\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"]}

package/lib/cjs/BackendLoggerCategory.js

@@ -95,5 +95,5 @@ var BackendLoggerCategory;
      * @internal
      */
     BackendLoggerCategory["ViewStateHydrator"] = "core-backend.ViewStateHydrator";
-})(BackendLoggerCategory = exports.BackendLoggerCategory || (exports.BackendLoggerCategory = {}));
+})(BackendLoggerCategory || (exports.BackendLoggerCategory = BackendLoggerCategory = {}));
 //# sourceMappingURL=BackendLoggerCategory.js.map

package/lib/cjs/BackendLoggerCategory.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackendLoggerCategory.js","sourceRoot":"","sources":["../../src/BackendLoggerCategory.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;;;GAIG;AACH,IAAY,qBAkGX;AAlGD,WAAY,qBAAqB;IAC/B,+DAA+D;IAC/D,qEAA4C,CAAA;IAE5C;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;OAEG;IACH,2FAAkE,CAAA;IAElE;;OAEG;IACH,2DAAkC,CAAA;IAElC;;;;OAIG;IACH,mDAA0B,CAAA;IAE1B;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,6EAAoD,CAAA;IAEpD;;;OAGG;IACH,2DAAkC,CAAA;IAElC;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,mFAA0D,CAAA;IAE1D;;OAEG;IACH,2EAAkD,CAAA;IAElD;;OAEG;IACH,6EAAoD,CAAA;IAEpD;;OAEG;IACH,mEAA0C,CAAA;IAE1C;;OAEG;IACH,yDAAgC,CAAA;IAEhC;;OAEG;IACH,yEAAgD,CAAA;IAChD;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;;OAGG;IACH,yDAAgC,CAAA;IAEhC;;;OAGG;IACH,6DAAoC,CAAA;IAEpC;;;OAGG;IACH,6EAAoD,CAAA;AACtD,CAAC,EAlGW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAkGhC","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 Logging\r\n */\r\n\r\n/** Logger categories used by this package\r\n * @note All logger categories in this package start with the `core-backend` prefix.\r\n * @see [Logger]($bentley)\r\n * @public\r\n */\r\nexport enum BackendLoggerCategory {\r\n  /** The logger category used by API related to authorization */\r\n  Authorization = \"core-backend.Authorization\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[CodeSpecs]]\r\n   */\r\n  CodeSpecs = \"core-backend.CodeSpecs\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[CustomViewState3dCreator]]\r\n   */\r\n  CustomViewState3dCreator = \"core-backend.CustomViewState3dCreator\",\r\n\r\n  /** The logger category used by the [[DevTools]] class and related classes.\r\n   * @internal\r\n   */\r\n  DevTools = \"core-backend.DevTools\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[ChangeSummaryManager]]\r\n   * - [[ECDb]]\r\n   * - [[ECSqlStatement]]\r\n   */\r\n  ECDb = \"core-backend.ECDb\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Functional]]\r\n   */\r\n  Functional = \"core-backend.Functional\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[LinearReferencing]]\r\n   */\r\n  LinearReferencing = \"core-backend.LinearReferencing\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - BriefcaseManager\r\n   * - [[IModelDb]]\r\n   */\r\n  IModelDb = \"core-backend.IModelDb\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[IModelHost]]\r\n   */\r\n  IModelHost = \"core-backend.IModelHost\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - TileRequestMemoizer\r\n   */\r\n  IModelTileRequestRpc = \"core-backend.IModelTileRequestRpc\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - IModelTileRpcImpl (Tile Uploading)\r\n   */\r\n  IModelTileUpload = \"core-backend.IModelTileUpload\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - TileStorage (tile upload/download)\r\n   */\r\n  IModelTileStorage = \"core-backend.IModelTileStorage\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Relationship]]\r\n   */\r\n  Relationship = \"core-backend.Relationship\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Schemas]]\r\n   */\r\n  Schemas = \"core-backend.Schemas\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[PromiseMemoizer]]\r\n   */\r\n  PromiseMemoizer = \"core-backend.PromiseMemoizer\",\r\n  /** The logger category used by the following classes:\r\n   * - [[EventSink]]\r\n   */\r\n  EventSink = \"core-backend.EventSink\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[iModels]]\r\n   * @alpha\r\n   */\r\n  Editing = \"core-backend.Editing\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[NativeHost]], [[NativeAppStorage]]\r\n   * @internal\r\n   */\r\n  NativeApp = \"core-backend.NativeApp\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[ViewStateHydrator]]\r\n   * @internal\r\n   */\r\n  ViewStateHydrator = \"core-backend.ViewStateHydrator\",\r\n}\r\n"]}
+{"version":3,"file":"BackendLoggerCategory.js","sourceRoot":"","sources":["../../src/BackendLoggerCategory.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;;;GAIG;AACH,IAAY,qBAkGX;AAlGD,WAAY,qBAAqB;IAC/B,+DAA+D;IAC/D,qEAA4C,CAAA;IAE5C;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;OAEG;IACH,2FAAkE,CAAA;IAElE;;OAEG;IACH,2DAAkC,CAAA;IAElC;;;;OAIG;IACH,mDAA0B,CAAA;IAE1B;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,6EAAoD,CAAA;IAEpD;;;OAGG;IACH,2DAAkC,CAAA;IAElC;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,mFAA0D,CAAA;IAE1D;;OAEG;IACH,2EAAkD,CAAA;IAElD;;OAEG;IACH,6EAAoD,CAAA;IAEpD;;OAEG;IACH,mEAA0C,CAAA;IAE1C;;OAEG;IACH,yDAAgC,CAAA;IAEhC;;OAEG;IACH,yEAAgD,CAAA;IAChD;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;;OAGG;IACH,yDAAgC,CAAA;IAEhC;;;OAGG;IACH,6DAAoC,CAAA;IAEpC;;;OAGG;IACH,6EAAoD,CAAA;AACtD,CAAC,EAlGW,qBAAqB,qCAArB,qBAAqB,QAkGhC","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 Logging\r\n */\r\n\r\n/** Logger categories used by this package\r\n * @note All logger categories in this package start with the `core-backend` prefix.\r\n * @see [Logger]($bentley)\r\n * @public\r\n */\r\nexport enum BackendLoggerCategory {\r\n  /** The logger category used by API related to authorization */\r\n  Authorization = \"core-backend.Authorization\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[CodeSpecs]]\r\n   */\r\n  CodeSpecs = \"core-backend.CodeSpecs\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[CustomViewState3dCreator]]\r\n   */\r\n  CustomViewState3dCreator = \"core-backend.CustomViewState3dCreator\",\r\n\r\n  /** The logger category used by the [[DevTools]] class and related classes.\r\n   * @internal\r\n   */\r\n  DevTools = \"core-backend.DevTools\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[ChangeSummaryManager]]\r\n   * - [[ECDb]]\r\n   * - [[ECSqlStatement]]\r\n   */\r\n  ECDb = \"core-backend.ECDb\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Functional]]\r\n   */\r\n  Functional = \"core-backend.Functional\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[LinearReferencing]]\r\n   */\r\n  LinearReferencing = \"core-backend.LinearReferencing\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - BriefcaseManager\r\n   * - [[IModelDb]]\r\n   */\r\n  IModelDb = \"core-backend.IModelDb\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[IModelHost]]\r\n   */\r\n  IModelHost = \"core-backend.IModelHost\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - TileRequestMemoizer\r\n   */\r\n  IModelTileRequestRpc = \"core-backend.IModelTileRequestRpc\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - IModelTileRpcImpl (Tile Uploading)\r\n   */\r\n  IModelTileUpload = \"core-backend.IModelTileUpload\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - TileStorage (tile upload/download)\r\n   */\r\n  IModelTileStorage = \"core-backend.IModelTileStorage\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Relationship]]\r\n   */\r\n  Relationship = \"core-backend.Relationship\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Schemas]]\r\n   */\r\n  Schemas = \"core-backend.Schemas\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[PromiseMemoizer]]\r\n   */\r\n  PromiseMemoizer = \"core-backend.PromiseMemoizer\",\r\n  /** The logger category used by the following classes:\r\n   * - [[EventSink]]\r\n   */\r\n  EventSink = \"core-backend.EventSink\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[iModels]]\r\n   * @alpha\r\n   */\r\n  Editing = \"core-backend.Editing\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[NativeHost]], [[NativeAppStorage]]\r\n   * @internal\r\n   */\r\n  NativeApp = \"core-backend.NativeApp\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[ViewStateHydrator]]\r\n   * @internal\r\n   */\r\n  ViewStateHydrator = \"core-backend.ViewStateHydrator\",\r\n}\r\n"]}

package/lib/cjs/BlobContainerService.js

@@ -14,5 +14,5 @@ exports.BlobContainer = void 0;
  */
 var BlobContainer;
 (function (BlobContainer) {
-})(BlobContainer = exports.BlobContainer || (exports.BlobContainer = {}));
+})(BlobContainer || (exports.BlobContainer = BlobContainer = {}));
 //# sourceMappingURL=BlobContainerService.js.map

package/lib/cjs/BlobContainerService.js.map

@@ -1 +1 @@
-{"version":3,"file":"BlobContainerService.js","sourceRoot":"","sources":["../../src/BlobContainerService.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;;GAGG;AACH,IAAiB,aAAa,CAiJ7B;AAjJD,WAAiB,aAAa;AAiJ9B,CAAC,EAjJgB,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAiJ7B","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 BlobContainers\r\n */\r\n\r\n// spell:ignore datacenter\r\n\r\nimport { AccessToken, GuidString, Id64String } from \"@itwin/core-bentley\";\r\nimport { SettingObject } from \"./workspace/Settings\";\r\n\r\n/**\r\n * Types and functions for creating, deleting and authorizing access to cloud-based blob containers for an iTwin.\r\n * @beta\r\n */\r\nexport namespace BlobContainer {\r\n\r\n  /** Object that implements the methods to create, delete, and request access to a container. */\r\n  export let service: BlobContainer.ContainerService | undefined;\r\n\r\n  /** name of cloud provider for a container. */\r\n  export type Provider = \"azure\" | \"google\";\r\n\r\n  /** the name of the container within its `Scope` */\r\n  export type ContainerId = string;\r\n\r\n  /** token that authenticates a user. This token is required to obtain a `ContainerToken`. */\r\n  export type UserToken = AccessToken;\r\n\r\n  /** token that authenticates access to a container for either read or write. */\r\n  export type ContainerToken = AccessToken;\r\n\r\n  /**\r\n   * The scope for a container. This determines:\r\n   *  - the \"owner\" organization, including the contract that governs its legal and commercial terms and obligations\r\n   *  - the administrators who may configure RBAC permissions\r\n   *  - the datacenter for the container. Every container resides in a datacenter as determined by the iTwinId. This\r\n   * determines the region for data residency requirements.\r\n   *  - the lifecycle constraints for the container. No container can outlive its iTwin or its iModel (if defined). That is,\r\n   * when the iTwin/iModel is deleted (either explicitly or due to contract expiration), the container is also deleted.\r\n   */\r\n  export interface Scope {\r\n    /** iTwinId of the owner of this container. */\r\n    iTwinId: Id64String;\r\n    /** optionally, an iModelId within the iTwin. If present, container is deleted when the iModel is deleted. */\r\n    iModelId?: Id64String;\r\n    /** the user GUID an individual, if this container is private. */\r\n    ownerGuid?: GuidString;\r\n  }\r\n\r\n  /**\r\n   * Metadata about the use of a container so that:\r\n   *  - administrators can understand why a container exists for assigning RBAC permissions appropriately\r\n   *  - usage reports can aggregate types of containers\r\n   *  - applications can identify their containers\r\n   *  - applications can store properties about their containers\r\n   */\r\n  export interface Metadata {\r\n    /** The machine-readable string that describes what the container is being used for (e.g. \"workspace\"). Always lowercase and singular. */\r\n    containerType: string;\r\n    /** Human-readable name for the container. This will be displayed in the administrator RBAC panel, and on usage reports. Not required to be unique.*/\r\n    label: string;\r\n    /** Optional human-readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */\r\n    description?: string;\r\n    /** optional properties for the container */\r\n    json?: SettingObject;\r\n  }\r\n\r\n  /** Properties returned by `Service.requestToken` */\r\n  export interface TokenProps {\r\n    /**\r\n     * expiring token that provides the requested access to the container. Should be used in all subsequent requests for blobs within the container,\r\n     * and must be refreshed before it expires\r\n     */\r\n    token: ContainerToken;\r\n    /** scope of the container. */\r\n    scope: Scope;\r\n    /** name of the blob storage provider. */\r\n    provider: Provider;\r\n    /** Time at which the token will expire. The token should be refreshed (that is, a new token should be requested) before this time. */\r\n    expiration: Date;\r\n    /** Metadata of the container. */\r\n    metadata: Metadata;\r\n  }\r\n\r\n  /** The URI and Id of the container. */\r\n  export interface UriAndId {\r\n    baseUri: string;\r\n    containerId: ContainerId;\r\n  }\r\n\r\n  /** Information required to access an existing container. */\r\n  export interface AccessContainerProps extends UriAndId {\r\n    userToken: UserToken;\r\n  }\r\n\r\n  /** Information about a newly created container. */\r\n  export interface CreatedContainerProps extends UriAndId {\r\n    /** name of the blob storage provider. */\r\n    provider: Provider;\r\n  }\r\n\r\n  /**\r\n   * Access level to request for token.\r\n   * - `\"write\"`: request a writeable AccessToken.\r\n   * - `\"read\"`:  request a read-only AccessToken.\r\n   * - `\"admin\"`:  request a admin AccessToken.\r\n   * - `\"writeIfPossible\"`: first request a writeable AccessToken. If the user is not authorized for write, request a read-only AccessToken.\r\n   * If the user is not authorized for the level requested, an exception is thrown.\r\n   */\r\n  export type RequestAccessLevel = \"write\" | \"read\" | \"admin\" | \"writeIfPossible\";\r\n\r\n  /** Information required to request an access token for a container. */\r\n  export interface RequestTokenProps extends AccessContainerProps {\r\n    /** the level of access requested. If not specified, defaults to `\"writeIfPossible\"`. */\r\n    accessLevel?: RequestAccessLevel;\r\n    /** the number of seconds before the token should expire.\r\n     * @note A maximum duration is determined by the service. If no value is supplied, or the value is larger than the maximum, the maximum duration is used.\r\n     */\r\n    durationSeconds?: number;\r\n  }\r\n\r\n  /** Information required to create a new container. */\r\n  export interface CreateNewContainerProps {\r\n    /** the scope of the new container */\r\n    scope: Scope;\r\n    /** metadata to be stored on the new container */\r\n    metadata: Metadata;\r\n    /** The user's access token. The user must be authorized with \"create container\" RBAC role for the iTwin. */\r\n    userToken: UserToken;\r\n    /**\r\n     * the id for the container. Useful for tests.\r\n     * @internal\r\n     */\r\n    containerId?: ContainerId;\r\n  }\r\n\r\n  /** Methods to create, delete, and access blob containers. */\r\n  export interface ContainerService {\r\n    /**  Create a new blob container. Throws on failure (e.g. access denied or container already exists.) */\r\n    create(props: CreateNewContainerProps): Promise<CreatedContainerProps>;\r\n\r\n    /**\r\n     * Delete an existing blob container.\r\n     * @note This method requires that the user be authorized with \"delete container\" RBAC role for the iTwin.\r\n     */\r\n    delete(container: AccessContainerProps): Promise<void>;\r\n\r\n    /** query the Scope for a container */\r\n    queryScope(container: AccessContainerProps): Promise<Scope>;\r\n\r\n    /** query the Metadata for a container */\r\n    queryMetadata(container: AccessContainerProps): Promise<Metadata>;\r\n\r\n    /** update the json properties of this container */\r\n    updateJson(container: AccessContainerProps, json: SettingObject): Promise<void>;\r\n\r\n    /** Request a `ContainerToken` for a container. Throws on failure. */\r\n    requestToken(props: RequestTokenProps): Promise<TokenProps>;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BlobContainerService.js","sourceRoot":"","sources":["../../src/BlobContainerService.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;;GAGG;AACH,IAAiB,aAAa,CAiJ7B;AAjJD,WAAiB,aAAa;AAiJ9B,CAAC,EAjJgB,aAAa,6BAAb,aAAa,QAiJ7B","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 BlobContainers\r\n */\r\n\r\n// spell:ignore datacenter\r\n\r\nimport { AccessToken, GuidString, Id64String } from \"@itwin/core-bentley\";\r\nimport { SettingObject } from \"./workspace/Settings\";\r\n\r\n/**\r\n * Types and functions for creating, deleting and authorizing access to cloud-based blob containers for an iTwin.\r\n * @beta\r\n */\r\nexport namespace BlobContainer {\r\n\r\n  /** Object that implements the methods to create, delete, and request access to a container. */\r\n  export let service: BlobContainer.ContainerService | undefined;\r\n\r\n  /** name of cloud provider for a container. */\r\n  export type Provider = \"azure\" | \"google\";\r\n\r\n  /** the name of the container within its `Scope` */\r\n  export type ContainerId = string;\r\n\r\n  /** token that authenticates a user. This token is required to obtain a `ContainerToken`. */\r\n  export type UserToken = AccessToken;\r\n\r\n  /** token that authenticates access to a container for either read or write. */\r\n  export type ContainerToken = AccessToken;\r\n\r\n  /**\r\n   * The scope for a container. This determines:\r\n   *  - the \"owner\" organization, including the contract that governs its legal and commercial terms and obligations\r\n   *  - the administrators who may configure RBAC permissions\r\n   *  - the datacenter for the container. Every container resides in a datacenter as determined by the iTwinId. This\r\n   * determines the region for data residency requirements.\r\n   *  - the lifecycle constraints for the container. No container can outlive its iTwin or its iModel (if defined). That is,\r\n   * when the iTwin/iModel is deleted (either explicitly or due to contract expiration), the container is also deleted.\r\n   */\r\n  export interface Scope {\r\n    /** iTwinId of the owner of this container. */\r\n    iTwinId: Id64String;\r\n    /** optionally, an iModelId within the iTwin. If present, container is deleted when the iModel is deleted. */\r\n    iModelId?: Id64String;\r\n    /** the user GUID an individual, if this container is private. */\r\n    ownerGuid?: GuidString;\r\n  }\r\n\r\n  /**\r\n   * Metadata about the use of a container so that:\r\n   *  - administrators can understand why a container exists for assigning RBAC permissions appropriately\r\n   *  - usage reports can aggregate types of containers\r\n   *  - applications can identify their containers\r\n   *  - applications can store properties about their containers\r\n   */\r\n  export interface Metadata {\r\n    /** The machine-readable string that describes what the container is being used for (e.g. \"workspace\"). Always lowercase and singular. */\r\n    containerType: string;\r\n    /** Human-readable name for the container. This will be displayed in the administrator RBAC panel, and on usage reports. Not required to be unique.*/\r\n    label: string;\r\n    /** Optional human-readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */\r\n    description?: string;\r\n    /** optional properties for the container */\r\n    json?: SettingObject;\r\n  }\r\n\r\n  /** Properties returned by `Service.requestToken` */\r\n  export interface TokenProps {\r\n    /**\r\n     * expiring token that provides the requested access to the container. Should be used in all subsequent requests for blobs within the container,\r\n     * and must be refreshed before it expires\r\n     */\r\n    token: ContainerToken;\r\n    /** scope of the container. */\r\n    scope: Scope;\r\n    /** name of the blob storage provider. */\r\n    provider: Provider;\r\n    /** Time at which the token will expire. The token should be refreshed (that is, a new token should be requested) before this time. */\r\n    expiration: Date;\r\n    /** Metadata of the container. */\r\n    metadata: Metadata;\r\n  }\r\n\r\n  /** The URI and Id of the container. */\r\n  export interface UriAndId {\r\n    baseUri: string;\r\n    containerId: ContainerId;\r\n  }\r\n\r\n  /** Information required to access an existing container. */\r\n  export interface AccessContainerProps extends UriAndId {\r\n    userToken: UserToken;\r\n  }\r\n\r\n  /** Information about a newly created container. */\r\n  export interface CreatedContainerProps extends UriAndId {\r\n    /** name of the blob storage provider. */\r\n    provider: Provider;\r\n  }\r\n\r\n  /**\r\n   * Access level to request for token.\r\n   * - `\"write\"`: request a writeable AccessToken.\r\n   * - `\"read\"`:  request a read-only AccessToken.\r\n   * - `\"admin\"`:  request a admin AccessToken.\r\n   * - `\"writeIfPossible\"`: first request a writeable AccessToken. If the user is not authorized for write, request a read-only AccessToken.\r\n   * If the user is not authorized for the level requested, an exception is thrown.\r\n   */\r\n  export type RequestAccessLevel = \"write\" | \"read\" | \"admin\" | \"writeIfPossible\";\r\n\r\n  /** Information required to request an access token for a container. */\r\n  export interface RequestTokenProps extends AccessContainerProps {\r\n    /** the level of access requested. If not specified, defaults to `\"writeIfPossible\"`. */\r\n    accessLevel?: RequestAccessLevel;\r\n    /** the number of seconds before the token should expire.\r\n     * @note A maximum duration is determined by the service. If no value is supplied, or the value is larger than the maximum, the maximum duration is used.\r\n     */\r\n    durationSeconds?: number;\r\n  }\r\n\r\n  /** Information required to create a new container. */\r\n  export interface CreateNewContainerProps {\r\n    /** the scope of the new container */\r\n    scope: Scope;\r\n    /** metadata to be stored on the new container */\r\n    metadata: Metadata;\r\n    /** The user's access token. The user must be authorized with \"create container\" RBAC role for the iTwin. */\r\n    userToken: UserToken;\r\n    /**\r\n     * the id for the container. Useful for tests.\r\n     * @internal\r\n     */\r\n    containerId?: ContainerId;\r\n  }\r\n\r\n  /** Methods to create, delete, and access blob containers. */\r\n  export interface ContainerService {\r\n    /**  Create a new blob container. Throws on failure (e.g. access denied or container already exists.) */\r\n    create(props: CreateNewContainerProps): Promise<CreatedContainerProps>;\r\n\r\n    /**\r\n     * Delete an existing blob container.\r\n     * @note This method requires that the user be authorized with \"delete container\" RBAC role for the iTwin.\r\n     */\r\n    delete(container: AccessContainerProps): Promise<void>;\r\n\r\n    /** query the Scope for a container */\r\n    queryScope(container: AccessContainerProps): Promise<Scope>;\r\n\r\n    /** query the Metadata for a container */\r\n    queryMetadata(container: AccessContainerProps): Promise<Metadata>;\r\n\r\n    /** update the json properties of this container */\r\n    updateJson(container: AccessContainerProps, json: SettingObject): Promise<void>;\r\n\r\n    /** Request a `ContainerToken` for a container. Throws on failure. */\r\n    requestToken(props: RequestTokenProps): Promise<TokenProps>;\r\n  }\r\n}\r\n"]}

package/lib/cjs/BriefcaseManager.js

@@ -337,7 +337,7 @@ class BriefcaseManager {
         const changesets = await IModelHost_1.IModelHost.hubAccess.downloadChangesets({
             accessToken: arg.accessToken,
             iModelId: db.iModelId,
-            range: { first: reverse ? arg.toIndex + 1 : currentIndex + 1, end: reverse ? currentIndex : arg.toIndex },
+            range: { first: reverse ? arg.toIndex + 1 : currentIndex + 1, end: reverse ? currentIndex : arg.toIndex }, // eslint-disable-line @typescript-eslint/no-non-null-assertion
             targetDir: BriefcaseManager.getChangeSetsPath(db.iModelId),
             progressCallback: arg.onProgress,
         });
@@ -414,6 +414,6 @@ class BriefcaseManager {
         }
     }
 }
-BriefcaseManager._briefcaseSubDir = "briefcases";
 exports.BriefcaseManager = BriefcaseManager;
+BriefcaseManager._briefcaseSubDir = "briefcases";
 //# sourceMappingURL=BriefcaseManager.js.map

package/lib/cjs/BriefcaseManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"BriefcaseManager.js","sourceRoot":"","sources":["../../src/BriefcaseManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,qCAAqC;AAErC,6BAA6B;AAC7B,sDAE6B;AAC7B,oDAG4B;AAE5B,mEAAgE;AAChE,2DAA2F;AAC3F,yCAA6D;AAC7D,6CAA0C;AAC1C,6CAA0C;AAE1C,MAAM,cAAc,GAAG,6CAAqB,CAAC,QAAQ,CAAC;AAkDtD;;GAEG;AACH,MAAa,gBAAgB;IAC3B,wFAAwF;IACjF,MAAM,CAAC,aAAa,CAAC,QAAoB,IAAkB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAE/G,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAAC,QAAoB,IAAkB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IAErI,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,QAAoB,IAAmB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhK,gBAAgB;IACT,MAAM,CAAC,0BAA0B,CAAC,QAAoB,IAAmB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAGhK,gGAAgG;IACzF,MAAM,CAAC,oBAAoB,CAAC,QAAoB;QACrD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,WAAW,CAAC,SAAyB;QACjD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,GAAG,SAAS,CAAC,WAAW,MAAM,CAAC,CAAC;IAClG,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,YAA0B;QACrD,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC;QAC9B,uBAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAChD,CAAC;IAGD;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,YAA0B;QACjD,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO;QACT,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QACjC,uBAAU,CAAC,gBAAgB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC3D,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC3B,CAAC;IAEO,MAAM,CAAC,QAAQ;QACrB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,QAAqB;QACrD,MAAM,aAAa,GAA0B,EAAE,CAAC;QAChD,MAAM,UAAU,GAAG,uBAAU,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1D,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;YAClC,IAAI,QAAQ,IAAI,QAAQ,KAAK,SAAS;gBACpC,SAAS;YACX,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC3E,IAAI;gBACF,IAAI,CAAC,uBAAU,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,WAAW;oBAC5C,SAAS;aACZ;YAAC,OAAO,GAAG,EAAE;gBACZ,SAAS;aACV;YAED,MAAM,UAAU,GAAG,uBAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YAClD,KAAK,MAAM,aAAa,IAAI,UAAU,EAAE;gBACtC,IAAI,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;oBAClC,IAAI;wBACF,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;wBAClD,MAAM,QAAQ,GAAG,uBAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC3D,MAAM,EAAE,GAAG,mBAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,uBAAQ,CAAC,QAAQ,CAAC,CAAC;wBACrE,aAAa,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC,WAAW,EAAE,EAAE,WAAW,EAAE,EAAE,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,mBAAmB,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;wBACxK,EAAE,CAAC,SAAS,EAAE,CAAC;qBAChB;oBAAC,OAAO,IAAI,EAAE;qBACd;iBACF;aACF;SACF;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IAGD,qDAAqD;IAC9C,MAAM,KAAK,QAAQ,KAAmB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAErE;;OAEG;IACI,MAAM,CAAC,kBAAkB,CAAC,EAAe;QAC9C,OAAO,EAAE,IAAI,8BAAgB,CAAC,UAAU,IAAI,EAAE,IAAI,8BAAgB,CAAC,SAAS,CAAC;IAC/E,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,GAA6B;QACrE,OAAO,uBAAU,CAAC,SAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAA2B;QAC/D,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI,MAAM,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;QAC7E,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,IAAI,IAAI,CAAC,WAAW,CAAC,EAAE,GAAG,GAAG,EAAE,WAAW,EAAE,CAAC,CAAC;QAE3E,IAAI,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC;YACjC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,iBAAiB,EAAE,cAAc,QAAQ,kBAAkB,CAAC,CAAC;QAElG,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,IAAI,2BAAa,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC;QACzD,MAAM,SAAS,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,GAAG,GAAG,EAAE,OAAO,EAAE,2BAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACxH,MAAM,UAAU,GAAoB,EAAE,GAAG,GAAG,EAAE,SAAS,EAAE,CAAC;QAE1D,IAAI;YACF,MAAM,qCAAiB,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;SAC7G;QAAC,OAAO,KAAc,EAAE;YACvB,IAAI,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,WAAW,KAAK,SAAS;gBAClD,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;YAExF,MAAM,KAAK,CAAC;SACb;QAED,MAAM,QAAQ,GAAG,uBAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC;QAC3D,MAAM,QAAQ,GAAwB;YACpC,QAAQ;YACR,WAAW;YACX,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,SAAS,EAAE,UAAU,CAAC,SAAS;YAC/B,QAAQ;SACT,CAAC;QAEF,+DAA+D;QAC/D,MAAM,QAAQ,GAAG,IAAI,uBAAU,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACjD,IAAI;YACF,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,uBAAQ,CAAC,SAAS,CAAC,CAAC;SACnD;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,IAAI,yBAAW,CAAC,GAAG,CAAC,WAAW,EAAE,yDAAyD,QAAQ,SAAS,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;SACjI;QACD,IAAI;YACF,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC,+CAA+C;YACzE,QAAQ,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;YACvC,IAAI,QAAQ,CAAC,mBAAmB,EAAE,CAAC,EAAE,KAAK,UAAU,CAAC,SAAS,CAAC,EAAE;gBAC/D,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,+CAA+C,QAAQ,EAAE,CAAC,CAAC;SAC5G;gBAAS;YACR,QAAQ,CAAC,WAAW,EAAE,CAAC;YACvB,QAAQ,CAAC,SAAS,EAAE,CAAC;SACtB;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,6BAA6B,CAAC,QAAgB;QAC1D,MAAM,cAAc,GAAG,gBAAgB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACpE,gBAAgB,CAAC,uBAAuB,CAAC,cAAc,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,WAAwB,EAAE,SAAyB;QACtF,IAAI,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,WAAW,CAAC;YAChD,OAAO,uBAAU,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE,WAAW,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;IACpI,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,QAAuB,EAAE,WAAyB;QACzF,IAAI;YACF,MAAM,EAAE,GAAG,mBAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,uBAAQ,CAAC,QAAQ,CAAC,CAAC;YACrE,MAAM,SAAS,GAAmB;gBAChC,QAAQ,EAAE,EAAE,CAAC,WAAW,EAAE;gBAC1B,WAAW,EAAE,EAAE,CAAC,cAAc,EAAE;aACjC,CAAC;YACF,EAAE,CAAC,SAAS,EAAE,CAAC;YAEf,IAAI,WAAW,EAAE;gBACf,IAAI,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE;oBAClD,MAAM,gBAAgB,CAAC,gBAAgB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;iBACjE;aACF;SACF;QAAC,OAAO,KAAK,EAAE;SACf;QAED,yCAAyC;QACzC,IAAI;YACF,IAAI,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC;gBACjC,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;SACnC;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,gCAAgC,GAAG,EAAE,CAAC,CAAC;SACvF;QAED,8GAA8G;QAC9G,IAAI;YACF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACzC,MAAM,KAAK,GAAG,uBAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YAC9C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;gBACxB,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;oBAC3B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,uBAAuB;aACrE;SACF;QAAC,OAAO,GAAG,EAAE;SACb;IACH,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,UAAU,CAAC,QAAuB;QAC/C,IAAI;YACF,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;SACjC;QAAC,OAAO,KAAK,EAAE;YACd,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,sBAAsB,QAAQ,KAAK,KAAK,EAAE,CAAC,CAAC;YAC5E,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,mBAAmB,CAAC,cAA4B;QAC7D,IAAI;YACF,MAAM,KAAK,GAAG,uBAAU,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;YACrD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;gBAClB,OAAO,KAAK,CAAC;YAEf,uBAAU,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;SACtC;QAAC,OAAO,KAAK,EAAE;YACd,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,yBAAyB,cAAc,EAAE,CAAC,CAAC;YAC3E,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,oBAAoB,CAAC,cAA4B;QAC9D,IAAI,CAAC,uBAAU,CAAC,UAAU,CAAC,cAAc,CAAC;YACxC,OAAO,KAAK,CAAC;QAEf,IAAI,MAAM,GAAG,IAAI,CAAC;QAClB,MAAM,KAAK,GAAG,uBAAU,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;QACrD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;YAChD,MAAM,SAAS,GAAG,CAAC,uBAAU,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAC1J,IAAI,CAAC,SAAS;gBACZ,MAAM,GAAG,KAAK,CAAC;SAClB;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,4EAA4E;IACrE,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,GAA4D;QAC7F,OAAO,uBAAU,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,GAAG,GAAG,EAAE,WAAW,EAAE,MAAM,uBAAU,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACzG,CAAC;IAED,gFAAgF;IACzE,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAoD;QACtF,OAAO,uBAAU,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,GAAG,GAAG,EAAE,WAAW,EAAE,MAAM,uBAAU,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED,wEAAwE;IACjE,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAA6B;QAClE,OAAO,uBAAU,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAAE,GAAG,GAAG,EAAE,WAAW,EAAE,MAAM,uBAAU,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAC7G,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAkB;QACtD,OAAO,uBAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,uBAAuB,CAAC,cAA4B;QACjE,IAAI,CAAC,uBAAU,CAAC,UAAU,CAAC,cAAc,CAAC;YACxC,OAAO,IAAI,CAAC;QAEd,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,MAAM,GAAG,gBAAgB,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;QAC/D,IAAI,CAAC,MAAM;YACT,OAAO,KAAK,CAAC;QAEf,MAAM,GAAG,gBAAgB,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QAC9D,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAY,EAAE,aAAiC;QACvF,IAAI,aAAa,CAAC,WAAW,KAAK,2BAAa,CAAC,MAAM;YACpD,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,uJAAuJ;QAE3K,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC1C,EAAE,CAAC,SAAS,GAAG,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,CAAC;QAEjD,4CAA4C;QAC5C,uBAAU,CAAC,UAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,EAAY,EAAE,GAAoB;QAC3E,IAAI,CAAC,EAAE,CAAC,MAAM,IAAI,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,gHAAgH;YAC1J,MAAM,IAAI,yBAAW,CAAC,8BAAe,CAAC,UAAU,EAAE,yDAAyD,CAAC,CAAC;QAE/G,IAAI,YAAY,GAAG,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC;QACtC,IAAI,YAAY,KAAK,SAAS;YAC5B,YAAY,GAAG,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAEhK,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QAE3E,uBAAuB;QACvB,MAAM,UAAU,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,kBAAkB,CAAC;YAC/D,WAAW,EAAE,GAAG,CAAC,WAAW;YAC5B,QAAQ,EAAE,EAAE,CAAC,QAAQ;YACrB,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE;YAC1G,SAAS,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,CAAC,QAAQ,CAAC;YAC1D,gBAAgB,EAAE,GAAG,CAAC,UAAU;SACjC,CAAC,CAAC;QAEH,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACzB,OAAO,CAAC,mBAAmB;QAE7B,IAAI,OAAO;YACT,UAAU,CAAC,OAAO,EAAE,CAAC;QAEvB,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;YAClC,MAAM,SAAS,GAAG,IAAI,wBAAS,CAAC,IAAI,SAAS,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;YAC3D,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,6CAA6C,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;YACrG,MAAM,IAAI,CAAC,oBAAoB,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;YAC/C,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,6BAA6B,SAAS,CAAC,WAAW,KAAK,SAAS,CAAC,cAAc,WAAW,CAAC,CAAC;SAC5H;QACD,mBAAmB;QACnB,EAAE,CAAC,sBAAsB,EAAE,CAAC;IAC9B,CAAC;IAED,4EAA4E;IACpE,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,EAAe,EAAE,GAAoB;QACpE,MAAM,cAAc,GAAG,EAAE,CAAC,QAAQ,CAAC,oBAAoB,EAAwB,CAAC;QAChF,cAAc,CAAC,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC;QAC5C,cAAc,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC;QAC7C,MAAM,QAAQ,GAAG,uBAAU,CAAC,SAAS,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC;QACrE,IAAI,CAAC,QAAQ,EAAE,oCAAoC;YACjD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,0BAA0B,CAAC,CAAC;QAE5E,cAAc,CAAC,IAAI,GAAG,QAAQ,CAAC;QAE/B,IAAI,UAAU,GAAG,GAAG,CAAC,cAAc,IAAI,CAAC,CAAC;QACzC,OAAO,IAAI,EAAE;YACX,IAAI;gBACF,MAAM,WAAW,GAAG,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC;gBACtD,MAAM,KAAK,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,EAAE,cAAc,EAAE,CAAC,CAAC;gBAC/G,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC/C,EAAE,CAAC,SAAS,GAAG,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,CAAC;gBACjD,IAAI,CAAC,GAAG,CAAC,WAAW;oBAClB,MAAM,EAAE,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC;gBAEnC,OAAO;aACR;YAAC,OAAO,GAAQ,EAAE;gBACjB,MAAM,WAAW,GAAG,GAAG,EAAE;oBACvB,IAAI,UAAU,EAAE,IAAI,CAAC;wBACnB,OAAO,KAAK,CAAC;oBACf,QAAQ,GAAG,CAAC,WAAW,EAAE;wBACvB,KAAK,8BAAe,CAAC,kBAAkB,CAAC;wBACxC,KAAK,8BAAe,CAAC,yBAAyB,CAAC;wBAC/C,KAAK,8BAAe,CAAC,eAAe;4BAClC,OAAO,IAAI,CAAC;qBACf;oBACD,OAAO,KAAK,CAAC;gBACf,CAAC,CAAC;gBAEF,IAAI,CAAC,WAAW,EAAE,EAAE;oBAClB,EAAE,CAAC,QAAQ,CAAC,sBAAsB,EAAE,CAAC;oBACrC,MAAM,GAAG,CAAC;iBACX;aACF;oBAAS;gBACR,uBAAU,CAAC,UAAU,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;aAChD;SACF;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,EAAe,EAAE,GAAoB;QACrE,IAAI,UAAU,GAAG,GAAG,CAAC,eAAe,IAAI,CAAC,CAAC;QAC1C,OAAO,IAAI,EAAE;YACX,IAAI;gBACF,MAAM,gBAAgB,CAAC,sBAAsB,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;gBACvD,OAAO,MAAM,gBAAgB,CAAC,WAAW,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;aACpD;YAAC,OAAO,GAAQ,EAAE;gBACjB,IAAI,UAAU,EAAE,IAAI,CAAC,IAAI,GAAG,CAAC,WAAW,KAAK,8BAAe,CAAC,cAAc;oBACzE,MAAM,CAAC,GAAG,CAAC,CAAC;gBACd,MAAM,CAAC,GAAG,CAAC,eAAe,IAAI,yBAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aACjE;SACF;IACH,CAAC;;AAtac,iCAAgB,GAAG,YAAY,CAAC;AAbpC,4CAAgB","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\n// cspell:ignore cset csets ecchanges\r\n\r\nimport * as path from \"path\";\r\nimport {\r\n  AccessToken, BeDuration, ChangeSetStatus, GuidString, IModelHubStatus, IModelStatus, Logger, OpenMode, StopWatch,\r\n} from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseId, BriefcaseIdValue, BriefcaseProps, ChangesetFileProps, ChangesetIndex, ChangesetIndexOrId, ChangesetProps, ChangesetRange, ChangesetType, IModelError, IModelVersion, LocalBriefcaseProps,\r\n  LocalDirName, LocalFileName, RequestNewBriefcaseProps,\r\n} from \"@itwin/core-common\";\r\nimport { AcquireNewBriefcaseIdArg, IModelNameArg } from \"./BackendHubAccess\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { CheckpointManager, CheckpointProps, ProgressFunction } from \"./CheckpointManager\";\r\nimport { BriefcaseDb, IModelDb, TokenArg } from \"./IModelDb\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\n\r\nconst loggerCategory = BackendLoggerCategory.IModelDb;\r\n\r\n/** The argument for [[BriefcaseManager.downloadBriefcase]]\r\n * @public\r\n*/\r\nexport interface RequestNewBriefcaseArg extends TokenArg, RequestNewBriefcaseProps {\r\n  /** If present, a function called periodically during the download to indicate progress.\r\n   * @note return non-zero from this function to abort the download.\r\n   */\r\n  onProgress?: ProgressFunction;\r\n}\r\n\r\n/**\r\n * Parameters for pushing changesets to iModelHub\r\n * @public\r\n */\r\nexport interface PushChangesArgs extends TokenArg {\r\n  /** A description of the changes. This is visible on the iModel's timeline. */\r\n  description: string;\r\n  /** if present, the locks are retained after the operation. Otherwise, *all* locks are released after the changeset is successfully pushed. */\r\n  retainLocks?: true;\r\n  /** number of times to retry pull/merge if other users are pushing at the same time. Default is 5 */\r\n  mergeRetryCount?: number;\r\n  /** delay to wait between pull/merge retry attempts. Default is 3 seconds */\r\n  mergeRetryDelay?: BeDuration;\r\n  /** the number of time to attempt to retry to push the changeset upon failure. Default is 3 */\r\n  pushRetryCount?: number;\r\n  /** The delay to wait between retry attempts on failed pushes. Default is 3 seconds. */\r\n  pushRetryDelay?: BeDuration;\r\n}\r\n\r\n/**\r\n * Specifies a specific index for pulling changes.\r\n * @public\r\n */\r\nexport interface ToChangesetArgs extends TokenArg {\r\n  /** The last ChangesetIndex to pull. If not present, pull *all* newer changesets. */\r\n  toIndex?: ChangesetIndex;\r\n}\r\n\r\n/** Arguments for [[BriefcaseManager.pullAndApplyChangesets]]\r\n * @public\r\n */\r\nexport type PullChangesArgs = ToChangesetArgs & {\r\n  /** If present, a function called periodically during the download to indicate progress.\r\n   * @note return non-zero from this function to abort the download.\r\n   */\r\n  onProgress?: ProgressFunction;\r\n};\r\n\r\n/** Manages downloading Briefcases and downloading and uploading changesets.\r\n * @public\r\n */\r\nexport class BriefcaseManager {\r\n  /** Get the local path of the folder storing files that are associated with an imodel */\r\n  public static getIModelPath(iModelId: GuidString): LocalDirName { return path.join(this._cacheDir, iModelId); }\r\n\r\n  /** @internal */\r\n  public static getChangeSetsPath(iModelId: GuidString): LocalDirName { return path.join(this.getIModelPath(iModelId), \"changesets\"); }\r\n\r\n  /** @internal */\r\n  public static getChangeCachePathName(iModelId: GuidString): LocalFileName { return path.join(this.getIModelPath(iModelId), iModelId.concat(\".bim.ecchanges\")); }\r\n\r\n  /** @internal */\r\n  public static getChangedElementsPathName(iModelId: GuidString): LocalFileName { return path.join(this.getIModelPath(iModelId), iModelId.concat(\".bim.elems\")); }\r\n\r\n  private static _briefcaseSubDir = \"briefcases\";\r\n  /** Get the local path of the folder storing briefcases associated with the specified iModel. */\r\n  public static getBriefcaseBasePath(iModelId: GuidString): LocalDirName {\r\n    return path.join(this.getIModelPath(iModelId), this._briefcaseSubDir);\r\n  }\r\n\r\n  /** Get the name of the local file that holds, or will hold, a local briefcase in the briefcase cache.\r\n   * @note The briefcase cache is a local directory established in the call to [[BriefcaseManager.initialize]].\r\n   * @param briefcase the iModelId and BriefcaseId for the filename\r\n   * @see getIModelPath\r\n   */\r\n  public static getFileName(briefcase: BriefcaseProps): LocalFileName {\r\n    return path.join(this.getBriefcaseBasePath(briefcase.iModelId), `${briefcase.briefcaseId}.bim`);\r\n  }\r\n\r\n  private static setupCacheDir(cacheRootDir: LocalDirName) {\r\n    this._cacheDir = cacheRootDir;\r\n    IModelJsFs.recursiveMkDirSync(this._cacheDir);\r\n  }\r\n\r\n  private static _initialized?: boolean;\r\n  /** Initialize BriefcaseManager\r\n   * @param cacheRootDir The root directory for storing a cache of downloaded briefcase files on the local computer.\r\n   * Briefcases are stored relative to this path in sub-folders organized by IModelId.\r\n   * @note It is perfectly valid for applications to store briefcases in locations they manage, outside of `cacheRootDir`.\r\n   */\r\n  public static initialize(cacheRootDir: LocalDirName) {\r\n    if (this._initialized)\r\n      return;\r\n    this.setupCacheDir(cacheRootDir);\r\n    IModelHost.onBeforeShutdown.addOnce(() => this.finalize());\r\n    this._initialized = true;\r\n  }\r\n\r\n  private static finalize() {\r\n    this._initialized = false;\r\n  }\r\n\r\n  /** Get a list of the local briefcase held in the briefcase cache, optionally for a single iModelId\r\n   * @param iModelId if present, only briefcases for this iModelId are returned, otherwise all briefcases for all\r\n   * iModels in the briefcase cache are returned.\r\n   * @note usually there should only be one briefcase per iModel.\r\n   */\r\n  public static getCachedBriefcases(iModelId?: GuidString): LocalBriefcaseProps[] {\r\n    const briefcaseList: LocalBriefcaseProps[] = [];\r\n    const iModelDirs = IModelJsFs.readdirSync(this._cacheDir);\r\n    for (const iModelDir of iModelDirs) {\r\n      if (iModelId && iModelId !== iModelDir)\r\n        continue;\r\n      const bcPath = path.join(this._cacheDir, iModelDir, this._briefcaseSubDir);\r\n      try {\r\n        if (!IModelJsFs.lstatSync(bcPath)?.isDirectory)\r\n          continue;\r\n      } catch (err) {\r\n        continue;\r\n      }\r\n\r\n      const briefcases = IModelJsFs.readdirSync(bcPath);\r\n      for (const briefcaseName of briefcases) {\r\n        if (briefcaseName.endsWith(\".bim\")) {\r\n          try {\r\n            const fileName = path.join(bcPath, briefcaseName);\r\n            const fileSize = IModelJsFs.lstatSync(fileName)?.size ?? 0;\r\n            const db = IModelDb.openDgnDb({ path: fileName }, OpenMode.Readonly);\r\n            briefcaseList.push({ fileName, iTwinId: db.getITwinId(), iModelId: db.getIModelId(), briefcaseId: db.getBriefcaseId(), changeset: db.getCurrentChangeset(), fileSize });\r\n            db.closeFile();\r\n          } catch (_err) {\r\n          }\r\n        }\r\n      }\r\n    }\r\n    return briefcaseList;\r\n  }\r\n\r\n  private static _cacheDir: LocalDirName;\r\n  /** Get the root directory for the briefcase cache */\r\n  public static get cacheDir(): LocalDirName { return this._cacheDir; }\r\n\r\n  /** Determine whether the supplied briefcaseId is in the range of assigned BriefcaseIds issued by iModelHub\r\n   * @note this does check whether the id was actually acquired by the caller.\r\n   */\r\n  public static isValidBriefcaseId(id: BriefcaseId) {\r\n    return id >= BriefcaseIdValue.FirstValid && id <= BriefcaseIdValue.LastValid;\r\n  }\r\n\r\n  /** Acquire a new briefcaseId from iModelHub for the supplied iModelId\r\n   * @note usually there should only be one briefcase per iModel per user. If a single user acquires more than one briefcaseId,\r\n   * it's a good idea to supply different aliases for each of them.\r\n   */\r\n  public static async acquireNewBriefcaseId(arg: AcquireNewBriefcaseIdArg): Promise<BriefcaseId> {\r\n    return IModelHost.hubAccess.acquireNewBriefcaseId(arg);\r\n  }\r\n\r\n  /**\r\n   * Download a new briefcase from iModelHub for the supplied iModelId.\r\n   *\r\n   * Briefcases are local files holding a copy of an iModel.\r\n   * 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.\r\n   * 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.\r\n   * Readonly briefcases are \"unassigned\" with the special value [[BriefcaseId.Unassigned]].\r\n   *\r\n   * 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\r\n   * briefcase to make isolated independent sets of changes, but that is exceedingly complicated and rare.\r\n   *\r\n   * Callers of this method may supply a BriefcaseId, or if none is supplied, a new one is acquired from iModelHub.\r\n   *\r\n   * @param arg The arguments that specify the briefcase file to be downloaded.\r\n   * @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).\r\n   * @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\r\n   * 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\r\n   * for the IModelId.\r\n   * @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)\r\n   */\r\n  public static async downloadBriefcase(arg: RequestNewBriefcaseArg): Promise<LocalBriefcaseProps> {\r\n    const briefcaseId = arg.briefcaseId ?? await this.acquireNewBriefcaseId(arg);\r\n    const fileName = arg.fileName ?? this.getFileName({ ...arg, briefcaseId });\r\n\r\n    if (IModelJsFs.existsSync(fileName))\r\n      throw new IModelError(IModelStatus.FileAlreadyExists, `Briefcase \"${fileName}\" already exists`);\r\n\r\n    const asOf = arg.asOf ?? IModelVersion.latest().toJSON();\r\n    const changeset = await IModelHost.hubAccess.getChangesetFromVersion({ ...arg, version: IModelVersion.fromJSON(asOf) });\r\n    const checkpoint: CheckpointProps = { ...arg, changeset };\r\n\r\n    try {\r\n      await CheckpointManager.downloadCheckpoint({ localFile: fileName, checkpoint, onProgress: arg.onProgress });\r\n    } catch (error: unknown) {\r\n      if (arg.accessToken && arg.briefcaseId === undefined)\r\n        await this.releaseBriefcase(arg.accessToken, { briefcaseId, iModelId: arg.iModelId });\r\n\r\n      throw error;\r\n    }\r\n\r\n    const fileSize = IModelJsFs.lstatSync(fileName)?.size ?? 0;\r\n    const response: LocalBriefcaseProps = {\r\n      fileName,\r\n      briefcaseId,\r\n      iModelId: arg.iModelId,\r\n      iTwinId: arg.iTwinId,\r\n      changeset: checkpoint.changeset,\r\n      fileSize,\r\n    };\r\n\r\n    // now open the downloaded checkpoint and reset its BriefcaseId\r\n    const nativeDb = new IModelHost.platform.DgnDb();\r\n    try {\r\n      nativeDb.openIModel(fileName, OpenMode.ReadWrite);\r\n    } catch (err: any) {\r\n      throw new IModelError(err.errorNumber, `Could not open downloaded briefcase for write access: ${fileName}, err=${err.message}`);\r\n    }\r\n    try {\r\n      nativeDb.enableWalMode(); // local briefcases should use WAL journal mode\r\n      nativeDb.resetBriefcaseId(briefcaseId);\r\n      if (nativeDb.getCurrentChangeset().id !== checkpoint.changeset.id)\r\n        throw new IModelError(IModelStatus.InvalidId, `Downloaded briefcase has wrong changesetId: ${fileName}`);\r\n    } finally {\r\n      nativeDb.saveChanges();\r\n      nativeDb.closeFile();\r\n    }\r\n    return response;\r\n  }\r\n\r\n  /** Deletes change sets of an iModel from local disk\r\n   * @internal\r\n   */\r\n  public static deleteChangeSetsFromLocalDisk(iModelId: string) {\r\n    const changesetsPath = BriefcaseManager.getChangeSetsPath(iModelId);\r\n    BriefcaseManager.deleteFolderAndContents(changesetsPath);\r\n  }\r\n\r\n  /** Releases a briefcaseId from iModelHub. After this call it is illegal to generate changesets for the released briefcaseId.\r\n   * @note generally, this method should not be called directly. Instead use [[deleteBriefcaseFiles]].\r\n   * @see deleteBriefcaseFiles\r\n   */\r\n  public static async releaseBriefcase(accessToken: AccessToken, briefcase: BriefcaseProps): Promise<void> {\r\n    if (this.isValidBriefcaseId(briefcase.briefcaseId))\r\n      return IModelHost.hubAccess.releaseBriefcase({ accessToken, iModelId: briefcase.iModelId, briefcaseId: briefcase.briefcaseId });\r\n  }\r\n\r\n  /**\r\n   * Delete and clean up a briefcase and all of its associated files. First, this method opens the supplied filename to determine its briefcaseId.\r\n   * Then, if a requestContext is supplied, it releases a BriefcaseId from iModelHub. Finally it deletes the local briefcase file and\r\n   * associated files (that is, all files in the same directory that start with the briefcase name).\r\n   * @param filePath the full file name of the Briefcase to delete\r\n   * @param accessToken for releasing the briefcaseId\r\n   */\r\n  public static async deleteBriefcaseFiles(filePath: LocalFileName, accessToken?: AccessToken): Promise<void> {\r\n    try {\r\n      const db = IModelDb.openDgnDb({ path: filePath }, OpenMode.Readonly);\r\n      const briefcase: BriefcaseProps = {\r\n        iModelId: db.getIModelId(),\r\n        briefcaseId: db.getBriefcaseId(),\r\n      };\r\n      db.closeFile();\r\n\r\n      if (accessToken) {\r\n        if (this.isValidBriefcaseId(briefcase.briefcaseId)) {\r\n          await BriefcaseManager.releaseBriefcase(accessToken, briefcase);\r\n        }\r\n      }\r\n    } catch (error) {\r\n    }\r\n\r\n    // first try to delete the briefcase file\r\n    try {\r\n      if (IModelJsFs.existsSync(filePath))\r\n        IModelJsFs.unlinkSync(filePath);\r\n    } catch (err) {\r\n      throw new IModelError(IModelStatus.BadRequest, `cannot delete briefcase file ${err}`);\r\n    }\r\n\r\n    // next, delete all files that start with the briefcase's filePath (e.g. \"a.bim-locks\", \"a.bim-journal\", etc.)\r\n    try {\r\n      const dirName = path.dirname(filePath);\r\n      const fileName = path.basename(filePath);\r\n      const files = IModelJsFs.readdirSync(dirName);\r\n      for (const file of files) {\r\n        if (file.startsWith(fileName))\r\n          this.deleteFile(path.join(dirName, file)); // don't throw on error\r\n      }\r\n    } catch (err) {\r\n    }\r\n  }\r\n\r\n  /** Deletes a file\r\n   *  - Does not throw any error, but logs it instead\r\n   *  - Returns true if the delete was successful\r\n   */\r\n  private static deleteFile(pathname: LocalFileName): boolean {\r\n    try {\r\n      IModelJsFs.unlinkSync(pathname);\r\n    } catch (error) {\r\n      Logger.logError(loggerCategory, `Cannot delete file ${pathname}, ${error}`);\r\n      return false;\r\n    }\r\n    return true;\r\n  }\r\n\r\n  /** Deletes a folder, checking if it's empty\r\n   *  - Does not throw any error, but logs it instead\r\n   *  - Returns true if the delete was successful\r\n   */\r\n  private static deleteFolderIfEmpty(folderPathname: LocalDirName): boolean {\r\n    try {\r\n      const files = IModelJsFs.readdirSync(folderPathname);\r\n      if (files.length > 0)\r\n        return false;\r\n\r\n      IModelJsFs.rmdirSync(folderPathname);\r\n    } catch (error) {\r\n      Logger.logError(loggerCategory, `Cannot delete folder: ${folderPathname}`);\r\n      return false;\r\n    }\r\n    return true;\r\n  }\r\n\r\n  /** Deletes the contents of a folder, but not the folder itself\r\n   *  - Does not throw any errors, but logs them.\r\n   *  - returns true if the delete was successful.\r\n   */\r\n  private static deleteFolderContents(folderPathname: LocalDirName): boolean {\r\n    if (!IModelJsFs.existsSync(folderPathname))\r\n      return false;\r\n\r\n    let status = true;\r\n    const files = IModelJsFs.readdirSync(folderPathname);\r\n    for (const file of files) {\r\n      const curPath = path.join(folderPathname, file);\r\n      const locStatus = (IModelJsFs.lstatSync(curPath)?.isDirectory) ? BriefcaseManager.deleteFolderAndContents(curPath) : BriefcaseManager.deleteFile(curPath);\r\n      if (!locStatus)\r\n        status = false;\r\n    }\r\n    return status;\r\n  }\r\n\r\n  /** Query the hub for the properties for a ChangesetIndex or ChangesetId  */\r\n  public static async queryChangeset(arg: { iModelId: GuidString, changeset: ChangesetIndexOrId }): Promise<ChangesetProps> {\r\n    return IModelHost.hubAccess.queryChangeset({ ...arg, accessToken: await IModelHost.getAccessToken() });\r\n  }\r\n\r\n  /** Query the hub for an array of changeset properties given a ChangesetRange */\r\n  public static async queryChangesets(arg: { iModelId: GuidString, range: ChangesetRange }): Promise<ChangesetProps[]> {\r\n    return IModelHost.hubAccess.queryChangesets({ ...arg, accessToken: await IModelHost.getAccessToken() });\r\n  }\r\n\r\n  /** Query the hub for the ChangesetProps of the most recent changeset */\r\n  public static async getLatestChangeset(arg: { iModelId: GuidString }): Promise<ChangesetProps> {\r\n    return IModelHost.hubAccess.getLatestChangeset({ ...arg, accessToken: await IModelHost.getAccessToken() });\r\n  }\r\n\r\n  /** Query the Id of an iModel by name.\r\n   * @param arg Identifies the iModel of interest\r\n   * @returns the Id of the corresponding iModel, or `undefined` if no such iModel exists.\r\n   */\r\n  public static async queryIModelByName(arg: IModelNameArg): Promise<GuidString | undefined> {\r\n    return IModelHost.hubAccess.queryIModelByName(arg);\r\n  }\r\n\r\n  /** Deletes a folder and all it's contents.\r\n   *  - Does not throw any errors, but logs them.\r\n   *  - returns true if the delete was successful.\r\n   */\r\n  private static deleteFolderAndContents(folderPathname: LocalDirName): boolean {\r\n    if (!IModelJsFs.existsSync(folderPathname))\r\n      return true;\r\n\r\n    let status = false;\r\n    status = BriefcaseManager.deleteFolderContents(folderPathname);\r\n    if (!status)\r\n      return false;\r\n\r\n    status = BriefcaseManager.deleteFolderIfEmpty(folderPathname);\r\n    return status;\r\n  }\r\n\r\n  private static async applySingleChangeset(db: IModelDb, changesetFile: ChangesetFileProps) {\r\n    if (changesetFile.changesType === ChangesetType.Schema)\r\n      db.clearCaches(); // for schema changesets, statement caches may become invalid. Do this *before* applying, in case db needs to be closed (open statements hold db open.)\r\n\r\n    db.nativeDb.applyChangeset(changesetFile);\r\n    db.changeset = db.nativeDb.getCurrentChangeset();\r\n\r\n    // we're done with this changeset, delete it\r\n    IModelJsFs.removeSync(changesetFile.pathname);\r\n  }\r\n\r\n  /** @internal */\r\n  public static async pullAndApplyChangesets(db: IModelDb, arg: PullChangesArgs): Promise<void> {\r\n    if (!db.isOpen || db.nativeDb.isReadonly()) // don't use db.isReadonly - we reopen the file writable just for this operation but db.isReadonly is still true\r\n      throw new IModelError(ChangeSetStatus.ApplyError, \"Briefcase must be open ReadWrite to process change sets\");\r\n\r\n    let currentIndex = db.changeset.index;\r\n    if (currentIndex === undefined)\r\n      currentIndex = (await IModelHost.hubAccess.queryChangeset({ accessToken: arg.accessToken, iModelId: db.iModelId, changeset: { id: db.changeset.id } })).index;\r\n\r\n    const reverse = (arg.toIndex && arg.toIndex < currentIndex) ? true : false;\r\n\r\n    // Download change sets\r\n    const changesets = await IModelHost.hubAccess.downloadChangesets({\r\n      accessToken: arg.accessToken,\r\n      iModelId: db.iModelId,\r\n      range: { first: reverse ? arg.toIndex! + 1 : currentIndex + 1, end: reverse ? currentIndex : arg.toIndex }, // eslint-disable-line @typescript-eslint/no-non-null-assertion\r\n      targetDir: BriefcaseManager.getChangeSetsPath(db.iModelId),\r\n      progressCallback: arg.onProgress,\r\n    });\r\n\r\n    if (changesets.length === 0)\r\n      return; // nothing to apply\r\n\r\n    if (reverse)\r\n      changesets.reverse();\r\n\r\n    for (const changeset of changesets) {\r\n      const stopwatch = new StopWatch(`[${changeset.id}]`, true);\r\n      Logger.logInfo(loggerCategory, `Starting application of changeset with id ${stopwatch.description}`);\r\n      await this.applySingleChangeset(db, changeset);\r\n      Logger.logInfo(loggerCategory, `Applied changeset with id ${stopwatch.description} (${stopwatch.elapsedSeconds} seconds)`);\r\n    }\r\n    // notify listeners\r\n    db.notifyChangesetApplied();\r\n  }\r\n\r\n  /** create a changeset from the current changes, and push it to iModelHub */\r\n  private static async pushChanges(db: BriefcaseDb, arg: PushChangesArgs): Promise<void> {\r\n    const changesetProps = db.nativeDb.startCreateChangeset() as ChangesetFileProps;\r\n    changesetProps.briefcaseId = db.briefcaseId;\r\n    changesetProps.description = arg.description;\r\n    const fileSize = IModelJsFs.lstatSync(changesetProps.pathname)?.size;\r\n    if (!fileSize) // either undefined or 0 means error\r\n      throw new IModelError(IModelStatus.NoContent, \"error creating changeset\");\r\n\r\n    changesetProps.size = fileSize;\r\n\r\n    let retryCount = arg.pushRetryCount ?? 3;\r\n    while (true) {\r\n      try {\r\n        const accessToken = await IModelHost.getAccessToken();\r\n        const index = await IModelHost.hubAccess.pushChangeset({ accessToken, iModelId: db.iModelId, changesetProps });\r\n        db.nativeDb.completeCreateChangeset({ index });\r\n        db.changeset = db.nativeDb.getCurrentChangeset();\r\n        if (!arg.retainLocks)\r\n          await db.locks.releaseAllLocks();\r\n\r\n        return;\r\n      } catch (err: any) {\r\n        const shouldRetry = () => {\r\n          if (retryCount-- <= 0)\r\n            return false;\r\n          switch (err.errorNumber) {\r\n            case IModelHubStatus.AnotherUserPushing:\r\n            case IModelHubStatus.DatabaseTemporarilyLocked:\r\n            case IModelHubStatus.OperationFailed:\r\n              return true;\r\n          }\r\n          return false;\r\n        };\r\n\r\n        if (!shouldRetry()) {\r\n          db.nativeDb.abandonCreateChangeset();\r\n          throw err;\r\n        }\r\n      } finally {\r\n        IModelJsFs.removeSync(changesetProps.pathname);\r\n      }\r\n    }\r\n  }\r\n\r\n  /** Pull/merge (if necessary), then push all local changes as a changeset. Called by [[BriefcaseDb.pushChanges]]\r\n   * @internal\r\n   */\r\n  public static async pullMergePush(db: BriefcaseDb, arg: PushChangesArgs): Promise<void> {\r\n    let retryCount = arg.mergeRetryCount ?? 5;\r\n    while (true) {\r\n      try {\r\n        await BriefcaseManager.pullAndApplyChangesets(db, arg);\r\n        return await BriefcaseManager.pushChanges(db, arg);\r\n      } catch (err: any) {\r\n        if (retryCount-- <= 0 || err.errorNumber !== IModelHubStatus.PullIsRequired)\r\n          throw (err);\r\n        await (arg.mergeRetryDelay ?? BeDuration.fromSeconds(3)).wait();\r\n      }\r\n    }\r\n  }\r\n\r\n}\r\n"]}
+{"version":3,"file":"BriefcaseManager.js","sourceRoot":"","sources":["../../src/BriefcaseManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,qCAAqC;AAErC,6BAA6B;AAC7B,sDAE6B;AAC7B,oDAG4B;AAE5B,mEAAgE;AAChE,2DAA2F;AAC3F,yCAA6D;AAC7D,6CAA0C;AAC1C,6CAA0C;AAE1C,MAAM,cAAc,GAAG,6CAAqB,CAAC,QAAQ,CAAC;AAkDtD;;GAEG;AACH,MAAa,gBAAgB;IAC3B,wFAAwF;IACjF,MAAM,CAAC,aAAa,CAAC,QAAoB,IAAkB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAE/G,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAAC,QAAoB,IAAkB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IAErI,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,QAAoB,IAAmB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhK,gBAAgB;IACT,MAAM,CAAC,0BAA0B,CAAC,QAAoB,IAAmB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAGhK,gGAAgG;IACzF,MAAM,CAAC,oBAAoB,CAAC,QAAoB;QACrD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,WAAW,CAAC,SAAyB;QACjD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,GAAG,SAAS,CAAC,WAAW,MAAM,CAAC,CAAC;IAClG,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,YAA0B;QACrD,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC;QAC9B,uBAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAChD,CAAC;IAGD;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,YAA0B;QACjD,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO;QACT,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QACjC,uBAAU,CAAC,gBAAgB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC3D,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC3B,CAAC;IAEO,MAAM,CAAC,QAAQ;QACrB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,QAAqB;QACrD,MAAM,aAAa,GAA0B,EAAE,CAAC;QAChD,MAAM,UAAU,GAAG,uBAAU,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1D,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,IAAI,QAAQ,IAAI,QAAQ,KAAK,SAAS;gBACpC,SAAS;YACX,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC3E,IAAI,CAAC;gBACH,IAAI,CAAC,uBAAU,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,WAAW;oBAC5C,SAAS;YACb,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,SAAS;YACX,CAAC;YAED,MAAM,UAAU,GAAG,uBAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YAClD,KAAK,MAAM,aAAa,IAAI,UAAU,EAAE,CAAC;gBACvC,IAAI,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;oBACnC,IAAI,CAAC;wBACH,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;wBAClD,MAAM,QAAQ,GAAG,uBAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC3D,MAAM,EAAE,GAAG,mBAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,uBAAQ,CAAC,QAAQ,CAAC,CAAC;wBACrE,aAAa,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC,WAAW,EAAE,EAAE,WAAW,EAAE,EAAE,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,mBAAmB,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;wBACxK,EAAE,CAAC,SAAS,EAAE,CAAC;oBACjB,CAAC;oBAAC,OAAO,IAAI,EAAE,CAAC;oBAChB,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IAGD,qDAAqD;IAC9C,MAAM,KAAK,QAAQ,KAAmB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAErE;;OAEG;IACI,MAAM,CAAC,kBAAkB,CAAC,EAAe;QAC9C,OAAO,EAAE,IAAI,8BAAgB,CAAC,UAAU,IAAI,EAAE,IAAI,8BAAgB,CAAC,SAAS,CAAC;IAC/E,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,GAA6B;QACrE,OAAO,uBAAU,CAAC,SAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAA2B;QAC/D,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI,MAAM,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;QAC7E,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,IAAI,IAAI,CAAC,WAAW,CAAC,EAAE,GAAG,GAAG,EAAE,WAAW,EAAE,CAAC,CAAC;QAE3E,IAAI,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC;YACjC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,iBAAiB,EAAE,cAAc,QAAQ,kBAAkB,CAAC,CAAC;QAElG,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,IAAI,2BAAa,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC;QACzD,MAAM,SAAS,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,GAAG,GAAG,EAAE,OAAO,EAAE,2BAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACxH,MAAM,UAAU,GAAoB,EAAE,GAAG,GAAG,EAAE,SAAS,EAAE,CAAC;QAE1D,IAAI,CAAC;YACH,MAAM,qCAAiB,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;QAC9G,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,IAAI,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,WAAW,KAAK,SAAS;gBAClD,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;YAExF,MAAM,KAAK,CAAC;QACd,CAAC;QAED,MAAM,QAAQ,GAAG,uBAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC;QAC3D,MAAM,QAAQ,GAAwB;YACpC,QAAQ;YACR,WAAW;YACX,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,SAAS,EAAE,UAAU,CAAC,SAAS;YAC/B,QAAQ;SACT,CAAC;QAEF,+DAA+D;QAC/D,MAAM,QAAQ,GAAG,IAAI,uBAAU,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACjD,IAAI,CAAC;YACH,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,uBAAQ,CAAC,SAAS,CAAC,CAAC;QACpD,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,yBAAW,CAAC,GAAG,CAAC,WAAW,EAAE,yDAAyD,QAAQ,SAAS,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QAClI,CAAC;QACD,IAAI,CAAC;YACH,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC,+CAA+C;YACzE,QAAQ,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;YACvC,IAAI,QAAQ,CAAC,mBAAmB,EAAE,CAAC,EAAE,KAAK,UAAU,CAAC,SAAS,CAAC,EAAE;gBAC/D,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,+CAA+C,QAAQ,EAAE,CAAC,CAAC;QAC7G,CAAC;gBAAS,CAAC;YACT,QAAQ,CAAC,WAAW,EAAE,CAAC;YACvB,QAAQ,CAAC,SAAS,EAAE,CAAC;QACvB,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,6BAA6B,CAAC,QAAgB;QAC1D,MAAM,cAAc,GAAG,gBAAgB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACpE,gBAAgB,CAAC,uBAAuB,CAAC,cAAc,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,WAAwB,EAAE,SAAyB;QACtF,IAAI,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,WAAW,CAAC;YAChD,OAAO,uBAAU,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE,WAAW,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;IACpI,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,QAAuB,EAAE,WAAyB;QACzF,IAAI,CAAC;YACH,MAAM,EAAE,GAAG,mBAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,uBAAQ,CAAC,QAAQ,CAAC,CAAC;YACrE,MAAM,SAAS,GAAmB;gBAChC,QAAQ,EAAE,EAAE,CAAC,WAAW,EAAE;gBAC1B,WAAW,EAAE,EAAE,CAAC,cAAc,EAAE;aACjC,CAAC;YACF,EAAE,CAAC,SAAS,EAAE,CAAC;YAEf,IAAI,WAAW,EAAE,CAAC;gBAChB,IAAI,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC;oBACnD,MAAM,gBAAgB,CAAC,gBAAgB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;gBAClE,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;QACjB,CAAC;QAED,yCAAyC;QACzC,IAAI,CAAC;YACH,IAAI,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC;gBACjC,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,gCAAgC,GAAG,EAAE,CAAC,CAAC;QACxF,CAAC;QAED,8GAA8G;QAC9G,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACzC,MAAM,KAAK,GAAG,uBAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YAC9C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;oBAC3B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,uBAAuB;YACtE,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,UAAU,CAAC,QAAuB;QAC/C,IAAI,CAAC;YACH,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAClC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,sBAAsB,QAAQ,KAAK,KAAK,EAAE,CAAC,CAAC;YAC5E,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,mBAAmB,CAAC,cAA4B;QAC7D,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,uBAAU,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;YACrD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;gBAClB,OAAO,KAAK,CAAC;YAEf,uBAAU,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QACvC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,yBAAyB,cAAc,EAAE,CAAC,CAAC;YAC3E,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,oBAAoB,CAAC,cAA4B;QAC9D,IAAI,CAAC,uBAAU,CAAC,UAAU,CAAC,cAAc,CAAC;YACxC,OAAO,KAAK,CAAC;QAEf,IAAI,MAAM,GAAG,IAAI,CAAC;QAClB,MAAM,KAAK,GAAG,uBAAU,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;QACrD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;YAChD,MAAM,SAAS,GAAG,CAAC,uBAAU,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAC1J,IAAI,CAAC,SAAS;gBACZ,MAAM,GAAG,KAAK,CAAC;QACnB,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,4EAA4E;IACrE,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,GAA4D;QAC7F,OAAO,uBAAU,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,GAAG,GAAG,EAAE,WAAW,EAAE,MAAM,uBAAU,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACzG,CAAC;IAED,gFAAgF;IACzE,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAoD;QACtF,OAAO,uBAAU,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,GAAG,GAAG,EAAE,WAAW,EAAE,MAAM,uBAAU,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED,wEAAwE;IACjE,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAA6B;QAClE,OAAO,uBAAU,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAAE,GAAG,GAAG,EAAE,WAAW,EAAE,MAAM,uBAAU,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAC7G,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAkB;QACtD,OAAO,uBAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,uBAAuB,CAAC,cAA4B;QACjE,IAAI,CAAC,uBAAU,CAAC,UAAU,CAAC,cAAc,CAAC;YACxC,OAAO,IAAI,CAAC;QAEd,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,MAAM,GAAG,gBAAgB,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;QAC/D,IAAI,CAAC,MAAM;YACT,OAAO,KAAK,CAAC;QAEf,MAAM,GAAG,gBAAgB,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QAC9D,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAY,EAAE,aAAiC;QACvF,IAAI,aAAa,CAAC,WAAW,KAAK,2BAAa,CAAC,MAAM;YACpD,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,uJAAuJ;QAE3K,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC1C,EAAE,CAAC,SAAS,GAAG,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,CAAC;QAEjD,4CAA4C;QAC5C,uBAAU,CAAC,UAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,EAAY,EAAE,GAAoB;QAC3E,IAAI,CAAC,EAAE,CAAC,MAAM,IAAI,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,gHAAgH;YAC1J,MAAM,IAAI,yBAAW,CAAC,8BAAe,CAAC,UAAU,EAAE,yDAAyD,CAAC,CAAC;QAE/G,IAAI,YAAY,GAAG,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC;QACtC,IAAI,YAAY,KAAK,SAAS;YAC5B,YAAY,GAAG,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAEhK,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QAE3E,uBAAuB;QACvB,MAAM,UAAU,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,kBAAkB,CAAC;YAC/D,WAAW,EAAE,GAAG,CAAC,WAAW;YAC5B,QAAQ,EAAE,EAAE,CAAC,QAAQ;YACrB,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,+DAA+D;YAC3K,SAAS,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,CAAC,QAAQ,CAAC;YAC1D,gBAAgB,EAAE,GAAG,CAAC,UAAU;SACjC,CAAC,CAAC;QAEH,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACzB,OAAO,CAAC,mBAAmB;QAE7B,IAAI,OAAO;YACT,UAAU,CAAC,OAAO,EAAE,CAAC;QAEvB,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,MAAM,SAAS,GAAG,IAAI,wBAAS,CAAC,IAAI,SAAS,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;YAC3D,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,6CAA6C,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;YACrG,MAAM,IAAI,CAAC,oBAAoB,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;YAC/C,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,6BAA6B,SAAS,CAAC,WAAW,KAAK,SAAS,CAAC,cAAc,WAAW,CAAC,CAAC;QAC7H,CAAC;QACD,mBAAmB;QACnB,EAAE,CAAC,sBAAsB,EAAE,CAAC;IAC9B,CAAC;IAED,4EAA4E;IACpE,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,EAAe,EAAE,GAAoB;QACpE,MAAM,cAAc,GAAG,EAAE,CAAC,QAAQ,CAAC,oBAAoB,EAAwB,CAAC;QAChF,cAAc,CAAC,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC;QAC5C,cAAc,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC;QAC7C,MAAM,QAAQ,GAAG,uBAAU,CAAC,SAAS,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC;QACrE,IAAI,CAAC,QAAQ,EAAE,oCAAoC;YACjD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,0BAA0B,CAAC,CAAC;QAE5E,cAAc,CAAC,IAAI,GAAG,QAAQ,CAAC;QAE/B,IAAI,UAAU,GAAG,GAAG,CAAC,cAAc,IAAI,CAAC,CAAC;QACzC,OAAO,IAAI,EAAE,CAAC;YACZ,IAAI,CAAC;gBACH,MAAM,WAAW,GAAG,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC;gBACtD,MAAM,KAAK,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,EAAE,cAAc,EAAE,CAAC,CAAC;gBAC/G,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC/C,EAAE,CAAC,SAAS,GAAG,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,CAAC;gBACjD,IAAI,CAAC,GAAG,CAAC,WAAW;oBAClB,MAAM,EAAE,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC;gBAEnC,OAAO;YACT,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,MAAM,WAAW,GAAG,GAAG,EAAE;oBACvB,IAAI,UAAU,EAAE,IAAI,CAAC;wBACnB,OAAO,KAAK,CAAC;oBACf,QAAQ,GAAG,CAAC,WAAW,EAAE,CAAC;wBACxB,KAAK,8BAAe,CAAC,kBAAkB,CAAC;wBACxC,KAAK,8BAAe,CAAC,yBAAyB,CAAC;wBAC/C,KAAK,8BAAe,CAAC,eAAe;4BAClC,OAAO,IAAI,CAAC;oBAChB,CAAC;oBACD,OAAO,KAAK,CAAC;gBACf,CAAC,CAAC;gBAEF,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;oBACnB,EAAE,CAAC,QAAQ,CAAC,sBAAsB,EAAE,CAAC;oBACrC,MAAM,GAAG,CAAC;gBACZ,CAAC;YACH,CAAC;oBAAS,CAAC;gBACT,uBAAU,CAAC,UAAU,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,EAAe,EAAE,GAAoB;QACrE,IAAI,UAAU,GAAG,GAAG,CAAC,eAAe,IAAI,CAAC,CAAC;QAC1C,OAAO,IAAI,EAAE,CAAC;YACZ,IAAI,CAAC;gBACH,MAAM,gBAAgB,CAAC,sBAAsB,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;gBACvD,OAAO,MAAM,gBAAgB,CAAC,WAAW,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;YACrD,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,IAAI,UAAU,EAAE,IAAI,CAAC,IAAI,GAAG,CAAC,WAAW,KAAK,8BAAe,CAAC,cAAc;oBACzE,MAAM,CAAC,GAAG,CAAC,CAAC;gBACd,MAAM,CAAC,GAAG,CAAC,eAAe,IAAI,yBAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAClE,CAAC;QACH,CAAC;IACH,CAAC;;AAnbH,4CAqbC;AAxagB,iCAAgB,GAAG,YAAY,CAAC","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\n// cspell:ignore cset csets ecchanges\r\n\r\nimport * as path from \"path\";\r\nimport {\r\n  AccessToken, BeDuration, ChangeSetStatus, GuidString, IModelHubStatus, IModelStatus, Logger, OpenMode, StopWatch,\r\n} from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseId, BriefcaseIdValue, BriefcaseProps, ChangesetFileProps, ChangesetIndex, ChangesetIndexOrId, ChangesetProps, ChangesetRange, ChangesetType, IModelError, IModelVersion, LocalBriefcaseProps,\r\n  LocalDirName, LocalFileName, RequestNewBriefcaseProps,\r\n} from \"@itwin/core-common\";\r\nimport { AcquireNewBriefcaseIdArg, IModelNameArg } from \"./BackendHubAccess\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { CheckpointManager, CheckpointProps, ProgressFunction } from \"./CheckpointManager\";\r\nimport { BriefcaseDb, IModelDb, TokenArg } from \"./IModelDb\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\n\r\nconst loggerCategory = BackendLoggerCategory.IModelDb;\r\n\r\n/** The argument for [[BriefcaseManager.downloadBriefcase]]\r\n * @public\r\n*/\r\nexport interface RequestNewBriefcaseArg extends TokenArg, RequestNewBriefcaseProps {\r\n  /** If present, a function called periodically during the download to indicate progress.\r\n   * @note return non-zero from this function to abort the download.\r\n   */\r\n  onProgress?: ProgressFunction;\r\n}\r\n\r\n/**\r\n * Parameters for pushing changesets to iModelHub\r\n * @public\r\n */\r\nexport interface PushChangesArgs extends TokenArg {\r\n  /** A description of the changes. This is visible on the iModel's timeline. */\r\n  description: string;\r\n  /** if present, the locks are retained after the operation. Otherwise, *all* locks are released after the changeset is successfully pushed. */\r\n  retainLocks?: true;\r\n  /** number of times to retry pull/merge if other users are pushing at the same time. Default is 5 */\r\n  mergeRetryCount?: number;\r\n  /** delay to wait between pull/merge retry attempts. Default is 3 seconds */\r\n  mergeRetryDelay?: BeDuration;\r\n  /** the number of time to attempt to retry to push the changeset upon failure. Default is 3 */\r\n  pushRetryCount?: number;\r\n  /** The delay to wait between retry attempts on failed pushes. Default is 3 seconds. */\r\n  pushRetryDelay?: BeDuration;\r\n}\r\n\r\n/**\r\n * Specifies a specific index for pulling changes.\r\n * @public\r\n */\r\nexport interface ToChangesetArgs extends TokenArg {\r\n  /** The last ChangesetIndex to pull. If not present, pull *all* newer changesets. */\r\n  toIndex?: ChangesetIndex;\r\n}\r\n\r\n/** Arguments for [[BriefcaseManager.pullAndApplyChangesets]]\r\n * @public\r\n */\r\nexport type PullChangesArgs = ToChangesetArgs & {\r\n  /** If present, a function called periodically during the download to indicate progress.\r\n   * @note return non-zero from this function to abort the download.\r\n   */\r\n  onProgress?: ProgressFunction;\r\n};\r\n\r\n/** Manages downloading Briefcases and downloading and uploading changesets.\r\n * @public\r\n */\r\nexport class BriefcaseManager {\r\n  /** Get the local path of the folder storing files that are associated with an imodel */\r\n  public static getIModelPath(iModelId: GuidString): LocalDirName { return path.join(this._cacheDir, iModelId); }\r\n\r\n  /** @internal */\r\n  public static getChangeSetsPath(iModelId: GuidString): LocalDirName { return path.join(this.getIModelPath(iModelId), \"changesets\"); }\r\n\r\n  /** @internal */\r\n  public static getChangeCachePathName(iModelId: GuidString): LocalFileName { return path.join(this.getIModelPath(iModelId), iModelId.concat(\".bim.ecchanges\")); }\r\n\r\n  /** @internal */\r\n  public static getChangedElementsPathName(iModelId: GuidString): LocalFileName { return path.join(this.getIModelPath(iModelId), iModelId.concat(\".bim.elems\")); }\r\n\r\n  private static _briefcaseSubDir = \"briefcases\";\r\n  /** Get the local path of the folder storing briefcases associated with the specified iModel. */\r\n  public static getBriefcaseBasePath(iModelId: GuidString): LocalDirName {\r\n    return path.join(this.getIModelPath(iModelId), this._briefcaseSubDir);\r\n  }\r\n\r\n  /** Get the name of the local file that holds, or will hold, a local briefcase in the briefcase cache.\r\n   * @note The briefcase cache is a local directory established in the call to [[BriefcaseManager.initialize]].\r\n   * @param briefcase the iModelId and BriefcaseId for the filename\r\n   * @see getIModelPath\r\n   */\r\n  public static getFileName(briefcase: BriefcaseProps): LocalFileName {\r\n    return path.join(this.getBriefcaseBasePath(briefcase.iModelId), `${briefcase.briefcaseId}.bim`);\r\n  }\r\n\r\n  private static setupCacheDir(cacheRootDir: LocalDirName) {\r\n    this._cacheDir = cacheRootDir;\r\n    IModelJsFs.recursiveMkDirSync(this._cacheDir);\r\n  }\r\n\r\n  private static _initialized?: boolean;\r\n  /** Initialize BriefcaseManager\r\n   * @param cacheRootDir The root directory for storing a cache of downloaded briefcase files on the local computer.\r\n   * Briefcases are stored relative to this path in sub-folders organized by IModelId.\r\n   * @note It is perfectly valid for applications to store briefcases in locations they manage, outside of `cacheRootDir`.\r\n   */\r\n  public static initialize(cacheRootDir: LocalDirName) {\r\n    if (this._initialized)\r\n      return;\r\n    this.setupCacheDir(cacheRootDir);\r\n    IModelHost.onBeforeShutdown.addOnce(() => this.finalize());\r\n    this._initialized = true;\r\n  }\r\n\r\n  private static finalize() {\r\n    this._initialized = false;\r\n  }\r\n\r\n  /** Get a list of the local briefcase held in the briefcase cache, optionally for a single iModelId\r\n   * @param iModelId if present, only briefcases for this iModelId are returned, otherwise all briefcases for all\r\n   * iModels in the briefcase cache are returned.\r\n   * @note usually there should only be one briefcase per iModel.\r\n   */\r\n  public static getCachedBriefcases(iModelId?: GuidString): LocalBriefcaseProps[] {\r\n    const briefcaseList: LocalBriefcaseProps[] = [];\r\n    const iModelDirs = IModelJsFs.readdirSync(this._cacheDir);\r\n    for (const iModelDir of iModelDirs) {\r\n      if (iModelId && iModelId !== iModelDir)\r\n        continue;\r\n      const bcPath = path.join(this._cacheDir, iModelDir, this._briefcaseSubDir);\r\n      try {\r\n        if (!IModelJsFs.lstatSync(bcPath)?.isDirectory)\r\n          continue;\r\n      } catch (err) {\r\n        continue;\r\n      }\r\n\r\n      const briefcases = IModelJsFs.readdirSync(bcPath);\r\n      for (const briefcaseName of briefcases) {\r\n        if (briefcaseName.endsWith(\".bim\")) {\r\n          try {\r\n            const fileName = path.join(bcPath, briefcaseName);\r\n            const fileSize = IModelJsFs.lstatSync(fileName)?.size ?? 0;\r\n            const db = IModelDb.openDgnDb({ path: fileName }, OpenMode.Readonly);\r\n            briefcaseList.push({ fileName, iTwinId: db.getITwinId(), iModelId: db.getIModelId(), briefcaseId: db.getBriefcaseId(), changeset: db.getCurrentChangeset(), fileSize });\r\n            db.closeFile();\r\n          } catch (_err) {\r\n          }\r\n        }\r\n      }\r\n    }\r\n    return briefcaseList;\r\n  }\r\n\r\n  private static _cacheDir: LocalDirName;\r\n  /** Get the root directory for the briefcase cache */\r\n  public static get cacheDir(): LocalDirName { return this._cacheDir; }\r\n\r\n  /** Determine whether the supplied briefcaseId is in the range of assigned BriefcaseIds issued by iModelHub\r\n   * @note this does check whether the id was actually acquired by the caller.\r\n   */\r\n  public static isValidBriefcaseId(id: BriefcaseId) {\r\n    return id >= BriefcaseIdValue.FirstValid && id <= BriefcaseIdValue.LastValid;\r\n  }\r\n\r\n  /** Acquire a new briefcaseId from iModelHub for the supplied iModelId\r\n   * @note usually there should only be one briefcase per iModel per user. If a single user acquires more than one briefcaseId,\r\n   * it's a good idea to supply different aliases for each of them.\r\n   */\r\n  public static async acquireNewBriefcaseId(arg: AcquireNewBriefcaseIdArg): Promise<BriefcaseId> {\r\n    return IModelHost.hubAccess.acquireNewBriefcaseId(arg);\r\n  }\r\n\r\n  /**\r\n   * Download a new briefcase from iModelHub for the supplied iModelId.\r\n   *\r\n   * Briefcases are local files holding a copy of an iModel.\r\n   * 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.\r\n   * 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.\r\n   * Readonly briefcases are \"unassigned\" with the special value [[BriefcaseId.Unassigned]].\r\n   *\r\n   * 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\r\n   * briefcase to make isolated independent sets of changes, but that is exceedingly complicated and rare.\r\n   *\r\n   * Callers of this method may supply a BriefcaseId, or if none is supplied, a new one is acquired from iModelHub.\r\n   *\r\n   * @param arg The arguments that specify the briefcase file to be downloaded.\r\n   * @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).\r\n   * @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\r\n   * 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\r\n   * for the IModelId.\r\n   * @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)\r\n   */\r\n  public static async downloadBriefcase(arg: RequestNewBriefcaseArg): Promise<LocalBriefcaseProps> {\r\n    const briefcaseId = arg.briefcaseId ?? await this.acquireNewBriefcaseId(arg);\r\n    const fileName = arg.fileName ?? this.getFileName({ ...arg, briefcaseId });\r\n\r\n    if (IModelJsFs.existsSync(fileName))\r\n      throw new IModelError(IModelStatus.FileAlreadyExists, `Briefcase \"${fileName}\" already exists`);\r\n\r\n    const asOf = arg.asOf ?? IModelVersion.latest().toJSON();\r\n    const changeset = await IModelHost.hubAccess.getChangesetFromVersion({ ...arg, version: IModelVersion.fromJSON(asOf) });\r\n    const checkpoint: CheckpointProps = { ...arg, changeset };\r\n\r\n    try {\r\n      await CheckpointManager.downloadCheckpoint({ localFile: fileName, checkpoint, onProgress: arg.onProgress });\r\n    } catch (error: unknown) {\r\n      if (arg.accessToken && arg.briefcaseId === undefined)\r\n        await this.releaseBriefcase(arg.accessToken, { briefcaseId, iModelId: arg.iModelId });\r\n\r\n      throw error;\r\n    }\r\n\r\n    const fileSize = IModelJsFs.lstatSync(fileName)?.size ?? 0;\r\n    const response: LocalBriefcaseProps = {\r\n      fileName,\r\n      briefcaseId,\r\n      iModelId: arg.iModelId,\r\n      iTwinId: arg.iTwinId,\r\n      changeset: checkpoint.changeset,\r\n      fileSize,\r\n    };\r\n\r\n    // now open the downloaded checkpoint and reset its BriefcaseId\r\n    const nativeDb = new IModelHost.platform.DgnDb();\r\n    try {\r\n      nativeDb.openIModel(fileName, OpenMode.ReadWrite);\r\n    } catch (err: any) {\r\n      throw new IModelError(err.errorNumber, `Could not open downloaded briefcase for write access: ${fileName}, err=${err.message}`);\r\n    }\r\n    try {\r\n      nativeDb.enableWalMode(); // local briefcases should use WAL journal mode\r\n      nativeDb.resetBriefcaseId(briefcaseId);\r\n      if (nativeDb.getCurrentChangeset().id !== checkpoint.changeset.id)\r\n        throw new IModelError(IModelStatus.InvalidId, `Downloaded briefcase has wrong changesetId: ${fileName}`);\r\n    } finally {\r\n      nativeDb.saveChanges();\r\n      nativeDb.closeFile();\r\n    }\r\n    return response;\r\n  }\r\n\r\n  /** Deletes change sets of an iModel from local disk\r\n   * @internal\r\n   */\r\n  public static deleteChangeSetsFromLocalDisk(iModelId: string) {\r\n    const changesetsPath = BriefcaseManager.getChangeSetsPath(iModelId);\r\n    BriefcaseManager.deleteFolderAndContents(changesetsPath);\r\n  }\r\n\r\n  /** Releases a briefcaseId from iModelHub. After this call it is illegal to generate changesets for the released briefcaseId.\r\n   * @note generally, this method should not be called directly. Instead use [[deleteBriefcaseFiles]].\r\n   * @see deleteBriefcaseFiles\r\n   */\r\n  public static async releaseBriefcase(accessToken: AccessToken, briefcase: BriefcaseProps): Promise<void> {\r\n    if (this.isValidBriefcaseId(briefcase.briefcaseId))\r\n      return IModelHost.hubAccess.releaseBriefcase({ accessToken, iModelId: briefcase.iModelId, briefcaseId: briefcase.briefcaseId });\r\n  }\r\n\r\n  /**\r\n   * Delete and clean up a briefcase and all of its associated files. First, this method opens the supplied filename to determine its briefcaseId.\r\n   * Then, if a requestContext is supplied, it releases a BriefcaseId from iModelHub. Finally it deletes the local briefcase file and\r\n   * associated files (that is, all files in the same directory that start with the briefcase name).\r\n   * @param filePath the full file name of the Briefcase to delete\r\n   * @param accessToken for releasing the briefcaseId\r\n   */\r\n  public static async deleteBriefcaseFiles(filePath: LocalFileName, accessToken?: AccessToken): Promise<void> {\r\n    try {\r\n      const db = IModelDb.openDgnDb({ path: filePath }, OpenMode.Readonly);\r\n      const briefcase: BriefcaseProps = {\r\n        iModelId: db.getIModelId(),\r\n        briefcaseId: db.getBriefcaseId(),\r\n      };\r\n      db.closeFile();\r\n\r\n      if (accessToken) {\r\n        if (this.isValidBriefcaseId(briefcase.briefcaseId)) {\r\n          await BriefcaseManager.releaseBriefcase(accessToken, briefcase);\r\n        }\r\n      }\r\n    } catch (error) {\r\n    }\r\n\r\n    // first try to delete the briefcase file\r\n    try {\r\n      if (IModelJsFs.existsSync(filePath))\r\n        IModelJsFs.unlinkSync(filePath);\r\n    } catch (err) {\r\n      throw new IModelError(IModelStatus.BadRequest, `cannot delete briefcase file ${err}`);\r\n    }\r\n\r\n    // next, delete all files that start with the briefcase's filePath (e.g. \"a.bim-locks\", \"a.bim-journal\", etc.)\r\n    try {\r\n      const dirName = path.dirname(filePath);\r\n      const fileName = path.basename(filePath);\r\n      const files = IModelJsFs.readdirSync(dirName);\r\n      for (const file of files) {\r\n        if (file.startsWith(fileName))\r\n          this.deleteFile(path.join(dirName, file)); // don't throw on error\r\n      }\r\n    } catch (err) {\r\n    }\r\n  }\r\n\r\n  /** Deletes a file\r\n   *  - Does not throw any error, but logs it instead\r\n   *  - Returns true if the delete was successful\r\n   */\r\n  private static deleteFile(pathname: LocalFileName): boolean {\r\n    try {\r\n      IModelJsFs.unlinkSync(pathname);\r\n    } catch (error) {\r\n      Logger.logError(loggerCategory, `Cannot delete file ${pathname}, ${error}`);\r\n      return false;\r\n    }\r\n    return true;\r\n  }\r\n\r\n  /** Deletes a folder, checking if it's empty\r\n   *  - Does not throw any error, but logs it instead\r\n   *  - Returns true if the delete was successful\r\n   */\r\n  private static deleteFolderIfEmpty(folderPathname: LocalDirName): boolean {\r\n    try {\r\n      const files = IModelJsFs.readdirSync(folderPathname);\r\n      if (files.length > 0)\r\n        return false;\r\n\r\n      IModelJsFs.rmdirSync(folderPathname);\r\n    } catch (error) {\r\n      Logger.logError(loggerCategory, `Cannot delete folder: ${folderPathname}`);\r\n      return false;\r\n    }\r\n    return true;\r\n  }\r\n\r\n  /** Deletes the contents of a folder, but not the folder itself\r\n   *  - Does not throw any errors, but logs them.\r\n   *  - returns true if the delete was successful.\r\n   */\r\n  private static deleteFolderContents(folderPathname: LocalDirName): boolean {\r\n    if (!IModelJsFs.existsSync(folderPathname))\r\n      return false;\r\n\r\n    let status = true;\r\n    const files = IModelJsFs.readdirSync(folderPathname);\r\n    for (const file of files) {\r\n      const curPath = path.join(folderPathname, file);\r\n      const locStatus = (IModelJsFs.lstatSync(curPath)?.isDirectory) ? BriefcaseManager.deleteFolderAndContents(curPath) : BriefcaseManager.deleteFile(curPath);\r\n      if (!locStatus)\r\n        status = false;\r\n    }\r\n    return status;\r\n  }\r\n\r\n  /** Query the hub for the properties for a ChangesetIndex or ChangesetId  */\r\n  public static async queryChangeset(arg: { iModelId: GuidString, changeset: ChangesetIndexOrId }): Promise<ChangesetProps> {\r\n    return IModelHost.hubAccess.queryChangeset({ ...arg, accessToken: await IModelHost.getAccessToken() });\r\n  }\r\n\r\n  /** Query the hub for an array of changeset properties given a ChangesetRange */\r\n  public static async queryChangesets(arg: { iModelId: GuidString, range: ChangesetRange }): Promise<ChangesetProps[]> {\r\n    return IModelHost.hubAccess.queryChangesets({ ...arg, accessToken: await IModelHost.getAccessToken() });\r\n  }\r\n\r\n  /** Query the hub for the ChangesetProps of the most recent changeset */\r\n  public static async getLatestChangeset(arg: { iModelId: GuidString }): Promise<ChangesetProps> {\r\n    return IModelHost.hubAccess.getLatestChangeset({ ...arg, accessToken: await IModelHost.getAccessToken() });\r\n  }\r\n\r\n  /** Query the Id of an iModel by name.\r\n   * @param arg Identifies the iModel of interest\r\n   * @returns the Id of the corresponding iModel, or `undefined` if no such iModel exists.\r\n   */\r\n  public static async queryIModelByName(arg: IModelNameArg): Promise<GuidString | undefined> {\r\n    return IModelHost.hubAccess.queryIModelByName(arg);\r\n  }\r\n\r\n  /** Deletes a folder and all it's contents.\r\n   *  - Does not throw any errors, but logs them.\r\n   *  - returns true if the delete was successful.\r\n   */\r\n  private static deleteFolderAndContents(folderPathname: LocalDirName): boolean {\r\n    if (!IModelJsFs.existsSync(folderPathname))\r\n      return true;\r\n\r\n    let status = false;\r\n    status = BriefcaseManager.deleteFolderContents(folderPathname);\r\n    if (!status)\r\n      return false;\r\n\r\n    status = BriefcaseManager.deleteFolderIfEmpty(folderPathname);\r\n    return status;\r\n  }\r\n\r\n  private static async applySingleChangeset(db: IModelDb, changesetFile: ChangesetFileProps) {\r\n    if (changesetFile.changesType === ChangesetType.Schema)\r\n      db.clearCaches(); // for schema changesets, statement caches may become invalid. Do this *before* applying, in case db needs to be closed (open statements hold db open.)\r\n\r\n    db.nativeDb.applyChangeset(changesetFile);\r\n    db.changeset = db.nativeDb.getCurrentChangeset();\r\n\r\n    // we're done with this changeset, delete it\r\n    IModelJsFs.removeSync(changesetFile.pathname);\r\n  }\r\n\r\n  /** @internal */\r\n  public static async pullAndApplyChangesets(db: IModelDb, arg: PullChangesArgs): Promise<void> {\r\n    if (!db.isOpen || db.nativeDb.isReadonly()) // don't use db.isReadonly - we reopen the file writable just for this operation but db.isReadonly is still true\r\n      throw new IModelError(ChangeSetStatus.ApplyError, \"Briefcase must be open ReadWrite to process change sets\");\r\n\r\n    let currentIndex = db.changeset.index;\r\n    if (currentIndex === undefined)\r\n      currentIndex = (await IModelHost.hubAccess.queryChangeset({ accessToken: arg.accessToken, iModelId: db.iModelId, changeset: { id: db.changeset.id } })).index;\r\n\r\n    const reverse = (arg.toIndex && arg.toIndex < currentIndex) ? true : false;\r\n\r\n    // Download change sets\r\n    const changesets = await IModelHost.hubAccess.downloadChangesets({\r\n      accessToken: arg.accessToken,\r\n      iModelId: db.iModelId,\r\n      range: { first: reverse ? arg.toIndex! + 1 : currentIndex + 1, end: reverse ? currentIndex : arg.toIndex }, // eslint-disable-line @typescript-eslint/no-non-null-assertion\r\n      targetDir: BriefcaseManager.getChangeSetsPath(db.iModelId),\r\n      progressCallback: arg.onProgress,\r\n    });\r\n\r\n    if (changesets.length === 0)\r\n      return; // nothing to apply\r\n\r\n    if (reverse)\r\n      changesets.reverse();\r\n\r\n    for (const changeset of changesets) {\r\n      const stopwatch = new StopWatch(`[${changeset.id}]`, true);\r\n      Logger.logInfo(loggerCategory, `Starting application of changeset with id ${stopwatch.description}`);\r\n      await this.applySingleChangeset(db, changeset);\r\n      Logger.logInfo(loggerCategory, `Applied changeset with id ${stopwatch.description} (${stopwatch.elapsedSeconds} seconds)`);\r\n    }\r\n    // notify listeners\r\n    db.notifyChangesetApplied();\r\n  }\r\n\r\n  /** create a changeset from the current changes, and push it to iModelHub */\r\n  private static async pushChanges(db: BriefcaseDb, arg: PushChangesArgs): Promise<void> {\r\n    const changesetProps = db.nativeDb.startCreateChangeset() as ChangesetFileProps;\r\n    changesetProps.briefcaseId = db.briefcaseId;\r\n    changesetProps.description = arg.description;\r\n    const fileSize = IModelJsFs.lstatSync(changesetProps.pathname)?.size;\r\n    if (!fileSize) // either undefined or 0 means error\r\n      throw new IModelError(IModelStatus.NoContent, \"error creating changeset\");\r\n\r\n    changesetProps.size = fileSize;\r\n\r\n    let retryCount = arg.pushRetryCount ?? 3;\r\n    while (true) {\r\n      try {\r\n        const accessToken = await IModelHost.getAccessToken();\r\n        const index = await IModelHost.hubAccess.pushChangeset({ accessToken, iModelId: db.iModelId, changesetProps });\r\n        db.nativeDb.completeCreateChangeset({ index });\r\n        db.changeset = db.nativeDb.getCurrentChangeset();\r\n        if (!arg.retainLocks)\r\n          await db.locks.releaseAllLocks();\r\n\r\n        return;\r\n      } catch (err: any) {\r\n        const shouldRetry = () => {\r\n          if (retryCount-- <= 0)\r\n            return false;\r\n          switch (err.errorNumber) {\r\n            case IModelHubStatus.AnotherUserPushing:\r\n            case IModelHubStatus.DatabaseTemporarilyLocked:\r\n            case IModelHubStatus.OperationFailed:\r\n              return true;\r\n          }\r\n          return false;\r\n        };\r\n\r\n        if (!shouldRetry()) {\r\n          db.nativeDb.abandonCreateChangeset();\r\n          throw err;\r\n        }\r\n      } finally {\r\n        IModelJsFs.removeSync(changesetProps.pathname);\r\n      }\r\n    }\r\n  }\r\n\r\n  /** Pull/merge (if necessary), then push all local changes as a changeset. Called by [[BriefcaseDb.pushChanges]]\r\n   * @internal\r\n   */\r\n  public static async pullMergePush(db: BriefcaseDb, arg: PushChangesArgs): Promise<void> {\r\n    let retryCount = arg.mergeRetryCount ?? 5;\r\n    while (true) {\r\n      try {\r\n        await BriefcaseManager.pullAndApplyChangesets(db, arg);\r\n        return await BriefcaseManager.pushChanges(db, arg);\r\n      } catch (err: any) {\r\n        if (retryCount-- <= 0 || err.errorNumber !== IModelHubStatus.PullIsRequired)\r\n          throw (err);\r\n        await (arg.mergeRetryDelay ?? BeDuration.fromSeconds(3)).wait();\r\n      }\r\n    }\r\n  }\r\n\r\n}\r\n"]}

package/lib/cjs/ChangeSummaryManager.js

@@ -343,6 +343,6 @@ class ChangeSummaryManager {
         }
     }
 }
-ChangeSummaryManager._currentIModelChangeSchemaVersion = { read: 2, write: 0, minor: 0 };
 exports.ChangeSummaryManager = ChangeSummaryManager;
+ChangeSummaryManager._currentIModelChangeSchemaVersion = { read: 2, write: 0, minor: 0 };
 //# sourceMappingURL=ChangeSummaryManager.js.map

package/lib/cjs/ChangeSummaryManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"ChangeSummaryManager.js","sourceRoot":"","sources":["../../src/ChangeSummaryManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAyH;AACzH,oDAAiH;AACjH,6BAA6B;AAC7B,mEAAgE;AAChE,yDAAsD;AACtD,iCAA4C;AAE5C,yCAA6D;AAC7D,6CAA0D;AAC1D,6CAA0C;AAE1C,MAAM,cAAc,GAAW,6CAAqB,CAAC,IAAI,CAAC;AAiD1D;;;;;GAKG;AACH,MAAa,oBAAoB;IAG/B;;;OAGG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAAgB;QAClD,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM;YAC3B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAE3E,OAAO,MAAM,CAAC,QAAQ,CAAC,qBAAqB,EAAE,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,MAAgB;QAC9C,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM;YAC3B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAE3E,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,CAAC;YACpD,OAAO;QAET,MAAM,oBAAoB,GAAW,mCAAgB,CAAC,sBAAsB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC9F,IAAI,CAAC,uBAAU,CAAC,UAAU,CAAC,oBAAoB,CAAC,EAAE;YAChD,IAAA,oBAAK,EAAC,IAAI,WAAI,EAAE,EAAE,CAAC,eAAqB,EAAE,EAAE;gBAC1C,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,EAAE,eAAe,EAAE,oBAAoB,CAAC,CAAC;YAC5F,CAAC,CAAC,CAAC;SACJ;QAED,IAAA,qBAAM,EAAC,uBAAU,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC,CAAC;QACpD,MAAM,GAAG,GAAa,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;QAC9E,IAAI,GAAG,KAAK,uBAAQ,CAAC,YAAY;YAC/B,MAAM,IAAI,yBAAW,CAAC,GAAG,EAAE,yCAAyC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC;IAC5F,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,MAAgB;QAC9C,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM;YAC3B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAE3E,MAAM,CAAC,WAAW,EAAE,CAAC;QACrB,MAAM,GAAG,GAAa,MAAM,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QAC1D,IAAI,GAAG,KAAK,uBAAQ,CAAC,YAAY;YAC/B,MAAM,IAAI,yBAAW,CAAC,GAAG,EAAE,2CAA2C,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC;IAC9F,CAAC;IAEO,MAAM,CAAC,uBAAuB,CAAC,MAAmB;QACxD,IAAI,CAAC,MAAM,EAAE,MAAM;YACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,6CAA6C,CAAC,CAAC;QAE5F,MAAM,WAAW,GAAG,IAAI,WAAI,EAAE,CAAC;QAC/B,MAAM,mBAAmB,GAAG,mCAAgB,CAAC,sBAAsB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACrF,IAAI,uBAAU,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE;YAC9C,oBAAoB,CAAC,mBAAmB,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;YAC3E,OAAO,WAAW,CAAC;SACpB;QAED,IAAI;YACF,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,EAAE,WAAW,EAAE,mBAAmB,CAAC,CAAC;YACrF,OAAO,WAAW,CAAC;SACpB;QAAC,OAAO,CAAC,EAAE;YACV,0EAA0E;YAC1E,IAAI,uBAAU,CAAC,UAAU,CAAC,mBAAmB,CAAC;gBAC5C,uBAAU,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;YAE7C,MAAM,CAAC,CAAC;SACT;IACH,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,WAAiB,EAAE,mBAA2B;QACnG,IAAI,CAAC,MAAM,EAAE,MAAM;YACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,6CAA6C,CAAC,CAAC;QAE5F,MAAM,IAAI,GAAa,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,WAAW,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC;QACpG,IAAI,IAAI,KAAK,uBAAQ,CAAC,YAAY;YAChC,MAAM,IAAI,yBAAW,CAAC,IAAI,EAAE,0CAA0C,mBAAmB,IAAI,CAAC,CAAC;QAEjG,iGAAiG;QACjG,WAAW,CAAC,YAAY,CAAC,oBAAoB,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACzE,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,WAAiB,EAAE,mBAA2B;QAC/E,WAAW,CAAC,MAAM,CAAC,mBAAmB,EAAE,mBAAY,CAAC,WAAW,CAAC,CAAC;QAElE,MAAM,mBAAmB,GAAmD,WAAW,CAAC,qBAAqB,CAAC,gHAAgH,EAC5N,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa;gBACxC,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,wCAAwC,CAAC,CAAC;YAE5F,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;QAEL,IAAI,mBAAmB,CAAC,IAAI,KAAK,oBAAoB,CAAC,iCAAiC,CAAC,IAAI;YAC1F,mBAAmB,CAAC,KAAK,KAAK,oBAAoB,CAAC,iCAAiC,CAAC,KAAK;YAC1F,mBAAmB,CAAC,KAAK,KAAK,oBAAoB,CAAC,iCAAiC,CAAC,KAAK;YAC1F,OAAO;QAET,WAAW,CAAC,YAAY,CAAC,oBAAoB,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACzE,CAAC;IAEO,MAAM,CAAC,qBAAqB,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,2BAAc,CAAC,gBAAgB,EAAE,oCAAoC,CAAC,CAAC,CAAC,CAAC;IAEnI,MAAM,CAAC,yBAAyB,CAAC,WAAiB,EAAE,WAAuB;QACjF,OAAO,WAAW,CAAC,qBAAqB,CAAC,uEAAuE,EAC9G,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;YAChC,IAAI,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE;gBACxC,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;YAElC,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,WAAiB,EAAE,eAA2B,EAAE,cAA0B,EAAE,oBAAiC,EAAE,WAAoB,EAAE,iBAA0B,EAAE,oBAAiC;QAChO,WAAW,CAAC,qBAAqB,CAAC,uHAAuH,EACvJ,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;YAChC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;YACnC,IAAI,oBAAoB;gBACtB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;YAE3C,IAAI,WAAW;gBACb,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;YAElC,IAAI,iBAAiB;gBACnB,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC;YAE1C,IAAI,oBAAoB;gBACtB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;YAE3C,MAAM,CAAC,GAAa,IAAI,CAAC,IAAI,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,uBAAQ,CAAC,cAAc;gBAC/B,MAAM,IAAI,yBAAW,CAAC,CAAC,EAAE,mEAAmE,eAAe,EAAE,CAAC,CAAC;QACnH,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,kBAAkB,CAAC,MAAmB,EAAE,eAA2B;QAC/E,IAAI,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,CAAC;YACrD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,+CAA+C,CAAC,CAAC;QAE9F,OAAO,MAAM,CAAC,qBAAqB,CAAC,mHAAmH,EACrJ,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;YAChC,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa;gBACxC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,oDAAoD,eAAe,GAAG,CAAC,CAAC;YAErH,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YAC1B,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC;QACpL,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAAmB,EAAE,gBAA4B;QACjF,IAAI,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,CAAC;YACrD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,+CAA+C,CAAC,CAAC;QAE9F,yBAAyB;QACzB,MAAM,cAAc,GAAmB,MAAM,CAAC,qBAAqB,CAAC;;8FAEsB,EAAE,CAAC,IAAoB,EAAE,EAAE;YACnH,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;YACjC,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa;gBACxC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,kCAAkC,gBAAgB,GAAG,CAAC,CAAC;YAEpG,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,iBAAiB,GAAe,GAAG,CAAC,iBAAiB,CAAC;YAC5D,MAAM,wBAAwB,GAAW,IAAI,GAAG,CAAC,yBAAyB,MAAM,GAAG,CAAC,wBAAwB,GAAG,CAAC;YAChH,MAAM,EAAE,GAAiB,GAAG,CAAC,MAAsB,CAAC;YAEpD,OAAO;gBACL,EAAE,EAAE,gBAAgB,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,EAAE,EAAE,EAAE,iBAAiB,EAAE,SAAS,EAAE,wBAAwB,EAAE;gBAC/H,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,GAAG,CAAC,UAAU;aACvC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,4BAA4B,CAAC,MAAgB,EAAE,gBAA4B;QACvF,OAAO,MAAM,CAAC,qBAAqB,CAAC,wFAAwF,EAC1H,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;YAEjC,MAAM,iBAAiB,GAAa,EAAE,CAAC;YACvC,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa,EAAE;gBAC7C,uGAAuG;gBACvG,MAAM,YAAY,GAAW,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;gBAC1D,MAAM,kBAAkB,GAAa,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC7D,IAAA,qBAAM,EAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAEtC,IAAI,YAAY,GAAY,IAAI,CAAC;gBACjC,IAAI,IAAI,GAAW,EAAE,CAAC;gBACtB,KAAK,MAAM,KAAK,IAAI,kBAAkB,EAAE;oBACtC,IAAI,CAAC,YAAY;wBACf,IAAI,IAAI,GAAG,CAAC;oBAEd,IAAI,IAAI,IAAI,KAAK,GAAG,CAAC;oBACrB,YAAY,GAAG,KAAK,CAAC;iBACtB;gBACD,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC9B;YAED,OAAO,iBAAiB,CAAC;QAC3B,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,MAAM,CAAC,8BAA8B,CAAC,MAAgB,EAAE,kBAAqH,EAAE,iBAAoC,EAAE,oBAA+B;QACzP,IAAI,iBAA2B,CAAC;QAChC,IAAI,CAAC,oBAAoB,EAAE;YACzB,0GAA0G;YAC1G,iBAAiB,GAAG,oBAAoB,CAAC,4BAA4B,CAAC,MAAM,EAAE,kBAAkB,CAAC,EAAE,CAAC,CAAC;SACtG;;YACC,iBAAiB,GAAG,oBAAoB,CAAC;QAE3C,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC;YAChC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,sDAAsD,kBAAkB,CAAC,EAAE,GAAG,CAAC,CAAC;QAE7H,IAAI,KAAK,GAAW,SAAS,CAAC;QAC9B,iBAAiB,CAAC,GAAG,CAAC,CAAC,IAAY,EAAE,KAAa,EAAE,EAAE;YACpD,IAAI,KAAK,KAAK,CAAC;gBACb,KAAK,IAAI,GAAG,CAAC;YAEf,KAAK,IAAI,IAAI,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,sGAAsG;QACtG,gDAAgD;QAChD,KAAK,IAAI,cAAc,kBAAkB,CAAC,eAAe,CAAC,SAAS,YAAY,kBAAkB,CAAC,SAAS,IAAI,iBAAiB,wBAAwB,kBAAkB,CAAC,eAAe,CAAC,EAAE,EAAE,CAAC;QAChM,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,WAAwB,EAAE,MAAmB;QACnF,IAAI,CAAC,MAAM,EAAE,MAAM;YACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAC3E,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,WAAW;YACd,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,yCAAyC,CAAC,CAAC;QAC5F,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC;YACpC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,iDAAiD,CAAC,CAAC;QAEpG,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QACjC,MAAM,gBAAgB,GAAW,mCAAgB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAC9E,MAAM,SAAS,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC,CAAC;QAE/J,IAAI,CAAC,uBAAU,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC;YAC5C,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,YAAY,EAAE,kCAAkC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE3G,IAAI,WAA6B,CAAC;QAClC,IAAI;YACF,WAAW,GAAG,oBAAoB,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;YACnE,IAAA,qBAAM,EAAC,WAAW,CAAC,QAAQ,KAAK,SAAS,EAAE,qDAAqD,CAAC,CAAC;YAElG,IAAI,eAAe,GAAG,oBAAoB,CAAC,yBAAyB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YAC/F,IAAI,eAAe,KAAK,SAAS,EAAE;gBACjC,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,yEAAyE,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;gBAC1J,OAAO,eAAe,CAAC;aACxB;YAED,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,WAAW,CAAC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC5F,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,uBAAQ,CAAC,YAAY;gBAC3D,MAAM,IAAI,yBAAW,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAE/D,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC;YAClC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC;YAC9B,oBAAoB,CAAC,gBAAgB,CAAC,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,WAAW,EAAE,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;YAEvK,WAAW,CAAC,WAAW,EAAE,CAAC;YAC1B,OAAO,eAAe,CAAC;SACxB;gBAAS;YACR,IAAI,WAAW,KAAK,SAAS;gBAC3B,WAAW,CAAC,OAAO,EAAE,CAAC;YACxB,uBAAU,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;SAC3C;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAA6B;QACrE,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,MAAM,uBAAU,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC;QAChF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAC1C,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,2BAAa,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAChJ,IAAI,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG;YACzB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAC;QAC5E,IAAI,KAAK,CAAC,KAAK,KAAK,CAAC,IAAI,KAAK,CAAC,GAAG,KAAK,CAAC;YACtC,OAAO,EAAE,CAAC,CAAC,uDAAuD;QAEpE,MAAM,UAAU,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAEhG,uEAAuE;QACvE,MAAM,aAAa,GAAG,mCAAgB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QACtE,MAAM,QAAQ,GAAW,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,4BAA4B,CAAC,CAAC;QAChF,IAAI,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC;YACjC,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAElC,IAAI,MAA+B,CAAC;QACpC,IAAI;YACF,2DAA2D;YAC3D,MAAM,KAAK,GAAG,MAAM,mCAAgB,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,gBAAgB,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;YACnK,MAAM,GAAG,MAAM,sBAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YAE9D,MAAM,UAAU,GAAG,IAAI,KAAK,EAAc,CAAC;YAC3C,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBACtD,kCAAkC;gBAClC,IAAI,KAAK,GAAG,CAAC;oBACX,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;gBAE9E,mEAAmE;gBACnE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;gBACtE,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC5B;YACD,OAAO,UAAU,CAAC;SACnB;gBAAS;YACR,IAAI,MAAM,KAAK,SAAS;gBACtB,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;SACjC;IACH,CAAC;;AA1XuB,sDAAiC,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;AADjF,oDAAoB","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 { AccessToken, assert, DbResult, GuidString, Id64String, IModelStatus, Logger, using } from \"@itwin/core-bentley\";\r\nimport { ChangedValueState, ChangeOpCode, ChangesetRange, IModelError, IModelVersion } from \"@itwin/core-common\";\r\nimport * as path from \"path\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { BriefcaseManager } from \"./BriefcaseManager\";\r\nimport { ECDb, ECDbOpenMode } from \"./ECDb\";\r\nimport { ECSqlStatement } from \"./ECSqlStatement\";\r\nimport { BriefcaseDb, IModelDb, TokenArg } from \"./IModelDb\";\r\nimport { IModelHost, KnownLocations } from \"./IModelHost\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\n\r\nconst loggerCategory: string = BackendLoggerCategory.ECDb;\r\n\r\n/** Represents an instance of the `ChangeSummary` ECClass from the `ECDbChange` ECSchema\r\n * combined with the information from the related `Changeset` instance (from the `IModelChange` ECSchema) from\r\n * which the Change Summary was extracted.\r\n *\r\n * See also\r\n * - [ChangeSummaryManager.queryChangeSummary]($backend)\r\n * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)\r\n * @beta\r\n */\r\nexport interface ChangeSummary {\r\n  id: Id64String;\r\n  changeSet: { wsgId: GuidString, parentWsgId: GuidString, description: string, pushDate: string, userCreated: GuidString };\r\n}\r\n\r\n/** Represents an instance of the `InstanceChange` ECClass from the `ECDbChange` ECSchema\r\n *\r\n * See also\r\n * - [ChangeSummaryManager.queryInstanceChange]($backend)\r\n * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)\r\n * @beta\r\n */\r\nexport interface InstanceChange {\r\n  id: Id64String;\r\n  summaryId: Id64String;\r\n  changedInstance: { id: Id64String, className: string };\r\n  opCode: ChangeOpCode;\r\n  isIndirect: boolean;\r\n}\r\n\r\n/** Options for [ChangeSummaryManager.createChangeSummaries]($backend).\r\n * @beta\r\n */\r\nexport interface CreateChangeSummaryArgs extends TokenArg {\r\n  /** Id of the iTwin that contains the iModel */\r\n  iTwinId: GuidString;\r\n\r\n  /** Id of the iModel */\r\n  iModelId: GuidString;\r\n\r\n  /**\r\n   * Range of change sets\r\n   * - the Change Summary for the first and last versions are also included\r\n   * - if unspecified, all change sets until the latest version are processed\r\n   */\r\n  range: ChangesetRange;\r\n}\r\n\r\n/** Class to extract Change Summaries for a briefcase.\r\n *\r\n * See also:\r\n * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)\r\n * @beta\r\n */\r\nexport class ChangeSummaryManager {\r\n  private static readonly _currentIModelChangeSchemaVersion = { read: 2, write: 0, minor: 0 };\r\n\r\n  /** Determines whether the *Change Cache file* is attached to the specified iModel or not\r\n   * @param iModel iModel to check whether a *Change Cache file* is attached\r\n   * @returns Returns true if the *Change Cache file* is attached to the iModel. false otherwise\r\n   */\r\n  public static isChangeCacheAttached(iModel: IModelDb): boolean {\r\n    if (!iModel || !iModel.isOpen)\r\n      throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n\r\n    return iModel.nativeDb.isChangeCacheAttached();\r\n  }\r\n\r\n  /** Attaches the *Change Cache file* to the specified iModel if it hasn't been attached yet.\r\n   * A new *Change Cache file* will be created for the iModel if it hasn't existed before.\r\n   * @param iModel iModel to attach the *Change Cache file* file to\r\n   * @throws [IModelError]($common)\r\n   */\r\n  public static attachChangeCache(iModel: IModelDb): void {\r\n    if (!iModel || !iModel.isOpen)\r\n      throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n\r\n    if (ChangeSummaryManager.isChangeCacheAttached(iModel))\r\n      return;\r\n\r\n    const changesCacheFilePath: string = BriefcaseManager.getChangeCachePathName(iModel.iModelId);\r\n    if (!IModelJsFs.existsSync(changesCacheFilePath)) {\r\n      using(new ECDb(), (changeCacheFile: ECDb) => {\r\n        ChangeSummaryManager.createChangeCacheFile(iModel, changeCacheFile, changesCacheFilePath);\r\n      });\r\n    }\r\n\r\n    assert(IModelJsFs.existsSync(changesCacheFilePath));\r\n    const res: DbResult = iModel.nativeDb.attachChangeCache(changesCacheFilePath);\r\n    if (res !== DbResult.BE_SQLITE_OK)\r\n      throw new IModelError(res, `Failed to attach Change Cache file to ${iModel.pathName}.`);\r\n  }\r\n\r\n  /** Detaches the *Change Cache file* from the specified iModel.\r\n   * - note that this method will cause any pending (currently running or queued) queries to fail\r\n   * @param iModel iModel to detach the *Change Cache file* to\r\n   * @throws [IModelError]($common) in case of errors, e.g. if no *Change Cache file* was attached before.\r\n   */\r\n  public static detachChangeCache(iModel: IModelDb): void {\r\n    if (!iModel || !iModel.isOpen)\r\n      throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n\r\n    iModel.clearCaches();\r\n    const res: DbResult = iModel.nativeDb.detachChangeCache();\r\n    if (res !== DbResult.BE_SQLITE_OK)\r\n      throw new IModelError(res, `Failed to detach Change Cache file from ${iModel.pathName}.`);\r\n  }\r\n\r\n  private static openOrCreateChangesFile(iModel: BriefcaseDb): ECDb {\r\n    if (!iModel?.isOpen)\r\n      throw new IModelError(IModelStatus.BadArg, \"Invalid iModel handle. iModel must be open.\");\r\n\r\n    const changesFile = new ECDb();\r\n    const changeCacheFilePath = BriefcaseManager.getChangeCachePathName(iModel.iModelId);\r\n    if (IModelJsFs.existsSync(changeCacheFilePath)) {\r\n      ChangeSummaryManager.openChangeCacheFile(changesFile, changeCacheFilePath);\r\n      return changesFile;\r\n    }\r\n\r\n    try {\r\n      ChangeSummaryManager.createChangeCacheFile(iModel, changesFile, changeCacheFilePath);\r\n      return changesFile;\r\n    } catch (e) {\r\n      // delete cache file again in case it was created but schema import failed\r\n      if (IModelJsFs.existsSync(changeCacheFilePath))\r\n        IModelJsFs.removeSync(changeCacheFilePath);\r\n\r\n      throw e;\r\n    }\r\n  }\r\n\r\n  private static createChangeCacheFile(iModel: IModelDb, changesFile: ECDb, changeCacheFilePath: string): void {\r\n    if (!iModel?.isOpen)\r\n      throw new IModelError(IModelStatus.BadArg, \"Invalid iModel object. iModel must be open.\");\r\n\r\n    const stat: DbResult = iModel.nativeDb.createChangeCache(changesFile.nativeDb, changeCacheFilePath);\r\n    if (stat !== DbResult.BE_SQLITE_OK)\r\n      throw new IModelError(stat, `Failed to create Change Cache file at \"${changeCacheFilePath}\".`);\r\n\r\n    // Extended information like changeset ids, push dates are persisted in the IModelChange ECSchema\r\n    changesFile.importSchema(ChangeSummaryManager.getExtendedSchemaPath());\r\n  }\r\n\r\n  private static openChangeCacheFile(changesFile: ECDb, changeCacheFilePath: string): void {\r\n    changesFile.openDb(changeCacheFilePath, ECDbOpenMode.FileUpgrade);\r\n\r\n    const actualSchemaVersion: { read: number, write: number, minor: number } = changesFile.withPreparedStatement(\"SELECT VersionMajor read,VersionWrite write,VersionMinor minor FROM meta.ECSchemaDef WHERE Name='IModelChange'\",\r\n      (stmt: ECSqlStatement) => {\r\n        if (stmt.step() !== DbResult.BE_SQLITE_ROW)\r\n          throw new IModelError(DbResult.BE_SQLITE_ERROR, \"File is not a valid Change Cache file.\");\r\n\r\n        return stmt.getRow();\r\n      });\r\n\r\n    if (actualSchemaVersion.read === ChangeSummaryManager._currentIModelChangeSchemaVersion.read &&\r\n      actualSchemaVersion.write === ChangeSummaryManager._currentIModelChangeSchemaVersion.write &&\r\n      actualSchemaVersion.minor === ChangeSummaryManager._currentIModelChangeSchemaVersion.minor)\r\n      return;\r\n\r\n    changesFile.importSchema(ChangeSummaryManager.getExtendedSchemaPath());\r\n  }\r\n\r\n  private static getExtendedSchemaPath(): string { return path.join(KnownLocations.packageAssetsDir, \"IModelChange.02.00.00.ecschema.xml\"); }\r\n\r\n  private static isSummaryAlreadyExtracted(changesFile: ECDb, changeSetId: GuidString): Id64String | undefined {\r\n    return changesFile.withPreparedStatement(\"SELECT Summary.Id summaryid FROM imodelchange.ChangeSet WHERE WsgId=?\",\r\n      (stmt: ECSqlStatement) => {\r\n        stmt.bindString(1, changeSetId);\r\n        if (DbResult.BE_SQLITE_ROW === stmt.step())\r\n          return stmt.getValue(0).getId();\r\n\r\n        return undefined;\r\n      });\r\n  }\r\n\r\n  private static addExtendedInfos(changesFile: ECDb, changeSummaryId: Id64String, changesetWsgId: GuidString, changesetParentWsgId?: GuidString, description?: string, changesetPushDate?: string, changeSetUserCreated?: GuidString): void {\r\n    changesFile.withPreparedStatement(\"INSERT INTO imodelchange.ChangeSet(Summary.Id,WsgId,ParentWsgId,Description,PushDate,UserCreated) VALUES(?,?,?,?,?,?)\",\r\n      (stmt: ECSqlStatement) => {\r\n        stmt.bindId(1, changeSummaryId);\r\n        stmt.bindString(2, changesetWsgId);\r\n        if (changesetParentWsgId)\r\n          stmt.bindString(3, changesetParentWsgId);\r\n\r\n        if (description)\r\n          stmt.bindString(4, description);\r\n\r\n        if (changesetPushDate)\r\n          stmt.bindDateTime(5, changesetPushDate);\r\n\r\n        if (changeSetUserCreated)\r\n          stmt.bindString(6, changeSetUserCreated);\r\n\r\n        const r: DbResult = stmt.step();\r\n        if (r !== DbResult.BE_SQLITE_DONE)\r\n          throw new IModelError(r, `Failed to add changeset information to extracted change summary ${changeSummaryId}`);\r\n      });\r\n  }\r\n\r\n  /** Queries the ChangeSummary for the specified change summary id\r\n   *\r\n   * See also\r\n   * - `ECDbChange.ChangeSummary` ECClass in the *ECDbChange* ECSchema\r\n   * - [Change Summary Overview]($docs/learning/ChangeSummaries)\r\n   * @param iModel iModel\r\n   * @param changeSummaryId ECInstanceId of the ChangeSummary\r\n   * @returns Returns the requested ChangeSummary object\r\n   * @throws [IModelError]($common) If change summary does not exist for the specified id, or if the\r\n   * change cache file hasn't been attached, or in case of other errors.\r\n   */\r\n  public static queryChangeSummary(iModel: BriefcaseDb, changeSummaryId: Id64String): ChangeSummary {\r\n    if (!ChangeSummaryManager.isChangeCacheAttached(iModel))\r\n      throw new IModelError(IModelStatus.BadArg, \"Change Cache file must be attached to iModel.\");\r\n\r\n    return iModel.withPreparedStatement(\"SELECT WsgId,ParentWsgId,Description,PushDate,UserCreated FROM ecchange.imodelchange.ChangeSet WHERE Summary.Id=?\",\r\n      (stmt: ECSqlStatement) => {\r\n        stmt.bindId(1, changeSummaryId);\r\n        if (stmt.step() !== DbResult.BE_SQLITE_ROW)\r\n          throw new IModelError(IModelStatus.BadArg, `No ChangeSet information found for ChangeSummary ${changeSummaryId}.`);\r\n\r\n        const row = stmt.getRow();\r\n        return { id: changeSummaryId, changeSet: { wsgId: row.wsgId, parentWsgId: row.parentWsgId, description: row.description, pushDate: row.pushDate, userCreated: row.userCreated } };\r\n      });\r\n  }\r\n\r\n  /** Queries the InstanceChange for the specified instance change id.\r\n   *\r\n   * See also\r\n   * - `ECDbChange.InstanceChange` ECClass in the *ECDbChange* ECSchema\r\n   * - [Change Summary Overview]($docs/learning/ChangeSummaries)\r\n   * @param iModel iModel\r\n   * @param instanceChangeId ECInstanceId of the InstanceChange (see `ECDbChange.InstanceChange` ECClass in the *ECDbChange* ECSchema)\r\n   * @returns Returns the requested InstanceChange object (see `ECDbChange.InstanceChange` ECClass in the *ECDbChange* ECSchema)\r\n   * @throws [IModelError]($common) if instance change does not exist for the specified id, or if the\r\n   * change cache file hasn't been attached, or in case of other errors.\r\n   */\r\n  public static queryInstanceChange(iModel: BriefcaseDb, instanceChangeId: Id64String): InstanceChange {\r\n    if (!ChangeSummaryManager.isChangeCacheAttached(iModel))\r\n      throw new IModelError(IModelStatus.BadArg, \"Change Cache file must be attached to iModel.\");\r\n\r\n    // query instance changes\r\n    const instanceChange: InstanceChange = iModel.withPreparedStatement(`SELECT ic.Summary.Id summaryId, s.Name changedInstanceSchemaName, c.Name changedInstanceClassName, ic.ChangedInstance.Id changedInstanceId,\r\n       ic.OpCode, ic.IsIndirect FROM ecchange.change.InstanceChange ic JOIN main.meta.ECClassDef c ON c.ECInstanceId = ic.ChangedInstance.ClassId\r\n       JOIN main.meta.ECSchemaDef s ON c.Schema.Id = s.ECInstanceId WHERE ic.ECInstanceId =? `, (stmt: ECSqlStatement) => {\r\n      stmt.bindId(1, instanceChangeId);\r\n      if (stmt.step() !== DbResult.BE_SQLITE_ROW)\r\n        throw new IModelError(IModelStatus.BadArg, `No InstanceChange found for id ${instanceChangeId}.`);\r\n\r\n      const row = stmt.getRow();\r\n      const changedInstanceId: Id64String = row.changedInstanceId;\r\n      const changedInstanceClassName: string = `[${row.changedInstanceSchemaName}].[${row.changedInstanceClassName}]`;\r\n      const op: ChangeOpCode = row.opCode as ChangeOpCode;\r\n\r\n      return {\r\n        id: instanceChangeId, summaryId: row.summaryId, changedInstance: { id: changedInstanceId, className: changedInstanceClassName },\r\n        opCode: op, isIndirect: row.isIndirect,\r\n      };\r\n    });\r\n\r\n    return instanceChange;\r\n  }\r\n\r\n  /** Retrieves the names of the properties whose values have changed for the given instance change\r\n   *\r\n   * See also [Change Summary Overview]($docs/learning/ChangeSummaries)\r\n   * @param iModel iModel\r\n   * @param instanceChangeId Id of the InstanceChange to query the properties whose values have changed\r\n   * @returns Returns names of the properties whose values have changed for the given instance change\r\n   * @throws [IModelError]($common) if the change cache file hasn't been attached, or in case of other errors.\r\n   */\r\n  public static getChangedPropertyValueNames(iModel: IModelDb, instanceChangeId: Id64String): string[] {\r\n    return iModel.withPreparedStatement(\"SELECT AccessString FROM ecchange.change.PropertyValueChange WHERE InstanceChange.Id=?\",\r\n      (stmt: ECSqlStatement) => {\r\n        stmt.bindId(1, instanceChangeId);\r\n\r\n        const selectClauseItems: string[] = [];\r\n        while (stmt.step() === DbResult.BE_SQLITE_ROW) {\r\n          // access string tokens need to be escaped as they might collide with reserved words in ECSQL or SQLite\r\n          const accessString: string = stmt.getValue(0).getString();\r\n          const accessStringTokens: string[] = accessString.split(\".\");\r\n          assert(accessStringTokens.length > 0);\r\n\r\n          let isFirstToken: boolean = true;\r\n          let item: string = \"\";\r\n          for (const token of accessStringTokens) {\r\n            if (!isFirstToken)\r\n              item += \".\";\r\n\r\n            item += `[${token}]`;\r\n            isFirstToken = false;\r\n          }\r\n          selectClauseItems.push(item);\r\n        }\r\n\r\n        return selectClauseItems;\r\n      });\r\n  }\r\n\r\n  /** Builds the ECSQL to query the property value changes for the specified instance change and the specified ChangedValueState.\r\n   *\r\n   * See also [Change Summary Overview]($docs/learning/ChangeSummaries)\r\n   * @param iModel iModel\r\n   * @param instanceChangeInfo InstanceChange to query the property value changes for\r\n   *        changedInstance.className must be fully qualified and schema and class name must be escaped with square brackets if they collide with reserved ECSQL words: `[schema name].[class name]`\r\n   * @param changedValueState The Changed State to query the values for. This must correspond to the [InstanceChange.OpCode]($backend) of the InstanceChange.\r\n   * @param changedPropertyNames List of the property names for which values have changed for the specified instance change.\r\n   *        The list can be obtained by calling [ChangeSummaryManager.getChangedPropertyValueNames]($core-backend).\r\n   *        If omitted, the method will call the above method by itself. The parameter allows for checking first whether\r\n   *        an instance change has any property value changes at all. If there are no property value changes, this method\r\n   *        should not be called, as it will throw an error.\r\n   * @returns Returns the ECSQL that will retrieve the property value changes\r\n   * @throws [IModelError]($common) if instance change does not exist, if there are not property value changes for the instance change,\r\n   *        if the change cache file hasn't been attached, or in case of other errors.\r\n   */\r\n  public static buildPropertyValueChangesECSql(iModel: IModelDb, instanceChangeInfo: { id: Id64String, summaryId: Id64String, changedInstance: { id: Id64String, className: string } }, changedValueState: ChangedValueState, changedPropertyNames?: string[]): string {\r\n    let selectClauseItems: string[];\r\n    if (!changedPropertyNames) {\r\n      // query property value changes just to build a SELECT statement against the class of the changed instance\r\n      selectClauseItems = ChangeSummaryManager.getChangedPropertyValueNames(iModel, instanceChangeInfo.id);\r\n    } else\r\n      selectClauseItems = changedPropertyNames;\r\n\r\n    if (selectClauseItems.length === 0)\r\n      throw new IModelError(IModelStatus.BadArg, `No property value changes found for InstanceChange ${instanceChangeInfo.id}.`);\r\n\r\n    let ecsql: string = \"SELECT \";\r\n    selectClauseItems.map((item: string, index: number) => {\r\n      if (index !== 0)\r\n        ecsql += \",\";\r\n\r\n      ecsql += item;\r\n    });\r\n\r\n    // Avoiding parameters in the Changes function speeds up performance because ECDb can do optimizations\r\n    // if it knows the function args at prepare time\r\n    ecsql += ` FROM main.${instanceChangeInfo.changedInstance.className}.Changes(${instanceChangeInfo.summaryId},${changedValueState}) WHERE ECInstanceId=${instanceChangeInfo.changedInstance.id}`;\r\n    return ecsql;\r\n  }\r\n\r\n  /**\r\n   * Creates a change summary for the last applied change set to the iModel\r\n   * @param accessToken A valid access token string\r\n   * @param iModel iModel to extract change summaries for. The iModel must not be a standalone iModel, and must have at least one change set applied to it.\r\n   * @returns The id of the extracted change summary.\r\n   * @beta\r\n   */\r\n  public static async createChangeSummary(accessToken: AccessToken, iModel: BriefcaseDb): Promise<Id64String> {\r\n    if (!iModel?.isOpen)\r\n      throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n    const changesetId = iModel.changeset.id;\r\n    if (!changesetId)\r\n      throw new IModelError(IModelStatus.BadRequest, \"No change set was applied to the iModel\");\r\n    if (this.isChangeCacheAttached(iModel))\r\n      throw new IModelError(IModelStatus.BadRequest, \"Change cache must be detached before extraction\");\r\n\r\n    const iModelId = iModel.iModelId;\r\n    const changesetsFolder: string = BriefcaseManager.getChangeSetsPath(iModelId);\r\n    const changeset = await IModelHost.hubAccess.downloadChangeset({ accessToken, iModelId, changeset: { id: iModel.changeset.id }, targetDir: changesetsFolder });\r\n\r\n    if (!IModelJsFs.existsSync(changeset.pathname))\r\n      throw new IModelError(IModelStatus.FileNotFound, `Failed to download change set: ${changeset.pathname}`);\r\n\r\n    let changesFile: ECDb | undefined;\r\n    try {\r\n      changesFile = ChangeSummaryManager.openOrCreateChangesFile(iModel);\r\n      assert(changesFile.nativeDb !== undefined, \"Invalid changesFile - should've caused an exception\");\r\n\r\n      let changeSummaryId = ChangeSummaryManager.isSummaryAlreadyExtracted(changesFile, changesetId);\r\n      if (changeSummaryId !== undefined) {\r\n        Logger.logInfo(loggerCategory, `Change Summary for changeset already exists. It is not extracted again.`, () => ({ iModelId, changeSetId: changesetId }));\r\n        return changeSummaryId;\r\n      }\r\n\r\n      const stat = iModel.nativeDb.extractChangeSummary(changesFile.nativeDb, changeset.pathname);\r\n      if (stat.error && stat.error.status !== DbResult.BE_SQLITE_OK)\r\n        throw new IModelError(stat.error.status, stat.error.message);\r\n\r\n      assert(undefined !== stat.result);\r\n      changeSummaryId = stat.result;\r\n      ChangeSummaryManager.addExtendedInfos(changesFile, changeSummaryId, changesetId, changeset.parentId, changeset.description, changeset.pushDate, changeset.userCreated);\r\n\r\n      changesFile.saveChanges();\r\n      return changeSummaryId;\r\n    } finally {\r\n      if (changesFile !== undefined)\r\n        changesFile.dispose();\r\n      IModelJsFs.unlinkSync(changeset.pathname);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Creates change summaries for the specified iModel and a specified range of versions\r\n   * @note This may be an expensive operation - downloads the first version and starts applying the change sets, extracting summaries one by one\r\n   * @param args Arguments including the range of versions for which Change Summaries are to be created, and other necessary input for creation\r\n   */\r\n  public static async createChangeSummaries(args: CreateChangeSummaryArgs): Promise<Id64String[]> {\r\n    const accessToken = args.accessToken ?? await IModelHost.getAccessToken() ?? \"\";\r\n    const { iModelId, iTwinId, range } = args;\r\n    range.end = range.end ?? (await IModelHost.hubAccess.getChangesetFromVersion({ accessToken, iModelId, version: IModelVersion.latest() })).index;\r\n    if (range.first > range.end)\r\n      throw new IModelError(IModelStatus.BadArg, \"Invalid range of changesets\");\r\n    if (range.first === 0 && range.end === 0)\r\n      return []; // no changesets exist, so the inclusive range is empty\r\n\r\n    const changesets = await IModelHost.hubAccess.queryChangesets({ accessToken, iModelId, range });\r\n\r\n    // Setup a temporary briefcase to help with extracting change summaries\r\n    const briefcasePath = BriefcaseManager.getBriefcaseBasePath(iModelId);\r\n    const fileName: string = path.join(briefcasePath, `ChangeSummaryBriefcase.bim`);\r\n    if (IModelJsFs.existsSync(fileName))\r\n      IModelJsFs.removeSync(fileName);\r\n\r\n    let iModel: BriefcaseDb | undefined;\r\n    try {\r\n      // Download a version that has the first change set applied\r\n      const props = await BriefcaseManager.downloadBriefcase({ accessToken, iTwinId, iModelId, asOf: { afterChangeSetId: changesets[0].id }, briefcaseId: 0, fileName });\r\n      iModel = await BriefcaseDb.open({ fileName: props.fileName });\r\n\r\n      const summaryIds = new Array<Id64String>();\r\n      for (let index = 0; index < changesets.length; index++) {\r\n        // Apply a change set if necessary\r\n        if (index > 0)\r\n          await iModel.pullChanges({ accessToken, toIndex: changesets[index].index });\r\n\r\n        // Create a change summary for the last change set that was applied\r\n        const summaryId = await this.createChangeSummary(accessToken, iModel);\r\n        summaryIds.push(summaryId);\r\n      }\r\n      return summaryIds;\r\n    } finally {\r\n      if (iModel !== undefined)\r\n        iModel.close();\r\n      IModelJsFs.removeSync(fileName);\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ChangeSummaryManager.js","sourceRoot":"","sources":["../../src/ChangeSummaryManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAyH;AACzH,oDAAiH;AACjH,6BAA6B;AAC7B,mEAAgE;AAChE,yDAAsD;AACtD,iCAA4C;AAE5C,yCAA6D;AAC7D,6CAA0D;AAC1D,6CAA0C;AAE1C,MAAM,cAAc,GAAW,6CAAqB,CAAC,IAAI,CAAC;AAiD1D;;;;;GAKG;AACH,MAAa,oBAAoB;IAG/B;;;OAGG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAAgB;QAClD,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM;YAC3B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAE3E,OAAO,MAAM,CAAC,QAAQ,CAAC,qBAAqB,EAAE,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,MAAgB;QAC9C,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM;YAC3B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAE3E,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,CAAC;YACpD,OAAO;QAET,MAAM,oBAAoB,GAAW,mCAAgB,CAAC,sBAAsB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC9F,IAAI,CAAC,uBAAU,CAAC,UAAU,CAAC,oBAAoB,CAAC,EAAE,CAAC;YACjD,IAAA,oBAAK,EAAC,IAAI,WAAI,EAAE,EAAE,CAAC,eAAqB,EAAE,EAAE;gBAC1C,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,EAAE,eAAe,EAAE,oBAAoB,CAAC,CAAC;YAC5F,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAA,qBAAM,EAAC,uBAAU,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC,CAAC;QACpD,MAAM,GAAG,GAAa,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;QAC9E,IAAI,GAAG,KAAK,uBAAQ,CAAC,YAAY;YAC/B,MAAM,IAAI,yBAAW,CAAC,GAAG,EAAE,yCAAyC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC;IAC5F,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,MAAgB;QAC9C,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM;YAC3B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAE3E,MAAM,CAAC,WAAW,EAAE,CAAC;QACrB,MAAM,GAAG,GAAa,MAAM,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QAC1D,IAAI,GAAG,KAAK,uBAAQ,CAAC,YAAY;YAC/B,MAAM,IAAI,yBAAW,CAAC,GAAG,EAAE,2CAA2C,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC;IAC9F,CAAC;IAEO,MAAM,CAAC,uBAAuB,CAAC,MAAmB;QACxD,IAAI,CAAC,MAAM,EAAE,MAAM;YACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,6CAA6C,CAAC,CAAC;QAE5F,MAAM,WAAW,GAAG,IAAI,WAAI,EAAE,CAAC;QAC/B,MAAM,mBAAmB,GAAG,mCAAgB,CAAC,sBAAsB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACrF,IAAI,uBAAU,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE,CAAC;YAC/C,oBAAoB,CAAC,mBAAmB,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;YAC3E,OAAO,WAAW,CAAC;QACrB,CAAC;QAED,IAAI,CAAC;YACH,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,EAAE,WAAW,EAAE,mBAAmB,CAAC,CAAC;YACrF,OAAO,WAAW,CAAC;QACrB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,0EAA0E;YAC1E,IAAI,uBAAU,CAAC,UAAU,CAAC,mBAAmB,CAAC;gBAC5C,uBAAU,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;YAE7C,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,WAAiB,EAAE,mBAA2B;QACnG,IAAI,CAAC,MAAM,EAAE,MAAM;YACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,6CAA6C,CAAC,CAAC;QAE5F,MAAM,IAAI,GAAa,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,WAAW,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC;QACpG,IAAI,IAAI,KAAK,uBAAQ,CAAC,YAAY;YAChC,MAAM,IAAI,yBAAW,CAAC,IAAI,EAAE,0CAA0C,mBAAmB,IAAI,CAAC,CAAC;QAEjG,iGAAiG;QACjG,WAAW,CAAC,YAAY,CAAC,oBAAoB,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACzE,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,WAAiB,EAAE,mBAA2B;QAC/E,WAAW,CAAC,MAAM,CAAC,mBAAmB,EAAE,mBAAY,CAAC,WAAW,CAAC,CAAC;QAElE,MAAM,mBAAmB,GAAmD,WAAW,CAAC,qBAAqB,CAAC,gHAAgH,EAC5N,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa;gBACxC,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,wCAAwC,CAAC,CAAC;YAE5F,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;QAEL,IAAI,mBAAmB,CAAC,IAAI,KAAK,oBAAoB,CAAC,iCAAiC,CAAC,IAAI;YAC1F,mBAAmB,CAAC,KAAK,KAAK,oBAAoB,CAAC,iCAAiC,CAAC,KAAK;YAC1F,mBAAmB,CAAC,KAAK,KAAK,oBAAoB,CAAC,iCAAiC,CAAC,KAAK;YAC1F,OAAO;QAET,WAAW,CAAC,YAAY,CAAC,oBAAoB,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACzE,CAAC;IAEO,MAAM,CAAC,qBAAqB,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,2BAAc,CAAC,gBAAgB,EAAE,oCAAoC,CAAC,CAAC,CAAC,CAAC;IAEnI,MAAM,CAAC,yBAAyB,CAAC,WAAiB,EAAE,WAAuB;QACjF,OAAO,WAAW,CAAC,qBAAqB,CAAC,uEAAuE,EAC9G,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;YAChC,IAAI,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE;gBACxC,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;YAElC,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,WAAiB,EAAE,eAA2B,EAAE,cAA0B,EAAE,oBAAiC,EAAE,WAAoB,EAAE,iBAA0B,EAAE,oBAAiC;QAChO,WAAW,CAAC,qBAAqB,CAAC,uHAAuH,EACvJ,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;YAChC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;YACnC,IAAI,oBAAoB;gBACtB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;YAE3C,IAAI,WAAW;gBACb,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;YAElC,IAAI,iBAAiB;gBACnB,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC;YAE1C,IAAI,oBAAoB;gBACtB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;YAE3C,MAAM,CAAC,GAAa,IAAI,CAAC,IAAI,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,uBAAQ,CAAC,cAAc;gBAC/B,MAAM,IAAI,yBAAW,CAAC,CAAC,EAAE,mEAAmE,eAAe,EAAE,CAAC,CAAC;QACnH,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,kBAAkB,CAAC,MAAmB,EAAE,eAA2B;QAC/E,IAAI,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,CAAC;YACrD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,+CAA+C,CAAC,CAAC;QAE9F,OAAO,MAAM,CAAC,qBAAqB,CAAC,mHAAmH,EACrJ,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;YAChC,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa;gBACxC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,oDAAoD,eAAe,GAAG,CAAC,CAAC;YAErH,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YAC1B,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC;QACpL,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAAmB,EAAE,gBAA4B;QACjF,IAAI,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,MAAM,CAAC;YACrD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,+CAA+C,CAAC,CAAC;QAE9F,yBAAyB;QACzB,MAAM,cAAc,GAAmB,MAAM,CAAC,qBAAqB,CAAC;;8FAEsB,EAAE,CAAC,IAAoB,EAAE,EAAE;YACnH,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;YACjC,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa;gBACxC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,kCAAkC,gBAAgB,GAAG,CAAC,CAAC;YAEpG,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,iBAAiB,GAAe,GAAG,CAAC,iBAAiB,CAAC;YAC5D,MAAM,wBAAwB,GAAW,IAAI,GAAG,CAAC,yBAAyB,MAAM,GAAG,CAAC,wBAAwB,GAAG,CAAC;YAChH,MAAM,EAAE,GAAiB,GAAG,CAAC,MAAsB,CAAC;YAEpD,OAAO;gBACL,EAAE,EAAE,gBAAgB,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,EAAE,EAAE,EAAE,iBAAiB,EAAE,SAAS,EAAE,wBAAwB,EAAE;gBAC/H,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,GAAG,CAAC,UAAU;aACvC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,4BAA4B,CAAC,MAAgB,EAAE,gBAA4B;QACvF,OAAO,MAAM,CAAC,qBAAqB,CAAC,wFAAwF,EAC1H,CAAC,IAAoB,EAAE,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;YAEjC,MAAM,iBAAiB,GAAa,EAAE,CAAC;YACvC,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa,EAAE,CAAC;gBAC9C,uGAAuG;gBACvG,MAAM,YAAY,GAAW,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;gBAC1D,MAAM,kBAAkB,GAAa,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC7D,IAAA,qBAAM,EAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAEtC,IAAI,YAAY,GAAY,IAAI,CAAC;gBACjC,IAAI,IAAI,GAAW,EAAE,CAAC;gBACtB,KAAK,MAAM,KAAK,IAAI,kBAAkB,EAAE,CAAC;oBACvC,IAAI,CAAC,YAAY;wBACf,IAAI,IAAI,GAAG,CAAC;oBAEd,IAAI,IAAI,IAAI,KAAK,GAAG,CAAC;oBACrB,YAAY,GAAG,KAAK,CAAC;gBACvB,CAAC;gBACD,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;YAED,OAAO,iBAAiB,CAAC;QAC3B,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,MAAM,CAAC,8BAA8B,CAAC,MAAgB,EAAE,kBAAqH,EAAE,iBAAoC,EAAE,oBAA+B;QACzP,IAAI,iBAA2B,CAAC;QAChC,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC1B,0GAA0G;YAC1G,iBAAiB,GAAG,oBAAoB,CAAC,4BAA4B,CAAC,MAAM,EAAE,kBAAkB,CAAC,EAAE,CAAC,CAAC;QACvG,CAAC;;YACC,iBAAiB,GAAG,oBAAoB,CAAC;QAE3C,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC;YAChC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,sDAAsD,kBAAkB,CAAC,EAAE,GAAG,CAAC,CAAC;QAE7H,IAAI,KAAK,GAAW,SAAS,CAAC;QAC9B,iBAAiB,CAAC,GAAG,CAAC,CAAC,IAAY,EAAE,KAAa,EAAE,EAAE;YACpD,IAAI,KAAK,KAAK,CAAC;gBACb,KAAK,IAAI,GAAG,CAAC;YAEf,KAAK,IAAI,IAAI,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,sGAAsG;QACtG,gDAAgD;QAChD,KAAK,IAAI,cAAc,kBAAkB,CAAC,eAAe,CAAC,SAAS,YAAY,kBAAkB,CAAC,SAAS,IAAI,iBAAiB,wBAAwB,kBAAkB,CAAC,eAAe,CAAC,EAAE,EAAE,CAAC;QAChM,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,WAAwB,EAAE,MAAmB;QACnF,IAAI,CAAC,MAAM,EAAE,MAAM;YACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAC3E,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,WAAW;YACd,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,yCAAyC,CAAC,CAAC;QAC5F,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC;YACpC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,iDAAiD,CAAC,CAAC;QAEpG,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QACjC,MAAM,gBAAgB,GAAW,mCAAgB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAC9E,MAAM,SAAS,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC,CAAC;QAE/J,IAAI,CAAC,uBAAU,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC;YAC5C,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,YAAY,EAAE,kCAAkC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE3G,IAAI,WAA6B,CAAC;QAClC,IAAI,CAAC;YACH,WAAW,GAAG,oBAAoB,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;YACnE,IAAA,qBAAM,EAAC,WAAW,CAAC,QAAQ,KAAK,SAAS,EAAE,qDAAqD,CAAC,CAAC;YAElG,IAAI,eAAe,GAAG,oBAAoB,CAAC,yBAAyB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YAC/F,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;gBAClC,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,yEAAyE,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;gBAC1J,OAAO,eAAe,CAAC;YACzB,CAAC;YAED,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,WAAW,CAAC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC5F,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,uBAAQ,CAAC,YAAY;gBAC3D,MAAM,IAAI,yBAAW,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAE/D,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC;YAClC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC;YAC9B,oBAAoB,CAAC,gBAAgB,CAAC,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,WAAW,EAAE,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;YAEvK,WAAW,CAAC,WAAW,EAAE,CAAC;YAC1B,OAAO,eAAe,CAAC;QACzB,CAAC;gBAAS,CAAC;YACT,IAAI,WAAW,KAAK,SAAS;gBAC3B,WAAW,CAAC,OAAO,EAAE,CAAC;YACxB,uBAAU,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAA6B;QACrE,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,MAAM,uBAAU,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC;QAChF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAC1C,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,2BAAa,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAChJ,IAAI,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG;YACzB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAC;QAC5E,IAAI,KAAK,CAAC,KAAK,KAAK,CAAC,IAAI,KAAK,CAAC,GAAG,KAAK,CAAC;YACtC,OAAO,EAAE,CAAC,CAAC,uDAAuD;QAEpE,MAAM,UAAU,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAEhG,uEAAuE;QACvE,MAAM,aAAa,GAAG,mCAAgB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QACtE,MAAM,QAAQ,GAAW,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,4BAA4B,CAAC,CAAC;QAChF,IAAI,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC;YACjC,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAElC,IAAI,MAA+B,CAAC;QACpC,IAAI,CAAC;YACH,2DAA2D;YAC3D,MAAM,KAAK,GAAG,MAAM,mCAAgB,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,gBAAgB,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;YACnK,MAAM,GAAG,MAAM,sBAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YAE9D,MAAM,UAAU,GAAG,IAAI,KAAK,EAAc,CAAC;YAC3C,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;gBACvD,kCAAkC;gBAClC,IAAI,KAAK,GAAG,CAAC;oBACX,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;gBAE9E,mEAAmE;gBACnE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;gBACtE,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC7B,CAAC;YACD,OAAO,UAAU,CAAC;QACpB,CAAC;gBAAS,CAAC;YACT,IAAI,MAAM,KAAK,SAAS;gBACtB,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;;AA3XH,oDA4XC;AA3XyB,sDAAiC,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC","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 { AccessToken, assert, DbResult, GuidString, Id64String, IModelStatus, Logger, using } from \"@itwin/core-bentley\";\r\nimport { ChangedValueState, ChangeOpCode, ChangesetRange, IModelError, IModelVersion } from \"@itwin/core-common\";\r\nimport * as path from \"path\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { BriefcaseManager } from \"./BriefcaseManager\";\r\nimport { ECDb, ECDbOpenMode } from \"./ECDb\";\r\nimport { ECSqlStatement } from \"./ECSqlStatement\";\r\nimport { BriefcaseDb, IModelDb, TokenArg } from \"./IModelDb\";\r\nimport { IModelHost, KnownLocations } from \"./IModelHost\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\n\r\nconst loggerCategory: string = BackendLoggerCategory.ECDb;\r\n\r\n/** Represents an instance of the `ChangeSummary` ECClass from the `ECDbChange` ECSchema\r\n * combined with the information from the related `Changeset` instance (from the `IModelChange` ECSchema) from\r\n * which the Change Summary was extracted.\r\n *\r\n * See also\r\n * - [ChangeSummaryManager.queryChangeSummary]($backend)\r\n * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)\r\n * @beta\r\n */\r\nexport interface ChangeSummary {\r\n  id: Id64String;\r\n  changeSet: { wsgId: GuidString, parentWsgId: GuidString, description: string, pushDate: string, userCreated: GuidString };\r\n}\r\n\r\n/** Represents an instance of the `InstanceChange` ECClass from the `ECDbChange` ECSchema\r\n *\r\n * See also\r\n * - [ChangeSummaryManager.queryInstanceChange]($backend)\r\n * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)\r\n * @beta\r\n */\r\nexport interface InstanceChange {\r\n  id: Id64String;\r\n  summaryId: Id64String;\r\n  changedInstance: { id: Id64String, className: string };\r\n  opCode: ChangeOpCode;\r\n  isIndirect: boolean;\r\n}\r\n\r\n/** Options for [ChangeSummaryManager.createChangeSummaries]($backend).\r\n * @beta\r\n */\r\nexport interface CreateChangeSummaryArgs extends TokenArg {\r\n  /** Id of the iTwin that contains the iModel */\r\n  iTwinId: GuidString;\r\n\r\n  /** Id of the iModel */\r\n  iModelId: GuidString;\r\n\r\n  /**\r\n   * Range of change sets\r\n   * - the Change Summary for the first and last versions are also included\r\n   * - if unspecified, all change sets until the latest version are processed\r\n   */\r\n  range: ChangesetRange;\r\n}\r\n\r\n/** Class to extract Change Summaries for a briefcase.\r\n *\r\n * See also:\r\n * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)\r\n * @beta\r\n */\r\nexport class ChangeSummaryManager {\r\n  private static readonly _currentIModelChangeSchemaVersion = { read: 2, write: 0, minor: 0 };\r\n\r\n  /** Determines whether the *Change Cache file* is attached to the specified iModel or not\r\n   * @param iModel iModel to check whether a *Change Cache file* is attached\r\n   * @returns Returns true if the *Change Cache file* is attached to the iModel. false otherwise\r\n   */\r\n  public static isChangeCacheAttached(iModel: IModelDb): boolean {\r\n    if (!iModel || !iModel.isOpen)\r\n      throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n\r\n    return iModel.nativeDb.isChangeCacheAttached();\r\n  }\r\n\r\n  /** Attaches the *Change Cache file* to the specified iModel if it hasn't been attached yet.\r\n   * A new *Change Cache file* will be created for the iModel if it hasn't existed before.\r\n   * @param iModel iModel to attach the *Change Cache file* file to\r\n   * @throws [IModelError]($common)\r\n   */\r\n  public static attachChangeCache(iModel: IModelDb): void {\r\n    if (!iModel || !iModel.isOpen)\r\n      throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n\r\n    if (ChangeSummaryManager.isChangeCacheAttached(iModel))\r\n      return;\r\n\r\n    const changesCacheFilePath: string = BriefcaseManager.getChangeCachePathName(iModel.iModelId);\r\n    if (!IModelJsFs.existsSync(changesCacheFilePath)) {\r\n      using(new ECDb(), (changeCacheFile: ECDb) => {\r\n        ChangeSummaryManager.createChangeCacheFile(iModel, changeCacheFile, changesCacheFilePath);\r\n      });\r\n    }\r\n\r\n    assert(IModelJsFs.existsSync(changesCacheFilePath));\r\n    const res: DbResult = iModel.nativeDb.attachChangeCache(changesCacheFilePath);\r\n    if (res !== DbResult.BE_SQLITE_OK)\r\n      throw new IModelError(res, `Failed to attach Change Cache file to ${iModel.pathName}.`);\r\n  }\r\n\r\n  /** Detaches the *Change Cache file* from the specified iModel.\r\n   * - note that this method will cause any pending (currently running or queued) queries to fail\r\n   * @param iModel iModel to detach the *Change Cache file* to\r\n   * @throws [IModelError]($common) in case of errors, e.g. if no *Change Cache file* was attached before.\r\n   */\r\n  public static detachChangeCache(iModel: IModelDb): void {\r\n    if (!iModel || !iModel.isOpen)\r\n      throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n\r\n    iModel.clearCaches();\r\n    const res: DbResult = iModel.nativeDb.detachChangeCache();\r\n    if (res !== DbResult.BE_SQLITE_OK)\r\n      throw new IModelError(res, `Failed to detach Change Cache file from ${iModel.pathName}.`);\r\n  }\r\n\r\n  private static openOrCreateChangesFile(iModel: BriefcaseDb): ECDb {\r\n    if (!iModel?.isOpen)\r\n      throw new IModelError(IModelStatus.BadArg, \"Invalid iModel handle. iModel must be open.\");\r\n\r\n    const changesFile = new ECDb();\r\n    const changeCacheFilePath = BriefcaseManager.getChangeCachePathName(iModel.iModelId);\r\n    if (IModelJsFs.existsSync(changeCacheFilePath)) {\r\n      ChangeSummaryManager.openChangeCacheFile(changesFile, changeCacheFilePath);\r\n      return changesFile;\r\n    }\r\n\r\n    try {\r\n      ChangeSummaryManager.createChangeCacheFile(iModel, changesFile, changeCacheFilePath);\r\n      return changesFile;\r\n    } catch (e) {\r\n      // delete cache file again in case it was created but schema import failed\r\n      if (IModelJsFs.existsSync(changeCacheFilePath))\r\n        IModelJsFs.removeSync(changeCacheFilePath);\r\n\r\n      throw e;\r\n    }\r\n  }\r\n\r\n  private static createChangeCacheFile(iModel: IModelDb, changesFile: ECDb, changeCacheFilePath: string): void {\r\n    if (!iModel?.isOpen)\r\n      throw new IModelError(IModelStatus.BadArg, \"Invalid iModel object. iModel must be open.\");\r\n\r\n    const stat: DbResult = iModel.nativeDb.createChangeCache(changesFile.nativeDb, changeCacheFilePath);\r\n    if (stat !== DbResult.BE_SQLITE_OK)\r\n      throw new IModelError(stat, `Failed to create Change Cache file at \"${changeCacheFilePath}\".`);\r\n\r\n    // Extended information like changeset ids, push dates are persisted in the IModelChange ECSchema\r\n    changesFile.importSchema(ChangeSummaryManager.getExtendedSchemaPath());\r\n  }\r\n\r\n  private static openChangeCacheFile(changesFile: ECDb, changeCacheFilePath: string): void {\r\n    changesFile.openDb(changeCacheFilePath, ECDbOpenMode.FileUpgrade);\r\n\r\n    const actualSchemaVersion: { read: number, write: number, minor: number } = changesFile.withPreparedStatement(\"SELECT VersionMajor read,VersionWrite write,VersionMinor minor FROM meta.ECSchemaDef WHERE Name='IModelChange'\",\r\n      (stmt: ECSqlStatement) => {\r\n        if (stmt.step() !== DbResult.BE_SQLITE_ROW)\r\n          throw new IModelError(DbResult.BE_SQLITE_ERROR, \"File is not a valid Change Cache file.\");\r\n\r\n        return stmt.getRow();\r\n      });\r\n\r\n    if (actualSchemaVersion.read === ChangeSummaryManager._currentIModelChangeSchemaVersion.read &&\r\n      actualSchemaVersion.write === ChangeSummaryManager._currentIModelChangeSchemaVersion.write &&\r\n      actualSchemaVersion.minor === ChangeSummaryManager._currentIModelChangeSchemaVersion.minor)\r\n      return;\r\n\r\n    changesFile.importSchema(ChangeSummaryManager.getExtendedSchemaPath());\r\n  }\r\n\r\n  private static getExtendedSchemaPath(): string { return path.join(KnownLocations.packageAssetsDir, \"IModelChange.02.00.00.ecschema.xml\"); }\r\n\r\n  private static isSummaryAlreadyExtracted(changesFile: ECDb, changeSetId: GuidString): Id64String | undefined {\r\n    return changesFile.withPreparedStatement(\"SELECT Summary.Id summaryid FROM imodelchange.ChangeSet WHERE WsgId=?\",\r\n      (stmt: ECSqlStatement) => {\r\n        stmt.bindString(1, changeSetId);\r\n        if (DbResult.BE_SQLITE_ROW === stmt.step())\r\n          return stmt.getValue(0).getId();\r\n\r\n        return undefined;\r\n      });\r\n  }\r\n\r\n  private static addExtendedInfos(changesFile: ECDb, changeSummaryId: Id64String, changesetWsgId: GuidString, changesetParentWsgId?: GuidString, description?: string, changesetPushDate?: string, changeSetUserCreated?: GuidString): void {\r\n    changesFile.withPreparedStatement(\"INSERT INTO imodelchange.ChangeSet(Summary.Id,WsgId,ParentWsgId,Description,PushDate,UserCreated) VALUES(?,?,?,?,?,?)\",\r\n      (stmt: ECSqlStatement) => {\r\n        stmt.bindId(1, changeSummaryId);\r\n        stmt.bindString(2, changesetWsgId);\r\n        if (changesetParentWsgId)\r\n          stmt.bindString(3, changesetParentWsgId);\r\n\r\n        if (description)\r\n          stmt.bindString(4, description);\r\n\r\n        if (changesetPushDate)\r\n          stmt.bindDateTime(5, changesetPushDate);\r\n\r\n        if (changeSetUserCreated)\r\n          stmt.bindString(6, changeSetUserCreated);\r\n\r\n        const r: DbResult = stmt.step();\r\n        if (r !== DbResult.BE_SQLITE_DONE)\r\n          throw new IModelError(r, `Failed to add changeset information to extracted change summary ${changeSummaryId}`);\r\n      });\r\n  }\r\n\r\n  /** Queries the ChangeSummary for the specified change summary id\r\n   *\r\n   * See also\r\n   * - `ECDbChange.ChangeSummary` ECClass in the *ECDbChange* ECSchema\r\n   * - [Change Summary Overview]($docs/learning/ChangeSummaries)\r\n   * @param iModel iModel\r\n   * @param changeSummaryId ECInstanceId of the ChangeSummary\r\n   * @returns Returns the requested ChangeSummary object\r\n   * @throws [IModelError]($common) If change summary does not exist for the specified id, or if the\r\n   * change cache file hasn't been attached, or in case of other errors.\r\n   */\r\n  public static queryChangeSummary(iModel: BriefcaseDb, changeSummaryId: Id64String): ChangeSummary {\r\n    if (!ChangeSummaryManager.isChangeCacheAttached(iModel))\r\n      throw new IModelError(IModelStatus.BadArg, \"Change Cache file must be attached to iModel.\");\r\n\r\n    return iModel.withPreparedStatement(\"SELECT WsgId,ParentWsgId,Description,PushDate,UserCreated FROM ecchange.imodelchange.ChangeSet WHERE Summary.Id=?\",\r\n      (stmt: ECSqlStatement) => {\r\n        stmt.bindId(1, changeSummaryId);\r\n        if (stmt.step() !== DbResult.BE_SQLITE_ROW)\r\n          throw new IModelError(IModelStatus.BadArg, `No ChangeSet information found for ChangeSummary ${changeSummaryId}.`);\r\n\r\n        const row = stmt.getRow();\r\n        return { id: changeSummaryId, changeSet: { wsgId: row.wsgId, parentWsgId: row.parentWsgId, description: row.description, pushDate: row.pushDate, userCreated: row.userCreated } };\r\n      });\r\n  }\r\n\r\n  /** Queries the InstanceChange for the specified instance change id.\r\n   *\r\n   * See also\r\n   * - `ECDbChange.InstanceChange` ECClass in the *ECDbChange* ECSchema\r\n   * - [Change Summary Overview]($docs/learning/ChangeSummaries)\r\n   * @param iModel iModel\r\n   * @param instanceChangeId ECInstanceId of the InstanceChange (see `ECDbChange.InstanceChange` ECClass in the *ECDbChange* ECSchema)\r\n   * @returns Returns the requested InstanceChange object (see `ECDbChange.InstanceChange` ECClass in the *ECDbChange* ECSchema)\r\n   * @throws [IModelError]($common) if instance change does not exist for the specified id, or if the\r\n   * change cache file hasn't been attached, or in case of other errors.\r\n   */\r\n  public static queryInstanceChange(iModel: BriefcaseDb, instanceChangeId: Id64String): InstanceChange {\r\n    if (!ChangeSummaryManager.isChangeCacheAttached(iModel))\r\n      throw new IModelError(IModelStatus.BadArg, \"Change Cache file must be attached to iModel.\");\r\n\r\n    // query instance changes\r\n    const instanceChange: InstanceChange = iModel.withPreparedStatement(`SELECT ic.Summary.Id summaryId, s.Name changedInstanceSchemaName, c.Name changedInstanceClassName, ic.ChangedInstance.Id changedInstanceId,\r\n       ic.OpCode, ic.IsIndirect FROM ecchange.change.InstanceChange ic JOIN main.meta.ECClassDef c ON c.ECInstanceId = ic.ChangedInstance.ClassId\r\n       JOIN main.meta.ECSchemaDef s ON c.Schema.Id = s.ECInstanceId WHERE ic.ECInstanceId =? `, (stmt: ECSqlStatement) => {\r\n      stmt.bindId(1, instanceChangeId);\r\n      if (stmt.step() !== DbResult.BE_SQLITE_ROW)\r\n        throw new IModelError(IModelStatus.BadArg, `No InstanceChange found for id ${instanceChangeId}.`);\r\n\r\n      const row = stmt.getRow();\r\n      const changedInstanceId: Id64String = row.changedInstanceId;\r\n      const changedInstanceClassName: string = `[${row.changedInstanceSchemaName}].[${row.changedInstanceClassName}]`;\r\n      const op: ChangeOpCode = row.opCode as ChangeOpCode;\r\n\r\n      return {\r\n        id: instanceChangeId, summaryId: row.summaryId, changedInstance: { id: changedInstanceId, className: changedInstanceClassName },\r\n        opCode: op, isIndirect: row.isIndirect,\r\n      };\r\n    });\r\n\r\n    return instanceChange;\r\n  }\r\n\r\n  /** Retrieves the names of the properties whose values have changed for the given instance change\r\n   *\r\n   * See also [Change Summary Overview]($docs/learning/ChangeSummaries)\r\n   * @param iModel iModel\r\n   * @param instanceChangeId Id of the InstanceChange to query the properties whose values have changed\r\n   * @returns Returns names of the properties whose values have changed for the given instance change\r\n   * @throws [IModelError]($common) if the change cache file hasn't been attached, or in case of other errors.\r\n   */\r\n  public static getChangedPropertyValueNames(iModel: IModelDb, instanceChangeId: Id64String): string[] {\r\n    return iModel.withPreparedStatement(\"SELECT AccessString FROM ecchange.change.PropertyValueChange WHERE InstanceChange.Id=?\",\r\n      (stmt: ECSqlStatement) => {\r\n        stmt.bindId(1, instanceChangeId);\r\n\r\n        const selectClauseItems: string[] = [];\r\n        while (stmt.step() === DbResult.BE_SQLITE_ROW) {\r\n          // access string tokens need to be escaped as they might collide with reserved words in ECSQL or SQLite\r\n          const accessString: string = stmt.getValue(0).getString();\r\n          const accessStringTokens: string[] = accessString.split(\".\");\r\n          assert(accessStringTokens.length > 0);\r\n\r\n          let isFirstToken: boolean = true;\r\n          let item: string = \"\";\r\n          for (const token of accessStringTokens) {\r\n            if (!isFirstToken)\r\n              item += \".\";\r\n\r\n            item += `[${token}]`;\r\n            isFirstToken = false;\r\n          }\r\n          selectClauseItems.push(item);\r\n        }\r\n\r\n        return selectClauseItems;\r\n      });\r\n  }\r\n\r\n  /** Builds the ECSQL to query the property value changes for the specified instance change and the specified ChangedValueState.\r\n   *\r\n   * See also [Change Summary Overview]($docs/learning/ChangeSummaries)\r\n   * @param iModel iModel\r\n   * @param instanceChangeInfo InstanceChange to query the property value changes for\r\n   *        changedInstance.className must be fully qualified and schema and class name must be escaped with square brackets if they collide with reserved ECSQL words: `[schema name].[class name]`\r\n   * @param changedValueState The Changed State to query the values for. This must correspond to the [InstanceChange.OpCode]($backend) of the InstanceChange.\r\n   * @param changedPropertyNames List of the property names for which values have changed for the specified instance change.\r\n   *        The list can be obtained by calling [ChangeSummaryManager.getChangedPropertyValueNames]($core-backend).\r\n   *        If omitted, the method will call the above method by itself. The parameter allows for checking first whether\r\n   *        an instance change has any property value changes at all. If there are no property value changes, this method\r\n   *        should not be called, as it will throw an error.\r\n   * @returns Returns the ECSQL that will retrieve the property value changes\r\n   * @throws [IModelError]($common) if instance change does not exist, if there are not property value changes for the instance change,\r\n   *        if the change cache file hasn't been attached, or in case of other errors.\r\n   */\r\n  public static buildPropertyValueChangesECSql(iModel: IModelDb, instanceChangeInfo: { id: Id64String, summaryId: Id64String, changedInstance: { id: Id64String, className: string } }, changedValueState: ChangedValueState, changedPropertyNames?: string[]): string {\r\n    let selectClauseItems: string[];\r\n    if (!changedPropertyNames) {\r\n      // query property value changes just to build a SELECT statement against the class of the changed instance\r\n      selectClauseItems = ChangeSummaryManager.getChangedPropertyValueNames(iModel, instanceChangeInfo.id);\r\n    } else\r\n      selectClauseItems = changedPropertyNames;\r\n\r\n    if (selectClauseItems.length === 0)\r\n      throw new IModelError(IModelStatus.BadArg, `No property value changes found for InstanceChange ${instanceChangeInfo.id}.`);\r\n\r\n    let ecsql: string = \"SELECT \";\r\n    selectClauseItems.map((item: string, index: number) => {\r\n      if (index !== 0)\r\n        ecsql += \",\";\r\n\r\n      ecsql += item;\r\n    });\r\n\r\n    // Avoiding parameters in the Changes function speeds up performance because ECDb can do optimizations\r\n    // if it knows the function args at prepare time\r\n    ecsql += ` FROM main.${instanceChangeInfo.changedInstance.className}.Changes(${instanceChangeInfo.summaryId},${changedValueState}) WHERE ECInstanceId=${instanceChangeInfo.changedInstance.id}`;\r\n    return ecsql;\r\n  }\r\n\r\n  /**\r\n   * Creates a change summary for the last applied change set to the iModel\r\n   * @param accessToken A valid access token string\r\n   * @param iModel iModel to extract change summaries for. The iModel must not be a standalone iModel, and must have at least one change set applied to it.\r\n   * @returns The id of the extracted change summary.\r\n   * @beta\r\n   */\r\n  public static async createChangeSummary(accessToken: AccessToken, iModel: BriefcaseDb): Promise<Id64String> {\r\n    if (!iModel?.isOpen)\r\n      throw new IModelError(IModelStatus.BadRequest, \"Briefcase must be open\");\r\n    const changesetId = iModel.changeset.id;\r\n    if (!changesetId)\r\n      throw new IModelError(IModelStatus.BadRequest, \"No change set was applied to the iModel\");\r\n    if (this.isChangeCacheAttached(iModel))\r\n      throw new IModelError(IModelStatus.BadRequest, \"Change cache must be detached before extraction\");\r\n\r\n    const iModelId = iModel.iModelId;\r\n    const changesetsFolder: string = BriefcaseManager.getChangeSetsPath(iModelId);\r\n    const changeset = await IModelHost.hubAccess.downloadChangeset({ accessToken, iModelId, changeset: { id: iModel.changeset.id }, targetDir: changesetsFolder });\r\n\r\n    if (!IModelJsFs.existsSync(changeset.pathname))\r\n      throw new IModelError(IModelStatus.FileNotFound, `Failed to download change set: ${changeset.pathname}`);\r\n\r\n    let changesFile: ECDb | undefined;\r\n    try {\r\n      changesFile = ChangeSummaryManager.openOrCreateChangesFile(iModel);\r\n      assert(changesFile.nativeDb !== undefined, \"Invalid changesFile - should've caused an exception\");\r\n\r\n      let changeSummaryId = ChangeSummaryManager.isSummaryAlreadyExtracted(changesFile, changesetId);\r\n      if (changeSummaryId !== undefined) {\r\n        Logger.logInfo(loggerCategory, `Change Summary for changeset already exists. It is not extracted again.`, () => ({ iModelId, changeSetId: changesetId }));\r\n        return changeSummaryId;\r\n      }\r\n\r\n      const stat = iModel.nativeDb.extractChangeSummary(changesFile.nativeDb, changeset.pathname);\r\n      if (stat.error && stat.error.status !== DbResult.BE_SQLITE_OK)\r\n        throw new IModelError(stat.error.status, stat.error.message);\r\n\r\n      assert(undefined !== stat.result);\r\n      changeSummaryId = stat.result;\r\n      ChangeSummaryManager.addExtendedInfos(changesFile, changeSummaryId, changesetId, changeset.parentId, changeset.description, changeset.pushDate, changeset.userCreated);\r\n\r\n      changesFile.saveChanges();\r\n      return changeSummaryId;\r\n    } finally {\r\n      if (changesFile !== undefined)\r\n        changesFile.dispose();\r\n      IModelJsFs.unlinkSync(changeset.pathname);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Creates change summaries for the specified iModel and a specified range of versions\r\n   * @note This may be an expensive operation - downloads the first version and starts applying the change sets, extracting summaries one by one\r\n   * @param args Arguments including the range of versions for which Change Summaries are to be created, and other necessary input for creation\r\n   */\r\n  public static async createChangeSummaries(args: CreateChangeSummaryArgs): Promise<Id64String[]> {\r\n    const accessToken = args.accessToken ?? await IModelHost.getAccessToken() ?? \"\";\r\n    const { iModelId, iTwinId, range } = args;\r\n    range.end = range.end ?? (await IModelHost.hubAccess.getChangesetFromVersion({ accessToken, iModelId, version: IModelVersion.latest() })).index;\r\n    if (range.first > range.end)\r\n      throw new IModelError(IModelStatus.BadArg, \"Invalid range of changesets\");\r\n    if (range.first === 0 && range.end === 0)\r\n      return []; // no changesets exist, so the inclusive range is empty\r\n\r\n    const changesets = await IModelHost.hubAccess.queryChangesets({ accessToken, iModelId, range });\r\n\r\n    // Setup a temporary briefcase to help with extracting change summaries\r\n    const briefcasePath = BriefcaseManager.getBriefcaseBasePath(iModelId);\r\n    const fileName: string = path.join(briefcasePath, `ChangeSummaryBriefcase.bim`);\r\n    if (IModelJsFs.existsSync(fileName))\r\n      IModelJsFs.removeSync(fileName);\r\n\r\n    let iModel: BriefcaseDb | undefined;\r\n    try {\r\n      // Download a version that has the first change set applied\r\n      const props = await BriefcaseManager.downloadBriefcase({ accessToken, iTwinId, iModelId, asOf: { afterChangeSetId: changesets[0].id }, briefcaseId: 0, fileName });\r\n      iModel = await BriefcaseDb.open({ fileName: props.fileName });\r\n\r\n      const summaryIds = new Array<Id64String>();\r\n      for (let index = 0; index < changesets.length; index++) {\r\n        // Apply a change set if necessary\r\n        if (index > 0)\r\n          await iModel.pullChanges({ accessToken, toIndex: changesets[index].index });\r\n\r\n        // Create a change summary for the last change set that was applied\r\n        const summaryId = await this.createChangeSummary(accessToken, iModel);\r\n        summaryIds.push(summaryId);\r\n      }\r\n      return summaryIds;\r\n    } finally {\r\n      if (iModel !== undefined)\r\n        iModel.close();\r\n      IModelJsFs.removeSync(fileName);\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/cjs/ChangedElementsManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"ChangedElementsManager.js","sourceRoot":"","sources":["../../src/ChangedElementsManager.ts"],"names":[],"mappings":";;;AAMA,yDAAsD;AACtD,2DAAwD;AACxD,6CAA0C;AAQ1C,qDAAqD;AACrD,gBAAgB;AAChB,MAAa,sBAAsB;IAI1B,MAAM,CAAC,0BAA0B,CAAC,QAAoB,IAAY,OAAO,mCAAgB,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAExI,8BAA8B;IACtB,MAAM,CAAC,oBAAoB,CAAC,QAAoB;QACtD,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,QAAQ;YAClD,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACxB,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE;YACpD,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;SACzB;QACD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,MAAM,IAAI,GAAG,sBAAsB,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC;YACzE,IAAI,CAAC,uBAAU,CAAC,UAAU,CAAC,IAAI,CAAC;gBAC9B,OAAO,SAAS,CAAC;YAEnB,MAAM,EAAE,GAAsB,qCAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC7D,IAAI,CAAC,MAAM,GAAG;gBACZ,QAAQ;gBACR,EAAE;aACH,CAAC;YAEF,OAAO,EAAE,CAAC;SACX;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,MAAM,CAAC,OAAO;QACnB,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;SACzB;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,kBAAkB,CAAC,QAAoB,EAAE,gBAAwB,EAAE,cAAsB;QACrG,MAAM,EAAE,GAAkC,sBAAsB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAChG,IAAI,CAAC,EAAE;YACL,OAAO,SAAS,CAAC;QAEnB,OAAO,EAAE,CAAC,kBAAkB,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,gBAAgB,CAAC,QAAoB,EAAE,gBAAwB,EAAE,cAAsB;QACnG,MAAM,EAAE,GAAkC,sBAAsB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAChG,IAAI,CAAC,EAAE;YACL,OAAO,SAAS,CAAC;QAEnB,OAAO,EAAE,CAAC,gBAAgB,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,QAAoB,EAAE,gBAAwB,EAAE,cAAsB;QAChG,MAAM,EAAE,GAAkC,sBAAsB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAChG,IAAI,CAAC,EAAE;YACL,OAAO,SAAS,CAAC;QAEnB,OAAO,EAAE,CAAC,aAAa,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,WAAW,CAAC,QAAoB,EAAE,WAAmB;QACjE,MAAM,EAAE,GAAkC,sBAAsB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAChG,IAAI,CAAC,EAAE;YACL,OAAO,KAAK,CAAC;QAEf,OAAO,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IACrC,CAAC;CACF;AA9FD,wDA8FC","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\nimport { GuidString } from \"@itwin/core-bentley\";\r\nimport { ChangeData, ChangedElements, ChangedModels } from \"@itwin/core-common\";\r\nimport { BriefcaseManager } from \"./BriefcaseManager\";\r\nimport { ChangedElementsDb } from \"./ChangedElementsDb\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\n\r\n/** @internal */\r\ninterface ChangedElementsDbCacheEntry {\r\n  iModelId: GuidString;\r\n  db: ChangedElementsDb;\r\n}\r\n\r\n/** Utilities for querying changed elements caches */\r\n/** @internal */\r\nexport class ChangedElementsManager {\r\n  /** Maintains a single entry since we will only have a cache per iModel, which means a ChangedElementsDb per backend instance */\r\n  private static _entry: ChangedElementsDbCacheEntry | undefined;\r\n\r\n  public static getChangedElementsPathName(iModelId: GuidString): string { return BriefcaseManager.getChangedElementsPathName(iModelId); }\r\n\r\n  /** Get changed elements Db */\r\n  private static getChangedElementsDb(iModelId: GuidString): ChangedElementsDb | undefined {\r\n    if (this._entry && this._entry.iModelId === iModelId)\r\n      return this._entry.db;\r\n    if (this._entry && this._entry.iModelId !== iModelId) {\r\n      this._entry.db.closeDb();\r\n      this._entry.db.cleanCaches();\r\n      this._entry = undefined;\r\n    }\r\n    if (!this._entry) {\r\n      const path = ChangedElementsManager.getChangedElementsPathName(iModelId);\r\n      if (!IModelJsFs.existsSync(path))\r\n        return undefined;\r\n\r\n      const db: ChangedElementsDb = ChangedElementsDb.openDb(path);\r\n      this._entry = {\r\n        iModelId,\r\n        db,\r\n      };\r\n\r\n      return db;\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  public static cleanUp() {\r\n    if (this._entry) {\r\n      this._entry.db.closeDb();\r\n      this._entry.db.cleanCaches();\r\n      this._entry = undefined;\r\n    }\r\n  }\r\n\r\n  /** Gets the changed elements from the cache if found\r\n   * @param iModelId Id of the iModel\r\n   * @param startChangesetId Start changeset Id\r\n   * @param endChangesetId End changeset Id\r\n   * @returns Changed elements if found\r\n   */\r\n  public static getChangedElements(iModelId: GuidString, startChangesetId: string, endChangesetId: string): ChangedElements | undefined {\r\n    const db: ChangedElementsDb | undefined = ChangedElementsManager.getChangedElementsDb(iModelId);\r\n    if (!db)\r\n      return undefined;\r\n\r\n    return db.getChangedElements(startChangesetId, endChangesetId);\r\n  }\r\n\r\n  /** Gets the changed models from the cache if found\r\n   * @param iModelId Id of the iModel\r\n   * @param startChangesetId Start changeset Id\r\n   * @param endChangesetId End changeset Id\r\n   * @returns Changed models if found\r\n   */\r\n  public static getChangedModels(iModelId: GuidString, startChangesetId: string, endChangesetId: string): ChangedModels | undefined {\r\n    const db: ChangedElementsDb | undefined = ChangedElementsManager.getChangedElementsDb(iModelId);\r\n    if (!db)\r\n      return undefined;\r\n\r\n    return db.getChangedModels(startChangesetId, endChangesetId);\r\n  }\r\n\r\n  /** Gets the change data (models and elements) from the cache if found\r\n   * @param iModelId Id of the iModel\r\n   * @param startChangesetId Start changeset Id\r\n   * @param endChangesetId End changeset Id\r\n   * @returns Changed models if found\r\n   */\r\n  public static getChangeData(iModelId: GuidString, startChangesetId: string, endChangesetId: string): ChangeData | undefined {\r\n    const db: ChangedElementsDb | undefined = ChangedElementsManager.getChangedElementsDb(iModelId);\r\n    if (!db)\r\n      return undefined;\r\n\r\n    return db.getChangeData(startChangesetId, endChangesetId);\r\n  }\r\n\r\n  /** Checks if the cache contains information about the changeset\r\n   * @param iModelId Id of the iModel\r\n   * @param changesetId Changeset to check for\r\n   * @returns true if the changeset has been processed and exists in the cache\r\n   */\r\n  public static isProcessed(iModelId: GuidString, changesetId: string): boolean {\r\n    const db: ChangedElementsDb | undefined = ChangedElementsManager.getChangedElementsDb(iModelId);\r\n    if (!db)\r\n      return false;\r\n\r\n    return db.isProcessed(changesetId);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ChangedElementsManager.js","sourceRoot":"","sources":["../../src/ChangedElementsManager.ts"],"names":[],"mappings":";;;AAMA,yDAAsD;AACtD,2DAAwD;AACxD,6CAA0C;AAQ1C,qDAAqD;AACrD,gBAAgB;AAChB,MAAa,sBAAsB;IAI1B,MAAM,CAAC,0BAA0B,CAAC,QAAoB,IAAY,OAAO,mCAAgB,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAExI,8BAA8B;IACtB,MAAM,CAAC,oBAAoB,CAAC,QAAoB;QACtD,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,QAAQ;YAClD,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACxB,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACrD,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QAC1B,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,IAAI,GAAG,sBAAsB,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC;YACzE,IAAI,CAAC,uBAAU,CAAC,UAAU,CAAC,IAAI,CAAC;gBAC9B,OAAO,SAAS,CAAC;YAEnB,MAAM,EAAE,GAAsB,qCAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC7D,IAAI,CAAC,MAAM,GAAG;gBACZ,QAAQ;gBACR,EAAE;aACH,CAAC;YAEF,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,MAAM,CAAC,OAAO;QACnB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QAC1B,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,kBAAkB,CAAC,QAAoB,EAAE,gBAAwB,EAAE,cAAsB;QACrG,MAAM,EAAE,GAAkC,sBAAsB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAChG,IAAI,CAAC,EAAE;YACL,OAAO,SAAS,CAAC;QAEnB,OAAO,EAAE,CAAC,kBAAkB,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,gBAAgB,CAAC,QAAoB,EAAE,gBAAwB,EAAE,cAAsB;QACnG,MAAM,EAAE,GAAkC,sBAAsB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAChG,IAAI,CAAC,EAAE;YACL,OAAO,SAAS,CAAC;QAEnB,OAAO,EAAE,CAAC,gBAAgB,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,QAAoB,EAAE,gBAAwB,EAAE,cAAsB;QAChG,MAAM,EAAE,GAAkC,sBAAsB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAChG,IAAI,CAAC,EAAE;YACL,OAAO,SAAS,CAAC;QAEnB,OAAO,EAAE,CAAC,aAAa,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,WAAW,CAAC,QAAoB,EAAE,WAAmB;QACjE,MAAM,EAAE,GAAkC,sBAAsB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAChG,IAAI,CAAC,EAAE;YACL,OAAO,KAAK,CAAC;QAEf,OAAO,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IACrC,CAAC;CACF;AA9FD,wDA8FC","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\nimport { GuidString } from \"@itwin/core-bentley\";\r\nimport { ChangeData, ChangedElements, ChangedModels } from \"@itwin/core-common\";\r\nimport { BriefcaseManager } from \"./BriefcaseManager\";\r\nimport { ChangedElementsDb } from \"./ChangedElementsDb\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\n\r\n/** @internal */\r\ninterface ChangedElementsDbCacheEntry {\r\n  iModelId: GuidString;\r\n  db: ChangedElementsDb;\r\n}\r\n\r\n/** Utilities for querying changed elements caches */\r\n/** @internal */\r\nexport class ChangedElementsManager {\r\n  /** Maintains a single entry since we will only have a cache per iModel, which means a ChangedElementsDb per backend instance */\r\n  private static _entry: ChangedElementsDbCacheEntry | undefined;\r\n\r\n  public static getChangedElementsPathName(iModelId: GuidString): string { return BriefcaseManager.getChangedElementsPathName(iModelId); }\r\n\r\n  /** Get changed elements Db */\r\n  private static getChangedElementsDb(iModelId: GuidString): ChangedElementsDb | undefined {\r\n    if (this._entry && this._entry.iModelId === iModelId)\r\n      return this._entry.db;\r\n    if (this._entry && this._entry.iModelId !== iModelId) {\r\n      this._entry.db.closeDb();\r\n      this._entry.db.cleanCaches();\r\n      this._entry = undefined;\r\n    }\r\n    if (!this._entry) {\r\n      const path = ChangedElementsManager.getChangedElementsPathName(iModelId);\r\n      if (!IModelJsFs.existsSync(path))\r\n        return undefined;\r\n\r\n      const db: ChangedElementsDb = ChangedElementsDb.openDb(path);\r\n      this._entry = {\r\n        iModelId,\r\n        db,\r\n      };\r\n\r\n      return db;\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  public static cleanUp() {\r\n    if (this._entry) {\r\n      this._entry.db.closeDb();\r\n      this._entry.db.cleanCaches();\r\n      this._entry = undefined;\r\n    }\r\n  }\r\n\r\n  /** Gets the changed elements from the cache if found\r\n   * @param iModelId Id of the iModel\r\n   * @param startChangesetId Start changeset Id\r\n   * @param endChangesetId End changeset Id\r\n   * @returns Changed elements if found\r\n   */\r\n  public static getChangedElements(iModelId: GuidString, startChangesetId: string, endChangesetId: string): ChangedElements | undefined {\r\n    const db: ChangedElementsDb | undefined = ChangedElementsManager.getChangedElementsDb(iModelId);\r\n    if (!db)\r\n      return undefined;\r\n\r\n    return db.getChangedElements(startChangesetId, endChangesetId);\r\n  }\r\n\r\n  /** Gets the changed models from the cache if found\r\n   * @param iModelId Id of the iModel\r\n   * @param startChangesetId Start changeset Id\r\n   * @param endChangesetId End changeset Id\r\n   * @returns Changed models if found\r\n   */\r\n  public static getChangedModels(iModelId: GuidString, startChangesetId: string, endChangesetId: string): ChangedModels | undefined {\r\n    const db: ChangedElementsDb | undefined = ChangedElementsManager.getChangedElementsDb(iModelId);\r\n    if (!db)\r\n      return undefined;\r\n\r\n    return db.getChangedModels(startChangesetId, endChangesetId);\r\n  }\r\n\r\n  /** Gets the change data (models and elements) from the cache if found\r\n   * @param iModelId Id of the iModel\r\n   * @param startChangesetId Start changeset Id\r\n   * @param endChangesetId End changeset Id\r\n   * @returns Changed models if found\r\n   */\r\n  public static getChangeData(iModelId: GuidString, startChangesetId: string, endChangesetId: string): ChangeData | undefined {\r\n    const db: ChangedElementsDb | undefined = ChangedElementsManager.getChangedElementsDb(iModelId);\r\n    if (!db)\r\n      return undefined;\r\n\r\n    return db.getChangeData(startChangesetId, endChangesetId);\r\n  }\r\n\r\n  /** Checks if the cache contains information about the changeset\r\n   * @param iModelId Id of the iModel\r\n   * @param changesetId Changeset to check for\r\n   * @returns true if the changeset has been processed and exists in the cache\r\n   */\r\n  public static isProcessed(iModelId: GuidString, changesetId: string): boolean {\r\n    const db: ChangedElementsDb | undefined = ChangedElementsManager.getChangedElementsDb(iModelId);\r\n    if (!db)\r\n      return false;\r\n\r\n    return db.isProcessed(changesetId);\r\n  }\r\n}\r\n"]}

package/lib/cjs/ChangesetECAdaptor.js

@@ -528,8 +528,8 @@ class ChangesetECAdaptor {
          * set debug flags
          */
         this.debugFlags = {
-            replaceBlobWithEllipsis: false,
-            replaceGeomWithEllipsis: false,
+            replaceBlobWithEllipsis: false, // replace bolb with ... for debugging
+            replaceGeomWithEllipsis: false, // replace geom with ... for debugging
             replaceGuidWithEllipsis: false, // replace geom with ... for debugging
         };
         if (!reader.db)