@itwin/core-backend 5.0.0-dev.90 → 5.0.0-dev.92

package/lib/esm/BackendHubAccess.d.ts

@@ -0,0 +1,215 @@
+/** @packageDocumentation
+ * @module HubAccess
+ */
+import { AccessToken, GuidString, Id64String } from "@itwin/core-bentley";
+import { BriefcaseId, ChangesetFileProps, ChangesetIdWithIndex, ChangesetIndex, ChangesetIndexAndId, ChangesetIndexOrId, ChangesetProps, ChangesetRange, LockState as CommonLockState, IModelError, IModelVersion, LocalDirName, LocalFileName } from "@itwin/core-common";
+import { CheckpointProps, DownloadRequest, ProgressFunction } from "./CheckpointManager";
+import type { TokenArg } from "./IModelDb";
+/** 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 state of a lock. See [Acquiring locks on elements.]($docs/learning/backend/ConcurrencyControl.md#acquiring-locks-on-elements).
+ * @deprecated in 4.7 Use [LockState]($common)
+ * @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
+}
+/**
+ * The properties to access a V2 checkpoint through a daemon.
+ * @public
+ */
+export interface V2CheckpointAccessProps {
+    /** blob store account name. */
+    readonly accountName: string;
+    /** AccessToken that grants access to the container. */
+    readonly sasToken: AccessToken;
+    /** The name of the iModel's blob store container holding all checkpoints. */
+    readonly containerId: string;
+    /** The name of the virtual file within the container, used for the checkpoint */
+    readonly dbName: string;
+    /** blob storage module: e.g. "azure", "google", "aws". May also include URI style parameters. */
+    readonly storageType: string;
+}
+/**
+ * Maps element Ids to their corresponding [LockState]($common)s.
+ * @public
+ */
+export type LockMap = Map<Id64String, CommonLockState>;
+/**
+ * The properties of a lock that may be obtained from a lock server.
+ * @public
+ */
+export interface LockProps {
+    /** The elementId for the lock */
+    readonly id: Id64String;
+    /** the lock state */
+    readonly state: CommonLockState;
+}
+/**
+ * Argument for cancelling and tracking download progress.
+ * @public
+ */
+export interface DownloadProgressArg {
+    /** Called to show progress during a download. If this function returns non-zero, the download is aborted. */
+    progressCallback?: ProgressFunction;
+}
+/**
+ * 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;
+}
+/** Argument for downloading a changeset.
+ * @public
+ */
+export interface DownloadChangesetArg extends ChangesetArg, DownloadProgressArg {
+    /** Directory where the changeset should be downloaded. */
+    targetDir: LocalDirName;
+}
+/** @internal */
+export interface ChangesetIndexArg extends IModelIdArg {
+    readonly changeset: ChangesetIdWithIndex;
+}
+/** Argument for methods that must supply an IModelId and a range of Changesets.
+ * @public
+ */
+export interface ChangesetRangeArg extends IModelIdArg {
+    /** the range of changesets desired. If is undefined, *all* changesets are returned. */
+    readonly range?: ChangesetRange;
+}
+/** Argument for downloading a changeset range.
+ * @public
+ */
+export interface DownloadChangesetRangeArg extends ChangesetRangeArg, DownloadProgressArg {
+    /** Directory where the changesets should be downloaded. */
+    targetDir: LocalDirName;
+}
+/**
+ * Arguments to create a new iModel in iModelHub
+ *  @public
+ */
+export interface CreateNewIModelProps extends IModelNameArg {
+    readonly description?: string;
+    readonly version0?: 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.
+ * @public
+ */
+export interface BackendHubAccess {
+    /** Download all the changesets in the specified range. */
+    downloadChangesets: (arg: DownloadChangesetRangeArg) => Promise<ChangesetFileProps[]>;
+    /** Download a single changeset. */
+    downloadChangeset: (arg: DownloadChangesetArg) => 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
+     * @deprecated in 3.x. V1 checkpoints are deprecated. Download V2 checkpoint using [[V2CheckpointManager.downloadCheckpoint]].
+     * @internal
+     */
+    downloadV1Checkpoint: (arg: DownloadRequest) => Promise<ChangesetIndexAndId>;
+    /** Get the access props for a V2 checkpoint. Returns undefined if no V2 checkpoint exists. */
+    queryV2Checkpoint: (arg: CheckpointProps) => Promise<V2CheckpointAccessProps | undefined>;
+    /**
+     * acquire one or more locks. Throws if unsuccessful. If *any* lock cannot be obtained, no locks are acquired
+     * @throws ConflictingLocksError if one or more requested locks are held by other briefcases.
+     */
+    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. */
+    queryAllLocks: (arg: BriefcaseDbArg) => Promise<LockProps[]>;
+    /** Release all currently held locks */
+    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/esm/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,oBAAoB,EAAE,cAAc,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,cAAc,EAAE,cAAc,EAC9I,SAAS,IAAI,eAAe,EAAE,WAAW,EAAE,aAAa,EACxD,YAAY,EAAE,aAAa,EAC5B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACzF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;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,oBAAY,SAAS;IACnB,gCAAgC;IAChC,IAAI,IAAI;IACR,mJAAmJ;IACnJ,MAAM,IAAI;IACV;;OAEG;IACH,SAAS,IAAI;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,+BAA+B;IAC/B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B,6EAA6E;IAC7E,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,iFAAiF;IACjF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,iGAAiG;IACjG,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC;IACxB,qBAAqB;IACrB,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,6GAA6G;IAC7G,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;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;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,YAAY,EAAE,mBAAmB;IAC7E,0DAA0D;IAC1D,SAAS,EAAE,YAAY,CAAC;CACzB;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;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB,EAAE,mBAAmB;IACvF,2DAA2D;IAC3D,SAAS,EAAE,YAAY,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,0DAA0D;IAC1D,kBAAkB,EAAE,CAAC,GAAG,EAAE,yBAAyB,KAAK,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACtF,mCAAmC;IACnC,iBAAiB,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC9E,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;;;;OAIG;IACH,oBAAoB,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAE7E,8FAA8F;IAC9F,iBAAiB,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC,CAAC;IAE1F;;;OAGG;IACH,YAAY,EAAE,CAAC,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE,uHAAuH;IACvH,aAAa,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAE7D,uCAAuC;IACvC,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/esm/BackendHubAccess.js

@@ -0,0 +1,41 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { IModelHubStatus } from "@itwin/core-bentley";
+import { IModelError, } from "@itwin/core-common";
+/** Exception thrown if lock cannot be acquired.
+ * @beta
+*/
+export class LockConflict extends IModelError {
+    briefcaseId;
+    briefcaseAlias;
+    constructor(
+    /** Id of Briefcase holding lock */
+    briefcaseId, 
+    /** Alias of Briefcase holding lock */
+    briefcaseAlias, msg) {
+        super(IModelHubStatus.LockOwnedByAnotherBriefcase, msg);
+        this.briefcaseId = briefcaseId;
+        this.briefcaseAlias = briefcaseAlias;
+    }
+}
+/** The state of a lock. See [Acquiring locks on elements.]($docs/learning/backend/ConcurrencyControl.md#acquiring-locks-on-elements).
+ * @deprecated in 4.7 Use [LockState]($common)
+ * @public
+ */
+export 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 || (LockState = {}));
+//# sourceMappingURL=BackendHubAccess.js.map

package/lib/esm/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,OAAO,EAAuC,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAEyB,WAAW,GAE1C,MAAM,oBAAoB,CAAC;AAI5B;;EAEE;AACF,MAAM,OAAO,YAAa,SAAQ,WAAW;IAGzB;IAEA;IAJlB;IACE,mCAAmC;IACnB,WAAwB;IACxC,sCAAsC;IACtB,cAAsB,EACtC,GAA6D;QAE7D,KAAK,CAAC,eAAe,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAC;QALxC,gBAAW,GAAX,WAAW,CAAa;QAExB,mBAAc,GAAd,cAAc,CAAQ;IAIxC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,SASX;AATD,WAAY,SAAS;IACnB,gCAAgC;IAChC,yCAAQ,CAAA;IACR,mJAAmJ;IACnJ,6CAAU,CAAA;IACV;;OAEG;IACH,mDAAa,CAAA;AACf,CAAC,EATW,SAAS,KAAT,SAAS,QASpB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module HubAccess\n */\n\nimport { AccessToken, GuidString, Id64String, IModelHubStatus } from \"@itwin/core-bentley\";\nimport {\n  BriefcaseId, ChangesetFileProps, ChangesetIdWithIndex, ChangesetIndex, ChangesetIndexAndId, ChangesetIndexOrId, ChangesetProps, ChangesetRange,\n  LockState as CommonLockState, IModelError, IModelVersion,\n  LocalDirName, LocalFileName,\n} from \"@itwin/core-common\";\nimport { CheckpointProps, DownloadRequest, ProgressFunction } from \"./CheckpointManager\";\nimport type { TokenArg } from \"./IModelDb\";\n\n/** Exception thrown if lock cannot be acquired.\n * @beta\n*/\nexport class LockConflict extends IModelError {\n  public constructor(\n    /** Id of Briefcase holding lock */\n    public readonly briefcaseId: BriefcaseId,\n    /** Alias of Briefcase holding lock */\n    public readonly briefcaseAlias: string,\n    msg: \"shared lock is held\" | \"exclusive lock is already held\",\n  ) {\n    super(IModelHubStatus.LockOwnedByAnotherBriefcase, msg);\n  }\n}\n\n/** The state of a lock. See [Acquiring locks on elements.]($docs/learning/backend/ConcurrencyControl.md#acquiring-locks-on-elements).\n * @deprecated in 4.7 Use [LockState]($common)\n * @public\n */\nexport enum LockState {\n  /** The element is not locked */\n  None = 0,\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. */\n  Shared = 1,\n  /** A Lock that permits modifications to an element and blocks other users from making modifications to it.\n   * Holding an exclusive lock on an \"owner\" (a model or a parent element), implicitly exclusively locks all its members.\n   */\n  Exclusive = 2,\n}\n\n/**\n * The properties to access a V2 checkpoint through a daemon.\n * @public\n */\nexport interface V2CheckpointAccessProps {\n  /** blob store account name. */\n  readonly accountName: string;\n  /** AccessToken that grants access to the container. */\n  readonly sasToken: AccessToken;\n  /** The name of the iModel's blob store container holding all checkpoints. */\n  readonly containerId: string;\n  /** The name of the virtual file within the container, used for the checkpoint */\n  readonly dbName: string;\n  /** blob storage module: e.g. \"azure\", \"google\", \"aws\". May also include URI style parameters. */\n  readonly storageType: string;\n}\n\n/**\n * Maps element Ids to their corresponding [LockState]($common)s.\n * @public\n */\nexport type LockMap = Map<Id64String, CommonLockState>;\n\n/**\n * The properties of a lock that may be obtained from a lock server.\n * @public\n */\nexport interface LockProps {\n  /** The elementId for the lock */\n  readonly id: Id64String;\n  /** the lock state */\n  readonly state: CommonLockState;\n}\n\n/**\n * Argument for cancelling and tracking download progress.\n * @public\n */\nexport interface DownloadProgressArg {\n  /** Called to show progress during a download. If this function returns non-zero, the download is aborted. */\n  progressCallback?: ProgressFunction;\n}\n\n/**\n * Argument for methods that must supply an iTwinId\n * @public\n */\nexport interface ITwinIdArg {\n  readonly iTwinId: GuidString;\n}\n\n/**\n * Argument for methods that must supply an IModelId\n * @public\n */\nexport interface IModelIdArg extends TokenArg {\n  readonly iModelId: GuidString;\n}\n\n/**\n * Argument for acquiring a new BriefcaseId\n * @public\n */\nexport interface AcquireNewBriefcaseIdArg extends IModelIdArg {\n  /** A string to be reported to other users to identify this briefcase, for example in the case of conflicts or lock collisions. */\n  readonly briefcaseAlias?: string;\n}\n\n/** Argument for methods that must supply an IModel name and iTwinId\n * @public\n */\nexport interface IModelNameArg extends TokenArg, ITwinIdArg {\n  readonly iModelName: string;\n}\n\n/** Argument for methods that must supply an IModelId and a BriefcaseId\n * @public\n */\nexport interface BriefcaseIdArg extends IModelIdArg {\n  readonly briefcaseId: BriefcaseId;\n}\n\n/** Argument for methods that must supply a briefcaseId and a changeset\n * @public\n */\nexport interface BriefcaseDbArg extends BriefcaseIdArg {\n  readonly changeset: ChangesetIdWithIndex;\n}\n\n/** Argument for methods that must supply an IModelId and a changeset\n * @public\n */\nexport interface ChangesetArg extends IModelIdArg {\n  readonly changeset: ChangesetIndexOrId;\n}\n\n/** Argument for downloading a changeset.\n * @public\n */\nexport interface DownloadChangesetArg extends ChangesetArg, DownloadProgressArg {\n  /** Directory where the changeset should be downloaded. */\n  targetDir: LocalDirName;\n}\n\n/** @internal */\nexport interface ChangesetIndexArg extends IModelIdArg {\n  readonly changeset: ChangesetIdWithIndex;\n}\n\n/** Argument for methods that must supply an IModelId and a range of Changesets.\n * @public\n */\nexport interface ChangesetRangeArg extends IModelIdArg {\n  /** the range of changesets desired. If is undefined, *all* changesets are returned. */\n  readonly range?: ChangesetRange;\n}\n\n/** Argument for downloading a changeset range.\n * @public\n */\nexport interface DownloadChangesetRangeArg extends ChangesetRangeArg, DownloadProgressArg {\n  /** Directory where the changesets should be downloaded. */\n  targetDir: LocalDirName;\n}\n\n/**\n * Arguments to create a new iModel in iModelHub\n *  @public\n */\nexport interface CreateNewIModelProps extends IModelNameArg {\n  readonly description?: string;\n  readonly version0?: LocalFileName;\n  readonly noLocks?: true;\n}\n\n/**\n * Methods for accessing services of IModelHub from an iTwin.js backend.\n * Generally direct access to these methods should not be required, since higher-level apis are provided.\n * @public\n */\nexport interface BackendHubAccess {\n  /** Download all the changesets in the specified range. */\n  downloadChangesets: (arg: DownloadChangesetRangeArg) => Promise<ChangesetFileProps[]>;\n  /** Download a single changeset. */\n  downloadChangeset: (arg: DownloadChangesetArg) => Promise<ChangesetFileProps>;\n  /** Query the changeset properties given a ChangesetIndex  */\n  queryChangeset: (arg: ChangesetArg) => Promise<ChangesetProps>;\n  /** Query an array of changeset properties given a range of ChangesetIndexes  */\n  queryChangesets: (arg: ChangesetRangeArg) => Promise<ChangesetProps[]>;\n  /** Push a changeset to iModelHub. Returns the newly pushed changeset's index */\n  pushChangeset: (arg: IModelIdArg & { changesetProps: ChangesetFileProps }) => Promise<ChangesetIndex>;\n  /** Get the ChangesetProps of the most recent changeset */\n  getLatestChangeset: (arg: IModelIdArg) => Promise<ChangesetProps>;\n  /** Get the ChangesetProps for an IModelVersion */\n  getChangesetFromVersion: (arg: IModelIdArg & { version: IModelVersion }) => Promise<ChangesetProps>;\n  /** Get the ChangesetProps for a named version */\n  getChangesetFromNamedVersion: (arg: IModelIdArg & { versionName: string }) => Promise<ChangesetProps>;\n\n  /** Acquire a new briefcaseId for the supplied iModelId\n     * @note usually there should only be one briefcase per iModel per user.\n     */\n  acquireNewBriefcaseId: (arg: AcquireNewBriefcaseIdArg) => Promise<BriefcaseId>;\n  /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */\n  releaseBriefcase: (arg: BriefcaseIdArg) => Promise<void>;\n\n  /** get an array of the briefcases assigned to a user. */\n  getMyBriefcaseIds: (arg: IModelIdArg) => Promise<BriefcaseId[]>;\n\n  /**\n   * Download a v1 checkpoint\n   * @deprecated in 3.x. V1 checkpoints are deprecated. Download V2 checkpoint using [[V2CheckpointManager.downloadCheckpoint]].\n   * @internal\n   */\n  downloadV1Checkpoint: (arg: DownloadRequest) => Promise<ChangesetIndexAndId>;\n\n  /** Get the access props for a V2 checkpoint. Returns undefined if no V2 checkpoint exists. */\n  queryV2Checkpoint: (arg: CheckpointProps) => Promise<V2CheckpointAccessProps | undefined>;\n\n  /**\n   * acquire one or more locks. Throws if unsuccessful. If *any* lock cannot be obtained, no locks are acquired\n   * @throws ConflictingLocksError if one or more requested locks are held by other briefcases.\n   */\n  acquireLocks: (arg: BriefcaseDbArg, locks: LockMap) => Promise<void>;\n\n  /** Get the list of all held locks for a briefcase. This can be very expensive and is currently used only for tests. */\n  queryAllLocks: (arg: BriefcaseDbArg) => Promise<LockProps[]>;\n\n  /** Release all currently held locks */\n  releaseAllLocks: (arg: BriefcaseDbArg) => Promise<void>;\n\n  /** Get the iModelId of an iModel by name. Undefined if no iModel with that name exists.  */\n  queryIModelByName: (arg: IModelNameArg) => Promise<GuidString | undefined>;\n\n  /** create a new iModel. Returns the Guid of the newly created iModel */\n  createNewIModel: (arg: CreateNewIModelProps) => Promise<GuidString>;\n\n  /** delete an iModel */\n  deleteIModel: (arg: IModelIdArg & ITwinIdArg) => Promise<void>;\n}\n"]}

package/lib/esm/BackendLoggerCategory.d.ts

@@ -0,0 +1,88 @@
+/** @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 following classes:
+     * - [[CustomViewState3dCreator]]
+     */
+    CustomViewState3dCreator = "core-backend.CustomViewState3dCreator",
+    /** 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:
+     * - TileStorage (tile upload/download)
+     */
+    IModelTileStorage = "core-backend.IModelTileStorage",
+    /** 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:
+     * - [[NativeHost]], [[NativeAppStorage]]
+     * @internal
+     */
+    NativeApp = "core-backend.NativeApp",
+    /** The logger category used by the following classes:
+     * - [[ViewStateHydrator]]
+     * @internal
+     */
+    ViewStateHydrator = "core-backend.ViewStateHydrator",
+    /** @internal */
+    Workspace = "core-backend.Workspace"
+}
+//# sourceMappingURL=BackendLoggerCategory.d.ts.map

package/lib/esm/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,wBAAwB,0CAA0C;IAElE;;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,iBAAiB,mCAAmC;IAEpD;;OAEG;IACH,YAAY,8BAA8B;IAE1C;;OAEG;IACH,OAAO,yBAAyB;IAEhC;;OAEG;IACH,eAAe,iCAAiC;IAChD;;OAEG;IACH,SAAS,2BAA2B;IAEpC;;;OAGG;IACH,SAAS,2BAA2B;IAEpC;;;OAGG;IACH,iBAAiB,mCAAmC;IAEpD,gBAAgB;IAChB,SAAS,2BAA2B;CACrC"}

package/lib/esm/BackendLoggerCategory.js

@@ -0,0 +1,93 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/** Logger categories used by this package
+ * @note All logger categories in this package start with the `core-backend` prefix.
+ * @see [Logger]($bentley)
+ * @public
+ */
+export 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 following classes:
+     * - [[CustomViewState3dCreator]]
+     */
+    BackendLoggerCategory["CustomViewState3dCreator"] = "core-backend.CustomViewState3dCreator";
+    /** 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:
+     * - TileStorage (tile upload/download)
+     */
+    BackendLoggerCategory["IModelTileStorage"] = "core-backend.IModelTileStorage";
+    /** 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:
+     * - [[NativeHost]], [[NativeAppStorage]]
+     * @internal
+     */
+    BackendLoggerCategory["NativeApp"] = "core-backend.NativeApp";
+    /** The logger category used by the following classes:
+     * - [[ViewStateHydrator]]
+     * @internal
+     */
+    BackendLoggerCategory["ViewStateHydrator"] = "core-backend.ViewStateHydrator";
+    /** @internal */
+    BackendLoggerCategory["Workspace"] = "core-backend.Workspace";
+})(BackendLoggerCategory || (BackendLoggerCategory = {}));
+//# sourceMappingURL=BackendLoggerCategory.js.map

package/lib/esm/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,MAAM,CAAN,IAAY,qBA+FX;AA/FD,WAAY,qBAAqB;IAC/B,+DAA+D;IAC/D,qEAA4C,CAAA;IAE5C;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;OAEG;IACH,2FAAkE,CAAA;IAElE;;OAEG;IACH,2DAAkC,CAAA;IAElC;;;;OAIG;IACH,mDAA0B,CAAA;IAE1B;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,6EAAoD,CAAA;IAEpD;;;OAGG;IACH,2DAAkC,CAAA;IAElC;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,mFAA0D,CAAA;IAE1D;;OAEG;IACH,2EAAkD,CAAA;IAElD;;OAEG;IACH,6EAAoD,CAAA;IAEpD;;OAEG;IACH,mEAA0C,CAAA;IAE1C;;OAEG;IACH,yDAAgC,CAAA;IAEhC;;OAEG;IACH,yEAAgD,CAAA;IAChD;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;;OAGG;IACH,6DAAoC,CAAA;IAEpC;;;OAGG;IACH,6EAAoD,CAAA;IAEpD,gBAAgB;IAChB,6DAAoC,CAAA;AACtC,CAAC,EA/FW,qBAAqB,KAArB,qBAAqB,QA+FhC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Logging\n */\n\n/** Logger categories used by this package\n * @note All logger categories in this package start with the `core-backend` prefix.\n * @see [Logger]($bentley)\n * @public\n */\nexport enum BackendLoggerCategory {\n  /** The logger category used by API related to authorization */\n  Authorization = \"core-backend.Authorization\",\n\n  /** The logger category used by the following classes:\n   * - [[CodeSpecs]]\n   */\n  CodeSpecs = \"core-backend.CodeSpecs\",\n\n  /** The logger category used by the following classes:\n   * - [[CustomViewState3dCreator]]\n   */\n  CustomViewState3dCreator = \"core-backend.CustomViewState3dCreator\",\n\n  /** The logger category used by the [[DevTools]] class and related classes.\n   * @internal\n   */\n  DevTools = \"core-backend.DevTools\",\n\n  /** The logger category used by the following classes:\n   * - [[ChangeSummaryManager]]\n   * - [[ECDb]]\n   * - [[ECSqlStatement]]\n   */\n  ECDb = \"core-backend.ECDb\",\n\n  /** The logger category used by the following classes:\n   * - [[Functional]]\n   */\n  Functional = \"core-backend.Functional\",\n\n  /** The logger category used by the following classes:\n   * - [[LinearReferencing]]\n   */\n  LinearReferencing = \"core-backend.LinearReferencing\",\n\n  /** The logger category used by the following classes:\n   * - BriefcaseManager\n   * - [[IModelDb]]\n   */\n  IModelDb = \"core-backend.IModelDb\",\n\n  /** The logger category used by the following classes:\n   * - [[IModelHost]]\n   */\n  IModelHost = \"core-backend.IModelHost\",\n\n  /** The logger category used by the following classes:\n   * - TileRequestMemoizer\n   */\n  IModelTileRequestRpc = \"core-backend.IModelTileRequestRpc\",\n\n  /** The logger category used by the following classes:\n   * - IModelTileRpcImpl (Tile Uploading)\n   */\n  IModelTileUpload = \"core-backend.IModelTileUpload\",\n\n  /** The logger category used by the following classes:\n   * - TileStorage (tile upload/download)\n   */\n  IModelTileStorage = \"core-backend.IModelTileStorage\",\n\n  /** The logger category used by the following classes:\n   * - [[Relationship]]\n   */\n  Relationship = \"core-backend.Relationship\",\n\n  /** The logger category used by the following classes:\n   * - [[Schemas]]\n   */\n  Schemas = \"core-backend.Schemas\",\n\n  /** The logger category used by the following classes:\n   * - [[PromiseMemoizer]]\n   */\n  PromiseMemoizer = \"core-backend.PromiseMemoizer\",\n  /** The logger category used by the following classes:\n   * - [[EventSink]]\n   */\n  EventSink = \"core-backend.EventSink\",\n\n  /** The logger category used by the following classes:\n   * - [[NativeHost]], [[NativeAppStorage]]\n   * @internal\n   */\n  NativeApp = \"core-backend.NativeApp\",\n\n  /** The logger category used by the following classes:\n   * - [[ViewStateHydrator]]\n   * @internal\n   */\n  ViewStateHydrator = \"core-backend.ViewStateHydrator\",\n\n  /** @internal */\n  Workspace = \"core-backend.Workspace\",\n}\n"]}

package/lib/esm/BisCoreSchema.d.ts

@@ -0,0 +1,22 @@
+/** @packageDocumentation
+ * @module Schema
+ */
+import { Schema } from "./Schema";
+/**
+ * The [BisCore]($docs/bis/guide/fundamentals/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/esm/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;AAO3C;;;;;;;;;;GAUG;AACH,qBAAa,aAAc,SAAQ,MAAM;IACvC,WAA2B,UAAU,IAAI,MAAM,CAAsB;IACrE,WAAkB,cAAc,IAAI,MAAM,CAAsH;IAEhK,gBAAgB;WACF,cAAc;CAuB7B"}

package/lib/esm/BisCoreSchema.js

@@ -0,0 +1,61 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Schema
+ */
+import * as path from "path";
+import * as categoryMod from "./Category";
+import { ClassRegistry } from "./ClassRegistry";
+import * as elementMod from "./Element";
+import * as aspectMod from "./ElementAspect";
+import * as externalSourceMod from "./ExternalSource";
+import { KnownLocations } from "./IModelHost";
+import * as materialMod from "./Material";
+import * as modelMod from "./Model";
+import * as linkMod from "./Relationship";
+import { Schema, Schemas } from "./Schema";
+import * as textureMod from "./Texture";
+import * as viewMod from "./ViewDefinition";
+import * as displayStyleMod from "./DisplayStyle";
+import * as annotationsMod from "./TextAnnotationElement";
+import * as sheetIndex from "./SheetIndex";
+/**
+ * The [BisCore]($docs/bis/guide/fundamentals/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 class BisCoreSchema extends Schema {
+    static get schemaName() { return "BisCore"; }
+    static get schemaFilePath() { return path.join(KnownLocations.nativeAssetsDir, "ECSchemas", "Dgn", `${BisCoreSchema.schemaName}.ecschema.xml`); }
+    /** @internal */
+    static registerSchema() {
+        if (this === Schemas.getRegisteredSchema(this.schemaName))
+            return;
+        Schemas.unregisterSchema(this.schemaName);
+        Schemas.registerSchema(this);
+        // this list should include all backend .ts files with implementations of Entity-based classes. Order does not matter.
+        [
+            elementMod,
+            aspectMod,
+            modelMod,
+            categoryMod,
+            viewMod,
+            linkMod,
+            textureMod,
+            materialMod,
+            externalSourceMod,
+            displayStyleMod,
+            annotationsMod,
+            sheetIndex
+        ].forEach((module) => ClassRegistry.registerModule(module, this));
+    }
+}
+//# sourceMappingURL=BisCoreSchema.js.map

package/lib/esm/BisCoreSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BisCoreSchema.js","sourceRoot":"","sources":["../../src/BisCoreSchema.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,UAAU,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,iBAAiB,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,KAAK,UAAU,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,eAAe,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,cAAc,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAE3C;;;;;;;;;;GAUG;AACH,MAAM,OAAO,aAAc,SAAQ,MAAM;IAChC,MAAM,KAAc,UAAU,KAAa,OAAO,SAAS,CAAC,CAAC,CAAC;IAC9D,MAAM,KAAK,cAAc,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,aAAa,CAAC,UAAU,eAAe,CAAC,CAAC,CAAC,CAAC;IAEhK,gBAAgB;IACT,MAAM,CAAC,cAAc;QAC1B,IAAI,IAAI,KAAK,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;YACvD,OAAO;QAET,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAE7B,sHAAsH;QACtH;YACE,UAAU;YACV,SAAS;YACT,QAAQ;YACR,WAAW;YACX,OAAO;YACP,OAAO;YACP,UAAU;YACV,WAAW;YACX,iBAAiB;YACjB,eAAe;YACf,cAAc;YACd,UAAU;SACX,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,aAAa,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IACpE,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Schema\n */\n\nimport * as path from \"path\";\nimport * as categoryMod from \"./Category\";\nimport { ClassRegistry } from \"./ClassRegistry\";\nimport * as elementMod from \"./Element\";\nimport * as aspectMod from \"./ElementAspect\";\nimport * as externalSourceMod from \"./ExternalSource\";\nimport { KnownLocations } from \"./IModelHost\";\nimport * as materialMod from \"./Material\";\nimport * as modelMod from \"./Model\";\nimport * as linkMod from \"./Relationship\";\nimport { Schema, Schemas } from \"./Schema\";\nimport * as textureMod from \"./Texture\";\nimport * as viewMod from \"./ViewDefinition\";\nimport * as displayStyleMod from \"./DisplayStyle\";\nimport * as annotationsMod from \"./TextAnnotationElement\";\nimport * as sheetIndex from \"./SheetIndex\";\n\n/**\n * The [BisCore]($docs/bis/guide/fundamentals/schemas-domains.md) schema is the lowest level Schema in an iModel.\n *\n * It is automatically registered when [[IModelHost.startup]] is called.\n *\n * Example:\n * ``` ts\n * [[include:BisCore.registerSchemaAndGetClass]]\n * ```\n * @public\n */\nexport class BisCoreSchema extends Schema {\n  public static override get schemaName(): string { return \"BisCore\"; }\n  public static get schemaFilePath(): string { return path.join(KnownLocations.nativeAssetsDir, \"ECSchemas\", \"Dgn\", `${BisCoreSchema.schemaName}.ecschema.xml`); }\n\n  /** @internal */\n  public static registerSchema() {\n    if (this === Schemas.getRegisteredSchema(this.schemaName))\n      return;\n\n    Schemas.unregisterSchema(this.schemaName);\n    Schemas.registerSchema(this);\n\n    // this list should include all backend .ts files with implementations of Entity-based classes. Order does not matter.\n    [\n      elementMod,\n      aspectMod,\n      modelMod,\n      categoryMod,\n      viewMod,\n      linkMod,\n      textureMod,\n      materialMod,\n      externalSourceMod,\n      displayStyleMod,\n      annotationsMod,\n      sheetIndex\n    ].forEach((module) => ClassRegistry.registerModule(module, this));\n  }\n}\n"]}