@itwin/core-backend 3.0.0-dev.100

package/LICENSE.md

@@ -0,0 +1,9 @@
+# MIT License
+
+Copyright © 2017-2021 Bentley Systems, Incorporated. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,11 @@
+# @itwin/core-backend
+
+Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.
+
+## Description
+
+The __@itwin/core-backend__ package contains classes that backend code can use to work with directly with iModels.
+
+## Documentation
+
+See the [iTwin.js](https://www.itwinjs.org) documentation for more information.

package/lib/cjs/AliCloudStorageService.d.ts

@@ -0,0 +1,12 @@
+import { CloudStorageContainerDescriptor, CloudStorageContainerUrl, CloudStorageProvider } from "@itwin/core-common";
+import { CloudStorageService, CloudStorageServiceCredentials, CloudStorageUploadOptions } from "./CloudStorageBackend";
+/** @beta */
+export declare class AliCloudStorageService extends CloudStorageService {
+    private _client;
+    id: CloudStorageProvider;
+    constructor(credentials: CloudStorageServiceCredentials);
+    obtainContainerUrl(id: CloudStorageContainerDescriptor, expiry: Date, _clientIp?: string): CloudStorageContainerUrl;
+    listContainer(name: string, marker: string, count: number): Promise<string[]>;
+    upload(container: string, name: string, data: Uint8Array, options?: CloudStorageUploadOptions): Promise<string>;
+}
+//# sourceMappingURL=AliCloudStorageService.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AliCloudStorageService.d.ts","sourceRoot":"","sources":["../../src/AliCloudStorageService.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,+BAA+B,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AACrH,OAAO,EAAE,mBAAmB,EAAE,8BAA8B,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAuBvH,YAAY;AACZ,qBAAa,sBAAuB,SAAQ,mBAAmB;IAC7D,OAAO,CAAC,OAAO,CAAM;IAEd,EAAE,uBAAiC;gBAEvB,WAAW,EAAE,8BAA8B;IAUvD,kBAAkB,CAAC,EAAE,EAAE,+BAA+B,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,wBAAwB;IAoB7G,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAM7E,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,MAAM,CAAC;CA4B7H"}

package/lib/cjs/AliCloudStorageService.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AliCloudStorageService = void 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+const stream_1 = require("stream");
+const zlib = require("zlib");
+const core_common_1 = require("@itwin/core-common");
+const CloudStorageBackend_1 = require("./CloudStorageBackend");
+/** @beta */
+class AliCloudStorageService extends CloudStorageBackend_1.CloudStorageService {
+    constructor(credentials) {
+        super();
+        this.id = core_common_1.CloudStorageProvider.AliCloud;
+        this._client = new OSS({
+            region: "oss-cn-hangzhou",
+            accessKeyId: credentials.account,
+            accessKeySecret: credentials.accessKey,
+        });
+    }
+    obtainContainerUrl(id, expiry, _clientIp) {
+        const now = new Date().getTime();
+        const policy = {
+            expires: expiry.getTime() - now,
+        };
+        this._client.useBucket(id.name);
+        const url = {
+            descriptor: this.makeDescriptor(id),
+            valid: 0,
+            expires: expiry.getTime(),
+            url: this._client.signatureUrl(id.resource, policy),
+            bound: true,
+        };
+        return url;
+    }
+    async listContainer(name, marker, count) {
+        this._client.useBucket(name);
+        const query = await this._client.list({ marker, "max-keys": count }, {});
+        return query.objects ? query.objects.map((o) => o.name) : [];
+    }
+    async upload(container, name, data, options) {
+        await this._client.putBucket(container);
+        await this._client.putBucketCORS(container, [{ allowedOrigin: "*", allowedMethod: ["GET", "POST", "PUT", "DELETE", "HEAD"], allowedHeader: "*" }]);
+        this._client.useBucket(container);
+        const dataStream = new stream_1.PassThrough();
+        dataStream.end(data);
+        let source;
+        const putOptions = {
+            mime: (options && options.type) ? options.type : "application/octet-stream",
+            headers: {
+                // eslint-disable-next-line @typescript-eslint/naming-convention
+                "Cache-Control": (options && options.cacheControl) ? options.cacheControl : "private, max-age=31536000, immutable",
+            },
+        };
+        if (options && options.contentEncoding === "gzip") {
+            putOptions.headers["Content-Encoding"] = options.contentEncoding;
+            const compressor = zlib.createGzip();
+            source = dataStream.pipe(compressor);
+        }
+        else {
+            source = dataStream;
+        }
+        await this._client.putStream(name, source, putOptions);
+        return "";
+    }
+}
+exports.AliCloudStorageService = AliCloudStorageService;
+//# sourceMappingURL=AliCloudStorageService.js.map

package/lib/cjs/AliCloudStorageService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AliCloudStorageService.js","sourceRoot":"","sources":["../../src/AliCloudStorageService.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,mCAA+C;AAC/C,6BAA6B;AAC7B,oDAAqH;AACrH,+DAAuH;AAuBvH,YAAY;AACZ,MAAa,sBAAuB,SAAQ,yCAAmB;IAK7D,YAAmB,WAA2C;QAC5D,KAAK,EAAE,CAAC;QAHH,OAAE,GAAG,kCAAoB,CAAC,QAAQ,CAAC;QAKxC,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,CAAC;YACrB,MAAM,EAAE,iBAAiB;YACzB,WAAW,EAAE,WAAW,CAAC,OAAO;YAChC,eAAe,EAAE,WAAW,CAAC,SAAS;SACvC,CAAC,CAAC;IACL,CAAC;IAEM,kBAAkB,CAAC,EAAmC,EAAE,MAAY,EAAE,SAAkB;QAC7F,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAEjC,MAAM,MAAM,GAA4B;YACtC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,GAAG,GAAG;SAChC,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAEhC,MAAM,GAAG,GAA6B;YACpC,UAAU,EAAE,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;YACnC,KAAK,EAAE,CAAC;YACR,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;YACzB,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,QAAS,EAAE,MAAM,CAAC;YACpD,KAAK,EAAE,IAAI;SACZ,CAAC;QAEF,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,IAAY,EAAE,MAAc,EAAE,KAAa;QACpE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC7B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;QACzE,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/D,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,IAAY,EAAE,IAAgB,EAAE,OAAmC;QACxG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACxC,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,EAAE,aAAa,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QACnJ,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAElC,MAAM,UAAU,GAAG,IAAI,oBAAW,EAAE,CAAC;QACrC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAErB,IAAI,MAAgB,CAAC;QAErB,MAAM,UAAU,GAAG;YACjB,IAAI,EAAE,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,0BAA0B;YAC3E,OAAO,EAAE;gBACP,gEAAgE;gBAChE,eAAe,EAAE,CAAC,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,sCAAsC;aACnH;SACsB,CAAC;QAE1B,IAAI,OAAO,IAAI,OAAO,CAAC,eAAe,KAAK,MAAM,EAAE;YAChD,UAAU,CAAC,OAAe,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC;YAC1E,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;YACrC,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SACtC;aAAM;YACL,MAAM,GAAG,UAAU,CAAC;SACrB;QACD,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;QACvD,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AArED,wDAqEC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { PassThrough, Readable } from \"stream\";\r\nimport * as zlib from \"zlib\";\r\nimport { CloudStorageContainerDescriptor, CloudStorageContainerUrl, CloudStorageProvider } from \"@itwin/core-common\";\r\nimport { CloudStorageService, CloudStorageServiceCredentials, CloudStorageUploadOptions } from \"./CloudStorageBackend\";\r\n\r\ndeclare class OSS {\r\n  constructor(params: { region: string, accessKeyId: string, accessKeySecret: string })\r\n  public useBucket(name: string): void;\r\n  public signatureUrl(name: string, policy: OSS.SignatureUrlOptions): string;\r\n  public list(params: { marker: string, \"max-keys\": number }, arg2: {}): Promise<{ objects?: Array<{ name: string }> }>;\r\n  public putBucket(name: string): Promise<void>;\r\n  public putBucketCORS(name: string, params: Array<{ allowedOrigin: string, allowedMethod: string[], allowedHeader: string }>): Promise<void>;\r\n  public putStream(name: string, source: Readable, options: OSS.PutStreamOptions): Promise<void>;\r\n}\r\n\r\ndeclare namespace OSS { // eslint-disable-line no-redeclare\r\n  interface SignatureUrlOptions {\r\n    expires: number;\r\n  }\r\n\r\n  interface PutStreamOptions {\r\n    mime: string;\r\n    headers: { [index: string]: string };\r\n  }\r\n}\r\n\r\n/** @beta */\r\nexport class AliCloudStorageService extends CloudStorageService {\r\n  private _client: OSS;\r\n\r\n  public id = CloudStorageProvider.AliCloud;\r\n\r\n  public constructor(credentials: CloudStorageServiceCredentials) {\r\n    super();\r\n\r\n    this._client = new OSS({\r\n      region: \"oss-cn-hangzhou\",\r\n      accessKeyId: credentials.account,\r\n      accessKeySecret: credentials.accessKey,\r\n    });\r\n  }\r\n\r\n  public obtainContainerUrl(id: CloudStorageContainerDescriptor, expiry: Date, _clientIp?: string): CloudStorageContainerUrl {\r\n    const now = new Date().getTime();\r\n\r\n    const policy: OSS.SignatureUrlOptions = {\r\n      expires: expiry.getTime() - now,\r\n    };\r\n\r\n    this._client.useBucket(id.name);\r\n\r\n    const url: CloudStorageContainerUrl = {\r\n      descriptor: this.makeDescriptor(id),\r\n      valid: 0,\r\n      expires: expiry.getTime(),\r\n      url: this._client.signatureUrl(id.resource!, policy),\r\n      bound: true,\r\n    };\r\n\r\n    return url;\r\n  }\r\n\r\n  public async listContainer(name: string, marker: string, count: number): Promise<string[]> {\r\n    this._client.useBucket(name);\r\n    const query = await this._client.list({ marker, \"max-keys\": count }, {});\r\n    return query.objects ? query.objects.map((o) => o.name) : [];\r\n  }\r\n\r\n  public async upload(container: string, name: string, data: Uint8Array, options?: CloudStorageUploadOptions): Promise<string> {\r\n    await this._client.putBucket(container);\r\n    await this._client.putBucketCORS(container, [{ allowedOrigin: \"*\", allowedMethod: [\"GET\", \"POST\", \"PUT\", \"DELETE\", \"HEAD\"], allowedHeader: \"*\" }]);\r\n    this._client.useBucket(container);\r\n\r\n    const dataStream = new PassThrough();\r\n    dataStream.end(data);\r\n\r\n    let source: Readable;\r\n\r\n    const putOptions = {\r\n      mime: (options && options.type) ? options.type : \"application/octet-stream\",\r\n      headers: {\r\n        // eslint-disable-next-line @typescript-eslint/naming-convention\r\n        \"Cache-Control\": (options && options.cacheControl) ? options.cacheControl : \"private, max-age=31536000, immutable\",\r\n      },\r\n    } as OSS.PutStreamOptions;\r\n\r\n    if (options && options.contentEncoding === \"gzip\") {\r\n      (putOptions.headers as any)[\"Content-Encoding\"] = options.contentEncoding;\r\n      const compressor = zlib.createGzip();\r\n      source = dataStream.pipe(compressor);\r\n    } else {\r\n      source = dataStream;\r\n    }\r\n    await this._client.putStream(name, source, putOptions);\r\n    return \"\";\r\n  }\r\n}\r\n"]}

package/lib/cjs/BackendHubAccess.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"BackendHubAccess.d.ts","sourceRoot":"","sources":["../../src/BackendHubAccess.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAmB,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EACL,WAAW,EAAE,kBAAkB,EAAE,WAAW,EAAE,oBAAoB,EAAE,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,cAAc,EAAE,WAAW,EACnJ,aAAa,EAAE,YAAY,EAAE,aAAa,EAC3C,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;GAEG;AACH,oBAAY,SAAS;IACnB,gCAAgC;IAChC,IAAI,IAAI;IACR,mJAAmJ;IACnJ,MAAM,IAAI;IACV;;OAEG;IACH,SAAS,IAAI;CACd;AAED;;EAEE;AACF,qBAAa,YAAa,SAAQ,WAAW;IAEzC,mCAAmC;aACnB,WAAW,EAAE,WAAW;IACxC,sCAAsC;aACtB,cAAc,EAAE,MAAM;;IAHtC,mCAAmC;IACnB,WAAW,EAAE,WAAW;IACxC,sCAAsC;IACtB,cAAc,EAAE,MAAM,EACtC,GAAG,EAAE,qBAAqB,GAAG,gCAAgC;CAIhE;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,+BAA+B;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,6EAA6E;IAC7E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,uDAAuD;IACvD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,iFAAiF;IACjF,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,iGAAiG;IACjG,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED,gBAAgB;AAChB,oBAAY,OAAO,GAAG,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;AAEjD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC;IACxB,qBAAqB;IACrB,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,QAAQ;IAC3C,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,WAAW;IAC3D,kIAAkI;IAClI,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ,EAAE,UAAU;IACzD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;CACxC;AAED,gBAAgB;AAChB,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,uFAAuF;IACvF,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,gBAAgB;AAChB,oBAAY,aAAa,GAAG,eAAe,CAAC;AAE5C;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,SAAS,CAAC,EAAE,aAAa,CAAC;IACnC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,0DAA0D;IAC1D,kBAAkB,EAAE,CAAC,GAAG,EAAE,iBAAiB,GAAG;QAAE,SAAS,EAAE,YAAY,CAAA;KAAE,KAAK,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAC5G,mCAAmC;IACnC,iBAAiB,EAAE,CAAC,GAAG,EAAE,YAAY,GAAG;QAAE,SAAS,EAAE,YAAY,CAAA;KAAE,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACpG,6DAA6D;IAC7D,cAAc,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAC/D,gFAAgF;IAChF,eAAe,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACvE,gFAAgF;IAChF,aAAa,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,cAAc,EAAE,kBAAkB,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACtG,0DAA0D;IAC1D,kBAAkB,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAClE,kDAAkD;IAClD,uBAAuB,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,OAAO,EAAE,aAAa,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACpG,iDAAiD;IACjD,4BAA4B,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAEtG;;SAEK;IACL,qBAAqB,EAAE,CAAC,GAAG,EAAE,wBAAwB,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/E,gHAAgH;IAChH,gBAAgB,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD,yDAAyD;IACzD,iBAAiB,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAEhE;;;OAGG;IACH,oBAAoB,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IAEnE;;;OAGG;IACH,iBAAiB,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC,CAAC;IAC1F;;;OAGG;IACH,oBAAoB,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IAEnE;;;OAGG;IACH,YAAY,EAAE,CAAC,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE;;;OAGG;IACH,aAAa,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAE7D;;;OAGG;IACH,eAAe,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD,4FAA4F;IAC5F,iBAAiB,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAE3E,wEAAwE;IACxE,eAAe,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;IAEpE,uBAAuB;IACvB,YAAY,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAChE"}

package/lib/cjs/BackendHubAccess.js

@@ -0,0 +1,42 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module HubAccess
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LockConflict = exports.LockState = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+/** The state of a lock.
+ * @public
+ */
+var LockState;
+(function (LockState) {
+    /** The element is not locked */
+    LockState[LockState["None"] = 0] = "None";
+    /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */
+    LockState[LockState["Shared"] = 1] = "Shared";
+    /** A Lock that permits modifications to an element and blocks other users from making modifications to it.
+     * Holding an exclusive lock on an "owner" (a model or a parent element), implicitly exclusively locks all its members.
+     */
+    LockState[LockState["Exclusive"] = 2] = "Exclusive";
+})(LockState = exports.LockState || (exports.LockState = {}));
+/** Exception thrown if lock cannot be acquired.
+ * @beta
+*/
+class LockConflict extends core_common_1.IModelError {
+    constructor(
+    /** Id of Briefcase holding lock */
+    briefcaseId, 
+    /** Alias of Briefcase holding lock */
+    briefcaseAlias, msg) {
+        super(core_bentley_1.IModelHubStatus.LockOwnedByAnotherBriefcase, msg);
+        this.briefcaseId = briefcaseId;
+        this.briefcaseAlias = briefcaseAlias;
+    }
+}
+exports.LockConflict = LockConflict;
+//# sourceMappingURL=BackendHubAccess.js.map

package/lib/cjs/BackendHubAccess.js.map

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

package/lib/cjs/BackendLoggerCategory.d.ts

@@ -0,0 +1,83 @@
+/** @packageDocumentation
+ * @module Logging
+ */
+/** Logger categories used by this package
+ * @note All logger categories in this package start with the `core-backend` prefix.
+ * @see [Logger]($bentley)
+ * @public
+ */
+export declare enum BackendLoggerCategory {
+    /** The logger category used by API related to authorization */
+    Authorization = "core-backend.Authorization",
+    /** The logger category used by the following classes:
+     * - [[CodeSpecs]]
+     */
+    CodeSpecs = "core-backend.CodeSpecs",
+    /** The logger category used by the [[DevTools]] class and related classes.
+     * @internal
+     */
+    DevTools = "core-backend.DevTools",
+    /** The logger category used by the following classes:
+     * - [[ChangeSummaryManager]]
+     * - [[ECDb]]
+     * - [[ECSqlStatement]]
+     */
+    ECDb = "core-backend.ECDb",
+    /** The logger category used by the following classes:
+     * - [[Functional]]
+     */
+    Functional = "core-backend.Functional",
+    /** The logger category used by the following classes:
+     * - [[LinearReferencing]]
+     */
+    LinearReferencing = "core-backend.LinearReferencing",
+    /** The logger category used by the following classes:
+     * - BriefcaseManager
+     * - [[IModelDb]]
+     */
+    IModelDb = "core-backend.IModelDb",
+    /** The logger category used by the following classes:
+     * - [[IModelHost]]
+     */
+    IModelHost = "core-backend.IModelHost",
+    /** The logger category used by the following classes:
+     * - TileRequestMemoizer
+     */
+    IModelTileRequestRpc = "core-backend.IModelTileRequestRpc",
+    /** The logger category used by the following classes:
+     * - IModelTileRpcImpl (Tile Uploading)
+     */
+    IModelTileUpload = "core-backend.IModelTileUpload",
+    /** The logger category used by the following classes:
+     * - [[Relationship]]
+     */
+    Relationship = "core-backend.Relationship",
+    /** The logger category used by the following classes:
+     * - [[Schemas]]
+     */
+    Schemas = "core-backend.Schemas",
+    /** The logger category used by the following classes:
+     * - [[PromiseMemoizer]]
+     */
+    PromiseMemoizer = "core-backend.PromiseMemoizer",
+    /** The logger category used by the following classes:
+     * - [[EventSink]]
+     */
+    EventSink = "core-backend.EventSink",
+    /** The logger category used by the following classes:
+     * - [[IModelSchemaLoader]]
+     * @alpha
+     */
+    IModelSchemaLoader = "core-backend.IModelSchemaLoader",
+    /** The logger category used by the following classes:
+     * - [[iModels]]
+     * @alpha
+     */
+    Editing = "core-backend.Editing",
+    /** The logger category used by the following classes:
+     * - [[NativeHost]], [[NativeAppStorage]]
+     * @internal
+     */
+    NativeApp = "core-backend.NativeApp"
+}
+//# sourceMappingURL=BackendLoggerCategory.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BackendLoggerCategory.d.ts","sourceRoot":"","sources":["../../src/BackendLoggerCategory.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;GAIG;AACH,oBAAY,qBAAqB;IAC/B,+DAA+D;IAC/D,aAAa,+BAA+B;IAE5C;;OAEG;IACH,SAAS,2BAA2B;IAEpC;;OAEG;IACH,QAAQ,0BAA0B;IAElC;;;;OAIG;IACH,IAAI,sBAAsB;IAE1B;;OAEG;IACH,UAAU,4BAA4B;IAEtC;;OAEG;IACH,iBAAiB,mCAAmC;IAEpD;;;OAGG;IACH,QAAQ,0BAA0B;IAElC;;OAEG;IACH,UAAU,4BAA4B;IAEtC;;OAEG;IACH,oBAAoB,sCAAsC;IAE1D;;OAEG;IACH,gBAAgB,kCAAkC;IAElD;;OAEG;IACH,YAAY,8BAA8B;IAE1C;;OAEG;IACH,OAAO,yBAAyB;IAEhC;;OAEG;IACH,eAAe,iCAAiC;IAChD;;OAEG;IACH,SAAS,2BAA2B;IAEpC;;;OAGG;IACH,kBAAkB,oCAAoC;IAEtD;;;OAGG;IACH,OAAO,yBAAyB;IAEhC;;;OAGG;IACH,SAAS,2BAA2B;CACrC"}

package/lib/cjs/BackendLoggerCategory.js

@@ -0,0 +1,91 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Logging
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BackendLoggerCategory = void 0;
+/** Logger categories used by this package
+ * @note All logger categories in this package start with the `core-backend` prefix.
+ * @see [Logger]($bentley)
+ * @public
+ */
+var BackendLoggerCategory;
+(function (BackendLoggerCategory) {
+    /** The logger category used by API related to authorization */
+    BackendLoggerCategory["Authorization"] = "core-backend.Authorization";
+    /** The logger category used by the following classes:
+     * - [[CodeSpecs]]
+     */
+    BackendLoggerCategory["CodeSpecs"] = "core-backend.CodeSpecs";
+    /** The logger category used by the [[DevTools]] class and related classes.
+     * @internal
+     */
+    BackendLoggerCategory["DevTools"] = "core-backend.DevTools";
+    /** The logger category used by the following classes:
+     * - [[ChangeSummaryManager]]
+     * - [[ECDb]]
+     * - [[ECSqlStatement]]
+     */
+    BackendLoggerCategory["ECDb"] = "core-backend.ECDb";
+    /** The logger category used by the following classes:
+     * - [[Functional]]
+     */
+    BackendLoggerCategory["Functional"] = "core-backend.Functional";
+    /** The logger category used by the following classes:
+     * - [[LinearReferencing]]
+     */
+    BackendLoggerCategory["LinearReferencing"] = "core-backend.LinearReferencing";
+    /** The logger category used by the following classes:
+     * - BriefcaseManager
+     * - [[IModelDb]]
+     */
+    BackendLoggerCategory["IModelDb"] = "core-backend.IModelDb";
+    /** The logger category used by the following classes:
+     * - [[IModelHost]]
+     */
+    BackendLoggerCategory["IModelHost"] = "core-backend.IModelHost";
+    /** The logger category used by the following classes:
+     * - TileRequestMemoizer
+     */
+    BackendLoggerCategory["IModelTileRequestRpc"] = "core-backend.IModelTileRequestRpc";
+    /** The logger category used by the following classes:
+     * - IModelTileRpcImpl (Tile Uploading)
+     */
+    BackendLoggerCategory["IModelTileUpload"] = "core-backend.IModelTileUpload";
+    /** The logger category used by the following classes:
+     * - [[Relationship]]
+     */
+    BackendLoggerCategory["Relationship"] = "core-backend.Relationship";
+    /** The logger category used by the following classes:
+     * - [[Schemas]]
+     */
+    BackendLoggerCategory["Schemas"] = "core-backend.Schemas";
+    /** The logger category used by the following classes:
+     * - [[PromiseMemoizer]]
+     */
+    BackendLoggerCategory["PromiseMemoizer"] = "core-backend.PromiseMemoizer";
+    /** The logger category used by the following classes:
+     * - [[EventSink]]
+     */
+    BackendLoggerCategory["EventSink"] = "core-backend.EventSink";
+    /** The logger category used by the following classes:
+     * - [[IModelSchemaLoader]]
+     * @alpha
+     */
+    BackendLoggerCategory["IModelSchemaLoader"] = "core-backend.IModelSchemaLoader";
+    /** The logger category used by the following classes:
+     * - [[iModels]]
+     * @alpha
+     */
+    BackendLoggerCategory["Editing"] = "core-backend.Editing";
+    /** The logger category used by the following classes:
+     * - [[NativeHost]], [[NativeAppStorage]]
+     * @internal
+     */
+    BackendLoggerCategory["NativeApp"] = "core-backend.NativeApp";
+})(BackendLoggerCategory = exports.BackendLoggerCategory || (exports.BackendLoggerCategory = {}));
+//# sourceMappingURL=BackendLoggerCategory.js.map

package/lib/cjs/BackendLoggerCategory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackendLoggerCategory.js","sourceRoot":"","sources":["../../src/BackendLoggerCategory.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;;;GAIG;AACH,IAAY,qBAwFX;AAxFD,WAAY,qBAAqB;IAC/B,+DAA+D;IAC/D,qEAA4C,CAAA;IAE5C;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;OAEG;IACH,2DAAkC,CAAA;IAElC;;;;OAIG;IACH,mDAA0B,CAAA;IAE1B;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,6EAAoD,CAAA;IAEpD;;;OAGG;IACH,2DAAkC,CAAA;IAElC;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,mFAA0D,CAAA;IAE1D;;OAEG;IACH,2EAAkD,CAAA;IAElD;;OAEG;IACH,mEAA0C,CAAA;IAE1C;;OAEG;IACH,yDAAgC,CAAA;IAEhC;;OAEG;IACH,yEAAgD,CAAA;IAChD;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;;OAGG;IACH,+EAAsD,CAAA;IAEtD;;;OAGG;IACH,yDAAgC,CAAA;IAEhC;;;OAGG;IACH,6DAAoC,CAAA;AACtC,CAAC,EAxFW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAwFhC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Logging\r\n */\r\n\r\n/** Logger categories used by this package\r\n * @note All logger categories in this package start with the `core-backend` prefix.\r\n * @see [Logger]($bentley)\r\n * @public\r\n */\r\nexport enum BackendLoggerCategory {\r\n  /** The logger category used by API related to authorization */\r\n  Authorization = \"core-backend.Authorization\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[CodeSpecs]]\r\n   */\r\n  CodeSpecs = \"core-backend.CodeSpecs\",\r\n\r\n  /** The logger category used by the [[DevTools]] class and related classes.\r\n   * @internal\r\n   */\r\n  DevTools = \"core-backend.DevTools\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[ChangeSummaryManager]]\r\n   * - [[ECDb]]\r\n   * - [[ECSqlStatement]]\r\n   */\r\n  ECDb = \"core-backend.ECDb\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Functional]]\r\n   */\r\n  Functional = \"core-backend.Functional\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[LinearReferencing]]\r\n   */\r\n  LinearReferencing = \"core-backend.LinearReferencing\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - BriefcaseManager\r\n   * - [[IModelDb]]\r\n   */\r\n  IModelDb = \"core-backend.IModelDb\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[IModelHost]]\r\n   */\r\n  IModelHost = \"core-backend.IModelHost\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - TileRequestMemoizer\r\n   */\r\n  IModelTileRequestRpc = \"core-backend.IModelTileRequestRpc\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - IModelTileRpcImpl (Tile Uploading)\r\n   */\r\n  IModelTileUpload = \"core-backend.IModelTileUpload\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Relationship]]\r\n   */\r\n  Relationship = \"core-backend.Relationship\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Schemas]]\r\n   */\r\n  Schemas = \"core-backend.Schemas\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[PromiseMemoizer]]\r\n   */\r\n  PromiseMemoizer = \"core-backend.PromiseMemoizer\",\r\n  /** The logger category used by the following classes:\r\n   * - [[EventSink]]\r\n   */\r\n  EventSink = \"core-backend.EventSink\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[IModelSchemaLoader]]\r\n   * @alpha\r\n   */\r\n  IModelSchemaLoader = \"core-backend.IModelSchemaLoader\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[iModels]]\r\n   * @alpha\r\n   */\r\n  Editing = \"core-backend.Editing\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[NativeHost]], [[NativeAppStorage]]\r\n   * @internal\r\n   */\r\n  NativeApp = \"core-backend.NativeApp\",\r\n}\r\n"]}

package/lib/cjs/BisCoreSchema.d.ts

@@ -0,0 +1,22 @@
+/** @packageDocumentation
+ * @module Schema
+ */
+import { Schema } from "./Schema";
+/**
+ * The [BisCore]($docs/bis/intro/schemas-domains.md) schema is the lowest level Schema in an iModel.
+ *
+ * It is automatically registered when [[IModelHost.startup]] is called.
+ *
+ * ** Example:**
+ * ``` ts
+ * [[include:BisCore.registerSchemaAndGetClass]]
+ * ```
+ * @public
+ */
+export declare class BisCoreSchema extends Schema {
+    static get schemaName(): string;
+    static get schemaFilePath(): string;
+    /** @internal */
+    static registerSchema(): void;
+}
+//# sourceMappingURL=BisCoreSchema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BisCoreSchema.d.ts","sourceRoot":"","sources":["../../src/BisCoreSchema.ts"],"names":[],"mappings":"AAIA;;GAEG;AAYH,OAAO,EAAE,MAAM,EAAW,MAAM,UAAU,CAAC;AAK3C;;;;;;;;;;GAUG;AACH,qBAAa,aAAc,SAAQ,MAAM;IACvC,WAA2B,UAAU,IAAI,MAAM,CAAsB;IACrE,WAAkB,cAAc,IAAI,MAAM,CAAsH;IAEhK,gBAAgB;WACF,cAAc;CAqB7B"}