@itwin/core-backend 4.1.0-dev.6 → 4.1.0-dev.63

package/CHANGELOG.md

@@ -1,6 +1,79 @@
 # Change Log - @itwin/core-backend
 
-This log was last generated on Tue, 25 Apr 2023 17:50:35 GMT and should not be manually modified.
+This log was last generated on Mon, 03 Jul 2023 15:28:41 GMT and should not be manually modified.
+
+## 4.0.3
+Mon, 03 Jul 2023 15:28:41 GMT
+
+_Version update only_
+
+## 4.0.2
+Wed, 21 Jun 2023 22:04:43 GMT
+
+_Version update only_
+
+## 4.0.1
+Wed, 21 Jun 2023 20:29:13 GMT
+
+_Version update only_
+
+## 4.0.0
+Mon, 22 May 2023 15:34:14 GMT
+
+### Updates
+
+- use baseUri rather than accountName for cloud containers
+- added support for index of internal codes
+- added IModelHost.profileDir. No two process may use the same profile directory at the same time.
+- implemented constant lod texture mapping for tiles
+- Deprecate IModelDb's and ECDb's query, queryRowCount, and restartQuery methods.
+- Remove `ChangeSummaryManager.extractChangeSummaries`
+- added ChannelControl
+- Update to eslint@8
+- add flag schemaLockHeld
+- add public methods to BriefcaseManager to query the hub for changesets
+- Drop Node 12 and Node 14.
+- Drop Node 16 support.
+- Prevent IPC requests from blocking the backend.
+- cloudsqlite: add bcvhttplog and pragma bcv_client support
+- change backendhubaccess and related properties to @internal
+- Add SpatialViewState.fromJSON.
+- remove old entity-unaware implementation of getReferenceIds
+- rename members of @alpha CodeService interfaces
+- DrawingViewDefinition.fromJSON
+- Fix for timing issue in core tests
+- allow passing a custom schema read context to IModelDb.importSchemas
+- Added test to verify Id serialization to hex for system properties.
+
+## 3.7.9
+Tue, 20 Jun 2023 12:51:02 GMT
+
+_Version update only_
+
+## 3.7.8
+Thu, 01 Jun 2023 17:00:39 GMT
+
+### Updates
+
+- Prefetches triggered by attach now have configurable minRequests/maxRequests through ApplicationSettings
+
+## 3.7.7
+Wed, 24 May 2023 17:27:09 GMT
+
+_Version update only_
+
+## 3.7.6
+Mon, 15 May 2023 18:23:40 GMT
+
+### Updates
+
+- log metadata when uploading tiles
+- disable native sqlite logger category when calling 'updateToRequestedVersion'
+
+## 3.7.5
+Thu, 04 May 2023 19:43:18 GMT
+
+_Version update only_
 
 ## 3.7.4
 Tue, 25 Apr 2023 17:50:35 GMT

package/lib/cjs/BlobContainerService.d.ts

@@ -1,7 +1,8 @@
 /** @packageDocumentation
  * @module BlobContainers
  */
-import { AccessToken, Id64String } from "@itwin/core-bentley";
+import { AccessToken, GuidString, Id64String } from "@itwin/core-bentley";
+import { SettingObject } from "./workspace/Settings";
 /**
  * Types and functions for creating, deleting and authorizing access to cloud-based blob containers for an iTwin.
  * @beta
@@ -10,7 +11,7 @@ export declare namespace BlobContainer {
     /** Object that implements the methods to create, delete, and request access to a container. */
     let service: BlobContainer.ContainerService | undefined;
     /** name of cloud provider for a container. */
-    type Provider = "azure" | "google" | "aws";
+    type Provider = "azure" | "google";
     /** the name of the container within its `Scope` */
     type ContainerId = string;
     /** token that authenticates a user. This token is required to obtain a `ContainerToken`. */
@@ -31,25 +32,25 @@ export declare namespace BlobContainer {
         iTwinId: Id64String;
         /** optionally, an iModelId within the iTwin. If present, container is deleted when the iModel is deleted. */
         iModelId?: Id64String;
-        /** optionally, an owner of the container. Owners always have administrator rights for the container. */
-        owner?: string;
+        /** the user GUID an individual, if this container is private. */
+        ownerGuid?: GuidString;
     }
     /**
      * Metadata about the use of a container so that:
      *  - administrators can understand why a container exists for assigning RBAC permissions appropriately
      *  - usage reports can aggregate types of containers
      *  - applications can identify their containers
-     *  - applications can store important (to them) properties "on" their containers
+     *  - applications can store properties about their containers
      */
     interface Metadata {
-        /** Human readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */
-        description: string;
-        /** a machine-readable string that describes the "format" of the data in this container (e.g. "CloudSqlite") */
-        format: string;
-        /** an identifier of the application that uses this this container */
-        application: string;
-        /** Additional properties stored on the container */
-        [propertyName: string]: string;
+        /** The machine-readable string that describes what the container is being used for (e.g. "workspace"). Always lowercase and singular. */
+        containerType: string;
+        /** Human-readable name for the container. This will be displayed in the administrator RBAC panel, and on usage reports. Not required to be unique.*/
+        label: string;
+        /** Optional human-readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */
+        description?: string;
+        /** optional properties for the container */
+        json?: SettingObject;
     }
     /** Properties returned by `Service.requestToken` */
     interface TokenProps {
@@ -70,19 +71,26 @@ export declare namespace BlobContainer {
     /** The URI and Id of the container. */
     interface UriAndId {
         baseUri: string;
-        id: ContainerId;
+        containerId: ContainerId;
     }
     /** Information required to access an existing container. */
-    interface AccessContainerProps {
-        address: UriAndId;
+    interface AccessContainerProps extends UriAndId {
         userToken: UserToken;
     }
+    /**
+     * Access level to request for token.
+     * - `"write"`: request a writeable AccessToken.
+     * - `"read"`:  request a read-only AccessToken.
+     * - `"admin"`:  request a admin AccessToken.
+     * - `"writeIfPossible"`: first request a writeable AccessToken. If the user is not authorized for write, request a read-only AccessToken.
+     * If the user is not authorized for the level requested, an exception is thrown.
+     */
+    type RequestAccessLevel = "write" | "read" | "admin" | "writeIfPossible";
     /** Information required to request an access token for a container. */
     interface RequestTokenProps extends AccessContainerProps {
-        /** If true, token should provide write access.
-         * @note if write access is requested and the user is authorized for read but not write, an exception will be thrown (i.e. a read token is *not* returned).
-         */
-        forWriteAccess?: boolean;
+        storageType: Provider;
+        /** the level of access requested. If not specified, defaults to `"writeIfPossible"`. */
+        accessLevel?: RequestAccessLevel;
         /** the number of seconds before the token should expire.
          * @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.
          */
@@ -100,22 +108,24 @@ export declare namespace BlobContainer {
          * the id for the container. Useful for tests.
          * @internal
          */
-        id?: ContainerId;
+        containerId?: ContainerId;
     }
     /** Methods to create, delete, and access blob containers. */
     interface ContainerService {
-        /**
-         * Create a new blob container. Throws on failure (e.g. access denied or container already exists.)
-         */
+        /**  Create a new blob container. Throws on failure (e.g. access denied or container already exists.) */
         create(props: CreateNewContainerProps): Promise<UriAndId>;
         /**
          * Delete an existing blob container.
          * @note This method requires that the user be authorized with "delete container" RBAC role for the iTwin.
          */
-        delete(props: AccessContainerProps): Promise<void>;
-        /**
-         * Request a `ContainerToken` for a container. Throws on failure.
-         */
+        delete(container: AccessContainerProps): Promise<void>;
+        /** query the Scope for a container */
+        queryScope(container: AccessContainerProps): Promise<Scope>;
+        /** query the Metadata for a container */
+        queryMetadata(container: AccessContainerProps): Promise<Metadata>;
+        /** update the json properties of this container */
+        updateJson(container: AccessContainerProps, json: SettingObject): Promise<void>;
+        /** Request a `ContainerToken` for a container. Throws on failure. */
         requestToken(props: RequestTokenProps): Promise<TokenProps>;
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"BlobContainerService.d.ts","sourceRoot":"","sources":["../../src/BlobContainerService.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE9D;;;GAGG;AACH,yBAAiB,aAAa,CAAC;IAE7B,+FAA+F;IACxF,IAAI,OAAO,EAAE,aAAa,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAE/D,8CAA8C;IAC9C,KAAY,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAC;IAElD,mDAAmD;IACnD,KAAY,WAAW,GAAG,MAAM,CAAC;IAEjC,4FAA4F;IAC5F,KAAY,SAAS,GAAG,WAAW,CAAC;IAEpC,+EAA+E;IAC/E,KAAY,cAAc,GAAG,WAAW,CAAC;IAEzC;;;;;;;;OAQG;IACH,UAAiB,KAAK;QACpB,8CAA8C;QAC9C,OAAO,EAAE,UAAU,CAAC;QACpB,6GAA6G;QAC7G,QAAQ,CAAC,EAAE,UAAU,CAAC;QACtB,wGAAwG;QACxG,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;;;;;OAMG;IACH,UAAiB,QAAQ;QACvB,yJAAyJ;QACzJ,WAAW,EAAE,MAAM,CAAC;QACpB,+GAA+G;QAC/G,MAAM,EAAE,MAAM,CAAC;QACf,qEAAqE;QACrE,WAAW,EAAE,MAAM,CAAC;QACpB,oDAAoD;QACpD,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;KAChC;IAED,oDAAoD;IACpD,UAAiB,UAAU;QACzB;;;WAGG;QACH,KAAK,EAAE,cAAc,CAAC;QACtB,8BAA8B;QAC9B,KAAK,EAAE,KAAK,CAAC;QACb,yCAAyC;QACzC,QAAQ,EAAE,QAAQ,CAAC;QACnB,sIAAsI;QACtI,UAAU,EAAE,IAAI,CAAC;QACjB,iCAAiC;QACjC,QAAQ,EAAE,QAAQ,CAAC;KACpB;IAED,uCAAuC;IACvC,UAAiB,QAAQ;QACvB,OAAO,EAAE,MAAM,CAAC;QAChB,EAAE,EAAE,WAAW,CAAC;KACjB;IAED,4DAA4D;IAC5D,UAAiB,oBAAoB;QACnC,OAAO,EAAE,QAAQ,CAAC;QAClB,SAAS,EAAE,SAAS,CAAC;KACtB;IAED,uEAAuE;IACvE,UAAiB,iBAAkB,SAAQ,oBAAoB;QAC7D;;WAEG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED,sDAAsD;IACtD,UAAiB,uBAAuB;QACtC,qCAAqC;QACrC,KAAK,EAAE,KAAK,CAAC;QACb,iDAAiD;QACjD,QAAQ,EAAE,QAAQ,CAAC;QACnB,4GAA4G;QAC5G,SAAS,EAAE,SAAS,CAAC;QACrB;;;WAGG;QACH,EAAE,CAAC,EAAE,WAAW,CAAC;KAClB;IAED,6DAA6D;IAC7D,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,MAAM,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QAE1D;;;WAGG;QACH,MAAM,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEnD;;WAEG;QACH,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;KAC7D;CACF"}
+{"version":3,"file":"BlobContainerService.d.ts","sourceRoot":"","sources":["../../src/BlobContainerService.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC1E,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD;;;GAGG;AACH,yBAAiB,aAAa,CAAC;IAE7B,+FAA+F;IACxF,IAAI,OAAO,EAAE,aAAa,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAE/D,8CAA8C;IAC9C,KAAY,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;IAE1C,mDAAmD;IACnD,KAAY,WAAW,GAAG,MAAM,CAAC;IAEjC,4FAA4F;IAC5F,KAAY,SAAS,GAAG,WAAW,CAAC;IAEpC,+EAA+E;IAC/E,KAAY,cAAc,GAAG,WAAW,CAAC;IAEzC;;;;;;;;OAQG;IACH,UAAiB,KAAK;QACpB,8CAA8C;QAC9C,OAAO,EAAE,UAAU,CAAC;QACpB,6GAA6G;QAC7G,QAAQ,CAAC,EAAE,UAAU,CAAC;QACtB,iEAAiE;QACjE,SAAS,CAAC,EAAE,UAAU,CAAC;KACxB;IAED;;;;;;OAMG;IACH,UAAiB,QAAQ;QACvB,yIAAyI;QACzI,aAAa,EAAE,MAAM,CAAC;QACtB,qJAAqJ;QACrJ,KAAK,EAAE,MAAM,CAAC;QACd,kKAAkK;QAClK,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,4CAA4C;QAC5C,IAAI,CAAC,EAAE,aAAa,CAAC;KACtB;IAED,oDAAoD;IACpD,UAAiB,UAAU;QACzB;;;WAGG;QACH,KAAK,EAAE,cAAc,CAAC;QACtB,8BAA8B;QAC9B,KAAK,EAAE,KAAK,CAAC;QACb,yCAAyC;QACzC,QAAQ,EAAE,QAAQ,CAAC;QACnB,sIAAsI;QACtI,UAAU,EAAE,IAAI,CAAC;QACjB,iCAAiC;QACjC,QAAQ,EAAE,QAAQ,CAAC;KACpB;IAED,uCAAuC;IACvC,UAAiB,QAAQ;QACvB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,WAAW,CAAC;KAC1B;IAED,4DAA4D;IAC5D,UAAiB,oBAAqB,SAAQ,QAAQ;QACpD,SAAS,EAAE,SAAS,CAAC;KACtB;IAED;;;;;;;OAOG;IACH,KAAY,kBAAkB,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,iBAAiB,CAAC;IAEhF,uEAAuE;IACvE,UAAiB,iBAAkB,SAAQ,oBAAoB;QAC7D,WAAW,EAAE,QAAQ,CAAC;QACtB,wFAAwF;QACxF,WAAW,CAAC,EAAE,kBAAkB,CAAC;QACjC;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED,sDAAsD;IACtD,UAAiB,uBAAuB;QACtC,qCAAqC;QACrC,KAAK,EAAE,KAAK,CAAC;QACb,iDAAiD;QACjD,QAAQ,EAAE,QAAQ,CAAC;QACnB,4GAA4G;QAC5G,SAAS,EAAE,SAAS,CAAC;QACrB;;;WAGG;QACH,WAAW,CAAC,EAAE,WAAW,CAAC;KAC3B;IAED,6DAA6D;IAC7D,UAAiB,gBAAgB;QAC/B,wGAAwG;QACxG,MAAM,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QAE1D;;;WAGG;QACH,MAAM,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEvD,sCAAsC;QACtC,UAAU,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAE5D,yCAAyC;QACzC,aAAa,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QAElE,mDAAmD;QACnD,UAAU,CAAC,SAAS,EAAE,oBAAoB,EAAE,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEhF,qEAAqE;QACrE,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;KAC7D;CACF"}

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;;;AAMH;;;GAGG;AACH,IAAiB,aAAa,CA+H7B;AA/HD,WAAiB,aAAa;AA+H9B,CAAC,EA/HgB,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA+H7B","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, Id64String } from \"@itwin/core-bentley\";\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\" | \"aws\";\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    /** optionally, an owner of the container. Owners always have administrator rights for the container. */\r\n    owner?: string;\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 important (to them) properties \"on\" their containers\r\n   */\r\n  export interface Metadata {\r\n    /** 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    /** a machine-readable string that describes the \"format\" of the data in this container (e.g. \"CloudSqlite\") */\r\n    format: string;\r\n    /** an identifier of the application that uses this this container */\r\n    application: string;\r\n    /** Additional properties stored on the container */\r\n    [propertyName: string]: string;\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    id: ContainerId;\r\n  }\r\n\r\n  /** Information required to access an existing container. */\r\n  export interface AccessContainerProps {\r\n    address: UriAndId;\r\n    userToken: UserToken;\r\n  }\r\n\r\n  /** Information required to request an access token for a container. */\r\n  export interface RequestTokenProps extends AccessContainerProps {\r\n    /** If true, token should provide write access.\r\n     * @note if write access is requested and the user is authorized for read but not write, an exception will be thrown (i.e. a read token is *not* returned).\r\n     */\r\n    forWriteAccess?: boolean;\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    id?: ContainerId;\r\n  }\r\n\r\n  /** Methods to create, delete, and access blob containers. */\r\n  export interface ContainerService {\r\n    /**\r\n     * Create a new blob container. Throws on failure (e.g. access denied or container already exists.)\r\n     */\r\n    create(props: CreateNewContainerProps): Promise<UriAndId>;\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(props: AccessContainerProps): Promise<void>;\r\n\r\n    /**\r\n     * Request a `ContainerToken` for a container. Throws on failure.\r\n     */\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,CA4I7B;AA5ID,WAAiB,aAAa;AA4I9B,CAAC,EA5IgB,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA4I7B","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  /**\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    storageType: Provider;\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<UriAndId>;\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.d.ts

@@ -2,8 +2,8 @@
  * @module iModels
  */
 import { AccessToken, BeDuration, GuidString } from "@itwin/core-bentley";
-import { BriefcaseId, BriefcaseProps, ChangesetIndex, ChangesetIndexOrId, ChangesetProps, ChangesetRange, LocalBriefcaseProps, LocalDirName, LocalFileName, RequestNewBriefcaseProps, RpcActivity } from "@itwin/core-common";
-import { AcquireNewBriefcaseIdArg } from "./BackendHubAccess";
+import { BriefcaseId, BriefcaseProps, ChangesetIndex, ChangesetIndexOrId, ChangesetProps, ChangesetRange, LocalBriefcaseProps, LocalDirName, LocalFileName, RequestNewBriefcaseProps } from "@itwin/core-common";
+import { AcquireNewBriefcaseIdArg, IModelNameArg } from "./BackendHubAccess";
 import { ProgressFunction } from "./CheckpointManager";
 import { BriefcaseDb, IModelDb, TokenArg } from "./IModelDb";
 /** The argument for [[BriefcaseManager.downloadBriefcase]]
@@ -63,7 +63,7 @@ export declare class BriefcaseManager {
     /** @internal */
     static getChangedElementsPathName(iModelId: GuidString): LocalFileName;
     private static _briefcaseSubDir;
-    /** @internal */
+    /** Get the local path of the folder storing briefcases associated with the specified iModel. */
     static getBriefcaseBasePath(iModelId: GuidString): LocalDirName;
     /** Get the name of the local file that holds, or will hold, a local briefcase in the briefcase cache.
      * @note The briefcase cache is a local directory established in the call to [[BriefcaseManager.initialize]].
@@ -165,6 +165,11 @@ export declare class BriefcaseManager {
     static getLatestChangeset(arg: {
         iModelId: GuidString;
     }): Promise<ChangesetProps>;
+    /** Query the Id of an iModel by name.
+     * @param arg Identifies the iModel of interest
+     * @returns the Id of the corresponding iModel, or `undefined` if no such iModel exists.
+     */
+    static queryIModelByName(arg: IModelNameArg): Promise<GuidString | undefined>;
     /** Deletes a folder and all it's contents.
      *  - Does not throw any errors, but logs them.
      *  - returns true if the delete was successful.
@@ -179,7 +184,5 @@ export declare class BriefcaseManager {
      * @internal
      */
     static pullMergePush(db: BriefcaseDb, arg: PushChangesArgs): Promise<void>;
-    /** @internal */
-    static logUsage(imodel: IModelDb, activity?: RpcActivity): void;
 }
 //# sourceMappingURL=BriefcaseManager.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"BriefcaseManager.d.ts","sourceRoot":"","sources":["../../src/BriefcaseManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EACL,WAAW,EAAE,UAAU,EAAmB,UAAU,EACrD,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,WAAW,EAAoB,cAAc,EAAsB,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,cAAc,EAA6C,mBAAmB,EACrM,YAAY,EAAE,aAAa,EAAE,wBAAwB,EAAE,WAAW,EACnE,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAE9D,OAAO,EAAsC,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAM7D;;EAEE;AACF,MAAM,WAAW,sBAAuB,SAAQ,QAAQ,EAAE,wBAAwB;IAChF;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,8EAA8E;IAC9E,WAAW,EAAE,MAAM,CAAC;IACpB,8IAA8I;IAC9I,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,oGAAoG;IACpG,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,4EAA4E;IAC5E,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,8FAA8F;IAC9F,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uFAAuF;IACvF,cAAc,CAAC,EAAE,UAAU,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,oFAAoF;IACpF,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG;IAC9C;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,wFAAwF;WAC1E,aAAa,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAE/D,gBAAgB;WACF,iBAAiB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAEnE,gBAAgB;WACF,sBAAsB,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAEzE,gBAAgB;WACF,0BAA0B,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAE7E,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAgB;IAC/C,gBAAgB;WACF,oBAAoB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAItE;;;;OAIG;WACW,WAAW,CAAC,SAAS,EAAE,cAAc,GAAG,aAAa;IAInE,OAAO,CAAC,MAAM,CAAC,aAAa;IAK5B,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAU;IACtC;;;;OAIG;WACW,UAAU,CAAC,YAAY,EAAE,YAAY;IAQnD,OAAO,CAAC,MAAM,CAAC,QAAQ;IAIvB;;;;OAIG;WACW,mBAAmB,CAAC,QAAQ,CAAC,EAAE,UAAU,GAAG,mBAAmB,EAAE;IA+B/E,OAAO,CAAC,MAAM,CAAC,SAAS,CAAe;IACvC,qDAAqD;IACrD,WAAkB,QAAQ,IAAI,YAAY,CAA2B;IAErE;;OAEG;WACW,kBAAkB,CAAC,EAAE,EAAE,WAAW;IAIhD;;;OAGG;WACiB,qBAAqB,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC;IAI9F;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,iBAAiB,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAiDhG;;OAEG;WACW,6BAA6B,CAAC,QAAQ,EAAE,MAAM;IAK5D;;;OAGG;WACiB,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxG;;;;;;OAMG;WACiB,oBAAoB,CAAC,QAAQ,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAsC3G;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU;IAUzB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAclC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAenC,4EAA4E;WACxD,cAAc,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAC;QAAC,SAAS,EAAE,kBAAkB,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAIzH,gFAAgF;WAC5D,eAAe,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAC;QAAC,KAAK,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAIpH,wEAAwE;WACpD,kBAAkB,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAI9F;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;mBAajB,oBAAoB;IAWzC,gBAAgB;WACI,sBAAsB,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAgC7F,4EAA4E;mBACvD,WAAW;IA4ChC;;OAEG;WACiB,aAAa,CAAC,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAcvF,gBAAgB;WACF,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,WAAW;CAmBhE"}
+{"version":3,"file":"BriefcaseManager.d.ts","sourceRoot":"","sources":["../../src/BriefcaseManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EACL,WAAW,EAAE,UAAU,EAAmB,UAAU,EACrD,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,WAAW,EAAoB,cAAc,EAAsB,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,cAAc,EAA6C,mBAAmB,EACrM,YAAY,EAAE,aAAa,EAAE,wBAAwB,EACtD,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,wBAAwB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAE7E,OAAO,EAAsC,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAM7D;;EAEE;AACF,MAAM,WAAW,sBAAuB,SAAQ,QAAQ,EAAE,wBAAwB;IAChF;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,8EAA8E;IAC9E,WAAW,EAAE,MAAM,CAAC;IACpB,8IAA8I;IAC9I,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,oGAAoG;IACpG,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,4EAA4E;IAC5E,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,8FAA8F;IAC9F,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uFAAuF;IACvF,cAAc,CAAC,EAAE,UAAU,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,oFAAoF;IACpF,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG;IAC9C;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,wFAAwF;WAC1E,aAAa,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAE/D,gBAAgB;WACF,iBAAiB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAEnE,gBAAgB;WACF,sBAAsB,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAEzE,gBAAgB;WACF,0BAA0B,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAE7E,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAgB;IAC/C,gGAAgG;WAClF,oBAAoB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAItE;;;;OAIG;WACW,WAAW,CAAC,SAAS,EAAE,cAAc,GAAG,aAAa;IAInE,OAAO,CAAC,MAAM,CAAC,aAAa;IAK5B,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAU;IACtC;;;;OAIG;WACW,UAAU,CAAC,YAAY,EAAE,YAAY;IAQnD,OAAO,CAAC,MAAM,CAAC,QAAQ;IAIvB;;;;OAIG;WACW,mBAAmB,CAAC,QAAQ,CAAC,EAAE,UAAU,GAAG,mBAAmB,EAAE;IA+B/E,OAAO,CAAC,MAAM,CAAC,SAAS,CAAe;IACvC,qDAAqD;IACrD,WAAkB,QAAQ,IAAI,YAAY,CAA2B;IAErE;;OAEG;WACW,kBAAkB,CAAC,EAAE,EAAE,WAAW;IAIhD;;;OAGG;WACiB,qBAAqB,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC;IAI9F;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,iBAAiB,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAiDhG;;OAEG;WACW,6BAA6B,CAAC,QAAQ,EAAE,MAAM;IAK5D;;;OAGG;WACiB,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxG;;;;;;OAMG;WACiB,oBAAoB,CAAC,QAAQ,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAsC3G;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU;IAUzB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAclC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAenC,4EAA4E;WACxD,cAAc,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAC;QAAC,SAAS,EAAE,kBAAkB,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAIzH,gFAAgF;WAC5D,eAAe,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAC;QAAC,KAAK,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAIpH,wEAAwE;WACpD,kBAAkB,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAI9F;;;OAGG;WACiB,iBAAiB,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAI1F;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;mBAajB,oBAAoB;IAWzC,gBAAgB;WACI,sBAAsB,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAgC7F,4EAA4E;mBACvD,WAAW;IA4ChC;;OAEG;WACiB,aAAa,CAAC,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;CAcxF"}

package/lib/cjs/BriefcaseManager.js

@@ -12,7 +12,6 @@ exports.BriefcaseManager = void 0;
 const path = require("path");
 const core_bentley_1 = require("@itwin/core-bentley");
 const core_common_1 = require("@itwin/core-common");
-const core_telemetry_1 = require("@itwin/core-telemetry");
 const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
 const CheckpointManager_1 = require("./CheckpointManager");
 const IModelDb_1 = require("./IModelDb");
@@ -31,7 +30,7 @@ class BriefcaseManager {
     static getChangeCachePathName(iModelId) { return path.join(this.getIModelPath(iModelId), iModelId.concat(".bim.ecchanges")); }
     /** @internal */
     static getChangedElementsPathName(iModelId) { return path.join(this.getIModelPath(iModelId), iModelId.concat(".bim.elems")); }
-    /** @internal */
+    /** Get the local path of the folder storing briefcases associated with the specified iModel. */
     static getBriefcaseBasePath(iModelId) {
         return path.join(this.getIModelPath(iModelId), this._briefcaseSubDir);
     }
@@ -297,6 +296,13 @@ class BriefcaseManager {
     static async getLatestChangeset(arg) {
         return IModelHost_1.IModelHost.hubAccess.getLatestChangeset({ ...arg, accessToken: await IModelHost_1.IModelHost.getAccessToken() });
     }
+    /** Query the Id of an iModel by name.
+     * @param arg Identifies the iModel of interest
+     * @returns the Id of the corresponding iModel, or `undefined` if no such iModel exists.
+     */
+    static async queryIModelByName(arg) {
+        return IModelHost_1.IModelHost.hubAccess.queryIModelByName(arg);
+    }
     /** Deletes a folder and all it's contents.
      *  - Does not throw any errors, but logs them.
      *  - returns true if the delete was successful.
@@ -403,19 +409,6 @@ class BriefcaseManager {
             }
         }
     }
-    /** @internal */
-    static logUsage(imodel, activity) {
-        const telemetryEvent = new core_telemetry_1.TelemetryEvent("core-backend - Open iModel", "7a6424d1-2114-4e89-b13b-43670a38ccd4", // Feature: "iModel Use"
-        imodel.iTwinId, imodel.iModelId, imodel.changeset?.id);
-        activity = activity ?? {
-            activityId: "",
-            applicationId: IModelHost_1.IModelHost.applicationId,
-            applicationVersion: IModelHost_1.IModelHost.applicationVersion,
-            sessionId: IModelHost_1.IModelHost.sessionId,
-            accessToken: "", // IModelHost.getAccessToken(); ACCESS_TOKEN_NEEDS_WORK
-        };
-        IModelHost_1.IModelHost.telemetry.postTelemetry(activity, telemetryEvent); // eslint-disable-line @typescript-eslint/no-floating-promises
-    }
 }
 BriefcaseManager._briefcaseSubDir = "briefcases";
 exports.BriefcaseManager = BriefcaseManager;

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;AAC5B,0DAAuD;AAEvD,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,gBAAgB;IACT,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,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACzD,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,WAAW,EAAE,CAAC;qBAClB;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,WAAW,EAAE,CAAC;SACxB;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,WAAW,EAAE,CAAC;YAEjB,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;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;YAChC,MAAM,IAAI,CAAC,oBAAoB,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;QAEjD,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;IAED,gBAAgB;IACT,MAAM,CAAC,QAAQ,CAAC,MAAgB,EAAE,QAAsB;QAE7D,MAAM,cAAc,GAAG,IAAI,+BAAc,CACvC,4BAA4B,EAC5B,sCAAsC,EAAE,wBAAwB;QAChE,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,SAAS,EAAE,EAAE,CACrB,CAAC;QACF,QAAQ,GAAG,QAAQ,IAAI;YACrB,UAAU,EAAE,EAAE;YACd,aAAa,EAAE,uBAAU,CAAC,aAAa;YACvC,kBAAkB,EAAE,uBAAU,CAAC,kBAAkB;YACjD,SAAS,EAAE,uBAAU,CAAC,SAAS;YAC/B,WAAW,EAAE,EAAE,EAAE,uDAAuD;SACzE,CAAC;QAEF,uBAAU,CAAC,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,8DAA8D;IAC9H,CAAC;;AAhbc,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,\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, RpcActivity,\r\n} from \"@itwin/core-common\";\r\nimport { TelemetryEvent } from \"@itwin/core-telemetry\";\r\nimport { AcquireNewBriefcaseIdArg } 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  /** @internal */\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, this);\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.closeIModel();\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.closeIModel();\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.closeIModel();\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  /** 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      await this.applySingleChangeset(db, changeset);\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  /** @internal */\r\n  public static logUsage(imodel: IModelDb, activity?: RpcActivity) { // eslint-disable-line deprecation/deprecation\r\n\r\n    const telemetryEvent = new TelemetryEvent(\r\n      \"core-backend - Open iModel\",\r\n      \"7a6424d1-2114-4e89-b13b-43670a38ccd4\", // Feature: \"iModel Use\"\r\n      imodel.iTwinId,\r\n      imodel.iModelId,\r\n      imodel.changeset?.id,\r\n    );\r\n    activity = activity ?? {\r\n      activityId: \"\",\r\n      applicationId: IModelHost.applicationId,\r\n      applicationVersion: IModelHost.applicationVersion,\r\n      sessionId: IModelHost.sessionId,\r\n      accessToken: \"\", // IModelHost.getAccessToken(); ACCESS_TOKEN_NEEDS_WORK\r\n    };\r\n\r\n    IModelHost.telemetry.postTelemetry(activity, telemetryEvent); // eslint-disable-line @typescript-eslint/no-floating-promises\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,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACzD,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,WAAW,EAAE,CAAC;qBAClB;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,WAAW,EAAE,CAAC;SACxB;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,WAAW,EAAE,CAAC;YAEjB,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;YAChC,MAAM,IAAI,CAAC,oBAAoB,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;QAEjD,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;;AAnac,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,\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, this);\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.closeIModel();\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.closeIModel();\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.closeIModel();\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      await this.applySingleChangeset(db, changeset);\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/Category.d.ts

@@ -15,8 +15,7 @@ export declare class SubCategory extends DefinitionElement {
     appearance: SubCategoryAppearance;
     /** Optional description of this SubCategory. */
     description?: string;
-    /** @internal */
-    constructor(props: SubCategoryProps, iModel: IModelDb);
+    protected constructor(props: SubCategoryProps, iModel: IModelDb);
     /** @internal */
     toJSON(): SubCategoryProps;
     /** Get the SubCategory's name (its Code value). */
@@ -60,8 +59,7 @@ export declare class Category extends DefinitionElement {
     static get className(): string;
     rank: Rank;
     description?: string;
-    /** @internal */
-    constructor(props: CategoryProps, iModel: IModelDb);
+    protected constructor(props: CategoryProps, iModel: IModelDb);
     /** @internal */
     toJSON(): CategoryProps;
     /** Get the Id of the default SubCategory for this Category. */
@@ -75,12 +73,7 @@ export declare class Category extends DefinitionElement {
 export declare class DrawingCategory extends Category {
     /** @internal */
     static get className(): string;
-    /** Construct a DrawingCategory
-     * @param opts  The properties of the new DrawingCategory
-     * @param iModel The IModelDb where the DrawingCategory may be inserted.
-     * @internal
-     */
-    constructor(opts: ElementProps, iModel: IModelDb);
+    protected constructor(opts: ElementProps, iModel: IModelDb);
     /** Get the name of the CodeSpec that is used by DrawingCategory objects. */
     static getCodeSpecName(): string;
     /** Looks up the CategoryId of a DrawingCategory by model and name */
@@ -116,12 +109,7 @@ export declare class DrawingCategory extends Category {
 export declare class SpatialCategory extends Category {
     /** @internal */
     static get className(): string;
-    /** Construct a SpatialCategory
-     * @param opts  The properties of the new SpatialCategory
-     * @param iModel The IModelDb where the SpatialCategory may be inserted.
-     * @internal
-     */
-    constructor(opts: ElementProps, iModel: IModelDb);
+    protected constructor(opts: ElementProps, iModel: IModelDb);
     /** Get the name of the CodeSpec that is used by SpatialCategory objects. */
     static getCodeSpecName(): string;
     /** Looks up the CategoryId of a SpatialCategory by model and name */

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

@@ -1 +1 @@
-{"version":3,"file":"Category.d.ts","sourceRoot":"","sources":["../../src/Category.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAa,MAAM,qBAAqB,CAAC;AAClE,OAAO,EACQ,aAAa,EAAE,IAAI,EAAE,cAAc,EAAY,YAAY,EAAE,IAAI,EAAE,qBAAqB,EAAE,gBAAgB,EACxH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC;;GAEG;AACH,qBAAa,WAAY,SAAQ,iBAAiB;IAChD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA0B;IACxE,qDAAqD;IAC9C,UAAU,EAAE,qBAAqB,CAAC;IACzC,gDAAgD;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE5B,gBAAgB;gBACG,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ;IAM5D,gBAAgB;IACA,MAAM,IAAI,gBAAgB;IAQ1C,mDAAmD;IAC5C,kBAAkB,IAAI,MAAM;IACnC,qCAAqC;IAC9B,gBAAgB,IAAI,UAAU;IACrC,wDAAwD;IACjD,aAAa,IAAI,UAAU;IAClC,uEAAuE;IACvE,IAAW,oBAAoB,IAAI,OAAO,CAA+F;IAEzI;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKrG;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,WAAW;IAelK;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,UAAU;CAIlK;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,iBAAiB;IAC7C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAuB;IAC9D,IAAI,EAAE,IAAI,CAAa;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IAE5B,gBAAgB;gBACG,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ;IAMzD,gBAAgB;IACA,MAAM,IAAI,aAAa;IAQvC,+DAA+D;IACxD,sBAAsB,IAAI,UAAU;IAE3C,sEAAsE;IAC/D,oBAAoB,CAAC,KAAK,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,IAAI;CAQ9F;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;IAC3C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAE5E;;;;OAIG;gBACgB,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ;IAEvD,4EAA4E;WAC9D,eAAe,IAAI,MAAM;IAEvC,qEAAqE;WACvD,qBAAqB,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAK7H;;;;;OAKG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,eAAe;IAUtG;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,UAAU;CAO1K;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;IAC3C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAC5E;;;;OAIG;gBACgB,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ;IAEvD,4EAA4E;WAC9D,eAAe,IAAI,MAAM;IAEvC,qEAAqE;WACvD,qBAAqB,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAK7H;;;;;OAKG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,eAAe;IAUtG;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,UAAU;CAM1K"}
+{"version":3,"file":"Category.d.ts","sourceRoot":"","sources":["../../src/Category.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAa,MAAM,qBAAqB,CAAC;AAClE,OAAO,EACQ,aAAa,EAAE,IAAI,EAAE,cAAc,EAAY,YAAY,EAAE,IAAI,EAAE,qBAAqB,EAAE,gBAAgB,EACxH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC;;GAEG;AACH,qBAAa,WAAY,SAAQ,iBAAiB;IAChD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA0B;IACxE,qDAAqD;IAC9C,UAAU,EAAE,qBAAqB,CAAC;IACzC,gDAAgD;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE5B,SAAS,aAAa,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ;IAM/D,gBAAgB;IACA,MAAM,IAAI,gBAAgB;IAQ1C,mDAAmD;IAC5C,kBAAkB,IAAI,MAAM;IACnC,qCAAqC;IAC9B,gBAAgB,IAAI,UAAU;IACrC,wDAAwD;IACjD,aAAa,IAAI,UAAU;IAClC,uEAAuE;IACvE,IAAW,oBAAoB,IAAI,OAAO,CAA+F;IAEzI;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKrG;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,WAAW;IAelK;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,UAAU;CAIlK;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,iBAAiB;IAC7C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAuB;IAC9D,IAAI,EAAE,IAAI,CAAa;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IAE5B,SAAS,aAAa,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ;IAM5D,gBAAgB;IACA,MAAM,IAAI,aAAa;IAQvC,+DAA+D;IACxD,sBAAsB,IAAI,UAAU;IAE3C,sEAAsE;IAC/D,oBAAoB,CAAC,KAAK,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,IAAI;CAQ9F;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;IAC3C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAE5E,SAAS,aAAa,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ;IAE1D,4EAA4E;WAC9D,eAAe,IAAI,MAAM;IAEvC,qEAAqE;WACvD,qBAAqB,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAK7H;;;;;OAKG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,eAAe;IAUtG;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,UAAU;CAO1K;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;IAC3C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAC5E,SAAS,aAAa,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ;IAE1D,4EAA4E;WAC9D,eAAe,IAAI,MAAM;IAEvC,qEAAqE;WACvD,qBAAqB,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAK7H;;;;;OAKG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,eAAe;IAUtG;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,UAAU;CAM1K"}